blob: ee79bfdb9b22319ace6aba884180194373123420 [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**
drh411995d2002-06-25 19:31:18 +000017** $Id: main.c,v 1.85 2002/06/25 19:31:18 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/*
24** This is the callback routine for the code that initializes the
drh382c0242001-10-06 16:33:02 +000025** database. See sqliteInit() below for additional information.
26**
27** Each callback contains the following information:
drh28037572000-08-02 13:47:41 +000028**
drh4a324312001-12-21 14:30:42 +000029** argv[0] = "file-format" or "schema-cookie" or "table" or "index"
drhe3c41372001-09-17 20:25:58 +000030** argv[1] = table or index name or meta statement type.
31** argv[2] = root page number for table or index. NULL for meta.
drhadbca9c2001-09-27 15:11:53 +000032** argv[3] = SQL create statement for the table or index
drhe0bc4042002-06-25 01:09:11 +000033** argv[4] = "1" for temporary files, "0" for main database
drhd78eeee2001-09-13 16:18:53 +000034**
drh75897232000-05-29 14:26:00 +000035*/
drhe0140fc2002-06-16 18:21:44 +000036int sqliteInitCallback(void *pDb, int argc, char **argv, char **azColName){
drh75897232000-05-29 14:26:00 +000037 sqlite *db = (sqlite*)pDb;
38 Parse sParse;
drhd78eeee2001-09-13 16:18:53 +000039 int nErr = 0;
drh75897232000-05-29 14:26:00 +000040
drh382c0242001-10-06 16:33:02 +000041 /* TODO: Do some validity checks on all fields. In particular,
42 ** make sure fields do not contain NULLs. Otherwise we might core
43 ** when attempting to initialize from a corrupt database file. */
drhe3c41372001-09-17 20:25:58 +000044
drhe0bc4042002-06-25 01:09:11 +000045 assert( argc==5 );
drhd78eeee2001-09-13 16:18:53 +000046 switch( argv[0][0] ){
drh17f71932002-02-21 12:01:27 +000047 case 'v':
drhd78eeee2001-09-13 16:18:53 +000048 case 'i':
drh17f71932002-02-21 12:01:27 +000049 case 't': { /* CREATE TABLE, CREATE INDEX, or CREATE VIEW statements */
drhadbca9c2001-09-27 15:11:53 +000050 if( argv[3] && argv[3][0] ){
drh17f71932002-02-21 12:01:27 +000051 /* Call the parser to process a CREATE TABLE, INDEX or VIEW.
drh382c0242001-10-06 16:33:02 +000052 ** But because sParse.initFlag is set to 1, no VDBE code is generated
53 ** or executed. All the parser does is build the internal data
drh17f71932002-02-21 12:01:27 +000054 ** structures that describe the table, index, or view.
drh382c0242001-10-06 16:33:02 +000055 */
drhadbca9c2001-09-27 15:11:53 +000056 memset(&sParse, 0, sizeof(sParse));
57 sParse.db = db;
58 sParse.initFlag = 1;
drhe0bc4042002-06-25 01:09:11 +000059 sParse.isTemp = argv[4][0] - '0';
drhadbca9c2001-09-27 15:11:53 +000060 sParse.newTnum = atoi(argv[2]);
drhf5bf0a72001-11-23 00:24:12 +000061 sqliteRunParser(&sParse, argv[3], 0);
drhadbca9c2001-09-27 15:11:53 +000062 }else{
drh382c0242001-10-06 16:33:02 +000063 /* If the SQL column is blank it means this is an index that
64 ** was created to be the PRIMARY KEY or to fulfill a UNIQUE
drhaacc5432002-01-06 17:07:40 +000065 ** constraint for a CREATE TABLE. The index should have already
drh382c0242001-10-06 16:33:02 +000066 ** been created when we processed the CREATE TABLE. All we have
drhaacc5432002-01-06 17:07:40 +000067 ** to do here is record the root page number for that index.
drh382c0242001-10-06 16:33:02 +000068 */
drhadbca9c2001-09-27 15:11:53 +000069 Index *pIndex = sqliteFindIndex(db, argv[1]);
70 if( pIndex==0 || pIndex->tnum!=0 ){
drhda9e0342002-01-10 14:31:48 +000071 /* This can occur if there exists an index on a TEMP table which
72 ** has the same name as another index on a permanent index. Since
73 ** the permanent table is hidden by the TEMP table, we can also
74 ** safely ignore the index on the permanent table.
75 */
76 /* Do Nothing */;
drhadbca9c2001-09-27 15:11:53 +000077 }else{
78 pIndex->tnum = atoi(argv[2]);
79 }
80 }
drhd78eeee2001-09-13 16:18:53 +000081 break;
82 }
83 default: {
84 /* This can not happen! */
85 nErr = 1;
86 assert( nErr==0 );
87 }
drh28037572000-08-02 13:47:41 +000088 }
drh75897232000-05-29 14:26:00 +000089 return nErr;
90}
91
92/*
drh58b95762000-06-02 01:17:37 +000093** Attempt to read the database schema and initialize internal
94** data structures. Return one of the SQLITE_ error codes to
95** indicate success or failure.
drhbed86902000-06-02 13:27:59 +000096**
97** After the database is initialized, the SQLITE_Initialized
98** bit is set in the flags field of the sqlite structure. An
99** attempt is made to initialize the database as soon as it
100** is opened. If that fails (perhaps because another process
101** has the sqlite_master table locked) than another attempt
102** is made the first time the database is accessed.
drh75897232000-05-29 14:26:00 +0000103*/
drhe0bc4042002-06-25 01:09:11 +0000104int sqliteInit(sqlite *db, char **pzErrMsg){
drh58b95762000-06-02 01:17:37 +0000105 int rc;
drhe0bc4042002-06-25 01:09:11 +0000106 BtCursor *curMain;
107 int size;
108 Table *pTab;
109 char *azArg[6];
110 int meta[SQLITE_N_BTREE_META];
111 Parse sParse;
drh58b95762000-06-02 01:17:37 +0000112
113 /*
114 ** The master database table has a structure like this
115 */
drh75897232000-05-29 14:26:00 +0000116 static char master_schema[] =
drhe0bc4042002-06-25 01:09:11 +0000117 "CREATE TABLE sqlite_master(\n"
118 " type text,\n"
119 " name text,\n"
120 " tbl_name text,\n"
121 " rootpage integer,\n"
122 " sql text\n"
123 ")"
124 ;
125 static char temp_master_schema[] =
126 "CREATE TEMP TABLE sqlite_temp_master(\n"
drh75897232000-05-29 14:26:00 +0000127 " type text,\n"
128 " name text,\n"
129 " tbl_name text,\n"
drhadbca9c2001-09-27 15:11:53 +0000130 " rootpage integer,\n"
drh75897232000-05-29 14:26:00 +0000131 " sql text\n"
132 ")"
133 ;
134
drhe0bc4042002-06-25 01:09:11 +0000135 /* The following SQL will read the schema from the master tables.
136 ** The first version works with SQLite file formats 2 or greater.
137 ** The second version is for format 1 files.
drh75897232000-05-29 14:26:00 +0000138 **
drhe0bc4042002-06-25 01:09:11 +0000139 ** Beginning with file format 2, the rowid for new table entries
140 ** (including entries in sqlite_master) is an increasing integer.
141 ** So for file format 2 and later, we can play back sqlite_master
142 ** and all the CREATE statements will appear in the right order.
143 ** But with file format 1, table entries were random and so we
144 ** have to make sure the CREATE TABLEs occur before their corresponding
145 ** CREATE INDEXs. (We don't have to deal with CREATE VIEW or
146 ** CREATE TRIGGER in file format 1 because those constructs did
147 ** not exist then.)
drh75897232000-05-29 14:26:00 +0000148 */
drhe0bc4042002-06-25 01:09:11 +0000149 static char init_script[] =
150 "SELECT type, name, rootpage, sql, 1 FROM sqlite_temp_master "
151 "UNION ALL "
152 "SELECT type, name, rootpage, sql, 0 FROM sqlite_master";
153 static char older_init_script[] =
154 "SELECT type, name, rootpage, sql, 1 FROM sqlite_temp_master "
155 "UNION ALL "
156 "SELECT type, name, rootpage, sql, 0 FROM sqlite_master "
157 "WHERE type='table' "
158 "UNION ALL "
159 "SELECT type, name, rootpage, sql, 0 FROM sqlite_master "
160 "WHERE type='index'";
drh17f71932002-02-21 12:01:27 +0000161
drh603240c2002-03-05 01:11:12 +0000162
drhe0bc4042002-06-25 01:09:11 +0000163 /* Construct the schema tables: sqlite_master and sqlite_temp_master
drh58b95762000-06-02 01:17:37 +0000164 */
drhe0bc4042002-06-25 01:09:11 +0000165 azArg[0] = "table";
166 azArg[1] = MASTER_NAME;
167 azArg[2] = "2";
168 azArg[3] = master_schema;
169 azArg[4] = "0";
170 azArg[5] = 0;
171 sqliteInitCallback(db, 5, azArg, 0);
172 pTab = sqliteFindTable(db, MASTER_NAME);
173 if( pTab ){
174 pTab->readOnly = 1;
drhd8bc7082000-06-07 23:51:50 +0000175 }
drhe0bc4042002-06-25 01:09:11 +0000176 azArg[1] = TEMP_MASTER_NAME;
177 azArg[3] = temp_master_schema;
178 azArg[4] = "1";
179 sqliteInitCallback(db, 5, azArg, 0);
180 pTab = sqliteFindTable(db, TEMP_MASTER_NAME);
181 if( pTab ){
182 pTab->readOnly = 1;
183 }
184
185 /* Create a cursor to hold the database open
186 */
187 if( db->pBe==0 ) return SQLITE_OK;
188 rc = sqliteBtreeCursor(db->pBe, 2, 0, &curMain);
189 if( rc ) return rc;
190
191 /* Get the database meta information
192 */
193 rc = sqliteBtreeGetMeta(db->pBe, meta);
194 if( rc ){
195 sqliteBtreeCloseCursor(curMain);
196 return rc;
197 }
198 db->schema_cookie = meta[1];
199 db->next_cookie = db->schema_cookie;
200 db->file_format = meta[2];
201 size = meta[3];
202 if( size==0 ){ size = MAX_PAGES; }
203 db->cache_size = size;
204 sqliteBtreeSetCacheSize(db->pBe, size);
205
206 /*
207 ** file_format==1 Version 2.1.0.
208 ** file_format==2 Version 2.2.0. Add support for INTEGER PRIMARY KEY.
209 ** file_format==3 Version 2.6.0. Add support for separate numeric and
210 ** text datatypes.
211 */
212 if( db->file_format==0 ){
drh17f71932002-02-21 12:01:27 +0000213 db->file_format = 2;
drhe0bc4042002-06-25 01:09:11 +0000214 }else if( db->file_format>2 ){
215 sqliteBtreeCloseCursor(curMain);
drhd78eeee2001-09-13 16:18:53 +0000216 sqliteSetString(pzErrMsg, "unsupported file format", 0);
drh28037572000-08-02 13:47:41 +0000217 rc = SQLITE_ERROR;
218 }
drhaacc5432002-01-06 17:07:40 +0000219
drhe0bc4042002-06-25 01:09:11 +0000220 /* Read the schema information out of the schema tables
drhaacc5432002-01-06 17:07:40 +0000221 */
drhe0bc4042002-06-25 01:09:11 +0000222 memset(&sParse, 0, sizeof(sParse));
223 sParse.db = db;
224 sParse.pBe = db->pBe;
225 sParse.xCallback = sqliteInitCallback;
226 sParse.pArg = (void*)db;
227 sParse.initFlag = 1;
228 sqliteRunParser(&sParse,
229 db->file_format>=2 ? init_script : older_init_script,
230 pzErrMsg);
231 if( sqlite_malloc_failed ){
232 sqliteSetString(pzErrMsg, "out of memory", 0);
233 sParse.rc = SQLITE_NOMEM;
234 sqliteBtreeRollback(db->pBe);
235 sqliteResetInternalSchema(db);
236 }
237 if( sParse.rc==SQLITE_OK ){
drh58b95762000-06-02 01:17:37 +0000238 db->flags |= SQLITE_Initialized;
drh5e00f6c2001-09-13 13:46:56 +0000239 sqliteCommitInternalChanges(db);
drhe0bc4042002-06-25 01:09:11 +0000240 }else{
241 db->flags &= ~SQLITE_Initialized;
242 sqliteResetInternalSchema(db);
drh58b95762000-06-02 01:17:37 +0000243 }
drhe0bc4042002-06-25 01:09:11 +0000244 sqliteBtreeCloseCursor(curMain);
245 return sParse.rc;
drh58b95762000-06-02 01:17:37 +0000246}
247
248/*
drhb217a572000-08-22 13:40:18 +0000249** The version of the library
250*/
drh3d0b5592000-08-22 13:40:51 +0000251const char sqlite_version[] = SQLITE_VERSION;
drhb217a572000-08-22 13:40:18 +0000252
253/*
drh297ecf12001-04-05 15:57:13 +0000254** Does the library expect data to be encoded as UTF-8 or iso8859? The
255** following global constant always lets us know.
256*/
257#ifdef SQLITE_UTF8
drhfbc3eab2001-04-06 16:13:42 +0000258const char sqlite_encoding[] = "UTF-8";
drh297ecf12001-04-05 15:57:13 +0000259#else
drhfbc3eab2001-04-06 16:13:42 +0000260const char sqlite_encoding[] = "iso8859";
drh297ecf12001-04-05 15:57:13 +0000261#endif
262
263/*
drh58b95762000-06-02 01:17:37 +0000264** Open a new SQLite database. Construct an "sqlite" structure to define
265** the state of this database and return a pointer to that structure.
266**
267** An attempt is made to initialize the in-memory data structures that
268** hold the database schema. But if this fails (because the schema file
269** is locked) then that step is deferred until the first call to
270** sqlite_exec().
271*/
272sqlite *sqlite_open(const char *zFilename, int mode, char **pzErrMsg){
273 sqlite *db;
274 int rc;
275
276 /* Allocate the sqlite data structure */
drh75897232000-05-29 14:26:00 +0000277 db = sqliteMalloc( sizeof(sqlite) );
278 if( pzErrMsg ) *pzErrMsg = 0;
drhdaffd0e2001-04-11 14:28:42 +0000279 if( db==0 ) goto no_mem_on_open;
drhbeae3192001-09-22 18:12:08 +0000280 sqliteHashInit(&db->tblHash, SQLITE_HASH_STRING, 0);
281 sqliteHashInit(&db->idxHash, SQLITE_HASH_STRING, 0);
danielk1977c3f9bad2002-05-15 08:30:12 +0000282 sqliteHashInit(&db->trigHash, SQLITE_HASH_STRING, 0);
drh0bce8352002-02-28 00:41:10 +0000283 sqliteHashInit(&db->aFunc, SQLITE_HASH_STRING, 1);
drh28f4b682002-06-09 10:14:18 +0000284 sqliteRegisterBuiltinFunctions(db);
drh1c928532002-01-31 15:54:21 +0000285 db->onError = OE_Default;
drh5cf8e8c2002-02-19 22:42:05 +0000286 db->priorNewRowid = 0;
drh247be432002-05-10 05:44:55 +0000287 db->magic = SQLITE_MAGIC_BUSY;
drh75897232000-05-29 14:26:00 +0000288
289 /* Open the backend database driver */
drha1b351a2001-09-14 16:42:12 +0000290 rc = sqliteBtreeOpen(zFilename, mode, MAX_PAGES, &db->pBe);
drh5e00f6c2001-09-13 13:46:56 +0000291 if( rc!=SQLITE_OK ){
292 switch( rc ){
293 default: {
drhaacc5432002-01-06 17:07:40 +0000294 sqliteSetString(pzErrMsg, "unable to open database: ", zFilename, 0);
drh5e00f6c2001-09-13 13:46:56 +0000295 }
296 }
drh75897232000-05-29 14:26:00 +0000297 sqliteFree(db);
drh5edc3122001-09-13 21:53:09 +0000298 sqliteStrRealloc(pzErrMsg);
drhbe0072d2001-09-13 14:46:09 +0000299 return 0;
drh75897232000-05-29 14:26:00 +0000300 }
301
drh58b95762000-06-02 01:17:37 +0000302 /* Attempt to read the schema */
303 rc = sqliteInit(db, pzErrMsg);
drhc67980b2002-06-14 20:54:14 +0000304 db->magic = SQLITE_MAGIC_OPEN;
drhdaffd0e2001-04-11 14:28:42 +0000305 if( sqlite_malloc_failed ){
drh6d4abfb2001-10-22 02:58:08 +0000306 sqlite_close(db);
drhdaffd0e2001-04-11 14:28:42 +0000307 goto no_mem_on_open;
308 }else if( rc!=SQLITE_OK && rc!=SQLITE_BUSY ){
drh58b95762000-06-02 01:17:37 +0000309 sqlite_close(db);
drh5edc3122001-09-13 21:53:09 +0000310 sqliteStrRealloc(pzErrMsg);
drh58b95762000-06-02 01:17:37 +0000311 return 0;
drhaacc5432002-01-06 17:07:40 +0000312 }else if( pzErrMsg ){
drhdaffd0e2001-04-11 14:28:42 +0000313 sqliteFree(*pzErrMsg);
drhbed86902000-06-02 13:27:59 +0000314 *pzErrMsg = 0;
drh75897232000-05-29 14:26:00 +0000315 }
drh75897232000-05-29 14:26:00 +0000316 return db;
drhdaffd0e2001-04-11 14:28:42 +0000317
318no_mem_on_open:
319 sqliteSetString(pzErrMsg, "out of memory", 0);
320 sqliteStrRealloc(pzErrMsg);
321 return 0;
drh75897232000-05-29 14:26:00 +0000322}
323
324/*
drhaf9ff332002-01-16 21:00:27 +0000325** Return the ROWID of the most recent insert
326*/
327int sqlite_last_insert_rowid(sqlite *db){
328 return db->lastRowid;
329}
330
331/*
drhc8d30ac2002-04-12 10:08:59 +0000332** Return the number of changes in the most recent call to sqlite_exec().
333*/
334int sqlite_changes(sqlite *db){
335 return db->nChange;
336}
337
338/*
drh50e5dad2001-09-15 00:57:28 +0000339** Close an existing SQLite database
340*/
341void sqlite_close(sqlite *db){
drh8e0a2f92002-02-23 23:45:45 +0000342 HashElem *i;
drhc22bd472002-05-10 13:14:07 +0000343 if( sqliteSafetyCheck(db) || sqliteSafetyOn(db) ){ return; }
drh247be432002-05-10 05:44:55 +0000344 db->magic = SQLITE_MAGIC_CLOSED;
drh50e5dad2001-09-15 00:57:28 +0000345 sqliteBtreeClose(db->pBe);
drhe0bc4042002-06-25 01:09:11 +0000346 sqliteResetInternalSchema(db);
drhf57b3392001-10-08 13:22:32 +0000347 if( db->pBeTemp ){
348 sqliteBtreeClose(db->pBeTemp);
349 }
drh0bce8352002-02-28 00:41:10 +0000350 for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
351 FuncDef *pFunc, *pNext;
352 for(pFunc = (FuncDef*)sqliteHashData(i); pFunc; pFunc=pNext){
drh8e0a2f92002-02-23 23:45:45 +0000353 pNext = pFunc->pNext;
354 sqliteFree(pFunc);
355 }
356 }
drh0bce8352002-02-28 00:41:10 +0000357 sqliteHashClear(&db->aFunc);
drh75897232000-05-29 14:26:00 +0000358 sqliteFree(db);
359}
360
361/*
362** Return TRUE if the given SQL string ends in a semicolon.
drhce9079c2002-05-15 14:17:44 +0000363**
364** Special handling is require for CREATE TRIGGER statements.
365** Whenever the CREATE TRIGGER keywords are seen, the statement
366** must end with ";END;".
drh75897232000-05-29 14:26:00 +0000367*/
368int sqlite_complete(const char *zSql){
drhce9079c2002-05-15 14:17:44 +0000369 int isComplete = 1;
370 int requireEnd = 0;
371 int seenText = 0;
danielk1977c3f9bad2002-05-15 08:30:12 +0000372 int seenCreate = 0;
drh8c82b352000-12-10 18:23:50 +0000373 while( *zSql ){
374 switch( *zSql ){
375 case ';': {
376 isComplete = 1;
drhce9079c2002-05-15 14:17:44 +0000377 seenText = 1;
378 seenCreate = 0;
drh75897232000-05-29 14:26:00 +0000379 break;
drh8c82b352000-12-10 18:23:50 +0000380 }
381 case ' ':
382 case '\t':
383 case '\n':
384 case '\f': {
drh75897232000-05-29 14:26:00 +0000385 break;
drh8c82b352000-12-10 18:23:50 +0000386 }
drh969fa7c2002-02-18 18:30:32 +0000387 case '[': {
388 isComplete = 0;
drhce9079c2002-05-15 14:17:44 +0000389 seenText = 1;
390 seenCreate = 0;
drh969fa7c2002-02-18 18:30:32 +0000391 zSql++;
392 while( *zSql && *zSql!=']' ){ zSql++; }
393 if( *zSql==0 ) return 0;
394 break;
395 }
drhce9079c2002-05-15 14:17:44 +0000396 case '"':
drh8c82b352000-12-10 18:23:50 +0000397 case '\'': {
drhce9079c2002-05-15 14:17:44 +0000398 int c = *zSql;
drh8c82b352000-12-10 18:23:50 +0000399 isComplete = 0;
drhce9079c2002-05-15 14:17:44 +0000400 seenText = 1;
401 seenCreate = 0;
drh8c82b352000-12-10 18:23:50 +0000402 zSql++;
drhce9079c2002-05-15 14:17:44 +0000403 while( *zSql && *zSql!=c ){ zSql++; }
drh8c82b352000-12-10 18:23:50 +0000404 if( *zSql==0 ) return 0;
405 break;
406 }
407 case '-': {
408 if( zSql[1]!='-' ){
409 isComplete = 0;
drhce9079c2002-05-15 14:17:44 +0000410 seenCreate = 0;
drh8c82b352000-12-10 18:23:50 +0000411 break;
412 }
413 while( *zSql && *zSql!='\n' ){ zSql++; }
drhce9079c2002-05-15 14:17:44 +0000414 if( *zSql==0 ) return seenText && isComplete && requireEnd==0;
415 break;
416 }
417 case 'c':
418 case 'C': {
419 seenText = 1;
420 if( !isComplete ) break;
421 isComplete = 0;
422 if( sqliteStrNICmp(zSql, "create", 6)!=0 ) break;
423 if( !isspace(zSql[6]) ) break;
424 zSql += 5;
425 seenCreate = 1;
426 while( isspace(zSql[1]) ) zSql++;
427 if( sqliteStrNICmp(&zSql[1],"trigger", 7)!=0 ) break;
428 zSql += 7;
429 requireEnd++;
430 break;
431 }
432 case 't':
433 case 'T': {
434 seenText = 1;
435 if( !seenCreate ) break;
436 seenCreate = 0;
437 isComplete = 0;
438 if( sqliteStrNICmp(zSql, "trigger", 7)!=0 ) break;
439 if( !isspace(zSql[7]) ) break;
440 zSql += 6;
441 requireEnd++;
442 break;
443 }
444 case 'e':
445 case 'E': {
446 seenCreate = 0;
447 seenText = 1;
448 if( !isComplete ) break;
449 isComplete = 0;
450 if( requireEnd==0 ) break;
451 if( sqliteStrNICmp(zSql, "end", 3)!=0 ) break;
452 zSql += 2;
453 while( isspace(zSql[1]) ) zSql++;
454 if( zSql[1]==';' ){
455 zSql++;
456 isComplete = 1;
457 requireEnd--;
458 }
drh8c82b352000-12-10 18:23:50 +0000459 break;
drh9adf9ac2002-05-15 11:44:13 +0000460 }
drh8c82b352000-12-10 18:23:50 +0000461 default: {
drhce9079c2002-05-15 14:17:44 +0000462 seenCreate = 0;
463 seenText = 1;
drh8c82b352000-12-10 18:23:50 +0000464 isComplete = 0;
465 break;
466 }
drh75897232000-05-29 14:26:00 +0000467 }
drh8c82b352000-12-10 18:23:50 +0000468 zSql++;
drh75897232000-05-29 14:26:00 +0000469 }
drhce9079c2002-05-15 14:17:44 +0000470 return seenText && isComplete && requireEnd==0;
drh75897232000-05-29 14:26:00 +0000471}
472
473/*
drhbed86902000-06-02 13:27:59 +0000474** Execute SQL code. Return one of the SQLITE_ success/failure
475** codes. Also write an error message into memory obtained from
476** malloc() and make *pzErrMsg point to that message.
477**
478** If the SQL is a query, then for each row in the query result
479** the xCallback() function is called. pArg becomes the first
480** argument to xCallback(). If xCallback=NULL then no callback
481** is invoked, even for queries.
drh75897232000-05-29 14:26:00 +0000482*/
483int sqlite_exec(
484 sqlite *db, /* The database on which the SQL executes */
drh9f71c2e2001-11-03 23:57:09 +0000485 const char *zSql, /* The SQL to be executed */
drh75897232000-05-29 14:26:00 +0000486 sqlite_callback xCallback, /* Invoke this callback routine */
487 void *pArg, /* First argument to xCallback() */
488 char **pzErrMsg /* Write error messages here */
489){
490 Parse sParse;
drh75897232000-05-29 14:26:00 +0000491
492 if( pzErrMsg ) *pzErrMsg = 0;
drhc22bd472002-05-10 13:14:07 +0000493 if( sqliteSafetyOn(db) ) goto exec_misuse;
drh58b95762000-06-02 01:17:37 +0000494 if( (db->flags & SQLITE_Initialized)==0 ){
495 int rc = sqliteInit(db, pzErrMsg);
drhdaffd0e2001-04-11 14:28:42 +0000496 if( rc!=SQLITE_OK ){
497 sqliteStrRealloc(pzErrMsg);
drh247be432002-05-10 05:44:55 +0000498 sqliteSafetyOff(db);
drhdaffd0e2001-04-11 14:28:42 +0000499 return rc;
500 }
drh58b95762000-06-02 01:17:37 +0000501 }
drhc8d30ac2002-04-12 10:08:59 +0000502 if( db->recursionDepth==0 ){ db->nChange = 0; }
503 db->recursionDepth++;
drh75897232000-05-29 14:26:00 +0000504 memset(&sParse, 0, sizeof(sParse));
505 sParse.db = db;
drh5e00f6c2001-09-13 13:46:56 +0000506 sParse.pBe = db->pBe;
drh75897232000-05-29 14:26:00 +0000507 sParse.xCallback = xCallback;
508 sParse.pArg = pArg;
drh4c504392000-10-16 22:06:40 +0000509 sqliteRunParser(&sParse, zSql, pzErrMsg);
drhdaffd0e2001-04-11 14:28:42 +0000510 if( sqlite_malloc_failed ){
511 sqliteSetString(pzErrMsg, "out of memory", 0);
512 sParse.rc = SQLITE_NOMEM;
drh6d4abfb2001-10-22 02:58:08 +0000513 sqliteBtreeRollback(db->pBe);
514 if( db->pBeTemp ) sqliteBtreeRollback(db->pBeTemp);
515 db->flags &= ~SQLITE_InTrans;
drhe0bc4042002-06-25 01:09:11 +0000516 sqliteResetInternalSchema(db);
drhdaffd0e2001-04-11 14:28:42 +0000517 }
518 sqliteStrRealloc(pzErrMsg);
drh50e5dad2001-09-15 00:57:28 +0000519 if( sParse.rc==SQLITE_SCHEMA ){
drhe0bc4042002-06-25 01:09:11 +0000520 sqliteResetInternalSchema(db);
drh50e5dad2001-09-15 00:57:28 +0000521 }
drhc8d30ac2002-04-12 10:08:59 +0000522 db->recursionDepth--;
drhc22bd472002-05-10 13:14:07 +0000523 if( sqliteSafetyOff(db) ) goto exec_misuse;
drh4c504392000-10-16 22:06:40 +0000524 return sParse.rc;
drhc22bd472002-05-10 13:14:07 +0000525
526exec_misuse:
527 if( pzErrMsg ){
528 *pzErrMsg = 0;
529 sqliteSetString(pzErrMsg, sqlite_error_string(SQLITE_MISUSE), 0);
530 sqliteStrRealloc(pzErrMsg);
531 }
532 return SQLITE_MISUSE;
drh75897232000-05-29 14:26:00 +0000533}
drh2dfbbca2000-07-28 14:32:48 +0000534
535/*
drhc22bd472002-05-10 13:14:07 +0000536** Return a static string that describes the kind of error specified in the
537** argument.
drh247be432002-05-10 05:44:55 +0000538*/
drhc22bd472002-05-10 13:14:07 +0000539const char *sqlite_error_string(int rc){
540 const char *z;
541 switch( rc ){
542 case SQLITE_OK: z = "not an error"; break;
543 case SQLITE_ERROR: z = "SQL logic error or missing database"; break;
544 case SQLITE_INTERNAL: z = "internal SQLite implementation flaw"; break;
545 case SQLITE_PERM: z = "access permission denied"; break;
546 case SQLITE_ABORT: z = "callback requested query abort"; break;
547 case SQLITE_BUSY: z = "database is locked"; break;
548 case SQLITE_LOCKED: z = "database table is locked"; break;
549 case SQLITE_NOMEM: z = "out of memory"; break;
550 case SQLITE_READONLY: z = "attempt to write a readonly database"; break;
551 case SQLITE_INTERRUPT: z = "interrupted"; break;
552 case SQLITE_IOERR: z = "disk I/O error"; break;
553 case SQLITE_CORRUPT: z = "database disk image is malformed"; break;
554 case SQLITE_NOTFOUND: z = "table or record not found"; break;
555 case SQLITE_FULL: z = "database is full"; break;
556 case SQLITE_CANTOPEN: z = "unable to open database file"; break;
557 case SQLITE_PROTOCOL: z = "database locking protocol failure"; break;
558 case SQLITE_EMPTY: z = "table contains no data"; break;
559 case SQLITE_SCHEMA: z = "database schema has changed"; break;
560 case SQLITE_TOOBIG: z = "too much data for one table row"; break;
561 case SQLITE_CONSTRAINT: z = "constraint failed"; break;
562 case SQLITE_MISMATCH: z = "datatype mismatch"; break;
563 case SQLITE_MISUSE: z = "library routine called out of sequence";break;
564 default: z = "unknown error"; break;
drh247be432002-05-10 05:44:55 +0000565 }
drhc22bd472002-05-10 13:14:07 +0000566 return z;
drh247be432002-05-10 05:44:55 +0000567}
568
569/*
drh2dfbbca2000-07-28 14:32:48 +0000570** This routine implements a busy callback that sleeps and tries
571** again until a timeout value is reached. The timeout value is
572** an integer number of milliseconds passed in as the first
573** argument.
574*/
drhdaffd0e2001-04-11 14:28:42 +0000575static int sqliteDefaultBusyCallback(
drh2dfbbca2000-07-28 14:32:48 +0000576 void *Timeout, /* Maximum amount of time to wait */
577 const char *NotUsed, /* The name of the table that is busy */
578 int count /* Number of times table has been busy */
579){
drh8cfbf082001-09-19 13:22:39 +0000580#if SQLITE_MIN_SLEEP_MS==1
581 int delay = 10;
drh2dfbbca2000-07-28 14:32:48 +0000582 int prior_delay = 0;
583 int timeout = (int)Timeout;
584 int i;
585
586 for(i=1; i<count; i++){
587 prior_delay += delay;
588 delay = delay*2;
drh8cfbf082001-09-19 13:22:39 +0000589 if( delay>=1000 ){
590 delay = 1000;
591 prior_delay += 1000*(count - i - 1);
drh2dfbbca2000-07-28 14:32:48 +0000592 break;
593 }
594 }
drh3109e022001-10-09 13:46:01 +0000595 if( prior_delay + delay > timeout ){
596 delay = timeout - prior_delay;
drh2dfbbca2000-07-28 14:32:48 +0000597 if( delay<=0 ) return 0;
598 }
drh8cfbf082001-09-19 13:22:39 +0000599 sqliteOsSleep(delay);
drh2dfbbca2000-07-28 14:32:48 +0000600 return 1;
601#else
602 int timeout = (int)Timeout;
603 if( (count+1)*1000 > timeout ){
604 return 0;
605 }
drh8cfbf082001-09-19 13:22:39 +0000606 sqliteOsSleep(1000);
drh2dfbbca2000-07-28 14:32:48 +0000607 return 1;
608#endif
609}
610
611/*
612** This routine sets the busy callback for an Sqlite database to the
613** given callback function with the given argument.
614*/
615void sqlite_busy_handler(
616 sqlite *db,
617 int (*xBusy)(void*,const char*,int),
618 void *pArg
619){
620 db->xBusyCallback = xBusy;
621 db->pBusyArg = pArg;
622}
623
624/*
625** This routine installs a default busy handler that waits for the
626** specified number of milliseconds before returning 0.
627*/
628void sqlite_busy_timeout(sqlite *db, int ms){
629 if( ms>0 ){
drhdaffd0e2001-04-11 14:28:42 +0000630 sqlite_busy_handler(db, sqliteDefaultBusyCallback, (void*)ms);
drh2dfbbca2000-07-28 14:32:48 +0000631 }else{
632 sqlite_busy_handler(db, 0, 0);
633 }
634}
drh4c504392000-10-16 22:06:40 +0000635
636/*
637** Cause any pending operation to stop at its earliest opportunity.
638*/
639void sqlite_interrupt(sqlite *db){
640 db->flags |= SQLITE_Interrupt;
641}
drhfa86c412002-02-02 15:01:15 +0000642
643/*
644** Windows systems should call this routine to free memory that
645** is returned in the in the errmsg parameter of sqlite_open() when
646** SQLite is a DLL. For some reason, it does not work to call free()
647** directly.
648**
649** Note that we need to call free() not sqliteFree() here, since every
650** string that is exported from SQLite should have already passed through
651** sqliteStrRealloc().
652*/
653void sqlite_freemem(void *p){ free(p); }
654
655/*
656** Windows systems need functions to call to return the sqlite_version
657** and sqlite_encoding strings.
658*/
659const char *sqlite_libversion(void){ return sqlite_version; }
660const char *sqlite_libencoding(void){ return sqlite_encoding; }
drh8e0a2f92002-02-23 23:45:45 +0000661
662/*
663** Create new user-defined functions. The sqlite_create_function()
664** routine creates a regular function and sqlite_create_aggregate()
665** creates an aggregate function.
666**
667** Passing a NULL xFunc argument or NULL xStep and xFinalize arguments
668** disables the function. Calling sqlite_create_function() with the
669** same name and number of arguments as a prior call to
670** sqlite_create_aggregate() disables the prior call to
671** sqlite_create_aggregate(), and vice versa.
672**
673** If nArg is -1 it means that this function will accept any number
674** of arguments, including 0.
675*/
676int sqlite_create_function(
677 sqlite *db, /* Add the function to this database connection */
678 const char *zName, /* Name of the function to add */
679 int nArg, /* Number of arguments */
drh1350b032002-02-27 19:00:20 +0000680 void (*xFunc)(sqlite_func*,int,const char**), /* The implementation */
681 void *pUserData /* User data */
drh8e0a2f92002-02-23 23:45:45 +0000682){
drh0bce8352002-02-28 00:41:10 +0000683 FuncDef *p;
drhc22bd472002-05-10 13:14:07 +0000684 if( db==0 || zName==0 || sqliteSafetyCheck(db) ) return 1;
drh0bce8352002-02-28 00:41:10 +0000685 p = sqliteFindFunction(db, zName, strlen(zName), nArg, 1);
drh4e0f9952002-02-27 01:53:13 +0000686 if( p==0 ) return 1;
drh8e0a2f92002-02-23 23:45:45 +0000687 p->xFunc = xFunc;
688 p->xStep = 0;
689 p->xFinalize = 0;
drh1350b032002-02-27 19:00:20 +0000690 p->pUserData = pUserData;
drh8e0a2f92002-02-23 23:45:45 +0000691 return 0;
692}
693int sqlite_create_aggregate(
694 sqlite *db, /* Add the function to this database connection */
695 const char *zName, /* Name of the function to add */
696 int nArg, /* Number of arguments */
drh1350b032002-02-27 19:00:20 +0000697 void (*xStep)(sqlite_func*,int,const char**), /* The step function */
698 void (*xFinalize)(sqlite_func*), /* The finalizer */
699 void *pUserData /* User data */
drh8e0a2f92002-02-23 23:45:45 +0000700){
drh0bce8352002-02-28 00:41:10 +0000701 FuncDef *p;
drhc22bd472002-05-10 13:14:07 +0000702 if( db==0 || zName==0 || sqliteSafetyCheck(db) ) return 1;
drh0bce8352002-02-28 00:41:10 +0000703 p = sqliteFindFunction(db, zName, strlen(zName), nArg, 1);
drh4e0f9952002-02-27 01:53:13 +0000704 if( p==0 ) return 1;
drh8e0a2f92002-02-23 23:45:45 +0000705 p->xFunc = 0;
706 p->xStep = xStep;
707 p->xFinalize = xFinalize;
drh1350b032002-02-27 19:00:20 +0000708 p->pUserData = pUserData;
drh8e0a2f92002-02-23 23:45:45 +0000709 return 0;
710}
drhc9b84a12002-06-20 11:36:48 +0000711
712/*
drh411995d2002-06-25 19:31:18 +0000713** Change the datatype for all functions with a given name. See the
714** header comment for the prototype of this function in sqlite.h for
715** additional information.
drhc9b84a12002-06-20 11:36:48 +0000716*/
717int sqlite_function_type(sqlite *db, const char *zName, int dataType){
718 FuncDef *p = (FuncDef*)sqliteHashFind(&db->aFunc, zName, strlen(zName));
719 while( p ){
720 p->dataType = dataType;
721 p = p->pNext;
722 }
drhf46f9052002-06-22 02:33:38 +0000723 return SQLITE_OK;
drhc9b84a12002-06-20 11:36:48 +0000724}
drh411995d2002-06-25 19:31:18 +0000725
726/*
727** Attempt to open the file named in the argument as the auxiliary database
728** file. The auxiliary database file is used to store TEMP tables. But
729** by using this API, it is possible to trick SQLite into opening two
730** separate databases and acting on them as if they were one.
731**
732** This routine closes the existing auxiliary database file, which will
733** cause any previously created TEMP tables to be created.
734**
735** The zName parameter can be a NULL pointer or an empty string to cause
736** a temporary file to be opened and automatically deleted when closed.
737*/
738int sqlite_open_aux_file(sqlite *db, const char *zName, char **pzErrMsg){
739 int rc;
740 if( zName && zName[0]==0 ) zName = 0;
741 if( sqliteSafetyOn(db) ) goto openaux_misuse;
742 sqliteResetInternalSchema(db);
743 if( db->pBeTemp!=0 ){
744 sqliteBtreeClose(db->pBeTemp);
745 }
746 rc = sqliteBtreeOpen(zName, 0, MAX_PAGES, &db->pBeTemp);
747 if( rc ){
748 if( zName==0 ) zName = "a temporary file";
749 sqliteSetString(pzErrMsg, "unable to open ", zName,
750 ": ", sqlite_error_string(rc), 0);
751 sqliteStrRealloc(pzErrMsg);
752 sqliteSafetyOff(db);
753 return rc;
754 }
755 rc = sqliteInit(db, pzErrMsg);
756 if( sqliteSafetyOff(db) ) goto openaux_misuse;
757 sqliteStrRealloc(pzErrMsg);
758 return rc;
759
760openaux_misuse:
761 sqliteSetString(pzErrMsg, sqlite_error_string(SQLITE_MISUSE), 0);
762 sqliteStrRealloc(pzErrMsg);
763 return SQLITE_MISUSE;
764}