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