xref: /sqlite-3.40.0/src/alter.c (revision 7a420e22)
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 /*
25 ** This function is used by SQL generated to implement the
26 ** ALTER TABLE command. The first argument is the text of a CREATE TABLE or
27 ** CREATE INDEX command. The second is a table name. The table name in
28 ** the CREATE TABLE or CREATE INDEX statement is replaced with the third
29 ** argument and the result returned. Examples:
30 **
31 ** sqlite_rename_table('CREATE TABLE abc(a, b, c)', 'def')
32 **     -> 'CREATE TABLE def(a, b, c)'
33 **
34 ** sqlite_rename_table('CREATE INDEX i ON abc(a)', 'def')
35 **     -> 'CREATE INDEX i ON def(a, b, c)'
36 */
37 static void renameTableFunc(
38   sqlite3_context *context,
39   int NotUsed,
40   sqlite3_value **argv
41 ){
42   unsigned char const *zSql = sqlite3_value_text(argv[0]);
43   unsigned char const *zTableName = sqlite3_value_text(argv[1]);
44 
45   int token;
46   Token tname;
47   unsigned char const *zCsr = zSql;
48   int len = 0;
49   char *zRet;
50 
51   sqlite3 *db = sqlite3_context_db_handle(context);
52 
53   UNUSED_PARAMETER(NotUsed);
54 
55   /* The principle used to locate the table name in the CREATE TABLE
56   ** statement is that the table name is the first non-space token that
57   ** is immediately followed by a TK_LP or TK_USING token.
58   */
59   if( zSql ){
60     do {
61       if( !*zCsr ){
62         /* Ran out of input before finding an opening bracket. Return NULL. */
63         return;
64       }
65 
66       /* Store the token that zCsr points to in tname. */
67       tname.z = (char*)zCsr;
68       tname.n = len;
69 
70       /* Advance zCsr to the next token. Store that token type in 'token',
71       ** and its length in 'len' (to be used next iteration of this loop).
72       */
73       do {
74         zCsr += len;
75         len = sqlite3GetToken(zCsr, &token);
76       } while( token==TK_SPACE );
77       assert( len>0 );
78     } while( token!=TK_LP && token!=TK_USING );
79 
80     zRet = sqlite3MPrintf(db, "%.*s\"%w\"%s", ((u8*)tname.z) - zSql, zSql,
81        zTableName, tname.z+tname.n);
82     sqlite3_result_text(context, zRet, -1, SQLITE_DYNAMIC);
83   }
84 }
85 
86 /*
87 ** This C function implements an SQL user function that is used by SQL code
88 ** generated by the ALTER TABLE ... RENAME command to modify the definition
89 ** of any foreign key constraints that use the table being renamed as the
90 ** parent table. It is passed three arguments:
91 **
92 **   1) The complete text of the CREATE TABLE statement being modified,
93 **   2) The old name of the table being renamed, and
94 **   3) The new name of the table being renamed.
95 **
96 ** It returns the new CREATE TABLE statement. For example:
97 **
98 **   sqlite_rename_parent('CREATE TABLE t1(a REFERENCES t2)', 't2', 't3')
99 **       -> 'CREATE TABLE t1(a REFERENCES t3)'
100 */
101 #ifndef SQLITE_OMIT_FOREIGN_KEY
102 static void renameParentFunc(
103   sqlite3_context *context,
104   int NotUsed,
105   sqlite3_value **argv
106 ){
107   sqlite3 *db = sqlite3_context_db_handle(context);
108   char *zOutput = 0;
109   char *zResult;
110   unsigned char const *zInput = sqlite3_value_text(argv[0]);
111   unsigned char const *zOld = sqlite3_value_text(argv[1]);
112   unsigned char const *zNew = sqlite3_value_text(argv[2]);
113 
114   unsigned const char *z;         /* Pointer to token */
115   int n;                          /* Length of token z */
116   int token;                      /* Type of token */
117 
118   UNUSED_PARAMETER(NotUsed);
119   for(z=zInput; *z; z=z+n){
120     n = sqlite3GetToken(z, &token);
121     if( token==TK_REFERENCES ){
122       char *zParent;
123       do {
124         z += n;
125         n = sqlite3GetToken(z, &token);
126       }while( token==TK_SPACE );
127 
128       zParent = sqlite3DbStrNDup(db, (const char *)z, n);
129       if( zParent==0 ) break;
130       sqlite3Dequote(zParent);
131       if( 0==sqlite3StrICmp((const char *)zOld, zParent) ){
132         char *zOut = sqlite3MPrintf(db, "%s%.*s\"%w\"",
133             (zOutput?zOutput:""), z-zInput, zInput, (const char *)zNew
134         );
135         sqlite3DbFree(db, zOutput);
136         zOutput = zOut;
137         zInput = &z[n];
138       }
139       sqlite3DbFree(db, zParent);
140     }
141   }
142 
143   zResult = sqlite3MPrintf(db, "%s%s", (zOutput?zOutput:""), zInput),
144   sqlite3_result_text(context, zResult, -1, SQLITE_DYNAMIC);
145   sqlite3DbFree(db, zOutput);
146 }
147 #endif
148 
149 #ifndef SQLITE_OMIT_TRIGGER
150 /* This function is used by SQL generated to implement the
151 ** ALTER TABLE command. The first argument is the text of a CREATE TRIGGER
152 ** statement. The second is a table name. The table name in the CREATE
153 ** TRIGGER statement is replaced with the third argument and the result
154 ** returned. This is analagous to renameTableFunc() above, except for CREATE
155 ** TRIGGER, not CREATE INDEX and CREATE TABLE.
156 */
157 static void renameTriggerFunc(
158   sqlite3_context *context,
159   int NotUsed,
160   sqlite3_value **argv
161 ){
162   unsigned char const *zSql = sqlite3_value_text(argv[0]);
163   unsigned char const *zTableName = sqlite3_value_text(argv[1]);
164 
165   int token;
166   Token tname;
167   int dist = 3;
168   unsigned char const *zCsr = zSql;
169   int len = 0;
170   char *zRet;
171   sqlite3 *db = sqlite3_context_db_handle(context);
172 
173   UNUSED_PARAMETER(NotUsed);
174 
175   /* The principle used to locate the table name in the CREATE TRIGGER
176   ** statement is that the table name is the first token that is immediatedly
177   ** preceded by either TK_ON or TK_DOT and immediatedly followed by one
178   ** of TK_WHEN, TK_BEGIN or TK_FOR.
179   */
180   if( zSql ){
181     do {
182 
183       if( !*zCsr ){
184         /* Ran out of input before finding the table name. Return NULL. */
185         return;
186       }
187 
188       /* Store the token that zCsr points to in tname. */
189       tname.z = (char*)zCsr;
190       tname.n = len;
191 
192       /* Advance zCsr to the next token. Store that token type in 'token',
193       ** and its length in 'len' (to be used next iteration of this loop).
194       */
195       do {
196         zCsr += len;
197         len = sqlite3GetToken(zCsr, &token);
198       }while( token==TK_SPACE );
199       assert( len>0 );
200 
201       /* Variable 'dist' stores the number of tokens read since the most
202       ** recent TK_DOT or TK_ON. This means that when a WHEN, FOR or BEGIN
203       ** token is read and 'dist' equals 2, the condition stated above
204       ** to be met.
205       **
206       ** Note that ON cannot be a database, table or column name, so
207       ** there is no need to worry about syntax like
208       ** "CREATE TRIGGER ... ON ON.ON BEGIN ..." etc.
209       */
210       dist++;
211       if( token==TK_DOT || token==TK_ON ){
212         dist = 0;
213       }
214     } while( dist!=2 || (token!=TK_WHEN && token!=TK_FOR && token!=TK_BEGIN) );
215 
216     /* Variable tname now contains the token that is the old table-name
217     ** in the CREATE TRIGGER statement.
218     */
219     zRet = sqlite3MPrintf(db, "%.*s\"%w\"%s", ((u8*)tname.z) - zSql, zSql,
220        zTableName, tname.z+tname.n);
221     sqlite3_result_text(context, zRet, -1, SQLITE_DYNAMIC);
222   }
223 }
224 #endif   /* !SQLITE_OMIT_TRIGGER */
225 
226 /*
227 ** Register built-in functions used to help implement ALTER TABLE
228 */
229 void sqlite3AlterFunctions(void){
230   static SQLITE_WSD FuncDef aAlterTableFuncs[] = {
231     FUNCTION(sqlite_rename_table,   2, 0, 0, renameTableFunc),
232 #ifndef SQLITE_OMIT_TRIGGER
233     FUNCTION(sqlite_rename_trigger, 2, 0, 0, renameTriggerFunc),
234 #endif
235 #ifndef SQLITE_OMIT_FOREIGN_KEY
236     FUNCTION(sqlite_rename_parent,  3, 0, 0, renameParentFunc),
237 #endif
238   };
239   int i;
240   FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
241   FuncDef *aFunc = (FuncDef*)&GLOBAL(FuncDef, aAlterTableFuncs);
242 
243   for(i=0; i<ArraySize(aAlterTableFuncs); i++){
244     sqlite3FuncDefInsert(pHash, &aFunc[i]);
245   }
246 }
247 
248 /*
249 ** This function is used to create the text of expressions of the form:
250 **
251 **   name=<constant1> OR name=<constant2> OR ...
252 **
253 ** If argument zWhere is NULL, then a pointer string containing the text
254 ** "name=<constant>" is returned, where <constant> is the quoted version
255 ** of the string passed as argument zConstant. The returned buffer is
256 ** allocated using sqlite3DbMalloc(). It is the responsibility of the
257 ** caller to ensure that it is eventually freed.
258 **
259 ** If argument zWhere is not NULL, then the string returned is
260 ** "<where> OR name=<constant>", where <where> is the contents of zWhere.
261 ** In this case zWhere is passed to sqlite3DbFree() before returning.
262 **
263 */
264 static char *whereOrName(sqlite3 *db, char *zWhere, char *zConstant){
265   char *zNew;
266   if( !zWhere ){
267     zNew = sqlite3MPrintf(db, "name=%Q", zConstant);
268   }else{
269     zNew = sqlite3MPrintf(db, "%s OR name=%Q", zWhere, zConstant);
270     sqlite3DbFree(db, zWhere);
271   }
272   return zNew;
273 }
274 
275 #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
276 /*
277 ** Generate the text of a WHERE expression which can be used to select all
278 ** tables that have foreign key constraints that refer to table pTab (i.e.
279 ** constraints for which pTab is the parent table) from the sqlite_master
280 ** table.
281 */
282 static char *whereForeignKeys(Parse *pParse, Table *pTab){
283   FKey *p;
284   char *zWhere = 0;
285   for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
286     zWhere = whereOrName(pParse->db, zWhere, p->pFrom->zName);
287   }
288   return zWhere;
289 }
290 #endif
291 
292 /*
293 ** Generate the text of a WHERE expression which can be used to select all
294 ** temporary triggers on table pTab from the sqlite_temp_master table. If
295 ** table pTab has no temporary triggers, or is itself stored in the
296 ** temporary database, NULL is returned.
297 */
298 static char *whereTempTriggers(Parse *pParse, Table *pTab){
299   Trigger *pTrig;
300   char *zWhere = 0;
301   const Schema *pTempSchema = pParse->db->aDb[1].pSchema; /* Temp db schema */
302 
303   /* If the table is not located in the temp-db (in which case NULL is
304   ** returned, loop through the tables list of triggers. For each trigger
305   ** that is not part of the temp-db schema, add a clause to the WHERE
306   ** expression being built up in zWhere.
307   */
308   if( pTab->pSchema!=pTempSchema ){
309     sqlite3 *db = pParse->db;
310     for(pTrig=sqlite3TriggerList(pParse, pTab); pTrig; pTrig=pTrig->pNext){
311       if( pTrig->pSchema==pTempSchema ){
312         zWhere = whereOrName(db, zWhere, pTrig->zName);
313       }
314     }
315   }
316   if( zWhere ){
317     char *zNew = sqlite3MPrintf(pParse->db, "type='trigger' AND (%s)", zWhere);
318     sqlite3DbFree(pParse->db, zWhere);
319     zWhere = zNew;
320   }
321   return zWhere;
322 }
323 
324 /*
325 ** Generate code to drop and reload the internal representation of table
326 ** pTab from the database, including triggers and temporary triggers.
327 ** Argument zName is the name of the table in the database schema at
328 ** the time the generated code is executed. This can be different from
329 ** pTab->zName if this function is being called to code part of an
330 ** "ALTER TABLE RENAME TO" statement.
331 */
332 static void reloadTableSchema(Parse *pParse, Table *pTab, const char *zName){
333   Vdbe *v;
334   char *zWhere;
335   int iDb;                   /* Index of database containing pTab */
336 #ifndef SQLITE_OMIT_TRIGGER
337   Trigger *pTrig;
338 #endif
339 
340   v = sqlite3GetVdbe(pParse);
341   if( NEVER(v==0) ) return;
342   assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
343   iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
344   assert( iDb>=0 );
345 
346 #ifndef SQLITE_OMIT_TRIGGER
347   /* Drop any table triggers from the internal schema. */
348   for(pTrig=sqlite3TriggerList(pParse, pTab); pTrig; pTrig=pTrig->pNext){
349     int iTrigDb = sqlite3SchemaToIndex(pParse->db, pTrig->pSchema);
350     assert( iTrigDb==iDb || iTrigDb==1 );
351     sqlite3VdbeAddOp4(v, OP_DropTrigger, iTrigDb, 0, 0, pTrig->zName, 0);
352   }
353 #endif
354 
355   /* Drop the table and index from the internal schema.  */
356   sqlite3VdbeAddOp4(v, OP_DropTable, iDb, 0, 0, pTab->zName, 0);
357 
358   /* Reload the table, index and permanent trigger schemas. */
359   zWhere = sqlite3MPrintf(pParse->db, "tbl_name=%Q", zName);
360   if( !zWhere ) return;
361   sqlite3VdbeAddOp4(v, OP_ParseSchema, iDb, 0, 0, zWhere, P4_DYNAMIC);
362 
363 #ifndef SQLITE_OMIT_TRIGGER
364   /* Now, if the table is not stored in the temp database, reload any temp
365   ** triggers. Don't use IN(...) in case SQLITE_OMIT_SUBQUERY is defined.
366   */
367   if( (zWhere=whereTempTriggers(pParse, pTab))!=0 ){
368     sqlite3VdbeAddOp4(v, OP_ParseSchema, 1, 0, 0, zWhere, P4_DYNAMIC);
369   }
370 #endif
371 }
372 
373 /*
374 ** Generate code to implement the "ALTER TABLE xxx RENAME TO yyy"
375 ** command.
376 */
377 void sqlite3AlterRenameTable(
378   Parse *pParse,            /* Parser context. */
379   SrcList *pSrc,            /* The table to rename. */
380   Token *pName              /* The new table name. */
381 ){
382   int iDb;                  /* Database that contains the table */
383   char *zDb;                /* Name of database iDb */
384   Table *pTab;              /* Table being renamed */
385   char *zName = 0;          /* NULL-terminated version of pName */
386   sqlite3 *db = pParse->db; /* Database connection */
387   int nTabName;             /* Number of UTF-8 characters in zTabName */
388   const char *zTabName;     /* Original name of the table */
389   Vdbe *v;
390 #ifndef SQLITE_OMIT_TRIGGER
391   char *zWhere = 0;         /* Where clause to locate temp triggers */
392 #endif
393   VTable *pVTab = 0;        /* Non-zero if this is a v-tab with an xRename() */
394   int savedDbFlags;         /* Saved value of db->flags */
395 
396   savedDbFlags = db->flags;
397   if( NEVER(db->mallocFailed) ) goto exit_rename_table;
398   assert( pSrc->nSrc==1 );
399   assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
400 
401   pTab = sqlite3LocateTable(pParse, 0, pSrc->a[0].zName, pSrc->a[0].zDatabase);
402   if( !pTab ) goto exit_rename_table;
403   iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
404   zDb = db->aDb[iDb].zName;
405   db->flags |= SQLITE_PreferBuiltin;
406 
407   /* Get a NULL terminated version of the new table name. */
408   zName = sqlite3NameFromToken(db, pName);
409   if( !zName ) goto exit_rename_table;
410 
411   /* Check that a table or index named 'zName' does not already exist
412   ** in database iDb. If so, this is an error.
413   */
414   if( sqlite3FindTable(db, zName, zDb) || sqlite3FindIndex(db, zName, zDb) ){
415     sqlite3ErrorMsg(pParse,
416         "there is already another table or index with this name: %s", zName);
417     goto exit_rename_table;
418   }
419 
420   /* Make sure it is not a system table being altered, or a reserved name
421   ** that the table is being renamed to.
422   */
423   if( sqlite3Strlen30(pTab->zName)>6
424    && 0==sqlite3StrNICmp(pTab->zName, "sqlite_", 7)
425   ){
426     sqlite3ErrorMsg(pParse, "table %s may not be altered", pTab->zName);
427     goto exit_rename_table;
428   }
429   if( SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){
430     goto exit_rename_table;
431   }
432 
433 #ifndef SQLITE_OMIT_VIEW
434   if( pTab->pSelect ){
435     sqlite3ErrorMsg(pParse, "view %s may not be altered", pTab->zName);
436     goto exit_rename_table;
437   }
438 #endif
439 
440 #ifndef SQLITE_OMIT_AUTHORIZATION
441   /* Invoke the authorization callback. */
442   if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
443     goto exit_rename_table;
444   }
445 #endif
446 
447 #ifndef SQLITE_OMIT_VIRTUALTABLE
448   if( sqlite3ViewGetColumnNames(pParse, pTab) ){
449     goto exit_rename_table;
450   }
451   if( IsVirtual(pTab) ){
452     pVTab = sqlite3GetVTable(db, pTab);
453     if( pVTab->pVtab->pModule->xRename==0 ){
454       pVTab = 0;
455     }
456   }
457 #endif
458 
459   /* Begin a transaction and code the VerifyCookie for database iDb.
460   ** Then modify the schema cookie (since the ALTER TABLE modifies the
461   ** schema). Open a statement transaction if the table is a virtual
462   ** table.
463   */
464   v = sqlite3GetVdbe(pParse);
465   if( v==0 ){
466     goto exit_rename_table;
467   }
468   sqlite3BeginWriteOperation(pParse, pVTab!=0, iDb);
469   sqlite3ChangeCookie(pParse, iDb);
470 
471   /* If this is a virtual table, invoke the xRename() function if
472   ** one is defined. The xRename() callback will modify the names
473   ** of any resources used by the v-table implementation (including other
474   ** SQLite tables) that are identified by the name of the virtual table.
475   */
476 #ifndef SQLITE_OMIT_VIRTUALTABLE
477   if( pVTab ){
478     int i = ++pParse->nMem;
479     sqlite3VdbeAddOp4(v, OP_String8, 0, i, 0, zName, 0);
480     sqlite3VdbeAddOp4(v, OP_VRename, i, 0, 0,(const char*)pVTab, P4_VTAB);
481     sqlite3MayAbort(pParse);
482   }
483 #endif
484 
485   /* figure out how many UTF-8 characters are in zName */
486   zTabName = pTab->zName;
487   nTabName = sqlite3Utf8CharLen(zTabName, -1);
488 
489 #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
490   if( db->flags&SQLITE_ForeignKeys ){
491     /* If foreign-key support is enabled, rewrite the CREATE TABLE
492     ** statements corresponding to all child tables of foreign key constraints
493     ** for which the renamed table is the parent table.  */
494     if( (zWhere=whereForeignKeys(pParse, pTab))!=0 ){
495       sqlite3NestedParse(pParse,
496           "UPDATE \"%w\".%s SET "
497               "sql = sqlite_rename_parent(sql, %Q, %Q) "
498               "WHERE %s;", zDb, SCHEMA_TABLE(iDb), zTabName, zName, zWhere);
499       sqlite3DbFree(db, zWhere);
500     }
501   }
502 #endif
503 
504   /* Modify the sqlite_master table to use the new table name. */
505   sqlite3NestedParse(pParse,
506       "UPDATE %Q.%s SET "
507 #ifdef SQLITE_OMIT_TRIGGER
508           "sql = sqlite_rename_table(sql, %Q), "
509 #else
510           "sql = CASE "
511             "WHEN type = 'trigger' THEN sqlite_rename_trigger(sql, %Q)"
512             "ELSE sqlite_rename_table(sql, %Q) END, "
513 #endif
514           "tbl_name = %Q, "
515           "name = CASE "
516             "WHEN type='table' THEN %Q "
517             "WHEN name LIKE 'sqlite_autoindex%%' AND type='index' THEN "
518              "'sqlite_autoindex_' || %Q || substr(name,%d+18) "
519             "ELSE name END "
520       "WHERE tbl_name=%Q AND "
521           "(type='table' OR type='index' OR type='trigger');",
522       zDb, SCHEMA_TABLE(iDb), zName, zName, zName,
523 #ifndef SQLITE_OMIT_TRIGGER
524       zName,
525 #endif
526       zName, nTabName, zTabName
527   );
528 
529 #ifndef SQLITE_OMIT_AUTOINCREMENT
530   /* If the sqlite_sequence table exists in this database, then update
531   ** it with the new table name.
532   */
533   if( sqlite3FindTable(db, "sqlite_sequence", zDb) ){
534     sqlite3NestedParse(pParse,
535         "UPDATE \"%w\".sqlite_sequence set name = %Q WHERE name = %Q",
536         zDb, zName, pTab->zName);
537   }
538 #endif
539 
540 #ifndef SQLITE_OMIT_TRIGGER
541   /* If there are TEMP triggers on this table, modify the sqlite_temp_master
542   ** table. Don't do this if the table being ALTERed is itself located in
543   ** the temp database.
544   */
545   if( (zWhere=whereTempTriggers(pParse, pTab))!=0 ){
546     sqlite3NestedParse(pParse,
547         "UPDATE sqlite_temp_master SET "
548             "sql = sqlite_rename_trigger(sql, %Q), "
549             "tbl_name = %Q "
550             "WHERE %s;", zName, zName, zWhere);
551     sqlite3DbFree(db, zWhere);
552   }
553 #endif
554 
555 #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
556   if( db->flags&SQLITE_ForeignKeys ){
557     FKey *p;
558     for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
559       Table *pFrom = p->pFrom;
560       if( pFrom!=pTab ){
561         reloadTableSchema(pParse, p->pFrom, pFrom->zName);
562       }
563     }
564   }
565 #endif
566 
567   /* Drop and reload the internal table schema. */
568   reloadTableSchema(pParse, pTab, zName);
569 
570 exit_rename_table:
571   sqlite3SrcListDelete(db, pSrc);
572   sqlite3DbFree(db, zName);
573   db->flags = savedDbFlags;
574 }
575 
576 
577 /*
578 ** Generate code to make sure the file format number is at least minFormat.
579 ** The generated code will increase the file format number if necessary.
580 */
581 void sqlite3MinimumFileFormat(Parse *pParse, int iDb, int minFormat){
582   Vdbe *v;
583   v = sqlite3GetVdbe(pParse);
584   /* The VDBE should have been allocated before this routine is called.
585   ** If that allocation failed, we would have quit before reaching this
586   ** point */
587   if( ALWAYS(v) ){
588     int r1 = sqlite3GetTempReg(pParse);
589     int r2 = sqlite3GetTempReg(pParse);
590     int j1;
591     sqlite3VdbeAddOp3(v, OP_ReadCookie, iDb, r1, BTREE_FILE_FORMAT);
592     sqlite3VdbeUsesBtree(v, iDb);
593     sqlite3VdbeAddOp2(v, OP_Integer, minFormat, r2);
594     j1 = sqlite3VdbeAddOp3(v, OP_Ge, r2, 0, r1);
595     sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_FILE_FORMAT, r2);
596     sqlite3VdbeJumpHere(v, j1);
597     sqlite3ReleaseTempReg(pParse, r1);
598     sqlite3ReleaseTempReg(pParse, r2);
599   }
600 }
601 
602 /*
603 ** This function is called after an "ALTER TABLE ... ADD" statement
604 ** has been parsed. Argument pColDef contains the text of the new
605 ** column definition.
606 **
607 ** The Table structure pParse->pNewTable was extended to include
608 ** the new column during parsing.
609 */
610 void sqlite3AlterFinishAddColumn(Parse *pParse, Token *pColDef){
611   Table *pNew;              /* Copy of pParse->pNewTable */
612   Table *pTab;              /* Table being altered */
613   int iDb;                  /* Database number */
614   const char *zDb;          /* Database name */
615   const char *zTab;         /* Table name */
616   char *zCol;               /* Null-terminated column definition */
617   Column *pCol;             /* The new column */
618   Expr *pDflt;              /* Default value for the new column */
619   sqlite3 *db;              /* The database connection; */
620 
621   db = pParse->db;
622   if( pParse->nErr || db->mallocFailed ) return;
623   pNew = pParse->pNewTable;
624   assert( pNew );
625 
626   assert( sqlite3BtreeHoldsAllMutexes(db) );
627   iDb = sqlite3SchemaToIndex(db, pNew->pSchema);
628   zDb = db->aDb[iDb].zName;
629   zTab = &pNew->zName[16];  /* Skip the "sqlite_altertab_" prefix on the name */
630   pCol = &pNew->aCol[pNew->nCol-1];
631   pDflt = pCol->pDflt;
632   pTab = sqlite3FindTable(db, zTab, zDb);
633   assert( pTab );
634 
635 #ifndef SQLITE_OMIT_AUTHORIZATION
636   /* Invoke the authorization callback. */
637   if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
638     return;
639   }
640 #endif
641 
642   /* If the default value for the new column was specified with a
643   ** literal NULL, then set pDflt to 0. This simplifies checking
644   ** for an SQL NULL default below.
645   */
646   if( pDflt && pDflt->op==TK_NULL ){
647     pDflt = 0;
648   }
649 
650   /* Check that the new column is not specified as PRIMARY KEY or UNIQUE.
651   ** If there is a NOT NULL constraint, then the default value for the
652   ** column must not be NULL.
653   */
654   if( pCol->isPrimKey ){
655     sqlite3ErrorMsg(pParse, "Cannot add a PRIMARY KEY column");
656     return;
657   }
658   if( pNew->pIndex ){
659     sqlite3ErrorMsg(pParse, "Cannot add a UNIQUE column");
660     return;
661   }
662   if( (db->flags&SQLITE_ForeignKeys) && pNew->pFKey && pDflt ){
663     sqlite3ErrorMsg(pParse,
664         "Cannot add a REFERENCES column with non-NULL default value");
665     return;
666   }
667   if( pCol->notNull && !pDflt ){
668     sqlite3ErrorMsg(pParse,
669         "Cannot add a NOT NULL column with default value NULL");
670     return;
671   }
672 
673   /* Ensure the default expression is something that sqlite3ValueFromExpr()
674   ** can handle (i.e. not CURRENT_TIME etc.)
675   */
676   if( pDflt ){
677     sqlite3_value *pVal;
678     if( sqlite3ValueFromExpr(db, pDflt, SQLITE_UTF8, SQLITE_AFF_NONE, &pVal) ){
679       db->mallocFailed = 1;
680       return;
681     }
682     if( !pVal ){
683       sqlite3ErrorMsg(pParse, "Cannot add a column with non-constant default");
684       return;
685     }
686     sqlite3ValueFree(pVal);
687   }
688 
689   /* Modify the CREATE TABLE statement. */
690   zCol = sqlite3DbStrNDup(db, (char*)pColDef->z, pColDef->n);
691   if( zCol ){
692     char *zEnd = &zCol[pColDef->n-1];
693     int savedDbFlags = db->flags;
694     while( zEnd>zCol && (*zEnd==';' || sqlite3Isspace(*zEnd)) ){
695       *zEnd-- = '\0';
696     }
697     db->flags |= SQLITE_PreferBuiltin;
698     sqlite3NestedParse(pParse,
699         "UPDATE \"%w\".%s SET "
700           "sql = substr(sql,1,%d) || ', ' || %Q || substr(sql,%d) "
701         "WHERE type = 'table' AND name = %Q",
702       zDb, SCHEMA_TABLE(iDb), pNew->addColOffset, zCol, pNew->addColOffset+1,
703       zTab
704     );
705     sqlite3DbFree(db, zCol);
706     db->flags = savedDbFlags;
707   }
708 
709   /* If the default value of the new column is NULL, then set the file
710   ** format to 2. If the default value of the new column is not NULL,
711   ** the file format becomes 3.
712   */
713   sqlite3MinimumFileFormat(pParse, iDb, pDflt ? 3 : 2);
714 
715   /* Reload the schema of the modified table. */
716   reloadTableSchema(pParse, pTab, pTab->zName);
717 }
718 
719 /*
720 ** This function is called by the parser after the table-name in
721 ** an "ALTER TABLE <table-name> ADD" statement is parsed. Argument
722 ** pSrc is the full-name of the table being altered.
723 **
724 ** This routine makes a (partial) copy of the Table structure
725 ** for the table being altered and sets Parse.pNewTable to point
726 ** to it. Routines called by the parser as the column definition
727 ** is parsed (i.e. sqlite3AddColumn()) add the new Column data to
728 ** the copy. The copy of the Table structure is deleted by tokenize.c
729 ** after parsing is finished.
730 **
731 ** Routine sqlite3AlterFinishAddColumn() will be called to complete
732 ** coding the "ALTER TABLE ... ADD" statement.
733 */
734 void sqlite3AlterBeginAddColumn(Parse *pParse, SrcList *pSrc){
735   Table *pNew;
736   Table *pTab;
737   Vdbe *v;
738   int iDb;
739   int i;
740   int nAlloc;
741   sqlite3 *db = pParse->db;
742 
743   /* Look up the table being altered. */
744   assert( pParse->pNewTable==0 );
745   assert( sqlite3BtreeHoldsAllMutexes(db) );
746   if( db->mallocFailed ) goto exit_begin_add_column;
747   pTab = sqlite3LocateTable(pParse, 0, pSrc->a[0].zName, pSrc->a[0].zDatabase);
748   if( !pTab ) goto exit_begin_add_column;
749 
750 #ifndef SQLITE_OMIT_VIRTUALTABLE
751   if( IsVirtual(pTab) ){
752     sqlite3ErrorMsg(pParse, "virtual tables may not be altered");
753     goto exit_begin_add_column;
754   }
755 #endif
756 
757   /* Make sure this is not an attempt to ALTER a view. */
758   if( pTab->pSelect ){
759     sqlite3ErrorMsg(pParse, "Cannot add a column to a view");
760     goto exit_begin_add_column;
761   }
762 
763   assert( pTab->addColOffset>0 );
764   iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
765 
766   /* Put a copy of the Table struct in Parse.pNewTable for the
767   ** sqlite3AddColumn() function and friends to modify.  But modify
768   ** the name by adding an "sqlite_altertab_" prefix.  By adding this
769   ** prefix, we insure that the name will not collide with an existing
770   ** table because user table are not allowed to have the "sqlite_"
771   ** prefix on their name.
772   */
773   pNew = (Table*)sqlite3DbMallocZero(db, sizeof(Table));
774   if( !pNew ) goto exit_begin_add_column;
775   pParse->pNewTable = pNew;
776   pNew->nRef = 1;
777   pNew->nCol = pTab->nCol;
778   assert( pNew->nCol>0 );
779   nAlloc = (((pNew->nCol-1)/8)*8)+8;
780   assert( nAlloc>=pNew->nCol && nAlloc%8==0 && nAlloc-pNew->nCol<8 );
781   pNew->aCol = (Column*)sqlite3DbMallocZero(db, sizeof(Column)*nAlloc);
782   pNew->zName = sqlite3MPrintf(db, "sqlite_altertab_%s", pTab->zName);
783   if( !pNew->aCol || !pNew->zName ){
784     db->mallocFailed = 1;
785     goto exit_begin_add_column;
786   }
787   memcpy(pNew->aCol, pTab->aCol, sizeof(Column)*pNew->nCol);
788   for(i=0; i<pNew->nCol; i++){
789     Column *pCol = &pNew->aCol[i];
790     pCol->zName = sqlite3DbStrDup(db, pCol->zName);
791     pCol->zColl = 0;
792     pCol->zType = 0;
793     pCol->pDflt = 0;
794     pCol->zDflt = 0;
795   }
796   pNew->pSchema = db->aDb[iDb].pSchema;
797   pNew->addColOffset = pTab->addColOffset;
798   pNew->nRef = 1;
799 
800   /* Begin a transaction and increment the schema cookie.  */
801   sqlite3BeginWriteOperation(pParse, 0, iDb);
802   v = sqlite3GetVdbe(pParse);
803   if( !v ) goto exit_begin_add_column;
804   sqlite3ChangeCookie(pParse, iDb);
805 
806 exit_begin_add_column:
807   sqlite3SrcListDelete(db, pSrc);
808   return;
809 }
810 #endif  /* SQLITE_ALTER_TABLE */
811