xref: /sqlite-3.40.0/src/insert.c (revision afe028a8)
1cce7d176Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
3cce7d176Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
6cce7d176Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
10cce7d176Sdrh **
11cce7d176Sdrh *************************************************************************
12cce7d176Sdrh ** This file contains C code routines that are called by the parser
13b19a2bc6Sdrh ** to handle INSERT statements in SQLite.
14cce7d176Sdrh */
15cce7d176Sdrh #include "sqliteInt.h"
16cce7d176Sdrh 
17cce7d176Sdrh /*
1826198bb4Sdrh ** Generate code that will
19dd9930efSdrh **
2026198bb4Sdrh **   (1) acquire a lock for table pTab then
2126198bb4Sdrh **   (2) open pTab as cursor iCur.
2226198bb4Sdrh **
2326198bb4Sdrh ** If pTab is a WITHOUT ROWID table, then it is the PRIMARY KEY index
2426198bb4Sdrh ** for that table that is actually opened.
25bbb5e4e0Sdrh */
26bbb5e4e0Sdrh void sqlite3OpenTable(
272ec2fb22Sdrh   Parse *pParse,  /* Generate code into this VDBE */
28bbb5e4e0Sdrh   int iCur,       /* The cursor number of the table */
29bbb5e4e0Sdrh   int iDb,        /* The database index in sqlite3.aDb[] */
30bbb5e4e0Sdrh   Table *pTab,    /* The table to be opened */
31bbb5e4e0Sdrh   int opcode      /* OP_OpenRead or OP_OpenWrite */
32bbb5e4e0Sdrh ){
33bbb5e4e0Sdrh   Vdbe *v;
345f53aac2Sdrh   assert( !IsVirtual(pTab) );
352ec2fb22Sdrh   v = sqlite3GetVdbe(pParse);
36bbb5e4e0Sdrh   assert( opcode==OP_OpenWrite || opcode==OP_OpenRead );
372ec2fb22Sdrh   sqlite3TableLock(pParse, iDb, pTab->tnum,
382ec2fb22Sdrh                    (opcode==OP_OpenWrite)?1:0, pTab->zName);
39ec95c441Sdrh   if( HasRowid(pTab) ){
40261c02d9Sdrh     sqlite3VdbeAddOp4Int(v, opcode, iCur, pTab->tnum, iDb, pTab->nCol);
41dd9930efSdrh     VdbeComment((v, "%s", pTab->zName));
4226198bb4Sdrh   }else{
43dd9930efSdrh     Index *pPk = sqlite3PrimaryKeyIndex(pTab);
44dd9930efSdrh     assert( pPk!=0 );
45*afe028a8Sdrh     assert( pPk->tnum==pTab->tnum );
462ec2fb22Sdrh     sqlite3VdbeAddOp3(v, opcode, iCur, pPk->tnum, iDb);
472ec2fb22Sdrh     sqlite3VdbeSetP4KeyInfo(pParse, pPk);
48bbb5e4e0Sdrh     VdbeComment((v, "%s", pTab->zName));
49bbb5e4e0Sdrh   }
50ec95c441Sdrh }
51bbb5e4e0Sdrh 
52bbb5e4e0Sdrh /*
5369f8bb9cSdan ** Return a pointer to the column affinity string associated with index
5469f8bb9cSdan ** pIdx. A column affinity string has one character for each column in
5569f8bb9cSdan ** the table, according to the affinity of the column:
563d1bfeaaSdanielk1977 **
573d1bfeaaSdanielk1977 **  Character      Column affinity
583d1bfeaaSdanielk1977 **  ------------------------------
594583c37cSdrh **  'A'            NONE
604583c37cSdrh **  'B'            TEXT
614583c37cSdrh **  'C'            NUMERIC
624583c37cSdrh **  'D'            INTEGER
634583c37cSdrh **  'F'            REAL
642d401ab8Sdrh **
654583c37cSdrh ** An extra 'D' is appended to the end of the string to cover the
662d401ab8Sdrh ** rowid that appears as the last column in every index.
6769f8bb9cSdan **
6869f8bb9cSdan ** Memory for the buffer containing the column index affinity string
6969f8bb9cSdan ** is managed along with the rest of the Index structure. It will be
7069f8bb9cSdan ** released when sqlite3DeleteIndex() is called.
713d1bfeaaSdanielk1977 */
7269f8bb9cSdan const char *sqlite3IndexAffinityStr(Vdbe *v, Index *pIdx){
73a37cdde0Sdanielk1977   if( !pIdx->zColAff ){
74e014a838Sdanielk1977     /* The first time a column affinity string for a particular index is
75a37cdde0Sdanielk1977     ** required, it is allocated and populated here. It is then stored as
76e014a838Sdanielk1977     ** a member of the Index structure for subsequent use.
77a37cdde0Sdanielk1977     **
78a37cdde0Sdanielk1977     ** The column affinity string will eventually be deleted by
79e014a838Sdanielk1977     ** sqliteDeleteIndex() when the Index structure itself is cleaned
80a37cdde0Sdanielk1977     ** up.
81a37cdde0Sdanielk1977     */
82a37cdde0Sdanielk1977     int n;
83a37cdde0Sdanielk1977     Table *pTab = pIdx->pTable;
84abb6fcabSdrh     sqlite3 *db = sqlite3VdbeDb(v);
85ad124329Sdrh     pIdx->zColAff = (char *)sqlite3DbMallocRaw(0, pIdx->nColumn+1);
86a37cdde0Sdanielk1977     if( !pIdx->zColAff ){
87633e6d57Sdrh       db->mallocFailed = 1;
8869f8bb9cSdan       return 0;
89a37cdde0Sdanielk1977     }
90ad124329Sdrh     for(n=0; n<pIdx->nColumn; n++){
91ad124329Sdrh       i16 x = pIdx->aiColumn[n];
92ad124329Sdrh       pIdx->zColAff[n] = x<0 ? SQLITE_AFF_INTEGER : pTab->aCol[x].affinity;
93a37cdde0Sdanielk1977     }
942d401ab8Sdrh     pIdx->zColAff[n] = 0;
95a37cdde0Sdanielk1977   }
963d1bfeaaSdanielk1977 
9769f8bb9cSdan   return pIdx->zColAff;
98a37cdde0Sdanielk1977 }
99a37cdde0Sdanielk1977 
100a37cdde0Sdanielk1977 /*
10157bf4a8eSdrh ** Compute the affinity string for table pTab, if it has not already been
10257bf4a8eSdrh ** computed.  As an optimization, omit trailing SQLITE_AFF_NONE affinities.
10357bf4a8eSdrh **
104b6e8fd10Sdrh ** If the affinity exists (if it is no entirely SQLITE_AFF_NONE values) and
10557bf4a8eSdrh ** if iReg>0 then code an OP_Affinity opcode that will set the affinities
10657bf4a8eSdrh ** for register iReg and following.  Or if affinities exists and iReg==0,
10757bf4a8eSdrh ** then just set the P4 operand of the previous opcode (which should  be
10857bf4a8eSdrh ** an OP_MakeRecord) to the affinity string.
10957bf4a8eSdrh **
110b6e8fd10Sdrh ** A column affinity string has one character per column:
111a37cdde0Sdanielk1977 **
112a37cdde0Sdanielk1977 **  Character      Column affinity
113a37cdde0Sdanielk1977 **  ------------------------------
1144583c37cSdrh **  'A'            NONE
1154583c37cSdrh **  'B'            TEXT
1164583c37cSdrh **  'C'            NUMERIC
1174583c37cSdrh **  'D'            INTEGER
1184583c37cSdrh **  'E'            REAL
119a37cdde0Sdanielk1977 */
12057bf4a8eSdrh void sqlite3TableAffinity(Vdbe *v, Table *pTab, int iReg){
1213d1bfeaaSdanielk1977   int i;
12257bf4a8eSdrh   char *zColAff = pTab->zColAff;
12357bf4a8eSdrh   if( zColAff==0 ){
124abb6fcabSdrh     sqlite3 *db = sqlite3VdbeDb(v);
125b975598eSdrh     zColAff = (char *)sqlite3DbMallocRaw(0, pTab->nCol+1);
1263d1bfeaaSdanielk1977     if( !zColAff ){
127633e6d57Sdrh       db->mallocFailed = 1;
128a37cdde0Sdanielk1977       return;
1293d1bfeaaSdanielk1977     }
1303d1bfeaaSdanielk1977 
1313d1bfeaaSdanielk1977     for(i=0; i<pTab->nCol; i++){
132a37cdde0Sdanielk1977       zColAff[i] = pTab->aCol[i].affinity;
1333d1bfeaaSdanielk1977     }
13457bf4a8eSdrh     do{
13557bf4a8eSdrh       zColAff[i--] = 0;
13657bf4a8eSdrh     }while( i>=0 && zColAff[i]==SQLITE_AFF_NONE );
1373d1bfeaaSdanielk1977     pTab->zColAff = zColAff;
1383d1bfeaaSdanielk1977   }
13957bf4a8eSdrh   i = sqlite3Strlen30(zColAff);
14057bf4a8eSdrh   if( i ){
14157bf4a8eSdrh     if( iReg ){
14257bf4a8eSdrh       sqlite3VdbeAddOp4(v, OP_Affinity, iReg, i, 0, zColAff, i);
14357bf4a8eSdrh     }else{
14457bf4a8eSdrh       sqlite3VdbeChangeP4(v, -1, zColAff, i);
14557bf4a8eSdrh     }
14657bf4a8eSdrh   }
1473d1bfeaaSdanielk1977 }
1483d1bfeaaSdanielk1977 
1494d88778bSdanielk1977 /*
15048d1178aSdrh ** Return non-zero if the table pTab in database iDb or any of its indices
151b6e8fd10Sdrh ** have been opened at any point in the VDBE program. This is used to see if
15248d1178aSdrh ** a statement of the form  "INSERT INTO <iDb, pTab> SELECT ..." can
153b6e8fd10Sdrh ** run without using a temporary table for the results of the SELECT.
1544d88778bSdanielk1977 */
15505a86c5cSdrh static int readsTable(Parse *p, int iDb, Table *pTab){
156595a523aSdanielk1977   Vdbe *v = sqlite3GetVdbe(p);
1574d88778bSdanielk1977   int i;
15848d1178aSdrh   int iEnd = sqlite3VdbeCurrentAddr(v);
159595a523aSdanielk1977 #ifndef SQLITE_OMIT_VIRTUALTABLE
160595a523aSdanielk1977   VTable *pVTab = IsVirtual(pTab) ? sqlite3GetVTable(p->db, pTab) : 0;
161595a523aSdanielk1977 #endif
162595a523aSdanielk1977 
16305a86c5cSdrh   for(i=1; i<iEnd; i++){
16448d1178aSdrh     VdbeOp *pOp = sqlite3VdbeGetOp(v, i);
165ef0bea92Sdrh     assert( pOp!=0 );
166207872a4Sdanielk1977     if( pOp->opcode==OP_OpenRead && pOp->p3==iDb ){
16748d1178aSdrh       Index *pIndex;
168207872a4Sdanielk1977       int tnum = pOp->p2;
16948d1178aSdrh       if( tnum==pTab->tnum ){
17048d1178aSdrh         return 1;
17148d1178aSdrh       }
17248d1178aSdrh       for(pIndex=pTab->pIndex; pIndex; pIndex=pIndex->pNext){
17348d1178aSdrh         if( tnum==pIndex->tnum ){
17448d1178aSdrh           return 1;
17548d1178aSdrh         }
17648d1178aSdrh       }
17748d1178aSdrh     }
178543165efSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
179595a523aSdanielk1977     if( pOp->opcode==OP_VOpen && pOp->p4.pVtab==pVTab ){
1802dca4ac1Sdanielk1977       assert( pOp->p4.pVtab!=0 );
18166a5167bSdrh       assert( pOp->p4type==P4_VTAB );
18248d1178aSdrh       return 1;
1834d88778bSdanielk1977     }
184543165efSdrh #endif
1854d88778bSdanielk1977   }
1864d88778bSdanielk1977   return 0;
1874d88778bSdanielk1977 }
1883d1bfeaaSdanielk1977 
1899d9cf229Sdrh #ifndef SQLITE_OMIT_AUTOINCREMENT
1909d9cf229Sdrh /*
1910b9f50d8Sdrh ** Locate or create an AutoincInfo structure associated with table pTab
1920b9f50d8Sdrh ** which is in database iDb.  Return the register number for the register
1930b9f50d8Sdrh ** that holds the maximum rowid.
1949d9cf229Sdrh **
1950b9f50d8Sdrh ** There is at most one AutoincInfo structure per table even if the
1960b9f50d8Sdrh ** same table is autoincremented multiple times due to inserts within
1970b9f50d8Sdrh ** triggers.  A new AutoincInfo structure is created if this is the
1980b9f50d8Sdrh ** first use of table pTab.  On 2nd and subsequent uses, the original
1990b9f50d8Sdrh ** AutoincInfo structure is used.
2009d9cf229Sdrh **
2010b9f50d8Sdrh ** Three memory locations are allocated:
2020b9f50d8Sdrh **
2030b9f50d8Sdrh **   (1)  Register to hold the name of the pTab table.
2040b9f50d8Sdrh **   (2)  Register to hold the maximum ROWID of pTab.
2050b9f50d8Sdrh **   (3)  Register to hold the rowid in sqlite_sequence of pTab
2060b9f50d8Sdrh **
2070b9f50d8Sdrh ** The 2nd register is the one that is returned.  That is all the
2080b9f50d8Sdrh ** insert routine needs to know about.
2099d9cf229Sdrh */
2109d9cf229Sdrh static int autoIncBegin(
2119d9cf229Sdrh   Parse *pParse,      /* Parsing context */
2129d9cf229Sdrh   int iDb,            /* Index of the database holding pTab */
2139d9cf229Sdrh   Table *pTab         /* The table we are writing to */
2149d9cf229Sdrh ){
2156a288a33Sdrh   int memId = 0;      /* Register holding maximum rowid */
2167d10d5a6Sdrh   if( pTab->tabFlags & TF_Autoincrement ){
21765a7cd16Sdan     Parse *pToplevel = sqlite3ParseToplevel(pParse);
2180b9f50d8Sdrh     AutoincInfo *pInfo;
2190b9f50d8Sdrh 
22065a7cd16Sdan     pInfo = pToplevel->pAinc;
2210b9f50d8Sdrh     while( pInfo && pInfo->pTab!=pTab ){ pInfo = pInfo->pNext; }
2220b9f50d8Sdrh     if( pInfo==0 ){
2230b9f50d8Sdrh       pInfo = sqlite3DbMallocRaw(pParse->db, sizeof(*pInfo));
2240b9f50d8Sdrh       if( pInfo==0 ) return 0;
22565a7cd16Sdan       pInfo->pNext = pToplevel->pAinc;
22665a7cd16Sdan       pToplevel->pAinc = pInfo;
2270b9f50d8Sdrh       pInfo->pTab = pTab;
2280b9f50d8Sdrh       pInfo->iDb = iDb;
22965a7cd16Sdan       pToplevel->nMem++;                  /* Register to hold name of table */
23065a7cd16Sdan       pInfo->regCtr = ++pToplevel->nMem;  /* Max rowid register */
23165a7cd16Sdan       pToplevel->nMem++;                  /* Rowid in sqlite_sequence */
2320b9f50d8Sdrh     }
2330b9f50d8Sdrh     memId = pInfo->regCtr;
2349d9cf229Sdrh   }
2359d9cf229Sdrh   return memId;
2369d9cf229Sdrh }
2379d9cf229Sdrh 
2389d9cf229Sdrh /*
2390b9f50d8Sdrh ** This routine generates code that will initialize all of the
2400b9f50d8Sdrh ** register used by the autoincrement tracker.
2410b9f50d8Sdrh */
2420b9f50d8Sdrh void sqlite3AutoincrementBegin(Parse *pParse){
2430b9f50d8Sdrh   AutoincInfo *p;            /* Information about an AUTOINCREMENT */
2440b9f50d8Sdrh   sqlite3 *db = pParse->db;  /* The database connection */
2450b9f50d8Sdrh   Db *pDb;                   /* Database only autoinc table */
2460b9f50d8Sdrh   int memId;                 /* Register holding max rowid */
2470b9f50d8Sdrh   int addr;                  /* A VDBE address */
2480b9f50d8Sdrh   Vdbe *v = pParse->pVdbe;   /* VDBE under construction */
2490b9f50d8Sdrh 
250345ba7dbSdrh   /* This routine is never called during trigger-generation.  It is
251345ba7dbSdrh   ** only called from the top-level */
252345ba7dbSdrh   assert( pParse->pTriggerTab==0 );
253345ba7dbSdrh   assert( pParse==sqlite3ParseToplevel(pParse) );
25476d462eeSdan 
2550b9f50d8Sdrh   assert( v );   /* We failed long ago if this is not so */
2560b9f50d8Sdrh   for(p = pParse->pAinc; p; p = p->pNext){
2570b9f50d8Sdrh     pDb = &db->aDb[p->iDb];
2580b9f50d8Sdrh     memId = p->regCtr;
2592120608eSdrh     assert( sqlite3SchemaMutexHeld(db, 0, pDb->pSchema) );
2600b9f50d8Sdrh     sqlite3OpenTable(pParse, 0, p->iDb, pDb->pSchema->pSeqTab, OP_OpenRead);
261f4d31bcbSdrh     sqlite3VdbeAddOp3(v, OP_Null, 0, memId, memId+1);
2620b9f50d8Sdrh     addr = sqlite3VdbeCurrentAddr(v);
2630b9f50d8Sdrh     sqlite3VdbeAddOp4(v, OP_String8, 0, memId-1, 0, p->pTab->zName, 0);
264688852abSdrh     sqlite3VdbeAddOp2(v, OP_Rewind, 0, addr+9); VdbeCoverage(v);
2650b9f50d8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, 0, 0, memId);
266688852abSdrh     sqlite3VdbeAddOp3(v, OP_Ne, memId-1, addr+7, memId); VdbeCoverage(v);
2670b9f50d8Sdrh     sqlite3VdbeChangeP5(v, SQLITE_JUMPIFNULL);
2680b9f50d8Sdrh     sqlite3VdbeAddOp2(v, OP_Rowid, 0, memId+1);
2690b9f50d8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, 0, 1, memId);
2700b9f50d8Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, addr+9);
271688852abSdrh     sqlite3VdbeAddOp2(v, OP_Next, 0, addr+2); VdbeCoverage(v);
2720b9f50d8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, memId);
2730b9f50d8Sdrh     sqlite3VdbeAddOp0(v, OP_Close);
2740b9f50d8Sdrh   }
2750b9f50d8Sdrh }
2760b9f50d8Sdrh 
2770b9f50d8Sdrh /*
2789d9cf229Sdrh ** Update the maximum rowid for an autoincrement calculation.
2799d9cf229Sdrh **
2809d9cf229Sdrh ** This routine should be called when the top of the stack holds a
2819d9cf229Sdrh ** new rowid that is about to be inserted.  If that new rowid is
2829d9cf229Sdrh ** larger than the maximum rowid in the memId memory cell, then the
2839d9cf229Sdrh ** memory cell is updated.  The stack is unchanged.
2849d9cf229Sdrh */
2856a288a33Sdrh static void autoIncStep(Parse *pParse, int memId, int regRowid){
2869d9cf229Sdrh   if( memId>0 ){
2876a288a33Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_MemMax, memId, regRowid);
2889d9cf229Sdrh   }
2899d9cf229Sdrh }
2909d9cf229Sdrh 
2919d9cf229Sdrh /*
2920b9f50d8Sdrh ** This routine generates the code needed to write autoincrement
2930b9f50d8Sdrh ** maximum rowid values back into the sqlite_sequence register.
2940b9f50d8Sdrh ** Every statement that might do an INSERT into an autoincrement
2950b9f50d8Sdrh ** table (either directly or through triggers) needs to call this
2960b9f50d8Sdrh ** routine just before the "exit" code.
2979d9cf229Sdrh */
2980b9f50d8Sdrh void sqlite3AutoincrementEnd(Parse *pParse){
2990b9f50d8Sdrh   AutoincInfo *p;
3009d9cf229Sdrh   Vdbe *v = pParse->pVdbe;
3010b9f50d8Sdrh   sqlite3 *db = pParse->db;
3026a288a33Sdrh 
3039d9cf229Sdrh   assert( v );
3040b9f50d8Sdrh   for(p = pParse->pAinc; p; p = p->pNext){
3050b9f50d8Sdrh     Db *pDb = &db->aDb[p->iDb];
3063d77dee9Sdrh     int j1;
3070b9f50d8Sdrh     int iRec;
3080b9f50d8Sdrh     int memId = p->regCtr;
3090b9f50d8Sdrh 
3100b9f50d8Sdrh     iRec = sqlite3GetTempReg(pParse);
3112120608eSdrh     assert( sqlite3SchemaMutexHeld(db, 0, pDb->pSchema) );
3120b9f50d8Sdrh     sqlite3OpenTable(pParse, 0, p->iDb, pDb->pSchema->pSeqTab, OP_OpenWrite);
313688852abSdrh     j1 = sqlite3VdbeAddOp1(v, OP_NotNull, memId+1); VdbeCoverage(v);
3140b9f50d8Sdrh     sqlite3VdbeAddOp2(v, OP_NewRowid, 0, memId+1);
3156a288a33Sdrh     sqlite3VdbeJumpHere(v, j1);
316a7a8e14bSdanielk1977     sqlite3VdbeAddOp3(v, OP_MakeRecord, memId-1, 2, iRec);
3170b9f50d8Sdrh     sqlite3VdbeAddOp3(v, OP_Insert, 0, iRec, memId+1);
31835573356Sdrh     sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
3190b9f50d8Sdrh     sqlite3VdbeAddOp0(v, OP_Close);
3200b9f50d8Sdrh     sqlite3ReleaseTempReg(pParse, iRec);
3219d9cf229Sdrh   }
3229d9cf229Sdrh }
3239d9cf229Sdrh #else
3249d9cf229Sdrh /*
3259d9cf229Sdrh ** If SQLITE_OMIT_AUTOINCREMENT is defined, then the three routines
3269d9cf229Sdrh ** above are all no-ops
3279d9cf229Sdrh */
3289d9cf229Sdrh # define autoIncBegin(A,B,C) (0)
329287fb61cSdanielk1977 # define autoIncStep(A,B,C)
3309d9cf229Sdrh #endif /* SQLITE_OMIT_AUTOINCREMENT */
3319d9cf229Sdrh 
3329d9cf229Sdrh 
3339d9cf229Sdrh /* Forward declaration */
3349d9cf229Sdrh static int xferOptimization(
3359d9cf229Sdrh   Parse *pParse,        /* Parser context */
3369d9cf229Sdrh   Table *pDest,         /* The table we are inserting into */
3379d9cf229Sdrh   Select *pSelect,      /* A SELECT statement to use as the data source */
3389d9cf229Sdrh   int onError,          /* How to handle constraint errors */
3399d9cf229Sdrh   int iDbDest           /* The database of pDest */
3409d9cf229Sdrh );
3419d9cf229Sdrh 
3423d1bfeaaSdanielk1977 /*
343d82b5021Sdrh ** This routine is called to handle SQL of the following forms:
344cce7d176Sdrh **
345a21f78b9Sdrh **    insert into TABLE (IDLIST) values(EXPRLIST),(EXPRLIST),...
3461ccde15dSdrh **    insert into TABLE (IDLIST) select
347a21f78b9Sdrh **    insert into TABLE (IDLIST) default values
348cce7d176Sdrh **
3491ccde15dSdrh ** The IDLIST following the table name is always optional.  If omitted,
350a21f78b9Sdrh ** then a list of all (non-hidden) columns for the table is substituted.
351a21f78b9Sdrh ** The IDLIST appears in the pColumn parameter.  pColumn is NULL if IDLIST
352a21f78b9Sdrh ** is omitted.
3531ccde15dSdrh **
354a21f78b9Sdrh ** For the pSelect parameter holds the values to be inserted for the
355a21f78b9Sdrh ** first two forms shown above.  A VALUES clause is really just short-hand
356a21f78b9Sdrh ** for a SELECT statement that omits the FROM clause and everything else
357a21f78b9Sdrh ** that follows.  If the pSelect parameter is NULL, that means that the
358a21f78b9Sdrh ** DEFAULT VALUES form of the INSERT statement is intended.
359142e30dfSdrh **
3609d9cf229Sdrh ** The code generated follows one of four templates.  For a simple
361a21f78b9Sdrh ** insert with data coming from a single-row VALUES clause, the code executes
362e00ee6ebSdrh ** once straight down through.  Pseudo-code follows (we call this
363e00ee6ebSdrh ** the "1st template"):
364142e30dfSdrh **
365142e30dfSdrh **         open write cursor to <table> and its indices
366ec95c441Sdrh **         put VALUES clause expressions into registers
367142e30dfSdrh **         write the resulting record into <table>
368142e30dfSdrh **         cleanup
369142e30dfSdrh **
3709d9cf229Sdrh ** The three remaining templates assume the statement is of the form
371142e30dfSdrh **
372142e30dfSdrh **   INSERT INTO <table> SELECT ...
373142e30dfSdrh **
3749d9cf229Sdrh ** If the SELECT clause is of the restricted form "SELECT * FROM <table2>" -
3759d9cf229Sdrh ** in other words if the SELECT pulls all columns from a single table
3769d9cf229Sdrh ** and there is no WHERE or LIMIT or GROUP BY or ORDER BY clauses, and
3779d9cf229Sdrh ** if <table2> and <table1> are distinct tables but have identical
3789d9cf229Sdrh ** schemas, including all the same indices, then a special optimization
3799d9cf229Sdrh ** is invoked that copies raw records from <table2> over to <table1>.
3809d9cf229Sdrh ** See the xferOptimization() function for the implementation of this
381e00ee6ebSdrh ** template.  This is the 2nd template.
3829d9cf229Sdrh **
3839d9cf229Sdrh **         open a write cursor to <table>
3849d9cf229Sdrh **         open read cursor on <table2>
3859d9cf229Sdrh **         transfer all records in <table2> over to <table>
3869d9cf229Sdrh **         close cursors
3879d9cf229Sdrh **         foreach index on <table>
3889d9cf229Sdrh **           open a write cursor on the <table> index
3899d9cf229Sdrh **           open a read cursor on the corresponding <table2> index
3909d9cf229Sdrh **           transfer all records from the read to the write cursors
3919d9cf229Sdrh **           close cursors
3929d9cf229Sdrh **         end foreach
3939d9cf229Sdrh **
394e00ee6ebSdrh ** The 3rd template is for when the second template does not apply
3959d9cf229Sdrh ** and the SELECT clause does not read from <table> at any time.
3969d9cf229Sdrh ** The generated code follows this template:
397142e30dfSdrh **
398e00ee6ebSdrh **         X <- A
399142e30dfSdrh **         goto B
400142e30dfSdrh **      A: setup for the SELECT
4019d9cf229Sdrh **         loop over the rows in the SELECT
402e00ee6ebSdrh **           load values into registers R..R+n
403e00ee6ebSdrh **           yield X
404142e30dfSdrh **         end loop
405142e30dfSdrh **         cleanup after the SELECT
40681cf13ecSdrh **         end-coroutine X
407e00ee6ebSdrh **      B: open write cursor to <table> and its indices
40881cf13ecSdrh **      C: yield X, at EOF goto D
409e00ee6ebSdrh **         insert the select result into <table> from R..R+n
410e00ee6ebSdrh **         goto C
411142e30dfSdrh **      D: cleanup
412142e30dfSdrh **
413e00ee6ebSdrh ** The 4th template is used if the insert statement takes its
414142e30dfSdrh ** values from a SELECT but the data is being inserted into a table
415142e30dfSdrh ** that is also read as part of the SELECT.  In the third form,
41660ec914cSpeter.d.reid ** we have to use an intermediate table to store the results of
417142e30dfSdrh ** the select.  The template is like this:
418142e30dfSdrh **
419e00ee6ebSdrh **         X <- A
420142e30dfSdrh **         goto B
421142e30dfSdrh **      A: setup for the SELECT
422142e30dfSdrh **         loop over the tables in the SELECT
423e00ee6ebSdrh **           load value into register R..R+n
424e00ee6ebSdrh **           yield X
425142e30dfSdrh **         end loop
426142e30dfSdrh **         cleanup after the SELECT
42781cf13ecSdrh **         end co-routine R
428e00ee6ebSdrh **      B: open temp table
42981cf13ecSdrh **      L: yield X, at EOF goto M
430e00ee6ebSdrh **         insert row from R..R+n into temp table
431e00ee6ebSdrh **         goto L
432e00ee6ebSdrh **      M: open write cursor to <table> and its indices
433e00ee6ebSdrh **         rewind temp table
434e00ee6ebSdrh **      C: loop over rows of intermediate table
435142e30dfSdrh **           transfer values form intermediate table into <table>
436e00ee6ebSdrh **         end loop
437e00ee6ebSdrh **      D: cleanup
438cce7d176Sdrh */
4394adee20fSdanielk1977 void sqlite3Insert(
440cce7d176Sdrh   Parse *pParse,        /* Parser context */
441113088ecSdrh   SrcList *pTabList,    /* Name of table into which we are inserting */
4425974a30fSdrh   Select *pSelect,      /* A SELECT statement to use as the data source */
4439cfcf5d4Sdrh   IdList *pColumn,      /* Column names corresponding to IDLIST. */
4449cfcf5d4Sdrh   int onError           /* How to handle constraint errors */
445cce7d176Sdrh ){
4466a288a33Sdrh   sqlite3 *db;          /* The main database structure */
4476a288a33Sdrh   Table *pTab;          /* The table to insert into.  aka TABLE */
448113088ecSdrh   char *zTab;           /* Name of the table into which we are inserting */
449e22a334bSdrh   const char *zDb;      /* Name of the database holding this table */
4505974a30fSdrh   int i, j, idx;        /* Loop counters */
4515974a30fSdrh   Vdbe *v;              /* Generate code into this virtual machine */
4525974a30fSdrh   Index *pIdx;          /* For looping over indices of the table */
453967e8b73Sdrh   int nColumn;          /* Number of columns in the data */
4546a288a33Sdrh   int nHidden = 0;      /* Number of hidden columns if TABLE is virtual */
45526198bb4Sdrh   int iDataCur = 0;     /* VDBE cursor that is the main data repository */
45626198bb4Sdrh   int iIdxCur = 0;      /* First index cursor */
457d82b5021Sdrh   int ipkColumn = -1;   /* Column that is the INTEGER PRIMARY KEY */
4580ca3e24bSdrh   int endOfLoop;        /* Label for the end of the insertion loop */
459cfe9a69fSdanielk1977   int srcTab = 0;       /* Data comes from this temporary cursor if >=0 */
460e00ee6ebSdrh   int addrInsTop = 0;   /* Jump to label "D" */
461e00ee6ebSdrh   int addrCont = 0;     /* Top of insert loop. Label "C" in templates 3 and 4 */
4622eb95377Sdrh   SelectDest dest;      /* Destination for SELECT on rhs of INSERT */
4636a288a33Sdrh   int iDb;              /* Index of database holding TABLE */
4642958a4e6Sdrh   Db *pDb;              /* The database containing table being inserted into */
46505a86c5cSdrh   u8 useTempTable = 0;  /* Store SELECT results in intermediate table */
46605a86c5cSdrh   u8 appendFlag = 0;    /* True if the insert is likely to be an append */
46705a86c5cSdrh   u8 withoutRowid;      /* 0 for normal table.  1 for WITHOUT ROWID table */
468a21f78b9Sdrh   u8 bIdListInOrder;    /* True if IDLIST is in table order */
46975593d96Sdrh   ExprList *pList = 0;  /* List of VALUES() to be inserted  */
470cce7d176Sdrh 
4716a288a33Sdrh   /* Register allocations */
4721bd10f8aSdrh   int regFromSelect = 0;/* Base register for data coming from SELECT */
4736a288a33Sdrh   int regAutoinc = 0;   /* Register holding the AUTOINCREMENT counter */
4746a288a33Sdrh   int regRowCount = 0;  /* Memory cell used for the row counter */
4756a288a33Sdrh   int regIns;           /* Block of regs holding rowid+data being inserted */
4766a288a33Sdrh   int regRowid;         /* registers holding insert rowid */
4776a288a33Sdrh   int regData;          /* register holding first column to insert */
478aa9b8963Sdrh   int *aRegIdx = 0;     /* One register allocated to each index */
4796a288a33Sdrh 
480798da52cSdrh #ifndef SQLITE_OMIT_TRIGGER
481798da52cSdrh   int isView;                 /* True if attempting to insert into a view */
4822f886d1dSdanielk1977   Trigger *pTrigger;          /* List of triggers on pTab, if required */
4832f886d1dSdanielk1977   int tmask;                  /* Mask of trigger times */
484798da52cSdrh #endif
485c3f9bad2Sdanielk1977 
48617435752Sdrh   db = pParse->db;
4871bd10f8aSdrh   memset(&dest, 0, sizeof(dest));
48817435752Sdrh   if( pParse->nErr || db->mallocFailed ){
4896f7adc8aSdrh     goto insert_cleanup;
4906f7adc8aSdrh   }
491daffd0e5Sdrh 
49275593d96Sdrh   /* If the Select object is really just a simple VALUES() list with a
493a21f78b9Sdrh   ** single row (the common case) then keep that one row of values
494a21f78b9Sdrh   ** and discard the other (unused) parts of the pSelect object
49575593d96Sdrh   */
49675593d96Sdrh   if( pSelect && (pSelect->selFlags & SF_Values)!=0 && pSelect->pPrior==0 ){
49775593d96Sdrh     pList = pSelect->pEList;
49875593d96Sdrh     pSelect->pEList = 0;
49975593d96Sdrh     sqlite3SelectDelete(db, pSelect);
50075593d96Sdrh     pSelect = 0;
50175593d96Sdrh   }
50275593d96Sdrh 
5031ccde15dSdrh   /* Locate the table into which we will be inserting new information.
5041ccde15dSdrh   */
505113088ecSdrh   assert( pTabList->nSrc==1 );
506113088ecSdrh   zTab = pTabList->a[0].zName;
507098d1684Sdrh   if( NEVER(zTab==0) ) goto insert_cleanup;
5084adee20fSdanielk1977   pTab = sqlite3SrcListLookup(pParse, pTabList);
509c3f9bad2Sdanielk1977   if( pTab==0 ){
510c3f9bad2Sdanielk1977     goto insert_cleanup;
511c3f9bad2Sdanielk1977   }
512da184236Sdanielk1977   iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
513da184236Sdanielk1977   assert( iDb<db->nDb );
514da184236Sdanielk1977   pDb = &db->aDb[iDb];
5152958a4e6Sdrh   zDb = pDb->zName;
5164adee20fSdanielk1977   if( sqlite3AuthCheck(pParse, SQLITE_INSERT, pTab->zName, 0, zDb) ){
5171962bda7Sdrh     goto insert_cleanup;
5181962bda7Sdrh   }
519ec95c441Sdrh   withoutRowid = !HasRowid(pTab);
520c3f9bad2Sdanielk1977 
521b7f9164eSdrh   /* Figure out if we have any triggers and if the table being
522b7f9164eSdrh   ** inserted into is a view
523b7f9164eSdrh   */
524b7f9164eSdrh #ifndef SQLITE_OMIT_TRIGGER
5252f886d1dSdanielk1977   pTrigger = sqlite3TriggersExist(pParse, pTab, TK_INSERT, 0, &tmask);
526b7f9164eSdrh   isView = pTab->pSelect!=0;
527b7f9164eSdrh #else
5282f886d1dSdanielk1977 # define pTrigger 0
5292f886d1dSdanielk1977 # define tmask 0
530b7f9164eSdrh # define isView 0
531b7f9164eSdrh #endif
532b7f9164eSdrh #ifdef SQLITE_OMIT_VIEW
533b7f9164eSdrh # undef isView
534b7f9164eSdrh # define isView 0
535b7f9164eSdrh #endif
5362f886d1dSdanielk1977   assert( (pTrigger && tmask) || (pTrigger==0 && tmask==0) );
537b7f9164eSdrh 
538f573c99bSdrh   /* If pTab is really a view, make sure it has been initialized.
539d82b5021Sdrh   ** ViewGetColumnNames() is a no-op if pTab is not a view.
540f573c99bSdrh   */
541b3d24bf8Sdanielk1977   if( sqlite3ViewGetColumnNames(pParse, pTab) ){
542f573c99bSdrh     goto insert_cleanup;
543f573c99bSdrh   }
544f573c99bSdrh 
545d82b5021Sdrh   /* Cannot insert into a read-only table.
546595a523aSdanielk1977   */
547595a523aSdanielk1977   if( sqlite3IsReadOnly(pParse, pTab, tmask) ){
548595a523aSdanielk1977     goto insert_cleanup;
549595a523aSdanielk1977   }
550595a523aSdanielk1977 
5511ccde15dSdrh   /* Allocate a VDBE
5521ccde15dSdrh   */
5534adee20fSdanielk1977   v = sqlite3GetVdbe(pParse);
5545974a30fSdrh   if( v==0 ) goto insert_cleanup;
5554794f735Sdrh   if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
5562f886d1dSdanielk1977   sqlite3BeginWriteOperation(pParse, pSelect || pTrigger, iDb);
5571ccde15dSdrh 
5589d9cf229Sdrh #ifndef SQLITE_OMIT_XFER_OPT
5599d9cf229Sdrh   /* If the statement is of the form
5609d9cf229Sdrh   **
5619d9cf229Sdrh   **       INSERT INTO <table1> SELECT * FROM <table2>;
5629d9cf229Sdrh   **
5639d9cf229Sdrh   ** Then special optimizations can be applied that make the transfer
5649d9cf229Sdrh   ** very fast and which reduce fragmentation of indices.
565e00ee6ebSdrh   **
566e00ee6ebSdrh   ** This is the 2nd template.
5679d9cf229Sdrh   */
568ebbf08a0Sdan   if( pColumn==0 && xferOptimization(pParse, pTab, pSelect, onError, iDb) ){
5692f886d1dSdanielk1977     assert( !pTrigger );
5709d9cf229Sdrh     assert( pList==0 );
5710b9f50d8Sdrh     goto insert_end;
5729d9cf229Sdrh   }
5739d9cf229Sdrh #endif /* SQLITE_OMIT_XFER_OPT */
5749d9cf229Sdrh 
5752958a4e6Sdrh   /* If this is an AUTOINCREMENT table, look up the sequence number in the
5766a288a33Sdrh   ** sqlite_sequence table and store it in memory cell regAutoinc.
5772958a4e6Sdrh   */
5786a288a33Sdrh   regAutoinc = autoIncBegin(pParse, iDb, pTab);
5792958a4e6Sdrh 
58005a86c5cSdrh   /* Allocate registers for holding the rowid of the new row,
58160ec914cSpeter.d.reid   ** the content of the new row, and the assembled row record.
58205a86c5cSdrh   */
58305a86c5cSdrh   regRowid = regIns = pParse->nMem+1;
58405a86c5cSdrh   pParse->nMem += pTab->nCol + 1;
58505a86c5cSdrh   if( IsVirtual(pTab) ){
58605a86c5cSdrh     regRowid++;
58705a86c5cSdrh     pParse->nMem++;
58805a86c5cSdrh   }
58905a86c5cSdrh   regData = regRowid+1;
59005a86c5cSdrh 
59105a86c5cSdrh   /* If the INSERT statement included an IDLIST term, then make sure
59205a86c5cSdrh   ** all elements of the IDLIST really are columns of the table and
59305a86c5cSdrh   ** remember the column indices.
59405a86c5cSdrh   **
59505a86c5cSdrh   ** If the table has an INTEGER PRIMARY KEY column and that column
59605a86c5cSdrh   ** is named in the IDLIST, then record in the ipkColumn variable
59705a86c5cSdrh   ** the index into IDLIST of the primary key column.  ipkColumn is
59805a86c5cSdrh   ** the index of the primary key as it appears in IDLIST, not as
59905a86c5cSdrh   ** is appears in the original table.  (The index of the INTEGER
60005a86c5cSdrh   ** PRIMARY KEY in the original table is pTab->iPKey.)
60105a86c5cSdrh   */
602a21f78b9Sdrh   bIdListInOrder = (pTab->tabFlags & TF_OOOHidden)==0;
60305a86c5cSdrh   if( pColumn ){
60405a86c5cSdrh     for(i=0; i<pColumn->nId; i++){
60505a86c5cSdrh       pColumn->a[i].idx = -1;
60605a86c5cSdrh     }
60705a86c5cSdrh     for(i=0; i<pColumn->nId; i++){
60805a86c5cSdrh       for(j=0; j<pTab->nCol; j++){
60905a86c5cSdrh         if( sqlite3StrICmp(pColumn->a[i].zName, pTab->aCol[j].zName)==0 ){
61005a86c5cSdrh           pColumn->a[i].idx = j;
61105a86c5cSdrh           if( i!=j ) bIdListInOrder = 0;
61205a86c5cSdrh           if( j==pTab->iPKey ){
61305a86c5cSdrh             ipkColumn = i;  assert( !withoutRowid );
61405a86c5cSdrh           }
61505a86c5cSdrh           break;
61605a86c5cSdrh         }
61705a86c5cSdrh       }
61805a86c5cSdrh       if( j>=pTab->nCol ){
61905a86c5cSdrh         if( sqlite3IsRowid(pColumn->a[i].zName) && !withoutRowid ){
62005a86c5cSdrh           ipkColumn = i;
621e48ae715Sdrh           bIdListInOrder = 0;
62205a86c5cSdrh         }else{
62305a86c5cSdrh           sqlite3ErrorMsg(pParse, "table %S has no column named %s",
62405a86c5cSdrh               pTabList, 0, pColumn->a[i].zName);
62505a86c5cSdrh           pParse->checkSchema = 1;
62605a86c5cSdrh           goto insert_cleanup;
62705a86c5cSdrh         }
62805a86c5cSdrh       }
62905a86c5cSdrh     }
63005a86c5cSdrh   }
63105a86c5cSdrh 
6321ccde15dSdrh   /* Figure out how many columns of data are supplied.  If the data
633e00ee6ebSdrh   ** is coming from a SELECT statement, then generate a co-routine that
634e00ee6ebSdrh   ** produces a single row of the SELECT on each invocation.  The
635e00ee6ebSdrh   ** co-routine is the common header to the 3rd and 4th templates.
6361ccde15dSdrh   */
6375974a30fSdrh   if( pSelect ){
638a21f78b9Sdrh     /* Data is coming from a SELECT or from a multi-row VALUES clause.
639a21f78b9Sdrh     ** Generate a co-routine to run the SELECT. */
64005a86c5cSdrh     int regYield;       /* Register holding co-routine entry-point */
64105a86c5cSdrh     int addrTop;        /* Top of the co-routine */
64205a86c5cSdrh     int rc;             /* Result code */
6431013c932Sdrh 
64405a86c5cSdrh     regYield = ++pParse->nMem;
64505a86c5cSdrh     addrTop = sqlite3VdbeCurrentAddr(v) + 1;
64605a86c5cSdrh     sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, addrTop);
64705a86c5cSdrh     sqlite3SelectDestInit(&dest, SRT_Coroutine, regYield);
64805a86c5cSdrh     dest.iSdst = bIdListInOrder ? regData : 0;
64905a86c5cSdrh     dest.nSdst = pTab->nCol;
65005a86c5cSdrh     rc = sqlite3Select(pParse, pSelect, &dest);
6512b596da8Sdrh     regFromSelect = dest.iSdst;
652992590beSdrh     if( rc || db->mallocFailed || pParse->nErr ) goto insert_cleanup;
65305a86c5cSdrh     sqlite3VdbeAddOp1(v, OP_EndCoroutine, regYield);
65405a86c5cSdrh     sqlite3VdbeJumpHere(v, addrTop - 1);                       /* label B: */
6555974a30fSdrh     assert( pSelect->pEList );
656967e8b73Sdrh     nColumn = pSelect->pEList->nExpr;
657142e30dfSdrh 
658142e30dfSdrh     /* Set useTempTable to TRUE if the result of the SELECT statement
659e00ee6ebSdrh     ** should be written into a temporary table (template 4).  Set to
660d82b5021Sdrh     ** FALSE if each output row of the SELECT can be written directly into
661e00ee6ebSdrh     ** the destination table (template 3).
662048c530cSdrh     **
663048c530cSdrh     ** A temp table must be used if the table being updated is also one
664048c530cSdrh     ** of the tables being read by the SELECT statement.  Also use a
665048c530cSdrh     ** temp table in the case of row triggers.
666142e30dfSdrh     */
66705a86c5cSdrh     if( pTrigger || readsTable(pParse, iDb, pTab) ){
668048c530cSdrh       useTempTable = 1;
669048c530cSdrh     }
670142e30dfSdrh 
671142e30dfSdrh     if( useTempTable ){
672e00ee6ebSdrh       /* Invoke the coroutine to extract information from the SELECT
673e00ee6ebSdrh       ** and add it to a transient table srcTab.  The code generated
674e00ee6ebSdrh       ** here is from the 4th template:
675e00ee6ebSdrh       **
676e00ee6ebSdrh       **      B: open temp table
67781cf13ecSdrh       **      L: yield X, goto M at EOF
678e00ee6ebSdrh       **         insert row from R..R+n into temp table
679e00ee6ebSdrh       **         goto L
680e00ee6ebSdrh       **      M: ...
681142e30dfSdrh       */
682e00ee6ebSdrh       int regRec;          /* Register to hold packed record */
683dc5ea5c7Sdrh       int regTempRowid;    /* Register to hold temp table ROWID */
68406280ee5Sdrh       int addrL;           /* Label "L" */
685b7654111Sdrh 
686142e30dfSdrh       srcTab = pParse->nTab++;
687b7654111Sdrh       regRec = sqlite3GetTempReg(pParse);
688dc5ea5c7Sdrh       regTempRowid = sqlite3GetTempReg(pParse);
689e00ee6ebSdrh       sqlite3VdbeAddOp2(v, OP_OpenEphemeral, srcTab, nColumn);
69006280ee5Sdrh       addrL = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm); VdbeCoverage(v);
6911db639ceSdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, regFromSelect, nColumn, regRec);
692dc5ea5c7Sdrh       sqlite3VdbeAddOp2(v, OP_NewRowid, srcTab, regTempRowid);
693dc5ea5c7Sdrh       sqlite3VdbeAddOp3(v, OP_Insert, srcTab, regRec, regTempRowid);
69406280ee5Sdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, addrL);
69506280ee5Sdrh       sqlite3VdbeJumpHere(v, addrL);
696b7654111Sdrh       sqlite3ReleaseTempReg(pParse, regRec);
697dc5ea5c7Sdrh       sqlite3ReleaseTempReg(pParse, regTempRowid);
698142e30dfSdrh     }
699142e30dfSdrh   }else{
700a21f78b9Sdrh     /* This is the case if the data for the INSERT is coming from a
701a21f78b9Sdrh     ** single-row VALUES clause
702142e30dfSdrh     */
703b3bce662Sdanielk1977     NameContext sNC;
704b3bce662Sdanielk1977     memset(&sNC, 0, sizeof(sNC));
705b3bce662Sdanielk1977     sNC.pParse = pParse;
7065974a30fSdrh     srcTab = -1;
70748d1178aSdrh     assert( useTempTable==0 );
708147d0cccSdrh     nColumn = pList ? pList->nExpr : 0;
709e64e7b20Sdrh     for(i=0; i<nColumn; i++){
7107d10d5a6Sdrh       if( sqlite3ResolveExprNames(&sNC, pList->a[i].pExpr) ){
711b04a5d87Sdrh         goto insert_cleanup;
712b04a5d87Sdrh       }
713e64e7b20Sdrh     }
7145974a30fSdrh   }
7151ccde15dSdrh 
71605a86c5cSdrh   /* If there is no IDLIST term but the table has an integer primary
71705a86c5cSdrh   ** key, the set the ipkColumn variable to the integer primary key
71805a86c5cSdrh   ** column index in the original table definition.
71905a86c5cSdrh   */
72005a86c5cSdrh   if( pColumn==0 && nColumn>0 ){
72105a86c5cSdrh     ipkColumn = pTab->iPKey;
72205a86c5cSdrh   }
72305a86c5cSdrh 
7241ccde15dSdrh   /* Make sure the number of columns in the source data matches the number
7251ccde15dSdrh   ** of columns to be inserted into the table.
7261ccde15dSdrh   */
727034ca14fSdanielk1977   if( IsVirtual(pTab) ){
728034ca14fSdanielk1977     for(i=0; i<pTab->nCol; i++){
729034ca14fSdanielk1977       nHidden += (IsHiddenColumn(&pTab->aCol[i]) ? 1 : 0);
730034ca14fSdanielk1977     }
731034ca14fSdanielk1977   }
732034ca14fSdanielk1977   if( pColumn==0 && nColumn && nColumn!=(pTab->nCol-nHidden) ){
7334adee20fSdanielk1977     sqlite3ErrorMsg(pParse,
734da93d238Sdrh        "table %S has %d columns but %d values were supplied",
735d51397a6Sdrh        pTabList, 0, pTab->nCol-nHidden, nColumn);
736cce7d176Sdrh     goto insert_cleanup;
737cce7d176Sdrh   }
738967e8b73Sdrh   if( pColumn!=0 && nColumn!=pColumn->nId ){
7394adee20fSdanielk1977     sqlite3ErrorMsg(pParse, "%d values for %d columns", nColumn, pColumn->nId);
740cce7d176Sdrh     goto insert_cleanup;
741cce7d176Sdrh   }
7421ccde15dSdrh 
743c3f9bad2Sdanielk1977   /* Initialize the count of rows to be inserted
7441ccde15dSdrh   */
745142e30dfSdrh   if( db->flags & SQLITE_CountRows ){
7466a288a33Sdrh     regRowCount = ++pParse->nMem;
7476a288a33Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, regRowCount);
748c3f9bad2Sdanielk1977   }
749c3f9bad2Sdanielk1977 
750e448dc4aSdanielk1977   /* If this is not a view, open the table and and all indices */
751e448dc4aSdanielk1977   if( !isView ){
752aa9b8963Sdrh     int nIdx;
7536a53499aSdrh     nIdx = sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, -1, 0,
75426198bb4Sdrh                                       &iDataCur, &iIdxCur);
7555c070538Sdrh     aRegIdx = sqlite3DbMallocRaw(db, sizeof(int)*(nIdx+1));
756aa9b8963Sdrh     if( aRegIdx==0 ){
757aa9b8963Sdrh       goto insert_cleanup;
758aa9b8963Sdrh     }
759aa9b8963Sdrh     for(i=0; i<nIdx; i++){
760aa9b8963Sdrh       aRegIdx[i] = ++pParse->nMem;
761aa9b8963Sdrh     }
762feeb1394Sdrh   }
763feeb1394Sdrh 
764e00ee6ebSdrh   /* This is the top of the main insertion loop */
765142e30dfSdrh   if( useTempTable ){
766e00ee6ebSdrh     /* This block codes the top of loop only.  The complete loop is the
767e00ee6ebSdrh     ** following pseudocode (template 4):
768e00ee6ebSdrh     **
76981cf13ecSdrh     **         rewind temp table, if empty goto D
770e00ee6ebSdrh     **      C: loop over rows of intermediate table
771e00ee6ebSdrh     **           transfer values form intermediate table into <table>
772e00ee6ebSdrh     **         end loop
773e00ee6ebSdrh     **      D: ...
774e00ee6ebSdrh     */
775688852abSdrh     addrInsTop = sqlite3VdbeAddOp1(v, OP_Rewind, srcTab); VdbeCoverage(v);
776e00ee6ebSdrh     addrCont = sqlite3VdbeCurrentAddr(v);
777142e30dfSdrh   }else if( pSelect ){
778e00ee6ebSdrh     /* This block codes the top of loop only.  The complete loop is the
779e00ee6ebSdrh     ** following pseudocode (template 3):
780e00ee6ebSdrh     **
78181cf13ecSdrh     **      C: yield X, at EOF goto D
782e00ee6ebSdrh     **         insert the select result into <table> from R..R+n
783e00ee6ebSdrh     **         goto C
784e00ee6ebSdrh     **      D: ...
785e00ee6ebSdrh     */
78681cf13ecSdrh     addrInsTop = addrCont = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm);
787688852abSdrh     VdbeCoverage(v);
788bed8690fSdrh   }
7891ccde15dSdrh 
7905cf590c1Sdrh   /* Run the BEFORE and INSTEAD OF triggers, if there are any
79170ce3f0cSdrh   */
7924adee20fSdanielk1977   endOfLoop = sqlite3VdbeMakeLabel(v);
7932f886d1dSdanielk1977   if( tmask & TRIGGER_BEFORE ){
79476d462eeSdan     int regCols = sqlite3GetTempRange(pParse, pTab->nCol+1);
795c3f9bad2Sdanielk1977 
79670ce3f0cSdrh     /* build the NEW.* reference row.  Note that if there is an INTEGER
79770ce3f0cSdrh     ** PRIMARY KEY into which a NULL is being inserted, that NULL will be
79870ce3f0cSdrh     ** translated into a unique ID for the row.  But on a BEFORE trigger,
79970ce3f0cSdrh     ** we do not know what the unique ID will be (because the insert has
80070ce3f0cSdrh     ** not happened yet) so we substitute a rowid of -1
80170ce3f0cSdrh     */
802d82b5021Sdrh     if( ipkColumn<0 ){
80376d462eeSdan       sqlite3VdbeAddOp2(v, OP_Integer, -1, regCols);
80470ce3f0cSdrh     }else{
8056a288a33Sdrh       int j1;
806ec95c441Sdrh       assert( !withoutRowid );
8077fe45908Sdrh       if( useTempTable ){
808d82b5021Sdrh         sqlite3VdbeAddOp3(v, OP_Column, srcTab, ipkColumn, regCols);
8097fe45908Sdrh       }else{
810d6fe961eSdrh         assert( pSelect==0 );  /* Otherwise useTempTable is true */
811d82b5021Sdrh         sqlite3ExprCode(pParse, pList->a[ipkColumn].pExpr, regCols);
8127fe45908Sdrh       }
813688852abSdrh       j1 = sqlite3VdbeAddOp1(v, OP_NotNull, regCols); VdbeCoverage(v);
81476d462eeSdan       sqlite3VdbeAddOp2(v, OP_Integer, -1, regCols);
8156a288a33Sdrh       sqlite3VdbeJumpHere(v, j1);
816688852abSdrh       sqlite3VdbeAddOp1(v, OP_MustBeInt, regCols); VdbeCoverage(v);
81770ce3f0cSdrh     }
81870ce3f0cSdrh 
819034ca14fSdanielk1977     /* Cannot have triggers on a virtual table. If it were possible,
820034ca14fSdanielk1977     ** this block would have to account for hidden column.
821034ca14fSdanielk1977     */
822034ca14fSdanielk1977     assert( !IsVirtual(pTab) );
823034ca14fSdanielk1977 
82470ce3f0cSdrh     /* Create the new column data
82570ce3f0cSdrh     */
826c3f9bad2Sdanielk1977     for(i=0; i<pTab->nCol; i++){
827c3f9bad2Sdanielk1977       if( pColumn==0 ){
828c3f9bad2Sdanielk1977         j = i;
829c3f9bad2Sdanielk1977       }else{
830c3f9bad2Sdanielk1977         for(j=0; j<pColumn->nId; j++){
831c3f9bad2Sdanielk1977           if( pColumn->a[j].idx==i ) break;
832c3f9bad2Sdanielk1977         }
833c3f9bad2Sdanielk1977       }
8347ba45971Sdan       if( (!useTempTable && !pList) || (pColumn && j>=pColumn->nId) ){
83576d462eeSdan         sqlite3ExprCode(pParse, pTab->aCol[i].pDflt, regCols+i+1);
836142e30dfSdrh       }else if( useTempTable ){
83776d462eeSdan         sqlite3VdbeAddOp3(v, OP_Column, srcTab, j, regCols+i+1);
838c3f9bad2Sdanielk1977       }else{
839d6fe961eSdrh         assert( pSelect==0 ); /* Otherwise useTempTable is true */
84076d462eeSdan         sqlite3ExprCodeAndCache(pParse, pList->a[j].pExpr, regCols+i+1);
841c3f9bad2Sdanielk1977       }
842c3f9bad2Sdanielk1977     }
843a37cdde0Sdanielk1977 
844a37cdde0Sdanielk1977     /* If this is an INSERT on a view with an INSTEAD OF INSERT trigger,
845a37cdde0Sdanielk1977     ** do not attempt any conversions before assembling the record.
846a37cdde0Sdanielk1977     ** If this is a real table, attempt conversions as required by the
847a37cdde0Sdanielk1977     ** table column affinities.
848a37cdde0Sdanielk1977     */
849a37cdde0Sdanielk1977     if( !isView ){
85057bf4a8eSdrh       sqlite3TableAffinity(v, pTab, regCols+1);
851a37cdde0Sdanielk1977     }
852c3f9bad2Sdanielk1977 
8535cf590c1Sdrh     /* Fire BEFORE or INSTEAD OF triggers */
854165921a7Sdan     sqlite3CodeRowTrigger(pParse, pTrigger, TK_INSERT, 0, TRIGGER_BEFORE,
85594d7f50aSdan         pTab, regCols-pTab->nCol-1, onError, endOfLoop);
856165921a7Sdan 
85776d462eeSdan     sqlite3ReleaseTempRange(pParse, regCols, pTab->nCol+1);
85870ce3f0cSdrh   }
859c3f9bad2Sdanielk1977 
860d82b5021Sdrh   /* Compute the content of the next row to insert into a range of
861d82b5021Sdrh   ** registers beginning at regIns.
8621ccde15dSdrh   */
8635cf590c1Sdrh   if( !isView ){
8644cbdda9eSdrh     if( IsVirtual(pTab) ){
8654cbdda9eSdrh       /* The row that the VUpdate opcode will delete: none */
8666a288a33Sdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, regIns);
8674cbdda9eSdrh     }
868d82b5021Sdrh     if( ipkColumn>=0 ){
869142e30dfSdrh       if( useTempTable ){
870d82b5021Sdrh         sqlite3VdbeAddOp3(v, OP_Column, srcTab, ipkColumn, regRowid);
871142e30dfSdrh       }else if( pSelect ){
87205a86c5cSdrh         sqlite3VdbeAddOp2(v, OP_Copy, regFromSelect+ipkColumn, regRowid);
8734a32431cSdrh       }else{
874e4d90813Sdrh         VdbeOp *pOp;
875d82b5021Sdrh         sqlite3ExprCode(pParse, pList->a[ipkColumn].pExpr, regRowid);
87620411ea7Sdrh         pOp = sqlite3VdbeGetOp(v, -1);
8771b7ecbb4Sdrh         if( ALWAYS(pOp) && pOp->opcode==OP_Null && !IsVirtual(pTab) ){
878e4d90813Sdrh           appendFlag = 1;
879e4d90813Sdrh           pOp->opcode = OP_NewRowid;
88026198bb4Sdrh           pOp->p1 = iDataCur;
8816a288a33Sdrh           pOp->p2 = regRowid;
8826a288a33Sdrh           pOp->p3 = regAutoinc;
883e4d90813Sdrh         }
88427a32783Sdrh       }
885f0863fe5Sdrh       /* If the PRIMARY KEY expression is NULL, then use OP_NewRowid
886e1e68f49Sdrh       ** to generate a unique primary key value.
887e1e68f49Sdrh       */
888e4d90813Sdrh       if( !appendFlag ){
8891db639ceSdrh         int j1;
890bb50e7adSdanielk1977         if( !IsVirtual(pTab) ){
891688852abSdrh           j1 = sqlite3VdbeAddOp1(v, OP_NotNull, regRowid); VdbeCoverage(v);
89226198bb4Sdrh           sqlite3VdbeAddOp3(v, OP_NewRowid, iDataCur, regRowid, regAutoinc);
8931db639ceSdrh           sqlite3VdbeJumpHere(v, j1);
894bb50e7adSdanielk1977         }else{
895bb50e7adSdanielk1977           j1 = sqlite3VdbeCurrentAddr(v);
896688852abSdrh           sqlite3VdbeAddOp2(v, OP_IsNull, regRowid, j1+2); VdbeCoverage(v);
897bb50e7adSdanielk1977         }
898688852abSdrh         sqlite3VdbeAddOp1(v, OP_MustBeInt, regRowid); VdbeCoverage(v);
899e4d90813Sdrh       }
900ec95c441Sdrh     }else if( IsVirtual(pTab) || withoutRowid ){
9016a288a33Sdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, regRowid);
9024a32431cSdrh     }else{
90326198bb4Sdrh       sqlite3VdbeAddOp3(v, OP_NewRowid, iDataCur, regRowid, regAutoinc);
904e4d90813Sdrh       appendFlag = 1;
9054a32431cSdrh     }
9066a288a33Sdrh     autoIncStep(pParse, regAutoinc, regRowid);
9074a32431cSdrh 
908d82b5021Sdrh     /* Compute data for all columns of the new entry, beginning
9094a32431cSdrh     ** with the first column.
9104a32431cSdrh     */
911034ca14fSdanielk1977     nHidden = 0;
912cce7d176Sdrh     for(i=0; i<pTab->nCol; i++){
9136a288a33Sdrh       int iRegStore = regRowid+1+i;
9144a32431cSdrh       if( i==pTab->iPKey ){
9154a32431cSdrh         /* The value of the INTEGER PRIMARY KEY column is always a NULL.
916d82b5021Sdrh         ** Whenever this column is read, the rowid will be substituted
917d82b5021Sdrh         ** in its place.  Hence, fill this column with a NULL to avoid
91805a86c5cSdrh         ** taking up data space with information that will never be used.
91905a86c5cSdrh         ** As there may be shallow copies of this value, make it a soft-NULL */
92005a86c5cSdrh         sqlite3VdbeAddOp1(v, OP_SoftNull, iRegStore);
9214a32431cSdrh         continue;
9224a32431cSdrh       }
923967e8b73Sdrh       if( pColumn==0 ){
924034ca14fSdanielk1977         if( IsHiddenColumn(&pTab->aCol[i]) ){
925034ca14fSdanielk1977           assert( IsVirtual(pTab) );
926034ca14fSdanielk1977           j = -1;
927034ca14fSdanielk1977           nHidden++;
928034ca14fSdanielk1977         }else{
929034ca14fSdanielk1977           j = i - nHidden;
930034ca14fSdanielk1977         }
931cce7d176Sdrh       }else{
932967e8b73Sdrh         for(j=0; j<pColumn->nId; j++){
933967e8b73Sdrh           if( pColumn->a[j].idx==i ) break;
934cce7d176Sdrh         }
935cce7d176Sdrh       }
936034ca14fSdanielk1977       if( j<0 || nColumn==0 || (pColumn && j>=pColumn->nId) ){
93705a86c5cSdrh         sqlite3ExprCodeFactorable(pParse, pTab->aCol[i].pDflt, iRegStore);
938142e30dfSdrh       }else if( useTempTable ){
939287fb61cSdanielk1977         sqlite3VdbeAddOp3(v, OP_Column, srcTab, j, iRegStore);
940142e30dfSdrh       }else if( pSelect ){
94105a86c5cSdrh         if( regFromSelect!=regData ){
942b7654111Sdrh           sqlite3VdbeAddOp2(v, OP_SCopy, regFromSelect+j, iRegStore);
94305a86c5cSdrh         }
944cce7d176Sdrh       }else{
945287fb61cSdanielk1977         sqlite3ExprCode(pParse, pList->a[j].pExpr, iRegStore);
946cce7d176Sdrh       }
947cce7d176Sdrh     }
9481ccde15dSdrh 
9490ca3e24bSdrh     /* Generate code to check constraints and generate index keys and
9500ca3e24bSdrh     ** do the insertion.
9514a32431cSdrh     */
9524cbdda9eSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
9534cbdda9eSdrh     if( IsVirtual(pTab) ){
954595a523aSdanielk1977       const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
9554f3dd150Sdrh       sqlite3VtabMakeWritable(pParse, pTab);
956595a523aSdanielk1977       sqlite3VdbeAddOp4(v, OP_VUpdate, 1, pTab->nCol+2, regIns, pVTab, P4_VTAB);
957b061d058Sdan       sqlite3VdbeChangeP5(v, onError==OE_Default ? OE_Abort : onError);
958e0af83acSdan       sqlite3MayAbort(pParse);
9594cbdda9eSdrh     }else
9604cbdda9eSdrh #endif
9614cbdda9eSdrh     {
962de630353Sdanielk1977       int isReplace;    /* Set to true if constraints may cause a replace */
963f8ffb278Sdrh       sqlite3GenerateConstraintChecks(pParse, pTab, aRegIdx, iDataCur, iIdxCur,
964f8ffb278Sdrh           regIns, 0, ipkColumn>=0, onError, endOfLoop, &isReplace
96504adf416Sdrh       );
9668ff2d956Sdan       sqlite3FkCheck(pParse, pTab, 0, regIns, 0, 0);
96726198bb4Sdrh       sqlite3CompleteInsertion(pParse, pTab, iDataCur, iIdxCur,
96826198bb4Sdrh                                regIns, aRegIdx, 0, appendFlag, isReplace==0);
9695cf590c1Sdrh     }
9704cbdda9eSdrh   }
9711bee3d7bSdrh 
972feeb1394Sdrh   /* Update the count of rows that are inserted
9731bee3d7bSdrh   */
974142e30dfSdrh   if( (db->flags & SQLITE_CountRows)!=0 ){
9756a288a33Sdrh     sqlite3VdbeAddOp2(v, OP_AddImm, regRowCount, 1);
9761bee3d7bSdrh   }
977c3f9bad2Sdanielk1977 
9782f886d1dSdanielk1977   if( pTrigger ){
979c3f9bad2Sdanielk1977     /* Code AFTER triggers */
980165921a7Sdan     sqlite3CodeRowTrigger(pParse, pTrigger, TK_INSERT, 0, TRIGGER_AFTER,
98194d7f50aSdan         pTab, regData-2-pTab->nCol, onError, endOfLoop);
982c3f9bad2Sdanielk1977   }
9831bee3d7bSdrh 
984e00ee6ebSdrh   /* The bottom of the main insertion loop, if the data source
985e00ee6ebSdrh   ** is a SELECT statement.
9861ccde15dSdrh   */
9874adee20fSdanielk1977   sqlite3VdbeResolveLabel(v, endOfLoop);
988142e30dfSdrh   if( useTempTable ){
989688852abSdrh     sqlite3VdbeAddOp2(v, OP_Next, srcTab, addrCont); VdbeCoverage(v);
990e00ee6ebSdrh     sqlite3VdbeJumpHere(v, addrInsTop);
9912eb95377Sdrh     sqlite3VdbeAddOp1(v, OP_Close, srcTab);
992142e30dfSdrh   }else if( pSelect ){
993e00ee6ebSdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, addrCont);
994e00ee6ebSdrh     sqlite3VdbeJumpHere(v, addrInsTop);
9956b56344dSdrh   }
996c3f9bad2Sdanielk1977 
997e448dc4aSdanielk1977   if( !IsVirtual(pTab) && !isView ){
998c3f9bad2Sdanielk1977     /* Close all tables opened */
99926198bb4Sdrh     if( iDataCur<iIdxCur ) sqlite3VdbeAddOp1(v, OP_Close, iDataCur);
100026198bb4Sdrh     for(idx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, idx++){
100126198bb4Sdrh       sqlite3VdbeAddOp1(v, OP_Close, idx+iIdxCur);
1002cce7d176Sdrh     }
1003c3f9bad2Sdanielk1977   }
1004c3f9bad2Sdanielk1977 
10050b9f50d8Sdrh insert_end:
1006f3388144Sdrh   /* Update the sqlite_sequence table by storing the content of the
10070b9f50d8Sdrh   ** maximum rowid counter values recorded while inserting into
10080b9f50d8Sdrh   ** autoincrement tables.
10092958a4e6Sdrh   */
1010165921a7Sdan   if( pParse->nested==0 && pParse->pTriggerTab==0 ){
10110b9f50d8Sdrh     sqlite3AutoincrementEnd(pParse);
10120b9f50d8Sdrh   }
10132958a4e6Sdrh 
10141bee3d7bSdrh   /*
1015e7de6f25Sdanielk1977   ** Return the number of rows inserted. If this routine is
1016e7de6f25Sdanielk1977   ** generating code because of a call to sqlite3NestedParse(), do not
1017e7de6f25Sdanielk1977   ** invoke the callback function.
10181bee3d7bSdrh   */
1019165921a7Sdan   if( (db->flags&SQLITE_CountRows) && !pParse->nested && !pParse->pTriggerTab ){
10206a288a33Sdrh     sqlite3VdbeAddOp2(v, OP_ResultRow, regRowCount, 1);
102122322fd4Sdanielk1977     sqlite3VdbeSetNumCols(v, 1);
102210fb749bSdanielk1977     sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows inserted", SQLITE_STATIC);
10231bee3d7bSdrh   }
1024cce7d176Sdrh 
1025cce7d176Sdrh insert_cleanup:
1026633e6d57Sdrh   sqlite3SrcListDelete(db, pTabList);
1027633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1028633e6d57Sdrh   sqlite3SelectDelete(db, pSelect);
1029633e6d57Sdrh   sqlite3IdListDelete(db, pColumn);
1030633e6d57Sdrh   sqlite3DbFree(db, aRegIdx);
1031cce7d176Sdrh }
10329cfcf5d4Sdrh 
103375cbd984Sdan /* Make sure "isView" and other macros defined above are undefined. Otherwise
103460ec914cSpeter.d.reid ** they may interfere with compilation of other functions in this file
103575cbd984Sdan ** (or in another file, if this file becomes part of the amalgamation).  */
103675cbd984Sdan #ifdef isView
103775cbd984Sdan  #undef isView
103875cbd984Sdan #endif
103975cbd984Sdan #ifdef pTrigger
104075cbd984Sdan  #undef pTrigger
104175cbd984Sdan #endif
104275cbd984Sdan #ifdef tmask
104375cbd984Sdan  #undef tmask
104475cbd984Sdan #endif
104575cbd984Sdan 
104611e85273Sdrh /*
10476934fc7bSdrh ** Generate code to do constraint checks prior to an INSERT or an UPDATE
10486934fc7bSdrh ** on table pTab.
10499cfcf5d4Sdrh **
10506934fc7bSdrh ** The regNewData parameter is the first register in a range that contains
10516934fc7bSdrh ** the data to be inserted or the data after the update.  There will be
10526934fc7bSdrh ** pTab->nCol+1 registers in this range.  The first register (the one
10536934fc7bSdrh ** that regNewData points to) will contain the new rowid, or NULL in the
10546934fc7bSdrh ** case of a WITHOUT ROWID table.  The second register in the range will
10556934fc7bSdrh ** contain the content of the first table column.  The third register will
10566934fc7bSdrh ** contain the content of the second table column.  And so forth.
10570ca3e24bSdrh **
1058f8ffb278Sdrh ** The regOldData parameter is similar to regNewData except that it contains
1059f8ffb278Sdrh ** the data prior to an UPDATE rather than afterwards.  regOldData is zero
1060f8ffb278Sdrh ** for an INSERT.  This routine can distinguish between UPDATE and INSERT by
1061f8ffb278Sdrh ** checking regOldData for zero.
10620ca3e24bSdrh **
1063f8ffb278Sdrh ** For an UPDATE, the pkChng boolean is true if the true primary key (the
1064f8ffb278Sdrh ** rowid for a normal table or the PRIMARY KEY for a WITHOUT ROWID table)
1065f8ffb278Sdrh ** might be modified by the UPDATE.  If pkChng is false, then the key of
1066f8ffb278Sdrh ** the iDataCur content table is guaranteed to be unchanged by the UPDATE.
1067f8ffb278Sdrh **
1068f8ffb278Sdrh ** For an INSERT, the pkChng boolean indicates whether or not the rowid
1069f8ffb278Sdrh ** was explicitly specified as part of the INSERT statement.  If pkChng
1070f8ffb278Sdrh ** is zero, it means that the either rowid is computed automatically or
1071f8ffb278Sdrh ** that the table is a WITHOUT ROWID table and has no rowid.  On an INSERT,
1072f8ffb278Sdrh ** pkChng will only be true if the INSERT statement provides an integer
1073f8ffb278Sdrh ** value for either the rowid column or its INTEGER PRIMARY KEY alias.
10740ca3e24bSdrh **
10756934fc7bSdrh ** The code generated by this routine will store new index entries into
1076aa9b8963Sdrh ** registers identified by aRegIdx[].  No index entry is created for
1077aa9b8963Sdrh ** indices where aRegIdx[i]==0.  The order of indices in aRegIdx[] is
1078aa9b8963Sdrh ** the same as the order of indices on the linked list of indices
10796934fc7bSdrh ** at pTab->pIndex.
10806934fc7bSdrh **
10816934fc7bSdrh ** The caller must have already opened writeable cursors on the main
10826934fc7bSdrh ** table and all applicable indices (that is to say, all indices for which
10836934fc7bSdrh ** aRegIdx[] is not zero).  iDataCur is the cursor for the main table when
10846934fc7bSdrh ** inserting or updating a rowid table, or the cursor for the PRIMARY KEY
10856934fc7bSdrh ** index when operating on a WITHOUT ROWID table.  iIdxCur is the cursor
10866934fc7bSdrh ** for the first index in the pTab->pIndex list.  Cursors for other indices
10876934fc7bSdrh ** are at iIdxCur+N for the N-th element of the pTab->pIndex list.
10889cfcf5d4Sdrh **
10899cfcf5d4Sdrh ** This routine also generates code to check constraints.  NOT NULL,
10909cfcf5d4Sdrh ** CHECK, and UNIQUE constraints are all checked.  If a constraint fails,
10911c92853dSdrh ** then the appropriate action is performed.  There are five possible
10921c92853dSdrh ** actions: ROLLBACK, ABORT, FAIL, REPLACE, and IGNORE.
10939cfcf5d4Sdrh **
10949cfcf5d4Sdrh **  Constraint type  Action       What Happens
10959cfcf5d4Sdrh **  ---------------  ----------   ----------------------------------------
10961c92853dSdrh **  any              ROLLBACK     The current transaction is rolled back and
10976934fc7bSdrh **                                sqlite3_step() returns immediately with a
10989cfcf5d4Sdrh **                                return code of SQLITE_CONSTRAINT.
10999cfcf5d4Sdrh **
11001c92853dSdrh **  any              ABORT        Back out changes from the current command
11011c92853dSdrh **                                only (do not do a complete rollback) then
11026934fc7bSdrh **                                cause sqlite3_step() to return immediately
11031c92853dSdrh **                                with SQLITE_CONSTRAINT.
11041c92853dSdrh **
11056934fc7bSdrh **  any              FAIL         Sqlite3_step() returns immediately with a
11061c92853dSdrh **                                return code of SQLITE_CONSTRAINT.  The
11071c92853dSdrh **                                transaction is not rolled back and any
11086934fc7bSdrh **                                changes to prior rows are retained.
11091c92853dSdrh **
11106934fc7bSdrh **  any              IGNORE       The attempt in insert or update the current
11116934fc7bSdrh **                                row is skipped, without throwing an error.
11126934fc7bSdrh **                                Processing continues with the next row.
11136934fc7bSdrh **                                (There is an immediate jump to ignoreDest.)
11149cfcf5d4Sdrh **
11159cfcf5d4Sdrh **  NOT NULL         REPLACE      The NULL value is replace by the default
11169cfcf5d4Sdrh **                                value for that column.  If the default value
11179cfcf5d4Sdrh **                                is NULL, the action is the same as ABORT.
11189cfcf5d4Sdrh **
11199cfcf5d4Sdrh **  UNIQUE           REPLACE      The other row that conflicts with the row
11209cfcf5d4Sdrh **                                being inserted is removed.
11219cfcf5d4Sdrh **
11229cfcf5d4Sdrh **  CHECK            REPLACE      Illegal.  The results in an exception.
11239cfcf5d4Sdrh **
11241c92853dSdrh ** Which action to take is determined by the overrideError parameter.
11251c92853dSdrh ** Or if overrideError==OE_Default, then the pParse->onError parameter
11261c92853dSdrh ** is used.  Or if pParse->onError==OE_Default then the onError value
11271c92853dSdrh ** for the constraint is used.
11289cfcf5d4Sdrh */
11294adee20fSdanielk1977 void sqlite3GenerateConstraintChecks(
11309cfcf5d4Sdrh   Parse *pParse,       /* The parser context */
11316934fc7bSdrh   Table *pTab,         /* The table being inserted or updated */
1132f8ffb278Sdrh   int *aRegIdx,        /* Use register aRegIdx[i] for index i.  0 for unused */
11336934fc7bSdrh   int iDataCur,        /* Canonical data cursor (main table or PK index) */
113426198bb4Sdrh   int iIdxCur,         /* First index cursor */
11356934fc7bSdrh   int regNewData,      /* First register in a range holding values to insert */
1136f8ffb278Sdrh   int regOldData,      /* Previous content.  0 for INSERTs */
1137f8ffb278Sdrh   u8 pkChng,           /* Non-zero if the rowid or PRIMARY KEY changed */
1138f8ffb278Sdrh   u8 overrideError,    /* Override onError to this if not OE_Default */
1139de630353Sdanielk1977   int ignoreDest,      /* Jump to this label on an OE_Ignore resolution */
1140de630353Sdanielk1977   int *pbMayReplace    /* OUT: Set to true if constraint may cause a replace */
11419cfcf5d4Sdrh ){
11421b7ecbb4Sdrh   Vdbe *v;             /* VDBE under constrution */
11431b7ecbb4Sdrh   Index *pIdx;         /* Pointer to one of the indices */
114411e85273Sdrh   Index *pPk = 0;      /* The PRIMARY KEY index */
11452938f924Sdrh   sqlite3 *db;         /* Database connection */
1146f8ffb278Sdrh   int i;               /* loop counter */
1147f8ffb278Sdrh   int ix;              /* Index loop counter */
1148f8ffb278Sdrh   int nCol;            /* Number of columns */
1149f8ffb278Sdrh   int onError;         /* Conflict resolution strategy */
115060ec914cSpeter.d.reid   int j1;              /* Address of jump instruction */
11511b7ecbb4Sdrh   int seenReplace = 0; /* True if REPLACE is used to resolve INT PK conflict */
11526fbe41acSdrh   int nPkField;        /* Number of fields in PRIMARY KEY. 1 for ROWID tables */
11538d1b82e4Sdrh   int ipkTop = 0;      /* Top of the rowid change constraint check */
11548d1b82e4Sdrh   int ipkBottom = 0;   /* Bottom of the rowid change constraint check */
11558d1b82e4Sdrh   u8 isUpdate;         /* True if this is an UPDATE operation */
115657bf4a8eSdrh   u8 bAffinityDone = 0;  /* True if the OP_Affinity operation has been run */
11575426d809Sdrh   int regRowid = -1;   /* Register holding ROWID value */
11589cfcf5d4Sdrh 
1159f8ffb278Sdrh   isUpdate = regOldData!=0;
11602938f924Sdrh   db = pParse->db;
11614adee20fSdanielk1977   v = sqlite3GetVdbe(pParse);
11629cfcf5d4Sdrh   assert( v!=0 );
1163417be79cSdrh   assert( pTab->pSelect==0 );  /* This table is not a VIEW */
11649cfcf5d4Sdrh   nCol = pTab->nCol;
1165aa9b8963Sdrh 
11666934fc7bSdrh   /* pPk is the PRIMARY KEY index for WITHOUT ROWID tables and NULL for
11676934fc7bSdrh   ** normal rowid tables.  nPkField is the number of key fields in the
11686934fc7bSdrh   ** pPk index or 1 for a rowid table.  In other words, nPkField is the
11696934fc7bSdrh   ** number of fields in the true primary key of the table. */
117026198bb4Sdrh   if( HasRowid(pTab) ){
117126198bb4Sdrh     pPk = 0;
117226198bb4Sdrh     nPkField = 1;
117326198bb4Sdrh   }else{
117426198bb4Sdrh     pPk = sqlite3PrimaryKeyIndex(pTab);
117526198bb4Sdrh     nPkField = pPk->nKeyCol;
117626198bb4Sdrh   }
11776fbe41acSdrh 
11786fbe41acSdrh   /* Record that this module has started */
11796fbe41acSdrh   VdbeModuleComment((v, "BEGIN: GenCnstCks(%d,%d,%d,%d,%d)",
11806934fc7bSdrh                      iDataCur, iIdxCur, regNewData, regOldData, pkChng));
118111e85273Sdrh 
11829cfcf5d4Sdrh   /* Test all NOT NULL constraints.
11839cfcf5d4Sdrh   */
11849cfcf5d4Sdrh   for(i=0; i<nCol; i++){
11850ca3e24bSdrh     if( i==pTab->iPKey ){
11860ca3e24bSdrh       continue;
11870ca3e24bSdrh     }
11889cfcf5d4Sdrh     onError = pTab->aCol[i].notNull;
11890ca3e24bSdrh     if( onError==OE_None ) continue;
11909cfcf5d4Sdrh     if( overrideError!=OE_Default ){
11919cfcf5d4Sdrh       onError = overrideError;
1192a996e477Sdrh     }else if( onError==OE_Default ){
1193a996e477Sdrh       onError = OE_Abort;
11949cfcf5d4Sdrh     }
11957977a17fSdanielk1977     if( onError==OE_Replace && pTab->aCol[i].pDflt==0 ){
11969cfcf5d4Sdrh       onError = OE_Abort;
11979cfcf5d4Sdrh     }
1198b84f96f8Sdanielk1977     assert( onError==OE_Rollback || onError==OE_Abort || onError==OE_Fail
1199b84f96f8Sdanielk1977         || onError==OE_Ignore || onError==OE_Replace );
12009cfcf5d4Sdrh     switch( onError ){
12011c92853dSdrh       case OE_Abort:
1202e0af83acSdan         sqlite3MayAbort(pParse);
12030978d4ffSdrh         /* Fall through */
1204e0af83acSdan       case OE_Rollback:
12051c92853dSdrh       case OE_Fail: {
1206f9c8ce3cSdrh         char *zMsg = sqlite3MPrintf(db, "%s.%s", pTab->zName,
1207f9c8ce3cSdrh                                     pTab->aCol[i].zName);
1208f9c8ce3cSdrh         sqlite3VdbeAddOp4(v, OP_HaltIfNull, SQLITE_CONSTRAINT_NOTNULL, onError,
1209f9c8ce3cSdrh                           regNewData+1+i, zMsg, P4_DYNAMIC);
1210f9c8ce3cSdrh         sqlite3VdbeChangeP5(v, P5_ConstraintNotNull);
1211688852abSdrh         VdbeCoverage(v);
12129cfcf5d4Sdrh         break;
12139cfcf5d4Sdrh       }
12149cfcf5d4Sdrh       case OE_Ignore: {
12156934fc7bSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, regNewData+1+i, ignoreDest);
1216688852abSdrh         VdbeCoverage(v);
12179cfcf5d4Sdrh         break;
12189cfcf5d4Sdrh       }
1219098d1684Sdrh       default: {
1220098d1684Sdrh         assert( onError==OE_Replace );
1221688852abSdrh         j1 = sqlite3VdbeAddOp1(v, OP_NotNull, regNewData+1+i); VdbeCoverage(v);
12226934fc7bSdrh         sqlite3ExprCode(pParse, pTab->aCol[i].pDflt, regNewData+1+i);
12235053a79bSdrh         sqlite3VdbeJumpHere(v, j1);
12249cfcf5d4Sdrh         break;
12259cfcf5d4Sdrh       }
12269cfcf5d4Sdrh     }
12279cfcf5d4Sdrh   }
12289cfcf5d4Sdrh 
12299cfcf5d4Sdrh   /* Test all CHECK constraints
12309cfcf5d4Sdrh   */
1231ffe07b2dSdrh #ifndef SQLITE_OMIT_CHECK
12322938f924Sdrh   if( pTab->pCheck && (db->flags & SQLITE_IgnoreChecks)==0 ){
12332938f924Sdrh     ExprList *pCheck = pTab->pCheck;
12346934fc7bSdrh     pParse->ckBase = regNewData+1;
1235aa01c7e2Sdrh     onError = overrideError!=OE_Default ? overrideError : OE_Abort;
12362938f924Sdrh     for(i=0; i<pCheck->nExpr; i++){
12372938f924Sdrh       int allOk = sqlite3VdbeMakeLabel(v);
12382d8e9203Sdrh       sqlite3ExprIfTrue(pParse, pCheck->a[i].pExpr, allOk, SQLITE_JUMPIFNULL);
12392e06c67cSdrh       if( onError==OE_Ignore ){
124066a5167bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, ignoreDest);
1241aa01c7e2Sdrh       }else{
1242f9c8ce3cSdrh         char *zName = pCheck->a[i].zName;
1243f9c8ce3cSdrh         if( zName==0 ) zName = pTab->zName;
12446dc84902Sdrh         if( onError==OE_Replace ) onError = OE_Abort; /* IMP: R-15569-63625 */
1245d91c1a17Sdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_CHECK,
1246f9c8ce3cSdrh                               onError, zName, P4_TRANSIENT,
1247f9c8ce3cSdrh                               P5_ConstraintCheck);
1248aa01c7e2Sdrh       }
1249ffe07b2dSdrh       sqlite3VdbeResolveLabel(v, allOk);
1250c31c7c1cSdrh     }
12512938f924Sdrh   }
1252ffe07b2dSdrh #endif /* !defined(SQLITE_OMIT_CHECK) */
12539cfcf5d4Sdrh 
1254f8ffb278Sdrh   /* If rowid is changing, make sure the new rowid does not previously
1255f8ffb278Sdrh   ** exist in the table.
12569cfcf5d4Sdrh   */
12576fbe41acSdrh   if( pkChng && pPk==0 ){
125811e85273Sdrh     int addrRowidOk = sqlite3VdbeMakeLabel(v);
125911e85273Sdrh 
1260f8ffb278Sdrh     /* Figure out what action to take in case of a rowid collision */
12610ca3e24bSdrh     onError = pTab->keyConf;
12620ca3e24bSdrh     if( overrideError!=OE_Default ){
12630ca3e24bSdrh       onError = overrideError;
1264a996e477Sdrh     }else if( onError==OE_Default ){
1265a996e477Sdrh       onError = OE_Abort;
12660ca3e24bSdrh     }
1267a0217ba7Sdrh 
126879b0c956Sdrh     if( isUpdate ){
1269f8ffb278Sdrh       /* pkChng!=0 does not mean that the rowid has change, only that
1270f8ffb278Sdrh       ** it might have changed.  Skip the conflict logic below if the rowid
1271f8ffb278Sdrh       ** is unchanged. */
12726934fc7bSdrh       sqlite3VdbeAddOp3(v, OP_Eq, regNewData, addrRowidOk, regOldData);
12733d77dee9Sdrh       sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
1274688852abSdrh       VdbeCoverage(v);
127579b0c956Sdrh     }
1276f8ffb278Sdrh 
12778d1b82e4Sdrh     /* If the response to a rowid conflict is REPLACE but the response
12788d1b82e4Sdrh     ** to some other UNIQUE constraint is FAIL or IGNORE, then we need
12798d1b82e4Sdrh     ** to defer the running of the rowid conflict checking until after
12808d1b82e4Sdrh     ** the UNIQUE constraints have run.
12818d1b82e4Sdrh     */
12828d1b82e4Sdrh     if( onError==OE_Replace && overrideError!=OE_Replace ){
12838d1b82e4Sdrh       for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
12848d1b82e4Sdrh         if( pIdx->onError==OE_Ignore || pIdx->onError==OE_Fail ){
12858d1b82e4Sdrh           ipkTop = sqlite3VdbeAddOp0(v, OP_Goto);
12868d1b82e4Sdrh           break;
12878d1b82e4Sdrh         }
12888d1b82e4Sdrh       }
12898d1b82e4Sdrh     }
12908d1b82e4Sdrh 
1291f8ffb278Sdrh     /* Check to see if the new rowid already exists in the table.  Skip
1292f8ffb278Sdrh     ** the following conflict logic if it does not. */
12936934fc7bSdrh     sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, addrRowidOk, regNewData);
1294688852abSdrh     VdbeCoverage(v);
1295f8ffb278Sdrh 
1296f8ffb278Sdrh     /* Generate code that deals with a rowid collision */
12970ca3e24bSdrh     switch( onError ){
1298a0217ba7Sdrh       default: {
1299a0217ba7Sdrh         onError = OE_Abort;
1300a0217ba7Sdrh         /* Fall thru into the next case */
1301a0217ba7Sdrh       }
13021c92853dSdrh       case OE_Rollback:
13031c92853dSdrh       case OE_Abort:
13041c92853dSdrh       case OE_Fail: {
1305f9c8ce3cSdrh         sqlite3RowidConstraint(pParse, onError, pTab);
13060ca3e24bSdrh         break;
13070ca3e24bSdrh       }
13085383ae5cSdrh       case OE_Replace: {
13092283d46cSdan         /* If there are DELETE triggers on this table and the
13102283d46cSdan         ** recursive-triggers flag is set, call GenerateRowDelete() to
1311d5578433Smistachkin         ** remove the conflicting row from the table. This will fire
13122283d46cSdan         ** the triggers and remove both the table and index b-tree entries.
13132283d46cSdan         **
13142283d46cSdan         ** Otherwise, if there are no triggers or the recursive-triggers
1315da730f6eSdan         ** flag is not set, but the table has one or more indexes, call
1316da730f6eSdan         ** GenerateRowIndexDelete(). This removes the index b-tree entries
1317da730f6eSdan         ** only. The table b-tree entry will be replaced by the new entry
1318da730f6eSdan         ** when it is inserted.
1319da730f6eSdan         **
1320da730f6eSdan         ** If either GenerateRowDelete() or GenerateRowIndexDelete() is called,
1321da730f6eSdan         ** also invoke MultiWrite() to indicate that this VDBE may require
1322da730f6eSdan         ** statement rollback (if the statement is aborted after the delete
1323da730f6eSdan         ** takes place). Earlier versions called sqlite3MultiWrite() regardless,
1324da730f6eSdan         ** but being more selective here allows statements like:
1325da730f6eSdan         **
1326da730f6eSdan         **   REPLACE INTO t(rowid) VALUES($newrowid)
1327da730f6eSdan         **
1328da730f6eSdan         ** to run without a statement journal if there are no indexes on the
1329da730f6eSdan         ** table.
1330da730f6eSdan         */
13312283d46cSdan         Trigger *pTrigger = 0;
13322938f924Sdrh         if( db->flags&SQLITE_RecTriggers ){
13332283d46cSdan           pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
13342283d46cSdan         }
1335e7a94d81Sdan         if( pTrigger || sqlite3FkRequired(pParse, pTab, 0, 0) ){
1336da730f6eSdan           sqlite3MultiWrite(pParse);
133726198bb4Sdrh           sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
1338392ee21dSdrh                                    regNewData, 1, 0, OE_Replace, 1);
1339da730f6eSdan         }else if( pTab->pIndex ){
1340da730f6eSdan           sqlite3MultiWrite(pParse);
134126198bb4Sdrh           sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur, 0);
13422283d46cSdan         }
13435383ae5cSdrh         seenReplace = 1;
13445383ae5cSdrh         break;
13455383ae5cSdrh       }
13460ca3e24bSdrh       case OE_Ignore: {
13478d1b82e4Sdrh         /*assert( seenReplace==0 );*/
134866a5167bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, ignoreDest);
13490ca3e24bSdrh         break;
13500ca3e24bSdrh       }
13510ca3e24bSdrh     }
135211e85273Sdrh     sqlite3VdbeResolveLabel(v, addrRowidOk);
13538d1b82e4Sdrh     if( ipkTop ){
13548d1b82e4Sdrh       ipkBottom = sqlite3VdbeAddOp0(v, OP_Goto);
13558d1b82e4Sdrh       sqlite3VdbeJumpHere(v, ipkTop);
13568d1b82e4Sdrh     }
13570ca3e24bSdrh   }
13580bd1f4eaSdrh 
13590bd1f4eaSdrh   /* Test all UNIQUE constraints by creating entries for each UNIQUE
13600bd1f4eaSdrh   ** index and making sure that duplicate entries do not already exist.
136111e85273Sdrh   ** Compute the revised record entries for indices as we go.
1362f8ffb278Sdrh   **
1363f8ffb278Sdrh   ** This loop also handles the case of the PRIMARY KEY index for a
1364f8ffb278Sdrh   ** WITHOUT ROWID table.
13650bd1f4eaSdrh   */
136626198bb4Sdrh   for(ix=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, ix++){
13676934fc7bSdrh     int regIdx;          /* Range of registers hold conent for pIdx */
13686934fc7bSdrh     int regR;            /* Range of registers holding conflicting PK */
13696934fc7bSdrh     int iThisCur;        /* Cursor for this UNIQUE index */
13706934fc7bSdrh     int addrUniqueOk;    /* Jump here if the UNIQUE constraint is satisfied */
13712184fc75Sdrh 
137226198bb4Sdrh     if( aRegIdx[ix]==0 ) continue;  /* Skip indices that do not change */
137357bf4a8eSdrh     if( bAffinityDone==0 ){
137457bf4a8eSdrh       sqlite3TableAffinity(v, pTab, regNewData+1);
137557bf4a8eSdrh       bAffinityDone = 1;
137657bf4a8eSdrh     }
13776934fc7bSdrh     iThisCur = iIdxCur+ix;
13786934fc7bSdrh     addrUniqueOk = sqlite3VdbeMakeLabel(v);
1379b2fe7d8cSdrh 
1380f8ffb278Sdrh     /* Skip partial indices for which the WHERE clause is not true */
1381b2b9d3d7Sdrh     if( pIdx->pPartIdxWhere ){
138226198bb4Sdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, aRegIdx[ix]);
13836934fc7bSdrh       pParse->ckBase = regNewData+1;
138411e85273Sdrh       sqlite3ExprIfFalse(pParse, pIdx->pPartIdxWhere, addrUniqueOk,
1385b2b9d3d7Sdrh                          SQLITE_JUMPIFNULL);
1386b2b9d3d7Sdrh       pParse->ckBase = 0;
1387b2b9d3d7Sdrh     }
1388b2b9d3d7Sdrh 
13896934fc7bSdrh     /* Create a record for this index entry as it should appear after
1390f8ffb278Sdrh     ** the insert or update.  Store that record in the aRegIdx[ix] register
1391f8ffb278Sdrh     */
139211e85273Sdrh     regIdx = sqlite3GetTempRange(pParse, pIdx->nColumn);
13939cfcf5d4Sdrh     for(i=0; i<pIdx->nColumn; i++){
13946934fc7bSdrh       int iField = pIdx->aiColumn[i];
1395f82b9afcSdrh       int x;
139626198bb4Sdrh       if( iField<0 || iField==pTab->iPKey ){
13975426d809Sdrh         if( regRowid==regIdx+i ) continue; /* ROWID already in regIdx+i */
1398f82b9afcSdrh         x = regNewData;
13995426d809Sdrh         regRowid =  pIdx->pPartIdxWhere ? -1 : regIdx+i;
14009cfcf5d4Sdrh       }else{
1401f82b9afcSdrh         x = iField + regNewData + 1;
14029cfcf5d4Sdrh       }
1403f82b9afcSdrh       sqlite3VdbeAddOp2(v, OP_SCopy, x, regIdx+i);
1404f82b9afcSdrh       VdbeComment((v, "%s", iField<0 ? "rowid" : pTab->aCol[iField].zName));
14059cfcf5d4Sdrh     }
140626198bb4Sdrh     sqlite3VdbeAddOp3(v, OP_MakeRecord, regIdx, pIdx->nColumn, aRegIdx[ix]);
140726198bb4Sdrh     VdbeComment((v, "for %s", pIdx->zName));
1408bbbdc83bSdrh     sqlite3ExprCacheAffinityChange(pParse, regIdx, pIdx->nColumn);
1409b2fe7d8cSdrh 
1410f8ffb278Sdrh     /* In an UPDATE operation, if this index is the PRIMARY KEY index
1411f8ffb278Sdrh     ** of a WITHOUT ROWID table and there has been no change the
1412f8ffb278Sdrh     ** primary key, then no collision is possible.  The collision detection
1413f8ffb278Sdrh     ** logic below can all be skipped. */
141400012df4Sdrh     if( isUpdate && pPk==pIdx && pkChng==0 ){
1415da475b8dSdrh       sqlite3VdbeResolveLabel(v, addrUniqueOk);
1416da475b8dSdrh       continue;
1417da475b8dSdrh     }
1418f8ffb278Sdrh 
14196934fc7bSdrh     /* Find out what action to take in case there is a uniqueness conflict */
14209cfcf5d4Sdrh     onError = pIdx->onError;
1421de630353Sdanielk1977     if( onError==OE_None ){
142226198bb4Sdrh       sqlite3ReleaseTempRange(pParse, regIdx, pIdx->nColumn);
142311e85273Sdrh       sqlite3VdbeResolveLabel(v, addrUniqueOk);
1424de630353Sdanielk1977       continue;  /* pIdx is not a UNIQUE index */
1425de630353Sdanielk1977     }
14269cfcf5d4Sdrh     if( overrideError!=OE_Default ){
14279cfcf5d4Sdrh       onError = overrideError;
1428a996e477Sdrh     }else if( onError==OE_Default ){
1429a996e477Sdrh       onError = OE_Abort;
14309cfcf5d4Sdrh     }
14315383ae5cSdrh 
1432b2fe7d8cSdrh     /* Check to see if the new index entry will be unique */
143326198bb4Sdrh     sqlite3VdbeAddOp4Int(v, OP_NoConflict, iThisCur, addrUniqueOk,
1434688852abSdrh                          regIdx, pIdx->nKeyCol); VdbeCoverage(v);
1435f8ffb278Sdrh 
1436f8ffb278Sdrh     /* Generate code to handle collisions */
1437392ee21dSdrh     regR = (pIdx==pPk) ? regIdx : sqlite3GetTempRange(pParse, nPkField);
143846d03fcbSdrh     if( isUpdate || onError==OE_Replace ){
143911e85273Sdrh       if( HasRowid(pTab) ){
14406934fc7bSdrh         sqlite3VdbeAddOp2(v, OP_IdxRowid, iThisCur, regR);
14410978d4ffSdrh         /* Conflict only if the rowid of the existing index entry
14420978d4ffSdrh         ** is different from old-rowid */
1443f8ffb278Sdrh         if( isUpdate ){
14446934fc7bSdrh           sqlite3VdbeAddOp3(v, OP_Eq, regR, addrUniqueOk, regOldData);
14453d77dee9Sdrh           sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
1446688852abSdrh           VdbeCoverage(v);
1447f8ffb278Sdrh         }
144826198bb4Sdrh       }else{
1449ccc79f02Sdrh         int x;
145026198bb4Sdrh         /* Extract the PRIMARY KEY from the end of the index entry and
1451da475b8dSdrh         ** store it in registers regR..regR+nPk-1 */
1452a021f121Sdrh         if( pIdx!=pPk ){
145326198bb4Sdrh           for(i=0; i<pPk->nKeyCol; i++){
1454ccc79f02Sdrh             x = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[i]);
145526198bb4Sdrh             sqlite3VdbeAddOp3(v, OP_Column, iThisCur, x, regR+i);
145626198bb4Sdrh             VdbeComment((v, "%s.%s", pTab->zName,
145726198bb4Sdrh                          pTab->aCol[pPk->aiColumn[i]].zName));
145826198bb4Sdrh           }
1459da475b8dSdrh         }
1460da475b8dSdrh         if( isUpdate ){
1461e83267daSdan           /* If currently processing the PRIMARY KEY of a WITHOUT ROWID
1462e83267daSdan           ** table, only conflict if the new PRIMARY KEY values are actually
1463e83267daSdan           ** different from the old.
1464e83267daSdan           **
1465e83267daSdan           ** For a UNIQUE index, only conflict if the PRIMARY KEY values
1466e83267daSdan           ** of the matched index row are different from the original PRIMARY
1467e83267daSdan           ** KEY values of this row before the update.  */
1468e83267daSdan           int addrJump = sqlite3VdbeCurrentAddr(v)+pPk->nKeyCol;
1469e83267daSdan           int op = OP_Ne;
147048dd1d8eSdrh           int regCmp = (IsPrimaryKeyIndex(pIdx) ? regIdx : regR);
1471e83267daSdan 
1472e83267daSdan           for(i=0; i<pPk->nKeyCol; i++){
1473e83267daSdan             char *p4 = (char*)sqlite3LocateCollSeq(pParse, pPk->azColl[i]);
1474ccc79f02Sdrh             x = pPk->aiColumn[i];
1475e83267daSdan             if( i==(pPk->nKeyCol-1) ){
1476e83267daSdan               addrJump = addrUniqueOk;
1477e83267daSdan               op = OP_Eq;
147811e85273Sdrh             }
1479e83267daSdan             sqlite3VdbeAddOp4(v, op,
1480e83267daSdan                 regOldData+1+x, addrJump, regCmp+i, p4, P4_COLLSEQ
14813d77dee9Sdrh             );
14823d77dee9Sdrh             sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
14833d77dee9Sdrh             VdbeCoverageIf(v, op==OP_Eq);
14843d77dee9Sdrh             VdbeCoverageIf(v, op==OP_Ne);
1485da475b8dSdrh           }
148611e85273Sdrh         }
148726198bb4Sdrh       }
148846d03fcbSdrh     }
1489b2fe7d8cSdrh 
1490b2fe7d8cSdrh     /* Generate code that executes if the new index entry is not unique */
1491b84f96f8Sdanielk1977     assert( onError==OE_Rollback || onError==OE_Abort || onError==OE_Fail
1492b84f96f8Sdanielk1977         || onError==OE_Ignore || onError==OE_Replace );
14939cfcf5d4Sdrh     switch( onError ){
14941c92853dSdrh       case OE_Rollback:
14951c92853dSdrh       case OE_Abort:
14961c92853dSdrh       case OE_Fail: {
1497f9c8ce3cSdrh         sqlite3UniqueConstraint(pParse, onError, pIdx);
14989cfcf5d4Sdrh         break;
14999cfcf5d4Sdrh       }
15009cfcf5d4Sdrh       case OE_Ignore: {
150166a5167bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, ignoreDest);
15029cfcf5d4Sdrh         break;
15039cfcf5d4Sdrh       }
1504098d1684Sdrh       default: {
15052283d46cSdan         Trigger *pTrigger = 0;
1506098d1684Sdrh         assert( onError==OE_Replace );
15071bea559aSdan         sqlite3MultiWrite(pParse);
15082938f924Sdrh         if( db->flags&SQLITE_RecTriggers ){
15092283d46cSdan           pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
15102283d46cSdan         }
151126198bb4Sdrh         sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
1512392ee21dSdrh                                  regR, nPkField, 0, OE_Replace, pIdx==pPk);
15130ca3e24bSdrh         seenReplace = 1;
15149cfcf5d4Sdrh         break;
15159cfcf5d4Sdrh       }
15169cfcf5d4Sdrh     }
151711e85273Sdrh     sqlite3VdbeResolveLabel(v, addrUniqueOk);
1518392ee21dSdrh     sqlite3ReleaseTempRange(pParse, regIdx, pIdx->nColumn);
1519392ee21dSdrh     if( regR!=regIdx ) sqlite3ReleaseTempRange(pParse, regR, nPkField);
15209cfcf5d4Sdrh   }
15218d1b82e4Sdrh   if( ipkTop ){
15228d1b82e4Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, ipkTop+1);
15238d1b82e4Sdrh     sqlite3VdbeJumpHere(v, ipkBottom);
15248d1b82e4Sdrh   }
1525de630353Sdanielk1977 
1526de630353Sdanielk1977   *pbMayReplace = seenReplace;
1527ce60aa46Sdrh   VdbeModuleComment((v, "END: GenCnstCks(%d)", seenReplace));
15289cfcf5d4Sdrh }
15290ca3e24bSdrh 
15300ca3e24bSdrh /*
15310ca3e24bSdrh ** This routine generates code to finish the INSERT or UPDATE operation
15324adee20fSdanielk1977 ** that was started by a prior call to sqlite3GenerateConstraintChecks.
15336934fc7bSdrh ** A consecutive range of registers starting at regNewData contains the
153404adf416Sdrh ** rowid and the content to be inserted.
15350ca3e24bSdrh **
1536b419a926Sdrh ** The arguments to this routine should be the same as the first six
15374adee20fSdanielk1977 ** arguments to sqlite3GenerateConstraintChecks.
15380ca3e24bSdrh */
15394adee20fSdanielk1977 void sqlite3CompleteInsertion(
15400ca3e24bSdrh   Parse *pParse,      /* The parser context */
15410ca3e24bSdrh   Table *pTab,        /* the table into which we are inserting */
154226198bb4Sdrh   int iDataCur,       /* Cursor of the canonical data source */
154326198bb4Sdrh   int iIdxCur,        /* First index cursor */
15446934fc7bSdrh   int regNewData,     /* Range of content */
1545aa9b8963Sdrh   int *aRegIdx,       /* Register used by each index.  0 for unused indices */
154670ce3f0cSdrh   int isUpdate,       /* True for UPDATE, False for INSERT */
1547de630353Sdanielk1977   int appendBias,     /* True if this is likely to be an append */
1548de630353Sdanielk1977   int useSeekResult   /* True to set the USESEEKRESULT flag on OP_[Idx]Insert */
15490ca3e24bSdrh ){
15506934fc7bSdrh   Vdbe *v;            /* Prepared statements under construction */
15516934fc7bSdrh   Index *pIdx;        /* An index being inserted or updated */
15526934fc7bSdrh   u8 pik_flags;       /* flag values passed to the btree insert */
15536934fc7bSdrh   int regData;        /* Content registers (after the rowid) */
155460ec914cSpeter.d.reid   int regRec;         /* Register holding assembled record for the table */
15556934fc7bSdrh   int i;              /* Loop counter */
155657bf4a8eSdrh   u8 bAffinityDone = 0; /* True if OP_Affinity has been run already */
15570ca3e24bSdrh 
15584adee20fSdanielk1977   v = sqlite3GetVdbe(pParse);
15590ca3e24bSdrh   assert( v!=0 );
1560417be79cSdrh   assert( pTab->pSelect==0 );  /* This table is not a VIEW */
1561b2b9d3d7Sdrh   for(i=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, i++){
1562aa9b8963Sdrh     if( aRegIdx[i]==0 ) continue;
156357bf4a8eSdrh     bAffinityDone = 1;
1564b2b9d3d7Sdrh     if( pIdx->pPartIdxWhere ){
1565b2b9d3d7Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, aRegIdx[i], sqlite3VdbeCurrentAddr(v)+2);
1566688852abSdrh       VdbeCoverage(v);
1567b2b9d3d7Sdrh     }
156826198bb4Sdrh     sqlite3VdbeAddOp2(v, OP_IdxInsert, iIdxCur+i, aRegIdx[i]);
15696546af14Sdrh     pik_flags = 0;
15706546af14Sdrh     if( useSeekResult ) pik_flags = OPFLAG_USESEEKRESULT;
157148dd1d8eSdrh     if( IsPrimaryKeyIndex(pIdx) && !HasRowid(pTab) ){
15724308e348Sdrh       assert( pParse->nested==0 );
15736546af14Sdrh       pik_flags |= OPFLAG_NCHANGE;
1574de630353Sdanielk1977     }
15756546af14Sdrh     if( pik_flags )  sqlite3VdbeChangeP5(v, pik_flags);
15760ca3e24bSdrh   }
1577ec95c441Sdrh   if( !HasRowid(pTab) ) return;
15786934fc7bSdrh   regData = regNewData + 1;
1579b7654111Sdrh   regRec = sqlite3GetTempReg(pParse);
15801db639ceSdrh   sqlite3VdbeAddOp3(v, OP_MakeRecord, regData, pTab->nCol, regRec);
158157bf4a8eSdrh   if( !bAffinityDone ) sqlite3TableAffinity(v, pTab, 0);
1582da250ea5Sdrh   sqlite3ExprCacheAffinityChange(pParse, regData, pTab->nCol);
15834794f735Sdrh   if( pParse->nested ){
15844794f735Sdrh     pik_flags = 0;
15854794f735Sdrh   }else{
158694eb6a14Sdanielk1977     pik_flags = OPFLAG_NCHANGE;
158794eb6a14Sdanielk1977     pik_flags |= (isUpdate?OPFLAG_ISUPDATE:OPFLAG_LASTROWID);
15884794f735Sdrh   }
1589e4d90813Sdrh   if( appendBias ){
1590e4d90813Sdrh     pik_flags |= OPFLAG_APPEND;
1591e4d90813Sdrh   }
1592de630353Sdanielk1977   if( useSeekResult ){
1593de630353Sdanielk1977     pik_flags |= OPFLAG_USESEEKRESULT;
1594de630353Sdanielk1977   }
15956934fc7bSdrh   sqlite3VdbeAddOp3(v, OP_Insert, iDataCur, regRec, regNewData);
159694eb6a14Sdanielk1977   if( !pParse->nested ){
15978d129422Sdrh     sqlite3VdbeChangeP4(v, -1, pTab->zName, P4_TRANSIENT);
159894eb6a14Sdanielk1977   }
1599b7654111Sdrh   sqlite3VdbeChangeP5(v, pik_flags);
16000ca3e24bSdrh }
1601cd44690aSdrh 
1602cd44690aSdrh /*
160326198bb4Sdrh ** Allocate cursors for the pTab table and all its indices and generate
160426198bb4Sdrh ** code to open and initialized those cursors.
1605aa9b8963Sdrh **
160626198bb4Sdrh ** The cursor for the object that contains the complete data (normally
160726198bb4Sdrh ** the table itself, but the PRIMARY KEY index in the case of a WITHOUT
160826198bb4Sdrh ** ROWID table) is returned in *piDataCur.  The first index cursor is
160926198bb4Sdrh ** returned in *piIdxCur.  The number of indices is returned.
161026198bb4Sdrh **
161126198bb4Sdrh ** Use iBase as the first cursor (either the *piDataCur for rowid tables
161226198bb4Sdrh ** or the first index for WITHOUT ROWID tables) if it is non-negative.
161326198bb4Sdrh ** If iBase is negative, then allocate the next available cursor.
161426198bb4Sdrh **
161526198bb4Sdrh ** For a rowid table, *piDataCur will be exactly one less than *piIdxCur.
161626198bb4Sdrh ** For a WITHOUT ROWID table, *piDataCur will be somewhere in the range
161726198bb4Sdrh ** of *piIdxCurs, depending on where the PRIMARY KEY index appears on the
161826198bb4Sdrh ** pTab->pIndex list.
1619b6b4b79fSdrh **
1620b6b4b79fSdrh ** If pTab is a virtual table, then this routine is a no-op and the
1621b6b4b79fSdrh ** *piDataCur and *piIdxCur values are left uninitialized.
1622cd44690aSdrh */
1623aa9b8963Sdrh int sqlite3OpenTableAndIndices(
1624290c1948Sdrh   Parse *pParse,   /* Parsing context */
1625290c1948Sdrh   Table *pTab,     /* Table to be opened */
162626198bb4Sdrh   int op,          /* OP_OpenRead or OP_OpenWrite */
162726198bb4Sdrh   int iBase,       /* Use this for the table cursor, if there is one */
16286a53499aSdrh   u8 *aToOpen,     /* If not NULL: boolean for each table and index */
162926198bb4Sdrh   int *piDataCur,  /* Write the database source cursor number here */
163026198bb4Sdrh   int *piIdxCur    /* Write the first index cursor number here */
1631290c1948Sdrh ){
1632cd44690aSdrh   int i;
16334cbdda9eSdrh   int iDb;
16346a53499aSdrh   int iDataCur;
1635cd44690aSdrh   Index *pIdx;
16364cbdda9eSdrh   Vdbe *v;
16374cbdda9eSdrh 
163826198bb4Sdrh   assert( op==OP_OpenRead || op==OP_OpenWrite );
163926198bb4Sdrh   if( IsVirtual(pTab) ){
1640b6b4b79fSdrh     /* This routine is a no-op for virtual tables. Leave the output
1641b6b4b79fSdrh     ** variables *piDataCur and *piIdxCur uninitialized so that valgrind
1642b6b4b79fSdrh     ** can detect if they are used by mistake in the caller. */
164326198bb4Sdrh     return 0;
164426198bb4Sdrh   }
16454cbdda9eSdrh   iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
16464cbdda9eSdrh   v = sqlite3GetVdbe(pParse);
1647cd44690aSdrh   assert( v!=0 );
164826198bb4Sdrh   if( iBase<0 ) iBase = pParse->nTab;
16496a53499aSdrh   iDataCur = iBase++;
16506a53499aSdrh   if( piDataCur ) *piDataCur = iDataCur;
16516a53499aSdrh   if( HasRowid(pTab) && (aToOpen==0 || aToOpen[0]) ){
16526a53499aSdrh     sqlite3OpenTable(pParse, iDataCur, iDb, pTab, op);
16536fbe41acSdrh   }else{
165426198bb4Sdrh     sqlite3TableLock(pParse, iDb, pTab->tnum, op==OP_OpenWrite, pTab->zName);
16556fbe41acSdrh   }
16566a53499aSdrh   if( piIdxCur ) *piIdxCur = iBase;
165726198bb4Sdrh   for(i=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, i++){
165826198bb4Sdrh     int iIdxCur = iBase++;
1659da184236Sdanielk1977     assert( pIdx->pSchema==pTab->pSchema );
166048dd1d8eSdrh     if( IsPrimaryKeyIndex(pIdx) && !HasRowid(pTab) && piDataCur ){
16616a53499aSdrh       *piDataCur = iIdxCur;
16626a53499aSdrh     }
16636a53499aSdrh     if( aToOpen==0 || aToOpen[i+1] ){
16642ec2fb22Sdrh       sqlite3VdbeAddOp3(v, op, iIdxCur, pIdx->tnum, iDb);
16652ec2fb22Sdrh       sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
1666207872a4Sdanielk1977       VdbeComment((v, "%s", pIdx->zName));
1667cd44690aSdrh     }
16686a53499aSdrh   }
166926198bb4Sdrh   if( iBase>pParse->nTab ) pParse->nTab = iBase;
167026198bb4Sdrh   return i;
1671cd44690aSdrh }
16729d9cf229Sdrh 
167391c58e23Sdrh 
167491c58e23Sdrh #ifdef SQLITE_TEST
167591c58e23Sdrh /*
167691c58e23Sdrh ** The following global variable is incremented whenever the
167791c58e23Sdrh ** transfer optimization is used.  This is used for testing
167891c58e23Sdrh ** purposes only - to make sure the transfer optimization really
167960ec914cSpeter.d.reid ** is happening when it is supposed to.
168091c58e23Sdrh */
168191c58e23Sdrh int sqlite3_xferopt_count;
168291c58e23Sdrh #endif /* SQLITE_TEST */
168391c58e23Sdrh 
168491c58e23Sdrh 
16859d9cf229Sdrh #ifndef SQLITE_OMIT_XFER_OPT
16869d9cf229Sdrh /*
16879d9cf229Sdrh ** Check to collation names to see if they are compatible.
16889d9cf229Sdrh */
16899d9cf229Sdrh static int xferCompatibleCollation(const char *z1, const char *z2){
16909d9cf229Sdrh   if( z1==0 ){
16919d9cf229Sdrh     return z2==0;
16929d9cf229Sdrh   }
16939d9cf229Sdrh   if( z2==0 ){
16949d9cf229Sdrh     return 0;
16959d9cf229Sdrh   }
16969d9cf229Sdrh   return sqlite3StrICmp(z1, z2)==0;
16979d9cf229Sdrh }
16989d9cf229Sdrh 
16999d9cf229Sdrh 
17009d9cf229Sdrh /*
17019d9cf229Sdrh ** Check to see if index pSrc is compatible as a source of data
17029d9cf229Sdrh ** for index pDest in an insert transfer optimization.  The rules
17039d9cf229Sdrh ** for a compatible index:
17049d9cf229Sdrh **
17059d9cf229Sdrh **    *   The index is over the same set of columns
17069d9cf229Sdrh **    *   The same DESC and ASC markings occurs on all columns
17079d9cf229Sdrh **    *   The same onError processing (OE_Abort, OE_Ignore, etc)
17089d9cf229Sdrh **    *   The same collating sequence on each column
1709b2b9d3d7Sdrh **    *   The index has the exact same WHERE clause
17109d9cf229Sdrh */
17119d9cf229Sdrh static int xferCompatibleIndex(Index *pDest, Index *pSrc){
17129d9cf229Sdrh   int i;
17139d9cf229Sdrh   assert( pDest && pSrc );
17149d9cf229Sdrh   assert( pDest->pTable!=pSrc->pTable );
1715bbbdc83bSdrh   if( pDest->nKeyCol!=pSrc->nKeyCol ){
17169d9cf229Sdrh     return 0;   /* Different number of columns */
17179d9cf229Sdrh   }
17189d9cf229Sdrh   if( pDest->onError!=pSrc->onError ){
17199d9cf229Sdrh     return 0;   /* Different conflict resolution strategies */
17209d9cf229Sdrh   }
1721bbbdc83bSdrh   for(i=0; i<pSrc->nKeyCol; i++){
17229d9cf229Sdrh     if( pSrc->aiColumn[i]!=pDest->aiColumn[i] ){
17239d9cf229Sdrh       return 0;   /* Different columns indexed */
17249d9cf229Sdrh     }
17259d9cf229Sdrh     if( pSrc->aSortOrder[i]!=pDest->aSortOrder[i] ){
17269d9cf229Sdrh       return 0;   /* Different sort orders */
17279d9cf229Sdrh     }
17283f6e781dSdrh     if( !xferCompatibleCollation(pSrc->azColl[i],pDest->azColl[i]) ){
172960a713c6Sdrh       return 0;   /* Different collating sequences */
17309d9cf229Sdrh     }
17319d9cf229Sdrh   }
1732619a1305Sdrh   if( sqlite3ExprCompare(pSrc->pPartIdxWhere, pDest->pPartIdxWhere, -1) ){
1733b2b9d3d7Sdrh     return 0;     /* Different WHERE clauses */
1734b2b9d3d7Sdrh   }
17359d9cf229Sdrh 
17369d9cf229Sdrh   /* If no test above fails then the indices must be compatible */
17379d9cf229Sdrh   return 1;
17389d9cf229Sdrh }
17399d9cf229Sdrh 
17409d9cf229Sdrh /*
17419d9cf229Sdrh ** Attempt the transfer optimization on INSERTs of the form
17429d9cf229Sdrh **
17439d9cf229Sdrh **     INSERT INTO tab1 SELECT * FROM tab2;
17449d9cf229Sdrh **
1745ccdf1baeSdrh ** The xfer optimization transfers raw records from tab2 over to tab1.
174660ec914cSpeter.d.reid ** Columns are not decoded and reassembled, which greatly improves
1747ccdf1baeSdrh ** performance.  Raw index records are transferred in the same way.
17489d9cf229Sdrh **
1749ccdf1baeSdrh ** The xfer optimization is only attempted if tab1 and tab2 are compatible.
1750ccdf1baeSdrh ** There are lots of rules for determining compatibility - see comments
1751ccdf1baeSdrh ** embedded in the code for details.
17529d9cf229Sdrh **
1753ccdf1baeSdrh ** This routine returns TRUE if the optimization is guaranteed to be used.
1754ccdf1baeSdrh ** Sometimes the xfer optimization will only work if the destination table
1755ccdf1baeSdrh ** is empty - a factor that can only be determined at run-time.  In that
1756ccdf1baeSdrh ** case, this routine generates code for the xfer optimization but also
1757ccdf1baeSdrh ** does a test to see if the destination table is empty and jumps over the
1758ccdf1baeSdrh ** xfer optimization code if the test fails.  In that case, this routine
1759ccdf1baeSdrh ** returns FALSE so that the caller will know to go ahead and generate
1760ccdf1baeSdrh ** an unoptimized transfer.  This routine also returns FALSE if there
1761ccdf1baeSdrh ** is no chance that the xfer optimization can be applied.
17629d9cf229Sdrh **
1763ccdf1baeSdrh ** This optimization is particularly useful at making VACUUM run faster.
17649d9cf229Sdrh */
17659d9cf229Sdrh static int xferOptimization(
17669d9cf229Sdrh   Parse *pParse,        /* Parser context */
17679d9cf229Sdrh   Table *pDest,         /* The table we are inserting into */
17689d9cf229Sdrh   Select *pSelect,      /* A SELECT statement to use as the data source */
17699d9cf229Sdrh   int onError,          /* How to handle constraint errors */
17709d9cf229Sdrh   int iDbDest           /* The database of pDest */
17719d9cf229Sdrh ){
1772e34162b1Sdan   sqlite3 *db = pParse->db;
17739d9cf229Sdrh   ExprList *pEList;                /* The result set of the SELECT */
17749d9cf229Sdrh   Table *pSrc;                     /* The table in the FROM clause of SELECT */
17759d9cf229Sdrh   Index *pSrcIdx, *pDestIdx;       /* Source and destination indices */
17769d9cf229Sdrh   struct SrcList_item *pItem;      /* An element of pSelect->pSrc */
17779d9cf229Sdrh   int i;                           /* Loop counter */
17789d9cf229Sdrh   int iDbSrc;                      /* The database of pSrc */
17799d9cf229Sdrh   int iSrc, iDest;                 /* Cursors from source and destination */
17809d9cf229Sdrh   int addr1, addr2;                /* Loop addresses */
1781da475b8dSdrh   int emptyDestTest = 0;           /* Address of test for empty pDest */
1782da475b8dSdrh   int emptySrcTest = 0;            /* Address of test for empty pSrc */
17839d9cf229Sdrh   Vdbe *v;                         /* The VDBE we are building */
17846a288a33Sdrh   int regAutoinc;                  /* Memory register used by AUTOINC */
1785f33c9fadSdrh   int destHasUniqueIdx = 0;        /* True if pDest has a UNIQUE index */
1786b7654111Sdrh   int regData, regRowid;           /* Registers holding data and rowid */
17879d9cf229Sdrh 
17889d9cf229Sdrh   if( pSelect==0 ){
17899d9cf229Sdrh     return 0;   /* Must be of the form  INSERT INTO ... SELECT ... */
17909d9cf229Sdrh   }
1791ebbf08a0Sdan   if( pParse->pWith || pSelect->pWith ){
1792ebbf08a0Sdan     /* Do not attempt to process this query if there are an WITH clauses
1793ebbf08a0Sdan     ** attached to it. Proceeding may generate a false "no such table: xxx"
1794ebbf08a0Sdan     ** error if pSelect reads from a CTE named "xxx".  */
1795ebbf08a0Sdan     return 0;
1796ebbf08a0Sdan   }
17972f886d1dSdanielk1977   if( sqlite3TriggerList(pParse, pDest) ){
17989d9cf229Sdrh     return 0;   /* tab1 must not have triggers */
17999d9cf229Sdrh   }
18009d9cf229Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
18017d10d5a6Sdrh   if( pDest->tabFlags & TF_Virtual ){
18029d9cf229Sdrh     return 0;   /* tab1 must not be a virtual table */
18039d9cf229Sdrh   }
18049d9cf229Sdrh #endif
18059d9cf229Sdrh   if( onError==OE_Default ){
1806e7224a01Sdrh     if( pDest->iPKey>=0 ) onError = pDest->keyConf;
1807e7224a01Sdrh     if( onError==OE_Default ) onError = OE_Abort;
18089d9cf229Sdrh   }
18095ce240a6Sdanielk1977   assert(pSelect->pSrc);   /* allocated even if there is no FROM clause */
18109d9cf229Sdrh   if( pSelect->pSrc->nSrc!=1 ){
18119d9cf229Sdrh     return 0;   /* FROM clause must have exactly one term */
18129d9cf229Sdrh   }
18139d9cf229Sdrh   if( pSelect->pSrc->a[0].pSelect ){
18149d9cf229Sdrh     return 0;   /* FROM clause cannot contain a subquery */
18159d9cf229Sdrh   }
18169d9cf229Sdrh   if( pSelect->pWhere ){
18179d9cf229Sdrh     return 0;   /* SELECT may not have a WHERE clause */
18189d9cf229Sdrh   }
18199d9cf229Sdrh   if( pSelect->pOrderBy ){
18209d9cf229Sdrh     return 0;   /* SELECT may not have an ORDER BY clause */
18219d9cf229Sdrh   }
18228103b7d2Sdrh   /* Do not need to test for a HAVING clause.  If HAVING is present but
18238103b7d2Sdrh   ** there is no ORDER BY, we will get an error. */
18249d9cf229Sdrh   if( pSelect->pGroupBy ){
18259d9cf229Sdrh     return 0;   /* SELECT may not have a GROUP BY clause */
18269d9cf229Sdrh   }
18279d9cf229Sdrh   if( pSelect->pLimit ){
18289d9cf229Sdrh     return 0;   /* SELECT may not have a LIMIT clause */
18299d9cf229Sdrh   }
18308103b7d2Sdrh   assert( pSelect->pOffset==0 );  /* Must be so if pLimit==0 */
18319d9cf229Sdrh   if( pSelect->pPrior ){
18329d9cf229Sdrh     return 0;   /* SELECT may not be a compound query */
18339d9cf229Sdrh   }
18347d10d5a6Sdrh   if( pSelect->selFlags & SF_Distinct ){
18359d9cf229Sdrh     return 0;   /* SELECT may not be DISTINCT */
18369d9cf229Sdrh   }
18379d9cf229Sdrh   pEList = pSelect->pEList;
18389d9cf229Sdrh   assert( pEList!=0 );
18399d9cf229Sdrh   if( pEList->nExpr!=1 ){
18409d9cf229Sdrh     return 0;   /* The result set must have exactly one column */
18419d9cf229Sdrh   }
18429d9cf229Sdrh   assert( pEList->a[0].pExpr );
18439d9cf229Sdrh   if( pEList->a[0].pExpr->op!=TK_ALL ){
18449d9cf229Sdrh     return 0;   /* The result set must be the special operator "*" */
18459d9cf229Sdrh   }
18469d9cf229Sdrh 
18479d9cf229Sdrh   /* At this point we have established that the statement is of the
18489d9cf229Sdrh   ** correct syntactic form to participate in this optimization.  Now
18499d9cf229Sdrh   ** we have to check the semantics.
18509d9cf229Sdrh   */
18519d9cf229Sdrh   pItem = pSelect->pSrc->a;
185241fb5cd1Sdan   pSrc = sqlite3LocateTableItem(pParse, 0, pItem);
18539d9cf229Sdrh   if( pSrc==0 ){
18549d9cf229Sdrh     return 0;   /* FROM clause does not contain a real table */
18559d9cf229Sdrh   }
18569d9cf229Sdrh   if( pSrc==pDest ){
18579d9cf229Sdrh     return 0;   /* tab1 and tab2 may not be the same table */
18589d9cf229Sdrh   }
185955548273Sdrh   if( HasRowid(pDest)!=HasRowid(pSrc) ){
186055548273Sdrh     return 0;   /* source and destination must both be WITHOUT ROWID or not */
186155548273Sdrh   }
18629d9cf229Sdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
18637d10d5a6Sdrh   if( pSrc->tabFlags & TF_Virtual ){
18649d9cf229Sdrh     return 0;   /* tab2 must not be a virtual table */
18659d9cf229Sdrh   }
18669d9cf229Sdrh #endif
18679d9cf229Sdrh   if( pSrc->pSelect ){
18689d9cf229Sdrh     return 0;   /* tab2 may not be a view */
18699d9cf229Sdrh   }
18709d9cf229Sdrh   if( pDest->nCol!=pSrc->nCol ){
18719d9cf229Sdrh     return 0;   /* Number of columns must be the same in tab1 and tab2 */
18729d9cf229Sdrh   }
18739d9cf229Sdrh   if( pDest->iPKey!=pSrc->iPKey ){
18749d9cf229Sdrh     return 0;   /* Both tables must have the same INTEGER PRIMARY KEY */
18759d9cf229Sdrh   }
18769d9cf229Sdrh   for(i=0; i<pDest->nCol; i++){
18779940e2aaSdan     Column *pDestCol = &pDest->aCol[i];
18789940e2aaSdan     Column *pSrcCol = &pSrc->aCol[i];
18799940e2aaSdan     if( pDestCol->affinity!=pSrcCol->affinity ){
18809d9cf229Sdrh       return 0;    /* Affinity must be the same on all columns */
18819d9cf229Sdrh     }
18829940e2aaSdan     if( !xferCompatibleCollation(pDestCol->zColl, pSrcCol->zColl) ){
18839d9cf229Sdrh       return 0;    /* Collating sequence must be the same on all columns */
18849d9cf229Sdrh     }
18859940e2aaSdan     if( pDestCol->notNull && !pSrcCol->notNull ){
18869d9cf229Sdrh       return 0;    /* tab2 must be NOT NULL if tab1 is */
18879d9cf229Sdrh     }
1888453e0261Sdrh     /* Default values for second and subsequent columns need to match. */
1889453e0261Sdrh     if( i>0
1890453e0261Sdrh      && ((pDestCol->zDflt==0)!=(pSrcCol->zDflt==0)
1891453e0261Sdrh          || (pDestCol->zDflt && strcmp(pDestCol->zDflt, pSrcCol->zDflt)!=0))
18929940e2aaSdan     ){
18939940e2aaSdan       return 0;    /* Default values must be the same for all columns */
18949940e2aaSdan     }
18959d9cf229Sdrh   }
18969d9cf229Sdrh   for(pDestIdx=pDest->pIndex; pDestIdx; pDestIdx=pDestIdx->pNext){
18975f1d1d9cSdrh     if( IsUniqueIndex(pDestIdx) ){
1898f33c9fadSdrh       destHasUniqueIdx = 1;
1899f33c9fadSdrh     }
19009d9cf229Sdrh     for(pSrcIdx=pSrc->pIndex; pSrcIdx; pSrcIdx=pSrcIdx->pNext){
19019d9cf229Sdrh       if( xferCompatibleIndex(pDestIdx, pSrcIdx) ) break;
19029d9cf229Sdrh     }
19039d9cf229Sdrh     if( pSrcIdx==0 ){
19049d9cf229Sdrh       return 0;    /* pDestIdx has no corresponding index in pSrc */
19059d9cf229Sdrh     }
19069d9cf229Sdrh   }
19077fc2f41bSdrh #ifndef SQLITE_OMIT_CHECK
1908619a1305Sdrh   if( pDest->pCheck && sqlite3ExprListCompare(pSrc->pCheck,pDest->pCheck,-1) ){
19098103b7d2Sdrh     return 0;   /* Tables have different CHECK constraints.  Ticket #2252 */
19108103b7d2Sdrh   }
19117fc2f41bSdrh #endif
1912713de341Sdrh #ifndef SQLITE_OMIT_FOREIGN_KEY
1913713de341Sdrh   /* Disallow the transfer optimization if the destination table constains
1914713de341Sdrh   ** any foreign key constraints.  This is more restrictive than necessary.
1915713de341Sdrh   ** But the main beneficiary of the transfer optimization is the VACUUM
1916713de341Sdrh   ** command, and the VACUUM command disables foreign key constraints.  So
1917713de341Sdrh   ** the extra complication to make this rule less restrictive is probably
1918713de341Sdrh   ** not worth the effort.  Ticket [6284df89debdfa61db8073e062908af0c9b6118e]
1919713de341Sdrh   */
1920e34162b1Sdan   if( (db->flags & SQLITE_ForeignKeys)!=0 && pDest->pFKey!=0 ){
1921713de341Sdrh     return 0;
1922713de341Sdrh   }
1923713de341Sdrh #endif
1924e34162b1Sdan   if( (db->flags & SQLITE_CountRows)!=0 ){
1925ccdf1baeSdrh     return 0;  /* xfer opt does not play well with PRAGMA count_changes */
19261696124dSdan   }
19279d9cf229Sdrh 
1928ccdf1baeSdrh   /* If we get this far, it means that the xfer optimization is at
1929ccdf1baeSdrh   ** least a possibility, though it might only work if the destination
1930ccdf1baeSdrh   ** table (tab1) is initially empty.
19319d9cf229Sdrh   */
1932dd73521bSdrh #ifdef SQLITE_TEST
1933dd73521bSdrh   sqlite3_xferopt_count++;
1934dd73521bSdrh #endif
1935e34162b1Sdan   iDbSrc = sqlite3SchemaToIndex(db, pSrc->pSchema);
19369d9cf229Sdrh   v = sqlite3GetVdbe(pParse);
1937f53e9b5aSdrh   sqlite3CodeVerifySchema(pParse, iDbSrc);
19389d9cf229Sdrh   iSrc = pParse->nTab++;
19399d9cf229Sdrh   iDest = pParse->nTab++;
19406a288a33Sdrh   regAutoinc = autoIncBegin(pParse, iDbDest, pDest);
194155548273Sdrh   regData = sqlite3GetTempReg(pParse);
194255548273Sdrh   regRowid = sqlite3GetTempReg(pParse);
19439d9cf229Sdrh   sqlite3OpenTable(pParse, iDest, iDbDest, pDest, OP_OpenWrite);
1944427ebba1Sdan   assert( HasRowid(pDest) || destHasUniqueIdx );
1945e34162b1Sdan   if( (db->flags & SQLITE_Vacuum)==0 && (
1946e34162b1Sdan       (pDest->iPKey<0 && pDest->pIndex!=0)          /* (1) */
1947ccdf1baeSdrh    || destHasUniqueIdx                              /* (2) */
1948ccdf1baeSdrh    || (onError!=OE_Abort && onError!=OE_Rollback)   /* (3) */
1949e34162b1Sdan   )){
1950ccdf1baeSdrh     /* In some circumstances, we are able to run the xfer optimization
1951e34162b1Sdan     ** only if the destination table is initially empty. Unless the
1952e34162b1Sdan     ** SQLITE_Vacuum flag is set, this block generates code to make
1953e34162b1Sdan     ** that determination. If SQLITE_Vacuum is set, then the destination
1954e34162b1Sdan     ** table is always empty.
1955e34162b1Sdan     **
1956e34162b1Sdan     ** Conditions under which the destination must be empty:
1957f33c9fadSdrh     **
1958ccdf1baeSdrh     ** (1) There is no INTEGER PRIMARY KEY but there are indices.
1959ccdf1baeSdrh     **     (If the destination is not initially empty, the rowid fields
1960ccdf1baeSdrh     **     of index entries might need to change.)
1961ccdf1baeSdrh     **
1962ccdf1baeSdrh     ** (2) The destination has a unique index.  (The xfer optimization
1963ccdf1baeSdrh     **     is unable to test uniqueness.)
1964ccdf1baeSdrh     **
1965ccdf1baeSdrh     ** (3) onError is something other than OE_Abort and OE_Rollback.
19669d9cf229Sdrh     */
1967688852abSdrh     addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iDest, 0); VdbeCoverage(v);
196866a5167bSdrh     emptyDestTest = sqlite3VdbeAddOp2(v, OP_Goto, 0, 0);
19699d9cf229Sdrh     sqlite3VdbeJumpHere(v, addr1);
19709d9cf229Sdrh   }
1971427ebba1Sdan   if( HasRowid(pSrc) ){
19729d9cf229Sdrh     sqlite3OpenTable(pParse, iSrc, iDbSrc, pSrc, OP_OpenRead);
1973688852abSdrh     emptySrcTest = sqlite3VdbeAddOp2(v, OP_Rewind, iSrc, 0); VdbeCoverage(v);
197442242dedSdrh     if( pDest->iPKey>=0 ){
1975b7654111Sdrh       addr1 = sqlite3VdbeAddOp2(v, OP_Rowid, iSrc, regRowid);
1976b7654111Sdrh       addr2 = sqlite3VdbeAddOp3(v, OP_NotExists, iDest, 0, regRowid);
1977688852abSdrh       VdbeCoverage(v);
1978f9c8ce3cSdrh       sqlite3RowidConstraint(pParse, onError, pDest);
19799d9cf229Sdrh       sqlite3VdbeJumpHere(v, addr2);
1980b7654111Sdrh       autoIncStep(pParse, regAutoinc, regRowid);
1981bd36ba69Sdrh     }else if( pDest->pIndex==0 ){
1982b7654111Sdrh       addr1 = sqlite3VdbeAddOp2(v, OP_NewRowid, iDest, regRowid);
198395bad4c7Sdrh     }else{
1984b7654111Sdrh       addr1 = sqlite3VdbeAddOp2(v, OP_Rowid, iSrc, regRowid);
19857d10d5a6Sdrh       assert( (pDest->tabFlags & TF_Autoincrement)==0 );
198695bad4c7Sdrh     }
1987b7654111Sdrh     sqlite3VdbeAddOp2(v, OP_RowData, iSrc, regData);
1988b7654111Sdrh     sqlite3VdbeAddOp3(v, OP_Insert, iDest, regData, regRowid);
1989b7654111Sdrh     sqlite3VdbeChangeP5(v, OPFLAG_NCHANGE|OPFLAG_LASTROWID|OPFLAG_APPEND);
19901f4aa337Sdanielk1977     sqlite3VdbeChangeP4(v, -1, pDest->zName, 0);
1991688852abSdrh     sqlite3VdbeAddOp2(v, OP_Next, iSrc, addr1); VdbeCoverage(v);
199255548273Sdrh     sqlite3VdbeAddOp2(v, OP_Close, iSrc, 0);
199355548273Sdrh     sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
1994da475b8dSdrh   }else{
1995da475b8dSdrh     sqlite3TableLock(pParse, iDbDest, pDest->tnum, 1, pDest->zName);
1996da475b8dSdrh     sqlite3TableLock(pParse, iDbSrc, pSrc->tnum, 0, pSrc->zName);
199755548273Sdrh   }
19989d9cf229Sdrh   for(pDestIdx=pDest->pIndex; pDestIdx; pDestIdx=pDestIdx->pNext){
1999e34162b1Sdan     u8 useSeekResult = 0;
20001b7ecbb4Sdrh     for(pSrcIdx=pSrc->pIndex; ALWAYS(pSrcIdx); pSrcIdx=pSrcIdx->pNext){
20019d9cf229Sdrh       if( xferCompatibleIndex(pDestIdx, pSrcIdx) ) break;
20029d9cf229Sdrh     }
20039d9cf229Sdrh     assert( pSrcIdx );
20042ec2fb22Sdrh     sqlite3VdbeAddOp3(v, OP_OpenRead, iSrc, pSrcIdx->tnum, iDbSrc);
20052ec2fb22Sdrh     sqlite3VdbeSetP4KeyInfo(pParse, pSrcIdx);
2006d4e70ebdSdrh     VdbeComment((v, "%s", pSrcIdx->zName));
20072ec2fb22Sdrh     sqlite3VdbeAddOp3(v, OP_OpenWrite, iDest, pDestIdx->tnum, iDbDest);
20082ec2fb22Sdrh     sqlite3VdbeSetP4KeyInfo(pParse, pDestIdx);
200959885728Sdan     sqlite3VdbeChangeP5(v, OPFLAG_BULKCSR);
2010207872a4Sdanielk1977     VdbeComment((v, "%s", pDestIdx->zName));
2011688852abSdrh     addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iSrc, 0); VdbeCoverage(v);
2012b7654111Sdrh     sqlite3VdbeAddOp2(v, OP_RowKey, iSrc, regData);
2013e34162b1Sdan     if( db->flags & SQLITE_Vacuum ){
2014e34162b1Sdan       /* This INSERT command is part of a VACUUM operation, which guarantees
2015e34162b1Sdan       ** that the destination table is empty. If all indexed columns use
2016e34162b1Sdan       ** collation sequence BINARY, then it can also be assumed that the
2017e34162b1Sdan       ** index will be populated by inserting keys in strictly sorted
2018e34162b1Sdan       ** order. In this case, instead of seeking within the b-tree as part
2019e34162b1Sdan       ** of every OP_IdxInsert opcode, an OP_Last is added before the
2020e34162b1Sdan       ** OP_IdxInsert to seek to the point within the b-tree where each key
2021e34162b1Sdan       ** should be inserted. This is faster.
2022e34162b1Sdan       **
2023e34162b1Sdan       ** If any of the indexed columns use a collation sequence other than
2024e34162b1Sdan       ** BINARY, this optimization is disabled. This is because the user
2025e34162b1Sdan       ** might change the definition of a collation sequence and then run
2026e34162b1Sdan       ** a VACUUM command. In that case keys may not be written in strictly
2027e34162b1Sdan       ** sorted order.  */
2028e34162b1Sdan       for(i=0; i<pSrcIdx->nColumn; i++){
2029e34162b1Sdan         char *zColl = pSrcIdx->azColl[i];
2030ab06b0e5Sdrh         assert( zColl!=0 );
2031ab06b0e5Sdrh         if( sqlite3_stricmp("BINARY", zColl) ) break;
2032e34162b1Sdan       }
2033e34162b1Sdan       if( i==pSrcIdx->nColumn ){
2034e34162b1Sdan         useSeekResult = OPFLAG_USESEEKRESULT;
2035e34162b1Sdan         sqlite3VdbeAddOp3(v, OP_Last, iDest, 0, -1);
2036e34162b1Sdan       }
2037e34162b1Sdan     }
2038b7654111Sdrh     sqlite3VdbeAddOp3(v, OP_IdxInsert, iDest, regData, 1);
2039e34162b1Sdan     sqlite3VdbeChangeP5(v, useSeekResult);
2040688852abSdrh     sqlite3VdbeAddOp2(v, OP_Next, iSrc, addr1+1); VdbeCoverage(v);
20419d9cf229Sdrh     sqlite3VdbeJumpHere(v, addr1);
204255548273Sdrh     sqlite3VdbeAddOp2(v, OP_Close, iSrc, 0);
204355548273Sdrh     sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
20449d9cf229Sdrh   }
2045aceb31b1Sdrh   if( emptySrcTest ) sqlite3VdbeJumpHere(v, emptySrcTest);
2046b7654111Sdrh   sqlite3ReleaseTempReg(pParse, regRowid);
2047b7654111Sdrh   sqlite3ReleaseTempReg(pParse, regData);
20489d9cf229Sdrh   if( emptyDestTest ){
204966a5167bSdrh     sqlite3VdbeAddOp2(v, OP_Halt, SQLITE_OK, 0);
20509d9cf229Sdrh     sqlite3VdbeJumpHere(v, emptyDestTest);
205166a5167bSdrh     sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
20529d9cf229Sdrh     return 0;
20539d9cf229Sdrh   }else{
20549d9cf229Sdrh     return 1;
20559d9cf229Sdrh   }
20569d9cf229Sdrh }
20579d9cf229Sdrh #endif /* SQLITE_OMIT_XFER_OPT */
2058