Snapshot of upstream SQLite 3.15.2
[sqlcipher.git] / src / insert.c
blob8167ff78c561d0cc1b9e2f60fa845bb38cdaca7a
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.
11 *************************************************************************
12 ** This file contains C code routines that are called by the parser
13 ** to handle INSERT statements in SQLite.
15 #include "sqliteInt.h"
18 ** Generate code that will
20 ** (1) acquire a lock for table pTab then
21 ** (2) open pTab as cursor iCur.
23 ** If pTab is a WITHOUT ROWID table, then it is the PRIMARY KEY index
24 ** for that table that is actually opened.
26 void sqlite3OpenTable(
27 Parse *pParse, /* Generate code into this VDBE */
28 int iCur, /* The cursor number of the table */
29 int iDb, /* The database index in sqlite3.aDb[] */
30 Table *pTab, /* The table to be opened */
31 int opcode /* OP_OpenRead or OP_OpenWrite */
33 Vdbe *v;
34 assert( !IsVirtual(pTab) );
35 v = sqlite3GetVdbe(pParse);
36 assert( opcode==OP_OpenWrite || opcode==OP_OpenRead );
37 sqlite3TableLock(pParse, iDb, pTab->tnum,
38 (opcode==OP_OpenWrite)?1:0, pTab->zName);
39 if( HasRowid(pTab) ){
40 sqlite3VdbeAddOp4Int(v, opcode, iCur, pTab->tnum, iDb, pTab->nCol);
41 VdbeComment((v, "%s", pTab->zName));
42 }else{
43 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
44 assert( pPk!=0 );
45 assert( pPk->tnum==pTab->tnum );
46 sqlite3VdbeAddOp3(v, opcode, iCur, pPk->tnum, iDb);
47 sqlite3VdbeSetP4KeyInfo(pParse, pPk);
48 VdbeComment((v, "%s", pTab->zName));
53 ** Return a pointer to the column affinity string associated with index
54 ** pIdx. A column affinity string has one character for each column in
55 ** the table, according to the affinity of the column:
57 ** Character Column affinity
58 ** ------------------------------
59 ** 'A' BLOB
60 ** 'B' TEXT
61 ** 'C' NUMERIC
62 ** 'D' INTEGER
63 ** 'F' REAL
65 ** An extra 'D' is appended to the end of the string to cover the
66 ** rowid that appears as the last column in every index.
68 ** Memory for the buffer containing the column index affinity string
69 ** is managed along with the rest of the Index structure. It will be
70 ** released when sqlite3DeleteIndex() is called.
72 const char *sqlite3IndexAffinityStr(sqlite3 *db, Index *pIdx){
73 if( !pIdx->zColAff ){
74 /* The first time a column affinity string for a particular index is
75 ** required, it is allocated and populated here. It is then stored as
76 ** a member of the Index structure for subsequent use.
78 ** The column affinity string will eventually be deleted by
79 ** sqliteDeleteIndex() when the Index structure itself is cleaned
80 ** up.
82 int n;
83 Table *pTab = pIdx->pTable;
84 pIdx->zColAff = (char *)sqlite3DbMallocRaw(0, pIdx->nColumn+1);
85 if( !pIdx->zColAff ){
86 sqlite3OomFault(db);
87 return 0;
89 for(n=0; n<pIdx->nColumn; n++){
90 i16 x = pIdx->aiColumn[n];
91 if( x>=0 ){
92 pIdx->zColAff[n] = pTab->aCol[x].affinity;
93 }else if( x==XN_ROWID ){
94 pIdx->zColAff[n] = SQLITE_AFF_INTEGER;
95 }else{
96 char aff;
97 assert( x==XN_EXPR );
98 assert( pIdx->aColExpr!=0 );
99 aff = sqlite3ExprAffinity(pIdx->aColExpr->a[n].pExpr);
100 if( aff==0 ) aff = SQLITE_AFF_BLOB;
101 pIdx->zColAff[n] = aff;
104 pIdx->zColAff[n] = 0;
107 return pIdx->zColAff;
111 ** Compute the affinity string for table pTab, if it has not already been
112 ** computed. As an optimization, omit trailing SQLITE_AFF_BLOB affinities.
114 ** If the affinity exists (if it is no entirely SQLITE_AFF_BLOB values) and
115 ** if iReg>0 then code an OP_Affinity opcode that will set the affinities
116 ** for register iReg and following. Or if affinities exists and iReg==0,
117 ** then just set the P4 operand of the previous opcode (which should be
118 ** an OP_MakeRecord) to the affinity string.
120 ** A column affinity string has one character per column:
122 ** Character Column affinity
123 ** ------------------------------
124 ** 'A' BLOB
125 ** 'B' TEXT
126 ** 'C' NUMERIC
127 ** 'D' INTEGER
128 ** 'E' REAL
130 void sqlite3TableAffinity(Vdbe *v, Table *pTab, int iReg){
131 int i;
132 char *zColAff = pTab->zColAff;
133 if( zColAff==0 ){
134 sqlite3 *db = sqlite3VdbeDb(v);
135 zColAff = (char *)sqlite3DbMallocRaw(0, pTab->nCol+1);
136 if( !zColAff ){
137 sqlite3OomFault(db);
138 return;
141 for(i=0; i<pTab->nCol; i++){
142 zColAff[i] = pTab->aCol[i].affinity;
145 zColAff[i--] = 0;
146 }while( i>=0 && zColAff[i]==SQLITE_AFF_BLOB );
147 pTab->zColAff = zColAff;
149 i = sqlite3Strlen30(zColAff);
150 if( i ){
151 if( iReg ){
152 sqlite3VdbeAddOp4(v, OP_Affinity, iReg, i, 0, zColAff, i);
153 }else{
154 sqlite3VdbeChangeP4(v, -1, zColAff, i);
160 ** Return non-zero if the table pTab in database iDb or any of its indices
161 ** have been opened at any point in the VDBE program. This is used to see if
162 ** a statement of the form "INSERT INTO <iDb, pTab> SELECT ..." can
163 ** run without using a temporary table for the results of the SELECT.
165 static int readsTable(Parse *p, int iDb, Table *pTab){
166 Vdbe *v = sqlite3GetVdbe(p);
167 int i;
168 int iEnd = sqlite3VdbeCurrentAddr(v);
169 #ifndef SQLITE_OMIT_VIRTUALTABLE
170 VTable *pVTab = IsVirtual(pTab) ? sqlite3GetVTable(p->db, pTab) : 0;
171 #endif
173 for(i=1; i<iEnd; i++){
174 VdbeOp *pOp = sqlite3VdbeGetOp(v, i);
175 assert( pOp!=0 );
176 if( pOp->opcode==OP_OpenRead && pOp->p3==iDb ){
177 Index *pIndex;
178 int tnum = pOp->p2;
179 if( tnum==pTab->tnum ){
180 return 1;
182 for(pIndex=pTab->pIndex; pIndex; pIndex=pIndex->pNext){
183 if( tnum==pIndex->tnum ){
184 return 1;
188 #ifndef SQLITE_OMIT_VIRTUALTABLE
189 if( pOp->opcode==OP_VOpen && pOp->p4.pVtab==pVTab ){
190 assert( pOp->p4.pVtab!=0 );
191 assert( pOp->p4type==P4_VTAB );
192 return 1;
194 #endif
196 return 0;
199 #ifndef SQLITE_OMIT_AUTOINCREMENT
201 ** Locate or create an AutoincInfo structure associated with table pTab
202 ** which is in database iDb. Return the register number for the register
203 ** that holds the maximum rowid. Return zero if pTab is not an AUTOINCREMENT
204 ** table. (Also return zero when doing a VACUUM since we do not want to
205 ** update the AUTOINCREMENT counters during a VACUUM.)
207 ** There is at most one AutoincInfo structure per table even if the
208 ** same table is autoincremented multiple times due to inserts within
209 ** triggers. A new AutoincInfo structure is created if this is the
210 ** first use of table pTab. On 2nd and subsequent uses, the original
211 ** AutoincInfo structure is used.
213 ** Three memory locations are allocated:
215 ** (1) Register to hold the name of the pTab table.
216 ** (2) Register to hold the maximum ROWID of pTab.
217 ** (3) Register to hold the rowid in sqlite_sequence of pTab
219 ** The 2nd register is the one that is returned. That is all the
220 ** insert routine needs to know about.
222 static int autoIncBegin(
223 Parse *pParse, /* Parsing context */
224 int iDb, /* Index of the database holding pTab */
225 Table *pTab /* The table we are writing to */
227 int memId = 0; /* Register holding maximum rowid */
228 if( (pTab->tabFlags & TF_Autoincrement)!=0
229 && (pParse->db->flags & SQLITE_Vacuum)==0
231 Parse *pToplevel = sqlite3ParseToplevel(pParse);
232 AutoincInfo *pInfo;
234 pInfo = pToplevel->pAinc;
235 while( pInfo && pInfo->pTab!=pTab ){ pInfo = pInfo->pNext; }
236 if( pInfo==0 ){
237 pInfo = sqlite3DbMallocRawNN(pParse->db, sizeof(*pInfo));
238 if( pInfo==0 ) return 0;
239 pInfo->pNext = pToplevel->pAinc;
240 pToplevel->pAinc = pInfo;
241 pInfo->pTab = pTab;
242 pInfo->iDb = iDb;
243 pToplevel->nMem++; /* Register to hold name of table */
244 pInfo->regCtr = ++pToplevel->nMem; /* Max rowid register */
245 pToplevel->nMem++; /* Rowid in sqlite_sequence */
247 memId = pInfo->regCtr;
249 return memId;
253 ** This routine generates code that will initialize all of the
254 ** register used by the autoincrement tracker.
256 void sqlite3AutoincrementBegin(Parse *pParse){
257 AutoincInfo *p; /* Information about an AUTOINCREMENT */
258 sqlite3 *db = pParse->db; /* The database connection */
259 Db *pDb; /* Database only autoinc table */
260 int memId; /* Register holding max rowid */
261 Vdbe *v = pParse->pVdbe; /* VDBE under construction */
263 /* This routine is never called during trigger-generation. It is
264 ** only called from the top-level */
265 assert( pParse->pTriggerTab==0 );
266 assert( sqlite3IsToplevel(pParse) );
268 assert( v ); /* We failed long ago if this is not so */
269 for(p = pParse->pAinc; p; p = p->pNext){
270 static const int iLn = VDBE_OFFSET_LINENO(2);
271 static const VdbeOpList autoInc[] = {
272 /* 0 */ {OP_Null, 0, 0, 0},
273 /* 1 */ {OP_Rewind, 0, 9, 0},
274 /* 2 */ {OP_Column, 0, 0, 0},
275 /* 3 */ {OP_Ne, 0, 7, 0},
276 /* 4 */ {OP_Rowid, 0, 0, 0},
277 /* 5 */ {OP_Column, 0, 1, 0},
278 /* 6 */ {OP_Goto, 0, 9, 0},
279 /* 7 */ {OP_Next, 0, 2, 0},
280 /* 8 */ {OP_Integer, 0, 0, 0},
281 /* 9 */ {OP_Close, 0, 0, 0}
283 VdbeOp *aOp;
284 pDb = &db->aDb[p->iDb];
285 memId = p->regCtr;
286 assert( sqlite3SchemaMutexHeld(db, 0, pDb->pSchema) );
287 sqlite3OpenTable(pParse, 0, p->iDb, pDb->pSchema->pSeqTab, OP_OpenRead);
288 sqlite3VdbeLoadString(v, memId-1, p->pTab->zName);
289 aOp = sqlite3VdbeAddOpList(v, ArraySize(autoInc), autoInc, iLn);
290 if( aOp==0 ) break;
291 aOp[0].p2 = memId;
292 aOp[0].p3 = memId+1;
293 aOp[2].p3 = memId;
294 aOp[3].p1 = memId-1;
295 aOp[3].p3 = memId;
296 aOp[3].p5 = SQLITE_JUMPIFNULL;
297 aOp[4].p2 = memId+1;
298 aOp[5].p3 = memId;
299 aOp[8].p2 = memId;
304 ** Update the maximum rowid for an autoincrement calculation.
306 ** This routine should be called when the regRowid register holds a
307 ** new rowid that is about to be inserted. If that new rowid is
308 ** larger than the maximum rowid in the memId memory cell, then the
309 ** memory cell is updated.
311 static void autoIncStep(Parse *pParse, int memId, int regRowid){
312 if( memId>0 ){
313 sqlite3VdbeAddOp2(pParse->pVdbe, OP_MemMax, memId, regRowid);
318 ** This routine generates the code needed to write autoincrement
319 ** maximum rowid values back into the sqlite_sequence register.
320 ** Every statement that might do an INSERT into an autoincrement
321 ** table (either directly or through triggers) needs to call this
322 ** routine just before the "exit" code.
324 static SQLITE_NOINLINE void autoIncrementEnd(Parse *pParse){
325 AutoincInfo *p;
326 Vdbe *v = pParse->pVdbe;
327 sqlite3 *db = pParse->db;
329 assert( v );
330 for(p = pParse->pAinc; p; p = p->pNext){
331 static const int iLn = VDBE_OFFSET_LINENO(2);
332 static const VdbeOpList autoIncEnd[] = {
333 /* 0 */ {OP_NotNull, 0, 2, 0},
334 /* 1 */ {OP_NewRowid, 0, 0, 0},
335 /* 2 */ {OP_MakeRecord, 0, 2, 0},
336 /* 3 */ {OP_Insert, 0, 0, 0},
337 /* 4 */ {OP_Close, 0, 0, 0}
339 VdbeOp *aOp;
340 Db *pDb = &db->aDb[p->iDb];
341 int iRec;
342 int memId = p->regCtr;
344 iRec = sqlite3GetTempReg(pParse);
345 assert( sqlite3SchemaMutexHeld(db, 0, pDb->pSchema) );
346 sqlite3OpenTable(pParse, 0, p->iDb, pDb->pSchema->pSeqTab, OP_OpenWrite);
347 aOp = sqlite3VdbeAddOpList(v, ArraySize(autoIncEnd), autoIncEnd, iLn);
348 if( aOp==0 ) break;
349 aOp[0].p1 = memId+1;
350 aOp[1].p2 = memId+1;
351 aOp[2].p1 = memId-1;
352 aOp[2].p3 = iRec;
353 aOp[3].p2 = iRec;
354 aOp[3].p3 = memId+1;
355 aOp[3].p5 = OPFLAG_APPEND;
356 sqlite3ReleaseTempReg(pParse, iRec);
359 void sqlite3AutoincrementEnd(Parse *pParse){
360 if( pParse->pAinc ) autoIncrementEnd(pParse);
362 #else
364 ** If SQLITE_OMIT_AUTOINCREMENT is defined, then the three routines
365 ** above are all no-ops
367 # define autoIncBegin(A,B,C) (0)
368 # define autoIncStep(A,B,C)
369 #endif /* SQLITE_OMIT_AUTOINCREMENT */
372 /* Forward declaration */
373 static int xferOptimization(
374 Parse *pParse, /* Parser context */
375 Table *pDest, /* The table we are inserting into */
376 Select *pSelect, /* A SELECT statement to use as the data source */
377 int onError, /* How to handle constraint errors */
378 int iDbDest /* The database of pDest */
382 ** This routine is called to handle SQL of the following forms:
384 ** insert into TABLE (IDLIST) values(EXPRLIST),(EXPRLIST),...
385 ** insert into TABLE (IDLIST) select
386 ** insert into TABLE (IDLIST) default values
388 ** The IDLIST following the table name is always optional. If omitted,
389 ** then a list of all (non-hidden) columns for the table is substituted.
390 ** The IDLIST appears in the pColumn parameter. pColumn is NULL if IDLIST
391 ** is omitted.
393 ** For the pSelect parameter holds the values to be inserted for the
394 ** first two forms shown above. A VALUES clause is really just short-hand
395 ** for a SELECT statement that omits the FROM clause and everything else
396 ** that follows. If the pSelect parameter is NULL, that means that the
397 ** DEFAULT VALUES form of the INSERT statement is intended.
399 ** The code generated follows one of four templates. For a simple
400 ** insert with data coming from a single-row VALUES clause, the code executes
401 ** once straight down through. Pseudo-code follows (we call this
402 ** the "1st template"):
404 ** open write cursor to <table> and its indices
405 ** put VALUES clause expressions into registers
406 ** write the resulting record into <table>
407 ** cleanup
409 ** The three remaining templates assume the statement is of the form
411 ** INSERT INTO <table> SELECT ...
413 ** If the SELECT clause is of the restricted form "SELECT * FROM <table2>" -
414 ** in other words if the SELECT pulls all columns from a single table
415 ** and there is no WHERE or LIMIT or GROUP BY or ORDER BY clauses, and
416 ** if <table2> and <table1> are distinct tables but have identical
417 ** schemas, including all the same indices, then a special optimization
418 ** is invoked that copies raw records from <table2> over to <table1>.
419 ** See the xferOptimization() function for the implementation of this
420 ** template. This is the 2nd template.
422 ** open a write cursor to <table>
423 ** open read cursor on <table2>
424 ** transfer all records in <table2> over to <table>
425 ** close cursors
426 ** foreach index on <table>
427 ** open a write cursor on the <table> index
428 ** open a read cursor on the corresponding <table2> index
429 ** transfer all records from the read to the write cursors
430 ** close cursors
431 ** end foreach
433 ** The 3rd template is for when the second template does not apply
434 ** and the SELECT clause does not read from <table> at any time.
435 ** The generated code follows this template:
437 ** X <- A
438 ** goto B
439 ** A: setup for the SELECT
440 ** loop over the rows in the SELECT
441 ** load values into registers R..R+n
442 ** yield X
443 ** end loop
444 ** cleanup after the SELECT
445 ** end-coroutine X
446 ** B: open write cursor to <table> and its indices
447 ** C: yield X, at EOF goto D
448 ** insert the select result into <table> from R..R+n
449 ** goto C
450 ** D: cleanup
452 ** The 4th template is used if the insert statement takes its
453 ** values from a SELECT but the data is being inserted into a table
454 ** that is also read as part of the SELECT. In the third form,
455 ** we have to use an intermediate table to store the results of
456 ** the select. The template is like this:
458 ** X <- A
459 ** goto B
460 ** A: setup for the SELECT
461 ** loop over the tables in the SELECT
462 ** load value into register R..R+n
463 ** yield X
464 ** end loop
465 ** cleanup after the SELECT
466 ** end co-routine R
467 ** B: open temp table
468 ** L: yield X, at EOF goto M
469 ** insert row from R..R+n into temp table
470 ** goto L
471 ** M: open write cursor to <table> and its indices
472 ** rewind temp table
473 ** C: loop over rows of intermediate table
474 ** transfer values form intermediate table into <table>
475 ** end loop
476 ** D: cleanup
478 void sqlite3Insert(
479 Parse *pParse, /* Parser context */
480 SrcList *pTabList, /* Name of table into which we are inserting */
481 Select *pSelect, /* A SELECT statement to use as the data source */
482 IdList *pColumn, /* Column names corresponding to IDLIST. */
483 int onError /* How to handle constraint errors */
485 sqlite3 *db; /* The main database structure */
486 Table *pTab; /* The table to insert into. aka TABLE */
487 char *zTab; /* Name of the table into which we are inserting */
488 int i, j, idx; /* Loop counters */
489 Vdbe *v; /* Generate code into this virtual machine */
490 Index *pIdx; /* For looping over indices of the table */
491 int nColumn; /* Number of columns in the data */
492 int nHidden = 0; /* Number of hidden columns if TABLE is virtual */
493 int iDataCur = 0; /* VDBE cursor that is the main data repository */
494 int iIdxCur = 0; /* First index cursor */
495 int ipkColumn = -1; /* Column that is the INTEGER PRIMARY KEY */
496 int endOfLoop; /* Label for the end of the insertion loop */
497 int srcTab = 0; /* Data comes from this temporary cursor if >=0 */
498 int addrInsTop = 0; /* Jump to label "D" */
499 int addrCont = 0; /* Top of insert loop. Label "C" in templates 3 and 4 */
500 SelectDest dest; /* Destination for SELECT on rhs of INSERT */
501 int iDb; /* Index of database holding TABLE */
502 u8 useTempTable = 0; /* Store SELECT results in intermediate table */
503 u8 appendFlag = 0; /* True if the insert is likely to be an append */
504 u8 withoutRowid; /* 0 for normal table. 1 for WITHOUT ROWID table */
505 u8 bIdListInOrder; /* True if IDLIST is in table order */
506 ExprList *pList = 0; /* List of VALUES() to be inserted */
508 /* Register allocations */
509 int regFromSelect = 0;/* Base register for data coming from SELECT */
510 int regAutoinc = 0; /* Register holding the AUTOINCREMENT counter */
511 int regRowCount = 0; /* Memory cell used for the row counter */
512 int regIns; /* Block of regs holding rowid+data being inserted */
513 int regRowid; /* registers holding insert rowid */
514 int regData; /* register holding first column to insert */
515 int *aRegIdx = 0; /* One register allocated to each index */
517 #ifndef SQLITE_OMIT_TRIGGER
518 int isView; /* True if attempting to insert into a view */
519 Trigger *pTrigger; /* List of triggers on pTab, if required */
520 int tmask; /* Mask of trigger times */
521 #endif
523 db = pParse->db;
524 memset(&dest, 0, sizeof(dest));
525 if( pParse->nErr || db->mallocFailed ){
526 goto insert_cleanup;
529 /* If the Select object is really just a simple VALUES() list with a
530 ** single row (the common case) then keep that one row of values
531 ** and discard the other (unused) parts of the pSelect object
533 if( pSelect && (pSelect->selFlags & SF_Values)!=0 && pSelect->pPrior==0 ){
534 pList = pSelect->pEList;
535 pSelect->pEList = 0;
536 sqlite3SelectDelete(db, pSelect);
537 pSelect = 0;
540 /* Locate the table into which we will be inserting new information.
542 assert( pTabList->nSrc==1 );
543 zTab = pTabList->a[0].zName;
544 if( NEVER(zTab==0) ) goto insert_cleanup;
545 pTab = sqlite3SrcListLookup(pParse, pTabList);
546 if( pTab==0 ){
547 goto insert_cleanup;
549 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
550 assert( iDb<db->nDb );
551 if( sqlite3AuthCheck(pParse, SQLITE_INSERT, pTab->zName, 0,
552 db->aDb[iDb].zDbSName) ){
553 goto insert_cleanup;
555 withoutRowid = !HasRowid(pTab);
557 /* Figure out if we have any triggers and if the table being
558 ** inserted into is a view
560 #ifndef SQLITE_OMIT_TRIGGER
561 pTrigger = sqlite3TriggersExist(pParse, pTab, TK_INSERT, 0, &tmask);
562 isView = pTab->pSelect!=0;
563 #else
564 # define pTrigger 0
565 # define tmask 0
566 # define isView 0
567 #endif
568 #ifdef SQLITE_OMIT_VIEW
569 # undef isView
570 # define isView 0
571 #endif
572 assert( (pTrigger && tmask) || (pTrigger==0 && tmask==0) );
574 /* If pTab is really a view, make sure it has been initialized.
575 ** ViewGetColumnNames() is a no-op if pTab is not a view.
577 if( sqlite3ViewGetColumnNames(pParse, pTab) ){
578 goto insert_cleanup;
581 /* Cannot insert into a read-only table.
583 if( sqlite3IsReadOnly(pParse, pTab, tmask) ){
584 goto insert_cleanup;
587 /* Allocate a VDBE
589 v = sqlite3GetVdbe(pParse);
590 if( v==0 ) goto insert_cleanup;
591 if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
592 sqlite3BeginWriteOperation(pParse, pSelect || pTrigger, iDb);
594 #ifndef SQLITE_OMIT_XFER_OPT
595 /* If the statement is of the form
597 ** INSERT INTO <table1> SELECT * FROM <table2>;
599 ** Then special optimizations can be applied that make the transfer
600 ** very fast and which reduce fragmentation of indices.
602 ** This is the 2nd template.
604 if( pColumn==0 && xferOptimization(pParse, pTab, pSelect, onError, iDb) ){
605 assert( !pTrigger );
606 assert( pList==0 );
607 goto insert_end;
609 #endif /* SQLITE_OMIT_XFER_OPT */
611 /* If this is an AUTOINCREMENT table, look up the sequence number in the
612 ** sqlite_sequence table and store it in memory cell regAutoinc.
614 regAutoinc = autoIncBegin(pParse, iDb, pTab);
616 /* Allocate registers for holding the rowid of the new row,
617 ** the content of the new row, and the assembled row record.
619 regRowid = regIns = pParse->nMem+1;
620 pParse->nMem += pTab->nCol + 1;
621 if( IsVirtual(pTab) ){
622 regRowid++;
623 pParse->nMem++;
625 regData = regRowid+1;
627 /* If the INSERT statement included an IDLIST term, then make sure
628 ** all elements of the IDLIST really are columns of the table and
629 ** remember the column indices.
631 ** If the table has an INTEGER PRIMARY KEY column and that column
632 ** is named in the IDLIST, then record in the ipkColumn variable
633 ** the index into IDLIST of the primary key column. ipkColumn is
634 ** the index of the primary key as it appears in IDLIST, not as
635 ** is appears in the original table. (The index of the INTEGER
636 ** PRIMARY KEY in the original table is pTab->iPKey.)
638 bIdListInOrder = (pTab->tabFlags & TF_OOOHidden)==0;
639 if( pColumn ){
640 for(i=0; i<pColumn->nId; i++){
641 pColumn->a[i].idx = -1;
643 for(i=0; i<pColumn->nId; i++){
644 for(j=0; j<pTab->nCol; j++){
645 if( sqlite3StrICmp(pColumn->a[i].zName, pTab->aCol[j].zName)==0 ){
646 pColumn->a[i].idx = j;
647 if( i!=j ) bIdListInOrder = 0;
648 if( j==pTab->iPKey ){
649 ipkColumn = i; assert( !withoutRowid );
651 break;
654 if( j>=pTab->nCol ){
655 if( sqlite3IsRowid(pColumn->a[i].zName) && !withoutRowid ){
656 ipkColumn = i;
657 bIdListInOrder = 0;
658 }else{
659 sqlite3ErrorMsg(pParse, "table %S has no column named %s",
660 pTabList, 0, pColumn->a[i].zName);
661 pParse->checkSchema = 1;
662 goto insert_cleanup;
668 /* Figure out how many columns of data are supplied. If the data
669 ** is coming from a SELECT statement, then generate a co-routine that
670 ** produces a single row of the SELECT on each invocation. The
671 ** co-routine is the common header to the 3rd and 4th templates.
673 if( pSelect ){
674 /* Data is coming from a SELECT or from a multi-row VALUES clause.
675 ** Generate a co-routine to run the SELECT. */
676 int regYield; /* Register holding co-routine entry-point */
677 int addrTop; /* Top of the co-routine */
678 int rc; /* Result code */
680 regYield = ++pParse->nMem;
681 addrTop = sqlite3VdbeCurrentAddr(v) + 1;
682 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, addrTop);
683 sqlite3SelectDestInit(&dest, SRT_Coroutine, regYield);
684 dest.iSdst = bIdListInOrder ? regData : 0;
685 dest.nSdst = pTab->nCol;
686 rc = sqlite3Select(pParse, pSelect, &dest);
687 regFromSelect = dest.iSdst;
688 if( rc || db->mallocFailed || pParse->nErr ) goto insert_cleanup;
689 sqlite3VdbeEndCoroutine(v, regYield);
690 sqlite3VdbeJumpHere(v, addrTop - 1); /* label B: */
691 assert( pSelect->pEList );
692 nColumn = pSelect->pEList->nExpr;
694 /* Set useTempTable to TRUE if the result of the SELECT statement
695 ** should be written into a temporary table (template 4). Set to
696 ** FALSE if each output row of the SELECT can be written directly into
697 ** the destination table (template 3).
699 ** A temp table must be used if the table being updated is also one
700 ** of the tables being read by the SELECT statement. Also use a
701 ** temp table in the case of row triggers.
703 if( pTrigger || readsTable(pParse, iDb, pTab) ){
704 useTempTable = 1;
707 if( useTempTable ){
708 /* Invoke the coroutine to extract information from the SELECT
709 ** and add it to a transient table srcTab. The code generated
710 ** here is from the 4th template:
712 ** B: open temp table
713 ** L: yield X, goto M at EOF
714 ** insert row from R..R+n into temp table
715 ** goto L
716 ** M: ...
718 int regRec; /* Register to hold packed record */
719 int regTempRowid; /* Register to hold temp table ROWID */
720 int addrL; /* Label "L" */
722 srcTab = pParse->nTab++;
723 regRec = sqlite3GetTempReg(pParse);
724 regTempRowid = sqlite3GetTempReg(pParse);
725 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, srcTab, nColumn);
726 addrL = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm); VdbeCoverage(v);
727 sqlite3VdbeAddOp3(v, OP_MakeRecord, regFromSelect, nColumn, regRec);
728 sqlite3VdbeAddOp2(v, OP_NewRowid, srcTab, regTempRowid);
729 sqlite3VdbeAddOp3(v, OP_Insert, srcTab, regRec, regTempRowid);
730 sqlite3VdbeGoto(v, addrL);
731 sqlite3VdbeJumpHere(v, addrL);
732 sqlite3ReleaseTempReg(pParse, regRec);
733 sqlite3ReleaseTempReg(pParse, regTempRowid);
735 }else{
736 /* This is the case if the data for the INSERT is coming from a
737 ** single-row VALUES clause
739 NameContext sNC;
740 memset(&sNC, 0, sizeof(sNC));
741 sNC.pParse = pParse;
742 srcTab = -1;
743 assert( useTempTable==0 );
744 if( pList ){
745 nColumn = pList->nExpr;
746 if( sqlite3ResolveExprListNames(&sNC, pList) ){
747 goto insert_cleanup;
749 }else{
750 nColumn = 0;
754 /* If there is no IDLIST term but the table has an integer primary
755 ** key, the set the ipkColumn variable to the integer primary key
756 ** column index in the original table definition.
758 if( pColumn==0 && nColumn>0 ){
759 ipkColumn = pTab->iPKey;
762 /* Make sure the number of columns in the source data matches the number
763 ** of columns to be inserted into the table.
765 for(i=0; i<pTab->nCol; i++){
766 nHidden += (IsHiddenColumn(&pTab->aCol[i]) ? 1 : 0);
768 if( pColumn==0 && nColumn && nColumn!=(pTab->nCol-nHidden) ){
769 sqlite3ErrorMsg(pParse,
770 "table %S has %d columns but %d values were supplied",
771 pTabList, 0, pTab->nCol-nHidden, nColumn);
772 goto insert_cleanup;
774 if( pColumn!=0 && nColumn!=pColumn->nId ){
775 sqlite3ErrorMsg(pParse, "%d values for %d columns", nColumn, pColumn->nId);
776 goto insert_cleanup;
779 /* Initialize the count of rows to be inserted
781 if( db->flags & SQLITE_CountRows ){
782 regRowCount = ++pParse->nMem;
783 sqlite3VdbeAddOp2(v, OP_Integer, 0, regRowCount);
786 /* If this is not a view, open the table and and all indices */
787 if( !isView ){
788 int nIdx;
789 nIdx = sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, 0, -1, 0,
790 &iDataCur, &iIdxCur);
791 aRegIdx = sqlite3DbMallocRawNN(db, sizeof(int)*(nIdx+1));
792 if( aRegIdx==0 ){
793 goto insert_cleanup;
795 for(i=0; i<nIdx; i++){
796 aRegIdx[i] = ++pParse->nMem;
800 /* This is the top of the main insertion loop */
801 if( useTempTable ){
802 /* This block codes the top of loop only. The complete loop is the
803 ** following pseudocode (template 4):
805 ** rewind temp table, if empty goto D
806 ** C: loop over rows of intermediate table
807 ** transfer values form intermediate table into <table>
808 ** end loop
809 ** D: ...
811 addrInsTop = sqlite3VdbeAddOp1(v, OP_Rewind, srcTab); VdbeCoverage(v);
812 addrCont = sqlite3VdbeCurrentAddr(v);
813 }else if( pSelect ){
814 /* This block codes the top of loop only. The complete loop is the
815 ** following pseudocode (template 3):
817 ** C: yield X, at EOF goto D
818 ** insert the select result into <table> from R..R+n
819 ** goto C
820 ** D: ...
822 addrInsTop = addrCont = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm);
823 VdbeCoverage(v);
826 /* Run the BEFORE and INSTEAD OF triggers, if there are any
828 endOfLoop = sqlite3VdbeMakeLabel(v);
829 if( tmask & TRIGGER_BEFORE ){
830 int regCols = sqlite3GetTempRange(pParse, pTab->nCol+1);
832 /* build the NEW.* reference row. Note that if there is an INTEGER
833 ** PRIMARY KEY into which a NULL is being inserted, that NULL will be
834 ** translated into a unique ID for the row. But on a BEFORE trigger,
835 ** we do not know what the unique ID will be (because the insert has
836 ** not happened yet) so we substitute a rowid of -1
838 if( ipkColumn<0 ){
839 sqlite3VdbeAddOp2(v, OP_Integer, -1, regCols);
840 }else{
841 int addr1;
842 assert( !withoutRowid );
843 if( useTempTable ){
844 sqlite3VdbeAddOp3(v, OP_Column, srcTab, ipkColumn, regCols);
845 }else{
846 assert( pSelect==0 ); /* Otherwise useTempTable is true */
847 sqlite3ExprCode(pParse, pList->a[ipkColumn].pExpr, regCols);
849 addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, regCols); VdbeCoverage(v);
850 sqlite3VdbeAddOp2(v, OP_Integer, -1, regCols);
851 sqlite3VdbeJumpHere(v, addr1);
852 sqlite3VdbeAddOp1(v, OP_MustBeInt, regCols); VdbeCoverage(v);
855 /* Cannot have triggers on a virtual table. If it were possible,
856 ** this block would have to account for hidden column.
858 assert( !IsVirtual(pTab) );
860 /* Create the new column data
862 for(i=j=0; i<pTab->nCol; i++){
863 if( pColumn ){
864 for(j=0; j<pColumn->nId; j++){
865 if( pColumn->a[j].idx==i ) break;
868 if( (!useTempTable && !pList) || (pColumn && j>=pColumn->nId)
869 || (pColumn==0 && IsOrdinaryHiddenColumn(&pTab->aCol[i])) ){
870 sqlite3ExprCode(pParse, pTab->aCol[i].pDflt, regCols+i+1);
871 }else if( useTempTable ){
872 sqlite3VdbeAddOp3(v, OP_Column, srcTab, j, regCols+i+1);
873 }else{
874 assert( pSelect==0 ); /* Otherwise useTempTable is true */
875 sqlite3ExprCodeAndCache(pParse, pList->a[j].pExpr, regCols+i+1);
877 if( pColumn==0 && !IsOrdinaryHiddenColumn(&pTab->aCol[i]) ) j++;
880 /* If this is an INSERT on a view with an INSTEAD OF INSERT trigger,
881 ** do not attempt any conversions before assembling the record.
882 ** If this is a real table, attempt conversions as required by the
883 ** table column affinities.
885 if( !isView ){
886 sqlite3TableAffinity(v, pTab, regCols+1);
889 /* Fire BEFORE or INSTEAD OF triggers */
890 sqlite3CodeRowTrigger(pParse, pTrigger, TK_INSERT, 0, TRIGGER_BEFORE,
891 pTab, regCols-pTab->nCol-1, onError, endOfLoop);
893 sqlite3ReleaseTempRange(pParse, regCols, pTab->nCol+1);
896 /* Compute the content of the next row to insert into a range of
897 ** registers beginning at regIns.
899 if( !isView ){
900 if( IsVirtual(pTab) ){
901 /* The row that the VUpdate opcode will delete: none */
902 sqlite3VdbeAddOp2(v, OP_Null, 0, regIns);
904 if( ipkColumn>=0 ){
905 if( useTempTable ){
906 sqlite3VdbeAddOp3(v, OP_Column, srcTab, ipkColumn, regRowid);
907 }else if( pSelect ){
908 sqlite3VdbeAddOp2(v, OP_Copy, regFromSelect+ipkColumn, regRowid);
909 }else{
910 VdbeOp *pOp;
911 sqlite3ExprCode(pParse, pList->a[ipkColumn].pExpr, regRowid);
912 pOp = sqlite3VdbeGetOp(v, -1);
913 if( ALWAYS(pOp) && pOp->opcode==OP_Null && !IsVirtual(pTab) ){
914 appendFlag = 1;
915 pOp->opcode = OP_NewRowid;
916 pOp->p1 = iDataCur;
917 pOp->p2 = regRowid;
918 pOp->p3 = regAutoinc;
921 /* If the PRIMARY KEY expression is NULL, then use OP_NewRowid
922 ** to generate a unique primary key value.
924 if( !appendFlag ){
925 int addr1;
926 if( !IsVirtual(pTab) ){
927 addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, regRowid); VdbeCoverage(v);
928 sqlite3VdbeAddOp3(v, OP_NewRowid, iDataCur, regRowid, regAutoinc);
929 sqlite3VdbeJumpHere(v, addr1);
930 }else{
931 addr1 = sqlite3VdbeCurrentAddr(v);
932 sqlite3VdbeAddOp2(v, OP_IsNull, regRowid, addr1+2); VdbeCoverage(v);
934 sqlite3VdbeAddOp1(v, OP_MustBeInt, regRowid); VdbeCoverage(v);
936 }else if( IsVirtual(pTab) || withoutRowid ){
937 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowid);
938 }else{
939 sqlite3VdbeAddOp3(v, OP_NewRowid, iDataCur, regRowid, regAutoinc);
940 appendFlag = 1;
942 autoIncStep(pParse, regAutoinc, regRowid);
944 /* Compute data for all columns of the new entry, beginning
945 ** with the first column.
947 nHidden = 0;
948 for(i=0; i<pTab->nCol; i++){
949 int iRegStore = regRowid+1+i;
950 if( i==pTab->iPKey ){
951 /* The value of the INTEGER PRIMARY KEY column is always a NULL.
952 ** Whenever this column is read, the rowid will be substituted
953 ** in its place. Hence, fill this column with a NULL to avoid
954 ** taking up data space with information that will never be used.
955 ** As there may be shallow copies of this value, make it a soft-NULL */
956 sqlite3VdbeAddOp1(v, OP_SoftNull, iRegStore);
957 continue;
959 if( pColumn==0 ){
960 if( IsHiddenColumn(&pTab->aCol[i]) ){
961 j = -1;
962 nHidden++;
963 }else{
964 j = i - nHidden;
966 }else{
967 for(j=0; j<pColumn->nId; j++){
968 if( pColumn->a[j].idx==i ) break;
971 if( j<0 || nColumn==0 || (pColumn && j>=pColumn->nId) ){
972 sqlite3ExprCodeFactorable(pParse, pTab->aCol[i].pDflt, iRegStore);
973 }else if( useTempTable ){
974 sqlite3VdbeAddOp3(v, OP_Column, srcTab, j, iRegStore);
975 }else if( pSelect ){
976 if( regFromSelect!=regData ){
977 sqlite3VdbeAddOp2(v, OP_SCopy, regFromSelect+j, iRegStore);
979 }else{
980 sqlite3ExprCode(pParse, pList->a[j].pExpr, iRegStore);
984 /* Generate code to check constraints and generate index keys and
985 ** do the insertion.
987 #ifndef SQLITE_OMIT_VIRTUALTABLE
988 if( IsVirtual(pTab) ){
989 const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
990 sqlite3VtabMakeWritable(pParse, pTab);
991 sqlite3VdbeAddOp4(v, OP_VUpdate, 1, pTab->nCol+2, regIns, pVTab, P4_VTAB);
992 sqlite3VdbeChangeP5(v, onError==OE_Default ? OE_Abort : onError);
993 sqlite3MayAbort(pParse);
994 }else
995 #endif
997 int isReplace; /* Set to true if constraints may cause a replace */
998 sqlite3GenerateConstraintChecks(pParse, pTab, aRegIdx, iDataCur, iIdxCur,
999 regIns, 0, ipkColumn>=0, onError, endOfLoop, &isReplace, 0
1001 sqlite3FkCheck(pParse, pTab, 0, regIns, 0, 0);
1002 sqlite3CompleteInsertion(pParse, pTab, iDataCur, iIdxCur,
1003 regIns, aRegIdx, 0, appendFlag, isReplace==0);
1007 /* Update the count of rows that are inserted
1009 if( (db->flags & SQLITE_CountRows)!=0 ){
1010 sqlite3VdbeAddOp2(v, OP_AddImm, regRowCount, 1);
1013 if( pTrigger ){
1014 /* Code AFTER triggers */
1015 sqlite3CodeRowTrigger(pParse, pTrigger, TK_INSERT, 0, TRIGGER_AFTER,
1016 pTab, regData-2-pTab->nCol, onError, endOfLoop);
1019 /* The bottom of the main insertion loop, if the data source
1020 ** is a SELECT statement.
1022 sqlite3VdbeResolveLabel(v, endOfLoop);
1023 if( useTempTable ){
1024 sqlite3VdbeAddOp2(v, OP_Next, srcTab, addrCont); VdbeCoverage(v);
1025 sqlite3VdbeJumpHere(v, addrInsTop);
1026 sqlite3VdbeAddOp1(v, OP_Close, srcTab);
1027 }else if( pSelect ){
1028 sqlite3VdbeGoto(v, addrCont);
1029 sqlite3VdbeJumpHere(v, addrInsTop);
1032 if( !IsVirtual(pTab) && !isView ){
1033 /* Close all tables opened */
1034 if( iDataCur<iIdxCur ) sqlite3VdbeAddOp1(v, OP_Close, iDataCur);
1035 for(idx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, idx++){
1036 sqlite3VdbeAddOp1(v, OP_Close, idx+iIdxCur);
1040 insert_end:
1041 /* Update the sqlite_sequence table by storing the content of the
1042 ** maximum rowid counter values recorded while inserting into
1043 ** autoincrement tables.
1045 if( pParse->nested==0 && pParse->pTriggerTab==0 ){
1046 sqlite3AutoincrementEnd(pParse);
1050 ** Return the number of rows inserted. If this routine is
1051 ** generating code because of a call to sqlite3NestedParse(), do not
1052 ** invoke the callback function.
1054 if( (db->flags&SQLITE_CountRows) && !pParse->nested && !pParse->pTriggerTab ){
1055 sqlite3VdbeAddOp2(v, OP_ResultRow, regRowCount, 1);
1056 sqlite3VdbeSetNumCols(v, 1);
1057 sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows inserted", SQLITE_STATIC);
1060 insert_cleanup:
1061 sqlite3SrcListDelete(db, pTabList);
1062 sqlite3ExprListDelete(db, pList);
1063 sqlite3SelectDelete(db, pSelect);
1064 sqlite3IdListDelete(db, pColumn);
1065 sqlite3DbFree(db, aRegIdx);
1068 /* Make sure "isView" and other macros defined above are undefined. Otherwise
1069 ** they may interfere with compilation of other functions in this file
1070 ** (or in another file, if this file becomes part of the amalgamation). */
1071 #ifdef isView
1072 #undef isView
1073 #endif
1074 #ifdef pTrigger
1075 #undef pTrigger
1076 #endif
1077 #ifdef tmask
1078 #undef tmask
1079 #endif
1082 ** Meanings of bits in of pWalker->eCode for checkConstraintUnchanged()
1084 #define CKCNSTRNT_COLUMN 0x01 /* CHECK constraint uses a changing column */
1085 #define CKCNSTRNT_ROWID 0x02 /* CHECK constraint references the ROWID */
1087 /* This is the Walker callback from checkConstraintUnchanged(). Set
1088 ** bit 0x01 of pWalker->eCode if
1089 ** pWalker->eCode to 0 if this expression node references any of the
1090 ** columns that are being modifed by an UPDATE statement.
1092 static int checkConstraintExprNode(Walker *pWalker, Expr *pExpr){
1093 if( pExpr->op==TK_COLUMN ){
1094 assert( pExpr->iColumn>=0 || pExpr->iColumn==-1 );
1095 if( pExpr->iColumn>=0 ){
1096 if( pWalker->u.aiCol[pExpr->iColumn]>=0 ){
1097 pWalker->eCode |= CKCNSTRNT_COLUMN;
1099 }else{
1100 pWalker->eCode |= CKCNSTRNT_ROWID;
1103 return WRC_Continue;
1107 ** pExpr is a CHECK constraint on a row that is being UPDATE-ed. The
1108 ** only columns that are modified by the UPDATE are those for which
1109 ** aiChng[i]>=0, and also the ROWID is modified if chngRowid is true.
1111 ** Return true if CHECK constraint pExpr does not use any of the
1112 ** changing columns (or the rowid if it is changing). In other words,
1113 ** return true if this CHECK constraint can be skipped when validating
1114 ** the new row in the UPDATE statement.
1116 static int checkConstraintUnchanged(Expr *pExpr, int *aiChng, int chngRowid){
1117 Walker w;
1118 memset(&w, 0, sizeof(w));
1119 w.eCode = 0;
1120 w.xExprCallback = checkConstraintExprNode;
1121 w.u.aiCol = aiChng;
1122 sqlite3WalkExpr(&w, pExpr);
1123 if( !chngRowid ){
1124 testcase( (w.eCode & CKCNSTRNT_ROWID)!=0 );
1125 w.eCode &= ~CKCNSTRNT_ROWID;
1127 testcase( w.eCode==0 );
1128 testcase( w.eCode==CKCNSTRNT_COLUMN );
1129 testcase( w.eCode==CKCNSTRNT_ROWID );
1130 testcase( w.eCode==(CKCNSTRNT_ROWID|CKCNSTRNT_COLUMN) );
1131 return !w.eCode;
1135 ** Generate code to do constraint checks prior to an INSERT or an UPDATE
1136 ** on table pTab.
1138 ** The regNewData parameter is the first register in a range that contains
1139 ** the data to be inserted or the data after the update. There will be
1140 ** pTab->nCol+1 registers in this range. The first register (the one
1141 ** that regNewData points to) will contain the new rowid, or NULL in the
1142 ** case of a WITHOUT ROWID table. The second register in the range will
1143 ** contain the content of the first table column. The third register will
1144 ** contain the content of the second table column. And so forth.
1146 ** The regOldData parameter is similar to regNewData except that it contains
1147 ** the data prior to an UPDATE rather than afterwards. regOldData is zero
1148 ** for an INSERT. This routine can distinguish between UPDATE and INSERT by
1149 ** checking regOldData for zero.
1151 ** For an UPDATE, the pkChng boolean is true if the true primary key (the
1152 ** rowid for a normal table or the PRIMARY KEY for a WITHOUT ROWID table)
1153 ** might be modified by the UPDATE. If pkChng is false, then the key of
1154 ** the iDataCur content table is guaranteed to be unchanged by the UPDATE.
1156 ** For an INSERT, the pkChng boolean indicates whether or not the rowid
1157 ** was explicitly specified as part of the INSERT statement. If pkChng
1158 ** is zero, it means that the either rowid is computed automatically or
1159 ** that the table is a WITHOUT ROWID table and has no rowid. On an INSERT,
1160 ** pkChng will only be true if the INSERT statement provides an integer
1161 ** value for either the rowid column or its INTEGER PRIMARY KEY alias.
1163 ** The code generated by this routine will store new index entries into
1164 ** registers identified by aRegIdx[]. No index entry is created for
1165 ** indices where aRegIdx[i]==0. The order of indices in aRegIdx[] is
1166 ** the same as the order of indices on the linked list of indices
1167 ** at pTab->pIndex.
1169 ** The caller must have already opened writeable cursors on the main
1170 ** table and all applicable indices (that is to say, all indices for which
1171 ** aRegIdx[] is not zero). iDataCur is the cursor for the main table when
1172 ** inserting or updating a rowid table, or the cursor for the PRIMARY KEY
1173 ** index when operating on a WITHOUT ROWID table. iIdxCur is the cursor
1174 ** for the first index in the pTab->pIndex list. Cursors for other indices
1175 ** are at iIdxCur+N for the N-th element of the pTab->pIndex list.
1177 ** This routine also generates code to check constraints. NOT NULL,
1178 ** CHECK, and UNIQUE constraints are all checked. If a constraint fails,
1179 ** then the appropriate action is performed. There are five possible
1180 ** actions: ROLLBACK, ABORT, FAIL, REPLACE, and IGNORE.
1182 ** Constraint type Action What Happens
1183 ** --------------- ---------- ----------------------------------------
1184 ** any ROLLBACK The current transaction is rolled back and
1185 ** sqlite3_step() returns immediately with a
1186 ** return code of SQLITE_CONSTRAINT.
1188 ** any ABORT Back out changes from the current command
1189 ** only (do not do a complete rollback) then
1190 ** cause sqlite3_step() to return immediately
1191 ** with SQLITE_CONSTRAINT.
1193 ** any FAIL Sqlite3_step() returns immediately with a
1194 ** return code of SQLITE_CONSTRAINT. The
1195 ** transaction is not rolled back and any
1196 ** changes to prior rows are retained.
1198 ** any IGNORE The attempt in insert or update the current
1199 ** row is skipped, without throwing an error.
1200 ** Processing continues with the next row.
1201 ** (There is an immediate jump to ignoreDest.)
1203 ** NOT NULL REPLACE The NULL value is replace by the default
1204 ** value for that column. If the default value
1205 ** is NULL, the action is the same as ABORT.
1207 ** UNIQUE REPLACE The other row that conflicts with the row
1208 ** being inserted is removed.
1210 ** CHECK REPLACE Illegal. The results in an exception.
1212 ** Which action to take is determined by the overrideError parameter.
1213 ** Or if overrideError==OE_Default, then the pParse->onError parameter
1214 ** is used. Or if pParse->onError==OE_Default then the onError value
1215 ** for the constraint is used.
1217 void sqlite3GenerateConstraintChecks(
1218 Parse *pParse, /* The parser context */
1219 Table *pTab, /* The table being inserted or updated */
1220 int *aRegIdx, /* Use register aRegIdx[i] for index i. 0 for unused */
1221 int iDataCur, /* Canonical data cursor (main table or PK index) */
1222 int iIdxCur, /* First index cursor */
1223 int regNewData, /* First register in a range holding values to insert */
1224 int regOldData, /* Previous content. 0 for INSERTs */
1225 u8 pkChng, /* Non-zero if the rowid or PRIMARY KEY changed */
1226 u8 overrideError, /* Override onError to this if not OE_Default */
1227 int ignoreDest, /* Jump to this label on an OE_Ignore resolution */
1228 int *pbMayReplace, /* OUT: Set to true if constraint may cause a replace */
1229 int *aiChng /* column i is unchanged if aiChng[i]<0 */
1231 Vdbe *v; /* VDBE under constrution */
1232 Index *pIdx; /* Pointer to one of the indices */
1233 Index *pPk = 0; /* The PRIMARY KEY index */
1234 sqlite3 *db; /* Database connection */
1235 int i; /* loop counter */
1236 int ix; /* Index loop counter */
1237 int nCol; /* Number of columns */
1238 int onError; /* Conflict resolution strategy */
1239 int addr1; /* Address of jump instruction */
1240 int seenReplace = 0; /* True if REPLACE is used to resolve INT PK conflict */
1241 int nPkField; /* Number of fields in PRIMARY KEY. 1 for ROWID tables */
1242 int ipkTop = 0; /* Top of the rowid change constraint check */
1243 int ipkBottom = 0; /* Bottom of the rowid change constraint check */
1244 u8 isUpdate; /* True if this is an UPDATE operation */
1245 u8 bAffinityDone = 0; /* True if the OP_Affinity operation has been run */
1246 int regRowid = -1; /* Register holding ROWID value */
1248 isUpdate = regOldData!=0;
1249 db = pParse->db;
1250 v = sqlite3GetVdbe(pParse);
1251 assert( v!=0 );
1252 assert( pTab->pSelect==0 ); /* This table is not a VIEW */
1253 nCol = pTab->nCol;
1255 /* pPk is the PRIMARY KEY index for WITHOUT ROWID tables and NULL for
1256 ** normal rowid tables. nPkField is the number of key fields in the
1257 ** pPk index or 1 for a rowid table. In other words, nPkField is the
1258 ** number of fields in the true primary key of the table. */
1259 if( HasRowid(pTab) ){
1260 pPk = 0;
1261 nPkField = 1;
1262 }else{
1263 pPk = sqlite3PrimaryKeyIndex(pTab);
1264 nPkField = pPk->nKeyCol;
1267 /* Record that this module has started */
1268 VdbeModuleComment((v, "BEGIN: GenCnstCks(%d,%d,%d,%d,%d)",
1269 iDataCur, iIdxCur, regNewData, regOldData, pkChng));
1271 /* Test all NOT NULL constraints.
1273 for(i=0; i<nCol; i++){
1274 if( i==pTab->iPKey ){
1275 continue; /* ROWID is never NULL */
1277 if( aiChng && aiChng[i]<0 ){
1278 /* Don't bother checking for NOT NULL on columns that do not change */
1279 continue;
1281 onError = pTab->aCol[i].notNull;
1282 if( onError==OE_None ) continue; /* This column is allowed to be NULL */
1283 if( overrideError!=OE_Default ){
1284 onError = overrideError;
1285 }else if( onError==OE_Default ){
1286 onError = OE_Abort;
1288 if( onError==OE_Replace && pTab->aCol[i].pDflt==0 ){
1289 onError = OE_Abort;
1291 assert( onError==OE_Rollback || onError==OE_Abort || onError==OE_Fail
1292 || onError==OE_Ignore || onError==OE_Replace );
1293 switch( onError ){
1294 case OE_Abort:
1295 sqlite3MayAbort(pParse);
1296 /* Fall through */
1297 case OE_Rollback:
1298 case OE_Fail: {
1299 char *zMsg = sqlite3MPrintf(db, "%s.%s", pTab->zName,
1300 pTab->aCol[i].zName);
1301 sqlite3VdbeAddOp4(v, OP_HaltIfNull, SQLITE_CONSTRAINT_NOTNULL, onError,
1302 regNewData+1+i, zMsg, P4_DYNAMIC);
1303 sqlite3VdbeChangeP5(v, P5_ConstraintNotNull);
1304 VdbeCoverage(v);
1305 break;
1307 case OE_Ignore: {
1308 sqlite3VdbeAddOp2(v, OP_IsNull, regNewData+1+i, ignoreDest);
1309 VdbeCoverage(v);
1310 break;
1312 default: {
1313 assert( onError==OE_Replace );
1314 addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, regNewData+1+i);
1315 VdbeCoverage(v);
1316 sqlite3ExprCode(pParse, pTab->aCol[i].pDflt, regNewData+1+i);
1317 sqlite3VdbeJumpHere(v, addr1);
1318 break;
1323 /* Test all CHECK constraints
1325 #ifndef SQLITE_OMIT_CHECK
1326 if( pTab->pCheck && (db->flags & SQLITE_IgnoreChecks)==0 ){
1327 ExprList *pCheck = pTab->pCheck;
1328 pParse->ckBase = regNewData+1;
1329 onError = overrideError!=OE_Default ? overrideError : OE_Abort;
1330 for(i=0; i<pCheck->nExpr; i++){
1331 int allOk;
1332 Expr *pExpr = pCheck->a[i].pExpr;
1333 if( aiChng && checkConstraintUnchanged(pExpr, aiChng, pkChng) ) continue;
1334 allOk = sqlite3VdbeMakeLabel(v);
1335 sqlite3ExprIfTrue(pParse, pExpr, allOk, SQLITE_JUMPIFNULL);
1336 if( onError==OE_Ignore ){
1337 sqlite3VdbeGoto(v, ignoreDest);
1338 }else{
1339 char *zName = pCheck->a[i].zName;
1340 if( zName==0 ) zName = pTab->zName;
1341 if( onError==OE_Replace ) onError = OE_Abort; /* IMP: R-15569-63625 */
1342 sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_CHECK,
1343 onError, zName, P4_TRANSIENT,
1344 P5_ConstraintCheck);
1346 sqlite3VdbeResolveLabel(v, allOk);
1349 #endif /* !defined(SQLITE_OMIT_CHECK) */
1351 /* If rowid is changing, make sure the new rowid does not previously
1352 ** exist in the table.
1354 if( pkChng && pPk==0 ){
1355 int addrRowidOk = sqlite3VdbeMakeLabel(v);
1357 /* Figure out what action to take in case of a rowid collision */
1358 onError = pTab->keyConf;
1359 if( overrideError!=OE_Default ){
1360 onError = overrideError;
1361 }else if( onError==OE_Default ){
1362 onError = OE_Abort;
1365 if( isUpdate ){
1366 /* pkChng!=0 does not mean that the rowid has change, only that
1367 ** it might have changed. Skip the conflict logic below if the rowid
1368 ** is unchanged. */
1369 sqlite3VdbeAddOp3(v, OP_Eq, regNewData, addrRowidOk, regOldData);
1370 sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
1371 VdbeCoverage(v);
1374 /* If the response to a rowid conflict is REPLACE but the response
1375 ** to some other UNIQUE constraint is FAIL or IGNORE, then we need
1376 ** to defer the running of the rowid conflict checking until after
1377 ** the UNIQUE constraints have run.
1379 if( onError==OE_Replace && overrideError!=OE_Replace ){
1380 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1381 if( pIdx->onError==OE_Ignore || pIdx->onError==OE_Fail ){
1382 ipkTop = sqlite3VdbeAddOp0(v, OP_Goto);
1383 break;
1388 /* Check to see if the new rowid already exists in the table. Skip
1389 ** the following conflict logic if it does not. */
1390 sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, addrRowidOk, regNewData);
1391 VdbeCoverage(v);
1393 /* Generate code that deals with a rowid collision */
1394 switch( onError ){
1395 default: {
1396 onError = OE_Abort;
1397 /* Fall thru into the next case */
1399 case OE_Rollback:
1400 case OE_Abort:
1401 case OE_Fail: {
1402 sqlite3RowidConstraint(pParse, onError, pTab);
1403 break;
1405 case OE_Replace: {
1406 /* If there are DELETE triggers on this table and the
1407 ** recursive-triggers flag is set, call GenerateRowDelete() to
1408 ** remove the conflicting row from the table. This will fire
1409 ** the triggers and remove both the table and index b-tree entries.
1411 ** Otherwise, if there are no triggers or the recursive-triggers
1412 ** flag is not set, but the table has one or more indexes, call
1413 ** GenerateRowIndexDelete(). This removes the index b-tree entries
1414 ** only. The table b-tree entry will be replaced by the new entry
1415 ** when it is inserted.
1417 ** If either GenerateRowDelete() or GenerateRowIndexDelete() is called,
1418 ** also invoke MultiWrite() to indicate that this VDBE may require
1419 ** statement rollback (if the statement is aborted after the delete
1420 ** takes place). Earlier versions called sqlite3MultiWrite() regardless,
1421 ** but being more selective here allows statements like:
1423 ** REPLACE INTO t(rowid) VALUES($newrowid)
1425 ** to run without a statement journal if there are no indexes on the
1426 ** table.
1428 Trigger *pTrigger = 0;
1429 if( db->flags&SQLITE_RecTriggers ){
1430 pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
1432 if( pTrigger || sqlite3FkRequired(pParse, pTab, 0, 0) ){
1433 sqlite3MultiWrite(pParse);
1434 sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
1435 regNewData, 1, 0, OE_Replace, 1, -1);
1436 }else{
1437 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1438 if( HasRowid(pTab) ){
1439 /* This OP_Delete opcode fires the pre-update-hook only. It does
1440 ** not modify the b-tree. It is more efficient to let the coming
1441 ** OP_Insert replace the existing entry than it is to delete the
1442 ** existing entry and then insert a new one. */
1443 sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, OPFLAG_ISNOOP);
1444 sqlite3VdbeChangeP4(v, -1, (char *)pTab, P4_TABLE);
1446 #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
1447 if( pTab->pIndex ){
1448 sqlite3MultiWrite(pParse);
1449 sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur,0,-1);
1452 seenReplace = 1;
1453 break;
1455 case OE_Ignore: {
1456 /*assert( seenReplace==0 );*/
1457 sqlite3VdbeGoto(v, ignoreDest);
1458 break;
1461 sqlite3VdbeResolveLabel(v, addrRowidOk);
1462 if( ipkTop ){
1463 ipkBottom = sqlite3VdbeAddOp0(v, OP_Goto);
1464 sqlite3VdbeJumpHere(v, ipkTop);
1468 /* Test all UNIQUE constraints by creating entries for each UNIQUE
1469 ** index and making sure that duplicate entries do not already exist.
1470 ** Compute the revised record entries for indices as we go.
1472 ** This loop also handles the case of the PRIMARY KEY index for a
1473 ** WITHOUT ROWID table.
1475 for(ix=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, ix++){
1476 int regIdx; /* Range of registers hold conent for pIdx */
1477 int regR; /* Range of registers holding conflicting PK */
1478 int iThisCur; /* Cursor for this UNIQUE index */
1479 int addrUniqueOk; /* Jump here if the UNIQUE constraint is satisfied */
1481 if( aRegIdx[ix]==0 ) continue; /* Skip indices that do not change */
1482 if( bAffinityDone==0 ){
1483 sqlite3TableAffinity(v, pTab, regNewData+1);
1484 bAffinityDone = 1;
1486 iThisCur = iIdxCur+ix;
1487 addrUniqueOk = sqlite3VdbeMakeLabel(v);
1489 /* Skip partial indices for which the WHERE clause is not true */
1490 if( pIdx->pPartIdxWhere ){
1491 sqlite3VdbeAddOp2(v, OP_Null, 0, aRegIdx[ix]);
1492 pParse->ckBase = regNewData+1;
1493 sqlite3ExprIfFalseDup(pParse, pIdx->pPartIdxWhere, addrUniqueOk,
1494 SQLITE_JUMPIFNULL);
1495 pParse->ckBase = 0;
1498 /* Create a record for this index entry as it should appear after
1499 ** the insert or update. Store that record in the aRegIdx[ix] register
1501 regIdx = sqlite3GetTempRange(pParse, pIdx->nColumn);
1502 for(i=0; i<pIdx->nColumn; i++){
1503 int iField = pIdx->aiColumn[i];
1504 int x;
1505 if( iField==XN_EXPR ){
1506 pParse->ckBase = regNewData+1;
1507 sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[i].pExpr, regIdx+i);
1508 pParse->ckBase = 0;
1509 VdbeComment((v, "%s column %d", pIdx->zName, i));
1510 }else{
1511 if( iField==XN_ROWID || iField==pTab->iPKey ){
1512 if( regRowid==regIdx+i ) continue; /* ROWID already in regIdx+i */
1513 x = regNewData;
1514 regRowid = pIdx->pPartIdxWhere ? -1 : regIdx+i;
1515 }else{
1516 x = iField + regNewData + 1;
1518 sqlite3VdbeAddOp2(v, iField<0 ? OP_IntCopy : OP_SCopy, x, regIdx+i);
1519 VdbeComment((v, "%s", iField<0 ? "rowid" : pTab->aCol[iField].zName));
1522 sqlite3VdbeAddOp3(v, OP_MakeRecord, regIdx, pIdx->nColumn, aRegIdx[ix]);
1523 VdbeComment((v, "for %s", pIdx->zName));
1524 sqlite3ExprCacheAffinityChange(pParse, regIdx, pIdx->nColumn);
1526 /* In an UPDATE operation, if this index is the PRIMARY KEY index
1527 ** of a WITHOUT ROWID table and there has been no change the
1528 ** primary key, then no collision is possible. The collision detection
1529 ** logic below can all be skipped. */
1530 if( isUpdate && pPk==pIdx && pkChng==0 ){
1531 sqlite3VdbeResolveLabel(v, addrUniqueOk);
1532 continue;
1535 /* Find out what action to take in case there is a uniqueness conflict */
1536 onError = pIdx->onError;
1537 if( onError==OE_None ){
1538 sqlite3ReleaseTempRange(pParse, regIdx, pIdx->nColumn);
1539 sqlite3VdbeResolveLabel(v, addrUniqueOk);
1540 continue; /* pIdx is not a UNIQUE index */
1542 if( overrideError!=OE_Default ){
1543 onError = overrideError;
1544 }else if( onError==OE_Default ){
1545 onError = OE_Abort;
1548 /* Check to see if the new index entry will be unique */
1549 sqlite3VdbeAddOp4Int(v, OP_NoConflict, iThisCur, addrUniqueOk,
1550 regIdx, pIdx->nKeyCol); VdbeCoverage(v);
1552 /* Generate code to handle collisions */
1553 regR = (pIdx==pPk) ? regIdx : sqlite3GetTempRange(pParse, nPkField);
1554 if( isUpdate || onError==OE_Replace ){
1555 if( HasRowid(pTab) ){
1556 sqlite3VdbeAddOp2(v, OP_IdxRowid, iThisCur, regR);
1557 /* Conflict only if the rowid of the existing index entry
1558 ** is different from old-rowid */
1559 if( isUpdate ){
1560 sqlite3VdbeAddOp3(v, OP_Eq, regR, addrUniqueOk, regOldData);
1561 sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
1562 VdbeCoverage(v);
1564 }else{
1565 int x;
1566 /* Extract the PRIMARY KEY from the end of the index entry and
1567 ** store it in registers regR..regR+nPk-1 */
1568 if( pIdx!=pPk ){
1569 for(i=0; i<pPk->nKeyCol; i++){
1570 assert( pPk->aiColumn[i]>=0 );
1571 x = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[i]);
1572 sqlite3VdbeAddOp3(v, OP_Column, iThisCur, x, regR+i);
1573 VdbeComment((v, "%s.%s", pTab->zName,
1574 pTab->aCol[pPk->aiColumn[i]].zName));
1577 if( isUpdate ){
1578 /* If currently processing the PRIMARY KEY of a WITHOUT ROWID
1579 ** table, only conflict if the new PRIMARY KEY values are actually
1580 ** different from the old.
1582 ** For a UNIQUE index, only conflict if the PRIMARY KEY values
1583 ** of the matched index row are different from the original PRIMARY
1584 ** KEY values of this row before the update. */
1585 int addrJump = sqlite3VdbeCurrentAddr(v)+pPk->nKeyCol;
1586 int op = OP_Ne;
1587 int regCmp = (IsPrimaryKeyIndex(pIdx) ? regIdx : regR);
1589 for(i=0; i<pPk->nKeyCol; i++){
1590 char *p4 = (char*)sqlite3LocateCollSeq(pParse, pPk->azColl[i]);
1591 x = pPk->aiColumn[i];
1592 assert( x>=0 );
1593 if( i==(pPk->nKeyCol-1) ){
1594 addrJump = addrUniqueOk;
1595 op = OP_Eq;
1597 sqlite3VdbeAddOp4(v, op,
1598 regOldData+1+x, addrJump, regCmp+i, p4, P4_COLLSEQ
1600 sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
1601 VdbeCoverageIf(v, op==OP_Eq);
1602 VdbeCoverageIf(v, op==OP_Ne);
1608 /* Generate code that executes if the new index entry is not unique */
1609 assert( onError==OE_Rollback || onError==OE_Abort || onError==OE_Fail
1610 || onError==OE_Ignore || onError==OE_Replace );
1611 switch( onError ){
1612 case OE_Rollback:
1613 case OE_Abort:
1614 case OE_Fail: {
1615 sqlite3UniqueConstraint(pParse, onError, pIdx);
1616 break;
1618 case OE_Ignore: {
1619 sqlite3VdbeGoto(v, ignoreDest);
1620 break;
1622 default: {
1623 Trigger *pTrigger = 0;
1624 assert( onError==OE_Replace );
1625 sqlite3MultiWrite(pParse);
1626 if( db->flags&SQLITE_RecTriggers ){
1627 pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
1629 sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
1630 regR, nPkField, 0, OE_Replace,
1631 (pIdx==pPk ? ONEPASS_SINGLE : ONEPASS_OFF), -1);
1632 seenReplace = 1;
1633 break;
1636 sqlite3VdbeResolveLabel(v, addrUniqueOk);
1637 sqlite3ReleaseTempRange(pParse, regIdx, pIdx->nColumn);
1638 if( regR!=regIdx ) sqlite3ReleaseTempRange(pParse, regR, nPkField);
1640 if( ipkTop ){
1641 sqlite3VdbeGoto(v, ipkTop+1);
1642 sqlite3VdbeJumpHere(v, ipkBottom);
1645 *pbMayReplace = seenReplace;
1646 VdbeModuleComment((v, "END: GenCnstCks(%d)", seenReplace));
1650 ** This routine generates code to finish the INSERT or UPDATE operation
1651 ** that was started by a prior call to sqlite3GenerateConstraintChecks.
1652 ** A consecutive range of registers starting at regNewData contains the
1653 ** rowid and the content to be inserted.
1655 ** The arguments to this routine should be the same as the first six
1656 ** arguments to sqlite3GenerateConstraintChecks.
1658 void sqlite3CompleteInsertion(
1659 Parse *pParse, /* The parser context */
1660 Table *pTab, /* the table into which we are inserting */
1661 int iDataCur, /* Cursor of the canonical data source */
1662 int iIdxCur, /* First index cursor */
1663 int regNewData, /* Range of content */
1664 int *aRegIdx, /* Register used by each index. 0 for unused indices */
1665 int isUpdate, /* True for UPDATE, False for INSERT */
1666 int appendBias, /* True if this is likely to be an append */
1667 int useSeekResult /* True to set the USESEEKRESULT flag on OP_[Idx]Insert */
1669 Vdbe *v; /* Prepared statements under construction */
1670 Index *pIdx; /* An index being inserted or updated */
1671 u8 pik_flags; /* flag values passed to the btree insert */
1672 int regData; /* Content registers (after the rowid) */
1673 int regRec; /* Register holding assembled record for the table */
1674 int i; /* Loop counter */
1675 u8 bAffinityDone = 0; /* True if OP_Affinity has been run already */
1677 v = sqlite3GetVdbe(pParse);
1678 assert( v!=0 );
1679 assert( pTab->pSelect==0 ); /* This table is not a VIEW */
1680 for(i=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, i++){
1681 if( aRegIdx[i]==0 ) continue;
1682 bAffinityDone = 1;
1683 if( pIdx->pPartIdxWhere ){
1684 sqlite3VdbeAddOp2(v, OP_IsNull, aRegIdx[i], sqlite3VdbeCurrentAddr(v)+2);
1685 VdbeCoverage(v);
1687 sqlite3VdbeAddOp2(v, OP_IdxInsert, iIdxCur+i, aRegIdx[i]);
1688 pik_flags = 0;
1689 if( useSeekResult ) pik_flags = OPFLAG_USESEEKRESULT;
1690 if( IsPrimaryKeyIndex(pIdx) && !HasRowid(pTab) ){
1691 assert( pParse->nested==0 );
1692 pik_flags |= OPFLAG_NCHANGE;
1694 sqlite3VdbeChangeP5(v, pik_flags);
1696 if( !HasRowid(pTab) ) return;
1697 regData = regNewData + 1;
1698 regRec = sqlite3GetTempReg(pParse);
1699 sqlite3VdbeAddOp3(v, OP_MakeRecord, regData, pTab->nCol, regRec);
1700 if( !bAffinityDone ) sqlite3TableAffinity(v, pTab, 0);
1701 sqlite3ExprCacheAffinityChange(pParse, regData, pTab->nCol);
1702 if( pParse->nested ){
1703 pik_flags = 0;
1704 }else{
1705 pik_flags = OPFLAG_NCHANGE;
1706 pik_flags |= (isUpdate?OPFLAG_ISUPDATE:OPFLAG_LASTROWID);
1708 if( appendBias ){
1709 pik_flags |= OPFLAG_APPEND;
1711 if( useSeekResult ){
1712 pik_flags |= OPFLAG_USESEEKRESULT;
1714 sqlite3VdbeAddOp3(v, OP_Insert, iDataCur, regRec, regNewData);
1715 if( !pParse->nested ){
1716 sqlite3VdbeChangeP4(v, -1, (char *)pTab, P4_TABLE);
1718 sqlite3VdbeChangeP5(v, pik_flags);
1722 ** Allocate cursors for the pTab table and all its indices and generate
1723 ** code to open and initialized those cursors.
1725 ** The cursor for the object that contains the complete data (normally
1726 ** the table itself, but the PRIMARY KEY index in the case of a WITHOUT
1727 ** ROWID table) is returned in *piDataCur. The first index cursor is
1728 ** returned in *piIdxCur. The number of indices is returned.
1730 ** Use iBase as the first cursor (either the *piDataCur for rowid tables
1731 ** or the first index for WITHOUT ROWID tables) if it is non-negative.
1732 ** If iBase is negative, then allocate the next available cursor.
1734 ** For a rowid table, *piDataCur will be exactly one less than *piIdxCur.
1735 ** For a WITHOUT ROWID table, *piDataCur will be somewhere in the range
1736 ** of *piIdxCurs, depending on where the PRIMARY KEY index appears on the
1737 ** pTab->pIndex list.
1739 ** If pTab is a virtual table, then this routine is a no-op and the
1740 ** *piDataCur and *piIdxCur values are left uninitialized.
1742 int sqlite3OpenTableAndIndices(
1743 Parse *pParse, /* Parsing context */
1744 Table *pTab, /* Table to be opened */
1745 int op, /* OP_OpenRead or OP_OpenWrite */
1746 u8 p5, /* P5 value for OP_Open* opcodes (except on WITHOUT ROWID) */
1747 int iBase, /* Use this for the table cursor, if there is one */
1748 u8 *aToOpen, /* If not NULL: boolean for each table and index */
1749 int *piDataCur, /* Write the database source cursor number here */
1750 int *piIdxCur /* Write the first index cursor number here */
1752 int i;
1753 int iDb;
1754 int iDataCur;
1755 Index *pIdx;
1756 Vdbe *v;
1758 assert( op==OP_OpenRead || op==OP_OpenWrite );
1759 assert( op==OP_OpenWrite || p5==0 );
1760 if( IsVirtual(pTab) ){
1761 /* This routine is a no-op for virtual tables. Leave the output
1762 ** variables *piDataCur and *piIdxCur uninitialized so that valgrind
1763 ** can detect if they are used by mistake in the caller. */
1764 return 0;
1766 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
1767 v = sqlite3GetVdbe(pParse);
1768 assert( v!=0 );
1769 if( iBase<0 ) iBase = pParse->nTab;
1770 iDataCur = iBase++;
1771 if( piDataCur ) *piDataCur = iDataCur;
1772 if( HasRowid(pTab) && (aToOpen==0 || aToOpen[0]) ){
1773 sqlite3OpenTable(pParse, iDataCur, iDb, pTab, op);
1774 }else{
1775 sqlite3TableLock(pParse, iDb, pTab->tnum, op==OP_OpenWrite, pTab->zName);
1777 if( piIdxCur ) *piIdxCur = iBase;
1778 for(i=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, i++){
1779 int iIdxCur = iBase++;
1780 assert( pIdx->pSchema==pTab->pSchema );
1781 if( IsPrimaryKeyIndex(pIdx) && !HasRowid(pTab) ){
1782 if( piDataCur ) *piDataCur = iIdxCur;
1783 p5 = 0;
1785 if( aToOpen==0 || aToOpen[i+1] ){
1786 sqlite3VdbeAddOp3(v, op, iIdxCur, pIdx->tnum, iDb);
1787 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
1788 sqlite3VdbeChangeP5(v, p5);
1789 VdbeComment((v, "%s", pIdx->zName));
1792 if( iBase>pParse->nTab ) pParse->nTab = iBase;
1793 return i;
1797 #ifdef SQLITE_TEST
1799 ** The following global variable is incremented whenever the
1800 ** transfer optimization is used. This is used for testing
1801 ** purposes only - to make sure the transfer optimization really
1802 ** is happening when it is supposed to.
1804 int sqlite3_xferopt_count;
1805 #endif /* SQLITE_TEST */
1808 #ifndef SQLITE_OMIT_XFER_OPT
1810 ** Check to see if index pSrc is compatible as a source of data
1811 ** for index pDest in an insert transfer optimization. The rules
1812 ** for a compatible index:
1814 ** * The index is over the same set of columns
1815 ** * The same DESC and ASC markings occurs on all columns
1816 ** * The same onError processing (OE_Abort, OE_Ignore, etc)
1817 ** * The same collating sequence on each column
1818 ** * The index has the exact same WHERE clause
1820 static int xferCompatibleIndex(Index *pDest, Index *pSrc){
1821 int i;
1822 assert( pDest && pSrc );
1823 assert( pDest->pTable!=pSrc->pTable );
1824 if( pDest->nKeyCol!=pSrc->nKeyCol ){
1825 return 0; /* Different number of columns */
1827 if( pDest->onError!=pSrc->onError ){
1828 return 0; /* Different conflict resolution strategies */
1830 for(i=0; i<pSrc->nKeyCol; i++){
1831 if( pSrc->aiColumn[i]!=pDest->aiColumn[i] ){
1832 return 0; /* Different columns indexed */
1834 if( pSrc->aiColumn[i]==XN_EXPR ){
1835 assert( pSrc->aColExpr!=0 && pDest->aColExpr!=0 );
1836 if( sqlite3ExprCompare(pSrc->aColExpr->a[i].pExpr,
1837 pDest->aColExpr->a[i].pExpr, -1)!=0 ){
1838 return 0; /* Different expressions in the index */
1841 if( pSrc->aSortOrder[i]!=pDest->aSortOrder[i] ){
1842 return 0; /* Different sort orders */
1844 if( sqlite3_stricmp(pSrc->azColl[i],pDest->azColl[i])!=0 ){
1845 return 0; /* Different collating sequences */
1848 if( sqlite3ExprCompare(pSrc->pPartIdxWhere, pDest->pPartIdxWhere, -1) ){
1849 return 0; /* Different WHERE clauses */
1852 /* If no test above fails then the indices must be compatible */
1853 return 1;
1857 ** Attempt the transfer optimization on INSERTs of the form
1859 ** INSERT INTO tab1 SELECT * FROM tab2;
1861 ** The xfer optimization transfers raw records from tab2 over to tab1.
1862 ** Columns are not decoded and reassembled, which greatly improves
1863 ** performance. Raw index records are transferred in the same way.
1865 ** The xfer optimization is only attempted if tab1 and tab2 are compatible.
1866 ** There are lots of rules for determining compatibility - see comments
1867 ** embedded in the code for details.
1869 ** This routine returns TRUE if the optimization is guaranteed to be used.
1870 ** Sometimes the xfer optimization will only work if the destination table
1871 ** is empty - a factor that can only be determined at run-time. In that
1872 ** case, this routine generates code for the xfer optimization but also
1873 ** does a test to see if the destination table is empty and jumps over the
1874 ** xfer optimization code if the test fails. In that case, this routine
1875 ** returns FALSE so that the caller will know to go ahead and generate
1876 ** an unoptimized transfer. This routine also returns FALSE if there
1877 ** is no chance that the xfer optimization can be applied.
1879 ** This optimization is particularly useful at making VACUUM run faster.
1881 static int xferOptimization(
1882 Parse *pParse, /* Parser context */
1883 Table *pDest, /* The table we are inserting into */
1884 Select *pSelect, /* A SELECT statement to use as the data source */
1885 int onError, /* How to handle constraint errors */
1886 int iDbDest /* The database of pDest */
1888 sqlite3 *db = pParse->db;
1889 ExprList *pEList; /* The result set of the SELECT */
1890 Table *pSrc; /* The table in the FROM clause of SELECT */
1891 Index *pSrcIdx, *pDestIdx; /* Source and destination indices */
1892 struct SrcList_item *pItem; /* An element of pSelect->pSrc */
1893 int i; /* Loop counter */
1894 int iDbSrc; /* The database of pSrc */
1895 int iSrc, iDest; /* Cursors from source and destination */
1896 int addr1, addr2; /* Loop addresses */
1897 int emptyDestTest = 0; /* Address of test for empty pDest */
1898 int emptySrcTest = 0; /* Address of test for empty pSrc */
1899 Vdbe *v; /* The VDBE we are building */
1900 int regAutoinc; /* Memory register used by AUTOINC */
1901 int destHasUniqueIdx = 0; /* True if pDest has a UNIQUE index */
1902 int regData, regRowid; /* Registers holding data and rowid */
1904 if( pSelect==0 ){
1905 return 0; /* Must be of the form INSERT INTO ... SELECT ... */
1907 if( pParse->pWith || pSelect->pWith ){
1908 /* Do not attempt to process this query if there are an WITH clauses
1909 ** attached to it. Proceeding may generate a false "no such table: xxx"
1910 ** error if pSelect reads from a CTE named "xxx". */
1911 return 0;
1913 if( sqlite3TriggerList(pParse, pDest) ){
1914 return 0; /* tab1 must not have triggers */
1916 #ifndef SQLITE_OMIT_VIRTUALTABLE
1917 if( pDest->tabFlags & TF_Virtual ){
1918 return 0; /* tab1 must not be a virtual table */
1920 #endif
1921 if( onError==OE_Default ){
1922 if( pDest->iPKey>=0 ) onError = pDest->keyConf;
1923 if( onError==OE_Default ) onError = OE_Abort;
1925 assert(pSelect->pSrc); /* allocated even if there is no FROM clause */
1926 if( pSelect->pSrc->nSrc!=1 ){
1927 return 0; /* FROM clause must have exactly one term */
1929 if( pSelect->pSrc->a[0].pSelect ){
1930 return 0; /* FROM clause cannot contain a subquery */
1932 if( pSelect->pWhere ){
1933 return 0; /* SELECT may not have a WHERE clause */
1935 if( pSelect->pOrderBy ){
1936 return 0; /* SELECT may not have an ORDER BY clause */
1938 /* Do not need to test for a HAVING clause. If HAVING is present but
1939 ** there is no ORDER BY, we will get an error. */
1940 if( pSelect->pGroupBy ){
1941 return 0; /* SELECT may not have a GROUP BY clause */
1943 if( pSelect->pLimit ){
1944 return 0; /* SELECT may not have a LIMIT clause */
1946 assert( pSelect->pOffset==0 ); /* Must be so if pLimit==0 */
1947 if( pSelect->pPrior ){
1948 return 0; /* SELECT may not be a compound query */
1950 if( pSelect->selFlags & SF_Distinct ){
1951 return 0; /* SELECT may not be DISTINCT */
1953 pEList = pSelect->pEList;
1954 assert( pEList!=0 );
1955 if( pEList->nExpr!=1 ){
1956 return 0; /* The result set must have exactly one column */
1958 assert( pEList->a[0].pExpr );
1959 if( pEList->a[0].pExpr->op!=TK_ASTERISK ){
1960 return 0; /* The result set must be the special operator "*" */
1963 /* At this point we have established that the statement is of the
1964 ** correct syntactic form to participate in this optimization. Now
1965 ** we have to check the semantics.
1967 pItem = pSelect->pSrc->a;
1968 pSrc = sqlite3LocateTableItem(pParse, 0, pItem);
1969 if( pSrc==0 ){
1970 return 0; /* FROM clause does not contain a real table */
1972 if( pSrc==pDest ){
1973 return 0; /* tab1 and tab2 may not be the same table */
1975 if( HasRowid(pDest)!=HasRowid(pSrc) ){
1976 return 0; /* source and destination must both be WITHOUT ROWID or not */
1978 #ifndef SQLITE_OMIT_VIRTUALTABLE
1979 if( pSrc->tabFlags & TF_Virtual ){
1980 return 0; /* tab2 must not be a virtual table */
1982 #endif
1983 if( pSrc->pSelect ){
1984 return 0; /* tab2 may not be a view */
1986 if( pDest->nCol!=pSrc->nCol ){
1987 return 0; /* Number of columns must be the same in tab1 and tab2 */
1989 if( pDest->iPKey!=pSrc->iPKey ){
1990 return 0; /* Both tables must have the same INTEGER PRIMARY KEY */
1992 for(i=0; i<pDest->nCol; i++){
1993 Column *pDestCol = &pDest->aCol[i];
1994 Column *pSrcCol = &pSrc->aCol[i];
1995 #ifdef SQLITE_ENABLE_HIDDEN_COLUMNS
1996 if( (db->flags & SQLITE_Vacuum)==0
1997 && (pDestCol->colFlags | pSrcCol->colFlags) & COLFLAG_HIDDEN
1999 return 0; /* Neither table may have __hidden__ columns */
2001 #endif
2002 if( pDestCol->affinity!=pSrcCol->affinity ){
2003 return 0; /* Affinity must be the same on all columns */
2005 if( sqlite3_stricmp(pDestCol->zColl, pSrcCol->zColl)!=0 ){
2006 return 0; /* Collating sequence must be the same on all columns */
2008 if( pDestCol->notNull && !pSrcCol->notNull ){
2009 return 0; /* tab2 must be NOT NULL if tab1 is */
2011 /* Default values for second and subsequent columns need to match. */
2012 if( i>0 ){
2013 assert( pDestCol->pDflt==0 || pDestCol->pDflt->op==TK_SPAN );
2014 assert( pSrcCol->pDflt==0 || pSrcCol->pDflt->op==TK_SPAN );
2015 if( (pDestCol->pDflt==0)!=(pSrcCol->pDflt==0)
2016 || (pDestCol->pDflt && strcmp(pDestCol->pDflt->u.zToken,
2017 pSrcCol->pDflt->u.zToken)!=0)
2019 return 0; /* Default values must be the same for all columns */
2023 for(pDestIdx=pDest->pIndex; pDestIdx; pDestIdx=pDestIdx->pNext){
2024 if( IsUniqueIndex(pDestIdx) ){
2025 destHasUniqueIdx = 1;
2027 for(pSrcIdx=pSrc->pIndex; pSrcIdx; pSrcIdx=pSrcIdx->pNext){
2028 if( xferCompatibleIndex(pDestIdx, pSrcIdx) ) break;
2030 if( pSrcIdx==0 ){
2031 return 0; /* pDestIdx has no corresponding index in pSrc */
2034 #ifndef SQLITE_OMIT_CHECK
2035 if( pDest->pCheck && sqlite3ExprListCompare(pSrc->pCheck,pDest->pCheck,-1) ){
2036 return 0; /* Tables have different CHECK constraints. Ticket #2252 */
2038 #endif
2039 #ifndef SQLITE_OMIT_FOREIGN_KEY
2040 /* Disallow the transfer optimization if the destination table constains
2041 ** any foreign key constraints. This is more restrictive than necessary.
2042 ** But the main beneficiary of the transfer optimization is the VACUUM
2043 ** command, and the VACUUM command disables foreign key constraints. So
2044 ** the extra complication to make this rule less restrictive is probably
2045 ** not worth the effort. Ticket [6284df89debdfa61db8073e062908af0c9b6118e]
2047 if( (db->flags & SQLITE_ForeignKeys)!=0 && pDest->pFKey!=0 ){
2048 return 0;
2050 #endif
2051 if( (db->flags & SQLITE_CountRows)!=0 ){
2052 return 0; /* xfer opt does not play well with PRAGMA count_changes */
2055 /* If we get this far, it means that the xfer optimization is at
2056 ** least a possibility, though it might only work if the destination
2057 ** table (tab1) is initially empty.
2059 #ifdef SQLITE_TEST
2060 sqlite3_xferopt_count++;
2061 #endif
2062 iDbSrc = sqlite3SchemaToIndex(db, pSrc->pSchema);
2063 v = sqlite3GetVdbe(pParse);
2064 sqlite3CodeVerifySchema(pParse, iDbSrc);
2065 iSrc = pParse->nTab++;
2066 iDest = pParse->nTab++;
2067 regAutoinc = autoIncBegin(pParse, iDbDest, pDest);
2068 regData = sqlite3GetTempReg(pParse);
2069 regRowid = sqlite3GetTempReg(pParse);
2070 sqlite3OpenTable(pParse, iDest, iDbDest, pDest, OP_OpenWrite);
2071 assert( HasRowid(pDest) || destHasUniqueIdx );
2072 if( (db->flags & SQLITE_Vacuum)==0 && (
2073 (pDest->iPKey<0 && pDest->pIndex!=0) /* (1) */
2074 || destHasUniqueIdx /* (2) */
2075 || (onError!=OE_Abort && onError!=OE_Rollback) /* (3) */
2077 /* In some circumstances, we are able to run the xfer optimization
2078 ** only if the destination table is initially empty. Unless the
2079 ** SQLITE_Vacuum flag is set, this block generates code to make
2080 ** that determination. If SQLITE_Vacuum is set, then the destination
2081 ** table is always empty.
2083 ** Conditions under which the destination must be empty:
2085 ** (1) There is no INTEGER PRIMARY KEY but there are indices.
2086 ** (If the destination is not initially empty, the rowid fields
2087 ** of index entries might need to change.)
2089 ** (2) The destination has a unique index. (The xfer optimization
2090 ** is unable to test uniqueness.)
2092 ** (3) onError is something other than OE_Abort and OE_Rollback.
2094 addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iDest, 0); VdbeCoverage(v);
2095 emptyDestTest = sqlite3VdbeAddOp0(v, OP_Goto);
2096 sqlite3VdbeJumpHere(v, addr1);
2098 if( HasRowid(pSrc) ){
2099 sqlite3OpenTable(pParse, iSrc, iDbSrc, pSrc, OP_OpenRead);
2100 emptySrcTest = sqlite3VdbeAddOp2(v, OP_Rewind, iSrc, 0); VdbeCoverage(v);
2101 if( pDest->iPKey>=0 ){
2102 addr1 = sqlite3VdbeAddOp2(v, OP_Rowid, iSrc, regRowid);
2103 addr2 = sqlite3VdbeAddOp3(v, OP_NotExists, iDest, 0, regRowid);
2104 VdbeCoverage(v);
2105 sqlite3RowidConstraint(pParse, onError, pDest);
2106 sqlite3VdbeJumpHere(v, addr2);
2107 autoIncStep(pParse, regAutoinc, regRowid);
2108 }else if( pDest->pIndex==0 ){
2109 addr1 = sqlite3VdbeAddOp2(v, OP_NewRowid, iDest, regRowid);
2110 }else{
2111 addr1 = sqlite3VdbeAddOp2(v, OP_Rowid, iSrc, regRowid);
2112 assert( (pDest->tabFlags & TF_Autoincrement)==0 );
2114 sqlite3VdbeAddOp2(v, OP_RowData, iSrc, regData);
2115 sqlite3VdbeAddOp4(v, OP_Insert, iDest, regData, regRowid,
2116 (char*)pDest, P4_TABLE);
2117 sqlite3VdbeChangeP5(v, OPFLAG_NCHANGE|OPFLAG_LASTROWID|OPFLAG_APPEND);
2118 sqlite3VdbeAddOp2(v, OP_Next, iSrc, addr1); VdbeCoverage(v);
2119 sqlite3VdbeAddOp2(v, OP_Close, iSrc, 0);
2120 sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
2121 }else{
2122 sqlite3TableLock(pParse, iDbDest, pDest->tnum, 1, pDest->zName);
2123 sqlite3TableLock(pParse, iDbSrc, pSrc->tnum, 0, pSrc->zName);
2125 for(pDestIdx=pDest->pIndex; pDestIdx; pDestIdx=pDestIdx->pNext){
2126 u8 idxInsFlags = 0;
2127 for(pSrcIdx=pSrc->pIndex; ALWAYS(pSrcIdx); pSrcIdx=pSrcIdx->pNext){
2128 if( xferCompatibleIndex(pDestIdx, pSrcIdx) ) break;
2130 assert( pSrcIdx );
2131 sqlite3VdbeAddOp3(v, OP_OpenRead, iSrc, pSrcIdx->tnum, iDbSrc);
2132 sqlite3VdbeSetP4KeyInfo(pParse, pSrcIdx);
2133 VdbeComment((v, "%s", pSrcIdx->zName));
2134 sqlite3VdbeAddOp3(v, OP_OpenWrite, iDest, pDestIdx->tnum, iDbDest);
2135 sqlite3VdbeSetP4KeyInfo(pParse, pDestIdx);
2136 sqlite3VdbeChangeP5(v, OPFLAG_BULKCSR);
2137 VdbeComment((v, "%s", pDestIdx->zName));
2138 addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iSrc, 0); VdbeCoverage(v);
2139 sqlite3VdbeAddOp2(v, OP_RowKey, iSrc, regData);
2140 if( db->flags & SQLITE_Vacuum ){
2141 /* This INSERT command is part of a VACUUM operation, which guarantees
2142 ** that the destination table is empty. If all indexed columns use
2143 ** collation sequence BINARY, then it can also be assumed that the
2144 ** index will be populated by inserting keys in strictly sorted
2145 ** order. In this case, instead of seeking within the b-tree as part
2146 ** of every OP_IdxInsert opcode, an OP_Last is added before the
2147 ** OP_IdxInsert to seek to the point within the b-tree where each key
2148 ** should be inserted. This is faster.
2150 ** If any of the indexed columns use a collation sequence other than
2151 ** BINARY, this optimization is disabled. This is because the user
2152 ** might change the definition of a collation sequence and then run
2153 ** a VACUUM command. In that case keys may not be written in strictly
2154 ** sorted order. */
2155 for(i=0; i<pSrcIdx->nColumn; i++){
2156 const char *zColl = pSrcIdx->azColl[i];
2157 assert( sqlite3_stricmp(sqlite3StrBINARY, zColl)!=0
2158 || sqlite3StrBINARY==zColl );
2159 if( sqlite3_stricmp(sqlite3StrBINARY, zColl) ) break;
2161 if( i==pSrcIdx->nColumn ){
2162 idxInsFlags = OPFLAG_USESEEKRESULT;
2163 sqlite3VdbeAddOp3(v, OP_Last, iDest, 0, -1);
2166 if( !HasRowid(pSrc) && pDestIdx->idxType==2 ){
2167 idxInsFlags |= OPFLAG_NCHANGE;
2169 sqlite3VdbeAddOp3(v, OP_IdxInsert, iDest, regData, 1);
2170 sqlite3VdbeChangeP5(v, idxInsFlags);
2171 sqlite3VdbeAddOp2(v, OP_Next, iSrc, addr1+1); VdbeCoverage(v);
2172 sqlite3VdbeJumpHere(v, addr1);
2173 sqlite3VdbeAddOp2(v, OP_Close, iSrc, 0);
2174 sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
2176 if( emptySrcTest ) sqlite3VdbeJumpHere(v, emptySrcTest);
2177 sqlite3ReleaseTempReg(pParse, regRowid);
2178 sqlite3ReleaseTempReg(pParse, regData);
2179 if( emptyDestTest ){
2180 sqlite3AutoincrementEnd(pParse);
2181 sqlite3VdbeAddOp2(v, OP_Halt, SQLITE_OK, 0);
2182 sqlite3VdbeJumpHere(v, emptyDestTest);
2183 sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
2184 return 0;
2185 }else{
2186 return 1;
2189 #endif /* SQLITE_OMIT_XFER_OPT */