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