blob: b0aa877d5c275756ee18d8414d37762ab45b60e2 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** Main file for the SQLite library. The routines in this file
13** implement the programmer interface to the library. Routines in
14** other files are for internal use by SQLite and should not be
15** accessed by users of the library.
16**
drhe30f4422007-08-21 16:15:55 +000017** $Id: main.c,v 1.392 2007/08/21 16:15:56 drh Exp $
drh75897232000-05-29 14:26:00 +000018*/
19#include "sqliteInt.h"
drhce9079c2002-05-15 14:17:44 +000020#include <ctype.h>
drh75897232000-05-29 14:26:00 +000021
22/*
drhb217a572000-08-22 13:40:18 +000023** The version of the library
24*/
danielk197724b03fd2004-05-10 10:34:34 +000025const char sqlite3_version[] = SQLITE_VERSION;
drh4aec8b62004-08-28 16:19:00 +000026const char *sqlite3_libversion(void){ return sqlite3_version; }
danielk197799ba19e2005-02-05 07:33:34 +000027int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
drhb217a572000-08-22 13:40:18 +000028
29/*
drhb0603412007-02-28 04:47:26 +000030** If the following function pointer is not NULL and if
31** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
32** I/O active are written using this function. These messages
33** are intended for debugging activity only.
34*/
35void (*sqlite3_io_trace)(const char*, ...) = 0;
36
37/*
drha16313e2007-03-30 11:29:32 +000038** If the following global variable points to a string which is the
39** name of a directory, then that directory will be used to store
40** temporary files.
41**
42** See also the "PRAGMA temp_store_directory" SQL command.
43*/
44char *sqlite3_temp_directory = 0;
45
46
47/*
drhd3d39e92004-05-20 22:16:29 +000048** This is the default collating function named "BINARY" which is always
49** available.
50*/
danielk19772c336542005-01-13 02:14:23 +000051static int binCollFunc(
drhd3d39e92004-05-20 22:16:29 +000052 void *NotUsed,
53 int nKey1, const void *pKey1,
54 int nKey2, const void *pKey2
55){
56 int rc, n;
57 n = nKey1<nKey2 ? nKey1 : nKey2;
58 rc = memcmp(pKey1, pKey2, n);
59 if( rc==0 ){
60 rc = nKey1 - nKey2;
61 }
62 return rc;
63}
64
65/*
danielk1977dc1bdc42004-06-11 10:51:27 +000066** Another built-in collating sequence: NOCASE.
67**
68** This collating sequence is intended to be used for "case independant
69** comparison". SQLite's knowledge of upper and lower case equivalents
70** extends only to the 26 characters used in the English language.
71**
72** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +000073*/
74static int nocaseCollatingFunc(
75 void *NotUsed,
76 int nKey1, const void *pKey1,
77 int nKey2, const void *pKey2
78){
79 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +000080 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk19770202b292004-06-09 09:55:16 +000081 if( 0==r ){
82 r = nKey1-nKey2;
83 }
84 return r;
85}
86
87/*
drhaf9ff332002-01-16 21:00:27 +000088** Return the ROWID of the most recent insert
89*/
drh9bb575f2004-09-06 17:24:11 +000090sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drhaf9ff332002-01-16 21:00:27 +000091 return db->lastRowid;
92}
93
94/*
danielk197724b03fd2004-05-10 10:34:34 +000095** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +000096*/
drh9bb575f2004-09-06 17:24:11 +000097int sqlite3_changes(sqlite3 *db){
drhc8d30ac2002-04-12 10:08:59 +000098 return db->nChange;
99}
100
rdcf146a772004-02-25 22:51:06 +0000101/*
danielk1977b28af712004-06-21 06:50:26 +0000102** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000103*/
danielk1977b28af712004-06-21 06:50:26 +0000104int sqlite3_total_changes(sqlite3 *db){
105 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000106}
107
drhc8d30ac2002-04-12 10:08:59 +0000108/*
drh50e5dad2001-09-15 00:57:28 +0000109** Close an existing SQLite database
110*/
drh9bb575f2004-09-06 17:24:11 +0000111int sqlite3_close(sqlite3 *db){
drh8e0a2f92002-02-23 23:45:45 +0000112 HashElem *i;
drh001bbcb2003-03-19 03:14:00 +0000113 int j;
danielk19775c4c7782004-06-16 10:39:23 +0000114
115 if( !db ){
danielk197796d81f92004-06-19 03:33:57 +0000116 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000117 }
drhc60d0442004-09-30 13:43:13 +0000118 if( sqlite3SafetyCheck(db) ){
danielk1977e35ee192004-06-26 09:50:11 +0000119 return SQLITE_MISUSE;
120 }
drh605264d2007-08-21 15:13:19 +0000121 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000122
danielk19771f723bd2005-05-26 12:37:29 +0000123#ifdef SQLITE_SSE
drh37527852006-03-16 16:19:56 +0000124 {
125 extern void sqlite3SseCleanup(sqlite3*);
126 sqlite3SseCleanup(db);
127 }
danielk19771f723bd2005-05-26 12:37:29 +0000128#endif
129
drhffc13f62006-07-30 20:50:44 +0000130 sqlite3ResetInternalSchema(db, 0);
danielk1977a04a34f2007-04-16 15:06:25 +0000131
danielk197701256832007-04-18 14:24:32 +0000132 /* If a transaction is open, the ResetInternalSchema() call above
133 ** will not have called the xDisconnect() method on any virtual
134 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
135 ** call will do so. We need to do this before the check for active
136 ** SQL statements below, as the v-table implementation may be storing
137 ** some prepared statements internally.
138 */
139 sqlite3VtabRollback(db);
140
danielk1977a04a34f2007-04-16 15:06:25 +0000141 /* If there are any outstanding VMs, return SQLITE_BUSY. */
danielk197796d81f92004-06-19 03:33:57 +0000142 if( db->pVdbe ){
143 sqlite3Error(db, SQLITE_BUSY,
144 "Unable to close due to unfinalised statements");
145 return SQLITE_BUSY;
146 }
147 assert( !sqlite3SafetyCheck(db) );
danielk1977e0048402004-06-15 16:51:01 +0000148
149 /* FIX ME: db->magic may be set to SQLITE_MAGIC_CLOSED if the database
150 ** cannot be opened for some reason. So this routine needs to run in
151 ** that case. But maybe there should be an extra magic value for the
152 ** "failed to open" state.
danielk1977b5584c02007-03-30 07:10:50 +0000153 **
154 ** TODO: Coverage tests do not test the case where this condition is
155 ** true. It's hard to see how to cause it without messing with threads.
danielk1977e0048402004-06-15 16:51:01 +0000156 */
danielk197796d81f92004-06-19 03:33:57 +0000157 if( db->magic!=SQLITE_MAGIC_CLOSED && sqlite3SafetyOn(db) ){
drh94e92032003-02-16 22:21:32 +0000158 /* printf("DID NOT CLOSE\n"); fflush(stdout); */
danielk197796d81f92004-06-19 03:33:57 +0000159 return SQLITE_ERROR;
drh94e92032003-02-16 22:21:32 +0000160 }
danielk1977e0048402004-06-15 16:51:01 +0000161
drh001bbcb2003-03-19 03:14:00 +0000162 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000163 struct Db *pDb = &db->aDb[j];
164 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000165 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000166 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000167 if( j!=1 ){
168 pDb->pSchema = 0;
169 }
drh113088e2003-03-20 01:16:58 +0000170 }
drhf57b3392001-10-08 13:22:32 +0000171 }
danielk19774adee202004-05-08 08:23:19 +0000172 sqlite3ResetInternalSchema(db, 0);
drh1c2d8412003-03-31 00:30:47 +0000173 assert( db->nDb<=2 );
174 assert( db->aDb==db->aDbStatic );
drh0bce8352002-02-28 00:41:10 +0000175 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
176 FuncDef *pFunc, *pNext;
177 for(pFunc = (FuncDef*)sqliteHashData(i); pFunc; pFunc=pNext){
drh8e0a2f92002-02-23 23:45:45 +0000178 pNext = pFunc->pNext;
drh17435752007-08-16 04:30:38 +0000179 sqlite3_free(pFunc);
drh8e0a2f92002-02-23 23:45:45 +0000180 }
181 }
danielk1977466be562004-06-10 02:16:01 +0000182
danielk1977d8123362004-06-12 09:25:12 +0000183 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000184 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000185 /* Invoke any destructors registered for collation sequence user data. */
186 for(j=0; j<3; j++){
187 if( pColl[j].xDel ){
188 pColl[j].xDel(pColl[j].pUser);
189 }
190 }
drh17435752007-08-16 04:30:38 +0000191 sqlite3_free(pColl);
danielk1977466be562004-06-10 02:16:01 +0000192 }
danielk1977d8123362004-06-12 09:25:12 +0000193 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +0000194#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +0000195 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
196 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +0000197 if( pMod->xDestroy ){
198 pMod->xDestroy(pMod->pAux);
199 }
drh17435752007-08-16 04:30:38 +0000200 sqlite3_free(pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +0000201 }
drhb9bb7c12006-06-11 23:41:55 +0000202 sqlite3HashClear(&db->aModule);
203#endif
danielk1977466be562004-06-10 02:16:01 +0000204
danielk19774adee202004-05-08 08:23:19 +0000205 sqlite3HashClear(&db->aFunc);
danielk19776622cce2004-05-20 11:00:52 +0000206 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +0000207 if( db->pErr ){
208 sqlite3ValueFree(db->pErr);
209 }
drhf1952c52006-06-08 15:48:00 +0000210 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +0000211
212 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +0000213
214 /* The temp-database schema is allocated differently from the other schema
215 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
216 ** So it needs to be freed here. Todo: Why not roll the temp schema into
217 ** the same sqliteMalloc() as the one that allocates the database
218 ** structure?
219 */
drh17435752007-08-16 04:30:38 +0000220 sqlite3_free(db->aDb[1].pSchema);
drhd677b3d2007-08-20 22:48:41 +0000221 sqlite3_vfs_release(db->pVfs);
drh605264d2007-08-21 15:13:19 +0000222 sqlite3_mutex_leave(db->mutex);
223 sqlite3_mutex_free(db->mutex);
drh17435752007-08-16 04:30:38 +0000224 sqlite3_free(db);
danielk197796d81f92004-06-19 03:33:57 +0000225 return SQLITE_OK;
drh75897232000-05-29 14:26:00 +0000226}
227
228/*
drh001bbcb2003-03-19 03:14:00 +0000229** Rollback all database files.
230*/
drh9bb575f2004-09-06 17:24:11 +0000231void sqlite3RollbackAll(sqlite3 *db){
drh001bbcb2003-03-19 03:14:00 +0000232 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +0000233 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +0000234 assert( sqlite3_mutex_held(db->mutex) );
drh001bbcb2003-03-19 03:14:00 +0000235 for(i=0; i<db->nDb; i++){
236 if( db->aDb[i].pBt ){
danielk1977f3f06bb2005-12-16 15:24:28 +0000237 if( sqlite3BtreeIsInTrans(db->aDb[i].pBt) ){
238 inTrans = 1;
239 }
danielk19774adee202004-05-08 08:23:19 +0000240 sqlite3BtreeRollback(db->aDb[i].pBt);
drh001bbcb2003-03-19 03:14:00 +0000241 db->aDb[i].inTrans = 0;
242 }
243 }
danielk1977a298e902006-06-22 09:53:48 +0000244 sqlite3VtabRollback(db);
danielk197771fd80b2005-12-16 06:54:01 +0000245 if( db->flags&SQLITE_InternChanges ){
danielk1977ea4d9e22007-08-13 15:28:33 +0000246 sqlite3ExpirePreparedStatements(db);
danielk197771fd80b2005-12-16 06:54:01 +0000247 sqlite3ResetInternalSchema(db, 0);
248 }
249
250 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +0000251 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +0000252 db->xRollbackCallback(db->pRollbackArg);
253 }
drh001bbcb2003-03-19 03:14:00 +0000254}
255
256/*
drhc22bd472002-05-10 13:14:07 +0000257** Return a static string that describes the kind of error specified in the
258** argument.
drh247be432002-05-10 05:44:55 +0000259*/
danielk1977f20b21c2004-05-31 23:56:42 +0000260const char *sqlite3ErrStr(int rc){
drhc22bd472002-05-10 13:14:07 +0000261 const char *z;
drh4ac285a2006-09-15 07:28:50 +0000262 switch( rc & 0xff ){
drhc60d0442004-09-30 13:43:13 +0000263 case SQLITE_ROW:
264 case SQLITE_DONE:
drhc22bd472002-05-10 13:14:07 +0000265 case SQLITE_OK: z = "not an error"; break;
266 case SQLITE_ERROR: z = "SQL logic error or missing database"; break;
drhc22bd472002-05-10 13:14:07 +0000267 case SQLITE_PERM: z = "access permission denied"; break;
268 case SQLITE_ABORT: z = "callback requested query abort"; break;
269 case SQLITE_BUSY: z = "database is locked"; break;
270 case SQLITE_LOCKED: z = "database table is locked"; break;
271 case SQLITE_NOMEM: z = "out of memory"; break;
272 case SQLITE_READONLY: z = "attempt to write a readonly database"; break;
273 case SQLITE_INTERRUPT: z = "interrupted"; break;
274 case SQLITE_IOERR: z = "disk I/O error"; break;
275 case SQLITE_CORRUPT: z = "database disk image is malformed"; break;
drh2db0bbc2005-08-11 02:10:18 +0000276 case SQLITE_FULL: z = "database or disk is full"; break;
drhc22bd472002-05-10 13:14:07 +0000277 case SQLITE_CANTOPEN: z = "unable to open database file"; break;
drhc22bd472002-05-10 13:14:07 +0000278 case SQLITE_EMPTY: z = "table contains no data"; break;
279 case SQLITE_SCHEMA: z = "database schema has changed"; break;
drh023ae032007-05-08 12:12:16 +0000280 case SQLITE_TOOBIG: z = "String or BLOB exceeded size limit"; break;
drhc22bd472002-05-10 13:14:07 +0000281 case SQLITE_CONSTRAINT: z = "constraint failed"; break;
282 case SQLITE_MISMATCH: z = "datatype mismatch"; break;
283 case SQLITE_MISUSE: z = "library routine called out of sequence";break;
drh8766c342002-11-09 00:33:15 +0000284 case SQLITE_NOLFS: z = "kernel lacks large file support"; break;
drhed6c8672003-01-12 18:02:16 +0000285 case SQLITE_AUTH: z = "authorization denied"; break;
jplyon892f6712003-06-12 08:59:00 +0000286 case SQLITE_FORMAT: z = "auxiliary database format error"; break;
drhb08153d2004-11-20 20:18:55 +0000287 case SQLITE_RANGE: z = "bind or column index out of range"; break;
drhc602f9a2004-02-12 19:01:04 +0000288 case SQLITE_NOTADB: z = "file is encrypted or is not a database";break;
drhc22bd472002-05-10 13:14:07 +0000289 default: z = "unknown error"; break;
drh247be432002-05-10 05:44:55 +0000290 }
drhc22bd472002-05-10 13:14:07 +0000291 return z;
drh247be432002-05-10 05:44:55 +0000292}
293
294/*
drh2dfbbca2000-07-28 14:32:48 +0000295** This routine implements a busy callback that sleeps and tries
296** again until a timeout value is reached. The timeout value is
297** an integer number of milliseconds passed in as the first
298** argument.
299*/
drhdaffd0e2001-04-11 14:28:42 +0000300static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +0000301 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +0000302 int count /* Number of times table has been busy */
303){
drh91c839b2006-03-03 20:54:41 +0000304#if OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +0000305 static const u8 delays[] =
306 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
307 static const u8 totals[] =
308 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhd1bec472004-01-15 13:29:31 +0000309# define NDELAY (sizeof(delays)/sizeof(delays[0]))
danielk1977b4b47412007-08-17 15:53:36 +0000310 sqlite3 *db = (sqlite3 *)ptr;
311 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +0000312 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +0000313
drhee570fa2005-04-28 12:06:05 +0000314 assert( count>=0 );
315 if( count < NDELAY ){
316 delay = delays[count];
317 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +0000318 }else{
319 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +0000320 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +0000321 }
drhd1bec472004-01-15 13:29:31 +0000322 if( prior + delay > timeout ){
323 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +0000324 if( delay<=0 ) return 0;
325 }
danielk19772a6bdf62007-08-20 16:07:00 +0000326 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +0000327 return 1;
328#else
drh482ea182007-08-20 11:12:40 +0000329 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +0000330 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +0000331 if( (count+1)*1000 > timeout ){
332 return 0;
333 }
drh482ea182007-08-20 11:12:40 +0000334 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +0000335 return 1;
336#endif
337}
338
339/*
drha4afb652005-07-09 02:16:02 +0000340** Invoke the given busy handler.
341**
342** This routine is called when an operation failed with a lock.
343** If this routine returns non-zero, the lock is retried. If it
344** returns 0, the operation aborts with an SQLITE_BUSY error.
345*/
346int sqlite3InvokeBusyHandler(BusyHandler *p){
347 int rc;
348 if( p==0 || p->xFunc==0 || p->nBusy<0 ) return 0;
349 rc = p->xFunc(p->pArg, p->nBusy);
350 if( rc==0 ){
351 p->nBusy = -1;
352 }else{
353 p->nBusy++;
354 }
355 return rc;
356}
357
358/*
drh2dfbbca2000-07-28 14:32:48 +0000359** This routine sets the busy callback for an Sqlite database to the
360** given callback function with the given argument.
361*/
danielk1977f9d64d22004-06-19 08:18:07 +0000362int sqlite3_busy_handler(
363 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +0000364 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +0000365 void *pArg
366){
drhc60d0442004-09-30 13:43:13 +0000367 if( sqlite3SafetyCheck(db) ){
368 return SQLITE_MISUSE;
369 }
drhe30f4422007-08-21 16:15:55 +0000370 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +0000371 db->busyHandler.xFunc = xBusy;
372 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +0000373 db->busyHandler.nBusy = 0;
drhe30f4422007-08-21 16:15:55 +0000374 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +0000375 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +0000376}
377
danielk1977348bb5d2003-10-18 09:37:26 +0000378#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
379/*
380** This routine sets the progress callback for an Sqlite database to the
381** given callback function with the given argument. The progress callback will
382** be invoked every nOps opcodes.
383*/
danielk197724b03fd2004-05-10 10:34:34 +0000384void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +0000385 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +0000386 int nOps,
387 int (*xProgress)(void*),
388 void *pArg
389){
drhc60d0442004-09-30 13:43:13 +0000390 if( !sqlite3SafetyCheck(db) ){
drhe30f4422007-08-21 16:15:55 +0000391 sqlite3_mutex_enter(db->mutex);
drhc60d0442004-09-30 13:43:13 +0000392 if( nOps>0 ){
393 db->xProgress = xProgress;
394 db->nProgressOps = nOps;
395 db->pProgressArg = pArg;
396 }else{
397 db->xProgress = 0;
398 db->nProgressOps = 0;
399 db->pProgressArg = 0;
400 }
drhe30f4422007-08-21 16:15:55 +0000401 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +0000402 }
403}
404#endif
405
406
drh2dfbbca2000-07-28 14:32:48 +0000407/*
408** This routine installs a default busy handler that waits for the
409** specified number of milliseconds before returning 0.
410*/
danielk1977f9d64d22004-06-19 08:18:07 +0000411int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh30867652006-07-06 10:59:57 +0000412 if( sqlite3SafetyCheck(db) ){
413 return SQLITE_MISUSE;
414 }
drh2dfbbca2000-07-28 14:32:48 +0000415 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +0000416 db->busyTimeout = ms;
417 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drh2dfbbca2000-07-28 14:32:48 +0000418 }else{
danielk197724b03fd2004-05-10 10:34:34 +0000419 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +0000420 }
danielk1977f9d64d22004-06-19 08:18:07 +0000421 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +0000422}
drh4c504392000-10-16 22:06:40 +0000423
424/*
425** Cause any pending operation to stop at its earliest opportunity.
426*/
drh9bb575f2004-09-06 17:24:11 +0000427void sqlite3_interrupt(sqlite3 *db){
drh881feaa2006-07-26 01:39:30 +0000428 if( db && (db->magic==SQLITE_MAGIC_OPEN || db->magic==SQLITE_MAGIC_BUSY) ){
429 db->u1.isInterrupted = 1;
drhc60d0442004-09-30 13:43:13 +0000430 }
drh4c504392000-10-16 22:06:40 +0000431}
drhfa86c412002-02-02 15:01:15 +0000432
drhfa86c412002-02-02 15:01:15 +0000433
434/*
danielk1977771151b2006-01-17 13:21:40 +0000435** This function is exactly the same as sqlite3_create_function(), except
436** that it is designed to be called by internal code. The difference is
437** that if a malloc() fails in sqlite3_create_function(), an error code
438** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +0000439*/
danielk1977771151b2006-01-17 13:21:40 +0000440int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +0000441 sqlite3 *db,
442 const char *zFunctionName,
443 int nArg,
danielk1977d8123362004-06-12 09:25:12 +0000444 int enc,
danielk197765904932004-05-26 06:18:37 +0000445 void *pUserData,
446 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
447 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
448 void (*xFinal)(sqlite3_context*)
drh8e0a2f92002-02-23 23:45:45 +0000449){
drh0bce8352002-02-28 00:41:10 +0000450 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +0000451 int nName;
danielk197765904932004-05-26 06:18:37 +0000452
drhe30f4422007-08-21 16:15:55 +0000453 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +0000454 if( sqlite3SafetyCheck(db) ){
455 return SQLITE_MISUSE;
456 }
457 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +0000458 (xFunc && (xFinal || xStep)) ||
459 (!xFunc && (xFinal && !xStep)) ||
460 (!xFunc && (!xFinal && xStep)) ||
461 (nArg<-1 || nArg>127) ||
462 (255<(nName = strlen(zFunctionName))) ){
drhbadf7a72006-06-14 15:35:36 +0000463 sqlite3Error(db, SQLITE_ERROR, "bad parameters");
danielk197765904932004-05-26 06:18:37 +0000464 return SQLITE_ERROR;
465 }
danielk1977d8123362004-06-12 09:25:12 +0000466
danielk197793758c82005-01-21 08:13:14 +0000467#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +0000468 /* If SQLITE_UTF16 is specified as the encoding type, transform this
469 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
470 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
471 **
472 ** If SQLITE_ANY is specified, add three versions of the function
473 ** to the hash table.
474 */
475 if( enc==SQLITE_UTF16 ){
476 enc = SQLITE_UTF16NATIVE;
477 }else if( enc==SQLITE_ANY ){
478 int rc;
danielk1977771151b2006-01-17 13:21:40 +0000479 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
danielk1977f9d64d22004-06-19 08:18:07 +0000480 pUserData, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +0000481 if( rc==SQLITE_OK ){
482 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
483 pUserData, xFunc, xStep, xFinal);
484 }
485 if( rc!=SQLITE_OK ){
486 return rc;
487 }
danielk1977d8123362004-06-12 09:25:12 +0000488 enc = SQLITE_UTF16BE;
489 }
danielk197793758c82005-01-21 08:13:14 +0000490#else
491 enc = SQLITE_UTF8;
492#endif
danielk19779636c4e2005-01-25 04:27:54 +0000493
494 /* Check if an existing function is being overridden or deleted. If so,
495 ** and there are active VMs, then return SQLITE_BUSY. If a function
496 ** is being overridden/deleted but there are no active VMs, allow the
497 ** operation to continue but invalidate all precompiled statements.
498 */
499 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, enc, 0);
500 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
501 if( db->activeVdbeCnt ){
502 sqlite3Error(db, SQLITE_BUSY,
503 "Unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +0000504 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +0000505 return SQLITE_BUSY;
506 }else{
507 sqlite3ExpirePreparedStatements(db);
508 }
509 }
danielk197765904932004-05-26 06:18:37 +0000510
danielk1977d8123362004-06-12 09:25:12 +0000511 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, enc, 1);
danielk1977771151b2006-01-17 13:21:40 +0000512 if( p ){
513 p->flags = 0;
514 p->xFunc = xFunc;
515 p->xStep = xStep;
516 p->xFinalize = xFinal;
517 p->pUserData = pUserData;
danielk197765fd59f2006-06-24 11:51:33 +0000518 p->nArg = nArg;
danielk1977771151b2006-01-17 13:21:40 +0000519 }
danielk197765904932004-05-26 06:18:37 +0000520 return SQLITE_OK;
521}
danielk1977771151b2006-01-17 13:21:40 +0000522
523/*
524** Create new user functions.
525*/
526int sqlite3_create_function(
527 sqlite3 *db,
528 const char *zFunctionName,
529 int nArg,
530 int enc,
531 void *p,
532 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
533 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
534 void (*xFinal)(sqlite3_context*)
535){
536 int rc;
drhe30f4422007-08-21 16:15:55 +0000537 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +0000538 assert( !db->mallocFailed );
danielk1977771151b2006-01-17 13:21:40 +0000539 rc = sqlite3CreateFunc(db, zFunctionName, nArg, enc, p, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +0000540 rc = sqlite3ApiExit(db, rc);
541 sqlite3_mutex_leave(db->mutex);
542 return rc;
danielk1977771151b2006-01-17 13:21:40 +0000543}
544
danielk197793758c82005-01-21 08:13:14 +0000545#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +0000546int sqlite3_create_function16(
547 sqlite3 *db,
548 const void *zFunctionName,
549 int nArg,
550 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +0000551 void *p,
danielk197765904932004-05-26 06:18:37 +0000552 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
553 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
554 void (*xFinal)(sqlite3_context*)
555){
556 int rc;
drhaf9a7c22005-12-15 03:04:10 +0000557 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +0000558 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +0000559 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +0000560 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1);
danielk1977771151b2006-01-17 13:21:40 +0000561 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal);
drh17435752007-08-16 04:30:38 +0000562 sqlite3_free(zFunc8);
drhe30f4422007-08-21 16:15:55 +0000563 rc = sqlite3ApiExit(db, rc);
564 sqlite3_mutex_leave(db->mutex);
565 return rc;
drh8e0a2f92002-02-23 23:45:45 +0000566}
danielk197793758c82005-01-21 08:13:14 +0000567#endif
drhc9b84a12002-06-20 11:36:48 +0000568
drhb7481e72006-09-16 21:45:14 +0000569
570/*
571** Declare that a function has been overloaded by a virtual table.
572**
573** If the function already exists as a regular global function, then
574** this routine is a no-op. If the function does not exist, then create
575** a new one that always throws a run-time error.
576**
577** When virtual tables intend to provide an overloaded function, they
578** should call this routine to make sure the global function exists.
579** A global function must exist in order for name resolution to work
580** properly.
581*/
582int sqlite3_overload_function(
583 sqlite3 *db,
584 const char *zName,
585 int nArg
586){
587 int nName = strlen(zName);
drhe30f4422007-08-21 16:15:55 +0000588 int rc;
589 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +0000590 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
591 sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
592 0, sqlite3InvalidFunction, 0, 0);
593 }
drhe30f4422007-08-21 16:15:55 +0000594 rc = sqlite3ApiExit(db, SQLITE_OK);
595 sqlite3_mutex_leave(db->mutex);
596 return rc;
drhb7481e72006-09-16 21:45:14 +0000597}
598
drh19e2d372005-08-29 23:00:03 +0000599#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +0000600/*
drh18de4822003-01-16 16:28:53 +0000601** Register a trace function. The pArg from the previously registered trace
602** is returned.
603**
604** A NULL trace function means that no tracing is executes. A non-NULL
605** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +0000606** SQL statement.
drh18de4822003-01-16 16:28:53 +0000607*/
drh9bb575f2004-09-06 17:24:11 +0000608void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +0000609 void *pOld;
610 sqlite3_mutex_enter(db->mutex);
611 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +0000612 db->xTrace = xTrace;
613 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000614 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +0000615 return pOld;
drh0d1a6432003-04-03 15:46:04 +0000616}
drh19e2d372005-08-29 23:00:03 +0000617/*
618** Register a profile function. The pArg from the previously registered
619** profile function is returned.
620**
621** A NULL profile function means that no profiling is executes. A non-NULL
622** profile is a pointer to a function that is invoked at the conclusion of
623** each SQL statement that is run.
624*/
625void *sqlite3_profile(
626 sqlite3 *db,
627 void (*xProfile)(void*,const char*,sqlite_uint64),
628 void *pArg
629){
drhe30f4422007-08-21 16:15:55 +0000630 void *pOld;
631 sqlite3_mutex_enter(db->mutex);
632 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +0000633 db->xProfile = xProfile;
634 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000635 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +0000636 return pOld;
637}
638#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +0000639
drhaa940ea2004-01-15 02:44:03 +0000640/*** EXPERIMENTAL ***
641**
642** Register a function to be invoked when a transaction comments.
danielk197771fd80b2005-12-16 06:54:01 +0000643** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +0000644** rollback.
645*/
danielk197724b03fd2004-05-10 10:34:34 +0000646void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +0000647 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +0000648 int (*xCallback)(void*), /* Function to invoke on each commit */
649 void *pArg /* Argument to the function */
650){
drhe30f4422007-08-21 16:15:55 +0000651 void *pOld;
652 sqlite3_mutex_enter(db->mutex);
653 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +0000654 db->xCommitCallback = xCallback;
655 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000656 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +0000657 return pOld;
658}
659
danielk197794eb6a12005-12-15 15:22:08 +0000660/*
661** Register a callback to be invoked each time a row is updated,
662** inserted or deleted using this database connection.
663*/
danielk197771fd80b2005-12-16 06:54:01 +0000664void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +0000665 sqlite3 *db, /* Attach the hook to this database */
666 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
667 void *pArg /* Argument to the function */
668){
drhe30f4422007-08-21 16:15:55 +0000669 void *pRet;
670 sqlite3_mutex_enter(db->mutex);
671 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +0000672 db->xUpdateCallback = xCallback;
673 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000674 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +0000675 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +0000676}
677
danielk197771fd80b2005-12-16 06:54:01 +0000678/*
679** Register a callback to be invoked each time a transaction is rolled
680** back by this database connection.
681*/
682void *sqlite3_rollback_hook(
683 sqlite3 *db, /* Attach the hook to this database */
684 void (*xCallback)(void*), /* Callback function */
685 void *pArg /* Argument to the function */
686){
drhe30f4422007-08-21 16:15:55 +0000687 void *pRet;
688 sqlite3_mutex_enter(db->mutex);
689 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +0000690 db->xRollbackCallback = xCallback;
691 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000692 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +0000693 return pRet;
694}
drhaa940ea2004-01-15 02:44:03 +0000695
paulb0208cc2003-04-13 18:26:49 +0000696/*
drh13bff812003-04-15 01:19:47 +0000697** This routine is called to create a connection to a database BTree
698** driver. If zFilename is the name of a file, then that file is
699** opened and used. If zFilename is the magic name ":memory:" then
700** the database is stored in memory (and is thus forgotten as soon as
701** the connection is closed.) If zFilename is NULL then the database
drh84bfda42005-07-15 13:05:21 +0000702** is a "virtual" database for transient use only and is deleted as
703** soon as the connection is closed.
drh90f5ecb2004-07-22 01:19:35 +0000704**
drh84bfda42005-07-15 13:05:21 +0000705** A virtual database can be either a disk file (that is automatically
706** deleted when the file is closed) or it an be held entirely in memory,
drh90f5ecb2004-07-22 01:19:35 +0000707** depending on the values of the TEMP_STORE compile-time macro and the
708** db->temp_store variable, according to the following chart:
709**
710** TEMP_STORE db->temp_store Location of temporary database
711** ---------- -------------- ------------------------------
712** 0 any file
713** 1 1 file
714** 1 2 memory
715** 1 0 file
716** 2 1 file
717** 2 2 memory
718** 2 0 memory
719** 3 any memory
paulb0208cc2003-04-13 18:26:49 +0000720*/
danielk19774adee202004-05-08 08:23:19 +0000721int sqlite3BtreeFactory(
drh9bb575f2004-09-06 17:24:11 +0000722 const sqlite3 *db, /* Main database when opening aux otherwise 0 */
paulb0208cc2003-04-13 18:26:49 +0000723 const char *zFilename, /* Name of the file containing the BTree database */
724 int omitJournal, /* if TRUE then do not journal this file */
725 int nCache, /* How many pages in the page cache */
danielk19774adee202004-05-08 08:23:19 +0000726 Btree **ppBtree /* Pointer to new Btree object written here */
727){
danielk19774adee202004-05-08 08:23:19 +0000728 int btree_flags = 0;
drh90f5ecb2004-07-22 01:19:35 +0000729 int rc;
danielk19774adee202004-05-08 08:23:19 +0000730
drhe30f4422007-08-21 16:15:55 +0000731 assert( sqlite3_mutex_held(db->mutex) );
drheec983e2004-05-08 10:11:36 +0000732 assert( ppBtree != 0);
danielk19774adee202004-05-08 08:23:19 +0000733 if( omitJournal ){
734 btree_flags |= BTREE_OMIT_JOURNAL;
paulb0208cc2003-04-13 18:26:49 +0000735 }
drh7bec5052005-02-06 02:45:41 +0000736 if( db->flags & SQLITE_NoReadlock ){
737 btree_flags |= BTREE_NO_READLOCK;
738 }
drh90f5ecb2004-07-22 01:19:35 +0000739 if( zFilename==0 ){
drh90f5ecb2004-07-22 01:19:35 +0000740#if TEMP_STORE==0
drh22ac46d2004-08-14 18:34:54 +0000741 /* Do nothing */
drh90f5ecb2004-07-22 01:19:35 +0000742#endif
danielk197703aded42004-11-22 05:26:27 +0000743#ifndef SQLITE_OMIT_MEMORYDB
drh90f5ecb2004-07-22 01:19:35 +0000744#if TEMP_STORE==1
drh22ac46d2004-08-14 18:34:54 +0000745 if( db->temp_store==2 ) zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +0000746#endif
747#if TEMP_STORE==2
drh22ac46d2004-08-14 18:34:54 +0000748 if( db->temp_store!=1 ) zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +0000749#endif
750#if TEMP_STORE==3
drh22ac46d2004-08-14 18:34:54 +0000751 zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +0000752#endif
danielk197703aded42004-11-22 05:26:27 +0000753#endif /* SQLITE_OMIT_MEMORYDB */
drh90f5ecb2004-07-22 01:19:35 +0000754 }
danielk19774adee202004-05-08 08:23:19 +0000755
danielk1977da184232006-01-05 11:34:32 +0000756 rc = sqlite3BtreeOpen(zFilename, (sqlite3 *)db, ppBtree, btree_flags);
drh90f5ecb2004-07-22 01:19:35 +0000757 if( rc==SQLITE_OK ){
758 sqlite3BtreeSetBusyHandler(*ppBtree, (void*)&db->busyHandler);
759 sqlite3BtreeSetCacheSize(*ppBtree, nCache);
760 }
761 return rc;
paulb0208cc2003-04-13 18:26:49 +0000762}
danielk19774adee202004-05-08 08:23:19 +0000763
danielk19774ad17132004-05-21 01:47:26 +0000764/*
765** Return UTF-8 encoded English language explanation of the most recent
766** error.
767*/
danielk19776622cce2004-05-20 11:00:52 +0000768const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +0000769 const char *z;
danielk1977ae7fc492007-03-29 15:00:52 +0000770 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +0000771 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +0000772 }
drhe30f4422007-08-21 16:15:55 +0000773 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +0000774 assert( !db->mallocFailed );
drhc60d0442004-09-30 13:43:13 +0000775 if( sqlite3SafetyCheck(db) || db->errCode==SQLITE_MISUSE ){
danielk1977e35ee192004-06-26 09:50:11 +0000776 return sqlite3ErrStr(SQLITE_MISUSE);
777 }
drh2646da72005-12-09 20:02:05 +0000778 z = (char*)sqlite3_value_text(db->pErr);
drhc60d0442004-09-30 13:43:13 +0000779 if( z==0 ){
780 z = sqlite3ErrStr(db->errCode);
danielk19776622cce2004-05-20 11:00:52 +0000781 }
drhe30f4422007-08-21 16:15:55 +0000782 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +0000783 return z;
danielk19776622cce2004-05-20 11:00:52 +0000784}
785
drh6c626082004-11-14 21:56:29 +0000786#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +0000787/*
788** Return UTF-16 encoded English language explanation of the most recent
789** error.
790*/
danielk19776622cce2004-05-20 11:00:52 +0000791const void *sqlite3_errmsg16(sqlite3 *db){
danielk1977bfd6cce2004-06-18 04:24:54 +0000792 /* Because all the characters in the string are in the unicode
793 ** range 0x00-0xFF, if we pad the big-endian string with a
794 ** zero byte, we can obtain the little-endian string with
795 ** &big_endian[1].
796 */
drh57196282004-10-06 15:41:16 +0000797 static const char outOfMemBe[] = {
danielk1977bfd6cce2004-06-18 04:24:54 +0000798 0, 'o', 0, 'u', 0, 't', 0, ' ',
799 0, 'o', 0, 'f', 0, ' ',
800 0, 'm', 0, 'e', 0, 'm', 0, 'o', 0, 'r', 0, 'y', 0, 0, 0
801 };
drh57196282004-10-06 15:41:16 +0000802 static const char misuseBe [] = {
danielk1977e35ee192004-06-26 09:50:11 +0000803 0, 'l', 0, 'i', 0, 'b', 0, 'r', 0, 'a', 0, 'r', 0, 'y', 0, ' ',
804 0, 'r', 0, 'o', 0, 'u', 0, 't', 0, 'i', 0, 'n', 0, 'e', 0, ' ',
805 0, 'c', 0, 'a', 0, 'l', 0, 'l', 0, 'e', 0, 'd', 0, ' ',
806 0, 'o', 0, 'u', 0, 't', 0, ' ',
807 0, 'o', 0, 'f', 0, ' ',
808 0, 's', 0, 'e', 0, 'q', 0, 'u', 0, 'e', 0, 'n', 0, 'c', 0, 'e', 0, 0, 0
809 };
danielk19774ad17132004-05-21 01:47:26 +0000810
drhc60d0442004-09-30 13:43:13 +0000811 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +0000812 if( !db ){
drhc60d0442004-09-30 13:43:13 +0000813 return (void *)(&outOfMemBe[SQLITE_UTF16NATIVE==SQLITE_UTF16LE?1:0]);
814 }
815 if( sqlite3SafetyCheck(db) || db->errCode==SQLITE_MISUSE ){
816 return (void *)(&misuseBe[SQLITE_UTF16NATIVE==SQLITE_UTF16LE?1:0]);
817 }
drhe30f4422007-08-21 16:15:55 +0000818 sqlite3_mutex_enter(db->mutex);
819 assert( !db->mallocFailed );
drhc60d0442004-09-30 13:43:13 +0000820 z = sqlite3_value_text16(db->pErr);
821 if( z==0 ){
danielk19771e536952007-08-16 10:09:01 +0000822 sqlite3ValueSetStr(db, db->pErr, -1, sqlite3ErrStr(db->errCode),
drhc60d0442004-09-30 13:43:13 +0000823 SQLITE_UTF8, SQLITE_STATIC);
824 z = sqlite3_value_text16(db->pErr);
825 }
danielk197754f01982006-01-18 15:25:17 +0000826 sqlite3ApiExit(0, 0);
drhe30f4422007-08-21 16:15:55 +0000827 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +0000828 return z;
danielk19776622cce2004-05-20 11:00:52 +0000829}
drh6c626082004-11-14 21:56:29 +0000830#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +0000831
drhc60d0442004-09-30 13:43:13 +0000832/*
danielk19777ddad962005-12-12 06:53:03 +0000833** Return the most recent error code generated by an SQLite routine. If NULL is
834** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +0000835*/
danielk19776622cce2004-05-20 11:00:52 +0000836int sqlite3_errcode(sqlite3 *db){
drh17435752007-08-16 04:30:38 +0000837 if( !db || db->mallocFailed ){
drhc60d0442004-09-30 13:43:13 +0000838 return SQLITE_NOMEM;
839 }
840 if( sqlite3SafetyCheck(db) ){
841 return SQLITE_MISUSE;
842 }
drh4ac285a2006-09-15 07:28:50 +0000843 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +0000844}
845
drh0e819f92006-02-01 13:50:41 +0000846/*
847** Create a new collating function for database "db". The name is zName
848** and the encoding is enc.
849*/
danielk19779a30cf62006-01-18 04:26:07 +0000850static int createCollation(
851 sqlite3* db,
852 const char *zName,
853 int enc,
854 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +0000855 int(*xCompare)(void*,int,const void*,int,const void*),
856 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +0000857){
858 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +0000859 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +0000860
861 if( sqlite3SafetyCheck(db) ){
862 return SQLITE_MISUSE;
863 }
drhe30f4422007-08-21 16:15:55 +0000864 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +0000865
866 /* If SQLITE_UTF16 is specified as the encoding type, transform this
867 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
868 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
869 */
drh7d9bd4e2006-02-16 18:16:36 +0000870 enc2 = enc & ~SQLITE_UTF16_ALIGNED;
871 if( enc2==SQLITE_UTF16 ){
872 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +0000873 }
874
drh7d9bd4e2006-02-16 18:16:36 +0000875 if( (enc2&~3)!=0 ){
876 sqlite3Error(db, SQLITE_ERROR, "unknown encoding");
danielk19779a30cf62006-01-18 04:26:07 +0000877 return SQLITE_ERROR;
878 }
879
880 /* Check if this call is removing or replacing an existing collation
881 ** sequence. If so, and there are active VMs, return busy. If there
882 ** are no active VMs, invalidate any pre-compiled statements.
883 */
drh7d9bd4e2006-02-16 18:16:36 +0000884 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, strlen(zName), 0);
danielk19779a30cf62006-01-18 04:26:07 +0000885 if( pColl && pColl->xCmp ){
886 if( db->activeVdbeCnt ){
887 sqlite3Error(db, SQLITE_BUSY,
888 "Unable to delete/modify collation sequence due to active statements");
889 return SQLITE_BUSY;
890 }
891 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +0000892
893 /* If collation sequence pColl was created directly by a call to
894 ** sqlite3_create_collation, and not generated by synthCollSeq(),
895 ** then any copies made by synthCollSeq() need to be invalidated.
896 ** Also, collation destructor - CollSeq.xDel() - function may need
897 ** to be called.
898 */
899 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
900 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, strlen(zName));
901 int j;
902 for(j=0; j<3; j++){
903 CollSeq *p = &aColl[j];
904 if( p->enc==pColl->enc ){
905 if( p->xDel ){
906 p->xDel(p->pUser);
907 }
908 p->xCmp = 0;
909 }
910 }
911 }
danielk19779a30cf62006-01-18 04:26:07 +0000912 }
913
drh7d9bd4e2006-02-16 18:16:36 +0000914 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, strlen(zName), 1);
danielk19779a30cf62006-01-18 04:26:07 +0000915 if( pColl ){
916 pColl->xCmp = xCompare;
917 pColl->pUser = pCtx;
danielk1977a9808b32007-05-07 09:32:45 +0000918 pColl->xDel = xDel;
drh7d9bd4e2006-02-16 18:16:36 +0000919 pColl->enc = enc2 | (enc & SQLITE_UTF16_ALIGNED);
danielk19779a30cf62006-01-18 04:26:07 +0000920 }
921 sqlite3Error(db, SQLITE_OK, 0);
922 return SQLITE_OK;
923}
924
925
danielk19776622cce2004-05-20 11:00:52 +0000926/*
danielk19774ad17132004-05-21 01:47:26 +0000927** This routine does the work of opening a database on behalf of
928** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +0000929** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +0000930*/
931static int openDatabase(
932 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +0000933 sqlite3 **ppDb, /* OUT: Returned database handle */
934 unsigned flags, /* Operational flags */
935 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +0000936){
937 sqlite3 *db;
danielk1977da184232006-01-05 11:34:32 +0000938 int rc;
drhd64fe2f2005-08-28 17:00:23 +0000939 CollSeq *pColl;
danielk19774ad17132004-05-21 01:47:26 +0000940
941 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +0000942 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +0000943 if( db==0 ) goto opendb_out;
drh605264d2007-08-21 15:13:19 +0000944 db->mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_RECURSIVE);
945 if( db->mutex==0 ){
946 db->mallocFailed = 1;
947 goto opendb_out;
948 }
949 db->pVfs = sqlite3_vfs_find(zVfs);
drh4ac285a2006-09-15 07:28:50 +0000950 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +0000951 db->priorNewRowid = 0;
952 db->magic = SQLITE_MAGIC_BUSY;
953 db->nDb = 2;
954 db->aDb = db->aDbStatic;
danielk19771d850a72004-05-31 08:26:49 +0000955 db->autoCommit = 1;
drh76fe8032006-07-11 14:17:51 +0000956 db->flags |= SQLITE_ShortColNames
957#if SQLITE_DEFAULT_FILE_FORMAT<4
958 | SQLITE_LegacyFileFmt
959#endif
drh56424db2007-03-27 22:24:11 +0000960#ifdef SQLITE_ENABLE_LOAD_EXTENSION
961 | SQLITE_LoadExtension
962#endif
drh76fe8032006-07-11 14:17:51 +0000963 ;
drhf9b596e2004-05-26 16:54:42 +0000964 sqlite3HashInit(&db->aFunc, SQLITE_HASH_STRING, 0);
danielk19774ad17132004-05-21 01:47:26 +0000965 sqlite3HashInit(&db->aCollSeq, SQLITE_HASH_STRING, 0);
drhb9bb7c12006-06-11 23:41:55 +0000966#ifndef SQLITE_OMIT_VIRTUALTABLE
967 sqlite3HashInit(&db->aModule, SQLITE_HASH_STRING, 0);
968#endif
danielk1977da184232006-01-05 11:34:32 +0000969
danielk19770202b292004-06-09 09:55:16 +0000970 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
971 ** and UTF-16, so add a version for each to avoid any unnecessary
972 ** conversions. The only error that can occur here is a malloc() failure.
973 */
danielk1977a9808b32007-05-07 09:32:45 +0000974 if( createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0) ||
975 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0) ||
976 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0) ||
danielk197714db2662006-01-09 16:12:04 +0000977 (db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 6, 0))==0
danielk19777ddad962005-12-12 06:53:03 +0000978 ){
drh17435752007-08-16 04:30:38 +0000979 assert( db->mallocFailed );
danielk19770202b292004-06-09 09:55:16 +0000980 db->magic = SQLITE_MAGIC_CLOSED;
981 goto opendb_out;
982 }
983
984 /* Also add a UTF-8 case-insensitive collation sequence. */
danielk1977a9808b32007-05-07 09:32:45 +0000985 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
danielk19770202b292004-06-09 09:55:16 +0000986
drhd64fe2f2005-08-28 17:00:23 +0000987 /* Set flags on the built-in collating sequences */
988 db->pDfltColl->type = SQLITE_COLL_BINARY;
989 pColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "NOCASE", 6, 0);
990 if( pColl ){
991 pColl->type = SQLITE_COLL_NOCASE;
992 }
993
danielk19774ad17132004-05-21 01:47:26 +0000994 /* Open the backend database driver */
drhc797d4d2007-05-08 01:08:49 +0000995 rc = sqlite3BtreeFactory(db, zFilename, 0, SQLITE_DEFAULT_CACHE_SIZE,
996 &db->aDb[0].pBt);
danielk19774ad17132004-05-21 01:47:26 +0000997 if( rc!=SQLITE_OK ){
danielk19774ad17132004-05-21 01:47:26 +0000998 sqlite3Error(db, rc, 0);
999 db->magic = SQLITE_MAGIC_CLOSED;
1000 goto opendb_out;
1001 }
drh17435752007-08-16 04:30:38 +00001002 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
1003 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00001004
drh03b808a2006-03-13 15:06:05 +00001005
danielk197753c0f742005-03-29 03:10:59 +00001006 /* The default safety_level for the main database is 'full'; for the temp
1007 ** database it is 'NONE'. This matches the pager layer defaults.
1008 */
1009 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00001010 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00001011#ifndef SQLITE_OMIT_TEMPDB
1012 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00001013 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00001014#endif
1015
danielk1977832a58a2007-06-22 15:21:15 +00001016 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00001017 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00001018 goto opendb_out;
1019 }
1020
danielk19778e227872004-06-07 07:52:17 +00001021 /* Register all built-in functions, but do not attempt to read the
1022 ** database schema yet. This is delayed until the first time the database
1023 ** is accessed.
1024 */
danielk1977832a58a2007-06-22 15:21:15 +00001025 sqlite3Error(db, SQLITE_OK, 0);
1026 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00001027
drh1409be62006-08-23 20:07:20 +00001028 /* Load automatic extensions - extensions that have been registered
1029 ** using the sqlite3_automatic_extension() API.
1030 */
drhf533acc2006-12-19 18:57:11 +00001031 (void)sqlite3AutoLoadExtensions(db);
danielk1977832a58a2007-06-22 15:21:15 +00001032 if( sqlite3_errcode(db)!=SQLITE_OK ){
1033 goto opendb_out;
1034 }
drh1409be62006-08-23 20:07:20 +00001035
drhaa29c132006-09-02 13:58:06 +00001036#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00001037 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00001038 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001039 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00001040 }
1041#endif
1042
shessa26cf572006-10-19 20:27:58 +00001043#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00001044 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00001045 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001046 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00001047 }
1048#endif
1049
shess69c4ae22007-08-20 17:37:47 +00001050#ifdef SQLITE_ENABLE_FTS3
1051 if( !db->mallocFailed && rc==SQLITE_OK ){
1052 extern int sqlite3Fts3Init(sqlite3*);
1053 rc = sqlite3Fts3Init(db);
1054 }
1055#endif
1056
danielk197783852ac2007-05-06 16:04:11 +00001057#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00001058 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk197783852ac2007-05-06 16:04:11 +00001059 extern int sqlite3IcuInit(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001060 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00001061 }
1062#endif
danielk1977832a58a2007-06-22 15:21:15 +00001063 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00001064
drh8fd5bd32007-04-02 16:40:37 +00001065 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
1066 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
1067 ** mode. Doing nothing at all also makes NORMAL the default.
1068 */
1069#ifdef SQLITE_DEFAULT_LOCKING_MODE
1070 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
1071 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
1072 SQLITE_DEFAULT_LOCKING_MODE);
1073#endif
1074
danielk19774ad17132004-05-21 01:47:26 +00001075opendb_out:
danielk19777ddad962005-12-12 06:53:03 +00001076 if( SQLITE_NOMEM==(rc = sqlite3_errcode(db)) ){
1077 sqlite3_close(db);
1078 db = 0;
danielk197713073932004-06-30 11:54:06 +00001079 }
danielk19774ad17132004-05-21 01:47:26 +00001080 *ppDb = db;
danielk197754f01982006-01-18 15:25:17 +00001081 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00001082}
1083
1084/*
1085** Open a new database handle.
1086*/
danielk197780290862004-05-22 09:21:21 +00001087int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00001088 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00001089 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00001090){
drh605264d2007-08-21 15:13:19 +00001091 return openDatabase(zFilename, ppDb,
1092 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
1093}
1094int sqlite3_open_v2(
1095 const void *filename, /* Database filename (UTF-8) */
1096 sqlite3 **ppDb, /* OUT: SQLite db handle */
1097 int flags, /* Flags */
1098 const char *zVfs /* Name of VFS module to use */
1099){
1100 return openDatabase(filename, ppDb, flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00001101}
1102
drh6c626082004-11-14 21:56:29 +00001103#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001104/*
1105** Open a new database handle.
1106*/
1107int sqlite3_open16(
1108 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00001109 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00001110){
danielk1977bfd6cce2004-06-18 04:24:54 +00001111 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00001112 sqlite3_value *pVal;
danielk19771e536952007-08-16 10:09:01 +00001113 int rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00001114
danielk19777ddad962005-12-12 06:53:03 +00001115 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00001116 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00001117 *ppDb = 0;
danielk19771e536952007-08-16 10:09:01 +00001118 pVal = sqlite3ValueNew(0);
1119 sqlite3ValueSetStr(0, pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
1120 zFilename8 = sqlite3ValueText(0, pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00001121 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00001122 rc = openDatabase(zFilename8, ppDb,
1123 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
danielk1977bfd6cce2004-06-18 04:24:54 +00001124 if( rc==SQLITE_OK && *ppDb ){
drh7dd90a42005-12-06 13:19:07 +00001125 rc = sqlite3_exec(*ppDb, "PRAGMA encoding = 'UTF-16'", 0, 0, 0);
danielk1977950f0542006-01-18 05:51:57 +00001126 if( rc!=SQLITE_OK ){
1127 sqlite3_close(*ppDb);
1128 *ppDb = 0;
1129 }
danielk1977bfd6cce2004-06-18 04:24:54 +00001130 }
danielk19774ad17132004-05-21 01:47:26 +00001131 }
danielk19777ddad962005-12-12 06:53:03 +00001132 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00001133
danielk197754f01982006-01-18 15:25:17 +00001134 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00001135}
drh6c626082004-11-14 21:56:29 +00001136#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00001137
danielk1977106bb232004-05-21 10:08:53 +00001138/*
danielk1977d8123362004-06-12 09:25:12 +00001139** Register a new collation sequence with the database handle db.
1140*/
danielk19770202b292004-06-09 09:55:16 +00001141int sqlite3_create_collation(
1142 sqlite3* db,
1143 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00001144 int enc,
danielk19770202b292004-06-09 09:55:16 +00001145 void* pCtx,
1146 int(*xCompare)(void*,int,const void*,int,const void*)
1147){
danielk19779a30cf62006-01-18 04:26:07 +00001148 int rc;
drhe30f4422007-08-21 16:15:55 +00001149 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001150 assert( !db->mallocFailed );
danielk1977a9808b32007-05-07 09:32:45 +00001151 rc = createCollation(db, zName, enc, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00001152 rc = sqlite3ApiExit(db, rc);
1153 sqlite3_mutex_leave(db->mutex);
1154 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00001155}
1156
1157/*
1158** Register a new collation sequence with the database handle db.
1159*/
danielk1977a393c032007-05-07 14:58:53 +00001160int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00001161 sqlite3* db,
1162 const char *zName,
1163 int enc,
1164 void* pCtx,
1165 int(*xCompare)(void*,int,const void*,int,const void*),
1166 void(*xDel)(void*)
1167){
1168 int rc;
drhe30f4422007-08-21 16:15:55 +00001169 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001170 assert( !db->mallocFailed );
danielk1977a9808b32007-05-07 09:32:45 +00001171 rc = createCollation(db, zName, enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00001172 rc = sqlite3ApiExit(db, rc);
1173 sqlite3_mutex_leave(db->mutex);
1174 return rc;
danielk19770202b292004-06-09 09:55:16 +00001175}
1176
drh6c626082004-11-14 21:56:29 +00001177#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001178/*
1179** Register a new collation sequence with the database handle db.
1180*/
danielk19770202b292004-06-09 09:55:16 +00001181int sqlite3_create_collation16(
1182 sqlite3* db,
1183 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00001184 int enc,
danielk19770202b292004-06-09 09:55:16 +00001185 void* pCtx,
1186 int(*xCompare)(void*,int,const void*,int,const void*)
1187){
danielk19779a30cf62006-01-18 04:26:07 +00001188 int rc = SQLITE_OK;
1189 char *zName8;
drhe30f4422007-08-21 16:15:55 +00001190 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001191 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +00001192 zName8 = sqlite3Utf16to8(db, zName, -1);
danielk19779a30cf62006-01-18 04:26:07 +00001193 if( zName8 ){
danielk1977a9808b32007-05-07 09:32:45 +00001194 rc = createCollation(db, zName8, enc, pCtx, xCompare, 0);
drh17435752007-08-16 04:30:38 +00001195 sqlite3_free(zName8);
danielk19779a30cf62006-01-18 04:26:07 +00001196 }
drhe30f4422007-08-21 16:15:55 +00001197 rc = sqlite3ApiExit(db, rc);
1198 sqlite3_mutex_leave(db->mutex);
1199 return rc;
danielk19770202b292004-06-09 09:55:16 +00001200}
drh6c626082004-11-14 21:56:29 +00001201#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00001202
danielk1977d8123362004-06-12 09:25:12 +00001203/*
1204** Register a collation sequence factory callback with the database handle
1205** db. Replace any previously installed collation sequence factory.
1206*/
danielk19777cedc8d2004-06-10 10:50:08 +00001207int sqlite3_collation_needed(
1208 sqlite3 *db,
1209 void *pCollNeededArg,
1210 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
1211){
drhc60d0442004-09-30 13:43:13 +00001212 if( sqlite3SafetyCheck(db) ){
1213 return SQLITE_MISUSE;
1214 }
drhe30f4422007-08-21 16:15:55 +00001215 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001216 db->xCollNeeded = xCollNeeded;
1217 db->xCollNeeded16 = 0;
1218 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00001219 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001220 return SQLITE_OK;
1221}
danielk1977d8123362004-06-12 09:25:12 +00001222
drh6c626082004-11-14 21:56:29 +00001223#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001224/*
1225** Register a collation sequence factory callback with the database handle
1226** db. Replace any previously installed collation sequence factory.
1227*/
danielk19777cedc8d2004-06-10 10:50:08 +00001228int sqlite3_collation_needed16(
1229 sqlite3 *db,
1230 void *pCollNeededArg,
1231 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
1232){
drhc60d0442004-09-30 13:43:13 +00001233 if( sqlite3SafetyCheck(db) ){
1234 return SQLITE_MISUSE;
1235 }
drhe30f4422007-08-21 16:15:55 +00001236 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001237 db->xCollNeeded = 0;
1238 db->xCollNeeded16 = xCollNeeded16;
1239 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00001240 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001241 return SQLITE_OK;
1242}
drh6c626082004-11-14 21:56:29 +00001243#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00001244
1245#ifndef SQLITE_OMIT_GLOBALRECOVER
1246/*
danielk19777ddad962005-12-12 06:53:03 +00001247** This function is now an anachronism. It used to be used to recover from a
1248** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00001249*/
1250int sqlite3_global_recover(){
danielk1977261919c2005-12-06 12:52:59 +00001251 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00001252}
1253#endif
drh3e1d8e62005-05-26 16:23:34 +00001254
1255/*
1256** Test to see whether or not the database connection is in autocommit
1257** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
1258** by default. Autocommit is disabled by a BEGIN statement and reenabled
1259** by the next COMMIT or ROLLBACK.
1260**
1261******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
1262*/
1263int sqlite3_get_autocommit(sqlite3 *db){
1264 return db->autoCommit;
1265}
drh49285702005-09-17 15:20:26 +00001266
1267#ifdef SQLITE_DEBUG
1268/*
1269** The following routine is subtituted for constant SQLITE_CORRUPT in
1270** debugging builds. This provides a way to set a breakpoint for when
1271** corruption is first detected.
1272*/
1273int sqlite3Corrupt(void){
1274 return SQLITE_CORRUPT;
1275}
1276#endif
drh7c1817e2006-01-10 13:58:48 +00001277
drh6f7adc82006-01-11 21:41:20 +00001278/*
1279** This is a convenience routine that makes sure that all thread-specific
1280** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00001281**
1282** SQLite no longer uses thread-specific data so this routine is now a
1283** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00001284*/
1285void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00001286}
danielk1977deb802c2006-02-09 13:43:28 +00001287
1288/*
1289** Return meta information about a specific column of a database table.
1290** See comment in sqlite3.h (sqlite.h.in) for details.
1291*/
1292#ifdef SQLITE_ENABLE_COLUMN_METADATA
1293int sqlite3_table_column_metadata(
1294 sqlite3 *db, /* Connection handle */
1295 const char *zDbName, /* Database name or NULL */
1296 const char *zTableName, /* Table name */
1297 const char *zColumnName, /* Column name */
1298 char const **pzDataType, /* OUTPUT: Declared data type */
1299 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
1300 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
1301 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
1302 int *pAutoinc /* OUTPUT: True if colums is auto-increment */
1303){
1304 int rc;
1305 char *zErrMsg = 0;
1306 Table *pTab = 0;
1307 Column *pCol = 0;
1308 int iCol;
1309
1310 char const *zDataType = 0;
1311 char const *zCollSeq = 0;
1312 int notnull = 0;
1313 int primarykey = 0;
1314 int autoinc = 0;
1315
1316 /* Ensure the database schema has been loaded */
1317 if( sqlite3SafetyOn(db) ){
1318 return SQLITE_MISUSE;
1319 }
drhe30f4422007-08-21 16:15:55 +00001320 sqlite3_mutex_enter(db->mutex);
danielk1977deb802c2006-02-09 13:43:28 +00001321 rc = sqlite3Init(db, &zErrMsg);
1322 if( SQLITE_OK!=rc ){
1323 goto error_out;
1324 }
1325
1326 /* Locate the table in question */
1327 pTab = sqlite3FindTable(db, zTableName, zDbName);
1328 if( !pTab || pTab->pSelect ){
1329 pTab = 0;
1330 goto error_out;
1331 }
1332
1333 /* Find the column for which info is requested */
1334 if( sqlite3IsRowid(zColumnName) ){
1335 iCol = pTab->iPKey;
1336 if( iCol>=0 ){
1337 pCol = &pTab->aCol[iCol];
1338 }
1339 }else{
1340 for(iCol=0; iCol<pTab->nCol; iCol++){
1341 pCol = &pTab->aCol[iCol];
1342 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
1343 break;
1344 }
1345 }
1346 if( iCol==pTab->nCol ){
1347 pTab = 0;
1348 goto error_out;
1349 }
1350 }
1351
1352 /* The following block stores the meta information that will be returned
1353 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
1354 ** and autoinc. At this point there are two possibilities:
1355 **
1356 ** 1. The specified column name was rowid", "oid" or "_rowid_"
1357 ** and there is no explicitly declared IPK column.
1358 **
1359 ** 2. The table is not a view and the column name identified an
1360 ** explicitly declared column. Copy meta information from *pCol.
1361 */
1362 if( pCol ){
1363 zDataType = pCol->zType;
1364 zCollSeq = pCol->zColl;
1365 notnull = (pCol->notNull?1:0);
1366 primarykey = (pCol->isPrimKey?1:0);
1367 autoinc = ((pTab->iPKey==iCol && pTab->autoInc)?1:0);
1368 }else{
1369 zDataType = "INTEGER";
1370 primarykey = 1;
1371 }
1372 if( !zCollSeq ){
1373 zCollSeq = "BINARY";
1374 }
1375
1376error_out:
1377 if( sqlite3SafetyOff(db) ){
1378 rc = SQLITE_MISUSE;
1379 }
1380
1381 /* Whether the function call succeeded or failed, set the output parameters
1382 ** to whatever their local counterparts contain. If an error did occur,
1383 ** this has the effect of zeroing all output parameters.
1384 */
1385 if( pzDataType ) *pzDataType = zDataType;
1386 if( pzCollSeq ) *pzCollSeq = zCollSeq;
1387 if( pNotNull ) *pNotNull = notnull;
1388 if( pPrimaryKey ) *pPrimaryKey = primarykey;
1389 if( pAutoinc ) *pAutoinc = autoinc;
1390
1391 if( SQLITE_OK==rc && !pTab ){
1392 sqlite3SetString(&zErrMsg, "no such table column: ", zTableName, ".",
1393 zColumnName, 0);
1394 rc = SQLITE_ERROR;
1395 }
1396 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh17435752007-08-16 04:30:38 +00001397 sqlite3_free(zErrMsg);
drhe30f4422007-08-21 16:15:55 +00001398 rc = sqlite3ApiExit(db, rc);
1399 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00001400 return rc;
1401}
drhe30f4422007-08-21 16:15:55 +00001402#endif
drhf9cb7f52006-06-27 20:06:44 +00001403
1404/*
1405** Sleep for a little while. Return the amount of time slept.
1406*/
1407int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00001408 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00001409 int rc;
drhd677b3d2007-08-20 22:48:41 +00001410 pVfs = sqlite3_vfs_find(0);
danielk1977fee2d252007-08-18 10:59:19 +00001411
1412 /* This function works in milliseconds, but the underlying OsSleep()
1413 ** API uses microseconds. Hence the 1000's.
1414 */
drhe30f4422007-08-21 16:15:55 +00001415 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
1416 sqlite3_vfs_release(pVfs);
1417 return rc;
drhf9cb7f52006-06-27 20:06:44 +00001418}
drh4ac285a2006-09-15 07:28:50 +00001419
1420/*
1421** Enable or disable the extended result codes.
1422*/
1423int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00001424 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001425 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00001426 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001427 return SQLITE_OK;
1428}