xref: /sqlite-3.40.0/src/alter.c (revision fb8ca7de)
1 /*
2 ** 2005 February 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 used to generate VDBE code
13 ** that implements the ALTER TABLE command.
14 */
15 #include "sqliteInt.h"
16 
17 /*
18 ** The code in this file only exists if we are not omitting the
19 ** ALTER TABLE logic from the build.
20 */
21 #ifndef SQLITE_OMIT_ALTERTABLE
22 
23 /*
24 ** Parameter zName is the name of a table that is about to be altered
25 ** (either with ALTER TABLE ... RENAME TO or ALTER TABLE ... ADD COLUMN).
26 ** If the table is a system table, this function leaves an error message
27 ** in pParse->zErr (system tables may not be altered) and returns non-zero.
28 **
29 ** Or, if zName is not a system table, zero is returned.
30 */
31 static int isAlterableTable(Parse *pParse, Table *pTab){
32   if( 0==sqlite3StrNICmp(pTab->zName, "sqlite_", 7)
33 #ifndef SQLITE_OMIT_VIRTUALTABLE
34    || (pTab->tabFlags & TF_Eponymous)!=0
35    || ( (pTab->tabFlags & TF_Shadow)!=0
36         && sqlite3ReadOnlyShadowTables(pParse->db)
37    )
38 #endif
39   ){
40     sqlite3ErrorMsg(pParse, "table %s may not be altered", pTab->zName);
41     return 1;
42   }
43   return 0;
44 }
45 
46 /*
47 ** Generate code to verify that the schemas of database zDb and, if
48 ** bTemp is not true, database "temp", can still be parsed. This is
49 ** called at the end of the generation of an ALTER TABLE ... RENAME ...
50 ** statement to ensure that the operation has not rendered any schema
51 ** objects unusable.
52 */
53 static void renameTestSchema(
54   Parse *pParse,                  /* Parse context */
55   const char *zDb,                /* Name of db to verify schema of */
56   int bTemp,                      /* True if this is the temp db */
57   const char *zWhen,              /* "when" part of error message */
58   int bNoDQS                      /* Do not allow DQS in the schema */
59 ){
60   pParse->colNamesSet = 1;
61   sqlite3NestedParse(pParse,
62       "SELECT 1 "
63       "FROM \"%w\"." DFLT_SCHEMA_TABLE " "
64       "WHERE name NOT LIKE 'sqliteX_%%' ESCAPE 'X'"
65       " AND sql NOT LIKE 'create virtual%%'"
66       " AND sqlite_rename_test(%Q, sql, type, name, %d, %Q, %d)=NULL ",
67       zDb,
68       zDb, bTemp, zWhen, bNoDQS
69   );
70 
71   if( bTemp==0 ){
72     sqlite3NestedParse(pParse,
73         "SELECT 1 "
74         "FROM temp." DFLT_SCHEMA_TABLE " "
75         "WHERE name NOT LIKE 'sqliteX_%%' ESCAPE 'X'"
76         " AND sql NOT LIKE 'create virtual%%'"
77         " AND sqlite_rename_test(%Q, sql, type, name, 1, %Q, %d)=NULL ",
78         zDb, zWhen, bNoDQS
79     );
80   }
81 }
82 
83 /*
84 ** Generate VM code to replace any double-quoted strings (but not double-quoted
85 ** identifiers) within the "sql" column of the sqlite_schema table in
86 ** database zDb with their single-quoted equivalents. If argument bTemp is
87 ** not true, similarly update all SQL statements in the sqlite_schema table
88 ** of the temp db.
89 */
90 static void renameFixQuotes(Parse *pParse, const char *zDb, int bTemp){
91   sqlite3NestedParse(pParse,
92       "UPDATE \"%w\"." DFLT_SCHEMA_TABLE
93       " SET sql = sqlite_rename_quotefix(%Q, sql)"
94       "WHERE name NOT LIKE 'sqliteX_%%' ESCAPE 'X'"
95       " AND sql NOT LIKE 'create virtual%%'" , zDb, zDb
96   );
97   if( bTemp==0 ){
98     sqlite3NestedParse(pParse,
99       "UPDATE temp." DFLT_SCHEMA_TABLE
100       " SET sql = sqlite_rename_quotefix('temp', sql)"
101       "WHERE name NOT LIKE 'sqliteX_%%' ESCAPE 'X'"
102       " AND sql NOT LIKE 'create virtual%%'"
103     );
104   }
105 }
106 
107 /*
108 ** Generate code to reload the schema for database iDb. And, if iDb!=1, for
109 ** the temp database as well.
110 */
111 static void renameReloadSchema(Parse *pParse, int iDb, u16 p5){
112   Vdbe *v = pParse->pVdbe;
113   if( v ){
114     sqlite3ChangeCookie(pParse, iDb);
115     sqlite3VdbeAddParseSchemaOp(pParse->pVdbe, iDb, 0, p5);
116     if( iDb!=1 ) sqlite3VdbeAddParseSchemaOp(pParse->pVdbe, 1, 0, p5);
117   }
118 }
119 
120 /*
121 ** Generate code to implement the "ALTER TABLE xxx RENAME TO yyy"
122 ** command.
123 */
124 void sqlite3AlterRenameTable(
125   Parse *pParse,            /* Parser context. */
126   SrcList *pSrc,            /* The table to rename. */
127   Token *pName              /* The new table name. */
128 ){
129   int iDb;                  /* Database that contains the table */
130   char *zDb;                /* Name of database iDb */
131   Table *pTab;              /* Table being renamed */
132   char *zName = 0;          /* NULL-terminated version of pName */
133   sqlite3 *db = pParse->db; /* Database connection */
134   int nTabName;             /* Number of UTF-8 characters in zTabName */
135   const char *zTabName;     /* Original name of the table */
136   Vdbe *v;
137   VTable *pVTab = 0;        /* Non-zero if this is a v-tab with an xRename() */
138 
139   if( NEVER(db->mallocFailed) ) goto exit_rename_table;
140   assert( pSrc->nSrc==1 );
141   assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
142 
143   pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
144   if( !pTab ) goto exit_rename_table;
145   iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
146   zDb = db->aDb[iDb].zDbSName;
147 
148   /* Get a NULL terminated version of the new table name. */
149   zName = sqlite3NameFromToken(db, pName);
150   if( !zName ) goto exit_rename_table;
151 
152   /* Check that a table or index named 'zName' does not already exist
153   ** in database iDb. If so, this is an error.
154   */
155   if( sqlite3FindTable(db, zName, zDb)
156    || sqlite3FindIndex(db, zName, zDb)
157    || sqlite3IsShadowTableOf(db, pTab, zName)
158   ){
159     sqlite3ErrorMsg(pParse,
160         "there is already another table or index with this name: %s", zName);
161     goto exit_rename_table;
162   }
163 
164   /* Make sure it is not a system table being altered, or a reserved name
165   ** that the table is being renamed to.
166   */
167   if( SQLITE_OK!=isAlterableTable(pParse, pTab) ){
168     goto exit_rename_table;
169   }
170   if( SQLITE_OK!=sqlite3CheckObjectName(pParse,zName,"table",zName) ){
171     goto exit_rename_table;
172   }
173 
174 #ifndef SQLITE_OMIT_VIEW
175   if( IsView(pTab) ){
176     sqlite3ErrorMsg(pParse, "view %s may not be altered", pTab->zName);
177     goto exit_rename_table;
178   }
179 #endif
180 
181 #ifndef SQLITE_OMIT_AUTHORIZATION
182   /* Invoke the authorization callback. */
183   if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
184     goto exit_rename_table;
185   }
186 #endif
187 
188 #ifndef SQLITE_OMIT_VIRTUALTABLE
189   if( sqlite3ViewGetColumnNames(pParse, pTab) ){
190     goto exit_rename_table;
191   }
192   if( IsVirtual(pTab) ){
193     pVTab = sqlite3GetVTable(db, pTab);
194     if( pVTab->pVtab->pModule->xRename==0 ){
195       pVTab = 0;
196     }
197   }
198 #endif
199 
200   /* Begin a transaction for database iDb. Then modify the schema cookie
201   ** (since the ALTER TABLE modifies the schema). Call sqlite3MayAbort(),
202   ** as the scalar functions (e.g. sqlite_rename_table()) invoked by the
203   ** nested SQL may raise an exception.  */
204   v = sqlite3GetVdbe(pParse);
205   if( v==0 ){
206     goto exit_rename_table;
207   }
208   sqlite3MayAbort(pParse);
209 
210   /* figure out how many UTF-8 characters are in zName */
211   zTabName = pTab->zName;
212   nTabName = sqlite3Utf8CharLen(zTabName, -1);
213 
214   /* Rewrite all CREATE TABLE, INDEX, TRIGGER or VIEW statements in
215   ** the schema to use the new table name.  */
216   sqlite3NestedParse(pParse,
217       "UPDATE \"%w\"." DFLT_SCHEMA_TABLE " SET "
218       "sql = sqlite_rename_table(%Q, type, name, sql, %Q, %Q, %d) "
219       "WHERE (type!='index' OR tbl_name=%Q COLLATE nocase)"
220       "AND   name NOT LIKE 'sqliteX_%%' ESCAPE 'X'"
221       , zDb, zDb, zTabName, zName, (iDb==1), zTabName
222   );
223 
224   /* Update the tbl_name and name columns of the sqlite_schema table
225   ** as required.  */
226   sqlite3NestedParse(pParse,
227       "UPDATE %Q." DFLT_SCHEMA_TABLE " SET "
228           "tbl_name = %Q, "
229           "name = CASE "
230             "WHEN type='table' THEN %Q "
231             "WHEN name LIKE 'sqliteX_autoindex%%' ESCAPE 'X' "
232             "     AND type='index' THEN "
233              "'sqlite_autoindex_' || %Q || substr(name,%d+18) "
234             "ELSE name END "
235       "WHERE tbl_name=%Q COLLATE nocase AND "
236           "(type='table' OR type='index' OR type='trigger');",
237       zDb,
238       zName, zName, zName,
239       nTabName, zTabName
240   );
241 
242 #ifndef SQLITE_OMIT_AUTOINCREMENT
243   /* If the sqlite_sequence table exists in this database, then update
244   ** it with the new table name.
245   */
246   if( sqlite3FindTable(db, "sqlite_sequence", zDb) ){
247     sqlite3NestedParse(pParse,
248         "UPDATE \"%w\".sqlite_sequence set name = %Q WHERE name = %Q",
249         zDb, zName, pTab->zName);
250   }
251 #endif
252 
253   /* If the table being renamed is not itself part of the temp database,
254   ** edit view and trigger definitions within the temp database
255   ** as required.  */
256   if( iDb!=1 ){
257     sqlite3NestedParse(pParse,
258         "UPDATE sqlite_temp_schema SET "
259             "sql = sqlite_rename_table(%Q, type, name, sql, %Q, %Q, 1), "
260             "tbl_name = "
261               "CASE WHEN tbl_name=%Q COLLATE nocase AND "
262               "  sqlite_rename_test(%Q, sql, type, name, 1, 'after rename', 0) "
263               "THEN %Q ELSE tbl_name END "
264             "WHERE type IN ('view', 'trigger')"
265         , zDb, zTabName, zName, zTabName, zDb, zName);
266   }
267 
268   /* If this is a virtual table, invoke the xRename() function if
269   ** one is defined. The xRename() callback will modify the names
270   ** of any resources used by the v-table implementation (including other
271   ** SQLite tables) that are identified by the name of the virtual table.
272   */
273 #ifndef SQLITE_OMIT_VIRTUALTABLE
274   if( pVTab ){
275     int i = ++pParse->nMem;
276     sqlite3VdbeLoadString(v, i, zName);
277     sqlite3VdbeAddOp4(v, OP_VRename, i, 0, 0,(const char*)pVTab, P4_VTAB);
278   }
279 #endif
280 
281   renameReloadSchema(pParse, iDb, INITFLAG_AlterRename);
282   renameTestSchema(pParse, zDb, iDb==1, "after rename", 0);
283 
284 exit_rename_table:
285   sqlite3SrcListDelete(db, pSrc);
286   sqlite3DbFree(db, zName);
287 }
288 
289 /*
290 ** Write code that will raise an error if the table described by
291 ** zDb and zTab is not empty.
292 */
293 static void sqlite3ErrorIfNotEmpty(
294   Parse *pParse,        /* Parsing context */
295   const char *zDb,      /* Schema holding the table */
296   const char *zTab,     /* Table to check for empty */
297   const char *zErr      /* Error message text */
298 ){
299   sqlite3NestedParse(pParse,
300      "SELECT raise(ABORT,%Q) FROM \"%w\".\"%w\"",
301      zErr, zDb, zTab
302   );
303 }
304 
305 /*
306 ** This function is called after an "ALTER TABLE ... ADD" statement
307 ** has been parsed. Argument pColDef contains the text of the new
308 ** column definition.
309 **
310 ** The Table structure pParse->pNewTable was extended to include
311 ** the new column during parsing.
312 */
313 void sqlite3AlterFinishAddColumn(Parse *pParse, Token *pColDef){
314   Table *pNew;              /* Copy of pParse->pNewTable */
315   Table *pTab;              /* Table being altered */
316   int iDb;                  /* Database number */
317   const char *zDb;          /* Database name */
318   const char *zTab;         /* Table name */
319   char *zCol;               /* Null-terminated column definition */
320   Column *pCol;             /* The new column */
321   Expr *pDflt;              /* Default value for the new column */
322   sqlite3 *db;              /* The database connection; */
323   Vdbe *v;                  /* The prepared statement under construction */
324   int r1;                   /* Temporary registers */
325 
326   db = pParse->db;
327   if( pParse->nErr || db->mallocFailed ) return;
328   pNew = pParse->pNewTable;
329   assert( pNew );
330 
331   assert( sqlite3BtreeHoldsAllMutexes(db) );
332   iDb = sqlite3SchemaToIndex(db, pNew->pSchema);
333   zDb = db->aDb[iDb].zDbSName;
334   zTab = &pNew->zName[16];  /* Skip the "sqlite_altertab_" prefix on the name */
335   pCol = &pNew->aCol[pNew->nCol-1];
336   pDflt = sqlite3ColumnExpr(pNew, pCol);
337   pTab = sqlite3FindTable(db, zTab, zDb);
338   assert( pTab );
339 
340 #ifndef SQLITE_OMIT_AUTHORIZATION
341   /* Invoke the authorization callback. */
342   if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
343     return;
344   }
345 #endif
346 
347 
348   /* Check that the new column is not specified as PRIMARY KEY or UNIQUE.
349   ** If there is a NOT NULL constraint, then the default value for the
350   ** column must not be NULL.
351   */
352   if( pCol->colFlags & COLFLAG_PRIMKEY ){
353     sqlite3ErrorMsg(pParse, "Cannot add a PRIMARY KEY column");
354     return;
355   }
356   if( pNew->pIndex ){
357     sqlite3ErrorMsg(pParse,
358          "Cannot add a UNIQUE column");
359     return;
360   }
361   if( (pCol->colFlags & COLFLAG_GENERATED)==0 ){
362     /* If the default value for the new column was specified with a
363     ** literal NULL, then set pDflt to 0. This simplifies checking
364     ** for an SQL NULL default below.
365     */
366     assert( pDflt==0 || pDflt->op==TK_SPAN );
367     if( pDflt && pDflt->pLeft->op==TK_NULL ){
368       pDflt = 0;
369     }
370     if( (db->flags&SQLITE_ForeignKeys) && pNew->u.tab.pFKey && pDflt ){
371       sqlite3ErrorIfNotEmpty(pParse, zDb, zTab,
372           "Cannot add a REFERENCES column with non-NULL default value");
373     }
374     if( pCol->notNull && !pDflt ){
375       sqlite3ErrorIfNotEmpty(pParse, zDb, zTab,
376           "Cannot add a NOT NULL column with default value NULL");
377     }
378 
379 
380     /* Ensure the default expression is something that sqlite3ValueFromExpr()
381     ** can handle (i.e. not CURRENT_TIME etc.)
382     */
383     if( pDflt ){
384       sqlite3_value *pVal = 0;
385       int rc;
386       rc = sqlite3ValueFromExpr(db, pDflt, SQLITE_UTF8, SQLITE_AFF_BLOB, &pVal);
387       assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
388       if( rc!=SQLITE_OK ){
389         assert( db->mallocFailed == 1 );
390         return;
391       }
392       if( !pVal ){
393         sqlite3ErrorIfNotEmpty(pParse, zDb, zTab,
394            "Cannot add a column with non-constant default");
395       }
396       sqlite3ValueFree(pVal);
397     }
398   }else if( pCol->colFlags & COLFLAG_STORED ){
399     sqlite3ErrorIfNotEmpty(pParse, zDb, zTab, "cannot add a STORED column");
400   }
401 
402 
403   /* Modify the CREATE TABLE statement. */
404   zCol = sqlite3DbStrNDup(db, (char*)pColDef->z, pColDef->n);
405   if( zCol ){
406     char *zEnd = &zCol[pColDef->n-1];
407     while( zEnd>zCol && (*zEnd==';' || sqlite3Isspace(*zEnd)) ){
408       *zEnd-- = '\0';
409     }
410     /* substr() operations on characters, but addColOffset is in bytes. So we
411     ** have to use printf() to translate between these units: */
412     assert( !IsVirtual(pTab) );
413     sqlite3NestedParse(pParse,
414         "UPDATE \"%w\"." DFLT_SCHEMA_TABLE " SET "
415           "sql = printf('%%.%ds, ',sql) || %Q"
416           " || substr(sql,1+length(printf('%%.%ds',sql))) "
417         "WHERE type = 'table' AND name = %Q",
418       zDb, pNew->u.tab.addColOffset, zCol, pNew->u.tab.addColOffset,
419       zTab
420     );
421     sqlite3DbFree(db, zCol);
422   }
423 
424   v = sqlite3GetVdbe(pParse);
425   if( v ){
426     /* Make sure the schema version is at least 3.  But do not upgrade
427     ** from less than 3 to 4, as that will corrupt any preexisting DESC
428     ** index.
429     */
430     r1 = sqlite3GetTempReg(pParse);
431     sqlite3VdbeAddOp3(v, OP_ReadCookie, iDb, r1, BTREE_FILE_FORMAT);
432     sqlite3VdbeUsesBtree(v, iDb);
433     sqlite3VdbeAddOp2(v, OP_AddImm, r1, -2);
434     sqlite3VdbeAddOp2(v, OP_IfPos, r1, sqlite3VdbeCurrentAddr(v)+2);
435     VdbeCoverage(v);
436     sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_FILE_FORMAT, 3);
437     sqlite3ReleaseTempReg(pParse, r1);
438 
439     /* Reload the table definition */
440     renameReloadSchema(pParse, iDb, INITFLAG_AlterRename);
441 
442     /* Verify that constraints are still satisfied */
443     if( pNew->pCheck!=0
444      || (pCol->notNull && (pCol->colFlags & COLFLAG_GENERATED)!=0)
445     ){
446       sqlite3NestedParse(pParse,
447         "SELECT CASE WHEN quick_check GLOB 'CHECK*'"
448         " THEN raise(ABORT,'CHECK constraint failed')"
449         " ELSE raise(ABORT,'NOT NULL constraint failed')"
450         " END"
451         "  FROM pragma_quick_check(\"%w\",\"%w\")"
452         " WHERE quick_check GLOB 'CHECK*' OR quick_check GLOB 'NULL*'",
453         zTab, zDb
454       );
455     }
456   }
457 }
458 
459 /*
460 ** This function is called by the parser after the table-name in
461 ** an "ALTER TABLE <table-name> ADD" statement is parsed. Argument
462 ** pSrc is the full-name of the table being altered.
463 **
464 ** This routine makes a (partial) copy of the Table structure
465 ** for the table being altered and sets Parse.pNewTable to point
466 ** to it. Routines called by the parser as the column definition
467 ** is parsed (i.e. sqlite3AddColumn()) add the new Column data to
468 ** the copy. The copy of the Table structure is deleted by tokenize.c
469 ** after parsing is finished.
470 **
471 ** Routine sqlite3AlterFinishAddColumn() will be called to complete
472 ** coding the "ALTER TABLE ... ADD" statement.
473 */
474 void sqlite3AlterBeginAddColumn(Parse *pParse, SrcList *pSrc){
475   Table *pNew;
476   Table *pTab;
477   int iDb;
478   int i;
479   int nAlloc;
480   sqlite3 *db = pParse->db;
481 
482   /* Look up the table being altered. */
483   assert( pParse->pNewTable==0 );
484   assert( sqlite3BtreeHoldsAllMutexes(db) );
485   if( db->mallocFailed ) goto exit_begin_add_column;
486   pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
487   if( !pTab ) goto exit_begin_add_column;
488 
489 #ifndef SQLITE_OMIT_VIRTUALTABLE
490   if( IsVirtual(pTab) ){
491     sqlite3ErrorMsg(pParse, "virtual tables may not be altered");
492     goto exit_begin_add_column;
493   }
494 #endif
495 
496   /* Make sure this is not an attempt to ALTER a view. */
497   if( IsView(pTab) ){
498     sqlite3ErrorMsg(pParse, "Cannot add a column to a view");
499     goto exit_begin_add_column;
500   }
501   if( SQLITE_OK!=isAlterableTable(pParse, pTab) ){
502     goto exit_begin_add_column;
503   }
504 
505   sqlite3MayAbort(pParse);
506   assert( pTab->u.tab.addColOffset>0 );
507   iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
508 
509   /* Put a copy of the Table struct in Parse.pNewTable for the
510   ** sqlite3AddColumn() function and friends to modify.  But modify
511   ** the name by adding an "sqlite_altertab_" prefix.  By adding this
512   ** prefix, we insure that the name will not collide with an existing
513   ** table because user table are not allowed to have the "sqlite_"
514   ** prefix on their name.
515   */
516   pNew = (Table*)sqlite3DbMallocZero(db, sizeof(Table));
517   if( !pNew ) goto exit_begin_add_column;
518   pParse->pNewTable = pNew;
519   pNew->nTabRef = 1;
520   pNew->nCol = pTab->nCol;
521   assert( pNew->nCol>0 );
522   nAlloc = (((pNew->nCol-1)/8)*8)+8;
523   assert( nAlloc>=pNew->nCol && nAlloc%8==0 && nAlloc-pNew->nCol<8 );
524   pNew->aCol = (Column*)sqlite3DbMallocZero(db, sizeof(Column)*nAlloc);
525   pNew->zName = sqlite3MPrintf(db, "sqlite_altertab_%s", pTab->zName);
526   if( !pNew->aCol || !pNew->zName ){
527     assert( db->mallocFailed );
528     goto exit_begin_add_column;
529   }
530   memcpy(pNew->aCol, pTab->aCol, sizeof(Column)*pNew->nCol);
531   for(i=0; i<pNew->nCol; i++){
532     Column *pCol = &pNew->aCol[i];
533     pCol->zCnName = sqlite3DbStrDup(db, pCol->zCnName);
534     pCol->hName = sqlite3StrIHash(pCol->zCnName);
535   }
536   assert( !IsVirtual(pNew) );
537   pNew->u.tab.pDfltList = sqlite3ExprListDup(db, pTab->u.tab.pDfltList, 0);
538   pNew->pSchema = db->aDb[iDb].pSchema;
539   pNew->u.tab.addColOffset = pTab->u.tab.addColOffset;
540   pNew->nTabRef = 1;
541 
542 exit_begin_add_column:
543   sqlite3SrcListDelete(db, pSrc);
544   return;
545 }
546 
547 /*
548 ** Parameter pTab is the subject of an ALTER TABLE ... RENAME COLUMN
549 ** command. This function checks if the table is a view or virtual
550 ** table (columns of views or virtual tables may not be renamed). If so,
551 ** it loads an error message into pParse and returns non-zero.
552 **
553 ** Or, if pTab is not a view or virtual table, zero is returned.
554 */
555 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
556 static int isRealTable(Parse *pParse, Table *pTab, int bDrop){
557   const char *zType = 0;
558 #ifndef SQLITE_OMIT_VIEW
559   if( IsView(pTab) ){
560     zType = "view";
561   }
562 #endif
563 #ifndef SQLITE_OMIT_VIRTUALTABLE
564   if( IsVirtual(pTab) ){
565     zType = "virtual table";
566   }
567 #endif
568   if( zType ){
569     sqlite3ErrorMsg(pParse, "cannot %s %s \"%s\"",
570         (bDrop ? "drop column from" : "rename columns of"),
571         zType, pTab->zName
572     );
573     return 1;
574   }
575   return 0;
576 }
577 #else /* !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) */
578 # define isRealTable(x,y,z) (0)
579 #endif
580 
581 /*
582 ** Handles the following parser reduction:
583 **
584 **  cmd ::= ALTER TABLE pSrc RENAME COLUMN pOld TO pNew
585 */
586 void sqlite3AlterRenameColumn(
587   Parse *pParse,                  /* Parsing context */
588   SrcList *pSrc,                  /* Table being altered.  pSrc->nSrc==1 */
589   Token *pOld,                    /* Name of column being changed */
590   Token *pNew                     /* New column name */
591 ){
592   sqlite3 *db = pParse->db;       /* Database connection */
593   Table *pTab;                    /* Table being updated */
594   int iCol;                       /* Index of column being renamed */
595   char *zOld = 0;                 /* Old column name */
596   char *zNew = 0;                 /* New column name */
597   const char *zDb;                /* Name of schema containing the table */
598   int iSchema;                    /* Index of the schema */
599   int bQuote;                     /* True to quote the new name */
600 
601   /* Locate the table to be altered */
602   pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
603   if( !pTab ) goto exit_rename_column;
604 
605   /* Cannot alter a system table */
606   if( SQLITE_OK!=isAlterableTable(pParse, pTab) ) goto exit_rename_column;
607   if( SQLITE_OK!=isRealTable(pParse, pTab, 0) ) goto exit_rename_column;
608 
609   /* Which schema holds the table to be altered */
610   iSchema = sqlite3SchemaToIndex(db, pTab->pSchema);
611   assert( iSchema>=0 );
612   zDb = db->aDb[iSchema].zDbSName;
613 
614 #ifndef SQLITE_OMIT_AUTHORIZATION
615   /* Invoke the authorization callback. */
616   if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
617     goto exit_rename_column;
618   }
619 #endif
620 
621   /* Make sure the old name really is a column name in the table to be
622   ** altered.  Set iCol to be the index of the column being renamed */
623   zOld = sqlite3NameFromToken(db, pOld);
624   if( !zOld ) goto exit_rename_column;
625   for(iCol=0; iCol<pTab->nCol; iCol++){
626     if( 0==sqlite3StrICmp(pTab->aCol[iCol].zCnName, zOld) ) break;
627   }
628   if( iCol==pTab->nCol ){
629     sqlite3ErrorMsg(pParse, "no such column: \"%s\"", zOld);
630     goto exit_rename_column;
631   }
632 
633   /* Ensure the schema contains no double-quoted strings */
634   renameTestSchema(pParse, zDb, iSchema==1, "", 0);
635   renameFixQuotes(pParse, zDb, iSchema==1);
636 
637   /* Do the rename operation using a recursive UPDATE statement that
638   ** uses the sqlite_rename_column() SQL function to compute the new
639   ** CREATE statement text for the sqlite_schema table.
640   */
641   sqlite3MayAbort(pParse);
642   zNew = sqlite3NameFromToken(db, pNew);
643   if( !zNew ) goto exit_rename_column;
644   assert( pNew->n>0 );
645   bQuote = sqlite3Isquote(pNew->z[0]);
646   sqlite3NestedParse(pParse,
647       "UPDATE \"%w\"." DFLT_SCHEMA_TABLE " SET "
648       "sql = sqlite_rename_column(sql, type, name, %Q, %Q, %d, %Q, %d, %d) "
649       "WHERE name NOT LIKE 'sqliteX_%%' ESCAPE 'X' "
650       " AND (type != 'index' OR tbl_name = %Q)"
651       " AND sql NOT LIKE 'create virtual%%'",
652       zDb,
653       zDb, pTab->zName, iCol, zNew, bQuote, iSchema==1,
654       pTab->zName
655   );
656 
657   sqlite3NestedParse(pParse,
658       "UPDATE temp." DFLT_SCHEMA_TABLE " SET "
659       "sql = sqlite_rename_column(sql, type, name, %Q, %Q, %d, %Q, %d, 1) "
660       "WHERE type IN ('trigger', 'view')",
661       zDb, pTab->zName, iCol, zNew, bQuote
662   );
663 
664   /* Drop and reload the database schema. */
665   renameReloadSchema(pParse, iSchema, INITFLAG_AlterRename);
666   renameTestSchema(pParse, zDb, iSchema==1, "after rename", 1);
667 
668  exit_rename_column:
669   sqlite3SrcListDelete(db, pSrc);
670   sqlite3DbFree(db, zOld);
671   sqlite3DbFree(db, zNew);
672   return;
673 }
674 
675 /*
676 ** Each RenameToken object maps an element of the parse tree into
677 ** the token that generated that element.  The parse tree element
678 ** might be one of:
679 **
680 **     *  A pointer to an Expr that represents an ID
681 **     *  The name of a table column in Column.zName
682 **
683 ** A list of RenameToken objects can be constructed during parsing.
684 ** Each new object is created by sqlite3RenameTokenMap().
685 ** As the parse tree is transformed, the sqlite3RenameTokenRemap()
686 ** routine is used to keep the mapping current.
687 **
688 ** After the parse finishes, renameTokenFind() routine can be used
689 ** to look up the actual token value that created some element in
690 ** the parse tree.
691 */
692 struct RenameToken {
693   void *p;               /* Parse tree element created by token t */
694   Token t;               /* The token that created parse tree element p */
695   RenameToken *pNext;    /* Next is a list of all RenameToken objects */
696 };
697 
698 /*
699 ** The context of an ALTER TABLE RENAME COLUMN operation that gets passed
700 ** down into the Walker.
701 */
702 typedef struct RenameCtx RenameCtx;
703 struct RenameCtx {
704   RenameToken *pList;             /* List of tokens to overwrite */
705   int nList;                      /* Number of tokens in pList */
706   int iCol;                       /* Index of column being renamed */
707   Table *pTab;                    /* Table being ALTERed */
708   const char *zOld;               /* Old column name */
709 };
710 
711 #ifdef SQLITE_DEBUG
712 /*
713 ** This function is only for debugging. It performs two tasks:
714 **
715 **   1. Checks that pointer pPtr does not already appear in the
716 **      rename-token list.
717 **
718 **   2. Dereferences each pointer in the rename-token list.
719 **
720 ** The second is most effective when debugging under valgrind or
721 ** address-sanitizer or similar. If any of these pointers no longer
722 ** point to valid objects, an exception is raised by the memory-checking
723 ** tool.
724 **
725 ** The point of this is to prevent comparisons of invalid pointer values.
726 ** Even though this always seems to work, it is undefined according to the
727 ** C standard. Example of undefined comparison:
728 **
729 **     sqlite3_free(x);
730 **     if( x==y ) ...
731 **
732 ** Technically, as x no longer points into a valid object or to the byte
733 ** following a valid object, it may not be used in comparison operations.
734 */
735 static void renameTokenCheckAll(Parse *pParse, void *pPtr){
736   if( pParse->nErr==0 && pParse->db->mallocFailed==0 ){
737     RenameToken *p;
738     u8 i = 0;
739     for(p=pParse->pRename; p; p=p->pNext){
740       if( p->p ){
741         assert( p->p!=pPtr );
742         i += *(u8*)(p->p);
743       }
744     }
745   }
746 }
747 #else
748 # define renameTokenCheckAll(x,y)
749 #endif
750 
751 /*
752 ** Remember that the parser tree element pPtr was created using
753 ** the token pToken.
754 **
755 ** In other words, construct a new RenameToken object and add it
756 ** to the list of RenameToken objects currently being built up
757 ** in pParse->pRename.
758 **
759 ** The pPtr argument is returned so that this routine can be used
760 ** with tail recursion in tokenExpr() routine, for a small performance
761 ** improvement.
762 */
763 void *sqlite3RenameTokenMap(Parse *pParse, void *pPtr, Token *pToken){
764   RenameToken *pNew;
765   assert( pPtr || pParse->db->mallocFailed );
766   renameTokenCheckAll(pParse, pPtr);
767   if( ALWAYS(pParse->eParseMode!=PARSE_MODE_UNMAP) ){
768     pNew = sqlite3DbMallocZero(pParse->db, sizeof(RenameToken));
769     if( pNew ){
770       pNew->p = pPtr;
771       pNew->t = *pToken;
772       pNew->pNext = pParse->pRename;
773       pParse->pRename = pNew;
774     }
775   }
776 
777   return pPtr;
778 }
779 
780 /*
781 ** It is assumed that there is already a RenameToken object associated
782 ** with parse tree element pFrom. This function remaps the associated token
783 ** to parse tree element pTo.
784 */
785 void sqlite3RenameTokenRemap(Parse *pParse, void *pTo, void *pFrom){
786   RenameToken *p;
787   renameTokenCheckAll(pParse, pTo);
788   for(p=pParse->pRename; p; p=p->pNext){
789     if( p->p==pFrom ){
790       p->p = pTo;
791       break;
792     }
793   }
794 }
795 
796 /*
797 ** Walker callback used by sqlite3RenameExprUnmap().
798 */
799 static int renameUnmapExprCb(Walker *pWalker, Expr *pExpr){
800   Parse *pParse = pWalker->pParse;
801   sqlite3RenameTokenRemap(pParse, 0, (void*)pExpr);
802   return WRC_Continue;
803 }
804 
805 /*
806 ** Iterate through the Select objects that are part of WITH clauses attached
807 ** to select statement pSelect.
808 */
809 static void renameWalkWith(Walker *pWalker, Select *pSelect){
810   With *pWith = pSelect->pWith;
811   if( pWith ){
812     Parse *pParse = pWalker->pParse;
813     int i;
814     With *pCopy = 0;
815     assert( pWith->nCte>0 );
816     if( (pWith->a[0].pSelect->selFlags & SF_Expanded)==0 ){
817       /* Push a copy of the With object onto the with-stack. We use a copy
818       ** here as the original will be expanded and resolved (flags SF_Expanded
819       ** and SF_Resolved) below. And the parser code that uses the with-stack
820       ** fails if the Select objects on it have already been expanded and
821       ** resolved.  */
822       pCopy = sqlite3WithDup(pParse->db, pWith);
823       pCopy = sqlite3WithPush(pParse, pCopy, 1);
824     }
825     for(i=0; i<pWith->nCte; i++){
826       Select *p = pWith->a[i].pSelect;
827       NameContext sNC;
828       memset(&sNC, 0, sizeof(sNC));
829       sNC.pParse = pParse;
830       if( pCopy ) sqlite3SelectPrep(sNC.pParse, p, &sNC);
831       sqlite3WalkSelect(pWalker, p);
832       sqlite3RenameExprlistUnmap(pParse, pWith->a[i].pCols);
833     }
834     if( pCopy && pParse->pWith==pCopy ){
835       pParse->pWith = pCopy->pOuter;
836     }
837   }
838 }
839 
840 /*
841 ** Unmap all tokens in the IdList object passed as the second argument.
842 */
843 static void unmapColumnIdlistNames(
844   Parse *pParse,
845   IdList *pIdList
846 ){
847   if( pIdList ){
848     int ii;
849     for(ii=0; ii<pIdList->nId; ii++){
850       sqlite3RenameTokenRemap(pParse, 0, (void*)pIdList->a[ii].zName);
851     }
852   }
853 }
854 
855 /*
856 ** Walker callback used by sqlite3RenameExprUnmap().
857 */
858 static int renameUnmapSelectCb(Walker *pWalker, Select *p){
859   Parse *pParse = pWalker->pParse;
860   int i;
861   if( pParse->nErr ) return WRC_Abort;
862   if( p->selFlags & (SF_View|SF_CopyCte) ){
863     testcase( p->selFlags & SF_View );
864     testcase( p->selFlags & SF_CopyCte );
865     return WRC_Prune;
866   }
867   if( ALWAYS(p->pEList) ){
868     ExprList *pList = p->pEList;
869     for(i=0; i<pList->nExpr; i++){
870       if( pList->a[i].zEName && pList->a[i].eEName==ENAME_NAME ){
871         sqlite3RenameTokenRemap(pParse, 0, (void*)pList->a[i].zEName);
872       }
873     }
874   }
875   if( ALWAYS(p->pSrc) ){  /* Every Select as a SrcList, even if it is empty */
876     SrcList *pSrc = p->pSrc;
877     for(i=0; i<pSrc->nSrc; i++){
878       sqlite3RenameTokenRemap(pParse, 0, (void*)pSrc->a[i].zName);
879       if( sqlite3WalkExpr(pWalker, pSrc->a[i].pOn) ) return WRC_Abort;
880       unmapColumnIdlistNames(pParse, pSrc->a[i].pUsing);
881     }
882   }
883 
884   renameWalkWith(pWalker, p);
885   return WRC_Continue;
886 }
887 
888 /*
889 ** Remove all nodes that are part of expression pExpr from the rename list.
890 */
891 void sqlite3RenameExprUnmap(Parse *pParse, Expr *pExpr){
892   u8 eMode = pParse->eParseMode;
893   Walker sWalker;
894   memset(&sWalker, 0, sizeof(Walker));
895   sWalker.pParse = pParse;
896   sWalker.xExprCallback = renameUnmapExprCb;
897   sWalker.xSelectCallback = renameUnmapSelectCb;
898   pParse->eParseMode = PARSE_MODE_UNMAP;
899   sqlite3WalkExpr(&sWalker, pExpr);
900   pParse->eParseMode = eMode;
901 }
902 
903 /*
904 ** Remove all nodes that are part of expression-list pEList from the
905 ** rename list.
906 */
907 void sqlite3RenameExprlistUnmap(Parse *pParse, ExprList *pEList){
908   if( pEList ){
909     int i;
910     Walker sWalker;
911     memset(&sWalker, 0, sizeof(Walker));
912     sWalker.pParse = pParse;
913     sWalker.xExprCallback = renameUnmapExprCb;
914     sqlite3WalkExprList(&sWalker, pEList);
915     for(i=0; i<pEList->nExpr; i++){
916       if( ALWAYS(pEList->a[i].eEName==ENAME_NAME) ){
917         sqlite3RenameTokenRemap(pParse, 0, (void*)pEList->a[i].zEName);
918       }
919     }
920   }
921 }
922 
923 /*
924 ** Free the list of RenameToken objects given in the second argument
925 */
926 static void renameTokenFree(sqlite3 *db, RenameToken *pToken){
927   RenameToken *pNext;
928   RenameToken *p;
929   for(p=pToken; p; p=pNext){
930     pNext = p->pNext;
931     sqlite3DbFree(db, p);
932   }
933 }
934 
935 /*
936 ** Search the Parse object passed as the first argument for a RenameToken
937 ** object associated with parse tree element pPtr. If found, return a pointer
938 ** to it. Otherwise, return NULL.
939 **
940 ** If the second argument passed to this function is not NULL and a matching
941 ** RenameToken object is found, remove it from the Parse object and add it to
942 ** the list maintained by the RenameCtx object.
943 */
944 static RenameToken *renameTokenFind(
945   Parse *pParse,
946   struct RenameCtx *pCtx,
947   void *pPtr
948 ){
949   RenameToken **pp;
950   if( NEVER(pPtr==0) ){
951     return 0;
952   }
953   for(pp=&pParse->pRename; (*pp); pp=&(*pp)->pNext){
954     if( (*pp)->p==pPtr ){
955       RenameToken *pToken = *pp;
956       if( pCtx ){
957         *pp = pToken->pNext;
958         pToken->pNext = pCtx->pList;
959         pCtx->pList = pToken;
960         pCtx->nList++;
961       }
962       return pToken;
963     }
964   }
965   return 0;
966 }
967 
968 /*
969 ** This is a Walker select callback. It does nothing. It is only required
970 ** because without a dummy callback, sqlite3WalkExpr() and similar do not
971 ** descend into sub-select statements.
972 */
973 static int renameColumnSelectCb(Walker *pWalker, Select *p){
974   if( p->selFlags & (SF_View|SF_CopyCte) ){
975     testcase( p->selFlags & SF_View );
976     testcase( p->selFlags & SF_CopyCte );
977     return WRC_Prune;
978   }
979   renameWalkWith(pWalker, p);
980   return WRC_Continue;
981 }
982 
983 /*
984 ** This is a Walker expression callback.
985 **
986 ** For every TK_COLUMN node in the expression tree, search to see
987 ** if the column being references is the column being renamed by an
988 ** ALTER TABLE statement.  If it is, then attach its associated
989 ** RenameToken object to the list of RenameToken objects being
990 ** constructed in RenameCtx object at pWalker->u.pRename.
991 */
992 static int renameColumnExprCb(Walker *pWalker, Expr *pExpr){
993   RenameCtx *p = pWalker->u.pRename;
994   if( pExpr->op==TK_TRIGGER
995    && pExpr->iColumn==p->iCol
996    && pWalker->pParse->pTriggerTab==p->pTab
997   ){
998     renameTokenFind(pWalker->pParse, p, (void*)pExpr);
999   }else if( pExpr->op==TK_COLUMN
1000    && pExpr->iColumn==p->iCol
1001    && p->pTab==pExpr->y.pTab
1002   ){
1003     renameTokenFind(pWalker->pParse, p, (void*)pExpr);
1004   }
1005   return WRC_Continue;
1006 }
1007 
1008 /*
1009 ** The RenameCtx contains a list of tokens that reference a column that
1010 ** is being renamed by an ALTER TABLE statement.  Return the "last"
1011 ** RenameToken in the RenameCtx and remove that RenameToken from the
1012 ** RenameContext.  "Last" means the last RenameToken encountered when
1013 ** the input SQL is parsed from left to right.  Repeated calls to this routine
1014 ** return all column name tokens in the order that they are encountered
1015 ** in the SQL statement.
1016 */
1017 static RenameToken *renameColumnTokenNext(RenameCtx *pCtx){
1018   RenameToken *pBest = pCtx->pList;
1019   RenameToken *pToken;
1020   RenameToken **pp;
1021 
1022   for(pToken=pBest->pNext; pToken; pToken=pToken->pNext){
1023     if( pToken->t.z>pBest->t.z ) pBest = pToken;
1024   }
1025   for(pp=&pCtx->pList; *pp!=pBest; pp=&(*pp)->pNext);
1026   *pp = pBest->pNext;
1027 
1028   return pBest;
1029 }
1030 
1031 /*
1032 ** An error occured while parsing or otherwise processing a database
1033 ** object (either pParse->pNewTable, pNewIndex or pNewTrigger) as part of an
1034 ** ALTER TABLE RENAME COLUMN program. The error message emitted by the
1035 ** sub-routine is currently stored in pParse->zErrMsg. This function
1036 ** adds context to the error message and then stores it in pCtx.
1037 */
1038 static void renameColumnParseError(
1039   sqlite3_context *pCtx,
1040   const char *zWhen,
1041   sqlite3_value *pType,
1042   sqlite3_value *pObject,
1043   Parse *pParse
1044 ){
1045   const char *zT = (const char*)sqlite3_value_text(pType);
1046   const char *zN = (const char*)sqlite3_value_text(pObject);
1047   char *zErr;
1048 
1049   zErr = sqlite3_mprintf("error in %s %s%s%s: %s",
1050       zT, zN, (zWhen[0] ? " " : ""), zWhen,
1051       pParse->zErrMsg
1052   );
1053   sqlite3_result_error(pCtx, zErr, -1);
1054   sqlite3_free(zErr);
1055 }
1056 
1057 /*
1058 ** For each name in the the expression-list pEList (i.e. each
1059 ** pEList->a[i].zName) that matches the string in zOld, extract the
1060 ** corresponding rename-token from Parse object pParse and add it
1061 ** to the RenameCtx pCtx.
1062 */
1063 static void renameColumnElistNames(
1064   Parse *pParse,
1065   RenameCtx *pCtx,
1066   ExprList *pEList,
1067   const char *zOld
1068 ){
1069   if( pEList ){
1070     int i;
1071     for(i=0; i<pEList->nExpr; i++){
1072       char *zName = pEList->a[i].zEName;
1073       if( ALWAYS(pEList->a[i].eEName==ENAME_NAME)
1074        && ALWAYS(zName!=0)
1075        && 0==sqlite3_stricmp(zName, zOld)
1076       ){
1077         renameTokenFind(pParse, pCtx, (void*)zName);
1078       }
1079     }
1080   }
1081 }
1082 
1083 /*
1084 ** For each name in the the id-list pIdList (i.e. each pIdList->a[i].zName)
1085 ** that matches the string in zOld, extract the corresponding rename-token
1086 ** from Parse object pParse and add it to the RenameCtx pCtx.
1087 */
1088 static void renameColumnIdlistNames(
1089   Parse *pParse,
1090   RenameCtx *pCtx,
1091   IdList *pIdList,
1092   const char *zOld
1093 ){
1094   if( pIdList ){
1095     int i;
1096     for(i=0; i<pIdList->nId; i++){
1097       char *zName = pIdList->a[i].zName;
1098       if( 0==sqlite3_stricmp(zName, zOld) ){
1099         renameTokenFind(pParse, pCtx, (void*)zName);
1100       }
1101     }
1102   }
1103 }
1104 
1105 
1106 /*
1107 ** Parse the SQL statement zSql using Parse object (*p). The Parse object
1108 ** is initialized by this function before it is used.
1109 */
1110 static int renameParseSql(
1111   Parse *p,                       /* Memory to use for Parse object */
1112   const char *zDb,                /* Name of schema SQL belongs to */
1113   sqlite3 *db,                    /* Database handle */
1114   const char *zSql,               /* SQL to parse */
1115   int bTemp                       /* True if SQL is from temp schema */
1116 ){
1117   int rc;
1118   char *zErr = 0;
1119 
1120   db->init.iDb = bTemp ? 1 : sqlite3FindDbName(db, zDb);
1121 
1122   /* Parse the SQL statement passed as the first argument. If no error
1123   ** occurs and the parse does not result in a new table, index or
1124   ** trigger object, the database must be corrupt. */
1125   memset(p, 0, sizeof(Parse));
1126   p->eParseMode = PARSE_MODE_RENAME;
1127   p->db = db;
1128   p->nQueryLoop = 1;
1129   rc = zSql ? sqlite3RunParser(p, zSql, &zErr) : SQLITE_NOMEM;
1130   assert( p->zErrMsg==0 );
1131   assert( rc!=SQLITE_OK || zErr==0 );
1132   p->zErrMsg = zErr;
1133   if( db->mallocFailed ) rc = SQLITE_NOMEM;
1134   if( rc==SQLITE_OK
1135    && p->pNewTable==0 && p->pNewIndex==0 && p->pNewTrigger==0
1136   ){
1137     rc = SQLITE_CORRUPT_BKPT;
1138   }
1139 
1140 #ifdef SQLITE_DEBUG
1141   /* Ensure that all mappings in the Parse.pRename list really do map to
1142   ** a part of the input string.  */
1143   if( rc==SQLITE_OK ){
1144     int nSql = sqlite3Strlen30(zSql);
1145     RenameToken *pToken;
1146     for(pToken=p->pRename; pToken; pToken=pToken->pNext){
1147       assert( pToken->t.z>=zSql && &pToken->t.z[pToken->t.n]<=&zSql[nSql] );
1148     }
1149   }
1150 #endif
1151 
1152   db->init.iDb = 0;
1153   return rc;
1154 }
1155 
1156 /*
1157 ** This function edits SQL statement zSql, replacing each token identified
1158 ** by the linked list pRename with the text of zNew. If argument bQuote is
1159 ** true, then zNew is always quoted first. If no error occurs, the result
1160 ** is loaded into context object pCtx as the result.
1161 **
1162 ** Or, if an error occurs (i.e. an OOM condition), an error is left in
1163 ** pCtx and an SQLite error code returned.
1164 */
1165 static int renameEditSql(
1166   sqlite3_context *pCtx,          /* Return result here */
1167   RenameCtx *pRename,             /* Rename context */
1168   const char *zSql,               /* SQL statement to edit */
1169   const char *zNew,               /* New token text */
1170   int bQuote                      /* True to always quote token */
1171 ){
1172   i64 nNew = sqlite3Strlen30(zNew);
1173   i64 nSql = sqlite3Strlen30(zSql);
1174   sqlite3 *db = sqlite3_context_db_handle(pCtx);
1175   int rc = SQLITE_OK;
1176   char *zQuot = 0;
1177   char *zOut;
1178   i64 nQuot = 0;
1179   char *zBuf1 = 0;
1180   char *zBuf2 = 0;
1181 
1182   if( zNew ){
1183     /* Set zQuot to point to a buffer containing a quoted copy of the
1184     ** identifier zNew. If the corresponding identifier in the original
1185     ** ALTER TABLE statement was quoted (bQuote==1), then set zNew to
1186     ** point to zQuot so that all substitutions are made using the
1187     ** quoted version of the new column name.  */
1188     zQuot = sqlite3MPrintf(db, "\"%w\" ", zNew);
1189     if( zQuot==0 ){
1190       return SQLITE_NOMEM;
1191     }else{
1192       nQuot = sqlite3Strlen30(zQuot)-1;
1193     }
1194 
1195     assert( nQuot>=nNew );
1196     zOut = sqlite3DbMallocZero(db, nSql + pRename->nList*nQuot + 1);
1197   }else{
1198     zOut = (char*)sqlite3DbMallocZero(db, (nSql*2+1) * 3);
1199     if( zOut ){
1200       zBuf1 = &zOut[nSql*2+1];
1201       zBuf2 = &zOut[nSql*4+2];
1202     }
1203   }
1204 
1205   /* At this point pRename->pList contains a list of RenameToken objects
1206   ** corresponding to all tokens in the input SQL that must be replaced
1207   ** with the new column name, or with single-quoted versions of themselves.
1208   ** All that remains is to construct and return the edited SQL string. */
1209   if( zOut ){
1210     int nOut = nSql;
1211     memcpy(zOut, zSql, nSql);
1212     while( pRename->pList ){
1213       int iOff;                   /* Offset of token to replace in zOut */
1214       u32 nReplace;
1215       const char *zReplace;
1216       RenameToken *pBest = renameColumnTokenNext(pRename);
1217 
1218       if( zNew ){
1219         if( bQuote==0 && sqlite3IsIdChar(*pBest->t.z) ){
1220           nReplace = nNew;
1221           zReplace = zNew;
1222         }else{
1223           nReplace = nQuot;
1224           zReplace = zQuot;
1225           if( pBest->t.z[pBest->t.n]=='"' ) nReplace++;
1226         }
1227       }else{
1228         /* Dequote the double-quoted token. Then requote it again, this time
1229         ** using single quotes. If the character immediately following the
1230         ** original token within the input SQL was a single quote ('), then
1231         ** add another space after the new, single-quoted version of the
1232         ** token. This is so that (SELECT "string"'alias') maps to
1233         ** (SELECT 'string' 'alias'), and not (SELECT 'string''alias').  */
1234         memcpy(zBuf1, pBest->t.z, pBest->t.n);
1235         zBuf1[pBest->t.n] = 0;
1236         sqlite3Dequote(zBuf1);
1237         sqlite3_snprintf(nSql*2, zBuf2, "%Q%s", zBuf1,
1238             pBest->t.z[pBest->t.n]=='\'' ? " " : ""
1239         );
1240         zReplace = zBuf2;
1241         nReplace = sqlite3Strlen30(zReplace);
1242       }
1243 
1244       iOff = pBest->t.z - zSql;
1245       if( pBest->t.n!=nReplace ){
1246         memmove(&zOut[iOff + nReplace], &zOut[iOff + pBest->t.n],
1247             nOut - (iOff + pBest->t.n)
1248         );
1249         nOut += nReplace - pBest->t.n;
1250         zOut[nOut] = '\0';
1251       }
1252       memcpy(&zOut[iOff], zReplace, nReplace);
1253       sqlite3DbFree(db, pBest);
1254     }
1255 
1256     sqlite3_result_text(pCtx, zOut, -1, SQLITE_TRANSIENT);
1257     sqlite3DbFree(db, zOut);
1258   }else{
1259     rc = SQLITE_NOMEM;
1260   }
1261 
1262   sqlite3_free(zQuot);
1263   return rc;
1264 }
1265 
1266 /*
1267 ** Resolve all symbols in the trigger at pParse->pNewTrigger, assuming
1268 ** it was read from the schema of database zDb. Return SQLITE_OK if
1269 ** successful. Otherwise, return an SQLite error code and leave an error
1270 ** message in the Parse object.
1271 */
1272 static int renameResolveTrigger(Parse *pParse){
1273   sqlite3 *db = pParse->db;
1274   Trigger *pNew = pParse->pNewTrigger;
1275   TriggerStep *pStep;
1276   NameContext sNC;
1277   int rc = SQLITE_OK;
1278 
1279   memset(&sNC, 0, sizeof(sNC));
1280   sNC.pParse = pParse;
1281   assert( pNew->pTabSchema );
1282   pParse->pTriggerTab = sqlite3FindTable(db, pNew->table,
1283       db->aDb[sqlite3SchemaToIndex(db, pNew->pTabSchema)].zDbSName
1284   );
1285   pParse->eTriggerOp = pNew->op;
1286   /* ALWAYS() because if the table of the trigger does not exist, the
1287   ** error would have been hit before this point */
1288   if( ALWAYS(pParse->pTriggerTab) ){
1289     rc = sqlite3ViewGetColumnNames(pParse, pParse->pTriggerTab);
1290   }
1291 
1292   /* Resolve symbols in WHEN clause */
1293   if( rc==SQLITE_OK && pNew->pWhen ){
1294     rc = sqlite3ResolveExprNames(&sNC, pNew->pWhen);
1295   }
1296 
1297   for(pStep=pNew->step_list; rc==SQLITE_OK && pStep; pStep=pStep->pNext){
1298     if( pStep->pSelect ){
1299       sqlite3SelectPrep(pParse, pStep->pSelect, &sNC);
1300       if( pParse->nErr ) rc = pParse->rc;
1301     }
1302     if( rc==SQLITE_OK && pStep->zTarget ){
1303       SrcList *pSrc = sqlite3TriggerStepSrc(pParse, pStep);
1304       if( pSrc ){
1305         int i;
1306         for(i=0; i<pSrc->nSrc && rc==SQLITE_OK; i++){
1307           SrcItem *p = &pSrc->a[i];
1308           p->iCursor = pParse->nTab++;
1309           if( p->pSelect ){
1310             sqlite3SelectPrep(pParse, p->pSelect, 0);
1311             sqlite3ExpandSubquery(pParse, p);
1312             assert( i>0 );
1313             assert( pStep->pFrom->a[i-1].pSelect );
1314             sqlite3SelectPrep(pParse, pStep->pFrom->a[i-1].pSelect, 0);
1315           }else{
1316             p->pTab = sqlite3LocateTableItem(pParse, 0, p);
1317             if( p->pTab==0 ){
1318               rc = SQLITE_ERROR;
1319             }else{
1320               p->pTab->nTabRef++;
1321               rc = sqlite3ViewGetColumnNames(pParse, p->pTab);
1322             }
1323           }
1324         }
1325         sNC.pSrcList = pSrc;
1326         if( rc==SQLITE_OK && pStep->pWhere ){
1327           rc = sqlite3ResolveExprNames(&sNC, pStep->pWhere);
1328         }
1329         if( rc==SQLITE_OK ){
1330           rc = sqlite3ResolveExprListNames(&sNC, pStep->pExprList);
1331         }
1332         assert( !pStep->pUpsert || (!pStep->pWhere && !pStep->pExprList) );
1333         if( pStep->pUpsert && rc==SQLITE_OK ){
1334           Upsert *pUpsert = pStep->pUpsert;
1335           pUpsert->pUpsertSrc = pSrc;
1336           sNC.uNC.pUpsert = pUpsert;
1337           sNC.ncFlags = NC_UUpsert;
1338           rc = sqlite3ResolveExprListNames(&sNC, pUpsert->pUpsertTarget);
1339           if( rc==SQLITE_OK ){
1340             ExprList *pUpsertSet = pUpsert->pUpsertSet;
1341             rc = sqlite3ResolveExprListNames(&sNC, pUpsertSet);
1342           }
1343           if( rc==SQLITE_OK ){
1344             rc = sqlite3ResolveExprNames(&sNC, pUpsert->pUpsertWhere);
1345           }
1346           if( rc==SQLITE_OK ){
1347             rc = sqlite3ResolveExprNames(&sNC, pUpsert->pUpsertTargetWhere);
1348           }
1349           sNC.ncFlags = 0;
1350         }
1351         sNC.pSrcList = 0;
1352         sqlite3SrcListDelete(db, pSrc);
1353       }else{
1354         rc = SQLITE_NOMEM;
1355       }
1356     }
1357   }
1358   return rc;
1359 }
1360 
1361 /*
1362 ** Invoke sqlite3WalkExpr() or sqlite3WalkSelect() on all Select or Expr
1363 ** objects that are part of the trigger passed as the second argument.
1364 */
1365 static void renameWalkTrigger(Walker *pWalker, Trigger *pTrigger){
1366   TriggerStep *pStep;
1367 
1368   /* Find tokens to edit in WHEN clause */
1369   sqlite3WalkExpr(pWalker, pTrigger->pWhen);
1370 
1371   /* Find tokens to edit in trigger steps */
1372   for(pStep=pTrigger->step_list; pStep; pStep=pStep->pNext){
1373     sqlite3WalkSelect(pWalker, pStep->pSelect);
1374     sqlite3WalkExpr(pWalker, pStep->pWhere);
1375     sqlite3WalkExprList(pWalker, pStep->pExprList);
1376     if( pStep->pUpsert ){
1377       Upsert *pUpsert = pStep->pUpsert;
1378       sqlite3WalkExprList(pWalker, pUpsert->pUpsertTarget);
1379       sqlite3WalkExprList(pWalker, pUpsert->pUpsertSet);
1380       sqlite3WalkExpr(pWalker, pUpsert->pUpsertWhere);
1381       sqlite3WalkExpr(pWalker, pUpsert->pUpsertTargetWhere);
1382     }
1383     if( pStep->pFrom ){
1384       int i;
1385       for(i=0; i<pStep->pFrom->nSrc; i++){
1386         sqlite3WalkSelect(pWalker, pStep->pFrom->a[i].pSelect);
1387       }
1388     }
1389   }
1390 }
1391 
1392 /*
1393 ** Free the contents of Parse object (*pParse). Do not free the memory
1394 ** occupied by the Parse object itself.
1395 */
1396 static void renameParseCleanup(Parse *pParse){
1397   sqlite3 *db = pParse->db;
1398   Index *pIdx;
1399   if( pParse->pVdbe ){
1400     sqlite3VdbeFinalize(pParse->pVdbe);
1401   }
1402   sqlite3DeleteTable(db, pParse->pNewTable);
1403   while( (pIdx = pParse->pNewIndex)!=0 ){
1404     pParse->pNewIndex = pIdx->pNext;
1405     sqlite3FreeIndex(db, pIdx);
1406   }
1407   sqlite3DeleteTrigger(db, pParse->pNewTrigger);
1408   sqlite3DbFree(db, pParse->zErrMsg);
1409   renameTokenFree(db, pParse->pRename);
1410   sqlite3ParserReset(pParse);
1411 }
1412 
1413 /*
1414 ** SQL function:
1415 **
1416 **     sqlite_rename_column(zSql, iCol, bQuote, zNew, zTable, zOld)
1417 **
1418 **   0. zSql:     SQL statement to rewrite
1419 **   1. type:     Type of object ("table", "view" etc.)
1420 **   2. object:   Name of object
1421 **   3. Database: Database name (e.g. "main")
1422 **   4. Table:    Table name
1423 **   5. iCol:     Index of column to rename
1424 **   6. zNew:     New column name
1425 **   7. bQuote:   Non-zero if the new column name should be quoted.
1426 **   8. bTemp:    True if zSql comes from temp schema
1427 **
1428 ** Do a column rename operation on the CREATE statement given in zSql.
1429 ** The iCol-th column (left-most is 0) of table zTable is renamed from zCol
1430 ** into zNew.  The name should be quoted if bQuote is true.
1431 **
1432 ** This function is used internally by the ALTER TABLE RENAME COLUMN command.
1433 ** It is only accessible to SQL created using sqlite3NestedParse().  It is
1434 ** not reachable from ordinary SQL passed into sqlite3_prepare().
1435 */
1436 static void renameColumnFunc(
1437   sqlite3_context *context,
1438   int NotUsed,
1439   sqlite3_value **argv
1440 ){
1441   sqlite3 *db = sqlite3_context_db_handle(context);
1442   RenameCtx sCtx;
1443   const char *zSql = (const char*)sqlite3_value_text(argv[0]);
1444   const char *zDb = (const char*)sqlite3_value_text(argv[3]);
1445   const char *zTable = (const char*)sqlite3_value_text(argv[4]);
1446   int iCol = sqlite3_value_int(argv[5]);
1447   const char *zNew = (const char*)sqlite3_value_text(argv[6]);
1448   int bQuote = sqlite3_value_int(argv[7]);
1449   int bTemp = sqlite3_value_int(argv[8]);
1450   const char *zOld;
1451   int rc;
1452   Parse sParse;
1453   Walker sWalker;
1454   Index *pIdx;
1455   int i;
1456   Table *pTab;
1457 #ifndef SQLITE_OMIT_AUTHORIZATION
1458   sqlite3_xauth xAuth = db->xAuth;
1459 #endif
1460 
1461   UNUSED_PARAMETER(NotUsed);
1462   if( zSql==0 ) return;
1463   if( zTable==0 ) return;
1464   if( zNew==0 ) return;
1465   if( iCol<0 ) return;
1466   sqlite3BtreeEnterAll(db);
1467   pTab = sqlite3FindTable(db, zTable, zDb);
1468   if( pTab==0 || iCol>=pTab->nCol ){
1469     sqlite3BtreeLeaveAll(db);
1470     return;
1471   }
1472   zOld = pTab->aCol[iCol].zCnName;
1473   memset(&sCtx, 0, sizeof(sCtx));
1474   sCtx.iCol = ((iCol==pTab->iPKey) ? -1 : iCol);
1475 
1476 #ifndef SQLITE_OMIT_AUTHORIZATION
1477   db->xAuth = 0;
1478 #endif
1479   rc = renameParseSql(&sParse, zDb, db, zSql, bTemp);
1480 
1481   /* Find tokens that need to be replaced. */
1482   memset(&sWalker, 0, sizeof(Walker));
1483   sWalker.pParse = &sParse;
1484   sWalker.xExprCallback = renameColumnExprCb;
1485   sWalker.xSelectCallback = renameColumnSelectCb;
1486   sWalker.u.pRename = &sCtx;
1487 
1488   sCtx.pTab = pTab;
1489   if( rc!=SQLITE_OK ) goto renameColumnFunc_done;
1490   if( sParse.pNewTable ){
1491     if( IsView(sParse.pNewTable) ){
1492       Select *pSelect = sParse.pNewTable->u.view.pSelect;
1493       pSelect->selFlags &= ~SF_View;
1494       sParse.rc = SQLITE_OK;
1495       sqlite3SelectPrep(&sParse, pSelect, 0);
1496       rc = (db->mallocFailed ? SQLITE_NOMEM : sParse.rc);
1497       if( rc==SQLITE_OK ){
1498         sqlite3WalkSelect(&sWalker, pSelect);
1499       }
1500       if( rc!=SQLITE_OK ) goto renameColumnFunc_done;
1501     }else if( ALWAYS(IsOrdinaryTable(sParse.pNewTable)) ){
1502       /* A regular table */
1503       int bFKOnly = sqlite3_stricmp(zTable, sParse.pNewTable->zName);
1504       FKey *pFKey;
1505       sCtx.pTab = sParse.pNewTable;
1506       if( bFKOnly==0 ){
1507         if( iCol<sParse.pNewTable->nCol ){
1508           renameTokenFind(
1509               &sParse, &sCtx, (void*)sParse.pNewTable->aCol[iCol].zCnName
1510           );
1511         }
1512         if( sCtx.iCol<0 ){
1513           renameTokenFind(&sParse, &sCtx, (void*)&sParse.pNewTable->iPKey);
1514         }
1515         sqlite3WalkExprList(&sWalker, sParse.pNewTable->pCheck);
1516         for(pIdx=sParse.pNewTable->pIndex; pIdx; pIdx=pIdx->pNext){
1517           sqlite3WalkExprList(&sWalker, pIdx->aColExpr);
1518         }
1519         for(pIdx=sParse.pNewIndex; pIdx; pIdx=pIdx->pNext){
1520           sqlite3WalkExprList(&sWalker, pIdx->aColExpr);
1521         }
1522 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1523         for(i=0; i<sParse.pNewTable->nCol; i++){
1524           Expr *pExpr = sqlite3ColumnExpr(sParse.pNewTable,
1525                                                   &sParse.pNewTable->aCol[i]);
1526           sqlite3WalkExpr(&sWalker, pExpr);
1527         }
1528 #endif
1529       }
1530 
1531       assert( !IsVirtual(sParse.pNewTable) );
1532       for(pFKey=sParse.pNewTable->u.tab.pFKey; pFKey; pFKey=pFKey->pNextFrom){
1533         for(i=0; i<pFKey->nCol; i++){
1534           if( bFKOnly==0 && pFKey->aCol[i].iFrom==iCol ){
1535             renameTokenFind(&sParse, &sCtx, (void*)&pFKey->aCol[i]);
1536           }
1537           if( 0==sqlite3_stricmp(pFKey->zTo, zTable)
1538            && 0==sqlite3_stricmp(pFKey->aCol[i].zCol, zOld)
1539           ){
1540             renameTokenFind(&sParse, &sCtx, (void*)pFKey->aCol[i].zCol);
1541           }
1542         }
1543       }
1544     }
1545   }else if( sParse.pNewIndex ){
1546     sqlite3WalkExprList(&sWalker, sParse.pNewIndex->aColExpr);
1547     sqlite3WalkExpr(&sWalker, sParse.pNewIndex->pPartIdxWhere);
1548   }else{
1549     /* A trigger */
1550     TriggerStep *pStep;
1551     rc = renameResolveTrigger(&sParse);
1552     if( rc!=SQLITE_OK ) goto renameColumnFunc_done;
1553 
1554     for(pStep=sParse.pNewTrigger->step_list; pStep; pStep=pStep->pNext){
1555       if( pStep->zTarget ){
1556         Table *pTarget = sqlite3LocateTable(&sParse, 0, pStep->zTarget, zDb);
1557         if( pTarget==pTab ){
1558           if( pStep->pUpsert ){
1559             ExprList *pUpsertSet = pStep->pUpsert->pUpsertSet;
1560             renameColumnElistNames(&sParse, &sCtx, pUpsertSet, zOld);
1561           }
1562           renameColumnIdlistNames(&sParse, &sCtx, pStep->pIdList, zOld);
1563           renameColumnElistNames(&sParse, &sCtx, pStep->pExprList, zOld);
1564         }
1565       }
1566     }
1567 
1568 
1569     /* Find tokens to edit in UPDATE OF clause */
1570     if( sParse.pTriggerTab==pTab ){
1571       renameColumnIdlistNames(&sParse, &sCtx,sParse.pNewTrigger->pColumns,zOld);
1572     }
1573 
1574     /* Find tokens to edit in various expressions and selects */
1575     renameWalkTrigger(&sWalker, sParse.pNewTrigger);
1576   }
1577 
1578   assert( rc==SQLITE_OK );
1579   rc = renameEditSql(context, &sCtx, zSql, zNew, bQuote);
1580 
1581 renameColumnFunc_done:
1582   if( rc!=SQLITE_OK ){
1583     if( sParse.zErrMsg ){
1584       renameColumnParseError(context, "", argv[1], argv[2], &sParse);
1585     }else{
1586       sqlite3_result_error_code(context, rc);
1587     }
1588   }
1589 
1590   renameParseCleanup(&sParse);
1591   renameTokenFree(db, sCtx.pList);
1592 #ifndef SQLITE_OMIT_AUTHORIZATION
1593   db->xAuth = xAuth;
1594 #endif
1595   sqlite3BtreeLeaveAll(db);
1596 }
1597 
1598 /*
1599 ** Walker expression callback used by "RENAME TABLE".
1600 */
1601 static int renameTableExprCb(Walker *pWalker, Expr *pExpr){
1602   RenameCtx *p = pWalker->u.pRename;
1603   if( pExpr->op==TK_COLUMN && p->pTab==pExpr->y.pTab ){
1604     renameTokenFind(pWalker->pParse, p, (void*)&pExpr->y.pTab);
1605   }
1606   return WRC_Continue;
1607 }
1608 
1609 /*
1610 ** Walker select callback used by "RENAME TABLE".
1611 */
1612 static int renameTableSelectCb(Walker *pWalker, Select *pSelect){
1613   int i;
1614   RenameCtx *p = pWalker->u.pRename;
1615   SrcList *pSrc = pSelect->pSrc;
1616   if( pSelect->selFlags & (SF_View|SF_CopyCte) ){
1617     testcase( pSelect->selFlags & SF_View );
1618     testcase( pSelect->selFlags & SF_CopyCte );
1619     return WRC_Prune;
1620   }
1621   if( NEVER(pSrc==0) ){
1622     assert( pWalker->pParse->db->mallocFailed );
1623     return WRC_Abort;
1624   }
1625   for(i=0; i<pSrc->nSrc; i++){
1626     SrcItem *pItem = &pSrc->a[i];
1627     if( pItem->pTab==p->pTab ){
1628       renameTokenFind(pWalker->pParse, p, pItem->zName);
1629     }
1630   }
1631   renameWalkWith(pWalker, pSelect);
1632 
1633   return WRC_Continue;
1634 }
1635 
1636 
1637 /*
1638 ** This C function implements an SQL user function that is used by SQL code
1639 ** generated by the ALTER TABLE ... RENAME command to modify the definition
1640 ** of any foreign key constraints that use the table being renamed as the
1641 ** parent table. It is passed three arguments:
1642 **
1643 **   0: The database containing the table being renamed.
1644 **   1. type:     Type of object ("table", "view" etc.)
1645 **   2. object:   Name of object
1646 **   3: The complete text of the schema statement being modified,
1647 **   4: The old name of the table being renamed, and
1648 **   5: The new name of the table being renamed.
1649 **   6: True if the schema statement comes from the temp db.
1650 **
1651 ** It returns the new schema statement. For example:
1652 **
1653 ** sqlite_rename_table('main', 'CREATE TABLE t1(a REFERENCES t2)','t2','t3',0)
1654 **       -> 'CREATE TABLE t1(a REFERENCES t3)'
1655 */
1656 static void renameTableFunc(
1657   sqlite3_context *context,
1658   int NotUsed,
1659   sqlite3_value **argv
1660 ){
1661   sqlite3 *db = sqlite3_context_db_handle(context);
1662   const char *zDb = (const char*)sqlite3_value_text(argv[0]);
1663   const char *zInput = (const char*)sqlite3_value_text(argv[3]);
1664   const char *zOld = (const char*)sqlite3_value_text(argv[4]);
1665   const char *zNew = (const char*)sqlite3_value_text(argv[5]);
1666   int bTemp = sqlite3_value_int(argv[6]);
1667   UNUSED_PARAMETER(NotUsed);
1668 
1669   if( zInput && zOld && zNew ){
1670     Parse sParse;
1671     int rc;
1672     int bQuote = 1;
1673     RenameCtx sCtx;
1674     Walker sWalker;
1675 
1676 #ifndef SQLITE_OMIT_AUTHORIZATION
1677     sqlite3_xauth xAuth = db->xAuth;
1678     db->xAuth = 0;
1679 #endif
1680 
1681     sqlite3BtreeEnterAll(db);
1682 
1683     memset(&sCtx, 0, sizeof(RenameCtx));
1684     sCtx.pTab = sqlite3FindTable(db, zOld, zDb);
1685     memset(&sWalker, 0, sizeof(Walker));
1686     sWalker.pParse = &sParse;
1687     sWalker.xExprCallback = renameTableExprCb;
1688     sWalker.xSelectCallback = renameTableSelectCb;
1689     sWalker.u.pRename = &sCtx;
1690 
1691     rc = renameParseSql(&sParse, zDb, db, zInput, bTemp);
1692 
1693     if( rc==SQLITE_OK ){
1694       int isLegacy = (db->flags & SQLITE_LegacyAlter);
1695       if( sParse.pNewTable ){
1696         Table *pTab = sParse.pNewTable;
1697 
1698         if( IsView(pTab) ){
1699           if( isLegacy==0 ){
1700             Select *pSelect = pTab->u.view.pSelect;
1701             NameContext sNC;
1702             memset(&sNC, 0, sizeof(sNC));
1703             sNC.pParse = &sParse;
1704 
1705             assert( pSelect->selFlags & SF_View );
1706             pSelect->selFlags &= ~SF_View;
1707             sqlite3SelectPrep(&sParse, pTab->u.view.pSelect, &sNC);
1708             if( sParse.nErr ){
1709               rc = sParse.rc;
1710             }else{
1711               sqlite3WalkSelect(&sWalker, pTab->u.view.pSelect);
1712             }
1713           }
1714         }else{
1715           /* Modify any FK definitions to point to the new table. */
1716 #ifndef SQLITE_OMIT_FOREIGN_KEY
1717           if( (isLegacy==0 || (db->flags & SQLITE_ForeignKeys))
1718            && !IsVirtual(pTab)
1719           ){
1720             FKey *pFKey;
1721             assert( !IsVirtual(pTab) );
1722             for(pFKey=pTab->u.tab.pFKey; pFKey; pFKey=pFKey->pNextFrom){
1723               if( sqlite3_stricmp(pFKey->zTo, zOld)==0 ){
1724                 renameTokenFind(&sParse, &sCtx, (void*)pFKey->zTo);
1725               }
1726             }
1727           }
1728 #endif
1729 
1730           /* If this is the table being altered, fix any table refs in CHECK
1731           ** expressions. Also update the name that appears right after the
1732           ** "CREATE [VIRTUAL] TABLE" bit. */
1733           if( sqlite3_stricmp(zOld, pTab->zName)==0 ){
1734             sCtx.pTab = pTab;
1735             if( isLegacy==0 ){
1736               sqlite3WalkExprList(&sWalker, pTab->pCheck);
1737             }
1738             renameTokenFind(&sParse, &sCtx, pTab->zName);
1739           }
1740         }
1741       }
1742 
1743       else if( sParse.pNewIndex ){
1744         renameTokenFind(&sParse, &sCtx, sParse.pNewIndex->zName);
1745         if( isLegacy==0 ){
1746           sqlite3WalkExpr(&sWalker, sParse.pNewIndex->pPartIdxWhere);
1747         }
1748       }
1749 
1750 #ifndef SQLITE_OMIT_TRIGGER
1751       else{
1752         Trigger *pTrigger = sParse.pNewTrigger;
1753         TriggerStep *pStep;
1754         if( 0==sqlite3_stricmp(sParse.pNewTrigger->table, zOld)
1755             && sCtx.pTab->pSchema==pTrigger->pTabSchema
1756           ){
1757           renameTokenFind(&sParse, &sCtx, sParse.pNewTrigger->table);
1758         }
1759 
1760         if( isLegacy==0 ){
1761           rc = renameResolveTrigger(&sParse);
1762           if( rc==SQLITE_OK ){
1763             renameWalkTrigger(&sWalker, pTrigger);
1764             for(pStep=pTrigger->step_list; pStep; pStep=pStep->pNext){
1765               if( pStep->zTarget && 0==sqlite3_stricmp(pStep->zTarget, zOld) ){
1766                 renameTokenFind(&sParse, &sCtx, pStep->zTarget);
1767               }
1768             }
1769           }
1770         }
1771       }
1772 #endif
1773     }
1774 
1775     if( rc==SQLITE_OK ){
1776       rc = renameEditSql(context, &sCtx, zInput, zNew, bQuote);
1777     }
1778     if( rc!=SQLITE_OK ){
1779       if( sParse.zErrMsg ){
1780         renameColumnParseError(context, "", argv[1], argv[2], &sParse);
1781       }else{
1782         sqlite3_result_error_code(context, rc);
1783       }
1784     }
1785 
1786     renameParseCleanup(&sParse);
1787     renameTokenFree(db, sCtx.pList);
1788     sqlite3BtreeLeaveAll(db);
1789 #ifndef SQLITE_OMIT_AUTHORIZATION
1790     db->xAuth = xAuth;
1791 #endif
1792   }
1793 
1794   return;
1795 }
1796 
1797 static int renameQuotefixExprCb(Walker *pWalker, Expr *pExpr){
1798   if( pExpr->op==TK_STRING && (pExpr->flags & EP_DblQuoted) ){
1799     renameTokenFind(pWalker->pParse, pWalker->u.pRename, (void*)pExpr);
1800   }
1801   return WRC_Continue;
1802 }
1803 
1804 /*
1805 ** The implementation of an SQL scalar function that rewrites DDL statements
1806 ** so that any string literals that use double-quotes are modified so that
1807 ** they use single quotes.
1808 **
1809 ** Two arguments must be passed:
1810 **
1811 **   0: Database name ("main", "temp" etc.).
1812 **   1: SQL statement to edit.
1813 **
1814 ** The returned value is the modified SQL statement. For example, given
1815 ** the database schema:
1816 **
1817 **   CREATE TABLE t1(a, b, c);
1818 **
1819 **   SELECT sqlite_rename_quotefix('main',
1820 **       'CREATE VIEW v1 AS SELECT "a", "string" FROM t1'
1821 **   );
1822 **
1823 ** returns the string:
1824 **
1825 **   CREATE VIEW v1 AS SELECT "a", 'string' FROM t1
1826 */
1827 static void renameQuotefixFunc(
1828   sqlite3_context *context,
1829   int NotUsed,
1830   sqlite3_value **argv
1831 ){
1832   sqlite3 *db = sqlite3_context_db_handle(context);
1833   char const *zDb = (const char*)sqlite3_value_text(argv[0]);
1834   char const *zInput = (const char*)sqlite3_value_text(argv[1]);
1835 
1836 #ifndef SQLITE_OMIT_AUTHORIZATION
1837   sqlite3_xauth xAuth = db->xAuth;
1838   db->xAuth = 0;
1839 #endif
1840 
1841   sqlite3BtreeEnterAll(db);
1842 
1843   UNUSED_PARAMETER(NotUsed);
1844   if( zDb && zInput ){
1845     int rc;
1846     Parse sParse;
1847     rc = renameParseSql(&sParse, zDb, db, zInput, 0);
1848 
1849     if( rc==SQLITE_OK ){
1850       RenameCtx sCtx;
1851       Walker sWalker;
1852 
1853       /* Walker to find tokens that need to be replaced. */
1854       memset(&sCtx, 0, sizeof(RenameCtx));
1855       memset(&sWalker, 0, sizeof(Walker));
1856       sWalker.pParse = &sParse;
1857       sWalker.xExprCallback = renameQuotefixExprCb;
1858       sWalker.xSelectCallback = renameColumnSelectCb;
1859       sWalker.u.pRename = &sCtx;
1860 
1861       if( sParse.pNewTable ){
1862         if( IsView(sParse.pNewTable) ){
1863           Select *pSelect = sParse.pNewTable->u.view.pSelect;
1864           pSelect->selFlags &= ~SF_View;
1865           sParse.rc = SQLITE_OK;
1866           sqlite3SelectPrep(&sParse, pSelect, 0);
1867           rc = (db->mallocFailed ? SQLITE_NOMEM : sParse.rc);
1868           if( rc==SQLITE_OK ){
1869             sqlite3WalkSelect(&sWalker, pSelect);
1870           }
1871         }else{
1872           int i;
1873           sqlite3WalkExprList(&sWalker, sParse.pNewTable->pCheck);
1874 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1875           for(i=0; i<sParse.pNewTable->nCol; i++){
1876             sqlite3WalkExpr(&sWalker,
1877                sqlite3ColumnExpr(sParse.pNewTable,
1878                                          &sParse.pNewTable->aCol[i]));
1879           }
1880 #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1881         }
1882       }else if( sParse.pNewIndex ){
1883         sqlite3WalkExprList(&sWalker, sParse.pNewIndex->aColExpr);
1884         sqlite3WalkExpr(&sWalker, sParse.pNewIndex->pPartIdxWhere);
1885       }else{
1886 #ifndef SQLITE_OMIT_TRIGGER
1887         rc = renameResolveTrigger(&sParse);
1888         if( rc==SQLITE_OK ){
1889           renameWalkTrigger(&sWalker, sParse.pNewTrigger);
1890         }
1891 #endif /* SQLITE_OMIT_TRIGGER */
1892       }
1893 
1894       if( rc==SQLITE_OK ){
1895         rc = renameEditSql(context, &sCtx, zInput, 0, 0);
1896       }
1897       renameTokenFree(db, sCtx.pList);
1898     }
1899     if( rc!=SQLITE_OK ){
1900       sqlite3_result_error_code(context, rc);
1901     }
1902     renameParseCleanup(&sParse);
1903   }
1904 
1905 #ifndef SQLITE_OMIT_AUTHORIZATION
1906   db->xAuth = xAuth;
1907 #endif
1908 
1909   sqlite3BtreeLeaveAll(db);
1910 }
1911 
1912 /*
1913 ** An SQL user function that checks that there are no parse or symbol
1914 ** resolution problems in a CREATE TRIGGER|TABLE|VIEW|INDEX statement.
1915 ** After an ALTER TABLE .. RENAME operation is performed and the schema
1916 ** reloaded, this function is called on each SQL statement in the schema
1917 ** to ensure that it is still usable.
1918 **
1919 **   0: Database name ("main", "temp" etc.).
1920 **   1: SQL statement.
1921 **   2: Object type ("view", "table", "trigger" or "index").
1922 **   3: Object name.
1923 **   4: True if object is from temp schema.
1924 **   5: "when" part of error message.
1925 **   6: True to disable the DQS quirk when parsing SQL.
1926 **
1927 ** Unless it finds an error, this function normally returns NULL. However, it
1928 ** returns integer value 1 if:
1929 **
1930 **   * the SQL argument creates a trigger, and
1931 **   * the table that the trigger is attached to is in database zDb.
1932 */
1933 static void renameTableTest(
1934   sqlite3_context *context,
1935   int NotUsed,
1936   sqlite3_value **argv
1937 ){
1938   sqlite3 *db = sqlite3_context_db_handle(context);
1939   char const *zDb = (const char*)sqlite3_value_text(argv[0]);
1940   char const *zInput = (const char*)sqlite3_value_text(argv[1]);
1941   int bTemp = sqlite3_value_int(argv[4]);
1942   int isLegacy = (db->flags & SQLITE_LegacyAlter);
1943   char const *zWhen = (const char*)sqlite3_value_text(argv[5]);
1944   int bNoDQS = sqlite3_value_int(argv[6]);
1945 
1946 #ifndef SQLITE_OMIT_AUTHORIZATION
1947   sqlite3_xauth xAuth = db->xAuth;
1948   db->xAuth = 0;
1949 #endif
1950 
1951   UNUSED_PARAMETER(NotUsed);
1952 
1953   if( zDb && zInput ){
1954     int rc;
1955     Parse sParse;
1956     int flags = db->flags;
1957     if( bNoDQS ) db->flags &= ~(SQLITE_DqsDML|SQLITE_DqsDDL);
1958     rc = renameParseSql(&sParse, zDb, db, zInput, bTemp);
1959     db->flags |= (flags & (SQLITE_DqsDML|SQLITE_DqsDDL));
1960     if( rc==SQLITE_OK ){
1961       if( isLegacy==0 && sParse.pNewTable && IsView(sParse.pNewTable) ){
1962         NameContext sNC;
1963         memset(&sNC, 0, sizeof(sNC));
1964         sNC.pParse = &sParse;
1965         sqlite3SelectPrep(&sParse, sParse.pNewTable->u.view.pSelect, &sNC);
1966         if( sParse.nErr ) rc = sParse.rc;
1967       }
1968 
1969       else if( sParse.pNewTrigger ){
1970         if( isLegacy==0 ){
1971           rc = renameResolveTrigger(&sParse);
1972         }
1973         if( rc==SQLITE_OK ){
1974           int i1 = sqlite3SchemaToIndex(db, sParse.pNewTrigger->pTabSchema);
1975           int i2 = sqlite3FindDbName(db, zDb);
1976           if( i1==i2 ) sqlite3_result_int(context, 1);
1977         }
1978       }
1979     }
1980 
1981     if( rc!=SQLITE_OK && zWhen ){
1982       renameColumnParseError(context, zWhen, argv[2], argv[3],&sParse);
1983     }
1984     renameParseCleanup(&sParse);
1985   }
1986 
1987 #ifndef SQLITE_OMIT_AUTHORIZATION
1988   db->xAuth = xAuth;
1989 #endif
1990 }
1991 
1992 /*
1993 ** The implementation of internal UDF sqlite_drop_column().
1994 **
1995 ** Arguments:
1996 **
1997 **  argv[0]: An integer - the index of the schema containing the table
1998 **  argv[1]: CREATE TABLE statement to modify.
1999 **  argv[2]: An integer - the index of the column to remove.
2000 **
2001 ** The value returned is a string containing the CREATE TABLE statement
2002 ** with column argv[2] removed.
2003 */
2004 static void dropColumnFunc(
2005   sqlite3_context *context,
2006   int NotUsed,
2007   sqlite3_value **argv
2008 ){
2009   sqlite3 *db = sqlite3_context_db_handle(context);
2010   int iSchema = sqlite3_value_int(argv[0]);
2011   const char *zSql = (const char*)sqlite3_value_text(argv[1]);
2012   int iCol = sqlite3_value_int(argv[2]);
2013   const char *zDb = db->aDb[iSchema].zDbSName;
2014   int rc;
2015   Parse sParse;
2016   RenameToken *pCol;
2017   Table *pTab;
2018   const char *zEnd;
2019   char *zNew = 0;
2020 
2021 #ifndef SQLITE_OMIT_AUTHORIZATION
2022   sqlite3_xauth xAuth = db->xAuth;
2023   db->xAuth = 0;
2024 #endif
2025 
2026   UNUSED_PARAMETER(NotUsed);
2027   rc = renameParseSql(&sParse, zDb, db, zSql, iSchema==1);
2028   if( rc!=SQLITE_OK ) goto drop_column_done;
2029   pTab = sParse.pNewTable;
2030   if( pTab==0 || pTab->nCol==1 || iCol>=pTab->nCol ){
2031     /* This can happen if the sqlite_schema table is corrupt */
2032     rc = SQLITE_CORRUPT_BKPT;
2033     goto drop_column_done;
2034   }
2035 
2036   pCol = renameTokenFind(&sParse, 0, (void*)pTab->aCol[iCol].zCnName);
2037   if( iCol<pTab->nCol-1 ){
2038     RenameToken *pEnd;
2039     pEnd = renameTokenFind(&sParse, 0, (void*)pTab->aCol[iCol+1].zCnName);
2040     zEnd = (const char*)pEnd->t.z;
2041   }else{
2042     assert( !IsVirtual(pTab) );
2043     zEnd = (const char*)&zSql[pTab->u.tab.addColOffset];
2044     while( ALWAYS(pCol->t.z[0]!=0) && pCol->t.z[0]!=',' ) pCol->t.z--;
2045   }
2046 
2047   zNew = sqlite3MPrintf(db, "%.*s%s", pCol->t.z-zSql, zSql, zEnd);
2048   sqlite3_result_text(context, zNew, -1, SQLITE_TRANSIENT);
2049   sqlite3_free(zNew);
2050 
2051 drop_column_done:
2052   renameParseCleanup(&sParse);
2053 #ifndef SQLITE_OMIT_AUTHORIZATION
2054   db->xAuth = xAuth;
2055 #endif
2056   if( rc!=SQLITE_OK ){
2057     sqlite3_result_error_code(context, rc);
2058   }
2059 }
2060 
2061 /*
2062 ** This function is called by the parser upon parsing an
2063 **
2064 **     ALTER TABLE pSrc DROP COLUMN pName
2065 **
2066 ** statement. Argument pSrc contains the possibly qualified name of the
2067 ** table being edited, and token pName the name of the column to drop.
2068 */
2069 void sqlite3AlterDropColumn(Parse *pParse, SrcList *pSrc, Token *pName){
2070   sqlite3 *db = pParse->db;       /* Database handle */
2071   Table *pTab;                    /* Table to modify */
2072   int iDb;                        /* Index of db containing pTab in aDb[] */
2073   const char *zDb;                /* Database containing pTab ("main" etc.) */
2074   char *zCol = 0;                 /* Name of column to drop */
2075   int iCol;                       /* Index of column zCol in pTab->aCol[] */
2076 
2077   /* Look up the table being altered. */
2078   assert( pParse->pNewTable==0 );
2079   assert( sqlite3BtreeHoldsAllMutexes(db) );
2080   if( NEVER(db->mallocFailed) ) goto exit_drop_column;
2081   pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
2082   if( !pTab ) goto exit_drop_column;
2083 
2084   /* Make sure this is not an attempt to ALTER a view, virtual table or
2085   ** system table. */
2086   if( SQLITE_OK!=isAlterableTable(pParse, pTab) ) goto exit_drop_column;
2087   if( SQLITE_OK!=isRealTable(pParse, pTab, 1) ) goto exit_drop_column;
2088 
2089   /* Find the index of the column being dropped. */
2090   zCol = sqlite3NameFromToken(db, pName);
2091   if( zCol==0 ){
2092     assert( db->mallocFailed );
2093     goto exit_drop_column;
2094   }
2095   iCol = sqlite3ColumnIndex(pTab, zCol);
2096   if( iCol<0 ){
2097     sqlite3ErrorMsg(pParse, "no such column: \"%s\"", zCol);
2098     goto exit_drop_column;
2099   }
2100 
2101   /* Do not allow the user to drop a PRIMARY KEY column or a column
2102   ** constrained by a UNIQUE constraint.  */
2103   if( pTab->aCol[iCol].colFlags & (COLFLAG_PRIMKEY|COLFLAG_UNIQUE) ){
2104     sqlite3ErrorMsg(pParse, "cannot drop %s column: \"%s\"",
2105         (pTab->aCol[iCol].colFlags&COLFLAG_PRIMKEY) ? "PRIMARY KEY" : "UNIQUE",
2106         zCol
2107     );
2108     goto exit_drop_column;
2109   }
2110 
2111   /* Do not allow the number of columns to go to zero */
2112   if( pTab->nCol<=1 ){
2113     sqlite3ErrorMsg(pParse, "cannot drop column \"%s\": no other columns exist",zCol);
2114     goto exit_drop_column;
2115   }
2116 
2117   /* Edit the sqlite_schema table */
2118   iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2119   assert( iDb>=0 );
2120   zDb = db->aDb[iDb].zDbSName;
2121   renameTestSchema(pParse, zDb, iDb==1, "", 0);
2122   renameFixQuotes(pParse, zDb, iDb==1);
2123   sqlite3NestedParse(pParse,
2124       "UPDATE \"%w\"." DFLT_SCHEMA_TABLE " SET "
2125       "sql = sqlite_drop_column(%d, sql, %d) "
2126       "WHERE (type=='table' AND tbl_name=%Q COLLATE nocase)"
2127       , zDb, iDb, iCol, pTab->zName
2128   );
2129 
2130   /* Drop and reload the database schema. */
2131   renameReloadSchema(pParse, iDb, INITFLAG_AlterDrop);
2132   renameTestSchema(pParse, zDb, iDb==1, "after drop column", 1);
2133 
2134   /* Edit rows of table on disk */
2135   if( pParse->nErr==0 && (pTab->aCol[iCol].colFlags & COLFLAG_VIRTUAL)==0 ){
2136     int i;
2137     int addr;
2138     int reg;
2139     int regRec;
2140     Index *pPk = 0;
2141     int nField = 0;               /* Number of non-virtual columns after drop */
2142     int iCur;
2143     Vdbe *v = sqlite3GetVdbe(pParse);
2144     iCur = pParse->nTab++;
2145     sqlite3OpenTable(pParse, iCur, iDb, pTab, OP_OpenWrite);
2146     addr = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
2147     reg = ++pParse->nMem;
2148     if( HasRowid(pTab) ){
2149       sqlite3VdbeAddOp2(v, OP_Rowid, iCur, reg);
2150       pParse->nMem += pTab->nCol;
2151     }else{
2152       pPk = sqlite3PrimaryKeyIndex(pTab);
2153       pParse->nMem += pPk->nColumn;
2154       for(i=0; i<pPk->nKeyCol; i++){
2155         sqlite3VdbeAddOp3(v, OP_Column, iCur, i, reg+i+1);
2156       }
2157       nField = pPk->nKeyCol;
2158     }
2159     regRec = ++pParse->nMem;
2160     for(i=0; i<pTab->nCol; i++){
2161       if( i!=iCol && (pTab->aCol[i].colFlags & COLFLAG_VIRTUAL)==0 ){
2162         int regOut;
2163         if( pPk ){
2164           int iPos = sqlite3TableColumnToIndex(pPk, i);
2165           int iColPos = sqlite3TableColumnToIndex(pPk, iCol);
2166           if( iPos<pPk->nKeyCol ) continue;
2167           regOut = reg+1+iPos-(iPos>iColPos);
2168         }else{
2169           regOut = reg+1+nField;
2170         }
2171         if( i==pTab->iPKey ){
2172           sqlite3VdbeAddOp2(v, OP_Null, 0, regOut);
2173         }else{
2174           sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, i, regOut);
2175         }
2176         nField++;
2177       }
2178     }
2179     if( nField==0 ){
2180       /* dbsqlfuzz 5f09e7bcc78b4954d06bf9f2400d7715f48d1fef */
2181       pParse->nMem++;
2182       sqlite3VdbeAddOp2(v, OP_Null, 0, reg+1);
2183       nField = 1;
2184     }
2185     sqlite3VdbeAddOp3(v, OP_MakeRecord, reg+1, nField, regRec);
2186     if( pPk ){
2187       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iCur, regRec, reg+1, pPk->nKeyCol);
2188     }else{
2189       sqlite3VdbeAddOp3(v, OP_Insert, iCur, regRec, reg);
2190     }
2191     sqlite3VdbeChangeP5(v, OPFLAG_SAVEPOSITION);
2192 
2193     sqlite3VdbeAddOp2(v, OP_Next, iCur, addr+1); VdbeCoverage(v);
2194     sqlite3VdbeJumpHere(v, addr);
2195   }
2196 
2197 exit_drop_column:
2198   sqlite3DbFree(db, zCol);
2199   sqlite3SrcListDelete(db, pSrc);
2200 }
2201 
2202 /*
2203 ** Register built-in functions used to help implement ALTER TABLE
2204 */
2205 void sqlite3AlterFunctions(void){
2206   static FuncDef aAlterTableFuncs[] = {
2207     INTERNAL_FUNCTION(sqlite_rename_column,  9, renameColumnFunc),
2208     INTERNAL_FUNCTION(sqlite_rename_table,   7, renameTableFunc),
2209     INTERNAL_FUNCTION(sqlite_rename_test,    7, renameTableTest),
2210     INTERNAL_FUNCTION(sqlite_drop_column,    3, dropColumnFunc),
2211     INTERNAL_FUNCTION(sqlite_rename_quotefix,2, renameQuotefixFunc),
2212   };
2213   sqlite3InsertBuiltinFuncs(aAlterTableFuncs, ArraySize(aAlterTableFuncs));
2214 }
2215 #endif  /* SQLITE_ALTER_TABLE */
2216