blob: 746f6725b90bdf805c98a33511273b61dc57ec85 [file] [log] [blame]
drhcce7d172000-05-31 15:34:51 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhcce7d172000-05-31 15:34:51 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhcce7d172000-05-31 15:34:51 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** 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.
drhcce7d172000-05-31 15:34:51 +000010**
11*************************************************************************
12** This file contains C code routines that are called by the parser
drh23bf66d2004-12-14 03:34:34 +000013** in order to generate code for DELETE FROM statements.
drhcce7d172000-05-31 15:34:51 +000014*/
15#include "sqliteInt.h"
16
drha76b5df2002-02-23 02:32:10 +000017/*
drh0bfc2d12011-04-05 11:26:54 +000018** 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**
drha76b5df2002-02-23 02:32:10 +000030*/
danielk19774adee202004-05-08 08:23:19 +000031Table *sqlite3SrcListLookup(Parse *pParse, SrcList *pSrc){
danielk1977b1c685b2008-10-06 16:18:39 +000032 struct SrcList_item *pItem = pSrc->a;
33 Table *pTab;
34 assert( pItem && pSrc->nSrc==1 );
dan41fb5cd2012-10-04 19:33:00 +000035 pTab = sqlite3LocateTableItem(pParse, 0, pItem);
dan1feeaed2010-07-23 15:41:47 +000036 sqlite3DeleteTable(pParse->db, pItem->pTab);
danielk1977b1c685b2008-10-06 16:18:39 +000037 pItem->pTab = pTab;
38 if( pTab ){
drh79df7782016-12-14 14:07:35 +000039 pTab->nTabRef++;
danielk1977b1c685b2008-10-06 16:18:39 +000040 }
41 if( sqlite3IndexedByLookup(pParse, pItem) ){
42 pTab = 0;
drha76b5df2002-02-23 02:32:10 +000043 }
44 return pTab;
45}
46
47/*
drh812d7a22003-03-27 13:50:00 +000048** 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*/
danielk19774adee202004-05-08 08:23:19 +000052int sqlite3IsReadOnly(Parse *pParse, Table *pTab, int viewOk){
danielk1977595a5232009-07-24 17:58:53 +000053 /* 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 )
drh4cbdda92006-06-14 19:00:20 +000068 ){
danielk19774adee202004-05-08 08:23:19 +000069 sqlite3ErrorMsg(pParse, "table %s may not be modified", pTab->zName);
drh5cf590c2003-04-24 01:45:04 +000070 return 1;
71 }
danielk1977595a5232009-07-24 17:58:53 +000072
danielk1977b84f96f2005-01-20 11:32:23 +000073#ifndef SQLITE_OMIT_VIEW
drh5cf590c2003-04-24 01:45:04 +000074 if( !viewOk && pTab->pSelect ){
drhda71ce12004-06-21 18:14:45 +000075 sqlite3ErrorMsg(pParse,"cannot modify %s because it is a view",pTab->zName);
drh812d7a22003-03-27 13:50:00 +000076 return 1;
77 }
danielk1977b84f96f2005-01-20 11:32:23 +000078#endif
drh812d7a22003-03-27 13:50:00 +000079 return 0;
80}
81
danielk1977299b1872004-11-22 10:02:10 +000082
drh0f35a6b2008-02-12 16:52:14 +000083#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*/
89void sqlite3MaterializeView(
90 Parse *pParse, /* Parsing context */
drh2a5d8252008-08-22 12:30:52 +000091 Table *pView, /* View definition */
drh0f35a6b2008-02-12 16:52:14 +000092 Expr *pWhere, /* Optional WHERE clause to be added */
danb3c16b82017-11-09 19:53:06 +000093 ExprList *pOrderBy, /* Optional ORDER BY clause */
94 Expr *pLimit, /* Optional LIMIT clause */
peter.d.reid60ec9142014-09-06 16:39:46 +000095 int iCur /* Cursor number for ephemeral table */
drh0f35a6b2008-02-12 16:52:14 +000096){
97 SelectDest dest;
dan6d235cb2013-03-09 14:40:24 +000098 Select *pSel;
99 SrcList *pFrom;
drh0f35a6b2008-02-12 16:52:14 +0000100 sqlite3 *db = pParse->db;
dan6d235cb2013-03-09 14:40:24 +0000101 int iDb = sqlite3SchemaToIndex(db, pView->pSchema);
dan6d235cb2013-03-09 14:40:24 +0000102 pWhere = sqlite3ExprDup(db, pWhere, 0);
103 pFrom = sqlite3SrcListAppend(db, 0, 0, 0);
dan6d235cb2013-03-09 14:40:24 +0000104 if( pFrom ){
105 assert( pFrom->nSrc==1 );
106 pFrom->a[0].zName = sqlite3DbStrDup(db, pView->zName);
drh69c33822016-08-18 14:33:11 +0000107 pFrom->a[0].zDatabase = sqlite3DbStrDup(db, db->aDb[iDb].zDbSName);
dan6d235cb2013-03-09 14:40:24 +0000108 assert( pFrom->a[0].pOn==0 );
109 assert( pFrom->a[0].pUsing==0 );
drh0f35a6b2008-02-12 16:52:14 +0000110 }
danb3c16b82017-11-09 19:53:06 +0000111 pSel = sqlite3SelectNew(pParse, 0, pFrom, pWhere, 0, 0, pOrderBy,
drh8c0833f2017-11-14 23:48:23 +0000112 SF_IncludeHidden, pLimit);
drh0f35a6b2008-02-12 16:52:14 +0000113 sqlite3SelectDestInit(&dest, SRT_EphemTab, iCur);
dan6d235cb2013-03-09 14:40:24 +0000114 sqlite3Select(pParse, pSel, &dest);
115 sqlite3SelectDelete(db, pSel);
drh0f35a6b2008-02-12 16:52:14 +0000116}
117#endif /* !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER) */
118
shane273f6192008-10-10 04:34:16 +0000119#if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
shane4281bd42008-10-07 05:27:11 +0000120/*
121** Generate an expression tree to implement the WHERE, ORDER BY,
122** and LIMIT/OFFSET portion of DELETE and UPDATE statements.
123**
124** DELETE FROM table_wxyz WHERE a<5 ORDER BY a LIMIT 1;
125** \__________________________/
126** pLimitWhere (pInClause)
127*/
128Expr *sqlite3LimitWhere(
shane49ffdbf2008-10-10 18:25:45 +0000129 Parse *pParse, /* The parser context */
130 SrcList *pSrc, /* the FROM clause -- which tables to scan */
131 Expr *pWhere, /* The WHERE clause. May be null */
132 ExprList *pOrderBy, /* The ORDER BY clause. May be null */
133 Expr *pLimit, /* The LIMIT clause. May be null */
drh9eade082013-10-24 14:16:10 +0000134 char *zStmtType /* Either DELETE or UPDATE. For err msgs. */
shane4281bd42008-10-07 05:27:11 +0000135){
danb3c16b82017-11-09 19:53:06 +0000136 sqlite3 *db = pParse->db;
137 Expr *pLhs = NULL; /* LHS of IN(SELECT...) operator */
shane49ffdbf2008-10-10 18:25:45 +0000138 Expr *pInClause = NULL; /* WHERE rowid IN ( select ) */
shane49ffdbf2008-10-10 18:25:45 +0000139 ExprList *pEList = NULL; /* Expression list contaning only pSelectRowid */
140 SrcList *pSelectSrc = NULL; /* SELECT rowid FROM x ... (dup of pSrc) */
141 Select *pSelect = NULL; /* Complete SELECT tree */
danb3c16b82017-11-09 19:53:06 +0000142 Table *pTab;
shane49ffdbf2008-10-10 18:25:45 +0000143
144 /* Check that there isn't an ORDER BY without a LIMIT clause.
145 */
danb3c16b82017-11-09 19:53:06 +0000146 if( pOrderBy && pLimit==0 ) {
shane49ffdbf2008-10-10 18:25:45 +0000147 sqlite3ErrorMsg(pParse, "ORDER BY without LIMIT on %s", zStmtType);
danb3c16b82017-11-09 19:53:06 +0000148 sqlite3ExprDelete(pParse->db, pWhere);
149 sqlite3ExprListDelete(pParse->db, pOrderBy);
danb3c16b82017-11-09 19:53:06 +0000150 return 0;
shane49ffdbf2008-10-10 18:25:45 +0000151 }
shane273f6192008-10-10 04:34:16 +0000152
153 /* We only need to generate a select expression if there
154 ** is a limit/offset term to enforce.
155 */
shane49ffdbf2008-10-10 18:25:45 +0000156 if( pLimit == 0 ) {
shane49ffdbf2008-10-10 18:25:45 +0000157 return pWhere;
158 }
shane273f6192008-10-10 04:34:16 +0000159
160 /* Generate a select expression tree to enforce the limit/offset
161 ** term for the DELETE or UPDATE statement. For example:
162 ** DELETE FROM table_a WHERE col1=1 ORDER BY col2 LIMIT 1 OFFSET 1
163 ** becomes:
164 ** DELETE FROM table_a WHERE rowid IN (
shaneb235db92008-10-10 13:35:57 +0000165 ** SELECT rowid FROM table_a WHERE col1=1 ORDER BY col2 LIMIT 1 OFFSET 1
shane273f6192008-10-10 04:34:16 +0000166 ** );
167 */
shaneb235db92008-10-10 13:35:57 +0000168
danb3c16b82017-11-09 19:53:06 +0000169 pTab = pSrc->a[0].pTab;
170 if( HasRowid(pTab) ){
171 pLhs = sqlite3PExpr(pParse, TK_ROW, 0, 0);
172 pEList = sqlite3ExprListAppend(
173 pParse, 0, sqlite3PExpr(pParse, TK_ROW, 0, 0)
174 );
175 }else{
176 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
177 if( pPk->nKeyCol==1 ){
dan26caf5b2017-11-10 15:42:21 +0000178 const char *zName = pTab->aCol[pPk->aiColumn[0]].zName;
179 pLhs = sqlite3Expr(db, TK_ID, zName);
180 pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ID, zName));
danb3c16b82017-11-09 19:53:06 +0000181 }else{
182 int i;
183 for(i=0; i<pPk->nKeyCol; i++){
184 Expr *p = sqlite3Expr(db, TK_ID, pTab->aCol[pPk->aiColumn[i]].zName);
185 pEList = sqlite3ExprListAppend(pParse, pEList, p);
186 }
187 pLhs = sqlite3PExpr(pParse, TK_VECTOR, 0, 0);
188 if( pLhs ){
189 pLhs->x.pList = sqlite3ExprListDup(db, pEList, 0);
190 }
191 }
192 }
shaneb235db92008-10-10 13:35:57 +0000193
shane273f6192008-10-10 04:34:16 +0000194 /* duplicate the FROM clause as it is needed by both the DELETE/UPDATE tree
shaneb235db92008-10-10 13:35:57 +0000195 ** and the SELECT subtree. */
danb3c16b82017-11-09 19:53:06 +0000196 pSrc->a[0].pTab = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +0000197 pSelectSrc = sqlite3SrcListDup(pParse->db, pSrc, 0);
danb3c16b82017-11-09 19:53:06 +0000198 pSrc->a[0].pTab = pTab;
danca3e3c32017-11-10 16:14:26 +0000199 pSrc->a[0].pIBIndex = 0;
shaneb235db92008-10-10 13:35:57 +0000200
201 /* generate the SELECT expression tree. */
danb3c16b82017-11-09 19:53:06 +0000202 pSelect = sqlite3SelectNew(pParse, pEList, pSelectSrc, pWhere, 0 ,0,
drh8c0833f2017-11-14 23:48:23 +0000203 pOrderBy,0,pLimit
danb3c16b82017-11-09 19:53:06 +0000204 );
shaneb235db92008-10-10 13:35:57 +0000205
shane49ffdbf2008-10-10 18:25:45 +0000206 /* now generate the new WHERE rowid IN clause for the DELETE/UDPATE */
danb3c16b82017-11-09 19:53:06 +0000207 pInClause = sqlite3PExpr(pParse, TK_IN, pLhs, 0);
drh08de4f72016-04-11 01:06:47 +0000208 sqlite3PExprAddSelect(pParse, pInClause, pSelect);
shane273f6192008-10-10 04:34:16 +0000209 return pInClause;
shane4281bd42008-10-07 05:27:11 +0000210}
drh9eade082013-10-24 14:16:10 +0000211#endif /* defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) */
212 /* && !defined(SQLITE_OMIT_SUBQUERY) */
drh0f35a6b2008-02-12 16:52:14 +0000213
drhad6d9462004-09-19 02:15:24 +0000214/*
drh23bf66d2004-12-14 03:34:34 +0000215** Generate code for a DELETE FROM statement.
216**
217** DELETE FROM table_wxyz WHERE a<5 AND b NOT NULL;
218** \________/ \________________/
219** pTabList pWhere
drhcce7d172000-05-31 15:34:51 +0000220*/
dan3b61ebb2017-11-10 20:13:14 +0000221void sqlite3DeleteFrom(
drhcce7d172000-05-31 15:34:51 +0000222 Parse *pParse, /* The parser context */
drh113088e2003-03-20 01:16:58 +0000223 SrcList *pTabList, /* The table from which we should delete things */
danb3c16b82017-11-09 19:53:06 +0000224 Expr *pWhere, /* The WHERE clause. May be null */
dan3b61ebb2017-11-10 20:13:14 +0000225 ExprList *pOrderBy, /* ORDER BY clause. May be null */
drh8c0833f2017-11-14 23:48:23 +0000226 Expr *pLimit /* LIMIT clause. May be null */
drhcce7d172000-05-31 15:34:51 +0000227){
228 Vdbe *v; /* The virtual database engine */
229 Table *pTab; /* The table from which records will be deleted */
drhcce7d172000-05-31 15:34:51 +0000230 int i; /* Loop counter */
231 WhereInfo *pWInfo; /* Information about the WHERE clause */
232 Index *pIdx; /* For looping over indices of the table */
drh26198bb2013-10-31 11:15:09 +0000233 int iTabCur; /* Cursor number for the table */
mistachkin1a51ce72015-01-12 18:38:02 +0000234 int iDataCur = 0; /* VDBE cursor for the canonical data source */
235 int iIdxCur = 0; /* Cursor number of the first index */
drh6a534992013-11-16 20:13:39 +0000236 int nIdx; /* Number of indices */
drh9bb575f2004-09-06 17:24:11 +0000237 sqlite3 *db; /* Main database structure */
drh85e20962003-04-25 17:52:11 +0000238 AuthContext sContext; /* Authorization context */
danielk1977b3bce662005-01-29 08:32:43 +0000239 NameContext sNC; /* Name context to resolve expressions in */
drh53a67772007-02-07 01:06:52 +0000240 int iDb; /* Database number */
drh79636912018-04-19 23:52:39 +0000241 int memCnt = 0; /* Memory cell used for change counting */
danielk197752bd7912008-10-27 15:34:32 +0000242 int rcauth; /* Value returned by authorization callback */
drhb0264ee2015-09-14 14:45:50 +0000243 int eOnePass; /* ONEPASS_OFF or _SINGLE or _MULTI */
drh6a534992013-11-16 20:13:39 +0000244 int aiCurOnePass[2]; /* The write cursors opened by WHERE_ONEPASS */
245 u8 *aToOpen = 0; /* Open cursor iTabCur+j if aToOpen[j] is true */
drh96129472013-11-16 22:48:52 +0000246 Index *pPk; /* The PRIMARY KEY index on the table */
mistachkin20b85952013-11-22 21:32:44 +0000247 int iPk = 0; /* First of nPk registers holding PRIMARY KEY value */
drhe73e0672013-11-18 03:11:54 +0000248 i16 nPk = 1; /* Number of columns in the PRIMARY KEY */
249 int iKey; /* Memory cell holding key of row to be deleted */
250 i16 nKey; /* Number of memory cells in the row key */
drh96129472013-11-16 22:48:52 +0000251 int iEphCur = 0; /* Ephemeral table holding all primary key values */
252 int iRowSet = 0; /* Register for rowset of rows to delete */
253 int addrBypass = 0; /* Address of jump over the delete logic */
254 int addrLoop = 0; /* Top of the delete loop */
peter.d.reid60ec9142014-09-06 16:39:46 +0000255 int addrEphOpen = 0; /* Instruction to open the Ephemeral table */
mistachkin9fe3fbb2016-05-04 19:04:20 +0000256 int bComplex; /* True if there are triggers or FKs or
drh57a07ba2016-05-02 12:18:56 +0000257 ** subqueries in the WHERE clause */
drh96129472013-11-16 22:48:52 +0000258
drh798da522004-11-04 04:42:28 +0000259#ifndef SQLITE_OMIT_TRIGGER
260 int isView; /* True if attempting to delete from a view */
danielk19772f886d12009-02-28 10:47:41 +0000261 Trigger *pTrigger; /* List of table triggers, if required */
drh798da522004-11-04 04:42:28 +0000262#endif
drhcce7d172000-05-31 15:34:51 +0000263
drheeb844a2009-08-08 18:01:07 +0000264 memset(&sContext, 0, sizeof(sContext));
drh17435752007-08-16 04:30:38 +0000265 db = pParse->db;
266 if( pParse->nErr || db->mallocFailed ){
drhdaffd0e2001-04-11 14:28:42 +0000267 goto delete_from_cleanup;
268 }
drh113088e2003-03-20 01:16:58 +0000269 assert( pTabList->nSrc==1 );
drhdaffd0e2001-04-11 14:28:42 +0000270
danb3c16b82017-11-09 19:53:06 +0000271
drh1ccde152000-06-17 13:12:39 +0000272 /* Locate the table which we want to delete. This table has to be
drhad3cab52002-05-24 02:04:32 +0000273 ** put in an SrcList structure because some of the subroutines we
drhcce7d172000-05-31 15:34:51 +0000274 ** will be calling are designed to work with multiple tables and expect
drhad3cab52002-05-24 02:04:32 +0000275 ** an SrcList* parameter instead of just a Table* parameter.
drhcce7d172000-05-31 15:34:51 +0000276 */
danielk19774adee202004-05-08 08:23:19 +0000277 pTab = sqlite3SrcListLookup(pParse, pTabList);
drha69d9162003-04-17 22:57:53 +0000278 if( pTab==0 ) goto delete_from_cleanup;
drhb7f91642004-10-31 02:22:47 +0000279
280 /* Figure out if we have any triggers and if the table being
281 ** deleted from is a view
282 */
283#ifndef SQLITE_OMIT_TRIGGER
danielk19772f886d12009-02-28 10:47:41 +0000284 pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
drh5cf590c2003-04-24 01:45:04 +0000285 isView = pTab->pSelect!=0;
drhb7f91642004-10-31 02:22:47 +0000286#else
danielk19772f886d12009-02-28 10:47:41 +0000287# define pTrigger 0
drhb7f91642004-10-31 02:22:47 +0000288# define isView 0
289#endif
drhee159622017-12-08 14:07:14 +0000290 bComplex = pTrigger || sqlite3FkRequired(pParse, pTab, 0, 0);
drhb7f91642004-10-31 02:22:47 +0000291#ifdef SQLITE_OMIT_VIEW
292# undef isView
293# define isView 0
294#endif
295
danb3c16b82017-11-09 19:53:06 +0000296#ifdef SQLITE_ENABLE_UPDATE_DELETE_LIMIT
297 if( !isView ){
298 pWhere = sqlite3LimitWhere(
drh8c0833f2017-11-14 23:48:23 +0000299 pParse, pTabList, pWhere, pOrderBy, pLimit, "DELETE"
danb3c16b82017-11-09 19:53:06 +0000300 );
301 pOrderBy = 0;
drh8c0833f2017-11-14 23:48:23 +0000302 pLimit = 0;
danb3c16b82017-11-09 19:53:06 +0000303 }
304#endif
305
danielk1977595a5232009-07-24 17:58:53 +0000306 /* If pTab is really a view, make sure it has been initialized.
307 */
308 if( sqlite3ViewGetColumnNames(pParse, pTab) ){
309 goto delete_from_cleanup;
310 }
311
danielk19772f886d12009-02-28 10:47:41 +0000312 if( sqlite3IsReadOnly(pParse, pTab, (pTrigger?1:0)) ){
drh5cf590c2003-04-24 01:45:04 +0000313 goto delete_from_cleanup;
drh113088e2003-03-20 01:16:58 +0000314 }
danielk1977da184232006-01-05 11:34:32 +0000315 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
316 assert( iDb<db->nDb );
drha0daa752016-09-16 11:53:10 +0000317 rcauth = sqlite3AuthCheck(pParse, SQLITE_DELETE, pTab->zName, 0,
318 db->aDb[iDb].zDbSName);
danielk197752bd7912008-10-27 15:34:32 +0000319 assert( rcauth==SQLITE_OK || rcauth==SQLITE_DENY || rcauth==SQLITE_IGNORE );
320 if( rcauth==SQLITE_DENY ){
drhe5f9c642003-01-13 23:27:31 +0000321 goto delete_from_cleanup;
322 }
danielk19772f886d12009-02-28 10:47:41 +0000323 assert(!isView || pTrigger);
drhcce7d172000-05-31 15:34:51 +0000324
drh6a534992013-11-16 20:13:39 +0000325 /* Assign cursor numbers to the table and all its indices.
drhcce7d172000-05-31 15:34:51 +0000326 */
drh6a3ea0e2003-05-02 14:32:12 +0000327 assert( pTabList->nSrc==1 );
drh26198bb2013-10-31 11:15:09 +0000328 iTabCur = pTabList->a[0].iCursor = pParse->nTab++;
drh6a534992013-11-16 20:13:39 +0000329 for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){
danielk1977e448dc42008-01-02 11:50:51 +0000330 pParse->nTab++;
331 }
drhcce7d172000-05-31 15:34:51 +0000332
drh85e20962003-04-25 17:52:11 +0000333 /* Start the view context
334 */
335 if( isView ){
danielk19774adee202004-05-08 08:23:19 +0000336 sqlite3AuthContextPush(pParse, &sContext, pTab->zName);
drh85e20962003-04-25 17:52:11 +0000337 }
338
drhcce7d172000-05-31 15:34:51 +0000339 /* Begin generating code.
340 */
danielk19774adee202004-05-08 08:23:19 +0000341 v = sqlite3GetVdbe(pParse);
danielk1977f29ce552002-05-19 23:43:12 +0000342 if( v==0 ){
343 goto delete_from_cleanup;
344 }
drh4794f732004-11-05 17:17:50 +0000345 if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
drh7c483602018-04-20 19:46:52 +0000346 sqlite3BeginWriteOperation(pParse, bComplex, iDb);
drh5e00f6c2001-09-13 13:46:56 +0000347
drh9d2985c2005-09-08 01:58:42 +0000348 /* If we are trying to delete from a view, realize that view into
peter.d.reid60ec9142014-09-06 16:39:46 +0000349 ** an ephemeral table.
drh5cf590c2003-04-24 01:45:04 +0000350 */
shanefa4e62f2008-09-01 21:59:42 +0000351#if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
drh5cf590c2003-04-24 01:45:04 +0000352 if( isView ){
danb3c16b82017-11-09 19:53:06 +0000353 sqlite3MaterializeView(pParse, pTab,
drh8c0833f2017-11-14 23:48:23 +0000354 pWhere, pOrderBy, pLimit, iTabCur
danb3c16b82017-11-09 19:53:06 +0000355 );
drhf8ffb272013-11-01 17:08:56 +0000356 iDataCur = iIdxCur = iTabCur;
danb3c16b82017-11-09 19:53:06 +0000357 pOrderBy = 0;
drh8c0833f2017-11-14 23:48:23 +0000358 pLimit = 0;
drh0f35a6b2008-02-12 16:52:14 +0000359 }
shanefa4e62f2008-09-01 21:59:42 +0000360#endif
drh1013c932008-01-06 00:25:21 +0000361
drh0f35a6b2008-02-12 16:52:14 +0000362 /* Resolve the column names in the WHERE clause.
363 */
364 memset(&sNC, 0, sizeof(sNC));
365 sNC.pParse = pParse;
366 sNC.pSrcList = pTabList;
drh7d10d5a2008-08-20 16:35:10 +0000367 if( sqlite3ResolveExprNames(&sNC, pWhere) ){
drh0f35a6b2008-02-12 16:52:14 +0000368 goto delete_from_cleanup;
drh5cf590c2003-04-24 01:45:04 +0000369 }
370
drh1bee3d72001-10-15 00:44:35 +0000371 /* Initialize the counter of the number of rows deleted, if
372 ** we are counting rows.
373 */
drh79636912018-04-19 23:52:39 +0000374 if( (db->flags & SQLITE_CountRows)!=0
375 && !pParse->nested
376 && !pParse->pTriggerTab
377 ){
drh0a07c102008-01-03 18:03:08 +0000378 memCnt = ++pParse->nMem;
drh4c583122008-01-04 22:01:03 +0000379 sqlite3VdbeAddOp2(v, OP_Integer, 0, memCnt);
drh1bee3d72001-10-15 00:44:35 +0000380 }
drhcce7d172000-05-31 15:34:51 +0000381
drhf8cecda2008-10-10 23:48:25 +0000382#ifndef SQLITE_OMIT_TRUNCATE_OPTIMIZATION
drh0353ced2001-03-20 22:05:00 +0000383 /* Special case: A DELETE without a WHERE clause deletes everything.
dan2283d462009-09-08 15:55:15 +0000384 ** It is easier just to erase the whole table. Prior to version 3.6.5,
385 ** this optimization caused the row change count (the value returned by
drh94189212017-05-11 13:43:57 +0000386 ** API function sqlite3_count_changes) to be set incorrectly.
387 **
388 ** The "rcauth==SQLITE_OK" terms is the
drh1e1c4222017-05-18 18:17:55 +0000389 ** IMPLEMENTATION-OF: R-17228-37124 If the action code is SQLITE_DELETE and
drh94189212017-05-11 13:43:57 +0000390 ** the callback returns SQLITE_IGNORE then the DELETE operation proceeds but
391 ** the truncate optimization is disabled and all rows are deleted
392 ** individually.
393 */
drh67c495a2011-03-30 17:25:35 +0000394 if( rcauth==SQLITE_OK
395 && pWhere==0
drhb77ebd82015-09-15 13:42:16 +0000396 && !bComplex
397 && !IsVirtual(pTab)
drh9b1c62d2011-03-30 21:04:43 +0000398#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
drh67c495a2011-03-30 17:25:35 +0000399 && db->xPreUpdateCallback==0
drh9b1c62d2011-03-30 21:04:43 +0000400#endif
dan1da40a32009-09-19 17:00:31 +0000401 ){
danielk19779a02fb42008-10-27 08:24:38 +0000402 assert( !isView );
dan5d1dcff2013-09-26 15:21:16 +0000403 sqlite3TableLock(pParse, iDb, pTab->tnum, 1, pTab->zName);
drh261c02d2013-10-25 14:46:15 +0000404 if( HasRowid(pTab) ){
drh79636912018-04-19 23:52:39 +0000405 sqlite3VdbeAddOp4(v, OP_Clear, pTab->tnum, iDb, memCnt ? memCnt : -1,
drh261c02d2013-10-25 14:46:15 +0000406 pTab->zName, P4_STATIC);
407 }
danielk19779a02fb42008-10-27 08:24:38 +0000408 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
409 assert( pIdx->pSchema==pTab->pSchema );
410 sqlite3VdbeAddOp2(v, OP_Clear, pIdx->tnum, iDb);
drhcce7d172000-05-31 15:34:51 +0000411 }
drhf8cecda2008-10-10 23:48:25 +0000412 }else
413#endif /* SQLITE_OMIT_TRUNCATE_OPTIMIZATION */
drh96129472013-11-16 22:48:52 +0000414 {
drhbcf68842016-05-06 16:06:59 +0000415 u16 wcf = WHERE_ONEPASS_DESIRED|WHERE_DUPLICATES_OK|WHERE_SEEK_TABLE;
drh91da7072016-05-04 14:45:30 +0000416 if( sNC.ncFlags & NC_VarSelect ) bComplex = 1;
danf0ee1d32015-09-12 19:26:11 +0000417 wcf |= (bComplex ? 0 : WHERE_ONEPASS_MULTIROW);
drh96129472013-11-16 22:48:52 +0000418 if( HasRowid(pTab) ){
419 /* For a rowid table, initialize the RowSet to an empty set */
420 pPk = 0;
421 nPk = 1;
422 iRowSet = ++pParse->nMem;
423 sqlite3VdbeAddOp2(v, OP_Null, 0, iRowSet);
424 }else{
peter.d.reid60ec9142014-09-06 16:39:46 +0000425 /* For a WITHOUT ROWID table, create an ephemeral table used to
drh96129472013-11-16 22:48:52 +0000426 ** hold all primary keys for rows to be deleted. */
427 pPk = sqlite3PrimaryKeyIndex(pTab);
428 assert( pPk!=0 );
429 nPk = pPk->nKeyCol;
430 iPk = pParse->nMem+1;
431 pParse->nMem += nPk;
432 iEphCur = pParse->nTab++;
433 addrEphOpen = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iEphCur, nPk);
434 sqlite3VdbeSetP4KeyInfo(pParse, pPk);
drh261c02d2013-10-25 14:46:15 +0000435 }
drh96129472013-11-16 22:48:52 +0000436
437 /* Construct a query to find the rowid or primary key for every row
danf0ee1d32015-09-12 19:26:11 +0000438 ** to be deleted, based on the WHERE clause. Set variable eOnePass
439 ** to indicate the strategy used to implement this delete:
440 **
drhb0264ee2015-09-14 14:45:50 +0000441 ** ONEPASS_OFF: Two-pass approach - use a FIFO for rowids/PK values.
442 ** ONEPASS_SINGLE: One-pass approach - at most one row deleted.
443 ** ONEPASS_MULTI: One-pass approach - any number of rows may be deleted.
drh261c02d2013-10-25 14:46:15 +0000444 */
danf0ee1d32015-09-12 19:26:11 +0000445 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, 0, 0, wcf, iTabCur+1);
drh261c02d2013-10-25 14:46:15 +0000446 if( pWInfo==0 ) goto delete_from_cleanup;
danf0ee1d32015-09-12 19:26:11 +0000447 eOnePass = sqlite3WhereOkOnePass(pWInfo, aiCurOnePass);
dan076e0f92015-09-28 15:20:58 +0000448 assert( IsVirtual(pTab)==0 || eOnePass!=ONEPASS_MULTI );
dan80b71982015-09-19 18:11:18 +0000449 assert( IsVirtual(pTab) || bComplex || eOnePass!=ONEPASS_OFF );
drh7c483602018-04-20 19:46:52 +0000450 if( eOnePass!=ONEPASS_SINGLE ) sqlite3MultiWrite(pParse);
drh96129472013-11-16 22:48:52 +0000451
452 /* Keep track of the number of rows to be deleted */
drh79636912018-04-19 23:52:39 +0000453 if( memCnt ){
drh6546af12013-11-04 15:23:25 +0000454 sqlite3VdbeAddOp2(v, OP_AddImm, memCnt, 1);
455 }
drh96129472013-11-16 22:48:52 +0000456
457 /* Extract the rowid or primary key for the current row */
458 if( pPk ){
459 for(i=0; i<nPk; i++){
drh4b92f982015-09-29 17:20:14 +0000460 assert( pPk->aiColumn[i]>=0 );
drh96129472013-11-16 22:48:52 +0000461 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTabCur,
462 pPk->aiColumn[i], iPk+i);
463 }
464 iKey = iPk;
drh96129472013-11-16 22:48:52 +0000465 }else{
drh8c607192018-08-04 15:53:55 +0000466 iKey = ++pParse->nMem;
467 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTabCur, -1, iKey);
drh261c02d2013-10-25 14:46:15 +0000468 }
drh96129472013-11-16 22:48:52 +0000469
drhb0264ee2015-09-14 14:45:50 +0000470 if( eOnePass!=ONEPASS_OFF ){
danf0ee1d32015-09-12 19:26:11 +0000471 /* For ONEPASS, no need to store the rowid/primary-key. There is only
drh96129472013-11-16 22:48:52 +0000472 ** one, so just keep it in its register(s) and fall through to the
danf0ee1d32015-09-12 19:26:11 +0000473 ** delete code. */
drh96129472013-11-16 22:48:52 +0000474 nKey = nPk; /* OP_Found will use an unpacked key */
drh575fad62016-02-05 13:38:36 +0000475 aToOpen = sqlite3DbMallocRawNN(db, nIdx+2);
drh52a82e62013-11-16 23:03:06 +0000476 if( aToOpen==0 ){
477 sqlite3WhereEnd(pWInfo);
478 goto delete_from_cleanup;
479 }
drh156c7912013-11-16 20:45:01 +0000480 memset(aToOpen, 1, nIdx+1);
481 aToOpen[nIdx+1] = 0;
482 if( aiCurOnePass[0]>=0 ) aToOpen[aiCurOnePass[0]-iTabCur] = 0;
483 if( aiCurOnePass[1]>=0 ) aToOpen[aiCurOnePass[1]-iTabCur] = 0;
drh96129472013-11-16 22:48:52 +0000484 if( addrEphOpen ) sqlite3VdbeChangeToNoop(v, addrEphOpen);
drh6a534992013-11-16 20:13:39 +0000485 }else{
danf0ee1d32015-09-12 19:26:11 +0000486 if( pPk ){
487 /* Add the PK key for this row to the temporary table */
488 iKey = ++pParse->nMem;
489 nKey = 0; /* Zero tells OP_Found to use a composite key */
490 sqlite3VdbeAddOp4(v, OP_MakeRecord, iPk, nPk, iKey,
491 sqlite3IndexAffinityStr(pParse->db, pPk), nPk);
drh9b4eaeb2016-11-09 00:10:33 +0000492 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iEphCur, iKey, iPk, nPk);
danf0ee1d32015-09-12 19:26:11 +0000493 }else{
494 /* Add the rowid of the row to be deleted to the RowSet */
drh170ad682017-06-02 15:44:22 +0000495 nKey = 1; /* OP_DeferredSeek always uses a single rowid */
danf0ee1d32015-09-12 19:26:11 +0000496 sqlite3VdbeAddOp2(v, OP_RowSetAdd, iRowSet, iKey);
497 }
danielk1977299b1872004-11-22 10:02:10 +0000498 }
drh96129472013-11-16 22:48:52 +0000499
danf0ee1d32015-09-12 19:26:11 +0000500 /* If this DELETE cannot use the ONEPASS strategy, this is the
501 ** end of the WHERE loop */
drhb0264ee2015-09-14 14:45:50 +0000502 if( eOnePass!=ONEPASS_OFF ){
drh83d47af2013-11-17 02:42:02 +0000503 addrBypass = sqlite3VdbeMakeLabel(v);
danf0ee1d32015-09-12 19:26:11 +0000504 }else{
505 sqlite3WhereEnd(pWInfo);
drh6a534992013-11-16 20:13:39 +0000506 }
drh96129472013-11-16 22:48:52 +0000507
dan165921a2009-08-28 18:53:45 +0000508 /* Unless this is a view, open cursors for the table we are
509 ** deleting from and all its indices. If this is a view, then the
510 ** only effect this statement has is to fire the INSTEAD OF
drh96129472013-11-16 22:48:52 +0000511 ** triggers.
512 */
danielk1977e448dc42008-01-02 11:50:51 +0000513 if( !isView ){
dan7210b3d2015-09-12 19:50:58 +0000514 int iAddrOnce = 0;
drhb0264ee2015-09-14 14:45:50 +0000515 if( eOnePass==ONEPASS_MULTI ){
drh511f9e82016-09-22 18:53:13 +0000516 iAddrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drh66336f32015-09-14 14:08:25 +0000517 }
drhb6b4b792014-08-21 14:10:23 +0000518 testcase( IsVirtual(pTab) );
drhb89aeb62016-01-27 15:49:32 +0000519 sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, OPFLAG_FORDELETE,
520 iTabCur, aToOpen, &iDataCur, &iIdxCur);
drhb6b4b792014-08-21 14:10:23 +0000521 assert( pPk || IsVirtual(pTab) || iDataCur==iTabCur );
522 assert( pPk || IsVirtual(pTab) || iIdxCur==iDataCur+1 );
drhb0264ee2015-09-14 14:45:50 +0000523 if( eOnePass==ONEPASS_MULTI ) sqlite3VdbeJumpHere(v, iAddrOnce);
danielk1977e448dc42008-01-02 11:50:51 +0000524 }
drh96129472013-11-16 22:48:52 +0000525
526 /* Set up a loop over the rowids/primary-keys that were found in the
527 ** where-clause loop above.
528 */
drhb0264ee2015-09-14 14:45:50 +0000529 if( eOnePass!=ONEPASS_OFF ){
drhb6b4b792014-08-21 14:10:23 +0000530 assert( nKey==nPk ); /* OP_Found will use an unpacked key */
dan076e0f92015-09-28 15:20:58 +0000531 if( !IsVirtual(pTab) && aToOpen[iDataCur-iTabCur] ){
drh635e57f2014-10-28 16:19:18 +0000532 assert( pPk!=0 || pTab->pSelect!=0 );
drh83d47af2013-11-17 02:42:02 +0000533 sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, addrBypass, iKey, nKey);
drh688852a2014-02-17 22:40:43 +0000534 VdbeCoverage(v);
drh83d47af2013-11-17 02:42:02 +0000535 }
drh96129472013-11-16 22:48:52 +0000536 }else if( pPk ){
drh688852a2014-02-17 22:40:43 +0000537 addrLoop = sqlite3VdbeAddOp1(v, OP_Rewind, iEphCur); VdbeCoverage(v);
drhe3740f22017-08-10 15:19:39 +0000538 if( IsVirtual(pTab) ){
539 sqlite3VdbeAddOp3(v, OP_Column, iEphCur, 0, iKey);
540 }else{
541 sqlite3VdbeAddOp2(v, OP_RowData, iEphCur, iKey);
542 }
drh96129472013-11-16 22:48:52 +0000543 assert( nKey==0 ); /* OP_Found will use a composite key */
544 }else{
545 addrLoop = sqlite3VdbeAddOp3(v, OP_RowSetRead, iRowSet, 0, iKey);
drh688852a2014-02-17 22:40:43 +0000546 VdbeCoverage(v);
drh96129472013-11-16 22:48:52 +0000547 assert( nKey==1 );
548 }
549
dan2283d462009-09-08 15:55:15 +0000550 /* Delete the row */
drh4cbdda92006-06-14 19:00:20 +0000551#ifndef SQLITE_OMIT_VIRTUALTABLE
dan2283d462009-09-08 15:55:15 +0000552 if( IsVirtual(pTab) ){
553 const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
554 sqlite3VtabMakeWritable(pParse, pTab);
dan076e0f92015-09-28 15:20:58 +0000555 assert( eOnePass==ONEPASS_OFF || eOnePass==ONEPASS_SINGLE );
dane0af83a2009-09-08 19:15:01 +0000556 sqlite3MayAbort(pParse);
drh338e3112018-05-24 23:51:57 +0000557 if( eOnePass==ONEPASS_SINGLE ){
558 sqlite3VdbeAddOp1(v, OP_Close, iTabCur);
559 if( sqlite3IsToplevel(pParse) ){
560 pParse->isMultiWrite = 0;
561 }
dan076e0f92015-09-28 15:20:58 +0000562 }
drh338e3112018-05-24 23:51:57 +0000563 sqlite3VdbeAddOp4(v, OP_VUpdate, 0, 1, iKey, pVTab, P4_VTAB);
564 sqlite3VdbeChangeP5(v, OE_Abort);
dan2283d462009-09-08 15:55:15 +0000565 }else
drh4cbdda92006-06-14 19:00:20 +0000566#endif
dan2283d462009-09-08 15:55:15 +0000567 {
568 int count = (pParse->nested==0); /* True to count changes */
drh26198bb2013-10-31 11:15:09 +0000569 sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
drh68116932017-01-07 14:47:03 +0000570 iKey, nKey, count, OE_Default, eOnePass, aiCurOnePass[1]);
danielk1977299b1872004-11-22 10:02:10 +0000571 }
drh96129472013-11-16 22:48:52 +0000572
573 /* End of the loop over all rowids/primary-keys. */
drhb0264ee2015-09-14 14:45:50 +0000574 if( eOnePass!=ONEPASS_OFF ){
drh83d47af2013-11-17 02:42:02 +0000575 sqlite3VdbeResolveLabel(v, addrBypass);
danf0ee1d32015-09-12 19:26:11 +0000576 sqlite3WhereEnd(pWInfo);
drh96129472013-11-16 22:48:52 +0000577 }else if( pPk ){
drh688852a2014-02-17 22:40:43 +0000578 sqlite3VdbeAddOp2(v, OP_Next, iEphCur, addrLoop+1); VdbeCoverage(v);
drh96129472013-11-16 22:48:52 +0000579 sqlite3VdbeJumpHere(v, addrLoop);
580 }else{
drh076e85f2015-09-03 13:46:12 +0000581 sqlite3VdbeGoto(v, addrLoop);
drh96129472013-11-16 22:48:52 +0000582 sqlite3VdbeJumpHere(v, addrLoop);
583 }
drh96129472013-11-16 22:48:52 +0000584 } /* End non-truncate path */
drh5e00f6c2001-09-13 13:46:56 +0000585
drh0b9f50d2009-06-23 20:28:53 +0000586 /* Update the sqlite_sequence table by storing the content of the
587 ** maximum rowid counter values recorded while inserting into
588 ** autoincrement tables.
589 */
dan165921a2009-08-28 18:53:45 +0000590 if( pParse->nested==0 && pParse->pTriggerTab==0 ){
drh0b9f50d2009-06-23 20:28:53 +0000591 sqlite3AutoincrementEnd(pParse);
592 }
593
dan2283d462009-09-08 15:55:15 +0000594 /* Return the number of rows that were deleted. If this routine is
danielk1977e7de6f22004-11-05 06:02:06 +0000595 ** generating code because of a call to sqlite3NestedParse(), do not
596 ** invoke the callback function.
drh1bee3d72001-10-15 00:44:35 +0000597 */
drh79636912018-04-19 23:52:39 +0000598 if( memCnt ){
drh66a51672008-01-03 00:01:23 +0000599 sqlite3VdbeAddOp2(v, OP_ResultRow, memCnt, 1);
danielk197722322fd2004-05-25 23:35:17 +0000600 sqlite3VdbeSetNumCols(v, 1);
danielk197710fb7492008-10-31 10:53:22 +0000601 sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows deleted", SQLITE_STATIC);
drh1bee3d72001-10-15 00:44:35 +0000602 }
drhcce7d172000-05-31 15:34:51 +0000603
604delete_from_cleanup:
danielk19774adee202004-05-08 08:23:19 +0000605 sqlite3AuthContextPop(&sContext);
drh633e6d52008-07-28 19:34:53 +0000606 sqlite3SrcListDelete(db, pTabList);
607 sqlite3ExprDelete(db, pWhere);
dan3b61ebb2017-11-10 20:13:14 +0000608#if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT)
danb3c16b82017-11-09 19:53:06 +0000609 sqlite3ExprListDelete(db, pOrderBy);
610 sqlite3ExprDelete(db, pLimit);
dan3b61ebb2017-11-10 20:13:14 +0000611#endif
drh6a534992013-11-16 20:13:39 +0000612 sqlite3DbFree(db, aToOpen);
drhcce7d172000-05-31 15:34:51 +0000613 return;
614}
dan75cbd982009-09-21 16:06:03 +0000615/* Make sure "isView" and other macros defined above are undefined. Otherwise
peter.d.reid60ec9142014-09-06 16:39:46 +0000616** they may interfere with compilation of other functions in this file
dan75cbd982009-09-21 16:06:03 +0000617** (or in another file, if this file becomes part of the amalgamation). */
618#ifdef isView
619 #undef isView
620#endif
621#ifdef pTrigger
622 #undef pTrigger
623#endif
drh9cfcf5d2002-01-29 18:41:24 +0000624
625/*
626** This routine generates VDBE code that causes a single row of a
drh6934fc72013-10-31 15:37:49 +0000627** single table to be deleted. Both the original table entry and
628** all indices are removed.
drh9cfcf5d2002-01-29 18:41:24 +0000629**
drh6934fc72013-10-31 15:37:49 +0000630** Preconditions:
drh9cfcf5d2002-01-29 18:41:24 +0000631**
drh6934fc72013-10-31 15:37:49 +0000632** 1. iDataCur is an open cursor on the btree that is the canonical data
633** store for the table. (This will be either the table itself,
drh26198bb2013-10-31 11:15:09 +0000634** in the case of a rowid table, or the PRIMARY KEY index in the case
drh6934fc72013-10-31 15:37:49 +0000635** of a WITHOUT ROWID table.)
drh9cfcf5d2002-01-29 18:41:24 +0000636**
637** 2. Read/write cursors for all indices of pTab must be open as
drh26198bb2013-10-31 11:15:09 +0000638** cursor number iIdxCur+i for the i-th index.
drh9cfcf5d2002-01-29 18:41:24 +0000639**
drhecb31b62013-10-24 19:48:39 +0000640** 3. The primary key for the row to be deleted must be stored in a
drh313619f2013-10-31 20:34:06 +0000641** sequence of nPk memory cells starting at iPk. If nPk==0 that means
642** that a search record formed from OP_MakeRecord is contained in the
643** single memory location iPk.
danf0ee1d32015-09-12 19:26:11 +0000644**
645** eMode:
drhb0264ee2015-09-14 14:45:50 +0000646** Parameter eMode may be passed either ONEPASS_OFF (0), ONEPASS_SINGLE, or
647** ONEPASS_MULTI. If eMode is not ONEPASS_OFF, then the cursor
648** iDataCur already points to the row to delete. If eMode is ONEPASS_OFF
649** then this function must seek iDataCur to the entry identified by iPk
650** and nPk before reading from it.
danf0ee1d32015-09-12 19:26:11 +0000651**
drhb0264ee2015-09-14 14:45:50 +0000652** If eMode is ONEPASS_MULTI, then this call is being made as part
danf0ee1d32015-09-12 19:26:11 +0000653** of a ONEPASS delete that affects multiple rows. In this case, if
drh4cef5b12017-01-07 14:26:28 +0000654** iIdxNoSeek is a valid cursor number (>=0) and is not the same as
655** iDataCur, then its position should be preserved following the delete
656** operation. Or, if iIdxNoSeek is not a valid cursor number, the
657** position of iDataCur should be preserved instead.
danf0ee1d32015-09-12 19:26:11 +0000658**
659** iIdxNoSeek:
drh4cef5b12017-01-07 14:26:28 +0000660** If iIdxNoSeek is a valid cursor number (>=0) not equal to iDataCur,
661** then it identifies an index cursor (from within array of cursors
662** starting at iIdxCur) that already points to the index entry to be deleted.
drh68116932017-01-07 14:47:03 +0000663** Except, this optimization is disabled if there are BEFORE triggers since
664** the trigger body might have moved the cursor.
drh9cfcf5d2002-01-29 18:41:24 +0000665*/
danielk19774adee202004-05-08 08:23:19 +0000666void sqlite3GenerateRowDelete(
drh2d401ab2008-01-10 23:50:11 +0000667 Parse *pParse, /* Parsing context */
drh9cfcf5d2002-01-29 18:41:24 +0000668 Table *pTab, /* Table containing the row to be deleted */
dan2283d462009-09-08 15:55:15 +0000669 Trigger *pTrigger, /* List of triggers to (potentially) fire */
drh26198bb2013-10-31 11:15:09 +0000670 int iDataCur, /* Cursor from which column data is extracted */
671 int iIdxCur, /* First index cursor */
drhecb31b62013-10-24 19:48:39 +0000672 int iPk, /* First memory cell containing the PRIMARY KEY */
673 i16 nPk, /* Number of PRIMARY KEY memory cells */
674 u8 count, /* If non-zero, increment the row change counter */
drh392ee212013-11-08 16:54:56 +0000675 u8 onconf, /* Default ON CONFLICT policy for triggers */
drhb0264ee2015-09-14 14:45:50 +0000676 u8 eMode, /* ONEPASS_OFF, _SINGLE, or _MULTI. See above */
danf0ee1d32015-09-12 19:26:11 +0000677 int iIdxNoSeek /* Cursor number of cursor that does not need seeking */
drh9cfcf5d2002-01-29 18:41:24 +0000678){
dan2283d462009-09-08 15:55:15 +0000679 Vdbe *v = pParse->pVdbe; /* Vdbe */
drh3f022182009-09-09 16:10:50 +0000680 int iOld = 0; /* First register in OLD.* array */
dan2283d462009-09-08 15:55:15 +0000681 int iLabel; /* Label resolved to end of generated code */
drh261c02d2013-10-25 14:46:15 +0000682 u8 opSeek; /* Seek opcode */
drh2d401ab2008-01-10 23:50:11 +0000683
dan2283d462009-09-08 15:55:15 +0000684 /* Vdbe is guaranteed to have been allocated by this stage. */
685 assert( v );
drh6934fc72013-10-31 15:37:49 +0000686 VdbeModuleComment((v, "BEGIN: GenRowDel(%d,%d,%d,%d)",
drh26198bb2013-10-31 11:15:09 +0000687 iDataCur, iIdxCur, iPk, (int)nPk));
dan2283d462009-09-08 15:55:15 +0000688
689 /* Seek cursor iCur to the row to delete. If this row no longer exists
690 ** (this can happen if a trigger program has already deleted it), do
691 ** not attempt to delete it or fire any DELETE triggers. */
692 iLabel = sqlite3VdbeMakeLabel(v);
drh261c02d2013-10-25 14:46:15 +0000693 opSeek = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
drhb0264ee2015-09-14 14:45:50 +0000694 if( eMode==ONEPASS_OFF ){
drh688852a2014-02-17 22:40:43 +0000695 sqlite3VdbeAddOp4Int(v, opSeek, iDataCur, iLabel, iPk, nPk);
drh49d9ba62014-02-19 00:53:46 +0000696 VdbeCoverageIf(v, opSeek==OP_NotExists);
697 VdbeCoverageIf(v, opSeek==OP_NotFound);
drh688852a2014-02-17 22:40:43 +0000698 }
dan2283d462009-09-08 15:55:15 +0000699
700 /* If there are any triggers to fire, allocate a range of registers to
701 ** use for the old.* references in the triggers. */
dane7a94d82009-10-01 16:09:04 +0000702 if( sqlite3FkRequired(pParse, pTab, 0, 0) || pTrigger ){
dan2283d462009-09-08 15:55:15 +0000703 u32 mask; /* Mask of OLD.* columns in use */
704 int iCol; /* Iterator used while populating OLD.* */
drh83d47af2013-11-17 02:42:02 +0000705 int addrStart; /* Start of BEFORE trigger programs */
dan2283d462009-09-08 15:55:15 +0000706
707 /* TODO: Could use temporary registers here. Also could attempt to
708 ** avoid copying the contents of the rowid register. */
danbb5f1682009-11-27 12:12:34 +0000709 mask = sqlite3TriggerColmask(
710 pParse, pTrigger, 0, 0, TRIGGER_BEFORE|TRIGGER_AFTER, pTab, onconf
711 );
dane7a94d82009-10-01 16:09:04 +0000712 mask |= sqlite3FkOldmask(pParse, pTab);
dan2283d462009-09-08 15:55:15 +0000713 iOld = pParse->nMem+1;
714 pParse->nMem += (1 + pTab->nCol);
715
716 /* Populate the OLD.* pseudo-table register array. These values will be
717 ** used by any BEFORE and AFTER triggers that exist. */
drhecb31b62013-10-24 19:48:39 +0000718 sqlite3VdbeAddOp2(v, OP_Copy, iPk, iOld);
dan2283d462009-09-08 15:55:15 +0000719 for(iCol=0; iCol<pTab->nCol; iCol++){
drh693e6712014-01-24 22:58:00 +0000720 testcase( mask!=0xffffffff && iCol==31 );
drh4d067982014-01-28 18:53:29 +0000721 testcase( mask!=0xffffffff && iCol==32 );
722 if( mask==0xffffffff || (iCol<=31 && (mask & MASKBIT32(iCol))!=0) ){
drh26198bb2013-10-31 11:15:09 +0000723 sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, iCol, iOld+iCol+1);
dan2283d462009-09-08 15:55:15 +0000724 }
725 }
726
dan1da40a32009-09-19 17:00:31 +0000727 /* Invoke BEFORE DELETE trigger programs. */
drh83d47af2013-11-17 02:42:02 +0000728 addrStart = sqlite3VdbeCurrentAddr(v);
dan2283d462009-09-08 15:55:15 +0000729 sqlite3CodeRowTrigger(pParse, pTrigger,
dan94d7f502009-09-24 09:05:49 +0000730 TK_DELETE, 0, TRIGGER_BEFORE, pTab, iOld, onconf, iLabel
dan2283d462009-09-08 15:55:15 +0000731 );
732
drh83d47af2013-11-17 02:42:02 +0000733 /* If any BEFORE triggers were coded, then seek the cursor to the
734 ** row to be deleted again. It may be that the BEFORE triggers moved
drh4cef5b12017-01-07 14:26:28 +0000735 ** the cursor or already deleted the row that the cursor was
drh83d47af2013-11-17 02:42:02 +0000736 ** pointing to.
drh68116932017-01-07 14:47:03 +0000737 **
738 ** Also disable the iIdxNoSeek optimization since the BEFORE trigger
739 ** may have moved that cursor.
drh83d47af2013-11-17 02:42:02 +0000740 */
741 if( addrStart<sqlite3VdbeCurrentAddr(v) ){
742 sqlite3VdbeAddOp4Int(v, opSeek, iDataCur, iLabel, iPk, nPk);
drh49d9ba62014-02-19 00:53:46 +0000743 VdbeCoverageIf(v, opSeek==OP_NotExists);
744 VdbeCoverageIf(v, opSeek==OP_NotFound);
drh68116932017-01-07 14:47:03 +0000745 testcase( iIdxNoSeek>=0 );
746 iIdxNoSeek = -1;
drh83d47af2013-11-17 02:42:02 +0000747 }
dan1da40a32009-09-19 17:00:31 +0000748
749 /* Do FK processing. This call checks that any FK constraints that
750 ** refer to this table (i.e. constraints attached to other tables)
751 ** are not violated by deleting this row. */
dan8ff2d952013-09-05 18:40:29 +0000752 sqlite3FkCheck(pParse, pTab, iOld, 0, 0, 0);
danielk197794eb6a12005-12-15 15:22:08 +0000753 }
dan2283d462009-09-08 15:55:15 +0000754
755 /* Delete the index and table entries. Skip this step if pTab is really
756 ** a view (in which case the only effect of the DELETE statement is to
dan46c47d42011-03-01 18:42:07 +0000757 ** fire the INSTEAD OF triggers).
758 **
759 ** If variable 'count' is non-zero, then this OP_Delete instruction should
760 ** invoke the update-hook. The pre-update-hook, on the other hand should
761 ** be invoked unless table pTab is a system table. The difference is that
762 ** the update-hook is not invoked for rows removed by REPLACE, but the
763 ** pre-update-hook is.
764 */
dan2283d462009-09-08 15:55:15 +0000765 if( pTab->pSelect==0 ){
drhe807bdb2016-01-21 17:06:33 +0000766 u8 p5 = 0;
danf0ee1d32015-09-12 19:26:11 +0000767 sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur,0,iIdxNoSeek);
drh26198bb2013-10-31 11:15:09 +0000768 sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, (count?OPFLAG_NCHANGE:0));
dan614efe22018-01-12 16:44:29 +0000769 if( pParse->nested==0 || 0==sqlite3_stricmp(pTab->zName, "sqlite_stat1") ){
dan50133de2017-01-27 17:02:26 +0000770 sqlite3VdbeAppendP4(v, (char*)pTab, P4_TABLE);
771 }
drhb89aeb62016-01-27 15:49:32 +0000772 if( eMode!=ONEPASS_OFF ){
drhdef19e32016-01-27 16:26:25 +0000773 sqlite3VdbeChangeP5(v, OPFLAG_AUXDELETE);
drhb89aeb62016-01-27 15:49:32 +0000774 }
drhad1d9a82017-01-07 03:26:50 +0000775 if( iIdxNoSeek>=0 && iIdxNoSeek!=iDataCur ){
danf0ee1d32015-09-12 19:26:11 +0000776 sqlite3VdbeAddOp1(v, OP_Delete, iIdxNoSeek);
777 }
drhe807bdb2016-01-21 17:06:33 +0000778 if( eMode==ONEPASS_MULTI ) p5 |= OPFLAG_SAVEPOSITION;
779 sqlite3VdbeChangeP5(v, p5);
dan2283d462009-09-08 15:55:15 +0000780 }
781
dan1da40a32009-09-19 17:00:31 +0000782 /* Do any ON CASCADE, SET NULL or SET DEFAULT operations required to
783 ** handle rows (possibly in other tables) that refer via a foreign key
784 ** to the row just deleted. */
dan8ff2d952013-09-05 18:40:29 +0000785 sqlite3FkActions(pParse, pTab, 0, iOld, 0, 0);
dan1da40a32009-09-19 17:00:31 +0000786
787 /* Invoke AFTER DELETE trigger programs. */
788 sqlite3CodeRowTrigger(pParse, pTrigger,
dan94d7f502009-09-24 09:05:49 +0000789 TK_DELETE, 0, TRIGGER_AFTER, pTab, iOld, onconf, iLabel
dan1da40a32009-09-19 17:00:31 +0000790 );
dan2283d462009-09-08 15:55:15 +0000791
792 /* Jump here if the row had already been deleted before any BEFORE
793 ** trigger programs were invoked. Or if a trigger program throws a
794 ** RAISE(IGNORE) exception. */
795 sqlite3VdbeResolveLabel(v, iLabel);
drh6934fc72013-10-31 15:37:49 +0000796 VdbeModuleComment((v, "END: GenRowDel()"));
drh0ca3e242002-01-29 23:07:02 +0000797}
798
799/*
800** This routine generates VDBE code that causes the deletion of all
drh6934fc72013-10-31 15:37:49 +0000801** index entries associated with a single row of a single table, pTab
drh0ca3e242002-01-29 23:07:02 +0000802**
drh6934fc72013-10-31 15:37:49 +0000803** Preconditions:
drh0ca3e242002-01-29 23:07:02 +0000804**
drh6934fc72013-10-31 15:37:49 +0000805** 1. A read/write cursor "iDataCur" must be open on the canonical storage
806** btree for the table pTab. (This will be either the table itself
drh26198bb2013-10-31 11:15:09 +0000807** for rowid tables or to the primary key index for WITHOUT ROWID
drh6934fc72013-10-31 15:37:49 +0000808** tables.)
drh0ca3e242002-01-29 23:07:02 +0000809**
810** 2. Read/write cursors for all indices of pTab must be open as
drh6934fc72013-10-31 15:37:49 +0000811** cursor number iIdxCur+i for the i-th index. (The pTab->pIndex
812** index is the 0-th index.)
drh0ca3e242002-01-29 23:07:02 +0000813**
drh6934fc72013-10-31 15:37:49 +0000814** 3. The "iDataCur" cursor must be already be positioned on the row
815** that is to be deleted.
drh0ca3e242002-01-29 23:07:02 +0000816*/
danielk19774adee202004-05-08 08:23:19 +0000817void sqlite3GenerateRowIndexDelete(
drh2d401ab2008-01-10 23:50:11 +0000818 Parse *pParse, /* Parsing and code generating context */
drh0ca3e242002-01-29 23:07:02 +0000819 Table *pTab, /* Table containing the row to be deleted */
drh26198bb2013-10-31 11:15:09 +0000820 int iDataCur, /* Cursor of table holding data. */
821 int iIdxCur, /* First index cursor */
danf0ee1d32015-09-12 19:26:11 +0000822 int *aRegIdx, /* Only delete if aRegIdx!=0 && aRegIdx[i]>0 */
823 int iIdxNoSeek /* Do not delete from this cursor */
drh0ca3e242002-01-29 23:07:02 +0000824){
drh6934fc72013-10-31 15:37:49 +0000825 int i; /* Index loop counter */
drh1c2c0b72014-01-04 19:27:05 +0000826 int r1 = -1; /* Register holding an index key */
drh6934fc72013-10-31 15:37:49 +0000827 int iPartIdxLabel; /* Jump destination for skipping partial index entries */
828 Index *pIdx; /* Current index */
drh1c2c0b72014-01-04 19:27:05 +0000829 Index *pPrior = 0; /* Prior index */
drh6934fc72013-10-31 15:37:49 +0000830 Vdbe *v; /* The prepared statement under construction */
831 Index *pPk; /* PRIMARY KEY index, or NULL for rowid tables */
drh9cfcf5d2002-01-29 18:41:24 +0000832
drh6934fc72013-10-31 15:37:49 +0000833 v = pParse->pVdbe;
drh261c02d2013-10-25 14:46:15 +0000834 pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
drh26198bb2013-10-31 11:15:09 +0000835 for(i=0, pIdx=pTab->pIndex; pIdx; i++, pIdx=pIdx->pNext){
drh6934fc72013-10-31 15:37:49 +0000836 assert( iIdxCur+i!=iDataCur || pPk==pIdx );
drh26198bb2013-10-31 11:15:09 +0000837 if( aRegIdx!=0 && aRegIdx[i]==0 ) continue;
drh261c02d2013-10-25 14:46:15 +0000838 if( pIdx==pPk ) continue;
danf0ee1d32015-09-12 19:26:11 +0000839 if( iIdxCur+i==iIdxNoSeek ) continue;
drh392ee212013-11-08 16:54:56 +0000840 VdbeModuleComment((v, "GenRowIdxDel for %s", pIdx->zName));
drh1c2c0b72014-01-04 19:27:05 +0000841 r1 = sqlite3GenerateIndexKey(pParse, pIdx, iDataCur, 0, 1,
danf0ee1d32015-09-12 19:26:11 +0000842 &iPartIdxLabel, pPrior, r1);
drh26198bb2013-10-31 11:15:09 +0000843 sqlite3VdbeAddOp3(v, OP_IdxDelete, iIdxCur+i, r1,
danf0ee1d32015-09-12 19:26:11 +0000844 pIdx->uniqNotNull ? pIdx->nKeyCol : pIdx->nColumn);
drh87744512014-04-13 19:15:49 +0000845 sqlite3ResolvePartIdxLabel(pParse, iPartIdxLabel);
drh1c2c0b72014-01-04 19:27:05 +0000846 pPrior = pIdx;
drh9cfcf5d2002-01-29 18:41:24 +0000847 }
drh9cfcf5d2002-01-29 18:41:24 +0000848}
drh51846b52004-05-28 16:00:21 +0000849
850/*
drh9eade082013-10-24 14:16:10 +0000851** Generate code that will assemble an index key and stores it in register
drhe14006d2008-03-25 17:23:32 +0000852** regOut. The key with be for index pIdx which is an index on pTab.
drh51846b52004-05-28 16:00:21 +0000853** iCur is the index of a cursor open on the pTab table and pointing to
drh26198bb2013-10-31 11:15:09 +0000854** the entry that needs indexing. If pTab is a WITHOUT ROWID table, then
855** iCur must be the cursor of the PRIMARY KEY index.
drh2d401ab2008-01-10 23:50:11 +0000856**
857** Return a register number which is the first in a block of
858** registers that holds the elements of the index key. The
859** block of registers has already been deallocated by the time
860** this routine returns.
drhb2b9d3d2013-08-01 01:14:43 +0000861**
862** If *piPartIdxLabel is not NULL, fill it in with a label and jump
863** to that label if pIdx is a partial index that should be skipped.
drh87744512014-04-13 19:15:49 +0000864** The label should be resolved using sqlite3ResolvePartIdxLabel().
drhb2b9d3d2013-08-01 01:14:43 +0000865** A partial index should be skipped if its WHERE clause evaluates
866** to false or null. If pIdx is not a partial index, *piPartIdxLabel
867** will be set to zero which is an empty label that is ignored by
drh87744512014-04-13 19:15:49 +0000868** sqlite3ResolvePartIdxLabel().
drh1c2c0b72014-01-04 19:27:05 +0000869**
870** The pPrior and regPrior parameters are used to implement a cache to
871** avoid unnecessary register loads. If pPrior is not NULL, then it is
872** a pointer to a different index for which an index key has just been
873** computed into register regPrior. If the current pIdx index is generating
874** its key into the same sequence of registers and if pPrior and pIdx share
875** a column in common, then the register corresponding to that column already
876** holds the correct value and the loading of that register is skipped.
877** This optimization is helpful when doing a DELETE or an INTEGRITY_CHECK
878** on a table with multiple indices, and especially with the ROWID or
879** PRIMARY KEY columns of the index.
drh51846b52004-05-28 16:00:21 +0000880*/
drh2d401ab2008-01-10 23:50:11 +0000881int sqlite3GenerateIndexKey(
drhb2b9d3d2013-08-01 01:14:43 +0000882 Parse *pParse, /* Parsing context */
883 Index *pIdx, /* The index for which to generate a key */
drh26198bb2013-10-31 11:15:09 +0000884 int iDataCur, /* Cursor number from which to take column data */
drh9eade082013-10-24 14:16:10 +0000885 int regOut, /* Put the new key into this register if not 0 */
886 int prefixOnly, /* Compute only a unique prefix of the key */
drh1c2c0b72014-01-04 19:27:05 +0000887 int *piPartIdxLabel, /* OUT: Jump to this label to skip partial index */
888 Index *pPrior, /* Previously generated index key */
889 int regPrior /* Register holding previous generated key */
drh51846b52004-05-28 16:00:21 +0000890){
drh2d401ab2008-01-10 23:50:11 +0000891 Vdbe *v = pParse->pVdbe;
drh51846b52004-05-28 16:00:21 +0000892 int j;
drh2d401ab2008-01-10 23:50:11 +0000893 int regBase;
894 int nCol;
drh51846b52004-05-28 16:00:21 +0000895
drhb2b9d3d2013-08-01 01:14:43 +0000896 if( piPartIdxLabel ){
897 if( pIdx->pPartIdxWhere ){
898 *piPartIdxLabel = sqlite3VdbeMakeLabel(v);
drh3e34eab2017-07-19 19:48:40 +0000899 pParse->iSelfTab = iDataCur + 1;
drh72bc8202015-06-11 13:58:35 +0000900 sqlite3ExprIfFalseDup(pParse, pIdx->pPartIdxWhere, *piPartIdxLabel,
901 SQLITE_JUMPIFNULL);
drh3e34eab2017-07-19 19:48:40 +0000902 pParse->iSelfTab = 0;
drhb2b9d3d2013-08-01 01:14:43 +0000903 }else{
904 *piPartIdxLabel = 0;
905 }
906 }
drh9eade082013-10-24 14:16:10 +0000907 nCol = (prefixOnly && pIdx->uniqNotNull) ? pIdx->nKeyCol : pIdx->nColumn;
drh44156282013-10-23 22:23:03 +0000908 regBase = sqlite3GetTempRange(pParse, nCol);
drh1c2c0b72014-01-04 19:27:05 +0000909 if( pPrior && (regBase!=regPrior || pPrior->pPartIdxWhere) ) pPrior = 0;
drh2d401ab2008-01-10 23:50:11 +0000910 for(j=0; j<nCol; j++){
drh1f9ca2c2015-08-25 16:57:52 +0000911 if( pPrior
912 && pPrior->aiColumn[j]==pIdx->aiColumn[j]
drh4b92f982015-09-29 17:20:14 +0000913 && pPrior->aiColumn[j]!=XN_EXPR
drh1f9ca2c2015-08-25 16:57:52 +0000914 ){
915 /* This column was already computed by the previous index */
916 continue;
917 }
918 sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iDataCur, j, regBase+j);
drh762c1c42014-01-02 19:35:30 +0000919 /* If the column affinity is REAL but the number is an integer, then it
920 ** might be stored in the table as an integer (using a compact
921 ** representation) then converted to REAL by an OP_RealAffinity opcode.
922 ** But we are getting ready to store this value back into an index, where
923 ** it should be converted by to INTEGER again. So omit the OP_RealAffinity
924 ** opcode if it is present */
drh61019c72014-01-04 16:49:02 +0000925 sqlite3VdbeDeletePriorOpcode(v, OP_RealAffinity);
drh51846b52004-05-28 16:00:21 +0000926 }
drh9eade082013-10-24 14:16:10 +0000927 if( regOut ){
drh44156282013-10-23 22:23:03 +0000928 sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regOut);
drhda060052017-01-16 16:43:02 +0000929 if( pIdx->pTable->pSelect ){
930 const char *zAff = sqlite3IndexAffinityStr(pParse->db, pIdx);
931 sqlite3VdbeChangeP4(v, -1, zAff, P4_TRANSIENT);
932 }
drhe14006d2008-03-25 17:23:32 +0000933 }
drh44156282013-10-23 22:23:03 +0000934 sqlite3ReleaseTempRange(pParse, regBase, nCol);
drh2d401ab2008-01-10 23:50:11 +0000935 return regBase;
drh51846b52004-05-28 16:00:21 +0000936}
drh87744512014-04-13 19:15:49 +0000937
938/*
939** If a prior call to sqlite3GenerateIndexKey() generated a jump-over label
940** because it was a partial index, then this routine should be called to
941** resolve that label.
942*/
943void sqlite3ResolvePartIdxLabel(Parse *pParse, int iLabel){
944 if( iLabel ){
945 sqlite3VdbeResolveLabel(pParse->pVdbe, iLabel);
drh87744512014-04-13 19:15:49 +0000946 }
947}