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: //
sl@0: 
sl@0: /**
sl@0: */
sl@0: inline CSqlDatabaseImpl::CSqlDatabaseImpl()
sl@0: 	{
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Attaches a secure or non-secure database.
sl@0: 
sl@0: Implements RSqlDatabase::Attach().
sl@0: 
sl@0: @param aDbFileName The name of the file that hosts the database. If this is
sl@0:                    a secure database, then the format of the name must be:
sl@0:                    \<drive\>:\<[SID]database file name excluding the path\>.
sl@0:                    If this is a private or shared non-secure database, then aDbFileName has to be the full 
sl@0:                    database file name. "[SID]" refers to SID of the application which created the attached database.
sl@0: @param aDbName Logical database name. It must be unique (per database connection). This is the name which can
sl@0:                be used for accessing tables in the attached database. The syntax is "database-name.table-name".
sl@0: 
sl@0: @return KErrNone, the operation has completed successfully;
sl@0:         KErrNoMemory, an out of memory condition has occurred;
sl@0:         KErrBadName, the file name is invalid - it has either a zero length or it is the name of a directory;
sl@0:         KErrNotReady, the drive does not exist or is not ready;
sl@0:         KErrInUse, the file is already open;
sl@0:         KErrNotFound, database file not found;
sl@0:         KErrGeneral, missing or invalid security policies (if the database to be opened is a secure database);
sl@0:         KErrPermissionDenied, the caller does not satisfy the relevant database security policies;
sl@0:         KErrNotSupported, incompatible SQL security version (if the database to be opened is a secure database).
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: @see RSqlDatabase
sl@0: @see RSqlDatabase::Attach()
sl@0: */
sl@0: inline TInt CSqlDatabaseImpl::Attach(const TDesC& aDbFileName, const TDesC& aDbName)
sl@0: 	{
sl@0: 	return Session().Attach(aDbFileName, aDbName);
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Detaches previously attached database.
sl@0: 
sl@0: Implements RSqlDatabase::Detach().
sl@0: 
sl@0: @param aDbName Logical database name. The logical name of the database to be detached.
sl@0: 
sl@0: @return KErrNone, the 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: @see RSqlDatabase
sl@0: @see RSqlDatabase::Detach()
sl@0: */
sl@0: inline TInt CSqlDatabaseImpl::Detach(const TDesC& aDbName)
sl@0: 	{
sl@0: 	return Session().Detach(aDbName);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Copies a database file to the specified location.
sl@0: 
sl@0: Implements RSqlDatabase::Copy().
sl@0: 
sl@0: @param aSrcDbFileName Source database file name.
sl@0: 					  If this is a secure database, then the format of the name must be:
sl@0: 					  \<drive\>:\<[SID]database file name excluding the path\>.
sl@0: 					  If this is a non-secure database, then aDbFileName has to be the full database file name.
sl@0: 					  "[SID]" refers to SID of the application which created the database.
sl@0: @param aDestDbFileName Destination database file name.
sl@0: 					  If this is a secure database, then the format of the name must be:
sl@0: 					  \<drive\>:\<[SID]database file name excluding the path\>.
sl@0: 					  If this is a non-secure database, then aDbFileName has to be the full database file name.
sl@0: 					  "[SID]" refers to SID of the application which performs the copying operation.
sl@0: 
sl@0: The allowed copying operations are:
sl@0: - secure to secure database. Only the application created the database is allowed to copy it.
sl@0: - non-secure to non-secure database. No restrictions apply to this operation.
sl@0: 
sl@0: @return KErrNone, the operation completed has successfully;
sl@0:         KErrBadName, the file name is invalid - it has either a zero length or it is the name of a directory;
sl@0:         KErrNotReady, the drive does not exist or is not ready;
sl@0:         KErrInUse, the file is already open;
sl@0:         KErrNotFound, database file not found;
sl@0:         KErrPermissionDenied, the SID of the calling application does not match the SID of source or destination database.
sl@0:                       Note that other system-wide error codes may also be returned.
sl@0: 
sl@0: @see RSqlDatabase
sl@0: @see RSqlDatabase::Copy()
sl@0: */
sl@0: inline TInt CSqlDatabaseImpl::Copy(const TDesC& aSrcDbFileName, const TDesC& aDestDbFileName)
sl@0: 	{
sl@0: 	return RSqlDbSession::CopyDatabase(aSrcDbFileName, aDestDbFileName);
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Deletes the specified database file.
sl@0: 
sl@0: Implements RSqlDatabase::Delete().
sl@0: 
sl@0: @param aDbFileName The name of the database file.
sl@0: 				   If this is a secure database, then the format of the name must be:
sl@0: 				   \<drive\>:\<[SID]database file name excluding the path\>.
sl@0: 				   If this is a private or shared non-secure database, then aDbFileName has to be the 
sl@0: 				   full database file name. "[SID]" refers to SID of the application which created the database.
sl@0: 
sl@0: @return KErrNone, the operation has completed successfully;
sl@0:         KErrBadName, the file name is invalid - it has either a zero length or it is the name of a directory;
sl@0:         KErrNotReady, the drive does not exist or is not ready;
sl@0:         KErrInUse, the database file is in use;
sl@0:         KErrNotFound, the database file cannot be found;
sl@0:         KErrAccessDenied, access to the database file is denied (e.g. it might be a read-only file);
sl@0:         KErrPermissionDenied, the SID of the calling application does not match the SID of the database;
sl@0:                       Note that other system-wide error codes may also be returned.
sl@0: 
sl@0: @see RSqlDatabase
sl@0: @see RSqlDatabase::Delete()
sl@0: */
sl@0: inline TInt CSqlDatabaseImpl::Delete(const TDesC& aDbFileName)
sl@0: 	{
sl@0: 	return RSqlDbSession::DeleteDatabase(aDbFileName);
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Sets the transaction isolation level for the database.
sl@0: 
sl@0: Implements RSqlDatabase::SetIsolationLevel().
sl@0: 
sl@0: @param aIsolationLevel The isolation level to be set.
sl@0: 					   Allowed isolation level values are:
sl@0: 					   - RSqlDatabase::EReadUncommitted;
sl@0: 					   - RSqlDatabase::ESerializable;
sl@0:                        
sl@0: @return KErrNone, if the operation has completed successfully;
sl@0: 		KErrNotSupported, invalid (not supported) transaction isolation level;
sl@0: 
sl@0: @see RSqlDatabase
sl@0: @see RSqlDatabase::SetIsolationLevel()
sl@0: */
sl@0: inline TInt CSqlDatabaseImpl::SetIsolationLevel(RSqlDatabase::TIsolationLevel aIsolationLevel)
sl@0: 	{
sl@0: 	return Session().SetIsolationLevel(aIsolationLevel);
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Executes one or more 16-bit DDL/DML SQL statements.
sl@0: 
sl@0: Implements RSqlDatabase::Exec().
sl@0: 
sl@0: @param aSqlStmt A string of 16-bit wide characters containing one or more DDL/DML SQL statements;
sl@0:                 each statement is separated by a ';' character.
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 DDL/DML 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, a syntax error has occurred - text describing the problem
sl@0:                         can be obtained by calling 	RSqlDatabase::LastErrorMessage();
sl@0:         KErrPermissionDenied, the caller does not satisfy the relevant database security policies.
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: @see RSqlDatabase
sl@0: @see RSqlDatabase::Exec()
sl@0: */
sl@0: inline TInt CSqlDatabaseImpl::Exec(const TDesC16& aSqlStmt)
sl@0: 	{
sl@0: 	return Session().Exec(aSqlStmt);
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Executes one or more 8-bit DDL/DML SQL statements.
sl@0: 
sl@0: Implements RSqlDatabase::Exec().
sl@0: 
sl@0: @param aSqlStmt A string of 8-bit wide characters containing one or more DDL/DML SQL statements;
sl@0:                 each statement is separated by a ';' character.
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 DDL/DML 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, a syntax error has occurred - text describing the problem
sl@0:                         can be obtained by calling 	RSqlDatabase::LastErrorMessage();
sl@0:         KErrPermissionDenied, the caller does not satisfy the relevant database security policies.
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: @see RSqlDatabase
sl@0: @see RSqlDatabase::Exec()
sl@0: */
sl@0: inline TInt CSqlDatabaseImpl::Exec(const TDesC8& aSqlStmt)
sl@0: 	{
sl@0: 	return Session().Exec(aSqlStmt);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Executes one or more 16-bit DDL/DML SQL statements asynchronously.
sl@0: 
sl@0: Implements RSqlDatabase::Exec().
sl@0: 
sl@0: @param aSqlStmt A string of 16-bit wide characters containing one or more DDL/DML SQL statements;
sl@0:                 each statement is separated by a ';' character.
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 DDL/DML 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, a syntax error has occurred - text describing the problem
sl@0:                         can be obtained by calling 	RSqlDatabase::LastErrorMessage();
sl@0:         	- KErrPermissionDenied, the caller does not satisfy the relevant database security policies;
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: @see RSqlDatabase
sl@0: @see RSqlDatabase::Exec()
sl@0: */
sl@0: inline void CSqlDatabaseImpl::Exec(const TDesC16& aSqlStmt, TRequestStatus& aStatus)
sl@0: 	{
sl@0: 	Session().Exec(aSqlStmt, aStatus);
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Executes one or more 8-bit DDL/DML SQL statements asynchronously.
sl@0: 
sl@0: Implements RSqlDatabase::Exec().
sl@0: 
sl@0: @param aSqlStmt A string of 8-bit wide characters containing one or more DDL/DML SQL statements;
sl@0:                 each statement is separated by a ';' character.
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 DDL/DML 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, a syntax error has occurred - text describing the problem
sl@0:                         can be obtained by calling 	RSqlDatabase::LastErrorMessage();
sl@0:         	- KErrPermissionDenied, the caller does not satisfy the relevant database security policies;
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: @see RSqlDatabase
sl@0: @see RSqlDatabase::Exec()
sl@0: */
sl@0: inline void CSqlDatabaseImpl::Exec(const TDesC8& aSqlStmt, TRequestStatus& aStatus)
sl@0: 	{
sl@0: 	Session().Exec(aSqlStmt, aStatus);
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Retrieves a reference to the textual description of the error returned by the
sl@0: most recent call.
sl@0: 
sl@0: Implements RSqlDatabase::LastErrorMessage().
sl@0: 
sl@0: @return A non-modifiable pointer descriptor representing the most recent error
sl@0:         message. Note that message may be NULL, i.e. the descriptor may have
sl@0:         zero length.
sl@0: 
sl@0: @see RSqlDatabase
sl@0: @see RSqlDatabase::LastErrorMessage()
sl@0: */
sl@0: inline TPtrC CSqlDatabaseImpl::LastErrorMessage()
sl@0: 	{
sl@0: 	return Session().LastErrorMessage();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Returns the ROWID of the most recent successful INSERT into the database 
sl@0: from this database connection.
sl@0: 
sl@0: Implements RSqlDatabase::LastInsertedRowId().
sl@0: 
sl@0: @return >0, the ROWID of the most recent successful INSERT into the database
sl@0: 			from this database connection;
sl@0: 		0, 	if no successful INSERTs have ever occurred from this database connection
sl@0: 		<0, if one of the system-wide error codes is returned
sl@0: 
sl@0: @see RSqlDatabase::LastInsertedRowId()
sl@0: */
sl@0: inline TInt64 CSqlDatabaseImpl::LastInsertedRowId()
sl@0: 	{
sl@0: 	return Session().LastInsertedRowId();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return A reference to RSqlDbSession instance.
sl@0: */
sl@0: inline RSqlDbSession& CSqlDatabaseImpl::Session()
sl@0: 	{
sl@0: 	return iDbSession;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sends a command to the server to Execute a SELECT query which is expected to return a single row consisting of
sl@0: a single column value and copies that value to the place refered by aRes parameter.
sl@0: 
sl@0: @param aSqlStmt 16-bit SELECT sql query
sl@0: @param aType    The expected column type
sl@0: @param aRes     Output parameter. Refers to the place where the result must be copied
sl@0: 
sl@0: @return KErrNone, if the function completes successfully,
sl@0: 		Positive value, The column value length, in case if the receiving buffer 
sl@0: 						is not big enough. This return result is possible only with text or binary columns.
sl@0: 		          
sl@0: @leave  The function may leave with database specific errors categorised as ESqlDbError and
sl@0:   		other system-wide error codes.
sl@0: */
sl@0: inline TInt CSqlDatabaseImpl::ExecScalarFullSelectL(const TDesC16& aSqlStmt, TSqlColumnType aType, TDes8& aRes)
sl@0: 	{
sl@0: 	TInt rc = Session().ExecScalarFullSelect(aSqlStmt, aType, aRes);
sl@0: 	__SQLLEAVE_IF_ERROR(rc);
sl@0: 	return rc;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sends a command to the server to Execute a SELECT query which is expected to return a single row consisting of
sl@0: a single column value and copies that value to the place refered by aRes parameter.
sl@0: 
sl@0: @param aSqlStmt 8-bit SELECT sql query
sl@0: @param aType    The expected column type
sl@0: @param aRes     Output parameter. Refers to the place where the result must be copied
sl@0: 
sl@0: @return KErrNone, if the function completes successfully,
sl@0: 		Positive value, The column value length, in case if the receiving buffer 
sl@0: 						is not big enough. This return result is possible only with text or binary columns.
sl@0: 		          
sl@0: @leave  The function may leave with database specific errors categorised as ESqlDbError and
sl@0:   		other system-wide error codes.
sl@0: */
sl@0: inline TInt CSqlDatabaseImpl::ExecScalarFullSelectL(const TDesC8& aSqlStmt, TSqlColumnType aType, TDes8& aRes)
sl@0: 	{
sl@0: 	TInt rc = Session().ExecScalarFullSelect(aSqlStmt, aType, aRes);
sl@0: 	__SQLLEAVE_IF_ERROR(rc);
sl@0: 	return rc;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return True, if the database is in transaction, false otherwise.
sl@0: */
sl@0: inline TBool CSqlDatabaseImpl::InTransaction()
sl@0: 	{
sl@0: 	return 	Session().SendReceive(ESqlSrvDbInTransaction) != 0;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return >= 0, 		  the operation has completed successfully. The number is the size of the main
sl@0: 					  database file,
sl@0:         KErrNoMemory, an out of memory condition has occurred;
sl@0:         KErrTooBig,   the database is too big and the size cannot fit into 32-bit signed integer;
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: inline TInt CSqlDatabaseImpl::Size()
sl@0: 	{
sl@0: 	return Session().SendReceive(ESqlSrvDbSize);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Returns the database file size and free space, in bytes.
sl@0: 
sl@0: @param aSize An output parameter. If the call was successfull the aSize object will contain information
sl@0: 			 about the database size and database free space.
sl@0: @param aDbName The attached database name or KNullDesC for the main database
sl@0: 
sl@0: @return KErrNone, The operation has completed succesfully;
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: [in/out]	Points to a RSqldatabase::TSize object, where the database size and free space values
sl@0: 			    will be copied.
sl@0: Arg 1: [out]	The database name length in characters
sl@0: Arg 2: [out]	The attached database name or KNullDesC for the main database
sl@0: */
sl@0: inline TInt CSqlDatabaseImpl::Size(RSqlDatabase::TSize& aSize, const TDesC& aDbName)
sl@0: 	{
sl@0: 	TPtr8 ptr(reinterpret_cast <TUint8*> (&aSize), sizeof(aSize));
sl@0: 	return Session().SendReceive(ESqlSrvDbSize2, TIpcArgs(&ptr, aDbName.Length(), &aDbName));
sl@0: 	}