xref: /sqlite-3.40.0/src/select.c (revision 3afd2b4d)
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 /*
61b87fbed5Sdrh ** Delete all the content of a Select structure.  Deallocate the structure
62b87fbed5Sdrh ** itself only if bFree is true.
63eda639e1Sdrh */
64b87fbed5Sdrh static void clearSelect(sqlite3 *db, Select *p, int bFree){
65b87fbed5Sdrh   while( p ){
66b87fbed5Sdrh     Select *pPrior = p->pPrior;
67633e6d57Sdrh     sqlite3ExprListDelete(db, p->pEList);
68633e6d57Sdrh     sqlite3SrcListDelete(db, p->pSrc);
69633e6d57Sdrh     sqlite3ExprDelete(db, p->pWhere);
70633e6d57Sdrh     sqlite3ExprListDelete(db, p->pGroupBy);
71633e6d57Sdrh     sqlite3ExprDelete(db, p->pHaving);
72633e6d57Sdrh     sqlite3ExprListDelete(db, p->pOrderBy);
73633e6d57Sdrh     sqlite3ExprDelete(db, p->pLimit);
74633e6d57Sdrh     sqlite3ExprDelete(db, p->pOffset);
754e9119d9Sdan     sqlite3WithDelete(db, p->pWith);
76b87fbed5Sdrh     if( bFree ) sqlite3DbFree(db, p);
77b87fbed5Sdrh     p = pPrior;
78b87fbed5Sdrh     bFree = 1;
79b87fbed5Sdrh   }
80eda639e1Sdrh }
81eda639e1Sdrh 
821013c932Sdrh /*
831013c932Sdrh ** Initialize a SelectDest structure.
841013c932Sdrh */
851013c932Sdrh void sqlite3SelectDestInit(SelectDest *pDest, int eDest, int iParm){
86ea678832Sdrh   pDest->eDest = (u8)eDest;
872b596da8Sdrh   pDest->iSDParm = iParm;
882b596da8Sdrh   pDest->affSdst = 0;
892b596da8Sdrh   pDest->iSdst = 0;
902b596da8Sdrh   pDest->nSdst = 0;
911013c932Sdrh }
921013c932Sdrh 
93eda639e1Sdrh 
94eda639e1Sdrh /*
959bb61fe7Sdrh ** Allocate a new Select structure and return a pointer to that
969bb61fe7Sdrh ** structure.
97cce7d176Sdrh */
984adee20fSdanielk1977 Select *sqlite3SelectNew(
9917435752Sdrh   Parse *pParse,        /* Parsing context */
100daffd0e5Sdrh   ExprList *pEList,     /* which columns to include in the result */
101ad3cab52Sdrh   SrcList *pSrc,        /* the FROM clause -- which tables to scan */
102daffd0e5Sdrh   Expr *pWhere,         /* the WHERE clause */
103daffd0e5Sdrh   ExprList *pGroupBy,   /* the GROUP BY clause */
104daffd0e5Sdrh   Expr *pHaving,        /* the HAVING clause */
105daffd0e5Sdrh   ExprList *pOrderBy,   /* the ORDER BY clause */
106832ee3d4Sdrh   u16 selFlags,         /* Flag parameters, such as SF_Distinct */
107a2dc3b1aSdanielk1977   Expr *pLimit,         /* LIMIT value.  NULL means not used */
108a2dc3b1aSdanielk1977   Expr *pOffset         /* OFFSET value.  NULL means no offset */
1099bb61fe7Sdrh ){
1109bb61fe7Sdrh   Select *pNew;
111eda639e1Sdrh   Select standin;
11217435752Sdrh   sqlite3 *db = pParse->db;
11317435752Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
114d72a276eSdrh   assert( db->mallocFailed || !pOffset || pLimit ); /* OFFSET implies LIMIT */
115daffd0e5Sdrh   if( pNew==0 ){
116338ec3e1Sdrh     assert( db->mallocFailed );
117eda639e1Sdrh     pNew = &standin;
118eda639e1Sdrh     memset(pNew, 0, sizeof(*pNew));
119eda639e1Sdrh   }
120b733d037Sdrh   if( pEList==0 ){
121b7916a78Sdrh     pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db,TK_ALL,0));
122b733d037Sdrh   }
1239bb61fe7Sdrh   pNew->pEList = pEList;
1247b113babSdrh   if( pSrc==0 ) pSrc = sqlite3DbMallocZero(db, sizeof(*pSrc));
1259bb61fe7Sdrh   pNew->pSrc = pSrc;
1269bb61fe7Sdrh   pNew->pWhere = pWhere;
1279bb61fe7Sdrh   pNew->pGroupBy = pGroupBy;
1289bb61fe7Sdrh   pNew->pHaving = pHaving;
1299bb61fe7Sdrh   pNew->pOrderBy = pOrderBy;
130832ee3d4Sdrh   pNew->selFlags = selFlags;
13182c3d636Sdrh   pNew->op = TK_SELECT;
132a2dc3b1aSdanielk1977   pNew->pLimit = pLimit;
133a2dc3b1aSdanielk1977   pNew->pOffset = pOffset;
134373cc2ddSdrh   assert( pOffset==0 || pLimit!=0 );
135b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
136b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1370a846f96Sdrh   if( db->mallocFailed ) {
138b87fbed5Sdrh     clearSelect(db, pNew, pNew!=&standin);
139eda639e1Sdrh     pNew = 0;
140a464c234Sdrh   }else{
141a464c234Sdrh     assert( pNew->pSrc!=0 || pParse->nErr>0 );
142daffd0e5Sdrh   }
143338ec3e1Sdrh   assert( pNew!=&standin );
1449bb61fe7Sdrh   return pNew;
1459bb61fe7Sdrh }
1469bb61fe7Sdrh 
147eb9b884cSdrh #if SELECTTRACE_ENABLED
148eb9b884cSdrh /*
149eb9b884cSdrh ** Set the name of a Select object
150eb9b884cSdrh */
151eb9b884cSdrh void sqlite3SelectSetName(Select *p, const char *zName){
152eb9b884cSdrh   if( p && zName ){
153eb9b884cSdrh     sqlite3_snprintf(sizeof(p->zSelName), p->zSelName, "%s", zName);
154eb9b884cSdrh   }
155eb9b884cSdrh }
156eb9b884cSdrh #endif
157eb9b884cSdrh 
158eb9b884cSdrh 
1599bb61fe7Sdrh /*
160eda639e1Sdrh ** Delete the given Select structure and all of its substructures.
161eda639e1Sdrh */
162633e6d57Sdrh void sqlite3SelectDelete(sqlite3 *db, Select *p){
163b87fbed5Sdrh   clearSelect(db, p, 1);
164eda639e1Sdrh }
165eda639e1Sdrh 
166eda639e1Sdrh /*
167d227a291Sdrh ** Return a pointer to the right-most SELECT statement in a compound.
168d227a291Sdrh */
169d227a291Sdrh static Select *findRightmost(Select *p){
170d227a291Sdrh   while( p->pNext ) p = p->pNext;
171d227a291Sdrh   return p;
172d227a291Sdrh }
173d227a291Sdrh 
174d227a291Sdrh /*
175f7b5496eSdrh ** Given 1 to 3 identifiers preceding the JOIN keyword, determine the
17601f3f253Sdrh ** type of join.  Return an integer constant that expresses that type
17701f3f253Sdrh ** in terms of the following bit values:
17801f3f253Sdrh **
17901f3f253Sdrh **     JT_INNER
1803dec223cSdrh **     JT_CROSS
18101f3f253Sdrh **     JT_OUTER
18201f3f253Sdrh **     JT_NATURAL
18301f3f253Sdrh **     JT_LEFT
18401f3f253Sdrh **     JT_RIGHT
18501f3f253Sdrh **
18601f3f253Sdrh ** A full outer join is the combination of JT_LEFT and JT_RIGHT.
18701f3f253Sdrh **
18801f3f253Sdrh ** If an illegal or unsupported join type is seen, then still return
18901f3f253Sdrh ** a join type, but put an error in the pParse structure.
19001f3f253Sdrh */
1914adee20fSdanielk1977 int sqlite3JoinType(Parse *pParse, Token *pA, Token *pB, Token *pC){
19201f3f253Sdrh   int jointype = 0;
19301f3f253Sdrh   Token *apAll[3];
19401f3f253Sdrh   Token *p;
195373cc2ddSdrh                              /*   0123456789 123456789 123456789 123 */
196373cc2ddSdrh   static const char zKeyText[] = "naturaleftouterightfullinnercross";
1975719628aSdrh   static const struct {
198373cc2ddSdrh     u8 i;        /* Beginning of keyword text in zKeyText[] */
199373cc2ddSdrh     u8 nChar;    /* Length of the keyword in characters */
200373cc2ddSdrh     u8 code;     /* Join type mask */
201373cc2ddSdrh   } aKeyword[] = {
202373cc2ddSdrh     /* natural */ { 0,  7, JT_NATURAL                },
203373cc2ddSdrh     /* left    */ { 6,  4, JT_LEFT|JT_OUTER          },
204373cc2ddSdrh     /* outer   */ { 10, 5, JT_OUTER                  },
205373cc2ddSdrh     /* right   */ { 14, 5, JT_RIGHT|JT_OUTER         },
206373cc2ddSdrh     /* full    */ { 19, 4, JT_LEFT|JT_RIGHT|JT_OUTER },
207373cc2ddSdrh     /* inner   */ { 23, 5, JT_INNER                  },
208373cc2ddSdrh     /* cross   */ { 28, 5, JT_INNER|JT_CROSS         },
20901f3f253Sdrh   };
21001f3f253Sdrh   int i, j;
21101f3f253Sdrh   apAll[0] = pA;
21201f3f253Sdrh   apAll[1] = pB;
21301f3f253Sdrh   apAll[2] = pC;
214195e6967Sdrh   for(i=0; i<3 && apAll[i]; i++){
21501f3f253Sdrh     p = apAll[i];
216373cc2ddSdrh     for(j=0; j<ArraySize(aKeyword); j++){
217373cc2ddSdrh       if( p->n==aKeyword[j].nChar
218373cc2ddSdrh           && sqlite3StrNICmp((char*)p->z, &zKeyText[aKeyword[j].i], p->n)==0 ){
219373cc2ddSdrh         jointype |= aKeyword[j].code;
22001f3f253Sdrh         break;
22101f3f253Sdrh       }
22201f3f253Sdrh     }
223373cc2ddSdrh     testcase( j==0 || j==1 || j==2 || j==3 || j==4 || j==5 || j==6 );
224373cc2ddSdrh     if( j>=ArraySize(aKeyword) ){
22501f3f253Sdrh       jointype |= JT_ERROR;
22601f3f253Sdrh       break;
22701f3f253Sdrh     }
22801f3f253Sdrh   }
229ad2d8307Sdrh   if(
230ad2d8307Sdrh      (jointype & (JT_INNER|JT_OUTER))==(JT_INNER|JT_OUTER) ||
231195e6967Sdrh      (jointype & JT_ERROR)!=0
232ad2d8307Sdrh   ){
233a9671a22Sdrh     const char *zSp = " ";
234a9671a22Sdrh     assert( pB!=0 );
235a9671a22Sdrh     if( pC==0 ){ zSp++; }
236ae29ffbeSdrh     sqlite3ErrorMsg(pParse, "unknown or unsupported join type: "
237a9671a22Sdrh        "%T %T%s%T", pA, pB, zSp, pC);
23801f3f253Sdrh     jointype = JT_INNER;
239373cc2ddSdrh   }else if( (jointype & JT_OUTER)!=0
240373cc2ddSdrh          && (jointype & (JT_LEFT|JT_RIGHT))!=JT_LEFT ){
2414adee20fSdanielk1977     sqlite3ErrorMsg(pParse,
242da93d238Sdrh       "RIGHT and FULL OUTER JOINs are not currently supported");
243195e6967Sdrh     jointype = JT_INNER;
24401f3f253Sdrh   }
24501f3f253Sdrh   return jointype;
24601f3f253Sdrh }
24701f3f253Sdrh 
24801f3f253Sdrh /*
249ad2d8307Sdrh ** Return the index of a column in a table.  Return -1 if the column
250ad2d8307Sdrh ** is not contained in the table.
251ad2d8307Sdrh */
252ad2d8307Sdrh static int columnIndex(Table *pTab, const char *zCol){
253ad2d8307Sdrh   int i;
254ad2d8307Sdrh   for(i=0; i<pTab->nCol; i++){
2554adee20fSdanielk1977     if( sqlite3StrICmp(pTab->aCol[i].zName, zCol)==0 ) return i;
256ad2d8307Sdrh   }
257ad2d8307Sdrh   return -1;
258ad2d8307Sdrh }
259ad2d8307Sdrh 
260ad2d8307Sdrh /*
2612179b434Sdrh ** Search the first N tables in pSrc, from left to right, looking for a
2622179b434Sdrh ** table that has a column named zCol.
2632179b434Sdrh **
2642179b434Sdrh ** When found, set *piTab and *piCol to the table index and column index
2652179b434Sdrh ** of the matching column and return TRUE.
2662179b434Sdrh **
2672179b434Sdrh ** If not found, return FALSE.
2682179b434Sdrh */
2692179b434Sdrh static int tableAndColumnIndex(
2702179b434Sdrh   SrcList *pSrc,       /* Array of tables to search */
2712179b434Sdrh   int N,               /* Number of tables in pSrc->a[] to search */
2722179b434Sdrh   const char *zCol,    /* Name of the column we are looking for */
2732179b434Sdrh   int *piTab,          /* Write index of pSrc->a[] here */
2742179b434Sdrh   int *piCol           /* Write index of pSrc->a[*piTab].pTab->aCol[] here */
2752179b434Sdrh ){
2762179b434Sdrh   int i;               /* For looping over tables in pSrc */
2772179b434Sdrh   int iCol;            /* Index of column matching zCol */
2782179b434Sdrh 
2792179b434Sdrh   assert( (piTab==0)==(piCol==0) );  /* Both or neither are NULL */
2802179b434Sdrh   for(i=0; i<N; i++){
2812179b434Sdrh     iCol = columnIndex(pSrc->a[i].pTab, zCol);
2822179b434Sdrh     if( iCol>=0 ){
2832179b434Sdrh       if( piTab ){
2842179b434Sdrh         *piTab = i;
2852179b434Sdrh         *piCol = iCol;
2862179b434Sdrh       }
2872179b434Sdrh       return 1;
2882179b434Sdrh     }
2892179b434Sdrh   }
2902179b434Sdrh   return 0;
2912179b434Sdrh }
2922179b434Sdrh 
2932179b434Sdrh /*
294f7b0b0adSdan ** This function is used to add terms implied by JOIN syntax to the
295f7b0b0adSdan ** WHERE clause expression of a SELECT statement. The new term, which
296f7b0b0adSdan ** is ANDed with the existing WHERE clause, is of the form:
297f7b0b0adSdan **
298f7b0b0adSdan **    (tab1.col1 = tab2.col2)
299f7b0b0adSdan **
300f7b0b0adSdan ** where tab1 is the iSrc'th table in SrcList pSrc and tab2 is the
301f7b0b0adSdan ** (iSrc+1)'th. Column col1 is column iColLeft of tab1, and col2 is
302f7b0b0adSdan ** column iColRight of tab2.
303ad2d8307Sdrh */
304ad2d8307Sdrh static void addWhereTerm(
30517435752Sdrh   Parse *pParse,                  /* Parsing context */
306f7b0b0adSdan   SrcList *pSrc,                  /* List of tables in FROM clause */
3072179b434Sdrh   int iLeft,                      /* Index of first table to join in pSrc */
308f7b0b0adSdan   int iColLeft,                   /* Index of column in first table */
3092179b434Sdrh   int iRight,                     /* Index of second table in pSrc */
310f7b0b0adSdan   int iColRight,                  /* Index of column in second table */
311f7b0b0adSdan   int isOuterJoin,                /* True if this is an OUTER join */
312f7b0b0adSdan   Expr **ppWhere                  /* IN/OUT: The WHERE clause to add to */
313ad2d8307Sdrh ){
314f7b0b0adSdan   sqlite3 *db = pParse->db;
315f7b0b0adSdan   Expr *pE1;
316f7b0b0adSdan   Expr *pE2;
317f7b0b0adSdan   Expr *pEq;
318ad2d8307Sdrh 
3192179b434Sdrh   assert( iLeft<iRight );
3202179b434Sdrh   assert( pSrc->nSrc>iRight );
3212179b434Sdrh   assert( pSrc->a[iLeft].pTab );
3222179b434Sdrh   assert( pSrc->a[iRight].pTab );
323f7b0b0adSdan 
3242179b434Sdrh   pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iColLeft);
3252179b434Sdrh   pE2 = sqlite3CreateColumnExpr(db, pSrc, iRight, iColRight);
326f7b0b0adSdan 
327f7b0b0adSdan   pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2, 0);
328f7b0b0adSdan   if( pEq && isOuterJoin ){
329f7b0b0adSdan     ExprSetProperty(pEq, EP_FromJoin);
330c5cd1249Sdrh     assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
331ebb6a65dSdrh     ExprSetVVAProperty(pEq, EP_NoReduce);
332f7b0b0adSdan     pEq->iRightJoinTable = (i16)pE2->iTable;
333030530deSdrh   }
334f7b0b0adSdan   *ppWhere = sqlite3ExprAnd(db, *ppWhere, pEq);
335ad2d8307Sdrh }
336ad2d8307Sdrh 
337ad2d8307Sdrh /*
3381f16230bSdrh ** Set the EP_FromJoin property on all terms of the given expression.
33922d6a53aSdrh ** And set the Expr.iRightJoinTable to iTable for every term in the
34022d6a53aSdrh ** expression.
3411cc093c2Sdrh **
342e78e8284Sdrh ** The EP_FromJoin property is used on terms of an expression to tell
3431cc093c2Sdrh ** the LEFT OUTER JOIN processing logic that this term is part of the
3441f16230bSdrh ** join restriction specified in the ON or USING clause and not a part
3451f16230bSdrh ** of the more general WHERE clause.  These terms are moved over to the
3461f16230bSdrh ** WHERE clause during join processing but we need to remember that they
3471f16230bSdrh ** originated in the ON or USING clause.
34822d6a53aSdrh **
34922d6a53aSdrh ** The Expr.iRightJoinTable tells the WHERE clause processing that the
35022d6a53aSdrh ** expression depends on table iRightJoinTable even if that table is not
35122d6a53aSdrh ** explicitly mentioned in the expression.  That information is needed
35222d6a53aSdrh ** for cases like this:
35322d6a53aSdrh **
35422d6a53aSdrh **    SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.b AND t1.x=5
35522d6a53aSdrh **
35622d6a53aSdrh ** The where clause needs to defer the handling of the t1.x=5
35722d6a53aSdrh ** term until after the t2 loop of the join.  In that way, a
35822d6a53aSdrh ** NULL t2 row will be inserted whenever t1.x!=5.  If we do not
35922d6a53aSdrh ** defer the handling of t1.x=5, it will be processed immediately
36022d6a53aSdrh ** after the t1 loop and rows with t1.x!=5 will never appear in
36122d6a53aSdrh ** the output, which is incorrect.
3621cc093c2Sdrh */
36322d6a53aSdrh static void setJoinExpr(Expr *p, int iTable){
3641cc093c2Sdrh   while( p ){
3651f16230bSdrh     ExprSetProperty(p, EP_FromJoin);
366c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
367ebb6a65dSdrh     ExprSetVVAProperty(p, EP_NoReduce);
368cf697396Sshane     p->iRightJoinTable = (i16)iTable;
36922d6a53aSdrh     setJoinExpr(p->pLeft, iTable);
3701cc093c2Sdrh     p = p->pRight;
3711cc093c2Sdrh   }
3721cc093c2Sdrh }
3731cc093c2Sdrh 
3741cc093c2Sdrh /*
375ad2d8307Sdrh ** This routine processes the join information for a SELECT statement.
376ad2d8307Sdrh ** ON and USING clauses are converted into extra terms of the WHERE clause.
377ad2d8307Sdrh ** NATURAL joins also create extra WHERE clause terms.
378ad2d8307Sdrh **
37991bb0eedSdrh ** The terms of a FROM clause are contained in the Select.pSrc structure.
38091bb0eedSdrh ** The left most table is the first entry in Select.pSrc.  The right-most
38191bb0eedSdrh ** table is the last entry.  The join operator is held in the entry to
38291bb0eedSdrh ** the left.  Thus entry 0 contains the join operator for the join between
38391bb0eedSdrh ** entries 0 and 1.  Any ON or USING clauses associated with the join are
38491bb0eedSdrh ** also attached to the left entry.
38591bb0eedSdrh **
386ad2d8307Sdrh ** This routine returns the number of errors encountered.
387ad2d8307Sdrh */
388ad2d8307Sdrh static int sqliteProcessJoin(Parse *pParse, Select *p){
38991bb0eedSdrh   SrcList *pSrc;                  /* All tables in the FROM clause */
39091bb0eedSdrh   int i, j;                       /* Loop counters */
39191bb0eedSdrh   struct SrcList_item *pLeft;     /* Left table being joined */
39291bb0eedSdrh   struct SrcList_item *pRight;    /* Right table being joined */
393ad2d8307Sdrh 
39491bb0eedSdrh   pSrc = p->pSrc;
39591bb0eedSdrh   pLeft = &pSrc->a[0];
39691bb0eedSdrh   pRight = &pLeft[1];
39791bb0eedSdrh   for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
39891bb0eedSdrh     Table *pLeftTab = pLeft->pTab;
39991bb0eedSdrh     Table *pRightTab = pRight->pTab;
400ad27e761Sdrh     int isOuter;
40191bb0eedSdrh 
4021c767f0dSdrh     if( NEVER(pLeftTab==0 || pRightTab==0) ) continue;
403ad27e761Sdrh     isOuter = (pRight->jointype & JT_OUTER)!=0;
404ad2d8307Sdrh 
405ad2d8307Sdrh     /* When the NATURAL keyword is present, add WHERE clause terms for
406ad2d8307Sdrh     ** every column that the two tables have in common.
407ad2d8307Sdrh     */
40861dfc31dSdrh     if( pRight->jointype & JT_NATURAL ){
40961dfc31dSdrh       if( pRight->pOn || pRight->pUsing ){
4104adee20fSdanielk1977         sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
411ad2d8307Sdrh            "an ON or USING clause", 0);
412ad2d8307Sdrh         return 1;
413ad2d8307Sdrh       }
4142179b434Sdrh       for(j=0; j<pRightTab->nCol; j++){
4152179b434Sdrh         char *zName;   /* Name of column in the right table */
4162179b434Sdrh         int iLeft;     /* Matching left table */
4172179b434Sdrh         int iLeftCol;  /* Matching column in the left table */
4182179b434Sdrh 
4192179b434Sdrh         zName = pRightTab->aCol[j].zName;
4202179b434Sdrh         if( tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol) ){
4212179b434Sdrh           addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, j,
4222179b434Sdrh                        isOuter, &p->pWhere);
423ad2d8307Sdrh         }
424ad2d8307Sdrh       }
425ad2d8307Sdrh     }
426ad2d8307Sdrh 
427ad2d8307Sdrh     /* Disallow both ON and USING clauses in the same join
428ad2d8307Sdrh     */
42961dfc31dSdrh     if( pRight->pOn && pRight->pUsing ){
4304adee20fSdanielk1977       sqlite3ErrorMsg(pParse, "cannot have both ON and USING "
431da93d238Sdrh         "clauses in the same join");
432ad2d8307Sdrh       return 1;
433ad2d8307Sdrh     }
434ad2d8307Sdrh 
435ad2d8307Sdrh     /* Add the ON clause to the end of the WHERE clause, connected by
43691bb0eedSdrh     ** an AND operator.
437ad2d8307Sdrh     */
43861dfc31dSdrh     if( pRight->pOn ){
439ad27e761Sdrh       if( isOuter ) setJoinExpr(pRight->pOn, pRight->iCursor);
44017435752Sdrh       p->pWhere = sqlite3ExprAnd(pParse->db, p->pWhere, pRight->pOn);
44161dfc31dSdrh       pRight->pOn = 0;
442ad2d8307Sdrh     }
443ad2d8307Sdrh 
444ad2d8307Sdrh     /* Create extra terms on the WHERE clause for each column named
445ad2d8307Sdrh     ** in the USING clause.  Example: If the two tables to be joined are
446ad2d8307Sdrh     ** A and B and the USING clause names X, Y, and Z, then add this
447ad2d8307Sdrh     ** to the WHERE clause:    A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
448ad2d8307Sdrh     ** Report an error if any column mentioned in the USING clause is
449ad2d8307Sdrh     ** not contained in both tables to be joined.
450ad2d8307Sdrh     */
45161dfc31dSdrh     if( pRight->pUsing ){
45261dfc31dSdrh       IdList *pList = pRight->pUsing;
453ad2d8307Sdrh       for(j=0; j<pList->nId; j++){
4542179b434Sdrh         char *zName;     /* Name of the term in the USING clause */
4552179b434Sdrh         int iLeft;       /* Table on the left with matching column name */
4562179b434Sdrh         int iLeftCol;    /* Column number of matching column on the left */
4572179b434Sdrh         int iRightCol;   /* Column number of matching column on the right */
4582179b434Sdrh 
4592179b434Sdrh         zName = pList->a[j].zName;
4602179b434Sdrh         iRightCol = columnIndex(pRightTab, zName);
4612179b434Sdrh         if( iRightCol<0
4622179b434Sdrh          || !tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol)
4632179b434Sdrh         ){
4644adee20fSdanielk1977           sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
46591bb0eedSdrh             "not present in both tables", zName);
466ad2d8307Sdrh           return 1;
467ad2d8307Sdrh         }
4682179b434Sdrh         addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, iRightCol,
4692179b434Sdrh                      isOuter, &p->pWhere);
470ad2d8307Sdrh       }
471ad2d8307Sdrh     }
472ad2d8307Sdrh   }
473ad2d8307Sdrh   return 0;
474ad2d8307Sdrh }
475ad2d8307Sdrh 
476079a3072Sdrh /* Forward reference */
477079a3072Sdrh static KeyInfo *keyInfoFromExprList(
478079a3072Sdrh   Parse *pParse,       /* Parsing context */
479079a3072Sdrh   ExprList *pList,     /* Form the KeyInfo object from this ExprList */
480079a3072Sdrh   int iStart,          /* Begin with this column of pList */
481079a3072Sdrh   int nExtra           /* Add this many extra columns to the end */
482079a3072Sdrh );
483079a3072Sdrh 
484ad2d8307Sdrh /*
485f45f2326Sdrh ** Generate code that will push the record in registers regData
486f45f2326Sdrh ** through regData+nData-1 onto the sorter.
487c926afbcSdrh */
488d59ba6ceSdrh static void pushOntoSorter(
489d59ba6ceSdrh   Parse *pParse,         /* Parser context */
490079a3072Sdrh   SortCtx *pSort,        /* Information about the ORDER BY clause */
491b7654111Sdrh   Select *pSelect,       /* The whole SELECT statement */
492f45f2326Sdrh   int regData,           /* First register holding data to be sorted */
493fd0a2f97Sdrh   int nData,             /* Number of elements in the data array */
494fd0a2f97Sdrh   int nPrefixReg         /* No. of reg prior to regData available for use */
495d59ba6ceSdrh ){
496f45f2326Sdrh   Vdbe *v = pParse->pVdbe;                         /* Stmt under construction */
49778d58432Sdan   int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
498f45f2326Sdrh   int nExpr = pSort->pOrderBy->nExpr;              /* No. of ORDER BY terms */
49978d58432Sdan   int nBase = nExpr + bSeq + nData;                /* Fields in sorter record */
500fd0a2f97Sdrh   int regBase;                                     /* Regs for sorter record */
501fb0d6e56Sdrh   int regRecord = ++pParse->nMem;                  /* Assembled sorter record */
50278d58432Sdan   int nOBSat = pSort->nOBSat;                      /* ORDER BY terms to skip */
503f45f2326Sdrh   int op;                            /* Opcode to add sorter record to sorter */
504f45f2326Sdrh 
50578d58432Sdan   assert( bSeq==0 || bSeq==1 );
506fd0a2f97Sdrh   if( nPrefixReg ){
50778d58432Sdan     assert( nPrefixReg==nExpr+bSeq );
50878d58432Sdan     regBase = regData - nExpr - bSeq;
509fd0a2f97Sdrh   }else{
510fb0d6e56Sdrh     regBase = pParse->nMem + 1;
511fb0d6e56Sdrh     pParse->nMem += nBase;
512fd0a2f97Sdrh   }
51370f624c3Sdrh   sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, SQLITE_ECEL_DUP);
51478d58432Sdan   if( bSeq ){
515079a3072Sdrh     sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
516fd0a2f97Sdrh   }
51778d58432Sdan   if( nPrefixReg==0 ){
518236241aeSdrh     sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
51978d58432Sdan   }
52078d58432Sdan 
521f45f2326Sdrh   sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regRecord);
522079a3072Sdrh   if( nOBSat>0 ){
523079a3072Sdrh     int regPrevKey;   /* The first nOBSat columns of the previous row */
524079a3072Sdrh     int addrFirst;    /* Address of the OP_IfNot opcode */
525079a3072Sdrh     int addrJmp;      /* Address of the OP_Jump opcode */
526079a3072Sdrh     VdbeOp *pOp;      /* Opcode that opens the sorter */
527079a3072Sdrh     int nKey;         /* Number of sorting key columns, including OP_Sequence */
528dbfca2b7Sdrh     KeyInfo *pKI;     /* Original KeyInfo on the sorter table */
529079a3072Sdrh 
53026d7e7c6Sdrh     regPrevKey = pParse->nMem+1;
53126d7e7c6Sdrh     pParse->nMem += pSort->nOBSat;
53278d58432Sdan     nKey = nExpr - pSort->nOBSat + bSeq;
53378d58432Sdan     if( bSeq ){
53478d58432Sdan       addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
53578d58432Sdan     }else{
53678d58432Sdan       addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
53778d58432Sdan     }
53878d58432Sdan     VdbeCoverage(v);
53926d7e7c6Sdrh     sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
540079a3072Sdrh     pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
54159b8f2e1Sdrh     if( pParse->db->mallocFailed ) return;
542fb0d6e56Sdrh     pOp->p2 = nKey + nData;
543dbfca2b7Sdrh     pKI = pOp->p4.pKeyInfo;
544dbfca2b7Sdrh     memset(pKI->aSortOrder, 0, pKI->nField); /* Makes OP_Jump below testable */
545dbfca2b7Sdrh     sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
546079a3072Sdrh     pOp->p4.pKeyInfo = keyInfoFromExprList(pParse, pSort->pOrderBy, nOBSat, 1);
547079a3072Sdrh     addrJmp = sqlite3VdbeCurrentAddr(v);
548079a3072Sdrh     sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
549079a3072Sdrh     pSort->labelBkOut = sqlite3VdbeMakeLabel(v);
550079a3072Sdrh     pSort->regReturn = ++pParse->nMem;
551079a3072Sdrh     sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
55265ea12cbSdrh     sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
553079a3072Sdrh     sqlite3VdbeJumpHere(v, addrFirst);
554236241aeSdrh     sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
555079a3072Sdrh     sqlite3VdbeJumpHere(v, addrJmp);
556079a3072Sdrh   }
557079a3072Sdrh   if( pSort->sortFlags & SORTFLAG_UseSorter ){
558c6aff30cSdrh     op = OP_SorterInsert;
559c6aff30cSdrh   }else{
560c6aff30cSdrh     op = OP_IdxInsert;
561c6aff30cSdrh   }
562079a3072Sdrh   sqlite3VdbeAddOp2(v, op, pSort->iECursor, regRecord);
56392b01d53Sdrh   if( pSelect->iLimit ){
56415007a99Sdrh     int addr1, addr2;
565b7654111Sdrh     int iLimit;
5660acb7e48Sdrh     if( pSelect->iOffset ){
567b7654111Sdrh       iLimit = pSelect->iOffset+1;
568b7654111Sdrh     }else{
569b7654111Sdrh       iLimit = pSelect->iLimit;
570b7654111Sdrh     }
571688852abSdrh     addr1 = sqlite3VdbeAddOp1(v, OP_IfZero, iLimit); VdbeCoverage(v);
572b7654111Sdrh     sqlite3VdbeAddOp2(v, OP_AddImm, iLimit, -1);
5733c84ddffSdrh     addr2 = sqlite3VdbeAddOp0(v, OP_Goto);
574d59ba6ceSdrh     sqlite3VdbeJumpHere(v, addr1);
575079a3072Sdrh     sqlite3VdbeAddOp1(v, OP_Last, pSort->iECursor);
576079a3072Sdrh     sqlite3VdbeAddOp1(v, OP_Delete, pSort->iECursor);
57715007a99Sdrh     sqlite3VdbeJumpHere(v, addr2);
578d59ba6ceSdrh   }
579c926afbcSdrh }
580c926afbcSdrh 
581c926afbcSdrh /*
582ec7429aeSdrh ** Add code to implement the OFFSET
583ea48eb2eSdrh */
584ec7429aeSdrh static void codeOffset(
585bab39e13Sdrh   Vdbe *v,          /* Generate code into this VM */
586aa9ce707Sdrh   int iOffset,      /* Register holding the offset counter */
587b7654111Sdrh   int iContinue     /* Jump here to skip the current record */
588ea48eb2eSdrh ){
589a22a75e5Sdrh   if( iOffset>0 ){
59015007a99Sdrh     int addr;
5914336b0e6Sdrh     addr = sqlite3VdbeAddOp3(v, OP_IfNeg, iOffset, 0, -1); VdbeCoverage(v);
59266a5167bSdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, iContinue);
593d4e70ebdSdrh     VdbeComment((v, "skip OFFSET records"));
59415007a99Sdrh     sqlite3VdbeJumpHere(v, addr);
595ea48eb2eSdrh   }
596ea48eb2eSdrh }
597ea48eb2eSdrh 
598ea48eb2eSdrh /*
59998757157Sdrh ** Add code that will check to make sure the N registers starting at iMem
60098757157Sdrh ** form a distinct entry.  iTab is a sorting index that holds previously
601a2a49dc9Sdrh ** seen combinations of the N values.  A new entry is made in iTab
602a2a49dc9Sdrh ** if the current N values are new.
603a2a49dc9Sdrh **
604a2a49dc9Sdrh ** A jump to addrRepeat is made and the N+1 values are popped from the
605a2a49dc9Sdrh ** stack if the top N elements are not distinct.
606a2a49dc9Sdrh */
607a2a49dc9Sdrh static void codeDistinct(
6082dcef11bSdrh   Parse *pParse,     /* Parsing and code generating context */
609a2a49dc9Sdrh   int iTab,          /* A sorting index used to test for distinctness */
610a2a49dc9Sdrh   int addrRepeat,    /* Jump to here if not distinct */
611477df4b3Sdrh   int N,             /* Number of elements */
612a2a49dc9Sdrh   int iMem           /* First element */
613a2a49dc9Sdrh ){
6142dcef11bSdrh   Vdbe *v;
6152dcef11bSdrh   int r1;
6162dcef11bSdrh 
6172dcef11bSdrh   v = pParse->pVdbe;
6182dcef11bSdrh   r1 = sqlite3GetTempReg(pParse);
619688852abSdrh   sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, iMem, N); VdbeCoverage(v);
6201db639ceSdrh   sqlite3VdbeAddOp3(v, OP_MakeRecord, iMem, N, r1);
6212dcef11bSdrh   sqlite3VdbeAddOp2(v, OP_IdxInsert, iTab, r1);
6222dcef11bSdrh   sqlite3ReleaseTempReg(pParse, r1);
623a2a49dc9Sdrh }
624a2a49dc9Sdrh 
625bb7dd683Sdrh #ifndef SQLITE_OMIT_SUBQUERY
626a2a49dc9Sdrh /*
627e305f43fSdrh ** Generate an error message when a SELECT is used within a subexpression
628e305f43fSdrh ** (example:  "a IN (SELECT * FROM table)") but it has more than 1 result
629bb7dd683Sdrh ** column.  We do this in a subroutine because the error used to occur
630bb7dd683Sdrh ** in multiple places.  (The error only occurs in one place now, but we
631bb7dd683Sdrh ** retain the subroutine to minimize code disruption.)
632e305f43fSdrh */
6336c8c8ce0Sdanielk1977 static int checkForMultiColumnSelectError(
6346c8c8ce0Sdanielk1977   Parse *pParse,       /* Parse context. */
6356c8c8ce0Sdanielk1977   SelectDest *pDest,   /* Destination of SELECT results */
6366c8c8ce0Sdanielk1977   int nExpr            /* Number of result columns returned by SELECT */
6376c8c8ce0Sdanielk1977 ){
6386c8c8ce0Sdanielk1977   int eDest = pDest->eDest;
639e305f43fSdrh   if( nExpr>1 && (eDest==SRT_Mem || eDest==SRT_Set) ){
640e305f43fSdrh     sqlite3ErrorMsg(pParse, "only a single result allowed for "
641e305f43fSdrh        "a SELECT that is part of an expression");
642e305f43fSdrh     return 1;
643e305f43fSdrh   }else{
644e305f43fSdrh     return 0;
645e305f43fSdrh   }
646e305f43fSdrh }
647bb7dd683Sdrh #endif
648c99130fdSdrh 
649c99130fdSdrh /*
6502282792aSdrh ** This routine generates the code for the inside of the inner loop
6512282792aSdrh ** of a SELECT.
65282c3d636Sdrh **
653340309fdSdrh ** If srcTab is negative, then the pEList expressions
654340309fdSdrh ** are evaluated in order to get the data for this row.  If srcTab is
655340309fdSdrh ** zero or more, then data is pulled from srcTab and pEList is used only
656340309fdSdrh ** to get number columns and the datatype for each column.
6572282792aSdrh */
658d2b3e23bSdrh static void selectInnerLoop(
6592282792aSdrh   Parse *pParse,          /* The parser context */
660df199a25Sdrh   Select *p,              /* The complete select statement being coded */
6612282792aSdrh   ExprList *pEList,       /* List of values being extracted */
66282c3d636Sdrh   int srcTab,             /* Pull data from this table */
663079a3072Sdrh   SortCtx *pSort,         /* If not NULL, info on how to process ORDER BY */
664e8e4af76Sdrh   DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
6656c8c8ce0Sdanielk1977   SelectDest *pDest,      /* How to dispose of the results */
6662282792aSdrh   int iContinue,          /* Jump here to continue with next row */
667a9671a22Sdrh   int iBreak              /* Jump here to break out of the inner loop */
6682282792aSdrh ){
6692282792aSdrh   Vdbe *v = pParse->pVdbe;
670d847eaadSdrh   int i;
671ea48eb2eSdrh   int hasDistinct;        /* True if the DISTINCT keyword is present */
672d847eaadSdrh   int regResult;              /* Start of memory holding result set */
673d847eaadSdrh   int eDest = pDest->eDest;   /* How to dispose of results */
6742b596da8Sdrh   int iParm = pDest->iSDParm; /* First argument to disposal method */
675d847eaadSdrh   int nResultCol;             /* Number of result columns */
676fd0a2f97Sdrh   int nPrefixReg = 0;         /* Number of extra registers before regResult */
67738640e15Sdrh 
6781c767f0dSdrh   assert( v );
67938640e15Sdrh   assert( pEList!=0 );
680e8e4af76Sdrh   hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
681079a3072Sdrh   if( pSort && pSort->pOrderBy==0 ) pSort = 0;
682079a3072Sdrh   if( pSort==0 && !hasDistinct ){
683a22a75e5Sdrh     assert( iContinue!=0 );
684aa9ce707Sdrh     codeOffset(v, p->iOffset, iContinue);
685df199a25Sdrh   }
686df199a25Sdrh 
687967e8b73Sdrh   /* Pull the requested columns.
6882282792aSdrh   */
689d847eaadSdrh   nResultCol = pEList->nExpr;
69005a86c5cSdrh 
6912b596da8Sdrh   if( pDest->iSdst==0 ){
692fd0a2f97Sdrh     if( pSort ){
69378d58432Sdan       nPrefixReg = pSort->pOrderBy->nExpr;
69478d58432Sdan       if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
695fd0a2f97Sdrh       pParse->nMem += nPrefixReg;
696fd0a2f97Sdrh     }
6972b596da8Sdrh     pDest->iSdst = pParse->nMem+1;
6980acb7e48Sdrh     pParse->nMem += nResultCol;
69905a86c5cSdrh   }else if( pDest->iSdst+nResultCol > pParse->nMem ){
70005a86c5cSdrh     /* This is an error condition that can result, for example, when a SELECT
70105a86c5cSdrh     ** on the right-hand side of an INSERT contains more result columns than
70205a86c5cSdrh     ** there are columns in the table on the left.  The error will be caught
70305a86c5cSdrh     ** and reported later.  But we need to make sure enough memory is allocated
70405a86c5cSdrh     ** to avoid other spurious errors in the meantime. */
70505a86c5cSdrh     pParse->nMem += nResultCol;
7061013c932Sdrh   }
70705a86c5cSdrh   pDest->nSdst = nResultCol;
7082b596da8Sdrh   regResult = pDest->iSdst;
709340309fdSdrh   if( srcTab>=0 ){
710340309fdSdrh     for(i=0; i<nResultCol; i++){
711d847eaadSdrh       sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
712340309fdSdrh       VdbeComment((v, "%s", pEList->a[i].zName));
71382c3d636Sdrh     }
7149ed1dfa8Sdanielk1977   }else if( eDest!=SRT_Exists ){
7159ed1dfa8Sdanielk1977     /* If the destination is an EXISTS(...) expression, the actual
7169ed1dfa8Sdanielk1977     ** values returned by the SELECT are not required.
7179ed1dfa8Sdanielk1977     */
718d1a01edaSdrh     sqlite3ExprCodeExprList(pParse, pEList, regResult,
7196295524eSdrh                   (eDest==SRT_Output||eDest==SRT_Coroutine)?SQLITE_ECEL_DUP:0);
720a2a49dc9Sdrh   }
7212282792aSdrh 
722daffd0e5Sdrh   /* If the DISTINCT keyword was present on the SELECT statement
723daffd0e5Sdrh   ** and this row has been seen before, then do not make this row
724daffd0e5Sdrh   ** part of the result.
7252282792aSdrh   */
726ea48eb2eSdrh   if( hasDistinct ){
727e8e4af76Sdrh     switch( pDistinct->eTnctType ){
728e8e4af76Sdrh       case WHERE_DISTINCT_ORDERED: {
729e8e4af76Sdrh         VdbeOp *pOp;            /* No longer required OpenEphemeral instr. */
730e8e4af76Sdrh         int iJump;              /* Jump destination */
731e8e4af76Sdrh         int regPrev;            /* Previous row content */
732e8e4af76Sdrh 
733e8e4af76Sdrh         /* Allocate space for the previous row */
734e8e4af76Sdrh         regPrev = pParse->nMem+1;
735340309fdSdrh         pParse->nMem += nResultCol;
736e8e4af76Sdrh 
737e8e4af76Sdrh         /* Change the OP_OpenEphemeral coded earlier to an OP_Null
738e8e4af76Sdrh         ** sets the MEM_Cleared bit on the first register of the
739e8e4af76Sdrh         ** previous value.  This will cause the OP_Ne below to always
740e8e4af76Sdrh         ** fail on the first iteration of the loop even if the first
741e8e4af76Sdrh         ** row is all NULLs.
742e8e4af76Sdrh         */
743e8e4af76Sdrh         sqlite3VdbeChangeToNoop(v, pDistinct->addrTnct);
744e8e4af76Sdrh         pOp = sqlite3VdbeGetOp(v, pDistinct->addrTnct);
745e8e4af76Sdrh         pOp->opcode = OP_Null;
746e8e4af76Sdrh         pOp->p1 = 1;
747e8e4af76Sdrh         pOp->p2 = regPrev;
748e8e4af76Sdrh 
749340309fdSdrh         iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
750340309fdSdrh         for(i=0; i<nResultCol; i++){
751e8e4af76Sdrh           CollSeq *pColl = sqlite3ExprCollSeq(pParse, pEList->a[i].pExpr);
752340309fdSdrh           if( i<nResultCol-1 ){
753e8e4af76Sdrh             sqlite3VdbeAddOp3(v, OP_Ne, regResult+i, iJump, regPrev+i);
754688852abSdrh             VdbeCoverage(v);
755e8e4af76Sdrh           }else{
756e8e4af76Sdrh             sqlite3VdbeAddOp3(v, OP_Eq, regResult+i, iContinue, regPrev+i);
757688852abSdrh             VdbeCoverage(v);
758e8e4af76Sdrh            }
759e8e4af76Sdrh           sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
760e8e4af76Sdrh           sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
761e8e4af76Sdrh         }
762fcf2a775Sdrh         assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
763340309fdSdrh         sqlite3VdbeAddOp3(v, OP_Copy, regResult, regPrev, nResultCol-1);
764e8e4af76Sdrh         break;
765e8e4af76Sdrh       }
766e8e4af76Sdrh 
767e8e4af76Sdrh       case WHERE_DISTINCT_UNIQUE: {
768e8e4af76Sdrh         sqlite3VdbeChangeToNoop(v, pDistinct->addrTnct);
769e8e4af76Sdrh         break;
770e8e4af76Sdrh       }
771e8e4af76Sdrh 
772e8e4af76Sdrh       default: {
773e8e4af76Sdrh         assert( pDistinct->eTnctType==WHERE_DISTINCT_UNORDERED );
774340309fdSdrh         codeDistinct(pParse, pDistinct->tabTnct, iContinue, nResultCol, regResult);
775e8e4af76Sdrh         break;
776e8e4af76Sdrh       }
777e8e4af76Sdrh     }
778079a3072Sdrh     if( pSort==0 ){
779aa9ce707Sdrh       codeOffset(v, p->iOffset, iContinue);
780ea48eb2eSdrh     }
7812282792aSdrh   }
78282c3d636Sdrh 
783c926afbcSdrh   switch( eDest ){
78482c3d636Sdrh     /* In this mode, write each query result to the key of the temporary
78582c3d636Sdrh     ** table iParm.
7862282792aSdrh     */
78713449892Sdrh #ifndef SQLITE_OMIT_COMPOUND_SELECT
788c926afbcSdrh     case SRT_Union: {
7899cbf3425Sdrh       int r1;
7909cbf3425Sdrh       r1 = sqlite3GetTempReg(pParse);
791340309fdSdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
7929cbf3425Sdrh       sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, r1);
7939cbf3425Sdrh       sqlite3ReleaseTempReg(pParse, r1);
794c926afbcSdrh       break;
795c926afbcSdrh     }
79682c3d636Sdrh 
79782c3d636Sdrh     /* Construct a record from the query result, but instead of
79882c3d636Sdrh     ** saving that record, use it as a key to delete elements from
79982c3d636Sdrh     ** the temporary table iParm.
80082c3d636Sdrh     */
801c926afbcSdrh     case SRT_Except: {
802340309fdSdrh       sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
803c926afbcSdrh       break;
804c926afbcSdrh     }
805781def29Sdrh #endif /* SQLITE_OMIT_COMPOUND_SELECT */
8065338a5f7Sdanielk1977 
8075338a5f7Sdanielk1977     /* Store the result as data using a unique key.
8085338a5f7Sdanielk1977     */
8098e1ee88cSdrh     case SRT_Fifo:
8108e1ee88cSdrh     case SRT_DistFifo:
8115338a5f7Sdanielk1977     case SRT_Table:
812b9bb7c18Sdrh     case SRT_EphemTab: {
813fd0a2f97Sdrh       int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
814373cc2ddSdrh       testcase( eDest==SRT_Table );
815373cc2ddSdrh       testcase( eDest==SRT_EphemTab );
816fd0a2f97Sdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
8178ce7184bSdan #ifndef SQLITE_OMIT_CTE
8188e1ee88cSdrh       if( eDest==SRT_DistFifo ){
8198e1ee88cSdrh         /* If the destination is DistFifo, then cursor (iParm+1) is open
8208ce7184bSdan         ** on an ephemeral index. If the current row is already present
8218ce7184bSdan         ** in the index, do not write it to the output. If not, add the
8228ce7184bSdan         ** current row to the index and proceed with writing it to the
8238ce7184bSdan         ** output table as well.  */
8248ce7184bSdan         int addr = sqlite3VdbeCurrentAddr(v) + 4;
825688852abSdrh         sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0); VdbeCoverage(v);
8268ce7184bSdan         sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r1);
827079a3072Sdrh         assert( pSort==0 );
8288ce7184bSdan       }
8298ce7184bSdan #endif
830079a3072Sdrh       if( pSort ){
831fd0a2f97Sdrh         pushOntoSorter(pParse, pSort, p, r1+nPrefixReg, 1, nPrefixReg);
8325338a5f7Sdanielk1977       }else{
833b7654111Sdrh         int r2 = sqlite3GetTempReg(pParse);
834b7654111Sdrh         sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
835b7654111Sdrh         sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
836b7654111Sdrh         sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
837b7654111Sdrh         sqlite3ReleaseTempReg(pParse, r2);
8385338a5f7Sdanielk1977       }
839fd0a2f97Sdrh       sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
8405338a5f7Sdanielk1977       break;
8415338a5f7Sdanielk1977     }
8422282792aSdrh 
84393758c8dSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
8442282792aSdrh     /* If we are creating a set for an "expr IN (SELECT ...)" construct,
8452282792aSdrh     ** then there should be a single item on the stack.  Write this
8462282792aSdrh     ** item into the set table with bogus data.
8472282792aSdrh     */
848c926afbcSdrh     case SRT_Set: {
849340309fdSdrh       assert( nResultCol==1 );
850634d81deSdrh       pDest->affSdst =
851634d81deSdrh                   sqlite3CompareAffinity(pEList->a[0].pExpr, pDest->affSdst);
852079a3072Sdrh       if( pSort ){
853de941c60Sdrh         /* At first glance you would think we could optimize out the
854de941c60Sdrh         ** ORDER BY in this case since the order of entries in the set
855de941c60Sdrh         ** does not matter.  But there might be a LIMIT clause, in which
856de941c60Sdrh         ** case the order does matter */
857fd0a2f97Sdrh         pushOntoSorter(pParse, pSort, p, regResult, 1, nPrefixReg);
858c926afbcSdrh       }else{
859b7654111Sdrh         int r1 = sqlite3GetTempReg(pParse);
860634d81deSdrh         sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult,1,r1, &pDest->affSdst, 1);
861da250ea5Sdrh         sqlite3ExprCacheAffinityChange(pParse, regResult, 1);
862b7654111Sdrh         sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, r1);
863b7654111Sdrh         sqlite3ReleaseTempReg(pParse, r1);
864c926afbcSdrh       }
865c926afbcSdrh       break;
866c926afbcSdrh     }
86782c3d636Sdrh 
868504b6989Sdrh     /* If any row exist in the result set, record that fact and abort.
869ec7429aeSdrh     */
870ec7429aeSdrh     case SRT_Exists: {
8714c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
872ec7429aeSdrh       /* The LIMIT clause will terminate the loop for us */
873ec7429aeSdrh       break;
874ec7429aeSdrh     }
875ec7429aeSdrh 
8762282792aSdrh     /* If this is a scalar select that is part of an expression, then
8772282792aSdrh     ** store the results in the appropriate memory cell and break out
8782282792aSdrh     ** of the scan loop.
8792282792aSdrh     */
880c926afbcSdrh     case SRT_Mem: {
881340309fdSdrh       assert( nResultCol==1 );
882079a3072Sdrh       if( pSort ){
883fd0a2f97Sdrh         pushOntoSorter(pParse, pSort, p, regResult, 1, nPrefixReg);
884c926afbcSdrh       }else{
88553932ce8Sdrh         assert( regResult==iParm );
886ec7429aeSdrh         /* The LIMIT clause will jump out of the loop for us */
887c926afbcSdrh       }
888c926afbcSdrh       break;
889c926afbcSdrh     }
89093758c8dSdanielk1977 #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
8912282792aSdrh 
89281cf13ecSdrh     case SRT_Coroutine:       /* Send data to a co-routine */
89381cf13ecSdrh     case SRT_Output: {        /* Return the results */
894373cc2ddSdrh       testcase( eDest==SRT_Coroutine );
895373cc2ddSdrh       testcase( eDest==SRT_Output );
896079a3072Sdrh       if( pSort ){
897fd0a2f97Sdrh         pushOntoSorter(pParse, pSort, p, regResult, nResultCol, nPrefixReg);
898e00ee6ebSdrh       }else if( eDest==SRT_Coroutine ){
8992b596da8Sdrh         sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
900c182d163Sdrh       }else{
901340309fdSdrh         sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
902340309fdSdrh         sqlite3ExprCacheAffinityChange(pParse, regResult, nResultCol);
903ac82fcf5Sdrh       }
904142e30dfSdrh       break;
905142e30dfSdrh     }
906142e30dfSdrh 
907fe1c6bb9Sdrh #ifndef SQLITE_OMIT_CTE
908fe1c6bb9Sdrh     /* Write the results into a priority queue that is order according to
909fe1c6bb9Sdrh     ** pDest->pOrderBy (in pSO).  pDest->iSDParm (in iParm) is the cursor for an
910fe1c6bb9Sdrh     ** index with pSO->nExpr+2 columns.  Build a key using pSO for the first
911fe1c6bb9Sdrh     ** pSO->nExpr columns, then make sure all keys are unique by adding a
912fe1c6bb9Sdrh     ** final OP_Sequence column.  The last column is the record as a blob.
913fe1c6bb9Sdrh     */
914fe1c6bb9Sdrh     case SRT_DistQueue:
915fe1c6bb9Sdrh     case SRT_Queue: {
916fe1c6bb9Sdrh       int nKey;
917fe1c6bb9Sdrh       int r1, r2, r3;
918fe1c6bb9Sdrh       int addrTest = 0;
919fe1c6bb9Sdrh       ExprList *pSO;
920fe1c6bb9Sdrh       pSO = pDest->pOrderBy;
921fe1c6bb9Sdrh       assert( pSO );
922fe1c6bb9Sdrh       nKey = pSO->nExpr;
923fe1c6bb9Sdrh       r1 = sqlite3GetTempReg(pParse);
924fe1c6bb9Sdrh       r2 = sqlite3GetTempRange(pParse, nKey+2);
925fe1c6bb9Sdrh       r3 = r2+nKey+1;
926fe1c6bb9Sdrh       if( eDest==SRT_DistQueue ){
927fe1c6bb9Sdrh         /* If the destination is DistQueue, then cursor (iParm+1) is open
928fe1c6bb9Sdrh         ** on a second ephemeral index that holds all values every previously
9297e4efaecSdrh         ** added to the queue. */
9307e4efaecSdrh         addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
9317e4efaecSdrh                                         regResult, nResultCol);
932688852abSdrh         VdbeCoverage(v);
9337e4efaecSdrh       }
9347e4efaecSdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
9357e4efaecSdrh       if( eDest==SRT_DistQueue ){
936fe1c6bb9Sdrh         sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
937cfe24586Sdan         sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
938fe1c6bb9Sdrh       }
939fe1c6bb9Sdrh       for(i=0; i<nKey; i++){
940fe1c6bb9Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy,
941fe1c6bb9Sdrh                           regResult + pSO->a[i].u.x.iOrderByCol - 1,
942fe1c6bb9Sdrh                           r2+i);
943fe1c6bb9Sdrh       }
944fe1c6bb9Sdrh       sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
945fe1c6bb9Sdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
946fe1c6bb9Sdrh       sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, r1);
947fe1c6bb9Sdrh       if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
948fe1c6bb9Sdrh       sqlite3ReleaseTempReg(pParse, r1);
949fe1c6bb9Sdrh       sqlite3ReleaseTempRange(pParse, r2, nKey+2);
950fe1c6bb9Sdrh       break;
951fe1c6bb9Sdrh     }
952fe1c6bb9Sdrh #endif /* SQLITE_OMIT_CTE */
953fe1c6bb9Sdrh 
954fe1c6bb9Sdrh 
955fe1c6bb9Sdrh 
9566a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_TRIGGER)
957d7489c39Sdrh     /* Discard the results.  This is used for SELECT statements inside
958d7489c39Sdrh     ** the body of a TRIGGER.  The purpose of such selects is to call
959d7489c39Sdrh     ** user-defined functions that have side effects.  We do not care
960d7489c39Sdrh     ** about the actual results of the select.
961d7489c39Sdrh     */
962c926afbcSdrh     default: {
963f46f905aSdrh       assert( eDest==SRT_Discard );
964c926afbcSdrh       break;
965c926afbcSdrh     }
96693758c8dSdanielk1977 #endif
967c926afbcSdrh   }
968ec7429aeSdrh 
9695e87be87Sdrh   /* Jump to the end of the loop if the LIMIT is reached.  Except, if
9705e87be87Sdrh   ** there is a sorter, in which case the sorter has already limited
9715e87be87Sdrh   ** the output for us.
972ec7429aeSdrh   */
973079a3072Sdrh   if( pSort==0 && p->iLimit ){
974688852abSdrh     sqlite3VdbeAddOp3(v, OP_IfZero, p->iLimit, iBreak, -1); VdbeCoverage(v);
975ec7429aeSdrh   }
97682c3d636Sdrh }
97782c3d636Sdrh 
97882c3d636Sdrh /*
979ad124329Sdrh ** Allocate a KeyInfo object sufficient for an index of N key columns and
980ad124329Sdrh ** X extra columns.
981323df790Sdrh */
982ad124329Sdrh KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
9832ec2fb22Sdrh   KeyInfo *p = sqlite3DbMallocZero(0,
984ad124329Sdrh                    sizeof(KeyInfo) + (N+X)*(sizeof(CollSeq*)+1));
985323df790Sdrh   if( p ){
986ad124329Sdrh     p->aSortOrder = (u8*)&p->aColl[N+X];
987323df790Sdrh     p->nField = (u16)N;
988ad124329Sdrh     p->nXField = (u16)X;
989323df790Sdrh     p->enc = ENC(db);
990323df790Sdrh     p->db = db;
9912ec2fb22Sdrh     p->nRef = 1;
9922ec2fb22Sdrh   }else{
9932ec2fb22Sdrh     db->mallocFailed = 1;
994323df790Sdrh   }
995323df790Sdrh   return p;
996323df790Sdrh }
997323df790Sdrh 
998323df790Sdrh /*
9992ec2fb22Sdrh ** Deallocate a KeyInfo object
10002ec2fb22Sdrh */
10012ec2fb22Sdrh void sqlite3KeyInfoUnref(KeyInfo *p){
10022ec2fb22Sdrh   if( p ){
10032ec2fb22Sdrh     assert( p->nRef>0 );
10042ec2fb22Sdrh     p->nRef--;
1005c6efe12dSmistachkin     if( p->nRef==0 ) sqlite3DbFree(0, p);
10062ec2fb22Sdrh   }
10072ec2fb22Sdrh }
10082ec2fb22Sdrh 
10092ec2fb22Sdrh /*
10102ec2fb22Sdrh ** Make a new pointer to a KeyInfo object
10112ec2fb22Sdrh */
10122ec2fb22Sdrh KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
10132ec2fb22Sdrh   if( p ){
10142ec2fb22Sdrh     assert( p->nRef>0 );
10152ec2fb22Sdrh     p->nRef++;
10162ec2fb22Sdrh   }
10172ec2fb22Sdrh   return p;
10182ec2fb22Sdrh }
10192ec2fb22Sdrh 
10202ec2fb22Sdrh #ifdef SQLITE_DEBUG
10212ec2fb22Sdrh /*
10222ec2fb22Sdrh ** Return TRUE if a KeyInfo object can be change.  The KeyInfo object
10232ec2fb22Sdrh ** can only be changed if this is just a single reference to the object.
10242ec2fb22Sdrh **
10252ec2fb22Sdrh ** This routine is used only inside of assert() statements.
10262ec2fb22Sdrh */
10272ec2fb22Sdrh int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
10282ec2fb22Sdrh #endif /* SQLITE_DEBUG */
10292ec2fb22Sdrh 
10302ec2fb22Sdrh /*
1031dece1a84Sdrh ** Given an expression list, generate a KeyInfo structure that records
1032dece1a84Sdrh ** the collating sequence for each expression in that expression list.
1033dece1a84Sdrh **
10340342b1f5Sdrh ** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
10350342b1f5Sdrh ** KeyInfo structure is appropriate for initializing a virtual index to
10360342b1f5Sdrh ** implement that clause.  If the ExprList is the result set of a SELECT
10370342b1f5Sdrh ** then the KeyInfo structure is appropriate for initializing a virtual
10380342b1f5Sdrh ** index to implement a DISTINCT test.
10390342b1f5Sdrh **
104060ec914cSpeter.d.reid ** Space to hold the KeyInfo structure is obtained from malloc.  The calling
1041dece1a84Sdrh ** function is responsible for seeing that this structure is eventually
10422ec2fb22Sdrh ** freed.
1043dece1a84Sdrh */
1044079a3072Sdrh static KeyInfo *keyInfoFromExprList(
1045079a3072Sdrh   Parse *pParse,       /* Parsing context */
1046079a3072Sdrh   ExprList *pList,     /* Form the KeyInfo object from this ExprList */
1047079a3072Sdrh   int iStart,          /* Begin with this column of pList */
1048079a3072Sdrh   int nExtra           /* Add this many extra columns to the end */
1049079a3072Sdrh ){
1050dece1a84Sdrh   int nExpr;
1051dece1a84Sdrh   KeyInfo *pInfo;
1052dece1a84Sdrh   struct ExprList_item *pItem;
1053323df790Sdrh   sqlite3 *db = pParse->db;
1054dece1a84Sdrh   int i;
1055dece1a84Sdrh 
1056dece1a84Sdrh   nExpr = pList->nExpr;
1057079a3072Sdrh   pInfo = sqlite3KeyInfoAlloc(db, nExpr+nExtra-iStart, 1);
1058dece1a84Sdrh   if( pInfo ){
10592ec2fb22Sdrh     assert( sqlite3KeyInfoIsWriteable(pInfo) );
10606284db90Sdrh     for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
1061dece1a84Sdrh       CollSeq *pColl;
1062dece1a84Sdrh       pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
1063323df790Sdrh       if( !pColl ) pColl = db->pDfltColl;
10646284db90Sdrh       pInfo->aColl[i-iStart] = pColl;
10656284db90Sdrh       pInfo->aSortOrder[i-iStart] = pItem->sortOrder;
1066dece1a84Sdrh     }
1067dece1a84Sdrh   }
1068dece1a84Sdrh   return pInfo;
1069dece1a84Sdrh }
1070dece1a84Sdrh 
10717f61e92cSdan #ifndef SQLITE_OMIT_COMPOUND_SELECT
10727f61e92cSdan /*
10737f61e92cSdan ** Name of the connection operator, used for error messages.
10747f61e92cSdan */
10757f61e92cSdan static const char *selectOpName(int id){
10767f61e92cSdan   char *z;
10777f61e92cSdan   switch( id ){
10787f61e92cSdan     case TK_ALL:       z = "UNION ALL";   break;
10797f61e92cSdan     case TK_INTERSECT: z = "INTERSECT";   break;
10807f61e92cSdan     case TK_EXCEPT:    z = "EXCEPT";      break;
10817f61e92cSdan     default:           z = "UNION";       break;
10827f61e92cSdan   }
10837f61e92cSdan   return z;
10847f61e92cSdan }
10857f61e92cSdan #endif /* SQLITE_OMIT_COMPOUND_SELECT */
10867f61e92cSdan 
10872ce22453Sdan #ifndef SQLITE_OMIT_EXPLAIN
108817c0bc0cSdan /*
108917c0bc0cSdan ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
109017c0bc0cSdan ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
109117c0bc0cSdan ** where the caption is of the form:
109217c0bc0cSdan **
109317c0bc0cSdan **   "USE TEMP B-TREE FOR xxx"
109417c0bc0cSdan **
109517c0bc0cSdan ** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
109617c0bc0cSdan ** is determined by the zUsage argument.
109717c0bc0cSdan */
10982ce22453Sdan static void explainTempTable(Parse *pParse, const char *zUsage){
10992ce22453Sdan   if( pParse->explain==2 ){
11002ce22453Sdan     Vdbe *v = pParse->pVdbe;
11012ce22453Sdan     char *zMsg = sqlite3MPrintf(pParse->db, "USE TEMP B-TREE FOR %s", zUsage);
11022ce22453Sdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
11032ce22453Sdan   }
11042ce22453Sdan }
110517c0bc0cSdan 
110617c0bc0cSdan /*
1107bb2b4418Sdan ** Assign expression b to lvalue a. A second, no-op, version of this macro
1108bb2b4418Sdan ** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
1109bb2b4418Sdan ** in sqlite3Select() to assign values to structure member variables that
1110bb2b4418Sdan ** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
1111bb2b4418Sdan ** code with #ifndef directives.
1112bb2b4418Sdan */
1113bb2b4418Sdan # define explainSetInteger(a, b) a = b
1114bb2b4418Sdan 
1115bb2b4418Sdan #else
1116bb2b4418Sdan /* No-op versions of the explainXXX() functions and macros. */
1117bb2b4418Sdan # define explainTempTable(y,z)
1118bb2b4418Sdan # define explainSetInteger(y,z)
1119bb2b4418Sdan #endif
1120bb2b4418Sdan 
1121bb2b4418Sdan #if !defined(SQLITE_OMIT_EXPLAIN) && !defined(SQLITE_OMIT_COMPOUND_SELECT)
1122bb2b4418Sdan /*
11237f61e92cSdan ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
11247f61e92cSdan ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
11257f61e92cSdan ** where the caption is of one of the two forms:
11267f61e92cSdan **
11277f61e92cSdan **   "COMPOSITE SUBQUERIES iSub1 and iSub2 (op)"
11287f61e92cSdan **   "COMPOSITE SUBQUERIES iSub1 and iSub2 USING TEMP B-TREE (op)"
11297f61e92cSdan **
11307f61e92cSdan ** where iSub1 and iSub2 are the integers passed as the corresponding
11317f61e92cSdan ** function parameters, and op is the text representation of the parameter
11327f61e92cSdan ** of the same name. The parameter "op" must be one of TK_UNION, TK_EXCEPT,
11337f61e92cSdan ** TK_INTERSECT or TK_ALL. The first form is used if argument bUseTmp is
11347f61e92cSdan ** false, or the second form if it is true.
11357f61e92cSdan */
11367f61e92cSdan static void explainComposite(
11377f61e92cSdan   Parse *pParse,                  /* Parse context */
11387f61e92cSdan   int op,                         /* One of TK_UNION, TK_EXCEPT etc. */
11397f61e92cSdan   int iSub1,                      /* Subquery id 1 */
11407f61e92cSdan   int iSub2,                      /* Subquery id 2 */
11417f61e92cSdan   int bUseTmp                     /* True if a temp table was used */
11427f61e92cSdan ){
11437f61e92cSdan   assert( op==TK_UNION || op==TK_EXCEPT || op==TK_INTERSECT || op==TK_ALL );
11447f61e92cSdan   if( pParse->explain==2 ){
11457f61e92cSdan     Vdbe *v = pParse->pVdbe;
11467f61e92cSdan     char *zMsg = sqlite3MPrintf(
114730969d3fSdan         pParse->db, "COMPOUND SUBQUERIES %d AND %d %s(%s)", iSub1, iSub2,
11487f61e92cSdan         bUseTmp?"USING TEMP B-TREE ":"", selectOpName(op)
11497f61e92cSdan     );
11507f61e92cSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
11517f61e92cSdan   }
11527f61e92cSdan }
11532ce22453Sdan #else
115417c0bc0cSdan /* No-op versions of the explainXXX() functions and macros. */
11557f61e92cSdan # define explainComposite(v,w,x,y,z)
11562ce22453Sdan #endif
1157dece1a84Sdrh 
1158dece1a84Sdrh /*
1159d8bc7086Sdrh ** If the inner loop was generated using a non-null pOrderBy argument,
1160d8bc7086Sdrh ** then the results were placed in a sorter.  After the loop is terminated
1161d8bc7086Sdrh ** we need to run the sorter and output the results.  The following
1162d8bc7086Sdrh ** routine generates the code needed to do that.
1163d8bc7086Sdrh */
1164c926afbcSdrh static void generateSortTail(
1165cdd536f0Sdrh   Parse *pParse,    /* Parsing context */
1166c926afbcSdrh   Select *p,        /* The SELECT statement */
1167079a3072Sdrh   SortCtx *pSort,   /* Information on the ORDER BY clause */
1168c926afbcSdrh   int nColumn,      /* Number of columns of data */
11696c8c8ce0Sdanielk1977   SelectDest *pDest /* Write the sorted results here */
1170c926afbcSdrh ){
1171ddba0c22Sdrh   Vdbe *v = pParse->pVdbe;                     /* The prepared statement */
1172dc5ea5c7Sdrh   int addrBreak = sqlite3VdbeMakeLabel(v);     /* Jump here to exit loop */
1173dc5ea5c7Sdrh   int addrContinue = sqlite3VdbeMakeLabel(v);  /* Jump here for next cycle */
1174d8bc7086Sdrh   int addr;
1175079a3072Sdrh   int addrOnce = 0;
11760342b1f5Sdrh   int iTab;
1177079a3072Sdrh   ExprList *pOrderBy = pSort->pOrderBy;
11786c8c8ce0Sdanielk1977   int eDest = pDest->eDest;
11792b596da8Sdrh   int iParm = pDest->iSDParm;
11802d401ab8Sdrh   int regRow;
11812d401ab8Sdrh   int regRowid;
1182079a3072Sdrh   int nKey;
1183f45f2326Sdrh   int iSortTab;                   /* Sorter cursor to read from */
1184f45f2326Sdrh   int nSortData;                  /* Trailing values to read from sorter */
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);
12186cf4a7dfSdrh     sqlite3VdbeAddOp3(v, OP_SorterData, iTab, regSortOut, iSortTab);
121978d58432Sdan     bSeq = 0;
1220c6aff30cSdrh   }else{
1221688852abSdrh     addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
1222aa9ce707Sdrh     codeOffset(v, p->iOffset, addrContinue);
1223f45f2326Sdrh     iSortTab = iTab;
122478d58432Sdan     bSeq = 1;
1225f45f2326Sdrh   }
1226f45f2326Sdrh   for(i=0; i<nSortData; i++){
122778d58432Sdan     sqlite3VdbeAddOp3(v, OP_Column, iSortTab, nKey+bSeq+i, regRow+i);
122870f624c3Sdrh     VdbeComment((v, "%s", aOutEx[i].zName ? aOutEx[i].zName : aOutEx[i].zSpan));
1229c6aff30cSdrh   }
1230c926afbcSdrh   switch( eDest ){
1231c926afbcSdrh     case SRT_Table:
1232b9bb7c18Sdrh     case SRT_EphemTab: {
12331c767f0dSdrh       testcase( eDest==SRT_Table );
12341c767f0dSdrh       testcase( eDest==SRT_EphemTab );
12352d401ab8Sdrh       sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
12362d401ab8Sdrh       sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
12372d401ab8Sdrh       sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1238c926afbcSdrh       break;
1239c926afbcSdrh     }
124093758c8dSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
1241c926afbcSdrh     case SRT_Set: {
1242c926afbcSdrh       assert( nColumn==1 );
1243634d81deSdrh       sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, 1, regRowid,
1244634d81deSdrh                         &pDest->affSdst, 1);
1245da250ea5Sdrh       sqlite3ExprCacheAffinityChange(pParse, regRow, 1);
1246a7a8e14bSdanielk1977       sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm, regRowid);
1247c926afbcSdrh       break;
1248c926afbcSdrh     }
1249c926afbcSdrh     case SRT_Mem: {
1250c926afbcSdrh       assert( nColumn==1 );
1251b21e7c70Sdrh       sqlite3ExprCodeMove(pParse, regRow, iParm, 1);
1252ec7429aeSdrh       /* The LIMIT clause will terminate the loop for us */
1253c926afbcSdrh       break;
1254c926afbcSdrh     }
125593758c8dSdanielk1977 #endif
1256373cc2ddSdrh     default: {
1257373cc2ddSdrh       assert( eDest==SRT_Output || eDest==SRT_Coroutine );
12581c767f0dSdrh       testcase( eDest==SRT_Output );
12591c767f0dSdrh       testcase( eDest==SRT_Coroutine );
12607d10d5a6Sdrh       if( eDest==SRT_Output ){
12612b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
12622b596da8Sdrh         sqlite3ExprCacheAffinityChange(pParse, pDest->iSdst, nColumn);
1263a9671a22Sdrh       }else{
12642b596da8Sdrh         sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
1265ce665cf6Sdrh       }
1266ac82fcf5Sdrh       break;
1267ac82fcf5Sdrh     }
1268c926afbcSdrh   }
1269f45f2326Sdrh   if( regRowid ){
12702d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, regRow);
12712d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, regRowid);
1272f45f2326Sdrh   }
1273ec7429aeSdrh   /* The bottom of the loop
1274ec7429aeSdrh   */
1275dc5ea5c7Sdrh   sqlite3VdbeResolveLabel(v, addrContinue);
1276079a3072Sdrh   if( pSort->sortFlags & SORTFLAG_UseSorter ){
1277688852abSdrh     sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
1278c6aff30cSdrh   }else{
1279688852abSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
1280c6aff30cSdrh   }
1281079a3072Sdrh   if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
1282dc5ea5c7Sdrh   sqlite3VdbeResolveLabel(v, addrBreak);
1283d8bc7086Sdrh }
1284d8bc7086Sdrh 
1285d8bc7086Sdrh /*
1286517eb646Sdanielk1977 ** Return a pointer to a string containing the 'declaration type' of the
1287517eb646Sdanielk1977 ** expression pExpr. The string may be treated as static by the caller.
1288e78e8284Sdrh **
12895f3e5e74Sdrh ** Also try to estimate the size of the returned value and return that
12905f3e5e74Sdrh ** result in *pEstWidth.
12915f3e5e74Sdrh **
1292955de52cSdanielk1977 ** The declaration type is the exact datatype definition extracted from the
1293955de52cSdanielk1977 ** original CREATE TABLE statement if the expression is a column. The
1294955de52cSdanielk1977 ** declaration type for a ROWID field is INTEGER. Exactly when an expression
1295955de52cSdanielk1977 ** is considered a column can be complex in the presence of subqueries. The
1296955de52cSdanielk1977 ** result-set expression in all of the following SELECT statements is
1297955de52cSdanielk1977 ** considered a column by this function.
1298e78e8284Sdrh **
1299955de52cSdanielk1977 **   SELECT col FROM tbl;
1300955de52cSdanielk1977 **   SELECT (SELECT col FROM tbl;
1301955de52cSdanielk1977 **   SELECT (SELECT col FROM tbl);
1302955de52cSdanielk1977 **   SELECT abc FROM (SELECT col AS abc FROM tbl);
1303955de52cSdanielk1977 **
1304955de52cSdanielk1977 ** The declaration type for any expression other than a column is NULL.
13055f3e5e74Sdrh **
13065f3e5e74Sdrh ** This routine has either 3 or 6 parameters depending on whether or not
13075f3e5e74Sdrh ** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
1308fcb78a49Sdrh */
13095f3e5e74Sdrh #ifdef SQLITE_ENABLE_COLUMN_METADATA
13105f3e5e74Sdrh # define columnType(A,B,C,D,E,F) columnTypeImpl(A,B,C,D,E,F)
13115f3e5e74Sdrh static const char *columnTypeImpl(
1312955de52cSdanielk1977   NameContext *pNC,
1313955de52cSdanielk1977   Expr *pExpr,
13145f3e5e74Sdrh   const char **pzOrigDb,
13155f3e5e74Sdrh   const char **pzOrigTab,
13165f3e5e74Sdrh   const char **pzOrigCol,
13175f3e5e74Sdrh   u8 *pEstWidth
1318955de52cSdanielk1977 ){
13195f3e5e74Sdrh   char const *zOrigDb = 0;
13205f3e5e74Sdrh   char const *zOrigTab = 0;
13215f3e5e74Sdrh   char const *zOrigCol = 0;
13225f3e5e74Sdrh #else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
13235f3e5e74Sdrh # define columnType(A,B,C,D,E,F) columnTypeImpl(A,B,F)
13245f3e5e74Sdrh static const char *columnTypeImpl(
13255f3e5e74Sdrh   NameContext *pNC,
13265f3e5e74Sdrh   Expr *pExpr,
13275f3e5e74Sdrh   u8 *pEstWidth
13285f3e5e74Sdrh ){
13295f3e5e74Sdrh #endif /* !defined(SQLITE_ENABLE_COLUMN_METADATA) */
1330955de52cSdanielk1977   char const *zType = 0;
1331517eb646Sdanielk1977   int j;
13325f3e5e74Sdrh   u8 estWidth = 1;
13335338a5f7Sdanielk1977 
13345f3e5e74Sdrh   if( NEVER(pExpr==0) || pNC->pSrcList==0 ) return 0;
133500e279d9Sdanielk1977   switch( pExpr->op ){
133630bcf5dbSdrh     case TK_AGG_COLUMN:
133700e279d9Sdanielk1977     case TK_COLUMN: {
1338955de52cSdanielk1977       /* The expression is a column. Locate the table the column is being
1339955de52cSdanielk1977       ** extracted from in NameContext.pSrcList. This table may be real
1340955de52cSdanielk1977       ** database table or a subquery.
1341955de52cSdanielk1977       */
1342955de52cSdanielk1977       Table *pTab = 0;            /* Table structure column is extracted from */
1343955de52cSdanielk1977       Select *pS = 0;             /* Select the column is extracted from */
1344955de52cSdanielk1977       int iCol = pExpr->iColumn;  /* Index of column in pTab */
1345373cc2ddSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1346373cc2ddSdrh       testcase( pExpr->op==TK_COLUMN );
134743bc88bbSdan       while( pNC && !pTab ){
1348b3bce662Sdanielk1977         SrcList *pTabList = pNC->pSrcList;
1349b3bce662Sdanielk1977         for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
1350b3bce662Sdanielk1977         if( j<pTabList->nSrc ){
13516a3ea0e6Sdrh           pTab = pTabList->a[j].pTab;
1352955de52cSdanielk1977           pS = pTabList->a[j].pSelect;
1353b3bce662Sdanielk1977         }else{
1354b3bce662Sdanielk1977           pNC = pNC->pNext;
1355b3bce662Sdanielk1977         }
1356b3bce662Sdanielk1977       }
1357955de52cSdanielk1977 
135843bc88bbSdan       if( pTab==0 ){
1359417168adSdrh         /* At one time, code such as "SELECT new.x" within a trigger would
1360417168adSdrh         ** cause this condition to run.  Since then, we have restructured how
1361417168adSdrh         ** trigger code is generated and so this condition is no longer
136243bc88bbSdan         ** possible. However, it can still be true for statements like
136343bc88bbSdan         ** the following:
136443bc88bbSdan         **
136543bc88bbSdan         **   CREATE TABLE t1(col INTEGER);
136643bc88bbSdan         **   SELECT (SELECT t1.col) FROM FROM t1;
136743bc88bbSdan         **
136843bc88bbSdan         ** when columnType() is called on the expression "t1.col" in the
136943bc88bbSdan         ** sub-select. In this case, set the column type to NULL, even
137043bc88bbSdan         ** though it should really be "INTEGER".
137143bc88bbSdan         **
137243bc88bbSdan         ** This is not a problem, as the column type of "t1.col" is never
137343bc88bbSdan         ** used. When columnType() is called on the expression
137443bc88bbSdan         ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
137543bc88bbSdan         ** branch below.  */
13767e62779aSdrh         break;
13777e62779aSdrh       }
1378955de52cSdanielk1977 
137943bc88bbSdan       assert( pTab && pExpr->pTab==pTab );
1380955de52cSdanielk1977       if( pS ){
1381955de52cSdanielk1977         /* The "table" is actually a sub-select or a view in the FROM clause
1382955de52cSdanielk1977         ** of the SELECT statement. Return the declaration type and origin
1383955de52cSdanielk1977         ** data for the result-set column of the sub-select.
1384955de52cSdanielk1977         */
13857b688edeSdrh         if( iCol>=0 && ALWAYS(iCol<pS->pEList->nExpr) ){
1386955de52cSdanielk1977           /* If iCol is less than zero, then the expression requests the
1387955de52cSdanielk1977           ** rowid of the sub-select or view. This expression is legal (see
1388955de52cSdanielk1977           ** test case misc2.2.2) - it always evaluates to NULL.
1389955de52cSdanielk1977           */
1390955de52cSdanielk1977           NameContext sNC;
1391955de52cSdanielk1977           Expr *p = pS->pEList->a[iCol].pExpr;
1392955de52cSdanielk1977           sNC.pSrcList = pS->pSrc;
139343bc88bbSdan           sNC.pNext = pNC;
1394955de52cSdanielk1977           sNC.pParse = pNC->pParse;
13955f3e5e74Sdrh           zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol, &estWidth);
1396955de52cSdanielk1977         }
139793c36bb3Sdrh       }else if( pTab->pSchema ){
1398955de52cSdanielk1977         /* A real table */
1399955de52cSdanielk1977         assert( !pS );
1400fcb78a49Sdrh         if( iCol<0 ) iCol = pTab->iPKey;
1401fcb78a49Sdrh         assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
14025f3e5e74Sdrh #ifdef SQLITE_ENABLE_COLUMN_METADATA
1403fcb78a49Sdrh         if( iCol<0 ){
1404fcb78a49Sdrh           zType = "INTEGER";
14055f3e5e74Sdrh           zOrigCol = "rowid";
1406fcb78a49Sdrh         }else{
1407fcb78a49Sdrh           zType = pTab->aCol[iCol].zType;
14085f3e5e74Sdrh           zOrigCol = pTab->aCol[iCol].zName;
14095f3e5e74Sdrh           estWidth = pTab->aCol[iCol].szEst;
1410955de52cSdanielk1977         }
14115f3e5e74Sdrh         zOrigTab = pTab->zName;
1412955de52cSdanielk1977         if( pNC->pParse ){
1413955de52cSdanielk1977           int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
14145f3e5e74Sdrh           zOrigDb = pNC->pParse->db->aDb[iDb].zName;
1415955de52cSdanielk1977         }
14165f3e5e74Sdrh #else
14175f3e5e74Sdrh         if( iCol<0 ){
14185f3e5e74Sdrh           zType = "INTEGER";
14195f3e5e74Sdrh         }else{
14205f3e5e74Sdrh           zType = pTab->aCol[iCol].zType;
14215f3e5e74Sdrh           estWidth = pTab->aCol[iCol].szEst;
14225f3e5e74Sdrh         }
14235f3e5e74Sdrh #endif
1424fcb78a49Sdrh       }
142500e279d9Sdanielk1977       break;
1426736c22b8Sdrh     }
142793758c8dSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
142800e279d9Sdanielk1977     case TK_SELECT: {
1429955de52cSdanielk1977       /* The expression is a sub-select. Return the declaration type and
1430955de52cSdanielk1977       ** origin info for the single column in the result set of the SELECT
1431955de52cSdanielk1977       ** statement.
1432955de52cSdanielk1977       */
1433b3bce662Sdanielk1977       NameContext sNC;
14346ab3a2ecSdanielk1977       Select *pS = pExpr->x.pSelect;
1435955de52cSdanielk1977       Expr *p = pS->pEList->a[0].pExpr;
14366ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
1437955de52cSdanielk1977       sNC.pSrcList = pS->pSrc;
1438b3bce662Sdanielk1977       sNC.pNext = pNC;
1439955de52cSdanielk1977       sNC.pParse = pNC->pParse;
14405f3e5e74Sdrh       zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol, &estWidth);
144100e279d9Sdanielk1977       break;
1442fcb78a49Sdrh     }
144393758c8dSdanielk1977 #endif
144400e279d9Sdanielk1977   }
144500e279d9Sdanielk1977 
14465f3e5e74Sdrh #ifdef SQLITE_ENABLE_COLUMN_METADATA
14475f3e5e74Sdrh   if( pzOrigDb ){
14485f3e5e74Sdrh     assert( pzOrigTab && pzOrigCol );
14495f3e5e74Sdrh     *pzOrigDb = zOrigDb;
14505f3e5e74Sdrh     *pzOrigTab = zOrigTab;
14515f3e5e74Sdrh     *pzOrigCol = zOrigCol;
1452955de52cSdanielk1977   }
14535f3e5e74Sdrh #endif
14545f3e5e74Sdrh   if( pEstWidth ) *pEstWidth = estWidth;
1455517eb646Sdanielk1977   return zType;
1456517eb646Sdanielk1977 }
1457517eb646Sdanielk1977 
1458517eb646Sdanielk1977 /*
1459517eb646Sdanielk1977 ** Generate code that will tell the VDBE the declaration types of columns
1460517eb646Sdanielk1977 ** in the result set.
1461517eb646Sdanielk1977 */
1462517eb646Sdanielk1977 static void generateColumnTypes(
1463517eb646Sdanielk1977   Parse *pParse,      /* Parser context */
1464517eb646Sdanielk1977   SrcList *pTabList,  /* List of tables */
1465517eb646Sdanielk1977   ExprList *pEList    /* Expressions defining the result set */
1466517eb646Sdanielk1977 ){
14673f913576Sdrh #ifndef SQLITE_OMIT_DECLTYPE
1468517eb646Sdanielk1977   Vdbe *v = pParse->pVdbe;
1469517eb646Sdanielk1977   int i;
1470b3bce662Sdanielk1977   NameContext sNC;
1471b3bce662Sdanielk1977   sNC.pSrcList = pTabList;
1472955de52cSdanielk1977   sNC.pParse = pParse;
1473517eb646Sdanielk1977   for(i=0; i<pEList->nExpr; i++){
1474517eb646Sdanielk1977     Expr *p = pEList->a[i].pExpr;
14753f913576Sdrh     const char *zType;
14763f913576Sdrh #ifdef SQLITE_ENABLE_COLUMN_METADATA
1477955de52cSdanielk1977     const char *zOrigDb = 0;
1478955de52cSdanielk1977     const char *zOrigTab = 0;
1479955de52cSdanielk1977     const char *zOrigCol = 0;
14805f3e5e74Sdrh     zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol, 0);
1481955de52cSdanielk1977 
148285b623f2Sdrh     /* The vdbe must make its own copy of the column-type and other
14834b1ae99dSdanielk1977     ** column specific strings, in case the schema is reset before this
14844b1ae99dSdanielk1977     ** virtual machine is deleted.
1485fbcd585fSdanielk1977     */
148610fb749bSdanielk1977     sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
148710fb749bSdanielk1977     sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
148810fb749bSdanielk1977     sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
14893f913576Sdrh #else
14905f3e5e74Sdrh     zType = columnType(&sNC, p, 0, 0, 0, 0);
14913f913576Sdrh #endif
149210fb749bSdanielk1977     sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
1493fcb78a49Sdrh   }
14945f3e5e74Sdrh #endif /* !defined(SQLITE_OMIT_DECLTYPE) */
1495fcb78a49Sdrh }
1496fcb78a49Sdrh 
1497fcb78a49Sdrh /*
1498fcb78a49Sdrh ** Generate code that will tell the VDBE the names of columns
1499fcb78a49Sdrh ** in the result set.  This information is used to provide the
1500fcabd464Sdrh ** azCol[] values in the callback.
150182c3d636Sdrh */
1502832508b7Sdrh static void generateColumnNames(
1503832508b7Sdrh   Parse *pParse,      /* Parser context */
1504ad3cab52Sdrh   SrcList *pTabList,  /* List of tables */
1505832508b7Sdrh   ExprList *pEList    /* Expressions defining the result set */
1506832508b7Sdrh ){
1507d8bc7086Sdrh   Vdbe *v = pParse->pVdbe;
15086a3ea0e6Sdrh   int i, j;
15099bb575fdSdrh   sqlite3 *db = pParse->db;
1510fcabd464Sdrh   int fullNames, shortNames;
1511fcabd464Sdrh 
1512fe2093d7Sdrh #ifndef SQLITE_OMIT_EXPLAIN
15133cf86063Sdanielk1977   /* If this is an EXPLAIN, skip this step */
15143cf86063Sdanielk1977   if( pParse->explain ){
151561de0d1bSdanielk1977     return;
15163cf86063Sdanielk1977   }
15175338a5f7Sdanielk1977 #endif
15183cf86063Sdanielk1977 
1519e2f02bacSdrh   if( pParse->colNamesSet || NEVER(v==0) || db->mallocFailed ) return;
1520d8bc7086Sdrh   pParse->colNamesSet = 1;
1521fcabd464Sdrh   fullNames = (db->flags & SQLITE_FullColNames)!=0;
1522fcabd464Sdrh   shortNames = (db->flags & SQLITE_ShortColNames)!=0;
152322322fd4Sdanielk1977   sqlite3VdbeSetNumCols(v, pEList->nExpr);
152482c3d636Sdrh   for(i=0; i<pEList->nExpr; i++){
152582c3d636Sdrh     Expr *p;
15265a38705eSdrh     p = pEList->a[i].pExpr;
1527373cc2ddSdrh     if( NEVER(p==0) ) continue;
152882c3d636Sdrh     if( pEList->a[i].zName ){
152982c3d636Sdrh       char *zName = pEList->a[i].zName;
153010fb749bSdanielk1977       sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
1531f018cc2eSdrh     }else if( (p->op==TK_COLUMN || p->op==TK_AGG_COLUMN) && pTabList ){
15326a3ea0e6Sdrh       Table *pTab;
153397665873Sdrh       char *zCol;
15348aff1015Sdrh       int iCol = p->iColumn;
1535e2f02bacSdrh       for(j=0; ALWAYS(j<pTabList->nSrc); j++){
1536e2f02bacSdrh         if( pTabList->a[j].iCursor==p->iTable ) break;
1537e2f02bacSdrh       }
15386a3ea0e6Sdrh       assert( j<pTabList->nSrc );
15396a3ea0e6Sdrh       pTab = pTabList->a[j].pTab;
15408aff1015Sdrh       if( iCol<0 ) iCol = pTab->iPKey;
154197665873Sdrh       assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
1542b1363206Sdrh       if( iCol<0 ){
154347a6db2bSdrh         zCol = "rowid";
1544b1363206Sdrh       }else{
1545b1363206Sdrh         zCol = pTab->aCol[iCol].zName;
1546b1363206Sdrh       }
1547e49b146fSdrh       if( !shortNames && !fullNames ){
154810fb749bSdanielk1977         sqlite3VdbeSetColName(v, i, COLNAME_NAME,
1549b7916a78Sdrh             sqlite3DbStrDup(db, pEList->a[i].zSpan), SQLITE_DYNAMIC);
15501c767f0dSdrh       }else if( fullNames ){
155182c3d636Sdrh         char *zName = 0;
15521c767f0dSdrh         zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
155310fb749bSdanielk1977         sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
155482c3d636Sdrh       }else{
155510fb749bSdanielk1977         sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
155682c3d636Sdrh       }
15571bee3d7bSdrh     }else{
1558859bc542Sdrh       const char *z = pEList->a[i].zSpan;
1559859bc542Sdrh       z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
1560859bc542Sdrh       sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
156182c3d636Sdrh     }
156282c3d636Sdrh   }
156376d505baSdanielk1977   generateColumnTypes(pParse, pTabList, pEList);
15645080aaa7Sdrh }
156582c3d636Sdrh 
1566d8bc7086Sdrh /*
156760ec914cSpeter.d.reid ** Given an expression list (which is really the list of expressions
15687d10d5a6Sdrh ** that form the result set of a SELECT statement) compute appropriate
15697d10d5a6Sdrh ** column names for a table that would hold the expression list.
15707d10d5a6Sdrh **
15717d10d5a6Sdrh ** All column names will be unique.
15727d10d5a6Sdrh **
15737d10d5a6Sdrh ** Only the column names are computed.  Column.zType, Column.zColl,
15747d10d5a6Sdrh ** and other fields of Column are zeroed.
15757d10d5a6Sdrh **
15767d10d5a6Sdrh ** Return SQLITE_OK on success.  If a memory allocation error occurs,
15777d10d5a6Sdrh ** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
1578315555caSdrh */
15797d10d5a6Sdrh static int selectColumnsFromExprList(
15807d10d5a6Sdrh   Parse *pParse,          /* Parsing context */
15817d10d5a6Sdrh   ExprList *pEList,       /* Expr list from which to derive column names */
1582d815f17dSdrh   i16 *pnCol,             /* Write the number of columns here */
15837d10d5a6Sdrh   Column **paCol          /* Write the new column list here */
15847d10d5a6Sdrh ){
1585dc5ea5c7Sdrh   sqlite3 *db = pParse->db;   /* Database connection */
1586dc5ea5c7Sdrh   int i, j;                   /* Loop counters */
1587dc5ea5c7Sdrh   int cnt;                    /* Index added to make the name unique */
1588dc5ea5c7Sdrh   Column *aCol, *pCol;        /* For looping over result columns */
1589dc5ea5c7Sdrh   int nCol;                   /* Number of columns in the result set */
1590dc5ea5c7Sdrh   Expr *p;                    /* Expression for a single result column */
1591dc5ea5c7Sdrh   char *zName;                /* Column name */
1592dc5ea5c7Sdrh   int nName;                  /* Size of name in zName[] */
159379d5f63fSdrh 
15948c2e0f02Sdan   if( pEList ){
15958c2e0f02Sdan     nCol = pEList->nExpr;
15968c2e0f02Sdan     aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
15978c2e0f02Sdan     testcase( aCol==0 );
15988c2e0f02Sdan   }else{
15998c2e0f02Sdan     nCol = 0;
16008c2e0f02Sdan     aCol = 0;
16018c2e0f02Sdan   }
16028c2e0f02Sdan   *pnCol = nCol;
16038c2e0f02Sdan   *paCol = aCol;
16048c2e0f02Sdan 
16057d10d5a6Sdrh   for(i=0, pCol=aCol; i<nCol; i++, pCol++){
160679d5f63fSdrh     /* Get an appropriate name for the column
160779d5f63fSdrh     */
1608580c8c18Sdrh     p = sqlite3ExprSkipCollate(pEList->a[i].pExpr);
160991bb0eedSdrh     if( (zName = pEList->a[i].zName)!=0 ){
161079d5f63fSdrh       /* If the column contains an "AS <name>" phrase, use <name> as the name */
161117435752Sdrh       zName = sqlite3DbStrDup(db, zName);
16127d10d5a6Sdrh     }else{
1613dc5ea5c7Sdrh       Expr *pColExpr = p;  /* The expression that is the result column name */
1614dc5ea5c7Sdrh       Table *pTab;         /* Table associated with this expression */
1615b07028f7Sdrh       while( pColExpr->op==TK_DOT ){
1616b07028f7Sdrh         pColExpr = pColExpr->pRight;
1617b07028f7Sdrh         assert( pColExpr!=0 );
1618b07028f7Sdrh       }
1619373cc2ddSdrh       if( pColExpr->op==TK_COLUMN && ALWAYS(pColExpr->pTab!=0) ){
162093a960a0Sdrh         /* For columns use the column name name */
1621dc5ea5c7Sdrh         int iCol = pColExpr->iColumn;
1622373cc2ddSdrh         pTab = pColExpr->pTab;
1623f0209f74Sdrh         if( iCol<0 ) iCol = pTab->iPKey;
1624f0209f74Sdrh         zName = sqlite3MPrintf(db, "%s",
1625f0209f74Sdrh                  iCol>=0 ? pTab->aCol[iCol].zName : "rowid");
1626b7916a78Sdrh       }else if( pColExpr->op==TK_ID ){
162733e619fcSdrh         assert( !ExprHasProperty(pColExpr, EP_IntValue) );
162833e619fcSdrh         zName = sqlite3MPrintf(db, "%s", pColExpr->u.zToken);
162993a960a0Sdrh       }else{
163079d5f63fSdrh         /* Use the original text of the column expression as its name */
1631b7916a78Sdrh         zName = sqlite3MPrintf(db, "%s", pEList->a[i].zSpan);
16327d10d5a6Sdrh       }
163322f70c32Sdrh     }
16347ce72f69Sdrh     if( db->mallocFailed ){
1635633e6d57Sdrh       sqlite3DbFree(db, zName);
16367ce72f69Sdrh       break;
1637dd5b2fa5Sdrh     }
163879d5f63fSdrh 
163979d5f63fSdrh     /* Make sure the column name is unique.  If the name is not unique,
164060ec914cSpeter.d.reid     ** append an integer to the name so that it becomes unique.
164179d5f63fSdrh     */
1642ea678832Sdrh     nName = sqlite3Strlen30(zName);
164379d5f63fSdrh     for(j=cnt=0; j<i; j++){
164479d5f63fSdrh       if( sqlite3StrICmp(aCol[j].zName, zName)==0 ){
1645633e6d57Sdrh         char *zNewName;
1646fb777327Sdrh         int k;
1647fb777327Sdrh         for(k=nName-1; k>1 && sqlite3Isdigit(zName[k]); k--){}
164819c6d96aSdrh         if( k>=0 && zName[k]==':' ) nName = k;
16492564ef97Sdrh         zName[nName] = 0;
1650633e6d57Sdrh         zNewName = sqlite3MPrintf(db, "%s:%d", zName, ++cnt);
1651633e6d57Sdrh         sqlite3DbFree(db, zName);
1652633e6d57Sdrh         zName = zNewName;
165379d5f63fSdrh         j = -1;
1654dd5b2fa5Sdrh         if( zName==0 ) break;
165579d5f63fSdrh       }
165679d5f63fSdrh     }
165791bb0eedSdrh     pCol->zName = zName;
16587d10d5a6Sdrh   }
16597d10d5a6Sdrh   if( db->mallocFailed ){
16607d10d5a6Sdrh     for(j=0; j<i; j++){
16617d10d5a6Sdrh       sqlite3DbFree(db, aCol[j].zName);
16627d10d5a6Sdrh     }
16637d10d5a6Sdrh     sqlite3DbFree(db, aCol);
16647d10d5a6Sdrh     *paCol = 0;
16657d10d5a6Sdrh     *pnCol = 0;
16667d10d5a6Sdrh     return SQLITE_NOMEM;
16677d10d5a6Sdrh   }
16687d10d5a6Sdrh   return SQLITE_OK;
16697d10d5a6Sdrh }
1670e014a838Sdanielk1977 
16717d10d5a6Sdrh /*
16727d10d5a6Sdrh ** Add type and collation information to a column list based on
16737d10d5a6Sdrh ** a SELECT statement.
16747d10d5a6Sdrh **
16757d10d5a6Sdrh ** The column list presumably came from selectColumnNamesFromExprList().
16767d10d5a6Sdrh ** The column list has only names, not types or collations.  This
16777d10d5a6Sdrh ** routine goes through and adds the types and collations.
16787d10d5a6Sdrh **
1679b08a67a7Sshane ** This routine requires that all identifiers in the SELECT
16807d10d5a6Sdrh ** statement be resolved.
168179d5f63fSdrh */
16827d10d5a6Sdrh static void selectAddColumnTypeAndCollation(
16837d10d5a6Sdrh   Parse *pParse,        /* Parsing contexts */
1684186ad8ccSdrh   Table *pTab,          /* Add column type information to this table */
16857d10d5a6Sdrh   Select *pSelect       /* SELECT used to determine types and collations */
16867d10d5a6Sdrh ){
16877d10d5a6Sdrh   sqlite3 *db = pParse->db;
16887d10d5a6Sdrh   NameContext sNC;
16897d10d5a6Sdrh   Column *pCol;
16907d10d5a6Sdrh   CollSeq *pColl;
16917d10d5a6Sdrh   int i;
16927d10d5a6Sdrh   Expr *p;
16937d10d5a6Sdrh   struct ExprList_item *a;
1694186ad8ccSdrh   u64 szAll = 0;
16957d10d5a6Sdrh 
16967d10d5a6Sdrh   assert( pSelect!=0 );
16977d10d5a6Sdrh   assert( (pSelect->selFlags & SF_Resolved)!=0 );
1698186ad8ccSdrh   assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
16997d10d5a6Sdrh   if( db->mallocFailed ) return;
1700c43e8be8Sdrh   memset(&sNC, 0, sizeof(sNC));
1701b3bce662Sdanielk1977   sNC.pSrcList = pSelect->pSrc;
17027d10d5a6Sdrh   a = pSelect->pEList->a;
1703186ad8ccSdrh   for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
17047d10d5a6Sdrh     p = a[i].pExpr;
17055f3e5e74Sdrh     pCol->zType = sqlite3DbStrDup(db, columnType(&sNC, p,0,0,0, &pCol->szEst));
1706186ad8ccSdrh     szAll += pCol->szEst;
1707c60e9b82Sdanielk1977     pCol->affinity = sqlite3ExprAffinity(p);
1708c4a64facSdrh     if( pCol->affinity==0 ) pCol->affinity = SQLITE_AFF_NONE;
1709b3bf556eSdanielk1977     pColl = sqlite3ExprCollSeq(pParse, p);
1710b3bf556eSdanielk1977     if( pColl ){
171117435752Sdrh       pCol->zColl = sqlite3DbStrDup(db, pColl->zName);
17120202b29eSdanielk1977     }
171322f70c32Sdrh   }
1714186ad8ccSdrh   pTab->szTabRow = sqlite3LogEst(szAll*4);
17157d10d5a6Sdrh }
17167d10d5a6Sdrh 
17177d10d5a6Sdrh /*
17187d10d5a6Sdrh ** Given a SELECT statement, generate a Table structure that describes
17197d10d5a6Sdrh ** the result set of that SELECT.
17207d10d5a6Sdrh */
17217d10d5a6Sdrh Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect){
17227d10d5a6Sdrh   Table *pTab;
17237d10d5a6Sdrh   sqlite3 *db = pParse->db;
17247d10d5a6Sdrh   int savedFlags;
17257d10d5a6Sdrh 
17267d10d5a6Sdrh   savedFlags = db->flags;
17277d10d5a6Sdrh   db->flags &= ~SQLITE_FullColNames;
17287d10d5a6Sdrh   db->flags |= SQLITE_ShortColNames;
17297d10d5a6Sdrh   sqlite3SelectPrep(pParse, pSelect, 0);
17307d10d5a6Sdrh   if( pParse->nErr ) return 0;
17317d10d5a6Sdrh   while( pSelect->pPrior ) pSelect = pSelect->pPrior;
17327d10d5a6Sdrh   db->flags = savedFlags;
17337d10d5a6Sdrh   pTab = sqlite3DbMallocZero(db, sizeof(Table) );
17347d10d5a6Sdrh   if( pTab==0 ){
17357d10d5a6Sdrh     return 0;
17367d10d5a6Sdrh   }
1737373cc2ddSdrh   /* The sqlite3ResultSetOfSelect() is only used n contexts where lookaside
1738b2468954Sdrh   ** is disabled */
1739373cc2ddSdrh   assert( db->lookaside.bEnabled==0 );
17407d10d5a6Sdrh   pTab->nRef = 1;
17417d10d5a6Sdrh   pTab->zName = 0;
1742cfc9df76Sdan   pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
17437d10d5a6Sdrh   selectColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
1744186ad8ccSdrh   selectAddColumnTypeAndCollation(pParse, pTab, pSelect);
174522f70c32Sdrh   pTab->iPKey = -1;
17467ce72f69Sdrh   if( db->mallocFailed ){
17471feeaed2Sdan     sqlite3DeleteTable(db, pTab);
17487ce72f69Sdrh     return 0;
17497ce72f69Sdrh   }
175022f70c32Sdrh   return pTab;
175122f70c32Sdrh }
175222f70c32Sdrh 
175322f70c32Sdrh /*
1754d8bc7086Sdrh ** Get a VDBE for the given parser context.  Create a new one if necessary.
1755d8bc7086Sdrh ** If an error occurs, return NULL and leave a message in pParse.
1756d8bc7086Sdrh */
17574adee20fSdanielk1977 Vdbe *sqlite3GetVdbe(Parse *pParse){
1758d8bc7086Sdrh   Vdbe *v = pParse->pVdbe;
1759d8bc7086Sdrh   if( v==0 ){
17609ac7962aSdrh     v = pParse->pVdbe = sqlite3VdbeCreate(pParse);
1761aceb31b1Sdrh     if( v ) sqlite3VdbeAddOp0(v, OP_Init);
1762e0e261a4Sdrh     if( pParse->pToplevel==0
1763e0e261a4Sdrh      && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
1764e0e261a4Sdrh     ){
1765e0e261a4Sdrh       pParse->okConstFactor = 1;
1766e0e261a4Sdrh     }
1767e0e261a4Sdrh 
1768d8bc7086Sdrh   }
1769d8bc7086Sdrh   return v;
1770d8bc7086Sdrh }
1771d8bc7086Sdrh 
177215007a99Sdrh 
1773d8bc7086Sdrh /*
17747b58daeaSdrh ** Compute the iLimit and iOffset fields of the SELECT based on the
1775ec7429aeSdrh ** pLimit and pOffset expressions.  pLimit and pOffset hold the expressions
17767b58daeaSdrh ** that appear in the original SQL statement after the LIMIT and OFFSET
1777a2dc3b1aSdanielk1977 ** keywords.  Or NULL if those keywords are omitted. iLimit and iOffset
1778a2dc3b1aSdanielk1977 ** are the integer memory register numbers for counters used to compute
1779a2dc3b1aSdanielk1977 ** the limit and offset.  If there is no limit and/or offset, then
1780a2dc3b1aSdanielk1977 ** iLimit and iOffset are negative.
17817b58daeaSdrh **
1782d59ba6ceSdrh ** This routine changes the values of iLimit and iOffset only if
1783ec7429aeSdrh ** a limit or offset is defined by pLimit and pOffset.  iLimit and
1784aa9ce707Sdrh ** iOffset should have been preset to appropriate default values (zero)
1785aa9ce707Sdrh ** prior to calling this routine.
1786aa9ce707Sdrh **
1787aa9ce707Sdrh ** The iOffset register (if it exists) is initialized to the value
1788aa9ce707Sdrh ** of the OFFSET.  The iLimit register is initialized to LIMIT.  Register
1789aa9ce707Sdrh ** iOffset+1 is initialized to LIMIT+OFFSET.
1790aa9ce707Sdrh **
1791ec7429aeSdrh ** Only if pLimit!=0 or pOffset!=0 do the limit registers get
17927b58daeaSdrh ** redefined.  The UNION ALL operator uses this property to force
17937b58daeaSdrh ** the reuse of the same limit and offset registers across multiple
17947b58daeaSdrh ** SELECT statements.
17957b58daeaSdrh */
1796ec7429aeSdrh static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
179702afc861Sdrh   Vdbe *v = 0;
179802afc861Sdrh   int iLimit = 0;
179915007a99Sdrh   int iOffset;
18009b918ed1Sdrh   int addr1, n;
18010acb7e48Sdrh   if( p->iLimit ) return;
180215007a99Sdrh 
18037b58daeaSdrh   /*
18047b58daeaSdrh   ** "LIMIT -1" always shows all rows.  There is some
1805f7b5496eSdrh   ** controversy about what the correct behavior should be.
18067b58daeaSdrh   ** The current implementation interprets "LIMIT 0" to mean
18077b58daeaSdrh   ** no rows.
18087b58daeaSdrh   */
1809ceea3321Sdrh   sqlite3ExprCacheClear(pParse);
1810373cc2ddSdrh   assert( p->pOffset==0 || p->pLimit!=0 );
1811a2dc3b1aSdanielk1977   if( p->pLimit ){
18120a07c107Sdrh     p->iLimit = iLimit = ++pParse->nMem;
181315007a99Sdrh     v = sqlite3GetVdbe(pParse);
1814aa9ce707Sdrh     assert( v!=0 );
18159b918ed1Sdrh     if( sqlite3ExprIsInteger(p->pLimit, &n) ){
18169b918ed1Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
18179b918ed1Sdrh       VdbeComment((v, "LIMIT counter"));
1818456e4e4fSdrh       if( n==0 ){
1819456e4e4fSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, iBreak);
1820613ba1eaSdrh       }else if( n>=0 && p->nSelectRow>(u64)n ){
1821613ba1eaSdrh         p->nSelectRow = n;
18229b918ed1Sdrh       }
18239b918ed1Sdrh     }else{
1824b7654111Sdrh       sqlite3ExprCode(pParse, p->pLimit, iLimit);
1825688852abSdrh       sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
1826d4e70ebdSdrh       VdbeComment((v, "LIMIT counter"));
1827688852abSdrh       sqlite3VdbeAddOp2(v, OP_IfZero, iLimit, iBreak); VdbeCoverage(v);
18289b918ed1Sdrh     }
1829a2dc3b1aSdanielk1977     if( p->pOffset ){
18300a07c107Sdrh       p->iOffset = iOffset = ++pParse->nMem;
1831b7654111Sdrh       pParse->nMem++;   /* Allocate an extra register for limit+offset */
1832b7654111Sdrh       sqlite3ExprCode(pParse, p->pOffset, iOffset);
1833688852abSdrh       sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
1834d4e70ebdSdrh       VdbeComment((v, "OFFSET counter"));
1835688852abSdrh       addr1 = sqlite3VdbeAddOp1(v, OP_IfPos, iOffset); VdbeCoverage(v);
1836b7654111Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, iOffset);
183715007a99Sdrh       sqlite3VdbeJumpHere(v, addr1);
1838b7654111Sdrh       sqlite3VdbeAddOp3(v, OP_Add, iLimit, iOffset, iOffset+1);
1839d4e70ebdSdrh       VdbeComment((v, "LIMIT+OFFSET"));
1840688852abSdrh       addr1 = sqlite3VdbeAddOp1(v, OP_IfPos, iLimit); VdbeCoverage(v);
1841b7654111Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, -1, iOffset+1);
1842b7654111Sdrh       sqlite3VdbeJumpHere(v, addr1);
1843b7654111Sdrh     }
1844d59ba6ceSdrh   }
18457b58daeaSdrh }
18467b58daeaSdrh 
1847b7f9164eSdrh #ifndef SQLITE_OMIT_COMPOUND_SELECT
1848fbc4ee7bSdrh /*
1849fbc4ee7bSdrh ** Return the appropriate collating sequence for the iCol-th column of
1850fbc4ee7bSdrh ** the result set for the compound-select statement "p".  Return NULL if
1851fbc4ee7bSdrh ** the column has no default collating sequence.
1852fbc4ee7bSdrh **
1853fbc4ee7bSdrh ** The collating sequence for the compound select is taken from the
1854fbc4ee7bSdrh ** left-most term of the select that has a collating sequence.
1855fbc4ee7bSdrh */
1856dc1bdc4fSdanielk1977 static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
1857fbc4ee7bSdrh   CollSeq *pRet;
1858dc1bdc4fSdanielk1977   if( p->pPrior ){
1859dc1bdc4fSdanielk1977     pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
1860fbc4ee7bSdrh   }else{
1861fbc4ee7bSdrh     pRet = 0;
1862dc1bdc4fSdanielk1977   }
186310c081adSdrh   assert( iCol>=0 );
186410c081adSdrh   if( pRet==0 && iCol<p->pEList->nExpr ){
1865dc1bdc4fSdanielk1977     pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
1866dc1bdc4fSdanielk1977   }
1867dc1bdc4fSdanielk1977   return pRet;
1868d3d39e93Sdrh }
186953bed45eSdan 
187053bed45eSdan /*
187153bed45eSdan ** The select statement passed as the second parameter is a compound SELECT
187253bed45eSdan ** with an ORDER BY clause. This function allocates and returns a KeyInfo
187353bed45eSdan ** structure suitable for implementing the ORDER BY.
187453bed45eSdan **
187553bed45eSdan ** Space to hold the KeyInfo structure is obtained from malloc. The calling
187653bed45eSdan ** function is responsible for ensuring that this structure is eventually
187753bed45eSdan ** freed.
187853bed45eSdan */
187953bed45eSdan static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
188053bed45eSdan   ExprList *pOrderBy = p->pOrderBy;
188153bed45eSdan   int nOrderBy = p->pOrderBy->nExpr;
188253bed45eSdan   sqlite3 *db = pParse->db;
188353bed45eSdan   KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
188453bed45eSdan   if( pRet ){
188553bed45eSdan     int i;
188653bed45eSdan     for(i=0; i<nOrderBy; i++){
188753bed45eSdan       struct ExprList_item *pItem = &pOrderBy->a[i];
188853bed45eSdan       Expr *pTerm = pItem->pExpr;
188953bed45eSdan       CollSeq *pColl;
189053bed45eSdan 
189153bed45eSdan       if( pTerm->flags & EP_Collate ){
189253bed45eSdan         pColl = sqlite3ExprCollSeq(pParse, pTerm);
189353bed45eSdan       }else{
189453bed45eSdan         pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
189553bed45eSdan         if( pColl==0 ) pColl = db->pDfltColl;
189653bed45eSdan         pOrderBy->a[i].pExpr =
189753bed45eSdan           sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
189853bed45eSdan       }
189953bed45eSdan       assert( sqlite3KeyInfoIsWriteable(pRet) );
190053bed45eSdan       pRet->aColl[i] = pColl;
190153bed45eSdan       pRet->aSortOrder[i] = pOrderBy->a[i].sortOrder;
190253bed45eSdan     }
190353bed45eSdan   }
190453bed45eSdan 
190553bed45eSdan   return pRet;
190653bed45eSdan }
1907d3d39e93Sdrh 
1908781def29Sdrh #ifndef SQLITE_OMIT_CTE
1909781def29Sdrh /*
1910781def29Sdrh ** This routine generates VDBE code to compute the content of a WITH RECURSIVE
1911781def29Sdrh ** query of the form:
1912781def29Sdrh **
1913781def29Sdrh **   <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
1914781def29Sdrh **                         \___________/             \_______________/
1915781def29Sdrh **                           p->pPrior                      p
1916781def29Sdrh **
1917781def29Sdrh **
1918781def29Sdrh ** There is exactly one reference to the recursive-table in the FROM clause
1919781def29Sdrh ** of recursive-query, marked with the SrcList->a[].isRecursive flag.
1920781def29Sdrh **
1921781def29Sdrh ** The setup-query runs once to generate an initial set of rows that go
1922781def29Sdrh ** into a Queue table.  Rows are extracted from the Queue table one by
1923fe1c6bb9Sdrh ** one.  Each row extracted from Queue is output to pDest.  Then the single
1924fe1c6bb9Sdrh ** extracted row (now in the iCurrent table) becomes the content of the
1925fe1c6bb9Sdrh ** recursive-table for a recursive-query run.  The output of the recursive-query
1926781def29Sdrh ** is added back into the Queue table.  Then another row is extracted from Queue
1927781def29Sdrh ** and the iteration continues until the Queue table is empty.
1928781def29Sdrh **
1929781def29Sdrh ** If the compound query operator is UNION then no duplicate rows are ever
1930781def29Sdrh ** inserted into the Queue table.  The iDistinct table keeps a copy of all rows
1931781def29Sdrh ** that have ever been inserted into Queue and causes duplicates to be
1932781def29Sdrh ** discarded.  If the operator is UNION ALL, then duplicates are allowed.
1933781def29Sdrh **
1934781def29Sdrh ** If the query has an ORDER BY, then entries in the Queue table are kept in
1935781def29Sdrh ** ORDER BY order and the first entry is extracted for each cycle.  Without
1936781def29Sdrh ** an ORDER BY, the Queue table is just a FIFO.
1937781def29Sdrh **
1938781def29Sdrh ** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
1939781def29Sdrh ** have been output to pDest.  A LIMIT of zero means to output no rows and a
1940781def29Sdrh ** negative LIMIT means to output all rows.  If there is also an OFFSET clause
1941781def29Sdrh ** with a positive value, then the first OFFSET outputs are discarded rather
1942781def29Sdrh ** than being sent to pDest.  The LIMIT count does not begin until after OFFSET
1943781def29Sdrh ** rows have been skipped.
1944781def29Sdrh */
1945781def29Sdrh static void generateWithRecursiveQuery(
1946781def29Sdrh   Parse *pParse,        /* Parsing context */
1947781def29Sdrh   Select *p,            /* The recursive SELECT to be coded */
1948781def29Sdrh   SelectDest *pDest     /* What to do with query results */
1949781def29Sdrh ){
1950781def29Sdrh   SrcList *pSrc = p->pSrc;      /* The FROM clause of the recursive query */
1951781def29Sdrh   int nCol = p->pEList->nExpr;  /* Number of columns in the recursive table */
1952781def29Sdrh   Vdbe *v = pParse->pVdbe;      /* The prepared statement under construction */
1953781def29Sdrh   Select *pSetup = p->pPrior;   /* The setup query */
1954781def29Sdrh   int addrTop;                  /* Top of the loop */
1955781def29Sdrh   int addrCont, addrBreak;      /* CONTINUE and BREAK addresses */
1956edf83d1eSdrh   int iCurrent = 0;             /* The Current table */
1957781def29Sdrh   int regCurrent;               /* Register holding Current table */
1958781def29Sdrh   int iQueue;                   /* The Queue table */
1959781def29Sdrh   int iDistinct = 0;            /* To ensure unique results if UNION */
19608e1ee88cSdrh   int eDest = SRT_Fifo;         /* How to write to Queue */
1961781def29Sdrh   SelectDest destQueue;         /* SelectDest targetting the Queue table */
1962781def29Sdrh   int i;                        /* Loop counter */
1963781def29Sdrh   int rc;                       /* Result code */
1964fe1c6bb9Sdrh   ExprList *pOrderBy;           /* The ORDER BY clause */
1965aa9ce707Sdrh   Expr *pLimit, *pOffset;       /* Saved LIMIT and OFFSET */
1966aa9ce707Sdrh   int regLimit, regOffset;      /* Registers used by LIMIT and OFFSET */
1967781def29Sdrh 
1968781def29Sdrh   /* Obtain authorization to do a recursive query */
1969781def29Sdrh   if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
1970781def29Sdrh 
1971aa9ce707Sdrh   /* Process the LIMIT and OFFSET clauses, if they exist */
1972aa9ce707Sdrh   addrBreak = sqlite3VdbeMakeLabel(v);
1973aa9ce707Sdrh   computeLimitRegisters(pParse, p, addrBreak);
1974aa9ce707Sdrh   pLimit = p->pLimit;
1975aa9ce707Sdrh   pOffset = p->pOffset;
1976aa9ce707Sdrh   regLimit = p->iLimit;
1977aa9ce707Sdrh   regOffset = p->iOffset;
1978aa9ce707Sdrh   p->pLimit = p->pOffset = 0;
1979aa9ce707Sdrh   p->iLimit = p->iOffset = 0;
198053bed45eSdan   pOrderBy = p->pOrderBy;
1981781def29Sdrh 
1982781def29Sdrh   /* Locate the cursor number of the Current table */
1983781def29Sdrh   for(i=0; ALWAYS(i<pSrc->nSrc); i++){
1984781def29Sdrh     if( pSrc->a[i].isRecursive ){
1985781def29Sdrh       iCurrent = pSrc->a[i].iCursor;
1986781def29Sdrh       break;
1987781def29Sdrh     }
1988781def29Sdrh   }
1989781def29Sdrh 
1990fe1c6bb9Sdrh   /* Allocate cursors numbers for Queue and Distinct.  The cursor number for
1991781def29Sdrh   ** the Distinct table must be exactly one greater than Queue in order
19928e1ee88cSdrh   ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
1993781def29Sdrh   iQueue = pParse->nTab++;
1994781def29Sdrh   if( p->op==TK_UNION ){
19958e1ee88cSdrh     eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
1996781def29Sdrh     iDistinct = pParse->nTab++;
1997fe1c6bb9Sdrh   }else{
19988e1ee88cSdrh     eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
1999781def29Sdrh   }
2000781def29Sdrh   sqlite3SelectDestInit(&destQueue, eDest, iQueue);
2001781def29Sdrh 
2002781def29Sdrh   /* Allocate cursors for Current, Queue, and Distinct. */
2003781def29Sdrh   regCurrent = ++pParse->nMem;
2004781def29Sdrh   sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
2005fe1c6bb9Sdrh   if( pOrderBy ){
200653bed45eSdan     KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
2007fe1c6bb9Sdrh     sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
2008fe1c6bb9Sdrh                       (char*)pKeyInfo, P4_KEYINFO);
2009fe1c6bb9Sdrh     destQueue.pOrderBy = pOrderBy;
2010fe1c6bb9Sdrh   }else{
2011781def29Sdrh     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
2012fe1c6bb9Sdrh   }
2013fe1c6bb9Sdrh   VdbeComment((v, "Queue table"));
2014781def29Sdrh   if( iDistinct ){
2015781def29Sdrh     p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
2016781def29Sdrh     p->selFlags |= SF_UsesEphemeral;
2017781def29Sdrh   }
2018781def29Sdrh 
201953bed45eSdan   /* Detach the ORDER BY clause from the compound SELECT */
202053bed45eSdan   p->pOrderBy = 0;
202153bed45eSdan 
2022781def29Sdrh   /* Store the results of the setup-query in Queue. */
2023d227a291Sdrh   pSetup->pNext = 0;
2024781def29Sdrh   rc = sqlite3Select(pParse, pSetup, &destQueue);
2025d227a291Sdrh   pSetup->pNext = p;
2026fe1c6bb9Sdrh   if( rc ) goto end_of_recursive_query;
2027781def29Sdrh 
2028781def29Sdrh   /* Find the next row in the Queue and output that row */
2029688852abSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
2030781def29Sdrh 
2031781def29Sdrh   /* Transfer the next row in Queue over to Current */
2032781def29Sdrh   sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
2033fe1c6bb9Sdrh   if( pOrderBy ){
2034fe1c6bb9Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
2035fe1c6bb9Sdrh   }else{
2036781def29Sdrh     sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
2037fe1c6bb9Sdrh   }
2038781def29Sdrh   sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
2039781def29Sdrh 
2040fe1c6bb9Sdrh   /* Output the single row in Current */
2041fe1c6bb9Sdrh   addrCont = sqlite3VdbeMakeLabel(v);
2042aa9ce707Sdrh   codeOffset(v, regOffset, addrCont);
2043fe1c6bb9Sdrh   selectInnerLoop(pParse, p, p->pEList, iCurrent,
2044079a3072Sdrh       0, 0, pDest, addrCont, addrBreak);
2045688852abSdrh   if( regLimit ){
2046688852abSdrh     sqlite3VdbeAddOp3(v, OP_IfZero, regLimit, addrBreak, -1);
2047688852abSdrh     VdbeCoverage(v);
2048688852abSdrh   }
2049fe1c6bb9Sdrh   sqlite3VdbeResolveLabel(v, addrCont);
2050fe1c6bb9Sdrh 
2051781def29Sdrh   /* Execute the recursive SELECT taking the single row in Current as
2052781def29Sdrh   ** the value for the recursive-table. Store the results in the Queue.
2053781def29Sdrh   */
2054781def29Sdrh   p->pPrior = 0;
2055781def29Sdrh   sqlite3Select(pParse, p, &destQueue);
2056781def29Sdrh   assert( p->pPrior==0 );
2057781def29Sdrh   p->pPrior = pSetup;
2058781def29Sdrh 
2059781def29Sdrh   /* Keep running the loop until the Queue is empty */
2060781def29Sdrh   sqlite3VdbeAddOp2(v, OP_Goto, 0, addrTop);
2061781def29Sdrh   sqlite3VdbeResolveLabel(v, addrBreak);
2062fe1c6bb9Sdrh 
2063fe1c6bb9Sdrh end_of_recursive_query:
20649afccba2Sdan   sqlite3ExprListDelete(pParse->db, p->pOrderBy);
2065fe1c6bb9Sdrh   p->pOrderBy = pOrderBy;
2066aa9ce707Sdrh   p->pLimit = pLimit;
2067aa9ce707Sdrh   p->pOffset = pOffset;
2068fe1c6bb9Sdrh   return;
2069781def29Sdrh }
2070b68b9778Sdan #endif /* SQLITE_OMIT_CTE */
2071781def29Sdrh 
2072781def29Sdrh /* Forward references */
2073b21e7c70Sdrh static int multiSelectOrderBy(
2074b21e7c70Sdrh   Parse *pParse,        /* Parsing context */
2075b21e7c70Sdrh   Select *p,            /* The right-most of SELECTs to be coded */
2076a9671a22Sdrh   SelectDest *pDest     /* What to do with query results */
2077b21e7c70Sdrh );
2078b21e7c70Sdrh 
207945f54a57Sdrh /*
208045f54a57Sdrh ** Error message for when two or more terms of a compound select have different
208145f54a57Sdrh ** size result sets.
208245f54a57Sdrh */
208345f54a57Sdrh static void selectWrongNumTermsError(Parse *pParse, Select *p){
208445f54a57Sdrh   if( p->selFlags & SF_Values ){
208545f54a57Sdrh     sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
208645f54a57Sdrh   }else{
208745f54a57Sdrh     sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
208845f54a57Sdrh       " do not have the same number of result columns", selectOpName(p->op));
208945f54a57Sdrh   }
209045f54a57Sdrh }
209145f54a57Sdrh 
209245f54a57Sdrh /*
209345f54a57Sdrh ** Handle the special case of a compound-select that originates from a
209445f54a57Sdrh ** VALUES clause.  By handling this as a special case, we avoid deep
209545f54a57Sdrh ** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
209645f54a57Sdrh ** on a VALUES clause.
209745f54a57Sdrh **
209845f54a57Sdrh ** Because the Select object originates from a VALUES clause:
209945f54a57Sdrh **   (1) It has no LIMIT or OFFSET
210045f54a57Sdrh **   (2) All terms are UNION ALL
210145f54a57Sdrh **   (3) There is no ORDER BY clause
210245f54a57Sdrh */
210345f54a57Sdrh static int multiSelectValues(
210445f54a57Sdrh   Parse *pParse,        /* Parsing context */
210545f54a57Sdrh   Select *p,            /* The right-most of SELECTs to be coded */
210645f54a57Sdrh   SelectDest *pDest     /* What to do with query results */
210745f54a57Sdrh ){
210845f54a57Sdrh   Select *pPrior;
210945f54a57Sdrh   int nExpr = p->pEList->nExpr;
211045f54a57Sdrh   int nRow = 1;
211145f54a57Sdrh   int rc = 0;
211245f54a57Sdrh   assert( p->pNext==0 );
211345f54a57Sdrh   assert( p->selFlags & SF_AllValues );
211445f54a57Sdrh   do{
211545f54a57Sdrh     assert( p->selFlags & SF_Values );
211645f54a57Sdrh     assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
211745f54a57Sdrh     assert( p->pLimit==0 );
211845f54a57Sdrh     assert( p->pOffset==0 );
211945f54a57Sdrh     if( p->pEList->nExpr!=nExpr ){
212045f54a57Sdrh       selectWrongNumTermsError(pParse, p);
212145f54a57Sdrh       return 1;
212245f54a57Sdrh     }
212345f54a57Sdrh     if( p->pPrior==0 ) break;
212445f54a57Sdrh     assert( p->pPrior->pNext==p );
212545f54a57Sdrh     p = p->pPrior;
212645f54a57Sdrh     nRow++;
212745f54a57Sdrh   }while(1);
212845f54a57Sdrh   while( p ){
212945f54a57Sdrh     pPrior = p->pPrior;
213045f54a57Sdrh     p->pPrior = 0;
213145f54a57Sdrh     rc = sqlite3Select(pParse, p, pDest);
213245f54a57Sdrh     p->pPrior = pPrior;
213345f54a57Sdrh     if( rc ) break;
213445f54a57Sdrh     p->nSelectRow = nRow;
213545f54a57Sdrh     p = p->pNext;
213645f54a57Sdrh   }
213745f54a57Sdrh   return rc;
213845f54a57Sdrh }
2139b21e7c70Sdrh 
2140d3d39e93Sdrh /*
214116ee60ffSdrh ** This routine is called to process a compound query form from
214216ee60ffSdrh ** two or more separate queries using UNION, UNION ALL, EXCEPT, or
214316ee60ffSdrh ** INTERSECT
2144c926afbcSdrh **
2145e78e8284Sdrh ** "p" points to the right-most of the two queries.  the query on the
2146e78e8284Sdrh ** left is p->pPrior.  The left query could also be a compound query
2147e78e8284Sdrh ** in which case this routine will be called recursively.
2148e78e8284Sdrh **
2149e78e8284Sdrh ** The results of the total query are to be written into a destination
2150e78e8284Sdrh ** of type eDest with parameter iParm.
2151e78e8284Sdrh **
2152e78e8284Sdrh ** Example 1:  Consider a three-way compound SQL statement.
2153e78e8284Sdrh **
2154e78e8284Sdrh **     SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
2155e78e8284Sdrh **
2156e78e8284Sdrh ** This statement is parsed up as follows:
2157e78e8284Sdrh **
2158e78e8284Sdrh **     SELECT c FROM t3
2159e78e8284Sdrh **      |
2160e78e8284Sdrh **      `----->  SELECT b FROM t2
2161e78e8284Sdrh **                |
21624b11c6d3Sjplyon **                `------>  SELECT a FROM t1
2163e78e8284Sdrh **
2164e78e8284Sdrh ** The arrows in the diagram above represent the Select.pPrior pointer.
2165e78e8284Sdrh ** So if this routine is called with p equal to the t3 query, then
2166e78e8284Sdrh ** pPrior will be the t2 query.  p->op will be TK_UNION in this case.
2167e78e8284Sdrh **
2168e78e8284Sdrh ** Notice that because of the way SQLite parses compound SELECTs, the
2169e78e8284Sdrh ** individual selects always group from left to right.
217082c3d636Sdrh */
217184ac9d02Sdanielk1977 static int multiSelect(
2172fbc4ee7bSdrh   Parse *pParse,        /* Parsing context */
2173fbc4ee7bSdrh   Select *p,            /* The right-most of SELECTs to be coded */
2174a9671a22Sdrh   SelectDest *pDest     /* What to do with query results */
217584ac9d02Sdanielk1977 ){
217684ac9d02Sdanielk1977   int rc = SQLITE_OK;   /* Success code from a subroutine */
217710e5e3cfSdrh   Select *pPrior;       /* Another SELECT immediately to our left */
217810e5e3cfSdrh   Vdbe *v;              /* Generate code to this VDBE */
21791013c932Sdrh   SelectDest dest;      /* Alternative data destination */
2180eca7e01aSdanielk1977   Select *pDelete = 0;  /* Chain of simple selects to delete */
2181633e6d57Sdrh   sqlite3 *db;          /* Database connection */
21827f61e92cSdan #ifndef SQLITE_OMIT_EXPLAIN
2183edf83d1eSdrh   int iSub1 = 0;        /* EQP id of left-hand query */
2184edf83d1eSdrh   int iSub2 = 0;        /* EQP id of right-hand query */
21857f61e92cSdan #endif
218682c3d636Sdrh 
21877b58daeaSdrh   /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs.  Only
2188fbc4ee7bSdrh   ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
218982c3d636Sdrh   */
2190701bb3b4Sdrh   assert( p && p->pPrior );  /* Calling function guarantees this much */
2191eae73fbfSdan   assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
2192633e6d57Sdrh   db = pParse->db;
2193d8bc7086Sdrh   pPrior = p->pPrior;
2194bc10377aSdrh   dest = *pDest;
2195d8bc7086Sdrh   if( pPrior->pOrderBy ){
21964adee20fSdanielk1977     sqlite3ErrorMsg(pParse,"ORDER BY clause should come after %s not before",
2197da93d238Sdrh       selectOpName(p->op));
219884ac9d02Sdanielk1977     rc = 1;
219984ac9d02Sdanielk1977     goto multi_select_end;
220082c3d636Sdrh   }
2201a2dc3b1aSdanielk1977   if( pPrior->pLimit ){
22024adee20fSdanielk1977     sqlite3ErrorMsg(pParse,"LIMIT clause should come after %s not before",
22037b58daeaSdrh       selectOpName(p->op));
220484ac9d02Sdanielk1977     rc = 1;
220584ac9d02Sdanielk1977     goto multi_select_end;
22067b58daeaSdrh   }
220782c3d636Sdrh 
22084adee20fSdanielk1977   v = sqlite3GetVdbe(pParse);
2209701bb3b4Sdrh   assert( v!=0 );  /* The VDBE already created by calling function */
2210d8bc7086Sdrh 
22111cc3d75fSdrh   /* Create the destination temporary table if necessary
22121cc3d75fSdrh   */
22136c8c8ce0Sdanielk1977   if( dest.eDest==SRT_EphemTab ){
2214b4964b72Sdanielk1977     assert( p->pEList );
22152b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
2216d4187c71Sdrh     sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
22176c8c8ce0Sdanielk1977     dest.eDest = SRT_Table;
22181cc3d75fSdrh   }
22191cc3d75fSdrh 
222045f54a57Sdrh   /* Special handling for a compound-select that originates as a VALUES clause.
222145f54a57Sdrh   */
222245f54a57Sdrh   if( p->selFlags & SF_AllValues ){
222345f54a57Sdrh     rc = multiSelectValues(pParse, p, &dest);
222445f54a57Sdrh     goto multi_select_end;
222545f54a57Sdrh   }
222645f54a57Sdrh 
2227f6e369a1Sdrh   /* Make sure all SELECTs in the statement have the same number of elements
2228f6e369a1Sdrh   ** in their result sets.
2229f6e369a1Sdrh   */
2230f6e369a1Sdrh   assert( p->pEList && pPrior->pEList );
2231f6e369a1Sdrh   if( p->pEList->nExpr!=pPrior->pEList->nExpr ){
223245f54a57Sdrh     selectWrongNumTermsError(pParse, p);
2233f6e369a1Sdrh     rc = 1;
2234f6e369a1Sdrh     goto multi_select_end;
2235f6e369a1Sdrh   }
2236f6e369a1Sdrh 
2237eede6a53Sdan #ifndef SQLITE_OMIT_CTE
2238eae73fbfSdan   if( p->selFlags & SF_Recursive ){
2239781def29Sdrh     generateWithRecursiveQuery(pParse, p, &dest);
22408ce7184bSdan   }else
22418ce7184bSdan #endif
22428ce7184bSdan 
2243a9671a22Sdrh   /* Compound SELECTs that have an ORDER BY clause are handled separately.
2244a9671a22Sdrh   */
2245f6e369a1Sdrh   if( p->pOrderBy ){
2246a9671a22Sdrh     return multiSelectOrderBy(pParse, p, pDest);
2247eede6a53Sdan   }else
2248f6e369a1Sdrh 
2249f46f905aSdrh   /* Generate code for the left and right SELECT statements.
2250d8bc7086Sdrh   */
225182c3d636Sdrh   switch( p->op ){
2252f46f905aSdrh     case TK_ALL: {
2253ec7429aeSdrh       int addr = 0;
225495aa47b1Sdrh       int nLimit;
2255a2dc3b1aSdanielk1977       assert( !pPrior->pLimit );
2256547180baSdrh       pPrior->iLimit = p->iLimit;
2257547180baSdrh       pPrior->iOffset = p->iOffset;
2258a2dc3b1aSdanielk1977       pPrior->pLimit = p->pLimit;
2259a2dc3b1aSdanielk1977       pPrior->pOffset = p->pOffset;
22607f61e92cSdan       explainSetInteger(iSub1, pParse->iNextSelectId);
22617d10d5a6Sdrh       rc = sqlite3Select(pParse, pPrior, &dest);
2262ad68cb6bSdanielk1977       p->pLimit = 0;
2263ad68cb6bSdanielk1977       p->pOffset = 0;
226484ac9d02Sdanielk1977       if( rc ){
226584ac9d02Sdanielk1977         goto multi_select_end;
226684ac9d02Sdanielk1977       }
2267f46f905aSdrh       p->pPrior = 0;
22687b58daeaSdrh       p->iLimit = pPrior->iLimit;
22697b58daeaSdrh       p->iOffset = pPrior->iOffset;
227092b01d53Sdrh       if( p->iLimit ){
2271688852abSdrh         addr = sqlite3VdbeAddOp1(v, OP_IfZero, p->iLimit); VdbeCoverage(v);
2272d4e70ebdSdrh         VdbeComment((v, "Jump ahead if LIMIT reached"));
2273ec7429aeSdrh       }
22747f61e92cSdan       explainSetInteger(iSub2, pParse->iNextSelectId);
22757d10d5a6Sdrh       rc = sqlite3Select(pParse, p, &dest);
2276373cc2ddSdrh       testcase( rc!=SQLITE_OK );
2277eca7e01aSdanielk1977       pDelete = p->pPrior;
2278f46f905aSdrh       p->pPrior = pPrior;
227995aa47b1Sdrh       p->nSelectRow += pPrior->nSelectRow;
228095aa47b1Sdrh       if( pPrior->pLimit
228195aa47b1Sdrh        && sqlite3ExprIsInteger(pPrior->pLimit, &nLimit)
2282613ba1eaSdrh        && nLimit>0 && p->nSelectRow > (u64)nLimit
228395aa47b1Sdrh       ){
2284c63367efSdrh         p->nSelectRow = nLimit;
228595aa47b1Sdrh       }
2286ec7429aeSdrh       if( addr ){
2287ec7429aeSdrh         sqlite3VdbeJumpHere(v, addr);
2288ec7429aeSdrh       }
2289f46f905aSdrh       break;
2290f46f905aSdrh     }
229182c3d636Sdrh     case TK_EXCEPT:
229282c3d636Sdrh     case TK_UNION: {
2293d8bc7086Sdrh       int unionTab;    /* Cursor number of the temporary table holding result */
2294ea678832Sdrh       u8 op = 0;       /* One of the SRT_ operations to apply to self */
2295d8bc7086Sdrh       int priorOp;     /* The SRT_ operation to apply to prior selects */
2296a2dc3b1aSdanielk1977       Expr *pLimit, *pOffset; /* Saved values of p->nLimit and p->nOffset */
2297dc1bdc4fSdanielk1977       int addr;
22986c8c8ce0Sdanielk1977       SelectDest uniondest;
229982c3d636Sdrh 
2300373cc2ddSdrh       testcase( p->op==TK_EXCEPT );
2301373cc2ddSdrh       testcase( p->op==TK_UNION );
230293a960a0Sdrh       priorOp = SRT_Union;
2303d227a291Sdrh       if( dest.eDest==priorOp ){
2304d8bc7086Sdrh         /* We can reuse a temporary table generated by a SELECT to our
2305c926afbcSdrh         ** right.
2306d8bc7086Sdrh         */
2307e2f02bacSdrh         assert( p->pLimit==0 );      /* Not allowed on leftward elements */
2308e2f02bacSdrh         assert( p->pOffset==0 );     /* Not allowed on leftward elements */
23092b596da8Sdrh         unionTab = dest.iSDParm;
231082c3d636Sdrh       }else{
2311d8bc7086Sdrh         /* We will need to create our own temporary table to hold the
2312d8bc7086Sdrh         ** intermediate results.
2313d8bc7086Sdrh         */
231482c3d636Sdrh         unionTab = pParse->nTab++;
231593a960a0Sdrh         assert( p->pOrderBy==0 );
231666a5167bSdrh         addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
2317b9bb7c18Sdrh         assert( p->addrOpenEphm[0] == -1 );
2318b9bb7c18Sdrh         p->addrOpenEphm[0] = addr;
2319d227a291Sdrh         findRightmost(p)->selFlags |= SF_UsesEphemeral;
232084ac9d02Sdanielk1977         assert( p->pEList );
2321d8bc7086Sdrh       }
2322d8bc7086Sdrh 
2323d8bc7086Sdrh       /* Code the SELECT statements to our left
2324d8bc7086Sdrh       */
2325b3bce662Sdanielk1977       assert( !pPrior->pOrderBy );
23261013c932Sdrh       sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
23277f61e92cSdan       explainSetInteger(iSub1, pParse->iNextSelectId);
23287d10d5a6Sdrh       rc = sqlite3Select(pParse, pPrior, &uniondest);
232984ac9d02Sdanielk1977       if( rc ){
233084ac9d02Sdanielk1977         goto multi_select_end;
233184ac9d02Sdanielk1977       }
2332d8bc7086Sdrh 
2333d8bc7086Sdrh       /* Code the current SELECT statement
2334d8bc7086Sdrh       */
23354cfb22f7Sdrh       if( p->op==TK_EXCEPT ){
23364cfb22f7Sdrh         op = SRT_Except;
23374cfb22f7Sdrh       }else{
23384cfb22f7Sdrh         assert( p->op==TK_UNION );
23394cfb22f7Sdrh         op = SRT_Union;
2340d8bc7086Sdrh       }
234182c3d636Sdrh       p->pPrior = 0;
2342a2dc3b1aSdanielk1977       pLimit = p->pLimit;
2343a2dc3b1aSdanielk1977       p->pLimit = 0;
2344a2dc3b1aSdanielk1977       pOffset = p->pOffset;
2345a2dc3b1aSdanielk1977       p->pOffset = 0;
23466c8c8ce0Sdanielk1977       uniondest.eDest = op;
23477f61e92cSdan       explainSetInteger(iSub2, pParse->iNextSelectId);
23487d10d5a6Sdrh       rc = sqlite3Select(pParse, p, &uniondest);
2349373cc2ddSdrh       testcase( rc!=SQLITE_OK );
23505bd1bf2eSdrh       /* Query flattening in sqlite3Select() might refill p->pOrderBy.
23515bd1bf2eSdrh       ** Be sure to delete p->pOrderBy, therefore, to avoid a memory leak. */
2352633e6d57Sdrh       sqlite3ExprListDelete(db, p->pOrderBy);
2353eca7e01aSdanielk1977       pDelete = p->pPrior;
235482c3d636Sdrh       p->pPrior = pPrior;
2355a9671a22Sdrh       p->pOrderBy = 0;
235695aa47b1Sdrh       if( p->op==TK_UNION ) p->nSelectRow += pPrior->nSelectRow;
2357633e6d57Sdrh       sqlite3ExprDelete(db, p->pLimit);
2358a2dc3b1aSdanielk1977       p->pLimit = pLimit;
2359a2dc3b1aSdanielk1977       p->pOffset = pOffset;
236092b01d53Sdrh       p->iLimit = 0;
236192b01d53Sdrh       p->iOffset = 0;
2362d8bc7086Sdrh 
2363d8bc7086Sdrh       /* Convert the data in the temporary table into whatever form
2364d8bc7086Sdrh       ** it is that we currently need.
2365d8bc7086Sdrh       */
23662b596da8Sdrh       assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
2367373cc2ddSdrh       if( dest.eDest!=priorOp ){
23686b56344dSdrh         int iCont, iBreak, iStart;
236982c3d636Sdrh         assert( p->pEList );
23707d10d5a6Sdrh         if( dest.eDest==SRT_Output ){
237192378253Sdrh           Select *pFirst = p;
237292378253Sdrh           while( pFirst->pPrior ) pFirst = pFirst->pPrior;
237392378253Sdrh           generateColumnNames(pParse, 0, pFirst->pEList);
237441202ccaSdrh         }
23754adee20fSdanielk1977         iBreak = sqlite3VdbeMakeLabel(v);
23764adee20fSdanielk1977         iCont = sqlite3VdbeMakeLabel(v);
2377ec7429aeSdrh         computeLimitRegisters(pParse, p, iBreak);
2378688852abSdrh         sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
23794adee20fSdanielk1977         iStart = sqlite3VdbeCurrentAddr(v);
2380340309fdSdrh         selectInnerLoop(pParse, p, p->pEList, unionTab,
2381079a3072Sdrh                         0, 0, &dest, iCont, iBreak);
23824adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, iCont);
2383688852abSdrh         sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
23844adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, iBreak);
238566a5167bSdrh         sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
238682c3d636Sdrh       }
238782c3d636Sdrh       break;
238882c3d636Sdrh     }
2389373cc2ddSdrh     default: assert( p->op==TK_INTERSECT ); {
239082c3d636Sdrh       int tab1, tab2;
23916b56344dSdrh       int iCont, iBreak, iStart;
2392a2dc3b1aSdanielk1977       Expr *pLimit, *pOffset;
2393dc1bdc4fSdanielk1977       int addr;
23941013c932Sdrh       SelectDest intersectdest;
23959cbf3425Sdrh       int r1;
239682c3d636Sdrh 
2397d8bc7086Sdrh       /* INTERSECT is different from the others since it requires
23986206d50aSdrh       ** two temporary tables.  Hence it has its own case.  Begin
2399d8bc7086Sdrh       ** by allocating the tables we will need.
2400d8bc7086Sdrh       */
240182c3d636Sdrh       tab1 = pParse->nTab++;
240282c3d636Sdrh       tab2 = pParse->nTab++;
240393a960a0Sdrh       assert( p->pOrderBy==0 );
2404dc1bdc4fSdanielk1977 
240566a5167bSdrh       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
2406b9bb7c18Sdrh       assert( p->addrOpenEphm[0] == -1 );
2407b9bb7c18Sdrh       p->addrOpenEphm[0] = addr;
2408d227a291Sdrh       findRightmost(p)->selFlags |= SF_UsesEphemeral;
240984ac9d02Sdanielk1977       assert( p->pEList );
2410d8bc7086Sdrh 
2411d8bc7086Sdrh       /* Code the SELECTs to our left into temporary table "tab1".
2412d8bc7086Sdrh       */
24131013c932Sdrh       sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
24147f61e92cSdan       explainSetInteger(iSub1, pParse->iNextSelectId);
24157d10d5a6Sdrh       rc = sqlite3Select(pParse, pPrior, &intersectdest);
241684ac9d02Sdanielk1977       if( rc ){
241784ac9d02Sdanielk1977         goto multi_select_end;
241884ac9d02Sdanielk1977       }
2419d8bc7086Sdrh 
2420d8bc7086Sdrh       /* Code the current SELECT into temporary table "tab2"
2421d8bc7086Sdrh       */
242266a5167bSdrh       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
2423b9bb7c18Sdrh       assert( p->addrOpenEphm[1] == -1 );
2424b9bb7c18Sdrh       p->addrOpenEphm[1] = addr;
242582c3d636Sdrh       p->pPrior = 0;
2426a2dc3b1aSdanielk1977       pLimit = p->pLimit;
2427a2dc3b1aSdanielk1977       p->pLimit = 0;
2428a2dc3b1aSdanielk1977       pOffset = p->pOffset;
2429a2dc3b1aSdanielk1977       p->pOffset = 0;
24302b596da8Sdrh       intersectdest.iSDParm = tab2;
24317f61e92cSdan       explainSetInteger(iSub2, pParse->iNextSelectId);
24327d10d5a6Sdrh       rc = sqlite3Select(pParse, p, &intersectdest);
2433373cc2ddSdrh       testcase( rc!=SQLITE_OK );
2434eca7e01aSdanielk1977       pDelete = p->pPrior;
243582c3d636Sdrh       p->pPrior = pPrior;
243695aa47b1Sdrh       if( p->nSelectRow>pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
2437633e6d57Sdrh       sqlite3ExprDelete(db, p->pLimit);
2438a2dc3b1aSdanielk1977       p->pLimit = pLimit;
2439a2dc3b1aSdanielk1977       p->pOffset = pOffset;
2440d8bc7086Sdrh 
2441d8bc7086Sdrh       /* Generate code to take the intersection of the two temporary
2442d8bc7086Sdrh       ** tables.
2443d8bc7086Sdrh       */
244482c3d636Sdrh       assert( p->pEList );
24457d10d5a6Sdrh       if( dest.eDest==SRT_Output ){
244692378253Sdrh         Select *pFirst = p;
244792378253Sdrh         while( pFirst->pPrior ) pFirst = pFirst->pPrior;
244892378253Sdrh         generateColumnNames(pParse, 0, pFirst->pEList);
244941202ccaSdrh       }
24504adee20fSdanielk1977       iBreak = sqlite3VdbeMakeLabel(v);
24514adee20fSdanielk1977       iCont = sqlite3VdbeMakeLabel(v);
2452ec7429aeSdrh       computeLimitRegisters(pParse, p, iBreak);
2453688852abSdrh       sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
24549cbf3425Sdrh       r1 = sqlite3GetTempReg(pParse);
24559cbf3425Sdrh       iStart = sqlite3VdbeAddOp2(v, OP_RowKey, tab1, r1);
2456688852abSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0); VdbeCoverage(v);
24579cbf3425Sdrh       sqlite3ReleaseTempReg(pParse, r1);
2458340309fdSdrh       selectInnerLoop(pParse, p, p->pEList, tab1,
2459079a3072Sdrh                       0, 0, &dest, iCont, iBreak);
24604adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, iCont);
2461688852abSdrh       sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
24624adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, iBreak);
246366a5167bSdrh       sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
246466a5167bSdrh       sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
246582c3d636Sdrh       break;
246682c3d636Sdrh     }
246782c3d636Sdrh   }
24688cdbf836Sdrh 
24697f61e92cSdan   explainComposite(pParse, p->op, iSub1, iSub2, p->op!=TK_ALL);
24707f61e92cSdan 
2471a9671a22Sdrh   /* Compute collating sequences used by
2472a9671a22Sdrh   ** temporary tables needed to implement the compound select.
2473a9671a22Sdrh   ** Attach the KeyInfo structure to all temporary tables.
24748cdbf836Sdrh   **
24758cdbf836Sdrh   ** This section is run by the right-most SELECT statement only.
24768cdbf836Sdrh   ** SELECT statements to the left always skip this part.  The right-most
24778cdbf836Sdrh   ** SELECT might also skip this part if it has no ORDER BY clause and
24788cdbf836Sdrh   ** no temp tables are required.
2479fbc4ee7bSdrh   */
24807d10d5a6Sdrh   if( p->selFlags & SF_UsesEphemeral ){
2481fbc4ee7bSdrh     int i;                        /* Loop counter */
2482fbc4ee7bSdrh     KeyInfo *pKeyInfo;            /* Collating sequence for the result set */
24830342b1f5Sdrh     Select *pLoop;                /* For looping through SELECT statements */
2484f68d7d17Sdrh     CollSeq **apColl;             /* For looping through pKeyInfo->aColl[] */
248593a960a0Sdrh     int nCol;                     /* Number of columns in result set */
2486fbc4ee7bSdrh 
2487d227a291Sdrh     assert( p->pNext==0 );
248893a960a0Sdrh     nCol = p->pEList->nExpr;
2489ad124329Sdrh     pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
2490dc1bdc4fSdanielk1977     if( !pKeyInfo ){
2491dc1bdc4fSdanielk1977       rc = SQLITE_NOMEM;
2492dc1bdc4fSdanielk1977       goto multi_select_end;
2493dc1bdc4fSdanielk1977     }
24940342b1f5Sdrh     for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
24950342b1f5Sdrh       *apColl = multiSelectCollSeq(pParse, p, i);
24960342b1f5Sdrh       if( 0==*apColl ){
2497633e6d57Sdrh         *apColl = db->pDfltColl;
2498dc1bdc4fSdanielk1977       }
2499dc1bdc4fSdanielk1977     }
2500dc1bdc4fSdanielk1977 
25010342b1f5Sdrh     for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
25020342b1f5Sdrh       for(i=0; i<2; i++){
2503b9bb7c18Sdrh         int addr = pLoop->addrOpenEphm[i];
25040342b1f5Sdrh         if( addr<0 ){
25050342b1f5Sdrh           /* If [0] is unused then [1] is also unused.  So we can
25060342b1f5Sdrh           ** always safely abort as soon as the first unused slot is found */
2507b9bb7c18Sdrh           assert( pLoop->addrOpenEphm[1]<0 );
25080342b1f5Sdrh           break;
25090342b1f5Sdrh         }
25100342b1f5Sdrh         sqlite3VdbeChangeP2(v, addr, nCol);
25112ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
25122ec2fb22Sdrh                             P4_KEYINFO);
25130ee5a1e7Sdrh         pLoop->addrOpenEphm[i] = -1;
25140342b1f5Sdrh       }
2515dc1bdc4fSdanielk1977     }
25162ec2fb22Sdrh     sqlite3KeyInfoUnref(pKeyInfo);
2517dc1bdc4fSdanielk1977   }
2518dc1bdc4fSdanielk1977 
2519dc1bdc4fSdanielk1977 multi_select_end:
25202b596da8Sdrh   pDest->iSdst = dest.iSdst;
25212b596da8Sdrh   pDest->nSdst = dest.nSdst;
2522633e6d57Sdrh   sqlite3SelectDelete(db, pDelete);
252384ac9d02Sdanielk1977   return rc;
25242282792aSdrh }
2525b7f9164eSdrh #endif /* SQLITE_OMIT_COMPOUND_SELECT */
25262282792aSdrh 
2527b21e7c70Sdrh /*
2528b21e7c70Sdrh ** Code an output subroutine for a coroutine implementation of a
2529b21e7c70Sdrh ** SELECT statment.
25300acb7e48Sdrh **
25312b596da8Sdrh ** The data to be output is contained in pIn->iSdst.  There are
25322b596da8Sdrh ** pIn->nSdst columns to be output.  pDest is where the output should
25330acb7e48Sdrh ** be sent.
25340acb7e48Sdrh **
25350acb7e48Sdrh ** regReturn is the number of the register holding the subroutine
25360acb7e48Sdrh ** return address.
25370acb7e48Sdrh **
2538f053d5b6Sdrh ** If regPrev>0 then it is the first register in a vector that
25390acb7e48Sdrh ** records the previous output.  mem[regPrev] is a flag that is false
25400acb7e48Sdrh ** if there has been no previous output.  If regPrev>0 then code is
25410acb7e48Sdrh ** generated to suppress duplicates.  pKeyInfo is used for comparing
25420acb7e48Sdrh ** keys.
25430acb7e48Sdrh **
25440acb7e48Sdrh ** If the LIMIT found in p->iLimit is reached, jump immediately to
25450acb7e48Sdrh ** iBreak.
2546b21e7c70Sdrh */
25470acb7e48Sdrh static int generateOutputSubroutine(
254892b01d53Sdrh   Parse *pParse,          /* Parsing context */
254992b01d53Sdrh   Select *p,              /* The SELECT statement */
255092b01d53Sdrh   SelectDest *pIn,        /* Coroutine supplying data */
255192b01d53Sdrh   SelectDest *pDest,      /* Where to send the data */
255292b01d53Sdrh   int regReturn,          /* The return address register */
25530acb7e48Sdrh   int regPrev,            /* Previous result register.  No uniqueness if 0 */
25540acb7e48Sdrh   KeyInfo *pKeyInfo,      /* For comparing with previous entry */
255592b01d53Sdrh   int iBreak              /* Jump here if we hit the LIMIT */
2556b21e7c70Sdrh ){
2557b21e7c70Sdrh   Vdbe *v = pParse->pVdbe;
255892b01d53Sdrh   int iContinue;
255992b01d53Sdrh   int addr;
2560b21e7c70Sdrh 
256192b01d53Sdrh   addr = sqlite3VdbeCurrentAddr(v);
256292b01d53Sdrh   iContinue = sqlite3VdbeMakeLabel(v);
25630acb7e48Sdrh 
25640acb7e48Sdrh   /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
25650acb7e48Sdrh   */
25660acb7e48Sdrh   if( regPrev ){
25670acb7e48Sdrh     int j1, j2;
2568688852abSdrh     j1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
25692b596da8Sdrh     j2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
25702ec2fb22Sdrh                               (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
2571688852abSdrh     sqlite3VdbeAddOp3(v, OP_Jump, j2+2, iContinue, j2+2); VdbeCoverage(v);
25720acb7e48Sdrh     sqlite3VdbeJumpHere(v, j1);
2573e8e4af76Sdrh     sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
2574ec86c724Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
25750acb7e48Sdrh   }
25761f9caa41Sdanielk1977   if( pParse->db->mallocFailed ) return 0;
25770acb7e48Sdrh 
2578d5578433Smistachkin   /* Suppress the first OFFSET entries if there is an OFFSET clause
25790acb7e48Sdrh   */
2580aa9ce707Sdrh   codeOffset(v, p->iOffset, iContinue);
2581b21e7c70Sdrh 
2582b21e7c70Sdrh   switch( pDest->eDest ){
2583b21e7c70Sdrh     /* Store the result as data using a unique key.
2584b21e7c70Sdrh     */
2585b21e7c70Sdrh     case SRT_Table:
2586b21e7c70Sdrh     case SRT_EphemTab: {
2587b21e7c70Sdrh       int r1 = sqlite3GetTempReg(pParse);
2588b21e7c70Sdrh       int r2 = sqlite3GetTempReg(pParse);
2589373cc2ddSdrh       testcase( pDest->eDest==SRT_Table );
2590373cc2ddSdrh       testcase( pDest->eDest==SRT_EphemTab );
25912b596da8Sdrh       sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
25922b596da8Sdrh       sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
25932b596da8Sdrh       sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
2594b21e7c70Sdrh       sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
2595b21e7c70Sdrh       sqlite3ReleaseTempReg(pParse, r2);
2596b21e7c70Sdrh       sqlite3ReleaseTempReg(pParse, r1);
2597b21e7c70Sdrh       break;
2598b21e7c70Sdrh     }
2599b21e7c70Sdrh 
2600b21e7c70Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2601b21e7c70Sdrh     /* If we are creating a set for an "expr IN (SELECT ...)" construct,
2602b21e7c70Sdrh     ** then there should be a single item on the stack.  Write this
2603b21e7c70Sdrh     ** item into the set table with bogus data.
2604b21e7c70Sdrh     */
2605b21e7c70Sdrh     case SRT_Set: {
26066fccc35aSdrh       int r1;
26072b596da8Sdrh       assert( pIn->nSdst==1 );
2608634d81deSdrh       pDest->affSdst =
26092b596da8Sdrh          sqlite3CompareAffinity(p->pEList->a[0].pExpr, pDest->affSdst);
2610b21e7c70Sdrh       r1 = sqlite3GetTempReg(pParse);
2611634d81deSdrh       sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, 1, r1, &pDest->affSdst,1);
26122b596da8Sdrh       sqlite3ExprCacheAffinityChange(pParse, pIn->iSdst, 1);
26132b596da8Sdrh       sqlite3VdbeAddOp2(v, OP_IdxInsert, pDest->iSDParm, r1);
2614b21e7c70Sdrh       sqlite3ReleaseTempReg(pParse, r1);
2615b21e7c70Sdrh       break;
2616b21e7c70Sdrh     }
2617b21e7c70Sdrh 
261885e9e22bSdrh #if 0  /* Never occurs on an ORDER BY query */
2619b21e7c70Sdrh     /* If any row exist in the result set, record that fact and abort.
2620b21e7c70Sdrh     */
2621b21e7c70Sdrh     case SRT_Exists: {
26222b596da8Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, pDest->iSDParm);
2623b21e7c70Sdrh       /* The LIMIT clause will terminate the loop for us */
2624b21e7c70Sdrh       break;
2625b21e7c70Sdrh     }
262685e9e22bSdrh #endif
2627b21e7c70Sdrh 
2628b21e7c70Sdrh     /* If this is a scalar select that is part of an expression, then
2629b21e7c70Sdrh     ** store the results in the appropriate memory cell and break out
2630b21e7c70Sdrh     ** of the scan loop.
2631b21e7c70Sdrh     */
2632b21e7c70Sdrh     case SRT_Mem: {
26332b596da8Sdrh       assert( pIn->nSdst==1 );
26342b596da8Sdrh       sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, 1);
2635b21e7c70Sdrh       /* The LIMIT clause will jump out of the loop for us */
2636b21e7c70Sdrh       break;
2637b21e7c70Sdrh     }
2638b21e7c70Sdrh #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
2639b21e7c70Sdrh 
26407d10d5a6Sdrh     /* The results are stored in a sequence of registers
26412b596da8Sdrh     ** starting at pDest->iSdst.  Then the co-routine yields.
2642b21e7c70Sdrh     */
264392b01d53Sdrh     case SRT_Coroutine: {
26442b596da8Sdrh       if( pDest->iSdst==0 ){
26452b596da8Sdrh         pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
26462b596da8Sdrh         pDest->nSdst = pIn->nSdst;
2647b21e7c70Sdrh       }
26482b596da8Sdrh       sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pDest->nSdst);
26492b596da8Sdrh       sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
265092b01d53Sdrh       break;
265192b01d53Sdrh     }
265292b01d53Sdrh 
2653ccfcbceaSdrh     /* If none of the above, then the result destination must be
2654ccfcbceaSdrh     ** SRT_Output.  This routine is never called with any other
2655ccfcbceaSdrh     ** destination other than the ones handled above or SRT_Output.
2656ccfcbceaSdrh     **
2657ccfcbceaSdrh     ** For SRT_Output, results are stored in a sequence of registers.
2658ccfcbceaSdrh     ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
2659ccfcbceaSdrh     ** return the next row of result.
26607d10d5a6Sdrh     */
2661ccfcbceaSdrh     default: {
2662ccfcbceaSdrh       assert( pDest->eDest==SRT_Output );
26632b596da8Sdrh       sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
26642b596da8Sdrh       sqlite3ExprCacheAffinityChange(pParse, pIn->iSdst, pIn->nSdst);
2665b21e7c70Sdrh       break;
2666b21e7c70Sdrh     }
2667b21e7c70Sdrh   }
266892b01d53Sdrh 
266992b01d53Sdrh   /* Jump to the end of the loop if the LIMIT is reached.
267092b01d53Sdrh   */
267192b01d53Sdrh   if( p->iLimit ){
2672688852abSdrh     sqlite3VdbeAddOp3(v, OP_IfZero, p->iLimit, iBreak, -1); VdbeCoverage(v);
267392b01d53Sdrh   }
267492b01d53Sdrh 
267592b01d53Sdrh   /* Generate the subroutine return
267692b01d53Sdrh   */
26770acb7e48Sdrh   sqlite3VdbeResolveLabel(v, iContinue);
267892b01d53Sdrh   sqlite3VdbeAddOp1(v, OP_Return, regReturn);
267992b01d53Sdrh 
268092b01d53Sdrh   return addr;
2681b21e7c70Sdrh }
2682b21e7c70Sdrh 
2683b21e7c70Sdrh /*
2684b21e7c70Sdrh ** Alternative compound select code generator for cases when there
2685b21e7c70Sdrh ** is an ORDER BY clause.
2686b21e7c70Sdrh **
2687b21e7c70Sdrh ** We assume a query of the following form:
2688b21e7c70Sdrh **
2689b21e7c70Sdrh **      <selectA>  <operator>  <selectB>  ORDER BY <orderbylist>
2690b21e7c70Sdrh **
2691b21e7c70Sdrh ** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT.  The idea
2692b21e7c70Sdrh ** is to code both <selectA> and <selectB> with the ORDER BY clause as
2693b21e7c70Sdrh ** co-routines.  Then run the co-routines in parallel and merge the results
2694b21e7c70Sdrh ** into the output.  In addition to the two coroutines (called selectA and
2695b21e7c70Sdrh ** selectB) there are 7 subroutines:
2696b21e7c70Sdrh **
2697b21e7c70Sdrh **    outA:    Move the output of the selectA coroutine into the output
2698b21e7c70Sdrh **             of the compound query.
2699b21e7c70Sdrh **
2700b21e7c70Sdrh **    outB:    Move the output of the selectB coroutine into the output
2701b21e7c70Sdrh **             of the compound query.  (Only generated for UNION and
2702b21e7c70Sdrh **             UNION ALL.  EXCEPT and INSERTSECT never output a row that
2703b21e7c70Sdrh **             appears only in B.)
2704b21e7c70Sdrh **
2705b21e7c70Sdrh **    AltB:    Called when there is data from both coroutines and A<B.
2706b21e7c70Sdrh **
2707b21e7c70Sdrh **    AeqB:    Called when there is data from both coroutines and A==B.
2708b21e7c70Sdrh **
2709b21e7c70Sdrh **    AgtB:    Called when there is data from both coroutines and A>B.
2710b21e7c70Sdrh **
2711b21e7c70Sdrh **    EofA:    Called when data is exhausted from selectA.
2712b21e7c70Sdrh **
2713b21e7c70Sdrh **    EofB:    Called when data is exhausted from selectB.
2714b21e7c70Sdrh **
2715b21e7c70Sdrh ** The implementation of the latter five subroutines depend on which
2716b21e7c70Sdrh ** <operator> is used:
2717b21e7c70Sdrh **
2718b21e7c70Sdrh **
2719b21e7c70Sdrh **             UNION ALL         UNION            EXCEPT          INTERSECT
2720b21e7c70Sdrh **          -------------  -----------------  --------------  -----------------
2721b21e7c70Sdrh **   AltB:   outA, nextA      outA, nextA       outA, nextA         nextA
2722b21e7c70Sdrh **
27230acb7e48Sdrh **   AeqB:   outA, nextA         nextA             nextA         outA, nextA
2724b21e7c70Sdrh **
2725b21e7c70Sdrh **   AgtB:   outB, nextB      outB, nextB          nextB            nextB
2726b21e7c70Sdrh **
27270acb7e48Sdrh **   EofA:   outB, nextB      outB, nextB          halt             halt
2728b21e7c70Sdrh **
27290acb7e48Sdrh **   EofB:   outA, nextA      outA, nextA       outA, nextA         halt
27300acb7e48Sdrh **
27310acb7e48Sdrh ** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
27320acb7e48Sdrh ** causes an immediate jump to EofA and an EOF on B following nextB causes
27330acb7e48Sdrh ** an immediate jump to EofB.  Within EofA and EofB, and EOF on entry or
27340acb7e48Sdrh ** following nextX causes a jump to the end of the select processing.
27350acb7e48Sdrh **
27360acb7e48Sdrh ** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
27370acb7e48Sdrh ** within the output subroutine.  The regPrev register set holds the previously
27380acb7e48Sdrh ** output value.  A comparison is made against this value and the output
27390acb7e48Sdrh ** is skipped if the next results would be the same as the previous.
2740b21e7c70Sdrh **
2741b21e7c70Sdrh ** The implementation plan is to implement the two coroutines and seven
2742b21e7c70Sdrh ** subroutines first, then put the control logic at the bottom.  Like this:
2743b21e7c70Sdrh **
2744b21e7c70Sdrh **          goto Init
2745b21e7c70Sdrh **     coA: coroutine for left query (A)
2746b21e7c70Sdrh **     coB: coroutine for right query (B)
2747b21e7c70Sdrh **    outA: output one row of A
2748b21e7c70Sdrh **    outB: output one row of B (UNION and UNION ALL only)
2749b21e7c70Sdrh **    EofA: ...
2750b21e7c70Sdrh **    EofB: ...
2751b21e7c70Sdrh **    AltB: ...
2752b21e7c70Sdrh **    AeqB: ...
2753b21e7c70Sdrh **    AgtB: ...
2754b21e7c70Sdrh **    Init: initialize coroutine registers
2755b21e7c70Sdrh **          yield coA
2756b21e7c70Sdrh **          if eof(A) goto EofA
2757b21e7c70Sdrh **          yield coB
2758b21e7c70Sdrh **          if eof(B) goto EofB
2759b21e7c70Sdrh **    Cmpr: Compare A, B
2760b21e7c70Sdrh **          Jump AltB, AeqB, AgtB
2761b21e7c70Sdrh **     End: ...
2762b21e7c70Sdrh **
2763b21e7c70Sdrh ** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
2764b21e7c70Sdrh ** actually called using Gosub and they do not Return.  EofA and EofB loop
2765b21e7c70Sdrh ** until all data is exhausted then jump to the "end" labe.  AltB, AeqB,
2766b21e7c70Sdrh ** and AgtB jump to either L2 or to one of EofA or EofB.
2767b21e7c70Sdrh */
2768de3e41e3Sdanielk1977 #ifndef SQLITE_OMIT_COMPOUND_SELECT
2769b21e7c70Sdrh static int multiSelectOrderBy(
2770b21e7c70Sdrh   Parse *pParse,        /* Parsing context */
2771b21e7c70Sdrh   Select *p,            /* The right-most of SELECTs to be coded */
2772a9671a22Sdrh   SelectDest *pDest     /* What to do with query results */
2773b21e7c70Sdrh ){
27740acb7e48Sdrh   int i, j;             /* Loop counters */
2775b21e7c70Sdrh   Select *pPrior;       /* Another SELECT immediately to our left */
2776b21e7c70Sdrh   Vdbe *v;              /* Generate code to this VDBE */
2777b21e7c70Sdrh   SelectDest destA;     /* Destination for coroutine A */
2778b21e7c70Sdrh   SelectDest destB;     /* Destination for coroutine B */
277992b01d53Sdrh   int regAddrA;         /* Address register for select-A coroutine */
278092b01d53Sdrh   int regAddrB;         /* Address register for select-B coroutine */
278192b01d53Sdrh   int addrSelectA;      /* Address of the select-A coroutine */
278292b01d53Sdrh   int addrSelectB;      /* Address of the select-B coroutine */
278392b01d53Sdrh   int regOutA;          /* Address register for the output-A subroutine */
278492b01d53Sdrh   int regOutB;          /* Address register for the output-B subroutine */
278592b01d53Sdrh   int addrOutA;         /* Address of the output-A subroutine */
2786b27b7f5dSdrh   int addrOutB = 0;     /* Address of the output-B subroutine */
278792b01d53Sdrh   int addrEofA;         /* Address of the select-A-exhausted subroutine */
278881cf13ecSdrh   int addrEofA_noB;     /* Alternate addrEofA if B is uninitialized */
278992b01d53Sdrh   int addrEofB;         /* Address of the select-B-exhausted subroutine */
279092b01d53Sdrh   int addrAltB;         /* Address of the A<B subroutine */
279192b01d53Sdrh   int addrAeqB;         /* Address of the A==B subroutine */
279292b01d53Sdrh   int addrAgtB;         /* Address of the A>B subroutine */
279392b01d53Sdrh   int regLimitA;        /* Limit register for select-A */
279492b01d53Sdrh   int regLimitB;        /* Limit register for select-A */
27950acb7e48Sdrh   int regPrev;          /* A range of registers to hold previous output */
279692b01d53Sdrh   int savedLimit;       /* Saved value of p->iLimit */
279792b01d53Sdrh   int savedOffset;      /* Saved value of p->iOffset */
279892b01d53Sdrh   int labelCmpr;        /* Label for the start of the merge algorithm */
279992b01d53Sdrh   int labelEnd;         /* Label for the end of the overall SELECT stmt */
28000acb7e48Sdrh   int j1;               /* Jump instructions that get retargetted */
280192b01d53Sdrh   int op;               /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
280296067816Sdrh   KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
28030acb7e48Sdrh   KeyInfo *pKeyMerge;   /* Comparison information for merging rows */
28040acb7e48Sdrh   sqlite3 *db;          /* Database connection */
28050acb7e48Sdrh   ExprList *pOrderBy;   /* The ORDER BY clause */
28060acb7e48Sdrh   int nOrderBy;         /* Number of terms in the ORDER BY clause */
28070acb7e48Sdrh   int *aPermute;        /* Mapping from ORDER BY terms to result set columns */
28087f61e92cSdan #ifndef SQLITE_OMIT_EXPLAIN
28097f61e92cSdan   int iSub1;            /* EQP id of left-hand query */
28107f61e92cSdan   int iSub2;            /* EQP id of right-hand query */
28117f61e92cSdan #endif
2812b21e7c70Sdrh 
281392b01d53Sdrh   assert( p->pOrderBy!=0 );
281496067816Sdrh   assert( pKeyDup==0 ); /* "Managed" code needs this.  Ticket #3382. */
28150acb7e48Sdrh   db = pParse->db;
281692b01d53Sdrh   v = pParse->pVdbe;
2817ccfcbceaSdrh   assert( v!=0 );       /* Already thrown the error if VDBE alloc failed */
281892b01d53Sdrh   labelEnd = sqlite3VdbeMakeLabel(v);
281992b01d53Sdrh   labelCmpr = sqlite3VdbeMakeLabel(v);
28200acb7e48Sdrh 
2821b21e7c70Sdrh 
282292b01d53Sdrh   /* Patch up the ORDER BY clause
282392b01d53Sdrh   */
282492b01d53Sdrh   op = p->op;
2825b21e7c70Sdrh   pPrior = p->pPrior;
282692b01d53Sdrh   assert( pPrior->pOrderBy==0 );
28270acb7e48Sdrh   pOrderBy = p->pOrderBy;
282893a960a0Sdrh   assert( pOrderBy );
28290acb7e48Sdrh   nOrderBy = pOrderBy->nExpr;
283093a960a0Sdrh 
28310acb7e48Sdrh   /* For operators other than UNION ALL we have to make sure that
28320acb7e48Sdrh   ** the ORDER BY clause covers every term of the result set.  Add
28330acb7e48Sdrh   ** terms to the ORDER BY clause as necessary.
28340acb7e48Sdrh   */
28350acb7e48Sdrh   if( op!=TK_ALL ){
28360acb7e48Sdrh     for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
28377d10d5a6Sdrh       struct ExprList_item *pItem;
28387d10d5a6Sdrh       for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
2839c2acc4e4Sdrh         assert( pItem->u.x.iOrderByCol>0 );
2840c2acc4e4Sdrh         if( pItem->u.x.iOrderByCol==i ) break;
28410acb7e48Sdrh       }
28420acb7e48Sdrh       if( j==nOrderBy ){
2843b7916a78Sdrh         Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
28440acb7e48Sdrh         if( pNew==0 ) return SQLITE_NOMEM;
28450acb7e48Sdrh         pNew->flags |= EP_IntValue;
284633e619fcSdrh         pNew->u.iValue = i;
2847b7916a78Sdrh         pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
2848c2acc4e4Sdrh         if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
28490acb7e48Sdrh       }
28500acb7e48Sdrh     }
28510acb7e48Sdrh   }
28520acb7e48Sdrh 
28530acb7e48Sdrh   /* Compute the comparison permutation and keyinfo that is used with
285410c081adSdrh   ** the permutation used to determine if the next
28550acb7e48Sdrh   ** row of results comes from selectA or selectB.  Also add explicit
28560acb7e48Sdrh   ** collations to the ORDER BY clause terms so that when the subqueries
28570acb7e48Sdrh   ** to the right and the left are evaluated, they use the correct
28580acb7e48Sdrh   ** collation.
28590acb7e48Sdrh   */
28600acb7e48Sdrh   aPermute = sqlite3DbMallocRaw(db, sizeof(int)*nOrderBy);
28610acb7e48Sdrh   if( aPermute ){
28627d10d5a6Sdrh     struct ExprList_item *pItem;
28637d10d5a6Sdrh     for(i=0, pItem=pOrderBy->a; i<nOrderBy; i++, pItem++){
2864c2acc4e4Sdrh       assert( pItem->u.x.iOrderByCol>0
2865c2acc4e4Sdrh           && pItem->u.x.iOrderByCol<=p->pEList->nExpr );
2866c2acc4e4Sdrh       aPermute[i] = pItem->u.x.iOrderByCol - 1;
28670acb7e48Sdrh     }
286853bed45eSdan     pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
28690acb7e48Sdrh   }else{
28700acb7e48Sdrh     pKeyMerge = 0;
28710acb7e48Sdrh   }
28720acb7e48Sdrh 
28730acb7e48Sdrh   /* Reattach the ORDER BY clause to the query.
28740acb7e48Sdrh   */
28750acb7e48Sdrh   p->pOrderBy = pOrderBy;
28766ab3a2ecSdanielk1977   pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
28770acb7e48Sdrh 
28780acb7e48Sdrh   /* Allocate a range of temporary registers and the KeyInfo needed
28790acb7e48Sdrh   ** for the logic that removes duplicate result rows when the
28800acb7e48Sdrh   ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
28810acb7e48Sdrh   */
28820acb7e48Sdrh   if( op==TK_ALL ){
28830acb7e48Sdrh     regPrev = 0;
28840acb7e48Sdrh   }else{
28850acb7e48Sdrh     int nExpr = p->pEList->nExpr;
28861c0dc825Sdrh     assert( nOrderBy>=nExpr || db->mallocFailed );
2887c8ac0d16Sdrh     regPrev = pParse->nMem+1;
2888c8ac0d16Sdrh     pParse->nMem += nExpr+1;
28890acb7e48Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
2890ad124329Sdrh     pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
28910acb7e48Sdrh     if( pKeyDup ){
28922ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
28930acb7e48Sdrh       for(i=0; i<nExpr; i++){
28940acb7e48Sdrh         pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
28950acb7e48Sdrh         pKeyDup->aSortOrder[i] = 0;
28960acb7e48Sdrh       }
28970acb7e48Sdrh     }
28980acb7e48Sdrh   }
289992b01d53Sdrh 
290092b01d53Sdrh   /* Separate the left and the right query from one another
290192b01d53Sdrh   */
290292b01d53Sdrh   p->pPrior = 0;
2903d227a291Sdrh   pPrior->pNext = 0;
29047d10d5a6Sdrh   sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
29050acb7e48Sdrh   if( pPrior->pPrior==0 ){
29067d10d5a6Sdrh     sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
29070acb7e48Sdrh   }
290892b01d53Sdrh 
290992b01d53Sdrh   /* Compute the limit registers */
291092b01d53Sdrh   computeLimitRegisters(pParse, p, labelEnd);
29110acb7e48Sdrh   if( p->iLimit && op==TK_ALL ){
291292b01d53Sdrh     regLimitA = ++pParse->nMem;
291392b01d53Sdrh     regLimitB = ++pParse->nMem;
291492b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
291592b01d53Sdrh                                   regLimitA);
291692b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
291792b01d53Sdrh   }else{
291892b01d53Sdrh     regLimitA = regLimitB = 0;
291992b01d53Sdrh   }
2920633e6d57Sdrh   sqlite3ExprDelete(db, p->pLimit);
29210acb7e48Sdrh   p->pLimit = 0;
2922633e6d57Sdrh   sqlite3ExprDelete(db, p->pOffset);
29230acb7e48Sdrh   p->pOffset = 0;
292492b01d53Sdrh 
2925b21e7c70Sdrh   regAddrA = ++pParse->nMem;
2926b21e7c70Sdrh   regAddrB = ++pParse->nMem;
2927b21e7c70Sdrh   regOutA = ++pParse->nMem;
2928b21e7c70Sdrh   regOutB = ++pParse->nMem;
2929b21e7c70Sdrh   sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
2930b21e7c70Sdrh   sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
2931b21e7c70Sdrh 
293292b01d53Sdrh   /* Generate a coroutine to evaluate the SELECT statement to the
29330acb7e48Sdrh   ** left of the compound operator - the "A" select.
29340acb7e48Sdrh   */
2935ed71a839Sdrh   addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
2936ed71a839Sdrh   j1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
2937ed71a839Sdrh   VdbeComment((v, "left SELECT"));
293892b01d53Sdrh   pPrior->iLimit = regLimitA;
29397f61e92cSdan   explainSetInteger(iSub1, pParse->iNextSelectId);
29407d10d5a6Sdrh   sqlite3Select(pParse, pPrior, &destA);
294181cf13ecSdrh   sqlite3VdbeAddOp1(v, OP_EndCoroutine, regAddrA);
2942ed71a839Sdrh   sqlite3VdbeJumpHere(v, j1);
2943b21e7c70Sdrh 
294492b01d53Sdrh   /* Generate a coroutine to evaluate the SELECT statement on
294592b01d53Sdrh   ** the right - the "B" select
294692b01d53Sdrh   */
2947ed71a839Sdrh   addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
2948ed71a839Sdrh   j1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
2949ed71a839Sdrh   VdbeComment((v, "right SELECT"));
295092b01d53Sdrh   savedLimit = p->iLimit;
295192b01d53Sdrh   savedOffset = p->iOffset;
295292b01d53Sdrh   p->iLimit = regLimitB;
295392b01d53Sdrh   p->iOffset = 0;
29547f61e92cSdan   explainSetInteger(iSub2, pParse->iNextSelectId);
29557d10d5a6Sdrh   sqlite3Select(pParse, p, &destB);
295692b01d53Sdrh   p->iLimit = savedLimit;
295792b01d53Sdrh   p->iOffset = savedOffset;
295881cf13ecSdrh   sqlite3VdbeAddOp1(v, OP_EndCoroutine, regAddrB);
2959b21e7c70Sdrh 
296092b01d53Sdrh   /* Generate a subroutine that outputs the current row of the A
29610acb7e48Sdrh   ** select as the next output row of the compound select.
296292b01d53Sdrh   */
2963b21e7c70Sdrh   VdbeNoopComment((v, "Output routine for A"));
29640acb7e48Sdrh   addrOutA = generateOutputSubroutine(pParse,
29650acb7e48Sdrh                  p, &destA, pDest, regOutA,
29662ec2fb22Sdrh                  regPrev, pKeyDup, labelEnd);
2967b21e7c70Sdrh 
296892b01d53Sdrh   /* Generate a subroutine that outputs the current row of the B
29690acb7e48Sdrh   ** select as the next output row of the compound select.
297092b01d53Sdrh   */
29710acb7e48Sdrh   if( op==TK_ALL || op==TK_UNION ){
2972b21e7c70Sdrh     VdbeNoopComment((v, "Output routine for B"));
29730acb7e48Sdrh     addrOutB = generateOutputSubroutine(pParse,
29740acb7e48Sdrh                  p, &destB, pDest, regOutB,
29752ec2fb22Sdrh                  regPrev, pKeyDup, labelEnd);
29760acb7e48Sdrh   }
29772ec2fb22Sdrh   sqlite3KeyInfoUnref(pKeyDup);
2978b21e7c70Sdrh 
297992b01d53Sdrh   /* Generate a subroutine to run when the results from select A
298092b01d53Sdrh   ** are exhausted and only data in select B remains.
298192b01d53Sdrh   */
298292b01d53Sdrh   if( op==TK_EXCEPT || op==TK_INTERSECT ){
298381cf13ecSdrh     addrEofA_noB = addrEofA = labelEnd;
298492b01d53Sdrh   }else{
298581cf13ecSdrh     VdbeNoopComment((v, "eof-A subroutine"));
298681cf13ecSdrh     addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
298781cf13ecSdrh     addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
2988688852abSdrh                                      VdbeCoverage(v);
29890acb7e48Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, addrEofA);
299095aa47b1Sdrh     p->nSelectRow += pPrior->nSelectRow;
2991b21e7c70Sdrh   }
2992b21e7c70Sdrh 
299392b01d53Sdrh   /* Generate a subroutine to run when the results from select B
299492b01d53Sdrh   ** are exhausted and only data in select A remains.
299592b01d53Sdrh   */
2996b21e7c70Sdrh   if( op==TK_INTERSECT ){
299792b01d53Sdrh     addrEofB = addrEofA;
299895aa47b1Sdrh     if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
2999b21e7c70Sdrh   }else{
300092b01d53Sdrh     VdbeNoopComment((v, "eof-B subroutine"));
300181cf13ecSdrh     addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
3002688852abSdrh     sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
30030acb7e48Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, addrEofB);
3004b21e7c70Sdrh   }
3005b21e7c70Sdrh 
300692b01d53Sdrh   /* Generate code to handle the case of A<B
300792b01d53Sdrh   */
3008b21e7c70Sdrh   VdbeNoopComment((v, "A-lt-B subroutine"));
30090acb7e48Sdrh   addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
3010688852abSdrh   sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
301192b01d53Sdrh   sqlite3VdbeAddOp2(v, OP_Goto, 0, labelCmpr);
3012b21e7c70Sdrh 
301392b01d53Sdrh   /* Generate code to handle the case of A==B
301492b01d53Sdrh   */
3015b21e7c70Sdrh   if( op==TK_ALL ){
3016b21e7c70Sdrh     addrAeqB = addrAltB;
30170acb7e48Sdrh   }else if( op==TK_INTERSECT ){
30180acb7e48Sdrh     addrAeqB = addrAltB;
30190acb7e48Sdrh     addrAltB++;
302092b01d53Sdrh   }else{
3021b21e7c70Sdrh     VdbeNoopComment((v, "A-eq-B subroutine"));
30220acb7e48Sdrh     addrAeqB =
3023688852abSdrh     sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
302492b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, labelCmpr);
302592b01d53Sdrh   }
3026b21e7c70Sdrh 
302792b01d53Sdrh   /* Generate code to handle the case of A>B
302892b01d53Sdrh   */
3029b21e7c70Sdrh   VdbeNoopComment((v, "A-gt-B subroutine"));
3030b21e7c70Sdrh   addrAgtB = sqlite3VdbeCurrentAddr(v);
3031b21e7c70Sdrh   if( op==TK_ALL || op==TK_UNION ){
3032b21e7c70Sdrh     sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
303392b01d53Sdrh   }
3034688852abSdrh   sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
303592b01d53Sdrh   sqlite3VdbeAddOp2(v, OP_Goto, 0, labelCmpr);
3036b21e7c70Sdrh 
303792b01d53Sdrh   /* This code runs once to initialize everything.
303892b01d53Sdrh   */
3039b21e7c70Sdrh   sqlite3VdbeJumpHere(v, j1);
3040688852abSdrh   sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
3041688852abSdrh   sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
304292b01d53Sdrh 
304392b01d53Sdrh   /* Implement the main merge loop
304492b01d53Sdrh   */
304592b01d53Sdrh   sqlite3VdbeResolveLabel(v, labelCmpr);
30460acb7e48Sdrh   sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
30472b596da8Sdrh   sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
30482ec2fb22Sdrh                          (char*)pKeyMerge, P4_KEYINFO);
3049953f7611Sdrh   sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
3050688852abSdrh   sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
305192b01d53Sdrh 
305292b01d53Sdrh   /* Jump to the this point in order to terminate the query.
305392b01d53Sdrh   */
3054b21e7c70Sdrh   sqlite3VdbeResolveLabel(v, labelEnd);
3055b21e7c70Sdrh 
305692b01d53Sdrh   /* Set the number of output columns
305792b01d53Sdrh   */
30587d10d5a6Sdrh   if( pDest->eDest==SRT_Output ){
30590acb7e48Sdrh     Select *pFirst = pPrior;
306092b01d53Sdrh     while( pFirst->pPrior ) pFirst = pFirst->pPrior;
306192b01d53Sdrh     generateColumnNames(pParse, 0, pFirst->pEList);
3062b21e7c70Sdrh   }
306392b01d53Sdrh 
30640acb7e48Sdrh   /* Reassembly the compound query so that it will be freed correctly
30650acb7e48Sdrh   ** by the calling function */
30665e7ad508Sdanielk1977   if( p->pPrior ){
3067633e6d57Sdrh     sqlite3SelectDelete(db, p->pPrior);
30685e7ad508Sdanielk1977   }
30690acb7e48Sdrh   p->pPrior = pPrior;
3070d227a291Sdrh   pPrior->pNext = p;
307192b01d53Sdrh 
307292b01d53Sdrh   /*** TBD:  Insert subroutine calls to close cursors on incomplete
307392b01d53Sdrh   **** subqueries ****/
30747f61e92cSdan   explainComposite(pParse, p->op, iSub1, iSub2, 0);
307592b01d53Sdrh   return SQLITE_OK;
307692b01d53Sdrh }
3077de3e41e3Sdanielk1977 #endif
3078b21e7c70Sdrh 
30793514b6f7Sshane #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
308017435752Sdrh /* Forward Declarations */
308117435752Sdrh static void substExprList(sqlite3*, ExprList*, int, ExprList*);
308217435752Sdrh static void substSelect(sqlite3*, Select *, int, ExprList *);
308317435752Sdrh 
30842282792aSdrh /*
3085832508b7Sdrh ** Scan through the expression pExpr.  Replace every reference to
30866a3ea0e6Sdrh ** a column in table number iTable with a copy of the iColumn-th
308784e59207Sdrh ** entry in pEList.  (But leave references to the ROWID column
30886a3ea0e6Sdrh ** unchanged.)
3089832508b7Sdrh **
3090832508b7Sdrh ** This routine is part of the flattening procedure.  A subquery
3091832508b7Sdrh ** whose result set is defined by pEList appears as entry in the
3092832508b7Sdrh ** FROM clause of a SELECT such that the VDBE cursor assigned to that
3093832508b7Sdrh ** FORM clause entry is iTable.  This routine make the necessary
3094832508b7Sdrh ** changes to pExpr so that it refers directly to the source table
3095832508b7Sdrh ** of the subquery rather the result set of the subquery.
3096832508b7Sdrh */
3097b7916a78Sdrh static Expr *substExpr(
309817435752Sdrh   sqlite3 *db,        /* Report malloc errors to this connection */
309917435752Sdrh   Expr *pExpr,        /* Expr in which substitution occurs */
310017435752Sdrh   int iTable,         /* Table to be substituted */
310117435752Sdrh   ExprList *pEList    /* Substitute expressions */
310217435752Sdrh ){
3103b7916a78Sdrh   if( pExpr==0 ) return 0;
310450350a15Sdrh   if( pExpr->op==TK_COLUMN && pExpr->iTable==iTable ){
310550350a15Sdrh     if( pExpr->iColumn<0 ){
310650350a15Sdrh       pExpr->op = TK_NULL;
310750350a15Sdrh     }else{
3108832508b7Sdrh       Expr *pNew;
310984e59207Sdrh       assert( pEList!=0 && pExpr->iColumn<pEList->nExpr );
31106ab3a2ecSdanielk1977       assert( pExpr->pLeft==0 && pExpr->pRight==0 );
3111b7916a78Sdrh       pNew = sqlite3ExprDup(db, pEList->a[pExpr->iColumn].pExpr, 0);
3112b7916a78Sdrh       sqlite3ExprDelete(db, pExpr);
3113b7916a78Sdrh       pExpr = pNew;
311450350a15Sdrh     }
3115832508b7Sdrh   }else{
3116b7916a78Sdrh     pExpr->pLeft = substExpr(db, pExpr->pLeft, iTable, pEList);
3117b7916a78Sdrh     pExpr->pRight = substExpr(db, pExpr->pRight, iTable, pEList);
31186ab3a2ecSdanielk1977     if( ExprHasProperty(pExpr, EP_xIsSelect) ){
31196ab3a2ecSdanielk1977       substSelect(db, pExpr->x.pSelect, iTable, pEList);
31206ab3a2ecSdanielk1977     }else{
31216ab3a2ecSdanielk1977       substExprList(db, pExpr->x.pList, iTable, pEList);
31226ab3a2ecSdanielk1977     }
3123832508b7Sdrh   }
3124b7916a78Sdrh   return pExpr;
3125832508b7Sdrh }
312617435752Sdrh static void substExprList(
312717435752Sdrh   sqlite3 *db,         /* Report malloc errors here */
312817435752Sdrh   ExprList *pList,     /* List to scan and in which to make substitutes */
312917435752Sdrh   int iTable,          /* Table to be substituted */
313017435752Sdrh   ExprList *pEList     /* Substitute values */
313117435752Sdrh ){
3132832508b7Sdrh   int i;
3133832508b7Sdrh   if( pList==0 ) return;
3134832508b7Sdrh   for(i=0; i<pList->nExpr; i++){
3135b7916a78Sdrh     pList->a[i].pExpr = substExpr(db, pList->a[i].pExpr, iTable, pEList);
3136832508b7Sdrh   }
3137832508b7Sdrh }
313817435752Sdrh static void substSelect(
313917435752Sdrh   sqlite3 *db,         /* Report malloc errors here */
314017435752Sdrh   Select *p,           /* SELECT statement in which to make substitutions */
314117435752Sdrh   int iTable,          /* Table to be replaced */
314217435752Sdrh   ExprList *pEList     /* Substitute values */
314317435752Sdrh ){
3144588a9a1aSdrh   SrcList *pSrc;
3145588a9a1aSdrh   struct SrcList_item *pItem;
3146588a9a1aSdrh   int i;
3147b3bce662Sdanielk1977   if( !p ) return;
314817435752Sdrh   substExprList(db, p->pEList, iTable, pEList);
314917435752Sdrh   substExprList(db, p->pGroupBy, iTable, pEList);
315017435752Sdrh   substExprList(db, p->pOrderBy, iTable, pEList);
3151b7916a78Sdrh   p->pHaving = substExpr(db, p->pHaving, iTable, pEList);
3152b7916a78Sdrh   p->pWhere = substExpr(db, p->pWhere, iTable, pEList);
315317435752Sdrh   substSelect(db, p->pPrior, iTable, pEList);
3154588a9a1aSdrh   pSrc = p->pSrc;
3155e2f02bacSdrh   assert( pSrc );  /* Even for (SELECT 1) we have: pSrc!=0 but pSrc->nSrc==0 */
3156e2f02bacSdrh   if( ALWAYS(pSrc) ){
3157588a9a1aSdrh     for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
3158588a9a1aSdrh       substSelect(db, pItem->pSelect, iTable, pEList);
3159588a9a1aSdrh     }
3160588a9a1aSdrh   }
3161b3bce662Sdanielk1977 }
31623514b6f7Sshane #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3163832508b7Sdrh 
31643514b6f7Sshane #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3165832508b7Sdrh /*
3166630d296cSdrh ** This routine attempts to flatten subqueries as a performance optimization.
3167630d296cSdrh ** This routine returns 1 if it makes changes and 0 if no flattening occurs.
31681350b030Sdrh **
31691350b030Sdrh ** To understand the concept of flattening, consider the following
31701350b030Sdrh ** query:
31711350b030Sdrh **
31721350b030Sdrh **     SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
31731350b030Sdrh **
31741350b030Sdrh ** The default way of implementing this query is to execute the
31751350b030Sdrh ** subquery first and store the results in a temporary table, then
31761350b030Sdrh ** run the outer query on that temporary table.  This requires two
31771350b030Sdrh ** passes over the data.  Furthermore, because the temporary table
31781350b030Sdrh ** has no indices, the WHERE clause on the outer query cannot be
3179832508b7Sdrh ** optimized.
31801350b030Sdrh **
3181832508b7Sdrh ** This routine attempts to rewrite queries such as the above into
31821350b030Sdrh ** a single flat select, like this:
31831350b030Sdrh **
31841350b030Sdrh **     SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
31851350b030Sdrh **
318660ec914cSpeter.d.reid ** The code generated for this simplification gives the same result
3187832508b7Sdrh ** but only has to scan the data once.  And because indices might
3188832508b7Sdrh ** exist on the table t1, a complete scan of the data might be
3189832508b7Sdrh ** avoided.
31901350b030Sdrh **
3191832508b7Sdrh ** Flattening is only attempted if all of the following are true:
31921350b030Sdrh **
3193832508b7Sdrh **   (1)  The subquery and the outer query do not both use aggregates.
31941350b030Sdrh **
3195832508b7Sdrh **   (2)  The subquery is not an aggregate or the outer query is not a join.
3196832508b7Sdrh **
31972b300d5dSdrh **   (3)  The subquery is not the right operand of a left outer join
319849ad330dSdan **        (Originally ticket #306.  Strengthened by ticket #3300)
3199832508b7Sdrh **
320049ad330dSdan **   (4)  The subquery is not DISTINCT.
3201832508b7Sdrh **
320249ad330dSdan **  (**)  At one point restrictions (4) and (5) defined a subset of DISTINCT
320349ad330dSdan **        sub-queries that were excluded from this optimization. Restriction
320449ad330dSdan **        (4) has since been expanded to exclude all DISTINCT subqueries.
3205832508b7Sdrh **
3206832508b7Sdrh **   (6)  The subquery does not use aggregates or the outer query is not
3207832508b7Sdrh **        DISTINCT.
3208832508b7Sdrh **
3209630d296cSdrh **   (7)  The subquery has a FROM clause.  TODO:  For subqueries without
3210630d296cSdrh **        A FROM clause, consider adding a FROM close with the special
3211630d296cSdrh **        table sqlite_once that consists of a single row containing a
3212630d296cSdrh **        single NULL.
321308192d5fSdrh **
3214df199a25Sdrh **   (8)  The subquery does not use LIMIT or the outer query is not a join.
3215df199a25Sdrh **
3216df199a25Sdrh **   (9)  The subquery does not use LIMIT or the outer query does not use
3217df199a25Sdrh **        aggregates.
3218df199a25Sdrh **
32196092d2bcSdrh **  (**)  Restriction (10) was removed from the code on 2005-02-05 but we
32206092d2bcSdrh **        accidently carried the comment forward until 2014-09-15.  Original
32216092d2bcSdrh **        text: "The subquery does not use aggregates or the outer query does not
32226092d2bcSdrh **        use LIMIT."
3223df199a25Sdrh **
3224174b6195Sdrh **  (11)  The subquery and the outer query do not both have ORDER BY clauses.
3225174b6195Sdrh **
32267b688edeSdrh **  (**)  Not implemented.  Subsumed into restriction (3).  Was previously
32272b300d5dSdrh **        a separate restriction deriving from ticket #350.
32283fc673e6Sdrh **
322949ad330dSdan **  (13)  The subquery and outer query do not both use LIMIT.
3230ac83963aSdrh **
323149ad330dSdan **  (14)  The subquery does not use OFFSET.
3232ac83963aSdrh **
3233ad91c6cdSdrh **  (15)  The outer query is not part of a compound select or the
3234f3913278Sdrh **        subquery does not have a LIMIT clause.
3235f3913278Sdrh **        (See ticket #2339 and ticket [02a8e81d44]).
3236ad91c6cdSdrh **
3237c52e355dSdrh **  (16)  The outer query is not an aggregate or the subquery does
3238c52e355dSdrh **        not contain ORDER BY.  (Ticket #2942)  This used to not matter
3239c52e355dSdrh **        until we introduced the group_concat() function.
3240c52e355dSdrh **
3241f23329a2Sdanielk1977 **  (17)  The sub-query is not a compound select, or it is a UNION ALL
32424914cf92Sdanielk1977 **        compound clause made up entirely of non-aggregate queries, and
3243f23329a2Sdanielk1977 **        the parent query:
3244f23329a2Sdanielk1977 **
3245f23329a2Sdanielk1977 **          * is not itself part of a compound select,
3246f23329a2Sdanielk1977 **          * is not an aggregate or DISTINCT query, and
3247630d296cSdrh **          * is not a join
3248f23329a2Sdanielk1977 **
32494914cf92Sdanielk1977 **        The parent and sub-query may contain WHERE clauses. Subject to
32504914cf92Sdanielk1977 **        rules (11), (13) and (14), they may also contain ORDER BY,
3251630d296cSdrh **        LIMIT and OFFSET clauses.  The subquery cannot use any compound
3252630d296cSdrh **        operator other than UNION ALL because all the other compound
3253630d296cSdrh **        operators have an implied DISTINCT which is disallowed by
3254630d296cSdrh **        restriction (4).
3255f23329a2Sdanielk1977 **
325667c70142Sdan **        Also, each component of the sub-query must return the same number
325767c70142Sdan **        of result columns. This is actually a requirement for any compound
325867c70142Sdan **        SELECT statement, but all the code here does is make sure that no
325967c70142Sdan **        such (illegal) sub-query is flattened. The caller will detect the
326067c70142Sdan **        syntax error and return a detailed message.
326167c70142Sdan **
326249fc1f60Sdanielk1977 **  (18)  If the sub-query is a compound select, then all terms of the
326349fc1f60Sdanielk1977 **        ORDER by clause of the parent must be simple references to
326449fc1f60Sdanielk1977 **        columns of the sub-query.
326549fc1f60Sdanielk1977 **
3266229cf702Sdrh **  (19)  The subquery does not use LIMIT or the outer query does not
3267229cf702Sdrh **        have a WHERE clause.
3268229cf702Sdrh **
3269e8902a70Sdrh **  (20)  If the sub-query is a compound select, then it must not use
3270e8902a70Sdrh **        an ORDER BY clause.  Ticket #3773.  We could relax this constraint
3271e8902a70Sdrh **        somewhat by saying that the terms of the ORDER BY clause must
3272630d296cSdrh **        appear as unmodified result columns in the outer query.  But we
3273e8902a70Sdrh **        have other optimizations in mind to deal with that case.
3274e8902a70Sdrh **
3275a91491e5Sshaneh **  (21)  The subquery does not use LIMIT or the outer query is not
3276a91491e5Sshaneh **        DISTINCT.  (See ticket [752e1646fc]).
3277a91491e5Sshaneh **
32788290c2adSdan **  (22)  The subquery is not a recursive CTE.
32798290c2adSdan **
32808290c2adSdan **  (23)  The parent is not a recursive CTE, or the sub-query is not a
32818290c2adSdan **        compound query. This restriction is because transforming the
32828290c2adSdan **        parent to a compound query confuses the code that handles
32838290c2adSdan **        recursive queries in multiSelect().
32848290c2adSdan **
32859588ad95Sdrh **  (24)  The subquery is not an aggregate that uses the built-in min() or
32869588ad95Sdrh **        or max() functions.  (Without this restriction, a query like:
32879588ad95Sdrh **        "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
32889588ad95Sdrh **        return the value X for which Y was maximal.)
32899588ad95Sdrh **
32908290c2adSdan **
3291832508b7Sdrh ** In this routine, the "p" parameter is a pointer to the outer query.
3292832508b7Sdrh ** The subquery is p->pSrc->a[iFrom].  isAgg is true if the outer query
3293832508b7Sdrh ** uses aggregates and subqueryIsAgg is true if the subquery uses aggregates.
3294832508b7Sdrh **
3295665de47aSdrh ** If flattening is not attempted, this routine is a no-op and returns 0.
3296832508b7Sdrh ** If flattening is attempted this routine returns 1.
3297832508b7Sdrh **
3298832508b7Sdrh ** All of the expression analysis must occur on both the outer query and
3299832508b7Sdrh ** the subquery before this routine runs.
33001350b030Sdrh */
33018c74a8caSdrh static int flattenSubquery(
3302524cc21eSdanielk1977   Parse *pParse,       /* Parsing context */
33038c74a8caSdrh   Select *p,           /* The parent or outer SELECT statement */
33048c74a8caSdrh   int iFrom,           /* Index in p->pSrc->a[] of the inner subquery */
33058c74a8caSdrh   int isAgg,           /* True if outer SELECT uses aggregate functions */
33068c74a8caSdrh   int subqueryIsAgg    /* True if the subquery uses aggregate functions */
33078c74a8caSdrh ){
3308524cc21eSdanielk1977   const char *zSavedAuthContext = pParse->zAuthContext;
3309f23329a2Sdanielk1977   Select *pParent;
33100bb28106Sdrh   Select *pSub;       /* The inner query or "subquery" */
3311f23329a2Sdanielk1977   Select *pSub1;      /* Pointer to the rightmost select in sub-query */
3312ad3cab52Sdrh   SrcList *pSrc;      /* The FROM clause of the outer query */
3313ad3cab52Sdrh   SrcList *pSubSrc;   /* The FROM clause of the subquery */
33140bb28106Sdrh   ExprList *pList;    /* The result set of the outer query */
33156a3ea0e6Sdrh   int iParent;        /* VDBE cursor number of the pSub result set temp table */
331691bb0eedSdrh   int i;              /* Loop counter */
331791bb0eedSdrh   Expr *pWhere;                    /* The WHERE clause */
331891bb0eedSdrh   struct SrcList_item *pSubitem;   /* The subquery */
3319524cc21eSdanielk1977   sqlite3 *db = pParse->db;
33201350b030Sdrh 
3321832508b7Sdrh   /* Check to see if flattening is permitted.  Return 0 if not.
3322832508b7Sdrh   */
3323a78c22c4Sdrh   assert( p!=0 );
3324a78c22c4Sdrh   assert( p->pPrior==0 );  /* Unable to flatten compound queries */
33257e5418e4Sdrh   if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
3326832508b7Sdrh   pSrc = p->pSrc;
3327ad3cab52Sdrh   assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
332891bb0eedSdrh   pSubitem = &pSrc->a[iFrom];
332949fc1f60Sdanielk1977   iParent = pSubitem->iCursor;
333091bb0eedSdrh   pSub = pSubitem->pSelect;
3331832508b7Sdrh   assert( pSub!=0 );
3332ac83963aSdrh   if( isAgg && subqueryIsAgg ) return 0;                 /* Restriction (1)  */
3333ac83963aSdrh   if( subqueryIsAgg && pSrc->nSrc>1 ) return 0;          /* Restriction (2)  */
3334832508b7Sdrh   pSubSrc = pSub->pSrc;
3335832508b7Sdrh   assert( pSubSrc );
3336ac83963aSdrh   /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
333760ec914cSpeter.d.reid   ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
3338ac83963aSdrh   ** because they could be computed at compile-time.  But when LIMIT and OFFSET
3339ac83963aSdrh   ** became arbitrary expressions, we were forced to add restrictions (13)
3340ac83963aSdrh   ** and (14). */
3341ac83963aSdrh   if( pSub->pLimit && p->pLimit ) return 0;              /* Restriction (13) */
3342ac83963aSdrh   if( pSub->pOffset ) return 0;                          /* Restriction (14) */
3343d227a291Sdrh   if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
3344ad91c6cdSdrh     return 0;                                            /* Restriction (15) */
3345ad91c6cdSdrh   }
3346ac83963aSdrh   if( pSubSrc->nSrc==0 ) return 0;                       /* Restriction (7)  */
334749ad330dSdan   if( pSub->selFlags & SF_Distinct ) return 0;           /* Restriction (5)  */
334849ad330dSdan   if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
334949ad330dSdan      return 0;         /* Restrictions (8)(9) */
3350df199a25Sdrh   }
33517d10d5a6Sdrh   if( (p->selFlags & SF_Distinct)!=0 && subqueryIsAgg ){
33527d10d5a6Sdrh      return 0;         /* Restriction (6)  */
33537d10d5a6Sdrh   }
33547d10d5a6Sdrh   if( p->pOrderBy && pSub->pOrderBy ){
3355ac83963aSdrh      return 0;                                           /* Restriction (11) */
3356ac83963aSdrh   }
3357c52e355dSdrh   if( isAgg && pSub->pOrderBy ) return 0;                /* Restriction (16) */
3358229cf702Sdrh   if( pSub->pLimit && p->pWhere ) return 0;              /* Restriction (19) */
3359a91491e5Sshaneh   if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
3360a91491e5Sshaneh      return 0;         /* Restriction (21) */
3361a91491e5Sshaneh   }
33629588ad95Sdrh   testcase( pSub->selFlags & SF_Recursive );
33639588ad95Sdrh   testcase( pSub->selFlags & SF_MinMaxAgg );
33649588ad95Sdrh   if( pSub->selFlags & (SF_Recursive|SF_MinMaxAgg) ){
33659588ad95Sdrh     return 0; /* Restrictions (22) and (24) */
33669588ad95Sdrh   }
33679588ad95Sdrh   if( (p->selFlags & SF_Recursive) && pSub->pPrior ){
33689588ad95Sdrh     return 0; /* Restriction (23) */
33699588ad95Sdrh   }
3370832508b7Sdrh 
33712b300d5dSdrh   /* OBSOLETE COMMENT 1:
33722b300d5dSdrh   ** Restriction 3:  If the subquery is a join, make sure the subquery is
33738af4d3acSdrh   ** not used as the right operand of an outer join.  Examples of why this
33748af4d3acSdrh   ** is not allowed:
33758af4d3acSdrh   **
33768af4d3acSdrh   **         t1 LEFT OUTER JOIN (t2 JOIN t3)
33778af4d3acSdrh   **
33788af4d3acSdrh   ** If we flatten the above, we would get
33798af4d3acSdrh   **
33808af4d3acSdrh   **         (t1 LEFT OUTER JOIN t2) JOIN t3
33818af4d3acSdrh   **
33828af4d3acSdrh   ** which is not at all the same thing.
33832b300d5dSdrh   **
33842b300d5dSdrh   ** OBSOLETE COMMENT 2:
33852b300d5dSdrh   ** Restriction 12:  If the subquery is the right operand of a left outer
33863fc673e6Sdrh   ** join, make sure the subquery has no WHERE clause.
33873fc673e6Sdrh   ** An examples of why this is not allowed:
33883fc673e6Sdrh   **
33893fc673e6Sdrh   **         t1 LEFT OUTER JOIN (SELECT * FROM t2 WHERE t2.x>0)
33903fc673e6Sdrh   **
33913fc673e6Sdrh   ** If we flatten the above, we would get
33923fc673e6Sdrh   **
33933fc673e6Sdrh   **         (t1 LEFT OUTER JOIN t2) WHERE t2.x>0
33943fc673e6Sdrh   **
33953fc673e6Sdrh   ** But the t2.x>0 test will always fail on a NULL row of t2, which
33963fc673e6Sdrh   ** effectively converts the OUTER JOIN into an INNER JOIN.
33972b300d5dSdrh   **
33982b300d5dSdrh   ** THIS OVERRIDES OBSOLETE COMMENTS 1 AND 2 ABOVE:
33992b300d5dSdrh   ** Ticket #3300 shows that flattening the right term of a LEFT JOIN
34002b300d5dSdrh   ** is fraught with danger.  Best to avoid the whole thing.  If the
34012b300d5dSdrh   ** subquery is the right term of a LEFT JOIN, then do not flatten.
34023fc673e6Sdrh   */
34032b300d5dSdrh   if( (pSubitem->jointype & JT_OUTER)!=0 ){
34043fc673e6Sdrh     return 0;
34053fc673e6Sdrh   }
34063fc673e6Sdrh 
3407f23329a2Sdanielk1977   /* Restriction 17: If the sub-query is a compound SELECT, then it must
3408f23329a2Sdanielk1977   ** use only the UNION ALL operator. And none of the simple select queries
3409f23329a2Sdanielk1977   ** that make up the compound SELECT are allowed to be aggregate or distinct
3410f23329a2Sdanielk1977   ** queries.
3411f23329a2Sdanielk1977   */
3412f23329a2Sdanielk1977   if( pSub->pPrior ){
3413e8902a70Sdrh     if( pSub->pOrderBy ){
3414e8902a70Sdrh       return 0;  /* Restriction 20 */
3415e8902a70Sdrh     }
3416e2f02bacSdrh     if( isAgg || (p->selFlags & SF_Distinct)!=0 || pSrc->nSrc!=1 ){
3417f23329a2Sdanielk1977       return 0;
3418f23329a2Sdanielk1977     }
3419f23329a2Sdanielk1977     for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
3420ccfcbceaSdrh       testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
3421ccfcbceaSdrh       testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
34224b3ac73cSdrh       assert( pSub->pSrc!=0 );
34237d10d5a6Sdrh       if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0
342480b3c548Sdanielk1977        || (pSub1->pPrior && pSub1->op!=TK_ALL)
34254b3ac73cSdrh        || pSub1->pSrc->nSrc<1
342667c70142Sdan        || pSub->pEList->nExpr!=pSub1->pEList->nExpr
342780b3c548Sdanielk1977       ){
3428f23329a2Sdanielk1977         return 0;
3429f23329a2Sdanielk1977       }
34304b3ac73cSdrh       testcase( pSub1->pSrc->nSrc>1 );
3431f23329a2Sdanielk1977     }
343249fc1f60Sdanielk1977 
343349fc1f60Sdanielk1977     /* Restriction 18. */
343449fc1f60Sdanielk1977     if( p->pOrderBy ){
343549fc1f60Sdanielk1977       int ii;
343649fc1f60Sdanielk1977       for(ii=0; ii<p->pOrderBy->nExpr; ii++){
3437c2acc4e4Sdrh         if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
343849fc1f60Sdanielk1977       }
343949fc1f60Sdanielk1977     }
3440f23329a2Sdanielk1977   }
3441f23329a2Sdanielk1977 
34427d10d5a6Sdrh   /***** If we reach this point, flattening is permitted. *****/
3443eb9b884cSdrh   SELECTTRACE(1,pParse,p,("flatten %s.%p from term %d\n",
3444eb9b884cSdrh                    pSub->zSelName, pSub, iFrom));
34457d10d5a6Sdrh 
34467d10d5a6Sdrh   /* Authorize the subquery */
3447524cc21eSdanielk1977   pParse->zAuthContext = pSubitem->zName;
3448a2acb0d7Sdrh   TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
3449a2acb0d7Sdrh   testcase( i==SQLITE_DENY );
3450524cc21eSdanielk1977   pParse->zAuthContext = zSavedAuthContext;
3451524cc21eSdanielk1977 
34527d10d5a6Sdrh   /* If the sub-query is a compound SELECT statement, then (by restrictions
34537d10d5a6Sdrh   ** 17 and 18 above) it must be a UNION ALL and the parent query must
34547d10d5a6Sdrh   ** be of the form:
3455f23329a2Sdanielk1977   **
3456f23329a2Sdanielk1977   **     SELECT <expr-list> FROM (<sub-query>) <where-clause>
3457f23329a2Sdanielk1977   **
3458f23329a2Sdanielk1977   ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
3459a78c22c4Sdrh   ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
3460f23329a2Sdanielk1977   ** OFFSET clauses and joins them to the left-hand-side of the original
3461f23329a2Sdanielk1977   ** using UNION ALL operators. In this case N is the number of simple
3462f23329a2Sdanielk1977   ** select statements in the compound sub-query.
3463a78c22c4Sdrh   **
3464a78c22c4Sdrh   ** Example:
3465a78c22c4Sdrh   **
3466a78c22c4Sdrh   **     SELECT a+1 FROM (
3467a78c22c4Sdrh   **        SELECT x FROM tab
3468a78c22c4Sdrh   **        UNION ALL
3469a78c22c4Sdrh   **        SELECT y FROM tab
3470a78c22c4Sdrh   **        UNION ALL
3471a78c22c4Sdrh   **        SELECT abs(z*2) FROM tab2
3472a78c22c4Sdrh   **     ) WHERE a!=5 ORDER BY 1
3473a78c22c4Sdrh   **
3474a78c22c4Sdrh   ** Transformed into:
3475a78c22c4Sdrh   **
3476a78c22c4Sdrh   **     SELECT x+1 FROM tab WHERE x+1!=5
3477a78c22c4Sdrh   **     UNION ALL
3478a78c22c4Sdrh   **     SELECT y+1 FROM tab WHERE y+1!=5
3479a78c22c4Sdrh   **     UNION ALL
3480a78c22c4Sdrh   **     SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
3481a78c22c4Sdrh   **     ORDER BY 1
3482a78c22c4Sdrh   **
3483a78c22c4Sdrh   ** We call this the "compound-subquery flattening".
3484f23329a2Sdanielk1977   */
3485f23329a2Sdanielk1977   for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
3486f23329a2Sdanielk1977     Select *pNew;
3487f23329a2Sdanielk1977     ExprList *pOrderBy = p->pOrderBy;
34884b86ef1dSdanielk1977     Expr *pLimit = p->pLimit;
3489547180baSdrh     Expr *pOffset = p->pOffset;
3490f23329a2Sdanielk1977     Select *pPrior = p->pPrior;
3491f23329a2Sdanielk1977     p->pOrderBy = 0;
3492f23329a2Sdanielk1977     p->pSrc = 0;
3493f23329a2Sdanielk1977     p->pPrior = 0;
34944b86ef1dSdanielk1977     p->pLimit = 0;
3495547180baSdrh     p->pOffset = 0;
34966ab3a2ecSdanielk1977     pNew = sqlite3SelectDup(db, p, 0);
3497eb9b884cSdrh     sqlite3SelectSetName(pNew, pSub->zSelName);
3498547180baSdrh     p->pOffset = pOffset;
34994b86ef1dSdanielk1977     p->pLimit = pLimit;
3500a78c22c4Sdrh     p->pOrderBy = pOrderBy;
3501a78c22c4Sdrh     p->pSrc = pSrc;
3502a78c22c4Sdrh     p->op = TK_ALL;
3503a78c22c4Sdrh     if( pNew==0 ){
3504d227a291Sdrh       p->pPrior = pPrior;
3505a78c22c4Sdrh     }else{
3506a78c22c4Sdrh       pNew->pPrior = pPrior;
3507d227a291Sdrh       if( pPrior ) pPrior->pNext = pNew;
3508d227a291Sdrh       pNew->pNext = p;
3509a78c22c4Sdrh       p->pPrior = pNew;
3510eb9b884cSdrh       SELECTTRACE(2,pParse,p,
3511eb9b884cSdrh          ("compound-subquery flattener creates %s.%p as peer\n",
3512eb9b884cSdrh          pNew->zSelName, pNew));
3513d227a291Sdrh     }
3514a78c22c4Sdrh     if( db->mallocFailed ) return 1;
3515a78c22c4Sdrh   }
3516f23329a2Sdanielk1977 
35177d10d5a6Sdrh   /* Begin flattening the iFrom-th entry of the FROM clause
35187d10d5a6Sdrh   ** in the outer query.
3519832508b7Sdrh   */
3520f23329a2Sdanielk1977   pSub = pSub1 = pSubitem->pSelect;
3521c31c2eb8Sdrh 
3522a78c22c4Sdrh   /* Delete the transient table structure associated with the
3523a78c22c4Sdrh   ** subquery
3524a78c22c4Sdrh   */
3525a78c22c4Sdrh   sqlite3DbFree(db, pSubitem->zDatabase);
3526a78c22c4Sdrh   sqlite3DbFree(db, pSubitem->zName);
3527a78c22c4Sdrh   sqlite3DbFree(db, pSubitem->zAlias);
3528a78c22c4Sdrh   pSubitem->zDatabase = 0;
3529a78c22c4Sdrh   pSubitem->zName = 0;
3530a78c22c4Sdrh   pSubitem->zAlias = 0;
3531a78c22c4Sdrh   pSubitem->pSelect = 0;
3532a78c22c4Sdrh 
3533a78c22c4Sdrh   /* Defer deleting the Table object associated with the
3534a78c22c4Sdrh   ** subquery until code generation is
3535a78c22c4Sdrh   ** complete, since there may still exist Expr.pTab entries that
3536a78c22c4Sdrh   ** refer to the subquery even after flattening.  Ticket #3346.
3537ccfcbceaSdrh   **
3538ccfcbceaSdrh   ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
3539a78c22c4Sdrh   */
3540ccfcbceaSdrh   if( ALWAYS(pSubitem->pTab!=0) ){
3541a78c22c4Sdrh     Table *pTabToDel = pSubitem->pTab;
3542a78c22c4Sdrh     if( pTabToDel->nRef==1 ){
354365a7cd16Sdan       Parse *pToplevel = sqlite3ParseToplevel(pParse);
354465a7cd16Sdan       pTabToDel->pNextZombie = pToplevel->pZombieTab;
354565a7cd16Sdan       pToplevel->pZombieTab = pTabToDel;
3546a78c22c4Sdrh     }else{
3547a78c22c4Sdrh       pTabToDel->nRef--;
3548a78c22c4Sdrh     }
3549a78c22c4Sdrh     pSubitem->pTab = 0;
3550a78c22c4Sdrh   }
3551a78c22c4Sdrh 
3552a78c22c4Sdrh   /* The following loop runs once for each term in a compound-subquery
3553a78c22c4Sdrh   ** flattening (as described above).  If we are doing a different kind
3554a78c22c4Sdrh   ** of flattening - a flattening other than a compound-subquery flattening -
3555a78c22c4Sdrh   ** then this loop only runs once.
3556a78c22c4Sdrh   **
3557a78c22c4Sdrh   ** This loop moves all of the FROM elements of the subquery into the
3558c31c2eb8Sdrh   ** the FROM clause of the outer query.  Before doing this, remember
3559c31c2eb8Sdrh   ** the cursor number for the original outer query FROM element in
3560c31c2eb8Sdrh   ** iParent.  The iParent cursor will never be used.  Subsequent code
3561c31c2eb8Sdrh   ** will scan expressions looking for iParent references and replace
3562c31c2eb8Sdrh   ** those references with expressions that resolve to the subquery FROM
3563c31c2eb8Sdrh   ** elements we are now copying in.
3564c31c2eb8Sdrh   */
3565a78c22c4Sdrh   for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
3566a78c22c4Sdrh     int nSubSrc;
3567ea678832Sdrh     u8 jointype = 0;
3568a78c22c4Sdrh     pSubSrc = pSub->pSrc;     /* FROM clause of subquery */
3569a78c22c4Sdrh     nSubSrc = pSubSrc->nSrc;  /* Number of terms in subquery FROM clause */
3570a78c22c4Sdrh     pSrc = pParent->pSrc;     /* FROM clause of the outer query */
3571588a9a1aSdrh 
3572a78c22c4Sdrh     if( pSrc ){
3573a78c22c4Sdrh       assert( pParent==p );  /* First time through the loop */
3574a78c22c4Sdrh       jointype = pSubitem->jointype;
3575588a9a1aSdrh     }else{
3576a78c22c4Sdrh       assert( pParent!=p );  /* 2nd and subsequent times through the loop */
3577a78c22c4Sdrh       pSrc = pParent->pSrc = sqlite3SrcListAppend(db, 0, 0, 0);
3578cfa063b3Sdrh       if( pSrc==0 ){
3579a78c22c4Sdrh         assert( db->mallocFailed );
3580a78c22c4Sdrh         break;
3581cfa063b3Sdrh       }
3582c31c2eb8Sdrh     }
3583a78c22c4Sdrh 
3584a78c22c4Sdrh     /* The subquery uses a single slot of the FROM clause of the outer
3585a78c22c4Sdrh     ** query.  If the subquery has more than one element in its FROM clause,
3586a78c22c4Sdrh     ** then expand the outer query to make space for it to hold all elements
3587a78c22c4Sdrh     ** of the subquery.
3588a78c22c4Sdrh     **
3589a78c22c4Sdrh     ** Example:
3590a78c22c4Sdrh     **
3591a78c22c4Sdrh     **    SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
3592a78c22c4Sdrh     **
3593a78c22c4Sdrh     ** The outer query has 3 slots in its FROM clause.  One slot of the
3594a78c22c4Sdrh     ** outer query (the middle slot) is used by the subquery.  The next
3595a78c22c4Sdrh     ** block of code will expand the out query to 4 slots.  The middle
3596a78c22c4Sdrh     ** slot is expanded to two slots in order to make space for the
3597a78c22c4Sdrh     ** two elements in the FROM clause of the subquery.
3598a78c22c4Sdrh     */
3599a78c22c4Sdrh     if( nSubSrc>1 ){
3600a78c22c4Sdrh       pParent->pSrc = pSrc = sqlite3SrcListEnlarge(db, pSrc, nSubSrc-1,iFrom+1);
3601a78c22c4Sdrh       if( db->mallocFailed ){
3602a78c22c4Sdrh         break;
3603c31c2eb8Sdrh       }
3604c31c2eb8Sdrh     }
3605a78c22c4Sdrh 
3606a78c22c4Sdrh     /* Transfer the FROM clause terms from the subquery into the
3607a78c22c4Sdrh     ** outer query.
3608a78c22c4Sdrh     */
3609c31c2eb8Sdrh     for(i=0; i<nSubSrc; i++){
3610c3a8402aSdrh       sqlite3IdListDelete(db, pSrc->a[i+iFrom].pUsing);
3611c31c2eb8Sdrh       pSrc->a[i+iFrom] = pSubSrc->a[i];
3612c31c2eb8Sdrh       memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
3613c31c2eb8Sdrh     }
361461dfc31dSdrh     pSrc->a[iFrom].jointype = jointype;
3615c31c2eb8Sdrh 
3616c31c2eb8Sdrh     /* Now begin substituting subquery result set expressions for
3617c31c2eb8Sdrh     ** references to the iParent in the outer query.
3618c31c2eb8Sdrh     **
3619c31c2eb8Sdrh     ** Example:
3620c31c2eb8Sdrh     **
3621c31c2eb8Sdrh     **   SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
3622c31c2eb8Sdrh     **   \                     \_____________ subquery __________/          /
3623c31c2eb8Sdrh     **    \_____________________ outer query ______________________________/
3624c31c2eb8Sdrh     **
3625c31c2eb8Sdrh     ** We look at every expression in the outer query and every place we see
3626c31c2eb8Sdrh     ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
3627c31c2eb8Sdrh     */
3628f23329a2Sdanielk1977     pList = pParent->pEList;
3629832508b7Sdrh     for(i=0; i<pList->nExpr; i++){
3630ccfcbceaSdrh       if( pList->a[i].zName==0 ){
363142fbf321Sdrh         char *zName = sqlite3DbStrDup(db, pList->a[i].zSpan);
363242fbf321Sdrh         sqlite3Dequote(zName);
363342fbf321Sdrh         pList->a[i].zName = zName;
3634832508b7Sdrh       }
3635ccfcbceaSdrh     }
3636f23329a2Sdanielk1977     substExprList(db, pParent->pEList, iParent, pSub->pEList);
36371b2e0329Sdrh     if( isAgg ){
3638f23329a2Sdanielk1977       substExprList(db, pParent->pGroupBy, iParent, pSub->pEList);
3639b7916a78Sdrh       pParent->pHaving = substExpr(db, pParent->pHaving, iParent, pSub->pEList);
36401b2e0329Sdrh     }
3641174b6195Sdrh     if( pSub->pOrderBy ){
36427c0a4720Sdan       /* At this point, any non-zero iOrderByCol values indicate that the
36437c0a4720Sdan       ** ORDER BY column expression is identical to the iOrderByCol'th
36447c0a4720Sdan       ** expression returned by SELECT statement pSub. Since these values
36457c0a4720Sdan       ** do not necessarily correspond to columns in SELECT statement pParent,
36467c0a4720Sdan       ** zero them before transfering the ORDER BY clause.
36477c0a4720Sdan       **
36487c0a4720Sdan       ** Not doing this may cause an error if a subsequent call to this
36497c0a4720Sdan       ** function attempts to flatten a compound sub-query into pParent
36507c0a4720Sdan       ** (the only way this can happen is if the compound sub-query is
36517c0a4720Sdan       ** currently part of pSub->pSrc). See ticket [d11a6e908f].  */
36527c0a4720Sdan       ExprList *pOrderBy = pSub->pOrderBy;
36537c0a4720Sdan       for(i=0; i<pOrderBy->nExpr; i++){
36547c0a4720Sdan         pOrderBy->a[i].u.x.iOrderByCol = 0;
36557c0a4720Sdan       }
3656f23329a2Sdanielk1977       assert( pParent->pOrderBy==0 );
36577c0a4720Sdan       assert( pSub->pPrior==0 );
36587c0a4720Sdan       pParent->pOrderBy = pOrderBy;
3659174b6195Sdrh       pSub->pOrderBy = 0;
3660f23329a2Sdanielk1977     }else if( pParent->pOrderBy ){
3661f23329a2Sdanielk1977       substExprList(db, pParent->pOrderBy, iParent, pSub->pEList);
3662174b6195Sdrh     }
3663832508b7Sdrh     if( pSub->pWhere ){
36646ab3a2ecSdanielk1977       pWhere = sqlite3ExprDup(db, pSub->pWhere, 0);
3665832508b7Sdrh     }else{
3666832508b7Sdrh       pWhere = 0;
3667832508b7Sdrh     }
3668832508b7Sdrh     if( subqueryIsAgg ){
3669f23329a2Sdanielk1977       assert( pParent->pHaving==0 );
3670f23329a2Sdanielk1977       pParent->pHaving = pParent->pWhere;
3671f23329a2Sdanielk1977       pParent->pWhere = pWhere;
3672b7916a78Sdrh       pParent->pHaving = substExpr(db, pParent->pHaving, iParent, pSub->pEList);
3673f23329a2Sdanielk1977       pParent->pHaving = sqlite3ExprAnd(db, pParent->pHaving,
36746ab3a2ecSdanielk1977                                   sqlite3ExprDup(db, pSub->pHaving, 0));
3675f23329a2Sdanielk1977       assert( pParent->pGroupBy==0 );
36766ab3a2ecSdanielk1977       pParent->pGroupBy = sqlite3ExprListDup(db, pSub->pGroupBy, 0);
3677832508b7Sdrh     }else{
3678b7916a78Sdrh       pParent->pWhere = substExpr(db, pParent->pWhere, iParent, pSub->pEList);
3679f23329a2Sdanielk1977       pParent->pWhere = sqlite3ExprAnd(db, pParent->pWhere, pWhere);
3680832508b7Sdrh     }
3681c31c2eb8Sdrh 
3682c31c2eb8Sdrh     /* The flattened query is distinct if either the inner or the
3683c31c2eb8Sdrh     ** outer query is distinct.
3684c31c2eb8Sdrh     */
36857d10d5a6Sdrh     pParent->selFlags |= pSub->selFlags & SF_Distinct;
36868c74a8caSdrh 
3687a58fdfb1Sdanielk1977     /*
3688a58fdfb1Sdanielk1977     ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
3689ac83963aSdrh     **
3690ac83963aSdrh     ** One is tempted to try to add a and b to combine the limits.  But this
3691ac83963aSdrh     ** does not work if either limit is negative.
3692a58fdfb1Sdanielk1977     */
3693a2dc3b1aSdanielk1977     if( pSub->pLimit ){
3694f23329a2Sdanielk1977       pParent->pLimit = pSub->pLimit;
3695a2dc3b1aSdanielk1977       pSub->pLimit = 0;
3696df199a25Sdrh     }
3697f23329a2Sdanielk1977   }
36988c74a8caSdrh 
3699c31c2eb8Sdrh   /* Finially, delete what is left of the subquery and return
3700c31c2eb8Sdrh   ** success.
3701c31c2eb8Sdrh   */
3702633e6d57Sdrh   sqlite3SelectDelete(db, pSub1);
3703f23329a2Sdanielk1977 
3704c90713d3Sdrh #if SELECTTRACE_ENABLED
3705c90713d3Sdrh   if( sqlite3SelectTrace & 0x100 ){
3706c90713d3Sdrh     sqlite3DebugPrintf("After flattening:\n");
3707c90713d3Sdrh     sqlite3TreeViewSelect(0, p, 0);
3708c90713d3Sdrh   }
3709c90713d3Sdrh #endif
3710c90713d3Sdrh 
3711832508b7Sdrh   return 1;
37121350b030Sdrh }
37133514b6f7Sshane #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
37141350b030Sdrh 
37151350b030Sdrh /*
37164ac391fcSdan ** Based on the contents of the AggInfo structure indicated by the first
37174ac391fcSdan ** argument, this function checks if the following are true:
3718a9d1ccb9Sdanielk1977 **
37194ac391fcSdan **    * the query contains just a single aggregate function,
37204ac391fcSdan **    * the aggregate function is either min() or max(), and
37214ac391fcSdan **    * the argument to the aggregate function is a column value.
3722738bdcfbSdanielk1977 **
37234ac391fcSdan ** If all of the above are true, then WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX
37244ac391fcSdan ** is returned as appropriate. Also, *ppMinMax is set to point to the
37254ac391fcSdan ** list of arguments passed to the aggregate before returning.
37264ac391fcSdan **
37274ac391fcSdan ** Or, if the conditions above are not met, *ppMinMax is set to 0 and
37284ac391fcSdan ** WHERE_ORDERBY_NORMAL is returned.
3729a9d1ccb9Sdanielk1977 */
37304ac391fcSdan static u8 minMaxQuery(AggInfo *pAggInfo, ExprList **ppMinMax){
37314ac391fcSdan   int eRet = WHERE_ORDERBY_NORMAL;          /* Return value */
3732a9d1ccb9Sdanielk1977 
37334ac391fcSdan   *ppMinMax = 0;
37344ac391fcSdan   if( pAggInfo->nFunc==1 ){
37354ac391fcSdan     Expr *pExpr = pAggInfo->aFunc[0].pExpr; /* Aggregate function */
37364ac391fcSdan     ExprList *pEList = pExpr->x.pList;      /* Arguments to agg function */
37374ac391fcSdan 
37384ac391fcSdan     assert( pExpr->op==TK_AGG_FUNCTION );
37394ac391fcSdan     if( pEList && pEList->nExpr==1 && pEList->a[0].pExpr->op==TK_AGG_COLUMN ){
37404ac391fcSdan       const char *zFunc = pExpr->u.zToken;
37414ac391fcSdan       if( sqlite3StrICmp(zFunc, "min")==0 ){
37424ac391fcSdan         eRet = WHERE_ORDERBY_MIN;
37434ac391fcSdan         *ppMinMax = pEList;
37444ac391fcSdan       }else if( sqlite3StrICmp(zFunc, "max")==0 ){
37454ac391fcSdan         eRet = WHERE_ORDERBY_MAX;
37464ac391fcSdan         *ppMinMax = pEList;
3747a9d1ccb9Sdanielk1977       }
37484ac391fcSdan     }
37494ac391fcSdan   }
37504ac391fcSdan 
37514ac391fcSdan   assert( *ppMinMax==0 || (*ppMinMax)->nExpr==1 );
37524ac391fcSdan   return eRet;
3753a9d1ccb9Sdanielk1977 }
3754a9d1ccb9Sdanielk1977 
3755a9d1ccb9Sdanielk1977 /*
3756a5533162Sdanielk1977 ** The select statement passed as the first argument is an aggregate query.
375760ec914cSpeter.d.reid ** The second argument is the associated aggregate-info object. This
3758a5533162Sdanielk1977 ** function tests if the SELECT is of the form:
3759a5533162Sdanielk1977 **
3760a5533162Sdanielk1977 **   SELECT count(*) FROM <tbl>
3761a5533162Sdanielk1977 **
3762a5533162Sdanielk1977 ** where table is a database table, not a sub-select or view. If the query
3763a5533162Sdanielk1977 ** does match this pattern, then a pointer to the Table object representing
3764a5533162Sdanielk1977 ** <tbl> is returned. Otherwise, 0 is returned.
3765a5533162Sdanielk1977 */
3766a5533162Sdanielk1977 static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
3767a5533162Sdanielk1977   Table *pTab;
3768a5533162Sdanielk1977   Expr *pExpr;
3769a5533162Sdanielk1977 
3770a5533162Sdanielk1977   assert( !p->pGroupBy );
3771a5533162Sdanielk1977 
37727a895a80Sdanielk1977   if( p->pWhere || p->pEList->nExpr!=1
3773a5533162Sdanielk1977    || p->pSrc->nSrc!=1 || p->pSrc->a[0].pSelect
3774a5533162Sdanielk1977   ){
3775a5533162Sdanielk1977     return 0;
3776a5533162Sdanielk1977   }
3777a5533162Sdanielk1977   pTab = p->pSrc->a[0].pTab;
3778a5533162Sdanielk1977   pExpr = p->pEList->a[0].pExpr;
377902f33725Sdanielk1977   assert( pTab && !pTab->pSelect && pExpr );
378002f33725Sdanielk1977 
378102f33725Sdanielk1977   if( IsVirtual(pTab) ) return 0;
3782a5533162Sdanielk1977   if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
3783fb0a6081Sdrh   if( NEVER(pAggInfo->nFunc==0) ) return 0;
3784d36e1041Sdrh   if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
3785a5533162Sdanielk1977   if( pExpr->flags&EP_Distinct ) return 0;
3786a5533162Sdanielk1977 
3787a5533162Sdanielk1977   return pTab;
3788a5533162Sdanielk1977 }
3789a5533162Sdanielk1977 
3790a5533162Sdanielk1977 /*
3791b1c685b0Sdanielk1977 ** If the source-list item passed as an argument was augmented with an
3792b1c685b0Sdanielk1977 ** INDEXED BY clause, then try to locate the specified index. If there
3793b1c685b0Sdanielk1977 ** was such a clause and the named index cannot be found, return
3794b1c685b0Sdanielk1977 ** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
3795b1c685b0Sdanielk1977 ** pFrom->pIndex and return SQLITE_OK.
3796b1c685b0Sdanielk1977 */
3797b1c685b0Sdanielk1977 int sqlite3IndexedByLookup(Parse *pParse, struct SrcList_item *pFrom){
3798b1c685b0Sdanielk1977   if( pFrom->pTab && pFrom->zIndex ){
3799b1c685b0Sdanielk1977     Table *pTab = pFrom->pTab;
3800b1c685b0Sdanielk1977     char *zIndex = pFrom->zIndex;
3801b1c685b0Sdanielk1977     Index *pIdx;
3802b1c685b0Sdanielk1977     for(pIdx=pTab->pIndex;
3803b1c685b0Sdanielk1977         pIdx && sqlite3StrICmp(pIdx->zName, zIndex);
3804b1c685b0Sdanielk1977         pIdx=pIdx->pNext
3805b1c685b0Sdanielk1977     );
3806b1c685b0Sdanielk1977     if( !pIdx ){
3807b1c685b0Sdanielk1977       sqlite3ErrorMsg(pParse, "no such index: %s", zIndex, 0);
38081db95106Sdan       pParse->checkSchema = 1;
3809b1c685b0Sdanielk1977       return SQLITE_ERROR;
3810b1c685b0Sdanielk1977     }
3811b1c685b0Sdanielk1977     pFrom->pIndex = pIdx;
3812b1c685b0Sdanielk1977   }
3813b1c685b0Sdanielk1977   return SQLITE_OK;
3814b1c685b0Sdanielk1977 }
3815c01b7306Sdrh /*
3816c01b7306Sdrh ** Detect compound SELECT statements that use an ORDER BY clause with
3817c01b7306Sdrh ** an alternative collating sequence.
3818c01b7306Sdrh **
3819c01b7306Sdrh **    SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
3820c01b7306Sdrh **
3821c01b7306Sdrh ** These are rewritten as a subquery:
3822c01b7306Sdrh **
3823c01b7306Sdrh **    SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
3824c01b7306Sdrh **     ORDER BY ... COLLATE ...
3825c01b7306Sdrh **
3826c01b7306Sdrh ** This transformation is necessary because the multiSelectOrderBy() routine
3827c01b7306Sdrh ** above that generates the code for a compound SELECT with an ORDER BY clause
3828c01b7306Sdrh ** uses a merge algorithm that requires the same collating sequence on the
3829c01b7306Sdrh ** result columns as on the ORDER BY clause.  See ticket
3830c01b7306Sdrh ** http://www.sqlite.org/src/info/6709574d2a
3831c01b7306Sdrh **
3832c01b7306Sdrh ** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
3833c01b7306Sdrh ** The UNION ALL operator works fine with multiSelectOrderBy() even when
3834c01b7306Sdrh ** there are COLLATE terms in the ORDER BY.
3835c01b7306Sdrh */
3836c01b7306Sdrh static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
3837c01b7306Sdrh   int i;
3838c01b7306Sdrh   Select *pNew;
3839c01b7306Sdrh   Select *pX;
3840c01b7306Sdrh   sqlite3 *db;
3841c01b7306Sdrh   struct ExprList_item *a;
3842c01b7306Sdrh   SrcList *pNewSrc;
3843c01b7306Sdrh   Parse *pParse;
3844c01b7306Sdrh   Token dummy;
3845c01b7306Sdrh 
3846c01b7306Sdrh   if( p->pPrior==0 ) return WRC_Continue;
3847c01b7306Sdrh   if( p->pOrderBy==0 ) return WRC_Continue;
3848c01b7306Sdrh   for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
3849c01b7306Sdrh   if( pX==0 ) return WRC_Continue;
3850c01b7306Sdrh   a = p->pOrderBy->a;
3851c01b7306Sdrh   for(i=p->pOrderBy->nExpr-1; i>=0; i--){
3852c01b7306Sdrh     if( a[i].pExpr->flags & EP_Collate ) break;
3853c01b7306Sdrh   }
3854c01b7306Sdrh   if( i<0 ) return WRC_Continue;
3855c01b7306Sdrh 
3856c01b7306Sdrh   /* If we reach this point, that means the transformation is required. */
3857c01b7306Sdrh 
3858c01b7306Sdrh   pParse = pWalker->pParse;
3859c01b7306Sdrh   db = pParse->db;
3860c01b7306Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
3861c01b7306Sdrh   if( pNew==0 ) return WRC_Abort;
3862c01b7306Sdrh   memset(&dummy, 0, sizeof(dummy));
3863c01b7306Sdrh   pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0,0);
3864c01b7306Sdrh   if( pNewSrc==0 ) return WRC_Abort;
3865c01b7306Sdrh   *pNew = *p;
3866c01b7306Sdrh   p->pSrc = pNewSrc;
3867c01b7306Sdrh   p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ALL, 0));
3868c01b7306Sdrh   p->op = TK_SELECT;
3869c01b7306Sdrh   p->pWhere = 0;
3870c01b7306Sdrh   pNew->pGroupBy = 0;
3871c01b7306Sdrh   pNew->pHaving = 0;
3872c01b7306Sdrh   pNew->pOrderBy = 0;
3873c01b7306Sdrh   p->pPrior = 0;
38748af9ad95Sdrh   p->pNext = 0;
38758af9ad95Sdrh   p->selFlags &= ~SF_Compound;
3876a6e3a8c9Sdrh   assert( pNew->pPrior!=0 );
3877a6e3a8c9Sdrh   pNew->pPrior->pNext = pNew;
3878c01b7306Sdrh   pNew->pLimit = 0;
3879c01b7306Sdrh   pNew->pOffset = 0;
3880c01b7306Sdrh   return WRC_Continue;
3881c01b7306Sdrh }
3882b1c685b0Sdanielk1977 
3883eede6a53Sdan #ifndef SQLITE_OMIT_CTE
3884eede6a53Sdan /*
3885eede6a53Sdan ** Argument pWith (which may be NULL) points to a linked list of nested
3886eede6a53Sdan ** WITH contexts, from inner to outermost. If the table identified by
3887eede6a53Sdan ** FROM clause element pItem is really a common-table-expression (CTE)
3888eede6a53Sdan ** then return a pointer to the CTE definition for that table. Otherwise
3889eede6a53Sdan ** return NULL.
389098f45e53Sdan **
389198f45e53Sdan ** If a non-NULL value is returned, set *ppContext to point to the With
389298f45e53Sdan ** object that the returned CTE belongs to.
389360c1a2f0Sdrh */
389498f45e53Sdan static struct Cte *searchWith(
389598f45e53Sdan   With *pWith,                    /* Current outermost WITH clause */
389698f45e53Sdan   struct SrcList_item *pItem,     /* FROM clause element to resolve */
389798f45e53Sdan   With **ppContext                /* OUT: WITH clause return value belongs to */
389898f45e53Sdan ){
38997b19f252Sdrh   const char *zName;
39007b19f252Sdrh   if( pItem->zDatabase==0 && (zName = pItem->zName)!=0 ){
3901eede6a53Sdan     With *p;
3902eede6a53Sdan     for(p=pWith; p; p=p->pOuter){
39034e9119d9Sdan       int i;
3904eede6a53Sdan       for(i=0; i<p->nCte; i++){
3905eede6a53Sdan         if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
390698f45e53Sdan           *ppContext = p;
3907eede6a53Sdan           return &p->a[i];
39084e9119d9Sdan         }
39094e9119d9Sdan       }
39104e9119d9Sdan     }
39114e9119d9Sdan   }
39124e9119d9Sdan   return 0;
39134e9119d9Sdan }
39144e9119d9Sdan 
3915c49832c2Sdrh /* The code generator maintains a stack of active WITH clauses
3916c49832c2Sdrh ** with the inner-most WITH clause being at the top of the stack.
3917c49832c2Sdrh **
3918b290f117Sdan ** This routine pushes the WITH clause passed as the second argument
3919b290f117Sdan ** onto the top of the stack. If argument bFree is true, then this
3920b290f117Sdan ** WITH clause will never be popped from the stack. In this case it
3921b290f117Sdan ** should be freed along with the Parse object. In other cases, when
3922b290f117Sdan ** bFree==0, the With object will be freed along with the SELECT
3923b290f117Sdan ** statement with which it is associated.
3924c49832c2Sdrh */
3925b290f117Sdan void sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
3926b290f117Sdan   assert( bFree==0 || pParse->pWith==0 );
39274e9119d9Sdan   if( pWith ){
39284e9119d9Sdan     pWith->pOuter = pParse->pWith;
39294e9119d9Sdan     pParse->pWith = pWith;
3930b290f117Sdan     pParse->bFreeWith = bFree;
39314e9119d9Sdan   }
39324e9119d9Sdan }
39334e9119d9Sdan 
3934eede6a53Sdan /*
3935eede6a53Sdan ** This function checks if argument pFrom refers to a CTE declared by
3936eede6a53Sdan ** a WITH clause on the stack currently maintained by the parser. And,
3937eede6a53Sdan ** if currently processing a CTE expression, if it is a recursive
3938eede6a53Sdan ** reference to the current CTE.
3939eede6a53Sdan **
3940eede6a53Sdan ** If pFrom falls into either of the two categories above, pFrom->pTab
3941eede6a53Sdan ** and other fields are populated accordingly. The caller should check
3942eede6a53Sdan ** (pFrom->pTab!=0) to determine whether or not a successful match
3943eede6a53Sdan ** was found.
3944eede6a53Sdan **
3945eede6a53Sdan ** Whether or not a match is found, SQLITE_OK is returned if no error
3946eede6a53Sdan ** occurs. If an error does occur, an error message is stored in the
3947eede6a53Sdan ** parser and some error code other than SQLITE_OK returned.
3948eede6a53Sdan */
39498ce7184bSdan static int withExpand(
39508ce7184bSdan   Walker *pWalker,
3951eede6a53Sdan   struct SrcList_item *pFrom
39528ce7184bSdan ){
39538ce7184bSdan   Parse *pParse = pWalker->pParse;
39548ce7184bSdan   sqlite3 *db = pParse->db;
395598f45e53Sdan   struct Cte *pCte;               /* Matched CTE (or NULL if no match) */
395698f45e53Sdan   With *pWith;                    /* WITH clause that pCte belongs to */
39578ce7184bSdan 
39588ce7184bSdan   assert( pFrom->pTab==0 );
39598ce7184bSdan 
396098f45e53Sdan   pCte = searchWith(pParse->pWith, pFrom, &pWith);
3961eae73fbfSdan   if( pCte ){
396298f45e53Sdan     Table *pTab;
39638ce7184bSdan     ExprList *pEList;
39648ce7184bSdan     Select *pSel;
396560e7068dSdan     Select *pLeft;                /* Left-most SELECT statement */
3966f2655fe8Sdan     int bMayRecursive;            /* True if compound joined by UNION [ALL] */
396798f45e53Sdan     With *pSavedWith;             /* Initial value of pParse->pWith */
3968f2655fe8Sdan 
3969f2655fe8Sdan     /* If pCte->zErr is non-NULL at this point, then this is an illegal
3970f2655fe8Sdan     ** recursive reference to CTE pCte. Leave an error in pParse and return
3971f2655fe8Sdan     ** early. If pCte->zErr is NULL, then this is not a recursive reference.
3972f2655fe8Sdan     ** In this case, proceed.  */
3973f2655fe8Sdan     if( pCte->zErr ){
3974f2655fe8Sdan       sqlite3ErrorMsg(pParse, pCte->zErr, pCte->zName);
397598f45e53Sdan       return SQLITE_ERROR;
3976f2655fe8Sdan     }
39778ce7184bSdan 
3978c25e2ebcSdrh     assert( pFrom->pTab==0 );
39798ce7184bSdan     pFrom->pTab = pTab = sqlite3DbMallocZero(db, sizeof(Table));
39808ce7184bSdan     if( pTab==0 ) return WRC_Abort;
39818ce7184bSdan     pTab->nRef = 1;
39822d4dc5fcSdan     pTab->zName = sqlite3DbStrDup(db, pCte->zName);
39838ce7184bSdan     pTab->iPKey = -1;
3984cfc9df76Sdan     pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
39858ce7184bSdan     pTab->tabFlags |= TF_Ephemeral;
39868ce7184bSdan     pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
39878ce7184bSdan     if( db->mallocFailed ) return SQLITE_NOMEM;
39888ce7184bSdan     assert( pFrom->pSelect );
39898ce7184bSdan 
3990eae73fbfSdan     /* Check if this is a recursive CTE. */
39918ce7184bSdan     pSel = pFrom->pSelect;
3992f2655fe8Sdan     bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
3993f2655fe8Sdan     if( bMayRecursive ){
3994eae73fbfSdan       int i;
3995eae73fbfSdan       SrcList *pSrc = pFrom->pSelect->pSrc;
3996eae73fbfSdan       for(i=0; i<pSrc->nSrc; i++){
3997eae73fbfSdan         struct SrcList_item *pItem = &pSrc->a[i];
3998eae73fbfSdan         if( pItem->zDatabase==0
3999eae73fbfSdan          && pItem->zName!=0
4000eae73fbfSdan          && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
4001eae73fbfSdan           ){
4002eae73fbfSdan           pItem->pTab = pTab;
4003eae73fbfSdan           pItem->isRecursive = 1;
4004eae73fbfSdan           pTab->nRef++;
4005eae73fbfSdan           pSel->selFlags |= SF_Recursive;
40068ce7184bSdan         }
4007eae73fbfSdan       }
4008eae73fbfSdan     }
4009eae73fbfSdan 
4010eae73fbfSdan     /* Only one recursive reference is permitted. */
4011eae73fbfSdan     if( pTab->nRef>2 ){
4012eae73fbfSdan       sqlite3ErrorMsg(
4013727a99f1Sdrh           pParse, "multiple references to recursive table: %s", pCte->zName
4014eae73fbfSdan       );
401598f45e53Sdan       return SQLITE_ERROR;
4016eae73fbfSdan     }
4017eae73fbfSdan     assert( pTab->nRef==1 || ((pSel->selFlags&SF_Recursive) && pTab->nRef==2 ));
4018eae73fbfSdan 
4019727a99f1Sdrh     pCte->zErr = "circular reference: %s";
402098f45e53Sdan     pSavedWith = pParse->pWith;
402198f45e53Sdan     pParse->pWith = pWith;
4022f2655fe8Sdan     sqlite3WalkSelect(pWalker, bMayRecursive ? pSel->pPrior : pSel);
40238ce7184bSdan 
40248ce7184bSdan     for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
40258ce7184bSdan     pEList = pLeft->pEList;
402660e7068dSdan     if( pCte->pCols ){
402760e7068dSdan       if( pEList->nExpr!=pCte->pCols->nExpr ){
4028727a99f1Sdrh         sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
402960e7068dSdan             pCte->zName, pEList->nExpr, pCte->pCols->nExpr
403060e7068dSdan         );
403198f45e53Sdan         pParse->pWith = pSavedWith;
403298f45e53Sdan         return SQLITE_ERROR;
40338ce7184bSdan       }
403460e7068dSdan       pEList = pCte->pCols;
403560e7068dSdan     }
40368ce7184bSdan 
403798f45e53Sdan     selectColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
4038f2655fe8Sdan     if( bMayRecursive ){
4039f2655fe8Sdan       if( pSel->selFlags & SF_Recursive ){
4040727a99f1Sdrh         pCte->zErr = "multiple recursive references: %s";
4041f2655fe8Sdan       }else{
4042727a99f1Sdrh         pCte->zErr = "recursive reference in a subquery: %s";
4043f2655fe8Sdan       }
4044f2655fe8Sdan       sqlite3WalkSelect(pWalker, pSel);
4045f2655fe8Sdan     }
4046f2655fe8Sdan     pCte->zErr = 0;
404798f45e53Sdan     pParse->pWith = pSavedWith;
40488ce7184bSdan   }
40498ce7184bSdan 
40508ce7184bSdan   return SQLITE_OK;
40518ce7184bSdan }
4052eede6a53Sdan #endif
40534e9119d9Sdan 
4054b290f117Sdan #ifndef SQLITE_OMIT_CTE
405571856944Sdan /*
405671856944Sdan ** If the SELECT passed as the second argument has an associated WITH
405771856944Sdan ** clause, pop it from the stack stored as part of the Parse object.
405871856944Sdan **
405971856944Sdan ** This function is used as the xSelectCallback2() callback by
406071856944Sdan ** sqlite3SelectExpand() when walking a SELECT tree to resolve table
406171856944Sdan ** names and other FROM clause elements.
406271856944Sdan */
4063b290f117Sdan static void selectPopWith(Walker *pWalker, Select *p){
4064b290f117Sdan   Parse *pParse = pWalker->pParse;
4065d227a291Sdrh   With *pWith = findRightmost(p)->pWith;
4066d227a291Sdrh   if( pWith!=0 ){
4067d227a291Sdrh     assert( pParse->pWith==pWith );
4068d227a291Sdrh     pParse->pWith = pWith->pOuter;
4069b290f117Sdan   }
4070b290f117Sdan }
4071b290f117Sdan #else
4072b290f117Sdan #define selectPopWith 0
4073b290f117Sdan #endif
4074b290f117Sdan 
4075b1c685b0Sdanielk1977 /*
40767d10d5a6Sdrh ** This routine is a Walker callback for "expanding" a SELECT statement.
40777d10d5a6Sdrh ** "Expanding" means to do the following:
40787d10d5a6Sdrh **
40797d10d5a6Sdrh **    (1)  Make sure VDBE cursor numbers have been assigned to every
40807d10d5a6Sdrh **         element of the FROM clause.
40817d10d5a6Sdrh **
40827d10d5a6Sdrh **    (2)  Fill in the pTabList->a[].pTab fields in the SrcList that
40837d10d5a6Sdrh **         defines FROM clause.  When views appear in the FROM clause,
40847d10d5a6Sdrh **         fill pTabList->a[].pSelect with a copy of the SELECT statement
40857d10d5a6Sdrh **         that implements the view.  A copy is made of the view's SELECT
40867d10d5a6Sdrh **         statement so that we can freely modify or delete that statement
408760ec914cSpeter.d.reid **         without worrying about messing up the persistent representation
40887d10d5a6Sdrh **         of the view.
40897d10d5a6Sdrh **
409060ec914cSpeter.d.reid **    (3)  Add terms to the WHERE clause to accommodate the NATURAL keyword
40917d10d5a6Sdrh **         on joins and the ON and USING clause of joins.
40927d10d5a6Sdrh **
40937d10d5a6Sdrh **    (4)  Scan the list of columns in the result set (pEList) looking
40947d10d5a6Sdrh **         for instances of the "*" operator or the TABLE.* operator.
40957d10d5a6Sdrh **         If found, expand each "*" to be every column in every table
40967d10d5a6Sdrh **         and TABLE.* to be every column in TABLE.
40977d10d5a6Sdrh **
4098b3bce662Sdanielk1977 */
40997d10d5a6Sdrh static int selectExpander(Walker *pWalker, Select *p){
41007d10d5a6Sdrh   Parse *pParse = pWalker->pParse;
41017d10d5a6Sdrh   int i, j, k;
41027d10d5a6Sdrh   SrcList *pTabList;
41037d10d5a6Sdrh   ExprList *pEList;
41047d10d5a6Sdrh   struct SrcList_item *pFrom;
41057d10d5a6Sdrh   sqlite3 *db = pParse->db;
41063e3f1a5bSdrh   Expr *pE, *pRight, *pExpr;
4107785097daSdrh   u16 selFlags = p->selFlags;
41087d10d5a6Sdrh 
4109785097daSdrh   p->selFlags |= SF_Expanded;
41107d10d5a6Sdrh   if( db->mallocFailed  ){
41117d10d5a6Sdrh     return WRC_Abort;
41127d10d5a6Sdrh   }
4113785097daSdrh   if( NEVER(p->pSrc==0) || (selFlags & SF_Expanded)!=0 ){
41147d10d5a6Sdrh     return WRC_Prune;
41157d10d5a6Sdrh   }
41167d10d5a6Sdrh   pTabList = p->pSrc;
41177d10d5a6Sdrh   pEList = p->pEList;
4118*3afd2b4dSdrh   if( pWalker->xSelectCallback2==selectPopWith ){
4119d227a291Sdrh     sqlite3WithPush(pParse, findRightmost(p)->pWith, 0);
4120*3afd2b4dSdrh   }
41217d10d5a6Sdrh 
41227d10d5a6Sdrh   /* Make sure cursor numbers have been assigned to all entries in
41237d10d5a6Sdrh   ** the FROM clause of the SELECT statement.
41247d10d5a6Sdrh   */
41257d10d5a6Sdrh   sqlite3SrcListAssignCursors(pParse, pTabList);
41267d10d5a6Sdrh 
41277d10d5a6Sdrh   /* Look up every table named in the FROM clause of the select.  If
41287d10d5a6Sdrh   ** an entry of the FROM clause is a subquery instead of a table or view,
41297d10d5a6Sdrh   ** then create a transient table structure to describe the subquery.
41307d10d5a6Sdrh   */
41317d10d5a6Sdrh   for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
41327d10d5a6Sdrh     Table *pTab;
4133eae73fbfSdan     assert( pFrom->isRecursive==0 || pFrom->pTab );
4134eae73fbfSdan     if( pFrom->isRecursive ) continue;
41357d10d5a6Sdrh     if( pFrom->pTab!=0 ){
41367d10d5a6Sdrh       /* This statement has already been prepared.  There is no need
41377d10d5a6Sdrh       ** to go further. */
41387d10d5a6Sdrh       assert( i==0 );
4139b290f117Sdan #ifndef SQLITE_OMIT_CTE
4140b290f117Sdan       selectPopWith(pWalker, p);
4141b290f117Sdan #endif
41427d10d5a6Sdrh       return WRC_Prune;
41437d10d5a6Sdrh     }
41444e9119d9Sdan #ifndef SQLITE_OMIT_CTE
4145eede6a53Sdan     if( withExpand(pWalker, pFrom) ) return WRC_Abort;
4146eede6a53Sdan     if( pFrom->pTab ) {} else
41474e9119d9Sdan #endif
41487d10d5a6Sdrh     if( pFrom->zName==0 ){
41497d10d5a6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
41507d10d5a6Sdrh       Select *pSel = pFrom->pSelect;
41517d10d5a6Sdrh       /* A sub-query in the FROM clause of a SELECT */
41527d10d5a6Sdrh       assert( pSel!=0 );
41537d10d5a6Sdrh       assert( pFrom->pTab==0 );
41547d10d5a6Sdrh       sqlite3WalkSelect(pWalker, pSel);
41557d10d5a6Sdrh       pFrom->pTab = pTab = sqlite3DbMallocZero(db, sizeof(Table));
41567d10d5a6Sdrh       if( pTab==0 ) return WRC_Abort;
41577d10d5a6Sdrh       pTab->nRef = 1;
4158186ad8ccSdrh       pTab->zName = sqlite3MPrintf(db, "sqlite_sq_%p", (void*)pTab);
41597d10d5a6Sdrh       while( pSel->pPrior ){ pSel = pSel->pPrior; }
41607d10d5a6Sdrh       selectColumnsFromExprList(pParse, pSel->pEList, &pTab->nCol, &pTab->aCol);
41617d10d5a6Sdrh       pTab->iPKey = -1;
4162cfc9df76Sdan       pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
41637d10d5a6Sdrh       pTab->tabFlags |= TF_Ephemeral;
41647d10d5a6Sdrh #endif
41657d10d5a6Sdrh     }else{
41667d10d5a6Sdrh       /* An ordinary table or view name in the FROM clause */
41677d10d5a6Sdrh       assert( pFrom->pTab==0 );
416841fb5cd1Sdan       pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
41697d10d5a6Sdrh       if( pTab==0 ) return WRC_Abort;
4170d2a56238Sdrh       if( pTab->nRef==0xffff ){
4171d2a56238Sdrh         sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
4172d2a56238Sdrh            pTab->zName);
4173d2a56238Sdrh         pFrom->pTab = 0;
4174d2a56238Sdrh         return WRC_Abort;
4175d2a56238Sdrh       }
41767d10d5a6Sdrh       pTab->nRef++;
41777d10d5a6Sdrh #if !defined(SQLITE_OMIT_VIEW) || !defined (SQLITE_OMIT_VIRTUALTABLE)
41787d10d5a6Sdrh       if( pTab->pSelect || IsVirtual(pTab) ){
41797d10d5a6Sdrh         /* We reach here if the named table is a really a view */
41807d10d5a6Sdrh         if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
418143152cf8Sdrh         assert( pFrom->pSelect==0 );
41826ab3a2ecSdanielk1977         pFrom->pSelect = sqlite3SelectDup(db, pTab->pSelect, 0);
4183eb9b884cSdrh         sqlite3SelectSetName(pFrom->pSelect, pTab->zName);
41847d10d5a6Sdrh         sqlite3WalkSelect(pWalker, pFrom->pSelect);
41857d10d5a6Sdrh       }
41867d10d5a6Sdrh #endif
41877d10d5a6Sdrh     }
418885574e31Sdanielk1977 
418985574e31Sdanielk1977     /* Locate the index named by the INDEXED BY clause, if any. */
4190b1c685b0Sdanielk1977     if( sqlite3IndexedByLookup(pParse, pFrom) ){
419185574e31Sdanielk1977       return WRC_Abort;
419285574e31Sdanielk1977     }
41937d10d5a6Sdrh   }
41947d10d5a6Sdrh 
41957d10d5a6Sdrh   /* Process NATURAL keywords, and ON and USING clauses of joins.
41967d10d5a6Sdrh   */
41977d10d5a6Sdrh   if( db->mallocFailed || sqliteProcessJoin(pParse, p) ){
41987d10d5a6Sdrh     return WRC_Abort;
41997d10d5a6Sdrh   }
42007d10d5a6Sdrh 
42017d10d5a6Sdrh   /* For every "*" that occurs in the column list, insert the names of
42027d10d5a6Sdrh   ** all columns in all tables.  And for every TABLE.* insert the names
42037d10d5a6Sdrh   ** of all columns in TABLE.  The parser inserted a special expression
42047d10d5a6Sdrh   ** with the TK_ALL operator for each "*" that it found in the column list.
42057d10d5a6Sdrh   ** The following code just has to locate the TK_ALL expressions and expand
42067d10d5a6Sdrh   ** each one to the list of all columns in all tables.
42077d10d5a6Sdrh   **
42087d10d5a6Sdrh   ** The first loop just checks to see if there are any "*" operators
42097d10d5a6Sdrh   ** that need expanding.
42107d10d5a6Sdrh   */
42117d10d5a6Sdrh   for(k=0; k<pEList->nExpr; k++){
42123e3f1a5bSdrh     pE = pEList->a[k].pExpr;
42137d10d5a6Sdrh     if( pE->op==TK_ALL ) break;
421443152cf8Sdrh     assert( pE->op!=TK_DOT || pE->pRight!=0 );
421543152cf8Sdrh     assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
421643152cf8Sdrh     if( pE->op==TK_DOT && pE->pRight->op==TK_ALL ) break;
42177d10d5a6Sdrh   }
42187d10d5a6Sdrh   if( k<pEList->nExpr ){
42197d10d5a6Sdrh     /*
42207d10d5a6Sdrh     ** If we get here it means the result set contains one or more "*"
42217d10d5a6Sdrh     ** operators that need to be expanded.  Loop through each expression
42227d10d5a6Sdrh     ** in the result set and expand them one by one.
42237d10d5a6Sdrh     */
42247d10d5a6Sdrh     struct ExprList_item *a = pEList->a;
42257d10d5a6Sdrh     ExprList *pNew = 0;
42267d10d5a6Sdrh     int flags = pParse->db->flags;
42277d10d5a6Sdrh     int longNames = (flags & SQLITE_FullColNames)!=0
422838b384a0Sdrh                       && (flags & SQLITE_ShortColNames)==0;
422938b384a0Sdrh 
423038b384a0Sdrh     /* When processing FROM-clause subqueries, it is always the case
423138b384a0Sdrh     ** that full_column_names=OFF and short_column_names=ON.  The
423238b384a0Sdrh     ** sqlite3ResultSetOfSelect() routine makes it so. */
423338b384a0Sdrh     assert( (p->selFlags & SF_NestedFrom)==0
423438b384a0Sdrh           || ((flags & SQLITE_FullColNames)==0 &&
423538b384a0Sdrh               (flags & SQLITE_ShortColNames)!=0) );
42367d10d5a6Sdrh 
42377d10d5a6Sdrh     for(k=0; k<pEList->nExpr; k++){
42383e3f1a5bSdrh       pE = a[k].pExpr;
42393e3f1a5bSdrh       pRight = pE->pRight;
42403e3f1a5bSdrh       assert( pE->op!=TK_DOT || pRight!=0 );
42413e3f1a5bSdrh       if( pE->op!=TK_ALL && (pE->op!=TK_DOT || pRight->op!=TK_ALL) ){
42427d10d5a6Sdrh         /* This particular expression does not need to be expanded.
42437d10d5a6Sdrh         */
4244b7916a78Sdrh         pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
42457d10d5a6Sdrh         if( pNew ){
42467d10d5a6Sdrh           pNew->a[pNew->nExpr-1].zName = a[k].zName;
4247b7916a78Sdrh           pNew->a[pNew->nExpr-1].zSpan = a[k].zSpan;
4248b7916a78Sdrh           a[k].zName = 0;
4249b7916a78Sdrh           a[k].zSpan = 0;
42507d10d5a6Sdrh         }
42517d10d5a6Sdrh         a[k].pExpr = 0;
42527d10d5a6Sdrh       }else{
42537d10d5a6Sdrh         /* This expression is a "*" or a "TABLE.*" and needs to be
42547d10d5a6Sdrh         ** expanded. */
42557d10d5a6Sdrh         int tableSeen = 0;      /* Set to 1 when TABLE matches */
42563e3f1a5bSdrh         char *zTName = 0;       /* text of name of TABLE */
425743152cf8Sdrh         if( pE->op==TK_DOT ){
425843152cf8Sdrh           assert( pE->pLeft!=0 );
425933e619fcSdrh           assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
426033e619fcSdrh           zTName = pE->pLeft->u.zToken;
42617d10d5a6Sdrh         }
42627d10d5a6Sdrh         for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
42637d10d5a6Sdrh           Table *pTab = pFrom->pTab;
42643e3f1a5bSdrh           Select *pSub = pFrom->pSelect;
42657d10d5a6Sdrh           char *zTabName = pFrom->zAlias;
42663e3f1a5bSdrh           const char *zSchemaName = 0;
4267c75e09c7Sdrh           int iDb;
426843152cf8Sdrh           if( zTabName==0 ){
42697d10d5a6Sdrh             zTabName = pTab->zName;
42707d10d5a6Sdrh           }
42717d10d5a6Sdrh           if( db->mallocFailed ) break;
42723e3f1a5bSdrh           if( pSub==0 || (pSub->selFlags & SF_NestedFrom)==0 ){
42733e3f1a5bSdrh             pSub = 0;
42747d10d5a6Sdrh             if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
42757d10d5a6Sdrh               continue;
42767d10d5a6Sdrh             }
42773e3f1a5bSdrh             iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
4278c75e09c7Sdrh             zSchemaName = iDb>=0 ? db->aDb[iDb].zName : "*";
42793e3f1a5bSdrh           }
42807d10d5a6Sdrh           for(j=0; j<pTab->nCol; j++){
42817d10d5a6Sdrh             char *zName = pTab->aCol[j].zName;
4282b7916a78Sdrh             char *zColname;  /* The computed column name */
4283b7916a78Sdrh             char *zToFree;   /* Malloced string that needs to be freed */
4284b7916a78Sdrh             Token sColname;  /* Computed column name as a token */
42857d10d5a6Sdrh 
4286c75e09c7Sdrh             assert( zName );
42873e3f1a5bSdrh             if( zTName && pSub
42883e3f1a5bSdrh              && sqlite3MatchSpanName(pSub->pEList->a[j].zSpan, 0, zTName, 0)==0
42893e3f1a5bSdrh             ){
42903e3f1a5bSdrh               continue;
42913e3f1a5bSdrh             }
42923e3f1a5bSdrh 
42937d10d5a6Sdrh             /* If a column is marked as 'hidden' (currently only possible
42947d10d5a6Sdrh             ** for virtual tables), do not include it in the expanded
42957d10d5a6Sdrh             ** result-set list.
42967d10d5a6Sdrh             */
42977d10d5a6Sdrh             if( IsHiddenColumn(&pTab->aCol[j]) ){
42987d10d5a6Sdrh               assert(IsVirtual(pTab));
42997d10d5a6Sdrh               continue;
43007d10d5a6Sdrh             }
43013e3f1a5bSdrh             tableSeen = 1;
43027d10d5a6Sdrh 
4303da55c48aSdrh             if( i>0 && zTName==0 ){
43042179b434Sdrh               if( (pFrom->jointype & JT_NATURAL)!=0
43052179b434Sdrh                 && tableAndColumnIndex(pTabList, i, zName, 0, 0)
43062179b434Sdrh               ){
43077d10d5a6Sdrh                 /* In a NATURAL join, omit the join columns from the
43082179b434Sdrh                 ** table to the right of the join */
43097d10d5a6Sdrh                 continue;
43107d10d5a6Sdrh               }
43112179b434Sdrh               if( sqlite3IdListIndex(pFrom->pUsing, zName)>=0 ){
43127d10d5a6Sdrh                 /* In a join with a USING clause, omit columns in the
43137d10d5a6Sdrh                 ** using clause from the table on the right. */
43147d10d5a6Sdrh                 continue;
43157d10d5a6Sdrh               }
43167d10d5a6Sdrh             }
4317b7916a78Sdrh             pRight = sqlite3Expr(db, TK_ID, zName);
4318b7916a78Sdrh             zColname = zName;
4319b7916a78Sdrh             zToFree = 0;
43207d10d5a6Sdrh             if( longNames || pTabList->nSrc>1 ){
4321b7916a78Sdrh               Expr *pLeft;
4322b7916a78Sdrh               pLeft = sqlite3Expr(db, TK_ID, zTabName);
43237d10d5a6Sdrh               pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight, 0);
432438b384a0Sdrh               if( zSchemaName ){
4325c75e09c7Sdrh                 pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
4326c75e09c7Sdrh                 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr, 0);
4327c75e09c7Sdrh               }
4328b7916a78Sdrh               if( longNames ){
4329b7916a78Sdrh                 zColname = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
4330b7916a78Sdrh                 zToFree = zColname;
4331b7916a78Sdrh               }
43327d10d5a6Sdrh             }else{
43337d10d5a6Sdrh               pExpr = pRight;
43347d10d5a6Sdrh             }
4335b7916a78Sdrh             pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
4336b7916a78Sdrh             sColname.z = zColname;
4337b7916a78Sdrh             sColname.n = sqlite3Strlen30(zColname);
4338b7916a78Sdrh             sqlite3ExprListSetName(pParse, pNew, &sColname, 0);
43398f25d18bSdrh             if( pNew && (p->selFlags & SF_NestedFrom)!=0 ){
43403e3f1a5bSdrh               struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
43413e3f1a5bSdrh               if( pSub ){
43423e3f1a5bSdrh                 pX->zSpan = sqlite3DbStrDup(db, pSub->pEList->a[j].zSpan);
4343c75e09c7Sdrh                 testcase( pX->zSpan==0 );
43443e3f1a5bSdrh               }else{
43453e3f1a5bSdrh                 pX->zSpan = sqlite3MPrintf(db, "%s.%s.%s",
43463e3f1a5bSdrh                                            zSchemaName, zTabName, zColname);
4347c75e09c7Sdrh                 testcase( pX->zSpan==0 );
43483e3f1a5bSdrh               }
43493e3f1a5bSdrh               pX->bSpanIsTab = 1;
43508f25d18bSdrh             }
4351b7916a78Sdrh             sqlite3DbFree(db, zToFree);
43527d10d5a6Sdrh           }
43537d10d5a6Sdrh         }
43547d10d5a6Sdrh         if( !tableSeen ){
43557d10d5a6Sdrh           if( zTName ){
43567d10d5a6Sdrh             sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
43577d10d5a6Sdrh           }else{
43587d10d5a6Sdrh             sqlite3ErrorMsg(pParse, "no tables specified");
43597d10d5a6Sdrh           }
43607d10d5a6Sdrh         }
43617d10d5a6Sdrh       }
43627d10d5a6Sdrh     }
43637d10d5a6Sdrh     sqlite3ExprListDelete(db, pEList);
43647d10d5a6Sdrh     p->pEList = pNew;
43657d10d5a6Sdrh   }
43667d10d5a6Sdrh #if SQLITE_MAX_COLUMN
43677d10d5a6Sdrh   if( p->pEList && p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
43687d10d5a6Sdrh     sqlite3ErrorMsg(pParse, "too many columns in result set");
43697d10d5a6Sdrh   }
43707d10d5a6Sdrh #endif
43717d10d5a6Sdrh   return WRC_Continue;
43727d10d5a6Sdrh }
43737d10d5a6Sdrh 
43747d10d5a6Sdrh /*
43757d10d5a6Sdrh ** No-op routine for the parse-tree walker.
43767d10d5a6Sdrh **
43777d10d5a6Sdrh ** When this routine is the Walker.xExprCallback then expression trees
43787d10d5a6Sdrh ** are walked without any actions being taken at each node.  Presumably,
43797d10d5a6Sdrh ** when this routine is used for Walker.xExprCallback then
43807d10d5a6Sdrh ** Walker.xSelectCallback is set to do something useful for every
43817d10d5a6Sdrh ** subquery in the parser tree.
43827d10d5a6Sdrh */
438362c14b34Sdanielk1977 static int exprWalkNoop(Walker *NotUsed, Expr *NotUsed2){
438462c14b34Sdanielk1977   UNUSED_PARAMETER2(NotUsed, NotUsed2);
43857d10d5a6Sdrh   return WRC_Continue;
43867d10d5a6Sdrh }
43877d10d5a6Sdrh 
43887d10d5a6Sdrh /*
43897d10d5a6Sdrh ** This routine "expands" a SELECT statement and all of its subqueries.
43907d10d5a6Sdrh ** For additional information on what it means to "expand" a SELECT
43917d10d5a6Sdrh ** statement, see the comment on the selectExpand worker callback above.
43927d10d5a6Sdrh **
43937d10d5a6Sdrh ** Expanding a SELECT statement is the first step in processing a
43947d10d5a6Sdrh ** SELECT statement.  The SELECT statement must be expanded before
43957d10d5a6Sdrh ** name resolution is performed.
43967d10d5a6Sdrh **
43977d10d5a6Sdrh ** If anything goes wrong, an error message is written into pParse.
43987d10d5a6Sdrh ** The calling function can detect the problem by looking at pParse->nErr
43997d10d5a6Sdrh ** and/or pParse->db->mallocFailed.
44007d10d5a6Sdrh */
44017d10d5a6Sdrh static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
44027d10d5a6Sdrh   Walker w;
4403aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
44047d10d5a6Sdrh   w.xExprCallback = exprWalkNoop;
44057d10d5a6Sdrh   w.pParse = pParse;
4406d58d3278Sdrh   if( pParse->hasCompound ){
4407d58d3278Sdrh     w.xSelectCallback = convertCompoundSelectToSubquery;
44087d10d5a6Sdrh     sqlite3WalkSelect(&w, pSelect);
4409d58d3278Sdrh   }
4410c01b7306Sdrh   w.xSelectCallback = selectExpander;
4411*3afd2b4dSdrh   if( (pSelect->selFlags & SF_AllValues)==0 ){
4412b290f117Sdan     w.xSelectCallback2 = selectPopWith;
4413*3afd2b4dSdrh   }
4414c01b7306Sdrh   sqlite3WalkSelect(&w, pSelect);
44157d10d5a6Sdrh }
44167d10d5a6Sdrh 
44177d10d5a6Sdrh 
44187d10d5a6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
44197d10d5a6Sdrh /*
44207d10d5a6Sdrh ** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
44217d10d5a6Sdrh ** interface.
44227d10d5a6Sdrh **
44237d10d5a6Sdrh ** For each FROM-clause subquery, add Column.zType and Column.zColl
44247d10d5a6Sdrh ** information to the Table structure that represents the result set
44257d10d5a6Sdrh ** of that subquery.
44267d10d5a6Sdrh **
44277d10d5a6Sdrh ** The Table structure that represents the result set was constructed
44287d10d5a6Sdrh ** by selectExpander() but the type and collation information was omitted
44297d10d5a6Sdrh ** at that point because identifiers had not yet been resolved.  This
44307d10d5a6Sdrh ** routine is called after identifier resolution.
44317d10d5a6Sdrh */
4432b290f117Sdan static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
44337d10d5a6Sdrh   Parse *pParse;
44347d10d5a6Sdrh   int i;
44357d10d5a6Sdrh   SrcList *pTabList;
44367d10d5a6Sdrh   struct SrcList_item *pFrom;
44377d10d5a6Sdrh 
44389d8b3072Sdrh   assert( p->selFlags & SF_Resolved );
44395a29d9cbSdrh   if( (p->selFlags & SF_HasTypeInfo)==0 ){
44407d10d5a6Sdrh     p->selFlags |= SF_HasTypeInfo;
44417d10d5a6Sdrh     pParse = pWalker->pParse;
44427d10d5a6Sdrh     pTabList = p->pSrc;
44437d10d5a6Sdrh     for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
44447d10d5a6Sdrh       Table *pTab = pFrom->pTab;
444543152cf8Sdrh       if( ALWAYS(pTab!=0) && (pTab->tabFlags & TF_Ephemeral)!=0 ){
44467d10d5a6Sdrh         /* A sub-query in the FROM clause of a SELECT */
44477d10d5a6Sdrh         Select *pSel = pFrom->pSelect;
44488ce7184bSdan         if( pSel ){
44497d10d5a6Sdrh           while( pSel->pPrior ) pSel = pSel->pPrior;
4450186ad8ccSdrh           selectAddColumnTypeAndCollation(pParse, pTab, pSel);
44517d10d5a6Sdrh         }
44527d10d5a6Sdrh       }
44535a29d9cbSdrh     }
44548ce7184bSdan   }
44557d10d5a6Sdrh }
44567d10d5a6Sdrh #endif
44577d10d5a6Sdrh 
44587d10d5a6Sdrh 
44597d10d5a6Sdrh /*
44607d10d5a6Sdrh ** This routine adds datatype and collating sequence information to
44617d10d5a6Sdrh ** the Table structures of all FROM-clause subqueries in a
44627d10d5a6Sdrh ** SELECT statement.
44637d10d5a6Sdrh **
44647d10d5a6Sdrh ** Use this routine after name resolution.
44657d10d5a6Sdrh */
44667d10d5a6Sdrh static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
44677d10d5a6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
44687d10d5a6Sdrh   Walker w;
4469aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
4470b290f117Sdan   w.xSelectCallback2 = selectAddSubqueryTypeInfo;
44717d10d5a6Sdrh   w.xExprCallback = exprWalkNoop;
44727d10d5a6Sdrh   w.pParse = pParse;
44737d10d5a6Sdrh   sqlite3WalkSelect(&w, pSelect);
44747d10d5a6Sdrh #endif
44757d10d5a6Sdrh }
44767d10d5a6Sdrh 
44777d10d5a6Sdrh 
44787d10d5a6Sdrh /*
4479030796dfSdrh ** This routine sets up a SELECT statement for processing.  The
44807d10d5a6Sdrh ** following is accomplished:
44817d10d5a6Sdrh **
44827d10d5a6Sdrh **     *  VDBE Cursor numbers are assigned to all FROM-clause terms.
44837d10d5a6Sdrh **     *  Ephemeral Table objects are created for all FROM-clause subqueries.
44847d10d5a6Sdrh **     *  ON and USING clauses are shifted into WHERE statements
44857d10d5a6Sdrh **     *  Wildcards "*" and "TABLE.*" in result sets are expanded.
44867d10d5a6Sdrh **     *  Identifiers in expression are matched to tables.
44877d10d5a6Sdrh **
44887d10d5a6Sdrh ** This routine acts recursively on all subqueries within the SELECT.
44897d10d5a6Sdrh */
44907d10d5a6Sdrh void sqlite3SelectPrep(
4491b3bce662Sdanielk1977   Parse *pParse,         /* The parser context */
4492b3bce662Sdanielk1977   Select *p,             /* The SELECT statement being coded. */
44937d10d5a6Sdrh   NameContext *pOuterNC  /* Name context for container */
4494b3bce662Sdanielk1977 ){
44957d10d5a6Sdrh   sqlite3 *db;
449643152cf8Sdrh   if( NEVER(p==0) ) return;
44977d10d5a6Sdrh   db = pParse->db;
4498785097daSdrh   if( db->mallocFailed ) return;
44997d10d5a6Sdrh   if( p->selFlags & SF_HasTypeInfo ) return;
45007d10d5a6Sdrh   sqlite3SelectExpand(pParse, p);
45017d10d5a6Sdrh   if( pParse->nErr || db->mallocFailed ) return;
45027d10d5a6Sdrh   sqlite3ResolveSelectNames(pParse, p, pOuterNC);
45037d10d5a6Sdrh   if( pParse->nErr || db->mallocFailed ) return;
45047d10d5a6Sdrh   sqlite3SelectAddTypeInfo(pParse, p);
4505f6bbe022Sdrh }
4506b3bce662Sdanielk1977 
4507b3bce662Sdanielk1977 /*
450813449892Sdrh ** Reset the aggregate accumulator.
450913449892Sdrh **
451013449892Sdrh ** The aggregate accumulator is a set of memory cells that hold
451113449892Sdrh ** intermediate results while calculating an aggregate.  This
4512030796dfSdrh ** routine generates code that stores NULLs in all of those memory
4513030796dfSdrh ** cells.
4514b3bce662Sdanielk1977 */
451513449892Sdrh static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
451613449892Sdrh   Vdbe *v = pParse->pVdbe;
451713449892Sdrh   int i;
4518c99130fdSdrh   struct AggInfo_func *pFunc;
45197e61d18eSdrh   int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
45207e61d18eSdrh   if( nReg==0 ) return;
45217e61d18eSdrh #ifdef SQLITE_DEBUG
45227e61d18eSdrh   /* Verify that all AggInfo registers are within the range specified by
45237e61d18eSdrh   ** AggInfo.mnReg..AggInfo.mxReg */
45247e61d18eSdrh   assert( nReg==pAggInfo->mxReg-pAggInfo->mnReg+1 );
452513449892Sdrh   for(i=0; i<pAggInfo->nColumn; i++){
45267e61d18eSdrh     assert( pAggInfo->aCol[i].iMem>=pAggInfo->mnReg
45277e61d18eSdrh          && pAggInfo->aCol[i].iMem<=pAggInfo->mxReg );
452813449892Sdrh   }
45297e61d18eSdrh   for(i=0; i<pAggInfo->nFunc; i++){
45307e61d18eSdrh     assert( pAggInfo->aFunc[i].iMem>=pAggInfo->mnReg
45317e61d18eSdrh          && pAggInfo->aFunc[i].iMem<=pAggInfo->mxReg );
45327e61d18eSdrh   }
45337e61d18eSdrh #endif
45347e61d18eSdrh   sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->mnReg, pAggInfo->mxReg);
4535c99130fdSdrh   for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
4536c99130fdSdrh     if( pFunc->iDistinct>=0 ){
4537c99130fdSdrh       Expr *pE = pFunc->pExpr;
45386ab3a2ecSdanielk1977       assert( !ExprHasProperty(pE, EP_xIsSelect) );
45396ab3a2ecSdanielk1977       if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
45400daa002cSdrh         sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
45410daa002cSdrh            "argument");
4542c99130fdSdrh         pFunc->iDistinct = -1;
4543c99130fdSdrh       }else{
4544079a3072Sdrh         KeyInfo *pKeyInfo = keyInfoFromExprList(pParse, pE->x.pList, 0, 0);
454566a5167bSdrh         sqlite3VdbeAddOp4(v, OP_OpenEphemeral, pFunc->iDistinct, 0, 0,
45462ec2fb22Sdrh                           (char*)pKeyInfo, P4_KEYINFO);
4547c99130fdSdrh       }
4548c99130fdSdrh     }
454913449892Sdrh   }
4550b3bce662Sdanielk1977 }
4551b3bce662Sdanielk1977 
4552b3bce662Sdanielk1977 /*
455313449892Sdrh ** Invoke the OP_AggFinalize opcode for every aggregate function
455413449892Sdrh ** in the AggInfo structure.
4555b3bce662Sdanielk1977 */
455613449892Sdrh static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
455713449892Sdrh   Vdbe *v = pParse->pVdbe;
455813449892Sdrh   int i;
455913449892Sdrh   struct AggInfo_func *pF;
456013449892Sdrh   for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
45616ab3a2ecSdanielk1977     ExprList *pList = pF->pExpr->x.pList;
45626ab3a2ecSdanielk1977     assert( !ExprHasProperty(pF->pExpr, EP_xIsSelect) );
456366a5167bSdrh     sqlite3VdbeAddOp4(v, OP_AggFinal, pF->iMem, pList ? pList->nExpr : 0, 0,
456466a5167bSdrh                       (void*)pF->pFunc, P4_FUNCDEF);
4565b3bce662Sdanielk1977   }
456613449892Sdrh }
456713449892Sdrh 
456813449892Sdrh /*
456913449892Sdrh ** Update the accumulator memory cells for an aggregate based on
457013449892Sdrh ** the current cursor position.
457113449892Sdrh */
457213449892Sdrh static void updateAccumulator(Parse *pParse, AggInfo *pAggInfo){
457313449892Sdrh   Vdbe *v = pParse->pVdbe;
457413449892Sdrh   int i;
45757a95789cSdrh   int regHit = 0;
45767a95789cSdrh   int addrHitTest = 0;
457713449892Sdrh   struct AggInfo_func *pF;
457813449892Sdrh   struct AggInfo_col *pC;
457913449892Sdrh 
458013449892Sdrh   pAggInfo->directMode = 1;
458113449892Sdrh   for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
458213449892Sdrh     int nArg;
4583c99130fdSdrh     int addrNext = 0;
458498757157Sdrh     int regAgg;
45856ab3a2ecSdanielk1977     ExprList *pList = pF->pExpr->x.pList;
45866ab3a2ecSdanielk1977     assert( !ExprHasProperty(pF->pExpr, EP_xIsSelect) );
458713449892Sdrh     if( pList ){
458813449892Sdrh       nArg = pList->nExpr;
4589892d3179Sdrh       regAgg = sqlite3GetTempRange(pParse, nArg);
4590d1a01edaSdrh       sqlite3ExprCodeExprList(pParse, pList, regAgg, SQLITE_ECEL_DUP);
459113449892Sdrh     }else{
459213449892Sdrh       nArg = 0;
459398757157Sdrh       regAgg = 0;
459413449892Sdrh     }
4595c99130fdSdrh     if( pF->iDistinct>=0 ){
4596c99130fdSdrh       addrNext = sqlite3VdbeMakeLabel(v);
4597c99130fdSdrh       assert( nArg==1 );
45982dcef11bSdrh       codeDistinct(pParse, pF->iDistinct, addrNext, 1, regAgg);
4599c99130fdSdrh     }
4600d36e1041Sdrh     if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
460113449892Sdrh       CollSeq *pColl = 0;
460213449892Sdrh       struct ExprList_item *pItem;
460313449892Sdrh       int j;
4604e82f5d04Sdrh       assert( pList!=0 );  /* pList!=0 if pF->pFunc has NEEDCOLL */
460543617e9aSdrh       for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
460613449892Sdrh         pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
460713449892Sdrh       }
460813449892Sdrh       if( !pColl ){
460913449892Sdrh         pColl = pParse->db->pDfltColl;
461013449892Sdrh       }
46117a95789cSdrh       if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
46127a95789cSdrh       sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
461313449892Sdrh     }
461498757157Sdrh     sqlite3VdbeAddOp4(v, OP_AggStep, 0, regAgg, pF->iMem,
461566a5167bSdrh                       (void*)pF->pFunc, P4_FUNCDEF);
4616ea678832Sdrh     sqlite3VdbeChangeP5(v, (u8)nArg);
4617da250ea5Sdrh     sqlite3ExprCacheAffinityChange(pParse, regAgg, nArg);
4618f49f3523Sdrh     sqlite3ReleaseTempRange(pParse, regAgg, nArg);
4619c99130fdSdrh     if( addrNext ){
4620c99130fdSdrh       sqlite3VdbeResolveLabel(v, addrNext);
4621ceea3321Sdrh       sqlite3ExprCacheClear(pParse);
4622c99130fdSdrh     }
462313449892Sdrh   }
462467a6a40cSdan 
462567a6a40cSdan   /* Before populating the accumulator registers, clear the column cache.
462667a6a40cSdan   ** Otherwise, if any of the required column values are already present
462767a6a40cSdan   ** in registers, sqlite3ExprCode() may use OP_SCopy to copy the value
462867a6a40cSdan   ** to pC->iMem. But by the time the value is used, the original register
462967a6a40cSdan   ** may have been used, invalidating the underlying buffer holding the
463067a6a40cSdan   ** text or blob value. See ticket [883034dcb5].
463167a6a40cSdan   **
463267a6a40cSdan   ** Another solution would be to change the OP_SCopy used to copy cached
463367a6a40cSdan   ** values to an OP_Copy.
463467a6a40cSdan   */
46357a95789cSdrh   if( regHit ){
4636688852abSdrh     addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
46377a95789cSdrh   }
463867a6a40cSdan   sqlite3ExprCacheClear(pParse);
463913449892Sdrh   for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
4640389a1adbSdrh     sqlite3ExprCode(pParse, pC->pExpr, pC->iMem);
464113449892Sdrh   }
464213449892Sdrh   pAggInfo->directMode = 0;
4643ceea3321Sdrh   sqlite3ExprCacheClear(pParse);
46447a95789cSdrh   if( addrHitTest ){
46457a95789cSdrh     sqlite3VdbeJumpHere(v, addrHitTest);
46467a95789cSdrh   }
464713449892Sdrh }
464813449892Sdrh 
4649b3bce662Sdanielk1977 /*
4650ef7075deSdan ** Add a single OP_Explain instruction to the VDBE to explain a simple
4651ef7075deSdan ** count(*) query ("SELECT count(*) FROM pTab").
4652ef7075deSdan */
4653ef7075deSdan #ifndef SQLITE_OMIT_EXPLAIN
4654ef7075deSdan static void explainSimpleCount(
4655ef7075deSdan   Parse *pParse,                  /* Parse context */
4656ef7075deSdan   Table *pTab,                    /* Table being queried */
4657ef7075deSdan   Index *pIdx                     /* Index used to optimize scan, or NULL */
4658ef7075deSdan ){
4659ef7075deSdan   if( pParse->explain==2 ){
466048dd1d8eSdrh     int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
46618a4380d7Sdrh     char *zEqp = sqlite3MPrintf(pParse->db, "SCAN TABLE %s%s%s",
4662ef7075deSdan         pTab->zName,
4663e96f2df3Sdan         bCover ? " USING COVERING INDEX " : "",
4664e96f2df3Sdan         bCover ? pIdx->zName : ""
4665ef7075deSdan     );
4666ef7075deSdan     sqlite3VdbeAddOp4(
4667ef7075deSdan         pParse->pVdbe, OP_Explain, pParse->iSelectId, 0, 0, zEqp, P4_DYNAMIC
4668ef7075deSdan     );
4669ef7075deSdan   }
4670ef7075deSdan }
4671ef7075deSdan #else
4672ef7075deSdan # define explainSimpleCount(a,b,c)
4673ef7075deSdan #endif
4674ef7075deSdan 
4675ef7075deSdan /*
46767d10d5a6Sdrh ** Generate code for the SELECT statement given in the p argument.
46779bb61fe7Sdrh **
4678340309fdSdrh ** The results are returned according to the SelectDest structure.
4679340309fdSdrh ** See comments in sqliteInt.h for further information.
4680e78e8284Sdrh **
46819bb61fe7Sdrh ** This routine returns the number of errors.  If any errors are
46829bb61fe7Sdrh ** encountered, then an appropriate error message is left in
46839bb61fe7Sdrh ** pParse->zErrMsg.
46849bb61fe7Sdrh **
46859bb61fe7Sdrh ** This routine does NOT free the Select structure passed in.  The
46869bb61fe7Sdrh ** calling function needs to do that.
46879bb61fe7Sdrh */
46884adee20fSdanielk1977 int sqlite3Select(
4689cce7d176Sdrh   Parse *pParse,         /* The parser context */
46909bb61fe7Sdrh   Select *p,             /* The SELECT statement being coded. */
46917d10d5a6Sdrh   SelectDest *pDest      /* What to do with the query results */
4692cce7d176Sdrh ){
469313449892Sdrh   int i, j;              /* Loop counters */
469413449892Sdrh   WhereInfo *pWInfo;     /* Return from sqlite3WhereBegin() */
469513449892Sdrh   Vdbe *v;               /* The virtual machine under construction */
4696b3bce662Sdanielk1977   int isAgg;             /* True for select lists like "count(*)" */
4697a2e00042Sdrh   ExprList *pEList;      /* List of columns to extract. */
4698ad3cab52Sdrh   SrcList *pTabList;     /* List of tables to select from */
46999bb61fe7Sdrh   Expr *pWhere;          /* The WHERE clause.  May be NULL */
47002282792aSdrh   ExprList *pGroupBy;    /* The GROUP BY clause.  May be NULL */
47012282792aSdrh   Expr *pHaving;         /* The HAVING clause.  May be NULL */
47021d83f052Sdrh   int rc = 1;            /* Value to return from this function */
4703e8e4af76Sdrh   DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
4704079a3072Sdrh   SortCtx sSort;         /* Info on how to code the ORDER BY clause */
470513449892Sdrh   AggInfo sAggInfo;      /* Information used by aggregate queries */
4706ec7429aeSdrh   int iEnd;              /* Address of the end of the query */
470717435752Sdrh   sqlite3 *db;           /* The database connection */
47089bb61fe7Sdrh 
47092ce22453Sdan #ifndef SQLITE_OMIT_EXPLAIN
47102ce22453Sdan   int iRestoreSelectId = pParse->iSelectId;
47112ce22453Sdan   pParse->iSelectId = pParse->iNextSelectId++;
47122ce22453Sdan #endif
47132ce22453Sdan 
471417435752Sdrh   db = pParse->db;
471517435752Sdrh   if( p==0 || db->mallocFailed || pParse->nErr ){
47166f7adc8aSdrh     return 1;
47176f7adc8aSdrh   }
47184adee20fSdanielk1977   if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
471913449892Sdrh   memset(&sAggInfo, 0, sizeof(sAggInfo));
4720eb9b884cSdrh #if SELECTTRACE_ENABLED
4721eb9b884cSdrh   pParse->nSelectIndent++;
4722c90713d3Sdrh   SELECTTRACE(1,pParse,p, ("begin processing:\n"));
4723c90713d3Sdrh   if( sqlite3SelectTrace & 0x100 ){
4724c90713d3Sdrh     sqlite3TreeViewSelect(0, p, 0);
4725c90713d3Sdrh   }
4726eb9b884cSdrh #endif
4727daffd0e5Sdrh 
47288e1ee88cSdrh   assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
47298e1ee88cSdrh   assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
47309afccba2Sdan   assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
47319afccba2Sdan   assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
47326c8c8ce0Sdanielk1977   if( IgnorableOrderby(pDest) ){
47339ed1dfa8Sdanielk1977     assert(pDest->eDest==SRT_Exists || pDest->eDest==SRT_Union ||
47349afccba2Sdan            pDest->eDest==SRT_Except || pDest->eDest==SRT_Discard ||
47358e1ee88cSdrh            pDest->eDest==SRT_Queue  || pDest->eDest==SRT_DistFifo ||
47368e1ee88cSdrh            pDest->eDest==SRT_DistQueue || pDest->eDest==SRT_Fifo);
4737ccfcbceaSdrh     /* If ORDER BY makes no difference in the output then neither does
4738ccfcbceaSdrh     ** DISTINCT so it can be removed too. */
4739ccfcbceaSdrh     sqlite3ExprListDelete(db, p->pOrderBy);
4740ccfcbceaSdrh     p->pOrderBy = 0;
47417d10d5a6Sdrh     p->selFlags &= ~SF_Distinct;
47429a99334dSdrh   }
47437d10d5a6Sdrh   sqlite3SelectPrep(pParse, p, 0);
4744079a3072Sdrh   memset(&sSort, 0, sizeof(sSort));
4745079a3072Sdrh   sSort.pOrderBy = p->pOrderBy;
4746b27b7f5dSdrh   pTabList = p->pSrc;
4747b27b7f5dSdrh   pEList = p->pEList;
4748956f4319Sdanielk1977   if( pParse->nErr || db->mallocFailed ){
47499a99334dSdrh     goto select_end;
47509a99334dSdrh   }
47517d10d5a6Sdrh   isAgg = (p->selFlags & SF_Aggregate)!=0;
475243152cf8Sdrh   assert( pEList!=0 );
4753cce7d176Sdrh 
4754d820cb1bSdrh   /* Begin generating code.
4755d820cb1bSdrh   */
47564adee20fSdanielk1977   v = sqlite3GetVdbe(pParse);
4757d820cb1bSdrh   if( v==0 ) goto select_end;
4758d820cb1bSdrh 
475974b617b2Sdan   /* If writing to memory or generating a set
476074b617b2Sdan   ** only a single column may be output.
476174b617b2Sdan   */
476274b617b2Sdan #ifndef SQLITE_OMIT_SUBQUERY
476374b617b2Sdan   if( checkForMultiColumnSelectError(pParse, pDest, pEList->nExpr) ){
476474b617b2Sdan     goto select_end;
476574b617b2Sdan   }
476674b617b2Sdan #endif
476774b617b2Sdan 
4768d820cb1bSdrh   /* Generate code for all sub-queries in the FROM clause
4769d820cb1bSdrh   */
477051522cd3Sdrh #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4771f23329a2Sdanielk1977   for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
477213449892Sdrh     struct SrcList_item *pItem = &pTabList->a[i];
47731013c932Sdrh     SelectDest dest;
4774daf79acbSdanielk1977     Select *pSub = pItem->pSelect;
4775f23329a2Sdanielk1977     int isAggSub;
4776c31c2eb8Sdrh 
47775b6a9ed4Sdrh     if( pSub==0 ) continue;
477821172c4cSdrh 
477921172c4cSdrh     /* Sometimes the code for a subquery will be generated more than
478021172c4cSdrh     ** once, if the subquery is part of the WHERE clause in a LEFT JOIN,
478121172c4cSdrh     ** for example.  In that case, do not regenerate the code to manifest
478221172c4cSdrh     ** a view or the co-routine to implement a view.  The first instance
478321172c4cSdrh     ** is sufficient, though the subroutine to manifest the view does need
478421172c4cSdrh     ** to be invoked again. */
47855b6a9ed4Sdrh     if( pItem->addrFillSub ){
478621172c4cSdrh       if( pItem->viaCoroutine==0 ){
47875b6a9ed4Sdrh         sqlite3VdbeAddOp2(v, OP_Gosub, pItem->regReturn, pItem->addrFillSub);
478821172c4cSdrh       }
47895b6a9ed4Sdrh       continue;
47905b6a9ed4Sdrh     }
4791daf79acbSdanielk1977 
4792fc976065Sdanielk1977     /* Increment Parse.nHeight by the height of the largest expression
4793f7b5496eSdrh     ** tree referred to by this, the parent select. The child select
4794fc976065Sdanielk1977     ** may contain expression trees of at most
4795fc976065Sdanielk1977     ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
4796fc976065Sdanielk1977     ** more conservative than necessary, but much easier than enforcing
4797fc976065Sdanielk1977     ** an exact limit.
4798fc976065Sdanielk1977     */
4799fc976065Sdanielk1977     pParse->nHeight += sqlite3SelectExprHeight(p);
4800daf79acbSdanielk1977 
48017d10d5a6Sdrh     isAggSub = (pSub->selFlags & SF_Aggregate)!=0;
4802524cc21eSdanielk1977     if( flattenSubquery(pParse, p, i, isAgg, isAggSub) ){
48035b6a9ed4Sdrh       /* This subquery can be absorbed into its parent. */
4804f23329a2Sdanielk1977       if( isAggSub ){
48057d10d5a6Sdrh         isAgg = 1;
48067d10d5a6Sdrh         p->selFlags |= SF_Aggregate;
4807daf79acbSdanielk1977       }
4808daf79acbSdanielk1977       i = -1;
4809ee06c99bSdrh     }else if( pTabList->nSrc==1
4810a5759677Sdrh            && OptimizationEnabled(db, SQLITE_SubqCoroutine)
4811a5759677Sdrh     ){
481221172c4cSdrh       /* Implement a co-routine that will return a single row of the result
481321172c4cSdrh       ** set on each invocation.
481421172c4cSdrh       */
4815725de29aSdrh       int addrTop = sqlite3VdbeCurrentAddr(v)+1;
481621172c4cSdrh       pItem->regReturn = ++pParse->nMem;
4817725de29aSdrh       sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
4818725de29aSdrh       VdbeComment((v, "%s", pItem->pTab->zName));
481921172c4cSdrh       pItem->addrFillSub = addrTop;
482021172c4cSdrh       sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
482121172c4cSdrh       explainSetInteger(pItem->iSelectId, (u8)pParse->iNextSelectId);
482221172c4cSdrh       sqlite3Select(pParse, pSub, &dest);
4823cfc9df76Sdan       pItem->pTab->nRowLogEst = sqlite3LogEst(pSub->nSelectRow);
482421172c4cSdrh       pItem->viaCoroutine = 1;
48255f612295Sdrh       pItem->regResult = dest.iSdst;
482681cf13ecSdrh       sqlite3VdbeAddOp1(v, OP_EndCoroutine, pItem->regReturn);
482721172c4cSdrh       sqlite3VdbeJumpHere(v, addrTop-1);
482821172c4cSdrh       sqlite3ClearTempRegCache(pParse);
4829daf79acbSdanielk1977     }else{
48305b6a9ed4Sdrh       /* Generate a subroutine that will fill an ephemeral table with
48315b6a9ed4Sdrh       ** the content of this subquery.  pItem->addrFillSub will point
48325b6a9ed4Sdrh       ** to the address of the generated subroutine.  pItem->regReturn
48335b6a9ed4Sdrh       ** is a register allocated to hold the subroutine return address
48345b6a9ed4Sdrh       */
48357157e8eaSdrh       int topAddr;
483648f2d3b1Sdrh       int onceAddr = 0;
48377157e8eaSdrh       int retAddr;
48385b6a9ed4Sdrh       assert( pItem->addrFillSub==0 );
48395b6a9ed4Sdrh       pItem->regReturn = ++pParse->nMem;
48407157e8eaSdrh       topAddr = sqlite3VdbeAddOp2(v, OP_Integer, 0, pItem->regReturn);
48417157e8eaSdrh       pItem->addrFillSub = topAddr+1;
48421d8cb21fSdan       if( pItem->isCorrelated==0 ){
4843ed17167eSdrh         /* If the subquery is not correlated and if we are not inside of
48445b6a9ed4Sdrh         ** a trigger, then we only need to compute the value of the subquery
48455b6a9ed4Sdrh         ** once. */
48467d176105Sdrh         onceAddr = sqlite3CodeOnce(pParse); VdbeCoverage(v);
4847725de29aSdrh         VdbeComment((v, "materialize \"%s\"", pItem->pTab->zName));
4848725de29aSdrh       }else{
4849725de29aSdrh         VdbeNoopComment((v, "materialize \"%s\"", pItem->pTab->zName));
48505b6a9ed4Sdrh       }
48511013c932Sdrh       sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
4852ce7e189dSdan       explainSetInteger(pItem->iSelectId, (u8)pParse->iNextSelectId);
48537d10d5a6Sdrh       sqlite3Select(pParse, pSub, &dest);
4854cfc9df76Sdan       pItem->pTab->nRowLogEst = sqlite3LogEst(pSub->nSelectRow);
485548f2d3b1Sdrh       if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
48567157e8eaSdrh       retAddr = sqlite3VdbeAddOp1(v, OP_Return, pItem->regReturn);
48577157e8eaSdrh       VdbeComment((v, "end %s", pItem->pTab->zName));
48587157e8eaSdrh       sqlite3VdbeChangeP1(v, topAddr, retAddr);
4859cdc69557Sdrh       sqlite3ClearTempRegCache(pParse);
4860daf79acbSdanielk1977     }
486143152cf8Sdrh     if( /*pParse->nErr ||*/ db->mallocFailed ){
4862cfa063b3Sdrh       goto select_end;
4863cfa063b3Sdrh     }
4864fc976065Sdanielk1977     pParse->nHeight -= sqlite3SelectExprHeight(p);
4865832508b7Sdrh     pTabList = p->pSrc;
48666c8c8ce0Sdanielk1977     if( !IgnorableOrderby(pDest) ){
4867079a3072Sdrh       sSort.pOrderBy = p->pOrderBy;
4868acd4c695Sdrh     }
4869daf79acbSdanielk1977   }
4870daf79acbSdanielk1977   pEList = p->pEList;
4871daf79acbSdanielk1977 #endif
4872daf79acbSdanielk1977   pWhere = p->pWhere;
4873832508b7Sdrh   pGroupBy = p->pGroupBy;
4874832508b7Sdrh   pHaving = p->pHaving;
4875e8e4af76Sdrh   sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
4876832508b7Sdrh 
4877f23329a2Sdanielk1977 #ifndef SQLITE_OMIT_COMPOUND_SELECT
4878f23329a2Sdanielk1977   /* If there is are a sequence of queries, do the earlier ones first.
4879f23329a2Sdanielk1977   */
4880f23329a2Sdanielk1977   if( p->pPrior ){
48817f61e92cSdan     rc = multiSelect(pParse, p, pDest);
488217c0bc0cSdan     explainSetInteger(pParse->iSelectId, iRestoreSelectId);
4883eb9b884cSdrh #if SELECTTRACE_ENABLED
4884eb9b884cSdrh     SELECTTRACE(1,pParse,p,("end compound-select processing\n"));
4885eb9b884cSdrh     pParse->nSelectIndent--;
4886eb9b884cSdrh #endif
48877f61e92cSdan     return rc;
4888f23329a2Sdanielk1977   }
4889f23329a2Sdanielk1977 #endif
4890f23329a2Sdanielk1977 
489150118cdfSdan   /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
489250118cdfSdan   ** if the select-list is the same as the ORDER BY list, then this query
489350118cdfSdan   ** can be rewritten as a GROUP BY. In other words, this:
489450118cdfSdan   **
489550118cdfSdan   **     SELECT DISTINCT xyz FROM ... ORDER BY xyz
489650118cdfSdan   **
489750118cdfSdan   ** is transformed to:
489850118cdfSdan   **
4899dea7d70dSdrh   **     SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
490050118cdfSdan   **
490150118cdfSdan   ** The second form is preferred as a single index (or temp-table) may be
490250118cdfSdan   ** used for both the ORDER BY and DISTINCT processing. As originally
490350118cdfSdan   ** written the query must use a temp-table for at least one of the ORDER
490450118cdfSdan   ** BY and DISTINCT, and an index or separate temp-table for the other.
490550118cdfSdan   */
490650118cdfSdan   if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
4907079a3072Sdrh    && sqlite3ExprListCompare(sSort.pOrderBy, p->pEList, -1)==0
490850118cdfSdan   ){
490950118cdfSdan     p->selFlags &= ~SF_Distinct;
491050118cdfSdan     p->pGroupBy = sqlite3ExprListDup(db, p->pEList, 0);
491150118cdfSdan     pGroupBy = p->pGroupBy;
4912e8e4af76Sdrh     /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
4913e8e4af76Sdrh     ** the sDistinct.isTnct is still set.  Hence, isTnct represents the
4914e8e4af76Sdrh     ** original setting of the SF_Distinct flag, not the current setting */
4915e8e4af76Sdrh     assert( sDistinct.isTnct );
491650118cdfSdan   }
491750118cdfSdan 
49188b4c40d8Sdrh   /* If there is an ORDER BY clause, then this sorting
49198b4c40d8Sdrh   ** index might end up being unused if the data can be
49209d2985c7Sdrh   ** extracted in pre-sorted order.  If that is the case, then the
4921b9bb7c18Sdrh   ** OP_OpenEphemeral instruction will be changed to an OP_Noop once
49229d2985c7Sdrh   ** we figure out that the sorting index is not needed.  The addrSortIndex
49239d2985c7Sdrh   ** variable is used to facilitate that change.
49247cedc8d4Sdanielk1977   */
4925079a3072Sdrh   if( sSort.pOrderBy ){
49260342b1f5Sdrh     KeyInfo *pKeyInfo;
4927079a3072Sdrh     pKeyInfo = keyInfoFromExprList(pParse, sSort.pOrderBy, 0, 0);
4928079a3072Sdrh     sSort.iECursor = pParse->nTab++;
4929079a3072Sdrh     sSort.addrSortIndex =
493066a5167bSdrh       sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
4931f45f2326Sdrh           sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
4932f45f2326Sdrh           (char*)pKeyInfo, P4_KEYINFO
4933f45f2326Sdrh       );
49349d2985c7Sdrh   }else{
4935079a3072Sdrh     sSort.addrSortIndex = -1;
49367cedc8d4Sdanielk1977   }
49377cedc8d4Sdanielk1977 
49382d0794e3Sdrh   /* If the output is destined for a temporary table, open that table.
49392d0794e3Sdrh   */
49406c8c8ce0Sdanielk1977   if( pDest->eDest==SRT_EphemTab ){
49412b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
49422d0794e3Sdrh   }
49432d0794e3Sdrh 
4944f42bacc2Sdrh   /* Set the limiter.
4945f42bacc2Sdrh   */
4946f42bacc2Sdrh   iEnd = sqlite3VdbeMakeLabel(v);
4947c63367efSdrh   p->nSelectRow = LARGEST_INT64;
4948f42bacc2Sdrh   computeLimitRegisters(pParse, p, iEnd);
4949079a3072Sdrh   if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
4950079a3072Sdrh     sqlite3VdbeGetOp(v, sSort.addrSortIndex)->opcode = OP_SorterOpen;
4951079a3072Sdrh     sSort.sortFlags |= SORTFLAG_UseSorter;
4952c6aff30cSdrh   }
4953f42bacc2Sdrh 
4954dece1a84Sdrh   /* Open a virtual index to use for the distinct set.
4955cce7d176Sdrh   */
49562ce22453Sdan   if( p->selFlags & SF_Distinct ){
4957e8e4af76Sdrh     sDistinct.tabTnct = pParse->nTab++;
4958e8e4af76Sdrh     sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
4959e8e4af76Sdrh                                 sDistinct.tabTnct, 0, 0,
4960079a3072Sdrh                                 (char*)keyInfoFromExprList(pParse, p->pEList,0,0),
49612ec2fb22Sdrh                                 P4_KEYINFO);
4962d4187c71Sdrh     sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
4963e8e4af76Sdrh     sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
4964832508b7Sdrh   }else{
4965e8e4af76Sdrh     sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
4966efb7251dSdrh   }
4967832508b7Sdrh 
496813449892Sdrh   if( !isAgg && pGroupBy==0 ){
4969e8e4af76Sdrh     /* No aggregate functions and no GROUP BY clause */
49706457a353Sdrh     u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0);
497138cc40c2Sdan 
497238cc40c2Sdan     /* Begin the database scan. */
4973079a3072Sdrh     pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
4974079a3072Sdrh                                p->pEList, wctrlFlags, 0);
49751d83f052Sdrh     if( pWInfo==0 ) goto select_end;
49766f32848dSdrh     if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
49776f32848dSdrh       p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
49786f32848dSdrh     }
49796457a353Sdrh     if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
49806f32848dSdrh       sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
49816f32848dSdrh     }
4982079a3072Sdrh     if( sSort.pOrderBy ){
4983079a3072Sdrh       sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
4984079a3072Sdrh       if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
4985079a3072Sdrh         sSort.pOrderBy = 0;
4986079a3072Sdrh       }
4987079a3072Sdrh     }
4988cce7d176Sdrh 
4989b9bb7c18Sdrh     /* If sorting index that was created by a prior OP_OpenEphemeral
4990b9bb7c18Sdrh     ** instruction ended up not being needed, then change the OP_OpenEphemeral
49919d2985c7Sdrh     ** into an OP_Noop.
49929d2985c7Sdrh     */
4993079a3072Sdrh     if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
4994079a3072Sdrh       sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
49959d2985c7Sdrh     }
49969d2985c7Sdrh 
499738cc40c2Sdan     /* Use the standard inner loop. */
4998079a3072Sdrh     selectInnerLoop(pParse, p, pEList, -1, &sSort, &sDistinct, pDest,
49996f32848dSdrh                     sqlite3WhereContinueLabel(pWInfo),
50006f32848dSdrh                     sqlite3WhereBreakLabel(pWInfo));
50012282792aSdrh 
5002cce7d176Sdrh     /* End the database scan loop.
5003cce7d176Sdrh     */
50044adee20fSdanielk1977     sqlite3WhereEnd(pWInfo);
500513449892Sdrh   }else{
5006e8e4af76Sdrh     /* This case when there exist aggregate functions or a GROUP BY clause
5007e8e4af76Sdrh     ** or both */
500813449892Sdrh     NameContext sNC;    /* Name context for processing aggregate information */
500913449892Sdrh     int iAMem;          /* First Mem address for storing current GROUP BY */
501013449892Sdrh     int iBMem;          /* First Mem address for previous GROUP BY */
501113449892Sdrh     int iUseFlag;       /* Mem address holding flag indicating that at least
501213449892Sdrh                         ** one row of the input to the aggregator has been
501313449892Sdrh                         ** processed */
501413449892Sdrh     int iAbortFlag;     /* Mem address which causes query abort if positive */
501513449892Sdrh     int groupBySort;    /* Rows come from source in GROUP BY order */
5016d176611bSdrh     int addrEnd;        /* End of processing for this SELECT */
50171c9d835dSdrh     int sortPTab = 0;   /* Pseudotable used to decode sorting results */
50181c9d835dSdrh     int sortOut = 0;    /* Output register from the sorter */
5019374cd78cSdan     int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
5020d176611bSdrh 
5021d176611bSdrh     /* Remove any and all aliases between the result set and the
5022d176611bSdrh     ** GROUP BY clause.
5023d176611bSdrh     */
5024d176611bSdrh     if( pGroupBy ){
5025dc5ea5c7Sdrh       int k;                        /* Loop counter */
5026d176611bSdrh       struct ExprList_item *pItem;  /* For looping over expression in a list */
5027d176611bSdrh 
5028dc5ea5c7Sdrh       for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
5029c2acc4e4Sdrh         pItem->u.x.iAlias = 0;
5030d176611bSdrh       }
5031dc5ea5c7Sdrh       for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
5032c2acc4e4Sdrh         pItem->u.x.iAlias = 0;
5033d176611bSdrh       }
5034c63367efSdrh       if( p->nSelectRow>100 ) p->nSelectRow = 100;
503595aa47b1Sdrh     }else{
5036c63367efSdrh       p->nSelectRow = 1;
5037d176611bSdrh     }
5038cce7d176Sdrh 
503913449892Sdrh 
5040374cd78cSdan     /* If there is both a GROUP BY and an ORDER BY clause and they are
5041374cd78cSdan     ** identical, then it may be possible to disable the ORDER BY clause
5042374cd78cSdan     ** on the grounds that the GROUP BY will cause elements to come out
5043374cd78cSdan     ** in the correct order. It also may not - the GROUP BY may use a
5044374cd78cSdan     ** database index that causes rows to be grouped together as required
5045374cd78cSdan     ** but not actually sorted. Either way, record the fact that the
5046374cd78cSdan     ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
5047374cd78cSdan     ** variable.  */
5048374cd78cSdan     if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
5049374cd78cSdan       orderByGrp = 1;
5050374cd78cSdan     }
5051374cd78cSdan 
5052d176611bSdrh     /* Create a label to jump to when we want to abort the query */
505313449892Sdrh     addrEnd = sqlite3VdbeMakeLabel(v);
505413449892Sdrh 
505513449892Sdrh     /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
505613449892Sdrh     ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
505713449892Sdrh     ** SELECT statement.
50582282792aSdrh     */
505913449892Sdrh     memset(&sNC, 0, sizeof(sNC));
506013449892Sdrh     sNC.pParse = pParse;
506113449892Sdrh     sNC.pSrcList = pTabList;
506213449892Sdrh     sNC.pAggInfo = &sAggInfo;
50637e61d18eSdrh     sAggInfo.mnReg = pParse->nMem+1;
5064dd23c6bfSdan     sAggInfo.nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
50659d2985c7Sdrh     sAggInfo.pGroupBy = pGroupBy;
5066d2b3e23bSdrh     sqlite3ExprAnalyzeAggList(&sNC, pEList);
5067079a3072Sdrh     sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
5068d2b3e23bSdrh     if( pHaving ){
5069d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
507013449892Sdrh     }
507113449892Sdrh     sAggInfo.nAccumulator = sAggInfo.nColumn;
507213449892Sdrh     for(i=0; i<sAggInfo.nFunc; i++){
50736ab3a2ecSdanielk1977       assert( !ExprHasProperty(sAggInfo.aFunc[i].pExpr, EP_xIsSelect) );
50743a8c4be7Sdrh       sNC.ncFlags |= NC_InAggFunc;
50756ab3a2ecSdanielk1977       sqlite3ExprAnalyzeAggList(&sNC, sAggInfo.aFunc[i].pExpr->x.pList);
50763a8c4be7Sdrh       sNC.ncFlags &= ~NC_InAggFunc;
507713449892Sdrh     }
50787e61d18eSdrh     sAggInfo.mxReg = pParse->nMem;
507917435752Sdrh     if( db->mallocFailed ) goto select_end;
508013449892Sdrh 
508113449892Sdrh     /* Processing for aggregates with GROUP BY is very different and
50823c4809a2Sdanielk1977     ** much more complex than aggregates without a GROUP BY.
508313449892Sdrh     */
508413449892Sdrh     if( pGroupBy ){
508513449892Sdrh       KeyInfo *pKeyInfo;  /* Keying information for the group by clause */
5086d176611bSdrh       int j1;             /* A-vs-B comparision jump */
5087d176611bSdrh       int addrOutputRow;  /* Start of subroutine that outputs a result row */
5088d176611bSdrh       int regOutputRow;   /* Return address register for output subroutine */
5089d176611bSdrh       int addrSetAbort;   /* Set the abort flag and return */
5090d176611bSdrh       int addrTopOfLoop;  /* Top of the input loop */
5091d176611bSdrh       int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
5092d176611bSdrh       int addrReset;      /* Subroutine for resetting the accumulator */
5093d176611bSdrh       int regReset;       /* Return address register for reset subroutine */
509413449892Sdrh 
509513449892Sdrh       /* If there is a GROUP BY clause we might need a sorting index to
509613449892Sdrh       ** implement it.  Allocate that sorting index now.  If it turns out
50971c9d835dSdrh       ** that we do not need it after all, the OP_SorterOpen instruction
509813449892Sdrh       ** will be converted into a Noop.
509913449892Sdrh       */
510013449892Sdrh       sAggInfo.sortingIdx = pParse->nTab++;
5101079a3072Sdrh       pKeyInfo = keyInfoFromExprList(pParse, pGroupBy, 0, 0);
51021c9d835dSdrh       addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
5103cd3e8f7cSdanielk1977           sAggInfo.sortingIdx, sAggInfo.nSortingColumn,
51042ec2fb22Sdrh           0, (char*)pKeyInfo, P4_KEYINFO);
510513449892Sdrh 
510613449892Sdrh       /* Initialize memory locations used by GROUP BY aggregate processing
510713449892Sdrh       */
51080a07c107Sdrh       iUseFlag = ++pParse->nMem;
51090a07c107Sdrh       iAbortFlag = ++pParse->nMem;
5110d176611bSdrh       regOutputRow = ++pParse->nMem;
5111d176611bSdrh       addrOutputRow = sqlite3VdbeMakeLabel(v);
5112d176611bSdrh       regReset = ++pParse->nMem;
5113d176611bSdrh       addrReset = sqlite3VdbeMakeLabel(v);
51140a07c107Sdrh       iAMem = pParse->nMem + 1;
511513449892Sdrh       pParse->nMem += pGroupBy->nExpr;
51160a07c107Sdrh       iBMem = pParse->nMem + 1;
511713449892Sdrh       pParse->nMem += pGroupBy->nExpr;
51184c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
5119d4e70ebdSdrh       VdbeComment((v, "clear abort flag"));
51204c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
5121d4e70ebdSdrh       VdbeComment((v, "indicate accumulator empty"));
5122b8475df8Sdrh       sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
5123e313382eSdrh 
512413449892Sdrh       /* Begin a loop that will extract all source rows in GROUP BY order.
512513449892Sdrh       ** This might involve two separate loops with an OP_Sort in between, or
512613449892Sdrh       ** it might be a single loop that uses an index to extract information
512713449892Sdrh       ** in the right order to begin with.
512813449892Sdrh       */
51292eb95377Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
513093ec45d5Sdrh       pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, 0,
5131374cd78cSdan           WHERE_GROUPBY | (orderByGrp ? WHERE_SORTBYGROUP : 0), 0
5132374cd78cSdan       );
51335360ad34Sdrh       if( pWInfo==0 ) goto select_end;
5134ddba0c22Sdrh       if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
513513449892Sdrh         /* The optimizer is able to deliver rows in group by order so
5136b9bb7c18Sdrh         ** we do not have to sort.  The OP_OpenEphemeral table will be
513713449892Sdrh         ** cancelled later because we still need to use the pKeyInfo
513813449892Sdrh         */
513913449892Sdrh         groupBySort = 0;
514013449892Sdrh       }else{
514113449892Sdrh         /* Rows are coming out in undetermined order.  We have to push
514213449892Sdrh         ** each row into a sorting index, terminate the first loop,
514313449892Sdrh         ** then loop over the sorting index in order to get the output
514413449892Sdrh         ** in sorted order
514513449892Sdrh         */
5146892d3179Sdrh         int regBase;
5147892d3179Sdrh         int regRecord;
5148892d3179Sdrh         int nCol;
5149892d3179Sdrh         int nGroupBy;
5150892d3179Sdrh 
51512ce22453Sdan         explainTempTable(pParse,
5152e8e4af76Sdrh             (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
5153e8e4af76Sdrh                     "DISTINCT" : "GROUP BY");
51542ce22453Sdan 
515513449892Sdrh         groupBySort = 1;
5156892d3179Sdrh         nGroupBy = pGroupBy->nExpr;
5157dd23c6bfSdan         nCol = nGroupBy;
5158dd23c6bfSdan         j = nGroupBy;
515913449892Sdrh         for(i=0; i<sAggInfo.nColumn; i++){
5160892d3179Sdrh           if( sAggInfo.aCol[i].iSorterColumn>=j ){
5161892d3179Sdrh             nCol++;
516213449892Sdrh             j++;
516313449892Sdrh           }
5164892d3179Sdrh         }
5165892d3179Sdrh         regBase = sqlite3GetTempRange(pParse, nCol);
5166ceea3321Sdrh         sqlite3ExprCacheClear(pParse);
5167191b54cbSdrh         sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0);
5168dd23c6bfSdan         j = nGroupBy;
5169892d3179Sdrh         for(i=0; i<sAggInfo.nColumn; i++){
5170892d3179Sdrh           struct AggInfo_col *pCol = &sAggInfo.aCol[i];
5171892d3179Sdrh           if( pCol->iSorterColumn>=j ){
5172e55cbd72Sdrh             int r1 = j + regBase;
51736a012f04Sdrh             int r2;
5174701bb3b4Sdrh 
51756a012f04Sdrh             r2 = sqlite3ExprCodeGetColumn(pParse,
5176a748fdccSdrh                                pCol->pTab, pCol->iColumn, pCol->iTable, r1, 0);
51776a012f04Sdrh             if( r1!=r2 ){
51786a012f04Sdrh               sqlite3VdbeAddOp2(v, OP_SCopy, r2, r1);
51796a012f04Sdrh             }
51806a012f04Sdrh             j++;
5181892d3179Sdrh           }
5182892d3179Sdrh         }
5183892d3179Sdrh         regRecord = sqlite3GetTempReg(pParse);
51841db639ceSdrh         sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
51851c9d835dSdrh         sqlite3VdbeAddOp2(v, OP_SorterInsert, sAggInfo.sortingIdx, regRecord);
5186892d3179Sdrh         sqlite3ReleaseTempReg(pParse, regRecord);
5187892d3179Sdrh         sqlite3ReleaseTempRange(pParse, regBase, nCol);
518813449892Sdrh         sqlite3WhereEnd(pWInfo);
51895134d135Sdan         sAggInfo.sortingIdxPTab = sortPTab = pParse->nTab++;
51901c9d835dSdrh         sortOut = sqlite3GetTempReg(pParse);
51911c9d835dSdrh         sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
51921c9d835dSdrh         sqlite3VdbeAddOp2(v, OP_SorterSort, sAggInfo.sortingIdx, addrEnd);
5193688852abSdrh         VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
519413449892Sdrh         sAggInfo.useSortingIdx = 1;
5195ceea3321Sdrh         sqlite3ExprCacheClear(pParse);
5196374cd78cSdan 
5197374cd78cSdan       }
5198374cd78cSdan 
5199374cd78cSdan       /* If the index or temporary table used by the GROUP BY sort
5200374cd78cSdan       ** will naturally deliver rows in the order required by the ORDER BY
5201374cd78cSdan       ** clause, cancel the ephemeral table open coded earlier.
5202374cd78cSdan       **
5203374cd78cSdan       ** This is an optimization - the correct answer should result regardless.
5204374cd78cSdan       ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
5205374cd78cSdan       ** disable this optimization for testing purposes.  */
5206374cd78cSdan       if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
5207374cd78cSdan        && (groupBySort || sqlite3WhereIsSorted(pWInfo))
5208374cd78cSdan       ){
5209374cd78cSdan         sSort.pOrderBy = 0;
5210374cd78cSdan         sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
521113449892Sdrh       }
521213449892Sdrh 
521313449892Sdrh       /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
521413449892Sdrh       ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
521513449892Sdrh       ** Then compare the current GROUP BY terms against the GROUP BY terms
521613449892Sdrh       ** from the previous row currently stored in a0, a1, a2...
521713449892Sdrh       */
521813449892Sdrh       addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
5219ceea3321Sdrh       sqlite3ExprCacheClear(pParse);
52201c9d835dSdrh       if( groupBySort ){
52216cf4a7dfSdrh         sqlite3VdbeAddOp3(v, OP_SorterData, sAggInfo.sortingIdx, sortOut,sortPTab);
52221c9d835dSdrh       }
522313449892Sdrh       for(j=0; j<pGroupBy->nExpr; j++){
522413449892Sdrh         if( groupBySort ){
52251c9d835dSdrh           sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
522613449892Sdrh         }else{
522713449892Sdrh           sAggInfo.directMode = 1;
52282dcef11bSdrh           sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
522913449892Sdrh         }
523013449892Sdrh       }
523116ee60ffSdrh       sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
52322ec2fb22Sdrh                           (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
523316ee60ffSdrh       j1 = sqlite3VdbeCurrentAddr(v);
5234688852abSdrh       sqlite3VdbeAddOp3(v, OP_Jump, j1+1, 0, j1+1); VdbeCoverage(v);
523513449892Sdrh 
523613449892Sdrh       /* Generate code that runs whenever the GROUP BY changes.
5237e00ee6ebSdrh       ** Changes in the GROUP BY are detected by the previous code
523813449892Sdrh       ** block.  If there were no changes, this block is skipped.
523913449892Sdrh       **
524013449892Sdrh       ** This code copies current group by terms in b0,b1,b2,...
524113449892Sdrh       ** over to a0,a1,a2.  It then calls the output subroutine
524213449892Sdrh       ** and resets the aggregate accumulator registers in preparation
524313449892Sdrh       ** for the next GROUP BY batch.
524413449892Sdrh       */
5245b21e7c70Sdrh       sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
52462eb95377Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
5247d4e70ebdSdrh       VdbeComment((v, "output one row"));
5248688852abSdrh       sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
5249d4e70ebdSdrh       VdbeComment((v, "check abort flag"));
52502eb95377Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
5251d4e70ebdSdrh       VdbeComment((v, "reset accumulator"));
525213449892Sdrh 
525313449892Sdrh       /* Update the aggregate accumulators based on the content of
525413449892Sdrh       ** the current row
525513449892Sdrh       */
525616ee60ffSdrh       sqlite3VdbeJumpHere(v, j1);
525713449892Sdrh       updateAccumulator(pParse, &sAggInfo);
52584c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
5259d4e70ebdSdrh       VdbeComment((v, "indicate data in accumulator"));
526013449892Sdrh 
526113449892Sdrh       /* End of the loop
526213449892Sdrh       */
526313449892Sdrh       if( groupBySort ){
52641c9d835dSdrh         sqlite3VdbeAddOp2(v, OP_SorterNext, sAggInfo.sortingIdx, addrTopOfLoop);
5265688852abSdrh         VdbeCoverage(v);
526613449892Sdrh       }else{
526713449892Sdrh         sqlite3WhereEnd(pWInfo);
526848f2d3b1Sdrh         sqlite3VdbeChangeToNoop(v, addrSortingIdx);
526913449892Sdrh       }
527013449892Sdrh 
527113449892Sdrh       /* Output the final row of result
527213449892Sdrh       */
52732eb95377Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
5274d4e70ebdSdrh       VdbeComment((v, "output final row"));
527513449892Sdrh 
5276d176611bSdrh       /* Jump over the subroutines
5277d176611bSdrh       */
5278d176611bSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, addrEnd);
5279d176611bSdrh 
5280d176611bSdrh       /* Generate a subroutine that outputs a single row of the result
5281d176611bSdrh       ** set.  This subroutine first looks at the iUseFlag.  If iUseFlag
5282d176611bSdrh       ** is less than or equal to zero, the subroutine is a no-op.  If
5283d176611bSdrh       ** the processing calls for the query to abort, this subroutine
5284d176611bSdrh       ** increments the iAbortFlag memory location before returning in
5285d176611bSdrh       ** order to signal the caller to abort.
5286d176611bSdrh       */
5287d176611bSdrh       addrSetAbort = sqlite3VdbeCurrentAddr(v);
5288d176611bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
5289d176611bSdrh       VdbeComment((v, "set abort flag"));
5290d176611bSdrh       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
5291d176611bSdrh       sqlite3VdbeResolveLabel(v, addrOutputRow);
5292d176611bSdrh       addrOutputRow = sqlite3VdbeCurrentAddr(v);
5293688852abSdrh       sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2); VdbeCoverage(v);
5294d176611bSdrh       VdbeComment((v, "Groupby result generator entry point"));
5295d176611bSdrh       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
5296d176611bSdrh       finalizeAggFunctions(pParse, &sAggInfo);
5297d176611bSdrh       sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
5298079a3072Sdrh       selectInnerLoop(pParse, p, p->pEList, -1, &sSort,
5299e8e4af76Sdrh                       &sDistinct, pDest,
5300d176611bSdrh                       addrOutputRow+1, addrSetAbort);
5301d176611bSdrh       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
5302d176611bSdrh       VdbeComment((v, "end groupby result generator"));
5303d176611bSdrh 
5304d176611bSdrh       /* Generate a subroutine that will reset the group-by accumulator
5305d176611bSdrh       */
5306d176611bSdrh       sqlite3VdbeResolveLabel(v, addrReset);
5307d176611bSdrh       resetAccumulator(pParse, &sAggInfo);
5308d176611bSdrh       sqlite3VdbeAddOp1(v, OP_Return, regReset);
5309d176611bSdrh 
531043152cf8Sdrh     } /* endif pGroupBy.  Begin aggregate queries without GROUP BY: */
531113449892Sdrh     else {
5312dba0137eSdanielk1977       ExprList *pDel = 0;
5313a5533162Sdanielk1977 #ifndef SQLITE_OMIT_BTREECOUNT
5314a5533162Sdanielk1977       Table *pTab;
5315a5533162Sdanielk1977       if( (pTab = isSimpleCount(p, &sAggInfo))!=0 ){
5316a5533162Sdanielk1977         /* If isSimpleCount() returns a pointer to a Table structure, then
5317a5533162Sdanielk1977         ** the SQL statement is of the form:
5318a5533162Sdanielk1977         **
5319a5533162Sdanielk1977         **   SELECT count(*) FROM <tbl>
5320a5533162Sdanielk1977         **
5321a5533162Sdanielk1977         ** where the Table structure returned represents table <tbl>.
5322a5533162Sdanielk1977         **
5323a5533162Sdanielk1977         ** This statement is so common that it is optimized specially. The
5324a5533162Sdanielk1977         ** OP_Count instruction is executed either on the intkey table that
5325a5533162Sdanielk1977         ** contains the data for table <tbl> or on one of its indexes. It
5326a5533162Sdanielk1977         ** is better to execute the op on an index, as indexes are almost
5327a5533162Sdanielk1977         ** always spread across less pages than their corresponding tables.
5328a5533162Sdanielk1977         */
5329a5533162Sdanielk1977         const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
5330a5533162Sdanielk1977         const int iCsr = pParse->nTab++;     /* Cursor to scan b-tree */
5331a5533162Sdanielk1977         Index *pIdx;                         /* Iterator variable */
5332a5533162Sdanielk1977         KeyInfo *pKeyInfo = 0;               /* Keyinfo for scanned index */
5333a5533162Sdanielk1977         Index *pBest = 0;                    /* Best index found so far */
5334a5533162Sdanielk1977         int iRoot = pTab->tnum;              /* Root page of scanned b-tree */
5335a9d1ccb9Sdanielk1977 
5336a5533162Sdanielk1977         sqlite3CodeVerifySchema(pParse, iDb);
5337a5533162Sdanielk1977         sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
5338a5533162Sdanielk1977 
5339d9e3cad2Sdrh         /* Search for the index that has the lowest scan cost.
5340a5533162Sdanielk1977         **
53413e9548b3Sdrh         ** (2011-04-15) Do not do a full scan of an unordered index.
53423e9548b3Sdrh         **
5343abcc1941Sdrh         ** (2013-10-03) Do not count the entries in a partial index.
53445f33f375Sdrh         **
5345a5533162Sdanielk1977         ** In practice the KeyInfo structure will not be used. It is only
5346a5533162Sdanielk1977         ** passed to keep OP_OpenRead happy.
5347a5533162Sdanielk1977         */
53485c7917e4Sdrh         if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
5349a5533162Sdanielk1977         for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
5350d9e3cad2Sdrh           if( pIdx->bUnordered==0
5351e13e9f54Sdrh            && pIdx->szIdxRow<pTab->szTabRow
5352d3037a41Sdrh            && pIdx->pPartIdxWhere==0
5353e13e9f54Sdrh            && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
5354d9e3cad2Sdrh           ){
5355a5533162Sdanielk1977             pBest = pIdx;
5356a5533162Sdanielk1977           }
5357a5533162Sdanielk1977         }
5358d9e3cad2Sdrh         if( pBest ){
5359a5533162Sdanielk1977           iRoot = pBest->tnum;
53602ec2fb22Sdrh           pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
5361a5533162Sdanielk1977         }
5362a5533162Sdanielk1977 
5363a5533162Sdanielk1977         /* Open a read-only cursor, execute the OP_Count, close the cursor. */
5364261c02d9Sdrh         sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, iRoot, iDb, 1);
5365a5533162Sdanielk1977         if( pKeyInfo ){
53662ec2fb22Sdrh           sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
5367a5533162Sdanielk1977         }
5368a5533162Sdanielk1977         sqlite3VdbeAddOp2(v, OP_Count, iCsr, sAggInfo.aFunc[0].iMem);
5369a5533162Sdanielk1977         sqlite3VdbeAddOp1(v, OP_Close, iCsr);
5370ef7075deSdan         explainSimpleCount(pParse, pTab, pBest);
5371a5533162Sdanielk1977       }else
5372a5533162Sdanielk1977 #endif /* SQLITE_OMIT_BTREECOUNT */
5373a5533162Sdanielk1977       {
5374738bdcfbSdanielk1977         /* Check if the query is of one of the following forms:
5375738bdcfbSdanielk1977         **
5376738bdcfbSdanielk1977         **   SELECT min(x) FROM ...
5377738bdcfbSdanielk1977         **   SELECT max(x) FROM ...
5378738bdcfbSdanielk1977         **
5379738bdcfbSdanielk1977         ** If it is, then ask the code in where.c to attempt to sort results
5380738bdcfbSdanielk1977         ** as if there was an "ORDER ON x" or "ORDER ON x DESC" clause.
5381738bdcfbSdanielk1977         ** If where.c is able to produce results sorted in this order, then
5382738bdcfbSdanielk1977         ** add vdbe code to break out of the processing loop after the
5383738bdcfbSdanielk1977         ** first iteration (since the first iteration of the loop is
5384738bdcfbSdanielk1977         ** guaranteed to operate on the row with the minimum or maximum
5385738bdcfbSdanielk1977         ** value of x, the only row required).
5386738bdcfbSdanielk1977         **
5387738bdcfbSdanielk1977         ** A special flag must be passed to sqlite3WhereBegin() to slightly
538848864df9Smistachkin         ** modify behavior as follows:
5389738bdcfbSdanielk1977         **
5390738bdcfbSdanielk1977         **   + If the query is a "SELECT min(x)", then the loop coded by
5391738bdcfbSdanielk1977         **     where.c should not iterate over any values with a NULL value
5392738bdcfbSdanielk1977         **     for x.
5393738bdcfbSdanielk1977         **
5394738bdcfbSdanielk1977         **   + The optimizer code in where.c (the thing that decides which
5395738bdcfbSdanielk1977         **     index or indices to use) should place a different priority on
5396738bdcfbSdanielk1977         **     satisfying the 'ORDER BY' clause than it does in other cases.
5397738bdcfbSdanielk1977         **     Refer to code and comments in where.c for details.
5398738bdcfbSdanielk1977         */
5399a5533162Sdanielk1977         ExprList *pMinMax = 0;
54004ac391fcSdan         u8 flag = WHERE_ORDERBY_NORMAL;
54014ac391fcSdan 
54024ac391fcSdan         assert( p->pGroupBy==0 );
54034ac391fcSdan         assert( flag==0 );
54044ac391fcSdan         if( p->pHaving==0 ){
54054ac391fcSdan           flag = minMaxQuery(&sAggInfo, &pMinMax);
54064ac391fcSdan         }
54074ac391fcSdan         assert( flag==0 || (pMinMax!=0 && pMinMax->nExpr==1) );
54084ac391fcSdan 
5409a9d1ccb9Sdanielk1977         if( flag ){
54104ac391fcSdan           pMinMax = sqlite3ExprListDup(db, pMinMax, 0);
54116ab3a2ecSdanielk1977           pDel = pMinMax;
54120e359b30Sdrh           if( pMinMax && !db->mallocFailed ){
5413ea678832Sdrh             pMinMax->a[0].sortOrder = flag!=WHERE_ORDERBY_MIN ?1:0;
5414a9d1ccb9Sdanielk1977             pMinMax->a[0].pExpr->op = TK_COLUMN;
5415a9d1ccb9Sdanielk1977           }
54161013c932Sdrh         }
5417a9d1ccb9Sdanielk1977 
541813449892Sdrh         /* This case runs if the aggregate has no GROUP BY clause.  The
541913449892Sdrh         ** processing is much simpler since there is only a single row
542013449892Sdrh         ** of output.
542113449892Sdrh         */
542213449892Sdrh         resetAccumulator(pParse, &sAggInfo);
542346ec5b63Sdrh         pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMax,0,flag,0);
5424dba0137eSdanielk1977         if( pWInfo==0 ){
5425633e6d57Sdrh           sqlite3ExprListDelete(db, pDel);
5426dba0137eSdanielk1977           goto select_end;
5427dba0137eSdanielk1977         }
542813449892Sdrh         updateAccumulator(pParse, &sAggInfo);
542946c35f9bSdrh         assert( pMinMax==0 || pMinMax->nExpr==1 );
5430ddba0c22Sdrh         if( sqlite3WhereIsOrdered(pWInfo)>0 ){
54316f32848dSdrh           sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3WhereBreakLabel(pWInfo));
5432a5533162Sdanielk1977           VdbeComment((v, "%s() by index",
5433a5533162Sdanielk1977                 (flag==WHERE_ORDERBY_MIN?"min":"max")));
5434a9d1ccb9Sdanielk1977         }
543513449892Sdrh         sqlite3WhereEnd(pWInfo);
543613449892Sdrh         finalizeAggFunctions(pParse, &sAggInfo);
54377a895a80Sdanielk1977       }
54387a895a80Sdanielk1977 
5439079a3072Sdrh       sSort.pOrderBy = 0;
544035573356Sdrh       sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
5441079a3072Sdrh       selectInnerLoop(pParse, p, p->pEList, -1, 0, 0,
5442a9671a22Sdrh                       pDest, addrEnd, addrEnd);
5443633e6d57Sdrh       sqlite3ExprListDelete(db, pDel);
544413449892Sdrh     }
544513449892Sdrh     sqlite3VdbeResolveLabel(v, addrEnd);
544613449892Sdrh 
544713449892Sdrh   } /* endif aggregate query */
54482282792aSdrh 
5449e8e4af76Sdrh   if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
54502ce22453Sdan     explainTempTable(pParse, "DISTINCT");
54512ce22453Sdan   }
54522ce22453Sdan 
5453cce7d176Sdrh   /* If there is an ORDER BY clause, then we need to sort the results
5454cce7d176Sdrh   ** and send them to the callback one by one.
5455cce7d176Sdrh   */
5456079a3072Sdrh   if( sSort.pOrderBy ){
54576284db90Sdrh     explainTempTable(pParse, sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
5458079a3072Sdrh     generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
5459cce7d176Sdrh   }
54606a535340Sdrh 
5461ec7429aeSdrh   /* Jump here to skip this query
5462ec7429aeSdrh   */
5463ec7429aeSdrh   sqlite3VdbeResolveLabel(v, iEnd);
5464ec7429aeSdrh 
54651d83f052Sdrh   /* The SELECT was successfully coded.   Set the return code to 0
54661d83f052Sdrh   ** to indicate no errors.
54671d83f052Sdrh   */
54681d83f052Sdrh   rc = 0;
54691d83f052Sdrh 
54701d83f052Sdrh   /* Control jumps to here if an error is encountered above, or upon
54711d83f052Sdrh   ** successful coding of the SELECT.
54721d83f052Sdrh   */
54731d83f052Sdrh select_end:
547417c0bc0cSdan   explainSetInteger(pParse->iSelectId, iRestoreSelectId);
5475955de52cSdanielk1977 
54767d10d5a6Sdrh   /* Identify column names if results of the SELECT are to be output.
5477955de52cSdanielk1977   */
54787d10d5a6Sdrh   if( rc==SQLITE_OK && pDest->eDest==SRT_Output ){
5479955de52cSdanielk1977     generateColumnNames(pParse, pTabList, pEList);
5480955de52cSdanielk1977   }
5481955de52cSdanielk1977 
5482633e6d57Sdrh   sqlite3DbFree(db, sAggInfo.aCol);
5483633e6d57Sdrh   sqlite3DbFree(db, sAggInfo.aFunc);
5484eb9b884cSdrh #if SELECTTRACE_ENABLED
5485eb9b884cSdrh   SELECTTRACE(1,pParse,p,("end processing\n"));
5486eb9b884cSdrh   pParse->nSelectIndent--;
5487eb9b884cSdrh #endif
54881d83f052Sdrh   return rc;
5489cce7d176Sdrh }
5490485f0039Sdrh 
54914fa4a54fSdrh #ifdef SQLITE_DEBUG
5492485f0039Sdrh /*
54937e02e5e6Sdrh ** Generate a human-readable description of a the Select object.
5494485f0039Sdrh */
54954fa4a54fSdrh void sqlite3TreeViewSelect(TreeView *pView, const Select *p, u8 moreToFollow){
5496b08cd3f3Sdrh   int n = 0;
54974fa4a54fSdrh   pView = sqlite3TreeViewPush(pView, moreToFollow);
54984fa4a54fSdrh   sqlite3TreeViewLine(pView, "SELECT%s%s",
54994fa4a54fSdrh     ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""),
55004fa4a54fSdrh     ((p->selFlags & SF_Aggregate) ? " agg_flag" : "")
55014fa4a54fSdrh   );
5502b08cd3f3Sdrh   if( p->pSrc && p->pSrc->nSrc ) n++;
5503b08cd3f3Sdrh   if( p->pWhere ) n++;
5504b08cd3f3Sdrh   if( p->pGroupBy ) n++;
5505b08cd3f3Sdrh   if( p->pHaving ) n++;
5506b08cd3f3Sdrh   if( p->pOrderBy ) n++;
5507b08cd3f3Sdrh   if( p->pLimit ) n++;
5508b08cd3f3Sdrh   if( p->pOffset ) n++;
5509b08cd3f3Sdrh   if( p->pPrior ) n++;
5510b08cd3f3Sdrh   sqlite3TreeViewExprList(pView, p->pEList, (n--)>0, "result-set");
55117e02e5e6Sdrh   if( p->pSrc && p->pSrc->nSrc ){
5512485f0039Sdrh     int i;
5513b08cd3f3Sdrh     pView = sqlite3TreeViewPush(pView, (n--)>0);
55144fa4a54fSdrh     sqlite3TreeViewLine(pView, "FROM");
5515485f0039Sdrh     for(i=0; i<p->pSrc->nSrc; i++){
5516485f0039Sdrh       struct SrcList_item *pItem = &p->pSrc->a[i];
55174fa4a54fSdrh       StrAccum x;
55184fa4a54fSdrh       char zLine[100];
55194fa4a54fSdrh       sqlite3StrAccumInit(&x, zLine, sizeof(zLine), 0);
55204fa4a54fSdrh       sqlite3XPrintf(&x, 0, "{%d,*}", pItem->iCursor);
55214fa4a54fSdrh       if( pItem->zDatabase ){
55224fa4a54fSdrh         sqlite3XPrintf(&x, 0, " %s.%s", pItem->zDatabase, pItem->zName);
5523485f0039Sdrh       }else if( pItem->zName ){
55244fa4a54fSdrh         sqlite3XPrintf(&x, 0, " %s", pItem->zName);
55254fa4a54fSdrh       }
55264fa4a54fSdrh       if( pItem->pTab ){
55274fa4a54fSdrh         sqlite3XPrintf(&x, 0, " tabname=%Q", pItem->pTab->zName);
5528485f0039Sdrh       }
5529485f0039Sdrh       if( pItem->zAlias ){
55304fa4a54fSdrh         sqlite3XPrintf(&x, 0, " (AS %s)", pItem->zAlias);
5531485f0039Sdrh       }
5532a84203a0Sdrh       if( pItem->jointype & JT_LEFT ){
55334fa4a54fSdrh         sqlite3XPrintf(&x, 0, " LEFT-JOIN");
5534485f0039Sdrh       }
55354fa4a54fSdrh       sqlite3StrAccumFinish(&x);
55364fa4a54fSdrh       sqlite3TreeViewItem(pView, zLine, i<p->pSrc->nSrc-1);
55374fa4a54fSdrh       if( pItem->pSelect ){
55384fa4a54fSdrh         sqlite3TreeViewSelect(pView, pItem->pSelect, 0);
5539485f0039Sdrh       }
55404fa4a54fSdrh       sqlite3TreeViewPop(pView);
55414fa4a54fSdrh     }
55424fa4a54fSdrh     sqlite3TreeViewPop(pView);
5543485f0039Sdrh   }
5544485f0039Sdrh   if( p->pWhere ){
5545b08cd3f3Sdrh     sqlite3TreeViewItem(pView, "WHERE", (n--)>0);
55464fa4a54fSdrh     sqlite3TreeViewExpr(pView, p->pWhere, 0);
55474fa4a54fSdrh     sqlite3TreeViewPop(pView);
5548485f0039Sdrh   }
5549485f0039Sdrh   if( p->pGroupBy ){
5550b08cd3f3Sdrh     sqlite3TreeViewExprList(pView, p->pGroupBy, (n--)>0, "GROUPBY");
5551485f0039Sdrh   }
5552485f0039Sdrh   if( p->pHaving ){
5553b08cd3f3Sdrh     sqlite3TreeViewItem(pView, "HAVING", (n--)>0);
55544fa4a54fSdrh     sqlite3TreeViewExpr(pView, p->pHaving, 0);
55554fa4a54fSdrh     sqlite3TreeViewPop(pView);
5556485f0039Sdrh   }
5557485f0039Sdrh   if( p->pOrderBy ){
5558b08cd3f3Sdrh     sqlite3TreeViewExprList(pView, p->pOrderBy, (n--)>0, "ORDERBY");
5559485f0039Sdrh   }
5560a84203a0Sdrh   if( p->pLimit ){
5561b08cd3f3Sdrh     sqlite3TreeViewItem(pView, "LIMIT", (n--)>0);
55624fa4a54fSdrh     sqlite3TreeViewExpr(pView, p->pLimit, 0);
55634fa4a54fSdrh     sqlite3TreeViewPop(pView);
5564a84203a0Sdrh   }
5565a84203a0Sdrh   if( p->pOffset ){
5566b08cd3f3Sdrh     sqlite3TreeViewItem(pView, "OFFSET", (n--)>0);
55674fa4a54fSdrh     sqlite3TreeViewExpr(pView, p->pOffset, 0);
55684fa4a54fSdrh     sqlite3TreeViewPop(pView);
5569485f0039Sdrh   }
55704fa4a54fSdrh   if( p->pPrior ){
55714fa4a54fSdrh     const char *zOp = "UNION";
55724fa4a54fSdrh     switch( p->op ){
55734fa4a54fSdrh       case TK_ALL:         zOp = "UNION ALL";  break;
55744fa4a54fSdrh       case TK_INTERSECT:   zOp = "INTERSECT";  break;
55754fa4a54fSdrh       case TK_EXCEPT:      zOp = "EXCEPT";     break;
5576485f0039Sdrh     }
5577b08cd3f3Sdrh     sqlite3TreeViewItem(pView, zOp, (n--)>0);
5578b08cd3f3Sdrh     sqlite3TreeViewSelect(pView, p->pPrior, 0);
55794fa4a54fSdrh     sqlite3TreeViewPop(pView);
5580a84203a0Sdrh   }
55814fa4a54fSdrh   sqlite3TreeViewPop(pView);
5582a84203a0Sdrh }
55834fa4a54fSdrh #endif /* SQLITE_DEBUG */
5584