xref: /sqlite-3.40.0/src/update.c (revision a3fdec71)
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_master 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 parameter iReg is not negative, code an OP_RealAffinity instruction
57 ** on register iReg. This is used when an equivalent integer value is
58 ** stored in place of an 8-byte floating point value in order to save
59 ** space.
60 */
61 void sqlite3ColumnDefault(Vdbe *v, Table *pTab, int i, int iReg){
62   assert( pTab!=0 );
63   if( !pTab->pSelect ){
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->zName));
68     assert( i<pTab->nCol );
69     sqlite3ValueFromExpr(sqlite3VdbeDb(v), pCol->pDflt, enc,
70                          pCol->affinity, &pValue);
71     if( pValue ){
72       sqlite3VdbeChangeP4(v, -1, (const char *)pValue, P4_MEM);
73     }
74 #ifndef SQLITE_OMIT_FLOATING_POINT
75     if( pTab->aCol[i].affinity==SQLITE_AFF_REAL ){
76       sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
77     }
78 #endif
79   }
80 }
81 
82 /*
83 ** Process an UPDATE statement.
84 **
85 **   UPDATE OR IGNORE table_wxyz SET a=b, c=d WHERE e<5 AND f NOT NULL;
86 **          \_______/ \________/     \______/       \________________/
87 *            onError   pTabList      pChanges             pWhere
88 */
89 void sqlite3Update(
90   Parse *pParse,         /* The parser context */
91   SrcList *pTabList,     /* The table in which we should change things */
92   ExprList *pChanges,    /* Things to be changed */
93   Expr *pWhere,          /* The WHERE clause.  May be null */
94   int onError            /* How to handle constraint errors */
95 ){
96   int i, j;              /* Loop counters */
97   Table *pTab;           /* The table to be updated */
98   int addrTop = 0;       /* VDBE instruction address of the start of the loop */
99   WhereInfo *pWInfo;     /* Information about the WHERE clause */
100   Vdbe *v;               /* The virtual database engine */
101   Index *pIdx;           /* For looping over indices */
102   Index *pPk;            /* The PRIMARY KEY index for WITHOUT ROWID tables */
103   int nIdx;              /* Number of indices that need updating */
104   int iBaseCur;          /* Base cursor number */
105   int iDataCur;          /* Cursor for the canonical data btree */
106   int iIdxCur;           /* Cursor for the first index */
107   sqlite3 *db;           /* The database structure */
108   int *aRegIdx = 0;      /* One register assigned to each index to be updated */
109   int *aXRef = 0;        /* aXRef[i] is the index in pChanges->a[] of the
110                          ** an expression for the i-th column of the table.
111                          ** aXRef[i]==-1 if the i-th column is not changed. */
112   u8 *aToOpen;           /* 1 for tables and indices to be opened */
113   u8 chngPk;             /* PRIMARY KEY changed in a WITHOUT ROWID table */
114   u8 chngRowid;          /* Rowid changed in a normal table */
115   u8 chngKey;            /* Either chngPk or chngRowid */
116   Expr *pRowidExpr = 0;  /* Expression defining the new record number */
117   AuthContext sContext;  /* The authorization context */
118   NameContext sNC;       /* The name-context to resolve expressions in */
119   int iDb;               /* Database containing the table being updated */
120   int okOnePass;         /* True for one-pass algorithm without the FIFO */
121   int hasFK;             /* True if foreign key processing is required */
122   int labelBreak;        /* Jump here to break out of UPDATE loop */
123   int labelContinue;     /* Jump here to continue next step of UPDATE loop */
124 
125 #ifndef SQLITE_OMIT_TRIGGER
126   int isView;            /* True when updating a view (INSTEAD OF trigger) */
127   Trigger *pTrigger;     /* List of triggers on pTab, if required */
128   int tmask;             /* Mask of TRIGGER_BEFORE|TRIGGER_AFTER */
129 #endif
130   int newmask;           /* Mask of NEW.* columns accessed by BEFORE triggers */
131   int iEph = 0;          /* Ephemeral table holding all primary key values */
132   int nKey = 0;          /* Number of elements in regKey for WITHOUT ROWID */
133   int aiCurOnePass[2];   /* The write cursors opened by WHERE_ONEPASS */
134 
135   /* Register Allocations */
136   int regRowCount = 0;   /* A count of rows changed */
137   int regOldRowid;       /* The old rowid */
138   int regNewRowid;       /* The new rowid */
139   int regNew;            /* Content of the NEW.* table in triggers */
140   int regOld = 0;        /* Content of OLD.* table in triggers */
141   int regRowSet = 0;     /* Rowset of rows to be updated */
142   int regKey = 0;        /* composite PRIMARY KEY value */
143 
144   memset(&sContext, 0, sizeof(sContext));
145   db = pParse->db;
146   if( pParse->nErr || db->mallocFailed ){
147     goto update_cleanup;
148   }
149   assert( pTabList->nSrc==1 );
150 
151   /* Locate the table which we want to update.
152   */
153   pTab = sqlite3SrcListLookup(pParse, pTabList);
154   if( pTab==0 ) goto update_cleanup;
155   iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
156 
157   /* Figure out if we have any triggers and if the table being
158   ** updated is a view.
159   */
160 #ifndef SQLITE_OMIT_TRIGGER
161   pTrigger = sqlite3TriggersExist(pParse, pTab, TK_UPDATE, pChanges, &tmask);
162   isView = pTab->pSelect!=0;
163   assert( pTrigger || tmask==0 );
164 #else
165 # define pTrigger 0
166 # define isView 0
167 # define tmask 0
168 #endif
169 #ifdef SQLITE_OMIT_VIEW
170 # undef isView
171 # define isView 0
172 #endif
173 
174   if( sqlite3ViewGetColumnNames(pParse, pTab) ){
175     goto update_cleanup;
176   }
177   if( sqlite3IsReadOnly(pParse, pTab, tmask) ){
178     goto update_cleanup;
179   }
180 
181   /* Allocate a cursors for the main database table and for all indices.
182   ** The index cursors might not be used, but if they are used they
183   ** need to occur right after the database cursor.  So go ahead and
184   ** allocate enough space, just in case.
185   */
186   pTabList->a[0].iCursor = iBaseCur = iDataCur = pParse->nTab++;
187   iIdxCur = iDataCur+1;
188   pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
189   for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){
190     if( pIdx->autoIndex==2 && pPk!=0 ){
191       iDataCur = pParse->nTab;
192       pTabList->a[0].iCursor = iDataCur;
193     }
194     pParse->nTab++;
195   }
196 
197   /* Allocate space for aXRef[], aRegIdx[], and aToOpen[].
198   ** Initialize aXRef[] and aToOpen[] to their default values.
199   */
200   aXRef = sqlite3DbMallocRaw(db, sizeof(int) * (pTab->nCol+nIdx) + nIdx+2 );
201   if( aXRef==0 ) goto update_cleanup;
202   aRegIdx = aXRef+pTab->nCol;
203   aToOpen = (u8*)(aRegIdx+nIdx);
204   memset(aToOpen, 1, nIdx+1);
205   aToOpen[nIdx+1] = 0;
206   for(i=0; i<pTab->nCol; i++) aXRef[i] = -1;
207 
208   /* Initialize the name-context */
209   memset(&sNC, 0, sizeof(sNC));
210   sNC.pParse = pParse;
211   sNC.pSrcList = pTabList;
212 
213   /* Resolve the column names in all the expressions of the
214   ** of the UPDATE statement.  Also find the column index
215   ** for each column to be updated in the pChanges array.  For each
216   ** column to be updated, make sure we have authorization to change
217   ** that column.
218   */
219   chngRowid = chngPk = 0;
220   for(i=0; i<pChanges->nExpr; i++){
221     if( sqlite3ResolveExprNames(&sNC, pChanges->a[i].pExpr) ){
222       goto update_cleanup;
223     }
224     for(j=0; j<pTab->nCol; j++){
225       if( sqlite3StrICmp(pTab->aCol[j].zName, pChanges->a[i].zName)==0 ){
226         if( j==pTab->iPKey ){
227           chngRowid = 1;
228           pRowidExpr = pChanges->a[i].pExpr;
229         }else if( pPk && (pTab->aCol[j].colFlags & COLFLAG_PRIMKEY)!=0 ){
230           chngPk = 1;
231         }
232         aXRef[j] = i;
233         break;
234       }
235     }
236     if( j>=pTab->nCol ){
237       if( pPk==0 && sqlite3IsRowid(pChanges->a[i].zName) ){
238         j = -1;
239         chngRowid = 1;
240         pRowidExpr = pChanges->a[i].pExpr;
241       }else{
242         sqlite3ErrorMsg(pParse, "no such column: %s", pChanges->a[i].zName);
243         pParse->checkSchema = 1;
244         goto update_cleanup;
245       }
246     }
247 #ifndef SQLITE_OMIT_AUTHORIZATION
248     {
249       int rc;
250       rc = sqlite3AuthCheck(pParse, SQLITE_UPDATE, pTab->zName,
251                             j<0 ? "ROWID" : pTab->aCol[j].zName,
252                             db->aDb[iDb].zName);
253       if( rc==SQLITE_DENY ){
254         goto update_cleanup;
255       }else if( rc==SQLITE_IGNORE ){
256         aXRef[j] = -1;
257       }
258     }
259 #endif
260   }
261   assert( (chngRowid & chngPk)==0 );
262   assert( chngRowid==0 || chngRowid==1 );
263   assert( chngPk==0 || chngPk==1 );
264   chngKey = chngRowid + chngPk;
265 
266   /* The SET expressions are not actually used inside the WHERE loop.
267   ** So reset the colUsed mask
268   */
269   pTabList->a[0].colUsed = 0;
270 
271   hasFK = sqlite3FkRequired(pParse, pTab, aXRef, chngKey);
272 
273   /* There is one entry in the aRegIdx[] array for each index on the table
274   ** being updated.  Fill in aRegIdx[] with a register number that will hold
275   ** the key for accessing each index.
276   */
277   for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
278     int reg;
279     if( chngKey || hasFK || pIdx->pPartIdxWhere || pIdx==pPk ){
280       reg = ++pParse->nMem;
281     }else{
282       reg = 0;
283       for(i=0; i<pIdx->nKeyCol; i++){
284         if( aXRef[pIdx->aiColumn[i]]>=0 ){
285           reg = ++pParse->nMem;
286           break;
287         }
288       }
289     }
290     if( reg==0 ) aToOpen[j+1] = 0;
291     aRegIdx[j] = reg;
292   }
293 
294   /* Begin generating code. */
295   v = sqlite3GetVdbe(pParse);
296   if( v==0 ) goto update_cleanup;
297   if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
298   sqlite3BeginWriteOperation(pParse, 1, iDb);
299 
300 #ifndef SQLITE_OMIT_VIRTUALTABLE
301   /* Virtual tables must be handled separately */
302   if( IsVirtual(pTab) ){
303     updateVirtualTable(pParse, pTabList, pTab, pChanges, pRowidExpr, aXRef,
304                        pWhere, onError);
305     pWhere = 0;
306     pTabList = 0;
307     goto update_cleanup;
308   }
309 #endif
310 
311   /* Allocate required registers. */
312   regRowSet = ++pParse->nMem;
313   regOldRowid = regNewRowid = ++pParse->nMem;
314   if( chngPk || pTrigger || hasFK ){
315     regOld = pParse->nMem + 1;
316     pParse->nMem += pTab->nCol;
317   }
318   if( chngKey || pTrigger || hasFK ){
319     regNewRowid = ++pParse->nMem;
320   }
321   regNew = pParse->nMem + 1;
322   pParse->nMem += pTab->nCol;
323 
324   /* Start the view context. */
325   if( isView ){
326     sqlite3AuthContextPush(pParse, &sContext, pTab->zName);
327   }
328 
329   /* If we are trying to update a view, realize that view into
330   ** a ephemeral table.
331   */
332 #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
333   if( isView ){
334     sqlite3MaterializeView(pParse, pTab, pWhere, iDataCur);
335   }
336 #endif
337 
338   /* Resolve the column names in all the expressions in the
339   ** WHERE clause.
340   */
341   if( sqlite3ResolveExprNames(&sNC, pWhere) ){
342     goto update_cleanup;
343   }
344 
345   /* Begin the database scan
346   */
347   if( HasRowid(pTab) ){
348     sqlite3VdbeAddOp3(v, OP_Null, 0, regRowSet, regOldRowid);
349     pWInfo = sqlite3WhereBegin(
350         pParse, pTabList, pWhere, 0, 0, WHERE_ONEPASS_DESIRED, iIdxCur
351     );
352     if( pWInfo==0 ) goto update_cleanup;
353     okOnePass = sqlite3WhereOkOnePass(pWInfo, aiCurOnePass);
354 
355     /* Remember the rowid of every item to be updated.
356     */
357     sqlite3VdbeAddOp2(v, OP_Rowid, iDataCur, regOldRowid);
358     if( !okOnePass ){
359       sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, regOldRowid);
360     }
361 
362     /* End the database scan loop.
363     */
364     sqlite3WhereEnd(pWInfo);
365   }else{
366     int iPk;         /* First of nPk memory cells holding PRIMARY KEY value */
367     i16 nPk;         /* Number of components of the PRIMARY KEY */
368     int addrOpen;    /* Address of the OpenEphemeral instruction */
369 
370     assert( pPk!=0 );
371     nPk = pPk->nKeyCol;
372     iPk = pParse->nMem+1;
373     pParse->nMem += nPk;
374     regKey = ++pParse->nMem;
375     iEph = pParse->nTab++;
376     sqlite3VdbeAddOp2(v, OP_Null, 0, iPk);
377     addrOpen = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iEph, nPk);
378     sqlite3VdbeSetP4KeyInfo(pParse, pPk);
379     pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, 0, 0,
380                                WHERE_ONEPASS_DESIRED, iIdxCur);
381     if( pWInfo==0 ) goto update_cleanup;
382     okOnePass = sqlite3WhereOkOnePass(pWInfo, aiCurOnePass);
383     for(i=0; i<nPk; i++){
384       sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, pPk->aiColumn[i],
385                                       iPk+i);
386     }
387     if( okOnePass ){
388       sqlite3VdbeChangeToNoop(v, addrOpen);
389       nKey = nPk;
390       regKey = iPk;
391     }else{
392       sqlite3VdbeAddOp4(v, OP_MakeRecord, iPk, nPk, regKey,
393                         sqlite3IndexAffinityStr(v, pPk), P4_TRANSIENT);
394       sqlite3VdbeAddOp2(v, OP_IdxInsert, iEph, regKey);
395     }
396     sqlite3WhereEnd(pWInfo);
397   }
398 
399   /* Initialize the count of updated rows
400   */
401   if( (db->flags & SQLITE_CountRows) && !pParse->pTriggerTab ){
402     regRowCount = ++pParse->nMem;
403     sqlite3VdbeAddOp2(v, OP_Integer, 0, regRowCount);
404   }
405 
406   labelBreak = sqlite3VdbeMakeLabel(v);
407   if( !isView ){
408     /*
409     ** Open every index that needs updating.  Note that if any
410     ** index could potentially invoke a REPLACE conflict resolution
411     ** action, then we need to open all indices because we might need
412     ** to be deleting some records.
413     */
414     if( onError==OE_Replace ){
415       memset(aToOpen, 1, nIdx+1);
416     }else{
417       for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
418         if( pIdx->onError==OE_Replace ){
419           memset(aToOpen, 1, nIdx+1);
420           break;
421         }
422       }
423     }
424     if( okOnePass ){
425       if( aiCurOnePass[0]>=0 ) aToOpen[aiCurOnePass[0]-iBaseCur] = 0;
426       if( aiCurOnePass[1]>=0 ) aToOpen[aiCurOnePass[1]-iBaseCur] = 0;
427     }
428     sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, iBaseCur, aToOpen,
429                                0, 0);
430   }
431 
432   /* Top of the update loop */
433   if( okOnePass ){
434     if( aToOpen[iDataCur-iBaseCur] ){
435       assert( pPk!=0 );
436       sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelBreak, regKey, nKey);
437     }
438     labelContinue = labelBreak;
439     sqlite3VdbeAddOp2(v, OP_IsNull, pPk ? regKey : regOldRowid, labelBreak);
440   }else if( pPk ){
441     labelContinue = sqlite3VdbeMakeLabel(v);
442     sqlite3VdbeAddOp2(v, OP_Rewind, iEph, labelBreak);
443     addrTop = sqlite3VdbeAddOp2(v, OP_RowKey, iEph, regKey);
444     sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelContinue, regKey, 0);
445   }else{
446     labelContinue = sqlite3VdbeAddOp3(v, OP_RowSetRead, regRowSet, labelBreak,
447                              regOldRowid);
448     sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, labelContinue, regOldRowid);
449   }
450 
451   /* If the record number will change, set register regNewRowid to
452   ** contain the new value. If the record number is not being modified,
453   ** then regNewRowid is the same register as regOldRowid, which is
454   ** already populated.  */
455   assert( chngKey || pTrigger || hasFK || regOldRowid==regNewRowid );
456   if( chngRowid ){
457     sqlite3ExprCode(pParse, pRowidExpr, regNewRowid);
458     sqlite3VdbeAddOp1(v, OP_MustBeInt, regNewRowid);
459   }
460 
461   /* Compute the old pre-UPDATE content of the row being changed, if that
462   ** information is needed */
463   if( chngPk || hasFK || pTrigger ){
464     u32 oldmask = (hasFK ? sqlite3FkOldmask(pParse, pTab) : 0);
465     oldmask |= sqlite3TriggerColmask(pParse,
466         pTrigger, pChanges, 0, TRIGGER_BEFORE|TRIGGER_AFTER, pTab, onError
467     );
468     for(i=0; i<pTab->nCol; i++){
469       if( oldmask==0xffffffff
470        || (i<32 && (oldmask & MASKBIT32(i))!=0)
471        || (pTab->aCol[i].colFlags & COLFLAG_PRIMKEY)!=0
472       ){
473         testcase(  oldmask!=0xffffffff && i==31 );
474         sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, i, regOld+i);
475       }else{
476         sqlite3VdbeAddOp2(v, OP_Null, 0, regOld+i);
477       }
478     }
479     if( chngRowid==0 && pPk==0 ){
480       sqlite3VdbeAddOp2(v, OP_Copy, regOldRowid, regNewRowid);
481     }
482   }
483 
484   /* Populate the array of registers beginning at regNew with the new
485   ** row data. This array is used to check constaints, create the new
486   ** table and index records, and as the values for any new.* references
487   ** made by triggers.
488   **
489   ** If there are one or more BEFORE triggers, then do not populate the
490   ** registers associated with columns that are (a) not modified by
491   ** this UPDATE statement and (b) not accessed by new.* references. The
492   ** values for registers not modified by the UPDATE must be reloaded from
493   ** the database after the BEFORE triggers are fired anyway (as the trigger
494   ** may have modified them). So not loading those that are not going to
495   ** be used eliminates some redundant opcodes.
496   */
497   newmask = sqlite3TriggerColmask(
498       pParse, pTrigger, pChanges, 1, TRIGGER_BEFORE, pTab, onError
499   );
500   /*sqlite3VdbeAddOp3(v, OP_Null, 0, regNew, regNew+pTab->nCol-1);*/
501   for(i=0; i<pTab->nCol; i++){
502     if( i==pTab->iPKey ){
503       sqlite3VdbeAddOp2(v, OP_Null, 0, regNew+i);
504     }else{
505       j = aXRef[i];
506       if( j>=0 ){
507         sqlite3ExprCode(pParse, pChanges->a[j].pExpr, regNew+i);
508       }else if( 0==(tmask&TRIGGER_BEFORE) || i>31 || (newmask & MASKBIT32(i)) ){
509         /* This branch loads the value of a column that will not be changed
510         ** into a register. This is done if there are no BEFORE triggers, or
511         ** if there are one or more BEFORE triggers that use this value via
512         ** a new.* reference in a trigger program.
513         */
514         testcase( i==31 );
515         testcase( i==32 );
516         sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, i, regNew+i);
517       }else{
518         sqlite3VdbeAddOp2(v, OP_Null, 0, regNew+i);
519       }
520     }
521   }
522 
523   /* Fire any BEFORE UPDATE triggers. This happens before constraints are
524   ** verified. One could argue that this is wrong.
525   */
526   if( tmask&TRIGGER_BEFORE ){
527     sqlite3VdbeAddOp2(v, OP_Affinity, regNew, pTab->nCol);
528     sqlite3TableAffinityStr(v, pTab);
529     sqlite3CodeRowTrigger(pParse, pTrigger, TK_UPDATE, pChanges,
530         TRIGGER_BEFORE, pTab, regOldRowid, onError, labelContinue);
531 
532     /* The row-trigger may have deleted the row being updated. In this
533     ** case, jump to the next row. No updates or AFTER triggers are
534     ** required. This behavior - what happens when the row being updated
535     ** is deleted or renamed by a BEFORE trigger - is left undefined in the
536     ** documentation.
537     */
538     if( pPk ){
539       sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelContinue,regKey,nKey);
540     }else{
541       sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, labelContinue, regOldRowid);
542     }
543 
544     /* If it did not delete it, the row-trigger may still have modified
545     ** some of the columns of the row being updated. Load the values for
546     ** all columns not modified by the update statement into their
547     ** registers in case this has happened.
548     */
549     for(i=0; i<pTab->nCol; i++){
550       if( aXRef[i]<0 && i!=pTab->iPKey ){
551         sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, i, regNew+i);
552       }
553     }
554   }
555 
556   if( !isView ){
557     int j1 = 0;           /* Address of jump instruction */
558     int bReplace = 0;     /* True if REPLACE conflict resolution might happen */
559 
560     /* Do constraint checks. */
561     assert( regOldRowid>0 );
562     sqlite3GenerateConstraintChecks(pParse, pTab, aRegIdx, iDataCur, iIdxCur,
563         regNewRowid, regOldRowid, chngKey, onError, labelContinue, &bReplace);
564 
565     /* Do FK constraint checks. */
566     if( hasFK ){
567       sqlite3FkCheck(pParse, pTab, regOldRowid, 0, aXRef, chngKey);
568     }
569 
570     /* Delete the index entries associated with the current record.  */
571     if( bReplace || chngKey ){
572       if( pPk ){
573         j1 = sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, 0, regKey, nKey);
574       }else{
575         j1 = sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, 0, regOldRowid);
576       }
577     }
578     sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur, aRegIdx);
579 
580     /* If changing the record number, delete the old record.  */
581     if( hasFK || chngKey || pPk!=0 ){
582       sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, 0);
583     }
584     if( bReplace || chngKey ){
585       sqlite3VdbeJumpHere(v, j1);
586     }
587 
588     if( hasFK ){
589       sqlite3FkCheck(pParse, pTab, 0, regNewRowid, aXRef, chngKey);
590     }
591 
592     /* Insert the new index entries and the new record. */
593     sqlite3CompleteInsertion(pParse, pTab, iDataCur, iIdxCur,
594                              regNewRowid, aRegIdx, 1, 0, 0);
595 
596     /* Do any ON CASCADE, SET NULL or SET DEFAULT operations required to
597     ** handle rows (possibly in other tables) that refer via a foreign key
598     ** to the row just updated. */
599     if( hasFK ){
600       sqlite3FkActions(pParse, pTab, pChanges, regOldRowid, aXRef, chngKey);
601     }
602   }
603 
604   /* Increment the row counter
605   */
606   if( (db->flags & SQLITE_CountRows) && !pParse->pTriggerTab){
607     sqlite3VdbeAddOp2(v, OP_AddImm, regRowCount, 1);
608   }
609 
610   sqlite3CodeRowTrigger(pParse, pTrigger, TK_UPDATE, pChanges,
611       TRIGGER_AFTER, pTab, regOldRowid, onError, labelContinue);
612 
613   /* Repeat the above with the next record to be updated, until
614   ** all record selected by the WHERE clause have been updated.
615   */
616   if( okOnePass ){
617     /* Nothing to do at end-of-loop for a single-pass */
618   }else if( pPk ){
619     sqlite3VdbeResolveLabel(v, labelContinue);
620     sqlite3VdbeAddOp2(v, OP_Next, iEph, addrTop);
621   }else{
622     sqlite3VdbeAddOp2(v, OP_Goto, 0, labelContinue);
623   }
624   sqlite3VdbeResolveLabel(v, labelBreak);
625 
626   /* Close all tables */
627   for(i=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, i++){
628     assert( aRegIdx );
629     if( aToOpen[i+1] ){
630       sqlite3VdbeAddOp2(v, OP_Close, iIdxCur+i, 0);
631     }
632   }
633   if( iDataCur<iIdxCur ) sqlite3VdbeAddOp2(v, OP_Close, iDataCur, 0);
634 
635   /* Update the sqlite_sequence table by storing the content of the
636   ** maximum rowid counter values recorded while inserting into
637   ** autoincrement tables.
638   */
639   if( pParse->nested==0 && pParse->pTriggerTab==0 ){
640     sqlite3AutoincrementEnd(pParse);
641   }
642 
643   /*
644   ** Return the number of rows that were changed. If this routine is
645   ** generating code because of a call to sqlite3NestedParse(), do not
646   ** invoke the callback function.
647   */
648   if( (db->flags&SQLITE_CountRows) && !pParse->pTriggerTab && !pParse->nested ){
649     sqlite3VdbeAddOp2(v, OP_ResultRow, regRowCount, 1);
650     sqlite3VdbeSetNumCols(v, 1);
651     sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows updated", SQLITE_STATIC);
652   }
653 
654 update_cleanup:
655   sqlite3AuthContextPop(&sContext);
656   sqlite3DbFree(db, aXRef); /* Also frees aRegIdx[] and aToOpen[] */
657   sqlite3SrcListDelete(db, pTabList);
658   sqlite3ExprListDelete(db, pChanges);
659   sqlite3ExprDelete(db, pWhere);
660   return;
661 }
662 /* Make sure "isView" and other macros defined above are undefined. Otherwise
663 ** thely may interfere with compilation of other functions in this file
664 ** (or in another file, if this file becomes part of the amalgamation).  */
665 #ifdef isView
666  #undef isView
667 #endif
668 #ifdef pTrigger
669  #undef pTrigger
670 #endif
671 
672 #ifndef SQLITE_OMIT_VIRTUALTABLE
673 /*
674 ** Generate code for an UPDATE of a virtual table.
675 **
676 ** The strategy is that we create an ephemerial table that contains
677 ** for each row to be changed:
678 **
679 **   (A)  The original rowid of that row.
680 **   (B)  The revised rowid for the row. (note1)
681 **   (C)  The content of every column in the row.
682 **
683 ** Then we loop over this ephemeral table and for each row in
684 ** the ephermeral table call VUpdate.
685 **
686 ** When finished, drop the ephemeral table.
687 **
688 ** (note1) Actually, if we know in advance that (A) is always the same
689 ** as (B) we only store (A), then duplicate (A) when pulling
690 ** it out of the ephemeral table before calling VUpdate.
691 */
692 static void updateVirtualTable(
693   Parse *pParse,       /* The parsing context */
694   SrcList *pSrc,       /* The virtual table to be modified */
695   Table *pTab,         /* The virtual table */
696   ExprList *pChanges,  /* The columns to change in the UPDATE statement */
697   Expr *pRowid,        /* Expression used to recompute the rowid */
698   int *aXRef,          /* Mapping from columns of pTab to entries in pChanges */
699   Expr *pWhere,        /* WHERE clause of the UPDATE statement */
700   int onError          /* ON CONFLICT strategy */
701 ){
702   Vdbe *v = pParse->pVdbe;  /* Virtual machine under construction */
703   ExprList *pEList = 0;     /* The result set of the SELECT statement */
704   Select *pSelect = 0;      /* The SELECT statement */
705   Expr *pExpr;              /* Temporary expression */
706   int ephemTab;             /* Table holding the result of the SELECT */
707   int i;                    /* Loop counter */
708   int addr;                 /* Address of top of loop */
709   int iReg;                 /* First register in set passed to OP_VUpdate */
710   sqlite3 *db = pParse->db; /* Database connection */
711   const char *pVTab = (const char*)sqlite3GetVTable(db, pTab);
712   SelectDest dest;
713 
714   /* Construct the SELECT statement that will find the new values for
715   ** all updated rows.
716   */
717   pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ID, "_rowid_"));
718   if( pRowid ){
719     pEList = sqlite3ExprListAppend(pParse, pEList,
720                                    sqlite3ExprDup(db, pRowid, 0));
721   }
722   assert( pTab->iPKey<0 );
723   for(i=0; i<pTab->nCol; i++){
724     if( aXRef[i]>=0 ){
725       pExpr = sqlite3ExprDup(db, pChanges->a[aXRef[i]].pExpr, 0);
726     }else{
727       pExpr = sqlite3Expr(db, TK_ID, pTab->aCol[i].zName);
728     }
729     pEList = sqlite3ExprListAppend(pParse, pEList, pExpr);
730   }
731   pSelect = sqlite3SelectNew(pParse, pEList, pSrc, pWhere, 0, 0, 0, 0, 0, 0);
732 
733   /* Create the ephemeral table into which the update results will
734   ** be stored.
735   */
736   assert( v );
737   ephemTab = pParse->nTab++;
738   sqlite3VdbeAddOp2(v, OP_OpenEphemeral, ephemTab, pTab->nCol+1+(pRowid!=0));
739   sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
740 
741   /* fill the ephemeral table
742   */
743   sqlite3SelectDestInit(&dest, SRT_Table, ephemTab);
744   sqlite3Select(pParse, pSelect, &dest);
745 
746   /* Generate code to scan the ephemeral table and call VUpdate. */
747   iReg = ++pParse->nMem;
748   pParse->nMem += pTab->nCol+1;
749   addr = sqlite3VdbeAddOp2(v, OP_Rewind, ephemTab, 0);
750   sqlite3VdbeAddOp3(v, OP_Column,  ephemTab, 0, iReg);
751   sqlite3VdbeAddOp3(v, OP_Column, ephemTab, (pRowid?1:0), iReg+1);
752   for(i=0; i<pTab->nCol; i++){
753     sqlite3VdbeAddOp3(v, OP_Column, ephemTab, i+1+(pRowid!=0), iReg+2+i);
754   }
755   sqlite3VtabMakeWritable(pParse, pTab);
756   sqlite3VdbeAddOp4(v, OP_VUpdate, 0, pTab->nCol+2, iReg, pVTab, P4_VTAB);
757   sqlite3VdbeChangeP5(v, onError==OE_Default ? OE_Abort : onError);
758   sqlite3MayAbort(pParse);
759   sqlite3VdbeAddOp2(v, OP_Next, ephemTab, addr+1);
760   sqlite3VdbeJumpHere(v, addr);
761   sqlite3VdbeAddOp2(v, OP_Close, ephemTab, 0);
762 
763   /* Cleanup */
764   sqlite3SelectDelete(db, pSelect);
765 }
766 #endif /* SQLITE_OMIT_VIRTUALTABLE */
767