Symaptic: os/persistentdata/persistentstorage/sql/SRC/Server/SqlSrvStatement.inl@bde4ae8d615e

     1 // Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 // ///////////////                HSqlSrvStmtParamBuf                        ////////////////////////////

    15 //

    16 //

    18 /**

    20  Creates a new HSqlSrvStmtParamBuf instance.

    22  @param aStatement A reference to the CSqlSrvStatement object, which needs the parameter data.

    23  @param aParamIndex Parameter index, zero based.

    24  @param aDataType Parameter value type - binary, text8 or text16.

    25  @param aBufType IPC stream buffer or a simple "bind param" buffer

    27  @return A pointer to the created HSqlSrvStmtParamBuf instance.

    29  @leave KErrNoMemory, an out of memory condition has occurred;

    31  @panic SqlDb 4 In _DEBUG mode. Parameter index negative.

    32 */

    33 inline HSqlSrvStmtParamBuf* HSqlSrvStmtParamBuf::NewL(CSqlSrvStatement& aStatement, TInt aParamIndex,

    34 													  HSqlSrvStmtParamBuf::TDataType aDataType, HSqlSrvStmtParamBuf::TBufType aBufType)

    35 	{

    36 	__ASSERT_DEBUG(aParamIndex >= 0, __SQLPANIC2(ESqlPanicBadArgument));

    37 	HSqlSrvStmtParamBuf* self = new (ELeave) HSqlSrvStmtParamBuf(aStatement, aParamIndex, aDataType, aBufType);

    38 	self->PushL();

    39 	self->ConstructL();

    40 	CleanupStack::Pop();

    41 	return self;

    42 	}

    44 /**

    45 Resets the current HSqlSrvStmtParamBuf instance.

    47 The internal buffer will be resized, if its capacity is bigger than HSqlSrvStmtParamBuf::EExpandSize * 2 bytes.

    49 @param aDataType Parameter value type - binary, text8 or text16.

    50 @param aBufType IPC stream buffer or a simple "bind param" buffer

    52 @panic SqlDb 2 In _DEBUG mode. Invalid HSqlSrvStmtParamBuf object.

    53 */

    54 inline void HSqlSrvStmtParamBuf::Reset(HSqlSrvStmtParamBuf::TDataType aDataType, HSqlSrvStmtParamBuf::TBufType aBufType)

    55 	{

    56 	__ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInvalidObj));

    58 	iStatementFinalized = EFalse;

    59 	iAlive = ETrue;

    60 	iDataType = aDataType;

    61 	iBufType = aBufType;

    62 	iSynchDone = EFalse;

    64 	iBuf->Delete(0, iBuf->Size());

    65 	if(iBuf->Capacity() > (HSqlSrvStmtParamBuf::EExpandSize * 2))

    66 		{

    67 		TRAPD(err, iBuf->SetReserveL(HSqlSrvStmtParamBuf::EExpandSize * 2));//the buffer size is minimized, the call can't fail

    68 		__ASSERT_ALWAYS(err == KErrNone, __SQLPANIC(ESqlPanicInternalError));

    69 		}

    70 	Set(*iBuf, 0, MStreamBuf::ERead | MStreamBuf::EWrite);

    71 	}

    73 /**

    74 Stores the aData into the buffer, from position 0.

    75 This function is used when the buffer type is not IPC.

    77 @param aData The data to be stored into the buffer

    79 @leave KErrNoMemory, an out of memory condition has occurred;

    81 @panic SqlDb 2 In _DEBUG mode. Invalid HSqlSrvStmtParamBuf object.

    82 @panic SqlDb 7 In _DEBUG mode. The buffer type is not HSqlSrvStmtParamBuf::EBufSimpleBind

    83 */

    84 inline const TPtrC8 HSqlSrvStmtParamBuf::SetDataL(const TDesC8& aData)

    85 	{

    86 	__ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInvalidObj));

    87 	__ASSERT_DEBUG(iBufType == HSqlSrvStmtParamBuf::EBufSimpleBind, __SQLPANIC(ESqlPanicInternalError));

    88 	iBuf->ResizeL(aData.Length());

    89 	iBuf->Write(0, aData);

    90 	//If the size is 0, then return KNullDesC8, where an empty string is hold, not a null one ("" instead of NULL)

    91 	// was return iBuf->Size() == 0 ? KNullDesC8() : iBuf->Ptr(0);

    92 	if (iBuf->Size() == 0)

    93 		{

    94 		return KNullDesC8();

    95 		}

    96 	return iBuf->Ptr(0);

    97 	}

    99 /**

   100 Returns a 8-bit pointer to the parameter data.

   102 @return 8-bit pointer to the parameter data.

   104 @panic SqlDb 2 In _DEBUG mode. Invalid HSqlSrvStmtParamBuf object.

   105 */

   106 inline const TPtrC8 HSqlSrvStmtParamBuf::Data() const

   107 	{

   108 	__ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInvalidObj));

   109 	//If the size is 0, then return KNullDesC8, where an empty string is hold, not a null one ("" instead of NULL)

   110 	// was return iBuf->Size() == 0 ? KNullDesC8() : iBuf->Ptr(0);

   111 	if (iBuf->Size() == 0)

   112 		{

   113 		return KNullDesC8();

   114 		}

   115 	return iBuf->Ptr(0);

   116 	}

   118 /**

   119 @return Buffered parameter value type - binary, text8 or text16.

   120 */

   121 inline HSqlSrvStmtParamBuf::TDataType HSqlSrvStmtParamBuf::DataType() const

   122 	{

   123 	return iDataType;

   124 	}

   126 /**

   127 Returns the parameter index.

   129 @panic SqlDb 7 In _DEBUG mode. Negative parameter index.

   131 @return Parameter index, zero based.

   132 */

   133 inline TInt HSqlSrvStmtParamBuf::ParamIndex() const

   134 	{

   135 	__ASSERT_DEBUG(iParamIndex >= 0, __SQLPANIC(ESqlPanicInternalError));

   136 	return iParamIndex;

   137 	}

   139 /**

   140 Initializes the HSqlSrvStmtParamBuf instance data members.

   142 @param aStatement A reference to the CSqlSrvStatement object, which needs the parameter data.

   143 @param aParameterIndex Parameter index, zero based.

   144 @param aDataType Parameter value type - binary, text8 or text16.

   145 @param aBufType IPC stream buffer or a simple "bind param" buffer

   146 */

   147 inline HSqlSrvStmtParamBuf::HSqlSrvStmtParamBuf(CSqlSrvStatement& aStatement, TInt aParamIndex,

   148 												HSqlSrvStmtParamBuf::TDataType aDataType, HSqlSrvStmtParamBuf::TBufType aBufType) :

   149 	iStatement(aStatement),

   150 	iBuf(NULL),

   151 	iParamIndex(aParamIndex),

   152 	iStatementFinalized(EFalse),

   153 	iAlive(EFalse),

   154 	iDataType(aDataType),

   155 	iBufType(aBufType),

   156 	iSynchDone(EFalse)

   157 	{

   158 	}

   160 /**

   161 HSqlSrvStmtParamBuf - second phase construction.

   162 Constructs the internal CFlatBuf object.

   164 @leave KErrNoMemory, an out of memory condition has occurred;

   165 */

   166 inline void HSqlSrvStmtParamBuf::ConstructL()

   167 	{

   168 	iBuf = CBufFlat::NewL(EExpandSize);

   169 	Set(*iBuf, 0, MStreamBuf::ERead | MStreamBuf::EWrite);

   170 	iAlive = ETrue;

   171 	}

   173 //////////////////////////////////////////////////////////////////////////////////////////////////////

   174 /////////////////////////////   CSqlSrvStatement class    ////////////////////////////////////////////

   175 //////////////////////////////////////////////////////////////////////////////////////////////////////

   177 /**

   178 Executes the SQL statement moving the cursor to the next row if there is a row available.

   180 @return KSqlErrStmtExpired, statement expired (if new functions or collating sequences are

   181 							registered or if an authorizer function is added or changed);

   182 		KErrNone, the operation completed successfully;

   183 		KSqlAtRow, the next record data is ready for processing by the caller;

   184 		KSqlAtEnd, no more records;

   185 		KSqlErrBusy, database file is locked;

   186 		KSqlErrGeneral, run-time error. Next() should not be called anymore;

   187 		KSqlErrMisuse, Next() called after KSqlAtEnd or KSqlErrGeneral returned by the previous Next() call;

   188 		KErrNoMemory, an out of memory condition has occurred. The statement will be reset.

   190 @panic SqlDb 2 In _DEBUG mode. Invalid (not created) CSqlSrvStatement object.

   191 @panic SqlDb 7 In _DEBUG mode. SQLITE internal error. (SQLITE_ERROR, followed by a sqlite3_reset(), which returns SQLITE_OK)

   192 */

   193 inline TInt CSqlSrvStatement::Next()

   194 	{

   195 	__ASSERT_DEBUG(iStmtHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));

   196 	TInt err = ::StmtNext(iStmtHandle);

   197 	iBufFlatType = static_cast <TSqlBufFlatType> (-1);

   198 	iBufFlat.ResetAndMinimize();

   199 	return err;

   200 	}

   202 /**

   203 Resets the prepared SQL statement to its initial state and makes it ready to be executed again.

   205 Any SQL statement parameters that had values bound to them, retain their values.

   207 @return KErrNone,  the operation completed successfully;

   208 		KSqlErrStmtExpired, Statement expired (if new functions or collating sequences are

   209 							registered or if an authorizer function is added or changed)

   211 @panic SqlDb 2 In _DEBUG mode. Invalid (not created) CSqlSrvStatement object.

   212 */

   213 inline TInt CSqlSrvStatement::Reset()

   214 	{

   215 	__ASSERT_DEBUG(iStmtHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));

   216 	iBufFlatType = static_cast <TSqlBufFlatType> (-1);

   217 	iBufFlat.ResetAndMinimize();

   218 	return ::StmtReset(iStmtHandle);

   219 	}

   221 /**

   222 Executes the prepared SQL statement.

   224 @return KErrNone, the operation completed successfully;

   225 		KSqlErrStmtExpired, statement expired (if new functions or collating sequences are

   226 							registered or if an authorizer function is added or changed);

   227 		KErrNoMemory, an out of memory condition has occurred. The statement will be reset.

   229 @panic SqlDb 2 In _DEBUG mode. Invalid (not created) CSqlSrvStatement object.

   230 @panic SqlDb 7 In _DEBUG mode. SQLITE internal error. (SQLITE_ERROR, followed by a sqlite3_reset(), which returns SQLITE_OK)

   231 */

   232 inline TInt CSqlSrvStatement::Exec()

   233 	{

   234 	__ASSERT_DEBUG(iStmtHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));

   235 	TInt err = ::StmtExec(iStmtHandle);

   236 	iBufFlatType = static_cast <TSqlBufFlatType> (-1);

   237 	iBufFlat.ResetAndMinimize();

   238 	return err;

   239 	}

   241 /**

   242 @panic SqlDb 2 In _DEBUG mode. Invalid (not created) CSqlSrvStatement object.

   243 */

   244 inline const RSqlBufFlat& CSqlSrvStatement::BufFlatL(TSqlBufFlatType aWhat) const

   245 	{

   246 	__ASSERT_DEBUG(iStmtHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));

   247 	if(aWhat != iBufFlatType)

   248 		{

   249 		__SQLLEAVE(KErrArgument);

   250 		}

   251 	return iBufFlat;

   252 	}

   254 /**

   255 */

   256 inline CSqlSrvStatement::CSqlSrvStatement()

   257 	{

   258 	}

   260 /**

   261 Initializes CSqlSrvStatement instance.

   263 @param aDbHandle The database handle

   264 @param aSqlStmt 16-bit SQL statement, zero-terminated string

   266 @leave KErrNoMemory, an out of memory condition has occurred;

   267 	   KErrArgument, bad argument, for example - the SQL string contains more than one SQL statements;

   268                   Note that the function may also leave with some other database specific

   269                   errors categorised as ESqlDbError.

   271 @panic SqlDb 4 In _DEBUG mode. aDbHandle is NULL.

   272 */

   273 inline void CSqlSrvStatement::ConstructL(sqlite3* aDbHandle, const TDesC16& aSqlStmt)

   274 	{

   275 	__ASSERT_DEBUG(aDbHandle != NULL, __SQLPANIC(ESqlPanicBadArgument));

   276 	iStmtHandle = ::StmtPrepare16L(aDbHandle, aSqlStmt);

   277 	DoCommonConstructL();

   278 	}

   280 /**

   281 Initializes CSqlSrvStatement instance.

   283 @param aDbHandle The database handle

   284 @param aSqlStmt 8-bit SQL statement, zero-terminated string

   286 @leave KErrNoMemory, an out of memory condition has occurred;

   287 	   KErrArgument, bad argument, for example - the SQL string contains more than one SQL statements;

   288                   Note that the function may also leave with some other database specific

   289                   errors categorised as ESqlDbError.

   291 @panic SqlDb 4 In _DEBUG mode. aDbHandle is NULL.

   292 */

   293 inline void CSqlSrvStatement::ConstructL(sqlite3* aDbHandle, const TDesC8& aSqlStmt)

   294 	{

   295 	__ASSERT_DEBUG(aDbHandle != NULL, __SQLPANIC(ESqlPanicBadArgument));

   296 	iStmtHandle = ::StmtPrepare8L(aDbHandle, aSqlStmt);

   297 	DoCommonConstructL();

   298 	}

author	sl@SLION-WIN7.fritz.box
	Fri, 15 Jun 2012 03:10:57 +0200
changeset 0	bde4ae8d615e
permissions	-rw-r--r--