xref: /sqlite-3.40.0/src/select.c (revision 4fa4a54f)
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 SELECT statements in SQLite.
14cce7d176Sdrh */
15cce7d176Sdrh #include "sqliteInt.h"
16cce7d176Sdrh 
17079a3072Sdrh /*
18abd4c723Sdrh ** Trace output macros
19abd4c723Sdrh */
20abd4c723Sdrh #if SELECTTRACE_ENABLED
21abd4c723Sdrh /***/ int sqlite3SelectTrace = 0;
22eb9b884cSdrh # define SELECTTRACE(K,P,S,X)  \
23eb9b884cSdrh   if(sqlite3SelectTrace&(K))   \
24eb9b884cSdrh     sqlite3DebugPrintf("%*s%s.%p: ",(P)->nSelectIndent*2-2,"",(S)->zSelName,(S)),\
25eb9b884cSdrh     sqlite3DebugPrintf X
26abd4c723Sdrh #else
27eb9b884cSdrh # define SELECTTRACE(K,P,S,X)
28abd4c723Sdrh #endif
29abd4c723Sdrh 
30abd4c723Sdrh 
31abd4c723Sdrh /*
32079a3072Sdrh ** An instance of the following object is used to record information about
33079a3072Sdrh ** how to process the DISTINCT keyword, to simplify passing that information
34079a3072Sdrh ** into the selectInnerLoop() routine.
35079a3072Sdrh */
36079a3072Sdrh typedef struct DistinctCtx DistinctCtx;
37079a3072Sdrh struct DistinctCtx {
38079a3072Sdrh   u8 isTnct;      /* True if the DISTINCT keyword is present */
39079a3072Sdrh   u8 eTnctType;   /* One of the WHERE_DISTINCT_* operators */
40079a3072Sdrh   int tabTnct;    /* Ephemeral table used for DISTINCT processing */
41079a3072Sdrh   int addrTnct;   /* Address of OP_OpenEphemeral opcode for tabTnct */
42079a3072Sdrh };
43079a3072Sdrh 
44079a3072Sdrh /*
45079a3072Sdrh ** An instance of the following object is used to record information about
46079a3072Sdrh ** the ORDER BY (or GROUP BY) clause of query is being coded.
47079a3072Sdrh */
48079a3072Sdrh typedef struct SortCtx SortCtx;
49079a3072Sdrh struct SortCtx {
50079a3072Sdrh   ExprList *pOrderBy;   /* The ORDER BY (or GROUP BY clause) */
51079a3072Sdrh   int nOBSat;           /* Number of ORDER BY terms satisfied by indices */
52079a3072Sdrh   int iECursor;         /* Cursor number for the sorter */
53079a3072Sdrh   int regReturn;        /* Register holding block-output return address */
54079a3072Sdrh   int labelBkOut;       /* Start label for the block-output subroutine */
55079a3072Sdrh   int addrSortIndex;    /* Address of the OP_SorterOpen or OP_OpenEphemeral */
56079a3072Sdrh   u8 sortFlags;         /* Zero or more SORTFLAG_* bits */
57079a3072Sdrh };
58079a3072Sdrh #define SORTFLAG_UseSorter  0x01   /* Use SorterOpen instead of OpenEphemeral */
59315555caSdrh 
60cce7d176Sdrh /*
61eda639e1Sdrh ** Delete all the content of a Select structure but do not deallocate
62eda639e1Sdrh ** the select structure itself.
63eda639e1Sdrh */
64633e6d57Sdrh static void clearSelect(sqlite3 *db, Select *p){
65633e6d57Sdrh   sqlite3ExprListDelete(db, p->pEList);
66633e6d57Sdrh   sqlite3SrcListDelete(db, p->pSrc);
67633e6d57Sdrh   sqlite3ExprDelete(db, p->pWhere);
68633e6d57Sdrh   sqlite3ExprListDelete(db, p->pGroupBy);
69633e6d57Sdrh   sqlite3ExprDelete(db, p->pHaving);
70633e6d57Sdrh   sqlite3ExprListDelete(db, p->pOrderBy);
71633e6d57Sdrh   sqlite3SelectDelete(db, p->pPrior);
72633e6d57Sdrh   sqlite3ExprDelete(db, p->pLimit);
73633e6d57Sdrh   sqlite3ExprDelete(db, p->pOffset);
744e9119d9Sdan   sqlite3WithDelete(db, p->pWith);
75eda639e1Sdrh }
76eda639e1Sdrh 
771013c932Sdrh /*
781013c932Sdrh ** Initialize a SelectDest structure.
791013c932Sdrh */
801013c932Sdrh void sqlite3SelectDestInit(SelectDest *pDest, int eDest, int iParm){
81ea678832Sdrh   pDest->eDest = (u8)eDest;
822b596da8Sdrh   pDest->iSDParm = iParm;
832b596da8Sdrh   pDest->affSdst = 0;
842b596da8Sdrh   pDest->iSdst = 0;
852b596da8Sdrh   pDest->nSdst = 0;
861013c932Sdrh }
871013c932Sdrh 
88eda639e1Sdrh 
89eda639e1Sdrh /*
909bb61fe7Sdrh ** Allocate a new Select structure and return a pointer to that
919bb61fe7Sdrh ** structure.
92cce7d176Sdrh */
934adee20fSdanielk1977 Select *sqlite3SelectNew(
9417435752Sdrh   Parse *pParse,        /* Parsing context */
95daffd0e5Sdrh   ExprList *pEList,     /* which columns to include in the result */
96ad3cab52Sdrh   SrcList *pSrc,        /* the FROM clause -- which tables to scan */
97daffd0e5Sdrh   Expr *pWhere,         /* the WHERE clause */
98daffd0e5Sdrh   ExprList *pGroupBy,   /* the GROUP BY clause */
99daffd0e5Sdrh   Expr *pHaving,        /* the HAVING clause */
100daffd0e5Sdrh   ExprList *pOrderBy,   /* the ORDER BY clause */
101832ee3d4Sdrh   u16 selFlags,         /* Flag parameters, such as SF_Distinct */
102a2dc3b1aSdanielk1977   Expr *pLimit,         /* LIMIT value.  NULL means not used */
103a2dc3b1aSdanielk1977   Expr *pOffset         /* OFFSET value.  NULL means no offset */
1049bb61fe7Sdrh ){
1059bb61fe7Sdrh   Select *pNew;
106eda639e1Sdrh   Select standin;
10717435752Sdrh   sqlite3 *db = pParse->db;
10817435752Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
109d72a276eSdrh   assert( db->mallocFailed || !pOffset || pLimit ); /* OFFSET implies LIMIT */
110daffd0e5Sdrh   if( pNew==0 ){
111338ec3e1Sdrh     assert( db->mallocFailed );
112eda639e1Sdrh     pNew = &standin;
113eda639e1Sdrh     memset(pNew, 0, sizeof(*pNew));
114eda639e1Sdrh   }
115b733d037Sdrh   if( pEList==0 ){
116b7916a78Sdrh     pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db,TK_ALL,0));
117b733d037Sdrh   }
1189bb61fe7Sdrh   pNew->pEList = pEList;
1197b113babSdrh   if( pSrc==0 ) pSrc = sqlite3DbMallocZero(db, sizeof(*pSrc));
1209bb61fe7Sdrh   pNew->pSrc = pSrc;
1219bb61fe7Sdrh   pNew->pWhere = pWhere;
1229bb61fe7Sdrh   pNew->pGroupBy = pGroupBy;
1239bb61fe7Sdrh   pNew->pHaving = pHaving;
1249bb61fe7Sdrh   pNew->pOrderBy = pOrderBy;
125832ee3d4Sdrh   pNew->selFlags = selFlags;
12682c3d636Sdrh   pNew->op = TK_SELECT;
127a2dc3b1aSdanielk1977   pNew->pLimit = pLimit;
128a2dc3b1aSdanielk1977   pNew->pOffset = pOffset;
129373cc2ddSdrh   assert( pOffset==0 || pLimit!=0 );
130b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
131b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1320a846f96Sdrh   if( db->mallocFailed ) {
133633e6d57Sdrh     clearSelect(db, pNew);
1340a846f96Sdrh     if( pNew!=&standin ) sqlite3DbFree(db, pNew);
135eda639e1Sdrh     pNew = 0;
136a464c234Sdrh   }else{
137a464c234Sdrh     assert( pNew->pSrc!=0 || pParse->nErr>0 );
138daffd0e5Sdrh   }
139338ec3e1Sdrh   assert( pNew!=&standin );
1409bb61fe7Sdrh   return pNew;
1419bb61fe7Sdrh }
1429bb61fe7Sdrh 
143eb9b884cSdrh #if SELECTTRACE_ENABLED
144eb9b884cSdrh /*
145eb9b884cSdrh ** Set the name of a Select object
146eb9b884cSdrh */
147eb9b884cSdrh void sqlite3SelectSetName(Select *p, const char *zName){
148eb9b884cSdrh   if( p && zName ){
149eb9b884cSdrh     sqlite3_snprintf(sizeof(p->zSelName), p->zSelName, "%s", zName);
150eb9b884cSdrh   }
151eb9b884cSdrh }
152eb9b884cSdrh #endif
153eb9b884cSdrh 
154eb9b884cSdrh 
1559bb61fe7Sdrh /*
156eda639e1Sdrh ** Delete the given Select structure and all of its substructures.
157eda639e1Sdrh */
158633e6d57Sdrh void sqlite3SelectDelete(sqlite3 *db, Select *p){
159eda639e1Sdrh   if( p ){
160633e6d57Sdrh     clearSelect(db, p);
161633e6d57Sdrh     sqlite3DbFree(db, p);
162eda639e1Sdrh   }
163eda639e1Sdrh }
164eda639e1Sdrh 
165eda639e1Sdrh /*
166d227a291Sdrh ** Return a pointer to the right-most SELECT statement in a compound.
167d227a291Sdrh */
168d227a291Sdrh static Select *findRightmost(Select *p){
169d227a291Sdrh   while( p->pNext ) p = p->pNext;
170d227a291Sdrh   return p;
171d227a291Sdrh }
172d227a291Sdrh 
173d227a291Sdrh /*
174f7b5496eSdrh ** Given 1 to 3 identifiers preceding the JOIN keyword, determine the
17501f3f253Sdrh ** type of join.  Return an integer constant that expresses that type
17601f3f253Sdrh ** in terms of the following bit values:
17701f3f253Sdrh **
17801f3f253Sdrh **     JT_INNER
1793dec223cSdrh **     JT_CROSS
18001f3f253Sdrh **     JT_OUTER
18101f3f253Sdrh **     JT_NATURAL
18201f3f253Sdrh **     JT_LEFT
18301f3f253Sdrh **     JT_RIGHT
18401f3f253Sdrh **
18501f3f253Sdrh ** A full outer join is the combination of JT_LEFT and JT_RIGHT.
18601f3f253Sdrh **
18701f3f253Sdrh ** If an illegal or unsupported join type is seen, then still return
18801f3f253Sdrh ** a join type, but put an error in the pParse structure.
18901f3f253Sdrh */
1904adee20fSdanielk1977 int sqlite3JoinType(Parse *pParse, Token *pA, Token *pB, Token *pC){
19101f3f253Sdrh   int jointype = 0;
19201f3f253Sdrh   Token *apAll[3];
19301f3f253Sdrh   Token *p;
194373cc2ddSdrh                              /*   0123456789 123456789 123456789 123 */
195373cc2ddSdrh   static const char zKeyText[] = "naturaleftouterightfullinnercross";
1965719628aSdrh   static const struct {
197373cc2ddSdrh     u8 i;        /* Beginning of keyword text in zKeyText[] */
198373cc2ddSdrh     u8 nChar;    /* Length of the keyword in characters */
199373cc2ddSdrh     u8 code;     /* Join type mask */
200373cc2ddSdrh   } aKeyword[] = {
201373cc2ddSdrh     /* natural */ { 0,  7, JT_NATURAL                },
202373cc2ddSdrh     /* left    */ { 6,  4, JT_LEFT|JT_OUTER          },
203373cc2ddSdrh     /* outer   */ { 10, 5, JT_OUTER                  },
204373cc2ddSdrh     /* right   */ { 14, 5, JT_RIGHT|JT_OUTER         },
205373cc2ddSdrh     /* full    */ { 19, 4, JT_LEFT|JT_RIGHT|JT_OUTER },
206373cc2ddSdrh     /* inner   */ { 23, 5, JT_INNER                  },
207373cc2ddSdrh     /* cross   */ { 28, 5, JT_INNER|JT_CROSS         },
20801f3f253Sdrh   };
20901f3f253Sdrh   int i, j;
21001f3f253Sdrh   apAll[0] = pA;
21101f3f253Sdrh   apAll[1] = pB;
21201f3f253Sdrh   apAll[2] = pC;
213195e6967Sdrh   for(i=0; i<3 && apAll[i]; i++){
21401f3f253Sdrh     p = apAll[i];
215373cc2ddSdrh     for(j=0; j<ArraySize(aKeyword); j++){
216373cc2ddSdrh       if( p->n==aKeyword[j].nChar
217373cc2ddSdrh           && sqlite3StrNICmp((char*)p->z, &zKeyText[aKeyword[j].i], p->n)==0 ){
218373cc2ddSdrh         jointype |= aKeyword[j].code;
21901f3f253Sdrh         break;
22001f3f253Sdrh       }
22101f3f253Sdrh     }
222373cc2ddSdrh     testcase( j==0 || j==1 || j==2 || j==3 || j==4 || j==5 || j==6 );
223373cc2ddSdrh     if( j>=ArraySize(aKeyword) ){
22401f3f253Sdrh       jointype |= JT_ERROR;
22501f3f253Sdrh       break;
22601f3f253Sdrh     }
22701f3f253Sdrh   }
228ad2d8307Sdrh   if(
229ad2d8307Sdrh      (jointype & (JT_INNER|JT_OUTER))==(JT_INNER|JT_OUTER) ||
230195e6967Sdrh      (jointype & JT_ERROR)!=0
231ad2d8307Sdrh   ){
232a9671a22Sdrh     const char *zSp = " ";
233a9671a22Sdrh     assert( pB!=0 );
234a9671a22Sdrh     if( pC==0 ){ zSp++; }
235ae29ffbeSdrh     sqlite3ErrorMsg(pParse, "unknown or unsupported join type: "
236a9671a22Sdrh        "%T %T%s%T", pA, pB, zSp, pC);
23701f3f253Sdrh     jointype = JT_INNER;
238373cc2ddSdrh   }else if( (jointype & JT_OUTER)!=0
239373cc2ddSdrh          && (jointype & (JT_LEFT|JT_RIGHT))!=JT_LEFT ){
2404adee20fSdanielk1977     sqlite3ErrorMsg(pParse,
241da93d238Sdrh       "RIGHT and FULL OUTER JOINs are not currently supported");
242195e6967Sdrh     jointype = JT_INNER;
24301f3f253Sdrh   }
24401f3f253Sdrh   return jointype;
24501f3f253Sdrh }
24601f3f253Sdrh 
24701f3f253Sdrh /*
248ad2d8307Sdrh ** Return the index of a column in a table.  Return -1 if the column
249ad2d8307Sdrh ** is not contained in the table.
250ad2d8307Sdrh */
251ad2d8307Sdrh static int columnIndex(Table *pTab, const char *zCol){
252ad2d8307Sdrh   int i;
253ad2d8307Sdrh   for(i=0; i<pTab->nCol; i++){
2544adee20fSdanielk1977     if( sqlite3StrICmp(pTab->aCol[i].zName, zCol)==0 ) return i;
255ad2d8307Sdrh   }
256ad2d8307Sdrh   return -1;
257ad2d8307Sdrh }
258ad2d8307Sdrh 
259ad2d8307Sdrh /*
2602179b434Sdrh ** Search the first N tables in pSrc, from left to right, looking for a
2612179b434Sdrh ** table that has a column named zCol.
2622179b434Sdrh **
2632179b434Sdrh ** When found, set *piTab and *piCol to the table index and column index
2642179b434Sdrh ** of the matching column and return TRUE.
2652179b434Sdrh **
2662179b434Sdrh ** If not found, return FALSE.
2672179b434Sdrh */
2682179b434Sdrh static int tableAndColumnIndex(
2692179b434Sdrh   SrcList *pSrc,       /* Array of tables to search */
2702179b434Sdrh   int N,               /* Number of tables in pSrc->a[] to search */
2712179b434Sdrh   const char *zCol,    /* Name of the column we are looking for */
2722179b434Sdrh   int *piTab,          /* Write index of pSrc->a[] here */
2732179b434Sdrh   int *piCol           /* Write index of pSrc->a[*piTab].pTab->aCol[] here */
2742179b434Sdrh ){
2752179b434Sdrh   int i;               /* For looping over tables in pSrc */
2762179b434Sdrh   int iCol;            /* Index of column matching zCol */
2772179b434Sdrh 
2782179b434Sdrh   assert( (piTab==0)==(piCol==0) );  /* Both or neither are NULL */
2792179b434Sdrh   for(i=0; i<N; i++){
2802179b434Sdrh     iCol = columnIndex(pSrc->a[i].pTab, zCol);
2812179b434Sdrh     if( iCol>=0 ){
2822179b434Sdrh       if( piTab ){
2832179b434Sdrh         *piTab = i;
2842179b434Sdrh         *piCol = iCol;
2852179b434Sdrh       }
2862179b434Sdrh       return 1;
2872179b434Sdrh     }
2882179b434Sdrh   }
2892179b434Sdrh   return 0;
2902179b434Sdrh }
2912179b434Sdrh 
2922179b434Sdrh /*
293f7b0b0adSdan ** This function is used to add terms implied by JOIN syntax to the
294f7b0b0adSdan ** WHERE clause expression of a SELECT statement. The new term, which
295f7b0b0adSdan ** is ANDed with the existing WHERE clause, is of the form:
296f7b0b0adSdan **
297f7b0b0adSdan **    (tab1.col1 = tab2.col2)
298f7b0b0adSdan **
299f7b0b0adSdan ** where tab1 is the iSrc'th table in SrcList pSrc and tab2 is the
300f7b0b0adSdan ** (iSrc+1)'th. Column col1 is column iColLeft of tab1, and col2 is
301f7b0b0adSdan ** column iColRight of tab2.
302ad2d8307Sdrh */
303ad2d8307Sdrh static void addWhereTerm(
30417435752Sdrh   Parse *pParse,                  /* Parsing context */
305f7b0b0adSdan   SrcList *pSrc,                  /* List of tables in FROM clause */
3062179b434Sdrh   int iLeft,                      /* Index of first table to join in pSrc */
307f7b0b0adSdan   int iColLeft,                   /* Index of column in first table */
3082179b434Sdrh   int iRight,                     /* Index of second table in pSrc */
309f7b0b0adSdan   int iColRight,                  /* Index of column in second table */
310f7b0b0adSdan   int isOuterJoin,                /* True if this is an OUTER join */
311f7b0b0adSdan   Expr **ppWhere                  /* IN/OUT: The WHERE clause to add to */
312ad2d8307Sdrh ){
313f7b0b0adSdan   sqlite3 *db = pParse->db;
314f7b0b0adSdan   Expr *pE1;
315f7b0b0adSdan   Expr *pE2;
316f7b0b0adSdan   Expr *pEq;
317ad2d8307Sdrh 
3182179b434Sdrh   assert( iLeft<iRight );
3192179b434Sdrh   assert( pSrc->nSrc>iRight );
3202179b434Sdrh   assert( pSrc->a[iLeft].pTab );
3212179b434Sdrh   assert( pSrc->a[iRight].pTab );
322f7b0b0adSdan 
3232179b434Sdrh   pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iColLeft);
3242179b434Sdrh   pE2 = sqlite3CreateColumnExpr(db, pSrc, iRight, iColRight);
325f7b0b0adSdan 
326f7b0b0adSdan   pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2, 0);
327f7b0b0adSdan   if( pEq && isOuterJoin ){
328f7b0b0adSdan     ExprSetProperty(pEq, EP_FromJoin);
329c5cd1249Sdrh     assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
330ebb6a65dSdrh     ExprSetVVAProperty(pEq, EP_NoReduce);
331f7b0b0adSdan     pEq->iRightJoinTable = (i16)pE2->iTable;
332030530deSdrh   }
333f7b0b0adSdan   *ppWhere = sqlite3ExprAnd(db, *ppWhere, pEq);
334ad2d8307Sdrh }
335ad2d8307Sdrh 
336ad2d8307Sdrh /*
3371f16230bSdrh ** Set the EP_FromJoin property on all terms of the given expression.
33822d6a53aSdrh ** And set the Expr.iRightJoinTable to iTable for every term in the
33922d6a53aSdrh ** expression.
3401cc093c2Sdrh **
341e78e8284Sdrh ** The EP_FromJoin property is used on terms of an expression to tell
3421cc093c2Sdrh ** the LEFT OUTER JOIN processing logic that this term is part of the
3431f16230bSdrh ** join restriction specified in the ON or USING clause and not a part
3441f16230bSdrh ** of the more general WHERE clause.  These terms are moved over to the
3451f16230bSdrh ** WHERE clause during join processing but we need to remember that they
3461f16230bSdrh ** originated in the ON or USING clause.
34722d6a53aSdrh **
34822d6a53aSdrh ** The Expr.iRightJoinTable tells the WHERE clause processing that the
34922d6a53aSdrh ** expression depends on table iRightJoinTable even if that table is not
35022d6a53aSdrh ** explicitly mentioned in the expression.  That information is needed
35122d6a53aSdrh ** for cases like this:
35222d6a53aSdrh **
35322d6a53aSdrh **    SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.b AND t1.x=5
35422d6a53aSdrh **
35522d6a53aSdrh ** The where clause needs to defer the handling of the t1.x=5
35622d6a53aSdrh ** term until after the t2 loop of the join.  In that way, a
35722d6a53aSdrh ** NULL t2 row will be inserted whenever t1.x!=5.  If we do not
35822d6a53aSdrh ** defer the handling of t1.x=5, it will be processed immediately
35922d6a53aSdrh ** after the t1 loop and rows with t1.x!=5 will never appear in
36022d6a53aSdrh ** the output, which is incorrect.
3611cc093c2Sdrh */
36222d6a53aSdrh static void setJoinExpr(Expr *p, int iTable){
3631cc093c2Sdrh   while( p ){
3641f16230bSdrh     ExprSetProperty(p, EP_FromJoin);
365c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
366ebb6a65dSdrh     ExprSetVVAProperty(p, EP_NoReduce);
367cf697396Sshane     p->iRightJoinTable = (i16)iTable;
36822d6a53aSdrh     setJoinExpr(p->pLeft, iTable);
3691cc093c2Sdrh     p = p->pRight;
3701cc093c2Sdrh   }
3711cc093c2Sdrh }
3721cc093c2Sdrh 
3731cc093c2Sdrh /*
374ad2d8307Sdrh ** This routine processes the join information for a SELECT statement.
375ad2d8307Sdrh ** ON and USING clauses are converted into extra terms of the WHERE clause.
376ad2d8307Sdrh ** NATURAL joins also create extra WHERE clause terms.
377ad2d8307Sdrh **
37891bb0eedSdrh ** The terms of a FROM clause are contained in the Select.pSrc structure.
37991bb0eedSdrh ** The left most table is the first entry in Select.pSrc.  The right-most
38091bb0eedSdrh ** table is the last entry.  The join operator is held in the entry to
38191bb0eedSdrh ** the left.  Thus entry 0 contains the join operator for the join between
38291bb0eedSdrh ** entries 0 and 1.  Any ON or USING clauses associated with the join are
38391bb0eedSdrh ** also attached to the left entry.
38491bb0eedSdrh **
385ad2d8307Sdrh ** This routine returns the number of errors encountered.
386ad2d8307Sdrh */
387ad2d8307Sdrh static int sqliteProcessJoin(Parse *pParse, Select *p){
38891bb0eedSdrh   SrcList *pSrc;                  /* All tables in the FROM clause */
38991bb0eedSdrh   int i, j;                       /* Loop counters */
39091bb0eedSdrh   struct SrcList_item *pLeft;     /* Left table being joined */
39191bb0eedSdrh   struct SrcList_item *pRight;    /* Right table being joined */
392ad2d8307Sdrh 
39391bb0eedSdrh   pSrc = p->pSrc;
39491bb0eedSdrh   pLeft = &pSrc->a[0];
39591bb0eedSdrh   pRight = &pLeft[1];
39691bb0eedSdrh   for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
39791bb0eedSdrh     Table *pLeftTab = pLeft->pTab;
39891bb0eedSdrh     Table *pRightTab = pRight->pTab;
399ad27e761Sdrh     int isOuter;
40091bb0eedSdrh 
4011c767f0dSdrh     if( NEVER(pLeftTab==0 || pRightTab==0) ) continue;
402ad27e761Sdrh     isOuter = (pRight->jointype & JT_OUTER)!=0;
403ad2d8307Sdrh 
404ad2d8307Sdrh     /* When the NATURAL keyword is present, add WHERE clause terms for
405ad2d8307Sdrh     ** every column that the two tables have in common.
406ad2d8307Sdrh     */
40761dfc31dSdrh     if( pRight->jointype & JT_NATURAL ){
40861dfc31dSdrh       if( pRight->pOn || pRight->pUsing ){
4094adee20fSdanielk1977         sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
410ad2d8307Sdrh            "an ON or USING clause", 0);
411ad2d8307Sdrh         return 1;
412ad2d8307Sdrh       }
4132179b434Sdrh       for(j=0; j<pRightTab->nCol; j++){
4142179b434Sdrh         char *zName;   /* Name of column in the right table */
4152179b434Sdrh         int iLeft;     /* Matching left table */
4162179b434Sdrh         int iLeftCol;  /* Matching column in the left table */
4172179b434Sdrh 
4182179b434Sdrh         zName = pRightTab->aCol[j].zName;
4192179b434Sdrh         if( tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol) ){
4202179b434Sdrh           addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, j,
4212179b434Sdrh                        isOuter, &p->pWhere);
422ad2d8307Sdrh         }
423ad2d8307Sdrh       }
424ad2d8307Sdrh     }
425ad2d8307Sdrh 
426ad2d8307Sdrh     /* Disallow both ON and USING clauses in the same join
427ad2d8307Sdrh     */
42861dfc31dSdrh     if( pRight->pOn && pRight->pUsing ){
4294adee20fSdanielk1977       sqlite3ErrorMsg(pParse, "cannot have both ON and USING "
430da93d238Sdrh         "clauses in the same join");
431ad2d8307Sdrh       return 1;
432ad2d8307Sdrh     }
433ad2d8307Sdrh 
434ad2d8307Sdrh     /* Add the ON clause to the end of the WHERE clause, connected by
43591bb0eedSdrh     ** an AND operator.
436ad2d8307Sdrh     */
43761dfc31dSdrh     if( pRight->pOn ){
438ad27e761Sdrh       if( isOuter ) setJoinExpr(pRight->pOn, pRight->iCursor);
43917435752Sdrh       p->pWhere = sqlite3ExprAnd(pParse->db, p->pWhere, pRight->pOn);
44061dfc31dSdrh       pRight->pOn = 0;
441ad2d8307Sdrh     }
442ad2d8307Sdrh 
443ad2d8307Sdrh     /* Create extra terms on the WHERE clause for each column named
444ad2d8307Sdrh     ** in the USING clause.  Example: If the two tables to be joined are
445ad2d8307Sdrh     ** A and B and the USING clause names X, Y, and Z, then add this
446ad2d8307Sdrh     ** to the WHERE clause:    A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
447ad2d8307Sdrh     ** Report an error if any column mentioned in the USING clause is
448ad2d8307Sdrh     ** not contained in both tables to be joined.
449ad2d8307Sdrh     */
45061dfc31dSdrh     if( pRight->pUsing ){
45161dfc31dSdrh       IdList *pList = pRight->pUsing;
452ad2d8307Sdrh       for(j=0; j<pList->nId; j++){
4532179b434Sdrh         char *zName;     /* Name of the term in the USING clause */
4542179b434Sdrh         int iLeft;       /* Table on the left with matching column name */
4552179b434Sdrh         int iLeftCol;    /* Column number of matching column on the left */
4562179b434Sdrh         int iRightCol;   /* Column number of matching column on the right */
4572179b434Sdrh 
4582179b434Sdrh         zName = pList->a[j].zName;
4592179b434Sdrh         iRightCol = columnIndex(pRightTab, zName);
4602179b434Sdrh         if( iRightCol<0
4612179b434Sdrh          || !tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol)
4622179b434Sdrh         ){
4634adee20fSdanielk1977           sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
46491bb0eedSdrh             "not present in both tables", zName);
465ad2d8307Sdrh           return 1;
466ad2d8307Sdrh         }
4672179b434Sdrh         addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, iRightCol,
4682179b434Sdrh                      isOuter, &p->pWhere);
469ad2d8307Sdrh       }
470ad2d8307Sdrh     }
471ad2d8307Sdrh   }
472ad2d8307Sdrh   return 0;
473ad2d8307Sdrh }
474ad2d8307Sdrh 
475079a3072Sdrh /* Forward reference */
476079a3072Sdrh static KeyInfo *keyInfoFromExprList(
477079a3072Sdrh   Parse *pParse,       /* Parsing context */
478079a3072Sdrh   ExprList *pList,     /* Form the KeyInfo object from this ExprList */
479079a3072Sdrh   int iStart,          /* Begin with this column of pList */
480079a3072Sdrh   int nExtra           /* Add this many extra columns to the end */
481079a3072Sdrh );
482079a3072Sdrh 
483ad2d8307Sdrh /*
484f45f2326Sdrh ** Generate code that will push the record in registers regData
485f45f2326Sdrh ** through regData+nData-1 onto the sorter.
486c926afbcSdrh */
487d59ba6ceSdrh static void pushOntoSorter(
488d59ba6ceSdrh   Parse *pParse,         /* Parser context */
489079a3072Sdrh   SortCtx *pSort,        /* Information about the ORDER BY clause */
490b7654111Sdrh   Select *pSelect,       /* The whole SELECT statement */
491f45f2326Sdrh   int regData,           /* First register holding data to be sorted */
492fd0a2f97Sdrh   int nData,             /* Number of elements in the data array */
493fd0a2f97Sdrh   int nPrefixReg         /* No. of reg prior to regData available for use */
494d59ba6ceSdrh ){
495f45f2326Sdrh   Vdbe *v = pParse->pVdbe;                         /* Stmt under construction */
49678d58432Sdan   int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
497f45f2326Sdrh   int nExpr = pSort->pOrderBy->nExpr;              /* No. of ORDER BY terms */
49878d58432Sdan   int nBase = nExpr + bSeq + nData;                /* Fields in sorter record */
499fd0a2f97Sdrh   int regBase;                                     /* Regs for sorter record */
500fb0d6e56Sdrh   int regRecord = ++pParse->nMem;                  /* Assembled sorter record */
50178d58432Sdan   int nOBSat = pSort->nOBSat;                      /* ORDER BY terms to skip */
502f45f2326Sdrh   int op;                            /* Opcode to add sorter record to sorter */
503f45f2326Sdrh 
50478d58432Sdan   assert( bSeq==0 || bSeq==1 );
505fd0a2f97Sdrh   if( nPrefixReg ){
50678d58432Sdan     assert( nPrefixReg==nExpr+bSeq );
50778d58432Sdan     regBase = regData - nExpr - bSeq;
508fd0a2f97Sdrh   }else{
509fb0d6e56Sdrh     regBase = pParse->nMem + 1;
510fb0d6e56Sdrh     pParse->nMem += nBase;
511fd0a2f97Sdrh   }
51270f624c3Sdrh   sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, SQLITE_ECEL_DUP);
51378d58432Sdan   if( bSeq ){
514079a3072Sdrh     sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
515fd0a2f97Sdrh   }
51678d58432Sdan   if( nPrefixReg==0 ){
517236241aeSdrh     sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
51878d58432Sdan   }
51978d58432Sdan 
520f45f2326Sdrh   sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regRecord);
521079a3072Sdrh   if( nOBSat>0 ){
522079a3072Sdrh     int regPrevKey;   /* The first nOBSat columns of the previous row */
523079a3072Sdrh     int addrFirst;    /* Address of the OP_IfNot opcode */
524079a3072Sdrh     int addrJmp;      /* Address of the OP_Jump opcode */
525079a3072Sdrh     VdbeOp *pOp;      /* Opcode that opens the sorter */
526079a3072Sdrh     int nKey;         /* Number of sorting key columns, including OP_Sequence */
527dbfca2b7Sdrh     KeyInfo *pKI;     /* Original KeyInfo on the sorter table */
528079a3072Sdrh 
52926d7e7c6Sdrh     regPrevKey = pParse->nMem+1;
53026d7e7c6Sdrh     pParse->nMem += pSort->nOBSat;
53178d58432Sdan     nKey = nExpr - pSort->nOBSat + bSeq;
53278d58432Sdan     if( bSeq ){
53378d58432Sdan       addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
53478d58432Sdan     }else{
53578d58432Sdan       addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
53678d58432Sdan     }
53778d58432Sdan     VdbeCoverage(v);
53826d7e7c6Sdrh     sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
539079a3072Sdrh     pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
54059b8f2e1Sdrh     if( pParse->db->mallocFailed ) return;
541fb0d6e56Sdrh     pOp->p2 = nKey + nData;
542dbfca2b7Sdrh     pKI = pOp->p4.pKeyInfo;
543dbfca2b7Sdrh     memset(pKI->aSortOrder, 0, pKI->nField); /* Makes OP_Jump below testable */
544dbfca2b7Sdrh     sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
545079a3072Sdrh     pOp->p4.pKeyInfo = keyInfoFromExprList(pParse, pSort->pOrderBy, nOBSat, 1);
546079a3072Sdrh     addrJmp = sqlite3VdbeCurrentAddr(v);
547079a3072Sdrh     sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
548079a3072Sdrh     pSort->labelBkOut = sqlite3VdbeMakeLabel(v);
549079a3072Sdrh     pSort->regReturn = ++pParse->nMem;
550079a3072Sdrh     sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
55165ea12cbSdrh     sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
552079a3072Sdrh     sqlite3VdbeJumpHere(v, addrFirst);
553236241aeSdrh     sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
554079a3072Sdrh     sqlite3VdbeJumpHere(v, addrJmp);
555079a3072Sdrh   }
556079a3072Sdrh   if( pSort->sortFlags & SORTFLAG_UseSorter ){
557c6aff30cSdrh     op = OP_SorterInsert;
558c6aff30cSdrh   }else{
559c6aff30cSdrh     op = OP_IdxInsert;
560c6aff30cSdrh   }
561079a3072Sdrh   sqlite3VdbeAddOp2(v, op, pSort->iECursor, regRecord);
56292b01d53Sdrh   if( pSelect->iLimit ){
56315007a99Sdrh     int addr1, addr2;
564b7654111Sdrh     int iLimit;
5650acb7e48Sdrh     if( pSelect->iOffset ){
566b7654111Sdrh       iLimit = pSelect->iOffset+1;
567b7654111Sdrh     }else{
568b7654111Sdrh       iLimit = pSelect->iLimit;
569b7654111Sdrh     }
570688852abSdrh     addr1 = sqlite3VdbeAddOp1(v, OP_IfZero, iLimit); VdbeCoverage(v);
571b7654111Sdrh     sqlite3VdbeAddOp2(v, OP_AddImm, iLimit, -1);
5723c84ddffSdrh     addr2 = sqlite3VdbeAddOp0(v, OP_Goto);
573d59ba6ceSdrh     sqlite3VdbeJumpHere(v, addr1);
574079a3072Sdrh     sqlite3VdbeAddOp1(v, OP_Last, pSort->iECursor);
575079a3072Sdrh     sqlite3VdbeAddOp1(v, OP_Delete, pSort->iECursor);
57615007a99Sdrh     sqlite3VdbeJumpHere(v, addr2);
577d59ba6ceSdrh   }
578c926afbcSdrh }
579c926afbcSdrh 
580c926afbcSdrh /*
581ec7429aeSdrh ** Add code to implement the OFFSET
582ea48eb2eSdrh */
583ec7429aeSdrh static void codeOffset(
584bab39e13Sdrh   Vdbe *v,          /* Generate code into this VM */
585aa9ce707Sdrh   int iOffset,      /* Register holding the offset counter */
586b7654111Sdrh   int iContinue     /* Jump here to skip the current record */
587ea48eb2eSdrh ){
588a22a75e5Sdrh   if( iOffset>0 ){
58915007a99Sdrh     int addr;
5904336b0e6Sdrh     addr = sqlite3VdbeAddOp3(v, OP_IfNeg, iOffset, 0, -1); VdbeCoverage(v);
59166a5167bSdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, iContinue);
592d4e70ebdSdrh     VdbeComment((v, "skip OFFSET records"));
59315007a99Sdrh     sqlite3VdbeJumpHere(v, addr);
594ea48eb2eSdrh   }
595ea48eb2eSdrh }
596ea48eb2eSdrh 
597ea48eb2eSdrh /*
59898757157Sdrh ** Add code that will check to make sure the N registers starting at iMem
59998757157Sdrh ** form a distinct entry.  iTab is a sorting index that holds previously
600a2a49dc9Sdrh ** seen combinations of the N values.  A new entry is made in iTab
601a2a49dc9Sdrh ** if the current N values are new.
602a2a49dc9Sdrh **
603a2a49dc9Sdrh ** A jump to addrRepeat is made and the N+1 values are popped from the
604a2a49dc9Sdrh ** stack if the top N elements are not distinct.
605a2a49dc9Sdrh */
606a2a49dc9Sdrh static void codeDistinct(
6072dcef11bSdrh   Parse *pParse,     /* Parsing and code generating context */
608a2a49dc9Sdrh   int iTab,          /* A sorting index used to test for distinctness */
609a2a49dc9Sdrh   int addrRepeat,    /* Jump to here if not distinct */
610477df4b3Sdrh   int N,             /* Number of elements */
611a2a49dc9Sdrh   int iMem           /* First element */
612a2a49dc9Sdrh ){
6132dcef11bSdrh   Vdbe *v;
6142dcef11bSdrh   int r1;
6152dcef11bSdrh 
6162dcef11bSdrh   v = pParse->pVdbe;
6172dcef11bSdrh   r1 = sqlite3GetTempReg(pParse);
618688852abSdrh   sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, iMem, N); VdbeCoverage(v);
6191db639ceSdrh   sqlite3VdbeAddOp3(v, OP_MakeRecord, iMem, N, r1);
6202dcef11bSdrh   sqlite3VdbeAddOp2(v, OP_IdxInsert, iTab, r1);
6212dcef11bSdrh   sqlite3ReleaseTempReg(pParse, r1);
622a2a49dc9Sdrh }
623a2a49dc9Sdrh 
624bb7dd683Sdrh #ifndef SQLITE_OMIT_SUBQUERY
625a2a49dc9Sdrh /*
626e305f43fSdrh ** Generate an error message when a SELECT is used within a subexpression
627e305f43fSdrh ** (example:  "a IN (SELECT * FROM table)") but it has more than 1 result
628bb7dd683Sdrh ** column.  We do this in a subroutine because the error used to occur
629bb7dd683Sdrh ** in multiple places.  (The error only occurs in one place now, but we
630bb7dd683Sdrh ** retain the subroutine to minimize code disruption.)
631e305f43fSdrh */
6326c8c8ce0Sdanielk1977 static int checkForMultiColumnSelectError(
6336c8c8ce0Sdanielk1977   Parse *pParse,       /* Parse context. */
6346c8c8ce0Sdanielk1977   SelectDest *pDest,   /* Destination of SELECT results */
6356c8c8ce0Sdanielk1977   int nExpr            /* Number of result columns returned by SELECT */
6366c8c8ce0Sdanielk1977 ){
6376c8c8ce0Sdanielk1977   int eDest = pDest->eDest;
638e305f43fSdrh   if( nExpr>1 && (eDest==SRT_Mem || eDest==SRT_Set) ){
639e305f43fSdrh     sqlite3ErrorMsg(pParse, "only a single result allowed for "
640e305f43fSdrh        "a SELECT that is part of an expression");
641e305f43fSdrh     return 1;
642e305f43fSdrh   }else{
643e305f43fSdrh     return 0;
644e305f43fSdrh   }
645e305f43fSdrh }
646bb7dd683Sdrh #endif
647c99130fdSdrh 
648c99130fdSdrh /*
6492282792aSdrh ** This routine generates the code for the inside of the inner loop
6502282792aSdrh ** of a SELECT.
65182c3d636Sdrh **
652340309fdSdrh ** If srcTab is negative, then the pEList expressions
653340309fdSdrh ** are evaluated in order to get the data for this row.  If srcTab is
654340309fdSdrh ** zero or more, then data is pulled from srcTab and pEList is used only
655340309fdSdrh ** to get number columns and the datatype for each column.
6562282792aSdrh */
657d2b3e23bSdrh static void selectInnerLoop(
6582282792aSdrh   Parse *pParse,          /* The parser context */
659df199a25Sdrh   Select *p,              /* The complete select statement being coded */
6602282792aSdrh   ExprList *pEList,       /* List of values being extracted */
66182c3d636Sdrh   int srcTab,             /* Pull data from this table */
662079a3072Sdrh   SortCtx *pSort,         /* If not NULL, info on how to process ORDER BY */
663e8e4af76Sdrh   DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
6646c8c8ce0Sdanielk1977   SelectDest *pDest,      /* How to dispose of the results */
6652282792aSdrh   int iContinue,          /* Jump here to continue with next row */
666a9671a22Sdrh   int iBreak              /* Jump here to break out of the inner loop */
6672282792aSdrh ){
6682282792aSdrh   Vdbe *v = pParse->pVdbe;
669d847eaadSdrh   int i;
670ea48eb2eSdrh   int hasDistinct;        /* True if the DISTINCT keyword is present */
671d847eaadSdrh   int regResult;              /* Start of memory holding result set */
672d847eaadSdrh   int eDest = pDest->eDest;   /* How to dispose of results */
6732b596da8Sdrh   int iParm = pDest->iSDParm; /* First argument to disposal method */
674d847eaadSdrh   int nResultCol;             /* Number of result columns */
675fd0a2f97Sdrh   int nPrefixReg = 0;         /* Number of extra registers before regResult */
67638640e15Sdrh 
6771c767f0dSdrh   assert( v );
67838640e15Sdrh   assert( pEList!=0 );
679e8e4af76Sdrh   hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
680079a3072Sdrh   if( pSort && pSort->pOrderBy==0 ) pSort = 0;
681079a3072Sdrh   if( pSort==0 && !hasDistinct ){
682a22a75e5Sdrh     assert( iContinue!=0 );
683aa9ce707Sdrh     codeOffset(v, p->iOffset, iContinue);
684df199a25Sdrh   }
685df199a25Sdrh 
686967e8b73Sdrh   /* Pull the requested columns.
6872282792aSdrh   */
688d847eaadSdrh   nResultCol = pEList->nExpr;
68905a86c5cSdrh 
6902b596da8Sdrh   if( pDest->iSdst==0 ){
691fd0a2f97Sdrh     if( pSort ){
69278d58432Sdan       nPrefixReg = pSort->pOrderBy->nExpr;
69378d58432Sdan       if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
694fd0a2f97Sdrh       pParse->nMem += nPrefixReg;
695fd0a2f97Sdrh     }
6962b596da8Sdrh     pDest->iSdst = pParse->nMem+1;
6970acb7e48Sdrh     pParse->nMem += nResultCol;
69805a86c5cSdrh   }else if( pDest->iSdst+nResultCol > pParse->nMem ){
69905a86c5cSdrh     /* This is an error condition that can result, for example, when a SELECT
70005a86c5cSdrh     ** on the right-hand side of an INSERT contains more result columns than
70105a86c5cSdrh     ** there are columns in the table on the left.  The error will be caught
70205a86c5cSdrh     ** and reported later.  But we need to make sure enough memory is allocated
70305a86c5cSdrh     ** to avoid other spurious errors in the meantime. */
70405a86c5cSdrh     pParse->nMem += nResultCol;
7051013c932Sdrh   }
70605a86c5cSdrh   pDest->nSdst = nResultCol;
7072b596da8Sdrh   regResult = pDest->iSdst;
708340309fdSdrh   if( srcTab>=0 ){
709340309fdSdrh     for(i=0; i<nResultCol; i++){
710d847eaadSdrh       sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
711340309fdSdrh       VdbeComment((v, "%s", pEList->a[i].zName));
71282c3d636Sdrh     }
7139ed1dfa8Sdanielk1977   }else if( eDest!=SRT_Exists ){
7149ed1dfa8Sdanielk1977     /* If the destination is an EXISTS(...) expression, the actual
7159ed1dfa8Sdanielk1977     ** values returned by the SELECT are not required.
7169ed1dfa8Sdanielk1977     */
717d1a01edaSdrh     sqlite3ExprCodeExprList(pParse, pEList, regResult,
7186295524eSdrh                   (eDest==SRT_Output||eDest==SRT_Coroutine)?SQLITE_ECEL_DUP:0);
719a2a49dc9Sdrh   }
7202282792aSdrh 
721daffd0e5Sdrh   /* If the DISTINCT keyword was present on the SELECT statement
722daffd0e5Sdrh   ** and this row has been seen before, then do not make this row
723daffd0e5Sdrh   ** part of the result.
7242282792aSdrh   */
725ea48eb2eSdrh   if( hasDistinct ){
726e8e4af76Sdrh     switch( pDistinct->eTnctType ){
727e8e4af76Sdrh       case WHERE_DISTINCT_ORDERED: {
728e8e4af76Sdrh         VdbeOp *pOp;            /* No longer required OpenEphemeral instr. */
729e8e4af76Sdrh         int iJump;              /* Jump destination */
730e8e4af76Sdrh         int regPrev;            /* Previous row content */
731e8e4af76Sdrh 
732e8e4af76Sdrh         /* Allocate space for the previous row */
733e8e4af76Sdrh         regPrev = pParse->nMem+1;
734340309fdSdrh         pParse->nMem += nResultCol;
735e8e4af76Sdrh 
736e8e4af76Sdrh         /* Change the OP_OpenEphemeral coded earlier to an OP_Null
737e8e4af76Sdrh         ** sets the MEM_Cleared bit on the first register of the
738e8e4af76Sdrh         ** previous value.  This will cause the OP_Ne below to always
739e8e4af76Sdrh         ** fail on the first iteration of the loop even if the first
740e8e4af76Sdrh         ** row is all NULLs.
741e8e4af76Sdrh         */
742e8e4af76Sdrh         sqlite3VdbeChangeToNoop(v, pDistinct->addrTnct);
743e8e4af76Sdrh         pOp = sqlite3VdbeGetOp(v, pDistinct->addrTnct);
744e8e4af76Sdrh         pOp->opcode = OP_Null;
745e8e4af76Sdrh         pOp->p1 = 1;
746e8e4af76Sdrh         pOp->p2 = regPrev;
747e8e4af76Sdrh 
748340309fdSdrh         iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
749340309fdSdrh         for(i=0; i<nResultCol; i++){
750e8e4af76Sdrh           CollSeq *pColl = sqlite3ExprCollSeq(pParse, pEList->a[i].pExpr);
751340309fdSdrh           if( i<nResultCol-1 ){
752e8e4af76Sdrh             sqlite3VdbeAddOp3(v, OP_Ne, regResult+i, iJump, regPrev+i);
753688852abSdrh             VdbeCoverage(v);
754e8e4af76Sdrh           }else{
755e8e4af76Sdrh             sqlite3VdbeAddOp3(v, OP_Eq, regResult+i, iContinue, regPrev+i);
756688852abSdrh             VdbeCoverage(v);
757e8e4af76Sdrh            }
758e8e4af76Sdrh           sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
759e8e4af76Sdrh           sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
760e8e4af76Sdrh         }
761fcf2a775Sdrh         assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
762340309fdSdrh         sqlite3VdbeAddOp3(v, OP_Copy, regResult, regPrev, nResultCol-1);
763e8e4af76Sdrh         break;
764e8e4af76Sdrh       }
765e8e4af76Sdrh 
766e8e4af76Sdrh       case WHERE_DISTINCT_UNIQUE: {
767e8e4af76Sdrh         sqlite3VdbeChangeToNoop(v, pDistinct->addrTnct);
768e8e4af76Sdrh         break;
769e8e4af76Sdrh       }
770e8e4af76Sdrh 
771e8e4af76Sdrh       default: {
772e8e4af76Sdrh         assert( pDistinct->eTnctType==WHERE_DISTINCT_UNORDERED );
773340309fdSdrh         codeDistinct(pParse, pDistinct->tabTnct, iContinue, nResultCol, regResult);
774e8e4af76Sdrh         break;
775e8e4af76Sdrh       }
776e8e4af76Sdrh     }
777079a3072Sdrh     if( pSort==0 ){
778aa9ce707Sdrh       codeOffset(v, p->iOffset, iContinue);
779ea48eb2eSdrh     }
7802282792aSdrh   }
78182c3d636Sdrh 
782c926afbcSdrh   switch( eDest ){
78382c3d636Sdrh     /* In this mode, write each query result to the key of the temporary
78482c3d636Sdrh     ** table iParm.
7852282792aSdrh     */
78613449892Sdrh #ifndef SQLITE_OMIT_COMPOUND_SELECT
787c926afbcSdrh     case SRT_Union: {
7889cbf3425Sdrh       int r1;
7899cbf3425Sdrh       r1 = sqlite3GetTempReg(pParse);
790340309fdSdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
7919cbf3425Sdrh       sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, r1);
7929cbf3425Sdrh       sqlite3ReleaseTempReg(pParse, r1);
793c926afbcSdrh       break;
794c926afbcSdrh     }
79582c3d636Sdrh 
79682c3d636Sdrh     /* Construct a record from the query result, but instead of
79782c3d636Sdrh     ** saving that record, use it as a key to delete elements from
79882c3d636Sdrh     ** the temporary table iParm.
79982c3d636Sdrh     */
800c926afbcSdrh     case SRT_Except: {
801340309fdSdrh       sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
802c926afbcSdrh       break;
803c926afbcSdrh     }
804781def29Sdrh #endif /* SQLITE_OMIT_COMPOUND_SELECT */
8055338a5f7Sdanielk1977 
8065338a5f7Sdanielk1977     /* Store the result as data using a unique key.
8075338a5f7Sdanielk1977     */
8088e1ee88cSdrh     case SRT_Fifo:
8098e1ee88cSdrh     case SRT_DistFifo:
8105338a5f7Sdanielk1977     case SRT_Table:
811b9bb7c18Sdrh     case SRT_EphemTab: {
812fd0a2f97Sdrh       int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
813373cc2ddSdrh       testcase( eDest==SRT_Table );
814373cc2ddSdrh       testcase( eDest==SRT_EphemTab );
815fd0a2f97Sdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
8168ce7184bSdan #ifndef SQLITE_OMIT_CTE
8178e1ee88cSdrh       if( eDest==SRT_DistFifo ){
8188e1ee88cSdrh         /* If the destination is DistFifo, then cursor (iParm+1) is open
8198ce7184bSdan         ** on an ephemeral index. If the current row is already present
8208ce7184bSdan         ** in the index, do not write it to the output. If not, add the
8218ce7184bSdan         ** current row to the index and proceed with writing it to the
8228ce7184bSdan         ** output table as well.  */
8238ce7184bSdan         int addr = sqlite3VdbeCurrentAddr(v) + 4;
824688852abSdrh         sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0); VdbeCoverage(v);
8258ce7184bSdan         sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r1);
826079a3072Sdrh         assert( pSort==0 );
8278ce7184bSdan       }
8288ce7184bSdan #endif
829079a3072Sdrh       if( pSort ){
830fd0a2f97Sdrh         pushOntoSorter(pParse, pSort, p, r1+nPrefixReg, 1, nPrefixReg);
8315338a5f7Sdanielk1977       }else{
832b7654111Sdrh         int r2 = sqlite3GetTempReg(pParse);
833b7654111Sdrh         sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
834b7654111Sdrh         sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
835b7654111Sdrh         sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
836b7654111Sdrh         sqlite3ReleaseTempReg(pParse, r2);
8375338a5f7Sdanielk1977       }
838fd0a2f97Sdrh       sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
8395338a5f7Sdanielk1977       break;
8405338a5f7Sdanielk1977     }
8412282792aSdrh 
84293758c8dSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
8432282792aSdrh     /* If we are creating a set for an "expr IN (SELECT ...)" construct,
8442282792aSdrh     ** then there should be a single item on the stack.  Write this
8452282792aSdrh     ** item into the set table with bogus data.
8462282792aSdrh     */
847c926afbcSdrh     case SRT_Set: {
848340309fdSdrh       assert( nResultCol==1 );
849634d81deSdrh       pDest->affSdst =
850634d81deSdrh                   sqlite3CompareAffinity(pEList->a[0].pExpr, pDest->affSdst);
851079a3072Sdrh       if( pSort ){
852de941c60Sdrh         /* At first glance you would think we could optimize out the
853de941c60Sdrh         ** ORDER BY in this case since the order of entries in the set
854de941c60Sdrh         ** does not matter.  But there might be a LIMIT clause, in which
855de941c60Sdrh         ** case the order does matter */
856fd0a2f97Sdrh         pushOntoSorter(pParse, pSort, p, regResult, 1, nPrefixReg);
857c926afbcSdrh       }else{
858b7654111Sdrh         int r1 = sqlite3GetTempReg(pParse);
859634d81deSdrh         sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult,1,r1, &pDest->affSdst, 1);
860da250ea5Sdrh         sqlite3ExprCacheAffinityChange(pParse, regResult, 1);
861b7654111Sdrh         sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, r1);
862b7654111Sdrh         sqlite3ReleaseTempReg(pParse, r1);
863c926afbcSdrh       }
864c926afbcSdrh       break;
865c926afbcSdrh     }
86682c3d636Sdrh 
867504b6989Sdrh     /* If any row exist in the result set, record that fact and abort.
868ec7429aeSdrh     */
869ec7429aeSdrh     case SRT_Exists: {
8704c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
871ec7429aeSdrh       /* The LIMIT clause will terminate the loop for us */
872ec7429aeSdrh       break;
873ec7429aeSdrh     }
874ec7429aeSdrh 
8752282792aSdrh     /* If this is a scalar select that is part of an expression, then
8762282792aSdrh     ** store the results in the appropriate memory cell and break out
8772282792aSdrh     ** of the scan loop.
8782282792aSdrh     */
879c926afbcSdrh     case SRT_Mem: {
880340309fdSdrh       assert( nResultCol==1 );
881079a3072Sdrh       if( pSort ){
882fd0a2f97Sdrh         pushOntoSorter(pParse, pSort, p, regResult, 1, nPrefixReg);
883c926afbcSdrh       }else{
88453932ce8Sdrh         assert( regResult==iParm );
885ec7429aeSdrh         /* The LIMIT clause will jump out of the loop for us */
886c926afbcSdrh       }
887c926afbcSdrh       break;
888c926afbcSdrh     }
88993758c8dSdanielk1977 #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
8902282792aSdrh 
89181cf13ecSdrh     case SRT_Coroutine:       /* Send data to a co-routine */
89281cf13ecSdrh     case SRT_Output: {        /* Return the results */
893373cc2ddSdrh       testcase( eDest==SRT_Coroutine );
894373cc2ddSdrh       testcase( eDest==SRT_Output );
895079a3072Sdrh       if( pSort ){
896fd0a2f97Sdrh         pushOntoSorter(pParse, pSort, p, regResult, nResultCol, nPrefixReg);
897e00ee6ebSdrh       }else if( eDest==SRT_Coroutine ){
8982b596da8Sdrh         sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
899c182d163Sdrh       }else{
900340309fdSdrh         sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
901340309fdSdrh         sqlite3ExprCacheAffinityChange(pParse, regResult, nResultCol);
902ac82fcf5Sdrh       }
903142e30dfSdrh       break;
904142e30dfSdrh     }
905142e30dfSdrh 
906fe1c6bb9Sdrh #ifndef SQLITE_OMIT_CTE
907fe1c6bb9Sdrh     /* Write the results into a priority queue that is order according to
908fe1c6bb9Sdrh     ** pDest->pOrderBy (in pSO).  pDest->iSDParm (in iParm) is the cursor for an
909fe1c6bb9Sdrh     ** index with pSO->nExpr+2 columns.  Build a key using pSO for the first
910fe1c6bb9Sdrh     ** pSO->nExpr columns, then make sure all keys are unique by adding a
911fe1c6bb9Sdrh     ** final OP_Sequence column.  The last column is the record as a blob.
912fe1c6bb9Sdrh     */
913fe1c6bb9Sdrh     case SRT_DistQueue:
914fe1c6bb9Sdrh     case SRT_Queue: {
915fe1c6bb9Sdrh       int nKey;
916fe1c6bb9Sdrh       int r1, r2, r3;
917fe1c6bb9Sdrh       int addrTest = 0;
918fe1c6bb9Sdrh       ExprList *pSO;
919fe1c6bb9Sdrh       pSO = pDest->pOrderBy;
920fe1c6bb9Sdrh       assert( pSO );
921fe1c6bb9Sdrh       nKey = pSO->nExpr;
922fe1c6bb9Sdrh       r1 = sqlite3GetTempReg(pParse);
923fe1c6bb9Sdrh       r2 = sqlite3GetTempRange(pParse, nKey+2);
924fe1c6bb9Sdrh       r3 = r2+nKey+1;
925fe1c6bb9Sdrh       if( eDest==SRT_DistQueue ){
926fe1c6bb9Sdrh         /* If the destination is DistQueue, then cursor (iParm+1) is open
927fe1c6bb9Sdrh         ** on a second ephemeral index that holds all values every previously
9287e4efaecSdrh         ** added to the queue. */
9297e4efaecSdrh         addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
9307e4efaecSdrh                                         regResult, nResultCol);
931688852abSdrh         VdbeCoverage(v);
9327e4efaecSdrh       }
9337e4efaecSdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
9347e4efaecSdrh       if( eDest==SRT_DistQueue ){
935fe1c6bb9Sdrh         sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
936cfe24586Sdan         sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
937fe1c6bb9Sdrh       }
938fe1c6bb9Sdrh       for(i=0; i<nKey; i++){
939fe1c6bb9Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy,
940fe1c6bb9Sdrh                           regResult + pSO->a[i].u.x.iOrderByCol - 1,
941fe1c6bb9Sdrh                           r2+i);
942fe1c6bb9Sdrh       }
943fe1c6bb9Sdrh       sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
944fe1c6bb9Sdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
945fe1c6bb9Sdrh       sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, r1);
946fe1c6bb9Sdrh       if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
947fe1c6bb9Sdrh       sqlite3ReleaseTempReg(pParse, r1);
948fe1c6bb9Sdrh       sqlite3ReleaseTempRange(pParse, r2, nKey+2);
949fe1c6bb9Sdrh       break;
950fe1c6bb9Sdrh     }
951fe1c6bb9Sdrh #endif /* SQLITE_OMIT_CTE */
952fe1c6bb9Sdrh 
953fe1c6bb9Sdrh 
954fe1c6bb9Sdrh 
9556a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_TRIGGER)
956d7489c39Sdrh     /* Discard the results.  This is used for SELECT statements inside
957d7489c39Sdrh     ** the body of a TRIGGER.  The purpose of such selects is to call
958d7489c39Sdrh     ** user-defined functions that have side effects.  We do not care
959d7489c39Sdrh     ** about the actual results of the select.
960d7489c39Sdrh     */
961c926afbcSdrh     default: {
962f46f905aSdrh       assert( eDest==SRT_Discard );
963c926afbcSdrh       break;
964c926afbcSdrh     }
96593758c8dSdanielk1977 #endif
966c926afbcSdrh   }
967ec7429aeSdrh 
9685e87be87Sdrh   /* Jump to the end of the loop if the LIMIT is reached.  Except, if
9695e87be87Sdrh   ** there is a sorter, in which case the sorter has already limited
9705e87be87Sdrh   ** the output for us.
971ec7429aeSdrh   */
972079a3072Sdrh   if( pSort==0 && p->iLimit ){
973688852abSdrh     sqlite3VdbeAddOp3(v, OP_IfZero, p->iLimit, iBreak, -1); VdbeCoverage(v);
974ec7429aeSdrh   }
97582c3d636Sdrh }
97682c3d636Sdrh 
97782c3d636Sdrh /*
978ad124329Sdrh ** Allocate a KeyInfo object sufficient for an index of N key columns and
979ad124329Sdrh ** X extra columns.
980323df790Sdrh */
981ad124329Sdrh KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
9822ec2fb22Sdrh   KeyInfo *p = sqlite3DbMallocZero(0,
983ad124329Sdrh                    sizeof(KeyInfo) + (N+X)*(sizeof(CollSeq*)+1));
984323df790Sdrh   if( p ){
985ad124329Sdrh     p->aSortOrder = (u8*)&p->aColl[N+X];
986323df790Sdrh     p->nField = (u16)N;
987ad124329Sdrh     p->nXField = (u16)X;
988323df790Sdrh     p->enc = ENC(db);
989323df790Sdrh     p->db = db;
9902ec2fb22Sdrh     p->nRef = 1;
9912ec2fb22Sdrh   }else{
9922ec2fb22Sdrh     db->mallocFailed = 1;
993323df790Sdrh   }
994323df790Sdrh   return p;
995323df790Sdrh }
996323df790Sdrh 
997323df790Sdrh /*
9982ec2fb22Sdrh ** Deallocate a KeyInfo object
9992ec2fb22Sdrh */
10002ec2fb22Sdrh void sqlite3KeyInfoUnref(KeyInfo *p){
10012ec2fb22Sdrh   if( p ){
10022ec2fb22Sdrh     assert( p->nRef>0 );
10032ec2fb22Sdrh     p->nRef--;
1004c6efe12dSmistachkin     if( p->nRef==0 ) sqlite3DbFree(0, p);
10052ec2fb22Sdrh   }
10062ec2fb22Sdrh }
10072ec2fb22Sdrh 
10082ec2fb22Sdrh /*
10092ec2fb22Sdrh ** Make a new pointer to a KeyInfo object
10102ec2fb22Sdrh */
10112ec2fb22Sdrh KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
10122ec2fb22Sdrh   if( p ){
10132ec2fb22Sdrh     assert( p->nRef>0 );
10142ec2fb22Sdrh     p->nRef++;
10152ec2fb22Sdrh   }
10162ec2fb22Sdrh   return p;
10172ec2fb22Sdrh }
10182ec2fb22Sdrh 
10192ec2fb22Sdrh #ifdef SQLITE_DEBUG
10202ec2fb22Sdrh /*
10212ec2fb22Sdrh ** Return TRUE if a KeyInfo object can be change.  The KeyInfo object
10222ec2fb22Sdrh ** can only be changed if this is just a single reference to the object.
10232ec2fb22Sdrh **
10242ec2fb22Sdrh ** This routine is used only inside of assert() statements.
10252ec2fb22Sdrh */
10262ec2fb22Sdrh int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
10272ec2fb22Sdrh #endif /* SQLITE_DEBUG */
10282ec2fb22Sdrh 
10292ec2fb22Sdrh /*
1030dece1a84Sdrh ** Given an expression list, generate a KeyInfo structure that records
1031dece1a84Sdrh ** the collating sequence for each expression in that expression list.
1032dece1a84Sdrh **
10330342b1f5Sdrh ** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
10340342b1f5Sdrh ** KeyInfo structure is appropriate for initializing a virtual index to
10350342b1f5Sdrh ** implement that clause.  If the ExprList is the result set of a SELECT
10360342b1f5Sdrh ** then the KeyInfo structure is appropriate for initializing a virtual
10370342b1f5Sdrh ** index to implement a DISTINCT test.
10380342b1f5Sdrh **
103960ec914cSpeter.d.reid ** Space to hold the KeyInfo structure is obtained from malloc.  The calling
1040dece1a84Sdrh ** function is responsible for seeing that this structure is eventually
10412ec2fb22Sdrh ** freed.
1042dece1a84Sdrh */
1043079a3072Sdrh static KeyInfo *keyInfoFromExprList(
1044079a3072Sdrh   Parse *pParse,       /* Parsing context */
1045079a3072Sdrh   ExprList *pList,     /* Form the KeyInfo object from this ExprList */
1046079a3072Sdrh   int iStart,          /* Begin with this column of pList */
1047079a3072Sdrh   int nExtra           /* Add this many extra columns to the end */
1048079a3072Sdrh ){
1049dece1a84Sdrh   int nExpr;
1050dece1a84Sdrh   KeyInfo *pInfo;
1051dece1a84Sdrh   struct ExprList_item *pItem;
1052323df790Sdrh   sqlite3 *db = pParse->db;
1053dece1a84Sdrh   int i;
1054dece1a84Sdrh 
1055dece1a84Sdrh   nExpr = pList->nExpr;
1056079a3072Sdrh   pInfo = sqlite3KeyInfoAlloc(db, nExpr+nExtra-iStart, 1);
1057dece1a84Sdrh   if( pInfo ){
10582ec2fb22Sdrh     assert( sqlite3KeyInfoIsWriteable(pInfo) );
10596284db90Sdrh     for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
1060dece1a84Sdrh       CollSeq *pColl;
1061dece1a84Sdrh       pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
1062323df790Sdrh       if( !pColl ) pColl = db->pDfltColl;
10636284db90Sdrh       pInfo->aColl[i-iStart] = pColl;
10646284db90Sdrh       pInfo->aSortOrder[i-iStart] = pItem->sortOrder;
1065dece1a84Sdrh     }
1066dece1a84Sdrh   }
1067dece1a84Sdrh   return pInfo;
1068dece1a84Sdrh }
1069dece1a84Sdrh 
10707f61e92cSdan #ifndef SQLITE_OMIT_COMPOUND_SELECT
10717f61e92cSdan /*
10727f61e92cSdan ** Name of the connection operator, used for error messages.
10737f61e92cSdan */
10747f61e92cSdan static const char *selectOpName(int id){
10757f61e92cSdan   char *z;
10767f61e92cSdan   switch( id ){
10777f61e92cSdan     case TK_ALL:       z = "UNION ALL";   break;
10787f61e92cSdan     case TK_INTERSECT: z = "INTERSECT";   break;
10797f61e92cSdan     case TK_EXCEPT:    z = "EXCEPT";      break;
10807f61e92cSdan     default:           z = "UNION";       break;
10817f61e92cSdan   }
10827f61e92cSdan   return z;
10837f61e92cSdan }
10847f61e92cSdan #endif /* SQLITE_OMIT_COMPOUND_SELECT */
10857f61e92cSdan 
10862ce22453Sdan #ifndef SQLITE_OMIT_EXPLAIN
108717c0bc0cSdan /*
108817c0bc0cSdan ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
108917c0bc0cSdan ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
109017c0bc0cSdan ** where the caption is of the form:
109117c0bc0cSdan **
109217c0bc0cSdan **   "USE TEMP B-TREE FOR xxx"
109317c0bc0cSdan **
109417c0bc0cSdan ** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
109517c0bc0cSdan ** is determined by the zUsage argument.
109617c0bc0cSdan */
10972ce22453Sdan static void explainTempTable(Parse *pParse, const char *zUsage){
10982ce22453Sdan   if( pParse->explain==2 ){
10992ce22453Sdan     Vdbe *v = pParse->pVdbe;
11002ce22453Sdan     char *zMsg = sqlite3MPrintf(pParse->db, "USE TEMP B-TREE FOR %s", zUsage);
11012ce22453Sdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
11022ce22453Sdan   }
11032ce22453Sdan }
110417c0bc0cSdan 
110517c0bc0cSdan /*
1106bb2b4418Sdan ** Assign expression b to lvalue a. A second, no-op, version of this macro
1107bb2b4418Sdan ** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
1108bb2b4418Sdan ** in sqlite3Select() to assign values to structure member variables that
1109bb2b4418Sdan ** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
1110bb2b4418Sdan ** code with #ifndef directives.
1111bb2b4418Sdan */
1112bb2b4418Sdan # define explainSetInteger(a, b) a = b
1113bb2b4418Sdan 
1114bb2b4418Sdan #else
1115bb2b4418Sdan /* No-op versions of the explainXXX() functions and macros. */
1116bb2b4418Sdan # define explainTempTable(y,z)
1117bb2b4418Sdan # define explainSetInteger(y,z)
1118bb2b4418Sdan #endif
1119bb2b4418Sdan 
1120bb2b4418Sdan #if !defined(SQLITE_OMIT_EXPLAIN) && !defined(SQLITE_OMIT_COMPOUND_SELECT)
1121bb2b4418Sdan /*
11227f61e92cSdan ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
11237f61e92cSdan ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
11247f61e92cSdan ** where the caption is of one of the two forms:
11257f61e92cSdan **
11267f61e92cSdan **   "COMPOSITE SUBQUERIES iSub1 and iSub2 (op)"
11277f61e92cSdan **   "COMPOSITE SUBQUERIES iSub1 and iSub2 USING TEMP B-TREE (op)"
11287f61e92cSdan **
11297f61e92cSdan ** where iSub1 and iSub2 are the integers passed as the corresponding
11307f61e92cSdan ** function parameters, and op is the text representation of the parameter
11317f61e92cSdan ** of the same name. The parameter "op" must be one of TK_UNION, TK_EXCEPT,
11327f61e92cSdan ** TK_INTERSECT or TK_ALL. The first form is used if argument bUseTmp is
11337f61e92cSdan ** false, or the second form if it is true.
11347f61e92cSdan */
11357f61e92cSdan static void explainComposite(
11367f61e92cSdan   Parse *pParse,                  /* Parse context */
11377f61e92cSdan   int op,                         /* One of TK_UNION, TK_EXCEPT etc. */
11387f61e92cSdan   int iSub1,                      /* Subquery id 1 */
11397f61e92cSdan   int iSub2,                      /* Subquery id 2 */
11407f61e92cSdan   int bUseTmp                     /* True if a temp table was used */
11417f61e92cSdan ){
11427f61e92cSdan   assert( op==TK_UNION || op==TK_EXCEPT || op==TK_INTERSECT || op==TK_ALL );
11437f61e92cSdan   if( pParse->explain==2 ){
11447f61e92cSdan     Vdbe *v = pParse->pVdbe;
11457f61e92cSdan     char *zMsg = sqlite3MPrintf(
114630969d3fSdan         pParse->db, "COMPOUND SUBQUERIES %d AND %d %s(%s)", iSub1, iSub2,
11477f61e92cSdan         bUseTmp?"USING TEMP B-TREE ":"", selectOpName(op)
11487f61e92cSdan     );
11497f61e92cSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
11507f61e92cSdan   }
11517f61e92cSdan }
11522ce22453Sdan #else
115317c0bc0cSdan /* No-op versions of the explainXXX() functions and macros. */
11547f61e92cSdan # define explainComposite(v,w,x,y,z)
11552ce22453Sdan #endif
1156dece1a84Sdrh 
1157dece1a84Sdrh /*
1158d8bc7086Sdrh ** If the inner loop was generated using a non-null pOrderBy argument,
1159d8bc7086Sdrh ** then the results were placed in a sorter.  After the loop is terminated
1160d8bc7086Sdrh ** we need to run the sorter and output the results.  The following
1161d8bc7086Sdrh ** routine generates the code needed to do that.
1162d8bc7086Sdrh */
1163c926afbcSdrh static void generateSortTail(
1164cdd536f0Sdrh   Parse *pParse,    /* Parsing context */
1165c926afbcSdrh   Select *p,        /* The SELECT statement */
1166079a3072Sdrh   SortCtx *pSort,   /* Information on the ORDER BY clause */
1167c926afbcSdrh   int nColumn,      /* Number of columns of data */
11686c8c8ce0Sdanielk1977   SelectDest *pDest /* Write the sorted results here */
1169c926afbcSdrh ){
1170ddba0c22Sdrh   Vdbe *v = pParse->pVdbe;                     /* The prepared statement */
1171dc5ea5c7Sdrh   int addrBreak = sqlite3VdbeMakeLabel(v);     /* Jump here to exit loop */
1172dc5ea5c7Sdrh   int addrContinue = sqlite3VdbeMakeLabel(v);  /* Jump here for next cycle */
1173d8bc7086Sdrh   int addr;
1174079a3072Sdrh   int addrOnce = 0;
11750342b1f5Sdrh   int iTab;
1176079a3072Sdrh   ExprList *pOrderBy = pSort->pOrderBy;
11776c8c8ce0Sdanielk1977   int eDest = pDest->eDest;
11782b596da8Sdrh   int iParm = pDest->iSDParm;
11792d401ab8Sdrh   int regRow;
11802d401ab8Sdrh   int regRowid;
1181079a3072Sdrh   int nKey;
1182f45f2326Sdrh   int iSortTab;                   /* Sorter cursor to read from */
1183f45f2326Sdrh   int nSortData;                  /* Trailing values to read from sorter */
1184f45f2326Sdrh   u8 p5;                          /* p5 parameter for 1st OP_Column */
1185f45f2326Sdrh   int i;
118678d58432Sdan   int bSeq;                       /* True if sorter record includes seq. no. */
118770f624c3Sdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
118870f624c3Sdrh   struct ExprList_item *aOutEx = p->pEList->a;
118970f624c3Sdrh #endif
11902d401ab8Sdrh 
1191079a3072Sdrh   if( pSort->labelBkOut ){
1192079a3072Sdrh     sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
1193079a3072Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, addrBreak);
1194079a3072Sdrh     sqlite3VdbeResolveLabel(v, pSort->labelBkOut);
1195079a3072Sdrh   }
1196079a3072Sdrh   iTab = pSort->iECursor;
11977d10d5a6Sdrh   if( eDest==SRT_Output || eDest==SRT_Coroutine ){
11983e9ca094Sdrh     regRowid = 0;
1199f45f2326Sdrh     regRow = pDest->iSdst;
1200f45f2326Sdrh     nSortData = nColumn;
12013e9ca094Sdrh   }else{
12023e9ca094Sdrh     regRowid = sqlite3GetTempReg(pParse);
1203f45f2326Sdrh     regRow = sqlite3GetTempReg(pParse);
1204f45f2326Sdrh     nSortData = 1;
1205cdd536f0Sdrh   }
1206079a3072Sdrh   nKey = pOrderBy->nExpr - pSort->nOBSat;
1207079a3072Sdrh   if( pSort->sortFlags & SORTFLAG_UseSorter ){
1208c2bb3282Sdrh     int regSortOut = ++pParse->nMem;
1209f45f2326Sdrh     iSortTab = pParse->nTab++;
121083553eefSdrh     if( pSort->labelBkOut ){
121183553eefSdrh       addrOnce = sqlite3CodeOnce(pParse); VdbeCoverage(v);
121283553eefSdrh     }
1213f45f2326Sdrh     sqlite3VdbeAddOp3(v, OP_OpenPseudo, iSortTab, regSortOut, nKey+1+nSortData);
1214079a3072Sdrh     if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
1215c6aff30cSdrh     addr = 1 + sqlite3VdbeAddOp2(v, OP_SorterSort, iTab, addrBreak);
1216688852abSdrh     VdbeCoverage(v);
1217aa9ce707Sdrh     codeOffset(v, p->iOffset, addrContinue);
1218c6aff30cSdrh     sqlite3VdbeAddOp2(v, OP_SorterData, iTab, regSortOut);
1219f45f2326Sdrh     p5 = OPFLAG_CLEARCACHE;
122078d58432Sdan     bSeq = 0;
1221c6aff30cSdrh   }else{
1222688852abSdrh     addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
1223aa9ce707Sdrh     codeOffset(v, p->iOffset, addrContinue);
1224f45f2326Sdrh     iSortTab = iTab;
1225f45f2326Sdrh     p5 = 0;
122678d58432Sdan     bSeq = 1;
1227f45f2326Sdrh   }
1228f45f2326Sdrh   for(i=0; i<nSortData; i++){
122978d58432Sdan     sqlite3VdbeAddOp3(v, OP_Column, iSortTab, nKey+bSeq+i, regRow+i);
1230f45f2326Sdrh     if( i==0 ) sqlite3VdbeChangeP5(v, p5);
123170f624c3Sdrh     VdbeComment((v, "%s", aOutEx[i].zName ? aOutEx[i].zName : aOutEx[i].zSpan));
1232c6aff30cSdrh   }
1233c926afbcSdrh   switch( eDest ){
1234c926afbcSdrh     case SRT_Table:
1235b9bb7c18Sdrh     case SRT_EphemTab: {
12361c767f0dSdrh       testcase( eDest==SRT_Table );
12371c767f0dSdrh       testcase( eDest==SRT_EphemTab );
12382d401ab8Sdrh       sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
12392d401ab8Sdrh       sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
12402d401ab8Sdrh       sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1241c926afbcSdrh       break;
1242c926afbcSdrh     }
124393758c8dSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
1244c926afbcSdrh     case SRT_Set: {
1245c926afbcSdrh       assert( nColumn==1 );
1246634d81deSdrh       sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, 1, regRowid,
1247634d81deSdrh                         &pDest->affSdst, 1);
1248da250ea5Sdrh       sqlite3ExprCacheAffinityChange(pParse, regRow, 1);
1249a7a8e14bSdanielk1977       sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, regRowid);
1250c926afbcSdrh       break;
1251c926afbcSdrh     }
1252c926afbcSdrh     case SRT_Mem: {
1253c926afbcSdrh       assert( nColumn==1 );
1254b21e7c70Sdrh       sqlite3ExprCodeMove(pParse, regRow, iParm, 1);
1255ec7429aeSdrh       /* The LIMIT clause will terminate the loop for us */
1256c926afbcSdrh       break;
1257c926afbcSdrh     }
125893758c8dSdanielk1977 #endif
1259373cc2ddSdrh     default: {
1260373cc2ddSdrh       assert( eDest==SRT_Output || eDest==SRT_Coroutine );
12611c767f0dSdrh       testcase( eDest==SRT_Output );
12621c767f0dSdrh       testcase( eDest==SRT_Coroutine );
12637d10d5a6Sdrh       if( eDest==SRT_Output ){
12642b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
12652b596da8Sdrh         sqlite3ExprCacheAffinityChange(pParse, pDest->iSdst, nColumn);
1266a9671a22Sdrh       }else{
12672b596da8Sdrh         sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
1268ce665cf6Sdrh       }
1269ac82fcf5Sdrh       break;
1270ac82fcf5Sdrh     }
1271c926afbcSdrh   }
1272f45f2326Sdrh   if( regRowid ){
12732d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, regRow);
12742d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, regRowid);
1275f45f2326Sdrh   }
1276ec7429aeSdrh   /* The bottom of the loop
1277ec7429aeSdrh   */
1278dc5ea5c7Sdrh   sqlite3VdbeResolveLabel(v, addrContinue);
1279079a3072Sdrh   if( pSort->sortFlags & SORTFLAG_UseSorter ){
1280688852abSdrh     sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
1281c6aff30cSdrh   }else{
1282688852abSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
1283c6aff30cSdrh   }
1284079a3072Sdrh   if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
1285dc5ea5c7Sdrh   sqlite3VdbeResolveLabel(v, addrBreak);
1286d8bc7086Sdrh }
1287d8bc7086Sdrh 
1288d8bc7086Sdrh /*
1289517eb646Sdanielk1977 ** Return a pointer to a string containing the 'declaration type' of the
1290517eb646Sdanielk1977 ** expression pExpr. The string may be treated as static by the caller.
1291e78e8284Sdrh **
12925f3e5e74Sdrh ** Also try to estimate the size of the returned value and return that
12935f3e5e74Sdrh ** result in *pEstWidth.
12945f3e5e74Sdrh **
1295955de52cSdanielk1977 ** The declaration type is the exact datatype definition extracted from the
1296955de52cSdanielk1977 ** original CREATE TABLE statement if the expression is a column. The
1297955de52cSdanielk1977 ** declaration type for a ROWID field is INTEGER. Exactly when an expression
1298955de52cSdanielk1977 ** is considered a column can be complex in the presence of subqueries. The
1299955de52cSdanielk1977 ** result-set expression in all of the following SELECT statements is
1300955de52cSdanielk1977 ** considered a column by this function.
1301e78e8284Sdrh **
1302955de52cSdanielk1977 **   SELECT col FROM tbl;
1303955de52cSdanielk1977 **   SELECT (SELECT col FROM tbl;
1304955de52cSdanielk1977 **   SELECT (SELECT col FROM tbl);
1305955de52cSdanielk1977 **   SELECT abc FROM (SELECT col AS abc FROM tbl);
1306955de52cSdanielk1977 **
1307955de52cSdanielk1977 ** The declaration type for any expression other than a column is NULL.
13085f3e5e74Sdrh **
13095f3e5e74Sdrh ** This routine has either 3 or 6 parameters depending on whether or not
13105f3e5e74Sdrh ** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
1311fcb78a49Sdrh */
13125f3e5e74Sdrh #ifdef SQLITE_ENABLE_COLUMN_METADATA
13135f3e5e74Sdrh # define columnType(A,B,C,D,E,F) columnTypeImpl(A,B,C,D,E,F)
13145f3e5e74Sdrh static const char *columnTypeImpl(
1315955de52cSdanielk1977   NameContext *pNC,
1316955de52cSdanielk1977   Expr *pExpr,
13175f3e5e74Sdrh   const char **pzOrigDb,
13185f3e5e74Sdrh   const char **pzOrigTab,
13195f3e5e74Sdrh   const char **pzOrigCol,
13205f3e5e74Sdrh   u8 *pEstWidth
1321955de52cSdanielk1977 ){
13225f3e5e74Sdrh   char const *zOrigDb = 0;
13235f3e5e74Sdrh   char const *zOrigTab = 0;
13245f3e5e74Sdrh   char const *zOrigCol = 0;
13255f3e5e74Sdrh #else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
13265f3e5e74Sdrh # define columnType(A,B,C,D,E,F) columnTypeImpl(A,B,F)
13275f3e5e74Sdrh static const char *columnTypeImpl(
13285f3e5e74Sdrh   NameContext *pNC,
13295f3e5e74Sdrh   Expr *pExpr,
13305f3e5e74Sdrh   u8 *pEstWidth
13315f3e5e74Sdrh ){
13325f3e5e74Sdrh #endif /* !defined(SQLITE_ENABLE_COLUMN_METADATA) */
1333955de52cSdanielk1977   char const *zType = 0;
1334517eb646Sdanielk1977   int j;
13355f3e5e74Sdrh   u8 estWidth = 1;
13365338a5f7Sdanielk1977 
13375f3e5e74Sdrh   if( NEVER(pExpr==0) || pNC->pSrcList==0 ) return 0;
133800e279d9Sdanielk1977   switch( pExpr->op ){
133930bcf5dbSdrh     case TK_AGG_COLUMN:
134000e279d9Sdanielk1977     case TK_COLUMN: {
1341955de52cSdanielk1977       /* The expression is a column. Locate the table the column is being
1342955de52cSdanielk1977       ** extracted from in NameContext.pSrcList. This table may be real
1343955de52cSdanielk1977       ** database table or a subquery.
1344955de52cSdanielk1977       */
1345955de52cSdanielk1977       Table *pTab = 0;            /* Table structure column is extracted from */
1346955de52cSdanielk1977       Select *pS = 0;             /* Select the column is extracted from */
1347955de52cSdanielk1977       int iCol = pExpr->iColumn;  /* Index of column in pTab */
1348373cc2ddSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1349373cc2ddSdrh       testcase( pExpr->op==TK_COLUMN );
135043bc88bbSdan       while( pNC && !pTab ){
1351b3bce662Sdanielk1977         SrcList *pTabList = pNC->pSrcList;
1352b3bce662Sdanielk1977         for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
1353b3bce662Sdanielk1977         if( j<pTabList->nSrc ){
13546a3ea0e6Sdrh           pTab = pTabList->a[j].pTab;
1355955de52cSdanielk1977           pS = pTabList->a[j].pSelect;
1356b3bce662Sdanielk1977         }else{
1357b3bce662Sdanielk1977           pNC = pNC->pNext;
1358b3bce662Sdanielk1977         }
1359b3bce662Sdanielk1977       }
1360955de52cSdanielk1977 
136143bc88bbSdan       if( pTab==0 ){
1362417168adSdrh         /* At one time, code such as "SELECT new.x" within a trigger would
1363417168adSdrh         ** cause this condition to run.  Since then, we have restructured how
1364417168adSdrh         ** trigger code is generated and so this condition is no longer
136543bc88bbSdan         ** possible. However, it can still be true for statements like
136643bc88bbSdan         ** the following:
136743bc88bbSdan         **
136843bc88bbSdan         **   CREATE TABLE t1(col INTEGER);
136943bc88bbSdan         **   SELECT (SELECT t1.col) FROM FROM t1;
137043bc88bbSdan         **
137143bc88bbSdan         ** when columnType() is called on the expression "t1.col" in the
137243bc88bbSdan         ** sub-select. In this case, set the column type to NULL, even
137343bc88bbSdan         ** though it should really be "INTEGER".
137443bc88bbSdan         **
137543bc88bbSdan         ** This is not a problem, as the column type of "t1.col" is never
137643bc88bbSdan         ** used. When columnType() is called on the expression
137743bc88bbSdan         ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
137843bc88bbSdan         ** branch below.  */
13797e62779aSdrh         break;
13807e62779aSdrh       }
1381955de52cSdanielk1977 
138243bc88bbSdan       assert( pTab && pExpr->pTab==pTab );
1383955de52cSdanielk1977       if( pS ){
1384955de52cSdanielk1977         /* The "table" is actually a sub-select or a view in the FROM clause
1385955de52cSdanielk1977         ** of the SELECT statement. Return the declaration type and origin
1386955de52cSdanielk1977         ** data for the result-set column of the sub-select.
1387955de52cSdanielk1977         */
13887b688edeSdrh         if( iCol>=0 && ALWAYS(iCol<pS->pEList->nExpr) ){
1389955de52cSdanielk1977           /* If iCol is less than zero, then the expression requests the
1390955de52cSdanielk1977           ** rowid of the sub-select or view. This expression is legal (see
1391955de52cSdanielk1977           ** test case misc2.2.2) - it always evaluates to NULL.
1392955de52cSdanielk1977           */
1393955de52cSdanielk1977           NameContext sNC;
1394955de52cSdanielk1977           Expr *p = pS->pEList->a[iCol].pExpr;
1395955de52cSdanielk1977           sNC.pSrcList = pS->pSrc;
139643bc88bbSdan           sNC.pNext = pNC;
1397955de52cSdanielk1977           sNC.pParse = pNC->pParse;
13985f3e5e74Sdrh           zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol, &estWidth);
1399955de52cSdanielk1977         }
140093c36bb3Sdrh       }else if( pTab->pSchema ){
1401955de52cSdanielk1977         /* A real table */
1402955de52cSdanielk1977         assert( !pS );
1403fcb78a49Sdrh         if( iCol<0 ) iCol = pTab->iPKey;
1404fcb78a49Sdrh         assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
14055f3e5e74Sdrh #ifdef SQLITE_ENABLE_COLUMN_METADATA
1406fcb78a49Sdrh         if( iCol<0 ){
1407fcb78a49Sdrh           zType = "INTEGER";
14085f3e5e74Sdrh           zOrigCol = "rowid";
1409fcb78a49Sdrh         }else{
1410fcb78a49Sdrh           zType = pTab->aCol[iCol].zType;
14115f3e5e74Sdrh           zOrigCol = pTab->aCol[iCol].zName;
14125f3e5e74Sdrh           estWidth = pTab->aCol[iCol].szEst;
1413955de52cSdanielk1977         }
14145f3e5e74Sdrh         zOrigTab = pTab->zName;
1415955de52cSdanielk1977         if( pNC->pParse ){
1416955de52cSdanielk1977           int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
14175f3e5e74Sdrh           zOrigDb = pNC->pParse->db->aDb[iDb].zName;
1418955de52cSdanielk1977         }
14195f3e5e74Sdrh #else
14205f3e5e74Sdrh         if( iCol<0 ){
14215f3e5e74Sdrh           zType = "INTEGER";
14225f3e5e74Sdrh         }else{
14235f3e5e74Sdrh           zType = pTab->aCol[iCol].zType;
14245f3e5e74Sdrh           estWidth = pTab->aCol[iCol].szEst;
14255f3e5e74Sdrh         }
14265f3e5e74Sdrh #endif
1427fcb78a49Sdrh       }
142800e279d9Sdanielk1977       break;
1429736c22b8Sdrh     }
143093758c8dSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
143100e279d9Sdanielk1977     case TK_SELECT: {
1432955de52cSdanielk1977       /* The expression is a sub-select. Return the declaration type and
1433955de52cSdanielk1977       ** origin info for the single column in the result set of the SELECT
1434955de52cSdanielk1977       ** statement.
1435955de52cSdanielk1977       */
1436b3bce662Sdanielk1977       NameContext sNC;
14376ab3a2ecSdanielk1977       Select *pS = pExpr->x.pSelect;
1438955de52cSdanielk1977       Expr *p = pS->pEList->a[0].pExpr;
14396ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
1440955de52cSdanielk1977       sNC.pSrcList = pS->pSrc;
1441b3bce662Sdanielk1977       sNC.pNext = pNC;
1442955de52cSdanielk1977       sNC.pParse = pNC->pParse;
14435f3e5e74Sdrh       zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol, &estWidth);
144400e279d9Sdanielk1977       break;
1445fcb78a49Sdrh     }
144693758c8dSdanielk1977 #endif
144700e279d9Sdanielk1977   }
144800e279d9Sdanielk1977 
14495f3e5e74Sdrh #ifdef SQLITE_ENABLE_COLUMN_METADATA
14505f3e5e74Sdrh   if( pzOrigDb ){
14515f3e5e74Sdrh     assert( pzOrigTab && pzOrigCol );
14525f3e5e74Sdrh     *pzOrigDb = zOrigDb;
14535f3e5e74Sdrh     *pzOrigTab = zOrigTab;
14545f3e5e74Sdrh     *pzOrigCol = zOrigCol;
1455955de52cSdanielk1977   }
14565f3e5e74Sdrh #endif
14575f3e5e74Sdrh   if( pEstWidth ) *pEstWidth = estWidth;
1458517eb646Sdanielk1977   return zType;
1459517eb646Sdanielk1977 }
1460517eb646Sdanielk1977 
1461517eb646Sdanielk1977 /*
1462517eb646Sdanielk1977 ** Generate code that will tell the VDBE the declaration types of columns
1463517eb646Sdanielk1977 ** in the result set.
1464517eb646Sdanielk1977 */
1465517eb646Sdanielk1977 static void generateColumnTypes(
1466517eb646Sdanielk1977   Parse *pParse,      /* Parser context */
1467517eb646Sdanielk1977   SrcList *pTabList,  /* List of tables */
1468517eb646Sdanielk1977   ExprList *pEList    /* Expressions defining the result set */
1469517eb646Sdanielk1977 ){
14703f913576Sdrh #ifndef SQLITE_OMIT_DECLTYPE
1471517eb646Sdanielk1977   Vdbe *v = pParse->pVdbe;
1472517eb646Sdanielk1977   int i;
1473b3bce662Sdanielk1977   NameContext sNC;
1474b3bce662Sdanielk1977   sNC.pSrcList = pTabList;
1475955de52cSdanielk1977   sNC.pParse = pParse;
1476517eb646Sdanielk1977   for(i=0; i<pEList->nExpr; i++){
1477517eb646Sdanielk1977     Expr *p = pEList->a[i].pExpr;
14783f913576Sdrh     const char *zType;
14793f913576Sdrh #ifdef SQLITE_ENABLE_COLUMN_METADATA
1480955de52cSdanielk1977     const char *zOrigDb = 0;
1481955de52cSdanielk1977     const char *zOrigTab = 0;
1482955de52cSdanielk1977     const char *zOrigCol = 0;
14835f3e5e74Sdrh     zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol, 0);
1484955de52cSdanielk1977 
148585b623f2Sdrh     /* The vdbe must make its own copy of the column-type and other
14864b1ae99dSdanielk1977     ** column specific strings, in case the schema is reset before this
14874b1ae99dSdanielk1977     ** virtual machine is deleted.
1488fbcd585fSdanielk1977     */
148910fb749bSdanielk1977     sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
149010fb749bSdanielk1977     sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
149110fb749bSdanielk1977     sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
14923f913576Sdrh #else
14935f3e5e74Sdrh     zType = columnType(&sNC, p, 0, 0, 0, 0);
14943f913576Sdrh #endif
149510fb749bSdanielk1977     sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
1496fcb78a49Sdrh   }
14975f3e5e74Sdrh #endif /* !defined(SQLITE_OMIT_DECLTYPE) */
1498fcb78a49Sdrh }
1499fcb78a49Sdrh 
1500fcb78a49Sdrh /*
1501fcb78a49Sdrh ** Generate code that will tell the VDBE the names of columns
1502fcb78a49Sdrh ** in the result set.  This information is used to provide the
1503fcabd464Sdrh ** azCol[] values in the callback.
150482c3d636Sdrh */
1505832508b7Sdrh static void generateColumnNames(
1506832508b7Sdrh   Parse *pParse,      /* Parser context */
1507ad3cab52Sdrh   SrcList *pTabList,  /* List of tables */
1508832508b7Sdrh   ExprList *pEList    /* Expressions defining the result set */
1509832508b7Sdrh ){
1510d8bc7086Sdrh   Vdbe *v = pParse->pVdbe;
15116a3ea0e6Sdrh   int i, j;
15129bb575fdSdrh   sqlite3 *db = pParse->db;
1513fcabd464Sdrh   int fullNames, shortNames;
1514fcabd464Sdrh 
1515fe2093d7Sdrh #ifndef SQLITE_OMIT_EXPLAIN
15163cf86063Sdanielk1977   /* If this is an EXPLAIN, skip this step */
15173cf86063Sdanielk1977   if( pParse->explain ){
151861de0d1bSdanielk1977     return;
15193cf86063Sdanielk1977   }
15205338a5f7Sdanielk1977 #endif
15213cf86063Sdanielk1977 
1522e2f02bacSdrh   if( pParse->colNamesSet || NEVER(v==0) || db->mallocFailed ) return;
1523d8bc7086Sdrh   pParse->colNamesSet = 1;
1524fcabd464Sdrh   fullNames = (db->flags & SQLITE_FullColNames)!=0;
1525fcabd464Sdrh   shortNames = (db->flags & SQLITE_ShortColNames)!=0;
152622322fd4Sdanielk1977   sqlite3VdbeSetNumCols(v, pEList->nExpr);
152782c3d636Sdrh   for(i=0; i<pEList->nExpr; i++){
152882c3d636Sdrh     Expr *p;
15295a38705eSdrh     p = pEList->a[i].pExpr;
1530373cc2ddSdrh     if( NEVER(p==0) ) continue;
153182c3d636Sdrh     if( pEList->a[i].zName ){
153282c3d636Sdrh       char *zName = pEList->a[i].zName;
153310fb749bSdanielk1977       sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
1534f018cc2eSdrh     }else if( (p->op==TK_COLUMN || p->op==TK_AGG_COLUMN) && pTabList ){
15356a3ea0e6Sdrh       Table *pTab;
153697665873Sdrh       char *zCol;
15378aff1015Sdrh       int iCol = p->iColumn;
1538e2f02bacSdrh       for(j=0; ALWAYS(j<pTabList->nSrc); j++){
1539e2f02bacSdrh         if( pTabList->a[j].iCursor==p->iTable ) break;
1540e2f02bacSdrh       }
15416a3ea0e6Sdrh       assert( j<pTabList->nSrc );
15426a3ea0e6Sdrh       pTab = pTabList->a[j].pTab;
15438aff1015Sdrh       if( iCol<0 ) iCol = pTab->iPKey;
154497665873Sdrh       assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
1545b1363206Sdrh       if( iCol<0 ){
154647a6db2bSdrh         zCol = "rowid";
1547b1363206Sdrh       }else{
1548b1363206Sdrh         zCol = pTab->aCol[iCol].zName;
1549b1363206Sdrh       }
1550e49b146fSdrh       if( !shortNames && !fullNames ){
155110fb749bSdanielk1977         sqlite3VdbeSetColName(v, i, COLNAME_NAME,
1552b7916a78Sdrh             sqlite3DbStrDup(db, pEList->a[i].zSpan), SQLITE_DYNAMIC);
15531c767f0dSdrh       }else if( fullNames ){
155482c3d636Sdrh         char *zName = 0;
15551c767f0dSdrh         zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
155610fb749bSdanielk1977         sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
155782c3d636Sdrh       }else{
155810fb749bSdanielk1977         sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
155982c3d636Sdrh       }
15601bee3d7bSdrh     }else{
1561859bc542Sdrh       const char *z = pEList->a[i].zSpan;
1562859bc542Sdrh       z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
1563859bc542Sdrh       sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
156482c3d636Sdrh     }
156582c3d636Sdrh   }
156676d505baSdanielk1977   generateColumnTypes(pParse, pTabList, pEList);
15675080aaa7Sdrh }
156882c3d636Sdrh 
1569d8bc7086Sdrh /*
157060ec914cSpeter.d.reid ** Given an expression list (which is really the list of expressions
15717d10d5a6Sdrh ** that form the result set of a SELECT statement) compute appropriate
15727d10d5a6Sdrh ** column names for a table that would hold the expression list.
15737d10d5a6Sdrh **
15747d10d5a6Sdrh ** All column names will be unique.
15757d10d5a6Sdrh **
15767d10d5a6Sdrh ** Only the column names are computed.  Column.zType, Column.zColl,
15777d10d5a6Sdrh ** and other fields of Column are zeroed.
15787d10d5a6Sdrh **
15797d10d5a6Sdrh ** Return SQLITE_OK on success.  If a memory allocation error occurs,
15807d10d5a6Sdrh ** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
1581315555caSdrh */
15827d10d5a6Sdrh static int selectColumnsFromExprList(
15837d10d5a6Sdrh   Parse *pParse,          /* Parsing context */
15847d10d5a6Sdrh   ExprList *pEList,       /* Expr list from which to derive column names */
1585d815f17dSdrh   i16 *pnCol,             /* Write the number of columns here */
15867d10d5a6Sdrh   Column **paCol          /* Write the new column list here */
15877d10d5a6Sdrh ){
1588dc5ea5c7Sdrh   sqlite3 *db = pParse->db;   /* Database connection */
1589dc5ea5c7Sdrh   int i, j;                   /* Loop counters */
1590dc5ea5c7Sdrh   int cnt;                    /* Index added to make the name unique */
1591dc5ea5c7Sdrh   Column *aCol, *pCol;        /* For looping over result columns */
1592dc5ea5c7Sdrh   int nCol;                   /* Number of columns in the result set */
1593dc5ea5c7Sdrh   Expr *p;                    /* Expression for a single result column */
1594dc5ea5c7Sdrh   char *zName;                /* Column name */
1595dc5ea5c7Sdrh   int nName;                  /* Size of name in zName[] */
159679d5f63fSdrh 
15978c2e0f02Sdan   if( pEList ){
15988c2e0f02Sdan     nCol = pEList->nExpr;
15998c2e0f02Sdan     aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
16008c2e0f02Sdan     testcase( aCol==0 );
16018c2e0f02Sdan   }else{
16028c2e0f02Sdan     nCol = 0;
16038c2e0f02Sdan     aCol = 0;
16048c2e0f02Sdan   }
16058c2e0f02Sdan   *pnCol = nCol;
16068c2e0f02Sdan   *paCol = aCol;
16078c2e0f02Sdan 
16087d10d5a6Sdrh   for(i=0, pCol=aCol; i<nCol; i++, pCol++){
160979d5f63fSdrh     /* Get an appropriate name for the column
161079d5f63fSdrh     */
1611580c8c18Sdrh     p = sqlite3ExprSkipCollate(pEList->a[i].pExpr);
161291bb0eedSdrh     if( (zName = pEList->a[i].zName)!=0 ){
161379d5f63fSdrh       /* If the column contains an "AS <name>" phrase, use <name> as the name */
161417435752Sdrh       zName = sqlite3DbStrDup(db, zName);
16157d10d5a6Sdrh     }else{
1616dc5ea5c7Sdrh       Expr *pColExpr = p;  /* The expression that is the result column name */
1617dc5ea5c7Sdrh       Table *pTab;         /* Table associated with this expression */
1618b07028f7Sdrh       while( pColExpr->op==TK_DOT ){
1619b07028f7Sdrh         pColExpr = pColExpr->pRight;
1620b07028f7Sdrh         assert( pColExpr!=0 );
1621b07028f7Sdrh       }
1622373cc2ddSdrh       if( pColExpr->op==TK_COLUMN && ALWAYS(pColExpr->pTab!=0) ){
162393a960a0Sdrh         /* For columns use the column name name */
1624dc5ea5c7Sdrh         int iCol = pColExpr->iColumn;
1625373cc2ddSdrh         pTab = pColExpr->pTab;
1626f0209f74Sdrh         if( iCol<0 ) iCol = pTab->iPKey;
1627f0209f74Sdrh         zName = sqlite3MPrintf(db, "%s",
1628f0209f74Sdrh                  iCol>=0 ? pTab->aCol[iCol].zName : "rowid");
1629b7916a78Sdrh       }else if( pColExpr->op==TK_ID ){
163033e619fcSdrh         assert( !ExprHasProperty(pColExpr, EP_IntValue) );
163133e619fcSdrh         zName = sqlite3MPrintf(db, "%s", pColExpr->u.zToken);
163293a960a0Sdrh       }else{
163379d5f63fSdrh         /* Use the original text of the column expression as its name */
1634b7916a78Sdrh         zName = sqlite3MPrintf(db, "%s", pEList->a[i].zSpan);
16357d10d5a6Sdrh       }
163622f70c32Sdrh     }
16377ce72f69Sdrh     if( db->mallocFailed ){
1638633e6d57Sdrh       sqlite3DbFree(db, zName);
16397ce72f69Sdrh       break;
1640dd5b2fa5Sdrh     }
164179d5f63fSdrh 
164279d5f63fSdrh     /* Make sure the column name is unique.  If the name is not unique,
164360ec914cSpeter.d.reid     ** append an integer to the name so that it becomes unique.
164479d5f63fSdrh     */
1645ea678832Sdrh     nName = sqlite3Strlen30(zName);
164679d5f63fSdrh     for(j=cnt=0; j<i; j++){
164779d5f63fSdrh       if( sqlite3StrICmp(aCol[j].zName, zName)==0 ){
1648633e6d57Sdrh         char *zNewName;
1649fb777327Sdrh         int k;
1650fb777327Sdrh         for(k=nName-1; k>1 && sqlite3Isdigit(zName[k]); k--){}
165119c6d96aSdrh         if( k>=0 && zName[k]==':' ) nName = k;
16522564ef97Sdrh         zName[nName] = 0;
1653633e6d57Sdrh         zNewName = sqlite3MPrintf(db, "%s:%d", zName, ++cnt);
1654633e6d57Sdrh         sqlite3DbFree(db, zName);
1655633e6d57Sdrh         zName = zNewName;
165679d5f63fSdrh         j = -1;
1657dd5b2fa5Sdrh         if( zName==0 ) break;
165879d5f63fSdrh       }
165979d5f63fSdrh     }
166091bb0eedSdrh     pCol->zName = zName;
16617d10d5a6Sdrh   }
16627d10d5a6Sdrh   if( db->mallocFailed ){
16637d10d5a6Sdrh     for(j=0; j<i; j++){
16647d10d5a6Sdrh       sqlite3DbFree(db, aCol[j].zName);
16657d10d5a6Sdrh     }
16667d10d5a6Sdrh     sqlite3DbFree(db, aCol);
16677d10d5a6Sdrh     *paCol = 0;
16687d10d5a6Sdrh     *pnCol = 0;
16697d10d5a6Sdrh     return SQLITE_NOMEM;
16707d10d5a6Sdrh   }
16717d10d5a6Sdrh   return SQLITE_OK;
16727d10d5a6Sdrh }
1673e014a838Sdanielk1977 
16747d10d5a6Sdrh /*
16757d10d5a6Sdrh ** Add type and collation information to a column list based on
16767d10d5a6Sdrh ** a SELECT statement.
16777d10d5a6Sdrh **
16787d10d5a6Sdrh ** The column list presumably came from selectColumnNamesFromExprList().
16797d10d5a6Sdrh ** The column list has only names, not types or collations.  This
16807d10d5a6Sdrh ** routine goes through and adds the types and collations.
16817d10d5a6Sdrh **
1682b08a67a7Sshane ** This routine requires that all identifiers in the SELECT
16837d10d5a6Sdrh ** statement be resolved.
168479d5f63fSdrh */
16857d10d5a6Sdrh static void selectAddColumnTypeAndCollation(
16867d10d5a6Sdrh   Parse *pParse,        /* Parsing contexts */
1687186ad8ccSdrh   Table *pTab,          /* Add column type information to this table */
16887d10d5a6Sdrh   Select *pSelect       /* SELECT used to determine types and collations */
16897d10d5a6Sdrh ){
16907d10d5a6Sdrh   sqlite3 *db = pParse->db;
16917d10d5a6Sdrh   NameContext sNC;
16927d10d5a6Sdrh   Column *pCol;
16937d10d5a6Sdrh   CollSeq *pColl;
16947d10d5a6Sdrh   int i;
16957d10d5a6Sdrh   Expr *p;
16967d10d5a6Sdrh   struct ExprList_item *a;
1697186ad8ccSdrh   u64 szAll = 0;
16987d10d5a6Sdrh 
16997d10d5a6Sdrh   assert( pSelect!=0 );
17007d10d5a6Sdrh   assert( (pSelect->selFlags & SF_Resolved)!=0 );
1701186ad8ccSdrh   assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
17027d10d5a6Sdrh   if( db->mallocFailed ) return;
1703c43e8be8Sdrh   memset(&sNC, 0, sizeof(sNC));
1704b3bce662Sdanielk1977   sNC.pSrcList = pSelect->pSrc;
17057d10d5a6Sdrh   a = pSelect->pEList->a;
1706186ad8ccSdrh   for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
17077d10d5a6Sdrh     p = a[i].pExpr;
17085f3e5e74Sdrh     pCol->zType = sqlite3DbStrDup(db, columnType(&sNC, p,0,0,0, &pCol->szEst));
1709186ad8ccSdrh     szAll += pCol->szEst;
1710c60e9b82Sdanielk1977     pCol->affinity = sqlite3ExprAffinity(p);
1711c4a64facSdrh     if( pCol->affinity==0 ) pCol->affinity = SQLITE_AFF_NONE;
1712b3bf556eSdanielk1977     pColl = sqlite3ExprCollSeq(pParse, p);
1713b3bf556eSdanielk1977     if( pColl ){
171417435752Sdrh       pCol->zColl = sqlite3DbStrDup(db, pColl->zName);
17150202b29eSdanielk1977     }
171622f70c32Sdrh   }
1717186ad8ccSdrh   pTab->szTabRow = sqlite3LogEst(szAll*4);
17187d10d5a6Sdrh }
17197d10d5a6Sdrh 
17207d10d5a6Sdrh /*
17217d10d5a6Sdrh ** Given a SELECT statement, generate a Table structure that describes
17227d10d5a6Sdrh ** the result set of that SELECT.
17237d10d5a6Sdrh */
17247d10d5a6Sdrh Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect){
17257d10d5a6Sdrh   Table *pTab;
17267d10d5a6Sdrh   sqlite3 *db = pParse->db;
17277d10d5a6Sdrh   int savedFlags;
17287d10d5a6Sdrh 
17297d10d5a6Sdrh   savedFlags = db->flags;
17307d10d5a6Sdrh   db->flags &= ~SQLITE_FullColNames;
17317d10d5a6Sdrh   db->flags |= SQLITE_ShortColNames;
17327d10d5a6Sdrh   sqlite3SelectPrep(pParse, pSelect, 0);
17337d10d5a6Sdrh   if( pParse->nErr ) return 0;
17347d10d5a6Sdrh   while( pSelect->pPrior ) pSelect = pSelect->pPrior;
17357d10d5a6Sdrh   db->flags = savedFlags;
17367d10d5a6Sdrh   pTab = sqlite3DbMallocZero(db, sizeof(Table) );
17377d10d5a6Sdrh   if( pTab==0 ){
17387d10d5a6Sdrh     return 0;
17397d10d5a6Sdrh   }
1740373cc2ddSdrh   /* The sqlite3ResultSetOfSelect() is only used n contexts where lookaside
1741b2468954Sdrh   ** is disabled */
1742373cc2ddSdrh   assert( db->lookaside.bEnabled==0 );
17437d10d5a6Sdrh   pTab->nRef = 1;
17447d10d5a6Sdrh   pTab->zName = 0;
1745cfc9df76Sdan   pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
17467d10d5a6Sdrh   selectColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
1747186ad8ccSdrh   selectAddColumnTypeAndCollation(pParse, pTab, pSelect);
174822f70c32Sdrh   pTab->iPKey = -1;
17497ce72f69Sdrh   if( db->mallocFailed ){
17501feeaed2Sdan     sqlite3DeleteTable(db, pTab);
17517ce72f69Sdrh     return 0;
17527ce72f69Sdrh   }
175322f70c32Sdrh   return pTab;
175422f70c32Sdrh }
175522f70c32Sdrh 
175622f70c32Sdrh /*
1757d8bc7086Sdrh ** Get a VDBE for the given parser context.  Create a new one if necessary.
1758d8bc7086Sdrh ** If an error occurs, return NULL and leave a message in pParse.
1759d8bc7086Sdrh */
17604adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse *pParse){
1761d8bc7086Sdrh   Vdbe *v = pParse->pVdbe;
1762d8bc7086Sdrh   if( v==0 ){
17639ac7962aSdrh     v = pParse->pVdbe = sqlite3VdbeCreate(pParse);
1764aceb31b1Sdrh     if( v ) sqlite3VdbeAddOp0(v, OP_Init);
1765e0e261a4Sdrh     if( pParse->pToplevel==0
1766e0e261a4Sdrh      && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
1767e0e261a4Sdrh     ){
1768e0e261a4Sdrh       pParse->okConstFactor = 1;
1769e0e261a4Sdrh     }
1770e0e261a4Sdrh 
1771d8bc7086Sdrh   }
1772d8bc7086Sdrh   return v;
1773d8bc7086Sdrh }
1774d8bc7086Sdrh 
177515007a99Sdrh 
1776d8bc7086Sdrh /*
17777b58daeaSdrh ** Compute the iLimit and iOffset fields of the SELECT based on the
1778ec7429aeSdrh ** pLimit and pOffset expressions.  pLimit and pOffset hold the expressions
17797b58daeaSdrh ** that appear in the original SQL statement after the LIMIT and OFFSET
1780a2dc3b1aSdanielk1977 ** keywords.  Or NULL if those keywords are omitted. iLimit and iOffset
1781a2dc3b1aSdanielk1977 ** are the integer memory register numbers for counters used to compute
1782a2dc3b1aSdanielk1977 ** the limit and offset.  If there is no limit and/or offset, then
1783a2dc3b1aSdanielk1977 ** iLimit and iOffset are negative.
17847b58daeaSdrh **
1785d59ba6ceSdrh ** This routine changes the values of iLimit and iOffset only if
1786ec7429aeSdrh ** a limit or offset is defined by pLimit and pOffset.  iLimit and
1787aa9ce707Sdrh ** iOffset should have been preset to appropriate default values (zero)
1788aa9ce707Sdrh ** prior to calling this routine.
1789aa9ce707Sdrh **
1790aa9ce707Sdrh ** The iOffset register (if it exists) is initialized to the value
1791aa9ce707Sdrh ** of the OFFSET.  The iLimit register is initialized to LIMIT.  Register
1792aa9ce707Sdrh ** iOffset+1 is initialized to LIMIT+OFFSET.
1793aa9ce707Sdrh **
1794ec7429aeSdrh ** Only if pLimit!=0 or pOffset!=0 do the limit registers get
17957b58daeaSdrh ** redefined.  The UNION ALL operator uses this property to force
17967b58daeaSdrh ** the reuse of the same limit and offset registers across multiple
17977b58daeaSdrh ** SELECT statements.
17987b58daeaSdrh */
1799ec7429aeSdrh static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
180002afc861Sdrh   Vdbe *v = 0;
180102afc861Sdrh   int iLimit = 0;
180215007a99Sdrh   int iOffset;
18039b918ed1Sdrh   int addr1, n;
18040acb7e48Sdrh   if( p->iLimit ) return;
180515007a99Sdrh 
18067b58daeaSdrh   /*
18077b58daeaSdrh   ** "LIMIT -1" always shows all rows.  There is some
1808f7b5496eSdrh   ** controversy about what the correct behavior should be.
18097b58daeaSdrh   ** The current implementation interprets "LIMIT 0" to mean
18107b58daeaSdrh   ** no rows.
18117b58daeaSdrh   */
1812ceea3321Sdrh   sqlite3ExprCacheClear(pParse);
1813373cc2ddSdrh   assert( p->pOffset==0 || p->pLimit!=0 );
1814a2dc3b1aSdanielk1977   if( p->pLimit ){
18150a07c107Sdrh     p->iLimit = iLimit = ++pParse->nMem;
181615007a99Sdrh     v = sqlite3GetVdbe(pParse);
1817aa9ce707Sdrh     assert( v!=0 );
18189b918ed1Sdrh     if( sqlite3ExprIsInteger(p->pLimit, &n) ){
18199b918ed1Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
18209b918ed1Sdrh       VdbeComment((v, "LIMIT counter"));
1821456e4e4fSdrh       if( n==0 ){
1822456e4e4fSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, iBreak);
1823613ba1eaSdrh       }else if( n>=0 && p->nSelectRow>(u64)n ){
1824613ba1eaSdrh         p->nSelectRow = n;
18259b918ed1Sdrh       }
18269b918ed1Sdrh     }else{
1827b7654111Sdrh       sqlite3ExprCode(pParse, p->pLimit, iLimit);
1828688852abSdrh       sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
1829d4e70ebdSdrh       VdbeComment((v, "LIMIT counter"));
1830688852abSdrh       sqlite3VdbeAddOp2(v, OP_IfZero, iLimit, iBreak); VdbeCoverage(v);
18319b918ed1Sdrh     }
1832a2dc3b1aSdanielk1977     if( p->pOffset ){
18330a07c107Sdrh       p->iOffset = iOffset = ++pParse->nMem;
1834b7654111Sdrh       pParse->nMem++;   /* Allocate an extra register for limit+offset */
1835b7654111Sdrh       sqlite3ExprCode(pParse, p->pOffset, iOffset);
1836688852abSdrh       sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
1837d4e70ebdSdrh       VdbeComment((v, "OFFSET counter"));
1838688852abSdrh       addr1 = sqlite3VdbeAddOp1(v, OP_IfPos, iOffset); VdbeCoverage(v);
1839b7654111Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, iOffset);
184015007a99Sdrh       sqlite3VdbeJumpHere(v, addr1);
1841b7654111Sdrh       sqlite3VdbeAddOp3(v, OP_Add, iLimit, iOffset, iOffset+1);
1842d4e70ebdSdrh       VdbeComment((v, "LIMIT+OFFSET"));
1843688852abSdrh       addr1 = sqlite3VdbeAddOp1(v, OP_IfPos, iLimit); VdbeCoverage(v);
1844b7654111Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, -1, iOffset+1);
1845b7654111Sdrh       sqlite3VdbeJumpHere(v, addr1);
1846b7654111Sdrh     }
1847d59ba6ceSdrh   }
18487b58daeaSdrh }
18497b58daeaSdrh 
1850b7f9164eSdrh #ifndef SQLITE_OMIT_COMPOUND_SELECT
1851fbc4ee7bSdrh /*
1852fbc4ee7bSdrh ** Return the appropriate collating sequence for the iCol-th column of
1853fbc4ee7bSdrh ** the result set for the compound-select statement "p".  Return NULL if
1854fbc4ee7bSdrh ** the column has no default collating sequence.
1855fbc4ee7bSdrh **
1856fbc4ee7bSdrh ** The collating sequence for the compound select is taken from the
1857fbc4ee7bSdrh ** left-most term of the select that has a collating sequence.
1858fbc4ee7bSdrh */
1859dc1bdc4fSdanielk1977 static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
1860fbc4ee7bSdrh   CollSeq *pRet;
1861dc1bdc4fSdanielk1977   if( p->pPrior ){
1862dc1bdc4fSdanielk1977     pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
1863fbc4ee7bSdrh   }else{
1864fbc4ee7bSdrh     pRet = 0;
1865dc1bdc4fSdanielk1977   }
186610c081adSdrh   assert( iCol>=0 );
186710c081adSdrh   if( pRet==0 && iCol<p->pEList->nExpr ){
1868dc1bdc4fSdanielk1977     pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
1869dc1bdc4fSdanielk1977   }
1870dc1bdc4fSdanielk1977   return pRet;
1871d3d39e93Sdrh }
187253bed45eSdan 
187353bed45eSdan /*
187453bed45eSdan ** The select statement passed as the second parameter is a compound SELECT
187553bed45eSdan ** with an ORDER BY clause. This function allocates and returns a KeyInfo
187653bed45eSdan ** structure suitable for implementing the ORDER BY.
187753bed45eSdan **
187853bed45eSdan ** Space to hold the KeyInfo structure is obtained from malloc. The calling
187953bed45eSdan ** function is responsible for ensuring that this structure is eventually
188053bed45eSdan ** freed.
188153bed45eSdan */
188253bed45eSdan static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
188353bed45eSdan   ExprList *pOrderBy = p->pOrderBy;
188453bed45eSdan   int nOrderBy = p->pOrderBy->nExpr;
188553bed45eSdan   sqlite3 *db = pParse->db;
188653bed45eSdan   KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
188753bed45eSdan   if( pRet ){
188853bed45eSdan     int i;
188953bed45eSdan     for(i=0; i<nOrderBy; i++){
189053bed45eSdan       struct ExprList_item *pItem = &pOrderBy->a[i];
189153bed45eSdan       Expr *pTerm = pItem->pExpr;
189253bed45eSdan       CollSeq *pColl;
189353bed45eSdan 
189453bed45eSdan       if( pTerm->flags & EP_Collate ){
189553bed45eSdan         pColl = sqlite3ExprCollSeq(pParse, pTerm);
189653bed45eSdan       }else{
189753bed45eSdan         pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
189853bed45eSdan         if( pColl==0 ) pColl = db->pDfltColl;
189953bed45eSdan         pOrderBy->a[i].pExpr =
190053bed45eSdan           sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
190153bed45eSdan       }
190253bed45eSdan       assert( sqlite3KeyInfoIsWriteable(pRet) );
190353bed45eSdan       pRet->aColl[i] = pColl;
190453bed45eSdan       pRet->aSortOrder[i] = pOrderBy->a[i].sortOrder;
190553bed45eSdan     }
190653bed45eSdan   }
190753bed45eSdan 
190853bed45eSdan   return pRet;
190953bed45eSdan }
1910d3d39e93Sdrh 
1911781def29Sdrh #ifndef SQLITE_OMIT_CTE
1912781def29Sdrh /*
1913781def29Sdrh ** This routine generates VDBE code to compute the content of a WITH RECURSIVE
1914781def29Sdrh ** query of the form:
1915781def29Sdrh **
1916781def29Sdrh **   <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
1917781def29Sdrh **                         \___________/             \_______________/
1918781def29Sdrh **                           p->pPrior                      p
1919781def29Sdrh **
1920781def29Sdrh **
1921781def29Sdrh ** There is exactly one reference to the recursive-table in the FROM clause
1922781def29Sdrh ** of recursive-query, marked with the SrcList->a[].isRecursive flag.
1923781def29Sdrh **
1924781def29Sdrh ** The setup-query runs once to generate an initial set of rows that go
1925781def29Sdrh ** into a Queue table.  Rows are extracted from the Queue table one by
1926fe1c6bb9Sdrh ** one.  Each row extracted from Queue is output to pDest.  Then the single
1927fe1c6bb9Sdrh ** extracted row (now in the iCurrent table) becomes the content of the
1928fe1c6bb9Sdrh ** recursive-table for a recursive-query run.  The output of the recursive-query
1929781def29Sdrh ** is added back into the Queue table.  Then another row is extracted from Queue
1930781def29Sdrh ** and the iteration continues until the Queue table is empty.
1931781def29Sdrh **
1932781def29Sdrh ** If the compound query operator is UNION then no duplicate rows are ever
1933781def29Sdrh ** inserted into the Queue table.  The iDistinct table keeps a copy of all rows
1934781def29Sdrh ** that have ever been inserted into Queue and causes duplicates to be
1935781def29Sdrh ** discarded.  If the operator is UNION ALL, then duplicates are allowed.
1936781def29Sdrh **
1937781def29Sdrh ** If the query has an ORDER BY, then entries in the Queue table are kept in
1938781def29Sdrh ** ORDER BY order and the first entry is extracted for each cycle.  Without
1939781def29Sdrh ** an ORDER BY, the Queue table is just a FIFO.
1940781def29Sdrh **
1941781def29Sdrh ** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
1942781def29Sdrh ** have been output to pDest.  A LIMIT of zero means to output no rows and a
1943781def29Sdrh ** negative LIMIT means to output all rows.  If there is also an OFFSET clause
1944781def29Sdrh ** with a positive value, then the first OFFSET outputs are discarded rather
1945781def29Sdrh ** than being sent to pDest.  The LIMIT count does not begin until after OFFSET
1946781def29Sdrh ** rows have been skipped.
1947781def29Sdrh */
1948781def29Sdrh static void generateWithRecursiveQuery(
1949781def29Sdrh   Parse *pParse,        /* Parsing context */
1950781def29Sdrh   Select *p,            /* The recursive SELECT to be coded */
1951781def29Sdrh   SelectDest *pDest     /* What to do with query results */
1952781def29Sdrh ){
1953781def29Sdrh   SrcList *pSrc = p->pSrc;      /* The FROM clause of the recursive query */
1954781def29Sdrh   int nCol = p->pEList->nExpr;  /* Number of columns in the recursive table */
1955781def29Sdrh   Vdbe *v = pParse->pVdbe;      /* The prepared statement under construction */
1956781def29Sdrh   Select *pSetup = p->pPrior;   /* The setup query */
1957781def29Sdrh   int addrTop;                  /* Top of the loop */
1958781def29Sdrh   int addrCont, addrBreak;      /* CONTINUE and BREAK addresses */
1959edf83d1eSdrh   int iCurrent = 0;             /* The Current table */
1960781def29Sdrh   int regCurrent;               /* Register holding Current table */
1961781def29Sdrh   int iQueue;                   /* The Queue table */
1962781def29Sdrh   int iDistinct = 0;            /* To ensure unique results if UNION */
19638e1ee88cSdrh   int eDest = SRT_Fifo;         /* How to write to Queue */
1964781def29Sdrh   SelectDest destQueue;         /* SelectDest targetting the Queue table */
1965781def29Sdrh   int i;                        /* Loop counter */
1966781def29Sdrh   int rc;                       /* Result code */
1967fe1c6bb9Sdrh   ExprList *pOrderBy;           /* The ORDER BY clause */
1968aa9ce707Sdrh   Expr *pLimit, *pOffset;       /* Saved LIMIT and OFFSET */
1969aa9ce707Sdrh   int regLimit, regOffset;      /* Registers used by LIMIT and OFFSET */
1970781def29Sdrh 
1971781def29Sdrh   /* Obtain authorization to do a recursive query */
1972781def29Sdrh   if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
1973781def29Sdrh 
1974aa9ce707Sdrh   /* Process the LIMIT and OFFSET clauses, if they exist */
1975aa9ce707Sdrh   addrBreak = sqlite3VdbeMakeLabel(v);
1976aa9ce707Sdrh   computeLimitRegisters(pParse, p, addrBreak);
1977aa9ce707Sdrh   pLimit = p->pLimit;
1978aa9ce707Sdrh   pOffset = p->pOffset;
1979aa9ce707Sdrh   regLimit = p->iLimit;
1980aa9ce707Sdrh   regOffset = p->iOffset;
1981aa9ce707Sdrh   p->pLimit = p->pOffset = 0;
1982aa9ce707Sdrh   p->iLimit = p->iOffset = 0;
198353bed45eSdan   pOrderBy = p->pOrderBy;
1984781def29Sdrh 
1985781def29Sdrh   /* Locate the cursor number of the Current table */
1986781def29Sdrh   for(i=0; ALWAYS(i<pSrc->nSrc); i++){
1987781def29Sdrh     if( pSrc->a[i].isRecursive ){
1988781def29Sdrh       iCurrent = pSrc->a[i].iCursor;
1989781def29Sdrh       break;
1990781def29Sdrh     }
1991781def29Sdrh   }
1992781def29Sdrh 
1993fe1c6bb9Sdrh   /* Allocate cursors numbers for Queue and Distinct.  The cursor number for
1994781def29Sdrh   ** the Distinct table must be exactly one greater than Queue in order
19958e1ee88cSdrh   ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
1996781def29Sdrh   iQueue = pParse->nTab++;
1997781def29Sdrh   if( p->op==TK_UNION ){
19988e1ee88cSdrh     eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
1999781def29Sdrh     iDistinct = pParse->nTab++;
2000fe1c6bb9Sdrh   }else{
20018e1ee88cSdrh     eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
2002781def29Sdrh   }
2003781def29Sdrh   sqlite3SelectDestInit(&destQueue, eDest, iQueue);
2004781def29Sdrh 
2005781def29Sdrh   /* Allocate cursors for Current, Queue, and Distinct. */
2006781def29Sdrh   regCurrent = ++pParse->nMem;
2007781def29Sdrh   sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
2008fe1c6bb9Sdrh   if( pOrderBy ){
200953bed45eSdan     KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
2010fe1c6bb9Sdrh     sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
2011fe1c6bb9Sdrh                       (char*)pKeyInfo, P4_KEYINFO);
2012fe1c6bb9Sdrh     destQueue.pOrderBy = pOrderBy;
2013fe1c6bb9Sdrh   }else{
2014781def29Sdrh     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
2015fe1c6bb9Sdrh   }
2016fe1c6bb9Sdrh   VdbeComment((v, "Queue table"));
2017781def29Sdrh   if( iDistinct ){
2018781def29Sdrh     p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
2019781def29Sdrh     p->selFlags |= SF_UsesEphemeral;
2020781def29Sdrh   }
2021781def29Sdrh 
202253bed45eSdan   /* Detach the ORDER BY clause from the compound SELECT */
202353bed45eSdan   p->pOrderBy = 0;
202453bed45eSdan 
2025781def29Sdrh   /* Store the results of the setup-query in Queue. */
2026d227a291Sdrh   pSetup->pNext = 0;
2027781def29Sdrh   rc = sqlite3Select(pParse, pSetup, &destQueue);
2028d227a291Sdrh   pSetup->pNext = p;
2029fe1c6bb9Sdrh   if( rc ) goto end_of_recursive_query;
2030781def29Sdrh 
2031781def29Sdrh   /* Find the next row in the Queue and output that row */
2032688852abSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
2033781def29Sdrh 
2034781def29Sdrh   /* Transfer the next row in Queue over to Current */
2035781def29Sdrh   sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
2036fe1c6bb9Sdrh   if( pOrderBy ){
2037fe1c6bb9Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
2038fe1c6bb9Sdrh   }else{
2039781def29Sdrh     sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
2040fe1c6bb9Sdrh   }
2041781def29Sdrh   sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
2042781def29Sdrh 
2043fe1c6bb9Sdrh   /* Output the single row in Current */
2044fe1c6bb9Sdrh   addrCont = sqlite3VdbeMakeLabel(v);
2045aa9ce707Sdrh   codeOffset(v, regOffset, addrCont);
2046fe1c6bb9Sdrh   selectInnerLoop(pParse, p, p->pEList, iCurrent,
2047079a3072Sdrh       0, 0, pDest, addrCont, addrBreak);
2048688852abSdrh   if( regLimit ){
2049688852abSdrh     sqlite3VdbeAddOp3(v, OP_IfZero, regLimit, addrBreak, -1);
2050688852abSdrh     VdbeCoverage(v);
2051688852abSdrh   }
2052fe1c6bb9Sdrh   sqlite3VdbeResolveLabel(v, addrCont);
2053fe1c6bb9Sdrh 
2054781def29Sdrh   /* Execute the recursive SELECT taking the single row in Current as
2055781def29Sdrh   ** the value for the recursive-table. Store the results in the Queue.
2056781def29Sdrh   */
2057781def29Sdrh   p->pPrior = 0;
2058781def29Sdrh   sqlite3Select(pParse, p, &destQueue);
2059781def29Sdrh   assert( p->pPrior==0 );
2060781def29Sdrh   p->pPrior = pSetup;
2061781def29Sdrh 
2062781def29Sdrh   /* Keep running the loop until the Queue is empty */
2063781def29Sdrh   sqlite3VdbeAddOp2(v, OP_Goto, 0, addrTop);
2064781def29Sdrh   sqlite3VdbeResolveLabel(v, addrBreak);
2065fe1c6bb9Sdrh 
2066fe1c6bb9Sdrh end_of_recursive_query:
20679afccba2Sdan   sqlite3ExprListDelete(pParse->db, p->pOrderBy);
2068fe1c6bb9Sdrh   p->pOrderBy = pOrderBy;
2069aa9ce707Sdrh   p->pLimit = pLimit;
2070aa9ce707Sdrh   p->pOffset = pOffset;
2071fe1c6bb9Sdrh   return;
2072781def29Sdrh }
2073b68b9778Sdan #endif /* SQLITE_OMIT_CTE */
2074781def29Sdrh 
2075781def29Sdrh /* Forward references */
2076b21e7c70Sdrh static int multiSelectOrderBy(
2077b21e7c70Sdrh   Parse *pParse,        /* Parsing context */
2078b21e7c70Sdrh   Select *p,            /* The right-most of SELECTs to be coded */
2079a9671a22Sdrh   SelectDest *pDest     /* What to do with query results */
2080b21e7c70Sdrh );
2081b21e7c70Sdrh 
2082b21e7c70Sdrh 
2083d3d39e93Sdrh /*
208416ee60ffSdrh ** This routine is called to process a compound query form from
208516ee60ffSdrh ** two or more separate queries using UNION, UNION ALL, EXCEPT, or
208616ee60ffSdrh ** INTERSECT
2087c926afbcSdrh **
2088e78e8284Sdrh ** "p" points to the right-most of the two queries.  the query on the
2089e78e8284Sdrh ** left is p->pPrior.  The left query could also be a compound query
2090e78e8284Sdrh ** in which case this routine will be called recursively.
2091e78e8284Sdrh **
2092e78e8284Sdrh ** The results of the total query are to be written into a destination
2093e78e8284Sdrh ** of type eDest with parameter iParm.
2094e78e8284Sdrh **
2095e78e8284Sdrh ** Example 1:  Consider a three-way compound SQL statement.
2096e78e8284Sdrh **
2097e78e8284Sdrh **     SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
2098e78e8284Sdrh **
2099e78e8284Sdrh ** This statement is parsed up as follows:
2100e78e8284Sdrh **
2101e78e8284Sdrh **     SELECT c FROM t3
2102e78e8284Sdrh **      |
2103e78e8284Sdrh **      `----->  SELECT b FROM t2
2104e78e8284Sdrh **                |
21054b11c6d3Sjplyon **                `------>  SELECT a FROM t1
2106e78e8284Sdrh **
2107e78e8284Sdrh ** The arrows in the diagram above represent the Select.pPrior pointer.
2108e78e8284Sdrh ** So if this routine is called with p equal to the t3 query, then
2109e78e8284Sdrh ** pPrior will be the t2 query.  p->op will be TK_UNION in this case.
2110e78e8284Sdrh **
2111e78e8284Sdrh ** Notice that because of the way SQLite parses compound SELECTs, the
2112e78e8284Sdrh ** individual selects always group from left to right.
211382c3d636Sdrh */
211484ac9d02Sdanielk1977 static int multiSelect(
2115fbc4ee7bSdrh   Parse *pParse,        /* Parsing context */
2116fbc4ee7bSdrh   Select *p,            /* The right-most of SELECTs to be coded */
2117a9671a22Sdrh   SelectDest *pDest     /* What to do with query results */
211884ac9d02Sdanielk1977 ){
211984ac9d02Sdanielk1977   int rc = SQLITE_OK;   /* Success code from a subroutine */
212010e5e3cfSdrh   Select *pPrior;       /* Another SELECT immediately to our left */
212110e5e3cfSdrh   Vdbe *v;              /* Generate code to this VDBE */
21221013c932Sdrh   SelectDest dest;      /* Alternative data destination */
2123eca7e01aSdanielk1977   Select *pDelete = 0;  /* Chain of simple selects to delete */
2124633e6d57Sdrh   sqlite3 *db;          /* Database connection */
21257f61e92cSdan #ifndef SQLITE_OMIT_EXPLAIN
2126edf83d1eSdrh   int iSub1 = 0;        /* EQP id of left-hand query */
2127edf83d1eSdrh   int iSub2 = 0;        /* EQP id of right-hand query */
21287f61e92cSdan #endif
212982c3d636Sdrh 
21307b58daeaSdrh   /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs.  Only
2131fbc4ee7bSdrh   ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
213282c3d636Sdrh   */
2133701bb3b4Sdrh   assert( p && p->pPrior );  /* Calling function guarantees this much */
2134eae73fbfSdan   assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
2135633e6d57Sdrh   db = pParse->db;
2136d8bc7086Sdrh   pPrior = p->pPrior;
2137bc10377aSdrh   dest = *pDest;
2138d8bc7086Sdrh   if( pPrior->pOrderBy ){
21394adee20fSdanielk1977     sqlite3ErrorMsg(pParse,"ORDER BY clause should come after %s not before",
2140da93d238Sdrh       selectOpName(p->op));
214184ac9d02Sdanielk1977     rc = 1;
214284ac9d02Sdanielk1977     goto multi_select_end;
214382c3d636Sdrh   }
2144a2dc3b1aSdanielk1977   if( pPrior->pLimit ){
21454adee20fSdanielk1977     sqlite3ErrorMsg(pParse,"LIMIT clause should come after %s not before",
21467b58daeaSdrh       selectOpName(p->op));
214784ac9d02Sdanielk1977     rc = 1;
214884ac9d02Sdanielk1977     goto multi_select_end;
21497b58daeaSdrh   }
215082c3d636Sdrh 
21514adee20fSdanielk1977   v = sqlite3GetVdbe(pParse);
2152701bb3b4Sdrh   assert( v!=0 );  /* The VDBE already created by calling function */
2153d8bc7086Sdrh 
21541cc3d75fSdrh   /* Create the destination temporary table if necessary
21551cc3d75fSdrh   */
21566c8c8ce0Sdanielk1977   if( dest.eDest==SRT_EphemTab ){
2157b4964b72Sdanielk1977     assert( p->pEList );
21582b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
2159d4187c71Sdrh     sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
21606c8c8ce0Sdanielk1977     dest.eDest = SRT_Table;
21611cc3d75fSdrh   }
21621cc3d75fSdrh 
2163f6e369a1Sdrh   /* Make sure all SELECTs in the statement have the same number of elements
2164f6e369a1Sdrh   ** in their result sets.
2165f6e369a1Sdrh   */
2166f6e369a1Sdrh   assert( p->pEList && pPrior->pEList );
2167f6e369a1Sdrh   if( p->pEList->nExpr!=pPrior->pEList->nExpr ){
21687b113babSdrh     if( p->selFlags & SF_Values ){
21697b113babSdrh       sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
21707b113babSdrh     }else{
2171f6e369a1Sdrh       sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
2172f6e369a1Sdrh         " do not have the same number of result columns", selectOpName(p->op));
21737b113babSdrh     }
2174f6e369a1Sdrh     rc = 1;
2175f6e369a1Sdrh     goto multi_select_end;
2176f6e369a1Sdrh   }
2177f6e369a1Sdrh 
2178eede6a53Sdan #ifndef SQLITE_OMIT_CTE
2179eae73fbfSdan   if( p->selFlags & SF_Recursive ){
2180781def29Sdrh     generateWithRecursiveQuery(pParse, p, &dest);
21818ce7184bSdan   }else
21828ce7184bSdan #endif
21838ce7184bSdan 
2184a9671a22Sdrh   /* Compound SELECTs that have an ORDER BY clause are handled separately.
2185a9671a22Sdrh   */
2186f6e369a1Sdrh   if( p->pOrderBy ){
2187a9671a22Sdrh     return multiSelectOrderBy(pParse, p, pDest);
2188eede6a53Sdan   }else
2189f6e369a1Sdrh 
2190f46f905aSdrh   /* Generate code for the left and right SELECT statements.
2191d8bc7086Sdrh   */
219282c3d636Sdrh   switch( p->op ){
2193f46f905aSdrh     case TK_ALL: {
2194ec7429aeSdrh       int addr = 0;
219595aa47b1Sdrh       int nLimit;
2196a2dc3b1aSdanielk1977       assert( !pPrior->pLimit );
2197547180baSdrh       pPrior->iLimit = p->iLimit;
2198547180baSdrh       pPrior->iOffset = p->iOffset;
2199a2dc3b1aSdanielk1977       pPrior->pLimit = p->pLimit;
2200a2dc3b1aSdanielk1977       pPrior->pOffset = p->pOffset;
22017f61e92cSdan       explainSetInteger(iSub1, pParse->iNextSelectId);
22027d10d5a6Sdrh       rc = sqlite3Select(pParse, pPrior, &dest);
2203ad68cb6bSdanielk1977       p->pLimit = 0;
2204ad68cb6bSdanielk1977       p->pOffset = 0;
220584ac9d02Sdanielk1977       if( rc ){
220684ac9d02Sdanielk1977         goto multi_select_end;
220784ac9d02Sdanielk1977       }
2208f46f905aSdrh       p->pPrior = 0;
22097b58daeaSdrh       p->iLimit = pPrior->iLimit;
22107b58daeaSdrh       p->iOffset = pPrior->iOffset;
221192b01d53Sdrh       if( p->iLimit ){
2212688852abSdrh         addr = sqlite3VdbeAddOp1(v, OP_IfZero, p->iLimit); VdbeCoverage(v);
2213d4e70ebdSdrh         VdbeComment((v, "Jump ahead if LIMIT reached"));
2214ec7429aeSdrh       }
22157f61e92cSdan       explainSetInteger(iSub2, pParse->iNextSelectId);
22167d10d5a6Sdrh       rc = sqlite3Select(pParse, p, &dest);
2217373cc2ddSdrh       testcase( rc!=SQLITE_OK );
2218eca7e01aSdanielk1977       pDelete = p->pPrior;
2219f46f905aSdrh       p->pPrior = pPrior;
222095aa47b1Sdrh       p->nSelectRow += pPrior->nSelectRow;
222195aa47b1Sdrh       if( pPrior->pLimit
222295aa47b1Sdrh        && sqlite3ExprIsInteger(pPrior->pLimit, &nLimit)
2223613ba1eaSdrh        && nLimit>0 && p->nSelectRow > (u64)nLimit
222495aa47b1Sdrh       ){
2225c63367efSdrh         p->nSelectRow = nLimit;
222695aa47b1Sdrh       }
2227ec7429aeSdrh       if( addr ){
2228ec7429aeSdrh         sqlite3VdbeJumpHere(v, addr);
2229ec7429aeSdrh       }
2230f46f905aSdrh       break;
2231f46f905aSdrh     }
223282c3d636Sdrh     case TK_EXCEPT:
223382c3d636Sdrh     case TK_UNION: {
2234d8bc7086Sdrh       int unionTab;    /* Cursor number of the temporary table holding result */
2235ea678832Sdrh       u8 op = 0;       /* One of the SRT_ operations to apply to self */
2236d8bc7086Sdrh       int priorOp;     /* The SRT_ operation to apply to prior selects */
2237a2dc3b1aSdanielk1977       Expr *pLimit, *pOffset; /* Saved values of p->nLimit and p->nOffset */
2238dc1bdc4fSdanielk1977       int addr;
22396c8c8ce0Sdanielk1977       SelectDest uniondest;
224082c3d636Sdrh 
2241373cc2ddSdrh       testcase( p->op==TK_EXCEPT );
2242373cc2ddSdrh       testcase( p->op==TK_UNION );
224393a960a0Sdrh       priorOp = SRT_Union;
2244d227a291Sdrh       if( dest.eDest==priorOp ){
2245d8bc7086Sdrh         /* We can reuse a temporary table generated by a SELECT to our
2246c926afbcSdrh         ** right.
2247d8bc7086Sdrh         */
2248e2f02bacSdrh         assert( p->pLimit==0 );      /* Not allowed on leftward elements */
2249e2f02bacSdrh         assert( p->pOffset==0 );     /* Not allowed on leftward elements */
22502b596da8Sdrh         unionTab = dest.iSDParm;
225182c3d636Sdrh       }else{
2252d8bc7086Sdrh         /* We will need to create our own temporary table to hold the
2253d8bc7086Sdrh         ** intermediate results.
2254d8bc7086Sdrh         */
225582c3d636Sdrh         unionTab = pParse->nTab++;
225693a960a0Sdrh         assert( p->pOrderBy==0 );
225766a5167bSdrh         addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
2258b9bb7c18Sdrh         assert( p->addrOpenEphm[0] == -1 );
2259b9bb7c18Sdrh         p->addrOpenEphm[0] = addr;
2260d227a291Sdrh         findRightmost(p)->selFlags |= SF_UsesEphemeral;
226184ac9d02Sdanielk1977         assert( p->pEList );
2262d8bc7086Sdrh       }
2263d8bc7086Sdrh 
2264d8bc7086Sdrh       /* Code the SELECT statements to our left
2265d8bc7086Sdrh       */
2266b3bce662Sdanielk1977       assert( !pPrior->pOrderBy );
22671013c932Sdrh       sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
22687f61e92cSdan       explainSetInteger(iSub1, pParse->iNextSelectId);
22697d10d5a6Sdrh       rc = sqlite3Select(pParse, pPrior, &uniondest);
227084ac9d02Sdanielk1977       if( rc ){
227184ac9d02Sdanielk1977         goto multi_select_end;
227284ac9d02Sdanielk1977       }
2273d8bc7086Sdrh 
2274d8bc7086Sdrh       /* Code the current SELECT statement
2275d8bc7086Sdrh       */
22764cfb22f7Sdrh       if( p->op==TK_EXCEPT ){
22774cfb22f7Sdrh         op = SRT_Except;
22784cfb22f7Sdrh       }else{
22794cfb22f7Sdrh         assert( p->op==TK_UNION );
22804cfb22f7Sdrh         op = SRT_Union;
2281d8bc7086Sdrh       }
228282c3d636Sdrh       p->pPrior = 0;
2283a2dc3b1aSdanielk1977       pLimit = p->pLimit;
2284a2dc3b1aSdanielk1977       p->pLimit = 0;
2285a2dc3b1aSdanielk1977       pOffset = p->pOffset;
2286a2dc3b1aSdanielk1977       p->pOffset = 0;
22876c8c8ce0Sdanielk1977       uniondest.eDest = op;
22887f61e92cSdan       explainSetInteger(iSub2, pParse->iNextSelectId);
22897d10d5a6Sdrh       rc = sqlite3Select(pParse, p, &uniondest);
2290373cc2ddSdrh       testcase( rc!=SQLITE_OK );
22915bd1bf2eSdrh       /* Query flattening in sqlite3Select() might refill p->pOrderBy.
22925bd1bf2eSdrh       ** Be sure to delete p->pOrderBy, therefore, to avoid a memory leak. */
2293633e6d57Sdrh       sqlite3ExprListDelete(db, p->pOrderBy);
2294eca7e01aSdanielk1977       pDelete = p->pPrior;
229582c3d636Sdrh       p->pPrior = pPrior;
2296a9671a22Sdrh       p->pOrderBy = 0;
229795aa47b1Sdrh       if( p->op==TK_UNION ) p->nSelectRow += pPrior->nSelectRow;
2298633e6d57Sdrh       sqlite3ExprDelete(db, p->pLimit);
2299a2dc3b1aSdanielk1977       p->pLimit = pLimit;
2300a2dc3b1aSdanielk1977       p->pOffset = pOffset;
230192b01d53Sdrh       p->iLimit = 0;
230292b01d53Sdrh       p->iOffset = 0;
2303d8bc7086Sdrh 
2304d8bc7086Sdrh       /* Convert the data in the temporary table into whatever form
2305d8bc7086Sdrh       ** it is that we currently need.
2306d8bc7086Sdrh       */
23072b596da8Sdrh       assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
2308373cc2ddSdrh       if( dest.eDest!=priorOp ){
23096b56344dSdrh         int iCont, iBreak, iStart;
231082c3d636Sdrh         assert( p->pEList );
23117d10d5a6Sdrh         if( dest.eDest==SRT_Output ){
231292378253Sdrh           Select *pFirst = p;
231392378253Sdrh           while( pFirst->pPrior ) pFirst = pFirst->pPrior;
231492378253Sdrh           generateColumnNames(pParse, 0, pFirst->pEList);
231541202ccaSdrh         }
23164adee20fSdanielk1977         iBreak = sqlite3VdbeMakeLabel(v);
23174adee20fSdanielk1977         iCont = sqlite3VdbeMakeLabel(v);
2318ec7429aeSdrh         computeLimitRegisters(pParse, p, iBreak);
2319688852abSdrh         sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
23204adee20fSdanielk1977         iStart = sqlite3VdbeCurrentAddr(v);
2321340309fdSdrh         selectInnerLoop(pParse, p, p->pEList, unionTab,
2322079a3072Sdrh                         0, 0, &dest, iCont, iBreak);
23234adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, iCont);
2324688852abSdrh         sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
23254adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, iBreak);
232666a5167bSdrh         sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
232782c3d636Sdrh       }
232882c3d636Sdrh       break;
232982c3d636Sdrh     }
2330373cc2ddSdrh     default: assert( p->op==TK_INTERSECT ); {
233182c3d636Sdrh       int tab1, tab2;
23326b56344dSdrh       int iCont, iBreak, iStart;
2333a2dc3b1aSdanielk1977       Expr *pLimit, *pOffset;
2334dc1bdc4fSdanielk1977       int addr;
23351013c932Sdrh       SelectDest intersectdest;
23369cbf3425Sdrh       int r1;
233782c3d636Sdrh 
2338d8bc7086Sdrh       /* INTERSECT is different from the others since it requires
23396206d50aSdrh       ** two temporary tables.  Hence it has its own case.  Begin
2340d8bc7086Sdrh       ** by allocating the tables we will need.
2341d8bc7086Sdrh       */
234282c3d636Sdrh       tab1 = pParse->nTab++;
234382c3d636Sdrh       tab2 = pParse->nTab++;
234493a960a0Sdrh       assert( p->pOrderBy==0 );
2345dc1bdc4fSdanielk1977 
234666a5167bSdrh       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
2347b9bb7c18Sdrh       assert( p->addrOpenEphm[0] == -1 );
2348b9bb7c18Sdrh       p->addrOpenEphm[0] = addr;
2349d227a291Sdrh       findRightmost(p)->selFlags |= SF_UsesEphemeral;
235084ac9d02Sdanielk1977       assert( p->pEList );
2351d8bc7086Sdrh 
2352d8bc7086Sdrh       /* Code the SELECTs to our left into temporary table "tab1".
2353d8bc7086Sdrh       */
23541013c932Sdrh       sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
23557f61e92cSdan       explainSetInteger(iSub1, pParse->iNextSelectId);
23567d10d5a6Sdrh       rc = sqlite3Select(pParse, pPrior, &intersectdest);
235784ac9d02Sdanielk1977       if( rc ){
235884ac9d02Sdanielk1977         goto multi_select_end;
235984ac9d02Sdanielk1977       }
2360d8bc7086Sdrh 
2361d8bc7086Sdrh       /* Code the current SELECT into temporary table "tab2"
2362d8bc7086Sdrh       */
236366a5167bSdrh       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
2364b9bb7c18Sdrh       assert( p->addrOpenEphm[1] == -1 );
2365b9bb7c18Sdrh       p->addrOpenEphm[1] = addr;
236682c3d636Sdrh       p->pPrior = 0;
2367a2dc3b1aSdanielk1977       pLimit = p->pLimit;
2368a2dc3b1aSdanielk1977       p->pLimit = 0;
2369a2dc3b1aSdanielk1977       pOffset = p->pOffset;
2370a2dc3b1aSdanielk1977       p->pOffset = 0;
23712b596da8Sdrh       intersectdest.iSDParm = tab2;
23727f61e92cSdan       explainSetInteger(iSub2, pParse->iNextSelectId);
23737d10d5a6Sdrh       rc = sqlite3Select(pParse, p, &intersectdest);
2374373cc2ddSdrh       testcase( rc!=SQLITE_OK );
2375eca7e01aSdanielk1977       pDelete = p->pPrior;
237682c3d636Sdrh       p->pPrior = pPrior;
237795aa47b1Sdrh       if( p->nSelectRow>pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
2378633e6d57Sdrh       sqlite3ExprDelete(db, p->pLimit);
2379a2dc3b1aSdanielk1977       p->pLimit = pLimit;
2380a2dc3b1aSdanielk1977       p->pOffset = pOffset;
2381d8bc7086Sdrh 
2382d8bc7086Sdrh       /* Generate code to take the intersection of the two temporary
2383d8bc7086Sdrh       ** tables.
2384d8bc7086Sdrh       */
238582c3d636Sdrh       assert( p->pEList );
23867d10d5a6Sdrh       if( dest.eDest==SRT_Output ){
238792378253Sdrh         Select *pFirst = p;
238892378253Sdrh         while( pFirst->pPrior ) pFirst = pFirst->pPrior;
238992378253Sdrh         generateColumnNames(pParse, 0, pFirst->pEList);
239041202ccaSdrh       }
23914adee20fSdanielk1977       iBreak = sqlite3VdbeMakeLabel(v);
23924adee20fSdanielk1977       iCont = sqlite3VdbeMakeLabel(v);
2393ec7429aeSdrh       computeLimitRegisters(pParse, p, iBreak);
2394688852abSdrh       sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
23959cbf3425Sdrh       r1 = sqlite3GetTempReg(pParse);
23969cbf3425Sdrh       iStart = sqlite3VdbeAddOp2(v, OP_RowKey, tab1, r1);
2397688852abSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0); VdbeCoverage(v);
23989cbf3425Sdrh       sqlite3ReleaseTempReg(pParse, r1);
2399340309fdSdrh       selectInnerLoop(pParse, p, p->pEList, tab1,
2400079a3072Sdrh                       0, 0, &dest, iCont, iBreak);
24014adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, iCont);
2402688852abSdrh       sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
24034adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, iBreak);
240466a5167bSdrh       sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
240566a5167bSdrh       sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
240682c3d636Sdrh       break;
240782c3d636Sdrh     }
240882c3d636Sdrh   }
24098cdbf836Sdrh 
24107f61e92cSdan   explainComposite(pParse, p->op, iSub1, iSub2, p->op!=TK_ALL);
24117f61e92cSdan 
2412a9671a22Sdrh   /* Compute collating sequences used by
2413a9671a22Sdrh   ** temporary tables needed to implement the compound select.
2414a9671a22Sdrh   ** Attach the KeyInfo structure to all temporary tables.
24158cdbf836Sdrh   **
24168cdbf836Sdrh   ** This section is run by the right-most SELECT statement only.
24178cdbf836Sdrh   ** SELECT statements to the left always skip this part.  The right-most
24188cdbf836Sdrh   ** SELECT might also skip this part if it has no ORDER BY clause and
24198cdbf836Sdrh   ** no temp tables are required.
2420fbc4ee7bSdrh   */
24217d10d5a6Sdrh   if( p->selFlags & SF_UsesEphemeral ){
2422fbc4ee7bSdrh     int i;                        /* Loop counter */
2423fbc4ee7bSdrh     KeyInfo *pKeyInfo;            /* Collating sequence for the result set */
24240342b1f5Sdrh     Select *pLoop;                /* For looping through SELECT statements */
2425f68d7d17Sdrh     CollSeq **apColl;             /* For looping through pKeyInfo->aColl[] */
242693a960a0Sdrh     int nCol;                     /* Number of columns in result set */
2427fbc4ee7bSdrh 
2428d227a291Sdrh     assert( p->pNext==0 );
242993a960a0Sdrh     nCol = p->pEList->nExpr;
2430ad124329Sdrh     pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
2431dc1bdc4fSdanielk1977     if( !pKeyInfo ){
2432dc1bdc4fSdanielk1977       rc = SQLITE_NOMEM;
2433dc1bdc4fSdanielk1977       goto multi_select_end;
2434dc1bdc4fSdanielk1977     }
24350342b1f5Sdrh     for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
24360342b1f5Sdrh       *apColl = multiSelectCollSeq(pParse, p, i);
24370342b1f5Sdrh       if( 0==*apColl ){
2438633e6d57Sdrh         *apColl = db->pDfltColl;
2439dc1bdc4fSdanielk1977       }
2440dc1bdc4fSdanielk1977     }
2441dc1bdc4fSdanielk1977 
24420342b1f5Sdrh     for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
24430342b1f5Sdrh       for(i=0; i<2; i++){
2444b9bb7c18Sdrh         int addr = pLoop->addrOpenEphm[i];
24450342b1f5Sdrh         if( addr<0 ){
24460342b1f5Sdrh           /* If [0] is unused then [1] is also unused.  So we can
24470342b1f5Sdrh           ** always safely abort as soon as the first unused slot is found */
2448b9bb7c18Sdrh           assert( pLoop->addrOpenEphm[1]<0 );
24490342b1f5Sdrh           break;
24500342b1f5Sdrh         }
24510342b1f5Sdrh         sqlite3VdbeChangeP2(v, addr, nCol);
24522ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
24532ec2fb22Sdrh                             P4_KEYINFO);
24540ee5a1e7Sdrh         pLoop->addrOpenEphm[i] = -1;
24550342b1f5Sdrh       }
2456dc1bdc4fSdanielk1977     }
24572ec2fb22Sdrh     sqlite3KeyInfoUnref(pKeyInfo);
2458dc1bdc4fSdanielk1977   }
2459dc1bdc4fSdanielk1977 
2460dc1bdc4fSdanielk1977 multi_select_end:
24612b596da8Sdrh   pDest->iSdst = dest.iSdst;
24622b596da8Sdrh   pDest->nSdst = dest.nSdst;
2463633e6d57Sdrh   sqlite3SelectDelete(db, pDelete);
246484ac9d02Sdanielk1977   return rc;
24652282792aSdrh }
2466b7f9164eSdrh #endif /* SQLITE_OMIT_COMPOUND_SELECT */
24672282792aSdrh 
2468b21e7c70Sdrh /*
2469b21e7c70Sdrh ** Code an output subroutine for a coroutine implementation of a
2470b21e7c70Sdrh ** SELECT statment.
24710acb7e48Sdrh **
24722b596da8Sdrh ** The data to be output is contained in pIn->iSdst.  There are
24732b596da8Sdrh ** pIn->nSdst columns to be output.  pDest is where the output should
24740acb7e48Sdrh ** be sent.
24750acb7e48Sdrh **
24760acb7e48Sdrh ** regReturn is the number of the register holding the subroutine
24770acb7e48Sdrh ** return address.
24780acb7e48Sdrh **
2479f053d5b6Sdrh ** If regPrev>0 then it is the first register in a vector that
24800acb7e48Sdrh ** records the previous output.  mem[regPrev] is a flag that is false
24810acb7e48Sdrh ** if there has been no previous output.  If regPrev>0 then code is
24820acb7e48Sdrh ** generated to suppress duplicates.  pKeyInfo is used for comparing
24830acb7e48Sdrh ** keys.
24840acb7e48Sdrh **
24850acb7e48Sdrh ** If the LIMIT found in p->iLimit is reached, jump immediately to
24860acb7e48Sdrh ** iBreak.
2487b21e7c70Sdrh */
24880acb7e48Sdrh static int generateOutputSubroutine(
248992b01d53Sdrh   Parse *pParse,          /* Parsing context */
249092b01d53Sdrh   Select *p,              /* The SELECT statement */
249192b01d53Sdrh   SelectDest *pIn,        /* Coroutine supplying data */
249292b01d53Sdrh   SelectDest *pDest,      /* Where to send the data */
249392b01d53Sdrh   int regReturn,          /* The return address register */
24940acb7e48Sdrh   int regPrev,            /* Previous result register.  No uniqueness if 0 */
24950acb7e48Sdrh   KeyInfo *pKeyInfo,      /* For comparing with previous entry */
249692b01d53Sdrh   int iBreak              /* Jump here if we hit the LIMIT */
2497b21e7c70Sdrh ){
2498b21e7c70Sdrh   Vdbe *v = pParse->pVdbe;
249992b01d53Sdrh   int iContinue;
250092b01d53Sdrh   int addr;
2501b21e7c70Sdrh 
250292b01d53Sdrh   addr = sqlite3VdbeCurrentAddr(v);
250392b01d53Sdrh   iContinue = sqlite3VdbeMakeLabel(v);
25040acb7e48Sdrh 
25050acb7e48Sdrh   /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
25060acb7e48Sdrh   */
25070acb7e48Sdrh   if( regPrev ){
25080acb7e48Sdrh     int j1, j2;
2509688852abSdrh     j1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
25102b596da8Sdrh     j2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
25112ec2fb22Sdrh                               (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
2512688852abSdrh     sqlite3VdbeAddOp3(v, OP_Jump, j2+2, iContinue, j2+2); VdbeCoverage(v);
25130acb7e48Sdrh     sqlite3VdbeJumpHere(v, j1);
2514e8e4af76Sdrh     sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
2515ec86c724Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
25160acb7e48Sdrh   }
25171f9caa41Sdanielk1977   if( pParse->db->mallocFailed ) return 0;
25180acb7e48Sdrh 
2519d5578433Smistachkin   /* Suppress the first OFFSET entries if there is an OFFSET clause
25200acb7e48Sdrh   */
2521aa9ce707Sdrh   codeOffset(v, p->iOffset, iContinue);
2522b21e7c70Sdrh 
2523b21e7c70Sdrh   switch( pDest->eDest ){
2524b21e7c70Sdrh     /* Store the result as data using a unique key.
2525b21e7c70Sdrh     */
2526b21e7c70Sdrh     case SRT_Table:
2527b21e7c70Sdrh     case SRT_EphemTab: {
2528b21e7c70Sdrh       int r1 = sqlite3GetTempReg(pParse);
2529b21e7c70Sdrh       int r2 = sqlite3GetTempReg(pParse);
2530373cc2ddSdrh       testcase( pDest->eDest==SRT_Table );
2531373cc2ddSdrh       testcase( pDest->eDest==SRT_EphemTab );
25322b596da8Sdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
25332b596da8Sdrh       sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
25342b596da8Sdrh       sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
2535b21e7c70Sdrh       sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
2536b21e7c70Sdrh       sqlite3ReleaseTempReg(pParse, r2);
2537b21e7c70Sdrh       sqlite3ReleaseTempReg(pParse, r1);
2538b21e7c70Sdrh       break;
2539b21e7c70Sdrh     }
2540b21e7c70Sdrh 
2541b21e7c70Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2542b21e7c70Sdrh     /* If we are creating a set for an "expr IN (SELECT ...)" construct,
2543b21e7c70Sdrh     ** then there should be a single item on the stack.  Write this
2544b21e7c70Sdrh     ** item into the set table with bogus data.
2545b21e7c70Sdrh     */
2546b21e7c70Sdrh     case SRT_Set: {
25476fccc35aSdrh       int r1;
25482b596da8Sdrh       assert( pIn->nSdst==1 );
2549634d81deSdrh       pDest->affSdst =
25502b596da8Sdrh          sqlite3CompareAffinity(p->pEList->a[0].pExpr, pDest->affSdst);
2551b21e7c70Sdrh       r1 = sqlite3GetTempReg(pParse);
2552634d81deSdrh       sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, 1, r1, &pDest->affSdst,1);
25532b596da8Sdrh       sqlite3ExprCacheAffinityChange(pParse, pIn->iSdst, 1);
25542b596da8Sdrh       sqlite3VdbeAddOp2(v, OP_IdxInsert, pDest->iSDParm, r1);
2555b21e7c70Sdrh       sqlite3ReleaseTempReg(pParse, r1);
2556b21e7c70Sdrh       break;
2557b21e7c70Sdrh     }
2558b21e7c70Sdrh 
255985e9e22bSdrh #if 0  /* Never occurs on an ORDER BY query */
2560b21e7c70Sdrh     /* If any row exist in the result set, record that fact and abort.
2561b21e7c70Sdrh     */
2562b21e7c70Sdrh     case SRT_Exists: {
25632b596da8Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, pDest->iSDParm);
2564b21e7c70Sdrh       /* The LIMIT clause will terminate the loop for us */
2565b21e7c70Sdrh       break;
2566b21e7c70Sdrh     }
256785e9e22bSdrh #endif
2568b21e7c70Sdrh 
2569b21e7c70Sdrh     /* If this is a scalar select that is part of an expression, then
2570b21e7c70Sdrh     ** store the results in the appropriate memory cell and break out
2571b21e7c70Sdrh     ** of the scan loop.
2572b21e7c70Sdrh     */
2573b21e7c70Sdrh     case SRT_Mem: {
25742b596da8Sdrh       assert( pIn->nSdst==1 );
25752b596da8Sdrh       sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, 1);
2576b21e7c70Sdrh       /* The LIMIT clause will jump out of the loop for us */
2577b21e7c70Sdrh       break;
2578b21e7c70Sdrh     }
2579b21e7c70Sdrh #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
2580b21e7c70Sdrh 
25817d10d5a6Sdrh     /* The results are stored in a sequence of registers
25822b596da8Sdrh     ** starting at pDest->iSdst.  Then the co-routine yields.
2583b21e7c70Sdrh     */
258492b01d53Sdrh     case SRT_Coroutine: {
25852b596da8Sdrh       if( pDest->iSdst==0 ){
25862b596da8Sdrh         pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
25872b596da8Sdrh         pDest->nSdst = pIn->nSdst;
2588b21e7c70Sdrh       }
25892b596da8Sdrh       sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pDest->nSdst);
25902b596da8Sdrh       sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
259192b01d53Sdrh       break;
259292b01d53Sdrh     }
259392b01d53Sdrh 
2594ccfcbceaSdrh     /* If none of the above, then the result destination must be
2595ccfcbceaSdrh     ** SRT_Output.  This routine is never called with any other
2596ccfcbceaSdrh     ** destination other than the ones handled above or SRT_Output.
2597ccfcbceaSdrh     **
2598ccfcbceaSdrh     ** For SRT_Output, results are stored in a sequence of registers.
2599ccfcbceaSdrh     ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
2600ccfcbceaSdrh     ** return the next row of result.
26017d10d5a6Sdrh     */
2602ccfcbceaSdrh     default: {
2603ccfcbceaSdrh       assert( pDest->eDest==SRT_Output );
26042b596da8Sdrh       sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
26052b596da8Sdrh       sqlite3ExprCacheAffinityChange(pParse, pIn->iSdst, pIn->nSdst);
2606b21e7c70Sdrh       break;
2607b21e7c70Sdrh     }
2608b21e7c70Sdrh   }
260992b01d53Sdrh 
261092b01d53Sdrh   /* Jump to the end of the loop if the LIMIT is reached.
261192b01d53Sdrh   */
261292b01d53Sdrh   if( p->iLimit ){
2613688852abSdrh     sqlite3VdbeAddOp3(v, OP_IfZero, p->iLimit, iBreak, -1); VdbeCoverage(v);
261492b01d53Sdrh   }
261592b01d53Sdrh 
261692b01d53Sdrh   /* Generate the subroutine return
261792b01d53Sdrh   */
26180acb7e48Sdrh   sqlite3VdbeResolveLabel(v, iContinue);
261992b01d53Sdrh   sqlite3VdbeAddOp1(v, OP_Return, regReturn);
262092b01d53Sdrh 
262192b01d53Sdrh   return addr;
2622b21e7c70Sdrh }
2623b21e7c70Sdrh 
2624b21e7c70Sdrh /*
2625b21e7c70Sdrh ** Alternative compound select code generator for cases when there
2626b21e7c70Sdrh ** is an ORDER BY clause.
2627b21e7c70Sdrh **
2628b21e7c70Sdrh ** We assume a query of the following form:
2629b21e7c70Sdrh **
2630b21e7c70Sdrh **      <selectA>  <operator>  <selectB>  ORDER BY <orderbylist>
2631b21e7c70Sdrh **
2632b21e7c70Sdrh ** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT.  The idea
2633b21e7c70Sdrh ** is to code both <selectA> and <selectB> with the ORDER BY clause as
2634b21e7c70Sdrh ** co-routines.  Then run the co-routines in parallel and merge the results
2635b21e7c70Sdrh ** into the output.  In addition to the two coroutines (called selectA and
2636b21e7c70Sdrh ** selectB) there are 7 subroutines:
2637b21e7c70Sdrh **
2638b21e7c70Sdrh **    outA:    Move the output of the selectA coroutine into the output
2639b21e7c70Sdrh **             of the compound query.
2640b21e7c70Sdrh **
2641b21e7c70Sdrh **    outB:    Move the output of the selectB coroutine into the output
2642b21e7c70Sdrh **             of the compound query.  (Only generated for UNION and
2643b21e7c70Sdrh **             UNION ALL.  EXCEPT and INSERTSECT never output a row that
2644b21e7c70Sdrh **             appears only in B.)
2645b21e7c70Sdrh **
2646b21e7c70Sdrh **    AltB:    Called when there is data from both coroutines and A<B.
2647b21e7c70Sdrh **
2648b21e7c70Sdrh **    AeqB:    Called when there is data from both coroutines and A==B.
2649b21e7c70Sdrh **
2650b21e7c70Sdrh **    AgtB:    Called when there is data from both coroutines and A>B.
2651b21e7c70Sdrh **
2652b21e7c70Sdrh **    EofA:    Called when data is exhausted from selectA.
2653b21e7c70Sdrh **
2654b21e7c70Sdrh **    EofB:    Called when data is exhausted from selectB.
2655b21e7c70Sdrh **
2656b21e7c70Sdrh ** The implementation of the latter five subroutines depend on which
2657b21e7c70Sdrh ** <operator> is used:
2658b21e7c70Sdrh **
2659b21e7c70Sdrh **
2660b21e7c70Sdrh **             UNION ALL         UNION            EXCEPT          INTERSECT
2661b21e7c70Sdrh **          -------------  -----------------  --------------  -----------------
2662b21e7c70Sdrh **   AltB:   outA, nextA      outA, nextA       outA, nextA         nextA
2663b21e7c70Sdrh **
26640acb7e48Sdrh **   AeqB:   outA, nextA         nextA             nextA         outA, nextA
2665b21e7c70Sdrh **
2666b21e7c70Sdrh **   AgtB:   outB, nextB      outB, nextB          nextB            nextB
2667b21e7c70Sdrh **
26680acb7e48Sdrh **   EofA:   outB, nextB      outB, nextB          halt             halt
2669b21e7c70Sdrh **
26700acb7e48Sdrh **   EofB:   outA, nextA      outA, nextA       outA, nextA         halt
26710acb7e48Sdrh **
26720acb7e48Sdrh ** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
26730acb7e48Sdrh ** causes an immediate jump to EofA and an EOF on B following nextB causes
26740acb7e48Sdrh ** an immediate jump to EofB.  Within EofA and EofB, and EOF on entry or
26750acb7e48Sdrh ** following nextX causes a jump to the end of the select processing.
26760acb7e48Sdrh **
26770acb7e48Sdrh ** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
26780acb7e48Sdrh ** within the output subroutine.  The regPrev register set holds the previously
26790acb7e48Sdrh ** output value.  A comparison is made against this value and the output
26800acb7e48Sdrh ** is skipped if the next results would be the same as the previous.
2681b21e7c70Sdrh **
2682b21e7c70Sdrh ** The implementation plan is to implement the two coroutines and seven
2683b21e7c70Sdrh ** subroutines first, then put the control logic at the bottom.  Like this:
2684b21e7c70Sdrh **
2685b21e7c70Sdrh **          goto Init
2686b21e7c70Sdrh **     coA: coroutine for left query (A)
2687b21e7c70Sdrh **     coB: coroutine for right query (B)
2688b21e7c70Sdrh **    outA: output one row of A
2689b21e7c70Sdrh **    outB: output one row of B (UNION and UNION ALL only)
2690b21e7c70Sdrh **    EofA: ...
2691b21e7c70Sdrh **    EofB: ...
2692b21e7c70Sdrh **    AltB: ...
2693b21e7c70Sdrh **    AeqB: ...
2694b21e7c70Sdrh **    AgtB: ...
2695b21e7c70Sdrh **    Init: initialize coroutine registers
2696b21e7c70Sdrh **          yield coA
2697b21e7c70Sdrh **          if eof(A) goto EofA
2698b21e7c70Sdrh **          yield coB
2699b21e7c70Sdrh **          if eof(B) goto EofB
2700b21e7c70Sdrh **    Cmpr: Compare A, B
2701b21e7c70Sdrh **          Jump AltB, AeqB, AgtB
2702b21e7c70Sdrh **     End: ...
2703b21e7c70Sdrh **
2704b21e7c70Sdrh ** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
2705b21e7c70Sdrh ** actually called using Gosub and they do not Return.  EofA and EofB loop
2706b21e7c70Sdrh ** until all data is exhausted then jump to the "end" labe.  AltB, AeqB,
2707b21e7c70Sdrh ** and AgtB jump to either L2 or to one of EofA or EofB.
2708b21e7c70Sdrh */
2709de3e41e3Sdanielk1977 #ifndef SQLITE_OMIT_COMPOUND_SELECT
2710b21e7c70Sdrh static int multiSelectOrderBy(
2711b21e7c70Sdrh   Parse *pParse,        /* Parsing context */
2712b21e7c70Sdrh   Select *p,            /* The right-most of SELECTs to be coded */
2713a9671a22Sdrh   SelectDest *pDest     /* What to do with query results */
2714b21e7c70Sdrh ){
27150acb7e48Sdrh   int i, j;             /* Loop counters */
2716b21e7c70Sdrh   Select *pPrior;       /* Another SELECT immediately to our left */
2717b21e7c70Sdrh   Vdbe *v;              /* Generate code to this VDBE */
2718b21e7c70Sdrh   SelectDest destA;     /* Destination for coroutine A */
2719b21e7c70Sdrh   SelectDest destB;     /* Destination for coroutine B */
272092b01d53Sdrh   int regAddrA;         /* Address register for select-A coroutine */
272192b01d53Sdrh   int regAddrB;         /* Address register for select-B coroutine */
272292b01d53Sdrh   int addrSelectA;      /* Address of the select-A coroutine */
272392b01d53Sdrh   int addrSelectB;      /* Address of the select-B coroutine */
272492b01d53Sdrh   int regOutA;          /* Address register for the output-A subroutine */
272592b01d53Sdrh   int regOutB;          /* Address register for the output-B subroutine */
272692b01d53Sdrh   int addrOutA;         /* Address of the output-A subroutine */
2727b27b7f5dSdrh   int addrOutB = 0;     /* Address of the output-B subroutine */
272892b01d53Sdrh   int addrEofA;         /* Address of the select-A-exhausted subroutine */
272981cf13ecSdrh   int addrEofA_noB;     /* Alternate addrEofA if B is uninitialized */
273092b01d53Sdrh   int addrEofB;         /* Address of the select-B-exhausted subroutine */
273192b01d53Sdrh   int addrAltB;         /* Address of the A<B subroutine */
273292b01d53Sdrh   int addrAeqB;         /* Address of the A==B subroutine */
273392b01d53Sdrh   int addrAgtB;         /* Address of the A>B subroutine */
273492b01d53Sdrh   int regLimitA;        /* Limit register for select-A */
273592b01d53Sdrh   int regLimitB;        /* Limit register for select-A */
27360acb7e48Sdrh   int regPrev;          /* A range of registers to hold previous output */
273792b01d53Sdrh   int savedLimit;       /* Saved value of p->iLimit */
273892b01d53Sdrh   int savedOffset;      /* Saved value of p->iOffset */
273992b01d53Sdrh   int labelCmpr;        /* Label for the start of the merge algorithm */
274092b01d53Sdrh   int labelEnd;         /* Label for the end of the overall SELECT stmt */
27410acb7e48Sdrh   int j1;               /* Jump instructions that get retargetted */
274292b01d53Sdrh   int op;               /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
274396067816Sdrh   KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
27440acb7e48Sdrh   KeyInfo *pKeyMerge;   /* Comparison information for merging rows */
27450acb7e48Sdrh   sqlite3 *db;          /* Database connection */
27460acb7e48Sdrh   ExprList *pOrderBy;   /* The ORDER BY clause */
27470acb7e48Sdrh   int nOrderBy;         /* Number of terms in the ORDER BY clause */
27480acb7e48Sdrh   int *aPermute;        /* Mapping from ORDER BY terms to result set columns */
27497f61e92cSdan #ifndef SQLITE_OMIT_EXPLAIN
27507f61e92cSdan   int iSub1;            /* EQP id of left-hand query */
27517f61e92cSdan   int iSub2;            /* EQP id of right-hand query */
27527f61e92cSdan #endif
2753b21e7c70Sdrh 
275492b01d53Sdrh   assert( p->pOrderBy!=0 );
275596067816Sdrh   assert( pKeyDup==0 ); /* "Managed" code needs this.  Ticket #3382. */
27560acb7e48Sdrh   db = pParse->db;
275792b01d53Sdrh   v = pParse->pVdbe;
2758ccfcbceaSdrh   assert( v!=0 );       /* Already thrown the error if VDBE alloc failed */
275992b01d53Sdrh   labelEnd = sqlite3VdbeMakeLabel(v);
276092b01d53Sdrh   labelCmpr = sqlite3VdbeMakeLabel(v);
27610acb7e48Sdrh 
2762b21e7c70Sdrh 
276392b01d53Sdrh   /* Patch up the ORDER BY clause
276492b01d53Sdrh   */
276592b01d53Sdrh   op = p->op;
2766b21e7c70Sdrh   pPrior = p->pPrior;
276792b01d53Sdrh   assert( pPrior->pOrderBy==0 );
27680acb7e48Sdrh   pOrderBy = p->pOrderBy;
276993a960a0Sdrh   assert( pOrderBy );
27700acb7e48Sdrh   nOrderBy = pOrderBy->nExpr;
277193a960a0Sdrh 
27720acb7e48Sdrh   /* For operators other than UNION ALL we have to make sure that
27730acb7e48Sdrh   ** the ORDER BY clause covers every term of the result set.  Add
27740acb7e48Sdrh   ** terms to the ORDER BY clause as necessary.
27750acb7e48Sdrh   */
27760acb7e48Sdrh   if( op!=TK_ALL ){
27770acb7e48Sdrh     for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
27787d10d5a6Sdrh       struct ExprList_item *pItem;
27797d10d5a6Sdrh       for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
2780c2acc4e4Sdrh         assert( pItem->u.x.iOrderByCol>0 );
2781c2acc4e4Sdrh         if( pItem->u.x.iOrderByCol==i ) break;
27820acb7e48Sdrh       }
27830acb7e48Sdrh       if( j==nOrderBy ){
2784b7916a78Sdrh         Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
27850acb7e48Sdrh         if( pNew==0 ) return SQLITE_NOMEM;
27860acb7e48Sdrh         pNew->flags |= EP_IntValue;
278733e619fcSdrh         pNew->u.iValue = i;
2788b7916a78Sdrh         pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
2789c2acc4e4Sdrh         if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
27900acb7e48Sdrh       }
27910acb7e48Sdrh     }
27920acb7e48Sdrh   }
27930acb7e48Sdrh 
27940acb7e48Sdrh   /* Compute the comparison permutation and keyinfo that is used with
279510c081adSdrh   ** the permutation used to determine if the next
27960acb7e48Sdrh   ** row of results comes from selectA or selectB.  Also add explicit
27970acb7e48Sdrh   ** collations to the ORDER BY clause terms so that when the subqueries
27980acb7e48Sdrh   ** to the right and the left are evaluated, they use the correct
27990acb7e48Sdrh   ** collation.
28000acb7e48Sdrh   */
28010acb7e48Sdrh   aPermute = sqlite3DbMallocRaw(db, sizeof(int)*nOrderBy);
28020acb7e48Sdrh   if( aPermute ){
28037d10d5a6Sdrh     struct ExprList_item *pItem;
28047d10d5a6Sdrh     for(i=0, pItem=pOrderBy->a; i<nOrderBy; i++, pItem++){
2805c2acc4e4Sdrh       assert( pItem->u.x.iOrderByCol>0
2806c2acc4e4Sdrh           && pItem->u.x.iOrderByCol<=p->pEList->nExpr );
2807c2acc4e4Sdrh       aPermute[i] = pItem->u.x.iOrderByCol - 1;
28080acb7e48Sdrh     }
280953bed45eSdan     pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
28100acb7e48Sdrh   }else{
28110acb7e48Sdrh     pKeyMerge = 0;
28120acb7e48Sdrh   }
28130acb7e48Sdrh 
28140acb7e48Sdrh   /* Reattach the ORDER BY clause to the query.
28150acb7e48Sdrh   */
28160acb7e48Sdrh   p->pOrderBy = pOrderBy;
28176ab3a2ecSdanielk1977   pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
28180acb7e48Sdrh 
28190acb7e48Sdrh   /* Allocate a range of temporary registers and the KeyInfo needed
28200acb7e48Sdrh   ** for the logic that removes duplicate result rows when the
28210acb7e48Sdrh   ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
28220acb7e48Sdrh   */
28230acb7e48Sdrh   if( op==TK_ALL ){
28240acb7e48Sdrh     regPrev = 0;
28250acb7e48Sdrh   }else{
28260acb7e48Sdrh     int nExpr = p->pEList->nExpr;
28271c0dc825Sdrh     assert( nOrderBy>=nExpr || db->mallocFailed );
2828c8ac0d16Sdrh     regPrev = pParse->nMem+1;
2829c8ac0d16Sdrh     pParse->nMem += nExpr+1;
28300acb7e48Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
2831ad124329Sdrh     pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
28320acb7e48Sdrh     if( pKeyDup ){
28332ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
28340acb7e48Sdrh       for(i=0; i<nExpr; i++){
28350acb7e48Sdrh         pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
28360acb7e48Sdrh         pKeyDup->aSortOrder[i] = 0;
28370acb7e48Sdrh       }
28380acb7e48Sdrh     }
28390acb7e48Sdrh   }
284092b01d53Sdrh 
284192b01d53Sdrh   /* Separate the left and the right query from one another
284292b01d53Sdrh   */
284392b01d53Sdrh   p->pPrior = 0;
2844d227a291Sdrh   pPrior->pNext = 0;
28457d10d5a6Sdrh   sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
28460acb7e48Sdrh   if( pPrior->pPrior==0 ){
28477d10d5a6Sdrh     sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
28480acb7e48Sdrh   }
284992b01d53Sdrh 
285092b01d53Sdrh   /* Compute the limit registers */
285192b01d53Sdrh   computeLimitRegisters(pParse, p, labelEnd);
28520acb7e48Sdrh   if( p->iLimit && op==TK_ALL ){
285392b01d53Sdrh     regLimitA = ++pParse->nMem;
285492b01d53Sdrh     regLimitB = ++pParse->nMem;
285592b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
285692b01d53Sdrh                                   regLimitA);
285792b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
285892b01d53Sdrh   }else{
285992b01d53Sdrh     regLimitA = regLimitB = 0;
286092b01d53Sdrh   }
2861633e6d57Sdrh   sqlite3ExprDelete(db, p->pLimit);
28620acb7e48Sdrh   p->pLimit = 0;
2863633e6d57Sdrh   sqlite3ExprDelete(db, p->pOffset);
28640acb7e48Sdrh   p->pOffset = 0;
286592b01d53Sdrh 
2866b21e7c70Sdrh   regAddrA = ++pParse->nMem;
2867b21e7c70Sdrh   regAddrB = ++pParse->nMem;
2868b21e7c70Sdrh   regOutA = ++pParse->nMem;
2869b21e7c70Sdrh   regOutB = ++pParse->nMem;
2870b21e7c70Sdrh   sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
2871b21e7c70Sdrh   sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
2872b21e7c70Sdrh 
287392b01d53Sdrh   /* Generate a coroutine to evaluate the SELECT statement to the
28740acb7e48Sdrh   ** left of the compound operator - the "A" select.
28750acb7e48Sdrh   */
2876ed71a839Sdrh   addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
2877ed71a839Sdrh   j1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
2878ed71a839Sdrh   VdbeComment((v, "left SELECT"));
287992b01d53Sdrh   pPrior->iLimit = regLimitA;
28807f61e92cSdan   explainSetInteger(iSub1, pParse->iNextSelectId);
28817d10d5a6Sdrh   sqlite3Select(pParse, pPrior, &destA);
288281cf13ecSdrh   sqlite3VdbeAddOp1(v, OP_EndCoroutine, regAddrA);
2883ed71a839Sdrh   sqlite3VdbeJumpHere(v, j1);
2884b21e7c70Sdrh 
288592b01d53Sdrh   /* Generate a coroutine to evaluate the SELECT statement on
288692b01d53Sdrh   ** the right - the "B" select
288792b01d53Sdrh   */
2888ed71a839Sdrh   addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
2889ed71a839Sdrh   j1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
2890ed71a839Sdrh   VdbeComment((v, "right SELECT"));
289192b01d53Sdrh   savedLimit = p->iLimit;
289292b01d53Sdrh   savedOffset = p->iOffset;
289392b01d53Sdrh   p->iLimit = regLimitB;
289492b01d53Sdrh   p->iOffset = 0;
28957f61e92cSdan   explainSetInteger(iSub2, pParse->iNextSelectId);
28967d10d5a6Sdrh   sqlite3Select(pParse, p, &destB);
289792b01d53Sdrh   p->iLimit = savedLimit;
289892b01d53Sdrh   p->iOffset = savedOffset;
289981cf13ecSdrh   sqlite3VdbeAddOp1(v, OP_EndCoroutine, regAddrB);
2900b21e7c70Sdrh 
290192b01d53Sdrh   /* Generate a subroutine that outputs the current row of the A
29020acb7e48Sdrh   ** select as the next output row of the compound select.
290392b01d53Sdrh   */
2904b21e7c70Sdrh   VdbeNoopComment((v, "Output routine for A"));
29050acb7e48Sdrh   addrOutA = generateOutputSubroutine(pParse,
29060acb7e48Sdrh                  p, &destA, pDest, regOutA,
29072ec2fb22Sdrh                  regPrev, pKeyDup, labelEnd);
2908b21e7c70Sdrh 
290992b01d53Sdrh   /* Generate a subroutine that outputs the current row of the B
29100acb7e48Sdrh   ** select as the next output row of the compound select.
291192b01d53Sdrh   */
29120acb7e48Sdrh   if( op==TK_ALL || op==TK_UNION ){
2913b21e7c70Sdrh     VdbeNoopComment((v, "Output routine for B"));
29140acb7e48Sdrh     addrOutB = generateOutputSubroutine(pParse,
29150acb7e48Sdrh                  p, &destB, pDest, regOutB,
29162ec2fb22Sdrh                  regPrev, pKeyDup, labelEnd);
29170acb7e48Sdrh   }
29182ec2fb22Sdrh   sqlite3KeyInfoUnref(pKeyDup);
2919b21e7c70Sdrh 
292092b01d53Sdrh   /* Generate a subroutine to run when the results from select A
292192b01d53Sdrh   ** are exhausted and only data in select B remains.
292292b01d53Sdrh   */
292392b01d53Sdrh   if( op==TK_EXCEPT || op==TK_INTERSECT ){
292481cf13ecSdrh     addrEofA_noB = addrEofA = labelEnd;
292592b01d53Sdrh   }else{
292681cf13ecSdrh     VdbeNoopComment((v, "eof-A subroutine"));
292781cf13ecSdrh     addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
292881cf13ecSdrh     addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
2929688852abSdrh                                      VdbeCoverage(v);
29300acb7e48Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, addrEofA);
293195aa47b1Sdrh     p->nSelectRow += pPrior->nSelectRow;
2932b21e7c70Sdrh   }
2933b21e7c70Sdrh 
293492b01d53Sdrh   /* Generate a subroutine to run when the results from select B
293592b01d53Sdrh   ** are exhausted and only data in select A remains.
293692b01d53Sdrh   */
2937b21e7c70Sdrh   if( op==TK_INTERSECT ){
293892b01d53Sdrh     addrEofB = addrEofA;
293995aa47b1Sdrh     if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
2940b21e7c70Sdrh   }else{
294192b01d53Sdrh     VdbeNoopComment((v, "eof-B subroutine"));
294281cf13ecSdrh     addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
2943688852abSdrh     sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
29440acb7e48Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, addrEofB);
2945b21e7c70Sdrh   }
2946b21e7c70Sdrh 
294792b01d53Sdrh   /* Generate code to handle the case of A<B
294892b01d53Sdrh   */
2949b21e7c70Sdrh   VdbeNoopComment((v, "A-lt-B subroutine"));
29500acb7e48Sdrh   addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
2951688852abSdrh   sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
295292b01d53Sdrh   sqlite3VdbeAddOp2(v, OP_Goto, 0, labelCmpr);
2953b21e7c70Sdrh 
295492b01d53Sdrh   /* Generate code to handle the case of A==B
295592b01d53Sdrh   */
2956b21e7c70Sdrh   if( op==TK_ALL ){
2957b21e7c70Sdrh     addrAeqB = addrAltB;
29580acb7e48Sdrh   }else if( op==TK_INTERSECT ){
29590acb7e48Sdrh     addrAeqB = addrAltB;
29600acb7e48Sdrh     addrAltB++;
296192b01d53Sdrh   }else{
2962b21e7c70Sdrh     VdbeNoopComment((v, "A-eq-B subroutine"));
29630acb7e48Sdrh     addrAeqB =
2964688852abSdrh     sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
296592b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, labelCmpr);
296692b01d53Sdrh   }
2967b21e7c70Sdrh 
296892b01d53Sdrh   /* Generate code to handle the case of A>B
296992b01d53Sdrh   */
2970b21e7c70Sdrh   VdbeNoopComment((v, "A-gt-B subroutine"));
2971b21e7c70Sdrh   addrAgtB = sqlite3VdbeCurrentAddr(v);
2972b21e7c70Sdrh   if( op==TK_ALL || op==TK_UNION ){
2973b21e7c70Sdrh     sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
297492b01d53Sdrh   }
2975688852abSdrh   sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
297692b01d53Sdrh   sqlite3VdbeAddOp2(v, OP_Goto, 0, labelCmpr);
2977b21e7c70Sdrh 
297892b01d53Sdrh   /* This code runs once to initialize everything.
297992b01d53Sdrh   */
2980b21e7c70Sdrh   sqlite3VdbeJumpHere(v, j1);
2981688852abSdrh   sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
2982688852abSdrh   sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
298392b01d53Sdrh 
298492b01d53Sdrh   /* Implement the main merge loop
298592b01d53Sdrh   */
298692b01d53Sdrh   sqlite3VdbeResolveLabel(v, labelCmpr);
29870acb7e48Sdrh   sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
29882b596da8Sdrh   sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
29892ec2fb22Sdrh                          (char*)pKeyMerge, P4_KEYINFO);
2990953f7611Sdrh   sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
2991688852abSdrh   sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
299292b01d53Sdrh 
299392b01d53Sdrh   /* Jump to the this point in order to terminate the query.
299492b01d53Sdrh   */
2995b21e7c70Sdrh   sqlite3VdbeResolveLabel(v, labelEnd);
2996b21e7c70Sdrh 
299792b01d53Sdrh   /* Set the number of output columns
299892b01d53Sdrh   */
29997d10d5a6Sdrh   if( pDest->eDest==SRT_Output ){
30000acb7e48Sdrh     Select *pFirst = pPrior;
300192b01d53Sdrh     while( pFirst->pPrior ) pFirst = pFirst->pPrior;
300292b01d53Sdrh     generateColumnNames(pParse, 0, pFirst->pEList);
3003b21e7c70Sdrh   }
300492b01d53Sdrh 
30050acb7e48Sdrh   /* Reassembly the compound query so that it will be freed correctly
30060acb7e48Sdrh   ** by the calling function */
30075e7ad508Sdanielk1977   if( p->pPrior ){
3008633e6d57Sdrh     sqlite3SelectDelete(db, p->pPrior);
30095e7ad508Sdanielk1977   }
30100acb7e48Sdrh   p->pPrior = pPrior;
3011d227a291Sdrh   pPrior->pNext = p;
301292b01d53Sdrh 
301392b01d53Sdrh   /*** TBD:  Insert subroutine calls to close cursors on incomplete
301492b01d53Sdrh   **** subqueries ****/
30157f61e92cSdan   explainComposite(pParse, p->op, iSub1, iSub2, 0);
301692b01d53Sdrh   return SQLITE_OK;
301792b01d53Sdrh }
3018de3e41e3Sdanielk1977 #endif
3019b21e7c70Sdrh 
30203514b6f7Sshane #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
302117435752Sdrh /* Forward Declarations */
302217435752Sdrh static void substExprList(sqlite3*, ExprList*, int, ExprList*);
302317435752Sdrh static void substSelect(sqlite3*, Select *, int, ExprList *);
302417435752Sdrh 
30252282792aSdrh /*
3026832508b7Sdrh ** Scan through the expression pExpr.  Replace every reference to
30276a3ea0e6Sdrh ** a column in table number iTable with a copy of the iColumn-th
302884e59207Sdrh ** entry in pEList.  (But leave references to the ROWID column
30296a3ea0e6Sdrh ** unchanged.)
3030832508b7Sdrh **
3031832508b7Sdrh ** This routine is part of the flattening procedure.  A subquery
3032832508b7Sdrh ** whose result set is defined by pEList appears as entry in the
3033832508b7Sdrh ** FROM clause of a SELECT such that the VDBE cursor assigned to that
3034832508b7Sdrh ** FORM clause entry is iTable.  This routine make the necessary
3035832508b7Sdrh ** changes to pExpr so that it refers directly to the source table
3036832508b7Sdrh ** of the subquery rather the result set of the subquery.
3037832508b7Sdrh */
3038b7916a78Sdrh static Expr *substExpr(
303917435752Sdrh   sqlite3 *db,        /* Report malloc errors to this connection */
304017435752Sdrh   Expr *pExpr,        /* Expr in which substitution occurs */
304117435752Sdrh   int iTable,         /* Table to be substituted */
304217435752Sdrh   ExprList *pEList    /* Substitute expressions */
304317435752Sdrh ){
3044b7916a78Sdrh   if( pExpr==0 ) return 0;
304550350a15Sdrh   if( pExpr->op==TK_COLUMN && pExpr->iTable==iTable ){
304650350a15Sdrh     if( pExpr->iColumn<0 ){
304750350a15Sdrh       pExpr->op = TK_NULL;
304850350a15Sdrh     }else{
3049832508b7Sdrh       Expr *pNew;
305084e59207Sdrh       assert( pEList!=0 && pExpr->iColumn<pEList->nExpr );
30516ab3a2ecSdanielk1977       assert( pExpr->pLeft==0 && pExpr->pRight==0 );
3052b7916a78Sdrh       pNew = sqlite3ExprDup(db, pEList->a[pExpr->iColumn].pExpr, 0);
3053b7916a78Sdrh       sqlite3ExprDelete(db, pExpr);
3054b7916a78Sdrh       pExpr = pNew;
305550350a15Sdrh     }
3056832508b7Sdrh   }else{
3057b7916a78Sdrh     pExpr->pLeft = substExpr(db, pExpr->pLeft, iTable, pEList);
3058b7916a78Sdrh     pExpr->pRight = substExpr(db, pExpr->pRight, iTable, pEList);
30596ab3a2ecSdanielk1977     if( ExprHasProperty(pExpr, EP_xIsSelect) ){
30606ab3a2ecSdanielk1977       substSelect(db, pExpr->x.pSelect, iTable, pEList);
30616ab3a2ecSdanielk1977     }else{
30626ab3a2ecSdanielk1977       substExprList(db, pExpr->x.pList, iTable, pEList);
30636ab3a2ecSdanielk1977     }
3064832508b7Sdrh   }
3065b7916a78Sdrh   return pExpr;
3066832508b7Sdrh }
306717435752Sdrh static void substExprList(
306817435752Sdrh   sqlite3 *db,         /* Report malloc errors here */
306917435752Sdrh   ExprList *pList,     /* List to scan and in which to make substitutes */
307017435752Sdrh   int iTable,          /* Table to be substituted */
307117435752Sdrh   ExprList *pEList     /* Substitute values */
307217435752Sdrh ){
3073832508b7Sdrh   int i;
3074832508b7Sdrh   if( pList==0 ) return;
3075832508b7Sdrh   for(i=0; i<pList->nExpr; i++){
3076b7916a78Sdrh     pList->a[i].pExpr = substExpr(db, pList->a[i].pExpr, iTable, pEList);
3077832508b7Sdrh   }
3078832508b7Sdrh }
307917435752Sdrh static void substSelect(
308017435752Sdrh   sqlite3 *db,         /* Report malloc errors here */
308117435752Sdrh   Select *p,           /* SELECT statement in which to make substitutions */
308217435752Sdrh   int iTable,          /* Table to be replaced */
308317435752Sdrh   ExprList *pEList     /* Substitute values */
308417435752Sdrh ){
3085588a9a1aSdrh   SrcList *pSrc;
3086588a9a1aSdrh   struct SrcList_item *pItem;
3087588a9a1aSdrh   int i;
3088b3bce662Sdanielk1977   if( !p ) return;
308917435752Sdrh   substExprList(db, p->pEList, iTable, pEList);
309017435752Sdrh   substExprList(db, p->pGroupBy, iTable, pEList);
309117435752Sdrh   substExprList(db, p->pOrderBy, iTable, pEList);
3092b7916a78Sdrh   p->pHaving = substExpr(db, p->pHaving, iTable, pEList);
3093b7916a78Sdrh   p->pWhere = substExpr(db, p->pWhere, iTable, pEList);
309417435752Sdrh   substSelect(db, p->pPrior, iTable, pEList);
3095588a9a1aSdrh   pSrc = p->pSrc;
3096e2f02bacSdrh   assert( pSrc );  /* Even for (SELECT 1) we have: pSrc!=0 but pSrc->nSrc==0 */
3097e2f02bacSdrh   if( ALWAYS(pSrc) ){
3098588a9a1aSdrh     for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
3099588a9a1aSdrh       substSelect(db, pItem->pSelect, iTable, pEList);
3100588a9a1aSdrh     }
3101588a9a1aSdrh   }
3102b3bce662Sdanielk1977 }
31033514b6f7Sshane #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3104832508b7Sdrh 
31053514b6f7Sshane #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3106832508b7Sdrh /*
3107630d296cSdrh ** This routine attempts to flatten subqueries as a performance optimization.
3108630d296cSdrh ** This routine returns 1 if it makes changes and 0 if no flattening occurs.
31091350b030Sdrh **
31101350b030Sdrh ** To understand the concept of flattening, consider the following
31111350b030Sdrh ** query:
31121350b030Sdrh **
31131350b030Sdrh **     SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
31141350b030Sdrh **
31151350b030Sdrh ** The default way of implementing this query is to execute the
31161350b030Sdrh ** subquery first and store the results in a temporary table, then
31171350b030Sdrh ** run the outer query on that temporary table.  This requires two
31181350b030Sdrh ** passes over the data.  Furthermore, because the temporary table
31191350b030Sdrh ** has no indices, the WHERE clause on the outer query cannot be
3120832508b7Sdrh ** optimized.
31211350b030Sdrh **
3122832508b7Sdrh ** This routine attempts to rewrite queries such as the above into
31231350b030Sdrh ** a single flat select, like this:
31241350b030Sdrh **
31251350b030Sdrh **     SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
31261350b030Sdrh **
312760ec914cSpeter.d.reid ** The code generated for this simplification gives the same result
3128832508b7Sdrh ** but only has to scan the data once.  And because indices might
3129832508b7Sdrh ** exist on the table t1, a complete scan of the data might be
3130832508b7Sdrh ** avoided.
31311350b030Sdrh **
3132832508b7Sdrh ** Flattening is only attempted if all of the following are true:
31331350b030Sdrh **
3134832508b7Sdrh **   (1)  The subquery and the outer query do not both use aggregates.
31351350b030Sdrh **
3136832508b7Sdrh **   (2)  The subquery is not an aggregate or the outer query is not a join.
3137832508b7Sdrh **
31382b300d5dSdrh **   (3)  The subquery is not the right operand of a left outer join
313949ad330dSdan **        (Originally ticket #306.  Strengthened by ticket #3300)
3140832508b7Sdrh **
314149ad330dSdan **   (4)  The subquery is not DISTINCT.
3142832508b7Sdrh **
314349ad330dSdan **  (**)  At one point restrictions (4) and (5) defined a subset of DISTINCT
314449ad330dSdan **        sub-queries that were excluded from this optimization. Restriction
314549ad330dSdan **        (4) has since been expanded to exclude all DISTINCT subqueries.
3146832508b7Sdrh **
3147832508b7Sdrh **   (6)  The subquery does not use aggregates or the outer query is not
3148832508b7Sdrh **        DISTINCT.
3149832508b7Sdrh **
3150630d296cSdrh **   (7)  The subquery has a FROM clause.  TODO:  For subqueries without
3151630d296cSdrh **        A FROM clause, consider adding a FROM close with the special
3152630d296cSdrh **        table sqlite_once that consists of a single row containing a
3153630d296cSdrh **        single NULL.
315408192d5fSdrh **
3155df199a25Sdrh **   (8)  The subquery does not use LIMIT or the outer query is not a join.
3156df199a25Sdrh **
3157df199a25Sdrh **   (9)  The subquery does not use LIMIT or the outer query does not use
3158df199a25Sdrh **        aggregates.
3159df199a25Sdrh **
31606092d2bcSdrh **  (**)  Restriction (10) was removed from the code on 2005-02-05 but we
31616092d2bcSdrh **        accidently carried the comment forward until 2014-09-15.  Original
31626092d2bcSdrh **        text: "The subquery does not use aggregates or the outer query does not
31636092d2bcSdrh **        use LIMIT."
3164df199a25Sdrh **
3165174b6195Sdrh **  (11)  The subquery and the outer query do not both have ORDER BY clauses.
3166174b6195Sdrh **
31677b688edeSdrh **  (**)  Not implemented.  Subsumed into restriction (3).  Was previously
31682b300d5dSdrh **        a separate restriction deriving from ticket #350.
31693fc673e6Sdrh **
317049ad330dSdan **  (13)  The subquery and outer query do not both use LIMIT.
3171ac83963aSdrh **
317249ad330dSdan **  (14)  The subquery does not use OFFSET.
3173ac83963aSdrh **
3174ad91c6cdSdrh **  (15)  The outer query is not part of a compound select or the
3175f3913278Sdrh **        subquery does not have a LIMIT clause.
3176f3913278Sdrh **        (See ticket #2339 and ticket [02a8e81d44]).
3177ad91c6cdSdrh **
3178c52e355dSdrh **  (16)  The outer query is not an aggregate or the subquery does
3179c52e355dSdrh **        not contain ORDER BY.  (Ticket #2942)  This used to not matter
3180c52e355dSdrh **        until we introduced the group_concat() function.
3181c52e355dSdrh **
3182f23329a2Sdanielk1977 **  (17)  The sub-query is not a compound select, or it is a UNION ALL
31834914cf92Sdanielk1977 **        compound clause made up entirely of non-aggregate queries, and
3184f23329a2Sdanielk1977 **        the parent query:
3185f23329a2Sdanielk1977 **
3186f23329a2Sdanielk1977 **          * is not itself part of a compound select,
3187f23329a2Sdanielk1977 **          * is not an aggregate or DISTINCT query, and
3188630d296cSdrh **          * is not a join
3189f23329a2Sdanielk1977 **
31904914cf92Sdanielk1977 **        The parent and sub-query may contain WHERE clauses. Subject to
31914914cf92Sdanielk1977 **        rules (11), (13) and (14), they may also contain ORDER BY,
3192630d296cSdrh **        LIMIT and OFFSET clauses.  The subquery cannot use any compound
3193630d296cSdrh **        operator other than UNION ALL because all the other compound
3194630d296cSdrh **        operators have an implied DISTINCT which is disallowed by
3195630d296cSdrh **        restriction (4).
3196f23329a2Sdanielk1977 **
319767c70142Sdan **        Also, each component of the sub-query must return the same number
319867c70142Sdan **        of result columns. This is actually a requirement for any compound
319967c70142Sdan **        SELECT statement, but all the code here does is make sure that no
320067c70142Sdan **        such (illegal) sub-query is flattened. The caller will detect the
320167c70142Sdan **        syntax error and return a detailed message.
320267c70142Sdan **
320349fc1f60Sdanielk1977 **  (18)  If the sub-query is a compound select, then all terms of the
320449fc1f60Sdanielk1977 **        ORDER by clause of the parent must be simple references to
320549fc1f60Sdanielk1977 **        columns of the sub-query.
320649fc1f60Sdanielk1977 **
3207229cf702Sdrh **  (19)  The subquery does not use LIMIT or the outer query does not
3208229cf702Sdrh **        have a WHERE clause.
3209229cf702Sdrh **
3210e8902a70Sdrh **  (20)  If the sub-query is a compound select, then it must not use
3211e8902a70Sdrh **        an ORDER BY clause.  Ticket #3773.  We could relax this constraint
3212e8902a70Sdrh **        somewhat by saying that the terms of the ORDER BY clause must
3213630d296cSdrh **        appear as unmodified result columns in the outer query.  But we
3214e8902a70Sdrh **        have other optimizations in mind to deal with that case.
3215e8902a70Sdrh **
3216a91491e5Sshaneh **  (21)  The subquery does not use LIMIT or the outer query is not
3217a91491e5Sshaneh **        DISTINCT.  (See ticket [752e1646fc]).
3218a91491e5Sshaneh **
32198290c2adSdan **  (22)  The subquery is not a recursive CTE.
32208290c2adSdan **
32218290c2adSdan **  (23)  The parent is not a recursive CTE, or the sub-query is not a
32228290c2adSdan **        compound query. This restriction is because transforming the
32238290c2adSdan **        parent to a compound query confuses the code that handles
32248290c2adSdan **        recursive queries in multiSelect().
32258290c2adSdan **
32269588ad95Sdrh **  (24)  The subquery is not an aggregate that uses the built-in min() or
32279588ad95Sdrh **        or max() functions.  (Without this restriction, a query like:
32289588ad95Sdrh **        "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
32299588ad95Sdrh **        return the value X for which Y was maximal.)
32309588ad95Sdrh **
32318290c2adSdan **
3232832508b7Sdrh ** In this routine, the "p" parameter is a pointer to the outer query.
3233832508b7Sdrh ** The subquery is p->pSrc->a[iFrom].  isAgg is true if the outer query
3234832508b7Sdrh ** uses aggregates and subqueryIsAgg is true if the subquery uses aggregates.
3235832508b7Sdrh **
3236665de47aSdrh ** If flattening is not attempted, this routine is a no-op and returns 0.
3237832508b7Sdrh ** If flattening is attempted this routine returns 1.
3238832508b7Sdrh **
3239832508b7Sdrh ** All of the expression analysis must occur on both the outer query and
3240832508b7Sdrh ** the subquery before this routine runs.
32411350b030Sdrh */
32428c74a8caSdrh static int flattenSubquery(
3243524cc21eSdanielk1977   Parse *pParse,       /* Parsing context */
32448c74a8caSdrh   Select *p,           /* The parent or outer SELECT statement */
32458c74a8caSdrh   int iFrom,           /* Index in p->pSrc->a[] of the inner subquery */
32468c74a8caSdrh   int isAgg,           /* True if outer SELECT uses aggregate functions */
32478c74a8caSdrh   int subqueryIsAgg    /* True if the subquery uses aggregate functions */
32488c74a8caSdrh ){
3249524cc21eSdanielk1977   const char *zSavedAuthContext = pParse->zAuthContext;
3250f23329a2Sdanielk1977   Select *pParent;
32510bb28106Sdrh   Select *pSub;       /* The inner query or "subquery" */
3252f23329a2Sdanielk1977   Select *pSub1;      /* Pointer to the rightmost select in sub-query */
3253ad3cab52Sdrh   SrcList *pSrc;      /* The FROM clause of the outer query */
3254ad3cab52Sdrh   SrcList *pSubSrc;   /* The FROM clause of the subquery */
32550bb28106Sdrh   ExprList *pList;    /* The result set of the outer query */
32566a3ea0e6Sdrh   int iParent;        /* VDBE cursor number of the pSub result set temp table */
325791bb0eedSdrh   int i;              /* Loop counter */
325891bb0eedSdrh   Expr *pWhere;                    /* The WHERE clause */
325991bb0eedSdrh   struct SrcList_item *pSubitem;   /* The subquery */
3260524cc21eSdanielk1977   sqlite3 *db = pParse->db;
32611350b030Sdrh 
3262832508b7Sdrh   /* Check to see if flattening is permitted.  Return 0 if not.
3263832508b7Sdrh   */
3264a78c22c4Sdrh   assert( p!=0 );
3265a78c22c4Sdrh   assert( p->pPrior==0 );  /* Unable to flatten compound queries */
32667e5418e4Sdrh   if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
3267832508b7Sdrh   pSrc = p->pSrc;
3268ad3cab52Sdrh   assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
326991bb0eedSdrh   pSubitem = &pSrc->a[iFrom];
327049fc1f60Sdanielk1977   iParent = pSubitem->iCursor;
327191bb0eedSdrh   pSub = pSubitem->pSelect;
3272832508b7Sdrh   assert( pSub!=0 );
3273ac83963aSdrh   if( isAgg && subqueryIsAgg ) return 0;                 /* Restriction (1)  */
3274ac83963aSdrh   if( subqueryIsAgg && pSrc->nSrc>1 ) return 0;          /* Restriction (2)  */
3275832508b7Sdrh   pSubSrc = pSub->pSrc;
3276832508b7Sdrh   assert( pSubSrc );
3277ac83963aSdrh   /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
327860ec914cSpeter.d.reid   ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
3279ac83963aSdrh   ** because they could be computed at compile-time.  But when LIMIT and OFFSET
3280ac83963aSdrh   ** became arbitrary expressions, we were forced to add restrictions (13)
3281ac83963aSdrh   ** and (14). */
3282ac83963aSdrh   if( pSub->pLimit && p->pLimit ) return 0;              /* Restriction (13) */
3283ac83963aSdrh   if( pSub->pOffset ) return 0;                          /* Restriction (14) */
3284d227a291Sdrh   if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
3285ad91c6cdSdrh     return 0;                                            /* Restriction (15) */
3286ad91c6cdSdrh   }
3287ac83963aSdrh   if( pSubSrc->nSrc==0 ) return 0;                       /* Restriction (7)  */
328849ad330dSdan   if( pSub->selFlags & SF_Distinct ) return 0;           /* Restriction (5)  */
328949ad330dSdan   if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
329049ad330dSdan      return 0;         /* Restrictions (8)(9) */
3291df199a25Sdrh   }
32927d10d5a6Sdrh   if( (p->selFlags & SF_Distinct)!=0 && subqueryIsAgg ){
32937d10d5a6Sdrh      return 0;         /* Restriction (6)  */
32947d10d5a6Sdrh   }
32957d10d5a6Sdrh   if( p->pOrderBy && pSub->pOrderBy ){
3296ac83963aSdrh      return 0;                                           /* Restriction (11) */
3297ac83963aSdrh   }
3298c52e355dSdrh   if( isAgg && pSub->pOrderBy ) return 0;                /* Restriction (16) */
3299229cf702Sdrh   if( pSub->pLimit && p->pWhere ) return 0;              /* Restriction (19) */
3300a91491e5Sshaneh   if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
3301a91491e5Sshaneh      return 0;         /* Restriction (21) */
3302a91491e5Sshaneh   }
33039588ad95Sdrh   testcase( pSub->selFlags & SF_Recursive );
33049588ad95Sdrh   testcase( pSub->selFlags & SF_MinMaxAgg );
33059588ad95Sdrh   if( pSub->selFlags & (SF_Recursive|SF_MinMaxAgg) ){
33069588ad95Sdrh     return 0; /* Restrictions (22) and (24) */
33079588ad95Sdrh   }
33089588ad95Sdrh   if( (p->selFlags & SF_Recursive) && pSub->pPrior ){
33099588ad95Sdrh     return 0; /* Restriction (23) */
33109588ad95Sdrh   }
3311832508b7Sdrh 
33122b300d5dSdrh   /* OBSOLETE COMMENT 1:
33132b300d5dSdrh   ** Restriction 3:  If the subquery is a join, make sure the subquery is
33148af4d3acSdrh   ** not used as the right operand of an outer join.  Examples of why this
33158af4d3acSdrh   ** is not allowed:
33168af4d3acSdrh   **
33178af4d3acSdrh   **         t1 LEFT OUTER JOIN (t2 JOIN t3)
33188af4d3acSdrh   **
33198af4d3acSdrh   ** If we flatten the above, we would get
33208af4d3acSdrh   **
33218af4d3acSdrh   **         (t1 LEFT OUTER JOIN t2) JOIN t3
33228af4d3acSdrh   **
33238af4d3acSdrh   ** which is not at all the same thing.
33242b300d5dSdrh   **
33252b300d5dSdrh   ** OBSOLETE COMMENT 2:
33262b300d5dSdrh   ** Restriction 12:  If the subquery is the right operand of a left outer
33273fc673e6Sdrh   ** join, make sure the subquery has no WHERE clause.
33283fc673e6Sdrh   ** An examples of why this is not allowed:
33293fc673e6Sdrh   **
33303fc673e6Sdrh   **         t1 LEFT OUTER JOIN (SELECT * FROM t2 WHERE t2.x>0)
33313fc673e6Sdrh   **
33323fc673e6Sdrh   ** If we flatten the above, we would get
33333fc673e6Sdrh   **
33343fc673e6Sdrh   **         (t1 LEFT OUTER JOIN t2) WHERE t2.x>0
33353fc673e6Sdrh   **
33363fc673e6Sdrh   ** But the t2.x>0 test will always fail on a NULL row of t2, which
33373fc673e6Sdrh   ** effectively converts the OUTER JOIN into an INNER JOIN.
33382b300d5dSdrh   **
33392b300d5dSdrh   ** THIS OVERRIDES OBSOLETE COMMENTS 1 AND 2 ABOVE:
33402b300d5dSdrh   ** Ticket #3300 shows that flattening the right term of a LEFT JOIN
33412b300d5dSdrh   ** is fraught with danger.  Best to avoid the whole thing.  If the
33422b300d5dSdrh   ** subquery is the right term of a LEFT JOIN, then do not flatten.
33433fc673e6Sdrh   */
33442b300d5dSdrh   if( (pSubitem->jointype & JT_OUTER)!=0 ){
33453fc673e6Sdrh     return 0;
33463fc673e6Sdrh   }
33473fc673e6Sdrh 
3348f23329a2Sdanielk1977   /* Restriction 17: If the sub-query is a compound SELECT, then it must
3349f23329a2Sdanielk1977   ** use only the UNION ALL operator. And none of the simple select queries
3350f23329a2Sdanielk1977   ** that make up the compound SELECT are allowed to be aggregate or distinct
3351f23329a2Sdanielk1977   ** queries.
3352f23329a2Sdanielk1977   */
3353f23329a2Sdanielk1977   if( pSub->pPrior ){
3354e8902a70Sdrh     if( pSub->pOrderBy ){
3355e8902a70Sdrh       return 0;  /* Restriction 20 */
3356e8902a70Sdrh     }
3357e2f02bacSdrh     if( isAgg || (p->selFlags & SF_Distinct)!=0 || pSrc->nSrc!=1 ){
3358f23329a2Sdanielk1977       return 0;
3359f23329a2Sdanielk1977     }
3360f23329a2Sdanielk1977     for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
3361ccfcbceaSdrh       testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
3362ccfcbceaSdrh       testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
33634b3ac73cSdrh       assert( pSub->pSrc!=0 );
33647d10d5a6Sdrh       if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0
336580b3c548Sdanielk1977        || (pSub1->pPrior && pSub1->op!=TK_ALL)
33664b3ac73cSdrh        || pSub1->pSrc->nSrc<1
336767c70142Sdan        || pSub->pEList->nExpr!=pSub1->pEList->nExpr
336880b3c548Sdanielk1977       ){
3369f23329a2Sdanielk1977         return 0;
3370f23329a2Sdanielk1977       }
33714b3ac73cSdrh       testcase( pSub1->pSrc->nSrc>1 );
3372f23329a2Sdanielk1977     }
337349fc1f60Sdanielk1977 
337449fc1f60Sdanielk1977     /* Restriction 18. */
337549fc1f60Sdanielk1977     if( p->pOrderBy ){
337649fc1f60Sdanielk1977       int ii;
337749fc1f60Sdanielk1977       for(ii=0; ii<p->pOrderBy->nExpr; ii++){
3378c2acc4e4Sdrh         if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
337949fc1f60Sdanielk1977       }
338049fc1f60Sdanielk1977     }
3381f23329a2Sdanielk1977   }
3382f23329a2Sdanielk1977 
33837d10d5a6Sdrh   /***** If we reach this point, flattening is permitted. *****/
3384eb9b884cSdrh   SELECTTRACE(1,pParse,p,("flatten %s.%p from term %d\n",
3385eb9b884cSdrh                    pSub->zSelName, pSub, iFrom));
33867d10d5a6Sdrh 
33877d10d5a6Sdrh   /* Authorize the subquery */
3388524cc21eSdanielk1977   pParse->zAuthContext = pSubitem->zName;
3389a2acb0d7Sdrh   TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
3390a2acb0d7Sdrh   testcase( i==SQLITE_DENY );
3391524cc21eSdanielk1977   pParse->zAuthContext = zSavedAuthContext;
3392524cc21eSdanielk1977 
33937d10d5a6Sdrh   /* If the sub-query is a compound SELECT statement, then (by restrictions
33947d10d5a6Sdrh   ** 17 and 18 above) it must be a UNION ALL and the parent query must
33957d10d5a6Sdrh   ** be of the form:
3396f23329a2Sdanielk1977   **
3397f23329a2Sdanielk1977   **     SELECT <expr-list> FROM (<sub-query>) <where-clause>
3398f23329a2Sdanielk1977   **
3399f23329a2Sdanielk1977   ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
3400a78c22c4Sdrh   ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
3401f23329a2Sdanielk1977   ** OFFSET clauses and joins them to the left-hand-side of the original
3402f23329a2Sdanielk1977   ** using UNION ALL operators. In this case N is the number of simple
3403f23329a2Sdanielk1977   ** select statements in the compound sub-query.
3404a78c22c4Sdrh   **
3405a78c22c4Sdrh   ** Example:
3406a78c22c4Sdrh   **
3407a78c22c4Sdrh   **     SELECT a+1 FROM (
3408a78c22c4Sdrh   **        SELECT x FROM tab
3409a78c22c4Sdrh   **        UNION ALL
3410a78c22c4Sdrh   **        SELECT y FROM tab
3411a78c22c4Sdrh   **        UNION ALL
3412a78c22c4Sdrh   **        SELECT abs(z*2) FROM tab2
3413a78c22c4Sdrh   **     ) WHERE a!=5 ORDER BY 1
3414a78c22c4Sdrh   **
3415a78c22c4Sdrh   ** Transformed into:
3416a78c22c4Sdrh   **
3417a78c22c4Sdrh   **     SELECT x+1 FROM tab WHERE x+1!=5
3418a78c22c4Sdrh   **     UNION ALL
3419a78c22c4Sdrh   **     SELECT y+1 FROM tab WHERE y+1!=5
3420a78c22c4Sdrh   **     UNION ALL
3421a78c22c4Sdrh   **     SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
3422a78c22c4Sdrh   **     ORDER BY 1
3423a78c22c4Sdrh   **
3424a78c22c4Sdrh   ** We call this the "compound-subquery flattening".
3425f23329a2Sdanielk1977   */
3426f23329a2Sdanielk1977   for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
3427f23329a2Sdanielk1977     Select *pNew;
3428f23329a2Sdanielk1977     ExprList *pOrderBy = p->pOrderBy;
34294b86ef1dSdanielk1977     Expr *pLimit = p->pLimit;
3430547180baSdrh     Expr *pOffset = p->pOffset;
3431f23329a2Sdanielk1977     Select *pPrior = p->pPrior;
3432f23329a2Sdanielk1977     p->pOrderBy = 0;
3433f23329a2Sdanielk1977     p->pSrc = 0;
3434f23329a2Sdanielk1977     p->pPrior = 0;
34354b86ef1dSdanielk1977     p->pLimit = 0;
3436547180baSdrh     p->pOffset = 0;
34376ab3a2ecSdanielk1977     pNew = sqlite3SelectDup(db, p, 0);
3438eb9b884cSdrh     sqlite3SelectSetName(pNew, pSub->zSelName);
3439547180baSdrh     p->pOffset = pOffset;
34404b86ef1dSdanielk1977     p->pLimit = pLimit;
3441a78c22c4Sdrh     p->pOrderBy = pOrderBy;
3442a78c22c4Sdrh     p->pSrc = pSrc;
3443a78c22c4Sdrh     p->op = TK_ALL;
3444a78c22c4Sdrh     if( pNew==0 ){
3445d227a291Sdrh       p->pPrior = pPrior;
3446a78c22c4Sdrh     }else{
3447a78c22c4Sdrh       pNew->pPrior = pPrior;
3448d227a291Sdrh       if( pPrior ) pPrior->pNext = pNew;
3449d227a291Sdrh       pNew->pNext = p;
3450a78c22c4Sdrh       p->pPrior = pNew;
3451eb9b884cSdrh       SELECTTRACE(2,pParse,p,
3452eb9b884cSdrh          ("compound-subquery flattener creates %s.%p as peer\n",
3453eb9b884cSdrh          pNew->zSelName, pNew));
3454d227a291Sdrh     }
3455a78c22c4Sdrh     if( db->mallocFailed ) return 1;
3456a78c22c4Sdrh   }
3457f23329a2Sdanielk1977 
34587d10d5a6Sdrh   /* Begin flattening the iFrom-th entry of the FROM clause
34597d10d5a6Sdrh   ** in the outer query.
3460832508b7Sdrh   */
3461f23329a2Sdanielk1977   pSub = pSub1 = pSubitem->pSelect;
3462c31c2eb8Sdrh 
3463a78c22c4Sdrh   /* Delete the transient table structure associated with the
3464a78c22c4Sdrh   ** subquery
3465a78c22c4Sdrh   */
3466a78c22c4Sdrh   sqlite3DbFree(db, pSubitem->zDatabase);
3467a78c22c4Sdrh   sqlite3DbFree(db, pSubitem->zName);
3468a78c22c4Sdrh   sqlite3DbFree(db, pSubitem->zAlias);
3469a78c22c4Sdrh   pSubitem->zDatabase = 0;
3470a78c22c4Sdrh   pSubitem->zName = 0;
3471a78c22c4Sdrh   pSubitem->zAlias = 0;
3472a78c22c4Sdrh   pSubitem->pSelect = 0;
3473a78c22c4Sdrh 
3474a78c22c4Sdrh   /* Defer deleting the Table object associated with the
3475a78c22c4Sdrh   ** subquery until code generation is
3476a78c22c4Sdrh   ** complete, since there may still exist Expr.pTab entries that
3477a78c22c4Sdrh   ** refer to the subquery even after flattening.  Ticket #3346.
3478ccfcbceaSdrh   **
3479ccfcbceaSdrh   ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
3480a78c22c4Sdrh   */
3481ccfcbceaSdrh   if( ALWAYS(pSubitem->pTab!=0) ){
3482a78c22c4Sdrh     Table *pTabToDel = pSubitem->pTab;
3483a78c22c4Sdrh     if( pTabToDel->nRef==1 ){
348465a7cd16Sdan       Parse *pToplevel = sqlite3ParseToplevel(pParse);
348565a7cd16Sdan       pTabToDel->pNextZombie = pToplevel->pZombieTab;
348665a7cd16Sdan       pToplevel->pZombieTab = pTabToDel;
3487a78c22c4Sdrh     }else{
3488a78c22c4Sdrh       pTabToDel->nRef--;
3489a78c22c4Sdrh     }
3490a78c22c4Sdrh     pSubitem->pTab = 0;
3491a78c22c4Sdrh   }
3492a78c22c4Sdrh 
3493a78c22c4Sdrh   /* The following loop runs once for each term in a compound-subquery
3494a78c22c4Sdrh   ** flattening (as described above).  If we are doing a different kind
3495a78c22c4Sdrh   ** of flattening - a flattening other than a compound-subquery flattening -
3496a78c22c4Sdrh   ** then this loop only runs once.
3497a78c22c4Sdrh   **
3498a78c22c4Sdrh   ** This loop moves all of the FROM elements of the subquery into the
3499c31c2eb8Sdrh   ** the FROM clause of the outer query.  Before doing this, remember
3500c31c2eb8Sdrh   ** the cursor number for the original outer query FROM element in
3501c31c2eb8Sdrh   ** iParent.  The iParent cursor will never be used.  Subsequent code
3502c31c2eb8Sdrh   ** will scan expressions looking for iParent references and replace
3503c31c2eb8Sdrh   ** those references with expressions that resolve to the subquery FROM
3504c31c2eb8Sdrh   ** elements we are now copying in.
3505c31c2eb8Sdrh   */
3506a78c22c4Sdrh   for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
3507a78c22c4Sdrh     int nSubSrc;
3508ea678832Sdrh     u8 jointype = 0;
3509a78c22c4Sdrh     pSubSrc = pSub->pSrc;     /* FROM clause of subquery */
3510a78c22c4Sdrh     nSubSrc = pSubSrc->nSrc;  /* Number of terms in subquery FROM clause */
3511a78c22c4Sdrh     pSrc = pParent->pSrc;     /* FROM clause of the outer query */
3512588a9a1aSdrh 
3513a78c22c4Sdrh     if( pSrc ){
3514a78c22c4Sdrh       assert( pParent==p );  /* First time through the loop */
3515a78c22c4Sdrh       jointype = pSubitem->jointype;
3516588a9a1aSdrh     }else{
3517a78c22c4Sdrh       assert( pParent!=p );  /* 2nd and subsequent times through the loop */
3518a78c22c4Sdrh       pSrc = pParent->pSrc = sqlite3SrcListAppend(db, 0, 0, 0);
3519cfa063b3Sdrh       if( pSrc==0 ){
3520a78c22c4Sdrh         assert( db->mallocFailed );
3521a78c22c4Sdrh         break;
3522cfa063b3Sdrh       }
3523c31c2eb8Sdrh     }
3524a78c22c4Sdrh 
3525a78c22c4Sdrh     /* The subquery uses a single slot of the FROM clause of the outer
3526a78c22c4Sdrh     ** query.  If the subquery has more than one element in its FROM clause,
3527a78c22c4Sdrh     ** then expand the outer query to make space for it to hold all elements
3528a78c22c4Sdrh     ** of the subquery.
3529a78c22c4Sdrh     **
3530a78c22c4Sdrh     ** Example:
3531a78c22c4Sdrh     **
3532a78c22c4Sdrh     **    SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
3533a78c22c4Sdrh     **
3534a78c22c4Sdrh     ** The outer query has 3 slots in its FROM clause.  One slot of the
3535a78c22c4Sdrh     ** outer query (the middle slot) is used by the subquery.  The next
3536a78c22c4Sdrh     ** block of code will expand the out query to 4 slots.  The middle
3537a78c22c4Sdrh     ** slot is expanded to two slots in order to make space for the
3538a78c22c4Sdrh     ** two elements in the FROM clause of the subquery.
3539a78c22c4Sdrh     */
3540a78c22c4Sdrh     if( nSubSrc>1 ){
3541a78c22c4Sdrh       pParent->pSrc = pSrc = sqlite3SrcListEnlarge(db, pSrc, nSubSrc-1,iFrom+1);
3542a78c22c4Sdrh       if( db->mallocFailed ){
3543a78c22c4Sdrh         break;
3544c31c2eb8Sdrh       }
3545c31c2eb8Sdrh     }
3546a78c22c4Sdrh 
3547a78c22c4Sdrh     /* Transfer the FROM clause terms from the subquery into the
3548a78c22c4Sdrh     ** outer query.
3549a78c22c4Sdrh     */
3550c31c2eb8Sdrh     for(i=0; i<nSubSrc; i++){
3551c3a8402aSdrh       sqlite3IdListDelete(db, pSrc->a[i+iFrom].pUsing);
3552c31c2eb8Sdrh       pSrc->a[i+iFrom] = pSubSrc->a[i];
3553c31c2eb8Sdrh       memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
3554c31c2eb8Sdrh     }
355561dfc31dSdrh     pSrc->a[iFrom].jointype = jointype;
3556c31c2eb8Sdrh 
3557c31c2eb8Sdrh     /* Now begin substituting subquery result set expressions for
3558c31c2eb8Sdrh     ** references to the iParent in the outer query.
3559c31c2eb8Sdrh     **
3560c31c2eb8Sdrh     ** Example:
3561c31c2eb8Sdrh     **
3562c31c2eb8Sdrh     **   SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
3563c31c2eb8Sdrh     **   \                     \_____________ subquery __________/          /
3564c31c2eb8Sdrh     **    \_____________________ outer query ______________________________/
3565c31c2eb8Sdrh     **
3566c31c2eb8Sdrh     ** We look at every expression in the outer query and every place we see
3567c31c2eb8Sdrh     ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
3568c31c2eb8Sdrh     */
3569f23329a2Sdanielk1977     pList = pParent->pEList;
3570832508b7Sdrh     for(i=0; i<pList->nExpr; i++){
3571ccfcbceaSdrh       if( pList->a[i].zName==0 ){
357242fbf321Sdrh         char *zName = sqlite3DbStrDup(db, pList->a[i].zSpan);
357342fbf321Sdrh         sqlite3Dequote(zName);
357442fbf321Sdrh         pList->a[i].zName = zName;
3575832508b7Sdrh       }
3576ccfcbceaSdrh     }
3577f23329a2Sdanielk1977     substExprList(db, pParent->pEList, iParent, pSub->pEList);
35781b2e0329Sdrh     if( isAgg ){
3579f23329a2Sdanielk1977       substExprList(db, pParent->pGroupBy, iParent, pSub->pEList);
3580b7916a78Sdrh       pParent->pHaving = substExpr(db, pParent->pHaving, iParent, pSub->pEList);
35811b2e0329Sdrh     }
3582174b6195Sdrh     if( pSub->pOrderBy ){
35837c0a4720Sdan       /* At this point, any non-zero iOrderByCol values indicate that the
35847c0a4720Sdan       ** ORDER BY column expression is identical to the iOrderByCol'th
35857c0a4720Sdan       ** expression returned by SELECT statement pSub. Since these values
35867c0a4720Sdan       ** do not necessarily correspond to columns in SELECT statement pParent,
35877c0a4720Sdan       ** zero them before transfering the ORDER BY clause.
35887c0a4720Sdan       **
35897c0a4720Sdan       ** Not doing this may cause an error if a subsequent call to this
35907c0a4720Sdan       ** function attempts to flatten a compound sub-query into pParent
35917c0a4720Sdan       ** (the only way this can happen is if the compound sub-query is
35927c0a4720Sdan       ** currently part of pSub->pSrc). See ticket [d11a6e908f].  */
35937c0a4720Sdan       ExprList *pOrderBy = pSub->pOrderBy;
35947c0a4720Sdan       for(i=0; i<pOrderBy->nExpr; i++){
35957c0a4720Sdan         pOrderBy->a[i].u.x.iOrderByCol = 0;
35967c0a4720Sdan       }
3597f23329a2Sdanielk1977       assert( pParent->pOrderBy==0 );
35987c0a4720Sdan       assert( pSub->pPrior==0 );
35997c0a4720Sdan       pParent->pOrderBy = pOrderBy;
3600174b6195Sdrh       pSub->pOrderBy = 0;
3601f23329a2Sdanielk1977     }else if( pParent->pOrderBy ){
3602f23329a2Sdanielk1977       substExprList(db, pParent->pOrderBy, iParent, pSub->pEList);
3603174b6195Sdrh     }
3604832508b7Sdrh     if( pSub->pWhere ){
36056ab3a2ecSdanielk1977       pWhere = sqlite3ExprDup(db, pSub->pWhere, 0);
3606832508b7Sdrh     }else{
3607832508b7Sdrh       pWhere = 0;
3608832508b7Sdrh     }
3609832508b7Sdrh     if( subqueryIsAgg ){
3610f23329a2Sdanielk1977       assert( pParent->pHaving==0 );
3611f23329a2Sdanielk1977       pParent->pHaving = pParent->pWhere;
3612f23329a2Sdanielk1977       pParent->pWhere = pWhere;
3613b7916a78Sdrh       pParent->pHaving = substExpr(db, pParent->pHaving, iParent, pSub->pEList);
3614f23329a2Sdanielk1977       pParent->pHaving = sqlite3ExprAnd(db, pParent->pHaving,
36156ab3a2ecSdanielk1977                                   sqlite3ExprDup(db, pSub->pHaving, 0));
3616f23329a2Sdanielk1977       assert( pParent->pGroupBy==0 );
36176ab3a2ecSdanielk1977       pParent->pGroupBy = sqlite3ExprListDup(db, pSub->pGroupBy, 0);
3618832508b7Sdrh     }else{
3619b7916a78Sdrh       pParent->pWhere = substExpr(db, pParent->pWhere, iParent, pSub->pEList);
3620f23329a2Sdanielk1977       pParent->pWhere = sqlite3ExprAnd(db, pParent->pWhere, pWhere);
3621832508b7Sdrh     }
3622c31c2eb8Sdrh 
3623c31c2eb8Sdrh     /* The flattened query is distinct if either the inner or the
3624c31c2eb8Sdrh     ** outer query is distinct.
3625c31c2eb8Sdrh     */
36267d10d5a6Sdrh     pParent->selFlags |= pSub->selFlags & SF_Distinct;
36278c74a8caSdrh 
3628a58fdfb1Sdanielk1977     /*
3629a58fdfb1Sdanielk1977     ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
3630ac83963aSdrh     **
3631ac83963aSdrh     ** One is tempted to try to add a and b to combine the limits.  But this
3632ac83963aSdrh     ** does not work if either limit is negative.
3633a58fdfb1Sdanielk1977     */
3634a2dc3b1aSdanielk1977     if( pSub->pLimit ){
3635f23329a2Sdanielk1977       pParent->pLimit = pSub->pLimit;
3636a2dc3b1aSdanielk1977       pSub->pLimit = 0;
3637df199a25Sdrh     }
3638f23329a2Sdanielk1977   }
36398c74a8caSdrh 
3640c31c2eb8Sdrh   /* Finially, delete what is left of the subquery and return
3641c31c2eb8Sdrh   ** success.
3642c31c2eb8Sdrh   */
3643633e6d57Sdrh   sqlite3SelectDelete(db, pSub1);
3644f23329a2Sdanielk1977 
3645832508b7Sdrh   return 1;
36461350b030Sdrh }
36473514b6f7Sshane #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
36481350b030Sdrh 
36491350b030Sdrh /*
36504ac391fcSdan ** Based on the contents of the AggInfo structure indicated by the first
36514ac391fcSdan ** argument, this function checks if the following are true:
3652a9d1ccb9Sdanielk1977 **
36534ac391fcSdan **    * the query contains just a single aggregate function,
36544ac391fcSdan **    * the aggregate function is either min() or max(), and
36554ac391fcSdan **    * the argument to the aggregate function is a column value.
3656738bdcfbSdanielk1977 **
36574ac391fcSdan ** If all of the above are true, then WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX
36584ac391fcSdan ** is returned as appropriate. Also, *ppMinMax is set to point to the
36594ac391fcSdan ** list of arguments passed to the aggregate before returning.
36604ac391fcSdan **
36614ac391fcSdan ** Or, if the conditions above are not met, *ppMinMax is set to 0 and
36624ac391fcSdan ** WHERE_ORDERBY_NORMAL is returned.
3663a9d1ccb9Sdanielk1977 */
36644ac391fcSdan static u8 minMaxQuery(AggInfo *pAggInfo, ExprList **ppMinMax){
36654ac391fcSdan   int eRet = WHERE_ORDERBY_NORMAL;          /* Return value */
3666a9d1ccb9Sdanielk1977 
36674ac391fcSdan   *ppMinMax = 0;
36684ac391fcSdan   if( pAggInfo->nFunc==1 ){
36694ac391fcSdan     Expr *pExpr = pAggInfo->aFunc[0].pExpr; /* Aggregate function */
36704ac391fcSdan     ExprList *pEList = pExpr->x.pList;      /* Arguments to agg function */
36714ac391fcSdan 
36724ac391fcSdan     assert( pExpr->op==TK_AGG_FUNCTION );
36734ac391fcSdan     if( pEList && pEList->nExpr==1 && pEList->a[0].pExpr->op==TK_AGG_COLUMN ){
36744ac391fcSdan       const char *zFunc = pExpr->u.zToken;
36754ac391fcSdan       if( sqlite3StrICmp(zFunc, "min")==0 ){
36764ac391fcSdan         eRet = WHERE_ORDERBY_MIN;
36774ac391fcSdan         *ppMinMax = pEList;
36784ac391fcSdan       }else if( sqlite3StrICmp(zFunc, "max")==0 ){
36794ac391fcSdan         eRet = WHERE_ORDERBY_MAX;
36804ac391fcSdan         *ppMinMax = pEList;
3681a9d1ccb9Sdanielk1977       }
36824ac391fcSdan     }
36834ac391fcSdan   }
36844ac391fcSdan 
36854ac391fcSdan   assert( *ppMinMax==0 || (*ppMinMax)->nExpr==1 );
36864ac391fcSdan   return eRet;
3687a9d1ccb9Sdanielk1977 }
3688a9d1ccb9Sdanielk1977 
3689a9d1ccb9Sdanielk1977 /*
3690a5533162Sdanielk1977 ** The select statement passed as the first argument is an aggregate query.
369160ec914cSpeter.d.reid ** The second argument is the associated aggregate-info object. This
3692a5533162Sdanielk1977 ** function tests if the SELECT is of the form:
3693a5533162Sdanielk1977 **
3694a5533162Sdanielk1977 **   SELECT count(*) FROM <tbl>
3695a5533162Sdanielk1977 **
3696a5533162Sdanielk1977 ** where table is a database table, not a sub-select or view. If the query
3697a5533162Sdanielk1977 ** does match this pattern, then a pointer to the Table object representing
3698a5533162Sdanielk1977 ** <tbl> is returned. Otherwise, 0 is returned.
3699a5533162Sdanielk1977 */
3700a5533162Sdanielk1977 static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
3701a5533162Sdanielk1977   Table *pTab;
3702a5533162Sdanielk1977   Expr *pExpr;
3703a5533162Sdanielk1977 
3704a5533162Sdanielk1977   assert( !p->pGroupBy );
3705a5533162Sdanielk1977 
37067a895a80Sdanielk1977   if( p->pWhere || p->pEList->nExpr!=1
3707a5533162Sdanielk1977    || p->pSrc->nSrc!=1 || p->pSrc->a[0].pSelect
3708a5533162Sdanielk1977   ){
3709a5533162Sdanielk1977     return 0;
3710a5533162Sdanielk1977   }
3711a5533162Sdanielk1977   pTab = p->pSrc->a[0].pTab;
3712a5533162Sdanielk1977   pExpr = p->pEList->a[0].pExpr;
371302f33725Sdanielk1977   assert( pTab && !pTab->pSelect && pExpr );
371402f33725Sdanielk1977 
371502f33725Sdanielk1977   if( IsVirtual(pTab) ) return 0;
3716a5533162Sdanielk1977   if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
3717fb0a6081Sdrh   if( NEVER(pAggInfo->nFunc==0) ) return 0;
3718d36e1041Sdrh   if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
3719a5533162Sdanielk1977   if( pExpr->flags&EP_Distinct ) return 0;
3720a5533162Sdanielk1977 
3721a5533162Sdanielk1977   return pTab;
3722a5533162Sdanielk1977 }
3723a5533162Sdanielk1977 
3724a5533162Sdanielk1977 /*
3725b1c685b0Sdanielk1977 ** If the source-list item passed as an argument was augmented with an
3726b1c685b0Sdanielk1977 ** INDEXED BY clause, then try to locate the specified index. If there
3727b1c685b0Sdanielk1977 ** was such a clause and the named index cannot be found, return
3728b1c685b0Sdanielk1977 ** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
3729b1c685b0Sdanielk1977 ** pFrom->pIndex and return SQLITE_OK.
3730b1c685b0Sdanielk1977 */
3731b1c685b0Sdanielk1977 int sqlite3IndexedByLookup(Parse *pParse, struct SrcList_item *pFrom){
3732b1c685b0Sdanielk1977   if( pFrom->pTab && pFrom->zIndex ){
3733b1c685b0Sdanielk1977     Table *pTab = pFrom->pTab;
3734b1c685b0Sdanielk1977     char *zIndex = pFrom->zIndex;
3735b1c685b0Sdanielk1977     Index *pIdx;
3736b1c685b0Sdanielk1977     for(pIdx=pTab->pIndex;
3737b1c685b0Sdanielk1977         pIdx && sqlite3StrICmp(pIdx->zName, zIndex);
3738b1c685b0Sdanielk1977         pIdx=pIdx->pNext
3739b1c685b0Sdanielk1977     );
3740b1c685b0Sdanielk1977     if( !pIdx ){
3741b1c685b0Sdanielk1977       sqlite3ErrorMsg(pParse, "no such index: %s", zIndex, 0);
37421db95106Sdan       pParse->checkSchema = 1;
3743b1c685b0Sdanielk1977       return SQLITE_ERROR;
3744b1c685b0Sdanielk1977     }
3745b1c685b0Sdanielk1977     pFrom->pIndex = pIdx;
3746b1c685b0Sdanielk1977   }
3747b1c685b0Sdanielk1977   return SQLITE_OK;
3748b1c685b0Sdanielk1977 }
3749c01b7306Sdrh /*
3750c01b7306Sdrh ** Detect compound SELECT statements that use an ORDER BY clause with
3751c01b7306Sdrh ** an alternative collating sequence.
3752c01b7306Sdrh **
3753c01b7306Sdrh **    SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
3754c01b7306Sdrh **
3755c01b7306Sdrh ** These are rewritten as a subquery:
3756c01b7306Sdrh **
3757c01b7306Sdrh **    SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
3758c01b7306Sdrh **     ORDER BY ... COLLATE ...
3759c01b7306Sdrh **
3760c01b7306Sdrh ** This transformation is necessary because the multiSelectOrderBy() routine
3761c01b7306Sdrh ** above that generates the code for a compound SELECT with an ORDER BY clause
3762c01b7306Sdrh ** uses a merge algorithm that requires the same collating sequence on the
3763c01b7306Sdrh ** result columns as on the ORDER BY clause.  See ticket
3764c01b7306Sdrh ** http://www.sqlite.org/src/info/6709574d2a
3765c01b7306Sdrh **
3766c01b7306Sdrh ** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
3767c01b7306Sdrh ** The UNION ALL operator works fine with multiSelectOrderBy() even when
3768c01b7306Sdrh ** there are COLLATE terms in the ORDER BY.
3769c01b7306Sdrh */
3770c01b7306Sdrh static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
3771c01b7306Sdrh   int i;
3772c01b7306Sdrh   Select *pNew;
3773c01b7306Sdrh   Select *pX;
3774c01b7306Sdrh   sqlite3 *db;
3775c01b7306Sdrh   struct ExprList_item *a;
3776c01b7306Sdrh   SrcList *pNewSrc;
3777c01b7306Sdrh   Parse *pParse;
3778c01b7306Sdrh   Token dummy;
3779c01b7306Sdrh 
3780c01b7306Sdrh   if( p->pPrior==0 ) return WRC_Continue;
3781c01b7306Sdrh   if( p->pOrderBy==0 ) return WRC_Continue;
3782c01b7306Sdrh   for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
3783c01b7306Sdrh   if( pX==0 ) return WRC_Continue;
3784c01b7306Sdrh   a = p->pOrderBy->a;
3785c01b7306Sdrh   for(i=p->pOrderBy->nExpr-1; i>=0; i--){
3786c01b7306Sdrh     if( a[i].pExpr->flags & EP_Collate ) break;
3787c01b7306Sdrh   }
3788c01b7306Sdrh   if( i<0 ) return WRC_Continue;
3789c01b7306Sdrh 
3790c01b7306Sdrh   /* If we reach this point, that means the transformation is required. */
3791c01b7306Sdrh 
3792c01b7306Sdrh   pParse = pWalker->pParse;
3793c01b7306Sdrh   db = pParse->db;
3794c01b7306Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
3795c01b7306Sdrh   if( pNew==0 ) return WRC_Abort;
3796c01b7306Sdrh   memset(&dummy, 0, sizeof(dummy));
3797c01b7306Sdrh   pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0,0);
3798c01b7306Sdrh   if( pNewSrc==0 ) return WRC_Abort;
3799c01b7306Sdrh   *pNew = *p;
3800c01b7306Sdrh   p->pSrc = pNewSrc;
3801c01b7306Sdrh   p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ALL, 0));
3802c01b7306Sdrh   p->op = TK_SELECT;
3803c01b7306Sdrh   p->pWhere = 0;
3804c01b7306Sdrh   pNew->pGroupBy = 0;
3805c01b7306Sdrh   pNew->pHaving = 0;
3806c01b7306Sdrh   pNew->pOrderBy = 0;
3807c01b7306Sdrh   p->pPrior = 0;
38088af9ad95Sdrh   p->pNext = 0;
38098af9ad95Sdrh   p->selFlags &= ~SF_Compound;
3810a6e3a8c9Sdrh   assert( pNew->pPrior!=0 );
3811a6e3a8c9Sdrh   pNew->pPrior->pNext = pNew;
3812c01b7306Sdrh   pNew->pLimit = 0;
3813c01b7306Sdrh   pNew->pOffset = 0;
3814c01b7306Sdrh   return WRC_Continue;
3815c01b7306Sdrh }
3816b1c685b0Sdanielk1977 
3817eede6a53Sdan #ifndef SQLITE_OMIT_CTE
3818eede6a53Sdan /*
3819eede6a53Sdan ** Argument pWith (which may be NULL) points to a linked list of nested
3820eede6a53Sdan ** WITH contexts, from inner to outermost. If the table identified by
3821eede6a53Sdan ** FROM clause element pItem is really a common-table-expression (CTE)
3822eede6a53Sdan ** then return a pointer to the CTE definition for that table. Otherwise
3823eede6a53Sdan ** return NULL.
382498f45e53Sdan **
382598f45e53Sdan ** If a non-NULL value is returned, set *ppContext to point to the With
382698f45e53Sdan ** object that the returned CTE belongs to.
382760c1a2f0Sdrh */
382898f45e53Sdan static struct Cte *searchWith(
382998f45e53Sdan   With *pWith,                    /* Current outermost WITH clause */
383098f45e53Sdan   struct SrcList_item *pItem,     /* FROM clause element to resolve */
383198f45e53Sdan   With **ppContext                /* OUT: WITH clause return value belongs to */
383298f45e53Sdan ){
38337b19f252Sdrh   const char *zName;
38347b19f252Sdrh   if( pItem->zDatabase==0 && (zName = pItem->zName)!=0 ){
3835eede6a53Sdan     With *p;
3836eede6a53Sdan     for(p=pWith; p; p=p->pOuter){
38374e9119d9Sdan       int i;
3838eede6a53Sdan       for(i=0; i<p->nCte; i++){
3839eede6a53Sdan         if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
384098f45e53Sdan           *ppContext = p;
3841eede6a53Sdan           return &p->a[i];
38424e9119d9Sdan         }
38434e9119d9Sdan       }
38444e9119d9Sdan     }
38454e9119d9Sdan   }
38464e9119d9Sdan   return 0;
38474e9119d9Sdan }
38484e9119d9Sdan 
3849c49832c2Sdrh /* The code generator maintains a stack of active WITH clauses
3850c49832c2Sdrh ** with the inner-most WITH clause being at the top of the stack.
3851c49832c2Sdrh **
3852b290f117Sdan ** This routine pushes the WITH clause passed as the second argument
3853b290f117Sdan ** onto the top of the stack. If argument bFree is true, then this
3854b290f117Sdan ** WITH clause will never be popped from the stack. In this case it
3855b290f117Sdan ** should be freed along with the Parse object. In other cases, when
3856b290f117Sdan ** bFree==0, the With object will be freed along with the SELECT
3857b290f117Sdan ** statement with which it is associated.
3858c49832c2Sdrh */
3859b290f117Sdan void sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
3860b290f117Sdan   assert( bFree==0 || pParse->pWith==0 );
38614e9119d9Sdan   if( pWith ){
38624e9119d9Sdan     pWith->pOuter = pParse->pWith;
38634e9119d9Sdan     pParse->pWith = pWith;
3864b290f117Sdan     pParse->bFreeWith = bFree;
38654e9119d9Sdan   }
38664e9119d9Sdan }
38674e9119d9Sdan 
3868eede6a53Sdan /*
3869eede6a53Sdan ** This function checks if argument pFrom refers to a CTE declared by
3870eede6a53Sdan ** a WITH clause on the stack currently maintained by the parser. And,
3871eede6a53Sdan ** if currently processing a CTE expression, if it is a recursive
3872eede6a53Sdan ** reference to the current CTE.
3873eede6a53Sdan **
3874eede6a53Sdan ** If pFrom falls into either of the two categories above, pFrom->pTab
3875eede6a53Sdan ** and other fields are populated accordingly. The caller should check
3876eede6a53Sdan ** (pFrom->pTab!=0) to determine whether or not a successful match
3877eede6a53Sdan ** was found.
3878eede6a53Sdan **
3879eede6a53Sdan ** Whether or not a match is found, SQLITE_OK is returned if no error
3880eede6a53Sdan ** occurs. If an error does occur, an error message is stored in the
3881eede6a53Sdan ** parser and some error code other than SQLITE_OK returned.
3882eede6a53Sdan */
38838ce7184bSdan static int withExpand(
38848ce7184bSdan   Walker *pWalker,
3885eede6a53Sdan   struct SrcList_item *pFrom
38868ce7184bSdan ){
38878ce7184bSdan   Parse *pParse = pWalker->pParse;
38888ce7184bSdan   sqlite3 *db = pParse->db;
388998f45e53Sdan   struct Cte *pCte;               /* Matched CTE (or NULL if no match) */
389098f45e53Sdan   With *pWith;                    /* WITH clause that pCte belongs to */
38918ce7184bSdan 
38928ce7184bSdan   assert( pFrom->pTab==0 );
38938ce7184bSdan 
389498f45e53Sdan   pCte = searchWith(pParse->pWith, pFrom, &pWith);
3895eae73fbfSdan   if( pCte ){
389698f45e53Sdan     Table *pTab;
38978ce7184bSdan     ExprList *pEList;
38988ce7184bSdan     Select *pSel;
389960e7068dSdan     Select *pLeft;                /* Left-most SELECT statement */
3900f2655fe8Sdan     int bMayRecursive;            /* True if compound joined by UNION [ALL] */
390198f45e53Sdan     With *pSavedWith;             /* Initial value of pParse->pWith */
3902f2655fe8Sdan 
3903f2655fe8Sdan     /* If pCte->zErr is non-NULL at this point, then this is an illegal
3904f2655fe8Sdan     ** recursive reference to CTE pCte. Leave an error in pParse and return
3905f2655fe8Sdan     ** early. If pCte->zErr is NULL, then this is not a recursive reference.
3906f2655fe8Sdan     ** In this case, proceed.  */
3907f2655fe8Sdan     if( pCte->zErr ){
3908f2655fe8Sdan       sqlite3ErrorMsg(pParse, pCte->zErr, pCte->zName);
390998f45e53Sdan       return SQLITE_ERROR;
3910f2655fe8Sdan     }
39118ce7184bSdan 
3912c25e2ebcSdrh     assert( pFrom->pTab==0 );
39138ce7184bSdan     pFrom->pTab = pTab = sqlite3DbMallocZero(db, sizeof(Table));
39148ce7184bSdan     if( pTab==0 ) return WRC_Abort;
39158ce7184bSdan     pTab->nRef = 1;
39162d4dc5fcSdan     pTab->zName = sqlite3DbStrDup(db, pCte->zName);
39178ce7184bSdan     pTab->iPKey = -1;
3918cfc9df76Sdan     pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
39198ce7184bSdan     pTab->tabFlags |= TF_Ephemeral;
39208ce7184bSdan     pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
39218ce7184bSdan     if( db->mallocFailed ) return SQLITE_NOMEM;
39228ce7184bSdan     assert( pFrom->pSelect );
39238ce7184bSdan 
3924eae73fbfSdan     /* Check if this is a recursive CTE. */
39258ce7184bSdan     pSel = pFrom->pSelect;
3926f2655fe8Sdan     bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
3927f2655fe8Sdan     if( bMayRecursive ){
3928eae73fbfSdan       int i;
3929eae73fbfSdan       SrcList *pSrc = pFrom->pSelect->pSrc;
3930eae73fbfSdan       for(i=0; i<pSrc->nSrc; i++){
3931eae73fbfSdan         struct SrcList_item *pItem = &pSrc->a[i];
3932eae73fbfSdan         if( pItem->zDatabase==0
3933eae73fbfSdan          && pItem->zName!=0
3934eae73fbfSdan          && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
3935eae73fbfSdan           ){
3936eae73fbfSdan           pItem->pTab = pTab;
3937eae73fbfSdan           pItem->isRecursive = 1;
3938eae73fbfSdan           pTab->nRef++;
3939eae73fbfSdan           pSel->selFlags |= SF_Recursive;
39408ce7184bSdan         }
3941eae73fbfSdan       }
3942eae73fbfSdan     }
3943eae73fbfSdan 
3944eae73fbfSdan     /* Only one recursive reference is permitted. */
3945eae73fbfSdan     if( pTab->nRef>2 ){
3946eae73fbfSdan       sqlite3ErrorMsg(
3947727a99f1Sdrh           pParse, "multiple references to recursive table: %s", pCte->zName
3948eae73fbfSdan       );
394998f45e53Sdan       return SQLITE_ERROR;
3950eae73fbfSdan     }
3951eae73fbfSdan     assert( pTab->nRef==1 || ((pSel->selFlags&SF_Recursive) && pTab->nRef==2 ));
3952eae73fbfSdan 
3953727a99f1Sdrh     pCte->zErr = "circular reference: %s";
395498f45e53Sdan     pSavedWith = pParse->pWith;
395598f45e53Sdan     pParse->pWith = pWith;
3956f2655fe8Sdan     sqlite3WalkSelect(pWalker, bMayRecursive ? pSel->pPrior : pSel);
39578ce7184bSdan 
39588ce7184bSdan     for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
39598ce7184bSdan     pEList = pLeft->pEList;
396060e7068dSdan     if( pCte->pCols ){
396160e7068dSdan       if( pEList->nExpr!=pCte->pCols->nExpr ){
3962727a99f1Sdrh         sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
396360e7068dSdan             pCte->zName, pEList->nExpr, pCte->pCols->nExpr
396460e7068dSdan         );
396598f45e53Sdan         pParse->pWith = pSavedWith;
396698f45e53Sdan         return SQLITE_ERROR;
39678ce7184bSdan       }
396860e7068dSdan       pEList = pCte->pCols;
396960e7068dSdan     }
39708ce7184bSdan 
397198f45e53Sdan     selectColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
3972f2655fe8Sdan     if( bMayRecursive ){
3973f2655fe8Sdan       if( pSel->selFlags & SF_Recursive ){
3974727a99f1Sdrh         pCte->zErr = "multiple recursive references: %s";
3975f2655fe8Sdan       }else{
3976727a99f1Sdrh         pCte->zErr = "recursive reference in a subquery: %s";
3977f2655fe8Sdan       }
3978f2655fe8Sdan       sqlite3WalkSelect(pWalker, pSel);
3979f2655fe8Sdan     }
3980f2655fe8Sdan     pCte->zErr = 0;
398198f45e53Sdan     pParse->pWith = pSavedWith;
39828ce7184bSdan   }
39838ce7184bSdan 
39848ce7184bSdan   return SQLITE_OK;
39858ce7184bSdan }
3986eede6a53Sdan #endif
39874e9119d9Sdan 
3988b290f117Sdan #ifndef SQLITE_OMIT_CTE
398971856944Sdan /*
399071856944Sdan ** If the SELECT passed as the second argument has an associated WITH
399171856944Sdan ** clause, pop it from the stack stored as part of the Parse object.
399271856944Sdan **
399371856944Sdan ** This function is used as the xSelectCallback2() callback by
399471856944Sdan ** sqlite3SelectExpand() when walking a SELECT tree to resolve table
399571856944Sdan ** names and other FROM clause elements.
399671856944Sdan */
3997b290f117Sdan static void selectPopWith(Walker *pWalker, Select *p){
3998b290f117Sdan   Parse *pParse = pWalker->pParse;
3999d227a291Sdrh   With *pWith = findRightmost(p)->pWith;
4000d227a291Sdrh   if( pWith!=0 ){
4001d227a291Sdrh     assert( pParse->pWith==pWith );
4002d227a291Sdrh     pParse->pWith = pWith->pOuter;
4003b290f117Sdan   }
4004b290f117Sdan }
4005b290f117Sdan #else
4006b290f117Sdan #define selectPopWith 0
4007b290f117Sdan #endif
4008b290f117Sdan 
4009b1c685b0Sdanielk1977 /*
40107d10d5a6Sdrh ** This routine is a Walker callback for "expanding" a SELECT statement.
40117d10d5a6Sdrh ** "Expanding" means to do the following:
40127d10d5a6Sdrh **
40137d10d5a6Sdrh **    (1)  Make sure VDBE cursor numbers have been assigned to every
40147d10d5a6Sdrh **         element of the FROM clause.
40157d10d5a6Sdrh **
40167d10d5a6Sdrh **    (2)  Fill in the pTabList->a[].pTab fields in the SrcList that
40177d10d5a6Sdrh **         defines FROM clause.  When views appear in the FROM clause,
40187d10d5a6Sdrh **         fill pTabList->a[].pSelect with a copy of the SELECT statement
40197d10d5a6Sdrh **         that implements the view.  A copy is made of the view's SELECT
40207d10d5a6Sdrh **         statement so that we can freely modify or delete that statement
402160ec914cSpeter.d.reid **         without worrying about messing up the persistent representation
40227d10d5a6Sdrh **         of the view.
40237d10d5a6Sdrh **
402460ec914cSpeter.d.reid **    (3)  Add terms to the WHERE clause to accommodate the NATURAL keyword
40257d10d5a6Sdrh **         on joins and the ON and USING clause of joins.
40267d10d5a6Sdrh **
40277d10d5a6Sdrh **    (4)  Scan the list of columns in the result set (pEList) looking
40287d10d5a6Sdrh **         for instances of the "*" operator or the TABLE.* operator.
40297d10d5a6Sdrh **         If found, expand each "*" to be every column in every table
40307d10d5a6Sdrh **         and TABLE.* to be every column in TABLE.
40317d10d5a6Sdrh **
4032b3bce662Sdanielk1977 */
40337d10d5a6Sdrh static int selectExpander(Walker *pWalker, Select *p){
40347d10d5a6Sdrh   Parse *pParse = pWalker->pParse;
40357d10d5a6Sdrh   int i, j, k;
40367d10d5a6Sdrh   SrcList *pTabList;
40377d10d5a6Sdrh   ExprList *pEList;
40387d10d5a6Sdrh   struct SrcList_item *pFrom;
40397d10d5a6Sdrh   sqlite3 *db = pParse->db;
40403e3f1a5bSdrh   Expr *pE, *pRight, *pExpr;
4041785097daSdrh   u16 selFlags = p->selFlags;
40427d10d5a6Sdrh 
4043785097daSdrh   p->selFlags |= SF_Expanded;
40447d10d5a6Sdrh   if( db->mallocFailed  ){
40457d10d5a6Sdrh     return WRC_Abort;
40467d10d5a6Sdrh   }
4047785097daSdrh   if( NEVER(p->pSrc==0) || (selFlags & SF_Expanded)!=0 ){
40487d10d5a6Sdrh     return WRC_Prune;
40497d10d5a6Sdrh   }
40507d10d5a6Sdrh   pTabList = p->pSrc;
40517d10d5a6Sdrh   pEList = p->pEList;
4052d227a291Sdrh   sqlite3WithPush(pParse, findRightmost(p)->pWith, 0);
40537d10d5a6Sdrh 
40547d10d5a6Sdrh   /* Make sure cursor numbers have been assigned to all entries in
40557d10d5a6Sdrh   ** the FROM clause of the SELECT statement.
40567d10d5a6Sdrh   */
40577d10d5a6Sdrh   sqlite3SrcListAssignCursors(pParse, pTabList);
40587d10d5a6Sdrh 
40597d10d5a6Sdrh   /* Look up every table named in the FROM clause of the select.  If
40607d10d5a6Sdrh   ** an entry of the FROM clause is a subquery instead of a table or view,
40617d10d5a6Sdrh   ** then create a transient table structure to describe the subquery.
40627d10d5a6Sdrh   */
40637d10d5a6Sdrh   for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
40647d10d5a6Sdrh     Table *pTab;
4065eae73fbfSdan     assert( pFrom->isRecursive==0 || pFrom->pTab );
4066eae73fbfSdan     if( pFrom->isRecursive ) continue;
40677d10d5a6Sdrh     if( pFrom->pTab!=0 ){
40687d10d5a6Sdrh       /* This statement has already been prepared.  There is no need
40697d10d5a6Sdrh       ** to go further. */
40707d10d5a6Sdrh       assert( i==0 );
4071b290f117Sdan #ifndef SQLITE_OMIT_CTE
4072b290f117Sdan       selectPopWith(pWalker, p);
4073b290f117Sdan #endif
40747d10d5a6Sdrh       return WRC_Prune;
40757d10d5a6Sdrh     }
40764e9119d9Sdan #ifndef SQLITE_OMIT_CTE
4077eede6a53Sdan     if( withExpand(pWalker, pFrom) ) return WRC_Abort;
4078eede6a53Sdan     if( pFrom->pTab ) {} else
40794e9119d9Sdan #endif
40807d10d5a6Sdrh     if( pFrom->zName==0 ){
40817d10d5a6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
40827d10d5a6Sdrh       Select *pSel = pFrom->pSelect;
40837d10d5a6Sdrh       /* A sub-query in the FROM clause of a SELECT */
40847d10d5a6Sdrh       assert( pSel!=0 );
40857d10d5a6Sdrh       assert( pFrom->pTab==0 );
40867d10d5a6Sdrh       sqlite3WalkSelect(pWalker, pSel);
40877d10d5a6Sdrh       pFrom->pTab = pTab = sqlite3DbMallocZero(db, sizeof(Table));
40887d10d5a6Sdrh       if( pTab==0 ) return WRC_Abort;
40897d10d5a6Sdrh       pTab->nRef = 1;
4090186ad8ccSdrh       pTab->zName = sqlite3MPrintf(db, "sqlite_sq_%p", (void*)pTab);
40917d10d5a6Sdrh       while( pSel->pPrior ){ pSel = pSel->pPrior; }
40927d10d5a6Sdrh       selectColumnsFromExprList(pParse, pSel->pEList, &pTab->nCol, &pTab->aCol);
40937d10d5a6Sdrh       pTab->iPKey = -1;
4094cfc9df76Sdan       pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
40957d10d5a6Sdrh       pTab->tabFlags |= TF_Ephemeral;
40967d10d5a6Sdrh #endif
40977d10d5a6Sdrh     }else{
40987d10d5a6Sdrh       /* An ordinary table or view name in the FROM clause */
40997d10d5a6Sdrh       assert( pFrom->pTab==0 );
410041fb5cd1Sdan       pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
41017d10d5a6Sdrh       if( pTab==0 ) return WRC_Abort;
4102d2a56238Sdrh       if( pTab->nRef==0xffff ){
4103d2a56238Sdrh         sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
4104d2a56238Sdrh            pTab->zName);
4105d2a56238Sdrh         pFrom->pTab = 0;
4106d2a56238Sdrh         return WRC_Abort;
4107d2a56238Sdrh       }
41087d10d5a6Sdrh       pTab->nRef++;
41097d10d5a6Sdrh #if !defined(SQLITE_OMIT_VIEW) || !defined (SQLITE_OMIT_VIRTUALTABLE)
41107d10d5a6Sdrh       if( pTab->pSelect || IsVirtual(pTab) ){
41117d10d5a6Sdrh         /* We reach here if the named table is a really a view */
41127d10d5a6Sdrh         if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
411343152cf8Sdrh         assert( pFrom->pSelect==0 );
41146ab3a2ecSdanielk1977         pFrom->pSelect = sqlite3SelectDup(db, pTab->pSelect, 0);
4115eb9b884cSdrh         sqlite3SelectSetName(pFrom->pSelect, pTab->zName);
41167d10d5a6Sdrh         sqlite3WalkSelect(pWalker, pFrom->pSelect);
41177d10d5a6Sdrh       }
41187d10d5a6Sdrh #endif
41197d10d5a6Sdrh     }
412085574e31Sdanielk1977 
412185574e31Sdanielk1977     /* Locate the index named by the INDEXED BY clause, if any. */
4122b1c685b0Sdanielk1977     if( sqlite3IndexedByLookup(pParse, pFrom) ){
412385574e31Sdanielk1977       return WRC_Abort;
412485574e31Sdanielk1977     }
41257d10d5a6Sdrh   }
41267d10d5a6Sdrh 
41277d10d5a6Sdrh   /* Process NATURAL keywords, and ON and USING clauses of joins.
41287d10d5a6Sdrh   */
41297d10d5a6Sdrh   if( db->mallocFailed || sqliteProcessJoin(pParse, p) ){
41307d10d5a6Sdrh     return WRC_Abort;
41317d10d5a6Sdrh   }
41327d10d5a6Sdrh 
41337d10d5a6Sdrh   /* For every "*" that occurs in the column list, insert the names of
41347d10d5a6Sdrh   ** all columns in all tables.  And for every TABLE.* insert the names
41357d10d5a6Sdrh   ** of all columns in TABLE.  The parser inserted a special expression
41367d10d5a6Sdrh   ** with the TK_ALL operator for each "*" that it found in the column list.
41377d10d5a6Sdrh   ** The following code just has to locate the TK_ALL expressions and expand
41387d10d5a6Sdrh   ** each one to the list of all columns in all tables.
41397d10d5a6Sdrh   **
41407d10d5a6Sdrh   ** The first loop just checks to see if there are any "*" operators
41417d10d5a6Sdrh   ** that need expanding.
41427d10d5a6Sdrh   */
41437d10d5a6Sdrh   for(k=0; k<pEList->nExpr; k++){
41443e3f1a5bSdrh     pE = pEList->a[k].pExpr;
41457d10d5a6Sdrh     if( pE->op==TK_ALL ) break;
414643152cf8Sdrh     assert( pE->op!=TK_DOT || pE->pRight!=0 );
414743152cf8Sdrh     assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
414843152cf8Sdrh     if( pE->op==TK_DOT && pE->pRight->op==TK_ALL ) break;
41497d10d5a6Sdrh   }
41507d10d5a6Sdrh   if( k<pEList->nExpr ){
41517d10d5a6Sdrh     /*
41527d10d5a6Sdrh     ** If we get here it means the result set contains one or more "*"
41537d10d5a6Sdrh     ** operators that need to be expanded.  Loop through each expression
41547d10d5a6Sdrh     ** in the result set and expand them one by one.
41557d10d5a6Sdrh     */
41567d10d5a6Sdrh     struct ExprList_item *a = pEList->a;
41577d10d5a6Sdrh     ExprList *pNew = 0;
41587d10d5a6Sdrh     int flags = pParse->db->flags;
41597d10d5a6Sdrh     int longNames = (flags & SQLITE_FullColNames)!=0
416038b384a0Sdrh                       && (flags & SQLITE_ShortColNames)==0;
416138b384a0Sdrh 
416238b384a0Sdrh     /* When processing FROM-clause subqueries, it is always the case
416338b384a0Sdrh     ** that full_column_names=OFF and short_column_names=ON.  The
416438b384a0Sdrh     ** sqlite3ResultSetOfSelect() routine makes it so. */
416538b384a0Sdrh     assert( (p->selFlags & SF_NestedFrom)==0
416638b384a0Sdrh           || ((flags & SQLITE_FullColNames)==0 &&
416738b384a0Sdrh               (flags & SQLITE_ShortColNames)!=0) );
41687d10d5a6Sdrh 
41697d10d5a6Sdrh     for(k=0; k<pEList->nExpr; k++){
41703e3f1a5bSdrh       pE = a[k].pExpr;
41713e3f1a5bSdrh       pRight = pE->pRight;
41723e3f1a5bSdrh       assert( pE->op!=TK_DOT || pRight!=0 );
41733e3f1a5bSdrh       if( pE->op!=TK_ALL && (pE->op!=TK_DOT || pRight->op!=TK_ALL) ){
41747d10d5a6Sdrh         /* This particular expression does not need to be expanded.
41757d10d5a6Sdrh         */
4176b7916a78Sdrh         pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
41777d10d5a6Sdrh         if( pNew ){
41787d10d5a6Sdrh           pNew->a[pNew->nExpr-1].zName = a[k].zName;
4179b7916a78Sdrh           pNew->a[pNew->nExpr-1].zSpan = a[k].zSpan;
4180b7916a78Sdrh           a[k].zName = 0;
4181b7916a78Sdrh           a[k].zSpan = 0;
41827d10d5a6Sdrh         }
41837d10d5a6Sdrh         a[k].pExpr = 0;
41847d10d5a6Sdrh       }else{
41857d10d5a6Sdrh         /* This expression is a "*" or a "TABLE.*" and needs to be
41867d10d5a6Sdrh         ** expanded. */
41877d10d5a6Sdrh         int tableSeen = 0;      /* Set to 1 when TABLE matches */
41883e3f1a5bSdrh         char *zTName = 0;       /* text of name of TABLE */
418943152cf8Sdrh         if( pE->op==TK_DOT ){
419043152cf8Sdrh           assert( pE->pLeft!=0 );
419133e619fcSdrh           assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
419233e619fcSdrh           zTName = pE->pLeft->u.zToken;
41937d10d5a6Sdrh         }
41947d10d5a6Sdrh         for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
41957d10d5a6Sdrh           Table *pTab = pFrom->pTab;
41963e3f1a5bSdrh           Select *pSub = pFrom->pSelect;
41977d10d5a6Sdrh           char *zTabName = pFrom->zAlias;
41983e3f1a5bSdrh           const char *zSchemaName = 0;
4199c75e09c7Sdrh           int iDb;
420043152cf8Sdrh           if( zTabName==0 ){
42017d10d5a6Sdrh             zTabName = pTab->zName;
42027d10d5a6Sdrh           }
42037d10d5a6Sdrh           if( db->mallocFailed ) break;
42043e3f1a5bSdrh           if( pSub==0 || (pSub->selFlags & SF_NestedFrom)==0 ){
42053e3f1a5bSdrh             pSub = 0;
42067d10d5a6Sdrh             if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
42077d10d5a6Sdrh               continue;
42087d10d5a6Sdrh             }
42093e3f1a5bSdrh             iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
4210c75e09c7Sdrh             zSchemaName = iDb>=0 ? db->aDb[iDb].zName : "*";
42113e3f1a5bSdrh           }
42127d10d5a6Sdrh           for(j=0; j<pTab->nCol; j++){
42137d10d5a6Sdrh             char *zName = pTab->aCol[j].zName;
4214b7916a78Sdrh             char *zColname;  /* The computed column name */
4215b7916a78Sdrh             char *zToFree;   /* Malloced string that needs to be freed */
4216b7916a78Sdrh             Token sColname;  /* Computed column name as a token */
42177d10d5a6Sdrh 
4218c75e09c7Sdrh             assert( zName );
42193e3f1a5bSdrh             if( zTName && pSub
42203e3f1a5bSdrh              && sqlite3MatchSpanName(pSub->pEList->a[j].zSpan, 0, zTName, 0)==0
42213e3f1a5bSdrh             ){
42223e3f1a5bSdrh               continue;
42233e3f1a5bSdrh             }
42243e3f1a5bSdrh 
42257d10d5a6Sdrh             /* If a column is marked as 'hidden' (currently only possible
42267d10d5a6Sdrh             ** for virtual tables), do not include it in the expanded
42277d10d5a6Sdrh             ** result-set list.
42287d10d5a6Sdrh             */
42297d10d5a6Sdrh             if( IsHiddenColumn(&pTab->aCol[j]) ){
42307d10d5a6Sdrh               assert(IsVirtual(pTab));
42317d10d5a6Sdrh               continue;
42327d10d5a6Sdrh             }
42333e3f1a5bSdrh             tableSeen = 1;
42347d10d5a6Sdrh 
4235da55c48aSdrh             if( i>0 && zTName==0 ){
42362179b434Sdrh               if( (pFrom->jointype & JT_NATURAL)!=0
42372179b434Sdrh                 && tableAndColumnIndex(pTabList, i, zName, 0, 0)
42382179b434Sdrh               ){
42397d10d5a6Sdrh                 /* In a NATURAL join, omit the join columns from the
42402179b434Sdrh                 ** table to the right of the join */
42417d10d5a6Sdrh                 continue;
42427d10d5a6Sdrh               }
42432179b434Sdrh               if( sqlite3IdListIndex(pFrom->pUsing, zName)>=0 ){
42447d10d5a6Sdrh                 /* In a join with a USING clause, omit columns in the
42457d10d5a6Sdrh                 ** using clause from the table on the right. */
42467d10d5a6Sdrh                 continue;
42477d10d5a6Sdrh               }
42487d10d5a6Sdrh             }
4249b7916a78Sdrh             pRight = sqlite3Expr(db, TK_ID, zName);
4250b7916a78Sdrh             zColname = zName;
4251b7916a78Sdrh             zToFree = 0;
42527d10d5a6Sdrh             if( longNames || pTabList->nSrc>1 ){
4253b7916a78Sdrh               Expr *pLeft;
4254b7916a78Sdrh               pLeft = sqlite3Expr(db, TK_ID, zTabName);
42557d10d5a6Sdrh               pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight, 0);
425638b384a0Sdrh               if( zSchemaName ){
4257c75e09c7Sdrh                 pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
4258c75e09c7Sdrh                 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr, 0);
4259c75e09c7Sdrh               }
4260b7916a78Sdrh               if( longNames ){
4261b7916a78Sdrh                 zColname = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
4262b7916a78Sdrh                 zToFree = zColname;
4263b7916a78Sdrh               }
42647d10d5a6Sdrh             }else{
42657d10d5a6Sdrh               pExpr = pRight;
42667d10d5a6Sdrh             }
4267b7916a78Sdrh             pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
4268b7916a78Sdrh             sColname.z = zColname;
4269b7916a78Sdrh             sColname.n = sqlite3Strlen30(zColname);
4270b7916a78Sdrh             sqlite3ExprListSetName(pParse, pNew, &sColname, 0);
42718f25d18bSdrh             if( pNew && (p->selFlags & SF_NestedFrom)!=0 ){
42723e3f1a5bSdrh               struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
42733e3f1a5bSdrh               if( pSub ){
42743e3f1a5bSdrh                 pX->zSpan = sqlite3DbStrDup(db, pSub->pEList->a[j].zSpan);
4275c75e09c7Sdrh                 testcase( pX->zSpan==0 );
42763e3f1a5bSdrh               }else{
42773e3f1a5bSdrh                 pX->zSpan = sqlite3MPrintf(db, "%s.%s.%s",
42783e3f1a5bSdrh                                            zSchemaName, zTabName, zColname);
4279c75e09c7Sdrh                 testcase( pX->zSpan==0 );
42803e3f1a5bSdrh               }
42813e3f1a5bSdrh               pX->bSpanIsTab = 1;
42828f25d18bSdrh             }
4283b7916a78Sdrh             sqlite3DbFree(db, zToFree);
42847d10d5a6Sdrh           }
42857d10d5a6Sdrh         }
42867d10d5a6Sdrh         if( !tableSeen ){
42877d10d5a6Sdrh           if( zTName ){
42887d10d5a6Sdrh             sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
42897d10d5a6Sdrh           }else{
42907d10d5a6Sdrh             sqlite3ErrorMsg(pParse, "no tables specified");
42917d10d5a6Sdrh           }
42927d10d5a6Sdrh         }
42937d10d5a6Sdrh       }
42947d10d5a6Sdrh     }
42957d10d5a6Sdrh     sqlite3ExprListDelete(db, pEList);
42967d10d5a6Sdrh     p->pEList = pNew;
42977d10d5a6Sdrh   }
42987d10d5a6Sdrh #if SQLITE_MAX_COLUMN
42997d10d5a6Sdrh   if( p->pEList && p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
43007d10d5a6Sdrh     sqlite3ErrorMsg(pParse, "too many columns in result set");
43017d10d5a6Sdrh   }
43027d10d5a6Sdrh #endif
43037d10d5a6Sdrh   return WRC_Continue;
43047d10d5a6Sdrh }
43057d10d5a6Sdrh 
43067d10d5a6Sdrh /*
43077d10d5a6Sdrh ** No-op routine for the parse-tree walker.
43087d10d5a6Sdrh **
43097d10d5a6Sdrh ** When this routine is the Walker.xExprCallback then expression trees
43107d10d5a6Sdrh ** are walked without any actions being taken at each node.  Presumably,
43117d10d5a6Sdrh ** when this routine is used for Walker.xExprCallback then
43127d10d5a6Sdrh ** Walker.xSelectCallback is set to do something useful for every
43137d10d5a6Sdrh ** subquery in the parser tree.
43147d10d5a6Sdrh */
431562c14b34Sdanielk1977 static int exprWalkNoop(Walker *NotUsed, Expr *NotUsed2){
431662c14b34Sdanielk1977   UNUSED_PARAMETER2(NotUsed, NotUsed2);
43177d10d5a6Sdrh   return WRC_Continue;
43187d10d5a6Sdrh }
43197d10d5a6Sdrh 
43207d10d5a6Sdrh /*
43217d10d5a6Sdrh ** This routine "expands" a SELECT statement and all of its subqueries.
43227d10d5a6Sdrh ** For additional information on what it means to "expand" a SELECT
43237d10d5a6Sdrh ** statement, see the comment on the selectExpand worker callback above.
43247d10d5a6Sdrh **
43257d10d5a6Sdrh ** Expanding a SELECT statement is the first step in processing a
43267d10d5a6Sdrh ** SELECT statement.  The SELECT statement must be expanded before
43277d10d5a6Sdrh ** name resolution is performed.
43287d10d5a6Sdrh **
43297d10d5a6Sdrh ** If anything goes wrong, an error message is written into pParse.
43307d10d5a6Sdrh ** The calling function can detect the problem by looking at pParse->nErr
43317d10d5a6Sdrh ** and/or pParse->db->mallocFailed.
43327d10d5a6Sdrh */
43337d10d5a6Sdrh static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
43347d10d5a6Sdrh   Walker w;
4335aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
43367d10d5a6Sdrh   w.xExprCallback = exprWalkNoop;
43377d10d5a6Sdrh   w.pParse = pParse;
4338d58d3278Sdrh   if( pParse->hasCompound ){
4339d58d3278Sdrh     w.xSelectCallback = convertCompoundSelectToSubquery;
43407d10d5a6Sdrh     sqlite3WalkSelect(&w, pSelect);
4341d58d3278Sdrh   }
4342c01b7306Sdrh   w.xSelectCallback = selectExpander;
4343b290f117Sdan   w.xSelectCallback2 = selectPopWith;
4344c01b7306Sdrh   sqlite3WalkSelect(&w, pSelect);
43457d10d5a6Sdrh }
43467d10d5a6Sdrh 
43477d10d5a6Sdrh 
43487d10d5a6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
43497d10d5a6Sdrh /*
43507d10d5a6Sdrh ** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
43517d10d5a6Sdrh ** interface.
43527d10d5a6Sdrh **
43537d10d5a6Sdrh ** For each FROM-clause subquery, add Column.zType and Column.zColl
43547d10d5a6Sdrh ** information to the Table structure that represents the result set
43557d10d5a6Sdrh ** of that subquery.
43567d10d5a6Sdrh **
43577d10d5a6Sdrh ** The Table structure that represents the result set was constructed
43587d10d5a6Sdrh ** by selectExpander() but the type and collation information was omitted
43597d10d5a6Sdrh ** at that point because identifiers had not yet been resolved.  This
43607d10d5a6Sdrh ** routine is called after identifier resolution.
43617d10d5a6Sdrh */
4362b290f117Sdan static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
43637d10d5a6Sdrh   Parse *pParse;
43647d10d5a6Sdrh   int i;
43657d10d5a6Sdrh   SrcList *pTabList;
43667d10d5a6Sdrh   struct SrcList_item *pFrom;
43677d10d5a6Sdrh 
43689d8b3072Sdrh   assert( p->selFlags & SF_Resolved );
43695a29d9cbSdrh   if( (p->selFlags & SF_HasTypeInfo)==0 ){
43707d10d5a6Sdrh     p->selFlags |= SF_HasTypeInfo;
43717d10d5a6Sdrh     pParse = pWalker->pParse;
43727d10d5a6Sdrh     pTabList = p->pSrc;
43737d10d5a6Sdrh     for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
43747d10d5a6Sdrh       Table *pTab = pFrom->pTab;
437543152cf8Sdrh       if( ALWAYS(pTab!=0) && (pTab->tabFlags & TF_Ephemeral)!=0 ){
43767d10d5a6Sdrh         /* A sub-query in the FROM clause of a SELECT */
43777d10d5a6Sdrh         Select *pSel = pFrom->pSelect;
43788ce7184bSdan         if( pSel ){
43797d10d5a6Sdrh           while( pSel->pPrior ) pSel = pSel->pPrior;
4380186ad8ccSdrh           selectAddColumnTypeAndCollation(pParse, pTab, pSel);
43817d10d5a6Sdrh         }
43827d10d5a6Sdrh       }
43835a29d9cbSdrh     }
43848ce7184bSdan   }
43857d10d5a6Sdrh }
43867d10d5a6Sdrh #endif
43877d10d5a6Sdrh 
43887d10d5a6Sdrh 
43897d10d5a6Sdrh /*
43907d10d5a6Sdrh ** This routine adds datatype and collating sequence information to
43917d10d5a6Sdrh ** the Table structures of all FROM-clause subqueries in a
43927d10d5a6Sdrh ** SELECT statement.
43937d10d5a6Sdrh **
43947d10d5a6Sdrh ** Use this routine after name resolution.
43957d10d5a6Sdrh */
43967d10d5a6Sdrh static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
43977d10d5a6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
43987d10d5a6Sdrh   Walker w;
4399aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
4400b290f117Sdan   w.xSelectCallback2 = selectAddSubqueryTypeInfo;
44017d10d5a6Sdrh   w.xExprCallback = exprWalkNoop;
44027d10d5a6Sdrh   w.pParse = pParse;
44037d10d5a6Sdrh   sqlite3WalkSelect(&w, pSelect);
44047d10d5a6Sdrh #endif
44057d10d5a6Sdrh }
44067d10d5a6Sdrh 
44077d10d5a6Sdrh 
44087d10d5a6Sdrh /*
4409030796dfSdrh ** This routine sets up a SELECT statement for processing.  The
44107d10d5a6Sdrh ** following is accomplished:
44117d10d5a6Sdrh **
44127d10d5a6Sdrh **     *  VDBE Cursor numbers are assigned to all FROM-clause terms.
44137d10d5a6Sdrh **     *  Ephemeral Table objects are created for all FROM-clause subqueries.
44147d10d5a6Sdrh **     *  ON and USING clauses are shifted into WHERE statements
44157d10d5a6Sdrh **     *  Wildcards "*" and "TABLE.*" in result sets are expanded.
44167d10d5a6Sdrh **     *  Identifiers in expression are matched to tables.
44177d10d5a6Sdrh **
44187d10d5a6Sdrh ** This routine acts recursively on all subqueries within the SELECT.
44197d10d5a6Sdrh */
44207d10d5a6Sdrh void sqlite3SelectPrep(
4421b3bce662Sdanielk1977   Parse *pParse,         /* The parser context */
4422b3bce662Sdanielk1977   Select *p,             /* The SELECT statement being coded. */
44237d10d5a6Sdrh   NameContext *pOuterNC  /* Name context for container */
4424b3bce662Sdanielk1977 ){
44257d10d5a6Sdrh   sqlite3 *db;
442643152cf8Sdrh   if( NEVER(p==0) ) return;
44277d10d5a6Sdrh   db = pParse->db;
4428785097daSdrh   if( db->mallocFailed ) return;
44297d10d5a6Sdrh   if( p->selFlags & SF_HasTypeInfo ) return;
44307d10d5a6Sdrh   sqlite3SelectExpand(pParse, p);
44317d10d5a6Sdrh   if( pParse->nErr || db->mallocFailed ) return;
44327d10d5a6Sdrh   sqlite3ResolveSelectNames(pParse, p, pOuterNC);
44337d10d5a6Sdrh   if( pParse->nErr || db->mallocFailed ) return;
44347d10d5a6Sdrh   sqlite3SelectAddTypeInfo(pParse, p);
4435f6bbe022Sdrh }
4436b3bce662Sdanielk1977 
4437b3bce662Sdanielk1977 /*
443813449892Sdrh ** Reset the aggregate accumulator.
443913449892Sdrh **
444013449892Sdrh ** The aggregate accumulator is a set of memory cells that hold
444113449892Sdrh ** intermediate results while calculating an aggregate.  This
4442030796dfSdrh ** routine generates code that stores NULLs in all of those memory
4443030796dfSdrh ** cells.
4444b3bce662Sdanielk1977 */
444513449892Sdrh static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
444613449892Sdrh   Vdbe *v = pParse->pVdbe;
444713449892Sdrh   int i;
4448c99130fdSdrh   struct AggInfo_func *pFunc;
44497e61d18eSdrh   int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
44507e61d18eSdrh   if( nReg==0 ) return;
44517e61d18eSdrh #ifdef SQLITE_DEBUG
44527e61d18eSdrh   /* Verify that all AggInfo registers are within the range specified by
44537e61d18eSdrh   ** AggInfo.mnReg..AggInfo.mxReg */
44547e61d18eSdrh   assert( nReg==pAggInfo->mxReg-pAggInfo->mnReg+1 );
445513449892Sdrh   for(i=0; i<pAggInfo->nColumn; i++){
44567e61d18eSdrh     assert( pAggInfo->aCol[i].iMem>=pAggInfo->mnReg
44577e61d18eSdrh          && pAggInfo->aCol[i].iMem<=pAggInfo->mxReg );
445813449892Sdrh   }
44597e61d18eSdrh   for(i=0; i<pAggInfo->nFunc; i++){
44607e61d18eSdrh     assert( pAggInfo->aFunc[i].iMem>=pAggInfo->mnReg
44617e61d18eSdrh          && pAggInfo->aFunc[i].iMem<=pAggInfo->mxReg );
44627e61d18eSdrh   }
44637e61d18eSdrh #endif
44647e61d18eSdrh   sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->mnReg, pAggInfo->mxReg);
4465c99130fdSdrh   for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
4466c99130fdSdrh     if( pFunc->iDistinct>=0 ){
4467c99130fdSdrh       Expr *pE = pFunc->pExpr;
44686ab3a2ecSdanielk1977       assert( !ExprHasProperty(pE, EP_xIsSelect) );
44696ab3a2ecSdanielk1977       if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
44700daa002cSdrh         sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
44710daa002cSdrh            "argument");
4472c99130fdSdrh         pFunc->iDistinct = -1;
4473c99130fdSdrh       }else{
4474079a3072Sdrh         KeyInfo *pKeyInfo = keyInfoFromExprList(pParse, pE->x.pList, 0, 0);
447566a5167bSdrh         sqlite3VdbeAddOp4(v, OP_OpenEphemeral, pFunc->iDistinct, 0, 0,
44762ec2fb22Sdrh                           (char*)pKeyInfo, P4_KEYINFO);
4477c99130fdSdrh       }
4478c99130fdSdrh     }
447913449892Sdrh   }
4480b3bce662Sdanielk1977 }
4481b3bce662Sdanielk1977 
4482b3bce662Sdanielk1977 /*
448313449892Sdrh ** Invoke the OP_AggFinalize opcode for every aggregate function
448413449892Sdrh ** in the AggInfo structure.
4485b3bce662Sdanielk1977 */
448613449892Sdrh static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
448713449892Sdrh   Vdbe *v = pParse->pVdbe;
448813449892Sdrh   int i;
448913449892Sdrh   struct AggInfo_func *pF;
449013449892Sdrh   for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
44916ab3a2ecSdanielk1977     ExprList *pList = pF->pExpr->x.pList;
44926ab3a2ecSdanielk1977     assert( !ExprHasProperty(pF->pExpr, EP_xIsSelect) );
449366a5167bSdrh     sqlite3VdbeAddOp4(v, OP_AggFinal, pF->iMem, pList ? pList->nExpr : 0, 0,
449466a5167bSdrh                       (void*)pF->pFunc, P4_FUNCDEF);
4495b3bce662Sdanielk1977   }
449613449892Sdrh }
449713449892Sdrh 
449813449892Sdrh /*
449913449892Sdrh ** Update the accumulator memory cells for an aggregate based on
450013449892Sdrh ** the current cursor position.
450113449892Sdrh */
450213449892Sdrh static void updateAccumulator(Parse *pParse, AggInfo *pAggInfo){
450313449892Sdrh   Vdbe *v = pParse->pVdbe;
450413449892Sdrh   int i;
45057a95789cSdrh   int regHit = 0;
45067a95789cSdrh   int addrHitTest = 0;
450713449892Sdrh   struct AggInfo_func *pF;
450813449892Sdrh   struct AggInfo_col *pC;
450913449892Sdrh 
451013449892Sdrh   pAggInfo->directMode = 1;
451113449892Sdrh   for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
451213449892Sdrh     int nArg;
4513c99130fdSdrh     int addrNext = 0;
451498757157Sdrh     int regAgg;
45156ab3a2ecSdanielk1977     ExprList *pList = pF->pExpr->x.pList;
45166ab3a2ecSdanielk1977     assert( !ExprHasProperty(pF->pExpr, EP_xIsSelect) );
451713449892Sdrh     if( pList ){
451813449892Sdrh       nArg = pList->nExpr;
4519892d3179Sdrh       regAgg = sqlite3GetTempRange(pParse, nArg);
4520d1a01edaSdrh       sqlite3ExprCodeExprList(pParse, pList, regAgg, SQLITE_ECEL_DUP);
452113449892Sdrh     }else{
452213449892Sdrh       nArg = 0;
452398757157Sdrh       regAgg = 0;
452413449892Sdrh     }
4525c99130fdSdrh     if( pF->iDistinct>=0 ){
4526c99130fdSdrh       addrNext = sqlite3VdbeMakeLabel(v);
4527c99130fdSdrh       assert( nArg==1 );
45282dcef11bSdrh       codeDistinct(pParse, pF->iDistinct, addrNext, 1, regAgg);
4529c99130fdSdrh     }
4530d36e1041Sdrh     if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
453113449892Sdrh       CollSeq *pColl = 0;
453213449892Sdrh       struct ExprList_item *pItem;
453313449892Sdrh       int j;
4534e82f5d04Sdrh       assert( pList!=0 );  /* pList!=0 if pF->pFunc has NEEDCOLL */
453543617e9aSdrh       for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
453613449892Sdrh         pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
453713449892Sdrh       }
453813449892Sdrh       if( !pColl ){
453913449892Sdrh         pColl = pParse->db->pDfltColl;
454013449892Sdrh       }
45417a95789cSdrh       if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
45427a95789cSdrh       sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
454313449892Sdrh     }
454498757157Sdrh     sqlite3VdbeAddOp4(v, OP_AggStep, 0, regAgg, pF->iMem,
454566a5167bSdrh                       (void*)pF->pFunc, P4_FUNCDEF);
4546ea678832Sdrh     sqlite3VdbeChangeP5(v, (u8)nArg);
4547da250ea5Sdrh     sqlite3ExprCacheAffinityChange(pParse, regAgg, nArg);
4548f49f3523Sdrh     sqlite3ReleaseTempRange(pParse, regAgg, nArg);
4549c99130fdSdrh     if( addrNext ){
4550c99130fdSdrh       sqlite3VdbeResolveLabel(v, addrNext);
4551ceea3321Sdrh       sqlite3ExprCacheClear(pParse);
4552c99130fdSdrh     }
455313449892Sdrh   }
455467a6a40cSdan 
455567a6a40cSdan   /* Before populating the accumulator registers, clear the column cache.
455667a6a40cSdan   ** Otherwise, if any of the required column values are already present
455767a6a40cSdan   ** in registers, sqlite3ExprCode() may use OP_SCopy to copy the value
455867a6a40cSdan   ** to pC->iMem. But by the time the value is used, the original register
455967a6a40cSdan   ** may have been used, invalidating the underlying buffer holding the
456067a6a40cSdan   ** text or blob value. See ticket [883034dcb5].
456167a6a40cSdan   **
456267a6a40cSdan   ** Another solution would be to change the OP_SCopy used to copy cached
456367a6a40cSdan   ** values to an OP_Copy.
456467a6a40cSdan   */
45657a95789cSdrh   if( regHit ){
4566688852abSdrh     addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
45677a95789cSdrh   }
456867a6a40cSdan   sqlite3ExprCacheClear(pParse);
456913449892Sdrh   for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
4570389a1adbSdrh     sqlite3ExprCode(pParse, pC->pExpr, pC->iMem);
457113449892Sdrh   }
457213449892Sdrh   pAggInfo->directMode = 0;
4573ceea3321Sdrh   sqlite3ExprCacheClear(pParse);
45747a95789cSdrh   if( addrHitTest ){
45757a95789cSdrh     sqlite3VdbeJumpHere(v, addrHitTest);
45767a95789cSdrh   }
457713449892Sdrh }
457813449892Sdrh 
4579b3bce662Sdanielk1977 /*
4580ef7075deSdan ** Add a single OP_Explain instruction to the VDBE to explain a simple
4581ef7075deSdan ** count(*) query ("SELECT count(*) FROM pTab").
4582ef7075deSdan */
4583ef7075deSdan #ifndef SQLITE_OMIT_EXPLAIN
4584ef7075deSdan static void explainSimpleCount(
4585ef7075deSdan   Parse *pParse,                  /* Parse context */
4586ef7075deSdan   Table *pTab,                    /* Table being queried */
4587ef7075deSdan   Index *pIdx                     /* Index used to optimize scan, or NULL */
4588ef7075deSdan ){
4589ef7075deSdan   if( pParse->explain==2 ){
459048dd1d8eSdrh     int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
45918a4380d7Sdrh     char *zEqp = sqlite3MPrintf(pParse->db, "SCAN TABLE %s%s%s",
4592ef7075deSdan         pTab->zName,
4593e96f2df3Sdan         bCover ? " USING COVERING INDEX " : "",
4594e96f2df3Sdan         bCover ? pIdx->zName : ""
4595ef7075deSdan     );
4596ef7075deSdan     sqlite3VdbeAddOp4(
4597ef7075deSdan         pParse->pVdbe, OP_Explain, pParse->iSelectId, 0, 0, zEqp, P4_DYNAMIC
4598ef7075deSdan     );
4599ef7075deSdan   }
4600ef7075deSdan }
4601ef7075deSdan #else
4602ef7075deSdan # define explainSimpleCount(a,b,c)
4603ef7075deSdan #endif
4604ef7075deSdan 
4605ef7075deSdan /*
46067d10d5a6Sdrh ** Generate code for the SELECT statement given in the p argument.
46079bb61fe7Sdrh **
4608340309fdSdrh ** The results are returned according to the SelectDest structure.
4609340309fdSdrh ** See comments in sqliteInt.h for further information.
4610e78e8284Sdrh **
46119bb61fe7Sdrh ** This routine returns the number of errors.  If any errors are
46129bb61fe7Sdrh ** encountered, then an appropriate error message is left in
46139bb61fe7Sdrh ** pParse->zErrMsg.
46149bb61fe7Sdrh **
46159bb61fe7Sdrh ** This routine does NOT free the Select structure passed in.  The
46169bb61fe7Sdrh ** calling function needs to do that.
46179bb61fe7Sdrh */
46184adee20fSdanielk1977 int sqlite3Select(
4619cce7d176Sdrh   Parse *pParse,         /* The parser context */
46209bb61fe7Sdrh   Select *p,             /* The SELECT statement being coded. */
46217d10d5a6Sdrh   SelectDest *pDest      /* What to do with the query results */
4622cce7d176Sdrh ){
462313449892Sdrh   int i, j;              /* Loop counters */
462413449892Sdrh   WhereInfo *pWInfo;     /* Return from sqlite3WhereBegin() */
462513449892Sdrh   Vdbe *v;               /* The virtual machine under construction */
4626b3bce662Sdanielk1977   int isAgg;             /* True for select lists like "count(*)" */
4627a2e00042Sdrh   ExprList *pEList;      /* List of columns to extract. */
4628ad3cab52Sdrh   SrcList *pTabList;     /* List of tables to select from */
46299bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause.  May be NULL */
46302282792aSdrh   ExprList *pGroupBy;    /* The GROUP BY clause.  May be NULL */
46312282792aSdrh   Expr *pHaving;         /* The HAVING clause.  May be NULL */
46321d83f052Sdrh   int rc = 1;            /* Value to return from this function */
4633e8e4af76Sdrh   DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
4634079a3072Sdrh   SortCtx sSort;         /* Info on how to code the ORDER BY clause */
463513449892Sdrh   AggInfo sAggInfo;      /* Information used by aggregate queries */
4636ec7429aeSdrh   int iEnd;              /* Address of the end of the query */
463717435752Sdrh   sqlite3 *db;           /* The database connection */
46389bb61fe7Sdrh 
46392ce22453Sdan #ifndef SQLITE_OMIT_EXPLAIN
46402ce22453Sdan   int iRestoreSelectId = pParse->iSelectId;
46412ce22453Sdan   pParse->iSelectId = pParse->iNextSelectId++;
46422ce22453Sdan #endif
46432ce22453Sdan 
464417435752Sdrh   db = pParse->db;
464517435752Sdrh   if( p==0 || db->mallocFailed || pParse->nErr ){
46466f7adc8aSdrh     return 1;
46476f7adc8aSdrh   }
46484adee20fSdanielk1977   if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
464913449892Sdrh   memset(&sAggInfo, 0, sizeof(sAggInfo));
4650eb9b884cSdrh #if SELECTTRACE_ENABLED
4651eb9b884cSdrh   pParse->nSelectIndent++;
4652eb9b884cSdrh   SELECTTRACE(1,pParse,p, ("begin processing\n"));
4653eb9b884cSdrh #endif
4654daffd0e5Sdrh 
46558e1ee88cSdrh   assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
46568e1ee88cSdrh   assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
46579afccba2Sdan   assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
46589afccba2Sdan   assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
46596c8c8ce0Sdanielk1977   if( IgnorableOrderby(pDest) ){
46609ed1dfa8Sdanielk1977     assert(pDest->eDest==SRT_Exists || pDest->eDest==SRT_Union ||
46619afccba2Sdan            pDest->eDest==SRT_Except || pDest->eDest==SRT_Discard ||
46628e1ee88cSdrh            pDest->eDest==SRT_Queue  || pDest->eDest==SRT_DistFifo ||
46638e1ee88cSdrh            pDest->eDest==SRT_DistQueue || pDest->eDest==SRT_Fifo);
4664ccfcbceaSdrh     /* If ORDER BY makes no difference in the output then neither does
4665ccfcbceaSdrh     ** DISTINCT so it can be removed too. */
4666ccfcbceaSdrh     sqlite3ExprListDelete(db, p->pOrderBy);
4667ccfcbceaSdrh     p->pOrderBy = 0;
46687d10d5a6Sdrh     p->selFlags &= ~SF_Distinct;
46699a99334dSdrh   }
46707d10d5a6Sdrh   sqlite3SelectPrep(pParse, p, 0);
4671079a3072Sdrh   memset(&sSort, 0, sizeof(sSort));
4672079a3072Sdrh   sSort.pOrderBy = p->pOrderBy;
4673b27b7f5dSdrh   pTabList = p->pSrc;
4674b27b7f5dSdrh   pEList = p->pEList;
4675956f4319Sdanielk1977   if( pParse->nErr || db->mallocFailed ){
46769a99334dSdrh     goto select_end;
46779a99334dSdrh   }
46787d10d5a6Sdrh   isAgg = (p->selFlags & SF_Aggregate)!=0;
467943152cf8Sdrh   assert( pEList!=0 );
4680cce7d176Sdrh 
4681d820cb1bSdrh   /* Begin generating code.
4682d820cb1bSdrh   */
46834adee20fSdanielk1977   v = sqlite3GetVdbe(pParse);
4684d820cb1bSdrh   if( v==0 ) goto select_end;
4685d820cb1bSdrh 
468674b617b2Sdan   /* If writing to memory or generating a set
468774b617b2Sdan   ** only a single column may be output.
468874b617b2Sdan   */
468974b617b2Sdan #ifndef SQLITE_OMIT_SUBQUERY
469074b617b2Sdan   if( checkForMultiColumnSelectError(pParse, pDest, pEList->nExpr) ){
469174b617b2Sdan     goto select_end;
469274b617b2Sdan   }
469374b617b2Sdan #endif
469474b617b2Sdan 
4695d820cb1bSdrh   /* Generate code for all sub-queries in the FROM clause
4696d820cb1bSdrh   */
469751522cd3Sdrh #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4698f23329a2Sdanielk1977   for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
469913449892Sdrh     struct SrcList_item *pItem = &pTabList->a[i];
47001013c932Sdrh     SelectDest dest;
4701daf79acbSdanielk1977     Select *pSub = pItem->pSelect;
4702f23329a2Sdanielk1977     int isAggSub;
4703c31c2eb8Sdrh 
47045b6a9ed4Sdrh     if( pSub==0 ) continue;
470521172c4cSdrh 
470621172c4cSdrh     /* Sometimes the code for a subquery will be generated more than
470721172c4cSdrh     ** once, if the subquery is part of the WHERE clause in a LEFT JOIN,
470821172c4cSdrh     ** for example.  In that case, do not regenerate the code to manifest
470921172c4cSdrh     ** a view or the co-routine to implement a view.  The first instance
471021172c4cSdrh     ** is sufficient, though the subroutine to manifest the view does need
471121172c4cSdrh     ** to be invoked again. */
47125b6a9ed4Sdrh     if( pItem->addrFillSub ){
471321172c4cSdrh       if( pItem->viaCoroutine==0 ){
47145b6a9ed4Sdrh         sqlite3VdbeAddOp2(v, OP_Gosub, pItem->regReturn, pItem->addrFillSub);
471521172c4cSdrh       }
47165b6a9ed4Sdrh       continue;
47175b6a9ed4Sdrh     }
4718daf79acbSdanielk1977 
4719fc976065Sdanielk1977     /* Increment Parse.nHeight by the height of the largest expression
4720f7b5496eSdrh     ** tree referred to by this, the parent select. The child select
4721fc976065Sdanielk1977     ** may contain expression trees of at most
4722fc976065Sdanielk1977     ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
4723fc976065Sdanielk1977     ** more conservative than necessary, but much easier than enforcing
4724fc976065Sdanielk1977     ** an exact limit.
4725fc976065Sdanielk1977     */
4726fc976065Sdanielk1977     pParse->nHeight += sqlite3SelectExprHeight(p);
4727daf79acbSdanielk1977 
47287d10d5a6Sdrh     isAggSub = (pSub->selFlags & SF_Aggregate)!=0;
4729524cc21eSdanielk1977     if( flattenSubquery(pParse, p, i, isAgg, isAggSub) ){
47305b6a9ed4Sdrh       /* This subquery can be absorbed into its parent. */
4731f23329a2Sdanielk1977       if( isAggSub ){
47327d10d5a6Sdrh         isAgg = 1;
47337d10d5a6Sdrh         p->selFlags |= SF_Aggregate;
4734daf79acbSdanielk1977       }
4735daf79acbSdanielk1977       i = -1;
4736ee06c99bSdrh     }else if( pTabList->nSrc==1
4737a5759677Sdrh            && OptimizationEnabled(db, SQLITE_SubqCoroutine)
4738a5759677Sdrh     ){
473921172c4cSdrh       /* Implement a co-routine that will return a single row of the result
474021172c4cSdrh       ** set on each invocation.
474121172c4cSdrh       */
4742725de29aSdrh       int addrTop = sqlite3VdbeCurrentAddr(v)+1;
474321172c4cSdrh       pItem->regReturn = ++pParse->nMem;
4744725de29aSdrh       sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
4745725de29aSdrh       VdbeComment((v, "%s", pItem->pTab->zName));
474621172c4cSdrh       pItem->addrFillSub = addrTop;
474721172c4cSdrh       sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
474821172c4cSdrh       explainSetInteger(pItem->iSelectId, (u8)pParse->iNextSelectId);
474921172c4cSdrh       sqlite3Select(pParse, pSub, &dest);
4750cfc9df76Sdan       pItem->pTab->nRowLogEst = sqlite3LogEst(pSub->nSelectRow);
475121172c4cSdrh       pItem->viaCoroutine = 1;
47525f612295Sdrh       pItem->regResult = dest.iSdst;
475381cf13ecSdrh       sqlite3VdbeAddOp1(v, OP_EndCoroutine, pItem->regReturn);
475421172c4cSdrh       sqlite3VdbeJumpHere(v, addrTop-1);
475521172c4cSdrh       sqlite3ClearTempRegCache(pParse);
4756daf79acbSdanielk1977     }else{
47575b6a9ed4Sdrh       /* Generate a subroutine that will fill an ephemeral table with
47585b6a9ed4Sdrh       ** the content of this subquery.  pItem->addrFillSub will point
47595b6a9ed4Sdrh       ** to the address of the generated subroutine.  pItem->regReturn
47605b6a9ed4Sdrh       ** is a register allocated to hold the subroutine return address
47615b6a9ed4Sdrh       */
47627157e8eaSdrh       int topAddr;
476348f2d3b1Sdrh       int onceAddr = 0;
47647157e8eaSdrh       int retAddr;
47655b6a9ed4Sdrh       assert( pItem->addrFillSub==0 );
47665b6a9ed4Sdrh       pItem->regReturn = ++pParse->nMem;
47677157e8eaSdrh       topAddr = sqlite3VdbeAddOp2(v, OP_Integer, 0, pItem->regReturn);
47687157e8eaSdrh       pItem->addrFillSub = topAddr+1;
47691d8cb21fSdan       if( pItem->isCorrelated==0 ){
4770ed17167eSdrh         /* If the subquery is not correlated and if we are not inside of
47715b6a9ed4Sdrh         ** a trigger, then we only need to compute the value of the subquery
47725b6a9ed4Sdrh         ** once. */
47737d176105Sdrh         onceAddr = sqlite3CodeOnce(pParse); VdbeCoverage(v);
4774725de29aSdrh         VdbeComment((v, "materialize \"%s\"", pItem->pTab->zName));
4775725de29aSdrh       }else{
4776725de29aSdrh         VdbeNoopComment((v, "materialize \"%s\"", pItem->pTab->zName));
47775b6a9ed4Sdrh       }
47781013c932Sdrh       sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
4779ce7e189dSdan       explainSetInteger(pItem->iSelectId, (u8)pParse->iNextSelectId);
47807d10d5a6Sdrh       sqlite3Select(pParse, pSub, &dest);
4781cfc9df76Sdan       pItem->pTab->nRowLogEst = sqlite3LogEst(pSub->nSelectRow);
478248f2d3b1Sdrh       if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
47837157e8eaSdrh       retAddr = sqlite3VdbeAddOp1(v, OP_Return, pItem->regReturn);
47847157e8eaSdrh       VdbeComment((v, "end %s", pItem->pTab->zName));
47857157e8eaSdrh       sqlite3VdbeChangeP1(v, topAddr, retAddr);
4786cdc69557Sdrh       sqlite3ClearTempRegCache(pParse);
4787daf79acbSdanielk1977     }
478843152cf8Sdrh     if( /*pParse->nErr ||*/ db->mallocFailed ){
4789cfa063b3Sdrh       goto select_end;
4790cfa063b3Sdrh     }
4791fc976065Sdanielk1977     pParse->nHeight -= sqlite3SelectExprHeight(p);
4792832508b7Sdrh     pTabList = p->pSrc;
47936c8c8ce0Sdanielk1977     if( !IgnorableOrderby(pDest) ){
4794079a3072Sdrh       sSort.pOrderBy = p->pOrderBy;
4795acd4c695Sdrh     }
4796daf79acbSdanielk1977   }
4797daf79acbSdanielk1977   pEList = p->pEList;
4798daf79acbSdanielk1977 #endif
4799daf79acbSdanielk1977   pWhere = p->pWhere;
4800832508b7Sdrh   pGroupBy = p->pGroupBy;
4801832508b7Sdrh   pHaving = p->pHaving;
4802e8e4af76Sdrh   sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
4803832508b7Sdrh 
4804f23329a2Sdanielk1977 #ifndef SQLITE_OMIT_COMPOUND_SELECT
4805f23329a2Sdanielk1977   /* If there is are a sequence of queries, do the earlier ones first.
4806f23329a2Sdanielk1977   */
4807f23329a2Sdanielk1977   if( p->pPrior ){
48087f61e92cSdan     rc = multiSelect(pParse, p, pDest);
480917c0bc0cSdan     explainSetInteger(pParse->iSelectId, iRestoreSelectId);
4810eb9b884cSdrh #if SELECTTRACE_ENABLED
4811eb9b884cSdrh     SELECTTRACE(1,pParse,p,("end compound-select processing\n"));
4812eb9b884cSdrh     pParse->nSelectIndent--;
4813eb9b884cSdrh #endif
48147f61e92cSdan     return rc;
4815f23329a2Sdanielk1977   }
4816f23329a2Sdanielk1977 #endif
4817f23329a2Sdanielk1977 
481850118cdfSdan   /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
481950118cdfSdan   ** if the select-list is the same as the ORDER BY list, then this query
482050118cdfSdan   ** can be rewritten as a GROUP BY. In other words, this:
482150118cdfSdan   **
482250118cdfSdan   **     SELECT DISTINCT xyz FROM ... ORDER BY xyz
482350118cdfSdan   **
482450118cdfSdan   ** is transformed to:
482550118cdfSdan   **
482650118cdfSdan   **     SELECT xyz FROM ... GROUP BY xyz
482750118cdfSdan   **
482850118cdfSdan   ** The second form is preferred as a single index (or temp-table) may be
482950118cdfSdan   ** used for both the ORDER BY and DISTINCT processing. As originally
483050118cdfSdan   ** written the query must use a temp-table for at least one of the ORDER
483150118cdfSdan   ** BY and DISTINCT, and an index or separate temp-table for the other.
483250118cdfSdan   */
483350118cdfSdan   if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
4834079a3072Sdrh    && sqlite3ExprListCompare(sSort.pOrderBy, p->pEList, -1)==0
483550118cdfSdan   ){
483650118cdfSdan     p->selFlags &= ~SF_Distinct;
483750118cdfSdan     p->pGroupBy = sqlite3ExprListDup(db, p->pEList, 0);
483850118cdfSdan     pGroupBy = p->pGroupBy;
4839079a3072Sdrh     sSort.pOrderBy = 0;
4840e8e4af76Sdrh     /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
4841e8e4af76Sdrh     ** the sDistinct.isTnct is still set.  Hence, isTnct represents the
4842e8e4af76Sdrh     ** original setting of the SF_Distinct flag, not the current setting */
4843e8e4af76Sdrh     assert( sDistinct.isTnct );
484450118cdfSdan   }
484550118cdfSdan 
48468b4c40d8Sdrh   /* If there is an ORDER BY clause, then this sorting
48478b4c40d8Sdrh   ** index might end up being unused if the data can be
48489d2985c7Sdrh   ** extracted in pre-sorted order.  If that is the case, then the
4849b9bb7c18Sdrh   ** OP_OpenEphemeral instruction will be changed to an OP_Noop once
48509d2985c7Sdrh   ** we figure out that the sorting index is not needed.  The addrSortIndex
48519d2985c7Sdrh   ** variable is used to facilitate that change.
48527cedc8d4Sdanielk1977   */
4853079a3072Sdrh   if( sSort.pOrderBy ){
48540342b1f5Sdrh     KeyInfo *pKeyInfo;
4855079a3072Sdrh     pKeyInfo = keyInfoFromExprList(pParse, sSort.pOrderBy, 0, 0);
4856079a3072Sdrh     sSort.iECursor = pParse->nTab++;
4857079a3072Sdrh     sSort.addrSortIndex =
485866a5167bSdrh       sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
4859f45f2326Sdrh           sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
4860f45f2326Sdrh           (char*)pKeyInfo, P4_KEYINFO
4861f45f2326Sdrh       );
48629d2985c7Sdrh   }else{
4863079a3072Sdrh     sSort.addrSortIndex = -1;
48647cedc8d4Sdanielk1977   }
48657cedc8d4Sdanielk1977 
48662d0794e3Sdrh   /* If the output is destined for a temporary table, open that table.
48672d0794e3Sdrh   */
48686c8c8ce0Sdanielk1977   if( pDest->eDest==SRT_EphemTab ){
48692b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
48702d0794e3Sdrh   }
48712d0794e3Sdrh 
4872f42bacc2Sdrh   /* Set the limiter.
4873f42bacc2Sdrh   */
4874f42bacc2Sdrh   iEnd = sqlite3VdbeMakeLabel(v);
4875c63367efSdrh   p->nSelectRow = LARGEST_INT64;
4876f42bacc2Sdrh   computeLimitRegisters(pParse, p, iEnd);
4877079a3072Sdrh   if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
4878079a3072Sdrh     sqlite3VdbeGetOp(v, sSort.addrSortIndex)->opcode = OP_SorterOpen;
4879079a3072Sdrh     sSort.sortFlags |= SORTFLAG_UseSorter;
4880c6aff30cSdrh   }
4881f42bacc2Sdrh 
4882dece1a84Sdrh   /* Open a virtual index to use for the distinct set.
4883cce7d176Sdrh   */
48842ce22453Sdan   if( p->selFlags & SF_Distinct ){
4885e8e4af76Sdrh     sDistinct.tabTnct = pParse->nTab++;
4886e8e4af76Sdrh     sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
4887e8e4af76Sdrh                                 sDistinct.tabTnct, 0, 0,
4888079a3072Sdrh                                 (char*)keyInfoFromExprList(pParse, p->pEList,0,0),
48892ec2fb22Sdrh                                 P4_KEYINFO);
4890d4187c71Sdrh     sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
4891e8e4af76Sdrh     sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
4892832508b7Sdrh   }else{
4893e8e4af76Sdrh     sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
4894efb7251dSdrh   }
4895832508b7Sdrh 
489613449892Sdrh   if( !isAgg && pGroupBy==0 ){
4897e8e4af76Sdrh     /* No aggregate functions and no GROUP BY clause */
48986457a353Sdrh     u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0);
489938cc40c2Sdan 
490038cc40c2Sdan     /* Begin the database scan. */
4901079a3072Sdrh     pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
4902079a3072Sdrh                                p->pEList, wctrlFlags, 0);
49031d83f052Sdrh     if( pWInfo==0 ) goto select_end;
49046f32848dSdrh     if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
49056f32848dSdrh       p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
49066f32848dSdrh     }
49076457a353Sdrh     if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
49086f32848dSdrh       sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
49096f32848dSdrh     }
4910079a3072Sdrh     if( sSort.pOrderBy ){
4911079a3072Sdrh       sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
4912079a3072Sdrh       if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
4913079a3072Sdrh         sSort.pOrderBy = 0;
4914079a3072Sdrh       }
4915079a3072Sdrh     }
4916cce7d176Sdrh 
4917b9bb7c18Sdrh     /* If sorting index that was created by a prior OP_OpenEphemeral
4918b9bb7c18Sdrh     ** instruction ended up not being needed, then change the OP_OpenEphemeral
49199d2985c7Sdrh     ** into an OP_Noop.
49209d2985c7Sdrh     */
4921079a3072Sdrh     if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
4922079a3072Sdrh       sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
49239d2985c7Sdrh     }
49249d2985c7Sdrh 
492538cc40c2Sdan     /* Use the standard inner loop. */
4926079a3072Sdrh     selectInnerLoop(pParse, p, pEList, -1, &sSort, &sDistinct, pDest,
49276f32848dSdrh                     sqlite3WhereContinueLabel(pWInfo),
49286f32848dSdrh                     sqlite3WhereBreakLabel(pWInfo));
49292282792aSdrh 
4930cce7d176Sdrh     /* End the database scan loop.
4931cce7d176Sdrh     */
49324adee20fSdanielk1977     sqlite3WhereEnd(pWInfo);
493313449892Sdrh   }else{
4934e8e4af76Sdrh     /* This case when there exist aggregate functions or a GROUP BY clause
4935e8e4af76Sdrh     ** or both */
493613449892Sdrh     NameContext sNC;    /* Name context for processing aggregate information */
493713449892Sdrh     int iAMem;          /* First Mem address for storing current GROUP BY */
493813449892Sdrh     int iBMem;          /* First Mem address for previous GROUP BY */
493913449892Sdrh     int iUseFlag;       /* Mem address holding flag indicating that at least
494013449892Sdrh                         ** one row of the input to the aggregator has been
494113449892Sdrh                         ** processed */
494213449892Sdrh     int iAbortFlag;     /* Mem address which causes query abort if positive */
494313449892Sdrh     int groupBySort;    /* Rows come from source in GROUP BY order */
4944d176611bSdrh     int addrEnd;        /* End of processing for this SELECT */
49451c9d835dSdrh     int sortPTab = 0;   /* Pseudotable used to decode sorting results */
49461c9d835dSdrh     int sortOut = 0;    /* Output register from the sorter */
4947374cd78cSdan     int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
4948d176611bSdrh 
4949d176611bSdrh     /* Remove any and all aliases between the result set and the
4950d176611bSdrh     ** GROUP BY clause.
4951d176611bSdrh     */
4952d176611bSdrh     if( pGroupBy ){
4953dc5ea5c7Sdrh       int k;                        /* Loop counter */
4954d176611bSdrh       struct ExprList_item *pItem;  /* For looping over expression in a list */
4955d176611bSdrh 
4956dc5ea5c7Sdrh       for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
4957c2acc4e4Sdrh         pItem->u.x.iAlias = 0;
4958d176611bSdrh       }
4959dc5ea5c7Sdrh       for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
4960c2acc4e4Sdrh         pItem->u.x.iAlias = 0;
4961d176611bSdrh       }
4962c63367efSdrh       if( p->nSelectRow>100 ) p->nSelectRow = 100;
496395aa47b1Sdrh     }else{
4964c63367efSdrh       p->nSelectRow = 1;
4965d176611bSdrh     }
4966cce7d176Sdrh 
496713449892Sdrh 
4968374cd78cSdan     /* If there is both a GROUP BY and an ORDER BY clause and they are
4969374cd78cSdan     ** identical, then it may be possible to disable the ORDER BY clause
4970374cd78cSdan     ** on the grounds that the GROUP BY will cause elements to come out
4971374cd78cSdan     ** in the correct order. It also may not - the GROUP BY may use a
4972374cd78cSdan     ** database index that causes rows to be grouped together as required
4973374cd78cSdan     ** but not actually sorted. Either way, record the fact that the
4974374cd78cSdan     ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
4975374cd78cSdan     ** variable.  */
4976374cd78cSdan     if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
4977374cd78cSdan       orderByGrp = 1;
4978374cd78cSdan     }
4979374cd78cSdan 
4980d176611bSdrh     /* Create a label to jump to when we want to abort the query */
498113449892Sdrh     addrEnd = sqlite3VdbeMakeLabel(v);
498213449892Sdrh 
498313449892Sdrh     /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
498413449892Sdrh     ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
498513449892Sdrh     ** SELECT statement.
49862282792aSdrh     */
498713449892Sdrh     memset(&sNC, 0, sizeof(sNC));
498813449892Sdrh     sNC.pParse = pParse;
498913449892Sdrh     sNC.pSrcList = pTabList;
499013449892Sdrh     sNC.pAggInfo = &sAggInfo;
49917e61d18eSdrh     sAggInfo.mnReg = pParse->nMem+1;
4992dd23c6bfSdan     sAggInfo.nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
49939d2985c7Sdrh     sAggInfo.pGroupBy = pGroupBy;
4994d2b3e23bSdrh     sqlite3ExprAnalyzeAggList(&sNC, pEList);
4995079a3072Sdrh     sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
4996d2b3e23bSdrh     if( pHaving ){
4997d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
499813449892Sdrh     }
499913449892Sdrh     sAggInfo.nAccumulator = sAggInfo.nColumn;
500013449892Sdrh     for(i=0; i<sAggInfo.nFunc; i++){
50016ab3a2ecSdanielk1977       assert( !ExprHasProperty(sAggInfo.aFunc[i].pExpr, EP_xIsSelect) );
50023a8c4be7Sdrh       sNC.ncFlags |= NC_InAggFunc;
50036ab3a2ecSdanielk1977       sqlite3ExprAnalyzeAggList(&sNC, sAggInfo.aFunc[i].pExpr->x.pList);
50043a8c4be7Sdrh       sNC.ncFlags &= ~NC_InAggFunc;
500513449892Sdrh     }
50067e61d18eSdrh     sAggInfo.mxReg = pParse->nMem;
500717435752Sdrh     if( db->mallocFailed ) goto select_end;
500813449892Sdrh 
500913449892Sdrh     /* Processing for aggregates with GROUP BY is very different and
50103c4809a2Sdanielk1977     ** much more complex than aggregates without a GROUP BY.
501113449892Sdrh     */
501213449892Sdrh     if( pGroupBy ){
501313449892Sdrh       KeyInfo *pKeyInfo;  /* Keying information for the group by clause */
5014d176611bSdrh       int j1;             /* A-vs-B comparision jump */
5015d176611bSdrh       int addrOutputRow;  /* Start of subroutine that outputs a result row */
5016d176611bSdrh       int regOutputRow;   /* Return address register for output subroutine */
5017d176611bSdrh       int addrSetAbort;   /* Set the abort flag and return */
5018d176611bSdrh       int addrTopOfLoop;  /* Top of the input loop */
5019d176611bSdrh       int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
5020d176611bSdrh       int addrReset;      /* Subroutine for resetting the accumulator */
5021d176611bSdrh       int regReset;       /* Return address register for reset subroutine */
502213449892Sdrh 
502313449892Sdrh       /* If there is a GROUP BY clause we might need a sorting index to
502413449892Sdrh       ** implement it.  Allocate that sorting index now.  If it turns out
50251c9d835dSdrh       ** that we do not need it after all, the OP_SorterOpen instruction
502613449892Sdrh       ** will be converted into a Noop.
502713449892Sdrh       */
502813449892Sdrh       sAggInfo.sortingIdx = pParse->nTab++;
5029079a3072Sdrh       pKeyInfo = keyInfoFromExprList(pParse, pGroupBy, 0, 0);
50301c9d835dSdrh       addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
5031cd3e8f7cSdanielk1977           sAggInfo.sortingIdx, sAggInfo.nSortingColumn,
50322ec2fb22Sdrh           0, (char*)pKeyInfo, P4_KEYINFO);
503313449892Sdrh 
503413449892Sdrh       /* Initialize memory locations used by GROUP BY aggregate processing
503513449892Sdrh       */
50360a07c107Sdrh       iUseFlag = ++pParse->nMem;
50370a07c107Sdrh       iAbortFlag = ++pParse->nMem;
5038d176611bSdrh       regOutputRow = ++pParse->nMem;
5039d176611bSdrh       addrOutputRow = sqlite3VdbeMakeLabel(v);
5040d176611bSdrh       regReset = ++pParse->nMem;
5041d176611bSdrh       addrReset = sqlite3VdbeMakeLabel(v);
50420a07c107Sdrh       iAMem = pParse->nMem + 1;
504313449892Sdrh       pParse->nMem += pGroupBy->nExpr;
50440a07c107Sdrh       iBMem = pParse->nMem + 1;
504513449892Sdrh       pParse->nMem += pGroupBy->nExpr;
50464c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
5047d4e70ebdSdrh       VdbeComment((v, "clear abort flag"));
50484c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
5049d4e70ebdSdrh       VdbeComment((v, "indicate accumulator empty"));
5050b8475df8Sdrh       sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
5051e313382eSdrh 
505213449892Sdrh       /* Begin a loop that will extract all source rows in GROUP BY order.
505313449892Sdrh       ** This might involve two separate loops with an OP_Sort in between, or
505413449892Sdrh       ** it might be a single loop that uses an index to extract information
505513449892Sdrh       ** in the right order to begin with.
505613449892Sdrh       */
50572eb95377Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
505893ec45d5Sdrh       pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, 0,
5059374cd78cSdan           WHERE_GROUPBY | (orderByGrp ? WHERE_SORTBYGROUP : 0), 0
5060374cd78cSdan       );
50615360ad34Sdrh       if( pWInfo==0 ) goto select_end;
5062ddba0c22Sdrh       if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
506313449892Sdrh         /* The optimizer is able to deliver rows in group by order so
5064b9bb7c18Sdrh         ** we do not have to sort.  The OP_OpenEphemeral table will be
506513449892Sdrh         ** cancelled later because we still need to use the pKeyInfo
506613449892Sdrh         */
506713449892Sdrh         groupBySort = 0;
506813449892Sdrh       }else{
506913449892Sdrh         /* Rows are coming out in undetermined order.  We have to push
507013449892Sdrh         ** each row into a sorting index, terminate the first loop,
507113449892Sdrh         ** then loop over the sorting index in order to get the output
507213449892Sdrh         ** in sorted order
507313449892Sdrh         */
5074892d3179Sdrh         int regBase;
5075892d3179Sdrh         int regRecord;
5076892d3179Sdrh         int nCol;
5077892d3179Sdrh         int nGroupBy;
5078892d3179Sdrh 
50792ce22453Sdan         explainTempTable(pParse,
5080e8e4af76Sdrh             (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
5081e8e4af76Sdrh                     "DISTINCT" : "GROUP BY");
50822ce22453Sdan 
508313449892Sdrh         groupBySort = 1;
5084892d3179Sdrh         nGroupBy = pGroupBy->nExpr;
5085dd23c6bfSdan         nCol = nGroupBy;
5086dd23c6bfSdan         j = nGroupBy;
508713449892Sdrh         for(i=0; i<sAggInfo.nColumn; i++){
5088892d3179Sdrh           if( sAggInfo.aCol[i].iSorterColumn>=j ){
5089892d3179Sdrh             nCol++;
509013449892Sdrh             j++;
509113449892Sdrh           }
5092892d3179Sdrh         }
5093892d3179Sdrh         regBase = sqlite3GetTempRange(pParse, nCol);
5094ceea3321Sdrh         sqlite3ExprCacheClear(pParse);
5095191b54cbSdrh         sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0);
5096dd23c6bfSdan         j = nGroupBy;
5097892d3179Sdrh         for(i=0; i<sAggInfo.nColumn; i++){
5098892d3179Sdrh           struct AggInfo_col *pCol = &sAggInfo.aCol[i];
5099892d3179Sdrh           if( pCol->iSorterColumn>=j ){
5100e55cbd72Sdrh             int r1 = j + regBase;
51016a012f04Sdrh             int r2;
5102701bb3b4Sdrh 
51036a012f04Sdrh             r2 = sqlite3ExprCodeGetColumn(pParse,
5104a748fdccSdrh                                pCol->pTab, pCol->iColumn, pCol->iTable, r1, 0);
51056a012f04Sdrh             if( r1!=r2 ){
51066a012f04Sdrh               sqlite3VdbeAddOp2(v, OP_SCopy, r2, r1);
51076a012f04Sdrh             }
51086a012f04Sdrh             j++;
5109892d3179Sdrh           }
5110892d3179Sdrh         }
5111892d3179Sdrh         regRecord = sqlite3GetTempReg(pParse);
51121db639ceSdrh         sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
51131c9d835dSdrh         sqlite3VdbeAddOp2(v, OP_SorterInsert, sAggInfo.sortingIdx, regRecord);
5114892d3179Sdrh         sqlite3ReleaseTempReg(pParse, regRecord);
5115892d3179Sdrh         sqlite3ReleaseTempRange(pParse, regBase, nCol);
511613449892Sdrh         sqlite3WhereEnd(pWInfo);
51175134d135Sdan         sAggInfo.sortingIdxPTab = sortPTab = pParse->nTab++;
51181c9d835dSdrh         sortOut = sqlite3GetTempReg(pParse);
51191c9d835dSdrh         sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
51201c9d835dSdrh         sqlite3VdbeAddOp2(v, OP_SorterSort, sAggInfo.sortingIdx, addrEnd);
5121688852abSdrh         VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
512213449892Sdrh         sAggInfo.useSortingIdx = 1;
5123ceea3321Sdrh         sqlite3ExprCacheClear(pParse);
5124374cd78cSdan 
5125374cd78cSdan       }
5126374cd78cSdan 
5127374cd78cSdan       /* If the index or temporary table used by the GROUP BY sort
5128374cd78cSdan       ** will naturally deliver rows in the order required by the ORDER BY
5129374cd78cSdan       ** clause, cancel the ephemeral table open coded earlier.
5130374cd78cSdan       **
5131374cd78cSdan       ** This is an optimization - the correct answer should result regardless.
5132374cd78cSdan       ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
5133374cd78cSdan       ** disable this optimization for testing purposes.  */
5134374cd78cSdan       if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
5135374cd78cSdan        && (groupBySort || sqlite3WhereIsSorted(pWInfo))
5136374cd78cSdan       ){
5137374cd78cSdan         sSort.pOrderBy = 0;
5138374cd78cSdan         sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
513913449892Sdrh       }
514013449892Sdrh 
514113449892Sdrh       /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
514213449892Sdrh       ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
514313449892Sdrh       ** Then compare the current GROUP BY terms against the GROUP BY terms
514413449892Sdrh       ** from the previous row currently stored in a0, a1, a2...
514513449892Sdrh       */
514613449892Sdrh       addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
5147ceea3321Sdrh       sqlite3ExprCacheClear(pParse);
51481c9d835dSdrh       if( groupBySort ){
51491c9d835dSdrh         sqlite3VdbeAddOp2(v, OP_SorterData, sAggInfo.sortingIdx, sortOut);
51501c9d835dSdrh       }
515113449892Sdrh       for(j=0; j<pGroupBy->nExpr; j++){
515213449892Sdrh         if( groupBySort ){
51531c9d835dSdrh           sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
51541c9d835dSdrh           if( j==0 ) sqlite3VdbeChangeP5(v, OPFLAG_CLEARCACHE);
515513449892Sdrh         }else{
515613449892Sdrh           sAggInfo.directMode = 1;
51572dcef11bSdrh           sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
515813449892Sdrh         }
515913449892Sdrh       }
516016ee60ffSdrh       sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
51612ec2fb22Sdrh                           (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
516216ee60ffSdrh       j1 = sqlite3VdbeCurrentAddr(v);
5163688852abSdrh       sqlite3VdbeAddOp3(v, OP_Jump, j1+1, 0, j1+1); VdbeCoverage(v);
516413449892Sdrh 
516513449892Sdrh       /* Generate code that runs whenever the GROUP BY changes.
5166e00ee6ebSdrh       ** Changes in the GROUP BY are detected by the previous code
516713449892Sdrh       ** block.  If there were no changes, this block is skipped.
516813449892Sdrh       **
516913449892Sdrh       ** This code copies current group by terms in b0,b1,b2,...
517013449892Sdrh       ** over to a0,a1,a2.  It then calls the output subroutine
517113449892Sdrh       ** and resets the aggregate accumulator registers in preparation
517213449892Sdrh       ** for the next GROUP BY batch.
517313449892Sdrh       */
5174b21e7c70Sdrh       sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
51752eb95377Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
5176d4e70ebdSdrh       VdbeComment((v, "output one row"));
5177688852abSdrh       sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
5178d4e70ebdSdrh       VdbeComment((v, "check abort flag"));
51792eb95377Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
5180d4e70ebdSdrh       VdbeComment((v, "reset accumulator"));
518113449892Sdrh 
518213449892Sdrh       /* Update the aggregate accumulators based on the content of
518313449892Sdrh       ** the current row
518413449892Sdrh       */
518516ee60ffSdrh       sqlite3VdbeJumpHere(v, j1);
518613449892Sdrh       updateAccumulator(pParse, &sAggInfo);
51874c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
5188d4e70ebdSdrh       VdbeComment((v, "indicate data in accumulator"));
518913449892Sdrh 
519013449892Sdrh       /* End of the loop
519113449892Sdrh       */
519213449892Sdrh       if( groupBySort ){
51931c9d835dSdrh         sqlite3VdbeAddOp2(v, OP_SorterNext, sAggInfo.sortingIdx, addrTopOfLoop);
5194688852abSdrh         VdbeCoverage(v);
519513449892Sdrh       }else{
519613449892Sdrh         sqlite3WhereEnd(pWInfo);
519748f2d3b1Sdrh         sqlite3VdbeChangeToNoop(v, addrSortingIdx);
519813449892Sdrh       }
519913449892Sdrh 
520013449892Sdrh       /* Output the final row of result
520113449892Sdrh       */
52022eb95377Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
5203d4e70ebdSdrh       VdbeComment((v, "output final row"));
520413449892Sdrh 
5205d176611bSdrh       /* Jump over the subroutines
5206d176611bSdrh       */
5207d176611bSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, addrEnd);
5208d176611bSdrh 
5209d176611bSdrh       /* Generate a subroutine that outputs a single row of the result
5210d176611bSdrh       ** set.  This subroutine first looks at the iUseFlag.  If iUseFlag
5211d176611bSdrh       ** is less than or equal to zero, the subroutine is a no-op.  If
5212d176611bSdrh       ** the processing calls for the query to abort, this subroutine
5213d176611bSdrh       ** increments the iAbortFlag memory location before returning in
5214d176611bSdrh       ** order to signal the caller to abort.
5215d176611bSdrh       */
5216d176611bSdrh       addrSetAbort = sqlite3VdbeCurrentAddr(v);
5217d176611bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
5218d176611bSdrh       VdbeComment((v, "set abort flag"));
5219d176611bSdrh       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
5220d176611bSdrh       sqlite3VdbeResolveLabel(v, addrOutputRow);
5221d176611bSdrh       addrOutputRow = sqlite3VdbeCurrentAddr(v);
5222688852abSdrh       sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2); VdbeCoverage(v);
5223d176611bSdrh       VdbeComment((v, "Groupby result generator entry point"));
5224d176611bSdrh       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
5225d176611bSdrh       finalizeAggFunctions(pParse, &sAggInfo);
5226d176611bSdrh       sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
5227079a3072Sdrh       selectInnerLoop(pParse, p, p->pEList, -1, &sSort,
5228e8e4af76Sdrh                       &sDistinct, pDest,
5229d176611bSdrh                       addrOutputRow+1, addrSetAbort);
5230d176611bSdrh       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
5231d176611bSdrh       VdbeComment((v, "end groupby result generator"));
5232d176611bSdrh 
5233d176611bSdrh       /* Generate a subroutine that will reset the group-by accumulator
5234d176611bSdrh       */
5235d176611bSdrh       sqlite3VdbeResolveLabel(v, addrReset);
5236d176611bSdrh       resetAccumulator(pParse, &sAggInfo);
5237d176611bSdrh       sqlite3VdbeAddOp1(v, OP_Return, regReset);
5238d176611bSdrh 
523943152cf8Sdrh     } /* endif pGroupBy.  Begin aggregate queries without GROUP BY: */
524013449892Sdrh     else {
5241dba0137eSdanielk1977       ExprList *pDel = 0;
5242a5533162Sdanielk1977 #ifndef SQLITE_OMIT_BTREECOUNT
5243a5533162Sdanielk1977       Table *pTab;
5244a5533162Sdanielk1977       if( (pTab = isSimpleCount(p, &sAggInfo))!=0 ){
5245a5533162Sdanielk1977         /* If isSimpleCount() returns a pointer to a Table structure, then
5246a5533162Sdanielk1977         ** the SQL statement is of the form:
5247a5533162Sdanielk1977         **
5248a5533162Sdanielk1977         **   SELECT count(*) FROM <tbl>
5249a5533162Sdanielk1977         **
5250a5533162Sdanielk1977         ** where the Table structure returned represents table <tbl>.
5251a5533162Sdanielk1977         **
5252a5533162Sdanielk1977         ** This statement is so common that it is optimized specially. The
5253a5533162Sdanielk1977         ** OP_Count instruction is executed either on the intkey table that
5254a5533162Sdanielk1977         ** contains the data for table <tbl> or on one of its indexes. It
5255a5533162Sdanielk1977         ** is better to execute the op on an index, as indexes are almost
5256a5533162Sdanielk1977         ** always spread across less pages than their corresponding tables.
5257a5533162Sdanielk1977         */
5258a5533162Sdanielk1977         const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
5259a5533162Sdanielk1977         const int iCsr = pParse->nTab++;     /* Cursor to scan b-tree */
5260a5533162Sdanielk1977         Index *pIdx;                         /* Iterator variable */
5261a5533162Sdanielk1977         KeyInfo *pKeyInfo = 0;               /* Keyinfo for scanned index */
5262a5533162Sdanielk1977         Index *pBest = 0;                    /* Best index found so far */
5263a5533162Sdanielk1977         int iRoot = pTab->tnum;              /* Root page of scanned b-tree */
5264a9d1ccb9Sdanielk1977 
5265a5533162Sdanielk1977         sqlite3CodeVerifySchema(pParse, iDb);
5266a5533162Sdanielk1977         sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
5267a5533162Sdanielk1977 
5268d9e3cad2Sdrh         /* Search for the index that has the lowest scan cost.
5269a5533162Sdanielk1977         **
52703e9548b3Sdrh         ** (2011-04-15) Do not do a full scan of an unordered index.
52713e9548b3Sdrh         **
5272abcc1941Sdrh         ** (2013-10-03) Do not count the entries in a partial index.
52735f33f375Sdrh         **
5274a5533162Sdanielk1977         ** In practice the KeyInfo structure will not be used. It is only
5275a5533162Sdanielk1977         ** passed to keep OP_OpenRead happy.
5276a5533162Sdanielk1977         */
52775c7917e4Sdrh         if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
5278a5533162Sdanielk1977         for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
5279d9e3cad2Sdrh           if( pIdx->bUnordered==0
5280e13e9f54Sdrh            && pIdx->szIdxRow<pTab->szTabRow
5281d3037a41Sdrh            && pIdx->pPartIdxWhere==0
5282e13e9f54Sdrh            && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
5283d9e3cad2Sdrh           ){
5284a5533162Sdanielk1977             pBest = pIdx;
5285a5533162Sdanielk1977           }
5286a5533162Sdanielk1977         }
5287d9e3cad2Sdrh         if( pBest ){
5288a5533162Sdanielk1977           iRoot = pBest->tnum;
52892ec2fb22Sdrh           pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
5290a5533162Sdanielk1977         }
5291a5533162Sdanielk1977 
5292a5533162Sdanielk1977         /* Open a read-only cursor, execute the OP_Count, close the cursor. */
5293261c02d9Sdrh         sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, iRoot, iDb, 1);
5294a5533162Sdanielk1977         if( pKeyInfo ){
52952ec2fb22Sdrh           sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
5296a5533162Sdanielk1977         }
5297a5533162Sdanielk1977         sqlite3VdbeAddOp2(v, OP_Count, iCsr, sAggInfo.aFunc[0].iMem);
5298a5533162Sdanielk1977         sqlite3VdbeAddOp1(v, OP_Close, iCsr);
5299ef7075deSdan         explainSimpleCount(pParse, pTab, pBest);
5300a5533162Sdanielk1977       }else
5301a5533162Sdanielk1977 #endif /* SQLITE_OMIT_BTREECOUNT */
5302a5533162Sdanielk1977       {
5303738bdcfbSdanielk1977         /* Check if the query is of one of the following forms:
5304738bdcfbSdanielk1977         **
5305738bdcfbSdanielk1977         **   SELECT min(x) FROM ...
5306738bdcfbSdanielk1977         **   SELECT max(x) FROM ...
5307738bdcfbSdanielk1977         **
5308738bdcfbSdanielk1977         ** If it is, then ask the code in where.c to attempt to sort results
5309738bdcfbSdanielk1977         ** as if there was an "ORDER ON x" or "ORDER ON x DESC" clause.
5310738bdcfbSdanielk1977         ** If where.c is able to produce results sorted in this order, then
5311738bdcfbSdanielk1977         ** add vdbe code to break out of the processing loop after the
5312738bdcfbSdanielk1977         ** first iteration (since the first iteration of the loop is
5313738bdcfbSdanielk1977         ** guaranteed to operate on the row with the minimum or maximum
5314738bdcfbSdanielk1977         ** value of x, the only row required).
5315738bdcfbSdanielk1977         **
5316738bdcfbSdanielk1977         ** A special flag must be passed to sqlite3WhereBegin() to slightly
531748864df9Smistachkin         ** modify behavior as follows:
5318738bdcfbSdanielk1977         **
5319738bdcfbSdanielk1977         **   + If the query is a "SELECT min(x)", then the loop coded by
5320738bdcfbSdanielk1977         **     where.c should not iterate over any values with a NULL value
5321738bdcfbSdanielk1977         **     for x.
5322738bdcfbSdanielk1977         **
5323738bdcfbSdanielk1977         **   + The optimizer code in where.c (the thing that decides which
5324738bdcfbSdanielk1977         **     index or indices to use) should place a different priority on
5325738bdcfbSdanielk1977         **     satisfying the 'ORDER BY' clause than it does in other cases.
5326738bdcfbSdanielk1977         **     Refer to code and comments in where.c for details.
5327738bdcfbSdanielk1977         */
5328a5533162Sdanielk1977         ExprList *pMinMax = 0;
53294ac391fcSdan         u8 flag = WHERE_ORDERBY_NORMAL;
53304ac391fcSdan 
53314ac391fcSdan         assert( p->pGroupBy==0 );
53324ac391fcSdan         assert( flag==0 );
53334ac391fcSdan         if( p->pHaving==0 ){
53344ac391fcSdan           flag = minMaxQuery(&sAggInfo, &pMinMax);
53354ac391fcSdan         }
53364ac391fcSdan         assert( flag==0 || (pMinMax!=0 && pMinMax->nExpr==1) );
53374ac391fcSdan 
5338a9d1ccb9Sdanielk1977         if( flag ){
53394ac391fcSdan           pMinMax = sqlite3ExprListDup(db, pMinMax, 0);
53406ab3a2ecSdanielk1977           pDel = pMinMax;
53410e359b30Sdrh           if( pMinMax && !db->mallocFailed ){
5342ea678832Sdrh             pMinMax->a[0].sortOrder = flag!=WHERE_ORDERBY_MIN ?1:0;
5343a9d1ccb9Sdanielk1977             pMinMax->a[0].pExpr->op = TK_COLUMN;
5344a9d1ccb9Sdanielk1977           }
53451013c932Sdrh         }
5346a9d1ccb9Sdanielk1977 
534713449892Sdrh         /* This case runs if the aggregate has no GROUP BY clause.  The
534813449892Sdrh         ** processing is much simpler since there is only a single row
534913449892Sdrh         ** of output.
535013449892Sdrh         */
535113449892Sdrh         resetAccumulator(pParse, &sAggInfo);
535246ec5b63Sdrh         pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMax,0,flag,0);
5353dba0137eSdanielk1977         if( pWInfo==0 ){
5354633e6d57Sdrh           sqlite3ExprListDelete(db, pDel);
5355dba0137eSdanielk1977           goto select_end;
5356dba0137eSdanielk1977         }
535713449892Sdrh         updateAccumulator(pParse, &sAggInfo);
535846c35f9bSdrh         assert( pMinMax==0 || pMinMax->nExpr==1 );
5359ddba0c22Sdrh         if( sqlite3WhereIsOrdered(pWInfo)>0 ){
53606f32848dSdrh           sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3WhereBreakLabel(pWInfo));
5361a5533162Sdanielk1977           VdbeComment((v, "%s() by index",
5362a5533162Sdanielk1977                 (flag==WHERE_ORDERBY_MIN?"min":"max")));
5363a9d1ccb9Sdanielk1977         }
536413449892Sdrh         sqlite3WhereEnd(pWInfo);
536513449892Sdrh         finalizeAggFunctions(pParse, &sAggInfo);
53667a895a80Sdanielk1977       }
53677a895a80Sdanielk1977 
5368079a3072Sdrh       sSort.pOrderBy = 0;
536935573356Sdrh       sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
5370079a3072Sdrh       selectInnerLoop(pParse, p, p->pEList, -1, 0, 0,
5371a9671a22Sdrh                       pDest, addrEnd, addrEnd);
5372633e6d57Sdrh       sqlite3ExprListDelete(db, pDel);
537313449892Sdrh     }
537413449892Sdrh     sqlite3VdbeResolveLabel(v, addrEnd);
537513449892Sdrh 
537613449892Sdrh   } /* endif aggregate query */
53772282792aSdrh 
5378e8e4af76Sdrh   if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
53792ce22453Sdan     explainTempTable(pParse, "DISTINCT");
53802ce22453Sdan   }
53812ce22453Sdan 
5382cce7d176Sdrh   /* If there is an ORDER BY clause, then we need to sort the results
5383cce7d176Sdrh   ** and send them to the callback one by one.
5384cce7d176Sdrh   */
5385079a3072Sdrh   if( sSort.pOrderBy ){
53866284db90Sdrh     explainTempTable(pParse, sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
5387079a3072Sdrh     generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
5388cce7d176Sdrh   }
53896a535340Sdrh 
5390ec7429aeSdrh   /* Jump here to skip this query
5391ec7429aeSdrh   */
5392ec7429aeSdrh   sqlite3VdbeResolveLabel(v, iEnd);
5393ec7429aeSdrh 
53941d83f052Sdrh   /* The SELECT was successfully coded.   Set the return code to 0
53951d83f052Sdrh   ** to indicate no errors.
53961d83f052Sdrh   */
53971d83f052Sdrh   rc = 0;
53981d83f052Sdrh 
53991d83f052Sdrh   /* Control jumps to here if an error is encountered above, or upon
54001d83f052Sdrh   ** successful coding of the SELECT.
54011d83f052Sdrh   */
54021d83f052Sdrh select_end:
540317c0bc0cSdan   explainSetInteger(pParse->iSelectId, iRestoreSelectId);
5404955de52cSdanielk1977 
54057d10d5a6Sdrh   /* Identify column names if results of the SELECT are to be output.
5406955de52cSdanielk1977   */
54077d10d5a6Sdrh   if( rc==SQLITE_OK && pDest->eDest==SRT_Output ){
5408955de52cSdanielk1977     generateColumnNames(pParse, pTabList, pEList);
5409955de52cSdanielk1977   }
5410955de52cSdanielk1977 
5411633e6d57Sdrh   sqlite3DbFree(db, sAggInfo.aCol);
5412633e6d57Sdrh   sqlite3DbFree(db, sAggInfo.aFunc);
5413eb9b884cSdrh #if SELECTTRACE_ENABLED
5414eb9b884cSdrh   SELECTTRACE(1,pParse,p,("end processing\n"));
5415eb9b884cSdrh   pParse->nSelectIndent--;
5416eb9b884cSdrh #endif
54171d83f052Sdrh   return rc;
5418cce7d176Sdrh }
5419485f0039Sdrh 
5420*4fa4a54fSdrh #ifdef SQLITE_DEBUG
5421485f0039Sdrh /*
54227e02e5e6Sdrh ** Generate a human-readable description of a the Select object.
5423485f0039Sdrh */
5424*4fa4a54fSdrh void sqlite3TreeViewSelect(TreeView *pView, const Select *p, u8 moreToFollow){
5425*4fa4a54fSdrh   pView = sqlite3TreeViewPush(pView, moreToFollow);
5426*4fa4a54fSdrh   sqlite3TreeViewLine(pView, "SELECT%s%s",
5427*4fa4a54fSdrh     ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""),
5428*4fa4a54fSdrh     ((p->selFlags & SF_Aggregate) ? " agg_flag" : "")
5429*4fa4a54fSdrh   );
5430*4fa4a54fSdrh   sqlite3TreeViewExprList(pView, p->pEList, 1, "result-set");
54317e02e5e6Sdrh   if( p->pSrc && p->pSrc->nSrc ){
5432485f0039Sdrh     int i;
5433*4fa4a54fSdrh     pView = sqlite3TreeViewPush(pView, 1);
5434*4fa4a54fSdrh     sqlite3TreeViewLine(pView, "FROM");
5435485f0039Sdrh     for(i=0; i<p->pSrc->nSrc; i++){
5436485f0039Sdrh       struct SrcList_item *pItem = &p->pSrc->a[i];
5437*4fa4a54fSdrh       StrAccum x;
5438*4fa4a54fSdrh       char zLine[100];
5439*4fa4a54fSdrh       sqlite3StrAccumInit(&x, zLine, sizeof(zLine), 0);
5440*4fa4a54fSdrh       sqlite3XPrintf(&x, 0, "{%d,*}", pItem->iCursor);
5441*4fa4a54fSdrh       if( pItem->zDatabase ){
5442*4fa4a54fSdrh         sqlite3XPrintf(&x, 0, " %s.%s", pItem->zDatabase, pItem->zName);
5443485f0039Sdrh       }else if( pItem->zName ){
5444*4fa4a54fSdrh         sqlite3XPrintf(&x, 0, " %s", pItem->zName);
5445*4fa4a54fSdrh       }
5446*4fa4a54fSdrh       if( pItem->pTab ){
5447*4fa4a54fSdrh         sqlite3XPrintf(&x, 0, " tabname=%Q", pItem->pTab->zName);
5448485f0039Sdrh       }
5449485f0039Sdrh       if( pItem->zAlias ){
5450*4fa4a54fSdrh         sqlite3XPrintf(&x, 0, " (AS %s)", pItem->zAlias);
5451485f0039Sdrh       }
5452a84203a0Sdrh       if( pItem->jointype & JT_LEFT ){
5453*4fa4a54fSdrh         sqlite3XPrintf(&x, 0, " LEFT-JOIN");
5454485f0039Sdrh       }
5455*4fa4a54fSdrh       sqlite3StrAccumFinish(&x);
5456*4fa4a54fSdrh       sqlite3TreeViewItem(pView, zLine, i<p->pSrc->nSrc-1);
5457*4fa4a54fSdrh       if( pItem->pSelect ){
5458*4fa4a54fSdrh         sqlite3TreeViewSelect(pView, pItem->pSelect, 0);
5459485f0039Sdrh       }
5460*4fa4a54fSdrh       sqlite3TreeViewPop(pView);
5461*4fa4a54fSdrh     }
5462*4fa4a54fSdrh     sqlite3TreeViewPop(pView);
5463485f0039Sdrh   }
5464485f0039Sdrh   if( p->pWhere ){
5465*4fa4a54fSdrh     sqlite3TreeViewItem(pView, "WHERE", 1);
5466*4fa4a54fSdrh     sqlite3TreeViewExpr(pView, p->pWhere, 0);
5467*4fa4a54fSdrh     sqlite3TreeViewPop(pView);
5468485f0039Sdrh   }
5469485f0039Sdrh   if( p->pGroupBy ){
5470*4fa4a54fSdrh     sqlite3TreeViewExprList(pView, p->pGroupBy, 1, "GROUPBY");
5471485f0039Sdrh   }
5472485f0039Sdrh   if( p->pHaving ){
5473*4fa4a54fSdrh     sqlite3TreeViewItem(pView, "HAVING", 1);
5474*4fa4a54fSdrh     sqlite3TreeViewExpr(pView, p->pHaving, 0);
5475*4fa4a54fSdrh     sqlite3TreeViewPop(pView);
5476485f0039Sdrh   }
5477485f0039Sdrh   if( p->pOrderBy ){
5478*4fa4a54fSdrh     sqlite3TreeViewExprList(pView, p->pOrderBy, 1, "ORDERBY");
5479485f0039Sdrh   }
5480a84203a0Sdrh   if( p->pLimit ){
5481*4fa4a54fSdrh     sqlite3TreeViewItem(pView, "LIMIT", 1);
5482*4fa4a54fSdrh     sqlite3TreeViewExpr(pView, p->pLimit, 0);
5483*4fa4a54fSdrh     sqlite3TreeViewPop(pView);
5484a84203a0Sdrh   }
5485a84203a0Sdrh   if( p->pOffset ){
5486*4fa4a54fSdrh     sqlite3TreeViewItem(pView, "OFFSET", 1);
5487*4fa4a54fSdrh     sqlite3TreeViewExpr(pView, p->pOffset, 0);
5488*4fa4a54fSdrh     sqlite3TreeViewPop(pView);
5489485f0039Sdrh   }
5490*4fa4a54fSdrh   if( p->pPrior ){
5491*4fa4a54fSdrh     const char *zOp = "UNION";
5492*4fa4a54fSdrh     switch( p->op ){
5493*4fa4a54fSdrh       case TK_ALL:         zOp = "UNION ALL";  break;
5494*4fa4a54fSdrh       case TK_INTERSECT:   zOp = "INTERSECT";  break;
5495*4fa4a54fSdrh       case TK_EXCEPT:      zOp = "EXCEPT";     break;
5496485f0039Sdrh     }
5497*4fa4a54fSdrh     sqlite3TreeViewItem(pView, zOp, 1);
5498*4fa4a54fSdrh     sqlite3TreeViewSelect(pView, p->pPrior, 1);
5499*4fa4a54fSdrh     sqlite3TreeViewPop(pView);
5500a84203a0Sdrh   }
5501*4fa4a54fSdrh   sqlite3TreeViewItem(pView, "END-SELECT", 0);
5502*4fa4a54fSdrh   sqlite3TreeViewPop(pView);
5503*4fa4a54fSdrh   sqlite3TreeViewPop(pView);
5504a84203a0Sdrh }
5505*4fa4a54fSdrh #endif /* SQLITE_DEBUG */
5506