Symaptic: os/persistentdata/persistentstorage/sql/SRC/Common/SqlUtil.h@bde4ae8d615e

     1 // Copyright (c) 2005-2009 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 // NTT DOCOMO, INC - Fix for Bug 1915 "SQL server panics when using long column type strings"

    13 //

    14 // Description:

    15 //

    17 #ifndef __SQLUTIL_H__

    18 #define __SQLUTIL_H__

    20 #include <e32std.h>			//TInt

    22 /**

    23 Defines the maximum length of text or binary data that can be transferred

    24 from the SQL server to the SQL client in a single IPC call.

    26 This constant affects the behaviour of a number of functions, specifically:

    27 - RSqlStatement::ColumnBinaryL()

    28 - RSqlStatement::ColumnTextL()

    29 .

    30 It also affects the behaviour of member functions of the classes:

    31 - RSqlParamWriteStream

    32 - RSqlColumnReadStream

    34 @see RSqlStatement::ColumnBinaryL()

    35 @see RSqlStatement::ColumnTextL()

    36 @see RSqlParamWriteStream

    37 @see RSqlColumnReadStream

    39 @internalComponent

    40 */

    41 #ifdef _DEBUG

    42 const TInt KSqlMaxDesLen = 8;

    43 #else

    44 const TInt KSqlMaxDesLen = 256;

    45 #endif

    47 /**

    48 Used internally for making sure config manipulation buffers

    49 are not exceeded

    50 @internalComponent

    51 */

    52 const TInt KSqlSrvMaxConfigStrLen = 256;

    54 /**

    55 If some server function retuns a non-negative error, which value is bigger than KSqlClientBufOverflowCode,

    56 then it means the server wanted to send a data buffer to the client but the client's

    57 buffer is not big enough. The client must increase the buffer size and try to retrieve the data only.

    58 @internalComponent

    59 */

    60 const TInt KSqlClientBufOverflowCode = 0x1000;

    62 /**

    63 @internalComponent

    64 */

    65 enum TSqlBufFlatType

    66 	{

    67 	ESqlColumnNamesBuf,

    68 	ESqlParamNamesBuf,

    69 	ESqlColumnValuesBuf,

    70 	ESqlDeclColumnTypesBuf

    71 	};

    73 /**

    74 This structure is used for IPC data transfers

    75 @internalComponent

    76 */

    77 NONSHARABLE_STRUCT(TSqlIpcData)

    78 	{

    79 	inline TSqlIpcData() :

    80 		iPrm1(0),

    81 		iPrm2(0)

    82 		{

    83 		}

    84 	TUint32 iPrm1;

    85 	TUint32 iPrm2;

    86 	};

    88 /**

    89 IPC function codes used for communication between SqlDb.dll and SqlSrv.exe.

    91 The max function code allowed is 0xFF - see KSqlSrvFunctionMask declaration in the same file.

    93 The 32-bit RMessage2 function code format, which is used by the SQL client and server, is:

    95 @code

    96 Bits: 31................................0

    97 Bytes:       0        1        2        3

    98       XXXXXXTT HHHHHHHH HHHHHHHH FFFFFFFF

   100 Where:

   101 - "X" - unused bits;

   102 - "T" - handle type: 0 - statement handle, 1 - stream handle, 2 - no handle;

   103 - "H" - statement or stream handle, 16 bits;

   104 - "F" - function code, 8 bits (see KSqlSrvFunctionMask);

   105 @endcode

   107 @see RMessage2

   108 @see KSqlSrvFunctionMask

   109 @see KSqlSrvHandleMask

   110 @see KSqlSrvHandleTypeMask

   111 @see KSqlSrvHandleShiftBits

   112 @see CSqlSrvSession

   113 @see CSqlSrvSession::ServiceL()

   115 @internalComponent

   116 */

   117 enum TSqlSrvFunction

   118 	{

   119 	//Test functions

   120 	ESqlSrvTestBase				= 					0x00,

   121 	ESqlSrvResourceMark			= ESqlSrvTestBase + 0x01,

   122 	ESqlSrvResourceCheck		= ESqlSrvTestBase + 0x02,

   123 	ESqlSrvResourceCount		= ESqlSrvTestBase + 0x03,

   124 	ESqlSrvSetDbHeapFailure		= ESqlSrvTestBase + 0x04,

   125 	ESqlSrvSetHeapFailure		= ESqlSrvTestBase + 0x05,

   126 	//Profiling functions

   127 	ESqlSrvProfilerStart		= ESqlSrvTestBase + 0x06,

   128 	ESqlSrvProfilerStop			= ESqlSrvTestBase + 0x07,

   129 	ESqlSrvProfilerReset		= ESqlSrvTestBase + 0x08,

   130 	ESqlSrvProfilerSetRange		= ESqlSrvTestBase + 0x09,//not used

   131 	ESqlSrvProfilerQuery	    = ESqlSrvTestBase + 0x0A,

   132 	//Database functions

   133 	ESqlSrvDbBase				= 					0x10,

   134 	ESqlSrvDbCreate				= ESqlSrvDbBase + 	0x01,

   135 	ESqlSrvDbCreateSecure		= ESqlSrvDbBase + 	0x02,

   136 	ESqlSrvDbOpen				= ESqlSrvDbBase + 	0x03,

   137 	ESqlSrvDbOpenFromHandle		= ESqlSrvDbBase + 	0x04,

   138 	ESqlSrvDbClose				= ESqlSrvDbBase + 	0x05,

   139 	ESqlSrvDbCopy				= ESqlSrvDbBase + 	0x06,

   140 	ESqlSrvDbDelete				= ESqlSrvDbBase + 	0x07,

   141 	//All operations with opcode > ESqlSrvDbDelete require valid database object (on the server side)

   142 	ESqlSrvLastErrorMsg			= ESqlSrvDbBase + 	0x08,

   143 	ESqlSrvDbExec8				= ESqlSrvDbBase + 	0x09,

   144 	ESqlSrvDbExec16				= ESqlSrvDbBase + 	0x0A,

   145 	ESqlSrvDbSetIsolationLevel	= ESqlSrvDbBase + 	0x0C,

   146 	ESqlSrvDbGetSecurityPolicy  = ESqlSrvDbBase + 	0x0D,

   147 	ESqlSrvDbAttach				= ESqlSrvDbBase + 	0x0E,

   148 	ESqlSrvDbAttachFromHandle	= ESqlSrvDbBase + 	0x0F,

   149 	ESqlSrvDbDetach				= ESqlSrvDbBase + 	0x10,

   150 	ESqlSrvDbScalarFullSelect8	= ESqlSrvDbBase + 	0x11,

   151 	ESqlSrvDbScalarFullSelect16	= ESqlSrvDbBase + 	0x12,

   152 	ESqlSrvDbInTransaction		= ESqlSrvDbBase + 	0x13,

   153 	ESqlSrvDbSize				= ESqlSrvDbBase + 	0x14,

   154 	ESqlSrvDbSize2				= ESqlSrvDbBase + 	0x15,

   155 	ESqlSrvDbBlobSource			= ESqlSrvDbBase + 	0x16,

   156 	ESqlSrvDbLastInsertedRowId	= ESqlSrvDbBase + 	0x17,

   157 	ESqlSrvDbCompact			= ESqlSrvDbBase + 	0x18,

   158 	//Database - reserved drive space management

   159 	ESqlSrvDbReserveDriveSpace	= ESqlSrvDbBase + 	0x19,

   160 	ESqlSrvDbFreeReservedSpace	= ESqlSrvDbBase + 	0x1A,

   161 	ESqlSrvDbGetReserveAccess	= ESqlSrvDbBase + 	0x1B,

   162 	ESqlSrvDbReleaseReserveAccess=ESqlSrvDbBase + 	0x1C,

   163 	//Statement functions

   164 	ESqlSrvStmtBase				= 					0x50,

   165 	ESqlSrvStmtPrepare8			= ESqlSrvStmtBase + 0x01,

   166 	ESqlSrvStmtPrepare16		= ESqlSrvStmtBase + 0x02,

   167 	ESqlSrvStmtClose			= ESqlSrvStmtBase + 0x03,

   168 	ESqlSrvStmtReset			= ESqlSrvStmtBase + 0x04,

   169 	ESqlSrvStmtExec				= ESqlSrvStmtBase + 0x05,

   170 	ESqlSrvStmtAsyncExec		= ESqlSrvStmtBase + 0x06,

   171 	ESqlSrvStmtBindExec			= ESqlSrvStmtBase + 0x07,

   172 	ESqlSrvStmtAsyncBindExec	= ESqlSrvStmtBase + 0x09,

   173 	ESqlSrvStmtNext				= ESqlSrvStmtBase + 0x0A,

   174 	ESqlSrvStmtBindNext			= ESqlSrvStmtBase + 0x0B,

   175 	ESqlSrvStmtColumnNames		= ESqlSrvStmtBase + 0x0C,

   176 	ESqlSrvStmtParamNames		= ESqlSrvStmtBase + 0x0D,

   177 	ESqlSrvStmtColumnSource		= ESqlSrvStmtBase + 0x0E,

   178 	ESqlSrvStmtBinParamSink		= ESqlSrvStmtBase + 0x0F,

   179 	ESqlSrvStmtTxtParamSink16	= ESqlSrvStmtBase + 0x11,

   180 	ESqlSrvStmtBufFlat			= ESqlSrvStmtBase + 0x12,

   181 	ESqlSrvStmtColumnValue		= ESqlSrvStmtBase + 0x13,

   182 	ESqlSrvStmtDeclColumnTypes	= ESqlSrvStmtBase + 0x14,

   183 	//Stream functions

   184 	ESqlSrvStreamBase			= 					  0x70,

   185 	ESqlSrvStreamRead			= ESqlSrvStreamBase + 0x01,

   186 	ESqlSrvStreamWrite			= ESqlSrvStreamBase + 0x02,

   187 	ESqlSrvStreamSize			= ESqlSrvStreamBase + 0x03,

   188 	ESqlSrvStreamSynch			= ESqlSrvStreamBase + 0x04,

   189 	ESqlSrvStreamClose			= ESqlSrvStreamBase + 0x05

   190 	};

   192 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   193 //////////                  RMessage2, function code related macros                                 ////////

   194 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   196 /**

   197 SQL server function mask.

   198 The SQL server function code must be less than 0x100.

   199 (it occupies the lower 8 bits of the 32-bit message code)

   201 @see TSqlSrvFunction

   203 @internalComponent

   204 */

   205 const TUint KSqlSrvFunctionMask		= 0x000000FF;

   207 /**

   208 SQL server (statement or stream) handle mask.

   209 The handle occupies 16 bits, right after the function code.

   211 @see KSqlSrvHandleTypeMask

   212 @see KSqlSrvHandleShiftBits

   214 @internalComponent

   215 */

   216 const TUint KSqlSrvHandleMask 		= 0x00FFFF00;

   218 /**

   219 SQL server (stream or statement) handle - shift bits.

   221 @see KSqlSrvFunctionMask

   222 @see KSqlSrvHandleMask

   224 @internalComponent

   225 */

   226 const TInt  KSqlSrvHandleShiftBits 	= 8;

   228 /**

   229 SQL server handle type bit.

   231 @see KSqlSrvHandleMask

   232 @see KSqlSrvHandleShiftBits

   234 @internalComponent

   235 */

   236 const TInt  KSqlSrvHandleTypeMask 	= 0x03000000;

   238 /**

   239 SQL server - handle type - statement or stream.

   241 @internalComponent

   242 */

   243 enum TSqlSrvHandleType

   244 	{

   245 	ESqlSrvNoHandle 		= 0x00000000,

   246 	ESqlSrvStreamHandle 	= 0x01000000,

   247 	ESqlSrvStatementHandle	= 0x02000000

   248 	};

   250 inline TInt MakeMsgCode(TSqlSrvFunction aFunction, TSqlSrvHandleType aHandleType, TInt aHandle);

   252 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   253 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   255 TInt Sql2OsErrCode(TInt aSqlError, TInt aOsError);

   257 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   258 //////////                  Case insensitive string comparisons                                     ////////

   259 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   261 inline TInt CompareNoCase8(const TDesC8& aLeft, const TDesC8& aRight);

   262 inline TInt CompareNoCase16(const TDesC16& aLeft, const TDesC16& aRight);

   263 #ifdef _UNICODE

   264 #define CompareNoCase CompareNoCase16

   265 #else

   266 #define CompareNoCase CompareNoCase8

   267 #endif//_UNICODE

   269 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   270 //////////                      Buffer alignment functions                                     /////////////

   271 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   273 inline TInt AlignedLen8(TInt aLen);

   274 #ifdef _DEBUG

   275 inline TBool IsAligned8(TInt aLen);

   276 #endif

   278 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   279 //////////                      Compaction modes                                     ///////////////////////

   280 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   282 /**

   283 Compaction modes.

   284 @internalComponent

   285 */

   286 enum TSqlCompactionMode

   287 	{

   288 	ESqlCompactionNotSet,

   289 	ESqlCompactionManual,

   290 	ESqlCompactionBackground,

   291 	ESqlCompactionAuto

   292 	};

   294 /**

   295 SQLite vacuum modes.

   296 @internalComponent

   297 */

   298 enum TSqliteVacuumMode

   299 	{

   300 	ESqliteVacuumOff			= 0,

   301 	ESqliteVacuumAuto			= 1,

   302 	ESqliteVacuumIncremental	= 2

   303 	};

   306 /**

   307 Default compaction mode.

   308 @internalComponent

   309 */

   310 const TSqlCompactionMode KSqlDefaultCompactionMode = ESqlCompactionBackground;

   312 /**

   313 Exec free page threshold in Kb, after which the background compaction will be activated.

   314 @internalComponent

   315 */

   316 const TInt KSqlCompactFreePageThresholdKb = 50;

   318 /**

   319 One compaction step length in milliseconds.

   320 @internalComponent

   321 */

   322 const TInt KSqlCompactStepLengthMs = 50;

   324 /**

   325 Interval in milliseconds between the compaction steps.

   326 @internalComponent

   327 */

   328 const TInt KSqlCompactStepIntervalMs = 50;

   330 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   332 /**

   333 The db config file version that is initially stored in the system settings table.

   334 @internalComponent

   335 */

   336 const TInt KSqlNullDbConfigFileVersion = 0;

   338 ////////////////////////////////////////////////////////////////////////////////////////////////////////////

   340 #include "SqlUtil.inl"

   342 #endif //__SQLUTIL_H__

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