xref: /sqlite-3.40.0/src/delete.c (revision 8ccdef6b)
1 /*
2 ** 2001 September 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 are called by the parser
13 ** in order to generate code for DELETE FROM statements.
14 */
15 #include "sqliteInt.h"
16 
17 /*
18 ** While a SrcList can in general represent multiple tables and subqueries
19 ** (as in the FROM clause of a SELECT statement) in this case it contains
20 ** the name of a single table, as one might find in an INSERT, DELETE,
21 ** or UPDATE statement.  Look up that table in the symbol table and
22 ** return a pointer.  Set an error message and return NULL if the table
23 ** name is not found or if any other error occurs.
24 **
25 ** The following fields are initialized appropriate in pSrc:
26 **
27 **    pSrc->a[0].pTab       Pointer to the Table object
28 **    pSrc->a[0].pIndex     Pointer to the INDEXED BY index, if there is one
29 **
30 */
31 Table *sqlite3SrcListLookup(Parse *pParse, SrcList *pSrc){
32   struct SrcList_item *pItem = pSrc->a;
33   Table *pTab;
34   assert( pItem && pSrc->nSrc==1 );
35   pTab = sqlite3LocateTableItem(pParse, 0, pItem);
36   sqlite3DeleteTable(pParse->db, pItem->pTab);
37   pItem->pTab = pTab;
38   if( pTab ){
39     pTab->nRef++;
40   }
41   if( sqlite3IndexedByLookup(pParse, pItem) ){
42     pTab = 0;
43   }
44   return pTab;
45 }
46 
47 /*
48 ** Check to make sure the given table is writable.  If it is not
49 ** writable, generate an error message and return 1.  If it is
50 ** writable return 0;
51 */
52 int sqlite3IsReadOnly(Parse *pParse, Table *pTab, int viewOk){
53   /* A table is not writable under the following circumstances:
54   **
55   **   1) It is a virtual table and no implementation of the xUpdate method
56   **      has been provided, or
57   **   2) It is a system table (i.e. sqlite_master), this call is not
58   **      part of a nested parse and writable_schema pragma has not
59   **      been specified.
60   **
61   ** In either case leave an error message in pParse and return non-zero.
62   */
63   if( ( IsVirtual(pTab)
64      && sqlite3GetVTable(pParse->db, pTab)->pMod->pModule->xUpdate==0 )
65    || ( (pTab->tabFlags & TF_Readonly)!=0
66      && (pParse->db->flags & SQLITE_WriteSchema)==0
67      && pParse->nested==0 )
68   ){
69     sqlite3ErrorMsg(pParse, "table %s may not be modified", pTab->zName);
70     return 1;
71   }
72 
73 #ifndef SQLITE_OMIT_VIEW
74   if( !viewOk && pTab->pSelect ){
75     sqlite3ErrorMsg(pParse,"cannot modify %s because it is a view",pTab->zName);
76     return 1;
77   }
78 #endif
79   return 0;
80 }
81 
82 
83 #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
84 /*
85 ** Evaluate a view and store its result in an ephemeral table.  The
86 ** pWhere argument is an optional WHERE clause that restricts the
87 ** set of rows in the view that are to be added to the ephemeral table.
88 */
89 void sqlite3MaterializeView(
90   Parse *pParse,       /* Parsing context */
91   Table *pView,        /* View definition */
92   Expr *pWhere,        /* Optional WHERE clause to be added */
93   int iCur             /* Cursor number for ephemeral table */
94 ){
95   SelectDest dest;
96   Select *pSel;
97   SrcList *pFrom;
98   sqlite3 *db = pParse->db;
99   int iDb = sqlite3SchemaToIndex(db, pView->pSchema);
100   pWhere = sqlite3ExprDup(db, pWhere, 0);
101   pFrom = sqlite3SrcListAppend(db, 0, 0, 0);
102   if( pFrom ){
103     assert( pFrom->nSrc==1 );
104     pFrom->a[0].zName = sqlite3DbStrDup(db, pView->zName);
105     pFrom->a[0].zDatabase = sqlite3DbStrDup(db, db->aDb[iDb].zName);
106     assert( pFrom->a[0].pOn==0 );
107     assert( pFrom->a[0].pUsing==0 );
108   }
109   pSel = sqlite3SelectNew(pParse, 0, pFrom, pWhere, 0, 0, 0,
110                           SF_IncludeHidden, 0, 0);
111   sqlite3SelectDestInit(&dest, SRT_EphemTab, iCur);
112   sqlite3Select(pParse, pSel, &dest);
113   sqlite3SelectDelete(db, pSel);
114 }
115 #endif /* !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER) */
116 
117 #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
118 /*
119 ** Generate an expression tree to implement the WHERE, ORDER BY,
120 ** and LIMIT/OFFSET portion of DELETE and UPDATE statements.
121 **
122 **     DELETE FROM table_wxyz WHERE a<5 ORDER BY a LIMIT 1;
123 **                            \__________________________/
124 **                               pLimitWhere (pInClause)
125 */
126 Expr *sqlite3LimitWhere(
127   Parse *pParse,               /* The parser context */
128   SrcList *pSrc,               /* the FROM clause -- which tables to scan */
129   Expr *pWhere,                /* The WHERE clause.  May be null */
130   ExprList *pOrderBy,          /* The ORDER BY clause.  May be null */
131   Expr *pLimit,                /* The LIMIT clause.  May be null */
132   Expr *pOffset,               /* The OFFSET clause.  May be null */
133   char *zStmtType              /* Either DELETE or UPDATE.  For err msgs. */
134 ){
135   Expr *pWhereRowid = NULL;    /* WHERE rowid .. */
136   Expr *pInClause = NULL;      /* WHERE rowid IN ( select ) */
137   Expr *pSelectRowid = NULL;   /* SELECT rowid ... */
138   ExprList *pEList = NULL;     /* Expression list contaning only pSelectRowid */
139   SrcList *pSelectSrc = NULL;  /* SELECT rowid FROM x ... (dup of pSrc) */
140   Select *pSelect = NULL;      /* Complete SELECT tree */
141 
142   /* Check that there isn't an ORDER BY without a LIMIT clause.
143   */
144   if( pOrderBy && (pLimit == 0) ) {
145     sqlite3ErrorMsg(pParse, "ORDER BY without LIMIT on %s", zStmtType);
146     goto limit_where_cleanup_2;
147   }
148 
149   /* We only need to generate a select expression if there
150   ** is a limit/offset term to enforce.
151   */
152   if( pLimit == 0 ) {
153     /* if pLimit is null, pOffset will always be null as well. */
154     assert( pOffset == 0 );
155     return pWhere;
156   }
157 
158   /* Generate a select expression tree to enforce the limit/offset
159   ** term for the DELETE or UPDATE statement.  For example:
160   **   DELETE FROM table_a WHERE col1=1 ORDER BY col2 LIMIT 1 OFFSET 1
161   ** becomes:
162   **   DELETE FROM table_a WHERE rowid IN (
163   **     SELECT rowid FROM table_a WHERE col1=1 ORDER BY col2 LIMIT 1 OFFSET 1
164   **   );
165   */
166 
167   pSelectRowid = sqlite3PExpr(pParse, TK_ROW, 0, 0, 0);
168   if( pSelectRowid == 0 ) goto limit_where_cleanup_2;
169   pEList = sqlite3ExprListAppend(pParse, 0, pSelectRowid);
170   if( pEList == 0 ) goto limit_where_cleanup_2;
171 
172   /* duplicate the FROM clause as it is needed by both the DELETE/UPDATE tree
173   ** and the SELECT subtree. */
174   pSelectSrc = sqlite3SrcListDup(pParse->db, pSrc, 0);
175   if( pSelectSrc == 0 ) {
176     sqlite3ExprListDelete(pParse->db, pEList);
177     goto limit_where_cleanup_2;
178   }
179 
180   /* generate the SELECT expression tree. */
181   pSelect = sqlite3SelectNew(pParse,pEList,pSelectSrc,pWhere,0,0,
182                              pOrderBy,0,pLimit,pOffset);
183   if( pSelect == 0 ) return 0;
184 
185   /* now generate the new WHERE rowid IN clause for the DELETE/UDPATE */
186   pWhereRowid = sqlite3PExpr(pParse, TK_ROW, 0, 0, 0);
187   if( pWhereRowid == 0 ) goto limit_where_cleanup_1;
188   pInClause = sqlite3PExpr(pParse, TK_IN, pWhereRowid, 0, 0);
189   if( pInClause == 0 ) goto limit_where_cleanup_1;
190 
191   pInClause->x.pSelect = pSelect;
192   pInClause->flags |= EP_xIsSelect;
193   sqlite3ExprSetHeightAndFlags(pParse, pInClause);
194   return pInClause;
195 
196   /* something went wrong. clean up anything allocated. */
197 limit_where_cleanup_1:
198   sqlite3SelectDelete(pParse->db, pSelect);
199   return 0;
200 
201 limit_where_cleanup_2:
202   sqlite3ExprDelete(pParse->db, pWhere);
203   sqlite3ExprListDelete(pParse->db, pOrderBy);
204   sqlite3ExprDelete(pParse->db, pLimit);
205   sqlite3ExprDelete(pParse->db, pOffset);
206   return 0;
207 }
208 #endif /* defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) */
209        /*      && !defined(SQLITE_OMIT_SUBQUERY) */
210 
211 /*
212 ** Generate code for a DELETE FROM statement.
213 **
214 **     DELETE FROM table_wxyz WHERE a<5 AND b NOT NULL;
215 **                 \________/       \________________/
216 **                  pTabList              pWhere
217 */
218 void sqlite3DeleteFrom(
219   Parse *pParse,         /* The parser context */
220   SrcList *pTabList,     /* The table from which we should delete things */
221   Expr *pWhere           /* The WHERE clause.  May be null */
222 ){
223   Vdbe *v;               /* The virtual database engine */
224   Table *pTab;           /* The table from which records will be deleted */
225   const char *zDb;       /* Name of database holding pTab */
226   int i;                 /* Loop counter */
227   WhereInfo *pWInfo;     /* Information about the WHERE clause */
228   Index *pIdx;           /* For looping over indices of the table */
229   int iTabCur;           /* Cursor number for the table */
230   int iDataCur = 0;      /* VDBE cursor for the canonical data source */
231   int iIdxCur = 0;       /* Cursor number of the first index */
232   int nIdx;              /* Number of indices */
233   sqlite3 *db;           /* Main database structure */
234   AuthContext sContext;  /* Authorization context */
235   NameContext sNC;       /* Name context to resolve expressions in */
236   int iDb;               /* Database number */
237   int memCnt = -1;       /* Memory cell used for change counting */
238   int rcauth;            /* Value returned by authorization callback */
239   int eOnePass;          /* ONEPASS_OFF or _SINGLE or _MULTI */
240   int aiCurOnePass[2];   /* The write cursors opened by WHERE_ONEPASS */
241   u8 *aToOpen = 0;       /* Open cursor iTabCur+j if aToOpen[j] is true */
242   Index *pPk;            /* The PRIMARY KEY index on the table */
243   int iPk = 0;           /* First of nPk registers holding PRIMARY KEY value */
244   i16 nPk = 1;           /* Number of columns in the PRIMARY KEY */
245   int iKey;              /* Memory cell holding key of row to be deleted */
246   i16 nKey;              /* Number of memory cells in the row key */
247   int iEphCur = 0;       /* Ephemeral table holding all primary key values */
248   int iRowSet = 0;       /* Register for rowset of rows to delete */
249   int addrBypass = 0;    /* Address of jump over the delete logic */
250   int addrLoop = 0;      /* Top of the delete loop */
251   int addrEphOpen = 0;   /* Instruction to open the Ephemeral table */
252 
253 #ifndef SQLITE_OMIT_TRIGGER
254   int isView;                  /* True if attempting to delete from a view */
255   Trigger *pTrigger;           /* List of table triggers, if required */
256   int bComplex;                /* True if there are either triggers or FKs */
257 #endif
258 
259   memset(&sContext, 0, sizeof(sContext));
260   db = pParse->db;
261   if( pParse->nErr || db->mallocFailed ){
262     goto delete_from_cleanup;
263   }
264   assert( pTabList->nSrc==1 );
265 
266   /* Locate the table which we want to delete.  This table has to be
267   ** put in an SrcList structure because some of the subroutines we
268   ** will be calling are designed to work with multiple tables and expect
269   ** an SrcList* parameter instead of just a Table* parameter.
270   */
271   pTab = sqlite3SrcListLookup(pParse, pTabList);
272   if( pTab==0 )  goto delete_from_cleanup;
273 
274   /* Figure out if we have any triggers and if the table being
275   ** deleted from is a view
276   */
277 #ifndef SQLITE_OMIT_TRIGGER
278   pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
279   isView = pTab->pSelect!=0;
280   bComplex = pTrigger || sqlite3FkRequired(pParse, pTab, 0, 0);
281 #else
282 # define pTrigger 0
283 # define isView 0
284 # define bComplex 0
285 #endif
286 #ifdef SQLITE_OMIT_VIEW
287 # undef isView
288 # define isView 0
289 #endif
290 
291   /* If pTab is really a view, make sure it has been initialized.
292   */
293   if( sqlite3ViewGetColumnNames(pParse, pTab) ){
294     goto delete_from_cleanup;
295   }
296 
297   if( sqlite3IsReadOnly(pParse, pTab, (pTrigger?1:0)) ){
298     goto delete_from_cleanup;
299   }
300   iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
301   assert( iDb<db->nDb );
302   zDb = db->aDb[iDb].zName;
303   rcauth = sqlite3AuthCheck(pParse, SQLITE_DELETE, pTab->zName, 0, zDb);
304   assert( rcauth==SQLITE_OK || rcauth==SQLITE_DENY || rcauth==SQLITE_IGNORE );
305   if( rcauth==SQLITE_DENY ){
306     goto delete_from_cleanup;
307   }
308   assert(!isView || pTrigger);
309 
310   /* Assign cursor numbers to the table and all its indices.
311   */
312   assert( pTabList->nSrc==1 );
313   iTabCur = pTabList->a[0].iCursor = pParse->nTab++;
314   for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){
315     pParse->nTab++;
316   }
317 
318   /* Start the view context
319   */
320   if( isView ){
321     sqlite3AuthContextPush(pParse, &sContext, pTab->zName);
322   }
323 
324   /* Begin generating code.
325   */
326   v = sqlite3GetVdbe(pParse);
327   if( v==0 ){
328     goto delete_from_cleanup;
329   }
330   if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
331   sqlite3BeginWriteOperation(pParse, 1, iDb);
332 
333   /* If we are trying to delete from a view, realize that view into
334   ** an ephemeral table.
335   */
336 #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
337   if( isView ){
338     sqlite3MaterializeView(pParse, pTab, pWhere, iTabCur);
339     iDataCur = iIdxCur = iTabCur;
340   }
341 #endif
342 
343   /* Resolve the column names in the WHERE clause.
344   */
345   memset(&sNC, 0, sizeof(sNC));
346   sNC.pParse = pParse;
347   sNC.pSrcList = pTabList;
348   if( sqlite3ResolveExprNames(&sNC, pWhere) ){
349     goto delete_from_cleanup;
350   }
351 
352   /* Initialize the counter of the number of rows deleted, if
353   ** we are counting rows.
354   */
355   if( db->flags & SQLITE_CountRows ){
356     memCnt = ++pParse->nMem;
357     sqlite3VdbeAddOp2(v, OP_Integer, 0, memCnt);
358   }
359 
360 #ifndef SQLITE_OMIT_TRUNCATE_OPTIMIZATION
361   /* Special case: A DELETE without a WHERE clause deletes everything.
362   ** It is easier just to erase the whole table. Prior to version 3.6.5,
363   ** this optimization caused the row change count (the value returned by
364   ** API function sqlite3_count_changes) to be set incorrectly.  */
365   if( rcauth==SQLITE_OK
366    && pWhere==0
367    && !bComplex
368    && !IsVirtual(pTab)
369   ){
370     assert( !isView );
371     sqlite3TableLock(pParse, iDb, pTab->tnum, 1, pTab->zName);
372     if( HasRowid(pTab) ){
373       sqlite3VdbeAddOp4(v, OP_Clear, pTab->tnum, iDb, memCnt,
374                         pTab->zName, P4_STATIC);
375     }
376     for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
377       assert( pIdx->pSchema==pTab->pSchema );
378       sqlite3VdbeAddOp2(v, OP_Clear, pIdx->tnum, iDb);
379     }
380   }else
381 #endif /* SQLITE_OMIT_TRUNCATE_OPTIMIZATION */
382   {
383     u16 wcf = WHERE_ONEPASS_DESIRED|WHERE_DUPLICATES_OK;
384     wcf |= (bComplex ? 0 : WHERE_ONEPASS_MULTIROW);
385     if( HasRowid(pTab) ){
386       /* For a rowid table, initialize the RowSet to an empty set */
387       pPk = 0;
388       nPk = 1;
389       iRowSet = ++pParse->nMem;
390       sqlite3VdbeAddOp2(v, OP_Null, 0, iRowSet);
391     }else{
392       /* For a WITHOUT ROWID table, create an ephemeral table used to
393       ** hold all primary keys for rows to be deleted. */
394       pPk = sqlite3PrimaryKeyIndex(pTab);
395       assert( pPk!=0 );
396       nPk = pPk->nKeyCol;
397       iPk = pParse->nMem+1;
398       pParse->nMem += nPk;
399       iEphCur = pParse->nTab++;
400       addrEphOpen = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iEphCur, nPk);
401       sqlite3VdbeSetP4KeyInfo(pParse, pPk);
402     }
403 
404     /* Construct a query to find the rowid or primary key for every row
405     ** to be deleted, based on the WHERE clause. Set variable eOnePass
406     ** to indicate the strategy used to implement this delete:
407     **
408     **  ONEPASS_OFF:    Two-pass approach - use a FIFO for rowids/PK values.
409     **  ONEPASS_SINGLE: One-pass approach - at most one row deleted.
410     **  ONEPASS_MULTI:  One-pass approach - any number of rows may be deleted.
411     */
412     pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, 0, 0, wcf, iTabCur+1);
413     if( pWInfo==0 ) goto delete_from_cleanup;
414     eOnePass = sqlite3WhereOkOnePass(pWInfo, aiCurOnePass);
415     assert( IsVirtual(pTab)==0 || eOnePass!=ONEPASS_MULTI );
416     assert( IsVirtual(pTab) || bComplex || eOnePass!=ONEPASS_OFF );
417 
418     /* Keep track of the number of rows to be deleted */
419     if( db->flags & SQLITE_CountRows ){
420       sqlite3VdbeAddOp2(v, OP_AddImm, memCnt, 1);
421     }
422 
423     /* Extract the rowid or primary key for the current row */
424     if( pPk ){
425       for(i=0; i<nPk; i++){
426         assert( pPk->aiColumn[i]>=0 );
427         sqlite3ExprCodeGetColumnOfTable(v, pTab, iTabCur,
428                                         pPk->aiColumn[i], iPk+i);
429       }
430       iKey = iPk;
431     }else{
432       iKey = pParse->nMem + 1;
433       iKey = sqlite3ExprCodeGetColumn(pParse, pTab, -1, iTabCur, iKey, 0);
434       if( iKey>pParse->nMem ) pParse->nMem = iKey;
435     }
436 
437     if( eOnePass!=ONEPASS_OFF ){
438       /* For ONEPASS, no need to store the rowid/primary-key. There is only
439       ** one, so just keep it in its register(s) and fall through to the
440       ** delete code.  */
441       nKey = nPk; /* OP_Found will use an unpacked key */
442       aToOpen = sqlite3DbMallocRaw(db, nIdx+2);
443       if( aToOpen==0 ){
444         sqlite3WhereEnd(pWInfo);
445         goto delete_from_cleanup;
446       }
447       memset(aToOpen, 1, nIdx+1);
448       aToOpen[nIdx+1] = 0;
449       if( aiCurOnePass[0]>=0 ) aToOpen[aiCurOnePass[0]-iTabCur] = 0;
450       if( aiCurOnePass[1]>=0 ) aToOpen[aiCurOnePass[1]-iTabCur] = 0;
451       if( addrEphOpen ) sqlite3VdbeChangeToNoop(v, addrEphOpen);
452     }else{
453       if( pPk ){
454         /* Add the PK key for this row to the temporary table */
455         iKey = ++pParse->nMem;
456         nKey = 0;   /* Zero tells OP_Found to use a composite key */
457         sqlite3VdbeAddOp4(v, OP_MakeRecord, iPk, nPk, iKey,
458             sqlite3IndexAffinityStr(pParse->db, pPk), nPk);
459         sqlite3VdbeAddOp2(v, OP_IdxInsert, iEphCur, iKey);
460       }else{
461         /* Add the rowid of the row to be deleted to the RowSet */
462         nKey = 1;  /* OP_Seek always uses a single rowid */
463         sqlite3VdbeAddOp2(v, OP_RowSetAdd, iRowSet, iKey);
464       }
465     }
466 
467     /* If this DELETE cannot use the ONEPASS strategy, this is the
468     ** end of the WHERE loop */
469     if( eOnePass!=ONEPASS_OFF ){
470       addrBypass = sqlite3VdbeMakeLabel(v);
471     }else{
472       sqlite3WhereEnd(pWInfo);
473     }
474 
475     /* Unless this is a view, open cursors for the table we are
476     ** deleting from and all its indices. If this is a view, then the
477     ** only effect this statement has is to fire the INSTEAD OF
478     ** triggers.
479     */
480     if( !isView ){
481       int iAddrOnce = 0;
482       u8 p5 = (eOnePass==ONEPASS_OFF ? 0 : OPFLAG_FORDELETE);
483       if( eOnePass==ONEPASS_MULTI ){
484         iAddrOnce = sqlite3CodeOnce(pParse); VdbeCoverage(v);
485       }
486       testcase( IsVirtual(pTab) );
487       sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, p5, iTabCur,
488                                  aToOpen, &iDataCur, &iIdxCur);
489       assert( pPk || IsVirtual(pTab) || iDataCur==iTabCur );
490       assert( pPk || IsVirtual(pTab) || iIdxCur==iDataCur+1 );
491       if( eOnePass==ONEPASS_MULTI ) sqlite3VdbeJumpHere(v, iAddrOnce);
492     }
493 
494     /* Set up a loop over the rowids/primary-keys that were found in the
495     ** where-clause loop above.
496     */
497     if( eOnePass!=ONEPASS_OFF ){
498       assert( nKey==nPk );  /* OP_Found will use an unpacked key */
499       if( !IsVirtual(pTab) && aToOpen[iDataCur-iTabCur] ){
500         assert( pPk!=0 || pTab->pSelect!=0 );
501         sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, addrBypass, iKey, nKey);
502         VdbeCoverage(v);
503       }
504     }else if( pPk ){
505       addrLoop = sqlite3VdbeAddOp1(v, OP_Rewind, iEphCur); VdbeCoverage(v);
506       sqlite3VdbeAddOp2(v, OP_RowKey, iEphCur, iKey);
507       assert( nKey==0 );  /* OP_Found will use a composite key */
508     }else{
509       addrLoop = sqlite3VdbeAddOp3(v, OP_RowSetRead, iRowSet, 0, iKey);
510       VdbeCoverage(v);
511       assert( nKey==1 );
512     }
513 
514     /* Delete the row */
515 #ifndef SQLITE_OMIT_VIRTUALTABLE
516     if( IsVirtual(pTab) ){
517       const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
518       sqlite3VtabMakeWritable(pParse, pTab);
519       sqlite3VdbeAddOp4(v, OP_VUpdate, 0, 1, iKey, pVTab, P4_VTAB);
520       sqlite3VdbeChangeP5(v, OE_Abort);
521       assert( eOnePass==ONEPASS_OFF || eOnePass==ONEPASS_SINGLE );
522       sqlite3MayAbort(pParse);
523       if( eOnePass==ONEPASS_SINGLE && sqlite3IsToplevel(pParse) ){
524         pParse->isMultiWrite = 0;
525       }
526     }else
527 #endif
528     {
529       int count = (pParse->nested==0);    /* True to count changes */
530       int iIdxNoSeek = -1;
531       if( bComplex==0 && aiCurOnePass[1]!=iDataCur ){
532         iIdxNoSeek = aiCurOnePass[1];
533       }
534       sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
535           iKey, nKey, count, OE_Default, eOnePass, iIdxNoSeek);
536     }
537 
538     /* End of the loop over all rowids/primary-keys. */
539     if( eOnePass!=ONEPASS_OFF ){
540       sqlite3VdbeResolveLabel(v, addrBypass);
541       sqlite3WhereEnd(pWInfo);
542     }else if( pPk ){
543       sqlite3VdbeAddOp2(v, OP_Next, iEphCur, addrLoop+1); VdbeCoverage(v);
544       sqlite3VdbeJumpHere(v, addrLoop);
545     }else{
546       sqlite3VdbeGoto(v, addrLoop);
547       sqlite3VdbeJumpHere(v, addrLoop);
548     }
549 
550     /* Close the cursors open on the table and its indexes. */
551     if( !isView && !IsVirtual(pTab) ){
552       if( !pPk ) sqlite3VdbeAddOp1(v, OP_Close, iDataCur);
553       for(i=0, pIdx=pTab->pIndex; pIdx; i++, pIdx=pIdx->pNext){
554         sqlite3VdbeAddOp1(v, OP_Close, iIdxCur + i);
555       }
556     }
557   } /* End non-truncate path */
558 
559   /* Update the sqlite_sequence table by storing the content of the
560   ** maximum rowid counter values recorded while inserting into
561   ** autoincrement tables.
562   */
563   if( pParse->nested==0 && pParse->pTriggerTab==0 ){
564     sqlite3AutoincrementEnd(pParse);
565   }
566 
567   /* Return the number of rows that were deleted. If this routine is
568   ** generating code because of a call to sqlite3NestedParse(), do not
569   ** invoke the callback function.
570   */
571   if( (db->flags&SQLITE_CountRows) && !pParse->nested && !pParse->pTriggerTab ){
572     sqlite3VdbeAddOp2(v, OP_ResultRow, memCnt, 1);
573     sqlite3VdbeSetNumCols(v, 1);
574     sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows deleted", SQLITE_STATIC);
575   }
576 
577 delete_from_cleanup:
578   sqlite3AuthContextPop(&sContext);
579   sqlite3SrcListDelete(db, pTabList);
580   sqlite3ExprDelete(db, pWhere);
581   sqlite3DbFree(db, aToOpen);
582   return;
583 }
584 /* Make sure "isView" and other macros defined above are undefined. Otherwise
585 ** they may interfere with compilation of other functions in this file
586 ** (or in another file, if this file becomes part of the amalgamation).  */
587 #ifdef isView
588  #undef isView
589 #endif
590 #ifdef pTrigger
591  #undef pTrigger
592 #endif
593 
594 /*
595 ** This routine generates VDBE code that causes a single row of a
596 ** single table to be deleted.  Both the original table entry and
597 ** all indices are removed.
598 **
599 ** Preconditions:
600 **
601 **   1.  iDataCur is an open cursor on the btree that is the canonical data
602 **       store for the table.  (This will be either the table itself,
603 **       in the case of a rowid table, or the PRIMARY KEY index in the case
604 **       of a WITHOUT ROWID table.)
605 **
606 **   2.  Read/write cursors for all indices of pTab must be open as
607 **       cursor number iIdxCur+i for the i-th index.
608 **
609 **   3.  The primary key for the row to be deleted must be stored in a
610 **       sequence of nPk memory cells starting at iPk.  If nPk==0 that means
611 **       that a search record formed from OP_MakeRecord is contained in the
612 **       single memory location iPk.
613 **
614 ** eMode:
615 **   Parameter eMode may be passed either ONEPASS_OFF (0), ONEPASS_SINGLE, or
616 **   ONEPASS_MULTI.  If eMode is not ONEPASS_OFF, then the cursor
617 **   iDataCur already points to the row to delete. If eMode is ONEPASS_OFF
618 **   then this function must seek iDataCur to the entry identified by iPk
619 **   and nPk before reading from it.
620 **
621 **   If eMode is ONEPASS_MULTI, then this call is being made as part
622 **   of a ONEPASS delete that affects multiple rows. In this case, if
623 **   iIdxNoSeek is a valid cursor number (>=0), then its position should
624 **   be preserved following the delete operation. Or, if iIdxNoSeek is not
625 **   a valid cursor number, the position of iDataCur should be preserved
626 **   instead.
627 **
628 ** iIdxNoSeek:
629 **   If iIdxNoSeek is a valid cursor number (>=0), then it identifies an
630 **   index cursor (from within array of cursors starting at iIdxCur) that
631 **   already points to the index entry to be deleted.
632 */
633 void sqlite3GenerateRowDelete(
634   Parse *pParse,     /* Parsing context */
635   Table *pTab,       /* Table containing the row to be deleted */
636   Trigger *pTrigger, /* List of triggers to (potentially) fire */
637   int iDataCur,      /* Cursor from which column data is extracted */
638   int iIdxCur,       /* First index cursor */
639   int iPk,           /* First memory cell containing the PRIMARY KEY */
640   i16 nPk,           /* Number of PRIMARY KEY memory cells */
641   u8 count,          /* If non-zero, increment the row change counter */
642   u8 onconf,         /* Default ON CONFLICT policy for triggers */
643   u8 eMode,          /* ONEPASS_OFF, _SINGLE, or _MULTI.  See above */
644   int iIdxNoSeek     /* Cursor number of cursor that does not need seeking */
645 ){
646   Vdbe *v = pParse->pVdbe;        /* Vdbe */
647   int iOld = 0;                   /* First register in OLD.* array */
648   int iLabel;                     /* Label resolved to end of generated code */
649   u8 opSeek;                      /* Seek opcode */
650 
651   /* Vdbe is guaranteed to have been allocated by this stage. */
652   assert( v );
653   VdbeModuleComment((v, "BEGIN: GenRowDel(%d,%d,%d,%d)",
654                          iDataCur, iIdxCur, iPk, (int)nPk));
655 
656   /* Seek cursor iCur to the row to delete. If this row no longer exists
657   ** (this can happen if a trigger program has already deleted it), do
658   ** not attempt to delete it or fire any DELETE triggers.  */
659   iLabel = sqlite3VdbeMakeLabel(v);
660   opSeek = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
661   if( eMode==ONEPASS_OFF ){
662     sqlite3VdbeAddOp4Int(v, opSeek, iDataCur, iLabel, iPk, nPk);
663     VdbeCoverageIf(v, opSeek==OP_NotExists);
664     VdbeCoverageIf(v, opSeek==OP_NotFound);
665   }
666 
667   /* If there are any triggers to fire, allocate a range of registers to
668   ** use for the old.* references in the triggers.  */
669   if( sqlite3FkRequired(pParse, pTab, 0, 0) || pTrigger ){
670     u32 mask;                     /* Mask of OLD.* columns in use */
671     int iCol;                     /* Iterator used while populating OLD.* */
672     int addrStart;                /* Start of BEFORE trigger programs */
673 
674     /* TODO: Could use temporary registers here. Also could attempt to
675     ** avoid copying the contents of the rowid register.  */
676     mask = sqlite3TriggerColmask(
677         pParse, pTrigger, 0, 0, TRIGGER_BEFORE|TRIGGER_AFTER, pTab, onconf
678     );
679     mask |= sqlite3FkOldmask(pParse, pTab);
680     iOld = pParse->nMem+1;
681     pParse->nMem += (1 + pTab->nCol);
682 
683     /* Populate the OLD.* pseudo-table register array. These values will be
684     ** used by any BEFORE and AFTER triggers that exist.  */
685     sqlite3VdbeAddOp2(v, OP_Copy, iPk, iOld);
686     for(iCol=0; iCol<pTab->nCol; iCol++){
687       testcase( mask!=0xffffffff && iCol==31 );
688       testcase( mask!=0xffffffff && iCol==32 );
689       if( mask==0xffffffff || (iCol<=31 && (mask & MASKBIT32(iCol))!=0) ){
690         sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, iCol, iOld+iCol+1);
691       }
692     }
693 
694     /* Invoke BEFORE DELETE trigger programs. */
695     addrStart = sqlite3VdbeCurrentAddr(v);
696     sqlite3CodeRowTrigger(pParse, pTrigger,
697         TK_DELETE, 0, TRIGGER_BEFORE, pTab, iOld, onconf, iLabel
698     );
699 
700     /* If any BEFORE triggers were coded, then seek the cursor to the
701     ** row to be deleted again. It may be that the BEFORE triggers moved
702     ** the cursor or of already deleted the row that the cursor was
703     ** pointing to.
704     */
705     if( addrStart<sqlite3VdbeCurrentAddr(v) ){
706       sqlite3VdbeAddOp4Int(v, opSeek, iDataCur, iLabel, iPk, nPk);
707       VdbeCoverageIf(v, opSeek==OP_NotExists);
708       VdbeCoverageIf(v, opSeek==OP_NotFound);
709     }
710 
711     /* Do FK processing. This call checks that any FK constraints that
712     ** refer to this table (i.e. constraints attached to other tables)
713     ** are not violated by deleting this row.  */
714     sqlite3FkCheck(pParse, pTab, iOld, 0, 0, 0);
715   }
716 
717   /* Delete the index and table entries. Skip this step if pTab is really
718   ** a view (in which case the only effect of the DELETE statement is to
719   ** fire the INSTEAD OF triggers).  */
720   if( pTab->pSelect==0 ){
721     sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur,0,iIdxNoSeek);
722     sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, (count?OPFLAG_NCHANGE:0));
723     if( count ){
724       sqlite3VdbeChangeP4(v, -1, pTab->zName, P4_TRANSIENT);
725     }
726     if( iIdxNoSeek>=0 ){
727       sqlite3VdbeAddOp1(v, OP_Delete, iIdxNoSeek);
728     }
729     sqlite3VdbeChangeP5(v, eMode==ONEPASS_MULTI);
730   }
731 
732   /* Do any ON CASCADE, SET NULL or SET DEFAULT operations required to
733   ** handle rows (possibly in other tables) that refer via a foreign key
734   ** to the row just deleted. */
735   sqlite3FkActions(pParse, pTab, 0, iOld, 0, 0);
736 
737   /* Invoke AFTER DELETE trigger programs. */
738   sqlite3CodeRowTrigger(pParse, pTrigger,
739       TK_DELETE, 0, TRIGGER_AFTER, pTab, iOld, onconf, iLabel
740   );
741 
742   /* Jump here if the row had already been deleted before any BEFORE
743   ** trigger programs were invoked. Or if a trigger program throws a
744   ** RAISE(IGNORE) exception.  */
745   sqlite3VdbeResolveLabel(v, iLabel);
746   VdbeModuleComment((v, "END: GenRowDel()"));
747 }
748 
749 /*
750 ** This routine generates VDBE code that causes the deletion of all
751 ** index entries associated with a single row of a single table, pTab
752 **
753 ** Preconditions:
754 **
755 **   1.  A read/write cursor "iDataCur" must be open on the canonical storage
756 **       btree for the table pTab.  (This will be either the table itself
757 **       for rowid tables or to the primary key index for WITHOUT ROWID
758 **       tables.)
759 **
760 **   2.  Read/write cursors for all indices of pTab must be open as
761 **       cursor number iIdxCur+i for the i-th index.  (The pTab->pIndex
762 **       index is the 0-th index.)
763 **
764 **   3.  The "iDataCur" cursor must be already be positioned on the row
765 **       that is to be deleted.
766 */
767 void sqlite3GenerateRowIndexDelete(
768   Parse *pParse,     /* Parsing and code generating context */
769   Table *pTab,       /* Table containing the row to be deleted */
770   int iDataCur,      /* Cursor of table holding data. */
771   int iIdxCur,       /* First index cursor */
772   int *aRegIdx,      /* Only delete if aRegIdx!=0 && aRegIdx[i]>0 */
773   int iIdxNoSeek     /* Do not delete from this cursor */
774 ){
775   int i;             /* Index loop counter */
776   int r1 = -1;       /* Register holding an index key */
777   int iPartIdxLabel; /* Jump destination for skipping partial index entries */
778   Index *pIdx;       /* Current index */
779   Index *pPrior = 0; /* Prior index */
780   Vdbe *v;           /* The prepared statement under construction */
781   Index *pPk;        /* PRIMARY KEY index, or NULL for rowid tables */
782 
783   v = pParse->pVdbe;
784   pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
785   for(i=0, pIdx=pTab->pIndex; pIdx; i++, pIdx=pIdx->pNext){
786     assert( iIdxCur+i!=iDataCur || pPk==pIdx );
787     if( aRegIdx!=0 && aRegIdx[i]==0 ) continue;
788     if( pIdx==pPk ) continue;
789     if( iIdxCur+i==iIdxNoSeek ) continue;
790     VdbeModuleComment((v, "GenRowIdxDel for %s", pIdx->zName));
791     r1 = sqlite3GenerateIndexKey(pParse, pIdx, iDataCur, 0, 1,
792         &iPartIdxLabel, pPrior, r1);
793     sqlite3VdbeAddOp3(v, OP_IdxDelete, iIdxCur+i, r1,
794         pIdx->uniqNotNull ? pIdx->nKeyCol : pIdx->nColumn);
795     sqlite3ResolvePartIdxLabel(pParse, iPartIdxLabel);
796     pPrior = pIdx;
797   }
798 }
799 
800 /*
801 ** Generate code that will assemble an index key and stores it in register
802 ** regOut.  The key with be for index pIdx which is an index on pTab.
803 ** iCur is the index of a cursor open on the pTab table and pointing to
804 ** the entry that needs indexing.  If pTab is a WITHOUT ROWID table, then
805 ** iCur must be the cursor of the PRIMARY KEY index.
806 **
807 ** Return a register number which is the first in a block of
808 ** registers that holds the elements of the index key.  The
809 ** block of registers has already been deallocated by the time
810 ** this routine returns.
811 **
812 ** If *piPartIdxLabel is not NULL, fill it in with a label and jump
813 ** to that label if pIdx is a partial index that should be skipped.
814 ** The label should be resolved using sqlite3ResolvePartIdxLabel().
815 ** A partial index should be skipped if its WHERE clause evaluates
816 ** to false or null.  If pIdx is not a partial index, *piPartIdxLabel
817 ** will be set to zero which is an empty label that is ignored by
818 ** sqlite3ResolvePartIdxLabel().
819 **
820 ** The pPrior and regPrior parameters are used to implement a cache to
821 ** avoid unnecessary register loads.  If pPrior is not NULL, then it is
822 ** a pointer to a different index for which an index key has just been
823 ** computed into register regPrior.  If the current pIdx index is generating
824 ** its key into the same sequence of registers and if pPrior and pIdx share
825 ** a column in common, then the register corresponding to that column already
826 ** holds the correct value and the loading of that register is skipped.
827 ** This optimization is helpful when doing a DELETE or an INTEGRITY_CHECK
828 ** on a table with multiple indices, and especially with the ROWID or
829 ** PRIMARY KEY columns of the index.
830 */
831 int sqlite3GenerateIndexKey(
832   Parse *pParse,       /* Parsing context */
833   Index *pIdx,         /* The index for which to generate a key */
834   int iDataCur,        /* Cursor number from which to take column data */
835   int regOut,          /* Put the new key into this register if not 0 */
836   int prefixOnly,      /* Compute only a unique prefix of the key */
837   int *piPartIdxLabel, /* OUT: Jump to this label to skip partial index */
838   Index *pPrior,       /* Previously generated index key */
839   int regPrior         /* Register holding previous generated key */
840 ){
841   Vdbe *v = pParse->pVdbe;
842   int j;
843   int regBase;
844   int nCol;
845 
846   if( piPartIdxLabel ){
847     if( pIdx->pPartIdxWhere ){
848       *piPartIdxLabel = sqlite3VdbeMakeLabel(v);
849       pParse->iSelfTab = iDataCur;
850       sqlite3ExprCachePush(pParse);
851       sqlite3ExprIfFalseDup(pParse, pIdx->pPartIdxWhere, *piPartIdxLabel,
852                             SQLITE_JUMPIFNULL);
853     }else{
854       *piPartIdxLabel = 0;
855     }
856   }
857   nCol = (prefixOnly && pIdx->uniqNotNull) ? pIdx->nKeyCol : pIdx->nColumn;
858   regBase = sqlite3GetTempRange(pParse, nCol);
859   if( pPrior && (regBase!=regPrior || pPrior->pPartIdxWhere) ) pPrior = 0;
860   for(j=0; j<nCol; j++){
861     if( pPrior
862      && pPrior->aiColumn[j]==pIdx->aiColumn[j]
863      && pPrior->aiColumn[j]!=XN_EXPR
864     ){
865       /* This column was already computed by the previous index */
866       continue;
867     }
868     sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iDataCur, j, regBase+j);
869     /* If the column affinity is REAL but the number is an integer, then it
870     ** might be stored in the table as an integer (using a compact
871     ** representation) then converted to REAL by an OP_RealAffinity opcode.
872     ** But we are getting ready to store this value back into an index, where
873     ** it should be converted by to INTEGER again.  So omit the OP_RealAffinity
874     ** opcode if it is present */
875     sqlite3VdbeDeletePriorOpcode(v, OP_RealAffinity);
876   }
877   if( regOut ){
878     sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regOut);
879   }
880   sqlite3ReleaseTempRange(pParse, regBase, nCol);
881   return regBase;
882 }
883 
884 /*
885 ** If a prior call to sqlite3GenerateIndexKey() generated a jump-over label
886 ** because it was a partial index, then this routine should be called to
887 ** resolve that label.
888 */
889 void sqlite3ResolvePartIdxLabel(Parse *pParse, int iLabel){
890   if( iLabel ){
891     sqlite3VdbeResolveLabel(pParse->pVdbe, iLabel);
892     sqlite3ExprCachePop(pParse);
893   }
894 }
895