blob: 5db7b0bd7f097d9e2681f06a0e04cb0838596466 [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**
drh27731d72009-06-22 12:05:10 +000016** $Id: prepare.c,v 1.124 2009/06/22 12:05:10 drh Exp $
danielk1977fa256a32005-05-25 04:11:56 +000017*/
18#include "sqliteInt.h"
danielk1977fa256a32005-05-25 04:11:56 +000019
20/*
21** Fill the InitData structure with an error message that indicates
22** that the database is corrupt.
23*/
drh34533152008-03-19 13:03:33 +000024static void corruptSchema(
25 InitData *pData, /* Initialization context */
26 const char *zObj, /* Object being parsed at the point of error */
27 const char *zExtra /* Error information */
28){
drhc456e572008-08-11 18:44:58 +000029 sqlite3 *db = pData->db;
30 if( !db->mallocFailed && (db->flags & SQLITE_RecoveryMode)==0 ){
drh34533152008-03-19 13:03:33 +000031 if( zObj==0 ) zObj = "?";
drhf089aa42008-07-08 19:34:06 +000032 sqlite3SetString(pData->pzErrMsg, pData->db,
33 "malformed database schema (%s)", zObj);
drh9da742f2009-06-16 17:49:36 +000034 if( zExtra ){
drh633e6d52008-07-28 19:34:53 +000035 *pData->pzErrMsg = sqlite3MAppendf(pData->db, *pData->pzErrMsg, "%s - %s",
drhf089aa42008-07-08 19:34:06 +000036 *pData->pzErrMsg, zExtra);
37 }
danielk1977fa256a32005-05-25 04:11:56 +000038 }
drh9da742f2009-06-16 17:49:36 +000039 pData->rc = db->mallocFailed ? SQLITE_NOMEM : SQLITE_CORRUPT;
danielk1977fa256a32005-05-25 04:11:56 +000040}
41
42/*
43** This is the callback routine for the code that initializes the
44** database. See sqlite3Init() below for additional information.
45** This routine is also called from the OP_ParseSchema opcode of the VDBE.
46**
47** Each callback contains the following information:
48**
49** argv[0] = name of thing being created
danielk197778efaba2006-06-12 06:09:17 +000050** argv[1] = root page number for table or index. 0 for trigger or view.
danielk1977fa256a32005-05-25 04:11:56 +000051** argv[2] = SQL text for the CREATE statement.
danielk1977fa256a32005-05-25 04:11:56 +000052**
53*/
danielk197762c14b32008-11-19 09:05:26 +000054int sqlite3InitCallback(void *pInit, int argc, char **argv, char **NotUsed){
danielk1977fa256a32005-05-25 04:11:56 +000055 InitData *pData = (InitData*)pInit;
56 sqlite3 *db = pData->db;
drhece3c722006-09-23 20:36:01 +000057 int iDb = pData->iDb;
danielk1977fa256a32005-05-25 04:11:56 +000058
danielk1977f3d3c272008-11-19 16:52:44 +000059 assert( argc==3 );
60 UNUSED_PARAMETER2(NotUsed, argc);
drhb1ab8ea2007-08-29 00:33:07 +000061 assert( sqlite3_mutex_held(db->mutex) );
drhece3c722006-09-23 20:36:01 +000062 DbClearProperty(db, iDb, DB_Empty);
drh17435752007-08-16 04:30:38 +000063 if( db->mallocFailed ){
drh34533152008-03-19 13:03:33 +000064 corruptSchema(pData, argv[0], 0);
drh9da742f2009-06-16 17:49:36 +000065 return 1;
danielk1977da184232006-01-05 11:34:32 +000066 }
67
danielk1977ff9b2e72008-09-08 09:06:18 +000068 assert( iDb>=0 && iDb<db->nDb );
danielk1977fa256a32005-05-25 04:11:56 +000069 if( argv==0 ) return 0; /* Might happen if EMPTY_RESULT_CALLBACKS are on */
drhece3c722006-09-23 20:36:01 +000070 if( argv[1]==0 ){
drh34533152008-03-19 13:03:33 +000071 corruptSchema(pData, argv[0], 0);
danielk1977ff9b2e72008-09-08 09:06:18 +000072 }else if( argv[2] && argv[2][0] ){
danielk1977fa256a32005-05-25 04:11:56 +000073 /* Call the parser to process a CREATE TABLE, INDEX or VIEW.
74 ** But because db->init.busy is set to 1, no VDBE code is generated
75 ** or executed. All the parser does is build the internal data
76 ** structures that describe the table, index, or view.
77 */
78 char *zErr;
79 int rc;
80 assert( db->init.busy );
81 db->init.iDb = iDb;
82 db->init.newTnum = atoi(argv[1]);
83 rc = sqlite3_exec(db, argv[2], 0, 0, &zErr);
84 db->init.iDb = 0;
drh43617e92006-03-06 20:55:46 +000085 assert( rc!=SQLITE_OK || zErr==0 );
danielk1977fa256a32005-05-25 04:11:56 +000086 if( SQLITE_OK!=rc ){
drh15ca1df2006-07-26 13:43:30 +000087 pData->rc = rc;
danielk1977261919c2005-12-06 12:52:59 +000088 if( rc==SQLITE_NOMEM ){
drh17435752007-08-16 04:30:38 +000089 db->mallocFailed = 1;
drh9da742f2009-06-16 17:49:36 +000090 }else if( rc!=SQLITE_INTERRUPT ){
drh34533152008-03-19 13:03:33 +000091 corruptSchema(pData, argv[0], zErr);
danielk1977261919c2005-12-06 12:52:59 +000092 }
drh633e6d52008-07-28 19:34:53 +000093 sqlite3DbFree(db, zErr);
danielk1977fa256a32005-05-25 04:11:56 +000094 }
drh02cd2b82008-01-22 19:34:27 +000095 }else if( argv[0]==0 ){
drh34533152008-03-19 13:03:33 +000096 corruptSchema(pData, 0, 0);
danielk1977fa256a32005-05-25 04:11:56 +000097 }else{
98 /* If the SQL column is blank it means this is an index that
99 ** was created to be the PRIMARY KEY or to fulfill a UNIQUE
100 ** constraint for a CREATE TABLE. The index should have already
101 ** been created when we processed the CREATE TABLE. All we have
102 ** to do here is record the root page number for that index.
103 */
104 Index *pIndex;
105 pIndex = sqlite3FindIndex(db, argv[0], db->aDb[iDb].zName);
drh9da742f2009-06-16 17:49:36 +0000106 if( pIndex==0 ){
danielk1977fa256a32005-05-25 04:11:56 +0000107 /* This can occur if there exists an index on a TEMP table which
108 ** has the same name as another index on a permanent index. Since
109 ** the permanent table is hidden by the TEMP table, we can also
110 ** safely ignore the index on the permanent table.
111 */
112 /* Do Nothing */;
drh9da742f2009-06-16 17:49:36 +0000113 }else if( sqlite3GetInt32(argv[1], &pIndex->tnum)==0 ){
114 corruptSchema(pData, argv[0], "invalid rootpage");
danielk1977fa256a32005-05-25 04:11:56 +0000115 }
116 }
117 return 0;
118}
119
120/*
121** Attempt to read the database schema and initialize internal
122** data structures for a single database file. The index of the
123** database file is given by iDb. iDb==0 is used for the main
124** database. iDb==1 should never be used. iDb>=2 is used for
125** auxiliary databases. Return one of the SQLITE_ error codes to
126** indicate success or failure.
127*/
128static int sqlite3InitOne(sqlite3 *db, int iDb, char **pzErrMsg){
129 int rc;
drh8a939192009-04-20 17:43:03 +0000130 int i;
danielk1977fa256a32005-05-25 04:11:56 +0000131 BtCursor *curMain;
132 int size;
133 Table *pTab;
drhfdd6e852005-12-16 01:06:16 +0000134 Db *pDb;
drhece3c722006-09-23 20:36:01 +0000135 char const *azArg[4];
danielk19770d19f7a2009-06-03 11:25:07 +0000136 int meta[5];
danielk1977fa256a32005-05-25 04:11:56 +0000137 InitData initData;
138 char const *zMasterSchema;
139 char const *zMasterName = SCHEMA_TABLE(iDb);
140
141 /*
142 ** The master database table has a structure like this
143 */
144 static const char master_schema[] =
145 "CREATE TABLE sqlite_master(\n"
146 " type text,\n"
147 " name text,\n"
148 " tbl_name text,\n"
149 " rootpage integer,\n"
150 " sql text\n"
151 ")"
152 ;
153#ifndef SQLITE_OMIT_TEMPDB
154 static const char temp_master_schema[] =
155 "CREATE TEMP TABLE sqlite_temp_master(\n"
156 " type text,\n"
157 " name text,\n"
158 " tbl_name text,\n"
159 " rootpage integer,\n"
160 " sql text\n"
161 ")"
162 ;
163#else
164 #define temp_master_schema 0
165#endif
166
167 assert( iDb>=0 && iDb<db->nDb );
danielk197714db2662006-01-09 16:12:04 +0000168 assert( db->aDb[iDb].pSchema );
drhb1ab8ea2007-08-29 00:33:07 +0000169 assert( sqlite3_mutex_held(db->mutex) );
danielk19774eab8b72007-12-27 15:12:16 +0000170 assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
danielk1977da184232006-01-05 11:34:32 +0000171
danielk1977fa256a32005-05-25 04:11:56 +0000172 /* zMasterSchema and zInitScript are set to point at the master schema
173 ** and initialisation script appropriate for the database being
174 ** initialised. zMasterName is the name of the master table.
175 */
176 if( !OMIT_TEMPDB && iDb==1 ){
177 zMasterSchema = temp_master_schema;
178 }else{
179 zMasterSchema = master_schema;
180 }
181 zMasterName = SCHEMA_TABLE(iDb);
182
183 /* Construct the schema tables. */
danielk1977fa256a32005-05-25 04:11:56 +0000184 azArg[0] = zMasterName;
185 azArg[1] = "1";
186 azArg[2] = zMasterSchema;
drhece3c722006-09-23 20:36:01 +0000187 azArg[3] = 0;
danielk1977fa256a32005-05-25 04:11:56 +0000188 initData.db = db;
drhece3c722006-09-23 20:36:01 +0000189 initData.iDb = iDb;
drhc456e572008-08-11 18:44:58 +0000190 initData.rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000191 initData.pzErrMsg = pzErrMsg;
drh7e8b8482008-01-23 03:03:05 +0000192 (void)sqlite3SafetyOff(db);
drhc456e572008-08-11 18:44:58 +0000193 sqlite3InitCallback(&initData, 3, (char **)azArg, 0);
drh7e8b8482008-01-23 03:03:05 +0000194 (void)sqlite3SafetyOn(db);
drhc456e572008-08-11 18:44:58 +0000195 if( initData.rc ){
danielk1977a1644fd2007-08-29 12:31:25 +0000196 rc = initData.rc;
197 goto error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000198 }
199 pTab = sqlite3FindTable(db, zMasterName, db->aDb[iDb].zName);
drh9da742f2009-06-16 17:49:36 +0000200 if( ALWAYS(pTab) ){
drh7d10d5a2008-08-20 16:35:10 +0000201 pTab->tabFlags |= TF_Readonly;
danielk1977fa256a32005-05-25 04:11:56 +0000202 }
danielk1977fa256a32005-05-25 04:11:56 +0000203
204 /* Create a cursor to hold the database open
205 */
drhfdd6e852005-12-16 01:06:16 +0000206 pDb = &db->aDb[iDb];
207 if( pDb->pBt==0 ){
drh9da742f2009-06-16 17:49:36 +0000208 if( !OMIT_TEMPDB && ALWAYS(iDb==1) ){
danielk1977b82e7ed2006-01-11 14:09:31 +0000209 DbSetProperty(db, 1, DB_SchemaLoaded);
210 }
danielk1977fa256a32005-05-25 04:11:56 +0000211 return SQLITE_OK;
212 }
danielk1977cd3e8f72008-03-25 09:47:35 +0000213 curMain = sqlite3MallocZero(sqlite3BtreeCursorSize());
214 if( !curMain ){
215 rc = SQLITE_NOMEM;
216 goto error_out;
217 }
drhb1ab8ea2007-08-29 00:33:07 +0000218 sqlite3BtreeEnter(pDb->pBt);
danielk1977cd3e8f72008-03-25 09:47:35 +0000219 rc = sqlite3BtreeCursor(pDb->pBt, MASTER_ROOT, 0, 0, curMain);
drh8a939192009-04-20 17:43:03 +0000220 if( rc==SQLITE_EMPTY ) rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000221
222 /* Get the database meta information.
223 **
224 ** Meta values are as follows:
225 ** meta[0] Schema cookie. Changes with each schema change.
226 ** meta[1] File format of schema layer.
227 ** meta[2] Size of the page cache.
drh27731d72009-06-22 12:05:10 +0000228 ** meta[3] Largest rootpage (auto/incr_vacuum mode)
drh8159a352006-05-23 23:22:29 +0000229 ** meta[4] Db text encoding. 1:UTF-8 2:UTF-16LE 3:UTF-16BE
drh27731d72009-06-22 12:05:10 +0000230 ** meta[5] User version
231 ** meta[6] Incremental vacuum mode
232 ** meta[7] unused
233 ** meta[8] unused
234 ** meta[9] unused
danielk1977fa256a32005-05-25 04:11:56 +0000235 **
drhf248e212006-01-25 22:50:38 +0000236 ** Note: The #defined SQLITE_UTF* symbols in sqliteInt.h correspond to
danielk1977fa256a32005-05-25 04:11:56 +0000237 ** the possible values of meta[4].
238 */
danielk19770d19f7a2009-06-03 11:25:07 +0000239 for(i=0; rc==SQLITE_OK && i<ArraySize(meta); i++){
drh8a939192009-04-20 17:43:03 +0000240 rc = sqlite3BtreeGetMeta(pDb->pBt, i+1, (u32 *)&meta[i]);
danielk1977fa256a32005-05-25 04:11:56 +0000241 }
danielk19770d19f7a2009-06-03 11:25:07 +0000242 if( rc ){
243 sqlite3SetString(pzErrMsg, db, "%s", sqlite3ErrStr(rc));
244 goto initone_error_out;
245 }
246 pDb->pSchema->schema_cookie = meta[BTREE_SCHEMA_VERSION-1];
danielk1977fa256a32005-05-25 04:11:56 +0000247
248 /* If opening a non-empty database, check the text encoding. For the
249 ** main database, set sqlite3.enc to the encoding of the main database.
250 ** For an attached db, it is an error if the encoding is not the same
251 ** as sqlite3.enc.
252 */
danielk19770d19f7a2009-06-03 11:25:07 +0000253 if( meta[BTREE_TEXT_ENCODING-1] ){ /* text encoding */
danielk1977fa256a32005-05-25 04:11:56 +0000254 if( iDb==0 ){
drhc5e47ac2009-06-04 00:11:56 +0000255 u8 encoding;
danielk197714db2662006-01-09 16:12:04 +0000256 /* If opening the main database, set ENC(db). */
drhc5e47ac2009-06-04 00:11:56 +0000257 encoding = (u8)meta[BTREE_TEXT_ENCODING-1] & 3;
258 if( encoding==0 ) encoding = SQLITE_UTF8;
259 ENC(db) = encoding;
drhc4a64fa2009-05-11 20:53:28 +0000260 db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, "BINARY", 0);
danielk1977fa256a32005-05-25 04:11:56 +0000261 }else{
danielk197714db2662006-01-09 16:12:04 +0000262 /* If opening an attached database, the encoding much match ENC(db) */
danielk19770d19f7a2009-06-03 11:25:07 +0000263 if( meta[BTREE_TEXT_ENCODING-1]!=ENC(db) ){
drhf089aa42008-07-08 19:34:06 +0000264 sqlite3SetString(pzErrMsg, db, "attached databases must use the same"
265 " text encoding as main database");
danielk1977cd3e8f72008-03-25 09:47:35 +0000266 rc = SQLITE_ERROR;
drh701bb3b2008-08-02 03:50:39 +0000267 goto initone_error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000268 }
269 }
danielk1977b82e7ed2006-01-11 14:09:31 +0000270 }else{
271 DbSetProperty(db, iDb, DB_Empty);
danielk1977fa256a32005-05-25 04:11:56 +0000272 }
danielk197714db2662006-01-09 16:12:04 +0000273 pDb->pSchema->enc = ENC(db);
danielk1977fa256a32005-05-25 04:11:56 +0000274
danielk19778cf6c552008-06-23 16:53:46 +0000275 if( pDb->pSchema->cache_size==0 ){
danielk19770d19f7a2009-06-03 11:25:07 +0000276 size = meta[BTREE_DEFAULT_CACHE_SIZE-1];
danielk19778cf6c552008-06-23 16:53:46 +0000277 if( size==0 ){ size = SQLITE_DEFAULT_CACHE_SIZE; }
278 if( size<0 ) size = -size;
279 pDb->pSchema->cache_size = size;
280 sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
281 }
danielk1977fa256a32005-05-25 04:11:56 +0000282
283 /*
284 ** file_format==1 Version 3.0.0.
drhfdd6e852005-12-16 01:06:16 +0000285 ** file_format==2 Version 3.1.3. // ALTER TABLE ADD COLUMN
286 ** file_format==3 Version 3.1.4. // ditto but with non-NULL defaults
drhd946db02005-12-29 19:23:06 +0000287 ** file_format==4 Version 3.3.0. // DESC indices. Boolean constants
danielk1977fa256a32005-05-25 04:11:56 +0000288 */
danielk19770d19f7a2009-06-03 11:25:07 +0000289 pDb->pSchema->file_format = (u8)meta[BTREE_FILE_FORMAT-1];
danielk1977da184232006-01-05 11:34:32 +0000290 if( pDb->pSchema->file_format==0 ){
291 pDb->pSchema->file_format = 1;
drhfdd6e852005-12-16 01:06:16 +0000292 }
danielk1977da184232006-01-05 11:34:32 +0000293 if( pDb->pSchema->file_format>SQLITE_MAX_FILE_FORMAT ){
drhf089aa42008-07-08 19:34:06 +0000294 sqlite3SetString(pzErrMsg, db, "unsupported file format");
danielk1977cd3e8f72008-03-25 09:47:35 +0000295 rc = SQLITE_ERROR;
drh701bb3b2008-08-02 03:50:39 +0000296 goto initone_error_out;
danielk1977fa256a32005-05-25 04:11:56 +0000297 }
298
drh4aa2bfe2007-11-28 13:43:16 +0000299 /* Ticket #2804: When we open a database in the newer file format,
300 ** clear the legacy_file_format pragma flag so that a VACUUM will
301 ** not downgrade the database and thus invalidate any descending
302 ** indices that the user might have created.
303 */
danielk19770d19f7a2009-06-03 11:25:07 +0000304 if( iDb==0 && meta[BTREE_FILE_FORMAT-1]>=4 ){
drh4aa2bfe2007-11-28 13:43:16 +0000305 db->flags &= ~SQLITE_LegacyFileFmt;
306 }
danielk1977fa256a32005-05-25 04:11:56 +0000307
308 /* Read the schema information out of the schema tables
309 */
310 assert( db->init.busy );
drh9da742f2009-06-16 17:49:36 +0000311 {
danielk1977fa256a32005-05-25 04:11:56 +0000312 char *zSql;
danielk19771e536952007-08-16 10:09:01 +0000313 zSql = sqlite3MPrintf(db,
drhece3c722006-09-23 20:36:01 +0000314 "SELECT name, rootpage, sql FROM '%q'.%s",
315 db->aDb[iDb].zName, zMasterName);
drh7e8b8482008-01-23 03:03:05 +0000316 (void)sqlite3SafetyOff(db);
drha6d0ffc2007-10-12 20:42:28 +0000317#ifndef SQLITE_OMIT_AUTHORIZATION
318 {
319 int (*xAuth)(void*,int,const char*,const char*,const char*,const char*);
320 xAuth = db->xAuth;
321 db->xAuth = 0;
322#endif
323 rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
324#ifndef SQLITE_OMIT_AUTHORIZATION
325 db->xAuth = xAuth;
326 }
327#endif
drhc456e572008-08-11 18:44:58 +0000328 if( rc==SQLITE_OK ) rc = initData.rc;
drh7e8b8482008-01-23 03:03:05 +0000329 (void)sqlite3SafetyOn(db);
drh633e6d52008-07-28 19:34:53 +0000330 sqlite3DbFree(db, zSql);
drh497e4462005-07-23 03:18:40 +0000331#ifndef SQLITE_OMIT_ANALYZE
332 if( rc==SQLITE_OK ){
333 sqlite3AnalysisLoad(db, iDb);
334 }
335#endif
danielk1977fa256a32005-05-25 04:11:56 +0000336 }
drh17435752007-08-16 04:30:38 +0000337 if( db->mallocFailed ){
danielk1977fa256a32005-05-25 04:11:56 +0000338 rc = SQLITE_NOMEM;
339 sqlite3ResetInternalSchema(db, 0);
340 }
danielk197734c68fb2007-03-14 15:37:04 +0000341 if( rc==SQLITE_OK || (db->flags&SQLITE_RecoveryMode)){
342 /* Black magic: If the SQLITE_RecoveryMode flag is set, then consider
shanebe217792009-03-05 04:20:31 +0000343 ** the schema loaded, even if errors occurred. In this situation the
danielk197734c68fb2007-03-14 15:37:04 +0000344 ** current sqlite3_prepare() operation will fail, but the following one
345 ** will attempt to compile the supplied statement against whatever subset
shanebe217792009-03-05 04:20:31 +0000346 ** of the schema was loaded before the error occurred. The primary
danielk197734c68fb2007-03-14 15:37:04 +0000347 ** purpose of this is to allow access to the sqlite_master table
drh85b623f2007-12-13 21:54:09 +0000348 ** even when its contents have been corrupted.
danielk197734c68fb2007-03-14 15:37:04 +0000349 */
danielk1977fa256a32005-05-25 04:11:56 +0000350 DbSetProperty(db, iDb, DB_SchemaLoaded);
danielk197734c68fb2007-03-14 15:37:04 +0000351 rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000352 }
danielk1977cd3e8f72008-03-25 09:47:35 +0000353
354 /* Jump here for an error that occurs after successfully allocating
355 ** curMain and calling sqlite3BtreeEnter(). For an error that occurs
356 ** before that point, jump to error_out.
357 */
drh701bb3b2008-08-02 03:50:39 +0000358initone_error_out:
danielk1977cd3e8f72008-03-25 09:47:35 +0000359 sqlite3BtreeCloseCursor(curMain);
360 sqlite3_free(curMain);
drhb1ab8ea2007-08-29 00:33:07 +0000361 sqlite3BtreeLeave(pDb->pBt);
danielk1977a1644fd2007-08-29 12:31:25 +0000362
363error_out:
danielk1977ae72d982007-10-03 08:46:44 +0000364 if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
danielk1977a1644fd2007-08-29 12:31:25 +0000365 db->mallocFailed = 1;
366 }
danielk1977fa256a32005-05-25 04:11:56 +0000367 return rc;
368}
369
370/*
371** Initialize all database files - the main database file, the file
372** used to store temporary tables, and any additional database files
373** created using ATTACH statements. Return a success code. If an
374** error occurs, write an error message into *pzErrMsg.
375**
danielk1977e7259292006-01-13 06:33:23 +0000376** After a database is initialized, the DB_SchemaLoaded bit is set
377** bit is set in the flags field of the Db structure. If the database
378** file was of zero-length, then the DB_Empty flag is also set.
danielk1977fa256a32005-05-25 04:11:56 +0000379*/
380int sqlite3Init(sqlite3 *db, char **pzErrMsg){
381 int i, rc;
danielk19775814c1a2007-08-13 14:41:19 +0000382 int commit_internal = !(db->flags&SQLITE_InternChanges);
danielk1977fa256a32005-05-25 04:11:56 +0000383
drhb1ab8ea2007-08-29 00:33:07 +0000384 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000385 rc = SQLITE_OK;
386 db->init.busy = 1;
387 for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
388 if( DbHasProperty(db, i, DB_SchemaLoaded) || i==1 ) continue;
389 rc = sqlite3InitOne(db, i, pzErrMsg);
390 if( rc ){
391 sqlite3ResetInternalSchema(db, i);
392 }
393 }
394
395 /* Once all the other databases have been initialised, load the schema
396 ** for the TEMP database. This is loaded last, as the TEMP database
397 ** schema may contain references to objects in other databases.
398 */
399#ifndef SQLITE_OMIT_TEMPDB
drh9da742f2009-06-16 17:49:36 +0000400 if( rc==SQLITE_OK && ALWAYS(db->nDb>1)
401 && !DbHasProperty(db, 1, DB_SchemaLoaded) ){
danielk1977fa256a32005-05-25 04:11:56 +0000402 rc = sqlite3InitOne(db, 1, pzErrMsg);
403 if( rc ){
404 sqlite3ResetInternalSchema(db, 1);
405 }
406 }
407#endif
408
409 db->init.busy = 0;
danielk19775814c1a2007-08-13 14:41:19 +0000410 if( rc==SQLITE_OK && commit_internal ){
danielk1977fa256a32005-05-25 04:11:56 +0000411 sqlite3CommitInternalChanges(db);
412 }
413
danielk1977b82e7ed2006-01-11 14:09:31 +0000414 return rc;
danielk1977fa256a32005-05-25 04:11:56 +0000415}
416
417/*
418** This routine is a no-op if the database schema is already initialised.
419** Otherwise, the schema is loaded. An error code is returned.
420*/
421int sqlite3ReadSchema(Parse *pParse){
422 int rc = SQLITE_OK;
423 sqlite3 *db = pParse->db;
drhb1ab8ea2007-08-29 00:33:07 +0000424 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000425 if( !db->init.busy ){
danielk1977b82e7ed2006-01-11 14:09:31 +0000426 rc = sqlite3Init(db, &pParse->zErrMsg);
danielk1977fa256a32005-05-25 04:11:56 +0000427 }
danielk1977fa256a32005-05-25 04:11:56 +0000428 if( rc!=SQLITE_OK ){
429 pParse->rc = rc;
430 pParse->nErr++;
431 }
432 return rc;
433}
434
435
436/*
437** Check schema cookies in all databases. If any cookie is out
438** of date, return 0. If all schema cookies are current, return 1.
439*/
440static int schemaIsValid(sqlite3 *db){
441 int iDb;
442 int rc;
443 BtCursor *curTemp;
444 int cookie;
445 int allOk = 1;
446
drhe5ae5732008-06-15 02:51:47 +0000447 curTemp = (BtCursor *)sqlite3Malloc(sqlite3BtreeCursorSize());
danielk1977cd3e8f72008-03-25 09:47:35 +0000448 if( curTemp ){
449 assert( sqlite3_mutex_held(db->mutex) );
450 for(iDb=0; allOk && iDb<db->nDb; iDb++){
451 Btree *pBt;
452 pBt = db->aDb[iDb].pBt;
453 if( pBt==0 ) continue;
454 memset(curTemp, 0, sqlite3BtreeCursorSize());
455 rc = sqlite3BtreeCursor(pBt, MASTER_ROOT, 0, 0, curTemp);
456 if( rc==SQLITE_OK ){
danielk19770d19f7a2009-06-03 11:25:07 +0000457 rc = sqlite3BtreeGetMeta(pBt, BTREE_SCHEMA_VERSION, (u32 *)&cookie);
drh58fbb312009-06-17 00:35:30 +0000458 if( ALWAYS(rc==SQLITE_OK)
459 && cookie!=db->aDb[iDb].pSchema->schema_cookie ){
danielk1977cd3e8f72008-03-25 09:47:35 +0000460 allOk = 0;
461 }
462 sqlite3BtreeCloseCursor(curTemp);
danielk1977fa256a32005-05-25 04:11:56 +0000463 }
drh58fbb312009-06-17 00:35:30 +0000464 if( NEVER(rc==SQLITE_NOMEM) || rc==SQLITE_IOERR_NOMEM ){
danielk1977cd3e8f72008-03-25 09:47:35 +0000465 db->mallocFailed = 1;
466 }
danielk1977fa256a32005-05-25 04:11:56 +0000467 }
danielk1977cd3e8f72008-03-25 09:47:35 +0000468 sqlite3_free(curTemp);
469 }else{
470 allOk = 0;
471 db->mallocFailed = 1;
danielk1977fa256a32005-05-25 04:11:56 +0000472 }
danielk1977cd3e8f72008-03-25 09:47:35 +0000473
danielk1977fa256a32005-05-25 04:11:56 +0000474 return allOk;
475}
476
477/*
drhf248e212006-01-25 22:50:38 +0000478** Convert a schema pointer into the iDb index that indicates
479** which database file in db->aDb[] the schema refers to.
480**
481** If the same database is attached more than once, the first
482** attached database is returned.
483*/
danielk1977e501b892006-01-09 06:29:47 +0000484int sqlite3SchemaToIndex(sqlite3 *db, Schema *pSchema){
drh198bf392006-01-06 21:52:49 +0000485 int i = -1000000;
486
487 /* If pSchema is NULL, then return -1000000. This happens when code in
488 ** expr.c is trying to resolve a reference to a transient table (i.e. one
489 ** created by a sub-select). In this case the return value of this
490 ** function should never be used.
491 **
492 ** We return -1000000 instead of the more usual -1 simply because using
drh1c767f02009-01-09 02:49:31 +0000493 ** -1000000 as the incorrect index into db->aDb[] is much
drh198bf392006-01-06 21:52:49 +0000494 ** more likely to cause a segfault than -1 (of course there are assert()
495 ** statements too, but it never hurts to play the odds).
496 */
drhb1ab8ea2007-08-29 00:33:07 +0000497 assert( sqlite3_mutex_held(db->mutex) );
drh198bf392006-01-06 21:52:49 +0000498 if( pSchema ){
drh1c767f02009-01-09 02:49:31 +0000499 for(i=0; ALWAYS(i<db->nDb); i++){
drh198bf392006-01-06 21:52:49 +0000500 if( db->aDb[i].pSchema==pSchema ){
501 break;
502 }
503 }
drh1c767f02009-01-09 02:49:31 +0000504 assert( i>=0 && i<db->nDb );
drh198bf392006-01-06 21:52:49 +0000505 }
506 return i;
507}
508
509/*
danielk1977fa256a32005-05-25 04:11:56 +0000510** Compile the UTF-8 encoded SQL statement zSql into a statement handle.
511*/
mlcreech3a00f902008-03-04 17:45:01 +0000512static int sqlite3Prepare(
danielk1977fa256a32005-05-25 04:11:56 +0000513 sqlite3 *db, /* Database handle. */
514 const char *zSql, /* UTF-8 encoded SQL statement. */
515 int nBytes, /* Length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +0000516 int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
danielk1977fa256a32005-05-25 04:11:56 +0000517 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
drhb900aaf2006-11-09 00:24:53 +0000518 const char **pzTail /* OUT: End of parsed string */
danielk1977fa256a32005-05-25 04:11:56 +0000519){
drhe7b347072009-06-01 18:18:20 +0000520 Parse *pParse; /* Parsing context */
521 char *zErrMsg = 0; /* Error message */
522 int rc = SQLITE_OK; /* Result code */
523 int i; /* Loop counter */
danielk1977fa256a32005-05-25 04:11:56 +0000524
drhe7b347072009-06-01 18:18:20 +0000525 /* Allocate the parsing context */
526 pParse = sqlite3StackAllocZero(db, sizeof(*pParse));
527 if( pParse==0 ){
528 rc = SQLITE_NOMEM;
529 goto end_prepare;
530 }
531
532 if( sqlite3SafetyOn(db) ){
533 rc = SQLITE_MISUSE;
534 goto end_prepare;
535 }
drh860e0772009-04-02 18:32:26 +0000536 assert( ppStmt && *ppStmt==0 );
drh86f8c192007-08-22 00:39:19 +0000537 assert( !db->mallocFailed );
drhb21c8cd2007-08-21 19:33:56 +0000538 assert( sqlite3_mutex_held(db->mutex) );
danielk1977fa256a32005-05-25 04:11:56 +0000539
drhc74d0b1d2009-02-24 16:18:05 +0000540 /* Check to verify that it is possible to get a read lock on all
541 ** database schemas. The inability to get a read lock indicates that
542 ** some other database connection is holding a write-lock, which in
543 ** turn means that the other connection has made uncommitted changes
544 ** to the schema.
545 **
546 ** Were we to proceed and prepare the statement against the uncommitted
547 ** schema changes and if those schema changes are subsequently rolled
548 ** back and different changes are made in their place, then when this
549 ** prepared statement goes to run the schema cookie would fail to detect
550 ** the schema change. Disaster would follow.
551 **
552 ** This thread is currently holding mutexes on all Btrees (because
553 ** of the sqlite3BtreeEnterAll() in sqlite3LockAndPrepare()) so it
554 ** is not possible for another thread to start a new schema change
555 ** while this routine is running. Hence, we do not need to hold
556 ** locks on the schema, we just need to make sure nobody else is
557 ** holding them.
558 **
559 ** Note that setting READ_UNCOMMITTED overrides most lock detection,
560 ** but it does *not* override schema lock detection, so this all still
561 ** works even if READ_UNCOMMITTED is set.
danielk1977c87d34d2006-01-06 13:00:28 +0000562 */
563 for(i=0; i<db->nDb; i++) {
564 Btree *pBt = db->aDb[i].pBt;
drhb1ab8ea2007-08-29 00:33:07 +0000565 if( pBt ){
drhc74d0b1d2009-02-24 16:18:05 +0000566 assert( sqlite3BtreeHoldsMutex(pBt) );
drhb1ab8ea2007-08-29 00:33:07 +0000567 rc = sqlite3BtreeSchemaLocked(pBt);
568 if( rc ){
569 const char *zDb = db->aDb[i].zName;
danielk1977404ca072009-03-16 13:19:36 +0000570 sqlite3Error(db, rc, "database schema is locked: %s", zDb);
drh7e8b8482008-01-23 03:03:05 +0000571 (void)sqlite3SafetyOff(db);
drhc74d0b1d2009-02-24 16:18:05 +0000572 testcase( db->flags & SQLITE_ReadUncommitted );
drhe7b347072009-06-01 18:18:20 +0000573 goto end_prepare;
drhb1ab8ea2007-08-29 00:33:07 +0000574 }
danielk1977c87d34d2006-01-06 13:00:28 +0000575 }
576 }
drhe7b347072009-06-01 18:18:20 +0000577
578
579 pParse->db = db;
drhd2d88bb2008-05-23 14:32:18 +0000580 if( nBytes>=0 && (nBytes==0 || zSql[nBytes-1]!=0) ){
drhe5c941b2007-05-08 13:58:26 +0000581 char *zSqlCopy;
drhbb4957f2008-03-20 14:03:29 +0000582 int mxLen = db->aLimit[SQLITE_LIMIT_SQL_LENGTH];
drh58fbb312009-06-17 00:35:30 +0000583 testcase( nBytes==mxLen );
584 testcase( nBytes==mxLen+1 );
drhbb4957f2008-03-20 14:03:29 +0000585 if( nBytes>mxLen ){
drhbe69bf62007-12-18 17:50:33 +0000586 sqlite3Error(db, SQLITE_TOOBIG, "statement too long");
drh7e8b8482008-01-23 03:03:05 +0000587 (void)sqlite3SafetyOff(db);
drhe7b347072009-06-01 18:18:20 +0000588 rc = sqlite3ApiExit(db, SQLITE_TOOBIG);
589 goto end_prepare;
drhe5c941b2007-05-08 13:58:26 +0000590 }
drh17435752007-08-16 04:30:38 +0000591 zSqlCopy = sqlite3DbStrNDup(db, zSql, nBytes);
drh276fdbf2007-04-30 21:39:16 +0000592 if( zSqlCopy ){
drhe7b347072009-06-01 18:18:20 +0000593 sqlite3RunParser(pParse, zSqlCopy, &zErrMsg);
drh633e6d52008-07-28 19:34:53 +0000594 sqlite3DbFree(db, zSqlCopy);
drhe7b347072009-06-01 18:18:20 +0000595 pParse->zTail = &zSql[pParse->zTail-zSqlCopy];
danielk19773a2c8c82008-04-03 14:36:25 +0000596 }else{
drhe7b347072009-06-01 18:18:20 +0000597 pParse->zTail = &zSql[nBytes];
drh276fdbf2007-04-30 21:39:16 +0000598 }
drh9051a422006-01-30 22:35:43 +0000599 }else{
drhe7b347072009-06-01 18:18:20 +0000600 sqlite3RunParser(pParse, zSql, &zErrMsg);
drh9051a422006-01-30 22:35:43 +0000601 }
danielk1977fa256a32005-05-25 04:11:56 +0000602
drh17435752007-08-16 04:30:38 +0000603 if( db->mallocFailed ){
drhe7b347072009-06-01 18:18:20 +0000604 pParse->rc = SQLITE_NOMEM;
danielk1977fa256a32005-05-25 04:11:56 +0000605 }
drhe7b347072009-06-01 18:18:20 +0000606 if( pParse->rc==SQLITE_DONE ) pParse->rc = SQLITE_OK;
607 if( pParse->checkSchema && !schemaIsValid(db) ){
608 pParse->rc = SQLITE_SCHEMA;
danielk1977fa256a32005-05-25 04:11:56 +0000609 }
drhe7b347072009-06-01 18:18:20 +0000610 if( pParse->rc==SQLITE_SCHEMA ){
danielk1977fa256a32005-05-25 04:11:56 +0000611 sqlite3ResetInternalSchema(db, 0);
612 }
drh17435752007-08-16 04:30:38 +0000613 if( db->mallocFailed ){
drhe7b347072009-06-01 18:18:20 +0000614 pParse->rc = SQLITE_NOMEM;
drh344a6272006-06-26 12:50:09 +0000615 }
drhb900aaf2006-11-09 00:24:53 +0000616 if( pzTail ){
drhe7b347072009-06-01 18:18:20 +0000617 *pzTail = pParse->zTail;
drhb900aaf2006-11-09 00:24:53 +0000618 }
drhe7b347072009-06-01 18:18:20 +0000619 rc = pParse->rc;
danielk1977fa256a32005-05-25 04:11:56 +0000620
621#ifndef SQLITE_OMIT_EXPLAIN
drhe7b347072009-06-01 18:18:20 +0000622 if( rc==SQLITE_OK && pParse->pVdbe && pParse->explain ){
623 static const char * const azColName[] = {
624 "addr", "opcode", "p1", "p2", "p3", "p4", "p5", "comment",
625 "order", "from", "detail"
626 };
627 int iFirst, mx;
628 if( pParse->explain==2 ){
629 sqlite3VdbeSetNumCols(pParse->pVdbe, 3);
630 iFirst = 8;
631 mx = 11;
drhecc92422005-09-10 16:46:12 +0000632 }else{
drhe7b347072009-06-01 18:18:20 +0000633 sqlite3VdbeSetNumCols(pParse->pVdbe, 8);
634 iFirst = 0;
635 mx = 8;
636 }
637 for(i=iFirst; i<mx; i++){
638 sqlite3VdbeSetColName(pParse->pVdbe, i-iFirst, COLNAME_NAME,
639 azColName[i], SQLITE_STATIC);
drhecc92422005-09-10 16:46:12 +0000640 }
drhb900aaf2006-11-09 00:24:53 +0000641 }
danielk1977fa256a32005-05-25 04:11:56 +0000642#endif
643
danielk1977fa256a32005-05-25 04:11:56 +0000644 if( sqlite3SafetyOff(db) ){
645 rc = SQLITE_MISUSE;
646 }
danielk19777e29e952007-04-19 11:09:01 +0000647
danielk19776ab3a2e2009-02-19 14:39:25 +0000648 assert( db->init.busy==0 || saveSqlFlag==0 );
649 if( db->init.busy==0 ){
drhe7b347072009-06-01 18:18:20 +0000650 Vdbe *pVdbe = pParse->pVdbe;
651 sqlite3VdbeSetSql(pVdbe, zSql, (int)(pParse->zTail-zSql), saveSqlFlag);
danielk19777e29e952007-04-19 11:09:01 +0000652 }
drhe7b347072009-06-01 18:18:20 +0000653 if( pParse->pVdbe && (rc!=SQLITE_OK || db->mallocFailed) ){
654 sqlite3VdbeFinalize(pParse->pVdbe);
danielk19777e29e952007-04-19 11:09:01 +0000655 assert(!(*ppStmt));
656 }else{
drhe7b347072009-06-01 18:18:20 +0000657 *ppStmt = (sqlite3_stmt*)pParse->pVdbe;
danielk1977fa256a32005-05-25 04:11:56 +0000658 }
659
660 if( zErrMsg ){
661 sqlite3Error(db, rc, "%s", zErrMsg);
drh633e6d52008-07-28 19:34:53 +0000662 sqlite3DbFree(db, zErrMsg);
danielk1977fa256a32005-05-25 04:11:56 +0000663 }else{
664 sqlite3Error(db, rc, 0);
665 }
danielk1977261919c2005-12-06 12:52:59 +0000666
drhe7b347072009-06-01 18:18:20 +0000667end_prepare:
668
669 sqlite3StackFree(db, pParse);
danielk197754f01982006-01-18 15:25:17 +0000670 rc = sqlite3ApiExit(db, rc);
drh4ac285a2006-09-15 07:28:50 +0000671 assert( (rc&db->errMask)==rc );
danielk1977fa256a32005-05-25 04:11:56 +0000672 return rc;
673}
drhb21c8cd2007-08-21 19:33:56 +0000674static int sqlite3LockAndPrepare(
675 sqlite3 *db, /* Database handle. */
676 const char *zSql, /* UTF-8 encoded SQL statement. */
677 int nBytes, /* Length of zSql in bytes. */
678 int saveSqlFlag, /* True to copy SQL text into the sqlite3_stmt */
679 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
680 const char **pzTail /* OUT: End of parsed string */
681){
682 int rc;
drh860e0772009-04-02 18:32:26 +0000683 assert( ppStmt!=0 );
684 *ppStmt = 0;
drh7e8b8482008-01-23 03:03:05 +0000685 if( !sqlite3SafetyCheckOk(db) ){
drh27641702007-08-22 02:56:42 +0000686 return SQLITE_MISUSE;
687 }
drhb21c8cd2007-08-21 19:33:56 +0000688 sqlite3_mutex_enter(db->mutex);
drhb1ab8ea2007-08-29 00:33:07 +0000689 sqlite3BtreeEnterAll(db);
drhb21c8cd2007-08-21 19:33:56 +0000690 rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, ppStmt, pzTail);
drh9da742f2009-06-16 17:49:36 +0000691 if( rc==SQLITE_SCHEMA ){
692 sqlite3_finalize(*ppStmt);
693 rc = sqlite3Prepare(db, zSql, nBytes, saveSqlFlag, ppStmt, pzTail);
694 }
drhb1ab8ea2007-08-29 00:33:07 +0000695 sqlite3BtreeLeaveAll(db);
drhb21c8cd2007-08-21 19:33:56 +0000696 sqlite3_mutex_leave(db->mutex);
697 return rc;
698}
danielk1977fa256a32005-05-25 04:11:56 +0000699
drhb900aaf2006-11-09 00:24:53 +0000700/*
701** Rerun the compilation of a statement after a schema change.
danielk197765a2ea12009-03-19 07:58:31 +0000702**
703** If the statement is successfully recompiled, return SQLITE_OK. Otherwise,
704** if the statement cannot be recompiled because another connection has
705** locked the sqlite3_master table, return SQLITE_LOCKED. If any other error
706** occurs, return SQLITE_SCHEMA.
drhb900aaf2006-11-09 00:24:53 +0000707*/
708int sqlite3Reprepare(Vdbe *p){
709 int rc;
drh4f0c5872007-03-26 22:05:01 +0000710 sqlite3_stmt *pNew;
drhb900aaf2006-11-09 00:24:53 +0000711 const char *zSql;
712 sqlite3 *db;
drhb21c8cd2007-08-21 19:33:56 +0000713
drhb1ab8ea2007-08-29 00:33:07 +0000714 assert( sqlite3_mutex_held(sqlite3VdbeDb(p)->mutex) );
danielk1977d0e2a852007-11-14 06:48:48 +0000715 zSql = sqlite3_sql((sqlite3_stmt *)p);
drhc4dd3fd2008-01-22 01:48:05 +0000716 assert( zSql!=0 ); /* Reprepare only called for prepare_v2() statements */
drhb900aaf2006-11-09 00:24:53 +0000717 db = sqlite3VdbeDb(p);
drhb21c8cd2007-08-21 19:33:56 +0000718 assert( sqlite3_mutex_held(db->mutex) );
drhb1ab8ea2007-08-29 00:33:07 +0000719 rc = sqlite3LockAndPrepare(db, zSql, -1, 0, &pNew, 0);
drhb900aaf2006-11-09 00:24:53 +0000720 if( rc ){
danielk19778e556522007-11-13 10:30:24 +0000721 if( rc==SQLITE_NOMEM ){
722 db->mallocFailed = 1;
723 }
drhb900aaf2006-11-09 00:24:53 +0000724 assert( pNew==0 );
danielk197765a2ea12009-03-19 07:58:31 +0000725 return (rc==SQLITE_LOCKED) ? SQLITE_LOCKED : SQLITE_SCHEMA;
drhb900aaf2006-11-09 00:24:53 +0000726 }else{
727 assert( pNew!=0 );
728 }
drh4f0c5872007-03-26 22:05:01 +0000729 sqlite3VdbeSwap((Vdbe*)pNew, p);
shane145834a2008-09-04 12:03:42 +0000730 sqlite3TransferBindings(pNew, (sqlite3_stmt*)p);
drh4f0c5872007-03-26 22:05:01 +0000731 sqlite3VdbeResetStepResult((Vdbe*)pNew);
732 sqlite3VdbeFinalize((Vdbe*)pNew);
danielk197765a2ea12009-03-19 07:58:31 +0000733 return SQLITE_OK;
drhb900aaf2006-11-09 00:24:53 +0000734}
735
736
737/*
738** Two versions of the official API. Legacy and new use. In the legacy
739** version, the original SQL text is not saved in the prepared statement
740** and so if a schema change occurs, SQLITE_SCHEMA is returned by
741** sqlite3_step(). In the new version, the original SQL text is retained
742** and the statement is automatically recompiled if an schema change
743** occurs.
744*/
745int sqlite3_prepare(
746 sqlite3 *db, /* Database handle. */
747 const char *zSql, /* UTF-8 encoded SQL statement. */
748 int nBytes, /* Length of zSql in bytes. */
749 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
750 const char **pzTail /* OUT: End of parsed string */
751){
drh17eaae72008-03-03 18:47:28 +0000752 int rc;
753 rc = sqlite3LockAndPrepare(db,zSql,nBytes,0,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000754 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000755 return rc;
drhb900aaf2006-11-09 00:24:53 +0000756}
757int sqlite3_prepare_v2(
758 sqlite3 *db, /* Database handle. */
759 const char *zSql, /* UTF-8 encoded SQL statement. */
760 int nBytes, /* Length of zSql in bytes. */
761 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
762 const char **pzTail /* OUT: End of parsed string */
763){
drh17eaae72008-03-03 18:47:28 +0000764 int rc;
765 rc = sqlite3LockAndPrepare(db,zSql,nBytes,1,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000766 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000767 return rc;
drhb900aaf2006-11-09 00:24:53 +0000768}
769
770
danielk1977fa256a32005-05-25 04:11:56 +0000771#ifndef SQLITE_OMIT_UTF16
772/*
773** Compile the UTF-16 encoded SQL statement zSql into a statement handle.
774*/
drhb900aaf2006-11-09 00:24:53 +0000775static int sqlite3Prepare16(
danielk1977fa256a32005-05-25 04:11:56 +0000776 sqlite3 *db, /* Database handle. */
777 const void *zSql, /* UTF-8 encoded SQL statement. */
778 int nBytes, /* Length of zSql in bytes. */
drhb900aaf2006-11-09 00:24:53 +0000779 int saveSqlFlag, /* True to save SQL text into the sqlite3_stmt */
danielk1977fa256a32005-05-25 04:11:56 +0000780 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
781 const void **pzTail /* OUT: End of parsed string */
782){
783 /* This function currently works by first transforming the UTF-16
784 ** encoded string to UTF-8, then invoking sqlite3_prepare(). The
785 ** tricky bit is figuring out the pointer to return in *pzTail.
786 */
danielk197754f01982006-01-18 15:25:17 +0000787 char *zSql8;
danielk1977c87d34d2006-01-06 13:00:28 +0000788 const char *zTail8 = 0;
danielk197754f01982006-01-18 15:25:17 +0000789 int rc = SQLITE_OK;
danielk1977fa256a32005-05-25 04:11:56 +0000790
drh860e0772009-04-02 18:32:26 +0000791 assert( ppStmt );
drh769e97e2009-04-01 16:33:37 +0000792 *ppStmt = 0;
drh7e8b8482008-01-23 03:03:05 +0000793 if( !sqlite3SafetyCheckOk(db) ){
danielk1977fa256a32005-05-25 04:11:56 +0000794 return SQLITE_MISUSE;
795 }
drhb21c8cd2007-08-21 19:33:56 +0000796 sqlite3_mutex_enter(db->mutex);
danielk19771e536952007-08-16 10:09:01 +0000797 zSql8 = sqlite3Utf16to8(db, zSql, nBytes);
danielk197754f01982006-01-18 15:25:17 +0000798 if( zSql8 ){
drhb1ab8ea2007-08-29 00:33:07 +0000799 rc = sqlite3LockAndPrepare(db, zSql8, -1, saveSqlFlag, ppStmt, &zTail8);
danielk1977fa256a32005-05-25 04:11:56 +0000800 }
danielk1977fa256a32005-05-25 04:11:56 +0000801
802 if( zTail8 && pzTail ){
803 /* If sqlite3_prepare returns a tail pointer, we calculate the
804 ** equivalent pointer into the UTF-16 string by counting the unicode
805 ** characters between zSql8 and zTail8, and then returning a pointer
806 ** the same number of characters into the UTF-16 string.
807 */
drhea678832008-12-10 19:26:22 +0000808 int chars_parsed = sqlite3Utf8CharLen(zSql8, (int)(zTail8-zSql8));
drhee858132007-05-08 20:37:38 +0000809 *pzTail = (u8 *)zSql + sqlite3Utf16ByteLen(zSql, chars_parsed);
danielk1977fa256a32005-05-25 04:11:56 +0000810 }
drh633e6d52008-07-28 19:34:53 +0000811 sqlite3DbFree(db, zSql8);
drhb21c8cd2007-08-21 19:33:56 +0000812 rc = sqlite3ApiExit(db, rc);
813 sqlite3_mutex_leave(db->mutex);
814 return rc;
danielk1977fa256a32005-05-25 04:11:56 +0000815}
drhb900aaf2006-11-09 00:24:53 +0000816
817/*
818** Two versions of the official API. Legacy and new use. In the legacy
819** version, the original SQL text is not saved in the prepared statement
820** and so if a schema change occurs, SQLITE_SCHEMA is returned by
821** sqlite3_step(). In the new version, the original SQL text is retained
822** and the statement is automatically recompiled if an schema change
823** occurs.
824*/
825int sqlite3_prepare16(
826 sqlite3 *db, /* Database handle. */
827 const void *zSql, /* UTF-8 encoded SQL statement. */
828 int nBytes, /* Length of zSql in bytes. */
829 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
830 const void **pzTail /* OUT: End of parsed string */
831){
drh17eaae72008-03-03 18:47:28 +0000832 int rc;
833 rc = sqlite3Prepare16(db,zSql,nBytes,0,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000834 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000835 return rc;
drhb900aaf2006-11-09 00:24:53 +0000836}
837int sqlite3_prepare16_v2(
838 sqlite3 *db, /* Database handle. */
839 const void *zSql, /* UTF-8 encoded SQL statement. */
840 int nBytes, /* Length of zSql in bytes. */
841 sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
842 const void **pzTail /* OUT: End of parsed string */
843){
drh17eaae72008-03-03 18:47:28 +0000844 int rc;
845 rc = sqlite3Prepare16(db,zSql,nBytes,1,ppStmt,pzTail);
drh58edb652008-03-08 12:23:30 +0000846 assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
drh17eaae72008-03-03 18:47:28 +0000847 return rc;
drhb900aaf2006-11-09 00:24:53 +0000848}
849
danielk1977fa256a32005-05-25 04:11:56 +0000850#endif /* SQLITE_OMIT_UTF16 */