blob: 4054e2fc8a23426bd6f413c2ebd55125ddfa40e7 [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**
drh1cc8c442007-08-24 16:08:29 +000017** $Id: main.c,v 1.398 2007/08/24 16:08:29 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");
drh27641702007-08-22 02:56:42 +0000145 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000146 return SQLITE_BUSY;
147 }
148 assert( !sqlite3SafetyCheck(db) );
danielk1977e0048402004-06-15 16:51:01 +0000149
150 /* FIX ME: db->magic may be set to SQLITE_MAGIC_CLOSED if the database
151 ** cannot be opened for some reason. So this routine needs to run in
152 ** that case. But maybe there should be an extra magic value for the
153 ** "failed to open" state.
danielk1977b5584c02007-03-30 07:10:50 +0000154 **
155 ** TODO: Coverage tests do not test the case where this condition is
156 ** true. It's hard to see how to cause it without messing with threads.
danielk1977e0048402004-06-15 16:51:01 +0000157 */
danielk197796d81f92004-06-19 03:33:57 +0000158 if( db->magic!=SQLITE_MAGIC_CLOSED && sqlite3SafetyOn(db) ){
drh94e92032003-02-16 22:21:32 +0000159 /* printf("DID NOT CLOSE\n"); fflush(stdout); */
drh27641702007-08-22 02:56:42 +0000160 sqlite3_mutex_leave(db->mutex);
danielk197796d81f92004-06-19 03:33:57 +0000161 return SQLITE_ERROR;
drh94e92032003-02-16 22:21:32 +0000162 }
danielk1977e0048402004-06-15 16:51:01 +0000163
drh001bbcb2003-03-19 03:14:00 +0000164 for(j=0; j<db->nDb; j++){
drh4d189ca2004-02-12 18:46:38 +0000165 struct Db *pDb = &db->aDb[j];
166 if( pDb->pBt ){
danielk19774adee202004-05-08 08:23:19 +0000167 sqlite3BtreeClose(pDb->pBt);
drh4d189ca2004-02-12 18:46:38 +0000168 pDb->pBt = 0;
danielk1977311019b2006-01-10 07:14:23 +0000169 if( j!=1 ){
170 pDb->pSchema = 0;
171 }
drh113088e2003-03-20 01:16:58 +0000172 }
drhf57b3392001-10-08 13:22:32 +0000173 }
danielk19774adee202004-05-08 08:23:19 +0000174 sqlite3ResetInternalSchema(db, 0);
drh1c2d8412003-03-31 00:30:47 +0000175 assert( db->nDb<=2 );
176 assert( db->aDb==db->aDbStatic );
drh0bce8352002-02-28 00:41:10 +0000177 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
178 FuncDef *pFunc, *pNext;
179 for(pFunc = (FuncDef*)sqliteHashData(i); pFunc; pFunc=pNext){
drh8e0a2f92002-02-23 23:45:45 +0000180 pNext = pFunc->pNext;
drh17435752007-08-16 04:30:38 +0000181 sqlite3_free(pFunc);
drh8e0a2f92002-02-23 23:45:45 +0000182 }
183 }
danielk1977466be562004-06-10 02:16:01 +0000184
danielk1977d8123362004-06-12 09:25:12 +0000185 for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
danielk1977466be562004-06-10 02:16:01 +0000186 CollSeq *pColl = (CollSeq *)sqliteHashData(i);
danielk1977a9808b32007-05-07 09:32:45 +0000187 /* Invoke any destructors registered for collation sequence user data. */
188 for(j=0; j<3; j++){
189 if( pColl[j].xDel ){
190 pColl[j].xDel(pColl[j].pUser);
191 }
192 }
drh17435752007-08-16 04:30:38 +0000193 sqlite3_free(pColl);
danielk1977466be562004-06-10 02:16:01 +0000194 }
danielk1977d8123362004-06-12 09:25:12 +0000195 sqlite3HashClear(&db->aCollSeq);
drhb9bb7c12006-06-11 23:41:55 +0000196#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk1977d1ab1ba2006-06-15 04:28:13 +0000197 for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
198 Module *pMod = (Module *)sqliteHashData(i);
danielk1977832a58a2007-06-22 15:21:15 +0000199 if( pMod->xDestroy ){
200 pMod->xDestroy(pMod->pAux);
201 }
drh17435752007-08-16 04:30:38 +0000202 sqlite3_free(pMod);
danielk1977d1ab1ba2006-06-15 04:28:13 +0000203 }
drhb9bb7c12006-06-11 23:41:55 +0000204 sqlite3HashClear(&db->aModule);
205#endif
danielk1977466be562004-06-10 02:16:01 +0000206
danielk19774adee202004-05-08 08:23:19 +0000207 sqlite3HashClear(&db->aFunc);
danielk19776622cce2004-05-20 11:00:52 +0000208 sqlite3Error(db, SQLITE_OK, 0); /* Deallocates any cached error strings. */
danielk1977bfd6cce2004-06-18 04:24:54 +0000209 if( db->pErr ){
210 sqlite3ValueFree(db->pErr);
211 }
drhf1952c52006-06-08 15:48:00 +0000212 sqlite3CloseExtensions(db);
danielk197796d81f92004-06-19 03:33:57 +0000213
214 db->magic = SQLITE_MAGIC_ERROR;
danielk1977311019b2006-01-10 07:14:23 +0000215
216 /* The temp-database schema is allocated differently from the other schema
217 ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
218 ** So it needs to be freed here. Todo: Why not roll the temp schema into
219 ** the same sqliteMalloc() as the one that allocates the database
220 ** structure?
221 */
drh17435752007-08-16 04:30:38 +0000222 sqlite3_free(db->aDb[1].pSchema);
drh605264d2007-08-21 15:13:19 +0000223 sqlite3_mutex_leave(db->mutex);
224 sqlite3_mutex_free(db->mutex);
drh17435752007-08-16 04:30:38 +0000225 sqlite3_free(db);
danielk197796d81f92004-06-19 03:33:57 +0000226 return SQLITE_OK;
drh75897232000-05-29 14:26:00 +0000227}
228
229/*
drh001bbcb2003-03-19 03:14:00 +0000230** Rollback all database files.
231*/
drh9bb575f2004-09-06 17:24:11 +0000232void sqlite3RollbackAll(sqlite3 *db){
drh001bbcb2003-03-19 03:14:00 +0000233 int i;
danielk1977f3f06bb2005-12-16 15:24:28 +0000234 int inTrans = 0;
drhe30f4422007-08-21 16:15:55 +0000235 assert( sqlite3_mutex_held(db->mutex) );
drh001bbcb2003-03-19 03:14:00 +0000236 for(i=0; i<db->nDb; i++){
237 if( db->aDb[i].pBt ){
danielk1977f3f06bb2005-12-16 15:24:28 +0000238 if( sqlite3BtreeIsInTrans(db->aDb[i].pBt) ){
239 inTrans = 1;
240 }
danielk19774adee202004-05-08 08:23:19 +0000241 sqlite3BtreeRollback(db->aDb[i].pBt);
drh001bbcb2003-03-19 03:14:00 +0000242 db->aDb[i].inTrans = 0;
243 }
244 }
danielk1977a298e902006-06-22 09:53:48 +0000245 sqlite3VtabRollback(db);
danielk197771fd80b2005-12-16 06:54:01 +0000246 if( db->flags&SQLITE_InternChanges ){
danielk1977ea4d9e22007-08-13 15:28:33 +0000247 sqlite3ExpirePreparedStatements(db);
danielk197771fd80b2005-12-16 06:54:01 +0000248 sqlite3ResetInternalSchema(db, 0);
249 }
250
251 /* If one has been configured, invoke the rollback-hook callback */
danielk1977f3f06bb2005-12-16 15:24:28 +0000252 if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
danielk197771fd80b2005-12-16 06:54:01 +0000253 db->xRollbackCallback(db->pRollbackArg);
254 }
drh001bbcb2003-03-19 03:14:00 +0000255}
256
257/*
drhc22bd472002-05-10 13:14:07 +0000258** Return a static string that describes the kind of error specified in the
259** argument.
drh247be432002-05-10 05:44:55 +0000260*/
danielk1977f20b21c2004-05-31 23:56:42 +0000261const char *sqlite3ErrStr(int rc){
drhc22bd472002-05-10 13:14:07 +0000262 const char *z;
drh4ac285a2006-09-15 07:28:50 +0000263 switch( rc & 0xff ){
drhc60d0442004-09-30 13:43:13 +0000264 case SQLITE_ROW:
265 case SQLITE_DONE:
drhc22bd472002-05-10 13:14:07 +0000266 case SQLITE_OK: z = "not an error"; break;
267 case SQLITE_ERROR: z = "SQL logic error or missing database"; break;
drhc22bd472002-05-10 13:14:07 +0000268 case SQLITE_PERM: z = "access permission denied"; break;
269 case SQLITE_ABORT: z = "callback requested query abort"; break;
270 case SQLITE_BUSY: z = "database is locked"; break;
271 case SQLITE_LOCKED: z = "database table is locked"; break;
272 case SQLITE_NOMEM: z = "out of memory"; break;
273 case SQLITE_READONLY: z = "attempt to write a readonly database"; break;
274 case SQLITE_INTERRUPT: z = "interrupted"; break;
275 case SQLITE_IOERR: z = "disk I/O error"; break;
276 case SQLITE_CORRUPT: z = "database disk image is malformed"; break;
drh2db0bbc2005-08-11 02:10:18 +0000277 case SQLITE_FULL: z = "database or disk is full"; break;
drhc22bd472002-05-10 13:14:07 +0000278 case SQLITE_CANTOPEN: z = "unable to open database file"; break;
drhc22bd472002-05-10 13:14:07 +0000279 case SQLITE_EMPTY: z = "table contains no data"; break;
280 case SQLITE_SCHEMA: z = "database schema has changed"; break;
drh023ae032007-05-08 12:12:16 +0000281 case SQLITE_TOOBIG: z = "String or BLOB exceeded size limit"; break;
drhc22bd472002-05-10 13:14:07 +0000282 case SQLITE_CONSTRAINT: z = "constraint failed"; break;
283 case SQLITE_MISMATCH: z = "datatype mismatch"; break;
284 case SQLITE_MISUSE: z = "library routine called out of sequence";break;
drh8766c342002-11-09 00:33:15 +0000285 case SQLITE_NOLFS: z = "kernel lacks large file support"; break;
drhed6c8672003-01-12 18:02:16 +0000286 case SQLITE_AUTH: z = "authorization denied"; break;
jplyon892f6712003-06-12 08:59:00 +0000287 case SQLITE_FORMAT: z = "auxiliary database format error"; break;
drhb08153d2004-11-20 20:18:55 +0000288 case SQLITE_RANGE: z = "bind or column index out of range"; break;
drhc602f9a2004-02-12 19:01:04 +0000289 case SQLITE_NOTADB: z = "file is encrypted or is not a database";break;
drhc22bd472002-05-10 13:14:07 +0000290 default: z = "unknown error"; break;
drh247be432002-05-10 05:44:55 +0000291 }
drhc22bd472002-05-10 13:14:07 +0000292 return z;
drh247be432002-05-10 05:44:55 +0000293}
294
295/*
drh2dfbbca2000-07-28 14:32:48 +0000296** This routine implements a busy callback that sleeps and tries
297** again until a timeout value is reached. The timeout value is
298** an integer number of milliseconds passed in as the first
299** argument.
300*/
drhdaffd0e2001-04-11 14:28:42 +0000301static int sqliteDefaultBusyCallback(
drh97903fe2005-05-24 20:19:57 +0000302 void *ptr, /* Database connection */
drh2dfbbca2000-07-28 14:32:48 +0000303 int count /* Number of times table has been busy */
304){
drh91c839b2006-03-03 20:54:41 +0000305#if OS_WIN || (defined(HAVE_USLEEP) && HAVE_USLEEP)
drhee570fa2005-04-28 12:06:05 +0000306 static const u8 delays[] =
307 { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
308 static const u8 totals[] =
309 { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
drhd1bec472004-01-15 13:29:31 +0000310# define NDELAY (sizeof(delays)/sizeof(delays[0]))
danielk1977b4b47412007-08-17 15:53:36 +0000311 sqlite3 *db = (sqlite3 *)ptr;
312 int timeout = db->busyTimeout;
drh97903fe2005-05-24 20:19:57 +0000313 int delay, prior;
drh2dfbbca2000-07-28 14:32:48 +0000314
drhee570fa2005-04-28 12:06:05 +0000315 assert( count>=0 );
316 if( count < NDELAY ){
317 delay = delays[count];
318 prior = totals[count];
drhd1bec472004-01-15 13:29:31 +0000319 }else{
320 delay = delays[NDELAY-1];
drh68cb6192005-05-06 22:05:56 +0000321 prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
drh2dfbbca2000-07-28 14:32:48 +0000322 }
drhd1bec472004-01-15 13:29:31 +0000323 if( prior + delay > timeout ){
324 delay = timeout - prior;
drh2dfbbca2000-07-28 14:32:48 +0000325 if( delay<=0 ) return 0;
326 }
danielk19772a6bdf62007-08-20 16:07:00 +0000327 sqlite3OsSleep(db->pVfs, delay*1000);
drh2dfbbca2000-07-28 14:32:48 +0000328 return 1;
329#else
drh482ea182007-08-20 11:12:40 +0000330 sqlite3 *db = (sqlite3 *)ptr;
drh3f737082005-06-14 02:24:31 +0000331 int timeout = ((sqlite3 *)ptr)->busyTimeout;
drh2dfbbca2000-07-28 14:32:48 +0000332 if( (count+1)*1000 > timeout ){
333 return 0;
334 }
drh482ea182007-08-20 11:12:40 +0000335 sqlite3OsSleep(db->pVfs, 1000000);
drh2dfbbca2000-07-28 14:32:48 +0000336 return 1;
337#endif
338}
339
340/*
drha4afb652005-07-09 02:16:02 +0000341** Invoke the given busy handler.
342**
343** This routine is called when an operation failed with a lock.
344** If this routine returns non-zero, the lock is retried. If it
345** returns 0, the operation aborts with an SQLITE_BUSY error.
346*/
347int sqlite3InvokeBusyHandler(BusyHandler *p){
348 int rc;
349 if( p==0 || p->xFunc==0 || p->nBusy<0 ) return 0;
350 rc = p->xFunc(p->pArg, p->nBusy);
351 if( rc==0 ){
352 p->nBusy = -1;
353 }else{
354 p->nBusy++;
355 }
356 return rc;
357}
358
359/*
drh2dfbbca2000-07-28 14:32:48 +0000360** This routine sets the busy callback for an Sqlite database to the
361** given callback function with the given argument.
362*/
danielk1977f9d64d22004-06-19 08:18:07 +0000363int sqlite3_busy_handler(
364 sqlite3 *db,
danielk19772a764eb2004-06-12 01:43:26 +0000365 int (*xBusy)(void*,int),
drh2dfbbca2000-07-28 14:32:48 +0000366 void *pArg
367){
drhc60d0442004-09-30 13:43:13 +0000368 if( sqlite3SafetyCheck(db) ){
369 return SQLITE_MISUSE;
370 }
drhe30f4422007-08-21 16:15:55 +0000371 sqlite3_mutex_enter(db->mutex);
danielk197724162fe2004-06-04 06:22:00 +0000372 db->busyHandler.xFunc = xBusy;
373 db->busyHandler.pArg = pArg;
drha4afb652005-07-09 02:16:02 +0000374 db->busyHandler.nBusy = 0;
drhe30f4422007-08-21 16:15:55 +0000375 sqlite3_mutex_leave(db->mutex);
danielk1977f9d64d22004-06-19 08:18:07 +0000376 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +0000377}
378
danielk1977348bb5d2003-10-18 09:37:26 +0000379#ifndef SQLITE_OMIT_PROGRESS_CALLBACK
380/*
381** This routine sets the progress callback for an Sqlite database to the
382** given callback function with the given argument. The progress callback will
383** be invoked every nOps opcodes.
384*/
danielk197724b03fd2004-05-10 10:34:34 +0000385void sqlite3_progress_handler(
drh9bb575f2004-09-06 17:24:11 +0000386 sqlite3 *db,
danielk1977348bb5d2003-10-18 09:37:26 +0000387 int nOps,
388 int (*xProgress)(void*),
389 void *pArg
390){
drhc60d0442004-09-30 13:43:13 +0000391 if( !sqlite3SafetyCheck(db) ){
drhe30f4422007-08-21 16:15:55 +0000392 sqlite3_mutex_enter(db->mutex);
drhc60d0442004-09-30 13:43:13 +0000393 if( nOps>0 ){
394 db->xProgress = xProgress;
395 db->nProgressOps = nOps;
396 db->pProgressArg = pArg;
397 }else{
398 db->xProgress = 0;
399 db->nProgressOps = 0;
400 db->pProgressArg = 0;
401 }
drhe30f4422007-08-21 16:15:55 +0000402 sqlite3_mutex_leave(db->mutex);
danielk1977348bb5d2003-10-18 09:37:26 +0000403 }
404}
405#endif
406
407
drh2dfbbca2000-07-28 14:32:48 +0000408/*
409** This routine installs a default busy handler that waits for the
410** specified number of milliseconds before returning 0.
411*/
danielk1977f9d64d22004-06-19 08:18:07 +0000412int sqlite3_busy_timeout(sqlite3 *db, int ms){
drh30867652006-07-06 10:59:57 +0000413 if( sqlite3SafetyCheck(db) ){
414 return SQLITE_MISUSE;
415 }
drh2dfbbca2000-07-28 14:32:48 +0000416 if( ms>0 ){
drh97903fe2005-05-24 20:19:57 +0000417 db->busyTimeout = ms;
418 sqlite3_busy_handler(db, sqliteDefaultBusyCallback, (void*)db);
drh2dfbbca2000-07-28 14:32:48 +0000419 }else{
danielk197724b03fd2004-05-10 10:34:34 +0000420 sqlite3_busy_handler(db, 0, 0);
drh2dfbbca2000-07-28 14:32:48 +0000421 }
danielk1977f9d64d22004-06-19 08:18:07 +0000422 return SQLITE_OK;
drh2dfbbca2000-07-28 14:32:48 +0000423}
drh4c504392000-10-16 22:06:40 +0000424
425/*
426** Cause any pending operation to stop at its earliest opportunity.
427*/
drh9bb575f2004-09-06 17:24:11 +0000428void sqlite3_interrupt(sqlite3 *db){
drh881feaa2006-07-26 01:39:30 +0000429 if( db && (db->magic==SQLITE_MAGIC_OPEN || db->magic==SQLITE_MAGIC_BUSY) ){
430 db->u1.isInterrupted = 1;
drhc60d0442004-09-30 13:43:13 +0000431 }
drh4c504392000-10-16 22:06:40 +0000432}
drhfa86c412002-02-02 15:01:15 +0000433
drhfa86c412002-02-02 15:01:15 +0000434
435/*
danielk1977771151b2006-01-17 13:21:40 +0000436** This function is exactly the same as sqlite3_create_function(), except
437** that it is designed to be called by internal code. The difference is
438** that if a malloc() fails in sqlite3_create_function(), an error code
439** is returned and the mallocFailed flag cleared.
drhfa86c412002-02-02 15:01:15 +0000440*/
danielk1977771151b2006-01-17 13:21:40 +0000441int sqlite3CreateFunc(
danielk197765904932004-05-26 06:18:37 +0000442 sqlite3 *db,
443 const char *zFunctionName,
444 int nArg,
danielk1977d8123362004-06-12 09:25:12 +0000445 int enc,
danielk197765904932004-05-26 06:18:37 +0000446 void *pUserData,
447 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
448 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
449 void (*xFinal)(sqlite3_context*)
drh8e0a2f92002-02-23 23:45:45 +0000450){
drh0bce8352002-02-28 00:41:10 +0000451 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +0000452 int nName;
danielk197765904932004-05-26 06:18:37 +0000453
drhe30f4422007-08-21 16:15:55 +0000454 assert( sqlite3_mutex_held(db->mutex) );
drhc60d0442004-09-30 13:43:13 +0000455 if( sqlite3SafetyCheck(db) ){
456 return SQLITE_MISUSE;
457 }
458 if( zFunctionName==0 ||
danielk1977398eae72004-05-26 06:58:43 +0000459 (xFunc && (xFinal || xStep)) ||
460 (!xFunc && (xFinal && !xStep)) ||
461 (!xFunc && (!xFinal && xStep)) ||
462 (nArg<-1 || nArg>127) ||
463 (255<(nName = strlen(zFunctionName))) ){
drhbadf7a72006-06-14 15:35:36 +0000464 sqlite3Error(db, SQLITE_ERROR, "bad parameters");
danielk197765904932004-05-26 06:18:37 +0000465 return SQLITE_ERROR;
466 }
danielk1977d8123362004-06-12 09:25:12 +0000467
danielk197793758c82005-01-21 08:13:14 +0000468#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +0000469 /* If SQLITE_UTF16 is specified as the encoding type, transform this
470 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
471 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
472 **
473 ** If SQLITE_ANY is specified, add three versions of the function
474 ** to the hash table.
475 */
476 if( enc==SQLITE_UTF16 ){
477 enc = SQLITE_UTF16NATIVE;
478 }else if( enc==SQLITE_ANY ){
479 int rc;
danielk1977771151b2006-01-17 13:21:40 +0000480 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8,
danielk1977f9d64d22004-06-19 08:18:07 +0000481 pUserData, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +0000482 if( rc==SQLITE_OK ){
483 rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE,
484 pUserData, xFunc, xStep, xFinal);
485 }
486 if( rc!=SQLITE_OK ){
487 return rc;
488 }
danielk1977d8123362004-06-12 09:25:12 +0000489 enc = SQLITE_UTF16BE;
490 }
danielk197793758c82005-01-21 08:13:14 +0000491#else
492 enc = SQLITE_UTF8;
493#endif
danielk19779636c4e2005-01-25 04:27:54 +0000494
495 /* Check if an existing function is being overridden or deleted. If so,
496 ** and there are active VMs, then return SQLITE_BUSY. If a function
497 ** is being overridden/deleted but there are no active VMs, allow the
498 ** operation to continue but invalidate all precompiled statements.
499 */
500 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, enc, 0);
501 if( p && p->iPrefEnc==enc && p->nArg==nArg ){
502 if( db->activeVdbeCnt ){
503 sqlite3Error(db, SQLITE_BUSY,
504 "Unable to delete/modify user-function due to active statements");
drh17435752007-08-16 04:30:38 +0000505 assert( !db->mallocFailed );
danielk19779636c4e2005-01-25 04:27:54 +0000506 return SQLITE_BUSY;
507 }else{
508 sqlite3ExpirePreparedStatements(db);
509 }
510 }
danielk197765904932004-05-26 06:18:37 +0000511
danielk1977d8123362004-06-12 09:25:12 +0000512 p = sqlite3FindFunction(db, zFunctionName, nName, nArg, enc, 1);
danielk1977771151b2006-01-17 13:21:40 +0000513 if( p ){
514 p->flags = 0;
515 p->xFunc = xFunc;
516 p->xStep = xStep;
517 p->xFinalize = xFinal;
518 p->pUserData = pUserData;
danielk197765fd59f2006-06-24 11:51:33 +0000519 p->nArg = nArg;
danielk1977771151b2006-01-17 13:21:40 +0000520 }
danielk197765904932004-05-26 06:18:37 +0000521 return SQLITE_OK;
522}
danielk1977771151b2006-01-17 13:21:40 +0000523
524/*
525** Create new user functions.
526*/
527int sqlite3_create_function(
528 sqlite3 *db,
529 const char *zFunctionName,
530 int nArg,
531 int enc,
532 void *p,
533 void (*xFunc)(sqlite3_context*,int,sqlite3_value **),
534 void (*xStep)(sqlite3_context*,int,sqlite3_value **),
535 void (*xFinal)(sqlite3_context*)
536){
537 int rc;
drhe30f4422007-08-21 16:15:55 +0000538 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +0000539 assert( !db->mallocFailed );
danielk1977771151b2006-01-17 13:21:40 +0000540 rc = sqlite3CreateFunc(db, zFunctionName, nArg, enc, p, xFunc, xStep, xFinal);
drhe30f4422007-08-21 16:15:55 +0000541 rc = sqlite3ApiExit(db, rc);
542 sqlite3_mutex_leave(db->mutex);
543 return rc;
danielk1977771151b2006-01-17 13:21:40 +0000544}
545
danielk197793758c82005-01-21 08:13:14 +0000546#ifndef SQLITE_OMIT_UTF16
danielk197765904932004-05-26 06:18:37 +0000547int sqlite3_create_function16(
548 sqlite3 *db,
549 const void *zFunctionName,
550 int nArg,
551 int eTextRep,
danielk1977771151b2006-01-17 13:21:40 +0000552 void *p,
danielk197765904932004-05-26 06:18:37 +0000553 void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
554 void (*xStep)(sqlite3_context*,int,sqlite3_value**),
555 void (*xFinal)(sqlite3_context*)
556){
557 int rc;
drhaf9a7c22005-12-15 03:04:10 +0000558 char *zFunc8;
drhe30f4422007-08-21 16:15:55 +0000559 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +0000560 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +0000561 zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1);
danielk1977771151b2006-01-17 13:21:40 +0000562 rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xFunc, xStep, xFinal);
drh17435752007-08-16 04:30:38 +0000563 sqlite3_free(zFunc8);
drhe30f4422007-08-21 16:15:55 +0000564 rc = sqlite3ApiExit(db, rc);
565 sqlite3_mutex_leave(db->mutex);
566 return rc;
drh8e0a2f92002-02-23 23:45:45 +0000567}
danielk197793758c82005-01-21 08:13:14 +0000568#endif
drhc9b84a12002-06-20 11:36:48 +0000569
drhb7481e72006-09-16 21:45:14 +0000570
571/*
572** Declare that a function has been overloaded by a virtual table.
573**
574** If the function already exists as a regular global function, then
575** this routine is a no-op. If the function does not exist, then create
576** a new one that always throws a run-time error.
577**
578** When virtual tables intend to provide an overloaded function, they
579** should call this routine to make sure the global function exists.
580** A global function must exist in order for name resolution to work
581** properly.
582*/
583int sqlite3_overload_function(
584 sqlite3 *db,
585 const char *zName,
586 int nArg
587){
588 int nName = strlen(zName);
drhe30f4422007-08-21 16:15:55 +0000589 int rc;
590 sqlite3_mutex_enter(db->mutex);
drhb7481e72006-09-16 21:45:14 +0000591 if( sqlite3FindFunction(db, zName, nName, nArg, SQLITE_UTF8, 0)==0 ){
592 sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
593 0, sqlite3InvalidFunction, 0, 0);
594 }
drhe30f4422007-08-21 16:15:55 +0000595 rc = sqlite3ApiExit(db, SQLITE_OK);
596 sqlite3_mutex_leave(db->mutex);
597 return rc;
drhb7481e72006-09-16 21:45:14 +0000598}
599
drh19e2d372005-08-29 23:00:03 +0000600#ifndef SQLITE_OMIT_TRACE
drhc9b84a12002-06-20 11:36:48 +0000601/*
drh18de4822003-01-16 16:28:53 +0000602** Register a trace function. The pArg from the previously registered trace
603** is returned.
604**
605** A NULL trace function means that no tracing is executes. A non-NULL
606** trace is a pointer to a function that is invoked at the start of each
drh19e2d372005-08-29 23:00:03 +0000607** SQL statement.
drh18de4822003-01-16 16:28:53 +0000608*/
drh9bb575f2004-09-06 17:24:11 +0000609void *sqlite3_trace(sqlite3 *db, void (*xTrace)(void*,const char*), void *pArg){
drhe30f4422007-08-21 16:15:55 +0000610 void *pOld;
611 sqlite3_mutex_enter(db->mutex);
612 pOld = db->pTraceArg;
drh18de4822003-01-16 16:28:53 +0000613 db->xTrace = xTrace;
614 db->pTraceArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000615 sqlite3_mutex_leave(db->mutex);
drh18de4822003-01-16 16:28:53 +0000616 return pOld;
drh0d1a6432003-04-03 15:46:04 +0000617}
drh19e2d372005-08-29 23:00:03 +0000618/*
619** Register a profile function. The pArg from the previously registered
620** profile function is returned.
621**
622** A NULL profile function means that no profiling is executes. A non-NULL
623** profile is a pointer to a function that is invoked at the conclusion of
624** each SQL statement that is run.
625*/
626void *sqlite3_profile(
627 sqlite3 *db,
628 void (*xProfile)(void*,const char*,sqlite_uint64),
629 void *pArg
630){
drhe30f4422007-08-21 16:15:55 +0000631 void *pOld;
632 sqlite3_mutex_enter(db->mutex);
633 pOld = db->pProfileArg;
drh19e2d372005-08-29 23:00:03 +0000634 db->xProfile = xProfile;
635 db->pProfileArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000636 sqlite3_mutex_leave(db->mutex);
drh19e2d372005-08-29 23:00:03 +0000637 return pOld;
638}
639#endif /* SQLITE_OMIT_TRACE */
paulb0208cc2003-04-13 18:26:49 +0000640
drhaa940ea2004-01-15 02:44:03 +0000641/*** EXPERIMENTAL ***
642**
643** Register a function to be invoked when a transaction comments.
danielk197771fd80b2005-12-16 06:54:01 +0000644** If the invoked function returns non-zero, then the commit becomes a
drhaa940ea2004-01-15 02:44:03 +0000645** rollback.
646*/
danielk197724b03fd2004-05-10 10:34:34 +0000647void *sqlite3_commit_hook(
drh9bb575f2004-09-06 17:24:11 +0000648 sqlite3 *db, /* Attach the hook to this database */
drhaa940ea2004-01-15 02:44:03 +0000649 int (*xCallback)(void*), /* Function to invoke on each commit */
650 void *pArg /* Argument to the function */
651){
drhe30f4422007-08-21 16:15:55 +0000652 void *pOld;
653 sqlite3_mutex_enter(db->mutex);
654 pOld = db->pCommitArg;
drhaa940ea2004-01-15 02:44:03 +0000655 db->xCommitCallback = xCallback;
656 db->pCommitArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000657 sqlite3_mutex_leave(db->mutex);
drhaa940ea2004-01-15 02:44:03 +0000658 return pOld;
659}
660
danielk197794eb6a12005-12-15 15:22:08 +0000661/*
662** Register a callback to be invoked each time a row is updated,
663** inserted or deleted using this database connection.
664*/
danielk197771fd80b2005-12-16 06:54:01 +0000665void *sqlite3_update_hook(
danielk197794eb6a12005-12-15 15:22:08 +0000666 sqlite3 *db, /* Attach the hook to this database */
667 void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
668 void *pArg /* Argument to the function */
669){
drhe30f4422007-08-21 16:15:55 +0000670 void *pRet;
671 sqlite3_mutex_enter(db->mutex);
672 pRet = db->pUpdateArg;
danielk197794eb6a12005-12-15 15:22:08 +0000673 db->xUpdateCallback = xCallback;
674 db->pUpdateArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000675 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +0000676 return pRet;
danielk197794eb6a12005-12-15 15:22:08 +0000677}
678
danielk197771fd80b2005-12-16 06:54:01 +0000679/*
680** Register a callback to be invoked each time a transaction is rolled
681** back by this database connection.
682*/
683void *sqlite3_rollback_hook(
684 sqlite3 *db, /* Attach the hook to this database */
685 void (*xCallback)(void*), /* Callback function */
686 void *pArg /* Argument to the function */
687){
drhe30f4422007-08-21 16:15:55 +0000688 void *pRet;
689 sqlite3_mutex_enter(db->mutex);
690 pRet = db->pRollbackArg;
danielk197771fd80b2005-12-16 06:54:01 +0000691 db->xRollbackCallback = xCallback;
692 db->pRollbackArg = pArg;
drhe30f4422007-08-21 16:15:55 +0000693 sqlite3_mutex_leave(db->mutex);
danielk197771fd80b2005-12-16 06:54:01 +0000694 return pRet;
695}
drhaa940ea2004-01-15 02:44:03 +0000696
paulb0208cc2003-04-13 18:26:49 +0000697/*
drh13bff812003-04-15 01:19:47 +0000698** This routine is called to create a connection to a database BTree
699** driver. If zFilename is the name of a file, then that file is
700** opened and used. If zFilename is the magic name ":memory:" then
701** the database is stored in memory (and is thus forgotten as soon as
702** the connection is closed.) If zFilename is NULL then the database
drh84bfda42005-07-15 13:05:21 +0000703** is a "virtual" database for transient use only and is deleted as
704** soon as the connection is closed.
drh90f5ecb2004-07-22 01:19:35 +0000705**
drh84bfda42005-07-15 13:05:21 +0000706** A virtual database can be either a disk file (that is automatically
707** deleted when the file is closed) or it an be held entirely in memory,
drh90f5ecb2004-07-22 01:19:35 +0000708** depending on the values of the TEMP_STORE compile-time macro and the
709** db->temp_store variable, according to the following chart:
710**
711** TEMP_STORE db->temp_store Location of temporary database
712** ---------- -------------- ------------------------------
713** 0 any file
714** 1 1 file
715** 1 2 memory
716** 1 0 file
717** 2 1 file
718** 2 2 memory
719** 2 0 memory
720** 3 any memory
paulb0208cc2003-04-13 18:26:49 +0000721*/
danielk19774adee202004-05-08 08:23:19 +0000722int sqlite3BtreeFactory(
drh9bb575f2004-09-06 17:24:11 +0000723 const sqlite3 *db, /* Main database when opening aux otherwise 0 */
paulb0208cc2003-04-13 18:26:49 +0000724 const char *zFilename, /* Name of the file containing the BTree database */
725 int omitJournal, /* if TRUE then do not journal this file */
726 int nCache, /* How many pages in the page cache */
danielk19774adee202004-05-08 08:23:19 +0000727 Btree **ppBtree /* Pointer to new Btree object written here */
728){
danielk19774adee202004-05-08 08:23:19 +0000729 int btree_flags = 0;
drh90f5ecb2004-07-22 01:19:35 +0000730 int rc;
danielk19774adee202004-05-08 08:23:19 +0000731
drhe30f4422007-08-21 16:15:55 +0000732 assert( sqlite3_mutex_held(db->mutex) );
drheec983e2004-05-08 10:11:36 +0000733 assert( ppBtree != 0);
danielk19774adee202004-05-08 08:23:19 +0000734 if( omitJournal ){
735 btree_flags |= BTREE_OMIT_JOURNAL;
paulb0208cc2003-04-13 18:26:49 +0000736 }
drh7bec5052005-02-06 02:45:41 +0000737 if( db->flags & SQLITE_NoReadlock ){
738 btree_flags |= BTREE_NO_READLOCK;
739 }
drh90f5ecb2004-07-22 01:19:35 +0000740 if( zFilename==0 ){
drh90f5ecb2004-07-22 01:19:35 +0000741#if TEMP_STORE==0
drh22ac46d2004-08-14 18:34:54 +0000742 /* Do nothing */
drh90f5ecb2004-07-22 01:19:35 +0000743#endif
danielk197703aded42004-11-22 05:26:27 +0000744#ifndef SQLITE_OMIT_MEMORYDB
drh90f5ecb2004-07-22 01:19:35 +0000745#if TEMP_STORE==1
drh22ac46d2004-08-14 18:34:54 +0000746 if( db->temp_store==2 ) zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +0000747#endif
748#if TEMP_STORE==2
drh22ac46d2004-08-14 18:34:54 +0000749 if( db->temp_store!=1 ) zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +0000750#endif
751#if TEMP_STORE==3
drh22ac46d2004-08-14 18:34:54 +0000752 zFilename = ":memory:";
drh90f5ecb2004-07-22 01:19:35 +0000753#endif
danielk197703aded42004-11-22 05:26:27 +0000754#endif /* SQLITE_OMIT_MEMORYDB */
drh90f5ecb2004-07-22 01:19:35 +0000755 }
danielk19774adee202004-05-08 08:23:19 +0000756
danielk1977da184232006-01-05 11:34:32 +0000757 rc = sqlite3BtreeOpen(zFilename, (sqlite3 *)db, ppBtree, btree_flags);
drh90f5ecb2004-07-22 01:19:35 +0000758 if( rc==SQLITE_OK ){
759 sqlite3BtreeSetBusyHandler(*ppBtree, (void*)&db->busyHandler);
760 sqlite3BtreeSetCacheSize(*ppBtree, nCache);
761 }
762 return rc;
paulb0208cc2003-04-13 18:26:49 +0000763}
danielk19774adee202004-05-08 08:23:19 +0000764
danielk19774ad17132004-05-21 01:47:26 +0000765/*
766** Return UTF-8 encoded English language explanation of the most recent
767** error.
768*/
danielk19776622cce2004-05-20 11:00:52 +0000769const char *sqlite3_errmsg(sqlite3 *db){
drhc60d0442004-09-30 13:43:13 +0000770 const char *z;
danielk1977ae7fc492007-03-29 15:00:52 +0000771 if( !db ){
danielk1977f20b21c2004-05-31 23:56:42 +0000772 return sqlite3ErrStr(SQLITE_NOMEM);
danielk19774ad17132004-05-21 01:47:26 +0000773 }
drhc60d0442004-09-30 13:43:13 +0000774 if( sqlite3SafetyCheck(db) || db->errCode==SQLITE_MISUSE ){
danielk1977e35ee192004-06-26 09:50:11 +0000775 return sqlite3ErrStr(SQLITE_MISUSE);
776 }
drh27641702007-08-22 02:56:42 +0000777 sqlite3_mutex_enter(db->mutex);
drh86f8c192007-08-22 00:39:19 +0000778 assert( !db->mallocFailed );
drh2646da72005-12-09 20:02:05 +0000779 z = (char*)sqlite3_value_text(db->pErr);
drhc60d0442004-09-30 13:43:13 +0000780 if( z==0 ){
781 z = sqlite3ErrStr(db->errCode);
danielk19776622cce2004-05-20 11:00:52 +0000782 }
drhe30f4422007-08-21 16:15:55 +0000783 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +0000784 return z;
danielk19776622cce2004-05-20 11:00:52 +0000785}
786
drh6c626082004-11-14 21:56:29 +0000787#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +0000788/*
789** Return UTF-16 encoded English language explanation of the most recent
790** error.
791*/
danielk19776622cce2004-05-20 11:00:52 +0000792const void *sqlite3_errmsg16(sqlite3 *db){
danielk1977bfd6cce2004-06-18 04:24:54 +0000793 /* Because all the characters in the string are in the unicode
794 ** range 0x00-0xFF, if we pad the big-endian string with a
795 ** zero byte, we can obtain the little-endian string with
796 ** &big_endian[1].
797 */
drh57196282004-10-06 15:41:16 +0000798 static const char outOfMemBe[] = {
danielk1977bfd6cce2004-06-18 04:24:54 +0000799 0, 'o', 0, 'u', 0, 't', 0, ' ',
800 0, 'o', 0, 'f', 0, ' ',
801 0, 'm', 0, 'e', 0, 'm', 0, 'o', 0, 'r', 0, 'y', 0, 0, 0
802 };
drh57196282004-10-06 15:41:16 +0000803 static const char misuseBe [] = {
danielk1977e35ee192004-06-26 09:50:11 +0000804 0, 'l', 0, 'i', 0, 'b', 0, 'r', 0, 'a', 0, 'r', 0, 'y', 0, ' ',
805 0, 'r', 0, 'o', 0, 'u', 0, 't', 0, 'i', 0, 'n', 0, 'e', 0, ' ',
806 0, 'c', 0, 'a', 0, 'l', 0, 'l', 0, 'e', 0, 'd', 0, ' ',
807 0, 'o', 0, 'u', 0, 't', 0, ' ',
808 0, 'o', 0, 'f', 0, ' ',
809 0, 's', 0, 'e', 0, 'q', 0, 'u', 0, 'e', 0, 'n', 0, 'c', 0, 'e', 0, 0, 0
810 };
danielk19774ad17132004-05-21 01:47:26 +0000811
drhc60d0442004-09-30 13:43:13 +0000812 const void *z;
danielk1977ae7fc492007-03-29 15:00:52 +0000813 if( !db ){
drhc60d0442004-09-30 13:43:13 +0000814 return (void *)(&outOfMemBe[SQLITE_UTF16NATIVE==SQLITE_UTF16LE?1:0]);
815 }
816 if( sqlite3SafetyCheck(db) || db->errCode==SQLITE_MISUSE ){
817 return (void *)(&misuseBe[SQLITE_UTF16NATIVE==SQLITE_UTF16LE?1:0]);
818 }
drhe30f4422007-08-21 16:15:55 +0000819 sqlite3_mutex_enter(db->mutex);
820 assert( !db->mallocFailed );
drhc60d0442004-09-30 13:43:13 +0000821 z = sqlite3_value_text16(db->pErr);
822 if( z==0 ){
drhb21c8cd2007-08-21 19:33:56 +0000823 sqlite3ValueSetStr(db->pErr, -1, sqlite3ErrStr(db->errCode),
drhc60d0442004-09-30 13:43:13 +0000824 SQLITE_UTF8, SQLITE_STATIC);
825 z = sqlite3_value_text16(db->pErr);
826 }
danielk197754f01982006-01-18 15:25:17 +0000827 sqlite3ApiExit(0, 0);
drhe30f4422007-08-21 16:15:55 +0000828 sqlite3_mutex_leave(db->mutex);
drhc60d0442004-09-30 13:43:13 +0000829 return z;
danielk19776622cce2004-05-20 11:00:52 +0000830}
drh6c626082004-11-14 21:56:29 +0000831#endif /* SQLITE_OMIT_UTF16 */
danielk19776622cce2004-05-20 11:00:52 +0000832
drhc60d0442004-09-30 13:43:13 +0000833/*
danielk19777ddad962005-12-12 06:53:03 +0000834** Return the most recent error code generated by an SQLite routine. If NULL is
835** passed to this function, we assume a malloc() failed during sqlite3_open().
drhc60d0442004-09-30 13:43:13 +0000836*/
danielk19776622cce2004-05-20 11:00:52 +0000837int sqlite3_errcode(sqlite3 *db){
drh17435752007-08-16 04:30:38 +0000838 if( !db || db->mallocFailed ){
drhc60d0442004-09-30 13:43:13 +0000839 return SQLITE_NOMEM;
840 }
841 if( sqlite3SafetyCheck(db) ){
842 return SQLITE_MISUSE;
843 }
drh4ac285a2006-09-15 07:28:50 +0000844 return db->errCode & db->errMask;
danielk19776622cce2004-05-20 11:00:52 +0000845}
846
drh0e819f92006-02-01 13:50:41 +0000847/*
848** Create a new collating function for database "db". The name is zName
849** and the encoding is enc.
850*/
danielk19779a30cf62006-01-18 04:26:07 +0000851static int createCollation(
852 sqlite3* db,
853 const char *zName,
854 int enc,
855 void* pCtx,
danielk1977a9808b32007-05-07 09:32:45 +0000856 int(*xCompare)(void*,int,const void*,int,const void*),
857 void(*xDel)(void*)
danielk19779a30cf62006-01-18 04:26:07 +0000858){
859 CollSeq *pColl;
drh7d9bd4e2006-02-16 18:16:36 +0000860 int enc2;
danielk19779a30cf62006-01-18 04:26:07 +0000861
862 if( sqlite3SafetyCheck(db) ){
863 return SQLITE_MISUSE;
864 }
drhe30f4422007-08-21 16:15:55 +0000865 assert( sqlite3_mutex_held(db->mutex) );
danielk19779a30cf62006-01-18 04:26:07 +0000866
867 /* If SQLITE_UTF16 is specified as the encoding type, transform this
868 ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
869 ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
870 */
drh7d9bd4e2006-02-16 18:16:36 +0000871 enc2 = enc & ~SQLITE_UTF16_ALIGNED;
872 if( enc2==SQLITE_UTF16 ){
873 enc2 = SQLITE_UTF16NATIVE;
danielk19779a30cf62006-01-18 04:26:07 +0000874 }
875
drh7d9bd4e2006-02-16 18:16:36 +0000876 if( (enc2&~3)!=0 ){
877 sqlite3Error(db, SQLITE_ERROR, "unknown encoding");
danielk19779a30cf62006-01-18 04:26:07 +0000878 return SQLITE_ERROR;
879 }
880
881 /* Check if this call is removing or replacing an existing collation
882 ** sequence. If so, and there are active VMs, return busy. If there
883 ** are no active VMs, invalidate any pre-compiled statements.
884 */
drh7d9bd4e2006-02-16 18:16:36 +0000885 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, strlen(zName), 0);
danielk19779a30cf62006-01-18 04:26:07 +0000886 if( pColl && pColl->xCmp ){
887 if( db->activeVdbeCnt ){
888 sqlite3Error(db, SQLITE_BUSY,
889 "Unable to delete/modify collation sequence due to active statements");
890 return SQLITE_BUSY;
891 }
892 sqlite3ExpirePreparedStatements(db);
danielk1977a9808b32007-05-07 09:32:45 +0000893
894 /* If collation sequence pColl was created directly by a call to
895 ** sqlite3_create_collation, and not generated by synthCollSeq(),
896 ** then any copies made by synthCollSeq() need to be invalidated.
897 ** Also, collation destructor - CollSeq.xDel() - function may need
898 ** to be called.
899 */
900 if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
901 CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName, strlen(zName));
902 int j;
903 for(j=0; j<3; j++){
904 CollSeq *p = &aColl[j];
905 if( p->enc==pColl->enc ){
906 if( p->xDel ){
907 p->xDel(p->pUser);
908 }
909 p->xCmp = 0;
910 }
911 }
912 }
danielk19779a30cf62006-01-18 04:26:07 +0000913 }
914
drh7d9bd4e2006-02-16 18:16:36 +0000915 pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, strlen(zName), 1);
danielk19779a30cf62006-01-18 04:26:07 +0000916 if( pColl ){
917 pColl->xCmp = xCompare;
918 pColl->pUser = pCtx;
danielk1977a9808b32007-05-07 09:32:45 +0000919 pColl->xDel = xDel;
drh7d9bd4e2006-02-16 18:16:36 +0000920 pColl->enc = enc2 | (enc & SQLITE_UTF16_ALIGNED);
danielk19779a30cf62006-01-18 04:26:07 +0000921 }
922 sqlite3Error(db, SQLITE_OK, 0);
923 return SQLITE_OK;
924}
925
926
danielk19776622cce2004-05-20 11:00:52 +0000927/*
danielk19774ad17132004-05-21 01:47:26 +0000928** This routine does the work of opening a database on behalf of
929** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
drhee570fa2005-04-28 12:06:05 +0000930** is UTF-8 encoded.
danielk19774ad17132004-05-21 01:47:26 +0000931*/
932static int openDatabase(
933 const char *zFilename, /* Database filename UTF-8 encoded */
drh605264d2007-08-21 15:13:19 +0000934 sqlite3 **ppDb, /* OUT: Returned database handle */
935 unsigned flags, /* Operational flags */
936 const char *zVfs /* Name of the VFS to use */
danielk19774ad17132004-05-21 01:47:26 +0000937){
938 sqlite3 *db;
danielk1977da184232006-01-05 11:34:32 +0000939 int rc;
drhd64fe2f2005-08-28 17:00:23 +0000940 CollSeq *pColl;
danielk19774ad17132004-05-21 01:47:26 +0000941
942 /* Allocate the sqlite data structure */
drh17435752007-08-16 04:30:38 +0000943 db = sqlite3MallocZero( sizeof(sqlite3) );
danielk19774ad17132004-05-21 01:47:26 +0000944 if( db==0 ) goto opendb_out;
drh605264d2007-08-21 15:13:19 +0000945 db->mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_RECURSIVE);
946 if( db->mutex==0 ){
drh153c62c2007-08-24 03:51:33 +0000947 sqlite3_free(db);
948 db = 0;
drh605264d2007-08-21 15:13:19 +0000949 goto opendb_out;
950 }
drh27641702007-08-22 02:56:42 +0000951 sqlite3_mutex_enter(db->mutex);
drh605264d2007-08-21 15:13:19 +0000952 db->pVfs = sqlite3_vfs_find(zVfs);
drh4ac285a2006-09-15 07:28:50 +0000953 db->errMask = 0xff;
danielk19774ad17132004-05-21 01:47:26 +0000954 db->priorNewRowid = 0;
danielk19774ad17132004-05-21 01:47:26 +0000955 db->nDb = 2;
drh153c62c2007-08-24 03:51:33 +0000956 db->magic = SQLITE_MAGIC_BUSY;
danielk19774ad17132004-05-21 01:47:26 +0000957 db->aDb = db->aDbStatic;
danielk19771d850a72004-05-31 08:26:49 +0000958 db->autoCommit = 1;
drh76fe8032006-07-11 14:17:51 +0000959 db->flags |= SQLITE_ShortColNames
960#if SQLITE_DEFAULT_FILE_FORMAT<4
961 | SQLITE_LegacyFileFmt
962#endif
drh56424db2007-03-27 22:24:11 +0000963#ifdef SQLITE_ENABLE_LOAD_EXTENSION
964 | SQLITE_LoadExtension
965#endif
drh76fe8032006-07-11 14:17:51 +0000966 ;
drhf9b596e2004-05-26 16:54:42 +0000967 sqlite3HashInit(&db->aFunc, SQLITE_HASH_STRING, 0);
danielk19774ad17132004-05-21 01:47:26 +0000968 sqlite3HashInit(&db->aCollSeq, SQLITE_HASH_STRING, 0);
drhb9bb7c12006-06-11 23:41:55 +0000969#ifndef SQLITE_OMIT_VIRTUALTABLE
970 sqlite3HashInit(&db->aModule, SQLITE_HASH_STRING, 0);
971#endif
danielk1977da184232006-01-05 11:34:32 +0000972
danielk19770202b292004-06-09 09:55:16 +0000973 /* Add the default collation sequence BINARY. BINARY works for both UTF-8
974 ** and UTF-16, so add a version for each to avoid any unnecessary
975 ** conversions. The only error that can occur here is a malloc() failure.
976 */
danielk1977a9808b32007-05-07 09:32:45 +0000977 if( createCollation(db, "BINARY", SQLITE_UTF8, 0, binCollFunc, 0) ||
978 createCollation(db, "BINARY", SQLITE_UTF16BE, 0, binCollFunc, 0) ||
979 createCollation(db, "BINARY", SQLITE_UTF16LE, 0, binCollFunc, 0) ||
danielk197714db2662006-01-09 16:12:04 +0000980 (db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 6, 0))==0
danielk19777ddad962005-12-12 06:53:03 +0000981 ){
drh17435752007-08-16 04:30:38 +0000982 assert( db->mallocFailed );
danielk19770202b292004-06-09 09:55:16 +0000983 db->magic = SQLITE_MAGIC_CLOSED;
984 goto opendb_out;
985 }
986
987 /* Also add a UTF-8 case-insensitive collation sequence. */
danielk1977a9808b32007-05-07 09:32:45 +0000988 createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
danielk19770202b292004-06-09 09:55:16 +0000989
drhd64fe2f2005-08-28 17:00:23 +0000990 /* Set flags on the built-in collating sequences */
991 db->pDfltColl->type = SQLITE_COLL_BINARY;
992 pColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "NOCASE", 6, 0);
993 if( pColl ){
994 pColl->type = SQLITE_COLL_NOCASE;
995 }
996
danielk19774ad17132004-05-21 01:47:26 +0000997 /* Open the backend database driver */
drhc797d4d2007-05-08 01:08:49 +0000998 rc = sqlite3BtreeFactory(db, zFilename, 0, SQLITE_DEFAULT_CACHE_SIZE,
999 &db->aDb[0].pBt);
danielk19774ad17132004-05-21 01:47:26 +00001000 if( rc!=SQLITE_OK ){
danielk19774ad17132004-05-21 01:47:26 +00001001 sqlite3Error(db, rc, 0);
1002 db->magic = SQLITE_MAGIC_CLOSED;
1003 goto opendb_out;
1004 }
drh17435752007-08-16 04:30:38 +00001005 db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
1006 db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
danielk197714db2662006-01-09 16:12:04 +00001007
drh03b808a2006-03-13 15:06:05 +00001008
danielk197753c0f742005-03-29 03:10:59 +00001009 /* The default safety_level for the main database is 'full'; for the temp
1010 ** database it is 'NONE'. This matches the pager layer defaults.
1011 */
1012 db->aDb[0].zName = "main";
danielk197791cf71b2004-06-26 06:37:06 +00001013 db->aDb[0].safety_level = 3;
danielk197753c0f742005-03-29 03:10:59 +00001014#ifndef SQLITE_OMIT_TEMPDB
1015 db->aDb[1].zName = "temp";
danielk197791cf71b2004-06-26 06:37:06 +00001016 db->aDb[1].safety_level = 1;
danielk197753c0f742005-03-29 03:10:59 +00001017#endif
1018
danielk1977832a58a2007-06-22 15:21:15 +00001019 db->magic = SQLITE_MAGIC_OPEN;
drh17435752007-08-16 04:30:38 +00001020 if( db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00001021 goto opendb_out;
1022 }
1023
danielk19778e227872004-06-07 07:52:17 +00001024 /* Register all built-in functions, but do not attempt to read the
1025 ** database schema yet. This is delayed until the first time the database
1026 ** is accessed.
1027 */
danielk1977832a58a2007-06-22 15:21:15 +00001028 sqlite3Error(db, SQLITE_OK, 0);
1029 sqlite3RegisterBuiltinFunctions(db);
danielk19774ad17132004-05-21 01:47:26 +00001030
drh1409be62006-08-23 20:07:20 +00001031 /* Load automatic extensions - extensions that have been registered
1032 ** using the sqlite3_automatic_extension() API.
1033 */
drhf533acc2006-12-19 18:57:11 +00001034 (void)sqlite3AutoLoadExtensions(db);
danielk1977832a58a2007-06-22 15:21:15 +00001035 if( sqlite3_errcode(db)!=SQLITE_OK ){
1036 goto opendb_out;
1037 }
drh1409be62006-08-23 20:07:20 +00001038
drhaa29c132006-09-02 13:58:06 +00001039#ifdef SQLITE_ENABLE_FTS1
drh17435752007-08-16 04:30:38 +00001040 if( !db->mallocFailed ){
drhaa29c132006-09-02 13:58:06 +00001041 extern int sqlite3Fts1Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001042 rc = sqlite3Fts1Init(db);
drhaa29c132006-09-02 13:58:06 +00001043 }
1044#endif
1045
shessa26cf572006-10-19 20:27:58 +00001046#ifdef SQLITE_ENABLE_FTS2
drh17435752007-08-16 04:30:38 +00001047 if( !db->mallocFailed && rc==SQLITE_OK ){
shessa26cf572006-10-19 20:27:58 +00001048 extern int sqlite3Fts2Init(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001049 rc = sqlite3Fts2Init(db);
shessa26cf572006-10-19 20:27:58 +00001050 }
1051#endif
1052
shess69c4ae22007-08-20 17:37:47 +00001053#ifdef SQLITE_ENABLE_FTS3
1054 if( !db->mallocFailed && rc==SQLITE_OK ){
1055 extern int sqlite3Fts3Init(sqlite3*);
1056 rc = sqlite3Fts3Init(db);
1057 }
1058#endif
1059
danielk197783852ac2007-05-06 16:04:11 +00001060#ifdef SQLITE_ENABLE_ICU
drh17435752007-08-16 04:30:38 +00001061 if( !db->mallocFailed && rc==SQLITE_OK ){
danielk197783852ac2007-05-06 16:04:11 +00001062 extern int sqlite3IcuInit(sqlite3*);
danielk1977832a58a2007-06-22 15:21:15 +00001063 rc = sqlite3IcuInit(db);
danielk197783852ac2007-05-06 16:04:11 +00001064 }
1065#endif
danielk1977832a58a2007-06-22 15:21:15 +00001066 sqlite3Error(db, rc, 0);
danielk197783852ac2007-05-06 16:04:11 +00001067
drh8fd5bd32007-04-02 16:40:37 +00001068 /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
1069 ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
1070 ** mode. Doing nothing at all also makes NORMAL the default.
1071 */
1072#ifdef SQLITE_DEFAULT_LOCKING_MODE
1073 db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
1074 sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
1075 SQLITE_DEFAULT_LOCKING_MODE);
1076#endif
1077
danielk19774ad17132004-05-21 01:47:26 +00001078opendb_out:
drh153c62c2007-08-24 03:51:33 +00001079 if( db && db->mutex ){
drhf3a65f72007-08-22 20:18:21 +00001080 sqlite3_mutex_leave(db->mutex);
1081 }
danielk19777ddad962005-12-12 06:53:03 +00001082 if( SQLITE_NOMEM==(rc = sqlite3_errcode(db)) ){
1083 sqlite3_close(db);
1084 db = 0;
danielk197713073932004-06-30 11:54:06 +00001085 }
danielk19774ad17132004-05-21 01:47:26 +00001086 *ppDb = db;
danielk197754f01982006-01-18 15:25:17 +00001087 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00001088}
1089
1090/*
1091** Open a new database handle.
1092*/
danielk197780290862004-05-22 09:21:21 +00001093int sqlite3_open(
danielk19774ad17132004-05-21 01:47:26 +00001094 const char *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00001095 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00001096){
drh605264d2007-08-21 15:13:19 +00001097 return openDatabase(zFilename, ppDb,
1098 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
1099}
1100int sqlite3_open_v2(
1101 const void *filename, /* Database filename (UTF-8) */
1102 sqlite3 **ppDb, /* OUT: SQLite db handle */
1103 int flags, /* Flags */
1104 const char *zVfs /* Name of VFS module to use */
1105){
1106 return openDatabase(filename, ppDb, flags, zVfs);
danielk197783ab5a82004-05-21 11:39:05 +00001107}
1108
drh6c626082004-11-14 21:56:29 +00001109#ifndef SQLITE_OMIT_UTF16
danielk19774ad17132004-05-21 01:47:26 +00001110/*
1111** Open a new database handle.
1112*/
1113int sqlite3_open16(
1114 const void *zFilename,
danielk19774f057f92004-06-08 00:02:33 +00001115 sqlite3 **ppDb
danielk19774ad17132004-05-21 01:47:26 +00001116){
danielk1977bfd6cce2004-06-18 04:24:54 +00001117 char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
danielk1977bfd6cce2004-06-18 04:24:54 +00001118 sqlite3_value *pVal;
danielk19771e536952007-08-16 10:09:01 +00001119 int rc = SQLITE_NOMEM;
danielk19774ad17132004-05-21 01:47:26 +00001120
danielk19777ddad962005-12-12 06:53:03 +00001121 assert( zFilename );
danielk19774ad17132004-05-21 01:47:26 +00001122 assert( ppDb );
danielk1977bfd6cce2004-06-18 04:24:54 +00001123 *ppDb = 0;
danielk19771e536952007-08-16 10:09:01 +00001124 pVal = sqlite3ValueNew(0);
drhb21c8cd2007-08-21 19:33:56 +00001125 sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
1126 zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
danielk1977bfd6cce2004-06-18 04:24:54 +00001127 if( zFilename8 ){
drh605264d2007-08-21 15:13:19 +00001128 rc = openDatabase(zFilename8, ppDb,
1129 SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
danielk1977bfd6cce2004-06-18 04:24:54 +00001130 if( rc==SQLITE_OK && *ppDb ){
drh7dd90a42005-12-06 13:19:07 +00001131 rc = sqlite3_exec(*ppDb, "PRAGMA encoding = 'UTF-16'", 0, 0, 0);
danielk1977950f0542006-01-18 05:51:57 +00001132 if( rc!=SQLITE_OK ){
1133 sqlite3_close(*ppDb);
1134 *ppDb = 0;
1135 }
danielk1977bfd6cce2004-06-18 04:24:54 +00001136 }
danielk19774ad17132004-05-21 01:47:26 +00001137 }
danielk19777ddad962005-12-12 06:53:03 +00001138 sqlite3ValueFree(pVal);
danielk19778e227872004-06-07 07:52:17 +00001139
danielk197754f01982006-01-18 15:25:17 +00001140 return sqlite3ApiExit(0, rc);
danielk19774ad17132004-05-21 01:47:26 +00001141}
drh6c626082004-11-14 21:56:29 +00001142#endif /* SQLITE_OMIT_UTF16 */
danielk19774ad17132004-05-21 01:47:26 +00001143
danielk1977106bb232004-05-21 10:08:53 +00001144/*
danielk1977d8123362004-06-12 09:25:12 +00001145** Register a new collation sequence with the database handle db.
1146*/
danielk19770202b292004-06-09 09:55:16 +00001147int sqlite3_create_collation(
1148 sqlite3* db,
1149 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00001150 int enc,
danielk19770202b292004-06-09 09:55:16 +00001151 void* pCtx,
1152 int(*xCompare)(void*,int,const void*,int,const void*)
1153){
danielk19779a30cf62006-01-18 04:26:07 +00001154 int rc;
drhe30f4422007-08-21 16:15:55 +00001155 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001156 assert( !db->mallocFailed );
danielk1977a9808b32007-05-07 09:32:45 +00001157 rc = createCollation(db, zName, enc, pCtx, xCompare, 0);
drhe30f4422007-08-21 16:15:55 +00001158 rc = sqlite3ApiExit(db, rc);
1159 sqlite3_mutex_leave(db->mutex);
1160 return rc;
danielk1977a9808b32007-05-07 09:32:45 +00001161}
1162
1163/*
1164** Register a new collation sequence with the database handle db.
1165*/
danielk1977a393c032007-05-07 14:58:53 +00001166int sqlite3_create_collation_v2(
danielk1977a9808b32007-05-07 09:32:45 +00001167 sqlite3* db,
1168 const char *zName,
1169 int enc,
1170 void* pCtx,
1171 int(*xCompare)(void*,int,const void*,int,const void*),
1172 void(*xDel)(void*)
1173){
1174 int rc;
drhe30f4422007-08-21 16:15:55 +00001175 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001176 assert( !db->mallocFailed );
danielk1977a9808b32007-05-07 09:32:45 +00001177 rc = createCollation(db, zName, enc, pCtx, xCompare, xDel);
drhe30f4422007-08-21 16:15:55 +00001178 rc = sqlite3ApiExit(db, rc);
1179 sqlite3_mutex_leave(db->mutex);
1180 return rc;
danielk19770202b292004-06-09 09:55:16 +00001181}
1182
drh6c626082004-11-14 21:56:29 +00001183#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001184/*
1185** Register a new collation sequence with the database handle db.
1186*/
danielk19770202b292004-06-09 09:55:16 +00001187int sqlite3_create_collation16(
1188 sqlite3* db,
1189 const char *zName,
danielk1977466be562004-06-10 02:16:01 +00001190 int enc,
danielk19770202b292004-06-09 09:55:16 +00001191 void* pCtx,
1192 int(*xCompare)(void*,int,const void*,int,const void*)
1193){
danielk19779a30cf62006-01-18 04:26:07 +00001194 int rc = SQLITE_OK;
1195 char *zName8;
drhe30f4422007-08-21 16:15:55 +00001196 sqlite3_mutex_enter(db->mutex);
drh17435752007-08-16 04:30:38 +00001197 assert( !db->mallocFailed );
danielk19771e536952007-08-16 10:09:01 +00001198 zName8 = sqlite3Utf16to8(db, zName, -1);
danielk19779a30cf62006-01-18 04:26:07 +00001199 if( zName8 ){
danielk1977a9808b32007-05-07 09:32:45 +00001200 rc = createCollation(db, zName8, enc, pCtx, xCompare, 0);
drh17435752007-08-16 04:30:38 +00001201 sqlite3_free(zName8);
danielk19779a30cf62006-01-18 04:26:07 +00001202 }
drhe30f4422007-08-21 16:15:55 +00001203 rc = sqlite3ApiExit(db, rc);
1204 sqlite3_mutex_leave(db->mutex);
1205 return rc;
danielk19770202b292004-06-09 09:55:16 +00001206}
drh6c626082004-11-14 21:56:29 +00001207#endif /* SQLITE_OMIT_UTF16 */
danielk19777cedc8d2004-06-10 10:50:08 +00001208
danielk1977d8123362004-06-12 09:25:12 +00001209/*
1210** Register a collation sequence factory callback with the database handle
1211** db. Replace any previously installed collation sequence factory.
1212*/
danielk19777cedc8d2004-06-10 10:50:08 +00001213int sqlite3_collation_needed(
1214 sqlite3 *db,
1215 void *pCollNeededArg,
1216 void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
1217){
drhc60d0442004-09-30 13:43:13 +00001218 if( sqlite3SafetyCheck(db) ){
1219 return SQLITE_MISUSE;
1220 }
drhe30f4422007-08-21 16:15:55 +00001221 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001222 db->xCollNeeded = xCollNeeded;
1223 db->xCollNeeded16 = 0;
1224 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00001225 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001226 return SQLITE_OK;
1227}
danielk1977d8123362004-06-12 09:25:12 +00001228
drh6c626082004-11-14 21:56:29 +00001229#ifndef SQLITE_OMIT_UTF16
danielk1977d8123362004-06-12 09:25:12 +00001230/*
1231** Register a collation sequence factory callback with the database handle
1232** db. Replace any previously installed collation sequence factory.
1233*/
danielk19777cedc8d2004-06-10 10:50:08 +00001234int sqlite3_collation_needed16(
1235 sqlite3 *db,
1236 void *pCollNeededArg,
1237 void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
1238){
drhc60d0442004-09-30 13:43:13 +00001239 if( sqlite3SafetyCheck(db) ){
1240 return SQLITE_MISUSE;
1241 }
drhe30f4422007-08-21 16:15:55 +00001242 sqlite3_mutex_enter(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001243 db->xCollNeeded = 0;
1244 db->xCollNeeded16 = xCollNeeded16;
1245 db->pCollNeededArg = pCollNeededArg;
drhe30f4422007-08-21 16:15:55 +00001246 sqlite3_mutex_leave(db->mutex);
danielk19777cedc8d2004-06-10 10:50:08 +00001247 return SQLITE_OK;
1248}
drh6c626082004-11-14 21:56:29 +00001249#endif /* SQLITE_OMIT_UTF16 */
danielk19776b456a22005-03-21 04:04:02 +00001250
1251#ifndef SQLITE_OMIT_GLOBALRECOVER
1252/*
danielk19777ddad962005-12-12 06:53:03 +00001253** This function is now an anachronism. It used to be used to recover from a
1254** malloc() failure, but SQLite now does this automatically.
danielk19776b456a22005-03-21 04:04:02 +00001255*/
1256int sqlite3_global_recover(){
danielk1977261919c2005-12-06 12:52:59 +00001257 return SQLITE_OK;
danielk19776b456a22005-03-21 04:04:02 +00001258}
1259#endif
drh3e1d8e62005-05-26 16:23:34 +00001260
1261/*
1262** Test to see whether or not the database connection is in autocommit
1263** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
1264** by default. Autocommit is disabled by a BEGIN statement and reenabled
1265** by the next COMMIT or ROLLBACK.
1266**
1267******* THIS IS AN EXPERIMENTAL API AND IS SUBJECT TO CHANGE ******
1268*/
1269int sqlite3_get_autocommit(sqlite3 *db){
1270 return db->autoCommit;
1271}
drh49285702005-09-17 15:20:26 +00001272
1273#ifdef SQLITE_DEBUG
1274/*
1275** The following routine is subtituted for constant SQLITE_CORRUPT in
1276** debugging builds. This provides a way to set a breakpoint for when
1277** corruption is first detected.
1278*/
1279int sqlite3Corrupt(void){
1280 return SQLITE_CORRUPT;
1281}
1282#endif
drh7c1817e2006-01-10 13:58:48 +00001283
drh6f7adc82006-01-11 21:41:20 +00001284/*
1285** This is a convenience routine that makes sure that all thread-specific
1286** data for this thread has been deallocated.
drhdce8bdb2007-08-16 13:01:44 +00001287**
1288** SQLite no longer uses thread-specific data so this routine is now a
1289** no-op. It is retained for historical compatibility.
drh6f7adc82006-01-11 21:41:20 +00001290*/
1291void sqlite3_thread_cleanup(void){
drh6f7adc82006-01-11 21:41:20 +00001292}
danielk1977deb802c2006-02-09 13:43:28 +00001293
1294/*
1295** Return meta information about a specific column of a database table.
1296** See comment in sqlite3.h (sqlite.h.in) for details.
1297*/
1298#ifdef SQLITE_ENABLE_COLUMN_METADATA
1299int sqlite3_table_column_metadata(
1300 sqlite3 *db, /* Connection handle */
1301 const char *zDbName, /* Database name or NULL */
1302 const char *zTableName, /* Table name */
1303 const char *zColumnName, /* Column name */
1304 char const **pzDataType, /* OUTPUT: Declared data type */
1305 char const **pzCollSeq, /* OUTPUT: Collation sequence name */
1306 int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
1307 int *pPrimaryKey, /* OUTPUT: True if column part of PK */
1308 int *pAutoinc /* OUTPUT: True if colums is auto-increment */
1309){
1310 int rc;
1311 char *zErrMsg = 0;
1312 Table *pTab = 0;
1313 Column *pCol = 0;
1314 int iCol;
1315
1316 char const *zDataType = 0;
1317 char const *zCollSeq = 0;
1318 int notnull = 0;
1319 int primarykey = 0;
1320 int autoinc = 0;
1321
1322 /* Ensure the database schema has been loaded */
1323 if( sqlite3SafetyOn(db) ){
1324 return SQLITE_MISUSE;
1325 }
drhe30f4422007-08-21 16:15:55 +00001326 sqlite3_mutex_enter(db->mutex);
danielk1977deb802c2006-02-09 13:43:28 +00001327 rc = sqlite3Init(db, &zErrMsg);
1328 if( SQLITE_OK!=rc ){
1329 goto error_out;
1330 }
1331
1332 /* Locate the table in question */
1333 pTab = sqlite3FindTable(db, zTableName, zDbName);
1334 if( !pTab || pTab->pSelect ){
1335 pTab = 0;
1336 goto error_out;
1337 }
1338
1339 /* Find the column for which info is requested */
1340 if( sqlite3IsRowid(zColumnName) ){
1341 iCol = pTab->iPKey;
1342 if( iCol>=0 ){
1343 pCol = &pTab->aCol[iCol];
1344 }
1345 }else{
1346 for(iCol=0; iCol<pTab->nCol; iCol++){
1347 pCol = &pTab->aCol[iCol];
1348 if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
1349 break;
1350 }
1351 }
1352 if( iCol==pTab->nCol ){
1353 pTab = 0;
1354 goto error_out;
1355 }
1356 }
1357
1358 /* The following block stores the meta information that will be returned
1359 ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
1360 ** and autoinc. At this point there are two possibilities:
1361 **
1362 ** 1. The specified column name was rowid", "oid" or "_rowid_"
1363 ** and there is no explicitly declared IPK column.
1364 **
1365 ** 2. The table is not a view and the column name identified an
1366 ** explicitly declared column. Copy meta information from *pCol.
1367 */
1368 if( pCol ){
1369 zDataType = pCol->zType;
1370 zCollSeq = pCol->zColl;
1371 notnull = (pCol->notNull?1:0);
1372 primarykey = (pCol->isPrimKey?1:0);
1373 autoinc = ((pTab->iPKey==iCol && pTab->autoInc)?1:0);
1374 }else{
1375 zDataType = "INTEGER";
1376 primarykey = 1;
1377 }
1378 if( !zCollSeq ){
1379 zCollSeq = "BINARY";
1380 }
1381
1382error_out:
1383 if( sqlite3SafetyOff(db) ){
1384 rc = SQLITE_MISUSE;
1385 }
1386
1387 /* Whether the function call succeeded or failed, set the output parameters
1388 ** to whatever their local counterparts contain. If an error did occur,
1389 ** this has the effect of zeroing all output parameters.
1390 */
1391 if( pzDataType ) *pzDataType = zDataType;
1392 if( pzCollSeq ) *pzCollSeq = zCollSeq;
1393 if( pNotNull ) *pNotNull = notnull;
1394 if( pPrimaryKey ) *pPrimaryKey = primarykey;
1395 if( pAutoinc ) *pAutoinc = autoinc;
1396
1397 if( SQLITE_OK==rc && !pTab ){
1398 sqlite3SetString(&zErrMsg, "no such table column: ", zTableName, ".",
1399 zColumnName, 0);
1400 rc = SQLITE_ERROR;
1401 }
1402 sqlite3Error(db, rc, (zErrMsg?"%s":0), zErrMsg);
drh17435752007-08-16 04:30:38 +00001403 sqlite3_free(zErrMsg);
drhe30f4422007-08-21 16:15:55 +00001404 rc = sqlite3ApiExit(db, rc);
1405 sqlite3_mutex_leave(db->mutex);
drhf9cb7f52006-06-27 20:06:44 +00001406 return rc;
1407}
drhe30f4422007-08-21 16:15:55 +00001408#endif
drhf9cb7f52006-06-27 20:06:44 +00001409
1410/*
1411** Sleep for a little while. Return the amount of time slept.
1412*/
1413int sqlite3_sleep(int ms){
danielk1977b4b47412007-08-17 15:53:36 +00001414 sqlite3_vfs *pVfs;
drhe30f4422007-08-21 16:15:55 +00001415 int rc;
drhd677b3d2007-08-20 22:48:41 +00001416 pVfs = sqlite3_vfs_find(0);
danielk1977fee2d252007-08-18 10:59:19 +00001417
1418 /* This function works in milliseconds, but the underlying OsSleep()
1419 ** API uses microseconds. Hence the 1000's.
1420 */
drhe30f4422007-08-21 16:15:55 +00001421 rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
drhe30f4422007-08-21 16:15:55 +00001422 return rc;
drhf9cb7f52006-06-27 20:06:44 +00001423}
drh4ac285a2006-09-15 07:28:50 +00001424
1425/*
1426** Enable or disable the extended result codes.
1427*/
1428int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
drhe30f4422007-08-21 16:15:55 +00001429 sqlite3_mutex_enter(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001430 db->errMask = onoff ? 0xffffffff : 0xff;
drhe30f4422007-08-21 16:15:55 +00001431 sqlite3_mutex_leave(db->mutex);
drh4ac285a2006-09-15 07:28:50 +00001432 return SQLITE_OK;
1433}