blob: aa4e4b3cf186fdf1b115b769bd1ecdc4a48e12f7 [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**
drh1c2d8412003-03-31 00:30:47 +000017** $Id: main.c,v 1.119 2003/03/31 00:30:48 drh Exp $
drh75897232000-05-29 14:26:00 +000018*/
19#include "sqliteInt.h"
drh8cfbf082001-09-19 13:22:39 +000020#include "os.h"
drhce9079c2002-05-15 14:17:44 +000021#include <ctype.h>
drh75897232000-05-29 14:26:00 +000022
23/*
drhc2311722002-07-19 17:46:38 +000024** A pointer to this structure is used to communicate information
25** from sqliteInit into the sqliteInitCallback.
26*/
27typedef struct {
28 sqlite *db; /* The database being initialized */
29 char **pzErrMsg; /* Error message stored here */
30} InitData;
31
32
33/*
drh75897232000-05-29 14:26:00 +000034** This is the callback routine for the code that initializes the
drh382c0242001-10-06 16:33:02 +000035** database. See sqliteInit() below for additional information.
36**
37** Each callback contains the following information:
drh28037572000-08-02 13:47:41 +000038**
drh4a324312001-12-21 14:30:42 +000039** argv[0] = "file-format" or "schema-cookie" or "table" or "index"
drhe3c41372001-09-17 20:25:58 +000040** argv[1] = table or index name or meta statement type.
41** argv[2] = root page number for table or index. NULL for meta.
drhe78e8282003-01-19 03:59:45 +000042** argv[3] = SQL text for a CREATE TABLE or CREATE INDEX statement.
drh1c2d8412003-03-31 00:30:47 +000043** argv[4] = "1" for temporary files, "0" for main database, "2" or more
44** for auxiliary database files.
drhd78eeee2001-09-13 16:18:53 +000045**
drh75897232000-05-29 14:26:00 +000046*/
drhc2311722002-07-19 17:46:38 +000047static
48int sqliteInitCallback(void *pInit, int argc, char **argv, char **azColName){
49 InitData *pData = (InitData*)pInit;
drh75897232000-05-29 14:26:00 +000050 Parse sParse;
drhd78eeee2001-09-13 16:18:53 +000051 int nErr = 0;
drh75897232000-05-29 14:26:00 +000052
drh382c0242001-10-06 16:33:02 +000053 /* TODO: Do some validity checks on all fields. In particular,
54 ** make sure fields do not contain NULLs. Otherwise we might core
55 ** when attempting to initialize from a corrupt database file. */
drhe3c41372001-09-17 20:25:58 +000056
drhe0bc4042002-06-25 01:09:11 +000057 assert( argc==5 );
drhd78eeee2001-09-13 16:18:53 +000058 switch( argv[0][0] ){
drh17f71932002-02-21 12:01:27 +000059 case 'v':
drhd78eeee2001-09-13 16:18:53 +000060 case 'i':
drh17f71932002-02-21 12:01:27 +000061 case 't': { /* CREATE TABLE, CREATE INDEX, or CREATE VIEW statements */
drhadbca9c2001-09-27 15:11:53 +000062 if( argv[3] && argv[3][0] ){
drh17f71932002-02-21 12:01:27 +000063 /* Call the parser to process a CREATE TABLE, INDEX or VIEW.
drh382c0242001-10-06 16:33:02 +000064 ** But because sParse.initFlag is set to 1, no VDBE code is generated
65 ** or executed. All the parser does is build the internal data
drh17f71932002-02-21 12:01:27 +000066 ** structures that describe the table, index, or view.
drh382c0242001-10-06 16:33:02 +000067 */
drhadbca9c2001-09-27 15:11:53 +000068 memset(&sParse, 0, sizeof(sParse));
drhc2311722002-07-19 17:46:38 +000069 sParse.db = pData->db;
drhadbca9c2001-09-27 15:11:53 +000070 sParse.initFlag = 1;
drhd24cc422003-03-27 12:51:24 +000071 sParse.iDb = atoi(argv[4]);
drhadbca9c2001-09-27 15:11:53 +000072 sParse.newTnum = atoi(argv[2]);
drhb86ccfb2003-01-28 23:13:10 +000073 sParse.useCallback = 1;
drhc2311722002-07-19 17:46:38 +000074 sqliteRunParser(&sParse, argv[3], pData->pzErrMsg);
drhadbca9c2001-09-27 15:11:53 +000075 }else{
drh382c0242001-10-06 16:33:02 +000076 /* If the SQL column is blank it means this is an index that
77 ** was created to be the PRIMARY KEY or to fulfill a UNIQUE
drhaacc5432002-01-06 17:07:40 +000078 ** constraint for a CREATE TABLE. The index should have already
drh382c0242001-10-06 16:33:02 +000079 ** been created when we processed the CREATE TABLE. All we have
drhaacc5432002-01-06 17:07:40 +000080 ** to do here is record the root page number for that index.
drh382c0242001-10-06 16:33:02 +000081 */
drhd24cc422003-03-27 12:51:24 +000082 int iDb;
83 Index *pIndex;
84
85 iDb = atoi(argv[4]);
86 assert( iDb>=0 && iDb<pData->db->nDb );
87 pIndex = sqliteFindIndex(pData->db, argv[1], pData->db->aDb[iDb].zName);
drhadbca9c2001-09-27 15:11:53 +000088 if( pIndex==0 || pIndex->tnum!=0 ){
drhda9e0342002-01-10 14:31:48 +000089 /* This can occur if there exists an index on a TEMP table which
90 ** has the same name as another index on a permanent index. Since
91 ** the permanent table is hidden by the TEMP table, we can also
92 ** safely ignore the index on the permanent table.
93 */
94 /* Do Nothing */;
drhadbca9c2001-09-27 15:11:53 +000095 }else{
96 pIndex->tnum = atoi(argv[2]);
97 }
98 }
drhd78eeee2001-09-13 16:18:53 +000099 break;
100 }
101 default: {
102 /* This can not happen! */
103 nErr = 1;
104 assert( nErr==0 );
105 }
drh28037572000-08-02 13:47:41 +0000106 }
drh75897232000-05-29 14:26:00 +0000107 return nErr;
108}
109
110/*
drh491791a2002-07-18 00:34:09 +0000111** This is a callback procedure used to reconstruct a table. The
112** name of the table to be reconstructed is passed in as argv[0].
113**
114** This routine is used to automatically upgrade a database from
115** format version 1 or 2 to version 3. The correct operation of
116** this routine relys on the fact that no indices are used when
117** copying a table out to a temporary file.
118*/
drhc2311722002-07-19 17:46:38 +0000119static
120int upgrade_3_callback(void *pInit, int argc, char **argv, char **NotUsed){
121 InitData *pData = (InitData*)pInit;
drh491791a2002-07-18 00:34:09 +0000122 int rc;
drh8e5ba842002-07-18 01:27:17 +0000123 Table *pTab;
124 Trigger *pTrig;
drh26b3e1b2002-07-19 18:52:40 +0000125 char *zErr = 0;
drh491791a2002-07-18 00:34:09 +0000126
drhd24cc422003-03-27 12:51:24 +0000127 pTab = sqliteFindTable(pData->db, argv[0], 0);
drhf573c992002-07-31 00:32:50 +0000128 assert( pTab!=0 );
129 assert( sqliteStrICmp(pTab->zName, argv[0])==0 );
drh8e5ba842002-07-18 01:27:17 +0000130 if( pTab ){
131 pTrig = pTab->pTrigger;
132 pTab->pTrigger = 0; /* Disable all triggers before rebuilding the table */
133 }
drhc2311722002-07-19 17:46:38 +0000134 rc = sqlite_exec_printf(pData->db,
drh491791a2002-07-18 00:34:09 +0000135 "CREATE TEMP TABLE sqlite_x AS SELECT * FROM '%q'; "
136 "DELETE FROM '%q'; "
137 "INSERT INTO '%q' SELECT * FROM sqlite_x; "
138 "DROP TABLE sqlite_x;",
drhc2311722002-07-19 17:46:38 +0000139 0, 0, &zErr, argv[0], argv[0], argv[0]);
140 if( zErr ){
141 sqliteSetString(pData->pzErrMsg, zErr, 0);
142 sqlite_freemem(zErr);
143 }
drhf573c992002-07-31 00:32:50 +0000144
145 /* If an error occurred in the SQL above, then the transaction will
146 ** rollback which will delete the internal symbol tables. This will
147 ** cause the structure that pTab points to be deleted. In case that
148 ** happened, we need to refetch pTab.
149 */
drhd24cc422003-03-27 12:51:24 +0000150 pTab = sqliteFindTable(pData->db, argv[0], 0);
drhf573c992002-07-31 00:32:50 +0000151 if( pTab ){
152 assert( sqliteStrICmp(pTab->zName, argv[0])==0 );
153 pTab->pTrigger = pTrig; /* Re-enable triggers */
154 }
drh491791a2002-07-18 00:34:09 +0000155 return rc!=SQLITE_OK;
156}
157
158
159
160/*
drh58b95762000-06-02 01:17:37 +0000161** Attempt to read the database schema and initialize internal
drh1c2d8412003-03-31 00:30:47 +0000162** data structures for a single database file. The index of the
163** database file is given by iDb. iDb==0 is used for the main
164** database. iDb==1 should never be used. iDb>=2 is used for
165** auxiliary databases. Return one of the SQLITE_ error codes to
drh58b95762000-06-02 01:17:37 +0000166** indicate success or failure.
drh75897232000-05-29 14:26:00 +0000167*/
drh1c2d8412003-03-31 00:30:47 +0000168static int sqliteInitOne(sqlite *db, int iDb, char **pzErrMsg){
drh58b95762000-06-02 01:17:37 +0000169 int rc;
drhe0bc4042002-06-25 01:09:11 +0000170 BtCursor *curMain;
171 int size;
172 Table *pTab;
173 char *azArg[6];
drh1c2d8412003-03-31 00:30:47 +0000174 char zDbNum[30];
drhe0bc4042002-06-25 01:09:11 +0000175 int meta[SQLITE_N_BTREE_META];
176 Parse sParse;
drhc2311722002-07-19 17:46:38 +0000177 InitData initData;
drh58b95762000-06-02 01:17:37 +0000178
179 /*
180 ** The master database table has a structure like this
181 */
drh75897232000-05-29 14:26:00 +0000182 static char master_schema[] =
drhe0bc4042002-06-25 01:09:11 +0000183 "CREATE TABLE sqlite_master(\n"
184 " type text,\n"
185 " name text,\n"
186 " tbl_name text,\n"
187 " rootpage integer,\n"
188 " sql text\n"
189 ")"
190 ;
191 static char temp_master_schema[] =
192 "CREATE TEMP TABLE sqlite_temp_master(\n"
drh75897232000-05-29 14:26:00 +0000193 " type text,\n"
194 " name text,\n"
195 " tbl_name text,\n"
drhadbca9c2001-09-27 15:11:53 +0000196 " rootpage integer,\n"
drh75897232000-05-29 14:26:00 +0000197 " sql text\n"
198 ")"
199 ;
200
drhe0bc4042002-06-25 01:09:11 +0000201 /* The following SQL will read the schema from the master tables.
202 ** The first version works with SQLite file formats 2 or greater.
203 ** The second version is for format 1 files.
drh75897232000-05-29 14:26:00 +0000204 **
drhe0bc4042002-06-25 01:09:11 +0000205 ** Beginning with file format 2, the rowid for new table entries
206 ** (including entries in sqlite_master) is an increasing integer.
207 ** So for file format 2 and later, we can play back sqlite_master
208 ** and all the CREATE statements will appear in the right order.
209 ** But with file format 1, table entries were random and so we
210 ** have to make sure the CREATE TABLEs occur before their corresponding
211 ** CREATE INDEXs. (We don't have to deal with CREATE VIEW or
212 ** CREATE TRIGGER in file format 1 because those constructs did
213 ** not exist then.)
drh75897232000-05-29 14:26:00 +0000214 */
drhe0bc4042002-06-25 01:09:11 +0000215 static char init_script[] =
216 "SELECT type, name, rootpage, sql, 1 FROM sqlite_temp_master "
217 "UNION ALL "
218 "SELECT type, name, rootpage, sql, 0 FROM sqlite_master";
219 static char older_init_script[] =
220 "SELECT type, name, rootpage, sql, 1 FROM sqlite_temp_master "
221 "UNION ALL "
222 "SELECT type, name, rootpage, sql, 0 FROM sqlite_master "
223 "WHERE type='table' "
224 "UNION ALL "
225 "SELECT type, name, rootpage, sql, 0 FROM sqlite_master "
226 "WHERE type='index'";
drh17f71932002-02-21 12:01:27 +0000227
drh603240c2002-03-05 01:11:12 +0000228
drh1c2d8412003-03-31 00:30:47 +0000229 assert( iDb>=0 && iDb!=1 && iDb<db->nDb );
230
drhe0bc4042002-06-25 01:09:11 +0000231 /* Construct the schema tables: sqlite_master and sqlite_temp_master
drh58b95762000-06-02 01:17:37 +0000232 */
drhe0bc4042002-06-25 01:09:11 +0000233 azArg[0] = "table";
234 azArg[1] = MASTER_NAME;
235 azArg[2] = "2";
236 azArg[3] = master_schema;
drh1c2d8412003-03-31 00:30:47 +0000237 sprintf(zDbNum, "%d", iDb);
238 azArg[4] = zDbNum;
drhe0bc4042002-06-25 01:09:11 +0000239 azArg[5] = 0;
drhc2311722002-07-19 17:46:38 +0000240 initData.db = db;
241 initData.pzErrMsg = pzErrMsg;
242 sqliteInitCallback(&initData, 5, azArg, 0);
drhd24cc422003-03-27 12:51:24 +0000243 pTab = sqliteFindTable(db, MASTER_NAME, "main");
drhe0bc4042002-06-25 01:09:11 +0000244 if( pTab ){
245 pTab->readOnly = 1;
drhd8bc7082000-06-07 23:51:50 +0000246 }
drh1c2d8412003-03-31 00:30:47 +0000247 if( iDb==0 ){
248 azArg[1] = TEMP_MASTER_NAME;
249 azArg[3] = temp_master_schema;
250 azArg[4] = "1";
251 sqliteInitCallback(&initData, 5, azArg, 0);
252 pTab = sqliteFindTable(db, TEMP_MASTER_NAME, "temp");
253 if( pTab ){
254 pTab->readOnly = 1;
255 }
drhe0bc4042002-06-25 01:09:11 +0000256 }
257
258 /* Create a cursor to hold the database open
259 */
drh1c2d8412003-03-31 00:30:47 +0000260 if( db->aDb[iDb].pBt==0 ) return SQLITE_OK;
261 rc = sqliteBtreeCursor(db->aDb[iDb].pBt, 2, 0, &curMain);
drh92ed08a2002-07-30 18:43:40 +0000262 if( rc ){
drh1e0ccab2002-08-29 23:59:47 +0000263 sqliteSetString(pzErrMsg, sqlite_error_string(rc), 0);
drh92ed08a2002-07-30 18:43:40 +0000264 return rc;
265 }
drhe0bc4042002-06-25 01:09:11 +0000266
267 /* Get the database meta information
268 */
drh1c2d8412003-03-31 00:30:47 +0000269 rc = sqliteBtreeGetMeta(db->aDb[iDb].pBt, meta);
drhe0bc4042002-06-25 01:09:11 +0000270 if( rc ){
drh1e0ccab2002-08-29 23:59:47 +0000271 sqliteSetString(pzErrMsg, sqlite_error_string(rc), 0);
drhe0bc4042002-06-25 01:09:11 +0000272 sqliteBtreeCloseCursor(curMain);
273 return rc;
274 }
drh1c2d8412003-03-31 00:30:47 +0000275 db->aDb[iDb].schema_cookie = meta[1];
276 if( iDb==0 ){
277 db->next_cookie = meta[1];
278 db->file_format = meta[2];
279 size = meta[3];
280 if( size==0 ){ size = MAX_PAGES; }
281 db->cache_size = size;
282 db->safety_level = meta[4];
283 if( db->safety_level==0 ) db->safety_level = 2;
drhe0bc4042002-06-25 01:09:11 +0000284
drh1c2d8412003-03-31 00:30:47 +0000285 /*
286 ** file_format==1 Version 2.1.0.
287 ** file_format==2 Version 2.2.0. Add support for INTEGER PRIMARY KEY.
288 ** file_format==3 Version 2.6.0. Fix empty-string index bug.
289 ** file_format==4 Version 2.7.0. Add support for separate numeric and
290 ** text datatypes.
291 */
292 if( db->file_format==0 ){
293 /* This happens if the database was initially empty */
294 db->file_format = 4;
295 }else if( db->file_format>4 ){
296 sqliteBtreeCloseCursor(curMain);
297 sqliteSetString(pzErrMsg, "unsupported file format", 0);
298 return SQLITE_ERROR;
299 }
300 }else if( db->file_format<4 || db->file_format!=meta[2] ){
301 sqliteSetString(pzErrMsg, "incompatible file format in auxiliary "
302 "database \"", db->aDb[iDb].zName, "\"", 0);
303 sqliteBtreeClose(db->aDb[iDb].pBt);
304 db->aDb[iDb].pBt = 0;
305 return SQLITE_FORMAT;
drh28037572000-08-02 13:47:41 +0000306 }
drh1c2d8412003-03-31 00:30:47 +0000307 sqliteBtreeSetCacheSize(db->aDb[iDb].pBt, size);
308 sqliteBtreeSetSafetyLevel(db->aDb[iDb].pBt, meta[4]==0 ? 2 : meta[4]);
drhaacc5432002-01-06 17:07:40 +0000309
drhe0bc4042002-06-25 01:09:11 +0000310 /* Read the schema information out of the schema tables
drhaacc5432002-01-06 17:07:40 +0000311 */
drhe0bc4042002-06-25 01:09:11 +0000312 memset(&sParse, 0, sizeof(sParse));
313 sParse.db = db;
drhe0bc4042002-06-25 01:09:11 +0000314 sParse.xCallback = sqliteInitCallback;
drhc2311722002-07-19 17:46:38 +0000315 sParse.pArg = (void*)&initData;
drhe0bc4042002-06-25 01:09:11 +0000316 sParse.initFlag = 1;
drhb86ccfb2003-01-28 23:13:10 +0000317 sParse.useCallback = 1;
drh1c2d8412003-03-31 00:30:47 +0000318 if( iDb==0 ){
319 sqliteRunParser(&sParse,
320 db->file_format>=2 ? init_script : older_init_script,
321 pzErrMsg);
322 }else{
323 char *zSql = 0;
324 sqliteSetString(&zSql,
325 "SELECT type, name, rootpage, sql, ", zDbNum, " FROM \"",
326 db->aDb[iDb].zName, "\".sqlite_master", 0);
327 sqliteRunParser(&sParse, zSql, pzErrMsg);
328 sqliteFree(zSql);
329 }
330 sqliteBtreeCloseCursor(curMain);
drhe0bc4042002-06-25 01:09:11 +0000331 if( sqlite_malloc_failed ){
332 sqliteSetString(pzErrMsg, "out of memory", 0);
333 sParse.rc = SQLITE_NOMEM;
drh1c2d8412003-03-31 00:30:47 +0000334 sqliteResetInternalSchema(db, 0);
drhe0bc4042002-06-25 01:09:11 +0000335 }
336 if( sParse.rc==SQLITE_OK ){
drh1c2d8412003-03-31 00:30:47 +0000337 db->aDb[iDb].flags |= SQLITE_Initialized;
338 }else{
339 sqliteResetInternalSchema(db, iDb);
340 }
341 return sParse.rc;
342}
343
344/*
345** Initialize all database files - the main database file, the file
346** used to store temporary tables, and any additional database files
347** created using ATTACH statements. Return a success code. If an
348** error occurs, write an error message into *pzErrMsg.
349**
350** After the database is initialized, the SQLITE_Initialized
351** bit is set in the flags field of the sqlite structure. An
352** attempt is made to initialize the database as soon as it
353** is opened. If that fails (perhaps because another process
354** has the sqlite_master table locked) than another attempt
355** is made the first time the database is accessed.
356*/
357int sqliteInit(sqlite *db, char **pzErrMsg){
358 int i, rc;
359
360 assert( (db->flags & SQLITE_Initialized)==0 );
361 rc = SQLITE_OK;
362 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
363 if( db->aDb[i].flags & SQLITE_Initialized ) continue;
364 if( i==1 ) continue; /* Skip the temp database - initialized with 0 */
365 rc = sqliteInitOne(db, i, pzErrMsg);
366 }
367 if( rc==SQLITE_OK ){
drh58b95762000-06-02 01:17:37 +0000368 db->flags |= SQLITE_Initialized;
drh5e00f6c2001-09-13 13:46:56 +0000369 sqliteCommitInternalChanges(db);
drhe0bc4042002-06-25 01:09:11 +0000370 }else{
371 db->flags &= ~SQLITE_Initialized;
drh58b95762000-06-02 01:17:37 +0000372 }
drh1c2d8412003-03-31 00:30:47 +0000373 return rc;
drh58b95762000-06-02 01:17:37 +0000374}
375
376/*
drhb217a572000-08-22 13:40:18 +0000377** The version of the library
378*/
drh096c4972002-07-19 19:03:41 +0000379const char rcsid[] = "@(#) \044Id: SQLite version " SQLITE_VERSION " $";
drh3d0b5592000-08-22 13:40:51 +0000380const char sqlite_version[] = SQLITE_VERSION;
drhb217a572000-08-22 13:40:18 +0000381
382/*
drh297ecf12001-04-05 15:57:13 +0000383** Does the library expect data to be encoded as UTF-8 or iso8859? The
384** following global constant always lets us know.
385*/
386#ifdef SQLITE_UTF8
drhfbc3eab2001-04-06 16:13:42 +0000387const char sqlite_encoding[] = "UTF-8";
drh297ecf12001-04-05 15:57:13 +0000388#else
drhfbc3eab2001-04-06 16:13:42 +0000389const char sqlite_encoding[] = "iso8859";
drh297ecf12001-04-05 15:57:13 +0000390#endif
391
392/*
drh58b95762000-06-02 01:17:37 +0000393** Open a new SQLite database. Construct an "sqlite" structure to define
394** the state of this database and return a pointer to that structure.
395**
396** An attempt is made to initialize the in-memory data structures that
397** hold the database schema. But if this fails (because the schema file
398** is locked) then that step is deferred until the first call to
399** sqlite_exec().
400*/
401sqlite *sqlite_open(const char *zFilename, int mode, char **pzErrMsg){
402 sqlite *db;
drhd24cc422003-03-27 12:51:24 +0000403 int rc, i;
drh58b95762000-06-02 01:17:37 +0000404
405 /* Allocate the sqlite data structure */
drh75897232000-05-29 14:26:00 +0000406 db = sqliteMalloc( sizeof(sqlite) );
407 if( pzErrMsg ) *pzErrMsg = 0;
drhdaffd0e2001-04-11 14:28:42 +0000408 if( db==0 ) goto no_mem_on_open;
drh1c928532002-01-31 15:54:21 +0000409 db->onError = OE_Default;
drh5cf8e8c2002-02-19 22:42:05 +0000410 db->priorNewRowid = 0;
drh247be432002-05-10 05:44:55 +0000411 db->magic = SQLITE_MAGIC_BUSY;
drh001bbcb2003-03-19 03:14:00 +0000412 db->nDb = 2;
413 db->aDb = db->aDbStatic;
drhd24cc422003-03-27 12:51:24 +0000414 sqliteHashInit(&db->aFunc, SQLITE_HASH_STRING, 1);
415 for(i=0; i<db->nDb; i++){
416 sqliteHashInit(&db->aDb[i].tblHash, SQLITE_HASH_STRING, 0);
417 sqliteHashInit(&db->aDb[i].idxHash, SQLITE_HASH_STRING, 0);
418 sqliteHashInit(&db->aDb[i].trigHash, SQLITE_HASH_STRING, 0);
419 sqliteHashInit(&db->aDb[i].aFKey, SQLITE_HASH_STRING, 1);
420 }
drh75897232000-05-29 14:26:00 +0000421
422 /* Open the backend database driver */
drh001bbcb2003-03-19 03:14:00 +0000423 rc = sqliteBtreeOpen(zFilename, 0, MAX_PAGES, &db->aDb[0].pBt);
drh5e00f6c2001-09-13 13:46:56 +0000424 if( rc!=SQLITE_OK ){
425 switch( rc ){
426 default: {
drhaacc5432002-01-06 17:07:40 +0000427 sqliteSetString(pzErrMsg, "unable to open database: ", zFilename, 0);
drh5e00f6c2001-09-13 13:46:56 +0000428 }
429 }
drh75897232000-05-29 14:26:00 +0000430 sqliteFree(db);
drh5edc3122001-09-13 21:53:09 +0000431 sqliteStrRealloc(pzErrMsg);
drhbe0072d2001-09-13 14:46:09 +0000432 return 0;
drh75897232000-05-29 14:26:00 +0000433 }
drh001bbcb2003-03-19 03:14:00 +0000434 db->aDb[0].zName = "main";
drh113088e2003-03-20 01:16:58 +0000435 db->aDb[1].zName = "temp";
drh75897232000-05-29 14:26:00 +0000436
drh58b95762000-06-02 01:17:37 +0000437 /* Attempt to read the schema */
drh8c90ebb2002-09-05 23:21:37 +0000438 sqliteRegisterBuiltinFunctions(db);
drh58b95762000-06-02 01:17:37 +0000439 rc = sqliteInit(db, pzErrMsg);
drhc67980b2002-06-14 20:54:14 +0000440 db->magic = SQLITE_MAGIC_OPEN;
drhdaffd0e2001-04-11 14:28:42 +0000441 if( sqlite_malloc_failed ){
drh6d4abfb2001-10-22 02:58:08 +0000442 sqlite_close(db);
drhdaffd0e2001-04-11 14:28:42 +0000443 goto no_mem_on_open;
444 }else if( rc!=SQLITE_OK && rc!=SQLITE_BUSY ){
drh58b95762000-06-02 01:17:37 +0000445 sqlite_close(db);
drh5edc3122001-09-13 21:53:09 +0000446 sqliteStrRealloc(pzErrMsg);
drh58b95762000-06-02 01:17:37 +0000447 return 0;
drhaacc5432002-01-06 17:07:40 +0000448 }else if( pzErrMsg ){
drhdaffd0e2001-04-11 14:28:42 +0000449 sqliteFree(*pzErrMsg);
drhbed86902000-06-02 13:27:59 +0000450 *pzErrMsg = 0;
drh75897232000-05-29 14:26:00 +0000451 }
drh491791a2002-07-18 00:34:09 +0000452
453 /* If the database is in formats 1 or 2, then upgrade it to
454 ** version 3. This will reconstruct all indices. If the
455 ** upgrade fails for any reason (ex: out of disk space, database
drhe78e8282003-01-19 03:59:45 +0000456 ** is read only, interrupt received, etc.) then refuse to open.
drh491791a2002-07-18 00:34:09 +0000457 */
drh92ed08a2002-07-30 18:43:40 +0000458 if( rc==SQLITE_OK && db->file_format<3 ){
drhc2311722002-07-19 17:46:38 +0000459 char *zErr = 0;
460 InitData initData;
drh491791a2002-07-18 00:34:09 +0000461 int meta[SQLITE_N_BTREE_META];
462
drhc2311722002-07-19 17:46:38 +0000463 initData.db = db;
464 initData.pzErrMsg = &zErr;
drh491791a2002-07-18 00:34:09 +0000465 db->file_format = 3;
466 rc = sqlite_exec(db,
467 "BEGIN; SELECT name FROM sqlite_master WHERE type='table';",
468 upgrade_3_callback,
drhc2311722002-07-19 17:46:38 +0000469 &initData,
drh491791a2002-07-18 00:34:09 +0000470 &zErr);
471 if( rc==SQLITE_OK ){
drh001bbcb2003-03-19 03:14:00 +0000472 sqliteBtreeGetMeta(db->aDb[0].pBt, meta);
drha9e99ae2002-08-13 23:02:57 +0000473 meta[2] = 4;
drh001bbcb2003-03-19 03:14:00 +0000474 sqliteBtreeUpdateMeta(db->aDb[0].pBt, meta);
drh491791a2002-07-18 00:34:09 +0000475 sqlite_exec(db, "COMMIT", 0, 0, 0);
476 }
477 if( rc!=SQLITE_OK ){
478 sqliteSetString(pzErrMsg,
479 "unable to upgrade database to the version 2.6 format",
480 zErr ? ": " : 0, zErr, 0);
drhc2311722002-07-19 17:46:38 +0000481 sqlite_freemem(zErr);
drh491791a2002-07-18 00:34:09 +0000482 sqliteStrRealloc(pzErrMsg);
483 sqlite_close(db);
484 return 0;
485 }
drhc2311722002-07-19 17:46:38 +0000486 sqlite_freemem(zErr);
drh491791a2002-07-18 00:34:09 +0000487 }
488
489 /* Return a pointer to the newly opened database structure */
drh75897232000-05-29 14:26:00 +0000490 return db;
drhdaffd0e2001-04-11 14:28:42 +0000491
492no_mem_on_open:
493 sqliteSetString(pzErrMsg, "out of memory", 0);
494 sqliteStrRealloc(pzErrMsg);
495 return 0;
drh75897232000-05-29 14:26:00 +0000496}
497
498/*
drhaf9ff332002-01-16 21:00:27 +0000499** Return the ROWID of the most recent insert
500*/
501int sqlite_last_insert_rowid(sqlite *db){
502 return db->lastRowid;
503}
504
505/*
drhc8d30ac2002-04-12 10:08:59 +0000506** Return the number of changes in the most recent call to sqlite_exec().
507*/
508int sqlite_changes(sqlite *db){
509 return db->nChange;
510}
511
512/*
drh50e5dad2001-09-15 00:57:28 +0000513** Close an existing SQLite database
514*/
515void sqlite_close(sqlite *db){
drh8e0a2f92002-02-23 23:45:45 +0000516 HashElem *i;
drh001bbcb2003-03-19 03:14:00 +0000517 int j;
drh94e92032003-02-16 22:21:32 +0000518 db->want_to_close = 1;
519 if( sqliteSafetyCheck(db) || sqliteSafetyOn(db) ){
520 /* printf("DID NOT CLOSE\n"); fflush(stdout); */
521 return;
522 }
drh247be432002-05-10 05:44:55 +0000523 db->magic = SQLITE_MAGIC_CLOSED;
drh001bbcb2003-03-19 03:14:00 +0000524 for(j=0; j<db->nDb; j++){
525 if( db->aDb[j].pBt ){
526 sqliteBtreeClose(db->aDb[j].pBt);
drh1c2d8412003-03-31 00:30:47 +0000527 db->aDb[j].pBt = 0;
drh001bbcb2003-03-19 03:14:00 +0000528 }
drh113088e2003-03-20 01:16:58 +0000529 if( j>=2 ){
530 sqliteFree(db->aDb[j].zName);
drh1c2d8412003-03-31 00:30:47 +0000531 db->aDb[j].zName = 0;
drh113088e2003-03-20 01:16:58 +0000532 }
drhf57b3392001-10-08 13:22:32 +0000533 }
drh1c2d8412003-03-31 00:30:47 +0000534 sqliteResetInternalSchema(db, 0);
535 assert( db->nDb<=2 );
536 assert( db->aDb==db->aDbStatic );
drh0bce8352002-02-28 00:41:10 +0000537 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
538 FuncDef *pFunc, *pNext;
539 for(pFunc = (FuncDef*)sqliteHashData(i); pFunc; pFunc=pNext){
drh8e0a2f92002-02-23 23:45:45 +0000540 pNext = pFunc->pNext;
541 sqliteFree(pFunc);
542 }
543 }
drh0bce8352002-02-28 00:41:10 +0000544 sqliteHashClear(&db->aFunc);
drh75897232000-05-29 14:26:00 +0000545 sqliteFree(db);
546}
547
548/*
549** Return TRUE if the given SQL string ends in a semicolon.
drhce9079c2002-05-15 14:17:44 +0000550**
551** Special handling is require for CREATE TRIGGER statements.
552** Whenever the CREATE TRIGGER keywords are seen, the statement
553** must end with ";END;".
drh75897232000-05-29 14:26:00 +0000554*/
555int sqlite_complete(const char *zSql){
drhce9079c2002-05-15 14:17:44 +0000556 int isComplete = 1;
557 int requireEnd = 0;
558 int seenText = 0;
danielk1977c3f9bad2002-05-15 08:30:12 +0000559 int seenCreate = 0;
drh8c82b352000-12-10 18:23:50 +0000560 while( *zSql ){
561 switch( *zSql ){
562 case ';': {
563 isComplete = 1;
drhce9079c2002-05-15 14:17:44 +0000564 seenText = 1;
565 seenCreate = 0;
drh75897232000-05-29 14:26:00 +0000566 break;
drh8c82b352000-12-10 18:23:50 +0000567 }
568 case ' ':
569 case '\t':
570 case '\n':
571 case '\f': {
drh75897232000-05-29 14:26:00 +0000572 break;
drh8c82b352000-12-10 18:23:50 +0000573 }
drh969fa7c2002-02-18 18:30:32 +0000574 case '[': {
575 isComplete = 0;
drhce9079c2002-05-15 14:17:44 +0000576 seenText = 1;
577 seenCreate = 0;
drh969fa7c2002-02-18 18:30:32 +0000578 zSql++;
579 while( *zSql && *zSql!=']' ){ zSql++; }
580 if( *zSql==0 ) return 0;
581 break;
582 }
drhce9079c2002-05-15 14:17:44 +0000583 case '"':
drh8c82b352000-12-10 18:23:50 +0000584 case '\'': {
drhce9079c2002-05-15 14:17:44 +0000585 int c = *zSql;
drh8c82b352000-12-10 18:23:50 +0000586 isComplete = 0;
drhce9079c2002-05-15 14:17:44 +0000587 seenText = 1;
588 seenCreate = 0;
drh8c82b352000-12-10 18:23:50 +0000589 zSql++;
drhce9079c2002-05-15 14:17:44 +0000590 while( *zSql && *zSql!=c ){ zSql++; }
drh8c82b352000-12-10 18:23:50 +0000591 if( *zSql==0 ) return 0;
592 break;
593 }
594 case '-': {
595 if( zSql[1]!='-' ){
596 isComplete = 0;
drhce9079c2002-05-15 14:17:44 +0000597 seenCreate = 0;
drh8c82b352000-12-10 18:23:50 +0000598 break;
599 }
600 while( *zSql && *zSql!='\n' ){ zSql++; }
drhce9079c2002-05-15 14:17:44 +0000601 if( *zSql==0 ) return seenText && isComplete && requireEnd==0;
602 break;
603 }
604 case 'c':
605 case 'C': {
606 seenText = 1;
607 if( !isComplete ) break;
608 isComplete = 0;
609 if( sqliteStrNICmp(zSql, "create", 6)!=0 ) break;
610 if( !isspace(zSql[6]) ) break;
611 zSql += 5;
612 seenCreate = 1;
613 while( isspace(zSql[1]) ) zSql++;
614 if( sqliteStrNICmp(&zSql[1],"trigger", 7)!=0 ) break;
615 zSql += 7;
616 requireEnd++;
617 break;
618 }
619 case 't':
620 case 'T': {
621 seenText = 1;
622 if( !seenCreate ) break;
623 seenCreate = 0;
624 isComplete = 0;
625 if( sqliteStrNICmp(zSql, "trigger", 7)!=0 ) break;
626 if( !isspace(zSql[7]) ) break;
627 zSql += 6;
628 requireEnd++;
629 break;
630 }
631 case 'e':
632 case 'E': {
633 seenCreate = 0;
634 seenText = 1;
635 if( !isComplete ) break;
636 isComplete = 0;
637 if( requireEnd==0 ) break;
638 if( sqliteStrNICmp(zSql, "end", 3)!=0 ) break;
639 zSql += 2;
640 while( isspace(zSql[1]) ) zSql++;
641 if( zSql[1]==';' ){
642 zSql++;
643 isComplete = 1;
644 requireEnd--;
645 }
drh8c82b352000-12-10 18:23:50 +0000646 break;
drh9adf9ac2002-05-15 11:44:13 +0000647 }
drh8c82b352000-12-10 18:23:50 +0000648 default: {
drhce9079c2002-05-15 14:17:44 +0000649 seenCreate = 0;
650 seenText = 1;
drh8c82b352000-12-10 18:23:50 +0000651 isComplete = 0;
652 break;
653 }
drh75897232000-05-29 14:26:00 +0000654 }
drh8c82b352000-12-10 18:23:50 +0000655 zSql++;
drh75897232000-05-29 14:26:00 +0000656 }
drhce9079c2002-05-15 14:17:44 +0000657 return seenText && isComplete && requireEnd==0;
drh75897232000-05-29 14:26:00 +0000658}
659
660/*
drh001bbcb2003-03-19 03:14:00 +0000661** Rollback all database files.
662*/
663void sqliteRollbackAll(sqlite *db){
664 int i;
665 for(i=0; i<db->nDb; i++){
666 if( db->aDb[i].pBt ){
667 sqliteBtreeRollback(db->aDb[i].pBt);
668 db->aDb[i].inTrans = 0;
669 }
670 }
671 sqliteRollbackInternalChanges(db);
672}
673
674/*
drhb86ccfb2003-01-28 23:13:10 +0000675** This routine does the work of either sqlite_exec() or sqlite_compile().
676** It works like sqlite_exec() if pVm==NULL and it works like sqlite_compile()
677** otherwise.
drh75897232000-05-29 14:26:00 +0000678*/
drhb86ccfb2003-01-28 23:13:10 +0000679static int sqliteMain(
drh75897232000-05-29 14:26:00 +0000680 sqlite *db, /* The database on which the SQL executes */
drh9f71c2e2001-11-03 23:57:09 +0000681 const char *zSql, /* The SQL to be executed */
drh75897232000-05-29 14:26:00 +0000682 sqlite_callback xCallback, /* Invoke this callback routine */
683 void *pArg, /* First argument to xCallback() */
drhb86ccfb2003-01-28 23:13:10 +0000684 const char **pzTail, /* OUT: Next statement after the first */
685 sqlite_vm **ppVm, /* OUT: The virtual machine */
686 char **pzErrMsg /* OUT: Write error messages here */
drh75897232000-05-29 14:26:00 +0000687){
688 Parse sParse;
drh75897232000-05-29 14:26:00 +0000689
drh799550b2003-01-18 17:04:08 +0000690 if( pzErrMsg ) *pzErrMsg = 0;
691 if( sqliteSafetyOn(db) ) goto exec_misuse;
drh58b95762000-06-02 01:17:37 +0000692 if( (db->flags & SQLITE_Initialized)==0 ){
drh1e0ccab2002-08-29 23:59:47 +0000693 int rc, cnt = 1;
694 while( (rc = sqliteInit(db, pzErrMsg))==SQLITE_BUSY
695 && db->xBusyCallback && db->xBusyCallback(db->pBusyArg, "", cnt++)!=0 ){}
drhdaffd0e2001-04-11 14:28:42 +0000696 if( rc!=SQLITE_OK ){
697 sqliteStrRealloc(pzErrMsg);
drh247be432002-05-10 05:44:55 +0000698 sqliteSafetyOff(db);
drhdaffd0e2001-04-11 14:28:42 +0000699 return rc;
700 }
drh7bc09d32002-11-01 01:55:36 +0000701 if( pzErrMsg ){
702 sqliteFree(*pzErrMsg);
703 *pzErrMsg = 0;
704 }
drh58b95762000-06-02 01:17:37 +0000705 }
drh491791a2002-07-18 00:34:09 +0000706 if( db->file_format<3 ){
707 sqliteSafetyOff(db);
708 sqliteSetString(pzErrMsg, "obsolete database file format", 0);
709 return SQLITE_ERROR;
710 }
drh326dce72003-01-29 14:06:07 +0000711 if( db->pVdbe==0 ){ db->nChange = 0; }
drh75897232000-05-29 14:26:00 +0000712 memset(&sParse, 0, sizeof(sParse));
713 sParse.db = db;
714 sParse.xCallback = xCallback;
715 sParse.pArg = pArg;
drhb86ccfb2003-01-28 23:13:10 +0000716 sParse.useCallback = ppVm==0;
717#ifndef SQLITE_OMIT_TRACE
718 if( db->xTrace ) db->xTrace(db->pTraceArg, zSql);
719#endif
drh4c504392000-10-16 22:06:40 +0000720 sqliteRunParser(&sParse, zSql, pzErrMsg);
drhdaffd0e2001-04-11 14:28:42 +0000721 if( sqlite_malloc_failed ){
722 sqliteSetString(pzErrMsg, "out of memory", 0);
723 sParse.rc = SQLITE_NOMEM;
drh001bbcb2003-03-19 03:14:00 +0000724 sqliteRollbackAll(db);
drh1c2d8412003-03-31 00:30:47 +0000725 sqliteResetInternalSchema(db, 0);
drh001bbcb2003-03-19 03:14:00 +0000726 db->flags &= ~SQLITE_InTrans;
drhdaffd0e2001-04-11 14:28:42 +0000727 }
drh326dce72003-01-29 14:06:07 +0000728 if( sParse.rc==SQLITE_DONE ) sParse.rc = SQLITE_OK;
drhb798fa62002-09-03 19:43:23 +0000729 if( sParse.rc!=SQLITE_OK && pzErrMsg && *pzErrMsg==0 ){
730 sqliteSetString(pzErrMsg, sqlite_error_string(sParse.rc), 0);
731 }
drhdaffd0e2001-04-11 14:28:42 +0000732 sqliteStrRealloc(pzErrMsg);
drh50e5dad2001-09-15 00:57:28 +0000733 if( sParse.rc==SQLITE_SCHEMA ){
drh1c2d8412003-03-31 00:30:47 +0000734 sqliteResetInternalSchema(db, 0);
drh50e5dad2001-09-15 00:57:28 +0000735 }
drhb86ccfb2003-01-28 23:13:10 +0000736 if( sParse.useCallback==0 ){
737 assert( ppVm );
drh326dce72003-01-29 14:06:07 +0000738 *ppVm = (sqlite_vm*)sParse.pVdbe;
739 *pzTail = sParse.zTail;
drhb86ccfb2003-01-28 23:13:10 +0000740 }
drhc22bd472002-05-10 13:14:07 +0000741 if( sqliteSafetyOff(db) ) goto exec_misuse;
drh4c504392000-10-16 22:06:40 +0000742 return sParse.rc;
drhc22bd472002-05-10 13:14:07 +0000743
744exec_misuse:
745 if( pzErrMsg ){
746 *pzErrMsg = 0;
747 sqliteSetString(pzErrMsg, sqlite_error_string(SQLITE_MISUSE), 0);
748 sqliteStrRealloc(pzErrMsg);
749 }
750 return SQLITE_MISUSE;
drh75897232000-05-29 14:26:00 +0000751}
drh2dfbbca2000-07-28 14:32:48 +0000752
753/*
drhb86ccfb2003-01-28 23:13:10 +0000754** Execute SQL code. Return one of the SQLITE_ success/failure
755** codes. Also write an error message into memory obtained from
756** malloc() and make *pzErrMsg point to that message.
757**
758** If the SQL is a query, then for each row in the query result
759** the xCallback() function is called. pArg becomes the first
760** argument to xCallback(). If xCallback=NULL then no callback
761** is invoked, even for queries.
762*/
763int sqlite_exec(
764 sqlite *db, /* The database on which the SQL executes */
765 const char *zSql, /* The SQL to be executed */
766 sqlite_callback xCallback, /* Invoke this callback routine */
767 void *pArg, /* First argument to xCallback() */
768 char **pzErrMsg /* Write error messages here */
769){
770 return sqliteMain(db, zSql, xCallback, pArg, 0, 0, pzErrMsg);
771}
772
773/*
774** Compile a single statement of SQL into a virtual machine. Return one
775** of the SQLITE_ success/failure codes. Also write an error message into
776** memory obtained from malloc() and make *pzErrMsg point to that message.
777*/
778int sqlite_compile(
779 sqlite *db, /* The database on which the SQL executes */
780 const char *zSql, /* The SQL to be executed */
781 const char **pzTail, /* OUT: Next statement after the first */
782 sqlite_vm **ppVm, /* OUT: The virtual machine */
783 char **pzErrMsg /* OUT: Write error messages here */
784){
785 return sqliteMain(db, zSql, 0, 0, pzTail, ppVm, pzErrMsg);
786}
787
788/*
789** The following routine destroys a virtual machine that is created by
790** the sqlite_compile() routine.
791**
792** The integer returned is an SQLITE_ success/failure code that describes
793** the result of executing the virtual machine. An error message is
794** written into memory obtained from malloc and *pzErrMsg is made to
795** point to that error if pzErrMsg is not NULL. The calling routine
796** should use sqlite_freemem() to delete the message when it has finished
797** with it.
798*/
799int sqlite_finalize(
800 sqlite_vm *pVm, /* The virtual machine to be destroyed */
801 char **pzErrMsg /* OUT: Write error messages here */
802){
drh483750b2003-01-29 18:46:51 +0000803 int rc = sqliteVdbeFinalize((Vdbe*)pVm, pzErrMsg);
804 sqliteStrRealloc(pzErrMsg);
805 return rc;
drhb86ccfb2003-01-28 23:13:10 +0000806}
807
808/*
drhc22bd472002-05-10 13:14:07 +0000809** Return a static string that describes the kind of error specified in the
810** argument.
drh247be432002-05-10 05:44:55 +0000811*/
drhc22bd472002-05-10 13:14:07 +0000812const char *sqlite_error_string(int rc){
813 const char *z;
814 switch( rc ){
815 case SQLITE_OK: z = "not an error"; break;
816 case SQLITE_ERROR: z = "SQL logic error or missing database"; break;
817 case SQLITE_INTERNAL: z = "internal SQLite implementation flaw"; break;
818 case SQLITE_PERM: z = "access permission denied"; break;
819 case SQLITE_ABORT: z = "callback requested query abort"; break;
820 case SQLITE_BUSY: z = "database is locked"; break;
821 case SQLITE_LOCKED: z = "database table is locked"; break;
822 case SQLITE_NOMEM: z = "out of memory"; break;
823 case SQLITE_READONLY: z = "attempt to write a readonly database"; break;
824 case SQLITE_INTERRUPT: z = "interrupted"; break;
825 case SQLITE_IOERR: z = "disk I/O error"; break;
826 case SQLITE_CORRUPT: z = "database disk image is malformed"; break;
827 case SQLITE_NOTFOUND: z = "table or record not found"; break;
828 case SQLITE_FULL: z = "database is full"; break;
829 case SQLITE_CANTOPEN: z = "unable to open database file"; break;
830 case SQLITE_PROTOCOL: z = "database locking protocol failure"; break;
831 case SQLITE_EMPTY: z = "table contains no data"; break;
832 case SQLITE_SCHEMA: z = "database schema has changed"; break;
833 case SQLITE_TOOBIG: z = "too much data for one table row"; break;
834 case SQLITE_CONSTRAINT: z = "constraint failed"; break;
835 case SQLITE_MISMATCH: z = "datatype mismatch"; break;
836 case SQLITE_MISUSE: z = "library routine called out of sequence";break;
drh8766c342002-11-09 00:33:15 +0000837 case SQLITE_NOLFS: z = "kernel lacks large file support"; break;
drhed6c8672003-01-12 18:02:16 +0000838 case SQLITE_AUTH: z = "authorization denied"; break;
drhc22bd472002-05-10 13:14:07 +0000839 default: z = "unknown error"; break;
drh247be432002-05-10 05:44:55 +0000840 }
drhc22bd472002-05-10 13:14:07 +0000841 return z;
drh247be432002-05-10 05:44:55 +0000842}
843
844/*
drh2dfbbca2000-07-28 14:32:48 +0000845** This routine implements a busy callback that sleeps and tries
846** again until a timeout value is reached. The timeout value is
847** an integer number of milliseconds passed in as the first
848** argument.
849*/
drhdaffd0e2001-04-11 14:28:42 +0000850static int sqliteDefaultBusyCallback(
drh2dfbbca2000-07-28 14:32:48 +0000851 void *Timeout, /* Maximum amount of time to wait */
852 const char *NotUsed, /* The name of the table that is busy */
853 int count /* Number of times table has been busy */
854){
drh8cfbf082001-09-19 13:22:39 +0000855#if SQLITE_MIN_SLEEP_MS==1
856 int delay = 10;
drh2dfbbca2000-07-28 14:32:48 +0000857 int prior_delay = 0;
858 int timeout = (int)Timeout;
859 int i;
860
861 for(i=1; i<count; i++){
862 prior_delay += delay;
863 delay = delay*2;
drh8cfbf082001-09-19 13:22:39 +0000864 if( delay>=1000 ){
865 delay = 1000;
866 prior_delay += 1000*(count - i - 1);
drh2dfbbca2000-07-28 14:32:48 +0000867 break;
868 }
869 }
drh3109e022001-10-09 13:46:01 +0000870 if( prior_delay + delay > timeout ){
871 delay = timeout - prior_delay;
drh2dfbbca2000-07-28 14:32:48 +0000872 if( delay<=0 ) return 0;
873 }
drh8cfbf082001-09-19 13:22:39 +0000874 sqliteOsSleep(delay);
drh2dfbbca2000-07-28 14:32:48 +0000875 return 1;
876#else
877 int timeout = (int)Timeout;
878 if( (count+1)*1000 > timeout ){
879 return 0;
880 }
drh8cfbf082001-09-19 13:22:39 +0000881 sqliteOsSleep(1000);
drh2dfbbca2000-07-28 14:32:48 +0000882 return 1;
883#endif
884}
885
886/*
887** This routine sets the busy callback for an Sqlite database to the
888** given callback function with the given argument.
889*/
890void sqlite_busy_handler(
891 sqlite *db,
892 int (*xBusy)(void*,const char*,int),
893 void *pArg
894){
895 db->xBusyCallback = xBusy;
896 db->pBusyArg = pArg;
897}
898
899/*
900** This routine installs a default busy handler that waits for the
901** specified number of milliseconds before returning 0.
902*/
903void sqlite_busy_timeout(sqlite *db, int ms){
904 if( ms>0 ){
drhdaffd0e2001-04-11 14:28:42 +0000905 sqlite_busy_handler(db, sqliteDefaultBusyCallback, (void*)ms);
drh2dfbbca2000-07-28 14:32:48 +0000906 }else{
907 sqlite_busy_handler(db, 0, 0);
908 }
909}
drh4c504392000-10-16 22:06:40 +0000910
911/*
912** Cause any pending operation to stop at its earliest opportunity.
913*/
914void sqlite_interrupt(sqlite *db){
915 db->flags |= SQLITE_Interrupt;
916}
drhfa86c412002-02-02 15:01:15 +0000917
918/*
919** Windows systems should call this routine to free memory that
920** is returned in the in the errmsg parameter of sqlite_open() when
921** SQLite is a DLL. For some reason, it does not work to call free()
922** directly.
923**
924** Note that we need to call free() not sqliteFree() here, since every
925** string that is exported from SQLite should have already passed through
926** sqliteStrRealloc().
927*/
928void sqlite_freemem(void *p){ free(p); }
929
930/*
931** Windows systems need functions to call to return the sqlite_version
drhe78e8282003-01-19 03:59:45 +0000932** and sqlite_encoding strings since they are unable to access constants
933** within DLLs.
drhfa86c412002-02-02 15:01:15 +0000934*/
935const char *sqlite_libversion(void){ return sqlite_version; }
936const char *sqlite_libencoding(void){ return sqlite_encoding; }
drh8e0a2f92002-02-23 23:45:45 +0000937
938/*
939** Create new user-defined functions. The sqlite_create_function()
940** routine creates a regular function and sqlite_create_aggregate()
941** creates an aggregate function.
942**
943** Passing a NULL xFunc argument or NULL xStep and xFinalize arguments
944** disables the function. Calling sqlite_create_function() with the
945** same name and number of arguments as a prior call to
946** sqlite_create_aggregate() disables the prior call to
947** sqlite_create_aggregate(), and vice versa.
948**
949** If nArg is -1 it means that this function will accept any number
950** of arguments, including 0.
951*/
952int sqlite_create_function(
953 sqlite *db, /* Add the function to this database connection */
954 const char *zName, /* Name of the function to add */
955 int nArg, /* Number of arguments */
drh1350b032002-02-27 19:00:20 +0000956 void (*xFunc)(sqlite_func*,int,const char**), /* The implementation */
957 void *pUserData /* User data */
drh8e0a2f92002-02-23 23:45:45 +0000958){
drh0bce8352002-02-28 00:41:10 +0000959 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +0000960 int nName;
drhc22bd472002-05-10 13:14:07 +0000961 if( db==0 || zName==0 || sqliteSafetyCheck(db) ) return 1;
drh4b59ab52002-08-24 18:24:51 +0000962 nName = strlen(zName);
963 if( nName>255 ) return 1;
964 p = sqliteFindFunction(db, zName, nName, nArg, 1);
drh4e0f9952002-02-27 01:53:13 +0000965 if( p==0 ) return 1;
drh8e0a2f92002-02-23 23:45:45 +0000966 p->xFunc = xFunc;
967 p->xStep = 0;
968 p->xFinalize = 0;
drh1350b032002-02-27 19:00:20 +0000969 p->pUserData = pUserData;
drh8e0a2f92002-02-23 23:45:45 +0000970 return 0;
971}
972int sqlite_create_aggregate(
973 sqlite *db, /* Add the function to this database connection */
974 const char *zName, /* Name of the function to add */
975 int nArg, /* Number of arguments */
drh1350b032002-02-27 19:00:20 +0000976 void (*xStep)(sqlite_func*,int,const char**), /* The step function */
977 void (*xFinalize)(sqlite_func*), /* The finalizer */
978 void *pUserData /* User data */
drh8e0a2f92002-02-23 23:45:45 +0000979){
drh0bce8352002-02-28 00:41:10 +0000980 FuncDef *p;
drh4b59ab52002-08-24 18:24:51 +0000981 int nName;
drhc22bd472002-05-10 13:14:07 +0000982 if( db==0 || zName==0 || sqliteSafetyCheck(db) ) return 1;
drh4b59ab52002-08-24 18:24:51 +0000983 nName = strlen(zName);
984 if( nName>255 ) return 1;
985 p = sqliteFindFunction(db, zName, nName, nArg, 1);
drh4e0f9952002-02-27 01:53:13 +0000986 if( p==0 ) return 1;
drh8e0a2f92002-02-23 23:45:45 +0000987 p->xFunc = 0;
988 p->xStep = xStep;
989 p->xFinalize = xFinalize;
drh1350b032002-02-27 19:00:20 +0000990 p->pUserData = pUserData;
drh8e0a2f92002-02-23 23:45:45 +0000991 return 0;
992}
drhc9b84a12002-06-20 11:36:48 +0000993
994/*
drh411995d2002-06-25 19:31:18 +0000995** Change the datatype for all functions with a given name. See the
996** header comment for the prototype of this function in sqlite.h for
997** additional information.
drhc9b84a12002-06-20 11:36:48 +0000998*/
999int sqlite_function_type(sqlite *db, const char *zName, int dataType){
1000 FuncDef *p = (FuncDef*)sqliteHashFind(&db->aFunc, zName, strlen(zName));
1001 while( p ){
1002 p->dataType = dataType;
1003 p = p->pNext;
1004 }
drhf46f9052002-06-22 02:33:38 +00001005 return SQLITE_OK;
drhc9b84a12002-06-20 11:36:48 +00001006}
drh411995d2002-06-25 19:31:18 +00001007
1008/*
drh18de4822003-01-16 16:28:53 +00001009** Register a trace function. The pArg from the previously registered trace
1010** is returned.
1011**
1012** A NULL trace function means that no tracing is executes. A non-NULL
1013** trace is a pointer to a function that is invoked at the start of each
1014** sqlite_exec().
1015*/
1016void *sqlite_trace(sqlite *db, void (*xTrace)(void*,const char*), void *pArg){
1017#ifndef SQLITE_OMIT_TRACE
1018 void *pOld = db->pTraceArg;
1019 db->xTrace = xTrace;
1020 db->pTraceArg = pArg;
1021 return pOld;
1022#else
1023 return 0;
1024#endif
1025}