1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/SRC/Client/SqlStream.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,227 @@
1.4 +// Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#include <sqldb.h> //RSqlColumnReadStream, RSqlParamWriteStream
1.20 +#include "SqlStatementImpl.h" //CSqlStatementImpl
1.21 +#include "OstTraceDefinitions.h"
1.22 +#ifdef OST_TRACE_COMPILER_IN_USE
1.23 +#include "SqlStreamTraces.h"
1.24 +#endif
1.25 +#include "SqlTraceDef.h"
1.26 +
1.27 +////////////////////////////////////////////////////////////////////////////////////////////////////
1.28 +///////////////////// RSqlColumnReadStream ////////////////////////////////////
1.29 +////////////////////////////////////////////////////////////////////////////////////////////////////
1.30 +
1.31 +/**
1.32 +Gives access to column data as a read-only stream of characters,
1.33 +
1.34 +The function can only be used for text and binary column types.
1.35 +
1.36 +@param aStmt The RSqlStatement object to which the referred column belongs.
1.37 +@param aColumnIndex The index value identifying the column; this is 0 for the first column.
1.38 +
1.39 +@return KErrNone, the text column data stream has been opened successfully;
1.40 + KErrNoMemory, an out of memory condition occurred;
1.41 + KErrArgument, the column type is neither text nor binary.
1.42 + Note that database specific errors categorised as ESqlDbError, and
1.43 + other system-wide error codes may also be returned.
1.44 +
1.45 +@capability None
1.46 +*/
1.47 +EXPORT_C TInt RSqlColumnReadStream::ColumnText(RSqlStatement& aStmt, TInt aColumnIndex)
1.48 + {
1.49 + SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXT_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnText;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
1.50 + TRAPD(err, Attach(aStmt.Impl().ColumnSourceL(aColumnIndex)));
1.51 + SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXT_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnText;err=%d", (TUint)this, err));
1.52 + return err;
1.53 + }
1.54 +
1.55 +/**
1.56 +Gives access to column data as a read-only stream of bytes.
1.57 +
1.58 +The function can only be used for text and binary column types.
1.59 +
1.60 +@param aStmt The RSqlStatement object to which the referred column belongs.
1.61 +@param aColumnIndex The index value identifying the column; this is 0 for the first column.
1.62 +
1.63 +@return KErrNone, the text column data stream has been opened successfully;
1.64 + KErrNoMemory, an out of memory condition occurred;
1.65 + KErrArgument, the column type is neither text nor binary.
1.66 + Note that database specific errors categorised as ESqlDbError, and
1.67 + other system-wide error codes may also be returned.
1.68 +
1.69 +@capability None
1.70 +*/
1.71 +EXPORT_C TInt RSqlColumnReadStream::ColumnBinary(RSqlStatement& aStmt, TInt aColumnIndex)
1.72 + {
1.73 + SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARY_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnBinary;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
1.74 + TRAPD(err, Attach(aStmt.Impl().ColumnSourceL(aColumnIndex)));
1.75 + SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARY_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnBinary;err=%d", (TUint)this, err));
1.76 + return err;
1.77 + }
1.78 +
1.79 +/**
1.80 +Gives access to column data as a read-only stream of characters,
1.81 +
1.82 +The function can only be used for text and binary column types.
1.83 +
1.84 +@param aStmt The RSqlStatement object to which the referred column belongs.
1.85 +@param aColumnIndex The index value identifying the column; this is 0 for the first column.
1.86 +
1.87 +@leave KErrNoMemory, an out of memory condition occurred;
1.88 + KErrArgument, the column type is neither text nor binary.
1.89 + Note that database specific errors categorised as ESqlDbError, and
1.90 + other system-wide error codes may also be returned.
1.91 +
1.92 +@capability None
1.93 +*/
1.94 +EXPORT_C void RSqlColumnReadStream::ColumnTextL(RSqlStatement& aStmt, TInt aColumnIndex)
1.95 + {
1.96 + SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXTL_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnTextL;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
1.97 + Attach(aStmt.Impl().ColumnSourceL(aColumnIndex));
1.98 + SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXTL_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnTextL", (TUint)this));
1.99 + }
1.100 +
1.101 +/**
1.102 +Gives access to column data as a read-only stream of bytes.
1.103 +
1.104 +The function can only be used for text and binary column types.
1.105 +
1.106 +@param aStmt The RSqlStatement object to which the referred column belongs.
1.107 +@param aColumnIndex The index value identifying the column; this is 0 for the first column.
1.108 +
1.109 +@leave KErrNoMemory, an out of memory condition occurred;
1.110 + KErrArgument, the column type is neither text nor binary.
1.111 + Note that database specific errors categorised as ESqlDbError, and
1.112 + other system-wide error codes may also be returned.
1.113 +
1.114 +@capability None
1.115 +*/
1.116 +EXPORT_C void RSqlColumnReadStream::ColumnBinaryL(RSqlStatement& aStmt, TInt aColumnIndex)
1.117 + {
1.118 + SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARYL_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnBinaryL;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
1.119 + Attach(aStmt.Impl().ColumnSourceL(aColumnIndex));
1.120 + SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARYL_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnBinaryL", (TUint)this));
1.121 + }
1.122 +
1.123 +////////////////////////////////////////////////////////////////////////////////////////////////////
1.124 +///////////////////// RSqlParamWriteStream ////////////////////////////////////
1.125 +////////////////////////////////////////////////////////////////////////////////////////////////////
1.126 +
1.127 +/**
1.128 +Gives access to parameter data as a stream of characters.
1.129 +
1.130 +NB You need to close the stream after the execution of the statement operation for
1.131 +which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).
1.132 +
1.133 +@param aStmt The RSqlStatement object to which the referred parameter belongs.
1.134 +@param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.
1.135 +
1.136 +@return KErrNone, the binary parameter data stream has been opened successfully;
1.137 + KErrNoMemory, an out of memory condition occurred.
1.138 + Note that database specific errors categorised as ESqlDbError, and
1.139 + other system-wide error codes may also be returned.
1.140 +
1.141 +@see RSqlStatement::Next()
1.142 +@see RSqlStatement::Exec()
1.143 +
1.144 +@capability None
1.145 +*/
1.146 +EXPORT_C TInt RSqlParamWriteStream::BindText(RSqlStatement& aStmt, TInt aParameterIndex)
1.147 + {
1.148 + SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXT_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindText;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
1.149 + TRAPD(err, Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtTxtParamSink16, aParameterIndex)));
1.150 + SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXT_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindText;err=%d", (TUint)this, err));
1.151 + return err;
1.152 + }
1.153 +
1.154 +/**
1.155 +Gives access to parameter data as a stream of bytes.
1.156 +
1.157 +NB You need to close the stream after the execution of the statement operation for
1.158 +which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).
1.159 +
1.160 +@param aStmt The RSqlStatement object to which the referred parameter belongs.
1.161 +@param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.
1.162 +
1.163 +@return KErrNone, the binary parameter data stream has been opened successfully;
1.164 + KErrNoMemory, an out of memory condition occurred.
1.165 + Note that database specific errors categorised as ESqlDbError, and
1.166 + other system-wide error codes may also be returned.
1.167 +
1.168 +@see RSqlStatement::Next()
1.169 +@see RSqlStatement::Exec()
1.170 +
1.171 +@capability None
1.172 +*/
1.173 +EXPORT_C TInt RSqlParamWriteStream::BindBinary(RSqlStatement& aStmt, TInt aParameterIndex)
1.174 + {
1.175 + SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARY_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindBinary;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
1.176 + TRAPD(err, Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtBinParamSink, aParameterIndex)));
1.177 + SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARY_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindBinary;err=%d", (TUint)this, err));
1.178 + return err;
1.179 + }
1.180 +
1.181 +/**
1.182 +Gives access to parameter data as a stream of characters.
1.183 +
1.184 +NB You need to close the stream after the execution of the statement operation for
1.185 +which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).
1.186 +
1.187 +@param aStmt The RSqlStatement object to which the referred parameter belongs.
1.188 +@param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.
1.189 +
1.190 +@leave KErrNoMemory, an out of memory condition occurred.
1.191 + Note that database specific errors categorised as ESqlDbError, and
1.192 + other system-wide error codes may also be returned.
1.193 +
1.194 +@see RSqlStatement::Next()
1.195 +@see RSqlStatement::Exec()
1.196 +
1.197 +@capability None
1.198 +*/
1.199 +EXPORT_C void RSqlParamWriteStream::BindTextL(RSqlStatement& aStmt, TInt aParameterIndex)
1.200 + {
1.201 + SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXTL_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindTextL;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
1.202 + Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtTxtParamSink16, aParameterIndex));
1.203 + SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXTL_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindTextL", (TUint)this));
1.204 + }
1.205 +
1.206 +/**
1.207 +Gives access to parameter data as a stream of bytes.
1.208 +
1.209 +NB You need to close the stream after the execution of the statement operation for
1.210 +which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).
1.211 +
1.212 +@param aStmt The RSqlStatement object to which the referred parameter belongs.
1.213 +@param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.
1.214 +
1.215 +@leave KErrNoMemory, an out of memory condition occurred.
1.216 + Note that database specific errors categorised as ESqlDbError, and
1.217 + other system-wide error codes may also be returned.
1.218 +
1.219 +@see RSqlStatement::Next()
1.220 +@see RSqlStatement::Exec()
1.221 +
1.222 +@capability None
1.223 +*/
1.224 +EXPORT_C void RSqlParamWriteStream::BindBinaryL(RSqlStatement& aStmt, TInt aParameterIndex)
1.225 + {
1.226 + SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARYL_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindBinaryL;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
1.227 + Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtBinParamSink, aParameterIndex));
1.228 + SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARYL_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindBinaryL", (TUint)this));
1.229 + }
1.230 +