blob: ba080fcf34993163c64764d72a241347215f3e65 [file] [log] [blame]
danielk1977fa256a32005-05-25 04:11:56 +00001/*
2** 2005 May 25
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** 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.
10**
11*************************************************************************
12** This file contains the implementation of the sqlite3_prepare()
13** interface, and routines that contribute to loading the database schema
14** from disk.
15**
drh3c84ddf2008-01-09 02:15:38 +000016** $Id: prepare.c,v 1.71 2008/01/09 02:15:39 drh Exp $
danielk1977fa256a32005-05-25 04:11:56 +000017*/
18#include "sqliteInt.h"
danielk1977fa256a32005-05-25 04:11:56 +000019#include <ctype.h>
20
21/*
22** Fill the InitData structure with an error message that indicates
23** that the database is corrupt.
24*/
25static void corruptSchema(InitData *pData, const char *zExtra){
drh17435752007-08-16 04:30:38 +000026 if( !pData->db->mallocFailed ){
danielk1977fa256a32005-05-25 04:11:56 +000027 sqlite3SetString(pData->pzErrMsg, "malformed database schema",
28 zExtra!=0 && zExtra[0]!=0 ? " - " : (char*)0, zExtra, (char*)0);
29 }
drh15ca1df2006-07-26 13:43:30 +000030 pData->rc = SQLITE_CORRUPT;
danielk1977fa256a32005-05-25 04:11:56 +000031}
32
33/*
34** This is the callback routine for the code that initializes the
35** database. See sqlite3Init() below for additional information.
36** This routine is also called from the OP_ParseSchema opcode of the VDBE.
37**
38** Each callback contains the following information:
39**
40** argv[0] = name of thing being created
danielk197778efaba2006-06-12 06:09:17 +000041** argv[1] = root page number for table or index. 0 for trigger or view.
danielk1977fa256a32005-05-25 04:11:56 +000042** argv[2] = SQL text for the CREATE statement.
danielk1977fa256a32005-05-25 04:11:56 +000043**
44*/
45int sqlite3InitCallback(void *pInit, int argc, char **argv, char **azColName){
46 InitData *pData = (InitData*)pInit;
47 sqlite3 *db = pData->db;
drhece3c722006-09-23 20:36:01 +000048 int iDb = pData->iDb;
danielk1977fa256a32005-05-25 04:11:56 +000049
drhb1ab8ea2007-08-29 00:33:07 +000050 assert( sqlite3_mutex_held(db->mutex) );
drh15ca1df2006-07-26 13:43:30 +000051 pData->rc = SQLITE_OK;
drhece3c722006-09-23 20:36:01 +000052 DbClearProperty(db, iDb, DB_Empty);
drh17435752007-08-16 04:30:38 +000053 if( db->mallocFailed ){
drhfe5a8162006-08-12 13:28:23 +000054 corruptSchema(pData, 0);
danielk1977da184232006-01-05 11:34:32 +000055 return SQLITE_NOMEM;
56 }
57
drhece3c722006-09-23 20:36:01 +000058 assert( argc==3 );
danielk1977fa256a32005-05-25 04:11:56 +000059 if( argv==0 ) return 0; /* Might happen if EMPTY_RESULT_CALLBACKS are on */
drhece3c722006-09-23 20:36:01 +000060 if( argv[1]==0 ){
danielk1977fa256a32005-05-25 04:11:56 +000061 corruptSchema(pData, 0);
62 return 1;
63 }
danielk1977fa256a32005-05-25 04:11:56 +000064 assert( iDb>=0 && iDb<db->nDb );
65 if( argv[2] && argv[2][0] ){
66 /* Call the parser to process a CREATE TABLE, INDEX or VIEW.
67 ** But because db->init.busy is set to 1, no VDBE code is generated
68 ** or executed. All the parser does is build the internal data
69 ** structures that describe the table, index, or view.
70 */
71 char *zErr;
72 int rc;
73 assert( db->init.busy );
74 db->init.iDb = iDb;
75 db->init.newTnum = atoi(argv[1]);
76 rc = sqlite3_exec(db, argv[2], 0, 0, &zErr);
77 db->init.iDb = 0;
drh43617e92006-03-06 20:55:46 +000078 assert( rc!=SQLITE_OK || zErr==0 );
danielk1977fa256a32005-05-25 04:11:56 +000079 if( SQLITE_OK!=rc ){
drh15ca1df2006-07-26 13:43:30 +000080 pData->rc = rc;
danielk1977261919c2005-12-06 12:52:59 +000081 if( rc==SQLITE_NOMEM ){
drh17435752007-08-16 04:30:38 +000082 db->mallocFailed = 1;
drh15ca1df2006-07-26 13:43:30 +000083 }else if( rc!=SQLITE_INTERRUPT ){
danielk19779e128002006-01-18 16:51:35 +000084 corruptSchema(pData, zErr);
danielk1977261919c2005-12-06 12:52:59 +000085 }
danielk1977fa256a32005-05-25 04:11:56 +000086 sqlite3_free(zErr);
drh15ca1df2006-07-26 13:43:30 +000087 return 1;
danielk1977fa256a32005-05-25 04:11:56 +000088 }
89 }else{
90 /* If the SQL column is blank it means this is an index that
91 ** was created to be the PRIMARY KEY or to fulfill a UNIQUE
92 ** constraint for a CREATE TABLE. The index should have already
93 ** been created when we processed the CREATE TABLE. All we have
94 ** to do here is record the root page number for that index.
95 */
96 Index *pIndex;
97 pIndex = sqlite3FindIndex(db, argv[0], db->aDb[iDb].zName);
98 if( pIndex==0 || pIndex->tnum!=0 ){
99 /* This can occur if there exists an index on a TEMP table which
100 ** has the same name as another index on a permanent index. Since
101 ** the permanent table is hidden by the TEMP table, we can also
102 ** safely ignore the index on the permanent table.
103 */
104 /* Do Nothing */;
105 }else{
106 pIndex->tnum = atoi(argv[1]);
107 }
108 }
109 return 0;
110}
111
112/*
113** Attempt to read the database schema and initialize internal
114** data structures for a single database file. The index of the
115** database file is given by iDb. iDb==0 is used for the main
116** database. iDb==1 should never be used. iDb>=2 is used for
117** auxiliary databases. Return one of the SQLITE_ error codes to
118** indicate success or failure.
119*/
120static int sqlite3InitOne(sqlite3 *db, int iDb, char **pzErrMsg){
121 int rc;
122 BtCursor *curMain;
123 int size;
124 Table *pTab;
drhfdd6e852005-12-16 01:06:16 +0000125 Db *pDb;
drhece3c722006-09-23 20:36:01 +0000126 char const *azArg[4];
danielk1977fa256a32005-05-25 04:11:56 +0000127 int meta[10];
128 InitData initData;
129 char const *zMasterSchema;
130 char const *zMasterName = SCHEMA_TABLE(iDb);
131
132 /*
133 ** The master database table has a structure like this
134 */
135 static const char master_schema[] =
136 "CREATE TABLE sqlite_master(\n"
137 " type text,\n"
138 " name text,\n"
139 " tbl_name text,\n"
140 " rootpage integer,\n"
141 " sql text\n"
142 ")"
143 ;
144#ifndef SQLITE_OMIT_TEMPDB
145 static const char temp_master_schema[] =
146 "CREATE TEMP TABLE sqlite_temp_master(\n"
147 " type text,\n"
148 " name text,\n"
149 " tbl_name text,\n"
150 " rootpage integer,\n"
151 " sql text\n"
152 ")"
153 ;
154#else
155 #define temp_master_schema 0
156#endif
157
158 assert( iDb>=0 && iDb<db->nDb );
danielk197714db2662006-01-09 16:12:04 +0000159 assert( db->aDb[iDb].pSchema );
drhb1ab8ea2007-08-29 00:33:07 +0000160 assert( sqlite3_mutex_held(db->mutex) );
danielk19774eab8b72007-12-27 15:12:16 +0000161 assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
danielk1977da184232006-01-05 11:34:32 +0000162
danielk1977fa256a32005-05-25 04:11:56 +0000163 /* zMasterSchema and zInitScript are set to point at the master schema
164 ** and initialisation script appropriate for the database being
165 ** initialised. zMasterName is the name of the master table.
166 */
167 if( !OMIT_TEMPDB && iDb==1 ){
168 zMasterSchema = temp_master_schema;
169 }else{
170 zMasterSchema = master_schema;
171 }
172 zMasterName = SCHEMA_TABLE(iDb);
173
174 /* Construct the schema tables. */
175 sqlite3SafetyOff(db);
176 azArg[0] = zMasterName;
177 azArg[1] = "1";
178 azArg[2] = zMasterSchema;
drhece3c722006-09-23 20:36:01 +0000179 azArg[3] = 0;
danielk1977fa256a32005-05-25 04:11:56 +0000180 initData.db = db;
drhece3c722006-09-23 20:36:01 +0000181 initData.iDb = iDb;
danielk1977fa256a32005-05-25 04:11:56 +0000182 initData.pzErrMsg = pzErrMsg;
drhece3c722006-09-23 20:36:01 +0000183 rc = sqlite3InitCallback(&initData, 3, (char **)azArg, 0);
drh15ca1df2006-07-26 13:43:30 +0000184 if( rc ){
danielk1977fa256a32005-05-25 04:11:56 +0000185 sqlite3SafetyOn(db);
danielk1977a1644fd2007-08-29 12:31:25 +0000186 rc = initData.rc;
187 goto error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000188 }
189 pTab = sqlite3FindTable(db, zMasterName, db->aDb[iDb].zName);
190 if( pTab ){
191 pTab->readOnly = 1;
192 }
193 sqlite3SafetyOn(db);
194
195 /* Create a cursor to hold the database open
196 */
drhfdd6e852005-12-16 01:06:16 +0000197 pDb = &db->aDb[iDb];
198 if( pDb->pBt==0 ){
danielk1977b82e7ed2006-01-11 14:09:31 +0000199 if( !OMIT_TEMPDB && iDb==1 ){
200 DbSetProperty(db, 1, DB_SchemaLoaded);
201 }
danielk1977fa256a32005-05-25 04:11:56 +0000202 return SQLITE_OK;
203 }
drhb1ab8ea2007-08-29 00:33:07 +0000204 sqlite3BtreeEnter(pDb->pBt);
drhfdd6e852005-12-16 01:06:16 +0000205 rc = sqlite3BtreeCursor(pDb->pBt, MASTER_ROOT, 0, 0, 0, &curMain);
danielk1977fa256a32005-05-25 04:11:56 +0000206 if( rc!=SQLITE_OK && rc!=SQLITE_EMPTY ){
207 sqlite3SetString(pzErrMsg, sqlite3ErrStr(rc), (char*)0);
drhb1ab8ea2007-08-29 00:33:07 +0000208 sqlite3BtreeLeave(pDb->pBt);
danielk1977a1644fd2007-08-29 12:31:25 +0000209 goto error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000210 }
211
212 /* Get the database meta information.
213 **
214 ** Meta values are as follows:
215 ** meta[0] Schema cookie. Changes with each schema change.
216 ** meta[1] File format of schema layer.
217 ** meta[2] Size of the page cache.
218 ** meta[3] Use freelist if 0. Autovacuum if greater than zero.
drh8159a352006-05-23 23:22:29 +0000219 ** meta[4] Db text encoding. 1:UTF-8 2:UTF-16LE 3:UTF-16BE
danielk1977fa256a32005-05-25 04:11:56 +0000220 ** meta[5] The user cookie. Used by the application.
danielk1977418899a2007-06-24 10:14:00 +0000221 ** meta[6] Incremental-vacuum flag.
danielk1977fa256a32005-05-25 04:11:56 +0000222 ** meta[7]
223 ** meta[8]
224 ** meta[9]
225 **
drhf248e212006-01-25 22:50:38 +0000226 ** Note: The #defined SQLITE_UTF* symbols in sqliteInt.h correspond to
danielk1977fa256a32005-05-25 04:11:56 +0000227 ** the possible values of meta[4].
228 */
229 if( rc==SQLITE_OK ){
230 int i;
231 for(i=0; rc==SQLITE_OK && i<sizeof(meta)/sizeof(meta[0]); i++){
drhfdd6e852005-12-16 01:06:16 +0000232 rc = sqlite3BtreeGetMeta(pDb->pBt, i+1, (u32 *)&meta[i]);
danielk1977fa256a32005-05-25 04:11:56 +0000233 }
234 if( rc ){
235 sqlite3SetString(pzErrMsg, sqlite3ErrStr(rc), (char*)0);
236 sqlite3BtreeCloseCursor(curMain);
drhb1ab8ea2007-08-29 00:33:07 +0000237 sqlite3BtreeLeave(pDb->pBt);
danielk1977a1644fd2007-08-29 12:31:25 +0000238 goto error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000239 }
240 }else{
241 memset(meta, 0, sizeof(meta));
242 }
danielk1977da184232006-01-05 11:34:32 +0000243 pDb->pSchema->schema_cookie = meta[0];
danielk1977fa256a32005-05-25 04:11:56 +0000244
245 /* If opening a non-empty database, check the text encoding. For the
246 ** main database, set sqlite3.enc to the encoding of the main database.
247 ** For an attached db, it is an error if the encoding is not the same
248 ** as sqlite3.enc.
249 */
250 if( meta[4] ){ /* text encoding */
251 if( iDb==0 ){
danielk197714db2662006-01-09 16:12:04 +0000252 /* If opening the main database, set ENC(db). */
253 ENC(db) = (u8)meta[4];
danielk1977b3bf5562006-01-10 17:58:23 +0000254 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 6, 0);
danielk1977fa256a32005-05-25 04:11:56 +0000255 }else{
danielk197714db2662006-01-09 16:12:04 +0000256 /* If opening an attached database, the encoding much match ENC(db) */
257 if( meta[4]!=ENC(db) ){
danielk1977fa256a32005-05-25 04:11:56 +0000258 sqlite3BtreeCloseCursor(curMain);
259 sqlite3SetString(pzErrMsg, "attached databases must use the same"
260 " text encoding as main database", (char*)0);
drhb1ab8ea2007-08-29 00:33:07 +0000261 sqlite3BtreeLeave(pDb->pBt);
danielk1977fa256a32005-05-25 04:11:56 +0000262 return SQLITE_ERROR;
263 }
264 }
danielk1977b82e7ed2006-01-11 14:09:31 +0000265 }else{
266 DbSetProperty(db, iDb, DB_Empty);
danielk1977fa256a32005-05-25 04:11:56 +0000267 }
danielk197714db2662006-01-09 16:12:04 +0000268 pDb->pSchema->enc = ENC(db);
danielk1977fa256a32005-05-25 04:11:56 +0000269
270 size = meta[2];
drhc797d4d2007-05-08 01:08:49 +0000271 if( size==0 ){ size = SQLITE_DEFAULT_CACHE_SIZE; }
drh3c84ddf2008-01-09 02:15:38 +0000272 if( size<0 ) size = -size;
danielk197714db2662006-01-09 16:12:04 +0000273 pDb->pSchema->cache_size = size;
274 sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
danielk1977fa256a32005-05-25 04:11:56 +0000275
276 /*
277 ** file_format==1 Version 3.0.0.
drhfdd6e852005-12-16 01:06:16 +0000278 ** file_format==2 Version 3.1.3. // ALTER TABLE ADD COLUMN
279 ** file_format==3 Version 3.1.4. // ditto but with non-NULL defaults
drhd946db02005-12-29 19:23:06 +0000280 ** file_format==4 Version 3.3.0. // DESC indices. Boolean constants
danielk1977fa256a32005-05-25 04:11:56 +0000281 */
danielk1977da184232006-01-05 11:34:32 +0000282 pDb->pSchema->file_format = meta[1];
283 if( pDb->pSchema->file_format==0 ){
284 pDb->pSchema->file_format = 1;
drhfdd6e852005-12-16 01:06:16 +0000285 }
danielk1977da184232006-01-05 11:34:32 +0000286 if( pDb->pSchema->file_format>SQLITE_MAX_FILE_FORMAT ){
danielk1977fa256a32005-05-25 04:11:56 +0000287 sqlite3BtreeCloseCursor(curMain);
288 sqlite3SetString(pzErrMsg, "unsupported file format", (char*)0);
drhb1ab8ea2007-08-29 00:33:07 +0000289 sqlite3BtreeLeave(pDb->pBt);
danielk1977fa256a32005-05-25 04:11:56 +0000290 return SQLITE_ERROR;
291 }
292
drh4aa2bfe2007-11-28 13:43:16 +0000293 /* Ticket #2804: When we open a database in the newer file format,
294 ** clear the legacy_file_format pragma flag so that a VACUUM will
295 ** not downgrade the database and thus invalidate any descending
296 ** indices that the user might have created.
297 */
298 if( iDb==0 && meta[1]>=4 ){
299 db->flags &= ~SQLITE_LegacyFileFmt;
300 }
danielk1977fa256a32005-05-25 04:11:56 +0000301
302 /* Read the schema information out of the schema tables
303 */
304 assert( db->init.busy );
305 if( rc==SQLITE_EMPTY ){
306 /* For an empty database, there is nothing to read */
307 rc = SQLITE_OK;
308 }else{
309 char *zSql;
danielk19771e536952007-08-16 10:09:01 +0000310 zSql = sqlite3MPrintf(db,
drhece3c722006-09-23 20:36:01 +0000311 "SELECT name, rootpage, sql FROM '%q'.%s",
312 db->aDb[iDb].zName, zMasterName);
danielk1977fa256a32005-05-25 04:11:56 +0000313 sqlite3SafetyOff(db);
drha6d0ffc2007-10-12 20:42:28 +0000314#ifndef SQLITE_OMIT_AUTHORIZATION
315 {
316 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
317 xAuth = db->xAuth;
318 db->xAuth = 0;
319#endif
320 rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
321#ifndef SQLITE_OMIT_AUTHORIZATION
322 db->xAuth = xAuth;
323 }
324#endif
drh15ca1df2006-07-26 13:43:30 +0000325 if( rc==SQLITE_ABORT ) rc = initData.rc;
danielk1977fa256a32005-05-25 04:11:56 +0000326 sqlite3SafetyOn(db);
drh17435752007-08-16 04:30:38 +0000327 sqlite3_free(zSql);
drh497e4462005-07-23 03:18:40 +0000328#ifndef SQLITE_OMIT_ANALYZE
329 if( rc==SQLITE_OK ){
330 sqlite3AnalysisLoad(db, iDb);
331 }
332#endif
danielk1977fa256a32005-05-25 04:11:56 +0000333 sqlite3BtreeCloseCursor(curMain);
334 }
drh17435752007-08-16 04:30:38 +0000335 if( db->mallocFailed ){
danielk19779e128002006-01-18 16:51:35 +0000336 /* sqlite3SetString(pzErrMsg, "out of memory", (char*)0); */
danielk1977fa256a32005-05-25 04:11:56 +0000337 rc = SQLITE_NOMEM;
338 sqlite3ResetInternalSchema(db, 0);
339 }
danielk197734c68fb2007-03-14 15:37:04 +0000340 if( rc==SQLITE_OK || (db->flags&SQLITE_RecoveryMode)){
341 /* Black magic: If the SQLITE_RecoveryMode flag is set, then consider
342 ** the schema loaded, even if errors occured. In this situation the
343 ** current sqlite3_prepare() operation will fail, but the following one
344 ** will attempt to compile the supplied statement against whatever subset
345 ** of the schema was loaded before the error occured. The primary
346 ** purpose of this is to allow access to the sqlite_master table
drh85b623f2007-12-13 21:54:09 +0000347 ** even when its contents have been corrupted.
danielk197734c68fb2007-03-14 15:37:04 +0000348 */
danielk1977fa256a32005-05-25 04:11:56 +0000349 DbSetProperty(db, iDb, DB_SchemaLoaded);
danielk197734c68fb2007-03-14 15:37:04 +0000350 rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000351 }
drhb1ab8ea2007-08-29 00:33:07 +0000352 sqlite3BtreeLeave(pDb->pBt);
danielk1977a1644fd2007-08-29 12:31:25 +0000353
354error_out:
danielk1977ae72d982007-10-03 08:46:44 +0000355 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
danielk1977a1644fd2007-08-29 12:31:25 +0000356 db->mallocFailed = 1;
357 }
danielk1977fa256a32005-05-25 04:11:56 +0000358 return rc;
359}
360
361/*
362** Initialize all database files - the main database file, the file
363** used to store temporary tables, and any additional database files
364** created using ATTACH statements. Return a success code. If an
365** error occurs, write an error message into *pzErrMsg.
366**
danielk1977e7259292006-01-13 06:33:23 +0000367** After a database is initialized, the DB_SchemaLoaded bit is set
368** bit is set in the flags field of the Db structure. If the database
369** file was of zero-length, then the DB_Empty flag is also set.
danielk1977fa256a32005-05-25 04:11:56 +0000370*/
371int sqlite3Init(sqlite3 *db, char **pzErrMsg){
372 int i, rc;
danielk19775814c1a2007-08-13 14:41:19 +0000373 int commit_internal = !(db->flags&SQLITE_InternChanges);
danielk1977fa256a32005-05-25 04:11:56 +0000374
drhb1ab8ea2007-08-29 00:33:07 +0000375 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000376 if( db->init.busy ) return SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000377 rc = SQLITE_OK;
378 db->init.busy = 1;
379 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
380 if( DbHasProperty(db, i, DB_SchemaLoaded) || i==1 ) continue;
381 rc = sqlite3InitOne(db, i, pzErrMsg);
382 if( rc ){
383 sqlite3ResetInternalSchema(db, i);
384 }
385 }
386
387 /* Once all the other databases have been initialised, load the schema
388 ** for the TEMP database. This is loaded last, as the TEMP database
389 ** schema may contain references to objects in other databases.
390 */
391#ifndef SQLITE_OMIT_TEMPDB
392 if( rc==SQLITE_OK && db->nDb>1 && !DbHasProperty(db, 1, DB_SchemaLoaded) ){
393 rc = sqlite3InitOne(db, 1, pzErrMsg);
394 if( rc ){
395 sqlite3ResetInternalSchema(db, 1);
396 }
397 }
398#endif
399
400 db->init.busy = 0;
danielk19775814c1a2007-08-13 14:41:19 +0000401 if( rc==SQLITE_OK && commit_internal ){
danielk1977fa256a32005-05-25 04:11:56 +0000402 sqlite3CommitInternalChanges(db);
403 }
404
danielk1977b82e7ed2006-01-11 14:09:31 +0000405 return rc;
danielk1977fa256a32005-05-25 04:11:56 +0000406}
407
408/*
409** This routine is a no-op if the database schema is already initialised.
410** Otherwise, the schema is loaded. An error code is returned.
411*/
412int sqlite3ReadSchema(Parse *pParse){
413 int rc = SQLITE_OK;
414 sqlite3 *db = pParse->db;
drhb1ab8ea2007-08-29 00:33:07 +0000415 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000416 if( !db->init.busy ){
danielk1977b82e7ed2006-01-11 14:09:31 +0000417 rc = sqlite3Init(db, &pParse->zErrMsg);
danielk1977fa256a32005-05-25 04:11:56 +0000418 }
danielk1977fa256a32005-05-25 04:11:56 +0000419 if( rc!=SQLITE_OK ){
420 pParse->rc = rc;
421 pParse->nErr++;
422 }
423 return rc;
424}
425
426
427/*
428** Check schema cookies in all databases. If any cookie is out
429** of date, return 0. If all schema cookies are current, return 1.
430*/
431static int schemaIsValid(sqlite3 *db){
432 int iDb;
433 int rc;
434 BtCursor *curTemp;
435 int cookie;
436 int allOk = 1;
437
drhb1ab8ea2007-08-29 00:33:07 +0000438 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000439 for(iDb=0; allOk && iDb<db->nDb; iDb++){
440 Btree *pBt;
441 pBt = db->aDb[iDb].pBt;
442 if( pBt==0 ) continue;
443 rc = sqlite3BtreeCursor(pBt, MASTER_ROOT, 0, 0, 0, &curTemp);
444 if( rc==SQLITE_OK ){
445 rc = sqlite3BtreeGetMeta(pBt, 1, (u32 *)&cookie);
danielk1977da184232006-01-05 11:34:32 +0000446 if( rc==SQLITE_OK && cookie!=db->aDb[iDb].pSchema->schema_cookie ){
danielk1977fa256a32005-05-25 04:11:56 +0000447 allOk = 0;
448 }
449 sqlite3BtreeCloseCursor(curTemp);
450 }
danielk1977ae72d982007-10-03 08:46:44 +0000451 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
danielk1977a1644fd2007-08-29 12:31:25 +0000452 db->mallocFailed = 1;
453 }
danielk1977fa256a32005-05-25 04:11:56 +0000454 }
455 return allOk;
456}
457
458/*
drhf248e212006-01-25 22:50:38 +0000459** Convert a schema pointer into the iDb index that indicates
460** which database file in db->aDb[] the schema refers to.
461**
462** If the same database is attached more than once, the first
463** attached database is returned.
464*/
danielk1977e501b892006-01-09 06:29:47 +0000465int sqlite3SchemaToIndex(sqlite3 *db, Schema *pSchema){
drh198bf392006-01-06 21:52:49 +0000466 int i = -1000000;
467
468 /* If pSchema is NULL, then return -1000000. This happens when code in
469 ** expr.c is trying to resolve a reference to a transient table (i.e. one
470 ** created by a sub-select). In this case the return value of this
471 ** function should never be used.
472 **
473 ** We return -1000000 instead of the more usual -1 simply because using
474 ** -1000000 as incorrectly using -1000000 index into db->aDb[] is much
475 ** more likely to cause a segfault than -1 (of course there are assert()
476 ** statements too, but it never hurts to play the odds).
477 */
drhb1ab8ea2007-08-29 00:33:07 +0000478 assert( sqlite3_mutex_held(db->mutex) );
drh198bf392006-01-06 21:52:49 +0000479 if( pSchema ){
480 for(i=0; i<db->nDb; i++){
481 if( db->aDb[i].pSchema==pSchema ){
482 break;
483 }
484 }
485 assert( i>=0 &&i>=0 && i<db->nDb );
486 }
487 return i;
488}
489
490/*
danielk1977fa256a32005-05-25 04:11:56 +0000491** Compile the UTF-8 encoded SQL statement zSql into a statement handle.
492*/
drhb900aaf2006-11-09 00:24:53 +0000493int sqlite3Prepare(
danielk1977fa256a32005-05-25 04:11:56 +0000494 sqlite3 *db, /* Database handle. */
495 const char *zSql, /* UTF-8 encoded SQL statement. */
496 int nBytes, /* Length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +0000497 int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
danielk1977fa256a32005-05-25 04:11:56 +0000498 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
drhb900aaf2006-11-09 00:24:53 +0000499 const char **pzTail /* OUT: End of parsed string */
danielk1977fa256a32005-05-25 04:11:56 +0000500){
501 Parse sParse;
502 char *zErrMsg = 0;
503 int rc = SQLITE_OK;
danielk1977c87d34d2006-01-06 13:00:28 +0000504 int i;
danielk1977fa256a32005-05-25 04:11:56 +0000505
danielk1977fa256a32005-05-25 04:11:56 +0000506 assert( ppStmt );
507 *ppStmt = 0;
508 if( sqlite3SafetyOn(db) ){
509 return SQLITE_MISUSE;
510 }
drh86f8c192007-08-22 00:39:19 +0000511 assert( !db->mallocFailed );
drhb21c8cd2007-08-21 19:33:56 +0000512 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000513
danielk1977c87d34d2006-01-06 13:00:28 +0000514 /* If any attached database schemas are locked, do not proceed with
515 ** compilation. Instead return SQLITE_LOCKED immediately.
516 */
517 for(i=0; i<db->nDb; i++) {
518 Btree *pBt = db->aDb[i].pBt;
drhb1ab8ea2007-08-29 00:33:07 +0000519 if( pBt ){
520 int rc;
521 rc = sqlite3BtreeSchemaLocked(pBt);
522 if( rc ){
523 const char *zDb = db->aDb[i].zName;
524 sqlite3Error(db, SQLITE_LOCKED, "database schema is locked: %s", zDb);
525 sqlite3SafetyOff(db);
526 return SQLITE_LOCKED;
527 }
danielk1977c87d34d2006-01-06 13:00:28 +0000528 }
529 }
530
danielk1977fa256a32005-05-25 04:11:56 +0000531 memset(&sParse, 0, sizeof(sParse));
532 sParse.db = db;
drh9051a422006-01-30 22:35:43 +0000533 if( nBytes>=0 && zSql[nBytes]!=0 ){
drhe5c941b2007-05-08 13:58:26 +0000534 char *zSqlCopy;
drhbe69bf62007-12-18 17:50:33 +0000535 if( SQLITE_MAX_SQL_LENGTH>0 && nBytes>SQLITE_MAX_SQL_LENGTH ){
536 sqlite3Error(db, SQLITE_TOOBIG, "statement too long");
537 sqlite3SafetyOff(db);
drhe5c941b2007-05-08 13:58:26 +0000538 return SQLITE_TOOBIG;
539 }
drh17435752007-08-16 04:30:38 +0000540 zSqlCopy = sqlite3DbStrNDup(db, zSql, nBytes);
drh276fdbf2007-04-30 21:39:16 +0000541 if( zSqlCopy ){
542 sqlite3RunParser(&sParse, zSqlCopy, &zErrMsg);
drh17435752007-08-16 04:30:38 +0000543 sqlite3_free(zSqlCopy);
drh276fdbf2007-04-30 21:39:16 +0000544 }
545 sParse.zTail = &zSql[nBytes];
drh9051a422006-01-30 22:35:43 +0000546 }else{
547 sqlite3RunParser(&sParse, zSql, &zErrMsg);
548 }
danielk1977fa256a32005-05-25 04:11:56 +0000549
drh17435752007-08-16 04:30:38 +0000550 if( db->mallocFailed ){
danielk1977261919c2005-12-06 12:52:59 +0000551 sParse.rc = SQLITE_NOMEM;
danielk1977fa256a32005-05-25 04:11:56 +0000552 }
553 if( sParse.rc==SQLITE_DONE ) sParse.rc = SQLITE_OK;
drh4d91a702006-01-04 15:54:36 +0000554 if( sParse.checkSchema && !schemaIsValid(db) ){
danielk1977fa256a32005-05-25 04:11:56 +0000555 sParse.rc = SQLITE_SCHEMA;
556 }
557 if( sParse.rc==SQLITE_SCHEMA ){
558 sqlite3ResetInternalSchema(db, 0);
559 }
drh17435752007-08-16 04:30:38 +0000560 if( db->mallocFailed ){
drh344a6272006-06-26 12:50:09 +0000561 sParse.rc = SQLITE_NOMEM;
562 }
drhb900aaf2006-11-09 00:24:53 +0000563 if( pzTail ){
564 *pzTail = sParse.zTail;
565 }
danielk1977fa256a32005-05-25 04:11:56 +0000566 rc = sParse.rc;
567
568#ifndef SQLITE_OMIT_EXPLAIN
569 if( rc==SQLITE_OK && sParse.pVdbe && sParse.explain ){
drhecc92422005-09-10 16:46:12 +0000570 if( sParse.explain==2 ){
571 sqlite3VdbeSetNumCols(sParse.pVdbe, 3);
drh66a51672008-01-03 00:01:23 +0000572 sqlite3VdbeSetColName(sParse.pVdbe, 0, COLNAME_NAME, "order", P4_STATIC);
573 sqlite3VdbeSetColName(sParse.pVdbe, 1, COLNAME_NAME, "from", P4_STATIC);
574 sqlite3VdbeSetColName(sParse.pVdbe, 2, COLNAME_NAME, "detail", P4_STATIC);
drhecc92422005-09-10 16:46:12 +0000575 }else{
danielk19770d78bae2008-01-03 07:09:48 +0000576 sqlite3VdbeSetNumCols(sParse.pVdbe, 8);
drh66a51672008-01-03 00:01:23 +0000577 sqlite3VdbeSetColName(sParse.pVdbe, 0, COLNAME_NAME, "addr", P4_STATIC);
578 sqlite3VdbeSetColName(sParse.pVdbe, 1, COLNAME_NAME, "opcode", P4_STATIC);
579 sqlite3VdbeSetColName(sParse.pVdbe, 2, COLNAME_NAME, "p1", P4_STATIC);
580 sqlite3VdbeSetColName(sParse.pVdbe, 3, COLNAME_NAME, "p2", P4_STATIC);
581 sqlite3VdbeSetColName(sParse.pVdbe, 4, COLNAME_NAME, "p3", P4_STATIC);
danielk19770d78bae2008-01-03 07:09:48 +0000582 sqlite3VdbeSetColName(sParse.pVdbe, 5, COLNAME_NAME, "p4", P4_STATIC);
583 sqlite3VdbeSetColName(sParse.pVdbe, 6, COLNAME_NAME, "p5", P4_STATIC);
584 sqlite3VdbeSetColName(sParse.pVdbe, 7, COLNAME_NAME, "comment",P4_STATIC);
drhecc92422005-09-10 16:46:12 +0000585 }
drhb900aaf2006-11-09 00:24:53 +0000586 }
danielk1977fa256a32005-05-25 04:11:56 +0000587#endif
588
danielk1977fa256a32005-05-25 04:11:56 +0000589 if( sqlite3SafetyOff(db) ){
590 rc = SQLITE_MISUSE;
591 }
danielk19777e29e952007-04-19 11:09:01 +0000592
593 if( saveSqlFlag ){
594 sqlite3VdbeSetSql(sParse.pVdbe, zSql, sParse.zTail - zSql);
595 }
drh17435752007-08-16 04:30:38 +0000596 if( rc!=SQLITE_OK || db->mallocFailed ){
danielk1977fa256a32005-05-25 04:11:56 +0000597 sqlite3_finalize((sqlite3_stmt*)sParse.pVdbe);
danielk19777e29e952007-04-19 11:09:01 +0000598 assert(!(*ppStmt));
599 }else{
600 *ppStmt = (sqlite3_stmt*)sParse.pVdbe;
danielk1977fa256a32005-05-25 04:11:56 +0000601 }
602
603 if( zErrMsg ){
604 sqlite3Error(db, rc, "%s", zErrMsg);
drh17435752007-08-16 04:30:38 +0000605 sqlite3_free(zErrMsg);
danielk1977fa256a32005-05-25 04:11:56 +0000606 }else{
607 sqlite3Error(db, rc, 0);
608 }
danielk1977261919c2005-12-06 12:52:59 +0000609
danielk197754f01982006-01-18 15:25:17 +0000610 rc = sqlite3ApiExit(db, rc);
drh4ac285a2006-09-15 07:28:50 +0000611 assert( (rc&db->errMask)==rc );
danielk1977fa256a32005-05-25 04:11:56 +0000612 return rc;
613}
drhb21c8cd2007-08-21 19:33:56 +0000614static int sqlite3LockAndPrepare(
615 sqlite3 *db, /* Database handle. */
616 const char *zSql, /* UTF-8 encoded SQL statement. */
617 int nBytes, /* Length of zSql in bytes. */
618 int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
619 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
620 const char **pzTail /* OUT: End of parsed string */
621){
622 int rc;
drh27641702007-08-22 02:56:42 +0000623 if( sqlite3SafetyCheck(db) ){
624 return SQLITE_MISUSE;
625 }
drhb21c8cd2007-08-21 19:33:56 +0000626 sqlite3_mutex_enter(db->mutex);
drhb1ab8ea2007-08-29 00:33:07 +0000627 sqlite3BtreeEnterAll(db);
drhb21c8cd2007-08-21 19:33:56 +0000628 rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, ppStmt, pzTail);
drhb1ab8ea2007-08-29 00:33:07 +0000629 sqlite3BtreeLeaveAll(db);
drhb21c8cd2007-08-21 19:33:56 +0000630 sqlite3_mutex_leave(db->mutex);
631 return rc;
632}
danielk1977fa256a32005-05-25 04:11:56 +0000633
drhb900aaf2006-11-09 00:24:53 +0000634/*
635** Rerun the compilation of a statement after a schema change.
636** Return true if the statement was recompiled successfully.
637** Return false if there is an error of some kind.
638*/
639int sqlite3Reprepare(Vdbe *p){
640 int rc;
drh4f0c5872007-03-26 22:05:01 +0000641 sqlite3_stmt *pNew;
drhb900aaf2006-11-09 00:24:53 +0000642 const char *zSql;
643 sqlite3 *db;
drhb21c8cd2007-08-21 19:33:56 +0000644
drhb1ab8ea2007-08-29 00:33:07 +0000645 assert( sqlite3_mutex_held(sqlite3VdbeDb(p)->mutex) );
danielk1977d0e2a852007-11-14 06:48:48 +0000646 zSql = sqlite3_sql((sqlite3_stmt *)p);
drhb900aaf2006-11-09 00:24:53 +0000647 if( zSql==0 ){
648 return 0;
649 }
650 db = sqlite3VdbeDb(p);
drhb21c8cd2007-08-21 19:33:56 +0000651 assert( sqlite3_mutex_held(db->mutex) );
drhb1ab8ea2007-08-29 00:33:07 +0000652 rc = sqlite3LockAndPrepare(db, zSql, -1, 0, &pNew, 0);
drhb900aaf2006-11-09 00:24:53 +0000653 if( rc ){
danielk19778e556522007-11-13 10:30:24 +0000654 if( rc==SQLITE_NOMEM ){
655 db->mallocFailed = 1;
656 }
drhb900aaf2006-11-09 00:24:53 +0000657 assert( pNew==0 );
658 return 0;
659 }else{
660 assert( pNew!=0 );
661 }
drh4f0c5872007-03-26 22:05:01 +0000662 sqlite3VdbeSwap((Vdbe*)pNew, p);
663 sqlite3_transfer_bindings(pNew, (sqlite3_stmt*)p);
664 sqlite3VdbeResetStepResult((Vdbe*)pNew);
665 sqlite3VdbeFinalize((Vdbe*)pNew);
drhb900aaf2006-11-09 00:24:53 +0000666 return 1;
667}
668
669
670/*
671** Two versions of the official API. Legacy and new use. In the legacy
672** version, the original SQL text is not saved in the prepared statement
673** and so if a schema change occurs, SQLITE_SCHEMA is returned by
674** sqlite3_step(). In the new version, the original SQL text is retained
675** and the statement is automatically recompiled if an schema change
676** occurs.
677*/
678int sqlite3_prepare(
679 sqlite3 *db, /* Database handle. */
680 const char *zSql, /* UTF-8 encoded SQL statement. */
681 int nBytes, /* Length of zSql in bytes. */
682 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
683 const char **pzTail /* OUT: End of parsed string */
684){
drhb21c8cd2007-08-21 19:33:56 +0000685 return sqlite3LockAndPrepare(db,zSql,nBytes,0,ppStmt,pzTail);
drhb900aaf2006-11-09 00:24:53 +0000686}
687int sqlite3_prepare_v2(
688 sqlite3 *db, /* Database handle. */
689 const char *zSql, /* UTF-8 encoded SQL statement. */
690 int nBytes, /* Length of zSql in bytes. */
691 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
692 const char **pzTail /* OUT: End of parsed string */
693){
drhb21c8cd2007-08-21 19:33:56 +0000694 return sqlite3LockAndPrepare(db,zSql,nBytes,1,ppStmt,pzTail);
drhb900aaf2006-11-09 00:24:53 +0000695}
696
697
danielk1977fa256a32005-05-25 04:11:56 +0000698#ifndef SQLITE_OMIT_UTF16
699/*
700** Compile the UTF-16 encoded SQL statement zSql into a statement handle.
701*/
drhb900aaf2006-11-09 00:24:53 +0000702static int sqlite3Prepare16(
danielk1977fa256a32005-05-25 04:11:56 +0000703 sqlite3 *db, /* Database handle. */
704 const void *zSql, /* UTF-8 encoded SQL statement. */
705 int nBytes, /* Length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +0000706 int saveSqlFlag, /* True to save SQL text into the sqlite3_stmt */
danielk1977fa256a32005-05-25 04:11:56 +0000707 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
708 const void **pzTail /* OUT: End of parsed string */
709){
710 /* This function currently works by first transforming the UTF-16
711 ** encoded string to UTF-8, then invoking sqlite3_prepare(). The
712 ** tricky bit is figuring out the pointer to return in *pzTail.
713 */
danielk197754f01982006-01-18 15:25:17 +0000714 char *zSql8;
danielk1977c87d34d2006-01-06 13:00:28 +0000715 const char *zTail8 = 0;
danielk197754f01982006-01-18 15:25:17 +0000716 int rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000717
718 if( sqlite3SafetyCheck(db) ){
719 return SQLITE_MISUSE;
720 }
drhb21c8cd2007-08-21 19:33:56 +0000721 sqlite3_mutex_enter(db->mutex);
danielk19771e536952007-08-16 10:09:01 +0000722 zSql8 = sqlite3Utf16to8(db, zSql, nBytes);
danielk197754f01982006-01-18 15:25:17 +0000723 if( zSql8 ){
drhb1ab8ea2007-08-29 00:33:07 +0000724 rc = sqlite3LockAndPrepare(db, zSql8, -1, saveSqlFlag, ppStmt, &zTail8);
danielk1977fa256a32005-05-25 04:11:56 +0000725 }
danielk1977fa256a32005-05-25 04:11:56 +0000726
727 if( zTail8 && pzTail ){
728 /* If sqlite3_prepare returns a tail pointer, we calculate the
729 ** equivalent pointer into the UTF-16 string by counting the unicode
730 ** characters between zSql8 and zTail8, and then returning a pointer
731 ** the same number of characters into the UTF-16 string.
732 */
drhee858132007-05-08 20:37:38 +0000733 int chars_parsed = sqlite3Utf8CharLen(zSql8, zTail8-zSql8);
734 *pzTail = (u8 *)zSql + sqlite3Utf16ByteLen(zSql, chars_parsed);
danielk1977fa256a32005-05-25 04:11:56 +0000735 }
drh17435752007-08-16 04:30:38 +0000736 sqlite3_free(zSql8);
drhb21c8cd2007-08-21 19:33:56 +0000737 rc = sqlite3ApiExit(db, rc);
738 sqlite3_mutex_leave(db->mutex);
739 return rc;
danielk1977fa256a32005-05-25 04:11:56 +0000740}
drhb900aaf2006-11-09 00:24:53 +0000741
742/*
743** Two versions of the official API. Legacy and new use. In the legacy
744** version, the original SQL text is not saved in the prepared statement
745** and so if a schema change occurs, SQLITE_SCHEMA is returned by
746** sqlite3_step(). In the new version, the original SQL text is retained
747** and the statement is automatically recompiled if an schema change
748** occurs.
749*/
750int sqlite3_prepare16(
751 sqlite3 *db, /* Database handle. */
752 const void *zSql, /* UTF-8 encoded SQL statement. */
753 int nBytes, /* Length of zSql in bytes. */
754 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
755 const void **pzTail /* OUT: End of parsed string */
756){
757 return sqlite3Prepare16(db,zSql,nBytes,0,ppStmt,pzTail);
758}
759int sqlite3_prepare16_v2(
760 sqlite3 *db, /* Database handle. */
761 const void *zSql, /* UTF-8 encoded SQL statement. */
762 int nBytes, /* Length of zSql in bytes. */
763 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
764 const void **pzTail /* OUT: End of parsed string */
765){
766 return sqlite3Prepare16(db,zSql,nBytes,1,ppStmt,pzTail);
767}
768
danielk1977fa256a32005-05-25 04:11:56 +0000769#endif /* SQLITE_OMIT_UTF16 */