xref: /sqlite-3.40.0/src/build.c (revision 7ef4d75b)
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.
10 **
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:
15 **
16 **     CREATE TABLE
17 **     DROP TABLE
18 **     CREATE INDEX
19 **     DROP INDEX
20 **     creating ID lists
21 **     BEGIN TRANSACTION
22 **     COMMIT
23 **     ROLLBACK
24 */
25 #include "sqliteInt.h"
26 
27 #ifndef SQLITE_OMIT_SHARED_CACHE
28 /*
29 ** The TableLock structure is only used by the sqlite3TableLock() and
30 ** codeTableLocks() functions.
31 */
32 struct TableLock {
33   int iDb;               /* The database containing the table to be locked */
34   Pgno 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 */
37 };
38 
39 /*
40 ** Record the fact that we want to lock a table at run-time.
41 **
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.
44 **
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().
48 */
49 static SQLITE_NOINLINE void lockTable(
50   Parse *pParse,     /* Parsing context */
51   int iDb,           /* Index of the database containing the table to lock */
52   Pgno 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 */
55 ){
56   Parse *pToplevel;
57   int i;
58   int nBytes;
59   TableLock *p;
60   assert( iDb>=0 );
61 
62   pToplevel = sqlite3ParseToplevel(pParse);
63   for(i=0; i<pToplevel->nTableLock; i++){
64     p = &pToplevel->aTableLock[i];
65     if( p->iDb==iDb && p->iTab==iTab ){
66       p->isWriteLock = (p->isWriteLock || isWriteLock);
67       return;
68     }
69   }
70 
71   nBytes = sizeof(TableLock) * (pToplevel->nTableLock+1);
72   pToplevel->aTableLock =
73       sqlite3DbReallocOrFree(pToplevel->db, pToplevel->aTableLock, nBytes);
74   if( pToplevel->aTableLock ){
75     p = &pToplevel->aTableLock[pToplevel->nTableLock++];
76     p->iDb = iDb;
77     p->iTab = iTab;
78     p->isWriteLock = isWriteLock;
79     p->zLockName = zName;
80   }else{
81     pToplevel->nTableLock = 0;
82     sqlite3OomFault(pToplevel->db);
83   }
84 }
85 void sqlite3TableLock(
86   Parse *pParse,     /* Parsing context */
87   int iDb,           /* Index of the database containing the table to lock */
88   Pgno iTab,         /* Root page number of the table to be locked */
89   u8 isWriteLock,    /* True for a write lock */
90   const char *zName  /* Name of the table to be locked */
91 ){
92   if( iDb==1 ) return;
93   if( !sqlite3BtreeSharable(pParse->db->aDb[iDb].pBt) ) return;
94   lockTable(pParse, iDb, iTab, isWriteLock, zName);
95 }
96 
97 /*
98 ** Code an OP_TableLock instruction for each table locked by the
99 ** statement (configured by calls to sqlite3TableLock()).
100 */
101 static void codeTableLocks(Parse *pParse){
102   int i;
103   Vdbe *pVdbe = pParse->pVdbe;
104   assert( pVdbe!=0 );
105 
106   for(i=0; i<pParse->nTableLock; i++){
107     TableLock *p = &pParse->aTableLock[i];
108     int p1 = p->iDb;
109     sqlite3VdbeAddOp4(pVdbe, OP_TableLock, p1, p->iTab, p->isWriteLock,
110                       p->zLockName, P4_STATIC);
111   }
112 }
113 #else
114   #define codeTableLocks(x)
115 #endif
116 
117 /*
118 ** Return TRUE if the given yDbMask object is empty - if it contains no
119 ** 1 bits.  This routine is used by the DbMaskAllZero() and DbMaskNotZero()
120 ** macros when SQLITE_MAX_ATTACHED is greater than 30.
121 */
122 #if SQLITE_MAX_ATTACHED>30
123 int sqlite3DbMaskAllZero(yDbMask m){
124   int i;
125   for(i=0; i<sizeof(yDbMask); i++) if( m[i] ) return 0;
126   return 1;
127 }
128 #endif
129 
130 /*
131 ** This routine is called after a single SQL statement has been
132 ** parsed and a VDBE program to execute that statement has been
133 ** prepared.  This routine puts the finishing touches on the
134 ** VDBE program and resets the pParse structure for the next
135 ** parse.
136 **
137 ** Note that if an error occurred, it might be the case that
138 ** no VDBE code was generated.
139 */
140 void sqlite3FinishCoding(Parse *pParse){
141   sqlite3 *db;
142   Vdbe *v;
143 
144   assert( pParse->pToplevel==0 );
145   db = pParse->db;
146   assert( db->pParse==pParse );
147   if( pParse->nested ) return;
148   if( pParse->nErr ){
149     if( db->mallocFailed ) pParse->rc = SQLITE_NOMEM;
150     return;
151   }
152   assert( db->mallocFailed==0 );
153 
154   /* Begin by generating some termination code at the end of the
155   ** vdbe program
156   */
157   v = pParse->pVdbe;
158   if( v==0 ){
159     if( db->init.busy ){
160       pParse->rc = SQLITE_DONE;
161       return;
162     }
163     v = sqlite3GetVdbe(pParse);
164     if( v==0 ) pParse->rc = SQLITE_ERROR;
165   }
166   assert( !pParse->isMultiWrite
167        || sqlite3VdbeAssertMayAbort(v, pParse->mayAbort));
168   if( v ){
169     if( pParse->bReturning ){
170       Returning *pReturning = pParse->u1.pReturning;
171       int addrRewind;
172       int i;
173       int reg;
174 
175       if( NEVER(pReturning->nRetCol==0) ){
176         assert( CORRUPT_DB );
177       }else{
178         sqlite3VdbeAddOp0(v, OP_FkCheck);
179         addrRewind =
180            sqlite3VdbeAddOp1(v, OP_Rewind, pReturning->iRetCur);
181         VdbeCoverage(v);
182         reg = pReturning->iRetReg;
183         for(i=0; i<pReturning->nRetCol; i++){
184           sqlite3VdbeAddOp3(v, OP_Column, pReturning->iRetCur, i, reg+i);
185         }
186         sqlite3VdbeAddOp2(v, OP_ResultRow, reg, i);
187         sqlite3VdbeAddOp2(v, OP_Next, pReturning->iRetCur, addrRewind+1);
188         VdbeCoverage(v);
189         sqlite3VdbeJumpHere(v, addrRewind);
190       }
191     }
192     sqlite3VdbeAddOp0(v, OP_Halt);
193 
194 #if SQLITE_USER_AUTHENTICATION
195     if( pParse->nTableLock>0 && db->init.busy==0 ){
196       sqlite3UserAuthInit(db);
197       if( db->auth.authLevel<UAUTH_User ){
198         sqlite3ErrorMsg(pParse, "user not authenticated");
199         pParse->rc = SQLITE_AUTH_USER;
200         return;
201       }
202     }
203 #endif
204 
205     /* The cookie mask contains one bit for each database file open.
206     ** (Bit 0 is for main, bit 1 is for temp, and so forth.)  Bits are
207     ** set for each database that is used.  Generate code to start a
208     ** transaction on each used database and to verify the schema cookie
209     ** on each used database.
210     */
211     if( db->mallocFailed==0
212      && (DbMaskNonZero(pParse->cookieMask) || pParse->pConstExpr)
213     ){
214       int iDb, i;
215       assert( sqlite3VdbeGetOp(v, 0)->opcode==OP_Init );
216       sqlite3VdbeJumpHere(v, 0);
217       for(iDb=0; iDb<db->nDb; iDb++){
218         Schema *pSchema;
219         if( DbMaskTest(pParse->cookieMask, iDb)==0 ) continue;
220         sqlite3VdbeUsesBtree(v, iDb);
221         pSchema = db->aDb[iDb].pSchema;
222         sqlite3VdbeAddOp4Int(v,
223           OP_Transaction,                    /* Opcode */
224           iDb,                               /* P1 */
225           DbMaskTest(pParse->writeMask,iDb), /* P2 */
226           pSchema->schema_cookie,            /* P3 */
227           pSchema->iGeneration               /* P4 */
228         );
229         if( db->init.busy==0 ) sqlite3VdbeChangeP5(v, 1);
230         VdbeComment((v,
231               "usesStmtJournal=%d", pParse->mayAbort && pParse->isMultiWrite));
232       }
233 #ifndef SQLITE_OMIT_VIRTUALTABLE
234       for(i=0; i<pParse->nVtabLock; i++){
235         char *vtab = (char *)sqlite3GetVTable(db, pParse->apVtabLock[i]);
236         sqlite3VdbeAddOp4(v, OP_VBegin, 0, 0, 0, vtab, P4_VTAB);
237       }
238       pParse->nVtabLock = 0;
239 #endif
240 
241       /* Once all the cookies have been verified and transactions opened,
242       ** obtain the required table-locks. This is a no-op unless the
243       ** shared-cache feature is enabled.
244       */
245       codeTableLocks(pParse);
246 
247       /* Initialize any AUTOINCREMENT data structures required.
248       */
249       sqlite3AutoincrementBegin(pParse);
250 
251       /* Code constant expressions that where factored out of inner loops.
252       **
253       ** The pConstExpr list might also contain expressions that we simply
254       ** want to keep around until the Parse object is deleted.  Such
255       ** expressions have iConstExprReg==0.  Do not generate code for
256       ** those expressions, of course.
257       */
258       if( pParse->pConstExpr ){
259         ExprList *pEL = pParse->pConstExpr;
260         pParse->okConstFactor = 0;
261         for(i=0; i<pEL->nExpr; i++){
262           int iReg = pEL->a[i].u.iConstExprReg;
263           if( iReg>0 ){
264             sqlite3ExprCode(pParse, pEL->a[i].pExpr, iReg);
265           }
266         }
267       }
268 
269       if( pParse->bReturning ){
270         Returning *pRet = pParse->u1.pReturning;
271         if( NEVER(pRet->nRetCol==0) ){
272           assert( CORRUPT_DB );
273         }else{
274           sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pRet->iRetCur, pRet->nRetCol);
275         }
276       }
277 
278       /* Finally, jump back to the beginning of the executable code. */
279       sqlite3VdbeGoto(v, 1);
280     }
281   }
282 
283   /* Get the VDBE program ready for execution
284   */
285   assert( v!=0 || pParse->nErr );
286   assert( db->mallocFailed==0 || pParse->nErr );
287   if( pParse->nErr==0 ){
288     /* A minimum of one cursor is required if autoincrement is used
289     *  See ticket [a696379c1f08866] */
290     assert( pParse->pAinc==0 || pParse->nTab>0 );
291     sqlite3VdbeMakeReady(v, pParse);
292     pParse->rc = SQLITE_DONE;
293   }else{
294     pParse->rc = SQLITE_ERROR;
295   }
296 }
297 
298 /*
299 ** Run the parser and code generator recursively in order to generate
300 ** code for the SQL statement given onto the end of the pParse context
301 ** currently under construction.  Notes:
302 **
303 **   *  The final OP_Halt is not appended and other initialization
304 **      and finalization steps are omitted because those are handling by the
305 **      outermost parser.
306 **
307 **   *  Built-in SQL functions always take precedence over application-defined
308 **      SQL functions.  In other words, it is not possible to override a
309 **      built-in function.
310 */
311 void sqlite3NestedParse(Parse *pParse, const char *zFormat, ...){
312   va_list ap;
313   char *zSql;
314   sqlite3 *db = pParse->db;
315   u32 savedDbFlags = db->mDbFlags;
316   char saveBuf[PARSE_TAIL_SZ];
317 
318   if( pParse->nErr ) return;
319   assert( pParse->nested<10 );  /* Nesting should only be of limited depth */
320   va_start(ap, zFormat);
321   zSql = sqlite3VMPrintf(db, zFormat, ap);
322   va_end(ap);
323   if( zSql==0 ){
324     /* This can result either from an OOM or because the formatted string
325     ** exceeds SQLITE_LIMIT_LENGTH.  In the latter case, we need to set
326     ** an error */
327     if( !db->mallocFailed ) pParse->rc = SQLITE_TOOBIG;
328     pParse->nErr++;
329     return;
330   }
331   pParse->nested++;
332   memcpy(saveBuf, PARSE_TAIL(pParse), PARSE_TAIL_SZ);
333   memset(PARSE_TAIL(pParse), 0, PARSE_TAIL_SZ);
334   db->mDbFlags |= DBFLAG_PreferBuiltin;
335   sqlite3RunParser(pParse, zSql);
336   sqlite3DbFree(db, pParse->zErrMsg);
337   pParse->zErrMsg = 0;
338   db->mDbFlags = savedDbFlags;
339   sqlite3DbFree(db, zSql);
340   memcpy(PARSE_TAIL(pParse), saveBuf, PARSE_TAIL_SZ);
341   pParse->nested--;
342 }
343 
344 #if SQLITE_USER_AUTHENTICATION
345 /*
346 ** Return TRUE if zTable is the name of the system table that stores the
347 ** list of users and their access credentials.
348 */
349 int sqlite3UserAuthTable(const char *zTable){
350   return sqlite3_stricmp(zTable, "sqlite_user")==0;
351 }
352 #endif
353 
354 /*
355 ** Locate the in-memory structure that describes a particular database
356 ** table given the name of that table and (optionally) the name of the
357 ** database containing the table.  Return NULL if not found.
358 **
359 ** If zDatabase is 0, all databases are searched for the table and the
360 ** first matching table is returned.  (No checking for duplicate table
361 ** names is done.)  The search order is TEMP first, then MAIN, then any
362 ** auxiliary databases added using the ATTACH command.
363 **
364 ** See also sqlite3LocateTable().
365 */
366 Table *sqlite3FindTable(sqlite3 *db, const char *zName, const char *zDatabase){
367   Table *p = 0;
368   int i;
369 
370   /* All mutexes are required for schema access.  Make sure we hold them. */
371   assert( zDatabase!=0 || sqlite3BtreeHoldsAllMutexes(db) );
372 #if SQLITE_USER_AUTHENTICATION
373   /* Only the admin user is allowed to know that the sqlite_user table
374   ** exists */
375   if( db->auth.authLevel<UAUTH_Admin && sqlite3UserAuthTable(zName)!=0 ){
376     return 0;
377   }
378 #endif
379   if( zDatabase ){
380     for(i=0; i<db->nDb; i++){
381       if( sqlite3StrICmp(zDatabase, db->aDb[i].zDbSName)==0 ) break;
382     }
383     if( i>=db->nDb ){
384       /* No match against the official names.  But always match "main"
385       ** to schema 0 as a legacy fallback. */
386       if( sqlite3StrICmp(zDatabase,"main")==0 ){
387         i = 0;
388       }else{
389         return 0;
390       }
391     }
392     p = sqlite3HashFind(&db->aDb[i].pSchema->tblHash, zName);
393     if( p==0 && sqlite3StrNICmp(zName, "sqlite_", 7)==0 ){
394       if( i==1 ){
395         if( sqlite3StrICmp(zName+7, &PREFERRED_TEMP_SCHEMA_TABLE[7])==0
396          || sqlite3StrICmp(zName+7, &PREFERRED_SCHEMA_TABLE[7])==0
397          || sqlite3StrICmp(zName+7, &LEGACY_SCHEMA_TABLE[7])==0
398         ){
399           p = sqlite3HashFind(&db->aDb[1].pSchema->tblHash,
400                               LEGACY_TEMP_SCHEMA_TABLE);
401         }
402       }else{
403         if( sqlite3StrICmp(zName+7, &PREFERRED_SCHEMA_TABLE[7])==0 ){
404           p = sqlite3HashFind(&db->aDb[i].pSchema->tblHash,
405                               LEGACY_SCHEMA_TABLE);
406         }
407       }
408     }
409   }else{
410     /* Match against TEMP first */
411     p = sqlite3HashFind(&db->aDb[1].pSchema->tblHash, zName);
412     if( p ) return p;
413     /* The main database is second */
414     p = sqlite3HashFind(&db->aDb[0].pSchema->tblHash, zName);
415     if( p ) return p;
416     /* Attached databases are in order of attachment */
417     for(i=2; i<db->nDb; i++){
418       assert( sqlite3SchemaMutexHeld(db, i, 0) );
419       p = sqlite3HashFind(&db->aDb[i].pSchema->tblHash, zName);
420       if( p ) break;
421     }
422     if( p==0 && sqlite3StrNICmp(zName, "sqlite_", 7)==0 ){
423       if( sqlite3StrICmp(zName+7, &PREFERRED_SCHEMA_TABLE[7])==0 ){
424         p = sqlite3HashFind(&db->aDb[0].pSchema->tblHash, LEGACY_SCHEMA_TABLE);
425       }else if( sqlite3StrICmp(zName+7, &PREFERRED_TEMP_SCHEMA_TABLE[7])==0 ){
426         p = sqlite3HashFind(&db->aDb[1].pSchema->tblHash,
427                             LEGACY_TEMP_SCHEMA_TABLE);
428       }
429     }
430   }
431   return p;
432 }
433 
434 /*
435 ** Locate the in-memory structure that describes a particular database
436 ** table given the name of that table and (optionally) the name of the
437 ** database containing the table.  Return NULL if not found.  Also leave an
438 ** error message in pParse->zErrMsg.
439 **
440 ** The difference between this routine and sqlite3FindTable() is that this
441 ** routine leaves an error message in pParse->zErrMsg where
442 ** sqlite3FindTable() does not.
443 */
444 Table *sqlite3LocateTable(
445   Parse *pParse,         /* context in which to report errors */
446   u32 flags,             /* LOCATE_VIEW or LOCATE_NOERR */
447   const char *zName,     /* Name of the table we are looking for */
448   const char *zDbase     /* Name of the database.  Might be NULL */
449 ){
450   Table *p;
451   sqlite3 *db = pParse->db;
452 
453   /* Read the database schema. If an error occurs, leave an error message
454   ** and code in pParse and return NULL. */
455   if( (db->mDbFlags & DBFLAG_SchemaKnownOk)==0
456    && SQLITE_OK!=sqlite3ReadSchema(pParse)
457   ){
458     return 0;
459   }
460 
461   p = sqlite3FindTable(db, zName, zDbase);
462   if( p==0 ){
463 #ifndef SQLITE_OMIT_VIRTUALTABLE
464     /* If zName is the not the name of a table in the schema created using
465     ** CREATE, then check to see if it is the name of an virtual table that
466     ** can be an eponymous virtual table. */
467     if( pParse->disableVtab==0 && db->init.busy==0 ){
468       Module *pMod = (Module*)sqlite3HashFind(&db->aModule, zName);
469       if( pMod==0 && sqlite3_strnicmp(zName, "pragma_", 7)==0 ){
470         pMod = sqlite3PragmaVtabRegister(db, zName);
471       }
472       if( pMod && sqlite3VtabEponymousTableInit(pParse, pMod) ){
473         testcase( pMod->pEpoTab==0 );
474         return pMod->pEpoTab;
475       }
476     }
477 #endif
478     if( flags & LOCATE_NOERR ) return 0;
479     pParse->checkSchema = 1;
480   }else if( IsVirtual(p) && pParse->disableVtab ){
481     p = 0;
482   }
483 
484   if( p==0 ){
485     const char *zMsg = flags & LOCATE_VIEW ? "no such view" : "no such table";
486     if( zDbase ){
487       sqlite3ErrorMsg(pParse, "%s: %s.%s", zMsg, zDbase, zName);
488     }else{
489       sqlite3ErrorMsg(pParse, "%s: %s", zMsg, zName);
490     }
491   }else{
492     assert( HasRowid(p) || p->iPKey<0 );
493   }
494 
495   return p;
496 }
497 
498 /*
499 ** Locate the table identified by *p.
500 **
501 ** This is a wrapper around sqlite3LocateTable(). The difference between
502 ** sqlite3LocateTable() and this function is that this function restricts
503 ** the search to schema (p->pSchema) if it is not NULL. p->pSchema may be
504 ** non-NULL if it is part of a view or trigger program definition. See
505 ** sqlite3FixSrcList() for details.
506 */
507 Table *sqlite3LocateTableItem(
508   Parse *pParse,
509   u32 flags,
510   SrcItem *p
511 ){
512   const char *zDb;
513   assert( p->pSchema==0 || p->zDatabase==0 );
514   if( p->pSchema ){
515     int iDb = sqlite3SchemaToIndex(pParse->db, p->pSchema);
516     zDb = pParse->db->aDb[iDb].zDbSName;
517   }else{
518     zDb = p->zDatabase;
519   }
520   return sqlite3LocateTable(pParse, flags, p->zName, zDb);
521 }
522 
523 /*
524 ** Return the preferred table name for system tables.  Translate legacy
525 ** names into the new preferred names, as appropriate.
526 */
527 const char *sqlite3PreferredTableName(const char *zName){
528   if( sqlite3StrNICmp(zName, "sqlite_", 7)==0 ){
529     if( sqlite3StrICmp(zName+7, &LEGACY_SCHEMA_TABLE[7])==0 ){
530       return PREFERRED_SCHEMA_TABLE;
531     }
532     if( sqlite3StrICmp(zName+7, &LEGACY_TEMP_SCHEMA_TABLE[7])==0 ){
533       return PREFERRED_TEMP_SCHEMA_TABLE;
534     }
535   }
536   return zName;
537 }
538 
539 /*
540 ** Locate the in-memory structure that describes
541 ** a particular index given the name of that index
542 ** and the name of the database that contains the index.
543 ** Return NULL if not found.
544 **
545 ** If zDatabase is 0, all databases are searched for the
546 ** table and the first matching index is returned.  (No checking
547 ** for duplicate index names is done.)  The search order is
548 ** TEMP first, then MAIN, then any auxiliary databases added
549 ** using the ATTACH command.
550 */
551 Index *sqlite3FindIndex(sqlite3 *db, const char *zName, const char *zDb){
552   Index *p = 0;
553   int i;
554   /* All mutexes are required for schema access.  Make sure we hold them. */
555   assert( zDb!=0 || sqlite3BtreeHoldsAllMutexes(db) );
556   for(i=OMIT_TEMPDB; i<db->nDb; i++){
557     int j = (i<2) ? i^1 : i;  /* Search TEMP before MAIN */
558     Schema *pSchema = db->aDb[j].pSchema;
559     assert( pSchema );
560     if( zDb && sqlite3DbIsNamed(db, j, zDb)==0 ) continue;
561     assert( sqlite3SchemaMutexHeld(db, j, 0) );
562     p = sqlite3HashFind(&pSchema->idxHash, zName);
563     if( p ) break;
564   }
565   return p;
566 }
567 
568 /*
569 ** Reclaim the memory used by an index
570 */
571 void sqlite3FreeIndex(sqlite3 *db, Index *p){
572 #ifndef SQLITE_OMIT_ANALYZE
573   sqlite3DeleteIndexSamples(db, p);
574 #endif
575   sqlite3ExprDelete(db, p->pPartIdxWhere);
576   sqlite3ExprListDelete(db, p->aColExpr);
577   sqlite3DbFree(db, p->zColAff);
578   if( p->isResized ) sqlite3DbFree(db, (void *)p->azColl);
579 #ifdef SQLITE_ENABLE_STAT4
580   sqlite3_free(p->aiRowEst);
581 #endif
582   sqlite3DbFree(db, p);
583 }
584 
585 /*
586 ** For the index called zIdxName which is found in the database iDb,
587 ** unlike that index from its Table then remove the index from
588 ** the index hash table and free all memory structures associated
589 ** with the index.
590 */
591 void sqlite3UnlinkAndDeleteIndex(sqlite3 *db, int iDb, const char *zIdxName){
592   Index *pIndex;
593   Hash *pHash;
594 
595   assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
596   pHash = &db->aDb[iDb].pSchema->idxHash;
597   pIndex = sqlite3HashInsert(pHash, zIdxName, 0);
598   if( ALWAYS(pIndex) ){
599     if( pIndex->pTable->pIndex==pIndex ){
600       pIndex->pTable->pIndex = pIndex->pNext;
601     }else{
602       Index *p;
603       /* Justification of ALWAYS();  The index must be on the list of
604       ** indices. */
605       p = pIndex->pTable->pIndex;
606       while( ALWAYS(p) && p->pNext!=pIndex ){ p = p->pNext; }
607       if( ALWAYS(p && p->pNext==pIndex) ){
608         p->pNext = pIndex->pNext;
609       }
610     }
611     sqlite3FreeIndex(db, pIndex);
612   }
613   db->mDbFlags |= DBFLAG_SchemaChange;
614 }
615 
616 /*
617 ** Look through the list of open database files in db->aDb[] and if
618 ** any have been closed, remove them from the list.  Reallocate the
619 ** db->aDb[] structure to a smaller size, if possible.
620 **
621 ** Entry 0 (the "main" database) and entry 1 (the "temp" database)
622 ** are never candidates for being collapsed.
623 */
624 void sqlite3CollapseDatabaseArray(sqlite3 *db){
625   int i, j;
626   for(i=j=2; i<db->nDb; i++){
627     struct Db *pDb = &db->aDb[i];
628     if( pDb->pBt==0 ){
629       sqlite3DbFree(db, pDb->zDbSName);
630       pDb->zDbSName = 0;
631       continue;
632     }
633     if( j<i ){
634       db->aDb[j] = db->aDb[i];
635     }
636     j++;
637   }
638   db->nDb = j;
639   if( db->nDb<=2 && db->aDb!=db->aDbStatic ){
640     memcpy(db->aDbStatic, db->aDb, 2*sizeof(db->aDb[0]));
641     sqlite3DbFree(db, db->aDb);
642     db->aDb = db->aDbStatic;
643   }
644 }
645 
646 /*
647 ** Reset the schema for the database at index iDb.  Also reset the
648 ** TEMP schema.  The reset is deferred if db->nSchemaLock is not zero.
649 ** Deferred resets may be run by calling with iDb<0.
650 */
651 void sqlite3ResetOneSchema(sqlite3 *db, int iDb){
652   int i;
653   assert( iDb<db->nDb );
654 
655   if( iDb>=0 ){
656     assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
657     DbSetProperty(db, iDb, DB_ResetWanted);
658     DbSetProperty(db, 1, DB_ResetWanted);
659     db->mDbFlags &= ~DBFLAG_SchemaKnownOk;
660   }
661 
662   if( db->nSchemaLock==0 ){
663     for(i=0; i<db->nDb; i++){
664       if( DbHasProperty(db, i, DB_ResetWanted) ){
665         sqlite3SchemaClear(db->aDb[i].pSchema);
666       }
667     }
668   }
669 }
670 
671 /*
672 ** Erase all schema information from all attached databases (including
673 ** "main" and "temp") for a single database connection.
674 */
675 void sqlite3ResetAllSchemasOfConnection(sqlite3 *db){
676   int i;
677   sqlite3BtreeEnterAll(db);
678   for(i=0; i<db->nDb; i++){
679     Db *pDb = &db->aDb[i];
680     if( pDb->pSchema ){
681       if( db->nSchemaLock==0 ){
682         sqlite3SchemaClear(pDb->pSchema);
683       }else{
684         DbSetProperty(db, i, DB_ResetWanted);
685       }
686     }
687   }
688   db->mDbFlags &= ~(DBFLAG_SchemaChange|DBFLAG_SchemaKnownOk);
689   sqlite3VtabUnlockList(db);
690   sqlite3BtreeLeaveAll(db);
691   if( db->nSchemaLock==0 ){
692     sqlite3CollapseDatabaseArray(db);
693   }
694 }
695 
696 /*
697 ** This routine is called when a commit occurs.
698 */
699 void sqlite3CommitInternalChanges(sqlite3 *db){
700   db->mDbFlags &= ~DBFLAG_SchemaChange;
701 }
702 
703 /*
704 ** Set the expression associated with a column.  This is usually
705 ** the DEFAULT value, but might also be the expression that computes
706 ** the value for a generated column.
707 */
708 void sqlite3ColumnSetExpr(
709   Parse *pParse,    /* Parsing context */
710   Table *pTab,      /* The table containing the column */
711   Column *pCol,     /* The column to receive the new DEFAULT expression */
712   Expr *pExpr       /* The new default expression */
713 ){
714   ExprList *pList;
715   assert( IsOrdinaryTable(pTab) );
716   pList = pTab->u.tab.pDfltList;
717   if( pCol->iDflt==0
718    || NEVER(pList==0)
719    || NEVER(pList->nExpr<pCol->iDflt)
720   ){
721     pCol->iDflt = pList==0 ? 1 : pList->nExpr+1;
722     pTab->u.tab.pDfltList = sqlite3ExprListAppend(pParse, pList, pExpr);
723   }else{
724     sqlite3ExprDelete(pParse->db, pList->a[pCol->iDflt-1].pExpr);
725     pList->a[pCol->iDflt-1].pExpr = pExpr;
726   }
727 }
728 
729 /*
730 ** Return the expression associated with a column.  The expression might be
731 ** the DEFAULT clause or the AS clause of a generated column.
732 ** Return NULL if the column has no associated expression.
733 */
734 Expr *sqlite3ColumnExpr(Table *pTab, Column *pCol){
735   if( pCol->iDflt==0 ) return 0;
736   if( NEVER(!IsOrdinaryTable(pTab)) ) return 0;
737   if( NEVER(pTab->u.tab.pDfltList==0) ) return 0;
738   if( NEVER(pTab->u.tab.pDfltList->nExpr<pCol->iDflt) ) return 0;
739   return pTab->u.tab.pDfltList->a[pCol->iDflt-1].pExpr;
740 }
741 
742 /*
743 ** Set the collating sequence name for a column.
744 */
745 void sqlite3ColumnSetColl(
746   sqlite3 *db,
747   Column *pCol,
748   const char *zColl
749 ){
750   i64 nColl;
751   i64 n;
752   char *zNew;
753   assert( zColl!=0 );
754   n = sqlite3Strlen30(pCol->zCnName) + 1;
755   if( pCol->colFlags & COLFLAG_HASTYPE ){
756     n += sqlite3Strlen30(pCol->zCnName+n) + 1;
757   }
758   nColl = sqlite3Strlen30(zColl) + 1;
759   zNew = sqlite3DbRealloc(db, pCol->zCnName, nColl+n);
760   if( zNew ){
761     pCol->zCnName = zNew;
762     memcpy(pCol->zCnName + n, zColl, nColl);
763     pCol->colFlags |= COLFLAG_HASCOLL;
764   }
765 }
766 
767 /*
768 ** Return the collating squence name for a column
769 */
770 const char *sqlite3ColumnColl(Column *pCol){
771   const char *z;
772   if( (pCol->colFlags & COLFLAG_HASCOLL)==0 ) return 0;
773   z = pCol->zCnName;
774   while( *z ){ z++; }
775   if( pCol->colFlags & COLFLAG_HASTYPE ){
776     do{ z++; }while( *z );
777   }
778   return z+1;
779 }
780 
781 /*
782 ** Delete memory allocated for the column names of a table or view (the
783 ** Table.aCol[] array).
784 */
785 void sqlite3DeleteColumnNames(sqlite3 *db, Table *pTable){
786   int i;
787   Column *pCol;
788   assert( pTable!=0 );
789   if( (pCol = pTable->aCol)!=0 ){
790     for(i=0; i<pTable->nCol; i++, pCol++){
791       assert( pCol->zCnName==0 || pCol->hName==sqlite3StrIHash(pCol->zCnName) );
792       sqlite3DbFree(db, pCol->zCnName);
793     }
794     sqlite3DbFree(db, pTable->aCol);
795     if( IsOrdinaryTable(pTable) ){
796       sqlite3ExprListDelete(db, pTable->u.tab.pDfltList);
797     }
798     if( db==0 || db->pnBytesFreed==0 ){
799       pTable->aCol = 0;
800       pTable->nCol = 0;
801       if( IsOrdinaryTable(pTable) ){
802         pTable->u.tab.pDfltList = 0;
803       }
804     }
805   }
806 }
807 
808 /*
809 ** Remove the memory data structures associated with the given
810 ** Table.  No changes are made to disk by this routine.
811 **
812 ** This routine just deletes the data structure.  It does not unlink
813 ** the table data structure from the hash table.  But it does destroy
814 ** memory structures of the indices and foreign keys associated with
815 ** the table.
816 **
817 ** The db parameter is optional.  It is needed if the Table object
818 ** contains lookaside memory.  (Table objects in the schema do not use
819 ** lookaside memory, but some ephemeral Table objects do.)  Or the
820 ** db parameter can be used with db->pnBytesFreed to measure the memory
821 ** used by the Table object.
822 */
823 static void SQLITE_NOINLINE deleteTable(sqlite3 *db, Table *pTable){
824   Index *pIndex, *pNext;
825 
826 #ifdef SQLITE_DEBUG
827   /* Record the number of outstanding lookaside allocations in schema Tables
828   ** prior to doing any free() operations. Since schema Tables do not use
829   ** lookaside, this number should not change.
830   **
831   ** If malloc has already failed, it may be that it failed while allocating
832   ** a Table object that was going to be marked ephemeral. So do not check
833   ** that no lookaside memory is used in this case either. */
834   int nLookaside = 0;
835   if( db && !db->mallocFailed && (pTable->tabFlags & TF_Ephemeral)==0 ){
836     nLookaside = sqlite3LookasideUsed(db, 0);
837   }
838 #endif
839 
840   /* Delete all indices associated with this table. */
841   for(pIndex = pTable->pIndex; pIndex; pIndex=pNext){
842     pNext = pIndex->pNext;
843     assert( pIndex->pSchema==pTable->pSchema
844          || (IsVirtual(pTable) && pIndex->idxType!=SQLITE_IDXTYPE_APPDEF) );
845     if( (db==0 || db->pnBytesFreed==0) && !IsVirtual(pTable) ){
846       char *zName = pIndex->zName;
847       TESTONLY ( Index *pOld = ) sqlite3HashInsert(
848          &pIndex->pSchema->idxHash, zName, 0
849       );
850       assert( db==0 || sqlite3SchemaMutexHeld(db, 0, pIndex->pSchema) );
851       assert( pOld==pIndex || pOld==0 );
852     }
853     sqlite3FreeIndex(db, pIndex);
854   }
855 
856   if( IsOrdinaryTable(pTable) ){
857     sqlite3FkDelete(db, pTable);
858   }
859 #ifndef SQLITE_OMIT_VIRTUAL_TABLE
860   else if( IsVirtual(pTable) ){
861     sqlite3VtabClear(db, pTable);
862   }
863 #endif
864   else{
865     assert( IsView(pTable) );
866     sqlite3SelectDelete(db, pTable->u.view.pSelect);
867   }
868 
869   /* Delete the Table structure itself.
870   */
871   sqlite3DeleteColumnNames(db, pTable);
872   sqlite3DbFree(db, pTable->zName);
873   sqlite3DbFree(db, pTable->zColAff);
874   sqlite3ExprListDelete(db, pTable->pCheck);
875   sqlite3DbFree(db, pTable);
876 
877   /* Verify that no lookaside memory was used by schema tables */
878   assert( nLookaside==0 || nLookaside==sqlite3LookasideUsed(db,0) );
879 }
880 void sqlite3DeleteTable(sqlite3 *db, Table *pTable){
881   /* Do not delete the table until the reference count reaches zero. */
882   if( !pTable ) return;
883   if( ((!db || db->pnBytesFreed==0) && (--pTable->nTabRef)>0) ) return;
884   deleteTable(db, pTable);
885 }
886 
887 
888 /*
889 ** Unlink the given table from the hash tables and the delete the
890 ** table structure with all its indices and foreign keys.
891 */
892 void sqlite3UnlinkAndDeleteTable(sqlite3 *db, int iDb, const char *zTabName){
893   Table *p;
894   Db *pDb;
895 
896   assert( db!=0 );
897   assert( iDb>=0 && iDb<db->nDb );
898   assert( zTabName );
899   assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
900   testcase( zTabName[0]==0 );  /* Zero-length table names are allowed */
901   pDb = &db->aDb[iDb];
902   p = sqlite3HashInsert(&pDb->pSchema->tblHash, zTabName, 0);
903   sqlite3DeleteTable(db, p);
904   db->mDbFlags |= DBFLAG_SchemaChange;
905 }
906 
907 /*
908 ** Given a token, return a string that consists of the text of that
909 ** token.  Space to hold the returned string
910 ** is obtained from sqliteMalloc() and must be freed by the calling
911 ** function.
912 **
913 ** Any quotation marks (ex:  "name", 'name', [name], or `name`) that
914 ** surround the body of the token are removed.
915 **
916 ** Tokens are often just pointers into the original SQL text and so
917 ** are not \000 terminated and are not persistent.  The returned string
918 ** is \000 terminated and is persistent.
919 */
920 char *sqlite3NameFromToken(sqlite3 *db, const Token *pName){
921   char *zName;
922   if( pName ){
923     zName = sqlite3DbStrNDup(db, (const char*)pName->z, pName->n);
924     sqlite3Dequote(zName);
925   }else{
926     zName = 0;
927   }
928   return zName;
929 }
930 
931 /*
932 ** Open the sqlite_schema table stored in database number iDb for
933 ** writing. The table is opened using cursor 0.
934 */
935 void sqlite3OpenSchemaTable(Parse *p, int iDb){
936   Vdbe *v = sqlite3GetVdbe(p);
937   sqlite3TableLock(p, iDb, SCHEMA_ROOT, 1, LEGACY_SCHEMA_TABLE);
938   sqlite3VdbeAddOp4Int(v, OP_OpenWrite, 0, SCHEMA_ROOT, iDb, 5);
939   if( p->nTab==0 ){
940     p->nTab = 1;
941   }
942 }
943 
944 /*
945 ** Parameter zName points to a nul-terminated buffer containing the name
946 ** of a database ("main", "temp" or the name of an attached db). This
947 ** function returns the index of the named database in db->aDb[], or
948 ** -1 if the named db cannot be found.
949 */
950 int sqlite3FindDbName(sqlite3 *db, const char *zName){
951   int i = -1;         /* Database number */
952   if( zName ){
953     Db *pDb;
954     for(i=(db->nDb-1), pDb=&db->aDb[i]; i>=0; i--, pDb--){
955       if( 0==sqlite3_stricmp(pDb->zDbSName, zName) ) break;
956       /* "main" is always an acceptable alias for the primary database
957       ** even if it has been renamed using SQLITE_DBCONFIG_MAINDBNAME. */
958       if( i==0 && 0==sqlite3_stricmp("main", zName) ) break;
959     }
960   }
961   return i;
962 }
963 
964 /*
965 ** The token *pName contains the name of a database (either "main" or
966 ** "temp" or the name of an attached db). This routine returns the
967 ** index of the named database in db->aDb[], or -1 if the named db
968 ** does not exist.
969 */
970 int sqlite3FindDb(sqlite3 *db, Token *pName){
971   int i;                               /* Database number */
972   char *zName;                         /* Name we are searching for */
973   zName = sqlite3NameFromToken(db, pName);
974   i = sqlite3FindDbName(db, zName);
975   sqlite3DbFree(db, zName);
976   return i;
977 }
978 
979 /* The table or view or trigger name is passed to this routine via tokens
980 ** pName1 and pName2. If the table name was fully qualified, for example:
981 **
982 ** CREATE TABLE xxx.yyy (...);
983 **
984 ** Then pName1 is set to "xxx" and pName2 "yyy". On the other hand if
985 ** the table name is not fully qualified, i.e.:
986 **
987 ** CREATE TABLE yyy(...);
988 **
989 ** Then pName1 is set to "yyy" and pName2 is "".
990 **
991 ** This routine sets the *ppUnqual pointer to point at the token (pName1 or
992 ** pName2) that stores the unqualified table name.  The index of the
993 ** database "xxx" is returned.
994 */
995 int sqlite3TwoPartName(
996   Parse *pParse,      /* Parsing and code generating context */
997   Token *pName1,      /* The "xxx" in the name "xxx.yyy" or "xxx" */
998   Token *pName2,      /* The "yyy" in the name "xxx.yyy" */
999   Token **pUnqual     /* Write the unqualified object name here */
1000 ){
1001   int iDb;                    /* Database holding the object */
1002   sqlite3 *db = pParse->db;
1003 
1004   assert( pName2!=0 );
1005   if( pName2->n>0 ){
1006     if( db->init.busy ) {
1007       sqlite3ErrorMsg(pParse, "corrupt database");
1008       return -1;
1009     }
1010     *pUnqual = pName2;
1011     iDb = sqlite3FindDb(db, pName1);
1012     if( iDb<0 ){
1013       sqlite3ErrorMsg(pParse, "unknown database %T", pName1);
1014       return -1;
1015     }
1016   }else{
1017     assert( db->init.iDb==0 || db->init.busy || IN_SPECIAL_PARSE
1018              || (db->mDbFlags & DBFLAG_Vacuum)!=0);
1019     iDb = db->init.iDb;
1020     *pUnqual = pName1;
1021   }
1022   return iDb;
1023 }
1024 
1025 /*
1026 ** True if PRAGMA writable_schema is ON
1027 */
1028 int sqlite3WritableSchema(sqlite3 *db){
1029   testcase( (db->flags&(SQLITE_WriteSchema|SQLITE_Defensive))==0 );
1030   testcase( (db->flags&(SQLITE_WriteSchema|SQLITE_Defensive))==
1031                SQLITE_WriteSchema );
1032   testcase( (db->flags&(SQLITE_WriteSchema|SQLITE_Defensive))==
1033                SQLITE_Defensive );
1034   testcase( (db->flags&(SQLITE_WriteSchema|SQLITE_Defensive))==
1035                (SQLITE_WriteSchema|SQLITE_Defensive) );
1036   return (db->flags&(SQLITE_WriteSchema|SQLITE_Defensive))==SQLITE_WriteSchema;
1037 }
1038 
1039 /*
1040 ** This routine is used to check if the UTF-8 string zName is a legal
1041 ** unqualified name for a new schema object (table, index, view or
1042 ** trigger). All names are legal except those that begin with the string
1043 ** "sqlite_" (in upper, lower or mixed case). This portion of the namespace
1044 ** is reserved for internal use.
1045 **
1046 ** When parsing the sqlite_schema table, this routine also checks to
1047 ** make sure the "type", "name", and "tbl_name" columns are consistent
1048 ** with the SQL.
1049 */
1050 int sqlite3CheckObjectName(
1051   Parse *pParse,            /* Parsing context */
1052   const char *zName,        /* Name of the object to check */
1053   const char *zType,        /* Type of this object */
1054   const char *zTblName      /* Parent table name for triggers and indexes */
1055 ){
1056   sqlite3 *db = pParse->db;
1057   if( sqlite3WritableSchema(db)
1058    || db->init.imposterTable
1059    || !sqlite3Config.bExtraSchemaChecks
1060   ){
1061     /* Skip these error checks for writable_schema=ON */
1062     return SQLITE_OK;
1063   }
1064   if( db->init.busy ){
1065     if( sqlite3_stricmp(zType, db->init.azInit[0])
1066      || sqlite3_stricmp(zName, db->init.azInit[1])
1067      || sqlite3_stricmp(zTblName, db->init.azInit[2])
1068     ){
1069       sqlite3ErrorMsg(pParse, ""); /* corruptSchema() will supply the error */
1070       return SQLITE_ERROR;
1071     }
1072   }else{
1073     if( (pParse->nested==0 && 0==sqlite3StrNICmp(zName, "sqlite_", 7))
1074      || (sqlite3ReadOnlyShadowTables(db) && sqlite3ShadowTableName(db, zName))
1075     ){
1076       sqlite3ErrorMsg(pParse, "object name reserved for internal use: %s",
1077                       zName);
1078       return SQLITE_ERROR;
1079     }
1080 
1081   }
1082   return SQLITE_OK;
1083 }
1084 
1085 /*
1086 ** Return the PRIMARY KEY index of a table
1087 */
1088 Index *sqlite3PrimaryKeyIndex(Table *pTab){
1089   Index *p;
1090   for(p=pTab->pIndex; p && !IsPrimaryKeyIndex(p); p=p->pNext){}
1091   return p;
1092 }
1093 
1094 /*
1095 ** Convert an table column number into a index column number.  That is,
1096 ** for the column iCol in the table (as defined by the CREATE TABLE statement)
1097 ** find the (first) offset of that column in index pIdx.  Or return -1
1098 ** if column iCol is not used in index pIdx.
1099 */
1100 i16 sqlite3TableColumnToIndex(Index *pIdx, i16 iCol){
1101   int i;
1102   for(i=0; i<pIdx->nColumn; i++){
1103     if( iCol==pIdx->aiColumn[i] ) return i;
1104   }
1105   return -1;
1106 }
1107 
1108 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1109 /* Convert a storage column number into a table column number.
1110 **
1111 ** The storage column number (0,1,2,....) is the index of the value
1112 ** as it appears in the record on disk.  The true column number
1113 ** is the index (0,1,2,...) of the column in the CREATE TABLE statement.
1114 **
1115 ** The storage column number is less than the table column number if
1116 ** and only there are VIRTUAL columns to the left.
1117 **
1118 ** If SQLITE_OMIT_GENERATED_COLUMNS, this routine is a no-op macro.
1119 */
1120 i16 sqlite3StorageColumnToTable(Table *pTab, i16 iCol){
1121   if( pTab->tabFlags & TF_HasVirtual ){
1122     int i;
1123     for(i=0; i<=iCol; i++){
1124       if( pTab->aCol[i].colFlags & COLFLAG_VIRTUAL ) iCol++;
1125     }
1126   }
1127   return iCol;
1128 }
1129 #endif
1130 
1131 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1132 /* Convert a table column number into a storage column number.
1133 **
1134 ** The storage column number (0,1,2,....) is the index of the value
1135 ** as it appears in the record on disk.  Or, if the input column is
1136 ** the N-th virtual column (zero-based) then the storage number is
1137 ** the number of non-virtual columns in the table plus N.
1138 **
1139 ** The true column number is the index (0,1,2,...) of the column in
1140 ** the CREATE TABLE statement.
1141 **
1142 ** If the input column is a VIRTUAL column, then it should not appear
1143 ** in storage.  But the value sometimes is cached in registers that
1144 ** follow the range of registers used to construct storage.  This
1145 ** avoids computing the same VIRTUAL column multiple times, and provides
1146 ** values for use by OP_Param opcodes in triggers.  Hence, if the
1147 ** input column is a VIRTUAL table, put it after all the other columns.
1148 **
1149 ** In the following, N means "normal column", S means STORED, and
1150 ** V means VIRTUAL.  Suppose the CREATE TABLE has columns like this:
1151 **
1152 **        CREATE TABLE ex(N,S,V,N,S,V,N,S,V);
1153 **                     -- 0 1 2 3 4 5 6 7 8
1154 **
1155 ** Then the mapping from this function is as follows:
1156 **
1157 **    INPUTS:     0 1 2 3 4 5 6 7 8
1158 **    OUTPUTS:    0 1 6 2 3 7 4 5 8
1159 **
1160 ** So, in other words, this routine shifts all the virtual columns to
1161 ** the end.
1162 **
1163 ** If SQLITE_OMIT_GENERATED_COLUMNS then there are no virtual columns and
1164 ** this routine is a no-op macro.  If the pTab does not have any virtual
1165 ** columns, then this routine is no-op that always return iCol.  If iCol
1166 ** is negative (indicating the ROWID column) then this routine return iCol.
1167 */
1168 i16 sqlite3TableColumnToStorage(Table *pTab, i16 iCol){
1169   int i;
1170   i16 n;
1171   assert( iCol<pTab->nCol );
1172   if( (pTab->tabFlags & TF_HasVirtual)==0 || iCol<0 ) return iCol;
1173   for(i=0, n=0; i<iCol; i++){
1174     if( (pTab->aCol[i].colFlags & COLFLAG_VIRTUAL)==0 ) n++;
1175   }
1176   if( pTab->aCol[i].colFlags & COLFLAG_VIRTUAL ){
1177     /* iCol is a virtual column itself */
1178     return pTab->nNVCol + i - n;
1179   }else{
1180     /* iCol is a normal or stored column */
1181     return n;
1182   }
1183 }
1184 #endif
1185 
1186 /*
1187 ** Insert a single OP_JournalMode query opcode in order to force the
1188 ** prepared statement to return false for sqlite3_stmt_readonly().  This
1189 ** is used by CREATE TABLE IF NOT EXISTS and similar if the table already
1190 ** exists, so that the prepared statement for CREATE TABLE IF NOT EXISTS
1191 ** will return false for sqlite3_stmt_readonly() even if that statement
1192 ** is a read-only no-op.
1193 */
1194 static void sqlite3ForceNotReadOnly(Parse *pParse){
1195   int iReg = ++pParse->nMem;
1196   Vdbe *v = sqlite3GetVdbe(pParse);
1197   if( v ){
1198     sqlite3VdbeAddOp3(v, OP_JournalMode, 0, iReg, PAGER_JOURNALMODE_QUERY);
1199     sqlite3VdbeUsesBtree(v, 0);
1200   }
1201 }
1202 
1203 /*
1204 ** Begin constructing a new table representation in memory.  This is
1205 ** the first of several action routines that get called in response
1206 ** to a CREATE TABLE statement.  In particular, this routine is called
1207 ** after seeing tokens "CREATE" and "TABLE" and the table name. The isTemp
1208 ** flag is true if the table should be stored in the auxiliary database
1209 ** file instead of in the main database file.  This is normally the case
1210 ** when the "TEMP" or "TEMPORARY" keyword occurs in between
1211 ** CREATE and TABLE.
1212 **
1213 ** The new table record is initialized and put in pParse->pNewTable.
1214 ** As more of the CREATE TABLE statement is parsed, additional action
1215 ** routines will be called to add more information to this record.
1216 ** At the end of the CREATE TABLE statement, the sqlite3EndTable() routine
1217 ** is called to complete the construction of the new table record.
1218 */
1219 void sqlite3StartTable(
1220   Parse *pParse,   /* Parser context */
1221   Token *pName1,   /* First part of the name of the table or view */
1222   Token *pName2,   /* Second part of the name of the table or view */
1223   int isTemp,      /* True if this is a TEMP table */
1224   int isView,      /* True if this is a VIEW */
1225   int isVirtual,   /* True if this is a VIRTUAL table */
1226   int noErr        /* Do nothing if table already exists */
1227 ){
1228   Table *pTable;
1229   char *zName = 0; /* The name of the new table */
1230   sqlite3 *db = pParse->db;
1231   Vdbe *v;
1232   int iDb;         /* Database number to create the table in */
1233   Token *pName;    /* Unqualified name of the table to create */
1234 
1235   if( db->init.busy && db->init.newTnum==1 ){
1236     /* Special case:  Parsing the sqlite_schema or sqlite_temp_schema schema */
1237     iDb = db->init.iDb;
1238     zName = sqlite3DbStrDup(db, SCHEMA_TABLE(iDb));
1239     pName = pName1;
1240   }else{
1241     /* The common case */
1242     iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pName);
1243     if( iDb<0 ) return;
1244     if( !OMIT_TEMPDB && isTemp && pName2->n>0 && iDb!=1 ){
1245       /* If creating a temp table, the name may not be qualified. Unless
1246       ** the database name is "temp" anyway.  */
1247       sqlite3ErrorMsg(pParse, "temporary table name must be unqualified");
1248       return;
1249     }
1250     if( !OMIT_TEMPDB && isTemp ) iDb = 1;
1251     zName = sqlite3NameFromToken(db, pName);
1252     if( IN_RENAME_OBJECT ){
1253       sqlite3RenameTokenMap(pParse, (void*)zName, pName);
1254     }
1255   }
1256   pParse->sNameToken = *pName;
1257   if( zName==0 ) return;
1258   if( sqlite3CheckObjectName(pParse, zName, isView?"view":"table", zName) ){
1259     goto begin_table_error;
1260   }
1261   if( db->init.iDb==1 ) isTemp = 1;
1262 #ifndef SQLITE_OMIT_AUTHORIZATION
1263   assert( isTemp==0 || isTemp==1 );
1264   assert( isView==0 || isView==1 );
1265   {
1266     static const u8 aCode[] = {
1267        SQLITE_CREATE_TABLE,
1268        SQLITE_CREATE_TEMP_TABLE,
1269        SQLITE_CREATE_VIEW,
1270        SQLITE_CREATE_TEMP_VIEW
1271     };
1272     char *zDb = db->aDb[iDb].zDbSName;
1273     if( sqlite3AuthCheck(pParse, SQLITE_INSERT, SCHEMA_TABLE(isTemp), 0, zDb) ){
1274       goto begin_table_error;
1275     }
1276     if( !isVirtual && sqlite3AuthCheck(pParse, (int)aCode[isTemp+2*isView],
1277                                        zName, 0, zDb) ){
1278       goto begin_table_error;
1279     }
1280   }
1281 #endif
1282 
1283   /* Make sure the new table name does not collide with an existing
1284   ** index or table name in the same database.  Issue an error message if
1285   ** it does. The exception is if the statement being parsed was passed
1286   ** to an sqlite3_declare_vtab() call. In that case only the column names
1287   ** and types will be used, so there is no need to test for namespace
1288   ** collisions.
1289   */
1290   if( !IN_SPECIAL_PARSE ){
1291     char *zDb = db->aDb[iDb].zDbSName;
1292     if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
1293       goto begin_table_error;
1294     }
1295     pTable = sqlite3FindTable(db, zName, zDb);
1296     if( pTable ){
1297       if( !noErr ){
1298         sqlite3ErrorMsg(pParse, "%s %T already exists",
1299                         (IsView(pTable)? "view" : "table"), pName);
1300       }else{
1301         assert( !db->init.busy || CORRUPT_DB );
1302         sqlite3CodeVerifySchema(pParse, iDb);
1303         sqlite3ForceNotReadOnly(pParse);
1304       }
1305       goto begin_table_error;
1306     }
1307     if( sqlite3FindIndex(db, zName, zDb)!=0 ){
1308       sqlite3ErrorMsg(pParse, "there is already an index named %s", zName);
1309       goto begin_table_error;
1310     }
1311   }
1312 
1313   pTable = sqlite3DbMallocZero(db, sizeof(Table));
1314   if( pTable==0 ){
1315     assert( db->mallocFailed );
1316     pParse->rc = SQLITE_NOMEM_BKPT;
1317     pParse->nErr++;
1318     goto begin_table_error;
1319   }
1320   pTable->zName = zName;
1321   pTable->iPKey = -1;
1322   pTable->pSchema = db->aDb[iDb].pSchema;
1323   pTable->nTabRef = 1;
1324 #ifdef SQLITE_DEFAULT_ROWEST
1325   pTable->nRowLogEst = sqlite3LogEst(SQLITE_DEFAULT_ROWEST);
1326 #else
1327   pTable->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
1328 #endif
1329   assert( pParse->pNewTable==0 );
1330   pParse->pNewTable = pTable;
1331 
1332   /* Begin generating the code that will insert the table record into
1333   ** the schema table.  Note in particular that we must go ahead
1334   ** and allocate the record number for the table entry now.  Before any
1335   ** PRIMARY KEY or UNIQUE keywords are parsed.  Those keywords will cause
1336   ** indices to be created and the table record must come before the
1337   ** indices.  Hence, the record number for the table must be allocated
1338   ** now.
1339   */
1340   if( !db->init.busy && (v = sqlite3GetVdbe(pParse))!=0 ){
1341     int addr1;
1342     int fileFormat;
1343     int reg1, reg2, reg3;
1344     /* nullRow[] is an OP_Record encoding of a row containing 5 NULLs */
1345     static const char nullRow[] = { 6, 0, 0, 0, 0, 0 };
1346     sqlite3BeginWriteOperation(pParse, 1, iDb);
1347 
1348 #ifndef SQLITE_OMIT_VIRTUALTABLE
1349     if( isVirtual ){
1350       sqlite3VdbeAddOp0(v, OP_VBegin);
1351     }
1352 #endif
1353 
1354     /* If the file format and encoding in the database have not been set,
1355     ** set them now.
1356     */
1357     reg1 = pParse->regRowid = ++pParse->nMem;
1358     reg2 = pParse->regRoot = ++pParse->nMem;
1359     reg3 = ++pParse->nMem;
1360     sqlite3VdbeAddOp3(v, OP_ReadCookie, iDb, reg3, BTREE_FILE_FORMAT);
1361     sqlite3VdbeUsesBtree(v, iDb);
1362     addr1 = sqlite3VdbeAddOp1(v, OP_If, reg3); VdbeCoverage(v);
1363     fileFormat = (db->flags & SQLITE_LegacyFileFmt)!=0 ?
1364                   1 : SQLITE_MAX_FILE_FORMAT;
1365     sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_FILE_FORMAT, fileFormat);
1366     sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_TEXT_ENCODING, ENC(db));
1367     sqlite3VdbeJumpHere(v, addr1);
1368 
1369     /* This just creates a place-holder record in the sqlite_schema table.
1370     ** The record created does not contain anything yet.  It will be replaced
1371     ** by the real entry in code generated at sqlite3EndTable().
1372     **
1373     ** The rowid for the new entry is left in register pParse->regRowid.
1374     ** The root page number of the new table is left in reg pParse->regRoot.
1375     ** The rowid and root page number values are needed by the code that
1376     ** sqlite3EndTable will generate.
1377     */
1378 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
1379     if( isView || isVirtual ){
1380       sqlite3VdbeAddOp2(v, OP_Integer, 0, reg2);
1381     }else
1382 #endif
1383     {
1384       assert( !pParse->bReturning );
1385       pParse->u1.addrCrTab =
1386          sqlite3VdbeAddOp3(v, OP_CreateBtree, iDb, reg2, BTREE_INTKEY);
1387     }
1388     sqlite3OpenSchemaTable(pParse, iDb);
1389     sqlite3VdbeAddOp2(v, OP_NewRowid, 0, reg1);
1390     sqlite3VdbeAddOp4(v, OP_Blob, 6, reg3, 0, nullRow, P4_STATIC);
1391     sqlite3VdbeAddOp3(v, OP_Insert, 0, reg3, reg1);
1392     sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1393     sqlite3VdbeAddOp0(v, OP_Close);
1394   }
1395 
1396   /* Normal (non-error) return. */
1397   return;
1398 
1399   /* If an error occurs, we jump here */
1400 begin_table_error:
1401   pParse->checkSchema = 1;
1402   sqlite3DbFree(db, zName);
1403   return;
1404 }
1405 
1406 /* Set properties of a table column based on the (magical)
1407 ** name of the column.
1408 */
1409 #if SQLITE_ENABLE_HIDDEN_COLUMNS
1410 void sqlite3ColumnPropertiesFromName(Table *pTab, Column *pCol){
1411   if( sqlite3_strnicmp(pCol->zCnName, "__hidden__", 10)==0 ){
1412     pCol->colFlags |= COLFLAG_HIDDEN;
1413     if( pTab ) pTab->tabFlags |= TF_HasHidden;
1414   }else if( pTab && pCol!=pTab->aCol && (pCol[-1].colFlags & COLFLAG_HIDDEN) ){
1415     pTab->tabFlags |= TF_OOOHidden;
1416   }
1417 }
1418 #endif
1419 
1420 /*
1421 ** Name of the special TEMP trigger used to implement RETURNING.  The
1422 ** name begins with "sqlite_" so that it is guaranteed not to collide
1423 ** with any application-generated triggers.
1424 */
1425 #define RETURNING_TRIGGER_NAME  "sqlite_returning"
1426 
1427 /*
1428 ** Clean up the data structures associated with the RETURNING clause.
1429 */
1430 static void sqlite3DeleteReturning(sqlite3 *db, Returning *pRet){
1431   Hash *pHash;
1432   pHash = &(db->aDb[1].pSchema->trigHash);
1433   sqlite3HashInsert(pHash, RETURNING_TRIGGER_NAME, 0);
1434   sqlite3ExprListDelete(db, pRet->pReturnEL);
1435   sqlite3DbFree(db, pRet);
1436 }
1437 
1438 /*
1439 ** Add the RETURNING clause to the parse currently underway.
1440 **
1441 ** This routine creates a special TEMP trigger that will fire for each row
1442 ** of the DML statement.  That TEMP trigger contains a single SELECT
1443 ** statement with a result set that is the argument of the RETURNING clause.
1444 ** The trigger has the Trigger.bReturning flag and an opcode of
1445 ** TK_RETURNING instead of TK_SELECT, so that the trigger code generator
1446 ** knows to handle it specially.  The TEMP trigger is automatically
1447 ** removed at the end of the parse.
1448 **
1449 ** When this routine is called, we do not yet know if the RETURNING clause
1450 ** is attached to a DELETE, INSERT, or UPDATE, so construct it as a
1451 ** RETURNING trigger instead.  It will then be converted into the appropriate
1452 ** type on the first call to sqlite3TriggersExist().
1453 */
1454 void sqlite3AddReturning(Parse *pParse, ExprList *pList){
1455   Returning *pRet;
1456   Hash *pHash;
1457   sqlite3 *db = pParse->db;
1458   if( pParse->pNewTrigger ){
1459     sqlite3ErrorMsg(pParse, "cannot use RETURNING in a trigger");
1460   }else{
1461     assert( pParse->bReturning==0 );
1462   }
1463   pParse->bReturning = 1;
1464   pRet = sqlite3DbMallocZero(db, sizeof(*pRet));
1465   if( pRet==0 ){
1466     sqlite3ExprListDelete(db, pList);
1467     return;
1468   }
1469   pParse->u1.pReturning = pRet;
1470   pRet->pParse = pParse;
1471   pRet->pReturnEL = pList;
1472   sqlite3ParserAddCleanup(pParse,
1473      (void(*)(sqlite3*,void*))sqlite3DeleteReturning, pRet);
1474   testcase( pParse->earlyCleanup );
1475   if( db->mallocFailed ) return;
1476   pRet->retTrig.zName = RETURNING_TRIGGER_NAME;
1477   pRet->retTrig.op = TK_RETURNING;
1478   pRet->retTrig.tr_tm = TRIGGER_AFTER;
1479   pRet->retTrig.bReturning = 1;
1480   pRet->retTrig.pSchema = db->aDb[1].pSchema;
1481   pRet->retTrig.pTabSchema = db->aDb[1].pSchema;
1482   pRet->retTrig.step_list = &pRet->retTStep;
1483   pRet->retTStep.op = TK_RETURNING;
1484   pRet->retTStep.pTrig = &pRet->retTrig;
1485   pRet->retTStep.pExprList = pList;
1486   pHash = &(db->aDb[1].pSchema->trigHash);
1487   assert( sqlite3HashFind(pHash, RETURNING_TRIGGER_NAME)==0 || pParse->nErr );
1488   if( sqlite3HashInsert(pHash, RETURNING_TRIGGER_NAME, &pRet->retTrig)
1489           ==&pRet->retTrig ){
1490     sqlite3OomFault(db);
1491   }
1492 }
1493 
1494 /*
1495 ** Add a new column to the table currently being constructed.
1496 **
1497 ** The parser calls this routine once for each column declaration
1498 ** in a CREATE TABLE statement.  sqlite3StartTable() gets called
1499 ** first to get things going.  Then this routine is called for each
1500 ** column.
1501 */
1502 void sqlite3AddColumn(Parse *pParse, Token sName, Token sType){
1503   Table *p;
1504   int i;
1505   char *z;
1506   char *zType;
1507   Column *pCol;
1508   sqlite3 *db = pParse->db;
1509   u8 hName;
1510   Column *aNew;
1511   u8 eType = COLTYPE_CUSTOM;
1512   u8 szEst = 1;
1513   char affinity = SQLITE_AFF_BLOB;
1514 
1515   if( (p = pParse->pNewTable)==0 ) return;
1516   if( p->nCol+1>db->aLimit[SQLITE_LIMIT_COLUMN] ){
1517     sqlite3ErrorMsg(pParse, "too many columns on %s", p->zName);
1518     return;
1519   }
1520   if( !IN_RENAME_OBJECT ) sqlite3DequoteToken(&sName);
1521 
1522   /* Because keywords GENERATE ALWAYS can be converted into indentifiers
1523   ** by the parser, we can sometimes end up with a typename that ends
1524   ** with "generated always".  Check for this case and omit the surplus
1525   ** text. */
1526   if( sType.n>=16
1527    && sqlite3_strnicmp(sType.z+(sType.n-6),"always",6)==0
1528   ){
1529     sType.n -= 6;
1530     while( ALWAYS(sType.n>0) && sqlite3Isspace(sType.z[sType.n-1]) ) sType.n--;
1531     if( sType.n>=9
1532      && sqlite3_strnicmp(sType.z+(sType.n-9),"generated",9)==0
1533     ){
1534       sType.n -= 9;
1535       while( sType.n>0 && sqlite3Isspace(sType.z[sType.n-1]) ) sType.n--;
1536     }
1537   }
1538 
1539   /* Check for standard typenames.  For standard typenames we will
1540   ** set the Column.eType field rather than storing the typename after
1541   ** the column name, in order to save space. */
1542   if( sType.n>=3 ){
1543     sqlite3DequoteToken(&sType);
1544     for(i=0; i<SQLITE_N_STDTYPE; i++){
1545        if( sType.n==sqlite3StdTypeLen[i]
1546         && sqlite3_strnicmp(sType.z, sqlite3StdType[i], sType.n)==0
1547        ){
1548          sType.n = 0;
1549          eType = i+1;
1550          affinity = sqlite3StdTypeAffinity[i];
1551          if( affinity<=SQLITE_AFF_TEXT ) szEst = 5;
1552          break;
1553        }
1554     }
1555   }
1556 
1557   z = sqlite3DbMallocRaw(db, (i64)sName.n + 1 + (i64)sType.n + (sType.n>0) );
1558   if( z==0 ) return;
1559   if( IN_RENAME_OBJECT ) sqlite3RenameTokenMap(pParse, (void*)z, &sName);
1560   memcpy(z, sName.z, sName.n);
1561   z[sName.n] = 0;
1562   sqlite3Dequote(z);
1563   hName = sqlite3StrIHash(z);
1564   for(i=0; i<p->nCol; i++){
1565     if( p->aCol[i].hName==hName && sqlite3StrICmp(z, p->aCol[i].zCnName)==0 ){
1566       sqlite3ErrorMsg(pParse, "duplicate column name: %s", z);
1567       sqlite3DbFree(db, z);
1568       return;
1569     }
1570   }
1571   aNew = sqlite3DbRealloc(db,p->aCol,((i64)p->nCol+1)*sizeof(p->aCol[0]));
1572   if( aNew==0 ){
1573     sqlite3DbFree(db, z);
1574     return;
1575   }
1576   p->aCol = aNew;
1577   pCol = &p->aCol[p->nCol];
1578   memset(pCol, 0, sizeof(p->aCol[0]));
1579   pCol->zCnName = z;
1580   pCol->hName = hName;
1581   sqlite3ColumnPropertiesFromName(p, pCol);
1582 
1583   if( sType.n==0 ){
1584     /* If there is no type specified, columns have the default affinity
1585     ** 'BLOB' with a default size of 4 bytes. */
1586     pCol->affinity = affinity;
1587     pCol->eCType = eType;
1588     pCol->szEst = szEst;
1589 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1590     if( affinity==SQLITE_AFF_BLOB ){
1591       if( 4>=sqlite3GlobalConfig.szSorterRef ){
1592         pCol->colFlags |= COLFLAG_SORTERREF;
1593       }
1594     }
1595 #endif
1596   }else{
1597     zType = z + sqlite3Strlen30(z) + 1;
1598     memcpy(zType, sType.z, sType.n);
1599     zType[sType.n] = 0;
1600     sqlite3Dequote(zType);
1601     pCol->affinity = sqlite3AffinityType(zType, pCol);
1602     pCol->colFlags |= COLFLAG_HASTYPE;
1603   }
1604   p->nCol++;
1605   p->nNVCol++;
1606   pParse->constraintName.n = 0;
1607 }
1608 
1609 /*
1610 ** This routine is called by the parser while in the middle of
1611 ** parsing a CREATE TABLE statement.  A "NOT NULL" constraint has
1612 ** been seen on a column.  This routine sets the notNull flag on
1613 ** the column currently under construction.
1614 */
1615 void sqlite3AddNotNull(Parse *pParse, int onError){
1616   Table *p;
1617   Column *pCol;
1618   p = pParse->pNewTable;
1619   if( p==0 || NEVER(p->nCol<1) ) return;
1620   pCol = &p->aCol[p->nCol-1];
1621   pCol->notNull = (u8)onError;
1622   p->tabFlags |= TF_HasNotNull;
1623 
1624   /* Set the uniqNotNull flag on any UNIQUE or PK indexes already created
1625   ** on this column.  */
1626   if( pCol->colFlags & COLFLAG_UNIQUE ){
1627     Index *pIdx;
1628     for(pIdx=p->pIndex; pIdx; pIdx=pIdx->pNext){
1629       assert( pIdx->nKeyCol==1 && pIdx->onError!=OE_None );
1630       if( pIdx->aiColumn[0]==p->nCol-1 ){
1631         pIdx->uniqNotNull = 1;
1632       }
1633     }
1634   }
1635 }
1636 
1637 /*
1638 ** Scan the column type name zType (length nType) and return the
1639 ** associated affinity type.
1640 **
1641 ** This routine does a case-independent search of zType for the
1642 ** substrings in the following table. If one of the substrings is
1643 ** found, the corresponding affinity is returned. If zType contains
1644 ** more than one of the substrings, entries toward the top of
1645 ** the table take priority. For example, if zType is 'BLOBINT',
1646 ** SQLITE_AFF_INTEGER is returned.
1647 **
1648 ** Substring     | Affinity
1649 ** --------------------------------
1650 ** 'INT'         | SQLITE_AFF_INTEGER
1651 ** 'CHAR'        | SQLITE_AFF_TEXT
1652 ** 'CLOB'        | SQLITE_AFF_TEXT
1653 ** 'TEXT'        | SQLITE_AFF_TEXT
1654 ** 'BLOB'        | SQLITE_AFF_BLOB
1655 ** 'REAL'        | SQLITE_AFF_REAL
1656 ** 'FLOA'        | SQLITE_AFF_REAL
1657 ** 'DOUB'        | SQLITE_AFF_REAL
1658 **
1659 ** If none of the substrings in the above table are found,
1660 ** SQLITE_AFF_NUMERIC is returned.
1661 */
1662 char sqlite3AffinityType(const char *zIn, Column *pCol){
1663   u32 h = 0;
1664   char aff = SQLITE_AFF_NUMERIC;
1665   const char *zChar = 0;
1666 
1667   assert( zIn!=0 );
1668   while( zIn[0] ){
1669     h = (h<<8) + sqlite3UpperToLower[(*zIn)&0xff];
1670     zIn++;
1671     if( h==(('c'<<24)+('h'<<16)+('a'<<8)+'r') ){             /* CHAR */
1672       aff = SQLITE_AFF_TEXT;
1673       zChar = zIn;
1674     }else if( h==(('c'<<24)+('l'<<16)+('o'<<8)+'b') ){       /* CLOB */
1675       aff = SQLITE_AFF_TEXT;
1676     }else if( h==(('t'<<24)+('e'<<16)+('x'<<8)+'t') ){       /* TEXT */
1677       aff = SQLITE_AFF_TEXT;
1678     }else if( h==(('b'<<24)+('l'<<16)+('o'<<8)+'b')          /* BLOB */
1679         && (aff==SQLITE_AFF_NUMERIC || aff==SQLITE_AFF_REAL) ){
1680       aff = SQLITE_AFF_BLOB;
1681       if( zIn[0]=='(' ) zChar = zIn;
1682 #ifndef SQLITE_OMIT_FLOATING_POINT
1683     }else if( h==(('r'<<24)+('e'<<16)+('a'<<8)+'l')          /* REAL */
1684         && aff==SQLITE_AFF_NUMERIC ){
1685       aff = SQLITE_AFF_REAL;
1686     }else if( h==(('f'<<24)+('l'<<16)+('o'<<8)+'a')          /* FLOA */
1687         && aff==SQLITE_AFF_NUMERIC ){
1688       aff = SQLITE_AFF_REAL;
1689     }else if( h==(('d'<<24)+('o'<<16)+('u'<<8)+'b')          /* DOUB */
1690         && aff==SQLITE_AFF_NUMERIC ){
1691       aff = SQLITE_AFF_REAL;
1692 #endif
1693     }else if( (h&0x00FFFFFF)==(('i'<<16)+('n'<<8)+'t') ){    /* INT */
1694       aff = SQLITE_AFF_INTEGER;
1695       break;
1696     }
1697   }
1698 
1699   /* If pCol is not NULL, store an estimate of the field size.  The
1700   ** estimate is scaled so that the size of an integer is 1.  */
1701   if( pCol ){
1702     int v = 0;   /* default size is approx 4 bytes */
1703     if( aff<SQLITE_AFF_NUMERIC ){
1704       if( zChar ){
1705         while( zChar[0] ){
1706           if( sqlite3Isdigit(zChar[0]) ){
1707             /* BLOB(k), VARCHAR(k), CHAR(k) -> r=(k/4+1) */
1708             sqlite3GetInt32(zChar, &v);
1709             break;
1710           }
1711           zChar++;
1712         }
1713       }else{
1714         v = 16;   /* BLOB, TEXT, CLOB -> r=5  (approx 20 bytes)*/
1715       }
1716     }
1717 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1718     if( v>=sqlite3GlobalConfig.szSorterRef ){
1719       pCol->colFlags |= COLFLAG_SORTERREF;
1720     }
1721 #endif
1722     v = v/4 + 1;
1723     if( v>255 ) v = 255;
1724     pCol->szEst = v;
1725   }
1726   return aff;
1727 }
1728 
1729 /*
1730 ** The expression is the default value for the most recently added column
1731 ** of the table currently under construction.
1732 **
1733 ** Default value expressions must be constant.  Raise an exception if this
1734 ** is not the case.
1735 **
1736 ** This routine is called by the parser while in the middle of
1737 ** parsing a CREATE TABLE statement.
1738 */
1739 void sqlite3AddDefaultValue(
1740   Parse *pParse,           /* Parsing context */
1741   Expr *pExpr,             /* The parsed expression of the default value */
1742   const char *zStart,      /* Start of the default value text */
1743   const char *zEnd         /* First character past end of defaut value text */
1744 ){
1745   Table *p;
1746   Column *pCol;
1747   sqlite3 *db = pParse->db;
1748   p = pParse->pNewTable;
1749   if( p!=0 ){
1750     int isInit = db->init.busy && db->init.iDb!=1;
1751     pCol = &(p->aCol[p->nCol-1]);
1752     if( !sqlite3ExprIsConstantOrFunction(pExpr, isInit) ){
1753       sqlite3ErrorMsg(pParse, "default value of column [%s] is not constant",
1754           pCol->zCnName);
1755 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1756     }else if( pCol->colFlags & COLFLAG_GENERATED ){
1757       testcase( pCol->colFlags & COLFLAG_VIRTUAL );
1758       testcase( pCol->colFlags & COLFLAG_STORED );
1759       sqlite3ErrorMsg(pParse, "cannot use DEFAULT on a generated column");
1760 #endif
1761     }else{
1762       /* A copy of pExpr is used instead of the original, as pExpr contains
1763       ** tokens that point to volatile memory.
1764       */
1765       Expr x, *pDfltExpr;
1766       memset(&x, 0, sizeof(x));
1767       x.op = TK_SPAN;
1768       x.u.zToken = sqlite3DbSpanDup(db, zStart, zEnd);
1769       x.pLeft = pExpr;
1770       x.flags = EP_Skip;
1771       pDfltExpr = sqlite3ExprDup(db, &x, EXPRDUP_REDUCE);
1772       sqlite3DbFree(db, x.u.zToken);
1773       sqlite3ColumnSetExpr(pParse, p, pCol, pDfltExpr);
1774     }
1775   }
1776   if( IN_RENAME_OBJECT ){
1777     sqlite3RenameExprUnmap(pParse, pExpr);
1778   }
1779   sqlite3ExprDelete(db, pExpr);
1780 }
1781 
1782 /*
1783 ** Backwards Compatibility Hack:
1784 **
1785 ** Historical versions of SQLite accepted strings as column names in
1786 ** indexes and PRIMARY KEY constraints and in UNIQUE constraints.  Example:
1787 **
1788 **     CREATE TABLE xyz(a,b,c,d,e,PRIMARY KEY('a'),UNIQUE('b','c' COLLATE trim)
1789 **     CREATE INDEX abc ON xyz('c','d' DESC,'e' COLLATE nocase DESC);
1790 **
1791 ** This is goofy.  But to preserve backwards compatibility we continue to
1792 ** accept it.  This routine does the necessary conversion.  It converts
1793 ** the expression given in its argument from a TK_STRING into a TK_ID
1794 ** if the expression is just a TK_STRING with an optional COLLATE clause.
1795 ** If the expression is anything other than TK_STRING, the expression is
1796 ** unchanged.
1797 */
1798 static void sqlite3StringToId(Expr *p){
1799   if( p->op==TK_STRING ){
1800     p->op = TK_ID;
1801   }else if( p->op==TK_COLLATE && p->pLeft->op==TK_STRING ){
1802     p->pLeft->op = TK_ID;
1803   }
1804 }
1805 
1806 /*
1807 ** Tag the given column as being part of the PRIMARY KEY
1808 */
1809 static void makeColumnPartOfPrimaryKey(Parse *pParse, Column *pCol){
1810   pCol->colFlags |= COLFLAG_PRIMKEY;
1811 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1812   if( pCol->colFlags & COLFLAG_GENERATED ){
1813     testcase( pCol->colFlags & COLFLAG_VIRTUAL );
1814     testcase( pCol->colFlags & COLFLAG_STORED );
1815     sqlite3ErrorMsg(pParse,
1816       "generated columns cannot be part of the PRIMARY KEY");
1817   }
1818 #endif
1819 }
1820 
1821 /*
1822 ** Designate the PRIMARY KEY for the table.  pList is a list of names
1823 ** of columns that form the primary key.  If pList is NULL, then the
1824 ** most recently added column of the table is the primary key.
1825 **
1826 ** A table can have at most one primary key.  If the table already has
1827 ** a primary key (and this is the second primary key) then create an
1828 ** error.
1829 **
1830 ** If the PRIMARY KEY is on a single column whose datatype is INTEGER,
1831 ** then we will try to use that column as the rowid.  Set the Table.iPKey
1832 ** field of the table under construction to be the index of the
1833 ** INTEGER PRIMARY KEY column.  Table.iPKey is set to -1 if there is
1834 ** no INTEGER PRIMARY KEY.
1835 **
1836 ** If the key is not an INTEGER PRIMARY KEY, then create a unique
1837 ** index for the key.  No index is created for INTEGER PRIMARY KEYs.
1838 */
1839 void sqlite3AddPrimaryKey(
1840   Parse *pParse,    /* Parsing context */
1841   ExprList *pList,  /* List of field names to be indexed */
1842   int onError,      /* What to do with a uniqueness conflict */
1843   int autoInc,      /* True if the AUTOINCREMENT keyword is present */
1844   int sortOrder     /* SQLITE_SO_ASC or SQLITE_SO_DESC */
1845 ){
1846   Table *pTab = pParse->pNewTable;
1847   Column *pCol = 0;
1848   int iCol = -1, i;
1849   int nTerm;
1850   if( pTab==0 ) goto primary_key_exit;
1851   if( pTab->tabFlags & TF_HasPrimaryKey ){
1852     sqlite3ErrorMsg(pParse,
1853       "table \"%s\" has more than one primary key", pTab->zName);
1854     goto primary_key_exit;
1855   }
1856   pTab->tabFlags |= TF_HasPrimaryKey;
1857   if( pList==0 ){
1858     iCol = pTab->nCol - 1;
1859     pCol = &pTab->aCol[iCol];
1860     makeColumnPartOfPrimaryKey(pParse, pCol);
1861     nTerm = 1;
1862   }else{
1863     nTerm = pList->nExpr;
1864     for(i=0; i<nTerm; i++){
1865       Expr *pCExpr = sqlite3ExprSkipCollate(pList->a[i].pExpr);
1866       assert( pCExpr!=0 );
1867       sqlite3StringToId(pCExpr);
1868       if( pCExpr->op==TK_ID ){
1869         const char *zCName;
1870         assert( !ExprHasProperty(pCExpr, EP_IntValue) );
1871         zCName = pCExpr->u.zToken;
1872         for(iCol=0; iCol<pTab->nCol; iCol++){
1873           if( sqlite3StrICmp(zCName, pTab->aCol[iCol].zCnName)==0 ){
1874             pCol = &pTab->aCol[iCol];
1875             makeColumnPartOfPrimaryKey(pParse, pCol);
1876             break;
1877           }
1878         }
1879       }
1880     }
1881   }
1882   if( nTerm==1
1883    && pCol
1884    && pCol->eCType==COLTYPE_INTEGER
1885    && sortOrder!=SQLITE_SO_DESC
1886   ){
1887     if( IN_RENAME_OBJECT && pList ){
1888       Expr *pCExpr = sqlite3ExprSkipCollate(pList->a[0].pExpr);
1889       sqlite3RenameTokenRemap(pParse, &pTab->iPKey, pCExpr);
1890     }
1891     pTab->iPKey = iCol;
1892     pTab->keyConf = (u8)onError;
1893     assert( autoInc==0 || autoInc==1 );
1894     pTab->tabFlags |= autoInc*TF_Autoincrement;
1895     if( pList ) pParse->iPkSortOrder = pList->a[0].sortFlags;
1896     (void)sqlite3HasExplicitNulls(pParse, pList);
1897   }else if( autoInc ){
1898 #ifndef SQLITE_OMIT_AUTOINCREMENT
1899     sqlite3ErrorMsg(pParse, "AUTOINCREMENT is only allowed on an "
1900        "INTEGER PRIMARY KEY");
1901 #endif
1902   }else{
1903     sqlite3CreateIndex(pParse, 0, 0, 0, pList, onError, 0,
1904                            0, sortOrder, 0, SQLITE_IDXTYPE_PRIMARYKEY);
1905     pList = 0;
1906   }
1907 
1908 primary_key_exit:
1909   sqlite3ExprListDelete(pParse->db, pList);
1910   return;
1911 }
1912 
1913 /*
1914 ** Add a new CHECK constraint to the table currently under construction.
1915 */
1916 void sqlite3AddCheckConstraint(
1917   Parse *pParse,      /* Parsing context */
1918   Expr *pCheckExpr,   /* The check expression */
1919   const char *zStart, /* Opening "(" */
1920   const char *zEnd    /* Closing ")" */
1921 ){
1922 #ifndef SQLITE_OMIT_CHECK
1923   Table *pTab = pParse->pNewTable;
1924   sqlite3 *db = pParse->db;
1925   if( pTab && !IN_DECLARE_VTAB
1926    && !sqlite3BtreeIsReadonly(db->aDb[db->init.iDb].pBt)
1927   ){
1928     pTab->pCheck = sqlite3ExprListAppend(pParse, pTab->pCheck, pCheckExpr);
1929     if( pParse->constraintName.n ){
1930       sqlite3ExprListSetName(pParse, pTab->pCheck, &pParse->constraintName, 1);
1931     }else{
1932       Token t;
1933       for(zStart++; sqlite3Isspace(zStart[0]); zStart++){}
1934       while( sqlite3Isspace(zEnd[-1]) ){ zEnd--; }
1935       t.z = zStart;
1936       t.n = (int)(zEnd - t.z);
1937       sqlite3ExprListSetName(pParse, pTab->pCheck, &t, 1);
1938     }
1939   }else
1940 #endif
1941   {
1942     sqlite3ExprDelete(pParse->db, pCheckExpr);
1943   }
1944 }
1945 
1946 /*
1947 ** Set the collation function of the most recently parsed table column
1948 ** to the CollSeq given.
1949 */
1950 void sqlite3AddCollateType(Parse *pParse, Token *pToken){
1951   Table *p;
1952   int i;
1953   char *zColl;              /* Dequoted name of collation sequence */
1954   sqlite3 *db;
1955 
1956   if( (p = pParse->pNewTable)==0 || IN_RENAME_OBJECT ) return;
1957   i = p->nCol-1;
1958   db = pParse->db;
1959   zColl = sqlite3NameFromToken(db, pToken);
1960   if( !zColl ) return;
1961 
1962   if( sqlite3LocateCollSeq(pParse, zColl) ){
1963     Index *pIdx;
1964     sqlite3ColumnSetColl(db, &p->aCol[i], zColl);
1965 
1966     /* If the column is declared as "<name> PRIMARY KEY COLLATE <type>",
1967     ** then an index may have been created on this column before the
1968     ** collation type was added. Correct this if it is the case.
1969     */
1970     for(pIdx=p->pIndex; pIdx; pIdx=pIdx->pNext){
1971       assert( pIdx->nKeyCol==1 );
1972       if( pIdx->aiColumn[0]==i ){
1973         pIdx->azColl[0] = sqlite3ColumnColl(&p->aCol[i]);
1974       }
1975     }
1976   }
1977   sqlite3DbFree(db, zColl);
1978 }
1979 
1980 /* Change the most recently parsed column to be a GENERATED ALWAYS AS
1981 ** column.
1982 */
1983 void sqlite3AddGenerated(Parse *pParse, Expr *pExpr, Token *pType){
1984 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1985   u8 eType = COLFLAG_VIRTUAL;
1986   Table *pTab = pParse->pNewTable;
1987   Column *pCol;
1988   if( pTab==0 ){
1989     /* generated column in an CREATE TABLE IF NOT EXISTS that already exists */
1990     goto generated_done;
1991   }
1992   pCol = &(pTab->aCol[pTab->nCol-1]);
1993   if( IN_DECLARE_VTAB ){
1994     sqlite3ErrorMsg(pParse, "virtual tables cannot use computed columns");
1995     goto generated_done;
1996   }
1997   if( pCol->iDflt>0 ) goto generated_error;
1998   if( pType ){
1999     if( pType->n==7 && sqlite3StrNICmp("virtual",pType->z,7)==0 ){
2000       /* no-op */
2001     }else if( pType->n==6 && sqlite3StrNICmp("stored",pType->z,6)==0 ){
2002       eType = COLFLAG_STORED;
2003     }else{
2004       goto generated_error;
2005     }
2006   }
2007   if( eType==COLFLAG_VIRTUAL ) pTab->nNVCol--;
2008   pCol->colFlags |= eType;
2009   assert( TF_HasVirtual==COLFLAG_VIRTUAL );
2010   assert( TF_HasStored==COLFLAG_STORED );
2011   pTab->tabFlags |= eType;
2012   if( pCol->colFlags & COLFLAG_PRIMKEY ){
2013     makeColumnPartOfPrimaryKey(pParse, pCol); /* For the error message */
2014   }
2015   sqlite3ColumnSetExpr(pParse, pTab, pCol, pExpr);
2016   pExpr = 0;
2017   goto generated_done;
2018 
2019 generated_error:
2020   sqlite3ErrorMsg(pParse, "error in generated column \"%s\"",
2021                   pCol->zCnName);
2022 generated_done:
2023   sqlite3ExprDelete(pParse->db, pExpr);
2024 #else
2025   /* Throw and error for the GENERATED ALWAYS AS clause if the
2026   ** SQLITE_OMIT_GENERATED_COLUMNS compile-time option is used. */
2027   sqlite3ErrorMsg(pParse, "generated columns not supported");
2028   sqlite3ExprDelete(pParse->db, pExpr);
2029 #endif
2030 }
2031 
2032 /*
2033 ** Generate code that will increment the schema cookie.
2034 **
2035 ** The schema cookie is used to determine when the schema for the
2036 ** database changes.  After each schema change, the cookie value
2037 ** changes.  When a process first reads the schema it records the
2038 ** cookie.  Thereafter, whenever it goes to access the database,
2039 ** it checks the cookie to make sure the schema has not changed
2040 ** since it was last read.
2041 **
2042 ** This plan is not completely bullet-proof.  It is possible for
2043 ** the schema to change multiple times and for the cookie to be
2044 ** set back to prior value.  But schema changes are infrequent
2045 ** and the probability of hitting the same cookie value is only
2046 ** 1 chance in 2^32.  So we're safe enough.
2047 **
2048 ** IMPLEMENTATION-OF: R-34230-56049 SQLite automatically increments
2049 ** the schema-version whenever the schema changes.
2050 */
2051 void sqlite3ChangeCookie(Parse *pParse, int iDb){
2052   sqlite3 *db = pParse->db;
2053   Vdbe *v = pParse->pVdbe;
2054   assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
2055   sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_SCHEMA_VERSION,
2056                    (int)(1+(unsigned)db->aDb[iDb].pSchema->schema_cookie));
2057 }
2058 
2059 /*
2060 ** Measure the number of characters needed to output the given
2061 ** identifier.  The number returned includes any quotes used
2062 ** but does not include the null terminator.
2063 **
2064 ** The estimate is conservative.  It might be larger that what is
2065 ** really needed.
2066 */
2067 static int identLength(const char *z){
2068   int n;
2069   for(n=0; *z; n++, z++){
2070     if( *z=='"' ){ n++; }
2071   }
2072   return n + 2;
2073 }
2074 
2075 /*
2076 ** The first parameter is a pointer to an output buffer. The second
2077 ** parameter is a pointer to an integer that contains the offset at
2078 ** which to write into the output buffer. This function copies the
2079 ** nul-terminated string pointed to by the third parameter, zSignedIdent,
2080 ** to the specified offset in the buffer and updates *pIdx to refer
2081 ** to the first byte after the last byte written before returning.
2082 **
2083 ** If the string zSignedIdent consists entirely of alpha-numeric
2084 ** characters, does not begin with a digit and is not an SQL keyword,
2085 ** then it is copied to the output buffer exactly as it is. Otherwise,
2086 ** it is quoted using double-quotes.
2087 */
2088 static void identPut(char *z, int *pIdx, char *zSignedIdent){
2089   unsigned char *zIdent = (unsigned char*)zSignedIdent;
2090   int i, j, needQuote;
2091   i = *pIdx;
2092 
2093   for(j=0; zIdent[j]; j++){
2094     if( !sqlite3Isalnum(zIdent[j]) && zIdent[j]!='_' ) break;
2095   }
2096   needQuote = sqlite3Isdigit(zIdent[0])
2097             || sqlite3KeywordCode(zIdent, j)!=TK_ID
2098             || zIdent[j]!=0
2099             || j==0;
2100 
2101   if( needQuote ) z[i++] = '"';
2102   for(j=0; zIdent[j]; j++){
2103     z[i++] = zIdent[j];
2104     if( zIdent[j]=='"' ) z[i++] = '"';
2105   }
2106   if( needQuote ) z[i++] = '"';
2107   z[i] = 0;
2108   *pIdx = i;
2109 }
2110 
2111 /*
2112 ** Generate a CREATE TABLE statement appropriate for the given
2113 ** table.  Memory to hold the text of the statement is obtained
2114 ** from sqliteMalloc() and must be freed by the calling function.
2115 */
2116 static char *createTableStmt(sqlite3 *db, Table *p){
2117   int i, k, n;
2118   char *zStmt;
2119   char *zSep, *zSep2, *zEnd;
2120   Column *pCol;
2121   n = 0;
2122   for(pCol = p->aCol, i=0; i<p->nCol; i++, pCol++){
2123     n += identLength(pCol->zCnName) + 5;
2124   }
2125   n += identLength(p->zName);
2126   if( n<50 ){
2127     zSep = "";
2128     zSep2 = ",";
2129     zEnd = ")";
2130   }else{
2131     zSep = "\n  ";
2132     zSep2 = ",\n  ";
2133     zEnd = "\n)";
2134   }
2135   n += 35 + 6*p->nCol;
2136   zStmt = sqlite3DbMallocRaw(0, n);
2137   if( zStmt==0 ){
2138     sqlite3OomFault(db);
2139     return 0;
2140   }
2141   sqlite3_snprintf(n, zStmt, "CREATE TABLE ");
2142   k = sqlite3Strlen30(zStmt);
2143   identPut(zStmt, &k, p->zName);
2144   zStmt[k++] = '(';
2145   for(pCol=p->aCol, i=0; i<p->nCol; i++, pCol++){
2146     static const char * const azType[] = {
2147         /* SQLITE_AFF_BLOB    */ "",
2148         /* SQLITE_AFF_TEXT    */ " TEXT",
2149         /* SQLITE_AFF_NUMERIC */ " NUM",
2150         /* SQLITE_AFF_INTEGER */ " INT",
2151         /* SQLITE_AFF_REAL    */ " REAL"
2152     };
2153     int len;
2154     const char *zType;
2155 
2156     sqlite3_snprintf(n-k, &zStmt[k], zSep);
2157     k += sqlite3Strlen30(&zStmt[k]);
2158     zSep = zSep2;
2159     identPut(zStmt, &k, pCol->zCnName);
2160     assert( pCol->affinity-SQLITE_AFF_BLOB >= 0 );
2161     assert( pCol->affinity-SQLITE_AFF_BLOB < ArraySize(azType) );
2162     testcase( pCol->affinity==SQLITE_AFF_BLOB );
2163     testcase( pCol->affinity==SQLITE_AFF_TEXT );
2164     testcase( pCol->affinity==SQLITE_AFF_NUMERIC );
2165     testcase( pCol->affinity==SQLITE_AFF_INTEGER );
2166     testcase( pCol->affinity==SQLITE_AFF_REAL );
2167 
2168     zType = azType[pCol->affinity - SQLITE_AFF_BLOB];
2169     len = sqlite3Strlen30(zType);
2170     assert( pCol->affinity==SQLITE_AFF_BLOB
2171             || pCol->affinity==sqlite3AffinityType(zType, 0) );
2172     memcpy(&zStmt[k], zType, len);
2173     k += len;
2174     assert( k<=n );
2175   }
2176   sqlite3_snprintf(n-k, &zStmt[k], "%s", zEnd);
2177   return zStmt;
2178 }
2179 
2180 /*
2181 ** Resize an Index object to hold N columns total.  Return SQLITE_OK
2182 ** on success and SQLITE_NOMEM on an OOM error.
2183 */
2184 static int resizeIndexObject(sqlite3 *db, Index *pIdx, int N){
2185   char *zExtra;
2186   int nByte;
2187   if( pIdx->nColumn>=N ) return SQLITE_OK;
2188   assert( pIdx->isResized==0 );
2189   nByte = (sizeof(char*) + sizeof(LogEst) + sizeof(i16) + 1)*N;
2190   zExtra = sqlite3DbMallocZero(db, nByte);
2191   if( zExtra==0 ) return SQLITE_NOMEM_BKPT;
2192   memcpy(zExtra, pIdx->azColl, sizeof(char*)*pIdx->nColumn);
2193   pIdx->azColl = (const char**)zExtra;
2194   zExtra += sizeof(char*)*N;
2195   memcpy(zExtra, pIdx->aiRowLogEst, sizeof(LogEst)*(pIdx->nKeyCol+1));
2196   pIdx->aiRowLogEst = (LogEst*)zExtra;
2197   zExtra += sizeof(LogEst)*N;
2198   memcpy(zExtra, pIdx->aiColumn, sizeof(i16)*pIdx->nColumn);
2199   pIdx->aiColumn = (i16*)zExtra;
2200   zExtra += sizeof(i16)*N;
2201   memcpy(zExtra, pIdx->aSortOrder, pIdx->nColumn);
2202   pIdx->aSortOrder = (u8*)zExtra;
2203   pIdx->nColumn = N;
2204   pIdx->isResized = 1;
2205   return SQLITE_OK;
2206 }
2207 
2208 /*
2209 ** Estimate the total row width for a table.
2210 */
2211 static void estimateTableWidth(Table *pTab){
2212   unsigned wTable = 0;
2213   const Column *pTabCol;
2214   int i;
2215   for(i=pTab->nCol, pTabCol=pTab->aCol; i>0; i--, pTabCol++){
2216     wTable += pTabCol->szEst;
2217   }
2218   if( pTab->iPKey<0 ) wTable++;
2219   pTab->szTabRow = sqlite3LogEst(wTable*4);
2220 }
2221 
2222 /*
2223 ** Estimate the average size of a row for an index.
2224 */
2225 static void estimateIndexWidth(Index *pIdx){
2226   unsigned wIndex = 0;
2227   int i;
2228   const Column *aCol = pIdx->pTable->aCol;
2229   for(i=0; i<pIdx->nColumn; i++){
2230     i16 x = pIdx->aiColumn[i];
2231     assert( x<pIdx->pTable->nCol );
2232     wIndex += x<0 ? 1 : aCol[pIdx->aiColumn[i]].szEst;
2233   }
2234   pIdx->szIdxRow = sqlite3LogEst(wIndex*4);
2235 }
2236 
2237 /* Return true if column number x is any of the first nCol entries of aiCol[].
2238 ** This is used to determine if the column number x appears in any of the
2239 ** first nCol entries of an index.
2240 */
2241 static int hasColumn(const i16 *aiCol, int nCol, int x){
2242   while( nCol-- > 0 ){
2243     if( x==*(aiCol++) ){
2244       return 1;
2245     }
2246   }
2247   return 0;
2248 }
2249 
2250 /*
2251 ** Return true if any of the first nKey entries of index pIdx exactly
2252 ** match the iCol-th entry of pPk.  pPk is always a WITHOUT ROWID
2253 ** PRIMARY KEY index.  pIdx is an index on the same table.  pIdx may
2254 ** or may not be the same index as pPk.
2255 **
2256 ** The first nKey entries of pIdx are guaranteed to be ordinary columns,
2257 ** not a rowid or expression.
2258 **
2259 ** This routine differs from hasColumn() in that both the column and the
2260 ** collating sequence must match for this routine, but for hasColumn() only
2261 ** the column name must match.
2262 */
2263 static int isDupColumn(Index *pIdx, int nKey, Index *pPk, int iCol){
2264   int i, j;
2265   assert( nKey<=pIdx->nColumn );
2266   assert( iCol<MAX(pPk->nColumn,pPk->nKeyCol) );
2267   assert( pPk->idxType==SQLITE_IDXTYPE_PRIMARYKEY );
2268   assert( pPk->pTable->tabFlags & TF_WithoutRowid );
2269   assert( pPk->pTable==pIdx->pTable );
2270   testcase( pPk==pIdx );
2271   j = pPk->aiColumn[iCol];
2272   assert( j!=XN_ROWID && j!=XN_EXPR );
2273   for(i=0; i<nKey; i++){
2274     assert( pIdx->aiColumn[i]>=0 || j>=0 );
2275     if( pIdx->aiColumn[i]==j
2276      && sqlite3StrICmp(pIdx->azColl[i], pPk->azColl[iCol])==0
2277     ){
2278       return 1;
2279     }
2280   }
2281   return 0;
2282 }
2283 
2284 /* Recompute the colNotIdxed field of the Index.
2285 **
2286 ** colNotIdxed is a bitmask that has a 0 bit representing each indexed
2287 ** columns that are within the first 63 columns of the table.  The
2288 ** high-order bit of colNotIdxed is always 1.  All unindexed columns
2289 ** of the table have a 1.
2290 **
2291 ** 2019-10-24:  For the purpose of this computation, virtual columns are
2292 ** not considered to be covered by the index, even if they are in the
2293 ** index, because we do not trust the logic in whereIndexExprTrans() to be
2294 ** able to find all instances of a reference to the indexed table column
2295 ** and convert them into references to the index.  Hence we always want
2296 ** the actual table at hand in order to recompute the virtual column, if
2297 ** necessary.
2298 **
2299 ** The colNotIdxed mask is AND-ed with the SrcList.a[].colUsed mask
2300 ** to determine if the index is covering index.
2301 */
2302 static void recomputeColumnsNotIndexed(Index *pIdx){
2303   Bitmask m = 0;
2304   int j;
2305   Table *pTab = pIdx->pTable;
2306   for(j=pIdx->nColumn-1; j>=0; j--){
2307     int x = pIdx->aiColumn[j];
2308     if( x>=0 && (pTab->aCol[x].colFlags & COLFLAG_VIRTUAL)==0 ){
2309       testcase( x==BMS-1 );
2310       testcase( x==BMS-2 );
2311       if( x<BMS-1 ) m |= MASKBIT(x);
2312     }
2313   }
2314   pIdx->colNotIdxed = ~m;
2315   assert( (pIdx->colNotIdxed>>63)==1 );
2316 }
2317 
2318 /*
2319 ** This routine runs at the end of parsing a CREATE TABLE statement that
2320 ** has a WITHOUT ROWID clause.  The job of this routine is to convert both
2321 ** internal schema data structures and the generated VDBE code so that they
2322 ** are appropriate for a WITHOUT ROWID table instead of a rowid table.
2323 ** Changes include:
2324 **
2325 **     (1)  Set all columns of the PRIMARY KEY schema object to be NOT NULL.
2326 **     (2)  Convert P3 parameter of the OP_CreateBtree from BTREE_INTKEY
2327 **          into BTREE_BLOBKEY.
2328 **     (3)  Bypass the creation of the sqlite_schema table entry
2329 **          for the PRIMARY KEY as the primary key index is now
2330 **          identified by the sqlite_schema table entry of the table itself.
2331 **     (4)  Set the Index.tnum of the PRIMARY KEY Index object in the
2332 **          schema to the rootpage from the main table.
2333 **     (5)  Add all table columns to the PRIMARY KEY Index object
2334 **          so that the PRIMARY KEY is a covering index.  The surplus
2335 **          columns are part of KeyInfo.nAllField and are not used for
2336 **          sorting or lookup or uniqueness checks.
2337 **     (6)  Replace the rowid tail on all automatically generated UNIQUE
2338 **          indices with the PRIMARY KEY columns.
2339 **
2340 ** For virtual tables, only (1) is performed.
2341 */
2342 static void convertToWithoutRowidTable(Parse *pParse, Table *pTab){
2343   Index *pIdx;
2344   Index *pPk;
2345   int nPk;
2346   int nExtra;
2347   int i, j;
2348   sqlite3 *db = pParse->db;
2349   Vdbe *v = pParse->pVdbe;
2350 
2351   /* Mark every PRIMARY KEY column as NOT NULL (except for imposter tables)
2352   */
2353   if( !db->init.imposterTable ){
2354     for(i=0; i<pTab->nCol; i++){
2355       if( (pTab->aCol[i].colFlags & COLFLAG_PRIMKEY)!=0
2356        && (pTab->aCol[i].notNull==OE_None)
2357       ){
2358         pTab->aCol[i].notNull = OE_Abort;
2359       }
2360     }
2361     pTab->tabFlags |= TF_HasNotNull;
2362   }
2363 
2364   /* Convert the P3 operand of the OP_CreateBtree opcode from BTREE_INTKEY
2365   ** into BTREE_BLOBKEY.
2366   */
2367   assert( !pParse->bReturning );
2368   if( pParse->u1.addrCrTab ){
2369     assert( v );
2370     sqlite3VdbeChangeP3(v, pParse->u1.addrCrTab, BTREE_BLOBKEY);
2371   }
2372 
2373   /* Locate the PRIMARY KEY index.  Or, if this table was originally
2374   ** an INTEGER PRIMARY KEY table, create a new PRIMARY KEY index.
2375   */
2376   if( pTab->iPKey>=0 ){
2377     ExprList *pList;
2378     Token ipkToken;
2379     sqlite3TokenInit(&ipkToken, pTab->aCol[pTab->iPKey].zCnName);
2380     pList = sqlite3ExprListAppend(pParse, 0,
2381                   sqlite3ExprAlloc(db, TK_ID, &ipkToken, 0));
2382     if( pList==0 ){
2383       pTab->tabFlags &= ~TF_WithoutRowid;
2384       return;
2385     }
2386     if( IN_RENAME_OBJECT ){
2387       sqlite3RenameTokenRemap(pParse, pList->a[0].pExpr, &pTab->iPKey);
2388     }
2389     pList->a[0].sortFlags = pParse->iPkSortOrder;
2390     assert( pParse->pNewTable==pTab );
2391     pTab->iPKey = -1;
2392     sqlite3CreateIndex(pParse, 0, 0, 0, pList, pTab->keyConf, 0, 0, 0, 0,
2393                        SQLITE_IDXTYPE_PRIMARYKEY);
2394     if( pParse->nErr ){
2395       pTab->tabFlags &= ~TF_WithoutRowid;
2396       return;
2397     }
2398     assert( db->mallocFailed==0 );
2399     pPk = sqlite3PrimaryKeyIndex(pTab);
2400     assert( pPk->nKeyCol==1 );
2401   }else{
2402     pPk = sqlite3PrimaryKeyIndex(pTab);
2403     assert( pPk!=0 );
2404 
2405     /*
2406     ** Remove all redundant columns from the PRIMARY KEY.  For example, change
2407     ** "PRIMARY KEY(a,b,a,b,c,b,c,d)" into just "PRIMARY KEY(a,b,c,d)".  Later
2408     ** code assumes the PRIMARY KEY contains no repeated columns.
2409     */
2410     for(i=j=1; i<pPk->nKeyCol; i++){
2411       if( isDupColumn(pPk, j, pPk, i) ){
2412         pPk->nColumn--;
2413       }else{
2414         testcase( hasColumn(pPk->aiColumn, j, pPk->aiColumn[i]) );
2415         pPk->azColl[j] = pPk->azColl[i];
2416         pPk->aSortOrder[j] = pPk->aSortOrder[i];
2417         pPk->aiColumn[j++] = pPk->aiColumn[i];
2418       }
2419     }
2420     pPk->nKeyCol = j;
2421   }
2422   assert( pPk!=0 );
2423   pPk->isCovering = 1;
2424   if( !db->init.imposterTable ) pPk->uniqNotNull = 1;
2425   nPk = pPk->nColumn = pPk->nKeyCol;
2426 
2427   /* Bypass the creation of the PRIMARY KEY btree and the sqlite_schema
2428   ** table entry. This is only required if currently generating VDBE
2429   ** code for a CREATE TABLE (not when parsing one as part of reading
2430   ** a database schema).  */
2431   if( v && pPk->tnum>0 ){
2432     assert( db->init.busy==0 );
2433     sqlite3VdbeChangeOpcode(v, (int)pPk->tnum, OP_Goto);
2434   }
2435 
2436   /* The root page of the PRIMARY KEY is the table root page */
2437   pPk->tnum = pTab->tnum;
2438 
2439   /* Update the in-memory representation of all UNIQUE indices by converting
2440   ** the final rowid column into one or more columns of the PRIMARY KEY.
2441   */
2442   for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
2443     int n;
2444     if( IsPrimaryKeyIndex(pIdx) ) continue;
2445     for(i=n=0; i<nPk; i++){
2446       if( !isDupColumn(pIdx, pIdx->nKeyCol, pPk, i) ){
2447         testcase( hasColumn(pIdx->aiColumn, pIdx->nKeyCol, pPk->aiColumn[i]) );
2448         n++;
2449       }
2450     }
2451     if( n==0 ){
2452       /* This index is a superset of the primary key */
2453       pIdx->nColumn = pIdx->nKeyCol;
2454       continue;
2455     }
2456     if( resizeIndexObject(db, pIdx, pIdx->nKeyCol+n) ) return;
2457     for(i=0, j=pIdx->nKeyCol; i<nPk; i++){
2458       if( !isDupColumn(pIdx, pIdx->nKeyCol, pPk, i) ){
2459         testcase( hasColumn(pIdx->aiColumn, pIdx->nKeyCol, pPk->aiColumn[i]) );
2460         pIdx->aiColumn[j] = pPk->aiColumn[i];
2461         pIdx->azColl[j] = pPk->azColl[i];
2462         if( pPk->aSortOrder[i] ){
2463           /* See ticket https://www.sqlite.org/src/info/bba7b69f9849b5bf */
2464           pIdx->bAscKeyBug = 1;
2465         }
2466         j++;
2467       }
2468     }
2469     assert( pIdx->nColumn>=pIdx->nKeyCol+n );
2470     assert( pIdx->nColumn>=j );
2471   }
2472 
2473   /* Add all table columns to the PRIMARY KEY index
2474   */
2475   nExtra = 0;
2476   for(i=0; i<pTab->nCol; i++){
2477     if( !hasColumn(pPk->aiColumn, nPk, i)
2478      && (pTab->aCol[i].colFlags & COLFLAG_VIRTUAL)==0 ) nExtra++;
2479   }
2480   if( resizeIndexObject(db, pPk, nPk+nExtra) ) return;
2481   for(i=0, j=nPk; i<pTab->nCol; i++){
2482     if( !hasColumn(pPk->aiColumn, j, i)
2483      && (pTab->aCol[i].colFlags & COLFLAG_VIRTUAL)==0
2484     ){
2485       assert( j<pPk->nColumn );
2486       pPk->aiColumn[j] = i;
2487       pPk->azColl[j] = sqlite3StrBINARY;
2488       j++;
2489     }
2490   }
2491   assert( pPk->nColumn==j );
2492   assert( pTab->nNVCol<=j );
2493   recomputeColumnsNotIndexed(pPk);
2494 }
2495 
2496 
2497 #ifndef SQLITE_OMIT_VIRTUALTABLE
2498 /*
2499 ** Return true if pTab is a virtual table and zName is a shadow table name
2500 ** for that virtual table.
2501 */
2502 int sqlite3IsShadowTableOf(sqlite3 *db, Table *pTab, const char *zName){
2503   int nName;                    /* Length of zName */
2504   Module *pMod;                 /* Module for the virtual table */
2505 
2506   if( !IsVirtual(pTab) ) return 0;
2507   nName = sqlite3Strlen30(pTab->zName);
2508   if( sqlite3_strnicmp(zName, pTab->zName, nName)!=0 ) return 0;
2509   if( zName[nName]!='_' ) return 0;
2510   pMod = (Module*)sqlite3HashFind(&db->aModule, pTab->u.vtab.azArg[0]);
2511   if( pMod==0 ) return 0;
2512   if( pMod->pModule->iVersion<3 ) return 0;
2513   if( pMod->pModule->xShadowName==0 ) return 0;
2514   return pMod->pModule->xShadowName(zName+nName+1);
2515 }
2516 #endif /* ifndef SQLITE_OMIT_VIRTUALTABLE */
2517 
2518 #ifndef SQLITE_OMIT_VIRTUALTABLE
2519 /*
2520 ** Table pTab is a virtual table.  If it the virtual table implementation
2521 ** exists and has an xShadowName method, then loop over all other ordinary
2522 ** tables within the same schema looking for shadow tables of pTab, and mark
2523 ** any shadow tables seen using the TF_Shadow flag.
2524 */
2525 void sqlite3MarkAllShadowTablesOf(sqlite3 *db, Table *pTab){
2526   int nName;                    /* Length of pTab->zName */
2527   Module *pMod;                 /* Module for the virtual table */
2528   HashElem *k;                  /* For looping through the symbol table */
2529 
2530   assert( IsVirtual(pTab) );
2531   pMod = (Module*)sqlite3HashFind(&db->aModule, pTab->u.vtab.azArg[0]);
2532   if( pMod==0 ) return;
2533   if( NEVER(pMod->pModule==0) ) return;
2534   if( pMod->pModule->iVersion<3 ) return;
2535   if( pMod->pModule->xShadowName==0 ) return;
2536   assert( pTab->zName!=0 );
2537   nName = sqlite3Strlen30(pTab->zName);
2538   for(k=sqliteHashFirst(&pTab->pSchema->tblHash); k; k=sqliteHashNext(k)){
2539     Table *pOther = sqliteHashData(k);
2540     assert( pOther->zName!=0 );
2541     if( !IsOrdinaryTable(pOther) ) continue;
2542     if( pOther->tabFlags & TF_Shadow ) continue;
2543     if( sqlite3StrNICmp(pOther->zName, pTab->zName, nName)==0
2544      && pOther->zName[nName]=='_'
2545      && pMod->pModule->xShadowName(pOther->zName+nName+1)
2546     ){
2547       pOther->tabFlags |= TF_Shadow;
2548     }
2549   }
2550 }
2551 #endif /* ifndef SQLITE_OMIT_VIRTUALTABLE */
2552 
2553 #ifndef SQLITE_OMIT_VIRTUALTABLE
2554 /*
2555 ** Return true if zName is a shadow table name in the current database
2556 ** connection.
2557 **
2558 ** zName is temporarily modified while this routine is running, but is
2559 ** restored to its original value prior to this routine returning.
2560 */
2561 int sqlite3ShadowTableName(sqlite3 *db, const char *zName){
2562   char *zTail;                  /* Pointer to the last "_" in zName */
2563   Table *pTab;                  /* Table that zName is a shadow of */
2564   zTail = strrchr(zName, '_');
2565   if( zTail==0 ) return 0;
2566   *zTail = 0;
2567   pTab = sqlite3FindTable(db, zName, 0);
2568   *zTail = '_';
2569   if( pTab==0 ) return 0;
2570   if( !IsVirtual(pTab) ) return 0;
2571   return sqlite3IsShadowTableOf(db, pTab, zName);
2572 }
2573 #endif /* ifndef SQLITE_OMIT_VIRTUALTABLE */
2574 
2575 
2576 #ifdef SQLITE_DEBUG
2577 /*
2578 ** Mark all nodes of an expression as EP_Immutable, indicating that
2579 ** they should not be changed.  Expressions attached to a table or
2580 ** index definition are tagged this way to help ensure that we do
2581 ** not pass them into code generator routines by mistake.
2582 */
2583 static int markImmutableExprStep(Walker *pWalker, Expr *pExpr){
2584   ExprSetVVAProperty(pExpr, EP_Immutable);
2585   return WRC_Continue;
2586 }
2587 static void markExprListImmutable(ExprList *pList){
2588   if( pList ){
2589     Walker w;
2590     memset(&w, 0, sizeof(w));
2591     w.xExprCallback = markImmutableExprStep;
2592     w.xSelectCallback = sqlite3SelectWalkNoop;
2593     w.xSelectCallback2 = 0;
2594     sqlite3WalkExprList(&w, pList);
2595   }
2596 }
2597 #else
2598 #define markExprListImmutable(X)  /* no-op */
2599 #endif /* SQLITE_DEBUG */
2600 
2601 
2602 /*
2603 ** This routine is called to report the final ")" that terminates
2604 ** a CREATE TABLE statement.
2605 **
2606 ** The table structure that other action routines have been building
2607 ** is added to the internal hash tables, assuming no errors have
2608 ** occurred.
2609 **
2610 ** An entry for the table is made in the schema table on disk, unless
2611 ** this is a temporary table or db->init.busy==1.  When db->init.busy==1
2612 ** it means we are reading the sqlite_schema table because we just
2613 ** connected to the database or because the sqlite_schema table has
2614 ** recently changed, so the entry for this table already exists in
2615 ** the sqlite_schema table.  We do not want to create it again.
2616 **
2617 ** If the pSelect argument is not NULL, it means that this routine
2618 ** was called to create a table generated from a
2619 ** "CREATE TABLE ... AS SELECT ..." statement.  The column names of
2620 ** the new table will match the result set of the SELECT.
2621 */
2622 void sqlite3EndTable(
2623   Parse *pParse,          /* Parse context */
2624   Token *pCons,           /* The ',' token after the last column defn. */
2625   Token *pEnd,            /* The ')' before options in the CREATE TABLE */
2626   u32 tabOpts,            /* Extra table options. Usually 0. */
2627   Select *pSelect         /* Select from a "CREATE ... AS SELECT" */
2628 ){
2629   Table *p;                 /* The new table */
2630   sqlite3 *db = pParse->db; /* The database connection */
2631   int iDb;                  /* Database in which the table lives */
2632   Index *pIdx;              /* An implied index of the table */
2633 
2634   if( pEnd==0 && pSelect==0 ){
2635     return;
2636   }
2637   p = pParse->pNewTable;
2638   if( p==0 ) return;
2639 
2640   if( pSelect==0 && sqlite3ShadowTableName(db, p->zName) ){
2641     p->tabFlags |= TF_Shadow;
2642   }
2643 
2644   /* If the db->init.busy is 1 it means we are reading the SQL off the
2645   ** "sqlite_schema" or "sqlite_temp_schema" table on the disk.
2646   ** So do not write to the disk again.  Extract the root page number
2647   ** for the table from the db->init.newTnum field.  (The page number
2648   ** should have been put there by the sqliteOpenCb routine.)
2649   **
2650   ** If the root page number is 1, that means this is the sqlite_schema
2651   ** table itself.  So mark it read-only.
2652   */
2653   if( db->init.busy ){
2654     if( pSelect || (!IsOrdinaryTable(p) && db->init.newTnum) ){
2655       sqlite3ErrorMsg(pParse, "");
2656       return;
2657     }
2658     p->tnum = db->init.newTnum;
2659     if( p->tnum==1 ) p->tabFlags |= TF_Readonly;
2660   }
2661 
2662   /* Special processing for tables that include the STRICT keyword:
2663   **
2664   **   *  Do not allow custom column datatypes.  Every column must have
2665   **      a datatype that is one of INT, INTEGER, REAL, TEXT, or BLOB.
2666   **
2667   **   *  If a PRIMARY KEY is defined, other than the INTEGER PRIMARY KEY,
2668   **      then all columns of the PRIMARY KEY must have a NOT NULL
2669   **      constraint.
2670   */
2671   if( tabOpts & TF_Strict ){
2672     int ii;
2673     p->tabFlags |= TF_Strict;
2674     for(ii=0; ii<p->nCol; ii++){
2675       Column *pCol = &p->aCol[ii];
2676       if( pCol->eCType==COLTYPE_CUSTOM ){
2677         if( pCol->colFlags & COLFLAG_HASTYPE ){
2678           sqlite3ErrorMsg(pParse,
2679             "unknown datatype for %s.%s: \"%s\"",
2680             p->zName, pCol->zCnName, sqlite3ColumnType(pCol, "")
2681           );
2682         }else{
2683           sqlite3ErrorMsg(pParse, "missing datatype for %s.%s",
2684                           p->zName, pCol->zCnName);
2685         }
2686         return;
2687       }else if( pCol->eCType==COLTYPE_ANY ){
2688         pCol->affinity = SQLITE_AFF_BLOB;
2689       }
2690       if( (pCol->colFlags & COLFLAG_PRIMKEY)!=0
2691        && p->iPKey!=ii
2692        && pCol->notNull == OE_None
2693       ){
2694         pCol->notNull = OE_Abort;
2695         p->tabFlags |= TF_HasNotNull;
2696       }
2697     }
2698   }
2699 
2700   assert( (p->tabFlags & TF_HasPrimaryKey)==0
2701        || p->iPKey>=0 || sqlite3PrimaryKeyIndex(p)!=0 );
2702   assert( (p->tabFlags & TF_HasPrimaryKey)!=0
2703        || (p->iPKey<0 && sqlite3PrimaryKeyIndex(p)==0) );
2704 
2705   /* Special processing for WITHOUT ROWID Tables */
2706   if( tabOpts & TF_WithoutRowid ){
2707     if( (p->tabFlags & TF_Autoincrement) ){
2708       sqlite3ErrorMsg(pParse,
2709           "AUTOINCREMENT not allowed on WITHOUT ROWID tables");
2710       return;
2711     }
2712     if( (p->tabFlags & TF_HasPrimaryKey)==0 ){
2713       sqlite3ErrorMsg(pParse, "PRIMARY KEY missing on table %s", p->zName);
2714       return;
2715     }
2716     p->tabFlags |= TF_WithoutRowid | TF_NoVisibleRowid;
2717     convertToWithoutRowidTable(pParse, p);
2718   }
2719   iDb = sqlite3SchemaToIndex(db, p->pSchema);
2720 
2721 #ifndef SQLITE_OMIT_CHECK
2722   /* Resolve names in all CHECK constraint expressions.
2723   */
2724   if( p->pCheck ){
2725     sqlite3ResolveSelfReference(pParse, p, NC_IsCheck, 0, p->pCheck);
2726     if( pParse->nErr ){
2727       /* If errors are seen, delete the CHECK constraints now, else they might
2728       ** actually be used if PRAGMA writable_schema=ON is set. */
2729       sqlite3ExprListDelete(db, p->pCheck);
2730       p->pCheck = 0;
2731     }else{
2732       markExprListImmutable(p->pCheck);
2733     }
2734   }
2735 #endif /* !defined(SQLITE_OMIT_CHECK) */
2736 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
2737   if( p->tabFlags & TF_HasGenerated ){
2738     int ii, nNG = 0;
2739     testcase( p->tabFlags & TF_HasVirtual );
2740     testcase( p->tabFlags & TF_HasStored );
2741     for(ii=0; ii<p->nCol; ii++){
2742       u32 colFlags = p->aCol[ii].colFlags;
2743       if( (colFlags & COLFLAG_GENERATED)!=0 ){
2744         Expr *pX = sqlite3ColumnExpr(p, &p->aCol[ii]);
2745         testcase( colFlags & COLFLAG_VIRTUAL );
2746         testcase( colFlags & COLFLAG_STORED );
2747         if( sqlite3ResolveSelfReference(pParse, p, NC_GenCol, pX, 0) ){
2748           /* If there are errors in resolving the expression, change the
2749           ** expression to a NULL.  This prevents code generators that operate
2750           ** on the expression from inserting extra parts into the expression
2751           ** tree that have been allocated from lookaside memory, which is
2752           ** illegal in a schema and will lead to errors or heap corruption
2753           ** when the database connection closes. */
2754           sqlite3ColumnSetExpr(pParse, p, &p->aCol[ii],
2755                sqlite3ExprAlloc(db, TK_NULL, 0, 0));
2756         }
2757       }else{
2758         nNG++;
2759       }
2760     }
2761     if( nNG==0 ){
2762       sqlite3ErrorMsg(pParse, "must have at least one non-generated column");
2763       return;
2764     }
2765   }
2766 #endif
2767 
2768   /* Estimate the average row size for the table and for all implied indices */
2769   estimateTableWidth(p);
2770   for(pIdx=p->pIndex; pIdx; pIdx=pIdx->pNext){
2771     estimateIndexWidth(pIdx);
2772   }
2773 
2774   /* If not initializing, then create a record for the new table
2775   ** in the schema table of the database.
2776   **
2777   ** If this is a TEMPORARY table, write the entry into the auxiliary
2778   ** file instead of into the main database file.
2779   */
2780   if( !db->init.busy ){
2781     int n;
2782     Vdbe *v;
2783     char *zType;    /* "view" or "table" */
2784     char *zType2;   /* "VIEW" or "TABLE" */
2785     char *zStmt;    /* Text of the CREATE TABLE or CREATE VIEW statement */
2786 
2787     v = sqlite3GetVdbe(pParse);
2788     if( NEVER(v==0) ) return;
2789 
2790     sqlite3VdbeAddOp1(v, OP_Close, 0);
2791 
2792     /*
2793     ** Initialize zType for the new view or table.
2794     */
2795     if( IsOrdinaryTable(p) ){
2796       /* A regular table */
2797       zType = "table";
2798       zType2 = "TABLE";
2799 #ifndef SQLITE_OMIT_VIEW
2800     }else{
2801       /* A view */
2802       zType = "view";
2803       zType2 = "VIEW";
2804 #endif
2805     }
2806 
2807     /* If this is a CREATE TABLE xx AS SELECT ..., execute the SELECT
2808     ** statement to populate the new table. The root-page number for the
2809     ** new table is in register pParse->regRoot.
2810     **
2811     ** Once the SELECT has been coded by sqlite3Select(), it is in a
2812     ** suitable state to query for the column names and types to be used
2813     ** by the new table.
2814     **
2815     ** A shared-cache write-lock is not required to write to the new table,
2816     ** as a schema-lock must have already been obtained to create it. Since
2817     ** a schema-lock excludes all other database users, the write-lock would
2818     ** be redundant.
2819     */
2820     if( pSelect ){
2821       SelectDest dest;    /* Where the SELECT should store results */
2822       int regYield;       /* Register holding co-routine entry-point */
2823       int addrTop;        /* Top of the co-routine */
2824       int regRec;         /* A record to be insert into the new table */
2825       int regRowid;       /* Rowid of the next row to insert */
2826       int addrInsLoop;    /* Top of the loop for inserting rows */
2827       Table *pSelTab;     /* A table that describes the SELECT results */
2828 
2829       if( IN_SPECIAL_PARSE ){
2830         pParse->rc = SQLITE_ERROR;
2831         pParse->nErr++;
2832         return;
2833       }
2834       regYield = ++pParse->nMem;
2835       regRec = ++pParse->nMem;
2836       regRowid = ++pParse->nMem;
2837       assert(pParse->nTab==1);
2838       sqlite3MayAbort(pParse);
2839       sqlite3VdbeAddOp3(v, OP_OpenWrite, 1, pParse->regRoot, iDb);
2840       sqlite3VdbeChangeP5(v, OPFLAG_P2ISREG);
2841       pParse->nTab = 2;
2842       addrTop = sqlite3VdbeCurrentAddr(v) + 1;
2843       sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, addrTop);
2844       if( pParse->nErr ) return;
2845       pSelTab = sqlite3ResultSetOfSelect(pParse, pSelect, SQLITE_AFF_BLOB);
2846       if( pSelTab==0 ) return;
2847       assert( p->aCol==0 );
2848       p->nCol = p->nNVCol = pSelTab->nCol;
2849       p->aCol = pSelTab->aCol;
2850       pSelTab->nCol = 0;
2851       pSelTab->aCol = 0;
2852       sqlite3DeleteTable(db, pSelTab);
2853       sqlite3SelectDestInit(&dest, SRT_Coroutine, regYield);
2854       sqlite3Select(pParse, pSelect, &dest);
2855       if( pParse->nErr ) return;
2856       sqlite3VdbeEndCoroutine(v, regYield);
2857       sqlite3VdbeJumpHere(v, addrTop - 1);
2858       addrInsLoop = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm);
2859       VdbeCoverage(v);
2860       sqlite3VdbeAddOp3(v, OP_MakeRecord, dest.iSdst, dest.nSdst, regRec);
2861       sqlite3TableAffinity(v, p, 0);
2862       sqlite3VdbeAddOp2(v, OP_NewRowid, 1, regRowid);
2863       sqlite3VdbeAddOp3(v, OP_Insert, 1, regRec, regRowid);
2864       sqlite3VdbeGoto(v, addrInsLoop);
2865       sqlite3VdbeJumpHere(v, addrInsLoop);
2866       sqlite3VdbeAddOp1(v, OP_Close, 1);
2867     }
2868 
2869     /* Compute the complete text of the CREATE statement */
2870     if( pSelect ){
2871       zStmt = createTableStmt(db, p);
2872     }else{
2873       Token *pEnd2 = tabOpts ? &pParse->sLastToken : pEnd;
2874       n = (int)(pEnd2->z - pParse->sNameToken.z);
2875       if( pEnd2->z[0]!=';' ) n += pEnd2->n;
2876       zStmt = sqlite3MPrintf(db,
2877           "CREATE %s %.*s", zType2, n, pParse->sNameToken.z
2878       );
2879     }
2880 
2881     /* A slot for the record has already been allocated in the
2882     ** schema table.  We just need to update that slot with all
2883     ** the information we've collected.
2884     */
2885     sqlite3NestedParse(pParse,
2886       "UPDATE %Q." LEGACY_SCHEMA_TABLE
2887       " SET type='%s', name=%Q, tbl_name=%Q, rootpage=#%d, sql=%Q"
2888       " WHERE rowid=#%d",
2889       db->aDb[iDb].zDbSName,
2890       zType,
2891       p->zName,
2892       p->zName,
2893       pParse->regRoot,
2894       zStmt,
2895       pParse->regRowid
2896     );
2897     sqlite3DbFree(db, zStmt);
2898     sqlite3ChangeCookie(pParse, iDb);
2899 
2900 #ifndef SQLITE_OMIT_AUTOINCREMENT
2901     /* Check to see if we need to create an sqlite_sequence table for
2902     ** keeping track of autoincrement keys.
2903     */
2904     if( (p->tabFlags & TF_Autoincrement)!=0 && !IN_SPECIAL_PARSE ){
2905       Db *pDb = &db->aDb[iDb];
2906       assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
2907       if( pDb->pSchema->pSeqTab==0 ){
2908         sqlite3NestedParse(pParse,
2909           "CREATE TABLE %Q.sqlite_sequence(name,seq)",
2910           pDb->zDbSName
2911         );
2912       }
2913     }
2914 #endif
2915 
2916     /* Reparse everything to update our internal data structures */
2917     sqlite3VdbeAddParseSchemaOp(v, iDb,
2918            sqlite3MPrintf(db, "tbl_name='%q' AND type!='trigger'", p->zName),0);
2919   }
2920 
2921   /* Add the table to the in-memory representation of the database.
2922   */
2923   if( db->init.busy ){
2924     Table *pOld;
2925     Schema *pSchema = p->pSchema;
2926     assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
2927     assert( HasRowid(p) || p->iPKey<0 );
2928     pOld = sqlite3HashInsert(&pSchema->tblHash, p->zName, p);
2929     if( pOld ){
2930       assert( p==pOld );  /* Malloc must have failed inside HashInsert() */
2931       sqlite3OomFault(db);
2932       return;
2933     }
2934     pParse->pNewTable = 0;
2935     db->mDbFlags |= DBFLAG_SchemaChange;
2936 
2937     /* If this is the magic sqlite_sequence table used by autoincrement,
2938     ** then record a pointer to this table in the main database structure
2939     ** so that INSERT can find the table easily.  */
2940     assert( !pParse->nested );
2941 #ifndef SQLITE_OMIT_AUTOINCREMENT
2942     if( strcmp(p->zName, "sqlite_sequence")==0 ){
2943       assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
2944       p->pSchema->pSeqTab = p;
2945     }
2946 #endif
2947   }
2948 
2949 #ifndef SQLITE_OMIT_ALTERTABLE
2950   if( !pSelect && IsOrdinaryTable(p) ){
2951     assert( pCons && pEnd );
2952     if( pCons->z==0 ){
2953       pCons = pEnd;
2954     }
2955     p->u.tab.addColOffset = 13 + (int)(pCons->z - pParse->sNameToken.z);
2956   }
2957 #endif
2958 }
2959 
2960 #ifndef SQLITE_OMIT_VIEW
2961 /*
2962 ** The parser calls this routine in order to create a new VIEW
2963 */
2964 void sqlite3CreateView(
2965   Parse *pParse,     /* The parsing context */
2966   Token *pBegin,     /* The CREATE token that begins the statement */
2967   Token *pName1,     /* The token that holds the name of the view */
2968   Token *pName2,     /* The token that holds the name of the view */
2969   ExprList *pCNames, /* Optional list of view column names */
2970   Select *pSelect,   /* A SELECT statement that will become the new view */
2971   int isTemp,        /* TRUE for a TEMPORARY view */
2972   int noErr          /* Suppress error messages if VIEW already exists */
2973 ){
2974   Table *p;
2975   int n;
2976   const char *z;
2977   Token sEnd;
2978   DbFixer sFix;
2979   Token *pName = 0;
2980   int iDb;
2981   sqlite3 *db = pParse->db;
2982 
2983   if( pParse->nVar>0 ){
2984     sqlite3ErrorMsg(pParse, "parameters are not allowed in views");
2985     goto create_view_fail;
2986   }
2987   sqlite3StartTable(pParse, pName1, pName2, isTemp, 1, 0, noErr);
2988   p = pParse->pNewTable;
2989   if( p==0 || pParse->nErr ) goto create_view_fail;
2990 
2991   /* Legacy versions of SQLite allowed the use of the magic "rowid" column
2992   ** on a view, even though views do not have rowids.  The following flag
2993   ** setting fixes this problem.  But the fix can be disabled by compiling
2994   ** with -DSQLITE_ALLOW_ROWID_IN_VIEW in case there are legacy apps that
2995   ** depend upon the old buggy behavior. */
2996 #ifndef SQLITE_ALLOW_ROWID_IN_VIEW
2997   p->tabFlags |= TF_NoVisibleRowid;
2998 #endif
2999 
3000   sqlite3TwoPartName(pParse, pName1, pName2, &pName);
3001   iDb = sqlite3SchemaToIndex(db, p->pSchema);
3002   sqlite3FixInit(&sFix, pParse, iDb, "view", pName);
3003   if( sqlite3FixSelect(&sFix, pSelect) ) goto create_view_fail;
3004 
3005   /* Make a copy of the entire SELECT statement that defines the view.
3006   ** This will force all the Expr.token.z values to be dynamically
3007   ** allocated rather than point to the input string - which means that
3008   ** they will persist after the current sqlite3_exec() call returns.
3009   */
3010   pSelect->selFlags |= SF_View;
3011   if( IN_RENAME_OBJECT ){
3012     p->u.view.pSelect = pSelect;
3013     pSelect = 0;
3014   }else{
3015     p->u.view.pSelect = sqlite3SelectDup(db, pSelect, EXPRDUP_REDUCE);
3016   }
3017   p->pCheck = sqlite3ExprListDup(db, pCNames, EXPRDUP_REDUCE);
3018   p->eTabType = TABTYP_VIEW;
3019   if( db->mallocFailed ) goto create_view_fail;
3020 
3021   /* Locate the end of the CREATE VIEW statement.  Make sEnd point to
3022   ** the end.
3023   */
3024   sEnd = pParse->sLastToken;
3025   assert( sEnd.z[0]!=0 || sEnd.n==0 );
3026   if( sEnd.z[0]!=';' ){
3027     sEnd.z += sEnd.n;
3028   }
3029   sEnd.n = 0;
3030   n = (int)(sEnd.z - pBegin->z);
3031   assert( n>0 );
3032   z = pBegin->z;
3033   while( sqlite3Isspace(z[n-1]) ){ n--; }
3034   sEnd.z = &z[n-1];
3035   sEnd.n = 1;
3036 
3037   /* Use sqlite3EndTable() to add the view to the schema table */
3038   sqlite3EndTable(pParse, 0, &sEnd, 0, 0);
3039 
3040 create_view_fail:
3041   sqlite3SelectDelete(db, pSelect);
3042   if( IN_RENAME_OBJECT ){
3043     sqlite3RenameExprlistUnmap(pParse, pCNames);
3044   }
3045   sqlite3ExprListDelete(db, pCNames);
3046   return;
3047 }
3048 #endif /* SQLITE_OMIT_VIEW */
3049 
3050 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
3051 /*
3052 ** The Table structure pTable is really a VIEW.  Fill in the names of
3053 ** the columns of the view in the pTable structure.  Return the number
3054 ** of errors.  If an error is seen leave an error message in pParse->zErrMsg.
3055 */
3056 int sqlite3ViewGetColumnNames(Parse *pParse, Table *pTable){
3057   Table *pSelTab;   /* A fake table from which we get the result set */
3058   Select *pSel;     /* Copy of the SELECT that implements the view */
3059   int nErr = 0;     /* Number of errors encountered */
3060   int n;            /* Temporarily holds the number of cursors assigned */
3061   sqlite3 *db = pParse->db;  /* Database connection for malloc errors */
3062 #ifndef SQLITE_OMIT_VIRTUALTABLE
3063   int rc;
3064 #endif
3065 #ifndef SQLITE_OMIT_AUTHORIZATION
3066   sqlite3_xauth xAuth;       /* Saved xAuth pointer */
3067 #endif
3068 
3069   assert( pTable );
3070 
3071 #ifndef SQLITE_OMIT_VIRTUALTABLE
3072   if( IsVirtual(pTable) ){
3073     db->nSchemaLock++;
3074     rc = sqlite3VtabCallConnect(pParse, pTable);
3075     db->nSchemaLock--;
3076     return rc;
3077   }
3078 #endif
3079 
3080 #ifndef SQLITE_OMIT_VIEW
3081   /* A positive nCol means the columns names for this view are
3082   ** already known.
3083   */
3084   if( pTable->nCol>0 ) return 0;
3085 
3086   /* A negative nCol is a special marker meaning that we are currently
3087   ** trying to compute the column names.  If we enter this routine with
3088   ** a negative nCol, it means two or more views form a loop, like this:
3089   **
3090   **     CREATE VIEW one AS SELECT * FROM two;
3091   **     CREATE VIEW two AS SELECT * FROM one;
3092   **
3093   ** Actually, the error above is now caught prior to reaching this point.
3094   ** But the following test is still important as it does come up
3095   ** in the following:
3096   **
3097   **     CREATE TABLE main.ex1(a);
3098   **     CREATE TEMP VIEW ex1 AS SELECT a FROM ex1;
3099   **     SELECT * FROM temp.ex1;
3100   */
3101   if( pTable->nCol<0 ){
3102     sqlite3ErrorMsg(pParse, "view %s is circularly defined", pTable->zName);
3103     return 1;
3104   }
3105   assert( pTable->nCol>=0 );
3106 
3107   /* If we get this far, it means we need to compute the table names.
3108   ** Note that the call to sqlite3ResultSetOfSelect() will expand any
3109   ** "*" elements in the results set of the view and will assign cursors
3110   ** to the elements of the FROM clause.  But we do not want these changes
3111   ** to be permanent.  So the computation is done on a copy of the SELECT
3112   ** statement that defines the view.
3113   */
3114   assert( IsView(pTable) );
3115   pSel = sqlite3SelectDup(db, pTable->u.view.pSelect, 0);
3116   if( pSel ){
3117     u8 eParseMode = pParse->eParseMode;
3118     pParse->eParseMode = PARSE_MODE_NORMAL;
3119     n = pParse->nTab;
3120     sqlite3SrcListAssignCursors(pParse, pSel->pSrc);
3121     pTable->nCol = -1;
3122     DisableLookaside;
3123 #ifndef SQLITE_OMIT_AUTHORIZATION
3124     xAuth = db->xAuth;
3125     db->xAuth = 0;
3126     pSelTab = sqlite3ResultSetOfSelect(pParse, pSel, SQLITE_AFF_NONE);
3127     db->xAuth = xAuth;
3128 #else
3129     pSelTab = sqlite3ResultSetOfSelect(pParse, pSel, SQLITE_AFF_NONE);
3130 #endif
3131     pParse->nTab = n;
3132     if( pSelTab==0 ){
3133       pTable->nCol = 0;
3134       nErr++;
3135     }else if( pTable->pCheck ){
3136       /* CREATE VIEW name(arglist) AS ...
3137       ** The names of the columns in the table are taken from
3138       ** arglist which is stored in pTable->pCheck.  The pCheck field
3139       ** normally holds CHECK constraints on an ordinary table, but for
3140       ** a VIEW it holds the list of column names.
3141       */
3142       sqlite3ColumnsFromExprList(pParse, pTable->pCheck,
3143                                  &pTable->nCol, &pTable->aCol);
3144       if( pParse->nErr==0
3145        && pTable->nCol==pSel->pEList->nExpr
3146       ){
3147         assert( db->mallocFailed==0 );
3148         sqlite3SelectAddColumnTypeAndCollation(pParse, pTable, pSel,
3149                                                SQLITE_AFF_NONE);
3150       }
3151     }else{
3152       /* CREATE VIEW name AS...  without an argument list.  Construct
3153       ** the column names from the SELECT statement that defines the view.
3154       */
3155       assert( pTable->aCol==0 );
3156       pTable->nCol = pSelTab->nCol;
3157       pTable->aCol = pSelTab->aCol;
3158       pTable->tabFlags |= (pSelTab->tabFlags & COLFLAG_NOINSERT);
3159       pSelTab->nCol = 0;
3160       pSelTab->aCol = 0;
3161       assert( sqlite3SchemaMutexHeld(db, 0, pTable->pSchema) );
3162     }
3163     pTable->nNVCol = pTable->nCol;
3164     sqlite3DeleteTable(db, pSelTab);
3165     sqlite3SelectDelete(db, pSel);
3166     EnableLookaside;
3167     pParse->eParseMode = eParseMode;
3168   } else {
3169     nErr++;
3170   }
3171   pTable->pSchema->schemaFlags |= DB_UnresetViews;
3172   if( db->mallocFailed ){
3173     sqlite3DeleteColumnNames(db, pTable);
3174   }
3175 #endif /* SQLITE_OMIT_VIEW */
3176   return nErr;
3177 }
3178 #endif /* !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) */
3179 
3180 #ifndef SQLITE_OMIT_VIEW
3181 /*
3182 ** Clear the column names from every VIEW in database idx.
3183 */
3184 static void sqliteViewResetAll(sqlite3 *db, int idx){
3185   HashElem *i;
3186   assert( sqlite3SchemaMutexHeld(db, idx, 0) );
3187   if( !DbHasProperty(db, idx, DB_UnresetViews) ) return;
3188   for(i=sqliteHashFirst(&db->aDb[idx].pSchema->tblHash); i;i=sqliteHashNext(i)){
3189     Table *pTab = sqliteHashData(i);
3190     if( IsView(pTab) ){
3191       sqlite3DeleteColumnNames(db, pTab);
3192     }
3193   }
3194   DbClearProperty(db, idx, DB_UnresetViews);
3195 }
3196 #else
3197 # define sqliteViewResetAll(A,B)
3198 #endif /* SQLITE_OMIT_VIEW */
3199 
3200 /*
3201 ** This function is called by the VDBE to adjust the internal schema
3202 ** used by SQLite when the btree layer moves a table root page. The
3203 ** root-page of a table or index in database iDb has changed from iFrom
3204 ** to iTo.
3205 **
3206 ** Ticket #1728:  The symbol table might still contain information
3207 ** on tables and/or indices that are the process of being deleted.
3208 ** If you are unlucky, one of those deleted indices or tables might
3209 ** have the same rootpage number as the real table or index that is
3210 ** being moved.  So we cannot stop searching after the first match
3211 ** because the first match might be for one of the deleted indices
3212 ** or tables and not the table/index that is actually being moved.
3213 ** We must continue looping until all tables and indices with
3214 ** rootpage==iFrom have been converted to have a rootpage of iTo
3215 ** in order to be certain that we got the right one.
3216 */
3217 #ifndef SQLITE_OMIT_AUTOVACUUM
3218 void sqlite3RootPageMoved(sqlite3 *db, int iDb, Pgno iFrom, Pgno iTo){
3219   HashElem *pElem;
3220   Hash *pHash;
3221   Db *pDb;
3222 
3223   assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
3224   pDb = &db->aDb[iDb];
3225   pHash = &pDb->pSchema->tblHash;
3226   for(pElem=sqliteHashFirst(pHash); pElem; pElem=sqliteHashNext(pElem)){
3227     Table *pTab = sqliteHashData(pElem);
3228     if( pTab->tnum==iFrom ){
3229       pTab->tnum = iTo;
3230     }
3231   }
3232   pHash = &pDb->pSchema->idxHash;
3233   for(pElem=sqliteHashFirst(pHash); pElem; pElem=sqliteHashNext(pElem)){
3234     Index *pIdx = sqliteHashData(pElem);
3235     if( pIdx->tnum==iFrom ){
3236       pIdx->tnum = iTo;
3237     }
3238   }
3239 }
3240 #endif
3241 
3242 /*
3243 ** Write code to erase the table with root-page iTable from database iDb.
3244 ** Also write code to modify the sqlite_schema table and internal schema
3245 ** if a root-page of another table is moved by the btree-layer whilst
3246 ** erasing iTable (this can happen with an auto-vacuum database).
3247 */
3248 static void destroyRootPage(Parse *pParse, int iTable, int iDb){
3249   Vdbe *v = sqlite3GetVdbe(pParse);
3250   int r1 = sqlite3GetTempReg(pParse);
3251   if( iTable<2 ) sqlite3ErrorMsg(pParse, "corrupt schema");
3252   sqlite3VdbeAddOp3(v, OP_Destroy, iTable, r1, iDb);
3253   sqlite3MayAbort(pParse);
3254 #ifndef SQLITE_OMIT_AUTOVACUUM
3255   /* OP_Destroy stores an in integer r1. If this integer
3256   ** is non-zero, then it is the root page number of a table moved to
3257   ** location iTable. The following code modifies the sqlite_schema table to
3258   ** reflect this.
3259   **
3260   ** The "#NNN" in the SQL is a special constant that means whatever value
3261   ** is in register NNN.  See grammar rules associated with the TK_REGISTER
3262   ** token for additional information.
3263   */
3264   sqlite3NestedParse(pParse,
3265      "UPDATE %Q." LEGACY_SCHEMA_TABLE
3266      " SET rootpage=%d WHERE #%d AND rootpage=#%d",
3267      pParse->db->aDb[iDb].zDbSName, iTable, r1, r1);
3268 #endif
3269   sqlite3ReleaseTempReg(pParse, r1);
3270 }
3271 
3272 /*
3273 ** Write VDBE code to erase table pTab and all associated indices on disk.
3274 ** Code to update the sqlite_schema tables and internal schema definitions
3275 ** in case a root-page belonging to another table is moved by the btree layer
3276 ** is also added (this can happen with an auto-vacuum database).
3277 */
3278 static void destroyTable(Parse *pParse, Table *pTab){
3279   /* If the database may be auto-vacuum capable (if SQLITE_OMIT_AUTOVACUUM
3280   ** is not defined), then it is important to call OP_Destroy on the
3281   ** table and index root-pages in order, starting with the numerically
3282   ** largest root-page number. This guarantees that none of the root-pages
3283   ** to be destroyed is relocated by an earlier OP_Destroy. i.e. if the
3284   ** following were coded:
3285   **
3286   ** OP_Destroy 4 0
3287   ** ...
3288   ** OP_Destroy 5 0
3289   **
3290   ** and root page 5 happened to be the largest root-page number in the
3291   ** database, then root page 5 would be moved to page 4 by the
3292   ** "OP_Destroy 4 0" opcode. The subsequent "OP_Destroy 5 0" would hit
3293   ** a free-list page.
3294   */
3295   Pgno iTab = pTab->tnum;
3296   Pgno iDestroyed = 0;
3297 
3298   while( 1 ){
3299     Index *pIdx;
3300     Pgno iLargest = 0;
3301 
3302     if( iDestroyed==0 || iTab<iDestroyed ){
3303       iLargest = iTab;
3304     }
3305     for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
3306       Pgno iIdx = pIdx->tnum;
3307       assert( pIdx->pSchema==pTab->pSchema );
3308       if( (iDestroyed==0 || (iIdx<iDestroyed)) && iIdx>iLargest ){
3309         iLargest = iIdx;
3310       }
3311     }
3312     if( iLargest==0 ){
3313       return;
3314     }else{
3315       int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
3316       assert( iDb>=0 && iDb<pParse->db->nDb );
3317       destroyRootPage(pParse, iLargest, iDb);
3318       iDestroyed = iLargest;
3319     }
3320   }
3321 }
3322 
3323 /*
3324 ** Remove entries from the sqlite_statN tables (for N in (1,2,3))
3325 ** after a DROP INDEX or DROP TABLE command.
3326 */
3327 static void sqlite3ClearStatTables(
3328   Parse *pParse,         /* The parsing context */
3329   int iDb,               /* The database number */
3330   const char *zType,     /* "idx" or "tbl" */
3331   const char *zName      /* Name of index or table */
3332 ){
3333   int i;
3334   const char *zDbName = pParse->db->aDb[iDb].zDbSName;
3335   for(i=1; i<=4; i++){
3336     char zTab[24];
3337     sqlite3_snprintf(sizeof(zTab),zTab,"sqlite_stat%d",i);
3338     if( sqlite3FindTable(pParse->db, zTab, zDbName) ){
3339       sqlite3NestedParse(pParse,
3340         "DELETE FROM %Q.%s WHERE %s=%Q",
3341         zDbName, zTab, zType, zName
3342       );
3343     }
3344   }
3345 }
3346 
3347 /*
3348 ** Generate code to drop a table.
3349 */
3350 void sqlite3CodeDropTable(Parse *pParse, Table *pTab, int iDb, int isView){
3351   Vdbe *v;
3352   sqlite3 *db = pParse->db;
3353   Trigger *pTrigger;
3354   Db *pDb = &db->aDb[iDb];
3355 
3356   v = sqlite3GetVdbe(pParse);
3357   assert( v!=0 );
3358   sqlite3BeginWriteOperation(pParse, 1, iDb);
3359 
3360 #ifndef SQLITE_OMIT_VIRTUALTABLE
3361   if( IsVirtual(pTab) ){
3362     sqlite3VdbeAddOp0(v, OP_VBegin);
3363   }
3364 #endif
3365 
3366   /* Drop all triggers associated with the table being dropped. Code
3367   ** is generated to remove entries from sqlite_schema and/or
3368   ** sqlite_temp_schema if required.
3369   */
3370   pTrigger = sqlite3TriggerList(pParse, pTab);
3371   while( pTrigger ){
3372     assert( pTrigger->pSchema==pTab->pSchema ||
3373         pTrigger->pSchema==db->aDb[1].pSchema );
3374     sqlite3DropTriggerPtr(pParse, pTrigger);
3375     pTrigger = pTrigger->pNext;
3376   }
3377 
3378 #ifndef SQLITE_OMIT_AUTOINCREMENT
3379   /* Remove any entries of the sqlite_sequence table associated with
3380   ** the table being dropped. This is done before the table is dropped
3381   ** at the btree level, in case the sqlite_sequence table needs to
3382   ** move as a result of the drop (can happen in auto-vacuum mode).
3383   */
3384   if( pTab->tabFlags & TF_Autoincrement ){
3385     sqlite3NestedParse(pParse,
3386       "DELETE FROM %Q.sqlite_sequence WHERE name=%Q",
3387       pDb->zDbSName, pTab->zName
3388     );
3389   }
3390 #endif
3391 
3392   /* Drop all entries in the schema table that refer to the
3393   ** table. The program name loops through the schema table and deletes
3394   ** every row that refers to a table of the same name as the one being
3395   ** dropped. Triggers are handled separately because a trigger can be
3396   ** created in the temp database that refers to a table in another
3397   ** database.
3398   */
3399   sqlite3NestedParse(pParse,
3400       "DELETE FROM %Q." LEGACY_SCHEMA_TABLE
3401       " WHERE tbl_name=%Q and type!='trigger'",
3402       pDb->zDbSName, pTab->zName);
3403   if( !isView && !IsVirtual(pTab) ){
3404     destroyTable(pParse, pTab);
3405   }
3406 
3407   /* Remove the table entry from SQLite's internal schema and modify
3408   ** the schema cookie.
3409   */
3410   if( IsVirtual(pTab) ){
3411     sqlite3VdbeAddOp4(v, OP_VDestroy, iDb, 0, 0, pTab->zName, 0);
3412     sqlite3MayAbort(pParse);
3413   }
3414   sqlite3VdbeAddOp4(v, OP_DropTable, iDb, 0, 0, pTab->zName, 0);
3415   sqlite3ChangeCookie(pParse, iDb);
3416   sqliteViewResetAll(db, iDb);
3417 }
3418 
3419 /*
3420 ** Return TRUE if shadow tables should be read-only in the current
3421 ** context.
3422 */
3423 int sqlite3ReadOnlyShadowTables(sqlite3 *db){
3424 #ifndef SQLITE_OMIT_VIRTUALTABLE
3425   if( (db->flags & SQLITE_Defensive)!=0
3426    && db->pVtabCtx==0
3427    && db->nVdbeExec==0
3428    && !sqlite3VtabInSync(db)
3429   ){
3430     return 1;
3431   }
3432 #endif
3433   return 0;
3434 }
3435 
3436 /*
3437 ** Return true if it is not allowed to drop the given table
3438 */
3439 static int tableMayNotBeDropped(sqlite3 *db, Table *pTab){
3440   if( sqlite3StrNICmp(pTab->zName, "sqlite_", 7)==0 ){
3441     if( sqlite3StrNICmp(pTab->zName+7, "stat", 4)==0 ) return 0;
3442     if( sqlite3StrNICmp(pTab->zName+7, "parameters", 10)==0 ) return 0;
3443     return 1;
3444   }
3445   if( (pTab->tabFlags & TF_Shadow)!=0 && sqlite3ReadOnlyShadowTables(db) ){
3446     return 1;
3447   }
3448   if( pTab->tabFlags & TF_Eponymous ){
3449     return 1;
3450   }
3451   return 0;
3452 }
3453 
3454 /*
3455 ** This routine is called to do the work of a DROP TABLE statement.
3456 ** pName is the name of the table to be dropped.
3457 */
3458 void sqlite3DropTable(Parse *pParse, SrcList *pName, int isView, int noErr){
3459   Table *pTab;
3460   Vdbe *v;
3461   sqlite3 *db = pParse->db;
3462   int iDb;
3463 
3464   if( db->mallocFailed ){
3465     goto exit_drop_table;
3466   }
3467   assert( pParse->nErr==0 );
3468   assert( pName->nSrc==1 );
3469   if( sqlite3ReadSchema(pParse) ) goto exit_drop_table;
3470   if( noErr ) db->suppressErr++;
3471   assert( isView==0 || isView==LOCATE_VIEW );
3472   pTab = sqlite3LocateTableItem(pParse, isView, &pName->a[0]);
3473   if( noErr ) db->suppressErr--;
3474 
3475   if( pTab==0 ){
3476     if( noErr ){
3477       sqlite3CodeVerifyNamedSchema(pParse, pName->a[0].zDatabase);
3478       sqlite3ForceNotReadOnly(pParse);
3479     }
3480     goto exit_drop_table;
3481   }
3482   iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
3483   assert( iDb>=0 && iDb<db->nDb );
3484 
3485   /* If pTab is a virtual table, call ViewGetColumnNames() to ensure
3486   ** it is initialized.
3487   */
3488   if( IsVirtual(pTab) && sqlite3ViewGetColumnNames(pParse, pTab) ){
3489     goto exit_drop_table;
3490   }
3491 #ifndef SQLITE_OMIT_AUTHORIZATION
3492   {
3493     int code;
3494     const char *zTab = SCHEMA_TABLE(iDb);
3495     const char *zDb = db->aDb[iDb].zDbSName;
3496     const char *zArg2 = 0;
3497     if( sqlite3AuthCheck(pParse, SQLITE_DELETE, zTab, 0, zDb)){
3498       goto exit_drop_table;
3499     }
3500     if( isView ){
3501       if( !OMIT_TEMPDB && iDb==1 ){
3502         code = SQLITE_DROP_TEMP_VIEW;
3503       }else{
3504         code = SQLITE_DROP_VIEW;
3505       }
3506 #ifndef SQLITE_OMIT_VIRTUALTABLE
3507     }else if( IsVirtual(pTab) ){
3508       code = SQLITE_DROP_VTABLE;
3509       zArg2 = sqlite3GetVTable(db, pTab)->pMod->zName;
3510 #endif
3511     }else{
3512       if( !OMIT_TEMPDB && iDb==1 ){
3513         code = SQLITE_DROP_TEMP_TABLE;
3514       }else{
3515         code = SQLITE_DROP_TABLE;
3516       }
3517     }
3518     if( sqlite3AuthCheck(pParse, code, pTab->zName, zArg2, zDb) ){
3519       goto exit_drop_table;
3520     }
3521     if( sqlite3AuthCheck(pParse, SQLITE_DELETE, pTab->zName, 0, zDb) ){
3522       goto exit_drop_table;
3523     }
3524   }
3525 #endif
3526   if( tableMayNotBeDropped(db, pTab) ){
3527     sqlite3ErrorMsg(pParse, "table %s may not be dropped", pTab->zName);
3528     goto exit_drop_table;
3529   }
3530 
3531 #ifndef SQLITE_OMIT_VIEW
3532   /* Ensure DROP TABLE is not used on a view, and DROP VIEW is not used
3533   ** on a table.
3534   */
3535   if( isView && !IsView(pTab) ){
3536     sqlite3ErrorMsg(pParse, "use DROP TABLE to delete table %s", pTab->zName);
3537     goto exit_drop_table;
3538   }
3539   if( !isView && IsView(pTab) ){
3540     sqlite3ErrorMsg(pParse, "use DROP VIEW to delete view %s", pTab->zName);
3541     goto exit_drop_table;
3542   }
3543 #endif
3544 
3545   /* Generate code to remove the table from the schema table
3546   ** on disk.
3547   */
3548   v = sqlite3GetVdbe(pParse);
3549   if( v ){
3550     sqlite3BeginWriteOperation(pParse, 1, iDb);
3551     if( !isView ){
3552       sqlite3ClearStatTables(pParse, iDb, "tbl", pTab->zName);
3553       sqlite3FkDropTable(pParse, pName, pTab);
3554     }
3555     sqlite3CodeDropTable(pParse, pTab, iDb, isView);
3556   }
3557 
3558 exit_drop_table:
3559   sqlite3SrcListDelete(db, pName);
3560 }
3561 
3562 /*
3563 ** This routine is called to create a new foreign key on the table
3564 ** currently under construction.  pFromCol determines which columns
3565 ** in the current table point to the foreign key.  If pFromCol==0 then
3566 ** connect the key to the last column inserted.  pTo is the name of
3567 ** the table referred to (a.k.a the "parent" table).  pToCol is a list
3568 ** of tables in the parent pTo table.  flags contains all
3569 ** information about the conflict resolution algorithms specified
3570 ** in the ON DELETE, ON UPDATE and ON INSERT clauses.
3571 **
3572 ** An FKey structure is created and added to the table currently
3573 ** under construction in the pParse->pNewTable field.
3574 **
3575 ** The foreign key is set for IMMEDIATE processing.  A subsequent call
3576 ** to sqlite3DeferForeignKey() might change this to DEFERRED.
3577 */
3578 void sqlite3CreateForeignKey(
3579   Parse *pParse,       /* Parsing context */
3580   ExprList *pFromCol,  /* Columns in this table that point to other table */
3581   Token *pTo,          /* Name of the other table */
3582   ExprList *pToCol,    /* Columns in the other table */
3583   int flags            /* Conflict resolution algorithms. */
3584 ){
3585   sqlite3 *db = pParse->db;
3586 #ifndef SQLITE_OMIT_FOREIGN_KEY
3587   FKey *pFKey = 0;
3588   FKey *pNextTo;
3589   Table *p = pParse->pNewTable;
3590   i64 nByte;
3591   int i;
3592   int nCol;
3593   char *z;
3594 
3595   assert( pTo!=0 );
3596   if( p==0 || IN_DECLARE_VTAB ) goto fk_end;
3597   if( pFromCol==0 ){
3598     int iCol = p->nCol-1;
3599     if( NEVER(iCol<0) ) goto fk_end;
3600     if( pToCol && pToCol->nExpr!=1 ){
3601       sqlite3ErrorMsg(pParse, "foreign key on %s"
3602          " should reference only one column of table %T",
3603          p->aCol[iCol].zCnName, pTo);
3604       goto fk_end;
3605     }
3606     nCol = 1;
3607   }else if( pToCol && pToCol->nExpr!=pFromCol->nExpr ){
3608     sqlite3ErrorMsg(pParse,
3609         "number of columns in foreign key does not match the number of "
3610         "columns in the referenced table");
3611     goto fk_end;
3612   }else{
3613     nCol = pFromCol->nExpr;
3614   }
3615   nByte = sizeof(*pFKey) + (nCol-1)*sizeof(pFKey->aCol[0]) + pTo->n + 1;
3616   if( pToCol ){
3617     for(i=0; i<pToCol->nExpr; i++){
3618       nByte += sqlite3Strlen30(pToCol->a[i].zEName) + 1;
3619     }
3620   }
3621   pFKey = sqlite3DbMallocZero(db, nByte );
3622   if( pFKey==0 ){
3623     goto fk_end;
3624   }
3625   pFKey->pFrom = p;
3626   assert( IsOrdinaryTable(p) );
3627   pFKey->pNextFrom = p->u.tab.pFKey;
3628   z = (char*)&pFKey->aCol[nCol];
3629   pFKey->zTo = z;
3630   if( IN_RENAME_OBJECT ){
3631     sqlite3RenameTokenMap(pParse, (void*)z, pTo);
3632   }
3633   memcpy(z, pTo->z, pTo->n);
3634   z[pTo->n] = 0;
3635   sqlite3Dequote(z);
3636   z += pTo->n+1;
3637   pFKey->nCol = nCol;
3638   if( pFromCol==0 ){
3639     pFKey->aCol[0].iFrom = p->nCol-1;
3640   }else{
3641     for(i=0; i<nCol; i++){
3642       int j;
3643       for(j=0; j<p->nCol; j++){
3644         if( sqlite3StrICmp(p->aCol[j].zCnName, pFromCol->a[i].zEName)==0 ){
3645           pFKey->aCol[i].iFrom = j;
3646           break;
3647         }
3648       }
3649       if( j>=p->nCol ){
3650         sqlite3ErrorMsg(pParse,
3651           "unknown column \"%s\" in foreign key definition",
3652           pFromCol->a[i].zEName);
3653         goto fk_end;
3654       }
3655       if( IN_RENAME_OBJECT ){
3656         sqlite3RenameTokenRemap(pParse, &pFKey->aCol[i], pFromCol->a[i].zEName);
3657       }
3658     }
3659   }
3660   if( pToCol ){
3661     for(i=0; i<nCol; i++){
3662       int n = sqlite3Strlen30(pToCol->a[i].zEName);
3663       pFKey->aCol[i].zCol = z;
3664       if( IN_RENAME_OBJECT ){
3665         sqlite3RenameTokenRemap(pParse, z, pToCol->a[i].zEName);
3666       }
3667       memcpy(z, pToCol->a[i].zEName, n);
3668       z[n] = 0;
3669       z += n+1;
3670     }
3671   }
3672   pFKey->isDeferred = 0;
3673   pFKey->aAction[0] = (u8)(flags & 0xff);            /* ON DELETE action */
3674   pFKey->aAction[1] = (u8)((flags >> 8 ) & 0xff);    /* ON UPDATE action */
3675 
3676   assert( sqlite3SchemaMutexHeld(db, 0, p->pSchema) );
3677   pNextTo = (FKey *)sqlite3HashInsert(&p->pSchema->fkeyHash,
3678       pFKey->zTo, (void *)pFKey
3679   );
3680   if( pNextTo==pFKey ){
3681     sqlite3OomFault(db);
3682     goto fk_end;
3683   }
3684   if( pNextTo ){
3685     assert( pNextTo->pPrevTo==0 );
3686     pFKey->pNextTo = pNextTo;
3687     pNextTo->pPrevTo = pFKey;
3688   }
3689 
3690   /* Link the foreign key to the table as the last step.
3691   */
3692   assert( IsOrdinaryTable(p) );
3693   p->u.tab.pFKey = pFKey;
3694   pFKey = 0;
3695 
3696 fk_end:
3697   sqlite3DbFree(db, pFKey);
3698 #endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
3699   sqlite3ExprListDelete(db, pFromCol);
3700   sqlite3ExprListDelete(db, pToCol);
3701 }
3702 
3703 /*
3704 ** This routine is called when an INITIALLY IMMEDIATE or INITIALLY DEFERRED
3705 ** clause is seen as part of a foreign key definition.  The isDeferred
3706 ** parameter is 1 for INITIALLY DEFERRED and 0 for INITIALLY IMMEDIATE.
3707 ** The behavior of the most recently created foreign key is adjusted
3708 ** accordingly.
3709 */
3710 void sqlite3DeferForeignKey(Parse *pParse, int isDeferred){
3711 #ifndef SQLITE_OMIT_FOREIGN_KEY
3712   Table *pTab;
3713   FKey *pFKey;
3714   if( (pTab = pParse->pNewTable)==0 ) return;
3715   if( NEVER(!IsOrdinaryTable(pTab)) ) return;
3716   if( (pFKey = pTab->u.tab.pFKey)==0 ) return;
3717   assert( isDeferred==0 || isDeferred==1 ); /* EV: R-30323-21917 */
3718   pFKey->isDeferred = (u8)isDeferred;
3719 #endif
3720 }
3721 
3722 /*
3723 ** Generate code that will erase and refill index *pIdx.  This is
3724 ** used to initialize a newly created index or to recompute the
3725 ** content of an index in response to a REINDEX command.
3726 **
3727 ** if memRootPage is not negative, it means that the index is newly
3728 ** created.  The register specified by memRootPage contains the
3729 ** root page number of the index.  If memRootPage is negative, then
3730 ** the index already exists and must be cleared before being refilled and
3731 ** the root page number of the index is taken from pIndex->tnum.
3732 */
3733 static void sqlite3RefillIndex(Parse *pParse, Index *pIndex, int memRootPage){
3734   Table *pTab = pIndex->pTable;  /* The table that is indexed */
3735   int iTab = pParse->nTab++;     /* Btree cursor used for pTab */
3736   int iIdx = pParse->nTab++;     /* Btree cursor used for pIndex */
3737   int iSorter;                   /* Cursor opened by OpenSorter (if in use) */
3738   int addr1;                     /* Address of top of loop */
3739   int addr2;                     /* Address to jump to for next iteration */
3740   Pgno tnum;                     /* Root page of index */
3741   int iPartIdxLabel;             /* Jump to this label to skip a row */
3742   Vdbe *v;                       /* Generate code into this virtual machine */
3743   KeyInfo *pKey;                 /* KeyInfo for index */
3744   int regRecord;                 /* Register holding assembled index record */
3745   sqlite3 *db = pParse->db;      /* The database connection */
3746   int iDb = sqlite3SchemaToIndex(db, pIndex->pSchema);
3747 
3748 #ifndef SQLITE_OMIT_AUTHORIZATION
3749   if( sqlite3AuthCheck(pParse, SQLITE_REINDEX, pIndex->zName, 0,
3750       db->aDb[iDb].zDbSName ) ){
3751     return;
3752   }
3753 #endif
3754 
3755   /* Require a write-lock on the table to perform this operation */
3756   sqlite3TableLock(pParse, iDb, pTab->tnum, 1, pTab->zName);
3757 
3758   v = sqlite3GetVdbe(pParse);
3759   if( v==0 ) return;
3760   if( memRootPage>=0 ){
3761     tnum = (Pgno)memRootPage;
3762   }else{
3763     tnum = pIndex->tnum;
3764   }
3765   pKey = sqlite3KeyInfoOfIndex(pParse, pIndex);
3766   assert( pKey!=0 || pParse->nErr );
3767 
3768   /* Open the sorter cursor if we are to use one. */
3769   iSorter = pParse->nTab++;
3770   sqlite3VdbeAddOp4(v, OP_SorterOpen, iSorter, 0, pIndex->nKeyCol, (char*)
3771                     sqlite3KeyInfoRef(pKey), P4_KEYINFO);
3772 
3773   /* Open the table. Loop through all rows of the table, inserting index
3774   ** records into the sorter. */
3775   sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
3776   addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, 0); VdbeCoverage(v);
3777   regRecord = sqlite3GetTempReg(pParse);
3778   sqlite3MultiWrite(pParse);
3779 
3780   sqlite3GenerateIndexKey(pParse,pIndex,iTab,regRecord,0,&iPartIdxLabel,0,0);
3781   sqlite3VdbeAddOp2(v, OP_SorterInsert, iSorter, regRecord);
3782   sqlite3ResolvePartIdxLabel(pParse, iPartIdxLabel);
3783   sqlite3VdbeAddOp2(v, OP_Next, iTab, addr1+1); VdbeCoverage(v);
3784   sqlite3VdbeJumpHere(v, addr1);
3785   if( memRootPage<0 ) sqlite3VdbeAddOp2(v, OP_Clear, tnum, iDb);
3786   sqlite3VdbeAddOp4(v, OP_OpenWrite, iIdx, (int)tnum, iDb,
3787                     (char *)pKey, P4_KEYINFO);
3788   sqlite3VdbeChangeP5(v, OPFLAG_BULKCSR|((memRootPage>=0)?OPFLAG_P2ISREG:0));
3789 
3790   addr1 = sqlite3VdbeAddOp2(v, OP_SorterSort, iSorter, 0); VdbeCoverage(v);
3791   if( IsUniqueIndex(pIndex) ){
3792     int j2 = sqlite3VdbeGoto(v, 1);
3793     addr2 = sqlite3VdbeCurrentAddr(v);
3794     sqlite3VdbeVerifyAbortable(v, OE_Abort);
3795     sqlite3VdbeAddOp4Int(v, OP_SorterCompare, iSorter, j2, regRecord,
3796                          pIndex->nKeyCol); VdbeCoverage(v);
3797     sqlite3UniqueConstraint(pParse, OE_Abort, pIndex);
3798     sqlite3VdbeJumpHere(v, j2);
3799   }else{
3800     /* Most CREATE INDEX and REINDEX statements that are not UNIQUE can not
3801     ** abort. The exception is if one of the indexed expressions contains a
3802     ** user function that throws an exception when it is evaluated. But the
3803     ** overhead of adding a statement journal to a CREATE INDEX statement is
3804     ** very small (since most of the pages written do not contain content that
3805     ** needs to be restored if the statement aborts), so we call
3806     ** sqlite3MayAbort() for all CREATE INDEX statements.  */
3807     sqlite3MayAbort(pParse);
3808     addr2 = sqlite3VdbeCurrentAddr(v);
3809   }
3810   sqlite3VdbeAddOp3(v, OP_SorterData, iSorter, regRecord, iIdx);
3811   if( !pIndex->bAscKeyBug ){
3812     /* This OP_SeekEnd opcode makes index insert for a REINDEX go much
3813     ** faster by avoiding unnecessary seeks.  But the optimization does
3814     ** not work for UNIQUE constraint indexes on WITHOUT ROWID tables
3815     ** with DESC primary keys, since those indexes have there keys in
3816     ** a different order from the main table.
3817     ** See ticket: https://www.sqlite.org/src/info/bba7b69f9849b5bf
3818     */
3819     sqlite3VdbeAddOp1(v, OP_SeekEnd, iIdx);
3820   }
3821   sqlite3VdbeAddOp2(v, OP_IdxInsert, iIdx, regRecord);
3822   sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
3823   sqlite3ReleaseTempReg(pParse, regRecord);
3824   sqlite3VdbeAddOp2(v, OP_SorterNext, iSorter, addr2); VdbeCoverage(v);
3825   sqlite3VdbeJumpHere(v, addr1);
3826 
3827   sqlite3VdbeAddOp1(v, OP_Close, iTab);
3828   sqlite3VdbeAddOp1(v, OP_Close, iIdx);
3829   sqlite3VdbeAddOp1(v, OP_Close, iSorter);
3830 }
3831 
3832 /*
3833 ** Allocate heap space to hold an Index object with nCol columns.
3834 **
3835 ** Increase the allocation size to provide an extra nExtra bytes
3836 ** of 8-byte aligned space after the Index object and return a
3837 ** pointer to this extra space in *ppExtra.
3838 */
3839 Index *sqlite3AllocateIndexObject(
3840   sqlite3 *db,         /* Database connection */
3841   i16 nCol,            /* Total number of columns in the index */
3842   int nExtra,          /* Number of bytes of extra space to alloc */
3843   char **ppExtra       /* Pointer to the "extra" space */
3844 ){
3845   Index *p;            /* Allocated index object */
3846   int nByte;           /* Bytes of space for Index object + arrays */
3847 
3848   nByte = ROUND8(sizeof(Index)) +              /* Index structure  */
3849           ROUND8(sizeof(char*)*nCol) +         /* Index.azColl     */
3850           ROUND8(sizeof(LogEst)*(nCol+1) +     /* Index.aiRowLogEst   */
3851                  sizeof(i16)*nCol +            /* Index.aiColumn   */
3852                  sizeof(u8)*nCol);             /* Index.aSortOrder */
3853   p = sqlite3DbMallocZero(db, nByte + nExtra);
3854   if( p ){
3855     char *pExtra = ((char*)p)+ROUND8(sizeof(Index));
3856     p->azColl = (const char**)pExtra; pExtra += ROUND8(sizeof(char*)*nCol);
3857     p->aiRowLogEst = (LogEst*)pExtra; pExtra += sizeof(LogEst)*(nCol+1);
3858     p->aiColumn = (i16*)pExtra;       pExtra += sizeof(i16)*nCol;
3859     p->aSortOrder = (u8*)pExtra;
3860     p->nColumn = nCol;
3861     p->nKeyCol = nCol - 1;
3862     *ppExtra = ((char*)p) + nByte;
3863   }
3864   return p;
3865 }
3866 
3867 /*
3868 ** If expression list pList contains an expression that was parsed with
3869 ** an explicit "NULLS FIRST" or "NULLS LAST" clause, leave an error in
3870 ** pParse and return non-zero. Otherwise, return zero.
3871 */
3872 int sqlite3HasExplicitNulls(Parse *pParse, ExprList *pList){
3873   if( pList ){
3874     int i;
3875     for(i=0; i<pList->nExpr; i++){
3876       if( pList->a[i].bNulls ){
3877         u8 sf = pList->a[i].sortFlags;
3878         sqlite3ErrorMsg(pParse, "unsupported use of NULLS %s",
3879             (sf==0 || sf==3) ? "FIRST" : "LAST"
3880         );
3881         return 1;
3882       }
3883     }
3884   }
3885   return 0;
3886 }
3887 
3888 /*
3889 ** Create a new index for an SQL table.  pName1.pName2 is the name of the index
3890 ** and pTblList is the name of the table that is to be indexed.  Both will
3891 ** be NULL for a primary key or an index that is created to satisfy a
3892 ** UNIQUE constraint.  If pTable and pIndex are NULL, use pParse->pNewTable
3893 ** as the table to be indexed.  pParse->pNewTable is a table that is
3894 ** currently being constructed by a CREATE TABLE statement.
3895 **
3896 ** pList is a list of columns to be indexed.  pList will be NULL if this
3897 ** is a primary key or unique-constraint on the most recent column added
3898 ** to the table currently under construction.
3899 */
3900 void sqlite3CreateIndex(
3901   Parse *pParse,     /* All information about this parse */
3902   Token *pName1,     /* First part of index name. May be NULL */
3903   Token *pName2,     /* Second part of index name. May be NULL */
3904   SrcList *pTblName, /* Table to index. Use pParse->pNewTable if 0 */
3905   ExprList *pList,   /* A list of columns to be indexed */
3906   int onError,       /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
3907   Token *pStart,     /* The CREATE token that begins this statement */
3908   Expr *pPIWhere,    /* WHERE clause for partial indices */
3909   int sortOrder,     /* Sort order of primary key when pList==NULL */
3910   int ifNotExist,    /* Omit error if index already exists */
3911   u8 idxType         /* The index type */
3912 ){
3913   Table *pTab = 0;     /* Table to be indexed */
3914   Index *pIndex = 0;   /* The index to be created */
3915   char *zName = 0;     /* Name of the index */
3916   int nName;           /* Number of characters in zName */
3917   int i, j;
3918   DbFixer sFix;        /* For assigning database names to pTable */
3919   int sortOrderMask;   /* 1 to honor DESC in index.  0 to ignore. */
3920   sqlite3 *db = pParse->db;
3921   Db *pDb;             /* The specific table containing the indexed database */
3922   int iDb;             /* Index of the database that is being written */
3923   Token *pName = 0;    /* Unqualified name of the index to create */
3924   struct ExprList_item *pListItem; /* For looping over pList */
3925   int nExtra = 0;                  /* Space allocated for zExtra[] */
3926   int nExtraCol;                   /* Number of extra columns needed */
3927   char *zExtra = 0;                /* Extra space after the Index object */
3928   Index *pPk = 0;      /* PRIMARY KEY index for WITHOUT ROWID tables */
3929 
3930   assert( db->pParse==pParse );
3931   if( pParse->nErr ){
3932     goto exit_create_index;
3933   }
3934   assert( db->mallocFailed==0 );
3935   if( IN_DECLARE_VTAB && idxType!=SQLITE_IDXTYPE_PRIMARYKEY ){
3936     goto exit_create_index;
3937   }
3938   if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
3939     goto exit_create_index;
3940   }
3941   if( sqlite3HasExplicitNulls(pParse, pList) ){
3942     goto exit_create_index;
3943   }
3944 
3945   /*
3946   ** Find the table that is to be indexed.  Return early if not found.
3947   */
3948   if( pTblName!=0 ){
3949 
3950     /* Use the two-part index name to determine the database
3951     ** to search for the table. 'Fix' the table name to this db
3952     ** before looking up the table.
3953     */
3954     assert( pName1 && pName2 );
3955     iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pName);
3956     if( iDb<0 ) goto exit_create_index;
3957     assert( pName && pName->z );
3958 
3959 #ifndef SQLITE_OMIT_TEMPDB
3960     /* If the index name was unqualified, check if the table
3961     ** is a temp table. If so, set the database to 1. Do not do this
3962     ** if initialising a database schema.
3963     */
3964     if( !db->init.busy ){
3965       pTab = sqlite3SrcListLookup(pParse, pTblName);
3966       if( pName2->n==0 && pTab && pTab->pSchema==db->aDb[1].pSchema ){
3967         iDb = 1;
3968       }
3969     }
3970 #endif
3971 
3972     sqlite3FixInit(&sFix, pParse, iDb, "index", pName);
3973     if( sqlite3FixSrcList(&sFix, pTblName) ){
3974       /* Because the parser constructs pTblName from a single identifier,
3975       ** sqlite3FixSrcList can never fail. */
3976       assert(0);
3977     }
3978     pTab = sqlite3LocateTableItem(pParse, 0, &pTblName->a[0]);
3979     assert( db->mallocFailed==0 || pTab==0 );
3980     if( pTab==0 ) goto exit_create_index;
3981     if( iDb==1 && db->aDb[iDb].pSchema!=pTab->pSchema ){
3982       sqlite3ErrorMsg(pParse,
3983            "cannot create a TEMP index on non-TEMP table \"%s\"",
3984            pTab->zName);
3985       goto exit_create_index;
3986     }
3987     if( !HasRowid(pTab) ) pPk = sqlite3PrimaryKeyIndex(pTab);
3988   }else{
3989     assert( pName==0 );
3990     assert( pStart==0 );
3991     pTab = pParse->pNewTable;
3992     if( !pTab ) goto exit_create_index;
3993     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
3994   }
3995   pDb = &db->aDb[iDb];
3996 
3997   assert( pTab!=0 );
3998   if( sqlite3StrNICmp(pTab->zName, "sqlite_", 7)==0
3999        && db->init.busy==0
4000        && pTblName!=0
4001 #if SQLITE_USER_AUTHENTICATION
4002        && sqlite3UserAuthTable(pTab->zName)==0
4003 #endif
4004   ){
4005     sqlite3ErrorMsg(pParse, "table %s may not be indexed", pTab->zName);
4006     goto exit_create_index;
4007   }
4008 #ifndef SQLITE_OMIT_VIEW
4009   if( IsView(pTab) ){
4010     sqlite3ErrorMsg(pParse, "views may not be indexed");
4011     goto exit_create_index;
4012   }
4013 #endif
4014 #ifndef SQLITE_OMIT_VIRTUALTABLE
4015   if( IsVirtual(pTab) ){
4016     sqlite3ErrorMsg(pParse, "virtual tables may not be indexed");
4017     goto exit_create_index;
4018   }
4019 #endif
4020 
4021   /*
4022   ** Find the name of the index.  Make sure there is not already another
4023   ** index or table with the same name.
4024   **
4025   ** Exception:  If we are reading the names of permanent indices from the
4026   ** sqlite_schema table (because some other process changed the schema) and
4027   ** one of the index names collides with the name of a temporary table or
4028   ** index, then we will continue to process this index.
4029   **
4030   ** If pName==0 it means that we are
4031   ** dealing with a primary key or UNIQUE constraint.  We have to invent our
4032   ** own name.
4033   */
4034   if( pName ){
4035     zName = sqlite3NameFromToken(db, pName);
4036     if( zName==0 ) goto exit_create_index;
4037     assert( pName->z!=0 );
4038     if( SQLITE_OK!=sqlite3CheckObjectName(pParse, zName,"index",pTab->zName) ){
4039       goto exit_create_index;
4040     }
4041     if( !IN_RENAME_OBJECT ){
4042       if( !db->init.busy ){
4043         if( sqlite3FindTable(db, zName, 0)!=0 ){
4044           sqlite3ErrorMsg(pParse, "there is already a table named %s", zName);
4045           goto exit_create_index;
4046         }
4047       }
4048       if( sqlite3FindIndex(db, zName, pDb->zDbSName)!=0 ){
4049         if( !ifNotExist ){
4050           sqlite3ErrorMsg(pParse, "index %s already exists", zName);
4051         }else{
4052           assert( !db->init.busy );
4053           sqlite3CodeVerifySchema(pParse, iDb);
4054           sqlite3ForceNotReadOnly(pParse);
4055         }
4056         goto exit_create_index;
4057       }
4058     }
4059   }else{
4060     int n;
4061     Index *pLoop;
4062     for(pLoop=pTab->pIndex, n=1; pLoop; pLoop=pLoop->pNext, n++){}
4063     zName = sqlite3MPrintf(db, "sqlite_autoindex_%s_%d", pTab->zName, n);
4064     if( zName==0 ){
4065       goto exit_create_index;
4066     }
4067 
4068     /* Automatic index names generated from within sqlite3_declare_vtab()
4069     ** must have names that are distinct from normal automatic index names.
4070     ** The following statement converts "sqlite3_autoindex..." into
4071     ** "sqlite3_butoindex..." in order to make the names distinct.
4072     ** The "vtab_err.test" test demonstrates the need of this statement. */
4073     if( IN_SPECIAL_PARSE ) zName[7]++;
4074   }
4075 
4076   /* Check for authorization to create an index.
4077   */
4078 #ifndef SQLITE_OMIT_AUTHORIZATION
4079   if( !IN_RENAME_OBJECT ){
4080     const char *zDb = pDb->zDbSName;
4081     if( sqlite3AuthCheck(pParse, SQLITE_INSERT, SCHEMA_TABLE(iDb), 0, zDb) ){
4082       goto exit_create_index;
4083     }
4084     i = SQLITE_CREATE_INDEX;
4085     if( !OMIT_TEMPDB && iDb==1 ) i = SQLITE_CREATE_TEMP_INDEX;
4086     if( sqlite3AuthCheck(pParse, i, zName, pTab->zName, zDb) ){
4087       goto exit_create_index;
4088     }
4089   }
4090 #endif
4091 
4092   /* If pList==0, it means this routine was called to make a primary
4093   ** key out of the last column added to the table under construction.
4094   ** So create a fake list to simulate this.
4095   */
4096   if( pList==0 ){
4097     Token prevCol;
4098     Column *pCol = &pTab->aCol[pTab->nCol-1];
4099     pCol->colFlags |= COLFLAG_UNIQUE;
4100     sqlite3TokenInit(&prevCol, pCol->zCnName);
4101     pList = sqlite3ExprListAppend(pParse, 0,
4102               sqlite3ExprAlloc(db, TK_ID, &prevCol, 0));
4103     if( pList==0 ) goto exit_create_index;
4104     assert( pList->nExpr==1 );
4105     sqlite3ExprListSetSortOrder(pList, sortOrder, SQLITE_SO_UNDEFINED);
4106   }else{
4107     sqlite3ExprListCheckLength(pParse, pList, "index");
4108     if( pParse->nErr ) goto exit_create_index;
4109   }
4110 
4111   /* Figure out how many bytes of space are required to store explicitly
4112   ** specified collation sequence names.
4113   */
4114   for(i=0; i<pList->nExpr; i++){
4115     Expr *pExpr = pList->a[i].pExpr;
4116     assert( pExpr!=0 );
4117     if( pExpr->op==TK_COLLATE ){
4118       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4119       nExtra += (1 + sqlite3Strlen30(pExpr->u.zToken));
4120     }
4121   }
4122 
4123   /*
4124   ** Allocate the index structure.
4125   */
4126   nName = sqlite3Strlen30(zName);
4127   nExtraCol = pPk ? pPk->nKeyCol : 1;
4128   assert( pList->nExpr + nExtraCol <= 32767 /* Fits in i16 */ );
4129   pIndex = sqlite3AllocateIndexObject(db, pList->nExpr + nExtraCol,
4130                                       nName + nExtra + 1, &zExtra);
4131   if( db->mallocFailed ){
4132     goto exit_create_index;
4133   }
4134   assert( EIGHT_BYTE_ALIGNMENT(pIndex->aiRowLogEst) );
4135   assert( EIGHT_BYTE_ALIGNMENT(pIndex->azColl) );
4136   pIndex->zName = zExtra;
4137   zExtra += nName + 1;
4138   memcpy(pIndex->zName, zName, nName+1);
4139   pIndex->pTable = pTab;
4140   pIndex->onError = (u8)onError;
4141   pIndex->uniqNotNull = onError!=OE_None;
4142   pIndex->idxType = idxType;
4143   pIndex->pSchema = db->aDb[iDb].pSchema;
4144   pIndex->nKeyCol = pList->nExpr;
4145   if( pPIWhere ){
4146     sqlite3ResolveSelfReference(pParse, pTab, NC_PartIdx, pPIWhere, 0);
4147     pIndex->pPartIdxWhere = pPIWhere;
4148     pPIWhere = 0;
4149   }
4150   assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
4151 
4152   /* Check to see if we should honor DESC requests on index columns
4153   */
4154   if( pDb->pSchema->file_format>=4 ){
4155     sortOrderMask = -1;   /* Honor DESC */
4156   }else{
4157     sortOrderMask = 0;    /* Ignore DESC */
4158   }
4159 
4160   /* Analyze the list of expressions that form the terms of the index and
4161   ** report any errors.  In the common case where the expression is exactly
4162   ** a table column, store that column in aiColumn[].  For general expressions,
4163   ** populate pIndex->aColExpr and store XN_EXPR (-2) in aiColumn[].
4164   **
4165   ** TODO: Issue a warning if two or more columns of the index are identical.
4166   ** TODO: Issue a warning if the table primary key is used as part of the
4167   ** index key.
4168   */
4169   pListItem = pList->a;
4170   if( IN_RENAME_OBJECT ){
4171     pIndex->aColExpr = pList;
4172     pList = 0;
4173   }
4174   for(i=0; i<pIndex->nKeyCol; i++, pListItem++){
4175     Expr *pCExpr;                  /* The i-th index expression */
4176     int requestedSortOrder;        /* ASC or DESC on the i-th expression */
4177     const char *zColl;             /* Collation sequence name */
4178 
4179     sqlite3StringToId(pListItem->pExpr);
4180     sqlite3ResolveSelfReference(pParse, pTab, NC_IdxExpr, pListItem->pExpr, 0);
4181     if( pParse->nErr ) goto exit_create_index;
4182     pCExpr = sqlite3ExprSkipCollate(pListItem->pExpr);
4183     if( pCExpr->op!=TK_COLUMN ){
4184       if( pTab==pParse->pNewTable ){
4185         sqlite3ErrorMsg(pParse, "expressions prohibited in PRIMARY KEY and "
4186                                 "UNIQUE constraints");
4187         goto exit_create_index;
4188       }
4189       if( pIndex->aColExpr==0 ){
4190         pIndex->aColExpr = pList;
4191         pList = 0;
4192       }
4193       j = XN_EXPR;
4194       pIndex->aiColumn[i] = XN_EXPR;
4195       pIndex->uniqNotNull = 0;
4196     }else{
4197       j = pCExpr->iColumn;
4198       assert( j<=0x7fff );
4199       if( j<0 ){
4200         j = pTab->iPKey;
4201       }else{
4202         if( pTab->aCol[j].notNull==0 ){
4203           pIndex->uniqNotNull = 0;
4204         }
4205         if( pTab->aCol[j].colFlags & COLFLAG_VIRTUAL ){
4206           pIndex->bHasVCol = 1;
4207         }
4208       }
4209       pIndex->aiColumn[i] = (i16)j;
4210     }
4211     zColl = 0;
4212     if( pListItem->pExpr->op==TK_COLLATE ){
4213       int nColl;
4214       assert( !ExprHasProperty(pListItem->pExpr, EP_IntValue) );
4215       zColl = pListItem->pExpr->u.zToken;
4216       nColl = sqlite3Strlen30(zColl) + 1;
4217       assert( nExtra>=nColl );
4218       memcpy(zExtra, zColl, nColl);
4219       zColl = zExtra;
4220       zExtra += nColl;
4221       nExtra -= nColl;
4222     }else if( j>=0 ){
4223       zColl = sqlite3ColumnColl(&pTab->aCol[j]);
4224     }
4225     if( !zColl ) zColl = sqlite3StrBINARY;
4226     if( !db->init.busy && !sqlite3LocateCollSeq(pParse, zColl) ){
4227       goto exit_create_index;
4228     }
4229     pIndex->azColl[i] = zColl;
4230     requestedSortOrder = pListItem->sortFlags & sortOrderMask;
4231     pIndex->aSortOrder[i] = (u8)requestedSortOrder;
4232   }
4233 
4234   /* Append the table key to the end of the index.  For WITHOUT ROWID
4235   ** tables (when pPk!=0) this will be the declared PRIMARY KEY.  For
4236   ** normal tables (when pPk==0) this will be the rowid.
4237   */
4238   if( pPk ){
4239     for(j=0; j<pPk->nKeyCol; j++){
4240       int x = pPk->aiColumn[j];
4241       assert( x>=0 );
4242       if( isDupColumn(pIndex, pIndex->nKeyCol, pPk, j) ){
4243         pIndex->nColumn--;
4244       }else{
4245         testcase( hasColumn(pIndex->aiColumn,pIndex->nKeyCol,x) );
4246         pIndex->aiColumn[i] = x;
4247         pIndex->azColl[i] = pPk->azColl[j];
4248         pIndex->aSortOrder[i] = pPk->aSortOrder[j];
4249         i++;
4250       }
4251     }
4252     assert( i==pIndex->nColumn );
4253   }else{
4254     pIndex->aiColumn[i] = XN_ROWID;
4255     pIndex->azColl[i] = sqlite3StrBINARY;
4256   }
4257   sqlite3DefaultRowEst(pIndex);
4258   if( pParse->pNewTable==0 ) estimateIndexWidth(pIndex);
4259 
4260   /* If this index contains every column of its table, then mark
4261   ** it as a covering index */
4262   assert( HasRowid(pTab)
4263       || pTab->iPKey<0 || sqlite3TableColumnToIndex(pIndex, pTab->iPKey)>=0 );
4264   recomputeColumnsNotIndexed(pIndex);
4265   if( pTblName!=0 && pIndex->nColumn>=pTab->nCol ){
4266     pIndex->isCovering = 1;
4267     for(j=0; j<pTab->nCol; j++){
4268       if( j==pTab->iPKey ) continue;
4269       if( sqlite3TableColumnToIndex(pIndex,j)>=0 ) continue;
4270       pIndex->isCovering = 0;
4271       break;
4272     }
4273   }
4274 
4275   if( pTab==pParse->pNewTable ){
4276     /* This routine has been called to create an automatic index as a
4277     ** result of a PRIMARY KEY or UNIQUE clause on a column definition, or
4278     ** a PRIMARY KEY or UNIQUE clause following the column definitions.
4279     ** i.e. one of:
4280     **
4281     ** CREATE TABLE t(x PRIMARY KEY, y);
4282     ** CREATE TABLE t(x, y, UNIQUE(x, y));
4283     **
4284     ** Either way, check to see if the table already has such an index. If
4285     ** so, don't bother creating this one. This only applies to
4286     ** automatically created indices. Users can do as they wish with
4287     ** explicit indices.
4288     **
4289     ** Two UNIQUE or PRIMARY KEY constraints are considered equivalent
4290     ** (and thus suppressing the second one) even if they have different
4291     ** sort orders.
4292     **
4293     ** If there are different collating sequences or if the columns of
4294     ** the constraint occur in different orders, then the constraints are
4295     ** considered distinct and both result in separate indices.
4296     */
4297     Index *pIdx;
4298     for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
4299       int k;
4300       assert( IsUniqueIndex(pIdx) );
4301       assert( pIdx->idxType!=SQLITE_IDXTYPE_APPDEF );
4302       assert( IsUniqueIndex(pIndex) );
4303 
4304       if( pIdx->nKeyCol!=pIndex->nKeyCol ) continue;
4305       for(k=0; k<pIdx->nKeyCol; k++){
4306         const char *z1;
4307         const char *z2;
4308         assert( pIdx->aiColumn[k]>=0 );
4309         if( pIdx->aiColumn[k]!=pIndex->aiColumn[k] ) break;
4310         z1 = pIdx->azColl[k];
4311         z2 = pIndex->azColl[k];
4312         if( sqlite3StrICmp(z1, z2) ) break;
4313       }
4314       if( k==pIdx->nKeyCol ){
4315         if( pIdx->onError!=pIndex->onError ){
4316           /* This constraint creates the same index as a previous
4317           ** constraint specified somewhere in the CREATE TABLE statement.
4318           ** However the ON CONFLICT clauses are different. If both this
4319           ** constraint and the previous equivalent constraint have explicit
4320           ** ON CONFLICT clauses this is an error. Otherwise, use the
4321           ** explicitly specified behavior for the index.
4322           */
4323           if( !(pIdx->onError==OE_Default || pIndex->onError==OE_Default) ){
4324             sqlite3ErrorMsg(pParse,
4325                 "conflicting ON CONFLICT clauses specified", 0);
4326           }
4327           if( pIdx->onError==OE_Default ){
4328             pIdx->onError = pIndex->onError;
4329           }
4330         }
4331         if( idxType==SQLITE_IDXTYPE_PRIMARYKEY ) pIdx->idxType = idxType;
4332         if( IN_RENAME_OBJECT ){
4333           pIndex->pNext = pParse->pNewIndex;
4334           pParse->pNewIndex = pIndex;
4335           pIndex = 0;
4336         }
4337         goto exit_create_index;
4338       }
4339     }
4340   }
4341 
4342   if( !IN_RENAME_OBJECT ){
4343 
4344     /* Link the new Index structure to its table and to the other
4345     ** in-memory database structures.
4346     */
4347     assert( pParse->nErr==0 );
4348     if( db->init.busy ){
4349       Index *p;
4350       assert( !IN_SPECIAL_PARSE );
4351       assert( sqlite3SchemaMutexHeld(db, 0, pIndex->pSchema) );
4352       if( pTblName!=0 ){
4353         pIndex->tnum = db->init.newTnum;
4354         if( sqlite3IndexHasDuplicateRootPage(pIndex) ){
4355           sqlite3ErrorMsg(pParse, "invalid rootpage");
4356           pParse->rc = SQLITE_CORRUPT_BKPT;
4357           goto exit_create_index;
4358         }
4359       }
4360       p = sqlite3HashInsert(&pIndex->pSchema->idxHash,
4361           pIndex->zName, pIndex);
4362       if( p ){
4363         assert( p==pIndex );  /* Malloc must have failed */
4364         sqlite3OomFault(db);
4365         goto exit_create_index;
4366       }
4367       db->mDbFlags |= DBFLAG_SchemaChange;
4368     }
4369 
4370     /* If this is the initial CREATE INDEX statement (or CREATE TABLE if the
4371     ** index is an implied index for a UNIQUE or PRIMARY KEY constraint) then
4372     ** emit code to allocate the index rootpage on disk and make an entry for
4373     ** the index in the sqlite_schema table and populate the index with
4374     ** content.  But, do not do this if we are simply reading the sqlite_schema
4375     ** table to parse the schema, or if this index is the PRIMARY KEY index
4376     ** of a WITHOUT ROWID table.
4377     **
4378     ** If pTblName==0 it means this index is generated as an implied PRIMARY KEY
4379     ** or UNIQUE index in a CREATE TABLE statement.  Since the table
4380     ** has just been created, it contains no data and the index initialization
4381     ** step can be skipped.
4382     */
4383     else if( HasRowid(pTab) || pTblName!=0 ){
4384       Vdbe *v;
4385       char *zStmt;
4386       int iMem = ++pParse->nMem;
4387 
4388       v = sqlite3GetVdbe(pParse);
4389       if( v==0 ) goto exit_create_index;
4390 
4391       sqlite3BeginWriteOperation(pParse, 1, iDb);
4392 
4393       /* Create the rootpage for the index using CreateIndex. But before
4394       ** doing so, code a Noop instruction and store its address in
4395       ** Index.tnum. This is required in case this index is actually a
4396       ** PRIMARY KEY and the table is actually a WITHOUT ROWID table. In
4397       ** that case the convertToWithoutRowidTable() routine will replace
4398       ** the Noop with a Goto to jump over the VDBE code generated below. */
4399       pIndex->tnum = (Pgno)sqlite3VdbeAddOp0(v, OP_Noop);
4400       sqlite3VdbeAddOp3(v, OP_CreateBtree, iDb, iMem, BTREE_BLOBKEY);
4401 
4402       /* Gather the complete text of the CREATE INDEX statement into
4403       ** the zStmt variable
4404       */
4405       assert( pName!=0 || pStart==0 );
4406       if( pStart ){
4407         int n = (int)(pParse->sLastToken.z - pName->z) + pParse->sLastToken.n;
4408         if( pName->z[n-1]==';' ) n--;
4409         /* A named index with an explicit CREATE INDEX statement */
4410         zStmt = sqlite3MPrintf(db, "CREATE%s INDEX %.*s",
4411             onError==OE_None ? "" : " UNIQUE", n, pName->z);
4412       }else{
4413         /* An automatic index created by a PRIMARY KEY or UNIQUE constraint */
4414         /* zStmt = sqlite3MPrintf(""); */
4415         zStmt = 0;
4416       }
4417 
4418       /* Add an entry in sqlite_schema for this index
4419       */
4420       sqlite3NestedParse(pParse,
4421          "INSERT INTO %Q." LEGACY_SCHEMA_TABLE " VALUES('index',%Q,%Q,#%d,%Q);",
4422          db->aDb[iDb].zDbSName,
4423          pIndex->zName,
4424          pTab->zName,
4425          iMem,
4426          zStmt
4427       );
4428       sqlite3DbFree(db, zStmt);
4429 
4430       /* Fill the index with data and reparse the schema. Code an OP_Expire
4431       ** to invalidate all pre-compiled statements.
4432       */
4433       if( pTblName ){
4434         sqlite3RefillIndex(pParse, pIndex, iMem);
4435         sqlite3ChangeCookie(pParse, iDb);
4436         sqlite3VdbeAddParseSchemaOp(v, iDb,
4437             sqlite3MPrintf(db, "name='%q' AND type='index'", pIndex->zName), 0);
4438         sqlite3VdbeAddOp2(v, OP_Expire, 0, 1);
4439       }
4440 
4441       sqlite3VdbeJumpHere(v, (int)pIndex->tnum);
4442     }
4443   }
4444   if( db->init.busy || pTblName==0 ){
4445     pIndex->pNext = pTab->pIndex;
4446     pTab->pIndex = pIndex;
4447     pIndex = 0;
4448   }
4449   else if( IN_RENAME_OBJECT ){
4450     assert( pParse->pNewIndex==0 );
4451     pParse->pNewIndex = pIndex;
4452     pIndex = 0;
4453   }
4454 
4455   /* Clean up before exiting */
4456 exit_create_index:
4457   if( pIndex ) sqlite3FreeIndex(db, pIndex);
4458   if( pTab ){
4459     /* Ensure all REPLACE indexes on pTab are at the end of the pIndex list.
4460     ** The list was already ordered when this routine was entered, so at this
4461     ** point at most a single index (the newly added index) will be out of
4462     ** order.  So we have to reorder at most one index. */
4463     Index **ppFrom;
4464     Index *pThis;
4465     for(ppFrom=&pTab->pIndex; (pThis = *ppFrom)!=0; ppFrom=&pThis->pNext){
4466       Index *pNext;
4467       if( pThis->onError!=OE_Replace ) continue;
4468       while( (pNext = pThis->pNext)!=0 && pNext->onError!=OE_Replace ){
4469         *ppFrom = pNext;
4470         pThis->pNext = pNext->pNext;
4471         pNext->pNext = pThis;
4472         ppFrom = &pNext->pNext;
4473       }
4474       break;
4475     }
4476 #ifdef SQLITE_DEBUG
4477     /* Verify that all REPLACE indexes really are now at the end
4478     ** of the index list.  In other words, no other index type ever
4479     ** comes after a REPLACE index on the list. */
4480     for(pThis = pTab->pIndex; pThis; pThis=pThis->pNext){
4481       assert( pThis->onError!=OE_Replace
4482            || pThis->pNext==0
4483            || pThis->pNext->onError==OE_Replace );
4484     }
4485 #endif
4486   }
4487   sqlite3ExprDelete(db, pPIWhere);
4488   sqlite3ExprListDelete(db, pList);
4489   sqlite3SrcListDelete(db, pTblName);
4490   sqlite3DbFree(db, zName);
4491 }
4492 
4493 /*
4494 ** Fill the Index.aiRowEst[] array with default information - information
4495 ** to be used when we have not run the ANALYZE command.
4496 **
4497 ** aiRowEst[0] is supposed to contain the number of elements in the index.
4498 ** Since we do not know, guess 1 million.  aiRowEst[1] is an estimate of the
4499 ** number of rows in the table that match any particular value of the
4500 ** first column of the index.  aiRowEst[2] is an estimate of the number
4501 ** of rows that match any particular combination of the first 2 columns
4502 ** of the index.  And so forth.  It must always be the case that
4503 *
4504 **           aiRowEst[N]<=aiRowEst[N-1]
4505 **           aiRowEst[N]>=1
4506 **
4507 ** Apart from that, we have little to go on besides intuition as to
4508 ** how aiRowEst[] should be initialized.  The numbers generated here
4509 ** are based on typical values found in actual indices.
4510 */
4511 void sqlite3DefaultRowEst(Index *pIdx){
4512                /*                10,  9,  8,  7,  6 */
4513   static const LogEst aVal[] = { 33, 32, 30, 28, 26 };
4514   LogEst *a = pIdx->aiRowLogEst;
4515   LogEst x;
4516   int nCopy = MIN(ArraySize(aVal), pIdx->nKeyCol);
4517   int i;
4518 
4519   /* Indexes with default row estimates should not have stat1 data */
4520   assert( !pIdx->hasStat1 );
4521 
4522   /* Set the first entry (number of rows in the index) to the estimated
4523   ** number of rows in the table, or half the number of rows in the table
4524   ** for a partial index.
4525   **
4526   ** 2020-05-27:  If some of the stat data is coming from the sqlite_stat1
4527   ** table but other parts we are having to guess at, then do not let the
4528   ** estimated number of rows in the table be less than 1000 (LogEst 99).
4529   ** Failure to do this can cause the indexes for which we do not have
4530   ** stat1 data to be ignored by the query planner.
4531   */
4532   x = pIdx->pTable->nRowLogEst;
4533   assert( 99==sqlite3LogEst(1000) );
4534   if( x<99 ){
4535     pIdx->pTable->nRowLogEst = x = 99;
4536   }
4537   if( pIdx->pPartIdxWhere!=0 ){ x -= 10;  assert( 10==sqlite3LogEst(2) ); }
4538   a[0] = x;
4539 
4540   /* Estimate that a[1] is 10, a[2] is 9, a[3] is 8, a[4] is 7, a[5] is
4541   ** 6 and each subsequent value (if any) is 5.  */
4542   memcpy(&a[1], aVal, nCopy*sizeof(LogEst));
4543   for(i=nCopy+1; i<=pIdx->nKeyCol; i++){
4544     a[i] = 23;                    assert( 23==sqlite3LogEst(5) );
4545   }
4546 
4547   assert( 0==sqlite3LogEst(1) );
4548   if( IsUniqueIndex(pIdx) ) a[pIdx->nKeyCol] = 0;
4549 }
4550 
4551 /*
4552 ** This routine will drop an existing named index.  This routine
4553 ** implements the DROP INDEX statement.
4554 */
4555 void sqlite3DropIndex(Parse *pParse, SrcList *pName, int ifExists){
4556   Index *pIndex;
4557   Vdbe *v;
4558   sqlite3 *db = pParse->db;
4559   int iDb;
4560 
4561   if( db->mallocFailed ){
4562     goto exit_drop_index;
4563   }
4564   assert( pParse->nErr==0 );   /* Never called with prior non-OOM errors */
4565   assert( pName->nSrc==1 );
4566   if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
4567     goto exit_drop_index;
4568   }
4569   pIndex = sqlite3FindIndex(db, pName->a[0].zName, pName->a[0].zDatabase);
4570   if( pIndex==0 ){
4571     if( !ifExists ){
4572       sqlite3ErrorMsg(pParse, "no such index: %S", pName->a);
4573     }else{
4574       sqlite3CodeVerifyNamedSchema(pParse, pName->a[0].zDatabase);
4575       sqlite3ForceNotReadOnly(pParse);
4576     }
4577     pParse->checkSchema = 1;
4578     goto exit_drop_index;
4579   }
4580   if( pIndex->idxType!=SQLITE_IDXTYPE_APPDEF ){
4581     sqlite3ErrorMsg(pParse, "index associated with UNIQUE "
4582       "or PRIMARY KEY constraint cannot be dropped", 0);
4583     goto exit_drop_index;
4584   }
4585   iDb = sqlite3SchemaToIndex(db, pIndex->pSchema);
4586 #ifndef SQLITE_OMIT_AUTHORIZATION
4587   {
4588     int code = SQLITE_DROP_INDEX;
4589     Table *pTab = pIndex->pTable;
4590     const char *zDb = db->aDb[iDb].zDbSName;
4591     const char *zTab = SCHEMA_TABLE(iDb);
4592     if( sqlite3AuthCheck(pParse, SQLITE_DELETE, zTab, 0, zDb) ){
4593       goto exit_drop_index;
4594     }
4595     if( !OMIT_TEMPDB && iDb==1 ) code = SQLITE_DROP_TEMP_INDEX;
4596     if( sqlite3AuthCheck(pParse, code, pIndex->zName, pTab->zName, zDb) ){
4597       goto exit_drop_index;
4598     }
4599   }
4600 #endif
4601 
4602   /* Generate code to remove the index and from the schema table */
4603   v = sqlite3GetVdbe(pParse);
4604   if( v ){
4605     sqlite3BeginWriteOperation(pParse, 1, iDb);
4606     sqlite3NestedParse(pParse,
4607        "DELETE FROM %Q." LEGACY_SCHEMA_TABLE " WHERE name=%Q AND type='index'",
4608        db->aDb[iDb].zDbSName, pIndex->zName
4609     );
4610     sqlite3ClearStatTables(pParse, iDb, "idx", pIndex->zName);
4611     sqlite3ChangeCookie(pParse, iDb);
4612     destroyRootPage(pParse, pIndex->tnum, iDb);
4613     sqlite3VdbeAddOp4(v, OP_DropIndex, iDb, 0, 0, pIndex->zName, 0);
4614   }
4615 
4616 exit_drop_index:
4617   sqlite3SrcListDelete(db, pName);
4618 }
4619 
4620 /*
4621 ** pArray is a pointer to an array of objects. Each object in the
4622 ** array is szEntry bytes in size. This routine uses sqlite3DbRealloc()
4623 ** to extend the array so that there is space for a new object at the end.
4624 **
4625 ** When this function is called, *pnEntry contains the current size of
4626 ** the array (in entries - so the allocation is ((*pnEntry) * szEntry) bytes
4627 ** in total).
4628 **
4629 ** If the realloc() is successful (i.e. if no OOM condition occurs), the
4630 ** space allocated for the new object is zeroed, *pnEntry updated to
4631 ** reflect the new size of the array and a pointer to the new allocation
4632 ** returned. *pIdx is set to the index of the new array entry in this case.
4633 **
4634 ** Otherwise, if the realloc() fails, *pIdx is set to -1, *pnEntry remains
4635 ** unchanged and a copy of pArray returned.
4636 */
4637 void *sqlite3ArrayAllocate(
4638   sqlite3 *db,      /* Connection to notify of malloc failures */
4639   void *pArray,     /* Array of objects.  Might be reallocated */
4640   int szEntry,      /* Size of each object in the array */
4641   int *pnEntry,     /* Number of objects currently in use */
4642   int *pIdx         /* Write the index of a new slot here */
4643 ){
4644   char *z;
4645   sqlite3_int64 n = *pIdx = *pnEntry;
4646   if( (n & (n-1))==0 ){
4647     sqlite3_int64 sz = (n==0) ? 1 : 2*n;
4648     void *pNew = sqlite3DbRealloc(db, pArray, sz*szEntry);
4649     if( pNew==0 ){
4650       *pIdx = -1;
4651       return pArray;
4652     }
4653     pArray = pNew;
4654   }
4655   z = (char*)pArray;
4656   memset(&z[n * szEntry], 0, szEntry);
4657   ++*pnEntry;
4658   return pArray;
4659 }
4660 
4661 /*
4662 ** Append a new element to the given IdList.  Create a new IdList if
4663 ** need be.
4664 **
4665 ** A new IdList is returned, or NULL if malloc() fails.
4666 */
4667 IdList *sqlite3IdListAppend(Parse *pParse, IdList *pList, Token *pToken){
4668   sqlite3 *db = pParse->db;
4669   int i;
4670   if( pList==0 ){
4671     pList = sqlite3DbMallocZero(db, sizeof(IdList) );
4672     if( pList==0 ) return 0;
4673   }
4674   pList->a = sqlite3ArrayAllocate(
4675       db,
4676       pList->a,
4677       sizeof(pList->a[0]),
4678       &pList->nId,
4679       &i
4680   );
4681   if( i<0 ){
4682     sqlite3IdListDelete(db, pList);
4683     return 0;
4684   }
4685   pList->a[i].zName = sqlite3NameFromToken(db, pToken);
4686   if( IN_RENAME_OBJECT && pList->a[i].zName ){
4687     sqlite3RenameTokenMap(pParse, (void*)pList->a[i].zName, pToken);
4688   }
4689   return pList;
4690 }
4691 
4692 /*
4693 ** Delete an IdList.
4694 */
4695 void sqlite3IdListDelete(sqlite3 *db, IdList *pList){
4696   int i;
4697   if( pList==0 ) return;
4698   for(i=0; i<pList->nId; i++){
4699     sqlite3DbFree(db, pList->a[i].zName);
4700   }
4701   sqlite3DbFree(db, pList->a);
4702   sqlite3DbFreeNN(db, pList);
4703 }
4704 
4705 /*
4706 ** Return the index in pList of the identifier named zId.  Return -1
4707 ** if not found.
4708 */
4709 int sqlite3IdListIndex(IdList *pList, const char *zName){
4710   int i;
4711   if( pList==0 ) return -1;
4712   for(i=0; i<pList->nId; i++){
4713     if( sqlite3StrICmp(pList->a[i].zName, zName)==0 ) return i;
4714   }
4715   return -1;
4716 }
4717 
4718 /*
4719 ** Maximum size of a SrcList object.
4720 ** The SrcList object is used to represent the FROM clause of a
4721 ** SELECT statement, and the query planner cannot deal with more
4722 ** than 64 tables in a join.  So any value larger than 64 here
4723 ** is sufficient for most uses.  Smaller values, like say 10, are
4724 ** appropriate for small and memory-limited applications.
4725 */
4726 #ifndef SQLITE_MAX_SRCLIST
4727 # define SQLITE_MAX_SRCLIST 200
4728 #endif
4729 
4730 /*
4731 ** Expand the space allocated for the given SrcList object by
4732 ** creating nExtra new slots beginning at iStart.  iStart is zero based.
4733 ** New slots are zeroed.
4734 **
4735 ** For example, suppose a SrcList initially contains two entries: A,B.
4736 ** To append 3 new entries onto the end, do this:
4737 **
4738 **    sqlite3SrcListEnlarge(db, pSrclist, 3, 2);
4739 **
4740 ** After the call above it would contain:  A, B, nil, nil, nil.
4741 ** If the iStart argument had been 1 instead of 2, then the result
4742 ** would have been:  A, nil, nil, nil, B.  To prepend the new slots,
4743 ** the iStart value would be 0.  The result then would
4744 ** be: nil, nil, nil, A, B.
4745 **
4746 ** If a memory allocation fails or the SrcList becomes too large, leave
4747 ** the original SrcList unchanged, return NULL, and leave an error message
4748 ** in pParse.
4749 */
4750 SrcList *sqlite3SrcListEnlarge(
4751   Parse *pParse,     /* Parsing context into which errors are reported */
4752   SrcList *pSrc,     /* The SrcList to be enlarged */
4753   int nExtra,        /* Number of new slots to add to pSrc->a[] */
4754   int iStart         /* Index in pSrc->a[] of first new slot */
4755 ){
4756   int i;
4757 
4758   /* Sanity checking on calling parameters */
4759   assert( iStart>=0 );
4760   assert( nExtra>=1 );
4761   assert( pSrc!=0 );
4762   assert( iStart<=pSrc->nSrc );
4763 
4764   /* Allocate additional space if needed */
4765   if( (u32)pSrc->nSrc+nExtra>pSrc->nAlloc ){
4766     SrcList *pNew;
4767     sqlite3_int64 nAlloc = 2*(sqlite3_int64)pSrc->nSrc+nExtra;
4768     sqlite3 *db = pParse->db;
4769 
4770     if( pSrc->nSrc+nExtra>=SQLITE_MAX_SRCLIST ){
4771       sqlite3ErrorMsg(pParse, "too many FROM clause terms, max: %d",
4772                       SQLITE_MAX_SRCLIST);
4773       return 0;
4774     }
4775     if( nAlloc>SQLITE_MAX_SRCLIST ) nAlloc = SQLITE_MAX_SRCLIST;
4776     pNew = sqlite3DbRealloc(db, pSrc,
4777                sizeof(*pSrc) + (nAlloc-1)*sizeof(pSrc->a[0]) );
4778     if( pNew==0 ){
4779       assert( db->mallocFailed );
4780       return 0;
4781     }
4782     pSrc = pNew;
4783     pSrc->nAlloc = nAlloc;
4784   }
4785 
4786   /* Move existing slots that come after the newly inserted slots
4787   ** out of the way */
4788   for(i=pSrc->nSrc-1; i>=iStart; i--){
4789     pSrc->a[i+nExtra] = pSrc->a[i];
4790   }
4791   pSrc->nSrc += nExtra;
4792 
4793   /* Zero the newly allocated slots */
4794   memset(&pSrc->a[iStart], 0, sizeof(pSrc->a[0])*nExtra);
4795   for(i=iStart; i<iStart+nExtra; i++){
4796     pSrc->a[i].iCursor = -1;
4797   }
4798 
4799   /* Return a pointer to the enlarged SrcList */
4800   return pSrc;
4801 }
4802 
4803 
4804 /*
4805 ** Append a new table name to the given SrcList.  Create a new SrcList if
4806 ** need be.  A new entry is created in the SrcList even if pTable is NULL.
4807 **
4808 ** A SrcList is returned, or NULL if there is an OOM error or if the
4809 ** SrcList grows to large.  The returned
4810 ** SrcList might be the same as the SrcList that was input or it might be
4811 ** a new one.  If an OOM error does occurs, then the prior value of pList
4812 ** that is input to this routine is automatically freed.
4813 **
4814 ** If pDatabase is not null, it means that the table has an optional
4815 ** database name prefix.  Like this:  "database.table".  The pDatabase
4816 ** points to the table name and the pTable points to the database name.
4817 ** The SrcList.a[].zName field is filled with the table name which might
4818 ** come from pTable (if pDatabase is NULL) or from pDatabase.
4819 ** SrcList.a[].zDatabase is filled with the database name from pTable,
4820 ** or with NULL if no database is specified.
4821 **
4822 ** In other words, if call like this:
4823 **
4824 **         sqlite3SrcListAppend(D,A,B,0);
4825 **
4826 ** Then B is a table name and the database name is unspecified.  If called
4827 ** like this:
4828 **
4829 **         sqlite3SrcListAppend(D,A,B,C);
4830 **
4831 ** Then C is the table name and B is the database name.  If C is defined
4832 ** then so is B.  In other words, we never have a case where:
4833 **
4834 **         sqlite3SrcListAppend(D,A,0,C);
4835 **
4836 ** Both pTable and pDatabase are assumed to be quoted.  They are dequoted
4837 ** before being added to the SrcList.
4838 */
4839 SrcList *sqlite3SrcListAppend(
4840   Parse *pParse,      /* Parsing context, in which errors are reported */
4841   SrcList *pList,     /* Append to this SrcList. NULL creates a new SrcList */
4842   Token *pTable,      /* Table to append */
4843   Token *pDatabase    /* Database of the table */
4844 ){
4845   SrcItem *pItem;
4846   sqlite3 *db;
4847   assert( pDatabase==0 || pTable!=0 );  /* Cannot have C without B */
4848   assert( pParse!=0 );
4849   assert( pParse->db!=0 );
4850   db = pParse->db;
4851   if( pList==0 ){
4852     pList = sqlite3DbMallocRawNN(pParse->db, sizeof(SrcList) );
4853     if( pList==0 ) return 0;
4854     pList->nAlloc = 1;
4855     pList->nSrc = 1;
4856     memset(&pList->a[0], 0, sizeof(pList->a[0]));
4857     pList->a[0].iCursor = -1;
4858   }else{
4859     SrcList *pNew = sqlite3SrcListEnlarge(pParse, pList, 1, pList->nSrc);
4860     if( pNew==0 ){
4861       sqlite3SrcListDelete(db, pList);
4862       return 0;
4863     }else{
4864       pList = pNew;
4865     }
4866   }
4867   pItem = &pList->a[pList->nSrc-1];
4868   if( pDatabase && pDatabase->z==0 ){
4869     pDatabase = 0;
4870   }
4871   if( pDatabase ){
4872     pItem->zName = sqlite3NameFromToken(db, pDatabase);
4873     pItem->zDatabase = sqlite3NameFromToken(db, pTable);
4874   }else{
4875     pItem->zName = sqlite3NameFromToken(db, pTable);
4876     pItem->zDatabase = 0;
4877   }
4878   return pList;
4879 }
4880 
4881 /*
4882 ** Assign VdbeCursor index numbers to all tables in a SrcList
4883 */
4884 void sqlite3SrcListAssignCursors(Parse *pParse, SrcList *pList){
4885   int i;
4886   SrcItem *pItem;
4887   assert( pList || pParse->db->mallocFailed );
4888   if( ALWAYS(pList) ){
4889     for(i=0, pItem=pList->a; i<pList->nSrc; i++, pItem++){
4890       if( pItem->iCursor>=0 ) continue;
4891       pItem->iCursor = pParse->nTab++;
4892       if( pItem->pSelect ){
4893         sqlite3SrcListAssignCursors(pParse, pItem->pSelect->pSrc);
4894       }
4895     }
4896   }
4897 }
4898 
4899 /*
4900 ** Delete an entire SrcList including all its substructure.
4901 */
4902 void sqlite3SrcListDelete(sqlite3 *db, SrcList *pList){
4903   int i;
4904   SrcItem *pItem;
4905   if( pList==0 ) return;
4906   for(pItem=pList->a, i=0; i<pList->nSrc; i++, pItem++){
4907     if( pItem->zDatabase ) sqlite3DbFreeNN(db, pItem->zDatabase);
4908     sqlite3DbFree(db, pItem->zName);
4909     if( pItem->zAlias ) sqlite3DbFreeNN(db, pItem->zAlias);
4910     if( pItem->fg.isIndexedBy ) sqlite3DbFree(db, pItem->u1.zIndexedBy);
4911     if( pItem->fg.isTabFunc ) sqlite3ExprListDelete(db, pItem->u1.pFuncArg);
4912     sqlite3DeleteTable(db, pItem->pTab);
4913     if( pItem->pSelect ) sqlite3SelectDelete(db, pItem->pSelect);
4914     if( pItem->pOn ) sqlite3ExprDelete(db, pItem->pOn);
4915     if( pItem->pUsing ) sqlite3IdListDelete(db, pItem->pUsing);
4916   }
4917   sqlite3DbFreeNN(db, pList);
4918 }
4919 
4920 /*
4921 ** This routine is called by the parser to add a new term to the
4922 ** end of a growing FROM clause.  The "p" parameter is the part of
4923 ** the FROM clause that has already been constructed.  "p" is NULL
4924 ** if this is the first term of the FROM clause.  pTable and pDatabase
4925 ** are the name of the table and database named in the FROM clause term.
4926 ** pDatabase is NULL if the database name qualifier is missing - the
4927 ** usual case.  If the term has an alias, then pAlias points to the
4928 ** alias token.  If the term is a subquery, then pSubquery is the
4929 ** SELECT statement that the subquery encodes.  The pTable and
4930 ** pDatabase parameters are NULL for subqueries.  The pOn and pUsing
4931 ** parameters are the content of the ON and USING clauses.
4932 **
4933 ** Return a new SrcList which encodes is the FROM with the new
4934 ** term added.
4935 */
4936 SrcList *sqlite3SrcListAppendFromTerm(
4937   Parse *pParse,          /* Parsing context */
4938   SrcList *p,             /* The left part of the FROM clause already seen */
4939   Token *pTable,          /* Name of the table to add to the FROM clause */
4940   Token *pDatabase,       /* Name of the database containing pTable */
4941   Token *pAlias,          /* The right-hand side of the AS subexpression */
4942   Select *pSubquery,      /* A subquery used in place of a table name */
4943   Expr *pOn,              /* The ON clause of a join */
4944   IdList *pUsing          /* The USING clause of a join */
4945 ){
4946   SrcItem *pItem;
4947   sqlite3 *db = pParse->db;
4948   if( !p && (pOn || pUsing) ){
4949     sqlite3ErrorMsg(pParse, "a JOIN clause is required before %s",
4950       (pOn ? "ON" : "USING")
4951     );
4952     goto append_from_error;
4953   }
4954   p = sqlite3SrcListAppend(pParse, p, pTable, pDatabase);
4955   if( p==0 ){
4956     goto append_from_error;
4957   }
4958   assert( p->nSrc>0 );
4959   pItem = &p->a[p->nSrc-1];
4960   assert( (pTable==0)==(pDatabase==0) );
4961   assert( pItem->zName==0 || pDatabase!=0 );
4962   if( IN_RENAME_OBJECT && pItem->zName ){
4963     Token *pToken = (ALWAYS(pDatabase) && pDatabase->z) ? pDatabase : pTable;
4964     sqlite3RenameTokenMap(pParse, pItem->zName, pToken);
4965   }
4966   assert( pAlias!=0 );
4967   if( pAlias->n ){
4968     pItem->zAlias = sqlite3NameFromToken(db, pAlias);
4969   }
4970   pItem->pSelect = pSubquery;
4971   pItem->pOn = pOn;
4972   pItem->pUsing = pUsing;
4973   return p;
4974 
4975 append_from_error:
4976   assert( p==0 );
4977   sqlite3ExprDelete(db, pOn);
4978   sqlite3IdListDelete(db, pUsing);
4979   sqlite3SelectDelete(db, pSubquery);
4980   return 0;
4981 }
4982 
4983 /*
4984 ** Add an INDEXED BY or NOT INDEXED clause to the most recently added
4985 ** element of the source-list passed as the second argument.
4986 */
4987 void sqlite3SrcListIndexedBy(Parse *pParse, SrcList *p, Token *pIndexedBy){
4988   assert( pIndexedBy!=0 );
4989   if( p && pIndexedBy->n>0 ){
4990     SrcItem *pItem;
4991     assert( p->nSrc>0 );
4992     pItem = &p->a[p->nSrc-1];
4993     assert( pItem->fg.notIndexed==0 );
4994     assert( pItem->fg.isIndexedBy==0 );
4995     assert( pItem->fg.isTabFunc==0 );
4996     if( pIndexedBy->n==1 && !pIndexedBy->z ){
4997       /* A "NOT INDEXED" clause was supplied. See parse.y
4998       ** construct "indexed_opt" for details. */
4999       pItem->fg.notIndexed = 1;
5000     }else{
5001       pItem->u1.zIndexedBy = sqlite3NameFromToken(pParse->db, pIndexedBy);
5002       pItem->fg.isIndexedBy = 1;
5003       assert( pItem->fg.isCte==0 );  /* No collision on union u2 */
5004     }
5005   }
5006 }
5007 
5008 /*
5009 ** Append the contents of SrcList p2 to SrcList p1 and return the resulting
5010 ** SrcList. Or, if an error occurs, return NULL. In all cases, p1 and p2
5011 ** are deleted by this function.
5012 */
5013 SrcList *sqlite3SrcListAppendList(Parse *pParse, SrcList *p1, SrcList *p2){
5014   assert( p1 && p1->nSrc==1 );
5015   if( p2 ){
5016     SrcList *pNew = sqlite3SrcListEnlarge(pParse, p1, p2->nSrc, 1);
5017     if( pNew==0 ){
5018       sqlite3SrcListDelete(pParse->db, p2);
5019     }else{
5020       p1 = pNew;
5021       memcpy(&p1->a[1], p2->a, p2->nSrc*sizeof(SrcItem));
5022       sqlite3DbFree(pParse->db, p2);
5023     }
5024   }
5025   return p1;
5026 }
5027 
5028 /*
5029 ** Add the list of function arguments to the SrcList entry for a
5030 ** table-valued-function.
5031 */
5032 void sqlite3SrcListFuncArgs(Parse *pParse, SrcList *p, ExprList *pList){
5033   if( p ){
5034     SrcItem *pItem = &p->a[p->nSrc-1];
5035     assert( pItem->fg.notIndexed==0 );
5036     assert( pItem->fg.isIndexedBy==0 );
5037     assert( pItem->fg.isTabFunc==0 );
5038     pItem->u1.pFuncArg = pList;
5039     pItem->fg.isTabFunc = 1;
5040   }else{
5041     sqlite3ExprListDelete(pParse->db, pList);
5042   }
5043 }
5044 
5045 /*
5046 ** When building up a FROM clause in the parser, the join operator
5047 ** is initially attached to the left operand.  But the code generator
5048 ** expects the join operator to be on the right operand.  This routine
5049 ** Shifts all join operators from left to right for an entire FROM
5050 ** clause.
5051 **
5052 ** Example: Suppose the join is like this:
5053 **
5054 **           A natural cross join B
5055 **
5056 ** The operator is "natural cross join".  The A and B operands are stored
5057 ** in p->a[0] and p->a[1], respectively.  The parser initially stores the
5058 ** operator with A.  This routine shifts that operator over to B.
5059 */
5060 void sqlite3SrcListShiftJoinType(SrcList *p){
5061   if( p ){
5062     int i;
5063     for(i=p->nSrc-1; i>0; i--){
5064       p->a[i].fg.jointype = p->a[i-1].fg.jointype;
5065     }
5066     p->a[0].fg.jointype = 0;
5067   }
5068 }
5069 
5070 /*
5071 ** Generate VDBE code for a BEGIN statement.
5072 */
5073 void sqlite3BeginTransaction(Parse *pParse, int type){
5074   sqlite3 *db;
5075   Vdbe *v;
5076   int i;
5077 
5078   assert( pParse!=0 );
5079   db = pParse->db;
5080   assert( db!=0 );
5081   if( sqlite3AuthCheck(pParse, SQLITE_TRANSACTION, "BEGIN", 0, 0) ){
5082     return;
5083   }
5084   v = sqlite3GetVdbe(pParse);
5085   if( !v ) return;
5086   if( type!=TK_DEFERRED ){
5087     for(i=0; i<db->nDb; i++){
5088       int eTxnType;
5089       Btree *pBt = db->aDb[i].pBt;
5090       if( pBt && sqlite3BtreeIsReadonly(pBt) ){
5091         eTxnType = 0;  /* Read txn */
5092       }else if( type==TK_EXCLUSIVE ){
5093         eTxnType = 2;  /* Exclusive txn */
5094       }else{
5095         eTxnType = 1;  /* Write txn */
5096       }
5097       sqlite3VdbeAddOp2(v, OP_Transaction, i, eTxnType);
5098       sqlite3VdbeUsesBtree(v, i);
5099     }
5100   }
5101   sqlite3VdbeAddOp0(v, OP_AutoCommit);
5102 }
5103 
5104 /*
5105 ** Generate VDBE code for a COMMIT or ROLLBACK statement.
5106 ** Code for ROLLBACK is generated if eType==TK_ROLLBACK.  Otherwise
5107 ** code is generated for a COMMIT.
5108 */
5109 void sqlite3EndTransaction(Parse *pParse, int eType){
5110   Vdbe *v;
5111   int isRollback;
5112 
5113   assert( pParse!=0 );
5114   assert( pParse->db!=0 );
5115   assert( eType==TK_COMMIT || eType==TK_END || eType==TK_ROLLBACK );
5116   isRollback = eType==TK_ROLLBACK;
5117   if( sqlite3AuthCheck(pParse, SQLITE_TRANSACTION,
5118        isRollback ? "ROLLBACK" : "COMMIT", 0, 0) ){
5119     return;
5120   }
5121   v = sqlite3GetVdbe(pParse);
5122   if( v ){
5123     sqlite3VdbeAddOp2(v, OP_AutoCommit, 1, isRollback);
5124   }
5125 }
5126 
5127 /*
5128 ** This function is called by the parser when it parses a command to create,
5129 ** release or rollback an SQL savepoint.
5130 */
5131 void sqlite3Savepoint(Parse *pParse, int op, Token *pName){
5132   char *zName = sqlite3NameFromToken(pParse->db, pName);
5133   if( zName ){
5134     Vdbe *v = sqlite3GetVdbe(pParse);
5135 #ifndef SQLITE_OMIT_AUTHORIZATION
5136     static const char * const az[] = { "BEGIN", "RELEASE", "ROLLBACK" };
5137     assert( !SAVEPOINT_BEGIN && SAVEPOINT_RELEASE==1 && SAVEPOINT_ROLLBACK==2 );
5138 #endif
5139     if( !v || sqlite3AuthCheck(pParse, SQLITE_SAVEPOINT, az[op], zName, 0) ){
5140       sqlite3DbFree(pParse->db, zName);
5141       return;
5142     }
5143     sqlite3VdbeAddOp4(v, OP_Savepoint, op, 0, 0, zName, P4_DYNAMIC);
5144   }
5145 }
5146 
5147 /*
5148 ** Make sure the TEMP database is open and available for use.  Return
5149 ** the number of errors.  Leave any error messages in the pParse structure.
5150 */
5151 int sqlite3OpenTempDatabase(Parse *pParse){
5152   sqlite3 *db = pParse->db;
5153   if( db->aDb[1].pBt==0 && !pParse->explain ){
5154     int rc;
5155     Btree *pBt;
5156     static const int flags =
5157           SQLITE_OPEN_READWRITE |
5158           SQLITE_OPEN_CREATE |
5159           SQLITE_OPEN_EXCLUSIVE |
5160           SQLITE_OPEN_DELETEONCLOSE |
5161           SQLITE_OPEN_TEMP_DB;
5162 
5163     rc = sqlite3BtreeOpen(db->pVfs, 0, db, &pBt, 0, flags);
5164     if( rc!=SQLITE_OK ){
5165       sqlite3ErrorMsg(pParse, "unable to open a temporary database "
5166         "file for storing temporary tables");
5167       pParse->rc = rc;
5168       return 1;
5169     }
5170     db->aDb[1].pBt = pBt;
5171     assert( db->aDb[1].pSchema );
5172     if( SQLITE_NOMEM==sqlite3BtreeSetPageSize(pBt, db->nextPagesize, 0, 0) ){
5173       sqlite3OomFault(db);
5174       return 1;
5175     }
5176   }
5177   return 0;
5178 }
5179 
5180 /*
5181 ** Record the fact that the schema cookie will need to be verified
5182 ** for database iDb.  The code to actually verify the schema cookie
5183 ** will occur at the end of the top-level VDBE and will be generated
5184 ** later, by sqlite3FinishCoding().
5185 */
5186 static void sqlite3CodeVerifySchemaAtToplevel(Parse *pToplevel, int iDb){
5187   assert( iDb>=0 && iDb<pToplevel->db->nDb );
5188   assert( pToplevel->db->aDb[iDb].pBt!=0 || iDb==1 );
5189   assert( iDb<SQLITE_MAX_DB );
5190   assert( sqlite3SchemaMutexHeld(pToplevel->db, iDb, 0) );
5191   if( DbMaskTest(pToplevel->cookieMask, iDb)==0 ){
5192     DbMaskSet(pToplevel->cookieMask, iDb);
5193     if( !OMIT_TEMPDB && iDb==1 ){
5194       sqlite3OpenTempDatabase(pToplevel);
5195     }
5196   }
5197 }
5198 void sqlite3CodeVerifySchema(Parse *pParse, int iDb){
5199   sqlite3CodeVerifySchemaAtToplevel(sqlite3ParseToplevel(pParse), iDb);
5200 }
5201 
5202 
5203 /*
5204 ** If argument zDb is NULL, then call sqlite3CodeVerifySchema() for each
5205 ** attached database. Otherwise, invoke it for the database named zDb only.
5206 */
5207 void sqlite3CodeVerifyNamedSchema(Parse *pParse, const char *zDb){
5208   sqlite3 *db = pParse->db;
5209   int i;
5210   for(i=0; i<db->nDb; i++){
5211     Db *pDb = &db->aDb[i];
5212     if( pDb->pBt && (!zDb || 0==sqlite3StrICmp(zDb, pDb->zDbSName)) ){
5213       sqlite3CodeVerifySchema(pParse, i);
5214     }
5215   }
5216 }
5217 
5218 /*
5219 ** Generate VDBE code that prepares for doing an operation that
5220 ** might change the database.
5221 **
5222 ** This routine starts a new transaction if we are not already within
5223 ** a transaction.  If we are already within a transaction, then a checkpoint
5224 ** is set if the setStatement parameter is true.  A checkpoint should
5225 ** be set for operations that might fail (due to a constraint) part of
5226 ** the way through and which will need to undo some writes without having to
5227 ** rollback the whole transaction.  For operations where all constraints
5228 ** can be checked before any changes are made to the database, it is never
5229 ** necessary to undo a write and the checkpoint should not be set.
5230 */
5231 void sqlite3BeginWriteOperation(Parse *pParse, int setStatement, int iDb){
5232   Parse *pToplevel = sqlite3ParseToplevel(pParse);
5233   sqlite3CodeVerifySchemaAtToplevel(pToplevel, iDb);
5234   DbMaskSet(pToplevel->writeMask, iDb);
5235   pToplevel->isMultiWrite |= setStatement;
5236 }
5237 
5238 /*
5239 ** Indicate that the statement currently under construction might write
5240 ** more than one entry (example: deleting one row then inserting another,
5241 ** inserting multiple rows in a table, or inserting a row and index entries.)
5242 ** If an abort occurs after some of these writes have completed, then it will
5243 ** be necessary to undo the completed writes.
5244 */
5245 void sqlite3MultiWrite(Parse *pParse){
5246   Parse *pToplevel = sqlite3ParseToplevel(pParse);
5247   pToplevel->isMultiWrite = 1;
5248 }
5249 
5250 /*
5251 ** The code generator calls this routine if is discovers that it is
5252 ** possible to abort a statement prior to completion.  In order to
5253 ** perform this abort without corrupting the database, we need to make
5254 ** sure that the statement is protected by a statement transaction.
5255 **
5256 ** Technically, we only need to set the mayAbort flag if the
5257 ** isMultiWrite flag was previously set.  There is a time dependency
5258 ** such that the abort must occur after the multiwrite.  This makes
5259 ** some statements involving the REPLACE conflict resolution algorithm
5260 ** go a little faster.  But taking advantage of this time dependency
5261 ** makes it more difficult to prove that the code is correct (in
5262 ** particular, it prevents us from writing an effective
5263 ** implementation of sqlite3AssertMayAbort()) and so we have chosen
5264 ** to take the safe route and skip the optimization.
5265 */
5266 void sqlite3MayAbort(Parse *pParse){
5267   Parse *pToplevel = sqlite3ParseToplevel(pParse);
5268   pToplevel->mayAbort = 1;
5269 }
5270 
5271 /*
5272 ** Code an OP_Halt that causes the vdbe to return an SQLITE_CONSTRAINT
5273 ** error. The onError parameter determines which (if any) of the statement
5274 ** and/or current transaction is rolled back.
5275 */
5276 void sqlite3HaltConstraint(
5277   Parse *pParse,    /* Parsing context */
5278   int errCode,      /* extended error code */
5279   int onError,      /* Constraint type */
5280   char *p4,         /* Error message */
5281   i8 p4type,        /* P4_STATIC or P4_TRANSIENT */
5282   u8 p5Errmsg       /* P5_ErrMsg type */
5283 ){
5284   Vdbe *v;
5285   assert( pParse->pVdbe!=0 );
5286   v = sqlite3GetVdbe(pParse);
5287   assert( (errCode&0xff)==SQLITE_CONSTRAINT || pParse->nested );
5288   if( onError==OE_Abort ){
5289     sqlite3MayAbort(pParse);
5290   }
5291   sqlite3VdbeAddOp4(v, OP_Halt, errCode, onError, 0, p4, p4type);
5292   sqlite3VdbeChangeP5(v, p5Errmsg);
5293 }
5294 
5295 /*
5296 ** Code an OP_Halt due to UNIQUE or PRIMARY KEY constraint violation.
5297 */
5298 void sqlite3UniqueConstraint(
5299   Parse *pParse,    /* Parsing context */
5300   int onError,      /* Constraint type */
5301   Index *pIdx       /* The index that triggers the constraint */
5302 ){
5303   char *zErr;
5304   int j;
5305   StrAccum errMsg;
5306   Table *pTab = pIdx->pTable;
5307 
5308   sqlite3StrAccumInit(&errMsg, pParse->db, 0, 0,
5309                       pParse->db->aLimit[SQLITE_LIMIT_LENGTH]);
5310   if( pIdx->aColExpr ){
5311     sqlite3_str_appendf(&errMsg, "index '%q'", pIdx->zName);
5312   }else{
5313     for(j=0; j<pIdx->nKeyCol; j++){
5314       char *zCol;
5315       assert( pIdx->aiColumn[j]>=0 );
5316       zCol = pTab->aCol[pIdx->aiColumn[j]].zCnName;
5317       if( j ) sqlite3_str_append(&errMsg, ", ", 2);
5318       sqlite3_str_appendall(&errMsg, pTab->zName);
5319       sqlite3_str_append(&errMsg, ".", 1);
5320       sqlite3_str_appendall(&errMsg, zCol);
5321     }
5322   }
5323   zErr = sqlite3StrAccumFinish(&errMsg);
5324   sqlite3HaltConstraint(pParse,
5325     IsPrimaryKeyIndex(pIdx) ? SQLITE_CONSTRAINT_PRIMARYKEY
5326                             : SQLITE_CONSTRAINT_UNIQUE,
5327     onError, zErr, P4_DYNAMIC, P5_ConstraintUnique);
5328 }
5329 
5330 
5331 /*
5332 ** Code an OP_Halt due to non-unique rowid.
5333 */
5334 void sqlite3RowidConstraint(
5335   Parse *pParse,    /* Parsing context */
5336   int onError,      /* Conflict resolution algorithm */
5337   Table *pTab       /* The table with the non-unique rowid */
5338 ){
5339   char *zMsg;
5340   int rc;
5341   if( pTab->iPKey>=0 ){
5342     zMsg = sqlite3MPrintf(pParse->db, "%s.%s", pTab->zName,
5343                           pTab->aCol[pTab->iPKey].zCnName);
5344     rc = SQLITE_CONSTRAINT_PRIMARYKEY;
5345   }else{
5346     zMsg = sqlite3MPrintf(pParse->db, "%s.rowid", pTab->zName);
5347     rc = SQLITE_CONSTRAINT_ROWID;
5348   }
5349   sqlite3HaltConstraint(pParse, rc, onError, zMsg, P4_DYNAMIC,
5350                         P5_ConstraintUnique);
5351 }
5352 
5353 /*
5354 ** Check to see if pIndex uses the collating sequence pColl.  Return
5355 ** true if it does and false if it does not.
5356 */
5357 #ifndef SQLITE_OMIT_REINDEX
5358 static int collationMatch(const char *zColl, Index *pIndex){
5359   int i;
5360   assert( zColl!=0 );
5361   for(i=0; i<pIndex->nColumn; i++){
5362     const char *z = pIndex->azColl[i];
5363     assert( z!=0 || pIndex->aiColumn[i]<0 );
5364     if( pIndex->aiColumn[i]>=0 && 0==sqlite3StrICmp(z, zColl) ){
5365       return 1;
5366     }
5367   }
5368   return 0;
5369 }
5370 #endif
5371 
5372 /*
5373 ** Recompute all indices of pTab that use the collating sequence pColl.
5374 ** If pColl==0 then recompute all indices of pTab.
5375 */
5376 #ifndef SQLITE_OMIT_REINDEX
5377 static void reindexTable(Parse *pParse, Table *pTab, char const *zColl){
5378   if( !IsVirtual(pTab) ){
5379     Index *pIndex;              /* An index associated with pTab */
5380 
5381     for(pIndex=pTab->pIndex; pIndex; pIndex=pIndex->pNext){
5382       if( zColl==0 || collationMatch(zColl, pIndex) ){
5383         int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
5384         sqlite3BeginWriteOperation(pParse, 0, iDb);
5385         sqlite3RefillIndex(pParse, pIndex, -1);
5386       }
5387     }
5388   }
5389 }
5390 #endif
5391 
5392 /*
5393 ** Recompute all indices of all tables in all databases where the
5394 ** indices use the collating sequence pColl.  If pColl==0 then recompute
5395 ** all indices everywhere.
5396 */
5397 #ifndef SQLITE_OMIT_REINDEX
5398 static void reindexDatabases(Parse *pParse, char const *zColl){
5399   Db *pDb;                    /* A single database */
5400   int iDb;                    /* The database index number */
5401   sqlite3 *db = pParse->db;   /* The database connection */
5402   HashElem *k;                /* For looping over tables in pDb */
5403   Table *pTab;                /* A table in the database */
5404 
5405   assert( sqlite3BtreeHoldsAllMutexes(db) );  /* Needed for schema access */
5406   for(iDb=0, pDb=db->aDb; iDb<db->nDb; iDb++, pDb++){
5407     assert( pDb!=0 );
5408     for(k=sqliteHashFirst(&pDb->pSchema->tblHash);  k; k=sqliteHashNext(k)){
5409       pTab = (Table*)sqliteHashData(k);
5410       reindexTable(pParse, pTab, zColl);
5411     }
5412   }
5413 }
5414 #endif
5415 
5416 /*
5417 ** Generate code for the REINDEX command.
5418 **
5419 **        REINDEX                            -- 1
5420 **        REINDEX  <collation>               -- 2
5421 **        REINDEX  ?<database>.?<tablename>  -- 3
5422 **        REINDEX  ?<database>.?<indexname>  -- 4
5423 **
5424 ** Form 1 causes all indices in all attached databases to be rebuilt.
5425 ** Form 2 rebuilds all indices in all databases that use the named
5426 ** collating function.  Forms 3 and 4 rebuild the named index or all
5427 ** indices associated with the named table.
5428 */
5429 #ifndef SQLITE_OMIT_REINDEX
5430 void sqlite3Reindex(Parse *pParse, Token *pName1, Token *pName2){
5431   CollSeq *pColl;             /* Collating sequence to be reindexed, or NULL */
5432   char *z;                    /* Name of a table or index */
5433   const char *zDb;            /* Name of the database */
5434   Table *pTab;                /* A table in the database */
5435   Index *pIndex;              /* An index associated with pTab */
5436   int iDb;                    /* The database index number */
5437   sqlite3 *db = pParse->db;   /* The database connection */
5438   Token *pObjName;            /* Name of the table or index to be reindexed */
5439 
5440   /* Read the database schema. If an error occurs, leave an error message
5441   ** and code in pParse and return NULL. */
5442   if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
5443     return;
5444   }
5445 
5446   if( pName1==0 ){
5447     reindexDatabases(pParse, 0);
5448     return;
5449   }else if( NEVER(pName2==0) || pName2->z==0 ){
5450     char *zColl;
5451     assert( pName1->z );
5452     zColl = sqlite3NameFromToken(pParse->db, pName1);
5453     if( !zColl ) return;
5454     pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
5455     if( pColl ){
5456       reindexDatabases(pParse, zColl);
5457       sqlite3DbFree(db, zColl);
5458       return;
5459     }
5460     sqlite3DbFree(db, zColl);
5461   }
5462   iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pObjName);
5463   if( iDb<0 ) return;
5464   z = sqlite3NameFromToken(db, pObjName);
5465   if( z==0 ) return;
5466   zDb = db->aDb[iDb].zDbSName;
5467   pTab = sqlite3FindTable(db, z, zDb);
5468   if( pTab ){
5469     reindexTable(pParse, pTab, 0);
5470     sqlite3DbFree(db, z);
5471     return;
5472   }
5473   pIndex = sqlite3FindIndex(db, z, zDb);
5474   sqlite3DbFree(db, z);
5475   if( pIndex ){
5476     sqlite3BeginWriteOperation(pParse, 0, iDb);
5477     sqlite3RefillIndex(pParse, pIndex, -1);
5478     return;
5479   }
5480   sqlite3ErrorMsg(pParse, "unable to identify the object to be reindexed");
5481 }
5482 #endif
5483 
5484 /*
5485 ** Return a KeyInfo structure that is appropriate for the given Index.
5486 **
5487 ** The caller should invoke sqlite3KeyInfoUnref() on the returned object
5488 ** when it has finished using it.
5489 */
5490 KeyInfo *sqlite3KeyInfoOfIndex(Parse *pParse, Index *pIdx){
5491   int i;
5492   int nCol = pIdx->nColumn;
5493   int nKey = pIdx->nKeyCol;
5494   KeyInfo *pKey;
5495   if( pParse->nErr ) return 0;
5496   if( pIdx->uniqNotNull ){
5497     pKey = sqlite3KeyInfoAlloc(pParse->db, nKey, nCol-nKey);
5498   }else{
5499     pKey = sqlite3KeyInfoAlloc(pParse->db, nCol, 0);
5500   }
5501   if( pKey ){
5502     assert( sqlite3KeyInfoIsWriteable(pKey) );
5503     for(i=0; i<nCol; i++){
5504       const char *zColl = pIdx->azColl[i];
5505       pKey->aColl[i] = zColl==sqlite3StrBINARY ? 0 :
5506                         sqlite3LocateCollSeq(pParse, zColl);
5507       pKey->aSortFlags[i] = pIdx->aSortOrder[i];
5508       assert( 0==(pKey->aSortFlags[i] & KEYINFO_ORDER_BIGNULL) );
5509     }
5510     if( pParse->nErr ){
5511       assert( pParse->rc==SQLITE_ERROR_MISSING_COLLSEQ );
5512       if( pIdx->bNoQuery==0 ){
5513         /* Deactivate the index because it contains an unknown collating
5514         ** sequence.  The only way to reactive the index is to reload the
5515         ** schema.  Adding the missing collating sequence later does not
5516         ** reactive the index.  The application had the chance to register
5517         ** the missing index using the collation-needed callback.  For
5518         ** simplicity, SQLite will not give the application a second chance.
5519         */
5520         pIdx->bNoQuery = 1;
5521         pParse->rc = SQLITE_ERROR_RETRY;
5522       }
5523       sqlite3KeyInfoUnref(pKey);
5524       pKey = 0;
5525     }
5526   }
5527   return pKey;
5528 }
5529 
5530 #ifndef SQLITE_OMIT_CTE
5531 /*
5532 ** Create a new CTE object
5533 */
5534 Cte *sqlite3CteNew(
5535   Parse *pParse,          /* Parsing context */
5536   Token *pName,           /* Name of the common-table */
5537   ExprList *pArglist,     /* Optional column name list for the table */
5538   Select *pQuery,         /* Query used to initialize the table */
5539   u8 eM10d                /* The MATERIALIZED flag */
5540 ){
5541   Cte *pNew;
5542   sqlite3 *db = pParse->db;
5543 
5544   pNew = sqlite3DbMallocZero(db, sizeof(*pNew));
5545   assert( pNew!=0 || db->mallocFailed );
5546 
5547   if( db->mallocFailed ){
5548     sqlite3ExprListDelete(db, pArglist);
5549     sqlite3SelectDelete(db, pQuery);
5550   }else{
5551     pNew->pSelect = pQuery;
5552     pNew->pCols = pArglist;
5553     pNew->zName = sqlite3NameFromToken(pParse->db, pName);
5554     pNew->eM10d = eM10d;
5555   }
5556   return pNew;
5557 }
5558 
5559 /*
5560 ** Clear information from a Cte object, but do not deallocate storage
5561 ** for the object itself.
5562 */
5563 static void cteClear(sqlite3 *db, Cte *pCte){
5564   assert( pCte!=0 );
5565   sqlite3ExprListDelete(db, pCte->pCols);
5566   sqlite3SelectDelete(db, pCte->pSelect);
5567   sqlite3DbFree(db, pCte->zName);
5568 }
5569 
5570 /*
5571 ** Free the contents of the CTE object passed as the second argument.
5572 */
5573 void sqlite3CteDelete(sqlite3 *db, Cte *pCte){
5574   assert( pCte!=0 );
5575   cteClear(db, pCte);
5576   sqlite3DbFree(db, pCte);
5577 }
5578 
5579 /*
5580 ** This routine is invoked once per CTE by the parser while parsing a
5581 ** WITH clause.  The CTE described by teh third argument is added to
5582 ** the WITH clause of the second argument.  If the second argument is
5583 ** NULL, then a new WITH argument is created.
5584 */
5585 With *sqlite3WithAdd(
5586   Parse *pParse,          /* Parsing context */
5587   With *pWith,            /* Existing WITH clause, or NULL */
5588   Cte *pCte               /* CTE to add to the WITH clause */
5589 ){
5590   sqlite3 *db = pParse->db;
5591   With *pNew;
5592   char *zName;
5593 
5594   if( pCte==0 ){
5595     return pWith;
5596   }
5597 
5598   /* Check that the CTE name is unique within this WITH clause. If
5599   ** not, store an error in the Parse structure. */
5600   zName = pCte->zName;
5601   if( zName && pWith ){
5602     int i;
5603     for(i=0; i<pWith->nCte; i++){
5604       if( sqlite3StrICmp(zName, pWith->a[i].zName)==0 ){
5605         sqlite3ErrorMsg(pParse, "duplicate WITH table name: %s", zName);
5606       }
5607     }
5608   }
5609 
5610   if( pWith ){
5611     sqlite3_int64 nByte = sizeof(*pWith) + (sizeof(pWith->a[1]) * pWith->nCte);
5612     pNew = sqlite3DbRealloc(db, pWith, nByte);
5613   }else{
5614     pNew = sqlite3DbMallocZero(db, sizeof(*pWith));
5615   }
5616   assert( (pNew!=0 && zName!=0) || db->mallocFailed );
5617 
5618   if( db->mallocFailed ){
5619     sqlite3CteDelete(db, pCte);
5620     pNew = pWith;
5621   }else{
5622     pNew->a[pNew->nCte++] = *pCte;
5623     sqlite3DbFree(db, pCte);
5624   }
5625 
5626   return pNew;
5627 }
5628 
5629 /*
5630 ** Free the contents of the With object passed as the second argument.
5631 */
5632 void sqlite3WithDelete(sqlite3 *db, With *pWith){
5633   if( pWith ){
5634     int i;
5635     for(i=0; i<pWith->nCte; i++){
5636       cteClear(db, &pWith->a[i]);
5637     }
5638     sqlite3DbFree(db, pWith);
5639   }
5640 }
5641 #endif /* !defined(SQLITE_OMIT_CTE) */
5642