blob: 538ba7d9f837eff88f0fc59051fdc52bf2cbac7f [file] [log] [blame]
drhd0e4a6c2005-02-15 20:47:57 +00001/*
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.
drhd0e4a6c2005-02-15 20:47:57 +000014*/
15#include "sqliteInt.h"
16
drh1f01ec12005-02-15 21:36:18 +000017/*
18** The code in this file only exists if we are not omitting the
19** ALTER TABLE logic from the build.
20*/
drhd0e4a6c2005-02-15 20:47:57 +000021#ifndef SQLITE_OMIT_ALTERTABLE
drh1f01ec12005-02-15 21:36:18 +000022
drh1f01ec12005-02-15 21:36:18 +000023/*
danbe535002011-04-01 15:15:58 +000024** 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*/
dan397a78d2018-12-18 20:31:14 +000031static int isAlterableTable(Parse *pParse, Table *pTab){
drh3d8c92d2021-04-22 18:02:48 +000032 if( 0==sqlite3StrNICmp(pTab->zName, "sqlite_", 7)
dan397a78d2018-12-18 20:31:14 +000033#ifndef SQLITE_OMIT_VIRTUALTABLE
drh3d8c92d2021-04-22 18:02:48 +000034 || (pTab->tabFlags & TF_Eponymous)!=0
drh070ae3b2019-11-16 13:51:31 +000035 || ( (pTab->tabFlags & TF_Shadow)!=0
36 && sqlite3ReadOnlyShadowTables(pParse->db)
dan397a78d2018-12-18 20:31:14 +000037 )
38#endif
39 ){
40 sqlite3ErrorMsg(pParse, "table %s may not be altered", pTab->zName);
danbe535002011-04-01 15:15:58 +000041 return 1;
42 }
43 return 0;
44}
45
dan09236502018-09-01 16:05:50 +000046/*
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*/
dan16953462021-02-18 19:25:44 +000053static 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 */
dan2ad080a2021-03-16 16:14:48 +000057 const char *zWhen, /* "when" part of error message */
58 int bNoDQS /* Do not allow DQS in the schema */
dan16953462021-02-18 19:25:44 +000059){
drh351ae772021-02-15 13:17:19 +000060 pParse->colNamesSet = 1;
dan9d324822018-08-30 20:03:44 +000061 sqlite3NestedParse(pParse,
62 "SELECT 1 "
drha4a871c2021-11-04 14:04:20 +000063 "FROM \"%w\"." LEGACY_SCHEMA_TABLE " "
dan65455fc2019-04-19 16:34:22 +000064 "WHERE name NOT LIKE 'sqliteX_%%' ESCAPE 'X'"
dan9d324822018-08-30 20:03:44 +000065 " AND sql NOT LIKE 'create virtual%%'"
dan2ad080a2021-03-16 16:14:48 +000066 " AND sqlite_rename_test(%Q, sql, type, name, %d, %Q, %d)=NULL ",
drh346a70c2020-06-15 20:27:35 +000067 zDb,
dan2ad080a2021-03-16 16:14:48 +000068 zDb, bTemp, zWhen, bNoDQS
dan9d324822018-08-30 20:03:44 +000069 );
70
71 if( bTemp==0 ){
72 sqlite3NestedParse(pParse,
73 "SELECT 1 "
drha4a871c2021-11-04 14:04:20 +000074 "FROM temp." LEGACY_SCHEMA_TABLE " "
dan65455fc2019-04-19 16:34:22 +000075 "WHERE name NOT LIKE 'sqliteX_%%' ESCAPE 'X'"
dan9d324822018-08-30 20:03:44 +000076 " AND sql NOT LIKE 'create virtual%%'"
dan2ad080a2021-03-16 16:14:48 +000077 " 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*/
90static void renameFixQuotes(Parse *pParse, const char *zDb, int bTemp){
91 sqlite3NestedParse(pParse,
drha4a871c2021-11-04 14:04:20 +000092 "UPDATE \"%w\"." LEGACY_SCHEMA_TABLE
dan2ad080a2021-03-16 16:14:48 +000093 " 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,
drha4a871c2021-11-04 14:04:20 +000099 "UPDATE temp." LEGACY_SCHEMA_TABLE
dan2ad080a2021-03-16 16:14:48 +0000100 " SET sql = sqlite_rename_quotefix('temp', sql)"
101 "WHERE name NOT LIKE 'sqliteX_%%' ESCAPE 'X'"
102 " AND sql NOT LIKE 'create virtual%%'"
dan9d324822018-08-30 20:03:44 +0000103 );
104 }
105}
106
danbe535002011-04-01 15:15:58 +0000107/*
dan09236502018-09-01 16:05:50 +0000108** Generate code to reload the schema for database iDb. And, if iDb!=1, for
109** the temp database as well.
110*/
dan6a5a13d2021-02-17 20:08:22 +0000111static void renameReloadSchema(Parse *pParse, int iDb, u16 p5){
dan09236502018-09-01 16:05:50 +0000112 Vdbe *v = pParse->pVdbe;
113 if( v ){
114 sqlite3ChangeCookie(pParse, iDb);
dan6a5a13d2021-02-17 20:08:22 +0000115 sqlite3VdbeAddParseSchemaOp(pParse->pVdbe, iDb, 0, p5);
116 if( iDb!=1 ) sqlite3VdbeAddParseSchemaOp(pParse->pVdbe, 1, 0, p5);
dan09236502018-09-01 16:05:50 +0000117 }
118}
119
120/*
drhd0e4a6c2005-02-15 20:47:57 +0000121** Generate code to implement the "ALTER TABLE xxx RENAME TO yyy"
122** command.
123*/
124void 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 */
drhd0e4a6c2005-02-15 20:47:57 +0000133 sqlite3 *db = pParse->db; /* Database connection */
drh4e5dd852007-05-15 03:56:49 +0000134 int nTabName; /* Number of UTF-8 characters in zTabName */
135 const char *zTabName; /* Original name of the table */
drhd0e4a6c2005-02-15 20:47:57 +0000136 Vdbe *v;
danielk1977595a5232009-07-24 17:58:53 +0000137 VTable *pVTab = 0; /* Non-zero if this is a v-tab with an xRename() */
drh545f5872010-04-24 14:02:59 +0000138
drh56d56f72009-04-16 16:30:17 +0000139 if( NEVER(db->mallocFailed) ) goto exit_rename_table;
drhd0e4a6c2005-02-15 20:47:57 +0000140 assert( pSrc->nSrc==1 );
drh1fee73e2007-08-29 04:00:57 +0000141 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
drhd0e4a6c2005-02-15 20:47:57 +0000142
dan41fb5cd2012-10-04 19:33:00 +0000143 pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
drhd0e4a6c2005-02-15 20:47:57 +0000144 if( !pTab ) goto exit_rename_table;
danielk1977da184232006-01-05 11:34:32 +0000145 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drh69c33822016-08-18 14:33:11 +0000146 zDb = db->aDb[iDb].zDbSName;
drhd0e4a6c2005-02-15 20:47:57 +0000147
148 /* Get a NULL terminated version of the new table name. */
drh17435752007-08-16 04:30:38 +0000149 zName = sqlite3NameFromToken(db, pName);
drhd0e4a6c2005-02-15 20:47:57 +0000150 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 */
drh3d863b52020-05-14 21:16:52 +0000155 if( sqlite3FindTable(db, zName, zDb)
156 || sqlite3FindIndex(db, zName, zDb)
157 || sqlite3IsShadowTableOf(db, pTab, zName)
158 ){
drhd0e4a6c2005-02-15 20:47:57 +0000159 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 */
dan397a78d2018-12-18 20:31:14 +0000167 if( SQLITE_OK!=isAlterableTable(pParse, pTab) ){
drhd0e4a6c2005-02-15 20:47:57 +0000168 goto exit_rename_table;
169 }
drhc5a93d42019-08-12 00:08:07 +0000170 if( SQLITE_OK!=sqlite3CheckObjectName(pParse,zName,"table",zName) ){
171 goto exit_rename_table;
drhd0e4a6c2005-02-15 20:47:57 +0000172 }
173
danielk197761116ae2007-12-13 08:15:30 +0000174#ifndef SQLITE_OMIT_VIEW
drhf38524d2021-08-02 16:41:57 +0000175 if( IsView(pTab) ){
danielk197761116ae2007-12-13 08:15:30 +0000176 sqlite3ErrorMsg(pParse, "view %s may not be altered", pTab->zName);
177 goto exit_rename_table;
178 }
179#endif
180
drhd0e4a6c2005-02-15 20:47:57 +0000181#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
danielk1977182c4ba2007-06-27 15:53:34 +0000188#ifndef SQLITE_OMIT_VIRTUALTABLE
danielk19775c558862007-06-27 17:09:24 +0000189 if( sqlite3ViewGetColumnNames(pParse, pTab) ){
190 goto exit_rename_table;
191 }
danielk1977595a5232009-07-24 17:58:53 +0000192 if( IsVirtual(pTab) ){
193 pVTab = sqlite3GetVTable(db, pTab);
194 if( pVTab->pVtab->pModule->xRename==0 ){
195 pVTab = 0;
196 }
danielk1977182c4ba2007-06-27 15:53:34 +0000197 }
198#endif
199
dan1f3b2842019-03-15 16:17:32 +0000200 /* 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. */
drhd0e4a6c2005-02-15 20:47:57 +0000204 v = sqlite3GetVdbe(pParse);
205 if( v==0 ){
206 goto exit_rename_table;
207 }
dan1f3b2842019-03-15 16:17:32 +0000208 sqlite3MayAbort(pParse);
drhd0e4a6c2005-02-15 20:47:57 +0000209
drh4e5dd852007-05-15 03:56:49 +0000210 /* figure out how many UTF-8 characters are in zName */
211 zTabName = pTab->zName;
drh9a087a92007-05-15 14:34:32 +0000212 nTabName = sqlite3Utf8CharLen(zTabName, -1);
drh4e5dd852007-05-15 03:56:49 +0000213
danc9461ec2018-08-29 21:00:16 +0000214 /* Rewrite all CREATE TABLE, INDEX, TRIGGER or VIEW statements in
215 ** the schema to use the new table name. */
216 sqlite3NestedParse(pParse,
drha4a871c2021-11-04 14:04:20 +0000217 "UPDATE \"%w\"." LEGACY_SCHEMA_TABLE " SET "
dan65372fa2018-09-03 20:05:15 +0000218 "sql = sqlite_rename_table(%Q, type, name, sql, %Q, %Q, %d) "
danc9461ec2018-08-29 21:00:16 +0000219 "WHERE (type!='index' OR tbl_name=%Q COLLATE nocase)"
dan65455fc2019-04-19 16:34:22 +0000220 "AND name NOT LIKE 'sqliteX_%%' ESCAPE 'X'"
drh346a70c2020-06-15 20:27:35 +0000221 , zDb, zDb, zTabName, zName, (iDb==1), zTabName
danc9461ec2018-08-29 21:00:16 +0000222 );
dan432cc5b2009-09-26 17:51:48 +0000223
drh1e32bed2020-06-19 13:33:53 +0000224 /* Update the tbl_name and name columns of the sqlite_schema table
danc9461ec2018-08-29 21:00:16 +0000225 ** as required. */
drhd0e4a6c2005-02-15 20:47:57 +0000226 sqlite3NestedParse(pParse,
drha4a871c2021-11-04 14:04:20 +0000227 "UPDATE %Q." LEGACY_SCHEMA_TABLE " SET "
drhd0e4a6c2005-02-15 20:47:57 +0000228 "tbl_name = %Q, "
229 "name = CASE "
230 "WHEN type='table' THEN %Q "
dan65455fc2019-04-19 16:34:22 +0000231 "WHEN name LIKE 'sqliteX_autoindex%%' ESCAPE 'X' "
232 " AND type='index' THEN "
drha21a9292007-10-20 20:58:57 +0000233 "'sqlite_autoindex_' || %Q || substr(name,%d+18) "
drhd0e4a6c2005-02-15 20:47:57 +0000234 "ELSE name END "
drh01522682012-02-01 01:13:10 +0000235 "WHERE tbl_name=%Q COLLATE nocase AND "
drhd0e4a6c2005-02-15 20:47:57 +0000236 "(type='table' OR type='index' OR type='trigger');",
drh346a70c2020-06-15 20:27:35 +0000237 zDb,
danc9461ec2018-08-29 21:00:16 +0000238 zName, zName, zName,
239 nTabName, zTabName
drhd0e4a6c2005-02-15 20:47:57 +0000240 );
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,
drh8e5b5f82008-02-09 14:30:29 +0000248 "UPDATE \"%w\".sqlite_sequence set name = %Q WHERE name = %Q",
drhd0e4a6c2005-02-15 20:47:57 +0000249 zDb, zName, pTab->zName);
250 }
251#endif
252
danc9461ec2018-08-29 21:00:16 +0000253 /* 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 ){
danielk197719a8e7e2005-03-17 05:03:38 +0000257 sqlite3NestedParse(pParse,
drh1e32bed2020-06-19 13:33:53 +0000258 "UPDATE sqlite_temp_schema SET "
dan65372fa2018-09-03 20:05:15 +0000259 "sql = sqlite_rename_table(%Q, type, name, sql, %Q, %Q, 1), "
danc9461ec2018-08-29 21:00:16 +0000260 "tbl_name = "
dan1d85c6b2018-09-06 16:01:37 +0000261 "CASE WHEN tbl_name=%Q COLLATE nocase AND "
dan2ad080a2021-03-16 16:14:48 +0000262 " sqlite_rename_test(%Q, sql, type, name, 1, 'after rename', 0) "
dan1d85c6b2018-09-06 16:01:37 +0000263 "THEN %Q ELSE tbl_name END "
danc9461ec2018-08-29 21:00:16 +0000264 "WHERE type IN ('view', 'trigger')"
dan1d85c6b2018-09-06 16:01:37 +0000265 , zDb, zTabName, zName, zTabName, zDb, zName);
drhd0e4a6c2005-02-15 20:47:57 +0000266 }
drhd0e4a6c2005-02-15 20:47:57 +0000267
dan34566c42018-09-20 17:21:21 +0000268 /* 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);
dan34566c42018-09-20 17:21:21 +0000278 }
279#endif
280
dan6a5a13d2021-02-17 20:08:22 +0000281 renameReloadSchema(pParse, iDb, INITFLAG_AlterRename);
dan2ad080a2021-03-16 16:14:48 +0000282 renameTestSchema(pParse, zDb, iDb==1, "after rename", 0);
dan9d324822018-08-30 20:03:44 +0000283
drhd0e4a6c2005-02-15 20:47:57 +0000284exit_rename_table:
drh633e6d52008-07-28 19:34:53 +0000285 sqlite3SrcListDelete(db, pSrc);
286 sqlite3DbFree(db, zName);
drhd0e4a6c2005-02-15 20:47:57 +0000287}
danielk197719a8e7e2005-03-17 05:03:38 +0000288
drhd3001712009-05-12 17:46:53 +0000289/*
drh9e5fdc42020-05-08 19:02:21 +0000290** Write code that will raise an error if the table described by
291** zDb and zTab is not empty.
292*/
293static 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/*
danielk197719a8e7e2005-03-17 05:03:38 +0000306** 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*/
313void 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 */
drh17435752007-08-16 04:30:38 +0000322 sqlite3 *db; /* The database connection; */
dan09236502018-09-01 16:05:50 +0000323 Vdbe *v; /* The prepared statement under construction */
drh86396212016-07-14 19:13:11 +0000324 int r1; /* Temporary registers */
danielk197719a8e7e2005-03-17 05:03:38 +0000325
danielk1977f150c9d2008-10-30 17:21:12 +0000326 db = pParse->db;
drh0c7d3d32022-01-24 16:47:12 +0000327 assert( db->pParse==pParse );
328 if( pParse->nErr ) return;
329 assert( db->mallocFailed==0 );
danielk197719a8e7e2005-03-17 05:03:38 +0000330 pNew = pParse->pNewTable;
331 assert( pNew );
332
drh1fee73e2007-08-29 04:00:57 +0000333 assert( sqlite3BtreeHoldsAllMutexes(db) );
drh17435752007-08-16 04:30:38 +0000334 iDb = sqlite3SchemaToIndex(db, pNew->pSchema);
drh69c33822016-08-18 14:33:11 +0000335 zDb = db->aDb[iDb].zDbSName;
drh03881232009-02-13 03:43:31 +0000336 zTab = &pNew->zName[16]; /* Skip the "sqlite_altertab_" prefix on the name */
danielk197719a8e7e2005-03-17 05:03:38 +0000337 pCol = &pNew->aCol[pNew->nCol-1];
drh79cf2b72021-07-31 20:30:41 +0000338 pDflt = sqlite3ColumnExpr(pNew, pCol);
drh17435752007-08-16 04:30:38 +0000339 pTab = sqlite3FindTable(db, zTab, zDb);
danielk197719a8e7e2005-03-17 05:03:38 +0000340 assert( pTab );
341
drh81f2ccd2006-01-31 14:28:44 +0000342#ifndef SQLITE_OMIT_AUTHORIZATION
343 /* Invoke the authorization callback. */
344 if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
345 return;
346 }
347#endif
348
danielk197719a8e7e2005-03-17 05:03:38 +0000349
350 /* Check that the new column is not specified as PRIMARY KEY or UNIQUE.
351 ** If there is a NOT NULL constraint, then the default value for the
352 ** column must not be NULL.
353 */
drha371ace2012-09-13 14:22:47 +0000354 if( pCol->colFlags & COLFLAG_PRIMKEY ){
danielk197719a8e7e2005-03-17 05:03:38 +0000355 sqlite3ErrorMsg(pParse, "Cannot add a PRIMARY KEY column");
356 return;
357 }
358 if( pNew->pIndex ){
drh9e5fdc42020-05-08 19:02:21 +0000359 sqlite3ErrorMsg(pParse,
360 "Cannot add a UNIQUE column");
danielk197719a8e7e2005-03-17 05:03:38 +0000361 return;
362 }
drhc27ea2a2019-10-16 20:05:56 +0000363 if( (pCol->colFlags & COLFLAG_GENERATED)==0 ){
364 /* If the default value for the new column was specified with a
365 ** literal NULL, then set pDflt to 0. This simplifies checking
366 ** for an SQL NULL default below.
367 */
368 assert( pDflt==0 || pDflt->op==TK_SPAN );
369 if( pDflt && pDflt->pLeft->op==TK_NULL ){
370 pDflt = 0;
371 }
drh78b2fa82021-10-07 12:11:20 +0000372 assert( IsOrdinaryTable(pNew) );
drhf38524d2021-08-02 16:41:57 +0000373 if( (db->flags&SQLITE_ForeignKeys) && pNew->u.tab.pFKey && pDflt ){
drh9e5fdc42020-05-08 19:02:21 +0000374 sqlite3ErrorIfNotEmpty(pParse, zDb, zTab,
drhc27ea2a2019-10-16 20:05:56 +0000375 "Cannot add a REFERENCES column with non-NULL default value");
drhc27ea2a2019-10-16 20:05:56 +0000376 }
377 if( pCol->notNull && !pDflt ){
drh9e5fdc42020-05-08 19:02:21 +0000378 sqlite3ErrorIfNotEmpty(pParse, zDb, zTab,
drhc27ea2a2019-10-16 20:05:56 +0000379 "Cannot add a NOT NULL column with default value NULL");
drhc27ea2a2019-10-16 20:05:56 +0000380 }
381
drh9e5fdc42020-05-08 19:02:21 +0000382
drhc27ea2a2019-10-16 20:05:56 +0000383 /* Ensure the default expression is something that sqlite3ValueFromExpr()
384 ** can handle (i.e. not CURRENT_TIME etc.)
385 */
386 if( pDflt ){
387 sqlite3_value *pVal = 0;
388 int rc;
389 rc = sqlite3ValueFromExpr(db, pDflt, SQLITE_UTF8, SQLITE_AFF_BLOB, &pVal);
390 assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
391 if( rc!=SQLITE_OK ){
392 assert( db->mallocFailed == 1 );
393 return;
394 }
395 if( !pVal ){
drh9e5fdc42020-05-08 19:02:21 +0000396 sqlite3ErrorIfNotEmpty(pParse, zDb, zTab,
397 "Cannot add a column with non-constant default");
drhc27ea2a2019-10-16 20:05:56 +0000398 }
399 sqlite3ValueFree(pVal);
400 }
drh035f6d92019-10-24 01:04:10 +0000401 }else if( pCol->colFlags & COLFLAG_STORED ){
drh9e5fdc42020-05-08 19:02:21 +0000402 sqlite3ErrorIfNotEmpty(pParse, zDb, zTab, "cannot add a STORED column");
danielk197719a8e7e2005-03-17 05:03:38 +0000403 }
404
danielk197719a8e7e2005-03-17 05:03:38 +0000405
406 /* Modify the CREATE TABLE statement. */
drh17435752007-08-16 04:30:38 +0000407 zCol = sqlite3DbStrNDup(db, (char*)pColDef->z, pColDef->n);
danielk197719a8e7e2005-03-17 05:03:38 +0000408 if( zCol ){
409 char *zEnd = &zCol[pColDef->n-1];
drh56d56f72009-04-16 16:30:17 +0000410 while( zEnd>zCol && (*zEnd==';' || sqlite3Isspace(*zEnd)) ){
danielk197719a8e7e2005-03-17 05:03:38 +0000411 *zEnd-- = '\0';
412 }
drh37114fb2021-01-01 20:04:34 +0000413 /* substr() operations on characters, but addColOffset is in bytes. So we
414 ** have to use printf() to translate between these units: */
drh78b2fa82021-10-07 12:11:20 +0000415 assert( IsOrdinaryTable(pTab) );
416 assert( IsOrdinaryTable(pNew) );
danielk197719a8e7e2005-03-17 05:03:38 +0000417 sqlite3NestedParse(pParse,
drha4a871c2021-11-04 14:04:20 +0000418 "UPDATE \"%w\"." LEGACY_SCHEMA_TABLE " SET "
drh37114fb2021-01-01 20:04:34 +0000419 "sql = printf('%%.%ds, ',sql) || %Q"
420 " || substr(sql,1+length(printf('%%.%ds',sql))) "
danielk197719a8e7e2005-03-17 05:03:38 +0000421 "WHERE type = 'table' AND name = %Q",
drhf38524d2021-08-02 16:41:57 +0000422 zDb, pNew->u.tab.addColOffset, zCol, pNew->u.tab.addColOffset,
danielk197719a8e7e2005-03-17 05:03:38 +0000423 zTab
424 );
drh633e6d52008-07-28 19:34:53 +0000425 sqlite3DbFree(db, zCol);
danielk197719a8e7e2005-03-17 05:03:38 +0000426 }
427
dan09236502018-09-01 16:05:50 +0000428 v = sqlite3GetVdbe(pParse);
429 if( v ){
drhb4d9b2b2021-07-20 07:35:07 +0000430 /* Make sure the schema version is at least 3. But do not upgrade
431 ** from less than 3 to 4, as that will corrupt any preexisting DESC
432 ** index.
433 */
dan09236502018-09-01 16:05:50 +0000434 r1 = sqlite3GetTempReg(pParse);
435 sqlite3VdbeAddOp3(v, OP_ReadCookie, iDb, r1, BTREE_FILE_FORMAT);
436 sqlite3VdbeUsesBtree(v, iDb);
437 sqlite3VdbeAddOp2(v, OP_AddImm, r1, -2);
438 sqlite3VdbeAddOp2(v, OP_IfPos, r1, sqlite3VdbeCurrentAddr(v)+2);
439 VdbeCoverage(v);
440 sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_FILE_FORMAT, 3);
441 sqlite3ReleaseTempReg(pParse, r1);
danielk197719a8e7e2005-03-17 05:03:38 +0000442
drhb4d9b2b2021-07-20 07:35:07 +0000443 /* Reload the table definition */
drhac894af2021-11-03 15:59:17 +0000444 renameReloadSchema(pParse, iDb, INITFLAG_AlterAdd);
drhb4d9b2b2021-07-20 07:35:07 +0000445
446 /* Verify that constraints are still satisfied */
drh0f91a532021-07-20 08:23:54 +0000447 if( pNew->pCheck!=0
drhb4d9b2b2021-07-20 07:35:07 +0000448 || (pCol->notNull && (pCol->colFlags & COLFLAG_GENERATED)!=0)
449 ){
450 sqlite3NestedParse(pParse,
451 "SELECT CASE WHEN quick_check GLOB 'CHECK*'"
452 " THEN raise(ABORT,'CHECK constraint failed')"
drh0f91a532021-07-20 08:23:54 +0000453 " ELSE raise(ABORT,'NOT NULL constraint failed')"
drhb4d9b2b2021-07-20 07:35:07 +0000454 " END"
drh72e30422022-01-16 15:15:39 +0000455 " FROM pragma_quick_check(%Q,%Q)"
drh0f91a532021-07-20 08:23:54 +0000456 " WHERE quick_check GLOB 'CHECK*' OR quick_check GLOB 'NULL*'",
drhb4d9b2b2021-07-20 07:35:07 +0000457 zTab, zDb
458 );
459 }
460 }
danielk197719a8e7e2005-03-17 05:03:38 +0000461}
462
drhfdd6e852005-12-16 01:06:16 +0000463/*
danielk197719a8e7e2005-03-17 05:03:38 +0000464** This function is called by the parser after the table-name in
465** an "ALTER TABLE <table-name> ADD" statement is parsed. Argument
466** pSrc is the full-name of the table being altered.
467**
468** This routine makes a (partial) copy of the Table structure
469** for the table being altered and sets Parse.pNewTable to point
470** to it. Routines called by the parser as the column definition
471** is parsed (i.e. sqlite3AddColumn()) add the new Column data to
472** the copy. The copy of the Table structure is deleted by tokenize.c
473** after parsing is finished.
474**
475** Routine sqlite3AlterFinishAddColumn() will be called to complete
476** coding the "ALTER TABLE ... ADD" statement.
477*/
478void sqlite3AlterBeginAddColumn(Parse *pParse, SrcList *pSrc){
479 Table *pNew;
480 Table *pTab;
danielk197719a8e7e2005-03-17 05:03:38 +0000481 int iDb;
482 int i;
483 int nAlloc;
drh17435752007-08-16 04:30:38 +0000484 sqlite3 *db = pParse->db;
danielk197719a8e7e2005-03-17 05:03:38 +0000485
486 /* Look up the table being altered. */
drh0bbaa1b2005-08-19 19:14:12 +0000487 assert( pParse->pNewTable==0 );
drh1fee73e2007-08-29 04:00:57 +0000488 assert( sqlite3BtreeHoldsAllMutexes(db) );
drh17435752007-08-16 04:30:38 +0000489 if( db->mallocFailed ) goto exit_begin_add_column;
dan41fb5cd2012-10-04 19:33:00 +0000490 pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
danielk197719a8e7e2005-03-17 05:03:38 +0000491 if( !pTab ) goto exit_begin_add_column;
492
danielk19775ee9d692006-06-21 12:36:25 +0000493#ifndef SQLITE_OMIT_VIRTUALTABLE
494 if( IsVirtual(pTab) ){
495 sqlite3ErrorMsg(pParse, "virtual tables may not be altered");
496 goto exit_begin_add_column;
497 }
498#endif
499
danielk197719a8e7e2005-03-17 05:03:38 +0000500 /* Make sure this is not an attempt to ALTER a view. */
drhf38524d2021-08-02 16:41:57 +0000501 if( IsView(pTab) ){
danielk197719a8e7e2005-03-17 05:03:38 +0000502 sqlite3ErrorMsg(pParse, "Cannot add a column to a view");
503 goto exit_begin_add_column;
504 }
dan397a78d2018-12-18 20:31:14 +0000505 if( SQLITE_OK!=isAlterableTable(pParse, pTab) ){
danbe535002011-04-01 15:15:58 +0000506 goto exit_begin_add_column;
507 }
danielk197719a8e7e2005-03-17 05:03:38 +0000508
dan03e025e2019-10-07 18:43:21 +0000509 sqlite3MayAbort(pParse);
drh78b2fa82021-10-07 12:11:20 +0000510 assert( IsOrdinaryTable(pTab) );
drhf38524d2021-08-02 16:41:57 +0000511 assert( pTab->u.tab.addColOffset>0 );
drh17435752007-08-16 04:30:38 +0000512 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
danielk197719a8e7e2005-03-17 05:03:38 +0000513
514 /* Put a copy of the Table struct in Parse.pNewTable for the
drh03881232009-02-13 03:43:31 +0000515 ** sqlite3AddColumn() function and friends to modify. But modify
516 ** the name by adding an "sqlite_altertab_" prefix. By adding this
517 ** prefix, we insure that the name will not collide with an existing
518 ** table because user table are not allowed to have the "sqlite_"
519 ** prefix on their name.
danielk197719a8e7e2005-03-17 05:03:38 +0000520 */
drh17435752007-08-16 04:30:38 +0000521 pNew = (Table*)sqlite3DbMallocZero(db, sizeof(Table));
danielk197719a8e7e2005-03-17 05:03:38 +0000522 if( !pNew ) goto exit_begin_add_column;
523 pParse->pNewTable = pNew;
drh79df7782016-12-14 14:07:35 +0000524 pNew->nTabRef = 1;
danielk197719a8e7e2005-03-17 05:03:38 +0000525 pNew->nCol = pTab->nCol;
danielk1977b3a2cce2005-03-27 01:56:30 +0000526 assert( pNew->nCol>0 );
527 nAlloc = (((pNew->nCol-1)/8)*8)+8;
528 assert( nAlloc>=pNew->nCol && nAlloc%8==0 && nAlloc-pNew->nCol<8 );
danielk197726783a52007-08-29 14:06:22 +0000529 pNew->aCol = (Column*)sqlite3DbMallocZero(db, sizeof(Column)*nAlloc);
drh03881232009-02-13 03:43:31 +0000530 pNew->zName = sqlite3MPrintf(db, "sqlite_altertab_%s", pTab->zName);
danielk197719a8e7e2005-03-17 05:03:38 +0000531 if( !pNew->aCol || !pNew->zName ){
drh4df86af2016-02-04 11:48:00 +0000532 assert( db->mallocFailed );
danielk197719a8e7e2005-03-17 05:03:38 +0000533 goto exit_begin_add_column;
534 }
535 memcpy(pNew->aCol, pTab->aCol, sizeof(Column)*pNew->nCol);
536 for(i=0; i<pNew->nCol; i++){
537 Column *pCol = &pNew->aCol[i];
drhcf9d36d2021-08-02 18:03:43 +0000538 pCol->zCnName = sqlite3DbStrDup(db, pCol->zCnName);
539 pCol->hName = sqlite3StrIHash(pCol->zCnName);
danielk197719a8e7e2005-03-17 05:03:38 +0000540 }
drh78b2fa82021-10-07 12:11:20 +0000541 assert( IsOrdinaryTable(pNew) );
drhf38524d2021-08-02 16:41:57 +0000542 pNew->u.tab.pDfltList = sqlite3ExprListDup(db, pTab->u.tab.pDfltList, 0);
drh17435752007-08-16 04:30:38 +0000543 pNew->pSchema = db->aDb[iDb].pSchema;
drhf38524d2021-08-02 16:41:57 +0000544 pNew->u.tab.addColOffset = pTab->u.tab.addColOffset;
drh79df7782016-12-14 14:07:35 +0000545 pNew->nTabRef = 1;
danielk197719a8e7e2005-03-17 05:03:38 +0000546
danielk197719a8e7e2005-03-17 05:03:38 +0000547exit_begin_add_column:
drh633e6d52008-07-28 19:34:53 +0000548 sqlite3SrcListDelete(db, pSrc);
danielk197719a8e7e2005-03-17 05:03:38 +0000549 return;
550}
dancf8f2892018-08-09 20:47:01 +0000551
drh4a2c7472018-08-13 15:09:48 +0000552/*
dan9d705572018-08-20 16:16:05 +0000553** Parameter pTab is the subject of an ALTER TABLE ... RENAME COLUMN
554** command. This function checks if the table is a view or virtual
555** table (columns of views or virtual tables may not be renamed). If so,
556** it loads an error message into pParse and returns non-zero.
557**
558** Or, if pTab is not a view or virtual table, zero is returned.
559*/
560#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
dan6a5a13d2021-02-17 20:08:22 +0000561static int isRealTable(Parse *pParse, Table *pTab, int bDrop){
dan9d705572018-08-20 16:16:05 +0000562 const char *zType = 0;
563#ifndef SQLITE_OMIT_VIEW
drhf38524d2021-08-02 16:41:57 +0000564 if( IsView(pTab) ){
dan9d705572018-08-20 16:16:05 +0000565 zType = "view";
dan1041a6a2018-09-06 17:47:09 +0000566 }
dan9d705572018-08-20 16:16:05 +0000567#endif
568#ifndef SQLITE_OMIT_VIRTUALTABLE
569 if( IsVirtual(pTab) ){
570 zType = "virtual table";
571 }
572#endif
573 if( zType ){
dan6a5a13d2021-02-17 20:08:22 +0000574 sqlite3ErrorMsg(pParse, "cannot %s %s \"%s\"",
575 (bDrop ? "drop column from" : "rename columns of"),
576 zType, pTab->zName
dan9d705572018-08-20 16:16:05 +0000577 );
578 return 1;
579 }
580 return 0;
581}
582#else /* !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) */
dan6a5a13d2021-02-17 20:08:22 +0000583# define isRealTable(x,y,z) (0)
dan9d705572018-08-20 16:16:05 +0000584#endif
585
586/*
drh4a2c7472018-08-13 15:09:48 +0000587** Handles the following parser reduction:
588**
589** cmd ::= ALTER TABLE pSrc RENAME COLUMN pOld TO pNew
590*/
dancf8f2892018-08-09 20:47:01 +0000591void sqlite3AlterRenameColumn(
drh4a2c7472018-08-13 15:09:48 +0000592 Parse *pParse, /* Parsing context */
593 SrcList *pSrc, /* Table being altered. pSrc->nSrc==1 */
594 Token *pOld, /* Name of column being changed */
595 Token *pNew /* New column name */
dancf8f2892018-08-09 20:47:01 +0000596){
drh4a2c7472018-08-13 15:09:48 +0000597 sqlite3 *db = pParse->db; /* Database connection */
dancf8f2892018-08-09 20:47:01 +0000598 Table *pTab; /* Table being updated */
599 int iCol; /* Index of column being renamed */
drh4a2c7472018-08-13 15:09:48 +0000600 char *zOld = 0; /* Old column name */
601 char *zNew = 0; /* New column name */
602 const char *zDb; /* Name of schema containing the table */
603 int iSchema; /* Index of the schema */
604 int bQuote; /* True to quote the new name */
dancf8f2892018-08-09 20:47:01 +0000605
drh4a2c7472018-08-13 15:09:48 +0000606 /* Locate the table to be altered */
dancf8f2892018-08-09 20:47:01 +0000607 pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
608 if( !pTab ) goto exit_rename_column;
drh4a2c7472018-08-13 15:09:48 +0000609
610 /* Cannot alter a system table */
dan397a78d2018-12-18 20:31:14 +0000611 if( SQLITE_OK!=isAlterableTable(pParse, pTab) ) goto exit_rename_column;
dan6a5a13d2021-02-17 20:08:22 +0000612 if( SQLITE_OK!=isRealTable(pParse, pTab, 0) ) goto exit_rename_column;
drh4a2c7472018-08-13 15:09:48 +0000613
614 /* Which schema holds the table to be altered */
dancf8f2892018-08-09 20:47:01 +0000615 iSchema = sqlite3SchemaToIndex(db, pTab->pSchema);
616 assert( iSchema>=0 );
617 zDb = db->aDb[iSchema].zDbSName;
618
drh0d019b92018-08-25 16:14:46 +0000619#ifndef SQLITE_OMIT_AUTHORIZATION
620 /* Invoke the authorization callback. */
621 if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
622 goto exit_rename_column;
623 }
624#endif
625
drh4a2c7472018-08-13 15:09:48 +0000626 /* Make sure the old name really is a column name in the table to be
627 ** altered. Set iCol to be the index of the column being renamed */
dancf8f2892018-08-09 20:47:01 +0000628 zOld = sqlite3NameFromToken(db, pOld);
629 if( !zOld ) goto exit_rename_column;
630 for(iCol=0; iCol<pTab->nCol; iCol++){
drhcf9d36d2021-08-02 18:03:43 +0000631 if( 0==sqlite3StrICmp(pTab->aCol[iCol].zCnName, zOld) ) break;
dancf8f2892018-08-09 20:47:01 +0000632 }
633 if( iCol==pTab->nCol ){
drh4e532952022-02-08 13:41:23 +0000634 sqlite3ErrorMsg(pParse, "no such column: \"%T\"", pOld);
dancf8f2892018-08-09 20:47:01 +0000635 goto exit_rename_column;
636 }
637
dan2ad080a2021-03-16 16:14:48 +0000638 /* Ensure the schema contains no double-quoted strings */
639 renameTestSchema(pParse, zDb, iSchema==1, "", 0);
640 renameFixQuotes(pParse, zDb, iSchema==1);
641
drh4a2c7472018-08-13 15:09:48 +0000642 /* Do the rename operation using a recursive UPDATE statement that
643 ** uses the sqlite_rename_column() SQL function to compute the new
drh1e32bed2020-06-19 13:33:53 +0000644 ** CREATE statement text for the sqlite_schema table.
drh4a2c7472018-08-13 15:09:48 +0000645 */
dan1f3b2842019-03-15 16:17:32 +0000646 sqlite3MayAbort(pParse);
dancf8f2892018-08-09 20:47:01 +0000647 zNew = sqlite3NameFromToken(db, pNew);
648 if( !zNew ) goto exit_rename_column;
dan404c3ba2018-08-11 20:38:33 +0000649 assert( pNew->n>0 );
650 bQuote = sqlite3Isquote(pNew->z[0]);
dancf8f2892018-08-09 20:47:01 +0000651 sqlite3NestedParse(pParse,
drha4a871c2021-11-04 14:04:20 +0000652 "UPDATE \"%w\"." LEGACY_SCHEMA_TABLE " SET "
danb87a9a82018-09-01 20:23:28 +0000653 "sql = sqlite_rename_column(sql, type, name, %Q, %Q, %d, %Q, %d, %d) "
dan65455fc2019-04-19 16:34:22 +0000654 "WHERE name NOT LIKE 'sqliteX_%%' ESCAPE 'X' "
drhe73e9572021-09-16 13:20:29 +0000655 " AND (type != 'index' OR tbl_name = %Q)",
drh346a70c2020-06-15 20:27:35 +0000656 zDb,
danb87a9a82018-09-01 20:23:28 +0000657 zDb, pTab->zName, iCol, zNew, bQuote, iSchema==1,
dan987db762018-08-14 20:18:50 +0000658 pTab->zName
dancf8f2892018-08-09 20:47:01 +0000659 );
660
dan9d324822018-08-30 20:03:44 +0000661 sqlite3NestedParse(pParse,
drha4a871c2021-11-04 14:04:20 +0000662 "UPDATE temp." LEGACY_SCHEMA_TABLE " SET "
danb87a9a82018-09-01 20:23:28 +0000663 "sql = sqlite_rename_column(sql, type, name, %Q, %Q, %d, %Q, %d, 1) "
dan9d324822018-08-30 20:03:44 +0000664 "WHERE type IN ('trigger', 'view')",
dan9d324822018-08-30 20:03:44 +0000665 zDb, pTab->zName, iCol, zNew, bQuote
666 );
667
dane325ffe2018-08-11 13:40:20 +0000668 /* Drop and reload the database schema. */
dan6a5a13d2021-02-17 20:08:22 +0000669 renameReloadSchema(pParse, iSchema, INITFLAG_AlterRename);
dan2ad080a2021-03-16 16:14:48 +0000670 renameTestSchema(pParse, zDb, iSchema==1, "after rename", 1);
dan0d5fa6b2018-08-24 17:55:49 +0000671
dancf8f2892018-08-09 20:47:01 +0000672 exit_rename_column:
673 sqlite3SrcListDelete(db, pSrc);
674 sqlite3DbFree(db, zOld);
675 sqlite3DbFree(db, zNew);
676 return;
677}
678
drh4a2c7472018-08-13 15:09:48 +0000679/*
680** Each RenameToken object maps an element of the parse tree into
681** the token that generated that element. The parse tree element
682** might be one of:
683**
684** * A pointer to an Expr that represents an ID
685** * The name of a table column in Column.zName
686**
687** A list of RenameToken objects can be constructed during parsing.
dan07e95232018-08-21 16:32:53 +0000688** Each new object is created by sqlite3RenameTokenMap().
689** As the parse tree is transformed, the sqlite3RenameTokenRemap()
drh4a2c7472018-08-13 15:09:48 +0000690** routine is used to keep the mapping current.
691**
692** After the parse finishes, renameTokenFind() routine can be used
693** to look up the actual token value that created some element in
694** the parse tree.
695*/
dancf8f2892018-08-09 20:47:01 +0000696struct RenameToken {
drhb6dad522021-09-24 16:14:47 +0000697 const void *p; /* Parse tree element created by token t */
drh4a2c7472018-08-13 15:09:48 +0000698 Token t; /* The token that created parse tree element p */
699 RenameToken *pNext; /* Next is a list of all RenameToken objects */
dancf8f2892018-08-09 20:47:01 +0000700};
701
drh4a2c7472018-08-13 15:09:48 +0000702/*
703** The context of an ALTER TABLE RENAME COLUMN operation that gets passed
704** down into the Walker.
705*/
dan5496d6a2018-08-13 17:14:26 +0000706typedef struct RenameCtx RenameCtx;
dancf8f2892018-08-09 20:47:01 +0000707struct RenameCtx {
708 RenameToken *pList; /* List of tokens to overwrite */
709 int nList; /* Number of tokens in pList */
710 int iCol; /* Index of column being renamed */
dan987db762018-08-14 20:18:50 +0000711 Table *pTab; /* Table being ALTERed */
dan5496d6a2018-08-13 17:14:26 +0000712 const char *zOld; /* Old column name */
dancf8f2892018-08-09 20:47:01 +0000713};
714
dan8900a482018-09-05 14:36:05 +0000715#ifdef SQLITE_DEBUG
716/*
717** This function is only for debugging. It performs two tasks:
718**
719** 1. Checks that pointer pPtr does not already appear in the
720** rename-token list.
721**
722** 2. Dereferences each pointer in the rename-token list.
723**
724** The second is most effective when debugging under valgrind or
725** address-sanitizer or similar. If any of these pointers no longer
726** point to valid objects, an exception is raised by the memory-checking
727** tool.
728**
729** The point of this is to prevent comparisons of invalid pointer values.
730** Even though this always seems to work, it is undefined according to the
731** C standard. Example of undefined comparison:
732**
733** sqlite3_free(x);
734** if( x==y ) ...
735**
736** Technically, as x no longer points into a valid object or to the byte
737** following a valid object, it may not be used in comparison operations.
738*/
drhb6dad522021-09-24 16:14:47 +0000739static void renameTokenCheckAll(Parse *pParse, const void *pPtr){
drh0c7d3d32022-01-24 16:47:12 +0000740 assert( pParse==pParse->db->pParse );
741 assert( pParse->db->mallocFailed==0 || pParse->nErr!=0 );
742 if( pParse->nErr==0 ){
drhb6dad522021-09-24 16:14:47 +0000743 const RenameToken *p;
dan8900a482018-09-05 14:36:05 +0000744 u8 i = 0;
745 for(p=pParse->pRename; p; p=p->pNext){
746 if( p->p ){
747 assert( p->p!=pPtr );
748 i += *(u8*)(p->p);
749 }
danc9461ec2018-08-29 21:00:16 +0000750 }
751 }
752}
dan8900a482018-09-05 14:36:05 +0000753#else
754# define renameTokenCheckAll(x,y)
755#endif
danc9461ec2018-08-29 21:00:16 +0000756
drh4a2c7472018-08-13 15:09:48 +0000757/*
drh49b269e2018-11-26 15:00:25 +0000758** Remember that the parser tree element pPtr was created using
759** the token pToken.
dan07e95232018-08-21 16:32:53 +0000760**
drh49b269e2018-11-26 15:00:25 +0000761** In other words, construct a new RenameToken object and add it
762** to the list of RenameToken objects currently being built up
763** in pParse->pRename.
764**
765** The pPtr argument is returned so that this routine can be used
766** with tail recursion in tokenExpr() routine, for a small performance
767** improvement.
drh4a2c7472018-08-13 15:09:48 +0000768*/
drhb6dad522021-09-24 16:14:47 +0000769const void *sqlite3RenameTokenMap(
770 Parse *pParse,
771 const void *pPtr,
772 const Token *pToken
773){
dancf8f2892018-08-09 20:47:01 +0000774 RenameToken *pNew;
danc9461ec2018-08-29 21:00:16 +0000775 assert( pPtr || pParse->db->mallocFailed );
dan8900a482018-09-05 14:36:05 +0000776 renameTokenCheckAll(pParse, pPtr);
drh2d99f952020-04-07 01:18:23 +0000777 if( ALWAYS(pParse->eParseMode!=PARSE_MODE_UNMAP) ){
dane6dc1e52019-12-05 14:31:43 +0000778 pNew = sqlite3DbMallocZero(pParse->db, sizeof(RenameToken));
779 if( pNew ){
780 pNew->p = pPtr;
781 pNew->t = *pToken;
782 pNew->pNext = pParse->pRename;
783 pParse->pRename = pNew;
784 }
dancf8f2892018-08-09 20:47:01 +0000785 }
danc9461ec2018-08-29 21:00:16 +0000786
dand145e5f2018-08-21 08:29:48 +0000787 return pPtr;
dancf8f2892018-08-09 20:47:01 +0000788}
789
drh4a2c7472018-08-13 15:09:48 +0000790/*
dan07e95232018-08-21 16:32:53 +0000791** It is assumed that there is already a RenameToken object associated
792** with parse tree element pFrom. This function remaps the associated token
793** to parse tree element pTo.
drh4a2c7472018-08-13 15:09:48 +0000794*/
drhb6dad522021-09-24 16:14:47 +0000795void sqlite3RenameTokenRemap(Parse *pParse, const void *pTo, const void *pFrom){
dancf8f2892018-08-09 20:47:01 +0000796 RenameToken *p;
dan8900a482018-09-05 14:36:05 +0000797 renameTokenCheckAll(pParse, pTo);
danc9461ec2018-08-29 21:00:16 +0000798 for(p=pParse->pRename; p; p=p->pNext){
dancf8f2892018-08-09 20:47:01 +0000799 if( p->p==pFrom ){
800 p->p = pTo;
801 break;
802 }
803 }
dancf8f2892018-08-09 20:47:01 +0000804}
805
drh4a2c7472018-08-13 15:09:48 +0000806/*
dan8900a482018-09-05 14:36:05 +0000807** Walker callback used by sqlite3RenameExprUnmap().
808*/
809static int renameUnmapExprCb(Walker *pWalker, Expr *pExpr){
810 Parse *pParse = pWalker->pParse;
drhb6dad522021-09-24 16:14:47 +0000811 sqlite3RenameTokenRemap(pParse, 0, (const void*)pExpr);
drh477572b2021-10-07 20:46:29 +0000812 if( ExprUseYTab(pExpr) ){
813 sqlite3RenameTokenRemap(pParse, 0, (const void*)&pExpr->y.pTab);
814 }
dan8900a482018-09-05 14:36:05 +0000815 return WRC_Continue;
816}
817
818/*
dan8f407622019-12-04 14:26:38 +0000819** Iterate through the Select objects that are part of WITH clauses attached
820** to select statement pSelect.
821*/
822static void renameWalkWith(Walker *pWalker, Select *pSelect){
drh646975c2019-12-17 12:03:30 +0000823 With *pWith = pSelect->pWith;
824 if( pWith ){
dan26d61e52021-06-11 11:14:24 +0000825 Parse *pParse = pWalker->pParse;
dan8f407622019-12-04 14:26:38 +0000826 int i;
drh35e6cd02021-06-11 13:18:56 +0000827 With *pCopy = 0;
dan26d61e52021-06-11 11:14:24 +0000828 assert( pWith->nCte>0 );
drh35e6cd02021-06-11 13:18:56 +0000829 if( (pWith->a[0].pSelect->selFlags & SF_Expanded)==0 ){
830 /* Push a copy of the With object onto the with-stack. We use a copy
831 ** here as the original will be expanded and resolved (flags SF_Expanded
832 ** and SF_Resolved) below. And the parser code that uses the with-stack
833 ** fails if the Select objects on it have already been expanded and
834 ** resolved. */
835 pCopy = sqlite3WithDup(pParse->db, pWith);
drh24ce9442021-06-12 17:45:32 +0000836 pCopy = sqlite3WithPush(pParse, pCopy, 1);
drh35e6cd02021-06-11 13:18:56 +0000837 }
838 for(i=0; i<pWith->nCte; i++){
839 Select *p = pWith->a[i].pSelect;
840 NameContext sNC;
841 memset(&sNC, 0, sizeof(sNC));
842 sNC.pParse = pParse;
843 if( pCopy ) sqlite3SelectPrep(sNC.pParse, p, &sNC);
dan5a69d192021-09-27 15:44:03 +0000844 if( sNC.pParse->db->mallocFailed ) return;
drh35e6cd02021-06-11 13:18:56 +0000845 sqlite3WalkSelect(pWalker, p);
846 sqlite3RenameExprlistUnmap(pParse, pWith->a[i].pCols);
847 }
848 if( pCopy && pParse->pWith==pCopy ){
dand03d3a92021-06-11 12:14:58 +0000849 pParse->pWith = pCopy->pOuter;
dan26d61e52021-06-11 11:14:24 +0000850 }
dan8f407622019-12-04 14:26:38 +0000851 }
852}
853
854/*
danfb99e382020-04-03 11:20:40 +0000855** Unmap all tokens in the IdList object passed as the second argument.
856*/
857static void unmapColumnIdlistNames(
858 Parse *pParse,
drhb6dad522021-09-24 16:14:47 +0000859 const IdList *pIdList
danfb99e382020-04-03 11:20:40 +0000860){
drhd44f8b22022-04-07 01:11:13 +0000861 int ii;
862 assert( pIdList!=0 );
863 for(ii=0; ii<pIdList->nId; ii++){
864 sqlite3RenameTokenRemap(pParse, 0, (const void*)pIdList->a[ii].zName);
danfb99e382020-04-03 11:20:40 +0000865 }
866}
867
868/*
dan0b277a92019-06-11 12:03:10 +0000869** Walker callback used by sqlite3RenameExprUnmap().
870*/
871static int renameUnmapSelectCb(Walker *pWalker, Select *p){
drhbdf4cf02019-06-15 15:21:49 +0000872 Parse *pParse = pWalker->pParse;
873 int i;
drhd63b69b2019-12-04 15:08:58 +0000874 if( pParse->nErr ) return WRC_Abort;
drh0fbc19e2021-10-17 10:31:09 +0000875 testcase( p->selFlags & SF_View );
876 testcase( p->selFlags & SF_CopyCte );
drhfebf0352021-10-13 14:01:44 +0000877 if( p->selFlags & (SF_View|SF_CopyCte) ){
danac67f562021-06-14 20:08:48 +0000878 return WRC_Prune;
879 }
drhbdf4cf02019-06-15 15:21:49 +0000880 if( ALWAYS(p->pEList) ){
881 ExprList *pList = p->pEList;
882 for(i=0; i<pList->nExpr; i++){
drhd88fd532022-05-02 20:49:30 +0000883 if( pList->a[i].zEName && pList->a[i].fg.eEName==ENAME_NAME ){
drh41cee662019-12-12 20:22:34 +0000884 sqlite3RenameTokenRemap(pParse, 0, (void*)pList->a[i].zEName);
drhbdf4cf02019-06-15 15:21:49 +0000885 }
886 }
887 }
drh2c3f4652019-06-11 16:43:58 +0000888 if( ALWAYS(p->pSrc) ){ /* Every Select as a SrcList, even if it is empty */
drhbdf4cf02019-06-15 15:21:49 +0000889 SrcList *pSrc = p->pSrc;
890 for(i=0; i<pSrc->nSrc; i++){
891 sqlite3RenameTokenRemap(pParse, 0, (void*)pSrc->a[i].zName);
drhd44f8b22022-04-07 01:11:13 +0000892 if( pSrc->a[i].fg.isUsing==0 ){
893 sqlite3WalkExpr(pWalker, pSrc->a[i].u3.pOn);
894 }else{
895 unmapColumnIdlistNames(pParse, pSrc->a[i].u3.pUsing);
896 }
dan0b277a92019-06-11 12:03:10 +0000897 }
898 }
dan8f407622019-12-04 14:26:38 +0000899
900 renameWalkWith(pWalker, p);
dan0b277a92019-06-11 12:03:10 +0000901 return WRC_Continue;
902}
903
904/*
dan8900a482018-09-05 14:36:05 +0000905** Remove all nodes that are part of expression pExpr from the rename list.
906*/
907void sqlite3RenameExprUnmap(Parse *pParse, Expr *pExpr){
dane6dc1e52019-12-05 14:31:43 +0000908 u8 eMode = pParse->eParseMode;
dan8900a482018-09-05 14:36:05 +0000909 Walker sWalker;
910 memset(&sWalker, 0, sizeof(Walker));
911 sWalker.pParse = pParse;
912 sWalker.xExprCallback = renameUnmapExprCb;
dan0b277a92019-06-11 12:03:10 +0000913 sWalker.xSelectCallback = renameUnmapSelectCb;
dane6dc1e52019-12-05 14:31:43 +0000914 pParse->eParseMode = PARSE_MODE_UNMAP;
dan8900a482018-09-05 14:36:05 +0000915 sqlite3WalkExpr(&sWalker, pExpr);
dane6dc1e52019-12-05 14:31:43 +0000916 pParse->eParseMode = eMode;
dan8900a482018-09-05 14:36:05 +0000917}
918
919/*
dane8ab40d2018-09-12 08:51:48 +0000920** Remove all nodes that are part of expression-list pEList from the
921** rename list.
922*/
923void sqlite3RenameExprlistUnmap(Parse *pParse, ExprList *pEList){
924 if( pEList ){
925 int i;
926 Walker sWalker;
927 memset(&sWalker, 0, sizeof(Walker));
928 sWalker.pParse = pParse;
929 sWalker.xExprCallback = renameUnmapExprCb;
930 sqlite3WalkExprList(&sWalker, pEList);
931 for(i=0; i<pEList->nExpr; i++){
drhd88fd532022-05-02 20:49:30 +0000932 if( ALWAYS(pEList->a[i].fg.eEName==ENAME_NAME) ){
drhc4938ea2019-12-13 00:49:42 +0000933 sqlite3RenameTokenRemap(pParse, 0, (void*)pEList->a[i].zEName);
934 }
dane8ab40d2018-09-12 08:51:48 +0000935 }
936 }
937}
938
939/*
drh4a2c7472018-08-13 15:09:48 +0000940** Free the list of RenameToken objects given in the second argument
941*/
dancf8f2892018-08-09 20:47:01 +0000942static void renameTokenFree(sqlite3 *db, RenameToken *pToken){
943 RenameToken *pNext;
944 RenameToken *p;
945 for(p=pToken; p; p=pNext){
946 pNext = p->pNext;
947 sqlite3DbFree(db, p);
948 }
949}
950
dan987db762018-08-14 20:18:50 +0000951/*
952** Search the Parse object passed as the first argument for a RenameToken
dan6e6d9832021-02-16 20:43:36 +0000953** object associated with parse tree element pPtr. If found, return a pointer
954** to it. Otherwise, return NULL.
955**
956** If the second argument passed to this function is not NULL and a matching
957** RenameToken object is found, remove it from the Parse object and add it to
958** the list maintained by the RenameCtx object.
dan987db762018-08-14 20:18:50 +0000959*/
dan6e6d9832021-02-16 20:43:36 +0000960static RenameToken *renameTokenFind(
961 Parse *pParse,
962 struct RenameCtx *pCtx,
drhb6dad522021-09-24 16:14:47 +0000963 const void *pPtr
dan6e6d9832021-02-16 20:43:36 +0000964){
dancf8f2892018-08-09 20:47:01 +0000965 RenameToken **pp;
drh06258a42021-06-04 23:26:56 +0000966 if( NEVER(pPtr==0) ){
drh65b93052021-04-22 16:54:34 +0000967 return 0;
968 }
dancf8f2892018-08-09 20:47:01 +0000969 for(pp=&pParse->pRename; (*pp); pp=&(*pp)->pNext){
970 if( (*pp)->p==pPtr ){
971 RenameToken *pToken = *pp;
dan6e6d9832021-02-16 20:43:36 +0000972 if( pCtx ){
973 *pp = pToken->pNext;
974 pToken->pNext = pCtx->pList;
975 pCtx->pList = pToken;
976 pCtx->nList++;
977 }
978 return pToken;
dancf8f2892018-08-09 20:47:01 +0000979 }
980 }
dan6e6d9832021-02-16 20:43:36 +0000981 return 0;
dancf8f2892018-08-09 20:47:01 +0000982}
983
dan24fedb92018-08-18 17:35:38 +0000984/*
985** This is a Walker select callback. It does nothing. It is only required
986** because without a dummy callback, sqlite3WalkExpr() and similar do not
987** descend into sub-select statements.
988*/
dan987db762018-08-14 20:18:50 +0000989static int renameColumnSelectCb(Walker *pWalker, Select *p){
danac67f562021-06-14 20:08:48 +0000990 if( p->selFlags & (SF_View|SF_CopyCte) ){
drh11e489d2021-06-14 20:49:33 +0000991 testcase( p->selFlags & SF_View );
992 testcase( p->selFlags & SF_CopyCte );
danac67f562021-06-14 20:08:48 +0000993 return WRC_Prune;
994 }
danea412512018-12-05 13:49:04 +0000995 renameWalkWith(pWalker, p);
dan987db762018-08-14 20:18:50 +0000996 return WRC_Continue;
997}
998
dan987db762018-08-14 20:18:50 +0000999/*
1000** This is a Walker expression callback.
1001**
1002** For every TK_COLUMN node in the expression tree, search to see
1003** if the column being references is the column being renamed by an
1004** ALTER TABLE statement. If it is, then attach its associated
1005** RenameToken object to the list of RenameToken objects being
1006** constructed in RenameCtx object at pWalker->u.pRename.
1007*/
dancf8f2892018-08-09 20:47:01 +00001008static int renameColumnExprCb(Walker *pWalker, Expr *pExpr){
dan5496d6a2018-08-13 17:14:26 +00001009 RenameCtx *p = pWalker->u.pRename;
dan0cbb0b12018-08-16 19:49:16 +00001010 if( pExpr->op==TK_TRIGGER
1011 && pExpr->iColumn==p->iCol
1012 && pWalker->pParse->pTriggerTab==p->pTab
1013 ){
dan5be60c52018-08-15 20:28:39 +00001014 renameTokenFind(pWalker->pParse, p, (void*)pExpr);
dan0cbb0b12018-08-16 19:49:16 +00001015 }else if( pExpr->op==TK_COLUMN
drh477572b2021-10-07 20:46:29 +00001016 && pExpr->iColumn==p->iCol
1017 && ALWAYS(ExprUseYTab(pExpr))
drheda079c2018-09-20 19:02:15 +00001018 && p->pTab==pExpr->y.pTab
dan987db762018-08-14 20:18:50 +00001019 ){
dan5496d6a2018-08-13 17:14:26 +00001020 renameTokenFind(pWalker->pParse, p, (void*)pExpr);
dancf8f2892018-08-09 20:47:01 +00001021 }
1022 return WRC_Continue;
1023}
1024
dan987db762018-08-14 20:18:50 +00001025/*
1026** The RenameCtx contains a list of tokens that reference a column that
dan24fedb92018-08-18 17:35:38 +00001027** is being renamed by an ALTER TABLE statement. Return the "last"
dan987db762018-08-14 20:18:50 +00001028** RenameToken in the RenameCtx and remove that RenameToken from the
dan24fedb92018-08-18 17:35:38 +00001029** RenameContext. "Last" means the last RenameToken encountered when
1030** the input SQL is parsed from left to right. Repeated calls to this routine
dan987db762018-08-14 20:18:50 +00001031** return all column name tokens in the order that they are encountered
1032** in the SQL statement.
1033*/
dan5496d6a2018-08-13 17:14:26 +00001034static RenameToken *renameColumnTokenNext(RenameCtx *pCtx){
dancf8f2892018-08-09 20:47:01 +00001035 RenameToken *pBest = pCtx->pList;
1036 RenameToken *pToken;
1037 RenameToken **pp;
1038
1039 for(pToken=pBest->pNext; pToken; pToken=pToken->pNext){
1040 if( pToken->t.z>pBest->t.z ) pBest = pToken;
1041 }
1042 for(pp=&pCtx->pList; *pp!=pBest; pp=&(*pp)->pNext);
1043 *pp = pBest->pNext;
1044
1045 return pBest;
1046}
1047
dan6fe7f232018-08-10 19:19:33 +00001048/*
dan24fedb92018-08-18 17:35:38 +00001049** An error occured while parsing or otherwise processing a database
1050** object (either pParse->pNewTable, pNewIndex or pNewTrigger) as part of an
1051** ALTER TABLE RENAME COLUMN program. The error message emitted by the
1052** sub-routine is currently stored in pParse->zErrMsg. This function
1053** adds context to the error message and then stores it in pCtx.
1054*/
danb0137382018-08-20 20:01:01 +00001055static void renameColumnParseError(
1056 sqlite3_context *pCtx,
dan16953462021-02-18 19:25:44 +00001057 const char *zWhen,
danb0137382018-08-20 20:01:01 +00001058 sqlite3_value *pType,
1059 sqlite3_value *pObject,
1060 Parse *pParse
1061){
drh79a5ee92018-08-23 19:32:04 +00001062 const char *zT = (const char*)sqlite3_value_text(pType);
1063 const char *zN = (const char*)sqlite3_value_text(pObject);
dan24fedb92018-08-18 17:35:38 +00001064 char *zErr;
danb0137382018-08-20 20:01:01 +00001065
drh89e9baa2022-02-06 21:13:59 +00001066 zErr = sqlite3MPrintf(pParse->db, "error in %s %s%s%s: %s",
dan16953462021-02-18 19:25:44 +00001067 zT, zN, (zWhen[0] ? " " : ""), zWhen,
dan0d5fa6b2018-08-24 17:55:49 +00001068 pParse->zErrMsg
1069 );
dan24fedb92018-08-18 17:35:38 +00001070 sqlite3_result_error(pCtx, zErr, -1);
drh89e9baa2022-02-06 21:13:59 +00001071 sqlite3DbFree(pParse->db, zErr);
dan24fedb92018-08-18 17:35:38 +00001072}
1073
1074/*
dan06249392018-08-21 15:06:59 +00001075** For each name in the the expression-list pEList (i.e. each
1076** pEList->a[i].zName) that matches the string in zOld, extract the
1077** corresponding rename-token from Parse object pParse and add it
1078** to the RenameCtx pCtx.
1079*/
1080static void renameColumnElistNames(
1081 Parse *pParse,
1082 RenameCtx *pCtx,
drhb6dad522021-09-24 16:14:47 +00001083 const ExprList *pEList,
dan06249392018-08-21 15:06:59 +00001084 const char *zOld
1085){
1086 if( pEList ){
1087 int i;
1088 for(i=0; i<pEList->nExpr; i++){
drhb6dad522021-09-24 16:14:47 +00001089 const char *zName = pEList->a[i].zEName;
drhd88fd532022-05-02 20:49:30 +00001090 if( ALWAYS(pEList->a[i].fg.eEName==ENAME_NAME)
drh9fc1b9a2020-01-02 22:23:01 +00001091 && ALWAYS(zName!=0)
drhc4938ea2019-12-13 00:49:42 +00001092 && 0==sqlite3_stricmp(zName, zOld)
1093 ){
drhb6dad522021-09-24 16:14:47 +00001094 renameTokenFind(pParse, pCtx, (const void*)zName);
dan06249392018-08-21 15:06:59 +00001095 }
1096 }
1097 }
1098}
1099
1100/*
1101** For each name in the the id-list pIdList (i.e. each pIdList->a[i].zName)
1102** that matches the string in zOld, extract the corresponding rename-token
1103** from Parse object pParse and add it to the RenameCtx pCtx.
1104*/
1105static void renameColumnIdlistNames(
1106 Parse *pParse,
1107 RenameCtx *pCtx,
drhb6dad522021-09-24 16:14:47 +00001108 const IdList *pIdList,
dan06249392018-08-21 15:06:59 +00001109 const char *zOld
1110){
1111 if( pIdList ){
1112 int i;
1113 for(i=0; i<pIdList->nId; i++){
drhb6dad522021-09-24 16:14:47 +00001114 const char *zName = pIdList->a[i].zName;
dan06249392018-08-21 15:06:59 +00001115 if( 0==sqlite3_stricmp(zName, zOld) ){
drhb6dad522021-09-24 16:14:47 +00001116 renameTokenFind(pParse, pCtx, (const void*)zName);
dan06249392018-08-21 15:06:59 +00001117 }
1118 }
1119 }
1120}
1121
danfb99e382020-04-03 11:20:40 +00001122
dandd1a9c82018-09-05 08:28:30 +00001123/*
1124** Parse the SQL statement zSql using Parse object (*p). The Parse object
1125** is initialized by this function before it is used.
1126*/
danc9461ec2018-08-29 21:00:16 +00001127static int renameParseSql(
dandd1a9c82018-09-05 08:28:30 +00001128 Parse *p, /* Memory to use for Parse object */
1129 const char *zDb, /* Name of schema SQL belongs to */
dandd1a9c82018-09-05 08:28:30 +00001130 sqlite3 *db, /* Database handle */
1131 const char *zSql, /* SQL to parse */
1132 int bTemp /* True if SQL is from temp schema */
danc9461ec2018-08-29 21:00:16 +00001133){
1134 int rc;
danc9461ec2018-08-29 21:00:16 +00001135
drhc692df22022-01-24 15:34:55 +00001136 sqlite3ParseObjectInit(p, db);
drhfde30432022-03-10 21:04:49 +00001137 if( zSql==0 ){
1138 return SQLITE_NOMEM;
1139 }
1140 if( sqlite3StrNICmp(zSql,"CREATE ",7)!=0 ){
1141 return SQLITE_CORRUPT_BKPT;
1142 }
1143 db->init.iDb = bTemp ? 1 : sqlite3FindDbName(db, zDb);
dane6dc1e52019-12-05 14:31:43 +00001144 p->eParseMode = PARSE_MODE_RENAME;
danc9461ec2018-08-29 21:00:16 +00001145 p->db = db;
1146 p->nQueryLoop = 1;
drhfde30432022-03-10 21:04:49 +00001147 rc = sqlite3RunParser(p, zSql);
danc9461ec2018-08-29 21:00:16 +00001148 if( db->mallocFailed ) rc = SQLITE_NOMEM;
1149 if( rc==SQLITE_OK
drhfde30432022-03-10 21:04:49 +00001150 && NEVER(p->pNewTable==0 && p->pNewIndex==0 && p->pNewTrigger==0)
danc9461ec2018-08-29 21:00:16 +00001151 ){
1152 rc = SQLITE_CORRUPT_BKPT;
1153 }
1154
1155#ifdef SQLITE_DEBUG
1156 /* Ensure that all mappings in the Parse.pRename list really do map to
1157 ** a part of the input string. */
1158 if( rc==SQLITE_OK ){
1159 int nSql = sqlite3Strlen30(zSql);
1160 RenameToken *pToken;
1161 for(pToken=p->pRename; pToken; pToken=pToken->pNext){
1162 assert( pToken->t.z>=zSql && &pToken->t.z[pToken->t.n]<=&zSql[nSql] );
1163 }
1164 }
1165#endif
1166
1167 db->init.iDb = 0;
1168 return rc;
1169}
1170
dandd1a9c82018-09-05 08:28:30 +00001171/*
1172** This function edits SQL statement zSql, replacing each token identified
1173** by the linked list pRename with the text of zNew. If argument bQuote is
1174** true, then zNew is always quoted first. If no error occurs, the result
1175** is loaded into context object pCtx as the result.
1176**
1177** Or, if an error occurs (i.e. an OOM condition), an error is left in
1178** pCtx and an SQLite error code returned.
1179*/
danc9461ec2018-08-29 21:00:16 +00001180static int renameEditSql(
1181 sqlite3_context *pCtx, /* Return result here */
1182 RenameCtx *pRename, /* Rename context */
1183 const char *zSql, /* SQL statement to edit */
1184 const char *zNew, /* New token text */
1185 int bQuote /* True to always quote token */
1186){
drh236bcdf2021-06-16 11:32:54 +00001187 i64 nNew = sqlite3Strlen30(zNew);
1188 i64 nSql = sqlite3Strlen30(zSql);
danc9461ec2018-08-29 21:00:16 +00001189 sqlite3 *db = sqlite3_context_db_handle(pCtx);
1190 int rc = SQLITE_OK;
dan1e240722021-03-15 20:22:34 +00001191 char *zQuot = 0;
danc9461ec2018-08-29 21:00:16 +00001192 char *zOut;
drh236bcdf2021-06-16 11:32:54 +00001193 i64 nQuot = 0;
dan1e240722021-03-15 20:22:34 +00001194 char *zBuf1 = 0;
1195 char *zBuf2 = 0;
danc9461ec2018-08-29 21:00:16 +00001196
dan1e240722021-03-15 20:22:34 +00001197 if( zNew ){
1198 /* Set zQuot to point to a buffer containing a quoted copy of the
1199 ** identifier zNew. If the corresponding identifier in the original
1200 ** ALTER TABLE statement was quoted (bQuote==1), then set zNew to
1201 ** point to zQuot so that all substitutions are made using the
1202 ** quoted version of the new column name. */
dan1d14ffe2021-03-23 22:15:34 +00001203 zQuot = sqlite3MPrintf(db, "\"%w\" ", zNew);
dan1e240722021-03-15 20:22:34 +00001204 if( zQuot==0 ){
1205 return SQLITE_NOMEM;
1206 }else{
dan1d14ffe2021-03-23 22:15:34 +00001207 nQuot = sqlite3Strlen30(zQuot)-1;
dan1e240722021-03-15 20:22:34 +00001208 }
1209
1210 assert( nQuot>=nNew );
1211 zOut = sqlite3DbMallocZero(db, nSql + pRename->nList*nQuot + 1);
danc9461ec2018-08-29 21:00:16 +00001212 }else{
dan1e240722021-03-15 20:22:34 +00001213 zOut = (char*)sqlite3DbMallocZero(db, (nSql*2+1) * 3);
1214 if( zOut ){
1215 zBuf1 = &zOut[nSql*2+1];
1216 zBuf2 = &zOut[nSql*4+2];
1217 }
danc9461ec2018-08-29 21:00:16 +00001218 }
1219
1220 /* At this point pRename->pList contains a list of RenameToken objects
1221 ** corresponding to all tokens in the input SQL that must be replaced
dan1e240722021-03-15 20:22:34 +00001222 ** with the new column name, or with single-quoted versions of themselves.
1223 ** All that remains is to construct and return the edited SQL string. */
danc9461ec2018-08-29 21:00:16 +00001224 if( zOut ){
1225 int nOut = nSql;
1226 memcpy(zOut, zSql, nSql);
1227 while( pRename->pList ){
1228 int iOff; /* Offset of token to replace in zOut */
danc9461ec2018-08-29 21:00:16 +00001229 u32 nReplace;
1230 const char *zReplace;
dan1e240722021-03-15 20:22:34 +00001231 RenameToken *pBest = renameColumnTokenNext(pRename);
1232
1233 if( zNew ){
dan1d14ffe2021-03-23 22:15:34 +00001234 if( bQuote==0 && sqlite3IsIdChar(*pBest->t.z) ){
dan1e240722021-03-15 20:22:34 +00001235 nReplace = nNew;
1236 zReplace = zNew;
1237 }else{
1238 nReplace = nQuot;
1239 zReplace = zQuot;
dan1d14ffe2021-03-23 22:15:34 +00001240 if( pBest->t.z[pBest->t.n]=='"' ) nReplace++;
dan1e240722021-03-15 20:22:34 +00001241 }
danc9461ec2018-08-29 21:00:16 +00001242 }else{
dan1e240722021-03-15 20:22:34 +00001243 /* Dequote the double-quoted token. Then requote it again, this time
1244 ** using single quotes. If the character immediately following the
1245 ** original token within the input SQL was a single quote ('), then
1246 ** add another space after the new, single-quoted version of the
1247 ** token. This is so that (SELECT "string"'alias') maps to
1248 ** (SELECT 'string' 'alias'), and not (SELECT 'string''alias'). */
1249 memcpy(zBuf1, pBest->t.z, pBest->t.n);
1250 zBuf1[pBest->t.n] = 0;
1251 sqlite3Dequote(zBuf1);
1252 sqlite3_snprintf(nSql*2, zBuf2, "%Q%s", zBuf1,
1253 pBest->t.z[pBest->t.n]=='\'' ? " " : ""
1254 );
1255 zReplace = zBuf2;
1256 nReplace = sqlite3Strlen30(zReplace);
danc9461ec2018-08-29 21:00:16 +00001257 }
1258
1259 iOff = pBest->t.z - zSql;
1260 if( pBest->t.n!=nReplace ){
1261 memmove(&zOut[iOff + nReplace], &zOut[iOff + pBest->t.n],
1262 nOut - (iOff + pBest->t.n)
1263 );
1264 nOut += nReplace - pBest->t.n;
1265 zOut[nOut] = '\0';
1266 }
1267 memcpy(&zOut[iOff], zReplace, nReplace);
1268 sqlite3DbFree(db, pBest);
1269 }
1270
1271 sqlite3_result_text(pCtx, zOut, -1, SQLITE_TRANSIENT);
1272 sqlite3DbFree(db, zOut);
1273 }else{
1274 rc = SQLITE_NOMEM;
1275 }
1276
1277 sqlite3_free(zQuot);
1278 return rc;
1279}
1280
dandd1a9c82018-09-05 08:28:30 +00001281/*
1282** Resolve all symbols in the trigger at pParse->pNewTrigger, assuming
1283** it was read from the schema of database zDb. Return SQLITE_OK if
1284** successful. Otherwise, return an SQLite error code and leave an error
1285** message in the Parse object.
1286*/
drha7c74002020-07-18 18:44:59 +00001287static int renameResolveTrigger(Parse *pParse){
danc9461ec2018-08-29 21:00:16 +00001288 sqlite3 *db = pParse->db;
dand5e6fef2018-09-07 15:50:31 +00001289 Trigger *pNew = pParse->pNewTrigger;
danc9461ec2018-08-29 21:00:16 +00001290 TriggerStep *pStep;
1291 NameContext sNC;
1292 int rc = SQLITE_OK;
1293
1294 memset(&sNC, 0, sizeof(sNC));
1295 sNC.pParse = pParse;
dand5e6fef2018-09-07 15:50:31 +00001296 assert( pNew->pTabSchema );
1297 pParse->pTriggerTab = sqlite3FindTable(db, pNew->table,
1298 db->aDb[sqlite3SchemaToIndex(db, pNew->pTabSchema)].zDbSName
1299 );
1300 pParse->eTriggerOp = pNew->op;
drhf470c372018-10-03 18:05:36 +00001301 /* ALWAYS() because if the table of the trigger does not exist, the
1302 ** error would have been hit before this point */
1303 if( ALWAYS(pParse->pTriggerTab) ){
dan5351e882018-10-01 07:04:12 +00001304 rc = sqlite3ViewGetColumnNames(pParse, pParse->pTriggerTab);
1305 }
danc9461ec2018-08-29 21:00:16 +00001306
1307 /* Resolve symbols in WHEN clause */
dan5351e882018-10-01 07:04:12 +00001308 if( rc==SQLITE_OK && pNew->pWhen ){
dand5e6fef2018-09-07 15:50:31 +00001309 rc = sqlite3ResolveExprNames(&sNC, pNew->pWhen);
danc9461ec2018-08-29 21:00:16 +00001310 }
1311
dand5e6fef2018-09-07 15:50:31 +00001312 for(pStep=pNew->step_list; rc==SQLITE_OK && pStep; pStep=pStep->pNext){
danc9461ec2018-08-29 21:00:16 +00001313 if( pStep->pSelect ){
1314 sqlite3SelectPrep(pParse, pStep->pSelect, &sNC);
1315 if( pParse->nErr ) rc = pParse->rc;
1316 }
dand5e6fef2018-09-07 15:50:31 +00001317 if( rc==SQLITE_OK && pStep->zTarget ){
dane7877b22020-07-14 19:51:01 +00001318 SrcList *pSrc = sqlite3TriggerStepSrc(pParse, pStep);
1319 if( pSrc ){
1320 int i;
drha3e64952020-08-12 16:19:12 +00001321 for(i=0; i<pSrc->nSrc && rc==SQLITE_OK; i++){
drh76012942021-02-21 21:04:54 +00001322 SrcItem *p = &pSrc->a[i];
dane7877b22020-07-14 19:51:01 +00001323 p->iCursor = pParse->nTab++;
dan7a39fae2020-10-31 16:33:01 +00001324 if( p->pSelect ){
1325 sqlite3SelectPrep(pParse, p->pSelect, 0);
1326 sqlite3ExpandSubquery(pParse, p);
1327 assert( i>0 );
1328 assert( pStep->pFrom->a[i-1].pSelect );
1329 sqlite3SelectPrep(pParse, pStep->pFrom->a[i-1].pSelect, 0);
dane7877b22020-07-14 19:51:01 +00001330 }else{
dan7a39fae2020-10-31 16:33:01 +00001331 p->pTab = sqlite3LocateTableItem(pParse, 0, p);
1332 if( p->pTab==0 ){
1333 rc = SQLITE_ERROR;
1334 }else{
1335 p->pTab->nTabRef++;
1336 rc = sqlite3ViewGetColumnNames(pParse, p->pTab);
1337 }
dane7877b22020-07-14 19:51:01 +00001338 }
1339 }
drh61a8ad72021-11-02 17:55:01 +00001340 if( rc==SQLITE_OK && db->mallocFailed ){
1341 rc = SQLITE_NOMEM;
1342 }
dane7877b22020-07-14 19:51:01 +00001343 sNC.pSrcList = pSrc;
1344 if( rc==SQLITE_OK && pStep->pWhere ){
danc9461ec2018-08-29 21:00:16 +00001345 rc = sqlite3ResolveExprNames(&sNC, pStep->pWhere);
1346 }
1347 if( rc==SQLITE_OK ){
1348 rc = sqlite3ResolveExprListNames(&sNC, pStep->pExprList);
1349 }
1350 assert( !pStep->pUpsert || (!pStep->pWhere && !pStep->pExprList) );
drhe58b2b42021-03-08 17:17:38 +00001351 if( pStep->pUpsert && rc==SQLITE_OK ){
danc9461ec2018-08-29 21:00:16 +00001352 Upsert *pUpsert = pStep->pUpsert;
dane7877b22020-07-14 19:51:01 +00001353 pUpsert->pUpsertSrc = pSrc;
danc9461ec2018-08-29 21:00:16 +00001354 sNC.uNC.pUpsert = pUpsert;
1355 sNC.ncFlags = NC_UUpsert;
1356 rc = sqlite3ResolveExprListNames(&sNC, pUpsert->pUpsertTarget);
1357 if( rc==SQLITE_OK ){
1358 ExprList *pUpsertSet = pUpsert->pUpsertSet;
1359 rc = sqlite3ResolveExprListNames(&sNC, pUpsertSet);
1360 }
1361 if( rc==SQLITE_OK ){
1362 rc = sqlite3ResolveExprNames(&sNC, pUpsert->pUpsertWhere);
1363 }
1364 if( rc==SQLITE_OK ){
1365 rc = sqlite3ResolveExprNames(&sNC, pUpsert->pUpsertTargetWhere);
1366 }
1367 sNC.ncFlags = 0;
1368 }
dan0e14e982019-01-18 16:06:18 +00001369 sNC.pSrcList = 0;
dane7877b22020-07-14 19:51:01 +00001370 sqlite3SrcListDelete(db, pSrc);
1371 }else{
1372 rc = SQLITE_NOMEM;
danc9461ec2018-08-29 21:00:16 +00001373 }
1374 }
1375 }
1376 return rc;
1377}
1378
dandd1a9c82018-09-05 08:28:30 +00001379/*
1380** Invoke sqlite3WalkExpr() or sqlite3WalkSelect() on all Select or Expr
1381** objects that are part of the trigger passed as the second argument.
1382*/
danc9461ec2018-08-29 21:00:16 +00001383static void renameWalkTrigger(Walker *pWalker, Trigger *pTrigger){
1384 TriggerStep *pStep;
1385
1386 /* Find tokens to edit in WHEN clause */
1387 sqlite3WalkExpr(pWalker, pTrigger->pWhen);
1388
1389 /* Find tokens to edit in trigger steps */
1390 for(pStep=pTrigger->step_list; pStep; pStep=pStep->pNext){
1391 sqlite3WalkSelect(pWalker, pStep->pSelect);
1392 sqlite3WalkExpr(pWalker, pStep->pWhere);
1393 sqlite3WalkExprList(pWalker, pStep->pExprList);
1394 if( pStep->pUpsert ){
1395 Upsert *pUpsert = pStep->pUpsert;
1396 sqlite3WalkExprList(pWalker, pUpsert->pUpsertTarget);
1397 sqlite3WalkExprList(pWalker, pUpsert->pUpsertSet);
1398 sqlite3WalkExpr(pWalker, pUpsert->pUpsertWhere);
1399 sqlite3WalkExpr(pWalker, pUpsert->pUpsertTargetWhere);
1400 }
dan7a39fae2020-10-31 16:33:01 +00001401 if( pStep->pFrom ){
1402 int i;
1403 for(i=0; i<pStep->pFrom->nSrc; i++){
1404 sqlite3WalkSelect(pWalker, pStep->pFrom->a[i].pSelect);
1405 }
1406 }
danc9461ec2018-08-29 21:00:16 +00001407 }
1408}
1409
dandd1a9c82018-09-05 08:28:30 +00001410/*
1411** Free the contents of Parse object (*pParse). Do not free the memory
1412** occupied by the Parse object itself.
1413*/
dan141e1192018-08-31 18:23:53 +00001414static void renameParseCleanup(Parse *pParse){
1415 sqlite3 *db = pParse->db;
drh885eeb62019-01-09 02:02:24 +00001416 Index *pIdx;
dan141e1192018-08-31 18:23:53 +00001417 if( pParse->pVdbe ){
1418 sqlite3VdbeFinalize(pParse->pVdbe);
1419 }
1420 sqlite3DeleteTable(db, pParse->pNewTable);
drh885eeb62019-01-09 02:02:24 +00001421 while( (pIdx = pParse->pNewIndex)!=0 ){
1422 pParse->pNewIndex = pIdx->pNext;
1423 sqlite3FreeIndex(db, pIdx);
1424 }
dan141e1192018-08-31 18:23:53 +00001425 sqlite3DeleteTrigger(db, pParse->pNewTrigger);
1426 sqlite3DbFree(db, pParse->zErrMsg);
1427 renameTokenFree(db, pParse->pRename);
drhc692df22022-01-24 15:34:55 +00001428 sqlite3ParseObjectReset(pParse);
dan141e1192018-08-31 18:23:53 +00001429}
1430
dan06249392018-08-21 15:06:59 +00001431/*
dan987db762018-08-14 20:18:50 +00001432** SQL function:
1433**
drh5a800502022-02-04 16:43:30 +00001434** sqlite_rename_column(SQL,TYPE,OBJ,DB,TABLE,COL,NEWNAME,QUOTE,TEMP)
dan987db762018-08-14 20:18:50 +00001435**
1436** 0. zSql: SQL statement to rewrite
danb0137382018-08-20 20:01:01 +00001437** 1. type: Type of object ("table", "view" etc.)
1438** 2. object: Name of object
1439** 3. Database: Database name (e.g. "main")
1440** 4. Table: Table name
1441** 5. iCol: Index of column to rename
1442** 6. zNew: New column name
dan9d324822018-08-30 20:03:44 +00001443** 7. bQuote: Non-zero if the new column name should be quoted.
danb87a9a82018-09-01 20:23:28 +00001444** 8. bTemp: True if zSql comes from temp schema
dan987db762018-08-14 20:18:50 +00001445**
1446** Do a column rename operation on the CREATE statement given in zSql.
1447** The iCol-th column (left-most is 0) of table zTable is renamed from zCol
1448** into zNew. The name should be quoted if bQuote is true.
1449**
1450** This function is used internally by the ALTER TABLE RENAME COLUMN command.
drheea8eb62018-11-26 18:09:15 +00001451** It is only accessible to SQL created using sqlite3NestedParse(). It is
drh5a800502022-02-04 16:43:30 +00001452** not reachable from ordinary SQL passed into sqlite3_prepare() unless the
1453** SQLITE_TESTCTRL_INTERNAL_FUNCTIONS test setting is enabled.
dan6fe7f232018-08-10 19:19:33 +00001454*/
dancf8f2892018-08-09 20:47:01 +00001455static void renameColumnFunc(
1456 sqlite3_context *context,
1457 int NotUsed,
1458 sqlite3_value **argv
1459){
1460 sqlite3 *db = sqlite3_context_db_handle(context);
dan5496d6a2018-08-13 17:14:26 +00001461 RenameCtx sCtx;
drhad866a12018-08-10 19:33:09 +00001462 const char *zSql = (const char*)sqlite3_value_text(argv[0]);
danb0137382018-08-20 20:01:01 +00001463 const char *zDb = (const char*)sqlite3_value_text(argv[3]);
1464 const char *zTable = (const char*)sqlite3_value_text(argv[4]);
1465 int iCol = sqlite3_value_int(argv[5]);
1466 const char *zNew = (const char*)sqlite3_value_text(argv[6]);
danb0137382018-08-20 20:01:01 +00001467 int bQuote = sqlite3_value_int(argv[7]);
danb87a9a82018-09-01 20:23:28 +00001468 int bTemp = sqlite3_value_int(argv[8]);
dan987db762018-08-14 20:18:50 +00001469 const char *zOld;
dancf8f2892018-08-09 20:47:01 +00001470 int rc;
dancf8f2892018-08-09 20:47:01 +00001471 Parse sParse;
1472 Walker sWalker;
dancf8f2892018-08-09 20:47:01 +00001473 Index *pIdx;
dancf8f2892018-08-09 20:47:01 +00001474 int i;
dan987db762018-08-14 20:18:50 +00001475 Table *pTab;
dan141e1192018-08-31 18:23:53 +00001476#ifndef SQLITE_OMIT_AUTHORIZATION
1477 sqlite3_xauth xAuth = db->xAuth;
1478#endif
dancf8f2892018-08-09 20:47:01 +00001479
drh38d99642018-08-18 18:27:18 +00001480 UNUSED_PARAMETER(NotUsed);
dan987db762018-08-14 20:18:50 +00001481 if( zSql==0 ) return;
dan987db762018-08-14 20:18:50 +00001482 if( zTable==0 ) return;
danb0137382018-08-20 20:01:01 +00001483 if( zNew==0 ) return;
dan987db762018-08-14 20:18:50 +00001484 if( iCol<0 ) return;
drhda76adc2018-08-25 02:04:05 +00001485 sqlite3BtreeEnterAll(db);
dan987db762018-08-14 20:18:50 +00001486 pTab = sqlite3FindTable(db, zTable, zDb);
drhda76adc2018-08-25 02:04:05 +00001487 if( pTab==0 || iCol>=pTab->nCol ){
1488 sqlite3BtreeLeaveAll(db);
1489 return;
1490 }
drhcf9d36d2021-08-02 18:03:43 +00001491 zOld = pTab->aCol[iCol].zCnName;
dancf8f2892018-08-09 20:47:01 +00001492 memset(&sCtx, 0, sizeof(sCtx));
dan987db762018-08-14 20:18:50 +00001493 sCtx.iCol = ((iCol==pTab->iPKey) ? -1 : iCol);
dancf8f2892018-08-09 20:47:01 +00001494
dan141e1192018-08-31 18:23:53 +00001495#ifndef SQLITE_OMIT_AUTHORIZATION
1496 db->xAuth = 0;
1497#endif
drhb2ab3dc2019-12-20 14:08:34 +00001498 rc = renameParseSql(&sParse, zDb, db, zSql, bTemp);
dan24fedb92018-08-18 17:35:38 +00001499
dancf8f2892018-08-09 20:47:01 +00001500 /* Find tokens that need to be replaced. */
1501 memset(&sWalker, 0, sizeof(Walker));
1502 sWalker.pParse = &sParse;
1503 sWalker.xExprCallback = renameColumnExprCb;
dan987db762018-08-14 20:18:50 +00001504 sWalker.xSelectCallback = renameColumnSelectCb;
dancf8f2892018-08-09 20:47:01 +00001505 sWalker.u.pRename = &sCtx;
1506
dan0cbb0b12018-08-16 19:49:16 +00001507 sCtx.pTab = pTab;
dan987db762018-08-14 20:18:50 +00001508 if( rc!=SQLITE_OK ) goto renameColumnFunc_done;
dancf8f2892018-08-09 20:47:01 +00001509 if( sParse.pNewTable ){
drhf38524d2021-08-02 16:41:57 +00001510 if( IsView(sParse.pNewTable) ){
1511 Select *pSelect = sParse.pNewTable->u.view.pSelect;
dan38096962019-12-09 08:13:43 +00001512 pSelect->selFlags &= ~SF_View;
dan987db762018-08-14 20:18:50 +00001513 sParse.rc = SQLITE_OK;
dan38096962019-12-09 08:13:43 +00001514 sqlite3SelectPrep(&sParse, pSelect, 0);
dan987db762018-08-14 20:18:50 +00001515 rc = (db->mallocFailed ? SQLITE_NOMEM : sParse.rc);
1516 if( rc==SQLITE_OK ){
1517 sqlite3WalkSelect(&sWalker, pSelect);
dana8762ae2018-08-11 17:49:23 +00001518 }
dan987db762018-08-14 20:18:50 +00001519 if( rc!=SQLITE_OK ) goto renameColumnFunc_done;
drhe73e9572021-09-16 13:20:29 +00001520 }else if( IsOrdinaryTable(sParse.pNewTable) ){
dan987db762018-08-14 20:18:50 +00001521 /* A regular table */
1522 int bFKOnly = sqlite3_stricmp(zTable, sParse.pNewTable->zName);
1523 FKey *pFKey;
dan0cbb0b12018-08-16 19:49:16 +00001524 sCtx.pTab = sParse.pNewTable;
dan987db762018-08-14 20:18:50 +00001525 if( bFKOnly==0 ){
drh06258a42021-06-04 23:26:56 +00001526 if( iCol<sParse.pNewTable->nCol ){
1527 renameTokenFind(
drhcf9d36d2021-08-02 18:03:43 +00001528 &sParse, &sCtx, (void*)sParse.pNewTable->aCol[iCol].zCnName
drh06258a42021-06-04 23:26:56 +00001529 );
1530 }
dan987db762018-08-14 20:18:50 +00001531 if( sCtx.iCol<0 ){
1532 renameTokenFind(&sParse, &sCtx, (void*)&sParse.pNewTable->iPKey);
dancf8f2892018-08-09 20:47:01 +00001533 }
dan987db762018-08-14 20:18:50 +00001534 sqlite3WalkExprList(&sWalker, sParse.pNewTable->pCheck);
1535 for(pIdx=sParse.pNewTable->pIndex; pIdx; pIdx=pIdx->pNext){
1536 sqlite3WalkExprList(&sWalker, pIdx->aColExpr);
1537 }
drh885eeb62019-01-09 02:02:24 +00001538 for(pIdx=sParse.pNewIndex; pIdx; pIdx=pIdx->pNext){
1539 sqlite3WalkExprList(&sWalker, pIdx->aColExpr);
1540 }
drhb9bcf7c2019-10-19 13:29:10 +00001541#ifndef SQLITE_OMIT_GENERATED_COLUMNS
dan776a5782021-03-16 11:11:07 +00001542 for(i=0; i<sParse.pNewTable->nCol; i++){
drh79cf2b72021-07-31 20:30:41 +00001543 Expr *pExpr = sqlite3ColumnExpr(sParse.pNewTable,
1544 &sParse.pNewTable->aCol[i]);
1545 sqlite3WalkExpr(&sWalker, pExpr);
dan776a5782021-03-16 11:11:07 +00001546 }
drhb9bcf7c2019-10-19 13:29:10 +00001547#endif
dan776a5782021-03-16 11:11:07 +00001548 }
dan987db762018-08-14 20:18:50 +00001549
drh78b2fa82021-10-07 12:11:20 +00001550 assert( IsOrdinaryTable(sParse.pNewTable) );
drhf38524d2021-08-02 16:41:57 +00001551 for(pFKey=sParse.pNewTable->u.tab.pFKey; pFKey; pFKey=pFKey->pNextFrom){
dan987db762018-08-14 20:18:50 +00001552 for(i=0; i<pFKey->nCol; i++){
dan356afab2018-08-14 21:05:35 +00001553 if( bFKOnly==0 && pFKey->aCol[i].iFrom==iCol ){
dan987db762018-08-14 20:18:50 +00001554 renameTokenFind(&sParse, &sCtx, (void*)&pFKey->aCol[i]);
1555 }
1556 if( 0==sqlite3_stricmp(pFKey->zTo, zTable)
1557 && 0==sqlite3_stricmp(pFKey->aCol[i].zCol, zOld)
1558 ){
1559 renameTokenFind(&sParse, &sCtx, (void*)pFKey->aCol[i].zCol);
1560 }
dan6fe7f232018-08-10 19:19:33 +00001561 }
dancf8f2892018-08-09 20:47:01 +00001562 }
1563 }
dan5496d6a2018-08-13 17:14:26 +00001564 }else if( sParse.pNewIndex ){
dancf8f2892018-08-09 20:47:01 +00001565 sqlite3WalkExprList(&sWalker, sParse.pNewIndex->aColExpr);
1566 sqlite3WalkExpr(&sWalker, sParse.pNewIndex->pPartIdxWhere);
dan5496d6a2018-08-13 17:14:26 +00001567 }else{
dan5be60c52018-08-15 20:28:39 +00001568 /* A trigger */
1569 TriggerStep *pStep;
drha7c74002020-07-18 18:44:59 +00001570 rc = renameResolveTrigger(&sParse);
danc9461ec2018-08-29 21:00:16 +00001571 if( rc!=SQLITE_OK ) goto renameColumnFunc_done;
dan5be60c52018-08-15 20:28:39 +00001572
danc9461ec2018-08-29 21:00:16 +00001573 for(pStep=sParse.pNewTrigger->step_list; pStep; pStep=pStep->pNext){
1574 if( pStep->zTarget ){
dan06249392018-08-21 15:06:59 +00001575 Table *pTarget = sqlite3LocateTable(&sParse, 0, pStep->zTarget, zDb);
danc9461ec2018-08-29 21:00:16 +00001576 if( pTarget==pTab ){
dan0cbb0b12018-08-16 19:49:16 +00001577 if( pStep->pUpsert ){
danc9461ec2018-08-29 21:00:16 +00001578 ExprList *pUpsertSet = pStep->pUpsert->pUpsertSet;
1579 renameColumnElistNames(&sParse, &sCtx, pUpsertSet, zOld);
dan0cbb0b12018-08-16 19:49:16 +00001580 }
danc9461ec2018-08-29 21:00:16 +00001581 renameColumnIdlistNames(&sParse, &sCtx, pStep->pIdList, zOld);
1582 renameColumnElistNames(&sParse, &sCtx, pStep->pExprList, zOld);
dan5be60c52018-08-15 20:28:39 +00001583 }
1584 }
1585 }
1586
dan5be60c52018-08-15 20:28:39 +00001587
1588 /* Find tokens to edit in UPDATE OF clause */
dan06249392018-08-21 15:06:59 +00001589 if( sParse.pTriggerTab==pTab ){
1590 renameColumnIdlistNames(&sParse, &sCtx,sParse.pNewTrigger->pColumns,zOld);
dan5496d6a2018-08-13 17:14:26 +00001591 }
dan5be60c52018-08-15 20:28:39 +00001592
danc9461ec2018-08-29 21:00:16 +00001593 /* Find tokens to edit in various expressions and selects */
1594 renameWalkTrigger(&sWalker, sParse.pNewTrigger);
dancf8f2892018-08-09 20:47:01 +00001595 }
1596
dan987db762018-08-14 20:18:50 +00001597 assert( rc==SQLITE_OK );
danc9461ec2018-08-29 21:00:16 +00001598 rc = renameEditSql(context, &sCtx, zSql, zNew, bQuote);
dancf8f2892018-08-09 20:47:01 +00001599
drh5fc22cd2018-08-13 13:43:11 +00001600renameColumnFunc_done:
dan987db762018-08-14 20:18:50 +00001601 if( rc!=SQLITE_OK ){
drh89e9baa2022-02-06 21:13:59 +00001602 if( rc==SQLITE_ERROR && sqlite3WritableSchema(db) ){
drh5a800502022-02-04 16:43:30 +00001603 sqlite3_result_value(context, argv[0]);
1604 }else if( sParse.zErrMsg ){
dan16953462021-02-18 19:25:44 +00001605 renameColumnParseError(context, "", argv[1], argv[2], &sParse);
dan987db762018-08-14 20:18:50 +00001606 }else{
1607 sqlite3_result_error_code(context, rc);
1608 }
1609 }
1610
dan141e1192018-08-31 18:23:53 +00001611 renameParseCleanup(&sParse);
drh4a2c7472018-08-13 15:09:48 +00001612 renameTokenFree(db, sCtx.pList);
dan141e1192018-08-31 18:23:53 +00001613#ifndef SQLITE_OMIT_AUTHORIZATION
1614 db->xAuth = xAuth;
1615#endif
drhda76adc2018-08-25 02:04:05 +00001616 sqlite3BtreeLeaveAll(db);
dancf8f2892018-08-09 20:47:01 +00001617}
1618
dandd1a9c82018-09-05 08:28:30 +00001619/*
1620** Walker expression callback used by "RENAME TABLE".
1621*/
danc9461ec2018-08-29 21:00:16 +00001622static int renameTableExprCb(Walker *pWalker, Expr *pExpr){
1623 RenameCtx *p = pWalker->u.pRename;
drh477572b2021-10-07 20:46:29 +00001624 if( pExpr->op==TK_COLUMN
1625 && ALWAYS(ExprUseYTab(pExpr))
1626 && p->pTab==pExpr->y.pTab
1627 ){
drheda079c2018-09-20 19:02:15 +00001628 renameTokenFind(pWalker->pParse, p, (void*)&pExpr->y.pTab);
danc9461ec2018-08-29 21:00:16 +00001629 }
1630 return WRC_Continue;
1631}
1632
1633/*
dandd1a9c82018-09-05 08:28:30 +00001634** Walker select callback used by "RENAME TABLE".
danc9461ec2018-08-29 21:00:16 +00001635*/
1636static int renameTableSelectCb(Walker *pWalker, Select *pSelect){
1637 int i;
1638 RenameCtx *p = pWalker->u.pRename;
1639 SrcList *pSrc = pSelect->pSrc;
danac67f562021-06-14 20:08:48 +00001640 if( pSelect->selFlags & (SF_View|SF_CopyCte) ){
1641 testcase( pSelect->selFlags & SF_View );
1642 testcase( pSelect->selFlags & SF_CopyCte );
1643 return WRC_Prune;
1644 }
drh9da977f2021-04-20 12:14:12 +00001645 if( NEVER(pSrc==0) ){
drh92a28242019-10-09 15:37:58 +00001646 assert( pWalker->pParse->db->mallocFailed );
drh974b2482018-12-06 01:53:12 +00001647 return WRC_Abort;
1648 }
danc9461ec2018-08-29 21:00:16 +00001649 for(i=0; i<pSrc->nSrc; i++){
drh76012942021-02-21 21:04:54 +00001650 SrcItem *pItem = &pSrc->a[i];
danc9461ec2018-08-29 21:00:16 +00001651 if( pItem->pTab==p->pTab ){
1652 renameTokenFind(pWalker->pParse, p, pItem->zName);
1653 }
1654 }
danea412512018-12-05 13:49:04 +00001655 renameWalkWith(pWalker, pSelect);
danc9461ec2018-08-29 21:00:16 +00001656
1657 return WRC_Continue;
1658}
1659
1660
1661/*
1662** This C function implements an SQL user function that is used by SQL code
1663** generated by the ALTER TABLE ... RENAME command to modify the definition
1664** of any foreign key constraints that use the table being renamed as the
1665** parent table. It is passed three arguments:
1666**
dan141e1192018-08-31 18:23:53 +00001667** 0: The database containing the table being renamed.
dan65372fa2018-09-03 20:05:15 +00001668** 1. type: Type of object ("table", "view" etc.)
1669** 2. object: Name of object
1670** 3: The complete text of the schema statement being modified,
1671** 4: The old name of the table being renamed, and
1672** 5: The new name of the table being renamed.
1673** 6: True if the schema statement comes from the temp db.
danc9461ec2018-08-29 21:00:16 +00001674**
dan141e1192018-08-31 18:23:53 +00001675** It returns the new schema statement. For example:
danc9461ec2018-08-29 21:00:16 +00001676**
dan141e1192018-08-31 18:23:53 +00001677** sqlite_rename_table('main', 'CREATE TABLE t1(a REFERENCES t2)','t2','t3',0)
danc9461ec2018-08-29 21:00:16 +00001678** -> 'CREATE TABLE t1(a REFERENCES t3)'
1679*/
1680static void renameTableFunc(
1681 sqlite3_context *context,
1682 int NotUsed,
1683 sqlite3_value **argv
1684){
1685 sqlite3 *db = sqlite3_context_db_handle(context);
drh5b1da302018-09-01 20:02:07 +00001686 const char *zDb = (const char*)sqlite3_value_text(argv[0]);
dan65372fa2018-09-03 20:05:15 +00001687 const char *zInput = (const char*)sqlite3_value_text(argv[3]);
1688 const char *zOld = (const char*)sqlite3_value_text(argv[4]);
1689 const char *zNew = (const char*)sqlite3_value_text(argv[5]);
1690 int bTemp = sqlite3_value_int(argv[6]);
drh5b1da302018-09-01 20:02:07 +00001691 UNUSED_PARAMETER(NotUsed);
danc9461ec2018-08-29 21:00:16 +00001692
dan141e1192018-08-31 18:23:53 +00001693 if( zInput && zOld && zNew ){
dan141e1192018-08-31 18:23:53 +00001694 Parse sParse;
1695 int rc;
1696 int bQuote = 1;
1697 RenameCtx sCtx;
1698 Walker sWalker;
danc9461ec2018-08-29 21:00:16 +00001699
dan141e1192018-08-31 18:23:53 +00001700#ifndef SQLITE_OMIT_AUTHORIZATION
1701 sqlite3_xauth xAuth = db->xAuth;
1702 db->xAuth = 0;
danc9461ec2018-08-29 21:00:16 +00001703#endif
1704
dan141e1192018-08-31 18:23:53 +00001705 sqlite3BtreeEnterAll(db);
1706
1707 memset(&sCtx, 0, sizeof(RenameCtx));
1708 sCtx.pTab = sqlite3FindTable(db, zOld, zDb);
1709 memset(&sWalker, 0, sizeof(Walker));
1710 sWalker.pParse = &sParse;
1711 sWalker.xExprCallback = renameTableExprCb;
1712 sWalker.xSelectCallback = renameTableSelectCb;
1713 sWalker.u.pRename = &sCtx;
1714
drhb2ab3dc2019-12-20 14:08:34 +00001715 rc = renameParseSql(&sParse, zDb, db, zInput, bTemp);
dan141e1192018-08-31 18:23:53 +00001716
1717 if( rc==SQLITE_OK ){
dan674b8942018-09-20 08:28:01 +00001718 int isLegacy = (db->flags & SQLITE_LegacyAlter);
dan141e1192018-08-31 18:23:53 +00001719 if( sParse.pNewTable ){
1720 Table *pTab = sParse.pNewTable;
1721
drhf38524d2021-08-02 16:41:57 +00001722 if( IsView(pTab) ){
dan674b8942018-09-20 08:28:01 +00001723 if( isLegacy==0 ){
drhf38524d2021-08-02 16:41:57 +00001724 Select *pSelect = pTab->u.view.pSelect;
dan674b8942018-09-20 08:28:01 +00001725 NameContext sNC;
1726 memset(&sNC, 0, sizeof(sNC));
1727 sNC.pParse = &sParse;
dan141e1192018-08-31 18:23:53 +00001728
dan38096962019-12-09 08:13:43 +00001729 assert( pSelect->selFlags & SF_View );
1730 pSelect->selFlags &= ~SF_View;
drhf38524d2021-08-02 16:41:57 +00001731 sqlite3SelectPrep(&sParse, pTab->u.view.pSelect, &sNC);
drh1548d522019-12-20 12:55:21 +00001732 if( sParse.nErr ){
1733 rc = sParse.rc;
1734 }else{
drhf38524d2021-08-02 16:41:57 +00001735 sqlite3WalkSelect(&sWalker, pTab->u.view.pSelect);
drh1548d522019-12-20 12:55:21 +00001736 }
dan674b8942018-09-20 08:28:01 +00001737 }
dan141e1192018-08-31 18:23:53 +00001738 }else{
1739 /* Modify any FK definitions to point to the new table. */
1740#ifndef SQLITE_OMIT_FOREIGN_KEY
drhf38524d2021-08-02 16:41:57 +00001741 if( (isLegacy==0 || (db->flags & SQLITE_ForeignKeys))
1742 && !IsVirtual(pTab)
1743 ){
dan202a0272018-09-07 11:51:21 +00001744 FKey *pFKey;
drh78b2fa82021-10-07 12:11:20 +00001745 assert( IsOrdinaryTable(pTab) );
drhf38524d2021-08-02 16:41:57 +00001746 for(pFKey=pTab->u.tab.pFKey; pFKey; pFKey=pFKey->pNextFrom){
dan202a0272018-09-07 11:51:21 +00001747 if( sqlite3_stricmp(pFKey->zTo, zOld)==0 ){
1748 renameTokenFind(&sParse, &sCtx, (void*)pFKey->zTo);
1749 }
dan141e1192018-08-31 18:23:53 +00001750 }
1751 }
1752#endif
1753
1754 /* If this is the table being altered, fix any table refs in CHECK
1755 ** expressions. Also update the name that appears right after the
1756 ** "CREATE [VIRTUAL] TABLE" bit. */
1757 if( sqlite3_stricmp(zOld, pTab->zName)==0 ){
1758 sCtx.pTab = pTab;
dan674b8942018-09-20 08:28:01 +00001759 if( isLegacy==0 ){
1760 sqlite3WalkExprList(&sWalker, pTab->pCheck);
1761 }
dan141e1192018-08-31 18:23:53 +00001762 renameTokenFind(&sParse, &sCtx, pTab->zName);
1763 }
danc9461ec2018-08-29 21:00:16 +00001764 }
1765 }
danc9461ec2018-08-29 21:00:16 +00001766
dan141e1192018-08-31 18:23:53 +00001767 else if( sParse.pNewIndex ){
1768 renameTokenFind(&sParse, &sCtx, sParse.pNewIndex->zName);
dan674b8942018-09-20 08:28:01 +00001769 if( isLegacy==0 ){
1770 sqlite3WalkExpr(&sWalker, sParse.pNewIndex->pPartIdxWhere);
1771 }
dan141e1192018-08-31 18:23:53 +00001772 }
danc9461ec2018-08-29 21:00:16 +00001773
1774#ifndef SQLITE_OMIT_TRIGGER
danb87a9a82018-09-01 20:23:28 +00001775 else{
dan141e1192018-08-31 18:23:53 +00001776 Trigger *pTrigger = sParse.pNewTrigger;
1777 TriggerStep *pStep;
1778 if( 0==sqlite3_stricmp(sParse.pNewTrigger->table, zOld)
1779 && sCtx.pTab->pSchema==pTrigger->pTabSchema
1780 ){
1781 renameTokenFind(&sParse, &sCtx, sParse.pNewTrigger->table);
1782 }
danc9461ec2018-08-29 21:00:16 +00001783
dan674b8942018-09-20 08:28:01 +00001784 if( isLegacy==0 ){
drha7c74002020-07-18 18:44:59 +00001785 rc = renameResolveTrigger(&sParse);
dan674b8942018-09-20 08:28:01 +00001786 if( rc==SQLITE_OK ){
1787 renameWalkTrigger(&sWalker, pTrigger);
1788 for(pStep=pTrigger->step_list; pStep; pStep=pStep->pNext){
1789 if( pStep->zTarget && 0==sqlite3_stricmp(pStep->zTarget, zOld) ){
1790 renameTokenFind(&sParse, &sCtx, pStep->zTarget);
1791 }
dan141e1192018-08-31 18:23:53 +00001792 }
dan0ccda962018-08-30 16:26:48 +00001793 }
danc9461ec2018-08-29 21:00:16 +00001794 }
1795 }
dan141e1192018-08-31 18:23:53 +00001796#endif
danc9461ec2018-08-29 21:00:16 +00001797 }
dan141e1192018-08-31 18:23:53 +00001798
1799 if( rc==SQLITE_OK ){
1800 rc = renameEditSql(context, &sCtx, zInput, zNew, bQuote);
1801 }
1802 if( rc!=SQLITE_OK ){
drh89e9baa2022-02-06 21:13:59 +00001803 if( rc==SQLITE_ERROR && sqlite3WritableSchema(db) ){
drh10d29c72022-02-04 20:07:24 +00001804 sqlite3_result_value(context, argv[3]);
1805 }else if( sParse.zErrMsg ){
dan16953462021-02-18 19:25:44 +00001806 renameColumnParseError(context, "", argv[1], argv[2], &sParse);
dan65372fa2018-09-03 20:05:15 +00001807 }else{
1808 sqlite3_result_error_code(context, rc);
1809 }
dan141e1192018-08-31 18:23:53 +00001810 }
1811
1812 renameParseCleanup(&sParse);
1813 renameTokenFree(db, sCtx.pList);
1814 sqlite3BtreeLeaveAll(db);
1815#ifndef SQLITE_OMIT_AUTHORIZATION
1816 db->xAuth = xAuth;
danc9461ec2018-08-29 21:00:16 +00001817#endif
1818 }
1819
danc9461ec2018-08-29 21:00:16 +00001820 return;
1821}
1822
dan1e240722021-03-15 20:22:34 +00001823static int renameQuotefixExprCb(Walker *pWalker, Expr *pExpr){
1824 if( pExpr->op==TK_STRING && (pExpr->flags & EP_DblQuoted) ){
drhb6dad522021-09-24 16:14:47 +00001825 renameTokenFind(pWalker->pParse, pWalker->u.pRename, (const void*)pExpr);
dan1e240722021-03-15 20:22:34 +00001826 }
1827 return WRC_Continue;
1828}
1829
drh5a800502022-02-04 16:43:30 +00001830/* SQL function: sqlite_rename_quotefix(DB,SQL)
1831**
1832** Rewrite the DDL statement "SQL" so that any string literals that use
1833** double-quotes use single quotes instead.
dan1e240722021-03-15 20:22:34 +00001834**
1835** Two arguments must be passed:
1836**
1837** 0: Database name ("main", "temp" etc.).
1838** 1: SQL statement to edit.
1839**
1840** The returned value is the modified SQL statement. For example, given
1841** the database schema:
1842**
1843** CREATE TABLE t1(a, b, c);
1844**
1845** SELECT sqlite_rename_quotefix('main',
1846** 'CREATE VIEW v1 AS SELECT "a", "string" FROM t1'
1847** );
1848**
1849** returns the string:
1850**
1851** CREATE VIEW v1 AS SELECT "a", 'string' FROM t1
drh5a800502022-02-04 16:43:30 +00001852**
1853** If there is a error in the input SQL, then raise an error, except
1854** if PRAGMA writable_schema=ON, then just return the input string
1855** unmodified following an error.
dan1e240722021-03-15 20:22:34 +00001856*/
1857static void renameQuotefixFunc(
1858 sqlite3_context *context,
1859 int NotUsed,
1860 sqlite3_value **argv
1861){
1862 sqlite3 *db = sqlite3_context_db_handle(context);
1863 char const *zDb = (const char*)sqlite3_value_text(argv[0]);
1864 char const *zInput = (const char*)sqlite3_value_text(argv[1]);
1865
1866#ifndef SQLITE_OMIT_AUTHORIZATION
1867 sqlite3_xauth xAuth = db->xAuth;
1868 db->xAuth = 0;
1869#endif
1870
1871 sqlite3BtreeEnterAll(db);
1872
1873 UNUSED_PARAMETER(NotUsed);
1874 if( zDb && zInput ){
1875 int rc;
1876 Parse sParse;
1877 rc = renameParseSql(&sParse, zDb, db, zInput, 0);
1878
1879 if( rc==SQLITE_OK ){
1880 RenameCtx sCtx;
1881 Walker sWalker;
1882
1883 /* Walker to find tokens that need to be replaced. */
1884 memset(&sCtx, 0, sizeof(RenameCtx));
1885 memset(&sWalker, 0, sizeof(Walker));
1886 sWalker.pParse = &sParse;
1887 sWalker.xExprCallback = renameQuotefixExprCb;
1888 sWalker.xSelectCallback = renameColumnSelectCb;
1889 sWalker.u.pRename = &sCtx;
1890
1891 if( sParse.pNewTable ){
drhf38524d2021-08-02 16:41:57 +00001892 if( IsView(sParse.pNewTable) ){
1893 Select *pSelect = sParse.pNewTable->u.view.pSelect;
dan1e240722021-03-15 20:22:34 +00001894 pSelect->selFlags &= ~SF_View;
1895 sParse.rc = SQLITE_OK;
1896 sqlite3SelectPrep(&sParse, pSelect, 0);
1897 rc = (db->mallocFailed ? SQLITE_NOMEM : sParse.rc);
1898 if( rc==SQLITE_OK ){
1899 sqlite3WalkSelect(&sWalker, pSelect);
1900 }
1901 }else{
1902 int i;
1903 sqlite3WalkExprList(&sWalker, sParse.pNewTable->pCheck);
1904#ifndef SQLITE_OMIT_GENERATED_COLUMNS
1905 for(i=0; i<sParse.pNewTable->nCol; i++){
drh79cf2b72021-07-31 20:30:41 +00001906 sqlite3WalkExpr(&sWalker,
1907 sqlite3ColumnExpr(sParse.pNewTable,
1908 &sParse.pNewTable->aCol[i]));
dan1e240722021-03-15 20:22:34 +00001909 }
1910#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1911 }
1912 }else if( sParse.pNewIndex ){
1913 sqlite3WalkExprList(&sWalker, sParse.pNewIndex->aColExpr);
1914 sqlite3WalkExpr(&sWalker, sParse.pNewIndex->pPartIdxWhere);
1915 }else{
1916#ifndef SQLITE_OMIT_TRIGGER
1917 rc = renameResolveTrigger(&sParse);
1918 if( rc==SQLITE_OK ){
1919 renameWalkTrigger(&sWalker, sParse.pNewTrigger);
1920 }
1921#endif /* SQLITE_OMIT_TRIGGER */
1922 }
1923
1924 if( rc==SQLITE_OK ){
1925 rc = renameEditSql(context, &sCtx, zInput, 0, 0);
1926 }
dan1fffa732021-03-16 18:24:49 +00001927 renameTokenFree(db, sCtx.pList);
dan1e240722021-03-15 20:22:34 +00001928 }
1929 if( rc!=SQLITE_OK ){
drh89e9baa2022-02-06 21:13:59 +00001930 if( sqlite3WritableSchema(db) && rc==SQLITE_ERROR ){
drh5a800502022-02-04 16:43:30 +00001931 sqlite3_result_value(context, argv[1]);
1932 }else{
1933 sqlite3_result_error_code(context, rc);
1934 }
dan1e240722021-03-15 20:22:34 +00001935 }
1936 renameParseCleanup(&sParse);
1937 }
1938
1939#ifndef SQLITE_OMIT_AUTHORIZATION
1940 db->xAuth = xAuth;
1941#endif
1942
1943 sqlite3BtreeLeaveAll(db);
1944}
1945
drh5a800502022-02-04 16:43:30 +00001946/* Function: sqlite_rename_test(DB,SQL,TYPE,NAME,ISTEMP,WHEN,DQS)
1947**
dandd1a9c82018-09-05 08:28:30 +00001948** An SQL user function that checks that there are no parse or symbol
1949** resolution problems in a CREATE TRIGGER|TABLE|VIEW|INDEX statement.
1950** After an ALTER TABLE .. RENAME operation is performed and the schema
1951** reloaded, this function is called on each SQL statement in the schema
dan1d85c6b2018-09-06 16:01:37 +00001952** to ensure that it is still usable.
dandd1a9c82018-09-05 08:28:30 +00001953**
1954** 0: Database name ("main", "temp" etc.).
1955** 1: SQL statement.
1956** 2: Object type ("view", "table", "trigger" or "index").
1957** 3: Object name.
1958** 4: True if object is from temp schema.
dan16953462021-02-18 19:25:44 +00001959** 5: "when" part of error message.
dan2ad080a2021-03-16 16:14:48 +00001960** 6: True to disable the DQS quirk when parsing SQL.
dan1d85c6b2018-09-06 16:01:37 +00001961**
drh5a800502022-02-04 16:43:30 +00001962** The return value is computed as follows:
dan1d85c6b2018-09-06 16:01:37 +00001963**
drh5a800502022-02-04 16:43:30 +00001964** A. If an error is seen and not in PRAGMA writable_schema=ON mode,
1965** then raise the error.
1966** B. Else if a trigger is created and the the table that the trigger is
1967** attached to is in database zDb, then return 1.
1968** C. Otherwise return NULL.
dandd1a9c82018-09-05 08:28:30 +00001969*/
dan9d324822018-08-30 20:03:44 +00001970static void renameTableTest(
1971 sqlite3_context *context,
1972 int NotUsed,
1973 sqlite3_value **argv
1974){
1975 sqlite3 *db = sqlite3_context_db_handle(context);
drh5b1da302018-09-01 20:02:07 +00001976 char const *zDb = (const char*)sqlite3_value_text(argv[0]);
1977 char const *zInput = (const char*)sqlite3_value_text(argv[1]);
dan9d324822018-08-30 20:03:44 +00001978 int bTemp = sqlite3_value_int(argv[4]);
dan674b8942018-09-20 08:28:01 +00001979 int isLegacy = (db->flags & SQLITE_LegacyAlter);
dan16953462021-02-18 19:25:44 +00001980 char const *zWhen = (const char*)sqlite3_value_text(argv[5]);
dan2ad080a2021-03-16 16:14:48 +00001981 int bNoDQS = sqlite3_value_int(argv[6]);
dan9d324822018-08-30 20:03:44 +00001982
dan141e1192018-08-31 18:23:53 +00001983#ifndef SQLITE_OMIT_AUTHORIZATION
1984 sqlite3_xauth xAuth = db->xAuth;
1985 db->xAuth = 0;
1986#endif
1987
drh5b1da302018-09-01 20:02:07 +00001988 UNUSED_PARAMETER(NotUsed);
dan2ad080a2021-03-16 16:14:48 +00001989
dan09236502018-09-01 16:05:50 +00001990 if( zDb && zInput ){
1991 int rc;
1992 Parse sParse;
dan2ad080a2021-03-16 16:14:48 +00001993 int flags = db->flags;
1994 if( bNoDQS ) db->flags &= ~(SQLITE_DqsDML|SQLITE_DqsDDL);
drhb2ab3dc2019-12-20 14:08:34 +00001995 rc = renameParseSql(&sParse, zDb, db, zInput, bTemp);
dan2ad080a2021-03-16 16:14:48 +00001996 db->flags |= (flags & (SQLITE_DqsDML|SQLITE_DqsDDL));
dan09236502018-09-01 16:05:50 +00001997 if( rc==SQLITE_OK ){
drhf38524d2021-08-02 16:41:57 +00001998 if( isLegacy==0 && sParse.pNewTable && IsView(sParse.pNewTable) ){
dan09236502018-09-01 16:05:50 +00001999 NameContext sNC;
2000 memset(&sNC, 0, sizeof(sNC));
2001 sNC.pParse = &sParse;
drhf38524d2021-08-02 16:41:57 +00002002 sqlite3SelectPrep(&sParse, sParse.pNewTable->u.view.pSelect, &sNC);
dan09236502018-09-01 16:05:50 +00002003 if( sParse.nErr ) rc = sParse.rc;
2004 }
2005
2006 else if( sParse.pNewTrigger ){
dan674b8942018-09-20 08:28:01 +00002007 if( isLegacy==0 ){
drha7c74002020-07-18 18:44:59 +00002008 rc = renameResolveTrigger(&sParse);
dan674b8942018-09-20 08:28:01 +00002009 }
drh3b700452018-09-07 19:12:08 +00002010 if( rc==SQLITE_OK ){
dan1d85c6b2018-09-06 16:01:37 +00002011 int i1 = sqlite3SchemaToIndex(db, sParse.pNewTrigger->pTabSchema);
2012 int i2 = sqlite3FindDbName(db, zDb);
drh5a800502022-02-04 16:43:30 +00002013 if( i1==i2 ){
2014 /* Handle output case B */
2015 sqlite3_result_int(context, 1);
2016 }
dan1d85c6b2018-09-06 16:01:37 +00002017 }
dan09236502018-09-01 16:05:50 +00002018 }
dan9d324822018-08-30 20:03:44 +00002019 }
2020
drh569c1052022-02-05 12:05:43 +00002021 if( rc!=SQLITE_OK && zWhen && !sqlite3WritableSchema(db) ){
drh5a800502022-02-04 16:43:30 +00002022 /* Output case A */
dan16953462021-02-18 19:25:44 +00002023 renameColumnParseError(context, zWhen, argv[2], argv[3],&sParse);
dan9d324822018-08-30 20:03:44 +00002024 }
dan09236502018-09-01 16:05:50 +00002025 renameParseCleanup(&sParse);
dan9d324822018-08-30 20:03:44 +00002026 }
2027
dan141e1192018-08-31 18:23:53 +00002028#ifndef SQLITE_OMIT_AUTHORIZATION
2029 db->xAuth = xAuth;
2030#endif
dan9d324822018-08-30 20:03:44 +00002031}
2032
dancf8f2892018-08-09 20:47:01 +00002033/*
dan6a5a13d2021-02-17 20:08:22 +00002034** The implementation of internal UDF sqlite_drop_column().
2035**
dan6e6d9832021-02-16 20:43:36 +00002036** Arguments:
2037**
2038** argv[0]: An integer - the index of the schema containing the table
2039** argv[1]: CREATE TABLE statement to modify.
2040** argv[2]: An integer - the index of the column to remove.
dan6a5a13d2021-02-17 20:08:22 +00002041**
2042** The value returned is a string containing the CREATE TABLE statement
2043** with column argv[2] removed.
dan6e6d9832021-02-16 20:43:36 +00002044*/
2045static void dropColumnFunc(
2046 sqlite3_context *context,
2047 int NotUsed,
2048 sqlite3_value **argv
2049){
2050 sqlite3 *db = sqlite3_context_db_handle(context);
2051 int iSchema = sqlite3_value_int(argv[0]);
2052 const char *zSql = (const char*)sqlite3_value_text(argv[1]);
2053 int iCol = sqlite3_value_int(argv[2]);
dan6e6d9832021-02-16 20:43:36 +00002054 const char *zDb = db->aDb[iSchema].zDbSName;
2055 int rc;
2056 Parse sParse;
2057 RenameToken *pCol;
2058 Table *pTab;
2059 const char *zEnd;
2060 char *zNew = 0;
2061
dan678f3b32021-02-18 20:27:46 +00002062#ifndef SQLITE_OMIT_AUTHORIZATION
2063 sqlite3_xauth xAuth = db->xAuth;
2064 db->xAuth = 0;
2065#endif
2066
drh05edf722021-03-04 19:44:01 +00002067 UNUSED_PARAMETER(NotUsed);
dan6e6d9832021-02-16 20:43:36 +00002068 rc = renameParseSql(&sParse, zDb, db, zSql, iSchema==1);
2069 if( rc!=SQLITE_OK ) goto drop_column_done;
2070 pTab = sParse.pNewTable;
drh747cc942021-03-06 13:02:12 +00002071 if( pTab==0 || pTab->nCol==1 || iCol>=pTab->nCol ){
danf4a72782021-02-19 14:13:40 +00002072 /* This can happen if the sqlite_schema table is corrupt */
2073 rc = SQLITE_CORRUPT_BKPT;
2074 goto drop_column_done;
2075 }
dan6e6d9832021-02-16 20:43:36 +00002076
drhcf9d36d2021-08-02 18:03:43 +00002077 pCol = renameTokenFind(&sParse, 0, (void*)pTab->aCol[iCol].zCnName);
dan6e6d9832021-02-16 20:43:36 +00002078 if( iCol<pTab->nCol-1 ){
2079 RenameToken *pEnd;
drhcf9d36d2021-08-02 18:03:43 +00002080 pEnd = renameTokenFind(&sParse, 0, (void*)pTab->aCol[iCol+1].zCnName);
dan6e6d9832021-02-16 20:43:36 +00002081 zEnd = (const char*)pEnd->t.z;
2082 }else{
drh78b2fa82021-10-07 12:11:20 +00002083 assert( IsOrdinaryTable(pTab) );
drhf38524d2021-08-02 16:41:57 +00002084 zEnd = (const char*)&zSql[pTab->u.tab.addColOffset];
drh60fe2352021-02-19 09:46:52 +00002085 while( ALWAYS(pCol->t.z[0]!=0) && pCol->t.z[0]!=',' ) pCol->t.z--;
dan6e6d9832021-02-16 20:43:36 +00002086 }
2087
danc2a878e2021-02-17 20:46:44 +00002088 zNew = sqlite3MPrintf(db, "%.*s%s", pCol->t.z-zSql, zSql, zEnd);
dan6e6d9832021-02-16 20:43:36 +00002089 sqlite3_result_text(context, zNew, -1, SQLITE_TRANSIENT);
2090 sqlite3_free(zNew);
2091
2092drop_column_done:
2093 renameParseCleanup(&sParse);
dan678f3b32021-02-18 20:27:46 +00002094#ifndef SQLITE_OMIT_AUTHORIZATION
2095 db->xAuth = xAuth;
2096#endif
danf4a72782021-02-19 14:13:40 +00002097 if( rc!=SQLITE_OK ){
2098 sqlite3_result_error_code(context, rc);
2099 }
dan6e6d9832021-02-16 20:43:36 +00002100}
2101
dan6a5a13d2021-02-17 20:08:22 +00002102/*
2103** This function is called by the parser upon parsing an
2104**
2105** ALTER TABLE pSrc DROP COLUMN pName
2106**
2107** statement. Argument pSrc contains the possibly qualified name of the
2108** table being edited, and token pName the name of the column to drop.
2109*/
drhb6dad522021-09-24 16:14:47 +00002110void sqlite3AlterDropColumn(Parse *pParse, SrcList *pSrc, const Token *pName){
dan6a5a13d2021-02-17 20:08:22 +00002111 sqlite3 *db = pParse->db; /* Database handle */
2112 Table *pTab; /* Table to modify */
2113 int iDb; /* Index of db containing pTab in aDb[] */
2114 const char *zDb; /* Database containing pTab ("main" etc.) */
2115 char *zCol = 0; /* Name of column to drop */
2116 int iCol; /* Index of column zCol in pTab->aCol[] */
dan6e6d9832021-02-16 20:43:36 +00002117
2118 /* Look up the table being altered. */
2119 assert( pParse->pNewTable==0 );
2120 assert( sqlite3BtreeHoldsAllMutexes(db) );
drhc90fa012021-02-19 02:30:02 +00002121 if( NEVER(db->mallocFailed) ) goto exit_drop_column;
dan6e6d9832021-02-16 20:43:36 +00002122 pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
2123 if( !pTab ) goto exit_drop_column;
2124
dan6a5a13d2021-02-17 20:08:22 +00002125 /* Make sure this is not an attempt to ALTER a view, virtual table or
2126 ** system table. */
2127 if( SQLITE_OK!=isAlterableTable(pParse, pTab) ) goto exit_drop_column;
2128 if( SQLITE_OK!=isRealTable(pParse, pTab, 1) ) goto exit_drop_column;
dan6e6d9832021-02-16 20:43:36 +00002129
2130 /* Find the index of the column being dropped. */
2131 zCol = sqlite3NameFromToken(db, pName);
2132 if( zCol==0 ){
2133 assert( db->mallocFailed );
2134 goto exit_drop_column;
2135 }
2136 iCol = sqlite3ColumnIndex(pTab, zCol);
2137 if( iCol<0 ){
drh4e532952022-02-08 13:41:23 +00002138 sqlite3ErrorMsg(pParse, "no such column: \"%T\"", pName);
dan6e6d9832021-02-16 20:43:36 +00002139 goto exit_drop_column;
2140 }
2141
2142 /* Do not allow the user to drop a PRIMARY KEY column or a column
2143 ** constrained by a UNIQUE constraint. */
dan6a5a13d2021-02-17 20:08:22 +00002144 if( pTab->aCol[iCol].colFlags & (COLFLAG_PRIMKEY|COLFLAG_UNIQUE) ){
2145 sqlite3ErrorMsg(pParse, "cannot drop %s column: \"%s\"",
2146 (pTab->aCol[iCol].colFlags&COLFLAG_PRIMKEY) ? "PRIMARY KEY" : "UNIQUE",
2147 zCol
2148 );
dan6e6d9832021-02-16 20:43:36 +00002149 goto exit_drop_column;
2150 }
dan6e6d9832021-02-16 20:43:36 +00002151
drh239c84f2021-02-19 09:09:07 +00002152 /* Do not allow the number of columns to go to zero */
2153 if( pTab->nCol<=1 ){
2154 sqlite3ErrorMsg(pParse, "cannot drop column \"%s\": no other columns exist",zCol);
2155 goto exit_drop_column;
2156 }
2157
dan6a5a13d2021-02-17 20:08:22 +00002158 /* Edit the sqlite_schema table */
2159 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2160 assert( iDb>=0 );
2161 zDb = db->aDb[iDb].zDbSName;
drh85b70e02022-01-18 16:16:32 +00002162#ifndef SQLITE_OMIT_AUTHORIZATION
2163 /* Invoke the authorization callback. */
2164 if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, zCol) ){
2165 goto exit_drop_column;
2166 }
2167#endif
dan2ad080a2021-03-16 16:14:48 +00002168 renameTestSchema(pParse, zDb, iDb==1, "", 0);
2169 renameFixQuotes(pParse, zDb, iDb==1);
dan6e6d9832021-02-16 20:43:36 +00002170 sqlite3NestedParse(pParse,
drha4a871c2021-11-04 14:04:20 +00002171 "UPDATE \"%w\"." LEGACY_SCHEMA_TABLE " SET "
dan578277c2021-02-19 18:39:32 +00002172 "sql = sqlite_drop_column(%d, sql, %d) "
dan6e6d9832021-02-16 20:43:36 +00002173 "WHERE (type=='table' AND tbl_name=%Q COLLATE nocase)"
dan578277c2021-02-19 18:39:32 +00002174 , zDb, iDb, iCol, pTab->zName
dan6e6d9832021-02-16 20:43:36 +00002175 );
2176
2177 /* Drop and reload the database schema. */
dan6a5a13d2021-02-17 20:08:22 +00002178 renameReloadSchema(pParse, iDb, INITFLAG_AlterDrop);
dan2ad080a2021-03-16 16:14:48 +00002179 renameTestSchema(pParse, zDb, iDb==1, "after drop column", 1);
dan6e6d9832021-02-16 20:43:36 +00002180
2181 /* Edit rows of table on disk */
danc2a878e2021-02-17 20:46:44 +00002182 if( pParse->nErr==0 && (pTab->aCol[iCol].colFlags & COLFLAG_VIRTUAL)==0 ){
dan6a5a13d2021-02-17 20:08:22 +00002183 int i;
2184 int addr;
2185 int reg;
2186 int regRec;
2187 Index *pPk = 0;
2188 int nField = 0; /* Number of non-virtual columns after drop */
2189 int iCur;
2190 Vdbe *v = sqlite3GetVdbe(pParse);
2191 iCur = pParse->nTab++;
2192 sqlite3OpenTable(pParse, iCur, iDb, pTab, OP_OpenWrite);
drh03361402021-02-18 23:53:47 +00002193 addr = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
dan6a5a13d2021-02-17 20:08:22 +00002194 reg = ++pParse->nMem;
dan6a5a13d2021-02-17 20:08:22 +00002195 if( HasRowid(pTab) ){
2196 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, reg);
dancc263012021-04-06 21:20:39 +00002197 pParse->nMem += pTab->nCol;
dan6a5a13d2021-02-17 20:08:22 +00002198 }else{
2199 pPk = sqlite3PrimaryKeyIndex(pTab);
dancc263012021-04-06 21:20:39 +00002200 pParse->nMem += pPk->nColumn;
2201 for(i=0; i<pPk->nKeyCol; i++){
2202 sqlite3VdbeAddOp3(v, OP_Column, iCur, i, reg+i+1);
2203 }
2204 nField = pPk->nKeyCol;
dan6e6d9832021-02-16 20:43:36 +00002205 }
dancc263012021-04-06 21:20:39 +00002206 regRec = ++pParse->nMem;
dan6a5a13d2021-02-17 20:08:22 +00002207 for(i=0; i<pTab->nCol; i++){
2208 if( i!=iCol && (pTab->aCol[i].colFlags & COLFLAG_VIRTUAL)==0 ){
2209 int regOut;
2210 if( pPk ){
2211 int iPos = sqlite3TableColumnToIndex(pPk, i);
2212 int iColPos = sqlite3TableColumnToIndex(pPk, iCol);
dancc263012021-04-06 21:20:39 +00002213 if( iPos<pPk->nKeyCol ) continue;
dan6a5a13d2021-02-17 20:08:22 +00002214 regOut = reg+1+iPos-(iPos>iColPos);
2215 }else{
2216 regOut = reg+1+nField;
2217 }
dan0a746cc2021-04-18 05:30:39 +00002218 if( i==pTab->iPKey ){
2219 sqlite3VdbeAddOp2(v, OP_Null, 0, regOut);
2220 }else{
2221 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, i, regOut);
2222 }
dan6a5a13d2021-02-17 20:08:22 +00002223 nField++;
2224 }
2225 }
drh55b8b732021-07-22 18:22:51 +00002226 if( nField==0 ){
2227 /* dbsqlfuzz 5f09e7bcc78b4954d06bf9f2400d7715f48d1fef */
2228 pParse->nMem++;
2229 sqlite3VdbeAddOp2(v, OP_Null, 0, reg+1);
2230 nField = 1;
2231 }
dan6a5a13d2021-02-17 20:08:22 +00002232 sqlite3VdbeAddOp3(v, OP_MakeRecord, reg+1, nField, regRec);
2233 if( pPk ){
2234 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iCur, regRec, reg+1, pPk->nKeyCol);
2235 }else{
2236 sqlite3VdbeAddOp3(v, OP_Insert, iCur, regRec, reg);
2237 }
dan0a746cc2021-04-18 05:30:39 +00002238 sqlite3VdbeChangeP5(v, OPFLAG_SAVEPOSITION);
dan6e6d9832021-02-16 20:43:36 +00002239
drh03361402021-02-18 23:53:47 +00002240 sqlite3VdbeAddOp2(v, OP_Next, iCur, addr+1); VdbeCoverage(v);
dan6a5a13d2021-02-17 20:08:22 +00002241 sqlite3VdbeJumpHere(v, addr);
2242 }
dan6e6d9832021-02-16 20:43:36 +00002243
2244exit_drop_column:
2245 sqlite3DbFree(db, zCol);
2246 sqlite3SrcListDelete(db, pSrc);
dan6e6d9832021-02-16 20:43:36 +00002247}
2248
2249/*
dancf8f2892018-08-09 20:47:01 +00002250** Register built-in functions used to help implement ALTER TABLE
2251*/
2252void sqlite3AlterFunctions(void){
2253 static FuncDef aAlterTableFuncs[] = {
dan6e6d9832021-02-16 20:43:36 +00002254 INTERNAL_FUNCTION(sqlite_rename_column, 9, renameColumnFunc),
2255 INTERNAL_FUNCTION(sqlite_rename_table, 7, renameTableFunc),
dan2ad080a2021-03-16 16:14:48 +00002256 INTERNAL_FUNCTION(sqlite_rename_test, 7, renameTableTest),
dan578277c2021-02-19 18:39:32 +00002257 INTERNAL_FUNCTION(sqlite_drop_column, 3, dropColumnFunc),
dan1e240722021-03-15 20:22:34 +00002258 INTERNAL_FUNCTION(sqlite_rename_quotefix,2, renameQuotefixFunc),
dancf8f2892018-08-09 20:47:01 +00002259 };
2260 sqlite3InsertBuiltinFuncs(aAlterTableFuncs, ArraySize(aAlterTableFuncs));
2261}
drhd0e4a6c2005-02-15 20:47:57 +00002262#endif /* SQLITE_ALTER_TABLE */