Further corrections to read-only SHM file handling on Win32.
[sqlite.git] / src / build.c
blobfc4dbcdba83324f92adcae382e81b3a0635fc1fb
1 /*
2 ** 2001 September 15
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.
11 *************************************************************************
12 ** This file contains C code routines that are called by the SQLite parser
13 ** when syntax rules are reduced. The routines in this file handle the
14 ** following kinds of SQL syntax:
16 ** CREATE TABLE
17 ** DROP TABLE
18 ** CREATE INDEX
19 ** DROP INDEX
20 ** creating ID lists
21 ** BEGIN TRANSACTION
22 ** COMMIT
23 ** ROLLBACK
25 #include "sqliteInt.h"
27 #ifndef SQLITE_OMIT_SHARED_CACHE
29 ** The TableLock structure is only used by the sqlite3TableLock() and
30 ** codeTableLocks() functions.
32 struct TableLock {
33 int iDb; /* The database containing the table to be locked */
34 int iTab; /* The root page of the table to be locked */
35 u8 isWriteLock; /* True for write lock. False for a read lock */
36 const char *zLockName; /* Name of the table */
40 ** Record the fact that we want to lock a table at run-time.
42 ** The table to be locked has root page iTab and is found in database iDb.
43 ** A read or a write lock can be taken depending on isWritelock.
45 ** This routine just records the fact that the lock is desired. The
46 ** code to make the lock occur is generated by a later call to
47 ** codeTableLocks() which occurs during sqlite3FinishCoding().
49 void sqlite3TableLock(
50 Parse *pParse, /* Parsing context */
51 int iDb, /* Index of the database containing the table to lock */
52 int iTab, /* Root page number of the table to be locked */
53 u8 isWriteLock, /* True for a write lock */
54 const char *zName /* Name of the table to be locked */
56 Parse *pToplevel = sqlite3ParseToplevel(pParse);
57 int i;
58 int nBytes;
59 TableLock *p;
60 assert( iDb>=0 );
62 if( iDb==1 ) return;
63 if( !sqlite3BtreeSharable(pParse->db->aDb[iDb].pBt) ) return;
64 for(i=0; i<pToplevel->nTableLock; i++){
65 p = &pToplevel->aTableLock[i];
66 if( p->iDb==iDb && p->iTab==iTab ){
67 p->isWriteLock = (p->isWriteLock || isWriteLock);
68 return;
72 nBytes = sizeof(TableLock) * (pToplevel->nTableLock+1);
73 pToplevel->aTableLock =
74 sqlite3DbReallocOrFree(pToplevel->db, pToplevel->aTableLock, nBytes);
75 if( pToplevel->aTableLock ){
76 p = &pToplevel->aTableLock[pToplevel->nTableLock++];
77 p->iDb = iDb;
78 p->iTab = iTab;
79 p->isWriteLock = isWriteLock;
80 p->zLockName = zName;
81 }else{
82 pToplevel->nTableLock = 0;
83 sqlite3OomFault(pToplevel->db);
88 ** Code an OP_TableLock instruction for each table locked by the
89 ** statement (configured by calls to sqlite3TableLock()).
91 static void codeTableLocks(Parse *pParse){
92 int i;
93 Vdbe *pVdbe;
95 pVdbe = sqlite3GetVdbe(pParse);
96 assert( pVdbe!=0 ); /* sqlite3GetVdbe cannot fail: VDBE already allocated */
98 for(i=0; i<pParse->nTableLock; i++){
99 TableLock *p = &pParse->aTableLock[i];
100 int p1 = p->iDb;
101 sqlite3VdbeAddOp4(pVdbe, OP_TableLock, p1, p->iTab, p->isWriteLock,
102 p->zLockName, P4_STATIC);
105 #else
106 #define codeTableLocks(x)
107 #endif
110 ** Return TRUE if the given yDbMask object is empty - if it contains no
111 ** 1 bits. This routine is used by the DbMaskAllZero() and DbMaskNotZero()
112 ** macros when SQLITE_MAX_ATTACHED is greater than 30.
114 #if SQLITE_MAX_ATTACHED>30
115 int sqlite3DbMaskAllZero(yDbMask m){
116 int i;
117 for(i=0; i<sizeof(yDbMask); i++) if( m[i] ) return 0;
118 return 1;
120 #endif
123 ** This routine is called after a single SQL statement has been
124 ** parsed and a VDBE program to execute that statement has been
125 ** prepared. This routine puts the finishing touches on the
126 ** VDBE program and resets the pParse structure for the next
127 ** parse.
129 ** Note that if an error occurred, it might be the case that
130 ** no VDBE code was generated.
132 void sqlite3FinishCoding(Parse *pParse){
133 sqlite3 *db;
134 Vdbe *v;
136 assert( pParse->pToplevel==0 );
137 db = pParse->db;
138 if( pParse->nested ) return;
139 if( db->mallocFailed || pParse->nErr ){
140 if( pParse->rc==SQLITE_OK ) pParse->rc = SQLITE_ERROR;
141 return;
144 /* Begin by generating some termination code at the end of the
145 ** vdbe program
147 v = sqlite3GetVdbe(pParse);
148 assert( !pParse->isMultiWrite
149 || sqlite3VdbeAssertMayAbort(v, pParse->mayAbort));
150 if( v ){
151 sqlite3VdbeAddOp0(v, OP_Halt);
153 #if SQLITE_USER_AUTHENTICATION
154 if( pParse->nTableLock>0 && db->init.busy==0 ){
155 sqlite3UserAuthInit(db);
156 if( db->auth.authLevel<UAUTH_User ){
157 sqlite3ErrorMsg(pParse, "user not authenticated");
158 pParse->rc = SQLITE_AUTH_USER;
159 return;
162 #endif
164 /* The cookie mask contains one bit for each database file open.
165 ** (Bit 0 is for main, bit 1 is for temp, and so forth.) Bits are
166 ** set for each database that is used. Generate code to start a
167 ** transaction on each used database and to verify the schema cookie
168 ** on each used database.
170 if( db->mallocFailed==0
171 && (DbMaskNonZero(pParse->cookieMask) || pParse->pConstExpr)
173 int iDb, i;
174 assert( sqlite3VdbeGetOp(v, 0)->opcode==OP_Init );
175 sqlite3VdbeJumpHere(v, 0);
176 for(iDb=0; iDb<db->nDb; iDb++){
177 Schema *pSchema;
178 if( DbMaskTest(pParse->cookieMask, iDb)==0 ) continue;
179 sqlite3VdbeUsesBtree(v, iDb);
180 pSchema = db->aDb[iDb].pSchema;
181 sqlite3VdbeAddOp4Int(v,
182 OP_Transaction, /* Opcode */
183 iDb, /* P1 */
184 DbMaskTest(pParse->writeMask,iDb), /* P2 */
185 pSchema->schema_cookie, /* P3 */
186 pSchema->iGeneration /* P4 */
188 if( db->init.busy==0 ) sqlite3VdbeChangeP5(v, 1);
189 VdbeComment((v,
190 "usesStmtJournal=%d", pParse->mayAbort && pParse->isMultiWrite));
192 #ifndef SQLITE_OMIT_VIRTUALTABLE
193 for(i=0; i<pParse->nVtabLock; i++){
194 char *vtab = (char *)sqlite3GetVTable(db, pParse->apVtabLock[i]);
195 sqlite3VdbeAddOp4(v, OP_VBegin, 0, 0, 0, vtab, P4_VTAB);
197 pParse->nVtabLock = 0;
198 #endif
200 /* Once all the cookies have been verified and transactions opened,
201 ** obtain the required table-locks. This is a no-op unless the
202 ** shared-cache feature is enabled.
204 codeTableLocks(pParse);
206 /* Initialize any AUTOINCREMENT data structures required.
208 sqlite3AutoincrementBegin(pParse);
210 /* Code constant expressions that where factored out of inner loops */
211 if( pParse->pConstExpr ){
212 ExprList *pEL = pParse->pConstExpr;
213 pParse->okConstFactor = 0;
214 for(i=0; i<pEL->nExpr; i++){
215 sqlite3ExprCode(pParse, pEL->a[i].pExpr, pEL->a[i].u.iConstExprReg);
219 /* Finally, jump back to the beginning of the executable code. */
220 sqlite3VdbeGoto(v, 1);
225 /* Get the VDBE program ready for execution
227 if( v && pParse->nErr==0 && !db->mallocFailed ){
228 assert( pParse->iCacheLevel==0 ); /* Disables and re-enables match */
229 /* A minimum of one cursor is required if autoincrement is used
230 * See ticket [a696379c1f08866] */
231 if( pParse->pAinc!=0 && pParse->nTab==0 ) pParse->nTab = 1;
232 sqlite3VdbeMakeReady(v, pParse);
233 pParse->rc = SQLITE_DONE;
234 }else{
235 pParse->rc = SQLITE_ERROR;
240 ** Run the parser and code generator recursively in order to generate
241 ** code for the SQL statement given onto the end of the pParse context
242 ** currently under construction. When the parser is run recursively
243 ** this way, the final OP_Halt is not appended and other initialization
244 ** and finalization steps are omitted because those are handling by the
245 ** outermost parser.
247 ** Not everything is nestable. This facility is designed to permit
248 ** INSERT, UPDATE, and DELETE operations against SQLITE_MASTER. Use
249 ** care if you decide to try to use this routine for some other purposes.
251 void sqlite3NestedParse(Parse *pParse, const char *zFormat, ...){
252 va_list ap;
253 char *zSql;
254 char *zErrMsg = 0;
255 sqlite3 *db = pParse->db;
256 char saveBuf[PARSE_TAIL_SZ];
258 if( pParse->nErr ) return;
259 assert( pParse->nested<10 ); /* Nesting should only be of limited depth */
260 va_start(ap, zFormat);
261 zSql = sqlite3VMPrintf(db, zFormat, ap);
262 va_end(ap);
263 if( zSql==0 ){
264 return; /* A malloc must have failed */
266 pParse->nested++;
267 memcpy(saveBuf, PARSE_TAIL(pParse), PARSE_TAIL_SZ);
268 memset(PARSE_TAIL(pParse), 0, PARSE_TAIL_SZ);
269 sqlite3RunParser(pParse, zSql, &zErrMsg);
270 sqlite3DbFree(db, zErrMsg);
271 sqlite3DbFree(db, zSql);
272 memcpy(PARSE_TAIL(pParse), saveBuf, PARSE_TAIL_SZ);
273 pParse->nested--;
276 #if SQLITE_USER_AUTHENTICATION
278 ** Return TRUE if zTable is the name of the system table that stores the
279 ** list of users and their access credentials.
281 int sqlite3UserAuthTable(const char *zTable){
282 return sqlite3_stricmp(zTable, "sqlite_user")==0;
284 #endif
287 ** Locate the in-memory structure that describes a particular database
288 ** table given the name of that table and (optionally) the name of the
289 ** database containing the table. Return NULL if not found.
291 ** If zDatabase is 0, all databases are searched for the table and the
292 ** first matching table is returned. (No checking for duplicate table
293 ** names is done.) The search order is TEMP first, then MAIN, then any
294 ** auxiliary databases added using the ATTACH command.
296 ** See also sqlite3LocateTable().
298 Table *sqlite3FindTable(sqlite3 *db, const char *zName, const char *zDatabase){
299 Table *p = 0;
300 int i;
302 /* All mutexes are required for schema access. Make sure we hold them. */
303 assert( zDatabase!=0 || sqlite3BtreeHoldsAllMutexes(db) );
304 #if SQLITE_USER_AUTHENTICATION
305 /* Only the admin user is allowed to know that the sqlite_user table
306 ** exists */
307 if( db->auth.authLevel<UAUTH_Admin && sqlite3UserAuthTable(zName)!=0 ){
308 return 0;
310 #endif
311 while(1){
312 for(i=OMIT_TEMPDB; i<db->nDb; i++){
313 int j = (i<2) ? i^1 : i; /* Search TEMP before MAIN */
314 if( zDatabase==0 || sqlite3StrICmp(zDatabase, db->aDb[j].zDbSName)==0 ){
315 assert( sqlite3SchemaMutexHeld(db, j, 0) );
316 p = sqlite3HashFind(&db->aDb[j].pSchema->tblHash, zName);
317 if( p ) return p;
320 /* Not found. If the name we were looking for was temp.sqlite_master
321 ** then change the name to sqlite_temp_master and try again. */
322 if( sqlite3StrICmp(zName, MASTER_NAME)!=0 ) break;
323 if( sqlite3_stricmp(zDatabase, db->aDb[1].zDbSName)!=0 ) break;
324 zName = TEMP_MASTER_NAME;
326 return 0;
330 ** Locate the in-memory structure that describes a particular database
331 ** table given the name of that table and (optionally) the name of the
332 ** database containing the table. Return NULL if not found. Also leave an
333 ** error message in pParse->zErrMsg.
335 ** The difference between this routine and sqlite3FindTable() is that this
336 ** routine leaves an error message in pParse->zErrMsg where
337 ** sqlite3FindTable() does not.
339 Table *sqlite3LocateTable(
340 Parse *pParse, /* context in which to report errors */
341 u32 flags, /* LOCATE_VIEW or LOCATE_NOERR */
342 const char *zName, /* Name of the table we are looking for */
343 const char *zDbase /* Name of the database. Might be NULL */
345 Table *p;
347 /* Read the database schema. If an error occurs, leave an error message
348 ** and code in pParse and return NULL. */
349 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
350 return 0;
353 p = sqlite3FindTable(pParse->db, zName, zDbase);
354 if( p==0 ){
355 const char *zMsg = flags & LOCATE_VIEW ? "no such view" : "no such table";
356 #ifndef SQLITE_OMIT_VIRTUALTABLE
357 if( sqlite3FindDbName(pParse->db, zDbase)<1 ){
358 /* If zName is the not the name of a table in the schema created using
359 ** CREATE, then check to see if it is the name of an virtual table that
360 ** can be an eponymous virtual table. */
361 Module *pMod = (Module*)sqlite3HashFind(&pParse->db->aModule, zName);
362 if( pMod==0 && sqlite3_strnicmp(zName, "pragma_", 7)==0 ){
363 pMod = sqlite3PragmaVtabRegister(pParse->db, zName);
365 if( pMod && sqlite3VtabEponymousTableInit(pParse, pMod) ){
366 return pMod->pEpoTab;
369 #endif
370 if( (flags & LOCATE_NOERR)==0 ){
371 if( zDbase ){
372 sqlite3ErrorMsg(pParse, "%s: %s.%s", zMsg, zDbase, zName);
373 }else{
374 sqlite3ErrorMsg(pParse, "%s: %s", zMsg, zName);
376 pParse->checkSchema = 1;
380 return p;
384 ** Locate the table identified by *p.
386 ** This is a wrapper around sqlite3LocateTable(). The difference between
387 ** sqlite3LocateTable() and this function is that this function restricts
388 ** the search to schema (p->pSchema) if it is not NULL. p->pSchema may be
389 ** non-NULL if it is part of a view or trigger program definition. See
390 ** sqlite3FixSrcList() for details.
392 Table *sqlite3LocateTableItem(
393 Parse *pParse,
394 u32 flags,
395 struct SrcList_item *p
397 const char *zDb;
398 assert( p->pSchema==0 || p->zDatabase==0 );
399 if( p->pSchema ){
400 int iDb = sqlite3SchemaToIndex(pParse->db, p->pSchema);
401 zDb = pParse->db->aDb[iDb].zDbSName;
402 }else{
403 zDb = p->zDatabase;
405 return sqlite3LocateTable(pParse, flags, p->zName, zDb);
409 ** Locate the in-memory structure that describes
410 ** a particular index given the name of that index
411 ** and the name of the database that contains the index.
412 ** Return NULL if not found.
414 ** If zDatabase is 0, all databases are searched for the
415 ** table and the first matching index is returned. (No checking
416 ** for duplicate index names is done.) The search order is
417 ** TEMP first, then MAIN, then any auxiliary databases added
418 ** using the ATTACH command.
420 Index *sqlite3FindIndex(sqlite3 *db, const char *zName, const char *zDb){
421 Index *p = 0;
422 int i;
423 /* All mutexes are required for schema access. Make sure we hold them. */
424 assert( zDb!=0 || sqlite3BtreeHoldsAllMutexes(db) );
425 for(i=OMIT_TEMPDB; i<db->nDb; i++){
426 int j = (i<2) ? i^1 : i; /* Search TEMP before MAIN */
427 Schema *pSchema = db->aDb[j].pSchema;
428 assert( pSchema );
429 if( zDb && sqlite3StrICmp(zDb, db->aDb[j].zDbSName) ) continue;
430 assert( sqlite3SchemaMutexHeld(db, j, 0) );
431 p = sqlite3HashFind(&pSchema->idxHash, zName);
432 if( p ) break;
434 return p;
438 ** Reclaim the memory used by an index
440 static void freeIndex(sqlite3 *db, Index *p){
441 #ifndef SQLITE_OMIT_ANALYZE
442 sqlite3DeleteIndexSamples(db, p);
443 #endif
444 sqlite3ExprDelete(db, p->pPartIdxWhere);
445 sqlite3ExprListDelete(db, p->aColExpr);
446 sqlite3DbFree(db, p->zColAff);
447 if( p->isResized ) sqlite3DbFree(db, (void *)p->azColl);
448 #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
449 sqlite3_free(p->aiRowEst);
450 #endif
451 sqlite3DbFree(db, p);
455 ** For the index called zIdxName which is found in the database iDb,
456 ** unlike that index from its Table then remove the index from
457 ** the index hash table and free all memory structures associated
458 ** with the index.
460 void sqlite3UnlinkAndDeleteIndex(sqlite3 *db, int iDb, const char *zIdxName){
461 Index *pIndex;
462 Hash *pHash;
464 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
465 pHash = &db->aDb[iDb].pSchema->idxHash;
466 pIndex = sqlite3HashInsert(pHash, zIdxName, 0);
467 if( ALWAYS(pIndex) ){
468 if( pIndex->pTable->pIndex==pIndex ){
469 pIndex->pTable->pIndex = pIndex->pNext;
470 }else{
471 Index *p;
472 /* Justification of ALWAYS(); The index must be on the list of
473 ** indices. */
474 p = pIndex->pTable->pIndex;
475 while( ALWAYS(p) && p->pNext!=pIndex ){ p = p->pNext; }
476 if( ALWAYS(p && p->pNext==pIndex) ){
477 p->pNext = pIndex->pNext;
480 freeIndex(db, pIndex);
482 db->mDbFlags |= DBFLAG_SchemaChange;
486 ** Look through the list of open database files in db->aDb[] and if
487 ** any have been closed, remove them from the list. Reallocate the
488 ** db->aDb[] structure to a smaller size, if possible.
490 ** Entry 0 (the "main" database) and entry 1 (the "temp" database)
491 ** are never candidates for being collapsed.
493 void sqlite3CollapseDatabaseArray(sqlite3 *db){
494 int i, j;
495 for(i=j=2; i<db->nDb; i++){
496 struct Db *pDb = &db->aDb[i];
497 if( pDb->pBt==0 ){
498 sqlite3DbFree(db, pDb->zDbSName);
499 pDb->zDbSName = 0;
500 continue;
502 if( j<i ){
503 db->aDb[j] = db->aDb[i];
505 j++;
507 db->nDb = j;
508 if( db->nDb<=2 && db->aDb!=db->aDbStatic ){
509 memcpy(db->aDbStatic, db->aDb, 2*sizeof(db->aDb[0]));
510 sqlite3DbFree(db, db->aDb);
511 db->aDb = db->aDbStatic;
516 ** Reset the schema for the database at index iDb. Also reset the
517 ** TEMP schema. The reset is deferred if db->nSchemaLock is not zero.
518 ** Deferred resets may be run by calling with iDb<0.
520 void sqlite3ResetOneSchema(sqlite3 *db, int iDb){
521 int i;
522 assert( iDb<db->nDb );
524 if( iDb>=0 ){
525 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
526 DbSetProperty(db, iDb, DB_ResetWanted);
527 DbSetProperty(db, 1, DB_ResetWanted);
530 if( db->nSchemaLock==0 ){
531 for(i=0; i<db->nDb; i++){
532 if( DbHasProperty(db, i, DB_ResetWanted) ){
533 sqlite3SchemaClear(db->aDb[i].pSchema);
540 ** Erase all schema information from all attached databases (including
541 ** "main" and "temp") for a single database connection.
543 void sqlite3ResetAllSchemasOfConnection(sqlite3 *db){
544 int i;
545 sqlite3BtreeEnterAll(db);
546 assert( db->nSchemaLock==0 );
547 for(i=0; i<db->nDb; i++){
548 Db *pDb = &db->aDb[i];
549 if( pDb->pSchema ){
550 sqlite3SchemaClear(pDb->pSchema);
553 db->mDbFlags &= ~DBFLAG_SchemaChange;
554 sqlite3VtabUnlockList(db);
555 sqlite3BtreeLeaveAll(db);
556 sqlite3CollapseDatabaseArray(db);
560 ** This routine is called when a commit occurs.
562 void sqlite3CommitInternalChanges(sqlite3 *db){
563 db->mDbFlags &= ~DBFLAG_SchemaChange;
567 ** Delete memory allocated for the column names of a table or view (the
568 ** Table.aCol[] array).
570 void sqlite3DeleteColumnNames(sqlite3 *db, Table *pTable){
571 int i;
572 Column *pCol;
573 assert( pTable!=0 );
574 if( (pCol = pTable->aCol)!=0 ){
575 for(i=0; i<pTable->nCol; i++, pCol++){
576 sqlite3DbFree(db, pCol->zName);
577 sqlite3ExprDelete(db, pCol->pDflt);
578 sqlite3DbFree(db, pCol->zColl);
580 sqlite3DbFree(db, pTable->aCol);
585 ** Remove the memory data structures associated with the given
586 ** Table. No changes are made to disk by this routine.
588 ** This routine just deletes the data structure. It does not unlink
589 ** the table data structure from the hash table. But it does destroy
590 ** memory structures of the indices and foreign keys associated with
591 ** the table.
593 ** The db parameter is optional. It is needed if the Table object
594 ** contains lookaside memory. (Table objects in the schema do not use
595 ** lookaside memory, but some ephemeral Table objects do.) Or the
596 ** db parameter can be used with db->pnBytesFreed to measure the memory
597 ** used by the Table object.
599 static void SQLITE_NOINLINE deleteTable(sqlite3 *db, Table *pTable){
600 Index *pIndex, *pNext;
602 #ifdef SQLITE_DEBUG
603 /* Record the number of outstanding lookaside allocations in schema Tables
604 ** prior to doing any free() operations. Since schema Tables do not use
605 ** lookaside, this number should not change. */
606 int nLookaside = 0;
607 if( db && (pTable->tabFlags & TF_Ephemeral)==0 ){
608 nLookaside = sqlite3LookasideUsed(db, 0);
610 #endif
612 /* Delete all indices associated with this table. */
613 for(pIndex = pTable->pIndex; pIndex; pIndex=pNext){
614 pNext = pIndex->pNext;
615 assert( pIndex->pSchema==pTable->pSchema
616 || (IsVirtual(pTable) && pIndex->idxType!=SQLITE_IDXTYPE_APPDEF) );
617 if( (db==0 || db->pnBytesFreed==0) && !IsVirtual(pTable) ){
618 char *zName = pIndex->zName;
619 TESTONLY ( Index *pOld = ) sqlite3HashInsert(
620 &pIndex->pSchema->idxHash, zName, 0
622 assert( db==0 || sqlite3SchemaMutexHeld(db, 0, pIndex->pSchema) );
623 assert( pOld==pIndex || pOld==0 );
625 freeIndex(db, pIndex);
628 /* Delete any foreign keys attached to this table. */
629 sqlite3FkDelete(db, pTable);
631 /* Delete the Table structure itself.
633 sqlite3DeleteColumnNames(db, pTable);
634 sqlite3DbFree(db, pTable->zName);
635 sqlite3DbFree(db, pTable->zColAff);
636 sqlite3SelectDelete(db, pTable->pSelect);
637 sqlite3ExprListDelete(db, pTable->pCheck);
638 #ifndef SQLITE_OMIT_VIRTUALTABLE
639 sqlite3VtabClear(db, pTable);
640 #endif
641 sqlite3DbFree(db, pTable);
643 /* Verify that no lookaside memory was used by schema tables */
644 assert( nLookaside==0 || nLookaside==sqlite3LookasideUsed(db,0) );
646 void sqlite3DeleteTable(sqlite3 *db, Table *pTable){
647 /* Do not delete the table until the reference count reaches zero. */
648 if( !pTable ) return;
649 if( ((!db || db->pnBytesFreed==0) && (--pTable->nTabRef)>0) ) return;
650 deleteTable(db, pTable);
655 ** Unlink the given table from the hash tables and the delete the
656 ** table structure with all its indices and foreign keys.
658 void sqlite3UnlinkAndDeleteTable(sqlite3 *db, int iDb, const char *zTabName){
659 Table *p;
660 Db *pDb;
662 assert( db!=0 );
663 assert( iDb>=0 && iDb<db->nDb );
664 assert( zTabName );
665 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
666 testcase( zTabName[0]==0 ); /* Zero-length table names are allowed */
667 pDb = &db->aDb[iDb];
668 p = sqlite3HashInsert(&pDb->pSchema->tblHash, zTabName, 0);
669 sqlite3DeleteTable(db, p);
670 db->mDbFlags |= DBFLAG_SchemaChange;
674 ** Given a token, return a string that consists of the text of that
675 ** token. Space to hold the returned string
676 ** is obtained from sqliteMalloc() and must be freed by the calling
677 ** function.
679 ** Any quotation marks (ex: "name", 'name', [name], or `name`) that
680 ** surround the body of the token are removed.
682 ** Tokens are often just pointers into the original SQL text and so
683 ** are not \000 terminated and are not persistent. The returned string
684 ** is \000 terminated and is persistent.
686 char *sqlite3NameFromToken(sqlite3 *db, Token *pName){
687 char *zName;
688 if( pName ){
689 zName = sqlite3DbStrNDup(db, (char*)pName->z, pName->n);
690 sqlite3Dequote(zName);
691 }else{
692 zName = 0;
694 return zName;
698 ** Open the sqlite_master table stored in database number iDb for
699 ** writing. The table is opened using cursor 0.
701 void sqlite3OpenMasterTable(Parse *p, int iDb){
702 Vdbe *v = sqlite3GetVdbe(p);
703 sqlite3TableLock(p, iDb, MASTER_ROOT, 1, MASTER_NAME);
704 sqlite3VdbeAddOp4Int(v, OP_OpenWrite, 0, MASTER_ROOT, iDb, 5);
705 if( p->nTab==0 ){
706 p->nTab = 1;
711 ** Parameter zName points to a nul-terminated buffer containing the name
712 ** of a database ("main", "temp" or the name of an attached db). This
713 ** function returns the index of the named database in db->aDb[], or
714 ** -1 if the named db cannot be found.
716 int sqlite3FindDbName(sqlite3 *db, const char *zName){
717 int i = -1; /* Database number */
718 if( zName ){
719 Db *pDb;
720 for(i=(db->nDb-1), pDb=&db->aDb[i]; i>=0; i--, pDb--){
721 if( 0==sqlite3_stricmp(pDb->zDbSName, zName) ) break;
722 /* "main" is always an acceptable alias for the primary database
723 ** even if it has been renamed using SQLITE_DBCONFIG_MAINDBNAME. */
724 if( i==0 && 0==sqlite3_stricmp("main", zName) ) break;
727 return i;
731 ** The token *pName contains the name of a database (either "main" or
732 ** "temp" or the name of an attached db). This routine returns the
733 ** index of the named database in db->aDb[], or -1 if the named db
734 ** does not exist.
736 int sqlite3FindDb(sqlite3 *db, Token *pName){
737 int i; /* Database number */
738 char *zName; /* Name we are searching for */
739 zName = sqlite3NameFromToken(db, pName);
740 i = sqlite3FindDbName(db, zName);
741 sqlite3DbFree(db, zName);
742 return i;
745 /* The table or view or trigger name is passed to this routine via tokens
746 ** pName1 and pName2. If the table name was fully qualified, for example:
748 ** CREATE TABLE xxx.yyy (...);
750 ** Then pName1 is set to "xxx" and pName2 "yyy". On the other hand if
751 ** the table name is not fully qualified, i.e.:
753 ** CREATE TABLE yyy(...);
755 ** Then pName1 is set to "yyy" and pName2 is "".
757 ** This routine sets the *ppUnqual pointer to point at the token (pName1 or
758 ** pName2) that stores the unqualified table name. The index of the
759 ** database "xxx" is returned.
761 int sqlite3TwoPartName(
762 Parse *pParse, /* Parsing and code generating context */
763 Token *pName1, /* The "xxx" in the name "xxx.yyy" or "xxx" */
764 Token *pName2, /* The "yyy" in the name "xxx.yyy" */
765 Token **pUnqual /* Write the unqualified object name here */
767 int iDb; /* Database holding the object */
768 sqlite3 *db = pParse->db;
770 assert( pName2!=0 );
771 if( pName2->n>0 ){
772 if( db->init.busy ) {
773 sqlite3ErrorMsg(pParse, "corrupt database");
774 return -1;
776 *pUnqual = pName2;
777 iDb = sqlite3FindDb(db, pName1);
778 if( iDb<0 ){
779 sqlite3ErrorMsg(pParse, "unknown database %T", pName1);
780 return -1;
782 }else{
783 assert( db->init.iDb==0 || db->init.busy
784 || (db->mDbFlags & DBFLAG_Vacuum)!=0);
785 iDb = db->init.iDb;
786 *pUnqual = pName1;
788 return iDb;
792 ** This routine is used to check if the UTF-8 string zName is a legal
793 ** unqualified name for a new schema object (table, index, view or
794 ** trigger). All names are legal except those that begin with the string
795 ** "sqlite_" (in upper, lower or mixed case). This portion of the namespace
796 ** is reserved for internal use.
798 int sqlite3CheckObjectName(Parse *pParse, const char *zName){
799 if( !pParse->db->init.busy && pParse->nested==0
800 && (pParse->db->flags & SQLITE_WriteSchema)==0
801 && 0==sqlite3StrNICmp(zName, "sqlite_", 7) ){
802 sqlite3ErrorMsg(pParse, "object name reserved for internal use: %s", zName);
803 return SQLITE_ERROR;
805 return SQLITE_OK;
809 ** Return the PRIMARY KEY index of a table
811 Index *sqlite3PrimaryKeyIndex(Table *pTab){
812 Index *p;
813 for(p=pTab->pIndex; p && !IsPrimaryKeyIndex(p); p=p->pNext){}
814 return p;
818 ** Return the column of index pIdx that corresponds to table
819 ** column iCol. Return -1 if not found.
821 i16 sqlite3ColumnOfIndex(Index *pIdx, i16 iCol){
822 int i;
823 for(i=0; i<pIdx->nColumn; i++){
824 if( iCol==pIdx->aiColumn[i] ) return i;
826 return -1;
830 ** Begin constructing a new table representation in memory. This is
831 ** the first of several action routines that get called in response
832 ** to a CREATE TABLE statement. In particular, this routine is called
833 ** after seeing tokens "CREATE" and "TABLE" and the table name. The isTemp
834 ** flag is true if the table should be stored in the auxiliary database
835 ** file instead of in the main database file. This is normally the case
836 ** when the "TEMP" or "TEMPORARY" keyword occurs in between
837 ** CREATE and TABLE.
839 ** The new table record is initialized and put in pParse->pNewTable.
840 ** As more of the CREATE TABLE statement is parsed, additional action
841 ** routines will be called to add more information to this record.
842 ** At the end of the CREATE TABLE statement, the sqlite3EndTable() routine
843 ** is called to complete the construction of the new table record.
845 void sqlite3StartTable(
846 Parse *pParse, /* Parser context */
847 Token *pName1, /* First part of the name of the table or view */
848 Token *pName2, /* Second part of the name of the table or view */
849 int isTemp, /* True if this is a TEMP table */
850 int isView, /* True if this is a VIEW */
851 int isVirtual, /* True if this is a VIRTUAL table */
852 int noErr /* Do nothing if table already exists */
854 Table *pTable;
855 char *zName = 0; /* The name of the new table */
856 sqlite3 *db = pParse->db;
857 Vdbe *v;
858 int iDb; /* Database number to create the table in */
859 Token *pName; /* Unqualified name of the table to create */
861 if( db->init.busy && db->init.newTnum==1 ){
862 /* Special case: Parsing the sqlite_master or sqlite_temp_master schema */
863 iDb = db->init.iDb;
864 zName = sqlite3DbStrDup(db, SCHEMA_TABLE(iDb));
865 pName = pName1;
866 }else{
867 /* The common case */
868 iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pName);
869 if( iDb<0 ) return;
870 if( !OMIT_TEMPDB && isTemp && pName2->n>0 && iDb!=1 ){
871 /* If creating a temp table, the name may not be qualified. Unless
872 ** the database name is "temp" anyway. */
873 sqlite3ErrorMsg(pParse, "temporary table name must be unqualified");
874 return;
876 if( !OMIT_TEMPDB && isTemp ) iDb = 1;
877 zName = sqlite3NameFromToken(db, pName);
879 pParse->sNameToken = *pName;
880 if( zName==0 ) return;
881 if( SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){
882 goto begin_table_error;
884 if( db->init.iDb==1 ) isTemp = 1;
885 #ifndef SQLITE_OMIT_AUTHORIZATION
886 assert( isTemp==0 || isTemp==1 );
887 assert( isView==0 || isView==1 );
889 static const u8 aCode[] = {
890 SQLITE_CREATE_TABLE,
891 SQLITE_CREATE_TEMP_TABLE,
892 SQLITE_CREATE_VIEW,
893 SQLITE_CREATE_TEMP_VIEW
895 char *zDb = db->aDb[iDb].zDbSName;
896 if( sqlite3AuthCheck(pParse, SQLITE_INSERT, SCHEMA_TABLE(isTemp), 0, zDb) ){
897 goto begin_table_error;
899 if( !isVirtual && sqlite3AuthCheck(pParse, (int)aCode[isTemp+2*isView],
900 zName, 0, zDb) ){
901 goto begin_table_error;
904 #endif
906 /* Make sure the new table name does not collide with an existing
907 ** index or table name in the same database. Issue an error message if
908 ** it does. The exception is if the statement being parsed was passed
909 ** to an sqlite3_declare_vtab() call. In that case only the column names
910 ** and types will be used, so there is no need to test for namespace
911 ** collisions.
913 if( !IN_DECLARE_VTAB ){
914 char *zDb = db->aDb[iDb].zDbSName;
915 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
916 goto begin_table_error;
918 pTable = sqlite3FindTable(db, zName, zDb);
919 if( pTable ){
920 if( !noErr ){
921 sqlite3ErrorMsg(pParse, "table %T already exists", pName);
922 }else{
923 assert( !db->init.busy || CORRUPT_DB );
924 sqlite3CodeVerifySchema(pParse, iDb);
926 goto begin_table_error;
928 if( sqlite3FindIndex(db, zName, zDb)!=0 ){
929 sqlite3ErrorMsg(pParse, "there is already an index named %s", zName);
930 goto begin_table_error;
934 pTable = sqlite3DbMallocZero(db, sizeof(Table));
935 if( pTable==0 ){
936 assert( db->mallocFailed );
937 pParse->rc = SQLITE_NOMEM_BKPT;
938 pParse->nErr++;
939 goto begin_table_error;
941 pTable->zName = zName;
942 pTable->iPKey = -1;
943 pTable->pSchema = db->aDb[iDb].pSchema;
944 pTable->nTabRef = 1;
945 #ifdef SQLITE_DEFAULT_ROWEST
946 pTable->nRowLogEst = sqlite3LogEst(SQLITE_DEFAULT_ROWEST);
947 #else
948 pTable->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
949 #endif
950 assert( pParse->pNewTable==0 );
951 pParse->pNewTable = pTable;
953 /* If this is the magic sqlite_sequence table used by autoincrement,
954 ** then record a pointer to this table in the main database structure
955 ** so that INSERT can find the table easily.
957 #ifndef SQLITE_OMIT_AUTOINCREMENT
958 if( !pParse->nested && strcmp(zName, "sqlite_sequence")==0 ){
959 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
960 pTable->pSchema->pSeqTab = pTable;
962 #endif
964 /* Begin generating the code that will insert the table record into
965 ** the SQLITE_MASTER table. Note in particular that we must go ahead
966 ** and allocate the record number for the table entry now. Before any
967 ** PRIMARY KEY or UNIQUE keywords are parsed. Those keywords will cause
968 ** indices to be created and the table record must come before the
969 ** indices. Hence, the record number for the table must be allocated
970 ** now.
972 if( !db->init.busy && (v = sqlite3GetVdbe(pParse))!=0 ){
973 int addr1;
974 int fileFormat;
975 int reg1, reg2, reg3;
976 /* nullRow[] is an OP_Record encoding of a row containing 5 NULLs */
977 static const char nullRow[] = { 6, 0, 0, 0, 0, 0 };
978 sqlite3BeginWriteOperation(pParse, 1, iDb);
980 #ifndef SQLITE_OMIT_VIRTUALTABLE
981 if( isVirtual ){
982 sqlite3VdbeAddOp0(v, OP_VBegin);
984 #endif
986 /* If the file format and encoding in the database have not been set,
987 ** set them now.
989 reg1 = pParse->regRowid = ++pParse->nMem;
990 reg2 = pParse->regRoot = ++pParse->nMem;
991 reg3 = ++pParse->nMem;
992 sqlite3VdbeAddOp3(v, OP_ReadCookie, iDb, reg3, BTREE_FILE_FORMAT);
993 sqlite3VdbeUsesBtree(v, iDb);
994 addr1 = sqlite3VdbeAddOp1(v, OP_If, reg3); VdbeCoverage(v);
995 fileFormat = (db->flags & SQLITE_LegacyFileFmt)!=0 ?
996 1 : SQLITE_MAX_FILE_FORMAT;
997 sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_FILE_FORMAT, fileFormat);
998 sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_TEXT_ENCODING, ENC(db));
999 sqlite3VdbeJumpHere(v, addr1);
1001 /* This just creates a place-holder record in the sqlite_master table.
1002 ** The record created does not contain anything yet. It will be replaced
1003 ** by the real entry in code generated at sqlite3EndTable().
1005 ** The rowid for the new entry is left in register pParse->regRowid.
1006 ** The root page number of the new table is left in reg pParse->regRoot.
1007 ** The rowid and root page number values are needed by the code that
1008 ** sqlite3EndTable will generate.
1010 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
1011 if( isView || isVirtual ){
1012 sqlite3VdbeAddOp2(v, OP_Integer, 0, reg2);
1013 }else
1014 #endif
1016 pParse->addrCrTab =
1017 sqlite3VdbeAddOp3(v, OP_CreateBtree, iDb, reg2, BTREE_INTKEY);
1019 sqlite3OpenMasterTable(pParse, iDb);
1020 sqlite3VdbeAddOp2(v, OP_NewRowid, 0, reg1);
1021 sqlite3VdbeAddOp4(v, OP_Blob, 6, reg3, 0, nullRow, P4_STATIC);
1022 sqlite3VdbeAddOp3(v, OP_Insert, 0, reg3, reg1);
1023 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1024 sqlite3VdbeAddOp0(v, OP_Close);
1027 /* Normal (non-error) return. */
1028 return;
1030 /* If an error occurs, we jump here */
1031 begin_table_error:
1032 sqlite3DbFree(db, zName);
1033 return;
1036 /* Set properties of a table column based on the (magical)
1037 ** name of the column.
1039 #if SQLITE_ENABLE_HIDDEN_COLUMNS
1040 void sqlite3ColumnPropertiesFromName(Table *pTab, Column *pCol){
1041 if( sqlite3_strnicmp(pCol->zName, "__hidden__", 10)==0 ){
1042 pCol->colFlags |= COLFLAG_HIDDEN;
1043 }else if( pTab && pCol!=pTab->aCol && (pCol[-1].colFlags & COLFLAG_HIDDEN) ){
1044 pTab->tabFlags |= TF_OOOHidden;
1047 #endif
1051 ** Add a new column to the table currently being constructed.
1053 ** The parser calls this routine once for each column declaration
1054 ** in a CREATE TABLE statement. sqlite3StartTable() gets called
1055 ** first to get things going. Then this routine is called for each
1056 ** column.
1058 void sqlite3AddColumn(Parse *pParse, Token *pName, Token *pType){
1059 Table *p;
1060 int i;
1061 char *z;
1062 char *zType;
1063 Column *pCol;
1064 sqlite3 *db = pParse->db;
1065 if( (p = pParse->pNewTable)==0 ) return;
1066 if( p->nCol+1>db->aLimit[SQLITE_LIMIT_COLUMN] ){
1067 sqlite3ErrorMsg(pParse, "too many columns on %s", p->zName);
1068 return;
1070 z = sqlite3DbMallocRaw(db, pName->n + pType->n + 2);
1071 if( z==0 ) return;
1072 memcpy(z, pName->z, pName->n);
1073 z[pName->n] = 0;
1074 sqlite3Dequote(z);
1075 for(i=0; i<p->nCol; i++){
1076 if( sqlite3_stricmp(z, p->aCol[i].zName)==0 ){
1077 sqlite3ErrorMsg(pParse, "duplicate column name: %s", z);
1078 sqlite3DbFree(db, z);
1079 return;
1082 if( (p->nCol & 0x7)==0 ){
1083 Column *aNew;
1084 aNew = sqlite3DbRealloc(db,p->aCol,(p->nCol+8)*sizeof(p->aCol[0]));
1085 if( aNew==0 ){
1086 sqlite3DbFree(db, z);
1087 return;
1089 p->aCol = aNew;
1091 pCol = &p->aCol[p->nCol];
1092 memset(pCol, 0, sizeof(p->aCol[0]));
1093 pCol->zName = z;
1094 sqlite3ColumnPropertiesFromName(p, pCol);
1096 if( pType->n==0 ){
1097 /* If there is no type specified, columns have the default affinity
1098 ** 'BLOB'. */
1099 pCol->affinity = SQLITE_AFF_BLOB;
1100 pCol->szEst = 1;
1101 }else{
1102 zType = z + sqlite3Strlen30(z) + 1;
1103 memcpy(zType, pType->z, pType->n);
1104 zType[pType->n] = 0;
1105 sqlite3Dequote(zType);
1106 pCol->affinity = sqlite3AffinityType(zType, &pCol->szEst);
1107 pCol->colFlags |= COLFLAG_HASTYPE;
1109 p->nCol++;
1110 pParse->constraintName.n = 0;
1114 ** This routine is called by the parser while in the middle of
1115 ** parsing a CREATE TABLE statement. A "NOT NULL" constraint has
1116 ** been seen on a column. This routine sets the notNull flag on
1117 ** the column currently under construction.
1119 void sqlite3AddNotNull(Parse *pParse, int onError){
1120 Table *p;
1121 p = pParse->pNewTable;
1122 if( p==0 || NEVER(p->nCol<1) ) return;
1123 p->aCol[p->nCol-1].notNull = (u8)onError;
1124 p->tabFlags |= TF_HasNotNull;
1128 ** Scan the column type name zType (length nType) and return the
1129 ** associated affinity type.
1131 ** This routine does a case-independent search of zType for the
1132 ** substrings in the following table. If one of the substrings is
1133 ** found, the corresponding affinity is returned. If zType contains
1134 ** more than one of the substrings, entries toward the top of
1135 ** the table take priority. For example, if zType is 'BLOBINT',
1136 ** SQLITE_AFF_INTEGER is returned.
1138 ** Substring | Affinity
1139 ** --------------------------------
1140 ** 'INT' | SQLITE_AFF_INTEGER
1141 ** 'CHAR' | SQLITE_AFF_TEXT
1142 ** 'CLOB' | SQLITE_AFF_TEXT
1143 ** 'TEXT' | SQLITE_AFF_TEXT
1144 ** 'BLOB' | SQLITE_AFF_BLOB
1145 ** 'REAL' | SQLITE_AFF_REAL
1146 ** 'FLOA' | SQLITE_AFF_REAL
1147 ** 'DOUB' | SQLITE_AFF_REAL
1149 ** If none of the substrings in the above table are found,
1150 ** SQLITE_AFF_NUMERIC is returned.
1152 char sqlite3AffinityType(const char *zIn, u8 *pszEst){
1153 u32 h = 0;
1154 char aff = SQLITE_AFF_NUMERIC;
1155 const char *zChar = 0;
1157 assert( zIn!=0 );
1158 while( zIn[0] ){
1159 h = (h<<8) + sqlite3UpperToLower[(*zIn)&0xff];
1160 zIn++;
1161 if( h==(('c'<<24)+('h'<<16)+('a'<<8)+'r') ){ /* CHAR */
1162 aff = SQLITE_AFF_TEXT;
1163 zChar = zIn;
1164 }else if( h==(('c'<<24)+('l'<<16)+('o'<<8)+'b') ){ /* CLOB */
1165 aff = SQLITE_AFF_TEXT;
1166 }else if( h==(('t'<<24)+('e'<<16)+('x'<<8)+'t') ){ /* TEXT */
1167 aff = SQLITE_AFF_TEXT;
1168 }else if( h==(('b'<<24)+('l'<<16)+('o'<<8)+'b') /* BLOB */
1169 && (aff==SQLITE_AFF_NUMERIC || aff==SQLITE_AFF_REAL) ){
1170 aff = SQLITE_AFF_BLOB;
1171 if( zIn[0]=='(' ) zChar = zIn;
1172 #ifndef SQLITE_OMIT_FLOATING_POINT
1173 }else if( h==(('r'<<24)+('e'<<16)+('a'<<8)+'l') /* REAL */
1174 && aff==SQLITE_AFF_NUMERIC ){
1175 aff = SQLITE_AFF_REAL;
1176 }else if( h==(('f'<<24)+('l'<<16)+('o'<<8)+'a') /* FLOA */
1177 && aff==SQLITE_AFF_NUMERIC ){
1178 aff = SQLITE_AFF_REAL;
1179 }else if( h==(('d'<<24)+('o'<<16)+('u'<<8)+'b') /* DOUB */
1180 && aff==SQLITE_AFF_NUMERIC ){
1181 aff = SQLITE_AFF_REAL;
1182 #endif
1183 }else if( (h&0x00FFFFFF)==(('i'<<16)+('n'<<8)+'t') ){ /* INT */
1184 aff = SQLITE_AFF_INTEGER;
1185 break;
1189 /* If pszEst is not NULL, store an estimate of the field size. The
1190 ** estimate is scaled so that the size of an integer is 1. */
1191 if( pszEst ){
1192 *pszEst = 1; /* default size is approx 4 bytes */
1193 if( aff<SQLITE_AFF_NUMERIC ){
1194 if( zChar ){
1195 while( zChar[0] ){
1196 if( sqlite3Isdigit(zChar[0]) ){
1197 int v = 0;
1198 sqlite3GetInt32(zChar, &v);
1199 v = v/4 + 1;
1200 if( v>255 ) v = 255;
1201 *pszEst = v; /* BLOB(k), VARCHAR(k), CHAR(k) -> r=(k/4+1) */
1202 break;
1204 zChar++;
1206 }else{
1207 *pszEst = 5; /* BLOB, TEXT, CLOB -> r=5 (approx 20 bytes)*/
1211 return aff;
1215 ** The expression is the default value for the most recently added column
1216 ** of the table currently under construction.
1218 ** Default value expressions must be constant. Raise an exception if this
1219 ** is not the case.
1221 ** This routine is called by the parser while in the middle of
1222 ** parsing a CREATE TABLE statement.
1224 void sqlite3AddDefaultValue(Parse *pParse, ExprSpan *pSpan){
1225 Table *p;
1226 Column *pCol;
1227 sqlite3 *db = pParse->db;
1228 p = pParse->pNewTable;
1229 if( p!=0 ){
1230 pCol = &(p->aCol[p->nCol-1]);
1231 if( !sqlite3ExprIsConstantOrFunction(pSpan->pExpr, db->init.busy) ){
1232 sqlite3ErrorMsg(pParse, "default value of column [%s] is not constant",
1233 pCol->zName);
1234 }else{
1235 /* A copy of pExpr is used instead of the original, as pExpr contains
1236 ** tokens that point to volatile memory. The 'span' of the expression
1237 ** is required by pragma table_info.
1239 Expr x;
1240 sqlite3ExprDelete(db, pCol->pDflt);
1241 memset(&x, 0, sizeof(x));
1242 x.op = TK_SPAN;
1243 x.u.zToken = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1244 (int)(pSpan->zEnd - pSpan->zStart));
1245 x.pLeft = pSpan->pExpr;
1246 x.flags = EP_Skip;
1247 pCol->pDflt = sqlite3ExprDup(db, &x, EXPRDUP_REDUCE);
1248 sqlite3DbFree(db, x.u.zToken);
1251 sqlite3ExprDelete(db, pSpan->pExpr);
1255 ** Backwards Compatibility Hack:
1257 ** Historical versions of SQLite accepted strings as column names in
1258 ** indexes and PRIMARY KEY constraints and in UNIQUE constraints. Example:
1260 ** CREATE TABLE xyz(a,b,c,d,e,PRIMARY KEY('a'),UNIQUE('b','c' COLLATE trim)
1261 ** CREATE INDEX abc ON xyz('c','d' DESC,'e' COLLATE nocase DESC);
1263 ** This is goofy. But to preserve backwards compatibility we continue to
1264 ** accept it. This routine does the necessary conversion. It converts
1265 ** the expression given in its argument from a TK_STRING into a TK_ID
1266 ** if the expression is just a TK_STRING with an optional COLLATE clause.
1267 ** If the epxression is anything other than TK_STRING, the expression is
1268 ** unchanged.
1270 static void sqlite3StringToId(Expr *p){
1271 if( p->op==TK_STRING ){
1272 p->op = TK_ID;
1273 }else if( p->op==TK_COLLATE && p->pLeft->op==TK_STRING ){
1274 p->pLeft->op = TK_ID;
1279 ** Designate the PRIMARY KEY for the table. pList is a list of names
1280 ** of columns that form the primary key. If pList is NULL, then the
1281 ** most recently added column of the table is the primary key.
1283 ** A table can have at most one primary key. If the table already has
1284 ** a primary key (and this is the second primary key) then create an
1285 ** error.
1287 ** If the PRIMARY KEY is on a single column whose datatype is INTEGER,
1288 ** then we will try to use that column as the rowid. Set the Table.iPKey
1289 ** field of the table under construction to be the index of the
1290 ** INTEGER PRIMARY KEY column. Table.iPKey is set to -1 if there is
1291 ** no INTEGER PRIMARY KEY.
1293 ** If the key is not an INTEGER PRIMARY KEY, then create a unique
1294 ** index for the key. No index is created for INTEGER PRIMARY KEYs.
1296 void sqlite3AddPrimaryKey(
1297 Parse *pParse, /* Parsing context */
1298 ExprList *pList, /* List of field names to be indexed */
1299 int onError, /* What to do with a uniqueness conflict */
1300 int autoInc, /* True if the AUTOINCREMENT keyword is present */
1301 int sortOrder /* SQLITE_SO_ASC or SQLITE_SO_DESC */
1303 Table *pTab = pParse->pNewTable;
1304 Column *pCol = 0;
1305 int iCol = -1, i;
1306 int nTerm;
1307 if( pTab==0 ) goto primary_key_exit;
1308 if( pTab->tabFlags & TF_HasPrimaryKey ){
1309 sqlite3ErrorMsg(pParse,
1310 "table \"%s\" has more than one primary key", pTab->zName);
1311 goto primary_key_exit;
1313 pTab->tabFlags |= TF_HasPrimaryKey;
1314 if( pList==0 ){
1315 iCol = pTab->nCol - 1;
1316 pCol = &pTab->aCol[iCol];
1317 pCol->colFlags |= COLFLAG_PRIMKEY;
1318 nTerm = 1;
1319 }else{
1320 nTerm = pList->nExpr;
1321 for(i=0; i<nTerm; i++){
1322 Expr *pCExpr = sqlite3ExprSkipCollate(pList->a[i].pExpr);
1323 assert( pCExpr!=0 );
1324 sqlite3StringToId(pCExpr);
1325 if( pCExpr->op==TK_ID ){
1326 const char *zCName = pCExpr->u.zToken;
1327 for(iCol=0; iCol<pTab->nCol; iCol++){
1328 if( sqlite3StrICmp(zCName, pTab->aCol[iCol].zName)==0 ){
1329 pCol = &pTab->aCol[iCol];
1330 pCol->colFlags |= COLFLAG_PRIMKEY;
1331 break;
1337 if( nTerm==1
1338 && pCol
1339 && sqlite3StrICmp(sqlite3ColumnType(pCol,""), "INTEGER")==0
1340 && sortOrder!=SQLITE_SO_DESC
1342 pTab->iPKey = iCol;
1343 pTab->keyConf = (u8)onError;
1344 assert( autoInc==0 || autoInc==1 );
1345 pTab->tabFlags |= autoInc*TF_Autoincrement;
1346 if( pList ) pParse->iPkSortOrder = pList->a[0].sortOrder;
1347 }else if( autoInc ){
1348 #ifndef SQLITE_OMIT_AUTOINCREMENT
1349 sqlite3ErrorMsg(pParse, "AUTOINCREMENT is only allowed on an "
1350 "INTEGER PRIMARY KEY");
1351 #endif
1352 }else{
1353 sqlite3CreateIndex(pParse, 0, 0, 0, pList, onError, 0,
1354 0, sortOrder, 0, SQLITE_IDXTYPE_PRIMARYKEY);
1355 pList = 0;
1358 primary_key_exit:
1359 sqlite3ExprListDelete(pParse->db, pList);
1360 return;
1364 ** Add a new CHECK constraint to the table currently under construction.
1366 void sqlite3AddCheckConstraint(
1367 Parse *pParse, /* Parsing context */
1368 Expr *pCheckExpr /* The check expression */
1370 #ifndef SQLITE_OMIT_CHECK
1371 Table *pTab = pParse->pNewTable;
1372 sqlite3 *db = pParse->db;
1373 if( pTab && !IN_DECLARE_VTAB
1374 && !sqlite3BtreeIsReadonly(db->aDb[db->init.iDb].pBt)
1376 pTab->pCheck = sqlite3ExprListAppend(pParse, pTab->pCheck, pCheckExpr);
1377 if( pParse->constraintName.n ){
1378 sqlite3ExprListSetName(pParse, pTab->pCheck, &pParse->constraintName, 1);
1380 }else
1381 #endif
1383 sqlite3ExprDelete(pParse->db, pCheckExpr);
1388 ** Set the collation function of the most recently parsed table column
1389 ** to the CollSeq given.
1391 void sqlite3AddCollateType(Parse *pParse, Token *pToken){
1392 Table *p;
1393 int i;
1394 char *zColl; /* Dequoted name of collation sequence */
1395 sqlite3 *db;
1397 if( (p = pParse->pNewTable)==0 ) return;
1398 i = p->nCol-1;
1399 db = pParse->db;
1400 zColl = sqlite3NameFromToken(db, pToken);
1401 if( !zColl ) return;
1403 if( sqlite3LocateCollSeq(pParse, zColl) ){
1404 Index *pIdx;
1405 sqlite3DbFree(db, p->aCol[i].zColl);
1406 p->aCol[i].zColl = zColl;
1408 /* If the column is declared as "<name> PRIMARY KEY COLLATE <type>",
1409 ** then an index may have been created on this column before the
1410 ** collation type was added. Correct this if it is the case.
1412 for(pIdx=p->pIndex; pIdx; pIdx=pIdx->pNext){
1413 assert( pIdx->nKeyCol==1 );
1414 if( pIdx->aiColumn[0]==i ){
1415 pIdx->azColl[0] = p->aCol[i].zColl;
1418 }else{
1419 sqlite3DbFree(db, zColl);
1424 ** This function returns the collation sequence for database native text
1425 ** encoding identified by the string zName, length nName.
1427 ** If the requested collation sequence is not available, or not available
1428 ** in the database native encoding, the collation factory is invoked to
1429 ** request it. If the collation factory does not supply such a sequence,
1430 ** and the sequence is available in another text encoding, then that is
1431 ** returned instead.
1433 ** If no versions of the requested collations sequence are available, or
1434 ** another error occurs, NULL is returned and an error message written into
1435 ** pParse.
1437 ** This routine is a wrapper around sqlite3FindCollSeq(). This routine
1438 ** invokes the collation factory if the named collation cannot be found
1439 ** and generates an error message.
1441 ** See also: sqlite3FindCollSeq(), sqlite3GetCollSeq()
1443 CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName){
1444 sqlite3 *db = pParse->db;
1445 u8 enc = ENC(db);
1446 u8 initbusy = db->init.busy;
1447 CollSeq *pColl;
1449 pColl = sqlite3FindCollSeq(db, enc, zName, initbusy);
1450 if( !initbusy && (!pColl || !pColl->xCmp) ){
1451 pColl = sqlite3GetCollSeq(pParse, enc, pColl, zName);
1454 return pColl;
1459 ** Generate code that will increment the schema cookie.
1461 ** The schema cookie is used to determine when the schema for the
1462 ** database changes. After each schema change, the cookie value
1463 ** changes. When a process first reads the schema it records the
1464 ** cookie. Thereafter, whenever it goes to access the database,
1465 ** it checks the cookie to make sure the schema has not changed
1466 ** since it was last read.
1468 ** This plan is not completely bullet-proof. It is possible for
1469 ** the schema to change multiple times and for the cookie to be
1470 ** set back to prior value. But schema changes are infrequent
1471 ** and the probability of hitting the same cookie value is only
1472 ** 1 chance in 2^32. So we're safe enough.
1474 ** IMPLEMENTATION-OF: R-34230-56049 SQLite automatically increments
1475 ** the schema-version whenever the schema changes.
1477 void sqlite3ChangeCookie(Parse *pParse, int iDb){
1478 sqlite3 *db = pParse->db;
1479 Vdbe *v = pParse->pVdbe;
1480 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1481 sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_SCHEMA_VERSION,
1482 db->aDb[iDb].pSchema->schema_cookie+1);
1486 ** Measure the number of characters needed to output the given
1487 ** identifier. The number returned includes any quotes used
1488 ** but does not include the null terminator.
1490 ** The estimate is conservative. It might be larger that what is
1491 ** really needed.
1493 static int identLength(const char *z){
1494 int n;
1495 for(n=0; *z; n++, z++){
1496 if( *z=='"' ){ n++; }
1498 return n + 2;
1502 ** The first parameter is a pointer to an output buffer. The second
1503 ** parameter is a pointer to an integer that contains the offset at
1504 ** which to write into the output buffer. This function copies the
1505 ** nul-terminated string pointed to by the third parameter, zSignedIdent,
1506 ** to the specified offset in the buffer and updates *pIdx to refer
1507 ** to the first byte after the last byte written before returning.
1509 ** If the string zSignedIdent consists entirely of alpha-numeric
1510 ** characters, does not begin with a digit and is not an SQL keyword,
1511 ** then it is copied to the output buffer exactly as it is. Otherwise,
1512 ** it is quoted using double-quotes.
1514 static void identPut(char *z, int *pIdx, char *zSignedIdent){
1515 unsigned char *zIdent = (unsigned char*)zSignedIdent;
1516 int i, j, needQuote;
1517 i = *pIdx;
1519 for(j=0; zIdent[j]; j++){
1520 if( !sqlite3Isalnum(zIdent[j]) && zIdent[j]!='_' ) break;
1522 needQuote = sqlite3Isdigit(zIdent[0])
1523 || sqlite3KeywordCode(zIdent, j)!=TK_ID
1524 || zIdent[j]!=0
1525 || j==0;
1527 if( needQuote ) z[i++] = '"';
1528 for(j=0; zIdent[j]; j++){
1529 z[i++] = zIdent[j];
1530 if( zIdent[j]=='"' ) z[i++] = '"';
1532 if( needQuote ) z[i++] = '"';
1533 z[i] = 0;
1534 *pIdx = i;
1538 ** Generate a CREATE TABLE statement appropriate for the given
1539 ** table. Memory to hold the text of the statement is obtained
1540 ** from sqliteMalloc() and must be freed by the calling function.
1542 static char *createTableStmt(sqlite3 *db, Table *p){
1543 int i, k, n;
1544 char *zStmt;
1545 char *zSep, *zSep2, *zEnd;
1546 Column *pCol;
1547 n = 0;
1548 for(pCol = p->aCol, i=0; i<p->nCol; i++, pCol++){
1549 n += identLength(pCol->zName) + 5;
1551 n += identLength(p->zName);
1552 if( n<50 ){
1553 zSep = "";
1554 zSep2 = ",";
1555 zEnd = ")";
1556 }else{
1557 zSep = "\n ";
1558 zSep2 = ",\n ";
1559 zEnd = "\n)";
1561 n += 35 + 6*p->nCol;
1562 zStmt = sqlite3DbMallocRaw(0, n);
1563 if( zStmt==0 ){
1564 sqlite3OomFault(db);
1565 return 0;
1567 sqlite3_snprintf(n, zStmt, "CREATE TABLE ");
1568 k = sqlite3Strlen30(zStmt);
1569 identPut(zStmt, &k, p->zName);
1570 zStmt[k++] = '(';
1571 for(pCol=p->aCol, i=0; i<p->nCol; i++, pCol++){
1572 static const char * const azType[] = {
1573 /* SQLITE_AFF_BLOB */ "",
1574 /* SQLITE_AFF_TEXT */ " TEXT",
1575 /* SQLITE_AFF_NUMERIC */ " NUM",
1576 /* SQLITE_AFF_INTEGER */ " INT",
1577 /* SQLITE_AFF_REAL */ " REAL"
1579 int len;
1580 const char *zType;
1582 sqlite3_snprintf(n-k, &zStmt[k], zSep);
1583 k += sqlite3Strlen30(&zStmt[k]);
1584 zSep = zSep2;
1585 identPut(zStmt, &k, pCol->zName);
1586 assert( pCol->affinity-SQLITE_AFF_BLOB >= 0 );
1587 assert( pCol->affinity-SQLITE_AFF_BLOB < ArraySize(azType) );
1588 testcase( pCol->affinity==SQLITE_AFF_BLOB );
1589 testcase( pCol->affinity==SQLITE_AFF_TEXT );
1590 testcase( pCol->affinity==SQLITE_AFF_NUMERIC );
1591 testcase( pCol->affinity==SQLITE_AFF_INTEGER );
1592 testcase( pCol->affinity==SQLITE_AFF_REAL );
1594 zType = azType[pCol->affinity - SQLITE_AFF_BLOB];
1595 len = sqlite3Strlen30(zType);
1596 assert( pCol->affinity==SQLITE_AFF_BLOB
1597 || pCol->affinity==sqlite3AffinityType(zType, 0) );
1598 memcpy(&zStmt[k], zType, len);
1599 k += len;
1600 assert( k<=n );
1602 sqlite3_snprintf(n-k, &zStmt[k], "%s", zEnd);
1603 return zStmt;
1607 ** Resize an Index object to hold N columns total. Return SQLITE_OK
1608 ** on success and SQLITE_NOMEM on an OOM error.
1610 static int resizeIndexObject(sqlite3 *db, Index *pIdx, int N){
1611 char *zExtra;
1612 int nByte;
1613 if( pIdx->nColumn>=N ) return SQLITE_OK;
1614 assert( pIdx->isResized==0 );
1615 nByte = (sizeof(char*) + sizeof(i16) + 1)*N;
1616 zExtra = sqlite3DbMallocZero(db, nByte);
1617 if( zExtra==0 ) return SQLITE_NOMEM_BKPT;
1618 memcpy(zExtra, pIdx->azColl, sizeof(char*)*pIdx->nColumn);
1619 pIdx->azColl = (const char**)zExtra;
1620 zExtra += sizeof(char*)*N;
1621 memcpy(zExtra, pIdx->aiColumn, sizeof(i16)*pIdx->nColumn);
1622 pIdx->aiColumn = (i16*)zExtra;
1623 zExtra += sizeof(i16)*N;
1624 memcpy(zExtra, pIdx->aSortOrder, pIdx->nColumn);
1625 pIdx->aSortOrder = (u8*)zExtra;
1626 pIdx->nColumn = N;
1627 pIdx->isResized = 1;
1628 return SQLITE_OK;
1632 ** Estimate the total row width for a table.
1634 static void estimateTableWidth(Table *pTab){
1635 unsigned wTable = 0;
1636 const Column *pTabCol;
1637 int i;
1638 for(i=pTab->nCol, pTabCol=pTab->aCol; i>0; i--, pTabCol++){
1639 wTable += pTabCol->szEst;
1641 if( pTab->iPKey<0 ) wTable++;
1642 pTab->szTabRow = sqlite3LogEst(wTable*4);
1646 ** Estimate the average size of a row for an index.
1648 static void estimateIndexWidth(Index *pIdx){
1649 unsigned wIndex = 0;
1650 int i;
1651 const Column *aCol = pIdx->pTable->aCol;
1652 for(i=0; i<pIdx->nColumn; i++){
1653 i16 x = pIdx->aiColumn[i];
1654 assert( x<pIdx->pTable->nCol );
1655 wIndex += x<0 ? 1 : aCol[pIdx->aiColumn[i]].szEst;
1657 pIdx->szIdxRow = sqlite3LogEst(wIndex*4);
1660 /* Return true if value x is found any of the first nCol entries of aiCol[]
1662 static int hasColumn(const i16 *aiCol, int nCol, int x){
1663 while( nCol-- > 0 ) if( x==*(aiCol++) ) return 1;
1664 return 0;
1668 ** This routine runs at the end of parsing a CREATE TABLE statement that
1669 ** has a WITHOUT ROWID clause. The job of this routine is to convert both
1670 ** internal schema data structures and the generated VDBE code so that they
1671 ** are appropriate for a WITHOUT ROWID table instead of a rowid table.
1672 ** Changes include:
1674 ** (1) Set all columns of the PRIMARY KEY schema object to be NOT NULL.
1675 ** (2) Convert P3 parameter of the OP_CreateBtree from BTREE_INTKEY
1676 ** into BTREE_BLOBKEY.
1677 ** (3) Bypass the creation of the sqlite_master table entry
1678 ** for the PRIMARY KEY as the primary key index is now
1679 ** identified by the sqlite_master table entry of the table itself.
1680 ** (4) Set the Index.tnum of the PRIMARY KEY Index object in the
1681 ** schema to the rootpage from the main table.
1682 ** (5) Add all table columns to the PRIMARY KEY Index object
1683 ** so that the PRIMARY KEY is a covering index. The surplus
1684 ** columns are part of KeyInfo.nAllField and are not used for
1685 ** sorting or lookup or uniqueness checks.
1686 ** (6) Replace the rowid tail on all automatically generated UNIQUE
1687 ** indices with the PRIMARY KEY columns.
1689 ** For virtual tables, only (1) is performed.
1691 static void convertToWithoutRowidTable(Parse *pParse, Table *pTab){
1692 Index *pIdx;
1693 Index *pPk;
1694 int nPk;
1695 int i, j;
1696 sqlite3 *db = pParse->db;
1697 Vdbe *v = pParse->pVdbe;
1699 /* Mark every PRIMARY KEY column as NOT NULL (except for imposter tables)
1701 if( !db->init.imposterTable ){
1702 for(i=0; i<pTab->nCol; i++){
1703 if( (pTab->aCol[i].colFlags & COLFLAG_PRIMKEY)!=0 ){
1704 pTab->aCol[i].notNull = OE_Abort;
1709 /* The remaining transformations only apply to b-tree tables, not to
1710 ** virtual tables */
1711 if( IN_DECLARE_VTAB ) return;
1713 /* Convert the P3 operand of the OP_CreateBtree opcode from BTREE_INTKEY
1714 ** into BTREE_BLOBKEY.
1716 if( pParse->addrCrTab ){
1717 assert( v );
1718 sqlite3VdbeChangeP3(v, pParse->addrCrTab, BTREE_BLOBKEY);
1721 /* Locate the PRIMARY KEY index. Or, if this table was originally
1722 ** an INTEGER PRIMARY KEY table, create a new PRIMARY KEY index.
1724 if( pTab->iPKey>=0 ){
1725 ExprList *pList;
1726 Token ipkToken;
1727 sqlite3TokenInit(&ipkToken, pTab->aCol[pTab->iPKey].zName);
1728 pList = sqlite3ExprListAppend(pParse, 0,
1729 sqlite3ExprAlloc(db, TK_ID, &ipkToken, 0));
1730 if( pList==0 ) return;
1731 pList->a[0].sortOrder = pParse->iPkSortOrder;
1732 assert( pParse->pNewTable==pTab );
1733 sqlite3CreateIndex(pParse, 0, 0, 0, pList, pTab->keyConf, 0, 0, 0, 0,
1734 SQLITE_IDXTYPE_PRIMARYKEY);
1735 if( db->mallocFailed ) return;
1736 pPk = sqlite3PrimaryKeyIndex(pTab);
1737 pTab->iPKey = -1;
1738 }else{
1739 pPk = sqlite3PrimaryKeyIndex(pTab);
1742 ** Remove all redundant columns from the PRIMARY KEY. For example, change
1743 ** "PRIMARY KEY(a,b,a,b,c,b,c,d)" into just "PRIMARY KEY(a,b,c,d)". Later
1744 ** code assumes the PRIMARY KEY contains no repeated columns.
1746 for(i=j=1; i<pPk->nKeyCol; i++){
1747 if( hasColumn(pPk->aiColumn, j, pPk->aiColumn[i]) ){
1748 pPk->nColumn--;
1749 }else{
1750 pPk->aiColumn[j++] = pPk->aiColumn[i];
1753 pPk->nKeyCol = j;
1755 assert( pPk!=0 );
1756 pPk->isCovering = 1;
1757 if( !db->init.imposterTable ) pPk->uniqNotNull = 1;
1758 nPk = pPk->nKeyCol;
1760 /* Bypass the creation of the PRIMARY KEY btree and the sqlite_master
1761 ** table entry. This is only required if currently generating VDBE
1762 ** code for a CREATE TABLE (not when parsing one as part of reading
1763 ** a database schema). */
1764 if( v && pPk->tnum>0 ){
1765 assert( db->init.busy==0 );
1766 sqlite3VdbeChangeOpcode(v, pPk->tnum, OP_Goto);
1769 /* The root page of the PRIMARY KEY is the table root page */
1770 pPk->tnum = pTab->tnum;
1772 /* Update the in-memory representation of all UNIQUE indices by converting
1773 ** the final rowid column into one or more columns of the PRIMARY KEY.
1775 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1776 int n;
1777 if( IsPrimaryKeyIndex(pIdx) ) continue;
1778 for(i=n=0; i<nPk; i++){
1779 if( !hasColumn(pIdx->aiColumn, pIdx->nKeyCol, pPk->aiColumn[i]) ) n++;
1781 if( n==0 ){
1782 /* This index is a superset of the primary key */
1783 pIdx->nColumn = pIdx->nKeyCol;
1784 continue;
1786 if( resizeIndexObject(db, pIdx, pIdx->nKeyCol+n) ) return;
1787 for(i=0, j=pIdx->nKeyCol; i<nPk; i++){
1788 if( !hasColumn(pIdx->aiColumn, pIdx->nKeyCol, pPk->aiColumn[i]) ){
1789 pIdx->aiColumn[j] = pPk->aiColumn[i];
1790 pIdx->azColl[j] = pPk->azColl[i];
1791 j++;
1794 assert( pIdx->nColumn>=pIdx->nKeyCol+n );
1795 assert( pIdx->nColumn>=j );
1798 /* Add all table columns to the PRIMARY KEY index
1800 if( nPk<pTab->nCol ){
1801 if( resizeIndexObject(db, pPk, pTab->nCol) ) return;
1802 for(i=0, j=nPk; i<pTab->nCol; i++){
1803 if( !hasColumn(pPk->aiColumn, j, i) ){
1804 assert( j<pPk->nColumn );
1805 pPk->aiColumn[j] = i;
1806 pPk->azColl[j] = sqlite3StrBINARY;
1807 j++;
1810 assert( pPk->nColumn==j );
1811 assert( pTab->nCol==j );
1812 }else{
1813 pPk->nColumn = pTab->nCol;
1818 ** This routine is called to report the final ")" that terminates
1819 ** a CREATE TABLE statement.
1821 ** The table structure that other action routines have been building
1822 ** is added to the internal hash tables, assuming no errors have
1823 ** occurred.
1825 ** An entry for the table is made in the master table on disk, unless
1826 ** this is a temporary table or db->init.busy==1. When db->init.busy==1
1827 ** it means we are reading the sqlite_master table because we just
1828 ** connected to the database or because the sqlite_master table has
1829 ** recently changed, so the entry for this table already exists in
1830 ** the sqlite_master table. We do not want to create it again.
1832 ** If the pSelect argument is not NULL, it means that this routine
1833 ** was called to create a table generated from a
1834 ** "CREATE TABLE ... AS SELECT ..." statement. The column names of
1835 ** the new table will match the result set of the SELECT.
1837 void sqlite3EndTable(
1838 Parse *pParse, /* Parse context */
1839 Token *pCons, /* The ',' token after the last column defn. */
1840 Token *pEnd, /* The ')' before options in the CREATE TABLE */
1841 u8 tabOpts, /* Extra table options. Usually 0. */
1842 Select *pSelect /* Select from a "CREATE ... AS SELECT" */
1844 Table *p; /* The new table */
1845 sqlite3 *db = pParse->db; /* The database connection */
1846 int iDb; /* Database in which the table lives */
1847 Index *pIdx; /* An implied index of the table */
1849 if( pEnd==0 && pSelect==0 ){
1850 return;
1852 assert( !db->mallocFailed );
1853 p = pParse->pNewTable;
1854 if( p==0 ) return;
1856 assert( !db->init.busy || !pSelect );
1858 /* If the db->init.busy is 1 it means we are reading the SQL off the
1859 ** "sqlite_master" or "sqlite_temp_master" table on the disk.
1860 ** So do not write to the disk again. Extract the root page number
1861 ** for the table from the db->init.newTnum field. (The page number
1862 ** should have been put there by the sqliteOpenCb routine.)
1864 ** If the root page number is 1, that means this is the sqlite_master
1865 ** table itself. So mark it read-only.
1867 if( db->init.busy ){
1868 p->tnum = db->init.newTnum;
1869 if( p->tnum==1 ) p->tabFlags |= TF_Readonly;
1872 /* Special processing for WITHOUT ROWID Tables */
1873 if( tabOpts & TF_WithoutRowid ){
1874 if( (p->tabFlags & TF_Autoincrement) ){
1875 sqlite3ErrorMsg(pParse,
1876 "AUTOINCREMENT not allowed on WITHOUT ROWID tables");
1877 return;
1879 if( (p->tabFlags & TF_HasPrimaryKey)==0 ){
1880 sqlite3ErrorMsg(pParse, "PRIMARY KEY missing on table %s", p->zName);
1881 }else{
1882 p->tabFlags |= TF_WithoutRowid | TF_NoVisibleRowid;
1883 convertToWithoutRowidTable(pParse, p);
1887 iDb = sqlite3SchemaToIndex(db, p->pSchema);
1889 #ifndef SQLITE_OMIT_CHECK
1890 /* Resolve names in all CHECK constraint expressions.
1892 if( p->pCheck ){
1893 sqlite3ResolveSelfReference(pParse, p, NC_IsCheck, 0, p->pCheck);
1895 #endif /* !defined(SQLITE_OMIT_CHECK) */
1897 /* Estimate the average row size for the table and for all implied indices */
1898 estimateTableWidth(p);
1899 for(pIdx=p->pIndex; pIdx; pIdx=pIdx->pNext){
1900 estimateIndexWidth(pIdx);
1903 /* If not initializing, then create a record for the new table
1904 ** in the SQLITE_MASTER table of the database.
1906 ** If this is a TEMPORARY table, write the entry into the auxiliary
1907 ** file instead of into the main database file.
1909 if( !db->init.busy ){
1910 int n;
1911 Vdbe *v;
1912 char *zType; /* "view" or "table" */
1913 char *zType2; /* "VIEW" or "TABLE" */
1914 char *zStmt; /* Text of the CREATE TABLE or CREATE VIEW statement */
1916 v = sqlite3GetVdbe(pParse);
1917 if( NEVER(v==0) ) return;
1919 sqlite3VdbeAddOp1(v, OP_Close, 0);
1922 ** Initialize zType for the new view or table.
1924 if( p->pSelect==0 ){
1925 /* A regular table */
1926 zType = "table";
1927 zType2 = "TABLE";
1928 #ifndef SQLITE_OMIT_VIEW
1929 }else{
1930 /* A view */
1931 zType = "view";
1932 zType2 = "VIEW";
1933 #endif
1936 /* If this is a CREATE TABLE xx AS SELECT ..., execute the SELECT
1937 ** statement to populate the new table. The root-page number for the
1938 ** new table is in register pParse->regRoot.
1940 ** Once the SELECT has been coded by sqlite3Select(), it is in a
1941 ** suitable state to query for the column names and types to be used
1942 ** by the new table.
1944 ** A shared-cache write-lock is not required to write to the new table,
1945 ** as a schema-lock must have already been obtained to create it. Since
1946 ** a schema-lock excludes all other database users, the write-lock would
1947 ** be redundant.
1949 if( pSelect ){
1950 SelectDest dest; /* Where the SELECT should store results */
1951 int regYield; /* Register holding co-routine entry-point */
1952 int addrTop; /* Top of the co-routine */
1953 int regRec; /* A record to be insert into the new table */
1954 int regRowid; /* Rowid of the next row to insert */
1955 int addrInsLoop; /* Top of the loop for inserting rows */
1956 Table *pSelTab; /* A table that describes the SELECT results */
1958 regYield = ++pParse->nMem;
1959 regRec = ++pParse->nMem;
1960 regRowid = ++pParse->nMem;
1961 assert(pParse->nTab==1);
1962 sqlite3MayAbort(pParse);
1963 sqlite3VdbeAddOp3(v, OP_OpenWrite, 1, pParse->regRoot, iDb);
1964 sqlite3VdbeChangeP5(v, OPFLAG_P2ISREG);
1965 pParse->nTab = 2;
1966 addrTop = sqlite3VdbeCurrentAddr(v) + 1;
1967 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, addrTop);
1968 sqlite3SelectDestInit(&dest, SRT_Coroutine, regYield);
1969 sqlite3Select(pParse, pSelect, &dest);
1970 sqlite3VdbeEndCoroutine(v, regYield);
1971 sqlite3VdbeJumpHere(v, addrTop - 1);
1972 if( pParse->nErr ) return;
1973 pSelTab = sqlite3ResultSetOfSelect(pParse, pSelect);
1974 if( pSelTab==0 ) return;
1975 assert( p->aCol==0 );
1976 p->nCol = pSelTab->nCol;
1977 p->aCol = pSelTab->aCol;
1978 pSelTab->nCol = 0;
1979 pSelTab->aCol = 0;
1980 sqlite3DeleteTable(db, pSelTab);
1981 addrInsLoop = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm);
1982 VdbeCoverage(v);
1983 sqlite3VdbeAddOp3(v, OP_MakeRecord, dest.iSdst, dest.nSdst, regRec);
1984 sqlite3TableAffinity(v, p, 0);
1985 sqlite3VdbeAddOp2(v, OP_NewRowid, 1, regRowid);
1986 sqlite3VdbeAddOp3(v, OP_Insert, 1, regRec, regRowid);
1987 sqlite3VdbeGoto(v, addrInsLoop);
1988 sqlite3VdbeJumpHere(v, addrInsLoop);
1989 sqlite3VdbeAddOp1(v, OP_Close, 1);
1992 /* Compute the complete text of the CREATE statement */
1993 if( pSelect ){
1994 zStmt = createTableStmt(db, p);
1995 }else{
1996 Token *pEnd2 = tabOpts ? &pParse->sLastToken : pEnd;
1997 n = (int)(pEnd2->z - pParse->sNameToken.z);
1998 if( pEnd2->z[0]!=';' ) n += pEnd2->n;
1999 zStmt = sqlite3MPrintf(db,
2000 "CREATE %s %.*s", zType2, n, pParse->sNameToken.z
2004 /* A slot for the record has already been allocated in the
2005 ** SQLITE_MASTER table. We just need to update that slot with all
2006 ** the information we've collected.
2008 sqlite3NestedParse(pParse,
2009 "UPDATE %Q.%s "
2010 "SET type='%s', name=%Q, tbl_name=%Q, rootpage=#%d, sql=%Q "
2011 "WHERE rowid=#%d",
2012 db->aDb[iDb].zDbSName, MASTER_NAME,
2013 zType,
2014 p->zName,
2015 p->zName,
2016 pParse->regRoot,
2017 zStmt,
2018 pParse->regRowid
2020 sqlite3DbFree(db, zStmt);
2021 sqlite3ChangeCookie(pParse, iDb);
2023 #ifndef SQLITE_OMIT_AUTOINCREMENT
2024 /* Check to see if we need to create an sqlite_sequence table for
2025 ** keeping track of autoincrement keys.
2027 if( (p->tabFlags & TF_Autoincrement)!=0 ){
2028 Db *pDb = &db->aDb[iDb];
2029 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
2030 if( pDb->pSchema->pSeqTab==0 ){
2031 sqlite3NestedParse(pParse,
2032 "CREATE TABLE %Q.sqlite_sequence(name,seq)",
2033 pDb->zDbSName
2037 #endif
2039 /* Reparse everything to update our internal data structures */
2040 sqlite3VdbeAddParseSchemaOp(v, iDb,
2041 sqlite3MPrintf(db, "tbl_name='%q' AND type!='trigger'", p->zName));
2045 /* Add the table to the in-memory representation of the database.
2047 if( db->init.busy ){
2048 Table *pOld;
2049 Schema *pSchema = p->pSchema;
2050 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
2051 pOld = sqlite3HashInsert(&pSchema->tblHash, p->zName, p);
2052 if( pOld ){
2053 assert( p==pOld ); /* Malloc must have failed inside HashInsert() */
2054 sqlite3OomFault(db);
2055 return;
2057 pParse->pNewTable = 0;
2058 db->mDbFlags |= DBFLAG_SchemaChange;
2060 #ifndef SQLITE_OMIT_ALTERTABLE
2061 if( !p->pSelect ){
2062 const char *zName = (const char *)pParse->sNameToken.z;
2063 int nName;
2064 assert( !pSelect && pCons && pEnd );
2065 if( pCons->z==0 ){
2066 pCons = pEnd;
2068 nName = (int)((const char *)pCons->z - zName);
2069 p->addColOffset = 13 + sqlite3Utf8CharLen(zName, nName);
2071 #endif
2075 #ifndef SQLITE_OMIT_VIEW
2077 ** The parser calls this routine in order to create a new VIEW
2079 void sqlite3CreateView(
2080 Parse *pParse, /* The parsing context */
2081 Token *pBegin, /* The CREATE token that begins the statement */
2082 Token *pName1, /* The token that holds the name of the view */
2083 Token *pName2, /* The token that holds the name of the view */
2084 ExprList *pCNames, /* Optional list of view column names */
2085 Select *pSelect, /* A SELECT statement that will become the new view */
2086 int isTemp, /* TRUE for a TEMPORARY view */
2087 int noErr /* Suppress error messages if VIEW already exists */
2089 Table *p;
2090 int n;
2091 const char *z;
2092 Token sEnd;
2093 DbFixer sFix;
2094 Token *pName = 0;
2095 int iDb;
2096 sqlite3 *db = pParse->db;
2098 if( pParse->nVar>0 ){
2099 sqlite3ErrorMsg(pParse, "parameters are not allowed in views");
2100 goto create_view_fail;
2102 sqlite3StartTable(pParse, pName1, pName2, isTemp, 1, 0, noErr);
2103 p = pParse->pNewTable;
2104 if( p==0 || pParse->nErr ) goto create_view_fail;
2105 sqlite3TwoPartName(pParse, pName1, pName2, &pName);
2106 iDb = sqlite3SchemaToIndex(db, p->pSchema);
2107 sqlite3FixInit(&sFix, pParse, iDb, "view", pName);
2108 if( sqlite3FixSelect(&sFix, pSelect) ) goto create_view_fail;
2110 /* Make a copy of the entire SELECT statement that defines the view.
2111 ** This will force all the Expr.token.z values to be dynamically
2112 ** allocated rather than point to the input string - which means that
2113 ** they will persist after the current sqlite3_exec() call returns.
2115 p->pSelect = sqlite3SelectDup(db, pSelect, EXPRDUP_REDUCE);
2116 p->pCheck = sqlite3ExprListDup(db, pCNames, EXPRDUP_REDUCE);
2117 if( db->mallocFailed ) goto create_view_fail;
2119 /* Locate the end of the CREATE VIEW statement. Make sEnd point to
2120 ** the end.
2122 sEnd = pParse->sLastToken;
2123 assert( sEnd.z[0]!=0 );
2124 if( sEnd.z[0]!=';' ){
2125 sEnd.z += sEnd.n;
2127 sEnd.n = 0;
2128 n = (int)(sEnd.z - pBegin->z);
2129 assert( n>0 );
2130 z = pBegin->z;
2131 while( sqlite3Isspace(z[n-1]) ){ n--; }
2132 sEnd.z = &z[n-1];
2133 sEnd.n = 1;
2135 /* Use sqlite3EndTable() to add the view to the SQLITE_MASTER table */
2136 sqlite3EndTable(pParse, 0, &sEnd, 0, 0);
2138 create_view_fail:
2139 sqlite3SelectDelete(db, pSelect);
2140 sqlite3ExprListDelete(db, pCNames);
2141 return;
2143 #endif /* SQLITE_OMIT_VIEW */
2145 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
2147 ** The Table structure pTable is really a VIEW. Fill in the names of
2148 ** the columns of the view in the pTable structure. Return the number
2149 ** of errors. If an error is seen leave an error message in pParse->zErrMsg.
2151 int sqlite3ViewGetColumnNames(Parse *pParse, Table *pTable){
2152 Table *pSelTab; /* A fake table from which we get the result set */
2153 Select *pSel; /* Copy of the SELECT that implements the view */
2154 int nErr = 0; /* Number of errors encountered */
2155 int n; /* Temporarily holds the number of cursors assigned */
2156 sqlite3 *db = pParse->db; /* Database connection for malloc errors */
2157 #ifndef SQLITE_OMIT_VIRTUALTABLE
2158 int rc;
2159 #endif
2160 #ifndef SQLITE_OMIT_AUTHORIZATION
2161 sqlite3_xauth xAuth; /* Saved xAuth pointer */
2162 #endif
2164 assert( pTable );
2166 #ifndef SQLITE_OMIT_VIRTUALTABLE
2167 db->nSchemaLock++;
2168 rc = sqlite3VtabCallConnect(pParse, pTable);
2169 db->nSchemaLock--;
2170 if( rc ){
2171 return 1;
2173 if( IsVirtual(pTable) ) return 0;
2174 #endif
2176 #ifndef SQLITE_OMIT_VIEW
2177 /* A positive nCol means the columns names for this view are
2178 ** already known.
2180 if( pTable->nCol>0 ) return 0;
2182 /* A negative nCol is a special marker meaning that we are currently
2183 ** trying to compute the column names. If we enter this routine with
2184 ** a negative nCol, it means two or more views form a loop, like this:
2186 ** CREATE VIEW one AS SELECT * FROM two;
2187 ** CREATE VIEW two AS SELECT * FROM one;
2189 ** Actually, the error above is now caught prior to reaching this point.
2190 ** But the following test is still important as it does come up
2191 ** in the following:
2193 ** CREATE TABLE main.ex1(a);
2194 ** CREATE TEMP VIEW ex1 AS SELECT a FROM ex1;
2195 ** SELECT * FROM temp.ex1;
2197 if( pTable->nCol<0 ){
2198 sqlite3ErrorMsg(pParse, "view %s is circularly defined", pTable->zName);
2199 return 1;
2201 assert( pTable->nCol>=0 );
2203 /* If we get this far, it means we need to compute the table names.
2204 ** Note that the call to sqlite3ResultSetOfSelect() will expand any
2205 ** "*" elements in the results set of the view and will assign cursors
2206 ** to the elements of the FROM clause. But we do not want these changes
2207 ** to be permanent. So the computation is done on a copy of the SELECT
2208 ** statement that defines the view.
2210 assert( pTable->pSelect );
2211 pSel = sqlite3SelectDup(db, pTable->pSelect, 0);
2212 if( pSel ){
2213 n = pParse->nTab;
2214 sqlite3SrcListAssignCursors(pParse, pSel->pSrc);
2215 pTable->nCol = -1;
2216 db->lookaside.bDisable++;
2217 #ifndef SQLITE_OMIT_AUTHORIZATION
2218 xAuth = db->xAuth;
2219 db->xAuth = 0;
2220 pSelTab = sqlite3ResultSetOfSelect(pParse, pSel);
2221 db->xAuth = xAuth;
2222 #else
2223 pSelTab = sqlite3ResultSetOfSelect(pParse, pSel);
2224 #endif
2225 pParse->nTab = n;
2226 if( pTable->pCheck ){
2227 /* CREATE VIEW name(arglist) AS ...
2228 ** The names of the columns in the table are taken from
2229 ** arglist which is stored in pTable->pCheck. The pCheck field
2230 ** normally holds CHECK constraints on an ordinary table, but for
2231 ** a VIEW it holds the list of column names.
2233 sqlite3ColumnsFromExprList(pParse, pTable->pCheck,
2234 &pTable->nCol, &pTable->aCol);
2235 if( db->mallocFailed==0
2236 && pParse->nErr==0
2237 && pTable->nCol==pSel->pEList->nExpr
2239 sqlite3SelectAddColumnTypeAndCollation(pParse, pTable, pSel);
2241 }else if( pSelTab ){
2242 /* CREATE VIEW name AS... without an argument list. Construct
2243 ** the column names from the SELECT statement that defines the view.
2245 assert( pTable->aCol==0 );
2246 pTable->nCol = pSelTab->nCol;
2247 pTable->aCol = pSelTab->aCol;
2248 pSelTab->nCol = 0;
2249 pSelTab->aCol = 0;
2250 assert( sqlite3SchemaMutexHeld(db, 0, pTable->pSchema) );
2251 }else{
2252 pTable->nCol = 0;
2253 nErr++;
2255 sqlite3DeleteTable(db, pSelTab);
2256 sqlite3SelectDelete(db, pSel);
2257 db->lookaside.bDisable--;
2258 } else {
2259 nErr++;
2261 pTable->pSchema->schemaFlags |= DB_UnresetViews;
2262 #endif /* SQLITE_OMIT_VIEW */
2263 return nErr;
2265 #endif /* !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) */
2267 #ifndef SQLITE_OMIT_VIEW
2269 ** Clear the column names from every VIEW in database idx.
2271 static void sqliteViewResetAll(sqlite3 *db, int idx){
2272 HashElem *i;
2273 assert( sqlite3SchemaMutexHeld(db, idx, 0) );
2274 if( !DbHasProperty(db, idx, DB_UnresetViews) ) return;
2275 for(i=sqliteHashFirst(&db->aDb[idx].pSchema->tblHash); i;i=sqliteHashNext(i)){
2276 Table *pTab = sqliteHashData(i);
2277 if( pTab->pSelect ){
2278 sqlite3DeleteColumnNames(db, pTab);
2279 pTab->aCol = 0;
2280 pTab->nCol = 0;
2283 DbClearProperty(db, idx, DB_UnresetViews);
2285 #else
2286 # define sqliteViewResetAll(A,B)
2287 #endif /* SQLITE_OMIT_VIEW */
2290 ** This function is called by the VDBE to adjust the internal schema
2291 ** used by SQLite when the btree layer moves a table root page. The
2292 ** root-page of a table or index in database iDb has changed from iFrom
2293 ** to iTo.
2295 ** Ticket #1728: The symbol table might still contain information
2296 ** on tables and/or indices that are the process of being deleted.
2297 ** If you are unlucky, one of those deleted indices or tables might
2298 ** have the same rootpage number as the real table or index that is
2299 ** being moved. So we cannot stop searching after the first match
2300 ** because the first match might be for one of the deleted indices
2301 ** or tables and not the table/index that is actually being moved.
2302 ** We must continue looping until all tables and indices with
2303 ** rootpage==iFrom have been converted to have a rootpage of iTo
2304 ** in order to be certain that we got the right one.
2306 #ifndef SQLITE_OMIT_AUTOVACUUM
2307 void sqlite3RootPageMoved(sqlite3 *db, int iDb, int iFrom, int iTo){
2308 HashElem *pElem;
2309 Hash *pHash;
2310 Db *pDb;
2312 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
2313 pDb = &db->aDb[iDb];
2314 pHash = &pDb->pSchema->tblHash;
2315 for(pElem=sqliteHashFirst(pHash); pElem; pElem=sqliteHashNext(pElem)){
2316 Table *pTab = sqliteHashData(pElem);
2317 if( pTab->tnum==iFrom ){
2318 pTab->tnum = iTo;
2321 pHash = &pDb->pSchema->idxHash;
2322 for(pElem=sqliteHashFirst(pHash); pElem; pElem=sqliteHashNext(pElem)){
2323 Index *pIdx = sqliteHashData(pElem);
2324 if( pIdx->tnum==iFrom ){
2325 pIdx->tnum = iTo;
2329 #endif
2332 ** Write code to erase the table with root-page iTable from database iDb.
2333 ** Also write code to modify the sqlite_master table and internal schema
2334 ** if a root-page of another table is moved by the btree-layer whilst
2335 ** erasing iTable (this can happen with an auto-vacuum database).
2337 static void destroyRootPage(Parse *pParse, int iTable, int iDb){
2338 Vdbe *v = sqlite3GetVdbe(pParse);
2339 int r1 = sqlite3GetTempReg(pParse);
2340 assert( iTable>1 );
2341 sqlite3VdbeAddOp3(v, OP_Destroy, iTable, r1, iDb);
2342 sqlite3MayAbort(pParse);
2343 #ifndef SQLITE_OMIT_AUTOVACUUM
2344 /* OP_Destroy stores an in integer r1. If this integer
2345 ** is non-zero, then it is the root page number of a table moved to
2346 ** location iTable. The following code modifies the sqlite_master table to
2347 ** reflect this.
2349 ** The "#NNN" in the SQL is a special constant that means whatever value
2350 ** is in register NNN. See grammar rules associated with the TK_REGISTER
2351 ** token for additional information.
2353 sqlite3NestedParse(pParse,
2354 "UPDATE %Q.%s SET rootpage=%d WHERE #%d AND rootpage=#%d",
2355 pParse->db->aDb[iDb].zDbSName, MASTER_NAME, iTable, r1, r1);
2356 #endif
2357 sqlite3ReleaseTempReg(pParse, r1);
2361 ** Write VDBE code to erase table pTab and all associated indices on disk.
2362 ** Code to update the sqlite_master tables and internal schema definitions
2363 ** in case a root-page belonging to another table is moved by the btree layer
2364 ** is also added (this can happen with an auto-vacuum database).
2366 static void destroyTable(Parse *pParse, Table *pTab){
2367 /* If the database may be auto-vacuum capable (if SQLITE_OMIT_AUTOVACUUM
2368 ** is not defined), then it is important to call OP_Destroy on the
2369 ** table and index root-pages in order, starting with the numerically
2370 ** largest root-page number. This guarantees that none of the root-pages
2371 ** to be destroyed is relocated by an earlier OP_Destroy. i.e. if the
2372 ** following were coded:
2374 ** OP_Destroy 4 0
2375 ** ...
2376 ** OP_Destroy 5 0
2378 ** and root page 5 happened to be the largest root-page number in the
2379 ** database, then root page 5 would be moved to page 4 by the
2380 ** "OP_Destroy 4 0" opcode. The subsequent "OP_Destroy 5 0" would hit
2381 ** a free-list page.
2383 int iTab = pTab->tnum;
2384 int iDestroyed = 0;
2386 while( 1 ){
2387 Index *pIdx;
2388 int iLargest = 0;
2390 if( iDestroyed==0 || iTab<iDestroyed ){
2391 iLargest = iTab;
2393 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
2394 int iIdx = pIdx->tnum;
2395 assert( pIdx->pSchema==pTab->pSchema );
2396 if( (iDestroyed==0 || (iIdx<iDestroyed)) && iIdx>iLargest ){
2397 iLargest = iIdx;
2400 if( iLargest==0 ){
2401 return;
2402 }else{
2403 int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
2404 assert( iDb>=0 && iDb<pParse->db->nDb );
2405 destroyRootPage(pParse, iLargest, iDb);
2406 iDestroyed = iLargest;
2412 ** Remove entries from the sqlite_statN tables (for N in (1,2,3))
2413 ** after a DROP INDEX or DROP TABLE command.
2415 static void sqlite3ClearStatTables(
2416 Parse *pParse, /* The parsing context */
2417 int iDb, /* The database number */
2418 const char *zType, /* "idx" or "tbl" */
2419 const char *zName /* Name of index or table */
2421 int i;
2422 const char *zDbName = pParse->db->aDb[iDb].zDbSName;
2423 for(i=1; i<=4; i++){
2424 char zTab[24];
2425 sqlite3_snprintf(sizeof(zTab),zTab,"sqlite_stat%d",i);
2426 if( sqlite3FindTable(pParse->db, zTab, zDbName) ){
2427 sqlite3NestedParse(pParse,
2428 "DELETE FROM %Q.%s WHERE %s=%Q",
2429 zDbName, zTab, zType, zName
2436 ** Generate code to drop a table.
2438 void sqlite3CodeDropTable(Parse *pParse, Table *pTab, int iDb, int isView){
2439 Vdbe *v;
2440 sqlite3 *db = pParse->db;
2441 Trigger *pTrigger;
2442 Db *pDb = &db->aDb[iDb];
2444 v = sqlite3GetVdbe(pParse);
2445 assert( v!=0 );
2446 sqlite3BeginWriteOperation(pParse, 1, iDb);
2448 #ifndef SQLITE_OMIT_VIRTUALTABLE
2449 if( IsVirtual(pTab) ){
2450 sqlite3VdbeAddOp0(v, OP_VBegin);
2452 #endif
2454 /* Drop all triggers associated with the table being dropped. Code
2455 ** is generated to remove entries from sqlite_master and/or
2456 ** sqlite_temp_master if required.
2458 pTrigger = sqlite3TriggerList(pParse, pTab);
2459 while( pTrigger ){
2460 assert( pTrigger->pSchema==pTab->pSchema ||
2461 pTrigger->pSchema==db->aDb[1].pSchema );
2462 sqlite3DropTriggerPtr(pParse, pTrigger);
2463 pTrigger = pTrigger->pNext;
2466 #ifndef SQLITE_OMIT_AUTOINCREMENT
2467 /* Remove any entries of the sqlite_sequence table associated with
2468 ** the table being dropped. This is done before the table is dropped
2469 ** at the btree level, in case the sqlite_sequence table needs to
2470 ** move as a result of the drop (can happen in auto-vacuum mode).
2472 if( pTab->tabFlags & TF_Autoincrement ){
2473 sqlite3NestedParse(pParse,
2474 "DELETE FROM %Q.sqlite_sequence WHERE name=%Q",
2475 pDb->zDbSName, pTab->zName
2478 #endif
2480 /* Drop all SQLITE_MASTER table and index entries that refer to the
2481 ** table. The program name loops through the master table and deletes
2482 ** every row that refers to a table of the same name as the one being
2483 ** dropped. Triggers are handled separately because a trigger can be
2484 ** created in the temp database that refers to a table in another
2485 ** database.
2487 sqlite3NestedParse(pParse,
2488 "DELETE FROM %Q.%s WHERE tbl_name=%Q and type!='trigger'",
2489 pDb->zDbSName, MASTER_NAME, pTab->zName);
2490 if( !isView && !IsVirtual(pTab) ){
2491 destroyTable(pParse, pTab);
2494 /* Remove the table entry from SQLite's internal schema and modify
2495 ** the schema cookie.
2497 if( IsVirtual(pTab) ){
2498 sqlite3VdbeAddOp4(v, OP_VDestroy, iDb, 0, 0, pTab->zName, 0);
2500 sqlite3VdbeAddOp4(v, OP_DropTable, iDb, 0, 0, pTab->zName, 0);
2501 sqlite3ChangeCookie(pParse, iDb);
2502 sqliteViewResetAll(db, iDb);
2506 ** This routine is called to do the work of a DROP TABLE statement.
2507 ** pName is the name of the table to be dropped.
2509 void sqlite3DropTable(Parse *pParse, SrcList *pName, int isView, int noErr){
2510 Table *pTab;
2511 Vdbe *v;
2512 sqlite3 *db = pParse->db;
2513 int iDb;
2515 if( db->mallocFailed ){
2516 goto exit_drop_table;
2518 assert( pParse->nErr==0 );
2519 assert( pName->nSrc==1 );
2520 if( sqlite3ReadSchema(pParse) ) goto exit_drop_table;
2521 if( noErr ) db->suppressErr++;
2522 assert( isView==0 || isView==LOCATE_VIEW );
2523 pTab = sqlite3LocateTableItem(pParse, isView, &pName->a[0]);
2524 if( noErr ) db->suppressErr--;
2526 if( pTab==0 ){
2527 if( noErr ) sqlite3CodeVerifyNamedSchema(pParse, pName->a[0].zDatabase);
2528 goto exit_drop_table;
2530 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2531 assert( iDb>=0 && iDb<db->nDb );
2533 /* If pTab is a virtual table, call ViewGetColumnNames() to ensure
2534 ** it is initialized.
2536 if( IsVirtual(pTab) && sqlite3ViewGetColumnNames(pParse, pTab) ){
2537 goto exit_drop_table;
2539 #ifndef SQLITE_OMIT_AUTHORIZATION
2541 int code;
2542 const char *zTab = SCHEMA_TABLE(iDb);
2543 const char *zDb = db->aDb[iDb].zDbSName;
2544 const char *zArg2 = 0;
2545 if( sqlite3AuthCheck(pParse, SQLITE_DELETE, zTab, 0, zDb)){
2546 goto exit_drop_table;
2548 if( isView ){
2549 if( !OMIT_TEMPDB && iDb==1 ){
2550 code = SQLITE_DROP_TEMP_VIEW;
2551 }else{
2552 code = SQLITE_DROP_VIEW;
2554 #ifndef SQLITE_OMIT_VIRTUALTABLE
2555 }else if( IsVirtual(pTab) ){
2556 code = SQLITE_DROP_VTABLE;
2557 zArg2 = sqlite3GetVTable(db, pTab)->pMod->zName;
2558 #endif
2559 }else{
2560 if( !OMIT_TEMPDB && iDb==1 ){
2561 code = SQLITE_DROP_TEMP_TABLE;
2562 }else{
2563 code = SQLITE_DROP_TABLE;
2566 if( sqlite3AuthCheck(pParse, code, pTab->zName, zArg2, zDb) ){
2567 goto exit_drop_table;
2569 if( sqlite3AuthCheck(pParse, SQLITE_DELETE, pTab->zName, 0, zDb) ){
2570 goto exit_drop_table;
2573 #endif
2574 if( sqlite3StrNICmp(pTab->zName, "sqlite_", 7)==0
2575 && sqlite3StrNICmp(pTab->zName, "sqlite_stat", 11)!=0 ){
2576 sqlite3ErrorMsg(pParse, "table %s may not be dropped", pTab->zName);
2577 goto exit_drop_table;
2580 #ifndef SQLITE_OMIT_VIEW
2581 /* Ensure DROP TABLE is not used on a view, and DROP VIEW is not used
2582 ** on a table.
2584 if( isView && pTab->pSelect==0 ){
2585 sqlite3ErrorMsg(pParse, "use DROP TABLE to delete table %s", pTab->zName);
2586 goto exit_drop_table;
2588 if( !isView && pTab->pSelect ){
2589 sqlite3ErrorMsg(pParse, "use DROP VIEW to delete view %s", pTab->zName);
2590 goto exit_drop_table;
2592 #endif
2594 /* Generate code to remove the table from the master table
2595 ** on disk.
2597 v = sqlite3GetVdbe(pParse);
2598 if( v ){
2599 sqlite3BeginWriteOperation(pParse, 1, iDb);
2600 sqlite3ClearStatTables(pParse, iDb, "tbl", pTab->zName);
2601 sqlite3FkDropTable(pParse, pName, pTab);
2602 sqlite3CodeDropTable(pParse, pTab, iDb, isView);
2605 exit_drop_table:
2606 sqlite3SrcListDelete(db, pName);
2610 ** This routine is called to create a new foreign key on the table
2611 ** currently under construction. pFromCol determines which columns
2612 ** in the current table point to the foreign key. If pFromCol==0 then
2613 ** connect the key to the last column inserted. pTo is the name of
2614 ** the table referred to (a.k.a the "parent" table). pToCol is a list
2615 ** of tables in the parent pTo table. flags contains all
2616 ** information about the conflict resolution algorithms specified
2617 ** in the ON DELETE, ON UPDATE and ON INSERT clauses.
2619 ** An FKey structure is created and added to the table currently
2620 ** under construction in the pParse->pNewTable field.
2622 ** The foreign key is set for IMMEDIATE processing. A subsequent call
2623 ** to sqlite3DeferForeignKey() might change this to DEFERRED.
2625 void sqlite3CreateForeignKey(
2626 Parse *pParse, /* Parsing context */
2627 ExprList *pFromCol, /* Columns in this table that point to other table */
2628 Token *pTo, /* Name of the other table */
2629 ExprList *pToCol, /* Columns in the other table */
2630 int flags /* Conflict resolution algorithms. */
2632 sqlite3 *db = pParse->db;
2633 #ifndef SQLITE_OMIT_FOREIGN_KEY
2634 FKey *pFKey = 0;
2635 FKey *pNextTo;
2636 Table *p = pParse->pNewTable;
2637 int nByte;
2638 int i;
2639 int nCol;
2640 char *z;
2642 assert( pTo!=0 );
2643 if( p==0 || IN_DECLARE_VTAB ) goto fk_end;
2644 if( pFromCol==0 ){
2645 int iCol = p->nCol-1;
2646 if( NEVER(iCol<0) ) goto fk_end;
2647 if( pToCol && pToCol->nExpr!=1 ){
2648 sqlite3ErrorMsg(pParse, "foreign key on %s"
2649 " should reference only one column of table %T",
2650 p->aCol[iCol].zName, pTo);
2651 goto fk_end;
2653 nCol = 1;
2654 }else if( pToCol && pToCol->nExpr!=pFromCol->nExpr ){
2655 sqlite3ErrorMsg(pParse,
2656 "number of columns in foreign key does not match the number of "
2657 "columns in the referenced table");
2658 goto fk_end;
2659 }else{
2660 nCol = pFromCol->nExpr;
2662 nByte = sizeof(*pFKey) + (nCol-1)*sizeof(pFKey->aCol[0]) + pTo->n + 1;
2663 if( pToCol ){
2664 for(i=0; i<pToCol->nExpr; i++){
2665 nByte += sqlite3Strlen30(pToCol->a[i].zName) + 1;
2668 pFKey = sqlite3DbMallocZero(db, nByte );
2669 if( pFKey==0 ){
2670 goto fk_end;
2672 pFKey->pFrom = p;
2673 pFKey->pNextFrom = p->pFKey;
2674 z = (char*)&pFKey->aCol[nCol];
2675 pFKey->zTo = z;
2676 memcpy(z, pTo->z, pTo->n);
2677 z[pTo->n] = 0;
2678 sqlite3Dequote(z);
2679 z += pTo->n+1;
2680 pFKey->nCol = nCol;
2681 if( pFromCol==0 ){
2682 pFKey->aCol[0].iFrom = p->nCol-1;
2683 }else{
2684 for(i=0; i<nCol; i++){
2685 int j;
2686 for(j=0; j<p->nCol; j++){
2687 if( sqlite3StrICmp(p->aCol[j].zName, pFromCol->a[i].zName)==0 ){
2688 pFKey->aCol[i].iFrom = j;
2689 break;
2692 if( j>=p->nCol ){
2693 sqlite3ErrorMsg(pParse,
2694 "unknown column \"%s\" in foreign key definition",
2695 pFromCol->a[i].zName);
2696 goto fk_end;
2700 if( pToCol ){
2701 for(i=0; i<nCol; i++){
2702 int n = sqlite3Strlen30(pToCol->a[i].zName);
2703 pFKey->aCol[i].zCol = z;
2704 memcpy(z, pToCol->a[i].zName, n);
2705 z[n] = 0;
2706 z += n+1;
2709 pFKey->isDeferred = 0;
2710 pFKey->aAction[0] = (u8)(flags & 0xff); /* ON DELETE action */
2711 pFKey->aAction[1] = (u8)((flags >> 8 ) & 0xff); /* ON UPDATE action */
2713 assert( sqlite3SchemaMutexHeld(db, 0, p->pSchema) );
2714 pNextTo = (FKey *)sqlite3HashInsert(&p->pSchema->fkeyHash,
2715 pFKey->zTo, (void *)pFKey
2717 if( pNextTo==pFKey ){
2718 sqlite3OomFault(db);
2719 goto fk_end;
2721 if( pNextTo ){
2722 assert( pNextTo->pPrevTo==0 );
2723 pFKey->pNextTo = pNextTo;
2724 pNextTo->pPrevTo = pFKey;
2727 /* Link the foreign key to the table as the last step.
2729 p->pFKey = pFKey;
2730 pFKey = 0;
2732 fk_end:
2733 sqlite3DbFree(db, pFKey);
2734 #endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
2735 sqlite3ExprListDelete(db, pFromCol);
2736 sqlite3ExprListDelete(db, pToCol);
2740 ** This routine is called when an INITIALLY IMMEDIATE or INITIALLY DEFERRED
2741 ** clause is seen as part of a foreign key definition. The isDeferred
2742 ** parameter is 1 for INITIALLY DEFERRED and 0 for INITIALLY IMMEDIATE.
2743 ** The behavior of the most recently created foreign key is adjusted
2744 ** accordingly.
2746 void sqlite3DeferForeignKey(Parse *pParse, int isDeferred){
2747 #ifndef SQLITE_OMIT_FOREIGN_KEY
2748 Table *pTab;
2749 FKey *pFKey;
2750 if( (pTab = pParse->pNewTable)==0 || (pFKey = pTab->pFKey)==0 ) return;
2751 assert( isDeferred==0 || isDeferred==1 ); /* EV: R-30323-21917 */
2752 pFKey->isDeferred = (u8)isDeferred;
2753 #endif
2757 ** Generate code that will erase and refill index *pIdx. This is
2758 ** used to initialize a newly created index or to recompute the
2759 ** content of an index in response to a REINDEX command.
2761 ** if memRootPage is not negative, it means that the index is newly
2762 ** created. The register specified by memRootPage contains the
2763 ** root page number of the index. If memRootPage is negative, then
2764 ** the index already exists and must be cleared before being refilled and
2765 ** the root page number of the index is taken from pIndex->tnum.
2767 static void sqlite3RefillIndex(Parse *pParse, Index *pIndex, int memRootPage){
2768 Table *pTab = pIndex->pTable; /* The table that is indexed */
2769 int iTab = pParse->nTab++; /* Btree cursor used for pTab */
2770 int iIdx = pParse->nTab++; /* Btree cursor used for pIndex */
2771 int iSorter; /* Cursor opened by OpenSorter (if in use) */
2772 int addr1; /* Address of top of loop */
2773 int addr2; /* Address to jump to for next iteration */
2774 int tnum; /* Root page of index */
2775 int iPartIdxLabel; /* Jump to this label to skip a row */
2776 Vdbe *v; /* Generate code into this virtual machine */
2777 KeyInfo *pKey; /* KeyInfo for index */
2778 int regRecord; /* Register holding assembled index record */
2779 sqlite3 *db = pParse->db; /* The database connection */
2780 int iDb = sqlite3SchemaToIndex(db, pIndex->pSchema);
2782 #ifndef SQLITE_OMIT_AUTHORIZATION
2783 if( sqlite3AuthCheck(pParse, SQLITE_REINDEX, pIndex->zName, 0,
2784 db->aDb[iDb].zDbSName ) ){
2785 return;
2787 #endif
2789 /* Require a write-lock on the table to perform this operation */
2790 sqlite3TableLock(pParse, iDb, pTab->tnum, 1, pTab->zName);
2792 v = sqlite3GetVdbe(pParse);
2793 if( v==0 ) return;
2794 if( memRootPage>=0 ){
2795 tnum = memRootPage;
2796 }else{
2797 tnum = pIndex->tnum;
2799 pKey = sqlite3KeyInfoOfIndex(pParse, pIndex);
2800 assert( pKey!=0 || db->mallocFailed || pParse->nErr );
2802 /* Open the sorter cursor if we are to use one. */
2803 iSorter = pParse->nTab++;
2804 sqlite3VdbeAddOp4(v, OP_SorterOpen, iSorter, 0, pIndex->nKeyCol, (char*)
2805 sqlite3KeyInfoRef(pKey), P4_KEYINFO);
2807 /* Open the table. Loop through all rows of the table, inserting index
2808 ** records into the sorter. */
2809 sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
2810 addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, 0); VdbeCoverage(v);
2811 regRecord = sqlite3GetTempReg(pParse);
2813 sqlite3GenerateIndexKey(pParse,pIndex,iTab,regRecord,0,&iPartIdxLabel,0,0);
2814 sqlite3VdbeAddOp2(v, OP_SorterInsert, iSorter, regRecord);
2815 sqlite3ResolvePartIdxLabel(pParse, iPartIdxLabel);
2816 sqlite3VdbeAddOp2(v, OP_Next, iTab, addr1+1); VdbeCoverage(v);
2817 sqlite3VdbeJumpHere(v, addr1);
2818 if( memRootPage<0 ) sqlite3VdbeAddOp2(v, OP_Clear, tnum, iDb);
2819 sqlite3VdbeAddOp4(v, OP_OpenWrite, iIdx, tnum, iDb,
2820 (char *)pKey, P4_KEYINFO);
2821 sqlite3VdbeChangeP5(v, OPFLAG_BULKCSR|((memRootPage>=0)?OPFLAG_P2ISREG:0));
2823 addr1 = sqlite3VdbeAddOp2(v, OP_SorterSort, iSorter, 0); VdbeCoverage(v);
2824 if( IsUniqueIndex(pIndex) ){
2825 int j2 = sqlite3VdbeCurrentAddr(v) + 3;
2826 sqlite3VdbeGoto(v, j2);
2827 addr2 = sqlite3VdbeCurrentAddr(v);
2828 sqlite3VdbeAddOp4Int(v, OP_SorterCompare, iSorter, j2, regRecord,
2829 pIndex->nKeyCol); VdbeCoverage(v);
2830 sqlite3UniqueConstraint(pParse, OE_Abort, pIndex);
2831 }else{
2832 addr2 = sqlite3VdbeCurrentAddr(v);
2834 sqlite3VdbeAddOp3(v, OP_SorterData, iSorter, regRecord, iIdx);
2835 sqlite3VdbeAddOp1(v, OP_SeekEnd, iIdx);
2836 sqlite3VdbeAddOp2(v, OP_IdxInsert, iIdx, regRecord);
2837 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2838 sqlite3ReleaseTempReg(pParse, regRecord);
2839 sqlite3VdbeAddOp2(v, OP_SorterNext, iSorter, addr2); VdbeCoverage(v);
2840 sqlite3VdbeJumpHere(v, addr1);
2842 sqlite3VdbeAddOp1(v, OP_Close, iTab);
2843 sqlite3VdbeAddOp1(v, OP_Close, iIdx);
2844 sqlite3VdbeAddOp1(v, OP_Close, iSorter);
2848 ** Allocate heap space to hold an Index object with nCol columns.
2850 ** Increase the allocation size to provide an extra nExtra bytes
2851 ** of 8-byte aligned space after the Index object and return a
2852 ** pointer to this extra space in *ppExtra.
2854 Index *sqlite3AllocateIndexObject(
2855 sqlite3 *db, /* Database connection */
2856 i16 nCol, /* Total number of columns in the index */
2857 int nExtra, /* Number of bytes of extra space to alloc */
2858 char **ppExtra /* Pointer to the "extra" space */
2860 Index *p; /* Allocated index object */
2861 int nByte; /* Bytes of space for Index object + arrays */
2863 nByte = ROUND8(sizeof(Index)) + /* Index structure */
2864 ROUND8(sizeof(char*)*nCol) + /* Index.azColl */
2865 ROUND8(sizeof(LogEst)*(nCol+1) + /* Index.aiRowLogEst */
2866 sizeof(i16)*nCol + /* Index.aiColumn */
2867 sizeof(u8)*nCol); /* Index.aSortOrder */
2868 p = sqlite3DbMallocZero(db, nByte + nExtra);
2869 if( p ){
2870 char *pExtra = ((char*)p)+ROUND8(sizeof(Index));
2871 p->azColl = (const char**)pExtra; pExtra += ROUND8(sizeof(char*)*nCol);
2872 p->aiRowLogEst = (LogEst*)pExtra; pExtra += sizeof(LogEst)*(nCol+1);
2873 p->aiColumn = (i16*)pExtra; pExtra += sizeof(i16)*nCol;
2874 p->aSortOrder = (u8*)pExtra;
2875 p->nColumn = nCol;
2876 p->nKeyCol = nCol - 1;
2877 *ppExtra = ((char*)p) + nByte;
2879 return p;
2883 ** Create a new index for an SQL table. pName1.pName2 is the name of the index
2884 ** and pTblList is the name of the table that is to be indexed. Both will
2885 ** be NULL for a primary key or an index that is created to satisfy a
2886 ** UNIQUE constraint. If pTable and pIndex are NULL, use pParse->pNewTable
2887 ** as the table to be indexed. pParse->pNewTable is a table that is
2888 ** currently being constructed by a CREATE TABLE statement.
2890 ** pList is a list of columns to be indexed. pList will be NULL if this
2891 ** is a primary key or unique-constraint on the most recent column added
2892 ** to the table currently under construction.
2894 void sqlite3CreateIndex(
2895 Parse *pParse, /* All information about this parse */
2896 Token *pName1, /* First part of index name. May be NULL */
2897 Token *pName2, /* Second part of index name. May be NULL */
2898 SrcList *pTblName, /* Table to index. Use pParse->pNewTable if 0 */
2899 ExprList *pList, /* A list of columns to be indexed */
2900 int onError, /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
2901 Token *pStart, /* The CREATE token that begins this statement */
2902 Expr *pPIWhere, /* WHERE clause for partial indices */
2903 int sortOrder, /* Sort order of primary key when pList==NULL */
2904 int ifNotExist, /* Omit error if index already exists */
2905 u8 idxType /* The index type */
2907 Table *pTab = 0; /* Table to be indexed */
2908 Index *pIndex = 0; /* The index to be created */
2909 char *zName = 0; /* Name of the index */
2910 int nName; /* Number of characters in zName */
2911 int i, j;
2912 DbFixer sFix; /* For assigning database names to pTable */
2913 int sortOrderMask; /* 1 to honor DESC in index. 0 to ignore. */
2914 sqlite3 *db = pParse->db;
2915 Db *pDb; /* The specific table containing the indexed database */
2916 int iDb; /* Index of the database that is being written */
2917 Token *pName = 0; /* Unqualified name of the index to create */
2918 struct ExprList_item *pListItem; /* For looping over pList */
2919 int nExtra = 0; /* Space allocated for zExtra[] */
2920 int nExtraCol; /* Number of extra columns needed */
2921 char *zExtra = 0; /* Extra space after the Index object */
2922 Index *pPk = 0; /* PRIMARY KEY index for WITHOUT ROWID tables */
2924 if( db->mallocFailed || pParse->nErr>0 ){
2925 goto exit_create_index;
2927 if( IN_DECLARE_VTAB && idxType!=SQLITE_IDXTYPE_PRIMARYKEY ){
2928 goto exit_create_index;
2930 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
2931 goto exit_create_index;
2935 ** Find the table that is to be indexed. Return early if not found.
2937 if( pTblName!=0 ){
2939 /* Use the two-part index name to determine the database
2940 ** to search for the table. 'Fix' the table name to this db
2941 ** before looking up the table.
2943 assert( pName1 && pName2 );
2944 iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pName);
2945 if( iDb<0 ) goto exit_create_index;
2946 assert( pName && pName->z );
2948 #ifndef SQLITE_OMIT_TEMPDB
2949 /* If the index name was unqualified, check if the table
2950 ** is a temp table. If so, set the database to 1. Do not do this
2951 ** if initialising a database schema.
2953 if( !db->init.busy ){
2954 pTab = sqlite3SrcListLookup(pParse, pTblName);
2955 if( pName2->n==0 && pTab && pTab->pSchema==db->aDb[1].pSchema ){
2956 iDb = 1;
2959 #endif
2961 sqlite3FixInit(&sFix, pParse, iDb, "index", pName);
2962 if( sqlite3FixSrcList(&sFix, pTblName) ){
2963 /* Because the parser constructs pTblName from a single identifier,
2964 ** sqlite3FixSrcList can never fail. */
2965 assert(0);
2967 pTab = sqlite3LocateTableItem(pParse, 0, &pTblName->a[0]);
2968 assert( db->mallocFailed==0 || pTab==0 );
2969 if( pTab==0 ) goto exit_create_index;
2970 if( iDb==1 && db->aDb[iDb].pSchema!=pTab->pSchema ){
2971 sqlite3ErrorMsg(pParse,
2972 "cannot create a TEMP index on non-TEMP table \"%s\"",
2973 pTab->zName);
2974 goto exit_create_index;
2976 if( !HasRowid(pTab) ) pPk = sqlite3PrimaryKeyIndex(pTab);
2977 }else{
2978 assert( pName==0 );
2979 assert( pStart==0 );
2980 pTab = pParse->pNewTable;
2981 if( !pTab ) goto exit_create_index;
2982 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2984 pDb = &db->aDb[iDb];
2986 assert( pTab!=0 );
2987 assert( pParse->nErr==0 );
2988 if( sqlite3StrNICmp(pTab->zName, "sqlite_", 7)==0
2989 && db->init.busy==0
2990 #if SQLITE_USER_AUTHENTICATION
2991 && sqlite3UserAuthTable(pTab->zName)==0
2992 #endif
2993 && sqlite3StrNICmp(&pTab->zName[7],"altertab_",9)!=0 ){
2994 sqlite3ErrorMsg(pParse, "table %s may not be indexed", pTab->zName);
2995 goto exit_create_index;
2997 #ifndef SQLITE_OMIT_VIEW
2998 if( pTab->pSelect ){
2999 sqlite3ErrorMsg(pParse, "views may not be indexed");
3000 goto exit_create_index;
3002 #endif
3003 #ifndef SQLITE_OMIT_VIRTUALTABLE
3004 if( IsVirtual(pTab) ){
3005 sqlite3ErrorMsg(pParse, "virtual tables may not be indexed");
3006 goto exit_create_index;
3008 #endif
3011 ** Find the name of the index. Make sure there is not already another
3012 ** index or table with the same name.
3014 ** Exception: If we are reading the names of permanent indices from the
3015 ** sqlite_master table (because some other process changed the schema) and
3016 ** one of the index names collides with the name of a temporary table or
3017 ** index, then we will continue to process this index.
3019 ** If pName==0 it means that we are
3020 ** dealing with a primary key or UNIQUE constraint. We have to invent our
3021 ** own name.
3023 if( pName ){
3024 zName = sqlite3NameFromToken(db, pName);
3025 if( zName==0 ) goto exit_create_index;
3026 assert( pName->z!=0 );
3027 if( SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){
3028 goto exit_create_index;
3030 if( !db->init.busy ){
3031 if( sqlite3FindTable(db, zName, 0)!=0 ){
3032 sqlite3ErrorMsg(pParse, "there is already a table named %s", zName);
3033 goto exit_create_index;
3036 if( sqlite3FindIndex(db, zName, pDb->zDbSName)!=0 ){
3037 if( !ifNotExist ){
3038 sqlite3ErrorMsg(pParse, "index %s already exists", zName);
3039 }else{
3040 assert( !db->init.busy );
3041 sqlite3CodeVerifySchema(pParse, iDb);
3043 goto exit_create_index;
3045 }else{
3046 int n;
3047 Index *pLoop;
3048 for(pLoop=pTab->pIndex, n=1; pLoop; pLoop=pLoop->pNext, n++){}
3049 zName = sqlite3MPrintf(db, "sqlite_autoindex_%s_%d", pTab->zName, n);
3050 if( zName==0 ){
3051 goto exit_create_index;
3054 /* Automatic index names generated from within sqlite3_declare_vtab()
3055 ** must have names that are distinct from normal automatic index names.
3056 ** The following statement converts "sqlite3_autoindex..." into
3057 ** "sqlite3_butoindex..." in order to make the names distinct.
3058 ** The "vtab_err.test" test demonstrates the need of this statement. */
3059 if( IN_DECLARE_VTAB ) zName[7]++;
3062 /* Check for authorization to create an index.
3064 #ifndef SQLITE_OMIT_AUTHORIZATION
3066 const char *zDb = pDb->zDbSName;
3067 if( sqlite3AuthCheck(pParse, SQLITE_INSERT, SCHEMA_TABLE(iDb), 0, zDb) ){
3068 goto exit_create_index;
3070 i = SQLITE_CREATE_INDEX;
3071 if( !OMIT_TEMPDB && iDb==1 ) i = SQLITE_CREATE_TEMP_INDEX;
3072 if( sqlite3AuthCheck(pParse, i, zName, pTab->zName, zDb) ){
3073 goto exit_create_index;
3076 #endif
3078 /* If pList==0, it means this routine was called to make a primary
3079 ** key out of the last column added to the table under construction.
3080 ** So create a fake list to simulate this.
3082 if( pList==0 ){
3083 Token prevCol;
3084 sqlite3TokenInit(&prevCol, pTab->aCol[pTab->nCol-1].zName);
3085 pList = sqlite3ExprListAppend(pParse, 0,
3086 sqlite3ExprAlloc(db, TK_ID, &prevCol, 0));
3087 if( pList==0 ) goto exit_create_index;
3088 assert( pList->nExpr==1 );
3089 sqlite3ExprListSetSortOrder(pList, sortOrder);
3090 }else{
3091 sqlite3ExprListCheckLength(pParse, pList, "index");
3094 /* Figure out how many bytes of space are required to store explicitly
3095 ** specified collation sequence names.
3097 for(i=0; i<pList->nExpr; i++){
3098 Expr *pExpr = pList->a[i].pExpr;
3099 assert( pExpr!=0 );
3100 if( pExpr->op==TK_COLLATE ){
3101 nExtra += (1 + sqlite3Strlen30(pExpr->u.zToken));
3106 ** Allocate the index structure.
3108 nName = sqlite3Strlen30(zName);
3109 nExtraCol = pPk ? pPk->nKeyCol : 1;
3110 pIndex = sqlite3AllocateIndexObject(db, pList->nExpr + nExtraCol,
3111 nName + nExtra + 1, &zExtra);
3112 if( db->mallocFailed ){
3113 goto exit_create_index;
3115 assert( EIGHT_BYTE_ALIGNMENT(pIndex->aiRowLogEst) );
3116 assert( EIGHT_BYTE_ALIGNMENT(pIndex->azColl) );
3117 pIndex->zName = zExtra;
3118 zExtra += nName + 1;
3119 memcpy(pIndex->zName, zName, nName+1);
3120 pIndex->pTable = pTab;
3121 pIndex->onError = (u8)onError;
3122 pIndex->uniqNotNull = onError!=OE_None;
3123 pIndex->idxType = idxType;
3124 pIndex->pSchema = db->aDb[iDb].pSchema;
3125 pIndex->nKeyCol = pList->nExpr;
3126 if( pPIWhere ){
3127 sqlite3ResolveSelfReference(pParse, pTab, NC_PartIdx, pPIWhere, 0);
3128 pIndex->pPartIdxWhere = pPIWhere;
3129 pPIWhere = 0;
3131 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
3133 /* Check to see if we should honor DESC requests on index columns
3135 if( pDb->pSchema->file_format>=4 ){
3136 sortOrderMask = -1; /* Honor DESC */
3137 }else{
3138 sortOrderMask = 0; /* Ignore DESC */
3141 /* Analyze the list of expressions that form the terms of the index and
3142 ** report any errors. In the common case where the expression is exactly
3143 ** a table column, store that column in aiColumn[]. For general expressions,
3144 ** populate pIndex->aColExpr and store XN_EXPR (-2) in aiColumn[].
3146 ** TODO: Issue a warning if two or more columns of the index are identical.
3147 ** TODO: Issue a warning if the table primary key is used as part of the
3148 ** index key.
3150 for(i=0, pListItem=pList->a; i<pList->nExpr; i++, pListItem++){
3151 Expr *pCExpr; /* The i-th index expression */
3152 int requestedSortOrder; /* ASC or DESC on the i-th expression */
3153 const char *zColl; /* Collation sequence name */
3155 sqlite3StringToId(pListItem->pExpr);
3156 sqlite3ResolveSelfReference(pParse, pTab, NC_IdxExpr, pListItem->pExpr, 0);
3157 if( pParse->nErr ) goto exit_create_index;
3158 pCExpr = sqlite3ExprSkipCollate(pListItem->pExpr);
3159 if( pCExpr->op!=TK_COLUMN ){
3160 if( pTab==pParse->pNewTable ){
3161 sqlite3ErrorMsg(pParse, "expressions prohibited in PRIMARY KEY and "
3162 "UNIQUE constraints");
3163 goto exit_create_index;
3165 if( pIndex->aColExpr==0 ){
3166 ExprList *pCopy = sqlite3ExprListDup(db, pList, 0);
3167 pIndex->aColExpr = pCopy;
3168 if( !db->mallocFailed ){
3169 assert( pCopy!=0 );
3170 pListItem = &pCopy->a[i];
3173 j = XN_EXPR;
3174 pIndex->aiColumn[i] = XN_EXPR;
3175 pIndex->uniqNotNull = 0;
3176 }else{
3177 j = pCExpr->iColumn;
3178 assert( j<=0x7fff );
3179 if( j<0 ){
3180 j = pTab->iPKey;
3181 }else if( pTab->aCol[j].notNull==0 ){
3182 pIndex->uniqNotNull = 0;
3184 pIndex->aiColumn[i] = (i16)j;
3186 zColl = 0;
3187 if( pListItem->pExpr->op==TK_COLLATE ){
3188 int nColl;
3189 zColl = pListItem->pExpr->u.zToken;
3190 nColl = sqlite3Strlen30(zColl) + 1;
3191 assert( nExtra>=nColl );
3192 memcpy(zExtra, zColl, nColl);
3193 zColl = zExtra;
3194 zExtra += nColl;
3195 nExtra -= nColl;
3196 }else if( j>=0 ){
3197 zColl = pTab->aCol[j].zColl;
3199 if( !zColl ) zColl = sqlite3StrBINARY;
3200 if( !db->init.busy && !sqlite3LocateCollSeq(pParse, zColl) ){
3201 goto exit_create_index;
3203 pIndex->azColl[i] = zColl;
3204 requestedSortOrder = pListItem->sortOrder & sortOrderMask;
3205 pIndex->aSortOrder[i] = (u8)requestedSortOrder;
3208 /* Append the table key to the end of the index. For WITHOUT ROWID
3209 ** tables (when pPk!=0) this will be the declared PRIMARY KEY. For
3210 ** normal tables (when pPk==0) this will be the rowid.
3212 if( pPk ){
3213 for(j=0; j<pPk->nKeyCol; j++){
3214 int x = pPk->aiColumn[j];
3215 assert( x>=0 );
3216 if( hasColumn(pIndex->aiColumn, pIndex->nKeyCol, x) ){
3217 pIndex->nColumn--;
3218 }else{
3219 pIndex->aiColumn[i] = x;
3220 pIndex->azColl[i] = pPk->azColl[j];
3221 pIndex->aSortOrder[i] = pPk->aSortOrder[j];
3222 i++;
3225 assert( i==pIndex->nColumn );
3226 }else{
3227 pIndex->aiColumn[i] = XN_ROWID;
3228 pIndex->azColl[i] = sqlite3StrBINARY;
3230 sqlite3DefaultRowEst(pIndex);
3231 if( pParse->pNewTable==0 ) estimateIndexWidth(pIndex);
3233 /* If this index contains every column of its table, then mark
3234 ** it as a covering index */
3235 assert( HasRowid(pTab)
3236 || pTab->iPKey<0 || sqlite3ColumnOfIndex(pIndex, pTab->iPKey)>=0 );
3237 if( pTblName!=0 && pIndex->nColumn>=pTab->nCol ){
3238 pIndex->isCovering = 1;
3239 for(j=0; j<pTab->nCol; j++){
3240 if( j==pTab->iPKey ) continue;
3241 if( sqlite3ColumnOfIndex(pIndex,j)>=0 ) continue;
3242 pIndex->isCovering = 0;
3243 break;
3247 if( pTab==pParse->pNewTable ){
3248 /* This routine has been called to create an automatic index as a
3249 ** result of a PRIMARY KEY or UNIQUE clause on a column definition, or
3250 ** a PRIMARY KEY or UNIQUE clause following the column definitions.
3251 ** i.e. one of:
3253 ** CREATE TABLE t(x PRIMARY KEY, y);
3254 ** CREATE TABLE t(x, y, UNIQUE(x, y));
3256 ** Either way, check to see if the table already has such an index. If
3257 ** so, don't bother creating this one. This only applies to
3258 ** automatically created indices. Users can do as they wish with
3259 ** explicit indices.
3261 ** Two UNIQUE or PRIMARY KEY constraints are considered equivalent
3262 ** (and thus suppressing the second one) even if they have different
3263 ** sort orders.
3265 ** If there are different collating sequences or if the columns of
3266 ** the constraint occur in different orders, then the constraints are
3267 ** considered distinct and both result in separate indices.
3269 Index *pIdx;
3270 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
3271 int k;
3272 assert( IsUniqueIndex(pIdx) );
3273 assert( pIdx->idxType!=SQLITE_IDXTYPE_APPDEF );
3274 assert( IsUniqueIndex(pIndex) );
3276 if( pIdx->nKeyCol!=pIndex->nKeyCol ) continue;
3277 for(k=0; k<pIdx->nKeyCol; k++){
3278 const char *z1;
3279 const char *z2;
3280 assert( pIdx->aiColumn[k]>=0 );
3281 if( pIdx->aiColumn[k]!=pIndex->aiColumn[k] ) break;
3282 z1 = pIdx->azColl[k];
3283 z2 = pIndex->azColl[k];
3284 if( sqlite3StrICmp(z1, z2) ) break;
3286 if( k==pIdx->nKeyCol ){
3287 if( pIdx->onError!=pIndex->onError ){
3288 /* This constraint creates the same index as a previous
3289 ** constraint specified somewhere in the CREATE TABLE statement.
3290 ** However the ON CONFLICT clauses are different. If both this
3291 ** constraint and the previous equivalent constraint have explicit
3292 ** ON CONFLICT clauses this is an error. Otherwise, use the
3293 ** explicitly specified behavior for the index.
3295 if( !(pIdx->onError==OE_Default || pIndex->onError==OE_Default) ){
3296 sqlite3ErrorMsg(pParse,
3297 "conflicting ON CONFLICT clauses specified", 0);
3299 if( pIdx->onError==OE_Default ){
3300 pIdx->onError = pIndex->onError;
3303 if( idxType==SQLITE_IDXTYPE_PRIMARYKEY ) pIdx->idxType = idxType;
3304 goto exit_create_index;
3309 /* Link the new Index structure to its table and to the other
3310 ** in-memory database structures.
3312 assert( pParse->nErr==0 );
3313 if( db->init.busy ){
3314 Index *p;
3315 assert( !IN_DECLARE_VTAB );
3316 assert( sqlite3SchemaMutexHeld(db, 0, pIndex->pSchema) );
3317 p = sqlite3HashInsert(&pIndex->pSchema->idxHash,
3318 pIndex->zName, pIndex);
3319 if( p ){
3320 assert( p==pIndex ); /* Malloc must have failed */
3321 sqlite3OomFault(db);
3322 goto exit_create_index;
3324 db->mDbFlags |= DBFLAG_SchemaChange;
3325 if( pTblName!=0 ){
3326 pIndex->tnum = db->init.newTnum;
3330 /* If this is the initial CREATE INDEX statement (or CREATE TABLE if the
3331 ** index is an implied index for a UNIQUE or PRIMARY KEY constraint) then
3332 ** emit code to allocate the index rootpage on disk and make an entry for
3333 ** the index in the sqlite_master table and populate the index with
3334 ** content. But, do not do this if we are simply reading the sqlite_master
3335 ** table to parse the schema, or if this index is the PRIMARY KEY index
3336 ** of a WITHOUT ROWID table.
3338 ** If pTblName==0 it means this index is generated as an implied PRIMARY KEY
3339 ** or UNIQUE index in a CREATE TABLE statement. Since the table
3340 ** has just been created, it contains no data and the index initialization
3341 ** step can be skipped.
3343 else if( HasRowid(pTab) || pTblName!=0 ){
3344 Vdbe *v;
3345 char *zStmt;
3346 int iMem = ++pParse->nMem;
3348 v = sqlite3GetVdbe(pParse);
3349 if( v==0 ) goto exit_create_index;
3351 sqlite3BeginWriteOperation(pParse, 1, iDb);
3353 /* Create the rootpage for the index using CreateIndex. But before
3354 ** doing so, code a Noop instruction and store its address in
3355 ** Index.tnum. This is required in case this index is actually a
3356 ** PRIMARY KEY and the table is actually a WITHOUT ROWID table. In
3357 ** that case the convertToWithoutRowidTable() routine will replace
3358 ** the Noop with a Goto to jump over the VDBE code generated below. */
3359 pIndex->tnum = sqlite3VdbeAddOp0(v, OP_Noop);
3360 sqlite3VdbeAddOp3(v, OP_CreateBtree, iDb, iMem, BTREE_BLOBKEY);
3362 /* Gather the complete text of the CREATE INDEX statement into
3363 ** the zStmt variable
3365 if( pStart ){
3366 int n = (int)(pParse->sLastToken.z - pName->z) + pParse->sLastToken.n;
3367 if( pName->z[n-1]==';' ) n--;
3368 /* A named index with an explicit CREATE INDEX statement */
3369 zStmt = sqlite3MPrintf(db, "CREATE%s INDEX %.*s",
3370 onError==OE_None ? "" : " UNIQUE", n, pName->z);
3371 }else{
3372 /* An automatic index created by a PRIMARY KEY or UNIQUE constraint */
3373 /* zStmt = sqlite3MPrintf(""); */
3374 zStmt = 0;
3377 /* Add an entry in sqlite_master for this index
3379 sqlite3NestedParse(pParse,
3380 "INSERT INTO %Q.%s VALUES('index',%Q,%Q,#%d,%Q);",
3381 db->aDb[iDb].zDbSName, MASTER_NAME,
3382 pIndex->zName,
3383 pTab->zName,
3384 iMem,
3385 zStmt
3387 sqlite3DbFree(db, zStmt);
3389 /* Fill the index with data and reparse the schema. Code an OP_Expire
3390 ** to invalidate all pre-compiled statements.
3392 if( pTblName ){
3393 sqlite3RefillIndex(pParse, pIndex, iMem);
3394 sqlite3ChangeCookie(pParse, iDb);
3395 sqlite3VdbeAddParseSchemaOp(v, iDb,
3396 sqlite3MPrintf(db, "name='%q' AND type='index'", pIndex->zName));
3397 sqlite3VdbeAddOp0(v, OP_Expire);
3400 sqlite3VdbeJumpHere(v, pIndex->tnum);
3403 /* When adding an index to the list of indices for a table, make
3404 ** sure all indices labeled OE_Replace come after all those labeled
3405 ** OE_Ignore. This is necessary for the correct constraint check
3406 ** processing (in sqlite3GenerateConstraintChecks()) as part of
3407 ** UPDATE and INSERT statements.
3409 if( db->init.busy || pTblName==0 ){
3410 if( onError!=OE_Replace || pTab->pIndex==0
3411 || pTab->pIndex->onError==OE_Replace){
3412 pIndex->pNext = pTab->pIndex;
3413 pTab->pIndex = pIndex;
3414 }else{
3415 Index *pOther = pTab->pIndex;
3416 while( pOther->pNext && pOther->pNext->onError!=OE_Replace ){
3417 pOther = pOther->pNext;
3419 pIndex->pNext = pOther->pNext;
3420 pOther->pNext = pIndex;
3422 pIndex = 0;
3425 /* Clean up before exiting */
3426 exit_create_index:
3427 if( pIndex ) freeIndex(db, pIndex);
3428 sqlite3ExprDelete(db, pPIWhere);
3429 sqlite3ExprListDelete(db, pList);
3430 sqlite3SrcListDelete(db, pTblName);
3431 sqlite3DbFree(db, zName);
3435 ** Fill the Index.aiRowEst[] array with default information - information
3436 ** to be used when we have not run the ANALYZE command.
3438 ** aiRowEst[0] is supposed to contain the number of elements in the index.
3439 ** Since we do not know, guess 1 million. aiRowEst[1] is an estimate of the
3440 ** number of rows in the table that match any particular value of the
3441 ** first column of the index. aiRowEst[2] is an estimate of the number
3442 ** of rows that match any particular combination of the first 2 columns
3443 ** of the index. And so forth. It must always be the case that
3445 ** aiRowEst[N]<=aiRowEst[N-1]
3446 ** aiRowEst[N]>=1
3448 ** Apart from that, we have little to go on besides intuition as to
3449 ** how aiRowEst[] should be initialized. The numbers generated here
3450 ** are based on typical values found in actual indices.
3452 void sqlite3DefaultRowEst(Index *pIdx){
3453 /* 10, 9, 8, 7, 6 */
3454 LogEst aVal[] = { 33, 32, 30, 28, 26 };
3455 LogEst *a = pIdx->aiRowLogEst;
3456 int nCopy = MIN(ArraySize(aVal), pIdx->nKeyCol);
3457 int i;
3459 /* Indexes with default row estimates should not have stat1 data */
3460 assert( !pIdx->hasStat1 );
3462 /* Set the first entry (number of rows in the index) to the estimated
3463 ** number of rows in the table, or half the number of rows in the table
3464 ** for a partial index. But do not let the estimate drop below 10. */
3465 a[0] = pIdx->pTable->nRowLogEst;
3466 if( pIdx->pPartIdxWhere!=0 ) a[0] -= 10; assert( 10==sqlite3LogEst(2) );
3467 if( a[0]<33 ) a[0] = 33; assert( 33==sqlite3LogEst(10) );
3469 /* Estimate that a[1] is 10, a[2] is 9, a[3] is 8, a[4] is 7, a[5] is
3470 ** 6 and each subsequent value (if any) is 5. */
3471 memcpy(&a[1], aVal, nCopy*sizeof(LogEst));
3472 for(i=nCopy+1; i<=pIdx->nKeyCol; i++){
3473 a[i] = 23; assert( 23==sqlite3LogEst(5) );
3476 assert( 0==sqlite3LogEst(1) );
3477 if( IsUniqueIndex(pIdx) ) a[pIdx->nKeyCol] = 0;
3481 ** This routine will drop an existing named index. This routine
3482 ** implements the DROP INDEX statement.
3484 void sqlite3DropIndex(Parse *pParse, SrcList *pName, int ifExists){
3485 Index *pIndex;
3486 Vdbe *v;
3487 sqlite3 *db = pParse->db;
3488 int iDb;
3490 assert( pParse->nErr==0 ); /* Never called with prior errors */
3491 if( db->mallocFailed ){
3492 goto exit_drop_index;
3494 assert( pName->nSrc==1 );
3495 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
3496 goto exit_drop_index;
3498 pIndex = sqlite3FindIndex(db, pName->a[0].zName, pName->a[0].zDatabase);
3499 if( pIndex==0 ){
3500 if( !ifExists ){
3501 sqlite3ErrorMsg(pParse, "no such index: %S", pName, 0);
3502 }else{
3503 sqlite3CodeVerifyNamedSchema(pParse, pName->a[0].zDatabase);
3505 pParse->checkSchema = 1;
3506 goto exit_drop_index;
3508 if( pIndex->idxType!=SQLITE_IDXTYPE_APPDEF ){
3509 sqlite3ErrorMsg(pParse, "index associated with UNIQUE "
3510 "or PRIMARY KEY constraint cannot be dropped", 0);
3511 goto exit_drop_index;
3513 iDb = sqlite3SchemaToIndex(db, pIndex->pSchema);
3514 #ifndef SQLITE_OMIT_AUTHORIZATION
3516 int code = SQLITE_DROP_INDEX;
3517 Table *pTab = pIndex->pTable;
3518 const char *zDb = db->aDb[iDb].zDbSName;
3519 const char *zTab = SCHEMA_TABLE(iDb);
3520 if( sqlite3AuthCheck(pParse, SQLITE_DELETE, zTab, 0, zDb) ){
3521 goto exit_drop_index;
3523 if( !OMIT_TEMPDB && iDb ) code = SQLITE_DROP_TEMP_INDEX;
3524 if( sqlite3AuthCheck(pParse, code, pIndex->zName, pTab->zName, zDb) ){
3525 goto exit_drop_index;
3528 #endif
3530 /* Generate code to remove the index and from the master table */
3531 v = sqlite3GetVdbe(pParse);
3532 if( v ){
3533 sqlite3BeginWriteOperation(pParse, 1, iDb);
3534 sqlite3NestedParse(pParse,
3535 "DELETE FROM %Q.%s WHERE name=%Q AND type='index'",
3536 db->aDb[iDb].zDbSName, MASTER_NAME, pIndex->zName
3538 sqlite3ClearStatTables(pParse, iDb, "idx", pIndex->zName);
3539 sqlite3ChangeCookie(pParse, iDb);
3540 destroyRootPage(pParse, pIndex->tnum, iDb);
3541 sqlite3VdbeAddOp4(v, OP_DropIndex, iDb, 0, 0, pIndex->zName, 0);
3544 exit_drop_index:
3545 sqlite3SrcListDelete(db, pName);
3549 ** pArray is a pointer to an array of objects. Each object in the
3550 ** array is szEntry bytes in size. This routine uses sqlite3DbRealloc()
3551 ** to extend the array so that there is space for a new object at the end.
3553 ** When this function is called, *pnEntry contains the current size of
3554 ** the array (in entries - so the allocation is ((*pnEntry) * szEntry) bytes
3555 ** in total).
3557 ** If the realloc() is successful (i.e. if no OOM condition occurs), the
3558 ** space allocated for the new object is zeroed, *pnEntry updated to
3559 ** reflect the new size of the array and a pointer to the new allocation
3560 ** returned. *pIdx is set to the index of the new array entry in this case.
3562 ** Otherwise, if the realloc() fails, *pIdx is set to -1, *pnEntry remains
3563 ** unchanged and a copy of pArray returned.
3565 void *sqlite3ArrayAllocate(
3566 sqlite3 *db, /* Connection to notify of malloc failures */
3567 void *pArray, /* Array of objects. Might be reallocated */
3568 int szEntry, /* Size of each object in the array */
3569 int *pnEntry, /* Number of objects currently in use */
3570 int *pIdx /* Write the index of a new slot here */
3572 char *z;
3573 int n = *pnEntry;
3574 if( (n & (n-1))==0 ){
3575 int sz = (n==0) ? 1 : 2*n;
3576 void *pNew = sqlite3DbRealloc(db, pArray, sz*szEntry);
3577 if( pNew==0 ){
3578 *pIdx = -1;
3579 return pArray;
3581 pArray = pNew;
3583 z = (char*)pArray;
3584 memset(&z[n * szEntry], 0, szEntry);
3585 *pIdx = n;
3586 ++*pnEntry;
3587 return pArray;
3591 ** Append a new element to the given IdList. Create a new IdList if
3592 ** need be.
3594 ** A new IdList is returned, or NULL if malloc() fails.
3596 IdList *sqlite3IdListAppend(sqlite3 *db, IdList *pList, Token *pToken){
3597 int i;
3598 if( pList==0 ){
3599 pList = sqlite3DbMallocZero(db, sizeof(IdList) );
3600 if( pList==0 ) return 0;
3602 pList->a = sqlite3ArrayAllocate(
3604 pList->a,
3605 sizeof(pList->a[0]),
3606 &pList->nId,
3609 if( i<0 ){
3610 sqlite3IdListDelete(db, pList);
3611 return 0;
3613 pList->a[i].zName = sqlite3NameFromToken(db, pToken);
3614 return pList;
3618 ** Delete an IdList.
3620 void sqlite3IdListDelete(sqlite3 *db, IdList *pList){
3621 int i;
3622 if( pList==0 ) return;
3623 for(i=0; i<pList->nId; i++){
3624 sqlite3DbFree(db, pList->a[i].zName);
3626 sqlite3DbFree(db, pList->a);
3627 sqlite3DbFreeNN(db, pList);
3631 ** Return the index in pList of the identifier named zId. Return -1
3632 ** if not found.
3634 int sqlite3IdListIndex(IdList *pList, const char *zName){
3635 int i;
3636 if( pList==0 ) return -1;
3637 for(i=0; i<pList->nId; i++){
3638 if( sqlite3StrICmp(pList->a[i].zName, zName)==0 ) return i;
3640 return -1;
3644 ** Expand the space allocated for the given SrcList object by
3645 ** creating nExtra new slots beginning at iStart. iStart is zero based.
3646 ** New slots are zeroed.
3648 ** For example, suppose a SrcList initially contains two entries: A,B.
3649 ** To append 3 new entries onto the end, do this:
3651 ** sqlite3SrcListEnlarge(db, pSrclist, 3, 2);
3653 ** After the call above it would contain: A, B, nil, nil, nil.
3654 ** If the iStart argument had been 1 instead of 2, then the result
3655 ** would have been: A, nil, nil, nil, B. To prepend the new slots,
3656 ** the iStart value would be 0. The result then would
3657 ** be: nil, nil, nil, A, B.
3659 ** If a memory allocation fails the SrcList is unchanged. The
3660 ** db->mallocFailed flag will be set to true.
3662 SrcList *sqlite3SrcListEnlarge(
3663 sqlite3 *db, /* Database connection to notify of OOM errors */
3664 SrcList *pSrc, /* The SrcList to be enlarged */
3665 int nExtra, /* Number of new slots to add to pSrc->a[] */
3666 int iStart /* Index in pSrc->a[] of first new slot */
3668 int i;
3670 /* Sanity checking on calling parameters */
3671 assert( iStart>=0 );
3672 assert( nExtra>=1 );
3673 assert( pSrc!=0 );
3674 assert( iStart<=pSrc->nSrc );
3676 /* Allocate additional space if needed */
3677 if( (u32)pSrc->nSrc+nExtra>pSrc->nAlloc ){
3678 SrcList *pNew;
3679 int nAlloc = pSrc->nSrc*2+nExtra;
3680 int nGot;
3681 pNew = sqlite3DbRealloc(db, pSrc,
3682 sizeof(*pSrc) + (nAlloc-1)*sizeof(pSrc->a[0]) );
3683 if( pNew==0 ){
3684 assert( db->mallocFailed );
3685 return pSrc;
3687 pSrc = pNew;
3688 nGot = (sqlite3DbMallocSize(db, pNew) - sizeof(*pSrc))/sizeof(pSrc->a[0])+1;
3689 pSrc->nAlloc = nGot;
3692 /* Move existing slots that come after the newly inserted slots
3693 ** out of the way */
3694 for(i=pSrc->nSrc-1; i>=iStart; i--){
3695 pSrc->a[i+nExtra] = pSrc->a[i];
3697 pSrc->nSrc += nExtra;
3699 /* Zero the newly allocated slots */
3700 memset(&pSrc->a[iStart], 0, sizeof(pSrc->a[0])*nExtra);
3701 for(i=iStart; i<iStart+nExtra; i++){
3702 pSrc->a[i].iCursor = -1;
3705 /* Return a pointer to the enlarged SrcList */
3706 return pSrc;
3711 ** Append a new table name to the given SrcList. Create a new SrcList if
3712 ** need be. A new entry is created in the SrcList even if pTable is NULL.
3714 ** A SrcList is returned, or NULL if there is an OOM error. The returned
3715 ** SrcList might be the same as the SrcList that was input or it might be
3716 ** a new one. If an OOM error does occurs, then the prior value of pList
3717 ** that is input to this routine is automatically freed.
3719 ** If pDatabase is not null, it means that the table has an optional
3720 ** database name prefix. Like this: "database.table". The pDatabase
3721 ** points to the table name and the pTable points to the database name.
3722 ** The SrcList.a[].zName field is filled with the table name which might
3723 ** come from pTable (if pDatabase is NULL) or from pDatabase.
3724 ** SrcList.a[].zDatabase is filled with the database name from pTable,
3725 ** or with NULL if no database is specified.
3727 ** In other words, if call like this:
3729 ** sqlite3SrcListAppend(D,A,B,0);
3731 ** Then B is a table name and the database name is unspecified. If called
3732 ** like this:
3734 ** sqlite3SrcListAppend(D,A,B,C);
3736 ** Then C is the table name and B is the database name. If C is defined
3737 ** then so is B. In other words, we never have a case where:
3739 ** sqlite3SrcListAppend(D,A,0,C);
3741 ** Both pTable and pDatabase are assumed to be quoted. They are dequoted
3742 ** before being added to the SrcList.
3744 SrcList *sqlite3SrcListAppend(
3745 sqlite3 *db, /* Connection to notify of malloc failures */
3746 SrcList *pList, /* Append to this SrcList. NULL creates a new SrcList */
3747 Token *pTable, /* Table to append */
3748 Token *pDatabase /* Database of the table */
3750 struct SrcList_item *pItem;
3751 assert( pDatabase==0 || pTable!=0 ); /* Cannot have C without B */
3752 assert( db!=0 );
3753 if( pList==0 ){
3754 pList = sqlite3DbMallocRawNN(db, sizeof(SrcList) );
3755 if( pList==0 ) return 0;
3756 pList->nAlloc = 1;
3757 pList->nSrc = 1;
3758 memset(&pList->a[0], 0, sizeof(pList->a[0]));
3759 pList->a[0].iCursor = -1;
3760 }else{
3761 pList = sqlite3SrcListEnlarge(db, pList, 1, pList->nSrc);
3763 if( db->mallocFailed ){
3764 sqlite3SrcListDelete(db, pList);
3765 return 0;
3767 pItem = &pList->a[pList->nSrc-1];
3768 if( pDatabase && pDatabase->z==0 ){
3769 pDatabase = 0;
3771 if( pDatabase ){
3772 pItem->zName = sqlite3NameFromToken(db, pDatabase);
3773 pItem->zDatabase = sqlite3NameFromToken(db, pTable);
3774 }else{
3775 pItem->zName = sqlite3NameFromToken(db, pTable);
3776 pItem->zDatabase = 0;
3778 return pList;
3782 ** Assign VdbeCursor index numbers to all tables in a SrcList
3784 void sqlite3SrcListAssignCursors(Parse *pParse, SrcList *pList){
3785 int i;
3786 struct SrcList_item *pItem;
3787 assert(pList || pParse->db->mallocFailed );
3788 if( pList ){
3789 for(i=0, pItem=pList->a; i<pList->nSrc; i++, pItem++){
3790 if( pItem->iCursor>=0 ) break;
3791 pItem->iCursor = pParse->nTab++;
3792 if( pItem->pSelect ){
3793 sqlite3SrcListAssignCursors(pParse, pItem->pSelect->pSrc);
3800 ** Delete an entire SrcList including all its substructure.
3802 void sqlite3SrcListDelete(sqlite3 *db, SrcList *pList){
3803 int i;
3804 struct SrcList_item *pItem;
3805 if( pList==0 ) return;
3806 for(pItem=pList->a, i=0; i<pList->nSrc; i++, pItem++){
3807 sqlite3DbFree(db, pItem->zDatabase);
3808 sqlite3DbFree(db, pItem->zName);
3809 sqlite3DbFree(db, pItem->zAlias);
3810 if( pItem->fg.isIndexedBy ) sqlite3DbFree(db, pItem->u1.zIndexedBy);
3811 if( pItem->fg.isTabFunc ) sqlite3ExprListDelete(db, pItem->u1.pFuncArg);
3812 sqlite3DeleteTable(db, pItem->pTab);
3813 sqlite3SelectDelete(db, pItem->pSelect);
3814 sqlite3ExprDelete(db, pItem->pOn);
3815 sqlite3IdListDelete(db, pItem->pUsing);
3817 sqlite3DbFreeNN(db, pList);
3821 ** This routine is called by the parser to add a new term to the
3822 ** end of a growing FROM clause. The "p" parameter is the part of
3823 ** the FROM clause that has already been constructed. "p" is NULL
3824 ** if this is the first term of the FROM clause. pTable and pDatabase
3825 ** are the name of the table and database named in the FROM clause term.
3826 ** pDatabase is NULL if the database name qualifier is missing - the
3827 ** usual case. If the term has an alias, then pAlias points to the
3828 ** alias token. If the term is a subquery, then pSubquery is the
3829 ** SELECT statement that the subquery encodes. The pTable and
3830 ** pDatabase parameters are NULL for subqueries. The pOn and pUsing
3831 ** parameters are the content of the ON and USING clauses.
3833 ** Return a new SrcList which encodes is the FROM with the new
3834 ** term added.
3836 SrcList *sqlite3SrcListAppendFromTerm(
3837 Parse *pParse, /* Parsing context */
3838 SrcList *p, /* The left part of the FROM clause already seen */
3839 Token *pTable, /* Name of the table to add to the FROM clause */
3840 Token *pDatabase, /* Name of the database containing pTable */
3841 Token *pAlias, /* The right-hand side of the AS subexpression */
3842 Select *pSubquery, /* A subquery used in place of a table name */
3843 Expr *pOn, /* The ON clause of a join */
3844 IdList *pUsing /* The USING clause of a join */
3846 struct SrcList_item *pItem;
3847 sqlite3 *db = pParse->db;
3848 if( !p && (pOn || pUsing) ){
3849 sqlite3ErrorMsg(pParse, "a JOIN clause is required before %s",
3850 (pOn ? "ON" : "USING")
3852 goto append_from_error;
3854 p = sqlite3SrcListAppend(db, p, pTable, pDatabase);
3855 if( p==0 ){
3856 goto append_from_error;
3858 assert( p->nSrc>0 );
3859 pItem = &p->a[p->nSrc-1];
3860 assert( pAlias!=0 );
3861 if( pAlias->n ){
3862 pItem->zAlias = sqlite3NameFromToken(db, pAlias);
3864 pItem->pSelect = pSubquery;
3865 pItem->pOn = pOn;
3866 pItem->pUsing = pUsing;
3867 return p;
3869 append_from_error:
3870 assert( p==0 );
3871 sqlite3ExprDelete(db, pOn);
3872 sqlite3IdListDelete(db, pUsing);
3873 sqlite3SelectDelete(db, pSubquery);
3874 return 0;
3878 ** Add an INDEXED BY or NOT INDEXED clause to the most recently added
3879 ** element of the source-list passed as the second argument.
3881 void sqlite3SrcListIndexedBy(Parse *pParse, SrcList *p, Token *pIndexedBy){
3882 assert( pIndexedBy!=0 );
3883 if( p && pIndexedBy->n>0 ){
3884 struct SrcList_item *pItem;
3885 assert( p->nSrc>0 );
3886 pItem = &p->a[p->nSrc-1];
3887 assert( pItem->fg.notIndexed==0 );
3888 assert( pItem->fg.isIndexedBy==0 );
3889 assert( pItem->fg.isTabFunc==0 );
3890 if( pIndexedBy->n==1 && !pIndexedBy->z ){
3891 /* A "NOT INDEXED" clause was supplied. See parse.y
3892 ** construct "indexed_opt" for details. */
3893 pItem->fg.notIndexed = 1;
3894 }else{
3895 pItem->u1.zIndexedBy = sqlite3NameFromToken(pParse->db, pIndexedBy);
3896 pItem->fg.isIndexedBy = 1;
3902 ** Add the list of function arguments to the SrcList entry for a
3903 ** table-valued-function.
3905 void sqlite3SrcListFuncArgs(Parse *pParse, SrcList *p, ExprList *pList){
3906 if( p ){
3907 struct SrcList_item *pItem = &p->a[p->nSrc-1];
3908 assert( pItem->fg.notIndexed==0 );
3909 assert( pItem->fg.isIndexedBy==0 );
3910 assert( pItem->fg.isTabFunc==0 );
3911 pItem->u1.pFuncArg = pList;
3912 pItem->fg.isTabFunc = 1;
3913 }else{
3914 sqlite3ExprListDelete(pParse->db, pList);
3919 ** When building up a FROM clause in the parser, the join operator
3920 ** is initially attached to the left operand. But the code generator
3921 ** expects the join operator to be on the right operand. This routine
3922 ** Shifts all join operators from left to right for an entire FROM
3923 ** clause.
3925 ** Example: Suppose the join is like this:
3927 ** A natural cross join B
3929 ** The operator is "natural cross join". The A and B operands are stored
3930 ** in p->a[0] and p->a[1], respectively. The parser initially stores the
3931 ** operator with A. This routine shifts that operator over to B.
3933 void sqlite3SrcListShiftJoinType(SrcList *p){
3934 if( p ){
3935 int i;
3936 for(i=p->nSrc-1; i>0; i--){
3937 p->a[i].fg.jointype = p->a[i-1].fg.jointype;
3939 p->a[0].fg.jointype = 0;
3944 ** Generate VDBE code for a BEGIN statement.
3946 void sqlite3BeginTransaction(Parse *pParse, int type){
3947 sqlite3 *db;
3948 Vdbe *v;
3949 int i;
3951 assert( pParse!=0 );
3952 db = pParse->db;
3953 assert( db!=0 );
3954 if( sqlite3AuthCheck(pParse, SQLITE_TRANSACTION, "BEGIN", 0, 0) ){
3955 return;
3957 v = sqlite3GetVdbe(pParse);
3958 if( !v ) return;
3959 if( type!=TK_DEFERRED ){
3960 for(i=0; i<db->nDb; i++){
3961 sqlite3VdbeAddOp2(v, OP_Transaction, i, (type==TK_EXCLUSIVE)+1);
3962 sqlite3VdbeUsesBtree(v, i);
3965 sqlite3VdbeAddOp0(v, OP_AutoCommit);
3969 ** Generate VDBE code for a COMMIT or ROLLBACK statement.
3970 ** Code for ROLLBACK is generated if eType==TK_ROLLBACK. Otherwise
3971 ** code is generated for a COMMIT.
3973 void sqlite3EndTransaction(Parse *pParse, int eType){
3974 Vdbe *v;
3975 int isRollback;
3977 assert( pParse!=0 );
3978 assert( pParse->db!=0 );
3979 assert( eType==TK_COMMIT || eType==TK_END || eType==TK_ROLLBACK );
3980 isRollback = eType==TK_ROLLBACK;
3981 if( sqlite3AuthCheck(pParse, SQLITE_TRANSACTION,
3982 isRollback ? "ROLLBACK" : "COMMIT", 0, 0) ){
3983 return;
3985 v = sqlite3GetVdbe(pParse);
3986 if( v ){
3987 sqlite3VdbeAddOp2(v, OP_AutoCommit, 1, isRollback);
3992 ** This function is called by the parser when it parses a command to create,
3993 ** release or rollback an SQL savepoint.
3995 void sqlite3Savepoint(Parse *pParse, int op, Token *pName){
3996 char *zName = sqlite3NameFromToken(pParse->db, pName);
3997 if( zName ){
3998 Vdbe *v = sqlite3GetVdbe(pParse);
3999 #ifndef SQLITE_OMIT_AUTHORIZATION
4000 static const char * const az[] = { "BEGIN", "RELEASE", "ROLLBACK" };
4001 assert( !SAVEPOINT_BEGIN && SAVEPOINT_RELEASE==1 && SAVEPOINT_ROLLBACK==2 );
4002 #endif
4003 if( !v || sqlite3AuthCheck(pParse, SQLITE_SAVEPOINT, az[op], zName, 0) ){
4004 sqlite3DbFree(pParse->db, zName);
4005 return;
4007 sqlite3VdbeAddOp4(v, OP_Savepoint, op, 0, 0, zName, P4_DYNAMIC);
4012 ** Make sure the TEMP database is open and available for use. Return
4013 ** the number of errors. Leave any error messages in the pParse structure.
4015 int sqlite3OpenTempDatabase(Parse *pParse){
4016 sqlite3 *db = pParse->db;
4017 if( db->aDb[1].pBt==0 && !pParse->explain ){
4018 int rc;
4019 Btree *pBt;
4020 static const int flags =
4021 SQLITE_OPEN_READWRITE |
4022 SQLITE_OPEN_CREATE |
4023 SQLITE_OPEN_EXCLUSIVE |
4024 SQLITE_OPEN_DELETEONCLOSE |
4025 SQLITE_OPEN_TEMP_DB;
4027 rc = sqlite3BtreeOpen(db->pVfs, 0, db, &pBt, 0, flags);
4028 if( rc!=SQLITE_OK ){
4029 sqlite3ErrorMsg(pParse, "unable to open a temporary database "
4030 "file for storing temporary tables");
4031 pParse->rc = rc;
4032 return 1;
4034 db->aDb[1].pBt = pBt;
4035 assert( db->aDb[1].pSchema );
4036 if( SQLITE_NOMEM==sqlite3BtreeSetPageSize(pBt, db->nextPagesize, -1, 0) ){
4037 sqlite3OomFault(db);
4038 return 1;
4041 return 0;
4045 ** Record the fact that the schema cookie will need to be verified
4046 ** for database iDb. The code to actually verify the schema cookie
4047 ** will occur at the end of the top-level VDBE and will be generated
4048 ** later, by sqlite3FinishCoding().
4050 void sqlite3CodeVerifySchema(Parse *pParse, int iDb){
4051 Parse *pToplevel = sqlite3ParseToplevel(pParse);
4053 assert( iDb>=0 && iDb<pParse->db->nDb );
4054 assert( pParse->db->aDb[iDb].pBt!=0 || iDb==1 );
4055 assert( iDb<SQLITE_MAX_ATTACHED+2 );
4056 assert( sqlite3SchemaMutexHeld(pParse->db, iDb, 0) );
4057 if( DbMaskTest(pToplevel->cookieMask, iDb)==0 ){
4058 DbMaskSet(pToplevel->cookieMask, iDb);
4059 if( !OMIT_TEMPDB && iDb==1 ){
4060 sqlite3OpenTempDatabase(pToplevel);
4066 ** If argument zDb is NULL, then call sqlite3CodeVerifySchema() for each
4067 ** attached database. Otherwise, invoke it for the database named zDb only.
4069 void sqlite3CodeVerifyNamedSchema(Parse *pParse, const char *zDb){
4070 sqlite3 *db = pParse->db;
4071 int i;
4072 for(i=0; i<db->nDb; i++){
4073 Db *pDb = &db->aDb[i];
4074 if( pDb->pBt && (!zDb || 0==sqlite3StrICmp(zDb, pDb->zDbSName)) ){
4075 sqlite3CodeVerifySchema(pParse, i);
4081 ** Generate VDBE code that prepares for doing an operation that
4082 ** might change the database.
4084 ** This routine starts a new transaction if we are not already within
4085 ** a transaction. If we are already within a transaction, then a checkpoint
4086 ** is set if the setStatement parameter is true. A checkpoint should
4087 ** be set for operations that might fail (due to a constraint) part of
4088 ** the way through and which will need to undo some writes without having to
4089 ** rollback the whole transaction. For operations where all constraints
4090 ** can be checked before any changes are made to the database, it is never
4091 ** necessary to undo a write and the checkpoint should not be set.
4093 void sqlite3BeginWriteOperation(Parse *pParse, int setStatement, int iDb){
4094 Parse *pToplevel = sqlite3ParseToplevel(pParse);
4095 sqlite3CodeVerifySchema(pParse, iDb);
4096 DbMaskSet(pToplevel->writeMask, iDb);
4097 pToplevel->isMultiWrite |= setStatement;
4101 ** Indicate that the statement currently under construction might write
4102 ** more than one entry (example: deleting one row then inserting another,
4103 ** inserting multiple rows in a table, or inserting a row and index entries.)
4104 ** If an abort occurs after some of these writes have completed, then it will
4105 ** be necessary to undo the completed writes.
4107 void sqlite3MultiWrite(Parse *pParse){
4108 Parse *pToplevel = sqlite3ParseToplevel(pParse);
4109 pToplevel->isMultiWrite = 1;
4113 ** The code generator calls this routine if is discovers that it is
4114 ** possible to abort a statement prior to completion. In order to
4115 ** perform this abort without corrupting the database, we need to make
4116 ** sure that the statement is protected by a statement transaction.
4118 ** Technically, we only need to set the mayAbort flag if the
4119 ** isMultiWrite flag was previously set. There is a time dependency
4120 ** such that the abort must occur after the multiwrite. This makes
4121 ** some statements involving the REPLACE conflict resolution algorithm
4122 ** go a little faster. But taking advantage of this time dependency
4123 ** makes it more difficult to prove that the code is correct (in
4124 ** particular, it prevents us from writing an effective
4125 ** implementation of sqlite3AssertMayAbort()) and so we have chosen
4126 ** to take the safe route and skip the optimization.
4128 void sqlite3MayAbort(Parse *pParse){
4129 Parse *pToplevel = sqlite3ParseToplevel(pParse);
4130 pToplevel->mayAbort = 1;
4134 ** Code an OP_Halt that causes the vdbe to return an SQLITE_CONSTRAINT
4135 ** error. The onError parameter determines which (if any) of the statement
4136 ** and/or current transaction is rolled back.
4138 void sqlite3HaltConstraint(
4139 Parse *pParse, /* Parsing context */
4140 int errCode, /* extended error code */
4141 int onError, /* Constraint type */
4142 char *p4, /* Error message */
4143 i8 p4type, /* P4_STATIC or P4_TRANSIENT */
4144 u8 p5Errmsg /* P5_ErrMsg type */
4146 Vdbe *v = sqlite3GetVdbe(pParse);
4147 assert( (errCode&0xff)==SQLITE_CONSTRAINT );
4148 if( onError==OE_Abort ){
4149 sqlite3MayAbort(pParse);
4151 sqlite3VdbeAddOp4(v, OP_Halt, errCode, onError, 0, p4, p4type);
4152 sqlite3VdbeChangeP5(v, p5Errmsg);
4156 ** Code an OP_Halt due to UNIQUE or PRIMARY KEY constraint violation.
4158 void sqlite3UniqueConstraint(
4159 Parse *pParse, /* Parsing context */
4160 int onError, /* Constraint type */
4161 Index *pIdx /* The index that triggers the constraint */
4163 char *zErr;
4164 int j;
4165 StrAccum errMsg;
4166 Table *pTab = pIdx->pTable;
4168 sqlite3StrAccumInit(&errMsg, pParse->db, 0, 0, 200);
4169 if( pIdx->aColExpr ){
4170 sqlite3XPrintf(&errMsg, "index '%q'", pIdx->zName);
4171 }else{
4172 for(j=0; j<pIdx->nKeyCol; j++){
4173 char *zCol;
4174 assert( pIdx->aiColumn[j]>=0 );
4175 zCol = pTab->aCol[pIdx->aiColumn[j]].zName;
4176 if( j ) sqlite3StrAccumAppend(&errMsg, ", ", 2);
4177 sqlite3StrAccumAppendAll(&errMsg, pTab->zName);
4178 sqlite3StrAccumAppend(&errMsg, ".", 1);
4179 sqlite3StrAccumAppendAll(&errMsg, zCol);
4182 zErr = sqlite3StrAccumFinish(&errMsg);
4183 sqlite3HaltConstraint(pParse,
4184 IsPrimaryKeyIndex(pIdx) ? SQLITE_CONSTRAINT_PRIMARYKEY
4185 : SQLITE_CONSTRAINT_UNIQUE,
4186 onError, zErr, P4_DYNAMIC, P5_ConstraintUnique);
4191 ** Code an OP_Halt due to non-unique rowid.
4193 void sqlite3RowidConstraint(
4194 Parse *pParse, /* Parsing context */
4195 int onError, /* Conflict resolution algorithm */
4196 Table *pTab /* The table with the non-unique rowid */
4198 char *zMsg;
4199 int rc;
4200 if( pTab->iPKey>=0 ){
4201 zMsg = sqlite3MPrintf(pParse->db, "%s.%s", pTab->zName,
4202 pTab->aCol[pTab->iPKey].zName);
4203 rc = SQLITE_CONSTRAINT_PRIMARYKEY;
4204 }else{
4205 zMsg = sqlite3MPrintf(pParse->db, "%s.rowid", pTab->zName);
4206 rc = SQLITE_CONSTRAINT_ROWID;
4208 sqlite3HaltConstraint(pParse, rc, onError, zMsg, P4_DYNAMIC,
4209 P5_ConstraintUnique);
4213 ** Check to see if pIndex uses the collating sequence pColl. Return
4214 ** true if it does and false if it does not.
4216 #ifndef SQLITE_OMIT_REINDEX
4217 static int collationMatch(const char *zColl, Index *pIndex){
4218 int i;
4219 assert( zColl!=0 );
4220 for(i=0; i<pIndex->nColumn; i++){
4221 const char *z = pIndex->azColl[i];
4222 assert( z!=0 || pIndex->aiColumn[i]<0 );
4223 if( pIndex->aiColumn[i]>=0 && 0==sqlite3StrICmp(z, zColl) ){
4224 return 1;
4227 return 0;
4229 #endif
4232 ** Recompute all indices of pTab that use the collating sequence pColl.
4233 ** If pColl==0 then recompute all indices of pTab.
4235 #ifndef SQLITE_OMIT_REINDEX
4236 static void reindexTable(Parse *pParse, Table *pTab, char const *zColl){
4237 Index *pIndex; /* An index associated with pTab */
4239 for(pIndex=pTab->pIndex; pIndex; pIndex=pIndex->pNext){
4240 if( zColl==0 || collationMatch(zColl, pIndex) ){
4241 int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
4242 sqlite3BeginWriteOperation(pParse, 0, iDb);
4243 sqlite3RefillIndex(pParse, pIndex, -1);
4247 #endif
4250 ** Recompute all indices of all tables in all databases where the
4251 ** indices use the collating sequence pColl. If pColl==0 then recompute
4252 ** all indices everywhere.
4254 #ifndef SQLITE_OMIT_REINDEX
4255 static void reindexDatabases(Parse *pParse, char const *zColl){
4256 Db *pDb; /* A single database */
4257 int iDb; /* The database index number */
4258 sqlite3 *db = pParse->db; /* The database connection */
4259 HashElem *k; /* For looping over tables in pDb */
4260 Table *pTab; /* A table in the database */
4262 assert( sqlite3BtreeHoldsAllMutexes(db) ); /* Needed for schema access */
4263 for(iDb=0, pDb=db->aDb; iDb<db->nDb; iDb++, pDb++){
4264 assert( pDb!=0 );
4265 for(k=sqliteHashFirst(&pDb->pSchema->tblHash); k; k=sqliteHashNext(k)){
4266 pTab = (Table*)sqliteHashData(k);
4267 reindexTable(pParse, pTab, zColl);
4271 #endif
4274 ** Generate code for the REINDEX command.
4276 ** REINDEX -- 1
4277 ** REINDEX <collation> -- 2
4278 ** REINDEX ?<database>.?<tablename> -- 3
4279 ** REINDEX ?<database>.?<indexname> -- 4
4281 ** Form 1 causes all indices in all attached databases to be rebuilt.
4282 ** Form 2 rebuilds all indices in all databases that use the named
4283 ** collating function. Forms 3 and 4 rebuild the named index or all
4284 ** indices associated with the named table.
4286 #ifndef SQLITE_OMIT_REINDEX
4287 void sqlite3Reindex(Parse *pParse, Token *pName1, Token *pName2){
4288 CollSeq *pColl; /* Collating sequence to be reindexed, or NULL */
4289 char *z; /* Name of a table or index */
4290 const char *zDb; /* Name of the database */
4291 Table *pTab; /* A table in the database */
4292 Index *pIndex; /* An index associated with pTab */
4293 int iDb; /* The database index number */
4294 sqlite3 *db = pParse->db; /* The database connection */
4295 Token *pObjName; /* Name of the table or index to be reindexed */
4297 /* Read the database schema. If an error occurs, leave an error message
4298 ** and code in pParse and return NULL. */
4299 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
4300 return;
4303 if( pName1==0 ){
4304 reindexDatabases(pParse, 0);
4305 return;
4306 }else if( NEVER(pName2==0) || pName2->z==0 ){
4307 char *zColl;
4308 assert( pName1->z );
4309 zColl = sqlite3NameFromToken(pParse->db, pName1);
4310 if( !zColl ) return;
4311 pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
4312 if( pColl ){
4313 reindexDatabases(pParse, zColl);
4314 sqlite3DbFree(db, zColl);
4315 return;
4317 sqlite3DbFree(db, zColl);
4319 iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pObjName);
4320 if( iDb<0 ) return;
4321 z = sqlite3NameFromToken(db, pObjName);
4322 if( z==0 ) return;
4323 zDb = db->aDb[iDb].zDbSName;
4324 pTab = sqlite3FindTable(db, z, zDb);
4325 if( pTab ){
4326 reindexTable(pParse, pTab, 0);
4327 sqlite3DbFree(db, z);
4328 return;
4330 pIndex = sqlite3FindIndex(db, z, zDb);
4331 sqlite3DbFree(db, z);
4332 if( pIndex ){
4333 sqlite3BeginWriteOperation(pParse, 0, iDb);
4334 sqlite3RefillIndex(pParse, pIndex, -1);
4335 return;
4337 sqlite3ErrorMsg(pParse, "unable to identify the object to be reindexed");
4339 #endif
4342 ** Return a KeyInfo structure that is appropriate for the given Index.
4344 ** The caller should invoke sqlite3KeyInfoUnref() on the returned object
4345 ** when it has finished using it.
4347 KeyInfo *sqlite3KeyInfoOfIndex(Parse *pParse, Index *pIdx){
4348 int i;
4349 int nCol = pIdx->nColumn;
4350 int nKey = pIdx->nKeyCol;
4351 KeyInfo *pKey;
4352 if( pParse->nErr ) return 0;
4353 if( pIdx->uniqNotNull ){
4354 pKey = sqlite3KeyInfoAlloc(pParse->db, nKey, nCol-nKey);
4355 }else{
4356 pKey = sqlite3KeyInfoAlloc(pParse->db, nCol, 0);
4358 if( pKey ){
4359 assert( sqlite3KeyInfoIsWriteable(pKey) );
4360 for(i=0; i<nCol; i++){
4361 const char *zColl = pIdx->azColl[i];
4362 pKey->aColl[i] = zColl==sqlite3StrBINARY ? 0 :
4363 sqlite3LocateCollSeq(pParse, zColl);
4364 pKey->aSortOrder[i] = pIdx->aSortOrder[i];
4366 if( pParse->nErr ){
4367 sqlite3KeyInfoUnref(pKey);
4368 pKey = 0;
4371 return pKey;
4374 #ifndef SQLITE_OMIT_CTE
4376 ** This routine is invoked once per CTE by the parser while parsing a
4377 ** WITH clause.
4379 With *sqlite3WithAdd(
4380 Parse *pParse, /* Parsing context */
4381 With *pWith, /* Existing WITH clause, or NULL */
4382 Token *pName, /* Name of the common-table */
4383 ExprList *pArglist, /* Optional column name list for the table */
4384 Select *pQuery /* Query used to initialize the table */
4386 sqlite3 *db = pParse->db;
4387 With *pNew;
4388 char *zName;
4390 /* Check that the CTE name is unique within this WITH clause. If
4391 ** not, store an error in the Parse structure. */
4392 zName = sqlite3NameFromToken(pParse->db, pName);
4393 if( zName && pWith ){
4394 int i;
4395 for(i=0; i<pWith->nCte; i++){
4396 if( sqlite3StrICmp(zName, pWith->a[i].zName)==0 ){
4397 sqlite3ErrorMsg(pParse, "duplicate WITH table name: %s", zName);
4402 if( pWith ){
4403 int nByte = sizeof(*pWith) + (sizeof(pWith->a[1]) * pWith->nCte);
4404 pNew = sqlite3DbRealloc(db, pWith, nByte);
4405 }else{
4406 pNew = sqlite3DbMallocZero(db, sizeof(*pWith));
4408 assert( (pNew!=0 && zName!=0) || db->mallocFailed );
4410 if( db->mallocFailed ){
4411 sqlite3ExprListDelete(db, pArglist);
4412 sqlite3SelectDelete(db, pQuery);
4413 sqlite3DbFree(db, zName);
4414 pNew = pWith;
4415 }else{
4416 pNew->a[pNew->nCte].pSelect = pQuery;
4417 pNew->a[pNew->nCte].pCols = pArglist;
4418 pNew->a[pNew->nCte].zName = zName;
4419 pNew->a[pNew->nCte].zCteErr = 0;
4420 pNew->nCte++;
4423 return pNew;
4427 ** Free the contents of the With object passed as the second argument.
4429 void sqlite3WithDelete(sqlite3 *db, With *pWith){
4430 if( pWith ){
4431 int i;
4432 for(i=0; i<pWith->nCte; i++){
4433 struct Cte *pCte = &pWith->a[i];
4434 sqlite3ExprListDelete(db, pCte->pCols);
4435 sqlite3SelectDelete(db, pCte->pSelect);
4436 sqlite3DbFree(db, pCte->zName);
4438 sqlite3DbFree(db, pWith);
4441 #endif /* !defined(SQLITE_OMIT_CTE) */