blob: 51ed40d998e550496f7575f491a4754398b8bfa0 [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**
danielk1977fa18bec2007-09-03 11:04:22 +000017** $Id: main.c,v 1.403 2007/09/03 11:04:22 danielk1977 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; }
drhb67e8bf2007-08-30 20:09:48 +000028int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
drhb217a572000-08-22 13:40:18 +000029
30/*
drhb0603412007-02-28 04:47:26 +000031** If the following function pointer is not NULL and if
32** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
33** I/O active are written using this function. These messages
34** are intended for debugging activity only.
35*/
36void (*sqlite3_io_trace)(const char*, ...) = 0;
37
38/*
drha16313e2007-03-30 11:29:32 +000039** If the following global variable points to a string which is the
40** name of a directory, then that directory will be used to store
41** temporary files.
42**
43** See also the "PRAGMA temp_store_directory" SQL command.
44*/
45char *sqlite3_temp_directory = 0;
46
47
48/*
drhd3d39e92004-05-20 22:16:29 +000049** This is the default collating function named "BINARY" which is always
50** available.
51*/
danielk19772c336542005-01-13 02:14:23 +000052static int binCollFunc(
drhd3d39e92004-05-20 22:16:29 +000053 void *NotUsed,
54 int nKey1, const void *pKey1,
55 int nKey2, const void *pKey2
56){
57 int rc, n;
58 n = nKey1<nKey2 ? nKey1 : nKey2;
59 rc = memcmp(pKey1, pKey2, n);
60 if( rc==0 ){
61 rc = nKey1 - nKey2;
62 }
63 return rc;
64}
65
66/*
danielk1977dc1bdc42004-06-11 10:51:27 +000067** Another built-in collating sequence: NOCASE.
68**
69** This collating sequence is intended to be used for "case independant
70** comparison". SQLite's knowledge of upper and lower case equivalents
71** extends only to the 26 characters used in the English language.
72**
73** At the moment there is only a UTF-8 implementation.
danielk19770202b292004-06-09 09:55:16 +000074*/
75static int nocaseCollatingFunc(
76 void *NotUsed,
77 int nKey1, const void *pKey1,
78 int nKey2, const void *pKey2
79){
80 int r = sqlite3StrNICmp(
drh208f80a2004-08-29 20:08:58 +000081 (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
danielk19770202b292004-06-09 09:55:16 +000082 if( 0==r ){
83 r = nKey1-nKey2;
84 }
85 return r;
86}
87
88/*
drhaf9ff332002-01-16 21:00:27 +000089** Return the ROWID of the most recent insert
90*/
drh9bb575f2004-09-06 17:24:11 +000091sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
drhaf9ff332002-01-16 21:00:27 +000092 return db->lastRowid;
93}
94
95/*
danielk197724b03fd2004-05-10 10:34:34 +000096** Return the number of changes in the most recent call to sqlite3_exec().
drhc8d30ac2002-04-12 10:08:59 +000097*/
drh9bb575f2004-09-06 17:24:11 +000098int sqlite3_changes(sqlite3 *db){
drhc8d30ac2002-04-12 10:08:59 +000099 return db->nChange;
100}
101
rdcf146a772004-02-25 22:51:06 +0000102/*
danielk1977b28af712004-06-21 06:50:26 +0000103** Return the number of changes since the database handle was opened.
rdcf146a772004-02-25 22:51:06 +0000104*/
danielk1977b28af712004-06-21 06:50:26 +0000105int sqlite3_total_changes(sqlite3 *db){
106 return db->nTotalChange;
rdcb0c374f2004-02-20 22:53:38 +0000107}
108
drhc8d30ac2002-04-12 10:08:59 +0000109/*
drh50e5dad2001-09-15 00:57:28 +0000110** Close an existing SQLite database
111*/
drh9bb575f2004-09-06 17:24:11 +0000112int sqlite3_close(sqlite3 *db){
drh8e0a2f92002-02-23 23:45:45 +0000113 HashElem *i;
drh001bbcb2003-03-19 03:14:00 +0000114 int j;
danielk19775c4c7782004-06-16 10:39:23 +0000115
116 if( !db ){
danielk197796d81f92004-06-19 03:33:57 +0000117 return SQLITE_OK;
danielk19775c4c7782004-06-16 10:39:23 +0000118 }
drhc60d0442004-09-30 13:43:13 +0000119 if( sqlite3SafetyCheck(db) ){
danielk1977e35ee192004-06-26 09:50:11 +0000120 return SQLITE_MISUSE;
121 }
drh605264d2007-08-21 15:13:19 +0000122 sqlite3_mutex_enter(db->mutex);
danielk1977e35ee192004-06-26 09:50:11 +0000123
danielk19771f723bd2005-05-26 12:37:29 +0000124#ifdef SQLITE_SSE
drh37527852006-03-16 16:19:56 +0000125 {
126 extern void sqlite3SseCleanup(sqlite3*);
127 sqlite3SseCleanup(db);
128 }
danielk19771f723bd2005-05-26 12:37:29 +0000129#endif
130
drhffc13f62006-07-30 20:50:44 +0000131 sqlite3ResetInternalSchema(db, 0);
danielk1977a04a34f2007-04-16 15:06:25 +0000132
danielk197701256832007-04-18 14:24:32 +0000133 /* If a transaction is open, the ResetInternalSchema() call above
134 ** will not have called the xDisconnect() method on any virtual
135 ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
136 ** call will do so. We need to do this before the check for active
137 ** SQL statements below, as the v-table implementation may be storing
138 ** some prepared statements internally.
139 */
140 sqlite3VtabRollback(db);
141
danielk1977a04a34f2007-04-16 15:06:25 +0000142 /* If there are any outstanding VMs, return SQLITE_BUSY. */
danielk197796d81f92004-06-19 03:33:57 +0000143 if( db->pVdbe ){
144 sqlite3Error(db, SQLITE_BUSY,
145 "Unable to close due to unfinalised statements");
drh27641702007-08-22 02:56:42 +0000146 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000147 return SQLITE_BUSY;
148 }
149 assert( !sqlite3SafetyCheck(db) );
danielk1977e0048402004-06-15 16:51:01 +0000150
151 /* FIX ME: db->magic may be set to SQLITE_MAGIC_CLOSED if the database
152 ** cannot be opened for some reason. So this routine needs to run in
153 ** that case. But maybe there should be an extra magic value for the
154 ** "failed to open" state.
danielk1977b5584c02007-03-30 07:10:50 +0000155 **
156 ** TODO: Coverage tests do not test the case where this condition is
157 ** true. It's hard to see how to cause it without messing with threads.
danielk1977e0048402004-06-15 16:51:01 +0000158 */
danielk197796d81f92004-06-19 03:33:57 +0000159 if( db->magic!=SQLITE_MAGIC_CLOSED && sqlite3SafetyOn(db) ){
drh94e92032003-02-16 22:21:32 +0000160 /* printf("DID NOT CLOSE\n"); fflush(stdout); */
drh27641702007-08-22 02:56:42 +0000161 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000162 return SQLITE_ERROR;
drh94e92032003-02-16 22:21:32 +0000163 }
danielk1977e0048402004-06-15 16:51:01 +0000164
drh001bbcb2003-03-19 03:14:00 +0000165 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000166 struct Db *pDb = &db->aDb[j];
167 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000168 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000169 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000170 if( j!=1 ){
171 pDb->pSchema = 0;
172 }
drh113088e2003-03-20 01:16:58 +0000173 }
drhf57b3392001-10-08 13:22:32 +0000174 }
danielk19774adee202004-05-08 08:23:19 +0000175 sqlite3ResetInternalSchema(db, 0);
drh1c2d8412003-03-31 00:30:47 +0000176 assert( db->nDb<=2 );
177 assert( db->aDb==db->aDbStatic );
drh0bce8352002-02-28 00:41:10 +0000178 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
179 FuncDef *pFunc, *pNext;
180 for(pFunc = (FuncDef*)sqliteHashData(i); pFunc; pFunc=pNext){
drh8e0a2f92002-02-23 23:45:45 +0000181 pNext = pFunc->pNext;
drh17435752007-08-16 04:30:38 +0000182 sqlite3_free(pFunc);
drh8e0a2f92002-02-23 23:45:45 +0000183 }
184 }
danielk1977466be562004-06-10 02:16:01 +0000185
danielk1977d8123362004-06-12 09:25:12 +0000186 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000187 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000188 /* Invoke any destructors registered for collation sequence user data. */
189 for(j=0; j<3; j++){
190 if( pColl[j].xDel ){
191 pColl[j].xDel(pColl[j].pUser);
192 }
193 }
drh17435752007-08-16 04:30:38 +0000194 sqlite3_free(pColl);
danielk1977466be562004-06-10 02:16:01 +0000195 }
danielk1977d8123362004-06-12 09:25:12 +0000196 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +0000197#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +0000198 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
199 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +0000200 if( pMod->xDestroy ){
201 pMod->xDestroy(pMod->pAux);
202 }
drh17435752007-08-16 04:30:38 +0000203 sqlite3_free(pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +0000204 }
drhb9bb7c12006-06-11 23:41:55 +0000205 sqlite3HashClear(&db->aModule);
206#endif
danielk1977466be562004-06-10 02:16:01 +0000207
danielk19774adee202004-05-08 08:23:19 +0000208 sqlite3HashClear(&db->aFunc);
danielk19776622cce2004-05-20 11:00:52 +0000209 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +0000210 if( db->pErr ){
211 sqlite3ValueFree(db->pErr);
212 }
drhf1952c52006-06-08 15:48:00 +0000213 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +0000214
215 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +0000216
217 /* The temp-database schema is allocated differently from the other schema
218 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
219 ** So it needs to be freed here. Todo: Why not roll the temp schema into
220 ** the same sqliteMalloc() as the one that allocates the database
221 ** structure?
222 */
drh17435752007-08-16 04:30:38 +0000223 sqlite3_free(db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +0000224 sqlite3_mutex_leave(db->mutex);
225 sqlite3_mutex_free(db->mutex);
drh17435752007-08-16 04:30:38 +0000226 sqlite3_free(db);
danielk197796d81f92004-06-19 03:33:57 +0000227 return SQLITE_OK;
drh75897232000-05-29 14:26:00 +0000228}
229
230/*
drh001bbcb2003-03-19 03:14:00 +0000231** Rollback all database files.
232*/
drh9bb575f2004-09-06 17:24:11 +0000233void sqlite3RollbackAll(sqlite3 *db){
drh001bbcb2003-03-19 03:14:00 +0000234 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +0000235 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +0000236 assert( sqlite3_mutex_held(db->mutex) );
drh001bbcb2003-03-19 03:14:00 +0000237 for(i=0; i<db->nDb; i++){
238 if( db->aDb[i].pBt ){
danielk1977f3f06bb2005-12-16 15:24:28 +0000239 if( sqlite3BtreeIsInTrans(db->aDb[i].pBt) ){
240 inTrans = 1;
241 }
danielk19774adee202004-05-08 08:23:19 +0000242 sqlite3BtreeRollback(db->aDb[i].pBt);
drh001bbcb2003-03-19 03:14:00 +0000243 db->aDb[i].inTrans = 0;
244 }
245 }
danielk1977a298e902006-06-22 09:53:48 +0000246 sqlite3VtabRollback(db);
danielk197771fd80b2005-12-16 06:54:01 +0000247 if( db->flags&SQLITE_InternChanges ){
danielk1977ea4d9e22007-08-13 15:28:33 +0000248 sqlite3ExpirePreparedStatements(db);
danielk197771fd80b2005-12-16 06:54:01 +0000249 sqlite3ResetInternalSchema(db, 0);
250 }
251
252 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +0000253 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +0000254 db->xRollbackCallback(db->pRollbackArg);
255 }
drh001bbcb2003-03-19 03:14:00 +0000256}
257
258/*
drhc22bd472002-05-10 13:14:07 +0000259** Return a static string that describes the kind of error specified in the
260** argument.
drh247be432002-05-10 05:44:55 +0000261*/
danielk1977f20b21c2004-05-31 23:56:42 +0000262const char *sqlite3ErrStr(int rc){
drhc22bd472002-05-10 13:14:07 +0000263 const char *z;
drh4ac285a2006-09-15 07:28:50 +0000264 switch( rc & 0xff ){
drhc60d0442004-09-30 13:43:13 +0000265 case SQLITE_ROW:
266 case SQLITE_DONE:
drhc22bd472002-05-10 13:14:07 +0000267 case SQLITE_OK: z = "not an error"; break;
268 case SQLITE_ERROR: z = "SQL logic error or missing database"; break;
drhc22bd472002-05-10 13:14:07 +0000269 case SQLITE_PERM: z = "access permission denied"; break;
270 case SQLITE_ABORT: z = "callback requested query abort"; break;
271 case SQLITE_BUSY: z = "database is locked"; break;
272 case SQLITE_LOCKED: z = "database table is locked"; break;
273 case SQLITE_NOMEM: z = "out of memory"; break;
274 case SQLITE_READONLY: z = "attempt to write a readonly database"; break;
275 case SQLITE_INTERRUPT: z = "interrupted"; break;
276 case SQLITE_IOERR: z = "disk I/O error"; break;
277 case SQLITE_CORRUPT: z = "database disk image is malformed"; break;
drh2db0bbc2005-08-11 02:10:18 +0000278 case SQLITE_FULL: z = "database or disk is full"; break;
drhc22bd472002-05-10 13:14:07 +0000279 case SQLITE_CANTOPEN: z = "unable to open database file"; break;
drhc22bd472002-05-10 13:14:07 +0000280 case SQLITE_EMPTY: z = "table contains no data"; break;
281 case SQLITE_SCHEMA: z = "database schema has changed"; break;
drh023ae032007-05-08 12:12:16 +0000282 case SQLITE_TOOBIG: z = "String or BLOB exceeded size limit"; break;
drhc22bd472002-05-10 13:14:07 +0000283 case SQLITE_CONSTRAINT: z = "constraint failed"; break;
284 case SQLITE_MISMATCH: z = "datatype mismatch"; break;
285 case SQLITE_MISUSE: z = "library routine called out of sequence";break;
drh8766c342002-11-09 00:33:15 +0000286 case SQLITE_NOLFS: z = "kernel lacks large file support"; break;
drhed6c8672003-01-12 18:02:16 +0000287 case SQLITE_AUTH: z = "authorization denied"; break;
jplyon892f6712003-06-12 08:59:00 +0000288 case SQLITE_FORMAT: z = "auxiliary database format error"; break;
drhb08153d2004-11-20 20:18:55 +0000289 case SQLITE_RANGE: z = "bind or column index out of range"; break;
drhc602f9a2004-02-12 19:01:04 +0000290 case SQLITE_NOTADB: z = "file is encrypted or is not a database";break;
drhc22bd472002-05-10 13:14:07 +0000291 default: z = "unknown error"; break;
drh247be432002-05-10 05:44:55 +0000292 }
drhc22bd472002-05-10 13:14:07 +0000293 return z;
drh247be432002-05-10 05:44:55 +0000294}
295
296/*
drh2dfbbca2000-07-28 14:32:48 +0000297** This routine implements a busy callback that sleeps and tries
298** again until a timeout value is reached. The timeout value is
299** an integer number of milliseconds passed in as the first
300** argument.
301*/
drhdaffd0e2001-04-11 14:28:42 +0000302static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +0000303 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +0000304 int count /* Number of times table has been busy */
305){
drh91c839b2006-03-03 20:54:41 +0000306#if OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +0000307 static const u8 delays[] =
308 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
309 static const u8 totals[] =
310 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhd1bec472004-01-15 13:29:31 +0000311# define NDELAY (sizeof(delays)/sizeof(delays[0]))
danielk1977b4b47412007-08-17 15:53:36 +0000312 sqlite3 *db = (sqlite3 *)ptr;
313 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +0000314 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +0000315
drhee570fa2005-04-28 12:06:05 +0000316 assert( count>=0 );
317 if( count < NDELAY ){
318 delay = delays[count];
319 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +0000320 }else{
321 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +0000322 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +0000323 }
drhd1bec472004-01-15 13:29:31 +0000324 if( prior + delay > timeout ){
325 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +0000326 if( delay<=0 ) return 0;
327 }
danielk19772a6bdf62007-08-20 16:07:00 +0000328 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +0000329 return 1;
330#else
drh482ea182007-08-20 11:12:40 +0000331 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +0000332 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +0000333 if( (count+1)*1000 > timeout ){
334 return 0;
335 }
drh482ea182007-08-20 11:12:40 +0000336 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +0000337 return 1;
338#endif
339}
340
341/*
drha4afb652005-07-09 02:16:02 +0000342** Invoke the given busy handler.
343**
344** This routine is called when an operation failed with a lock.
345** If this routine returns non-zero, the lock is retried. If it
346** returns 0, the operation aborts with an SQLITE_BUSY error.
347*/
348int sqlite3InvokeBusyHandler(BusyHandler *p){
349 int rc;
350 if( p==0 || p->xFunc==0 || p->nBusy<0 ) return 0;
351 rc = p->xFunc(p->pArg, p->nBusy);
352 if( rc==0 ){
353 p->nBusy = -1;
354 }else{
355 p->nBusy++;
356 }
357 return rc;
358}
359
360/*
drh2dfbbca2000-07-28 14:32:48 +0000361** This routine sets the busy callback for an Sqlite database to the
362** given callback function with the given argument.
363*/
danielk1977f9d64d22004-06-19 08:18:07 +0000364int sqlite3_busy_handler(
365 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +0000366 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +0000367 void *pArg
368){
drhc60d0442004-09-30 13:43:13 +0000369 if( sqlite3SafetyCheck(db) ){
370 return SQLITE_MISUSE;
371 }
drhe30f4422007-08-21 16:15:55 +0000372 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +0000373 db->busyHandler.xFunc = xBusy;
374 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +0000375 db->busyHandler.nBusy = 0;
drhe30f4422007-08-21 16:15:55 +0000376 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +0000377 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +0000378}
379
danielk1977348bb5d2003-10-18 09:37:26 +0000380#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
381/*
382** This routine sets the progress callback for an Sqlite database to the
383** given callback function with the given argument. The progress callback will
384** be invoked every nOps opcodes.
385*/
danielk197724b03fd2004-05-10 10:34:34 +0000386void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +0000387 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +0000388 int nOps,
389 int (*xProgress)(void*),
390 void *pArg
391){
drhc60d0442004-09-30 13:43:13 +0000392 if( !sqlite3SafetyCheck(db) ){
drhe30f4422007-08-21 16:15:55 +0000393 sqlite3_mutex_enter(db->mutex);
drhc60d0442004-09-30 13:43:13 +0000394 if( nOps>0 ){
395 db->xProgress = xProgress;
396 db->nProgressOps = nOps;
397 db->pProgressArg = pArg;
398 }else{
399 db->xProgress = 0;
400 db->nProgressOps = 0;
401 db->pProgressArg = 0;
402 }
drhe30f4422007-08-21 16:15:55 +0000403 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +0000404 }
405}
406#endif
407
408
drh2dfbbca2000-07-28 14:32:48 +0000409/*
410** This routine installs a default busy handler that waits for the
411** specified number of milliseconds before returning 0.
412*/
danielk1977f9d64d22004-06-19 08:18:07 +0000413int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh30867652006-07-06 10:59:57 +0000414 if( sqlite3SafetyCheck(db) ){
415 return SQLITE_MISUSE;
416 }
drh2dfbbca2000-07-28 14:32:48 +0000417 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +0000418 db->busyTimeout = ms;
419 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drh2dfbbca2000-07-28 14:32:48 +0000420 }else{
danielk197724b03fd2004-05-10 10:34:34 +0000421 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +0000422 }
danielk1977f9d64d22004-06-19 08:18:07 +0000423 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +0000424}
drh4c504392000-10-16 22:06:40 +0000425
426/*
427** Cause any pending operation to stop at its earliest opportunity.
428*/
drh9bb575f2004-09-06 17:24:11 +0000429void sqlite3_interrupt(sqlite3 *db){
drh881feaa2006-07-26 01:39:30 +0000430 if( db && (db->magic==SQLITE_MAGIC_OPEN || db->magic==SQLITE_MAGIC_BUSY) ){
431 db->u1.isInterrupted = 1;
drhc60d0442004-09-30 13:43:13 +0000432 }
drh4c504392000-10-16 22:06:40 +0000433}
drhfa86c412002-02-02 15:01:15 +0000434
drhfa86c412002-02-02 15:01:15 +0000435
436/*
danielk1977771151b2006-01-17 13:21:40 +0000437** This function is exactly the same as sqlite3_create_function(), except
438** that it is designed to be called by internal code. The difference is
439** that if a malloc() fails in sqlite3_create_function(), an error code
440** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +0000441*/
danielk1977771151b2006-01-17 13:21:40 +0000442int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +0000443 sqlite3 *db,
444 const char *zFunctionName,
445 int nArg,
danielk1977d8123362004-06-12 09:25:12 +0000446 int enc,
danielk197765904932004-05-26 06:18:37 +0000447 void *pUserData,
448 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
449 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
450 void (*xFinal)(sqlite3_context*)
drh8e0a2f92002-02-23 23:45:45 +0000451){
drh0bce8352002-02-28 00:41:10 +0000452 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +0000453 int nName;
danielk197765904932004-05-26 06:18:37 +0000454
drhe30f4422007-08-21 16:15:55 +0000455 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +0000456 if( sqlite3SafetyCheck(db) ){
457 return SQLITE_MISUSE;
458 }
459 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +0000460 (xFunc && (xFinal || xStep)) ||
461 (!xFunc && (xFinal && !xStep)) ||
462 (!xFunc && (!xFinal && xStep)) ||
463 (nArg<-1 || nArg>127) ||
464 (255<(nName = strlen(zFunctionName))) ){
drhbadf7a72006-06-14 15:35:36 +0000465 sqlite3Error(db, SQLITE_ERROR, "bad parameters");
danielk197765904932004-05-26 06:18:37 +0000466 return SQLITE_ERROR;
467 }
danielk1977d8123362004-06-12 09:25:12 +0000468
danielk197793758c82005-01-21 08:13:14 +0000469#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +0000470 /* If SQLITE_UTF16 is specified as the encoding type, transform this
471 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
472 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
473 **
474 ** If SQLITE_ANY is specified, add three versions of the function
475 ** to the hash table.
476 */
477 if( enc==SQLITE_UTF16 ){
478 enc = SQLITE_UTF16NATIVE;
479 }else if( enc==SQLITE_ANY ){
480 int rc;
danielk1977771151b2006-01-17 13:21:40 +0000481 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
danielk1977f9d64d22004-06-19 08:18:07 +0000482 pUserData, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +0000483 if( rc==SQLITE_OK ){
484 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
485 pUserData, xFunc, xStep, xFinal);
486 }
487 if( rc!=SQLITE_OK ){
488 return rc;
489 }
danielk1977d8123362004-06-12 09:25:12 +0000490 enc = SQLITE_UTF16BE;
491 }
danielk197793758c82005-01-21 08:13:14 +0000492#else
493 enc = SQLITE_UTF8;
494#endif
danielk19779636c4e2005-01-25 04:27:54 +0000495
496 /* Check if an existing function is being overridden or deleted. If so,
497 ** and there are active VMs, then return SQLITE_BUSY. If a function
498 ** is being overridden/deleted but there are no active VMs, allow the
499 ** operation to continue but invalidate all precompiled statements.
500 */
501 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, enc, 0);
502 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
503 if( db->activeVdbeCnt ){
504 sqlite3Error(db, SQLITE_BUSY,
505 "Unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +0000506 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +0000507 return SQLITE_BUSY;
508 }else{
509 sqlite3ExpirePreparedStatements(db);
510 }
511 }
danielk197765904932004-05-26 06:18:37 +0000512
danielk1977d8123362004-06-12 09:25:12 +0000513 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, enc, 1);
danielk1977fa18bec2007-09-03 11:04:22 +0000514 assert(p || db->mallocFailed);
515 if( !p ){
516 return SQLITE_NOMEM;
danielk1977771151b2006-01-17 13:21:40 +0000517 }
danielk1977fa18bec2007-09-03 11:04:22 +0000518 p->flags = 0;
519 p->xFunc = xFunc;
520 p->xStep = xStep;
521 p->xFinalize = xFinal;
522 p->pUserData = pUserData;
523 p->nArg = nArg;
danielk197765904932004-05-26 06:18:37 +0000524 return SQLITE_OK;
525}
danielk1977771151b2006-01-17 13:21:40 +0000526
527/*
528** Create new user functions.
529*/
530int sqlite3_create_function(
531 sqlite3 *db,
532 const char *zFunctionName,
533 int nArg,
534 int enc,
535 void *p,
536 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
537 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
538 void (*xFinal)(sqlite3_context*)
539){
540 int rc;
drhe30f4422007-08-21 16:15:55 +0000541 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +0000542 assert( !db->mallocFailed );
danielk1977771151b2006-01-17 13:21:40 +0000543 rc = sqlite3CreateFunc(db, zFunctionName, nArg, enc, p, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +0000544 rc = sqlite3ApiExit(db, rc);
545 sqlite3_mutex_leave(db->mutex);
546 return rc;
danielk1977771151b2006-01-17 13:21:40 +0000547}
548
danielk197793758c82005-01-21 08:13:14 +0000549#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +0000550int sqlite3_create_function16(
551 sqlite3 *db,
552 const void *zFunctionName,
553 int nArg,
554 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +0000555 void *p,
danielk197765904932004-05-26 06:18:37 +0000556 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
557 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
558 void (*xFinal)(sqlite3_context*)
559){
560 int rc;
drhaf9a7c22005-12-15 03:04:10 +0000561 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +0000562 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +0000563 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +0000564 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1);
danielk1977771151b2006-01-17 13:21:40 +0000565 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal);
drh17435752007-08-16 04:30:38 +0000566 sqlite3_free(zFunc8);
drhe30f4422007-08-21 16:15:55 +0000567 rc = sqlite3ApiExit(db, rc);
568 sqlite3_mutex_leave(db->mutex);
569 return rc;
drh8e0a2f92002-02-23 23:45:45 +0000570}
danielk197793758c82005-01-21 08:13:14 +0000571#endif
drhc9b84a12002-06-20 11:36:48 +0000572
drhb7481e72006-09-16 21:45:14 +0000573
574/*
575** Declare that a function has been overloaded by a virtual table.
576**
577** If the function already exists as a regular global function, then
578** this routine is a no-op. If the function does not exist, then create
579** a new one that always throws a run-time error.
580**
581** When virtual tables intend to provide an overloaded function, they
582** should call this routine to make sure the global function exists.
583** A global function must exist in order for name resolution to work
584** properly.
585*/
586int sqlite3_overload_function(
587 sqlite3 *db,
588 const char *zName,
589 int nArg
590){
591 int nName = strlen(zName);
drhe30f4422007-08-21 16:15:55 +0000592 int rc;
593 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +0000594 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
595 sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
596 0, sqlite3InvalidFunction, 0, 0);
597 }
drhe30f4422007-08-21 16:15:55 +0000598 rc = sqlite3ApiExit(db, SQLITE_OK);
599 sqlite3_mutex_leave(db->mutex);
600 return rc;
drhb7481e72006-09-16 21:45:14 +0000601}
602
drh19e2d372005-08-29 23:00:03 +0000603#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +0000604/*
drh18de4822003-01-16 16:28:53 +0000605** Register a trace function. The pArg from the previously registered trace
606** is returned.
607**
608** A NULL trace function means that no tracing is executes. A non-NULL
609** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +0000610** SQL statement.
drh18de4822003-01-16 16:28:53 +0000611*/
drh9bb575f2004-09-06 17:24:11 +0000612void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +0000613 void *pOld;
614 sqlite3_mutex_enter(db->mutex);
615 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +0000616 db->xTrace = xTrace;
617 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000618 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +0000619 return pOld;
drh0d1a6432003-04-03 15:46:04 +0000620}
drh19e2d372005-08-29 23:00:03 +0000621/*
622** Register a profile function. The pArg from the previously registered
623** profile function is returned.
624**
625** A NULL profile function means that no profiling is executes. A non-NULL
626** profile is a pointer to a function that is invoked at the conclusion of
627** each SQL statement that is run.
628*/
629void *sqlite3_profile(
630 sqlite3 *db,
631 void (*xProfile)(void*,const char*,sqlite_uint64),
632 void *pArg
633){
drhe30f4422007-08-21 16:15:55 +0000634 void *pOld;
635 sqlite3_mutex_enter(db->mutex);
636 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +0000637 db->xProfile = xProfile;
638 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000639 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +0000640 return pOld;
641}
642#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +0000643
drhaa940ea2004-01-15 02:44:03 +0000644/*** EXPERIMENTAL ***
645**
646** Register a function to be invoked when a transaction comments.
danielk197771fd80b2005-12-16 06:54:01 +0000647** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +0000648** rollback.
649*/
danielk197724b03fd2004-05-10 10:34:34 +0000650void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +0000651 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +0000652 int (*xCallback)(void*), /* Function to invoke on each commit */
653 void *pArg /* Argument to the function */
654){
drhe30f4422007-08-21 16:15:55 +0000655 void *pOld;
656 sqlite3_mutex_enter(db->mutex);
657 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +0000658 db->xCommitCallback = xCallback;
659 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000660 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +0000661 return pOld;
662}
663
danielk197794eb6a12005-12-15 15:22:08 +0000664/*
665** Register a callback to be invoked each time a row is updated,
666** inserted or deleted using this database connection.
667*/
danielk197771fd80b2005-12-16 06:54:01 +0000668void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +0000669 sqlite3 *db, /* Attach the hook to this database */
670 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
671 void *pArg /* Argument to the function */
672){
drhe30f4422007-08-21 16:15:55 +0000673 void *pRet;
674 sqlite3_mutex_enter(db->mutex);
675 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +0000676 db->xUpdateCallback = xCallback;
677 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000678 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +0000679 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +0000680}
681
danielk197771fd80b2005-12-16 06:54:01 +0000682/*
683** Register a callback to be invoked each time a transaction is rolled
684** back by this database connection.
685*/
686void *sqlite3_rollback_hook(
687 sqlite3 *db, /* Attach the hook to this database */
688 void (*xCallback)(void*), /* Callback function */
689 void *pArg /* Argument to the function */
690){
drhe30f4422007-08-21 16:15:55 +0000691 void *pRet;
692 sqlite3_mutex_enter(db->mutex);
693 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +0000694 db->xRollbackCallback = xCallback;
695 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000696 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +0000697 return pRet;
698}
drhaa940ea2004-01-15 02:44:03 +0000699
paulb0208cc2003-04-13 18:26:49 +0000700/*
drh13bff812003-04-15 01:19:47 +0000701** This routine is called to create a connection to a database BTree
702** driver. If zFilename is the name of a file, then that file is
703** opened and used. If zFilename is the magic name ":memory:" then
704** the database is stored in memory (and is thus forgotten as soon as
705** the connection is closed.) If zFilename is NULL then the database
drh84bfda42005-07-15 13:05:21 +0000706** is a "virtual" database for transient use only and is deleted as
707** soon as the connection is closed.
drh90f5ecb2004-07-22 01:19:35 +0000708**
drh84bfda42005-07-15 13:05:21 +0000709** A virtual database can be either a disk file (that is automatically
710** deleted when the file is closed) or it an be held entirely in memory,
drh90f5ecb2004-07-22 01:19:35 +0000711** depending on the values of the TEMP_STORE compile-time macro and the
712** db->temp_store variable, according to the following chart:
713**
714** TEMP_STORE db->temp_store Location of temporary database
715** ---------- -------------- ------------------------------
716** 0 any file
717** 1 1 file
718** 1 2 memory
719** 1 0 file
720** 2 1 file
721** 2 2 memory
722** 2 0 memory
723** 3 any memory
paulb0208cc2003-04-13 18:26:49 +0000724*/
danielk19774adee202004-05-08 08:23:19 +0000725int sqlite3BtreeFactory(
drh9bb575f2004-09-06 17:24:11 +0000726 const sqlite3 *db, /* Main database when opening aux otherwise 0 */
paulb0208cc2003-04-13 18:26:49 +0000727 const char *zFilename, /* Name of the file containing the BTree database */
728 int omitJournal, /* if TRUE then do not journal this file */
729 int nCache, /* How many pages in the page cache */
danielk19774adee202004-05-08 08:23:19 +0000730 Btree **ppBtree /* Pointer to new Btree object written here */
731){
danielk19774adee202004-05-08 08:23:19 +0000732 int btree_flags = 0;
drh90f5ecb2004-07-22 01:19:35 +0000733 int rc;
danielk19774adee202004-05-08 08:23:19 +0000734
drhe30f4422007-08-21 16:15:55 +0000735 assert( sqlite3_mutex_held(db->mutex) );
drheec983e2004-05-08 10:11:36 +0000736 assert( ppBtree != 0);
danielk19774adee202004-05-08 08:23:19 +0000737 if( omitJournal ){
738 btree_flags |= BTREE_OMIT_JOURNAL;
paulb0208cc2003-04-13 18:26:49 +0000739 }
drh7bec5052005-02-06 02:45:41 +0000740 if( db->flags & SQLITE_NoReadlock ){
741 btree_flags |= BTREE_NO_READLOCK;
742 }
drh90f5ecb2004-07-22 01:19:35 +0000743 if( zFilename==0 ){
drh90f5ecb2004-07-22 01:19:35 +0000744#if TEMP_STORE==0
drh22ac46d2004-08-14 18:34:54 +0000745 /* Do nothing */
drh90f5ecb2004-07-22 01:19:35 +0000746#endif
danielk197703aded42004-11-22 05:26:27 +0000747#ifndef SQLITE_OMIT_MEMORYDB
drh90f5ecb2004-07-22 01:19:35 +0000748#if TEMP_STORE==1
drh22ac46d2004-08-14 18:34:54 +0000749 if( db->temp_store==2 ) zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +0000750#endif
751#if TEMP_STORE==2
drh22ac46d2004-08-14 18:34:54 +0000752 if( db->temp_store!=1 ) zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +0000753#endif
754#if TEMP_STORE==3
drh22ac46d2004-08-14 18:34:54 +0000755 zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +0000756#endif
danielk197703aded42004-11-22 05:26:27 +0000757#endif /* SQLITE_OMIT_MEMORYDB */
drh90f5ecb2004-07-22 01:19:35 +0000758 }
danielk19774adee202004-05-08 08:23:19 +0000759
danielk1977da184232006-01-05 11:34:32 +0000760 rc = sqlite3BtreeOpen(zFilename, (sqlite3 *)db, ppBtree, btree_flags);
drh90f5ecb2004-07-22 01:19:35 +0000761 if( rc==SQLITE_OK ){
762 sqlite3BtreeSetBusyHandler(*ppBtree, (void*)&db->busyHandler);
763 sqlite3BtreeSetCacheSize(*ppBtree, nCache);
764 }
765 return rc;
paulb0208cc2003-04-13 18:26:49 +0000766}
danielk19774adee202004-05-08 08:23:19 +0000767
danielk19774ad17132004-05-21 01:47:26 +0000768/*
769** Return UTF-8 encoded English language explanation of the most recent
770** error.
771*/
danielk19776622cce2004-05-20 11:00:52 +0000772const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +0000773 const char *z;
danielk1977ae7fc492007-03-29 15:00:52 +0000774 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +0000775 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +0000776 }
drhc60d0442004-09-30 13:43:13 +0000777 if( sqlite3SafetyCheck(db) || db->errCode==SQLITE_MISUSE ){
danielk1977e35ee192004-06-26 09:50:11 +0000778 return sqlite3ErrStr(SQLITE_MISUSE);
779 }
drh27641702007-08-22 02:56:42 +0000780 sqlite3_mutex_enter(db->mutex);
drh86f8c192007-08-22 00:39:19 +0000781 assert( !db->mallocFailed );
drh2646da72005-12-09 20:02:05 +0000782 z = (char*)sqlite3_value_text(db->pErr);
drhc60d0442004-09-30 13:43:13 +0000783 if( z==0 ){
784 z = sqlite3ErrStr(db->errCode);
danielk19776622cce2004-05-20 11:00:52 +0000785 }
drhe30f4422007-08-21 16:15:55 +0000786 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +0000787 return z;
danielk19776622cce2004-05-20 11:00:52 +0000788}
789
drh6c626082004-11-14 21:56:29 +0000790#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +0000791/*
792** Return UTF-16 encoded English language explanation of the most recent
793** error.
794*/
danielk19776622cce2004-05-20 11:00:52 +0000795const void *sqlite3_errmsg16(sqlite3 *db){
danielk1977bfd6cce2004-06-18 04:24:54 +0000796 /* Because all the characters in the string are in the unicode
797 ** range 0x00-0xFF, if we pad the big-endian string with a
798 ** zero byte, we can obtain the little-endian string with
799 ** &big_endian[1].
800 */
drh57196282004-10-06 15:41:16 +0000801 static const char outOfMemBe[] = {
danielk1977bfd6cce2004-06-18 04:24:54 +0000802 0, 'o', 0, 'u', 0, 't', 0, ' ',
803 0, 'o', 0, 'f', 0, ' ',
804 0, 'm', 0, 'e', 0, 'm', 0, 'o', 0, 'r', 0, 'y', 0, 0, 0
805 };
drh57196282004-10-06 15:41:16 +0000806 static const char misuseBe [] = {
danielk1977e35ee192004-06-26 09:50:11 +0000807 0, 'l', 0, 'i', 0, 'b', 0, 'r', 0, 'a', 0, 'r', 0, 'y', 0, ' ',
808 0, 'r', 0, 'o', 0, 'u', 0, 't', 0, 'i', 0, 'n', 0, 'e', 0, ' ',
809 0, 'c', 0, 'a', 0, 'l', 0, 'l', 0, 'e', 0, 'd', 0, ' ',
810 0, 'o', 0, 'u', 0, 't', 0, ' ',
811 0, 'o', 0, 'f', 0, ' ',
812 0, 's', 0, 'e', 0, 'q', 0, 'u', 0, 'e', 0, 'n', 0, 'c', 0, 'e', 0, 0, 0
813 };
danielk19774ad17132004-05-21 01:47:26 +0000814
drhc60d0442004-09-30 13:43:13 +0000815 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +0000816 if( !db ){
drhc60d0442004-09-30 13:43:13 +0000817 return (void *)(&outOfMemBe[SQLITE_UTF16NATIVE==SQLITE_UTF16LE?1:0]);
818 }
819 if( sqlite3SafetyCheck(db) || db->errCode==SQLITE_MISUSE ){
820 return (void *)(&misuseBe[SQLITE_UTF16NATIVE==SQLITE_UTF16LE?1:0]);
821 }
drhe30f4422007-08-21 16:15:55 +0000822 sqlite3_mutex_enter(db->mutex);
823 assert( !db->mallocFailed );
drhc60d0442004-09-30 13:43:13 +0000824 z = sqlite3_value_text16(db->pErr);
825 if( z==0 ){
drhb21c8cd2007-08-21 19:33:56 +0000826 sqlite3ValueSetStr(db->pErr, -1, sqlite3ErrStr(db->errCode),
drhc60d0442004-09-30 13:43:13 +0000827 SQLITE_UTF8, SQLITE_STATIC);
828 z = sqlite3_value_text16(db->pErr);
829 }
danielk197754f01982006-01-18 15:25:17 +0000830 sqlite3ApiExit(0, 0);
drhe30f4422007-08-21 16:15:55 +0000831 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +0000832 return z;
danielk19776622cce2004-05-20 11:00:52 +0000833}
drh6c626082004-11-14 21:56:29 +0000834#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +0000835
drhc60d0442004-09-30 13:43:13 +0000836/*
danielk19777ddad962005-12-12 06:53:03 +0000837** Return the most recent error code generated by an SQLite routine. If NULL is
838** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +0000839*/
danielk19776622cce2004-05-20 11:00:52 +0000840int sqlite3_errcode(sqlite3 *db){
drh17435752007-08-16 04:30:38 +0000841 if( !db || db->mallocFailed ){
drhc60d0442004-09-30 13:43:13 +0000842 return SQLITE_NOMEM;
843 }
844 if( sqlite3SafetyCheck(db) ){
845 return SQLITE_MISUSE;
846 }
drh4ac285a2006-09-15 07:28:50 +0000847 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +0000848}
849
drh0e819f92006-02-01 13:50:41 +0000850/*
851** Create a new collating function for database "db". The name is zName
852** and the encoding is enc.
853*/
danielk19779a30cf62006-01-18 04:26:07 +0000854static int createCollation(
855 sqlite3* db,
856 const char *zName,
857 int enc,
858 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +0000859 int(*xCompare)(void*,int,const void*,int,const void*),
860 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +0000861){
862 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +0000863 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +0000864
865 if( sqlite3SafetyCheck(db) ){
866 return SQLITE_MISUSE;
867 }
drhe30f4422007-08-21 16:15:55 +0000868 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +0000869
870 /* If SQLITE_UTF16 is specified as the encoding type, transform this
871 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
872 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
873 */
drh7d9bd4e2006-02-16 18:16:36 +0000874 enc2 = enc & ~SQLITE_UTF16_ALIGNED;
875 if( enc2==SQLITE_UTF16 ){
876 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +0000877 }
878
drh7d9bd4e2006-02-16 18:16:36 +0000879 if( (enc2&~3)!=0 ){
880 sqlite3Error(db, SQLITE_ERROR, "unknown encoding");
danielk19779a30cf62006-01-18 04:26:07 +0000881 return SQLITE_ERROR;
882 }
883
884 /* Check if this call is removing or replacing an existing collation
885 ** sequence. If so, and there are active VMs, return busy. If there
886 ** are no active VMs, invalidate any pre-compiled statements.
887 */
drh7d9bd4e2006-02-16 18:16:36 +0000888 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, strlen(zName), 0);
danielk19779a30cf62006-01-18 04:26:07 +0000889 if( pColl && pColl->xCmp ){
890 if( db->activeVdbeCnt ){
891 sqlite3Error(db, SQLITE_BUSY,
892 "Unable to delete/modify collation sequence due to active statements");
893 return SQLITE_BUSY;
894 }
895 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +0000896
897 /* If collation sequence pColl was created directly by a call to
898 ** sqlite3_create_collation, and not generated by synthCollSeq(),
899 ** then any copies made by synthCollSeq() need to be invalidated.
900 ** Also, collation destructor - CollSeq.xDel() - function may need
901 ** to be called.
902 */
903 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
904 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, strlen(zName));
905 int j;
906 for(j=0; j<3; j++){
907 CollSeq *p = &aColl[j];
908 if( p->enc==pColl->enc ){
909 if( p->xDel ){
910 p->xDel(p->pUser);
911 }
912 p->xCmp = 0;
913 }
914 }
915 }
danielk19779a30cf62006-01-18 04:26:07 +0000916 }
917
drh7d9bd4e2006-02-16 18:16:36 +0000918 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, strlen(zName), 1);
danielk19779a30cf62006-01-18 04:26:07 +0000919 if( pColl ){
920 pColl->xCmp = xCompare;
921 pColl->pUser = pCtx;
danielk1977a9808b32007-05-07 09:32:45 +0000922 pColl->xDel = xDel;
drh7d9bd4e2006-02-16 18:16:36 +0000923 pColl->enc = enc2 | (enc & SQLITE_UTF16_ALIGNED);
danielk19779a30cf62006-01-18 04:26:07 +0000924 }
925 sqlite3Error(db, SQLITE_OK, 0);
926 return SQLITE_OK;
927}
928
929
danielk19776622cce2004-05-20 11:00:52 +0000930/*
danielk19774ad17132004-05-21 01:47:26 +0000931** This routine does the work of opening a database on behalf of
932** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +0000933** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +0000934*/
935static int openDatabase(
936 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +0000937 sqlite3 **ppDb, /* OUT: Returned database handle */
938 unsigned flags, /* Operational flags */
939 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +0000940){
941 sqlite3 *db;
danielk1977da184232006-01-05 11:34:32 +0000942 int rc;
drhd64fe2f2005-08-28 17:00:23 +0000943 CollSeq *pColl;
danielk19774ad17132004-05-21 01:47:26 +0000944
945 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +0000946 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +0000947 if( db==0 ) goto opendb_out;
drh605264d2007-08-21 15:13:19 +0000948 db->mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_RECURSIVE);
949 if( db->mutex==0 ){
drh153c62c2007-08-24 03:51:33 +0000950 sqlite3_free(db);
951 db = 0;
drh605264d2007-08-21 15:13:19 +0000952 goto opendb_out;
953 }
drh27641702007-08-22 02:56:42 +0000954 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +0000955 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +0000956 db->priorNewRowid = 0;
danielk19774ad17132004-05-21 01:47:26 +0000957 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +0000958 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +0000959 db->aDb = db->aDbStatic;
danielk19771d850a72004-05-31 08:26:49 +0000960 db->autoCommit = 1;
drh76fe8032006-07-11 14:17:51 +0000961 db->flags |= SQLITE_ShortColNames
962#if SQLITE_DEFAULT_FILE_FORMAT<4
963 | SQLITE_LegacyFileFmt
964#endif
drh56424db2007-03-27 22:24:11 +0000965#ifdef SQLITE_ENABLE_LOAD_EXTENSION
966 | SQLITE_LoadExtension
967#endif
drh76fe8032006-07-11 14:17:51 +0000968 ;
drhf9b596e2004-05-26 16:54:42 +0000969 sqlite3HashInit(&db->aFunc, SQLITE_HASH_STRING, 0);
danielk19774ad17132004-05-21 01:47:26 +0000970 sqlite3HashInit(&db->aCollSeq, SQLITE_HASH_STRING, 0);
drhb9bb7c12006-06-11 23:41:55 +0000971#ifndef SQLITE_OMIT_VIRTUALTABLE
972 sqlite3HashInit(&db->aModule, SQLITE_HASH_STRING, 0);
973#endif
danielk1977da184232006-01-05 11:34:32 +0000974
danielk197795c8a542007-09-01 06:51:27 +0000975 db->pVfs = sqlite3_vfs_find(zVfs);
976 if( !db->pVfs ){
977 rc = SQLITE_ERROR;
978 db->magic = SQLITE_MAGIC_CLOSED;
979 sqlite3Error(db, rc, "no such vfs: %s", (zVfs?zVfs:"(null)"));
980 goto opendb_out;
981 }
982
danielk19770202b292004-06-09 09:55:16 +0000983 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
984 ** and UTF-16, so add a version for each to avoid any unnecessary
985 ** conversions. The only error that can occur here is a malloc() failure.
986 */
danielk1977a9808b32007-05-07 09:32:45 +0000987 if( createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0) ||
988 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0) ||
989 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0) ||
danielk197714db2662006-01-09 16:12:04 +0000990 (db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 6, 0))==0
danielk19777ddad962005-12-12 06:53:03 +0000991 ){
drh17435752007-08-16 04:30:38 +0000992 assert( db->mallocFailed );
danielk19770202b292004-06-09 09:55:16 +0000993 db->magic = SQLITE_MAGIC_CLOSED;
994 goto opendb_out;
995 }
996
997 /* Also add a UTF-8 case-insensitive collation sequence. */
danielk1977a9808b32007-05-07 09:32:45 +0000998 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
danielk19770202b292004-06-09 09:55:16 +0000999
drhd64fe2f2005-08-28 17:00:23 +00001000 /* Set flags on the built-in collating sequences */
1001 db->pDfltColl->type = SQLITE_COLL_BINARY;
1002 pColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "NOCASE", 6, 0);
1003 if( pColl ){
1004 pColl->type = SQLITE_COLL_NOCASE;
1005 }
1006
danielk19774ad17132004-05-21 01:47:26 +00001007 /* Open the backend database driver */
drhc797d4d2007-05-08 01:08:49 +00001008 rc = sqlite3BtreeFactory(db, zFilename, 0, SQLITE_DEFAULT_CACHE_SIZE,
1009 &db->aDb[0].pBt);
danielk19774ad17132004-05-21 01:47:26 +00001010 if( rc!=SQLITE_OK ){
danielk19774ad17132004-05-21 01:47:26 +00001011 sqlite3Error(db, rc, 0);
1012 db->magic = SQLITE_MAGIC_CLOSED;
1013 goto opendb_out;
1014 }
drh17435752007-08-16 04:30:38 +00001015 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
1016 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00001017
drh03b808a2006-03-13 15:06:05 +00001018
danielk197753c0f742005-03-29 03:10:59 +00001019 /* The default safety_level for the main database is 'full'; for the temp
1020 ** database it is 'NONE'. This matches the pager layer defaults.
1021 */
1022 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00001023 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00001024#ifndef SQLITE_OMIT_TEMPDB
1025 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00001026 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00001027#endif
1028
danielk1977832a58a2007-06-22 15:21:15 +00001029 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00001030 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00001031 goto opendb_out;
1032 }
1033
danielk19778e227872004-06-07 07:52:17 +00001034 /* Register all built-in functions, but do not attempt to read the
1035 ** database schema yet. This is delayed until the first time the database
1036 ** is accessed.
1037 */
danielk1977832a58a2007-06-22 15:21:15 +00001038 sqlite3Error(db, SQLITE_OK, 0);
1039 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00001040
drh1409be62006-08-23 20:07:20 +00001041 /* Load automatic extensions - extensions that have been registered
1042 ** using the sqlite3_automatic_extension() API.
1043 */
drhf533acc2006-12-19 18:57:11 +00001044 (void)sqlite3AutoLoadExtensions(db);
danielk1977832a58a2007-06-22 15:21:15 +00001045 if( sqlite3_errcode(db)!=SQLITE_OK ){
1046 goto opendb_out;
1047 }
drh1409be62006-08-23 20:07:20 +00001048
drhaa29c132006-09-02 13:58:06 +00001049#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00001050 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00001051 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001052 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00001053 }
1054#endif
1055
shessa26cf572006-10-19 20:27:58 +00001056#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00001057 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00001058 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001059 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00001060 }
1061#endif
1062
shess69c4ae22007-08-20 17:37:47 +00001063#ifdef SQLITE_ENABLE_FTS3
1064 if( !db->mallocFailed && rc==SQLITE_OK ){
1065 extern int sqlite3Fts3Init(sqlite3*);
1066 rc = sqlite3Fts3Init(db);
1067 }
1068#endif
1069
danielk197783852ac2007-05-06 16:04:11 +00001070#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00001071 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk197783852ac2007-05-06 16:04:11 +00001072 extern int sqlite3IcuInit(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001073 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00001074 }
1075#endif
danielk1977832a58a2007-06-22 15:21:15 +00001076 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00001077
drh8fd5bd32007-04-02 16:40:37 +00001078 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
1079 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
1080 ** mode. Doing nothing at all also makes NORMAL the default.
1081 */
1082#ifdef SQLITE_DEFAULT_LOCKING_MODE
1083 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
1084 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
1085 SQLITE_DEFAULT_LOCKING_MODE);
1086#endif
1087
danielk19774ad17132004-05-21 01:47:26 +00001088opendb_out:
drh153c62c2007-08-24 03:51:33 +00001089 if( db && db->mutex ){
drhf3a65f72007-08-22 20:18:21 +00001090 sqlite3_mutex_leave(db->mutex);
1091 }
danielk19777ddad962005-12-12 06:53:03 +00001092 if( SQLITE_NOMEM==(rc = sqlite3_errcode(db)) ){
1093 sqlite3_close(db);
1094 db = 0;
danielk197713073932004-06-30 11:54:06 +00001095 }
danielk19774ad17132004-05-21 01:47:26 +00001096 *ppDb = db;
danielk197754f01982006-01-18 15:25:17 +00001097 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00001098}
1099
1100/*
1101** Open a new database handle.
1102*/
danielk197780290862004-05-22 09:21:21 +00001103int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00001104 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00001105 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00001106){
drh605264d2007-08-21 15:13:19 +00001107 return openDatabase(zFilename, ppDb,
1108 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
1109}
1110int sqlite3_open_v2(
drh428e2822007-08-30 16:23:19 +00001111 const char *filename, /* Database filename (UTF-8) */
drh605264d2007-08-21 15:13:19 +00001112 sqlite3 **ppDb, /* OUT: SQLite db handle */
1113 int flags, /* Flags */
1114 const char *zVfs /* Name of VFS module to use */
1115){
1116 return openDatabase(filename, ppDb, flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00001117}
1118
drh6c626082004-11-14 21:56:29 +00001119#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001120/*
1121** Open a new database handle.
1122*/
1123int sqlite3_open16(
1124 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00001125 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00001126){
danielk1977bfd6cce2004-06-18 04:24:54 +00001127 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00001128 sqlite3_value *pVal;
danielk19771e536952007-08-16 10:09:01 +00001129 int rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00001130
danielk19777ddad962005-12-12 06:53:03 +00001131 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00001132 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00001133 *ppDb = 0;
danielk19771e536952007-08-16 10:09:01 +00001134 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00001135 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
1136 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00001137 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00001138 rc = openDatabase(zFilename8, ppDb,
1139 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
danielk1977bfd6cce2004-06-18 04:24:54 +00001140 if( rc==SQLITE_OK && *ppDb ){
drh7dd90a42005-12-06 13:19:07 +00001141 rc = sqlite3_exec(*ppDb, "PRAGMA encoding = 'UTF-16'", 0, 0, 0);
danielk1977950f0542006-01-18 05:51:57 +00001142 if( rc!=SQLITE_OK ){
1143 sqlite3_close(*ppDb);
1144 *ppDb = 0;
1145 }
danielk1977bfd6cce2004-06-18 04:24:54 +00001146 }
danielk19774ad17132004-05-21 01:47:26 +00001147 }
danielk19777ddad962005-12-12 06:53:03 +00001148 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00001149
danielk197754f01982006-01-18 15:25:17 +00001150 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00001151}
drh6c626082004-11-14 21:56:29 +00001152#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00001153
danielk1977106bb232004-05-21 10:08:53 +00001154/*
danielk1977d8123362004-06-12 09:25:12 +00001155** Register a new collation sequence with the database handle db.
1156*/
danielk19770202b292004-06-09 09:55:16 +00001157int sqlite3_create_collation(
1158 sqlite3* db,
1159 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00001160 int enc,
danielk19770202b292004-06-09 09:55:16 +00001161 void* pCtx,
1162 int(*xCompare)(void*,int,const void*,int,const void*)
1163){
danielk19779a30cf62006-01-18 04:26:07 +00001164 int rc;
drhe30f4422007-08-21 16:15:55 +00001165 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001166 assert( !db->mallocFailed );
danielk1977a9808b32007-05-07 09:32:45 +00001167 rc = createCollation(db, zName, enc, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00001168 rc = sqlite3ApiExit(db, rc);
1169 sqlite3_mutex_leave(db->mutex);
1170 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00001171}
1172
1173/*
1174** Register a new collation sequence with the database handle db.
1175*/
danielk1977a393c032007-05-07 14:58:53 +00001176int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00001177 sqlite3* db,
1178 const char *zName,
1179 int enc,
1180 void* pCtx,
1181 int(*xCompare)(void*,int,const void*,int,const void*),
1182 void(*xDel)(void*)
1183){
1184 int rc;
drhe30f4422007-08-21 16:15:55 +00001185 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001186 assert( !db->mallocFailed );
danielk1977a9808b32007-05-07 09:32:45 +00001187 rc = createCollation(db, zName, enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00001188 rc = sqlite3ApiExit(db, rc);
1189 sqlite3_mutex_leave(db->mutex);
1190 return rc;
danielk19770202b292004-06-09 09:55:16 +00001191}
1192
drh6c626082004-11-14 21:56:29 +00001193#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001194/*
1195** Register a new collation sequence with the database handle db.
1196*/
danielk19770202b292004-06-09 09:55:16 +00001197int sqlite3_create_collation16(
1198 sqlite3* db,
1199 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00001200 int enc,
danielk19770202b292004-06-09 09:55:16 +00001201 void* pCtx,
1202 int(*xCompare)(void*,int,const void*,int,const void*)
1203){
danielk19779a30cf62006-01-18 04:26:07 +00001204 int rc = SQLITE_OK;
1205 char *zName8;
drhe30f4422007-08-21 16:15:55 +00001206 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001207 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +00001208 zName8 = sqlite3Utf16to8(db, zName, -1);
danielk19779a30cf62006-01-18 04:26:07 +00001209 if( zName8 ){
danielk1977a9808b32007-05-07 09:32:45 +00001210 rc = createCollation(db, zName8, enc, pCtx, xCompare, 0);
drh17435752007-08-16 04:30:38 +00001211 sqlite3_free(zName8);
danielk19779a30cf62006-01-18 04:26:07 +00001212 }
drhe30f4422007-08-21 16:15:55 +00001213 rc = sqlite3ApiExit(db, rc);
1214 sqlite3_mutex_leave(db->mutex);
1215 return rc;
danielk19770202b292004-06-09 09:55:16 +00001216}
drh6c626082004-11-14 21:56:29 +00001217#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00001218
danielk1977d8123362004-06-12 09:25:12 +00001219/*
1220** Register a collation sequence factory callback with the database handle
1221** db. Replace any previously installed collation sequence factory.
1222*/
danielk19777cedc8d2004-06-10 10:50:08 +00001223int sqlite3_collation_needed(
1224 sqlite3 *db,
1225 void *pCollNeededArg,
1226 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
1227){
drhc60d0442004-09-30 13:43:13 +00001228 if( sqlite3SafetyCheck(db) ){
1229 return SQLITE_MISUSE;
1230 }
drhe30f4422007-08-21 16:15:55 +00001231 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001232 db->xCollNeeded = xCollNeeded;
1233 db->xCollNeeded16 = 0;
1234 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00001235 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001236 return SQLITE_OK;
1237}
danielk1977d8123362004-06-12 09:25:12 +00001238
drh6c626082004-11-14 21:56:29 +00001239#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001240/*
1241** Register a collation sequence factory callback with the database handle
1242** db. Replace any previously installed collation sequence factory.
1243*/
danielk19777cedc8d2004-06-10 10:50:08 +00001244int sqlite3_collation_needed16(
1245 sqlite3 *db,
1246 void *pCollNeededArg,
1247 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
1248){
drhc60d0442004-09-30 13:43:13 +00001249 if( sqlite3SafetyCheck(db) ){
1250 return SQLITE_MISUSE;
1251 }
drhe30f4422007-08-21 16:15:55 +00001252 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001253 db->xCollNeeded = 0;
1254 db->xCollNeeded16 = xCollNeeded16;
1255 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00001256 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001257 return SQLITE_OK;
1258}
drh6c626082004-11-14 21:56:29 +00001259#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00001260
1261#ifndef SQLITE_OMIT_GLOBALRECOVER
1262/*
danielk19777ddad962005-12-12 06:53:03 +00001263** This function is now an anachronism. It used to be used to recover from a
1264** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00001265*/
1266int sqlite3_global_recover(){
danielk1977261919c2005-12-06 12:52:59 +00001267 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00001268}
1269#endif
drh3e1d8e62005-05-26 16:23:34 +00001270
1271/*
1272** Test to see whether or not the database connection is in autocommit
1273** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
1274** by default. Autocommit is disabled by a BEGIN statement and reenabled
1275** by the next COMMIT or ROLLBACK.
1276**
1277******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
1278*/
1279int sqlite3_get_autocommit(sqlite3 *db){
1280 return db->autoCommit;
1281}
drh49285702005-09-17 15:20:26 +00001282
1283#ifdef SQLITE_DEBUG
1284/*
1285** The following routine is subtituted for constant SQLITE_CORRUPT in
1286** debugging builds. This provides a way to set a breakpoint for when
1287** corruption is first detected.
1288*/
1289int sqlite3Corrupt(void){
1290 return SQLITE_CORRUPT;
1291}
1292#endif
drh7c1817e2006-01-10 13:58:48 +00001293
drh6f7adc82006-01-11 21:41:20 +00001294/*
1295** This is a convenience routine that makes sure that all thread-specific
1296** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00001297**
1298** SQLite no longer uses thread-specific data so this routine is now a
1299** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00001300*/
1301void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00001302}
danielk1977deb802c2006-02-09 13:43:28 +00001303
1304/*
1305** Return meta information about a specific column of a database table.
1306** See comment in sqlite3.h (sqlite.h.in) for details.
1307*/
1308#ifdef SQLITE_ENABLE_COLUMN_METADATA
1309int sqlite3_table_column_metadata(
1310 sqlite3 *db, /* Connection handle */
1311 const char *zDbName, /* Database name or NULL */
1312 const char *zTableName, /* Table name */
1313 const char *zColumnName, /* Column name */
1314 char const **pzDataType, /* OUTPUT: Declared data type */
1315 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
1316 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
1317 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
1318 int *pAutoinc /* OUTPUT: True if colums is auto-increment */
1319){
1320 int rc;
1321 char *zErrMsg = 0;
1322 Table *pTab = 0;
1323 Column *pCol = 0;
1324 int iCol;
1325
1326 char const *zDataType = 0;
1327 char const *zCollSeq = 0;
1328 int notnull = 0;
1329 int primarykey = 0;
1330 int autoinc = 0;
1331
1332 /* Ensure the database schema has been loaded */
1333 if( sqlite3SafetyOn(db) ){
1334 return SQLITE_MISUSE;
1335 }
drhe30f4422007-08-21 16:15:55 +00001336 sqlite3_mutex_enter(db->mutex);
danielk1977deb802c2006-02-09 13:43:28 +00001337 rc = sqlite3Init(db, &zErrMsg);
1338 if( SQLITE_OK!=rc ){
1339 goto error_out;
1340 }
1341
1342 /* Locate the table in question */
1343 pTab = sqlite3FindTable(db, zTableName, zDbName);
1344 if( !pTab || pTab->pSelect ){
1345 pTab = 0;
1346 goto error_out;
1347 }
1348
1349 /* Find the column for which info is requested */
1350 if( sqlite3IsRowid(zColumnName) ){
1351 iCol = pTab->iPKey;
1352 if( iCol>=0 ){
1353 pCol = &pTab->aCol[iCol];
1354 }
1355 }else{
1356 for(iCol=0; iCol<pTab->nCol; iCol++){
1357 pCol = &pTab->aCol[iCol];
1358 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
1359 break;
1360 }
1361 }
1362 if( iCol==pTab->nCol ){
1363 pTab = 0;
1364 goto error_out;
1365 }
1366 }
1367
1368 /* The following block stores the meta information that will be returned
1369 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
1370 ** and autoinc. At this point there are two possibilities:
1371 **
1372 ** 1. The specified column name was rowid", "oid" or "_rowid_"
1373 ** and there is no explicitly declared IPK column.
1374 **
1375 ** 2. The table is not a view and the column name identified an
1376 ** explicitly declared column. Copy meta information from *pCol.
1377 */
1378 if( pCol ){
1379 zDataType = pCol->zType;
1380 zCollSeq = pCol->zColl;
1381 notnull = (pCol->notNull?1:0);
1382 primarykey = (pCol->isPrimKey?1:0);
1383 autoinc = ((pTab->iPKey==iCol && pTab->autoInc)?1:0);
1384 }else{
1385 zDataType = "INTEGER";
1386 primarykey = 1;
1387 }
1388 if( !zCollSeq ){
1389 zCollSeq = "BINARY";
1390 }
1391
1392error_out:
1393 if( sqlite3SafetyOff(db) ){
1394 rc = SQLITE_MISUSE;
1395 }
1396
1397 /* Whether the function call succeeded or failed, set the output parameters
1398 ** to whatever their local counterparts contain. If an error did occur,
1399 ** this has the effect of zeroing all output parameters.
1400 */
1401 if( pzDataType ) *pzDataType = zDataType;
1402 if( pzCollSeq ) *pzCollSeq = zCollSeq;
1403 if( pNotNull ) *pNotNull = notnull;
1404 if( pPrimaryKey ) *pPrimaryKey = primarykey;
1405 if( pAutoinc ) *pAutoinc = autoinc;
1406
1407 if( SQLITE_OK==rc && !pTab ){
1408 sqlite3SetString(&zErrMsg, "no such table column: ", zTableName, ".",
1409 zColumnName, 0);
1410 rc = SQLITE_ERROR;
1411 }
1412 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh17435752007-08-16 04:30:38 +00001413 sqlite3_free(zErrMsg);
drhe30f4422007-08-21 16:15:55 +00001414 rc = sqlite3ApiExit(db, rc);
1415 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00001416 return rc;
1417}
drhe30f4422007-08-21 16:15:55 +00001418#endif
drhf9cb7f52006-06-27 20:06:44 +00001419
1420/*
1421** Sleep for a little while. Return the amount of time slept.
1422*/
1423int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00001424 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00001425 int rc;
drhd677b3d2007-08-20 22:48:41 +00001426 pVfs = sqlite3_vfs_find(0);
danielk1977fee2d252007-08-18 10:59:19 +00001427
1428 /* This function works in milliseconds, but the underlying OsSleep()
1429 ** API uses microseconds. Hence the 1000's.
1430 */
drhe30f4422007-08-21 16:15:55 +00001431 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00001432 return rc;
drhf9cb7f52006-06-27 20:06:44 +00001433}
drh4ac285a2006-09-15 07:28:50 +00001434
1435/*
1436** Enable or disable the extended result codes.
1437*/
1438int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00001439 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001440 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00001441 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001442 return SQLITE_OK;
1443}
drhcc6bb3e2007-08-31 16:11:35 +00001444
1445/*
1446** Invoke the xFileControl method on a particular database.
1447*/
1448int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
1449 int rc = SQLITE_ERROR;
1450 int iDb;
1451 sqlite3_mutex_enter(db->mutex);
1452 if( zDbName==0 ){
1453 iDb = 0;
1454 }else{
1455 for(iDb=0; iDb<db->nDb; iDb++){
1456 if( strcmp(db->aDb[iDb].zName, zDbName)==0 ) break;
1457 }
1458 }
1459 if( iDb<db->nDb ){
1460 Btree *pBtree = db->aDb[iDb].pBt;
1461 if( pBtree ){
1462 Pager *pPager;
1463 sqlite3BtreeEnter(pBtree);
1464 pPager = sqlite3BtreePager(pBtree);
1465 if( pPager ){
1466 sqlite3_file *fd = sqlite3PagerFile(pPager);
1467 if( fd ){
1468 rc = sqlite3OsFileControl(fd, op, pArg);
1469 }
1470 }
1471 sqlite3BtreeLeave(pBtree);
1472 }
1473 }
1474 sqlite3_mutex_leave(db->mutex);
1475 return rc;
1476}