1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/SRC/Client/SqlStmtSession.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,116 @@
1.4 +// Copyright (c) 2005-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 +// NTT DOCOMO, INC - Fix for Bug 1915 "SQL server panics when using long column type strings"
1.16 +//
1.17 +// Description:
1.18 +//
1.19 +
1.20 +#ifndef __SQLSTMTSESSION_H__
1.21 +#define __SQLSTMTSESSION_H__
1.22 +
1.23 +#include <e32std.h>
1.24 +#include "SqlDbSession.h" //RSqlDbSession
1.25 +#include "SqlBufFlat.h" //RSqlBufFlat
1.26 +#include "IPCBuf.h" //HIpcBuf
1.27 +
1.28 +/**
1.29 +RSqlStatementSession class is used for "prepare once execute many times" supplied to PrepareL() SQL
1.30 +statement.
1.31 +RSqlStatementSession::PrepareL() must be called for preparing the SQL statement.
1.32 +If the SQL statement contains parameters, Bind() must be called before calling Next() or Exec()
1.33 +to bind the parameter values.
1.34 +RSqlStatementSession class shall not be used for executing a set of SQL statements, separated with ";".
1.35 +PrepareL() will report this as a KErrArgument error.
1.36 +
1.37 +RSqlStatementSession class hides all details about the communication with the database server.
1.38 +No database specific header files should be seen or used outside the session class.
1.39 +
1.40 +Usage patterns:
1.41 +
1.42 +1) SQL statement which does not return a record set.
1.43 +
1.44 +@code
1.45 + RSqlStatementSession sess;
1.46 + TInt err = sess.Prepare(...);
1.47 + ...
1.48 + RSqlBufFlat paramBuf;
1.49 + <Initialize "paramBuf" object>;
1.50 +begin:
1.51 + err = sess.Bind(paramBuf);
1.52 + err = sess.Exec();
1.53 + err = sess.Reset();
1.54 + <Now a new set of parameter values can be prepared and the statement can be executed again - from the "begin" label>;
1.55 +
1.56 + sess.Close();
1.57 +@endcode
1.58 +
1.59 +2) SQL statement which returns a record set.
1.60 +
1.61 +@code
1.62 + RSqlStatementSession sess;
1.63 + TInt err = sess.Prepare(...);
1.64 + ...
1.65 + RSqlBufFlat paramBuf;
1.66 + <Initialize "paramBuf" object>;
1.67 + RSqlBufFlat columnBuf;
1.68 + <Initialize "columnBuf" object. The element count must match the columns count>;
1.69 +begin:
1.70 + err = sess.Bind(paramBuf);
1.71 + while(sess.Next(columnBuf) == KSqlAtRow)
1.72 + {
1.73 + <process the record data - "columnBuf" set>;
1.74 + }
1.75 + err = sess.Reset();
1.76 + <Now a new set of parameter values can be prepared and the statement can be executed again - from the "begin" label>;
1.77 +
1.78 + sess.Close();
1.79 +@endcode
1.80 +
1.81 +@internalComponent
1.82 +*/
1.83 +NONSHARABLE_CLASS(RSqlStatementSession)
1.84 + {
1.85 +public:
1.86 + inline RSqlStatementSession();
1.87 + TInt Prepare(RSqlDbSession& aDbSession, const TDesC& aSqlStmt, TInt& aColumnCount, TInt& aParamCount);
1.88 + TInt Prepare(RSqlDbSession& aDbSession, const TDesC8& aSqlStmt, TInt& aColumnCount, TInt& aParamCount);
1.89 + void Close();
1.90 +
1.91 + inline TInt Reset();
1.92 + inline TInt Exec();
1.93 + inline void Exec(TRequestStatus& aStatus);
1.94 + inline TInt BindExec(const RSqlBufFlat& aParamBuf);
1.95 + inline void BindExec(const RSqlBufFlat& aParamBuf, TRequestStatus& aStatus);
1.96 + inline TInt Next(RSqlBufFlat& aColumnBuf);
1.97 + TInt BindNext(const RSqlBufFlat& aParamBuf, RSqlBufFlat& aColumnBuf);
1.98 + TInt GetNames(TSqlSrvFunction aFunction, RSqlBufFlat& aNameBuf);
1.99 + inline TInt ReadColumnValue(TInt aColumnIndex, TDes8& aBuf);
1.100 +
1.101 + inline MStreamBuf* ColumnSourceL(TInt aColumnIndex);
1.102 + inline MStreamBuf* ParamSinkL(TSqlSrvFunction aFunction, TInt aParamIndex);
1.103 +
1.104 + TInt GetDeclColumnTypes(RSqlBufFlat& aDeclColumnTypeBuf);
1.105 +
1.106 +private:
1.107 + TInt DoBindNext(TSqlSrvFunction aFunction, TIpcArgs& aIpcArgs, RSqlBufFlat& aColumnBuf);
1.108 + TInt Retry(RSqlBufFlat& aBufFlat, TInt aSize, TSqlBufFlatType aWhat);
1.109 + inline RSqlDbSession& DbSession() const;
1.110 +
1.111 +private:
1.112 + TInt iHandle;
1.113 + RSqlDbSession* iDbSession;
1.114 +
1.115 + };
1.116 +
1.117 +#include "SqlStmtSession.inl"
1.118 +
1.119 +#endif//__SQLSTMTSESSION_H__