sl@0: // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Initializes RSqlDbSession data members with their default values.
sl@0: // 
sl@0: //
sl@0: 
sl@0: inline RSqlDbSession::RSqlDbSession() :
sl@0: 	iLastErrorMessage(NULL)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sends a command to the server to detach previously attached database.
sl@0: 
sl@0: @param aDbName Logical database name. 
sl@0: 
sl@0: @return KErrNone, operation has completed successfully;
sl@0: 		KErrNotFound, no attached database with aDbName name.
sl@0:                       Note that database specific errors categorised as ESqlDbError, and
sl@0:                       other system-wide error codes may also be returned.
sl@0: 
sl@0: Usage of the IPC call arguments: 
sl@0: Arg 0: [out]	Logical database name length.
sl@0: Arg 1: [out]	Logical database name.
sl@0: */
sl@0: inline TInt RSqlDbSession::Detach(const TDesC& aDbName)
sl@0: 	{
sl@0: 	return SendReceive(ESqlSrvDbDetach, TIpcArgs(aDbName.Length(), &aDbName));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Executes one or more 16-bit SQL statements.
sl@0: 
sl@0: The method sends a message to the SQL server containing one or more 16-bit SQL statements to be executed.
sl@0: SQL statements of any kind can be executed, but the method won't return any record(s) 
sl@0: if the SQL statement type is "SELECT".
sl@0: If the SQL statement(s) contains one or more parameters, these parameters will be set to NULL before the
sl@0: execution.
sl@0: If the call fails and the error class is ESqlDbError, a text description of the error can be obtained using
sl@0: LastErrorMessage() method.
sl@0: 
sl@0: @param aSqlStmt String containing one or more 8/16-bit SQL statements, separated with ';'.
sl@0: 
sl@0: @return >=0, The operation has completed successfully. The number of database rows that were 
sl@0: 			 changed/inserted/deleted by the most recently completed INSERT/UPDATE/DELETE sql statement.
sl@0: 			 Exception: If the executed statement is "DELETE FROM <table>", then the function returns 0 
sl@0: 			 if the operation has completed successfully (disregarding the number of the deleted rows);
sl@0: 		KErrNoMemory, an out of memory condition has occured;
sl@0: 		KSqlErrGeneral, Syntax error. A text message describing the problem can be obtained calling
sl@0: 						LastErrorMessage().
sl@0: 
sl@0: Usage of the IPC call arguments: 
sl@0: Arg 0: [out]	16-bit character length of SQL statement.
sl@0: Arg 1: [out]	SQL statement(s).
sl@0: */
sl@0: inline TInt RSqlDbSession::Exec(const TDesC& aSqlStmt)
sl@0: 	{
sl@0: 	return SendReceive(ESqlSrvDbExec16, TIpcArgs(aSqlStmt.Length(), &aSqlStmt));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Executes one or more 8-bit SQL statements.
sl@0: 
sl@0: The method sends a message to the SQL server containing one or more 8-bit SQL statements to be executed.
sl@0: SQL statements of any kind can be executed, but the method won't return any record(s) 
sl@0: if the SQL statement type is "SELECT".
sl@0: If the SQL statement(s) contains one or more parameters, these parameters will be set to NULL before the
sl@0: execution.
sl@0: If the call fails and the error class is ESqlDbError, a text description of the error can be obtained using
sl@0: LastErrorMessage() method.
sl@0: 
sl@0: @param aSqlStmt String containing one or more 8-bit SQL statements, separated with ';'.
sl@0: 
sl@0: @return >=0, The operation has completed successfully. The number of database rows that were 
sl@0: 			 changed/inserted/deleted by the most recently completed INSERT/UPDATE/DELETE sql statement.
sl@0: 			 Exception: If the executed statement is "DELETE FROM <table>", then the function returns 0 
sl@0: 			 if the operation has completed successfully (disregarding the number of the deleted rows);
sl@0: 		KErrNoMemory, an out of memory condition has occured;
sl@0: 		KSqlErrGeneral, Syntax error. A text message describing the problem can be obtained calling
sl@0: 						LastErrorMessage().
sl@0: 
sl@0: Usage of the IPC call arguments: 
sl@0: Arg 0: [out]	8-bit character length of SQL statement.
sl@0: Arg 1: [out]	SQL statement(s).
sl@0: */
sl@0: inline TInt RSqlDbSession::Exec(const TDesC8& aSqlStmt)
sl@0: 	{
sl@0: 	return SendReceive(ESqlSrvDbExec8, TIpcArgs(aSqlStmt.Length(), &aSqlStmt));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Executes one or more 16-bit SQL statements asynchronously.
sl@0: 
sl@0: The method sends a message to the SQL server containing one or more 16-bit SQL statements to be executed.
sl@0: SQL statements of any kind can be executed, but the method won't return any record(s) 
sl@0: if the SQL statement type is "SELECT".
sl@0: If the SQL statement(s) contains one or more parameters, these parameters will be set to NULL before the
sl@0: execution.
sl@0: If the call fails and the error class is ESqlDbError, a text description of the error can be obtained using
sl@0: LastErrorMessage() method.
sl@0: 
sl@0: @param aSqlStmt String containing one or more 16-bit SQL statements, separated with ';'.
sl@0: @param aStatus Completion status of asynchronous request, one of the following:
sl@0: @code
sl@0: 		- >=0, The operation has completed successfully. The number of database rows that were 
sl@0: 			   changed/inserted/deleted by the most recently completed INSERT/UPDATE/DELETE sql statement.
sl@0: 			 Exception: If the executed statement is "DELETE FROM <table>", then the function returns 0 
sl@0: 			 if the operation has completed successfully (disregarding the number of the deleted rows);
sl@0:         - KSqlErrStmtExpired, the SQL statement has expired (if new functions or
sl@0:                             collating sequences have been registered or if an
sl@0:                             authorizer function has been added or changed);
sl@0:         - KErrNoMemory, an out of memory condition has occurred - the statement
sl@0:                       will be reset.
sl@0:                       Note that aStatus may be set with database specific errors categorised as ESqlDbError, 
sl@0:                       and other system-wide error codes.
sl@0: @endcode
sl@0: 
sl@0: Usage of the IPC call arguments: 
sl@0: Arg 0: [out]	16-bit character length of SQL statement.
sl@0: Arg 1: [out]	SQL statement(s).
sl@0: */
sl@0: inline void RSqlDbSession::Exec(const TDesC& aSqlStmt, TRequestStatus& aStatus)
sl@0: 	{
sl@0: 	SendReceive(ESqlSrvDbExec16, TIpcArgs(aSqlStmt.Length(), &aSqlStmt), aStatus);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Executes one or more 8-bit SQL statements asynchronously.
sl@0: 
sl@0: The method sends a message to the SQL server containing one or more 8-bit SQL statements to be executed.
sl@0: SQL statements of any kind can be executed, but the method won't return any record(s) 
sl@0: if the SQL statement type is "SELECT".
sl@0: If the SQL statement(s) contains one or more parameters, these parameters will be set to NULL before the
sl@0: execution.
sl@0: If the call fails and the error class is ESqlDbError, a text description of the error can be obtained using
sl@0: LastErrorMessage() method.
sl@0: 
sl@0: @param aSqlStmt String containing one or more 8-bit SQL statements, separated with ';'.
sl@0: @param aStatus Completion status of asynchronous request, one of the following:
sl@0: @code
sl@0: 		- >=0, The operation has completed successfully. The number of database rows that were 
sl@0: 			   changed/inserted/deleted by the most recently completed INSERT/UPDATE/DELETE sql statement.
sl@0: 			 Exception: If the executed statement is "DELETE FROM <table>", then the function returns 0 
sl@0: 			 if the operation has completed successfully (disregarding the number of the deleted rows);
sl@0:         - KSqlErrStmtExpired, the SQL statement has expired (if new functions or
sl@0:                             collating sequences have been registered or if an
sl@0:                             authorizer function has been added or changed);
sl@0:         - KErrNoMemory, an out of memory condition has occurred - the statement
sl@0:                       will be reset.
sl@0:                       Note that aStatus may be set with database specific errors categorised as ESqlDbError, 
sl@0:                       and other system-wide error codes.
sl@0: @endcode
sl@0: 
sl@0: Usage of the IPC call arguments: 
sl@0: Arg 0: [out]	8-bit character length of SQL statement.
sl@0: Arg 1: [out]	SQL statement(s).
sl@0: */
sl@0: inline void RSqlDbSession::Exec(const TDesC8& aSqlStmt, TRequestStatus& aStatus)
sl@0: 	{
sl@0: 	SendReceive(ESqlSrvDbExec8, TIpcArgs(aSqlStmt.Length(), &aSqlStmt), aStatus);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sets the transaction isolation level.
sl@0: 
sl@0: The method sends a message to the SQL server to set the desired isolation level.
sl@0: The default isolation level is RSqlDatabase::ESerializable, but can be changed to 
sl@0: RSqlDatabase::EReadUncommitted for database connections which share the access to the same database file.
sl@0: 
sl@0: @param aIsolationLevel Desired isolation level: RSqlDatabase::ESerializable or RSqlDatabase::EReadUncommitted.
sl@0: @return KErrNone, the operation has completed successfully.
sl@0:                   The function may also return some other system-wide error codes.
sl@0: 
sl@0: Usage of the IPC call arguments: 
sl@0: Arg 0: [out]	Isolation level type.
sl@0: */
sl@0: inline TInt RSqlDbSession::SetIsolationLevel(RSqlDatabase::TIsolationLevel aIsolationLevel)
sl@0: 	{
sl@0: 	return SendReceive(ESqlSrvDbSetIsolationLevel, TIpcArgs(static_cast <TInt> (aIsolationLevel)));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Usage of the IPC call arguments: 
sl@0: Arg 0: [out]	(16-bit character length of SQL statement) | (expected column value type << 24).
sl@0: Arg 1: [out]	SQL statement.
sl@0: Arg 2: [out]	Byte max length of the receiving buffer
sl@0: Arg 3: [in/out]	The receiving buffer
sl@0: */
sl@0: inline TInt RSqlDbSession::ExecScalarFullSelect(const TDesC& aSqlStmt, TSqlColumnType aType, TDes8& aRes)
sl@0: 	{
sl@0: 	return SendReceive(ESqlSrvDbScalarFullSelect16, TIpcArgs(aSqlStmt.Length() | (aType << 24), &aSqlStmt, aRes.MaxLength(), &aRes));
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Usage of the IPC call arguments: 
sl@0: Arg 0: [out]	(8-bit character length of SQL statement) | (expected column value type << 24).
sl@0: Arg 1: [out]	SQL statement.
sl@0: Arg 2: [out]	Byte max length of the receiving buffer
sl@0: Arg 3: [in/out]	The receiving buffer
sl@0: */
sl@0: inline TInt RSqlDbSession::ExecScalarFullSelect(const TDesC8& aSqlStmt, TSqlColumnType aType, TDes8& aRes)
sl@0: 	{
sl@0: 	return SendReceive(ESqlSrvDbScalarFullSelect8, TIpcArgs(aSqlStmt.Length() | (aType << 24), &aSqlStmt, aRes.MaxLength(), &aRes));
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: The method sends a message to the SQL server.
sl@0: 
sl@0: @param aFunction Function code
sl@0: 
sl@0: @return KErrNone or system-wide error codes.
sl@0: */
sl@0: inline TInt RSqlDbSession::SendReceive(TInt aFunction)
sl@0: 	{
sl@0: 	return RSessionBase::SendReceive(aFunction);	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: The method sends a message asynchronously to the SQL server.
sl@0: 
sl@0: @param aFunction Function code
sl@0: 
sl@0: @return KErrNone or system-wide error codes.
sl@0: */
sl@0: inline void RSqlDbSession::SendReceive(TInt aFunction, TRequestStatus& aStatus)
sl@0: 	{
sl@0: 	RSessionBase::SendReceive(aFunction, aStatus);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: The method sends a message with arguments to the SQL server.
sl@0: 
sl@0: @param aFunction Function code
sl@0: @param aArgs Message arguments
sl@0: 
sl@0: @return KErrNone or system-wide error codes.
sl@0: */
sl@0: inline TInt RSqlDbSession::SendReceive(TInt aFunction, const TIpcArgs& aArgs)
sl@0: 	{
sl@0: 	return RSessionBase::SendReceive(aFunction, aArgs);	
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: The method sends asynchronously a message with arguments to the SQL server.
sl@0: 
sl@0: @param aFunction Function code
sl@0: @param aArgs Message arguments
sl@0: @param aStatus Completion status of asynchronous request
sl@0: */
sl@0: inline void RSqlDbSession::SendReceive(TInt aFunction,const TIpcArgs& aArgs, TRequestStatus& aStatus)
sl@0: 	{
sl@0: 	RSessionBase::SendReceive(aFunction, aArgs, aStatus);	
sl@0: 	}