blob: 1ec74cdcc7b7113d8ecb8fc5010e312b73617f6f [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){
861 if( pIdList ){
862 int ii;
863 for(ii=0; ii<pIdList->nId; ii++){
drhb6dad522021-09-24 16:14:47 +0000864 sqlite3RenameTokenRemap(pParse, 0, (const void*)pIdList->a[ii].zName);
danfb99e382020-04-03 11:20:40 +0000865 }
866 }
867}
868
869/*
dan0b277a92019-06-11 12:03:10 +0000870** Walker callback used by sqlite3RenameExprUnmap().
871*/
872static int renameUnmapSelectCb(Walker *pWalker, Select *p){
drhbdf4cf02019-06-15 15:21:49 +0000873 Parse *pParse = pWalker->pParse;
874 int i;
drhd63b69b2019-12-04 15:08:58 +0000875 if( pParse->nErr ) return WRC_Abort;
drh0fbc19e2021-10-17 10:31:09 +0000876 testcase( p->selFlags & SF_View );
877 testcase( p->selFlags & SF_CopyCte );
drhfebf0352021-10-13 14:01:44 +0000878 if( p->selFlags & (SF_View|SF_CopyCte) ){
danac67f562021-06-14 20:08:48 +0000879 return WRC_Prune;
880 }
drhbdf4cf02019-06-15 15:21:49 +0000881 if( ALWAYS(p->pEList) ){
882 ExprList *pList = p->pEList;
883 for(i=0; i<pList->nExpr; i++){
drhc4938ea2019-12-13 00:49:42 +0000884 if( pList->a[i].zEName && pList->a[i].eEName==ENAME_NAME ){
drh41cee662019-12-12 20:22:34 +0000885 sqlite3RenameTokenRemap(pParse, 0, (void*)pList->a[i].zEName);
drhbdf4cf02019-06-15 15:21:49 +0000886 }
887 }
888 }
drh2c3f4652019-06-11 16:43:58 +0000889 if( ALWAYS(p->pSrc) ){ /* Every Select as a SrcList, even if it is empty */
drhbdf4cf02019-06-15 15:21:49 +0000890 SrcList *pSrc = p->pSrc;
891 for(i=0; i<pSrc->nSrc; i++){
892 sqlite3RenameTokenRemap(pParse, 0, (void*)pSrc->a[i].zName);
drh00197742021-09-29 20:17:19 +0000893 sqlite3WalkExpr(pWalker, pSrc->a[i].pOn);
danfb99e382020-04-03 11:20:40 +0000894 unmapColumnIdlistNames(pParse, pSrc->a[i].pUsing);
dan0b277a92019-06-11 12:03:10 +0000895 }
896 }
dan8f407622019-12-04 14:26:38 +0000897
898 renameWalkWith(pWalker, p);
dan0b277a92019-06-11 12:03:10 +0000899 return WRC_Continue;
900}
901
902/*
dan8900a482018-09-05 14:36:05 +0000903** Remove all nodes that are part of expression pExpr from the rename list.
904*/
905void sqlite3RenameExprUnmap(Parse *pParse, Expr *pExpr){
dane6dc1e52019-12-05 14:31:43 +0000906 u8 eMode = pParse->eParseMode;
dan8900a482018-09-05 14:36:05 +0000907 Walker sWalker;
908 memset(&sWalker, 0, sizeof(Walker));
909 sWalker.pParse = pParse;
910 sWalker.xExprCallback = renameUnmapExprCb;
dan0b277a92019-06-11 12:03:10 +0000911 sWalker.xSelectCallback = renameUnmapSelectCb;
dane6dc1e52019-12-05 14:31:43 +0000912 pParse->eParseMode = PARSE_MODE_UNMAP;
dan8900a482018-09-05 14:36:05 +0000913 sqlite3WalkExpr(&sWalker, pExpr);
dane6dc1e52019-12-05 14:31:43 +0000914 pParse->eParseMode = eMode;
dan8900a482018-09-05 14:36:05 +0000915}
916
917/*
dane8ab40d2018-09-12 08:51:48 +0000918** Remove all nodes that are part of expression-list pEList from the
919** rename list.
920*/
921void sqlite3RenameExprlistUnmap(Parse *pParse, ExprList *pEList){
922 if( pEList ){
923 int i;
924 Walker sWalker;
925 memset(&sWalker, 0, sizeof(Walker));
926 sWalker.pParse = pParse;
927 sWalker.xExprCallback = renameUnmapExprCb;
928 sqlite3WalkExprList(&sWalker, pEList);
929 for(i=0; i<pEList->nExpr; i++){
drh9fc1b9a2020-01-02 22:23:01 +0000930 if( ALWAYS(pEList->a[i].eEName==ENAME_NAME) ){
drhc4938ea2019-12-13 00:49:42 +0000931 sqlite3RenameTokenRemap(pParse, 0, (void*)pEList->a[i].zEName);
932 }
dane8ab40d2018-09-12 08:51:48 +0000933 }
934 }
935}
936
937/*
drh4a2c7472018-08-13 15:09:48 +0000938** Free the list of RenameToken objects given in the second argument
939*/
dancf8f2892018-08-09 20:47:01 +0000940static void renameTokenFree(sqlite3 *db, RenameToken *pToken){
941 RenameToken *pNext;
942 RenameToken *p;
943 for(p=pToken; p; p=pNext){
944 pNext = p->pNext;
945 sqlite3DbFree(db, p);
946 }
947}
948
dan987db762018-08-14 20:18:50 +0000949/*
950** Search the Parse object passed as the first argument for a RenameToken
dan6e6d9832021-02-16 20:43:36 +0000951** object associated with parse tree element pPtr. If found, return a pointer
952** to it. Otherwise, return NULL.
953**
954** If the second argument passed to this function is not NULL and a matching
955** RenameToken object is found, remove it from the Parse object and add it to
956** the list maintained by the RenameCtx object.
dan987db762018-08-14 20:18:50 +0000957*/
dan6e6d9832021-02-16 20:43:36 +0000958static RenameToken *renameTokenFind(
959 Parse *pParse,
960 struct RenameCtx *pCtx,
drhb6dad522021-09-24 16:14:47 +0000961 const void *pPtr
dan6e6d9832021-02-16 20:43:36 +0000962){
dancf8f2892018-08-09 20:47:01 +0000963 RenameToken **pp;
drh06258a42021-06-04 23:26:56 +0000964 if( NEVER(pPtr==0) ){
drh65b93052021-04-22 16:54:34 +0000965 return 0;
966 }
dancf8f2892018-08-09 20:47:01 +0000967 for(pp=&pParse->pRename; (*pp); pp=&(*pp)->pNext){
968 if( (*pp)->p==pPtr ){
969 RenameToken *pToken = *pp;
dan6e6d9832021-02-16 20:43:36 +0000970 if( pCtx ){
971 *pp = pToken->pNext;
972 pToken->pNext = pCtx->pList;
973 pCtx->pList = pToken;
974 pCtx->nList++;
975 }
976 return pToken;
dancf8f2892018-08-09 20:47:01 +0000977 }
978 }
dan6e6d9832021-02-16 20:43:36 +0000979 return 0;
dancf8f2892018-08-09 20:47:01 +0000980}
981
dan24fedb92018-08-18 17:35:38 +0000982/*
983** This is a Walker select callback. It does nothing. It is only required
984** because without a dummy callback, sqlite3WalkExpr() and similar do not
985** descend into sub-select statements.
986*/
dan987db762018-08-14 20:18:50 +0000987static int renameColumnSelectCb(Walker *pWalker, Select *p){
danac67f562021-06-14 20:08:48 +0000988 if( p->selFlags & (SF_View|SF_CopyCte) ){
drh11e489d2021-06-14 20:49:33 +0000989 testcase( p->selFlags & SF_View );
990 testcase( p->selFlags & SF_CopyCte );
danac67f562021-06-14 20:08:48 +0000991 return WRC_Prune;
992 }
danea412512018-12-05 13:49:04 +0000993 renameWalkWith(pWalker, p);
dan987db762018-08-14 20:18:50 +0000994 return WRC_Continue;
995}
996
dan987db762018-08-14 20:18:50 +0000997/*
998** This is a Walker expression callback.
999**
1000** For every TK_COLUMN node in the expression tree, search to see
1001** if the column being references is the column being renamed by an
1002** ALTER TABLE statement. If it is, then attach its associated
1003** RenameToken object to the list of RenameToken objects being
1004** constructed in RenameCtx object at pWalker->u.pRename.
1005*/
dancf8f2892018-08-09 20:47:01 +00001006static int renameColumnExprCb(Walker *pWalker, Expr *pExpr){
dan5496d6a2018-08-13 17:14:26 +00001007 RenameCtx *p = pWalker->u.pRename;
dan0cbb0b12018-08-16 19:49:16 +00001008 if( pExpr->op==TK_TRIGGER
1009 && pExpr->iColumn==p->iCol
1010 && pWalker->pParse->pTriggerTab==p->pTab
1011 ){
dan5be60c52018-08-15 20:28:39 +00001012 renameTokenFind(pWalker->pParse, p, (void*)pExpr);
dan0cbb0b12018-08-16 19:49:16 +00001013 }else if( pExpr->op==TK_COLUMN
drh477572b2021-10-07 20:46:29 +00001014 && pExpr->iColumn==p->iCol
1015 && ALWAYS(ExprUseYTab(pExpr))
drheda079c2018-09-20 19:02:15 +00001016 && p->pTab==pExpr->y.pTab
dan987db762018-08-14 20:18:50 +00001017 ){
dan5496d6a2018-08-13 17:14:26 +00001018 renameTokenFind(pWalker->pParse, p, (void*)pExpr);
dancf8f2892018-08-09 20:47:01 +00001019 }
1020 return WRC_Continue;
1021}
1022
dan987db762018-08-14 20:18:50 +00001023/*
1024** The RenameCtx contains a list of tokens that reference a column that
dan24fedb92018-08-18 17:35:38 +00001025** is being renamed by an ALTER TABLE statement. Return the "last"
dan987db762018-08-14 20:18:50 +00001026** RenameToken in the RenameCtx and remove that RenameToken from the
dan24fedb92018-08-18 17:35:38 +00001027** RenameContext. "Last" means the last RenameToken encountered when
1028** the input SQL is parsed from left to right. Repeated calls to this routine
dan987db762018-08-14 20:18:50 +00001029** return all column name tokens in the order that they are encountered
1030** in the SQL statement.
1031*/
dan5496d6a2018-08-13 17:14:26 +00001032static RenameToken *renameColumnTokenNext(RenameCtx *pCtx){
dancf8f2892018-08-09 20:47:01 +00001033 RenameToken *pBest = pCtx->pList;
1034 RenameToken *pToken;
1035 RenameToken **pp;
1036
1037 for(pToken=pBest->pNext; pToken; pToken=pToken->pNext){
1038 if( pToken->t.z>pBest->t.z ) pBest = pToken;
1039 }
1040 for(pp=&pCtx->pList; *pp!=pBest; pp=&(*pp)->pNext);
1041 *pp = pBest->pNext;
1042
1043 return pBest;
1044}
1045
dan6fe7f232018-08-10 19:19:33 +00001046/*
dan24fedb92018-08-18 17:35:38 +00001047** An error occured while parsing or otherwise processing a database
1048** object (either pParse->pNewTable, pNewIndex or pNewTrigger) as part of an
1049** ALTER TABLE RENAME COLUMN program. The error message emitted by the
1050** sub-routine is currently stored in pParse->zErrMsg. This function
1051** adds context to the error message and then stores it in pCtx.
1052*/
danb0137382018-08-20 20:01:01 +00001053static void renameColumnParseError(
1054 sqlite3_context *pCtx,
dan16953462021-02-18 19:25:44 +00001055 const char *zWhen,
danb0137382018-08-20 20:01:01 +00001056 sqlite3_value *pType,
1057 sqlite3_value *pObject,
1058 Parse *pParse
1059){
drh79a5ee92018-08-23 19:32:04 +00001060 const char *zT = (const char*)sqlite3_value_text(pType);
1061 const char *zN = (const char*)sqlite3_value_text(pObject);
dan24fedb92018-08-18 17:35:38 +00001062 char *zErr;
danb0137382018-08-20 20:01:01 +00001063
drh89e9baa2022-02-06 21:13:59 +00001064 zErr = sqlite3MPrintf(pParse->db, "error in %s %s%s%s: %s",
dan16953462021-02-18 19:25:44 +00001065 zT, zN, (zWhen[0] ? " " : ""), zWhen,
dan0d5fa6b2018-08-24 17:55:49 +00001066 pParse->zErrMsg
1067 );
dan24fedb92018-08-18 17:35:38 +00001068 sqlite3_result_error(pCtx, zErr, -1);
drh89e9baa2022-02-06 21:13:59 +00001069 sqlite3DbFree(pParse->db, zErr);
dan24fedb92018-08-18 17:35:38 +00001070}
1071
1072/*
dan06249392018-08-21 15:06:59 +00001073** For each name in the the expression-list pEList (i.e. each
1074** pEList->a[i].zName) that matches the string in zOld, extract the
1075** corresponding rename-token from Parse object pParse and add it
1076** to the RenameCtx pCtx.
1077*/
1078static void renameColumnElistNames(
1079 Parse *pParse,
1080 RenameCtx *pCtx,
drhb6dad522021-09-24 16:14:47 +00001081 const ExprList *pEList,
dan06249392018-08-21 15:06:59 +00001082 const char *zOld
1083){
1084 if( pEList ){
1085 int i;
1086 for(i=0; i<pEList->nExpr; i++){
drhb6dad522021-09-24 16:14:47 +00001087 const char *zName = pEList->a[i].zEName;
drh9fc1b9a2020-01-02 22:23:01 +00001088 if( ALWAYS(pEList->a[i].eEName==ENAME_NAME)
1089 && ALWAYS(zName!=0)
drhc4938ea2019-12-13 00:49:42 +00001090 && 0==sqlite3_stricmp(zName, zOld)
1091 ){
drhb6dad522021-09-24 16:14:47 +00001092 renameTokenFind(pParse, pCtx, (const void*)zName);
dan06249392018-08-21 15:06:59 +00001093 }
1094 }
1095 }
1096}
1097
1098/*
1099** For each name in the the id-list pIdList (i.e. each pIdList->a[i].zName)
1100** that matches the string in zOld, extract the corresponding rename-token
1101** from Parse object pParse and add it to the RenameCtx pCtx.
1102*/
1103static void renameColumnIdlistNames(
1104 Parse *pParse,
1105 RenameCtx *pCtx,
drhb6dad522021-09-24 16:14:47 +00001106 const IdList *pIdList,
dan06249392018-08-21 15:06:59 +00001107 const char *zOld
1108){
1109 if( pIdList ){
1110 int i;
1111 for(i=0; i<pIdList->nId; i++){
drhb6dad522021-09-24 16:14:47 +00001112 const char *zName = pIdList->a[i].zName;
dan06249392018-08-21 15:06:59 +00001113 if( 0==sqlite3_stricmp(zName, zOld) ){
drhb6dad522021-09-24 16:14:47 +00001114 renameTokenFind(pParse, pCtx, (const void*)zName);
dan06249392018-08-21 15:06:59 +00001115 }
1116 }
1117 }
1118}
1119
danfb99e382020-04-03 11:20:40 +00001120
dandd1a9c82018-09-05 08:28:30 +00001121/*
1122** Parse the SQL statement zSql using Parse object (*p). The Parse object
1123** is initialized by this function before it is used.
1124*/
danc9461ec2018-08-29 21:00:16 +00001125static int renameParseSql(
dandd1a9c82018-09-05 08:28:30 +00001126 Parse *p, /* Memory to use for Parse object */
1127 const char *zDb, /* Name of schema SQL belongs to */
dandd1a9c82018-09-05 08:28:30 +00001128 sqlite3 *db, /* Database handle */
1129 const char *zSql, /* SQL to parse */
1130 int bTemp /* True if SQL is from temp schema */
danc9461ec2018-08-29 21:00:16 +00001131){
1132 int rc;
danc9461ec2018-08-29 21:00:16 +00001133
drhc692df22022-01-24 15:34:55 +00001134 sqlite3ParseObjectInit(p, db);
drhfde30432022-03-10 21:04:49 +00001135 if( zSql==0 ){
1136 return SQLITE_NOMEM;
1137 }
1138 if( sqlite3StrNICmp(zSql,"CREATE ",7)!=0 ){
1139 return SQLITE_CORRUPT_BKPT;
1140 }
1141 db->init.iDb = bTemp ? 1 : sqlite3FindDbName(db, zDb);
dane6dc1e52019-12-05 14:31:43 +00001142 p->eParseMode = PARSE_MODE_RENAME;
danc9461ec2018-08-29 21:00:16 +00001143 p->db = db;
1144 p->nQueryLoop = 1;
drhfde30432022-03-10 21:04:49 +00001145 rc = sqlite3RunParser(p, zSql);
danc9461ec2018-08-29 21:00:16 +00001146 if( db->mallocFailed ) rc = SQLITE_NOMEM;
1147 if( rc==SQLITE_OK
drhfde30432022-03-10 21:04:49 +00001148 && NEVER(p->pNewTable==0 && p->pNewIndex==0 && p->pNewTrigger==0)
danc9461ec2018-08-29 21:00:16 +00001149 ){
1150 rc = SQLITE_CORRUPT_BKPT;
1151 }
1152
1153#ifdef SQLITE_DEBUG
1154 /* Ensure that all mappings in the Parse.pRename list really do map to
1155 ** a part of the input string. */
1156 if( rc==SQLITE_OK ){
1157 int nSql = sqlite3Strlen30(zSql);
1158 RenameToken *pToken;
1159 for(pToken=p->pRename; pToken; pToken=pToken->pNext){
1160 assert( pToken->t.z>=zSql && &pToken->t.z[pToken->t.n]<=&zSql[nSql] );
1161 }
1162 }
1163#endif
1164
1165 db->init.iDb = 0;
1166 return rc;
1167}
1168
dandd1a9c82018-09-05 08:28:30 +00001169/*
1170** This function edits SQL statement zSql, replacing each token identified
1171** by the linked list pRename with the text of zNew. If argument bQuote is
1172** true, then zNew is always quoted first. If no error occurs, the result
1173** is loaded into context object pCtx as the result.
1174**
1175** Or, if an error occurs (i.e. an OOM condition), an error is left in
1176** pCtx and an SQLite error code returned.
1177*/
danc9461ec2018-08-29 21:00:16 +00001178static int renameEditSql(
1179 sqlite3_context *pCtx, /* Return result here */
1180 RenameCtx *pRename, /* Rename context */
1181 const char *zSql, /* SQL statement to edit */
1182 const char *zNew, /* New token text */
1183 int bQuote /* True to always quote token */
1184){
drh236bcdf2021-06-16 11:32:54 +00001185 i64 nNew = sqlite3Strlen30(zNew);
1186 i64 nSql = sqlite3Strlen30(zSql);
danc9461ec2018-08-29 21:00:16 +00001187 sqlite3 *db = sqlite3_context_db_handle(pCtx);
1188 int rc = SQLITE_OK;
dan1e240722021-03-15 20:22:34 +00001189 char *zQuot = 0;
danc9461ec2018-08-29 21:00:16 +00001190 char *zOut;
drh236bcdf2021-06-16 11:32:54 +00001191 i64 nQuot = 0;
dan1e240722021-03-15 20:22:34 +00001192 char *zBuf1 = 0;
1193 char *zBuf2 = 0;
danc9461ec2018-08-29 21:00:16 +00001194
dan1e240722021-03-15 20:22:34 +00001195 if( zNew ){
1196 /* Set zQuot to point to a buffer containing a quoted copy of the
1197 ** identifier zNew. If the corresponding identifier in the original
1198 ** ALTER TABLE statement was quoted (bQuote==1), then set zNew to
1199 ** point to zQuot so that all substitutions are made using the
1200 ** quoted version of the new column name. */
dan1d14ffe2021-03-23 22:15:34 +00001201 zQuot = sqlite3MPrintf(db, "\"%w\" ", zNew);
dan1e240722021-03-15 20:22:34 +00001202 if( zQuot==0 ){
1203 return SQLITE_NOMEM;
1204 }else{
dan1d14ffe2021-03-23 22:15:34 +00001205 nQuot = sqlite3Strlen30(zQuot)-1;
dan1e240722021-03-15 20:22:34 +00001206 }
1207
1208 assert( nQuot>=nNew );
1209 zOut = sqlite3DbMallocZero(db, nSql + pRename->nList*nQuot + 1);
danc9461ec2018-08-29 21:00:16 +00001210 }else{
dan1e240722021-03-15 20:22:34 +00001211 zOut = (char*)sqlite3DbMallocZero(db, (nSql*2+1) * 3);
1212 if( zOut ){
1213 zBuf1 = &zOut[nSql*2+1];
1214 zBuf2 = &zOut[nSql*4+2];
1215 }
danc9461ec2018-08-29 21:00:16 +00001216 }
1217
1218 /* At this point pRename->pList contains a list of RenameToken objects
1219 ** corresponding to all tokens in the input SQL that must be replaced
dan1e240722021-03-15 20:22:34 +00001220 ** with the new column name, or with single-quoted versions of themselves.
1221 ** All that remains is to construct and return the edited SQL string. */
danc9461ec2018-08-29 21:00:16 +00001222 if( zOut ){
1223 int nOut = nSql;
1224 memcpy(zOut, zSql, nSql);
1225 while( pRename->pList ){
1226 int iOff; /* Offset of token to replace in zOut */
danc9461ec2018-08-29 21:00:16 +00001227 u32 nReplace;
1228 const char *zReplace;
dan1e240722021-03-15 20:22:34 +00001229 RenameToken *pBest = renameColumnTokenNext(pRename);
1230
1231 if( zNew ){
dan1d14ffe2021-03-23 22:15:34 +00001232 if( bQuote==0 && sqlite3IsIdChar(*pBest->t.z) ){
dan1e240722021-03-15 20:22:34 +00001233 nReplace = nNew;
1234 zReplace = zNew;
1235 }else{
1236 nReplace = nQuot;
1237 zReplace = zQuot;
dan1d14ffe2021-03-23 22:15:34 +00001238 if( pBest->t.z[pBest->t.n]=='"' ) nReplace++;
dan1e240722021-03-15 20:22:34 +00001239 }
danc9461ec2018-08-29 21:00:16 +00001240 }else{
dan1e240722021-03-15 20:22:34 +00001241 /* Dequote the double-quoted token. Then requote it again, this time
1242 ** using single quotes. If the character immediately following the
1243 ** original token within the input SQL was a single quote ('), then
1244 ** add another space after the new, single-quoted version of the
1245 ** token. This is so that (SELECT "string"'alias') maps to
1246 ** (SELECT 'string' 'alias'), and not (SELECT 'string''alias'). */
1247 memcpy(zBuf1, pBest->t.z, pBest->t.n);
1248 zBuf1[pBest->t.n] = 0;
1249 sqlite3Dequote(zBuf1);
1250 sqlite3_snprintf(nSql*2, zBuf2, "%Q%s", zBuf1,
1251 pBest->t.z[pBest->t.n]=='\'' ? " " : ""
1252 );
1253 zReplace = zBuf2;
1254 nReplace = sqlite3Strlen30(zReplace);
danc9461ec2018-08-29 21:00:16 +00001255 }
1256
1257 iOff = pBest->t.z - zSql;
1258 if( pBest->t.n!=nReplace ){
1259 memmove(&zOut[iOff + nReplace], &zOut[iOff + pBest->t.n],
1260 nOut - (iOff + pBest->t.n)
1261 );
1262 nOut += nReplace - pBest->t.n;
1263 zOut[nOut] = '\0';
1264 }
1265 memcpy(&zOut[iOff], zReplace, nReplace);
1266 sqlite3DbFree(db, pBest);
1267 }
1268
1269 sqlite3_result_text(pCtx, zOut, -1, SQLITE_TRANSIENT);
1270 sqlite3DbFree(db, zOut);
1271 }else{
1272 rc = SQLITE_NOMEM;
1273 }
1274
1275 sqlite3_free(zQuot);
1276 return rc;
1277}
1278
dandd1a9c82018-09-05 08:28:30 +00001279/*
1280** Resolve all symbols in the trigger at pParse->pNewTrigger, assuming
1281** it was read from the schema of database zDb. Return SQLITE_OK if
1282** successful. Otherwise, return an SQLite error code and leave an error
1283** message in the Parse object.
1284*/
drha7c74002020-07-18 18:44:59 +00001285static int renameResolveTrigger(Parse *pParse){
danc9461ec2018-08-29 21:00:16 +00001286 sqlite3 *db = pParse->db;
dand5e6fef2018-09-07 15:50:31 +00001287 Trigger *pNew = pParse->pNewTrigger;
danc9461ec2018-08-29 21:00:16 +00001288 TriggerStep *pStep;
1289 NameContext sNC;
1290 int rc = SQLITE_OK;
1291
1292 memset(&sNC, 0, sizeof(sNC));
1293 sNC.pParse = pParse;
dand5e6fef2018-09-07 15:50:31 +00001294 assert( pNew->pTabSchema );
1295 pParse->pTriggerTab = sqlite3FindTable(db, pNew->table,
1296 db->aDb[sqlite3SchemaToIndex(db, pNew->pTabSchema)].zDbSName
1297 );
1298 pParse->eTriggerOp = pNew->op;
drhf470c372018-10-03 18:05:36 +00001299 /* ALWAYS() because if the table of the trigger does not exist, the
1300 ** error would have been hit before this point */
1301 if( ALWAYS(pParse->pTriggerTab) ){
dan5351e882018-10-01 07:04:12 +00001302 rc = sqlite3ViewGetColumnNames(pParse, pParse->pTriggerTab);
1303 }
danc9461ec2018-08-29 21:00:16 +00001304
1305 /* Resolve symbols in WHEN clause */
dan5351e882018-10-01 07:04:12 +00001306 if( rc==SQLITE_OK && pNew->pWhen ){
dand5e6fef2018-09-07 15:50:31 +00001307 rc = sqlite3ResolveExprNames(&sNC, pNew->pWhen);
danc9461ec2018-08-29 21:00:16 +00001308 }
1309
dand5e6fef2018-09-07 15:50:31 +00001310 for(pStep=pNew->step_list; rc==SQLITE_OK && pStep; pStep=pStep->pNext){
danc9461ec2018-08-29 21:00:16 +00001311 if( pStep->pSelect ){
1312 sqlite3SelectPrep(pParse, pStep->pSelect, &sNC);
1313 if( pParse->nErr ) rc = pParse->rc;
1314 }
dand5e6fef2018-09-07 15:50:31 +00001315 if( rc==SQLITE_OK && pStep->zTarget ){
dane7877b22020-07-14 19:51:01 +00001316 SrcList *pSrc = sqlite3TriggerStepSrc(pParse, pStep);
1317 if( pSrc ){
1318 int i;
drha3e64952020-08-12 16:19:12 +00001319 for(i=0; i<pSrc->nSrc && rc==SQLITE_OK; i++){
drh76012942021-02-21 21:04:54 +00001320 SrcItem *p = &pSrc->a[i];
dane7877b22020-07-14 19:51:01 +00001321 p->iCursor = pParse->nTab++;
dan7a39fae2020-10-31 16:33:01 +00001322 if( p->pSelect ){
1323 sqlite3SelectPrep(pParse, p->pSelect, 0);
1324 sqlite3ExpandSubquery(pParse, p);
1325 assert( i>0 );
1326 assert( pStep->pFrom->a[i-1].pSelect );
1327 sqlite3SelectPrep(pParse, pStep->pFrom->a[i-1].pSelect, 0);
dane7877b22020-07-14 19:51:01 +00001328 }else{
dan7a39fae2020-10-31 16:33:01 +00001329 p->pTab = sqlite3LocateTableItem(pParse, 0, p);
1330 if( p->pTab==0 ){
1331 rc = SQLITE_ERROR;
1332 }else{
1333 p->pTab->nTabRef++;
1334 rc = sqlite3ViewGetColumnNames(pParse, p->pTab);
1335 }
dane7877b22020-07-14 19:51:01 +00001336 }
1337 }
drh61a8ad72021-11-02 17:55:01 +00001338 if( rc==SQLITE_OK && db->mallocFailed ){
1339 rc = SQLITE_NOMEM;
1340 }
dane7877b22020-07-14 19:51:01 +00001341 sNC.pSrcList = pSrc;
1342 if( rc==SQLITE_OK && pStep->pWhere ){
danc9461ec2018-08-29 21:00:16 +00001343 rc = sqlite3ResolveExprNames(&sNC, pStep->pWhere);
1344 }
1345 if( rc==SQLITE_OK ){
1346 rc = sqlite3ResolveExprListNames(&sNC, pStep->pExprList);
1347 }
1348 assert( !pStep->pUpsert || (!pStep->pWhere && !pStep->pExprList) );
drhe58b2b42021-03-08 17:17:38 +00001349 if( pStep->pUpsert && rc==SQLITE_OK ){
danc9461ec2018-08-29 21:00:16 +00001350 Upsert *pUpsert = pStep->pUpsert;
dane7877b22020-07-14 19:51:01 +00001351 pUpsert->pUpsertSrc = pSrc;
danc9461ec2018-08-29 21:00:16 +00001352 sNC.uNC.pUpsert = pUpsert;
1353 sNC.ncFlags = NC_UUpsert;
1354 rc = sqlite3ResolveExprListNames(&sNC, pUpsert->pUpsertTarget);
1355 if( rc==SQLITE_OK ){
1356 ExprList *pUpsertSet = pUpsert->pUpsertSet;
1357 rc = sqlite3ResolveExprListNames(&sNC, pUpsertSet);
1358 }
1359 if( rc==SQLITE_OK ){
1360 rc = sqlite3ResolveExprNames(&sNC, pUpsert->pUpsertWhere);
1361 }
1362 if( rc==SQLITE_OK ){
1363 rc = sqlite3ResolveExprNames(&sNC, pUpsert->pUpsertTargetWhere);
1364 }
1365 sNC.ncFlags = 0;
1366 }
dan0e14e982019-01-18 16:06:18 +00001367 sNC.pSrcList = 0;
dane7877b22020-07-14 19:51:01 +00001368 sqlite3SrcListDelete(db, pSrc);
1369 }else{
1370 rc = SQLITE_NOMEM;
danc9461ec2018-08-29 21:00:16 +00001371 }
1372 }
1373 }
1374 return rc;
1375}
1376
dandd1a9c82018-09-05 08:28:30 +00001377/*
1378** Invoke sqlite3WalkExpr() or sqlite3WalkSelect() on all Select or Expr
1379** objects that are part of the trigger passed as the second argument.
1380*/
danc9461ec2018-08-29 21:00:16 +00001381static void renameWalkTrigger(Walker *pWalker, Trigger *pTrigger){
1382 TriggerStep *pStep;
1383
1384 /* Find tokens to edit in WHEN clause */
1385 sqlite3WalkExpr(pWalker, pTrigger->pWhen);
1386
1387 /* Find tokens to edit in trigger steps */
1388 for(pStep=pTrigger->step_list; pStep; pStep=pStep->pNext){
1389 sqlite3WalkSelect(pWalker, pStep->pSelect);
1390 sqlite3WalkExpr(pWalker, pStep->pWhere);
1391 sqlite3WalkExprList(pWalker, pStep->pExprList);
1392 if( pStep->pUpsert ){
1393 Upsert *pUpsert = pStep->pUpsert;
1394 sqlite3WalkExprList(pWalker, pUpsert->pUpsertTarget);
1395 sqlite3WalkExprList(pWalker, pUpsert->pUpsertSet);
1396 sqlite3WalkExpr(pWalker, pUpsert->pUpsertWhere);
1397 sqlite3WalkExpr(pWalker, pUpsert->pUpsertTargetWhere);
1398 }
dan7a39fae2020-10-31 16:33:01 +00001399 if( pStep->pFrom ){
1400 int i;
1401 for(i=0; i<pStep->pFrom->nSrc; i++){
1402 sqlite3WalkSelect(pWalker, pStep->pFrom->a[i].pSelect);
1403 }
1404 }
danc9461ec2018-08-29 21:00:16 +00001405 }
1406}
1407
dandd1a9c82018-09-05 08:28:30 +00001408/*
1409** Free the contents of Parse object (*pParse). Do not free the memory
1410** occupied by the Parse object itself.
1411*/
dan141e1192018-08-31 18:23:53 +00001412static void renameParseCleanup(Parse *pParse){
1413 sqlite3 *db = pParse->db;
drh885eeb62019-01-09 02:02:24 +00001414 Index *pIdx;
dan141e1192018-08-31 18:23:53 +00001415 if( pParse->pVdbe ){
1416 sqlite3VdbeFinalize(pParse->pVdbe);
1417 }
1418 sqlite3DeleteTable(db, pParse->pNewTable);
drh885eeb62019-01-09 02:02:24 +00001419 while( (pIdx = pParse->pNewIndex)!=0 ){
1420 pParse->pNewIndex = pIdx->pNext;
1421 sqlite3FreeIndex(db, pIdx);
1422 }
dan141e1192018-08-31 18:23:53 +00001423 sqlite3DeleteTrigger(db, pParse->pNewTrigger);
1424 sqlite3DbFree(db, pParse->zErrMsg);
1425 renameTokenFree(db, pParse->pRename);
drhc692df22022-01-24 15:34:55 +00001426 sqlite3ParseObjectReset(pParse);
dan141e1192018-08-31 18:23:53 +00001427}
1428
dan06249392018-08-21 15:06:59 +00001429/*
dan987db762018-08-14 20:18:50 +00001430** SQL function:
1431**
drh5a800502022-02-04 16:43:30 +00001432** sqlite_rename_column(SQL,TYPE,OBJ,DB,TABLE,COL,NEWNAME,QUOTE,TEMP)
dan987db762018-08-14 20:18:50 +00001433**
1434** 0. zSql: SQL statement to rewrite
danb0137382018-08-20 20:01:01 +00001435** 1. type: Type of object ("table", "view" etc.)
1436** 2. object: Name of object
1437** 3. Database: Database name (e.g. "main")
1438** 4. Table: Table name
1439** 5. iCol: Index of column to rename
1440** 6. zNew: New column name
dan9d324822018-08-30 20:03:44 +00001441** 7. bQuote: Non-zero if the new column name should be quoted.
danb87a9a82018-09-01 20:23:28 +00001442** 8. bTemp: True if zSql comes from temp schema
dan987db762018-08-14 20:18:50 +00001443**
1444** Do a column rename operation on the CREATE statement given in zSql.
1445** The iCol-th column (left-most is 0) of table zTable is renamed from zCol
1446** into zNew. The name should be quoted if bQuote is true.
1447**
1448** This function is used internally by the ALTER TABLE RENAME COLUMN command.
drheea8eb62018-11-26 18:09:15 +00001449** It is only accessible to SQL created using sqlite3NestedParse(). It is
drh5a800502022-02-04 16:43:30 +00001450** not reachable from ordinary SQL passed into sqlite3_prepare() unless the
1451** SQLITE_TESTCTRL_INTERNAL_FUNCTIONS test setting is enabled.
dan6fe7f232018-08-10 19:19:33 +00001452*/
dancf8f2892018-08-09 20:47:01 +00001453static void renameColumnFunc(
1454 sqlite3_context *context,
1455 int NotUsed,
1456 sqlite3_value **argv
1457){
1458 sqlite3 *db = sqlite3_context_db_handle(context);
dan5496d6a2018-08-13 17:14:26 +00001459 RenameCtx sCtx;
drhad866a12018-08-10 19:33:09 +00001460 const char *zSql = (const char*)sqlite3_value_text(argv[0]);
danb0137382018-08-20 20:01:01 +00001461 const char *zDb = (const char*)sqlite3_value_text(argv[3]);
1462 const char *zTable = (const char*)sqlite3_value_text(argv[4]);
1463 int iCol = sqlite3_value_int(argv[5]);
1464 const char *zNew = (const char*)sqlite3_value_text(argv[6]);
danb0137382018-08-20 20:01:01 +00001465 int bQuote = sqlite3_value_int(argv[7]);
danb87a9a82018-09-01 20:23:28 +00001466 int bTemp = sqlite3_value_int(argv[8]);
dan987db762018-08-14 20:18:50 +00001467 const char *zOld;
dancf8f2892018-08-09 20:47:01 +00001468 int rc;
dancf8f2892018-08-09 20:47:01 +00001469 Parse sParse;
1470 Walker sWalker;
dancf8f2892018-08-09 20:47:01 +00001471 Index *pIdx;
dancf8f2892018-08-09 20:47:01 +00001472 int i;
dan987db762018-08-14 20:18:50 +00001473 Table *pTab;
dan141e1192018-08-31 18:23:53 +00001474#ifndef SQLITE_OMIT_AUTHORIZATION
1475 sqlite3_xauth xAuth = db->xAuth;
1476#endif
dancf8f2892018-08-09 20:47:01 +00001477
drh38d99642018-08-18 18:27:18 +00001478 UNUSED_PARAMETER(NotUsed);
dan987db762018-08-14 20:18:50 +00001479 if( zSql==0 ) return;
dan987db762018-08-14 20:18:50 +00001480 if( zTable==0 ) return;
danb0137382018-08-20 20:01:01 +00001481 if( zNew==0 ) return;
dan987db762018-08-14 20:18:50 +00001482 if( iCol<0 ) return;
drhda76adc2018-08-25 02:04:05 +00001483 sqlite3BtreeEnterAll(db);
dan987db762018-08-14 20:18:50 +00001484 pTab = sqlite3FindTable(db, zTable, zDb);
drhda76adc2018-08-25 02:04:05 +00001485 if( pTab==0 || iCol>=pTab->nCol ){
1486 sqlite3BtreeLeaveAll(db);
1487 return;
1488 }
drhcf9d36d2021-08-02 18:03:43 +00001489 zOld = pTab->aCol[iCol].zCnName;
dancf8f2892018-08-09 20:47:01 +00001490 memset(&sCtx, 0, sizeof(sCtx));
dan987db762018-08-14 20:18:50 +00001491 sCtx.iCol = ((iCol==pTab->iPKey) ? -1 : iCol);
dancf8f2892018-08-09 20:47:01 +00001492
dan141e1192018-08-31 18:23:53 +00001493#ifndef SQLITE_OMIT_AUTHORIZATION
1494 db->xAuth = 0;
1495#endif
drhb2ab3dc2019-12-20 14:08:34 +00001496 rc = renameParseSql(&sParse, zDb, db, zSql, bTemp);
dan24fedb92018-08-18 17:35:38 +00001497
dancf8f2892018-08-09 20:47:01 +00001498 /* Find tokens that need to be replaced. */
1499 memset(&sWalker, 0, sizeof(Walker));
1500 sWalker.pParse = &sParse;
1501 sWalker.xExprCallback = renameColumnExprCb;
dan987db762018-08-14 20:18:50 +00001502 sWalker.xSelectCallback = renameColumnSelectCb;
dancf8f2892018-08-09 20:47:01 +00001503 sWalker.u.pRename = &sCtx;
1504
dan0cbb0b12018-08-16 19:49:16 +00001505 sCtx.pTab = pTab;
dan987db762018-08-14 20:18:50 +00001506 if( rc!=SQLITE_OK ) goto renameColumnFunc_done;
dancf8f2892018-08-09 20:47:01 +00001507 if( sParse.pNewTable ){
drhf38524d2021-08-02 16:41:57 +00001508 if( IsView(sParse.pNewTable) ){
1509 Select *pSelect = sParse.pNewTable->u.view.pSelect;
dan38096962019-12-09 08:13:43 +00001510 pSelect->selFlags &= ~SF_View;
dan987db762018-08-14 20:18:50 +00001511 sParse.rc = SQLITE_OK;
dan38096962019-12-09 08:13:43 +00001512 sqlite3SelectPrep(&sParse, pSelect, 0);
dan987db762018-08-14 20:18:50 +00001513 rc = (db->mallocFailed ? SQLITE_NOMEM : sParse.rc);
1514 if( rc==SQLITE_OK ){
1515 sqlite3WalkSelect(&sWalker, pSelect);
dana8762ae2018-08-11 17:49:23 +00001516 }
dan987db762018-08-14 20:18:50 +00001517 if( rc!=SQLITE_OK ) goto renameColumnFunc_done;
drhe73e9572021-09-16 13:20:29 +00001518 }else if( IsOrdinaryTable(sParse.pNewTable) ){
dan987db762018-08-14 20:18:50 +00001519 /* A regular table */
1520 int bFKOnly = sqlite3_stricmp(zTable, sParse.pNewTable->zName);
1521 FKey *pFKey;
dan0cbb0b12018-08-16 19:49:16 +00001522 sCtx.pTab = sParse.pNewTable;
dan987db762018-08-14 20:18:50 +00001523 if( bFKOnly==0 ){
drh06258a42021-06-04 23:26:56 +00001524 if( iCol<sParse.pNewTable->nCol ){
1525 renameTokenFind(
drhcf9d36d2021-08-02 18:03:43 +00001526 &sParse, &sCtx, (void*)sParse.pNewTable->aCol[iCol].zCnName
drh06258a42021-06-04 23:26:56 +00001527 );
1528 }
dan987db762018-08-14 20:18:50 +00001529 if( sCtx.iCol<0 ){
1530 renameTokenFind(&sParse, &sCtx, (void*)&sParse.pNewTable->iPKey);
dancf8f2892018-08-09 20:47:01 +00001531 }
dan987db762018-08-14 20:18:50 +00001532 sqlite3WalkExprList(&sWalker, sParse.pNewTable->pCheck);
1533 for(pIdx=sParse.pNewTable->pIndex; pIdx; pIdx=pIdx->pNext){
1534 sqlite3WalkExprList(&sWalker, pIdx->aColExpr);
1535 }
drh885eeb62019-01-09 02:02:24 +00001536 for(pIdx=sParse.pNewIndex; pIdx; pIdx=pIdx->pNext){
1537 sqlite3WalkExprList(&sWalker, pIdx->aColExpr);
1538 }
drhb9bcf7c2019-10-19 13:29:10 +00001539#ifndef SQLITE_OMIT_GENERATED_COLUMNS
dan776a5782021-03-16 11:11:07 +00001540 for(i=0; i<sParse.pNewTable->nCol; i++){
drh79cf2b72021-07-31 20:30:41 +00001541 Expr *pExpr = sqlite3ColumnExpr(sParse.pNewTable,
1542 &sParse.pNewTable->aCol[i]);
1543 sqlite3WalkExpr(&sWalker, pExpr);
dan776a5782021-03-16 11:11:07 +00001544 }
drhb9bcf7c2019-10-19 13:29:10 +00001545#endif
dan776a5782021-03-16 11:11:07 +00001546 }
dan987db762018-08-14 20:18:50 +00001547
drh78b2fa82021-10-07 12:11:20 +00001548 assert( IsOrdinaryTable(sParse.pNewTable) );
drhf38524d2021-08-02 16:41:57 +00001549 for(pFKey=sParse.pNewTable->u.tab.pFKey; pFKey; pFKey=pFKey->pNextFrom){
dan987db762018-08-14 20:18:50 +00001550 for(i=0; i<pFKey->nCol; i++){
dan356afab2018-08-14 21:05:35 +00001551 if( bFKOnly==0 && pFKey->aCol[i].iFrom==iCol ){
dan987db762018-08-14 20:18:50 +00001552 renameTokenFind(&sParse, &sCtx, (void*)&pFKey->aCol[i]);
1553 }
1554 if( 0==sqlite3_stricmp(pFKey->zTo, zTable)
1555 && 0==sqlite3_stricmp(pFKey->aCol[i].zCol, zOld)
1556 ){
1557 renameTokenFind(&sParse, &sCtx, (void*)pFKey->aCol[i].zCol);
1558 }
dan6fe7f232018-08-10 19:19:33 +00001559 }
dancf8f2892018-08-09 20:47:01 +00001560 }
1561 }
dan5496d6a2018-08-13 17:14:26 +00001562 }else if( sParse.pNewIndex ){
dancf8f2892018-08-09 20:47:01 +00001563 sqlite3WalkExprList(&sWalker, sParse.pNewIndex->aColExpr);
1564 sqlite3WalkExpr(&sWalker, sParse.pNewIndex->pPartIdxWhere);
dan5496d6a2018-08-13 17:14:26 +00001565 }else{
dan5be60c52018-08-15 20:28:39 +00001566 /* A trigger */
1567 TriggerStep *pStep;
drha7c74002020-07-18 18:44:59 +00001568 rc = renameResolveTrigger(&sParse);
danc9461ec2018-08-29 21:00:16 +00001569 if( rc!=SQLITE_OK ) goto renameColumnFunc_done;
dan5be60c52018-08-15 20:28:39 +00001570
danc9461ec2018-08-29 21:00:16 +00001571 for(pStep=sParse.pNewTrigger->step_list; pStep; pStep=pStep->pNext){
1572 if( pStep->zTarget ){
dan06249392018-08-21 15:06:59 +00001573 Table *pTarget = sqlite3LocateTable(&sParse, 0, pStep->zTarget, zDb);
danc9461ec2018-08-29 21:00:16 +00001574 if( pTarget==pTab ){
dan0cbb0b12018-08-16 19:49:16 +00001575 if( pStep->pUpsert ){
danc9461ec2018-08-29 21:00:16 +00001576 ExprList *pUpsertSet = pStep->pUpsert->pUpsertSet;
1577 renameColumnElistNames(&sParse, &sCtx, pUpsertSet, zOld);
dan0cbb0b12018-08-16 19:49:16 +00001578 }
danc9461ec2018-08-29 21:00:16 +00001579 renameColumnIdlistNames(&sParse, &sCtx, pStep->pIdList, zOld);
1580 renameColumnElistNames(&sParse, &sCtx, pStep->pExprList, zOld);
dan5be60c52018-08-15 20:28:39 +00001581 }
1582 }
1583 }
1584
dan5be60c52018-08-15 20:28:39 +00001585
1586 /* Find tokens to edit in UPDATE OF clause */
dan06249392018-08-21 15:06:59 +00001587 if( sParse.pTriggerTab==pTab ){
1588 renameColumnIdlistNames(&sParse, &sCtx,sParse.pNewTrigger->pColumns,zOld);
dan5496d6a2018-08-13 17:14:26 +00001589 }
dan5be60c52018-08-15 20:28:39 +00001590
danc9461ec2018-08-29 21:00:16 +00001591 /* Find tokens to edit in various expressions and selects */
1592 renameWalkTrigger(&sWalker, sParse.pNewTrigger);
dancf8f2892018-08-09 20:47:01 +00001593 }
1594
dan987db762018-08-14 20:18:50 +00001595 assert( rc==SQLITE_OK );
danc9461ec2018-08-29 21:00:16 +00001596 rc = renameEditSql(context, &sCtx, zSql, zNew, bQuote);
dancf8f2892018-08-09 20:47:01 +00001597
drh5fc22cd2018-08-13 13:43:11 +00001598renameColumnFunc_done:
dan987db762018-08-14 20:18:50 +00001599 if( rc!=SQLITE_OK ){
drh89e9baa2022-02-06 21:13:59 +00001600 if( rc==SQLITE_ERROR && sqlite3WritableSchema(db) ){
drh5a800502022-02-04 16:43:30 +00001601 sqlite3_result_value(context, argv[0]);
1602 }else if( sParse.zErrMsg ){
dan16953462021-02-18 19:25:44 +00001603 renameColumnParseError(context, "", argv[1], argv[2], &sParse);
dan987db762018-08-14 20:18:50 +00001604 }else{
1605 sqlite3_result_error_code(context, rc);
1606 }
1607 }
1608
dan141e1192018-08-31 18:23:53 +00001609 renameParseCleanup(&sParse);
drh4a2c7472018-08-13 15:09:48 +00001610 renameTokenFree(db, sCtx.pList);
dan141e1192018-08-31 18:23:53 +00001611#ifndef SQLITE_OMIT_AUTHORIZATION
1612 db->xAuth = xAuth;
1613#endif
drhda76adc2018-08-25 02:04:05 +00001614 sqlite3BtreeLeaveAll(db);
dancf8f2892018-08-09 20:47:01 +00001615}
1616
dandd1a9c82018-09-05 08:28:30 +00001617/*
1618** Walker expression callback used by "RENAME TABLE".
1619*/
danc9461ec2018-08-29 21:00:16 +00001620static int renameTableExprCb(Walker *pWalker, Expr *pExpr){
1621 RenameCtx *p = pWalker->u.pRename;
drh477572b2021-10-07 20:46:29 +00001622 if( pExpr->op==TK_COLUMN
1623 && ALWAYS(ExprUseYTab(pExpr))
1624 && p->pTab==pExpr->y.pTab
1625 ){
drheda079c2018-09-20 19:02:15 +00001626 renameTokenFind(pWalker->pParse, p, (void*)&pExpr->y.pTab);
danc9461ec2018-08-29 21:00:16 +00001627 }
1628 return WRC_Continue;
1629}
1630
1631/*
dandd1a9c82018-09-05 08:28:30 +00001632** Walker select callback used by "RENAME TABLE".
danc9461ec2018-08-29 21:00:16 +00001633*/
1634static int renameTableSelectCb(Walker *pWalker, Select *pSelect){
1635 int i;
1636 RenameCtx *p = pWalker->u.pRename;
1637 SrcList *pSrc = pSelect->pSrc;
danac67f562021-06-14 20:08:48 +00001638 if( pSelect->selFlags & (SF_View|SF_CopyCte) ){
1639 testcase( pSelect->selFlags & SF_View );
1640 testcase( pSelect->selFlags & SF_CopyCte );
1641 return WRC_Prune;
1642 }
drh9da977f2021-04-20 12:14:12 +00001643 if( NEVER(pSrc==0) ){
drh92a28242019-10-09 15:37:58 +00001644 assert( pWalker->pParse->db->mallocFailed );
drh974b2482018-12-06 01:53:12 +00001645 return WRC_Abort;
1646 }
danc9461ec2018-08-29 21:00:16 +00001647 for(i=0; i<pSrc->nSrc; i++){
drh76012942021-02-21 21:04:54 +00001648 SrcItem *pItem = &pSrc->a[i];
danc9461ec2018-08-29 21:00:16 +00001649 if( pItem->pTab==p->pTab ){
1650 renameTokenFind(pWalker->pParse, p, pItem->zName);
1651 }
1652 }
danea412512018-12-05 13:49:04 +00001653 renameWalkWith(pWalker, pSelect);
danc9461ec2018-08-29 21:00:16 +00001654
1655 return WRC_Continue;
1656}
1657
1658
1659/*
1660** This C function implements an SQL user function that is used by SQL code
1661** generated by the ALTER TABLE ... RENAME command to modify the definition
1662** of any foreign key constraints that use the table being renamed as the
1663** parent table. It is passed three arguments:
1664**
dan141e1192018-08-31 18:23:53 +00001665** 0: The database containing the table being renamed.
dan65372fa2018-09-03 20:05:15 +00001666** 1. type: Type of object ("table", "view" etc.)
1667** 2. object: Name of object
1668** 3: The complete text of the schema statement being modified,
1669** 4: The old name of the table being renamed, and
1670** 5: The new name of the table being renamed.
1671** 6: True if the schema statement comes from the temp db.
danc9461ec2018-08-29 21:00:16 +00001672**
dan141e1192018-08-31 18:23:53 +00001673** It returns the new schema statement. For example:
danc9461ec2018-08-29 21:00:16 +00001674**
dan141e1192018-08-31 18:23:53 +00001675** sqlite_rename_table('main', 'CREATE TABLE t1(a REFERENCES t2)','t2','t3',0)
danc9461ec2018-08-29 21:00:16 +00001676** -> 'CREATE TABLE t1(a REFERENCES t3)'
1677*/
1678static void renameTableFunc(
1679 sqlite3_context *context,
1680 int NotUsed,
1681 sqlite3_value **argv
1682){
1683 sqlite3 *db = sqlite3_context_db_handle(context);
drh5b1da302018-09-01 20:02:07 +00001684 const char *zDb = (const char*)sqlite3_value_text(argv[0]);
dan65372fa2018-09-03 20:05:15 +00001685 const char *zInput = (const char*)sqlite3_value_text(argv[3]);
1686 const char *zOld = (const char*)sqlite3_value_text(argv[4]);
1687 const char *zNew = (const char*)sqlite3_value_text(argv[5]);
1688 int bTemp = sqlite3_value_int(argv[6]);
drh5b1da302018-09-01 20:02:07 +00001689 UNUSED_PARAMETER(NotUsed);
danc9461ec2018-08-29 21:00:16 +00001690
dan141e1192018-08-31 18:23:53 +00001691 if( zInput && zOld && zNew ){
dan141e1192018-08-31 18:23:53 +00001692 Parse sParse;
1693 int rc;
1694 int bQuote = 1;
1695 RenameCtx sCtx;
1696 Walker sWalker;
danc9461ec2018-08-29 21:00:16 +00001697
dan141e1192018-08-31 18:23:53 +00001698#ifndef SQLITE_OMIT_AUTHORIZATION
1699 sqlite3_xauth xAuth = db->xAuth;
1700 db->xAuth = 0;
danc9461ec2018-08-29 21:00:16 +00001701#endif
1702
dan141e1192018-08-31 18:23:53 +00001703 sqlite3BtreeEnterAll(db);
1704
1705 memset(&sCtx, 0, sizeof(RenameCtx));
1706 sCtx.pTab = sqlite3FindTable(db, zOld, zDb);
1707 memset(&sWalker, 0, sizeof(Walker));
1708 sWalker.pParse = &sParse;
1709 sWalker.xExprCallback = renameTableExprCb;
1710 sWalker.xSelectCallback = renameTableSelectCb;
1711 sWalker.u.pRename = &sCtx;
1712
drhb2ab3dc2019-12-20 14:08:34 +00001713 rc = renameParseSql(&sParse, zDb, db, zInput, bTemp);
dan141e1192018-08-31 18:23:53 +00001714
1715 if( rc==SQLITE_OK ){
dan674b8942018-09-20 08:28:01 +00001716 int isLegacy = (db->flags & SQLITE_LegacyAlter);
dan141e1192018-08-31 18:23:53 +00001717 if( sParse.pNewTable ){
1718 Table *pTab = sParse.pNewTable;
1719
drhf38524d2021-08-02 16:41:57 +00001720 if( IsView(pTab) ){
dan674b8942018-09-20 08:28:01 +00001721 if( isLegacy==0 ){
drhf38524d2021-08-02 16:41:57 +00001722 Select *pSelect = pTab->u.view.pSelect;
dan674b8942018-09-20 08:28:01 +00001723 NameContext sNC;
1724 memset(&sNC, 0, sizeof(sNC));
1725 sNC.pParse = &sParse;
dan141e1192018-08-31 18:23:53 +00001726
dan38096962019-12-09 08:13:43 +00001727 assert( pSelect->selFlags & SF_View );
1728 pSelect->selFlags &= ~SF_View;
drhf38524d2021-08-02 16:41:57 +00001729 sqlite3SelectPrep(&sParse, pTab->u.view.pSelect, &sNC);
drh1548d522019-12-20 12:55:21 +00001730 if( sParse.nErr ){
1731 rc = sParse.rc;
1732 }else{
drhf38524d2021-08-02 16:41:57 +00001733 sqlite3WalkSelect(&sWalker, pTab->u.view.pSelect);
drh1548d522019-12-20 12:55:21 +00001734 }
dan674b8942018-09-20 08:28:01 +00001735 }
dan141e1192018-08-31 18:23:53 +00001736 }else{
1737 /* Modify any FK definitions to point to the new table. */
1738#ifndef SQLITE_OMIT_FOREIGN_KEY
drhf38524d2021-08-02 16:41:57 +00001739 if( (isLegacy==0 || (db->flags & SQLITE_ForeignKeys))
1740 && !IsVirtual(pTab)
1741 ){
dan202a0272018-09-07 11:51:21 +00001742 FKey *pFKey;
drh78b2fa82021-10-07 12:11:20 +00001743 assert( IsOrdinaryTable(pTab) );
drhf38524d2021-08-02 16:41:57 +00001744 for(pFKey=pTab->u.tab.pFKey; pFKey; pFKey=pFKey->pNextFrom){
dan202a0272018-09-07 11:51:21 +00001745 if( sqlite3_stricmp(pFKey->zTo, zOld)==0 ){
1746 renameTokenFind(&sParse, &sCtx, (void*)pFKey->zTo);
1747 }
dan141e1192018-08-31 18:23:53 +00001748 }
1749 }
1750#endif
1751
1752 /* If this is the table being altered, fix any table refs in CHECK
1753 ** expressions. Also update the name that appears right after the
1754 ** "CREATE [VIRTUAL] TABLE" bit. */
1755 if( sqlite3_stricmp(zOld, pTab->zName)==0 ){
1756 sCtx.pTab = pTab;
dan674b8942018-09-20 08:28:01 +00001757 if( isLegacy==0 ){
1758 sqlite3WalkExprList(&sWalker, pTab->pCheck);
1759 }
dan141e1192018-08-31 18:23:53 +00001760 renameTokenFind(&sParse, &sCtx, pTab->zName);
1761 }
danc9461ec2018-08-29 21:00:16 +00001762 }
1763 }
danc9461ec2018-08-29 21:00:16 +00001764
dan141e1192018-08-31 18:23:53 +00001765 else if( sParse.pNewIndex ){
1766 renameTokenFind(&sParse, &sCtx, sParse.pNewIndex->zName);
dan674b8942018-09-20 08:28:01 +00001767 if( isLegacy==0 ){
1768 sqlite3WalkExpr(&sWalker, sParse.pNewIndex->pPartIdxWhere);
1769 }
dan141e1192018-08-31 18:23:53 +00001770 }
danc9461ec2018-08-29 21:00:16 +00001771
1772#ifndef SQLITE_OMIT_TRIGGER
danb87a9a82018-09-01 20:23:28 +00001773 else{
dan141e1192018-08-31 18:23:53 +00001774 Trigger *pTrigger = sParse.pNewTrigger;
1775 TriggerStep *pStep;
1776 if( 0==sqlite3_stricmp(sParse.pNewTrigger->table, zOld)
1777 && sCtx.pTab->pSchema==pTrigger->pTabSchema
1778 ){
1779 renameTokenFind(&sParse, &sCtx, sParse.pNewTrigger->table);
1780 }
danc9461ec2018-08-29 21:00:16 +00001781
dan674b8942018-09-20 08:28:01 +00001782 if( isLegacy==0 ){
drha7c74002020-07-18 18:44:59 +00001783 rc = renameResolveTrigger(&sParse);
dan674b8942018-09-20 08:28:01 +00001784 if( rc==SQLITE_OK ){
1785 renameWalkTrigger(&sWalker, pTrigger);
1786 for(pStep=pTrigger->step_list; pStep; pStep=pStep->pNext){
1787 if( pStep->zTarget && 0==sqlite3_stricmp(pStep->zTarget, zOld) ){
1788 renameTokenFind(&sParse, &sCtx, pStep->zTarget);
1789 }
dan141e1192018-08-31 18:23:53 +00001790 }
dan0ccda962018-08-30 16:26:48 +00001791 }
danc9461ec2018-08-29 21:00:16 +00001792 }
1793 }
dan141e1192018-08-31 18:23:53 +00001794#endif
danc9461ec2018-08-29 21:00:16 +00001795 }
dan141e1192018-08-31 18:23:53 +00001796
1797 if( rc==SQLITE_OK ){
1798 rc = renameEditSql(context, &sCtx, zInput, zNew, bQuote);
1799 }
1800 if( rc!=SQLITE_OK ){
drh89e9baa2022-02-06 21:13:59 +00001801 if( rc==SQLITE_ERROR && sqlite3WritableSchema(db) ){
drh10d29c72022-02-04 20:07:24 +00001802 sqlite3_result_value(context, argv[3]);
1803 }else if( sParse.zErrMsg ){
dan16953462021-02-18 19:25:44 +00001804 renameColumnParseError(context, "", argv[1], argv[2], &sParse);
dan65372fa2018-09-03 20:05:15 +00001805 }else{
1806 sqlite3_result_error_code(context, rc);
1807 }
dan141e1192018-08-31 18:23:53 +00001808 }
1809
1810 renameParseCleanup(&sParse);
1811 renameTokenFree(db, sCtx.pList);
1812 sqlite3BtreeLeaveAll(db);
1813#ifndef SQLITE_OMIT_AUTHORIZATION
1814 db->xAuth = xAuth;
danc9461ec2018-08-29 21:00:16 +00001815#endif
1816 }
1817
danc9461ec2018-08-29 21:00:16 +00001818 return;
1819}
1820
dan1e240722021-03-15 20:22:34 +00001821static int renameQuotefixExprCb(Walker *pWalker, Expr *pExpr){
1822 if( pExpr->op==TK_STRING && (pExpr->flags & EP_DblQuoted) ){
drhb6dad522021-09-24 16:14:47 +00001823 renameTokenFind(pWalker->pParse, pWalker->u.pRename, (const void*)pExpr);
dan1e240722021-03-15 20:22:34 +00001824 }
1825 return WRC_Continue;
1826}
1827
drh5a800502022-02-04 16:43:30 +00001828/* SQL function: sqlite_rename_quotefix(DB,SQL)
1829**
1830** Rewrite the DDL statement "SQL" so that any string literals that use
1831** double-quotes use single quotes instead.
dan1e240722021-03-15 20:22:34 +00001832**
1833** Two arguments must be passed:
1834**
1835** 0: Database name ("main", "temp" etc.).
1836** 1: SQL statement to edit.
1837**
1838** The returned value is the modified SQL statement. For example, given
1839** the database schema:
1840**
1841** CREATE TABLE t1(a, b, c);
1842**
1843** SELECT sqlite_rename_quotefix('main',
1844** 'CREATE VIEW v1 AS SELECT "a", "string" FROM t1'
1845** );
1846**
1847** returns the string:
1848**
1849** CREATE VIEW v1 AS SELECT "a", 'string' FROM t1
drh5a800502022-02-04 16:43:30 +00001850**
1851** If there is a error in the input SQL, then raise an error, except
1852** if PRAGMA writable_schema=ON, then just return the input string
1853** unmodified following an error.
dan1e240722021-03-15 20:22:34 +00001854*/
1855static void renameQuotefixFunc(
1856 sqlite3_context *context,
1857 int NotUsed,
1858 sqlite3_value **argv
1859){
1860 sqlite3 *db = sqlite3_context_db_handle(context);
1861 char const *zDb = (const char*)sqlite3_value_text(argv[0]);
1862 char const *zInput = (const char*)sqlite3_value_text(argv[1]);
1863
1864#ifndef SQLITE_OMIT_AUTHORIZATION
1865 sqlite3_xauth xAuth = db->xAuth;
1866 db->xAuth = 0;
1867#endif
1868
1869 sqlite3BtreeEnterAll(db);
1870
1871 UNUSED_PARAMETER(NotUsed);
1872 if( zDb && zInput ){
1873 int rc;
1874 Parse sParse;
1875 rc = renameParseSql(&sParse, zDb, db, zInput, 0);
1876
1877 if( rc==SQLITE_OK ){
1878 RenameCtx sCtx;
1879 Walker sWalker;
1880
1881 /* Walker to find tokens that need to be replaced. */
1882 memset(&sCtx, 0, sizeof(RenameCtx));
1883 memset(&sWalker, 0, sizeof(Walker));
1884 sWalker.pParse = &sParse;
1885 sWalker.xExprCallback = renameQuotefixExprCb;
1886 sWalker.xSelectCallback = renameColumnSelectCb;
1887 sWalker.u.pRename = &sCtx;
1888
1889 if( sParse.pNewTable ){
drhf38524d2021-08-02 16:41:57 +00001890 if( IsView(sParse.pNewTable) ){
1891 Select *pSelect = sParse.pNewTable->u.view.pSelect;
dan1e240722021-03-15 20:22:34 +00001892 pSelect->selFlags &= ~SF_View;
1893 sParse.rc = SQLITE_OK;
1894 sqlite3SelectPrep(&sParse, pSelect, 0);
1895 rc = (db->mallocFailed ? SQLITE_NOMEM : sParse.rc);
1896 if( rc==SQLITE_OK ){
1897 sqlite3WalkSelect(&sWalker, pSelect);
1898 }
1899 }else{
1900 int i;
1901 sqlite3WalkExprList(&sWalker, sParse.pNewTable->pCheck);
1902#ifndef SQLITE_OMIT_GENERATED_COLUMNS
1903 for(i=0; i<sParse.pNewTable->nCol; i++){
drh79cf2b72021-07-31 20:30:41 +00001904 sqlite3WalkExpr(&sWalker,
1905 sqlite3ColumnExpr(sParse.pNewTable,
1906 &sParse.pNewTable->aCol[i]));
dan1e240722021-03-15 20:22:34 +00001907 }
1908#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1909 }
1910 }else if( sParse.pNewIndex ){
1911 sqlite3WalkExprList(&sWalker, sParse.pNewIndex->aColExpr);
1912 sqlite3WalkExpr(&sWalker, sParse.pNewIndex->pPartIdxWhere);
1913 }else{
1914#ifndef SQLITE_OMIT_TRIGGER
1915 rc = renameResolveTrigger(&sParse);
1916 if( rc==SQLITE_OK ){
1917 renameWalkTrigger(&sWalker, sParse.pNewTrigger);
1918 }
1919#endif /* SQLITE_OMIT_TRIGGER */
1920 }
1921
1922 if( rc==SQLITE_OK ){
1923 rc = renameEditSql(context, &sCtx, zInput, 0, 0);
1924 }
dan1fffa732021-03-16 18:24:49 +00001925 renameTokenFree(db, sCtx.pList);
dan1e240722021-03-15 20:22:34 +00001926 }
1927 if( rc!=SQLITE_OK ){
drh89e9baa2022-02-06 21:13:59 +00001928 if( sqlite3WritableSchema(db) && rc==SQLITE_ERROR ){
drh5a800502022-02-04 16:43:30 +00001929 sqlite3_result_value(context, argv[1]);
1930 }else{
1931 sqlite3_result_error_code(context, rc);
1932 }
dan1e240722021-03-15 20:22:34 +00001933 }
1934 renameParseCleanup(&sParse);
1935 }
1936
1937#ifndef SQLITE_OMIT_AUTHORIZATION
1938 db->xAuth = xAuth;
1939#endif
1940
1941 sqlite3BtreeLeaveAll(db);
1942}
1943
drh5a800502022-02-04 16:43:30 +00001944/* Function: sqlite_rename_test(DB,SQL,TYPE,NAME,ISTEMP,WHEN,DQS)
1945**
dandd1a9c82018-09-05 08:28:30 +00001946** An SQL user function that checks that there are no parse or symbol
1947** resolution problems in a CREATE TRIGGER|TABLE|VIEW|INDEX statement.
1948** After an ALTER TABLE .. RENAME operation is performed and the schema
1949** reloaded, this function is called on each SQL statement in the schema
dan1d85c6b2018-09-06 16:01:37 +00001950** to ensure that it is still usable.
dandd1a9c82018-09-05 08:28:30 +00001951**
1952** 0: Database name ("main", "temp" etc.).
1953** 1: SQL statement.
1954** 2: Object type ("view", "table", "trigger" or "index").
1955** 3: Object name.
1956** 4: True if object is from temp schema.
dan16953462021-02-18 19:25:44 +00001957** 5: "when" part of error message.
dan2ad080a2021-03-16 16:14:48 +00001958** 6: True to disable the DQS quirk when parsing SQL.
dan1d85c6b2018-09-06 16:01:37 +00001959**
drh5a800502022-02-04 16:43:30 +00001960** The return value is computed as follows:
dan1d85c6b2018-09-06 16:01:37 +00001961**
drh5a800502022-02-04 16:43:30 +00001962** A. If an error is seen and not in PRAGMA writable_schema=ON mode,
1963** then raise the error.
1964** B. Else if a trigger is created and the the table that the trigger is
1965** attached to is in database zDb, then return 1.
1966** C. Otherwise return NULL.
dandd1a9c82018-09-05 08:28:30 +00001967*/
dan9d324822018-08-30 20:03:44 +00001968static void renameTableTest(
1969 sqlite3_context *context,
1970 int NotUsed,
1971 sqlite3_value **argv
1972){
1973 sqlite3 *db = sqlite3_context_db_handle(context);
drh5b1da302018-09-01 20:02:07 +00001974 char const *zDb = (const char*)sqlite3_value_text(argv[0]);
1975 char const *zInput = (const char*)sqlite3_value_text(argv[1]);
dan9d324822018-08-30 20:03:44 +00001976 int bTemp = sqlite3_value_int(argv[4]);
dan674b8942018-09-20 08:28:01 +00001977 int isLegacy = (db->flags & SQLITE_LegacyAlter);
dan16953462021-02-18 19:25:44 +00001978 char const *zWhen = (const char*)sqlite3_value_text(argv[5]);
dan2ad080a2021-03-16 16:14:48 +00001979 int bNoDQS = sqlite3_value_int(argv[6]);
dan9d324822018-08-30 20:03:44 +00001980
dan141e1192018-08-31 18:23:53 +00001981#ifndef SQLITE_OMIT_AUTHORIZATION
1982 sqlite3_xauth xAuth = db->xAuth;
1983 db->xAuth = 0;
1984#endif
1985
drh5b1da302018-09-01 20:02:07 +00001986 UNUSED_PARAMETER(NotUsed);
dan2ad080a2021-03-16 16:14:48 +00001987
dan09236502018-09-01 16:05:50 +00001988 if( zDb && zInput ){
1989 int rc;
1990 Parse sParse;
dan2ad080a2021-03-16 16:14:48 +00001991 int flags = db->flags;
1992 if( bNoDQS ) db->flags &= ~(SQLITE_DqsDML|SQLITE_DqsDDL);
drhb2ab3dc2019-12-20 14:08:34 +00001993 rc = renameParseSql(&sParse, zDb, db, zInput, bTemp);
dan2ad080a2021-03-16 16:14:48 +00001994 db->flags |= (flags & (SQLITE_DqsDML|SQLITE_DqsDDL));
dan09236502018-09-01 16:05:50 +00001995 if( rc==SQLITE_OK ){
drhf38524d2021-08-02 16:41:57 +00001996 if( isLegacy==0 && sParse.pNewTable && IsView(sParse.pNewTable) ){
dan09236502018-09-01 16:05:50 +00001997 NameContext sNC;
1998 memset(&sNC, 0, sizeof(sNC));
1999 sNC.pParse = &sParse;
drhf38524d2021-08-02 16:41:57 +00002000 sqlite3SelectPrep(&sParse, sParse.pNewTable->u.view.pSelect, &sNC);
dan09236502018-09-01 16:05:50 +00002001 if( sParse.nErr ) rc = sParse.rc;
2002 }
2003
2004 else if( sParse.pNewTrigger ){
dan674b8942018-09-20 08:28:01 +00002005 if( isLegacy==0 ){
drha7c74002020-07-18 18:44:59 +00002006 rc = renameResolveTrigger(&sParse);
dan674b8942018-09-20 08:28:01 +00002007 }
drh3b700452018-09-07 19:12:08 +00002008 if( rc==SQLITE_OK ){
dan1d85c6b2018-09-06 16:01:37 +00002009 int i1 = sqlite3SchemaToIndex(db, sParse.pNewTrigger->pTabSchema);
2010 int i2 = sqlite3FindDbName(db, zDb);
drh5a800502022-02-04 16:43:30 +00002011 if( i1==i2 ){
2012 /* Handle output case B */
2013 sqlite3_result_int(context, 1);
2014 }
dan1d85c6b2018-09-06 16:01:37 +00002015 }
dan09236502018-09-01 16:05:50 +00002016 }
dan9d324822018-08-30 20:03:44 +00002017 }
2018
drh569c1052022-02-05 12:05:43 +00002019 if( rc!=SQLITE_OK && zWhen && !sqlite3WritableSchema(db) ){
drh5a800502022-02-04 16:43:30 +00002020 /* Output case A */
dan16953462021-02-18 19:25:44 +00002021 renameColumnParseError(context, zWhen, argv[2], argv[3],&sParse);
dan9d324822018-08-30 20:03:44 +00002022 }
dan09236502018-09-01 16:05:50 +00002023 renameParseCleanup(&sParse);
dan9d324822018-08-30 20:03:44 +00002024 }
2025
dan141e1192018-08-31 18:23:53 +00002026#ifndef SQLITE_OMIT_AUTHORIZATION
2027 db->xAuth = xAuth;
2028#endif
dan9d324822018-08-30 20:03:44 +00002029}
2030
dancf8f2892018-08-09 20:47:01 +00002031/*
dan6a5a13d2021-02-17 20:08:22 +00002032** The implementation of internal UDF sqlite_drop_column().
2033**
dan6e6d9832021-02-16 20:43:36 +00002034** Arguments:
2035**
2036** argv[0]: An integer - the index of the schema containing the table
2037** argv[1]: CREATE TABLE statement to modify.
2038** argv[2]: An integer - the index of the column to remove.
dan6a5a13d2021-02-17 20:08:22 +00002039**
2040** The value returned is a string containing the CREATE TABLE statement
2041** with column argv[2] removed.
dan6e6d9832021-02-16 20:43:36 +00002042*/
2043static void dropColumnFunc(
2044 sqlite3_context *context,
2045 int NotUsed,
2046 sqlite3_value **argv
2047){
2048 sqlite3 *db = sqlite3_context_db_handle(context);
2049 int iSchema = sqlite3_value_int(argv[0]);
2050 const char *zSql = (const char*)sqlite3_value_text(argv[1]);
2051 int iCol = sqlite3_value_int(argv[2]);
dan6e6d9832021-02-16 20:43:36 +00002052 const char *zDb = db->aDb[iSchema].zDbSName;
2053 int rc;
2054 Parse sParse;
2055 RenameToken *pCol;
2056 Table *pTab;
2057 const char *zEnd;
2058 char *zNew = 0;
2059
dan678f3b32021-02-18 20:27:46 +00002060#ifndef SQLITE_OMIT_AUTHORIZATION
2061 sqlite3_xauth xAuth = db->xAuth;
2062 db->xAuth = 0;
2063#endif
2064
drh05edf722021-03-04 19:44:01 +00002065 UNUSED_PARAMETER(NotUsed);
dan6e6d9832021-02-16 20:43:36 +00002066 rc = renameParseSql(&sParse, zDb, db, zSql, iSchema==1);
2067 if( rc!=SQLITE_OK ) goto drop_column_done;
2068 pTab = sParse.pNewTable;
drh747cc942021-03-06 13:02:12 +00002069 if( pTab==0 || pTab->nCol==1 || iCol>=pTab->nCol ){
danf4a72782021-02-19 14:13:40 +00002070 /* This can happen if the sqlite_schema table is corrupt */
2071 rc = SQLITE_CORRUPT_BKPT;
2072 goto drop_column_done;
2073 }
dan6e6d9832021-02-16 20:43:36 +00002074
drhcf9d36d2021-08-02 18:03:43 +00002075 pCol = renameTokenFind(&sParse, 0, (void*)pTab->aCol[iCol].zCnName);
dan6e6d9832021-02-16 20:43:36 +00002076 if( iCol<pTab->nCol-1 ){
2077 RenameToken *pEnd;
drhcf9d36d2021-08-02 18:03:43 +00002078 pEnd = renameTokenFind(&sParse, 0, (void*)pTab->aCol[iCol+1].zCnName);
dan6e6d9832021-02-16 20:43:36 +00002079 zEnd = (const char*)pEnd->t.z;
2080 }else{
drh78b2fa82021-10-07 12:11:20 +00002081 assert( IsOrdinaryTable(pTab) );
drhf38524d2021-08-02 16:41:57 +00002082 zEnd = (const char*)&zSql[pTab->u.tab.addColOffset];
drh60fe2352021-02-19 09:46:52 +00002083 while( ALWAYS(pCol->t.z[0]!=0) && pCol->t.z[0]!=',' ) pCol->t.z--;
dan6e6d9832021-02-16 20:43:36 +00002084 }
2085
danc2a878e2021-02-17 20:46:44 +00002086 zNew = sqlite3MPrintf(db, "%.*s%s", pCol->t.z-zSql, zSql, zEnd);
dan6e6d9832021-02-16 20:43:36 +00002087 sqlite3_result_text(context, zNew, -1, SQLITE_TRANSIENT);
2088 sqlite3_free(zNew);
2089
2090drop_column_done:
2091 renameParseCleanup(&sParse);
dan678f3b32021-02-18 20:27:46 +00002092#ifndef SQLITE_OMIT_AUTHORIZATION
2093 db->xAuth = xAuth;
2094#endif
danf4a72782021-02-19 14:13:40 +00002095 if( rc!=SQLITE_OK ){
2096 sqlite3_result_error_code(context, rc);
2097 }
dan6e6d9832021-02-16 20:43:36 +00002098}
2099
dan6a5a13d2021-02-17 20:08:22 +00002100/*
2101** This function is called by the parser upon parsing an
2102**
2103** ALTER TABLE pSrc DROP COLUMN pName
2104**
2105** statement. Argument pSrc contains the possibly qualified name of the
2106** table being edited, and token pName the name of the column to drop.
2107*/
drhb6dad522021-09-24 16:14:47 +00002108void sqlite3AlterDropColumn(Parse *pParse, SrcList *pSrc, const Token *pName){
dan6a5a13d2021-02-17 20:08:22 +00002109 sqlite3 *db = pParse->db; /* Database handle */
2110 Table *pTab; /* Table to modify */
2111 int iDb; /* Index of db containing pTab in aDb[] */
2112 const char *zDb; /* Database containing pTab ("main" etc.) */
2113 char *zCol = 0; /* Name of column to drop */
2114 int iCol; /* Index of column zCol in pTab->aCol[] */
dan6e6d9832021-02-16 20:43:36 +00002115
2116 /* Look up the table being altered. */
2117 assert( pParse->pNewTable==0 );
2118 assert( sqlite3BtreeHoldsAllMutexes(db) );
drhc90fa012021-02-19 02:30:02 +00002119 if( NEVER(db->mallocFailed) ) goto exit_drop_column;
dan6e6d9832021-02-16 20:43:36 +00002120 pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
2121 if( !pTab ) goto exit_drop_column;
2122
dan6a5a13d2021-02-17 20:08:22 +00002123 /* Make sure this is not an attempt to ALTER a view, virtual table or
2124 ** system table. */
2125 if( SQLITE_OK!=isAlterableTable(pParse, pTab) ) goto exit_drop_column;
2126 if( SQLITE_OK!=isRealTable(pParse, pTab, 1) ) goto exit_drop_column;
dan6e6d9832021-02-16 20:43:36 +00002127
2128 /* Find the index of the column being dropped. */
2129 zCol = sqlite3NameFromToken(db, pName);
2130 if( zCol==0 ){
2131 assert( db->mallocFailed );
2132 goto exit_drop_column;
2133 }
2134 iCol = sqlite3ColumnIndex(pTab, zCol);
2135 if( iCol<0 ){
drh4e532952022-02-08 13:41:23 +00002136 sqlite3ErrorMsg(pParse, "no such column: \"%T\"", pName);
dan6e6d9832021-02-16 20:43:36 +00002137 goto exit_drop_column;
2138 }
2139
2140 /* Do not allow the user to drop a PRIMARY KEY column or a column
2141 ** constrained by a UNIQUE constraint. */
dan6a5a13d2021-02-17 20:08:22 +00002142 if( pTab->aCol[iCol].colFlags & (COLFLAG_PRIMKEY|COLFLAG_UNIQUE) ){
2143 sqlite3ErrorMsg(pParse, "cannot drop %s column: \"%s\"",
2144 (pTab->aCol[iCol].colFlags&COLFLAG_PRIMKEY) ? "PRIMARY KEY" : "UNIQUE",
2145 zCol
2146 );
dan6e6d9832021-02-16 20:43:36 +00002147 goto exit_drop_column;
2148 }
dan6e6d9832021-02-16 20:43:36 +00002149
drh239c84f2021-02-19 09:09:07 +00002150 /* Do not allow the number of columns to go to zero */
2151 if( pTab->nCol<=1 ){
2152 sqlite3ErrorMsg(pParse, "cannot drop column \"%s\": no other columns exist",zCol);
2153 goto exit_drop_column;
2154 }
2155
dan6a5a13d2021-02-17 20:08:22 +00002156 /* Edit the sqlite_schema table */
2157 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2158 assert( iDb>=0 );
2159 zDb = db->aDb[iDb].zDbSName;
drh85b70e02022-01-18 16:16:32 +00002160#ifndef SQLITE_OMIT_AUTHORIZATION
2161 /* Invoke the authorization callback. */
2162 if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, zCol) ){
2163 goto exit_drop_column;
2164 }
2165#endif
dan2ad080a2021-03-16 16:14:48 +00002166 renameTestSchema(pParse, zDb, iDb==1, "", 0);
2167 renameFixQuotes(pParse, zDb, iDb==1);
dan6e6d9832021-02-16 20:43:36 +00002168 sqlite3NestedParse(pParse,
drha4a871c2021-11-04 14:04:20 +00002169 "UPDATE \"%w\"." LEGACY_SCHEMA_TABLE " SET "
dan578277c2021-02-19 18:39:32 +00002170 "sql = sqlite_drop_column(%d, sql, %d) "
dan6e6d9832021-02-16 20:43:36 +00002171 "WHERE (type=='table' AND tbl_name=%Q COLLATE nocase)"
dan578277c2021-02-19 18:39:32 +00002172 , zDb, iDb, iCol, pTab->zName
dan6e6d9832021-02-16 20:43:36 +00002173 );
2174
2175 /* Drop and reload the database schema. */
dan6a5a13d2021-02-17 20:08:22 +00002176 renameReloadSchema(pParse, iDb, INITFLAG_AlterDrop);
dan2ad080a2021-03-16 16:14:48 +00002177 renameTestSchema(pParse, zDb, iDb==1, "after drop column", 1);
dan6e6d9832021-02-16 20:43:36 +00002178
2179 /* Edit rows of table on disk */
danc2a878e2021-02-17 20:46:44 +00002180 if( pParse->nErr==0 && (pTab->aCol[iCol].colFlags & COLFLAG_VIRTUAL)==0 ){
dan6a5a13d2021-02-17 20:08:22 +00002181 int i;
2182 int addr;
2183 int reg;
2184 int regRec;
2185 Index *pPk = 0;
2186 int nField = 0; /* Number of non-virtual columns after drop */
2187 int iCur;
2188 Vdbe *v = sqlite3GetVdbe(pParse);
2189 iCur = pParse->nTab++;
2190 sqlite3OpenTable(pParse, iCur, iDb, pTab, OP_OpenWrite);
drh03361402021-02-18 23:53:47 +00002191 addr = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
dan6a5a13d2021-02-17 20:08:22 +00002192 reg = ++pParse->nMem;
dan6a5a13d2021-02-17 20:08:22 +00002193 if( HasRowid(pTab) ){
2194 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, reg);
dancc263012021-04-06 21:20:39 +00002195 pParse->nMem += pTab->nCol;
dan6a5a13d2021-02-17 20:08:22 +00002196 }else{
2197 pPk = sqlite3PrimaryKeyIndex(pTab);
dancc263012021-04-06 21:20:39 +00002198 pParse->nMem += pPk->nColumn;
2199 for(i=0; i<pPk->nKeyCol; i++){
2200 sqlite3VdbeAddOp3(v, OP_Column, iCur, i, reg+i+1);
2201 }
2202 nField = pPk->nKeyCol;
dan6e6d9832021-02-16 20:43:36 +00002203 }
dancc263012021-04-06 21:20:39 +00002204 regRec = ++pParse->nMem;
dan6a5a13d2021-02-17 20:08:22 +00002205 for(i=0; i<pTab->nCol; i++){
2206 if( i!=iCol && (pTab->aCol[i].colFlags & COLFLAG_VIRTUAL)==0 ){
2207 int regOut;
2208 if( pPk ){
2209 int iPos = sqlite3TableColumnToIndex(pPk, i);
2210 int iColPos = sqlite3TableColumnToIndex(pPk, iCol);
dancc263012021-04-06 21:20:39 +00002211 if( iPos<pPk->nKeyCol ) continue;
dan6a5a13d2021-02-17 20:08:22 +00002212 regOut = reg+1+iPos-(iPos>iColPos);
2213 }else{
2214 regOut = reg+1+nField;
2215 }
dan0a746cc2021-04-18 05:30:39 +00002216 if( i==pTab->iPKey ){
2217 sqlite3VdbeAddOp2(v, OP_Null, 0, regOut);
2218 }else{
2219 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, i, regOut);
2220 }
dan6a5a13d2021-02-17 20:08:22 +00002221 nField++;
2222 }
2223 }
drh55b8b732021-07-22 18:22:51 +00002224 if( nField==0 ){
2225 /* dbsqlfuzz 5f09e7bcc78b4954d06bf9f2400d7715f48d1fef */
2226 pParse->nMem++;
2227 sqlite3VdbeAddOp2(v, OP_Null, 0, reg+1);
2228 nField = 1;
2229 }
dan6a5a13d2021-02-17 20:08:22 +00002230 sqlite3VdbeAddOp3(v, OP_MakeRecord, reg+1, nField, regRec);
2231 if( pPk ){
2232 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iCur, regRec, reg+1, pPk->nKeyCol);
2233 }else{
2234 sqlite3VdbeAddOp3(v, OP_Insert, iCur, regRec, reg);
2235 }
dan0a746cc2021-04-18 05:30:39 +00002236 sqlite3VdbeChangeP5(v, OPFLAG_SAVEPOSITION);
dan6e6d9832021-02-16 20:43:36 +00002237
drh03361402021-02-18 23:53:47 +00002238 sqlite3VdbeAddOp2(v, OP_Next, iCur, addr+1); VdbeCoverage(v);
dan6a5a13d2021-02-17 20:08:22 +00002239 sqlite3VdbeJumpHere(v, addr);
2240 }
dan6e6d9832021-02-16 20:43:36 +00002241
2242exit_drop_column:
2243 sqlite3DbFree(db, zCol);
2244 sqlite3SrcListDelete(db, pSrc);
dan6e6d9832021-02-16 20:43:36 +00002245}
2246
2247/*
dancf8f2892018-08-09 20:47:01 +00002248** Register built-in functions used to help implement ALTER TABLE
2249*/
2250void sqlite3AlterFunctions(void){
2251 static FuncDef aAlterTableFuncs[] = {
dan6e6d9832021-02-16 20:43:36 +00002252 INTERNAL_FUNCTION(sqlite_rename_column, 9, renameColumnFunc),
2253 INTERNAL_FUNCTION(sqlite_rename_table, 7, renameTableFunc),
dan2ad080a2021-03-16 16:14:48 +00002254 INTERNAL_FUNCTION(sqlite_rename_test, 7, renameTableTest),
dan578277c2021-02-19 18:39:32 +00002255 INTERNAL_FUNCTION(sqlite_drop_column, 3, dropColumnFunc),
dan1e240722021-03-15 20:22:34 +00002256 INTERNAL_FUNCTION(sqlite_rename_quotefix,2, renameQuotefixFunc),
dancf8f2892018-08-09 20:47:01 +00002257 };
2258 sqlite3InsertBuiltinFuncs(aAlterTableFuncs, ArraySize(aAlterTableFuncs));
2259}
drhd0e4a6c2005-02-15 20:47:57 +00002260#endif /* SQLITE_ALTER_TABLE */