xref: /sqlite-3.40.0/src/update.c (revision dedd51ae)
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 ** to handle UPDATE statements.
14 */
15 #include "sqliteInt.h"
16 
17 #ifndef SQLITE_OMIT_VIRTUALTABLE
18 /* Forward declaration */
19 static void updateVirtualTable(
20   Parse *pParse,       /* The parsing context */
21   SrcList *pSrc,       /* The virtual table to be modified */
22   Table *pTab,         /* The virtual table */
23   ExprList *pChanges,  /* The columns to change in the UPDATE statement */
24   Expr *pRowidExpr,    /* Expression used to recompute the rowid */
25   int *aXRef,          /* Mapping from columns of pTab to entries in pChanges */
26   Expr *pWhere,        /* WHERE clause of the UPDATE statement */
27   int onError          /* ON CONFLICT strategy */
28 );
29 #endif /* SQLITE_OMIT_VIRTUALTABLE */
30 
31 /*
32 ** The most recently coded instruction was an OP_Column to retrieve the
33 ** i-th column of table pTab. This routine sets the P4 parameter of the
34 ** OP_Column to the default value, if any.
35 **
36 ** The default value of a column is specified by a DEFAULT clause in the
37 ** column definition. This was either supplied by the user when the table
38 ** was created, or added later to the table definition by an ALTER TABLE
39 ** command. If the latter, then the row-records in the table btree on disk
40 ** may not contain a value for the column and the default value, taken
41 ** from the P4 parameter of the OP_Column instruction, is returned instead.
42 ** If the former, then all row-records are guaranteed to include a value
43 ** for the column and the P4 value is not required.
44 **
45 ** Column definitions created by an ALTER TABLE command may only have
46 ** literal default values specified: a number, null or a string. (If a more
47 ** complicated default expression value was provided, it is evaluated
48 ** when the ALTER TABLE is executed and one of the literal values written
49 ** into the sqlite_schema table.)
50 **
51 ** Therefore, the P4 parameter is only required if the default value for
52 ** the column is a literal number, string or null. The sqlite3ValueFromExpr()
53 ** function is capable of transforming these types of expressions into
54 ** sqlite3_value objects.
55 **
56 ** If column as REAL affinity and the table is an ordinary b-tree table
57 ** (not a virtual table) then the value might have been stored as an
58 ** integer.  In that case, add an OP_RealAffinity opcode to make sure
59 ** it has been converted into REAL.
60 */
61 void sqlite3ColumnDefault(Vdbe *v, Table *pTab, int i, int iReg){
62   assert( pTab!=0 );
63   if( !IsView(pTab) ){
64     sqlite3_value *pValue = 0;
65     u8 enc = ENC(sqlite3VdbeDb(v));
66     Column *pCol = &pTab->aCol[i];
67     VdbeComment((v, "%s.%s", pTab->zName, pCol->zCnName));
68     assert( i<pTab->nCol );
69     sqlite3ValueFromExpr(sqlite3VdbeDb(v),
70                          sqlite3ColumnExpr(pTab,pCol), enc,
71                          pCol->affinity, &pValue);
72     if( pValue ){
73       sqlite3VdbeAppendP4(v, pValue, P4_MEM);
74     }
75   }
76 #ifndef SQLITE_OMIT_FLOATING_POINT
77   if( pTab->aCol[i].affinity==SQLITE_AFF_REAL && !IsVirtual(pTab) ){
78     sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
79   }
80 #endif
81 }
82 
83 /*
84 ** Check to see if column iCol of index pIdx references any of the
85 ** columns defined by aXRef and chngRowid.  Return true if it does
86 ** and false if not.  This is an optimization.  False-positives are a
87 ** performance degradation, but false-negatives can result in a corrupt
88 ** index and incorrect answers.
89 **
90 ** aXRef[j] will be non-negative if column j of the original table is
91 ** being updated.  chngRowid will be true if the rowid of the table is
92 ** being updated.
93 */
94 static int indexColumnIsBeingUpdated(
95   Index *pIdx,      /* The index to check */
96   int iCol,         /* Which column of the index to check */
97   int *aXRef,       /* aXRef[j]>=0 if column j is being updated */
98   int chngRowid     /* true if the rowid is being updated */
99 ){
100   i16 iIdxCol = pIdx->aiColumn[iCol];
101   assert( iIdxCol!=XN_ROWID ); /* Cannot index rowid */
102   if( iIdxCol>=0 ){
103     return aXRef[iIdxCol]>=0;
104   }
105   assert( iIdxCol==XN_EXPR );
106   assert( pIdx->aColExpr!=0 );
107   assert( pIdx->aColExpr->a[iCol].pExpr!=0 );
108   return sqlite3ExprReferencesUpdatedColumn(pIdx->aColExpr->a[iCol].pExpr,
109                                             aXRef,chngRowid);
110 }
111 
112 /*
113 ** Check to see if index pIdx is a partial index whose conditional
114 ** expression might change values due to an UPDATE.  Return true if
115 ** the index is subject to change and false if the index is guaranteed
116 ** to be unchanged.  This is an optimization.  False-positives are a
117 ** performance degradation, but false-negatives can result in a corrupt
118 ** index and incorrect answers.
119 **
120 ** aXRef[j] will be non-negative if column j of the original table is
121 ** being updated.  chngRowid will be true if the rowid of the table is
122 ** being updated.
123 */
124 static int indexWhereClauseMightChange(
125   Index *pIdx,      /* The index to check */
126   int *aXRef,       /* aXRef[j]>=0 if column j is being updated */
127   int chngRowid     /* true if the rowid is being updated */
128 ){
129   if( pIdx->pPartIdxWhere==0 ) return 0;
130   return sqlite3ExprReferencesUpdatedColumn(pIdx->pPartIdxWhere,
131                                             aXRef, chngRowid);
132 }
133 
134 /*
135 ** Allocate and return a pointer to an expression of type TK_ROW with
136 ** Expr.iColumn set to value (iCol+1). The resolver will modify the
137 ** expression to be a TK_COLUMN reading column iCol of the first
138 ** table in the source-list (pSrc->a[0]).
139 */
140 static Expr *exprRowColumn(Parse *pParse, int iCol){
141   Expr *pRet = sqlite3PExpr(pParse, TK_ROW, 0, 0);
142   if( pRet ) pRet->iColumn = iCol+1;
143   return pRet;
144 }
145 
146 /*
147 ** Assuming both the pLimit and pOrderBy parameters are NULL, this function
148 ** generates VM code to run the query:
149 **
150 **   SELECT <other-columns>, pChanges FROM pTabList WHERE pWhere
151 **
152 ** and write the results to the ephemeral table already opened as cursor
153 ** iEph. None of pChanges, pTabList or pWhere are modified or consumed by
154 ** this function, they must be deleted by the caller.
155 **
156 ** Or, if pLimit and pOrderBy are not NULL, and pTab is not a view:
157 **
158 **   SELECT <other-columns>, pChanges FROM pTabList
159 **   WHERE pWhere
160 **   GROUP BY <other-columns>
161 **   ORDER BY pOrderBy LIMIT pLimit
162 **
163 ** If pTab is a view, the GROUP BY clause is omitted.
164 **
165 ** Exactly how results are written to table iEph, and exactly what
166 ** the <other-columns> in the query above are is determined by the type
167 ** of table pTabList->a[0].pTab.
168 **
169 ** If the table is a WITHOUT ROWID table, then argument pPk must be its
170 ** PRIMARY KEY. In this case <other-columns> are the primary key columns
171 ** of the table, in order. The results of the query are written to ephemeral
172 ** table iEph as index keys, using OP_IdxInsert.
173 **
174 ** If the table is actually a view, then <other-columns> are all columns of
175 ** the view. The results are written to the ephemeral table iEph as records
176 ** with automatically assigned integer keys.
177 **
178 ** If the table is a virtual or ordinary intkey table, then <other-columns>
179 ** is its rowid. For a virtual table, the results are written to iEph as
180 ** records with automatically assigned integer keys For intkey tables, the
181 ** rowid value in <other-columns> is used as the integer key, and the
182 ** remaining fields make up the table record.
183 */
184 static void updateFromSelect(
185   Parse *pParse,                  /* Parse context */
186   int iEph,                       /* Cursor for open eph. table */
187   Index *pPk,                     /* PK if table 0 is WITHOUT ROWID */
188   ExprList *pChanges,             /* List of expressions to return */
189   SrcList *pTabList,              /* List of tables to select from */
190   Expr *pWhere,                   /* WHERE clause for query */
191   ExprList *pOrderBy,             /* ORDER BY clause */
192   Expr *pLimit                    /* LIMIT clause */
193 ){
194   int i;
195   SelectDest dest;
196   Select *pSelect = 0;
197   ExprList *pList = 0;
198   ExprList *pGrp = 0;
199   Expr *pLimit2 = 0;
200   ExprList *pOrderBy2 = 0;
201   sqlite3 *db = pParse->db;
202   Table *pTab = pTabList->a[0].pTab;
203   SrcList *pSrc;
204   Expr *pWhere2;
205   int eDest;
206 
207 #ifdef SQLITE_ENABLE_UPDATE_DELETE_LIMIT
208   if( pOrderBy && pLimit==0 ) {
209     sqlite3ErrorMsg(pParse, "ORDER BY without LIMIT on UPDATE");
210     return;
211   }
212   pOrderBy2 = sqlite3ExprListDup(db, pOrderBy, 0);
213   pLimit2 = sqlite3ExprDup(db, pLimit, 0);
214 #else
215   UNUSED_PARAMETER(pOrderBy);
216   UNUSED_PARAMETER(pLimit);
217 #endif
218 
219   pSrc = sqlite3SrcListDup(db, pTabList, 0);
220   pWhere2 = sqlite3ExprDup(db, pWhere, 0);
221 
222   assert( pTabList->nSrc>1 );
223   if( pSrc ){
224     pSrc->a[0].fg.notCte = 1;
225     pSrc->a[0].iCursor = -1;
226     pSrc->a[0].pTab->nTabRef--;
227     pSrc->a[0].pTab = 0;
228   }
229   if( pPk ){
230     for(i=0; i<pPk->nKeyCol; i++){
231       Expr *pNew = exprRowColumn(pParse, pPk->aiColumn[i]);
232 #ifdef SQLITE_ENABLE_UPDATE_DELETE_LIMIT
233       if( pLimit ){
234         pGrp = sqlite3ExprListAppend(pParse, pGrp, sqlite3ExprDup(db, pNew, 0));
235       }
236 #endif
237       pList = sqlite3ExprListAppend(pParse, pList, pNew);
238     }
239     eDest = IsVirtual(pTab) ? SRT_Table : SRT_Upfrom;
240   }else if( IsView(pTab) ){
241     for(i=0; i<pTab->nCol; i++){
242       pList = sqlite3ExprListAppend(pParse, pList, exprRowColumn(pParse, i));
243     }
244     eDest = SRT_Table;
245   }else{
246     eDest = IsVirtual(pTab) ? SRT_Table : SRT_Upfrom;
247     pList = sqlite3ExprListAppend(pParse, 0, sqlite3PExpr(pParse,TK_ROW,0,0));
248 #ifdef SQLITE_ENABLE_UPDATE_DELETE_LIMIT
249     if( pLimit ){
250       pGrp = sqlite3ExprListAppend(pParse, 0, sqlite3PExpr(pParse,TK_ROW,0,0));
251     }
252 #endif
253   }
254   assert( pChanges!=0 || pParse->db->mallocFailed );
255   if( pChanges ){
256     for(i=0; i<pChanges->nExpr; i++){
257       pList = sqlite3ExprListAppend(pParse, pList,
258           sqlite3ExprDup(db, pChanges->a[i].pExpr, 0)
259       );
260     }
261   }
262   pSelect = sqlite3SelectNew(pParse, pList,
263       pSrc, pWhere2, pGrp, 0, pOrderBy2, SF_UFSrcCheck|SF_IncludeHidden, pLimit2
264   );
265   if( pSelect ) pSelect->selFlags |= SF_OrderByReqd;
266   sqlite3SelectDestInit(&dest, eDest, iEph);
267   dest.iSDParm2 = (pPk ? pPk->nKeyCol : -1);
268   sqlite3Select(pParse, pSelect, &dest);
269   sqlite3SelectDelete(db, pSelect);
270 }
271 
272 /*
273 ** Process an UPDATE statement.
274 **
275 **   UPDATE OR IGNORE tbl SET a=b, c=d FROM tbl2... WHERE e<5 AND f NOT NULL;
276 **          \_______/ \_/     \______/      \_____/       \________________/
277 **           onError   |      pChanges         |                pWhere
278 **                     \_______________________/
279 **                               pTabList
280 */
281 void sqlite3Update(
282   Parse *pParse,         /* The parser context */
283   SrcList *pTabList,     /* The table in which we should change things */
284   ExprList *pChanges,    /* Things to be changed */
285   Expr *pWhere,          /* The WHERE clause.  May be null */
286   int onError,           /* How to handle constraint errors */
287   ExprList *pOrderBy,    /* ORDER BY clause. May be null */
288   Expr *pLimit,          /* LIMIT clause. May be null */
289   Upsert *pUpsert        /* ON CONFLICT clause, or null */
290 ){
291   int i, j, k;           /* Loop counters */
292   Table *pTab;           /* The table to be updated */
293   int addrTop = 0;       /* VDBE instruction address of the start of the loop */
294   WhereInfo *pWInfo = 0; /* Information about the WHERE clause */
295   Vdbe *v;               /* The virtual database engine */
296   Index *pIdx;           /* For looping over indices */
297   Index *pPk;            /* The PRIMARY KEY index for WITHOUT ROWID tables */
298   int nIdx;              /* Number of indices that need updating */
299   int nAllIdx;           /* Total number of indexes */
300   int iBaseCur;          /* Base cursor number */
301   int iDataCur;          /* Cursor for the canonical data btree */
302   int iIdxCur;           /* Cursor for the first index */
303   sqlite3 *db;           /* The database structure */
304   int *aRegIdx = 0;      /* Registers for to each index and the main table */
305   int *aXRef = 0;        /* aXRef[i] is the index in pChanges->a[] of the
306                          ** an expression for the i-th column of the table.
307                          ** aXRef[i]==-1 if the i-th column is not changed. */
308   u8 *aToOpen;           /* 1 for tables and indices to be opened */
309   u8 chngPk;             /* PRIMARY KEY changed in a WITHOUT ROWID table */
310   u8 chngRowid;          /* Rowid changed in a normal table */
311   u8 chngKey;            /* Either chngPk or chngRowid */
312   Expr *pRowidExpr = 0;  /* Expression defining the new record number */
313   int iRowidExpr = -1;   /* Index of "rowid=" (or IPK) assignment in pChanges */
314   AuthContext sContext;  /* The authorization context */
315   NameContext sNC;       /* The name-context to resolve expressions in */
316   int iDb;               /* Database containing the table being updated */
317   int eOnePass;          /* ONEPASS_XXX value from where.c */
318   int hasFK;             /* True if foreign key processing is required */
319   int labelBreak;        /* Jump here to break out of UPDATE loop */
320   int labelContinue;     /* Jump here to continue next step of UPDATE loop */
321   int flags;             /* Flags for sqlite3WhereBegin() */
322 
323 #ifndef SQLITE_OMIT_TRIGGER
324   int isView;            /* True when updating a view (INSTEAD OF trigger) */
325   Trigger *pTrigger;     /* List of triggers on pTab, if required */
326   int tmask;             /* Mask of TRIGGER_BEFORE|TRIGGER_AFTER */
327 #endif
328   int newmask;           /* Mask of NEW.* columns accessed by BEFORE triggers */
329   int iEph = 0;          /* Ephemeral table holding all primary key values */
330   int nKey = 0;          /* Number of elements in regKey for WITHOUT ROWID */
331   int aiCurOnePass[2];   /* The write cursors opened by WHERE_ONEPASS */
332   int addrOpen = 0;      /* Address of OP_OpenEphemeral */
333   int iPk = 0;           /* First of nPk cells holding PRIMARY KEY value */
334   i16 nPk = 0;           /* Number of components of the PRIMARY KEY */
335   int bReplace = 0;      /* True if REPLACE conflict resolution might happen */
336   int bFinishSeek = 1;   /* The OP_FinishSeek opcode is needed */
337   int nChangeFrom = 0;   /* If there is a FROM, pChanges->nExpr, else 0 */
338 
339   /* Register Allocations */
340   int regRowCount = 0;   /* A count of rows changed */
341   int regOldRowid = 0;   /* The old rowid */
342   int regNewRowid = 0;   /* The new rowid */
343   int regNew = 0;        /* Content of the NEW.* table in triggers */
344   int regOld = 0;        /* Content of OLD.* table in triggers */
345   int regRowSet = 0;     /* Rowset of rows to be updated */
346   int regKey = 0;        /* composite PRIMARY KEY value */
347 
348   memset(&sContext, 0, sizeof(sContext));
349   db = pParse->db;
350   assert( db->pParse==pParse );
351   if( pParse->nErr ){
352     goto update_cleanup;
353   }
354   assert( db->mallocFailed==0 );
355 
356   /* Locate the table which we want to update.
357   */
358   pTab = sqlite3SrcListLookup(pParse, pTabList);
359   if( pTab==0 ) goto update_cleanup;
360   iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
361 
362   /* Figure out if we have any triggers and if the table being
363   ** updated is a view.
364   */
365 #ifndef SQLITE_OMIT_TRIGGER
366   pTrigger = sqlite3TriggersExist(pParse, pTab, TK_UPDATE, pChanges, &tmask);
367   isView = IsView(pTab);
368   assert( pTrigger || tmask==0 );
369 #else
370 # define pTrigger 0
371 # define isView 0
372 # define tmask 0
373 #endif
374 #ifdef SQLITE_OMIT_VIEW
375 # undef isView
376 # define isView 0
377 #endif
378 
379   /* If there was a FROM clause, set nChangeFrom to the number of expressions
380   ** in the change-list. Otherwise, set it to 0. There cannot be a FROM
381   ** clause if this function is being called to generate code for part of
382   ** an UPSERT statement.  */
383   nChangeFrom = (pTabList->nSrc>1) ? pChanges->nExpr : 0;
384   assert( nChangeFrom==0 || pUpsert==0 );
385 
386 #ifdef SQLITE_ENABLE_UPDATE_DELETE_LIMIT
387   if( !isView && nChangeFrom==0 ){
388     pWhere = sqlite3LimitWhere(
389         pParse, pTabList, pWhere, pOrderBy, pLimit, "UPDATE"
390     );
391     pOrderBy = 0;
392     pLimit = 0;
393   }
394 #endif
395 
396   if( sqlite3ViewGetColumnNames(pParse, pTab) ){
397     goto update_cleanup;
398   }
399   if( sqlite3IsReadOnly(pParse, pTab, tmask) ){
400     goto update_cleanup;
401   }
402 
403   /* Allocate a cursors for the main database table and for all indices.
404   ** The index cursors might not be used, but if they are used they
405   ** need to occur right after the database cursor.  So go ahead and
406   ** allocate enough space, just in case.
407   */
408   iBaseCur = iDataCur = pParse->nTab++;
409   iIdxCur = iDataCur+1;
410   pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
411   testcase( pPk!=0 && pPk!=pTab->pIndex );
412   for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){
413     if( pPk==pIdx ){
414       iDataCur = pParse->nTab;
415     }
416     pParse->nTab++;
417   }
418   if( pUpsert ){
419     /* On an UPSERT, reuse the same cursors already opened by INSERT */
420     iDataCur = pUpsert->iDataCur;
421     iIdxCur = pUpsert->iIdxCur;
422     pParse->nTab = iBaseCur;
423   }
424   pTabList->a[0].iCursor = iDataCur;
425 
426   /* Allocate space for aXRef[], aRegIdx[], and aToOpen[].
427   ** Initialize aXRef[] and aToOpen[] to their default values.
428   */
429   aXRef = sqlite3DbMallocRawNN(db, sizeof(int) * (pTab->nCol+nIdx+1) + nIdx+2 );
430   if( aXRef==0 ) goto update_cleanup;
431   aRegIdx = aXRef+pTab->nCol;
432   aToOpen = (u8*)(aRegIdx+nIdx+1);
433   memset(aToOpen, 1, nIdx+1);
434   aToOpen[nIdx+1] = 0;
435   for(i=0; i<pTab->nCol; i++) aXRef[i] = -1;
436 
437   /* Initialize the name-context */
438   memset(&sNC, 0, sizeof(sNC));
439   sNC.pParse = pParse;
440   sNC.pSrcList = pTabList;
441   sNC.uNC.pUpsert = pUpsert;
442   sNC.ncFlags = NC_UUpsert;
443 
444   /* Begin generating code. */
445   v = sqlite3GetVdbe(pParse);
446   if( v==0 ) goto update_cleanup;
447 
448   /* Resolve the column names in all the expressions of the
449   ** of the UPDATE statement.  Also find the column index
450   ** for each column to be updated in the pChanges array.  For each
451   ** column to be updated, make sure we have authorization to change
452   ** that column.
453   */
454   chngRowid = chngPk = 0;
455   for(i=0; i<pChanges->nExpr; i++){
456     u8 hCol = sqlite3StrIHash(pChanges->a[i].zEName);
457     /* If this is an UPDATE with a FROM clause, do not resolve expressions
458     ** here. The call to sqlite3Select() below will do that. */
459     if( nChangeFrom==0 && sqlite3ResolveExprNames(&sNC, pChanges->a[i].pExpr) ){
460       goto update_cleanup;
461     }
462     for(j=0; j<pTab->nCol; j++){
463       if( pTab->aCol[j].hName==hCol
464        && sqlite3StrICmp(pTab->aCol[j].zCnName, pChanges->a[i].zEName)==0
465       ){
466         if( j==pTab->iPKey ){
467           chngRowid = 1;
468           pRowidExpr = pChanges->a[i].pExpr;
469           iRowidExpr = i;
470         }else if( pPk && (pTab->aCol[j].colFlags & COLFLAG_PRIMKEY)!=0 ){
471           chngPk = 1;
472         }
473 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
474         else if( pTab->aCol[j].colFlags & COLFLAG_GENERATED ){
475           testcase( pTab->aCol[j].colFlags & COLFLAG_VIRTUAL );
476           testcase( pTab->aCol[j].colFlags & COLFLAG_STORED );
477           sqlite3ErrorMsg(pParse,
478              "cannot UPDATE generated column \"%s\"",
479              pTab->aCol[j].zCnName);
480           goto update_cleanup;
481         }
482 #endif
483         aXRef[j] = i;
484         break;
485       }
486     }
487     if( j>=pTab->nCol ){
488       if( pPk==0 && sqlite3IsRowid(pChanges->a[i].zEName) ){
489         j = -1;
490         chngRowid = 1;
491         pRowidExpr = pChanges->a[i].pExpr;
492         iRowidExpr = i;
493       }else{
494         sqlite3ErrorMsg(pParse, "no such column: %s", pChanges->a[i].zEName);
495         pParse->checkSchema = 1;
496         goto update_cleanup;
497       }
498     }
499 #ifndef SQLITE_OMIT_AUTHORIZATION
500     {
501       int rc;
502       rc = sqlite3AuthCheck(pParse, SQLITE_UPDATE, pTab->zName,
503                             j<0 ? "ROWID" : pTab->aCol[j].zCnName,
504                             db->aDb[iDb].zDbSName);
505       if( rc==SQLITE_DENY ){
506         goto update_cleanup;
507       }else if( rc==SQLITE_IGNORE ){
508         aXRef[j] = -1;
509       }
510     }
511 #endif
512   }
513   assert( (chngRowid & chngPk)==0 );
514   assert( chngRowid==0 || chngRowid==1 );
515   assert( chngPk==0 || chngPk==1 );
516   chngKey = chngRowid + chngPk;
517 
518 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
519   /* Mark generated columns as changing if their generator expressions
520   ** reference any changing column.  The actual aXRef[] value for
521   ** generated expressions is not used, other than to check to see that it
522   ** is non-negative, so the value of aXRef[] for generated columns can be
523   ** set to any non-negative number.  We use 99999 so that the value is
524   ** obvious when looking at aXRef[] in a symbolic debugger.
525   */
526   if( pTab->tabFlags & TF_HasGenerated ){
527     int bProgress;
528     testcase( pTab->tabFlags & TF_HasVirtual );
529     testcase( pTab->tabFlags & TF_HasStored );
530     do{
531       bProgress = 0;
532       for(i=0; i<pTab->nCol; i++){
533         if( aXRef[i]>=0 ) continue;
534         if( (pTab->aCol[i].colFlags & COLFLAG_GENERATED)==0 ) continue;
535         if( sqlite3ExprReferencesUpdatedColumn(
536                 sqlite3ColumnExpr(pTab, &pTab->aCol[i]),
537                  aXRef, chngRowid)
538         ){
539           aXRef[i] = 99999;
540           bProgress = 1;
541         }
542       }
543     }while( bProgress );
544   }
545 #endif
546 
547   /* The SET expressions are not actually used inside the WHERE loop.
548   ** So reset the colUsed mask. Unless this is a virtual table. In that
549   ** case, set all bits of the colUsed mask (to ensure that the virtual
550   ** table implementation makes all columns available).
551   */
552   pTabList->a[0].colUsed = IsVirtual(pTab) ? ALLBITS : 0;
553 
554   hasFK = sqlite3FkRequired(pParse, pTab, aXRef, chngKey);
555 
556   /* There is one entry in the aRegIdx[] array for each index on the table
557   ** being updated.  Fill in aRegIdx[] with a register number that will hold
558   ** the key for accessing each index.
559   */
560   if( onError==OE_Replace ) bReplace = 1;
561   for(nAllIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nAllIdx++){
562     int reg;
563     if( chngKey || hasFK>1 || pIdx==pPk
564      || indexWhereClauseMightChange(pIdx,aXRef,chngRowid)
565     ){
566       reg = ++pParse->nMem;
567       pParse->nMem += pIdx->nColumn;
568     }else{
569       reg = 0;
570       for(i=0; i<pIdx->nKeyCol; i++){
571         if( indexColumnIsBeingUpdated(pIdx, i, aXRef, chngRowid) ){
572           reg = ++pParse->nMem;
573           pParse->nMem += pIdx->nColumn;
574           if( onError==OE_Default && pIdx->onError==OE_Replace ){
575             bReplace = 1;
576           }
577           break;
578         }
579       }
580     }
581     if( reg==0 ) aToOpen[nAllIdx+1] = 0;
582     aRegIdx[nAllIdx] = reg;
583   }
584   aRegIdx[nAllIdx] = ++pParse->nMem;  /* Register storing the table record */
585   if( bReplace ){
586     /* If REPLACE conflict resolution might be invoked, open cursors on all
587     ** indexes in case they are needed to delete records.  */
588     memset(aToOpen, 1, nIdx+1);
589   }
590 
591   if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
592   sqlite3BeginWriteOperation(pParse, pTrigger || hasFK, iDb);
593 
594   /* Allocate required registers. */
595   if( !IsVirtual(pTab) ){
596     /* For now, regRowSet and aRegIdx[nAllIdx] share the same register.
597     ** If regRowSet turns out to be needed, then aRegIdx[nAllIdx] will be
598     ** reallocated.  aRegIdx[nAllIdx] is the register in which the main
599     ** table record is written.  regRowSet holds the RowSet for the
600     ** two-pass update algorithm. */
601     assert( aRegIdx[nAllIdx]==pParse->nMem );
602     regRowSet = aRegIdx[nAllIdx];
603     regOldRowid = regNewRowid = ++pParse->nMem;
604     if( chngPk || pTrigger || hasFK ){
605       regOld = pParse->nMem + 1;
606       pParse->nMem += pTab->nCol;
607     }
608     if( chngKey || pTrigger || hasFK ){
609       regNewRowid = ++pParse->nMem;
610     }
611     regNew = pParse->nMem + 1;
612     pParse->nMem += pTab->nCol;
613   }
614 
615   /* Start the view context. */
616   if( isView ){
617     sqlite3AuthContextPush(pParse, &sContext, pTab->zName);
618   }
619 
620   /* If we are trying to update a view, realize that view into
621   ** an ephemeral table.
622   */
623 #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
624   if( nChangeFrom==0 && isView ){
625     sqlite3MaterializeView(pParse, pTab,
626         pWhere, pOrderBy, pLimit, iDataCur
627     );
628     pOrderBy = 0;
629     pLimit = 0;
630   }
631 #endif
632 
633   /* Resolve the column names in all the expressions in the
634   ** WHERE clause.
635   */
636   if( nChangeFrom==0 && sqlite3ResolveExprNames(&sNC, pWhere) ){
637     goto update_cleanup;
638   }
639 
640 #ifndef SQLITE_OMIT_VIRTUALTABLE
641   /* Virtual tables must be handled separately */
642   if( IsVirtual(pTab) ){
643     updateVirtualTable(pParse, pTabList, pTab, pChanges, pRowidExpr, aXRef,
644                        pWhere, onError);
645     goto update_cleanup;
646   }
647 #endif
648 
649   /* Jump to labelBreak to abandon further processing of this UPDATE */
650   labelContinue = labelBreak = sqlite3VdbeMakeLabel(pParse);
651 
652   /* Not an UPSERT.  Normal processing.  Begin by
653   ** initialize the count of updated rows */
654   if( (db->flags&SQLITE_CountRows)!=0
655    && !pParse->pTriggerTab
656    && !pParse->nested
657    && !pParse->bReturning
658    && pUpsert==0
659   ){
660     regRowCount = ++pParse->nMem;
661     sqlite3VdbeAddOp2(v, OP_Integer, 0, regRowCount);
662   }
663 
664   if( nChangeFrom==0 && HasRowid(pTab) ){
665     sqlite3VdbeAddOp3(v, OP_Null, 0, regRowSet, regOldRowid);
666     iEph = pParse->nTab++;
667     addrOpen = sqlite3VdbeAddOp3(v, OP_OpenEphemeral, iEph, 0, regRowSet);
668   }else{
669     assert( pPk!=0 || HasRowid(pTab) );
670     nPk = pPk ? pPk->nKeyCol : 0;
671     iPk = pParse->nMem+1;
672     pParse->nMem += nPk;
673     pParse->nMem += nChangeFrom;
674     regKey = ++pParse->nMem;
675     if( pUpsert==0 ){
676       int nEphCol = nPk + nChangeFrom + (isView ? pTab->nCol : 0);
677       iEph = pParse->nTab++;
678       if( pPk ) sqlite3VdbeAddOp3(v, OP_Null, 0, iPk, iPk+nPk-1);
679       addrOpen = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iEph, nEphCol);
680       if( pPk ){
681         KeyInfo *pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pPk);
682         if( pKeyInfo ){
683           pKeyInfo->nAllField = nEphCol;
684           sqlite3VdbeAppendP4(v, pKeyInfo, P4_KEYINFO);
685         }
686       }
687       if( nChangeFrom ){
688         updateFromSelect(
689             pParse, iEph, pPk, pChanges, pTabList, pWhere, pOrderBy, pLimit
690         );
691 #ifndef SQLITE_OMIT_SUBQUERY
692         if( isView ) iDataCur = iEph;
693 #endif
694       }
695     }
696   }
697 
698   if( nChangeFrom ){
699     sqlite3MultiWrite(pParse);
700     eOnePass = ONEPASS_OFF;
701     nKey = nPk;
702     regKey = iPk;
703   }else{
704     if( pUpsert ){
705       /* If this is an UPSERT, then all cursors have already been opened by
706       ** the outer INSERT and the data cursor should be pointing at the row
707       ** that is to be updated.  So bypass the code that searches for the
708       ** row(s) to be updated.
709       */
710       pWInfo = 0;
711       eOnePass = ONEPASS_SINGLE;
712       sqlite3ExprIfFalse(pParse, pWhere, labelBreak, SQLITE_JUMPIFNULL);
713       bFinishSeek = 0;
714     }else{
715       /* Begin the database scan.
716       **
717       ** Do not consider a single-pass strategy for a multi-row update if
718       ** there are any triggers or foreign keys to process, or rows may
719       ** be deleted as a result of REPLACE conflict handling. Any of these
720       ** things might disturb a cursor being used to scan through the table
721       ** or index, causing a single-pass approach to malfunction.  */
722       flags = WHERE_ONEPASS_DESIRED;
723       if( !pParse->nested && !pTrigger && !hasFK && !chngKey && !bReplace ){
724         flags |= WHERE_ONEPASS_MULTIROW;
725       }
726       pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere,0,0,0,flags,iIdxCur);
727       if( pWInfo==0 ) goto update_cleanup;
728 
729       /* A one-pass strategy that might update more than one row may not
730       ** be used if any column of the index used for the scan is being
731       ** updated. Otherwise, if there is an index on "b", statements like
732       ** the following could create an infinite loop:
733       **
734       **   UPDATE t1 SET b=b+1 WHERE b>?
735       **
736       ** Fall back to ONEPASS_OFF if where.c has selected a ONEPASS_MULTI
737       ** strategy that uses an index for which one or more columns are being
738       ** updated.  */
739       eOnePass = sqlite3WhereOkOnePass(pWInfo, aiCurOnePass);
740       bFinishSeek = sqlite3WhereUsesDeferredSeek(pWInfo);
741       if( eOnePass!=ONEPASS_SINGLE ){
742         sqlite3MultiWrite(pParse);
743         if( eOnePass==ONEPASS_MULTI ){
744           int iCur = aiCurOnePass[1];
745           if( iCur>=0 && iCur!=iDataCur && aToOpen[iCur-iBaseCur] ){
746             eOnePass = ONEPASS_OFF;
747           }
748           assert( iCur!=iDataCur || !HasRowid(pTab) );
749         }
750       }
751     }
752 
753     if( HasRowid(pTab) ){
754       /* Read the rowid of the current row of the WHERE scan. In ONEPASS_OFF
755       ** mode, write the rowid into the FIFO. In either of the one-pass modes,
756       ** leave it in register regOldRowid.  */
757       sqlite3VdbeAddOp2(v, OP_Rowid, iDataCur, regOldRowid);
758       if( eOnePass==ONEPASS_OFF ){
759         aRegIdx[nAllIdx] = ++pParse->nMem;
760         sqlite3VdbeAddOp3(v, OP_Insert, iEph, regRowSet, regOldRowid);
761       }else{
762         if( ALWAYS(addrOpen) ) sqlite3VdbeChangeToNoop(v, addrOpen);
763       }
764     }else{
765       /* Read the PK of the current row into an array of registers. In
766       ** ONEPASS_OFF mode, serialize the array into a record and store it in
767       ** the ephemeral table. Or, in ONEPASS_SINGLE or MULTI mode, change
768       ** the OP_OpenEphemeral instruction to a Noop (the ephemeral table
769       ** is not required) and leave the PK fields in the array of registers.  */
770       for(i=0; i<nPk; i++){
771         assert( pPk->aiColumn[i]>=0 );
772         sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur,
773                                         pPk->aiColumn[i], iPk+i);
774       }
775       if( eOnePass ){
776         if( addrOpen ) sqlite3VdbeChangeToNoop(v, addrOpen);
777         nKey = nPk;
778         regKey = iPk;
779       }else{
780         sqlite3VdbeAddOp4(v, OP_MakeRecord, iPk, nPk, regKey,
781                           sqlite3IndexAffinityStr(db, pPk), nPk);
782         sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iEph, regKey, iPk, nPk);
783       }
784     }
785   }
786 
787   if( pUpsert==0 ){
788     if( nChangeFrom==0 && eOnePass!=ONEPASS_MULTI ){
789       sqlite3WhereEnd(pWInfo);
790     }
791 
792     if( !isView ){
793       int addrOnce = 0;
794 
795       /* Open every index that needs updating. */
796       if( eOnePass!=ONEPASS_OFF ){
797         if( aiCurOnePass[0]>=0 ) aToOpen[aiCurOnePass[0]-iBaseCur] = 0;
798         if( aiCurOnePass[1]>=0 ) aToOpen[aiCurOnePass[1]-iBaseCur] = 0;
799       }
800 
801       if( eOnePass==ONEPASS_MULTI && (nIdx-(aiCurOnePass[1]>=0))>0 ){
802         addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
803       }
804       sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, 0, iBaseCur,
805                                  aToOpen, 0, 0);
806       if( addrOnce ){
807         sqlite3VdbeJumpHereOrPopInst(v, addrOnce);
808       }
809     }
810 
811     /* Top of the update loop */
812     if( eOnePass!=ONEPASS_OFF ){
813       if( aiCurOnePass[0]!=iDataCur
814        && aiCurOnePass[1]!=iDataCur
815 #ifdef SQLITE_ALLOW_ROWID_IN_VIEW
816        && !isView
817 #endif
818       ){
819         assert( pPk );
820         sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelBreak, regKey,nKey);
821         VdbeCoverage(v);
822       }
823       if( eOnePass!=ONEPASS_SINGLE ){
824         labelContinue = sqlite3VdbeMakeLabel(pParse);
825       }
826       sqlite3VdbeAddOp2(v, OP_IsNull, pPk ? regKey : regOldRowid, labelBreak);
827       VdbeCoverageIf(v, pPk==0);
828       VdbeCoverageIf(v, pPk!=0);
829     }else if( pPk || nChangeFrom ){
830       labelContinue = sqlite3VdbeMakeLabel(pParse);
831       sqlite3VdbeAddOp2(v, OP_Rewind, iEph, labelBreak); VdbeCoverage(v);
832       addrTop = sqlite3VdbeCurrentAddr(v);
833       if( nChangeFrom ){
834         if( !isView ){
835           if( pPk ){
836             for(i=0; i<nPk; i++){
837               sqlite3VdbeAddOp3(v, OP_Column, iEph, i, iPk+i);
838             }
839             sqlite3VdbeAddOp4Int(
840                 v, OP_NotFound, iDataCur, labelContinue, iPk, nPk
841             ); VdbeCoverage(v);
842           }else{
843             sqlite3VdbeAddOp2(v, OP_Rowid, iEph, regOldRowid);
844             sqlite3VdbeAddOp3(
845                 v, OP_NotExists, iDataCur, labelContinue, regOldRowid
846             ); VdbeCoverage(v);
847           }
848         }
849       }else{
850         sqlite3VdbeAddOp2(v, OP_RowData, iEph, regKey);
851         sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelContinue, regKey,0);
852         VdbeCoverage(v);
853       }
854     }else{
855       sqlite3VdbeAddOp2(v, OP_Rewind, iEph, labelBreak); VdbeCoverage(v);
856       labelContinue = sqlite3VdbeMakeLabel(pParse);
857       addrTop = sqlite3VdbeAddOp2(v, OP_Rowid, iEph, regOldRowid);
858       VdbeCoverage(v);
859       sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, labelContinue, regOldRowid);
860       VdbeCoverage(v);
861     }
862   }
863 
864   /* If the rowid value will change, set register regNewRowid to
865   ** contain the new value. If the rowid is not being modified,
866   ** then regNewRowid is the same register as regOldRowid, which is
867   ** already populated.  */
868   assert( chngKey || pTrigger || hasFK || regOldRowid==regNewRowid );
869   if( chngRowid ){
870     assert( iRowidExpr>=0 );
871     if( nChangeFrom==0 ){
872       sqlite3ExprCode(pParse, pRowidExpr, regNewRowid);
873     }else{
874       sqlite3VdbeAddOp3(v, OP_Column, iEph, iRowidExpr, regNewRowid);
875     }
876     sqlite3VdbeAddOp1(v, OP_MustBeInt, regNewRowid); VdbeCoverage(v);
877   }
878 
879   /* Compute the old pre-UPDATE content of the row being changed, if that
880   ** information is needed */
881   if( chngPk || hasFK || pTrigger ){
882     u32 oldmask = (hasFK ? sqlite3FkOldmask(pParse, pTab) : 0);
883     oldmask |= sqlite3TriggerColmask(pParse,
884         pTrigger, pChanges, 0, TRIGGER_BEFORE|TRIGGER_AFTER, pTab, onError
885     );
886     for(i=0; i<pTab->nCol; i++){
887       u32 colFlags = pTab->aCol[i].colFlags;
888       k = sqlite3TableColumnToStorage(pTab, i) + regOld;
889       if( oldmask==0xffffffff
890        || (i<32 && (oldmask & MASKBIT32(i))!=0)
891        || (colFlags & COLFLAG_PRIMKEY)!=0
892       ){
893         testcase(  oldmask!=0xffffffff && i==31 );
894         sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, i, k);
895       }else{
896         sqlite3VdbeAddOp2(v, OP_Null, 0, k);
897       }
898     }
899     if( chngRowid==0 && pPk==0 ){
900       sqlite3VdbeAddOp2(v, OP_Copy, regOldRowid, regNewRowid);
901     }
902   }
903 
904   /* Populate the array of registers beginning at regNew with the new
905   ** row data. This array is used to check constants, create the new
906   ** table and index records, and as the values for any new.* references
907   ** made by triggers.
908   **
909   ** If there are one or more BEFORE triggers, then do not populate the
910   ** registers associated with columns that are (a) not modified by
911   ** this UPDATE statement and (b) not accessed by new.* references. The
912   ** values for registers not modified by the UPDATE must be reloaded from
913   ** the database after the BEFORE triggers are fired anyway (as the trigger
914   ** may have modified them). So not loading those that are not going to
915   ** be used eliminates some redundant opcodes.
916   */
917   newmask = sqlite3TriggerColmask(
918       pParse, pTrigger, pChanges, 1, TRIGGER_BEFORE, pTab, onError
919   );
920   for(i=0, k=regNew; i<pTab->nCol; i++, k++){
921     if( i==pTab->iPKey ){
922       sqlite3VdbeAddOp2(v, OP_Null, 0, k);
923     }else if( (pTab->aCol[i].colFlags & COLFLAG_GENERATED)!=0 ){
924       if( pTab->aCol[i].colFlags & COLFLAG_VIRTUAL ) k--;
925     }else{
926       j = aXRef[i];
927       if( j>=0 ){
928         if( nChangeFrom ){
929           int nOff = (isView ? pTab->nCol : nPk);
930           assert( eOnePass==ONEPASS_OFF );
931           sqlite3VdbeAddOp3(v, OP_Column, iEph, nOff+j, k);
932         }else{
933           sqlite3ExprCode(pParse, pChanges->a[j].pExpr, k);
934         }
935       }else if( 0==(tmask&TRIGGER_BEFORE) || i>31 || (newmask & MASKBIT32(i)) ){
936         /* This branch loads the value of a column that will not be changed
937         ** into a register. This is done if there are no BEFORE triggers, or
938         ** if there are one or more BEFORE triggers that use this value via
939         ** a new.* reference in a trigger program.
940         */
941         testcase( i==31 );
942         testcase( i==32 );
943         sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, i, k);
944         bFinishSeek = 0;
945       }else{
946         sqlite3VdbeAddOp2(v, OP_Null, 0, k);
947       }
948     }
949   }
950 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
951   if( pTab->tabFlags & TF_HasGenerated ){
952     testcase( pTab->tabFlags & TF_HasVirtual );
953     testcase( pTab->tabFlags & TF_HasStored );
954     sqlite3ComputeGeneratedColumns(pParse, regNew, pTab);
955   }
956 #endif
957 
958   /* Fire any BEFORE UPDATE triggers. This happens before constraints are
959   ** verified. One could argue that this is wrong.
960   */
961   if( tmask&TRIGGER_BEFORE ){
962     sqlite3TableAffinity(v, pTab, regNew);
963     sqlite3CodeRowTrigger(pParse, pTrigger, TK_UPDATE, pChanges,
964         TRIGGER_BEFORE, pTab, regOldRowid, onError, labelContinue);
965 
966     if( !isView ){
967       /* The row-trigger may have deleted the row being updated. In this
968       ** case, jump to the next row. No updates or AFTER triggers are
969       ** required. This behavior - what happens when the row being updated
970       ** is deleted or renamed by a BEFORE trigger - is left undefined in the
971       ** documentation.
972       */
973       if( pPk ){
974         sqlite3VdbeAddOp4Int(v, OP_NotFound,iDataCur,labelContinue,regKey,nKey);
975         VdbeCoverage(v);
976       }else{
977         sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, labelContinue,regOldRowid);
978         VdbeCoverage(v);
979       }
980 
981       /* After-BEFORE-trigger-reload-loop:
982       ** If it did not delete it, the BEFORE trigger may still have modified
983       ** some of the columns of the row being updated. Load the values for
984       ** all columns not modified by the update statement into their registers
985       ** in case this has happened. Only unmodified columns are reloaded.
986       ** The values computed for modified columns use the values before the
987       ** BEFORE trigger runs.  See test case trigger1-18.0 (added 2018-04-26)
988       ** for an example.
989       */
990       for(i=0, k=regNew; i<pTab->nCol; i++, k++){
991         if( pTab->aCol[i].colFlags & COLFLAG_GENERATED ){
992           if( pTab->aCol[i].colFlags & COLFLAG_VIRTUAL ) k--;
993         }else if( aXRef[i]<0 && i!=pTab->iPKey ){
994           sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, i, k);
995         }
996       }
997 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
998       if( pTab->tabFlags & TF_HasGenerated ){
999         testcase( pTab->tabFlags & TF_HasVirtual );
1000         testcase( pTab->tabFlags & TF_HasStored );
1001         sqlite3ComputeGeneratedColumns(pParse, regNew, pTab);
1002       }
1003 #endif
1004     }
1005   }
1006 
1007   if( !isView ){
1008     /* Do constraint checks. */
1009     assert( regOldRowid>0 );
1010     sqlite3GenerateConstraintChecks(pParse, pTab, aRegIdx, iDataCur, iIdxCur,
1011         regNewRowid, regOldRowid, chngKey, onError, labelContinue, &bReplace,
1012         aXRef, 0);
1013 
1014     /* If REPLACE conflict handling may have been used, or if the PK of the
1015     ** row is changing, then the GenerateConstraintChecks() above may have
1016     ** moved cursor iDataCur. Reseek it. */
1017     if( bReplace || chngKey ){
1018       if( pPk ){
1019         sqlite3VdbeAddOp4Int(v, OP_NotFound,iDataCur,labelContinue,regKey,nKey);
1020       }else{
1021         sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, labelContinue,regOldRowid);
1022       }
1023       VdbeCoverageNeverTaken(v);
1024     }
1025 
1026     /* Do FK constraint checks. */
1027     if( hasFK ){
1028       sqlite3FkCheck(pParse, pTab, regOldRowid, 0, aXRef, chngKey);
1029     }
1030 
1031     /* Delete the index entries associated with the current record.  */
1032     sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur, aRegIdx, -1);
1033 
1034     /* We must run the OP_FinishSeek opcode to resolve a prior
1035     ** OP_DeferredSeek if there is any possibility that there have been
1036     ** no OP_Column opcodes since the OP_DeferredSeek was issued.  But
1037     ** we want to avoid the OP_FinishSeek if possible, as running it
1038     ** costs CPU cycles. */
1039     if( bFinishSeek ){
1040       sqlite3VdbeAddOp1(v, OP_FinishSeek, iDataCur);
1041     }
1042 
1043     /* If changing the rowid value, or if there are foreign key constraints
1044     ** to process, delete the old record. Otherwise, add a noop OP_Delete
1045     ** to invoke the pre-update hook.
1046     **
1047     ** That (regNew==regnewRowid+1) is true is also important for the
1048     ** pre-update hook. If the caller invokes preupdate_new(), the returned
1049     ** value is copied from memory cell (regNewRowid+1+iCol), where iCol
1050     ** is the column index supplied by the user.
1051     */
1052     assert( regNew==regNewRowid+1 );
1053 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1054     sqlite3VdbeAddOp3(v, OP_Delete, iDataCur,
1055         OPFLAG_ISUPDATE | ((hasFK>1 || chngKey) ? 0 : OPFLAG_ISNOOP),
1056         regNewRowid
1057     );
1058     if( eOnePass==ONEPASS_MULTI ){
1059       assert( hasFK==0 && chngKey==0 );
1060       sqlite3VdbeChangeP5(v, OPFLAG_SAVEPOSITION);
1061     }
1062     if( !pParse->nested ){
1063       sqlite3VdbeAppendP4(v, pTab, P4_TABLE);
1064     }
1065 #else
1066     if( hasFK>1 || chngKey ){
1067       sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, 0);
1068     }
1069 #endif
1070 
1071     if( hasFK ){
1072       sqlite3FkCheck(pParse, pTab, 0, regNewRowid, aXRef, chngKey);
1073     }
1074 
1075     /* Insert the new index entries and the new record. */
1076     sqlite3CompleteInsertion(
1077         pParse, pTab, iDataCur, iIdxCur, regNewRowid, aRegIdx,
1078         OPFLAG_ISUPDATE | (eOnePass==ONEPASS_MULTI ? OPFLAG_SAVEPOSITION : 0),
1079         0, 0
1080     );
1081 
1082     /* Do any ON CASCADE, SET NULL or SET DEFAULT operations required to
1083     ** handle rows (possibly in other tables) that refer via a foreign key
1084     ** to the row just updated. */
1085     if( hasFK ){
1086       sqlite3FkActions(pParse, pTab, pChanges, regOldRowid, aXRef, chngKey);
1087     }
1088   }
1089 
1090   /* Increment the row counter
1091   */
1092   if( regRowCount ){
1093     sqlite3VdbeAddOp2(v, OP_AddImm, regRowCount, 1);
1094   }
1095 
1096   sqlite3CodeRowTrigger(pParse, pTrigger, TK_UPDATE, pChanges,
1097       TRIGGER_AFTER, pTab, regOldRowid, onError, labelContinue);
1098 
1099   /* Repeat the above with the next record to be updated, until
1100   ** all record selected by the WHERE clause have been updated.
1101   */
1102   if( eOnePass==ONEPASS_SINGLE ){
1103     /* Nothing to do at end-of-loop for a single-pass */
1104   }else if( eOnePass==ONEPASS_MULTI ){
1105     sqlite3VdbeResolveLabel(v, labelContinue);
1106     sqlite3WhereEnd(pWInfo);
1107   }else{
1108     sqlite3VdbeResolveLabel(v, labelContinue);
1109     sqlite3VdbeAddOp2(v, OP_Next, iEph, addrTop); VdbeCoverage(v);
1110   }
1111   sqlite3VdbeResolveLabel(v, labelBreak);
1112 
1113   /* Update the sqlite_sequence table by storing the content of the
1114   ** maximum rowid counter values recorded while inserting into
1115   ** autoincrement tables.
1116   */
1117   if( pParse->nested==0 && pParse->pTriggerTab==0 && pUpsert==0 ){
1118     sqlite3AutoincrementEnd(pParse);
1119   }
1120 
1121   /*
1122   ** Return the number of rows that were changed, if we are tracking
1123   ** that information.
1124   */
1125   if( regRowCount ){
1126     sqlite3CodeChangeCount(v, regRowCount, "rows updated");
1127   }
1128 
1129 update_cleanup:
1130   sqlite3AuthContextPop(&sContext);
1131   sqlite3DbFree(db, aXRef); /* Also frees aRegIdx[] and aToOpen[] */
1132   sqlite3SrcListDelete(db, pTabList);
1133   sqlite3ExprListDelete(db, pChanges);
1134   sqlite3ExprDelete(db, pWhere);
1135 #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT)
1136   sqlite3ExprListDelete(db, pOrderBy);
1137   sqlite3ExprDelete(db, pLimit);
1138 #endif
1139   return;
1140 }
1141 /* Make sure "isView" and other macros defined above are undefined. Otherwise
1142 ** they may interfere with compilation of other functions in this file
1143 ** (or in another file, if this file becomes part of the amalgamation).  */
1144 #ifdef isView
1145  #undef isView
1146 #endif
1147 #ifdef pTrigger
1148  #undef pTrigger
1149 #endif
1150 
1151 #ifndef SQLITE_OMIT_VIRTUALTABLE
1152 /*
1153 ** Generate code for an UPDATE of a virtual table.
1154 **
1155 ** There are two possible strategies - the default and the special
1156 ** "onepass" strategy. Onepass is only used if the virtual table
1157 ** implementation indicates that pWhere may match at most one row.
1158 **
1159 ** The default strategy is to create an ephemeral table that contains
1160 ** for each row to be changed:
1161 **
1162 **   (A)  The original rowid of that row.
1163 **   (B)  The revised rowid for the row.
1164 **   (C)  The content of every column in the row.
1165 **
1166 ** Then loop through the contents of this ephemeral table executing a
1167 ** VUpdate for each row. When finished, drop the ephemeral table.
1168 **
1169 ** The "onepass" strategy does not use an ephemeral table. Instead, it
1170 ** stores the same values (A, B and C above) in a register array and
1171 ** makes a single invocation of VUpdate.
1172 */
1173 static void updateVirtualTable(
1174   Parse *pParse,       /* The parsing context */
1175   SrcList *pSrc,       /* The virtual table to be modified */
1176   Table *pTab,         /* The virtual table */
1177   ExprList *pChanges,  /* The columns to change in the UPDATE statement */
1178   Expr *pRowid,        /* Expression used to recompute the rowid */
1179   int *aXRef,          /* Mapping from columns of pTab to entries in pChanges */
1180   Expr *pWhere,        /* WHERE clause of the UPDATE statement */
1181   int onError          /* ON CONFLICT strategy */
1182 ){
1183   Vdbe *v = pParse->pVdbe;  /* Virtual machine under construction */
1184   int ephemTab;             /* Table holding the result of the SELECT */
1185   int i;                    /* Loop counter */
1186   sqlite3 *db = pParse->db; /* Database connection */
1187   const char *pVTab = (const char*)sqlite3GetVTable(db, pTab);
1188   WhereInfo *pWInfo = 0;
1189   int nArg = 2 + pTab->nCol;      /* Number of arguments to VUpdate */
1190   int regArg;                     /* First register in VUpdate arg array */
1191   int regRec;                     /* Register in which to assemble record */
1192   int regRowid;                   /* Register for ephem table rowid */
1193   int iCsr = pSrc->a[0].iCursor;  /* Cursor used for virtual table scan */
1194   int aDummy[2];                  /* Unused arg for sqlite3WhereOkOnePass() */
1195   int eOnePass;                   /* True to use onepass strategy */
1196   int addr;                       /* Address of OP_OpenEphemeral */
1197 
1198   /* Allocate nArg registers in which to gather the arguments for VUpdate. Then
1199   ** create and open the ephemeral table in which the records created from
1200   ** these arguments will be temporarily stored. */
1201   assert( v );
1202   ephemTab = pParse->nTab++;
1203   addr= sqlite3VdbeAddOp2(v, OP_OpenEphemeral, ephemTab, nArg);
1204   regArg = pParse->nMem + 1;
1205   pParse->nMem += nArg;
1206   if( pSrc->nSrc>1 ){
1207     Index *pPk = 0;
1208     Expr *pRow;
1209     ExprList *pList;
1210     if( HasRowid(pTab) ){
1211       if( pRowid ){
1212         pRow = sqlite3ExprDup(db, pRowid, 0);
1213       }else{
1214         pRow = sqlite3PExpr(pParse, TK_ROW, 0, 0);
1215       }
1216     }else{
1217       i16 iPk;      /* PRIMARY KEY column */
1218       pPk = sqlite3PrimaryKeyIndex(pTab);
1219       assert( pPk!=0 );
1220       assert( pPk->nKeyCol==1 );
1221       iPk = pPk->aiColumn[0];
1222       if( aXRef[iPk]>=0 ){
1223         pRow = sqlite3ExprDup(db, pChanges->a[aXRef[iPk]].pExpr, 0);
1224       }else{
1225         pRow = exprRowColumn(pParse, iPk);
1226       }
1227     }
1228     pList = sqlite3ExprListAppend(pParse, 0, pRow);
1229 
1230     for(i=0; i<pTab->nCol; i++){
1231       if( aXRef[i]>=0 ){
1232         pList = sqlite3ExprListAppend(pParse, pList,
1233           sqlite3ExprDup(db, pChanges->a[aXRef[i]].pExpr, 0)
1234         );
1235       }else{
1236         pList = sqlite3ExprListAppend(pParse, pList, exprRowColumn(pParse, i));
1237       }
1238     }
1239 
1240     updateFromSelect(pParse, ephemTab, pPk, pList, pSrc, pWhere, 0, 0);
1241     sqlite3ExprListDelete(db, pList);
1242     eOnePass = ONEPASS_OFF;
1243   }else{
1244     regRec = ++pParse->nMem;
1245     regRowid = ++pParse->nMem;
1246 
1247     /* Start scanning the virtual table */
1248     pWInfo = sqlite3WhereBegin(
1249         pParse, pSrc, pWhere, 0, 0, 0, WHERE_ONEPASS_DESIRED, 0
1250     );
1251     if( pWInfo==0 ) return;
1252 
1253     /* Populate the argument registers. */
1254     for(i=0; i<pTab->nCol; i++){
1255       assert( (pTab->aCol[i].colFlags & COLFLAG_GENERATED)==0 );
1256       if( aXRef[i]>=0 ){
1257         sqlite3ExprCode(pParse, pChanges->a[aXRef[i]].pExpr, regArg+2+i);
1258       }else{
1259         sqlite3VdbeAddOp3(v, OP_VColumn, iCsr, i, regArg+2+i);
1260         sqlite3VdbeChangeP5(v, OPFLAG_NOCHNG);/* For sqlite3_vtab_nochange() */
1261       }
1262     }
1263     if( HasRowid(pTab) ){
1264       sqlite3VdbeAddOp2(v, OP_Rowid, iCsr, regArg);
1265       if( pRowid ){
1266         sqlite3ExprCode(pParse, pRowid, regArg+1);
1267       }else{
1268         sqlite3VdbeAddOp2(v, OP_Rowid, iCsr, regArg+1);
1269       }
1270     }else{
1271       Index *pPk;   /* PRIMARY KEY index */
1272       i16 iPk;      /* PRIMARY KEY column */
1273       pPk = sqlite3PrimaryKeyIndex(pTab);
1274       assert( pPk!=0 );
1275       assert( pPk->nKeyCol==1 );
1276       iPk = pPk->aiColumn[0];
1277       sqlite3VdbeAddOp3(v, OP_VColumn, iCsr, iPk, regArg);
1278       sqlite3VdbeAddOp2(v, OP_SCopy, regArg+2+iPk, regArg+1);
1279     }
1280 
1281     eOnePass = sqlite3WhereOkOnePass(pWInfo, aDummy);
1282 
1283     /* There is no ONEPASS_MULTI on virtual tables */
1284     assert( eOnePass==ONEPASS_OFF || eOnePass==ONEPASS_SINGLE );
1285 
1286     if( eOnePass ){
1287       /* If using the onepass strategy, no-op out the OP_OpenEphemeral coded
1288       ** above. */
1289       sqlite3VdbeChangeToNoop(v, addr);
1290       sqlite3VdbeAddOp1(v, OP_Close, iCsr);
1291     }else{
1292       /* Create a record from the argument register contents and insert it into
1293       ** the ephemeral table. */
1294       sqlite3MultiWrite(pParse);
1295       sqlite3VdbeAddOp3(v, OP_MakeRecord, regArg, nArg, regRec);
1296 #if defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_NULL_TRIM)
1297       /* Signal an assert() within OP_MakeRecord that it is allowed to
1298       ** accept no-change records with serial_type 10 */
1299       sqlite3VdbeChangeP5(v, OPFLAG_NOCHNG_MAGIC);
1300 #endif
1301       sqlite3VdbeAddOp2(v, OP_NewRowid, ephemTab, regRowid);
1302       sqlite3VdbeAddOp3(v, OP_Insert, ephemTab, regRec, regRowid);
1303     }
1304   }
1305 
1306 
1307   if( eOnePass==ONEPASS_OFF ){
1308     /* End the virtual table scan */
1309     if( pSrc->nSrc==1 ){
1310       sqlite3WhereEnd(pWInfo);
1311     }
1312 
1313     /* Begin scannning through the ephemeral table. */
1314     addr = sqlite3VdbeAddOp1(v, OP_Rewind, ephemTab); VdbeCoverage(v);
1315 
1316     /* Extract arguments from the current row of the ephemeral table and
1317     ** invoke the VUpdate method.  */
1318     for(i=0; i<nArg; i++){
1319       sqlite3VdbeAddOp3(v, OP_Column, ephemTab, i, regArg+i);
1320     }
1321   }
1322   sqlite3VtabMakeWritable(pParse, pTab);
1323   sqlite3VdbeAddOp4(v, OP_VUpdate, 0, nArg, regArg, pVTab, P4_VTAB);
1324   sqlite3VdbeChangeP5(v, onError==OE_Default ? OE_Abort : onError);
1325   sqlite3MayAbort(pParse);
1326 
1327   /* End of the ephemeral table scan. Or, if using the onepass strategy,
1328   ** jump to here if the scan visited zero rows. */
1329   if( eOnePass==ONEPASS_OFF ){
1330     sqlite3VdbeAddOp2(v, OP_Next, ephemTab, addr+1); VdbeCoverage(v);
1331     sqlite3VdbeJumpHere(v, addr);
1332     sqlite3VdbeAddOp2(v, OP_Close, ephemTab, 0);
1333   }else{
1334     sqlite3WhereEnd(pWInfo);
1335   }
1336 }
1337 #endif /* SQLITE_OMIT_VIRTUALTABLE */
1338