blob: 187beac7fb24d56f779e6f2103cd28fac2512743 [file] [log] [blame]
drhcce7d172000-05-31 15:34:51 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drhcce7d172000-05-31 15:34:51 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drhcce7d172000-05-31 15:34:51 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** 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.
drhcce7d172000-05-31 15:34:51 +000010**
11*************************************************************************
12** This file contains C code routines that are called by the parser
drhb19a2bc2001-09-16 00:13:26 +000013** to handle SELECT statements in SQLite.
drhcce7d172000-05-31 15:34:51 +000014*/
15#include "sqliteInt.h"
16
drh079a3072014-03-19 14:10:55 +000017/*
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.
drheda639e2006-01-22 00:42:09 +000021*/
drh079a3072014-03-19 14:10:55 +000022typedef struct DistinctCtx DistinctCtx;
23struct DistinctCtx {
drhd6df8552022-03-17 18:03:08 +000024 u8 isTnct; /* 0: Not distinct. 1: DISTICT 2: DISTINCT and ORDER BY */
drh079a3072014-03-19 14:10:55 +000025 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.
dan24e25d32018-04-14 18:46:20 +000033**
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.
drh079a3072014-03-19 14:10:55 +000047*/
48typedef struct SortCtx SortCtx;
49struct 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 */
drha04a8be2016-01-13 17:50:10 +000056 int labelDone; /* Jump here when done, ex: LIMIT reached */
drh6ee5a7b2018-09-08 20:09:46 +000057 int labelOBLopt; /* Jump here when sorter is full */
drh079a3072014-03-19 14:10:55 +000058 u8 sortFlags; /* Zero or more SORTFLAG_* bits */
dan24e25d32018-04-14 18:46:20 +000059#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
drhbbd4ae52018-04-30 19:32:49 +000067 struct RowLoadInfo *pDeferredRowLoad; /* Deferred row loading info or NULL */
drh079a3072014-03-19 14:10:55 +000068};
69#define SORTFLAG_UseSorter 0x01 /* Use SorterOpen instead of OpenEphemeral */
drh315555c2002-10-20 15:53:03 +000070
drhcce7d172000-05-31 15:34:51 +000071/*
drhb87fbed2015-01-05 15:48:45 +000072** Delete all the content of a Select structure. Deallocate the structure
drha9ebfe22019-12-25 23:54:21 +000073** 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
drheda639e2006-01-22 00:42:09 +000077*/
drhb87fbed2015-01-05 15:48:45 +000078static void clearSelect(sqlite3 *db, Select *p, int bFree){
drh41ce47c2022-08-22 02:00:26 +000079 assert( db!=0 );
drhb87fbed2015-01-05 15:48:45 +000080 while( p ){
81 Select *pPrior = p->pPrior;
82 sqlite3ExprListDelete(db, p->pEList);
83 sqlite3SrcListDelete(db, p->pSrc);
84 sqlite3ExprDelete(db, p->pWhere);
85 sqlite3ExprListDelete(db, p->pGroupBy);
86 sqlite3ExprDelete(db, p->pHaving);
87 sqlite3ExprListDelete(db, p->pOrderBy);
88 sqlite3ExprDelete(db, p->pLimit);
dan50f9f6c2021-03-04 14:18:22 +000089 if( OK_IF_ALWAYS_TRUE(p->pWith) ) sqlite3WithDelete(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +000090#ifndef SQLITE_OMIT_WINDOWFUNC
dane3bf6322018-06-08 20:58:27 +000091 if( OK_IF_ALWAYS_TRUE(p->pWinDefn) ){
92 sqlite3WindowListDelete(db, p->pWinDefn);
93 }
dan50f9f6c2021-03-04 14:18:22 +000094 while( p->pWin ){
95 assert( p->pWin->ppThis==&p->pWin );
96 sqlite3WindowUnlinkFromSelect(p->pWin);
97 }
dan67a9b8e2018-06-22 20:51:35 +000098#endif
drh41ce47c2022-08-22 02:00:26 +000099 if( bFree ) sqlite3DbNNFreeNN(db, p);
drhb87fbed2015-01-05 15:48:45 +0000100 p = pPrior;
101 bFree = 1;
102 }
drheda639e2006-01-22 00:42:09 +0000103}
104
drh1013c932008-01-06 00:25:21 +0000105/*
106** Initialize a SelectDest structure.
107*/
108void sqlite3SelectDestInit(SelectDest *pDest, int eDest, int iParm){
drhea678832008-12-10 19:26:22 +0000109 pDest->eDest = (u8)eDest;
drh2b596da2012-07-23 21:43:19 +0000110 pDest->iSDParm = iParm;
dan9ed322d2020-04-29 17:41:29 +0000111 pDest->iSDParm2 = 0;
dan71c57db2016-07-09 20:23:55 +0000112 pDest->zAffSdst = 0;
drh2b596da2012-07-23 21:43:19 +0000113 pDest->iSdst = 0;
114 pDest->nSdst = 0;
drh1013c932008-01-06 00:25:21 +0000115}
116
drheda639e2006-01-22 00:42:09 +0000117
118/*
drh9bb61fe2000-06-05 16:01:39 +0000119** Allocate a new Select structure and return a pointer to that
120** structure.
drhcce7d172000-05-31 15:34:51 +0000121*/
danielk19774adee202004-05-08 08:23:19 +0000122Select *sqlite3SelectNew(
drh17435752007-08-16 04:30:38 +0000123 Parse *pParse, /* Parsing context */
drhdaffd0e2001-04-11 14:28:42 +0000124 ExprList *pEList, /* which columns to include in the result */
drhad3cab52002-05-24 02:04:32 +0000125 SrcList *pSrc, /* the FROM clause -- which tables to scan */
drhdaffd0e2001-04-11 14:28:42 +0000126 Expr *pWhere, /* the WHERE clause */
127 ExprList *pGroupBy, /* the GROUP BY clause */
128 Expr *pHaving, /* the HAVING clause */
129 ExprList *pOrderBy, /* the ORDER BY clause */
drhc3489bb2016-02-25 16:04:59 +0000130 u32 selFlags, /* Flag parameters, such as SF_Distinct */
drh8c0833f2017-11-14 23:48:23 +0000131 Expr *pLimit /* LIMIT value. NULL means not used */
drh9bb61fe2000-06-05 16:01:39 +0000132){
drhd3bf7662020-05-25 01:31:09 +0000133 Select *pNew, *pAllocated;
drheda639e2006-01-22 00:42:09 +0000134 Select standin;
drhd3bf7662020-05-25 01:31:09 +0000135 pAllocated = pNew = sqlite3DbMallocRawNN(pParse->db, sizeof(*pNew) );
drhdaffd0e2001-04-11 14:28:42 +0000136 if( pNew==0 ){
drhef90a6b2017-04-11 16:44:39 +0000137 assert( pParse->db->mallocFailed );
drheda639e2006-01-22 00:42:09 +0000138 pNew = &standin;
drheda639e2006-01-22 00:42:09 +0000139 }
140 if( pEList==0 ){
drh3d240d22017-09-28 16:56:55 +0000141 pEList = sqlite3ExprListAppend(pParse, 0,
142 sqlite3Expr(pParse->db,TK_ASTERISK,0));
drheda639e2006-01-22 00:42:09 +0000143 }
144 pNew->pEList = pEList;
drhca3862d2016-01-08 12:46:39 +0000145 pNew->op = TK_SELECT;
146 pNew->selFlags = selFlags;
147 pNew->iLimit = 0;
148 pNew->iOffset = 0;
drhfef37762018-07-10 19:48:35 +0000149 pNew->selId = ++pParse->nSelect;
drhca3862d2016-01-08 12:46:39 +0000150 pNew->addrOpenEphm[0] = -1;
151 pNew->addrOpenEphm[1] = -1;
152 pNew->nSelectRow = 0;
drhef90a6b2017-04-11 16:44:39 +0000153 if( pSrc==0 ) pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*pSrc));
drheda639e2006-01-22 00:42:09 +0000154 pNew->pSrc = pSrc;
155 pNew->pWhere = pWhere;
156 pNew->pGroupBy = pGroupBy;
157 pNew->pHaving = pHaving;
158 pNew->pOrderBy = pOrderBy;
drhca3862d2016-01-08 12:46:39 +0000159 pNew->pPrior = 0;
160 pNew->pNext = 0;
drheda639e2006-01-22 00:42:09 +0000161 pNew->pLimit = pLimit;
drhca3862d2016-01-08 12:46:39 +0000162 pNew->pWith = 0;
dan67a9b8e2018-06-22 20:51:35 +0000163#ifndef SQLITE_OMIT_WINDOWFUNC
dan86fb6e12018-05-16 20:58:07 +0000164 pNew->pWin = 0;
dane3bf6322018-06-08 20:58:27 +0000165 pNew->pWinDefn = 0;
dan67a9b8e2018-06-22 20:51:35 +0000166#endif
drhef90a6b2017-04-11 16:44:39 +0000167 if( pParse->db->mallocFailed ) {
168 clearSelect(pParse->db, pNew, pNew!=&standin);
drhd3bf7662020-05-25 01:31:09 +0000169 pAllocated = 0;
drha464c232011-09-16 19:04:03 +0000170 }else{
171 assert( pNew->pSrc!=0 || pParse->nErr>0 );
drhdaffd0e2001-04-11 14:28:42 +0000172 }
drhd3bf7662020-05-25 01:31:09 +0000173 return pAllocated;
drh9bb61fe2000-06-05 16:01:39 +0000174}
175
drheb9b8842014-09-21 00:27:26 +0000176
drh9bb61fe2000-06-05 16:01:39 +0000177/*
drheda639e2006-01-22 00:42:09 +0000178** Delete the given Select structure and all of its substructures.
179*/
drh633e6d52008-07-28 19:34:53 +0000180void sqlite3SelectDelete(sqlite3 *db, Select *p){
drh8906a4b2017-10-03 17:29:40 +0000181 if( OK_IF_ALWAYS_TRUE(p) ) clearSelect(db, p, 1);
drheda639e2006-01-22 00:42:09 +0000182}
183
184/*
drhd227a292014-02-09 18:02:09 +0000185** Return a pointer to the right-most SELECT statement in a compound.
186*/
187static Select *findRightmost(Select *p){
188 while( p->pNext ) p = p->pNext;
189 return p;
drh9bb61fe2000-06-05 16:01:39 +0000190}
191
192/*
drhf7b54962013-05-28 12:11:54 +0000193** Given 1 to 3 identifiers preceding the JOIN keyword, determine the
drh01f3f252002-05-24 16:14:15 +0000194** type of join. Return an integer constant that expresses that type
195** in terms of the following bit values:
196**
197** JT_INNER
drh3dec2232005-09-10 15:28:09 +0000198** JT_CROSS
drh01f3f252002-05-24 16:14:15 +0000199** JT_OUTER
200** JT_NATURAL
201** JT_LEFT
202** JT_RIGHT
203**
204** A full outer join is the combination of JT_LEFT and JT_RIGHT.
205**
206** If an illegal or unsupported join type is seen, then still return
207** a join type, but put an error in the pParse structure.
drh81a23622022-04-08 15:11:10 +0000208**
209** These are the valid join types:
210**
211**
212** pA pB pC Return Value
213** ------- ----- ----- ------------
214** CROSS - - JT_CROSS
215** INNER - - JT_INNER
216** LEFT - - JT_LEFT|JT_OUTER
217** LEFT OUTER - JT_LEFT|JT_OUTER
218** RIGHT - - JT_RIGHT|JT_OUTER
219** RIGHT OUTER - JT_RIGHT|JT_OUTER
220** FULL - - JT_LEFT|JT_RIGHT|JT_OUTER
221** FULL OUTER - JT_LEFT|JT_RIGHT|JT_OUTER
222** NATURAL INNER - JT_NATURAL|JT_INNER
223** NATURAL LEFT - JT_NATURAL|JT_LEFT|JT_OUTER
224** NATURAL LEFT OUTER JT_NATURAL|JT_LEFT|JT_OUTER
225** NATURAL RIGHT - JT_NATURAL|JT_RIGHT|JT_OUTER
226** NATURAL RIGHT OUTER JT_NATURAL|JT_RIGHT|JT_OUTER
227** NATURAL FULL - JT_NATURAL|JT_LEFT|JT_RIGHT
228** NATURAL FULL OUTER JT_NATRUAL|JT_LEFT|JT_RIGHT
229**
230** To preserve historical compatibly, SQLite also accepts a variety
231** of other non-standard and in many cases non-sensical join types.
232** This routine makes as much sense at it can from the nonsense join
233** type and returns a result. Examples of accepted nonsense join types
234** include but are not limited to:
235**
236** INNER CROSS JOIN -> same as JOIN
237** NATURAL CROSS JOIN -> same as NATURAL JOIN
238** OUTER LEFT JOIN -> same as LEFT JOIN
239** LEFT NATURAL JOIN -> same as NATURAL LEFT JOIN
240** LEFT RIGHT JOIN -> same as FULL JOIN
241** RIGHT OUTER FULL JOIN -> same as FULL JOIN
242** CROSS CROSS CROSS JOIN -> same as JOIN
243**
244** The only restrictions on the join type name are:
245**
246** * "INNER" cannot appear together with "OUTER", "LEFT", "RIGHT",
247** or "FULL".
248**
249** * "CROSS" cannot appear together with "OUTER", "LEFT", "RIGHT,
250** or "FULL".
251**
252** * If "OUTER" is present then there must also be one of
253** "LEFT", "RIGHT", or "FULL"
drh01f3f252002-05-24 16:14:15 +0000254*/
danielk19774adee202004-05-08 08:23:19 +0000255int sqlite3JoinType(Parse *pParse, Token *pA, Token *pB, Token *pC){
drh01f3f252002-05-24 16:14:15 +0000256 int jointype = 0;
257 Token *apAll[3];
258 Token *p;
drh373cc2d2009-05-17 02:06:14 +0000259 /* 0123456789 123456789 123456789 123 */
260 static const char zKeyText[] = "naturaleftouterightfullinnercross";
drh57196282004-10-06 15:41:16 +0000261 static const struct {
drh373cc2d2009-05-17 02:06:14 +0000262 u8 i; /* Beginning of keyword text in zKeyText[] */
263 u8 nChar; /* Length of the keyword in characters */
264 u8 code; /* Join type mask */
265 } aKeyword[] = {
drh81a23622022-04-08 15:11:10 +0000266 /* (0) natural */ { 0, 7, JT_NATURAL },
267 /* (1) left */ { 6, 4, JT_LEFT|JT_OUTER },
268 /* (2) outer */ { 10, 5, JT_OUTER },
269 /* (3) right */ { 14, 5, JT_RIGHT|JT_OUTER },
270 /* (4) full */ { 19, 4, JT_LEFT|JT_RIGHT|JT_OUTER },
271 /* (5) inner */ { 23, 5, JT_INNER },
272 /* (6) cross */ { 28, 5, JT_INNER|JT_CROSS },
drh01f3f252002-05-24 16:14:15 +0000273 };
274 int i, j;
275 apAll[0] = pA;
276 apAll[1] = pB;
277 apAll[2] = pC;
drh195e6962002-05-25 00:18:20 +0000278 for(i=0; i<3 && apAll[i]; i++){
drh01f3f252002-05-24 16:14:15 +0000279 p = apAll[i];
drh373cc2d2009-05-17 02:06:14 +0000280 for(j=0; j<ArraySize(aKeyword); j++){
281 if( p->n==aKeyword[j].nChar
282 && sqlite3StrNICmp((char*)p->z, &zKeyText[aKeyword[j].i], p->n)==0 ){
283 jointype |= aKeyword[j].code;
drh01f3f252002-05-24 16:14:15 +0000284 break;
285 }
286 }
drh373cc2d2009-05-17 02:06:14 +0000287 testcase( j==0 || j==1 || j==2 || j==3 || j==4 || j==5 || j==6 );
288 if( j>=ArraySize(aKeyword) ){
drh01f3f252002-05-24 16:14:15 +0000289 jointype |= JT_ERROR;
290 break;
291 }
292 }
drhad2d8302002-05-24 20:31:36 +0000293 if(
294 (jointype & (JT_INNER|JT_OUTER))==(JT_INNER|JT_OUTER) ||
drh81a23622022-04-08 15:11:10 +0000295 (jointype & JT_ERROR)!=0 ||
296 (jointype & (JT_OUTER|JT_LEFT|JT_RIGHT))==JT_OUTER
drhad2d8302002-05-24 20:31:36 +0000297 ){
drh81a23622022-04-08 15:11:10 +0000298 const char *zSp1 = " ";
299 const char *zSp2 = " ";
300 if( pB==0 ){ zSp1++; }
301 if( pC==0 ){ zSp2++; }
drh0879d5f2022-04-12 18:40:14 +0000302 sqlite3ErrorMsg(pParse, "unknown join type: "
drh81a23622022-04-08 15:11:10 +0000303 "%T%s%T%s%T", pA, zSp1, pB, zSp2, pC);
drh01f3f252002-05-24 16:14:15 +0000304 jointype = JT_INNER;
305 }
306 return jointype;
307}
308
309/*
drhad2d8302002-05-24 20:31:36 +0000310** Return the index of a column in a table. Return -1 if the column
311** is not contained in the table.
312*/
dan6e6d9832021-02-16 20:43:36 +0000313int sqlite3ColumnIndex(Table *pTab, const char *zCol){
drhad2d8302002-05-24 20:31:36 +0000314 int i;
drha1928072020-07-20 13:11:19 +0000315 u8 h = sqlite3StrIHash(zCol);
316 Column *pCol;
317 for(pCol=pTab->aCol, i=0; i<pTab->nCol; pCol++, i++){
drhcf9d36d2021-08-02 18:03:43 +0000318 if( pCol->hName==h && sqlite3StrICmp(pCol->zCnName, zCol)==0 ) return i;
drhad2d8302002-05-24 20:31:36 +0000319 }
320 return -1;
321}
322
323/*
drh815b7822022-04-20 15:07:39 +0000324** Mark a subquery result column as having been used.
325*/
326void sqlite3SrcItemColumnUsed(SrcItem *pItem, int iCol){
327 assert( pItem!=0 );
mistachkin07fae322022-07-06 23:50:01 +0000328 assert( (int)pItem->fg.isNestedFrom == IsNestedFrom(pItem->pSelect) );
drh815b7822022-04-20 15:07:39 +0000329 if( pItem->fg.isNestedFrom ){
330 ExprList *pResults;
331 assert( pItem->pSelect!=0 );
332 pResults = pItem->pSelect->pEList;
333 assert( pResults!=0 );
334 assert( iCol>=0 && iCol<pResults->nExpr );
drhd88fd532022-05-02 20:49:30 +0000335 pResults->a[iCol].fg.bUsed = 1;
drh815b7822022-04-20 15:07:39 +0000336 }
337}
338
339/*
drhfe146992022-04-17 18:46:17 +0000340** Search the tables iStart..iEnd (inclusive) in pSrc, looking for a
341** table that has a column named zCol. The search is left-to-right.
342** The first match found is returned.
drh2179b432009-12-09 17:36:39 +0000343**
344** When found, set *piTab and *piCol to the table index and column index
345** of the matching column and return TRUE.
346**
347** If not found, return FALSE.
348*/
349static int tableAndColumnIndex(
350 SrcList *pSrc, /* Array of tables to search */
drhfe146992022-04-17 18:46:17 +0000351 int iStart, /* First member of pSrc->a[] to check */
352 int iEnd, /* Last member of pSrc->a[] to check */
drh2179b432009-12-09 17:36:39 +0000353 const char *zCol, /* Name of the column we are looking for */
354 int *piTab, /* Write index of pSrc->a[] here */
dan9d41af22019-12-30 14:32:27 +0000355 int *piCol, /* Write index of pSrc->a[*piTab].pTab->aCol[] here */
drhfe146992022-04-17 18:46:17 +0000356 int bIgnoreHidden /* Ignore hidden columns */
drh2179b432009-12-09 17:36:39 +0000357){
358 int i; /* For looping over tables in pSrc */
359 int iCol; /* Index of column matching zCol */
360
drhfe146992022-04-17 18:46:17 +0000361 assert( iEnd<pSrc->nSrc );
362 assert( iStart>=0 );
drh2179b432009-12-09 17:36:39 +0000363 assert( (piTab==0)==(piCol==0) ); /* Both or neither are NULL */
drhfe146992022-04-17 18:46:17 +0000364
365 for(i=iStart; i<=iEnd; i++){
dan6e6d9832021-02-16 20:43:36 +0000366 iCol = sqlite3ColumnIndex(pSrc->a[i].pTab, zCol);
dan9d41af22019-12-30 14:32:27 +0000367 if( iCol>=0
368 && (bIgnoreHidden==0 || IsHiddenColumn(&pSrc->a[i].pTab->aCol[iCol])==0)
369 ){
drh2179b432009-12-09 17:36:39 +0000370 if( piTab ){
drh815b7822022-04-20 15:07:39 +0000371 sqlite3SrcItemColumnUsed(&pSrc->a[i], iCol);
drh2179b432009-12-09 17:36:39 +0000372 *piTab = i;
373 *piCol = iCol;
374 }
drhfe146992022-04-17 18:46:17 +0000375 return 1;
drh2179b432009-12-09 17:36:39 +0000376 }
377 }
drhfe146992022-04-17 18:46:17 +0000378 return 0;
drhad2d8302002-05-24 20:31:36 +0000379}
380
381/*
drh67a99db2022-05-13 14:52:04 +0000382** Set the EP_OuterON property on all terms of the given expression.
drhd1985262022-04-11 11:25:28 +0000383** And set the Expr.w.iJoin to iTable for every term in the
drh22d6a532005-09-19 21:05:48 +0000384** expression.
drh1cc093c2002-06-24 22:01:57 +0000385**
drh67a99db2022-05-13 14:52:04 +0000386** The EP_OuterON property is used on terms of an expression to tell
drhb77c07a2022-04-11 11:59:25 +0000387** the OUTER JOIN processing logic that this term is part of the
drh1f162302002-10-27 19:35:33 +0000388** join restriction specified in the ON or USING clause and not a part
389** of the more general WHERE clause. These terms are moved over to the
390** WHERE clause during join processing but we need to remember that they
391** originated in the ON or USING clause.
drh22d6a532005-09-19 21:05:48 +0000392**
drhd1985262022-04-11 11:25:28 +0000393** The Expr.w.iJoin tells the WHERE clause processing that the
394** expression depends on table w.iJoin even if that table is not
drh22d6a532005-09-19 21:05:48 +0000395** explicitly mentioned in the expression. That information is needed
396** for cases like this:
397**
398** SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.b AND t1.x=5
399**
400** The where clause needs to defer the handling of the t1.x=5
401** term until after the t2 loop of the join. In that way, a
402** NULL t2 row will be inserted whenever t1.x!=5. If we do not
403** defer the handling of t1.x=5, it will be processed immediately
404** after the t1 loop and rows with t1.x!=5 will never appear in
405** the output, which is incorrect.
drh1cc093c2002-06-24 22:01:57 +0000406*/
drh3a6e4c52022-04-11 12:38:06 +0000407void sqlite3SetJoinExpr(Expr *p, int iTable, u32 joinFlag){
drh67a99db2022-05-13 14:52:04 +0000408 assert( joinFlag==EP_OuterON || joinFlag==EP_InnerON );
drh1cc093c2002-06-24 22:01:57 +0000409 while( p ){
drh3a6e4c52022-04-11 12:38:06 +0000410 ExprSetProperty(p, joinFlag);
drhc5cd1242013-09-12 16:50:49 +0000411 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +0000412 ExprSetVVAProperty(p, EP_NoReduce);
drhd1985262022-04-11 11:25:28 +0000413 p->w.iJoin = iTable;
drha4eeccd2021-10-07 17:43:30 +0000414 if( p->op==TK_FUNCTION ){
415 assert( ExprUseXList(p) );
416 if( p->x.pList ){
417 int i;
418 for(i=0; i<p->x.pList->nExpr; i++){
drh3a6e4c52022-04-11 12:38:06 +0000419 sqlite3SetJoinExpr(p->x.pList->a[i].pExpr, iTable, joinFlag);
drha4eeccd2021-10-07 17:43:30 +0000420 }
drh606f2342015-06-18 14:32:51 +0000421 }
422 }
drh3a6e4c52022-04-11 12:38:06 +0000423 sqlite3SetJoinExpr(p->pLeft, iTable, joinFlag);
drh1cc093c2002-06-24 22:01:57 +0000424 p = p->pRight;
425 }
426}
427
drhd7480402022-06-20 17:04:44 +0000428/* Undo the work of sqlite3SetJoinExpr(). This is used when a LEFT JOIN
429** is simplified into an ordinary JOIN, and when an ON expression is
430** "pushed down" into the WHERE clause of a subquery.
drh25897872018-03-20 21:16:15 +0000431**
drhd7480402022-06-20 17:04:44 +0000432** Convert every term that is marked with EP_OuterON and w.iJoin==iTable into
433** an ordinary term that omits the EP_OuterON mark. Or if iTable<0, then
434** just clear every EP_OuterON and EP_InnerON mark from the expression tree.
drh92d1afb2022-06-13 12:42:24 +0000435**
436** If nullable is true, that means that Expr p might evaluate to NULL even
437** if it is a reference to a NOT NULL column. This can happen, for example,
438** if the table that p references is on the left side of a RIGHT JOIN.
439** If nullable is true, then take care to not remove the EP_CanBeNull bit.
440** See forum thread https://sqlite.org/forum/forumpost/b40696f50145d21c
drh25897872018-03-20 21:16:15 +0000441*/
drh92d1afb2022-06-13 12:42:24 +0000442static void unsetJoinExpr(Expr *p, int iTable, int nullable){
drh25897872018-03-20 21:16:15 +0000443 while( p ){
drhd7480402022-06-20 17:04:44 +0000444 if( iTable<0 || (ExprHasProperty(p, EP_OuterON) && p->w.iJoin==iTable) ){
445 ExprClearProperty(p, EP_OuterON|EP_InnerON);
446 if( iTable>=0 ) ExprSetProperty(p, EP_InnerON);
drh25897872018-03-20 21:16:15 +0000447 }
drh92d1afb2022-06-13 12:42:24 +0000448 if( p->op==TK_COLUMN && p->iTable==iTable && !nullable ){
dan8ddf6862021-02-26 20:14:32 +0000449 ExprClearProperty(p, EP_CanBeNull);
450 }
drha4eeccd2021-10-07 17:43:30 +0000451 if( p->op==TK_FUNCTION ){
452 assert( ExprUseXList(p) );
453 if( p->x.pList ){
454 int i;
455 for(i=0; i<p->x.pList->nExpr; i++){
drh92d1afb2022-06-13 12:42:24 +0000456 unsetJoinExpr(p->x.pList->a[i].pExpr, iTable, nullable);
drha4eeccd2021-10-07 17:43:30 +0000457 }
drh25897872018-03-20 21:16:15 +0000458 }
459 }
drh92d1afb2022-06-13 12:42:24 +0000460 unsetJoinExpr(p->pLeft, iTable, nullable);
drh25897872018-03-20 21:16:15 +0000461 p = p->pRight;
462 }
463}
464
drh1cc093c2002-06-24 22:01:57 +0000465/*
drhad2d8302002-05-24 20:31:36 +0000466** This routine processes the join information for a SELECT statement.
drhbc656e22022-04-20 16:26:22 +0000467**
468** * A NATURAL join is converted into a USING join. After that, we
469** do not need to be concerned with NATURAL joins and we only have
470** think about USING joins.
471**
472** * ON and USING clauses result in extra terms being added to the
473** WHERE clause to enforce the specified constraints. The extra
drh67a99db2022-05-13 14:52:04 +0000474** WHERE clause terms will be tagged with EP_OuterON or
475** EP_InnerON so that we know that they originated in ON/USING.
drhad2d8302002-05-24 20:31:36 +0000476**
drh91bb0ee2004-09-01 03:06:34 +0000477** The terms of a FROM clause are contained in the Select.pSrc structure.
478** The left most table is the first entry in Select.pSrc. The right-most
479** table is the last entry. The join operator is held in the entry to
drhbc656e22022-04-20 16:26:22 +0000480** the right. Thus entry 1 contains the join operator for the join between
drh91bb0ee2004-09-01 03:06:34 +0000481** entries 0 and 1. Any ON or USING clauses associated with the join are
drhbc656e22022-04-20 16:26:22 +0000482** also attached to the right entry.
drh91bb0ee2004-09-01 03:06:34 +0000483**
drhad2d8302002-05-24 20:31:36 +0000484** This routine returns the number of errors encountered.
485*/
drh358424a2022-04-15 15:15:01 +0000486static int sqlite3ProcessJoin(Parse *pParse, Select *p){
drh91bb0ee2004-09-01 03:06:34 +0000487 SrcList *pSrc; /* All tables in the FROM clause */
488 int i, j; /* Loop counters */
drh76012942021-02-21 21:04:54 +0000489 SrcItem *pLeft; /* Left table being joined */
490 SrcItem *pRight; /* Right table being joined */
drhad2d8302002-05-24 20:31:36 +0000491
drh91bb0ee2004-09-01 03:06:34 +0000492 pSrc = p->pSrc;
493 pLeft = &pSrc->a[0];
494 pRight = &pLeft[1];
495 for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
drh91bb0ee2004-09-01 03:06:34 +0000496 Table *pRightTab = pRight->pTab;
drh3a6e4c52022-04-11 12:38:06 +0000497 u32 joinType;
drh91bb0ee2004-09-01 03:06:34 +0000498
drhce2c4822017-10-03 17:17:34 +0000499 if( NEVER(pLeft->pTab==0 || pRightTab==0) ) continue;
drh67a99db2022-05-13 14:52:04 +0000500 joinType = (pRight->fg.jointype & JT_OUTER)!=0 ? EP_OuterON : EP_InnerON;
drhad2d8302002-05-24 20:31:36 +0000501
drh22c4bc82022-04-15 17:08:40 +0000502 /* If this is a NATURAL join, synthesize an approprate USING clause
503 ** to specify which columns should be joined.
drhad2d8302002-05-24 20:31:36 +0000504 */
drh8a48b9c2015-08-19 15:20:00 +0000505 if( pRight->fg.jointype & JT_NATURAL ){
drh22c4bc82022-04-15 17:08:40 +0000506 IdList *pUsing = 0;
drhd44f8b22022-04-07 01:11:13 +0000507 if( pRight->fg.isUsing || pRight->u3.pOn ){
danielk19774adee202004-05-08 08:23:19 +0000508 sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
drhad2d8302002-05-24 20:31:36 +0000509 "an ON or USING clause", 0);
drhad2d8302002-05-24 20:31:36 +0000510 return 1;
511 }
drh2179b432009-12-09 17:36:39 +0000512 for(j=0; j<pRightTab->nCol; j++){
513 char *zName; /* Name of column in the right table */
drh2179b432009-12-09 17:36:39 +0000514
dan9d41af22019-12-30 14:32:27 +0000515 if( IsHiddenColumn(&pRightTab->aCol[j]) ) continue;
drhcf9d36d2021-08-02 18:03:43 +0000516 zName = pRightTab->aCol[j].zCnName;
drhfe146992022-04-17 18:46:17 +0000517 if( tableAndColumnIndex(pSrc, 0, i, zName, 0, 0, 1) ){
drhd0453f72022-04-18 00:04:15 +0000518 pUsing = sqlite3IdListAppend(pParse, pUsing, 0);
519 if( pUsing ){
520 assert( pUsing->nId>0 );
521 assert( pUsing->a[pUsing->nId-1].zName==0 );
522 pUsing->a[pUsing->nId-1].zName = sqlite3DbStrDup(pParse->db, zName);
523 }
drhad2d8302002-05-24 20:31:36 +0000524 }
525 }
drh22c4bc82022-04-15 17:08:40 +0000526 if( pUsing ){
527 pRight->fg.isUsing = 1;
drh4ce7bf92022-04-15 18:30:48 +0000528 pRight->fg.isSynthUsing = 1;
drh22c4bc82022-04-15 17:08:40 +0000529 pRight->u3.pUsing = pUsing;
530 }
drhabf86bd2022-04-18 09:59:33 +0000531 if( pParse->nErr ) return 1;
drhad2d8302002-05-24 20:31:36 +0000532 }
533
drhad2d8302002-05-24 20:31:36 +0000534 /* Create extra terms on the WHERE clause for each column named
535 ** in the USING clause. Example: If the two tables to be joined are
536 ** A and B and the USING clause names X, Y, and Z, then add this
537 ** to the WHERE clause: A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
538 ** Report an error if any column mentioned in the USING clause is
539 ** not contained in both tables to be joined.
540 */
drhd44f8b22022-04-07 01:11:13 +0000541 if( pRight->fg.isUsing ){
542 IdList *pList = pRight->u3.pUsing;
drhfe146992022-04-17 18:46:17 +0000543 sqlite3 *db = pParse->db;
drhd44f8b22022-04-07 01:11:13 +0000544 assert( pList!=0 );
drhad2d8302002-05-24 20:31:36 +0000545 for(j=0; j<pList->nId; j++){
drh2179b432009-12-09 17:36:39 +0000546 char *zName; /* Name of the term in the USING clause */
547 int iLeft; /* Table on the left with matching column name */
548 int iLeftCol; /* Column number of matching column on the left */
549 int iRightCol; /* Column number of matching column on the right */
drhfe146992022-04-17 18:46:17 +0000550 Expr *pE1; /* Reference to the column on the LEFT of the join */
551 Expr *pE2; /* Reference to the column on the RIGHT of the join */
552 Expr *pEq; /* Equality constraint. pE1 == pE2 */
drh2179b432009-12-09 17:36:39 +0000553
554 zName = pList->a[j].zName;
dan6e6d9832021-02-16 20:43:36 +0000555 iRightCol = sqlite3ColumnIndex(pRightTab, zName);
drh2179b432009-12-09 17:36:39 +0000556 if( iRightCol<0
drhfe146992022-04-17 18:46:17 +0000557 || tableAndColumnIndex(pSrc, 0, i, zName, &iLeft, &iLeftCol,
558 pRight->fg.isSynthUsing)==0
drh2179b432009-12-09 17:36:39 +0000559 ){
danielk19774adee202004-05-08 08:23:19 +0000560 sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
drh91bb0ee2004-09-01 03:06:34 +0000561 "not present in both tables", zName);
drhad2d8302002-05-24 20:31:36 +0000562 return 1;
563 }
drhfe146992022-04-17 18:46:17 +0000564 pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iLeftCol);
drh22b410d2022-04-20 18:12:42 +0000565 sqlite3SrcItemColumnUsed(&pSrc->a[iLeft], iLeftCol);
drhfe146992022-04-17 18:46:17 +0000566 if( (pSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
567 /* This branch runs if the query contains one or more RIGHT or FULL
568 ** JOINs. If only a single table on the left side of this join
drhbc656e22022-04-20 16:26:22 +0000569 ** contains the zName column, then this branch is a no-op.
570 ** But if there are two or more tables on the left side
drhfe146992022-04-17 18:46:17 +0000571 ** of the join, construct a coalesce() function that gathers all
572 ** such tables. Raise an error if more than one of those references
573 ** to zName is not also within a prior USING clause.
574 **
575 ** We really ought to raise an error if there are two or more
576 ** non-USING references to zName on the left of an INNER or LEFT
577 ** JOIN. But older versions of SQLite do not do that, so we avoid
578 ** adding a new error so as to not break legacy applications.
drh052953a2022-04-16 22:57:41 +0000579 */
drhfe146992022-04-17 18:46:17 +0000580 ExprList *pFuncArgs = 0; /* Arguments to the coalesce() */
drh052953a2022-04-16 22:57:41 +0000581 static const Token tkCoalesce = { "coalesce", 8 };
drhfe146992022-04-17 18:46:17 +0000582 while( tableAndColumnIndex(pSrc, iLeft+1, i, zName, &iLeft, &iLeftCol,
583 pRight->fg.isSynthUsing)!=0 ){
584 if( pSrc->a[iLeft].fg.isUsing==0
585 || sqlite3IdListIndex(pSrc->a[iLeft].u3.pUsing, zName)<0
586 ){
587 sqlite3ErrorMsg(pParse, "ambiguous reference to %s in USING()",
588 zName);
589 break;
590 }
591 pFuncArgs = sqlite3ExprListAppend(pParse, pFuncArgs, pE1);
592 pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iLeftCol);
drh22b410d2022-04-20 18:12:42 +0000593 sqlite3SrcItemColumnUsed(&pSrc->a[iLeft], iLeftCol);
drh052953a2022-04-16 22:57:41 +0000594 }
drhfe146992022-04-17 18:46:17 +0000595 if( pFuncArgs ){
596 pFuncArgs = sqlite3ExprListAppend(pParse, pFuncArgs, pE1);
597 pE1 = sqlite3ExprFunction(pParse, pFuncArgs, &tkCoalesce, 0);
drh052953a2022-04-16 22:57:41 +0000598 }
drh052953a2022-04-16 22:57:41 +0000599 }
drhfe146992022-04-17 18:46:17 +0000600 pE2 = sqlite3CreateColumnExpr(db, pSrc, i+1, iRightCol);
drh815b7822022-04-20 15:07:39 +0000601 sqlite3SrcItemColumnUsed(pRight, iRightCol);
drhfe146992022-04-17 18:46:17 +0000602 pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2);
603 assert( pE2!=0 || pEq==0 );
604 if( pEq ){
605 ExprSetProperty(pEq, joinType);
606 assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
607 ExprSetVVAProperty(pEq, EP_NoReduce);
608 pEq->w.iJoin = pE2->iTable;
609 }
610 p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pEq);
drhad2d8302002-05-24 20:31:36 +0000611 }
612 }
drhd44f8b22022-04-07 01:11:13 +0000613
614 /* Add the ON clause to the end of the WHERE clause, connected by
615 ** an AND operator.
616 */
617 else if( pRight->u3.pOn ){
drh3a6e4c52022-04-11 12:38:06 +0000618 sqlite3SetJoinExpr(pRight->u3.pOn, pRight->iCursor, joinType);
drhd44f8b22022-04-07 01:11:13 +0000619 p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pRight->u3.pOn);
620 pRight->u3.pOn = 0;
drh5c118e32022-06-08 15:30:39 +0000621 pRight->fg.isOn = 1;
drhd44f8b22022-04-07 01:11:13 +0000622 }
drhad2d8302002-05-24 20:31:36 +0000623 }
624 return 0;
625}
626
627/*
drhbbd4ae52018-04-30 19:32:49 +0000628** An instance of this object holds information (beyond pParse and pSelect)
629** needed to load the next result row that is to be added to the sorter.
630*/
631typedef struct RowLoadInfo RowLoadInfo;
632struct RowLoadInfo {
633 int regResult; /* Store results in array of registers here */
634 u8 ecelFlags; /* Flag argument to ExprCodeExprList() */
635#ifdef SQLITE_ENABLE_SORTER_REFERENCES
636 ExprList *pExtra; /* Extra columns needed by sorter refs */
637 int regExtraResult; /* Where to load the extra columns */
638#endif
639};
640
641/*
642** This routine does the work of loading query data into an array of
643** registers so that it can be added to the sorter.
644*/
645static void innerLoopLoadRow(
646 Parse *pParse, /* Statement under construction */
647 Select *pSelect, /* The query being coded */
648 RowLoadInfo *pInfo /* Info needed to complete the row load */
649){
650 sqlite3ExprCodeExprList(pParse, pSelect->pEList, pInfo->regResult,
651 0, pInfo->ecelFlags);
652#ifdef SQLITE_ENABLE_SORTER_REFERENCES
653 if( pInfo->pExtra ){
654 sqlite3ExprCodeExprList(pParse, pInfo->pExtra, pInfo->regExtraResult, 0, 0);
655 sqlite3ExprListDelete(pParse->db, pInfo->pExtra);
656 }
657#endif
658}
659
660/*
661** Code the OP_MakeRecord instruction that generates the entry to be
662** added into the sorter.
663**
664** Return the register in which the result is stored.
665*/
666static int makeSorterRecord(
667 Parse *pParse,
668 SortCtx *pSort,
669 Select *pSelect,
670 int regBase,
671 int nBase
672){
673 int nOBSat = pSort->nOBSat;
674 Vdbe *v = pParse->pVdbe;
675 int regOut = ++pParse->nMem;
676 if( pSort->pDeferredRowLoad ){
677 innerLoopLoadRow(pParse, pSelect, pSort->pDeferredRowLoad);
678 }
679 sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regOut);
680 return regOut;
681}
682
683/*
drhf45f2322014-03-23 17:45:03 +0000684** Generate code that will push the record in registers regData
685** through regData+nData-1 onto the sorter.
drhc926afb2002-06-20 03:38:26 +0000686*/
drhd59ba6c2006-01-08 05:02:54 +0000687static void pushOntoSorter(
688 Parse *pParse, /* Parser context */
drh079a3072014-03-19 14:10:55 +0000689 SortCtx *pSort, /* Information about the ORDER BY clause */
drhb7654112008-01-12 12:48:07 +0000690 Select *pSelect, /* The whole SELECT statement */
drhf45f2322014-03-23 17:45:03 +0000691 int regData, /* First register holding data to be sorted */
drh5579d592015-08-26 14:01:41 +0000692 int regOrigData, /* First register holding data before packing */
drhbbd4ae52018-04-30 19:32:49 +0000693 int nData, /* Number of elements in the regData data array */
drhfd0a2f92014-03-24 18:08:15 +0000694 int nPrefixReg /* No. of reg prior to regData available for use */
drhd59ba6c2006-01-08 05:02:54 +0000695){
drhf45f2322014-03-23 17:45:03 +0000696 Vdbe *v = pParse->pVdbe; /* Stmt under construction */
dan78d58432014-03-25 15:04:07 +0000697 int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
drhf45f2322014-03-23 17:45:03 +0000698 int nExpr = pSort->pOrderBy->nExpr; /* No. of ORDER BY terms */
dan78d58432014-03-25 15:04:07 +0000699 int nBase = nExpr + bSeq + nData; /* Fields in sorter record */
drhfd0a2f92014-03-24 18:08:15 +0000700 int regBase; /* Regs for sorter record */
drhbbd4ae52018-04-30 19:32:49 +0000701 int regRecord = 0; /* Assembled sorter record */
dan78d58432014-03-25 15:04:07 +0000702 int nOBSat = pSort->nOBSat; /* ORDER BY terms to skip */
703 int op; /* Opcode to add sorter record to sorter */
drha04a8be2016-01-13 17:50:10 +0000704 int iLimit; /* LIMIT counter */
drhbbd4ae52018-04-30 19:32:49 +0000705 int iSkip = 0; /* End of the sorter insert loop */
drhf45f2322014-03-23 17:45:03 +0000706
dan78d58432014-03-25 15:04:07 +0000707 assert( bSeq==0 || bSeq==1 );
drhbbd4ae52018-04-30 19:32:49 +0000708
709 /* Three cases:
710 ** (1) The data to be sorted has already been packed into a Record
711 ** by a prior OP_MakeRecord. In this case nData==1 and regData
712 ** will be completely unrelated to regOrigData.
713 ** (2) All output columns are included in the sort record. In that
714 ** case regData==regOrigData.
715 ** (3) Some output columns are omitted from the sort record due to
716 ** the SQLITE_ENABLE_SORTER_REFERENCE optimization, or due to the
drhc6f36fa2018-05-05 16:50:35 +0000717 ** SQLITE_ECEL_OMITREF optimization, or due to the
718 ** SortCtx.pDeferredRowLoad optimiation. In any of these cases
719 ** regOrigData is 0 to prevent this routine from trying to copy
720 ** values that might not yet exist.
drhbbd4ae52018-04-30 19:32:49 +0000721 */
dan9af90b72016-11-11 18:08:59 +0000722 assert( nData==1 || regData==regOrigData || regOrigData==0 );
drhbbd4ae52018-04-30 19:32:49 +0000723
drhfd0a2f92014-03-24 18:08:15 +0000724 if( nPrefixReg ){
dan78d58432014-03-25 15:04:07 +0000725 assert( nPrefixReg==nExpr+bSeq );
drhbbd4ae52018-04-30 19:32:49 +0000726 regBase = regData - nPrefixReg;
drhfd0a2f92014-03-24 18:08:15 +0000727 }else{
drhfb0d6e52014-05-02 13:09:06 +0000728 regBase = pParse->nMem + 1;
729 pParse->nMem += nBase;
drhfd0a2f92014-03-24 18:08:15 +0000730 }
drha04a8be2016-01-13 17:50:10 +0000731 assert( pSelect->iOffset==0 || pSelect->iLimit!=0 );
732 iLimit = pSelect->iOffset ? pSelect->iOffset+1 : pSelect->iLimit;
drhec4ccdb2018-12-29 02:26:59 +0000733 pSort->labelDone = sqlite3VdbeMakeLabel(pParse);
drh5579d592015-08-26 14:01:41 +0000734 sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, regOrigData,
dan9af90b72016-11-11 18:08:59 +0000735 SQLITE_ECEL_DUP | (regOrigData? SQLITE_ECEL_REF : 0));
dan78d58432014-03-25 15:04:07 +0000736 if( bSeq ){
737 sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
drhfd0a2f92014-03-24 18:08:15 +0000738 }
dan257c13f2016-11-10 20:14:06 +0000739 if( nPrefixReg==0 && nData>0 ){
drh236241a2014-09-12 17:41:30 +0000740 sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
dan78d58432014-03-25 15:04:07 +0000741 }
drh079a3072014-03-19 14:10:55 +0000742 if( nOBSat>0 ){
743 int regPrevKey; /* The first nOBSat columns of the previous row */
744 int addrFirst; /* Address of the OP_IfNot opcode */
745 int addrJmp; /* Address of the OP_Jump opcode */
746 VdbeOp *pOp; /* Opcode that opens the sorter */
747 int nKey; /* Number of sorting key columns, including OP_Sequence */
drhdbfca2b2014-03-22 02:19:53 +0000748 KeyInfo *pKI; /* Original KeyInfo on the sorter table */
drh079a3072014-03-19 14:10:55 +0000749
drhbbd4ae52018-04-30 19:32:49 +0000750 regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
drh26d7e7c2014-03-19 16:56:58 +0000751 regPrevKey = pParse->nMem+1;
752 pParse->nMem += pSort->nOBSat;
dan78d58432014-03-25 15:04:07 +0000753 nKey = nExpr - pSort->nOBSat + bSeq;
754 if( bSeq ){
755 addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
756 }else{
757 addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
758 }
759 VdbeCoverage(v);
drh26d7e7c2014-03-19 16:56:58 +0000760 sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
drh079a3072014-03-19 14:10:55 +0000761 pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
drh59b8f2e2014-03-22 00:27:14 +0000762 if( pParse->db->mallocFailed ) return;
drhfb0d6e52014-05-02 13:09:06 +0000763 pOp->p2 = nKey + nData;
drhdbfca2b2014-03-22 02:19:53 +0000764 pKI = pOp->p4.pKeyInfo;
dan6e118922019-08-12 16:36:38 +0000765 memset(pKI->aSortFlags, 0, pKI->nKeyField); /* Makes OP_Jump testable */
drhdbfca2b2014-03-22 02:19:53 +0000766 sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
drha485ad12017-08-02 22:43:14 +0000767 testcase( pKI->nAllField > pKI->nKeyField+2 );
danf9eae182018-05-21 19:45:11 +0000768 pOp->p4.pKeyInfo = sqlite3KeyInfoFromExprList(pParse,pSort->pOrderBy,nOBSat,
drha485ad12017-08-02 22:43:14 +0000769 pKI->nAllField-pKI->nKeyField-1);
drh166bc382019-10-26 15:40:17 +0000770 pOp = 0; /* Ensure pOp not used after sqltie3VdbeAddOp3() */
drh079a3072014-03-19 14:10:55 +0000771 addrJmp = sqlite3VdbeCurrentAddr(v);
772 sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
drhec4ccdb2018-12-29 02:26:59 +0000773 pSort->labelBkOut = sqlite3VdbeMakeLabel(pParse);
drh079a3072014-03-19 14:10:55 +0000774 pSort->regReturn = ++pParse->nMem;
775 sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
drh65ea12c2014-03-19 17:41:36 +0000776 sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
drha04a8be2016-01-13 17:50:10 +0000777 if( iLimit ){
778 sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, pSort->labelDone);
779 VdbeCoverage(v);
780 }
drh079a3072014-03-19 14:10:55 +0000781 sqlite3VdbeJumpHere(v, addrFirst);
drh236241a2014-09-12 17:41:30 +0000782 sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
drh079a3072014-03-19 14:10:55 +0000783 sqlite3VdbeJumpHere(v, addrJmp);
784 }
danf226f032018-04-26 16:13:47 +0000785 if( iLimit ){
786 /* At this point the values for the new sorter entry are stored
787 ** in an array of registers. They need to be composed into a record
788 ** and inserted into the sorter if either (a) there are currently
789 ** less than LIMIT+OFFSET items or (b) the new record is smaller than
790 ** the largest record currently in the sorter. If (b) is true and there
791 ** are already LIMIT+OFFSET items in the sorter, delete the largest
792 ** entry before inserting the new one. This way there are never more
793 ** than LIMIT+OFFSET items in the sorter.
794 **
795 ** If the new record does not need to be inserted into the sorter,
drh6ee5a7b2018-09-08 20:09:46 +0000796 ** jump to the next iteration of the loop. If the pSort->labelOBLopt
797 ** value is not zero, then it is a label of where to jump. Otherwise,
798 ** just bypass the row insert logic. See the header comment on the
799 ** sqlite3WhereOrderByLimitOptLabel() function for additional info.
danf226f032018-04-26 16:13:47 +0000800 */
801 int iCsr = pSort->iECursor;
danf226f032018-04-26 16:13:47 +0000802 sqlite3VdbeAddOp2(v, OP_IfNotZero, iLimit, sqlite3VdbeCurrentAddr(v)+4);
803 VdbeCoverage(v);
804 sqlite3VdbeAddOp2(v, OP_Last, iCsr, 0);
drhbbd4ae52018-04-30 19:32:49 +0000805 iSkip = sqlite3VdbeAddOp4Int(v, OP_IdxLE,
806 iCsr, 0, regBase+nOBSat, nExpr-nOBSat);
danf226f032018-04-26 16:13:47 +0000807 VdbeCoverage(v);
808 sqlite3VdbeAddOp1(v, OP_Delete, iCsr);
809 }
drhbbd4ae52018-04-30 19:32:49 +0000810 if( regRecord==0 ){
811 regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
danf226f032018-04-26 16:13:47 +0000812 }
drh079a3072014-03-19 14:10:55 +0000813 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drhc6aff302011-09-01 15:32:47 +0000814 op = OP_SorterInsert;
815 }else{
816 op = OP_IdxInsert;
817 }
drh4a8b0132016-11-09 01:38:56 +0000818 sqlite3VdbeAddOp4Int(v, op, pSort->iECursor, regRecord,
819 regBase+nOBSat, nBase-nOBSat);
drhbbd4ae52018-04-30 19:32:49 +0000820 if( iSkip ){
drhbbd4ae52018-04-30 19:32:49 +0000821 sqlite3VdbeChangeP2(v, iSkip,
drh6ee5a7b2018-09-08 20:09:46 +0000822 pSort->labelOBLopt ? pSort->labelOBLopt : sqlite3VdbeCurrentAddr(v));
drhbbd4ae52018-04-30 19:32:49 +0000823 }
drhc926afb2002-06-20 03:38:26 +0000824}
825
826/*
drhec7429a2005-10-06 16:53:14 +0000827** Add code to implement the OFFSET
drhea48eb22004-07-19 23:16:38 +0000828*/
drhec7429a2005-10-06 16:53:14 +0000829static void codeOffset(
drhbab39e12004-07-19 23:38:11 +0000830 Vdbe *v, /* Generate code into this VM */
drhaa9ce702014-01-22 18:07:04 +0000831 int iOffset, /* Register holding the offset counter */
drhb7654112008-01-12 12:48:07 +0000832 int iContinue /* Jump here to skip the current record */
drhea48eb22004-07-19 23:16:38 +0000833){
drha22a75e2014-03-21 18:16:23 +0000834 if( iOffset>0 ){
drh8b0cf382015-10-06 21:07:06 +0000835 sqlite3VdbeAddOp3(v, OP_IfPos, iOffset, iContinue, 1); VdbeCoverage(v);
836 VdbeComment((v, "OFFSET"));
drhea48eb22004-07-19 23:16:38 +0000837 }
drhea48eb22004-07-19 23:16:38 +0000838}
839
840/*
dan96ecb7b2021-03-09 16:47:33 +0000841** Add code that will check to make sure the array of registers starting at
842** iMem form a distinct entry. This is used by both "SELECT DISTINCT ..." and
dan76075802021-03-12 21:09:20 +0000843** distinct aggregates ("SELECT count(DISTINCT <expr>) ..."). Three strategies
844** are available. Which is used depends on the value of parameter eTnctType,
845** as follows:
drha2a49dc2008-01-02 14:28:13 +0000846**
dan96ecb7b2021-03-09 16:47:33 +0000847** WHERE_DISTINCT_UNORDERED/WHERE_DISTINCT_NOOP:
drh9be13392021-03-24 19:44:01 +0000848** Build an ephemeral table that contains all entries seen before and
849** skip entries which have been seen before.
850**
dan76075802021-03-12 21:09:20 +0000851** Parameter iTab is the cursor number of an ephemeral table that must
852** be opened before the VM code generated by this routine is executed.
dan5383db72021-03-12 18:24:31 +0000853** The ephemeral cursor table is queried for a record identical to the
dan96ecb7b2021-03-09 16:47:33 +0000854** record formed by the current array of registers. If one is found,
855** jump to VM address addrRepeat. Otherwise, insert a new record into
856** the ephemeral cursor and proceed.
857**
dan76075802021-03-12 21:09:20 +0000858** The returned value in this case is a copy of parameter iTab.
859**
dan96ecb7b2021-03-09 16:47:33 +0000860** WHERE_DISTINCT_ORDERED:
drh9be13392021-03-24 19:44:01 +0000861** In this case rows are being delivered sorted order. The ephermal
862** table is not required. Instead, the current set of values
863** is compared against previous row. If they match, the new row
dan96ecb7b2021-03-09 16:47:33 +0000864** is not distinct and control jumps to VM address addrRepeat. Otherwise,
865** the VM program proceeds with processing the new row.
866**
dan76075802021-03-12 21:09:20 +0000867** The returned value in this case is the register number of the first
868** in an array of registers used to store the previous result row so that
drh9be13392021-03-24 19:44:01 +0000869** it can be compared to the next. The caller must ensure that this
870** register is initialized to NULL. (The fixDistinctOpenEph() routine
871** will take care of this initialization.)
dan76075802021-03-12 21:09:20 +0000872**
dan96ecb7b2021-03-09 16:47:33 +0000873** WHERE_DISTINCT_UNIQUE:
874** In this case it has already been determined that the rows are distinct.
drh9be13392021-03-24 19:44:01 +0000875** No special action is required. The return value is zero.
dan96ecb7b2021-03-09 16:47:33 +0000876**
877** Parameter pEList is the list of expressions used to generated the
878** contents of each row. It is used by this routine to determine (a)
879** how many elements there are in the array of registers and (b) the
880** collation sequences that should be used for the comparisons if
881** eTnctType is WHERE_DISTINCT_ORDERED.
drha2a49dc2008-01-02 14:28:13 +0000882*/
dan5383db72021-03-12 18:24:31 +0000883static int codeDistinct(
drh2dcef112008-01-12 19:03:48 +0000884 Parse *pParse, /* Parsing and code generating context */
dan4fcb30b2021-03-09 16:06:25 +0000885 int eTnctType, /* WHERE_DISTINCT_* value */
drha2a49dc2008-01-02 14:28:13 +0000886 int iTab, /* A sorting index used to test for distinctness */
887 int addrRepeat, /* Jump to here if not distinct */
dan4fcb30b2021-03-09 16:06:25 +0000888 ExprList *pEList, /* Expression for each element */
889 int regElem /* First element */
drha2a49dc2008-01-02 14:28:13 +0000890){
dan5383db72021-03-12 18:24:31 +0000891 int iRet = 0;
dan4fcb30b2021-03-09 16:06:25 +0000892 int nResultCol = pEList->nExpr;
893 Vdbe *v = pParse->pVdbe;
drh2dcef112008-01-12 19:03:48 +0000894
dan4fcb30b2021-03-09 16:06:25 +0000895 switch( eTnctType ){
896 case WHERE_DISTINCT_ORDERED: {
897 int i;
dan4fcb30b2021-03-09 16:06:25 +0000898 int iJump; /* Jump destination */
899 int regPrev; /* Previous row content */
900
901 /* Allocate space for the previous row */
dan5383db72021-03-12 18:24:31 +0000902 iRet = regPrev = pParse->nMem+1;
dan4fcb30b2021-03-09 16:06:25 +0000903 pParse->nMem += nResultCol;
904
dan4fcb30b2021-03-09 16:06:25 +0000905 iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
906 for(i=0; i<nResultCol; i++){
907 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pEList->a[i].pExpr);
908 if( i<nResultCol-1 ){
909 sqlite3VdbeAddOp3(v, OP_Ne, regElem+i, iJump, regPrev+i);
910 VdbeCoverage(v);
911 }else{
912 sqlite3VdbeAddOp3(v, OP_Eq, regElem+i, addrRepeat, regPrev+i);
913 VdbeCoverage(v);
914 }
915 sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
916 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
917 }
918 assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
919 sqlite3VdbeAddOp3(v, OP_Copy, regElem, regPrev, nResultCol-1);
920 break;
921 }
922
923 case WHERE_DISTINCT_UNIQUE: {
dan5383db72021-03-12 18:24:31 +0000924 /* nothing to do */
dan4fcb30b2021-03-09 16:06:25 +0000925 break;
926 }
927
928 default: {
929 int r1 = sqlite3GetTempReg(pParse);
930 sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, regElem, nResultCol);
931 VdbeCoverage(v);
932 sqlite3VdbeAddOp3(v, OP_MakeRecord, regElem, nResultCol, r1);
933 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r1, regElem, nResultCol);
934 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
935 sqlite3ReleaseTempReg(pParse, r1);
dan5383db72021-03-12 18:24:31 +0000936 iRet = iTab;
dan4fcb30b2021-03-09 16:06:25 +0000937 break;
938 }
939 }
dan5383db72021-03-12 18:24:31 +0000940
941 return iRet;
942}
943
dan76075802021-03-12 21:09:20 +0000944/*
drh9be13392021-03-24 19:44:01 +0000945** This routine runs after codeDistinct(). It makes necessary
946** adjustments to the OP_OpenEphemeral opcode that the codeDistinct()
947** routine made use of. This processing must be done separately since
948** sometimes codeDistinct is called before the OP_OpenEphemeral is actually
949** laid down.
dan76075802021-03-12 21:09:20 +0000950**
drh9be13392021-03-24 19:44:01 +0000951** WHERE_DISTINCT_NOOP:
952** WHERE_DISTINCT_UNORDERED:
dan76075802021-03-12 21:09:20 +0000953**
drh9be13392021-03-24 19:44:01 +0000954** No adjustments necessary. This function is a no-op.
dan76075802021-03-12 21:09:20 +0000955**
drh9be13392021-03-24 19:44:01 +0000956** WHERE_DISTINCT_UNIQUE:
957**
958** The ephemeral table is not needed. So change the
959** OP_OpenEphemeral opcode into an OP_Noop.
960**
961** WHERE_DISTINCT_ORDERED:
962**
963** The ephemeral table is not needed. But we do need register
964** iVal to be initialized to NULL. So change the OP_OpenEphemeral
965** into an OP_Null on the iVal register.
dan76075802021-03-12 21:09:20 +0000966*/
dan5383db72021-03-12 18:24:31 +0000967static void fixDistinctOpenEph(
968 Parse *pParse, /* Parsing and code generating context */
969 int eTnctType, /* WHERE_DISTINCT_* value */
970 int iVal, /* Value returned by codeDistinct() */
dan76075802021-03-12 21:09:20 +0000971 int iOpenEphAddr /* Address of OP_OpenEphemeral instruction for iTab */
dan5383db72021-03-12 18:24:31 +0000972){
drhc6da6db2021-07-28 02:04:58 +0000973 if( pParse->nErr==0
974 && (eTnctType==WHERE_DISTINCT_UNIQUE || eTnctType==WHERE_DISTINCT_ORDERED)
975 ){
dan5383db72021-03-12 18:24:31 +0000976 Vdbe *v = pParse->pVdbe;
dan76075802021-03-12 21:09:20 +0000977 sqlite3VdbeChangeToNoop(v, iOpenEphAddr);
drh9be13392021-03-24 19:44:01 +0000978 if( sqlite3VdbeGetOp(v, iOpenEphAddr+1)->opcode==OP_Explain ){
979 sqlite3VdbeChangeToNoop(v, iOpenEphAddr+1);
980 }
dan5383db72021-03-12 18:24:31 +0000981 if( eTnctType==WHERE_DISTINCT_ORDERED ){
982 /* Change the OP_OpenEphemeral to an OP_Null that sets the MEM_Cleared
983 ** bit on the first register of the previous value. This will cause the
984 ** OP_Ne added in codeDistinct() to always fail on the first iteration of
985 ** the loop even if the first row is all NULLs. */
dan76075802021-03-12 21:09:20 +0000986 VdbeOp *pOp = sqlite3VdbeGetOp(v, iOpenEphAddr);
dan5383db72021-03-12 18:24:31 +0000987 pOp->opcode = OP_Null;
988 pOp->p1 = 1;
989 pOp->p2 = iVal;
990 }
991 }
drha2a49dc2008-01-02 14:28:13 +0000992}
993
dan24e25d32018-04-14 18:46:20 +0000994#ifdef SQLITE_ENABLE_SORTER_REFERENCES
995/*
996** This function is called as part of inner-loop generation for a SELECT
997** statement with an ORDER BY that is not optimized by an index. It
998** determines the expressions, if any, that the sorter-reference
999** optimization should be used for. The sorter-reference optimization
1000** is used for SELECT queries like:
1001**
1002** SELECT a, bigblob FROM t1 ORDER BY a LIMIT 10
1003**
1004** If the optimization is used for expression "bigblob", then instead of
1005** storing values read from that column in the sorter records, the PK of
1006** the row from table t1 is stored instead. Then, as records are extracted from
1007** the sorter to return to the user, the required value of bigblob is
1008** retrieved directly from table t1. If the values are very large, this
1009** can be more efficient than storing them directly in the sorter records.
1010**
drh00e5d3d2022-05-03 16:18:25 +00001011** The ExprList_item.fg.bSorterRef flag is set for each expression in pEList
dan24e25d32018-04-14 18:46:20 +00001012** for which the sorter-reference optimization should be enabled.
1013** Additionally, the pSort->aDefer[] array is populated with entries
1014** for all cursors required to evaluate all selected expressions. Finally.
1015** output variable (*ppExtra) is set to an expression list containing
1016** expressions for all extra PK values that should be stored in the
1017** sorter records.
1018*/
1019static void selectExprDefer(
1020 Parse *pParse, /* Leave any error here */
1021 SortCtx *pSort, /* Sorter context */
1022 ExprList *pEList, /* Expressions destined for sorter */
1023 ExprList **ppExtra /* Expressions to append to sorter record */
1024){
1025 int i;
1026 int nDefer = 0;
1027 ExprList *pExtra = 0;
1028 for(i=0; i<pEList->nExpr; i++){
1029 struct ExprList_item *pItem = &pEList->a[i];
1030 if( pItem->u.x.iOrderByCol==0 ){
1031 Expr *pExpr = pItem->pExpr;
drh477572b2021-10-07 20:46:29 +00001032 Table *pTab;
drhffa5b052021-10-12 18:05:55 +00001033 if( pExpr->op==TK_COLUMN
1034 && pExpr->iColumn>=0
1035 && ALWAYS( ExprUseYTab(pExpr) )
1036 && (pTab = pExpr->y.pTab)!=0
1037 && IsOrdinaryTable(pTab)
1038 && (pTab->aCol[pExpr->iColumn].colFlags & COLFLAG_SORTERREF)!=0
dan24e25d32018-04-14 18:46:20 +00001039 ){
1040 int j;
1041 for(j=0; j<nDefer; j++){
1042 if( pSort->aDefer[j].iCsr==pExpr->iTable ) break;
1043 }
1044 if( j==nDefer ){
1045 if( nDefer==ArraySize(pSort->aDefer) ){
1046 continue;
1047 }else{
1048 int nKey = 1;
1049 int k;
1050 Index *pPk = 0;
1051 if( !HasRowid(pTab) ){
1052 pPk = sqlite3PrimaryKeyIndex(pTab);
1053 nKey = pPk->nKeyCol;
1054 }
1055 for(k=0; k<nKey; k++){
1056 Expr *pNew = sqlite3PExpr(pParse, TK_COLUMN, 0, 0);
1057 if( pNew ){
1058 pNew->iTable = pExpr->iTable;
drh477572b2021-10-07 20:46:29 +00001059 assert( ExprUseYTab(pNew) );
drheda079c2018-09-20 19:02:15 +00001060 pNew->y.pTab = pExpr->y.pTab;
dan24e25d32018-04-14 18:46:20 +00001061 pNew->iColumn = pPk ? pPk->aiColumn[k] : -1;
1062 pExtra = sqlite3ExprListAppend(pParse, pExtra, pNew);
1063 }
1064 }
drheda079c2018-09-20 19:02:15 +00001065 pSort->aDefer[nDefer].pTab = pExpr->y.pTab;
dan24e25d32018-04-14 18:46:20 +00001066 pSort->aDefer[nDefer].iCsr = pExpr->iTable;
1067 pSort->aDefer[nDefer].nKey = nKey;
1068 nDefer++;
1069 }
1070 }
drhd88fd532022-05-02 20:49:30 +00001071 pItem->fg.bSorterRef = 1;
dan24e25d32018-04-14 18:46:20 +00001072 }
1073 }
1074 }
1075 pSort->nDefer = (u8)nDefer;
1076 *ppExtra = pExtra;
1077}
1078#endif
1079
drhc99130f2005-09-11 11:56:27 +00001080/*
drh22827922000-06-06 17:27:05 +00001081** This routine generates the code for the inside of the inner loop
1082** of a SELECT.
drh82c3d632000-06-06 21:56:07 +00001083**
drh2def2f72017-09-15 17:40:34 +00001084** If srcTab is negative, then the p->pEList expressions
drh340309f2014-01-22 00:23:49 +00001085** are evaluated in order to get the data for this row. If srcTab is
drh2def2f72017-09-15 17:40:34 +00001086** zero or more, then data is pulled from srcTab and p->pEList is used only
dan257c13f2016-11-10 20:14:06 +00001087** to get the number of columns and the collation sequence for each column.
drh22827922000-06-06 17:27:05 +00001088*/
drhd2b3e232008-01-23 14:51:49 +00001089static void selectInnerLoop(
drh22827922000-06-06 17:27:05 +00001090 Parse *pParse, /* The parser context */
drhdf199a22002-06-14 22:38:41 +00001091 Select *p, /* The complete select statement being coded */
drh2def2f72017-09-15 17:40:34 +00001092 int srcTab, /* Pull data from this table if non-negative */
drh079a3072014-03-19 14:10:55 +00001093 SortCtx *pSort, /* If not NULL, info on how to process ORDER BY */
drhe8e4af72012-09-21 00:04:28 +00001094 DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
danielk19776c8c8ce2008-01-02 16:27:09 +00001095 SelectDest *pDest, /* How to dispose of the results */
drh22827922000-06-06 17:27:05 +00001096 int iContinue, /* Jump here to continue with next row */
drha9671a22008-07-08 23:40:20 +00001097 int iBreak /* Jump here to break out of the inner loop */
drh22827922000-06-06 17:27:05 +00001098){
1099 Vdbe *v = pParse->pVdbe;
drhd847eaa2008-01-17 17:15:56 +00001100 int i;
dan9af90b72016-11-11 18:08:59 +00001101 int hasDistinct; /* True if the DISTINCT keyword is present */
drhd847eaa2008-01-17 17:15:56 +00001102 int eDest = pDest->eDest; /* How to dispose of results */
drh2b596da2012-07-23 21:43:19 +00001103 int iParm = pDest->iSDParm; /* First argument to disposal method */
drhd847eaa2008-01-17 17:15:56 +00001104 int nResultCol; /* Number of result columns */
drhfd0a2f92014-03-24 18:08:15 +00001105 int nPrefixReg = 0; /* Number of extra registers before regResult */
drhbbd4ae52018-04-30 19:32:49 +00001106 RowLoadInfo sRowLoadInfo; /* Info for deferred row loading */
drh38640e12002-07-05 21:42:36 +00001107
dan9af90b72016-11-11 18:08:59 +00001108 /* Usually, regResult is the first cell in an array of memory cells
1109 ** containing the current result row. In this case regOrig is set to the
1110 ** same value. However, if the results are being sent to the sorter, the
1111 ** values for any expressions that are also part of the sort-key are omitted
1112 ** from this array. In this case regOrig is set to zero. */
1113 int regResult; /* Start of memory holding current results */
1114 int regOrig; /* Start of memory holding full result (or 0) */
1115
drh1c767f02009-01-09 02:49:31 +00001116 assert( v );
drh2def2f72017-09-15 17:40:34 +00001117 assert( p->pEList!=0 );
drhe8e4af72012-09-21 00:04:28 +00001118 hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
drh079a3072014-03-19 14:10:55 +00001119 if( pSort && pSort->pOrderBy==0 ) pSort = 0;
1120 if( pSort==0 && !hasDistinct ){
drha22a75e2014-03-21 18:16:23 +00001121 assert( iContinue!=0 );
drhaa9ce702014-01-22 18:07:04 +00001122 codeOffset(v, p->iOffset, iContinue);
drhdf199a22002-06-14 22:38:41 +00001123 }
1124
drh967e8b72000-06-21 13:59:10 +00001125 /* Pull the requested columns.
drh22827922000-06-06 17:27:05 +00001126 */
drh2def2f72017-09-15 17:40:34 +00001127 nResultCol = p->pEList->nExpr;
drh05a86c52014-02-16 01:55:49 +00001128
drh2b596da2012-07-23 21:43:19 +00001129 if( pDest->iSdst==0 ){
drhfd0a2f92014-03-24 18:08:15 +00001130 if( pSort ){
dan78d58432014-03-25 15:04:07 +00001131 nPrefixReg = pSort->pOrderBy->nExpr;
1132 if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
drhfd0a2f92014-03-24 18:08:15 +00001133 pParse->nMem += nPrefixReg;
1134 }
drh2b596da2012-07-23 21:43:19 +00001135 pDest->iSdst = pParse->nMem+1;
drh0acb7e42008-06-25 00:12:41 +00001136 pParse->nMem += nResultCol;
drh05a86c52014-02-16 01:55:49 +00001137 }else if( pDest->iSdst+nResultCol > pParse->nMem ){
1138 /* This is an error condition that can result, for example, when a SELECT
1139 ** on the right-hand side of an INSERT contains more result columns than
1140 ** there are columns in the table on the left. The error will be caught
1141 ** and reported later. But we need to make sure enough memory is allocated
1142 ** to avoid other spurious errors in the meantime. */
1143 pParse->nMem += nResultCol;
drh1013c932008-01-06 00:25:21 +00001144 }
drh05a86c52014-02-16 01:55:49 +00001145 pDest->nSdst = nResultCol;
dan9af90b72016-11-11 18:08:59 +00001146 regOrig = regResult = pDest->iSdst;
drh340309f2014-01-22 00:23:49 +00001147 if( srcTab>=0 ){
1148 for(i=0; i<nResultCol; i++){
drhd847eaa2008-01-17 17:15:56 +00001149 sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
drh41cee662019-12-12 20:22:34 +00001150 VdbeComment((v, "%s", p->pEList->a[i].zEName));
drh82c3d632000-06-06 21:56:07 +00001151 }
danielk19779ed1dfa2008-01-02 17:11:14 +00001152 }else if( eDest!=SRT_Exists ){
dan24e25d32018-04-14 18:46:20 +00001153#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1154 ExprList *pExtra = 0;
1155#endif
danielk19779ed1dfa2008-01-02 17:11:14 +00001156 /* If the destination is an EXISTS(...) expression, the actual
1157 ** values returned by the SELECT are not required.
1158 */
drhbbd4ae52018-04-30 19:32:49 +00001159 u8 ecelFlags; /* "ecel" is an abbreviation of "ExprCodeExprList" */
1160 ExprList *pEList;
drhdf553652015-05-18 04:24:27 +00001161 if( eDest==SRT_Mem || eDest==SRT_Output || eDest==SRT_Coroutine ){
1162 ecelFlags = SQLITE_ECEL_DUP;
1163 }else{
1164 ecelFlags = 0;
1165 }
danac56ab72017-01-05 17:23:11 +00001166 if( pSort && hasDistinct==0 && eDest!=SRT_EphemTab && eDest!=SRT_Table ){
drh2def2f72017-09-15 17:40:34 +00001167 /* For each expression in p->pEList that is a copy of an expression in
dan257c13f2016-11-10 20:14:06 +00001168 ** the ORDER BY clause (pSort->pOrderBy), set the associated
1169 ** iOrderByCol value to one more than the index of the ORDER BY
1170 ** expression within the sort-key that pushOntoSorter() will generate.
drh2def2f72017-09-15 17:40:34 +00001171 ** This allows the p->pEList field to be omitted from the sorted record,
dan257c13f2016-11-10 20:14:06 +00001172 ** saving space and CPU cycles. */
1173 ecelFlags |= (SQLITE_ECEL_OMITREF|SQLITE_ECEL_REF);
drhbbd4ae52018-04-30 19:32:49 +00001174
dan257c13f2016-11-10 20:14:06 +00001175 for(i=pSort->nOBSat; i<pSort->pOrderBy->nExpr; i++){
1176 int j;
1177 if( (j = pSort->pOrderBy->a[i].u.x.iOrderByCol)>0 ){
drh2def2f72017-09-15 17:40:34 +00001178 p->pEList->a[j-1].u.x.iOrderByCol = i+1-pSort->nOBSat;
dan257c13f2016-11-10 20:14:06 +00001179 }
1180 }
dan24e25d32018-04-14 18:46:20 +00001181#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1182 selectExprDefer(pParse, pSort, p->pEList, &pExtra);
drh5a2e65e2018-04-18 19:08:44 +00001183 if( pExtra && pParse->db->mallocFailed==0 ){
dan24e25d32018-04-14 18:46:20 +00001184 /* If there are any extra PK columns to add to the sorter records,
1185 ** allocate extra memory cells and adjust the OpenEphemeral
1186 ** instruction to account for the larger records. This is only
1187 ** required if there are one or more WITHOUT ROWID tables with
1188 ** composite primary keys in the SortCtx.aDefer[] array. */
1189 VdbeOp *pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
1190 pOp->p2 += (pExtra->nExpr - pSort->nDefer);
1191 pOp->p4.pKeyInfo->nAllField += (pExtra->nExpr - pSort->nDefer);
1192 pParse->nMem += pExtra->nExpr;
1193 }
1194#endif
drhbbd4ae52018-04-30 19:32:49 +00001195
1196 /* Adjust nResultCol to account for columns that are omitted
1197 ** from the sorter by the optimizations in this branch */
1198 pEList = p->pEList;
1199 for(i=0; i<pEList->nExpr; i++){
1200 if( pEList->a[i].u.x.iOrderByCol>0
1201#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001202 || pEList->a[i].fg.bSorterRef
drhbbd4ae52018-04-30 19:32:49 +00001203#endif
1204 ){
1205 nResultCol--;
1206 regOrig = 0;
1207 }
1208 }
1209
1210 testcase( regOrig );
1211 testcase( eDest==SRT_Set );
1212 testcase( eDest==SRT_Mem );
1213 testcase( eDest==SRT_Coroutine );
1214 testcase( eDest==SRT_Output );
dan257c13f2016-11-10 20:14:06 +00001215 assert( eDest==SRT_Set || eDest==SRT_Mem
danf2972b62020-04-29 20:11:01 +00001216 || eDest==SRT_Coroutine || eDest==SRT_Output
1217 || eDest==SRT_Upfrom );
dan257c13f2016-11-10 20:14:06 +00001218 }
drhbbd4ae52018-04-30 19:32:49 +00001219 sRowLoadInfo.regResult = regResult;
1220 sRowLoadInfo.ecelFlags = ecelFlags;
dan24e25d32018-04-14 18:46:20 +00001221#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhbbd4ae52018-04-30 19:32:49 +00001222 sRowLoadInfo.pExtra = pExtra;
1223 sRowLoadInfo.regExtraResult = regResult + nResultCol;
1224 if( pExtra ) nResultCol += pExtra->nExpr;
dan24e25d32018-04-14 18:46:20 +00001225#endif
drhbbd4ae52018-04-30 19:32:49 +00001226 if( p->iLimit
1227 && (ecelFlags & SQLITE_ECEL_OMITREF)!=0
1228 && nPrefixReg>0
1229 ){
1230 assert( pSort!=0 );
1231 assert( hasDistinct==0 );
1232 pSort->pDeferredRowLoad = &sRowLoadInfo;
drhc6f36fa2018-05-05 16:50:35 +00001233 regOrig = 0;
drhbbd4ae52018-04-30 19:32:49 +00001234 }else{
1235 innerLoopLoadRow(pParse, p, &sRowLoadInfo);
1236 }
drh22827922000-06-06 17:27:05 +00001237 }
1238
drhdaffd0e2001-04-11 14:28:42 +00001239 /* If the DISTINCT keyword was present on the SELECT statement
1240 ** and this row has been seen before, then do not make this row
1241 ** part of the result.
drh22827922000-06-06 17:27:05 +00001242 */
drhea48eb22004-07-19 23:16:38 +00001243 if( hasDistinct ){
dan5383db72021-03-12 18:24:31 +00001244 int eType = pDistinct->eTnctType;
1245 int iTab = pDistinct->tabTnct;
dan4fcb30b2021-03-09 16:06:25 +00001246 assert( nResultCol==p->pEList->nExpr );
dan5383db72021-03-12 18:24:31 +00001247 iTab = codeDistinct(pParse, eType, iTab, iContinue, p->pEList, regResult);
1248 fixDistinctOpenEph(pParse, eType, iTab, pDistinct->addrTnct);
drh079a3072014-03-19 14:10:55 +00001249 if( pSort==0 ){
drhaa9ce702014-01-22 18:07:04 +00001250 codeOffset(v, p->iOffset, iContinue);
drhea48eb22004-07-19 23:16:38 +00001251 }
drh22827922000-06-06 17:27:05 +00001252 }
drh82c3d632000-06-06 21:56:07 +00001253
drhc926afb2002-06-20 03:38:26 +00001254 switch( eDest ){
1255 /* In this mode, write each query result to the key of the temporary
1256 ** table iParm.
1257 */
drh13449892005-09-07 21:22:45 +00001258#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhc926afb2002-06-20 03:38:26 +00001259 case SRT_Union: {
drh9cbf3422008-01-17 16:22:13 +00001260 int r1;
1261 r1 = sqlite3GetTempReg(pParse);
drh340309f2014-01-22 00:23:49 +00001262 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
drh9b4eaeb2016-11-09 00:10:33 +00001263 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
drh9cbf3422008-01-17 16:22:13 +00001264 sqlite3ReleaseTempReg(pParse, r1);
drhc926afb2002-06-20 03:38:26 +00001265 break;
drh22827922000-06-06 17:27:05 +00001266 }
drh22827922000-06-06 17:27:05 +00001267
drhc926afb2002-06-20 03:38:26 +00001268 /* Construct a record from the query result, but instead of
1269 ** saving that record, use it as a key to delete elements from
1270 ** the temporary table iParm.
1271 */
1272 case SRT_Except: {
drh340309f2014-01-22 00:23:49 +00001273 sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
drhc926afb2002-06-20 03:38:26 +00001274 break;
1275 }
drh781def22014-01-22 13:35:53 +00001276#endif /* SQLITE_OMIT_COMPOUND_SELECT */
danielk19775338a5f2005-01-20 13:03:10 +00001277
1278 /* Store the result as data using a unique key.
1279 */
drh8e1ee882014-03-21 19:56:09 +00001280 case SRT_Fifo:
1281 case SRT_DistFifo:
danielk19775338a5f2005-01-20 13:03:10 +00001282 case SRT_Table:
drhb9bb7c12006-06-11 23:41:55 +00001283 case SRT_EphemTab: {
drhfd0a2f92014-03-24 18:08:15 +00001284 int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
drh373cc2d2009-05-17 02:06:14 +00001285 testcase( eDest==SRT_Table );
1286 testcase( eDest==SRT_EphemTab );
drhe2248cf2015-05-22 17:29:27 +00001287 testcase( eDest==SRT_Fifo );
1288 testcase( eDest==SRT_DistFifo );
drhfd0a2f92014-03-24 18:08:15 +00001289 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
drh5fdb9a32022-11-01 00:52:22 +00001290 if( pDest->zAffSdst ){
1291 sqlite3VdbeChangeP4(v, -1, pDest->zAffSdst, nResultCol);
1292 }
dan8ce71842014-01-14 20:14:09 +00001293#ifndef SQLITE_OMIT_CTE
drh8e1ee882014-03-21 19:56:09 +00001294 if( eDest==SRT_DistFifo ){
1295 /* If the destination is DistFifo, then cursor (iParm+1) is open
dan8ce71842014-01-14 20:14:09 +00001296 ** on an ephemeral index. If the current row is already present
1297 ** in the index, do not write it to the output. If not, add the
1298 ** current row to the index and proceed with writing it to the
1299 ** output table as well. */
1300 int addr = sqlite3VdbeCurrentAddr(v) + 4;
drh38b41492015-06-08 15:08:15 +00001301 sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0);
1302 VdbeCoverage(v);
drh9b4eaeb2016-11-09 00:10:33 +00001303 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm+1, r1,regResult,nResultCol);
drh079a3072014-03-19 14:10:55 +00001304 assert( pSort==0 );
dan8ce71842014-01-14 20:14:09 +00001305 }
1306#endif
drh079a3072014-03-19 14:10:55 +00001307 if( pSort ){
drhbbd4ae52018-04-30 19:32:49 +00001308 assert( regResult==regOrig );
1309 pushOntoSorter(pParse, pSort, p, r1+nPrefixReg, regOrig, 1, nPrefixReg);
danielk19775338a5f2005-01-20 13:03:10 +00001310 }else{
drhb7654112008-01-12 12:48:07 +00001311 int r2 = sqlite3GetTempReg(pParse);
1312 sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
1313 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
1314 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1315 sqlite3ReleaseTempReg(pParse, r2);
danielk19775338a5f2005-01-20 13:03:10 +00001316 }
drhfd0a2f92014-03-24 18:08:15 +00001317 sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
danielk19775338a5f2005-01-20 13:03:10 +00001318 break;
1319 }
drh5974a302000-06-07 14:42:26 +00001320
dan9ed322d2020-04-29 17:41:29 +00001321 case SRT_Upfrom: {
danf2972b62020-04-29 20:11:01 +00001322 if( pSort ){
1323 pushOntoSorter(
1324 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drh2add24c2020-07-23 14:12:47 +00001325 }else{
danf2972b62020-04-29 20:11:01 +00001326 int i2 = pDest->iSDParm2;
1327 int r1 = sqlite3GetTempReg(pParse);
drh09cf5692020-07-20 18:07:35 +00001328
1329 /* If the UPDATE FROM join is an aggregate that matches no rows, it
1330 ** might still be trying to return one row, because that is what
1331 ** aggregates do. Don't record that empty row in the output table. */
1332 sqlite3VdbeAddOp2(v, OP_IsNull, regResult, iBreak); VdbeCoverage(v);
1333
1334 sqlite3VdbeAddOp3(v, OP_MakeRecord,
1335 regResult+(i2<0), nResultCol-(i2<0), r1);
danf2972b62020-04-29 20:11:01 +00001336 if( i2<0 ){
1337 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regResult);
1338 }else{
1339 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, i2);
1340 }
dan9ed322d2020-04-29 17:41:29 +00001341 }
1342 break;
1343 }
1344
1345#ifndef SQLITE_OMIT_SUBQUERY
drhc926afb2002-06-20 03:38:26 +00001346 /* If we are creating a set for an "expr IN (SELECT ...)" construct,
1347 ** then there should be a single item on the stack. Write this
1348 ** item into the set table with bogus data.
1349 */
1350 case SRT_Set: {
drh079a3072014-03-19 14:10:55 +00001351 if( pSort ){
drhde941c62005-08-28 01:34:21 +00001352 /* At first glance you would think we could optimize out the
1353 ** ORDER BY in this case since the order of entries in the set
1354 ** does not matter. But there might be a LIMIT clause, in which
1355 ** case the order does matter */
dan51d82d12016-08-02 18:50:15 +00001356 pushOntoSorter(
dan9af90b72016-11-11 18:08:59 +00001357 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drhc926afb2002-06-20 03:38:26 +00001358 }else{
drhb7654112008-01-12 12:48:07 +00001359 int r1 = sqlite3GetTempReg(pParse);
dan9ed322d2020-04-29 17:41:29 +00001360 assert( sqlite3Strlen30(pDest->zAffSdst)==nResultCol );
1361 sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult, nResultCol,
1362 r1, pDest->zAffSdst, nResultCol);
1363 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
drhb7654112008-01-12 12:48:07 +00001364 sqlite3ReleaseTempReg(pParse, r1);
drhc926afb2002-06-20 03:38:26 +00001365 }
1366 break;
1367 }
drh22827922000-06-06 17:27:05 +00001368
dan9ed322d2020-04-29 17:41:29 +00001369
drh504b6982006-01-22 21:52:56 +00001370 /* If any row exist in the result set, record that fact and abort.
drhec7429a2005-10-06 16:53:14 +00001371 */
1372 case SRT_Exists: {
drh4c583122008-01-04 22:01:03 +00001373 sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
drhec7429a2005-10-06 16:53:14 +00001374 /* The LIMIT clause will terminate the loop for us */
1375 break;
1376 }
1377
drhc926afb2002-06-20 03:38:26 +00001378 /* If this is a scalar select that is part of an expression, then
dan870a0702016-08-01 16:37:43 +00001379 ** store the results in the appropriate memory cell or array of
1380 ** memory cells and break out of the scan loop.
drhc926afb2002-06-20 03:38:26 +00001381 */
1382 case SRT_Mem: {
drh079a3072014-03-19 14:10:55 +00001383 if( pSort ){
dan257c13f2016-11-10 20:14:06 +00001384 assert( nResultCol<=pDest->nSdst );
dan870a0702016-08-01 16:37:43 +00001385 pushOntoSorter(
dan9af90b72016-11-11 18:08:59 +00001386 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drhc926afb2002-06-20 03:38:26 +00001387 }else{
dan257c13f2016-11-10 20:14:06 +00001388 assert( nResultCol==pDest->nSdst );
drh53932ce2014-08-29 12:29:39 +00001389 assert( regResult==iParm );
drhec7429a2005-10-06 16:53:14 +00001390 /* The LIMIT clause will jump out of the loop for us */
drhc926afb2002-06-20 03:38:26 +00001391 }
1392 break;
1393 }
danielk197793758c82005-01-21 08:13:14 +00001394#endif /* #ifndef SQLITE_OMIT_SUBQUERY */
drh22827922000-06-06 17:27:05 +00001395
drh81cf13e2014-02-07 18:27:53 +00001396 case SRT_Coroutine: /* Send data to a co-routine */
1397 case SRT_Output: { /* Return the results */
drh373cc2d2009-05-17 02:06:14 +00001398 testcase( eDest==SRT_Coroutine );
1399 testcase( eDest==SRT_Output );
drh079a3072014-03-19 14:10:55 +00001400 if( pSort ){
dan9af90b72016-11-11 18:08:59 +00001401 pushOntoSorter(pParse, pSort, p, regResult, regOrig, nResultCol,
drh5579d592015-08-26 14:01:41 +00001402 nPrefixReg);
drhe00ee6e2008-06-20 15:24:01 +00001403 }else if( eDest==SRT_Coroutine ){
drh2b596da2012-07-23 21:43:19 +00001404 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drhc182d162005-08-14 20:47:16 +00001405 }else{
drh340309f2014-01-22 00:23:49 +00001406 sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
drhac82fcf2002-09-08 17:23:41 +00001407 }
drh142e30d2002-08-28 03:00:58 +00001408 break;
1409 }
1410
drhfe1c6bb2014-01-22 17:28:35 +00001411#ifndef SQLITE_OMIT_CTE
1412 /* Write the results into a priority queue that is order according to
1413 ** pDest->pOrderBy (in pSO). pDest->iSDParm (in iParm) is the cursor for an
1414 ** index with pSO->nExpr+2 columns. Build a key using pSO for the first
1415 ** pSO->nExpr columns, then make sure all keys are unique by adding a
1416 ** final OP_Sequence column. The last column is the record as a blob.
1417 */
1418 case SRT_DistQueue:
1419 case SRT_Queue: {
1420 int nKey;
1421 int r1, r2, r3;
1422 int addrTest = 0;
1423 ExprList *pSO;
1424 pSO = pDest->pOrderBy;
1425 assert( pSO );
1426 nKey = pSO->nExpr;
1427 r1 = sqlite3GetTempReg(pParse);
1428 r2 = sqlite3GetTempRange(pParse, nKey+2);
1429 r3 = r2+nKey+1;
drhfe1c6bb2014-01-22 17:28:35 +00001430 if( eDest==SRT_DistQueue ){
1431 /* If the destination is DistQueue, then cursor (iParm+1) is open
1432 ** on a second ephemeral index that holds all values every previously
drh7e4efae2014-02-26 21:35:31 +00001433 ** added to the queue. */
1434 addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
1435 regResult, nResultCol);
drh688852a2014-02-17 22:40:43 +00001436 VdbeCoverage(v);
drh7e4efae2014-02-26 21:35:31 +00001437 }
1438 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
1439 if( eDest==SRT_DistQueue ){
drhfe1c6bb2014-01-22 17:28:35 +00001440 sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
dancfe24582014-01-22 19:23:30 +00001441 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
drhfe1c6bb2014-01-22 17:28:35 +00001442 }
1443 for(i=0; i<nKey; i++){
1444 sqlite3VdbeAddOp2(v, OP_SCopy,
1445 regResult + pSO->a[i].u.x.iOrderByCol - 1,
1446 r2+i);
1447 }
1448 sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
1449 sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
drh9b4eaeb2016-11-09 00:10:33 +00001450 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, r2, nKey+2);
drhfe1c6bb2014-01-22 17:28:35 +00001451 if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
1452 sqlite3ReleaseTempReg(pParse, r1);
1453 sqlite3ReleaseTempRange(pParse, r2, nKey+2);
1454 break;
1455 }
1456#endif /* SQLITE_OMIT_CTE */
1457
1458
1459
danielk19776a67fe82005-02-04 04:07:16 +00001460#if !defined(SQLITE_OMIT_TRIGGER)
drhc926afb2002-06-20 03:38:26 +00001461 /* Discard the results. This is used for SELECT statements inside
1462 ** the body of a TRIGGER. The purpose of such selects is to call
1463 ** user-defined functions that have side effects. We do not care
1464 ** about the actual results of the select.
1465 */
drhc926afb2002-06-20 03:38:26 +00001466 default: {
drhf46f9052002-06-22 02:33:38 +00001467 assert( eDest==SRT_Discard );
drhc926afb2002-06-20 03:38:26 +00001468 break;
1469 }
danielk197793758c82005-01-21 08:13:14 +00001470#endif
drh82c3d632000-06-06 21:56:07 +00001471 }
drhec7429a2005-10-06 16:53:14 +00001472
drh5e87be82010-10-06 18:55:37 +00001473 /* Jump to the end of the loop if the LIMIT is reached. Except, if
1474 ** there is a sorter, in which case the sorter has already limited
1475 ** the output for us.
drhec7429a2005-10-06 16:53:14 +00001476 */
drh079a3072014-03-19 14:10:55 +00001477 if( pSort==0 && p->iLimit ){
drh16897072015-03-07 00:57:37 +00001478 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
drhec7429a2005-10-06 16:53:14 +00001479 }
drh82c3d632000-06-06 21:56:07 +00001480}
1481
1482/*
drhad124322013-10-23 13:30:58 +00001483** Allocate a KeyInfo object sufficient for an index of N key columns and
1484** X extra columns.
drh323df792013-08-05 19:11:29 +00001485*/
drhad124322013-10-23 13:30:58 +00001486KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
drhd4ab0032017-05-31 13:45:59 +00001487 int nExtra = (N+X)*(sizeof(CollSeq*)+1) - sizeof(CollSeq*);
drhd8e4b132016-10-01 19:21:56 +00001488 KeyInfo *p = sqlite3DbMallocRawNN(db, sizeof(KeyInfo) + nExtra);
drh323df792013-08-05 19:11:29 +00001489 if( p ){
dan6e118922019-08-12 16:36:38 +00001490 p->aSortFlags = (u8*)&p->aColl[N+X];
drha485ad12017-08-02 22:43:14 +00001491 p->nKeyField = (u16)N;
1492 p->nAllField = (u16)(N+X);
drh323df792013-08-05 19:11:29 +00001493 p->enc = ENC(db);
1494 p->db = db;
drh2ec2fb22013-11-06 19:59:23 +00001495 p->nRef = 1;
drhc263f7c2016-01-18 13:18:54 +00001496 memset(&p[1], 0, nExtra);
drh2ec2fb22013-11-06 19:59:23 +00001497 }else{
drh3cdb1392022-01-24 12:48:54 +00001498 return (KeyInfo*)sqlite3OomFault(db);
drh323df792013-08-05 19:11:29 +00001499 }
1500 return p;
1501}
1502
1503/*
drh2ec2fb22013-11-06 19:59:23 +00001504** Deallocate a KeyInfo object
1505*/
1506void sqlite3KeyInfoUnref(KeyInfo *p){
1507 if( p ){
drh41ce47c2022-08-22 02:00:26 +00001508 assert( p->db!=0 );
drh2ec2fb22013-11-06 19:59:23 +00001509 assert( p->nRef>0 );
drh2ec2fb22013-11-06 19:59:23 +00001510 p->nRef--;
drh41ce47c2022-08-22 02:00:26 +00001511 if( p->nRef==0 ) sqlite3DbNNFreeNN(p->db, p);
drh2ec2fb22013-11-06 19:59:23 +00001512 }
1513}
1514
1515/*
1516** Make a new pointer to a KeyInfo object
1517*/
1518KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
1519 if( p ){
1520 assert( p->nRef>0 );
1521 p->nRef++;
1522 }
1523 return p;
1524}
1525
1526#ifdef SQLITE_DEBUG
1527/*
1528** Return TRUE if a KeyInfo object can be change. The KeyInfo object
1529** can only be changed if this is just a single reference to the object.
1530**
1531** This routine is used only inside of assert() statements.
1532*/
1533int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
1534#endif /* SQLITE_DEBUG */
1535
1536/*
drhdece1a82005-08-31 18:20:00 +00001537** Given an expression list, generate a KeyInfo structure that records
1538** the collating sequence for each expression in that expression list.
1539**
drh0342b1f2005-09-01 03:07:44 +00001540** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
1541** KeyInfo structure is appropriate for initializing a virtual index to
1542** implement that clause. If the ExprList is the result set of a SELECT
1543** then the KeyInfo structure is appropriate for initializing a virtual
1544** index to implement a DISTINCT test.
1545**
peter.d.reid60ec9142014-09-06 16:39:46 +00001546** Space to hold the KeyInfo structure is obtained from malloc. The calling
drhdece1a82005-08-31 18:20:00 +00001547** function is responsible for seeing that this structure is eventually
drh2ec2fb22013-11-06 19:59:23 +00001548** freed.
drhdece1a82005-08-31 18:20:00 +00001549*/
danf9eae182018-05-21 19:45:11 +00001550KeyInfo *sqlite3KeyInfoFromExprList(
drh079a3072014-03-19 14:10:55 +00001551 Parse *pParse, /* Parsing context */
1552 ExprList *pList, /* Form the KeyInfo object from this ExprList */
1553 int iStart, /* Begin with this column of pList */
1554 int nExtra /* Add this many extra columns to the end */
1555){
drhdece1a82005-08-31 18:20:00 +00001556 int nExpr;
1557 KeyInfo *pInfo;
1558 struct ExprList_item *pItem;
drh323df792013-08-05 19:11:29 +00001559 sqlite3 *db = pParse->db;
drhdece1a82005-08-31 18:20:00 +00001560 int i;
1561
1562 nExpr = pList->nExpr;
drh3f39bcf2015-01-19 20:59:34 +00001563 pInfo = sqlite3KeyInfoAlloc(db, nExpr-iStart, nExtra+1);
drhdece1a82005-08-31 18:20:00 +00001564 if( pInfo ){
drh2ec2fb22013-11-06 19:59:23 +00001565 assert( sqlite3KeyInfoIsWriteable(pInfo) );
drh6284db92014-03-19 23:24:49 +00001566 for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
drh70efa842017-09-28 01:58:23 +00001567 pInfo->aColl[i-iStart] = sqlite3ExprNNCollSeq(pParse, pItem->pExpr);
drhd88fd532022-05-02 20:49:30 +00001568 pInfo->aSortFlags[i-iStart] = pItem->fg.sortFlags;
drhdece1a82005-08-31 18:20:00 +00001569 }
1570 }
1571 return pInfo;
1572}
1573
dan7f61e922010-11-11 16:46:40 +00001574/*
1575** Name of the connection operator, used for error messages.
1576*/
drhaae0f742021-03-04 16:03:32 +00001577const char *sqlite3SelectOpName(int id){
dan7f61e922010-11-11 16:46:40 +00001578 char *z;
1579 switch( id ){
1580 case TK_ALL: z = "UNION ALL"; break;
1581 case TK_INTERSECT: z = "INTERSECT"; break;
1582 case TK_EXCEPT: z = "EXCEPT"; break;
1583 default: z = "UNION"; break;
1584 }
1585 return z;
1586}
dan7f61e922010-11-11 16:46:40 +00001587
dan2ce22452010-11-08 19:01:16 +00001588#ifndef SQLITE_OMIT_EXPLAIN
dan17c0bc02010-11-09 17:35:19 +00001589/*
1590** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
1591** is a no-op. Otherwise, it adds a single row of output to the EQP result,
1592** where the caption is of the form:
1593**
1594** "USE TEMP B-TREE FOR xxx"
1595**
1596** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
1597** is determined by the zUsage argument.
1598*/
dan2ce22452010-11-08 19:01:16 +00001599static void explainTempTable(Parse *pParse, const char *zUsage){
drhe2ca99c2018-05-02 00:33:43 +00001600 ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s", zUsage));
dan2ce22452010-11-08 19:01:16 +00001601}
dan17c0bc02010-11-09 17:35:19 +00001602
1603/*
danbb2b4412011-04-06 17:54:31 +00001604** Assign expression b to lvalue a. A second, no-op, version of this macro
1605** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
1606** in sqlite3Select() to assign values to structure member variables that
1607** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
1608** code with #ifndef directives.
1609*/
1610# define explainSetInteger(a, b) a = b
1611
1612#else
1613/* No-op versions of the explainXXX() functions and macros. */
1614# define explainTempTable(y,z)
1615# define explainSetInteger(y,z)
1616#endif
1617
drhdece1a82005-08-31 18:20:00 +00001618
1619/*
drhd8bc7082000-06-07 23:51:50 +00001620** If the inner loop was generated using a non-null pOrderBy argument,
1621** then the results were placed in a sorter. After the loop is terminated
1622** we need to run the sorter and output the results. The following
1623** routine generates the code needed to do that.
1624*/
drhc926afb2002-06-20 03:38:26 +00001625static void generateSortTail(
danielk19776c8c8ce2008-01-02 16:27:09 +00001626 Parse *pParse, /* Parsing context */
1627 Select *p, /* The SELECT statement */
drh079a3072014-03-19 14:10:55 +00001628 SortCtx *pSort, /* Information on the ORDER BY clause */
danielk19776c8c8ce2008-01-02 16:27:09 +00001629 int nColumn, /* Number of columns of data */
1630 SelectDest *pDest /* Write the sorted results here */
drhc926afb2002-06-20 03:38:26 +00001631){
drhddba0c22014-03-18 20:33:42 +00001632 Vdbe *v = pParse->pVdbe; /* The prepared statement */
drha04a8be2016-01-13 17:50:10 +00001633 int addrBreak = pSort->labelDone; /* Jump here to exit loop */
drhec4ccdb2018-12-29 02:26:59 +00001634 int addrContinue = sqlite3VdbeMakeLabel(pParse);/* Jump here for next cycle */
dan24e25d32018-04-14 18:46:20 +00001635 int addr; /* Top of output loop. Jump for Next. */
drh079a3072014-03-19 14:10:55 +00001636 int addrOnce = 0;
drh0342b1f2005-09-01 03:07:44 +00001637 int iTab;
drh079a3072014-03-19 14:10:55 +00001638 ExprList *pOrderBy = pSort->pOrderBy;
danielk19776c8c8ce2008-01-02 16:27:09 +00001639 int eDest = pDest->eDest;
drh2b596da2012-07-23 21:43:19 +00001640 int iParm = pDest->iSDParm;
drh2d401ab2008-01-10 23:50:11 +00001641 int regRow;
1642 int regRowid;
dan257c13f2016-11-10 20:14:06 +00001643 int iCol;
dan24e25d32018-04-14 18:46:20 +00001644 int nKey; /* Number of key columns in sorter record */
drhf45f2322014-03-23 17:45:03 +00001645 int iSortTab; /* Sorter cursor to read from */
drhf45f2322014-03-23 17:45:03 +00001646 int i;
dan78d58432014-03-25 15:04:07 +00001647 int bSeq; /* True if sorter record includes seq. no. */
dan24e25d32018-04-14 18:46:20 +00001648 int nRefKey = 0;
drh70f624c2014-03-24 01:43:50 +00001649 struct ExprList_item *aOutEx = p->pEList->a;
drh2d401ab2008-01-10 23:50:11 +00001650
drha04a8be2016-01-13 17:50:10 +00001651 assert( addrBreak<0 );
drh079a3072014-03-19 14:10:55 +00001652 if( pSort->labelBkOut ){
1653 sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
drh076e85f2015-09-03 13:46:12 +00001654 sqlite3VdbeGoto(v, addrBreak);
drh079a3072014-03-19 14:10:55 +00001655 sqlite3VdbeResolveLabel(v, pSort->labelBkOut);
drh079a3072014-03-19 14:10:55 +00001656 }
dan24e25d32018-04-14 18:46:20 +00001657
1658#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1659 /* Open any cursors needed for sorter-reference expressions */
1660 for(i=0; i<pSort->nDefer; i++){
1661 Table *pTab = pSort->aDefer[i].pTab;
1662 int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
1663 sqlite3OpenTable(pParse, pSort->aDefer[i].iCsr, iDb, pTab, OP_OpenRead);
1664 nRefKey = MAX(nRefKey, pSort->aDefer[i].nKey);
1665 }
1666#endif
1667
drh079a3072014-03-19 14:10:55 +00001668 iTab = pSort->iECursor;
dan71c57db2016-07-09 20:23:55 +00001669 if( eDest==SRT_Output || eDest==SRT_Coroutine || eDest==SRT_Mem ){
drh8efc6a82022-01-12 20:31:14 +00001670 if( eDest==SRT_Mem && p->iOffset ){
1671 sqlite3VdbeAddOp2(v, OP_Null, 0, pDest->iSdst);
1672 }
drh3e9ca092009-09-08 01:14:48 +00001673 regRowid = 0;
drhf45f2322014-03-23 17:45:03 +00001674 regRow = pDest->iSdst;
drhed24da42016-09-06 14:37:05 +00001675 }else{
dan51d82d12016-08-02 18:50:15 +00001676 regRowid = sqlite3GetTempReg(pParse);
drh375afb82019-01-16 19:26:31 +00001677 if( eDest==SRT_EphemTab || eDest==SRT_Table ){
1678 regRow = sqlite3GetTempReg(pParse);
1679 nColumn = 0;
1680 }else{
1681 regRow = sqlite3GetTempRange(pParse, nColumn);
1682 }
drhcdd536f2006-03-17 00:04:03 +00001683 }
drh079a3072014-03-19 14:10:55 +00001684 nKey = pOrderBy->nExpr - pSort->nOBSat;
1685 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drhc2bb3282011-09-04 01:11:46 +00001686 int regSortOut = ++pParse->nMem;
drhf45f2322014-03-23 17:45:03 +00001687 iSortTab = pParse->nTab++;
drh83553ee2014-03-24 02:20:53 +00001688 if( pSort->labelBkOut ){
drh511f9e82016-09-22 18:53:13 +00001689 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drh83553ee2014-03-24 02:20:53 +00001690 }
dan24e25d32018-04-14 18:46:20 +00001691 sqlite3VdbeAddOp3(v, OP_OpenPseudo, iSortTab, regSortOut,
1692 nKey+1+nColumn+nRefKey);
drh079a3072014-03-19 14:10:55 +00001693 if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
drhc6aff302011-09-01 15:32:47 +00001694 addr = 1 + sqlite3VdbeAddOp2(v, OP_SorterSort, iTab, addrBreak);
drh688852a2014-02-17 22:40:43 +00001695 VdbeCoverage(v);
drhbffd5c12022-08-04 17:15:00 +00001696 assert( p->iLimit==0 && p->iOffset==0 );
drh6cf4a7d2014-10-13 13:00:58 +00001697 sqlite3VdbeAddOp3(v, OP_SorterData, iTab, regSortOut, iSortTab);
dan78d58432014-03-25 15:04:07 +00001698 bSeq = 0;
drhc6aff302011-09-01 15:32:47 +00001699 }else{
drh688852a2014-02-17 22:40:43 +00001700 addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
drhaa9ce702014-01-22 18:07:04 +00001701 codeOffset(v, p->iOffset, addrContinue);
drhf45f2322014-03-23 17:45:03 +00001702 iSortTab = iTab;
dan78d58432014-03-25 15:04:07 +00001703 bSeq = 1;
drhbffd5c12022-08-04 17:15:00 +00001704 if( p->iOffset>0 ){
1705 sqlite3VdbeAddOp2(v, OP_AddImm, p->iLimit, -1);
1706 }
drhf45f2322014-03-23 17:45:03 +00001707 }
dand6189ea2018-04-11 14:11:53 +00001708 for(i=0, iCol=nKey+bSeq-1; i<nColumn; i++){
dan24e25d32018-04-14 18:46:20 +00001709#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001710 if( aOutEx[i].fg.bSorterRef ) continue;
dan24e25d32018-04-14 18:46:20 +00001711#endif
drh9f895232018-01-24 20:42:42 +00001712 if( aOutEx[i].u.x.iOrderByCol==0 ) iCol++;
1713 }
dan24e25d32018-04-14 18:46:20 +00001714#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1715 if( pSort->nDefer ){
1716 int iKey = iCol+1;
1717 int regKey = sqlite3GetTempRange(pParse, nRefKey);
1718
1719 for(i=0; i<pSort->nDefer; i++){
1720 int iCsr = pSort->aDefer[i].iCsr;
1721 Table *pTab = pSort->aDefer[i].pTab;
1722 int nKey = pSort->aDefer[i].nKey;
1723
1724 sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1725 if( HasRowid(pTab) ){
1726 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey);
1727 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCsr,
1728 sqlite3VdbeCurrentAddr(v)+1, regKey);
1729 }else{
dan24e25d32018-04-14 18:46:20 +00001730 int k;
1731 int iJmp;
drh7590d092018-04-18 14:04:19 +00001732 assert( sqlite3PrimaryKeyIndex(pTab)->nKeyCol==nKey );
dan24e25d32018-04-14 18:46:20 +00001733 for(k=0; k<nKey; k++){
1734 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey+k);
1735 }
1736 iJmp = sqlite3VdbeCurrentAddr(v);
1737 sqlite3VdbeAddOp4Int(v, OP_SeekGE, iCsr, iJmp+2, regKey, nKey);
1738 sqlite3VdbeAddOp4Int(v, OP_IdxLE, iCsr, iJmp+3, regKey, nKey);
1739 sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1740 }
dan257c13f2016-11-10 20:14:06 +00001741 }
dan24e25d32018-04-14 18:46:20 +00001742 sqlite3ReleaseTempRange(pParse, regKey, nRefKey);
1743 }
1744#endif
1745 for(i=nColumn-1; i>=0; i--){
1746#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001747 if( aOutEx[i].fg.bSorterRef ){
dan24e25d32018-04-14 18:46:20 +00001748 sqlite3ExprCode(pParse, aOutEx[i].pExpr, regRow+i);
1749 }else
1750#endif
1751 {
1752 int iRead;
1753 if( aOutEx[i].u.x.iOrderByCol ){
1754 iRead = aOutEx[i].u.x.iOrderByCol-1;
1755 }else{
1756 iRead = iCol--;
1757 }
1758 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iRead, regRow+i);
drhcbb9da32019-12-12 22:11:33 +00001759 VdbeComment((v, "%s", aOutEx[i].zEName));
dan24e25d32018-04-14 18:46:20 +00001760 }
drhc6aff302011-09-01 15:32:47 +00001761 }
drhc926afb2002-06-20 03:38:26 +00001762 switch( eDest ){
danac56ab72017-01-05 17:23:11 +00001763 case SRT_Table:
drhb9bb7c12006-06-11 23:41:55 +00001764 case SRT_EphemTab: {
drh375afb82019-01-16 19:26:31 +00001765 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, nKey+bSeq, regRow);
drh2d401ab2008-01-10 23:50:11 +00001766 sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
1767 sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
1768 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
drhc926afb2002-06-20 03:38:26 +00001769 break;
1770 }
danielk197793758c82005-01-21 08:13:14 +00001771#ifndef SQLITE_OMIT_SUBQUERY
drhc926afb2002-06-20 03:38:26 +00001772 case SRT_Set: {
dan71c57db2016-07-09 20:23:55 +00001773 assert( nColumn==sqlite3Strlen30(pDest->zAffSdst) );
1774 sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, nColumn, regRowid,
dan553168c2016-08-01 20:14:31 +00001775 pDest->zAffSdst, nColumn);
drh9b4eaeb2016-11-09 00:10:33 +00001776 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, regRowid, regRow, nColumn);
drhc926afb2002-06-20 03:38:26 +00001777 break;
1778 }
1779 case SRT_Mem: {
drhec7429a2005-10-06 16:53:14 +00001780 /* The LIMIT clause will terminate the loop for us */
drhc926afb2002-06-20 03:38:26 +00001781 break;
1782 }
danielk197793758c82005-01-21 08:13:14 +00001783#endif
danf2972b62020-04-29 20:11:01 +00001784 case SRT_Upfrom: {
1785 int i2 = pDest->iSDParm2;
1786 int r1 = sqlite3GetTempReg(pParse);
1787 sqlite3VdbeAddOp3(v, OP_MakeRecord,regRow+(i2<0),nColumn-(i2<0),r1);
1788 if( i2<0 ){
1789 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regRow);
1790 }else{
1791 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regRow, i2);
1792 }
1793 break;
1794 }
drh373cc2d2009-05-17 02:06:14 +00001795 default: {
drh373cc2d2009-05-17 02:06:14 +00001796 assert( eDest==SRT_Output || eDest==SRT_Coroutine );
drh1c767f02009-01-09 02:49:31 +00001797 testcase( eDest==SRT_Output );
1798 testcase( eDest==SRT_Coroutine );
drh7d10d5a2008-08-20 16:35:10 +00001799 if( eDest==SRT_Output ){
drh2b596da2012-07-23 21:43:19 +00001800 sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
drha9671a22008-07-08 23:40:20 +00001801 }else{
drh2b596da2012-07-23 21:43:19 +00001802 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drhce665cf2004-05-21 03:01:58 +00001803 }
drhac82fcf2002-09-08 17:23:41 +00001804 break;
1805 }
drhc926afb2002-06-20 03:38:26 +00001806 }
drhf45f2322014-03-23 17:45:03 +00001807 if( regRowid ){
dan51d82d12016-08-02 18:50:15 +00001808 if( eDest==SRT_Set ){
1809 sqlite3ReleaseTempRange(pParse, regRow, nColumn);
1810 }else{
1811 sqlite3ReleaseTempReg(pParse, regRow);
1812 }
drhf45f2322014-03-23 17:45:03 +00001813 sqlite3ReleaseTempReg(pParse, regRowid);
1814 }
drhec7429a2005-10-06 16:53:14 +00001815 /* The bottom of the loop
1816 */
drhdc5ea5c2008-12-10 17:19:59 +00001817 sqlite3VdbeResolveLabel(v, addrContinue);
drh079a3072014-03-19 14:10:55 +00001818 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drh688852a2014-02-17 22:40:43 +00001819 sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
drhc6aff302011-09-01 15:32:47 +00001820 }else{
drh688852a2014-02-17 22:40:43 +00001821 sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
drhc6aff302011-09-01 15:32:47 +00001822 }
drh079a3072014-03-19 14:10:55 +00001823 if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
drhdc5ea5c2008-12-10 17:19:59 +00001824 sqlite3VdbeResolveLabel(v, addrBreak);
drhd8bc7082000-06-07 23:51:50 +00001825}
1826
1827/*
danielk1977517eb642004-06-07 10:00:31 +00001828** Return a pointer to a string containing the 'declaration type' of the
1829** expression pExpr. The string may be treated as static by the caller.
drhe78e8282003-01-19 03:59:45 +00001830**
danielk1977955de522006-02-10 02:27:42 +00001831** The declaration type is the exact datatype definition extracted from the
1832** original CREATE TABLE statement if the expression is a column. The
1833** declaration type for a ROWID field is INTEGER. Exactly when an expression
1834** is considered a column can be complex in the presence of subqueries. The
1835** result-set expression in all of the following SELECT statements is
1836** considered a column by this function.
1837**
1838** SELECT col FROM tbl;
1839** SELECT (SELECT col FROM tbl;
1840** SELECT (SELECT col FROM tbl);
1841** SELECT abc FROM (SELECT col AS abc FROM tbl);
danielk1977517eb642004-06-07 10:00:31 +00001842**
danielk1977955de522006-02-10 02:27:42 +00001843** The declaration type for any expression other than a column is NULL.
drh5f3e5e72013-10-08 20:01:35 +00001844**
1845** This routine has either 3 or 6 parameters depending on whether or not
1846** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
danielk1977517eb642004-06-07 10:00:31 +00001847*/
drh5f3e5e72013-10-08 20:01:35 +00001848#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhcafc2f72017-10-03 03:01:09 +00001849# define columnType(A,B,C,D,E) columnTypeImpl(A,B,C,D,E)
drhb121dd12015-06-06 18:30:17 +00001850#else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
drhcafc2f72017-10-03 03:01:09 +00001851# define columnType(A,B,C,D,E) columnTypeImpl(A,B)
drhb121dd12015-06-06 18:30:17 +00001852#endif
drh5f3e5e72013-10-08 20:01:35 +00001853static const char *columnTypeImpl(
danielk1977955de522006-02-10 02:27:42 +00001854 NameContext *pNC,
drhcafc2f72017-10-03 03:01:09 +00001855#ifndef SQLITE_ENABLE_COLUMN_METADATA
1856 Expr *pExpr
1857#else
danielk1977955de522006-02-10 02:27:42 +00001858 Expr *pExpr,
drh5f3e5e72013-10-08 20:01:35 +00001859 const char **pzOrigDb,
1860 const char **pzOrigTab,
drhcafc2f72017-10-03 03:01:09 +00001861 const char **pzOrigCol
drhb121dd12015-06-06 18:30:17 +00001862#endif
danielk1977955de522006-02-10 02:27:42 +00001863){
1864 char const *zType = 0;
danielk1977517eb642004-06-07 10:00:31 +00001865 int j;
drhb121dd12015-06-06 18:30:17 +00001866#ifdef SQLITE_ENABLE_COLUMN_METADATA
1867 char const *zOrigDb = 0;
1868 char const *zOrigTab = 0;
1869 char const *zOrigCol = 0;
1870#endif
danielk19775338a5f2005-01-20 13:03:10 +00001871
drhf7ce4292015-12-02 19:46:12 +00001872 assert( pExpr!=0 );
1873 assert( pNC->pSrcList!=0 );
danielk197700e279d2004-06-21 07:36:32 +00001874 switch( pExpr->op ){
1875 case TK_COLUMN: {
danielk1977955de522006-02-10 02:27:42 +00001876 /* The expression is a column. Locate the table the column is being
1877 ** extracted from in NameContext.pSrcList. This table may be real
1878 ** database table or a subquery.
1879 */
1880 Table *pTab = 0; /* Table structure column is extracted from */
1881 Select *pS = 0; /* Select the column is extracted from */
1882 int iCol = pExpr->iColumn; /* Index of column in pTab */
dan43bc88b2009-09-10 10:15:59 +00001883 while( pNC && !pTab ){
danielk1977b3bce662005-01-29 08:32:43 +00001884 SrcList *pTabList = pNC->pSrcList;
1885 for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
1886 if( j<pTabList->nSrc ){
1887 pTab = pTabList->a[j].pTab;
danielk1977955de522006-02-10 02:27:42 +00001888 pS = pTabList->a[j].pSelect;
danielk1977b3bce662005-01-29 08:32:43 +00001889 }else{
1890 pNC = pNC->pNext;
1891 }
1892 }
danielk1977955de522006-02-10 02:27:42 +00001893
dan43bc88b2009-09-10 10:15:59 +00001894 if( pTab==0 ){
drh417168a2009-09-07 18:14:02 +00001895 /* At one time, code such as "SELECT new.x" within a trigger would
1896 ** cause this condition to run. Since then, we have restructured how
1897 ** trigger code is generated and so this condition is no longer
dan43bc88b2009-09-10 10:15:59 +00001898 ** possible. However, it can still be true for statements like
1899 ** the following:
1900 **
1901 ** CREATE TABLE t1(col INTEGER);
1902 ** SELECT (SELECT t1.col) FROM FROM t1;
1903 **
1904 ** when columnType() is called on the expression "t1.col" in the
1905 ** sub-select. In this case, set the column type to NULL, even
1906 ** though it should really be "INTEGER".
1907 **
1908 ** This is not a problem, as the column type of "t1.col" is never
1909 ** used. When columnType() is called on the expression
1910 ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
1911 ** branch below. */
drh7e627792005-04-29 02:10:00 +00001912 break;
1913 }
danielk1977955de522006-02-10 02:27:42 +00001914
drh477572b2021-10-07 20:46:29 +00001915 assert( pTab && ExprUseYTab(pExpr) && pExpr->y.pTab==pTab );
danielk1977955de522006-02-10 02:27:42 +00001916 if( pS ){
1917 /* The "table" is actually a sub-select or a view in the FROM clause
1918 ** of the SELECT statement. Return the declaration type and origin
1919 ** data for the result-set column of the sub-select.
1920 */
drh6e5020e2021-04-07 15:45:01 +00001921 if( iCol<pS->pEList->nExpr
1922#ifdef SQLITE_ALLOW_ROWID_IN_VIEW
1923 && iCol>=0
1924#else
1925 && ALWAYS(iCol>=0)
1926#endif
1927 ){
danielk1977955de522006-02-10 02:27:42 +00001928 /* If iCol is less than zero, then the expression requests the
1929 ** rowid of the sub-select or view. This expression is legal (see
1930 ** test case misc2.2.2) - it always evaluates to NULL.
1931 */
1932 NameContext sNC;
1933 Expr *p = pS->pEList->a[iCol].pExpr;
1934 sNC.pSrcList = pS->pSrc;
dan43bc88b2009-09-10 10:15:59 +00001935 sNC.pNext = pNC;
danielk1977955de522006-02-10 02:27:42 +00001936 sNC.pParse = pNC->pParse;
drhcafc2f72017-10-03 03:01:09 +00001937 zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol);
danielk1977955de522006-02-10 02:27:42 +00001938 }
drha78d7572017-10-03 16:57:33 +00001939 }else{
1940 /* A real table or a CTE table */
danielk1977955de522006-02-10 02:27:42 +00001941 assert( !pS );
drh5f3e5e72013-10-08 20:01:35 +00001942#ifdef SQLITE_ENABLE_COLUMN_METADATA
drha78d7572017-10-03 16:57:33 +00001943 if( iCol<0 ) iCol = pTab->iPKey;
1944 assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
danielk1977955de522006-02-10 02:27:42 +00001945 if( iCol<0 ){
1946 zType = "INTEGER";
drh5f3e5e72013-10-08 20:01:35 +00001947 zOrigCol = "rowid";
danielk1977955de522006-02-10 02:27:42 +00001948 }else{
drhcf9d36d2021-08-02 18:03:43 +00001949 zOrigCol = pTab->aCol[iCol].zCnName;
drhd7564862016-03-22 20:05:09 +00001950 zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
danielk1977955de522006-02-10 02:27:42 +00001951 }
drh5f3e5e72013-10-08 20:01:35 +00001952 zOrigTab = pTab->zName;
drha78d7572017-10-03 16:57:33 +00001953 if( pNC->pParse && pTab->pSchema ){
danielk1977955de522006-02-10 02:27:42 +00001954 int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
drhe59be012016-08-18 20:56:39 +00001955 zOrigDb = pNC->pParse->db->aDb[iDb].zDbSName;
danielk1977955de522006-02-10 02:27:42 +00001956 }
drh5f3e5e72013-10-08 20:01:35 +00001957#else
drha78d7572017-10-03 16:57:33 +00001958 assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
drh5f3e5e72013-10-08 20:01:35 +00001959 if( iCol<0 ){
1960 zType = "INTEGER";
1961 }else{
drhd7564862016-03-22 20:05:09 +00001962 zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
drh5f3e5e72013-10-08 20:01:35 +00001963 }
1964#endif
danielk197700e279d2004-06-21 07:36:32 +00001965 }
1966 break;
danielk1977517eb642004-06-07 10:00:31 +00001967 }
danielk197793758c82005-01-21 08:13:14 +00001968#ifndef SQLITE_OMIT_SUBQUERY
danielk197700e279d2004-06-21 07:36:32 +00001969 case TK_SELECT: {
danielk1977955de522006-02-10 02:27:42 +00001970 /* The expression is a sub-select. Return the declaration type and
1971 ** origin info for the single column in the result set of the SELECT
1972 ** statement.
1973 */
danielk1977b3bce662005-01-29 08:32:43 +00001974 NameContext sNC;
drha4eeccd2021-10-07 17:43:30 +00001975 Select *pS;
1976 Expr *p;
1977 assert( ExprUseXSelect(pExpr) );
1978 pS = pExpr->x.pSelect;
1979 p = pS->pEList->a[0].pExpr;
danielk1977955de522006-02-10 02:27:42 +00001980 sNC.pSrcList = pS->pSrc;
danielk1977b3bce662005-01-29 08:32:43 +00001981 sNC.pNext = pNC;
danielk1977955de522006-02-10 02:27:42 +00001982 sNC.pParse = pNC->pParse;
drhcafc2f72017-10-03 03:01:09 +00001983 zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
danielk197700e279d2004-06-21 07:36:32 +00001984 break;
danielk1977517eb642004-06-07 10:00:31 +00001985 }
danielk197793758c82005-01-21 08:13:14 +00001986#endif
danielk1977517eb642004-06-07 10:00:31 +00001987 }
drh5f3e5e72013-10-08 20:01:35 +00001988
1989#ifdef SQLITE_ENABLE_COLUMN_METADATA
1990 if( pzOrigDb ){
1991 assert( pzOrigTab && pzOrigCol );
1992 *pzOrigDb = zOrigDb;
1993 *pzOrigTab = zOrigTab;
1994 *pzOrigCol = zOrigCol;
danielk1977955de522006-02-10 02:27:42 +00001995 }
drh5f3e5e72013-10-08 20:01:35 +00001996#endif
danielk1977517eb642004-06-07 10:00:31 +00001997 return zType;
1998}
1999
2000/*
2001** Generate code that will tell the VDBE the declaration types of columns
2002** in the result set.
drhfcb78a42003-01-18 20:11:05 +00002003*/
2004static void generateColumnTypes(
2005 Parse *pParse, /* Parser context */
drhfcb78a42003-01-18 20:11:05 +00002006 SrcList *pTabList, /* List of tables */
2007 ExprList *pEList /* Expressions defining the result set */
2008){
drh3f913572008-03-22 01:07:17 +00002009#ifndef SQLITE_OMIT_DECLTYPE
drhfcb78a42003-01-18 20:11:05 +00002010 Vdbe *v = pParse->pVdbe;
danielk1977517eb642004-06-07 10:00:31 +00002011 int i;
danielk1977b3bce662005-01-29 08:32:43 +00002012 NameContext sNC;
2013 sNC.pSrcList = pTabList;
danielk1977955de522006-02-10 02:27:42 +00002014 sNC.pParse = pParse;
drheac5fc02017-04-11 01:01:27 +00002015 sNC.pNext = 0;
drhfcb78a42003-01-18 20:11:05 +00002016 for(i=0; i<pEList->nExpr; i++){
2017 Expr *p = pEList->a[i].pExpr;
drh3f913572008-03-22 01:07:17 +00002018 const char *zType;
2019#ifdef SQLITE_ENABLE_COLUMN_METADATA
danielk1977955de522006-02-10 02:27:42 +00002020 const char *zOrigDb = 0;
2021 const char *zOrigTab = 0;
2022 const char *zOrigCol = 0;
drhcafc2f72017-10-03 03:01:09 +00002023 zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
danielk1977955de522006-02-10 02:27:42 +00002024
drh85b623f2007-12-13 21:54:09 +00002025 /* The vdbe must make its own copy of the column-type and other
danielk19774b1ae992006-02-10 03:06:10 +00002026 ** column specific strings, in case the schema is reset before this
2027 ** virtual machine is deleted.
danielk1977fbcd5852004-06-15 02:44:18 +00002028 */
danielk197710fb7492008-10-31 10:53:22 +00002029 sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
2030 sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
2031 sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
drh3f913572008-03-22 01:07:17 +00002032#else
drhcafc2f72017-10-03 03:01:09 +00002033 zType = columnType(&sNC, p, 0, 0, 0);
drh3f913572008-03-22 01:07:17 +00002034#endif
danielk197710fb7492008-10-31 10:53:22 +00002035 sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
drhfcb78a42003-01-18 20:11:05 +00002036 }
drh5f3e5e72013-10-08 20:01:35 +00002037#endif /* !defined(SQLITE_OMIT_DECLTYPE) */
drhfcb78a42003-01-18 20:11:05 +00002038}
2039
drheac5fc02017-04-11 01:01:27 +00002040
2041/*
drhec360a82017-07-12 14:10:19 +00002042** Compute the column names for a SELECT statement.
2043**
2044** The only guarantee that SQLite makes about column names is that if the
2045** column has an AS clause assigning it a name, that will be the name used.
2046** That is the only documented guarantee. However, countless applications
2047** developed over the years have made baseless assumptions about column names
2048** and will break if those assumptions changes. Hence, use extreme caution
2049** when modifying this routine to avoid breaking legacy.
2050**
2051** See Also: sqlite3ColumnsFromExprList()
2052**
2053** The PRAGMA short_column_names and PRAGMA full_column_names settings are
2054** deprecated. The default setting is short=ON, full=OFF. 99.9% of all
2055** applications should operate this way. Nevertheless, we need to support the
2056** other modes for legacy:
2057**
2058** short=OFF, full=OFF: Column name is the text of the expression has it
2059** originally appears in the SELECT statement. In
2060** other words, the zSpan of the result expression.
2061**
2062** short=ON, full=OFF: (This is the default setting). If the result
drh3d240d22017-09-28 16:56:55 +00002063** refers directly to a table column, then the
2064** result column name is just the table column
2065** name: COLUMN. Otherwise use zSpan.
drhec360a82017-07-12 14:10:19 +00002066**
2067** full=ON, short=ANY: If the result refers directly to a table column,
2068** then the result column name with the table name
2069** prefix, ex: TABLE.COLUMN. Otherwise use zSpan.
drh82c3d632000-06-06 21:56:07 +00002070*/
drh90881862021-05-19 12:17:03 +00002071void sqlite3GenerateColumnNames(
drh832508b2002-03-02 17:04:07 +00002072 Parse *pParse, /* Parser context */
drhf35f2f92017-07-29 16:01:55 +00002073 Select *pSelect /* Generate column names for this SELECT statement */
drh832508b2002-03-02 17:04:07 +00002074){
drhd8bc7082000-06-07 23:51:50 +00002075 Vdbe *v = pParse->pVdbe;
drheac5fc02017-04-11 01:01:27 +00002076 int i;
2077 Table *pTab;
drhf35f2f92017-07-29 16:01:55 +00002078 SrcList *pTabList;
2079 ExprList *pEList;
drh9bb575f2004-09-06 17:24:11 +00002080 sqlite3 *db = pParse->db;
drhf35f2f92017-07-29 16:01:55 +00002081 int fullName; /* TABLE.COLUMN if no AS clause and is a direct table ref */
2082 int srcName; /* COLUMN or TABLE.COLUMN if no AS clause and is direct */
drhfcabd462004-02-20 14:50:58 +00002083
drhfe2093d2005-01-20 22:48:47 +00002084#ifndef SQLITE_OMIT_EXPLAIN
danielk19773cf86062004-05-26 10:11:05 +00002085 /* If this is an EXPLAIN, skip this step */
2086 if( pParse->explain ){
danielk197761de0d12004-05-27 23:56:16 +00002087 return;
danielk19773cf86062004-05-26 10:11:05 +00002088 }
danielk19775338a5f2005-01-20 13:03:10 +00002089#endif
danielk19773cf86062004-05-26 10:11:05 +00002090
drh5e8b9852018-05-03 22:52:56 +00002091 if( pParse->colNamesSet ) return;
drhf35f2f92017-07-29 16:01:55 +00002092 /* Column names are determined by the left-most term of a compound select */
2093 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh5d7aef12022-11-22 19:49:16 +00002094 TREETRACE(0x80,pParse,pSelect,("generating column names\n"));
drhf35f2f92017-07-29 16:01:55 +00002095 pTabList = pSelect->pSrc;
2096 pEList = pSelect->pEList;
drh98029472015-12-03 21:47:30 +00002097 assert( v!=0 );
drhf7ce4292015-12-02 19:46:12 +00002098 assert( pTabList!=0 );
drhd8bc7082000-06-07 23:51:50 +00002099 pParse->colNamesSet = 1;
drhec360a82017-07-12 14:10:19 +00002100 fullName = (db->flags & SQLITE_FullColNames)!=0;
2101 srcName = (db->flags & SQLITE_ShortColNames)!=0 || fullName;
danielk197722322fd2004-05-25 23:35:17 +00002102 sqlite3VdbeSetNumCols(v, pEList->nExpr);
drh82c3d632000-06-06 21:56:07 +00002103 for(i=0; i<pEList->nExpr; i++){
drhec360a82017-07-12 14:10:19 +00002104 Expr *p = pEList->a[i].pExpr;
2105
2106 assert( p!=0 );
drh4dd89d52017-08-14 14:53:24 +00002107 assert( p->op!=TK_AGG_COLUMN ); /* Agg processing has not run yet */
drh477572b2021-10-07 20:46:29 +00002108 assert( p->op!=TK_COLUMN
2109 || (ExprUseYTab(p) && p->y.pTab!=0) ); /* Covering idx not yet coded */
drhd88fd532022-05-02 20:49:30 +00002110 if( pEList->a[i].zEName && pEList->a[i].fg.eEName==ENAME_NAME ){
drhec360a82017-07-12 14:10:19 +00002111 /* An AS clause always takes first priority */
drh41cee662019-12-12 20:22:34 +00002112 char *zName = pEList->a[i].zEName;
danielk197710fb7492008-10-31 10:53:22 +00002113 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
drhf35f2f92017-07-29 16:01:55 +00002114 }else if( srcName && p->op==TK_COLUMN ){
drh97665872002-02-13 23:22:53 +00002115 char *zCol;
drh8aff1012001-12-22 14:49:24 +00002116 int iCol = p->iColumn;
drheda079c2018-09-20 19:02:15 +00002117 pTab = p->y.pTab;
drhf35f2f92017-07-29 16:01:55 +00002118 assert( pTab!=0 );
drh8aff1012001-12-22 14:49:24 +00002119 if( iCol<0 ) iCol = pTab->iPKey;
drh97665872002-02-13 23:22:53 +00002120 assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
drhb1363202002-06-26 02:45:03 +00002121 if( iCol<0 ){
drh47a6db22005-01-18 16:02:40 +00002122 zCol = "rowid";
drhb1363202002-06-26 02:45:03 +00002123 }else{
drhcf9d36d2021-08-02 18:03:43 +00002124 zCol = pTab->aCol[iCol].zCnName;
drhb1363202002-06-26 02:45:03 +00002125 }
drhec360a82017-07-12 14:10:19 +00002126 if( fullName ){
drh82c3d632000-06-06 21:56:07 +00002127 char *zName = 0;
drh1c767f02009-01-09 02:49:31 +00002128 zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
danielk197710fb7492008-10-31 10:53:22 +00002129 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
drh82c3d632000-06-06 21:56:07 +00002130 }else{
danielk197710fb7492008-10-31 10:53:22 +00002131 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
drh82c3d632000-06-06 21:56:07 +00002132 }
drh1bee3d72001-10-15 00:44:35 +00002133 }else{
drhcbb9da32019-12-12 22:11:33 +00002134 const char *z = pEList->a[i].zEName;
drh859bc542014-01-13 20:32:18 +00002135 z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
2136 sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
drh82c3d632000-06-06 21:56:07 +00002137 }
2138 }
danielk197776d505b2004-05-28 13:13:02 +00002139 generateColumnTypes(pParse, pTabList, pEList);
drh82c3d632000-06-06 21:56:07 +00002140}
2141
drhd8bc7082000-06-07 23:51:50 +00002142/*
peter.d.reid60ec9142014-09-06 16:39:46 +00002143** Given an expression list (which is really the list of expressions
drh7d10d5a2008-08-20 16:35:10 +00002144** that form the result set of a SELECT statement) compute appropriate
2145** column names for a table that would hold the expression list.
2146**
2147** All column names will be unique.
2148**
2149** Only the column names are computed. Column.zType, Column.zColl,
2150** and other fields of Column are zeroed.
2151**
2152** Return SQLITE_OK on success. If a memory allocation error occurs,
2153** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
drhec360a82017-07-12 14:10:19 +00002154**
2155** The only guarantee that SQLite makes about column names is that if the
2156** column has an AS clause assigning it a name, that will be the name used.
2157** That is the only documented guarantee. However, countless applications
2158** developed over the years have made baseless assumptions about column names
2159** and will break if those assumptions changes. Hence, use extreme caution
2160** when modifying this routine to avoid breaking legacy.
2161**
drh90881862021-05-19 12:17:03 +00002162** See Also: sqlite3GenerateColumnNames()
drh315555c2002-10-20 15:53:03 +00002163*/
drh8981b902015-08-24 17:42:49 +00002164int sqlite3ColumnsFromExprList(
drh7d10d5a2008-08-20 16:35:10 +00002165 Parse *pParse, /* Parsing context */
2166 ExprList *pEList, /* Expr list from which to derive column names */
drhd815f172012-09-13 14:42:43 +00002167 i16 *pnCol, /* Write the number of columns here */
drh7d10d5a2008-08-20 16:35:10 +00002168 Column **paCol /* Write the new column list here */
2169){
drhdc5ea5c2008-12-10 17:19:59 +00002170 sqlite3 *db = pParse->db; /* Database connection */
2171 int i, j; /* Loop counters */
drhebed3fa2015-11-14 16:47:23 +00002172 u32 cnt; /* Index added to make the name unique */
drhdc5ea5c2008-12-10 17:19:59 +00002173 Column *aCol, *pCol; /* For looping over result columns */
2174 int nCol; /* Number of columns in the result set */
drhdc5ea5c2008-12-10 17:19:59 +00002175 char *zName; /* Column name */
2176 int nName; /* Size of name in zName[] */
drh0315e3c2015-11-14 20:52:43 +00002177 Hash ht; /* Hash table of column names */
drh6d5ab2a2020-11-02 00:40:05 +00002178 Table *pTab;
drh22f70c32002-02-18 01:17:00 +00002179
drh0315e3c2015-11-14 20:52:43 +00002180 sqlite3HashInit(&ht);
dan8c2e0f02012-03-31 15:08:56 +00002181 if( pEList ){
2182 nCol = pEList->nExpr;
2183 aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
2184 testcase( aCol==0 );
drh080fe6d2021-03-18 20:04:46 +00002185 if( NEVER(nCol>32767) ) nCol = 32767;
dan8c2e0f02012-03-31 15:08:56 +00002186 }else{
2187 nCol = 0;
2188 aCol = 0;
2189 }
dan8836cbb2015-11-21 19:43:29 +00002190 assert( nCol==(i16)nCol );
dan8c2e0f02012-03-31 15:08:56 +00002191 *pnCol = nCol;
2192 *paCol = aCol;
2193
drh0315e3c2015-11-14 20:52:43 +00002194 for(i=0, pCol=aCol; i<nCol && !db->mallocFailed; i++, pCol++){
drh18f86002022-04-21 13:11:26 +00002195 struct ExprList_item *pX = &pEList->a[i];
drh45e41b72022-04-22 23:18:21 +00002196 struct ExprList_item *pCollide;
drh79d5f632005-01-18 17:20:10 +00002197 /* Get an appropriate name for the column
2198 */
drhd88fd532022-05-02 20:49:30 +00002199 if( (zName = pX->zEName)!=0 && pX->fg.eEName==ENAME_NAME ){
drh79d5f632005-01-18 17:20:10 +00002200 /* If the column contains an "AS <name>" phrase, use <name> as the name */
drh93a960a2008-07-10 00:32:42 +00002201 }else{
drh18f86002022-04-21 13:11:26 +00002202 Expr *pColExpr = sqlite3ExprSkipCollateAndLikely(pX->pExpr);
drh235667a2020-11-08 20:44:30 +00002203 while( ALWAYS(pColExpr!=0) && pColExpr->op==TK_DOT ){
drhb07028f2011-10-14 21:49:18 +00002204 pColExpr = pColExpr->pRight;
2205 assert( pColExpr!=0 );
2206 }
drh477572b2021-10-07 20:46:29 +00002207 if( pColExpr->op==TK_COLUMN
2208 && ALWAYS( ExprUseYTab(pColExpr) )
drh5af8a862022-05-27 18:06:49 +00002209 && ALWAYS( pColExpr->y.pTab!=0 )
drh477572b2021-10-07 20:46:29 +00002210 ){
drh7d10d5a2008-08-20 16:35:10 +00002211 /* For columns use the column name name */
drhdc5ea5c2008-12-10 17:19:59 +00002212 int iCol = pColExpr->iColumn;
drh5af8a862022-05-27 18:06:49 +00002213 pTab = pColExpr->y.pTab;
drhf0209f72008-08-21 14:54:28 +00002214 if( iCol<0 ) iCol = pTab->iPKey;
drhcf9d36d2021-08-02 18:03:43 +00002215 zName = iCol>=0 ? pTab->aCol[iCol].zCnName : "rowid";
drhb7916a72009-05-27 10:31:29 +00002216 }else if( pColExpr->op==TK_ID ){
drh33e619f2009-05-28 01:00:55 +00002217 assert( !ExprHasProperty(pColExpr, EP_IntValue) );
drh96ceaf82015-11-14 22:04:22 +00002218 zName = pColExpr->u.zToken;
drh7d10d5a2008-08-20 16:35:10 +00002219 }else{
2220 /* Use the original text of the column expression as its name */
drh18f86002022-04-21 13:11:26 +00002221 assert( zName==pX->zEName ); /* pointer comparison intended */
drh7d10d5a2008-08-20 16:35:10 +00002222 }
drh22f70c32002-02-18 01:17:00 +00002223 }
drh0cbec592020-01-03 02:20:37 +00002224 if( zName && !sqlite3IsTrueOrFalse(zName) ){
drhd7ca6002017-07-09 00:30:58 +00002225 zName = sqlite3DbStrDup(db, zName);
2226 }else{
drh155507b2017-07-09 18:55:29 +00002227 zName = sqlite3MPrintf(db,"column%d",i+1);
drhd7ca6002017-07-09 00:30:58 +00002228 }
drh79d5f632005-01-18 17:20:10 +00002229
2230 /* Make sure the column name is unique. If the name is not unique,
peter.d.reid60ec9142014-09-06 16:39:46 +00002231 ** append an integer to the name so that it becomes unique.
drh79d5f632005-01-18 17:20:10 +00002232 */
drh0315e3c2015-11-14 20:52:43 +00002233 cnt = 0;
drh45e41b72022-04-22 23:18:21 +00002234 while( zName && (pCollide = sqlite3HashFind(&ht, zName))!=0 ){
drhd88fd532022-05-02 20:49:30 +00002235 if( pCollide->fg.bUsingTerm ){
drhab843a52022-04-23 07:29:34 +00002236 pCol->colFlags |= COLFLAG_NOEXPAND;
drh45e41b72022-04-22 23:18:21 +00002237 }
drh0315e3c2015-11-14 20:52:43 +00002238 nName = sqlite3Strlen30(zName);
drhf7ee8962015-11-15 11:13:49 +00002239 if( nName>0 ){
2240 for(j=nName-1; j>0 && sqlite3Isdigit(zName[j]); j--){}
2241 if( zName[j]==':' ) nName = j;
2242 }
drh96ceaf82015-11-14 22:04:22 +00002243 zName = sqlite3MPrintf(db, "%.*z:%u", nName, zName, ++cnt);
drh0315e3c2015-11-14 20:52:43 +00002244 if( cnt>3 ) sqlite3_randomness(sizeof(cnt), &cnt);
drh79d5f632005-01-18 17:20:10 +00002245 }
drhcf9d36d2021-08-02 18:03:43 +00002246 pCol->zCnName = zName;
drhd44390c2020-04-06 18:16:31 +00002247 pCol->hName = sqlite3StrIHash(zName);
drhd88fd532022-05-02 20:49:30 +00002248 if( pX->fg.bNoExpand ){
drh72d620b2022-05-02 19:59:03 +00002249 pCol->colFlags |= COLFLAG_NOEXPAND;
2250 }
danba68f8f2015-11-19 16:46:46 +00002251 sqlite3ColumnPropertiesFromName(0, pCol);
drh45e41b72022-04-22 23:18:21 +00002252 if( zName && sqlite3HashInsert(&ht, zName, pX)==pX ){
drh4a642b62016-02-05 01:55:27 +00002253 sqlite3OomFault(db);
drh0315e3c2015-11-14 20:52:43 +00002254 }
drh7d10d5a2008-08-20 16:35:10 +00002255 }
drh0315e3c2015-11-14 20:52:43 +00002256 sqlite3HashClear(&ht);
drh7d10d5a2008-08-20 16:35:10 +00002257 if( db->mallocFailed ){
drh7d10d5a2008-08-20 16:35:10 +00002258 for(j=0; j<i; j++){
drhcf9d36d2021-08-02 18:03:43 +00002259 sqlite3DbFree(db, aCol[j].zCnName);
drh7d10d5a2008-08-20 16:35:10 +00002260 }
2261 sqlite3DbFree(db, aCol);
2262 *paCol = 0;
2263 *pnCol = 0;
mistachkinfad30392016-02-13 23:43:46 +00002264 return SQLITE_NOMEM_BKPT;
drh7d10d5a2008-08-20 16:35:10 +00002265 }
2266 return SQLITE_OK;
2267}
danielk1977517eb642004-06-07 10:00:31 +00002268
drh7d10d5a2008-08-20 16:35:10 +00002269/*
2270** Add type and collation information to a column list based on
2271** a SELECT statement.
2272**
2273** The column list presumably came from selectColumnNamesFromExprList().
2274** The column list has only names, not types or collations. This
2275** routine goes through and adds the types and collations.
2276**
shaneb08a67a2009-03-31 03:41:56 +00002277** This routine requires that all identifiers in the SELECT
drh7d10d5a2008-08-20 16:35:10 +00002278** statement be resolved.
2279*/
drhed06a132016-04-05 20:59:12 +00002280void sqlite3SelectAddColumnTypeAndCollation(
drh7d10d5a2008-08-20 16:35:10 +00002281 Parse *pParse, /* Parsing contexts */
drh186ad8c2013-10-08 18:40:37 +00002282 Table *pTab, /* Add column type information to this table */
drh81506b82019-08-05 19:32:06 +00002283 Select *pSelect, /* SELECT used to determine types and collations */
2284 char aff /* Default affinity for columns */
drh7d10d5a2008-08-20 16:35:10 +00002285){
2286 sqlite3 *db = pParse->db;
2287 NameContext sNC;
2288 Column *pCol;
2289 CollSeq *pColl;
2290 int i;
2291 Expr *p;
2292 struct ExprList_item *a;
2293
2294 assert( pSelect!=0 );
2295 assert( (pSelect->selFlags & SF_Resolved)!=0 );
drh186ad8c2013-10-08 18:40:37 +00002296 assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
drh7d10d5a2008-08-20 16:35:10 +00002297 if( db->mallocFailed ) return;
2298 memset(&sNC, 0, sizeof(sNC));
2299 sNC.pSrcList = pSelect->pSrc;
2300 a = pSelect->pEList->a;
drh186ad8c2013-10-08 18:40:37 +00002301 for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
drhed06a132016-04-05 20:59:12 +00002302 const char *zType;
drh913306a2021-11-26 17:10:18 +00002303 i64 n, m;
drh6f6e60d2021-02-18 15:45:34 +00002304 pTab->tabFlags |= (pCol->colFlags & COLFLAG_NOINSERT);
drh7d10d5a2008-08-20 16:35:10 +00002305 p = a[i].pExpr;
drhcafc2f72017-10-03 03:01:09 +00002306 zType = columnType(&sNC, p, 0, 0, 0);
2307 /* pCol->szEst = ... // Column size est for SELECT tables never used */
danielk1977c60e9b82005-01-31 12:42:29 +00002308 pCol->affinity = sqlite3ExprAffinity(p);
drh0c4db032017-10-03 19:53:12 +00002309 if( zType ){
2310 m = sqlite3Strlen30(zType);
drhcf9d36d2021-08-02 18:03:43 +00002311 n = sqlite3Strlen30(pCol->zCnName);
2312 pCol->zCnName = sqlite3DbReallocOrFree(db, pCol->zCnName, n+m+2);
2313 if( pCol->zCnName ){
2314 memcpy(&pCol->zCnName[n+1], zType, m+1);
drhed06a132016-04-05 20:59:12 +00002315 pCol->colFlags |= COLFLAG_HASTYPE;
drh146121f2021-11-12 14:39:49 +00002316 }else{
2317 testcase( pCol->colFlags & COLFLAG_HASTYPE );
2318 pCol->colFlags &= ~(COLFLAG_HASTYPE|COLFLAG_HASCOLL);
drhed06a132016-04-05 20:59:12 +00002319 }
2320 }
drh96fb16e2019-08-06 14:37:24 +00002321 if( pCol->affinity<=SQLITE_AFF_NONE ) pCol->affinity = aff;
danielk1977b3bf5562006-01-10 17:58:23 +00002322 pColl = sqlite3ExprCollSeq(pParse, p);
drh5ced0a92021-08-24 17:07:44 +00002323 if( pColl ){
drh65b40092021-08-05 15:27:19 +00002324 assert( pTab->pIndex==0 );
2325 sqlite3ColumnSetColl(db, pCol, pColl->zName);
danielk19770202b292004-06-09 09:55:16 +00002326 }
drh22f70c32002-02-18 01:17:00 +00002327 }
drhcafc2f72017-10-03 03:01:09 +00002328 pTab->szTabRow = 1; /* Any non-zero value works */
drh7d10d5a2008-08-20 16:35:10 +00002329}
2330
2331/*
2332** Given a SELECT statement, generate a Table structure that describes
2333** the result set of that SELECT.
2334*/
drh81506b82019-08-05 19:32:06 +00002335Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect, char aff){
drh7d10d5a2008-08-20 16:35:10 +00002336 Table *pTab;
2337 sqlite3 *db = pParse->db;
drh70d5dfb2018-12-06 16:50:55 +00002338 u64 savedFlags;
drh7d10d5a2008-08-20 16:35:10 +00002339
2340 savedFlags = db->flags;
drhd5b44d62018-12-06 17:06:02 +00002341 db->flags &= ~(u64)SQLITE_FullColNames;
drh7d10d5a2008-08-20 16:35:10 +00002342 db->flags |= SQLITE_ShortColNames;
2343 sqlite3SelectPrep(pParse, pSelect, 0);
drh491b6d82019-01-24 15:51:03 +00002344 db->flags = savedFlags;
drh7d10d5a2008-08-20 16:35:10 +00002345 if( pParse->nErr ) return 0;
2346 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh7d10d5a2008-08-20 16:35:10 +00002347 pTab = sqlite3DbMallocZero(db, sizeof(Table) );
2348 if( pTab==0 ){
2349 return 0;
2350 }
drh79df7782016-12-14 14:07:35 +00002351 pTab->nTabRef = 1;
drh7d10d5a2008-08-20 16:35:10 +00002352 pTab->zName = 0;
dancfc9df72014-04-25 15:01:01 +00002353 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drh8981b902015-08-24 17:42:49 +00002354 sqlite3ColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
drh81506b82019-08-05 19:32:06 +00002355 sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSelect, aff);
drh22f70c32002-02-18 01:17:00 +00002356 pTab->iPKey = -1;
drh7ce72f62008-07-24 15:50:41 +00002357 if( db->mallocFailed ){
dan1feeaed2010-07-23 15:41:47 +00002358 sqlite3DeleteTable(db, pTab);
drh7ce72f62008-07-24 15:50:41 +00002359 return 0;
2360 }
drh22f70c32002-02-18 01:17:00 +00002361 return pTab;
2362}
2363
2364/*
drhd8bc7082000-06-07 23:51:50 +00002365** Get a VDBE for the given parser context. Create a new one if necessary.
2366** If an error occurs, return NULL and leave a message in pParse.
2367*/
drh55965612017-09-16 20:58:41 +00002368Vdbe *sqlite3GetVdbe(Parse *pParse){
2369 if( pParse->pVdbe ){
2370 return pParse->pVdbe;
2371 }
drh6f077342016-04-12 00:26:59 +00002372 if( pParse->pToplevel==0
2373 && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
2374 ){
2375 pParse->okConstFactor = 1;
drhd8bc7082000-06-07 23:51:50 +00002376 }
drh55965612017-09-16 20:58:41 +00002377 return sqlite3VdbeCreate(pParse);
drh6f077342016-04-12 00:26:59 +00002378}
drhfcb78a42003-01-18 20:11:05 +00002379
drh15007a92006-01-08 18:10:17 +00002380
drhd8bc7082000-06-07 23:51:50 +00002381/*
drh7b58dae2003-07-20 01:16:46 +00002382** Compute the iLimit and iOffset fields of the SELECT based on the
drh8c0833f2017-11-14 23:48:23 +00002383** pLimit expressions. pLimit->pLeft and pLimit->pRight hold the expressions
drh7b58dae2003-07-20 01:16:46 +00002384** that appear in the original SQL statement after the LIMIT and OFFSET
danielk1977a2dc3b12005-02-05 12:48:48 +00002385** keywords. Or NULL if those keywords are omitted. iLimit and iOffset
2386** are the integer memory register numbers for counters used to compute
2387** the limit and offset. If there is no limit and/or offset, then
2388** iLimit and iOffset are negative.
drh7b58dae2003-07-20 01:16:46 +00002389**
drhd59ba6c2006-01-08 05:02:54 +00002390** This routine changes the values of iLimit and iOffset only if
drh8c0833f2017-11-14 23:48:23 +00002391** a limit or offset is defined by pLimit->pLeft and pLimit->pRight. iLimit
2392** and iOffset should have been preset to appropriate default values (zero)
drhaa9ce702014-01-22 18:07:04 +00002393** prior to calling this routine.
2394**
2395** The iOffset register (if it exists) is initialized to the value
2396** of the OFFSET. The iLimit register is initialized to LIMIT. Register
2397** iOffset+1 is initialized to LIMIT+OFFSET.
2398**
drh8c0833f2017-11-14 23:48:23 +00002399** Only if pLimit->pLeft!=0 do the limit registers get
drh7b58dae2003-07-20 01:16:46 +00002400** redefined. The UNION ALL operator uses this property to force
2401** the reuse of the same limit and offset registers across multiple
2402** SELECT statements.
2403*/
drhec7429a2005-10-06 16:53:14 +00002404static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
drh02afc862006-01-20 18:10:57 +00002405 Vdbe *v = 0;
2406 int iLimit = 0;
drh15007a92006-01-08 18:10:17 +00002407 int iOffset;
drh8b0cf382015-10-06 21:07:06 +00002408 int n;
drh8c0833f2017-11-14 23:48:23 +00002409 Expr *pLimit = p->pLimit;
2410
drh0acb7e42008-06-25 00:12:41 +00002411 if( p->iLimit ) return;
drh15007a92006-01-08 18:10:17 +00002412
drh7b58dae2003-07-20 01:16:46 +00002413 /*
drh7b58dae2003-07-20 01:16:46 +00002414 ** "LIMIT -1" always shows all rows. There is some
drhf7b54962013-05-28 12:11:54 +00002415 ** controversy about what the correct behavior should be.
drh7b58dae2003-07-20 01:16:46 +00002416 ** The current implementation interprets "LIMIT 0" to mean
2417 ** no rows.
2418 */
drh8c0833f2017-11-14 23:48:23 +00002419 if( pLimit ){
2420 assert( pLimit->op==TK_LIMIT );
2421 assert( pLimit->pLeft!=0 );
drh0a07c102008-01-03 18:03:08 +00002422 p->iLimit = iLimit = ++pParse->nMem;
drh15007a92006-01-08 18:10:17 +00002423 v = sqlite3GetVdbe(pParse);
drhaa9ce702014-01-22 18:07:04 +00002424 assert( v!=0 );
drh8c0833f2017-11-14 23:48:23 +00002425 if( sqlite3ExprIsInteger(pLimit->pLeft, &n) ){
drh456e4e42009-11-20 16:13:15 +00002426 sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
2427 VdbeComment((v, "LIMIT counter"));
drh9b918ed2009-11-12 03:13:26 +00002428 if( n==0 ){
drh076e85f2015-09-03 13:46:12 +00002429 sqlite3VdbeGoto(v, iBreak);
drhc3489bb2016-02-25 16:04:59 +00002430 }else if( n>=0 && p->nSelectRow>sqlite3LogEst((u64)n) ){
2431 p->nSelectRow = sqlite3LogEst((u64)n);
2432 p->selFlags |= SF_FixedLimit;
drh9b918ed2009-11-12 03:13:26 +00002433 }
2434 }else{
drh8c0833f2017-11-14 23:48:23 +00002435 sqlite3ExprCode(pParse, pLimit->pLeft, iLimit);
drh688852a2014-02-17 22:40:43 +00002436 sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
drh9b918ed2009-11-12 03:13:26 +00002437 VdbeComment((v, "LIMIT counter"));
drh16897072015-03-07 00:57:37 +00002438 sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, iBreak); VdbeCoverage(v);
drh9b918ed2009-11-12 03:13:26 +00002439 }
drh8c0833f2017-11-14 23:48:23 +00002440 if( pLimit->pRight ){
drh373cc2d2009-05-17 02:06:14 +00002441 p->iOffset = iOffset = ++pParse->nMem;
drhb7654112008-01-12 12:48:07 +00002442 pParse->nMem++; /* Allocate an extra register for limit+offset */
drh8c0833f2017-11-14 23:48:23 +00002443 sqlite3ExprCode(pParse, pLimit->pRight, iOffset);
drh688852a2014-02-17 22:40:43 +00002444 sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
drh373cc2d2009-05-17 02:06:14 +00002445 VdbeComment((v, "OFFSET counter"));
drhcc2fa4c2016-01-25 15:57:29 +00002446 sqlite3VdbeAddOp3(v, OP_OffsetLimit, iLimit, iOffset+1, iOffset);
drhb7654112008-01-12 12:48:07 +00002447 VdbeComment((v, "LIMIT+OFFSET"));
drhd59ba6c2006-01-08 05:02:54 +00002448 }
drh7b58dae2003-07-20 01:16:46 +00002449 }
2450}
2451
drhb7f91642004-10-31 02:22:47 +00002452#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhfbc4ee72004-08-29 01:31:05 +00002453/*
drhfbc4ee72004-08-29 01:31:05 +00002454** Return the appropriate collating sequence for the iCol-th column of
2455** the result set for the compound-select statement "p". Return NULL if
2456** the column has no default collating sequence.
2457**
2458** The collating sequence for the compound select is taken from the
2459** left-most term of the select that has a collating sequence.
2460*/
danielk1977dc1bdc42004-06-11 10:51:27 +00002461static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
drhfbc4ee72004-08-29 01:31:05 +00002462 CollSeq *pRet;
danielk1977dc1bdc42004-06-11 10:51:27 +00002463 if( p->pPrior ){
2464 pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
drhfbc4ee72004-08-29 01:31:05 +00002465 }else{
2466 pRet = 0;
danielk1977dc1bdc42004-06-11 10:51:27 +00002467 }
drh10c081a2009-04-16 00:24:23 +00002468 assert( iCol>=0 );
drh2ec18a32015-06-23 23:31:52 +00002469 /* iCol must be less than p->pEList->nExpr. Otherwise an error would
2470 ** have been thrown during name resolution and we would not have gotten
2471 ** this far */
2472 if( pRet==0 && ALWAYS(iCol<p->pEList->nExpr) ){
danielk1977dc1bdc42004-06-11 10:51:27 +00002473 pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
2474 }
2475 return pRet;
drhd3d39e92004-05-20 22:16:29 +00002476}
2477
dan53bed452014-01-24 20:37:18 +00002478/*
2479** The select statement passed as the second parameter is a compound SELECT
2480** with an ORDER BY clause. This function allocates and returns a KeyInfo
2481** structure suitable for implementing the ORDER BY.
2482**
2483** Space to hold the KeyInfo structure is obtained from malloc. The calling
2484** function is responsible for ensuring that this structure is eventually
2485** freed.
2486*/
2487static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
2488 ExprList *pOrderBy = p->pOrderBy;
drh7d4c94b2021-10-04 22:34:38 +00002489 int nOrderBy = ALWAYS(pOrderBy!=0) ? pOrderBy->nExpr : 0;
dan53bed452014-01-24 20:37:18 +00002490 sqlite3 *db = pParse->db;
2491 KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
2492 if( pRet ){
2493 int i;
2494 for(i=0; i<nOrderBy; i++){
2495 struct ExprList_item *pItem = &pOrderBy->a[i];
2496 Expr *pTerm = pItem->pExpr;
2497 CollSeq *pColl;
2498
2499 if( pTerm->flags & EP_Collate ){
2500 pColl = sqlite3ExprCollSeq(pParse, pTerm);
2501 }else{
2502 pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
2503 if( pColl==0 ) pColl = db->pDfltColl;
2504 pOrderBy->a[i].pExpr =
2505 sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
2506 }
2507 assert( sqlite3KeyInfoIsWriteable(pRet) );
2508 pRet->aColl[i] = pColl;
drhd88fd532022-05-02 20:49:30 +00002509 pRet->aSortFlags[i] = pOrderBy->a[i].fg.sortFlags;
dan53bed452014-01-24 20:37:18 +00002510 }
2511 }
2512
2513 return pRet;
2514}
drhd3d39e92004-05-20 22:16:29 +00002515
drh781def22014-01-22 13:35:53 +00002516#ifndef SQLITE_OMIT_CTE
2517/*
2518** This routine generates VDBE code to compute the content of a WITH RECURSIVE
2519** query of the form:
2520**
2521** <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
2522** \___________/ \_______________/
2523** p->pPrior p
2524**
2525**
2526** There is exactly one reference to the recursive-table in the FROM clause
drh8a48b9c2015-08-19 15:20:00 +00002527** of recursive-query, marked with the SrcList->a[].fg.isRecursive flag.
drh781def22014-01-22 13:35:53 +00002528**
2529** The setup-query runs once to generate an initial set of rows that go
2530** into a Queue table. Rows are extracted from the Queue table one by
drhfe1c6bb2014-01-22 17:28:35 +00002531** one. Each row extracted from Queue is output to pDest. Then the single
2532** extracted row (now in the iCurrent table) becomes the content of the
2533** recursive-table for a recursive-query run. The output of the recursive-query
drh781def22014-01-22 13:35:53 +00002534** is added back into the Queue table. Then another row is extracted from Queue
2535** and the iteration continues until the Queue table is empty.
2536**
2537** If the compound query operator is UNION then no duplicate rows are ever
2538** inserted into the Queue table. The iDistinct table keeps a copy of all rows
2539** that have ever been inserted into Queue and causes duplicates to be
2540** discarded. If the operator is UNION ALL, then duplicates are allowed.
2541**
2542** If the query has an ORDER BY, then entries in the Queue table are kept in
2543** ORDER BY order and the first entry is extracted for each cycle. Without
2544** an ORDER BY, the Queue table is just a FIFO.
2545**
2546** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
2547** have been output to pDest. A LIMIT of zero means to output no rows and a
2548** negative LIMIT means to output all rows. If there is also an OFFSET clause
2549** with a positive value, then the first OFFSET outputs are discarded rather
2550** than being sent to pDest. The LIMIT count does not begin until after OFFSET
2551** rows have been skipped.
2552*/
2553static void generateWithRecursiveQuery(
2554 Parse *pParse, /* Parsing context */
2555 Select *p, /* The recursive SELECT to be coded */
2556 SelectDest *pDest /* What to do with query results */
2557){
2558 SrcList *pSrc = p->pSrc; /* The FROM clause of the recursive query */
2559 int nCol = p->pEList->nExpr; /* Number of columns in the recursive table */
2560 Vdbe *v = pParse->pVdbe; /* The prepared statement under construction */
drhe85e1da2021-10-01 21:01:07 +00002561 Select *pSetup; /* The setup query */
drh34055852020-10-19 01:23:48 +00002562 Select *pFirstRec; /* Left-most recursive term */
drh781def22014-01-22 13:35:53 +00002563 int addrTop; /* Top of the loop */
2564 int addrCont, addrBreak; /* CONTINUE and BREAK addresses */
drhedf83d12014-01-22 18:31:27 +00002565 int iCurrent = 0; /* The Current table */
drh781def22014-01-22 13:35:53 +00002566 int regCurrent; /* Register holding Current table */
2567 int iQueue; /* The Queue table */
2568 int iDistinct = 0; /* To ensure unique results if UNION */
drh8e1ee882014-03-21 19:56:09 +00002569 int eDest = SRT_Fifo; /* How to write to Queue */
drh781def22014-01-22 13:35:53 +00002570 SelectDest destQueue; /* SelectDest targetting the Queue table */
2571 int i; /* Loop counter */
2572 int rc; /* Result code */
drhfe1c6bb2014-01-22 17:28:35 +00002573 ExprList *pOrderBy; /* The ORDER BY clause */
drh8c0833f2017-11-14 23:48:23 +00002574 Expr *pLimit; /* Saved LIMIT and OFFSET */
drhaa9ce702014-01-22 18:07:04 +00002575 int regLimit, regOffset; /* Registers used by LIMIT and OFFSET */
drh781def22014-01-22 13:35:53 +00002576
dan6afa35c2018-09-27 12:14:15 +00002577#ifndef SQLITE_OMIT_WINDOWFUNC
2578 if( p->pWin ){
2579 sqlite3ErrorMsg(pParse, "cannot use window functions in recursive queries");
2580 return;
2581 }
2582#endif
2583
drh781def22014-01-22 13:35:53 +00002584 /* Obtain authorization to do a recursive query */
2585 if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
drh781def22014-01-22 13:35:53 +00002586
drhaa9ce702014-01-22 18:07:04 +00002587 /* Process the LIMIT and OFFSET clauses, if they exist */
drhec4ccdb2018-12-29 02:26:59 +00002588 addrBreak = sqlite3VdbeMakeLabel(pParse);
dan69b93832016-12-16 15:05:40 +00002589 p->nSelectRow = 320; /* 4 billion rows */
drhaa9ce702014-01-22 18:07:04 +00002590 computeLimitRegisters(pParse, p, addrBreak);
2591 pLimit = p->pLimit;
drhaa9ce702014-01-22 18:07:04 +00002592 regLimit = p->iLimit;
2593 regOffset = p->iOffset;
drh8c0833f2017-11-14 23:48:23 +00002594 p->pLimit = 0;
drhaa9ce702014-01-22 18:07:04 +00002595 p->iLimit = p->iOffset = 0;
dan53bed452014-01-24 20:37:18 +00002596 pOrderBy = p->pOrderBy;
drh781def22014-01-22 13:35:53 +00002597
2598 /* Locate the cursor number of the Current table */
2599 for(i=0; ALWAYS(i<pSrc->nSrc); i++){
drh8a48b9c2015-08-19 15:20:00 +00002600 if( pSrc->a[i].fg.isRecursive ){
drh781def22014-01-22 13:35:53 +00002601 iCurrent = pSrc->a[i].iCursor;
2602 break;
2603 }
2604 }
2605
drhfe1c6bb2014-01-22 17:28:35 +00002606 /* Allocate cursors numbers for Queue and Distinct. The cursor number for
drh781def22014-01-22 13:35:53 +00002607 ** the Distinct table must be exactly one greater than Queue in order
drh8e1ee882014-03-21 19:56:09 +00002608 ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
drh781def22014-01-22 13:35:53 +00002609 iQueue = pParse->nTab++;
2610 if( p->op==TK_UNION ){
drh8e1ee882014-03-21 19:56:09 +00002611 eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
drh781def22014-01-22 13:35:53 +00002612 iDistinct = pParse->nTab++;
drhfe1c6bb2014-01-22 17:28:35 +00002613 }else{
drh8e1ee882014-03-21 19:56:09 +00002614 eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
drh781def22014-01-22 13:35:53 +00002615 }
2616 sqlite3SelectDestInit(&destQueue, eDest, iQueue);
2617
2618 /* Allocate cursors for Current, Queue, and Distinct. */
2619 regCurrent = ++pParse->nMem;
2620 sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
drhfe1c6bb2014-01-22 17:28:35 +00002621 if( pOrderBy ){
dan53bed452014-01-24 20:37:18 +00002622 KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
drhfe1c6bb2014-01-22 17:28:35 +00002623 sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
2624 (char*)pKeyInfo, P4_KEYINFO);
2625 destQueue.pOrderBy = pOrderBy;
2626 }else{
2627 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
2628 }
2629 VdbeComment((v, "Queue table"));
drh781def22014-01-22 13:35:53 +00002630 if( iDistinct ){
2631 p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
2632 p->selFlags |= SF_UsesEphemeral;
2633 }
2634
dan53bed452014-01-24 20:37:18 +00002635 /* Detach the ORDER BY clause from the compound SELECT */
2636 p->pOrderBy = 0;
2637
drh34055852020-10-19 01:23:48 +00002638 /* Figure out how many elements of the compound SELECT are part of the
2639 ** recursive query. Make sure no recursive elements use aggregate
2640 ** functions. Mark the recursive elements as UNION ALL even if they
2641 ** are really UNION because the distinctness will be enforced by the
2642 ** iDistinct table. pFirstRec is left pointing to the left-most
2643 ** recursive term of the CTE.
2644 */
drh34055852020-10-19 01:23:48 +00002645 for(pFirstRec=p; ALWAYS(pFirstRec!=0); pFirstRec=pFirstRec->pPrior){
2646 if( pFirstRec->selFlags & SF_Aggregate ){
2647 sqlite3ErrorMsg(pParse, "recursive aggregate queries not supported");
2648 goto end_of_recursive_query;
2649 }
2650 pFirstRec->op = TK_ALL;
2651 if( (pFirstRec->pPrior->selFlags & SF_Recursive)==0 ) break;
2652 }
2653
drh781def22014-01-22 13:35:53 +00002654 /* Store the results of the setup-query in Queue. */
drh34055852020-10-19 01:23:48 +00002655 pSetup = pFirstRec->pPrior;
drhd227a292014-02-09 18:02:09 +00002656 pSetup->pNext = 0;
drh84a01de2018-05-02 16:13:48 +00002657 ExplainQueryPlan((pParse, 1, "SETUP"));
drh781def22014-01-22 13:35:53 +00002658 rc = sqlite3Select(pParse, pSetup, &destQueue);
drhd227a292014-02-09 18:02:09 +00002659 pSetup->pNext = p;
drhfe1c6bb2014-01-22 17:28:35 +00002660 if( rc ) goto end_of_recursive_query;
drh781def22014-01-22 13:35:53 +00002661
2662 /* Find the next row in the Queue and output that row */
drh688852a2014-02-17 22:40:43 +00002663 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
drh781def22014-01-22 13:35:53 +00002664
2665 /* Transfer the next row in Queue over to Current */
2666 sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
drhfe1c6bb2014-01-22 17:28:35 +00002667 if( pOrderBy ){
2668 sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
2669 }else{
2670 sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
2671 }
drh781def22014-01-22 13:35:53 +00002672 sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
2673
drhfe1c6bb2014-01-22 17:28:35 +00002674 /* Output the single row in Current */
drhec4ccdb2018-12-29 02:26:59 +00002675 addrCont = sqlite3VdbeMakeLabel(pParse);
drhaa9ce702014-01-22 18:07:04 +00002676 codeOffset(v, regOffset, addrCont);
drh2def2f72017-09-15 17:40:34 +00002677 selectInnerLoop(pParse, p, iCurrent,
drh079a3072014-03-19 14:10:55 +00002678 0, 0, pDest, addrCont, addrBreak);
drh688852a2014-02-17 22:40:43 +00002679 if( regLimit ){
drh16897072015-03-07 00:57:37 +00002680 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, regLimit, addrBreak);
drh688852a2014-02-17 22:40:43 +00002681 VdbeCoverage(v);
2682 }
drhfe1c6bb2014-01-22 17:28:35 +00002683 sqlite3VdbeResolveLabel(v, addrCont);
2684
drh781def22014-01-22 13:35:53 +00002685 /* Execute the recursive SELECT taking the single row in Current as
2686 ** the value for the recursive-table. Store the results in the Queue.
2687 */
drh34055852020-10-19 01:23:48 +00002688 pFirstRec->pPrior = 0;
2689 ExplainQueryPlan((pParse, 1, "RECURSIVE STEP"));
2690 sqlite3Select(pParse, p, &destQueue);
2691 assert( pFirstRec->pPrior==0 );
2692 pFirstRec->pPrior = pSetup;
drh781def22014-01-22 13:35:53 +00002693
2694 /* Keep running the loop until the Queue is empty */
drh076e85f2015-09-03 13:46:12 +00002695 sqlite3VdbeGoto(v, addrTop);
drh781def22014-01-22 13:35:53 +00002696 sqlite3VdbeResolveLabel(v, addrBreak);
drhfe1c6bb2014-01-22 17:28:35 +00002697
2698end_of_recursive_query:
dan9afccba2014-03-21 19:27:54 +00002699 sqlite3ExprListDelete(pParse->db, p->pOrderBy);
drhfe1c6bb2014-01-22 17:28:35 +00002700 p->pOrderBy = pOrderBy;
drhaa9ce702014-01-22 18:07:04 +00002701 p->pLimit = pLimit;
drhfe1c6bb2014-01-22 17:28:35 +00002702 return;
drh781def22014-01-22 13:35:53 +00002703}
danb68b9772014-01-25 12:16:53 +00002704#endif /* SQLITE_OMIT_CTE */
drh781def22014-01-22 13:35:53 +00002705
2706/* Forward references */
drhb21e7c72008-06-22 12:37:57 +00002707static int multiSelectOrderBy(
2708 Parse *pParse, /* Parsing context */
2709 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00002710 SelectDest *pDest /* What to do with query results */
drhb21e7c72008-06-22 12:37:57 +00002711);
2712
drh45f54a52015-01-05 19:16:42 +00002713/*
drh45f54a52015-01-05 19:16:42 +00002714** Handle the special case of a compound-select that originates from a
2715** VALUES clause. By handling this as a special case, we avoid deep
2716** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
2717** on a VALUES clause.
2718**
2719** Because the Select object originates from a VALUES clause:
drhb058d052018-01-14 20:12:23 +00002720** (1) There is no LIMIT or OFFSET or else there is a LIMIT of exactly 1
drh45f54a52015-01-05 19:16:42 +00002721** (2) All terms are UNION ALL
2722** (3) There is no ORDER BY clause
drhb058d052018-01-14 20:12:23 +00002723**
2724** The "LIMIT of exactly 1" case of condition (1) comes about when a VALUES
2725** clause occurs within scalar expression (ex: "SELECT (VALUES(1),(2),(3))").
2726** The sqlite3CodeSubselect will have added the LIMIT 1 clause in tht case.
drhd1f0a862022-02-25 11:30:29 +00002727** Since the limit is exactly 1, we only need to evaluate the left-most VALUES.
drh45f54a52015-01-05 19:16:42 +00002728*/
2729static int multiSelectValues(
2730 Parse *pParse, /* Parsing context */
2731 Select *p, /* The right-most of SELECTs to be coded */
2732 SelectDest *pDest /* What to do with query results */
2733){
drh45f54a52015-01-05 19:16:42 +00002734 int nRow = 1;
2735 int rc = 0;
drhfa16f5d2018-05-03 01:37:13 +00002736 int bShowAll = p->pLimit==0;
drh772460f2015-04-16 14:13:12 +00002737 assert( p->selFlags & SF_MultiValue );
drh45f54a52015-01-05 19:16:42 +00002738 do{
2739 assert( p->selFlags & SF_Values );
2740 assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
dan923cadb2015-06-23 12:19:55 +00002741 assert( p->pNext==0 || p->pEList->nExpr==p->pNext->pEList->nExpr );
drhef9f7192020-01-17 19:14:08 +00002742#ifndef SQLITE_OMIT_WINDOWFUNC
drh29cdbad2019-12-07 13:42:47 +00002743 if( p->pWin ) return -1;
drhef9f7192020-01-17 19:14:08 +00002744#endif
drh45f54a52015-01-05 19:16:42 +00002745 if( p->pPrior==0 ) break;
2746 assert( p->pPrior->pNext==p );
2747 p = p->pPrior;
drhfa16f5d2018-05-03 01:37:13 +00002748 nRow += bShowAll;
drh45f54a52015-01-05 19:16:42 +00002749 }while(1);
drhfa16f5d2018-05-03 01:37:13 +00002750 ExplainQueryPlan((pParse, 0, "SCAN %d CONSTANT ROW%s", nRow,
2751 nRow==1 ? "" : "S"));
drh45f54a52015-01-05 19:16:42 +00002752 while( p ){
drhfa16f5d2018-05-03 01:37:13 +00002753 selectInnerLoop(pParse, p, -1, 0, 0, pDest, 1, 1);
2754 if( !bShowAll ) break;
drh45f54a52015-01-05 19:16:42 +00002755 p->nSelectRow = nRow;
2756 p = p->pNext;
2757 }
2758 return rc;
2759}
drhb21e7c72008-06-22 12:37:57 +00002760
drhd3d39e92004-05-20 22:16:29 +00002761/*
drh34055852020-10-19 01:23:48 +00002762** Return true if the SELECT statement which is known to be the recursive
2763** part of a recursive CTE still has its anchor terms attached. If the
2764** anchor terms have already been removed, then return false.
2765*/
2766static int hasAnchor(Select *p){
2767 while( p && (p->selFlags & SF_Recursive)!=0 ){ p = p->pPrior; }
2768 return p!=0;
2769}
2770
2771/*
drh16ee60f2008-06-20 18:13:25 +00002772** This routine is called to process a compound query form from
2773** two or more separate queries using UNION, UNION ALL, EXCEPT, or
2774** INTERSECT
drhc926afb2002-06-20 03:38:26 +00002775**
drhe78e8282003-01-19 03:59:45 +00002776** "p" points to the right-most of the two queries. the query on the
2777** left is p->pPrior. The left query could also be a compound query
2778** in which case this routine will be called recursively.
2779**
2780** The results of the total query are to be written into a destination
2781** of type eDest with parameter iParm.
2782**
2783** Example 1: Consider a three-way compound SQL statement.
2784**
2785** SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
2786**
2787** This statement is parsed up as follows:
2788**
2789** SELECT c FROM t3
2790** |
2791** `-----> SELECT b FROM t2
2792** |
jplyon4b11c6d2004-01-19 04:57:53 +00002793** `------> SELECT a FROM t1
drhe78e8282003-01-19 03:59:45 +00002794**
2795** The arrows in the diagram above represent the Select.pPrior pointer.
2796** So if this routine is called with p equal to the t3 query, then
2797** pPrior will be the t2 query. p->op will be TK_UNION in this case.
2798**
2799** Notice that because of the way SQLite parses compound SELECTs, the
2800** individual selects always group from left to right.
drh82c3d632000-06-06 21:56:07 +00002801*/
danielk197784ac9d02004-05-18 09:58:06 +00002802static int multiSelect(
drhfbc4ee72004-08-29 01:31:05 +00002803 Parse *pParse, /* Parsing context */
2804 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00002805 SelectDest *pDest /* What to do with query results */
danielk197784ac9d02004-05-18 09:58:06 +00002806){
drhfbc4ee72004-08-29 01:31:05 +00002807 int rc = SQLITE_OK; /* Success code from a subroutine */
2808 Select *pPrior; /* Another SELECT immediately to our left */
2809 Vdbe *v; /* Generate code to this VDBE */
drh1013c932008-01-06 00:25:21 +00002810 SelectDest dest; /* Alternative data destination */
danielk1977eca7e012008-07-01 16:05:25 +00002811 Select *pDelete = 0; /* Chain of simple selects to delete */
drh633e6d52008-07-28 19:34:53 +00002812 sqlite3 *db; /* Database connection */
drh82c3d632000-06-06 21:56:07 +00002813
drh7b58dae2003-07-20 01:16:46 +00002814 /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs. Only
drhfbc4ee72004-08-29 01:31:05 +00002815 ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
drh82c3d632000-06-06 21:56:07 +00002816 */
drh701bb3b2008-08-02 03:50:39 +00002817 assert( p && p->pPrior ); /* Calling function guarantees this much */
daneae73fb2014-01-16 18:34:33 +00002818 assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
drhb0968b62019-05-29 18:33:59 +00002819 assert( p->selFlags & SF_Compound );
drh633e6d52008-07-28 19:34:53 +00002820 db = pParse->db;
drhd8bc7082000-06-07 23:51:50 +00002821 pPrior = p->pPrior;
drhbc103772008-08-08 18:06:25 +00002822 dest = *pDest;
drhaae0f742021-03-04 16:03:32 +00002823 assert( pPrior->pOrderBy==0 );
2824 assert( pPrior->pLimit==0 );
drh82c3d632000-06-06 21:56:07 +00002825
danielk19774adee202004-05-08 08:23:19 +00002826 v = sqlite3GetVdbe(pParse);
drh701bb3b2008-08-02 03:50:39 +00002827 assert( v!=0 ); /* The VDBE already created by calling function */
drhd8bc7082000-06-07 23:51:50 +00002828
drh1cc3d752002-03-23 00:31:29 +00002829 /* Create the destination temporary table if necessary
2830 */
danielk19776c8c8ce2008-01-02 16:27:09 +00002831 if( dest.eDest==SRT_EphemTab ){
danielk1977b4964b72004-05-18 01:23:38 +00002832 assert( p->pEList );
drh2b596da2012-07-23 21:43:19 +00002833 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
danielk19776c8c8ce2008-01-02 16:27:09 +00002834 dest.eDest = SRT_Table;
drh1cc3d752002-03-23 00:31:29 +00002835 }
2836
drh45f54a52015-01-05 19:16:42 +00002837 /* Special handling for a compound-select that originates as a VALUES clause.
2838 */
drh772460f2015-04-16 14:13:12 +00002839 if( p->selFlags & SF_MultiValue ){
drh45f54a52015-01-05 19:16:42 +00002840 rc = multiSelectValues(pParse, p, &dest);
drh29cdbad2019-12-07 13:42:47 +00002841 if( rc>=0 ) goto multi_select_end;
2842 rc = SQLITE_OK;
drh45f54a52015-01-05 19:16:42 +00002843 }
2844
drhf6e369a2008-06-24 12:46:30 +00002845 /* Make sure all SELECTs in the statement have the same number of elements
2846 ** in their result sets.
2847 */
2848 assert( p->pEList && pPrior->pEList );
dan923cadb2015-06-23 12:19:55 +00002849 assert( p->pEList->nExpr==pPrior->pEList->nExpr );
drhf6e369a2008-06-24 12:46:30 +00002850
daneede6a52014-01-15 19:42:23 +00002851#ifndef SQLITE_OMIT_CTE
drh34055852020-10-19 01:23:48 +00002852 if( (p->selFlags & SF_Recursive)!=0 && hasAnchor(p) ){
drh781def22014-01-22 13:35:53 +00002853 generateWithRecursiveQuery(pParse, p, &dest);
dan8ce71842014-01-14 20:14:09 +00002854 }else
2855#endif
drhf6e369a2008-06-24 12:46:30 +00002856
drha9671a22008-07-08 23:40:20 +00002857 /* Compound SELECTs that have an ORDER BY clause are handled separately.
2858 */
drhf6e369a2008-06-24 12:46:30 +00002859 if( p->pOrderBy ){
drha9671a22008-07-08 23:40:20 +00002860 return multiSelectOrderBy(pParse, p, pDest);
drh03c39052018-05-02 14:24:34 +00002861 }else{
drhf6e369a2008-06-24 12:46:30 +00002862
drhc631ded2018-05-02 02:22:22 +00002863#ifndef SQLITE_OMIT_EXPLAIN
drh03c39052018-05-02 14:24:34 +00002864 if( pPrior->pPrior==0 ){
drh4d799832018-05-03 19:47:14 +00002865 ExplainQueryPlan((pParse, 1, "COMPOUND QUERY"));
drh03c39052018-05-02 14:24:34 +00002866 ExplainQueryPlan((pParse, 1, "LEFT-MOST SUBQUERY"));
drh03c39052018-05-02 14:24:34 +00002867 }
drhc631ded2018-05-02 02:22:22 +00002868#endif
2869
drh03c39052018-05-02 14:24:34 +00002870 /* Generate code for the left and right SELECT statements.
2871 */
2872 switch( p->op ){
2873 case TK_ALL: {
2874 int addr = 0;
drh252d5822021-04-07 13:20:34 +00002875 int nLimit = 0; /* Initialize to suppress harmless compiler warning */
drh03c39052018-05-02 14:24:34 +00002876 assert( !pPrior->pLimit );
2877 pPrior->iLimit = p->iLimit;
2878 pPrior->iOffset = p->iOffset;
2879 pPrior->pLimit = p->pLimit;
drh5d7aef12022-11-22 19:49:16 +00002880 TREETRACE(0x200, pParse, p, ("multiSelect UNION ALL left...\n"));
drh03c39052018-05-02 14:24:34 +00002881 rc = sqlite3Select(pParse, pPrior, &dest);
drhbc7819d2021-03-05 14:08:45 +00002882 pPrior->pLimit = 0;
drh03c39052018-05-02 14:24:34 +00002883 if( rc ){
2884 goto multi_select_end;
drh9f1ef452015-10-06 17:27:18 +00002885 }
drh03c39052018-05-02 14:24:34 +00002886 p->pPrior = 0;
2887 p->iLimit = pPrior->iLimit;
2888 p->iOffset = pPrior->iOffset;
2889 if( p->iLimit ){
2890 addr = sqlite3VdbeAddOp1(v, OP_IfNot, p->iLimit); VdbeCoverage(v);
2891 VdbeComment((v, "Jump ahead if LIMIT reached"));
2892 if( p->iOffset ){
2893 sqlite3VdbeAddOp3(v, OP_OffsetLimit,
2894 p->iLimit, p->iOffset+1, p->iOffset);
2895 }
2896 }
2897 ExplainQueryPlan((pParse, 1, "UNION ALL"));
drh5d7aef12022-11-22 19:49:16 +00002898 TREETRACE(0x200, pParse, p, ("multiSelect UNION ALL right...\n"));
drh03c39052018-05-02 14:24:34 +00002899 rc = sqlite3Select(pParse, p, &dest);
2900 testcase( rc!=SQLITE_OK );
2901 pDelete = p->pPrior;
2902 p->pPrior = pPrior;
2903 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
drhbc7819d2021-03-05 14:08:45 +00002904 if( p->pLimit
2905 && sqlite3ExprIsInteger(p->pLimit->pLeft, &nLimit)
drh03c39052018-05-02 14:24:34 +00002906 && nLimit>0 && p->nSelectRow > sqlite3LogEst((u64)nLimit)
2907 ){
2908 p->nSelectRow = sqlite3LogEst((u64)nLimit);
2909 }
2910 if( addr ){
2911 sqlite3VdbeJumpHere(v, addr);
2912 }
2913 break;
drha9671a22008-07-08 23:40:20 +00002914 }
drh03c39052018-05-02 14:24:34 +00002915 case TK_EXCEPT:
2916 case TK_UNION: {
2917 int unionTab; /* Cursor number of the temp table holding result */
2918 u8 op = 0; /* One of the SRT_ operations to apply to self */
2919 int priorOp; /* The SRT_ operation to apply to prior selects */
2920 Expr *pLimit; /* Saved values of p->nLimit */
2921 int addr;
2922 SelectDest uniondest;
2923
2924 testcase( p->op==TK_EXCEPT );
2925 testcase( p->op==TK_UNION );
2926 priorOp = SRT_Union;
2927 if( dest.eDest==priorOp ){
2928 /* We can reuse a temporary table generated by a SELECT to our
2929 ** right.
2930 */
2931 assert( p->pLimit==0 ); /* Not allowed on leftward elements */
2932 unionTab = dest.iSDParm;
2933 }else{
2934 /* We will need to create our own temporary table to hold the
2935 ** intermediate results.
2936 */
2937 unionTab = pParse->nTab++;
2938 assert( p->pOrderBy==0 );
2939 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
2940 assert( p->addrOpenEphm[0] == -1 );
2941 p->addrOpenEphm[0] = addr;
2942 findRightmost(p)->selFlags |= SF_UsesEphemeral;
2943 assert( p->pEList );
2944 }
drh34055852020-10-19 01:23:48 +00002945
drh03c39052018-05-02 14:24:34 +00002946
2947 /* Code the SELECT statements to our left
drhd8bc7082000-06-07 23:51:50 +00002948 */
drh03c39052018-05-02 14:24:34 +00002949 assert( !pPrior->pOrderBy );
2950 sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
drh5d7aef12022-11-22 19:49:16 +00002951 TREETRACE(0x200, pParse, p, ("multiSelect EXCEPT/UNION left...\n"));
drh03c39052018-05-02 14:24:34 +00002952 rc = sqlite3Select(pParse, pPrior, &uniondest);
2953 if( rc ){
2954 goto multi_select_end;
2955 }
2956
2957 /* Code the current SELECT statement
drhd8bc7082000-06-07 23:51:50 +00002958 */
drh03c39052018-05-02 14:24:34 +00002959 if( p->op==TK_EXCEPT ){
2960 op = SRT_Except;
2961 }else{
2962 assert( p->op==TK_UNION );
2963 op = SRT_Union;
2964 }
2965 p->pPrior = 0;
2966 pLimit = p->pLimit;
2967 p->pLimit = 0;
2968 uniondest.eDest = op;
2969 ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
drhaae0f742021-03-04 16:03:32 +00002970 sqlite3SelectOpName(p->op)));
drh5d7aef12022-11-22 19:49:16 +00002971 TREETRACE(0x200, pParse, p, ("multiSelect EXCEPT/UNION right...\n"));
drh03c39052018-05-02 14:24:34 +00002972 rc = sqlite3Select(pParse, p, &uniondest);
2973 testcase( rc!=SQLITE_OK );
drhb7cbf5c2020-06-15 13:51:34 +00002974 assert( p->pOrderBy==0 );
drh03c39052018-05-02 14:24:34 +00002975 pDelete = p->pPrior;
2976 p->pPrior = pPrior;
2977 p->pOrderBy = 0;
2978 if( p->op==TK_UNION ){
2979 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
2980 }
2981 sqlite3ExprDelete(db, p->pLimit);
2982 p->pLimit = pLimit;
2983 p->iLimit = 0;
2984 p->iOffset = 0;
2985
2986 /* Convert the data in the temporary table into whatever form
2987 ** it is that we currently need.
2988 */
2989 assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
drha9ebfe22019-12-25 23:54:21 +00002990 assert( p->pEList || db->mallocFailed );
2991 if( dest.eDest!=priorOp && db->mallocFailed==0 ){
drh03c39052018-05-02 14:24:34 +00002992 int iCont, iBreak, iStart;
drhec4ccdb2018-12-29 02:26:59 +00002993 iBreak = sqlite3VdbeMakeLabel(pParse);
2994 iCont = sqlite3VdbeMakeLabel(pParse);
drh03c39052018-05-02 14:24:34 +00002995 computeLimitRegisters(pParse, p, iBreak);
2996 sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
2997 iStart = sqlite3VdbeCurrentAddr(v);
2998 selectInnerLoop(pParse, p, unionTab,
2999 0, 0, &dest, iCont, iBreak);
3000 sqlite3VdbeResolveLabel(v, iCont);
3001 sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
3002 sqlite3VdbeResolveLabel(v, iBreak);
3003 sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
3004 }
3005 break;
3006 }
3007 default: assert( p->op==TK_INTERSECT ); {
3008 int tab1, tab2;
3009 int iCont, iBreak, iStart;
3010 Expr *pLimit;
3011 int addr;
3012 SelectDest intersectdest;
3013 int r1;
3014
3015 /* INTERSECT is different from the others since it requires
3016 ** two temporary tables. Hence it has its own case. Begin
3017 ** by allocating the tables we will need.
3018 */
3019 tab1 = pParse->nTab++;
3020 tab2 = pParse->nTab++;
drh93a960a2008-07-10 00:32:42 +00003021 assert( p->pOrderBy==0 );
drh03c39052018-05-02 14:24:34 +00003022
3023 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
drh93a960a2008-07-10 00:32:42 +00003024 assert( p->addrOpenEphm[0] == -1 );
3025 p->addrOpenEphm[0] = addr;
drhd227a292014-02-09 18:02:09 +00003026 findRightmost(p)->selFlags |= SF_UsesEphemeral;
danielk197784ac9d02004-05-18 09:58:06 +00003027 assert( p->pEList );
drh03c39052018-05-02 14:24:34 +00003028
3029 /* Code the SELECTs to our left into temporary table "tab1".
3030 */
3031 sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
drh5d7aef12022-11-22 19:49:16 +00003032 TREETRACE(0x400, pParse, p, ("multiSelect INTERSECT left...\n"));
drh03c39052018-05-02 14:24:34 +00003033 rc = sqlite3Select(pParse, pPrior, &intersectdest);
3034 if( rc ){
3035 goto multi_select_end;
3036 }
3037
3038 /* Code the current SELECT into temporary table "tab2"
3039 */
3040 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
3041 assert( p->addrOpenEphm[1] == -1 );
3042 p->addrOpenEphm[1] = addr;
3043 p->pPrior = 0;
3044 pLimit = p->pLimit;
3045 p->pLimit = 0;
3046 intersectdest.iSDParm = tab2;
3047 ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
drhaae0f742021-03-04 16:03:32 +00003048 sqlite3SelectOpName(p->op)));
drh5d7aef12022-11-22 19:49:16 +00003049 TREETRACE(0x400, pParse, p, ("multiSelect INTERSECT right...\n"));
drh03c39052018-05-02 14:24:34 +00003050 rc = sqlite3Select(pParse, p, &intersectdest);
3051 testcase( rc!=SQLITE_OK );
3052 pDelete = p->pPrior;
3053 p->pPrior = pPrior;
3054 if( p->nSelectRow>pPrior->nSelectRow ){
3055 p->nSelectRow = pPrior->nSelectRow;
3056 }
3057 sqlite3ExprDelete(db, p->pLimit);
3058 p->pLimit = pLimit;
3059
3060 /* Generate code to take the intersection of the two temporary
3061 ** tables.
3062 */
drh5f695122020-02-20 14:08:51 +00003063 if( rc ) break;
drh82c3d632000-06-06 21:56:07 +00003064 assert( p->pEList );
drhec4ccdb2018-12-29 02:26:59 +00003065 iBreak = sqlite3VdbeMakeLabel(pParse);
3066 iCont = sqlite3VdbeMakeLabel(pParse);
drhec7429a2005-10-06 16:53:14 +00003067 computeLimitRegisters(pParse, p, iBreak);
drh03c39052018-05-02 14:24:34 +00003068 sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
3069 r1 = sqlite3GetTempReg(pParse);
3070 iStart = sqlite3VdbeAddOp2(v, OP_RowData, tab1, r1);
3071 sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0);
3072 VdbeCoverage(v);
3073 sqlite3ReleaseTempReg(pParse, r1);
3074 selectInnerLoop(pParse, p, tab1,
drhe8e4af72012-09-21 00:04:28 +00003075 0, 0, &dest, iCont, iBreak);
danielk19774adee202004-05-08 08:23:19 +00003076 sqlite3VdbeResolveLabel(v, iCont);
drh03c39052018-05-02 14:24:34 +00003077 sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
danielk19774adee202004-05-08 08:23:19 +00003078 sqlite3VdbeResolveLabel(v, iBreak);
drh03c39052018-05-02 14:24:34 +00003079 sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
3080 sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
3081 break;
drh82c3d632000-06-06 21:56:07 +00003082 }
drh82c3d632000-06-06 21:56:07 +00003083 }
drh03c39052018-05-02 14:24:34 +00003084
3085 #ifndef SQLITE_OMIT_EXPLAIN
3086 if( p->pNext==0 ){
3087 ExplainQueryPlanPop(pParse);
drh82c3d632000-06-06 21:56:07 +00003088 }
drh03c39052018-05-02 14:24:34 +00003089 #endif
drh82c3d632000-06-06 21:56:07 +00003090 }
drh8428b3b2019-12-19 22:08:19 +00003091 if( pParse->nErr ) goto multi_select_end;
drh03c39052018-05-02 14:24:34 +00003092
drha9671a22008-07-08 23:40:20 +00003093 /* Compute collating sequences used by
3094 ** temporary tables needed to implement the compound select.
3095 ** Attach the KeyInfo structure to all temporary tables.
drh8cdbf832004-08-29 16:25:03 +00003096 **
3097 ** This section is run by the right-most SELECT statement only.
3098 ** SELECT statements to the left always skip this part. The right-most
3099 ** SELECT might also skip this part if it has no ORDER BY clause and
3100 ** no temp tables are required.
drhfbc4ee72004-08-29 01:31:05 +00003101 */
drh7d10d5a2008-08-20 16:35:10 +00003102 if( p->selFlags & SF_UsesEphemeral ){
drhfbc4ee72004-08-29 01:31:05 +00003103 int i; /* Loop counter */
3104 KeyInfo *pKeyInfo; /* Collating sequence for the result set */
drh0342b1f2005-09-01 03:07:44 +00003105 Select *pLoop; /* For looping through SELECT statements */
drhf68d7d12007-05-03 13:02:26 +00003106 CollSeq **apColl; /* For looping through pKeyInfo->aColl[] */
drh93a960a2008-07-10 00:32:42 +00003107 int nCol; /* Number of columns in result set */
drhfbc4ee72004-08-29 01:31:05 +00003108
drhd227a292014-02-09 18:02:09 +00003109 assert( p->pNext==0 );
drhaa6fe5b2021-10-04 13:18:44 +00003110 assert( p->pEList!=0 );
drh93a960a2008-07-10 00:32:42 +00003111 nCol = p->pEList->nExpr;
drhad124322013-10-23 13:30:58 +00003112 pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
danielk1977dc1bdc42004-06-11 10:51:27 +00003113 if( !pKeyInfo ){
mistachkinfad30392016-02-13 23:43:46 +00003114 rc = SQLITE_NOMEM_BKPT;
danielk1977dc1bdc42004-06-11 10:51:27 +00003115 goto multi_select_end;
3116 }
drh0342b1f2005-09-01 03:07:44 +00003117 for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
3118 *apColl = multiSelectCollSeq(pParse, p, i);
3119 if( 0==*apColl ){
drh633e6d52008-07-28 19:34:53 +00003120 *apColl = db->pDfltColl;
danielk1977dc1bdc42004-06-11 10:51:27 +00003121 }
3122 }
3123
drh0342b1f2005-09-01 03:07:44 +00003124 for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
3125 for(i=0; i<2; i++){
drhb9bb7c12006-06-11 23:41:55 +00003126 int addr = pLoop->addrOpenEphm[i];
drh0342b1f2005-09-01 03:07:44 +00003127 if( addr<0 ){
3128 /* If [0] is unused then [1] is also unused. So we can
3129 ** always safely abort as soon as the first unused slot is found */
drhb9bb7c12006-06-11 23:41:55 +00003130 assert( pLoop->addrOpenEphm[1]<0 );
drh0342b1f2005-09-01 03:07:44 +00003131 break;
3132 }
3133 sqlite3VdbeChangeP2(v, addr, nCol);
drh2ec2fb22013-11-06 19:59:23 +00003134 sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
3135 P4_KEYINFO);
drh0ee5a1e2007-01-26 19:04:00 +00003136 pLoop->addrOpenEphm[i] = -1;
drh0342b1f2005-09-01 03:07:44 +00003137 }
danielk1977dc1bdc42004-06-11 10:51:27 +00003138 }
drh2ec2fb22013-11-06 19:59:23 +00003139 sqlite3KeyInfoUnref(pKeyInfo);
danielk197784ac9d02004-05-18 09:58:06 +00003140 }
danielk1977dc1bdc42004-06-11 10:51:27 +00003141
3142multi_select_end:
drh2b596da2012-07-23 21:43:19 +00003143 pDest->iSdst = dest.iSdst;
3144 pDest->nSdst = dest.nSdst;
drhce68b6b2021-08-21 16:42:58 +00003145 if( pDelete ){
3146 sqlite3ParserAddCleanup(pParse,
3147 (void(*)(sqlite3*,void*))sqlite3SelectDelete,
3148 pDelete);
3149 }
danielk197784ac9d02004-05-18 09:58:06 +00003150 return rc;
drh22827922000-06-06 17:27:05 +00003151}
drhb7f91642004-10-31 02:22:47 +00003152#endif /* SQLITE_OMIT_COMPOUND_SELECT */
drh22827922000-06-06 17:27:05 +00003153
drhb21e7c72008-06-22 12:37:57 +00003154/*
mistachkin89b31d72015-07-16 17:29:27 +00003155** Error message for when two or more terms of a compound select have different
3156** size result sets.
3157*/
3158void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p){
3159 if( p->selFlags & SF_Values ){
3160 sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
3161 }else{
3162 sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
drhaae0f742021-03-04 16:03:32 +00003163 " do not have the same number of result columns",
3164 sqlite3SelectOpName(p->op));
mistachkin89b31d72015-07-16 17:29:27 +00003165 }
3166}
3167
3168/*
drhb21e7c72008-06-22 12:37:57 +00003169** Code an output subroutine for a coroutine implementation of a
3170** SELECT statment.
drh0acb7e42008-06-25 00:12:41 +00003171**
drh2b596da2012-07-23 21:43:19 +00003172** The data to be output is contained in pIn->iSdst. There are
3173** pIn->nSdst columns to be output. pDest is where the output should
drh0acb7e42008-06-25 00:12:41 +00003174** be sent.
3175**
3176** regReturn is the number of the register holding the subroutine
3177** return address.
3178**
drhf053d5b2010-08-09 14:26:32 +00003179** If regPrev>0 then it is the first register in a vector that
drh0acb7e42008-06-25 00:12:41 +00003180** records the previous output. mem[regPrev] is a flag that is false
3181** if there has been no previous output. If regPrev>0 then code is
3182** generated to suppress duplicates. pKeyInfo is used for comparing
3183** keys.
3184**
3185** If the LIMIT found in p->iLimit is reached, jump immediately to
3186** iBreak.
drhb21e7c72008-06-22 12:37:57 +00003187*/
drh0acb7e42008-06-25 00:12:41 +00003188static int generateOutputSubroutine(
drh92b01d52008-06-24 00:32:35 +00003189 Parse *pParse, /* Parsing context */
3190 Select *p, /* The SELECT statement */
3191 SelectDest *pIn, /* Coroutine supplying data */
3192 SelectDest *pDest, /* Where to send the data */
3193 int regReturn, /* The return address register */
drh0acb7e42008-06-25 00:12:41 +00003194 int regPrev, /* Previous result register. No uniqueness if 0 */
3195 KeyInfo *pKeyInfo, /* For comparing with previous entry */
drh92b01d52008-06-24 00:32:35 +00003196 int iBreak /* Jump here if we hit the LIMIT */
drhb21e7c72008-06-22 12:37:57 +00003197){
3198 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003199 int iContinue;
3200 int addr;
drhb21e7c72008-06-22 12:37:57 +00003201
drh92b01d52008-06-24 00:32:35 +00003202 addr = sqlite3VdbeCurrentAddr(v);
drhec4ccdb2018-12-29 02:26:59 +00003203 iContinue = sqlite3VdbeMakeLabel(pParse);
drh0acb7e42008-06-25 00:12:41 +00003204
3205 /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
3206 */
3207 if( regPrev ){
drh728e0f92015-10-10 14:41:28 +00003208 int addr1, addr2;
3209 addr1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
3210 addr2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
drh2ec2fb22013-11-06 19:59:23 +00003211 (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
drh728e0f92015-10-10 14:41:28 +00003212 sqlite3VdbeAddOp3(v, OP_Jump, addr2+2, iContinue, addr2+2); VdbeCoverage(v);
3213 sqlite3VdbeJumpHere(v, addr1);
drhe8e4af72012-09-21 00:04:28 +00003214 sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
drhec86c722011-12-09 17:27:51 +00003215 sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
drh0acb7e42008-06-25 00:12:41 +00003216 }
danielk19771f9caa42008-07-02 16:10:45 +00003217 if( pParse->db->mallocFailed ) return 0;
drh0acb7e42008-06-25 00:12:41 +00003218
mistachkind5578432012-08-25 10:01:29 +00003219 /* Suppress the first OFFSET entries if there is an OFFSET clause
drh0acb7e42008-06-25 00:12:41 +00003220 */
drhaa9ce702014-01-22 18:07:04 +00003221 codeOffset(v, p->iOffset, iContinue);
drhb21e7c72008-06-22 12:37:57 +00003222
drhe2248cf2015-05-22 17:29:27 +00003223 assert( pDest->eDest!=SRT_Exists );
3224 assert( pDest->eDest!=SRT_Table );
drhb21e7c72008-06-22 12:37:57 +00003225 switch( pDest->eDest ){
3226 /* Store the result as data using a unique key.
3227 */
drhb21e7c72008-06-22 12:37:57 +00003228 case SRT_EphemTab: {
3229 int r1 = sqlite3GetTempReg(pParse);
3230 int r2 = sqlite3GetTempReg(pParse);
drh2b596da2012-07-23 21:43:19 +00003231 sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
3232 sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
3233 sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
drhb21e7c72008-06-22 12:37:57 +00003234 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
3235 sqlite3ReleaseTempReg(pParse, r2);
3236 sqlite3ReleaseTempReg(pParse, r1);
3237 break;
3238 }
3239
3240#ifndef SQLITE_OMIT_SUBQUERY
drh14318072016-09-06 18:51:25 +00003241 /* If we are creating a set for an "expr IN (SELECT ...)".
drhb21e7c72008-06-22 12:37:57 +00003242 */
3243 case SRT_Set: {
drh6fccc352008-06-27 00:52:45 +00003244 int r1;
drh63cecc42016-09-06 19:08:21 +00003245 testcase( pIn->nSdst>1 );
drhb21e7c72008-06-22 12:37:57 +00003246 r1 = sqlite3GetTempReg(pParse);
dan71c57db2016-07-09 20:23:55 +00003247 sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst,
drh14318072016-09-06 18:51:25 +00003248 r1, pDest->zAffSdst, pIn->nSdst);
drh9b4eaeb2016-11-09 00:10:33 +00003249 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pDest->iSDParm, r1,
3250 pIn->iSdst, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003251 sqlite3ReleaseTempReg(pParse, r1);
drhb21e7c72008-06-22 12:37:57 +00003252 break;
3253 }
3254
drhb21e7c72008-06-22 12:37:57 +00003255 /* If this is a scalar select that is part of an expression, then
3256 ** store the results in the appropriate memory cell and break out
drhcb99c572019-08-09 20:26:01 +00003257 ** of the scan loop. Note that the select might return multiple columns
3258 ** if it is the RHS of a row-value IN operator.
drhb21e7c72008-06-22 12:37:57 +00003259 */
3260 case SRT_Mem: {
drh5f0922b2021-03-04 16:32:28 +00003261 testcase( pIn->nSdst>1 );
3262 sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003263 /* The LIMIT clause will jump out of the loop for us */
3264 break;
3265 }
3266#endif /* #ifndef SQLITE_OMIT_SUBQUERY */
3267
drh7d10d5a2008-08-20 16:35:10 +00003268 /* The results are stored in a sequence of registers
drh2b596da2012-07-23 21:43:19 +00003269 ** starting at pDest->iSdst. Then the co-routine yields.
drhb21e7c72008-06-22 12:37:57 +00003270 */
drh92b01d52008-06-24 00:32:35 +00003271 case SRT_Coroutine: {
drh2b596da2012-07-23 21:43:19 +00003272 if( pDest->iSdst==0 ){
3273 pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
3274 pDest->nSdst = pIn->nSdst;
drhb21e7c72008-06-22 12:37:57 +00003275 }
dan4b79bde2015-04-21 15:49:04 +00003276 sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pIn->nSdst);
drh2b596da2012-07-23 21:43:19 +00003277 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drh92b01d52008-06-24 00:32:35 +00003278 break;
3279 }
3280
drhccfcbce2009-05-18 15:46:07 +00003281 /* If none of the above, then the result destination must be
3282 ** SRT_Output. This routine is never called with any other
3283 ** destination other than the ones handled above or SRT_Output.
3284 **
3285 ** For SRT_Output, results are stored in a sequence of registers.
3286 ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
3287 ** return the next row of result.
drh7d10d5a2008-08-20 16:35:10 +00003288 */
drhccfcbce2009-05-18 15:46:07 +00003289 default: {
3290 assert( pDest->eDest==SRT_Output );
drh2b596da2012-07-23 21:43:19 +00003291 sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003292 break;
3293 }
drhb21e7c72008-06-22 12:37:57 +00003294 }
drh92b01d52008-06-24 00:32:35 +00003295
3296 /* Jump to the end of the loop if the LIMIT is reached.
3297 */
3298 if( p->iLimit ){
drh16897072015-03-07 00:57:37 +00003299 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003300 }
3301
drh92b01d52008-06-24 00:32:35 +00003302 /* Generate the subroutine return
3303 */
drh0acb7e42008-06-25 00:12:41 +00003304 sqlite3VdbeResolveLabel(v, iContinue);
drh92b01d52008-06-24 00:32:35 +00003305 sqlite3VdbeAddOp1(v, OP_Return, regReturn);
3306
3307 return addr;
drhb21e7c72008-06-22 12:37:57 +00003308}
3309
3310/*
3311** Alternative compound select code generator for cases when there
3312** is an ORDER BY clause.
3313**
3314** We assume a query of the following form:
3315**
3316** <selectA> <operator> <selectB> ORDER BY <orderbylist>
3317**
3318** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT. The idea
3319** is to code both <selectA> and <selectB> with the ORDER BY clause as
3320** co-routines. Then run the co-routines in parallel and merge the results
3321** into the output. In addition to the two coroutines (called selectA and
3322** selectB) there are 7 subroutines:
3323**
3324** outA: Move the output of the selectA coroutine into the output
3325** of the compound query.
3326**
3327** outB: Move the output of the selectB coroutine into the output
3328** of the compound query. (Only generated for UNION and
3329** UNION ALL. EXCEPT and INSERTSECT never output a row that
3330** appears only in B.)
3331**
3332** AltB: Called when there is data from both coroutines and A<B.
3333**
3334** AeqB: Called when there is data from both coroutines and A==B.
3335**
3336** AgtB: Called when there is data from both coroutines and A>B.
3337**
3338** EofA: Called when data is exhausted from selectA.
3339**
3340** EofB: Called when data is exhausted from selectB.
3341**
3342** The implementation of the latter five subroutines depend on which
3343** <operator> is used:
3344**
3345**
3346** UNION ALL UNION EXCEPT INTERSECT
3347** ------------- ----------------- -------------- -----------------
drh0acb7e42008-06-25 00:12:41 +00003348** AltB: outA, nextA outA, nextA outA, nextA nextA
drhb21e7c72008-06-22 12:37:57 +00003349**
drh0acb7e42008-06-25 00:12:41 +00003350** AeqB: outA, nextA nextA nextA outA, nextA
drhb21e7c72008-06-22 12:37:57 +00003351**
drh0acb7e42008-06-25 00:12:41 +00003352** AgtB: outB, nextB outB, nextB nextB nextB
drhb21e7c72008-06-22 12:37:57 +00003353**
drh0acb7e42008-06-25 00:12:41 +00003354** EofA: outB, nextB outB, nextB halt halt
drhb21e7c72008-06-22 12:37:57 +00003355**
drh0acb7e42008-06-25 00:12:41 +00003356** EofB: outA, nextA outA, nextA outA, nextA halt
3357**
3358** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
3359** causes an immediate jump to EofA and an EOF on B following nextB causes
3360** an immediate jump to EofB. Within EofA and EofB, and EOF on entry or
3361** following nextX causes a jump to the end of the select processing.
3362**
3363** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
3364** within the output subroutine. The regPrev register set holds the previously
3365** output value. A comparison is made against this value and the output
3366** is skipped if the next results would be the same as the previous.
drhb21e7c72008-06-22 12:37:57 +00003367**
3368** The implementation plan is to implement the two coroutines and seven
3369** subroutines first, then put the control logic at the bottom. Like this:
3370**
3371** goto Init
3372** coA: coroutine for left query (A)
3373** coB: coroutine for right query (B)
3374** outA: output one row of A
3375** outB: output one row of B (UNION and UNION ALL only)
3376** EofA: ...
3377** EofB: ...
3378** AltB: ...
3379** AeqB: ...
3380** AgtB: ...
3381** Init: initialize coroutine registers
3382** yield coA
3383** if eof(A) goto EofA
3384** yield coB
3385** if eof(B) goto EofB
3386** Cmpr: Compare A, B
3387** Jump AltB, AeqB, AgtB
3388** End: ...
3389**
3390** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
3391** actually called using Gosub and they do not Return. EofA and EofB loop
3392** until all data is exhausted then jump to the "end" labe. AltB, AeqB,
3393** and AgtB jump to either L2 or to one of EofA or EofB.
3394*/
danielk1977de3e41e2008-08-04 03:51:24 +00003395#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhb21e7c72008-06-22 12:37:57 +00003396static int multiSelectOrderBy(
3397 Parse *pParse, /* Parsing context */
3398 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00003399 SelectDest *pDest /* What to do with query results */
drhb21e7c72008-06-22 12:37:57 +00003400){
drh0acb7e42008-06-25 00:12:41 +00003401 int i, j; /* Loop counters */
drhb21e7c72008-06-22 12:37:57 +00003402 Select *pPrior; /* Another SELECT immediately to our left */
drh38cebe02021-12-30 00:37:11 +00003403 Select *pSplit; /* Left-most SELECT in the right-hand group */
3404 int nSelect; /* Number of SELECT statements in the compound */
drhb21e7c72008-06-22 12:37:57 +00003405 Vdbe *v; /* Generate code to this VDBE */
drhb21e7c72008-06-22 12:37:57 +00003406 SelectDest destA; /* Destination for coroutine A */
3407 SelectDest destB; /* Destination for coroutine B */
drh92b01d52008-06-24 00:32:35 +00003408 int regAddrA; /* Address register for select-A coroutine */
drh92b01d52008-06-24 00:32:35 +00003409 int regAddrB; /* Address register for select-B coroutine */
drh92b01d52008-06-24 00:32:35 +00003410 int addrSelectA; /* Address of the select-A coroutine */
3411 int addrSelectB; /* Address of the select-B coroutine */
3412 int regOutA; /* Address register for the output-A subroutine */
3413 int regOutB; /* Address register for the output-B subroutine */
3414 int addrOutA; /* Address of the output-A subroutine */
drhb27b7f52008-12-10 18:03:45 +00003415 int addrOutB = 0; /* Address of the output-B subroutine */
drh92b01d52008-06-24 00:32:35 +00003416 int addrEofA; /* Address of the select-A-exhausted subroutine */
drh81cf13e2014-02-07 18:27:53 +00003417 int addrEofA_noB; /* Alternate addrEofA if B is uninitialized */
drh92b01d52008-06-24 00:32:35 +00003418 int addrEofB; /* Address of the select-B-exhausted subroutine */
3419 int addrAltB; /* Address of the A<B subroutine */
3420 int addrAeqB; /* Address of the A==B subroutine */
3421 int addrAgtB; /* Address of the A>B subroutine */
3422 int regLimitA; /* Limit register for select-A */
3423 int regLimitB; /* Limit register for select-A */
drh0acb7e42008-06-25 00:12:41 +00003424 int regPrev; /* A range of registers to hold previous output */
drh92b01d52008-06-24 00:32:35 +00003425 int savedLimit; /* Saved value of p->iLimit */
3426 int savedOffset; /* Saved value of p->iOffset */
3427 int labelCmpr; /* Label for the start of the merge algorithm */
3428 int labelEnd; /* Label for the end of the overall SELECT stmt */
drh728e0f92015-10-10 14:41:28 +00003429 int addr1; /* Jump instructions that get retargetted */
drh92b01d52008-06-24 00:32:35 +00003430 int op; /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
drh96067812008-09-23 09:36:10 +00003431 KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
drh0acb7e42008-06-25 00:12:41 +00003432 KeyInfo *pKeyMerge; /* Comparison information for merging rows */
3433 sqlite3 *db; /* Database connection */
3434 ExprList *pOrderBy; /* The ORDER BY clause */
3435 int nOrderBy; /* Number of terms in the ORDER BY clause */
drhabc38152020-07-22 13:38:04 +00003436 u32 *aPermute; /* Mapping from ORDER BY terms to result set columns */
drhb21e7c72008-06-22 12:37:57 +00003437
drh92b01d52008-06-24 00:32:35 +00003438 assert( p->pOrderBy!=0 );
drh96067812008-09-23 09:36:10 +00003439 assert( pKeyDup==0 ); /* "Managed" code needs this. Ticket #3382. */
drh0acb7e42008-06-25 00:12:41 +00003440 db = pParse->db;
drh92b01d52008-06-24 00:32:35 +00003441 v = pParse->pVdbe;
drhccfcbce2009-05-18 15:46:07 +00003442 assert( v!=0 ); /* Already thrown the error if VDBE alloc failed */
drhec4ccdb2018-12-29 02:26:59 +00003443 labelEnd = sqlite3VdbeMakeLabel(pParse);
3444 labelCmpr = sqlite3VdbeMakeLabel(pParse);
drh0acb7e42008-06-25 00:12:41 +00003445
drh92b01d52008-06-24 00:32:35 +00003446
3447 /* Patch up the ORDER BY clause
3448 */
3449 op = p->op;
drh38cebe02021-12-30 00:37:11 +00003450 assert( p->pPrior->pOrderBy==0 );
drh0acb7e42008-06-25 00:12:41 +00003451 pOrderBy = p->pOrderBy;
drh93a960a2008-07-10 00:32:42 +00003452 assert( pOrderBy );
drh93a960a2008-07-10 00:32:42 +00003453 nOrderBy = pOrderBy->nExpr;
3454
drh0acb7e42008-06-25 00:12:41 +00003455 /* For operators other than UNION ALL we have to make sure that
3456 ** the ORDER BY clause covers every term of the result set. Add
3457 ** terms to the ORDER BY clause as necessary.
3458 */
3459 if( op!=TK_ALL ){
3460 for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
drh7d10d5a2008-08-20 16:35:10 +00003461 struct ExprList_item *pItem;
3462 for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
drh7d4c94b2021-10-04 22:34:38 +00003463 assert( pItem!=0 );
drhc2acc4e2013-11-15 18:15:19 +00003464 assert( pItem->u.x.iOrderByCol>0 );
3465 if( pItem->u.x.iOrderByCol==i ) break;
drh0acb7e42008-06-25 00:12:41 +00003466 }
3467 if( j==nOrderBy ){
drhb7916a72009-05-27 10:31:29 +00003468 Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
mistachkinfad30392016-02-13 23:43:46 +00003469 if( pNew==0 ) return SQLITE_NOMEM_BKPT;
drh0acb7e42008-06-25 00:12:41 +00003470 pNew->flags |= EP_IntValue;
drh33e619f2009-05-28 01:00:55 +00003471 pNew->u.iValue = i;
drh43606172017-04-05 11:32:13 +00003472 p->pOrderBy = pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
drhc2acc4e2013-11-15 18:15:19 +00003473 if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
drh0acb7e42008-06-25 00:12:41 +00003474 }
3475 }
3476 }
3477
3478 /* Compute the comparison permutation and keyinfo that is used with
drh10c081a2009-04-16 00:24:23 +00003479 ** the permutation used to determine if the next
drh0acb7e42008-06-25 00:12:41 +00003480 ** row of results comes from selectA or selectB. Also add explicit
3481 ** collations to the ORDER BY clause terms so that when the subqueries
3482 ** to the right and the left are evaluated, they use the correct
3483 ** collation.
3484 */
drhabc38152020-07-22 13:38:04 +00003485 aPermute = sqlite3DbMallocRawNN(db, sizeof(u32)*(nOrderBy + 1));
drh0acb7e42008-06-25 00:12:41 +00003486 if( aPermute ){
drh7d10d5a2008-08-20 16:35:10 +00003487 struct ExprList_item *pItem;
drhb1702022016-01-30 00:45:18 +00003488 aPermute[0] = nOrderBy;
3489 for(i=1, pItem=pOrderBy->a; i<=nOrderBy; i++, pItem++){
drh7d4c94b2021-10-04 22:34:38 +00003490 assert( pItem!=0 );
drh67366182015-04-16 14:33:35 +00003491 assert( pItem->u.x.iOrderByCol>0 );
drh2ec18a32015-06-23 23:31:52 +00003492 assert( pItem->u.x.iOrderByCol<=p->pEList->nExpr );
drhc2acc4e2013-11-15 18:15:19 +00003493 aPermute[i] = pItem->u.x.iOrderByCol - 1;
drh0acb7e42008-06-25 00:12:41 +00003494 }
dan53bed452014-01-24 20:37:18 +00003495 pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
drh0acb7e42008-06-25 00:12:41 +00003496 }else{
3497 pKeyMerge = 0;
3498 }
3499
drh0acb7e42008-06-25 00:12:41 +00003500 /* Allocate a range of temporary registers and the KeyInfo needed
3501 ** for the logic that removes duplicate result rows when the
3502 ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
3503 */
3504 if( op==TK_ALL ){
3505 regPrev = 0;
3506 }else{
3507 int nExpr = p->pEList->nExpr;
drh1c0dc822008-10-30 22:13:23 +00003508 assert( nOrderBy>=nExpr || db->mallocFailed );
drhc8ac0d12013-02-16 02:41:01 +00003509 regPrev = pParse->nMem+1;
3510 pParse->nMem += nExpr+1;
drh0acb7e42008-06-25 00:12:41 +00003511 sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
drhad124322013-10-23 13:30:58 +00003512 pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
drh0acb7e42008-06-25 00:12:41 +00003513 if( pKeyDup ){
drh2ec2fb22013-11-06 19:59:23 +00003514 assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
drh0acb7e42008-06-25 00:12:41 +00003515 for(i=0; i<nExpr; i++){
3516 pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
dan6e118922019-08-12 16:36:38 +00003517 pKeyDup->aSortFlags[i] = 0;
drh0acb7e42008-06-25 00:12:41 +00003518 }
3519 }
3520 }
drh92b01d52008-06-24 00:32:35 +00003521
3522 /* Separate the left and the right query from one another
3523 */
drh38cebe02021-12-30 00:37:11 +00003524 nSelect = 1;
3525 if( (op==TK_ALL || op==TK_UNION)
3526 && OptimizationEnabled(db, SQLITE_BalancedMerge)
3527 ){
3528 for(pSplit=p; pSplit->pPrior!=0 && pSplit->op==op; pSplit=pSplit->pPrior){
3529 nSelect++;
3530 assert( pSplit->pPrior->pNext==pSplit );
3531 }
3532 }
3533 if( nSelect<=3 ){
3534 pSplit = p;
3535 }else{
3536 pSplit = p;
3537 for(i=2; i<nSelect; i+=2){ pSplit = pSplit->pPrior; }
3538 }
3539 pPrior = pSplit->pPrior;
drh98bb34c2022-01-20 12:58:15 +00003540 assert( pPrior!=0 );
drh38cebe02021-12-30 00:37:11 +00003541 pSplit->pPrior = 0;
drhd227a292014-02-09 18:02:09 +00003542 pPrior->pNext = 0;
drh38cebe02021-12-30 00:37:11 +00003543 assert( p->pOrderBy == pOrderBy );
3544 assert( pOrderBy!=0 || db->mallocFailed );
3545 pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
drh9aff8242021-12-30 17:46:15 +00003546 sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
3547 sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
drh0acb7e42008-06-25 00:12:41 +00003548
drh92b01d52008-06-24 00:32:35 +00003549 /* Compute the limit registers */
3550 computeLimitRegisters(pParse, p, labelEnd);
drh0acb7e42008-06-25 00:12:41 +00003551 if( p->iLimit && op==TK_ALL ){
drh92b01d52008-06-24 00:32:35 +00003552 regLimitA = ++pParse->nMem;
3553 regLimitB = ++pParse->nMem;
3554 sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
3555 regLimitA);
3556 sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
3557 }else{
3558 regLimitA = regLimitB = 0;
3559 }
drh633e6d52008-07-28 19:34:53 +00003560 sqlite3ExprDelete(db, p->pLimit);
drh0acb7e42008-06-25 00:12:41 +00003561 p->pLimit = 0;
drh92b01d52008-06-24 00:32:35 +00003562
drhb21e7c72008-06-22 12:37:57 +00003563 regAddrA = ++pParse->nMem;
drhb21e7c72008-06-22 12:37:57 +00003564 regAddrB = ++pParse->nMem;
drhb21e7c72008-06-22 12:37:57 +00003565 regOutA = ++pParse->nMem;
3566 regOutB = ++pParse->nMem;
3567 sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
3568 sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
drhe2ca99c2018-05-02 00:33:43 +00003569
drhaae0f742021-03-04 16:03:32 +00003570 ExplainQueryPlan((pParse, 1, "MERGE (%s)", sqlite3SelectOpName(p->op)));
drhb21e7c72008-06-22 12:37:57 +00003571
drh92b01d52008-06-24 00:32:35 +00003572 /* Generate a coroutine to evaluate the SELECT statement to the
drh0acb7e42008-06-25 00:12:41 +00003573 ** left of the compound operator - the "A" select.
3574 */
drhed71a832014-02-07 19:18:10 +00003575 addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
drh728e0f92015-10-10 14:41:28 +00003576 addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
drhed71a832014-02-07 19:18:10 +00003577 VdbeComment((v, "left SELECT"));
drh92b01d52008-06-24 00:32:35 +00003578 pPrior->iLimit = regLimitA;
drhc631ded2018-05-02 02:22:22 +00003579 ExplainQueryPlan((pParse, 1, "LEFT"));
drh7d10d5a2008-08-20 16:35:10 +00003580 sqlite3Select(pParse, pPrior, &destA);
drh2fade2f2016-02-09 02:12:20 +00003581 sqlite3VdbeEndCoroutine(v, regAddrA);
drh728e0f92015-10-10 14:41:28 +00003582 sqlite3VdbeJumpHere(v, addr1);
drhb21e7c72008-06-22 12:37:57 +00003583
drh92b01d52008-06-24 00:32:35 +00003584 /* Generate a coroutine to evaluate the SELECT statement on
3585 ** the right - the "B" select
3586 */
drhed71a832014-02-07 19:18:10 +00003587 addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
drh728e0f92015-10-10 14:41:28 +00003588 addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
drhed71a832014-02-07 19:18:10 +00003589 VdbeComment((v, "right SELECT"));
drh92b01d52008-06-24 00:32:35 +00003590 savedLimit = p->iLimit;
3591 savedOffset = p->iOffset;
3592 p->iLimit = regLimitB;
3593 p->iOffset = 0;
drhc631ded2018-05-02 02:22:22 +00003594 ExplainQueryPlan((pParse, 1, "RIGHT"));
drh7d10d5a2008-08-20 16:35:10 +00003595 sqlite3Select(pParse, p, &destB);
drh92b01d52008-06-24 00:32:35 +00003596 p->iLimit = savedLimit;
3597 p->iOffset = savedOffset;
drh2fade2f2016-02-09 02:12:20 +00003598 sqlite3VdbeEndCoroutine(v, regAddrB);
drhb21e7c72008-06-22 12:37:57 +00003599
drh92b01d52008-06-24 00:32:35 +00003600 /* Generate a subroutine that outputs the current row of the A
drh0acb7e42008-06-25 00:12:41 +00003601 ** select as the next output row of the compound select.
drh92b01d52008-06-24 00:32:35 +00003602 */
drhb21e7c72008-06-22 12:37:57 +00003603 VdbeNoopComment((v, "Output routine for A"));
drh0acb7e42008-06-25 00:12:41 +00003604 addrOutA = generateOutputSubroutine(pParse,
3605 p, &destA, pDest, regOutA,
drh2ec2fb22013-11-06 19:59:23 +00003606 regPrev, pKeyDup, labelEnd);
drhb21e7c72008-06-22 12:37:57 +00003607
drh92b01d52008-06-24 00:32:35 +00003608 /* Generate a subroutine that outputs the current row of the B
drh0acb7e42008-06-25 00:12:41 +00003609 ** select as the next output row of the compound select.
drh92b01d52008-06-24 00:32:35 +00003610 */
drh0acb7e42008-06-25 00:12:41 +00003611 if( op==TK_ALL || op==TK_UNION ){
3612 VdbeNoopComment((v, "Output routine for B"));
3613 addrOutB = generateOutputSubroutine(pParse,
3614 p, &destB, pDest, regOutB,
drh2ec2fb22013-11-06 19:59:23 +00003615 regPrev, pKeyDup, labelEnd);
drh0acb7e42008-06-25 00:12:41 +00003616 }
drh2ec2fb22013-11-06 19:59:23 +00003617 sqlite3KeyInfoUnref(pKeyDup);
drhb21e7c72008-06-22 12:37:57 +00003618
drh92b01d52008-06-24 00:32:35 +00003619 /* Generate a subroutine to run when the results from select A
3620 ** are exhausted and only data in select B remains.
3621 */
drhb21e7c72008-06-22 12:37:57 +00003622 if( op==TK_EXCEPT || op==TK_INTERSECT ){
drh81cf13e2014-02-07 18:27:53 +00003623 addrEofA_noB = addrEofA = labelEnd;
drhb21e7c72008-06-22 12:37:57 +00003624 }else{
drh81cf13e2014-02-07 18:27:53 +00003625 VdbeNoopComment((v, "eof-A subroutine"));
3626 addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3627 addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
drh688852a2014-02-17 22:40:43 +00003628 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003629 sqlite3VdbeGoto(v, addrEofA);
drhc3489bb2016-02-25 16:04:59 +00003630 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
drhb21e7c72008-06-22 12:37:57 +00003631 }
3632
drh92b01d52008-06-24 00:32:35 +00003633 /* Generate a subroutine to run when the results from select B
3634 ** are exhausted and only data in select A remains.
3635 */
drhb21e7c72008-06-22 12:37:57 +00003636 if( op==TK_INTERSECT ){
drh92b01d52008-06-24 00:32:35 +00003637 addrEofB = addrEofA;
drh95aa47b2010-11-16 02:49:15 +00003638 if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
drhb21e7c72008-06-22 12:37:57 +00003639 }else{
drh92b01d52008-06-24 00:32:35 +00003640 VdbeNoopComment((v, "eof-B subroutine"));
drh81cf13e2014-02-07 18:27:53 +00003641 addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
drh688852a2014-02-17 22:40:43 +00003642 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003643 sqlite3VdbeGoto(v, addrEofB);
drhb21e7c72008-06-22 12:37:57 +00003644 }
3645
drh92b01d52008-06-24 00:32:35 +00003646 /* Generate code to handle the case of A<B
3647 */
drhb21e7c72008-06-22 12:37:57 +00003648 VdbeNoopComment((v, "A-lt-B subroutine"));
drh0acb7e42008-06-25 00:12:41 +00003649 addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
drh688852a2014-02-17 22:40:43 +00003650 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003651 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003652
drh92b01d52008-06-24 00:32:35 +00003653 /* Generate code to handle the case of A==B
3654 */
drhb21e7c72008-06-22 12:37:57 +00003655 if( op==TK_ALL ){
3656 addrAeqB = addrAltB;
drh0acb7e42008-06-25 00:12:41 +00003657 }else if( op==TK_INTERSECT ){
3658 addrAeqB = addrAltB;
3659 addrAltB++;
drh92b01d52008-06-24 00:32:35 +00003660 }else{
drhb21e7c72008-06-22 12:37:57 +00003661 VdbeNoopComment((v, "A-eq-B subroutine"));
drh0acb7e42008-06-25 00:12:41 +00003662 addrAeqB =
drh688852a2014-02-17 22:40:43 +00003663 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003664 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003665 }
3666
drh92b01d52008-06-24 00:32:35 +00003667 /* Generate code to handle the case of A>B
3668 */
drhb21e7c72008-06-22 12:37:57 +00003669 VdbeNoopComment((v, "A-gt-B subroutine"));
3670 addrAgtB = sqlite3VdbeCurrentAddr(v);
3671 if( op==TK_ALL || op==TK_UNION ){
3672 sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3673 }
drh688852a2014-02-17 22:40:43 +00003674 sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003675 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003676
drh92b01d52008-06-24 00:32:35 +00003677 /* This code runs once to initialize everything.
3678 */
drh728e0f92015-10-10 14:41:28 +00003679 sqlite3VdbeJumpHere(v, addr1);
drh688852a2014-02-17 22:40:43 +00003680 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
3681 sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003682
3683 /* Implement the main merge loop
3684 */
3685 sqlite3VdbeResolveLabel(v, labelCmpr);
drh0acb7e42008-06-25 00:12:41 +00003686 sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
drh2b596da2012-07-23 21:43:19 +00003687 sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
drh2ec2fb22013-11-06 19:59:23 +00003688 (char*)pKeyMerge, P4_KEYINFO);
drh953f7612012-12-07 22:18:54 +00003689 sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
drh688852a2014-02-17 22:40:43 +00003690 sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003691
3692 /* Jump to the this point in order to terminate the query.
3693 */
drhb21e7c72008-06-22 12:37:57 +00003694 sqlite3VdbeResolveLabel(v, labelEnd);
drh92b01d52008-06-24 00:32:35 +00003695
drh54422232022-11-07 15:23:51 +00003696 /* Make arrangements to free the 2nd and subsequent arms of the compound
3697 ** after the parse has finished */
drh38cebe02021-12-30 00:37:11 +00003698 if( pSplit->pPrior ){
drh44132242022-09-01 13:51:09 +00003699 sqlite3ParserAddCleanup(pParse,
3700 (void(*)(sqlite3*,void*))sqlite3SelectDelete, pSplit->pPrior);
danielk19775e7ad502008-07-01 17:39:27 +00003701 }
drh38cebe02021-12-30 00:37:11 +00003702 pSplit->pPrior = pPrior;
3703 pPrior->pNext = pSplit;
dancd0b2452021-04-12 12:02:49 +00003704 sqlite3ExprListDelete(db, pPrior->pOrderBy);
3705 pPrior->pOrderBy = 0;
3706
drh92b01d52008-06-24 00:32:35 +00003707 /*** TBD: Insert subroutine calls to close cursors on incomplete
3708 **** subqueries ****/
drhe2ca99c2018-05-02 00:33:43 +00003709 ExplainQueryPlanPop(pParse);
drh3dc4cc62015-04-15 07:10:25 +00003710 return pParse->nErr!=0;
drhb21e7c72008-06-22 12:37:57 +00003711}
danielk1977de3e41e2008-08-04 03:51:24 +00003712#endif
drhb21e7c72008-06-22 12:37:57 +00003713
shane3514b6f2008-07-22 05:00:55 +00003714#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh46967de2017-04-14 12:39:37 +00003715
3716/* An instance of the SubstContext object describes an substitution edit
3717** to be performed on a parse tree.
3718**
3719** All references to columns in table iTable are to be replaced by corresponding
3720** expressions in pEList.
drhc133bab2022-04-11 20:15:52 +00003721**
3722** ## About "isOuterJoin":
3723**
3724** The isOuterJoin column indicates that the replacement will occur into a
3725** position in the parent that NULL-able due to an OUTER JOIN. Either the
3726** target slot in the parent is the right operand of a LEFT JOIN, or one of
3727** the left operands of a RIGHT JOIN. In either case, we need to potentially
3728** bypass the substituted expression with OP_IfNullRow.
3729**
drh40c9bec2022-09-20 16:57:49 +00003730** Suppose the original expression is an integer constant. Even though the table
drhc133bab2022-04-11 20:15:52 +00003731** has the nullRow flag set, because the expression is an integer constant,
3732** it will not be NULLed out. So instead, we insert an OP_IfNullRow opcode
3733** that checks to see if the nullRow flag is set on the table. If the nullRow
3734** flag is set, then the value in the register is set to NULL and the original
3735** expression is bypassed. If the nullRow flag is not set, then the original
3736** expression runs to populate the register.
3737**
3738** Example where this is needed:
3739**
3740** CREATE TABLE t1(a INTEGER PRIMARY KEY, b INT);
3741** CREATE TABLE t2(x INT UNIQUE);
3742**
3743** SELECT a,b,m,x FROM t1 LEFT JOIN (SELECT 59 AS m,x FROM t2) ON b=x;
3744**
3745** When the subquery on the right side of the LEFT JOIN is flattened, we
3746** have to add OP_IfNullRow in front of the OP_Integer that implements the
3747** "m" value of the subquery so that a NULL will be loaded instead of 59
3748** when processing a non-matched row of the left.
drh46967de2017-04-14 12:39:37 +00003749*/
3750typedef struct SubstContext {
3751 Parse *pParse; /* The parsing context */
3752 int iTable; /* Replace references to this table */
drh31d6fd52017-04-14 19:03:10 +00003753 int iNewTable; /* New table number */
drhc133bab2022-04-11 20:15:52 +00003754 int isOuterJoin; /* Add TK_IF_NULL_ROW opcodes on each replacement */
drh46967de2017-04-14 12:39:37 +00003755 ExprList *pEList; /* Replacement expressions */
dan879164e2022-10-14 19:30:34 +00003756 ExprList *pCList; /* Collation sequences for replacement expr */
drh46967de2017-04-14 12:39:37 +00003757} SubstContext;
3758
drh17435752007-08-16 04:30:38 +00003759/* Forward Declarations */
drh46967de2017-04-14 12:39:37 +00003760static void substExprList(SubstContext*, ExprList*);
3761static void substSelect(SubstContext*, Select*, int);
drh17435752007-08-16 04:30:38 +00003762
drh22827922000-06-06 17:27:05 +00003763/*
drh832508b2002-03-02 17:04:07 +00003764** Scan through the expression pExpr. Replace every reference to
drh6a3ea0e2003-05-02 14:32:12 +00003765** a column in table number iTable with a copy of the iColumn-th
drh84e59202002-03-14 14:33:31 +00003766** entry in pEList. (But leave references to the ROWID column
drh6a3ea0e2003-05-02 14:32:12 +00003767** unchanged.)
drh832508b2002-03-02 17:04:07 +00003768**
3769** This routine is part of the flattening procedure. A subquery
3770** whose result set is defined by pEList appears as entry in the
3771** FROM clause of a SELECT such that the VDBE cursor assigned to that
drhaca19e12017-04-07 19:41:31 +00003772** FORM clause entry is iTable. This routine makes the necessary
drh832508b2002-03-02 17:04:07 +00003773** changes to pExpr so that it refers directly to the source table
3774** of the subquery rather the result set of the subquery.
3775*/
drhb7916a72009-05-27 10:31:29 +00003776static Expr *substExpr(
drh46967de2017-04-14 12:39:37 +00003777 SubstContext *pSubst, /* Description of the substitution */
3778 Expr *pExpr /* Expr in which substitution occurs */
drh17435752007-08-16 04:30:38 +00003779){
drhb7916a72009-05-27 10:31:29 +00003780 if( pExpr==0 ) return 0;
drh33b2cb92022-06-07 13:09:58 +00003781 if( ExprHasProperty(pExpr, EP_OuterON|EP_InnerON)
drhd1985262022-04-11 11:25:28 +00003782 && pExpr->w.iJoin==pSubst->iTable
drh3d240d22017-09-28 16:56:55 +00003783 ){
drh33b2cb92022-06-07 13:09:58 +00003784 testcase( ExprHasProperty(pExpr, EP_InnerON) );
drhd1985262022-04-11 11:25:28 +00003785 pExpr->w.iJoin = pSubst->iNewTable;
drh399c7e22017-04-14 17:18:45 +00003786 }
drh2e52a9c2020-04-04 00:15:54 +00003787 if( pExpr->op==TK_COLUMN
3788 && pExpr->iTable==pSubst->iTable
3789 && !ExprHasProperty(pExpr, EP_FixedCol)
3790 ){
drh6e5020e2021-04-07 15:45:01 +00003791#ifdef SQLITE_ALLOW_ROWID_IN_VIEW
drh50350a12004-02-13 16:22:22 +00003792 if( pExpr->iColumn<0 ){
3793 pExpr->op = TK_NULL;
drh6e5020e2021-04-07 15:45:01 +00003794 }else
3795#endif
3796 {
drh50350a12004-02-13 16:22:22 +00003797 Expr *pNew;
dan879164e2022-10-14 19:30:34 +00003798 int iColumn = pExpr->iColumn;
3799 Expr *pCopy = pSubst->pEList->a[iColumn].pExpr;
drh31d6fd52017-04-14 19:03:10 +00003800 Expr ifNullRow;
dan879164e2022-10-14 19:30:34 +00003801 assert( pSubst->pEList!=0 && iColumn<pSubst->pEList->nExpr );
drh1fd4e7b2018-07-28 14:56:56 +00003802 assert( pExpr->pRight==0 );
dan44c56042016-12-07 15:38:37 +00003803 if( sqlite3ExprIsVector(pCopy) ){
drh46967de2017-04-14 12:39:37 +00003804 sqlite3VectorErrorMsg(pSubst->pParse, pCopy);
dan44c56042016-12-07 15:38:37 +00003805 }else{
drh46967de2017-04-14 12:39:37 +00003806 sqlite3 *db = pSubst->pParse->db;
drhc133bab2022-04-11 20:15:52 +00003807 if( pSubst->isOuterJoin && pCopy->op!=TK_COLUMN ){
drh31d6fd52017-04-14 19:03:10 +00003808 memset(&ifNullRow, 0, sizeof(ifNullRow));
3809 ifNullRow.op = TK_IF_NULL_ROW;
3810 ifNullRow.pLeft = pCopy;
3811 ifNullRow.iTable = pSubst->iNewTable;
drh4b1b65c2022-07-26 15:32:02 +00003812 ifNullRow.iColumn = -99;
drh46fe1382020-08-19 23:32:06 +00003813 ifNullRow.flags = EP_IfNullRow;
drh31d6fd52017-04-14 19:03:10 +00003814 pCopy = &ifNullRow;
3815 }
drh11df7d22018-12-06 19:15:36 +00003816 testcase( ExprHasProperty(pCopy, EP_Subquery) );
dan44c56042016-12-07 15:38:37 +00003817 pNew = sqlite3ExprDup(db, pCopy, 0);
drh8c6cb1b2021-04-19 20:36:13 +00003818 if( db->mallocFailed ){
3819 sqlite3ExprDelete(db, pNew);
3820 return pExpr;
3821 }
drhc133bab2022-04-11 20:15:52 +00003822 if( pSubst->isOuterJoin ){
danbd11a2a2017-06-20 17:43:26 +00003823 ExprSetProperty(pNew, EP_CanBeNull);
3824 }
drh67a99db2022-05-13 14:52:04 +00003825 if( ExprHasProperty(pExpr,EP_OuterON|EP_InnerON) ){
drh3a6e4c52022-04-11 12:38:06 +00003826 sqlite3SetJoinExpr(pNew, pExpr->w.iJoin,
drh67a99db2022-05-13 14:52:04 +00003827 pExpr->flags & (EP_OuterON|EP_InnerON));
dan44c56042016-12-07 15:38:37 +00003828 }
3829 sqlite3ExprDelete(db, pExpr);
3830 pExpr = pNew;
dan410fac32022-06-02 16:26:21 +00003831 if( pExpr->op==TK_TRUEFALSE ){
3832 pExpr->u.iValue = sqlite3ExprTruthValue(pExpr);
3833 pExpr->op = TK_INTEGER;
3834 ExprSetProperty(pExpr, EP_IntValue);
3835 }
dane0866392019-09-09 19:49:42 +00003836
danfa508342019-09-10 15:33:52 +00003837 /* Ensure that the expression now has an implicit collation sequence,
3838 ** just as it did when it was a column of a view or sub-query. */
dan879164e2022-10-14 19:30:34 +00003839 {
3840 CollSeq *pNat = sqlite3ExprCollSeq(pSubst->pParse, pExpr);
3841 CollSeq *pColl = sqlite3ExprCollSeq(pSubst->pParse,
3842 pSubst->pCList->a[iColumn].pExpr
drh60b95332021-04-19 15:05:27 +00003843 );
dan879164e2022-10-14 19:30:34 +00003844 if( pNat!=pColl || (pExpr->op!=TK_COLUMN && pExpr->op!=TK_COLLATE) ){
3845 pExpr = sqlite3ExprAddCollateString(pSubst->pParse, pExpr,
3846 (pColl ? pColl->zName : "BINARY")
3847 );
3848 }
dane0866392019-09-09 19:49:42 +00003849 }
drh60b95332021-04-19 15:05:27 +00003850 ExprClearProperty(pExpr, EP_Collate);
dan92ddb3b2016-12-01 19:38:05 +00003851 }
drh50350a12004-02-13 16:22:22 +00003852 }
drh832508b2002-03-02 17:04:07 +00003853 }else{
drh7c1544e2017-05-23 12:44:57 +00003854 if( pExpr->op==TK_IF_NULL_ROW && pExpr->iTable==pSubst->iTable ){
3855 pExpr->iTable = pSubst->iNewTable;
3856 }
drh46967de2017-04-14 12:39:37 +00003857 pExpr->pLeft = substExpr(pSubst, pExpr->pLeft);
3858 pExpr->pRight = substExpr(pSubst, pExpr->pRight);
drha4eeccd2021-10-07 17:43:30 +00003859 if( ExprUseXSelect(pExpr) ){
drh46967de2017-04-14 12:39:37 +00003860 substSelect(pSubst, pExpr->x.pSelect, 1);
danielk19776ab3a2e2009-02-19 14:39:25 +00003861 }else{
drh46967de2017-04-14 12:39:37 +00003862 substExprList(pSubst, pExpr->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +00003863 }
dan3703edf2019-10-10 15:17:09 +00003864#ifndef SQLITE_OMIT_WINDOWFUNC
3865 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3866 Window *pWin = pExpr->y.pWin;
3867 pWin->pFilter = substExpr(pSubst, pWin->pFilter);
3868 substExprList(pSubst, pWin->pPartition);
3869 substExprList(pSubst, pWin->pOrderBy);
3870 }
3871#endif
drh832508b2002-03-02 17:04:07 +00003872 }
drhb7916a72009-05-27 10:31:29 +00003873 return pExpr;
drh832508b2002-03-02 17:04:07 +00003874}
drh17435752007-08-16 04:30:38 +00003875static void substExprList(
drh46967de2017-04-14 12:39:37 +00003876 SubstContext *pSubst, /* Description of the substitution */
3877 ExprList *pList /* List to scan and in which to make substitutes */
drh17435752007-08-16 04:30:38 +00003878){
drh832508b2002-03-02 17:04:07 +00003879 int i;
3880 if( pList==0 ) return;
3881 for(i=0; i<pList->nExpr; i++){
drh46967de2017-04-14 12:39:37 +00003882 pList->a[i].pExpr = substExpr(pSubst, pList->a[i].pExpr);
drh832508b2002-03-02 17:04:07 +00003883 }
3884}
drh17435752007-08-16 04:30:38 +00003885static void substSelect(
drh46967de2017-04-14 12:39:37 +00003886 SubstContext *pSubst, /* Description of the substitution */
3887 Select *p, /* SELECT statement in which to make substitutions */
3888 int doPrior /* Do substitutes on p->pPrior too */
drh17435752007-08-16 04:30:38 +00003889){
drh588a9a12008-09-01 15:52:10 +00003890 SrcList *pSrc;
drh76012942021-02-21 21:04:54 +00003891 SrcItem *pItem;
drh588a9a12008-09-01 15:52:10 +00003892 int i;
danielk1977b3bce662005-01-29 08:32:43 +00003893 if( !p ) return;
drhd12b6362015-10-11 19:46:59 +00003894 do{
drh46967de2017-04-14 12:39:37 +00003895 substExprList(pSubst, p->pEList);
3896 substExprList(pSubst, p->pGroupBy);
3897 substExprList(pSubst, p->pOrderBy);
3898 p->pHaving = substExpr(pSubst, p->pHaving);
3899 p->pWhere = substExpr(pSubst, p->pWhere);
drhd12b6362015-10-11 19:46:59 +00003900 pSrc = p->pSrc;
drh29064902015-10-11 20:08:31 +00003901 assert( pSrc!=0 );
drh588a9a12008-09-01 15:52:10 +00003902 for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
drh46967de2017-04-14 12:39:37 +00003903 substSelect(pSubst, pItem->pSelect, 1);
drh29064902015-10-11 20:08:31 +00003904 if( pItem->fg.isTabFunc ){
drh46967de2017-04-14 12:39:37 +00003905 substExprList(pSubst, pItem->u1.pFuncArg);
drhd12b6362015-10-11 19:46:59 +00003906 }
drh588a9a12008-09-01 15:52:10 +00003907 }
drhd12b6362015-10-11 19:46:59 +00003908 }while( doPrior && (p = p->pPrior)!=0 );
danielk1977b3bce662005-01-29 08:32:43 +00003909}
shane3514b6f2008-07-22 05:00:55 +00003910#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
drh832508b2002-03-02 17:04:07 +00003911
shane3514b6f2008-07-22 05:00:55 +00003912#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh832508b2002-03-02 17:04:07 +00003913/*
drh2aee5142020-03-21 00:05:53 +00003914** pSelect is a SELECT statement and pSrcItem is one item in the FROM
3915** clause of that SELECT.
3916**
3917** This routine scans the entire SELECT statement and recomputes the
3918** pSrcItem->colUsed mask.
3919*/
3920static int recomputeColumnsUsedExpr(Walker *pWalker, Expr *pExpr){
drh76012942021-02-21 21:04:54 +00003921 SrcItem *pItem;
drh2aee5142020-03-21 00:05:53 +00003922 if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
3923 pItem = pWalker->u.pSrcItem;
3924 if( pItem->iCursor!=pExpr->iTable ) return WRC_Continue;
drh74a07982020-03-21 23:10:38 +00003925 if( pExpr->iColumn<0 ) return WRC_Continue;
3926 pItem->colUsed |= sqlite3ExprColUsed(pExpr);
drh2aee5142020-03-21 00:05:53 +00003927 return WRC_Continue;
3928}
3929static void recomputeColumnsUsed(
3930 Select *pSelect, /* The complete SELECT statement */
drh76012942021-02-21 21:04:54 +00003931 SrcItem *pSrcItem /* Which FROM clause item to recompute */
drh2aee5142020-03-21 00:05:53 +00003932){
3933 Walker w;
3934 if( NEVER(pSrcItem->pTab==0) ) return;
3935 memset(&w, 0, sizeof(w));
3936 w.xExprCallback = recomputeColumnsUsedExpr;
3937 w.xSelectCallback = sqlite3SelectWalkNoop;
3938 w.u.pSrcItem = pSrcItem;
3939 pSrcItem->colUsed = 0;
3940 sqlite3WalkSelect(&w, pSelect);
3941}
3942#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3943
3944#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3945/*
dan964fa262020-12-18 16:13:39 +00003946** Assign new cursor numbers to each of the items in pSrc. For each
3947** new cursor number assigned, set an entry in the aCsrMap[] array
3948** to map the old cursor number to the new:
3949**
drhc8d21472021-07-21 15:42:05 +00003950** aCsrMap[iOld+1] = iNew;
dan964fa262020-12-18 16:13:39 +00003951**
3952** The array is guaranteed by the caller to be large enough for all
drhc8d21472021-07-21 15:42:05 +00003953** existing cursor numbers in pSrc. aCsrMap[0] is the array size.
dan964fa262020-12-18 16:13:39 +00003954**
3955** If pSrc contains any sub-selects, call this routine recursively
3956** on the FROM clause of each such sub-select, with iExcept set to -1.
3957*/
3958static void srclistRenumberCursors(
3959 Parse *pParse, /* Parse context */
3960 int *aCsrMap, /* Array to store cursor mappings in */
3961 SrcList *pSrc, /* FROM clause to renumber */
3962 int iExcept /* FROM clause item to skip */
3963){
3964 int i;
drh76012942021-02-21 21:04:54 +00003965 SrcItem *pItem;
dan964fa262020-12-18 16:13:39 +00003966 for(i=0, pItem=pSrc->a; i<pSrc->nSrc; i++, pItem++){
3967 if( i!=iExcept ){
dand131b512020-12-18 18:04:44 +00003968 Select *p;
drhc8d21472021-07-21 15:42:05 +00003969 assert( pItem->iCursor < aCsrMap[0] );
3970 if( !pItem->fg.isRecursive || aCsrMap[pItem->iCursor+1]==0 ){
3971 aCsrMap[pItem->iCursor+1] = pParse->nTab++;
drhc7f50772021-04-26 21:23:01 +00003972 }
drhc8d21472021-07-21 15:42:05 +00003973 pItem->iCursor = aCsrMap[pItem->iCursor+1];
dand131b512020-12-18 18:04:44 +00003974 for(p=pItem->pSelect; p; p=p->pPrior){
3975 srclistRenumberCursors(pParse, aCsrMap, p->pSrc, -1);
dan964fa262020-12-18 16:13:39 +00003976 }
3977 }
3978 }
3979}
3980
3981/*
drhc8d21472021-07-21 15:42:05 +00003982** *piCursor is a cursor number. Change it if it needs to be mapped.
3983*/
3984static void renumberCursorDoMapping(Walker *pWalker, int *piCursor){
3985 int *aCsrMap = pWalker->u.aiCol;
3986 int iCsr = *piCursor;
3987 if( iCsr < aCsrMap[0] && aCsrMap[iCsr+1]>0 ){
3988 *piCursor = aCsrMap[iCsr+1];
3989 }
3990}
3991
3992/*
dan964fa262020-12-18 16:13:39 +00003993** Expression walker callback used by renumberCursors() to update
3994** Expr objects to match newly assigned cursor numbers.
3995*/
3996static int renumberCursorsCb(Walker *pWalker, Expr *pExpr){
dane8f14902021-02-13 14:26:25 +00003997 int op = pExpr->op;
drhc8d21472021-07-21 15:42:05 +00003998 if( op==TK_COLUMN || op==TK_IF_NULL_ROW ){
3999 renumberCursorDoMapping(pWalker, &pExpr->iTable);
dan964fa262020-12-18 16:13:39 +00004000 }
drh67a99db2022-05-13 14:52:04 +00004001 if( ExprHasProperty(pExpr, EP_OuterON) ){
drhd1985262022-04-11 11:25:28 +00004002 renumberCursorDoMapping(pWalker, &pExpr->w.iJoin);
dan961a7262020-12-21 19:50:10 +00004003 }
dan964fa262020-12-18 16:13:39 +00004004 return WRC_Continue;
4005}
4006
4007/*
4008** Assign a new cursor number to each cursor in the FROM clause (Select.pSrc)
4009** of the SELECT statement passed as the second argument, and to each
4010** cursor in the FROM clause of any FROM clause sub-selects, recursively.
4011** Except, do not assign a new cursor number to the iExcept'th element in
4012** the FROM clause of (*p). Update all expressions and other references
4013** to refer to the new cursor numbers.
4014**
4015** Argument aCsrMap is an array that may be used for temporary working
4016** space. Two guarantees are made by the caller:
4017**
4018** * the array is larger than the largest cursor number used within the
4019** select statement passed as an argument, and
4020**
4021** * the array entries for all cursor numbers that do *not* appear in
4022** FROM clauses of the select statement as described above are
4023** initialized to zero.
4024*/
4025static void renumberCursors(
4026 Parse *pParse, /* Parse context */
4027 Select *p, /* Select to renumber cursors within */
4028 int iExcept, /* FROM clause item to skip */
4029 int *aCsrMap /* Working space */
4030){
4031 Walker w;
4032 srclistRenumberCursors(pParse, aCsrMap, p->pSrc, iExcept);
4033 memset(&w, 0, sizeof(w));
4034 w.u.aiCol = aCsrMap;
4035 w.xExprCallback = renumberCursorsCb;
4036 w.xSelectCallback = sqlite3SelectWalkNoop;
4037 sqlite3WalkSelect(&w, p);
4038}
4039#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4040
dan879164e2022-10-14 19:30:34 +00004041/*
4042** If pSel is not part of a compound SELECT, return a pointer to its
4043** expression list. Otherwise, return a pointer to the expression list
4044** of the leftmost SELECT in the compound.
4045*/
4046static ExprList *findLeftmostExprlist(Select *pSel){
4047 while( pSel->pPrior ){
4048 pSel = pSel->pPrior;
4049 }
4050 return pSel->pEList;
4051}
4052
dan964fa262020-12-18 16:13:39 +00004053#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4054/*
drh630d2962011-12-11 21:51:04 +00004055** This routine attempts to flatten subqueries as a performance optimization.
4056** This routine returns 1 if it makes changes and 0 if no flattening occurs.
drh1350b032002-02-27 19:00:20 +00004057**
4058** To understand the concept of flattening, consider the following
4059** query:
4060**
4061** SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
4062**
4063** The default way of implementing this query is to execute the
4064** subquery first and store the results in a temporary table, then
4065** run the outer query on that temporary table. This requires two
4066** passes over the data. Furthermore, because the temporary table
4067** has no indices, the WHERE clause on the outer query cannot be
drh832508b2002-03-02 17:04:07 +00004068** optimized.
drh1350b032002-02-27 19:00:20 +00004069**
drh832508b2002-03-02 17:04:07 +00004070** This routine attempts to rewrite queries such as the above into
drh1350b032002-02-27 19:00:20 +00004071** a single flat select, like this:
4072**
4073** SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
4074**
peter.d.reid60ec9142014-09-06 16:39:46 +00004075** The code generated for this simplification gives the same result
drh832508b2002-03-02 17:04:07 +00004076** but only has to scan the data once. And because indices might
4077** exist on the table t1, a complete scan of the data might be
4078** avoided.
drh1350b032002-02-27 19:00:20 +00004079**
drhd981e822017-09-29 16:07:56 +00004080** Flattening is subject to the following constraints:
drh1350b032002-02-27 19:00:20 +00004081**
drh25c221e2017-09-29 22:13:24 +00004082** (**) We no longer attempt to flatten aggregate subqueries. Was:
4083** The subquery and the outer query cannot both be aggregates.
drh1350b032002-02-27 19:00:20 +00004084**
drh25c221e2017-09-29 22:13:24 +00004085** (**) We no longer attempt to flatten aggregate subqueries. Was:
4086** (2) If the subquery is an aggregate then
drhd981e822017-09-29 16:07:56 +00004087** (2a) the outer query must not be a join and
4088** (2b) the outer query must not use subqueries
4089** other than the one FROM-clause subquery that is a candidate
4090** for flattening. (This is due to ticket [2f7170d73bf9abf80]
4091** from 2015-02-09.)
drh832508b2002-03-02 17:04:07 +00004092**
drhd981e822017-09-29 16:07:56 +00004093** (3) If the subquery is the right operand of a LEFT JOIN then
4094** (3a) the subquery may not be a join and
4095** (3b) the FROM clause of the subquery may not contain a virtual
4096** table and
drhee373022022-07-25 15:54:23 +00004097** (**) Was: "The outer query may not have a GROUP BY." This case
4098** is now managed correctly
drh396afe62019-12-18 20:51:58 +00004099** (3d) the outer query may not be DISTINCT.
drh41798d52022-04-11 00:21:53 +00004100** See also (26) for restrictions on RIGHT JOIN.
drh832508b2002-03-02 17:04:07 +00004101**
drhd981e822017-09-29 16:07:56 +00004102** (4) The subquery can not be DISTINCT.
drh832508b2002-03-02 17:04:07 +00004103**
dan49ad3302010-08-13 16:38:48 +00004104** (**) At one point restrictions (4) and (5) defined a subset of DISTINCT
4105** sub-queries that were excluded from this optimization. Restriction
4106** (4) has since been expanded to exclude all DISTINCT subqueries.
drh832508b2002-03-02 17:04:07 +00004107**
drh25c221e2017-09-29 22:13:24 +00004108** (**) We no longer attempt to flatten aggregate subqueries. Was:
4109** If the subquery is aggregate, the outer query may not be DISTINCT.
drh832508b2002-03-02 17:04:07 +00004110**
drhd981e822017-09-29 16:07:56 +00004111** (7) The subquery must have a FROM clause. TODO: For subqueries without
drh31d6fd52017-04-14 19:03:10 +00004112** A FROM clause, consider adding a FROM clause with the special
drh630d2962011-12-11 21:51:04 +00004113** table sqlite_once that consists of a single row containing a
4114** single NULL.
drh08192d52002-04-30 19:20:28 +00004115**
drhd981e822017-09-29 16:07:56 +00004116** (8) If the subquery uses LIMIT then the outer query may not be a join.
drhdf199a22002-06-14 22:38:41 +00004117**
drhd981e822017-09-29 16:07:56 +00004118** (9) If the subquery uses LIMIT then the outer query may not be aggregate.
drhdf199a22002-06-14 22:38:41 +00004119**
drh6092d2b2014-09-15 11:14:50 +00004120** (**) Restriction (10) was removed from the code on 2005-02-05 but we
4121** accidently carried the comment forward until 2014-09-15. Original
drhd981e822017-09-29 16:07:56 +00004122** constraint: "If the subquery is aggregate then the outer query
4123** may not use LIMIT."
drhdf199a22002-06-14 22:38:41 +00004124**
drhd981e822017-09-29 16:07:56 +00004125** (11) The subquery and the outer query may not both have ORDER BY clauses.
drh174b6192002-12-03 02:22:52 +00004126**
drh7b688ed2009-12-22 00:29:53 +00004127** (**) Not implemented. Subsumed into restriction (3). Was previously
drh2b300d52008-08-14 00:19:48 +00004128** a separate restriction deriving from ticket #350.
drh3fc673e2003-06-16 00:40:34 +00004129**
drhd981e822017-09-29 16:07:56 +00004130** (13) The subquery and outer query may not both use LIMIT.
drhac839632006-01-21 22:19:54 +00004131**
drhd981e822017-09-29 16:07:56 +00004132** (14) The subquery may not use OFFSET.
drhac839632006-01-21 22:19:54 +00004133**
drhd981e822017-09-29 16:07:56 +00004134** (15) If the outer query is part of a compound select, then the
4135** subquery may not use LIMIT.
drhf3913272010-04-15 23:24:29 +00004136** (See ticket #2339 and ticket [02a8e81d44]).
drhad91c6c2007-05-06 20:04:24 +00004137**
drhd981e822017-09-29 16:07:56 +00004138** (16) If the outer query is aggregate, then the subquery may not
4139** use ORDER BY. (Ticket #2942) This used to not matter
drhc52e3552008-02-15 14:33:03 +00004140** until we introduced the group_concat() function.
4141**
drhd981e822017-09-29 16:07:56 +00004142** (17) If the subquery is a compound select, then
4143** (17a) all compound operators must be a UNION ALL, and
4144** (17b) no terms within the subquery compound may be aggregate
drhe76acc62017-10-04 02:30:45 +00004145** or DISTINCT, and
drhd981e822017-09-29 16:07:56 +00004146** (17c) every term within the subquery compound must have a FROM clause
4147** (17d) the outer query may not be
4148** (17d1) aggregate, or
dan8daf5ae2020-12-17 16:48:04 +00004149** (17d2) DISTINCT
4150** (17e) the subquery may not contain window functions, and
4151** (17f) the subquery must not be the RHS of a LEFT JOIN.
drhb88bf862022-07-13 15:52:15 +00004152** (17g) either the subquery is the first element of the outer
4153** query or there are no RIGHT or FULL JOINs in any arm
4154** of the subquery. (This is a duplicate of condition (27b).)
drhb6d91672022-11-01 01:07:29 +00004155** (17h) The corresponding result set expressions in all arms of the
4156** compound must have the same affinity.
danielk1977f23329a2008-07-01 14:09:13 +00004157**
danielk19774914cf92008-07-01 18:26:49 +00004158** The parent and sub-query may contain WHERE clauses. Subject to
4159** rules (11), (13) and (14), they may also contain ORDER BY,
drh630d2962011-12-11 21:51:04 +00004160** LIMIT and OFFSET clauses. The subquery cannot use any compound
4161** operator other than UNION ALL because all the other compound
4162** operators have an implied DISTINCT which is disallowed by
4163** restriction (4).
danielk1977f23329a2008-07-01 14:09:13 +00004164**
dan67c70142012-08-28 14:45:50 +00004165** Also, each component of the sub-query must return the same number
4166** of result columns. This is actually a requirement for any compound
4167** SELECT statement, but all the code here does is make sure that no
4168** such (illegal) sub-query is flattened. The caller will detect the
4169** syntax error and return a detailed message.
4170**
danielk197749fc1f62008-07-08 17:43:56 +00004171** (18) If the sub-query is a compound select, then all terms of the
dan9353bea2020-12-17 17:17:12 +00004172** ORDER BY clause of the parent must be copies of a term returned
4173** by the parent query.
danielk197749fc1f62008-07-08 17:43:56 +00004174**
drhd981e822017-09-29 16:07:56 +00004175** (19) If the subquery uses LIMIT then the outer query may not
drh229cf702008-08-26 12:56:14 +00004176** have a WHERE clause.
4177**
drhfca23552017-10-28 20:51:54 +00004178** (20) If the sub-query is a compound select, then it must not use
4179** an ORDER BY clause. Ticket #3773. We could relax this constraint
4180** somewhat by saying that the terms of the ORDER BY clause must
4181** appear as unmodified result columns in the outer query. But we
4182** have other optimizations in mind to deal with that case.
drhe8902a72009-04-02 16:59:47 +00004183**
drhd981e822017-09-29 16:07:56 +00004184** (21) If the subquery uses LIMIT then the outer query may not be
shaneha91491e2011-02-11 20:52:20 +00004185** DISTINCT. (See ticket [752e1646fc]).
4186**
drhd981e822017-09-29 16:07:56 +00004187** (22) The subquery may not be a recursive CTE.
dan8290c2a2014-01-16 10:58:39 +00004188**
dan8daf5ae2020-12-17 16:48:04 +00004189** (23) If the outer query is a recursive CTE, then the sub-query may not be
4190** a compound query. This restriction is because transforming the
dan8290c2a2014-01-16 10:58:39 +00004191** parent to a compound query confuses the code that handles
4192** recursive queries in multiSelect().
4193**
drh508e2d02017-09-30 01:25:04 +00004194** (**) We no longer attempt to flatten aggregate subqueries. Was:
4195** The subquery may not be an aggregate that uses the built-in min() or
drh9588ad92014-09-15 14:46:02 +00004196** or max() functions. (Without this restriction, a query like:
4197** "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
4198** return the value X for which Y was maximal.)
4199**
dan9a947222018-06-14 19:06:36 +00004200** (25) If either the subquery or the parent query contains a window
4201** function in the select list or ORDER BY clause, flattening
4202** is not attempted.
4203**
drh41798d52022-04-11 00:21:53 +00004204** (26) The subquery may not be the right operand of a RIGHT JOIN.
4205** See also (3) for restrictions on LEFT JOIN.
4206**
drh1c2bf412022-04-18 23:20:02 +00004207** (27) The subquery may not contain a FULL or RIGHT JOIN unless it
drhb22b4932022-09-19 19:25:15 +00004208** is the first element of the parent query. Two subcases:
4209** (27a) the subquery is not a compound query.
drhb88bf862022-07-13 15:52:15 +00004210** (27b) the subquery is a compound query and the RIGHT JOIN occurs
4211** in any arm of the compound query. (See also (17g).)
drh1c2bf412022-04-18 23:20:02 +00004212**
drh67f70be2022-04-22 16:15:48 +00004213** (28) The subquery is not a MATERIALIZED CTE.
4214**
dan8290c2a2014-01-16 10:58:39 +00004215**
drh832508b2002-03-02 17:04:07 +00004216** In this routine, the "p" parameter is a pointer to the outer query.
4217** The subquery is p->pSrc->a[iFrom]. isAgg is true if the outer query
drh25c221e2017-09-29 22:13:24 +00004218** uses aggregates.
drh832508b2002-03-02 17:04:07 +00004219**
drh665de472003-03-31 13:36:09 +00004220** If flattening is not attempted, this routine is a no-op and returns 0.
drh832508b2002-03-02 17:04:07 +00004221** If flattening is attempted this routine returns 1.
4222**
4223** All of the expression analysis must occur on both the outer query and
4224** the subquery before this routine runs.
drh1350b032002-02-27 19:00:20 +00004225*/
drh8c74a8c2002-08-25 19:20:40 +00004226static int flattenSubquery(
danielk1977524cc212008-07-02 13:13:51 +00004227 Parse *pParse, /* Parsing context */
drh8c74a8c2002-08-25 19:20:40 +00004228 Select *p, /* The parent or outer SELECT statement */
4229 int iFrom, /* Index in p->pSrc->a[] of the inner subquery */
drh25c221e2017-09-29 22:13:24 +00004230 int isAgg /* True if outer SELECT uses aggregate functions */
drh8c74a8c2002-08-25 19:20:40 +00004231){
danielk1977524cc212008-07-02 13:13:51 +00004232 const char *zSavedAuthContext = pParse->zAuthContext;
drhd12b6362015-10-11 19:46:59 +00004233 Select *pParent; /* Current UNION ALL term of the other query */
drh0bb28102002-05-08 11:54:14 +00004234 Select *pSub; /* The inner query or "subquery" */
danielk1977f23329a2008-07-01 14:09:13 +00004235 Select *pSub1; /* Pointer to the rightmost select in sub-query */
drhad3cab52002-05-24 02:04:32 +00004236 SrcList *pSrc; /* The FROM clause of the outer query */
4237 SrcList *pSubSrc; /* The FROM clause of the subquery */
drh6a3ea0e2003-05-02 14:32:12 +00004238 int iParent; /* VDBE cursor number of the pSub result set temp table */
drh399c7e22017-04-14 17:18:45 +00004239 int iNewParent = -1;/* Replacement table for iParent */
drhc133bab2022-04-11 20:15:52 +00004240 int isOuterJoin = 0; /* True if pSub is the right side of a LEFT JOIN */
drh91bb0ee2004-09-01 03:06:34 +00004241 int i; /* Loop counter */
4242 Expr *pWhere; /* The WHERE clause */
drh76012942021-02-21 21:04:54 +00004243 SrcItem *pSubitem; /* The subquery */
danielk1977524cc212008-07-02 13:13:51 +00004244 sqlite3 *db = pParse->db;
drh89636622020-06-07 17:33:18 +00004245 Walker w; /* Walker to persist agginfo data */
dan964fa262020-12-18 16:13:39 +00004246 int *aCsrMap = 0;
drh1350b032002-02-27 19:00:20 +00004247
drh832508b2002-03-02 17:04:07 +00004248 /* Check to see if flattening is permitted. Return 0 if not.
4249 */
drha78c22c2008-11-11 18:28:58 +00004250 assert( p!=0 );
drhd981e822017-09-29 16:07:56 +00004251 assert( p->pPrior==0 );
drh7e5418e2012-09-27 15:05:54 +00004252 if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
drh832508b2002-03-02 17:04:07 +00004253 pSrc = p->pSrc;
drhad3cab52002-05-24 02:04:32 +00004254 assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
drh91bb0ee2004-09-01 03:06:34 +00004255 pSubitem = &pSrc->a[iFrom];
danielk197749fc1f62008-07-08 17:43:56 +00004256 iParent = pSubitem->iCursor;
drh91bb0ee2004-09-01 03:06:34 +00004257 pSub = pSubitem->pSelect;
drh832508b2002-03-02 17:04:07 +00004258 assert( pSub!=0 );
drh399c7e22017-04-14 17:18:45 +00004259
dan67a9b8e2018-06-22 20:51:35 +00004260#ifndef SQLITE_OMIT_WINDOWFUNC
dan9a947222018-06-14 19:06:36 +00004261 if( p->pWin || pSub->pWin ) return 0; /* Restriction (25) */
dan67a9b8e2018-06-22 20:51:35 +00004262#endif
dan86fb6e12018-05-16 20:58:07 +00004263
drh832508b2002-03-02 17:04:07 +00004264 pSubSrc = pSub->pSrc;
4265 assert( pSubSrc );
drhac839632006-01-21 22:19:54 +00004266 /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
peter.d.reid60ec9142014-09-06 16:39:46 +00004267 ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
drhac839632006-01-21 22:19:54 +00004268 ** because they could be computed at compile-time. But when LIMIT and OFFSET
4269 ** became arbitrary expressions, we were forced to add restrictions (13)
4270 ** and (14). */
4271 if( pSub->pLimit && p->pLimit ) return 0; /* Restriction (13) */
drh8c0833f2017-11-14 23:48:23 +00004272 if( pSub->pLimit && pSub->pLimit->pRight ) return 0; /* Restriction (14) */
drhd227a292014-02-09 18:02:09 +00004273 if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
drhad91c6c2007-05-06 20:04:24 +00004274 return 0; /* Restriction (15) */
4275 }
drhac839632006-01-21 22:19:54 +00004276 if( pSubSrc->nSrc==0 ) return 0; /* Restriction (7) */
drhd981e822017-09-29 16:07:56 +00004277 if( pSub->selFlags & SF_Distinct ) return 0; /* Restriction (4) */
dan49ad3302010-08-13 16:38:48 +00004278 if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
4279 return 0; /* Restrictions (8)(9) */
drhdf199a22002-06-14 22:38:41 +00004280 }
drh7d10d5a2008-08-20 16:35:10 +00004281 if( p->pOrderBy && pSub->pOrderBy ){
drhac839632006-01-21 22:19:54 +00004282 return 0; /* Restriction (11) */
4283 }
drhc52e3552008-02-15 14:33:03 +00004284 if( isAgg && pSub->pOrderBy ) return 0; /* Restriction (16) */
drh229cf702008-08-26 12:56:14 +00004285 if( pSub->pLimit && p->pWhere ) return 0; /* Restriction (19) */
shaneha91491e2011-02-11 20:52:20 +00004286 if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
4287 return 0; /* Restriction (21) */
4288 }
drh508e2d02017-09-30 01:25:04 +00004289 if( pSub->selFlags & (SF_Recursive) ){
4290 return 0; /* Restrictions (22) */
drh9588ad92014-09-15 14:46:02 +00004291 }
drh832508b2002-03-02 17:04:07 +00004292
drh399c7e22017-04-14 17:18:45 +00004293 /*
4294 ** If the subquery is the right operand of a LEFT JOIN, then the
drhd981e822017-09-29 16:07:56 +00004295 ** subquery may not be a join itself (3a). Example of why this is not
4296 ** allowed:
drh8af4d3a2003-05-06 20:35:16 +00004297 **
4298 ** t1 LEFT OUTER JOIN (t2 JOIN t3)
4299 **
4300 ** If we flatten the above, we would get
4301 **
4302 ** (t1 LEFT OUTER JOIN t2) JOIN t3
4303 **
4304 ** which is not at all the same thing.
drh2b300d52008-08-14 00:19:48 +00004305 **
drh31d6fd52017-04-14 19:03:10 +00004306 ** See also tickets #306, #350, and #3300.
drh3fc673e2003-06-16 00:40:34 +00004307 */
drhc133bab2022-04-11 20:15:52 +00004308 if( (pSubitem->fg.jointype & (JT_OUTER|JT_LTORJ))!=0 ){
drh41798d52022-04-11 00:21:53 +00004309 if( pSubSrc->nSrc>1 /* (3a) */
drh9efc6182022-06-23 12:36:56 +00004310 || IsVirtual(pSubSrc->a[0].pTab) /* (3b) */
drh41798d52022-04-11 00:21:53 +00004311 || (p->selFlags & SF_Distinct)!=0 /* (3d) */
4312 || (pSubitem->fg.jointype & JT_RIGHT)!=0 /* (26) */
drh396afe62019-12-18 20:51:58 +00004313 ){
drhd981e822017-09-29 16:07:56 +00004314 return 0;
drh399c7e22017-04-14 17:18:45 +00004315 }
drhc133bab2022-04-11 20:15:52 +00004316 isOuterJoin = 1;
drh3fc673e2003-06-16 00:40:34 +00004317 }
4318
drh1c2bf412022-04-18 23:20:02 +00004319 assert( pSubSrc->nSrc>0 ); /* True by restriction (7) */
4320 if( iFrom>0 && (pSubSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
drhb88bf862022-07-13 15:52:15 +00004321 return 0; /* Restriction (27a) */
drh1c2bf412022-04-18 23:20:02 +00004322 }
drh67f70be2022-04-22 16:15:48 +00004323 if( pSubitem->fg.isCte && pSubitem->u2.pCteUse->eM10d==M10d_Yes ){
4324 return 0; /* (28) */
4325 }
drh1c2bf412022-04-18 23:20:02 +00004326
drhd981e822017-09-29 16:07:56 +00004327 /* Restriction (17): If the sub-query is a compound SELECT, then it must
danielk1977f23329a2008-07-01 14:09:13 +00004328 ** use only the UNION ALL operator. And none of the simple select queries
4329 ** that make up the compound SELECT are allowed to be aggregate or distinct
4330 ** queries.
4331 */
4332 if( pSub->pPrior ){
drhb6d91672022-11-01 01:07:29 +00004333 int ii;
drhfca23552017-10-28 20:51:54 +00004334 if( pSub->pOrderBy ){
4335 return 0; /* Restriction (20) */
4336 }
drhc133bab2022-04-11 20:15:52 +00004337 if( isAgg || (p->selFlags & SF_Distinct)!=0 || isOuterJoin>0 ){
dan8daf5ae2020-12-17 16:48:04 +00004338 return 0; /* (17d1), (17d2), or (17f) */
danielk1977f23329a2008-07-01 14:09:13 +00004339 }
4340 for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
drhccfcbce2009-05-18 15:46:07 +00004341 testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
4342 testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
drh4b3ac732011-12-10 23:18:32 +00004343 assert( pSub->pSrc!=0 );
dan8daf5ae2020-12-17 16:48:04 +00004344 assert( (pSub->selFlags & SF_Recursive)==0 );
drh2ec18a32015-06-23 23:31:52 +00004345 assert( pSub->pEList->nExpr==pSub1->pEList->nExpr );
drhd981e822017-09-29 16:07:56 +00004346 if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0 /* (17b) */
4347 || (pSub1->pPrior && pSub1->op!=TK_ALL) /* (17a) */
4348 || pSub1->pSrc->nSrc<1 /* (17c) */
drhef9f7192020-01-17 19:14:08 +00004349#ifndef SQLITE_OMIT_WINDOWFUNC
drh8d95ed72019-12-30 20:42:17 +00004350 || pSub1->pWin /* (17e) */
drhef9f7192020-01-17 19:14:08 +00004351#endif
danielk197780b3c542008-07-10 17:59:12 +00004352 ){
danielk1977f23329a2008-07-01 14:09:13 +00004353 return 0;
4354 }
drhb88bf862022-07-13 15:52:15 +00004355 if( iFrom>0 && (pSub1->pSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
4356 /* Without this restriction, the JT_LTORJ flag would end up being
4357 ** omitted on left-hand tables of the right join that is being
4358 ** flattened. */
4359 return 0; /* Restrictions (17g), (27b) */
4360 }
drh4b3ac732011-12-10 23:18:32 +00004361 testcase( pSub1->pSrc->nSrc>1 );
danielk1977f23329a2008-07-01 14:09:13 +00004362 }
danielk197749fc1f62008-07-08 17:43:56 +00004363
drhd981e822017-09-29 16:07:56 +00004364 /* Restriction (18). */
danielk197749fc1f62008-07-08 17:43:56 +00004365 if( p->pOrderBy ){
danielk197749fc1f62008-07-08 17:43:56 +00004366 for(ii=0; ii<p->pOrderBy->nExpr; ii++){
drhc2acc4e2013-11-15 18:15:19 +00004367 if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
danielk197749fc1f62008-07-08 17:43:56 +00004368 }
4369 }
danielk1977f23329a2008-07-01 14:09:13 +00004370
dande9ed622020-12-16 20:00:46 +00004371 /* Restriction (23) */
4372 if( (p->selFlags & SF_Recursive) ) return 0;
dan964fa262020-12-18 16:13:39 +00004373
drhb6d91672022-11-01 01:07:29 +00004374 /* Restriction (17h) */
4375 for(ii=0; ii<pSub->pEList->nExpr; ii++){
4376 char aff;
4377 assert( pSub->pEList->a[ii].pExpr!=0 );
4378 aff = sqlite3ExprAffinity(pSub->pEList->a[ii].pExpr);
4379 for(pSub1=pSub->pPrior; pSub1; pSub1=pSub1->pPrior){
4380 assert( pSub1->pEList!=0 );
4381 assert( pSub1->pEList->nExpr>ii );
4382 assert( pSub1->pEList->a[ii].pExpr!=0 );
4383 if( sqlite3ExprAffinity(pSub1->pEList->a[ii].pExpr)!=aff ){
4384 return 0;
4385 }
4386 }
4387 }
4388
dan964fa262020-12-18 16:13:39 +00004389 if( pSrc->nSrc>1 ){
dan51ddfef2021-03-17 14:29:37 +00004390 if( pParse->nSelect>500 ) return 0;
drh95fe38f2022-04-25 14:59:59 +00004391 if( OptimizationDisabled(db, SQLITE_FlttnUnionAll) ) return 0;
drh913306a2021-11-26 17:10:18 +00004392 aCsrMap = sqlite3DbMallocZero(db, ((i64)pParse->nTab+1)*sizeof(int));
drhc8d21472021-07-21 15:42:05 +00004393 if( aCsrMap ) aCsrMap[0] = pParse->nTab;
dan964fa262020-12-18 16:13:39 +00004394 }
dande9ed622020-12-16 20:00:46 +00004395 }
drhcdb2f602017-10-04 05:59:54 +00004396
drh7d10d5a2008-08-20 16:35:10 +00004397 /***** If we reach this point, flattening is permitted. *****/
drh5d7aef12022-11-22 19:49:16 +00004398 TREETRACE(0x4,pParse,p,("flatten %u.%p from term %d\n",
drhfef37762018-07-10 19:48:35 +00004399 pSub->selId, pSub, iFrom));
drh7d10d5a2008-08-20 16:35:10 +00004400
4401 /* Authorize the subquery */
danielk1977524cc212008-07-02 13:13:51 +00004402 pParse->zAuthContext = pSubitem->zName;
drha2acb0d2012-04-11 23:22:37 +00004403 TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
4404 testcase( i==SQLITE_DENY );
danielk1977524cc212008-07-02 13:13:51 +00004405 pParse->zAuthContext = zSavedAuthContext;
4406
dande9ed622020-12-16 20:00:46 +00004407 /* Delete the transient structures associated with thesubquery */
4408 pSub1 = pSubitem->pSelect;
4409 sqlite3DbFree(db, pSubitem->zDatabase);
4410 sqlite3DbFree(db, pSubitem->zName);
4411 sqlite3DbFree(db, pSubitem->zAlias);
4412 pSubitem->zDatabase = 0;
4413 pSubitem->zName = 0;
4414 pSubitem->zAlias = 0;
4415 pSubitem->pSelect = 0;
drhd44f8b22022-04-07 01:11:13 +00004416 assert( pSubitem->fg.isUsing!=0 || pSubitem->u3.pOn==0 );
dande9ed622020-12-16 20:00:46 +00004417
drh7d10d5a2008-08-20 16:35:10 +00004418 /* If the sub-query is a compound SELECT statement, then (by restrictions
4419 ** 17 and 18 above) it must be a UNION ALL and the parent query must
4420 ** be of the form:
danielk1977f23329a2008-07-01 14:09:13 +00004421 **
4422 ** SELECT <expr-list> FROM (<sub-query>) <where-clause>
4423 **
4424 ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
drha78c22c2008-11-11 18:28:58 +00004425 ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
danielk1977f23329a2008-07-01 14:09:13 +00004426 ** OFFSET clauses and joins them to the left-hand-side of the original
4427 ** using UNION ALL operators. In this case N is the number of simple
4428 ** select statements in the compound sub-query.
drha78c22c2008-11-11 18:28:58 +00004429 **
4430 ** Example:
4431 **
4432 ** SELECT a+1 FROM (
4433 ** SELECT x FROM tab
4434 ** UNION ALL
4435 ** SELECT y FROM tab
4436 ** UNION ALL
4437 ** SELECT abs(z*2) FROM tab2
4438 ** ) WHERE a!=5 ORDER BY 1
4439 **
4440 ** Transformed into:
4441 **
4442 ** SELECT x+1 FROM tab WHERE x+1!=5
4443 ** UNION ALL
4444 ** SELECT y+1 FROM tab WHERE y+1!=5
4445 ** UNION ALL
4446 ** SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
4447 ** ORDER BY 1
4448 **
4449 ** We call this the "compound-subquery flattening".
danielk1977f23329a2008-07-01 14:09:13 +00004450 */
4451 for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
4452 Select *pNew;
4453 ExprList *pOrderBy = p->pOrderBy;
danielk19774b86ef12008-07-01 14:39:35 +00004454 Expr *pLimit = p->pLimit;
danielk1977f23329a2008-07-01 14:09:13 +00004455 Select *pPrior = p->pPrior;
dande9ed622020-12-16 20:00:46 +00004456 Table *pItemTab = pSubitem->pTab;
4457 pSubitem->pTab = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004458 p->pOrderBy = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004459 p->pPrior = 0;
danielk19774b86ef12008-07-01 14:39:35 +00004460 p->pLimit = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00004461 pNew = sqlite3SelectDup(db, p, 0);
danielk19774b86ef12008-07-01 14:39:35 +00004462 p->pLimit = pLimit;
drha78c22c2008-11-11 18:28:58 +00004463 p->pOrderBy = pOrderBy;
drha78c22c2008-11-11 18:28:58 +00004464 p->op = TK_ALL;
dande9ed622020-12-16 20:00:46 +00004465 pSubitem->pTab = pItemTab;
drha78c22c2008-11-11 18:28:58 +00004466 if( pNew==0 ){
drhd227a292014-02-09 18:02:09 +00004467 p->pPrior = pPrior;
drha78c22c2008-11-11 18:28:58 +00004468 }else{
dan51ddfef2021-03-17 14:29:37 +00004469 pNew->selId = ++pParse->nSelect;
drh9da977f2021-04-20 12:14:12 +00004470 if( aCsrMap && ALWAYS(db->mallocFailed==0) ){
dan964fa262020-12-18 16:13:39 +00004471 renumberCursors(pParse, pNew, iFrom, aCsrMap);
4472 }
drha78c22c2008-11-11 18:28:58 +00004473 pNew->pPrior = pPrior;
drhd227a292014-02-09 18:02:09 +00004474 if( pPrior ) pPrior->pNext = pNew;
4475 pNew->pNext = p;
4476 p->pPrior = pNew;
drh5d7aef12022-11-22 19:49:16 +00004477 TREETRACE(0x4,pParse,p,("compound-subquery flattener"
drhfef37762018-07-10 19:48:35 +00004478 " creates %u as peer\n",pNew->selId));
drha78c22c2008-11-11 18:28:58 +00004479 }
dande9ed622020-12-16 20:00:46 +00004480 assert( pSubitem->pSelect==0 );
dan964fa262020-12-18 16:13:39 +00004481 }
4482 sqlite3DbFree(db, aCsrMap);
4483 if( db->mallocFailed ){
4484 pSubitem->pSelect = pSub1;
4485 return 1;
danielk1977f23329a2008-07-01 14:09:13 +00004486 }
4487
drha78c22c2008-11-11 18:28:58 +00004488 /* Defer deleting the Table object associated with the
4489 ** subquery until code generation is
4490 ** complete, since there may still exist Expr.pTab entries that
4491 ** refer to the subquery even after flattening. Ticket #3346.
drhccfcbce2009-05-18 15:46:07 +00004492 **
4493 ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
drha78c22c2008-11-11 18:28:58 +00004494 */
drhccfcbce2009-05-18 15:46:07 +00004495 if( ALWAYS(pSubitem->pTab!=0) ){
drha78c22c2008-11-11 18:28:58 +00004496 Table *pTabToDel = pSubitem->pTab;
drh79df7782016-12-14 14:07:35 +00004497 if( pTabToDel->nTabRef==1 ){
dan65a7cd12009-09-01 12:16:01 +00004498 Parse *pToplevel = sqlite3ParseToplevel(pParse);
drhcf3c0782021-01-11 20:37:02 +00004499 sqlite3ParserAddCleanup(pToplevel,
4500 (void(*)(sqlite3*,void*))sqlite3DeleteTable,
4501 pTabToDel);
drh21d4f5b2021-01-12 15:30:01 +00004502 testcase( pToplevel->earlyCleanup );
drha78c22c2008-11-11 18:28:58 +00004503 }else{
drh79df7782016-12-14 14:07:35 +00004504 pTabToDel->nTabRef--;
drha78c22c2008-11-11 18:28:58 +00004505 }
4506 pSubitem->pTab = 0;
4507 }
4508
4509 /* The following loop runs once for each term in a compound-subquery
4510 ** flattening (as described above). If we are doing a different kind
4511 ** of flattening - a flattening other than a compound-subquery flattening -
4512 ** then this loop only runs once.
4513 **
4514 ** This loop moves all of the FROM elements of the subquery into the
4515 ** the FROM clause of the outer query. Before doing this, remember
4516 ** the cursor number for the original outer query FROM element in
4517 ** iParent. The iParent cursor will never be used. Subsequent code
4518 ** will scan expressions looking for iParent references and replace
4519 ** those references with expressions that resolve to the subquery FROM
4520 ** elements we are now copying in.
4521 */
dande9ed622020-12-16 20:00:46 +00004522 pSub = pSub1;
danielk1977f23329a2008-07-01 14:09:13 +00004523 for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
drha78c22c2008-11-11 18:28:58 +00004524 int nSubSrc;
drhea678832008-12-10 19:26:22 +00004525 u8 jointype = 0;
drh79d26582022-04-11 10:38:28 +00004526 u8 ltorj = pSrc->a[iFrom].fg.jointype & JT_LTORJ;
drh55f66b32019-07-16 19:44:32 +00004527 assert( pSub!=0 );
drha78c22c2008-11-11 18:28:58 +00004528 pSubSrc = pSub->pSrc; /* FROM clause of subquery */
4529 nSubSrc = pSubSrc->nSrc; /* Number of terms in subquery FROM clause */
4530 pSrc = pParent->pSrc; /* FROM clause of the outer query */
drhc31c2eb2003-05-02 16:04:17 +00004531
dande9ed622020-12-16 20:00:46 +00004532 if( pParent==p ){
4533 jointype = pSubitem->fg.jointype; /* First time through the loop */
drha78c22c2008-11-11 18:28:58 +00004534 }
dande9ed622020-12-16 20:00:46 +00004535
drha78c22c2008-11-11 18:28:58 +00004536 /* The subquery uses a single slot of the FROM clause of the outer
4537 ** query. If the subquery has more than one element in its FROM clause,
4538 ** then expand the outer query to make space for it to hold all elements
4539 ** of the subquery.
4540 **
4541 ** Example:
4542 **
4543 ** SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
4544 **
4545 ** The outer query has 3 slots in its FROM clause. One slot of the
4546 ** outer query (the middle slot) is used by the subquery. The next
drhd12b6362015-10-11 19:46:59 +00004547 ** block of code will expand the outer query FROM clause to 4 slots.
4548 ** The middle slot is expanded to two slots in order to make space
4549 ** for the two elements in the FROM clause of the subquery.
drha78c22c2008-11-11 18:28:58 +00004550 */
4551 if( nSubSrc>1 ){
drh29c992c2019-01-17 15:40:41 +00004552 pSrc = sqlite3SrcListEnlarge(pParse, pSrc, nSubSrc-1,iFrom+1);
4553 if( pSrc==0 ) break;
4554 pParent->pSrc = pSrc;
drhc31c2eb2003-05-02 16:04:17 +00004555 }
drha78c22c2008-11-11 18:28:58 +00004556
4557 /* Transfer the FROM clause terms from the subquery into the
4558 ** outer query.
4559 */
drhc31c2eb2003-05-02 16:04:17 +00004560 for(i=0; i<nSubSrc; i++){
drhd44f8b22022-04-07 01:11:13 +00004561 SrcItem *pItem = &pSrc->a[i+iFrom];
4562 if( pItem->fg.isUsing ) sqlite3IdListDelete(db, pItem->u3.pUsing);
4563 assert( pItem->fg.isTabFunc==0 );
4564 *pItem = pSubSrc->a[i];
drh79d26582022-04-11 10:38:28 +00004565 pItem->fg.jointype |= ltorj;
drh399c7e22017-04-14 17:18:45 +00004566 iNewParent = pSubSrc->a[i].iCursor;
drhc31c2eb2003-05-02 16:04:17 +00004567 memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
4568 }
drhf7309bc2022-04-12 20:20:54 +00004569 pSrc->a[iFrom].fg.jointype &= JT_LTORJ;
4570 pSrc->a[iFrom].fg.jointype |= jointype | ltorj;
danielk1977f23329a2008-07-01 14:09:13 +00004571
4572 /* Now begin substituting subquery result set expressions for
4573 ** references to the iParent in the outer query.
4574 **
4575 ** Example:
4576 **
4577 ** SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
4578 ** \ \_____________ subquery __________/ /
4579 ** \_____________________ outer query ______________________________/
4580 **
4581 ** We look at every expression in the outer query and every place we see
4582 ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
4583 */
drhb7cbf5c2020-06-15 13:51:34 +00004584 if( pSub->pOrderBy && (pParent->selFlags & SF_NoopOrderBy)==0 ){
dan7c0a4722014-09-20 20:38:48 +00004585 /* At this point, any non-zero iOrderByCol values indicate that the
4586 ** ORDER BY column expression is identical to the iOrderByCol'th
4587 ** expression returned by SELECT statement pSub. Since these values
4588 ** do not necessarily correspond to columns in SELECT statement pParent,
4589 ** zero them before transfering the ORDER BY clause.
4590 **
4591 ** Not doing this may cause an error if a subsequent call to this
4592 ** function attempts to flatten a compound sub-query into pParent
4593 ** (the only way this can happen is if the compound sub-query is
4594 ** currently part of pSub->pSrc). See ticket [d11a6e908f]. */
4595 ExprList *pOrderBy = pSub->pOrderBy;
4596 for(i=0; i<pOrderBy->nExpr; i++){
4597 pOrderBy->a[i].u.x.iOrderByCol = 0;
4598 }
danielk1977f23329a2008-07-01 14:09:13 +00004599 assert( pParent->pOrderBy==0 );
dan7c0a4722014-09-20 20:38:48 +00004600 pParent->pOrderBy = pOrderBy;
danielk1977f23329a2008-07-01 14:09:13 +00004601 pSub->pOrderBy = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004602 }
drh11df7d22018-12-06 19:15:36 +00004603 pWhere = pSub->pWhere;
4604 pSub->pWhere = 0;
drhc133bab2022-04-11 20:15:52 +00004605 if( isOuterJoin>0 ){
drh67a99db2022-05-13 14:52:04 +00004606 sqlite3SetJoinExpr(pWhere, iNewParent, EP_OuterON);
drh399c7e22017-04-14 17:18:45 +00004607 }
dancd653a32020-06-13 21:24:40 +00004608 if( pWhere ){
4609 if( pParent->pWhere ){
4610 pParent->pWhere = sqlite3PExpr(pParse, TK_AND, pWhere, pParent->pWhere);
4611 }else{
4612 pParent->pWhere = pWhere;
4613 }
4614 }
danc3becdd2017-03-13 14:30:40 +00004615 if( db->mallocFailed==0 ){
drh46967de2017-04-14 12:39:37 +00004616 SubstContext x;
4617 x.pParse = pParse;
4618 x.iTable = iParent;
drh399c7e22017-04-14 17:18:45 +00004619 x.iNewTable = iNewParent;
drhc133bab2022-04-11 20:15:52 +00004620 x.isOuterJoin = isOuterJoin;
drh46967de2017-04-14 12:39:37 +00004621 x.pEList = pSub->pEList;
dan879164e2022-10-14 19:30:34 +00004622 x.pCList = findLeftmostExprlist(pSub);
drh46967de2017-04-14 12:39:37 +00004623 substSelect(&x, pParent, 0);
danc3becdd2017-03-13 14:30:40 +00004624 }
danielk1977f23329a2008-07-01 14:09:13 +00004625
drh7cd5e852019-05-29 17:22:38 +00004626 /* The flattened query is a compound if either the inner or the
4627 ** outer query is a compound. */
4628 pParent->selFlags |= pSub->selFlags & SF_Compound;
4629 assert( (pSub->selFlags & SF_Distinct)==0 ); /* restriction (17b) */
danielk1977f23329a2008-07-01 14:09:13 +00004630
4631 /*
4632 ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
4633 **
4634 ** One is tempted to try to add a and b to combine the limits. But this
4635 ** does not work if either limit is negative.
4636 */
4637 if( pSub->pLimit ){
4638 pParent->pLimit = pSub->pLimit;
4639 pSub->pLimit = 0;
4640 }
drh2aee5142020-03-21 00:05:53 +00004641
drh3b880652022-10-19 11:58:24 +00004642 /* Recompute the SrcItem.colUsed masks for the flattened
drh2aee5142020-03-21 00:05:53 +00004643 ** tables. */
4644 for(i=0; i<nSubSrc; i++){
4645 recomputeColumnsUsed(pParent, &pSrc->a[i+iFrom]);
4646 }
drhdf199a22002-06-14 22:38:41 +00004647 }
drh8c74a8c2002-08-25 19:20:40 +00004648
drhc31c2eb2003-05-02 16:04:17 +00004649 /* Finially, delete what is left of the subquery and return
4650 ** success.
4651 */
drh89636622020-06-07 17:33:18 +00004652 sqlite3AggInfoPersistWalkerInit(&w, pParse);
4653 sqlite3WalkSelect(&w,pSub1);
drh633e6d52008-07-28 19:34:53 +00004654 sqlite3SelectDelete(db, pSub1);
danielk1977f23329a2008-07-01 14:09:13 +00004655
drh5e431be2022-04-06 11:08:38 +00004656#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00004657 if( sqlite3TreeTrace & 0x4 ){
4658 TREETRACE(0x4,pParse,p,("After flattening:\n"));
drhc90713d2014-09-30 13:46:49 +00004659 sqlite3TreeViewSelect(0, p, 0);
4660 }
4661#endif
4662
drh832508b2002-03-02 17:04:07 +00004663 return 1;
4664}
shane3514b6f2008-07-22 05:00:55 +00004665#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
drh1350b032002-02-27 19:00:20 +00004666
drh660ee552018-07-26 21:16:53 +00004667/*
drh8e5bfed2018-10-25 14:15:37 +00004668** A structure to keep track of all of the column values that are fixed to
drhefad2e22018-07-27 16:57:11 +00004669** a known value due to WHERE clause constraints of the form COLUMN=VALUE.
drh660ee552018-07-26 21:16:53 +00004670*/
4671typedef struct WhereConst WhereConst;
4672struct WhereConst {
drhefad2e22018-07-27 16:57:11 +00004673 Parse *pParse; /* Parsing context */
drh75016052021-06-10 14:36:23 +00004674 u8 *pOomFault; /* Pointer to pParse->db->mallocFailed */
drh660ee552018-07-26 21:16:53 +00004675 int nConst; /* Number for COLUMN=CONSTANT terms */
4676 int nChng; /* Number of times a constant is propagated */
dan40b82f92021-05-26 18:51:57 +00004677 int bHasAffBlob; /* At least one column in apExpr[] as affinity BLOB */
drhae8776e2022-06-20 12:42:28 +00004678 u32 mExcludeOn; /* Which ON expressions to exclude from considertion.
4679 ** Either EP_OuterON or EP_InnerON|EP_OuterON */
drhefad2e22018-07-27 16:57:11 +00004680 Expr **apExpr; /* [i*2] is COLUMN and [i*2+1] is VALUE */
drh660ee552018-07-26 21:16:53 +00004681};
drh69b72d52015-06-01 20:28:03 +00004682
drh660ee552018-07-26 21:16:53 +00004683/*
drh8e5bfed2018-10-25 14:15:37 +00004684** Add a new entry to the pConst object. Except, do not add duplicate
drhf8f76d62020-01-08 04:36:01 +00004685** pColumn entires. Also, do not add if doing so would not be appropriate.
4686**
4687** The caller guarantees the pColumn is a column and pValue is a constant.
4688** This routine has to do some additional checks before completing the
4689** insert.
drh660ee552018-07-26 21:16:53 +00004690*/
4691static void constInsert(
drhf8f76d62020-01-08 04:36:01 +00004692 WhereConst *pConst, /* The WhereConst into which we are inserting */
4693 Expr *pColumn, /* The COLUMN part of the constraint */
4694 Expr *pValue, /* The VALUE part of the constraint */
4695 Expr *pExpr /* Overall expression: COLUMN=VALUE or VALUE=COLUMN */
drh660ee552018-07-26 21:16:53 +00004696){
drh8e5bfed2018-10-25 14:15:37 +00004697 int i;
4698 assert( pColumn->op==TK_COLUMN );
drhf8f76d62020-01-08 04:36:01 +00004699 assert( sqlite3ExprIsConstant(pValue) );
4700
drhfdfd45a2020-02-13 22:12:35 +00004701 if( ExprHasProperty(pColumn, EP_FixedCol) ) return;
4702 if( sqlite3ExprAffinity(pValue)!=0 ) return;
drhf8f76d62020-01-08 04:36:01 +00004703 if( !sqlite3IsBinary(sqlite3ExprCompareCollSeq(pConst->pParse,pExpr)) ){
4704 return;
4705 }
drh8e5bfed2018-10-25 14:15:37 +00004706
4707 /* 2018-10-25 ticket [cf5ed20f]
4708 ** Make sure the same pColumn is not inserted more than once */
4709 for(i=0; i<pConst->nConst; i++){
drh7be5e3d2020-01-09 20:33:13 +00004710 const Expr *pE2 = pConst->apExpr[i*2];
4711 assert( pE2->op==TK_COLUMN );
4712 if( pE2->iTable==pColumn->iTable
4713 && pE2->iColumn==pColumn->iColumn
drh8e5bfed2018-10-25 14:15:37 +00004714 ){
4715 return; /* Already present. Return without doing anything. */
4716 }
4717 }
dan40b82f92021-05-26 18:51:57 +00004718 if( sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4719 pConst->bHasAffBlob = 1;
4720 }
drh9cbf4f32018-07-27 20:01:00 +00004721
drh660ee552018-07-26 21:16:53 +00004722 pConst->nConst++;
drhefad2e22018-07-27 16:57:11 +00004723 pConst->apExpr = sqlite3DbReallocOrFree(pConst->pParse->db, pConst->apExpr,
drh660ee552018-07-26 21:16:53 +00004724 pConst->nConst*2*sizeof(Expr*));
4725 if( pConst->apExpr==0 ){
4726 pConst->nConst = 0;
4727 }else{
4728 pConst->apExpr[pConst->nConst*2-2] = pColumn;
4729 pConst->apExpr[pConst->nConst*2-1] = pValue;
4730 }
4731}
4732
4733/*
drhefad2e22018-07-27 16:57:11 +00004734** Find all terms of COLUMN=VALUE or VALUE=COLUMN in pExpr where VALUE
4735** is a constant expression and where the term must be true because it
4736** is part of the AND-connected terms of the expression. For each term
4737** found, add it to the pConst structure.
drh660ee552018-07-26 21:16:53 +00004738*/
4739static void findConstInWhere(WhereConst *pConst, Expr *pExpr){
drhefad2e22018-07-27 16:57:11 +00004740 Expr *pRight, *pLeft;
drhb775c972021-05-14 14:26:57 +00004741 if( NEVER(pExpr==0) ) return;
drhae8776e2022-06-20 12:42:28 +00004742 if( ExprHasProperty(pExpr, pConst->mExcludeOn) ){
drh958fcd42022-06-10 11:28:52 +00004743 testcase( ExprHasProperty(pExpr, EP_OuterON) );
4744 testcase( ExprHasProperty(pExpr, EP_InnerON) );
4745 return;
4746 }
drh660ee552018-07-26 21:16:53 +00004747 if( pExpr->op==TK_AND ){
4748 findConstInWhere(pConst, pExpr->pRight);
4749 findConstInWhere(pConst, pExpr->pLeft);
4750 return;
4751 }
4752 if( pExpr->op!=TK_EQ ) return;
drhefad2e22018-07-27 16:57:11 +00004753 pRight = pExpr->pRight;
4754 pLeft = pExpr->pLeft;
4755 assert( pRight!=0 );
4756 assert( pLeft!=0 );
drhf8f76d62020-01-08 04:36:01 +00004757 if( pRight->op==TK_COLUMN && sqlite3ExprIsConstant(pLeft) ){
4758 constInsert(pConst,pRight,pLeft,pExpr);
4759 }
4760 if( pLeft->op==TK_COLUMN && sqlite3ExprIsConstant(pRight) ){
4761 constInsert(pConst,pLeft,pRight,pExpr);
drh660ee552018-07-26 21:16:53 +00004762 }
4763}
4764
4765/*
dan40b82f92021-05-26 18:51:57 +00004766** This is a helper function for Walker callback propagateConstantExprRewrite().
4767**
4768** Argument pExpr is a candidate expression to be replaced by a value. If
4769** pExpr is equivalent to one of the columns named in pWalker->u.pConst,
4770** then overwrite it with the corresponding value. Except, do not do so
4771** if argument bIgnoreAffBlob is non-zero and the affinity of pExpr
4772** is SQLITE_AFF_BLOB.
drh660ee552018-07-26 21:16:53 +00004773*/
dan40b82f92021-05-26 18:51:57 +00004774static int propagateConstantExprRewriteOne(
4775 WhereConst *pConst,
4776 Expr *pExpr,
4777 int bIgnoreAffBlob
4778){
drh660ee552018-07-26 21:16:53 +00004779 int i;
drh75016052021-06-10 14:36:23 +00004780 if( pConst->pOomFault[0] ) return WRC_Prune;
drh660ee552018-07-26 21:16:53 +00004781 if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
drhae8776e2022-06-20 12:42:28 +00004782 if( ExprHasProperty(pExpr, EP_FixedCol|pConst->mExcludeOn) ){
drhbe0330e2020-01-16 17:53:24 +00004783 testcase( ExprHasProperty(pExpr, EP_FixedCol) );
drh67a99db2022-05-13 14:52:04 +00004784 testcase( ExprHasProperty(pExpr, EP_OuterON) );
drhae8776e2022-06-20 12:42:28 +00004785 testcase( ExprHasProperty(pExpr, EP_InnerON) );
drhbe0330e2020-01-16 17:53:24 +00004786 return WRC_Continue;
4787 }
drh660ee552018-07-26 21:16:53 +00004788 for(i=0; i<pConst->nConst; i++){
4789 Expr *pColumn = pConst->apExpr[i*2];
4790 if( pColumn==pExpr ) continue;
4791 if( pColumn->iTable!=pExpr->iTable ) continue;
4792 if( pColumn->iColumn!=pExpr->iColumn ) continue;
dan40b82f92021-05-26 18:51:57 +00004793 if( bIgnoreAffBlob && sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4794 break;
4795 }
drhefad2e22018-07-27 16:57:11 +00004796 /* A match is found. Add the EP_FixedCol property */
drh660ee552018-07-26 21:16:53 +00004797 pConst->nChng++;
4798 ExprClearProperty(pExpr, EP_Leaf);
drhefad2e22018-07-27 16:57:11 +00004799 ExprSetProperty(pExpr, EP_FixedCol);
4800 assert( pExpr->pLeft==0 );
4801 pExpr->pLeft = sqlite3ExprDup(pConst->pParse->db, pConst->apExpr[i*2+1], 0);
drh75016052021-06-10 14:36:23 +00004802 if( pConst->pParse->db->mallocFailed ) return WRC_Prune;
drh660ee552018-07-26 21:16:53 +00004803 break;
4804 }
4805 return WRC_Prune;
4806}
4807
4808/*
dan40b82f92021-05-26 18:51:57 +00004809** This is a Walker expression callback. pExpr is a node from the WHERE
4810** clause of a SELECT statement. This function examines pExpr to see if
4811** any substitutions based on the contents of pWalker->u.pConst should
4812** be made to pExpr or its immediate children.
4813**
4814** A substitution is made if:
4815**
4816** + pExpr is a column with an affinity other than BLOB that matches
4817** one of the columns in pWalker->u.pConst, or
4818**
4819** + pExpr is a binary comparison operator (=, <=, >=, <, >) that
4820** uses an affinity other than TEXT and one of its immediate
4821** children is a column that matches one of the columns in
4822** pWalker->u.pConst.
4823*/
4824static int propagateConstantExprRewrite(Walker *pWalker, Expr *pExpr){
4825 WhereConst *pConst = pWalker->u.pConst;
drha8ed5152021-05-26 19:52:21 +00004826 assert( TK_GT==TK_EQ+1 );
4827 assert( TK_LE==TK_EQ+2 );
4828 assert( TK_LT==TK_EQ+3 );
4829 assert( TK_GE==TK_EQ+4 );
dan40b82f92021-05-26 18:51:57 +00004830 if( pConst->bHasAffBlob ){
drha8ed5152021-05-26 19:52:21 +00004831 if( (pExpr->op>=TK_EQ && pExpr->op<=TK_GE)
dan40b82f92021-05-26 18:51:57 +00004832 || pExpr->op==TK_IS
4833 ){
4834 propagateConstantExprRewriteOne(pConst, pExpr->pLeft, 0);
drh75016052021-06-10 14:36:23 +00004835 if( pConst->pOomFault[0] ) return WRC_Prune;
dan40b82f92021-05-26 18:51:57 +00004836 if( sqlite3ExprAffinity(pExpr->pLeft)!=SQLITE_AFF_TEXT ){
4837 propagateConstantExprRewriteOne(pConst, pExpr->pRight, 0);
4838 }
4839 }
4840 }
4841 return propagateConstantExprRewriteOne(pConst, pExpr, pConst->bHasAffBlob);
4842}
4843
4844/*
drh660ee552018-07-26 21:16:53 +00004845** The WHERE-clause constant propagation optimization.
4846**
4847** If the WHERE clause contains terms of the form COLUMN=CONSTANT or
drh97bffe62020-01-08 00:39:37 +00004848** CONSTANT=COLUMN that are top-level AND-connected terms that are not
4849** part of a ON clause from a LEFT JOIN, then throughout the query
4850** replace all other occurrences of COLUMN with CONSTANT.
drh660ee552018-07-26 21:16:53 +00004851**
4852** For example, the query:
4853**
4854** SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=t1.a AND t3.c=t2.b
4855**
4856** Is transformed into
4857**
4858** SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=39 AND t3.c=39
4859**
4860** Return true if any transformations where made and false if not.
drhefad2e22018-07-27 16:57:11 +00004861**
4862** Implementation note: Constant propagation is tricky due to affinity
4863** and collating sequence interactions. Consider this example:
4864**
4865** CREATE TABLE t1(a INT,b TEXT);
4866** INSERT INTO t1 VALUES(123,'0123');
4867** SELECT * FROM t1 WHERE a=123 AND b=a;
4868** SELECT * FROM t1 WHERE a=123 AND b=123;
4869**
4870** The two SELECT statements above should return different answers. b=a
4871** is alway true because the comparison uses numeric affinity, but b=123
4872** is false because it uses text affinity and '0123' is not the same as '123'.
4873** To work around this, the expression tree is not actually changed from
4874** "b=a" to "b=123" but rather the "a" in "b=a" is tagged with EP_FixedCol
4875** and the "123" value is hung off of the pLeft pointer. Code generator
4876** routines know to generate the constant "123" instead of looking up the
4877** column value. Also, to avoid collation problems, this optimization is
4878** only attempted if the "a=123" term uses the default BINARY collation.
drh342cb332021-05-27 14:09:01 +00004879**
4880** 2021-05-25 forum post 6a06202608: Another troublesome case is...
4881**
4882** CREATE TABLE t1(x);
4883** INSERT INTO t1 VALUES(10.0);
4884** SELECT 1 FROM t1 WHERE x=10 AND x LIKE 10;
4885**
4886** The query should return no rows, because the t1.x value is '10.0' not '10'
4887** and '10.0' is not LIKE '10'. But if we are not careful, the first WHERE
4888** term "x=10" will cause the second WHERE term to become "10 LIKE 10",
4889** resulting in a false positive. To avoid this, constant propagation for
4890** columns with BLOB affinity is only allowed if the constant is used with
4891** operators ==, <=, <, >=, >, or IS in a way that will cause the correct
4892** type conversions to occur. See logic associated with the bHasAffBlob flag
4893** for details.
drh660ee552018-07-26 21:16:53 +00004894*/
4895static int propagateConstants(
4896 Parse *pParse, /* The parsing context */
4897 Select *p /* The query in which to propagate constants */
4898){
4899 WhereConst x;
4900 Walker w;
4901 int nChng = 0;
drhefad2e22018-07-27 16:57:11 +00004902 x.pParse = pParse;
drh75016052021-06-10 14:36:23 +00004903 x.pOomFault = &pParse->db->mallocFailed;
drh660ee552018-07-26 21:16:53 +00004904 do{
4905 x.nConst = 0;
4906 x.nChng = 0;
4907 x.apExpr = 0;
dan40b82f92021-05-26 18:51:57 +00004908 x.bHasAffBlob = 0;
drhae8776e2022-06-20 12:42:28 +00004909 if( ALWAYS(p->pSrc!=0)
4910 && p->pSrc->nSrc>0
4911 && (p->pSrc->a[0].fg.jointype & JT_LTORJ)!=0
4912 ){
4913 /* Do not propagate constants on any ON clause if there is a
4914 ** RIGHT JOIN anywhere in the query */
4915 x.mExcludeOn = EP_InnerON | EP_OuterON;
4916 }else{
4917 /* Do not propagate constants through the ON clause of a LEFT JOIN */
4918 x.mExcludeOn = EP_OuterON;
4919 }
drh660ee552018-07-26 21:16:53 +00004920 findConstInWhere(&x, p->pWhere);
4921 if( x.nConst ){
4922 memset(&w, 0, sizeof(w));
4923 w.pParse = pParse;
4924 w.xExprCallback = propagateConstantExprRewrite;
4925 w.xSelectCallback = sqlite3SelectWalkNoop;
4926 w.xSelectCallback2 = 0;
4927 w.walkerDepth = 0;
4928 w.u.pConst = &x;
drhefad2e22018-07-27 16:57:11 +00004929 sqlite3WalkExpr(&w, p->pWhere);
4930 sqlite3DbFree(x.pParse->db, x.apExpr);
drh660ee552018-07-26 21:16:53 +00004931 nChng += x.nChng;
4932 }
4933 }while( x.nChng );
4934 return nChng;
4935}
drh69b72d52015-06-01 20:28:03 +00004936
4937#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
dan903fdd42021-02-22 20:56:13 +00004938# if !defined(SQLITE_OMIT_WINDOWFUNC)
4939/*
4940** This function is called to determine whether or not it is safe to
4941** push WHERE clause expression pExpr down to FROM clause sub-query
4942** pSubq, which contains at least one window function. Return 1
4943** if it is safe and the expression should be pushed down, or 0
4944** otherwise.
4945**
4946** It is only safe to push the expression down if it consists only
4947** of constants and copies of expressions that appear in the PARTITION
4948** BY clause of all window function used by the sub-query. It is safe
4949** to filter out entire partitions, but not rows within partitions, as
4950** this may change the results of the window functions.
4951**
4952** At the time this function is called it is guaranteed that
4953**
4954** * the sub-query uses only one distinct window frame, and
4955** * that the window frame has a PARTITION BY clase.
4956*/
4957static int pushDownWindowCheck(Parse *pParse, Select *pSubq, Expr *pExpr){
4958 assert( pSubq->pWin->pPartition );
4959 assert( (pSubq->selFlags & SF_MultiPart)==0 );
4960 assert( pSubq->pPrior==0 );
4961 return sqlite3ExprIsConstantOrGroupBy(pParse, pExpr, pSubq->pWin->pPartition);
4962}
4963# endif /* SQLITE_OMIT_WINDOWFUNC */
4964#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4965
4966#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh69b72d52015-06-01 20:28:03 +00004967/*
4968** Make copies of relevant WHERE clause terms of the outer query into
4969** the WHERE clause of subquery. Example:
4970**
4971** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1) WHERE x=5 AND y=10;
4972**
4973** Transformed into:
4974**
4975** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1 WHERE a=5 AND c-d=10)
4976** WHERE x=5 AND y=10;
4977**
4978** The hope is that the terms added to the inner query will make it more
4979** efficient.
4980**
4981** Do not attempt this optimization if:
4982**
drh25c221e2017-09-29 22:13:24 +00004983** (1) (** This restriction was removed on 2017-09-29. We used to
4984** disallow this optimization for aggregate subqueries, but now
drh67cc51a2017-09-30 11:47:06 +00004985** it is allowed by putting the extra terms on the HAVING clause.
4986** The added HAVING clause is pointless if the subquery lacks
4987** a GROUP BY clause. But such a HAVING clause is also harmless
4988** so there does not appear to be any reason to add extra logic
4989** to suppress it. **)
drh69b72d52015-06-01 20:28:03 +00004990**
4991** (2) The inner query is the recursive part of a common table expression.
4992**
4993** (3) The inner query has a LIMIT clause (since the changes to the WHERE
dance103732018-06-23 07:59:39 +00004994** clause would change the meaning of the LIMIT).
drh69b72d52015-06-01 20:28:03 +00004995**
drh6a9b9522018-03-27 15:13:43 +00004996** (4) The inner query is the right operand of a LEFT JOIN and the
4997** expression to be pushed down does not come from the ON clause
4998** on that LEFT JOIN.
drh69b72d52015-06-01 20:28:03 +00004999**
drh38978dd2015-08-22 01:32:29 +00005000** (5) The WHERE clause expression originates in the ON or USING clause
drh7fbb1012018-03-21 01:59:46 +00005001** of a LEFT JOIN where iCursor is not the right-hand table of that
5002** left join. An example:
5003**
5004** SELECT *
5005** FROM (SELECT 1 AS a1 UNION ALL SELECT 2) AS aa
5006** JOIN (SELECT 1 AS b2 UNION ALL SELECT 2) AS bb ON (a1=b2)
5007** LEFT JOIN (SELECT 8 AS c3 UNION ALL SELECT 9) AS cc ON (b2=2);
5008**
5009** The correct answer is three rows: (1,1,NULL),(2,2,8),(2,2,9).
5010** But if the (b2=2) term were to be pushed down into the bb subquery,
5011** then the (1,1,NULL) row would be suppressed.
drh38978dd2015-08-22 01:32:29 +00005012**
dan903fdd42021-02-22 20:56:13 +00005013** (6) Window functions make things tricky as changes to the WHERE clause
5014** of the inner query could change the window over which window
5015** functions are calculated. Therefore, do not attempt the optimization
5016** if:
5017**
5018** (6a) The inner query uses multiple incompatible window partitions.
5019**
5020** (6b) The inner query is a compound and uses window-functions.
5021**
5022** (6c) The WHERE clause does not consist entirely of constants and
5023** copies of expressions found in the PARTITION BY clause of
5024** all window-functions used by the sub-query. It is safe to
5025** filter out entire partitions, as this does not change the
5026** window over which any window-function is calculated.
dance103732018-06-23 07:59:39 +00005027**
drh745912e2021-02-22 03:04:25 +00005028** (7) The inner query is a Common Table Expression (CTE) that should
5029** be materialized. (This restriction is implemented in the calling
5030** routine.)
5031**
dan195687f2022-10-26 21:14:21 +00005032** (8) The subquery may not be a compound that uses UNION, INTERSECT,
5033** or EXCEPT. (We could, perhaps, relax this restriction to allow
5034** this case if none of the comparisons operators between left and
5035** right arms of the compound use a collation other than BINARY.
5036** But it is a lot of work to check that case for an obscure and
5037** minor optimization, so we omit it for now.)
5038**
drh69b72d52015-06-01 20:28:03 +00005039** Return 0 if no changes are made and non-zero if one or more WHERE clause
5040** terms are duplicated into the subquery.
5041*/
5042static int pushDownWhereTerms(
dan44c56042016-12-07 15:38:37 +00005043 Parse *pParse, /* Parse context (for malloc() and error reporting) */
drh69b72d52015-06-01 20:28:03 +00005044 Select *pSubq, /* The subquery whose WHERE clause is to be augmented */
5045 Expr *pWhere, /* The WHERE clause of the outer query */
drha9cdb902022-04-25 19:40:33 +00005046 SrcItem *pSrc /* The subquery term of the outer FROM clause */
drh69b72d52015-06-01 20:28:03 +00005047){
5048 Expr *pNew;
5049 int nChng = 0;
5050 if( pWhere==0 ) return 0;
dan903fdd42021-02-22 20:56:13 +00005051 if( pSubq->selFlags & (SF_Recursive|SF_MultiPart) ) return 0;
drh0e464b52022-04-25 20:47:58 +00005052 if( pSrc->fg.jointype & (JT_LTORJ|JT_RIGHT) ) return 0;
drh508e2d02017-09-30 01:25:04 +00005053
dance103732018-06-23 07:59:39 +00005054#ifndef SQLITE_OMIT_WINDOWFUNC
dan903fdd42021-02-22 20:56:13 +00005055 if( pSubq->pPrior ){
5056 Select *pSel;
5057 for(pSel=pSubq; pSel; pSel=pSel->pPrior){
dan195687f2022-10-26 21:14:21 +00005058 u8 op = pSel->op;
5059 assert( op==TK_ALL || op==TK_SELECT
5060 || op==TK_UNION || op==TK_INTERSECT || op==TK_EXCEPT );
5061 if( op!=TK_ALL && op!=TK_SELECT ) return 0; /* restriction (8) */
dan903fdd42021-02-22 20:56:13 +00005062 if( pSel->pWin ) return 0; /* restriction (6b) */
5063 }
5064 }else{
5065 if( pSubq->pWin && pSubq->pWin->pPartition==0 ) return 0;
danf65e3792020-06-10 10:58:15 +00005066 }
dance103732018-06-23 07:59:39 +00005067#endif
5068
drh508e2d02017-09-30 01:25:04 +00005069#ifdef SQLITE_DEBUG
5070 /* Only the first term of a compound can have a WITH clause. But make
5071 ** sure no other terms are marked SF_Recursive in case something changes
5072 ** in the future.
5073 */
5074 {
5075 Select *pX;
5076 for(pX=pSubq; pX; pX=pX->pPrior){
5077 assert( (pX->selFlags & (SF_Recursive))==0 );
drhb1ec87a2016-04-25 02:20:10 +00005078 }
drh69b72d52015-06-01 20:28:03 +00005079 }
drh508e2d02017-09-30 01:25:04 +00005080#endif
5081
drh69b72d52015-06-01 20:28:03 +00005082 if( pSubq->pLimit!=0 ){
drhb1ec87a2016-04-25 02:20:10 +00005083 return 0; /* restriction (3) */
drh69b72d52015-06-01 20:28:03 +00005084 }
5085 while( pWhere->op==TK_AND ){
drha9cdb902022-04-25 19:40:33 +00005086 nChng += pushDownWhereTerms(pParse, pSubq, pWhere->pRight, pSrc);
drh69b72d52015-06-01 20:28:03 +00005087 pWhere = pWhere->pLeft;
5088 }
drha9cdb902022-04-25 19:40:33 +00005089
5090#if 0 /* Legacy code. Checks now done by sqlite3ExprIsTableConstraint() */
drh6a9b9522018-03-27 15:13:43 +00005091 if( isLeftJoin
drh67a99db2022-05-13 14:52:04 +00005092 && (ExprHasProperty(pWhere,EP_OuterON)==0
drhd1985262022-04-11 11:25:28 +00005093 || pWhere->w.iJoin!=iCursor)
drh6a9b9522018-03-27 15:13:43 +00005094 ){
5095 return 0; /* restriction (4) */
5096 }
drh67a99db2022-05-13 14:52:04 +00005097 if( ExprHasProperty(pWhere,EP_OuterON)
drhd1985262022-04-11 11:25:28 +00005098 && pWhere->w.iJoin!=iCursor
drh796588a2022-02-05 21:49:47 +00005099 ){
drh7fbb1012018-03-21 01:59:46 +00005100 return 0; /* restriction (5) */
5101 }
drha9cdb902022-04-25 19:40:33 +00005102#endif
5103
drh5eb6e092022-04-25 20:38:42 +00005104 if( sqlite3ExprIsTableConstraint(pWhere, pSrc) ){
drh69b72d52015-06-01 20:28:03 +00005105 nChng++;
drh8794c682021-02-13 16:39:24 +00005106 pSubq->selFlags |= SF_PushDown;
drh69b72d52015-06-01 20:28:03 +00005107 while( pSubq ){
drh46967de2017-04-14 12:39:37 +00005108 SubstContext x;
dan44c56042016-12-07 15:38:37 +00005109 pNew = sqlite3ExprDup(pParse->db, pWhere, 0);
drh92d1afb2022-06-13 12:42:24 +00005110 unsetJoinExpr(pNew, -1, 1);
drh46967de2017-04-14 12:39:37 +00005111 x.pParse = pParse;
drha9cdb902022-04-25 19:40:33 +00005112 x.iTable = pSrc->iCursor;
5113 x.iNewTable = pSrc->iCursor;
drhc133bab2022-04-11 20:15:52 +00005114 x.isOuterJoin = 0;
drh46967de2017-04-14 12:39:37 +00005115 x.pEList = pSubq->pEList;
dan879164e2022-10-14 19:30:34 +00005116 x.pCList = findLeftmostExprlist(pSubq);
drh46967de2017-04-14 12:39:37 +00005117 pNew = substExpr(&x, pNew);
dan903fdd42021-02-22 20:56:13 +00005118#ifndef SQLITE_OMIT_WINDOWFUNC
5119 if( pSubq->pWin && 0==pushDownWindowCheck(pParse, pSubq, pNew) ){
5120 /* Restriction 6c has prevented push-down in this case */
5121 sqlite3ExprDelete(pParse->db, pNew);
5122 nChng--;
5123 break;
5124 }
5125#endif
drh25c221e2017-09-29 22:13:24 +00005126 if( pSubq->selFlags & SF_Aggregate ){
drhd5c851c2019-04-19 13:38:34 +00005127 pSubq->pHaving = sqlite3ExprAnd(pParse, pSubq->pHaving, pNew);
drh25c221e2017-09-29 22:13:24 +00005128 }else{
drhd5c851c2019-04-19 13:38:34 +00005129 pSubq->pWhere = sqlite3ExprAnd(pParse, pSubq->pWhere, pNew);
drh25c221e2017-09-29 22:13:24 +00005130 }
drh69b72d52015-06-01 20:28:03 +00005131 pSubq = pSubq->pPrior;
5132 }
5133 }
5134 return nChng;
5135}
5136#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
5137
drh1350b032002-02-27 19:00:20 +00005138/*
drh47d9f832017-10-26 20:04:28 +00005139** The pFunc is the only aggregate function in the query. Check to see
5140** if the query is a candidate for the min/max optimization.
danielk1977a9d1ccb2008-01-05 17:39:29 +00005141**
drh47d9f832017-10-26 20:04:28 +00005142** If the query is a candidate for the min/max optimization, then set
5143** *ppMinMax to be an ORDER BY clause to be used for the optimization
5144** and return either WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX depending on
5145** whether pFunc is a min() or max() function.
danielk1977738bdcf2008-01-07 10:16:40 +00005146**
drh47d9f832017-10-26 20:04:28 +00005147** If the query is not a candidate for the min/max optimization, return
5148** WHERE_ORDERBY_NORMAL (which must be zero).
dan4ac391f2012-12-13 16:37:10 +00005149**
drh47d9f832017-10-26 20:04:28 +00005150** This routine must be called after aggregate functions have been
5151** located but before their arguments have been subjected to aggregate
5152** analysis.
danielk1977a9d1ccb2008-01-05 17:39:29 +00005153*/
drh47d9f832017-10-26 20:04:28 +00005154static u8 minMaxQuery(sqlite3 *db, Expr *pFunc, ExprList **ppMinMax){
5155 int eRet = WHERE_ORDERBY_NORMAL; /* Return value */
drha4eeccd2021-10-07 17:43:30 +00005156 ExprList *pEList; /* Arguments to agg function */
drh47d9f832017-10-26 20:04:28 +00005157 const char *zFunc; /* Name of aggregate function pFunc */
5158 ExprList *pOrderBy;
drhbe284e42020-02-27 16:21:39 +00005159 u8 sortFlags = 0;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005160
drh47d9f832017-10-26 20:04:28 +00005161 assert( *ppMinMax==0 );
5162 assert( pFunc->op==TK_AGG_FUNCTION );
dan4f9adee2019-07-13 16:22:50 +00005163 assert( !IsWindowFunc(pFunc) );
drha4eeccd2021-10-07 17:43:30 +00005164 assert( ExprUseXList(pFunc) );
5165 pEList = pFunc->x.pList;
drhaf7b7652021-01-13 19:28:17 +00005166 if( pEList==0
5167 || pEList->nExpr!=1
5168 || ExprHasProperty(pFunc, EP_WinFunc)
5169 || OptimizationDisabled(db, SQLITE_MinMaxOpt)
5170 ){
dan6ba7ab02019-07-02 11:56:47 +00005171 return eRet;
5172 }
drhf9751072021-10-07 13:40:29 +00005173 assert( !ExprHasProperty(pFunc, EP_IntValue) );
drh47d9f832017-10-26 20:04:28 +00005174 zFunc = pFunc->u.zToken;
5175 if( sqlite3StrICmp(zFunc, "min")==0 ){
5176 eRet = WHERE_ORDERBY_MIN;
dan67e2bb92020-02-27 15:07:16 +00005177 if( sqlite3ExprCanBeNull(pEList->a[0].pExpr) ){
5178 sortFlags = KEYINFO_ORDER_BIGNULL;
5179 }
drh47d9f832017-10-26 20:04:28 +00005180 }else if( sqlite3StrICmp(zFunc, "max")==0 ){
5181 eRet = WHERE_ORDERBY_MAX;
dan5b32bdf2019-08-17 15:47:32 +00005182 sortFlags = KEYINFO_ORDER_DESC;
drh47d9f832017-10-26 20:04:28 +00005183 }else{
5184 return eRet;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005185 }
drh47d9f832017-10-26 20:04:28 +00005186 *ppMinMax = pOrderBy = sqlite3ExprListDup(db, pEList, 0);
5187 assert( pOrderBy!=0 || db->mallocFailed );
drhd88fd532022-05-02 20:49:30 +00005188 if( pOrderBy ) pOrderBy->a[0].fg.sortFlags = sortFlags;
dan4ac391f2012-12-13 16:37:10 +00005189 return eRet;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005190}
5191
5192/*
danielk1977a5533162009-02-24 10:01:51 +00005193** The select statement passed as the first argument is an aggregate query.
peter.d.reid60ec9142014-09-06 16:39:46 +00005194** The second argument is the associated aggregate-info object. This
danielk1977a5533162009-02-24 10:01:51 +00005195** function tests if the SELECT is of the form:
5196**
5197** SELECT count(*) FROM <tbl>
5198**
5199** where table is a database table, not a sub-select or view. If the query
5200** does match this pattern, then a pointer to the Table object representing
drha1c4c3c2021-11-05 11:52:33 +00005201** <tbl> is returned. Otherwise, NULL is returned.
5202**
drhe574a922021-11-26 15:08:55 +00005203** This routine checks to see if it is safe to use the count optimization.
5204** A correct answer is still obtained (though perhaps more slowly) if
5205** this routine returns NULL when it could have returned a table pointer.
5206** But returning the pointer when NULL should have been returned can
5207** result in incorrect answers and/or crashes. So, when in doubt, return NULL.
danielk1977a5533162009-02-24 10:01:51 +00005208*/
5209static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
5210 Table *pTab;
5211 Expr *pExpr;
5212
5213 assert( !p->pGroupBy );
5214
drha1c4c3c2021-11-05 11:52:33 +00005215 if( p->pWhere
5216 || p->pEList->nExpr!=1
5217 || p->pSrc->nSrc!=1
5218 || p->pSrc->a[0].pSelect
5219 || pAggInfo->nFunc!=1
dan2c1b1dd2022-07-01 21:03:19 +00005220 || p->pHaving
danielk1977a5533162009-02-24 10:01:51 +00005221 ){
5222 return 0;
5223 }
danielk1977a5533162009-02-24 10:01:51 +00005224 pTab = p->pSrc->a[0].pTab;
drha1c4c3c2021-11-05 11:52:33 +00005225 assert( pTab!=0 );
5226 assert( !IsView(pTab) );
5227 if( !IsOrdinaryTable(pTab) ) return 0;
danielk1977a5533162009-02-24 10:01:51 +00005228 pExpr = p->pEList->a[0].pExpr;
drha1c4c3c2021-11-05 11:52:33 +00005229 assert( pExpr!=0 );
danielk1977a5533162009-02-24 10:01:51 +00005230 if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
dan8745f8a2021-11-15 14:11:23 +00005231 if( pExpr->pAggInfo!=pAggInfo ) return 0;
drhd36e1042013-09-06 13:10:12 +00005232 if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
drha1c4c3c2021-11-05 11:52:33 +00005233 assert( pAggInfo->aFunc[0].pFExpr==pExpr );
5234 testcase( ExprHasProperty(pExpr, EP_Distinct) );
5235 testcase( ExprHasProperty(pExpr, EP_WinFunc) );
dan4f9adee2019-07-13 16:22:50 +00005236 if( ExprHasProperty(pExpr, EP_Distinct|EP_WinFunc) ) return 0;
danielk1977a5533162009-02-24 10:01:51 +00005237
5238 return pTab;
5239}
5240
5241/*
danielk1977b1c685b2008-10-06 16:18:39 +00005242** If the source-list item passed as an argument was augmented with an
5243** INDEXED BY clause, then try to locate the specified index. If there
5244** was such a clause and the named index cannot be found, return
5245** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
5246** pFrom->pIndex and return SQLITE_OK.
5247*/
drh76012942021-02-21 21:04:54 +00005248int sqlite3IndexedByLookup(Parse *pParse, SrcItem *pFrom){
drh18622712021-02-20 21:20:54 +00005249 Table *pTab = pFrom->pTab;
5250 char *zIndexedBy = pFrom->u1.zIndexedBy;
5251 Index *pIdx;
5252 assert( pTab!=0 );
5253 assert( pFrom->fg.isIndexedBy!=0 );
5254
5255 for(pIdx=pTab->pIndex;
5256 pIdx && sqlite3StrICmp(pIdx->zName, zIndexedBy);
5257 pIdx=pIdx->pNext
5258 );
5259 if( !pIdx ){
5260 sqlite3ErrorMsg(pParse, "no such index: %s", zIndexedBy, 0);
5261 pParse->checkSchema = 1;
5262 return SQLITE_ERROR;
danielk1977b1c685b2008-10-06 16:18:39 +00005263 }
drhdbfbb5a2021-10-07 23:04:50 +00005264 assert( pFrom->fg.isCte==0 );
drha79e2a22021-02-21 23:44:14 +00005265 pFrom->u2.pIBIndex = pIdx;
danielk1977b1c685b2008-10-06 16:18:39 +00005266 return SQLITE_OK;
5267}
drh18622712021-02-20 21:20:54 +00005268
drhc01b7302013-05-07 17:49:08 +00005269/*
5270** Detect compound SELECT statements that use an ORDER BY clause with
5271** an alternative collating sequence.
5272**
5273** SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
5274**
5275** These are rewritten as a subquery:
5276**
5277** SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
5278** ORDER BY ... COLLATE ...
5279**
5280** This transformation is necessary because the multiSelectOrderBy() routine
5281** above that generates the code for a compound SELECT with an ORDER BY clause
5282** uses a merge algorithm that requires the same collating sequence on the
5283** result columns as on the ORDER BY clause. See ticket
5284** http://www.sqlite.org/src/info/6709574d2a
5285**
5286** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
5287** The UNION ALL operator works fine with multiSelectOrderBy() even when
5288** there are COLLATE terms in the ORDER BY.
5289*/
5290static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
5291 int i;
5292 Select *pNew;
5293 Select *pX;
5294 sqlite3 *db;
5295 struct ExprList_item *a;
5296 SrcList *pNewSrc;
5297 Parse *pParse;
5298 Token dummy;
5299
5300 if( p->pPrior==0 ) return WRC_Continue;
5301 if( p->pOrderBy==0 ) return WRC_Continue;
5302 for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
5303 if( pX==0 ) return WRC_Continue;
5304 a = p->pOrderBy->a;
dan46daa992020-06-11 15:53:54 +00005305#ifndef SQLITE_OMIT_WINDOWFUNC
5306 /* If iOrderByCol is already non-zero, then it has already been matched
5307 ** to a result column of the SELECT statement. This occurs when the
5308 ** SELECT is rewritten for window-functions processing and then passed
5309 ** to sqlite3SelectPrep() and similar a second time. The rewriting done
5310 ** by this function is not required in this case. */
5311 if( a[0].u.x.iOrderByCol ) return WRC_Continue;
5312#endif
drhc01b7302013-05-07 17:49:08 +00005313 for(i=p->pOrderBy->nExpr-1; i>=0; i--){
5314 if( a[i].pExpr->flags & EP_Collate ) break;
5315 }
5316 if( i<0 ) return WRC_Continue;
5317
5318 /* If we reach this point, that means the transformation is required. */
5319
5320 pParse = pWalker->pParse;
5321 db = pParse->db;
5322 pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
5323 if( pNew==0 ) return WRC_Abort;
5324 memset(&dummy, 0, sizeof(dummy));
drhd44f8b22022-04-07 01:11:13 +00005325 pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0);
drhc01b7302013-05-07 17:49:08 +00005326 if( pNewSrc==0 ) return WRC_Abort;
5327 *pNew = *p;
5328 p->pSrc = pNewSrc;
drh1a1d3cd2015-11-19 16:33:31 +00005329 p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ASTERISK, 0));
drhc01b7302013-05-07 17:49:08 +00005330 p->op = TK_SELECT;
5331 p->pWhere = 0;
5332 pNew->pGroupBy = 0;
5333 pNew->pHaving = 0;
5334 pNew->pOrderBy = 0;
5335 p->pPrior = 0;
drh8af9ad92014-02-10 18:56:05 +00005336 p->pNext = 0;
drhf932f712015-04-12 17:35:27 +00005337 p->pWith = 0;
danfcc057d2019-12-04 01:42:07 +00005338#ifndef SQLITE_OMIT_WINDOWFUNC
5339 p->pWinDefn = 0;
5340#endif
drh8af9ad92014-02-10 18:56:05 +00005341 p->selFlags &= ~SF_Compound;
danb33c50f2015-04-04 16:43:16 +00005342 assert( (p->selFlags & SF_Converted)==0 );
5343 p->selFlags |= SF_Converted;
drha6e3a8c2014-02-10 21:07:51 +00005344 assert( pNew->pPrior!=0 );
5345 pNew->pPrior->pNext = pNew;
drhc01b7302013-05-07 17:49:08 +00005346 pNew->pLimit = 0;
drhc01b7302013-05-07 17:49:08 +00005347 return WRC_Continue;
5348}
danielk1977b1c685b2008-10-06 16:18:39 +00005349
drh20292312015-11-21 13:24:46 +00005350/*
5351** Check to see if the FROM clause term pFrom has table-valued function
5352** arguments. If it does, leave an error message in pParse and return
5353** non-zero, since pFrom is not allowed to be a table-valued function.
5354*/
drh76012942021-02-21 21:04:54 +00005355static int cannotBeFunction(Parse *pParse, SrcItem *pFrom){
drh20292312015-11-21 13:24:46 +00005356 if( pFrom->fg.isTabFunc ){
5357 sqlite3ErrorMsg(pParse, "'%s' is not a function", pFrom->zName);
5358 return 1;
5359 }
5360 return 0;
5361}
5362
daneede6a52014-01-15 19:42:23 +00005363#ifndef SQLITE_OMIT_CTE
5364/*
5365** Argument pWith (which may be NULL) points to a linked list of nested
5366** WITH contexts, from inner to outermost. If the table identified by
5367** FROM clause element pItem is really a common-table-expression (CTE)
5368** then return a pointer to the CTE definition for that table. Otherwise
5369** return NULL.
dan98f45e52014-01-17 17:40:46 +00005370**
5371** If a non-NULL value is returned, set *ppContext to point to the With
5372** object that the returned CTE belongs to.
drh60c1a2f2014-01-15 18:23:00 +00005373*/
dan98f45e52014-01-17 17:40:46 +00005374static struct Cte *searchWith(
drh2476a6f2015-11-07 15:19:59 +00005375 With *pWith, /* Current innermost WITH clause */
drh76012942021-02-21 21:04:54 +00005376 SrcItem *pItem, /* FROM clause element to resolve */
dan98f45e52014-01-17 17:40:46 +00005377 With **ppContext /* OUT: WITH clause return value belongs to */
5378){
drh5abe1d32021-02-21 01:19:42 +00005379 const char *zName = pItem->zName;
5380 With *p;
5381 assert( pItem->zDatabase==0 );
5382 assert( zName!=0 );
5383 for(p=pWith; p; p=p->pOuter){
5384 int i;
5385 for(i=0; i<p->nCte; i++){
5386 if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
5387 *ppContext = p;
5388 return &p->a[i];
dan4e9119d2014-01-13 15:12:23 +00005389 }
5390 }
dan90bc36f2021-05-20 17:15:06 +00005391 if( p->bView ) break;
dan4e9119d2014-01-13 15:12:23 +00005392 }
5393 return 0;
5394}
5395
drhc49832c2014-01-15 18:35:52 +00005396/* The code generator maintains a stack of active WITH clauses
5397** with the inner-most WITH clause being at the top of the stack.
5398**
danb290f112014-01-17 14:59:27 +00005399** This routine pushes the WITH clause passed as the second argument
5400** onto the top of the stack. If argument bFree is true, then this
drh7cc73b32021-05-23 17:47:04 +00005401** WITH clause will never be popped from the stack but should instead
5402** be freed along with the Parse object. In other cases, when
danb290f112014-01-17 14:59:27 +00005403** bFree==0, the With object will be freed along with the SELECT
5404** statement with which it is associated.
drh24ce9442021-06-12 17:45:32 +00005405**
5406** This routine returns a copy of pWith. Or, if bFree is true and
5407** the pWith object is destroyed immediately due to an OOM condition,
5408** then this routine return NULL.
5409**
5410** If bFree is true, do not continue to use the pWith pointer after
5411** calling this routine, Instead, use only the return value.
drhc49832c2014-01-15 18:35:52 +00005412*/
drh24ce9442021-06-12 17:45:32 +00005413With *sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
dan4e9119d2014-01-13 15:12:23 +00005414 if( pWith ){
drh24ce9442021-06-12 17:45:32 +00005415 if( bFree ){
5416 pWith = (With*)sqlite3ParserAddCleanup(pParse,
5417 (void(*)(sqlite3*,void*))sqlite3WithDelete,
5418 pWith);
5419 if( pWith==0 ) return 0;
5420 }
drh7cc73b32021-05-23 17:47:04 +00005421 if( pParse->nErr==0 ){
5422 assert( pParse->pWith!=pWith );
5423 pWith->pOuter = pParse->pWith;
5424 pParse->pWith = pWith;
5425 }
dan4e9119d2014-01-13 15:12:23 +00005426 }
drh24ce9442021-06-12 17:45:32 +00005427 return pWith;
dan4e9119d2014-01-13 15:12:23 +00005428}
dan4e9119d2014-01-13 15:12:23 +00005429
daneede6a52014-01-15 19:42:23 +00005430/*
daneede6a52014-01-15 19:42:23 +00005431** This function checks if argument pFrom refers to a CTE declared by
drh5abe1d32021-02-21 01:19:42 +00005432** a WITH clause on the stack currently maintained by the parser (on the
5433** pParse->pWith linked list). And if currently processing a CTE
5434** CTE expression, through routine checks to see if the reference is
5435** a recursive reference to the CTE.
daneede6a52014-01-15 19:42:23 +00005436**
drh5abe1d32021-02-21 01:19:42 +00005437** If pFrom matches a CTE according to either of these two above, pFrom->pTab
5438** and other fields are populated accordingly.
daneede6a52014-01-15 19:42:23 +00005439**
drh5abe1d32021-02-21 01:19:42 +00005440** Return 0 if no match is found.
5441** Return 1 if a match is found.
5442** Return 2 if an error condition is detected.
daneede6a52014-01-15 19:42:23 +00005443*/
drh5abe1d32021-02-21 01:19:42 +00005444static int resolveFromTermToCte(
5445 Parse *pParse, /* The parsing context */
5446 Walker *pWalker, /* Current tree walker */
drh76012942021-02-21 21:04:54 +00005447 SrcItem *pFrom /* The FROM clause term to check */
dan8ce71842014-01-14 20:14:09 +00005448){
drh5abe1d32021-02-21 01:19:42 +00005449 Cte *pCte; /* Matched CTE (or NULL if no match) */
5450 With *pWith; /* The matching WITH */
dan8ce71842014-01-14 20:14:09 +00005451
dan8ce71842014-01-14 20:14:09 +00005452 assert( pFrom->pTab==0 );
drh5abe1d32021-02-21 01:19:42 +00005453 if( pParse->pWith==0 ){
5454 /* There are no WITH clauses in the stack. No match is possible */
5455 return 0;
drh46a31cd2019-11-09 14:38:58 +00005456 }
drh93c81392021-05-21 21:49:07 +00005457 if( pParse->nErr ){
5458 /* Prior errors might have left pParse->pWith in a goofy state, so
5459 ** go no further. */
5460 return 0;
5461 }
drh5abe1d32021-02-21 01:19:42 +00005462 if( pFrom->zDatabase!=0 ){
5463 /* The FROM term contains a schema qualifier (ex: main.t1) and so
5464 ** it cannot possibly be a CTE reference. */
5465 return 0;
5466 }
drhcd1499f2021-05-20 00:44:04 +00005467 if( pFrom->fg.notCte ){
5468 /* The FROM term is specifically excluded from matching a CTE.
5469 ** (1) It is part of a trigger that used to have zDatabase but had
5470 ** zDatabase removed by sqlite3FixTriggerStep().
5471 ** (2) This is the first term in the FROM clause of an UPDATE.
5472 */
5473 return 0;
5474 }
dan98f45e52014-01-17 17:40:46 +00005475 pCte = searchWith(pParse->pWith, pFrom, &pWith);
daneae73fb2014-01-16 18:34:33 +00005476 if( pCte ){
drh5abe1d32021-02-21 01:19:42 +00005477 sqlite3 *db = pParse->db;
dan98f45e52014-01-17 17:40:46 +00005478 Table *pTab;
dan8ce71842014-01-14 20:14:09 +00005479 ExprList *pEList;
5480 Select *pSel;
dan60e70682014-01-15 15:27:51 +00005481 Select *pLeft; /* Left-most SELECT statement */
drh34055852020-10-19 01:23:48 +00005482 Select *pRecTerm; /* Left-most recursive term */
danf2655fe2014-01-16 21:02:02 +00005483 int bMayRecursive; /* True if compound joined by UNION [ALL] */
dan98f45e52014-01-17 17:40:46 +00005484 With *pSavedWith; /* Initial value of pParse->pWith */
drh34055852020-10-19 01:23:48 +00005485 int iRecTab = -1; /* Cursor for recursive table */
drh745912e2021-02-22 03:04:25 +00005486 CteUse *pCteUse;
danf2655fe2014-01-16 21:02:02 +00005487
drh0576bc52015-08-26 11:40:11 +00005488 /* If pCte->zCteErr is non-NULL at this point, then this is an illegal
danf2655fe2014-01-16 21:02:02 +00005489 ** recursive reference to CTE pCte. Leave an error in pParse and return
drh0576bc52015-08-26 11:40:11 +00005490 ** early. If pCte->zCteErr is NULL, then this is not a recursive reference.
danf2655fe2014-01-16 21:02:02 +00005491 ** In this case, proceed. */
drh0576bc52015-08-26 11:40:11 +00005492 if( pCte->zCteErr ){
5493 sqlite3ErrorMsg(pParse, pCte->zCteErr, pCte->zName);
drh5abe1d32021-02-21 01:19:42 +00005494 return 2;
danf2655fe2014-01-16 21:02:02 +00005495 }
drh5abe1d32021-02-21 01:19:42 +00005496 if( cannotBeFunction(pParse, pFrom) ) return 2;
dan8ce71842014-01-14 20:14:09 +00005497
drhc25e2eb2014-01-20 14:58:55 +00005498 assert( pFrom->pTab==0 );
drha79e2a22021-02-21 23:44:14 +00005499 pTab = sqlite3DbMallocZero(db, sizeof(Table));
drh5abe1d32021-02-21 01:19:42 +00005500 if( pTab==0 ) return 2;
drh745912e2021-02-22 03:04:25 +00005501 pCteUse = pCte->pUse;
5502 if( pCteUse==0 ){
5503 pCte->pUse = pCteUse = sqlite3DbMallocZero(db, sizeof(pCteUse[0]));
5504 if( pCteUse==0
5505 || sqlite3ParserAddCleanup(pParse,sqlite3DbFree,pCteUse)==0
drha79e2a22021-02-21 23:44:14 +00005506 ){
5507 sqlite3DbFree(db, pTab);
5508 return 2;
5509 }
drh745912e2021-02-22 03:04:25 +00005510 pCteUse->eM10d = pCte->eM10d;
drha79e2a22021-02-21 23:44:14 +00005511 }
5512 pFrom->pTab = pTab;
drh79df7782016-12-14 14:07:35 +00005513 pTab->nTabRef = 1;
dan2d4dc5f2014-01-17 11:48:24 +00005514 pTab->zName = sqlite3DbStrDup(db, pCte->zName);
dan8ce71842014-01-14 20:14:09 +00005515 pTab->iPKey = -1;
dancfc9df72014-04-25 15:01:01 +00005516 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drhfccda8a2015-05-27 13:06:55 +00005517 pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
dan8ce71842014-01-14 20:14:09 +00005518 pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
drh5abe1d32021-02-21 01:19:42 +00005519 if( db->mallocFailed ) return 2;
danac67f562021-06-14 20:08:48 +00005520 pFrom->pSelect->selFlags |= SF_CopyCte;
dan8ce71842014-01-14 20:14:09 +00005521 assert( pFrom->pSelect );
drh0c1da682021-10-09 16:00:56 +00005522 if( pFrom->fg.isIndexedBy ){
5523 sqlite3ErrorMsg(pParse, "no such index: \"%s\"", pFrom->u1.zIndexedBy);
5524 return 2;
5525 }
drha79e2a22021-02-21 23:44:14 +00005526 pFrom->fg.isCte = 1;
drh745912e2021-02-22 03:04:25 +00005527 pFrom->u2.pCteUse = pCteUse;
5528 pCteUse->nUse++;
5529 if( pCteUse->nUse>=2 && pCteUse->eM10d==M10d_Any ){
5530 pCteUse->eM10d = M10d_Yes;
5531 }
dan8ce71842014-01-14 20:14:09 +00005532
daneae73fb2014-01-16 18:34:33 +00005533 /* Check if this is a recursive CTE. */
drh34055852020-10-19 01:23:48 +00005534 pRecTerm = pSel = pFrom->pSelect;
danf2655fe2014-01-16 21:02:02 +00005535 bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
drh34055852020-10-19 01:23:48 +00005536 while( bMayRecursive && pRecTerm->op==pSel->op ){
daneae73fb2014-01-16 18:34:33 +00005537 int i;
drh34055852020-10-19 01:23:48 +00005538 SrcList *pSrc = pRecTerm->pSrc;
5539 assert( pRecTerm->pPrior!=0 );
daneae73fb2014-01-16 18:34:33 +00005540 for(i=0; i<pSrc->nSrc; i++){
drh76012942021-02-21 21:04:54 +00005541 SrcItem *pItem = &pSrc->a[i];
daneae73fb2014-01-16 18:34:33 +00005542 if( pItem->zDatabase==0
5543 && pItem->zName!=0
5544 && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
drh34055852020-10-19 01:23:48 +00005545 ){
daneae73fb2014-01-16 18:34:33 +00005546 pItem->pTab = pTab;
drh94d6f3f2020-10-19 20:49:54 +00005547 pTab->nTabRef++;
drh8a48b9c2015-08-19 15:20:00 +00005548 pItem->fg.isRecursive = 1;
drh34055852020-10-19 01:23:48 +00005549 if( pRecTerm->selFlags & SF_Recursive ){
5550 sqlite3ErrorMsg(pParse,
5551 "multiple references to recursive table: %s", pCte->zName
5552 );
drh5abe1d32021-02-21 01:19:42 +00005553 return 2;
drh34055852020-10-19 01:23:48 +00005554 }
drh34055852020-10-19 01:23:48 +00005555 pRecTerm->selFlags |= SF_Recursive;
5556 if( iRecTab<0 ) iRecTab = pParse->nTab++;
5557 pItem->iCursor = iRecTab;
daneae73fb2014-01-16 18:34:33 +00005558 }
5559 }
drh34055852020-10-19 01:23:48 +00005560 if( (pRecTerm->selFlags & SF_Recursive)==0 ) break;
5561 pRecTerm = pRecTerm->pPrior;
dan8ce71842014-01-14 20:14:09 +00005562 }
5563
drh0576bc52015-08-26 11:40:11 +00005564 pCte->zCteErr = "circular reference: %s";
dan98f45e52014-01-17 17:40:46 +00005565 pSavedWith = pParse->pWith;
5566 pParse->pWith = pWith;
drh34055852020-10-19 01:23:48 +00005567 if( pSel->selFlags & SF_Recursive ){
danca237a82021-03-18 18:25:43 +00005568 int rc;
drh34055852020-10-19 01:23:48 +00005569 assert( pRecTerm!=0 );
5570 assert( (pRecTerm->selFlags & SF_Recursive)==0 );
5571 assert( pRecTerm->pNext!=0 );
5572 assert( (pRecTerm->pNext->selFlags & SF_Recursive)!=0 );
5573 assert( pRecTerm->pWith==0 );
5574 pRecTerm->pWith = pSel->pWith;
danca237a82021-03-18 18:25:43 +00005575 rc = sqlite3WalkSelect(pWalker, pRecTerm);
drh34055852020-10-19 01:23:48 +00005576 pRecTerm->pWith = 0;
danca237a82021-03-18 18:25:43 +00005577 if( rc ){
5578 pParse->pWith = pSavedWith;
5579 return 2;
5580 }
dan067cd832017-02-03 19:16:39 +00005581 }else{
danca237a82021-03-18 18:25:43 +00005582 if( sqlite3WalkSelect(pWalker, pSel) ){
5583 pParse->pWith = pSavedWith;
5584 return 2;
5585 }
dan067cd832017-02-03 19:16:39 +00005586 }
drh6e772262015-11-07 17:48:21 +00005587 pParse->pWith = pWith;
daneae73fb2014-01-16 18:34:33 +00005588
dan60e70682014-01-15 15:27:51 +00005589 for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
5590 pEList = pLeft->pEList;
dan8ce71842014-01-14 20:14:09 +00005591 if( pCte->pCols ){
drh8f9d0b22015-03-21 03:18:22 +00005592 if( pEList && pEList->nExpr!=pCte->pCols->nExpr ){
drh727a99f2014-01-16 21:59:51 +00005593 sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
dan60e70682014-01-15 15:27:51 +00005594 pCte->zName, pEList->nExpr, pCte->pCols->nExpr
5595 );
dan98f45e52014-01-17 17:40:46 +00005596 pParse->pWith = pSavedWith;
drh5abe1d32021-02-21 01:19:42 +00005597 return 2;
dan60e70682014-01-15 15:27:51 +00005598 }
dan8ce71842014-01-14 20:14:09 +00005599 pEList = pCte->pCols;
dan8ce71842014-01-14 20:14:09 +00005600 }
dan8ce71842014-01-14 20:14:09 +00005601
drh8981b902015-08-24 17:42:49 +00005602 sqlite3ColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
danf2655fe2014-01-16 21:02:02 +00005603 if( bMayRecursive ){
5604 if( pSel->selFlags & SF_Recursive ){
drh0576bc52015-08-26 11:40:11 +00005605 pCte->zCteErr = "multiple recursive references: %s";
danf2655fe2014-01-16 21:02:02 +00005606 }else{
drh0576bc52015-08-26 11:40:11 +00005607 pCte->zCteErr = "recursive reference in a subquery: %s";
danf2655fe2014-01-16 21:02:02 +00005608 }
5609 sqlite3WalkSelect(pWalker, pSel);
5610 }
drh0576bc52015-08-26 11:40:11 +00005611 pCte->zCteErr = 0;
dan98f45e52014-01-17 17:40:46 +00005612 pParse->pWith = pSavedWith;
drh5abe1d32021-02-21 01:19:42 +00005613 return 1; /* Success */
dan8ce71842014-01-14 20:14:09 +00005614 }
drh5abe1d32021-02-21 01:19:42 +00005615 return 0; /* No match */
dan8ce71842014-01-14 20:14:09 +00005616}
daneede6a52014-01-15 19:42:23 +00005617#endif
dan4e9119d2014-01-13 15:12:23 +00005618
danb290f112014-01-17 14:59:27 +00005619#ifndef SQLITE_OMIT_CTE
dan71856942014-01-17 15:15:10 +00005620/*
5621** If the SELECT passed as the second argument has an associated WITH
5622** clause, pop it from the stack stored as part of the Parse object.
5623**
5624** This function is used as the xSelectCallback2() callback by
5625** sqlite3SelectExpand() when walking a SELECT tree to resolve table
5626** names and other FROM clause elements.
5627*/
danbe120832021-05-17 16:20:41 +00005628void sqlite3SelectPopWith(Walker *pWalker, Select *p){
danb290f112014-01-17 14:59:27 +00005629 Parse *pParse = pWalker->pParse;
drh2f65b2f2017-10-02 21:29:51 +00005630 if( OK_IF_ALWAYS_TRUE(pParse->pWith) && p->pPrior==0 ){
dan067cd832017-02-03 19:16:39 +00005631 With *pWith = findRightmost(p)->pWith;
5632 if( pWith!=0 ){
dan70a32702020-01-21 14:42:48 +00005633 assert( pParse->pWith==pWith || pParse->nErr );
dan067cd832017-02-03 19:16:39 +00005634 pParse->pWith = pWith->pOuter;
5635 }
danb290f112014-01-17 14:59:27 +00005636 }
danb290f112014-01-17 14:59:27 +00005637}
danb290f112014-01-17 14:59:27 +00005638#endif
5639
dan9a947222018-06-14 19:06:36 +00005640/*
drh3b880652022-10-19 11:58:24 +00005641** The SrcItem structure passed as the second argument represents a
dan9a947222018-06-14 19:06:36 +00005642** sub-query in the FROM clause of a SELECT statement. This function
drh3b880652022-10-19 11:58:24 +00005643** allocates and populates the SrcItem.pTab object. If successful,
dan9a947222018-06-14 19:06:36 +00005644** SQLITE_OK is returned. Otherwise, if an OOM error is encountered,
5645** SQLITE_NOMEM.
5646*/
drh76012942021-02-21 21:04:54 +00005647int sqlite3ExpandSubquery(Parse *pParse, SrcItem *pFrom){
dan86fb6e12018-05-16 20:58:07 +00005648 Select *pSel = pFrom->pSelect;
5649 Table *pTab;
5650
dan9a947222018-06-14 19:06:36 +00005651 assert( pSel );
dan86fb6e12018-05-16 20:58:07 +00005652 pFrom->pTab = pTab = sqlite3DbMallocZero(pParse->db, sizeof(Table));
dan9a947222018-06-14 19:06:36 +00005653 if( pTab==0 ) return SQLITE_NOMEM;
dan86fb6e12018-05-16 20:58:07 +00005654 pTab->nTabRef = 1;
5655 if( pFrom->zAlias ){
5656 pTab->zName = sqlite3DbStrDup(pParse->db, pFrom->zAlias);
5657 }else{
drhd6bb6002022-04-22 18:07:38 +00005658 pTab->zName = sqlite3MPrintf(pParse->db, "%!S", pFrom);
dan86fb6e12018-05-16 20:58:07 +00005659 }
5660 while( pSel->pPrior ){ pSel = pSel->pPrior; }
5661 sqlite3ColumnsFromExprList(pParse, pSel->pEList,&pTab->nCol,&pTab->aCol);
5662 pTab->iPKey = -1;
5663 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drh6e5020e2021-04-07 15:45:01 +00005664#ifndef SQLITE_ALLOW_ROWID_IN_VIEW
5665 /* The usual case - do not allow ROWID on a subquery */
5666 pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
5667#else
5668 pTab->tabFlags |= TF_Ephemeral; /* Legacy compatibility mode */
5669#endif
drhf4b33152019-04-23 12:30:15 +00005670 return pParse->nErr ? SQLITE_ERROR : SQLITE_OK;
dan86fb6e12018-05-16 20:58:07 +00005671}
5672
drh4ce7bf92022-04-15 18:30:48 +00005673
5674/*
5675** Check the N SrcItem objects to the right of pBase. (N might be zero!)
5676** If any of those SrcItem objects have a USING clause containing zName
5677** then return true.
5678**
5679** If N is zero, or none of the N SrcItem objects to the right of pBase
5680** contains a USING clause, or if none of the USING clauses contain zName,
5681** then return false.
5682*/
5683static int inAnyUsingClause(
5684 const char *zName, /* Name we are looking for */
5685 SrcItem *pBase, /* The base SrcItem. Looking at pBase[1] and following */
5686 int N /* How many SrcItems to check */
5687){
5688 while( N>0 ){
5689 N--;
5690 pBase++;
5691 if( pBase->fg.isUsing==0 ) continue;
drhe32d6a02022-04-19 15:56:03 +00005692 if( NEVER(pBase->u3.pUsing==0) ) continue;
drh4ce7bf92022-04-15 18:30:48 +00005693 if( sqlite3IdListIndex(pBase->u3.pUsing, zName)>=0 ) return 1;
5694 }
5695 return 0;
5696}
5697
5698
danielk1977b1c685b2008-10-06 16:18:39 +00005699/*
drh7d10d5a2008-08-20 16:35:10 +00005700** This routine is a Walker callback for "expanding" a SELECT statement.
5701** "Expanding" means to do the following:
5702**
5703** (1) Make sure VDBE cursor numbers have been assigned to every
5704** element of the FROM clause.
5705**
5706** (2) Fill in the pTabList->a[].pTab fields in the SrcList that
5707** defines FROM clause. When views appear in the FROM clause,
5708** fill pTabList->a[].pSelect with a copy of the SELECT statement
5709** that implements the view. A copy is made of the view's SELECT
5710** statement so that we can freely modify or delete that statement
peter.d.reid60ec9142014-09-06 16:39:46 +00005711** without worrying about messing up the persistent representation
drh7d10d5a2008-08-20 16:35:10 +00005712** of the view.
5713**
peter.d.reid60ec9142014-09-06 16:39:46 +00005714** (3) Add terms to the WHERE clause to accommodate the NATURAL keyword
drh7d10d5a2008-08-20 16:35:10 +00005715** on joins and the ON and USING clause of joins.
5716**
5717** (4) Scan the list of columns in the result set (pEList) looking
5718** for instances of the "*" operator or the TABLE.* operator.
5719** If found, expand each "*" to be every column in every table
5720** and TABLE.* to be every column in TABLE.
5721**
danielk1977b3bce662005-01-29 08:32:43 +00005722*/
drh7d10d5a2008-08-20 16:35:10 +00005723static int selectExpander(Walker *pWalker, Select *p){
5724 Parse *pParse = pWalker->pParse;
drh5abe1d32021-02-21 01:19:42 +00005725 int i, j, k, rc;
drh7d10d5a2008-08-20 16:35:10 +00005726 SrcList *pTabList;
5727 ExprList *pEList;
drh76012942021-02-21 21:04:54 +00005728 SrcItem *pFrom;
drh7d10d5a2008-08-20 16:35:10 +00005729 sqlite3 *db = pParse->db;
drh3e3f1a52013-01-03 00:45:56 +00005730 Expr *pE, *pRight, *pExpr;
drh785097d2013-02-12 22:09:48 +00005731 u16 selFlags = p->selFlags;
drhfca23552017-10-28 20:51:54 +00005732 u32 elistFlags = 0;
danielk1977b3bce662005-01-29 08:32:43 +00005733
drh785097d2013-02-12 22:09:48 +00005734 p->selFlags |= SF_Expanded;
drh7d10d5a2008-08-20 16:35:10 +00005735 if( db->mallocFailed ){
5736 return WRC_Abort;
danielk1977b3bce662005-01-29 08:32:43 +00005737 }
drh9d9c41e2017-10-31 03:40:15 +00005738 assert( p->pSrc!=0 );
5739 if( (selFlags & SF_Expanded)!=0 ){
drh7d10d5a2008-08-20 16:35:10 +00005740 return WRC_Prune;
danielk1977b3bce662005-01-29 08:32:43 +00005741 }
drh59145812019-05-22 22:49:23 +00005742 if( pWalker->eCode ){
5743 /* Renumber selId because it has been copied from a view */
5744 p->selId = ++pParse->nSelect;
5745 }
drh7d10d5a2008-08-20 16:35:10 +00005746 pTabList = p->pSrc;
danielk1977b3bce662005-01-29 08:32:43 +00005747 pEList = p->pEList;
dan90bc36f2021-05-20 17:15:06 +00005748 if( pParse->pWith && (p->selFlags & SF_View) ){
5749 if( p->pWith==0 ){
5750 p->pWith = (With*)sqlite3DbMallocZero(db, sizeof(With));
5751 if( p->pWith==0 ){
5752 return WRC_Abort;
5753 }
5754 }
5755 p->pWith->bView = 1;
5756 }
drha5746e02018-04-09 20:36:09 +00005757 sqlite3WithPush(pParse, p->pWith, 0);
drh7d10d5a2008-08-20 16:35:10 +00005758
5759 /* Make sure cursor numbers have been assigned to all entries in
5760 ** the FROM clause of the SELECT statement.
5761 */
5762 sqlite3SrcListAssignCursors(pParse, pTabList);
5763
5764 /* Look up every table named in the FROM clause of the select. If
5765 ** an entry of the FROM clause is a subquery instead of a table or view,
5766 ** then create a transient table structure to describe the subquery.
5767 */
5768 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5769 Table *pTab;
drhe2b7d7a2015-09-29 15:50:04 +00005770 assert( pFrom->fg.isRecursive==0 || pFrom->pTab!=0 );
dan69887c92020-04-27 20:55:33 +00005771 if( pFrom->pTab ) continue;
5772 assert( pFrom->fg.isRecursive==0 );
drh7d10d5a2008-08-20 16:35:10 +00005773 if( pFrom->zName==0 ){
5774#ifndef SQLITE_OMIT_SUBQUERY
5775 Select *pSel = pFrom->pSelect;
5776 /* A sub-query in the FROM clause of a SELECT */
5777 assert( pSel!=0 );
5778 assert( pFrom->pTab==0 );
drh2b8c5a02015-01-22 12:00:17 +00005779 if( sqlite3WalkSelect(pWalker, pSel) ) return WRC_Abort;
dandfa552f2018-06-02 21:04:28 +00005780 if( sqlite3ExpandSubquery(pParse, pFrom) ) return WRC_Abort;
dan86fb6e12018-05-16 20:58:07 +00005781#endif
drh5abe1d32021-02-21 01:19:42 +00005782#ifndef SQLITE_OMIT_CTE
5783 }else if( (rc = resolveFromTermToCte(pParse, pWalker, pFrom))!=0 ){
5784 if( rc>1 ) return WRC_Abort;
5785 pTab = pFrom->pTab;
5786 assert( pTab!=0 );
5787#endif
drh7d10d5a2008-08-20 16:35:10 +00005788 }else{
5789 /* An ordinary table or view name in the FROM clause */
5790 assert( pFrom->pTab==0 );
dan41fb5cd2012-10-04 19:33:00 +00005791 pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
drh7d10d5a2008-08-20 16:35:10 +00005792 if( pTab==0 ) return WRC_Abort;
drh79df7782016-12-14 14:07:35 +00005793 if( pTab->nTabRef>=0xffff ){
drhd2a56232013-01-28 19:00:20 +00005794 sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
5795 pTab->zName);
5796 pFrom->pTab = 0;
5797 return WRC_Abort;
5798 }
drh79df7782016-12-14 14:07:35 +00005799 pTab->nTabRef++;
drh20292312015-11-21 13:24:46 +00005800 if( !IsVirtual(pTab) && cannotBeFunction(pParse, pFrom) ){
5801 return WRC_Abort;
5802 }
dan8c812f92020-01-21 16:23:17 +00005803#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhf38524d2021-08-02 16:41:57 +00005804 if( !IsOrdinaryTable(pTab) ){
drhbfad7be2015-10-11 20:39:46 +00005805 i16 nCol;
drh59145812019-05-22 22:49:23 +00005806 u8 eCodeOrig = pWalker->eCode;
drh7d10d5a2008-08-20 16:35:10 +00005807 if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
drh43152cf2009-05-19 19:04:58 +00005808 assert( pFrom->pSelect==0 );
drhf38524d2021-08-02 16:41:57 +00005809 if( IsView(pTab) ){
5810 if( (db->flags & SQLITE_EnableView)==0
5811 && pTab->pSchema!=db->aDb[1].pSchema
5812 ){
5813 sqlite3ErrorMsg(pParse, "access to view \"%s\" prohibited",
5814 pTab->zName);
5815 }
5816 pFrom->pSelect = sqlite3SelectDup(db, pTab->u.view.pSelect, 0);
danafaa6602021-09-30 18:42:52 +00005817 }
dan8c812f92020-01-21 16:23:17 +00005818#ifndef SQLITE_OMIT_VIRTUALTABLE
danafaa6602021-09-30 18:42:52 +00005819 else if( ALWAYS(IsVirtual(pTab))
drh3f681422020-01-07 18:10:56 +00005820 && pFrom->fg.fromDDL
drhf38524d2021-08-02 16:41:57 +00005821 && ALWAYS(pTab->u.vtab.p!=0)
5822 && pTab->u.vtab.p->eVtabRisk > ((db->flags & SQLITE_TrustedSchema)!=0)
drh3f681422020-01-07 18:10:56 +00005823 ){
drh32266a12020-01-09 13:08:28 +00005824 sqlite3ErrorMsg(pParse, "unsafe use of virtual table \"%s\"",
5825 pTab->zName);
drh11d88e62019-08-15 21:27:20 +00005826 }
drhf38524d2021-08-02 16:41:57 +00005827 assert( SQLITE_VTABRISK_Normal==1 && SQLITE_VTABRISK_High==2 );
dan8c812f92020-01-21 16:23:17 +00005828#endif
drhbfad7be2015-10-11 20:39:46 +00005829 nCol = pTab->nCol;
5830 pTab->nCol = -1;
drh59145812019-05-22 22:49:23 +00005831 pWalker->eCode = 1; /* Turn on Select.selId renumbering */
drh43152cf2009-05-19 19:04:58 +00005832 sqlite3WalkSelect(pWalker, pFrom->pSelect);
drh59145812019-05-22 22:49:23 +00005833 pWalker->eCode = eCodeOrig;
drhbfad7be2015-10-11 20:39:46 +00005834 pTab->nCol = nCol;
drh7d10d5a2008-08-20 16:35:10 +00005835 }
5836#endif
danielk1977b3bce662005-01-29 08:32:43 +00005837 }
danielk197785574e32008-10-06 05:32:18 +00005838
5839 /* Locate the index named by the INDEXED BY clause, if any. */
drh18622712021-02-20 21:20:54 +00005840 if( pFrom->fg.isIndexedBy && sqlite3IndexedByLookup(pParse, pFrom) ){
danielk1977b1c685b2008-10-06 16:18:39 +00005841 return WRC_Abort;
danielk197785574e32008-10-06 05:32:18 +00005842 }
danielk1977b3bce662005-01-29 08:32:43 +00005843 }
5844
drh7d10d5a2008-08-20 16:35:10 +00005845 /* Process NATURAL keywords, and ON and USING clauses of joins.
danielk1977b3bce662005-01-29 08:32:43 +00005846 */
drh0c7d3d32022-01-24 16:47:12 +00005847 assert( db->mallocFailed==0 || pParse->nErr!=0 );
drh358424a2022-04-15 15:15:01 +00005848 if( pParse->nErr || sqlite3ProcessJoin(pParse, p) ){
drh7d10d5a2008-08-20 16:35:10 +00005849 return WRC_Abort;
danielk1977b3bce662005-01-29 08:32:43 +00005850 }
5851
drh7d10d5a2008-08-20 16:35:10 +00005852 /* For every "*" that occurs in the column list, insert the names of
5853 ** all columns in all tables. And for every TABLE.* insert the names
5854 ** of all columns in TABLE. The parser inserted a special expression
drh1a1d3cd2015-11-19 16:33:31 +00005855 ** with the TK_ASTERISK operator for each "*" that it found in the column
5856 ** list. The following code just has to locate the TK_ASTERISK
5857 ** expressions and expand each one to the list of all columns in
5858 ** all tables.
danielk1977b3bce662005-01-29 08:32:43 +00005859 **
drh7d10d5a2008-08-20 16:35:10 +00005860 ** The first loop just checks to see if there are any "*" operators
5861 ** that need expanding.
danielk1977b3bce662005-01-29 08:32:43 +00005862 */
drh7d10d5a2008-08-20 16:35:10 +00005863 for(k=0; k<pEList->nExpr; k++){
drh3e3f1a52013-01-03 00:45:56 +00005864 pE = pEList->a[k].pExpr;
drh1a1d3cd2015-11-19 16:33:31 +00005865 if( pE->op==TK_ASTERISK ) break;
drh43152cf2009-05-19 19:04:58 +00005866 assert( pE->op!=TK_DOT || pE->pRight!=0 );
5867 assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
drh1a1d3cd2015-11-19 16:33:31 +00005868 if( pE->op==TK_DOT && pE->pRight->op==TK_ASTERISK ) break;
drhfca23552017-10-28 20:51:54 +00005869 elistFlags |= pE->flags;
danielk1977b3bce662005-01-29 08:32:43 +00005870 }
drh7d10d5a2008-08-20 16:35:10 +00005871 if( k<pEList->nExpr ){
5872 /*
5873 ** If we get here it means the result set contains one or more "*"
5874 ** operators that need to be expanded. Loop through each expression
5875 ** in the result set and expand them one by one.
5876 */
5877 struct ExprList_item *a = pEList->a;
5878 ExprList *pNew = 0;
5879 int flags = pParse->db->flags;
5880 int longNames = (flags & SQLITE_FullColNames)!=0
drh38b384a2013-01-03 17:34:28 +00005881 && (flags & SQLITE_ShortColNames)==0;
5882
drh7d10d5a2008-08-20 16:35:10 +00005883 for(k=0; k<pEList->nExpr; k++){
drh3e3f1a52013-01-03 00:45:56 +00005884 pE = a[k].pExpr;
drhfca23552017-10-28 20:51:54 +00005885 elistFlags |= pE->flags;
drh3e3f1a52013-01-03 00:45:56 +00005886 pRight = pE->pRight;
5887 assert( pE->op!=TK_DOT || pRight!=0 );
drh1a1d3cd2015-11-19 16:33:31 +00005888 if( pE->op!=TK_ASTERISK
5889 && (pE->op!=TK_DOT || pRight->op!=TK_ASTERISK)
5890 ){
drh7d10d5a2008-08-20 16:35:10 +00005891 /* This particular expression does not need to be expanded.
5892 */
drhb7916a72009-05-27 10:31:29 +00005893 pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
drh7d10d5a2008-08-20 16:35:10 +00005894 if( pNew ){
drh41cee662019-12-12 20:22:34 +00005895 pNew->a[pNew->nExpr-1].zEName = a[k].zEName;
drhd88fd532022-05-02 20:49:30 +00005896 pNew->a[pNew->nExpr-1].fg.eEName = a[k].fg.eEName;
drh41cee662019-12-12 20:22:34 +00005897 a[k].zEName = 0;
drh7d10d5a2008-08-20 16:35:10 +00005898 }
5899 a[k].pExpr = 0;
drh7d10d5a2008-08-20 16:35:10 +00005900 }else{
5901 /* This expression is a "*" or a "TABLE.*" and needs to be
5902 ** expanded. */
5903 int tableSeen = 0; /* Set to 1 when TABLE matches */
drh3e3f1a52013-01-03 00:45:56 +00005904 char *zTName = 0; /* text of name of TABLE */
drh43152cf2009-05-19 19:04:58 +00005905 if( pE->op==TK_DOT ){
5906 assert( pE->pLeft!=0 );
drh33e619f2009-05-28 01:00:55 +00005907 assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
5908 zTName = pE->pLeft->u.zToken;
drh7d10d5a2008-08-20 16:35:10 +00005909 }
5910 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
drh9c2d7aa2022-04-22 12:46:46 +00005911 Table *pTab = pFrom->pTab; /* Table for this data source */
5912 ExprList *pNestedFrom; /* Result-set of a nested FROM clause */
5913 char *zTabName; /* AS name for this data source */
5914 const char *zSchemaName = 0; /* Schema name for this data source */
5915 int iDb; /* Schema index for this data src */
drh63879a22022-05-02 20:04:34 +00005916 IdList *pUsing; /* USING clause for pFrom[1] */
drh9c2d7aa2022-04-22 12:46:46 +00005917
5918 if( (zTabName = pFrom->zAlias)==0 ){
drh7d10d5a2008-08-20 16:35:10 +00005919 zTabName = pTab->zName;
5920 }
5921 if( db->mallocFailed ) break;
mistachkin07fae322022-07-06 23:50:01 +00005922 assert( (int)pFrom->fg.isNestedFrom == IsNestedFrom(pFrom->pSelect) );
drh815b7822022-04-20 15:07:39 +00005923 if( pFrom->fg.isNestedFrom ){
drh9c2d7aa2022-04-22 12:46:46 +00005924 assert( pFrom->pSelect!=0 );
5925 pNestedFrom = pFrom->pSelect->pEList;
5926 assert( pNestedFrom!=0 );
5927 assert( pNestedFrom->nExpr==pTab->nCol );
drh815b7822022-04-20 15:07:39 +00005928 }else{
drh3e3f1a52013-01-03 00:45:56 +00005929 if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
5930 continue;
5931 }
drh9c2d7aa2022-04-22 12:46:46 +00005932 pNestedFrom = 0;
drh3e3f1a52013-01-03 00:45:56 +00005933 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh69c33822016-08-18 14:33:11 +00005934 zSchemaName = iDb>=0 ? db->aDb[iDb].zDbSName : "*";
drh7d10d5a2008-08-20 16:35:10 +00005935 }
drh45e41b72022-04-22 23:18:21 +00005936 if( i+1<pTabList->nSrc
5937 && pFrom[1].fg.isUsing
5938 && (selFlags & SF_NestedFrom)!=0
5939 ){
5940 int ii;
drh72d620b2022-05-02 19:59:03 +00005941 pUsing = pFrom[1].u3.pUsing;
drh45e41b72022-04-22 23:18:21 +00005942 for(ii=0; ii<pUsing->nId; ii++){
5943 const char *zUName = pUsing->a[ii].zName;
5944 pRight = sqlite3Expr(db, TK_ID, zUName);
5945 pNew = sqlite3ExprListAppend(pParse, pNew, pRight);
5946 if( pNew ){
5947 struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
5948 assert( pX->zEName==0 );
5949 pX->zEName = sqlite3MPrintf(db,"..%s", zUName);
drhd88fd532022-05-02 20:49:30 +00005950 pX->fg.eEName = ENAME_TAB;
5951 pX->fg.bUsingTerm = 1;
drh45e41b72022-04-22 23:18:21 +00005952 }
5953 }
drh72d620b2022-05-02 19:59:03 +00005954 }else{
5955 pUsing = 0;
drh45e41b72022-04-22 23:18:21 +00005956 }
drh7d10d5a2008-08-20 16:35:10 +00005957 for(j=0; j<pTab->nCol; j++){
drhcf9d36d2021-08-02 18:03:43 +00005958 char *zName = pTab->aCol[j].zCnName;
drh18f86002022-04-21 13:11:26 +00005959 struct ExprList_item *pX; /* Newly added ExprList term */
drh7d10d5a2008-08-20 16:35:10 +00005960
drhc75e09c2013-01-03 16:54:20 +00005961 assert( zName );
drh9c2d7aa2022-04-22 12:46:46 +00005962 if( zTName
5963 && pNestedFrom
5964 && sqlite3MatchEName(&pNestedFrom->a[j], 0, zTName, 0)==0
drh3e3f1a52013-01-03 00:45:56 +00005965 ){
5966 continue;
5967 }
5968
drh80090f92015-11-19 17:55:11 +00005969 /* If a column is marked as 'hidden', omit it from the expanded
5970 ** result-set list unless the SELECT has the SF_IncludeHidden
5971 ** bit set.
drh7d10d5a2008-08-20 16:35:10 +00005972 */
drhadef1592022-05-10 00:24:01 +00005973 if( (p->selFlags & SF_IncludeHidden)==0
5974 && IsHiddenColumn(&pTab->aCol[j])
5975 ){
5976 continue;
5977 }
5978 if( (pTab->aCol[j].colFlags & COLFLAG_NOEXPAND)!=0
5979 && zTName==0
5980 && (selFlags & (SF_NestedFrom))==0
5981 ){
5982 continue;
drh7d10d5a2008-08-20 16:35:10 +00005983 }
drh3e3f1a52013-01-03 00:45:56 +00005984 tableSeen = 1;
drh7d10d5a2008-08-20 16:35:10 +00005985
drh45e41b72022-04-22 23:18:21 +00005986 if( i>0 && zTName==0 && (selFlags & SF_NestedFrom)==0 ){
drhd44f8b22022-04-07 01:11:13 +00005987 if( pFrom->fg.isUsing
5988 && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0
5989 ){
drh7d10d5a2008-08-20 16:35:10 +00005990 /* In a join with a USING clause, omit columns in the
5991 ** using clause from the table on the right. */
5992 continue;
5993 }
5994 }
drhb7916a72009-05-27 10:31:29 +00005995 pRight = sqlite3Expr(db, TK_ID, zName);
drhbefbb402022-04-19 23:00:32 +00005996 if( (pTabList->nSrc>1
5997 && ( (pFrom->fg.jointype & JT_LTORJ)==0
drhd63c07e2022-04-23 14:30:22 +00005998 || (selFlags & SF_NestedFrom)!=0
drhbefbb402022-04-19 23:00:32 +00005999 || !inAnyUsingClause(zName,pFrom,pTabList->nSrc-i-1)
6000 )
6001 )
6002 || IN_RENAME_OBJECT
drh4ce7bf92022-04-15 18:30:48 +00006003 ){
drhb7916a72009-05-27 10:31:29 +00006004 Expr *pLeft;
6005 pLeft = sqlite3Expr(db, TK_ID, zTabName);
drhabfd35e2016-12-06 22:47:23 +00006006 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight);
dancbde37d2022-04-19 20:47:18 +00006007 if( IN_RENAME_OBJECT && pE->pLeft ){
6008 sqlite3RenameTokenRemap(pParse, pLeft, pE->pLeft);
6009 }
drh38b384a2013-01-03 17:34:28 +00006010 if( zSchemaName ){
drhc75e09c2013-01-03 16:54:20 +00006011 pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
drhabfd35e2016-12-06 22:47:23 +00006012 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr);
drhc75e09c2013-01-03 16:54:20 +00006013 }
drh7d10d5a2008-08-20 16:35:10 +00006014 }else{
6015 pExpr = pRight;
drh7d10d5a2008-08-20 16:35:10 +00006016 }
drhb7916a72009-05-27 10:31:29 +00006017 pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
drh18f86002022-04-21 13:11:26 +00006018 if( pNew==0 ){
6019 break; /* OOM */
6020 }
6021 pX = &pNew->a[pNew->nExpr-1];
6022 assert( pX->zEName==0 );
6023 if( (selFlags & SF_NestedFrom)!=0 && !IN_RENAME_OBJECT ){
drh9c2d7aa2022-04-22 12:46:46 +00006024 if( pNestedFrom ){
6025 pX->zEName = sqlite3DbStrDup(db, pNestedFrom->a[j].zEName);
drhcbb9da32019-12-12 22:11:33 +00006026 testcase( pX->zEName==0 );
drh3e3f1a52013-01-03 00:45:56 +00006027 }else{
drhcbb9da32019-12-12 22:11:33 +00006028 pX->zEName = sqlite3MPrintf(db, "%s.%s.%s",
drh18f86002022-04-21 13:11:26 +00006029 zSchemaName, zTabName, zName);
drhcbb9da32019-12-12 22:11:33 +00006030 testcase( pX->zEName==0 );
drh3e3f1a52013-01-03 00:45:56 +00006031 }
drhd88fd532022-05-02 20:49:30 +00006032 pX->fg.eEName = ENAME_TAB;
drh72d620b2022-05-02 19:59:03 +00006033 if( (pFrom->fg.isUsing
6034 && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0)
6035 || (pUsing && sqlite3IdListIndex(pUsing, zName)>=0)
6036 || (pTab->aCol[j].colFlags & COLFLAG_NOEXPAND)!=0
6037 ){
drhd88fd532022-05-02 20:49:30 +00006038 pX->fg.bNoExpand = 1;
drh72d620b2022-05-02 19:59:03 +00006039 }
drh18f86002022-04-21 13:11:26 +00006040 }else if( longNames ){
6041 pX->zEName = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
drhd88fd532022-05-02 20:49:30 +00006042 pX->fg.eEName = ENAME_NAME;
drh18f86002022-04-21 13:11:26 +00006043 }else{
6044 pX->zEName = sqlite3DbStrDup(db, zName);
drhd88fd532022-05-02 20:49:30 +00006045 pX->fg.eEName = ENAME_NAME;
drh8f25d182012-12-19 02:36:45 +00006046 }
drh7d10d5a2008-08-20 16:35:10 +00006047 }
6048 }
6049 if( !tableSeen ){
6050 if( zTName ){
6051 sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
6052 }else{
6053 sqlite3ErrorMsg(pParse, "no tables specified");
6054 }
6055 }
drh7d10d5a2008-08-20 16:35:10 +00006056 }
drh9a993342007-12-13 02:45:31 +00006057 }
drh7d10d5a2008-08-20 16:35:10 +00006058 sqlite3ExprListDelete(db, pEList);
6059 p->pEList = pNew;
drh4c774312007-12-08 21:10:20 +00006060 }
drhfca23552017-10-28 20:51:54 +00006061 if( p->pEList ){
6062 if( p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
6063 sqlite3ErrorMsg(pParse, "too many columns in result set");
6064 return WRC_Abort;
6065 }
6066 if( (elistFlags & (EP_HasFunc|EP_Subquery))!=0 ){
6067 p->selFlags |= SF_ComplexResult;
6068 }
drh994c80a2007-04-12 21:25:01 +00006069 }
drhcebc8002022-04-16 18:33:22 +00006070#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00006071 if( sqlite3TreeTrace & 0x8 ){
6072 TREETRACE(0x8,pParse,p,("After result-set wildcard expansion:\n"));
drhcebc8002022-04-16 18:33:22 +00006073 sqlite3TreeViewSelect(0, p, 0);
6074 }
6075#endif
drh7d10d5a2008-08-20 16:35:10 +00006076 return WRC_Continue;
6077}
danielk1977b3bce662005-01-29 08:32:43 +00006078
drh979dd1b2017-05-29 14:26:07 +00006079#if SQLITE_DEBUG
6080/*
6081** Always assert. This xSelectCallback2 implementation proves that the
6082** xSelectCallback2 is never invoked.
6083*/
6084void sqlite3SelectWalkAssert2(Walker *NotUsed, Select *NotUsed2){
6085 UNUSED_PARAMETER2(NotUsed, NotUsed2);
6086 assert( 0 );
6087}
6088#endif
6089/*
drh7d10d5a2008-08-20 16:35:10 +00006090** This routine "expands" a SELECT statement and all of its subqueries.
6091** For additional information on what it means to "expand" a SELECT
6092** statement, see the comment on the selectExpand worker callback above.
6093**
6094** Expanding a SELECT statement is the first step in processing a
6095** SELECT statement. The SELECT statement must be expanded before
6096** name resolution is performed.
6097**
6098** If anything goes wrong, an error message is written into pParse.
6099** The calling function can detect the problem by looking at pParse->nErr
6100** and/or pParse->db->mallocFailed.
6101*/
6102static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
6103 Walker w;
drh5b88bc42013-12-07 23:35:21 +00006104 w.xExprCallback = sqlite3ExprWalkNoop;
drh7d10d5a2008-08-20 16:35:10 +00006105 w.pParse = pParse;
drh878fcf92017-10-02 23:50:08 +00006106 if( OK_IF_ALWAYS_TRUE(pParse->hasCompound) ){
drhd58d3272013-08-05 22:05:02 +00006107 w.xSelectCallback = convertCompoundSelectToSubquery;
drh979dd1b2017-05-29 14:26:07 +00006108 w.xSelectCallback2 = 0;
drhd58d3272013-08-05 22:05:02 +00006109 sqlite3WalkSelect(&w, pSelect);
6110 }
drhc01b7302013-05-07 17:49:08 +00006111 w.xSelectCallback = selectExpander;
danbe120832021-05-17 16:20:41 +00006112 w.xSelectCallback2 = sqlite3SelectPopWith;
drh59145812019-05-22 22:49:23 +00006113 w.eCode = 0;
drhc01b7302013-05-07 17:49:08 +00006114 sqlite3WalkSelect(&w, pSelect);
drh7d10d5a2008-08-20 16:35:10 +00006115}
6116
6117
6118#ifndef SQLITE_OMIT_SUBQUERY
6119/*
6120** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
6121** interface.
6122**
6123** For each FROM-clause subquery, add Column.zType and Column.zColl
6124** information to the Table structure that represents the result set
6125** of that subquery.
6126**
6127** The Table structure that represents the result set was constructed
6128** by selectExpander() but the type and collation information was omitted
6129** at that point because identifiers had not yet been resolved. This
6130** routine is called after identifier resolution.
6131*/
danb290f112014-01-17 14:59:27 +00006132static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
drh7d10d5a2008-08-20 16:35:10 +00006133 Parse *pParse;
6134 int i;
6135 SrcList *pTabList;
drh76012942021-02-21 21:04:54 +00006136 SrcItem *pFrom;
drh7d10d5a2008-08-20 16:35:10 +00006137
drh9d8b3072008-08-22 16:29:51 +00006138 assert( p->selFlags & SF_Resolved );
dancc464412018-06-19 18:11:05 +00006139 if( p->selFlags & SF_HasTypeInfo ) return;
drhe2b7d7a2015-09-29 15:50:04 +00006140 p->selFlags |= SF_HasTypeInfo;
6141 pParse = pWalker->pParse;
6142 pTabList = p->pSrc;
6143 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
6144 Table *pTab = pFrom->pTab;
6145 assert( pTab!=0 );
6146 if( (pTab->tabFlags & TF_Ephemeral)!=0 ){
6147 /* A sub-query in the FROM clause of a SELECT */
6148 Select *pSel = pFrom->pSelect;
6149 if( pSel ){
6150 while( pSel->pPrior ) pSel = pSel->pPrior;
drh96fb16e2019-08-06 14:37:24 +00006151 sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSel,
6152 SQLITE_AFF_NONE);
drh5a29d9c2010-02-24 15:10:14 +00006153 }
drh13449892005-09-07 21:22:45 +00006154 }
6155 }
drh7d10d5a2008-08-20 16:35:10 +00006156}
6157#endif
drh13449892005-09-07 21:22:45 +00006158
drh7d10d5a2008-08-20 16:35:10 +00006159
6160/*
6161** This routine adds datatype and collating sequence information to
6162** the Table structures of all FROM-clause subqueries in a
6163** SELECT statement.
6164**
6165** Use this routine after name resolution.
6166*/
6167static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
6168#ifndef SQLITE_OMIT_SUBQUERY
6169 Walker w;
drh979dd1b2017-05-29 14:26:07 +00006170 w.xSelectCallback = sqlite3SelectWalkNoop;
danb290f112014-01-17 14:59:27 +00006171 w.xSelectCallback2 = selectAddSubqueryTypeInfo;
drh5b88bc42013-12-07 23:35:21 +00006172 w.xExprCallback = sqlite3ExprWalkNoop;
drh7d10d5a2008-08-20 16:35:10 +00006173 w.pParse = pParse;
6174 sqlite3WalkSelect(&w, pSelect);
6175#endif
6176}
6177
6178
6179/*
drh030796d2012-08-23 16:18:10 +00006180** This routine sets up a SELECT statement for processing. The
drh7d10d5a2008-08-20 16:35:10 +00006181** following is accomplished:
6182**
6183** * VDBE Cursor numbers are assigned to all FROM-clause terms.
6184** * Ephemeral Table objects are created for all FROM-clause subqueries.
6185** * ON and USING clauses are shifted into WHERE statements
6186** * Wildcards "*" and "TABLE.*" in result sets are expanded.
6187** * Identifiers in expression are matched to tables.
6188**
6189** This routine acts recursively on all subqueries within the SELECT.
6190*/
6191void sqlite3SelectPrep(
6192 Parse *pParse, /* The parser context */
6193 Select *p, /* The SELECT statement being coded. */
6194 NameContext *pOuterNC /* Name context for container */
6195){
drhe2463392017-10-03 14:24:24 +00006196 assert( p!=0 || pParse->db->mallocFailed );
drh0c7d3d32022-01-24 16:47:12 +00006197 assert( pParse->db->pParse==pParse );
drhe2463392017-10-03 14:24:24 +00006198 if( pParse->db->mallocFailed ) return;
drh7d10d5a2008-08-20 16:35:10 +00006199 if( p->selFlags & SF_HasTypeInfo ) return;
drh7d10d5a2008-08-20 16:35:10 +00006200 sqlite3SelectExpand(pParse, p);
drh0c7d3d32022-01-24 16:47:12 +00006201 if( pParse->nErr ) return;
drh7d10d5a2008-08-20 16:35:10 +00006202 sqlite3ResolveSelectNames(pParse, p, pOuterNC);
drh0c7d3d32022-01-24 16:47:12 +00006203 if( pParse->nErr ) return;
drh7d10d5a2008-08-20 16:35:10 +00006204 sqlite3SelectAddTypeInfo(pParse, p);
danielk1977b3bce662005-01-29 08:32:43 +00006205}
6206
drhc6138e92022-11-23 14:13:39 +00006207#if TREETRACE_ENABLED
danielk1977b3bce662005-01-29 08:32:43 +00006208/*
drhc6138e92022-11-23 14:13:39 +00006209** Display all information about an AggInfo object
6210*/
6211static void printAggInfo(AggInfo *pAggInfo){
6212 int ii;
6213 for(ii=0; ii<pAggInfo->nColumn; ii++){
6214 struct AggInfo_col *pCol = &pAggInfo->aCol[ii];
6215 sqlite3DebugPrintf(
6216 "agg-column[%d] pTab=%s iTable=%d iColumn=%d iMem=%d"
6217 " iSorterColumn=%d %s\n",
6218 ii, pCol->pTab ? pCol->pTab->zName : "NULL",
6219 pCol->iTable, pCol->iColumn, AggInfoColumnReg(pAggInfo,ii),
6220 pCol->iSorterColumn,
6221 ii>=pAggInfo->nAccumulator ? "" : " Accumulator");
6222 sqlite3TreeViewExpr(0, pAggInfo->aCol[ii].pCExpr, 0);
6223 }
6224 for(ii=0; ii<pAggInfo->nFunc; ii++){
drh2e30d952022-11-23 18:51:04 +00006225 sqlite3DebugPrintf("agg-func[%d]: iMem=%d\n",
drhc6138e92022-11-23 14:13:39 +00006226 ii, AggInfoFuncReg(pAggInfo,ii));
6227 sqlite3TreeViewExpr(0, pAggInfo->aFunc[ii].pFExpr, 0);
6228 }
6229}
6230#endif /* TREETRACE_ENABLED */
6231
6232/*
6233** Analyze the arguments to aggregate functions. Create new pAggInfo->aCol[]
6234** entries for columns that are arguments to aggregate functions but which
6235** are not otherwise used.
6236**
6237** The aCol[] entries in AggInfo prior to nAccumulator are columns that
6238** are referenced outside of aggregate functions. These might be columns
6239** that are part of the GROUP by clause, for example. Other database engines
6240** would throw an error if there is a column reference that is not in the
6241** GROUP BY clause and that is not part of an aggregate function argument.
6242** But SQLite allows this.
6243**
6244** The aCol[] entries beginning with the aCol[nAccumulator] and following
6245** are column references that are used exclusively as arguments to
6246** aggregate functions. This routine is responsible for computing
6247** (or recomputing) those aCol[] entries.
6248*/
6249static void analyzeAggFuncArgs(
6250 Parse *pParse,
6251 AggInfo *pAggInfo,
6252 NameContext *pNC
6253){
6254 int i;
6255 assert( pAggInfo!=0 );
drh7960da02022-11-25 13:08:20 +00006256 assert( pAggInfo->iFirstReg==0 );
drhc6138e92022-11-23 14:13:39 +00006257 pNC->ncFlags |= NC_InAggFunc;
6258 for(i=0; i<pAggInfo->nFunc; i++){
6259 Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
6260 assert( ExprUseXList(pExpr) );
6261 sqlite3ExprAnalyzeAggList(pNC, pExpr->x.pList);
6262#ifndef SQLITE_OMIT_WINDOWFUNC
6263 assert( !IsWindowFunc(pExpr) );
6264 if( ExprHasProperty(pExpr, EP_WinFunc) ){
6265 sqlite3ExprAnalyzeAggregates(pNC, pExpr->y.pWin->pFilter);
6266 }
6267#endif
6268 }
6269 pNC->ncFlags &= ~NC_InAggFunc;
6270}
6271
6272/*
6273** An index on expressions is being used in the inner loop of an
6274** aggregate query with a GROUP BY clause. This routine attempts
6275** to adjust the AggInfo object to take advantage of index and to
6276** perhaps use the index as a covering index.
6277**
6278*/
6279static void optimizeAggregateUseOfIndexedExpr(
6280 Parse *pParse, /* Parsing context */
6281 Select *pSelect, /* The SELECT statement being processed */
6282 AggInfo *pAggInfo, /* The aggregate info */
6283 NameContext *pNC /* Name context used to resolve agg-func args */
6284){
drh7960da02022-11-25 13:08:20 +00006285 assert( pAggInfo->iFirstReg==0 );
drh590f0132022-11-23 17:56:00 +00006286 pAggInfo->nColumn = pAggInfo->nAccumulator;
drhc25f5ea2022-11-24 15:04:23 +00006287 if( ALWAYS(pAggInfo->nSortingColumn>0) ){
drh590f0132022-11-23 17:56:00 +00006288 if( pAggInfo->nColumn==0 ){
6289 pAggInfo->nSortingColumn = 0;
6290 }else{
6291 pAggInfo->nSortingColumn =
6292 pAggInfo->aCol[pAggInfo->nColumn-1].iSorterColumn+1;
6293 }
6294 }
6295 analyzeAggFuncArgs(pParse, pAggInfo, pNC);
drhc6138e92022-11-23 14:13:39 +00006296#if TREETRACE_ENABLED
drh590f0132022-11-23 17:56:00 +00006297 if( sqlite3TreeTrace & 0x20 ){
drhc6138e92022-11-23 14:13:39 +00006298 IndexedExpr *pIEpr;
drh590f0132022-11-23 17:56:00 +00006299 TREETRACE(0x20, pParse, pSelect,
6300 ("AggInfo (possibly) adjusted for Indexed Exprs\n"));
6301 sqlite3TreeViewSelect(0, pSelect, 0);
drhc6138e92022-11-23 14:13:39 +00006302 for(pIEpr=pParse->pIdxEpr; pIEpr; pIEpr=pIEpr->pIENext){
6303 printf("data-cursor=%d index={%d,%d}\n",
6304 pIEpr->iDataCur, pIEpr->iIdxCur, pIEpr->iIdxCol);
6305 sqlite3TreeViewExpr(0, pIEpr->pExpr, 0);
6306 }
6307 printAggInfo(pAggInfo);
6308 }
6309#else
6310 (void)pSelect; /* Suppress unused-parameter warnings */
6311#endif
drhc6138e92022-11-23 14:13:39 +00006312}
6313
6314/*
drh2e30d952022-11-23 18:51:04 +00006315** Walker callback for aggregateConvertIndexedExprRefToColumn().
6316*/
6317static int aggregateIdxEprRefToColCallback(Walker *pWalker, Expr *pExpr){
6318 AggInfo *pAggInfo;
6319 struct AggInfo_col *pCol;
6320 if( pExpr->pAggInfo==0 ) return WRC_Continue;
6321 if( pExpr->op==TK_AGG_COLUMN ) return WRC_Continue;
6322 if( pExpr->op==TK_AGG_FUNCTION ) return WRC_Continue;
drh8683c092022-11-24 23:35:27 +00006323 if( pExpr->op==TK_IF_NULL_ROW ) return WRC_Continue;
drh2e30d952022-11-23 18:51:04 +00006324 pAggInfo = pExpr->pAggInfo;
6325 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
6326 pCol = &pAggInfo->aCol[pExpr->iAgg];
6327 pExpr->op = TK_AGG_COLUMN;
6328 pExpr->iTable = pCol->iTable;
6329 pExpr->iColumn = pCol->iColumn;
6330 return WRC_Prune;
6331}
6332
6333/*
6334** Convert every pAggInfo->aFunc[].pExpr such that any node within
6335** those expressions that has pAppInfo set is changed into a TK_AGG_COLUMN
6336** opcode.
6337*/
6338static void aggregateConvertIndexedExprRefToColumn(AggInfo *pAggInfo){
6339 int i;
6340 Walker w;
6341 memset(&w, 0, sizeof(w));
6342 w.xExprCallback = aggregateIdxEprRefToColCallback;
6343 for(i=0; i<pAggInfo->nFunc; i++){
6344 sqlite3WalkExpr(&w, pAggInfo->aFunc[i].pFExpr);
6345 }
6346}
6347
6348
6349/*
drhc6138e92022-11-23 14:13:39 +00006350** Allocate a block of registers so that there is one register for each
6351** pAggInfo->aCol[] and pAggInfo->aFunc[] entry in pAggInfo. The first
6352** register in this block is stored in pAggInfo->iFirstReg.
drh7960da02022-11-25 13:08:20 +00006353**
6354** This routine may only be called once for each AggInfo object. Prior
6355** to calling this routine:
6356**
6357** * The aCol[] and aFunc[] arrays may be modified
6358** * The AggInfoColumnReg() and AggInfoFuncReg() macros may not be used
6359**
6360** After clling this routine:
6361**
6362** * The aCol[] and aFunc[] arrays are fixed
6363** * The AggInfoColumnReg() and AggInfoFuncReg() macros may be used
6364**
drh42b78232022-11-22 14:10:22 +00006365*/
6366static void assignAggregateRegisters(Parse *pParse, AggInfo *pAggInfo){
drh42b78232022-11-22 14:10:22 +00006367 assert( pAggInfo!=0 );
drh3c8e4382022-11-22 15:43:16 +00006368 assert( pAggInfo->iFirstReg==0 );
6369 pAggInfo->iFirstReg = pParse->nMem + 1;
6370 pParse->nMem += pAggInfo->nColumn + pAggInfo->nFunc;
drh42b78232022-11-22 14:10:22 +00006371}
6372
6373/*
drh13449892005-09-07 21:22:45 +00006374** Reset the aggregate accumulator.
6375**
6376** The aggregate accumulator is a set of memory cells that hold
6377** intermediate results while calculating an aggregate. This
drh030796d2012-08-23 16:18:10 +00006378** routine generates code that stores NULLs in all of those memory
6379** cells.
danielk1977b3bce662005-01-29 08:32:43 +00006380*/
drh13449892005-09-07 21:22:45 +00006381static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
6382 Vdbe *v = pParse->pVdbe;
6383 int i;
drhc99130f2005-09-11 11:56:27 +00006384 struct AggInfo_func *pFunc;
drh7e61d182013-12-20 13:11:45 +00006385 int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
drh7960da02022-11-25 13:08:20 +00006386 assert( pAggInfo->iFirstReg>0 );
drh0c7d3d32022-01-24 16:47:12 +00006387 assert( pParse->db->pParse==pParse );
6388 assert( pParse->db->mallocFailed==0 || pParse->nErr!=0 );
drh7e61d182013-12-20 13:11:45 +00006389 if( nReg==0 ) return;
drh0c7d3d32022-01-24 16:47:12 +00006390 if( pParse->nErr ) return;
drh3c8e4382022-11-22 15:43:16 +00006391 sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->iFirstReg,
6392 pAggInfo->iFirstReg+nReg-1);
drhc99130f2005-09-11 11:56:27 +00006393 for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
drhc99130f2005-09-11 11:56:27 +00006394 if( pFunc->iDistinct>=0 ){
drh81185a52020-06-09 13:38:12 +00006395 Expr *pE = pFunc->pFExpr;
drha4eeccd2021-10-07 17:43:30 +00006396 assert( ExprUseXList(pE) );
danielk19776ab3a2e2009-02-19 14:39:25 +00006397 if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
drh0daa0022009-02-09 13:19:28 +00006398 sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
6399 "argument");
drhc99130f2005-09-11 11:56:27 +00006400 pFunc->iDistinct = -1;
6401 }else{
danf9eae182018-05-21 19:45:11 +00006402 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pE->x.pList,0,0);
dan4fcb30b2021-03-09 16:06:25 +00006403 pFunc->iDistAddr = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
6404 pFunc->iDistinct, 0, 0, (char*)pKeyInfo, P4_KEYINFO);
drh9be13392021-03-24 19:44:01 +00006405 ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s(DISTINCT)",
6406 pFunc->pFunc->zName));
drhc99130f2005-09-11 11:56:27 +00006407 }
6408 }
drh13449892005-09-07 21:22:45 +00006409 }
danielk1977b3bce662005-01-29 08:32:43 +00006410}
6411
6412/*
drh13449892005-09-07 21:22:45 +00006413** Invoke the OP_AggFinalize opcode for every aggregate function
6414** in the AggInfo structure.
danielk1977b3bce662005-01-29 08:32:43 +00006415*/
drh13449892005-09-07 21:22:45 +00006416static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
6417 Vdbe *v = pParse->pVdbe;
6418 int i;
6419 struct AggInfo_func *pF;
6420 for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
drha4eeccd2021-10-07 17:43:30 +00006421 ExprList *pList;
6422 assert( ExprUseXList(pF->pFExpr) );
6423 pList = pF->pFExpr->x.pList;
drh3c8e4382022-11-22 15:43:16 +00006424 sqlite3VdbeAddOp2(v, OP_AggFinal, AggInfoFuncReg(pAggInfo,i),
6425 pList ? pList->nExpr : 0);
drh2700aca2016-12-08 01:38:24 +00006426 sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
drh13449892005-09-07 21:22:45 +00006427 }
danielk1977b3bce662005-01-29 08:32:43 +00006428}
drh13449892005-09-07 21:22:45 +00006429
dan280c8942018-06-05 20:04:28 +00006430
drh13449892005-09-07 21:22:45 +00006431/*
drhf5d06562022-11-25 13:15:48 +00006432** Generate code that will update the accumulator memory cells for an
6433** aggregate based on the current cursor position.
dan280c8942018-06-05 20:04:28 +00006434**
6435** If regAcc is non-zero and there are no min() or max() aggregates
6436** in pAggInfo, then only populate the pAggInfo->nAccumulator accumulator
drh10cc16c2019-03-01 21:12:40 +00006437** registers if register regAcc contains 0. The caller will take care
dan280c8942018-06-05 20:04:28 +00006438** of setting and clearing regAcc.
drh13449892005-09-07 21:22:45 +00006439*/
dan4fcb30b2021-03-09 16:06:25 +00006440static void updateAccumulator(
6441 Parse *pParse,
6442 int regAcc,
6443 AggInfo *pAggInfo,
6444 int eDistinctType
6445){
drh13449892005-09-07 21:22:45 +00006446 Vdbe *v = pParse->pVdbe;
6447 int i;
drh7a957892012-02-02 17:35:43 +00006448 int regHit = 0;
6449 int addrHitTest = 0;
drh13449892005-09-07 21:22:45 +00006450 struct AggInfo_func *pF;
6451 struct AggInfo_col *pC;
drh13449892005-09-07 21:22:45 +00006452
drh7960da02022-11-25 13:08:20 +00006453 assert( pAggInfo->iFirstReg>0 );
drhf5d06562022-11-25 13:15:48 +00006454 if( pParse->nErr ) return;
drh13449892005-09-07 21:22:45 +00006455 pAggInfo->directMode = 1;
6456 for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
6457 int nArg;
drhc99130f2005-09-11 11:56:27 +00006458 int addrNext = 0;
drh98757152008-01-09 23:04:12 +00006459 int regAgg;
drha4eeccd2021-10-07 17:43:30 +00006460 ExprList *pList;
6461 assert( ExprUseXList(pF->pFExpr) );
drh81185a52020-06-09 13:38:12 +00006462 assert( !IsWindowFunc(pF->pFExpr) );
drha4eeccd2021-10-07 17:43:30 +00006463 pList = pF->pFExpr->x.pList;
drh81185a52020-06-09 13:38:12 +00006464 if( ExprHasProperty(pF->pFExpr, EP_WinFunc) ){
6465 Expr *pFilter = pF->pFExpr->y.pWin->pFilter;
daned09ddd2019-09-20 20:52:16 +00006466 if( pAggInfo->nAccumulator
6467 && (pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL)
danfa4b0d42020-07-01 14:07:45 +00006468 && regAcc
daned09ddd2019-09-20 20:52:16 +00006469 ){
danfa4b0d42020-07-01 14:07:45 +00006470 /* If regAcc==0, there there exists some min() or max() function
6471 ** without a FILTER clause that will ensure the magnet registers
6472 ** are populated. */
daned09ddd2019-09-20 20:52:16 +00006473 if( regHit==0 ) regHit = ++pParse->nMem;
danfa4b0d42020-07-01 14:07:45 +00006474 /* If this is the first row of the group (regAcc contains 0), clear the
daned09ddd2019-09-20 20:52:16 +00006475 ** "magnet" register regHit so that the accumulator registers
danaf9b58b2019-09-20 21:12:40 +00006476 ** are populated if the FILTER clause jumps over the the
6477 ** invocation of min() or max() altogether. Or, if this is not
danfa4b0d42020-07-01 14:07:45 +00006478 ** the first row (regAcc contains 1), set the magnet register so that
6479 ** the accumulators are not populated unless the min()/max() is invoked
6480 ** and indicates that they should be. */
daned09ddd2019-09-20 20:52:16 +00006481 sqlite3VdbeAddOp2(v, OP_Copy, regAcc, regHit);
6482 }
dan6ba7ab02019-07-02 11:56:47 +00006483 addrNext = sqlite3VdbeMakeLabel(pParse);
6484 sqlite3ExprIfFalse(pParse, pFilter, addrNext, SQLITE_JUMPIFNULL);
6485 }
drh13449892005-09-07 21:22:45 +00006486 if( pList ){
6487 nArg = pList->nExpr;
drh892d3172008-01-10 03:46:36 +00006488 regAgg = sqlite3GetTempRange(pParse, nArg);
drh5579d592015-08-26 14:01:41 +00006489 sqlite3ExprCodeExprList(pParse, pList, regAgg, 0, SQLITE_ECEL_DUP);
drh13449892005-09-07 21:22:45 +00006490 }else{
6491 nArg = 0;
drh98757152008-01-09 23:04:12 +00006492 regAgg = 0;
drh13449892005-09-07 21:22:45 +00006493 }
dan4fcb30b2021-03-09 16:06:25 +00006494 if( pF->iDistinct>=0 && pList ){
dan6ba7ab02019-07-02 11:56:47 +00006495 if( addrNext==0 ){
6496 addrNext = sqlite3VdbeMakeLabel(pParse);
6497 }
dan5383db72021-03-12 18:24:31 +00006498 pF->iDistinct = codeDistinct(pParse, eDistinctType,
6499 pF->iDistinct, addrNext, pList, regAgg);
drhc99130f2005-09-11 11:56:27 +00006500 }
drhd36e1042013-09-06 13:10:12 +00006501 if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh13449892005-09-07 21:22:45 +00006502 CollSeq *pColl = 0;
6503 struct ExprList_item *pItem;
6504 int j;
drhe82f5d02008-10-07 19:53:14 +00006505 assert( pList!=0 ); /* pList!=0 if pF->pFunc has NEEDCOLL */
drh43617e92006-03-06 20:55:46 +00006506 for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
drh13449892005-09-07 21:22:45 +00006507 pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
6508 }
6509 if( !pColl ){
6510 pColl = pParse->db->pDfltColl;
6511 }
drh7a957892012-02-02 17:35:43 +00006512 if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
6513 sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
drh13449892005-09-07 21:22:45 +00006514 }
drh3c8e4382022-11-22 15:43:16 +00006515 sqlite3VdbeAddOp3(v, OP_AggStep, 0, regAgg, AggInfoFuncReg(pAggInfo,i));
drh2700aca2016-12-08 01:38:24 +00006516 sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
drhea678832008-12-10 19:26:22 +00006517 sqlite3VdbeChangeP5(v, (u8)nArg);
drhf49f3522009-12-30 14:12:38 +00006518 sqlite3ReleaseTempRange(pParse, regAgg, nArg);
drhc99130f2005-09-11 11:56:27 +00006519 if( addrNext ){
6520 sqlite3VdbeResolveLabel(v, addrNext);
6521 }
drh13449892005-09-07 21:22:45 +00006522 }
dan280c8942018-06-05 20:04:28 +00006523 if( regHit==0 && pAggInfo->nAccumulator ){
6524 regHit = regAcc;
6525 }
drh7a957892012-02-02 17:35:43 +00006526 if( regHit ){
drh688852a2014-02-17 22:40:43 +00006527 addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
drh7a957892012-02-02 17:35:43 +00006528 }
drh13449892005-09-07 21:22:45 +00006529 for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
drh3c8e4382022-11-22 15:43:16 +00006530 sqlite3ExprCode(pParse, pC->pCExpr, AggInfoColumnReg(pAggInfo,i));
drh13449892005-09-07 21:22:45 +00006531 }
daned09ddd2019-09-20 20:52:16 +00006532
drh13449892005-09-07 21:22:45 +00006533 pAggInfo->directMode = 0;
drh7a957892012-02-02 17:35:43 +00006534 if( addrHitTest ){
drhdc4f6fc2020-02-07 19:44:13 +00006535 sqlite3VdbeJumpHereOrPopInst(v, addrHitTest);
drh7a957892012-02-02 17:35:43 +00006536 }
drh13449892005-09-07 21:22:45 +00006537}
6538
danielk1977b3bce662005-01-29 08:32:43 +00006539/*
danef7075d2011-02-21 17:49:49 +00006540** Add a single OP_Explain instruction to the VDBE to explain a simple
6541** count(*) query ("SELECT count(*) FROM pTab").
6542*/
6543#ifndef SQLITE_OMIT_EXPLAIN
6544static void explainSimpleCount(
6545 Parse *pParse, /* Parse context */
6546 Table *pTab, /* Table being queried */
6547 Index *pIdx /* Index used to optimize scan, or NULL */
6548){
6549 if( pParse->explain==2 ){
drh48dd1d82014-05-27 18:18:58 +00006550 int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
drh82102332021-03-20 15:11:29 +00006551 sqlite3VdbeExplain(pParse, 0, "SCAN %s%s%s",
dane96f2df2014-05-23 17:17:06 +00006552 pTab->zName,
6553 bCover ? " USING COVERING INDEX " : "",
6554 bCover ? pIdx->zName : ""
danef7075d2011-02-21 17:49:49 +00006555 );
danef7075d2011-02-21 17:49:49 +00006556 }
6557}
6558#else
6559# define explainSimpleCount(a,b,c)
6560#endif
6561
6562/*
danab31a842017-04-29 20:53:09 +00006563** sqlite3WalkExpr() callback used by havingToWhere().
6564**
6565** If the node passed to the callback is a TK_AND node, return
6566** WRC_Continue to tell sqlite3WalkExpr() to iterate through child nodes.
6567**
6568** Otherwise, return WRC_Prune. In this case, also check if the
6569** sub-expression matches the criteria for being moved to the WHERE
6570** clause. If so, add it to the WHERE clause and replace the sub-expression
6571** within the HAVING expression with a constant "1".
6572*/
6573static int havingToWhereExprCb(Walker *pWalker, Expr *pExpr){
6574 if( pExpr->op!=TK_AND ){
drhcd0abc22018-03-20 18:08:33 +00006575 Select *pS = pWalker->u.pSelect;
dand59f9832021-07-20 14:57:49 +00006576 /* This routine is called before the HAVING clause of the current
6577 ** SELECT is analyzed for aggregates. So if pExpr->pAggInfo is set
6578 ** here, it indicates that the expression is a correlated reference to a
6579 ** column from an outer aggregate query, or an aggregate function that
6580 ** belongs to an outer query. Do not move the expression to the WHERE
6581 ** clause in this obscure case, as doing so may corrupt the outer Select
6582 ** statements AggInfo structure. */
danf39168e2020-12-22 16:23:29 +00006583 if( sqlite3ExprIsConstantOrGroupBy(pWalker->pParse, pExpr, pS->pGroupBy)
6584 && ExprAlwaysFalse(pExpr)==0
dand59f9832021-07-20 14:57:49 +00006585 && pExpr->pAggInfo==0
danf39168e2020-12-22 16:23:29 +00006586 ){
danab31a842017-04-29 20:53:09 +00006587 sqlite3 *db = pWalker->pParse->db;
drh5776ee52019-09-23 12:38:10 +00006588 Expr *pNew = sqlite3Expr(db, TK_INTEGER, "1");
danab31a842017-04-29 20:53:09 +00006589 if( pNew ){
drhcd0abc22018-03-20 18:08:33 +00006590 Expr *pWhere = pS->pWhere;
danab31a842017-04-29 20:53:09 +00006591 SWAP(Expr, *pNew, *pExpr);
drhd5c851c2019-04-19 13:38:34 +00006592 pNew = sqlite3ExprAnd(pWalker->pParse, pWhere, pNew);
drhcd0abc22018-03-20 18:08:33 +00006593 pS->pWhere = pNew;
6594 pWalker->eCode = 1;
danab31a842017-04-29 20:53:09 +00006595 }
6596 }
6597 return WRC_Prune;
6598 }
6599 return WRC_Continue;
6600}
6601
6602/*
6603** Transfer eligible terms from the HAVING clause of a query, which is
6604** processed after grouping, to the WHERE clause, which is processed before
6605** grouping. For example, the query:
6606**
6607** SELECT * FROM <tables> WHERE a=? GROUP BY b HAVING b=? AND c=?
6608**
6609** can be rewritten as:
6610**
6611** SELECT * FROM <tables> WHERE a=? AND b=? GROUP BY b HAVING c=?
6612**
6613** A term of the HAVING expression is eligible for transfer if it consists
6614** entirely of constants and expressions that are also GROUP BY terms that
6615** use the "BINARY" collation sequence.
6616*/
drhcd0abc22018-03-20 18:08:33 +00006617static void havingToWhere(Parse *pParse, Select *p){
danab31a842017-04-29 20:53:09 +00006618 Walker sWalker;
danab31a842017-04-29 20:53:09 +00006619 memset(&sWalker, 0, sizeof(sWalker));
6620 sWalker.pParse = pParse;
6621 sWalker.xExprCallback = havingToWhereExprCb;
drhcd0abc22018-03-20 18:08:33 +00006622 sWalker.u.pSelect = p;
6623 sqlite3WalkExpr(&sWalker, p->pHaving);
drh5e431be2022-04-06 11:08:38 +00006624#if TREETRACE_ENABLED
6625 if( sWalker.eCode && (sqlite3TreeTrace & 0x100)!=0 ){
drh5d7aef12022-11-22 19:49:16 +00006626 TREETRACE(0x100,pParse,p,("Move HAVING terms into WHERE:\n"));
drhcd0abc22018-03-20 18:08:33 +00006627 sqlite3TreeViewSelect(0, p, 0);
6628 }
6629#endif
danab31a842017-04-29 20:53:09 +00006630}
6631
6632/*
drhe08e8d62017-05-01 15:15:41 +00006633** Check to see if the pThis entry of pTabList is a self-join of a prior view.
drh3b880652022-10-19 11:58:24 +00006634** If it is, then return the SrcItem for the prior view. If it is not,
drhe08e8d62017-05-01 15:15:41 +00006635** then return 0.
6636*/
drh76012942021-02-21 21:04:54 +00006637static SrcItem *isSelfJoinView(
drhe08e8d62017-05-01 15:15:41 +00006638 SrcList *pTabList, /* Search for self-joins in this FROM clause */
drh76012942021-02-21 21:04:54 +00006639 SrcItem *pThis /* Search for prior reference to this subquery */
drhe08e8d62017-05-01 15:15:41 +00006640){
drh76012942021-02-21 21:04:54 +00006641 SrcItem *pItem;
drh8794c682021-02-13 16:39:24 +00006642 assert( pThis->pSelect!=0 );
6643 if( pThis->pSelect->selFlags & SF_PushDown ) return 0;
drhe08e8d62017-05-01 15:15:41 +00006644 for(pItem = pTabList->a; pItem<pThis; pItem++){
drhbdefaf02018-12-27 02:16:01 +00006645 Select *pS1;
drhe08e8d62017-05-01 15:15:41 +00006646 if( pItem->pSelect==0 ) continue;
6647 if( pItem->fg.viaCoroutine ) continue;
drh33543c22017-05-01 16:37:20 +00006648 if( pItem->zName==0 ) continue;
drh30ad79a2019-05-23 16:38:12 +00006649 assert( pItem->pTab!=0 );
6650 assert( pThis->pTab!=0 );
6651 if( pItem->pTab->pSchema!=pThis->pTab->pSchema ) continue;
drhed712982017-05-01 17:04:35 +00006652 if( sqlite3_stricmp(pItem->zName, pThis->zName)!=0 ) continue;
drhbdefaf02018-12-27 02:16:01 +00006653 pS1 = pItem->pSelect;
drh30ad79a2019-05-23 16:38:12 +00006654 if( pItem->pTab->pSchema==0 && pThis->pSelect->selId!=pS1->selId ){
drhbdefaf02018-12-27 02:16:01 +00006655 /* The query flattener left two different CTE tables with identical
6656 ** names in the same FROM clause. */
6657 continue;
6658 }
drh8794c682021-02-13 16:39:24 +00006659 if( pItem->pSelect->selFlags & SF_PushDown ){
drhed712982017-05-01 17:04:35 +00006660 /* The view was modified by some other optimization such as
6661 ** pushDownWhereTerms() */
6662 continue;
6663 }
6664 return pItem;
drhe08e8d62017-05-01 15:15:41 +00006665 }
6666 return 0;
6667}
6668
drhc54246f2021-02-17 21:13:14 +00006669/*
6670** Deallocate a single AggInfo object
6671*/
6672static void agginfoFree(sqlite3 *db, AggInfo *p){
6673 sqlite3DbFree(db, p->aCol);
6674 sqlite3DbFree(db, p->aFunc);
6675 sqlite3DbFreeNN(db, p);
6676}
6677
drh269ba802017-07-04 19:34:36 +00006678#ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6679/*
6680** Attempt to transform a query of the form
6681**
6682** SELECT count(*) FROM (SELECT x FROM t1 UNION ALL SELECT y FROM t2)
6683**
6684** Into this:
6685**
6686** SELECT (SELECT count(*) FROM t1)+(SELECT count(*) FROM t2)
6687**
6688** The transformation only works if all of the following are true:
6689**
6690** * The subquery is a UNION ALL of two or more terms
dana4b5fb52018-08-03 20:19:52 +00006691** * The subquery does not have a LIMIT clause
drh269ba802017-07-04 19:34:36 +00006692** * There is no WHERE or GROUP BY or HAVING clauses on the subqueries
drh73c53b32019-05-15 18:42:15 +00006693** * The outer query is a simple count(*) with no WHERE clause or other
6694** extraneous syntax.
drh269ba802017-07-04 19:34:36 +00006695**
6696** Return TRUE if the optimization is undertaken.
6697*/
6698static int countOfViewOptimization(Parse *pParse, Select *p){
6699 Select *pSub, *pPrior;
6700 Expr *pExpr;
6701 Expr *pCount;
6702 sqlite3 *db;
drh3d240d22017-09-28 16:56:55 +00006703 if( (p->selFlags & SF_Aggregate)==0 ) return 0; /* This is an aggregate */
drh269ba802017-07-04 19:34:36 +00006704 if( p->pEList->nExpr!=1 ) return 0; /* Single result column */
drh73c53b32019-05-15 18:42:15 +00006705 if( p->pWhere ) return 0;
6706 if( p->pGroupBy ) return 0;
drh269ba802017-07-04 19:34:36 +00006707 pExpr = p->pEList->a[0].pExpr;
6708 if( pExpr->op!=TK_AGG_FUNCTION ) return 0; /* Result is an aggregate */
drha4eeccd2021-10-07 17:43:30 +00006709 assert( ExprUseUToken(pExpr) );
drh3d240d22017-09-28 16:56:55 +00006710 if( sqlite3_stricmp(pExpr->u.zToken,"count") ) return 0; /* Is count() */
drha4eeccd2021-10-07 17:43:30 +00006711 assert( ExprUseXList(pExpr) );
drh269ba802017-07-04 19:34:36 +00006712 if( pExpr->x.pList!=0 ) return 0; /* Must be count(*) */
drh3d240d22017-09-28 16:56:55 +00006713 if( p->pSrc->nSrc!=1 ) return 0; /* One table in FROM */
drh269ba802017-07-04 19:34:36 +00006714 pSub = p->pSrc->a[0].pSelect;
6715 if( pSub==0 ) return 0; /* The FROM is a subquery */
drh3d240d22017-09-28 16:56:55 +00006716 if( pSub->pPrior==0 ) return 0; /* Must be a compound ry */
drh269ba802017-07-04 19:34:36 +00006717 do{
6718 if( pSub->op!=TK_ALL && pSub->pPrior ) return 0; /* Must be UNION ALL */
6719 if( pSub->pWhere ) return 0; /* No WHERE clause */
dana4b5fb52018-08-03 20:19:52 +00006720 if( pSub->pLimit ) return 0; /* No LIMIT clause */
drh269ba802017-07-04 19:34:36 +00006721 if( pSub->selFlags & SF_Aggregate ) return 0; /* Not an aggregate */
drh3d240d22017-09-28 16:56:55 +00006722 pSub = pSub->pPrior; /* Repeat over compound */
drh269ba802017-07-04 19:34:36 +00006723 }while( pSub );
6724
drh3d240d22017-09-28 16:56:55 +00006725 /* If we reach this point then it is OK to perform the transformation */
drh269ba802017-07-04 19:34:36 +00006726
6727 db = pParse->db;
6728 pCount = pExpr;
6729 pExpr = 0;
6730 pSub = p->pSrc->a[0].pSelect;
6731 p->pSrc->a[0].pSelect = 0;
6732 sqlite3SrcListDelete(db, p->pSrc);
6733 p->pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*p->pSrc));
6734 while( pSub ){
6735 Expr *pTerm;
6736 pPrior = pSub->pPrior;
6737 pSub->pPrior = 0;
6738 pSub->pNext = 0;
6739 pSub->selFlags |= SF_Aggregate;
6740 pSub->selFlags &= ~SF_Compound;
6741 pSub->nSelectRow = 0;
6742 sqlite3ExprListDelete(db, pSub->pEList);
6743 pTerm = pPrior ? sqlite3ExprDup(db, pCount, 0) : pCount;
6744 pSub->pEList = sqlite3ExprListAppend(pParse, 0, pTerm);
6745 pTerm = sqlite3PExpr(pParse, TK_SELECT, 0, 0);
6746 sqlite3PExprAddSelect(pParse, pTerm, pSub);
6747 if( pExpr==0 ){
6748 pExpr = pTerm;
6749 }else{
6750 pExpr = sqlite3PExpr(pParse, TK_PLUS, pTerm, pExpr);
6751 }
6752 pSub = pPrior;
6753 }
6754 p->pEList->a[0].pExpr = pExpr;
6755 p->selFlags &= ~SF_Aggregate;
6756
drh5e431be2022-04-06 11:08:38 +00006757#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00006758 if( sqlite3TreeTrace & 0x200 ){
6759 TREETRACE(0x200,pParse,p,("After count-of-view optimization:\n"));
drh269ba802017-07-04 19:34:36 +00006760 sqlite3TreeViewSelect(0, p, 0);
6761 }
6762#endif
6763 return 1;
6764}
6765#endif /* SQLITE_COUNTOFVIEW_OPTIMIZATION */
6766
drhe08e8d62017-05-01 15:15:41 +00006767/*
drhfb98dac2022-05-25 02:32:11 +00006768** If any term of pSrc, or any SF_NestedFrom sub-query, is not the same
6769** as pSrcItem but has the same alias as p0, then return true.
6770** Otherwise return false.
6771*/
6772static int sameSrcAlias(SrcItem *p0, SrcList *pSrc){
6773 int i;
6774 for(i=0; i<pSrc->nSrc; i++){
6775 SrcItem *p1 = &pSrc->a[i];
6776 if( p1==p0 ) continue;
6777 if( p0->pTab==p1->pTab && 0==sqlite3_stricmp(p0->zAlias, p1->zAlias) ){
6778 return 1;
6779 }
6780 if( p1->pSelect
6781 && (p1->pSelect->selFlags & SF_NestedFrom)!=0
6782 && sameSrcAlias(p0, p1->pSelect->pSrc)
6783 ){
6784 return 1;
6785 }
6786 }
6787 return 0;
6788}
6789
drhb23f1572022-11-22 20:37:41 +00006790/*
drh7d10d5a2008-08-20 16:35:10 +00006791** Generate code for the SELECT statement given in the p argument.
drh9bb61fe2000-06-05 16:01:39 +00006792**
drh340309f2014-01-22 00:23:49 +00006793** The results are returned according to the SelectDest structure.
6794** See comments in sqliteInt.h for further information.
drhe78e8282003-01-19 03:59:45 +00006795**
drh9bb61fe2000-06-05 16:01:39 +00006796** This routine returns the number of errors. If any errors are
6797** encountered, then an appropriate error message is left in
6798** pParse->zErrMsg.
6799**
6800** This routine does NOT free the Select structure passed in. The
6801** calling function needs to do that.
6802*/
danielk19774adee202004-05-08 08:23:19 +00006803int sqlite3Select(
drhcce7d172000-05-31 15:34:51 +00006804 Parse *pParse, /* The parser context */
drh9bb61fe2000-06-05 16:01:39 +00006805 Select *p, /* The SELECT statement being coded. */
drh7d10d5a2008-08-20 16:35:10 +00006806 SelectDest *pDest /* What to do with the query results */
drhcce7d172000-05-31 15:34:51 +00006807){
drh13449892005-09-07 21:22:45 +00006808 int i, j; /* Loop counters */
6809 WhereInfo *pWInfo; /* Return from sqlite3WhereBegin() */
6810 Vdbe *v; /* The virtual machine under construction */
danielk1977b3bce662005-01-29 08:32:43 +00006811 int isAgg; /* True for select lists like "count(*)" */
mistachkinc29cbb02015-07-02 16:52:01 +00006812 ExprList *pEList = 0; /* List of columns to extract. */
drhad3cab52002-05-24 02:04:32 +00006813 SrcList *pTabList; /* List of tables to select from */
drh9bb61fe2000-06-05 16:01:39 +00006814 Expr *pWhere; /* The WHERE clause. May be NULL */
drh22827922000-06-06 17:27:05 +00006815 ExprList *pGroupBy; /* The GROUP BY clause. May be NULL */
6816 Expr *pHaving; /* The HAVING clause. May be NULL */
drhbf790972020-06-07 20:18:07 +00006817 AggInfo *pAggInfo = 0; /* Aggregate information */
drh1d83f052002-02-17 00:30:36 +00006818 int rc = 1; /* Value to return from this function */
drhe8e4af72012-09-21 00:04:28 +00006819 DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
drh079a3072014-03-19 14:10:55 +00006820 SortCtx sSort; /* Info on how to code the ORDER BY clause */
drhec7429a2005-10-06 16:53:14 +00006821 int iEnd; /* Address of the end of the query */
drh17435752007-08-16 04:30:38 +00006822 sqlite3 *db; /* The database connection */
drh47d9f832017-10-26 20:04:28 +00006823 ExprList *pMinMaxOrderBy = 0; /* Added ORDER BY for min/max queries */
6824 u8 minMaxFlag; /* Flag for min/max queries */
drh9bb61fe2000-06-05 16:01:39 +00006825
drh17435752007-08-16 04:30:38 +00006826 db = pParse->db;
drh0c7d3d32022-01-24 16:47:12 +00006827 assert( pParse==db->pParse );
drhe2ca99c2018-05-02 00:33:43 +00006828 v = sqlite3GetVdbe(pParse);
drh0c7d3d32022-01-24 16:47:12 +00006829 if( p==0 || pParse->nErr ){
drh6f7adc82006-01-11 21:41:20 +00006830 return 1;
6831 }
drh0c7d3d32022-01-24 16:47:12 +00006832 assert( db->mallocFailed==0 );
danielk19774adee202004-05-08 08:23:19 +00006833 if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
drh5e431be2022-04-06 11:08:38 +00006834#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00006835 TREETRACE(0x1,pParse,p, ("begin processing:\n", pParse->addrExplain));
6836 if( sqlite3TreeTrace & 0x10000 ){
drhc2d0df92022-04-06 18:30:17 +00006837 if( (sqlite3TreeTrace & 0x10001)==0x10000 ){
6838 sqlite3TreeViewLine(0, "In sqlite3Select() at %s:%d",
6839 __FILE__, __LINE__);
6840 }
6841 sqlite3ShowSelect(p);
drhc90713d2014-09-30 13:46:49 +00006842 }
drheb9b8842014-09-21 00:27:26 +00006843#endif
drhdaffd0e2001-04-11 14:28:42 +00006844
drh8e1ee882014-03-21 19:56:09 +00006845 assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
6846 assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
dan9afccba2014-03-21 19:27:54 +00006847 assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
6848 assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
drhf1ea4252020-09-17 00:46:09 +00006849 if( IgnorableDistinct(pDest) ){
6850 assert(pDest->eDest==SRT_Exists || pDest->eDest==SRT_Union ||
6851 pDest->eDest==SRT_Except || pDest->eDest==SRT_Discard ||
6852 pDest->eDest==SRT_DistQueue || pDest->eDest==SRT_DistFifo );
6853 /* All of these destinations are also able to ignore the ORDER BY clause */
drhfad1ad02021-03-03 14:07:52 +00006854 if( p->pOrderBy ){
drh5e431be2022-04-06 11:08:38 +00006855#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00006856 TREETRACE(0x800,pParse,p, ("dropping superfluous ORDER BY:\n"));
6857 if( sqlite3TreeTrace & 0x800 ){
drhfad1ad02021-03-03 14:07:52 +00006858 sqlite3TreeViewExprList(0, p->pOrderBy, 0, "ORDERBY");
6859 }
6860#endif
6861 sqlite3ParserAddCleanup(pParse,
6862 (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
6863 p->pOrderBy);
drh6d0053c2021-03-09 19:32:37 +00006864 testcase( pParse->earlyCleanup );
drhfad1ad02021-03-03 14:07:52 +00006865 p->pOrderBy = 0;
6866 }
drh7d10d5a2008-08-20 16:35:10 +00006867 p->selFlags &= ~SF_Distinct;
drhb7cbf5c2020-06-15 13:51:34 +00006868 p->selFlags |= SF_NoopOrderBy;
drh9a993342007-12-13 02:45:31 +00006869 }
drh7d10d5a2008-08-20 16:35:10 +00006870 sqlite3SelectPrep(pParse, p, 0);
drh0c7d3d32022-01-24 16:47:12 +00006871 if( pParse->nErr ){
drh9a993342007-12-13 02:45:31 +00006872 goto select_end;
6873 }
drh0c7d3d32022-01-24 16:47:12 +00006874 assert( db->mallocFailed==0 );
drhadc57f62015-06-06 00:18:01 +00006875 assert( p->pEList!=0 );
drh5e431be2022-04-06 11:08:38 +00006876#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00006877 if( sqlite3TreeTrace & 0x10 ){
6878 TREETRACE(0x10,pParse,p, ("after name resolution:\n"));
drh17645f52015-02-09 13:42:59 +00006879 sqlite3TreeViewSelect(0, p, 0);
6880 }
6881#endif
drhcce7d172000-05-31 15:34:51 +00006882
dan5daf69e2021-07-05 11:27:13 +00006883 /* If the SF_UFSrcCheck flag is set, then this function is being called
dan07ca7d62020-07-17 16:31:37 +00006884 ** as part of populating the temp table for an UPDATE...FROM statement.
6885 ** In this case, it is an error if the target object (pSrc->a[0]) name
dan5daf69e2021-07-05 11:27:13 +00006886 ** or alias is duplicated within FROM clause (pSrc->a[1..n]).
6887 **
6888 ** Postgres disallows this case too. The reason is that some other
6889 ** systems handle this case differently, and not all the same way,
6890 ** which is just confusing. To avoid this, we follow PG's lead and
6891 ** disallow it altogether. */
6892 if( p->selFlags & SF_UFSrcCheck ){
drh76012942021-02-21 21:04:54 +00006893 SrcItem *p0 = &p->pSrc->a[0];
drhfb98dac2022-05-25 02:32:11 +00006894 if( sameSrcAlias(p0, p->pSrc) ){
6895 sqlite3ErrorMsg(pParse,
6896 "target object/alias may not appear in FROM clause: %s",
6897 p0->zAlias ? p0->zAlias : p0->pTab->zName
6898 );
6899 goto select_end;
dan07ca7d62020-07-17 16:31:37 +00006900 }
dan5daf69e2021-07-05 11:27:13 +00006901
6902 /* Clear the SF_UFSrcCheck flag. The check has already been performed,
6903 ** and leaving this flag set can cause errors if a compound sub-query
6904 ** in p->pSrc is flattened into this query and this function called
6905 ** again as part of compound SELECT processing. */
6906 p->selFlags &= ~SF_UFSrcCheck;
dan07ca7d62020-07-17 16:31:37 +00006907 }
6908
drhf35f2f92017-07-29 16:01:55 +00006909 if( pDest->eDest==SRT_Output ){
drh90881862021-05-19 12:17:03 +00006910 sqlite3GenerateColumnNames(pParse, p);
drhf35f2f92017-07-29 16:01:55 +00006911 }
6912
dan67a9b8e2018-06-22 20:51:35 +00006913#ifndef SQLITE_OMIT_WINDOWFUNC
dan44918c72021-04-17 14:42:37 +00006914 if( sqlite3WindowRewrite(pParse, p) ){
drh0c7d3d32022-01-24 16:47:12 +00006915 assert( pParse->nErr );
dan86fb6e12018-05-16 20:58:07 +00006916 goto select_end;
6917 }
drh5e431be2022-04-06 11:08:38 +00006918#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00006919 if( p->pWin && (sqlite3TreeTrace & 0x40)!=0 ){
6920 TREETRACE(0x40,pParse,p, ("after window rewrite:\n"));
dandfa552f2018-06-02 21:04:28 +00006921 sqlite3TreeViewSelect(0, p, 0);
6922 }
6923#endif
dan67a9b8e2018-06-22 20:51:35 +00006924#endif /* SQLITE_OMIT_WINDOWFUNC */
dan86fb6e12018-05-16 20:58:07 +00006925 pTabList = p->pSrc;
dan73925692018-06-12 18:40:17 +00006926 isAgg = (p->selFlags & SF_Aggregate)!=0;
danf02cdd32018-06-27 19:48:50 +00006927 memset(&sSort, 0, sizeof(sSort));
6928 sSort.pOrderBy = p->pOrderBy;
dan86fb6e12018-05-16 20:58:07 +00006929
drh9216de82020-06-11 00:57:09 +00006930 /* Try to do various optimizations (flattening subqueries, and strength
drh25897872018-03-20 21:16:15 +00006931 ** reduction of join operators) in the FROM clause up into the main query
drhd820cb12002-02-18 03:21:45 +00006932 */
drh51522cd2005-01-20 13:36:19 +00006933#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
danielk1977f23329a2008-07-01 14:09:13 +00006934 for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
drh76012942021-02-21 21:04:54 +00006935 SrcItem *pItem = &pTabList->a[i];
danielk1977daf79ac2008-06-30 18:12:28 +00006936 Select *pSub = pItem->pSelect;
drh2679f142015-09-25 13:42:55 +00006937 Table *pTab = pItem->pTab;
drh25897872018-03-20 21:16:15 +00006938
drhb5aaee52020-06-11 16:04:10 +00006939 /* The expander should have already created transient Table objects
6940 ** even for FROM clause elements such as subqueries that do not correspond
6941 ** to a real table */
6942 assert( pTab!=0 );
6943
drh25897872018-03-20 21:16:15 +00006944 /* Convert LEFT JOIN into JOIN if there are terms of the right table
6945 ** of the LEFT JOIN used in the WHERE clause.
6946 */
drhff02ac72022-04-11 14:43:11 +00006947 if( (pItem->fg.jointype & (JT_LEFT|JT_RIGHT))==JT_LEFT
drh25897872018-03-20 21:16:15 +00006948 && sqlite3ExprImpliesNonNullRow(p->pWhere, pItem->iCursor)
6949 && OptimizationEnabled(db, SQLITE_SimplifyJoin)
6950 ){
drh5d7aef12022-11-22 19:49:16 +00006951 TREETRACE(0x1000,pParse,p,
drh25897872018-03-20 21:16:15 +00006952 ("LEFT-JOIN simplifies to JOIN on term %d\n",i));
drhefce69d2018-03-20 22:52:27 +00006953 pItem->fg.jointype &= ~(JT_LEFT|JT_OUTER);
drhd7480402022-06-20 17:04:44 +00006954 assert( pItem->iCursor>=0 );
drh92d1afb2022-06-13 12:42:24 +00006955 unsetJoinExpr(p->pWhere, pItem->iCursor,
6956 pTabList->a[0].fg.jointype & JT_LTORJ);
drh25897872018-03-20 21:16:15 +00006957 }
6958
6959 /* No futher action if this term of the FROM clause is no a subquery */
drh4490c402015-06-05 22:33:39 +00006960 if( pSub==0 ) continue;
drh2679f142015-09-25 13:42:55 +00006961
6962 /* Catch mismatch in the declared columns of a view and the number of
6963 ** columns in the SELECT on the RHS */
6964 if( pTab->nCol!=pSub->pEList->nExpr ){
6965 sqlite3ErrorMsg(pParse, "expected %d columns for '%s' but got %d",
6966 pTab->nCol, pTab->zName, pSub->pEList->nExpr);
6967 goto select_end;
6968 }
6969
drh25c221e2017-09-29 22:13:24 +00006970 /* Do not try to flatten an aggregate subquery.
6971 **
6972 ** Flattening an aggregate subquery is only possible if the outer query
6973 ** is not a join. But if the outer query is not a join, then the subquery
6974 ** will be implemented as a co-routine and there is no advantage to
6975 ** flattening in that case.
6976 */
6977 if( (pSub->selFlags & SF_Aggregate)!=0 ) continue;
6978 assert( pSub->pGroupBy==0 );
6979
drhbb301232021-07-15 19:29:43 +00006980 /* If a FROM-clause subquery has an ORDER BY clause that is not
6981 ** really doing anything, then delete it now so that it does not
drh0fb78f02021-07-16 01:19:19 +00006982 ** interfere with query flattening. See the discussion at
6983 ** https://sqlite.org/forum/forumpost/2d76f2bcf65d256a
drhbb301232021-07-15 19:29:43 +00006984 **
6985 ** Beware of these cases where the ORDER BY clause may not be safely
6986 ** omitted:
6987 **
6988 ** (1) There is also a LIMIT clause
6989 ** (2) The subquery was added to help with window-function
6990 ** processing
drh0fb78f02021-07-16 01:19:19 +00006991 ** (3) The subquery is in the FROM clause of an UPDATE
6992 ** (4) The outer query uses an aggregate function other than
drhbb301232021-07-15 19:29:43 +00006993 ** the built-in count(), min(), or max().
drh0fb78f02021-07-16 01:19:19 +00006994 ** (5) The ORDER BY isn't going to accomplish anything because
6995 ** one of:
6996 ** (a) The outer query has a different ORDER BY clause
6997 ** (b) The subquery is part of a join
6998 ** See forum post 062d576715d277c8
drhbb301232021-07-15 19:29:43 +00006999 */
7000 if( pSub->pOrderBy!=0
drh0fb78f02021-07-16 01:19:19 +00007001 && (p->pOrderBy!=0 || pTabList->nSrc>1) /* Condition (5) */
drhbb301232021-07-15 19:29:43 +00007002 && pSub->pLimit==0 /* Condition (1) */
7003 && (pSub->selFlags & SF_OrderByReqd)==0 /* Condition (2) */
drh0fb78f02021-07-16 01:19:19 +00007004 && (p->selFlags & SF_OrderByReqd)==0 /* Condition (3) and (4) */
drhbb301232021-07-15 19:29:43 +00007005 && OptimizationEnabled(db, SQLITE_OmitOrderBy)
7006 ){
drh5d7aef12022-11-22 19:49:16 +00007007 TREETRACE(0x800,pParse,p,
drhbb301232021-07-15 19:29:43 +00007008 ("omit superfluous ORDER BY on %r FROM-clause subquery\n",i+1));
drhe8344842022-07-14 01:48:27 +00007009 sqlite3ParserAddCleanup(pParse,
7010 (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
7011 pSub->pOrderBy);
drhbb301232021-07-15 19:29:43 +00007012 pSub->pOrderBy = 0;
7013 }
7014
drhfca23552017-10-28 20:51:54 +00007015 /* If the outer query contains a "complex" result set (that is,
7016 ** if the result set of the outer query uses functions or subqueries)
7017 ** and if the subquery contains an ORDER BY clause and if
drh648fe492017-09-28 20:06:53 +00007018 ** it will be implemented as a co-routine, then do not flatten. This
7019 ** restriction allows SQL constructs like this:
7020 **
7021 ** SELECT expensive_function(x)
7022 ** FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
7023 **
7024 ** The expensive_function() is only computed on the 10 rows that
7025 ** are output, rather than every row of the table.
drhfca23552017-10-28 20:51:54 +00007026 **
7027 ** The requirement that the outer query have a complex result set
7028 ** means that flattening does occur on simpler SQL constraints without
7029 ** the expensive_function() like:
7030 **
7031 ** SELECT x FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
drh648fe492017-09-28 20:06:53 +00007032 */
drh25c221e2017-09-29 22:13:24 +00007033 if( pSub->pOrderBy!=0
drh648fe492017-09-28 20:06:53 +00007034 && i==0
drhfca23552017-10-28 20:51:54 +00007035 && (p->selFlags & SF_ComplexResult)!=0
drh648fe492017-09-28 20:06:53 +00007036 && (pTabList->nSrc==1
drha76ac882022-04-08 19:20:12 +00007037 || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0)
drh648fe492017-09-28 20:06:53 +00007038 ){
7039 continue;
7040 }
7041
drh25c221e2017-09-29 22:13:24 +00007042 if( flattenSubquery(pParse, p, i, isAgg) ){
drh4acd7542019-02-06 00:55:47 +00007043 if( pParse->nErr ) goto select_end;
drh4490c402015-06-05 22:33:39 +00007044 /* This subquery can be absorbed into its parent. */
drh4490c402015-06-05 22:33:39 +00007045 i = -1;
7046 }
7047 pTabList = p->pSrc;
7048 if( db->mallocFailed ) goto select_end;
7049 if( !IgnorableOrderby(pDest) ){
7050 sSort.pOrderBy = p->pOrderBy;
7051 }
7052 }
7053#endif
7054
drh4490c402015-06-05 22:33:39 +00007055#ifndef SQLITE_OMIT_COMPOUND_SELECT
7056 /* Handle compound SELECT statements using the separate multiSelect()
7057 ** procedure.
7058 */
7059 if( p->pPrior ){
7060 rc = multiSelect(pParse, p, pDest);
drh5e431be2022-04-06 11:08:38 +00007061#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007062 TREETRACE(0x400,pParse,p,("end compound-select processing\n"));
7063 if( (sqlite3TreeTrace & 0x400)!=0 && ExplainQueryPlanParent(pParse)==0 ){
drhf20609d2018-04-23 17:43:35 +00007064 sqlite3TreeViewSelect(0, p, 0);
7065 }
drh4490c402015-06-05 22:33:39 +00007066#endif
drhc631ded2018-05-02 02:22:22 +00007067 if( p->pNext==0 ) ExplainQueryPlanPop(pParse);
drh4490c402015-06-05 22:33:39 +00007068 return rc;
7069 }
7070#endif
7071
drh7810ab62018-07-27 17:51:20 +00007072 /* Do the WHERE-clause constant propagation optimization if this is
7073 ** a join. No need to speed time on this operation for non-join queries
7074 ** as the equivalent optimization will be handled by query planner in
7075 ** sqlite3WhereBegin().
7076 */
drhb775c972021-05-14 14:26:57 +00007077 if( p->pWhere!=0
7078 && p->pWhere->op==TK_AND
drh7810ab62018-07-27 17:51:20 +00007079 && OptimizationEnabled(db, SQLITE_PropagateConst)
drh24e11162018-07-26 23:47:11 +00007080 && propagateConstants(pParse, p)
7081 ){
drh5e431be2022-04-06 11:08:38 +00007082#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007083 if( sqlite3TreeTrace & 0x2000 ){
7084 TREETRACE(0x2000,pParse,p,("After constant propagation:\n"));
drh24e11162018-07-26 23:47:11 +00007085 sqlite3TreeViewSelect(0, p, 0);
7086 }
7087#endif
7088 }else{
drh5d7aef12022-11-22 19:49:16 +00007089 TREETRACE(0x2000,pParse,p,("Constant propagation not helpful\n"));
drh24e11162018-07-26 23:47:11 +00007090 }
7091
dana4b5fb52018-08-03 20:19:52 +00007092#ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
7093 if( OptimizationEnabled(db, SQLITE_QueryFlattener|SQLITE_CountOfView)
7094 && countOfViewOptimization(pParse, p)
7095 ){
7096 if( db->mallocFailed ) goto select_end;
7097 pEList = p->pEList;
7098 pTabList = p->pSrc;
7099 }
7100#endif
7101
drh701caf12017-05-10 16:12:00 +00007102 /* For each term in the FROM clause, do two things:
7103 ** (1) Authorized unreferenced tables
7104 ** (2) Generate code for all sub-queries
drhd820cb12002-02-18 03:21:45 +00007105 */
drh4490c402015-06-05 22:33:39 +00007106 for(i=0; i<pTabList->nSrc; i++){
drh76012942021-02-21 21:04:54 +00007107 SrcItem *pItem = &pTabList->a[i];
drha79e2a22021-02-21 23:44:14 +00007108 SrcItem *pPrior;
drh13449892005-09-07 21:22:45 +00007109 SelectDest dest;
drh701caf12017-05-10 16:12:00 +00007110 Select *pSub;
drh824d21a2017-09-29 12:44:52 +00007111#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
7112 const char *zSavedAuthContext;
7113#endif
drh701caf12017-05-10 16:12:00 +00007114
drh3d240d22017-09-28 16:56:55 +00007115 /* Issue SQLITE_READ authorizations with a fake column name for any
7116 ** tables that are referenced but from which no values are extracted.
7117 ** Examples of where these kinds of null SQLITE_READ authorizations
7118 ** would occur:
drh701caf12017-05-10 16:12:00 +00007119 **
drh2336c932017-05-11 12:05:23 +00007120 ** SELECT count(*) FROM t1; -- SQLITE_READ t1.""
7121 ** SELECT t1.* FROM t1, t2; -- SQLITE_READ t2.""
7122 **
7123 ** The fake column name is an empty string. It is possible for a table to
7124 ** have a column named by the empty string, in which case there is no way to
7125 ** distinguish between an unreferenced table and an actual reference to the
drh3d240d22017-09-28 16:56:55 +00007126 ** "" column. The original design was for the fake column name to be a NULL,
drh2336c932017-05-11 12:05:23 +00007127 ** which would be unambiguous. But legacy authorization callbacks might
drh3d240d22017-09-28 16:56:55 +00007128 ** assume the column name is non-NULL and segfault. The use of an empty
7129 ** string for the fake column name seems safer.
drh701caf12017-05-10 16:12:00 +00007130 */
drh74c490e2019-08-07 13:25:21 +00007131 if( pItem->colUsed==0 && pItem->zName!=0 ){
drh2336c932017-05-11 12:05:23 +00007132 sqlite3AuthCheck(pParse, SQLITE_READ, pItem->zName, "", pItem->zDatabase);
drh701caf12017-05-10 16:12:00 +00007133 }
7134
7135#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
7136 /* Generate code for all sub-queries in the FROM clause
7137 */
7138 pSub = pItem->pSelect;
drh5b6a9ed2011-09-15 23:58:14 +00007139 if( pSub==0 ) continue;
drh21172c42012-10-30 00:29:07 +00007140
drh14c4d422021-05-26 18:46:51 +00007141 /* The code for a subquery should only be generated once. */
7142 assert( pItem->addrFillSub==0 );
danielk1977daf79ac2008-06-30 18:12:28 +00007143
danielk1977fc976062007-05-10 10:46:56 +00007144 /* Increment Parse.nHeight by the height of the largest expression
drhf7b54962013-05-28 12:11:54 +00007145 ** tree referred to by this, the parent select. The child select
danielk1977fc976062007-05-10 10:46:56 +00007146 ** may contain expression trees of at most
7147 ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
7148 ** more conservative than necessary, but much easier than enforcing
7149 ** an exact limit.
7150 */
7151 pParse->nHeight += sqlite3SelectExprHeight(p);
danielk1977daf79ac2008-06-30 18:12:28 +00007152
drhadc57f62015-06-06 00:18:01 +00007153 /* Make copies of constant WHERE-clause terms in the outer query down
7154 ** inside the subquery. This can help the subquery to run more efficiently.
7155 */
drh7fbb1012018-03-21 01:59:46 +00007156 if( OptimizationEnabled(db, SQLITE_PushDown)
drhdf67ec02021-08-11 13:48:56 +00007157 && (pItem->fg.isCte==0
7158 || (pItem->u2.pCteUse->eM10d!=M10d_Yes && pItem->u2.pCteUse->nUse<2))
drha9cdb902022-04-25 19:40:33 +00007159 && pushDownWhereTerms(pParse, pSub, p->pWhere, pItem)
drh4490c402015-06-05 22:33:39 +00007160 ){
drh5e431be2022-04-06 11:08:38 +00007161#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007162 if( sqlite3TreeTrace & 0x4000 ){
7163 TREETRACE(0x4000,pParse,p,
drhd2a44012018-07-28 14:34:22 +00007164 ("After WHERE-clause push-down into subquery %d:\n", pSub->selId));
drh4490c402015-06-05 22:33:39 +00007165 sqlite3TreeViewSelect(0, p, 0);
danielk1977daf79ac2008-06-30 18:12:28 +00007166 }
drh69b72d52015-06-01 20:28:03 +00007167#endif
drh8794c682021-02-13 16:39:24 +00007168 assert( pItem->pSelect && (pItem->pSelect->selFlags & SF_PushDown)!=0 );
drh2d277bb2018-03-20 11:24:30 +00007169 }else{
drh5d7aef12022-11-22 19:49:16 +00007170 TREETRACE(0x4000,pParse,p,("Push-down not possible\n"));
drh4490c402015-06-05 22:33:39 +00007171 }
drhadc57f62015-06-06 00:18:01 +00007172
drh824d21a2017-09-29 12:44:52 +00007173 zSavedAuthContext = pParse->zAuthContext;
7174 pParse->zAuthContext = pItem->zName;
7175
drhadc57f62015-06-06 00:18:01 +00007176 /* Generate code to implement the subquery
drh0ff47e92016-03-15 17:52:12 +00007177 **
drhcf5cab02022-06-22 15:55:28 +00007178 ** The subquery is implemented as a co-routine if all of the following are
drh9debb582022-04-10 23:01:20 +00007179 ** true:
7180 **
drha79e2a22021-02-21 23:44:14 +00007181 ** (1) the subquery is guaranteed to be the outer loop (so that
7182 ** it does not need to be computed more than once), and
drh745912e2021-02-22 03:04:25 +00007183 ** (2) the subquery is not a CTE that should be materialized
drh9debb582022-04-10 23:01:20 +00007184 ** (3) the subquery is not part of a left operand for a RIGHT JOIN
drhadc57f62015-06-06 00:18:01 +00007185 */
drh0ff47e92016-03-15 17:52:12 +00007186 if( i==0
7187 && (pTabList->nSrc==1
drha76ac882022-04-08 19:20:12 +00007188 || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0) /* (1) */
7189 && (pItem->fg.isCte==0 || pItem->u2.pCteUse->eM10d!=M10d_Yes) /* (2) */
drh9debb582022-04-10 23:01:20 +00007190 && (pTabList->a[0].fg.jointype & JT_LTORJ)==0 /* (3) */
drha5759672012-10-30 14:39:12 +00007191 ){
drh21172c42012-10-30 00:29:07 +00007192 /* Implement a co-routine that will return a single row of the result
7193 ** set on each invocation.
7194 */
drh4490c402015-06-05 22:33:39 +00007195 int addrTop = sqlite3VdbeCurrentAddr(v)+1;
drh824d21a2017-09-29 12:44:52 +00007196
drh21172c42012-10-30 00:29:07 +00007197 pItem->regReturn = ++pParse->nMem;
drh4490c402015-06-05 22:33:39 +00007198 sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
drha9799932021-03-19 13:00:28 +00007199 VdbeComment((v, "%!S", pItem));
drh21172c42012-10-30 00:29:07 +00007200 pItem->addrFillSub = addrTop;
drh21172c42012-10-30 00:29:07 +00007201 sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
drha9799932021-03-19 13:00:28 +00007202 ExplainQueryPlan((pParse, 1, "CO-ROUTINE %!S", pItem));
drh21172c42012-10-30 00:29:07 +00007203 sqlite3Select(pParse, pSub, &dest);
drhc3489bb2016-02-25 16:04:59 +00007204 pItem->pTab->nRowLogEst = pSub->nSelectRow;
drh8a48b9c2015-08-19 15:20:00 +00007205 pItem->fg.viaCoroutine = 1;
drh4490c402015-06-05 22:33:39 +00007206 pItem->regResult = dest.iSdst;
drh2fade2f2016-02-09 02:12:20 +00007207 sqlite3VdbeEndCoroutine(v, pItem->regReturn);
drh21172c42012-10-30 00:29:07 +00007208 sqlite3VdbeJumpHere(v, addrTop-1);
7209 sqlite3ClearTempRegCache(pParse);
drha79e2a22021-02-21 23:44:14 +00007210 }else if( pItem->fg.isCte && pItem->u2.pCteUse->addrM9e>0 ){
7211 /* This is a CTE for which materialization code has already been
7212 ** generated. Invoke the subroutine to compute the materialization,
7213 ** the make the pItem->iCursor be a copy of the ephemerial table that
7214 ** holds the result of the materialization. */
7215 CteUse *pCteUse = pItem->u2.pCteUse;
7216 sqlite3VdbeAddOp2(v, OP_Gosub, pCteUse->regRtn, pCteUse->addrM9e);
7217 if( pItem->iCursor!=pCteUse->iCur ){
7218 sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pCteUse->iCur);
drh834c6882021-08-11 13:19:13 +00007219 VdbeComment((v, "%!S", pItem));
drha79e2a22021-02-21 23:44:14 +00007220 }
7221 pSub->nSelectRow = pCteUse->nRowEst;
7222 }else if( (pPrior = isSelfJoinView(pTabList, pItem))!=0 ){
7223 /* This view has already been materialized by a prior entry in
7224 ** this same FROM clause. Reuse it. */
7225 if( pPrior->addrFillSub ){
7226 sqlite3VdbeAddOp2(v, OP_Gosub, pPrior->regReturn, pPrior->addrFillSub);
7227 }
7228 sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pPrior->iCursor);
7229 pSub->nSelectRow = pPrior->pSelect->nSelectRow;
danielk1977daf79ac2008-06-30 18:12:28 +00007230 }else{
drh14c4d422021-05-26 18:46:51 +00007231 /* Materialize the view. If the view is not correlated, generate a
drhd685dd62021-03-19 13:53:34 +00007232 ** subroutine to do the materialization so that subsequent uses of
7233 ** the same view can reuse the materialization. */
drh7157e8e2011-09-16 16:00:51 +00007234 int topAddr;
drh48f2d3b2011-09-16 01:34:43 +00007235 int onceAddr = 0;
drhe08e8d62017-05-01 15:15:41 +00007236
drh5b6a9ed2011-09-15 23:58:14 +00007237 pItem->regReturn = ++pParse->nMem;
drh40822eb2022-05-21 18:03:33 +00007238 topAddr = sqlite3VdbeAddOp0(v, OP_Goto);
drh7157e8e2011-09-16 16:00:51 +00007239 pItem->addrFillSub = topAddr+1;
drh40822eb2022-05-21 18:03:33 +00007240 pItem->fg.isMaterialized = 1;
drh8a48b9c2015-08-19 15:20:00 +00007241 if( pItem->fg.isCorrelated==0 ){
drhed171672013-04-24 13:50:09 +00007242 /* If the subquery is not correlated and if we are not inside of
drh5b6a9ed2011-09-15 23:58:14 +00007243 ** a trigger, then we only need to compute the value of the subquery
7244 ** once. */
drh511f9e82016-09-22 18:53:13 +00007245 onceAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drha9799932021-03-19 13:00:28 +00007246 VdbeComment((v, "materialize %!S", pItem));
drh69b72d52015-06-01 20:28:03 +00007247 }else{
drha9799932021-03-19 13:00:28 +00007248 VdbeNoopComment((v, "materialize %!S", pItem));
drh5b6a9ed2011-09-15 23:58:14 +00007249 }
drha79e2a22021-02-21 23:44:14 +00007250 sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
drha9799932021-03-19 13:00:28 +00007251 ExplainQueryPlan((pParse, 1, "MATERIALIZE %!S", pItem));
drh5fdb9a32022-11-01 00:52:22 +00007252 dest.zAffSdst = sqlite3TableAffinityStr(db, pItem->pTab);
drha79e2a22021-02-21 23:44:14 +00007253 sqlite3Select(pParse, pSub, &dest);
drh5fdb9a32022-11-01 00:52:22 +00007254 sqlite3DbFree(db, dest.zAffSdst);
7255 dest.zAffSdst = 0;
drhc3489bb2016-02-25 16:04:59 +00007256 pItem->pTab->nRowLogEst = pSub->nSelectRow;
drh48f2d3b2011-09-16 01:34:43 +00007257 if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
drh40822eb2022-05-21 18:03:33 +00007258 sqlite3VdbeAddOp2(v, OP_Return, pItem->regReturn, topAddr+1);
drha9799932021-03-19 13:00:28 +00007259 VdbeComment((v, "end %!S", pItem));
drh40822eb2022-05-21 18:03:33 +00007260 sqlite3VdbeJumpHere(v, topAddr);
drhcdc69552011-12-06 13:24:59 +00007261 sqlite3ClearTempRegCache(pParse);
drhd685dd62021-03-19 13:53:34 +00007262 if( pItem->fg.isCte && pItem->fg.isCorrelated==0 ){
drha79e2a22021-02-21 23:44:14 +00007263 CteUse *pCteUse = pItem->u2.pCteUse;
7264 pCteUse->addrM9e = pItem->addrFillSub;
7265 pCteUse->regRtn = pItem->regReturn;
7266 pCteUse->iCur = pItem->iCursor;
7267 pCteUse->nRowEst = pSub->nSelectRow;
7268 }
danielk1977daf79ac2008-06-30 18:12:28 +00007269 }
drhadc57f62015-06-06 00:18:01 +00007270 if( db->mallocFailed ) goto select_end;
danielk1977fc976062007-05-10 10:46:56 +00007271 pParse->nHeight -= sqlite3SelectExprHeight(p);
drh824d21a2017-09-29 12:44:52 +00007272 pParse->zAuthContext = zSavedAuthContext;
drh51522cd2005-01-20 13:36:19 +00007273#endif
drh701caf12017-05-10 16:12:00 +00007274 }
drhadc57f62015-06-06 00:18:01 +00007275
drh38b41492015-06-08 15:08:15 +00007276 /* Various elements of the SELECT copied into local variables for
7277 ** convenience */
drhadc57f62015-06-06 00:18:01 +00007278 pEList = p->pEList;
danielk1977daf79ac2008-06-30 18:12:28 +00007279 pWhere = p->pWhere;
7280 pGroupBy = p->pGroupBy;
7281 pHaving = p->pHaving;
drhe8e4af72012-09-21 00:04:28 +00007282 sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
drh832508b2002-03-02 17:04:07 +00007283
drh5e431be2022-04-06 11:08:38 +00007284#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007285 if( sqlite3TreeTrace & 0x8000 ){
7286 TREETRACE(0x8000,pParse,p,("After all FROM-clause analysis:\n"));
drhbc8edba2015-06-05 20:27:26 +00007287 sqlite3TreeViewSelect(0, p, 0);
danielk1977f23329a2008-07-01 14:09:13 +00007288 }
7289#endif
7290
dan50118cd2011-07-01 14:21:38 +00007291 /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
7292 ** if the select-list is the same as the ORDER BY list, then this query
7293 ** can be rewritten as a GROUP BY. In other words, this:
7294 **
7295 ** SELECT DISTINCT xyz FROM ... ORDER BY xyz
7296 **
7297 ** is transformed to:
7298 **
drhdea7d702014-12-04 21:54:58 +00007299 ** SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
dan50118cd2011-07-01 14:21:38 +00007300 **
7301 ** The second form is preferred as a single index (or temp-table) may be
7302 ** used for both the ORDER BY and DISTINCT processing. As originally
7303 ** written the query must use a temp-table for at least one of the ORDER
7304 ** BY and DISTINCT, and an index or separate temp-table for the other.
7305 */
7306 if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
drhadc57f62015-06-06 00:18:01 +00007307 && sqlite3ExprListCompare(sSort.pOrderBy, pEList, -1)==0
drhef9f7192020-01-17 19:14:08 +00007308#ifndef SQLITE_OMIT_WINDOWFUNC
dane59c5622019-11-22 10:14:01 +00007309 && p->pWin==0
drhef9f7192020-01-17 19:14:08 +00007310#endif
dan50118cd2011-07-01 14:21:38 +00007311 ){
7312 p->selFlags &= ~SF_Distinct;
drhadc57f62015-06-06 00:18:01 +00007313 pGroupBy = p->pGroupBy = sqlite3ExprListDup(db, pEList, 0);
dan9e10f9a2020-01-06 17:06:12 +00007314 p->selFlags |= SF_Aggregate;
drhe8e4af72012-09-21 00:04:28 +00007315 /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
7316 ** the sDistinct.isTnct is still set. Hence, isTnct represents the
7317 ** original setting of the SF_Distinct flag, not the current setting */
7318 assert( sDistinct.isTnct );
danece092e2022-03-16 12:06:00 +00007319 sDistinct.isTnct = 2;
drh7512cb42016-04-14 13:06:49 +00007320
drh5e431be2022-04-06 11:08:38 +00007321#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007322 if( sqlite3TreeTrace & 0x20000 ){
7323 TREETRACE(0x20000,pParse,p,("Transform DISTINCT into GROUP BY:\n"));
drh7512cb42016-04-14 13:06:49 +00007324 sqlite3TreeViewSelect(0, p, 0);
7325 }
7326#endif
dan50118cd2011-07-01 14:21:38 +00007327 }
7328
drhadc57f62015-06-06 00:18:01 +00007329 /* If there is an ORDER BY clause, then create an ephemeral index to
7330 ** do the sorting. But this sorting ephemeral index might end up
7331 ** being unused if the data can be extracted in pre-sorted order.
7332 ** If that is the case, then the OP_OpenEphemeral instruction will be
7333 ** changed to an OP_Noop once we figure out that the sorting index is
7334 ** not needed. The sSort.addrSortIndex variable is used to facilitate
7335 ** that change.
danielk19777cedc8d2004-06-10 10:50:08 +00007336 */
drh079a3072014-03-19 14:10:55 +00007337 if( sSort.pOrderBy ){
drh0342b1f2005-09-01 03:07:44 +00007338 KeyInfo *pKeyInfo;
danf9eae182018-05-21 19:45:11 +00007339 pKeyInfo = sqlite3KeyInfoFromExprList(
7340 pParse, sSort.pOrderBy, 0, pEList->nExpr);
drh079a3072014-03-19 14:10:55 +00007341 sSort.iECursor = pParse->nTab++;
7342 sSort.addrSortIndex =
drh66a51672008-01-03 00:01:23 +00007343 sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
drhf45f2322014-03-23 17:45:03 +00007344 sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
7345 (char*)pKeyInfo, P4_KEYINFO
7346 );
drh9d2985c2005-09-08 01:58:42 +00007347 }else{
drh079a3072014-03-19 14:10:55 +00007348 sSort.addrSortIndex = -1;
danielk19777cedc8d2004-06-10 10:50:08 +00007349 }
7350
drh2d0794e2002-03-03 03:03:52 +00007351 /* If the output is destined for a temporary table, open that table.
7352 */
danielk19776c8c8ce2008-01-02 16:27:09 +00007353 if( pDest->eDest==SRT_EphemTab ){
drh2b596da2012-07-23 21:43:19 +00007354 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
drh18f86002022-04-21 13:11:26 +00007355 if( p->selFlags & SF_NestedFrom ){
7356 /* Delete or NULL-out result columns that will never be used */
7357 int ii;
drhd88fd532022-05-02 20:49:30 +00007358 for(ii=pEList->nExpr-1; ii>0 && pEList->a[ii].fg.bUsed==0; ii--){
drh18f86002022-04-21 13:11:26 +00007359 sqlite3ExprDelete(db, pEList->a[ii].pExpr);
7360 sqlite3DbFree(db, pEList->a[ii].zEName);
7361 pEList->nExpr--;
7362 }
7363 for(ii=0; ii<pEList->nExpr; ii++){
drhd88fd532022-05-02 20:49:30 +00007364 if( pEList->a[ii].fg.bUsed==0 ) pEList->a[ii].pExpr->op = TK_NULL;
drh18f86002022-04-21 13:11:26 +00007365 }
7366 }
drh2d0794e2002-03-03 03:03:52 +00007367 }
7368
drhf42bacc2006-04-26 17:39:34 +00007369 /* Set the limiter.
7370 */
drhec4ccdb2018-12-29 02:26:59 +00007371 iEnd = sqlite3VdbeMakeLabel(pParse);
dan69b93832016-12-16 15:05:40 +00007372 if( (p->selFlags & SF_FixedLimit)==0 ){
7373 p->nSelectRow = 320; /* 4 billion rows */
7374 }
drh3c8fb6f2022-07-26 01:20:18 +00007375 if( p->pLimit ) computeLimitRegisters(pParse, p, iEnd);
drh079a3072014-03-19 14:10:55 +00007376 if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
drh0ff287f2015-09-02 18:40:33 +00007377 sqlite3VdbeChangeOpcode(v, sSort.addrSortIndex, OP_SorterOpen);
drh079a3072014-03-19 14:10:55 +00007378 sSort.sortFlags |= SORTFLAG_UseSorter;
drhc6aff302011-09-01 15:32:47 +00007379 }
drhf42bacc2006-04-26 17:39:34 +00007380
drhadc57f62015-06-06 00:18:01 +00007381 /* Open an ephemeral index to use for the distinct set.
drhefb72512000-05-31 20:00:52 +00007382 */
dan2ce22452010-11-08 19:01:16 +00007383 if( p->selFlags & SF_Distinct ){
drhe8e4af72012-09-21 00:04:28 +00007384 sDistinct.tabTnct = pParse->nTab++;
7385 sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
danf9eae182018-05-21 19:45:11 +00007386 sDistinct.tabTnct, 0, 0,
7387 (char*)sqlite3KeyInfoFromExprList(pParse, p->pEList,0,0),
7388 P4_KEYINFO);
drhd4187c72010-08-30 22:15:45 +00007389 sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
drhe8e4af72012-09-21 00:04:28 +00007390 sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
drh832508b2002-03-02 17:04:07 +00007391 }else{
drhe8e4af72012-09-21 00:04:28 +00007392 sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
drhefb72512000-05-31 20:00:52 +00007393 }
drh832508b2002-03-02 17:04:07 +00007394
drh13449892005-09-07 21:22:45 +00007395 if( !isAgg && pGroupBy==0 ){
drhe8e4af72012-09-21 00:04:28 +00007396 /* No aggregate functions and no GROUP BY clause */
dan67a9b8e2018-06-22 20:51:35 +00007397 u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0)
7398 | (p->selFlags & SF_FixedLimit);
7399#ifndef SQLITE_OMIT_WINDOWFUNC
drh067b92b2020-06-19 15:24:12 +00007400 Window *pWin = p->pWin; /* Main window object (or NULL) */
danf9eae182018-05-21 19:45:11 +00007401 if( pWin ){
dan4ea562e2020-01-01 20:17:15 +00007402 sqlite3WindowCodeInit(pParse, p);
dan86fb6e12018-05-16 20:58:07 +00007403 }
dan67a9b8e2018-06-22 20:51:35 +00007404#endif
7405 assert( WHERE_USE_LIMIT==SF_FixedLimit );
7406
dan86fb6e12018-05-16 20:58:07 +00007407
dan38cc40c2011-06-30 20:17:15 +00007408 /* Begin the database scan. */
drh5d7aef12022-11-22 19:49:16 +00007409 TREETRACE(0x2,pParse,p,("WhereBegin\n"));
drh079a3072014-03-19 14:10:55 +00007410 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
drh895bab32022-01-27 16:14:50 +00007411 p->pEList, p, wctrlFlags, p->nSelectRow);
drh13449892005-09-07 21:22:45 +00007412 if( pWInfo==0 ) goto select_end;
drh6f328482013-06-05 23:39:34 +00007413 if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
7414 p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
7415 }
drh6457a352013-06-21 00:35:37 +00007416 if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
drh6f328482013-06-05 23:39:34 +00007417 sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
7418 }
drh079a3072014-03-19 14:10:55 +00007419 if( sSort.pOrderBy ){
7420 sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
drh6ee5a7b2018-09-08 20:09:46 +00007421 sSort.labelOBLopt = sqlite3WhereOrderByLimitOptLabel(pWInfo);
drh079a3072014-03-19 14:10:55 +00007422 if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
7423 sSort.pOrderBy = 0;
7424 }
7425 }
drh5d7aef12022-11-22 19:49:16 +00007426 TREETRACE(0x2,pParse,p,("WhereBegin returns\n"));
drhcce7d172000-05-31 15:34:51 +00007427
drhb9bb7c12006-06-11 23:41:55 +00007428 /* If sorting index that was created by a prior OP_OpenEphemeral
7429 ** instruction ended up not being needed, then change the OP_OpenEphemeral
drh9d2985c2005-09-08 01:58:42 +00007430 ** into an OP_Noop.
7431 */
drh079a3072014-03-19 14:10:55 +00007432 if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
7433 sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
drh9d2985c2005-09-08 01:58:42 +00007434 }
7435
drh2def2f72017-09-15 17:40:34 +00007436 assert( p->pEList==pEList );
dan67a9b8e2018-06-22 20:51:35 +00007437#ifndef SQLITE_OMIT_WINDOWFUNC
danf9eae182018-05-21 19:45:11 +00007438 if( pWin ){
drhec4ccdb2018-12-29 02:26:59 +00007439 int addrGosub = sqlite3VdbeMakeLabel(pParse);
7440 int iCont = sqlite3VdbeMakeLabel(pParse);
7441 int iBreak = sqlite3VdbeMakeLabel(pParse);
danf9eae182018-05-21 19:45:11 +00007442 int regGosub = ++pParse->nMem;
drhefb72512000-05-31 20:00:52 +00007443
dandacf1de2018-06-08 16:11:55 +00007444 sqlite3WindowCodeStep(pParse, p, pWInfo, regGosub, addrGosub);
dan86fb6e12018-05-16 20:58:07 +00007445
danefa3a3c2018-06-23 16:26:20 +00007446 sqlite3VdbeAddOp2(v, OP_Goto, 0, iBreak);
danf9eae182018-05-21 19:45:11 +00007447 sqlite3VdbeResolveLabel(v, addrGosub);
drhb0225bc2018-07-10 20:50:27 +00007448 VdbeNoopComment((v, "inner-loop subroutine"));
drhd4cb09e2018-09-17 15:19:13 +00007449 sSort.labelOBLopt = 0;
danefa3a3c2018-06-23 16:26:20 +00007450 selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest, iCont, iBreak);
dandacf1de2018-06-08 16:11:55 +00007451 sqlite3VdbeResolveLabel(v, iCont);
dan86fb6e12018-05-16 20:58:07 +00007452 sqlite3VdbeAddOp1(v, OP_Return, regGosub);
drh0b3b0dd2018-07-10 05:11:03 +00007453 VdbeComment((v, "end inner-loop subroutine"));
danefa3a3c2018-06-23 16:26:20 +00007454 sqlite3VdbeResolveLabel(v, iBreak);
dan67a9b8e2018-06-22 20:51:35 +00007455 }else
7456#endif /* SQLITE_OMIT_WINDOWFUNC */
7457 {
dan86fb6e12018-05-16 20:58:07 +00007458 /* Use the standard inner loop. */
7459 selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest,
7460 sqlite3WhereContinueLabel(pWInfo),
7461 sqlite3WhereBreakLabel(pWInfo));
7462
7463 /* End the database scan loop.
7464 */
drh5d7aef12022-11-22 19:49:16 +00007465 TREETRACE(0x2,pParse,p,("WhereEnd\n"));
dan86fb6e12018-05-16 20:58:07 +00007466 sqlite3WhereEnd(pWInfo);
7467 }
drh13449892005-09-07 21:22:45 +00007468 }else{
drhe8e4af72012-09-21 00:04:28 +00007469 /* This case when there exist aggregate functions or a GROUP BY clause
7470 ** or both */
drh13449892005-09-07 21:22:45 +00007471 NameContext sNC; /* Name context for processing aggregate information */
7472 int iAMem; /* First Mem address for storing current GROUP BY */
7473 int iBMem; /* First Mem address for previous GROUP BY */
7474 int iUseFlag; /* Mem address holding flag indicating that at least
7475 ** one row of the input to the aggregator has been
7476 ** processed */
7477 int iAbortFlag; /* Mem address which causes query abort if positive */
7478 int groupBySort; /* Rows come from source in GROUP BY order */
drhd1766112008-09-17 00:13:12 +00007479 int addrEnd; /* End of processing for this SELECT */
drh1c9d8352011-09-01 16:01:27 +00007480 int sortPTab = 0; /* Pseudotable used to decode sorting results */
7481 int sortOut = 0; /* Output register from the sorter */
dan374cd782014-04-21 13:21:56 +00007482 int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
drhcce7d172000-05-31 15:34:51 +00007483
drhd1766112008-09-17 00:13:12 +00007484 /* Remove any and all aliases between the result set and the
7485 ** GROUP BY clause.
7486 */
7487 if( pGroupBy ){
drhdc5ea5c2008-12-10 17:19:59 +00007488 int k; /* Loop counter */
drhd1766112008-09-17 00:13:12 +00007489 struct ExprList_item *pItem; /* For looping over expression in a list */
drhcce7d172000-05-31 15:34:51 +00007490
drhdc5ea5c2008-12-10 17:19:59 +00007491 for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
drhc2acc4e2013-11-15 18:15:19 +00007492 pItem->u.x.iAlias = 0;
drhd1766112008-09-17 00:13:12 +00007493 }
drhdc5ea5c2008-12-10 17:19:59 +00007494 for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
drhc2acc4e2013-11-15 18:15:19 +00007495 pItem->u.x.iAlias = 0;
drhd1766112008-09-17 00:13:12 +00007496 }
drhc3489bb2016-02-25 16:04:59 +00007497 assert( 66==sqlite3LogEst(100) );
7498 if( p->nSelectRow>66 ) p->nSelectRow = 66;
dan8c9bcb22019-09-21 15:44:12 +00007499
7500 /* If there is both a GROUP BY and an ORDER BY clause and they are
7501 ** identical, then it may be possible to disable the ORDER BY clause
7502 ** on the grounds that the GROUP BY will cause elements to come out
7503 ** in the correct order. It also may not - the GROUP BY might use a
7504 ** database index that causes rows to be grouped together as required
7505 ** but not actually sorted. Either way, record the fact that the
7506 ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
7507 ** variable. */
7508 if( sSort.pOrderBy && pGroupBy->nExpr==sSort.pOrderBy->nExpr ){
drhe39f3882019-09-21 17:31:03 +00007509 int ii;
dan8c9bcb22019-09-21 15:44:12 +00007510 /* The GROUP BY processing doesn't care whether rows are delivered in
7511 ** ASC or DESC order - only that each group is returned contiguously.
7512 ** So set the ASC/DESC flags in the GROUP BY to match those in the
7513 ** ORDER BY to maximize the chances of rows being delivered in an
7514 ** order that makes the ORDER BY redundant. */
drhe39f3882019-09-21 17:31:03 +00007515 for(ii=0; ii<pGroupBy->nExpr; ii++){
drhd88fd532022-05-02 20:49:30 +00007516 u8 sortFlags;
7517 sortFlags = sSort.pOrderBy->a[ii].fg.sortFlags & KEYINFO_ORDER_DESC;
7518 pGroupBy->a[ii].fg.sortFlags = sortFlags;
dan8c9bcb22019-09-21 15:44:12 +00007519 }
7520 if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
7521 orderByGrp = 1;
7522 }
7523 }
drh95aa47b2010-11-16 02:49:15 +00007524 }else{
drhc3489bb2016-02-25 16:04:59 +00007525 assert( 0==sqlite3LogEst(1) );
7526 p->nSelectRow = 0;
drhd1766112008-09-17 00:13:12 +00007527 }
drh13449892005-09-07 21:22:45 +00007528
drhd1766112008-09-17 00:13:12 +00007529 /* Create a label to jump to when we want to abort the query */
drhec4ccdb2018-12-29 02:26:59 +00007530 addrEnd = sqlite3VdbeMakeLabel(pParse);
drh13449892005-09-07 21:22:45 +00007531
7532 /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
7533 ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
7534 ** SELECT statement.
7535 */
drhbf790972020-06-07 20:18:07 +00007536 pAggInfo = sqlite3DbMallocZero(db, sizeof(*pAggInfo) );
drhc54246f2021-02-17 21:13:14 +00007537 if( pAggInfo ){
7538 sqlite3ParserAddCleanup(pParse,
7539 (void(*)(sqlite3*,void*))agginfoFree, pAggInfo);
drh6d0053c2021-03-09 19:32:37 +00007540 testcase( pParse->earlyCleanup );
drhc54246f2021-02-17 21:13:14 +00007541 }
7542 if( db->mallocFailed ){
drhbf790972020-06-07 20:18:07 +00007543 goto select_end;
7544 }
drhe26d4282020-06-09 11:59:15 +00007545 pAggInfo->selId = p->selId;
drh13449892005-09-07 21:22:45 +00007546 memset(&sNC, 0, sizeof(sNC));
7547 sNC.pParse = pParse;
7548 sNC.pSrcList = pTabList;
drhbf790972020-06-07 20:18:07 +00007549 sNC.uNC.pAggInfo = pAggInfo;
drh25c3b8c2018-04-16 10:34:13 +00007550 VVA_ONLY( sNC.ncFlags = NC_UAggInfo; )
drhbf790972020-06-07 20:18:07 +00007551 pAggInfo->nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
7552 pAggInfo->pGroupBy = pGroupBy;
drhd2b3e232008-01-23 14:51:49 +00007553 sqlite3ExprAnalyzeAggList(&sNC, pEList);
drh079a3072014-03-19 14:10:55 +00007554 sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
drhd2b3e232008-01-23 14:51:49 +00007555 if( pHaving ){
danab31a842017-04-29 20:53:09 +00007556 if( pGroupBy ){
7557 assert( pWhere==p->pWhere );
drhcd0abc22018-03-20 18:08:33 +00007558 assert( pHaving==p->pHaving );
7559 assert( pGroupBy==p->pGroupBy );
7560 havingToWhere(pParse, p);
danab31a842017-04-29 20:53:09 +00007561 pWhere = p->pWhere;
7562 }
drhd2b3e232008-01-23 14:51:49 +00007563 sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
drh13449892005-09-07 21:22:45 +00007564 }
drhbf790972020-06-07 20:18:07 +00007565 pAggInfo->nAccumulator = pAggInfo->nColumn;
7566 if( p->pGroupBy==0 && p->pHaving==0 && pAggInfo->nFunc==1 ){
drh81185a52020-06-09 13:38:12 +00007567 minMaxFlag = minMaxQuery(db, pAggInfo->aFunc[0].pFExpr, &pMinMaxOrderBy);
drh47d9f832017-10-26 20:04:28 +00007568 }else{
7569 minMaxFlag = WHERE_ORDERBY_NORMAL;
7570 }
drhc6138e92022-11-23 14:13:39 +00007571 analyzeAggFuncArgs(pParse, pAggInfo, &sNC);
drh17435752007-08-16 04:30:38 +00007572 if( db->mallocFailed ) goto select_end;
drh5e431be2022-04-06 11:08:38 +00007573#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007574 if( sqlite3TreeTrace & 0x20 ){
7575 TREETRACE(0x20,pParse,p,("After aggregate analysis %p:\n", pAggInfo));
drh7ea11062017-10-26 18:43:19 +00007576 sqlite3TreeViewSelect(0, p, 0);
drhb9366f82021-01-13 11:44:51 +00007577 if( minMaxFlag ){
7578 sqlite3DebugPrintf("MIN/MAX Optimization (0x%02x) adds:\n", minMaxFlag);
7579 sqlite3TreeViewExprList(0, pMinMaxOrderBy, 0, "ORDERBY");
7580 }
drhda217c92022-11-21 17:40:23 +00007581 printAggInfo(pAggInfo);
drh7ea11062017-10-26 18:43:19 +00007582 }
7583#endif
7584
drh13449892005-09-07 21:22:45 +00007585
7586 /* Processing for aggregates with GROUP BY is very different and
danielk19773c4809a2007-11-12 15:29:18 +00007587 ** much more complex than aggregates without a GROUP BY.
drh13449892005-09-07 21:22:45 +00007588 */
7589 if( pGroupBy ){
7590 KeyInfo *pKeyInfo; /* Keying information for the group by clause */
drh728e0f92015-10-10 14:41:28 +00007591 int addr1; /* A-vs-B comparision jump */
drhd1766112008-09-17 00:13:12 +00007592 int addrOutputRow; /* Start of subroutine that outputs a result row */
7593 int regOutputRow; /* Return address register for output subroutine */
7594 int addrSetAbort; /* Set the abort flag and return */
7595 int addrTopOfLoop; /* Top of the input loop */
7596 int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
7597 int addrReset; /* Subroutine for resetting the accumulator */
7598 int regReset; /* Return address register for reset subroutine */
dan5383db72021-03-12 18:24:31 +00007599 ExprList *pDistinct = 0;
7600 u16 distFlag = 0;
7601 int eDist = WHERE_DISTINCT_NOOP;
7602
7603 if( pAggInfo->nFunc==1
7604 && pAggInfo->aFunc[0].iDistinct>=0
drha4eeccd2021-10-07 17:43:30 +00007605 && ALWAYS(pAggInfo->aFunc[0].pFExpr!=0)
7606 && ALWAYS(ExprUseXList(pAggInfo->aFunc[0].pFExpr))
7607 && pAggInfo->aFunc[0].pFExpr->x.pList!=0
dan5383db72021-03-12 18:24:31 +00007608 ){
7609 Expr *pExpr = pAggInfo->aFunc[0].pFExpr->x.pList->a[0].pExpr;
7610 pExpr = sqlite3ExprDup(db, pExpr, 0);
7611 pDistinct = sqlite3ExprListDup(db, pGroupBy, 0);
7612 pDistinct = sqlite3ExprListAppend(pParse, pDistinct, pExpr);
danf330d532021-04-03 19:23:59 +00007613 distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
dan5383db72021-03-12 18:24:31 +00007614 }
drh13449892005-09-07 21:22:45 +00007615
7616 /* If there is a GROUP BY clause we might need a sorting index to
7617 ** implement it. Allocate that sorting index now. If it turns out
drh1c9d8352011-09-01 16:01:27 +00007618 ** that we do not need it after all, the OP_SorterOpen instruction
drh13449892005-09-07 21:22:45 +00007619 ** will be converted into a Noop.
7620 */
drhbf790972020-06-07 20:18:07 +00007621 pAggInfo->sortingIdx = pParse->nTab++;
7622 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pGroupBy,
7623 0, pAggInfo->nColumn);
drh1c9d8352011-09-01 16:01:27 +00007624 addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
drhbf790972020-06-07 20:18:07 +00007625 pAggInfo->sortingIdx, pAggInfo->nSortingColumn,
drh2ec2fb22013-11-06 19:59:23 +00007626 0, (char*)pKeyInfo, P4_KEYINFO);
drh13449892005-09-07 21:22:45 +00007627
7628 /* Initialize memory locations used by GROUP BY aggregate processing
7629 */
drh0a07c102008-01-03 18:03:08 +00007630 iUseFlag = ++pParse->nMem;
7631 iAbortFlag = ++pParse->nMem;
drhd1766112008-09-17 00:13:12 +00007632 regOutputRow = ++pParse->nMem;
drhec4ccdb2018-12-29 02:26:59 +00007633 addrOutputRow = sqlite3VdbeMakeLabel(pParse);
drhd1766112008-09-17 00:13:12 +00007634 regReset = ++pParse->nMem;
drhec4ccdb2018-12-29 02:26:59 +00007635 addrReset = sqlite3VdbeMakeLabel(pParse);
drh0a07c102008-01-03 18:03:08 +00007636 iAMem = pParse->nMem + 1;
drh13449892005-09-07 21:22:45 +00007637 pParse->nMem += pGroupBy->nExpr;
drh0a07c102008-01-03 18:03:08 +00007638 iBMem = pParse->nMem + 1;
drh13449892005-09-07 21:22:45 +00007639 pParse->nMem += pGroupBy->nExpr;
drh4c583122008-01-04 22:01:03 +00007640 sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
drhd4e70eb2008-01-02 00:34:36 +00007641 VdbeComment((v, "clear abort flag"));
drhb8475df2011-12-09 16:21:19 +00007642 sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
drhe3133822005-09-20 13:11:59 +00007643
drh13449892005-09-07 21:22:45 +00007644 /* Begin a loop that will extract all source rows in GROUP BY order.
7645 ** This might involve two separate loops with an OP_Sort in between, or
7646 ** it might be a single loop that uses an index to extract information
7647 ** in the right order to begin with.
7648 */
drh2eb95372008-06-06 15:04:36 +00007649 sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
drh5d7aef12022-11-22 19:49:16 +00007650 TREETRACE(0x2,pParse,p,("WhereBegin\n"));
dan5383db72021-03-12 18:24:31 +00007651 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, pDistinct,
drhfb643592022-10-22 23:09:29 +00007652 p, (sDistinct.isTnct==2 ? WHERE_DISTINCTBY : WHERE_GROUPBY)
danece092e2022-03-16 12:06:00 +00007653 | (orderByGrp ? WHERE_SORTBYGROUP : 0) | distFlag, 0
dan374cd782014-04-21 13:21:56 +00007654 );
danbfd6f1b2021-04-08 20:29:12 +00007655 if( pWInfo==0 ){
7656 sqlite3ExprListDelete(db, pDistinct);
7657 goto select_end;
7658 }
drhb23f1572022-11-22 20:37:41 +00007659 if( pParse->pIdxEpr ){
drhc6138e92022-11-23 14:13:39 +00007660 optimizeAggregateUseOfIndexedExpr(pParse, p, pAggInfo, &sNC);
drhb23f1572022-11-22 20:37:41 +00007661 }
drh42b78232022-11-22 14:10:22 +00007662 assignAggregateRegisters(pParse, pAggInfo);
dan76075802021-03-12 21:09:20 +00007663 eDist = sqlite3WhereIsDistinct(pWInfo);
drh5d7aef12022-11-22 19:49:16 +00007664 TREETRACE(0x2,pParse,p,("WhereBegin returns\n"));
drhddba0c22014-03-18 20:33:42 +00007665 if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
drh13449892005-09-07 21:22:45 +00007666 /* The optimizer is able to deliver rows in group by order so
drhb9bb7c12006-06-11 23:41:55 +00007667 ** we do not have to sort. The OP_OpenEphemeral table will be
drh13449892005-09-07 21:22:45 +00007668 ** cancelled later because we still need to use the pKeyInfo
7669 */
drh13449892005-09-07 21:22:45 +00007670 groupBySort = 0;
7671 }else{
7672 /* Rows are coming out in undetermined order. We have to push
7673 ** each row into a sorting index, terminate the first loop,
7674 ** then loop over the sorting index in order to get the output
7675 ** in sorted order
7676 */
drh892d3172008-01-10 03:46:36 +00007677 int regBase;
7678 int regRecord;
7679 int nCol;
7680 int nGroupBy;
7681
dan2ce22452010-11-08 19:01:16 +00007682 explainTempTable(pParse,
drhe8e4af72012-09-21 00:04:28 +00007683 (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
7684 "DISTINCT" : "GROUP BY");
dan2ce22452010-11-08 19:01:16 +00007685
drh13449892005-09-07 21:22:45 +00007686 groupBySort = 1;
drh892d3172008-01-10 03:46:36 +00007687 nGroupBy = pGroupBy->nExpr;
dandd23c6b2014-03-24 20:19:07 +00007688 nCol = nGroupBy;
7689 j = nGroupBy;
drhbf790972020-06-07 20:18:07 +00007690 for(i=0; i<pAggInfo->nColumn; i++){
7691 if( pAggInfo->aCol[i].iSorterColumn>=j ){
drh892d3172008-01-10 03:46:36 +00007692 nCol++;
7693 j++;
7694 }
7695 }
7696 regBase = sqlite3GetTempRange(pParse, nCol);
drh5579d592015-08-26 14:01:41 +00007697 sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0, 0);
dandd23c6b2014-03-24 20:19:07 +00007698 j = nGroupBy;
drhee373022022-07-25 15:54:23 +00007699 pAggInfo->directMode = 1;
drhbf790972020-06-07 20:18:07 +00007700 for(i=0; i<pAggInfo->nColumn; i++){
7701 struct AggInfo_col *pCol = &pAggInfo->aCol[i];
drh892d3172008-01-10 03:46:36 +00007702 if( pCol->iSorterColumn>=j ){
drhee373022022-07-25 15:54:23 +00007703 sqlite3ExprCode(pParse, pCol->pCExpr, j + regBase);
drh6a012f02008-08-21 14:15:59 +00007704 j++;
drh892d3172008-01-10 03:46:36 +00007705 }
drh13449892005-09-07 21:22:45 +00007706 }
drhee373022022-07-25 15:54:23 +00007707 pAggInfo->directMode = 0;
drh892d3172008-01-10 03:46:36 +00007708 regRecord = sqlite3GetTempReg(pParse);
drh1db639c2008-01-17 02:36:28 +00007709 sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
drhbf790972020-06-07 20:18:07 +00007710 sqlite3VdbeAddOp2(v, OP_SorterInsert, pAggInfo->sortingIdx, regRecord);
drh892d3172008-01-10 03:46:36 +00007711 sqlite3ReleaseTempReg(pParse, regRecord);
7712 sqlite3ReleaseTempRange(pParse, regBase, nCol);
drh5d7aef12022-11-22 19:49:16 +00007713 TREETRACE(0x2,pParse,p,("WhereEnd\n"));
drh13449892005-09-07 21:22:45 +00007714 sqlite3WhereEnd(pWInfo);
drhbf790972020-06-07 20:18:07 +00007715 pAggInfo->sortingIdxPTab = sortPTab = pParse->nTab++;
drh1c9d8352011-09-01 16:01:27 +00007716 sortOut = sqlite3GetTempReg(pParse);
7717 sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
drhbf790972020-06-07 20:18:07 +00007718 sqlite3VdbeAddOp2(v, OP_SorterSort, pAggInfo->sortingIdx, addrEnd);
drh688852a2014-02-17 22:40:43 +00007719 VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
drhbf790972020-06-07 20:18:07 +00007720 pAggInfo->useSortingIdx = 1;
dan374cd782014-04-21 13:21:56 +00007721 }
7722
drh9b80cb52022-11-24 01:40:20 +00007723 /* If there entries in pAgggInfo->aFunc[] that contain subexpressions
7724 ** that are indexed (and that were previously identified and tagged
7725 ** in optimizeAggregateUseOfIndexedExpr()) then those subexpressions
7726 ** must now be converted into a TK_AGG_COLUMN node so that the value
7727 ** is correctly pulled from the index rather than being recomputed. */
drh2e30d952022-11-23 18:51:04 +00007728 if( pParse->pIdxEpr ){
7729 aggregateConvertIndexedExprRefToColumn(pAggInfo);
7730#if TREETRACE_ENABLED
7731 if( sqlite3TreeTrace & 0x20 ){
7732 TREETRACE(0x20, pParse, p,
7733 ("AggInfo function expressions converted to reference index\n"));
7734 sqlite3TreeViewSelect(0, p, 0);
7735 printAggInfo(pAggInfo);
7736 }
7737#endif
7738 }
7739
dan374cd782014-04-21 13:21:56 +00007740 /* If the index or temporary table used by the GROUP BY sort
7741 ** will naturally deliver rows in the order required by the ORDER BY
7742 ** clause, cancel the ephemeral table open coded earlier.
7743 **
7744 ** This is an optimization - the correct answer should result regardless.
7745 ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
7746 ** disable this optimization for testing purposes. */
7747 if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
7748 && (groupBySort || sqlite3WhereIsSorted(pWInfo))
7749 ){
7750 sSort.pOrderBy = 0;
7751 sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
drh13449892005-09-07 21:22:45 +00007752 }
7753
7754 /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
7755 ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
7756 ** Then compare the current GROUP BY terms against the GROUP BY terms
7757 ** from the previous row currently stored in a0, a1, a2...
7758 */
7759 addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
drh1c9d8352011-09-01 16:01:27 +00007760 if( groupBySort ){
drhbf790972020-06-07 20:18:07 +00007761 sqlite3VdbeAddOp3(v, OP_SorterData, pAggInfo->sortingIdx,
drh38b41492015-06-08 15:08:15 +00007762 sortOut, sortPTab);
drh1c9d8352011-09-01 16:01:27 +00007763 }
drh13449892005-09-07 21:22:45 +00007764 for(j=0; j<pGroupBy->nExpr; j++){
7765 if( groupBySort ){
drh1c9d8352011-09-01 16:01:27 +00007766 sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
drh13449892005-09-07 21:22:45 +00007767 }else{
drhbf790972020-06-07 20:18:07 +00007768 pAggInfo->directMode = 1;
drh2dcef112008-01-12 19:03:48 +00007769 sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
drh13449892005-09-07 21:22:45 +00007770 }
drh13449892005-09-07 21:22:45 +00007771 }
drh16ee60f2008-06-20 18:13:25 +00007772 sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
drh2ec2fb22013-11-06 19:59:23 +00007773 (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
drh728e0f92015-10-10 14:41:28 +00007774 addr1 = sqlite3VdbeCurrentAddr(v);
7775 sqlite3VdbeAddOp3(v, OP_Jump, addr1+1, 0, addr1+1); VdbeCoverage(v);
drh13449892005-09-07 21:22:45 +00007776
7777 /* Generate code that runs whenever the GROUP BY changes.
drhe00ee6e2008-06-20 15:24:01 +00007778 ** Changes in the GROUP BY are detected by the previous code
drh13449892005-09-07 21:22:45 +00007779 ** block. If there were no changes, this block is skipped.
7780 **
7781 ** This code copies current group by terms in b0,b1,b2,...
7782 ** over to a0,a1,a2. It then calls the output subroutine
7783 ** and resets the aggregate accumulator registers in preparation
7784 ** for the next GROUP BY batch.
7785 */
drhb21e7c72008-06-22 12:37:57 +00007786 sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
drh2eb95372008-06-06 15:04:36 +00007787 sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
drhd4e70eb2008-01-02 00:34:36 +00007788 VdbeComment((v, "output one row"));
drh688852a2014-02-17 22:40:43 +00007789 sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
drhd4e70eb2008-01-02 00:34:36 +00007790 VdbeComment((v, "check abort flag"));
drh2eb95372008-06-06 15:04:36 +00007791 sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
drhd4e70eb2008-01-02 00:34:36 +00007792 VdbeComment((v, "reset accumulator"));
drh13449892005-09-07 21:22:45 +00007793
7794 /* Update the aggregate accumulators based on the content of
7795 ** the current row
7796 */
drh728e0f92015-10-10 14:41:28 +00007797 sqlite3VdbeJumpHere(v, addr1);
dan5383db72021-03-12 18:24:31 +00007798 updateAccumulator(pParse, iUseFlag, pAggInfo, eDist);
drh4c583122008-01-04 22:01:03 +00007799 sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
drhd4e70eb2008-01-02 00:34:36 +00007800 VdbeComment((v, "indicate data in accumulator"));
drh13449892005-09-07 21:22:45 +00007801
7802 /* End of the loop
7803 */
7804 if( groupBySort ){
drhd1930572021-01-13 15:23:17 +00007805 sqlite3VdbeAddOp2(v, OP_SorterNext, pAggInfo->sortingIdx,addrTopOfLoop);
drh688852a2014-02-17 22:40:43 +00007806 VdbeCoverage(v);
drh13449892005-09-07 21:22:45 +00007807 }else{
drh5d7aef12022-11-22 19:49:16 +00007808 TREETRACE(0x2,pParse,p,("WhereEnd\n"));
drh13449892005-09-07 21:22:45 +00007809 sqlite3WhereEnd(pWInfo);
drh48f2d3b2011-09-16 01:34:43 +00007810 sqlite3VdbeChangeToNoop(v, addrSortingIdx);
drh13449892005-09-07 21:22:45 +00007811 }
danbfd6f1b2021-04-08 20:29:12 +00007812 sqlite3ExprListDelete(db, pDistinct);
drh13449892005-09-07 21:22:45 +00007813
7814 /* Output the final row of result
7815 */
drh2eb95372008-06-06 15:04:36 +00007816 sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
drhd4e70eb2008-01-02 00:34:36 +00007817 VdbeComment((v, "output final row"));
drhd1766112008-09-17 00:13:12 +00007818
7819 /* Jump over the subroutines
7820 */
drh076e85f2015-09-03 13:46:12 +00007821 sqlite3VdbeGoto(v, addrEnd);
drhd1766112008-09-17 00:13:12 +00007822
7823 /* Generate a subroutine that outputs a single row of the result
7824 ** set. This subroutine first looks at the iUseFlag. If iUseFlag
7825 ** is less than or equal to zero, the subroutine is a no-op. If
7826 ** the processing calls for the query to abort, this subroutine
7827 ** increments the iAbortFlag memory location before returning in
7828 ** order to signal the caller to abort.
7829 */
7830 addrSetAbort = sqlite3VdbeCurrentAddr(v);
7831 sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
7832 VdbeComment((v, "set abort flag"));
7833 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7834 sqlite3VdbeResolveLabel(v, addrOutputRow);
7835 addrOutputRow = sqlite3VdbeCurrentAddr(v);
7836 sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2);
drh38b41492015-06-08 15:08:15 +00007837 VdbeCoverage(v);
drhd1766112008-09-17 00:13:12 +00007838 VdbeComment((v, "Groupby result generator entry point"));
7839 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
drhbf790972020-06-07 20:18:07 +00007840 finalizeAggFunctions(pParse, pAggInfo);
drh33cd4902009-05-30 20:49:20 +00007841 sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
drh2def2f72017-09-15 17:40:34 +00007842 selectInnerLoop(pParse, p, -1, &sSort,
drhe8e4af72012-09-21 00:04:28 +00007843 &sDistinct, pDest,
drhd1766112008-09-17 00:13:12 +00007844 addrOutputRow+1, addrSetAbort);
7845 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7846 VdbeComment((v, "end groupby result generator"));
7847
7848 /* Generate a subroutine that will reset the group-by accumulator
7849 */
7850 sqlite3VdbeResolveLabel(v, addrReset);
drhbf790972020-06-07 20:18:07 +00007851 resetAccumulator(pParse, pAggInfo);
dan280c8942018-06-05 20:04:28 +00007852 sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
7853 VdbeComment((v, "indicate accumulator empty"));
drhd1766112008-09-17 00:13:12 +00007854 sqlite3VdbeAddOp1(v, OP_Return, regReset);
dan5383db72021-03-12 18:24:31 +00007855
danece092e2022-03-16 12:06:00 +00007856 if( distFlag!=0 && eDist!=WHERE_DISTINCT_NOOP ){
dan5383db72021-03-12 18:24:31 +00007857 struct AggInfo_func *pF = &pAggInfo->aFunc[0];
7858 fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7859 }
drh43152cf2009-05-19 19:04:58 +00007860 } /* endif pGroupBy. Begin aggregate queries without GROUP BY: */
drh13449892005-09-07 21:22:45 +00007861 else {
danielk1977a5533162009-02-24 10:01:51 +00007862 Table *pTab;
drhbf790972020-06-07 20:18:07 +00007863 if( (pTab = isSimpleCount(p, pAggInfo))!=0 ){
danielk1977a5533162009-02-24 10:01:51 +00007864 /* If isSimpleCount() returns a pointer to a Table structure, then
7865 ** the SQL statement is of the form:
7866 **
7867 ** SELECT count(*) FROM <tbl>
7868 **
7869 ** where the Table structure returned represents table <tbl>.
7870 **
7871 ** This statement is so common that it is optimized specially. The
7872 ** OP_Count instruction is executed either on the intkey table that
7873 ** contains the data for table <tbl> or on one of its indexes. It
7874 ** is better to execute the op on an index, as indexes are almost
7875 ** always spread across less pages than their corresponding tables.
7876 */
7877 const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
7878 const int iCsr = pParse->nTab++; /* Cursor to scan b-tree */
7879 Index *pIdx; /* Iterator variable */
7880 KeyInfo *pKeyInfo = 0; /* Keyinfo for scanned index */
7881 Index *pBest = 0; /* Best index found so far */
drh013e7bb2020-07-30 17:37:49 +00007882 Pgno iRoot = pTab->tnum; /* Root page of scanned b-tree */
danielk1977a9d1ccb2008-01-05 17:39:29 +00007883
danielk1977a5533162009-02-24 10:01:51 +00007884 sqlite3CodeVerifySchema(pParse, iDb);
7885 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
7886
drhd9e3cad2013-10-04 02:36:19 +00007887 /* Search for the index that has the lowest scan cost.
danielk1977a5533162009-02-24 10:01:51 +00007888 **
drh3e9548b2011-04-15 14:46:27 +00007889 ** (2011-04-15) Do not do a full scan of an unordered index.
7890 **
drhabcc1942013-11-12 14:55:40 +00007891 ** (2013-10-03) Do not count the entries in a partial index.
drh5f33f372013-10-04 00:00:12 +00007892 **
danielk1977a5533162009-02-24 10:01:51 +00007893 ** In practice the KeyInfo structure will not be used. It is only
7894 ** passed to keep OP_OpenRead happy.
7895 */
drh5c7917e2013-11-12 15:33:40 +00007896 if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
drh98aa1d72020-05-08 18:22:00 +00007897 if( !p->pSrc->a[0].fg.notIndexed ){
7898 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
7899 if( pIdx->bUnordered==0
7900 && pIdx->szIdxRow<pTab->szTabRow
7901 && pIdx->pPartIdxWhere==0
7902 && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
7903 ){
7904 pBest = pIdx;
7905 }
danielk1977a5533162009-02-24 10:01:51 +00007906 }
7907 }
drhd9e3cad2013-10-04 02:36:19 +00007908 if( pBest ){
danielk1977a5533162009-02-24 10:01:51 +00007909 iRoot = pBest->tnum;
drh2ec2fb22013-11-06 19:59:23 +00007910 pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
danielk1977a5533162009-02-24 10:01:51 +00007911 }
7912
7913 /* Open a read-only cursor, execute the OP_Count, close the cursor. */
drh013e7bb2020-07-30 17:37:49 +00007914 sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, (int)iRoot, iDb, 1);
danielk1977a5533162009-02-24 10:01:51 +00007915 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00007916 sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
danielk1977a5533162009-02-24 10:01:51 +00007917 }
drh42b78232022-11-22 14:10:22 +00007918 assignAggregateRegisters(pParse, pAggInfo);
drh3c8e4382022-11-22 15:43:16 +00007919 sqlite3VdbeAddOp2(v, OP_Count, iCsr, AggInfoFuncReg(pAggInfo,0));
danielk1977a5533162009-02-24 10:01:51 +00007920 sqlite3VdbeAddOp1(v, OP_Close, iCsr);
danef7075d2011-02-21 17:49:49 +00007921 explainSimpleCount(pParse, pTab, pBest);
drhe50478d2020-03-17 13:41:51 +00007922 }else{
dan280c8942018-06-05 20:04:28 +00007923 int regAcc = 0; /* "populate accumulators" flag */
dan4fcb30b2021-03-09 16:06:25 +00007924 ExprList *pDistinct = 0;
7925 u16 distFlag = 0;
dan5383db72021-03-12 18:24:31 +00007926 int eDist;
dan280c8942018-06-05 20:04:28 +00007927
daned09ddd2019-09-20 20:52:16 +00007928 /* If there are accumulator registers but no min() or max() functions
7929 ** without FILTER clauses, allocate register regAcc. Register regAcc
7930 ** will contain 0 the first time the inner loop runs, and 1 thereafter.
7931 ** The code generated by updateAccumulator() uses this to ensure
7932 ** that the accumulator registers are (a) updated only once if
7933 ** there are no min() or max functions or (b) always updated for the
7934 ** first row visited by the aggregate, so that they are updated at
7935 ** least once even if the FILTER clause means the min() or max()
7936 ** function visits zero rows. */
drhbf790972020-06-07 20:18:07 +00007937 if( pAggInfo->nAccumulator ){
7938 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00007939 if( ExprHasProperty(pAggInfo->aFunc[i].pFExpr, EP_WinFunc) ){
drhbf790972020-06-07 20:18:07 +00007940 continue;
7941 }
7942 if( pAggInfo->aFunc[i].pFunc->funcFlags&SQLITE_FUNC_NEEDCOLL ){
7943 break;
7944 }
dan280c8942018-06-05 20:04:28 +00007945 }
drhbf790972020-06-07 20:18:07 +00007946 if( i==pAggInfo->nFunc ){
dan280c8942018-06-05 20:04:28 +00007947 regAcc = ++pParse->nMem;
7948 sqlite3VdbeAddOp2(v, OP_Integer, 0, regAcc);
7949 }
dan4fcb30b2021-03-09 16:06:25 +00007950 }else if( pAggInfo->nFunc==1 && pAggInfo->aFunc[0].iDistinct>=0 ){
drha4eeccd2021-10-07 17:43:30 +00007951 assert( ExprUseXList(pAggInfo->aFunc[0].pFExpr) );
dan4fcb30b2021-03-09 16:06:25 +00007952 pDistinct = pAggInfo->aFunc[0].pFExpr->x.pList;
danf330d532021-04-03 19:23:59 +00007953 distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
dan280c8942018-06-05 20:04:28 +00007954 }
drh42b78232022-11-22 14:10:22 +00007955 assignAggregateRegisters(pParse, pAggInfo);
dan280c8942018-06-05 20:04:28 +00007956
danielk1977a5533162009-02-24 10:01:51 +00007957 /* This case runs if the aggregate has no GROUP BY clause. The
7958 ** processing is much simpler since there is only a single row
7959 ** of output.
7960 */
drh47d9f832017-10-26 20:04:28 +00007961 assert( p->pGroupBy==0 );
drhbf790972020-06-07 20:18:07 +00007962 resetAccumulator(pParse, pAggInfo);
drh47d9f832017-10-26 20:04:28 +00007963
7964 /* If this query is a candidate for the min/max optimization, then
7965 ** minMaxFlag will have been previously set to either
7966 ** WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX and pMinMaxOrderBy will
7967 ** be an appropriate ORDER BY expression for the optimization.
7968 */
7969 assert( minMaxFlag==WHERE_ORDERBY_NORMAL || pMinMaxOrderBy!=0 );
7970 assert( pMinMaxOrderBy==0 || pMinMaxOrderBy->nExpr==1 );
7971
drh5d7aef12022-11-22 19:49:16 +00007972 TREETRACE(0x2,pParse,p,("WhereBegin\n"));
drh47d9f832017-10-26 20:04:28 +00007973 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMaxOrderBy,
drhfb643592022-10-22 23:09:29 +00007974 pDistinct, p, minMaxFlag|distFlag, 0);
danielk1977a5533162009-02-24 10:01:51 +00007975 if( pWInfo==0 ){
danielk1977a5533162009-02-24 10:01:51 +00007976 goto select_end;
7977 }
drh5d7aef12022-11-22 19:49:16 +00007978 TREETRACE(0x2,pParse,p,("WhereBegin returns\n"));
dan5383db72021-03-12 18:24:31 +00007979 eDist = sqlite3WhereIsDistinct(pWInfo);
7980 updateAccumulator(pParse, regAcc, pAggInfo, eDist);
7981 if( eDist!=WHERE_DISTINCT_NOOP ){
drhde695ea2022-05-10 15:55:10 +00007982 struct AggInfo_func *pF = pAggInfo->aFunc;
drh3117b7b2022-04-19 18:23:01 +00007983 if( pF ){
7984 fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7985 }
dan5383db72021-03-12 18:24:31 +00007986 }
7987
dan280c8942018-06-05 20:04:28 +00007988 if( regAcc ) sqlite3VdbeAddOp2(v, OP_Integer, 1, regAcc);
drhd1930572021-01-13 15:23:17 +00007989 if( minMaxFlag ){
7990 sqlite3WhereMinMaxOptEarlyOut(v, pWInfo);
danielk1977a5533162009-02-24 10:01:51 +00007991 }
drh5d7aef12022-11-22 19:49:16 +00007992 TREETRACE(0x2,pParse,p,("WhereEnd\n"));
danielk1977a5533162009-02-24 10:01:51 +00007993 sqlite3WhereEnd(pWInfo);
drhbf790972020-06-07 20:18:07 +00007994 finalizeAggFunctions(pParse, pAggInfo);
danielk1977a9d1ccb2008-01-05 17:39:29 +00007995 }
7996
drh079a3072014-03-19 14:10:55 +00007997 sSort.pOrderBy = 0;
drh33cd4902009-05-30 20:49:20 +00007998 sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
drh2def2f72017-09-15 17:40:34 +00007999 selectInnerLoop(pParse, p, -1, 0, 0,
drha9671a22008-07-08 23:40:20 +00008000 pDest, addrEnd, addrEnd);
drh13449892005-09-07 21:22:45 +00008001 }
8002 sqlite3VdbeResolveLabel(v, addrEnd);
8003
8004 } /* endif aggregate query */
drh22827922000-06-06 17:27:05 +00008005
drhe8e4af72012-09-21 00:04:28 +00008006 if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
dan2ce22452010-11-08 19:01:16 +00008007 explainTempTable(pParse, "DISTINCT");
8008 }
8009
drhcce7d172000-05-31 15:34:51 +00008010 /* If there is an ORDER BY clause, then we need to sort the results
8011 ** and send them to the callback one by one.
8012 */
drh079a3072014-03-19 14:10:55 +00008013 if( sSort.pOrderBy ){
drh38b41492015-06-08 15:08:15 +00008014 explainTempTable(pParse,
8015 sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
dan24e25d32018-04-14 18:46:20 +00008016 assert( p->pEList==pEList );
drh079a3072014-03-19 14:10:55 +00008017 generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
drhcce7d172000-05-31 15:34:51 +00008018 }
drh6a535342001-10-19 16:44:56 +00008019
drhec7429a2005-10-06 16:53:14 +00008020 /* Jump here to skip this query
8021 */
8022 sqlite3VdbeResolveLabel(v, iEnd);
8023
dan5b1c07e2015-04-16 07:19:23 +00008024 /* The SELECT has been coded. If there is an error in the Parse structure,
8025 ** set the return code to 1. Otherwise 0. */
8026 rc = (pParse->nErr>0);
drh1d83f052002-02-17 00:30:36 +00008027
8028 /* Control jumps to here if an error is encountered above, or upon
8029 ** successful coding of the SELECT.
8030 */
8031select_end:
dan44918c72021-04-17 14:42:37 +00008032 assert( db->mallocFailed==0 || db->mallocFailed==1 );
drh0c7d3d32022-01-24 16:47:12 +00008033 assert( db->mallocFailed==0 || pParse->nErr!=0 );
drh47d9f832017-10-26 20:04:28 +00008034 sqlite3ExprListDelete(db, pMinMaxOrderBy);
drh89636622020-06-07 17:33:18 +00008035#ifdef SQLITE_DEBUG
drh7b4c4d42020-06-10 03:07:26 +00008036 if( pAggInfo && !db->mallocFailed ){
drhbf790972020-06-07 20:18:07 +00008037 for(i=0; i<pAggInfo->nColumn; i++){
drh81185a52020-06-09 13:38:12 +00008038 Expr *pExpr = pAggInfo->aCol[i].pCExpr;
drh590f0132022-11-23 17:56:00 +00008039 if( pExpr==0 ) continue;
drhbf790972020-06-07 20:18:07 +00008040 assert( pExpr->pAggInfo==pAggInfo );
drh89636622020-06-07 17:33:18 +00008041 assert( pExpr->iAgg==i );
8042 }
drhbf790972020-06-07 20:18:07 +00008043 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00008044 Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
drh06ddb082020-12-22 14:54:20 +00008045 assert( pExpr!=0 );
drhbf790972020-06-07 20:18:07 +00008046 assert( pExpr->pAggInfo==pAggInfo );
drh89636622020-06-07 17:33:18 +00008047 assert( pExpr->iAgg==i );
8048 }
drh89636622020-06-07 17:33:18 +00008049 }
drh89636622020-06-07 17:33:18 +00008050#endif
8051
drh5e431be2022-04-06 11:08:38 +00008052#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00008053 TREETRACE(0x1,pParse,p,("end processing\n"));
8054 if( (sqlite3TreeTrace & 0x40000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
drhf20609d2018-04-23 17:43:35 +00008055 sqlite3TreeViewSelect(0, p, 0);
8056 }
drheb9b8842014-09-21 00:27:26 +00008057#endif
drhe2ca99c2018-05-02 00:33:43 +00008058 ExplainQueryPlanPop(pParse);
drh1d83f052002-02-17 00:30:36 +00008059 return rc;
drhcce7d172000-05-31 15:34:51 +00008060}