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