persistentstorage/sql/SRC/Client/SqlStream.cpp
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Tue, 31 Aug 2010 16:57:14 +0300
branchRCL_3
changeset 23 26645d81f48d
parent 0 08ec8eefde2f
child 24 cc28652e0254
permissions -rw-r--r--
Revision: 201035 Kit: 201035

// Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#include <sqldb.h>					//RSqlColumnReadStream, RSqlParamWriteStream
#include "SqlStatementImpl.h"		//CSqlStatementImpl
#include "OstTraceDefinitions.h"
#ifdef OST_TRACE_COMPILER_IN_USE
#include "SqlStreamTraces.h"
#endif
#include "SqlTraceDef.h"

////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////         RSqlColumnReadStream              ////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////

/**
Gives access to column data as a read-only stream of characters,

The function can only be used for text and binary column types.

@param aStmt        The RSqlStatement object to which the referred column belongs.
@param aColumnIndex The index value identifying the column; this is 0 for the first column.

@return KErrNone, the text column data stream has been opened successfully;
        KErrNoMemory, an out of memory condition occurred;
        KErrArgument, the column type is neither text nor binary.
                      Note that database specific errors categorised as ESqlDbError, and
                      other system-wide error codes may also be returned.

@capability None
*/
EXPORT_C TInt RSqlColumnReadStream::ColumnText(RSqlStatement& aStmt, TInt aColumnIndex)
	{
	SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXT_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnText;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
	TRAPD(err, Attach(aStmt.Impl().ColumnSourceL(aColumnIndex)));
    SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXT_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnText;err=%d", (TUint)this, err));
	return err;
	}
	
/**
Gives access to column data as a read-only stream of bytes.

The function can only be used for text and binary column types.

@param aStmt        The RSqlStatement object to which the referred column belongs.
@param aColumnIndex The index value identifying the column; this is 0 for the first column.

@return KErrNone, the text column data stream has been opened successfully;
        KErrNoMemory, an out of memory condition occurred;
        KErrArgument, the column type is neither text nor binary.
                      Note that database specific errors categorised as ESqlDbError, and
                      other system-wide error codes may also be returned.

@capability None
*/
EXPORT_C TInt RSqlColumnReadStream::ColumnBinary(RSqlStatement& aStmt, TInt aColumnIndex)
	{
    SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARY_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnBinary;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
	TRAPD(err, Attach(aStmt.Impl().ColumnSourceL(aColumnIndex)));
    SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARY_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnBinary;err=%d", (TUint)this, err));
	return err;
	}

/**
Gives access to column data as a read-only stream of characters,

The function can only be used for text and binary column types.

@param aStmt        The RSqlStatement object to which the referred column belongs.
@param aColumnIndex The index value identifying the column; this is 0 for the first column.

@leave  KErrNoMemory, an out of memory condition occurred;
        KErrArgument, the column type is neither text nor binary.
                      Note that database specific errors categorised as ESqlDbError, and
                      other system-wide error codes may also be returned.

@capability None
*/
EXPORT_C void RSqlColumnReadStream::ColumnTextL(RSqlStatement& aStmt, TInt aColumnIndex)
	{
    SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXTL_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnTextL;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
	Attach(aStmt.Impl().ColumnSourceL(aColumnIndex));
    SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXTL_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnTextL", (TUint)this));
	}
	
/**
Gives access to column data as a read-only stream of bytes.

The function can only be used for text and binary column types.

@param aStmt        The RSqlStatement object to which the referred column belongs.
@param aColumnIndex The index value identifying the column; this is 0 for the first column.

@leave  KErrNoMemory, an out of memory condition occurred;
        KErrArgument, the column type is neither text nor binary.
                      Note that database specific errors categorised as ESqlDbError, and
                      other system-wide error codes may also be returned.

@capability None
*/
EXPORT_C void RSqlColumnReadStream::ColumnBinaryL(RSqlStatement& aStmt, TInt aColumnIndex)
	{
    SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARYL_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnBinaryL;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
	Attach(aStmt.Impl().ColumnSourceL(aColumnIndex));
    SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARYL_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnBinaryL", (TUint)this));
	}

////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////         RSqlParamWriteStream              ////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////

/**
Gives access to parameter data as a stream of characters.

NB You need to close the stream after the execution of the statement operation for
which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).

@param aStmt           The RSqlStatement object to which the referred parameter belongs.
@param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.

@return KErrNone, the binary parameter data stream has been opened successfully;
        KErrNoMemory, an out of memory condition occurred.
                      Note that database specific errors categorised as ESqlDbError, and
                      other system-wide error codes may also be returned.

@see RSqlStatement::Next()
@see RSqlStatement::Exec()

@capability None
*/
EXPORT_C TInt RSqlParamWriteStream::BindText(RSqlStatement& aStmt, TInt aParameterIndex)
	{
    SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXT_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindText;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
	TRAPD(err, Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtTxtParamSink16, aParameterIndex)));
    SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXT_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindText;err=%d", (TUint)this, err));
	return err;
	}
	
/**
Gives access to parameter data as a stream of bytes.

NB You need to close the stream after the execution of the statement operation for
which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).

@param aStmt           The RSqlStatement object to which the referred parameter belongs.
@param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.

@return KErrNone, the binary parameter data stream has been opened successfully;
        KErrNoMemory, an out of memory condition occurred.
                      Note that database specific errors categorised as ESqlDbError, and
                      other system-wide error codes may also be returned.

@see RSqlStatement::Next()
@see RSqlStatement::Exec()

@capability None
*/
EXPORT_C TInt RSqlParamWriteStream::BindBinary(RSqlStatement& aStmt, TInt aParameterIndex)
	{
    SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARY_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindBinary;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
	TRAPD(err, Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtBinParamSink, aParameterIndex)));
    SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARY_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindBinary;err=%d", (TUint)this, err));
	return err;
	}

/**
Gives access to parameter data as a stream of characters.

NB You need to close the stream after the execution of the statement operation for
which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).

@param aStmt           The RSqlStatement object to which the referred parameter belongs.
@param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.

@leave KErrNoMemory, an out of memory condition occurred.
                      Note that database specific errors categorised as ESqlDbError, and
                      other system-wide error codes may also be returned.

@see RSqlStatement::Next()
@see RSqlStatement::Exec()

@capability None
*/
EXPORT_C void RSqlParamWriteStream::BindTextL(RSqlStatement& aStmt, TInt aParameterIndex)
	{
    SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXTL_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindTextL;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
	Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtTxtParamSink16, aParameterIndex));
    SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXTL_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindTextL", (TUint)this));
	}
	
/**
Gives access to parameter data as a stream of bytes.

NB You need to close the stream after the execution of the statement operation for
which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).

@param aStmt           The RSqlStatement object to which the referred parameter belongs.
@param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.

@leave KErrNoMemory, an out of memory condition occurred.
                      Note that database specific errors categorised as ESqlDbError, and
                      other system-wide error codes may also be returned.

@see RSqlStatement::Next()
@see RSqlStatement::Exec()

@capability None
*/
EXPORT_C void RSqlParamWriteStream::BindBinaryL(RSqlStatement& aStmt, TInt aParameterIndex)
	{
    SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARYL_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindBinaryL;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
	Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtBinParamSink, aParameterIndex));
    SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARYL_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindBinaryL", (TUint)this));
	}