xref: /sqlite-3.40.0/src/select.c (revision 181d75ef)
1 /*
2 ** 2001 September 15
3 **
4 ** The author disclaims copyright to this source code.  In place of
5 ** a legal notice, here is a blessing:
6 **
7 **    May you do good and not evil.
8 **    May you find forgiveness for yourself and forgive others.
9 **    May you share freely, never taking more than you give.
10 **
11 *************************************************************************
12 ** This file contains C code routines that are called by the parser
13 ** to handle SELECT statements in SQLite.
14 */
15 #include "sqliteInt.h"
16 
17 /*
18 ** An instance of the following object is used to record information about
19 ** how to process the DISTINCT keyword, to simplify passing that information
20 ** into the selectInnerLoop() routine.
21 */
22 typedef struct DistinctCtx DistinctCtx;
23 struct DistinctCtx {
24   u8 isTnct;      /* 0: Not distinct. 1: DISTICT  2: DISTINCT and ORDER BY */
25   u8 eTnctType;   /* One of the WHERE_DISTINCT_* operators */
26   int tabTnct;    /* Ephemeral table used for DISTINCT processing */
27   int addrTnct;   /* Address of OP_OpenEphemeral opcode for tabTnct */
28 };
29 
30 /*
31 ** An instance of the following object is used to record information about
32 ** the ORDER BY (or GROUP BY) clause of query is being coded.
33 **
34 ** The aDefer[] array is used by the sorter-references optimization. For
35 ** example, assuming there is no index that can be used for the ORDER BY,
36 ** for the query:
37 **
38 **     SELECT a, bigblob FROM t1 ORDER BY a LIMIT 10;
39 **
40 ** it may be more efficient to add just the "a" values to the sorter, and
41 ** retrieve the associated "bigblob" values directly from table t1 as the
42 ** 10 smallest "a" values are extracted from the sorter.
43 **
44 ** When the sorter-reference optimization is used, there is one entry in the
45 ** aDefer[] array for each database table that may be read as values are
46 ** extracted from the sorter.
47 */
48 typedef struct SortCtx SortCtx;
49 struct SortCtx {
50   ExprList *pOrderBy;   /* The ORDER BY (or GROUP BY clause) */
51   int nOBSat;           /* Number of ORDER BY terms satisfied by indices */
52   int iECursor;         /* Cursor number for the sorter */
53   int regReturn;        /* Register holding block-output return address */
54   int labelBkOut;       /* Start label for the block-output subroutine */
55   int addrSortIndex;    /* Address of the OP_SorterOpen or OP_OpenEphemeral */
56   int labelDone;        /* Jump here when done, ex: LIMIT reached */
57   int labelOBLopt;      /* Jump here when sorter is full */
58   u8 sortFlags;         /* Zero or more SORTFLAG_* bits */
59 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
60   u8 nDefer;            /* Number of valid entries in aDefer[] */
61   struct DeferredCsr {
62     Table *pTab;        /* Table definition */
63     int iCsr;           /* Cursor number for table */
64     int nKey;           /* Number of PK columns for table pTab (>=1) */
65   } aDefer[4];
66 #endif
67   struct RowLoadInfo *pDeferredRowLoad;  /* Deferred row loading info or NULL */
68 };
69 #define SORTFLAG_UseSorter  0x01   /* Use SorterOpen instead of OpenEphemeral */
70 
71 /*
72 ** Delete all the content of a Select structure.  Deallocate the structure
73 ** itself depending on the value of bFree
74 **
75 ** If bFree==1, call sqlite3DbFree() on the p object.
76 ** If bFree==0, Leave the first Select object unfreed
77 */
78 static void clearSelect(sqlite3 *db, Select *p, int bFree){
79   while( p ){
80     Select *pPrior = p->pPrior;
81     sqlite3ExprListDelete(db, p->pEList);
82     sqlite3SrcListDelete(db, p->pSrc);
83     sqlite3ExprDelete(db, p->pWhere);
84     sqlite3ExprListDelete(db, p->pGroupBy);
85     sqlite3ExprDelete(db, p->pHaving);
86     sqlite3ExprListDelete(db, p->pOrderBy);
87     sqlite3ExprDelete(db, p->pLimit);
88     if( OK_IF_ALWAYS_TRUE(p->pWith) ) sqlite3WithDelete(db, p->pWith);
89 #ifndef SQLITE_OMIT_WINDOWFUNC
90     if( OK_IF_ALWAYS_TRUE(p->pWinDefn) ){
91       sqlite3WindowListDelete(db, p->pWinDefn);
92     }
93     while( p->pWin ){
94       assert( p->pWin->ppThis==&p->pWin );
95       sqlite3WindowUnlinkFromSelect(p->pWin);
96     }
97 #endif
98     if( bFree ) sqlite3DbFreeNN(db, p);
99     p = pPrior;
100     bFree = 1;
101   }
102 }
103 
104 /*
105 ** Initialize a SelectDest structure.
106 */
107 void sqlite3SelectDestInit(SelectDest *pDest, int eDest, int iParm){
108   pDest->eDest = (u8)eDest;
109   pDest->iSDParm = iParm;
110   pDest->iSDParm2 = 0;
111   pDest->zAffSdst = 0;
112   pDest->iSdst = 0;
113   pDest->nSdst = 0;
114 }
115 
116 
117 /*
118 ** Allocate a new Select structure and return a pointer to that
119 ** structure.
120 */
121 Select *sqlite3SelectNew(
122   Parse *pParse,        /* Parsing context */
123   ExprList *pEList,     /* which columns to include in the result */
124   SrcList *pSrc,        /* the FROM clause -- which tables to scan */
125   Expr *pWhere,         /* the WHERE clause */
126   ExprList *pGroupBy,   /* the GROUP BY clause */
127   Expr *pHaving,        /* the HAVING clause */
128   ExprList *pOrderBy,   /* the ORDER BY clause */
129   u32 selFlags,         /* Flag parameters, such as SF_Distinct */
130   Expr *pLimit          /* LIMIT value.  NULL means not used */
131 ){
132   Select *pNew, *pAllocated;
133   Select standin;
134   pAllocated = pNew = sqlite3DbMallocRawNN(pParse->db, sizeof(*pNew) );
135   if( pNew==0 ){
136     assert( pParse->db->mallocFailed );
137     pNew = &standin;
138   }
139   if( pEList==0 ){
140     pEList = sqlite3ExprListAppend(pParse, 0,
141                                    sqlite3Expr(pParse->db,TK_ASTERISK,0));
142   }
143   pNew->pEList = pEList;
144   pNew->op = TK_SELECT;
145   pNew->selFlags = selFlags;
146   pNew->iLimit = 0;
147   pNew->iOffset = 0;
148   pNew->selId = ++pParse->nSelect;
149   pNew->addrOpenEphm[0] = -1;
150   pNew->addrOpenEphm[1] = -1;
151   pNew->nSelectRow = 0;
152   if( pSrc==0 ) pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*pSrc));
153   pNew->pSrc = pSrc;
154   pNew->pWhere = pWhere;
155   pNew->pGroupBy = pGroupBy;
156   pNew->pHaving = pHaving;
157   pNew->pOrderBy = pOrderBy;
158   pNew->pPrior = 0;
159   pNew->pNext = 0;
160   pNew->pLimit = pLimit;
161   pNew->pWith = 0;
162 #ifndef SQLITE_OMIT_WINDOWFUNC
163   pNew->pWin = 0;
164   pNew->pWinDefn = 0;
165 #endif
166   if( pParse->db->mallocFailed ) {
167     clearSelect(pParse->db, pNew, pNew!=&standin);
168     pAllocated = 0;
169   }else{
170     assert( pNew->pSrc!=0 || pParse->nErr>0 );
171   }
172   return pAllocated;
173 }
174 
175 
176 /*
177 ** Delete the given Select structure and all of its substructures.
178 */
179 void sqlite3SelectDelete(sqlite3 *db, Select *p){
180   if( OK_IF_ALWAYS_TRUE(p) ) clearSelect(db, p, 1);
181 }
182 
183 /*
184 ** Return a pointer to the right-most SELECT statement in a compound.
185 */
186 static Select *findRightmost(Select *p){
187   while( p->pNext ) p = p->pNext;
188   return p;
189 }
190 
191 /*
192 ** Given 1 to 3 identifiers preceding the JOIN keyword, determine the
193 ** type of join.  Return an integer constant that expresses that type
194 ** in terms of the following bit values:
195 **
196 **     JT_INNER
197 **     JT_CROSS
198 **     JT_OUTER
199 **     JT_NATURAL
200 **     JT_LEFT
201 **     JT_RIGHT
202 **
203 ** A full outer join is the combination of JT_LEFT and JT_RIGHT.
204 **
205 ** If an illegal or unsupported join type is seen, then still return
206 ** a join type, but put an error in the pParse structure.
207 **
208 ** These are the valid join types:
209 **
210 **
211 **      pA       pB       pC               Return Value
212 **     -------  -----    -----             ------------
213 **     CROSS      -        -                 JT_CROSS
214 **     INNER      -        -                 JT_INNER
215 **     LEFT       -        -                 JT_LEFT|JT_OUTER
216 **     LEFT     OUTER      -                 JT_LEFT|JT_OUTER
217 **     RIGHT      -        -                 JT_RIGHT|JT_OUTER
218 **     RIGHT    OUTER      -                 JT_RIGHT|JT_OUTER
219 **     FULL       -        -                 JT_LEFT|JT_RIGHT|JT_OUTER
220 **     FULL     OUTER      -                 JT_LEFT|JT_RIGHT|JT_OUTER
221 **     NATURAL  INNER      -                 JT_NATURAL|JT_INNER
222 **     NATURAL  LEFT       -                 JT_NATURAL|JT_LEFT|JT_OUTER
223 **     NATURAL  LEFT     OUTER               JT_NATURAL|JT_LEFT|JT_OUTER
224 **     NATURAL  RIGHT      -                 JT_NATURAL|JT_RIGHT|JT_OUTER
225 **     NATURAL  RIGHT    OUTER               JT_NATURAL|JT_RIGHT|JT_OUTER
226 **     NATURAL  FULL       -                 JT_NATURAL|JT_LEFT|JT_RIGHT
227 **     NATURAL  FULL     OUTER               JT_NATRUAL|JT_LEFT|JT_RIGHT
228 **
229 ** To preserve historical compatibly, SQLite also accepts a variety
230 ** of other non-standard and in many cases non-sensical join types.
231 ** This routine makes as much sense at it can from the nonsense join
232 ** type and returns a result.  Examples of accepted nonsense join types
233 ** include but are not limited to:
234 **
235 **          INNER CROSS JOIN        ->   same as JOIN
236 **          NATURAL CROSS JOIN      ->   same as NATURAL JOIN
237 **          OUTER LEFT JOIN         ->   same as LEFT JOIN
238 **          LEFT NATURAL JOIN       ->   same as NATURAL LEFT JOIN
239 **          LEFT RIGHT JOIN         ->   same as FULL JOIN
240 **          RIGHT OUTER FULL JOIN   ->   same as FULL JOIN
241 **          CROSS CROSS CROSS JOIN  ->   same as JOIN
242 **
243 ** The only restrictions on the join type name are:
244 **
245 **    *   "INNER" cannot appear together with "OUTER", "LEFT", "RIGHT",
246 **        or "FULL".
247 **
248 **    *   "CROSS" cannot appear together with "OUTER", "LEFT", "RIGHT,
249 **        or "FULL".
250 **
251 **    *   If "OUTER" is present then there must also be one of
252 **        "LEFT", "RIGHT", or "FULL"
253 */
254 int sqlite3JoinType(Parse *pParse, Token *pA, Token *pB, Token *pC){
255   int jointype = 0;
256   Token *apAll[3];
257   Token *p;
258                              /*   0123456789 123456789 123456789 123 */
259   static const char zKeyText[] = "naturaleftouterightfullinnercross";
260   static const struct {
261     u8 i;        /* Beginning of keyword text in zKeyText[] */
262     u8 nChar;    /* Length of the keyword in characters */
263     u8 code;     /* Join type mask */
264   } aKeyword[] = {
265     /* (0) natural */ { 0,  7, JT_NATURAL                },
266     /* (1) left    */ { 6,  4, JT_LEFT|JT_OUTER          },
267     /* (2) outer   */ { 10, 5, JT_OUTER                  },
268     /* (3) right   */ { 14, 5, JT_RIGHT|JT_OUTER         },
269     /* (4) full    */ { 19, 4, JT_LEFT|JT_RIGHT|JT_OUTER },
270     /* (5) inner   */ { 23, 5, JT_INNER                  },
271     /* (6) cross   */ { 28, 5, JT_INNER|JT_CROSS         },
272   };
273   int i, j;
274   apAll[0] = pA;
275   apAll[1] = pB;
276   apAll[2] = pC;
277   for(i=0; i<3 && apAll[i]; i++){
278     p = apAll[i];
279     for(j=0; j<ArraySize(aKeyword); j++){
280       if( p->n==aKeyword[j].nChar
281           && sqlite3StrNICmp((char*)p->z, &zKeyText[aKeyword[j].i], p->n)==0 ){
282         jointype |= aKeyword[j].code;
283         break;
284       }
285     }
286     testcase( j==0 || j==1 || j==2 || j==3 || j==4 || j==5 || j==6 );
287     if( j>=ArraySize(aKeyword) ){
288       jointype |= JT_ERROR;
289       break;
290     }
291   }
292   if(
293      (jointype & (JT_INNER|JT_OUTER))==(JT_INNER|JT_OUTER) ||
294      (jointype & JT_ERROR)!=0 ||
295      (jointype & (JT_OUTER|JT_LEFT|JT_RIGHT))==JT_OUTER
296   ){
297     const char *zSp1 = " ";
298     const char *zSp2 = " ";
299     if( pB==0 ){ zSp1++; }
300     if( pC==0 ){ zSp2++; }
301     sqlite3ErrorMsg(pParse, "unknown join type: "
302        "%T%s%T%s%T", pA, zSp1, pB, zSp2, pC);
303     jointype = JT_INNER;
304   }
305   return jointype;
306 }
307 
308 /*
309 ** Return the index of a column in a table.  Return -1 if the column
310 ** is not contained in the table.
311 */
312 int sqlite3ColumnIndex(Table *pTab, const char *zCol){
313   int i;
314   u8 h = sqlite3StrIHash(zCol);
315   Column *pCol;
316   for(pCol=pTab->aCol, i=0; i<pTab->nCol; pCol++, i++){
317     if( pCol->hName==h && sqlite3StrICmp(pCol->zCnName, zCol)==0 ) return i;
318   }
319   return -1;
320 }
321 
322 /*
323 ** Mark a subquery result column as having been used.
324 */
325 void sqlite3SrcItemColumnUsed(SrcItem *pItem, int iCol){
326   assert( pItem!=0 );
327   assert( pItem->fg.isNestedFrom == IsNestedFrom(pItem->pSelect) );
328   if( pItem->fg.isNestedFrom ){
329     ExprList *pResults;
330     assert( pItem->pSelect!=0 );
331     pResults = pItem->pSelect->pEList;
332     assert( pResults!=0 );
333     assert( iCol>=0 && iCol<pResults->nExpr );
334     pResults->a[iCol].fg.bUsed = 1;
335   }
336 }
337 
338 /*
339 ** Search the tables iStart..iEnd (inclusive) in pSrc, looking for a
340 ** table that has a column named zCol.  The search is left-to-right.
341 ** The first match found is returned.
342 **
343 ** When found, set *piTab and *piCol to the table index and column index
344 ** of the matching column and return TRUE.
345 **
346 ** If not found, return FALSE.
347 */
348 static int tableAndColumnIndex(
349   SrcList *pSrc,       /* Array of tables to search */
350   int iStart,          /* First member of pSrc->a[] to check */
351   int iEnd,            /* Last member of pSrc->a[] to check */
352   const char *zCol,    /* Name of the column we are looking for */
353   int *piTab,          /* Write index of pSrc->a[] here */
354   int *piCol,          /* Write index of pSrc->a[*piTab].pTab->aCol[] here */
355   int bIgnoreHidden    /* Ignore hidden columns */
356 ){
357   int i;               /* For looping over tables in pSrc */
358   int iCol;            /* Index of column matching zCol */
359 
360   assert( iEnd<pSrc->nSrc );
361   assert( iStart>=0 );
362   assert( (piTab==0)==(piCol==0) );  /* Both or neither are NULL */
363 
364   for(i=iStart; i<=iEnd; i++){
365     iCol = sqlite3ColumnIndex(pSrc->a[i].pTab, zCol);
366     if( iCol>=0
367      && (bIgnoreHidden==0 || IsHiddenColumn(&pSrc->a[i].pTab->aCol[iCol])==0)
368     ){
369       if( piTab ){
370         sqlite3SrcItemColumnUsed(&pSrc->a[i], iCol);
371         *piTab = i;
372         *piCol = iCol;
373       }
374       return 1;
375     }
376   }
377   return 0;
378 }
379 
380 /*
381 ** Set the EP_OuterON property on all terms of the given expression.
382 ** And set the Expr.w.iJoin to iTable for every term in the
383 ** expression.
384 **
385 ** The EP_OuterON property is used on terms of an expression to tell
386 ** the OUTER JOIN processing logic that this term is part of the
387 ** join restriction specified in the ON or USING clause and not a part
388 ** of the more general WHERE clause.  These terms are moved over to the
389 ** WHERE clause during join processing but we need to remember that they
390 ** originated in the ON or USING clause.
391 **
392 ** The Expr.w.iJoin tells the WHERE clause processing that the
393 ** expression depends on table w.iJoin even if that table is not
394 ** explicitly mentioned in the expression.  That information is needed
395 ** for cases like this:
396 **
397 **    SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.b AND t1.x=5
398 **
399 ** The where clause needs to defer the handling of the t1.x=5
400 ** term until after the t2 loop of the join.  In that way, a
401 ** NULL t2 row will be inserted whenever t1.x!=5.  If we do not
402 ** defer the handling of t1.x=5, it will be processed immediately
403 ** after the t1 loop and rows with t1.x!=5 will never appear in
404 ** the output, which is incorrect.
405 */
406 void sqlite3SetJoinExpr(Expr *p, int iTable, u32 joinFlag){
407   assert( joinFlag==EP_OuterON || joinFlag==EP_InnerON );
408   while( p ){
409     ExprSetProperty(p, joinFlag);
410     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
411     ExprSetVVAProperty(p, EP_NoReduce);
412     p->w.iJoin = iTable;
413     if( p->op==TK_FUNCTION ){
414       assert( ExprUseXList(p) );
415       if( p->x.pList ){
416         int i;
417         for(i=0; i<p->x.pList->nExpr; i++){
418           sqlite3SetJoinExpr(p->x.pList->a[i].pExpr, iTable, joinFlag);
419         }
420       }
421     }
422     sqlite3SetJoinExpr(p->pLeft, iTable, joinFlag);
423     p = p->pRight;
424   }
425 }
426 
427 /* Undo the work of sqlite3SetJoinExpr(). In the expression p, convert every
428 ** term that is marked with EP_OuterON and w.iJoin==iTable into
429 ** an ordinary term that omits the EP_OuterON mark.
430 **
431 ** This happens when a LEFT JOIN is simplified into an ordinary JOIN.
432 */
433 static void unsetJoinExpr(Expr *p, int iTable){
434   while( p ){
435     if( ExprHasProperty(p, EP_OuterON)
436      && (iTable<0 || p->w.iJoin==iTable) ){
437       ExprClearProperty(p, EP_OuterON);
438       ExprSetProperty(p, EP_InnerON);
439     }
440     if( p->op==TK_COLUMN && p->iTable==iTable ){
441       ExprClearProperty(p, EP_CanBeNull);
442     }
443     if( p->op==TK_FUNCTION ){
444       assert( ExprUseXList(p) );
445       if( p->x.pList ){
446         int i;
447         for(i=0; i<p->x.pList->nExpr; i++){
448           unsetJoinExpr(p->x.pList->a[i].pExpr, iTable);
449         }
450       }
451     }
452     unsetJoinExpr(p->pLeft, iTable);
453     p = p->pRight;
454   }
455 }
456 
457 /*
458 ** This routine processes the join information for a SELECT statement.
459 **
460 **   *  A NATURAL join is converted into a USING join.  After that, we
461 **      do not need to be concerned with NATURAL joins and we only have
462 **      think about USING joins.
463 **
464 **   *  ON and USING clauses result in extra terms being added to the
465 **      WHERE clause to enforce the specified constraints.  The extra
466 **      WHERE clause terms will be tagged with EP_OuterON or
467 **      EP_InnerON so that we know that they originated in ON/USING.
468 **
469 ** The terms of a FROM clause are contained in the Select.pSrc structure.
470 ** The left most table is the first entry in Select.pSrc.  The right-most
471 ** table is the last entry.  The join operator is held in the entry to
472 ** the right.  Thus entry 1 contains the join operator for the join between
473 ** entries 0 and 1.  Any ON or USING clauses associated with the join are
474 ** also attached to the right entry.
475 **
476 ** This routine returns the number of errors encountered.
477 */
478 static int sqlite3ProcessJoin(Parse *pParse, Select *p){
479   SrcList *pSrc;                  /* All tables in the FROM clause */
480   int i, j;                       /* Loop counters */
481   SrcItem *pLeft;                 /* Left table being joined */
482   SrcItem *pRight;                /* Right table being joined */
483 
484   pSrc = p->pSrc;
485   pLeft = &pSrc->a[0];
486   pRight = &pLeft[1];
487   for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
488     Table *pRightTab = pRight->pTab;
489     u32 joinType;
490 
491     if( NEVER(pLeft->pTab==0 || pRightTab==0) ) continue;
492     joinType = (pRight->fg.jointype & JT_OUTER)!=0 ? EP_OuterON : EP_InnerON;
493 
494     /* If this is a NATURAL join, synthesize an approprate USING clause
495     ** to specify which columns should be joined.
496     */
497     if( pRight->fg.jointype & JT_NATURAL ){
498       IdList *pUsing = 0;
499       if( pRight->fg.isUsing || pRight->u3.pOn ){
500         sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
501            "an ON or USING clause", 0);
502         return 1;
503       }
504       for(j=0; j<pRightTab->nCol; j++){
505         char *zName;   /* Name of column in the right table */
506 
507         if( IsHiddenColumn(&pRightTab->aCol[j]) ) continue;
508         zName = pRightTab->aCol[j].zCnName;
509         if( tableAndColumnIndex(pSrc, 0, i, zName, 0, 0, 1) ){
510           pUsing = sqlite3IdListAppend(pParse, pUsing, 0);
511           if( pUsing ){
512             assert( pUsing->nId>0 );
513             assert( pUsing->a[pUsing->nId-1].zName==0 );
514             pUsing->a[pUsing->nId-1].zName = sqlite3DbStrDup(pParse->db, zName);
515           }
516         }
517       }
518       if( pUsing ){
519         pRight->fg.isUsing = 1;
520         pRight->fg.isSynthUsing = 1;
521         pRight->u3.pUsing = pUsing;
522       }
523       if( pParse->nErr ) return 1;
524     }
525 
526     /* Create extra terms on the WHERE clause for each column named
527     ** in the USING clause.  Example: If the two tables to be joined are
528     ** A and B and the USING clause names X, Y, and Z, then add this
529     ** to the WHERE clause:    A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
530     ** Report an error if any column mentioned in the USING clause is
531     ** not contained in both tables to be joined.
532     */
533     if( pRight->fg.isUsing ){
534       IdList *pList = pRight->u3.pUsing;
535       sqlite3 *db = pParse->db;
536       assert( pList!=0 );
537       for(j=0; j<pList->nId; j++){
538         char *zName;     /* Name of the term in the USING clause */
539         int iLeft;       /* Table on the left with matching column name */
540         int iLeftCol;    /* Column number of matching column on the left */
541         int iRightCol;   /* Column number of matching column on the right */
542         Expr *pE1;       /* Reference to the column on the LEFT of the join */
543         Expr *pE2;       /* Reference to the column on the RIGHT of the join */
544         Expr *pEq;       /* Equality constraint.  pE1 == pE2 */
545 
546         zName = pList->a[j].zName;
547         iRightCol = sqlite3ColumnIndex(pRightTab, zName);
548         if( iRightCol<0
549          || tableAndColumnIndex(pSrc, 0, i, zName, &iLeft, &iLeftCol,
550                                 pRight->fg.isSynthUsing)==0
551         ){
552           sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
553             "not present in both tables", zName);
554           return 1;
555         }
556         pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iLeftCol);
557         sqlite3SrcItemColumnUsed(&pSrc->a[iLeft], iLeftCol);
558         if( (pSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
559           /* This branch runs if the query contains one or more RIGHT or FULL
560           ** JOINs.  If only a single table on the left side of this join
561           ** contains the zName column, then this branch is a no-op.
562           ** But if there are two or more tables on the left side
563           ** of the join, construct a coalesce() function that gathers all
564           ** such tables.  Raise an error if more than one of those references
565           ** to zName is not also within a prior USING clause.
566           **
567           ** We really ought to raise an error if there are two or more
568           ** non-USING references to zName on the left of an INNER or LEFT
569           ** JOIN.  But older versions of SQLite do not do that, so we avoid
570           ** adding a new error so as to not break legacy applications.
571           */
572           ExprList *pFuncArgs = 0;   /* Arguments to the coalesce() */
573           static const Token tkCoalesce = { "coalesce", 8 };
574           while( tableAndColumnIndex(pSrc, iLeft+1, i, zName, &iLeft, &iLeftCol,
575                                      pRight->fg.isSynthUsing)!=0 ){
576             if( pSrc->a[iLeft].fg.isUsing==0
577              || sqlite3IdListIndex(pSrc->a[iLeft].u3.pUsing, zName)<0
578             ){
579               sqlite3ErrorMsg(pParse, "ambiguous reference to %s in USING()",
580                               zName);
581               break;
582             }
583             pFuncArgs = sqlite3ExprListAppend(pParse, pFuncArgs, pE1);
584             pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iLeftCol);
585             sqlite3SrcItemColumnUsed(&pSrc->a[iLeft], iLeftCol);
586           }
587           if( pFuncArgs ){
588             pFuncArgs = sqlite3ExprListAppend(pParse, pFuncArgs, pE1);
589             pE1 = sqlite3ExprFunction(pParse, pFuncArgs, &tkCoalesce, 0);
590           }
591         }
592         pE2 = sqlite3CreateColumnExpr(db, pSrc, i+1, iRightCol);
593         sqlite3SrcItemColumnUsed(pRight, iRightCol);
594         pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2);
595         assert( pE2!=0 || pEq==0 );
596         if( pEq ){
597           ExprSetProperty(pEq, joinType);
598           assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
599           ExprSetVVAProperty(pEq, EP_NoReduce);
600           pEq->w.iJoin = pE2->iTable;
601         }
602         p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pEq);
603       }
604     }
605 
606     /* Add the ON clause to the end of the WHERE clause, connected by
607     ** an AND operator.
608     */
609     else if( pRight->u3.pOn ){
610       sqlite3SetJoinExpr(pRight->u3.pOn, pRight->iCursor, joinType);
611       p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pRight->u3.pOn);
612       pRight->u3.pOn = 0;
613     }
614   }
615   return 0;
616 }
617 
618 /*
619 ** An instance of this object holds information (beyond pParse and pSelect)
620 ** needed to load the next result row that is to be added to the sorter.
621 */
622 typedef struct RowLoadInfo RowLoadInfo;
623 struct RowLoadInfo {
624   int regResult;               /* Store results in array of registers here */
625   u8 ecelFlags;                /* Flag argument to ExprCodeExprList() */
626 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
627   ExprList *pExtra;            /* Extra columns needed by sorter refs */
628   int regExtraResult;          /* Where to load the extra columns */
629 #endif
630 };
631 
632 /*
633 ** This routine does the work of loading query data into an array of
634 ** registers so that it can be added to the sorter.
635 */
636 static void innerLoopLoadRow(
637   Parse *pParse,             /* Statement under construction */
638   Select *pSelect,           /* The query being coded */
639   RowLoadInfo *pInfo         /* Info needed to complete the row load */
640 ){
641   sqlite3ExprCodeExprList(pParse, pSelect->pEList, pInfo->regResult,
642                           0, pInfo->ecelFlags);
643 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
644   if( pInfo->pExtra ){
645     sqlite3ExprCodeExprList(pParse, pInfo->pExtra, pInfo->regExtraResult, 0, 0);
646     sqlite3ExprListDelete(pParse->db, pInfo->pExtra);
647   }
648 #endif
649 }
650 
651 /*
652 ** Code the OP_MakeRecord instruction that generates the entry to be
653 ** added into the sorter.
654 **
655 ** Return the register in which the result is stored.
656 */
657 static int makeSorterRecord(
658   Parse *pParse,
659   SortCtx *pSort,
660   Select *pSelect,
661   int regBase,
662   int nBase
663 ){
664   int nOBSat = pSort->nOBSat;
665   Vdbe *v = pParse->pVdbe;
666   int regOut = ++pParse->nMem;
667   if( pSort->pDeferredRowLoad ){
668     innerLoopLoadRow(pParse, pSelect, pSort->pDeferredRowLoad);
669   }
670   sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regOut);
671   return regOut;
672 }
673 
674 /*
675 ** Generate code that will push the record in registers regData
676 ** through regData+nData-1 onto the sorter.
677 */
678 static void pushOntoSorter(
679   Parse *pParse,         /* Parser context */
680   SortCtx *pSort,        /* Information about the ORDER BY clause */
681   Select *pSelect,       /* The whole SELECT statement */
682   int regData,           /* First register holding data to be sorted */
683   int regOrigData,       /* First register holding data before packing */
684   int nData,             /* Number of elements in the regData data array */
685   int nPrefixReg         /* No. of reg prior to regData available for use */
686 ){
687   Vdbe *v = pParse->pVdbe;                         /* Stmt under construction */
688   int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
689   int nExpr = pSort->pOrderBy->nExpr;              /* No. of ORDER BY terms */
690   int nBase = nExpr + bSeq + nData;                /* Fields in sorter record */
691   int regBase;                                     /* Regs for sorter record */
692   int regRecord = 0;                               /* Assembled sorter record */
693   int nOBSat = pSort->nOBSat;                      /* ORDER BY terms to skip */
694   int op;                            /* Opcode to add sorter record to sorter */
695   int iLimit;                        /* LIMIT counter */
696   int iSkip = 0;                     /* End of the sorter insert loop */
697 
698   assert( bSeq==0 || bSeq==1 );
699 
700   /* Three cases:
701   **   (1) The data to be sorted has already been packed into a Record
702   **       by a prior OP_MakeRecord.  In this case nData==1 and regData
703   **       will be completely unrelated to regOrigData.
704   **   (2) All output columns are included in the sort record.  In that
705   **       case regData==regOrigData.
706   **   (3) Some output columns are omitted from the sort record due to
707   **       the SQLITE_ENABLE_SORTER_REFERENCE optimization, or due to the
708   **       SQLITE_ECEL_OMITREF optimization, or due to the
709   **       SortCtx.pDeferredRowLoad optimiation.  In any of these cases
710   **       regOrigData is 0 to prevent this routine from trying to copy
711   **       values that might not yet exist.
712   */
713   assert( nData==1 || regData==regOrigData || regOrigData==0 );
714 
715   if( nPrefixReg ){
716     assert( nPrefixReg==nExpr+bSeq );
717     regBase = regData - nPrefixReg;
718   }else{
719     regBase = pParse->nMem + 1;
720     pParse->nMem += nBase;
721   }
722   assert( pSelect->iOffset==0 || pSelect->iLimit!=0 );
723   iLimit = pSelect->iOffset ? pSelect->iOffset+1 : pSelect->iLimit;
724   pSort->labelDone = sqlite3VdbeMakeLabel(pParse);
725   sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, regOrigData,
726                           SQLITE_ECEL_DUP | (regOrigData? SQLITE_ECEL_REF : 0));
727   if( bSeq ){
728     sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
729   }
730   if( nPrefixReg==0 && nData>0 ){
731     sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
732   }
733   if( nOBSat>0 ){
734     int regPrevKey;   /* The first nOBSat columns of the previous row */
735     int addrFirst;    /* Address of the OP_IfNot opcode */
736     int addrJmp;      /* Address of the OP_Jump opcode */
737     VdbeOp *pOp;      /* Opcode that opens the sorter */
738     int nKey;         /* Number of sorting key columns, including OP_Sequence */
739     KeyInfo *pKI;     /* Original KeyInfo on the sorter table */
740 
741     regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
742     regPrevKey = pParse->nMem+1;
743     pParse->nMem += pSort->nOBSat;
744     nKey = nExpr - pSort->nOBSat + bSeq;
745     if( bSeq ){
746       addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
747     }else{
748       addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
749     }
750     VdbeCoverage(v);
751     sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
752     pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
753     if( pParse->db->mallocFailed ) return;
754     pOp->p2 = nKey + nData;
755     pKI = pOp->p4.pKeyInfo;
756     memset(pKI->aSortFlags, 0, pKI->nKeyField); /* Makes OP_Jump testable */
757     sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
758     testcase( pKI->nAllField > pKI->nKeyField+2 );
759     pOp->p4.pKeyInfo = sqlite3KeyInfoFromExprList(pParse,pSort->pOrderBy,nOBSat,
760                                            pKI->nAllField-pKI->nKeyField-1);
761     pOp = 0; /* Ensure pOp not used after sqltie3VdbeAddOp3() */
762     addrJmp = sqlite3VdbeCurrentAddr(v);
763     sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
764     pSort->labelBkOut = sqlite3VdbeMakeLabel(pParse);
765     pSort->regReturn = ++pParse->nMem;
766     sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
767     sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
768     if( iLimit ){
769       sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, pSort->labelDone);
770       VdbeCoverage(v);
771     }
772     sqlite3VdbeJumpHere(v, addrFirst);
773     sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
774     sqlite3VdbeJumpHere(v, addrJmp);
775   }
776   if( iLimit ){
777     /* At this point the values for the new sorter entry are stored
778     ** in an array of registers. They need to be composed into a record
779     ** and inserted into the sorter if either (a) there are currently
780     ** less than LIMIT+OFFSET items or (b) the new record is smaller than
781     ** the largest record currently in the sorter. If (b) is true and there
782     ** are already LIMIT+OFFSET items in the sorter, delete the largest
783     ** entry before inserting the new one. This way there are never more
784     ** than LIMIT+OFFSET items in the sorter.
785     **
786     ** If the new record does not need to be inserted into the sorter,
787     ** jump to the next iteration of the loop. If the pSort->labelOBLopt
788     ** value is not zero, then it is a label of where to jump.  Otherwise,
789     ** just bypass the row insert logic.  See the header comment on the
790     ** sqlite3WhereOrderByLimitOptLabel() function for additional info.
791     */
792     int iCsr = pSort->iECursor;
793     sqlite3VdbeAddOp2(v, OP_IfNotZero, iLimit, sqlite3VdbeCurrentAddr(v)+4);
794     VdbeCoverage(v);
795     sqlite3VdbeAddOp2(v, OP_Last, iCsr, 0);
796     iSkip = sqlite3VdbeAddOp4Int(v, OP_IdxLE,
797                                  iCsr, 0, regBase+nOBSat, nExpr-nOBSat);
798     VdbeCoverage(v);
799     sqlite3VdbeAddOp1(v, OP_Delete, iCsr);
800   }
801   if( regRecord==0 ){
802     regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
803   }
804   if( pSort->sortFlags & SORTFLAG_UseSorter ){
805     op = OP_SorterInsert;
806   }else{
807     op = OP_IdxInsert;
808   }
809   sqlite3VdbeAddOp4Int(v, op, pSort->iECursor, regRecord,
810                        regBase+nOBSat, nBase-nOBSat);
811   if( iSkip ){
812     sqlite3VdbeChangeP2(v, iSkip,
813          pSort->labelOBLopt ? pSort->labelOBLopt : sqlite3VdbeCurrentAddr(v));
814   }
815 }
816 
817 /*
818 ** Add code to implement the OFFSET
819 */
820 static void codeOffset(
821   Vdbe *v,          /* Generate code into this VM */
822   int iOffset,      /* Register holding the offset counter */
823   int iContinue     /* Jump here to skip the current record */
824 ){
825   if( iOffset>0 ){
826     sqlite3VdbeAddOp3(v, OP_IfPos, iOffset, iContinue, 1); VdbeCoverage(v);
827     VdbeComment((v, "OFFSET"));
828   }
829 }
830 
831 /*
832 ** Add code that will check to make sure the array of registers starting at
833 ** iMem form a distinct entry. This is used by both "SELECT DISTINCT ..." and
834 ** distinct aggregates ("SELECT count(DISTINCT <expr>) ..."). Three strategies
835 ** are available. Which is used depends on the value of parameter eTnctType,
836 ** as follows:
837 **
838 **   WHERE_DISTINCT_UNORDERED/WHERE_DISTINCT_NOOP:
839 **     Build an ephemeral table that contains all entries seen before and
840 **     skip entries which have been seen before.
841 **
842 **     Parameter iTab is the cursor number of an ephemeral table that must
843 **     be opened before the VM code generated by this routine is executed.
844 **     The ephemeral cursor table is queried for a record identical to the
845 **     record formed by the current array of registers. If one is found,
846 **     jump to VM address addrRepeat. Otherwise, insert a new record into
847 **     the ephemeral cursor and proceed.
848 **
849 **     The returned value in this case is a copy of parameter iTab.
850 **
851 **   WHERE_DISTINCT_ORDERED:
852 **     In this case rows are being delivered sorted order. The ephermal
853 **     table is not required. Instead, the current set of values
854 **     is compared against previous row. If they match, the new row
855 **     is not distinct and control jumps to VM address addrRepeat. Otherwise,
856 **     the VM program proceeds with processing the new row.
857 **
858 **     The returned value in this case is the register number of the first
859 **     in an array of registers used to store the previous result row so that
860 **     it can be compared to the next. The caller must ensure that this
861 **     register is initialized to NULL.  (The fixDistinctOpenEph() routine
862 **     will take care of this initialization.)
863 **
864 **   WHERE_DISTINCT_UNIQUE:
865 **     In this case it has already been determined that the rows are distinct.
866 **     No special action is required. The return value is zero.
867 **
868 ** Parameter pEList is the list of expressions used to generated the
869 ** contents of each row. It is used by this routine to determine (a)
870 ** how many elements there are in the array of registers and (b) the
871 ** collation sequences that should be used for the comparisons if
872 ** eTnctType is WHERE_DISTINCT_ORDERED.
873 */
874 static int codeDistinct(
875   Parse *pParse,     /* Parsing and code generating context */
876   int eTnctType,     /* WHERE_DISTINCT_* value */
877   int iTab,          /* A sorting index used to test for distinctness */
878   int addrRepeat,    /* Jump to here if not distinct */
879   ExprList *pEList,  /* Expression for each element */
880   int regElem        /* First element */
881 ){
882   int iRet = 0;
883   int nResultCol = pEList->nExpr;
884   Vdbe *v = pParse->pVdbe;
885 
886   switch( eTnctType ){
887     case WHERE_DISTINCT_ORDERED: {
888       int i;
889       int iJump;              /* Jump destination */
890       int regPrev;            /* Previous row content */
891 
892       /* Allocate space for the previous row */
893       iRet = regPrev = pParse->nMem+1;
894       pParse->nMem += nResultCol;
895 
896       iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
897       for(i=0; i<nResultCol; i++){
898         CollSeq *pColl = sqlite3ExprCollSeq(pParse, pEList->a[i].pExpr);
899         if( i<nResultCol-1 ){
900           sqlite3VdbeAddOp3(v, OP_Ne, regElem+i, iJump, regPrev+i);
901           VdbeCoverage(v);
902         }else{
903           sqlite3VdbeAddOp3(v, OP_Eq, regElem+i, addrRepeat, regPrev+i);
904           VdbeCoverage(v);
905          }
906         sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
907         sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
908       }
909       assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
910       sqlite3VdbeAddOp3(v, OP_Copy, regElem, regPrev, nResultCol-1);
911       break;
912     }
913 
914     case WHERE_DISTINCT_UNIQUE: {
915       /* nothing to do */
916       break;
917     }
918 
919     default: {
920       int r1 = sqlite3GetTempReg(pParse);
921       sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, regElem, nResultCol);
922       VdbeCoverage(v);
923       sqlite3VdbeAddOp3(v, OP_MakeRecord, regElem, nResultCol, r1);
924       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r1, regElem, nResultCol);
925       sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
926       sqlite3ReleaseTempReg(pParse, r1);
927       iRet = iTab;
928       break;
929     }
930   }
931 
932   return iRet;
933 }
934 
935 /*
936 ** This routine runs after codeDistinct().  It makes necessary
937 ** adjustments to the OP_OpenEphemeral opcode that the codeDistinct()
938 ** routine made use of.  This processing must be done separately since
939 ** sometimes codeDistinct is called before the OP_OpenEphemeral is actually
940 ** laid down.
941 **
942 ** WHERE_DISTINCT_NOOP:
943 ** WHERE_DISTINCT_UNORDERED:
944 **
945 **     No adjustments necessary.  This function is a no-op.
946 **
947 ** WHERE_DISTINCT_UNIQUE:
948 **
949 **     The ephemeral table is not needed.  So change the
950 **     OP_OpenEphemeral opcode into an OP_Noop.
951 **
952 ** WHERE_DISTINCT_ORDERED:
953 **
954 **     The ephemeral table is not needed.  But we do need register
955 **     iVal to be initialized to NULL.  So change the OP_OpenEphemeral
956 **     into an OP_Null on the iVal register.
957 */
958 static void fixDistinctOpenEph(
959   Parse *pParse,     /* Parsing and code generating context */
960   int eTnctType,     /* WHERE_DISTINCT_* value */
961   int iVal,          /* Value returned by codeDistinct() */
962   int iOpenEphAddr   /* Address of OP_OpenEphemeral instruction for iTab */
963 ){
964   if( pParse->nErr==0
965    && (eTnctType==WHERE_DISTINCT_UNIQUE || eTnctType==WHERE_DISTINCT_ORDERED)
966   ){
967     Vdbe *v = pParse->pVdbe;
968     sqlite3VdbeChangeToNoop(v, iOpenEphAddr);
969     if( sqlite3VdbeGetOp(v, iOpenEphAddr+1)->opcode==OP_Explain ){
970       sqlite3VdbeChangeToNoop(v, iOpenEphAddr+1);
971     }
972     if( eTnctType==WHERE_DISTINCT_ORDERED ){
973       /* Change the OP_OpenEphemeral to an OP_Null that sets the MEM_Cleared
974       ** bit on the first register of the previous value.  This will cause the
975       ** OP_Ne added in codeDistinct() to always fail on the first iteration of
976       ** the loop even if the first row is all NULLs.  */
977       VdbeOp *pOp = sqlite3VdbeGetOp(v, iOpenEphAddr);
978       pOp->opcode = OP_Null;
979       pOp->p1 = 1;
980       pOp->p2 = iVal;
981     }
982   }
983 }
984 
985 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
986 /*
987 ** This function is called as part of inner-loop generation for a SELECT
988 ** statement with an ORDER BY that is not optimized by an index. It
989 ** determines the expressions, if any, that the sorter-reference
990 ** optimization should be used for. The sorter-reference optimization
991 ** is used for SELECT queries like:
992 **
993 **   SELECT a, bigblob FROM t1 ORDER BY a LIMIT 10
994 **
995 ** If the optimization is used for expression "bigblob", then instead of
996 ** storing values read from that column in the sorter records, the PK of
997 ** the row from table t1 is stored instead. Then, as records are extracted from
998 ** the sorter to return to the user, the required value of bigblob is
999 ** retrieved directly from table t1. If the values are very large, this
1000 ** can be more efficient than storing them directly in the sorter records.
1001 **
1002 ** The ExprList_item.fg.bSorterRef flag is set for each expression in pEList
1003 ** for which the sorter-reference optimization should be enabled.
1004 ** Additionally, the pSort->aDefer[] array is populated with entries
1005 ** for all cursors required to evaluate all selected expressions. Finally.
1006 ** output variable (*ppExtra) is set to an expression list containing
1007 ** expressions for all extra PK values that should be stored in the
1008 ** sorter records.
1009 */
1010 static void selectExprDefer(
1011   Parse *pParse,                  /* Leave any error here */
1012   SortCtx *pSort,                 /* Sorter context */
1013   ExprList *pEList,               /* Expressions destined for sorter */
1014   ExprList **ppExtra              /* Expressions to append to sorter record */
1015 ){
1016   int i;
1017   int nDefer = 0;
1018   ExprList *pExtra = 0;
1019   for(i=0; i<pEList->nExpr; i++){
1020     struct ExprList_item *pItem = &pEList->a[i];
1021     if( pItem->u.x.iOrderByCol==0 ){
1022       Expr *pExpr = pItem->pExpr;
1023       Table *pTab;
1024       if( pExpr->op==TK_COLUMN
1025        && pExpr->iColumn>=0
1026        && ALWAYS( ExprUseYTab(pExpr) )
1027        && (pTab = pExpr->y.pTab)!=0
1028        && IsOrdinaryTable(pTab)
1029        && (pTab->aCol[pExpr->iColumn].colFlags & COLFLAG_SORTERREF)!=0
1030       ){
1031         int j;
1032         for(j=0; j<nDefer; j++){
1033           if( pSort->aDefer[j].iCsr==pExpr->iTable ) break;
1034         }
1035         if( j==nDefer ){
1036           if( nDefer==ArraySize(pSort->aDefer) ){
1037             continue;
1038           }else{
1039             int nKey = 1;
1040             int k;
1041             Index *pPk = 0;
1042             if( !HasRowid(pTab) ){
1043               pPk = sqlite3PrimaryKeyIndex(pTab);
1044               nKey = pPk->nKeyCol;
1045             }
1046             for(k=0; k<nKey; k++){
1047               Expr *pNew = sqlite3PExpr(pParse, TK_COLUMN, 0, 0);
1048               if( pNew ){
1049                 pNew->iTable = pExpr->iTable;
1050                 assert( ExprUseYTab(pNew) );
1051                 pNew->y.pTab = pExpr->y.pTab;
1052                 pNew->iColumn = pPk ? pPk->aiColumn[k] : -1;
1053                 pExtra = sqlite3ExprListAppend(pParse, pExtra, pNew);
1054               }
1055             }
1056             pSort->aDefer[nDefer].pTab = pExpr->y.pTab;
1057             pSort->aDefer[nDefer].iCsr = pExpr->iTable;
1058             pSort->aDefer[nDefer].nKey = nKey;
1059             nDefer++;
1060           }
1061         }
1062         pItem->fg.bSorterRef = 1;
1063       }
1064     }
1065   }
1066   pSort->nDefer = (u8)nDefer;
1067   *ppExtra = pExtra;
1068 }
1069 #endif
1070 
1071 /*
1072 ** This routine generates the code for the inside of the inner loop
1073 ** of a SELECT.
1074 **
1075 ** If srcTab is negative, then the p->pEList expressions
1076 ** are evaluated in order to get the data for this row.  If srcTab is
1077 ** zero or more, then data is pulled from srcTab and p->pEList is used only
1078 ** to get the number of columns and the collation sequence for each column.
1079 */
1080 static void selectInnerLoop(
1081   Parse *pParse,          /* The parser context */
1082   Select *p,              /* The complete select statement being coded */
1083   int srcTab,             /* Pull data from this table if non-negative */
1084   SortCtx *pSort,         /* If not NULL, info on how to process ORDER BY */
1085   DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
1086   SelectDest *pDest,      /* How to dispose of the results */
1087   int iContinue,          /* Jump here to continue with next row */
1088   int iBreak              /* Jump here to break out of the inner loop */
1089 ){
1090   Vdbe *v = pParse->pVdbe;
1091   int i;
1092   int hasDistinct;            /* True if the DISTINCT keyword is present */
1093   int eDest = pDest->eDest;   /* How to dispose of results */
1094   int iParm = pDest->iSDParm; /* First argument to disposal method */
1095   int nResultCol;             /* Number of result columns */
1096   int nPrefixReg = 0;         /* Number of extra registers before regResult */
1097   RowLoadInfo sRowLoadInfo;   /* Info for deferred row loading */
1098 
1099   /* Usually, regResult is the first cell in an array of memory cells
1100   ** containing the current result row. In this case regOrig is set to the
1101   ** same value. However, if the results are being sent to the sorter, the
1102   ** values for any expressions that are also part of the sort-key are omitted
1103   ** from this array. In this case regOrig is set to zero.  */
1104   int regResult;              /* Start of memory holding current results */
1105   int regOrig;                /* Start of memory holding full result (or 0) */
1106 
1107   assert( v );
1108   assert( p->pEList!=0 );
1109   hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
1110   if( pSort && pSort->pOrderBy==0 ) pSort = 0;
1111   if( pSort==0 && !hasDistinct ){
1112     assert( iContinue!=0 );
1113     codeOffset(v, p->iOffset, iContinue);
1114   }
1115 
1116   /* Pull the requested columns.
1117   */
1118   nResultCol = p->pEList->nExpr;
1119 
1120   if( pDest->iSdst==0 ){
1121     if( pSort ){
1122       nPrefixReg = pSort->pOrderBy->nExpr;
1123       if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
1124       pParse->nMem += nPrefixReg;
1125     }
1126     pDest->iSdst = pParse->nMem+1;
1127     pParse->nMem += nResultCol;
1128   }else if( pDest->iSdst+nResultCol > pParse->nMem ){
1129     /* This is an error condition that can result, for example, when a SELECT
1130     ** on the right-hand side of an INSERT contains more result columns than
1131     ** there are columns in the table on the left.  The error will be caught
1132     ** and reported later.  But we need to make sure enough memory is allocated
1133     ** to avoid other spurious errors in the meantime. */
1134     pParse->nMem += nResultCol;
1135   }
1136   pDest->nSdst = nResultCol;
1137   regOrig = regResult = pDest->iSdst;
1138   if( srcTab>=0 ){
1139     for(i=0; i<nResultCol; i++){
1140       sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
1141       VdbeComment((v, "%s", p->pEList->a[i].zEName));
1142     }
1143   }else if( eDest!=SRT_Exists ){
1144 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1145     ExprList *pExtra = 0;
1146 #endif
1147     /* If the destination is an EXISTS(...) expression, the actual
1148     ** values returned by the SELECT are not required.
1149     */
1150     u8 ecelFlags;    /* "ecel" is an abbreviation of "ExprCodeExprList" */
1151     ExprList *pEList;
1152     if( eDest==SRT_Mem || eDest==SRT_Output || eDest==SRT_Coroutine ){
1153       ecelFlags = SQLITE_ECEL_DUP;
1154     }else{
1155       ecelFlags = 0;
1156     }
1157     if( pSort && hasDistinct==0 && eDest!=SRT_EphemTab && eDest!=SRT_Table ){
1158       /* For each expression in p->pEList that is a copy of an expression in
1159       ** the ORDER BY clause (pSort->pOrderBy), set the associated
1160       ** iOrderByCol value to one more than the index of the ORDER BY
1161       ** expression within the sort-key that pushOntoSorter() will generate.
1162       ** This allows the p->pEList field to be omitted from the sorted record,
1163       ** saving space and CPU cycles.  */
1164       ecelFlags |= (SQLITE_ECEL_OMITREF|SQLITE_ECEL_REF);
1165 
1166       for(i=pSort->nOBSat; i<pSort->pOrderBy->nExpr; i++){
1167         int j;
1168         if( (j = pSort->pOrderBy->a[i].u.x.iOrderByCol)>0 ){
1169           p->pEList->a[j-1].u.x.iOrderByCol = i+1-pSort->nOBSat;
1170         }
1171       }
1172 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1173       selectExprDefer(pParse, pSort, p->pEList, &pExtra);
1174       if( pExtra && pParse->db->mallocFailed==0 ){
1175         /* If there are any extra PK columns to add to the sorter records,
1176         ** allocate extra memory cells and adjust the OpenEphemeral
1177         ** instruction to account for the larger records. This is only
1178         ** required if there are one or more WITHOUT ROWID tables with
1179         ** composite primary keys in the SortCtx.aDefer[] array.  */
1180         VdbeOp *pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
1181         pOp->p2 += (pExtra->nExpr - pSort->nDefer);
1182         pOp->p4.pKeyInfo->nAllField += (pExtra->nExpr - pSort->nDefer);
1183         pParse->nMem += pExtra->nExpr;
1184       }
1185 #endif
1186 
1187       /* Adjust nResultCol to account for columns that are omitted
1188       ** from the sorter by the optimizations in this branch */
1189       pEList = p->pEList;
1190       for(i=0; i<pEList->nExpr; i++){
1191         if( pEList->a[i].u.x.iOrderByCol>0
1192 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1193          || pEList->a[i].fg.bSorterRef
1194 #endif
1195         ){
1196           nResultCol--;
1197           regOrig = 0;
1198         }
1199       }
1200 
1201       testcase( regOrig );
1202       testcase( eDest==SRT_Set );
1203       testcase( eDest==SRT_Mem );
1204       testcase( eDest==SRT_Coroutine );
1205       testcase( eDest==SRT_Output );
1206       assert( eDest==SRT_Set || eDest==SRT_Mem
1207            || eDest==SRT_Coroutine || eDest==SRT_Output
1208            || eDest==SRT_Upfrom );
1209     }
1210     sRowLoadInfo.regResult = regResult;
1211     sRowLoadInfo.ecelFlags = ecelFlags;
1212 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1213     sRowLoadInfo.pExtra = pExtra;
1214     sRowLoadInfo.regExtraResult = regResult + nResultCol;
1215     if( pExtra ) nResultCol += pExtra->nExpr;
1216 #endif
1217     if( p->iLimit
1218      && (ecelFlags & SQLITE_ECEL_OMITREF)!=0
1219      && nPrefixReg>0
1220     ){
1221       assert( pSort!=0 );
1222       assert( hasDistinct==0 );
1223       pSort->pDeferredRowLoad = &sRowLoadInfo;
1224       regOrig = 0;
1225     }else{
1226       innerLoopLoadRow(pParse, p, &sRowLoadInfo);
1227     }
1228   }
1229 
1230   /* If the DISTINCT keyword was present on the SELECT statement
1231   ** and this row has been seen before, then do not make this row
1232   ** part of the result.
1233   */
1234   if( hasDistinct ){
1235     int eType = pDistinct->eTnctType;
1236     int iTab = pDistinct->tabTnct;
1237     assert( nResultCol==p->pEList->nExpr );
1238     iTab = codeDistinct(pParse, eType, iTab, iContinue, p->pEList, regResult);
1239     fixDistinctOpenEph(pParse, eType, iTab, pDistinct->addrTnct);
1240     if( pSort==0 ){
1241       codeOffset(v, p->iOffset, iContinue);
1242     }
1243   }
1244 
1245   switch( eDest ){
1246     /* In this mode, write each query result to the key of the temporary
1247     ** table iParm.
1248     */
1249 #ifndef SQLITE_OMIT_COMPOUND_SELECT
1250     case SRT_Union: {
1251       int r1;
1252       r1 = sqlite3GetTempReg(pParse);
1253       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
1254       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
1255       sqlite3ReleaseTempReg(pParse, r1);
1256       break;
1257     }
1258 
1259     /* Construct a record from the query result, but instead of
1260     ** saving that record, use it as a key to delete elements from
1261     ** the temporary table iParm.
1262     */
1263     case SRT_Except: {
1264       sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
1265       break;
1266     }
1267 #endif /* SQLITE_OMIT_COMPOUND_SELECT */
1268 
1269     /* Store the result as data using a unique key.
1270     */
1271     case SRT_Fifo:
1272     case SRT_DistFifo:
1273     case SRT_Table:
1274     case SRT_EphemTab: {
1275       int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
1276       testcase( eDest==SRT_Table );
1277       testcase( eDest==SRT_EphemTab );
1278       testcase( eDest==SRT_Fifo );
1279       testcase( eDest==SRT_DistFifo );
1280       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
1281 #ifndef SQLITE_OMIT_CTE
1282       if( eDest==SRT_DistFifo ){
1283         /* If the destination is DistFifo, then cursor (iParm+1) is open
1284         ** on an ephemeral index. If the current row is already present
1285         ** in the index, do not write it to the output. If not, add the
1286         ** current row to the index and proceed with writing it to the
1287         ** output table as well.  */
1288         int addr = sqlite3VdbeCurrentAddr(v) + 4;
1289         sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0);
1290         VdbeCoverage(v);
1291         sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm+1, r1,regResult,nResultCol);
1292         assert( pSort==0 );
1293       }
1294 #endif
1295       if( pSort ){
1296         assert( regResult==regOrig );
1297         pushOntoSorter(pParse, pSort, p, r1+nPrefixReg, regOrig, 1, nPrefixReg);
1298       }else{
1299         int r2 = sqlite3GetTempReg(pParse);
1300         sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
1301         sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
1302         sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1303         sqlite3ReleaseTempReg(pParse, r2);
1304       }
1305       sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
1306       break;
1307     }
1308 
1309     case SRT_Upfrom: {
1310       if( pSort ){
1311         pushOntoSorter(
1312             pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
1313       }else{
1314         int i2 = pDest->iSDParm2;
1315         int r1 = sqlite3GetTempReg(pParse);
1316 
1317         /* If the UPDATE FROM join is an aggregate that matches no rows, it
1318         ** might still be trying to return one row, because that is what
1319         ** aggregates do.  Don't record that empty row in the output table. */
1320         sqlite3VdbeAddOp2(v, OP_IsNull, regResult, iBreak); VdbeCoverage(v);
1321 
1322         sqlite3VdbeAddOp3(v, OP_MakeRecord,
1323                           regResult+(i2<0), nResultCol-(i2<0), r1);
1324         if( i2<0 ){
1325           sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regResult);
1326         }else{
1327           sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, i2);
1328         }
1329       }
1330       break;
1331     }
1332 
1333 #ifndef SQLITE_OMIT_SUBQUERY
1334     /* If we are creating a set for an "expr IN (SELECT ...)" construct,
1335     ** then there should be a single item on the stack.  Write this
1336     ** item into the set table with bogus data.
1337     */
1338     case SRT_Set: {
1339       if( pSort ){
1340         /* At first glance you would think we could optimize out the
1341         ** ORDER BY in this case since the order of entries in the set
1342         ** does not matter.  But there might be a LIMIT clause, in which
1343         ** case the order does matter */
1344         pushOntoSorter(
1345             pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
1346       }else{
1347         int r1 = sqlite3GetTempReg(pParse);
1348         assert( sqlite3Strlen30(pDest->zAffSdst)==nResultCol );
1349         sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult, nResultCol,
1350             r1, pDest->zAffSdst, nResultCol);
1351         sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
1352         sqlite3ReleaseTempReg(pParse, r1);
1353       }
1354       break;
1355     }
1356 
1357 
1358     /* If any row exist in the result set, record that fact and abort.
1359     */
1360     case SRT_Exists: {
1361       sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
1362       /* The LIMIT clause will terminate the loop for us */
1363       break;
1364     }
1365 
1366     /* If this is a scalar select that is part of an expression, then
1367     ** store the results in the appropriate memory cell or array of
1368     ** memory cells and break out of the scan loop.
1369     */
1370     case SRT_Mem: {
1371       if( pSort ){
1372         assert( nResultCol<=pDest->nSdst );
1373         pushOntoSorter(
1374             pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
1375       }else{
1376         assert( nResultCol==pDest->nSdst );
1377         assert( regResult==iParm );
1378         /* The LIMIT clause will jump out of the loop for us */
1379       }
1380       break;
1381     }
1382 #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
1383 
1384     case SRT_Coroutine:       /* Send data to a co-routine */
1385     case SRT_Output: {        /* Return the results */
1386       testcase( eDest==SRT_Coroutine );
1387       testcase( eDest==SRT_Output );
1388       if( pSort ){
1389         pushOntoSorter(pParse, pSort, p, regResult, regOrig, nResultCol,
1390                        nPrefixReg);
1391       }else if( eDest==SRT_Coroutine ){
1392         sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
1393       }else{
1394         sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
1395       }
1396       break;
1397     }
1398 
1399 #ifndef SQLITE_OMIT_CTE
1400     /* Write the results into a priority queue that is order according to
1401     ** pDest->pOrderBy (in pSO).  pDest->iSDParm (in iParm) is the cursor for an
1402     ** index with pSO->nExpr+2 columns.  Build a key using pSO for the first
1403     ** pSO->nExpr columns, then make sure all keys are unique by adding a
1404     ** final OP_Sequence column.  The last column is the record as a blob.
1405     */
1406     case SRT_DistQueue:
1407     case SRT_Queue: {
1408       int nKey;
1409       int r1, r2, r3;
1410       int addrTest = 0;
1411       ExprList *pSO;
1412       pSO = pDest->pOrderBy;
1413       assert( pSO );
1414       nKey = pSO->nExpr;
1415       r1 = sqlite3GetTempReg(pParse);
1416       r2 = sqlite3GetTempRange(pParse, nKey+2);
1417       r3 = r2+nKey+1;
1418       if( eDest==SRT_DistQueue ){
1419         /* If the destination is DistQueue, then cursor (iParm+1) is open
1420         ** on a second ephemeral index that holds all values every previously
1421         ** added to the queue. */
1422         addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
1423                                         regResult, nResultCol);
1424         VdbeCoverage(v);
1425       }
1426       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
1427       if( eDest==SRT_DistQueue ){
1428         sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
1429         sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
1430       }
1431       for(i=0; i<nKey; i++){
1432         sqlite3VdbeAddOp2(v, OP_SCopy,
1433                           regResult + pSO->a[i].u.x.iOrderByCol - 1,
1434                           r2+i);
1435       }
1436       sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
1437       sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
1438       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, r2, nKey+2);
1439       if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
1440       sqlite3ReleaseTempReg(pParse, r1);
1441       sqlite3ReleaseTempRange(pParse, r2, nKey+2);
1442       break;
1443     }
1444 #endif /* SQLITE_OMIT_CTE */
1445 
1446 
1447 
1448 #if !defined(SQLITE_OMIT_TRIGGER)
1449     /* Discard the results.  This is used for SELECT statements inside
1450     ** the body of a TRIGGER.  The purpose of such selects is to call
1451     ** user-defined functions that have side effects.  We do not care
1452     ** about the actual results of the select.
1453     */
1454     default: {
1455       assert( eDest==SRT_Discard );
1456       break;
1457     }
1458 #endif
1459   }
1460 
1461   /* Jump to the end of the loop if the LIMIT is reached.  Except, if
1462   ** there is a sorter, in which case the sorter has already limited
1463   ** the output for us.
1464   */
1465   if( pSort==0 && p->iLimit ){
1466     sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
1467   }
1468 }
1469 
1470 /*
1471 ** Allocate a KeyInfo object sufficient for an index of N key columns and
1472 ** X extra columns.
1473 */
1474 KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
1475   int nExtra = (N+X)*(sizeof(CollSeq*)+1) - sizeof(CollSeq*);
1476   KeyInfo *p = sqlite3DbMallocRawNN(db, sizeof(KeyInfo) + nExtra);
1477   if( p ){
1478     p->aSortFlags = (u8*)&p->aColl[N+X];
1479     p->nKeyField = (u16)N;
1480     p->nAllField = (u16)(N+X);
1481     p->enc = ENC(db);
1482     p->db = db;
1483     p->nRef = 1;
1484     memset(&p[1], 0, nExtra);
1485   }else{
1486     return (KeyInfo*)sqlite3OomFault(db);
1487   }
1488   return p;
1489 }
1490 
1491 /*
1492 ** Deallocate a KeyInfo object
1493 */
1494 void sqlite3KeyInfoUnref(KeyInfo *p){
1495   if( p ){
1496     assert( p->nRef>0 );
1497     p->nRef--;
1498     if( p->nRef==0 ) sqlite3DbFreeNN(p->db, p);
1499   }
1500 }
1501 
1502 /*
1503 ** Make a new pointer to a KeyInfo object
1504 */
1505 KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
1506   if( p ){
1507     assert( p->nRef>0 );
1508     p->nRef++;
1509   }
1510   return p;
1511 }
1512 
1513 #ifdef SQLITE_DEBUG
1514 /*
1515 ** Return TRUE if a KeyInfo object can be change.  The KeyInfo object
1516 ** can only be changed if this is just a single reference to the object.
1517 **
1518 ** This routine is used only inside of assert() statements.
1519 */
1520 int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
1521 #endif /* SQLITE_DEBUG */
1522 
1523 /*
1524 ** Given an expression list, generate a KeyInfo structure that records
1525 ** the collating sequence for each expression in that expression list.
1526 **
1527 ** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
1528 ** KeyInfo structure is appropriate for initializing a virtual index to
1529 ** implement that clause.  If the ExprList is the result set of a SELECT
1530 ** then the KeyInfo structure is appropriate for initializing a virtual
1531 ** index to implement a DISTINCT test.
1532 **
1533 ** Space to hold the KeyInfo structure is obtained from malloc.  The calling
1534 ** function is responsible for seeing that this structure is eventually
1535 ** freed.
1536 */
1537 KeyInfo *sqlite3KeyInfoFromExprList(
1538   Parse *pParse,       /* Parsing context */
1539   ExprList *pList,     /* Form the KeyInfo object from this ExprList */
1540   int iStart,          /* Begin with this column of pList */
1541   int nExtra           /* Add this many extra columns to the end */
1542 ){
1543   int nExpr;
1544   KeyInfo *pInfo;
1545   struct ExprList_item *pItem;
1546   sqlite3 *db = pParse->db;
1547   int i;
1548 
1549   nExpr = pList->nExpr;
1550   pInfo = sqlite3KeyInfoAlloc(db, nExpr-iStart, nExtra+1);
1551   if( pInfo ){
1552     assert( sqlite3KeyInfoIsWriteable(pInfo) );
1553     for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
1554       pInfo->aColl[i-iStart] = sqlite3ExprNNCollSeq(pParse, pItem->pExpr);
1555       pInfo->aSortFlags[i-iStart] = pItem->fg.sortFlags;
1556     }
1557   }
1558   return pInfo;
1559 }
1560 
1561 /*
1562 ** Name of the connection operator, used for error messages.
1563 */
1564 const char *sqlite3SelectOpName(int id){
1565   char *z;
1566   switch( id ){
1567     case TK_ALL:       z = "UNION ALL";   break;
1568     case TK_INTERSECT: z = "INTERSECT";   break;
1569     case TK_EXCEPT:    z = "EXCEPT";      break;
1570     default:           z = "UNION";       break;
1571   }
1572   return z;
1573 }
1574 
1575 #ifndef SQLITE_OMIT_EXPLAIN
1576 /*
1577 ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
1578 ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
1579 ** where the caption is of the form:
1580 **
1581 **   "USE TEMP B-TREE FOR xxx"
1582 **
1583 ** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
1584 ** is determined by the zUsage argument.
1585 */
1586 static void explainTempTable(Parse *pParse, const char *zUsage){
1587   ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s", zUsage));
1588 }
1589 
1590 /*
1591 ** Assign expression b to lvalue a. A second, no-op, version of this macro
1592 ** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
1593 ** in sqlite3Select() to assign values to structure member variables that
1594 ** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
1595 ** code with #ifndef directives.
1596 */
1597 # define explainSetInteger(a, b) a = b
1598 
1599 #else
1600 /* No-op versions of the explainXXX() functions and macros. */
1601 # define explainTempTable(y,z)
1602 # define explainSetInteger(y,z)
1603 #endif
1604 
1605 
1606 /*
1607 ** If the inner loop was generated using a non-null pOrderBy argument,
1608 ** then the results were placed in a sorter.  After the loop is terminated
1609 ** we need to run the sorter and output the results.  The following
1610 ** routine generates the code needed to do that.
1611 */
1612 static void generateSortTail(
1613   Parse *pParse,    /* Parsing context */
1614   Select *p,        /* The SELECT statement */
1615   SortCtx *pSort,   /* Information on the ORDER BY clause */
1616   int nColumn,      /* Number of columns of data */
1617   SelectDest *pDest /* Write the sorted results here */
1618 ){
1619   Vdbe *v = pParse->pVdbe;                     /* The prepared statement */
1620   int addrBreak = pSort->labelDone;            /* Jump here to exit loop */
1621   int addrContinue = sqlite3VdbeMakeLabel(pParse);/* Jump here for next cycle */
1622   int addr;                       /* Top of output loop. Jump for Next. */
1623   int addrOnce = 0;
1624   int iTab;
1625   ExprList *pOrderBy = pSort->pOrderBy;
1626   int eDest = pDest->eDest;
1627   int iParm = pDest->iSDParm;
1628   int regRow;
1629   int regRowid;
1630   int iCol;
1631   int nKey;                       /* Number of key columns in sorter record */
1632   int iSortTab;                   /* Sorter cursor to read from */
1633   int i;
1634   int bSeq;                       /* True if sorter record includes seq. no. */
1635   int nRefKey = 0;
1636   struct ExprList_item *aOutEx = p->pEList->a;
1637 
1638   assert( addrBreak<0 );
1639   if( pSort->labelBkOut ){
1640     sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
1641     sqlite3VdbeGoto(v, addrBreak);
1642     sqlite3VdbeResolveLabel(v, pSort->labelBkOut);
1643   }
1644 
1645 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1646   /* Open any cursors needed for sorter-reference expressions */
1647   for(i=0; i<pSort->nDefer; i++){
1648     Table *pTab = pSort->aDefer[i].pTab;
1649     int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
1650     sqlite3OpenTable(pParse, pSort->aDefer[i].iCsr, iDb, pTab, OP_OpenRead);
1651     nRefKey = MAX(nRefKey, pSort->aDefer[i].nKey);
1652   }
1653 #endif
1654 
1655   iTab = pSort->iECursor;
1656   if( eDest==SRT_Output || eDest==SRT_Coroutine || eDest==SRT_Mem ){
1657     if( eDest==SRT_Mem && p->iOffset ){
1658       sqlite3VdbeAddOp2(v, OP_Null, 0, pDest->iSdst);
1659     }
1660     regRowid = 0;
1661     regRow = pDest->iSdst;
1662   }else{
1663     regRowid = sqlite3GetTempReg(pParse);
1664     if( eDest==SRT_EphemTab || eDest==SRT_Table ){
1665       regRow = sqlite3GetTempReg(pParse);
1666       nColumn = 0;
1667     }else{
1668       regRow = sqlite3GetTempRange(pParse, nColumn);
1669     }
1670   }
1671   nKey = pOrderBy->nExpr - pSort->nOBSat;
1672   if( pSort->sortFlags & SORTFLAG_UseSorter ){
1673     int regSortOut = ++pParse->nMem;
1674     iSortTab = pParse->nTab++;
1675     if( pSort->labelBkOut ){
1676       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
1677     }
1678     sqlite3VdbeAddOp3(v, OP_OpenPseudo, iSortTab, regSortOut,
1679         nKey+1+nColumn+nRefKey);
1680     if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
1681     addr = 1 + sqlite3VdbeAddOp2(v, OP_SorterSort, iTab, addrBreak);
1682     VdbeCoverage(v);
1683     codeOffset(v, p->iOffset, addrContinue);
1684     sqlite3VdbeAddOp3(v, OP_SorterData, iTab, regSortOut, iSortTab);
1685     bSeq = 0;
1686   }else{
1687     addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
1688     codeOffset(v, p->iOffset, addrContinue);
1689     iSortTab = iTab;
1690     bSeq = 1;
1691   }
1692   for(i=0, iCol=nKey+bSeq-1; i<nColumn; i++){
1693 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1694     if( aOutEx[i].fg.bSorterRef ) continue;
1695 #endif
1696     if( aOutEx[i].u.x.iOrderByCol==0 ) iCol++;
1697   }
1698 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1699   if( pSort->nDefer ){
1700     int iKey = iCol+1;
1701     int regKey = sqlite3GetTempRange(pParse, nRefKey);
1702 
1703     for(i=0; i<pSort->nDefer; i++){
1704       int iCsr = pSort->aDefer[i].iCsr;
1705       Table *pTab = pSort->aDefer[i].pTab;
1706       int nKey = pSort->aDefer[i].nKey;
1707 
1708       sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1709       if( HasRowid(pTab) ){
1710         sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey);
1711         sqlite3VdbeAddOp3(v, OP_SeekRowid, iCsr,
1712             sqlite3VdbeCurrentAddr(v)+1, regKey);
1713       }else{
1714         int k;
1715         int iJmp;
1716         assert( sqlite3PrimaryKeyIndex(pTab)->nKeyCol==nKey );
1717         for(k=0; k<nKey; k++){
1718           sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey+k);
1719         }
1720         iJmp = sqlite3VdbeCurrentAddr(v);
1721         sqlite3VdbeAddOp4Int(v, OP_SeekGE, iCsr, iJmp+2, regKey, nKey);
1722         sqlite3VdbeAddOp4Int(v, OP_IdxLE, iCsr, iJmp+3, regKey, nKey);
1723         sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1724       }
1725     }
1726     sqlite3ReleaseTempRange(pParse, regKey, nRefKey);
1727   }
1728 #endif
1729   for(i=nColumn-1; i>=0; i--){
1730 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1731     if( aOutEx[i].fg.bSorterRef ){
1732       sqlite3ExprCode(pParse, aOutEx[i].pExpr, regRow+i);
1733     }else
1734 #endif
1735     {
1736       int iRead;
1737       if( aOutEx[i].u.x.iOrderByCol ){
1738         iRead = aOutEx[i].u.x.iOrderByCol-1;
1739       }else{
1740         iRead = iCol--;
1741       }
1742       sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iRead, regRow+i);
1743       VdbeComment((v, "%s", aOutEx[i].zEName));
1744     }
1745   }
1746   switch( eDest ){
1747     case SRT_Table:
1748     case SRT_EphemTab: {
1749       sqlite3VdbeAddOp3(v, OP_Column, iSortTab, nKey+bSeq, regRow);
1750       sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
1751       sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
1752       sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1753       break;
1754     }
1755 #ifndef SQLITE_OMIT_SUBQUERY
1756     case SRT_Set: {
1757       assert( nColumn==sqlite3Strlen30(pDest->zAffSdst) );
1758       sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, nColumn, regRowid,
1759                         pDest->zAffSdst, nColumn);
1760       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, regRowid, regRow, nColumn);
1761       break;
1762     }
1763     case SRT_Mem: {
1764       /* The LIMIT clause will terminate the loop for us */
1765       break;
1766     }
1767 #endif
1768     case SRT_Upfrom: {
1769       int i2 = pDest->iSDParm2;
1770       int r1 = sqlite3GetTempReg(pParse);
1771       sqlite3VdbeAddOp3(v, OP_MakeRecord,regRow+(i2<0),nColumn-(i2<0),r1);
1772       if( i2<0 ){
1773         sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regRow);
1774       }else{
1775         sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regRow, i2);
1776       }
1777       break;
1778     }
1779     default: {
1780       assert( eDest==SRT_Output || eDest==SRT_Coroutine );
1781       testcase( eDest==SRT_Output );
1782       testcase( eDest==SRT_Coroutine );
1783       if( eDest==SRT_Output ){
1784         sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
1785       }else{
1786         sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
1787       }
1788       break;
1789     }
1790   }
1791   if( regRowid ){
1792     if( eDest==SRT_Set ){
1793       sqlite3ReleaseTempRange(pParse, regRow, nColumn);
1794     }else{
1795       sqlite3ReleaseTempReg(pParse, regRow);
1796     }
1797     sqlite3ReleaseTempReg(pParse, regRowid);
1798   }
1799   /* The bottom of the loop
1800   */
1801   sqlite3VdbeResolveLabel(v, addrContinue);
1802   if( pSort->sortFlags & SORTFLAG_UseSorter ){
1803     sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
1804   }else{
1805     sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
1806   }
1807   if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
1808   sqlite3VdbeResolveLabel(v, addrBreak);
1809 }
1810 
1811 /*
1812 ** Return a pointer to a string containing the 'declaration type' of the
1813 ** expression pExpr. The string may be treated as static by the caller.
1814 **
1815 ** Also try to estimate the size of the returned value and return that
1816 ** result in *pEstWidth.
1817 **
1818 ** The declaration type is the exact datatype definition extracted from the
1819 ** original CREATE TABLE statement if the expression is a column. The
1820 ** declaration type for a ROWID field is INTEGER. Exactly when an expression
1821 ** is considered a column can be complex in the presence of subqueries. The
1822 ** result-set expression in all of the following SELECT statements is
1823 ** considered a column by this function.
1824 **
1825 **   SELECT col FROM tbl;
1826 **   SELECT (SELECT col FROM tbl;
1827 **   SELECT (SELECT col FROM tbl);
1828 **   SELECT abc FROM (SELECT col AS abc FROM tbl);
1829 **
1830 ** The declaration type for any expression other than a column is NULL.
1831 **
1832 ** This routine has either 3 or 6 parameters depending on whether or not
1833 ** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
1834 */
1835 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1836 # define columnType(A,B,C,D,E) columnTypeImpl(A,B,C,D,E)
1837 #else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
1838 # define columnType(A,B,C,D,E) columnTypeImpl(A,B)
1839 #endif
1840 static const char *columnTypeImpl(
1841   NameContext *pNC,
1842 #ifndef SQLITE_ENABLE_COLUMN_METADATA
1843   Expr *pExpr
1844 #else
1845   Expr *pExpr,
1846   const char **pzOrigDb,
1847   const char **pzOrigTab,
1848   const char **pzOrigCol
1849 #endif
1850 ){
1851   char const *zType = 0;
1852   int j;
1853 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1854   char const *zOrigDb = 0;
1855   char const *zOrigTab = 0;
1856   char const *zOrigCol = 0;
1857 #endif
1858 
1859   assert( pExpr!=0 );
1860   assert( pNC->pSrcList!=0 );
1861   switch( pExpr->op ){
1862     case TK_COLUMN: {
1863       /* The expression is a column. Locate the table the column is being
1864       ** extracted from in NameContext.pSrcList. This table may be real
1865       ** database table or a subquery.
1866       */
1867       Table *pTab = 0;            /* Table structure column is extracted from */
1868       Select *pS = 0;             /* Select the column is extracted from */
1869       int iCol = pExpr->iColumn;  /* Index of column in pTab */
1870       while( pNC && !pTab ){
1871         SrcList *pTabList = pNC->pSrcList;
1872         for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
1873         if( j<pTabList->nSrc ){
1874           pTab = pTabList->a[j].pTab;
1875           pS = pTabList->a[j].pSelect;
1876         }else{
1877           pNC = pNC->pNext;
1878         }
1879       }
1880 
1881       if( pTab==0 ){
1882         /* At one time, code such as "SELECT new.x" within a trigger would
1883         ** cause this condition to run.  Since then, we have restructured how
1884         ** trigger code is generated and so this condition is no longer
1885         ** possible. However, it can still be true for statements like
1886         ** the following:
1887         **
1888         **   CREATE TABLE t1(col INTEGER);
1889         **   SELECT (SELECT t1.col) FROM FROM t1;
1890         **
1891         ** when columnType() is called on the expression "t1.col" in the
1892         ** sub-select. In this case, set the column type to NULL, even
1893         ** though it should really be "INTEGER".
1894         **
1895         ** This is not a problem, as the column type of "t1.col" is never
1896         ** used. When columnType() is called on the expression
1897         ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
1898         ** branch below.  */
1899         break;
1900       }
1901 
1902       assert( pTab && ExprUseYTab(pExpr) && pExpr->y.pTab==pTab );
1903       if( pS ){
1904         /* The "table" is actually a sub-select or a view in the FROM clause
1905         ** of the SELECT statement. Return the declaration type and origin
1906         ** data for the result-set column of the sub-select.
1907         */
1908         if( iCol<pS->pEList->nExpr
1909 #ifdef SQLITE_ALLOW_ROWID_IN_VIEW
1910          && iCol>=0
1911 #else
1912          && ALWAYS(iCol>=0)
1913 #endif
1914         ){
1915           /* If iCol is less than zero, then the expression requests the
1916           ** rowid of the sub-select or view. This expression is legal (see
1917           ** test case misc2.2.2) - it always evaluates to NULL.
1918           */
1919           NameContext sNC;
1920           Expr *p = pS->pEList->a[iCol].pExpr;
1921           sNC.pSrcList = pS->pSrc;
1922           sNC.pNext = pNC;
1923           sNC.pParse = pNC->pParse;
1924           zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol);
1925         }
1926       }else{
1927         /* A real table or a CTE table */
1928         assert( !pS );
1929 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1930         if( iCol<0 ) iCol = pTab->iPKey;
1931         assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
1932         if( iCol<0 ){
1933           zType = "INTEGER";
1934           zOrigCol = "rowid";
1935         }else{
1936           zOrigCol = pTab->aCol[iCol].zCnName;
1937           zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
1938         }
1939         zOrigTab = pTab->zName;
1940         if( pNC->pParse && pTab->pSchema ){
1941           int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
1942           zOrigDb = pNC->pParse->db->aDb[iDb].zDbSName;
1943         }
1944 #else
1945         assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
1946         if( iCol<0 ){
1947           zType = "INTEGER";
1948         }else{
1949           zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
1950         }
1951 #endif
1952       }
1953       break;
1954     }
1955 #ifndef SQLITE_OMIT_SUBQUERY
1956     case TK_SELECT: {
1957       /* The expression is a sub-select. Return the declaration type and
1958       ** origin info for the single column in the result set of the SELECT
1959       ** statement.
1960       */
1961       NameContext sNC;
1962       Select *pS;
1963       Expr *p;
1964       assert( ExprUseXSelect(pExpr) );
1965       pS = pExpr->x.pSelect;
1966       p = pS->pEList->a[0].pExpr;
1967       sNC.pSrcList = pS->pSrc;
1968       sNC.pNext = pNC;
1969       sNC.pParse = pNC->pParse;
1970       zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
1971       break;
1972     }
1973 #endif
1974   }
1975 
1976 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1977   if( pzOrigDb ){
1978     assert( pzOrigTab && pzOrigCol );
1979     *pzOrigDb = zOrigDb;
1980     *pzOrigTab = zOrigTab;
1981     *pzOrigCol = zOrigCol;
1982   }
1983 #endif
1984   return zType;
1985 }
1986 
1987 /*
1988 ** Generate code that will tell the VDBE the declaration types of columns
1989 ** in the result set.
1990 */
1991 static void generateColumnTypes(
1992   Parse *pParse,      /* Parser context */
1993   SrcList *pTabList,  /* List of tables */
1994   ExprList *pEList    /* Expressions defining the result set */
1995 ){
1996 #ifndef SQLITE_OMIT_DECLTYPE
1997   Vdbe *v = pParse->pVdbe;
1998   int i;
1999   NameContext sNC;
2000   sNC.pSrcList = pTabList;
2001   sNC.pParse = pParse;
2002   sNC.pNext = 0;
2003   for(i=0; i<pEList->nExpr; i++){
2004     Expr *p = pEList->a[i].pExpr;
2005     const char *zType;
2006 #ifdef SQLITE_ENABLE_COLUMN_METADATA
2007     const char *zOrigDb = 0;
2008     const char *zOrigTab = 0;
2009     const char *zOrigCol = 0;
2010     zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
2011 
2012     /* The vdbe must make its own copy of the column-type and other
2013     ** column specific strings, in case the schema is reset before this
2014     ** virtual machine is deleted.
2015     */
2016     sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
2017     sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
2018     sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
2019 #else
2020     zType = columnType(&sNC, p, 0, 0, 0);
2021 #endif
2022     sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
2023   }
2024 #endif /* !defined(SQLITE_OMIT_DECLTYPE) */
2025 }
2026 
2027 
2028 /*
2029 ** Compute the column names for a SELECT statement.
2030 **
2031 ** The only guarantee that SQLite makes about column names is that if the
2032 ** column has an AS clause assigning it a name, that will be the name used.
2033 ** That is the only documented guarantee.  However, countless applications
2034 ** developed over the years have made baseless assumptions about column names
2035 ** and will break if those assumptions changes.  Hence, use extreme caution
2036 ** when modifying this routine to avoid breaking legacy.
2037 **
2038 ** See Also: sqlite3ColumnsFromExprList()
2039 **
2040 ** The PRAGMA short_column_names and PRAGMA full_column_names settings are
2041 ** deprecated.  The default setting is short=ON, full=OFF.  99.9% of all
2042 ** applications should operate this way.  Nevertheless, we need to support the
2043 ** other modes for legacy:
2044 **
2045 **    short=OFF, full=OFF:      Column name is the text of the expression has it
2046 **                              originally appears in the SELECT statement.  In
2047 **                              other words, the zSpan of the result expression.
2048 **
2049 **    short=ON, full=OFF:       (This is the default setting).  If the result
2050 **                              refers directly to a table column, then the
2051 **                              result column name is just the table column
2052 **                              name: COLUMN.  Otherwise use zSpan.
2053 **
2054 **    full=ON, short=ANY:       If the result refers directly to a table column,
2055 **                              then the result column name with the table name
2056 **                              prefix, ex: TABLE.COLUMN.  Otherwise use zSpan.
2057 */
2058 void sqlite3GenerateColumnNames(
2059   Parse *pParse,      /* Parser context */
2060   Select *pSelect     /* Generate column names for this SELECT statement */
2061 ){
2062   Vdbe *v = pParse->pVdbe;
2063   int i;
2064   Table *pTab;
2065   SrcList *pTabList;
2066   ExprList *pEList;
2067   sqlite3 *db = pParse->db;
2068   int fullName;    /* TABLE.COLUMN if no AS clause and is a direct table ref */
2069   int srcName;     /* COLUMN or TABLE.COLUMN if no AS clause and is direct */
2070 
2071 #ifndef SQLITE_OMIT_EXPLAIN
2072   /* If this is an EXPLAIN, skip this step */
2073   if( pParse->explain ){
2074     return;
2075   }
2076 #endif
2077 
2078   if( pParse->colNamesSet ) return;
2079   /* Column names are determined by the left-most term of a compound select */
2080   while( pSelect->pPrior ) pSelect = pSelect->pPrior;
2081   SELECTTRACE(1,pParse,pSelect,("generating column names\n"));
2082   pTabList = pSelect->pSrc;
2083   pEList = pSelect->pEList;
2084   assert( v!=0 );
2085   assert( pTabList!=0 );
2086   pParse->colNamesSet = 1;
2087   fullName = (db->flags & SQLITE_FullColNames)!=0;
2088   srcName = (db->flags & SQLITE_ShortColNames)!=0 || fullName;
2089   sqlite3VdbeSetNumCols(v, pEList->nExpr);
2090   for(i=0; i<pEList->nExpr; i++){
2091     Expr *p = pEList->a[i].pExpr;
2092 
2093     assert( p!=0 );
2094     assert( p->op!=TK_AGG_COLUMN );  /* Agg processing has not run yet */
2095     assert( p->op!=TK_COLUMN
2096         || (ExprUseYTab(p) && p->y.pTab!=0) ); /* Covering idx not yet coded */
2097     if( pEList->a[i].zEName && pEList->a[i].fg.eEName==ENAME_NAME ){
2098       /* An AS clause always takes first priority */
2099       char *zName = pEList->a[i].zEName;
2100       sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
2101     }else if( srcName && p->op==TK_COLUMN ){
2102       char *zCol;
2103       int iCol = p->iColumn;
2104       pTab = p->y.pTab;
2105       assert( pTab!=0 );
2106       if( iCol<0 ) iCol = pTab->iPKey;
2107       assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
2108       if( iCol<0 ){
2109         zCol = "rowid";
2110       }else{
2111         zCol = pTab->aCol[iCol].zCnName;
2112       }
2113       if( fullName ){
2114         char *zName = 0;
2115         zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
2116         sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
2117       }else{
2118         sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
2119       }
2120     }else{
2121       const char *z = pEList->a[i].zEName;
2122       z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
2123       sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
2124     }
2125   }
2126   generateColumnTypes(pParse, pTabList, pEList);
2127 }
2128 
2129 /*
2130 ** Given an expression list (which is really the list of expressions
2131 ** that form the result set of a SELECT statement) compute appropriate
2132 ** column names for a table that would hold the expression list.
2133 **
2134 ** All column names will be unique.
2135 **
2136 ** Only the column names are computed.  Column.zType, Column.zColl,
2137 ** and other fields of Column are zeroed.
2138 **
2139 ** Return SQLITE_OK on success.  If a memory allocation error occurs,
2140 ** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
2141 **
2142 ** The only guarantee that SQLite makes about column names is that if the
2143 ** column has an AS clause assigning it a name, that will be the name used.
2144 ** That is the only documented guarantee.  However, countless applications
2145 ** developed over the years have made baseless assumptions about column names
2146 ** and will break if those assumptions changes.  Hence, use extreme caution
2147 ** when modifying this routine to avoid breaking legacy.
2148 **
2149 ** See Also: sqlite3GenerateColumnNames()
2150 */
2151 int sqlite3ColumnsFromExprList(
2152   Parse *pParse,          /* Parsing context */
2153   ExprList *pEList,       /* Expr list from which to derive column names */
2154   i16 *pnCol,             /* Write the number of columns here */
2155   Column **paCol          /* Write the new column list here */
2156 ){
2157   sqlite3 *db = pParse->db;   /* Database connection */
2158   int i, j;                   /* Loop counters */
2159   u32 cnt;                    /* Index added to make the name unique */
2160   Column *aCol, *pCol;        /* For looping over result columns */
2161   int nCol;                   /* Number of columns in the result set */
2162   char *zName;                /* Column name */
2163   int nName;                  /* Size of name in zName[] */
2164   Hash ht;                    /* Hash table of column names */
2165   Table *pTab;
2166 
2167   sqlite3HashInit(&ht);
2168   if( pEList ){
2169     nCol = pEList->nExpr;
2170     aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
2171     testcase( aCol==0 );
2172     if( NEVER(nCol>32767) ) nCol = 32767;
2173   }else{
2174     nCol = 0;
2175     aCol = 0;
2176   }
2177   assert( nCol==(i16)nCol );
2178   *pnCol = nCol;
2179   *paCol = aCol;
2180 
2181   for(i=0, pCol=aCol; i<nCol && !db->mallocFailed; i++, pCol++){
2182     struct ExprList_item *pX = &pEList->a[i];
2183     struct ExprList_item *pCollide;
2184     /* Get an appropriate name for the column
2185     */
2186     if( (zName = pX->zEName)!=0 && pX->fg.eEName==ENAME_NAME ){
2187       /* If the column contains an "AS <name>" phrase, use <name> as the name */
2188     }else{
2189       Expr *pColExpr = sqlite3ExprSkipCollateAndLikely(pX->pExpr);
2190       while( ALWAYS(pColExpr!=0) && pColExpr->op==TK_DOT ){
2191         pColExpr = pColExpr->pRight;
2192         assert( pColExpr!=0 );
2193       }
2194       if( pColExpr->op==TK_COLUMN
2195        && ALWAYS( ExprUseYTab(pColExpr) )
2196        && ALWAYS( pColExpr->y.pTab!=0 )
2197       ){
2198         /* For columns use the column name name */
2199         int iCol = pColExpr->iColumn;
2200         pTab = pColExpr->y.pTab;
2201         if( iCol<0 ) iCol = pTab->iPKey;
2202         zName = iCol>=0 ? pTab->aCol[iCol].zCnName : "rowid";
2203       }else if( pColExpr->op==TK_ID ){
2204         assert( !ExprHasProperty(pColExpr, EP_IntValue) );
2205         zName = pColExpr->u.zToken;
2206       }else{
2207         /* Use the original text of the column expression as its name */
2208         assert( zName==pX->zEName );  /* pointer comparison intended */
2209       }
2210     }
2211     if( zName && !sqlite3IsTrueOrFalse(zName) ){
2212       zName = sqlite3DbStrDup(db, zName);
2213     }else{
2214       zName = sqlite3MPrintf(db,"column%d",i+1);
2215     }
2216 
2217     /* Make sure the column name is unique.  If the name is not unique,
2218     ** append an integer to the name so that it becomes unique.
2219     */
2220     cnt = 0;
2221     while( zName && (pCollide = sqlite3HashFind(&ht, zName))!=0 ){
2222       if( pCollide->fg.bUsingTerm ){
2223         pCol->colFlags |= COLFLAG_NOEXPAND;
2224       }
2225       nName = sqlite3Strlen30(zName);
2226       if( nName>0 ){
2227         for(j=nName-1; j>0 && sqlite3Isdigit(zName[j]); j--){}
2228         if( zName[j]==':' ) nName = j;
2229       }
2230       zName = sqlite3MPrintf(db, "%.*z:%u", nName, zName, ++cnt);
2231       if( cnt>3 ) sqlite3_randomness(sizeof(cnt), &cnt);
2232     }
2233     pCol->zCnName = zName;
2234     pCol->hName = sqlite3StrIHash(zName);
2235     if( pX->fg.bNoExpand ){
2236       pCol->colFlags |= COLFLAG_NOEXPAND;
2237     }
2238     sqlite3ColumnPropertiesFromName(0, pCol);
2239     if( zName && sqlite3HashInsert(&ht, zName, pX)==pX ){
2240       sqlite3OomFault(db);
2241     }
2242   }
2243   sqlite3HashClear(&ht);
2244   if( db->mallocFailed ){
2245     for(j=0; j<i; j++){
2246       sqlite3DbFree(db, aCol[j].zCnName);
2247     }
2248     sqlite3DbFree(db, aCol);
2249     *paCol = 0;
2250     *pnCol = 0;
2251     return SQLITE_NOMEM_BKPT;
2252   }
2253   return SQLITE_OK;
2254 }
2255 
2256 /*
2257 ** Add type and collation information to a column list based on
2258 ** a SELECT statement.
2259 **
2260 ** The column list presumably came from selectColumnNamesFromExprList().
2261 ** The column list has only names, not types or collations.  This
2262 ** routine goes through and adds the types and collations.
2263 **
2264 ** This routine requires that all identifiers in the SELECT
2265 ** statement be resolved.
2266 */
2267 void sqlite3SelectAddColumnTypeAndCollation(
2268   Parse *pParse,        /* Parsing contexts */
2269   Table *pTab,          /* Add column type information to this table */
2270   Select *pSelect,      /* SELECT used to determine types and collations */
2271   char aff              /* Default affinity for columns */
2272 ){
2273   sqlite3 *db = pParse->db;
2274   NameContext sNC;
2275   Column *pCol;
2276   CollSeq *pColl;
2277   int i;
2278   Expr *p;
2279   struct ExprList_item *a;
2280 
2281   assert( pSelect!=0 );
2282   assert( (pSelect->selFlags & SF_Resolved)!=0 );
2283   assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
2284   if( db->mallocFailed ) return;
2285   memset(&sNC, 0, sizeof(sNC));
2286   sNC.pSrcList = pSelect->pSrc;
2287   a = pSelect->pEList->a;
2288   for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
2289     const char *zType;
2290     i64 n, m;
2291     pTab->tabFlags |= (pCol->colFlags & COLFLAG_NOINSERT);
2292     p = a[i].pExpr;
2293     zType = columnType(&sNC, p, 0, 0, 0);
2294     /* pCol->szEst = ... // Column size est for SELECT tables never used */
2295     pCol->affinity = sqlite3ExprAffinity(p);
2296     if( zType ){
2297       m = sqlite3Strlen30(zType);
2298       n = sqlite3Strlen30(pCol->zCnName);
2299       pCol->zCnName = sqlite3DbReallocOrFree(db, pCol->zCnName, n+m+2);
2300       if( pCol->zCnName ){
2301         memcpy(&pCol->zCnName[n+1], zType, m+1);
2302         pCol->colFlags |= COLFLAG_HASTYPE;
2303       }else{
2304         testcase( pCol->colFlags & COLFLAG_HASTYPE );
2305         pCol->colFlags &= ~(COLFLAG_HASTYPE|COLFLAG_HASCOLL);
2306       }
2307     }
2308     if( pCol->affinity<=SQLITE_AFF_NONE ) pCol->affinity = aff;
2309     pColl = sqlite3ExprCollSeq(pParse, p);
2310     if( pColl ){
2311       assert( pTab->pIndex==0 );
2312       sqlite3ColumnSetColl(db, pCol, pColl->zName);
2313     }
2314   }
2315   pTab->szTabRow = 1; /* Any non-zero value works */
2316 }
2317 
2318 /*
2319 ** Given a SELECT statement, generate a Table structure that describes
2320 ** the result set of that SELECT.
2321 */
2322 Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect, char aff){
2323   Table *pTab;
2324   sqlite3 *db = pParse->db;
2325   u64 savedFlags;
2326 
2327   savedFlags = db->flags;
2328   db->flags &= ~(u64)SQLITE_FullColNames;
2329   db->flags |= SQLITE_ShortColNames;
2330   sqlite3SelectPrep(pParse, pSelect, 0);
2331   db->flags = savedFlags;
2332   if( pParse->nErr ) return 0;
2333   while( pSelect->pPrior ) pSelect = pSelect->pPrior;
2334   pTab = sqlite3DbMallocZero(db, sizeof(Table) );
2335   if( pTab==0 ){
2336     return 0;
2337   }
2338   pTab->nTabRef = 1;
2339   pTab->zName = 0;
2340   pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
2341   sqlite3ColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
2342   sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSelect, aff);
2343   pTab->iPKey = -1;
2344   if( db->mallocFailed ){
2345     sqlite3DeleteTable(db, pTab);
2346     return 0;
2347   }
2348   return pTab;
2349 }
2350 
2351 /*
2352 ** Get a VDBE for the given parser context.  Create a new one if necessary.
2353 ** If an error occurs, return NULL and leave a message in pParse.
2354 */
2355 Vdbe *sqlite3GetVdbe(Parse *pParse){
2356   if( pParse->pVdbe ){
2357     return pParse->pVdbe;
2358   }
2359   if( pParse->pToplevel==0
2360    && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
2361   ){
2362     pParse->okConstFactor = 1;
2363   }
2364   return sqlite3VdbeCreate(pParse);
2365 }
2366 
2367 
2368 /*
2369 ** Compute the iLimit and iOffset fields of the SELECT based on the
2370 ** pLimit expressions.  pLimit->pLeft and pLimit->pRight hold the expressions
2371 ** that appear in the original SQL statement after the LIMIT and OFFSET
2372 ** keywords.  Or NULL if those keywords are omitted. iLimit and iOffset
2373 ** are the integer memory register numbers for counters used to compute
2374 ** the limit and offset.  If there is no limit and/or offset, then
2375 ** iLimit and iOffset are negative.
2376 **
2377 ** This routine changes the values of iLimit and iOffset only if
2378 ** a limit or offset is defined by pLimit->pLeft and pLimit->pRight.  iLimit
2379 ** and iOffset should have been preset to appropriate default values (zero)
2380 ** prior to calling this routine.
2381 **
2382 ** The iOffset register (if it exists) is initialized to the value
2383 ** of the OFFSET.  The iLimit register is initialized to LIMIT.  Register
2384 ** iOffset+1 is initialized to LIMIT+OFFSET.
2385 **
2386 ** Only if pLimit->pLeft!=0 do the limit registers get
2387 ** redefined.  The UNION ALL operator uses this property to force
2388 ** the reuse of the same limit and offset registers across multiple
2389 ** SELECT statements.
2390 */
2391 static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
2392   Vdbe *v = 0;
2393   int iLimit = 0;
2394   int iOffset;
2395   int n;
2396   Expr *pLimit = p->pLimit;
2397 
2398   if( p->iLimit ) return;
2399 
2400   /*
2401   ** "LIMIT -1" always shows all rows.  There is some
2402   ** controversy about what the correct behavior should be.
2403   ** The current implementation interprets "LIMIT 0" to mean
2404   ** no rows.
2405   */
2406   if( pLimit ){
2407     assert( pLimit->op==TK_LIMIT );
2408     assert( pLimit->pLeft!=0 );
2409     p->iLimit = iLimit = ++pParse->nMem;
2410     v = sqlite3GetVdbe(pParse);
2411     assert( v!=0 );
2412     if( sqlite3ExprIsInteger(pLimit->pLeft, &n) ){
2413       sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
2414       VdbeComment((v, "LIMIT counter"));
2415       if( n==0 ){
2416         sqlite3VdbeGoto(v, iBreak);
2417       }else if( n>=0 && p->nSelectRow>sqlite3LogEst((u64)n) ){
2418         p->nSelectRow = sqlite3LogEst((u64)n);
2419         p->selFlags |= SF_FixedLimit;
2420       }
2421     }else{
2422       sqlite3ExprCode(pParse, pLimit->pLeft, iLimit);
2423       sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
2424       VdbeComment((v, "LIMIT counter"));
2425       sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, iBreak); VdbeCoverage(v);
2426     }
2427     if( pLimit->pRight ){
2428       p->iOffset = iOffset = ++pParse->nMem;
2429       pParse->nMem++;   /* Allocate an extra register for limit+offset */
2430       sqlite3ExprCode(pParse, pLimit->pRight, iOffset);
2431       sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
2432       VdbeComment((v, "OFFSET counter"));
2433       sqlite3VdbeAddOp3(v, OP_OffsetLimit, iLimit, iOffset+1, iOffset);
2434       VdbeComment((v, "LIMIT+OFFSET"));
2435     }
2436   }
2437 }
2438 
2439 #ifndef SQLITE_OMIT_COMPOUND_SELECT
2440 /*
2441 ** Return the appropriate collating sequence for the iCol-th column of
2442 ** the result set for the compound-select statement "p".  Return NULL if
2443 ** the column has no default collating sequence.
2444 **
2445 ** The collating sequence for the compound select is taken from the
2446 ** left-most term of the select that has a collating sequence.
2447 */
2448 static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
2449   CollSeq *pRet;
2450   if( p->pPrior ){
2451     pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
2452   }else{
2453     pRet = 0;
2454   }
2455   assert( iCol>=0 );
2456   /* iCol must be less than p->pEList->nExpr.  Otherwise an error would
2457   ** have been thrown during name resolution and we would not have gotten
2458   ** this far */
2459   if( pRet==0 && ALWAYS(iCol<p->pEList->nExpr) ){
2460     pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
2461   }
2462   return pRet;
2463 }
2464 
2465 /*
2466 ** The select statement passed as the second parameter is a compound SELECT
2467 ** with an ORDER BY clause. This function allocates and returns a KeyInfo
2468 ** structure suitable for implementing the ORDER BY.
2469 **
2470 ** Space to hold the KeyInfo structure is obtained from malloc. The calling
2471 ** function is responsible for ensuring that this structure is eventually
2472 ** freed.
2473 */
2474 static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
2475   ExprList *pOrderBy = p->pOrderBy;
2476   int nOrderBy = ALWAYS(pOrderBy!=0) ? pOrderBy->nExpr : 0;
2477   sqlite3 *db = pParse->db;
2478   KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
2479   if( pRet ){
2480     int i;
2481     for(i=0; i<nOrderBy; i++){
2482       struct ExprList_item *pItem = &pOrderBy->a[i];
2483       Expr *pTerm = pItem->pExpr;
2484       CollSeq *pColl;
2485 
2486       if( pTerm->flags & EP_Collate ){
2487         pColl = sqlite3ExprCollSeq(pParse, pTerm);
2488       }else{
2489         pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
2490         if( pColl==0 ) pColl = db->pDfltColl;
2491         pOrderBy->a[i].pExpr =
2492           sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
2493       }
2494       assert( sqlite3KeyInfoIsWriteable(pRet) );
2495       pRet->aColl[i] = pColl;
2496       pRet->aSortFlags[i] = pOrderBy->a[i].fg.sortFlags;
2497     }
2498   }
2499 
2500   return pRet;
2501 }
2502 
2503 #ifndef SQLITE_OMIT_CTE
2504 /*
2505 ** This routine generates VDBE code to compute the content of a WITH RECURSIVE
2506 ** query of the form:
2507 **
2508 **   <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
2509 **                         \___________/             \_______________/
2510 **                           p->pPrior                      p
2511 **
2512 **
2513 ** There is exactly one reference to the recursive-table in the FROM clause
2514 ** of recursive-query, marked with the SrcList->a[].fg.isRecursive flag.
2515 **
2516 ** The setup-query runs once to generate an initial set of rows that go
2517 ** into a Queue table.  Rows are extracted from the Queue table one by
2518 ** one.  Each row extracted from Queue is output to pDest.  Then the single
2519 ** extracted row (now in the iCurrent table) becomes the content of the
2520 ** recursive-table for a recursive-query run.  The output of the recursive-query
2521 ** is added back into the Queue table.  Then another row is extracted from Queue
2522 ** and the iteration continues until the Queue table is empty.
2523 **
2524 ** If the compound query operator is UNION then no duplicate rows are ever
2525 ** inserted into the Queue table.  The iDistinct table keeps a copy of all rows
2526 ** that have ever been inserted into Queue and causes duplicates to be
2527 ** discarded.  If the operator is UNION ALL, then duplicates are allowed.
2528 **
2529 ** If the query has an ORDER BY, then entries in the Queue table are kept in
2530 ** ORDER BY order and the first entry is extracted for each cycle.  Without
2531 ** an ORDER BY, the Queue table is just a FIFO.
2532 **
2533 ** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
2534 ** have been output to pDest.  A LIMIT of zero means to output no rows and a
2535 ** negative LIMIT means to output all rows.  If there is also an OFFSET clause
2536 ** with a positive value, then the first OFFSET outputs are discarded rather
2537 ** than being sent to pDest.  The LIMIT count does not begin until after OFFSET
2538 ** rows have been skipped.
2539 */
2540 static void generateWithRecursiveQuery(
2541   Parse *pParse,        /* Parsing context */
2542   Select *p,            /* The recursive SELECT to be coded */
2543   SelectDest *pDest     /* What to do with query results */
2544 ){
2545   SrcList *pSrc = p->pSrc;      /* The FROM clause of the recursive query */
2546   int nCol = p->pEList->nExpr;  /* Number of columns in the recursive table */
2547   Vdbe *v = pParse->pVdbe;      /* The prepared statement under construction */
2548   Select *pSetup;               /* The setup query */
2549   Select *pFirstRec;            /* Left-most recursive term */
2550   int addrTop;                  /* Top of the loop */
2551   int addrCont, addrBreak;      /* CONTINUE and BREAK addresses */
2552   int iCurrent = 0;             /* The Current table */
2553   int regCurrent;               /* Register holding Current table */
2554   int iQueue;                   /* The Queue table */
2555   int iDistinct = 0;            /* To ensure unique results if UNION */
2556   int eDest = SRT_Fifo;         /* How to write to Queue */
2557   SelectDest destQueue;         /* SelectDest targetting the Queue table */
2558   int i;                        /* Loop counter */
2559   int rc;                       /* Result code */
2560   ExprList *pOrderBy;           /* The ORDER BY clause */
2561   Expr *pLimit;                 /* Saved LIMIT and OFFSET */
2562   int regLimit, regOffset;      /* Registers used by LIMIT and OFFSET */
2563 
2564 #ifndef SQLITE_OMIT_WINDOWFUNC
2565   if( p->pWin ){
2566     sqlite3ErrorMsg(pParse, "cannot use window functions in recursive queries");
2567     return;
2568   }
2569 #endif
2570 
2571   /* Obtain authorization to do a recursive query */
2572   if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
2573 
2574   /* Process the LIMIT and OFFSET clauses, if they exist */
2575   addrBreak = sqlite3VdbeMakeLabel(pParse);
2576   p->nSelectRow = 320;  /* 4 billion rows */
2577   computeLimitRegisters(pParse, p, addrBreak);
2578   pLimit = p->pLimit;
2579   regLimit = p->iLimit;
2580   regOffset = p->iOffset;
2581   p->pLimit = 0;
2582   p->iLimit = p->iOffset = 0;
2583   pOrderBy = p->pOrderBy;
2584 
2585   /* Locate the cursor number of the Current table */
2586   for(i=0; ALWAYS(i<pSrc->nSrc); i++){
2587     if( pSrc->a[i].fg.isRecursive ){
2588       iCurrent = pSrc->a[i].iCursor;
2589       break;
2590     }
2591   }
2592 
2593   /* Allocate cursors numbers for Queue and Distinct.  The cursor number for
2594   ** the Distinct table must be exactly one greater than Queue in order
2595   ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
2596   iQueue = pParse->nTab++;
2597   if( p->op==TK_UNION ){
2598     eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
2599     iDistinct = pParse->nTab++;
2600   }else{
2601     eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
2602   }
2603   sqlite3SelectDestInit(&destQueue, eDest, iQueue);
2604 
2605   /* Allocate cursors for Current, Queue, and Distinct. */
2606   regCurrent = ++pParse->nMem;
2607   sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
2608   if( pOrderBy ){
2609     KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
2610     sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
2611                       (char*)pKeyInfo, P4_KEYINFO);
2612     destQueue.pOrderBy = pOrderBy;
2613   }else{
2614     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
2615   }
2616   VdbeComment((v, "Queue table"));
2617   if( iDistinct ){
2618     p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
2619     p->selFlags |= SF_UsesEphemeral;
2620   }
2621 
2622   /* Detach the ORDER BY clause from the compound SELECT */
2623   p->pOrderBy = 0;
2624 
2625   /* Figure out how many elements of the compound SELECT are part of the
2626   ** recursive query.  Make sure no recursive elements use aggregate
2627   ** functions.  Mark the recursive elements as UNION ALL even if they
2628   ** are really UNION because the distinctness will be enforced by the
2629   ** iDistinct table.  pFirstRec is left pointing to the left-most
2630   ** recursive term of the CTE.
2631   */
2632   for(pFirstRec=p; ALWAYS(pFirstRec!=0); pFirstRec=pFirstRec->pPrior){
2633     if( pFirstRec->selFlags & SF_Aggregate ){
2634       sqlite3ErrorMsg(pParse, "recursive aggregate queries not supported");
2635       goto end_of_recursive_query;
2636     }
2637     pFirstRec->op = TK_ALL;
2638     if( (pFirstRec->pPrior->selFlags & SF_Recursive)==0 ) break;
2639   }
2640 
2641   /* Store the results of the setup-query in Queue. */
2642   pSetup = pFirstRec->pPrior;
2643   pSetup->pNext = 0;
2644   ExplainQueryPlan((pParse, 1, "SETUP"));
2645   rc = sqlite3Select(pParse, pSetup, &destQueue);
2646   pSetup->pNext = p;
2647   if( rc ) goto end_of_recursive_query;
2648 
2649   /* Find the next row in the Queue and output that row */
2650   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
2651 
2652   /* Transfer the next row in Queue over to Current */
2653   sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
2654   if( pOrderBy ){
2655     sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
2656   }else{
2657     sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
2658   }
2659   sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
2660 
2661   /* Output the single row in Current */
2662   addrCont = sqlite3VdbeMakeLabel(pParse);
2663   codeOffset(v, regOffset, addrCont);
2664   selectInnerLoop(pParse, p, iCurrent,
2665       0, 0, pDest, addrCont, addrBreak);
2666   if( regLimit ){
2667     sqlite3VdbeAddOp2(v, OP_DecrJumpZero, regLimit, addrBreak);
2668     VdbeCoverage(v);
2669   }
2670   sqlite3VdbeResolveLabel(v, addrCont);
2671 
2672   /* Execute the recursive SELECT taking the single row in Current as
2673   ** the value for the recursive-table. Store the results in the Queue.
2674   */
2675   pFirstRec->pPrior = 0;
2676   ExplainQueryPlan((pParse, 1, "RECURSIVE STEP"));
2677   sqlite3Select(pParse, p, &destQueue);
2678   assert( pFirstRec->pPrior==0 );
2679   pFirstRec->pPrior = pSetup;
2680 
2681   /* Keep running the loop until the Queue is empty */
2682   sqlite3VdbeGoto(v, addrTop);
2683   sqlite3VdbeResolveLabel(v, addrBreak);
2684 
2685 end_of_recursive_query:
2686   sqlite3ExprListDelete(pParse->db, p->pOrderBy);
2687   p->pOrderBy = pOrderBy;
2688   p->pLimit = pLimit;
2689   return;
2690 }
2691 #endif /* SQLITE_OMIT_CTE */
2692 
2693 /* Forward references */
2694 static int multiSelectOrderBy(
2695   Parse *pParse,        /* Parsing context */
2696   Select *p,            /* The right-most of SELECTs to be coded */
2697   SelectDest *pDest     /* What to do with query results */
2698 );
2699 
2700 /*
2701 ** Handle the special case of a compound-select that originates from a
2702 ** VALUES clause.  By handling this as a special case, we avoid deep
2703 ** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
2704 ** on a VALUES clause.
2705 **
2706 ** Because the Select object originates from a VALUES clause:
2707 **   (1) There is no LIMIT or OFFSET or else there is a LIMIT of exactly 1
2708 **   (2) All terms are UNION ALL
2709 **   (3) There is no ORDER BY clause
2710 **
2711 ** The "LIMIT of exactly 1" case of condition (1) comes about when a VALUES
2712 ** clause occurs within scalar expression (ex: "SELECT (VALUES(1),(2),(3))").
2713 ** The sqlite3CodeSubselect will have added the LIMIT 1 clause in tht case.
2714 ** Since the limit is exactly 1, we only need to evaluate the left-most VALUES.
2715 */
2716 static int multiSelectValues(
2717   Parse *pParse,        /* Parsing context */
2718   Select *p,            /* The right-most of SELECTs to be coded */
2719   SelectDest *pDest     /* What to do with query results */
2720 ){
2721   int nRow = 1;
2722   int rc = 0;
2723   int bShowAll = p->pLimit==0;
2724   assert( p->selFlags & SF_MultiValue );
2725   do{
2726     assert( p->selFlags & SF_Values );
2727     assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
2728     assert( p->pNext==0 || p->pEList->nExpr==p->pNext->pEList->nExpr );
2729 #ifndef SQLITE_OMIT_WINDOWFUNC
2730     if( p->pWin ) return -1;
2731 #endif
2732     if( p->pPrior==0 ) break;
2733     assert( p->pPrior->pNext==p );
2734     p = p->pPrior;
2735     nRow += bShowAll;
2736   }while(1);
2737   ExplainQueryPlan((pParse, 0, "SCAN %d CONSTANT ROW%s", nRow,
2738                     nRow==1 ? "" : "S"));
2739   while( p ){
2740     selectInnerLoop(pParse, p, -1, 0, 0, pDest, 1, 1);
2741     if( !bShowAll ) break;
2742     p->nSelectRow = nRow;
2743     p = p->pNext;
2744   }
2745   return rc;
2746 }
2747 
2748 /*
2749 ** Return true if the SELECT statement which is known to be the recursive
2750 ** part of a recursive CTE still has its anchor terms attached.  If the
2751 ** anchor terms have already been removed, then return false.
2752 */
2753 static int hasAnchor(Select *p){
2754   while( p && (p->selFlags & SF_Recursive)!=0 ){ p = p->pPrior; }
2755   return p!=0;
2756 }
2757 
2758 /*
2759 ** This routine is called to process a compound query form from
2760 ** two or more separate queries using UNION, UNION ALL, EXCEPT, or
2761 ** INTERSECT
2762 **
2763 ** "p" points to the right-most of the two queries.  the query on the
2764 ** left is p->pPrior.  The left query could also be a compound query
2765 ** in which case this routine will be called recursively.
2766 **
2767 ** The results of the total query are to be written into a destination
2768 ** of type eDest with parameter iParm.
2769 **
2770 ** Example 1:  Consider a three-way compound SQL statement.
2771 **
2772 **     SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
2773 **
2774 ** This statement is parsed up as follows:
2775 **
2776 **     SELECT c FROM t3
2777 **      |
2778 **      `----->  SELECT b FROM t2
2779 **                |
2780 **                `------>  SELECT a FROM t1
2781 **
2782 ** The arrows in the diagram above represent the Select.pPrior pointer.
2783 ** So if this routine is called with p equal to the t3 query, then
2784 ** pPrior will be the t2 query.  p->op will be TK_UNION in this case.
2785 **
2786 ** Notice that because of the way SQLite parses compound SELECTs, the
2787 ** individual selects always group from left to right.
2788 */
2789 static int multiSelect(
2790   Parse *pParse,        /* Parsing context */
2791   Select *p,            /* The right-most of SELECTs to be coded */
2792   SelectDest *pDest     /* What to do with query results */
2793 ){
2794   int rc = SQLITE_OK;   /* Success code from a subroutine */
2795   Select *pPrior;       /* Another SELECT immediately to our left */
2796   Vdbe *v;              /* Generate code to this VDBE */
2797   SelectDest dest;      /* Alternative data destination */
2798   Select *pDelete = 0;  /* Chain of simple selects to delete */
2799   sqlite3 *db;          /* Database connection */
2800 
2801   /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs.  Only
2802   ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
2803   */
2804   assert( p && p->pPrior );  /* Calling function guarantees this much */
2805   assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
2806   assert( p->selFlags & SF_Compound );
2807   db = pParse->db;
2808   pPrior = p->pPrior;
2809   dest = *pDest;
2810   assert( pPrior->pOrderBy==0 );
2811   assert( pPrior->pLimit==0 );
2812 
2813   v = sqlite3GetVdbe(pParse);
2814   assert( v!=0 );  /* The VDBE already created by calling function */
2815 
2816   /* Create the destination temporary table if necessary
2817   */
2818   if( dest.eDest==SRT_EphemTab ){
2819     assert( p->pEList );
2820     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
2821     dest.eDest = SRT_Table;
2822   }
2823 
2824   /* Special handling for a compound-select that originates as a VALUES clause.
2825   */
2826   if( p->selFlags & SF_MultiValue ){
2827     rc = multiSelectValues(pParse, p, &dest);
2828     if( rc>=0 ) goto multi_select_end;
2829     rc = SQLITE_OK;
2830   }
2831 
2832   /* Make sure all SELECTs in the statement have the same number of elements
2833   ** in their result sets.
2834   */
2835   assert( p->pEList && pPrior->pEList );
2836   assert( p->pEList->nExpr==pPrior->pEList->nExpr );
2837 
2838 #ifndef SQLITE_OMIT_CTE
2839   if( (p->selFlags & SF_Recursive)!=0 && hasAnchor(p) ){
2840     generateWithRecursiveQuery(pParse, p, &dest);
2841   }else
2842 #endif
2843 
2844   /* Compound SELECTs that have an ORDER BY clause are handled separately.
2845   */
2846   if( p->pOrderBy ){
2847     return multiSelectOrderBy(pParse, p, pDest);
2848   }else{
2849 
2850 #ifndef SQLITE_OMIT_EXPLAIN
2851     if( pPrior->pPrior==0 ){
2852       ExplainQueryPlan((pParse, 1, "COMPOUND QUERY"));
2853       ExplainQueryPlan((pParse, 1, "LEFT-MOST SUBQUERY"));
2854     }
2855 #endif
2856 
2857     /* Generate code for the left and right SELECT statements.
2858     */
2859     switch( p->op ){
2860       case TK_ALL: {
2861         int addr = 0;
2862         int nLimit = 0;  /* Initialize to suppress harmless compiler warning */
2863         assert( !pPrior->pLimit );
2864         pPrior->iLimit = p->iLimit;
2865         pPrior->iOffset = p->iOffset;
2866         pPrior->pLimit = p->pLimit;
2867         SELECTTRACE(1, pParse, p, ("multiSelect UNION ALL left...\n"));
2868         rc = sqlite3Select(pParse, pPrior, &dest);
2869         pPrior->pLimit = 0;
2870         if( rc ){
2871           goto multi_select_end;
2872         }
2873         p->pPrior = 0;
2874         p->iLimit = pPrior->iLimit;
2875         p->iOffset = pPrior->iOffset;
2876         if( p->iLimit ){
2877           addr = sqlite3VdbeAddOp1(v, OP_IfNot, p->iLimit); VdbeCoverage(v);
2878           VdbeComment((v, "Jump ahead if LIMIT reached"));
2879           if( p->iOffset ){
2880             sqlite3VdbeAddOp3(v, OP_OffsetLimit,
2881                               p->iLimit, p->iOffset+1, p->iOffset);
2882           }
2883         }
2884         ExplainQueryPlan((pParse, 1, "UNION ALL"));
2885         SELECTTRACE(1, pParse, p, ("multiSelect UNION ALL right...\n"));
2886         rc = sqlite3Select(pParse, p, &dest);
2887         testcase( rc!=SQLITE_OK );
2888         pDelete = p->pPrior;
2889         p->pPrior = pPrior;
2890         p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
2891         if( p->pLimit
2892          && sqlite3ExprIsInteger(p->pLimit->pLeft, &nLimit)
2893          && nLimit>0 && p->nSelectRow > sqlite3LogEst((u64)nLimit)
2894         ){
2895           p->nSelectRow = sqlite3LogEst((u64)nLimit);
2896         }
2897         if( addr ){
2898           sqlite3VdbeJumpHere(v, addr);
2899         }
2900         break;
2901       }
2902       case TK_EXCEPT:
2903       case TK_UNION: {
2904         int unionTab;    /* Cursor number of the temp table holding result */
2905         u8 op = 0;       /* One of the SRT_ operations to apply to self */
2906         int priorOp;     /* The SRT_ operation to apply to prior selects */
2907         Expr *pLimit;    /* Saved values of p->nLimit  */
2908         int addr;
2909         SelectDest uniondest;
2910 
2911         testcase( p->op==TK_EXCEPT );
2912         testcase( p->op==TK_UNION );
2913         priorOp = SRT_Union;
2914         if( dest.eDest==priorOp ){
2915           /* We can reuse a temporary table generated by a SELECT to our
2916           ** right.
2917           */
2918           assert( p->pLimit==0 );      /* Not allowed on leftward elements */
2919           unionTab = dest.iSDParm;
2920         }else{
2921           /* We will need to create our own temporary table to hold the
2922           ** intermediate results.
2923           */
2924           unionTab = pParse->nTab++;
2925           assert( p->pOrderBy==0 );
2926           addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
2927           assert( p->addrOpenEphm[0] == -1 );
2928           p->addrOpenEphm[0] = addr;
2929           findRightmost(p)->selFlags |= SF_UsesEphemeral;
2930           assert( p->pEList );
2931         }
2932 
2933 
2934         /* Code the SELECT statements to our left
2935         */
2936         assert( !pPrior->pOrderBy );
2937         sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
2938         SELECTTRACE(1, pParse, p, ("multiSelect EXCEPT/UNION left...\n"));
2939         rc = sqlite3Select(pParse, pPrior, &uniondest);
2940         if( rc ){
2941           goto multi_select_end;
2942         }
2943 
2944         /* Code the current SELECT statement
2945         */
2946         if( p->op==TK_EXCEPT ){
2947           op = SRT_Except;
2948         }else{
2949           assert( p->op==TK_UNION );
2950           op = SRT_Union;
2951         }
2952         p->pPrior = 0;
2953         pLimit = p->pLimit;
2954         p->pLimit = 0;
2955         uniondest.eDest = op;
2956         ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
2957                           sqlite3SelectOpName(p->op)));
2958         SELECTTRACE(1, pParse, p, ("multiSelect EXCEPT/UNION right...\n"));
2959         rc = sqlite3Select(pParse, p, &uniondest);
2960         testcase( rc!=SQLITE_OK );
2961         assert( p->pOrderBy==0 );
2962         pDelete = p->pPrior;
2963         p->pPrior = pPrior;
2964         p->pOrderBy = 0;
2965         if( p->op==TK_UNION ){
2966           p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
2967         }
2968         sqlite3ExprDelete(db, p->pLimit);
2969         p->pLimit = pLimit;
2970         p->iLimit = 0;
2971         p->iOffset = 0;
2972 
2973         /* Convert the data in the temporary table into whatever form
2974         ** it is that we currently need.
2975         */
2976         assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
2977         assert( p->pEList || db->mallocFailed );
2978         if( dest.eDest!=priorOp && db->mallocFailed==0 ){
2979           int iCont, iBreak, iStart;
2980           iBreak = sqlite3VdbeMakeLabel(pParse);
2981           iCont = sqlite3VdbeMakeLabel(pParse);
2982           computeLimitRegisters(pParse, p, iBreak);
2983           sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
2984           iStart = sqlite3VdbeCurrentAddr(v);
2985           selectInnerLoop(pParse, p, unionTab,
2986                           0, 0, &dest, iCont, iBreak);
2987           sqlite3VdbeResolveLabel(v, iCont);
2988           sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
2989           sqlite3VdbeResolveLabel(v, iBreak);
2990           sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
2991         }
2992         break;
2993       }
2994       default: assert( p->op==TK_INTERSECT ); {
2995         int tab1, tab2;
2996         int iCont, iBreak, iStart;
2997         Expr *pLimit;
2998         int addr;
2999         SelectDest intersectdest;
3000         int r1;
3001 
3002         /* INTERSECT is different from the others since it requires
3003         ** two temporary tables.  Hence it has its own case.  Begin
3004         ** by allocating the tables we will need.
3005         */
3006         tab1 = pParse->nTab++;
3007         tab2 = pParse->nTab++;
3008         assert( p->pOrderBy==0 );
3009 
3010         addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
3011         assert( p->addrOpenEphm[0] == -1 );
3012         p->addrOpenEphm[0] = addr;
3013         findRightmost(p)->selFlags |= SF_UsesEphemeral;
3014         assert( p->pEList );
3015 
3016         /* Code the SELECTs to our left into temporary table "tab1".
3017         */
3018         sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
3019         SELECTTRACE(1, pParse, p, ("multiSelect INTERSECT left...\n"));
3020         rc = sqlite3Select(pParse, pPrior, &intersectdest);
3021         if( rc ){
3022           goto multi_select_end;
3023         }
3024 
3025         /* Code the current SELECT into temporary table "tab2"
3026         */
3027         addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
3028         assert( p->addrOpenEphm[1] == -1 );
3029         p->addrOpenEphm[1] = addr;
3030         p->pPrior = 0;
3031         pLimit = p->pLimit;
3032         p->pLimit = 0;
3033         intersectdest.iSDParm = tab2;
3034         ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
3035                           sqlite3SelectOpName(p->op)));
3036         SELECTTRACE(1, pParse, p, ("multiSelect INTERSECT right...\n"));
3037         rc = sqlite3Select(pParse, p, &intersectdest);
3038         testcase( rc!=SQLITE_OK );
3039         pDelete = p->pPrior;
3040         p->pPrior = pPrior;
3041         if( p->nSelectRow>pPrior->nSelectRow ){
3042           p->nSelectRow = pPrior->nSelectRow;
3043         }
3044         sqlite3ExprDelete(db, p->pLimit);
3045         p->pLimit = pLimit;
3046 
3047         /* Generate code to take the intersection of the two temporary
3048         ** tables.
3049         */
3050         if( rc ) break;
3051         assert( p->pEList );
3052         iBreak = sqlite3VdbeMakeLabel(pParse);
3053         iCont = sqlite3VdbeMakeLabel(pParse);
3054         computeLimitRegisters(pParse, p, iBreak);
3055         sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
3056         r1 = sqlite3GetTempReg(pParse);
3057         iStart = sqlite3VdbeAddOp2(v, OP_RowData, tab1, r1);
3058         sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0);
3059         VdbeCoverage(v);
3060         sqlite3ReleaseTempReg(pParse, r1);
3061         selectInnerLoop(pParse, p, tab1,
3062                         0, 0, &dest, iCont, iBreak);
3063         sqlite3VdbeResolveLabel(v, iCont);
3064         sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
3065         sqlite3VdbeResolveLabel(v, iBreak);
3066         sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
3067         sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
3068         break;
3069       }
3070     }
3071 
3072   #ifndef SQLITE_OMIT_EXPLAIN
3073     if( p->pNext==0 ){
3074       ExplainQueryPlanPop(pParse);
3075     }
3076   #endif
3077   }
3078   if( pParse->nErr ) goto multi_select_end;
3079 
3080   /* Compute collating sequences used by
3081   ** temporary tables needed to implement the compound select.
3082   ** Attach the KeyInfo structure to all temporary tables.
3083   **
3084   ** This section is run by the right-most SELECT statement only.
3085   ** SELECT statements to the left always skip this part.  The right-most
3086   ** SELECT might also skip this part if it has no ORDER BY clause and
3087   ** no temp tables are required.
3088   */
3089   if( p->selFlags & SF_UsesEphemeral ){
3090     int i;                        /* Loop counter */
3091     KeyInfo *pKeyInfo;            /* Collating sequence for the result set */
3092     Select *pLoop;                /* For looping through SELECT statements */
3093     CollSeq **apColl;             /* For looping through pKeyInfo->aColl[] */
3094     int nCol;                     /* Number of columns in result set */
3095 
3096     assert( p->pNext==0 );
3097     assert( p->pEList!=0 );
3098     nCol = p->pEList->nExpr;
3099     pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
3100     if( !pKeyInfo ){
3101       rc = SQLITE_NOMEM_BKPT;
3102       goto multi_select_end;
3103     }
3104     for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
3105       *apColl = multiSelectCollSeq(pParse, p, i);
3106       if( 0==*apColl ){
3107         *apColl = db->pDfltColl;
3108       }
3109     }
3110 
3111     for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
3112       for(i=0; i<2; i++){
3113         int addr = pLoop->addrOpenEphm[i];
3114         if( addr<0 ){
3115           /* If [0] is unused then [1] is also unused.  So we can
3116           ** always safely abort as soon as the first unused slot is found */
3117           assert( pLoop->addrOpenEphm[1]<0 );
3118           break;
3119         }
3120         sqlite3VdbeChangeP2(v, addr, nCol);
3121         sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
3122                             P4_KEYINFO);
3123         pLoop->addrOpenEphm[i] = -1;
3124       }
3125     }
3126     sqlite3KeyInfoUnref(pKeyInfo);
3127   }
3128 
3129 multi_select_end:
3130   pDest->iSdst = dest.iSdst;
3131   pDest->nSdst = dest.nSdst;
3132   if( pDelete ){
3133     sqlite3ParserAddCleanup(pParse,
3134         (void(*)(sqlite3*,void*))sqlite3SelectDelete,
3135         pDelete);
3136   }
3137   return rc;
3138 }
3139 #endif /* SQLITE_OMIT_COMPOUND_SELECT */
3140 
3141 /*
3142 ** Error message for when two or more terms of a compound select have different
3143 ** size result sets.
3144 */
3145 void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p){
3146   if( p->selFlags & SF_Values ){
3147     sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
3148   }else{
3149     sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
3150       " do not have the same number of result columns",
3151       sqlite3SelectOpName(p->op));
3152   }
3153 }
3154 
3155 /*
3156 ** Code an output subroutine for a coroutine implementation of a
3157 ** SELECT statment.
3158 **
3159 ** The data to be output is contained in pIn->iSdst.  There are
3160 ** pIn->nSdst columns to be output.  pDest is where the output should
3161 ** be sent.
3162 **
3163 ** regReturn is the number of the register holding the subroutine
3164 ** return address.
3165 **
3166 ** If regPrev>0 then it is the first register in a vector that
3167 ** records the previous output.  mem[regPrev] is a flag that is false
3168 ** if there has been no previous output.  If regPrev>0 then code is
3169 ** generated to suppress duplicates.  pKeyInfo is used for comparing
3170 ** keys.
3171 **
3172 ** If the LIMIT found in p->iLimit is reached, jump immediately to
3173 ** iBreak.
3174 */
3175 static int generateOutputSubroutine(
3176   Parse *pParse,          /* Parsing context */
3177   Select *p,              /* The SELECT statement */
3178   SelectDest *pIn,        /* Coroutine supplying data */
3179   SelectDest *pDest,      /* Where to send the data */
3180   int regReturn,          /* The return address register */
3181   int regPrev,            /* Previous result register.  No uniqueness if 0 */
3182   KeyInfo *pKeyInfo,      /* For comparing with previous entry */
3183   int iBreak              /* Jump here if we hit the LIMIT */
3184 ){
3185   Vdbe *v = pParse->pVdbe;
3186   int iContinue;
3187   int addr;
3188 
3189   addr = sqlite3VdbeCurrentAddr(v);
3190   iContinue = sqlite3VdbeMakeLabel(pParse);
3191 
3192   /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
3193   */
3194   if( regPrev ){
3195     int addr1, addr2;
3196     addr1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
3197     addr2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
3198                               (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
3199     sqlite3VdbeAddOp3(v, OP_Jump, addr2+2, iContinue, addr2+2); VdbeCoverage(v);
3200     sqlite3VdbeJumpHere(v, addr1);
3201     sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
3202     sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
3203   }
3204   if( pParse->db->mallocFailed ) return 0;
3205 
3206   /* Suppress the first OFFSET entries if there is an OFFSET clause
3207   */
3208   codeOffset(v, p->iOffset, iContinue);
3209 
3210   assert( pDest->eDest!=SRT_Exists );
3211   assert( pDest->eDest!=SRT_Table );
3212   switch( pDest->eDest ){
3213     /* Store the result as data using a unique key.
3214     */
3215     case SRT_EphemTab: {
3216       int r1 = sqlite3GetTempReg(pParse);
3217       int r2 = sqlite3GetTempReg(pParse);
3218       sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
3219       sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
3220       sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
3221       sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
3222       sqlite3ReleaseTempReg(pParse, r2);
3223       sqlite3ReleaseTempReg(pParse, r1);
3224       break;
3225     }
3226 
3227 #ifndef SQLITE_OMIT_SUBQUERY
3228     /* If we are creating a set for an "expr IN (SELECT ...)".
3229     */
3230     case SRT_Set: {
3231       int r1;
3232       testcase( pIn->nSdst>1 );
3233       r1 = sqlite3GetTempReg(pParse);
3234       sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst,
3235           r1, pDest->zAffSdst, pIn->nSdst);
3236       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pDest->iSDParm, r1,
3237                            pIn->iSdst, pIn->nSdst);
3238       sqlite3ReleaseTempReg(pParse, r1);
3239       break;
3240     }
3241 
3242     /* If this is a scalar select that is part of an expression, then
3243     ** store the results in the appropriate memory cell and break out
3244     ** of the scan loop.  Note that the select might return multiple columns
3245     ** if it is the RHS of a row-value IN operator.
3246     */
3247     case SRT_Mem: {
3248       testcase( pIn->nSdst>1 );
3249       sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, pIn->nSdst);
3250       /* The LIMIT clause will jump out of the loop for us */
3251       break;
3252     }
3253 #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
3254 
3255     /* The results are stored in a sequence of registers
3256     ** starting at pDest->iSdst.  Then the co-routine yields.
3257     */
3258     case SRT_Coroutine: {
3259       if( pDest->iSdst==0 ){
3260         pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
3261         pDest->nSdst = pIn->nSdst;
3262       }
3263       sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pIn->nSdst);
3264       sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
3265       break;
3266     }
3267 
3268     /* If none of the above, then the result destination must be
3269     ** SRT_Output.  This routine is never called with any other
3270     ** destination other than the ones handled above or SRT_Output.
3271     **
3272     ** For SRT_Output, results are stored in a sequence of registers.
3273     ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
3274     ** return the next row of result.
3275     */
3276     default: {
3277       assert( pDest->eDest==SRT_Output );
3278       sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
3279       break;
3280     }
3281   }
3282 
3283   /* Jump to the end of the loop if the LIMIT is reached.
3284   */
3285   if( p->iLimit ){
3286     sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
3287   }
3288 
3289   /* Generate the subroutine return
3290   */
3291   sqlite3VdbeResolveLabel(v, iContinue);
3292   sqlite3VdbeAddOp1(v, OP_Return, regReturn);
3293 
3294   return addr;
3295 }
3296 
3297 /*
3298 ** Alternative compound select code generator for cases when there
3299 ** is an ORDER BY clause.
3300 **
3301 ** We assume a query of the following form:
3302 **
3303 **      <selectA>  <operator>  <selectB>  ORDER BY <orderbylist>
3304 **
3305 ** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT.  The idea
3306 ** is to code both <selectA> and <selectB> with the ORDER BY clause as
3307 ** co-routines.  Then run the co-routines in parallel and merge the results
3308 ** into the output.  In addition to the two coroutines (called selectA and
3309 ** selectB) there are 7 subroutines:
3310 **
3311 **    outA:    Move the output of the selectA coroutine into the output
3312 **             of the compound query.
3313 **
3314 **    outB:    Move the output of the selectB coroutine into the output
3315 **             of the compound query.  (Only generated for UNION and
3316 **             UNION ALL.  EXCEPT and INSERTSECT never output a row that
3317 **             appears only in B.)
3318 **
3319 **    AltB:    Called when there is data from both coroutines and A<B.
3320 **
3321 **    AeqB:    Called when there is data from both coroutines and A==B.
3322 **
3323 **    AgtB:    Called when there is data from both coroutines and A>B.
3324 **
3325 **    EofA:    Called when data is exhausted from selectA.
3326 **
3327 **    EofB:    Called when data is exhausted from selectB.
3328 **
3329 ** The implementation of the latter five subroutines depend on which
3330 ** <operator> is used:
3331 **
3332 **
3333 **             UNION ALL         UNION            EXCEPT          INTERSECT
3334 **          -------------  -----------------  --------------  -----------------
3335 **   AltB:   outA, nextA      outA, nextA       outA, nextA         nextA
3336 **
3337 **   AeqB:   outA, nextA         nextA             nextA         outA, nextA
3338 **
3339 **   AgtB:   outB, nextB      outB, nextB          nextB            nextB
3340 **
3341 **   EofA:   outB, nextB      outB, nextB          halt             halt
3342 **
3343 **   EofB:   outA, nextA      outA, nextA       outA, nextA         halt
3344 **
3345 ** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
3346 ** causes an immediate jump to EofA and an EOF on B following nextB causes
3347 ** an immediate jump to EofB.  Within EofA and EofB, and EOF on entry or
3348 ** following nextX causes a jump to the end of the select processing.
3349 **
3350 ** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
3351 ** within the output subroutine.  The regPrev register set holds the previously
3352 ** output value.  A comparison is made against this value and the output
3353 ** is skipped if the next results would be the same as the previous.
3354 **
3355 ** The implementation plan is to implement the two coroutines and seven
3356 ** subroutines first, then put the control logic at the bottom.  Like this:
3357 **
3358 **          goto Init
3359 **     coA: coroutine for left query (A)
3360 **     coB: coroutine for right query (B)
3361 **    outA: output one row of A
3362 **    outB: output one row of B (UNION and UNION ALL only)
3363 **    EofA: ...
3364 **    EofB: ...
3365 **    AltB: ...
3366 **    AeqB: ...
3367 **    AgtB: ...
3368 **    Init: initialize coroutine registers
3369 **          yield coA
3370 **          if eof(A) goto EofA
3371 **          yield coB
3372 **          if eof(B) goto EofB
3373 **    Cmpr: Compare A, B
3374 **          Jump AltB, AeqB, AgtB
3375 **     End: ...
3376 **
3377 ** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
3378 ** actually called using Gosub and they do not Return.  EofA and EofB loop
3379 ** until all data is exhausted then jump to the "end" labe.  AltB, AeqB,
3380 ** and AgtB jump to either L2 or to one of EofA or EofB.
3381 */
3382 #ifndef SQLITE_OMIT_COMPOUND_SELECT
3383 static int multiSelectOrderBy(
3384   Parse *pParse,        /* Parsing context */
3385   Select *p,            /* The right-most of SELECTs to be coded */
3386   SelectDest *pDest     /* What to do with query results */
3387 ){
3388   int i, j;             /* Loop counters */
3389   Select *pPrior;       /* Another SELECT immediately to our left */
3390   Select *pSplit;       /* Left-most SELECT in the right-hand group */
3391   int nSelect;          /* Number of SELECT statements in the compound */
3392   Vdbe *v;              /* Generate code to this VDBE */
3393   SelectDest destA;     /* Destination for coroutine A */
3394   SelectDest destB;     /* Destination for coroutine B */
3395   int regAddrA;         /* Address register for select-A coroutine */
3396   int regAddrB;         /* Address register for select-B coroutine */
3397   int addrSelectA;      /* Address of the select-A coroutine */
3398   int addrSelectB;      /* Address of the select-B coroutine */
3399   int regOutA;          /* Address register for the output-A subroutine */
3400   int regOutB;          /* Address register for the output-B subroutine */
3401   int addrOutA;         /* Address of the output-A subroutine */
3402   int addrOutB = 0;     /* Address of the output-B subroutine */
3403   int addrEofA;         /* Address of the select-A-exhausted subroutine */
3404   int addrEofA_noB;     /* Alternate addrEofA if B is uninitialized */
3405   int addrEofB;         /* Address of the select-B-exhausted subroutine */
3406   int addrAltB;         /* Address of the A<B subroutine */
3407   int addrAeqB;         /* Address of the A==B subroutine */
3408   int addrAgtB;         /* Address of the A>B subroutine */
3409   int regLimitA;        /* Limit register for select-A */
3410   int regLimitB;        /* Limit register for select-A */
3411   int regPrev;          /* A range of registers to hold previous output */
3412   int savedLimit;       /* Saved value of p->iLimit */
3413   int savedOffset;      /* Saved value of p->iOffset */
3414   int labelCmpr;        /* Label for the start of the merge algorithm */
3415   int labelEnd;         /* Label for the end of the overall SELECT stmt */
3416   int addr1;            /* Jump instructions that get retargetted */
3417   int op;               /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
3418   KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
3419   KeyInfo *pKeyMerge;   /* Comparison information for merging rows */
3420   sqlite3 *db;          /* Database connection */
3421   ExprList *pOrderBy;   /* The ORDER BY clause */
3422   int nOrderBy;         /* Number of terms in the ORDER BY clause */
3423   u32 *aPermute;        /* Mapping from ORDER BY terms to result set columns */
3424 
3425   assert( p->pOrderBy!=0 );
3426   assert( pKeyDup==0 ); /* "Managed" code needs this.  Ticket #3382. */
3427   db = pParse->db;
3428   v = pParse->pVdbe;
3429   assert( v!=0 );       /* Already thrown the error if VDBE alloc failed */
3430   labelEnd = sqlite3VdbeMakeLabel(pParse);
3431   labelCmpr = sqlite3VdbeMakeLabel(pParse);
3432 
3433 
3434   /* Patch up the ORDER BY clause
3435   */
3436   op = p->op;
3437   assert( p->pPrior->pOrderBy==0 );
3438   pOrderBy = p->pOrderBy;
3439   assert( pOrderBy );
3440   nOrderBy = pOrderBy->nExpr;
3441 
3442   /* For operators other than UNION ALL we have to make sure that
3443   ** the ORDER BY clause covers every term of the result set.  Add
3444   ** terms to the ORDER BY clause as necessary.
3445   */
3446   if( op!=TK_ALL ){
3447     for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
3448       struct ExprList_item *pItem;
3449       for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
3450         assert( pItem!=0 );
3451         assert( pItem->u.x.iOrderByCol>0 );
3452         if( pItem->u.x.iOrderByCol==i ) break;
3453       }
3454       if( j==nOrderBy ){
3455         Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
3456         if( pNew==0 ) return SQLITE_NOMEM_BKPT;
3457         pNew->flags |= EP_IntValue;
3458         pNew->u.iValue = i;
3459         p->pOrderBy = pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
3460         if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
3461       }
3462     }
3463   }
3464 
3465   /* Compute the comparison permutation and keyinfo that is used with
3466   ** the permutation used to determine if the next
3467   ** row of results comes from selectA or selectB.  Also add explicit
3468   ** collations to the ORDER BY clause terms so that when the subqueries
3469   ** to the right and the left are evaluated, they use the correct
3470   ** collation.
3471   */
3472   aPermute = sqlite3DbMallocRawNN(db, sizeof(u32)*(nOrderBy + 1));
3473   if( aPermute ){
3474     struct ExprList_item *pItem;
3475     aPermute[0] = nOrderBy;
3476     for(i=1, pItem=pOrderBy->a; i<=nOrderBy; i++, pItem++){
3477       assert( pItem!=0 );
3478       assert( pItem->u.x.iOrderByCol>0 );
3479       assert( pItem->u.x.iOrderByCol<=p->pEList->nExpr );
3480       aPermute[i] = pItem->u.x.iOrderByCol - 1;
3481     }
3482     pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
3483   }else{
3484     pKeyMerge = 0;
3485   }
3486 
3487   /* Allocate a range of temporary registers and the KeyInfo needed
3488   ** for the logic that removes duplicate result rows when the
3489   ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
3490   */
3491   if( op==TK_ALL ){
3492     regPrev = 0;
3493   }else{
3494     int nExpr = p->pEList->nExpr;
3495     assert( nOrderBy>=nExpr || db->mallocFailed );
3496     regPrev = pParse->nMem+1;
3497     pParse->nMem += nExpr+1;
3498     sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
3499     pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
3500     if( pKeyDup ){
3501       assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
3502       for(i=0; i<nExpr; i++){
3503         pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
3504         pKeyDup->aSortFlags[i] = 0;
3505       }
3506     }
3507   }
3508 
3509   /* Separate the left and the right query from one another
3510   */
3511   nSelect = 1;
3512   if( (op==TK_ALL || op==TK_UNION)
3513    && OptimizationEnabled(db, SQLITE_BalancedMerge)
3514   ){
3515     for(pSplit=p; pSplit->pPrior!=0 && pSplit->op==op; pSplit=pSplit->pPrior){
3516       nSelect++;
3517       assert( pSplit->pPrior->pNext==pSplit );
3518     }
3519   }
3520   if( nSelect<=3 ){
3521     pSplit = p;
3522   }else{
3523     pSplit = p;
3524     for(i=2; i<nSelect; i+=2){ pSplit = pSplit->pPrior; }
3525   }
3526   pPrior = pSplit->pPrior;
3527   assert( pPrior!=0 );
3528   pSplit->pPrior = 0;
3529   pPrior->pNext = 0;
3530   assert( p->pOrderBy == pOrderBy );
3531   assert( pOrderBy!=0 || db->mallocFailed );
3532   pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
3533   sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
3534   sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
3535 
3536   /* Compute the limit registers */
3537   computeLimitRegisters(pParse, p, labelEnd);
3538   if( p->iLimit && op==TK_ALL ){
3539     regLimitA = ++pParse->nMem;
3540     regLimitB = ++pParse->nMem;
3541     sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
3542                                   regLimitA);
3543     sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
3544   }else{
3545     regLimitA = regLimitB = 0;
3546   }
3547   sqlite3ExprDelete(db, p->pLimit);
3548   p->pLimit = 0;
3549 
3550   regAddrA = ++pParse->nMem;
3551   regAddrB = ++pParse->nMem;
3552   regOutA = ++pParse->nMem;
3553   regOutB = ++pParse->nMem;
3554   sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
3555   sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
3556 
3557   ExplainQueryPlan((pParse, 1, "MERGE (%s)", sqlite3SelectOpName(p->op)));
3558 
3559   /* Generate a coroutine to evaluate the SELECT statement to the
3560   ** left of the compound operator - the "A" select.
3561   */
3562   addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
3563   addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
3564   VdbeComment((v, "left SELECT"));
3565   pPrior->iLimit = regLimitA;
3566   ExplainQueryPlan((pParse, 1, "LEFT"));
3567   sqlite3Select(pParse, pPrior, &destA);
3568   sqlite3VdbeEndCoroutine(v, regAddrA);
3569   sqlite3VdbeJumpHere(v, addr1);
3570 
3571   /* Generate a coroutine to evaluate the SELECT statement on
3572   ** the right - the "B" select
3573   */
3574   addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
3575   addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
3576   VdbeComment((v, "right SELECT"));
3577   savedLimit = p->iLimit;
3578   savedOffset = p->iOffset;
3579   p->iLimit = regLimitB;
3580   p->iOffset = 0;
3581   ExplainQueryPlan((pParse, 1, "RIGHT"));
3582   sqlite3Select(pParse, p, &destB);
3583   p->iLimit = savedLimit;
3584   p->iOffset = savedOffset;
3585   sqlite3VdbeEndCoroutine(v, regAddrB);
3586 
3587   /* Generate a subroutine that outputs the current row of the A
3588   ** select as the next output row of the compound select.
3589   */
3590   VdbeNoopComment((v, "Output routine for A"));
3591   addrOutA = generateOutputSubroutine(pParse,
3592                  p, &destA, pDest, regOutA,
3593                  regPrev, pKeyDup, labelEnd);
3594 
3595   /* Generate a subroutine that outputs the current row of the B
3596   ** select as the next output row of the compound select.
3597   */
3598   if( op==TK_ALL || op==TK_UNION ){
3599     VdbeNoopComment((v, "Output routine for B"));
3600     addrOutB = generateOutputSubroutine(pParse,
3601                  p, &destB, pDest, regOutB,
3602                  regPrev, pKeyDup, labelEnd);
3603   }
3604   sqlite3KeyInfoUnref(pKeyDup);
3605 
3606   /* Generate a subroutine to run when the results from select A
3607   ** are exhausted and only data in select B remains.
3608   */
3609   if( op==TK_EXCEPT || op==TK_INTERSECT ){
3610     addrEofA_noB = addrEofA = labelEnd;
3611   }else{
3612     VdbeNoopComment((v, "eof-A subroutine"));
3613     addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3614     addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
3615                                      VdbeCoverage(v);
3616     sqlite3VdbeGoto(v, addrEofA);
3617     p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
3618   }
3619 
3620   /* Generate a subroutine to run when the results from select B
3621   ** are exhausted and only data in select A remains.
3622   */
3623   if( op==TK_INTERSECT ){
3624     addrEofB = addrEofA;
3625     if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
3626   }else{
3627     VdbeNoopComment((v, "eof-B subroutine"));
3628     addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
3629     sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
3630     sqlite3VdbeGoto(v, addrEofB);
3631   }
3632 
3633   /* Generate code to handle the case of A<B
3634   */
3635   VdbeNoopComment((v, "A-lt-B subroutine"));
3636   addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
3637   sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
3638   sqlite3VdbeGoto(v, labelCmpr);
3639 
3640   /* Generate code to handle the case of A==B
3641   */
3642   if( op==TK_ALL ){
3643     addrAeqB = addrAltB;
3644   }else if( op==TK_INTERSECT ){
3645     addrAeqB = addrAltB;
3646     addrAltB++;
3647   }else{
3648     VdbeNoopComment((v, "A-eq-B subroutine"));
3649     addrAeqB =
3650     sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
3651     sqlite3VdbeGoto(v, labelCmpr);
3652   }
3653 
3654   /* Generate code to handle the case of A>B
3655   */
3656   VdbeNoopComment((v, "A-gt-B subroutine"));
3657   addrAgtB = sqlite3VdbeCurrentAddr(v);
3658   if( op==TK_ALL || op==TK_UNION ){
3659     sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3660   }
3661   sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
3662   sqlite3VdbeGoto(v, labelCmpr);
3663 
3664   /* This code runs once to initialize everything.
3665   */
3666   sqlite3VdbeJumpHere(v, addr1);
3667   sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
3668   sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
3669 
3670   /* Implement the main merge loop
3671   */
3672   sqlite3VdbeResolveLabel(v, labelCmpr);
3673   sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
3674   sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
3675                          (char*)pKeyMerge, P4_KEYINFO);
3676   sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
3677   sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
3678 
3679   /* Jump to the this point in order to terminate the query.
3680   */
3681   sqlite3VdbeResolveLabel(v, labelEnd);
3682 
3683   /* Reassembly the compound query so that it will be freed correctly
3684   ** by the calling function */
3685   if( pSplit->pPrior ){
3686     sqlite3SelectDelete(db, pSplit->pPrior);
3687   }
3688   pSplit->pPrior = pPrior;
3689   pPrior->pNext = pSplit;
3690   sqlite3ExprListDelete(db, pPrior->pOrderBy);
3691   pPrior->pOrderBy = 0;
3692 
3693   /*** TBD:  Insert subroutine calls to close cursors on incomplete
3694   **** subqueries ****/
3695   ExplainQueryPlanPop(pParse);
3696   return pParse->nErr!=0;
3697 }
3698 #endif
3699 
3700 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3701 
3702 /* An instance of the SubstContext object describes an substitution edit
3703 ** to be performed on a parse tree.
3704 **
3705 ** All references to columns in table iTable are to be replaced by corresponding
3706 ** expressions in pEList.
3707 **
3708 ** ## About "isOuterJoin":
3709 **
3710 ** The isOuterJoin column indicates that the replacement will occur into a
3711 ** position in the parent that NULL-able due to an OUTER JOIN.  Either the
3712 ** target slot in the parent is the right operand of a LEFT JOIN, or one of
3713 ** the left operands of a RIGHT JOIN.  In either case, we need to potentially
3714 ** bypass the substituted expression with OP_IfNullRow.
3715 **
3716 ** Suppose the original expression integer constant.  Even though the table
3717 ** has the nullRow flag set, because the expression is an integer constant,
3718 ** it will not be NULLed out.  So instead, we insert an OP_IfNullRow opcode
3719 ** that checks to see if the nullRow flag is set on the table.  If the nullRow
3720 ** flag is set, then the value in the register is set to NULL and the original
3721 ** expression is bypassed.  If the nullRow flag is not set, then the original
3722 ** expression runs to populate the register.
3723 **
3724 ** Example where this is needed:
3725 **
3726 **      CREATE TABLE t1(a INTEGER PRIMARY KEY, b INT);
3727 **      CREATE TABLE t2(x INT UNIQUE);
3728 **
3729 **      SELECT a,b,m,x FROM t1 LEFT JOIN (SELECT 59 AS m,x FROM t2) ON b=x;
3730 **
3731 ** When the subquery on the right side of the LEFT JOIN is flattened, we
3732 ** have to add OP_IfNullRow in front of the OP_Integer that implements the
3733 ** "m" value of the subquery so that a NULL will be loaded instead of 59
3734 ** when processing a non-matched row of the left.
3735 */
3736 typedef struct SubstContext {
3737   Parse *pParse;            /* The parsing context */
3738   int iTable;               /* Replace references to this table */
3739   int iNewTable;            /* New table number */
3740   int isOuterJoin;          /* Add TK_IF_NULL_ROW opcodes on each replacement */
3741   ExprList *pEList;         /* Replacement expressions */
3742 } SubstContext;
3743 
3744 /* Forward Declarations */
3745 static void substExprList(SubstContext*, ExprList*);
3746 static void substSelect(SubstContext*, Select*, int);
3747 
3748 /*
3749 ** Scan through the expression pExpr.  Replace every reference to
3750 ** a column in table number iTable with a copy of the iColumn-th
3751 ** entry in pEList.  (But leave references to the ROWID column
3752 ** unchanged.)
3753 **
3754 ** This routine is part of the flattening procedure.  A subquery
3755 ** whose result set is defined by pEList appears as entry in the
3756 ** FROM clause of a SELECT such that the VDBE cursor assigned to that
3757 ** FORM clause entry is iTable.  This routine makes the necessary
3758 ** changes to pExpr so that it refers directly to the source table
3759 ** of the subquery rather the result set of the subquery.
3760 */
3761 static Expr *substExpr(
3762   SubstContext *pSubst,  /* Description of the substitution */
3763   Expr *pExpr            /* Expr in which substitution occurs */
3764 ){
3765   if( pExpr==0 ) return 0;
3766   if( ExprHasProperty(pExpr, EP_OuterON)
3767    && pExpr->w.iJoin==pSubst->iTable
3768   ){
3769     pExpr->w.iJoin = pSubst->iNewTable;
3770   }
3771   if( pExpr->op==TK_COLUMN
3772    && pExpr->iTable==pSubst->iTable
3773    && !ExprHasProperty(pExpr, EP_FixedCol)
3774   ){
3775 #ifdef SQLITE_ALLOW_ROWID_IN_VIEW
3776     if( pExpr->iColumn<0 ){
3777       pExpr->op = TK_NULL;
3778     }else
3779 #endif
3780     {
3781       Expr *pNew;
3782       Expr *pCopy = pSubst->pEList->a[pExpr->iColumn].pExpr;
3783       Expr ifNullRow;
3784       assert( pSubst->pEList!=0 && pExpr->iColumn<pSubst->pEList->nExpr );
3785       assert( pExpr->pRight==0 );
3786       if( sqlite3ExprIsVector(pCopy) ){
3787         sqlite3VectorErrorMsg(pSubst->pParse, pCopy);
3788       }else{
3789         sqlite3 *db = pSubst->pParse->db;
3790         if( pSubst->isOuterJoin && pCopy->op!=TK_COLUMN ){
3791           memset(&ifNullRow, 0, sizeof(ifNullRow));
3792           ifNullRow.op = TK_IF_NULL_ROW;
3793           ifNullRow.pLeft = pCopy;
3794           ifNullRow.iTable = pSubst->iNewTable;
3795           ifNullRow.flags = EP_IfNullRow;
3796           pCopy = &ifNullRow;
3797         }
3798         testcase( ExprHasProperty(pCopy, EP_Subquery) );
3799         pNew = sqlite3ExprDup(db, pCopy, 0);
3800         if( db->mallocFailed ){
3801           sqlite3ExprDelete(db, pNew);
3802           return pExpr;
3803         }
3804         if( pSubst->isOuterJoin ){
3805           ExprSetProperty(pNew, EP_CanBeNull);
3806         }
3807         if( ExprHasProperty(pExpr,EP_OuterON|EP_InnerON) ){
3808           sqlite3SetJoinExpr(pNew, pExpr->w.iJoin,
3809                              pExpr->flags & (EP_OuterON|EP_InnerON));
3810         }
3811         sqlite3ExprDelete(db, pExpr);
3812         pExpr = pNew;
3813         if( pExpr->op==TK_TRUEFALSE ){
3814           pExpr->u.iValue = sqlite3ExprTruthValue(pExpr);
3815           pExpr->op = TK_INTEGER;
3816           ExprSetProperty(pExpr, EP_IntValue);
3817         }
3818 
3819         /* Ensure that the expression now has an implicit collation sequence,
3820         ** just as it did when it was a column of a view or sub-query. */
3821         if( pExpr->op!=TK_COLUMN && pExpr->op!=TK_COLLATE ){
3822           CollSeq *pColl = sqlite3ExprCollSeq(pSubst->pParse, pExpr);
3823           pExpr = sqlite3ExprAddCollateString(pSubst->pParse, pExpr,
3824               (pColl ? pColl->zName : "BINARY")
3825           );
3826         }
3827         ExprClearProperty(pExpr, EP_Collate);
3828       }
3829     }
3830   }else{
3831     if( pExpr->op==TK_IF_NULL_ROW && pExpr->iTable==pSubst->iTable ){
3832       pExpr->iTable = pSubst->iNewTable;
3833     }
3834     pExpr->pLeft = substExpr(pSubst, pExpr->pLeft);
3835     pExpr->pRight = substExpr(pSubst, pExpr->pRight);
3836     if( ExprUseXSelect(pExpr) ){
3837       substSelect(pSubst, pExpr->x.pSelect, 1);
3838     }else{
3839       substExprList(pSubst, pExpr->x.pList);
3840     }
3841 #ifndef SQLITE_OMIT_WINDOWFUNC
3842     if( ExprHasProperty(pExpr, EP_WinFunc) ){
3843       Window *pWin = pExpr->y.pWin;
3844       pWin->pFilter = substExpr(pSubst, pWin->pFilter);
3845       substExprList(pSubst, pWin->pPartition);
3846       substExprList(pSubst, pWin->pOrderBy);
3847     }
3848 #endif
3849   }
3850   return pExpr;
3851 }
3852 static void substExprList(
3853   SubstContext *pSubst, /* Description of the substitution */
3854   ExprList *pList       /* List to scan and in which to make substitutes */
3855 ){
3856   int i;
3857   if( pList==0 ) return;
3858   for(i=0; i<pList->nExpr; i++){
3859     pList->a[i].pExpr = substExpr(pSubst, pList->a[i].pExpr);
3860   }
3861 }
3862 static void substSelect(
3863   SubstContext *pSubst, /* Description of the substitution */
3864   Select *p,            /* SELECT statement in which to make substitutions */
3865   int doPrior           /* Do substitutes on p->pPrior too */
3866 ){
3867   SrcList *pSrc;
3868   SrcItem *pItem;
3869   int i;
3870   if( !p ) return;
3871   do{
3872     substExprList(pSubst, p->pEList);
3873     substExprList(pSubst, p->pGroupBy);
3874     substExprList(pSubst, p->pOrderBy);
3875     p->pHaving = substExpr(pSubst, p->pHaving);
3876     p->pWhere = substExpr(pSubst, p->pWhere);
3877     pSrc = p->pSrc;
3878     assert( pSrc!=0 );
3879     for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
3880       substSelect(pSubst, pItem->pSelect, 1);
3881       if( pItem->fg.isTabFunc ){
3882         substExprList(pSubst, pItem->u1.pFuncArg);
3883       }
3884     }
3885   }while( doPrior && (p = p->pPrior)!=0 );
3886 }
3887 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3888 
3889 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3890 /*
3891 ** pSelect is a SELECT statement and pSrcItem is one item in the FROM
3892 ** clause of that SELECT.
3893 **
3894 ** This routine scans the entire SELECT statement and recomputes the
3895 ** pSrcItem->colUsed mask.
3896 */
3897 static int recomputeColumnsUsedExpr(Walker *pWalker, Expr *pExpr){
3898   SrcItem *pItem;
3899   if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
3900   pItem = pWalker->u.pSrcItem;
3901   if( pItem->iCursor!=pExpr->iTable ) return WRC_Continue;
3902   if( pExpr->iColumn<0 ) return WRC_Continue;
3903   pItem->colUsed |= sqlite3ExprColUsed(pExpr);
3904   return WRC_Continue;
3905 }
3906 static void recomputeColumnsUsed(
3907   Select *pSelect,                 /* The complete SELECT statement */
3908   SrcItem *pSrcItem                /* Which FROM clause item to recompute */
3909 ){
3910   Walker w;
3911   if( NEVER(pSrcItem->pTab==0) ) return;
3912   memset(&w, 0, sizeof(w));
3913   w.xExprCallback = recomputeColumnsUsedExpr;
3914   w.xSelectCallback = sqlite3SelectWalkNoop;
3915   w.u.pSrcItem = pSrcItem;
3916   pSrcItem->colUsed = 0;
3917   sqlite3WalkSelect(&w, pSelect);
3918 }
3919 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3920 
3921 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3922 /*
3923 ** Assign new cursor numbers to each of the items in pSrc. For each
3924 ** new cursor number assigned, set an entry in the aCsrMap[] array
3925 ** to map the old cursor number to the new:
3926 **
3927 **     aCsrMap[iOld+1] = iNew;
3928 **
3929 ** The array is guaranteed by the caller to be large enough for all
3930 ** existing cursor numbers in pSrc.  aCsrMap[0] is the array size.
3931 **
3932 ** If pSrc contains any sub-selects, call this routine recursively
3933 ** on the FROM clause of each such sub-select, with iExcept set to -1.
3934 */
3935 static void srclistRenumberCursors(
3936   Parse *pParse,                  /* Parse context */
3937   int *aCsrMap,                   /* Array to store cursor mappings in */
3938   SrcList *pSrc,                  /* FROM clause to renumber */
3939   int iExcept                     /* FROM clause item to skip */
3940 ){
3941   int i;
3942   SrcItem *pItem;
3943   for(i=0, pItem=pSrc->a; i<pSrc->nSrc; i++, pItem++){
3944     if( i!=iExcept ){
3945       Select *p;
3946       assert( pItem->iCursor < aCsrMap[0] );
3947       if( !pItem->fg.isRecursive || aCsrMap[pItem->iCursor+1]==0 ){
3948         aCsrMap[pItem->iCursor+1] = pParse->nTab++;
3949       }
3950       pItem->iCursor = aCsrMap[pItem->iCursor+1];
3951       for(p=pItem->pSelect; p; p=p->pPrior){
3952         srclistRenumberCursors(pParse, aCsrMap, p->pSrc, -1);
3953       }
3954     }
3955   }
3956 }
3957 
3958 /*
3959 ** *piCursor is a cursor number.  Change it if it needs to be mapped.
3960 */
3961 static void renumberCursorDoMapping(Walker *pWalker, int *piCursor){
3962   int *aCsrMap = pWalker->u.aiCol;
3963   int iCsr = *piCursor;
3964   if( iCsr < aCsrMap[0] && aCsrMap[iCsr+1]>0 ){
3965     *piCursor = aCsrMap[iCsr+1];
3966   }
3967 }
3968 
3969 /*
3970 ** Expression walker callback used by renumberCursors() to update
3971 ** Expr objects to match newly assigned cursor numbers.
3972 */
3973 static int renumberCursorsCb(Walker *pWalker, Expr *pExpr){
3974   int op = pExpr->op;
3975   if( op==TK_COLUMN || op==TK_IF_NULL_ROW ){
3976     renumberCursorDoMapping(pWalker, &pExpr->iTable);
3977   }
3978   if( ExprHasProperty(pExpr, EP_OuterON) ){
3979     renumberCursorDoMapping(pWalker, &pExpr->w.iJoin);
3980   }
3981   return WRC_Continue;
3982 }
3983 
3984 /*
3985 ** Assign a new cursor number to each cursor in the FROM clause (Select.pSrc)
3986 ** of the SELECT statement passed as the second argument, and to each
3987 ** cursor in the FROM clause of any FROM clause sub-selects, recursively.
3988 ** Except, do not assign a new cursor number to the iExcept'th element in
3989 ** the FROM clause of (*p). Update all expressions and other references
3990 ** to refer to the new cursor numbers.
3991 **
3992 ** Argument aCsrMap is an array that may be used for temporary working
3993 ** space. Two guarantees are made by the caller:
3994 **
3995 **   * the array is larger than the largest cursor number used within the
3996 **     select statement passed as an argument, and
3997 **
3998 **   * the array entries for all cursor numbers that do *not* appear in
3999 **     FROM clauses of the select statement as described above are
4000 **     initialized to zero.
4001 */
4002 static void renumberCursors(
4003   Parse *pParse,                  /* Parse context */
4004   Select *p,                      /* Select to renumber cursors within */
4005   int iExcept,                    /* FROM clause item to skip */
4006   int *aCsrMap                    /* Working space */
4007 ){
4008   Walker w;
4009   srclistRenumberCursors(pParse, aCsrMap, p->pSrc, iExcept);
4010   memset(&w, 0, sizeof(w));
4011   w.u.aiCol = aCsrMap;
4012   w.xExprCallback = renumberCursorsCb;
4013   w.xSelectCallback = sqlite3SelectWalkNoop;
4014   sqlite3WalkSelect(&w, p);
4015 }
4016 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4017 
4018 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4019 /*
4020 ** This routine attempts to flatten subqueries as a performance optimization.
4021 ** This routine returns 1 if it makes changes and 0 if no flattening occurs.
4022 **
4023 ** To understand the concept of flattening, consider the following
4024 ** query:
4025 **
4026 **     SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
4027 **
4028 ** The default way of implementing this query is to execute the
4029 ** subquery first and store the results in a temporary table, then
4030 ** run the outer query on that temporary table.  This requires two
4031 ** passes over the data.  Furthermore, because the temporary table
4032 ** has no indices, the WHERE clause on the outer query cannot be
4033 ** optimized.
4034 **
4035 ** This routine attempts to rewrite queries such as the above into
4036 ** a single flat select, like this:
4037 **
4038 **     SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
4039 **
4040 ** The code generated for this simplification gives the same result
4041 ** but only has to scan the data once.  And because indices might
4042 ** exist on the table t1, a complete scan of the data might be
4043 ** avoided.
4044 **
4045 ** Flattening is subject to the following constraints:
4046 **
4047 **  (**)  We no longer attempt to flatten aggregate subqueries. Was:
4048 **        The subquery and the outer query cannot both be aggregates.
4049 **
4050 **  (**)  We no longer attempt to flatten aggregate subqueries. Was:
4051 **        (2) If the subquery is an aggregate then
4052 **        (2a) the outer query must not be a join and
4053 **        (2b) the outer query must not use subqueries
4054 **             other than the one FROM-clause subquery that is a candidate
4055 **             for flattening.  (This is due to ticket [2f7170d73bf9abf80]
4056 **             from 2015-02-09.)
4057 **
4058 **   (3)  If the subquery is the right operand of a LEFT JOIN then
4059 **        (3a) the subquery may not be a join and
4060 **        (3b) the FROM clause of the subquery may not contain a virtual
4061 **             table and
4062 **        (3c) the outer query may not be an aggregate.
4063 **        (3d) the outer query may not be DISTINCT.
4064 **        See also (26) for restrictions on RIGHT JOIN.
4065 **
4066 **   (4)  The subquery can not be DISTINCT.
4067 **
4068 **  (**)  At one point restrictions (4) and (5) defined a subset of DISTINCT
4069 **        sub-queries that were excluded from this optimization. Restriction
4070 **        (4) has since been expanded to exclude all DISTINCT subqueries.
4071 **
4072 **  (**)  We no longer attempt to flatten aggregate subqueries.  Was:
4073 **        If the subquery is aggregate, the outer query may not be DISTINCT.
4074 **
4075 **   (7)  The subquery must have a FROM clause.  TODO:  For subqueries without
4076 **        A FROM clause, consider adding a FROM clause with the special
4077 **        table sqlite_once that consists of a single row containing a
4078 **        single NULL.
4079 **
4080 **   (8)  If the subquery uses LIMIT then the outer query may not be a join.
4081 **
4082 **   (9)  If the subquery uses LIMIT then the outer query may not be aggregate.
4083 **
4084 **  (**)  Restriction (10) was removed from the code on 2005-02-05 but we
4085 **        accidently carried the comment forward until 2014-09-15.  Original
4086 **        constraint: "If the subquery is aggregate then the outer query
4087 **        may not use LIMIT."
4088 **
4089 **  (11)  The subquery and the outer query may not both have ORDER BY clauses.
4090 **
4091 **  (**)  Not implemented.  Subsumed into restriction (3).  Was previously
4092 **        a separate restriction deriving from ticket #350.
4093 **
4094 **  (13)  The subquery and outer query may not both use LIMIT.
4095 **
4096 **  (14)  The subquery may not use OFFSET.
4097 **
4098 **  (15)  If the outer query is part of a compound select, then the
4099 **        subquery may not use LIMIT.
4100 **        (See ticket #2339 and ticket [02a8e81d44]).
4101 **
4102 **  (16)  If the outer query is aggregate, then the subquery may not
4103 **        use ORDER BY.  (Ticket #2942)  This used to not matter
4104 **        until we introduced the group_concat() function.
4105 **
4106 **  (17)  If the subquery is a compound select, then
4107 **        (17a) all compound operators must be a UNION ALL, and
4108 **        (17b) no terms within the subquery compound may be aggregate
4109 **              or DISTINCT, and
4110 **        (17c) every term within the subquery compound must have a FROM clause
4111 **        (17d) the outer query may not be
4112 **              (17d1) aggregate, or
4113 **              (17d2) DISTINCT
4114 **        (17e) the subquery may not contain window functions, and
4115 **        (17f) the subquery must not be the RHS of a LEFT JOIN.
4116 **
4117 **        The parent and sub-query may contain WHERE clauses. Subject to
4118 **        rules (11), (13) and (14), they may also contain ORDER BY,
4119 **        LIMIT and OFFSET clauses.  The subquery cannot use any compound
4120 **        operator other than UNION ALL because all the other compound
4121 **        operators have an implied DISTINCT which is disallowed by
4122 **        restriction (4).
4123 **
4124 **        Also, each component of the sub-query must return the same number
4125 **        of result columns. This is actually a requirement for any compound
4126 **        SELECT statement, but all the code here does is make sure that no
4127 **        such (illegal) sub-query is flattened. The caller will detect the
4128 **        syntax error and return a detailed message.
4129 **
4130 **  (18)  If the sub-query is a compound select, then all terms of the
4131 **        ORDER BY clause of the parent must be copies of a term returned
4132 **        by the parent query.
4133 **
4134 **  (19)  If the subquery uses LIMIT then the outer query may not
4135 **        have a WHERE clause.
4136 **
4137 **  (20)  If the sub-query is a compound select, then it must not use
4138 **        an ORDER BY clause.  Ticket #3773.  We could relax this constraint
4139 **        somewhat by saying that the terms of the ORDER BY clause must
4140 **        appear as unmodified result columns in the outer query.  But we
4141 **        have other optimizations in mind to deal with that case.
4142 **
4143 **  (21)  If the subquery uses LIMIT then the outer query may not be
4144 **        DISTINCT.  (See ticket [752e1646fc]).
4145 **
4146 **  (22)  The subquery may not be a recursive CTE.
4147 **
4148 **  (23)  If the outer query is a recursive CTE, then the sub-query may not be
4149 **        a compound query.  This restriction is because transforming the
4150 **        parent to a compound query confuses the code that handles
4151 **        recursive queries in multiSelect().
4152 **
4153 **  (**)  We no longer attempt to flatten aggregate subqueries.  Was:
4154 **        The subquery may not be an aggregate that uses the built-in min() or
4155 **        or max() functions.  (Without this restriction, a query like:
4156 **        "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
4157 **        return the value X for which Y was maximal.)
4158 **
4159 **  (25)  If either the subquery or the parent query contains a window
4160 **        function in the select list or ORDER BY clause, flattening
4161 **        is not attempted.
4162 **
4163 **  (26)  The subquery may not be the right operand of a RIGHT JOIN.
4164 **        See also (3) for restrictions on LEFT JOIN.
4165 **
4166 **  (27)  The subquery may not contain a FULL or RIGHT JOIN unless it
4167 **        is the first element of the parent query.
4168 **
4169 **  (28)  The subquery is not a MATERIALIZED CTE.
4170 **
4171 **
4172 ** In this routine, the "p" parameter is a pointer to the outer query.
4173 ** The subquery is p->pSrc->a[iFrom].  isAgg is true if the outer query
4174 ** uses aggregates.
4175 **
4176 ** If flattening is not attempted, this routine is a no-op and returns 0.
4177 ** If flattening is attempted this routine returns 1.
4178 **
4179 ** All of the expression analysis must occur on both the outer query and
4180 ** the subquery before this routine runs.
4181 */
4182 static int flattenSubquery(
4183   Parse *pParse,       /* Parsing context */
4184   Select *p,           /* The parent or outer SELECT statement */
4185   int iFrom,           /* Index in p->pSrc->a[] of the inner subquery */
4186   int isAgg            /* True if outer SELECT uses aggregate functions */
4187 ){
4188   const char *zSavedAuthContext = pParse->zAuthContext;
4189   Select *pParent;    /* Current UNION ALL term of the other query */
4190   Select *pSub;       /* The inner query or "subquery" */
4191   Select *pSub1;      /* Pointer to the rightmost select in sub-query */
4192   SrcList *pSrc;      /* The FROM clause of the outer query */
4193   SrcList *pSubSrc;   /* The FROM clause of the subquery */
4194   int iParent;        /* VDBE cursor number of the pSub result set temp table */
4195   int iNewParent = -1;/* Replacement table for iParent */
4196   int isOuterJoin = 0; /* True if pSub is the right side of a LEFT JOIN */
4197   int i;              /* Loop counter */
4198   Expr *pWhere;                    /* The WHERE clause */
4199   SrcItem *pSubitem;               /* The subquery */
4200   sqlite3 *db = pParse->db;
4201   Walker w;                        /* Walker to persist agginfo data */
4202   int *aCsrMap = 0;
4203 
4204   /* Check to see if flattening is permitted.  Return 0 if not.
4205   */
4206   assert( p!=0 );
4207   assert( p->pPrior==0 );
4208   if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
4209   pSrc = p->pSrc;
4210   assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
4211   pSubitem = &pSrc->a[iFrom];
4212   iParent = pSubitem->iCursor;
4213   pSub = pSubitem->pSelect;
4214   assert( pSub!=0 );
4215 
4216 #ifndef SQLITE_OMIT_WINDOWFUNC
4217   if( p->pWin || pSub->pWin ) return 0;                  /* Restriction (25) */
4218 #endif
4219 
4220   pSubSrc = pSub->pSrc;
4221   assert( pSubSrc );
4222   /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
4223   ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
4224   ** because they could be computed at compile-time.  But when LIMIT and OFFSET
4225   ** became arbitrary expressions, we were forced to add restrictions (13)
4226   ** and (14). */
4227   if( pSub->pLimit && p->pLimit ) return 0;              /* Restriction (13) */
4228   if( pSub->pLimit && pSub->pLimit->pRight ) return 0;   /* Restriction (14) */
4229   if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
4230     return 0;                                            /* Restriction (15) */
4231   }
4232   if( pSubSrc->nSrc==0 ) return 0;                       /* Restriction (7)  */
4233   if( pSub->selFlags & SF_Distinct ) return 0;           /* Restriction (4)  */
4234   if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
4235      return 0;         /* Restrictions (8)(9) */
4236   }
4237   if( p->pOrderBy && pSub->pOrderBy ){
4238      return 0;                                           /* Restriction (11) */
4239   }
4240   if( isAgg && pSub->pOrderBy ) return 0;                /* Restriction (16) */
4241   if( pSub->pLimit && p->pWhere ) return 0;              /* Restriction (19) */
4242   if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
4243      return 0;         /* Restriction (21) */
4244   }
4245   if( pSub->selFlags & (SF_Recursive) ){
4246     return 0; /* Restrictions (22) */
4247   }
4248 
4249   /*
4250   ** If the subquery is the right operand of a LEFT JOIN, then the
4251   ** subquery may not be a join itself (3a). Example of why this is not
4252   ** allowed:
4253   **
4254   **         t1 LEFT OUTER JOIN (t2 JOIN t3)
4255   **
4256   ** If we flatten the above, we would get
4257   **
4258   **         (t1 LEFT OUTER JOIN t2) JOIN t3
4259   **
4260   ** which is not at all the same thing.
4261   **
4262   ** If the subquery is the right operand of a LEFT JOIN, then the outer
4263   ** query cannot be an aggregate. (3c)  This is an artifact of the way
4264   ** aggregates are processed - there is no mechanism to determine if
4265   ** the LEFT JOIN table should be all-NULL.
4266   **
4267   ** See also tickets #306, #350, and #3300.
4268   */
4269   if( (pSubitem->fg.jointype & (JT_OUTER|JT_LTORJ))!=0 ){
4270     if( pSubSrc->nSrc>1                        /* (3a) */
4271      || isAgg                                  /* (3b) */
4272      || IsVirtual(pSubSrc->a[0].pTab)          /* (3c) */
4273      || (p->selFlags & SF_Distinct)!=0         /* (3d) */
4274      || (pSubitem->fg.jointype & JT_RIGHT)!=0  /* (26) */
4275     ){
4276       return 0;
4277     }
4278     isOuterJoin = 1;
4279   }
4280 #ifdef SQLITE_EXTRA_IFNULLROW
4281   else if( iFrom>0 && !isAgg ){
4282     /* Setting isOuterJoin to -1 causes OP_IfNullRow opcodes to be generated for
4283     ** every reference to any result column from subquery in a join, even
4284     ** though they are not necessary.  This will stress-test the OP_IfNullRow
4285     ** opcode. */
4286     isOuterJoin = -1;
4287   }
4288 #endif
4289 
4290   assert( pSubSrc->nSrc>0 );  /* True by restriction (7) */
4291   if( iFrom>0 && (pSubSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
4292     return 0;   /* Restriction (27) */
4293   }
4294   if( pSubitem->fg.isCte && pSubitem->u2.pCteUse->eM10d==M10d_Yes ){
4295     return 0;       /* (28) */
4296   }
4297 
4298   /* Restriction (17): If the sub-query is a compound SELECT, then it must
4299   ** use only the UNION ALL operator. And none of the simple select queries
4300   ** that make up the compound SELECT are allowed to be aggregate or distinct
4301   ** queries.
4302   */
4303   if( pSub->pPrior ){
4304     if( pSub->pOrderBy ){
4305       return 0;  /* Restriction (20) */
4306     }
4307     if( isAgg || (p->selFlags & SF_Distinct)!=0 || isOuterJoin>0 ){
4308       return 0; /* (17d1), (17d2), or (17f) */
4309     }
4310     for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
4311       testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
4312       testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
4313       assert( pSub->pSrc!=0 );
4314       assert( (pSub->selFlags & SF_Recursive)==0 );
4315       assert( pSub->pEList->nExpr==pSub1->pEList->nExpr );
4316       if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0    /* (17b) */
4317        || (pSub1->pPrior && pSub1->op!=TK_ALL)                 /* (17a) */
4318        || pSub1->pSrc->nSrc<1                                  /* (17c) */
4319 #ifndef SQLITE_OMIT_WINDOWFUNC
4320        || pSub1->pWin                                          /* (17e) */
4321 #endif
4322       ){
4323         return 0;
4324       }
4325       testcase( pSub1->pSrc->nSrc>1 );
4326     }
4327 
4328     /* Restriction (18). */
4329     if( p->pOrderBy ){
4330       int ii;
4331       for(ii=0; ii<p->pOrderBy->nExpr; ii++){
4332         if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
4333       }
4334     }
4335 
4336     /* Restriction (23) */
4337     if( (p->selFlags & SF_Recursive) ) return 0;
4338 
4339     if( pSrc->nSrc>1 ){
4340       if( pParse->nSelect>500 ) return 0;
4341       if( OptimizationDisabled(db, SQLITE_FlttnUnionAll) ) return 0;
4342       aCsrMap = sqlite3DbMallocZero(db, ((i64)pParse->nTab+1)*sizeof(int));
4343       if( aCsrMap ) aCsrMap[0] = pParse->nTab;
4344     }
4345   }
4346 
4347   /***** If we reach this point, flattening is permitted. *****/
4348   SELECTTRACE(1,pParse,p,("flatten %u.%p from term %d\n",
4349                    pSub->selId, pSub, iFrom));
4350 
4351   /* Authorize the subquery */
4352   pParse->zAuthContext = pSubitem->zName;
4353   TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
4354   testcase( i==SQLITE_DENY );
4355   pParse->zAuthContext = zSavedAuthContext;
4356 
4357   /* Delete the transient structures associated with thesubquery */
4358   pSub1 = pSubitem->pSelect;
4359   sqlite3DbFree(db, pSubitem->zDatabase);
4360   sqlite3DbFree(db, pSubitem->zName);
4361   sqlite3DbFree(db, pSubitem->zAlias);
4362   pSubitem->zDatabase = 0;
4363   pSubitem->zName = 0;
4364   pSubitem->zAlias = 0;
4365   pSubitem->pSelect = 0;
4366   assert( pSubitem->fg.isUsing!=0 || pSubitem->u3.pOn==0 );
4367 
4368   /* If the sub-query is a compound SELECT statement, then (by restrictions
4369   ** 17 and 18 above) it must be a UNION ALL and the parent query must
4370   ** be of the form:
4371   **
4372   **     SELECT <expr-list> FROM (<sub-query>) <where-clause>
4373   **
4374   ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
4375   ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
4376   ** OFFSET clauses and joins them to the left-hand-side of the original
4377   ** using UNION ALL operators. In this case N is the number of simple
4378   ** select statements in the compound sub-query.
4379   **
4380   ** Example:
4381   **
4382   **     SELECT a+1 FROM (
4383   **        SELECT x FROM tab
4384   **        UNION ALL
4385   **        SELECT y FROM tab
4386   **        UNION ALL
4387   **        SELECT abs(z*2) FROM tab2
4388   **     ) WHERE a!=5 ORDER BY 1
4389   **
4390   ** Transformed into:
4391   **
4392   **     SELECT x+1 FROM tab WHERE x+1!=5
4393   **     UNION ALL
4394   **     SELECT y+1 FROM tab WHERE y+1!=5
4395   **     UNION ALL
4396   **     SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
4397   **     ORDER BY 1
4398   **
4399   ** We call this the "compound-subquery flattening".
4400   */
4401   for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
4402     Select *pNew;
4403     ExprList *pOrderBy = p->pOrderBy;
4404     Expr *pLimit = p->pLimit;
4405     Select *pPrior = p->pPrior;
4406     Table *pItemTab = pSubitem->pTab;
4407     pSubitem->pTab = 0;
4408     p->pOrderBy = 0;
4409     p->pPrior = 0;
4410     p->pLimit = 0;
4411     pNew = sqlite3SelectDup(db, p, 0);
4412     p->pLimit = pLimit;
4413     p->pOrderBy = pOrderBy;
4414     p->op = TK_ALL;
4415     pSubitem->pTab = pItemTab;
4416     if( pNew==0 ){
4417       p->pPrior = pPrior;
4418     }else{
4419       pNew->selId = ++pParse->nSelect;
4420       if( aCsrMap && ALWAYS(db->mallocFailed==0) ){
4421         renumberCursors(pParse, pNew, iFrom, aCsrMap);
4422       }
4423       pNew->pPrior = pPrior;
4424       if( pPrior ) pPrior->pNext = pNew;
4425       pNew->pNext = p;
4426       p->pPrior = pNew;
4427       SELECTTRACE(2,pParse,p,("compound-subquery flattener"
4428                               " creates %u as peer\n",pNew->selId));
4429     }
4430     assert( pSubitem->pSelect==0 );
4431   }
4432   sqlite3DbFree(db, aCsrMap);
4433   if( db->mallocFailed ){
4434     pSubitem->pSelect = pSub1;
4435     return 1;
4436   }
4437 
4438   /* Defer deleting the Table object associated with the
4439   ** subquery until code generation is
4440   ** complete, since there may still exist Expr.pTab entries that
4441   ** refer to the subquery even after flattening.  Ticket #3346.
4442   **
4443   ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
4444   */
4445   if( ALWAYS(pSubitem->pTab!=0) ){
4446     Table *pTabToDel = pSubitem->pTab;
4447     if( pTabToDel->nTabRef==1 ){
4448       Parse *pToplevel = sqlite3ParseToplevel(pParse);
4449       sqlite3ParserAddCleanup(pToplevel,
4450          (void(*)(sqlite3*,void*))sqlite3DeleteTable,
4451          pTabToDel);
4452       testcase( pToplevel->earlyCleanup );
4453     }else{
4454       pTabToDel->nTabRef--;
4455     }
4456     pSubitem->pTab = 0;
4457   }
4458 
4459   /* The following loop runs once for each term in a compound-subquery
4460   ** flattening (as described above).  If we are doing a different kind
4461   ** of flattening - a flattening other than a compound-subquery flattening -
4462   ** then this loop only runs once.
4463   **
4464   ** This loop moves all of the FROM elements of the subquery into the
4465   ** the FROM clause of the outer query.  Before doing this, remember
4466   ** the cursor number for the original outer query FROM element in
4467   ** iParent.  The iParent cursor will never be used.  Subsequent code
4468   ** will scan expressions looking for iParent references and replace
4469   ** those references with expressions that resolve to the subquery FROM
4470   ** elements we are now copying in.
4471   */
4472   pSub = pSub1;
4473   for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
4474     int nSubSrc;
4475     u8 jointype = 0;
4476     u8 ltorj = pSrc->a[iFrom].fg.jointype & JT_LTORJ;
4477     assert( pSub!=0 );
4478     pSubSrc = pSub->pSrc;     /* FROM clause of subquery */
4479     nSubSrc = pSubSrc->nSrc;  /* Number of terms in subquery FROM clause */
4480     pSrc = pParent->pSrc;     /* FROM clause of the outer query */
4481 
4482     if( pParent==p ){
4483       jointype = pSubitem->fg.jointype;     /* First time through the loop */
4484     }
4485 
4486     /* The subquery uses a single slot of the FROM clause of the outer
4487     ** query.  If the subquery has more than one element in its FROM clause,
4488     ** then expand the outer query to make space for it to hold all elements
4489     ** of the subquery.
4490     **
4491     ** Example:
4492     **
4493     **    SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
4494     **
4495     ** The outer query has 3 slots in its FROM clause.  One slot of the
4496     ** outer query (the middle slot) is used by the subquery.  The next
4497     ** block of code will expand the outer query FROM clause to 4 slots.
4498     ** The middle slot is expanded to two slots in order to make space
4499     ** for the two elements in the FROM clause of the subquery.
4500     */
4501     if( nSubSrc>1 ){
4502       pSrc = sqlite3SrcListEnlarge(pParse, pSrc, nSubSrc-1,iFrom+1);
4503       if( pSrc==0 ) break;
4504       pParent->pSrc = pSrc;
4505     }
4506 
4507     /* Transfer the FROM clause terms from the subquery into the
4508     ** outer query.
4509     */
4510     for(i=0; i<nSubSrc; i++){
4511       SrcItem *pItem = &pSrc->a[i+iFrom];
4512       if( pItem->fg.isUsing ) sqlite3IdListDelete(db, pItem->u3.pUsing);
4513       assert( pItem->fg.isTabFunc==0 );
4514       *pItem = pSubSrc->a[i];
4515       pItem->fg.jointype |= ltorj;
4516       iNewParent = pSubSrc->a[i].iCursor;
4517       memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
4518     }
4519     pSrc->a[iFrom].fg.jointype &= JT_LTORJ;
4520     pSrc->a[iFrom].fg.jointype |= jointype | ltorj;
4521 
4522     /* Now begin substituting subquery result set expressions for
4523     ** references to the iParent in the outer query.
4524     **
4525     ** Example:
4526     **
4527     **   SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
4528     **   \                     \_____________ subquery __________/          /
4529     **    \_____________________ outer query ______________________________/
4530     **
4531     ** We look at every expression in the outer query and every place we see
4532     ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
4533     */
4534     if( pSub->pOrderBy && (pParent->selFlags & SF_NoopOrderBy)==0 ){
4535       /* At this point, any non-zero iOrderByCol values indicate that the
4536       ** ORDER BY column expression is identical to the iOrderByCol'th
4537       ** expression returned by SELECT statement pSub. Since these values
4538       ** do not necessarily correspond to columns in SELECT statement pParent,
4539       ** zero them before transfering the ORDER BY clause.
4540       **
4541       ** Not doing this may cause an error if a subsequent call to this
4542       ** function attempts to flatten a compound sub-query into pParent
4543       ** (the only way this can happen is if the compound sub-query is
4544       ** currently part of pSub->pSrc). See ticket [d11a6e908f].  */
4545       ExprList *pOrderBy = pSub->pOrderBy;
4546       for(i=0; i<pOrderBy->nExpr; i++){
4547         pOrderBy->a[i].u.x.iOrderByCol = 0;
4548       }
4549       assert( pParent->pOrderBy==0 );
4550       pParent->pOrderBy = pOrderBy;
4551       pSub->pOrderBy = 0;
4552     }
4553     pWhere = pSub->pWhere;
4554     pSub->pWhere = 0;
4555     if( isOuterJoin>0 ){
4556       sqlite3SetJoinExpr(pWhere, iNewParent, EP_OuterON);
4557     }
4558     if( pWhere ){
4559       if( pParent->pWhere ){
4560         pParent->pWhere = sqlite3PExpr(pParse, TK_AND, pWhere, pParent->pWhere);
4561       }else{
4562         pParent->pWhere = pWhere;
4563       }
4564     }
4565     if( db->mallocFailed==0 ){
4566       SubstContext x;
4567       x.pParse = pParse;
4568       x.iTable = iParent;
4569       x.iNewTable = iNewParent;
4570       x.isOuterJoin = isOuterJoin;
4571       x.pEList = pSub->pEList;
4572       substSelect(&x, pParent, 0);
4573     }
4574 
4575     /* The flattened query is a compound if either the inner or the
4576     ** outer query is a compound. */
4577     pParent->selFlags |= pSub->selFlags & SF_Compound;
4578     assert( (pSub->selFlags & SF_Distinct)==0 ); /* restriction (17b) */
4579 
4580     /*
4581     ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
4582     **
4583     ** One is tempted to try to add a and b to combine the limits.  But this
4584     ** does not work if either limit is negative.
4585     */
4586     if( pSub->pLimit ){
4587       pParent->pLimit = pSub->pLimit;
4588       pSub->pLimit = 0;
4589     }
4590 
4591     /* Recompute the SrcList_item.colUsed masks for the flattened
4592     ** tables. */
4593     for(i=0; i<nSubSrc; i++){
4594       recomputeColumnsUsed(pParent, &pSrc->a[i+iFrom]);
4595     }
4596   }
4597 
4598   /* Finially, delete what is left of the subquery and return
4599   ** success.
4600   */
4601   sqlite3AggInfoPersistWalkerInit(&w, pParse);
4602   sqlite3WalkSelect(&w,pSub1);
4603   sqlite3SelectDelete(db, pSub1);
4604 
4605 #if TREETRACE_ENABLED
4606   if( sqlite3TreeTrace & 0x100 ){
4607     SELECTTRACE(0x100,pParse,p,("After flattening:\n"));
4608     sqlite3TreeViewSelect(0, p, 0);
4609   }
4610 #endif
4611 
4612   return 1;
4613 }
4614 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4615 
4616 /*
4617 ** A structure to keep track of all of the column values that are fixed to
4618 ** a known value due to WHERE clause constraints of the form COLUMN=VALUE.
4619 */
4620 typedef struct WhereConst WhereConst;
4621 struct WhereConst {
4622   Parse *pParse;   /* Parsing context */
4623   u8 *pOomFault;   /* Pointer to pParse->db->mallocFailed */
4624   int nConst;      /* Number for COLUMN=CONSTANT terms */
4625   int nChng;       /* Number of times a constant is propagated */
4626   int bHasAffBlob; /* At least one column in apExpr[] as affinity BLOB */
4627   Expr **apExpr;   /* [i*2] is COLUMN and [i*2+1] is VALUE */
4628 };
4629 
4630 /*
4631 ** Add a new entry to the pConst object.  Except, do not add duplicate
4632 ** pColumn entires.  Also, do not add if doing so would not be appropriate.
4633 **
4634 ** The caller guarantees the pColumn is a column and pValue is a constant.
4635 ** This routine has to do some additional checks before completing the
4636 ** insert.
4637 */
4638 static void constInsert(
4639   WhereConst *pConst,  /* The WhereConst into which we are inserting */
4640   Expr *pColumn,       /* The COLUMN part of the constraint */
4641   Expr *pValue,        /* The VALUE part of the constraint */
4642   Expr *pExpr          /* Overall expression: COLUMN=VALUE or VALUE=COLUMN */
4643 ){
4644   int i;
4645   assert( pColumn->op==TK_COLUMN );
4646   assert( sqlite3ExprIsConstant(pValue) );
4647 
4648   if( ExprHasProperty(pColumn, EP_FixedCol) ) return;
4649   if( sqlite3ExprAffinity(pValue)!=0 ) return;
4650   if( !sqlite3IsBinary(sqlite3ExprCompareCollSeq(pConst->pParse,pExpr)) ){
4651     return;
4652   }
4653 
4654   /* 2018-10-25 ticket [cf5ed20f]
4655   ** Make sure the same pColumn is not inserted more than once */
4656   for(i=0; i<pConst->nConst; i++){
4657     const Expr *pE2 = pConst->apExpr[i*2];
4658     assert( pE2->op==TK_COLUMN );
4659     if( pE2->iTable==pColumn->iTable
4660      && pE2->iColumn==pColumn->iColumn
4661     ){
4662       return;  /* Already present.  Return without doing anything. */
4663     }
4664   }
4665   if( sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4666     pConst->bHasAffBlob = 1;
4667   }
4668 
4669   pConst->nConst++;
4670   pConst->apExpr = sqlite3DbReallocOrFree(pConst->pParse->db, pConst->apExpr,
4671                          pConst->nConst*2*sizeof(Expr*));
4672   if( pConst->apExpr==0 ){
4673     pConst->nConst = 0;
4674   }else{
4675     pConst->apExpr[pConst->nConst*2-2] = pColumn;
4676     pConst->apExpr[pConst->nConst*2-1] = pValue;
4677   }
4678 }
4679 
4680 /*
4681 ** Find all terms of COLUMN=VALUE or VALUE=COLUMN in pExpr where VALUE
4682 ** is a constant expression and where the term must be true because it
4683 ** is part of the AND-connected terms of the expression.  For each term
4684 ** found, add it to the pConst structure.
4685 */
4686 static void findConstInWhere(WhereConst *pConst, Expr *pExpr){
4687   Expr *pRight, *pLeft;
4688   if( NEVER(pExpr==0) ) return;
4689   if( ExprHasProperty(pExpr, EP_OuterON) ) return;
4690   if( pExpr->op==TK_AND ){
4691     findConstInWhere(pConst, pExpr->pRight);
4692     findConstInWhere(pConst, pExpr->pLeft);
4693     return;
4694   }
4695   if( pExpr->op!=TK_EQ ) return;
4696   pRight = pExpr->pRight;
4697   pLeft = pExpr->pLeft;
4698   assert( pRight!=0 );
4699   assert( pLeft!=0 );
4700   if( pRight->op==TK_COLUMN && sqlite3ExprIsConstant(pLeft) ){
4701     constInsert(pConst,pRight,pLeft,pExpr);
4702   }
4703   if( pLeft->op==TK_COLUMN && sqlite3ExprIsConstant(pRight) ){
4704     constInsert(pConst,pLeft,pRight,pExpr);
4705   }
4706 }
4707 
4708 /*
4709 ** This is a helper function for Walker callback propagateConstantExprRewrite().
4710 **
4711 ** Argument pExpr is a candidate expression to be replaced by a value. If
4712 ** pExpr is equivalent to one of the columns named in pWalker->u.pConst,
4713 ** then overwrite it with the corresponding value. Except, do not do so
4714 ** if argument bIgnoreAffBlob is non-zero and the affinity of pExpr
4715 ** is SQLITE_AFF_BLOB.
4716 */
4717 static int propagateConstantExprRewriteOne(
4718   WhereConst *pConst,
4719   Expr *pExpr,
4720   int bIgnoreAffBlob
4721 ){
4722   int i;
4723   if( pConst->pOomFault[0] ) return WRC_Prune;
4724   if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
4725   if( ExprHasProperty(pExpr, EP_FixedCol|EP_OuterON) ){
4726     testcase( ExprHasProperty(pExpr, EP_FixedCol) );
4727     testcase( ExprHasProperty(pExpr, EP_OuterON) );
4728     return WRC_Continue;
4729   }
4730   for(i=0; i<pConst->nConst; i++){
4731     Expr *pColumn = pConst->apExpr[i*2];
4732     if( pColumn==pExpr ) continue;
4733     if( pColumn->iTable!=pExpr->iTable ) continue;
4734     if( pColumn->iColumn!=pExpr->iColumn ) continue;
4735     if( bIgnoreAffBlob && sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4736       break;
4737     }
4738     /* A match is found.  Add the EP_FixedCol property */
4739     pConst->nChng++;
4740     ExprClearProperty(pExpr, EP_Leaf);
4741     ExprSetProperty(pExpr, EP_FixedCol);
4742     assert( pExpr->pLeft==0 );
4743     pExpr->pLeft = sqlite3ExprDup(pConst->pParse->db, pConst->apExpr[i*2+1], 0);
4744     if( pConst->pParse->db->mallocFailed ) return WRC_Prune;
4745     break;
4746   }
4747   return WRC_Prune;
4748 }
4749 
4750 /*
4751 ** This is a Walker expression callback. pExpr is a node from the WHERE
4752 ** clause of a SELECT statement. This function examines pExpr to see if
4753 ** any substitutions based on the contents of pWalker->u.pConst should
4754 ** be made to pExpr or its immediate children.
4755 **
4756 ** A substitution is made if:
4757 **
4758 **   + pExpr is a column with an affinity other than BLOB that matches
4759 **     one of the columns in pWalker->u.pConst, or
4760 **
4761 **   + pExpr is a binary comparison operator (=, <=, >=, <, >) that
4762 **     uses an affinity other than TEXT and one of its immediate
4763 **     children is a column that matches one of the columns in
4764 **     pWalker->u.pConst.
4765 */
4766 static int propagateConstantExprRewrite(Walker *pWalker, Expr *pExpr){
4767   WhereConst *pConst = pWalker->u.pConst;
4768   assert( TK_GT==TK_EQ+1 );
4769   assert( TK_LE==TK_EQ+2 );
4770   assert( TK_LT==TK_EQ+3 );
4771   assert( TK_GE==TK_EQ+4 );
4772   if( pConst->bHasAffBlob ){
4773     if( (pExpr->op>=TK_EQ && pExpr->op<=TK_GE)
4774      || pExpr->op==TK_IS
4775     ){
4776       propagateConstantExprRewriteOne(pConst, pExpr->pLeft, 0);
4777       if( pConst->pOomFault[0] ) return WRC_Prune;
4778       if( sqlite3ExprAffinity(pExpr->pLeft)!=SQLITE_AFF_TEXT ){
4779         propagateConstantExprRewriteOne(pConst, pExpr->pRight, 0);
4780       }
4781     }
4782   }
4783   return propagateConstantExprRewriteOne(pConst, pExpr, pConst->bHasAffBlob);
4784 }
4785 
4786 /*
4787 ** The WHERE-clause constant propagation optimization.
4788 **
4789 ** If the WHERE clause contains terms of the form COLUMN=CONSTANT or
4790 ** CONSTANT=COLUMN that are top-level AND-connected terms that are not
4791 ** part of a ON clause from a LEFT JOIN, then throughout the query
4792 ** replace all other occurrences of COLUMN with CONSTANT.
4793 **
4794 ** For example, the query:
4795 **
4796 **      SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=t1.a AND t3.c=t2.b
4797 **
4798 ** Is transformed into
4799 **
4800 **      SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=39 AND t3.c=39
4801 **
4802 ** Return true if any transformations where made and false if not.
4803 **
4804 ** Implementation note:  Constant propagation is tricky due to affinity
4805 ** and collating sequence interactions.  Consider this example:
4806 **
4807 **    CREATE TABLE t1(a INT,b TEXT);
4808 **    INSERT INTO t1 VALUES(123,'0123');
4809 **    SELECT * FROM t1 WHERE a=123 AND b=a;
4810 **    SELECT * FROM t1 WHERE a=123 AND b=123;
4811 **
4812 ** The two SELECT statements above should return different answers.  b=a
4813 ** is alway true because the comparison uses numeric affinity, but b=123
4814 ** is false because it uses text affinity and '0123' is not the same as '123'.
4815 ** To work around this, the expression tree is not actually changed from
4816 ** "b=a" to "b=123" but rather the "a" in "b=a" is tagged with EP_FixedCol
4817 ** and the "123" value is hung off of the pLeft pointer.  Code generator
4818 ** routines know to generate the constant "123" instead of looking up the
4819 ** column value.  Also, to avoid collation problems, this optimization is
4820 ** only attempted if the "a=123" term uses the default BINARY collation.
4821 **
4822 ** 2021-05-25 forum post 6a06202608: Another troublesome case is...
4823 **
4824 **    CREATE TABLE t1(x);
4825 **    INSERT INTO t1 VALUES(10.0);
4826 **    SELECT 1 FROM t1 WHERE x=10 AND x LIKE 10;
4827 **
4828 ** The query should return no rows, because the t1.x value is '10.0' not '10'
4829 ** and '10.0' is not LIKE '10'.  But if we are not careful, the first WHERE
4830 ** term "x=10" will cause the second WHERE term to become "10 LIKE 10",
4831 ** resulting in a false positive.  To avoid this, constant propagation for
4832 ** columns with BLOB affinity is only allowed if the constant is used with
4833 ** operators ==, <=, <, >=, >, or IS in a way that will cause the correct
4834 ** type conversions to occur.  See logic associated with the bHasAffBlob flag
4835 ** for details.
4836 */
4837 static int propagateConstants(
4838   Parse *pParse,   /* The parsing context */
4839   Select *p        /* The query in which to propagate constants */
4840 ){
4841   WhereConst x;
4842   Walker w;
4843   int nChng = 0;
4844   x.pParse = pParse;
4845   x.pOomFault = &pParse->db->mallocFailed;
4846   do{
4847     x.nConst = 0;
4848     x.nChng = 0;
4849     x.apExpr = 0;
4850     x.bHasAffBlob = 0;
4851     findConstInWhere(&x, p->pWhere);
4852     if( x.nConst ){
4853       memset(&w, 0, sizeof(w));
4854       w.pParse = pParse;
4855       w.xExprCallback = propagateConstantExprRewrite;
4856       w.xSelectCallback = sqlite3SelectWalkNoop;
4857       w.xSelectCallback2 = 0;
4858       w.walkerDepth = 0;
4859       w.u.pConst = &x;
4860       sqlite3WalkExpr(&w, p->pWhere);
4861       sqlite3DbFree(x.pParse->db, x.apExpr);
4862       nChng += x.nChng;
4863     }
4864   }while( x.nChng );
4865   return nChng;
4866 }
4867 
4868 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4869 # if !defined(SQLITE_OMIT_WINDOWFUNC)
4870 /*
4871 ** This function is called to determine whether or not it is safe to
4872 ** push WHERE clause expression pExpr down to FROM clause sub-query
4873 ** pSubq, which contains at least one window function. Return 1
4874 ** if it is safe and the expression should be pushed down, or 0
4875 ** otherwise.
4876 **
4877 ** It is only safe to push the expression down if it consists only
4878 ** of constants and copies of expressions that appear in the PARTITION
4879 ** BY clause of all window function used by the sub-query. It is safe
4880 ** to filter out entire partitions, but not rows within partitions, as
4881 ** this may change the results of the window functions.
4882 **
4883 ** At the time this function is called it is guaranteed that
4884 **
4885 **   * the sub-query uses only one distinct window frame, and
4886 **   * that the window frame has a PARTITION BY clase.
4887 */
4888 static int pushDownWindowCheck(Parse *pParse, Select *pSubq, Expr *pExpr){
4889   assert( pSubq->pWin->pPartition );
4890   assert( (pSubq->selFlags & SF_MultiPart)==0 );
4891   assert( pSubq->pPrior==0 );
4892   return sqlite3ExprIsConstantOrGroupBy(pParse, pExpr, pSubq->pWin->pPartition);
4893 }
4894 # endif /* SQLITE_OMIT_WINDOWFUNC */
4895 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4896 
4897 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4898 /*
4899 ** Make copies of relevant WHERE clause terms of the outer query into
4900 ** the WHERE clause of subquery.  Example:
4901 **
4902 **    SELECT * FROM (SELECT a AS x, c-d AS y FROM t1) WHERE x=5 AND y=10;
4903 **
4904 ** Transformed into:
4905 **
4906 **    SELECT * FROM (SELECT a AS x, c-d AS y FROM t1 WHERE a=5 AND c-d=10)
4907 **     WHERE x=5 AND y=10;
4908 **
4909 ** The hope is that the terms added to the inner query will make it more
4910 ** efficient.
4911 **
4912 ** Do not attempt this optimization if:
4913 **
4914 **   (1) (** This restriction was removed on 2017-09-29.  We used to
4915 **           disallow this optimization for aggregate subqueries, but now
4916 **           it is allowed by putting the extra terms on the HAVING clause.
4917 **           The added HAVING clause is pointless if the subquery lacks
4918 **           a GROUP BY clause.  But such a HAVING clause is also harmless
4919 **           so there does not appear to be any reason to add extra logic
4920 **           to suppress it. **)
4921 **
4922 **   (2) The inner query is the recursive part of a common table expression.
4923 **
4924 **   (3) The inner query has a LIMIT clause (since the changes to the WHERE
4925 **       clause would change the meaning of the LIMIT).
4926 **
4927 **   (4) The inner query is the right operand of a LEFT JOIN and the
4928 **       expression to be pushed down does not come from the ON clause
4929 **       on that LEFT JOIN.
4930 **
4931 **   (5) The WHERE clause expression originates in the ON or USING clause
4932 **       of a LEFT JOIN where iCursor is not the right-hand table of that
4933 **       left join.  An example:
4934 **
4935 **           SELECT *
4936 **           FROM (SELECT 1 AS a1 UNION ALL SELECT 2) AS aa
4937 **           JOIN (SELECT 1 AS b2 UNION ALL SELECT 2) AS bb ON (a1=b2)
4938 **           LEFT JOIN (SELECT 8 AS c3 UNION ALL SELECT 9) AS cc ON (b2=2);
4939 **
4940 **       The correct answer is three rows:  (1,1,NULL),(2,2,8),(2,2,9).
4941 **       But if the (b2=2) term were to be pushed down into the bb subquery,
4942 **       then the (1,1,NULL) row would be suppressed.
4943 **
4944 **   (6) Window functions make things tricky as changes to the WHERE clause
4945 **       of the inner query could change the window over which window
4946 **       functions are calculated. Therefore, do not attempt the optimization
4947 **       if:
4948 **
4949 **     (6a) The inner query uses multiple incompatible window partitions.
4950 **
4951 **     (6b) The inner query is a compound and uses window-functions.
4952 **
4953 **     (6c) The WHERE clause does not consist entirely of constants and
4954 **          copies of expressions found in the PARTITION BY clause of
4955 **          all window-functions used by the sub-query. It is safe to
4956 **          filter out entire partitions, as this does not change the
4957 **          window over which any window-function is calculated.
4958 **
4959 **   (7) The inner query is a Common Table Expression (CTE) that should
4960 **       be materialized.  (This restriction is implemented in the calling
4961 **       routine.)
4962 **
4963 ** Return 0 if no changes are made and non-zero if one or more WHERE clause
4964 ** terms are duplicated into the subquery.
4965 */
4966 static int pushDownWhereTerms(
4967   Parse *pParse,        /* Parse context (for malloc() and error reporting) */
4968   Select *pSubq,        /* The subquery whose WHERE clause is to be augmented */
4969   Expr *pWhere,         /* The WHERE clause of the outer query */
4970   SrcItem *pSrc         /* The subquery term of the outer FROM clause */
4971 ){
4972   Expr *pNew;
4973   int nChng = 0;
4974   if( pWhere==0 ) return 0;
4975   if( pSubq->selFlags & (SF_Recursive|SF_MultiPart) ) return 0;
4976   if( pSrc->fg.jointype & (JT_LTORJ|JT_RIGHT) ) return 0;
4977 
4978 #ifndef SQLITE_OMIT_WINDOWFUNC
4979   if( pSubq->pPrior ){
4980     Select *pSel;
4981     for(pSel=pSubq; pSel; pSel=pSel->pPrior){
4982       if( pSel->pWin ) return 0;    /* restriction (6b) */
4983     }
4984   }else{
4985     if( pSubq->pWin && pSubq->pWin->pPartition==0 ) return 0;
4986   }
4987 #endif
4988 
4989 #ifdef SQLITE_DEBUG
4990   /* Only the first term of a compound can have a WITH clause.  But make
4991   ** sure no other terms are marked SF_Recursive in case something changes
4992   ** in the future.
4993   */
4994   {
4995     Select *pX;
4996     for(pX=pSubq; pX; pX=pX->pPrior){
4997       assert( (pX->selFlags & (SF_Recursive))==0 );
4998     }
4999   }
5000 #endif
5001 
5002   if( pSubq->pLimit!=0 ){
5003     return 0; /* restriction (3) */
5004   }
5005   while( pWhere->op==TK_AND ){
5006     nChng += pushDownWhereTerms(pParse, pSubq, pWhere->pRight, pSrc);
5007     pWhere = pWhere->pLeft;
5008   }
5009 
5010 #if 0  /* Legacy code. Checks now done by sqlite3ExprIsTableConstraint() */
5011   if( isLeftJoin
5012    && (ExprHasProperty(pWhere,EP_OuterON)==0
5013          || pWhere->w.iJoin!=iCursor)
5014   ){
5015     return 0; /* restriction (4) */
5016   }
5017   if( ExprHasProperty(pWhere,EP_OuterON)
5018    && pWhere->w.iJoin!=iCursor
5019   ){
5020     return 0; /* restriction (5) */
5021   }
5022 #endif
5023 
5024   if( sqlite3ExprIsTableConstraint(pWhere, pSrc) ){
5025     nChng++;
5026     pSubq->selFlags |= SF_PushDown;
5027     while( pSubq ){
5028       SubstContext x;
5029       pNew = sqlite3ExprDup(pParse->db, pWhere, 0);
5030       unsetJoinExpr(pNew, -1);
5031       x.pParse = pParse;
5032       x.iTable = pSrc->iCursor;
5033       x.iNewTable = pSrc->iCursor;
5034       x.isOuterJoin = 0;
5035       x.pEList = pSubq->pEList;
5036       pNew = substExpr(&x, pNew);
5037 #ifndef SQLITE_OMIT_WINDOWFUNC
5038       if( pSubq->pWin && 0==pushDownWindowCheck(pParse, pSubq, pNew) ){
5039         /* Restriction 6c has prevented push-down in this case */
5040         sqlite3ExprDelete(pParse->db, pNew);
5041         nChng--;
5042         break;
5043       }
5044 #endif
5045       if( pSubq->selFlags & SF_Aggregate ){
5046         pSubq->pHaving = sqlite3ExprAnd(pParse, pSubq->pHaving, pNew);
5047       }else{
5048         pSubq->pWhere = sqlite3ExprAnd(pParse, pSubq->pWhere, pNew);
5049       }
5050       pSubq = pSubq->pPrior;
5051     }
5052   }
5053   return nChng;
5054 }
5055 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
5056 
5057 /*
5058 ** The pFunc is the only aggregate function in the query.  Check to see
5059 ** if the query is a candidate for the min/max optimization.
5060 **
5061 ** If the query is a candidate for the min/max optimization, then set
5062 ** *ppMinMax to be an ORDER BY clause to be used for the optimization
5063 ** and return either WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX depending on
5064 ** whether pFunc is a min() or max() function.
5065 **
5066 ** If the query is not a candidate for the min/max optimization, return
5067 ** WHERE_ORDERBY_NORMAL (which must be zero).
5068 **
5069 ** This routine must be called after aggregate functions have been
5070 ** located but before their arguments have been subjected to aggregate
5071 ** analysis.
5072 */
5073 static u8 minMaxQuery(sqlite3 *db, Expr *pFunc, ExprList **ppMinMax){
5074   int eRet = WHERE_ORDERBY_NORMAL;      /* Return value */
5075   ExprList *pEList;                     /* Arguments to agg function */
5076   const char *zFunc;                    /* Name of aggregate function pFunc */
5077   ExprList *pOrderBy;
5078   u8 sortFlags = 0;
5079 
5080   assert( *ppMinMax==0 );
5081   assert( pFunc->op==TK_AGG_FUNCTION );
5082   assert( !IsWindowFunc(pFunc) );
5083   assert( ExprUseXList(pFunc) );
5084   pEList = pFunc->x.pList;
5085   if( pEList==0
5086    || pEList->nExpr!=1
5087    || ExprHasProperty(pFunc, EP_WinFunc)
5088    || OptimizationDisabled(db, SQLITE_MinMaxOpt)
5089   ){
5090     return eRet;
5091   }
5092   assert( !ExprHasProperty(pFunc, EP_IntValue) );
5093   zFunc = pFunc->u.zToken;
5094   if( sqlite3StrICmp(zFunc, "min")==0 ){
5095     eRet = WHERE_ORDERBY_MIN;
5096     if( sqlite3ExprCanBeNull(pEList->a[0].pExpr) ){
5097       sortFlags = KEYINFO_ORDER_BIGNULL;
5098     }
5099   }else if( sqlite3StrICmp(zFunc, "max")==0 ){
5100     eRet = WHERE_ORDERBY_MAX;
5101     sortFlags = KEYINFO_ORDER_DESC;
5102   }else{
5103     return eRet;
5104   }
5105   *ppMinMax = pOrderBy = sqlite3ExprListDup(db, pEList, 0);
5106   assert( pOrderBy!=0 || db->mallocFailed );
5107   if( pOrderBy ) pOrderBy->a[0].fg.sortFlags = sortFlags;
5108   return eRet;
5109 }
5110 
5111 /*
5112 ** The select statement passed as the first argument is an aggregate query.
5113 ** The second argument is the associated aggregate-info object. This
5114 ** function tests if the SELECT is of the form:
5115 **
5116 **   SELECT count(*) FROM <tbl>
5117 **
5118 ** where table is a database table, not a sub-select or view. If the query
5119 ** does match this pattern, then a pointer to the Table object representing
5120 ** <tbl> is returned. Otherwise, NULL is returned.
5121 **
5122 ** This routine checks to see if it is safe to use the count optimization.
5123 ** A correct answer is still obtained (though perhaps more slowly) if
5124 ** this routine returns NULL when it could have returned a table pointer.
5125 ** But returning the pointer when NULL should have been returned can
5126 ** result in incorrect answers and/or crashes.  So, when in doubt, return NULL.
5127 */
5128 static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
5129   Table *pTab;
5130   Expr *pExpr;
5131 
5132   assert( !p->pGroupBy );
5133 
5134   if( p->pWhere
5135    || p->pEList->nExpr!=1
5136    || p->pSrc->nSrc!=1
5137    || p->pSrc->a[0].pSelect
5138    || pAggInfo->nFunc!=1
5139   ){
5140     return 0;
5141   }
5142   pTab = p->pSrc->a[0].pTab;
5143   assert( pTab!=0 );
5144   assert( !IsView(pTab) );
5145   if( !IsOrdinaryTable(pTab) ) return 0;
5146   pExpr = p->pEList->a[0].pExpr;
5147   assert( pExpr!=0 );
5148   if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
5149   if( pExpr->pAggInfo!=pAggInfo ) return 0;
5150   if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
5151   assert( pAggInfo->aFunc[0].pFExpr==pExpr );
5152   testcase( ExprHasProperty(pExpr, EP_Distinct) );
5153   testcase( ExprHasProperty(pExpr, EP_WinFunc) );
5154   if( ExprHasProperty(pExpr, EP_Distinct|EP_WinFunc) ) return 0;
5155 
5156   return pTab;
5157 }
5158 
5159 /*
5160 ** If the source-list item passed as an argument was augmented with an
5161 ** INDEXED BY clause, then try to locate the specified index. If there
5162 ** was such a clause and the named index cannot be found, return
5163 ** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
5164 ** pFrom->pIndex and return SQLITE_OK.
5165 */
5166 int sqlite3IndexedByLookup(Parse *pParse, SrcItem *pFrom){
5167   Table *pTab = pFrom->pTab;
5168   char *zIndexedBy = pFrom->u1.zIndexedBy;
5169   Index *pIdx;
5170   assert( pTab!=0 );
5171   assert( pFrom->fg.isIndexedBy!=0 );
5172 
5173   for(pIdx=pTab->pIndex;
5174       pIdx && sqlite3StrICmp(pIdx->zName, zIndexedBy);
5175       pIdx=pIdx->pNext
5176   );
5177   if( !pIdx ){
5178     sqlite3ErrorMsg(pParse, "no such index: %s", zIndexedBy, 0);
5179     pParse->checkSchema = 1;
5180     return SQLITE_ERROR;
5181   }
5182   assert( pFrom->fg.isCte==0 );
5183   pFrom->u2.pIBIndex = pIdx;
5184   return SQLITE_OK;
5185 }
5186 
5187 /*
5188 ** Detect compound SELECT statements that use an ORDER BY clause with
5189 ** an alternative collating sequence.
5190 **
5191 **    SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
5192 **
5193 ** These are rewritten as a subquery:
5194 **
5195 **    SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
5196 **     ORDER BY ... COLLATE ...
5197 **
5198 ** This transformation is necessary because the multiSelectOrderBy() routine
5199 ** above that generates the code for a compound SELECT with an ORDER BY clause
5200 ** uses a merge algorithm that requires the same collating sequence on the
5201 ** result columns as on the ORDER BY clause.  See ticket
5202 ** http://www.sqlite.org/src/info/6709574d2a
5203 **
5204 ** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
5205 ** The UNION ALL operator works fine with multiSelectOrderBy() even when
5206 ** there are COLLATE terms in the ORDER BY.
5207 */
5208 static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
5209   int i;
5210   Select *pNew;
5211   Select *pX;
5212   sqlite3 *db;
5213   struct ExprList_item *a;
5214   SrcList *pNewSrc;
5215   Parse *pParse;
5216   Token dummy;
5217 
5218   if( p->pPrior==0 ) return WRC_Continue;
5219   if( p->pOrderBy==0 ) return WRC_Continue;
5220   for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
5221   if( pX==0 ) return WRC_Continue;
5222   a = p->pOrderBy->a;
5223 #ifndef SQLITE_OMIT_WINDOWFUNC
5224   /* If iOrderByCol is already non-zero, then it has already been matched
5225   ** to a result column of the SELECT statement. This occurs when the
5226   ** SELECT is rewritten for window-functions processing and then passed
5227   ** to sqlite3SelectPrep() and similar a second time. The rewriting done
5228   ** by this function is not required in this case. */
5229   if( a[0].u.x.iOrderByCol ) return WRC_Continue;
5230 #endif
5231   for(i=p->pOrderBy->nExpr-1; i>=0; i--){
5232     if( a[i].pExpr->flags & EP_Collate ) break;
5233   }
5234   if( i<0 ) return WRC_Continue;
5235 
5236   /* If we reach this point, that means the transformation is required. */
5237 
5238   pParse = pWalker->pParse;
5239   db = pParse->db;
5240   pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
5241   if( pNew==0 ) return WRC_Abort;
5242   memset(&dummy, 0, sizeof(dummy));
5243   pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0);
5244   if( pNewSrc==0 ) return WRC_Abort;
5245   *pNew = *p;
5246   p->pSrc = pNewSrc;
5247   p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ASTERISK, 0));
5248   p->op = TK_SELECT;
5249   p->pWhere = 0;
5250   pNew->pGroupBy = 0;
5251   pNew->pHaving = 0;
5252   pNew->pOrderBy = 0;
5253   p->pPrior = 0;
5254   p->pNext = 0;
5255   p->pWith = 0;
5256 #ifndef SQLITE_OMIT_WINDOWFUNC
5257   p->pWinDefn = 0;
5258 #endif
5259   p->selFlags &= ~SF_Compound;
5260   assert( (p->selFlags & SF_Converted)==0 );
5261   p->selFlags |= SF_Converted;
5262   assert( pNew->pPrior!=0 );
5263   pNew->pPrior->pNext = pNew;
5264   pNew->pLimit = 0;
5265   return WRC_Continue;
5266 }
5267 
5268 /*
5269 ** Check to see if the FROM clause term pFrom has table-valued function
5270 ** arguments.  If it does, leave an error message in pParse and return
5271 ** non-zero, since pFrom is not allowed to be a table-valued function.
5272 */
5273 static int cannotBeFunction(Parse *pParse, SrcItem *pFrom){
5274   if( pFrom->fg.isTabFunc ){
5275     sqlite3ErrorMsg(pParse, "'%s' is not a function", pFrom->zName);
5276     return 1;
5277   }
5278   return 0;
5279 }
5280 
5281 #ifndef SQLITE_OMIT_CTE
5282 /*
5283 ** Argument pWith (which may be NULL) points to a linked list of nested
5284 ** WITH contexts, from inner to outermost. If the table identified by
5285 ** FROM clause element pItem is really a common-table-expression (CTE)
5286 ** then return a pointer to the CTE definition for that table. Otherwise
5287 ** return NULL.
5288 **
5289 ** If a non-NULL value is returned, set *ppContext to point to the With
5290 ** object that the returned CTE belongs to.
5291 */
5292 static struct Cte *searchWith(
5293   With *pWith,                    /* Current innermost WITH clause */
5294   SrcItem *pItem,                 /* FROM clause element to resolve */
5295   With **ppContext                /* OUT: WITH clause return value belongs to */
5296 ){
5297   const char *zName = pItem->zName;
5298   With *p;
5299   assert( pItem->zDatabase==0 );
5300   assert( zName!=0 );
5301   for(p=pWith; p; p=p->pOuter){
5302     int i;
5303     for(i=0; i<p->nCte; i++){
5304       if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
5305         *ppContext = p;
5306         return &p->a[i];
5307       }
5308     }
5309     if( p->bView ) break;
5310   }
5311   return 0;
5312 }
5313 
5314 /* The code generator maintains a stack of active WITH clauses
5315 ** with the inner-most WITH clause being at the top of the stack.
5316 **
5317 ** This routine pushes the WITH clause passed as the second argument
5318 ** onto the top of the stack. If argument bFree is true, then this
5319 ** WITH clause will never be popped from the stack but should instead
5320 ** be freed along with the Parse object. In other cases, when
5321 ** bFree==0, the With object will be freed along with the SELECT
5322 ** statement with which it is associated.
5323 **
5324 ** This routine returns a copy of pWith.  Or, if bFree is true and
5325 ** the pWith object is destroyed immediately due to an OOM condition,
5326 ** then this routine return NULL.
5327 **
5328 ** If bFree is true, do not continue to use the pWith pointer after
5329 ** calling this routine,  Instead, use only the return value.
5330 */
5331 With *sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
5332   if( pWith ){
5333     if( bFree ){
5334       pWith = (With*)sqlite3ParserAddCleanup(pParse,
5335                       (void(*)(sqlite3*,void*))sqlite3WithDelete,
5336                       pWith);
5337       if( pWith==0 ) return 0;
5338     }
5339     if( pParse->nErr==0 ){
5340       assert( pParse->pWith!=pWith );
5341       pWith->pOuter = pParse->pWith;
5342       pParse->pWith = pWith;
5343     }
5344   }
5345   return pWith;
5346 }
5347 
5348 /*
5349 ** This function checks if argument pFrom refers to a CTE declared by
5350 ** a WITH clause on the stack currently maintained by the parser (on the
5351 ** pParse->pWith linked list).  And if currently processing a CTE
5352 ** CTE expression, through routine checks to see if the reference is
5353 ** a recursive reference to the CTE.
5354 **
5355 ** If pFrom matches a CTE according to either of these two above, pFrom->pTab
5356 ** and other fields are populated accordingly.
5357 **
5358 ** Return 0 if no match is found.
5359 ** Return 1 if a match is found.
5360 ** Return 2 if an error condition is detected.
5361 */
5362 static int resolveFromTermToCte(
5363   Parse *pParse,                  /* The parsing context */
5364   Walker *pWalker,                /* Current tree walker */
5365   SrcItem *pFrom                  /* The FROM clause term to check */
5366 ){
5367   Cte *pCte;               /* Matched CTE (or NULL if no match) */
5368   With *pWith;             /* The matching WITH */
5369 
5370   assert( pFrom->pTab==0 );
5371   if( pParse->pWith==0 ){
5372     /* There are no WITH clauses in the stack.  No match is possible */
5373     return 0;
5374   }
5375   if( pParse->nErr ){
5376     /* Prior errors might have left pParse->pWith in a goofy state, so
5377     ** go no further. */
5378     return 0;
5379   }
5380   if( pFrom->zDatabase!=0 ){
5381     /* The FROM term contains a schema qualifier (ex: main.t1) and so
5382     ** it cannot possibly be a CTE reference. */
5383     return 0;
5384   }
5385   if( pFrom->fg.notCte ){
5386     /* The FROM term is specifically excluded from matching a CTE.
5387     **   (1)  It is part of a trigger that used to have zDatabase but had
5388     **        zDatabase removed by sqlite3FixTriggerStep().
5389     **   (2)  This is the first term in the FROM clause of an UPDATE.
5390     */
5391     return 0;
5392   }
5393   pCte = searchWith(pParse->pWith, pFrom, &pWith);
5394   if( pCte ){
5395     sqlite3 *db = pParse->db;
5396     Table *pTab;
5397     ExprList *pEList;
5398     Select *pSel;
5399     Select *pLeft;                /* Left-most SELECT statement */
5400     Select *pRecTerm;             /* Left-most recursive term */
5401     int bMayRecursive;            /* True if compound joined by UNION [ALL] */
5402     With *pSavedWith;             /* Initial value of pParse->pWith */
5403     int iRecTab = -1;             /* Cursor for recursive table */
5404     CteUse *pCteUse;
5405 
5406     /* If pCte->zCteErr is non-NULL at this point, then this is an illegal
5407     ** recursive reference to CTE pCte. Leave an error in pParse and return
5408     ** early. If pCte->zCteErr is NULL, then this is not a recursive reference.
5409     ** In this case, proceed.  */
5410     if( pCte->zCteErr ){
5411       sqlite3ErrorMsg(pParse, pCte->zCteErr, pCte->zName);
5412       return 2;
5413     }
5414     if( cannotBeFunction(pParse, pFrom) ) return 2;
5415 
5416     assert( pFrom->pTab==0 );
5417     pTab = sqlite3DbMallocZero(db, sizeof(Table));
5418     if( pTab==0 ) return 2;
5419     pCteUse = pCte->pUse;
5420     if( pCteUse==0 ){
5421       pCte->pUse = pCteUse = sqlite3DbMallocZero(db, sizeof(pCteUse[0]));
5422       if( pCteUse==0
5423        || sqlite3ParserAddCleanup(pParse,sqlite3DbFree,pCteUse)==0
5424       ){
5425         sqlite3DbFree(db, pTab);
5426         return 2;
5427       }
5428       pCteUse->eM10d = pCte->eM10d;
5429     }
5430     pFrom->pTab = pTab;
5431     pTab->nTabRef = 1;
5432     pTab->zName = sqlite3DbStrDup(db, pCte->zName);
5433     pTab->iPKey = -1;
5434     pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
5435     pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
5436     pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
5437     if( db->mallocFailed ) return 2;
5438     pFrom->pSelect->selFlags |= SF_CopyCte;
5439     assert( pFrom->pSelect );
5440     if( pFrom->fg.isIndexedBy ){
5441       sqlite3ErrorMsg(pParse, "no such index: \"%s\"", pFrom->u1.zIndexedBy);
5442       return 2;
5443     }
5444     pFrom->fg.isCte = 1;
5445     pFrom->u2.pCteUse = pCteUse;
5446     pCteUse->nUse++;
5447     if( pCteUse->nUse>=2 && pCteUse->eM10d==M10d_Any ){
5448       pCteUse->eM10d = M10d_Yes;
5449     }
5450 
5451     /* Check if this is a recursive CTE. */
5452     pRecTerm = pSel = pFrom->pSelect;
5453     bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
5454     while( bMayRecursive && pRecTerm->op==pSel->op ){
5455       int i;
5456       SrcList *pSrc = pRecTerm->pSrc;
5457       assert( pRecTerm->pPrior!=0 );
5458       for(i=0; i<pSrc->nSrc; i++){
5459         SrcItem *pItem = &pSrc->a[i];
5460         if( pItem->zDatabase==0
5461          && pItem->zName!=0
5462          && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
5463         ){
5464           pItem->pTab = pTab;
5465           pTab->nTabRef++;
5466           pItem->fg.isRecursive = 1;
5467           if( pRecTerm->selFlags & SF_Recursive ){
5468             sqlite3ErrorMsg(pParse,
5469                "multiple references to recursive table: %s", pCte->zName
5470             );
5471             return 2;
5472           }
5473           pRecTerm->selFlags |= SF_Recursive;
5474           if( iRecTab<0 ) iRecTab = pParse->nTab++;
5475           pItem->iCursor = iRecTab;
5476         }
5477       }
5478       if( (pRecTerm->selFlags & SF_Recursive)==0 ) break;
5479       pRecTerm = pRecTerm->pPrior;
5480     }
5481 
5482     pCte->zCteErr = "circular reference: %s";
5483     pSavedWith = pParse->pWith;
5484     pParse->pWith = pWith;
5485     if( pSel->selFlags & SF_Recursive ){
5486       int rc;
5487       assert( pRecTerm!=0 );
5488       assert( (pRecTerm->selFlags & SF_Recursive)==0 );
5489       assert( pRecTerm->pNext!=0 );
5490       assert( (pRecTerm->pNext->selFlags & SF_Recursive)!=0 );
5491       assert( pRecTerm->pWith==0 );
5492       pRecTerm->pWith = pSel->pWith;
5493       rc = sqlite3WalkSelect(pWalker, pRecTerm);
5494       pRecTerm->pWith = 0;
5495       if( rc ){
5496         pParse->pWith = pSavedWith;
5497         return 2;
5498       }
5499     }else{
5500       if( sqlite3WalkSelect(pWalker, pSel) ){
5501         pParse->pWith = pSavedWith;
5502         return 2;
5503       }
5504     }
5505     pParse->pWith = pWith;
5506 
5507     for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
5508     pEList = pLeft->pEList;
5509     if( pCte->pCols ){
5510       if( pEList && pEList->nExpr!=pCte->pCols->nExpr ){
5511         sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
5512             pCte->zName, pEList->nExpr, pCte->pCols->nExpr
5513         );
5514         pParse->pWith = pSavedWith;
5515         return 2;
5516       }
5517       pEList = pCte->pCols;
5518     }
5519 
5520     sqlite3ColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
5521     if( bMayRecursive ){
5522       if( pSel->selFlags & SF_Recursive ){
5523         pCte->zCteErr = "multiple recursive references: %s";
5524       }else{
5525         pCte->zCteErr = "recursive reference in a subquery: %s";
5526       }
5527       sqlite3WalkSelect(pWalker, pSel);
5528     }
5529     pCte->zCteErr = 0;
5530     pParse->pWith = pSavedWith;
5531     return 1;  /* Success */
5532   }
5533   return 0;  /* No match */
5534 }
5535 #endif
5536 
5537 #ifndef SQLITE_OMIT_CTE
5538 /*
5539 ** If the SELECT passed as the second argument has an associated WITH
5540 ** clause, pop it from the stack stored as part of the Parse object.
5541 **
5542 ** This function is used as the xSelectCallback2() callback by
5543 ** sqlite3SelectExpand() when walking a SELECT tree to resolve table
5544 ** names and other FROM clause elements.
5545 */
5546 void sqlite3SelectPopWith(Walker *pWalker, Select *p){
5547   Parse *pParse = pWalker->pParse;
5548   if( OK_IF_ALWAYS_TRUE(pParse->pWith) && p->pPrior==0 ){
5549     With *pWith = findRightmost(p)->pWith;
5550     if( pWith!=0 ){
5551       assert( pParse->pWith==pWith || pParse->nErr );
5552       pParse->pWith = pWith->pOuter;
5553     }
5554   }
5555 }
5556 #endif
5557 
5558 /*
5559 ** The SrcList_item structure passed as the second argument represents a
5560 ** sub-query in the FROM clause of a SELECT statement. This function
5561 ** allocates and populates the SrcList_item.pTab object. If successful,
5562 ** SQLITE_OK is returned. Otherwise, if an OOM error is encountered,
5563 ** SQLITE_NOMEM.
5564 */
5565 int sqlite3ExpandSubquery(Parse *pParse, SrcItem *pFrom){
5566   Select *pSel = pFrom->pSelect;
5567   Table *pTab;
5568 
5569   assert( pSel );
5570   pFrom->pTab = pTab = sqlite3DbMallocZero(pParse->db, sizeof(Table));
5571   if( pTab==0 ) return SQLITE_NOMEM;
5572   pTab->nTabRef = 1;
5573   if( pFrom->zAlias ){
5574     pTab->zName = sqlite3DbStrDup(pParse->db, pFrom->zAlias);
5575   }else{
5576     pTab->zName = sqlite3MPrintf(pParse->db, "%!S", pFrom);
5577   }
5578   while( pSel->pPrior ){ pSel = pSel->pPrior; }
5579   sqlite3ColumnsFromExprList(pParse, pSel->pEList,&pTab->nCol,&pTab->aCol);
5580   pTab->iPKey = -1;
5581   pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
5582 #ifndef SQLITE_ALLOW_ROWID_IN_VIEW
5583   /* The usual case - do not allow ROWID on a subquery */
5584   pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
5585 #else
5586   pTab->tabFlags |= TF_Ephemeral;  /* Legacy compatibility mode */
5587 #endif
5588   return pParse->nErr ? SQLITE_ERROR : SQLITE_OK;
5589 }
5590 
5591 
5592 /*
5593 ** Check the N SrcItem objects to the right of pBase.  (N might be zero!)
5594 ** If any of those SrcItem objects have a USING clause containing zName
5595 ** then return true.
5596 **
5597 ** If N is zero, or none of the N SrcItem objects to the right of pBase
5598 ** contains a USING clause, or if none of the USING clauses contain zName,
5599 ** then return false.
5600 */
5601 static int inAnyUsingClause(
5602   const char *zName, /* Name we are looking for */
5603   SrcItem *pBase,    /* The base SrcItem.  Looking at pBase[1] and following */
5604   int N              /* How many SrcItems to check */
5605 ){
5606   while( N>0 ){
5607     N--;
5608     pBase++;
5609     if( pBase->fg.isUsing==0 ) continue;
5610     if( NEVER(pBase->u3.pUsing==0) ) continue;
5611     if( sqlite3IdListIndex(pBase->u3.pUsing, zName)>=0 ) return 1;
5612   }
5613   return 0;
5614 }
5615 
5616 
5617 /*
5618 ** This routine is a Walker callback for "expanding" a SELECT statement.
5619 ** "Expanding" means to do the following:
5620 **
5621 **    (1)  Make sure VDBE cursor numbers have been assigned to every
5622 **         element of the FROM clause.
5623 **
5624 **    (2)  Fill in the pTabList->a[].pTab fields in the SrcList that
5625 **         defines FROM clause.  When views appear in the FROM clause,
5626 **         fill pTabList->a[].pSelect with a copy of the SELECT statement
5627 **         that implements the view.  A copy is made of the view's SELECT
5628 **         statement so that we can freely modify or delete that statement
5629 **         without worrying about messing up the persistent representation
5630 **         of the view.
5631 **
5632 **    (3)  Add terms to the WHERE clause to accommodate the NATURAL keyword
5633 **         on joins and the ON and USING clause of joins.
5634 **
5635 **    (4)  Scan the list of columns in the result set (pEList) looking
5636 **         for instances of the "*" operator or the TABLE.* operator.
5637 **         If found, expand each "*" to be every column in every table
5638 **         and TABLE.* to be every column in TABLE.
5639 **
5640 */
5641 static int selectExpander(Walker *pWalker, Select *p){
5642   Parse *pParse = pWalker->pParse;
5643   int i, j, k, rc;
5644   SrcList *pTabList;
5645   ExprList *pEList;
5646   SrcItem *pFrom;
5647   sqlite3 *db = pParse->db;
5648   Expr *pE, *pRight, *pExpr;
5649   u16 selFlags = p->selFlags;
5650   u32 elistFlags = 0;
5651 
5652   p->selFlags |= SF_Expanded;
5653   if( db->mallocFailed  ){
5654     return WRC_Abort;
5655   }
5656   assert( p->pSrc!=0 );
5657   if( (selFlags & SF_Expanded)!=0 ){
5658     return WRC_Prune;
5659   }
5660   if( pWalker->eCode ){
5661     /* Renumber selId because it has been copied from a view */
5662     p->selId = ++pParse->nSelect;
5663   }
5664   pTabList = p->pSrc;
5665   pEList = p->pEList;
5666   if( pParse->pWith && (p->selFlags & SF_View) ){
5667     if( p->pWith==0 ){
5668       p->pWith = (With*)sqlite3DbMallocZero(db, sizeof(With));
5669       if( p->pWith==0 ){
5670         return WRC_Abort;
5671       }
5672     }
5673     p->pWith->bView = 1;
5674   }
5675   sqlite3WithPush(pParse, p->pWith, 0);
5676 
5677   /* Make sure cursor numbers have been assigned to all entries in
5678   ** the FROM clause of the SELECT statement.
5679   */
5680   sqlite3SrcListAssignCursors(pParse, pTabList);
5681 
5682   /* Look up every table named in the FROM clause of the select.  If
5683   ** an entry of the FROM clause is a subquery instead of a table or view,
5684   ** then create a transient table structure to describe the subquery.
5685   */
5686   for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5687     Table *pTab;
5688     assert( pFrom->fg.isRecursive==0 || pFrom->pTab!=0 );
5689     if( pFrom->pTab ) continue;
5690     assert( pFrom->fg.isRecursive==0 );
5691     if( pFrom->zName==0 ){
5692 #ifndef SQLITE_OMIT_SUBQUERY
5693       Select *pSel = pFrom->pSelect;
5694       /* A sub-query in the FROM clause of a SELECT */
5695       assert( pSel!=0 );
5696       assert( pFrom->pTab==0 );
5697       if( sqlite3WalkSelect(pWalker, pSel) ) return WRC_Abort;
5698       if( sqlite3ExpandSubquery(pParse, pFrom) ) return WRC_Abort;
5699 #endif
5700 #ifndef SQLITE_OMIT_CTE
5701     }else if( (rc = resolveFromTermToCte(pParse, pWalker, pFrom))!=0 ){
5702       if( rc>1 ) return WRC_Abort;
5703       pTab = pFrom->pTab;
5704       assert( pTab!=0 );
5705 #endif
5706     }else{
5707       /* An ordinary table or view name in the FROM clause */
5708       assert( pFrom->pTab==0 );
5709       pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
5710       if( pTab==0 ) return WRC_Abort;
5711       if( pTab->nTabRef>=0xffff ){
5712         sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
5713            pTab->zName);
5714         pFrom->pTab = 0;
5715         return WRC_Abort;
5716       }
5717       pTab->nTabRef++;
5718       if( !IsVirtual(pTab) && cannotBeFunction(pParse, pFrom) ){
5719         return WRC_Abort;
5720       }
5721 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
5722       if( !IsOrdinaryTable(pTab) ){
5723         i16 nCol;
5724         u8 eCodeOrig = pWalker->eCode;
5725         if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
5726         assert( pFrom->pSelect==0 );
5727         if( IsView(pTab) ){
5728           if( (db->flags & SQLITE_EnableView)==0
5729            && pTab->pSchema!=db->aDb[1].pSchema
5730           ){
5731             sqlite3ErrorMsg(pParse, "access to view \"%s\" prohibited",
5732               pTab->zName);
5733           }
5734           pFrom->pSelect = sqlite3SelectDup(db, pTab->u.view.pSelect, 0);
5735         }
5736 #ifndef SQLITE_OMIT_VIRTUALTABLE
5737         else if( ALWAYS(IsVirtual(pTab))
5738          && pFrom->fg.fromDDL
5739          && ALWAYS(pTab->u.vtab.p!=0)
5740          && pTab->u.vtab.p->eVtabRisk > ((db->flags & SQLITE_TrustedSchema)!=0)
5741         ){
5742           sqlite3ErrorMsg(pParse, "unsafe use of virtual table \"%s\"",
5743                                   pTab->zName);
5744         }
5745         assert( SQLITE_VTABRISK_Normal==1 && SQLITE_VTABRISK_High==2 );
5746 #endif
5747         nCol = pTab->nCol;
5748         pTab->nCol = -1;
5749         pWalker->eCode = 1;  /* Turn on Select.selId renumbering */
5750         sqlite3WalkSelect(pWalker, pFrom->pSelect);
5751         pWalker->eCode = eCodeOrig;
5752         pTab->nCol = nCol;
5753       }
5754 #endif
5755     }
5756 
5757     /* Locate the index named by the INDEXED BY clause, if any. */
5758     if( pFrom->fg.isIndexedBy && sqlite3IndexedByLookup(pParse, pFrom) ){
5759       return WRC_Abort;
5760     }
5761   }
5762 
5763   /* Process NATURAL keywords, and ON and USING clauses of joins.
5764   */
5765   assert( db->mallocFailed==0 || pParse->nErr!=0 );
5766   if( pParse->nErr || sqlite3ProcessJoin(pParse, p) ){
5767     return WRC_Abort;
5768   }
5769 
5770   /* For every "*" that occurs in the column list, insert the names of
5771   ** all columns in all tables.  And for every TABLE.* insert the names
5772   ** of all columns in TABLE.  The parser inserted a special expression
5773   ** with the TK_ASTERISK operator for each "*" that it found in the column
5774   ** list.  The following code just has to locate the TK_ASTERISK
5775   ** expressions and expand each one to the list of all columns in
5776   ** all tables.
5777   **
5778   ** The first loop just checks to see if there are any "*" operators
5779   ** that need expanding.
5780   */
5781   for(k=0; k<pEList->nExpr; k++){
5782     pE = pEList->a[k].pExpr;
5783     if( pE->op==TK_ASTERISK ) break;
5784     assert( pE->op!=TK_DOT || pE->pRight!=0 );
5785     assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
5786     if( pE->op==TK_DOT && pE->pRight->op==TK_ASTERISK ) break;
5787     elistFlags |= pE->flags;
5788   }
5789   if( k<pEList->nExpr ){
5790     /*
5791     ** If we get here it means the result set contains one or more "*"
5792     ** operators that need to be expanded.  Loop through each expression
5793     ** in the result set and expand them one by one.
5794     */
5795     struct ExprList_item *a = pEList->a;
5796     ExprList *pNew = 0;
5797     int flags = pParse->db->flags;
5798     int longNames = (flags & SQLITE_FullColNames)!=0
5799                       && (flags & SQLITE_ShortColNames)==0;
5800 
5801     for(k=0; k<pEList->nExpr; k++){
5802       pE = a[k].pExpr;
5803       elistFlags |= pE->flags;
5804       pRight = pE->pRight;
5805       assert( pE->op!=TK_DOT || pRight!=0 );
5806       if( pE->op!=TK_ASTERISK
5807        && (pE->op!=TK_DOT || pRight->op!=TK_ASTERISK)
5808       ){
5809         /* This particular expression does not need to be expanded.
5810         */
5811         pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
5812         if( pNew ){
5813           pNew->a[pNew->nExpr-1].zEName = a[k].zEName;
5814           pNew->a[pNew->nExpr-1].fg.eEName = a[k].fg.eEName;
5815           a[k].zEName = 0;
5816         }
5817         a[k].pExpr = 0;
5818       }else{
5819         /* This expression is a "*" or a "TABLE.*" and needs to be
5820         ** expanded. */
5821         int tableSeen = 0;      /* Set to 1 when TABLE matches */
5822         char *zTName = 0;       /* text of name of TABLE */
5823         if( pE->op==TK_DOT ){
5824           assert( pE->pLeft!=0 );
5825           assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
5826           zTName = pE->pLeft->u.zToken;
5827         }
5828         for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5829           Table *pTab = pFrom->pTab;   /* Table for this data source */
5830           ExprList *pNestedFrom;       /* Result-set of a nested FROM clause */
5831           char *zTabName;              /* AS name for this data source */
5832           const char *zSchemaName = 0; /* Schema name for this data source */
5833           int iDb;                     /* Schema index for this data src */
5834           IdList *pUsing;              /* USING clause for pFrom[1] */
5835 
5836           if( (zTabName = pFrom->zAlias)==0 ){
5837             zTabName = pTab->zName;
5838           }
5839           if( db->mallocFailed ) break;
5840           assert( pFrom->fg.isNestedFrom == IsNestedFrom(pFrom->pSelect) );
5841           if( pFrom->fg.isNestedFrom ){
5842             assert( pFrom->pSelect!=0 );
5843             pNestedFrom = pFrom->pSelect->pEList;
5844             assert( pNestedFrom!=0 );
5845             assert( pNestedFrom->nExpr==pTab->nCol );
5846           }else{
5847             if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
5848               continue;
5849             }
5850             pNestedFrom = 0;
5851             iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
5852             zSchemaName = iDb>=0 ? db->aDb[iDb].zDbSName : "*";
5853           }
5854           if( i+1<pTabList->nSrc
5855            && pFrom[1].fg.isUsing
5856            && (selFlags & SF_NestedFrom)!=0
5857           ){
5858             int ii;
5859             pUsing = pFrom[1].u3.pUsing;
5860             for(ii=0; ii<pUsing->nId; ii++){
5861               const char *zUName = pUsing->a[ii].zName;
5862               pRight = sqlite3Expr(db, TK_ID, zUName);
5863               pNew = sqlite3ExprListAppend(pParse, pNew, pRight);
5864               if( pNew ){
5865                 struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
5866                 assert( pX->zEName==0 );
5867                 pX->zEName = sqlite3MPrintf(db,"..%s", zUName);
5868                 pX->fg.eEName = ENAME_TAB;
5869                 pX->fg.bUsingTerm = 1;
5870               }
5871             }
5872           }else{
5873             pUsing = 0;
5874           }
5875           for(j=0; j<pTab->nCol; j++){
5876             char *zName = pTab->aCol[j].zCnName;
5877             struct ExprList_item *pX; /* Newly added ExprList term */
5878 
5879             assert( zName );
5880             if( zTName
5881              && pNestedFrom
5882              && sqlite3MatchEName(&pNestedFrom->a[j], 0, zTName, 0)==0
5883             ){
5884               continue;
5885             }
5886 
5887             /* If a column is marked as 'hidden', omit it from the expanded
5888             ** result-set list unless the SELECT has the SF_IncludeHidden
5889             ** bit set.
5890             */
5891             if( (p->selFlags & SF_IncludeHidden)==0
5892              && IsHiddenColumn(&pTab->aCol[j])
5893             ){
5894               continue;
5895             }
5896             if( (pTab->aCol[j].colFlags & COLFLAG_NOEXPAND)!=0
5897              && zTName==0
5898              && (selFlags & (SF_NestedFrom))==0
5899             ){
5900               continue;
5901             }
5902             tableSeen = 1;
5903 
5904             if( i>0 && zTName==0 && (selFlags & SF_NestedFrom)==0 ){
5905               if( pFrom->fg.isUsing
5906                && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0
5907               ){
5908                 /* In a join with a USING clause, omit columns in the
5909                 ** using clause from the table on the right. */
5910                 continue;
5911               }
5912             }
5913             pRight = sqlite3Expr(db, TK_ID, zName);
5914             if( (pTabList->nSrc>1
5915                  && (  (pFrom->fg.jointype & JT_LTORJ)==0
5916                      || (selFlags & SF_NestedFrom)!=0
5917                      || !inAnyUsingClause(zName,pFrom,pTabList->nSrc-i-1)
5918                     )
5919                 )
5920              || IN_RENAME_OBJECT
5921             ){
5922               Expr *pLeft;
5923               pLeft = sqlite3Expr(db, TK_ID, zTabName);
5924               pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight);
5925               if( IN_RENAME_OBJECT && pE->pLeft ){
5926                 sqlite3RenameTokenRemap(pParse, pLeft, pE->pLeft);
5927               }
5928               if( zSchemaName ){
5929                 pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
5930                 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr);
5931               }
5932             }else{
5933               pExpr = pRight;
5934             }
5935             pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
5936             if( pNew==0 ){
5937               break;  /* OOM */
5938             }
5939             pX = &pNew->a[pNew->nExpr-1];
5940             assert( pX->zEName==0 );
5941             if( (selFlags & SF_NestedFrom)!=0 && !IN_RENAME_OBJECT ){
5942               if( pNestedFrom ){
5943                 pX->zEName = sqlite3DbStrDup(db, pNestedFrom->a[j].zEName);
5944                 testcase( pX->zEName==0 );
5945               }else{
5946                 pX->zEName = sqlite3MPrintf(db, "%s.%s.%s",
5947                                            zSchemaName, zTabName, zName);
5948                 testcase( pX->zEName==0 );
5949               }
5950               pX->fg.eEName = ENAME_TAB;
5951               if( (pFrom->fg.isUsing
5952                    && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0)
5953                || (pUsing && sqlite3IdListIndex(pUsing, zName)>=0)
5954                || (pTab->aCol[j].colFlags & COLFLAG_NOEXPAND)!=0
5955               ){
5956                 pX->fg.bNoExpand = 1;
5957               }
5958             }else if( longNames ){
5959               pX->zEName = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
5960               pX->fg.eEName = ENAME_NAME;
5961             }else{
5962               pX->zEName = sqlite3DbStrDup(db, zName);
5963               pX->fg.eEName = ENAME_NAME;
5964             }
5965           }
5966         }
5967         if( !tableSeen ){
5968           if( zTName ){
5969             sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
5970           }else{
5971             sqlite3ErrorMsg(pParse, "no tables specified");
5972           }
5973         }
5974       }
5975     }
5976     sqlite3ExprListDelete(db, pEList);
5977     p->pEList = pNew;
5978   }
5979   if( p->pEList ){
5980     if( p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
5981       sqlite3ErrorMsg(pParse, "too many columns in result set");
5982       return WRC_Abort;
5983     }
5984     if( (elistFlags & (EP_HasFunc|EP_Subquery))!=0 ){
5985       p->selFlags |= SF_ComplexResult;
5986     }
5987   }
5988 #if TREETRACE_ENABLED
5989   if( sqlite3TreeTrace & 0x100 ){
5990     SELECTTRACE(0x100,pParse,p,("After result-set wildcard expansion:\n"));
5991     sqlite3TreeViewSelect(0, p, 0);
5992   }
5993 #endif
5994   return WRC_Continue;
5995 }
5996 
5997 #if SQLITE_DEBUG
5998 /*
5999 ** Always assert.  This xSelectCallback2 implementation proves that the
6000 ** xSelectCallback2 is never invoked.
6001 */
6002 void sqlite3SelectWalkAssert2(Walker *NotUsed, Select *NotUsed2){
6003   UNUSED_PARAMETER2(NotUsed, NotUsed2);
6004   assert( 0 );
6005 }
6006 #endif
6007 /*
6008 ** This routine "expands" a SELECT statement and all of its subqueries.
6009 ** For additional information on what it means to "expand" a SELECT
6010 ** statement, see the comment on the selectExpand worker callback above.
6011 **
6012 ** Expanding a SELECT statement is the first step in processing a
6013 ** SELECT statement.  The SELECT statement must be expanded before
6014 ** name resolution is performed.
6015 **
6016 ** If anything goes wrong, an error message is written into pParse.
6017 ** The calling function can detect the problem by looking at pParse->nErr
6018 ** and/or pParse->db->mallocFailed.
6019 */
6020 static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
6021   Walker w;
6022   w.xExprCallback = sqlite3ExprWalkNoop;
6023   w.pParse = pParse;
6024   if( OK_IF_ALWAYS_TRUE(pParse->hasCompound) ){
6025     w.xSelectCallback = convertCompoundSelectToSubquery;
6026     w.xSelectCallback2 = 0;
6027     sqlite3WalkSelect(&w, pSelect);
6028   }
6029   w.xSelectCallback = selectExpander;
6030   w.xSelectCallback2 = sqlite3SelectPopWith;
6031   w.eCode = 0;
6032   sqlite3WalkSelect(&w, pSelect);
6033 }
6034 
6035 
6036 #ifndef SQLITE_OMIT_SUBQUERY
6037 /*
6038 ** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
6039 ** interface.
6040 **
6041 ** For each FROM-clause subquery, add Column.zType and Column.zColl
6042 ** information to the Table structure that represents the result set
6043 ** of that subquery.
6044 **
6045 ** The Table structure that represents the result set was constructed
6046 ** by selectExpander() but the type and collation information was omitted
6047 ** at that point because identifiers had not yet been resolved.  This
6048 ** routine is called after identifier resolution.
6049 */
6050 static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
6051   Parse *pParse;
6052   int i;
6053   SrcList *pTabList;
6054   SrcItem *pFrom;
6055 
6056   assert( p->selFlags & SF_Resolved );
6057   if( p->selFlags & SF_HasTypeInfo ) return;
6058   p->selFlags |= SF_HasTypeInfo;
6059   pParse = pWalker->pParse;
6060   pTabList = p->pSrc;
6061   for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
6062     Table *pTab = pFrom->pTab;
6063     assert( pTab!=0 );
6064     if( (pTab->tabFlags & TF_Ephemeral)!=0 ){
6065       /* A sub-query in the FROM clause of a SELECT */
6066       Select *pSel = pFrom->pSelect;
6067       if( pSel ){
6068         while( pSel->pPrior ) pSel = pSel->pPrior;
6069         sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSel,
6070                                                SQLITE_AFF_NONE);
6071       }
6072     }
6073   }
6074 }
6075 #endif
6076 
6077 
6078 /*
6079 ** This routine adds datatype and collating sequence information to
6080 ** the Table structures of all FROM-clause subqueries in a
6081 ** SELECT statement.
6082 **
6083 ** Use this routine after name resolution.
6084 */
6085 static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
6086 #ifndef SQLITE_OMIT_SUBQUERY
6087   Walker w;
6088   w.xSelectCallback = sqlite3SelectWalkNoop;
6089   w.xSelectCallback2 = selectAddSubqueryTypeInfo;
6090   w.xExprCallback = sqlite3ExprWalkNoop;
6091   w.pParse = pParse;
6092   sqlite3WalkSelect(&w, pSelect);
6093 #endif
6094 }
6095 
6096 
6097 /*
6098 ** This routine sets up a SELECT statement for processing.  The
6099 ** following is accomplished:
6100 **
6101 **     *  VDBE Cursor numbers are assigned to all FROM-clause terms.
6102 **     *  Ephemeral Table objects are created for all FROM-clause subqueries.
6103 **     *  ON and USING clauses are shifted into WHERE statements
6104 **     *  Wildcards "*" and "TABLE.*" in result sets are expanded.
6105 **     *  Identifiers in expression are matched to tables.
6106 **
6107 ** This routine acts recursively on all subqueries within the SELECT.
6108 */
6109 void sqlite3SelectPrep(
6110   Parse *pParse,         /* The parser context */
6111   Select *p,             /* The SELECT statement being coded. */
6112   NameContext *pOuterNC  /* Name context for container */
6113 ){
6114   assert( p!=0 || pParse->db->mallocFailed );
6115   assert( pParse->db->pParse==pParse );
6116   if( pParse->db->mallocFailed ) return;
6117   if( p->selFlags & SF_HasTypeInfo ) return;
6118   sqlite3SelectExpand(pParse, p);
6119   if( pParse->nErr ) return;
6120   sqlite3ResolveSelectNames(pParse, p, pOuterNC);
6121   if( pParse->nErr ) return;
6122   sqlite3SelectAddTypeInfo(pParse, p);
6123 }
6124 
6125 /*
6126 ** Reset the aggregate accumulator.
6127 **
6128 ** The aggregate accumulator is a set of memory cells that hold
6129 ** intermediate results while calculating an aggregate.  This
6130 ** routine generates code that stores NULLs in all of those memory
6131 ** cells.
6132 */
6133 static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
6134   Vdbe *v = pParse->pVdbe;
6135   int i;
6136   struct AggInfo_func *pFunc;
6137   int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
6138   assert( pParse->db->pParse==pParse );
6139   assert( pParse->db->mallocFailed==0 || pParse->nErr!=0 );
6140   if( nReg==0 ) return;
6141   if( pParse->nErr ) return;
6142 #ifdef SQLITE_DEBUG
6143   /* Verify that all AggInfo registers are within the range specified by
6144   ** AggInfo.mnReg..AggInfo.mxReg */
6145   assert( nReg==pAggInfo->mxReg-pAggInfo->mnReg+1 );
6146   for(i=0; i<pAggInfo->nColumn; i++){
6147     assert( pAggInfo->aCol[i].iMem>=pAggInfo->mnReg
6148          && pAggInfo->aCol[i].iMem<=pAggInfo->mxReg );
6149   }
6150   for(i=0; i<pAggInfo->nFunc; i++){
6151     assert( pAggInfo->aFunc[i].iMem>=pAggInfo->mnReg
6152          && pAggInfo->aFunc[i].iMem<=pAggInfo->mxReg );
6153   }
6154 #endif
6155   sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->mnReg, pAggInfo->mxReg);
6156   for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
6157     if( pFunc->iDistinct>=0 ){
6158       Expr *pE = pFunc->pFExpr;
6159       assert( ExprUseXList(pE) );
6160       if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
6161         sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
6162            "argument");
6163         pFunc->iDistinct = -1;
6164       }else{
6165         KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pE->x.pList,0,0);
6166         pFunc->iDistAddr = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
6167             pFunc->iDistinct, 0, 0, (char*)pKeyInfo, P4_KEYINFO);
6168         ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s(DISTINCT)",
6169                           pFunc->pFunc->zName));
6170       }
6171     }
6172   }
6173 }
6174 
6175 /*
6176 ** Invoke the OP_AggFinalize opcode for every aggregate function
6177 ** in the AggInfo structure.
6178 */
6179 static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
6180   Vdbe *v = pParse->pVdbe;
6181   int i;
6182   struct AggInfo_func *pF;
6183   for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
6184     ExprList *pList;
6185     assert( ExprUseXList(pF->pFExpr) );
6186     pList = pF->pFExpr->x.pList;
6187     sqlite3VdbeAddOp2(v, OP_AggFinal, pF->iMem, pList ? pList->nExpr : 0);
6188     sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
6189   }
6190 }
6191 
6192 
6193 /*
6194 ** Update the accumulator memory cells for an aggregate based on
6195 ** the current cursor position.
6196 **
6197 ** If regAcc is non-zero and there are no min() or max() aggregates
6198 ** in pAggInfo, then only populate the pAggInfo->nAccumulator accumulator
6199 ** registers if register regAcc contains 0. The caller will take care
6200 ** of setting and clearing regAcc.
6201 */
6202 static void updateAccumulator(
6203   Parse *pParse,
6204   int regAcc,
6205   AggInfo *pAggInfo,
6206   int eDistinctType
6207 ){
6208   Vdbe *v = pParse->pVdbe;
6209   int i;
6210   int regHit = 0;
6211   int addrHitTest = 0;
6212   struct AggInfo_func *pF;
6213   struct AggInfo_col *pC;
6214 
6215   pAggInfo->directMode = 1;
6216   for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
6217     int nArg;
6218     int addrNext = 0;
6219     int regAgg;
6220     ExprList *pList;
6221     assert( ExprUseXList(pF->pFExpr) );
6222     assert( !IsWindowFunc(pF->pFExpr) );
6223     pList = pF->pFExpr->x.pList;
6224     if( ExprHasProperty(pF->pFExpr, EP_WinFunc) ){
6225       Expr *pFilter = pF->pFExpr->y.pWin->pFilter;
6226       if( pAggInfo->nAccumulator
6227        && (pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL)
6228        && regAcc
6229       ){
6230         /* If regAcc==0, there there exists some min() or max() function
6231         ** without a FILTER clause that will ensure the magnet registers
6232         ** are populated. */
6233         if( regHit==0 ) regHit = ++pParse->nMem;
6234         /* If this is the first row of the group (regAcc contains 0), clear the
6235         ** "magnet" register regHit so that the accumulator registers
6236         ** are populated if the FILTER clause jumps over the the
6237         ** invocation of min() or max() altogether. Or, if this is not
6238         ** the first row (regAcc contains 1), set the magnet register so that
6239         ** the accumulators are not populated unless the min()/max() is invoked
6240         ** and indicates that they should be.  */
6241         sqlite3VdbeAddOp2(v, OP_Copy, regAcc, regHit);
6242       }
6243       addrNext = sqlite3VdbeMakeLabel(pParse);
6244       sqlite3ExprIfFalse(pParse, pFilter, addrNext, SQLITE_JUMPIFNULL);
6245     }
6246     if( pList ){
6247       nArg = pList->nExpr;
6248       regAgg = sqlite3GetTempRange(pParse, nArg);
6249       sqlite3ExprCodeExprList(pParse, pList, regAgg, 0, SQLITE_ECEL_DUP);
6250     }else{
6251       nArg = 0;
6252       regAgg = 0;
6253     }
6254     if( pF->iDistinct>=0 && pList ){
6255       if( addrNext==0 ){
6256         addrNext = sqlite3VdbeMakeLabel(pParse);
6257       }
6258       pF->iDistinct = codeDistinct(pParse, eDistinctType,
6259           pF->iDistinct, addrNext, pList, regAgg);
6260     }
6261     if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
6262       CollSeq *pColl = 0;
6263       struct ExprList_item *pItem;
6264       int j;
6265       assert( pList!=0 );  /* pList!=0 if pF->pFunc has NEEDCOLL */
6266       for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
6267         pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
6268       }
6269       if( !pColl ){
6270         pColl = pParse->db->pDfltColl;
6271       }
6272       if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
6273       sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
6274     }
6275     sqlite3VdbeAddOp3(v, OP_AggStep, 0, regAgg, pF->iMem);
6276     sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
6277     sqlite3VdbeChangeP5(v, (u8)nArg);
6278     sqlite3ReleaseTempRange(pParse, regAgg, nArg);
6279     if( addrNext ){
6280       sqlite3VdbeResolveLabel(v, addrNext);
6281     }
6282   }
6283   if( regHit==0 && pAggInfo->nAccumulator ){
6284     regHit = regAcc;
6285   }
6286   if( regHit ){
6287     addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
6288   }
6289   for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
6290     sqlite3ExprCode(pParse, pC->pCExpr, pC->iMem);
6291   }
6292 
6293   pAggInfo->directMode = 0;
6294   if( addrHitTest ){
6295     sqlite3VdbeJumpHereOrPopInst(v, addrHitTest);
6296   }
6297 }
6298 
6299 /*
6300 ** Add a single OP_Explain instruction to the VDBE to explain a simple
6301 ** count(*) query ("SELECT count(*) FROM pTab").
6302 */
6303 #ifndef SQLITE_OMIT_EXPLAIN
6304 static void explainSimpleCount(
6305   Parse *pParse,                  /* Parse context */
6306   Table *pTab,                    /* Table being queried */
6307   Index *pIdx                     /* Index used to optimize scan, or NULL */
6308 ){
6309   if( pParse->explain==2 ){
6310     int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
6311     sqlite3VdbeExplain(pParse, 0, "SCAN %s%s%s",
6312         pTab->zName,
6313         bCover ? " USING COVERING INDEX " : "",
6314         bCover ? pIdx->zName : ""
6315     );
6316   }
6317 }
6318 #else
6319 # define explainSimpleCount(a,b,c)
6320 #endif
6321 
6322 /*
6323 ** sqlite3WalkExpr() callback used by havingToWhere().
6324 **
6325 ** If the node passed to the callback is a TK_AND node, return
6326 ** WRC_Continue to tell sqlite3WalkExpr() to iterate through child nodes.
6327 **
6328 ** Otherwise, return WRC_Prune. In this case, also check if the
6329 ** sub-expression matches the criteria for being moved to the WHERE
6330 ** clause. If so, add it to the WHERE clause and replace the sub-expression
6331 ** within the HAVING expression with a constant "1".
6332 */
6333 static int havingToWhereExprCb(Walker *pWalker, Expr *pExpr){
6334   if( pExpr->op!=TK_AND ){
6335     Select *pS = pWalker->u.pSelect;
6336     /* This routine is called before the HAVING clause of the current
6337     ** SELECT is analyzed for aggregates. So if pExpr->pAggInfo is set
6338     ** here, it indicates that the expression is a correlated reference to a
6339     ** column from an outer aggregate query, or an aggregate function that
6340     ** belongs to an outer query. Do not move the expression to the WHERE
6341     ** clause in this obscure case, as doing so may corrupt the outer Select
6342     ** statements AggInfo structure.  */
6343     if( sqlite3ExprIsConstantOrGroupBy(pWalker->pParse, pExpr, pS->pGroupBy)
6344      && ExprAlwaysFalse(pExpr)==0
6345      && pExpr->pAggInfo==0
6346     ){
6347       sqlite3 *db = pWalker->pParse->db;
6348       Expr *pNew = sqlite3Expr(db, TK_INTEGER, "1");
6349       if( pNew ){
6350         Expr *pWhere = pS->pWhere;
6351         SWAP(Expr, *pNew, *pExpr);
6352         pNew = sqlite3ExprAnd(pWalker->pParse, pWhere, pNew);
6353         pS->pWhere = pNew;
6354         pWalker->eCode = 1;
6355       }
6356     }
6357     return WRC_Prune;
6358   }
6359   return WRC_Continue;
6360 }
6361 
6362 /*
6363 ** Transfer eligible terms from the HAVING clause of a query, which is
6364 ** processed after grouping, to the WHERE clause, which is processed before
6365 ** grouping. For example, the query:
6366 **
6367 **   SELECT * FROM <tables> WHERE a=? GROUP BY b HAVING b=? AND c=?
6368 **
6369 ** can be rewritten as:
6370 **
6371 **   SELECT * FROM <tables> WHERE a=? AND b=? GROUP BY b HAVING c=?
6372 **
6373 ** A term of the HAVING expression is eligible for transfer if it consists
6374 ** entirely of constants and expressions that are also GROUP BY terms that
6375 ** use the "BINARY" collation sequence.
6376 */
6377 static void havingToWhere(Parse *pParse, Select *p){
6378   Walker sWalker;
6379   memset(&sWalker, 0, sizeof(sWalker));
6380   sWalker.pParse = pParse;
6381   sWalker.xExprCallback = havingToWhereExprCb;
6382   sWalker.u.pSelect = p;
6383   sqlite3WalkExpr(&sWalker, p->pHaving);
6384 #if TREETRACE_ENABLED
6385   if( sWalker.eCode && (sqlite3TreeTrace & 0x100)!=0 ){
6386     SELECTTRACE(0x100,pParse,p,("Move HAVING terms into WHERE:\n"));
6387     sqlite3TreeViewSelect(0, p, 0);
6388   }
6389 #endif
6390 }
6391 
6392 /*
6393 ** Check to see if the pThis entry of pTabList is a self-join of a prior view.
6394 ** If it is, then return the SrcList_item for the prior view.  If it is not,
6395 ** then return 0.
6396 */
6397 static SrcItem *isSelfJoinView(
6398   SrcList *pTabList,           /* Search for self-joins in this FROM clause */
6399   SrcItem *pThis               /* Search for prior reference to this subquery */
6400 ){
6401   SrcItem *pItem;
6402   assert( pThis->pSelect!=0 );
6403   if( pThis->pSelect->selFlags & SF_PushDown ) return 0;
6404   for(pItem = pTabList->a; pItem<pThis; pItem++){
6405     Select *pS1;
6406     if( pItem->pSelect==0 ) continue;
6407     if( pItem->fg.viaCoroutine ) continue;
6408     if( pItem->zName==0 ) continue;
6409     assert( pItem->pTab!=0 );
6410     assert( pThis->pTab!=0 );
6411     if( pItem->pTab->pSchema!=pThis->pTab->pSchema ) continue;
6412     if( sqlite3_stricmp(pItem->zName, pThis->zName)!=0 ) continue;
6413     pS1 = pItem->pSelect;
6414     if( pItem->pTab->pSchema==0 && pThis->pSelect->selId!=pS1->selId ){
6415       /* The query flattener left two different CTE tables with identical
6416       ** names in the same FROM clause. */
6417       continue;
6418     }
6419     if( pItem->pSelect->selFlags & SF_PushDown ){
6420       /* The view was modified by some other optimization such as
6421       ** pushDownWhereTerms() */
6422       continue;
6423     }
6424     return pItem;
6425   }
6426   return 0;
6427 }
6428 
6429 /*
6430 ** Deallocate a single AggInfo object
6431 */
6432 static void agginfoFree(sqlite3 *db, AggInfo *p){
6433   sqlite3DbFree(db, p->aCol);
6434   sqlite3DbFree(db, p->aFunc);
6435   sqlite3DbFreeNN(db, p);
6436 }
6437 
6438 #ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6439 /*
6440 ** Attempt to transform a query of the form
6441 **
6442 **    SELECT count(*) FROM (SELECT x FROM t1 UNION ALL SELECT y FROM t2)
6443 **
6444 ** Into this:
6445 **
6446 **    SELECT (SELECT count(*) FROM t1)+(SELECT count(*) FROM t2)
6447 **
6448 ** The transformation only works if all of the following are true:
6449 **
6450 **   *  The subquery is a UNION ALL of two or more terms
6451 **   *  The subquery does not have a LIMIT clause
6452 **   *  There is no WHERE or GROUP BY or HAVING clauses on the subqueries
6453 **   *  The outer query is a simple count(*) with no WHERE clause or other
6454 **      extraneous syntax.
6455 **
6456 ** Return TRUE if the optimization is undertaken.
6457 */
6458 static int countOfViewOptimization(Parse *pParse, Select *p){
6459   Select *pSub, *pPrior;
6460   Expr *pExpr;
6461   Expr *pCount;
6462   sqlite3 *db;
6463   if( (p->selFlags & SF_Aggregate)==0 ) return 0;   /* This is an aggregate */
6464   if( p->pEList->nExpr!=1 ) return 0;               /* Single result column */
6465   if( p->pWhere ) return 0;
6466   if( p->pGroupBy ) return 0;
6467   pExpr = p->pEList->a[0].pExpr;
6468   if( pExpr->op!=TK_AGG_FUNCTION ) return 0;        /* Result is an aggregate */
6469   assert( ExprUseUToken(pExpr) );
6470   if( sqlite3_stricmp(pExpr->u.zToken,"count") ) return 0;  /* Is count() */
6471   assert( ExprUseXList(pExpr) );
6472   if( pExpr->x.pList!=0 ) return 0;                 /* Must be count(*) */
6473   if( p->pSrc->nSrc!=1 ) return 0;                  /* One table in FROM  */
6474   pSub = p->pSrc->a[0].pSelect;
6475   if( pSub==0 ) return 0;                           /* The FROM is a subquery */
6476   if( pSub->pPrior==0 ) return 0;                   /* Must be a compound ry */
6477   do{
6478     if( pSub->op!=TK_ALL && pSub->pPrior ) return 0;  /* Must be UNION ALL */
6479     if( pSub->pWhere ) return 0;                      /* No WHERE clause */
6480     if( pSub->pLimit ) return 0;                      /* No LIMIT clause */
6481     if( pSub->selFlags & SF_Aggregate ) return 0;     /* Not an aggregate */
6482     pSub = pSub->pPrior;                              /* Repeat over compound */
6483   }while( pSub );
6484 
6485   /* If we reach this point then it is OK to perform the transformation */
6486 
6487   db = pParse->db;
6488   pCount = pExpr;
6489   pExpr = 0;
6490   pSub = p->pSrc->a[0].pSelect;
6491   p->pSrc->a[0].pSelect = 0;
6492   sqlite3SrcListDelete(db, p->pSrc);
6493   p->pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*p->pSrc));
6494   while( pSub ){
6495     Expr *pTerm;
6496     pPrior = pSub->pPrior;
6497     pSub->pPrior = 0;
6498     pSub->pNext = 0;
6499     pSub->selFlags |= SF_Aggregate;
6500     pSub->selFlags &= ~SF_Compound;
6501     pSub->nSelectRow = 0;
6502     sqlite3ExprListDelete(db, pSub->pEList);
6503     pTerm = pPrior ? sqlite3ExprDup(db, pCount, 0) : pCount;
6504     pSub->pEList = sqlite3ExprListAppend(pParse, 0, pTerm);
6505     pTerm = sqlite3PExpr(pParse, TK_SELECT, 0, 0);
6506     sqlite3PExprAddSelect(pParse, pTerm, pSub);
6507     if( pExpr==0 ){
6508       pExpr = pTerm;
6509     }else{
6510       pExpr = sqlite3PExpr(pParse, TK_PLUS, pTerm, pExpr);
6511     }
6512     pSub = pPrior;
6513   }
6514   p->pEList->a[0].pExpr = pExpr;
6515   p->selFlags &= ~SF_Aggregate;
6516 
6517 #if TREETRACE_ENABLED
6518   if( sqlite3TreeTrace & 0x400 ){
6519     SELECTTRACE(0x400,pParse,p,("After count-of-view optimization:\n"));
6520     sqlite3TreeViewSelect(0, p, 0);
6521   }
6522 #endif
6523   return 1;
6524 }
6525 #endif /* SQLITE_COUNTOFVIEW_OPTIMIZATION */
6526 
6527 /*
6528 ** If any term of pSrc, or any SF_NestedFrom sub-query, is not the same
6529 ** as pSrcItem but has the same alias as p0, then return true.
6530 ** Otherwise return false.
6531 */
6532 static int sameSrcAlias(SrcItem *p0, SrcList *pSrc){
6533   int i;
6534   for(i=0; i<pSrc->nSrc; i++){
6535     SrcItem *p1 = &pSrc->a[i];
6536     if( p1==p0 ) continue;
6537     if( p0->pTab==p1->pTab && 0==sqlite3_stricmp(p0->zAlias, p1->zAlias) ){
6538       return 1;
6539     }
6540     if( p1->pSelect
6541      && (p1->pSelect->selFlags & SF_NestedFrom)!=0
6542      && sameSrcAlias(p0, p1->pSelect->pSrc)
6543     ){
6544       return 1;
6545     }
6546   }
6547   return 0;
6548 }
6549 
6550 /*
6551 ** Generate code for the SELECT statement given in the p argument.
6552 **
6553 ** The results are returned according to the SelectDest structure.
6554 ** See comments in sqliteInt.h for further information.
6555 **
6556 ** This routine returns the number of errors.  If any errors are
6557 ** encountered, then an appropriate error message is left in
6558 ** pParse->zErrMsg.
6559 **
6560 ** This routine does NOT free the Select structure passed in.  The
6561 ** calling function needs to do that.
6562 */
6563 int sqlite3Select(
6564   Parse *pParse,         /* The parser context */
6565   Select *p,             /* The SELECT statement being coded. */
6566   SelectDest *pDest      /* What to do with the query results */
6567 ){
6568   int i, j;              /* Loop counters */
6569   WhereInfo *pWInfo;     /* Return from sqlite3WhereBegin() */
6570   Vdbe *v;               /* The virtual machine under construction */
6571   int isAgg;             /* True for select lists like "count(*)" */
6572   ExprList *pEList = 0;  /* List of columns to extract. */
6573   SrcList *pTabList;     /* List of tables to select from */
6574   Expr *pWhere;          /* The WHERE clause.  May be NULL */
6575   ExprList *pGroupBy;    /* The GROUP BY clause.  May be NULL */
6576   Expr *pHaving;         /* The HAVING clause.  May be NULL */
6577   AggInfo *pAggInfo = 0; /* Aggregate information */
6578   int rc = 1;            /* Value to return from this function */
6579   DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
6580   SortCtx sSort;         /* Info on how to code the ORDER BY clause */
6581   int iEnd;              /* Address of the end of the query */
6582   sqlite3 *db;           /* The database connection */
6583   ExprList *pMinMaxOrderBy = 0;  /* Added ORDER BY for min/max queries */
6584   u8 minMaxFlag;                 /* Flag for min/max queries */
6585 
6586   db = pParse->db;
6587   assert( pParse==db->pParse );
6588   v = sqlite3GetVdbe(pParse);
6589   if( p==0 || pParse->nErr ){
6590     return 1;
6591   }
6592   assert( db->mallocFailed==0 );
6593   if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
6594 #if TREETRACE_ENABLED
6595   SELECTTRACE(1,pParse,p, ("begin processing:\n", pParse->addrExplain));
6596   if( sqlite3TreeTrace & 0x10100 ){
6597     if( (sqlite3TreeTrace & 0x10001)==0x10000 ){
6598       sqlite3TreeViewLine(0, "In sqlite3Select() at %s:%d",
6599                            __FILE__, __LINE__);
6600     }
6601     sqlite3ShowSelect(p);
6602   }
6603 #endif
6604 
6605   assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
6606   assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
6607   assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
6608   assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
6609   if( IgnorableDistinct(pDest) ){
6610     assert(pDest->eDest==SRT_Exists     || pDest->eDest==SRT_Union ||
6611            pDest->eDest==SRT_Except     || pDest->eDest==SRT_Discard ||
6612            pDest->eDest==SRT_DistQueue  || pDest->eDest==SRT_DistFifo );
6613     /* All of these destinations are also able to ignore the ORDER BY clause */
6614     if( p->pOrderBy ){
6615 #if TREETRACE_ENABLED
6616       SELECTTRACE(1,pParse,p, ("dropping superfluous ORDER BY:\n"));
6617       if( sqlite3TreeTrace & 0x100 ){
6618         sqlite3TreeViewExprList(0, p->pOrderBy, 0, "ORDERBY");
6619       }
6620 #endif
6621       sqlite3ParserAddCleanup(pParse,
6622         (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
6623         p->pOrderBy);
6624       testcase( pParse->earlyCleanup );
6625       p->pOrderBy = 0;
6626     }
6627     p->selFlags &= ~SF_Distinct;
6628     p->selFlags |= SF_NoopOrderBy;
6629   }
6630   sqlite3SelectPrep(pParse, p, 0);
6631   if( pParse->nErr ){
6632     goto select_end;
6633   }
6634   assert( db->mallocFailed==0 );
6635   assert( p->pEList!=0 );
6636 #if TREETRACE_ENABLED
6637   if( sqlite3TreeTrace & 0x104 ){
6638     SELECTTRACE(0x104,pParse,p, ("after name resolution:\n"));
6639     sqlite3TreeViewSelect(0, p, 0);
6640   }
6641 #endif
6642 
6643   /* If the SF_UFSrcCheck flag is set, then this function is being called
6644   ** as part of populating the temp table for an UPDATE...FROM statement.
6645   ** In this case, it is an error if the target object (pSrc->a[0]) name
6646   ** or alias is duplicated within FROM clause (pSrc->a[1..n]).
6647   **
6648   ** Postgres disallows this case too. The reason is that some other
6649   ** systems handle this case differently, and not all the same way,
6650   ** which is just confusing. To avoid this, we follow PG's lead and
6651   ** disallow it altogether.  */
6652   if( p->selFlags & SF_UFSrcCheck ){
6653     SrcItem *p0 = &p->pSrc->a[0];
6654     if( sameSrcAlias(p0, p->pSrc) ){
6655       sqlite3ErrorMsg(pParse,
6656           "target object/alias may not appear in FROM clause: %s",
6657           p0->zAlias ? p0->zAlias : p0->pTab->zName
6658       );
6659       goto select_end;
6660     }
6661 
6662     /* Clear the SF_UFSrcCheck flag. The check has already been performed,
6663     ** and leaving this flag set can cause errors if a compound sub-query
6664     ** in p->pSrc is flattened into this query and this function called
6665     ** again as part of compound SELECT processing.  */
6666     p->selFlags &= ~SF_UFSrcCheck;
6667   }
6668 
6669   if( pDest->eDest==SRT_Output ){
6670     sqlite3GenerateColumnNames(pParse, p);
6671   }
6672 
6673 #ifndef SQLITE_OMIT_WINDOWFUNC
6674   if( sqlite3WindowRewrite(pParse, p) ){
6675     assert( pParse->nErr );
6676     goto select_end;
6677   }
6678 #if TREETRACE_ENABLED
6679   if( p->pWin && (sqlite3TreeTrace & 0x108)!=0 ){
6680     SELECTTRACE(0x104,pParse,p, ("after window rewrite:\n"));
6681     sqlite3TreeViewSelect(0, p, 0);
6682   }
6683 #endif
6684 #endif /* SQLITE_OMIT_WINDOWFUNC */
6685   pTabList = p->pSrc;
6686   isAgg = (p->selFlags & SF_Aggregate)!=0;
6687   memset(&sSort, 0, sizeof(sSort));
6688   sSort.pOrderBy = p->pOrderBy;
6689 
6690   /* Try to do various optimizations (flattening subqueries, and strength
6691   ** reduction of join operators) in the FROM clause up into the main query
6692   */
6693 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6694   for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
6695     SrcItem *pItem = &pTabList->a[i];
6696     Select *pSub = pItem->pSelect;
6697     Table *pTab = pItem->pTab;
6698 
6699     /* The expander should have already created transient Table objects
6700     ** even for FROM clause elements such as subqueries that do not correspond
6701     ** to a real table */
6702     assert( pTab!=0 );
6703 
6704     /* Convert LEFT JOIN into JOIN if there are terms of the right table
6705     ** of the LEFT JOIN used in the WHERE clause.
6706     */
6707     if( (pItem->fg.jointype & (JT_LEFT|JT_RIGHT))==JT_LEFT
6708      && sqlite3ExprImpliesNonNullRow(p->pWhere, pItem->iCursor)
6709      && OptimizationEnabled(db, SQLITE_SimplifyJoin)
6710     ){
6711       SELECTTRACE(0x100,pParse,p,
6712                 ("LEFT-JOIN simplifies to JOIN on term %d\n",i));
6713       pItem->fg.jointype &= ~(JT_LEFT|JT_OUTER);
6714       unsetJoinExpr(p->pWhere, pItem->iCursor);
6715     }
6716 
6717     /* No futher action if this term of the FROM clause is no a subquery */
6718     if( pSub==0 ) continue;
6719 
6720     /* Catch mismatch in the declared columns of a view and the number of
6721     ** columns in the SELECT on the RHS */
6722     if( pTab->nCol!=pSub->pEList->nExpr ){
6723       sqlite3ErrorMsg(pParse, "expected %d columns for '%s' but got %d",
6724                       pTab->nCol, pTab->zName, pSub->pEList->nExpr);
6725       goto select_end;
6726     }
6727 
6728     /* Do not try to flatten an aggregate subquery.
6729     **
6730     ** Flattening an aggregate subquery is only possible if the outer query
6731     ** is not a join.  But if the outer query is not a join, then the subquery
6732     ** will be implemented as a co-routine and there is no advantage to
6733     ** flattening in that case.
6734     */
6735     if( (pSub->selFlags & SF_Aggregate)!=0 ) continue;
6736     assert( pSub->pGroupBy==0 );
6737 
6738     /* If a FROM-clause subquery has an ORDER BY clause that is not
6739     ** really doing anything, then delete it now so that it does not
6740     ** interfere with query flattening.  See the discussion at
6741     ** https://sqlite.org/forum/forumpost/2d76f2bcf65d256a
6742     **
6743     ** Beware of these cases where the ORDER BY clause may not be safely
6744     ** omitted:
6745     **
6746     **    (1)   There is also a LIMIT clause
6747     **    (2)   The subquery was added to help with window-function
6748     **          processing
6749     **    (3)   The subquery is in the FROM clause of an UPDATE
6750     **    (4)   The outer query uses an aggregate function other than
6751     **          the built-in count(), min(), or max().
6752     **    (5)   The ORDER BY isn't going to accomplish anything because
6753     **          one of:
6754     **            (a)  The outer query has a different ORDER BY clause
6755     **            (b)  The subquery is part of a join
6756     **          See forum post 062d576715d277c8
6757     */
6758     if( pSub->pOrderBy!=0
6759      && (p->pOrderBy!=0 || pTabList->nSrc>1)      /* Condition (5) */
6760      && pSub->pLimit==0                           /* Condition (1) */
6761      && (pSub->selFlags & SF_OrderByReqd)==0      /* Condition (2) */
6762      && (p->selFlags & SF_OrderByReqd)==0         /* Condition (3) and (4) */
6763      && OptimizationEnabled(db, SQLITE_OmitOrderBy)
6764     ){
6765       SELECTTRACE(0x100,pParse,p,
6766                 ("omit superfluous ORDER BY on %r FROM-clause subquery\n",i+1));
6767       sqlite3ExprListDelete(db, pSub->pOrderBy);
6768       pSub->pOrderBy = 0;
6769     }
6770 
6771     /* If the outer query contains a "complex" result set (that is,
6772     ** if the result set of the outer query uses functions or subqueries)
6773     ** and if the subquery contains an ORDER BY clause and if
6774     ** it will be implemented as a co-routine, then do not flatten.  This
6775     ** restriction allows SQL constructs like this:
6776     **
6777     **  SELECT expensive_function(x)
6778     **    FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
6779     **
6780     ** The expensive_function() is only computed on the 10 rows that
6781     ** are output, rather than every row of the table.
6782     **
6783     ** The requirement that the outer query have a complex result set
6784     ** means that flattening does occur on simpler SQL constraints without
6785     ** the expensive_function() like:
6786     **
6787     **  SELECT x FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
6788     */
6789     if( pSub->pOrderBy!=0
6790      && i==0
6791      && (p->selFlags & SF_ComplexResult)!=0
6792      && (pTabList->nSrc==1
6793          || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0)
6794     ){
6795       continue;
6796     }
6797 
6798     if( flattenSubquery(pParse, p, i, isAgg) ){
6799       if( pParse->nErr ) goto select_end;
6800       /* This subquery can be absorbed into its parent. */
6801       i = -1;
6802     }
6803     pTabList = p->pSrc;
6804     if( db->mallocFailed ) goto select_end;
6805     if( !IgnorableOrderby(pDest) ){
6806       sSort.pOrderBy = p->pOrderBy;
6807     }
6808   }
6809 #endif
6810 
6811 #ifndef SQLITE_OMIT_COMPOUND_SELECT
6812   /* Handle compound SELECT statements using the separate multiSelect()
6813   ** procedure.
6814   */
6815   if( p->pPrior ){
6816     rc = multiSelect(pParse, p, pDest);
6817 #if TREETRACE_ENABLED
6818     SELECTTRACE(0x1,pParse,p,("end compound-select processing\n"));
6819     if( (sqlite3TreeTrace & 0x2000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
6820       sqlite3TreeViewSelect(0, p, 0);
6821     }
6822 #endif
6823     if( p->pNext==0 ) ExplainQueryPlanPop(pParse);
6824     return rc;
6825   }
6826 #endif
6827 
6828   /* Do the WHERE-clause constant propagation optimization if this is
6829   ** a join.  No need to speed time on this operation for non-join queries
6830   ** as the equivalent optimization will be handled by query planner in
6831   ** sqlite3WhereBegin().
6832   */
6833   if( p->pWhere!=0
6834    && p->pWhere->op==TK_AND
6835    && OptimizationEnabled(db, SQLITE_PropagateConst)
6836    && propagateConstants(pParse, p)
6837   ){
6838 #if TREETRACE_ENABLED
6839     if( sqlite3TreeTrace & 0x100 ){
6840       SELECTTRACE(0x100,pParse,p,("After constant propagation:\n"));
6841       sqlite3TreeViewSelect(0, p, 0);
6842     }
6843 #endif
6844   }else{
6845     SELECTTRACE(0x100,pParse,p,("Constant propagation not helpful\n"));
6846   }
6847 
6848 #ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6849   if( OptimizationEnabled(db, SQLITE_QueryFlattener|SQLITE_CountOfView)
6850    && countOfViewOptimization(pParse, p)
6851   ){
6852     if( db->mallocFailed ) goto select_end;
6853     pEList = p->pEList;
6854     pTabList = p->pSrc;
6855   }
6856 #endif
6857 
6858   /* For each term in the FROM clause, do two things:
6859   ** (1) Authorized unreferenced tables
6860   ** (2) Generate code for all sub-queries
6861   */
6862   for(i=0; i<pTabList->nSrc; i++){
6863     SrcItem *pItem = &pTabList->a[i];
6864     SrcItem *pPrior;
6865     SelectDest dest;
6866     Select *pSub;
6867 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6868     const char *zSavedAuthContext;
6869 #endif
6870 
6871     /* Issue SQLITE_READ authorizations with a fake column name for any
6872     ** tables that are referenced but from which no values are extracted.
6873     ** Examples of where these kinds of null SQLITE_READ authorizations
6874     ** would occur:
6875     **
6876     **     SELECT count(*) FROM t1;   -- SQLITE_READ t1.""
6877     **     SELECT t1.* FROM t1, t2;   -- SQLITE_READ t2.""
6878     **
6879     ** The fake column name is an empty string.  It is possible for a table to
6880     ** have a column named by the empty string, in which case there is no way to
6881     ** distinguish between an unreferenced table and an actual reference to the
6882     ** "" column. The original design was for the fake column name to be a NULL,
6883     ** which would be unambiguous.  But legacy authorization callbacks might
6884     ** assume the column name is non-NULL and segfault.  The use of an empty
6885     ** string for the fake column name seems safer.
6886     */
6887     if( pItem->colUsed==0 && pItem->zName!=0 ){
6888       sqlite3AuthCheck(pParse, SQLITE_READ, pItem->zName, "", pItem->zDatabase);
6889     }
6890 
6891 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6892     /* Generate code for all sub-queries in the FROM clause
6893     */
6894     pSub = pItem->pSelect;
6895     if( pSub==0 ) continue;
6896 
6897     /* The code for a subquery should only be generated once. */
6898     assert( pItem->addrFillSub==0 );
6899 
6900     /* Increment Parse.nHeight by the height of the largest expression
6901     ** tree referred to by this, the parent select. The child select
6902     ** may contain expression trees of at most
6903     ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
6904     ** more conservative than necessary, but much easier than enforcing
6905     ** an exact limit.
6906     */
6907     pParse->nHeight += sqlite3SelectExprHeight(p);
6908 
6909     /* Make copies of constant WHERE-clause terms in the outer query down
6910     ** inside the subquery.  This can help the subquery to run more efficiently.
6911     */
6912     if( OptimizationEnabled(db, SQLITE_PushDown)
6913      && (pItem->fg.isCte==0
6914          || (pItem->u2.pCteUse->eM10d!=M10d_Yes && pItem->u2.pCteUse->nUse<2))
6915      && pushDownWhereTerms(pParse, pSub, p->pWhere, pItem)
6916     ){
6917 #if TREETRACE_ENABLED
6918       if( sqlite3TreeTrace & 0x100 ){
6919         SELECTTRACE(0x100,pParse,p,
6920             ("After WHERE-clause push-down into subquery %d:\n", pSub->selId));
6921         sqlite3TreeViewSelect(0, p, 0);
6922       }
6923 #endif
6924       assert( pItem->pSelect && (pItem->pSelect->selFlags & SF_PushDown)!=0 );
6925     }else{
6926       SELECTTRACE(0x100,pParse,p,("Push-down not possible\n"));
6927     }
6928 
6929     zSavedAuthContext = pParse->zAuthContext;
6930     pParse->zAuthContext = pItem->zName;
6931 
6932     /* Generate code to implement the subquery
6933     **
6934     ** The subquery is implemented as a co-routine all if the following are
6935     ** true:
6936     **
6937     **    (1)  the subquery is guaranteed to be the outer loop (so that
6938     **         it does not need to be computed more than once), and
6939     **    (2)  the subquery is not a CTE that should be materialized
6940     **    (3)  the subquery is not part of a left operand for a RIGHT JOIN
6941     */
6942     if( i==0
6943      && (pTabList->nSrc==1
6944             || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0)  /* (1) */
6945      && (pItem->fg.isCte==0 || pItem->u2.pCteUse->eM10d!=M10d_Yes)   /* (2) */
6946      && (pTabList->a[0].fg.jointype & JT_LTORJ)==0                   /* (3) */
6947     ){
6948       /* Implement a co-routine that will return a single row of the result
6949       ** set on each invocation.
6950       */
6951       int addrTop = sqlite3VdbeCurrentAddr(v)+1;
6952 
6953       pItem->regReturn = ++pParse->nMem;
6954       sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
6955       VdbeComment((v, "%!S", pItem));
6956       pItem->addrFillSub = addrTop;
6957       sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
6958       ExplainQueryPlan((pParse, 1, "CO-ROUTINE %!S", pItem));
6959       sqlite3Select(pParse, pSub, &dest);
6960       pItem->pTab->nRowLogEst = pSub->nSelectRow;
6961       pItem->fg.viaCoroutine = 1;
6962       pItem->regResult = dest.iSdst;
6963       sqlite3VdbeEndCoroutine(v, pItem->regReturn);
6964       sqlite3VdbeJumpHere(v, addrTop-1);
6965       sqlite3ClearTempRegCache(pParse);
6966     }else if( pItem->fg.isCte && pItem->u2.pCteUse->addrM9e>0 ){
6967       /* This is a CTE for which materialization code has already been
6968       ** generated.  Invoke the subroutine to compute the materialization,
6969       ** the make the pItem->iCursor be a copy of the ephemerial table that
6970       ** holds the result of the materialization. */
6971       CteUse *pCteUse = pItem->u2.pCteUse;
6972       sqlite3VdbeAddOp2(v, OP_Gosub, pCteUse->regRtn, pCteUse->addrM9e);
6973       if( pItem->iCursor!=pCteUse->iCur ){
6974         sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pCteUse->iCur);
6975         VdbeComment((v, "%!S", pItem));
6976       }
6977       pSub->nSelectRow = pCteUse->nRowEst;
6978     }else if( (pPrior = isSelfJoinView(pTabList, pItem))!=0 ){
6979       /* This view has already been materialized by a prior entry in
6980       ** this same FROM clause.  Reuse it. */
6981       if( pPrior->addrFillSub ){
6982         sqlite3VdbeAddOp2(v, OP_Gosub, pPrior->regReturn, pPrior->addrFillSub);
6983       }
6984       sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pPrior->iCursor);
6985       pSub->nSelectRow = pPrior->pSelect->nSelectRow;
6986     }else{
6987       /* Materialize the view.  If the view is not correlated, generate a
6988       ** subroutine to do the materialization so that subsequent uses of
6989       ** the same view can reuse the materialization. */
6990       int topAddr;
6991       int onceAddr = 0;
6992 
6993       pItem->regReturn = ++pParse->nMem;
6994       topAddr = sqlite3VdbeAddOp0(v, OP_Goto);
6995       pItem->addrFillSub = topAddr+1;
6996       pItem->fg.isMaterialized = 1;
6997       if( pItem->fg.isCorrelated==0 ){
6998         /* If the subquery is not correlated and if we are not inside of
6999         ** a trigger, then we only need to compute the value of the subquery
7000         ** once. */
7001         onceAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
7002         VdbeComment((v, "materialize %!S", pItem));
7003       }else{
7004         VdbeNoopComment((v, "materialize %!S", pItem));
7005       }
7006       sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
7007       ExplainQueryPlan((pParse, 1, "MATERIALIZE %!S", pItem));
7008       sqlite3Select(pParse, pSub, &dest);
7009       pItem->pTab->nRowLogEst = pSub->nSelectRow;
7010       if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
7011       sqlite3VdbeAddOp2(v, OP_Return, pItem->regReturn, topAddr+1);
7012       VdbeComment((v, "end %!S", pItem));
7013       sqlite3VdbeJumpHere(v, topAddr);
7014       sqlite3ClearTempRegCache(pParse);
7015       if( pItem->fg.isCte && pItem->fg.isCorrelated==0 ){
7016         CteUse *pCteUse = pItem->u2.pCteUse;
7017         pCteUse->addrM9e = pItem->addrFillSub;
7018         pCteUse->regRtn = pItem->regReturn;
7019         pCteUse->iCur = pItem->iCursor;
7020         pCteUse->nRowEst = pSub->nSelectRow;
7021       }
7022     }
7023     if( db->mallocFailed ) goto select_end;
7024     pParse->nHeight -= sqlite3SelectExprHeight(p);
7025     pParse->zAuthContext = zSavedAuthContext;
7026 #endif
7027   }
7028 
7029   /* Various elements of the SELECT copied into local variables for
7030   ** convenience */
7031   pEList = p->pEList;
7032   pWhere = p->pWhere;
7033   pGroupBy = p->pGroupBy;
7034   pHaving = p->pHaving;
7035   sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
7036 
7037 #if TREETRACE_ENABLED
7038   if( sqlite3TreeTrace & 0x400 ){
7039     SELECTTRACE(0x400,pParse,p,("After all FROM-clause analysis:\n"));
7040     sqlite3TreeViewSelect(0, p, 0);
7041   }
7042 #endif
7043 
7044   /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
7045   ** if the select-list is the same as the ORDER BY list, then this query
7046   ** can be rewritten as a GROUP BY. In other words, this:
7047   **
7048   **     SELECT DISTINCT xyz FROM ... ORDER BY xyz
7049   **
7050   ** is transformed to:
7051   **
7052   **     SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
7053   **
7054   ** The second form is preferred as a single index (or temp-table) may be
7055   ** used for both the ORDER BY and DISTINCT processing. As originally
7056   ** written the query must use a temp-table for at least one of the ORDER
7057   ** BY and DISTINCT, and an index or separate temp-table for the other.
7058   */
7059   if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
7060    && sqlite3ExprListCompare(sSort.pOrderBy, pEList, -1)==0
7061 #ifndef SQLITE_OMIT_WINDOWFUNC
7062    && p->pWin==0
7063 #endif
7064   ){
7065     p->selFlags &= ~SF_Distinct;
7066     pGroupBy = p->pGroupBy = sqlite3ExprListDup(db, pEList, 0);
7067     p->selFlags |= SF_Aggregate;
7068     /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
7069     ** the sDistinct.isTnct is still set.  Hence, isTnct represents the
7070     ** original setting of the SF_Distinct flag, not the current setting */
7071     assert( sDistinct.isTnct );
7072     sDistinct.isTnct = 2;
7073 
7074 #if TREETRACE_ENABLED
7075     if( sqlite3TreeTrace & 0x400 ){
7076       SELECTTRACE(0x400,pParse,p,("Transform DISTINCT into GROUP BY:\n"));
7077       sqlite3TreeViewSelect(0, p, 0);
7078     }
7079 #endif
7080   }
7081 
7082   /* If there is an ORDER BY clause, then create an ephemeral index to
7083   ** do the sorting.  But this sorting ephemeral index might end up
7084   ** being unused if the data can be extracted in pre-sorted order.
7085   ** If that is the case, then the OP_OpenEphemeral instruction will be
7086   ** changed to an OP_Noop once we figure out that the sorting index is
7087   ** not needed.  The sSort.addrSortIndex variable is used to facilitate
7088   ** that change.
7089   */
7090   if( sSort.pOrderBy ){
7091     KeyInfo *pKeyInfo;
7092     pKeyInfo = sqlite3KeyInfoFromExprList(
7093         pParse, sSort.pOrderBy, 0, pEList->nExpr);
7094     sSort.iECursor = pParse->nTab++;
7095     sSort.addrSortIndex =
7096       sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
7097           sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
7098           (char*)pKeyInfo, P4_KEYINFO
7099       );
7100   }else{
7101     sSort.addrSortIndex = -1;
7102   }
7103 
7104   /* If the output is destined for a temporary table, open that table.
7105   */
7106   if( pDest->eDest==SRT_EphemTab ){
7107     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
7108     if( p->selFlags & SF_NestedFrom ){
7109       /* Delete or NULL-out result columns that will never be used */
7110       int ii;
7111       for(ii=pEList->nExpr-1; ii>0 && pEList->a[ii].fg.bUsed==0; ii--){
7112         sqlite3ExprDelete(db, pEList->a[ii].pExpr);
7113         sqlite3DbFree(db, pEList->a[ii].zEName);
7114         pEList->nExpr--;
7115       }
7116       for(ii=0; ii<pEList->nExpr; ii++){
7117         if( pEList->a[ii].fg.bUsed==0 ) pEList->a[ii].pExpr->op = TK_NULL;
7118       }
7119     }
7120   }
7121 
7122   /* Set the limiter.
7123   */
7124   iEnd = sqlite3VdbeMakeLabel(pParse);
7125   if( (p->selFlags & SF_FixedLimit)==0 ){
7126     p->nSelectRow = 320;  /* 4 billion rows */
7127   }
7128   computeLimitRegisters(pParse, p, iEnd);
7129   if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
7130     sqlite3VdbeChangeOpcode(v, sSort.addrSortIndex, OP_SorterOpen);
7131     sSort.sortFlags |= SORTFLAG_UseSorter;
7132   }
7133 
7134   /* Open an ephemeral index to use for the distinct set.
7135   */
7136   if( p->selFlags & SF_Distinct ){
7137     sDistinct.tabTnct = pParse->nTab++;
7138     sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
7139                        sDistinct.tabTnct, 0, 0,
7140                        (char*)sqlite3KeyInfoFromExprList(pParse, p->pEList,0,0),
7141                        P4_KEYINFO);
7142     sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
7143     sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
7144   }else{
7145     sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
7146   }
7147 
7148   if( !isAgg && pGroupBy==0 ){
7149     /* No aggregate functions and no GROUP BY clause */
7150     u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0)
7151                    | (p->selFlags & SF_FixedLimit);
7152 #ifndef SQLITE_OMIT_WINDOWFUNC
7153     Window *pWin = p->pWin;      /* Main window object (or NULL) */
7154     if( pWin ){
7155       sqlite3WindowCodeInit(pParse, p);
7156     }
7157 #endif
7158     assert( WHERE_USE_LIMIT==SF_FixedLimit );
7159 
7160 
7161     /* Begin the database scan. */
7162     SELECTTRACE(1,pParse,p,("WhereBegin\n"));
7163     pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
7164                                p->pEList, p, wctrlFlags, p->nSelectRow);
7165     if( pWInfo==0 ) goto select_end;
7166     if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
7167       p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
7168     }
7169     if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
7170       sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
7171     }
7172     if( sSort.pOrderBy ){
7173       sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
7174       sSort.labelOBLopt = sqlite3WhereOrderByLimitOptLabel(pWInfo);
7175       if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
7176         sSort.pOrderBy = 0;
7177       }
7178     }
7179     SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
7180 
7181     /* If sorting index that was created by a prior OP_OpenEphemeral
7182     ** instruction ended up not being needed, then change the OP_OpenEphemeral
7183     ** into an OP_Noop.
7184     */
7185     if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
7186       sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
7187     }
7188 
7189     assert( p->pEList==pEList );
7190 #ifndef SQLITE_OMIT_WINDOWFUNC
7191     if( pWin ){
7192       int addrGosub = sqlite3VdbeMakeLabel(pParse);
7193       int iCont = sqlite3VdbeMakeLabel(pParse);
7194       int iBreak = sqlite3VdbeMakeLabel(pParse);
7195       int regGosub = ++pParse->nMem;
7196 
7197       sqlite3WindowCodeStep(pParse, p, pWInfo, regGosub, addrGosub);
7198 
7199       sqlite3VdbeAddOp2(v, OP_Goto, 0, iBreak);
7200       sqlite3VdbeResolveLabel(v, addrGosub);
7201       VdbeNoopComment((v, "inner-loop subroutine"));
7202       sSort.labelOBLopt = 0;
7203       selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest, iCont, iBreak);
7204       sqlite3VdbeResolveLabel(v, iCont);
7205       sqlite3VdbeAddOp1(v, OP_Return, regGosub);
7206       VdbeComment((v, "end inner-loop subroutine"));
7207       sqlite3VdbeResolveLabel(v, iBreak);
7208     }else
7209 #endif /* SQLITE_OMIT_WINDOWFUNC */
7210     {
7211       /* Use the standard inner loop. */
7212       selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest,
7213           sqlite3WhereContinueLabel(pWInfo),
7214           sqlite3WhereBreakLabel(pWInfo));
7215 
7216       /* End the database scan loop.
7217       */
7218       SELECTTRACE(1,pParse,p,("WhereEnd\n"));
7219       sqlite3WhereEnd(pWInfo);
7220     }
7221   }else{
7222     /* This case when there exist aggregate functions or a GROUP BY clause
7223     ** or both */
7224     NameContext sNC;    /* Name context for processing aggregate information */
7225     int iAMem;          /* First Mem address for storing current GROUP BY */
7226     int iBMem;          /* First Mem address for previous GROUP BY */
7227     int iUseFlag;       /* Mem address holding flag indicating that at least
7228                         ** one row of the input to the aggregator has been
7229                         ** processed */
7230     int iAbortFlag;     /* Mem address which causes query abort if positive */
7231     int groupBySort;    /* Rows come from source in GROUP BY order */
7232     int addrEnd;        /* End of processing for this SELECT */
7233     int sortPTab = 0;   /* Pseudotable used to decode sorting results */
7234     int sortOut = 0;    /* Output register from the sorter */
7235     int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
7236 
7237     /* Remove any and all aliases between the result set and the
7238     ** GROUP BY clause.
7239     */
7240     if( pGroupBy ){
7241       int k;                        /* Loop counter */
7242       struct ExprList_item *pItem;  /* For looping over expression in a list */
7243 
7244       for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
7245         pItem->u.x.iAlias = 0;
7246       }
7247       for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
7248         pItem->u.x.iAlias = 0;
7249       }
7250       assert( 66==sqlite3LogEst(100) );
7251       if( p->nSelectRow>66 ) p->nSelectRow = 66;
7252 
7253       /* If there is both a GROUP BY and an ORDER BY clause and they are
7254       ** identical, then it may be possible to disable the ORDER BY clause
7255       ** on the grounds that the GROUP BY will cause elements to come out
7256       ** in the correct order. It also may not - the GROUP BY might use a
7257       ** database index that causes rows to be grouped together as required
7258       ** but not actually sorted. Either way, record the fact that the
7259       ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
7260       ** variable.  */
7261       if( sSort.pOrderBy && pGroupBy->nExpr==sSort.pOrderBy->nExpr ){
7262         int ii;
7263         /* The GROUP BY processing doesn't care whether rows are delivered in
7264         ** ASC or DESC order - only that each group is returned contiguously.
7265         ** So set the ASC/DESC flags in the GROUP BY to match those in the
7266         ** ORDER BY to maximize the chances of rows being delivered in an
7267         ** order that makes the ORDER BY redundant.  */
7268         for(ii=0; ii<pGroupBy->nExpr; ii++){
7269           u8 sortFlags;
7270           sortFlags = sSort.pOrderBy->a[ii].fg.sortFlags & KEYINFO_ORDER_DESC;
7271           pGroupBy->a[ii].fg.sortFlags = sortFlags;
7272         }
7273         if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
7274           orderByGrp = 1;
7275         }
7276       }
7277     }else{
7278       assert( 0==sqlite3LogEst(1) );
7279       p->nSelectRow = 0;
7280     }
7281 
7282     /* Create a label to jump to when we want to abort the query */
7283     addrEnd = sqlite3VdbeMakeLabel(pParse);
7284 
7285     /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
7286     ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
7287     ** SELECT statement.
7288     */
7289     pAggInfo = sqlite3DbMallocZero(db, sizeof(*pAggInfo) );
7290     if( pAggInfo ){
7291       sqlite3ParserAddCleanup(pParse,
7292           (void(*)(sqlite3*,void*))agginfoFree, pAggInfo);
7293       testcase( pParse->earlyCleanup );
7294     }
7295     if( db->mallocFailed ){
7296       goto select_end;
7297     }
7298     pAggInfo->selId = p->selId;
7299     memset(&sNC, 0, sizeof(sNC));
7300     sNC.pParse = pParse;
7301     sNC.pSrcList = pTabList;
7302     sNC.uNC.pAggInfo = pAggInfo;
7303     VVA_ONLY( sNC.ncFlags = NC_UAggInfo; )
7304     pAggInfo->mnReg = pParse->nMem+1;
7305     pAggInfo->nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
7306     pAggInfo->pGroupBy = pGroupBy;
7307     sqlite3ExprAnalyzeAggList(&sNC, pEList);
7308     sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
7309     if( pHaving ){
7310       if( pGroupBy ){
7311         assert( pWhere==p->pWhere );
7312         assert( pHaving==p->pHaving );
7313         assert( pGroupBy==p->pGroupBy );
7314         havingToWhere(pParse, p);
7315         pWhere = p->pWhere;
7316       }
7317       sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
7318     }
7319     pAggInfo->nAccumulator = pAggInfo->nColumn;
7320     if( p->pGroupBy==0 && p->pHaving==0 && pAggInfo->nFunc==1 ){
7321       minMaxFlag = minMaxQuery(db, pAggInfo->aFunc[0].pFExpr, &pMinMaxOrderBy);
7322     }else{
7323       minMaxFlag = WHERE_ORDERBY_NORMAL;
7324     }
7325     for(i=0; i<pAggInfo->nFunc; i++){
7326       Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
7327       assert( ExprUseXList(pExpr) );
7328       sNC.ncFlags |= NC_InAggFunc;
7329       sqlite3ExprAnalyzeAggList(&sNC, pExpr->x.pList);
7330 #ifndef SQLITE_OMIT_WINDOWFUNC
7331       assert( !IsWindowFunc(pExpr) );
7332       if( ExprHasProperty(pExpr, EP_WinFunc) ){
7333         sqlite3ExprAnalyzeAggregates(&sNC, pExpr->y.pWin->pFilter);
7334       }
7335 #endif
7336       sNC.ncFlags &= ~NC_InAggFunc;
7337     }
7338     pAggInfo->mxReg = pParse->nMem;
7339     if( db->mallocFailed ) goto select_end;
7340 #if TREETRACE_ENABLED
7341     if( sqlite3TreeTrace & 0x400 ){
7342       int ii;
7343       SELECTTRACE(0x400,pParse,p,("After aggregate analysis %p:\n", pAggInfo));
7344       sqlite3TreeViewSelect(0, p, 0);
7345       if( minMaxFlag ){
7346         sqlite3DebugPrintf("MIN/MAX Optimization (0x%02x) adds:\n", minMaxFlag);
7347         sqlite3TreeViewExprList(0, pMinMaxOrderBy, 0, "ORDERBY");
7348       }
7349       for(ii=0; ii<pAggInfo->nColumn; ii++){
7350         sqlite3DebugPrintf("agg-column[%d] iMem=%d\n",
7351             ii, pAggInfo->aCol[ii].iMem);
7352         sqlite3TreeViewExpr(0, pAggInfo->aCol[ii].pCExpr, 0);
7353       }
7354       for(ii=0; ii<pAggInfo->nFunc; ii++){
7355         sqlite3DebugPrintf("agg-func[%d]: iMem=%d\n",
7356             ii, pAggInfo->aFunc[ii].iMem);
7357         sqlite3TreeViewExpr(0, pAggInfo->aFunc[ii].pFExpr, 0);
7358       }
7359     }
7360 #endif
7361 
7362 
7363     /* Processing for aggregates with GROUP BY is very different and
7364     ** much more complex than aggregates without a GROUP BY.
7365     */
7366     if( pGroupBy ){
7367       KeyInfo *pKeyInfo;  /* Keying information for the group by clause */
7368       int addr1;          /* A-vs-B comparision jump */
7369       int addrOutputRow;  /* Start of subroutine that outputs a result row */
7370       int regOutputRow;   /* Return address register for output subroutine */
7371       int addrSetAbort;   /* Set the abort flag and return */
7372       int addrTopOfLoop;  /* Top of the input loop */
7373       int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
7374       int addrReset;      /* Subroutine for resetting the accumulator */
7375       int regReset;       /* Return address register for reset subroutine */
7376       ExprList *pDistinct = 0;
7377       u16 distFlag = 0;
7378       int eDist = WHERE_DISTINCT_NOOP;
7379 
7380       if( pAggInfo->nFunc==1
7381        && pAggInfo->aFunc[0].iDistinct>=0
7382        && ALWAYS(pAggInfo->aFunc[0].pFExpr!=0)
7383        && ALWAYS(ExprUseXList(pAggInfo->aFunc[0].pFExpr))
7384        && pAggInfo->aFunc[0].pFExpr->x.pList!=0
7385       ){
7386         Expr *pExpr = pAggInfo->aFunc[0].pFExpr->x.pList->a[0].pExpr;
7387         pExpr = sqlite3ExprDup(db, pExpr, 0);
7388         pDistinct = sqlite3ExprListDup(db, pGroupBy, 0);
7389         pDistinct = sqlite3ExprListAppend(pParse, pDistinct, pExpr);
7390         distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
7391       }
7392 
7393       /* If there is a GROUP BY clause we might need a sorting index to
7394       ** implement it.  Allocate that sorting index now.  If it turns out
7395       ** that we do not need it after all, the OP_SorterOpen instruction
7396       ** will be converted into a Noop.
7397       */
7398       pAggInfo->sortingIdx = pParse->nTab++;
7399       pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pGroupBy,
7400                                             0, pAggInfo->nColumn);
7401       addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
7402           pAggInfo->sortingIdx, pAggInfo->nSortingColumn,
7403           0, (char*)pKeyInfo, P4_KEYINFO);
7404 
7405       /* Initialize memory locations used by GROUP BY aggregate processing
7406       */
7407       iUseFlag = ++pParse->nMem;
7408       iAbortFlag = ++pParse->nMem;
7409       regOutputRow = ++pParse->nMem;
7410       addrOutputRow = sqlite3VdbeMakeLabel(pParse);
7411       regReset = ++pParse->nMem;
7412       addrReset = sqlite3VdbeMakeLabel(pParse);
7413       iAMem = pParse->nMem + 1;
7414       pParse->nMem += pGroupBy->nExpr;
7415       iBMem = pParse->nMem + 1;
7416       pParse->nMem += pGroupBy->nExpr;
7417       sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
7418       VdbeComment((v, "clear abort flag"));
7419       sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
7420 
7421       /* Begin a loop that will extract all source rows in GROUP BY order.
7422       ** This might involve two separate loops with an OP_Sort in between, or
7423       ** it might be a single loop that uses an index to extract information
7424       ** in the right order to begin with.
7425       */
7426       sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
7427       SELECTTRACE(1,pParse,p,("WhereBegin\n"));
7428       pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, pDistinct,
7429           0, (sDistinct.isTnct==2 ? WHERE_DISTINCTBY : WHERE_GROUPBY)
7430           |  (orderByGrp ? WHERE_SORTBYGROUP : 0) | distFlag, 0
7431       );
7432       if( pWInfo==0 ){
7433         sqlite3ExprListDelete(db, pDistinct);
7434         goto select_end;
7435       }
7436       eDist = sqlite3WhereIsDistinct(pWInfo);
7437       SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
7438       if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
7439         /* The optimizer is able to deliver rows in group by order so
7440         ** we do not have to sort.  The OP_OpenEphemeral table will be
7441         ** cancelled later because we still need to use the pKeyInfo
7442         */
7443         groupBySort = 0;
7444       }else{
7445         /* Rows are coming out in undetermined order.  We have to push
7446         ** each row into a sorting index, terminate the first loop,
7447         ** then loop over the sorting index in order to get the output
7448         ** in sorted order
7449         */
7450         int regBase;
7451         int regRecord;
7452         int nCol;
7453         int nGroupBy;
7454 
7455         explainTempTable(pParse,
7456             (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
7457                     "DISTINCT" : "GROUP BY");
7458 
7459         groupBySort = 1;
7460         nGroupBy = pGroupBy->nExpr;
7461         nCol = nGroupBy;
7462         j = nGroupBy;
7463         for(i=0; i<pAggInfo->nColumn; i++){
7464           if( pAggInfo->aCol[i].iSorterColumn>=j ){
7465             nCol++;
7466             j++;
7467           }
7468         }
7469         regBase = sqlite3GetTempRange(pParse, nCol);
7470         sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0, 0);
7471         j = nGroupBy;
7472         for(i=0; i<pAggInfo->nColumn; i++){
7473           struct AggInfo_col *pCol = &pAggInfo->aCol[i];
7474           if( pCol->iSorterColumn>=j ){
7475             int r1 = j + regBase;
7476             sqlite3ExprCodeGetColumnOfTable(v,
7477                                pCol->pTab, pCol->iTable, pCol->iColumn, r1);
7478             j++;
7479           }
7480         }
7481         regRecord = sqlite3GetTempReg(pParse);
7482         sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
7483         sqlite3VdbeAddOp2(v, OP_SorterInsert, pAggInfo->sortingIdx, regRecord);
7484         sqlite3ReleaseTempReg(pParse, regRecord);
7485         sqlite3ReleaseTempRange(pParse, regBase, nCol);
7486         SELECTTRACE(1,pParse,p,("WhereEnd\n"));
7487         sqlite3WhereEnd(pWInfo);
7488         pAggInfo->sortingIdxPTab = sortPTab = pParse->nTab++;
7489         sortOut = sqlite3GetTempReg(pParse);
7490         sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
7491         sqlite3VdbeAddOp2(v, OP_SorterSort, pAggInfo->sortingIdx, addrEnd);
7492         VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
7493         pAggInfo->useSortingIdx = 1;
7494       }
7495 
7496       /* If the index or temporary table used by the GROUP BY sort
7497       ** will naturally deliver rows in the order required by the ORDER BY
7498       ** clause, cancel the ephemeral table open coded earlier.
7499       **
7500       ** This is an optimization - the correct answer should result regardless.
7501       ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
7502       ** disable this optimization for testing purposes.  */
7503       if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
7504        && (groupBySort || sqlite3WhereIsSorted(pWInfo))
7505       ){
7506         sSort.pOrderBy = 0;
7507         sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
7508       }
7509 
7510       /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
7511       ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
7512       ** Then compare the current GROUP BY terms against the GROUP BY terms
7513       ** from the previous row currently stored in a0, a1, a2...
7514       */
7515       addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
7516       if( groupBySort ){
7517         sqlite3VdbeAddOp3(v, OP_SorterData, pAggInfo->sortingIdx,
7518                           sortOut, sortPTab);
7519       }
7520       for(j=0; j<pGroupBy->nExpr; j++){
7521         if( groupBySort ){
7522           sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
7523         }else{
7524           pAggInfo->directMode = 1;
7525           sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
7526         }
7527       }
7528       sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
7529                           (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
7530       addr1 = sqlite3VdbeCurrentAddr(v);
7531       sqlite3VdbeAddOp3(v, OP_Jump, addr1+1, 0, addr1+1); VdbeCoverage(v);
7532 
7533       /* Generate code that runs whenever the GROUP BY changes.
7534       ** Changes in the GROUP BY are detected by the previous code
7535       ** block.  If there were no changes, this block is skipped.
7536       **
7537       ** This code copies current group by terms in b0,b1,b2,...
7538       ** over to a0,a1,a2.  It then calls the output subroutine
7539       ** and resets the aggregate accumulator registers in preparation
7540       ** for the next GROUP BY batch.
7541       */
7542       sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
7543       sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
7544       VdbeComment((v, "output one row"));
7545       sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
7546       VdbeComment((v, "check abort flag"));
7547       sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
7548       VdbeComment((v, "reset accumulator"));
7549 
7550       /* Update the aggregate accumulators based on the content of
7551       ** the current row
7552       */
7553       sqlite3VdbeJumpHere(v, addr1);
7554       updateAccumulator(pParse, iUseFlag, pAggInfo, eDist);
7555       sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
7556       VdbeComment((v, "indicate data in accumulator"));
7557 
7558       /* End of the loop
7559       */
7560       if( groupBySort ){
7561         sqlite3VdbeAddOp2(v, OP_SorterNext, pAggInfo->sortingIdx,addrTopOfLoop);
7562         VdbeCoverage(v);
7563       }else{
7564         SELECTTRACE(1,pParse,p,("WhereEnd\n"));
7565         sqlite3WhereEnd(pWInfo);
7566         sqlite3VdbeChangeToNoop(v, addrSortingIdx);
7567       }
7568       sqlite3ExprListDelete(db, pDistinct);
7569 
7570       /* Output the final row of result
7571       */
7572       sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
7573       VdbeComment((v, "output final row"));
7574 
7575       /* Jump over the subroutines
7576       */
7577       sqlite3VdbeGoto(v, addrEnd);
7578 
7579       /* Generate a subroutine that outputs a single row of the result
7580       ** set.  This subroutine first looks at the iUseFlag.  If iUseFlag
7581       ** is less than or equal to zero, the subroutine is a no-op.  If
7582       ** the processing calls for the query to abort, this subroutine
7583       ** increments the iAbortFlag memory location before returning in
7584       ** order to signal the caller to abort.
7585       */
7586       addrSetAbort = sqlite3VdbeCurrentAddr(v);
7587       sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
7588       VdbeComment((v, "set abort flag"));
7589       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7590       sqlite3VdbeResolveLabel(v, addrOutputRow);
7591       addrOutputRow = sqlite3VdbeCurrentAddr(v);
7592       sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2);
7593       VdbeCoverage(v);
7594       VdbeComment((v, "Groupby result generator entry point"));
7595       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7596       finalizeAggFunctions(pParse, pAggInfo);
7597       sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
7598       selectInnerLoop(pParse, p, -1, &sSort,
7599                       &sDistinct, pDest,
7600                       addrOutputRow+1, addrSetAbort);
7601       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7602       VdbeComment((v, "end groupby result generator"));
7603 
7604       /* Generate a subroutine that will reset the group-by accumulator
7605       */
7606       sqlite3VdbeResolveLabel(v, addrReset);
7607       resetAccumulator(pParse, pAggInfo);
7608       sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
7609       VdbeComment((v, "indicate accumulator empty"));
7610       sqlite3VdbeAddOp1(v, OP_Return, regReset);
7611 
7612       if( distFlag!=0 && eDist!=WHERE_DISTINCT_NOOP ){
7613         struct AggInfo_func *pF = &pAggInfo->aFunc[0];
7614         fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7615       }
7616     } /* endif pGroupBy.  Begin aggregate queries without GROUP BY: */
7617     else {
7618       Table *pTab;
7619       if( (pTab = isSimpleCount(p, pAggInfo))!=0 ){
7620         /* If isSimpleCount() returns a pointer to a Table structure, then
7621         ** the SQL statement is of the form:
7622         **
7623         **   SELECT count(*) FROM <tbl>
7624         **
7625         ** where the Table structure returned represents table <tbl>.
7626         **
7627         ** This statement is so common that it is optimized specially. The
7628         ** OP_Count instruction is executed either on the intkey table that
7629         ** contains the data for table <tbl> or on one of its indexes. It
7630         ** is better to execute the op on an index, as indexes are almost
7631         ** always spread across less pages than their corresponding tables.
7632         */
7633         const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
7634         const int iCsr = pParse->nTab++;     /* Cursor to scan b-tree */
7635         Index *pIdx;                         /* Iterator variable */
7636         KeyInfo *pKeyInfo = 0;               /* Keyinfo for scanned index */
7637         Index *pBest = 0;                    /* Best index found so far */
7638         Pgno iRoot = pTab->tnum;             /* Root page of scanned b-tree */
7639 
7640         sqlite3CodeVerifySchema(pParse, iDb);
7641         sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
7642 
7643         /* Search for the index that has the lowest scan cost.
7644         **
7645         ** (2011-04-15) Do not do a full scan of an unordered index.
7646         **
7647         ** (2013-10-03) Do not count the entries in a partial index.
7648         **
7649         ** In practice the KeyInfo structure will not be used. It is only
7650         ** passed to keep OP_OpenRead happy.
7651         */
7652         if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
7653         if( !p->pSrc->a[0].fg.notIndexed ){
7654           for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
7655             if( pIdx->bUnordered==0
7656              && pIdx->szIdxRow<pTab->szTabRow
7657              && pIdx->pPartIdxWhere==0
7658              && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
7659             ){
7660               pBest = pIdx;
7661             }
7662           }
7663         }
7664         if( pBest ){
7665           iRoot = pBest->tnum;
7666           pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
7667         }
7668 
7669         /* Open a read-only cursor, execute the OP_Count, close the cursor. */
7670         sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, (int)iRoot, iDb, 1);
7671         if( pKeyInfo ){
7672           sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
7673         }
7674         sqlite3VdbeAddOp2(v, OP_Count, iCsr, pAggInfo->aFunc[0].iMem);
7675         sqlite3VdbeAddOp1(v, OP_Close, iCsr);
7676         explainSimpleCount(pParse, pTab, pBest);
7677       }else{
7678         int regAcc = 0;           /* "populate accumulators" flag */
7679         ExprList *pDistinct = 0;
7680         u16 distFlag = 0;
7681         int eDist;
7682 
7683         /* If there are accumulator registers but no min() or max() functions
7684         ** without FILTER clauses, allocate register regAcc. Register regAcc
7685         ** will contain 0 the first time the inner loop runs, and 1 thereafter.
7686         ** The code generated by updateAccumulator() uses this to ensure
7687         ** that the accumulator registers are (a) updated only once if
7688         ** there are no min() or max functions or (b) always updated for the
7689         ** first row visited by the aggregate, so that they are updated at
7690         ** least once even if the FILTER clause means the min() or max()
7691         ** function visits zero rows.  */
7692         if( pAggInfo->nAccumulator ){
7693           for(i=0; i<pAggInfo->nFunc; i++){
7694             if( ExprHasProperty(pAggInfo->aFunc[i].pFExpr, EP_WinFunc) ){
7695               continue;
7696             }
7697             if( pAggInfo->aFunc[i].pFunc->funcFlags&SQLITE_FUNC_NEEDCOLL ){
7698               break;
7699             }
7700           }
7701           if( i==pAggInfo->nFunc ){
7702             regAcc = ++pParse->nMem;
7703             sqlite3VdbeAddOp2(v, OP_Integer, 0, regAcc);
7704           }
7705         }else if( pAggInfo->nFunc==1 && pAggInfo->aFunc[0].iDistinct>=0 ){
7706           assert( ExprUseXList(pAggInfo->aFunc[0].pFExpr) );
7707           pDistinct = pAggInfo->aFunc[0].pFExpr->x.pList;
7708           distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
7709         }
7710 
7711         /* This case runs if the aggregate has no GROUP BY clause.  The
7712         ** processing is much simpler since there is only a single row
7713         ** of output.
7714         */
7715         assert( p->pGroupBy==0 );
7716         resetAccumulator(pParse, pAggInfo);
7717 
7718         /* If this query is a candidate for the min/max optimization, then
7719         ** minMaxFlag will have been previously set to either
7720         ** WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX and pMinMaxOrderBy will
7721         ** be an appropriate ORDER BY expression for the optimization.
7722         */
7723         assert( minMaxFlag==WHERE_ORDERBY_NORMAL || pMinMaxOrderBy!=0 );
7724         assert( pMinMaxOrderBy==0 || pMinMaxOrderBy->nExpr==1 );
7725 
7726         SELECTTRACE(1,pParse,p,("WhereBegin\n"));
7727         pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMaxOrderBy,
7728                                    pDistinct, 0, minMaxFlag|distFlag, 0);
7729         if( pWInfo==0 ){
7730           goto select_end;
7731         }
7732         SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
7733         eDist = sqlite3WhereIsDistinct(pWInfo);
7734         updateAccumulator(pParse, regAcc, pAggInfo, eDist);
7735         if( eDist!=WHERE_DISTINCT_NOOP ){
7736           struct AggInfo_func *pF = pAggInfo->aFunc;
7737           if( pF ){
7738             fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7739           }
7740         }
7741 
7742         if( regAcc ) sqlite3VdbeAddOp2(v, OP_Integer, 1, regAcc);
7743         if( minMaxFlag ){
7744           sqlite3WhereMinMaxOptEarlyOut(v, pWInfo);
7745         }
7746         SELECTTRACE(1,pParse,p,("WhereEnd\n"));
7747         sqlite3WhereEnd(pWInfo);
7748         finalizeAggFunctions(pParse, pAggInfo);
7749       }
7750 
7751       sSort.pOrderBy = 0;
7752       sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
7753       selectInnerLoop(pParse, p, -1, 0, 0,
7754                       pDest, addrEnd, addrEnd);
7755     }
7756     sqlite3VdbeResolveLabel(v, addrEnd);
7757 
7758   } /* endif aggregate query */
7759 
7760   if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
7761     explainTempTable(pParse, "DISTINCT");
7762   }
7763 
7764   /* If there is an ORDER BY clause, then we need to sort the results
7765   ** and send them to the callback one by one.
7766   */
7767   if( sSort.pOrderBy ){
7768     explainTempTable(pParse,
7769                      sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
7770     assert( p->pEList==pEList );
7771     generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
7772   }
7773 
7774   /* Jump here to skip this query
7775   */
7776   sqlite3VdbeResolveLabel(v, iEnd);
7777 
7778   /* The SELECT has been coded. If there is an error in the Parse structure,
7779   ** set the return code to 1. Otherwise 0. */
7780   rc = (pParse->nErr>0);
7781 
7782   /* Control jumps to here if an error is encountered above, or upon
7783   ** successful coding of the SELECT.
7784   */
7785 select_end:
7786   assert( db->mallocFailed==0 || db->mallocFailed==1 );
7787   assert( db->mallocFailed==0 || pParse->nErr!=0 );
7788   sqlite3ExprListDelete(db, pMinMaxOrderBy);
7789 #ifdef SQLITE_DEBUG
7790   if( pAggInfo && !db->mallocFailed ){
7791     for(i=0; i<pAggInfo->nColumn; i++){
7792       Expr *pExpr = pAggInfo->aCol[i].pCExpr;
7793       assert( pExpr!=0 );
7794       assert( pExpr->pAggInfo==pAggInfo );
7795       assert( pExpr->iAgg==i );
7796     }
7797     for(i=0; i<pAggInfo->nFunc; i++){
7798       Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
7799       assert( pExpr!=0 );
7800       assert( pExpr->pAggInfo==pAggInfo );
7801       assert( pExpr->iAgg==i );
7802     }
7803   }
7804 #endif
7805 
7806 #if TREETRACE_ENABLED
7807   SELECTTRACE(0x1,pParse,p,("end processing\n"));
7808   if( (sqlite3TreeTrace & 0x2000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
7809     sqlite3TreeViewSelect(0, p, 0);
7810   }
7811 #endif
7812   ExplainQueryPlanPop(pParse);
7813   return rc;
7814 }
7815