blob: d9e0e876984e595482eb937c3ed4c68cb975885c [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){
79 while( p ){
80 Select *pPrior = p->pPrior;
81 sqlite3ExprListDelete(db, p->pEList);
82 sqlite3SrcListDelete(db, p->pSrc);
83 sqlite3ExprDelete(db, p->pWhere);
84 sqlite3ExprListDelete(db, p->pGroupBy);
85 sqlite3ExprDelete(db, p->pHaving);
86 sqlite3ExprListDelete(db, p->pOrderBy);
87 sqlite3ExprDelete(db, p->pLimit);
dan50f9f6c2021-03-04 14:18:22 +000088 if( OK_IF_ALWAYS_TRUE(p->pWith) ) sqlite3WithDelete(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +000089#ifndef SQLITE_OMIT_WINDOWFUNC
dane3bf6322018-06-08 20:58:27 +000090 if( OK_IF_ALWAYS_TRUE(p->pWinDefn) ){
91 sqlite3WindowListDelete(db, p->pWinDefn);
92 }
dan50f9f6c2021-03-04 14:18:22 +000093 while( p->pWin ){
94 assert( p->pWin->ppThis==&p->pWin );
95 sqlite3WindowUnlinkFromSelect(p->pWin);
96 }
dan67a9b8e2018-06-22 20:51:35 +000097#endif
drhdbd6a7d2017-04-05 12:39:49 +000098 if( bFree ) sqlite3DbFreeNN(db, p);
drhb87fbed2015-01-05 15:48:45 +000099 p = pPrior;
100 bFree = 1;
101 }
drheda639e2006-01-22 00:42:09 +0000102}
103
drh1013c932008-01-06 00:25:21 +0000104/*
105** Initialize a SelectDest structure.
106*/
107void sqlite3SelectDestInit(SelectDest *pDest, int eDest, int iParm){
drhea678832008-12-10 19:26:22 +0000108 pDest->eDest = (u8)eDest;
drh2b596da2012-07-23 21:43:19 +0000109 pDest->iSDParm = iParm;
dan9ed322d2020-04-29 17:41:29 +0000110 pDest->iSDParm2 = 0;
dan71c57db2016-07-09 20:23:55 +0000111 pDest->zAffSdst = 0;
drh2b596da2012-07-23 21:43:19 +0000112 pDest->iSdst = 0;
113 pDest->nSdst = 0;
drh1013c932008-01-06 00:25:21 +0000114}
115
drheda639e2006-01-22 00:42:09 +0000116
117/*
drh9bb61fe2000-06-05 16:01:39 +0000118** Allocate a new Select structure and return a pointer to that
119** structure.
drhcce7d172000-05-31 15:34:51 +0000120*/
danielk19774adee202004-05-08 08:23:19 +0000121Select *sqlite3SelectNew(
drh17435752007-08-16 04:30:38 +0000122 Parse *pParse, /* Parsing context */
drhdaffd0e2001-04-11 14:28:42 +0000123 ExprList *pEList, /* which columns to include in the result */
drhad3cab52002-05-24 02:04:32 +0000124 SrcList *pSrc, /* the FROM clause -- which tables to scan */
drhdaffd0e2001-04-11 14:28:42 +0000125 Expr *pWhere, /* the WHERE clause */
126 ExprList *pGroupBy, /* the GROUP BY clause */
127 Expr *pHaving, /* the HAVING clause */
128 ExprList *pOrderBy, /* the ORDER BY clause */
drhc3489bb2016-02-25 16:04:59 +0000129 u32 selFlags, /* Flag parameters, such as SF_Distinct */
drh8c0833f2017-11-14 23:48:23 +0000130 Expr *pLimit /* LIMIT value. NULL means not used */
drh9bb61fe2000-06-05 16:01:39 +0000131){
drhd3bf7662020-05-25 01:31:09 +0000132 Select *pNew, *pAllocated;
drheda639e2006-01-22 00:42:09 +0000133 Select standin;
drhd3bf7662020-05-25 01:31:09 +0000134 pAllocated = pNew = sqlite3DbMallocRawNN(pParse->db, sizeof(*pNew) );
drhdaffd0e2001-04-11 14:28:42 +0000135 if( pNew==0 ){
drhef90a6b2017-04-11 16:44:39 +0000136 assert( pParse->db->mallocFailed );
drheda639e2006-01-22 00:42:09 +0000137 pNew = &standin;
drheda639e2006-01-22 00:42:09 +0000138 }
139 if( pEList==0 ){
drh3d240d22017-09-28 16:56:55 +0000140 pEList = sqlite3ExprListAppend(pParse, 0,
141 sqlite3Expr(pParse->db,TK_ASTERISK,0));
drheda639e2006-01-22 00:42:09 +0000142 }
143 pNew->pEList = pEList;
drhca3862d2016-01-08 12:46:39 +0000144 pNew->op = TK_SELECT;
145 pNew->selFlags = selFlags;
146 pNew->iLimit = 0;
147 pNew->iOffset = 0;
drhfef37762018-07-10 19:48:35 +0000148 pNew->selId = ++pParse->nSelect;
drhca3862d2016-01-08 12:46:39 +0000149 pNew->addrOpenEphm[0] = -1;
150 pNew->addrOpenEphm[1] = -1;
151 pNew->nSelectRow = 0;
drhef90a6b2017-04-11 16:44:39 +0000152 if( pSrc==0 ) pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*pSrc));
drheda639e2006-01-22 00:42:09 +0000153 pNew->pSrc = pSrc;
154 pNew->pWhere = pWhere;
155 pNew->pGroupBy = pGroupBy;
156 pNew->pHaving = pHaving;
157 pNew->pOrderBy = pOrderBy;
drhca3862d2016-01-08 12:46:39 +0000158 pNew->pPrior = 0;
159 pNew->pNext = 0;
drheda639e2006-01-22 00:42:09 +0000160 pNew->pLimit = pLimit;
drhca3862d2016-01-08 12:46:39 +0000161 pNew->pWith = 0;
dan67a9b8e2018-06-22 20:51:35 +0000162#ifndef SQLITE_OMIT_WINDOWFUNC
dan86fb6e12018-05-16 20:58:07 +0000163 pNew->pWin = 0;
dane3bf6322018-06-08 20:58:27 +0000164 pNew->pWinDefn = 0;
dan67a9b8e2018-06-22 20:51:35 +0000165#endif
drhef90a6b2017-04-11 16:44:39 +0000166 if( pParse->db->mallocFailed ) {
167 clearSelect(pParse->db, pNew, pNew!=&standin);
drhd3bf7662020-05-25 01:31:09 +0000168 pAllocated = 0;
drha464c232011-09-16 19:04:03 +0000169 }else{
170 assert( pNew->pSrc!=0 || pParse->nErr>0 );
drhdaffd0e2001-04-11 14:28:42 +0000171 }
drhd3bf7662020-05-25 01:31:09 +0000172 return pAllocated;
drh9bb61fe2000-06-05 16:01:39 +0000173}
174
drheb9b8842014-09-21 00:27:26 +0000175
drh9bb61fe2000-06-05 16:01:39 +0000176/*
drheda639e2006-01-22 00:42:09 +0000177** Delete the given Select structure and all of its substructures.
178*/
drh633e6d52008-07-28 19:34:53 +0000179void sqlite3SelectDelete(sqlite3 *db, Select *p){
drh8906a4b2017-10-03 17:29:40 +0000180 if( OK_IF_ALWAYS_TRUE(p) ) clearSelect(db, p, 1);
drheda639e2006-01-22 00:42:09 +0000181}
182
183/*
drhd227a292014-02-09 18:02:09 +0000184** Return a pointer to the right-most SELECT statement in a compound.
185*/
186static Select *findRightmost(Select *p){
187 while( p->pNext ) p = p->pNext;
188 return p;
drh9bb61fe2000-06-05 16:01:39 +0000189}
190
191/*
drhf7b54962013-05-28 12:11:54 +0000192** Given 1 to 3 identifiers preceding the JOIN keyword, determine the
drh01f3f252002-05-24 16:14:15 +0000193** type of join. Return an integer constant that expresses that type
194** in terms of the following bit values:
195**
196** JT_INNER
drh3dec2232005-09-10 15:28:09 +0000197** JT_CROSS
drh01f3f252002-05-24 16:14:15 +0000198** JT_OUTER
199** JT_NATURAL
200** JT_LEFT
201** JT_RIGHT
202**
203** A full outer join is the combination of JT_LEFT and JT_RIGHT.
204**
205** If an illegal or unsupported join type is seen, then still return
206** a join type, but put an error in the pParse structure.
drh81a23622022-04-08 15:11:10 +0000207**
208** These are the valid join types:
209**
210**
211** pA pB pC Return Value
212** ------- ----- ----- ------------
213** CROSS - - JT_CROSS
214** INNER - - JT_INNER
215** LEFT - - JT_LEFT|JT_OUTER
216** LEFT OUTER - JT_LEFT|JT_OUTER
217** RIGHT - - JT_RIGHT|JT_OUTER
218** RIGHT OUTER - JT_RIGHT|JT_OUTER
219** FULL - - JT_LEFT|JT_RIGHT|JT_OUTER
220** FULL OUTER - JT_LEFT|JT_RIGHT|JT_OUTER
221** NATURAL INNER - JT_NATURAL|JT_INNER
222** NATURAL LEFT - JT_NATURAL|JT_LEFT|JT_OUTER
223** NATURAL LEFT OUTER JT_NATURAL|JT_LEFT|JT_OUTER
224** NATURAL RIGHT - JT_NATURAL|JT_RIGHT|JT_OUTER
225** NATURAL RIGHT OUTER JT_NATURAL|JT_RIGHT|JT_OUTER
226** NATURAL FULL - JT_NATURAL|JT_LEFT|JT_RIGHT
227** NATURAL FULL OUTER JT_NATRUAL|JT_LEFT|JT_RIGHT
228**
229** To preserve historical compatibly, SQLite also accepts a variety
230** of other non-standard and in many cases non-sensical join types.
231** This routine makes as much sense at it can from the nonsense join
232** type and returns a result. Examples of accepted nonsense join types
233** include but are not limited to:
234**
235** INNER CROSS JOIN -> same as JOIN
236** NATURAL CROSS JOIN -> same as NATURAL JOIN
237** OUTER LEFT JOIN -> same as LEFT JOIN
238** LEFT NATURAL JOIN -> same as NATURAL LEFT JOIN
239** LEFT RIGHT JOIN -> same as FULL JOIN
240** RIGHT OUTER FULL JOIN -> same as FULL JOIN
241** CROSS CROSS CROSS JOIN -> same as JOIN
242**
243** The only restrictions on the join type name are:
244**
245** * "INNER" cannot appear together with "OUTER", "LEFT", "RIGHT",
246** or "FULL".
247**
248** * "CROSS" cannot appear together with "OUTER", "LEFT", "RIGHT,
249** or "FULL".
250**
251** * If "OUTER" is present then there must also be one of
252** "LEFT", "RIGHT", or "FULL"
drh01f3f252002-05-24 16:14:15 +0000253*/
danielk19774adee202004-05-08 08:23:19 +0000254int sqlite3JoinType(Parse *pParse, Token *pA, Token *pB, Token *pC){
drh01f3f252002-05-24 16:14:15 +0000255 int jointype = 0;
256 Token *apAll[3];
257 Token *p;
drh373cc2d2009-05-17 02:06:14 +0000258 /* 0123456789 123456789 123456789 123 */
259 static const char zKeyText[] = "naturaleftouterightfullinnercross";
drh57196282004-10-06 15:41:16 +0000260 static const struct {
drh373cc2d2009-05-17 02:06:14 +0000261 u8 i; /* Beginning of keyword text in zKeyText[] */
262 u8 nChar; /* Length of the keyword in characters */
263 u8 code; /* Join type mask */
264 } aKeyword[] = {
drh81a23622022-04-08 15:11:10 +0000265 /* (0) natural */ { 0, 7, JT_NATURAL },
266 /* (1) left */ { 6, 4, JT_LEFT|JT_OUTER },
267 /* (2) outer */ { 10, 5, JT_OUTER },
268 /* (3) right */ { 14, 5, JT_RIGHT|JT_OUTER },
269 /* (4) full */ { 19, 4, JT_LEFT|JT_RIGHT|JT_OUTER },
270 /* (5) inner */ { 23, 5, JT_INNER },
271 /* (6) cross */ { 28, 5, JT_INNER|JT_CROSS },
drh01f3f252002-05-24 16:14:15 +0000272 };
273 int i, j;
274 apAll[0] = pA;
275 apAll[1] = pB;
276 apAll[2] = pC;
drh195e6962002-05-25 00:18:20 +0000277 for(i=0; i<3 && apAll[i]; i++){
drh01f3f252002-05-24 16:14:15 +0000278 p = apAll[i];
drh373cc2d2009-05-17 02:06:14 +0000279 for(j=0; j<ArraySize(aKeyword); j++){
280 if( p->n==aKeyword[j].nChar
281 && sqlite3StrNICmp((char*)p->z, &zKeyText[aKeyword[j].i], p->n)==0 ){
282 jointype |= aKeyword[j].code;
drh01f3f252002-05-24 16:14:15 +0000283 break;
284 }
285 }
drh373cc2d2009-05-17 02:06:14 +0000286 testcase( j==0 || j==1 || j==2 || j==3 || j==4 || j==5 || j==6 );
287 if( j>=ArraySize(aKeyword) ){
drh01f3f252002-05-24 16:14:15 +0000288 jointype |= JT_ERROR;
289 break;
290 }
291 }
drhad2d8302002-05-24 20:31:36 +0000292 if(
293 (jointype & (JT_INNER|JT_OUTER))==(JT_INNER|JT_OUTER) ||
drh81a23622022-04-08 15:11:10 +0000294 (jointype & JT_ERROR)!=0 ||
295 (jointype & (JT_OUTER|JT_LEFT|JT_RIGHT))==JT_OUTER
drhad2d8302002-05-24 20:31:36 +0000296 ){
drh81a23622022-04-08 15:11:10 +0000297 const char *zSp1 = " ";
298 const char *zSp2 = " ";
299 if( pB==0 ){ zSp1++; }
300 if( pC==0 ){ zSp2++; }
drh0879d5f2022-04-12 18:40:14 +0000301 sqlite3ErrorMsg(pParse, "unknown join type: "
drh81a23622022-04-08 15:11:10 +0000302 "%T%s%T%s%T", pA, zSp1, pB, zSp2, pC);
drh01f3f252002-05-24 16:14:15 +0000303 jointype = JT_INNER;
304 }
305 return jointype;
306}
307
308/*
drhad2d8302002-05-24 20:31:36 +0000309** Return the index of a column in a table. Return -1 if the column
310** is not contained in the table.
311*/
dan6e6d9832021-02-16 20:43:36 +0000312int sqlite3ColumnIndex(Table *pTab, const char *zCol){
drhad2d8302002-05-24 20:31:36 +0000313 int i;
drha1928072020-07-20 13:11:19 +0000314 u8 h = sqlite3StrIHash(zCol);
315 Column *pCol;
316 for(pCol=pTab->aCol, i=0; i<pTab->nCol; pCol++, i++){
drhcf9d36d2021-08-02 18:03:43 +0000317 if( pCol->hName==h && sqlite3StrICmp(pCol->zCnName, zCol)==0 ) return i;
drhad2d8302002-05-24 20:31:36 +0000318 }
319 return -1;
320}
321
322/*
drh815b7822022-04-20 15:07:39 +0000323** Mark a subquery result column as having been used.
324*/
325void sqlite3SrcItemColumnUsed(SrcItem *pItem, int iCol){
326 assert( pItem!=0 );
mistachkin07fae322022-07-06 23:50:01 +0000327 assert( (int)pItem->fg.isNestedFrom == IsNestedFrom(pItem->pSelect) );
drh815b7822022-04-20 15:07:39 +0000328 if( pItem->fg.isNestedFrom ){
329 ExprList *pResults;
330 assert( pItem->pSelect!=0 );
331 pResults = pItem->pSelect->pEList;
332 assert( pResults!=0 );
333 assert( iCol>=0 && iCol<pResults->nExpr );
drhd88fd532022-05-02 20:49:30 +0000334 pResults->a[iCol].fg.bUsed = 1;
drh815b7822022-04-20 15:07:39 +0000335 }
336}
337
338/*
drhfe146992022-04-17 18:46:17 +0000339** Search the tables iStart..iEnd (inclusive) in pSrc, looking for a
340** table that has a column named zCol. The search is left-to-right.
341** The first match found is returned.
drh2179b432009-12-09 17:36:39 +0000342**
343** When found, set *piTab and *piCol to the table index and column index
344** of the matching column and return TRUE.
345**
346** If not found, return FALSE.
347*/
348static int tableAndColumnIndex(
349 SrcList *pSrc, /* Array of tables to search */
drhfe146992022-04-17 18:46:17 +0000350 int iStart, /* First member of pSrc->a[] to check */
351 int iEnd, /* Last member of pSrc->a[] to check */
drh2179b432009-12-09 17:36:39 +0000352 const char *zCol, /* Name of the column we are looking for */
353 int *piTab, /* Write index of pSrc->a[] here */
dan9d41af22019-12-30 14:32:27 +0000354 int *piCol, /* Write index of pSrc->a[*piTab].pTab->aCol[] here */
drhfe146992022-04-17 18:46:17 +0000355 int bIgnoreHidden /* Ignore hidden columns */
drh2179b432009-12-09 17:36:39 +0000356){
357 int i; /* For looping over tables in pSrc */
358 int iCol; /* Index of column matching zCol */
359
drhfe146992022-04-17 18:46:17 +0000360 assert( iEnd<pSrc->nSrc );
361 assert( iStart>=0 );
drh2179b432009-12-09 17:36:39 +0000362 assert( (piTab==0)==(piCol==0) ); /* Both or neither are NULL */
drhfe146992022-04-17 18:46:17 +0000363
364 for(i=iStart; i<=iEnd; i++){
dan6e6d9832021-02-16 20:43:36 +0000365 iCol = sqlite3ColumnIndex(pSrc->a[i].pTab, zCol);
dan9d41af22019-12-30 14:32:27 +0000366 if( iCol>=0
367 && (bIgnoreHidden==0 || IsHiddenColumn(&pSrc->a[i].pTab->aCol[iCol])==0)
368 ){
drh2179b432009-12-09 17:36:39 +0000369 if( piTab ){
drh815b7822022-04-20 15:07:39 +0000370 sqlite3SrcItemColumnUsed(&pSrc->a[i], iCol);
drh2179b432009-12-09 17:36:39 +0000371 *piTab = i;
372 *piCol = iCol;
373 }
drhfe146992022-04-17 18:46:17 +0000374 return 1;
drh2179b432009-12-09 17:36:39 +0000375 }
376 }
drhfe146992022-04-17 18:46:17 +0000377 return 0;
drhad2d8302002-05-24 20:31:36 +0000378}
379
380/*
drh67a99db2022-05-13 14:52:04 +0000381** Set the EP_OuterON property on all terms of the given expression.
drhd1985262022-04-11 11:25:28 +0000382** And set the Expr.w.iJoin to iTable for every term in the
drh22d6a532005-09-19 21:05:48 +0000383** expression.
drh1cc093c2002-06-24 22:01:57 +0000384**
drh67a99db2022-05-13 14:52:04 +0000385** The EP_OuterON property is used on terms of an expression to tell
drhb77c07a2022-04-11 11:59:25 +0000386** the OUTER JOIN processing logic that this term is part of the
drh1f162302002-10-27 19:35:33 +0000387** join restriction specified in the ON or USING clause and not a part
388** of the more general WHERE clause. These terms are moved over to the
389** WHERE clause during join processing but we need to remember that they
390** originated in the ON or USING clause.
drh22d6a532005-09-19 21:05:48 +0000391**
drhd1985262022-04-11 11:25:28 +0000392** The Expr.w.iJoin tells the WHERE clause processing that the
393** expression depends on table w.iJoin even if that table is not
drh22d6a532005-09-19 21:05:48 +0000394** explicitly mentioned in the expression. That information is needed
395** for cases like this:
396**
397** SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.b AND t1.x=5
398**
399** The where clause needs to defer the handling of the t1.x=5
400** term until after the t2 loop of the join. In that way, a
401** NULL t2 row will be inserted whenever t1.x!=5. If we do not
402** defer the handling of t1.x=5, it will be processed immediately
403** after the t1 loop and rows with t1.x!=5 will never appear in
404** the output, which is incorrect.
drh1cc093c2002-06-24 22:01:57 +0000405*/
drh3a6e4c52022-04-11 12:38:06 +0000406void sqlite3SetJoinExpr(Expr *p, int iTable, u32 joinFlag){
drh67a99db2022-05-13 14:52:04 +0000407 assert( joinFlag==EP_OuterON || joinFlag==EP_InnerON );
drh1cc093c2002-06-24 22:01:57 +0000408 while( p ){
drh3a6e4c52022-04-11 12:38:06 +0000409 ExprSetProperty(p, joinFlag);
drhc5cd1242013-09-12 16:50:49 +0000410 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +0000411 ExprSetVVAProperty(p, EP_NoReduce);
drhd1985262022-04-11 11:25:28 +0000412 p->w.iJoin = iTable;
drha4eeccd2021-10-07 17:43:30 +0000413 if( p->op==TK_FUNCTION ){
414 assert( ExprUseXList(p) );
415 if( p->x.pList ){
416 int i;
417 for(i=0; i<p->x.pList->nExpr; i++){
drh3a6e4c52022-04-11 12:38:06 +0000418 sqlite3SetJoinExpr(p->x.pList->a[i].pExpr, iTable, joinFlag);
drha4eeccd2021-10-07 17:43:30 +0000419 }
drh606f2342015-06-18 14:32:51 +0000420 }
421 }
drh3a6e4c52022-04-11 12:38:06 +0000422 sqlite3SetJoinExpr(p->pLeft, iTable, joinFlag);
drh1cc093c2002-06-24 22:01:57 +0000423 p = p->pRight;
424 }
425}
426
drhd7480402022-06-20 17:04:44 +0000427/* Undo the work of sqlite3SetJoinExpr(). This is used when a LEFT JOIN
428** is simplified into an ordinary JOIN, and when an ON expression is
429** "pushed down" into the WHERE clause of a subquery.
drh25897872018-03-20 21:16:15 +0000430**
drhd7480402022-06-20 17:04:44 +0000431** Convert every term that is marked with EP_OuterON and w.iJoin==iTable into
432** an ordinary term that omits the EP_OuterON mark. Or if iTable<0, then
433** just clear every EP_OuterON and EP_InnerON mark from the expression tree.
drh92d1afb2022-06-13 12:42:24 +0000434**
435** If nullable is true, that means that Expr p might evaluate to NULL even
436** if it is a reference to a NOT NULL column. This can happen, for example,
437** if the table that p references is on the left side of a RIGHT JOIN.
438** If nullable is true, then take care to not remove the EP_CanBeNull bit.
439** See forum thread https://sqlite.org/forum/forumpost/b40696f50145d21c
drh25897872018-03-20 21:16:15 +0000440*/
drh92d1afb2022-06-13 12:42:24 +0000441static void unsetJoinExpr(Expr *p, int iTable, int nullable){
drh25897872018-03-20 21:16:15 +0000442 while( p ){
drhd7480402022-06-20 17:04:44 +0000443 if( iTable<0 || (ExprHasProperty(p, EP_OuterON) && p->w.iJoin==iTable) ){
444 ExprClearProperty(p, EP_OuterON|EP_InnerON);
445 if( iTable>=0 ) ExprSetProperty(p, EP_InnerON);
drh25897872018-03-20 21:16:15 +0000446 }
drh92d1afb2022-06-13 12:42:24 +0000447 if( p->op==TK_COLUMN && p->iTable==iTable && !nullable ){
dan8ddf6862021-02-26 20:14:32 +0000448 ExprClearProperty(p, EP_CanBeNull);
449 }
drha4eeccd2021-10-07 17:43:30 +0000450 if( p->op==TK_FUNCTION ){
451 assert( ExprUseXList(p) );
452 if( p->x.pList ){
453 int i;
454 for(i=0; i<p->x.pList->nExpr; i++){
drh92d1afb2022-06-13 12:42:24 +0000455 unsetJoinExpr(p->x.pList->a[i].pExpr, iTable, nullable);
drha4eeccd2021-10-07 17:43:30 +0000456 }
drh25897872018-03-20 21:16:15 +0000457 }
458 }
drh92d1afb2022-06-13 12:42:24 +0000459 unsetJoinExpr(p->pLeft, iTable, nullable);
drh25897872018-03-20 21:16:15 +0000460 p = p->pRight;
461 }
462}
463
drh1cc093c2002-06-24 22:01:57 +0000464/*
drhad2d8302002-05-24 20:31:36 +0000465** This routine processes the join information for a SELECT statement.
drhbc656e22022-04-20 16:26:22 +0000466**
467** * A NATURAL join is converted into a USING join. After that, we
468** do not need to be concerned with NATURAL joins and we only have
469** think about USING joins.
470**
471** * ON and USING clauses result in extra terms being added to the
472** WHERE clause to enforce the specified constraints. The extra
drh67a99db2022-05-13 14:52:04 +0000473** WHERE clause terms will be tagged with EP_OuterON or
474** EP_InnerON so that we know that they originated in ON/USING.
drhad2d8302002-05-24 20:31:36 +0000475**
drh91bb0ee2004-09-01 03:06:34 +0000476** The terms of a FROM clause are contained in the Select.pSrc structure.
477** The left most table is the first entry in Select.pSrc. The right-most
478** table is the last entry. The join operator is held in the entry to
drhbc656e22022-04-20 16:26:22 +0000479** the right. Thus entry 1 contains the join operator for the join between
drh91bb0ee2004-09-01 03:06:34 +0000480** entries 0 and 1. Any ON or USING clauses associated with the join are
drhbc656e22022-04-20 16:26:22 +0000481** also attached to the right entry.
drh91bb0ee2004-09-01 03:06:34 +0000482**
drhad2d8302002-05-24 20:31:36 +0000483** This routine returns the number of errors encountered.
484*/
drh358424a2022-04-15 15:15:01 +0000485static int sqlite3ProcessJoin(Parse *pParse, Select *p){
drh91bb0ee2004-09-01 03:06:34 +0000486 SrcList *pSrc; /* All tables in the FROM clause */
487 int i, j; /* Loop counters */
drh76012942021-02-21 21:04:54 +0000488 SrcItem *pLeft; /* Left table being joined */
489 SrcItem *pRight; /* Right table being joined */
drhad2d8302002-05-24 20:31:36 +0000490
drh91bb0ee2004-09-01 03:06:34 +0000491 pSrc = p->pSrc;
492 pLeft = &pSrc->a[0];
493 pRight = &pLeft[1];
494 for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
drh91bb0ee2004-09-01 03:06:34 +0000495 Table *pRightTab = pRight->pTab;
drh3a6e4c52022-04-11 12:38:06 +0000496 u32 joinType;
drh91bb0ee2004-09-01 03:06:34 +0000497
drhce2c4822017-10-03 17:17:34 +0000498 if( NEVER(pLeft->pTab==0 || pRightTab==0) ) continue;
drh67a99db2022-05-13 14:52:04 +0000499 joinType = (pRight->fg.jointype & JT_OUTER)!=0 ? EP_OuterON : EP_InnerON;
drhad2d8302002-05-24 20:31:36 +0000500
drh22c4bc82022-04-15 17:08:40 +0000501 /* If this is a NATURAL join, synthesize an approprate USING clause
502 ** to specify which columns should be joined.
drhad2d8302002-05-24 20:31:36 +0000503 */
drh8a48b9c2015-08-19 15:20:00 +0000504 if( pRight->fg.jointype & JT_NATURAL ){
drh22c4bc82022-04-15 17:08:40 +0000505 IdList *pUsing = 0;
drhd44f8b22022-04-07 01:11:13 +0000506 if( pRight->fg.isUsing || pRight->u3.pOn ){
danielk19774adee202004-05-08 08:23:19 +0000507 sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
drhad2d8302002-05-24 20:31:36 +0000508 "an ON or USING clause", 0);
drhad2d8302002-05-24 20:31:36 +0000509 return 1;
510 }
drh2179b432009-12-09 17:36:39 +0000511 for(j=0; j<pRightTab->nCol; j++){
512 char *zName; /* Name of column in the right table */
drh2179b432009-12-09 17:36:39 +0000513
dan9d41af22019-12-30 14:32:27 +0000514 if( IsHiddenColumn(&pRightTab->aCol[j]) ) continue;
drhcf9d36d2021-08-02 18:03:43 +0000515 zName = pRightTab->aCol[j].zCnName;
drhfe146992022-04-17 18:46:17 +0000516 if( tableAndColumnIndex(pSrc, 0, i, zName, 0, 0, 1) ){
drhd0453f72022-04-18 00:04:15 +0000517 pUsing = sqlite3IdListAppend(pParse, pUsing, 0);
518 if( pUsing ){
519 assert( pUsing->nId>0 );
520 assert( pUsing->a[pUsing->nId-1].zName==0 );
521 pUsing->a[pUsing->nId-1].zName = sqlite3DbStrDup(pParse->db, zName);
522 }
drhad2d8302002-05-24 20:31:36 +0000523 }
524 }
drh22c4bc82022-04-15 17:08:40 +0000525 if( pUsing ){
526 pRight->fg.isUsing = 1;
drh4ce7bf92022-04-15 18:30:48 +0000527 pRight->fg.isSynthUsing = 1;
drh22c4bc82022-04-15 17:08:40 +0000528 pRight->u3.pUsing = pUsing;
529 }
drhabf86bd2022-04-18 09:59:33 +0000530 if( pParse->nErr ) return 1;
drhad2d8302002-05-24 20:31:36 +0000531 }
532
drhad2d8302002-05-24 20:31:36 +0000533 /* Create extra terms on the WHERE clause for each column named
534 ** in the USING clause. Example: If the two tables to be joined are
535 ** A and B and the USING clause names X, Y, and Z, then add this
536 ** to the WHERE clause: A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
537 ** Report an error if any column mentioned in the USING clause is
538 ** not contained in both tables to be joined.
539 */
drhd44f8b22022-04-07 01:11:13 +0000540 if( pRight->fg.isUsing ){
541 IdList *pList = pRight->u3.pUsing;
drhfe146992022-04-17 18:46:17 +0000542 sqlite3 *db = pParse->db;
drhd44f8b22022-04-07 01:11:13 +0000543 assert( pList!=0 );
drhad2d8302002-05-24 20:31:36 +0000544 for(j=0; j<pList->nId; j++){
drh2179b432009-12-09 17:36:39 +0000545 char *zName; /* Name of the term in the USING clause */
546 int iLeft; /* Table on the left with matching column name */
547 int iLeftCol; /* Column number of matching column on the left */
548 int iRightCol; /* Column number of matching column on the right */
drhfe146992022-04-17 18:46:17 +0000549 Expr *pE1; /* Reference to the column on the LEFT of the join */
550 Expr *pE2; /* Reference to the column on the RIGHT of the join */
551 Expr *pEq; /* Equality constraint. pE1 == pE2 */
drh2179b432009-12-09 17:36:39 +0000552
553 zName = pList->a[j].zName;
dan6e6d9832021-02-16 20:43:36 +0000554 iRightCol = sqlite3ColumnIndex(pRightTab, zName);
drh2179b432009-12-09 17:36:39 +0000555 if( iRightCol<0
drhfe146992022-04-17 18:46:17 +0000556 || tableAndColumnIndex(pSrc, 0, i, zName, &iLeft, &iLeftCol,
557 pRight->fg.isSynthUsing)==0
drh2179b432009-12-09 17:36:39 +0000558 ){
danielk19774adee202004-05-08 08:23:19 +0000559 sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
drh91bb0ee2004-09-01 03:06:34 +0000560 "not present in both tables", zName);
drhad2d8302002-05-24 20:31:36 +0000561 return 1;
562 }
drhfe146992022-04-17 18:46:17 +0000563 pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iLeftCol);
drh22b410d2022-04-20 18:12:42 +0000564 sqlite3SrcItemColumnUsed(&pSrc->a[iLeft], iLeftCol);
drhfe146992022-04-17 18:46:17 +0000565 if( (pSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
566 /* This branch runs if the query contains one or more RIGHT or FULL
567 ** JOINs. If only a single table on the left side of this join
drhbc656e22022-04-20 16:26:22 +0000568 ** contains the zName column, then this branch is a no-op.
569 ** But if there are two or more tables on the left side
drhfe146992022-04-17 18:46:17 +0000570 ** of the join, construct a coalesce() function that gathers all
571 ** such tables. Raise an error if more than one of those references
572 ** to zName is not also within a prior USING clause.
573 **
574 ** We really ought to raise an error if there are two or more
575 ** non-USING references to zName on the left of an INNER or LEFT
576 ** JOIN. But older versions of SQLite do not do that, so we avoid
577 ** adding a new error so as to not break legacy applications.
drh052953a2022-04-16 22:57:41 +0000578 */
drhfe146992022-04-17 18:46:17 +0000579 ExprList *pFuncArgs = 0; /* Arguments to the coalesce() */
drh052953a2022-04-16 22:57:41 +0000580 static const Token tkCoalesce = { "coalesce", 8 };
drhfe146992022-04-17 18:46:17 +0000581 while( tableAndColumnIndex(pSrc, iLeft+1, i, zName, &iLeft, &iLeftCol,
582 pRight->fg.isSynthUsing)!=0 ){
583 if( pSrc->a[iLeft].fg.isUsing==0
584 || sqlite3IdListIndex(pSrc->a[iLeft].u3.pUsing, zName)<0
585 ){
586 sqlite3ErrorMsg(pParse, "ambiguous reference to %s in USING()",
587 zName);
588 break;
589 }
590 pFuncArgs = sqlite3ExprListAppend(pParse, pFuncArgs, pE1);
591 pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iLeftCol);
drh22b410d2022-04-20 18:12:42 +0000592 sqlite3SrcItemColumnUsed(&pSrc->a[iLeft], iLeftCol);
drh052953a2022-04-16 22:57:41 +0000593 }
drhfe146992022-04-17 18:46:17 +0000594 if( pFuncArgs ){
595 pFuncArgs = sqlite3ExprListAppend(pParse, pFuncArgs, pE1);
596 pE1 = sqlite3ExprFunction(pParse, pFuncArgs, &tkCoalesce, 0);
drh052953a2022-04-16 22:57:41 +0000597 }
drh052953a2022-04-16 22:57:41 +0000598 }
drhfe146992022-04-17 18:46:17 +0000599 pE2 = sqlite3CreateColumnExpr(db, pSrc, i+1, iRightCol);
drh815b7822022-04-20 15:07:39 +0000600 sqlite3SrcItemColumnUsed(pRight, iRightCol);
drhfe146992022-04-17 18:46:17 +0000601 pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2);
602 assert( pE2!=0 || pEq==0 );
603 if( pEq ){
604 ExprSetProperty(pEq, joinType);
605 assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
606 ExprSetVVAProperty(pEq, EP_NoReduce);
607 pEq->w.iJoin = pE2->iTable;
608 }
609 p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pEq);
drhad2d8302002-05-24 20:31:36 +0000610 }
611 }
drhd44f8b22022-04-07 01:11:13 +0000612
613 /* Add the ON clause to the end of the WHERE clause, connected by
614 ** an AND operator.
615 */
616 else if( pRight->u3.pOn ){
drh3a6e4c52022-04-11 12:38:06 +0000617 sqlite3SetJoinExpr(pRight->u3.pOn, pRight->iCursor, joinType);
drhd44f8b22022-04-07 01:11:13 +0000618 p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pRight->u3.pOn);
619 pRight->u3.pOn = 0;
drh5c118e32022-06-08 15:30:39 +0000620 pRight->fg.isOn = 1;
drhd44f8b22022-04-07 01:11:13 +0000621 }
drhad2d8302002-05-24 20:31:36 +0000622 }
623 return 0;
624}
625
626/*
drhbbd4ae52018-04-30 19:32:49 +0000627** An instance of this object holds information (beyond pParse and pSelect)
628** needed to load the next result row that is to be added to the sorter.
629*/
630typedef struct RowLoadInfo RowLoadInfo;
631struct RowLoadInfo {
632 int regResult; /* Store results in array of registers here */
633 u8 ecelFlags; /* Flag argument to ExprCodeExprList() */
634#ifdef SQLITE_ENABLE_SORTER_REFERENCES
635 ExprList *pExtra; /* Extra columns needed by sorter refs */
636 int regExtraResult; /* Where to load the extra columns */
637#endif
638};
639
640/*
641** This routine does the work of loading query data into an array of
642** registers so that it can be added to the sorter.
643*/
644static void innerLoopLoadRow(
645 Parse *pParse, /* Statement under construction */
646 Select *pSelect, /* The query being coded */
647 RowLoadInfo *pInfo /* Info needed to complete the row load */
648){
649 sqlite3ExprCodeExprList(pParse, pSelect->pEList, pInfo->regResult,
650 0, pInfo->ecelFlags);
651#ifdef SQLITE_ENABLE_SORTER_REFERENCES
652 if( pInfo->pExtra ){
653 sqlite3ExprCodeExprList(pParse, pInfo->pExtra, pInfo->regExtraResult, 0, 0);
654 sqlite3ExprListDelete(pParse->db, pInfo->pExtra);
655 }
656#endif
657}
658
659/*
660** Code the OP_MakeRecord instruction that generates the entry to be
661** added into the sorter.
662**
663** Return the register in which the result is stored.
664*/
665static int makeSorterRecord(
666 Parse *pParse,
667 SortCtx *pSort,
668 Select *pSelect,
669 int regBase,
670 int nBase
671){
672 int nOBSat = pSort->nOBSat;
673 Vdbe *v = pParse->pVdbe;
674 int regOut = ++pParse->nMem;
675 if( pSort->pDeferredRowLoad ){
676 innerLoopLoadRow(pParse, pSelect, pSort->pDeferredRowLoad);
677 }
678 sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regOut);
679 return regOut;
680}
681
682/*
drhf45f2322014-03-23 17:45:03 +0000683** Generate code that will push the record in registers regData
684** through regData+nData-1 onto the sorter.
drhc926afb2002-06-20 03:38:26 +0000685*/
drhd59ba6c2006-01-08 05:02:54 +0000686static void pushOntoSorter(
687 Parse *pParse, /* Parser context */
drh079a3072014-03-19 14:10:55 +0000688 SortCtx *pSort, /* Information about the ORDER BY clause */
drhb7654112008-01-12 12:48:07 +0000689 Select *pSelect, /* The whole SELECT statement */
drhf45f2322014-03-23 17:45:03 +0000690 int regData, /* First register holding data to be sorted */
drh5579d592015-08-26 14:01:41 +0000691 int regOrigData, /* First register holding data before packing */
drhbbd4ae52018-04-30 19:32:49 +0000692 int nData, /* Number of elements in the regData data array */
drhfd0a2f92014-03-24 18:08:15 +0000693 int nPrefixReg /* No. of reg prior to regData available for use */
drhd59ba6c2006-01-08 05:02:54 +0000694){
drhf45f2322014-03-23 17:45:03 +0000695 Vdbe *v = pParse->pVdbe; /* Stmt under construction */
dan78d58432014-03-25 15:04:07 +0000696 int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
drhf45f2322014-03-23 17:45:03 +0000697 int nExpr = pSort->pOrderBy->nExpr; /* No. of ORDER BY terms */
dan78d58432014-03-25 15:04:07 +0000698 int nBase = nExpr + bSeq + nData; /* Fields in sorter record */
drhfd0a2f92014-03-24 18:08:15 +0000699 int regBase; /* Regs for sorter record */
drhbbd4ae52018-04-30 19:32:49 +0000700 int regRecord = 0; /* Assembled sorter record */
dan78d58432014-03-25 15:04:07 +0000701 int nOBSat = pSort->nOBSat; /* ORDER BY terms to skip */
702 int op; /* Opcode to add sorter record to sorter */
drha04a8be2016-01-13 17:50:10 +0000703 int iLimit; /* LIMIT counter */
drhbbd4ae52018-04-30 19:32:49 +0000704 int iSkip = 0; /* End of the sorter insert loop */
drhf45f2322014-03-23 17:45:03 +0000705
dan78d58432014-03-25 15:04:07 +0000706 assert( bSeq==0 || bSeq==1 );
drhbbd4ae52018-04-30 19:32:49 +0000707
708 /* Three cases:
709 ** (1) The data to be sorted has already been packed into a Record
710 ** by a prior OP_MakeRecord. In this case nData==1 and regData
711 ** will be completely unrelated to regOrigData.
712 ** (2) All output columns are included in the sort record. In that
713 ** case regData==regOrigData.
714 ** (3) Some output columns are omitted from the sort record due to
715 ** the SQLITE_ENABLE_SORTER_REFERENCE optimization, or due to the
drhc6f36fa2018-05-05 16:50:35 +0000716 ** SQLITE_ECEL_OMITREF optimization, or due to the
717 ** SortCtx.pDeferredRowLoad optimiation. In any of these cases
718 ** regOrigData is 0 to prevent this routine from trying to copy
719 ** values that might not yet exist.
drhbbd4ae52018-04-30 19:32:49 +0000720 */
dan9af90b72016-11-11 18:08:59 +0000721 assert( nData==1 || regData==regOrigData || regOrigData==0 );
drhbbd4ae52018-04-30 19:32:49 +0000722
drhfd0a2f92014-03-24 18:08:15 +0000723 if( nPrefixReg ){
dan78d58432014-03-25 15:04:07 +0000724 assert( nPrefixReg==nExpr+bSeq );
drhbbd4ae52018-04-30 19:32:49 +0000725 regBase = regData - nPrefixReg;
drhfd0a2f92014-03-24 18:08:15 +0000726 }else{
drhfb0d6e52014-05-02 13:09:06 +0000727 regBase = pParse->nMem + 1;
728 pParse->nMem += nBase;
drhfd0a2f92014-03-24 18:08:15 +0000729 }
drha04a8be2016-01-13 17:50:10 +0000730 assert( pSelect->iOffset==0 || pSelect->iLimit!=0 );
731 iLimit = pSelect->iOffset ? pSelect->iOffset+1 : pSelect->iLimit;
drhec4ccdb2018-12-29 02:26:59 +0000732 pSort->labelDone = sqlite3VdbeMakeLabel(pParse);
drh5579d592015-08-26 14:01:41 +0000733 sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, regOrigData,
dan9af90b72016-11-11 18:08:59 +0000734 SQLITE_ECEL_DUP | (regOrigData? SQLITE_ECEL_REF : 0));
dan78d58432014-03-25 15:04:07 +0000735 if( bSeq ){
736 sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
drhfd0a2f92014-03-24 18:08:15 +0000737 }
dan257c13f2016-11-10 20:14:06 +0000738 if( nPrefixReg==0 && nData>0 ){
drh236241a2014-09-12 17:41:30 +0000739 sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
dan78d58432014-03-25 15:04:07 +0000740 }
drh079a3072014-03-19 14:10:55 +0000741 if( nOBSat>0 ){
742 int regPrevKey; /* The first nOBSat columns of the previous row */
743 int addrFirst; /* Address of the OP_IfNot opcode */
744 int addrJmp; /* Address of the OP_Jump opcode */
745 VdbeOp *pOp; /* Opcode that opens the sorter */
746 int nKey; /* Number of sorting key columns, including OP_Sequence */
drhdbfca2b2014-03-22 02:19:53 +0000747 KeyInfo *pKI; /* Original KeyInfo on the sorter table */
drh079a3072014-03-19 14:10:55 +0000748
drhbbd4ae52018-04-30 19:32:49 +0000749 regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
drh26d7e7c2014-03-19 16:56:58 +0000750 regPrevKey = pParse->nMem+1;
751 pParse->nMem += pSort->nOBSat;
dan78d58432014-03-25 15:04:07 +0000752 nKey = nExpr - pSort->nOBSat + bSeq;
753 if( bSeq ){
754 addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
755 }else{
756 addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
757 }
758 VdbeCoverage(v);
drh26d7e7c2014-03-19 16:56:58 +0000759 sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
drh079a3072014-03-19 14:10:55 +0000760 pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
drh59b8f2e2014-03-22 00:27:14 +0000761 if( pParse->db->mallocFailed ) return;
drhfb0d6e52014-05-02 13:09:06 +0000762 pOp->p2 = nKey + nData;
drhdbfca2b2014-03-22 02:19:53 +0000763 pKI = pOp->p4.pKeyInfo;
dan6e118922019-08-12 16:36:38 +0000764 memset(pKI->aSortFlags, 0, pKI->nKeyField); /* Makes OP_Jump testable */
drhdbfca2b2014-03-22 02:19:53 +0000765 sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
drha485ad12017-08-02 22:43:14 +0000766 testcase( pKI->nAllField > pKI->nKeyField+2 );
danf9eae182018-05-21 19:45:11 +0000767 pOp->p4.pKeyInfo = sqlite3KeyInfoFromExprList(pParse,pSort->pOrderBy,nOBSat,
drha485ad12017-08-02 22:43:14 +0000768 pKI->nAllField-pKI->nKeyField-1);
drh166bc382019-10-26 15:40:17 +0000769 pOp = 0; /* Ensure pOp not used after sqltie3VdbeAddOp3() */
drh079a3072014-03-19 14:10:55 +0000770 addrJmp = sqlite3VdbeCurrentAddr(v);
771 sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
drhec4ccdb2018-12-29 02:26:59 +0000772 pSort->labelBkOut = sqlite3VdbeMakeLabel(pParse);
drh079a3072014-03-19 14:10:55 +0000773 pSort->regReturn = ++pParse->nMem;
774 sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
drh65ea12c2014-03-19 17:41:36 +0000775 sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
drha04a8be2016-01-13 17:50:10 +0000776 if( iLimit ){
777 sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, pSort->labelDone);
778 VdbeCoverage(v);
779 }
drh079a3072014-03-19 14:10:55 +0000780 sqlite3VdbeJumpHere(v, addrFirst);
drh236241a2014-09-12 17:41:30 +0000781 sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
drh079a3072014-03-19 14:10:55 +0000782 sqlite3VdbeJumpHere(v, addrJmp);
783 }
danf226f032018-04-26 16:13:47 +0000784 if( iLimit ){
785 /* At this point the values for the new sorter entry are stored
786 ** in an array of registers. They need to be composed into a record
787 ** and inserted into the sorter if either (a) there are currently
788 ** less than LIMIT+OFFSET items or (b) the new record is smaller than
789 ** the largest record currently in the sorter. If (b) is true and there
790 ** are already LIMIT+OFFSET items in the sorter, delete the largest
791 ** entry before inserting the new one. This way there are never more
792 ** than LIMIT+OFFSET items in the sorter.
793 **
794 ** If the new record does not need to be inserted into the sorter,
drh6ee5a7b2018-09-08 20:09:46 +0000795 ** jump to the next iteration of the loop. If the pSort->labelOBLopt
796 ** value is not zero, then it is a label of where to jump. Otherwise,
797 ** just bypass the row insert logic. See the header comment on the
798 ** sqlite3WhereOrderByLimitOptLabel() function for additional info.
danf226f032018-04-26 16:13:47 +0000799 */
800 int iCsr = pSort->iECursor;
danf226f032018-04-26 16:13:47 +0000801 sqlite3VdbeAddOp2(v, OP_IfNotZero, iLimit, sqlite3VdbeCurrentAddr(v)+4);
802 VdbeCoverage(v);
803 sqlite3VdbeAddOp2(v, OP_Last, iCsr, 0);
drhbbd4ae52018-04-30 19:32:49 +0000804 iSkip = sqlite3VdbeAddOp4Int(v, OP_IdxLE,
805 iCsr, 0, regBase+nOBSat, nExpr-nOBSat);
danf226f032018-04-26 16:13:47 +0000806 VdbeCoverage(v);
807 sqlite3VdbeAddOp1(v, OP_Delete, iCsr);
808 }
drhbbd4ae52018-04-30 19:32:49 +0000809 if( regRecord==0 ){
810 regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
danf226f032018-04-26 16:13:47 +0000811 }
drh079a3072014-03-19 14:10:55 +0000812 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drhc6aff302011-09-01 15:32:47 +0000813 op = OP_SorterInsert;
814 }else{
815 op = OP_IdxInsert;
816 }
drh4a8b0132016-11-09 01:38:56 +0000817 sqlite3VdbeAddOp4Int(v, op, pSort->iECursor, regRecord,
818 regBase+nOBSat, nBase-nOBSat);
drhbbd4ae52018-04-30 19:32:49 +0000819 if( iSkip ){
drhbbd4ae52018-04-30 19:32:49 +0000820 sqlite3VdbeChangeP2(v, iSkip,
drh6ee5a7b2018-09-08 20:09:46 +0000821 pSort->labelOBLopt ? pSort->labelOBLopt : sqlite3VdbeCurrentAddr(v));
drhbbd4ae52018-04-30 19:32:49 +0000822 }
drhc926afb2002-06-20 03:38:26 +0000823}
824
825/*
drhec7429a2005-10-06 16:53:14 +0000826** Add code to implement the OFFSET
drhea48eb22004-07-19 23:16:38 +0000827*/
drhec7429a2005-10-06 16:53:14 +0000828static void codeOffset(
drhbab39e12004-07-19 23:38:11 +0000829 Vdbe *v, /* Generate code into this VM */
drhaa9ce702014-01-22 18:07:04 +0000830 int iOffset, /* Register holding the offset counter */
drhb7654112008-01-12 12:48:07 +0000831 int iContinue /* Jump here to skip the current record */
drhea48eb22004-07-19 23:16:38 +0000832){
drha22a75e2014-03-21 18:16:23 +0000833 if( iOffset>0 ){
drh8b0cf382015-10-06 21:07:06 +0000834 sqlite3VdbeAddOp3(v, OP_IfPos, iOffset, iContinue, 1); VdbeCoverage(v);
835 VdbeComment((v, "OFFSET"));
drhea48eb22004-07-19 23:16:38 +0000836 }
drhea48eb22004-07-19 23:16:38 +0000837}
838
839/*
dan96ecb7b2021-03-09 16:47:33 +0000840** Add code that will check to make sure the array of registers starting at
841** iMem form a distinct entry. This is used by both "SELECT DISTINCT ..." and
dan76075802021-03-12 21:09:20 +0000842** distinct aggregates ("SELECT count(DISTINCT <expr>) ..."). Three strategies
843** are available. Which is used depends on the value of parameter eTnctType,
844** as follows:
drha2a49dc2008-01-02 14:28:13 +0000845**
dan96ecb7b2021-03-09 16:47:33 +0000846** WHERE_DISTINCT_UNORDERED/WHERE_DISTINCT_NOOP:
drh9be13392021-03-24 19:44:01 +0000847** Build an ephemeral table that contains all entries seen before and
848** skip entries which have been seen before.
849**
dan76075802021-03-12 21:09:20 +0000850** Parameter iTab is the cursor number of an ephemeral table that must
851** be opened before the VM code generated by this routine is executed.
dan5383db72021-03-12 18:24:31 +0000852** The ephemeral cursor table is queried for a record identical to the
dan96ecb7b2021-03-09 16:47:33 +0000853** record formed by the current array of registers. If one is found,
854** jump to VM address addrRepeat. Otherwise, insert a new record into
855** the ephemeral cursor and proceed.
856**
dan76075802021-03-12 21:09:20 +0000857** The returned value in this case is a copy of parameter iTab.
858**
dan96ecb7b2021-03-09 16:47:33 +0000859** WHERE_DISTINCT_ORDERED:
drh9be13392021-03-24 19:44:01 +0000860** In this case rows are being delivered sorted order. The ephermal
861** table is not required. Instead, the current set of values
862** is compared against previous row. If they match, the new row
dan96ecb7b2021-03-09 16:47:33 +0000863** is not distinct and control jumps to VM address addrRepeat. Otherwise,
864** the VM program proceeds with processing the new row.
865**
dan76075802021-03-12 21:09:20 +0000866** The returned value in this case is the register number of the first
867** in an array of registers used to store the previous result row so that
drh9be13392021-03-24 19:44:01 +0000868** it can be compared to the next. The caller must ensure that this
869** register is initialized to NULL. (The fixDistinctOpenEph() routine
870** will take care of this initialization.)
dan76075802021-03-12 21:09:20 +0000871**
dan96ecb7b2021-03-09 16:47:33 +0000872** WHERE_DISTINCT_UNIQUE:
873** In this case it has already been determined that the rows are distinct.
drh9be13392021-03-24 19:44:01 +0000874** No special action is required. The return value is zero.
dan96ecb7b2021-03-09 16:47:33 +0000875**
876** Parameter pEList is the list of expressions used to generated the
877** contents of each row. It is used by this routine to determine (a)
878** how many elements there are in the array of registers and (b) the
879** collation sequences that should be used for the comparisons if
880** eTnctType is WHERE_DISTINCT_ORDERED.
drha2a49dc2008-01-02 14:28:13 +0000881*/
dan5383db72021-03-12 18:24:31 +0000882static int codeDistinct(
drh2dcef112008-01-12 19:03:48 +0000883 Parse *pParse, /* Parsing and code generating context */
dan4fcb30b2021-03-09 16:06:25 +0000884 int eTnctType, /* WHERE_DISTINCT_* value */
drha2a49dc2008-01-02 14:28:13 +0000885 int iTab, /* A sorting index used to test for distinctness */
886 int addrRepeat, /* Jump to here if not distinct */
dan4fcb30b2021-03-09 16:06:25 +0000887 ExprList *pEList, /* Expression for each element */
888 int regElem /* First element */
drha2a49dc2008-01-02 14:28:13 +0000889){
dan5383db72021-03-12 18:24:31 +0000890 int iRet = 0;
dan4fcb30b2021-03-09 16:06:25 +0000891 int nResultCol = pEList->nExpr;
892 Vdbe *v = pParse->pVdbe;
drh2dcef112008-01-12 19:03:48 +0000893
dan4fcb30b2021-03-09 16:06:25 +0000894 switch( eTnctType ){
895 case WHERE_DISTINCT_ORDERED: {
896 int i;
dan4fcb30b2021-03-09 16:06:25 +0000897 int iJump; /* Jump destination */
898 int regPrev; /* Previous row content */
899
900 /* Allocate space for the previous row */
dan5383db72021-03-12 18:24:31 +0000901 iRet = regPrev = pParse->nMem+1;
dan4fcb30b2021-03-09 16:06:25 +0000902 pParse->nMem += nResultCol;
903
dan4fcb30b2021-03-09 16:06:25 +0000904 iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
905 for(i=0; i<nResultCol; i++){
906 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pEList->a[i].pExpr);
907 if( i<nResultCol-1 ){
908 sqlite3VdbeAddOp3(v, OP_Ne, regElem+i, iJump, regPrev+i);
909 VdbeCoverage(v);
910 }else{
911 sqlite3VdbeAddOp3(v, OP_Eq, regElem+i, addrRepeat, regPrev+i);
912 VdbeCoverage(v);
913 }
914 sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
915 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
916 }
917 assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
918 sqlite3VdbeAddOp3(v, OP_Copy, regElem, regPrev, nResultCol-1);
919 break;
920 }
921
922 case WHERE_DISTINCT_UNIQUE: {
dan5383db72021-03-12 18:24:31 +0000923 /* nothing to do */
dan4fcb30b2021-03-09 16:06:25 +0000924 break;
925 }
926
927 default: {
928 int r1 = sqlite3GetTempReg(pParse);
929 sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, regElem, nResultCol);
930 VdbeCoverage(v);
931 sqlite3VdbeAddOp3(v, OP_MakeRecord, regElem, nResultCol, r1);
932 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r1, regElem, nResultCol);
933 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
934 sqlite3ReleaseTempReg(pParse, r1);
dan5383db72021-03-12 18:24:31 +0000935 iRet = iTab;
dan4fcb30b2021-03-09 16:06:25 +0000936 break;
937 }
938 }
dan5383db72021-03-12 18:24:31 +0000939
940 return iRet;
941}
942
dan76075802021-03-12 21:09:20 +0000943/*
drh9be13392021-03-24 19:44:01 +0000944** This routine runs after codeDistinct(). It makes necessary
945** adjustments to the OP_OpenEphemeral opcode that the codeDistinct()
946** routine made use of. This processing must be done separately since
947** sometimes codeDistinct is called before the OP_OpenEphemeral is actually
948** laid down.
dan76075802021-03-12 21:09:20 +0000949**
drh9be13392021-03-24 19:44:01 +0000950** WHERE_DISTINCT_NOOP:
951** WHERE_DISTINCT_UNORDERED:
dan76075802021-03-12 21:09:20 +0000952**
drh9be13392021-03-24 19:44:01 +0000953** No adjustments necessary. This function is a no-op.
dan76075802021-03-12 21:09:20 +0000954**
drh9be13392021-03-24 19:44:01 +0000955** WHERE_DISTINCT_UNIQUE:
956**
957** The ephemeral table is not needed. So change the
958** OP_OpenEphemeral opcode into an OP_Noop.
959**
960** WHERE_DISTINCT_ORDERED:
961**
962** The ephemeral table is not needed. But we do need register
963** iVal to be initialized to NULL. So change the OP_OpenEphemeral
964** into an OP_Null on the iVal register.
dan76075802021-03-12 21:09:20 +0000965*/
dan5383db72021-03-12 18:24:31 +0000966static void fixDistinctOpenEph(
967 Parse *pParse, /* Parsing and code generating context */
968 int eTnctType, /* WHERE_DISTINCT_* value */
969 int iVal, /* Value returned by codeDistinct() */
dan76075802021-03-12 21:09:20 +0000970 int iOpenEphAddr /* Address of OP_OpenEphemeral instruction for iTab */
dan5383db72021-03-12 18:24:31 +0000971){
drhc6da6db2021-07-28 02:04:58 +0000972 if( pParse->nErr==0
973 && (eTnctType==WHERE_DISTINCT_UNIQUE || eTnctType==WHERE_DISTINCT_ORDERED)
974 ){
dan5383db72021-03-12 18:24:31 +0000975 Vdbe *v = pParse->pVdbe;
dan76075802021-03-12 21:09:20 +0000976 sqlite3VdbeChangeToNoop(v, iOpenEphAddr);
drh9be13392021-03-24 19:44:01 +0000977 if( sqlite3VdbeGetOp(v, iOpenEphAddr+1)->opcode==OP_Explain ){
978 sqlite3VdbeChangeToNoop(v, iOpenEphAddr+1);
979 }
dan5383db72021-03-12 18:24:31 +0000980 if( eTnctType==WHERE_DISTINCT_ORDERED ){
981 /* Change the OP_OpenEphemeral to an OP_Null that sets the MEM_Cleared
982 ** bit on the first register of the previous value. This will cause the
983 ** OP_Ne added in codeDistinct() to always fail on the first iteration of
984 ** the loop even if the first row is all NULLs. */
dan76075802021-03-12 21:09:20 +0000985 VdbeOp *pOp = sqlite3VdbeGetOp(v, iOpenEphAddr);
dan5383db72021-03-12 18:24:31 +0000986 pOp->opcode = OP_Null;
987 pOp->p1 = 1;
988 pOp->p2 = iVal;
989 }
990 }
drha2a49dc2008-01-02 14:28:13 +0000991}
992
dan24e25d32018-04-14 18:46:20 +0000993#ifdef SQLITE_ENABLE_SORTER_REFERENCES
994/*
995** This function is called as part of inner-loop generation for a SELECT
996** statement with an ORDER BY that is not optimized by an index. It
997** determines the expressions, if any, that the sorter-reference
998** optimization should be used for. The sorter-reference optimization
999** is used for SELECT queries like:
1000**
1001** SELECT a, bigblob FROM t1 ORDER BY a LIMIT 10
1002**
1003** If the optimization is used for expression "bigblob", then instead of
1004** storing values read from that column in the sorter records, the PK of
1005** the row from table t1 is stored instead. Then, as records are extracted from
1006** the sorter to return to the user, the required value of bigblob is
1007** retrieved directly from table t1. If the values are very large, this
1008** can be more efficient than storing them directly in the sorter records.
1009**
drh00e5d3d2022-05-03 16:18:25 +00001010** The ExprList_item.fg.bSorterRef flag is set for each expression in pEList
dan24e25d32018-04-14 18:46:20 +00001011** for which the sorter-reference optimization should be enabled.
1012** Additionally, the pSort->aDefer[] array is populated with entries
1013** for all cursors required to evaluate all selected expressions. Finally.
1014** output variable (*ppExtra) is set to an expression list containing
1015** expressions for all extra PK values that should be stored in the
1016** sorter records.
1017*/
1018static void selectExprDefer(
1019 Parse *pParse, /* Leave any error here */
1020 SortCtx *pSort, /* Sorter context */
1021 ExprList *pEList, /* Expressions destined for sorter */
1022 ExprList **ppExtra /* Expressions to append to sorter record */
1023){
1024 int i;
1025 int nDefer = 0;
1026 ExprList *pExtra = 0;
1027 for(i=0; i<pEList->nExpr; i++){
1028 struct ExprList_item *pItem = &pEList->a[i];
1029 if( pItem->u.x.iOrderByCol==0 ){
1030 Expr *pExpr = pItem->pExpr;
drh477572b2021-10-07 20:46:29 +00001031 Table *pTab;
drhffa5b052021-10-12 18:05:55 +00001032 if( pExpr->op==TK_COLUMN
1033 && pExpr->iColumn>=0
1034 && ALWAYS( ExprUseYTab(pExpr) )
1035 && (pTab = pExpr->y.pTab)!=0
1036 && IsOrdinaryTable(pTab)
1037 && (pTab->aCol[pExpr->iColumn].colFlags & COLFLAG_SORTERREF)!=0
dan24e25d32018-04-14 18:46:20 +00001038 ){
1039 int j;
1040 for(j=0; j<nDefer; j++){
1041 if( pSort->aDefer[j].iCsr==pExpr->iTable ) break;
1042 }
1043 if( j==nDefer ){
1044 if( nDefer==ArraySize(pSort->aDefer) ){
1045 continue;
1046 }else{
1047 int nKey = 1;
1048 int k;
1049 Index *pPk = 0;
1050 if( !HasRowid(pTab) ){
1051 pPk = sqlite3PrimaryKeyIndex(pTab);
1052 nKey = pPk->nKeyCol;
1053 }
1054 for(k=0; k<nKey; k++){
1055 Expr *pNew = sqlite3PExpr(pParse, TK_COLUMN, 0, 0);
1056 if( pNew ){
1057 pNew->iTable = pExpr->iTable;
drh477572b2021-10-07 20:46:29 +00001058 assert( ExprUseYTab(pNew) );
drheda079c2018-09-20 19:02:15 +00001059 pNew->y.pTab = pExpr->y.pTab;
dan24e25d32018-04-14 18:46:20 +00001060 pNew->iColumn = pPk ? pPk->aiColumn[k] : -1;
1061 pExtra = sqlite3ExprListAppend(pParse, pExtra, pNew);
1062 }
1063 }
drheda079c2018-09-20 19:02:15 +00001064 pSort->aDefer[nDefer].pTab = pExpr->y.pTab;
dan24e25d32018-04-14 18:46:20 +00001065 pSort->aDefer[nDefer].iCsr = pExpr->iTable;
1066 pSort->aDefer[nDefer].nKey = nKey;
1067 nDefer++;
1068 }
1069 }
drhd88fd532022-05-02 20:49:30 +00001070 pItem->fg.bSorterRef = 1;
dan24e25d32018-04-14 18:46:20 +00001071 }
1072 }
1073 }
1074 pSort->nDefer = (u8)nDefer;
1075 *ppExtra = pExtra;
1076}
1077#endif
1078
drhc99130f2005-09-11 11:56:27 +00001079/*
drh22827922000-06-06 17:27:05 +00001080** This routine generates the code for the inside of the inner loop
1081** of a SELECT.
drh82c3d632000-06-06 21:56:07 +00001082**
drh2def2f72017-09-15 17:40:34 +00001083** If srcTab is negative, then the p->pEList expressions
drh340309f2014-01-22 00:23:49 +00001084** are evaluated in order to get the data for this row. If srcTab is
drh2def2f72017-09-15 17:40:34 +00001085** zero or more, then data is pulled from srcTab and p->pEList is used only
dan257c13f2016-11-10 20:14:06 +00001086** to get the number of columns and the collation sequence for each column.
drh22827922000-06-06 17:27:05 +00001087*/
drhd2b3e232008-01-23 14:51:49 +00001088static void selectInnerLoop(
drh22827922000-06-06 17:27:05 +00001089 Parse *pParse, /* The parser context */
drhdf199a22002-06-14 22:38:41 +00001090 Select *p, /* The complete select statement being coded */
drh2def2f72017-09-15 17:40:34 +00001091 int srcTab, /* Pull data from this table if non-negative */
drh079a3072014-03-19 14:10:55 +00001092 SortCtx *pSort, /* If not NULL, info on how to process ORDER BY */
drhe8e4af72012-09-21 00:04:28 +00001093 DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
danielk19776c8c8ce2008-01-02 16:27:09 +00001094 SelectDest *pDest, /* How to dispose of the results */
drh22827922000-06-06 17:27:05 +00001095 int iContinue, /* Jump here to continue with next row */
drha9671a22008-07-08 23:40:20 +00001096 int iBreak /* Jump here to break out of the inner loop */
drh22827922000-06-06 17:27:05 +00001097){
1098 Vdbe *v = pParse->pVdbe;
drhd847eaa2008-01-17 17:15:56 +00001099 int i;
dan9af90b72016-11-11 18:08:59 +00001100 int hasDistinct; /* True if the DISTINCT keyword is present */
drhd847eaa2008-01-17 17:15:56 +00001101 int eDest = pDest->eDest; /* How to dispose of results */
drh2b596da2012-07-23 21:43:19 +00001102 int iParm = pDest->iSDParm; /* First argument to disposal method */
drhd847eaa2008-01-17 17:15:56 +00001103 int nResultCol; /* Number of result columns */
drhfd0a2f92014-03-24 18:08:15 +00001104 int nPrefixReg = 0; /* Number of extra registers before regResult */
drhbbd4ae52018-04-30 19:32:49 +00001105 RowLoadInfo sRowLoadInfo; /* Info for deferred row loading */
drh38640e12002-07-05 21:42:36 +00001106
dan9af90b72016-11-11 18:08:59 +00001107 /* Usually, regResult is the first cell in an array of memory cells
1108 ** containing the current result row. In this case regOrig is set to the
1109 ** same value. However, if the results are being sent to the sorter, the
1110 ** values for any expressions that are also part of the sort-key are omitted
1111 ** from this array. In this case regOrig is set to zero. */
1112 int regResult; /* Start of memory holding current results */
1113 int regOrig; /* Start of memory holding full result (or 0) */
1114
drh1c767f02009-01-09 02:49:31 +00001115 assert( v );
drh2def2f72017-09-15 17:40:34 +00001116 assert( p->pEList!=0 );
drhe8e4af72012-09-21 00:04:28 +00001117 hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
drh079a3072014-03-19 14:10:55 +00001118 if( pSort && pSort->pOrderBy==0 ) pSort = 0;
1119 if( pSort==0 && !hasDistinct ){
drha22a75e2014-03-21 18:16:23 +00001120 assert( iContinue!=0 );
drhaa9ce702014-01-22 18:07:04 +00001121 codeOffset(v, p->iOffset, iContinue);
drhdf199a22002-06-14 22:38:41 +00001122 }
1123
drh967e8b72000-06-21 13:59:10 +00001124 /* Pull the requested columns.
drh22827922000-06-06 17:27:05 +00001125 */
drh2def2f72017-09-15 17:40:34 +00001126 nResultCol = p->pEList->nExpr;
drh05a86c52014-02-16 01:55:49 +00001127
drh2b596da2012-07-23 21:43:19 +00001128 if( pDest->iSdst==0 ){
drhfd0a2f92014-03-24 18:08:15 +00001129 if( pSort ){
dan78d58432014-03-25 15:04:07 +00001130 nPrefixReg = pSort->pOrderBy->nExpr;
1131 if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
drhfd0a2f92014-03-24 18:08:15 +00001132 pParse->nMem += nPrefixReg;
1133 }
drh2b596da2012-07-23 21:43:19 +00001134 pDest->iSdst = pParse->nMem+1;
drh0acb7e42008-06-25 00:12:41 +00001135 pParse->nMem += nResultCol;
drh05a86c52014-02-16 01:55:49 +00001136 }else if( pDest->iSdst+nResultCol > pParse->nMem ){
1137 /* This is an error condition that can result, for example, when a SELECT
1138 ** on the right-hand side of an INSERT contains more result columns than
1139 ** there are columns in the table on the left. The error will be caught
1140 ** and reported later. But we need to make sure enough memory is allocated
1141 ** to avoid other spurious errors in the meantime. */
1142 pParse->nMem += nResultCol;
drh1013c932008-01-06 00:25:21 +00001143 }
drh05a86c52014-02-16 01:55:49 +00001144 pDest->nSdst = nResultCol;
dan9af90b72016-11-11 18:08:59 +00001145 regOrig = regResult = pDest->iSdst;
drh340309f2014-01-22 00:23:49 +00001146 if( srcTab>=0 ){
1147 for(i=0; i<nResultCol; i++){
drhd847eaa2008-01-17 17:15:56 +00001148 sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
drh41cee662019-12-12 20:22:34 +00001149 VdbeComment((v, "%s", p->pEList->a[i].zEName));
drh82c3d632000-06-06 21:56:07 +00001150 }
danielk19779ed1dfa2008-01-02 17:11:14 +00001151 }else if( eDest!=SRT_Exists ){
dan24e25d32018-04-14 18:46:20 +00001152#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1153 ExprList *pExtra = 0;
1154#endif
danielk19779ed1dfa2008-01-02 17:11:14 +00001155 /* If the destination is an EXISTS(...) expression, the actual
1156 ** values returned by the SELECT are not required.
1157 */
drhbbd4ae52018-04-30 19:32:49 +00001158 u8 ecelFlags; /* "ecel" is an abbreviation of "ExprCodeExprList" */
1159 ExprList *pEList;
drhdf553652015-05-18 04:24:27 +00001160 if( eDest==SRT_Mem || eDest==SRT_Output || eDest==SRT_Coroutine ){
1161 ecelFlags = SQLITE_ECEL_DUP;
1162 }else{
1163 ecelFlags = 0;
1164 }
danac56ab72017-01-05 17:23:11 +00001165 if( pSort && hasDistinct==0 && eDest!=SRT_EphemTab && eDest!=SRT_Table ){
drh2def2f72017-09-15 17:40:34 +00001166 /* For each expression in p->pEList that is a copy of an expression in
dan257c13f2016-11-10 20:14:06 +00001167 ** the ORDER BY clause (pSort->pOrderBy), set the associated
1168 ** iOrderByCol value to one more than the index of the ORDER BY
1169 ** expression within the sort-key that pushOntoSorter() will generate.
drh2def2f72017-09-15 17:40:34 +00001170 ** This allows the p->pEList field to be omitted from the sorted record,
dan257c13f2016-11-10 20:14:06 +00001171 ** saving space and CPU cycles. */
1172 ecelFlags |= (SQLITE_ECEL_OMITREF|SQLITE_ECEL_REF);
drhbbd4ae52018-04-30 19:32:49 +00001173
dan257c13f2016-11-10 20:14:06 +00001174 for(i=pSort->nOBSat; i<pSort->pOrderBy->nExpr; i++){
1175 int j;
1176 if( (j = pSort->pOrderBy->a[i].u.x.iOrderByCol)>0 ){
drh2def2f72017-09-15 17:40:34 +00001177 p->pEList->a[j-1].u.x.iOrderByCol = i+1-pSort->nOBSat;
dan257c13f2016-11-10 20:14:06 +00001178 }
1179 }
dan24e25d32018-04-14 18:46:20 +00001180#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1181 selectExprDefer(pParse, pSort, p->pEList, &pExtra);
drh5a2e65e2018-04-18 19:08:44 +00001182 if( pExtra && pParse->db->mallocFailed==0 ){
dan24e25d32018-04-14 18:46:20 +00001183 /* If there are any extra PK columns to add to the sorter records,
1184 ** allocate extra memory cells and adjust the OpenEphemeral
1185 ** instruction to account for the larger records. This is only
1186 ** required if there are one or more WITHOUT ROWID tables with
1187 ** composite primary keys in the SortCtx.aDefer[] array. */
1188 VdbeOp *pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
1189 pOp->p2 += (pExtra->nExpr - pSort->nDefer);
1190 pOp->p4.pKeyInfo->nAllField += (pExtra->nExpr - pSort->nDefer);
1191 pParse->nMem += pExtra->nExpr;
1192 }
1193#endif
drhbbd4ae52018-04-30 19:32:49 +00001194
1195 /* Adjust nResultCol to account for columns that are omitted
1196 ** from the sorter by the optimizations in this branch */
1197 pEList = p->pEList;
1198 for(i=0; i<pEList->nExpr; i++){
1199 if( pEList->a[i].u.x.iOrderByCol>0
1200#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001201 || pEList->a[i].fg.bSorterRef
drhbbd4ae52018-04-30 19:32:49 +00001202#endif
1203 ){
1204 nResultCol--;
1205 regOrig = 0;
1206 }
1207 }
1208
1209 testcase( regOrig );
1210 testcase( eDest==SRT_Set );
1211 testcase( eDest==SRT_Mem );
1212 testcase( eDest==SRT_Coroutine );
1213 testcase( eDest==SRT_Output );
dan257c13f2016-11-10 20:14:06 +00001214 assert( eDest==SRT_Set || eDest==SRT_Mem
danf2972b62020-04-29 20:11:01 +00001215 || eDest==SRT_Coroutine || eDest==SRT_Output
1216 || eDest==SRT_Upfrom );
dan257c13f2016-11-10 20:14:06 +00001217 }
drhbbd4ae52018-04-30 19:32:49 +00001218 sRowLoadInfo.regResult = regResult;
1219 sRowLoadInfo.ecelFlags = ecelFlags;
dan24e25d32018-04-14 18:46:20 +00001220#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhbbd4ae52018-04-30 19:32:49 +00001221 sRowLoadInfo.pExtra = pExtra;
1222 sRowLoadInfo.regExtraResult = regResult + nResultCol;
1223 if( pExtra ) nResultCol += pExtra->nExpr;
dan24e25d32018-04-14 18:46:20 +00001224#endif
drhbbd4ae52018-04-30 19:32:49 +00001225 if( p->iLimit
1226 && (ecelFlags & SQLITE_ECEL_OMITREF)!=0
1227 && nPrefixReg>0
1228 ){
1229 assert( pSort!=0 );
1230 assert( hasDistinct==0 );
1231 pSort->pDeferredRowLoad = &sRowLoadInfo;
drhc6f36fa2018-05-05 16:50:35 +00001232 regOrig = 0;
drhbbd4ae52018-04-30 19:32:49 +00001233 }else{
1234 innerLoopLoadRow(pParse, p, &sRowLoadInfo);
1235 }
drh22827922000-06-06 17:27:05 +00001236 }
1237
drhdaffd0e2001-04-11 14:28:42 +00001238 /* If the DISTINCT keyword was present on the SELECT statement
1239 ** and this row has been seen before, then do not make this row
1240 ** part of the result.
drh22827922000-06-06 17:27:05 +00001241 */
drhea48eb22004-07-19 23:16:38 +00001242 if( hasDistinct ){
dan5383db72021-03-12 18:24:31 +00001243 int eType = pDistinct->eTnctType;
1244 int iTab = pDistinct->tabTnct;
dan4fcb30b2021-03-09 16:06:25 +00001245 assert( nResultCol==p->pEList->nExpr );
dan5383db72021-03-12 18:24:31 +00001246 iTab = codeDistinct(pParse, eType, iTab, iContinue, p->pEList, regResult);
1247 fixDistinctOpenEph(pParse, eType, iTab, pDistinct->addrTnct);
drh079a3072014-03-19 14:10:55 +00001248 if( pSort==0 ){
drhaa9ce702014-01-22 18:07:04 +00001249 codeOffset(v, p->iOffset, iContinue);
drhea48eb22004-07-19 23:16:38 +00001250 }
drh22827922000-06-06 17:27:05 +00001251 }
drh82c3d632000-06-06 21:56:07 +00001252
drhc926afb2002-06-20 03:38:26 +00001253 switch( eDest ){
1254 /* In this mode, write each query result to the key of the temporary
1255 ** table iParm.
1256 */
drh13449892005-09-07 21:22:45 +00001257#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhc926afb2002-06-20 03:38:26 +00001258 case SRT_Union: {
drh9cbf3422008-01-17 16:22:13 +00001259 int r1;
1260 r1 = sqlite3GetTempReg(pParse);
drh340309f2014-01-22 00:23:49 +00001261 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
drh9b4eaeb2016-11-09 00:10:33 +00001262 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
drh9cbf3422008-01-17 16:22:13 +00001263 sqlite3ReleaseTempReg(pParse, r1);
drhc926afb2002-06-20 03:38:26 +00001264 break;
drh22827922000-06-06 17:27:05 +00001265 }
drh22827922000-06-06 17:27:05 +00001266
drhc926afb2002-06-20 03:38:26 +00001267 /* Construct a record from the query result, but instead of
1268 ** saving that record, use it as a key to delete elements from
1269 ** the temporary table iParm.
1270 */
1271 case SRT_Except: {
drh340309f2014-01-22 00:23:49 +00001272 sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
drhc926afb2002-06-20 03:38:26 +00001273 break;
1274 }
drh781def22014-01-22 13:35:53 +00001275#endif /* SQLITE_OMIT_COMPOUND_SELECT */
danielk19775338a5f2005-01-20 13:03:10 +00001276
1277 /* Store the result as data using a unique key.
1278 */
drh8e1ee882014-03-21 19:56:09 +00001279 case SRT_Fifo:
1280 case SRT_DistFifo:
danielk19775338a5f2005-01-20 13:03:10 +00001281 case SRT_Table:
drhb9bb7c12006-06-11 23:41:55 +00001282 case SRT_EphemTab: {
drhfd0a2f92014-03-24 18:08:15 +00001283 int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
drh373cc2d2009-05-17 02:06:14 +00001284 testcase( eDest==SRT_Table );
1285 testcase( eDest==SRT_EphemTab );
drhe2248cf2015-05-22 17:29:27 +00001286 testcase( eDest==SRT_Fifo );
1287 testcase( eDest==SRT_DistFifo );
drhfd0a2f92014-03-24 18:08:15 +00001288 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
dan8ce71842014-01-14 20:14:09 +00001289#ifndef SQLITE_OMIT_CTE
drh8e1ee882014-03-21 19:56:09 +00001290 if( eDest==SRT_DistFifo ){
1291 /* If the destination is DistFifo, then cursor (iParm+1) is open
dan8ce71842014-01-14 20:14:09 +00001292 ** on an ephemeral index. If the current row is already present
1293 ** in the index, do not write it to the output. If not, add the
1294 ** current row to the index and proceed with writing it to the
1295 ** output table as well. */
1296 int addr = sqlite3VdbeCurrentAddr(v) + 4;
drh38b41492015-06-08 15:08:15 +00001297 sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0);
1298 VdbeCoverage(v);
drh9b4eaeb2016-11-09 00:10:33 +00001299 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm+1, r1,regResult,nResultCol);
drh079a3072014-03-19 14:10:55 +00001300 assert( pSort==0 );
dan8ce71842014-01-14 20:14:09 +00001301 }
1302#endif
drh079a3072014-03-19 14:10:55 +00001303 if( pSort ){
drhbbd4ae52018-04-30 19:32:49 +00001304 assert( regResult==regOrig );
1305 pushOntoSorter(pParse, pSort, p, r1+nPrefixReg, regOrig, 1, nPrefixReg);
danielk19775338a5f2005-01-20 13:03:10 +00001306 }else{
drhb7654112008-01-12 12:48:07 +00001307 int r2 = sqlite3GetTempReg(pParse);
1308 sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
1309 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
1310 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1311 sqlite3ReleaseTempReg(pParse, r2);
danielk19775338a5f2005-01-20 13:03:10 +00001312 }
drhfd0a2f92014-03-24 18:08:15 +00001313 sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
danielk19775338a5f2005-01-20 13:03:10 +00001314 break;
1315 }
drh5974a302000-06-07 14:42:26 +00001316
dan9ed322d2020-04-29 17:41:29 +00001317 case SRT_Upfrom: {
danf2972b62020-04-29 20:11:01 +00001318 if( pSort ){
1319 pushOntoSorter(
1320 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drh2add24c2020-07-23 14:12:47 +00001321 }else{
danf2972b62020-04-29 20:11:01 +00001322 int i2 = pDest->iSDParm2;
1323 int r1 = sqlite3GetTempReg(pParse);
drh09cf5692020-07-20 18:07:35 +00001324
1325 /* If the UPDATE FROM join is an aggregate that matches no rows, it
1326 ** might still be trying to return one row, because that is what
1327 ** aggregates do. Don't record that empty row in the output table. */
1328 sqlite3VdbeAddOp2(v, OP_IsNull, regResult, iBreak); VdbeCoverage(v);
1329
1330 sqlite3VdbeAddOp3(v, OP_MakeRecord,
1331 regResult+(i2<0), nResultCol-(i2<0), r1);
danf2972b62020-04-29 20:11:01 +00001332 if( i2<0 ){
1333 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regResult);
1334 }else{
1335 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, i2);
1336 }
dan9ed322d2020-04-29 17:41:29 +00001337 }
1338 break;
1339 }
1340
1341#ifndef SQLITE_OMIT_SUBQUERY
drhc926afb2002-06-20 03:38:26 +00001342 /* If we are creating a set for an "expr IN (SELECT ...)" construct,
1343 ** then there should be a single item on the stack. Write this
1344 ** item into the set table with bogus data.
1345 */
1346 case SRT_Set: {
drh079a3072014-03-19 14:10:55 +00001347 if( pSort ){
drhde941c62005-08-28 01:34:21 +00001348 /* At first glance you would think we could optimize out the
1349 ** ORDER BY in this case since the order of entries in the set
1350 ** does not matter. But there might be a LIMIT clause, in which
1351 ** case the order does matter */
dan51d82d12016-08-02 18:50:15 +00001352 pushOntoSorter(
dan9af90b72016-11-11 18:08:59 +00001353 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drhc926afb2002-06-20 03:38:26 +00001354 }else{
drhb7654112008-01-12 12:48:07 +00001355 int r1 = sqlite3GetTempReg(pParse);
dan9ed322d2020-04-29 17:41:29 +00001356 assert( sqlite3Strlen30(pDest->zAffSdst)==nResultCol );
1357 sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult, nResultCol,
1358 r1, pDest->zAffSdst, nResultCol);
1359 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
drhb7654112008-01-12 12:48:07 +00001360 sqlite3ReleaseTempReg(pParse, r1);
drhc926afb2002-06-20 03:38:26 +00001361 }
1362 break;
1363 }
drh22827922000-06-06 17:27:05 +00001364
dan9ed322d2020-04-29 17:41:29 +00001365
drh504b6982006-01-22 21:52:56 +00001366 /* If any row exist in the result set, record that fact and abort.
drhec7429a2005-10-06 16:53:14 +00001367 */
1368 case SRT_Exists: {
drh4c583122008-01-04 22:01:03 +00001369 sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
drhec7429a2005-10-06 16:53:14 +00001370 /* The LIMIT clause will terminate the loop for us */
1371 break;
1372 }
1373
drhc926afb2002-06-20 03:38:26 +00001374 /* If this is a scalar select that is part of an expression, then
dan870a0702016-08-01 16:37:43 +00001375 ** store the results in the appropriate memory cell or array of
1376 ** memory cells and break out of the scan loop.
drhc926afb2002-06-20 03:38:26 +00001377 */
1378 case SRT_Mem: {
drh079a3072014-03-19 14:10:55 +00001379 if( pSort ){
dan257c13f2016-11-10 20:14:06 +00001380 assert( nResultCol<=pDest->nSdst );
dan870a0702016-08-01 16:37:43 +00001381 pushOntoSorter(
dan9af90b72016-11-11 18:08:59 +00001382 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drhc926afb2002-06-20 03:38:26 +00001383 }else{
dan257c13f2016-11-10 20:14:06 +00001384 assert( nResultCol==pDest->nSdst );
drh53932ce2014-08-29 12:29:39 +00001385 assert( regResult==iParm );
drhec7429a2005-10-06 16:53:14 +00001386 /* The LIMIT clause will jump out of the loop for us */
drhc926afb2002-06-20 03:38:26 +00001387 }
1388 break;
1389 }
danielk197793758c82005-01-21 08:13:14 +00001390#endif /* #ifndef SQLITE_OMIT_SUBQUERY */
drh22827922000-06-06 17:27:05 +00001391
drh81cf13e2014-02-07 18:27:53 +00001392 case SRT_Coroutine: /* Send data to a co-routine */
1393 case SRT_Output: { /* Return the results */
drh373cc2d2009-05-17 02:06:14 +00001394 testcase( eDest==SRT_Coroutine );
1395 testcase( eDest==SRT_Output );
drh079a3072014-03-19 14:10:55 +00001396 if( pSort ){
dan9af90b72016-11-11 18:08:59 +00001397 pushOntoSorter(pParse, pSort, p, regResult, regOrig, nResultCol,
drh5579d592015-08-26 14:01:41 +00001398 nPrefixReg);
drhe00ee6e2008-06-20 15:24:01 +00001399 }else if( eDest==SRT_Coroutine ){
drh2b596da2012-07-23 21:43:19 +00001400 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drhc182d162005-08-14 20:47:16 +00001401 }else{
drh340309f2014-01-22 00:23:49 +00001402 sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
drhac82fcf2002-09-08 17:23:41 +00001403 }
drh142e30d2002-08-28 03:00:58 +00001404 break;
1405 }
1406
drhfe1c6bb2014-01-22 17:28:35 +00001407#ifndef SQLITE_OMIT_CTE
1408 /* Write the results into a priority queue that is order according to
1409 ** pDest->pOrderBy (in pSO). pDest->iSDParm (in iParm) is the cursor for an
1410 ** index with pSO->nExpr+2 columns. Build a key using pSO for the first
1411 ** pSO->nExpr columns, then make sure all keys are unique by adding a
1412 ** final OP_Sequence column. The last column is the record as a blob.
1413 */
1414 case SRT_DistQueue:
1415 case SRT_Queue: {
1416 int nKey;
1417 int r1, r2, r3;
1418 int addrTest = 0;
1419 ExprList *pSO;
1420 pSO = pDest->pOrderBy;
1421 assert( pSO );
1422 nKey = pSO->nExpr;
1423 r1 = sqlite3GetTempReg(pParse);
1424 r2 = sqlite3GetTempRange(pParse, nKey+2);
1425 r3 = r2+nKey+1;
drhfe1c6bb2014-01-22 17:28:35 +00001426 if( eDest==SRT_DistQueue ){
1427 /* If the destination is DistQueue, then cursor (iParm+1) is open
1428 ** on a second ephemeral index that holds all values every previously
drh7e4efae2014-02-26 21:35:31 +00001429 ** added to the queue. */
1430 addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
1431 regResult, nResultCol);
drh688852a2014-02-17 22:40:43 +00001432 VdbeCoverage(v);
drh7e4efae2014-02-26 21:35:31 +00001433 }
1434 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
1435 if( eDest==SRT_DistQueue ){
drhfe1c6bb2014-01-22 17:28:35 +00001436 sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
dancfe24582014-01-22 19:23:30 +00001437 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
drhfe1c6bb2014-01-22 17:28:35 +00001438 }
1439 for(i=0; i<nKey; i++){
1440 sqlite3VdbeAddOp2(v, OP_SCopy,
1441 regResult + pSO->a[i].u.x.iOrderByCol - 1,
1442 r2+i);
1443 }
1444 sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
1445 sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
drh9b4eaeb2016-11-09 00:10:33 +00001446 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, r2, nKey+2);
drhfe1c6bb2014-01-22 17:28:35 +00001447 if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
1448 sqlite3ReleaseTempReg(pParse, r1);
1449 sqlite3ReleaseTempRange(pParse, r2, nKey+2);
1450 break;
1451 }
1452#endif /* SQLITE_OMIT_CTE */
1453
1454
1455
danielk19776a67fe82005-02-04 04:07:16 +00001456#if !defined(SQLITE_OMIT_TRIGGER)
drhc926afb2002-06-20 03:38:26 +00001457 /* Discard the results. This is used for SELECT statements inside
1458 ** the body of a TRIGGER. The purpose of such selects is to call
1459 ** user-defined functions that have side effects. We do not care
1460 ** about the actual results of the select.
1461 */
drhc926afb2002-06-20 03:38:26 +00001462 default: {
drhf46f9052002-06-22 02:33:38 +00001463 assert( eDest==SRT_Discard );
drhc926afb2002-06-20 03:38:26 +00001464 break;
1465 }
danielk197793758c82005-01-21 08:13:14 +00001466#endif
drh82c3d632000-06-06 21:56:07 +00001467 }
drhec7429a2005-10-06 16:53:14 +00001468
drh5e87be82010-10-06 18:55:37 +00001469 /* Jump to the end of the loop if the LIMIT is reached. Except, if
1470 ** there is a sorter, in which case the sorter has already limited
1471 ** the output for us.
drhec7429a2005-10-06 16:53:14 +00001472 */
drh079a3072014-03-19 14:10:55 +00001473 if( pSort==0 && p->iLimit ){
drh16897072015-03-07 00:57:37 +00001474 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
drhec7429a2005-10-06 16:53:14 +00001475 }
drh82c3d632000-06-06 21:56:07 +00001476}
1477
1478/*
drhad124322013-10-23 13:30:58 +00001479** Allocate a KeyInfo object sufficient for an index of N key columns and
1480** X extra columns.
drh323df792013-08-05 19:11:29 +00001481*/
drhad124322013-10-23 13:30:58 +00001482KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
drhd4ab0032017-05-31 13:45:59 +00001483 int nExtra = (N+X)*(sizeof(CollSeq*)+1) - sizeof(CollSeq*);
drhd8e4b132016-10-01 19:21:56 +00001484 KeyInfo *p = sqlite3DbMallocRawNN(db, sizeof(KeyInfo) + nExtra);
drh323df792013-08-05 19:11:29 +00001485 if( p ){
dan6e118922019-08-12 16:36:38 +00001486 p->aSortFlags = (u8*)&p->aColl[N+X];
drha485ad12017-08-02 22:43:14 +00001487 p->nKeyField = (u16)N;
1488 p->nAllField = (u16)(N+X);
drh323df792013-08-05 19:11:29 +00001489 p->enc = ENC(db);
1490 p->db = db;
drh2ec2fb22013-11-06 19:59:23 +00001491 p->nRef = 1;
drhc263f7c2016-01-18 13:18:54 +00001492 memset(&p[1], 0, nExtra);
drh2ec2fb22013-11-06 19:59:23 +00001493 }else{
drh3cdb1392022-01-24 12:48:54 +00001494 return (KeyInfo*)sqlite3OomFault(db);
drh323df792013-08-05 19:11:29 +00001495 }
1496 return p;
1497}
1498
1499/*
drh2ec2fb22013-11-06 19:59:23 +00001500** Deallocate a KeyInfo object
1501*/
1502void sqlite3KeyInfoUnref(KeyInfo *p){
1503 if( p ){
1504 assert( p->nRef>0 );
drh2ec2fb22013-11-06 19:59:23 +00001505 p->nRef--;
drhdbd6a7d2017-04-05 12:39:49 +00001506 if( p->nRef==0 ) sqlite3DbFreeNN(p->db, p);
drh2ec2fb22013-11-06 19:59:23 +00001507 }
1508}
1509
1510/*
1511** Make a new pointer to a KeyInfo object
1512*/
1513KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
1514 if( p ){
1515 assert( p->nRef>0 );
1516 p->nRef++;
1517 }
1518 return p;
1519}
1520
1521#ifdef SQLITE_DEBUG
1522/*
1523** Return TRUE if a KeyInfo object can be change. The KeyInfo object
1524** can only be changed if this is just a single reference to the object.
1525**
1526** This routine is used only inside of assert() statements.
1527*/
1528int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
1529#endif /* SQLITE_DEBUG */
1530
1531/*
drhdece1a82005-08-31 18:20:00 +00001532** Given an expression list, generate a KeyInfo structure that records
1533** the collating sequence for each expression in that expression list.
1534**
drh0342b1f2005-09-01 03:07:44 +00001535** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
1536** KeyInfo structure is appropriate for initializing a virtual index to
1537** implement that clause. If the ExprList is the result set of a SELECT
1538** then the KeyInfo structure is appropriate for initializing a virtual
1539** index to implement a DISTINCT test.
1540**
peter.d.reid60ec9142014-09-06 16:39:46 +00001541** Space to hold the KeyInfo structure is obtained from malloc. The calling
drhdece1a82005-08-31 18:20:00 +00001542** function is responsible for seeing that this structure is eventually
drh2ec2fb22013-11-06 19:59:23 +00001543** freed.
drhdece1a82005-08-31 18:20:00 +00001544*/
danf9eae182018-05-21 19:45:11 +00001545KeyInfo *sqlite3KeyInfoFromExprList(
drh079a3072014-03-19 14:10:55 +00001546 Parse *pParse, /* Parsing context */
1547 ExprList *pList, /* Form the KeyInfo object from this ExprList */
1548 int iStart, /* Begin with this column of pList */
1549 int nExtra /* Add this many extra columns to the end */
1550){
drhdece1a82005-08-31 18:20:00 +00001551 int nExpr;
1552 KeyInfo *pInfo;
1553 struct ExprList_item *pItem;
drh323df792013-08-05 19:11:29 +00001554 sqlite3 *db = pParse->db;
drhdece1a82005-08-31 18:20:00 +00001555 int i;
1556
1557 nExpr = pList->nExpr;
drh3f39bcf2015-01-19 20:59:34 +00001558 pInfo = sqlite3KeyInfoAlloc(db, nExpr-iStart, nExtra+1);
drhdece1a82005-08-31 18:20:00 +00001559 if( pInfo ){
drh2ec2fb22013-11-06 19:59:23 +00001560 assert( sqlite3KeyInfoIsWriteable(pInfo) );
drh6284db92014-03-19 23:24:49 +00001561 for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
drh70efa842017-09-28 01:58:23 +00001562 pInfo->aColl[i-iStart] = sqlite3ExprNNCollSeq(pParse, pItem->pExpr);
drhd88fd532022-05-02 20:49:30 +00001563 pInfo->aSortFlags[i-iStart] = pItem->fg.sortFlags;
drhdece1a82005-08-31 18:20:00 +00001564 }
1565 }
1566 return pInfo;
1567}
1568
dan7f61e922010-11-11 16:46:40 +00001569/*
1570** Name of the connection operator, used for error messages.
1571*/
drhaae0f742021-03-04 16:03:32 +00001572const char *sqlite3SelectOpName(int id){
dan7f61e922010-11-11 16:46:40 +00001573 char *z;
1574 switch( id ){
1575 case TK_ALL: z = "UNION ALL"; break;
1576 case TK_INTERSECT: z = "INTERSECT"; break;
1577 case TK_EXCEPT: z = "EXCEPT"; break;
1578 default: z = "UNION"; break;
1579 }
1580 return z;
1581}
dan7f61e922010-11-11 16:46:40 +00001582
dan2ce22452010-11-08 19:01:16 +00001583#ifndef SQLITE_OMIT_EXPLAIN
dan17c0bc02010-11-09 17:35:19 +00001584/*
1585** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
1586** is a no-op. Otherwise, it adds a single row of output to the EQP result,
1587** where the caption is of the form:
1588**
1589** "USE TEMP B-TREE FOR xxx"
1590**
1591** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
1592** is determined by the zUsage argument.
1593*/
dan2ce22452010-11-08 19:01:16 +00001594static void explainTempTable(Parse *pParse, const char *zUsage){
drhe2ca99c2018-05-02 00:33:43 +00001595 ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s", zUsage));
dan2ce22452010-11-08 19:01:16 +00001596}
dan17c0bc02010-11-09 17:35:19 +00001597
1598/*
danbb2b4412011-04-06 17:54:31 +00001599** Assign expression b to lvalue a. A second, no-op, version of this macro
1600** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
1601** in sqlite3Select() to assign values to structure member variables that
1602** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
1603** code with #ifndef directives.
1604*/
1605# define explainSetInteger(a, b) a = b
1606
1607#else
1608/* No-op versions of the explainXXX() functions and macros. */
1609# define explainTempTable(y,z)
1610# define explainSetInteger(y,z)
1611#endif
1612
drhdece1a82005-08-31 18:20:00 +00001613
1614/*
drhd8bc7082000-06-07 23:51:50 +00001615** If the inner loop was generated using a non-null pOrderBy argument,
1616** then the results were placed in a sorter. After the loop is terminated
1617** we need to run the sorter and output the results. The following
1618** routine generates the code needed to do that.
1619*/
drhc926afb2002-06-20 03:38:26 +00001620static void generateSortTail(
danielk19776c8c8ce2008-01-02 16:27:09 +00001621 Parse *pParse, /* Parsing context */
1622 Select *p, /* The SELECT statement */
drh079a3072014-03-19 14:10:55 +00001623 SortCtx *pSort, /* Information on the ORDER BY clause */
danielk19776c8c8ce2008-01-02 16:27:09 +00001624 int nColumn, /* Number of columns of data */
1625 SelectDest *pDest /* Write the sorted results here */
drhc926afb2002-06-20 03:38:26 +00001626){
drhddba0c22014-03-18 20:33:42 +00001627 Vdbe *v = pParse->pVdbe; /* The prepared statement */
drha04a8be2016-01-13 17:50:10 +00001628 int addrBreak = pSort->labelDone; /* Jump here to exit loop */
drhec4ccdb2018-12-29 02:26:59 +00001629 int addrContinue = sqlite3VdbeMakeLabel(pParse);/* Jump here for next cycle */
dan24e25d32018-04-14 18:46:20 +00001630 int addr; /* Top of output loop. Jump for Next. */
drh079a3072014-03-19 14:10:55 +00001631 int addrOnce = 0;
drh0342b1f2005-09-01 03:07:44 +00001632 int iTab;
drh079a3072014-03-19 14:10:55 +00001633 ExprList *pOrderBy = pSort->pOrderBy;
danielk19776c8c8ce2008-01-02 16:27:09 +00001634 int eDest = pDest->eDest;
drh2b596da2012-07-23 21:43:19 +00001635 int iParm = pDest->iSDParm;
drh2d401ab2008-01-10 23:50:11 +00001636 int regRow;
1637 int regRowid;
dan257c13f2016-11-10 20:14:06 +00001638 int iCol;
dan24e25d32018-04-14 18:46:20 +00001639 int nKey; /* Number of key columns in sorter record */
drhf45f2322014-03-23 17:45:03 +00001640 int iSortTab; /* Sorter cursor to read from */
drhf45f2322014-03-23 17:45:03 +00001641 int i;
dan78d58432014-03-25 15:04:07 +00001642 int bSeq; /* True if sorter record includes seq. no. */
dan24e25d32018-04-14 18:46:20 +00001643 int nRefKey = 0;
drh70f624c2014-03-24 01:43:50 +00001644 struct ExprList_item *aOutEx = p->pEList->a;
drh2d401ab2008-01-10 23:50:11 +00001645
drha04a8be2016-01-13 17:50:10 +00001646 assert( addrBreak<0 );
drh079a3072014-03-19 14:10:55 +00001647 if( pSort->labelBkOut ){
1648 sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
drh076e85f2015-09-03 13:46:12 +00001649 sqlite3VdbeGoto(v, addrBreak);
drh079a3072014-03-19 14:10:55 +00001650 sqlite3VdbeResolveLabel(v, pSort->labelBkOut);
drh079a3072014-03-19 14:10:55 +00001651 }
dan24e25d32018-04-14 18:46:20 +00001652
1653#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1654 /* Open any cursors needed for sorter-reference expressions */
1655 for(i=0; i<pSort->nDefer; i++){
1656 Table *pTab = pSort->aDefer[i].pTab;
1657 int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
1658 sqlite3OpenTable(pParse, pSort->aDefer[i].iCsr, iDb, pTab, OP_OpenRead);
1659 nRefKey = MAX(nRefKey, pSort->aDefer[i].nKey);
1660 }
1661#endif
1662
drh079a3072014-03-19 14:10:55 +00001663 iTab = pSort->iECursor;
dan71c57db2016-07-09 20:23:55 +00001664 if( eDest==SRT_Output || eDest==SRT_Coroutine || eDest==SRT_Mem ){
drh8efc6a82022-01-12 20:31:14 +00001665 if( eDest==SRT_Mem && p->iOffset ){
1666 sqlite3VdbeAddOp2(v, OP_Null, 0, pDest->iSdst);
1667 }
drh3e9ca092009-09-08 01:14:48 +00001668 regRowid = 0;
drhf45f2322014-03-23 17:45:03 +00001669 regRow = pDest->iSdst;
drhed24da42016-09-06 14:37:05 +00001670 }else{
dan51d82d12016-08-02 18:50:15 +00001671 regRowid = sqlite3GetTempReg(pParse);
drh375afb82019-01-16 19:26:31 +00001672 if( eDest==SRT_EphemTab || eDest==SRT_Table ){
1673 regRow = sqlite3GetTempReg(pParse);
1674 nColumn = 0;
1675 }else{
1676 regRow = sqlite3GetTempRange(pParse, nColumn);
1677 }
drhcdd536f2006-03-17 00:04:03 +00001678 }
drh079a3072014-03-19 14:10:55 +00001679 nKey = pOrderBy->nExpr - pSort->nOBSat;
1680 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drhc2bb3282011-09-04 01:11:46 +00001681 int regSortOut = ++pParse->nMem;
drhf45f2322014-03-23 17:45:03 +00001682 iSortTab = pParse->nTab++;
drh83553ee2014-03-24 02:20:53 +00001683 if( pSort->labelBkOut ){
drh511f9e82016-09-22 18:53:13 +00001684 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drh83553ee2014-03-24 02:20:53 +00001685 }
dan24e25d32018-04-14 18:46:20 +00001686 sqlite3VdbeAddOp3(v, OP_OpenPseudo, iSortTab, regSortOut,
1687 nKey+1+nColumn+nRefKey);
drh079a3072014-03-19 14:10:55 +00001688 if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
drhc6aff302011-09-01 15:32:47 +00001689 addr = 1 + sqlite3VdbeAddOp2(v, OP_SorterSort, iTab, addrBreak);
drh688852a2014-02-17 22:40:43 +00001690 VdbeCoverage(v);
drhaa9ce702014-01-22 18:07:04 +00001691 codeOffset(v, p->iOffset, addrContinue);
drh6cf4a7d2014-10-13 13:00:58 +00001692 sqlite3VdbeAddOp3(v, OP_SorterData, iTab, regSortOut, iSortTab);
dan78d58432014-03-25 15:04:07 +00001693 bSeq = 0;
drhc6aff302011-09-01 15:32:47 +00001694 }else{
drh688852a2014-02-17 22:40:43 +00001695 addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
drhaa9ce702014-01-22 18:07:04 +00001696 codeOffset(v, p->iOffset, addrContinue);
drhf45f2322014-03-23 17:45:03 +00001697 iSortTab = iTab;
dan78d58432014-03-25 15:04:07 +00001698 bSeq = 1;
drhf45f2322014-03-23 17:45:03 +00001699 }
dand6189ea2018-04-11 14:11:53 +00001700 for(i=0, iCol=nKey+bSeq-1; i<nColumn; i++){
dan24e25d32018-04-14 18:46:20 +00001701#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001702 if( aOutEx[i].fg.bSorterRef ) continue;
dan24e25d32018-04-14 18:46:20 +00001703#endif
drh9f895232018-01-24 20:42:42 +00001704 if( aOutEx[i].u.x.iOrderByCol==0 ) iCol++;
1705 }
dan24e25d32018-04-14 18:46:20 +00001706#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1707 if( pSort->nDefer ){
1708 int iKey = iCol+1;
1709 int regKey = sqlite3GetTempRange(pParse, nRefKey);
1710
1711 for(i=0; i<pSort->nDefer; i++){
1712 int iCsr = pSort->aDefer[i].iCsr;
1713 Table *pTab = pSort->aDefer[i].pTab;
1714 int nKey = pSort->aDefer[i].nKey;
1715
1716 sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1717 if( HasRowid(pTab) ){
1718 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey);
1719 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCsr,
1720 sqlite3VdbeCurrentAddr(v)+1, regKey);
1721 }else{
dan24e25d32018-04-14 18:46:20 +00001722 int k;
1723 int iJmp;
drh7590d092018-04-18 14:04:19 +00001724 assert( sqlite3PrimaryKeyIndex(pTab)->nKeyCol==nKey );
dan24e25d32018-04-14 18:46:20 +00001725 for(k=0; k<nKey; k++){
1726 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey+k);
1727 }
1728 iJmp = sqlite3VdbeCurrentAddr(v);
1729 sqlite3VdbeAddOp4Int(v, OP_SeekGE, iCsr, iJmp+2, regKey, nKey);
1730 sqlite3VdbeAddOp4Int(v, OP_IdxLE, iCsr, iJmp+3, regKey, nKey);
1731 sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1732 }
dan257c13f2016-11-10 20:14:06 +00001733 }
dan24e25d32018-04-14 18:46:20 +00001734 sqlite3ReleaseTempRange(pParse, regKey, nRefKey);
1735 }
1736#endif
1737 for(i=nColumn-1; i>=0; i--){
1738#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001739 if( aOutEx[i].fg.bSorterRef ){
dan24e25d32018-04-14 18:46:20 +00001740 sqlite3ExprCode(pParse, aOutEx[i].pExpr, regRow+i);
1741 }else
1742#endif
1743 {
1744 int iRead;
1745 if( aOutEx[i].u.x.iOrderByCol ){
1746 iRead = aOutEx[i].u.x.iOrderByCol-1;
1747 }else{
1748 iRead = iCol--;
1749 }
1750 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iRead, regRow+i);
drhcbb9da32019-12-12 22:11:33 +00001751 VdbeComment((v, "%s", aOutEx[i].zEName));
dan24e25d32018-04-14 18:46:20 +00001752 }
drhc6aff302011-09-01 15:32:47 +00001753 }
drhc926afb2002-06-20 03:38:26 +00001754 switch( eDest ){
danac56ab72017-01-05 17:23:11 +00001755 case SRT_Table:
drhb9bb7c12006-06-11 23:41:55 +00001756 case SRT_EphemTab: {
drh375afb82019-01-16 19:26:31 +00001757 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, nKey+bSeq, regRow);
drh2d401ab2008-01-10 23:50:11 +00001758 sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
1759 sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
1760 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
drhc926afb2002-06-20 03:38:26 +00001761 break;
1762 }
danielk197793758c82005-01-21 08:13:14 +00001763#ifndef SQLITE_OMIT_SUBQUERY
drhc926afb2002-06-20 03:38:26 +00001764 case SRT_Set: {
dan71c57db2016-07-09 20:23:55 +00001765 assert( nColumn==sqlite3Strlen30(pDest->zAffSdst) );
1766 sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, nColumn, regRowid,
dan553168c2016-08-01 20:14:31 +00001767 pDest->zAffSdst, nColumn);
drh9b4eaeb2016-11-09 00:10:33 +00001768 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, regRowid, regRow, nColumn);
drhc926afb2002-06-20 03:38:26 +00001769 break;
1770 }
1771 case SRT_Mem: {
drhec7429a2005-10-06 16:53:14 +00001772 /* The LIMIT clause will terminate the loop for us */
drhc926afb2002-06-20 03:38:26 +00001773 break;
1774 }
danielk197793758c82005-01-21 08:13:14 +00001775#endif
danf2972b62020-04-29 20:11:01 +00001776 case SRT_Upfrom: {
1777 int i2 = pDest->iSDParm2;
1778 int r1 = sqlite3GetTempReg(pParse);
1779 sqlite3VdbeAddOp3(v, OP_MakeRecord,regRow+(i2<0),nColumn-(i2<0),r1);
1780 if( i2<0 ){
1781 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regRow);
1782 }else{
1783 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regRow, i2);
1784 }
1785 break;
1786 }
drh373cc2d2009-05-17 02:06:14 +00001787 default: {
drh373cc2d2009-05-17 02:06:14 +00001788 assert( eDest==SRT_Output || eDest==SRT_Coroutine );
drh1c767f02009-01-09 02:49:31 +00001789 testcase( eDest==SRT_Output );
1790 testcase( eDest==SRT_Coroutine );
drh7d10d5a2008-08-20 16:35:10 +00001791 if( eDest==SRT_Output ){
drh2b596da2012-07-23 21:43:19 +00001792 sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
drha9671a22008-07-08 23:40:20 +00001793 }else{
drh2b596da2012-07-23 21:43:19 +00001794 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drhce665cf2004-05-21 03:01:58 +00001795 }
drhac82fcf2002-09-08 17:23:41 +00001796 break;
1797 }
drhc926afb2002-06-20 03:38:26 +00001798 }
drhf45f2322014-03-23 17:45:03 +00001799 if( regRowid ){
dan51d82d12016-08-02 18:50:15 +00001800 if( eDest==SRT_Set ){
1801 sqlite3ReleaseTempRange(pParse, regRow, nColumn);
1802 }else{
1803 sqlite3ReleaseTempReg(pParse, regRow);
1804 }
drhf45f2322014-03-23 17:45:03 +00001805 sqlite3ReleaseTempReg(pParse, regRowid);
1806 }
drhec7429a2005-10-06 16:53:14 +00001807 /* The bottom of the loop
1808 */
drhdc5ea5c2008-12-10 17:19:59 +00001809 sqlite3VdbeResolveLabel(v, addrContinue);
drh079a3072014-03-19 14:10:55 +00001810 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drh688852a2014-02-17 22:40:43 +00001811 sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
drhc6aff302011-09-01 15:32:47 +00001812 }else{
drh688852a2014-02-17 22:40:43 +00001813 sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
drhc6aff302011-09-01 15:32:47 +00001814 }
drh079a3072014-03-19 14:10:55 +00001815 if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
drhdc5ea5c2008-12-10 17:19:59 +00001816 sqlite3VdbeResolveLabel(v, addrBreak);
drhd8bc7082000-06-07 23:51:50 +00001817}
1818
1819/*
danielk1977517eb642004-06-07 10:00:31 +00001820** Return a pointer to a string containing the 'declaration type' of the
1821** expression pExpr. The string may be treated as static by the caller.
drhe78e8282003-01-19 03:59:45 +00001822**
danielk1977955de522006-02-10 02:27:42 +00001823** The declaration type is the exact datatype definition extracted from the
1824** original CREATE TABLE statement if the expression is a column. The
1825** declaration type for a ROWID field is INTEGER. Exactly when an expression
1826** is considered a column can be complex in the presence of subqueries. The
1827** result-set expression in all of the following SELECT statements is
1828** considered a column by this function.
1829**
1830** SELECT col FROM tbl;
1831** SELECT (SELECT col FROM tbl;
1832** SELECT (SELECT col FROM tbl);
1833** SELECT abc FROM (SELECT col AS abc FROM tbl);
danielk1977517eb642004-06-07 10:00:31 +00001834**
danielk1977955de522006-02-10 02:27:42 +00001835** The declaration type for any expression other than a column is NULL.
drh5f3e5e72013-10-08 20:01:35 +00001836**
1837** This routine has either 3 or 6 parameters depending on whether or not
1838** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
danielk1977517eb642004-06-07 10:00:31 +00001839*/
drh5f3e5e72013-10-08 20:01:35 +00001840#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhcafc2f72017-10-03 03:01:09 +00001841# define columnType(A,B,C,D,E) columnTypeImpl(A,B,C,D,E)
drhb121dd12015-06-06 18:30:17 +00001842#else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
drhcafc2f72017-10-03 03:01:09 +00001843# define columnType(A,B,C,D,E) columnTypeImpl(A,B)
drhb121dd12015-06-06 18:30:17 +00001844#endif
drh5f3e5e72013-10-08 20:01:35 +00001845static const char *columnTypeImpl(
danielk1977955de522006-02-10 02:27:42 +00001846 NameContext *pNC,
drhcafc2f72017-10-03 03:01:09 +00001847#ifndef SQLITE_ENABLE_COLUMN_METADATA
1848 Expr *pExpr
1849#else
danielk1977955de522006-02-10 02:27:42 +00001850 Expr *pExpr,
drh5f3e5e72013-10-08 20:01:35 +00001851 const char **pzOrigDb,
1852 const char **pzOrigTab,
drhcafc2f72017-10-03 03:01:09 +00001853 const char **pzOrigCol
drhb121dd12015-06-06 18:30:17 +00001854#endif
danielk1977955de522006-02-10 02:27:42 +00001855){
1856 char const *zType = 0;
danielk1977517eb642004-06-07 10:00:31 +00001857 int j;
drhb121dd12015-06-06 18:30:17 +00001858#ifdef SQLITE_ENABLE_COLUMN_METADATA
1859 char const *zOrigDb = 0;
1860 char const *zOrigTab = 0;
1861 char const *zOrigCol = 0;
1862#endif
danielk19775338a5f2005-01-20 13:03:10 +00001863
drhf7ce4292015-12-02 19:46:12 +00001864 assert( pExpr!=0 );
1865 assert( pNC->pSrcList!=0 );
danielk197700e279d2004-06-21 07:36:32 +00001866 switch( pExpr->op ){
1867 case TK_COLUMN: {
danielk1977955de522006-02-10 02:27:42 +00001868 /* The expression is a column. Locate the table the column is being
1869 ** extracted from in NameContext.pSrcList. This table may be real
1870 ** database table or a subquery.
1871 */
1872 Table *pTab = 0; /* Table structure column is extracted from */
1873 Select *pS = 0; /* Select the column is extracted from */
1874 int iCol = pExpr->iColumn; /* Index of column in pTab */
dan43bc88b2009-09-10 10:15:59 +00001875 while( pNC && !pTab ){
danielk1977b3bce662005-01-29 08:32:43 +00001876 SrcList *pTabList = pNC->pSrcList;
1877 for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
1878 if( j<pTabList->nSrc ){
1879 pTab = pTabList->a[j].pTab;
danielk1977955de522006-02-10 02:27:42 +00001880 pS = pTabList->a[j].pSelect;
danielk1977b3bce662005-01-29 08:32:43 +00001881 }else{
1882 pNC = pNC->pNext;
1883 }
1884 }
danielk1977955de522006-02-10 02:27:42 +00001885
dan43bc88b2009-09-10 10:15:59 +00001886 if( pTab==0 ){
drh417168a2009-09-07 18:14:02 +00001887 /* At one time, code such as "SELECT new.x" within a trigger would
1888 ** cause this condition to run. Since then, we have restructured how
1889 ** trigger code is generated and so this condition is no longer
dan43bc88b2009-09-10 10:15:59 +00001890 ** possible. However, it can still be true for statements like
1891 ** the following:
1892 **
1893 ** CREATE TABLE t1(col INTEGER);
1894 ** SELECT (SELECT t1.col) FROM FROM t1;
1895 **
1896 ** when columnType() is called on the expression "t1.col" in the
1897 ** sub-select. In this case, set the column type to NULL, even
1898 ** though it should really be "INTEGER".
1899 **
1900 ** This is not a problem, as the column type of "t1.col" is never
1901 ** used. When columnType() is called on the expression
1902 ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
1903 ** branch below. */
drh7e627792005-04-29 02:10:00 +00001904 break;
1905 }
danielk1977955de522006-02-10 02:27:42 +00001906
drh477572b2021-10-07 20:46:29 +00001907 assert( pTab && ExprUseYTab(pExpr) && pExpr->y.pTab==pTab );
danielk1977955de522006-02-10 02:27:42 +00001908 if( pS ){
1909 /* The "table" is actually a sub-select or a view in the FROM clause
1910 ** of the SELECT statement. Return the declaration type and origin
1911 ** data for the result-set column of the sub-select.
1912 */
drh6e5020e2021-04-07 15:45:01 +00001913 if( iCol<pS->pEList->nExpr
1914#ifdef SQLITE_ALLOW_ROWID_IN_VIEW
1915 && iCol>=0
1916#else
1917 && ALWAYS(iCol>=0)
1918#endif
1919 ){
danielk1977955de522006-02-10 02:27:42 +00001920 /* If iCol is less than zero, then the expression requests the
1921 ** rowid of the sub-select or view. This expression is legal (see
1922 ** test case misc2.2.2) - it always evaluates to NULL.
1923 */
1924 NameContext sNC;
1925 Expr *p = pS->pEList->a[iCol].pExpr;
1926 sNC.pSrcList = pS->pSrc;
dan43bc88b2009-09-10 10:15:59 +00001927 sNC.pNext = pNC;
danielk1977955de522006-02-10 02:27:42 +00001928 sNC.pParse = pNC->pParse;
drhcafc2f72017-10-03 03:01:09 +00001929 zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol);
danielk1977955de522006-02-10 02:27:42 +00001930 }
drha78d7572017-10-03 16:57:33 +00001931 }else{
1932 /* A real table or a CTE table */
danielk1977955de522006-02-10 02:27:42 +00001933 assert( !pS );
drh5f3e5e72013-10-08 20:01:35 +00001934#ifdef SQLITE_ENABLE_COLUMN_METADATA
drha78d7572017-10-03 16:57:33 +00001935 if( iCol<0 ) iCol = pTab->iPKey;
1936 assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
danielk1977955de522006-02-10 02:27:42 +00001937 if( iCol<0 ){
1938 zType = "INTEGER";
drh5f3e5e72013-10-08 20:01:35 +00001939 zOrigCol = "rowid";
danielk1977955de522006-02-10 02:27:42 +00001940 }else{
drhcf9d36d2021-08-02 18:03:43 +00001941 zOrigCol = pTab->aCol[iCol].zCnName;
drhd7564862016-03-22 20:05:09 +00001942 zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
danielk1977955de522006-02-10 02:27:42 +00001943 }
drh5f3e5e72013-10-08 20:01:35 +00001944 zOrigTab = pTab->zName;
drha78d7572017-10-03 16:57:33 +00001945 if( pNC->pParse && pTab->pSchema ){
danielk1977955de522006-02-10 02:27:42 +00001946 int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
drhe59be012016-08-18 20:56:39 +00001947 zOrigDb = pNC->pParse->db->aDb[iDb].zDbSName;
danielk1977955de522006-02-10 02:27:42 +00001948 }
drh5f3e5e72013-10-08 20:01:35 +00001949#else
drha78d7572017-10-03 16:57:33 +00001950 assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
drh5f3e5e72013-10-08 20:01:35 +00001951 if( iCol<0 ){
1952 zType = "INTEGER";
1953 }else{
drhd7564862016-03-22 20:05:09 +00001954 zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
drh5f3e5e72013-10-08 20:01:35 +00001955 }
1956#endif
danielk197700e279d2004-06-21 07:36:32 +00001957 }
1958 break;
danielk1977517eb642004-06-07 10:00:31 +00001959 }
danielk197793758c82005-01-21 08:13:14 +00001960#ifndef SQLITE_OMIT_SUBQUERY
danielk197700e279d2004-06-21 07:36:32 +00001961 case TK_SELECT: {
danielk1977955de522006-02-10 02:27:42 +00001962 /* The expression is a sub-select. Return the declaration type and
1963 ** origin info for the single column in the result set of the SELECT
1964 ** statement.
1965 */
danielk1977b3bce662005-01-29 08:32:43 +00001966 NameContext sNC;
drha4eeccd2021-10-07 17:43:30 +00001967 Select *pS;
1968 Expr *p;
1969 assert( ExprUseXSelect(pExpr) );
1970 pS = pExpr->x.pSelect;
1971 p = pS->pEList->a[0].pExpr;
danielk1977955de522006-02-10 02:27:42 +00001972 sNC.pSrcList = pS->pSrc;
danielk1977b3bce662005-01-29 08:32:43 +00001973 sNC.pNext = pNC;
danielk1977955de522006-02-10 02:27:42 +00001974 sNC.pParse = pNC->pParse;
drhcafc2f72017-10-03 03:01:09 +00001975 zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
danielk197700e279d2004-06-21 07:36:32 +00001976 break;
danielk1977517eb642004-06-07 10:00:31 +00001977 }
danielk197793758c82005-01-21 08:13:14 +00001978#endif
danielk1977517eb642004-06-07 10:00:31 +00001979 }
drh5f3e5e72013-10-08 20:01:35 +00001980
1981#ifdef SQLITE_ENABLE_COLUMN_METADATA
1982 if( pzOrigDb ){
1983 assert( pzOrigTab && pzOrigCol );
1984 *pzOrigDb = zOrigDb;
1985 *pzOrigTab = zOrigTab;
1986 *pzOrigCol = zOrigCol;
danielk1977955de522006-02-10 02:27:42 +00001987 }
drh5f3e5e72013-10-08 20:01:35 +00001988#endif
danielk1977517eb642004-06-07 10:00:31 +00001989 return zType;
1990}
1991
1992/*
1993** Generate code that will tell the VDBE the declaration types of columns
1994** in the result set.
drhfcb78a42003-01-18 20:11:05 +00001995*/
1996static void generateColumnTypes(
1997 Parse *pParse, /* Parser context */
drhfcb78a42003-01-18 20:11:05 +00001998 SrcList *pTabList, /* List of tables */
1999 ExprList *pEList /* Expressions defining the result set */
2000){
drh3f913572008-03-22 01:07:17 +00002001#ifndef SQLITE_OMIT_DECLTYPE
drhfcb78a42003-01-18 20:11:05 +00002002 Vdbe *v = pParse->pVdbe;
danielk1977517eb642004-06-07 10:00:31 +00002003 int i;
danielk1977b3bce662005-01-29 08:32:43 +00002004 NameContext sNC;
2005 sNC.pSrcList = pTabList;
danielk1977955de522006-02-10 02:27:42 +00002006 sNC.pParse = pParse;
drheac5fc02017-04-11 01:01:27 +00002007 sNC.pNext = 0;
drhfcb78a42003-01-18 20:11:05 +00002008 for(i=0; i<pEList->nExpr; i++){
2009 Expr *p = pEList->a[i].pExpr;
drh3f913572008-03-22 01:07:17 +00002010 const char *zType;
2011#ifdef SQLITE_ENABLE_COLUMN_METADATA
danielk1977955de522006-02-10 02:27:42 +00002012 const char *zOrigDb = 0;
2013 const char *zOrigTab = 0;
2014 const char *zOrigCol = 0;
drhcafc2f72017-10-03 03:01:09 +00002015 zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
danielk1977955de522006-02-10 02:27:42 +00002016
drh85b623f2007-12-13 21:54:09 +00002017 /* The vdbe must make its own copy of the column-type and other
danielk19774b1ae992006-02-10 03:06:10 +00002018 ** column specific strings, in case the schema is reset before this
2019 ** virtual machine is deleted.
danielk1977fbcd5852004-06-15 02:44:18 +00002020 */
danielk197710fb7492008-10-31 10:53:22 +00002021 sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
2022 sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
2023 sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
drh3f913572008-03-22 01:07:17 +00002024#else
drhcafc2f72017-10-03 03:01:09 +00002025 zType = columnType(&sNC, p, 0, 0, 0);
drh3f913572008-03-22 01:07:17 +00002026#endif
danielk197710fb7492008-10-31 10:53:22 +00002027 sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
drhfcb78a42003-01-18 20:11:05 +00002028 }
drh5f3e5e72013-10-08 20:01:35 +00002029#endif /* !defined(SQLITE_OMIT_DECLTYPE) */
drhfcb78a42003-01-18 20:11:05 +00002030}
2031
drheac5fc02017-04-11 01:01:27 +00002032
2033/*
drhec360a82017-07-12 14:10:19 +00002034** Compute the column names for a SELECT statement.
2035**
2036** The only guarantee that SQLite makes about column names is that if the
2037** column has an AS clause assigning it a name, that will be the name used.
2038** That is the only documented guarantee. However, countless applications
2039** developed over the years have made baseless assumptions about column names
2040** and will break if those assumptions changes. Hence, use extreme caution
2041** when modifying this routine to avoid breaking legacy.
2042**
2043** See Also: sqlite3ColumnsFromExprList()
2044**
2045** The PRAGMA short_column_names and PRAGMA full_column_names settings are
2046** deprecated. The default setting is short=ON, full=OFF. 99.9% of all
2047** applications should operate this way. Nevertheless, we need to support the
2048** other modes for legacy:
2049**
2050** short=OFF, full=OFF: Column name is the text of the expression has it
2051** originally appears in the SELECT statement. In
2052** other words, the zSpan of the result expression.
2053**
2054** short=ON, full=OFF: (This is the default setting). If the result
drh3d240d22017-09-28 16:56:55 +00002055** refers directly to a table column, then the
2056** result column name is just the table column
2057** name: COLUMN. Otherwise use zSpan.
drhec360a82017-07-12 14:10:19 +00002058**
2059** full=ON, short=ANY: If the result refers directly to a table column,
2060** then the result column name with the table name
2061** prefix, ex: TABLE.COLUMN. Otherwise use zSpan.
drh82c3d632000-06-06 21:56:07 +00002062*/
drh90881862021-05-19 12:17:03 +00002063void sqlite3GenerateColumnNames(
drh832508b2002-03-02 17:04:07 +00002064 Parse *pParse, /* Parser context */
drhf35f2f92017-07-29 16:01:55 +00002065 Select *pSelect /* Generate column names for this SELECT statement */
drh832508b2002-03-02 17:04:07 +00002066){
drhd8bc7082000-06-07 23:51:50 +00002067 Vdbe *v = pParse->pVdbe;
drheac5fc02017-04-11 01:01:27 +00002068 int i;
2069 Table *pTab;
drhf35f2f92017-07-29 16:01:55 +00002070 SrcList *pTabList;
2071 ExprList *pEList;
drh9bb575f2004-09-06 17:24:11 +00002072 sqlite3 *db = pParse->db;
drhf35f2f92017-07-29 16:01:55 +00002073 int fullName; /* TABLE.COLUMN if no AS clause and is a direct table ref */
2074 int srcName; /* COLUMN or TABLE.COLUMN if no AS clause and is direct */
drhfcabd462004-02-20 14:50:58 +00002075
drhfe2093d2005-01-20 22:48:47 +00002076#ifndef SQLITE_OMIT_EXPLAIN
danielk19773cf86062004-05-26 10:11:05 +00002077 /* If this is an EXPLAIN, skip this step */
2078 if( pParse->explain ){
danielk197761de0d12004-05-27 23:56:16 +00002079 return;
danielk19773cf86062004-05-26 10:11:05 +00002080 }
danielk19775338a5f2005-01-20 13:03:10 +00002081#endif
danielk19773cf86062004-05-26 10:11:05 +00002082
drh5e8b9852018-05-03 22:52:56 +00002083 if( pParse->colNamesSet ) return;
drhf35f2f92017-07-29 16:01:55 +00002084 /* Column names are determined by the left-most term of a compound select */
2085 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh07859482017-12-23 11:51:40 +00002086 SELECTTRACE(1,pParse,pSelect,("generating column names\n"));
drhf35f2f92017-07-29 16:01:55 +00002087 pTabList = pSelect->pSrc;
2088 pEList = pSelect->pEList;
drh98029472015-12-03 21:47:30 +00002089 assert( v!=0 );
drhf7ce4292015-12-02 19:46:12 +00002090 assert( pTabList!=0 );
drhd8bc7082000-06-07 23:51:50 +00002091 pParse->colNamesSet = 1;
drhec360a82017-07-12 14:10:19 +00002092 fullName = (db->flags & SQLITE_FullColNames)!=0;
2093 srcName = (db->flags & SQLITE_ShortColNames)!=0 || fullName;
danielk197722322fd2004-05-25 23:35:17 +00002094 sqlite3VdbeSetNumCols(v, pEList->nExpr);
drh82c3d632000-06-06 21:56:07 +00002095 for(i=0; i<pEList->nExpr; i++){
drhec360a82017-07-12 14:10:19 +00002096 Expr *p = pEList->a[i].pExpr;
2097
2098 assert( p!=0 );
drh4dd89d52017-08-14 14:53:24 +00002099 assert( p->op!=TK_AGG_COLUMN ); /* Agg processing has not run yet */
drh477572b2021-10-07 20:46:29 +00002100 assert( p->op!=TK_COLUMN
2101 || (ExprUseYTab(p) && p->y.pTab!=0) ); /* Covering idx not yet coded */
drhd88fd532022-05-02 20:49:30 +00002102 if( pEList->a[i].zEName && pEList->a[i].fg.eEName==ENAME_NAME ){
drhec360a82017-07-12 14:10:19 +00002103 /* An AS clause always takes first priority */
drh41cee662019-12-12 20:22:34 +00002104 char *zName = pEList->a[i].zEName;
danielk197710fb7492008-10-31 10:53:22 +00002105 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
drhf35f2f92017-07-29 16:01:55 +00002106 }else if( srcName && p->op==TK_COLUMN ){
drh97665872002-02-13 23:22:53 +00002107 char *zCol;
drh8aff1012001-12-22 14:49:24 +00002108 int iCol = p->iColumn;
drheda079c2018-09-20 19:02:15 +00002109 pTab = p->y.pTab;
drhf35f2f92017-07-29 16:01:55 +00002110 assert( pTab!=0 );
drh8aff1012001-12-22 14:49:24 +00002111 if( iCol<0 ) iCol = pTab->iPKey;
drh97665872002-02-13 23:22:53 +00002112 assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
drhb1363202002-06-26 02:45:03 +00002113 if( iCol<0 ){
drh47a6db22005-01-18 16:02:40 +00002114 zCol = "rowid";
drhb1363202002-06-26 02:45:03 +00002115 }else{
drhcf9d36d2021-08-02 18:03:43 +00002116 zCol = pTab->aCol[iCol].zCnName;
drhb1363202002-06-26 02:45:03 +00002117 }
drhec360a82017-07-12 14:10:19 +00002118 if( fullName ){
drh82c3d632000-06-06 21:56:07 +00002119 char *zName = 0;
drh1c767f02009-01-09 02:49:31 +00002120 zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
danielk197710fb7492008-10-31 10:53:22 +00002121 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
drh82c3d632000-06-06 21:56:07 +00002122 }else{
danielk197710fb7492008-10-31 10:53:22 +00002123 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
drh82c3d632000-06-06 21:56:07 +00002124 }
drh1bee3d72001-10-15 00:44:35 +00002125 }else{
drhcbb9da32019-12-12 22:11:33 +00002126 const char *z = pEList->a[i].zEName;
drh859bc542014-01-13 20:32:18 +00002127 z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
2128 sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
drh82c3d632000-06-06 21:56:07 +00002129 }
2130 }
danielk197776d505b2004-05-28 13:13:02 +00002131 generateColumnTypes(pParse, pTabList, pEList);
drh82c3d632000-06-06 21:56:07 +00002132}
2133
drhd8bc7082000-06-07 23:51:50 +00002134/*
peter.d.reid60ec9142014-09-06 16:39:46 +00002135** Given an expression list (which is really the list of expressions
drh7d10d5a2008-08-20 16:35:10 +00002136** that form the result set of a SELECT statement) compute appropriate
2137** column names for a table that would hold the expression list.
2138**
2139** All column names will be unique.
2140**
2141** Only the column names are computed. Column.zType, Column.zColl,
2142** and other fields of Column are zeroed.
2143**
2144** Return SQLITE_OK on success. If a memory allocation error occurs,
2145** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
drhec360a82017-07-12 14:10:19 +00002146**
2147** The only guarantee that SQLite makes about column names is that if the
2148** column has an AS clause assigning it a name, that will be the name used.
2149** That is the only documented guarantee. However, countless applications
2150** developed over the years have made baseless assumptions about column names
2151** and will break if those assumptions changes. Hence, use extreme caution
2152** when modifying this routine to avoid breaking legacy.
2153**
drh90881862021-05-19 12:17:03 +00002154** See Also: sqlite3GenerateColumnNames()
drh315555c2002-10-20 15:53:03 +00002155*/
drh8981b902015-08-24 17:42:49 +00002156int sqlite3ColumnsFromExprList(
drh7d10d5a2008-08-20 16:35:10 +00002157 Parse *pParse, /* Parsing context */
2158 ExprList *pEList, /* Expr list from which to derive column names */
drhd815f172012-09-13 14:42:43 +00002159 i16 *pnCol, /* Write the number of columns here */
drh7d10d5a2008-08-20 16:35:10 +00002160 Column **paCol /* Write the new column list here */
2161){
drhdc5ea5c2008-12-10 17:19:59 +00002162 sqlite3 *db = pParse->db; /* Database connection */
2163 int i, j; /* Loop counters */
drhebed3fa2015-11-14 16:47:23 +00002164 u32 cnt; /* Index added to make the name unique */
drhdc5ea5c2008-12-10 17:19:59 +00002165 Column *aCol, *pCol; /* For looping over result columns */
2166 int nCol; /* Number of columns in the result set */
drhdc5ea5c2008-12-10 17:19:59 +00002167 char *zName; /* Column name */
2168 int nName; /* Size of name in zName[] */
drh0315e3c2015-11-14 20:52:43 +00002169 Hash ht; /* Hash table of column names */
drh6d5ab2a2020-11-02 00:40:05 +00002170 Table *pTab;
drh22f70c32002-02-18 01:17:00 +00002171
drh0315e3c2015-11-14 20:52:43 +00002172 sqlite3HashInit(&ht);
dan8c2e0f02012-03-31 15:08:56 +00002173 if( pEList ){
2174 nCol = pEList->nExpr;
2175 aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
2176 testcase( aCol==0 );
drh080fe6d2021-03-18 20:04:46 +00002177 if( NEVER(nCol>32767) ) nCol = 32767;
dan8c2e0f02012-03-31 15:08:56 +00002178 }else{
2179 nCol = 0;
2180 aCol = 0;
2181 }
dan8836cbb2015-11-21 19:43:29 +00002182 assert( nCol==(i16)nCol );
dan8c2e0f02012-03-31 15:08:56 +00002183 *pnCol = nCol;
2184 *paCol = aCol;
2185
drh0315e3c2015-11-14 20:52:43 +00002186 for(i=0, pCol=aCol; i<nCol && !db->mallocFailed; i++, pCol++){
drh18f86002022-04-21 13:11:26 +00002187 struct ExprList_item *pX = &pEList->a[i];
drh45e41b72022-04-22 23:18:21 +00002188 struct ExprList_item *pCollide;
drh79d5f632005-01-18 17:20:10 +00002189 /* Get an appropriate name for the column
2190 */
drhd88fd532022-05-02 20:49:30 +00002191 if( (zName = pX->zEName)!=0 && pX->fg.eEName==ENAME_NAME ){
drh79d5f632005-01-18 17:20:10 +00002192 /* If the column contains an "AS <name>" phrase, use <name> as the name */
drh93a960a2008-07-10 00:32:42 +00002193 }else{
drh18f86002022-04-21 13:11:26 +00002194 Expr *pColExpr = sqlite3ExprSkipCollateAndLikely(pX->pExpr);
drh235667a2020-11-08 20:44:30 +00002195 while( ALWAYS(pColExpr!=0) && pColExpr->op==TK_DOT ){
drhb07028f2011-10-14 21:49:18 +00002196 pColExpr = pColExpr->pRight;
2197 assert( pColExpr!=0 );
2198 }
drh477572b2021-10-07 20:46:29 +00002199 if( pColExpr->op==TK_COLUMN
2200 && ALWAYS( ExprUseYTab(pColExpr) )
drh5af8a862022-05-27 18:06:49 +00002201 && ALWAYS( pColExpr->y.pTab!=0 )
drh477572b2021-10-07 20:46:29 +00002202 ){
drh7d10d5a2008-08-20 16:35:10 +00002203 /* For columns use the column name name */
drhdc5ea5c2008-12-10 17:19:59 +00002204 int iCol = pColExpr->iColumn;
drh5af8a862022-05-27 18:06:49 +00002205 pTab = pColExpr->y.pTab;
drhf0209f72008-08-21 14:54:28 +00002206 if( iCol<0 ) iCol = pTab->iPKey;
drhcf9d36d2021-08-02 18:03:43 +00002207 zName = iCol>=0 ? pTab->aCol[iCol].zCnName : "rowid";
drhb7916a72009-05-27 10:31:29 +00002208 }else if( pColExpr->op==TK_ID ){
drh33e619f2009-05-28 01:00:55 +00002209 assert( !ExprHasProperty(pColExpr, EP_IntValue) );
drh96ceaf82015-11-14 22:04:22 +00002210 zName = pColExpr->u.zToken;
drh7d10d5a2008-08-20 16:35:10 +00002211 }else{
2212 /* Use the original text of the column expression as its name */
drh18f86002022-04-21 13:11:26 +00002213 assert( zName==pX->zEName ); /* pointer comparison intended */
drh7d10d5a2008-08-20 16:35:10 +00002214 }
drh22f70c32002-02-18 01:17:00 +00002215 }
drh0cbec592020-01-03 02:20:37 +00002216 if( zName && !sqlite3IsTrueOrFalse(zName) ){
drhd7ca6002017-07-09 00:30:58 +00002217 zName = sqlite3DbStrDup(db, zName);
2218 }else{
drh155507b2017-07-09 18:55:29 +00002219 zName = sqlite3MPrintf(db,"column%d",i+1);
drhd7ca6002017-07-09 00:30:58 +00002220 }
drh79d5f632005-01-18 17:20:10 +00002221
2222 /* Make sure the column name is unique. If the name is not unique,
peter.d.reid60ec9142014-09-06 16:39:46 +00002223 ** append an integer to the name so that it becomes unique.
drh79d5f632005-01-18 17:20:10 +00002224 */
drh0315e3c2015-11-14 20:52:43 +00002225 cnt = 0;
drh45e41b72022-04-22 23:18:21 +00002226 while( zName && (pCollide = sqlite3HashFind(&ht, zName))!=0 ){
drhd88fd532022-05-02 20:49:30 +00002227 if( pCollide->fg.bUsingTerm ){
drhab843a52022-04-23 07:29:34 +00002228 pCol->colFlags |= COLFLAG_NOEXPAND;
drh45e41b72022-04-22 23:18:21 +00002229 }
drh0315e3c2015-11-14 20:52:43 +00002230 nName = sqlite3Strlen30(zName);
drhf7ee8962015-11-15 11:13:49 +00002231 if( nName>0 ){
2232 for(j=nName-1; j>0 && sqlite3Isdigit(zName[j]); j--){}
2233 if( zName[j]==':' ) nName = j;
2234 }
drh96ceaf82015-11-14 22:04:22 +00002235 zName = sqlite3MPrintf(db, "%.*z:%u", nName, zName, ++cnt);
drh0315e3c2015-11-14 20:52:43 +00002236 if( cnt>3 ) sqlite3_randomness(sizeof(cnt), &cnt);
drh79d5f632005-01-18 17:20:10 +00002237 }
drhcf9d36d2021-08-02 18:03:43 +00002238 pCol->zCnName = zName;
drhd44390c2020-04-06 18:16:31 +00002239 pCol->hName = sqlite3StrIHash(zName);
drhd88fd532022-05-02 20:49:30 +00002240 if( pX->fg.bNoExpand ){
drh72d620b2022-05-02 19:59:03 +00002241 pCol->colFlags |= COLFLAG_NOEXPAND;
2242 }
danba68f8f2015-11-19 16:46:46 +00002243 sqlite3ColumnPropertiesFromName(0, pCol);
drh45e41b72022-04-22 23:18:21 +00002244 if( zName && sqlite3HashInsert(&ht, zName, pX)==pX ){
drh4a642b62016-02-05 01:55:27 +00002245 sqlite3OomFault(db);
drh0315e3c2015-11-14 20:52:43 +00002246 }
drh7d10d5a2008-08-20 16:35:10 +00002247 }
drh0315e3c2015-11-14 20:52:43 +00002248 sqlite3HashClear(&ht);
drh7d10d5a2008-08-20 16:35:10 +00002249 if( db->mallocFailed ){
drh7d10d5a2008-08-20 16:35:10 +00002250 for(j=0; j<i; j++){
drhcf9d36d2021-08-02 18:03:43 +00002251 sqlite3DbFree(db, aCol[j].zCnName);
drh7d10d5a2008-08-20 16:35:10 +00002252 }
2253 sqlite3DbFree(db, aCol);
2254 *paCol = 0;
2255 *pnCol = 0;
mistachkinfad30392016-02-13 23:43:46 +00002256 return SQLITE_NOMEM_BKPT;
drh7d10d5a2008-08-20 16:35:10 +00002257 }
2258 return SQLITE_OK;
2259}
danielk1977517eb642004-06-07 10:00:31 +00002260
drh7d10d5a2008-08-20 16:35:10 +00002261/*
2262** Add type and collation information to a column list based on
2263** a SELECT statement.
2264**
2265** The column list presumably came from selectColumnNamesFromExprList().
2266** The column list has only names, not types or collations. This
2267** routine goes through and adds the types and collations.
2268**
shaneb08a67a2009-03-31 03:41:56 +00002269** This routine requires that all identifiers in the SELECT
drh7d10d5a2008-08-20 16:35:10 +00002270** statement be resolved.
2271*/
drhed06a132016-04-05 20:59:12 +00002272void sqlite3SelectAddColumnTypeAndCollation(
drh7d10d5a2008-08-20 16:35:10 +00002273 Parse *pParse, /* Parsing contexts */
drh186ad8c2013-10-08 18:40:37 +00002274 Table *pTab, /* Add column type information to this table */
drh81506b82019-08-05 19:32:06 +00002275 Select *pSelect, /* SELECT used to determine types and collations */
2276 char aff /* Default affinity for columns */
drh7d10d5a2008-08-20 16:35:10 +00002277){
2278 sqlite3 *db = pParse->db;
2279 NameContext sNC;
2280 Column *pCol;
2281 CollSeq *pColl;
2282 int i;
2283 Expr *p;
2284 struct ExprList_item *a;
2285
2286 assert( pSelect!=0 );
2287 assert( (pSelect->selFlags & SF_Resolved)!=0 );
drh186ad8c2013-10-08 18:40:37 +00002288 assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
drh7d10d5a2008-08-20 16:35:10 +00002289 if( db->mallocFailed ) return;
2290 memset(&sNC, 0, sizeof(sNC));
2291 sNC.pSrcList = pSelect->pSrc;
2292 a = pSelect->pEList->a;
drh186ad8c2013-10-08 18:40:37 +00002293 for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
drhed06a132016-04-05 20:59:12 +00002294 const char *zType;
drh913306a2021-11-26 17:10:18 +00002295 i64 n, m;
drh6f6e60d2021-02-18 15:45:34 +00002296 pTab->tabFlags |= (pCol->colFlags & COLFLAG_NOINSERT);
drh7d10d5a2008-08-20 16:35:10 +00002297 p = a[i].pExpr;
drhcafc2f72017-10-03 03:01:09 +00002298 zType = columnType(&sNC, p, 0, 0, 0);
2299 /* pCol->szEst = ... // Column size est for SELECT tables never used */
danielk1977c60e9b82005-01-31 12:42:29 +00002300 pCol->affinity = sqlite3ExprAffinity(p);
drh0c4db032017-10-03 19:53:12 +00002301 if( zType ){
2302 m = sqlite3Strlen30(zType);
drhcf9d36d2021-08-02 18:03:43 +00002303 n = sqlite3Strlen30(pCol->zCnName);
2304 pCol->zCnName = sqlite3DbReallocOrFree(db, pCol->zCnName, n+m+2);
2305 if( pCol->zCnName ){
2306 memcpy(&pCol->zCnName[n+1], zType, m+1);
drhed06a132016-04-05 20:59:12 +00002307 pCol->colFlags |= COLFLAG_HASTYPE;
drh146121f2021-11-12 14:39:49 +00002308 }else{
2309 testcase( pCol->colFlags & COLFLAG_HASTYPE );
2310 pCol->colFlags &= ~(COLFLAG_HASTYPE|COLFLAG_HASCOLL);
drhed06a132016-04-05 20:59:12 +00002311 }
2312 }
drh96fb16e2019-08-06 14:37:24 +00002313 if( pCol->affinity<=SQLITE_AFF_NONE ) pCol->affinity = aff;
danielk1977b3bf5562006-01-10 17:58:23 +00002314 pColl = sqlite3ExprCollSeq(pParse, p);
drh5ced0a92021-08-24 17:07:44 +00002315 if( pColl ){
drh65b40092021-08-05 15:27:19 +00002316 assert( pTab->pIndex==0 );
2317 sqlite3ColumnSetColl(db, pCol, pColl->zName);
danielk19770202b292004-06-09 09:55:16 +00002318 }
drh22f70c32002-02-18 01:17:00 +00002319 }
drhcafc2f72017-10-03 03:01:09 +00002320 pTab->szTabRow = 1; /* Any non-zero value works */
drh7d10d5a2008-08-20 16:35:10 +00002321}
2322
2323/*
2324** Given a SELECT statement, generate a Table structure that describes
2325** the result set of that SELECT.
2326*/
drh81506b82019-08-05 19:32:06 +00002327Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect, char aff){
drh7d10d5a2008-08-20 16:35:10 +00002328 Table *pTab;
2329 sqlite3 *db = pParse->db;
drh70d5dfb2018-12-06 16:50:55 +00002330 u64 savedFlags;
drh7d10d5a2008-08-20 16:35:10 +00002331
2332 savedFlags = db->flags;
drhd5b44d62018-12-06 17:06:02 +00002333 db->flags &= ~(u64)SQLITE_FullColNames;
drh7d10d5a2008-08-20 16:35:10 +00002334 db->flags |= SQLITE_ShortColNames;
2335 sqlite3SelectPrep(pParse, pSelect, 0);
drh491b6d82019-01-24 15:51:03 +00002336 db->flags = savedFlags;
drh7d10d5a2008-08-20 16:35:10 +00002337 if( pParse->nErr ) return 0;
2338 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh7d10d5a2008-08-20 16:35:10 +00002339 pTab = sqlite3DbMallocZero(db, sizeof(Table) );
2340 if( pTab==0 ){
2341 return 0;
2342 }
drh79df7782016-12-14 14:07:35 +00002343 pTab->nTabRef = 1;
drh7d10d5a2008-08-20 16:35:10 +00002344 pTab->zName = 0;
dancfc9df72014-04-25 15:01:01 +00002345 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drh8981b902015-08-24 17:42:49 +00002346 sqlite3ColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
drh81506b82019-08-05 19:32:06 +00002347 sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSelect, aff);
drh22f70c32002-02-18 01:17:00 +00002348 pTab->iPKey = -1;
drh7ce72f62008-07-24 15:50:41 +00002349 if( db->mallocFailed ){
dan1feeaed2010-07-23 15:41:47 +00002350 sqlite3DeleteTable(db, pTab);
drh7ce72f62008-07-24 15:50:41 +00002351 return 0;
2352 }
drh22f70c32002-02-18 01:17:00 +00002353 return pTab;
2354}
2355
2356/*
drhd8bc7082000-06-07 23:51:50 +00002357** Get a VDBE for the given parser context. Create a new one if necessary.
2358** If an error occurs, return NULL and leave a message in pParse.
2359*/
drh55965612017-09-16 20:58:41 +00002360Vdbe *sqlite3GetVdbe(Parse *pParse){
2361 if( pParse->pVdbe ){
2362 return pParse->pVdbe;
2363 }
drh6f077342016-04-12 00:26:59 +00002364 if( pParse->pToplevel==0
2365 && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
2366 ){
2367 pParse->okConstFactor = 1;
drhd8bc7082000-06-07 23:51:50 +00002368 }
drh55965612017-09-16 20:58:41 +00002369 return sqlite3VdbeCreate(pParse);
drh6f077342016-04-12 00:26:59 +00002370}
drhfcb78a42003-01-18 20:11:05 +00002371
drh15007a92006-01-08 18:10:17 +00002372
drhd8bc7082000-06-07 23:51:50 +00002373/*
drh7b58dae2003-07-20 01:16:46 +00002374** Compute the iLimit and iOffset fields of the SELECT based on the
drh8c0833f2017-11-14 23:48:23 +00002375** pLimit expressions. pLimit->pLeft and pLimit->pRight hold the expressions
drh7b58dae2003-07-20 01:16:46 +00002376** that appear in the original SQL statement after the LIMIT and OFFSET
danielk1977a2dc3b12005-02-05 12:48:48 +00002377** keywords. Or NULL if those keywords are omitted. iLimit and iOffset
2378** are the integer memory register numbers for counters used to compute
2379** the limit and offset. If there is no limit and/or offset, then
2380** iLimit and iOffset are negative.
drh7b58dae2003-07-20 01:16:46 +00002381**
drhd59ba6c2006-01-08 05:02:54 +00002382** This routine changes the values of iLimit and iOffset only if
drh8c0833f2017-11-14 23:48:23 +00002383** a limit or offset is defined by pLimit->pLeft and pLimit->pRight. iLimit
2384** and iOffset should have been preset to appropriate default values (zero)
drhaa9ce702014-01-22 18:07:04 +00002385** prior to calling this routine.
2386**
2387** The iOffset register (if it exists) is initialized to the value
2388** of the OFFSET. The iLimit register is initialized to LIMIT. Register
2389** iOffset+1 is initialized to LIMIT+OFFSET.
2390**
drh8c0833f2017-11-14 23:48:23 +00002391** Only if pLimit->pLeft!=0 do the limit registers get
drh7b58dae2003-07-20 01:16:46 +00002392** redefined. The UNION ALL operator uses this property to force
2393** the reuse of the same limit and offset registers across multiple
2394** SELECT statements.
2395*/
drhec7429a2005-10-06 16:53:14 +00002396static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
drh02afc862006-01-20 18:10:57 +00002397 Vdbe *v = 0;
2398 int iLimit = 0;
drh15007a92006-01-08 18:10:17 +00002399 int iOffset;
drh8b0cf382015-10-06 21:07:06 +00002400 int n;
drh8c0833f2017-11-14 23:48:23 +00002401 Expr *pLimit = p->pLimit;
2402
drh0acb7e42008-06-25 00:12:41 +00002403 if( p->iLimit ) return;
drh15007a92006-01-08 18:10:17 +00002404
drh7b58dae2003-07-20 01:16:46 +00002405 /*
drh7b58dae2003-07-20 01:16:46 +00002406 ** "LIMIT -1" always shows all rows. There is some
drhf7b54962013-05-28 12:11:54 +00002407 ** controversy about what the correct behavior should be.
drh7b58dae2003-07-20 01:16:46 +00002408 ** The current implementation interprets "LIMIT 0" to mean
2409 ** no rows.
2410 */
drh8c0833f2017-11-14 23:48:23 +00002411 if( pLimit ){
2412 assert( pLimit->op==TK_LIMIT );
2413 assert( pLimit->pLeft!=0 );
drh0a07c102008-01-03 18:03:08 +00002414 p->iLimit = iLimit = ++pParse->nMem;
drh15007a92006-01-08 18:10:17 +00002415 v = sqlite3GetVdbe(pParse);
drhaa9ce702014-01-22 18:07:04 +00002416 assert( v!=0 );
drh8c0833f2017-11-14 23:48:23 +00002417 if( sqlite3ExprIsInteger(pLimit->pLeft, &n) ){
drh456e4e42009-11-20 16:13:15 +00002418 sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
2419 VdbeComment((v, "LIMIT counter"));
drh9b918ed2009-11-12 03:13:26 +00002420 if( n==0 ){
drh076e85f2015-09-03 13:46:12 +00002421 sqlite3VdbeGoto(v, iBreak);
drhc3489bb2016-02-25 16:04:59 +00002422 }else if( n>=0 && p->nSelectRow>sqlite3LogEst((u64)n) ){
2423 p->nSelectRow = sqlite3LogEst((u64)n);
2424 p->selFlags |= SF_FixedLimit;
drh9b918ed2009-11-12 03:13:26 +00002425 }
2426 }else{
drh8c0833f2017-11-14 23:48:23 +00002427 sqlite3ExprCode(pParse, pLimit->pLeft, iLimit);
drh688852a2014-02-17 22:40:43 +00002428 sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
drh9b918ed2009-11-12 03:13:26 +00002429 VdbeComment((v, "LIMIT counter"));
drh16897072015-03-07 00:57:37 +00002430 sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, iBreak); VdbeCoverage(v);
drh9b918ed2009-11-12 03:13:26 +00002431 }
drh8c0833f2017-11-14 23:48:23 +00002432 if( pLimit->pRight ){
drh373cc2d2009-05-17 02:06:14 +00002433 p->iOffset = iOffset = ++pParse->nMem;
drhb7654112008-01-12 12:48:07 +00002434 pParse->nMem++; /* Allocate an extra register for limit+offset */
drh8c0833f2017-11-14 23:48:23 +00002435 sqlite3ExprCode(pParse, pLimit->pRight, iOffset);
drh688852a2014-02-17 22:40:43 +00002436 sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
drh373cc2d2009-05-17 02:06:14 +00002437 VdbeComment((v, "OFFSET counter"));
drhcc2fa4c2016-01-25 15:57:29 +00002438 sqlite3VdbeAddOp3(v, OP_OffsetLimit, iLimit, iOffset+1, iOffset);
drhb7654112008-01-12 12:48:07 +00002439 VdbeComment((v, "LIMIT+OFFSET"));
drhd59ba6c2006-01-08 05:02:54 +00002440 }
drh7b58dae2003-07-20 01:16:46 +00002441 }
2442}
2443
drhb7f91642004-10-31 02:22:47 +00002444#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhfbc4ee72004-08-29 01:31:05 +00002445/*
drhfbc4ee72004-08-29 01:31:05 +00002446** Return the appropriate collating sequence for the iCol-th column of
2447** the result set for the compound-select statement "p". Return NULL if
2448** the column has no default collating sequence.
2449**
2450** The collating sequence for the compound select is taken from the
2451** left-most term of the select that has a collating sequence.
2452*/
danielk1977dc1bdc42004-06-11 10:51:27 +00002453static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
drhfbc4ee72004-08-29 01:31:05 +00002454 CollSeq *pRet;
danielk1977dc1bdc42004-06-11 10:51:27 +00002455 if( p->pPrior ){
2456 pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
drhfbc4ee72004-08-29 01:31:05 +00002457 }else{
2458 pRet = 0;
danielk1977dc1bdc42004-06-11 10:51:27 +00002459 }
drh10c081a2009-04-16 00:24:23 +00002460 assert( iCol>=0 );
drh2ec18a32015-06-23 23:31:52 +00002461 /* iCol must be less than p->pEList->nExpr. Otherwise an error would
2462 ** have been thrown during name resolution and we would not have gotten
2463 ** this far */
2464 if( pRet==0 && ALWAYS(iCol<p->pEList->nExpr) ){
danielk1977dc1bdc42004-06-11 10:51:27 +00002465 pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
2466 }
2467 return pRet;
drhd3d39e92004-05-20 22:16:29 +00002468}
2469
dan53bed452014-01-24 20:37:18 +00002470/*
2471** The select statement passed as the second parameter is a compound SELECT
2472** with an ORDER BY clause. This function allocates and returns a KeyInfo
2473** structure suitable for implementing the ORDER BY.
2474**
2475** Space to hold the KeyInfo structure is obtained from malloc. The calling
2476** function is responsible for ensuring that this structure is eventually
2477** freed.
2478*/
2479static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
2480 ExprList *pOrderBy = p->pOrderBy;
drh7d4c94b2021-10-04 22:34:38 +00002481 int nOrderBy = ALWAYS(pOrderBy!=0) ? pOrderBy->nExpr : 0;
dan53bed452014-01-24 20:37:18 +00002482 sqlite3 *db = pParse->db;
2483 KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
2484 if( pRet ){
2485 int i;
2486 for(i=0; i<nOrderBy; i++){
2487 struct ExprList_item *pItem = &pOrderBy->a[i];
2488 Expr *pTerm = pItem->pExpr;
2489 CollSeq *pColl;
2490
2491 if( pTerm->flags & EP_Collate ){
2492 pColl = sqlite3ExprCollSeq(pParse, pTerm);
2493 }else{
2494 pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
2495 if( pColl==0 ) pColl = db->pDfltColl;
2496 pOrderBy->a[i].pExpr =
2497 sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
2498 }
2499 assert( sqlite3KeyInfoIsWriteable(pRet) );
2500 pRet->aColl[i] = pColl;
drhd88fd532022-05-02 20:49:30 +00002501 pRet->aSortFlags[i] = pOrderBy->a[i].fg.sortFlags;
dan53bed452014-01-24 20:37:18 +00002502 }
2503 }
2504
2505 return pRet;
2506}
drhd3d39e92004-05-20 22:16:29 +00002507
drh781def22014-01-22 13:35:53 +00002508#ifndef SQLITE_OMIT_CTE
2509/*
2510** This routine generates VDBE code to compute the content of a WITH RECURSIVE
2511** query of the form:
2512**
2513** <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
2514** \___________/ \_______________/
2515** p->pPrior p
2516**
2517**
2518** There is exactly one reference to the recursive-table in the FROM clause
drh8a48b9c2015-08-19 15:20:00 +00002519** of recursive-query, marked with the SrcList->a[].fg.isRecursive flag.
drh781def22014-01-22 13:35:53 +00002520**
2521** The setup-query runs once to generate an initial set of rows that go
2522** into a Queue table. Rows are extracted from the Queue table one by
drhfe1c6bb2014-01-22 17:28:35 +00002523** one. Each row extracted from Queue is output to pDest. Then the single
2524** extracted row (now in the iCurrent table) becomes the content of the
2525** recursive-table for a recursive-query run. The output of the recursive-query
drh781def22014-01-22 13:35:53 +00002526** is added back into the Queue table. Then another row is extracted from Queue
2527** and the iteration continues until the Queue table is empty.
2528**
2529** If the compound query operator is UNION then no duplicate rows are ever
2530** inserted into the Queue table. The iDistinct table keeps a copy of all rows
2531** that have ever been inserted into Queue and causes duplicates to be
2532** discarded. If the operator is UNION ALL, then duplicates are allowed.
2533**
2534** If the query has an ORDER BY, then entries in the Queue table are kept in
2535** ORDER BY order and the first entry is extracted for each cycle. Without
2536** an ORDER BY, the Queue table is just a FIFO.
2537**
2538** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
2539** have been output to pDest. A LIMIT of zero means to output no rows and a
2540** negative LIMIT means to output all rows. If there is also an OFFSET clause
2541** with a positive value, then the first OFFSET outputs are discarded rather
2542** than being sent to pDest. The LIMIT count does not begin until after OFFSET
2543** rows have been skipped.
2544*/
2545static void generateWithRecursiveQuery(
2546 Parse *pParse, /* Parsing context */
2547 Select *p, /* The recursive SELECT to be coded */
2548 SelectDest *pDest /* What to do with query results */
2549){
2550 SrcList *pSrc = p->pSrc; /* The FROM clause of the recursive query */
2551 int nCol = p->pEList->nExpr; /* Number of columns in the recursive table */
2552 Vdbe *v = pParse->pVdbe; /* The prepared statement under construction */
drhe85e1da2021-10-01 21:01:07 +00002553 Select *pSetup; /* The setup query */
drh34055852020-10-19 01:23:48 +00002554 Select *pFirstRec; /* Left-most recursive term */
drh781def22014-01-22 13:35:53 +00002555 int addrTop; /* Top of the loop */
2556 int addrCont, addrBreak; /* CONTINUE and BREAK addresses */
drhedf83d12014-01-22 18:31:27 +00002557 int iCurrent = 0; /* The Current table */
drh781def22014-01-22 13:35:53 +00002558 int regCurrent; /* Register holding Current table */
2559 int iQueue; /* The Queue table */
2560 int iDistinct = 0; /* To ensure unique results if UNION */
drh8e1ee882014-03-21 19:56:09 +00002561 int eDest = SRT_Fifo; /* How to write to Queue */
drh781def22014-01-22 13:35:53 +00002562 SelectDest destQueue; /* SelectDest targetting the Queue table */
2563 int i; /* Loop counter */
2564 int rc; /* Result code */
drhfe1c6bb2014-01-22 17:28:35 +00002565 ExprList *pOrderBy; /* The ORDER BY clause */
drh8c0833f2017-11-14 23:48:23 +00002566 Expr *pLimit; /* Saved LIMIT and OFFSET */
drhaa9ce702014-01-22 18:07:04 +00002567 int regLimit, regOffset; /* Registers used by LIMIT and OFFSET */
drh781def22014-01-22 13:35:53 +00002568
dan6afa35c2018-09-27 12:14:15 +00002569#ifndef SQLITE_OMIT_WINDOWFUNC
2570 if( p->pWin ){
2571 sqlite3ErrorMsg(pParse, "cannot use window functions in recursive queries");
2572 return;
2573 }
2574#endif
2575
drh781def22014-01-22 13:35:53 +00002576 /* Obtain authorization to do a recursive query */
2577 if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
drh781def22014-01-22 13:35:53 +00002578
drhaa9ce702014-01-22 18:07:04 +00002579 /* Process the LIMIT and OFFSET clauses, if they exist */
drhec4ccdb2018-12-29 02:26:59 +00002580 addrBreak = sqlite3VdbeMakeLabel(pParse);
dan69b93832016-12-16 15:05:40 +00002581 p->nSelectRow = 320; /* 4 billion rows */
drhaa9ce702014-01-22 18:07:04 +00002582 computeLimitRegisters(pParse, p, addrBreak);
2583 pLimit = p->pLimit;
drhaa9ce702014-01-22 18:07:04 +00002584 regLimit = p->iLimit;
2585 regOffset = p->iOffset;
drh8c0833f2017-11-14 23:48:23 +00002586 p->pLimit = 0;
drhaa9ce702014-01-22 18:07:04 +00002587 p->iLimit = p->iOffset = 0;
dan53bed452014-01-24 20:37:18 +00002588 pOrderBy = p->pOrderBy;
drh781def22014-01-22 13:35:53 +00002589
2590 /* Locate the cursor number of the Current table */
2591 for(i=0; ALWAYS(i<pSrc->nSrc); i++){
drh8a48b9c2015-08-19 15:20:00 +00002592 if( pSrc->a[i].fg.isRecursive ){
drh781def22014-01-22 13:35:53 +00002593 iCurrent = pSrc->a[i].iCursor;
2594 break;
2595 }
2596 }
2597
drhfe1c6bb2014-01-22 17:28:35 +00002598 /* Allocate cursors numbers for Queue and Distinct. The cursor number for
drh781def22014-01-22 13:35:53 +00002599 ** the Distinct table must be exactly one greater than Queue in order
drh8e1ee882014-03-21 19:56:09 +00002600 ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
drh781def22014-01-22 13:35:53 +00002601 iQueue = pParse->nTab++;
2602 if( p->op==TK_UNION ){
drh8e1ee882014-03-21 19:56:09 +00002603 eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
drh781def22014-01-22 13:35:53 +00002604 iDistinct = pParse->nTab++;
drhfe1c6bb2014-01-22 17:28:35 +00002605 }else{
drh8e1ee882014-03-21 19:56:09 +00002606 eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
drh781def22014-01-22 13:35:53 +00002607 }
2608 sqlite3SelectDestInit(&destQueue, eDest, iQueue);
2609
2610 /* Allocate cursors for Current, Queue, and Distinct. */
2611 regCurrent = ++pParse->nMem;
2612 sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
drhfe1c6bb2014-01-22 17:28:35 +00002613 if( pOrderBy ){
dan53bed452014-01-24 20:37:18 +00002614 KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
drhfe1c6bb2014-01-22 17:28:35 +00002615 sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
2616 (char*)pKeyInfo, P4_KEYINFO);
2617 destQueue.pOrderBy = pOrderBy;
2618 }else{
2619 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
2620 }
2621 VdbeComment((v, "Queue table"));
drh781def22014-01-22 13:35:53 +00002622 if( iDistinct ){
2623 p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
2624 p->selFlags |= SF_UsesEphemeral;
2625 }
2626
dan53bed452014-01-24 20:37:18 +00002627 /* Detach the ORDER BY clause from the compound SELECT */
2628 p->pOrderBy = 0;
2629
drh34055852020-10-19 01:23:48 +00002630 /* Figure out how many elements of the compound SELECT are part of the
2631 ** recursive query. Make sure no recursive elements use aggregate
2632 ** functions. Mark the recursive elements as UNION ALL even if they
2633 ** are really UNION because the distinctness will be enforced by the
2634 ** iDistinct table. pFirstRec is left pointing to the left-most
2635 ** recursive term of the CTE.
2636 */
drh34055852020-10-19 01:23:48 +00002637 for(pFirstRec=p; ALWAYS(pFirstRec!=0); pFirstRec=pFirstRec->pPrior){
2638 if( pFirstRec->selFlags & SF_Aggregate ){
2639 sqlite3ErrorMsg(pParse, "recursive aggregate queries not supported");
2640 goto end_of_recursive_query;
2641 }
2642 pFirstRec->op = TK_ALL;
2643 if( (pFirstRec->pPrior->selFlags & SF_Recursive)==0 ) break;
2644 }
2645
drh781def22014-01-22 13:35:53 +00002646 /* Store the results of the setup-query in Queue. */
drh34055852020-10-19 01:23:48 +00002647 pSetup = pFirstRec->pPrior;
drhd227a292014-02-09 18:02:09 +00002648 pSetup->pNext = 0;
drh84a01de2018-05-02 16:13:48 +00002649 ExplainQueryPlan((pParse, 1, "SETUP"));
drh781def22014-01-22 13:35:53 +00002650 rc = sqlite3Select(pParse, pSetup, &destQueue);
drhd227a292014-02-09 18:02:09 +00002651 pSetup->pNext = p;
drhfe1c6bb2014-01-22 17:28:35 +00002652 if( rc ) goto end_of_recursive_query;
drh781def22014-01-22 13:35:53 +00002653
2654 /* Find the next row in the Queue and output that row */
drh688852a2014-02-17 22:40:43 +00002655 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
drh781def22014-01-22 13:35:53 +00002656
2657 /* Transfer the next row in Queue over to Current */
2658 sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
drhfe1c6bb2014-01-22 17:28:35 +00002659 if( pOrderBy ){
2660 sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
2661 }else{
2662 sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
2663 }
drh781def22014-01-22 13:35:53 +00002664 sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
2665
drhfe1c6bb2014-01-22 17:28:35 +00002666 /* Output the single row in Current */
drhec4ccdb2018-12-29 02:26:59 +00002667 addrCont = sqlite3VdbeMakeLabel(pParse);
drhaa9ce702014-01-22 18:07:04 +00002668 codeOffset(v, regOffset, addrCont);
drh2def2f72017-09-15 17:40:34 +00002669 selectInnerLoop(pParse, p, iCurrent,
drh079a3072014-03-19 14:10:55 +00002670 0, 0, pDest, addrCont, addrBreak);
drh688852a2014-02-17 22:40:43 +00002671 if( regLimit ){
drh16897072015-03-07 00:57:37 +00002672 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, regLimit, addrBreak);
drh688852a2014-02-17 22:40:43 +00002673 VdbeCoverage(v);
2674 }
drhfe1c6bb2014-01-22 17:28:35 +00002675 sqlite3VdbeResolveLabel(v, addrCont);
2676
drh781def22014-01-22 13:35:53 +00002677 /* Execute the recursive SELECT taking the single row in Current as
2678 ** the value for the recursive-table. Store the results in the Queue.
2679 */
drh34055852020-10-19 01:23:48 +00002680 pFirstRec->pPrior = 0;
2681 ExplainQueryPlan((pParse, 1, "RECURSIVE STEP"));
2682 sqlite3Select(pParse, p, &destQueue);
2683 assert( pFirstRec->pPrior==0 );
2684 pFirstRec->pPrior = pSetup;
drh781def22014-01-22 13:35:53 +00002685
2686 /* Keep running the loop until the Queue is empty */
drh076e85f2015-09-03 13:46:12 +00002687 sqlite3VdbeGoto(v, addrTop);
drh781def22014-01-22 13:35:53 +00002688 sqlite3VdbeResolveLabel(v, addrBreak);
drhfe1c6bb2014-01-22 17:28:35 +00002689
2690end_of_recursive_query:
dan9afccba2014-03-21 19:27:54 +00002691 sqlite3ExprListDelete(pParse->db, p->pOrderBy);
drhfe1c6bb2014-01-22 17:28:35 +00002692 p->pOrderBy = pOrderBy;
drhaa9ce702014-01-22 18:07:04 +00002693 p->pLimit = pLimit;
drhfe1c6bb2014-01-22 17:28:35 +00002694 return;
drh781def22014-01-22 13:35:53 +00002695}
danb68b9772014-01-25 12:16:53 +00002696#endif /* SQLITE_OMIT_CTE */
drh781def22014-01-22 13:35:53 +00002697
2698/* Forward references */
drhb21e7c72008-06-22 12:37:57 +00002699static int multiSelectOrderBy(
2700 Parse *pParse, /* Parsing context */
2701 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00002702 SelectDest *pDest /* What to do with query results */
drhb21e7c72008-06-22 12:37:57 +00002703);
2704
drh45f54a52015-01-05 19:16:42 +00002705/*
drh45f54a52015-01-05 19:16:42 +00002706** Handle the special case of a compound-select that originates from a
2707** VALUES clause. By handling this as a special case, we avoid deep
2708** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
2709** on a VALUES clause.
2710**
2711** Because the Select object originates from a VALUES clause:
drhb058d052018-01-14 20:12:23 +00002712** (1) There is no LIMIT or OFFSET or else there is a LIMIT of exactly 1
drh45f54a52015-01-05 19:16:42 +00002713** (2) All terms are UNION ALL
2714** (3) There is no ORDER BY clause
drhb058d052018-01-14 20:12:23 +00002715**
2716** The "LIMIT of exactly 1" case of condition (1) comes about when a VALUES
2717** clause occurs within scalar expression (ex: "SELECT (VALUES(1),(2),(3))").
2718** The sqlite3CodeSubselect will have added the LIMIT 1 clause in tht case.
drhd1f0a862022-02-25 11:30:29 +00002719** Since the limit is exactly 1, we only need to evaluate the left-most VALUES.
drh45f54a52015-01-05 19:16:42 +00002720*/
2721static int multiSelectValues(
2722 Parse *pParse, /* Parsing context */
2723 Select *p, /* The right-most of SELECTs to be coded */
2724 SelectDest *pDest /* What to do with query results */
2725){
drh45f54a52015-01-05 19:16:42 +00002726 int nRow = 1;
2727 int rc = 0;
drhfa16f5d2018-05-03 01:37:13 +00002728 int bShowAll = p->pLimit==0;
drh772460f2015-04-16 14:13:12 +00002729 assert( p->selFlags & SF_MultiValue );
drh45f54a52015-01-05 19:16:42 +00002730 do{
2731 assert( p->selFlags & SF_Values );
2732 assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
dan923cadb2015-06-23 12:19:55 +00002733 assert( p->pNext==0 || p->pEList->nExpr==p->pNext->pEList->nExpr );
drhef9f7192020-01-17 19:14:08 +00002734#ifndef SQLITE_OMIT_WINDOWFUNC
drh29cdbad2019-12-07 13:42:47 +00002735 if( p->pWin ) return -1;
drhef9f7192020-01-17 19:14:08 +00002736#endif
drh45f54a52015-01-05 19:16:42 +00002737 if( p->pPrior==0 ) break;
2738 assert( p->pPrior->pNext==p );
2739 p = p->pPrior;
drhfa16f5d2018-05-03 01:37:13 +00002740 nRow += bShowAll;
drh45f54a52015-01-05 19:16:42 +00002741 }while(1);
drhfa16f5d2018-05-03 01:37:13 +00002742 ExplainQueryPlan((pParse, 0, "SCAN %d CONSTANT ROW%s", nRow,
2743 nRow==1 ? "" : "S"));
drh45f54a52015-01-05 19:16:42 +00002744 while( p ){
drhfa16f5d2018-05-03 01:37:13 +00002745 selectInnerLoop(pParse, p, -1, 0, 0, pDest, 1, 1);
2746 if( !bShowAll ) break;
drh45f54a52015-01-05 19:16:42 +00002747 p->nSelectRow = nRow;
2748 p = p->pNext;
2749 }
2750 return rc;
2751}
drhb21e7c72008-06-22 12:37:57 +00002752
drhd3d39e92004-05-20 22:16:29 +00002753/*
drh34055852020-10-19 01:23:48 +00002754** Return true if the SELECT statement which is known to be the recursive
2755** part of a recursive CTE still has its anchor terms attached. If the
2756** anchor terms have already been removed, then return false.
2757*/
2758static int hasAnchor(Select *p){
2759 while( p && (p->selFlags & SF_Recursive)!=0 ){ p = p->pPrior; }
2760 return p!=0;
2761}
2762
2763/*
drh16ee60f2008-06-20 18:13:25 +00002764** This routine is called to process a compound query form from
2765** two or more separate queries using UNION, UNION ALL, EXCEPT, or
2766** INTERSECT
drhc926afb2002-06-20 03:38:26 +00002767**
drhe78e8282003-01-19 03:59:45 +00002768** "p" points to the right-most of the two queries. the query on the
2769** left is p->pPrior. The left query could also be a compound query
2770** in which case this routine will be called recursively.
2771**
2772** The results of the total query are to be written into a destination
2773** of type eDest with parameter iParm.
2774**
2775** Example 1: Consider a three-way compound SQL statement.
2776**
2777** SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
2778**
2779** This statement is parsed up as follows:
2780**
2781** SELECT c FROM t3
2782** |
2783** `-----> SELECT b FROM t2
2784** |
jplyon4b11c6d2004-01-19 04:57:53 +00002785** `------> SELECT a FROM t1
drhe78e8282003-01-19 03:59:45 +00002786**
2787** The arrows in the diagram above represent the Select.pPrior pointer.
2788** So if this routine is called with p equal to the t3 query, then
2789** pPrior will be the t2 query. p->op will be TK_UNION in this case.
2790**
2791** Notice that because of the way SQLite parses compound SELECTs, the
2792** individual selects always group from left to right.
drh82c3d632000-06-06 21:56:07 +00002793*/
danielk197784ac9d02004-05-18 09:58:06 +00002794static int multiSelect(
drhfbc4ee72004-08-29 01:31:05 +00002795 Parse *pParse, /* Parsing context */
2796 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00002797 SelectDest *pDest /* What to do with query results */
danielk197784ac9d02004-05-18 09:58:06 +00002798){
drhfbc4ee72004-08-29 01:31:05 +00002799 int rc = SQLITE_OK; /* Success code from a subroutine */
2800 Select *pPrior; /* Another SELECT immediately to our left */
2801 Vdbe *v; /* Generate code to this VDBE */
drh1013c932008-01-06 00:25:21 +00002802 SelectDest dest; /* Alternative data destination */
danielk1977eca7e012008-07-01 16:05:25 +00002803 Select *pDelete = 0; /* Chain of simple selects to delete */
drh633e6d52008-07-28 19:34:53 +00002804 sqlite3 *db; /* Database connection */
drh82c3d632000-06-06 21:56:07 +00002805
drh7b58dae2003-07-20 01:16:46 +00002806 /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs. Only
drhfbc4ee72004-08-29 01:31:05 +00002807 ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
drh82c3d632000-06-06 21:56:07 +00002808 */
drh701bb3b2008-08-02 03:50:39 +00002809 assert( p && p->pPrior ); /* Calling function guarantees this much */
daneae73fb2014-01-16 18:34:33 +00002810 assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
drhb0968b62019-05-29 18:33:59 +00002811 assert( p->selFlags & SF_Compound );
drh633e6d52008-07-28 19:34:53 +00002812 db = pParse->db;
drhd8bc7082000-06-07 23:51:50 +00002813 pPrior = p->pPrior;
drhbc103772008-08-08 18:06:25 +00002814 dest = *pDest;
drhaae0f742021-03-04 16:03:32 +00002815 assert( pPrior->pOrderBy==0 );
2816 assert( pPrior->pLimit==0 );
drh82c3d632000-06-06 21:56:07 +00002817
danielk19774adee202004-05-08 08:23:19 +00002818 v = sqlite3GetVdbe(pParse);
drh701bb3b2008-08-02 03:50:39 +00002819 assert( v!=0 ); /* The VDBE already created by calling function */
drhd8bc7082000-06-07 23:51:50 +00002820
drh1cc3d752002-03-23 00:31:29 +00002821 /* Create the destination temporary table if necessary
2822 */
danielk19776c8c8ce2008-01-02 16:27:09 +00002823 if( dest.eDest==SRT_EphemTab ){
danielk1977b4964b72004-05-18 01:23:38 +00002824 assert( p->pEList );
drh2b596da2012-07-23 21:43:19 +00002825 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
danielk19776c8c8ce2008-01-02 16:27:09 +00002826 dest.eDest = SRT_Table;
drh1cc3d752002-03-23 00:31:29 +00002827 }
2828
drh45f54a52015-01-05 19:16:42 +00002829 /* Special handling for a compound-select that originates as a VALUES clause.
2830 */
drh772460f2015-04-16 14:13:12 +00002831 if( p->selFlags & SF_MultiValue ){
drh45f54a52015-01-05 19:16:42 +00002832 rc = multiSelectValues(pParse, p, &dest);
drh29cdbad2019-12-07 13:42:47 +00002833 if( rc>=0 ) goto multi_select_end;
2834 rc = SQLITE_OK;
drh45f54a52015-01-05 19:16:42 +00002835 }
2836
drhf6e369a2008-06-24 12:46:30 +00002837 /* Make sure all SELECTs in the statement have the same number of elements
2838 ** in their result sets.
2839 */
2840 assert( p->pEList && pPrior->pEList );
dan923cadb2015-06-23 12:19:55 +00002841 assert( p->pEList->nExpr==pPrior->pEList->nExpr );
drhf6e369a2008-06-24 12:46:30 +00002842
daneede6a52014-01-15 19:42:23 +00002843#ifndef SQLITE_OMIT_CTE
drh34055852020-10-19 01:23:48 +00002844 if( (p->selFlags & SF_Recursive)!=0 && hasAnchor(p) ){
drh781def22014-01-22 13:35:53 +00002845 generateWithRecursiveQuery(pParse, p, &dest);
dan8ce71842014-01-14 20:14:09 +00002846 }else
2847#endif
drhf6e369a2008-06-24 12:46:30 +00002848
drha9671a22008-07-08 23:40:20 +00002849 /* Compound SELECTs that have an ORDER BY clause are handled separately.
2850 */
drhf6e369a2008-06-24 12:46:30 +00002851 if( p->pOrderBy ){
drha9671a22008-07-08 23:40:20 +00002852 return multiSelectOrderBy(pParse, p, pDest);
drh03c39052018-05-02 14:24:34 +00002853 }else{
drhf6e369a2008-06-24 12:46:30 +00002854
drhc631ded2018-05-02 02:22:22 +00002855#ifndef SQLITE_OMIT_EXPLAIN
drh03c39052018-05-02 14:24:34 +00002856 if( pPrior->pPrior==0 ){
drh4d799832018-05-03 19:47:14 +00002857 ExplainQueryPlan((pParse, 1, "COMPOUND QUERY"));
drh03c39052018-05-02 14:24:34 +00002858 ExplainQueryPlan((pParse, 1, "LEFT-MOST SUBQUERY"));
drh03c39052018-05-02 14:24:34 +00002859 }
drhc631ded2018-05-02 02:22:22 +00002860#endif
2861
drh03c39052018-05-02 14:24:34 +00002862 /* Generate code for the left and right SELECT statements.
2863 */
2864 switch( p->op ){
2865 case TK_ALL: {
2866 int addr = 0;
drh252d5822021-04-07 13:20:34 +00002867 int nLimit = 0; /* Initialize to suppress harmless compiler warning */
drh03c39052018-05-02 14:24:34 +00002868 assert( !pPrior->pLimit );
2869 pPrior->iLimit = p->iLimit;
2870 pPrior->iOffset = p->iOffset;
2871 pPrior->pLimit = p->pLimit;
drh93ffb502021-05-18 19:10:10 +00002872 SELECTTRACE(1, pParse, p, ("multiSelect UNION ALL left...\n"));
drh03c39052018-05-02 14:24:34 +00002873 rc = sqlite3Select(pParse, pPrior, &dest);
drhbc7819d2021-03-05 14:08:45 +00002874 pPrior->pLimit = 0;
drh03c39052018-05-02 14:24:34 +00002875 if( rc ){
2876 goto multi_select_end;
drh9f1ef452015-10-06 17:27:18 +00002877 }
drh03c39052018-05-02 14:24:34 +00002878 p->pPrior = 0;
2879 p->iLimit = pPrior->iLimit;
2880 p->iOffset = pPrior->iOffset;
2881 if( p->iLimit ){
2882 addr = sqlite3VdbeAddOp1(v, OP_IfNot, p->iLimit); VdbeCoverage(v);
2883 VdbeComment((v, "Jump ahead if LIMIT reached"));
2884 if( p->iOffset ){
2885 sqlite3VdbeAddOp3(v, OP_OffsetLimit,
2886 p->iLimit, p->iOffset+1, p->iOffset);
2887 }
2888 }
2889 ExplainQueryPlan((pParse, 1, "UNION ALL"));
drh93ffb502021-05-18 19:10:10 +00002890 SELECTTRACE(1, pParse, p, ("multiSelect UNION ALL right...\n"));
drh03c39052018-05-02 14:24:34 +00002891 rc = sqlite3Select(pParse, p, &dest);
2892 testcase( rc!=SQLITE_OK );
2893 pDelete = p->pPrior;
2894 p->pPrior = pPrior;
2895 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
drhbc7819d2021-03-05 14:08:45 +00002896 if( p->pLimit
2897 && sqlite3ExprIsInteger(p->pLimit->pLeft, &nLimit)
drh03c39052018-05-02 14:24:34 +00002898 && nLimit>0 && p->nSelectRow > sqlite3LogEst((u64)nLimit)
2899 ){
2900 p->nSelectRow = sqlite3LogEst((u64)nLimit);
2901 }
2902 if( addr ){
2903 sqlite3VdbeJumpHere(v, addr);
2904 }
2905 break;
drha9671a22008-07-08 23:40:20 +00002906 }
drh03c39052018-05-02 14:24:34 +00002907 case TK_EXCEPT:
2908 case TK_UNION: {
2909 int unionTab; /* Cursor number of the temp table holding result */
2910 u8 op = 0; /* One of the SRT_ operations to apply to self */
2911 int priorOp; /* The SRT_ operation to apply to prior selects */
2912 Expr *pLimit; /* Saved values of p->nLimit */
2913 int addr;
2914 SelectDest uniondest;
2915
2916 testcase( p->op==TK_EXCEPT );
2917 testcase( p->op==TK_UNION );
2918 priorOp = SRT_Union;
2919 if( dest.eDest==priorOp ){
2920 /* We can reuse a temporary table generated by a SELECT to our
2921 ** right.
2922 */
2923 assert( p->pLimit==0 ); /* Not allowed on leftward elements */
2924 unionTab = dest.iSDParm;
2925 }else{
2926 /* We will need to create our own temporary table to hold the
2927 ** intermediate results.
2928 */
2929 unionTab = pParse->nTab++;
2930 assert( p->pOrderBy==0 );
2931 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
2932 assert( p->addrOpenEphm[0] == -1 );
2933 p->addrOpenEphm[0] = addr;
2934 findRightmost(p)->selFlags |= SF_UsesEphemeral;
2935 assert( p->pEList );
2936 }
drh34055852020-10-19 01:23:48 +00002937
drh03c39052018-05-02 14:24:34 +00002938
2939 /* Code the SELECT statements to our left
drhd8bc7082000-06-07 23:51:50 +00002940 */
drh03c39052018-05-02 14:24:34 +00002941 assert( !pPrior->pOrderBy );
2942 sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
drh93ffb502021-05-18 19:10:10 +00002943 SELECTTRACE(1, pParse, p, ("multiSelect EXCEPT/UNION left...\n"));
drh03c39052018-05-02 14:24:34 +00002944 rc = sqlite3Select(pParse, pPrior, &uniondest);
2945 if( rc ){
2946 goto multi_select_end;
2947 }
2948
2949 /* Code the current SELECT statement
drhd8bc7082000-06-07 23:51:50 +00002950 */
drh03c39052018-05-02 14:24:34 +00002951 if( p->op==TK_EXCEPT ){
2952 op = SRT_Except;
2953 }else{
2954 assert( p->op==TK_UNION );
2955 op = SRT_Union;
2956 }
2957 p->pPrior = 0;
2958 pLimit = p->pLimit;
2959 p->pLimit = 0;
2960 uniondest.eDest = op;
2961 ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
drhaae0f742021-03-04 16:03:32 +00002962 sqlite3SelectOpName(p->op)));
drh93ffb502021-05-18 19:10:10 +00002963 SELECTTRACE(1, pParse, p, ("multiSelect EXCEPT/UNION right...\n"));
drh03c39052018-05-02 14:24:34 +00002964 rc = sqlite3Select(pParse, p, &uniondest);
2965 testcase( rc!=SQLITE_OK );
drhb7cbf5c2020-06-15 13:51:34 +00002966 assert( p->pOrderBy==0 );
drh03c39052018-05-02 14:24:34 +00002967 pDelete = p->pPrior;
2968 p->pPrior = pPrior;
2969 p->pOrderBy = 0;
2970 if( p->op==TK_UNION ){
2971 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
2972 }
2973 sqlite3ExprDelete(db, p->pLimit);
2974 p->pLimit = pLimit;
2975 p->iLimit = 0;
2976 p->iOffset = 0;
2977
2978 /* Convert the data in the temporary table into whatever form
2979 ** it is that we currently need.
2980 */
2981 assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
drha9ebfe22019-12-25 23:54:21 +00002982 assert( p->pEList || db->mallocFailed );
2983 if( dest.eDest!=priorOp && db->mallocFailed==0 ){
drh03c39052018-05-02 14:24:34 +00002984 int iCont, iBreak, iStart;
drhec4ccdb2018-12-29 02:26:59 +00002985 iBreak = sqlite3VdbeMakeLabel(pParse);
2986 iCont = sqlite3VdbeMakeLabel(pParse);
drh03c39052018-05-02 14:24:34 +00002987 computeLimitRegisters(pParse, p, iBreak);
2988 sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
2989 iStart = sqlite3VdbeCurrentAddr(v);
2990 selectInnerLoop(pParse, p, unionTab,
2991 0, 0, &dest, iCont, iBreak);
2992 sqlite3VdbeResolveLabel(v, iCont);
2993 sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
2994 sqlite3VdbeResolveLabel(v, iBreak);
2995 sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
2996 }
2997 break;
2998 }
2999 default: assert( p->op==TK_INTERSECT ); {
3000 int tab1, tab2;
3001 int iCont, iBreak, iStart;
3002 Expr *pLimit;
3003 int addr;
3004 SelectDest intersectdest;
3005 int r1;
3006
3007 /* INTERSECT is different from the others since it requires
3008 ** two temporary tables. Hence it has its own case. Begin
3009 ** by allocating the tables we will need.
3010 */
3011 tab1 = pParse->nTab++;
3012 tab2 = pParse->nTab++;
drh93a960a2008-07-10 00:32:42 +00003013 assert( p->pOrderBy==0 );
drh03c39052018-05-02 14:24:34 +00003014
3015 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
drh93a960a2008-07-10 00:32:42 +00003016 assert( p->addrOpenEphm[0] == -1 );
3017 p->addrOpenEphm[0] = addr;
drhd227a292014-02-09 18:02:09 +00003018 findRightmost(p)->selFlags |= SF_UsesEphemeral;
danielk197784ac9d02004-05-18 09:58:06 +00003019 assert( p->pEList );
drh03c39052018-05-02 14:24:34 +00003020
3021 /* Code the SELECTs to our left into temporary table "tab1".
3022 */
3023 sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
drh93ffb502021-05-18 19:10:10 +00003024 SELECTTRACE(1, pParse, p, ("multiSelect INTERSECT left...\n"));
drh03c39052018-05-02 14:24:34 +00003025 rc = sqlite3Select(pParse, pPrior, &intersectdest);
3026 if( rc ){
3027 goto multi_select_end;
3028 }
3029
3030 /* Code the current SELECT into temporary table "tab2"
3031 */
3032 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
3033 assert( p->addrOpenEphm[1] == -1 );
3034 p->addrOpenEphm[1] = addr;
3035 p->pPrior = 0;
3036 pLimit = p->pLimit;
3037 p->pLimit = 0;
3038 intersectdest.iSDParm = tab2;
3039 ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
drhaae0f742021-03-04 16:03:32 +00003040 sqlite3SelectOpName(p->op)));
drh93ffb502021-05-18 19:10:10 +00003041 SELECTTRACE(1, pParse, p, ("multiSelect INTERSECT right...\n"));
drh03c39052018-05-02 14:24:34 +00003042 rc = sqlite3Select(pParse, p, &intersectdest);
3043 testcase( rc!=SQLITE_OK );
3044 pDelete = p->pPrior;
3045 p->pPrior = pPrior;
3046 if( p->nSelectRow>pPrior->nSelectRow ){
3047 p->nSelectRow = pPrior->nSelectRow;
3048 }
3049 sqlite3ExprDelete(db, p->pLimit);
3050 p->pLimit = pLimit;
3051
3052 /* Generate code to take the intersection of the two temporary
3053 ** tables.
3054 */
drh5f695122020-02-20 14:08:51 +00003055 if( rc ) break;
drh82c3d632000-06-06 21:56:07 +00003056 assert( p->pEList );
drhec4ccdb2018-12-29 02:26:59 +00003057 iBreak = sqlite3VdbeMakeLabel(pParse);
3058 iCont = sqlite3VdbeMakeLabel(pParse);
drhec7429a2005-10-06 16:53:14 +00003059 computeLimitRegisters(pParse, p, iBreak);
drh03c39052018-05-02 14:24:34 +00003060 sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
3061 r1 = sqlite3GetTempReg(pParse);
3062 iStart = sqlite3VdbeAddOp2(v, OP_RowData, tab1, r1);
3063 sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0);
3064 VdbeCoverage(v);
3065 sqlite3ReleaseTempReg(pParse, r1);
3066 selectInnerLoop(pParse, p, tab1,
drhe8e4af72012-09-21 00:04:28 +00003067 0, 0, &dest, iCont, iBreak);
danielk19774adee202004-05-08 08:23:19 +00003068 sqlite3VdbeResolveLabel(v, iCont);
drh03c39052018-05-02 14:24:34 +00003069 sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
danielk19774adee202004-05-08 08:23:19 +00003070 sqlite3VdbeResolveLabel(v, iBreak);
drh03c39052018-05-02 14:24:34 +00003071 sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
3072 sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
3073 break;
drh82c3d632000-06-06 21:56:07 +00003074 }
drh82c3d632000-06-06 21:56:07 +00003075 }
drh03c39052018-05-02 14:24:34 +00003076
3077 #ifndef SQLITE_OMIT_EXPLAIN
3078 if( p->pNext==0 ){
3079 ExplainQueryPlanPop(pParse);
drh82c3d632000-06-06 21:56:07 +00003080 }
drh03c39052018-05-02 14:24:34 +00003081 #endif
drh82c3d632000-06-06 21:56:07 +00003082 }
drh8428b3b2019-12-19 22:08:19 +00003083 if( pParse->nErr ) goto multi_select_end;
drh03c39052018-05-02 14:24:34 +00003084
drha9671a22008-07-08 23:40:20 +00003085 /* Compute collating sequences used by
3086 ** temporary tables needed to implement the compound select.
3087 ** Attach the KeyInfo structure to all temporary tables.
drh8cdbf832004-08-29 16:25:03 +00003088 **
3089 ** This section is run by the right-most SELECT statement only.
3090 ** SELECT statements to the left always skip this part. The right-most
3091 ** SELECT might also skip this part if it has no ORDER BY clause and
3092 ** no temp tables are required.
drhfbc4ee72004-08-29 01:31:05 +00003093 */
drh7d10d5a2008-08-20 16:35:10 +00003094 if( p->selFlags & SF_UsesEphemeral ){
drhfbc4ee72004-08-29 01:31:05 +00003095 int i; /* Loop counter */
3096 KeyInfo *pKeyInfo; /* Collating sequence for the result set */
drh0342b1f2005-09-01 03:07:44 +00003097 Select *pLoop; /* For looping through SELECT statements */
drhf68d7d12007-05-03 13:02:26 +00003098 CollSeq **apColl; /* For looping through pKeyInfo->aColl[] */
drh93a960a2008-07-10 00:32:42 +00003099 int nCol; /* Number of columns in result set */
drhfbc4ee72004-08-29 01:31:05 +00003100
drhd227a292014-02-09 18:02:09 +00003101 assert( p->pNext==0 );
drhaa6fe5b2021-10-04 13:18:44 +00003102 assert( p->pEList!=0 );
drh93a960a2008-07-10 00:32:42 +00003103 nCol = p->pEList->nExpr;
drhad124322013-10-23 13:30:58 +00003104 pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
danielk1977dc1bdc42004-06-11 10:51:27 +00003105 if( !pKeyInfo ){
mistachkinfad30392016-02-13 23:43:46 +00003106 rc = SQLITE_NOMEM_BKPT;
danielk1977dc1bdc42004-06-11 10:51:27 +00003107 goto multi_select_end;
3108 }
drh0342b1f2005-09-01 03:07:44 +00003109 for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
3110 *apColl = multiSelectCollSeq(pParse, p, i);
3111 if( 0==*apColl ){
drh633e6d52008-07-28 19:34:53 +00003112 *apColl = db->pDfltColl;
danielk1977dc1bdc42004-06-11 10:51:27 +00003113 }
3114 }
3115
drh0342b1f2005-09-01 03:07:44 +00003116 for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
3117 for(i=0; i<2; i++){
drhb9bb7c12006-06-11 23:41:55 +00003118 int addr = pLoop->addrOpenEphm[i];
drh0342b1f2005-09-01 03:07:44 +00003119 if( addr<0 ){
3120 /* If [0] is unused then [1] is also unused. So we can
3121 ** always safely abort as soon as the first unused slot is found */
drhb9bb7c12006-06-11 23:41:55 +00003122 assert( pLoop->addrOpenEphm[1]<0 );
drh0342b1f2005-09-01 03:07:44 +00003123 break;
3124 }
3125 sqlite3VdbeChangeP2(v, addr, nCol);
drh2ec2fb22013-11-06 19:59:23 +00003126 sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
3127 P4_KEYINFO);
drh0ee5a1e2007-01-26 19:04:00 +00003128 pLoop->addrOpenEphm[i] = -1;
drh0342b1f2005-09-01 03:07:44 +00003129 }
danielk1977dc1bdc42004-06-11 10:51:27 +00003130 }
drh2ec2fb22013-11-06 19:59:23 +00003131 sqlite3KeyInfoUnref(pKeyInfo);
danielk197784ac9d02004-05-18 09:58:06 +00003132 }
danielk1977dc1bdc42004-06-11 10:51:27 +00003133
3134multi_select_end:
drh2b596da2012-07-23 21:43:19 +00003135 pDest->iSdst = dest.iSdst;
3136 pDest->nSdst = dest.nSdst;
drhce68b6b2021-08-21 16:42:58 +00003137 if( pDelete ){
3138 sqlite3ParserAddCleanup(pParse,
3139 (void(*)(sqlite3*,void*))sqlite3SelectDelete,
3140 pDelete);
3141 }
danielk197784ac9d02004-05-18 09:58:06 +00003142 return rc;
drh22827922000-06-06 17:27:05 +00003143}
drhb7f91642004-10-31 02:22:47 +00003144#endif /* SQLITE_OMIT_COMPOUND_SELECT */
drh22827922000-06-06 17:27:05 +00003145
drhb21e7c72008-06-22 12:37:57 +00003146/*
mistachkin89b31d72015-07-16 17:29:27 +00003147** Error message for when two or more terms of a compound select have different
3148** size result sets.
3149*/
3150void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p){
3151 if( p->selFlags & SF_Values ){
3152 sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
3153 }else{
3154 sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
drhaae0f742021-03-04 16:03:32 +00003155 " do not have the same number of result columns",
3156 sqlite3SelectOpName(p->op));
mistachkin89b31d72015-07-16 17:29:27 +00003157 }
3158}
3159
3160/*
drhb21e7c72008-06-22 12:37:57 +00003161** Code an output subroutine for a coroutine implementation of a
3162** SELECT statment.
drh0acb7e42008-06-25 00:12:41 +00003163**
drh2b596da2012-07-23 21:43:19 +00003164** The data to be output is contained in pIn->iSdst. There are
3165** pIn->nSdst columns to be output. pDest is where the output should
drh0acb7e42008-06-25 00:12:41 +00003166** be sent.
3167**
3168** regReturn is the number of the register holding the subroutine
3169** return address.
3170**
drhf053d5b2010-08-09 14:26:32 +00003171** If regPrev>0 then it is the first register in a vector that
drh0acb7e42008-06-25 00:12:41 +00003172** records the previous output. mem[regPrev] is a flag that is false
3173** if there has been no previous output. If regPrev>0 then code is
3174** generated to suppress duplicates. pKeyInfo is used for comparing
3175** keys.
3176**
3177** If the LIMIT found in p->iLimit is reached, jump immediately to
3178** iBreak.
drhb21e7c72008-06-22 12:37:57 +00003179*/
drh0acb7e42008-06-25 00:12:41 +00003180static int generateOutputSubroutine(
drh92b01d52008-06-24 00:32:35 +00003181 Parse *pParse, /* Parsing context */
3182 Select *p, /* The SELECT statement */
3183 SelectDest *pIn, /* Coroutine supplying data */
3184 SelectDest *pDest, /* Where to send the data */
3185 int regReturn, /* The return address register */
drh0acb7e42008-06-25 00:12:41 +00003186 int regPrev, /* Previous result register. No uniqueness if 0 */
3187 KeyInfo *pKeyInfo, /* For comparing with previous entry */
drh92b01d52008-06-24 00:32:35 +00003188 int iBreak /* Jump here if we hit the LIMIT */
drhb21e7c72008-06-22 12:37:57 +00003189){
3190 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003191 int iContinue;
3192 int addr;
drhb21e7c72008-06-22 12:37:57 +00003193
drh92b01d52008-06-24 00:32:35 +00003194 addr = sqlite3VdbeCurrentAddr(v);
drhec4ccdb2018-12-29 02:26:59 +00003195 iContinue = sqlite3VdbeMakeLabel(pParse);
drh0acb7e42008-06-25 00:12:41 +00003196
3197 /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
3198 */
3199 if( regPrev ){
drh728e0f92015-10-10 14:41:28 +00003200 int addr1, addr2;
3201 addr1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
3202 addr2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
drh2ec2fb22013-11-06 19:59:23 +00003203 (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
drh728e0f92015-10-10 14:41:28 +00003204 sqlite3VdbeAddOp3(v, OP_Jump, addr2+2, iContinue, addr2+2); VdbeCoverage(v);
3205 sqlite3VdbeJumpHere(v, addr1);
drhe8e4af72012-09-21 00:04:28 +00003206 sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
drhec86c722011-12-09 17:27:51 +00003207 sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
drh0acb7e42008-06-25 00:12:41 +00003208 }
danielk19771f9caa42008-07-02 16:10:45 +00003209 if( pParse->db->mallocFailed ) return 0;
drh0acb7e42008-06-25 00:12:41 +00003210
mistachkind5578432012-08-25 10:01:29 +00003211 /* Suppress the first OFFSET entries if there is an OFFSET clause
drh0acb7e42008-06-25 00:12:41 +00003212 */
drhaa9ce702014-01-22 18:07:04 +00003213 codeOffset(v, p->iOffset, iContinue);
drhb21e7c72008-06-22 12:37:57 +00003214
drhe2248cf2015-05-22 17:29:27 +00003215 assert( pDest->eDest!=SRT_Exists );
3216 assert( pDest->eDest!=SRT_Table );
drhb21e7c72008-06-22 12:37:57 +00003217 switch( pDest->eDest ){
3218 /* Store the result as data using a unique key.
3219 */
drhb21e7c72008-06-22 12:37:57 +00003220 case SRT_EphemTab: {
3221 int r1 = sqlite3GetTempReg(pParse);
3222 int r2 = sqlite3GetTempReg(pParse);
drh2b596da2012-07-23 21:43:19 +00003223 sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
3224 sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
3225 sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
drhb21e7c72008-06-22 12:37:57 +00003226 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
3227 sqlite3ReleaseTempReg(pParse, r2);
3228 sqlite3ReleaseTempReg(pParse, r1);
3229 break;
3230 }
3231
3232#ifndef SQLITE_OMIT_SUBQUERY
drh14318072016-09-06 18:51:25 +00003233 /* If we are creating a set for an "expr IN (SELECT ...)".
drhb21e7c72008-06-22 12:37:57 +00003234 */
3235 case SRT_Set: {
drh6fccc352008-06-27 00:52:45 +00003236 int r1;
drh63cecc42016-09-06 19:08:21 +00003237 testcase( pIn->nSdst>1 );
drhb21e7c72008-06-22 12:37:57 +00003238 r1 = sqlite3GetTempReg(pParse);
dan71c57db2016-07-09 20:23:55 +00003239 sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst,
drh14318072016-09-06 18:51:25 +00003240 r1, pDest->zAffSdst, pIn->nSdst);
drh9b4eaeb2016-11-09 00:10:33 +00003241 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pDest->iSDParm, r1,
3242 pIn->iSdst, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003243 sqlite3ReleaseTempReg(pParse, r1);
drhb21e7c72008-06-22 12:37:57 +00003244 break;
3245 }
3246
drhb21e7c72008-06-22 12:37:57 +00003247 /* If this is a scalar select that is part of an expression, then
3248 ** store the results in the appropriate memory cell and break out
drhcb99c572019-08-09 20:26:01 +00003249 ** of the scan loop. Note that the select might return multiple columns
3250 ** if it is the RHS of a row-value IN operator.
drhb21e7c72008-06-22 12:37:57 +00003251 */
3252 case SRT_Mem: {
drh5f0922b2021-03-04 16:32:28 +00003253 testcase( pIn->nSdst>1 );
3254 sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003255 /* The LIMIT clause will jump out of the loop for us */
3256 break;
3257 }
3258#endif /* #ifndef SQLITE_OMIT_SUBQUERY */
3259
drh7d10d5a2008-08-20 16:35:10 +00003260 /* The results are stored in a sequence of registers
drh2b596da2012-07-23 21:43:19 +00003261 ** starting at pDest->iSdst. Then the co-routine yields.
drhb21e7c72008-06-22 12:37:57 +00003262 */
drh92b01d52008-06-24 00:32:35 +00003263 case SRT_Coroutine: {
drh2b596da2012-07-23 21:43:19 +00003264 if( pDest->iSdst==0 ){
3265 pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
3266 pDest->nSdst = pIn->nSdst;
drhb21e7c72008-06-22 12:37:57 +00003267 }
dan4b79bde2015-04-21 15:49:04 +00003268 sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pIn->nSdst);
drh2b596da2012-07-23 21:43:19 +00003269 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drh92b01d52008-06-24 00:32:35 +00003270 break;
3271 }
3272
drhccfcbce2009-05-18 15:46:07 +00003273 /* If none of the above, then the result destination must be
3274 ** SRT_Output. This routine is never called with any other
3275 ** destination other than the ones handled above or SRT_Output.
3276 **
3277 ** For SRT_Output, results are stored in a sequence of registers.
3278 ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
3279 ** return the next row of result.
drh7d10d5a2008-08-20 16:35:10 +00003280 */
drhccfcbce2009-05-18 15:46:07 +00003281 default: {
3282 assert( pDest->eDest==SRT_Output );
drh2b596da2012-07-23 21:43:19 +00003283 sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003284 break;
3285 }
drhb21e7c72008-06-22 12:37:57 +00003286 }
drh92b01d52008-06-24 00:32:35 +00003287
3288 /* Jump to the end of the loop if the LIMIT is reached.
3289 */
3290 if( p->iLimit ){
drh16897072015-03-07 00:57:37 +00003291 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003292 }
3293
drh92b01d52008-06-24 00:32:35 +00003294 /* Generate the subroutine return
3295 */
drh0acb7e42008-06-25 00:12:41 +00003296 sqlite3VdbeResolveLabel(v, iContinue);
drh92b01d52008-06-24 00:32:35 +00003297 sqlite3VdbeAddOp1(v, OP_Return, regReturn);
3298
3299 return addr;
drhb21e7c72008-06-22 12:37:57 +00003300}
3301
3302/*
3303** Alternative compound select code generator for cases when there
3304** is an ORDER BY clause.
3305**
3306** We assume a query of the following form:
3307**
3308** <selectA> <operator> <selectB> ORDER BY <orderbylist>
3309**
3310** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT. The idea
3311** is to code both <selectA> and <selectB> with the ORDER BY clause as
3312** co-routines. Then run the co-routines in parallel and merge the results
3313** into the output. In addition to the two coroutines (called selectA and
3314** selectB) there are 7 subroutines:
3315**
3316** outA: Move the output of the selectA coroutine into the output
3317** of the compound query.
3318**
3319** outB: Move the output of the selectB coroutine into the output
3320** of the compound query. (Only generated for UNION and
3321** UNION ALL. EXCEPT and INSERTSECT never output a row that
3322** appears only in B.)
3323**
3324** AltB: Called when there is data from both coroutines and A<B.
3325**
3326** AeqB: Called when there is data from both coroutines and A==B.
3327**
3328** AgtB: Called when there is data from both coroutines and A>B.
3329**
3330** EofA: Called when data is exhausted from selectA.
3331**
3332** EofB: Called when data is exhausted from selectB.
3333**
3334** The implementation of the latter five subroutines depend on which
3335** <operator> is used:
3336**
3337**
3338** UNION ALL UNION EXCEPT INTERSECT
3339** ------------- ----------------- -------------- -----------------
drh0acb7e42008-06-25 00:12:41 +00003340** AltB: outA, nextA outA, nextA outA, nextA nextA
drhb21e7c72008-06-22 12:37:57 +00003341**
drh0acb7e42008-06-25 00:12:41 +00003342** AeqB: outA, nextA nextA nextA outA, nextA
drhb21e7c72008-06-22 12:37:57 +00003343**
drh0acb7e42008-06-25 00:12:41 +00003344** AgtB: outB, nextB outB, nextB nextB nextB
drhb21e7c72008-06-22 12:37:57 +00003345**
drh0acb7e42008-06-25 00:12:41 +00003346** EofA: outB, nextB outB, nextB halt halt
drhb21e7c72008-06-22 12:37:57 +00003347**
drh0acb7e42008-06-25 00:12:41 +00003348** EofB: outA, nextA outA, nextA outA, nextA halt
3349**
3350** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
3351** causes an immediate jump to EofA and an EOF on B following nextB causes
3352** an immediate jump to EofB. Within EofA and EofB, and EOF on entry or
3353** following nextX causes a jump to the end of the select processing.
3354**
3355** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
3356** within the output subroutine. The regPrev register set holds the previously
3357** output value. A comparison is made against this value and the output
3358** is skipped if the next results would be the same as the previous.
drhb21e7c72008-06-22 12:37:57 +00003359**
3360** The implementation plan is to implement the two coroutines and seven
3361** subroutines first, then put the control logic at the bottom. Like this:
3362**
3363** goto Init
3364** coA: coroutine for left query (A)
3365** coB: coroutine for right query (B)
3366** outA: output one row of A
3367** outB: output one row of B (UNION and UNION ALL only)
3368** EofA: ...
3369** EofB: ...
3370** AltB: ...
3371** AeqB: ...
3372** AgtB: ...
3373** Init: initialize coroutine registers
3374** yield coA
3375** if eof(A) goto EofA
3376** yield coB
3377** if eof(B) goto EofB
3378** Cmpr: Compare A, B
3379** Jump AltB, AeqB, AgtB
3380** End: ...
3381**
3382** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
3383** actually called using Gosub and they do not Return. EofA and EofB loop
3384** until all data is exhausted then jump to the "end" labe. AltB, AeqB,
3385** and AgtB jump to either L2 or to one of EofA or EofB.
3386*/
danielk1977de3e41e2008-08-04 03:51:24 +00003387#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhb21e7c72008-06-22 12:37:57 +00003388static int multiSelectOrderBy(
3389 Parse *pParse, /* Parsing context */
3390 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00003391 SelectDest *pDest /* What to do with query results */
drhb21e7c72008-06-22 12:37:57 +00003392){
drh0acb7e42008-06-25 00:12:41 +00003393 int i, j; /* Loop counters */
drhb21e7c72008-06-22 12:37:57 +00003394 Select *pPrior; /* Another SELECT immediately to our left */
drh38cebe02021-12-30 00:37:11 +00003395 Select *pSplit; /* Left-most SELECT in the right-hand group */
3396 int nSelect; /* Number of SELECT statements in the compound */
drhb21e7c72008-06-22 12:37:57 +00003397 Vdbe *v; /* Generate code to this VDBE */
drhb21e7c72008-06-22 12:37:57 +00003398 SelectDest destA; /* Destination for coroutine A */
3399 SelectDest destB; /* Destination for coroutine B */
drh92b01d52008-06-24 00:32:35 +00003400 int regAddrA; /* Address register for select-A coroutine */
drh92b01d52008-06-24 00:32:35 +00003401 int regAddrB; /* Address register for select-B coroutine */
drh92b01d52008-06-24 00:32:35 +00003402 int addrSelectA; /* Address of the select-A coroutine */
3403 int addrSelectB; /* Address of the select-B coroutine */
3404 int regOutA; /* Address register for the output-A subroutine */
3405 int regOutB; /* Address register for the output-B subroutine */
3406 int addrOutA; /* Address of the output-A subroutine */
drhb27b7f52008-12-10 18:03:45 +00003407 int addrOutB = 0; /* Address of the output-B subroutine */
drh92b01d52008-06-24 00:32:35 +00003408 int addrEofA; /* Address of the select-A-exhausted subroutine */
drh81cf13e2014-02-07 18:27:53 +00003409 int addrEofA_noB; /* Alternate addrEofA if B is uninitialized */
drh92b01d52008-06-24 00:32:35 +00003410 int addrEofB; /* Address of the select-B-exhausted subroutine */
3411 int addrAltB; /* Address of the A<B subroutine */
3412 int addrAeqB; /* Address of the A==B subroutine */
3413 int addrAgtB; /* Address of the A>B subroutine */
3414 int regLimitA; /* Limit register for select-A */
3415 int regLimitB; /* Limit register for select-A */
drh0acb7e42008-06-25 00:12:41 +00003416 int regPrev; /* A range of registers to hold previous output */
drh92b01d52008-06-24 00:32:35 +00003417 int savedLimit; /* Saved value of p->iLimit */
3418 int savedOffset; /* Saved value of p->iOffset */
3419 int labelCmpr; /* Label for the start of the merge algorithm */
3420 int labelEnd; /* Label for the end of the overall SELECT stmt */
drh728e0f92015-10-10 14:41:28 +00003421 int addr1; /* Jump instructions that get retargetted */
drh92b01d52008-06-24 00:32:35 +00003422 int op; /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
drh96067812008-09-23 09:36:10 +00003423 KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
drh0acb7e42008-06-25 00:12:41 +00003424 KeyInfo *pKeyMerge; /* Comparison information for merging rows */
3425 sqlite3 *db; /* Database connection */
3426 ExprList *pOrderBy; /* The ORDER BY clause */
3427 int nOrderBy; /* Number of terms in the ORDER BY clause */
drhabc38152020-07-22 13:38:04 +00003428 u32 *aPermute; /* Mapping from ORDER BY terms to result set columns */
drhb21e7c72008-06-22 12:37:57 +00003429
drh92b01d52008-06-24 00:32:35 +00003430 assert( p->pOrderBy!=0 );
drh96067812008-09-23 09:36:10 +00003431 assert( pKeyDup==0 ); /* "Managed" code needs this. Ticket #3382. */
drh0acb7e42008-06-25 00:12:41 +00003432 db = pParse->db;
drh92b01d52008-06-24 00:32:35 +00003433 v = pParse->pVdbe;
drhccfcbce2009-05-18 15:46:07 +00003434 assert( v!=0 ); /* Already thrown the error if VDBE alloc failed */
drhec4ccdb2018-12-29 02:26:59 +00003435 labelEnd = sqlite3VdbeMakeLabel(pParse);
3436 labelCmpr = sqlite3VdbeMakeLabel(pParse);
drh0acb7e42008-06-25 00:12:41 +00003437
drh92b01d52008-06-24 00:32:35 +00003438
3439 /* Patch up the ORDER BY clause
3440 */
3441 op = p->op;
drh38cebe02021-12-30 00:37:11 +00003442 assert( p->pPrior->pOrderBy==0 );
drh0acb7e42008-06-25 00:12:41 +00003443 pOrderBy = p->pOrderBy;
drh93a960a2008-07-10 00:32:42 +00003444 assert( pOrderBy );
drh93a960a2008-07-10 00:32:42 +00003445 nOrderBy = pOrderBy->nExpr;
3446
drh0acb7e42008-06-25 00:12:41 +00003447 /* For operators other than UNION ALL we have to make sure that
3448 ** the ORDER BY clause covers every term of the result set. Add
3449 ** terms to the ORDER BY clause as necessary.
3450 */
3451 if( op!=TK_ALL ){
3452 for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
drh7d10d5a2008-08-20 16:35:10 +00003453 struct ExprList_item *pItem;
3454 for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
drh7d4c94b2021-10-04 22:34:38 +00003455 assert( pItem!=0 );
drhc2acc4e2013-11-15 18:15:19 +00003456 assert( pItem->u.x.iOrderByCol>0 );
3457 if( pItem->u.x.iOrderByCol==i ) break;
drh0acb7e42008-06-25 00:12:41 +00003458 }
3459 if( j==nOrderBy ){
drhb7916a72009-05-27 10:31:29 +00003460 Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
mistachkinfad30392016-02-13 23:43:46 +00003461 if( pNew==0 ) return SQLITE_NOMEM_BKPT;
drh0acb7e42008-06-25 00:12:41 +00003462 pNew->flags |= EP_IntValue;
drh33e619f2009-05-28 01:00:55 +00003463 pNew->u.iValue = i;
drh43606172017-04-05 11:32:13 +00003464 p->pOrderBy = pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
drhc2acc4e2013-11-15 18:15:19 +00003465 if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
drh0acb7e42008-06-25 00:12:41 +00003466 }
3467 }
3468 }
3469
3470 /* Compute the comparison permutation and keyinfo that is used with
drh10c081a2009-04-16 00:24:23 +00003471 ** the permutation used to determine if the next
drh0acb7e42008-06-25 00:12:41 +00003472 ** row of results comes from selectA or selectB. Also add explicit
3473 ** collations to the ORDER BY clause terms so that when the subqueries
3474 ** to the right and the left are evaluated, they use the correct
3475 ** collation.
3476 */
drhabc38152020-07-22 13:38:04 +00003477 aPermute = sqlite3DbMallocRawNN(db, sizeof(u32)*(nOrderBy + 1));
drh0acb7e42008-06-25 00:12:41 +00003478 if( aPermute ){
drh7d10d5a2008-08-20 16:35:10 +00003479 struct ExprList_item *pItem;
drhb1702022016-01-30 00:45:18 +00003480 aPermute[0] = nOrderBy;
3481 for(i=1, pItem=pOrderBy->a; i<=nOrderBy; i++, pItem++){
drh7d4c94b2021-10-04 22:34:38 +00003482 assert( pItem!=0 );
drh67366182015-04-16 14:33:35 +00003483 assert( pItem->u.x.iOrderByCol>0 );
drh2ec18a32015-06-23 23:31:52 +00003484 assert( pItem->u.x.iOrderByCol<=p->pEList->nExpr );
drhc2acc4e2013-11-15 18:15:19 +00003485 aPermute[i] = pItem->u.x.iOrderByCol - 1;
drh0acb7e42008-06-25 00:12:41 +00003486 }
dan53bed452014-01-24 20:37:18 +00003487 pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
drh0acb7e42008-06-25 00:12:41 +00003488 }else{
3489 pKeyMerge = 0;
3490 }
3491
drh0acb7e42008-06-25 00:12:41 +00003492 /* Allocate a range of temporary registers and the KeyInfo needed
3493 ** for the logic that removes duplicate result rows when the
3494 ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
3495 */
3496 if( op==TK_ALL ){
3497 regPrev = 0;
3498 }else{
3499 int nExpr = p->pEList->nExpr;
drh1c0dc822008-10-30 22:13:23 +00003500 assert( nOrderBy>=nExpr || db->mallocFailed );
drhc8ac0d12013-02-16 02:41:01 +00003501 regPrev = pParse->nMem+1;
3502 pParse->nMem += nExpr+1;
drh0acb7e42008-06-25 00:12:41 +00003503 sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
drhad124322013-10-23 13:30:58 +00003504 pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
drh0acb7e42008-06-25 00:12:41 +00003505 if( pKeyDup ){
drh2ec2fb22013-11-06 19:59:23 +00003506 assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
drh0acb7e42008-06-25 00:12:41 +00003507 for(i=0; i<nExpr; i++){
3508 pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
dan6e118922019-08-12 16:36:38 +00003509 pKeyDup->aSortFlags[i] = 0;
drh0acb7e42008-06-25 00:12:41 +00003510 }
3511 }
3512 }
drh92b01d52008-06-24 00:32:35 +00003513
3514 /* Separate the left and the right query from one another
3515 */
drh38cebe02021-12-30 00:37:11 +00003516 nSelect = 1;
3517 if( (op==TK_ALL || op==TK_UNION)
3518 && OptimizationEnabled(db, SQLITE_BalancedMerge)
3519 ){
3520 for(pSplit=p; pSplit->pPrior!=0 && pSplit->op==op; pSplit=pSplit->pPrior){
3521 nSelect++;
3522 assert( pSplit->pPrior->pNext==pSplit );
3523 }
3524 }
3525 if( nSelect<=3 ){
3526 pSplit = p;
3527 }else{
3528 pSplit = p;
3529 for(i=2; i<nSelect; i+=2){ pSplit = pSplit->pPrior; }
3530 }
3531 pPrior = pSplit->pPrior;
drh98bb34c2022-01-20 12:58:15 +00003532 assert( pPrior!=0 );
drh38cebe02021-12-30 00:37:11 +00003533 pSplit->pPrior = 0;
drhd227a292014-02-09 18:02:09 +00003534 pPrior->pNext = 0;
drh38cebe02021-12-30 00:37:11 +00003535 assert( p->pOrderBy == pOrderBy );
3536 assert( pOrderBy!=0 || db->mallocFailed );
3537 pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
drh9aff8242021-12-30 17:46:15 +00003538 sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
3539 sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
drh0acb7e42008-06-25 00:12:41 +00003540
drh92b01d52008-06-24 00:32:35 +00003541 /* Compute the limit registers */
3542 computeLimitRegisters(pParse, p, labelEnd);
drh0acb7e42008-06-25 00:12:41 +00003543 if( p->iLimit && op==TK_ALL ){
drh92b01d52008-06-24 00:32:35 +00003544 regLimitA = ++pParse->nMem;
3545 regLimitB = ++pParse->nMem;
3546 sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
3547 regLimitA);
3548 sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
3549 }else{
3550 regLimitA = regLimitB = 0;
3551 }
drh633e6d52008-07-28 19:34:53 +00003552 sqlite3ExprDelete(db, p->pLimit);
drh0acb7e42008-06-25 00:12:41 +00003553 p->pLimit = 0;
drh92b01d52008-06-24 00:32:35 +00003554
drhb21e7c72008-06-22 12:37:57 +00003555 regAddrA = ++pParse->nMem;
drhb21e7c72008-06-22 12:37:57 +00003556 regAddrB = ++pParse->nMem;
drhb21e7c72008-06-22 12:37:57 +00003557 regOutA = ++pParse->nMem;
3558 regOutB = ++pParse->nMem;
3559 sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
3560 sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
drhe2ca99c2018-05-02 00:33:43 +00003561
drhaae0f742021-03-04 16:03:32 +00003562 ExplainQueryPlan((pParse, 1, "MERGE (%s)", sqlite3SelectOpName(p->op)));
drhb21e7c72008-06-22 12:37:57 +00003563
drh92b01d52008-06-24 00:32:35 +00003564 /* Generate a coroutine to evaluate the SELECT statement to the
drh0acb7e42008-06-25 00:12:41 +00003565 ** left of the compound operator - the "A" select.
3566 */
drhed71a832014-02-07 19:18:10 +00003567 addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
drh728e0f92015-10-10 14:41:28 +00003568 addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
drhed71a832014-02-07 19:18:10 +00003569 VdbeComment((v, "left SELECT"));
drh92b01d52008-06-24 00:32:35 +00003570 pPrior->iLimit = regLimitA;
drhc631ded2018-05-02 02:22:22 +00003571 ExplainQueryPlan((pParse, 1, "LEFT"));
drh7d10d5a2008-08-20 16:35:10 +00003572 sqlite3Select(pParse, pPrior, &destA);
drh2fade2f2016-02-09 02:12:20 +00003573 sqlite3VdbeEndCoroutine(v, regAddrA);
drh728e0f92015-10-10 14:41:28 +00003574 sqlite3VdbeJumpHere(v, addr1);
drhb21e7c72008-06-22 12:37:57 +00003575
drh92b01d52008-06-24 00:32:35 +00003576 /* Generate a coroutine to evaluate the SELECT statement on
3577 ** the right - the "B" select
3578 */
drhed71a832014-02-07 19:18:10 +00003579 addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
drh728e0f92015-10-10 14:41:28 +00003580 addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
drhed71a832014-02-07 19:18:10 +00003581 VdbeComment((v, "right SELECT"));
drh92b01d52008-06-24 00:32:35 +00003582 savedLimit = p->iLimit;
3583 savedOffset = p->iOffset;
3584 p->iLimit = regLimitB;
3585 p->iOffset = 0;
drhc631ded2018-05-02 02:22:22 +00003586 ExplainQueryPlan((pParse, 1, "RIGHT"));
drh7d10d5a2008-08-20 16:35:10 +00003587 sqlite3Select(pParse, p, &destB);
drh92b01d52008-06-24 00:32:35 +00003588 p->iLimit = savedLimit;
3589 p->iOffset = savedOffset;
drh2fade2f2016-02-09 02:12:20 +00003590 sqlite3VdbeEndCoroutine(v, regAddrB);
drhb21e7c72008-06-22 12:37:57 +00003591
drh92b01d52008-06-24 00:32:35 +00003592 /* Generate a subroutine that outputs the current row of the A
drh0acb7e42008-06-25 00:12:41 +00003593 ** select as the next output row of the compound select.
drh92b01d52008-06-24 00:32:35 +00003594 */
drhb21e7c72008-06-22 12:37:57 +00003595 VdbeNoopComment((v, "Output routine for A"));
drh0acb7e42008-06-25 00:12:41 +00003596 addrOutA = generateOutputSubroutine(pParse,
3597 p, &destA, pDest, regOutA,
drh2ec2fb22013-11-06 19:59:23 +00003598 regPrev, pKeyDup, labelEnd);
drhb21e7c72008-06-22 12:37:57 +00003599
drh92b01d52008-06-24 00:32:35 +00003600 /* Generate a subroutine that outputs the current row of the B
drh0acb7e42008-06-25 00:12:41 +00003601 ** select as the next output row of the compound select.
drh92b01d52008-06-24 00:32:35 +00003602 */
drh0acb7e42008-06-25 00:12:41 +00003603 if( op==TK_ALL || op==TK_UNION ){
3604 VdbeNoopComment((v, "Output routine for B"));
3605 addrOutB = generateOutputSubroutine(pParse,
3606 p, &destB, pDest, regOutB,
drh2ec2fb22013-11-06 19:59:23 +00003607 regPrev, pKeyDup, labelEnd);
drh0acb7e42008-06-25 00:12:41 +00003608 }
drh2ec2fb22013-11-06 19:59:23 +00003609 sqlite3KeyInfoUnref(pKeyDup);
drhb21e7c72008-06-22 12:37:57 +00003610
drh92b01d52008-06-24 00:32:35 +00003611 /* Generate a subroutine to run when the results from select A
3612 ** are exhausted and only data in select B remains.
3613 */
drhb21e7c72008-06-22 12:37:57 +00003614 if( op==TK_EXCEPT || op==TK_INTERSECT ){
drh81cf13e2014-02-07 18:27:53 +00003615 addrEofA_noB = addrEofA = labelEnd;
drhb21e7c72008-06-22 12:37:57 +00003616 }else{
drh81cf13e2014-02-07 18:27:53 +00003617 VdbeNoopComment((v, "eof-A subroutine"));
3618 addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3619 addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
drh688852a2014-02-17 22:40:43 +00003620 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003621 sqlite3VdbeGoto(v, addrEofA);
drhc3489bb2016-02-25 16:04:59 +00003622 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
drhb21e7c72008-06-22 12:37:57 +00003623 }
3624
drh92b01d52008-06-24 00:32:35 +00003625 /* Generate a subroutine to run when the results from select B
3626 ** are exhausted and only data in select A remains.
3627 */
drhb21e7c72008-06-22 12:37:57 +00003628 if( op==TK_INTERSECT ){
drh92b01d52008-06-24 00:32:35 +00003629 addrEofB = addrEofA;
drh95aa47b2010-11-16 02:49:15 +00003630 if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
drhb21e7c72008-06-22 12:37:57 +00003631 }else{
drh92b01d52008-06-24 00:32:35 +00003632 VdbeNoopComment((v, "eof-B subroutine"));
drh81cf13e2014-02-07 18:27:53 +00003633 addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
drh688852a2014-02-17 22:40:43 +00003634 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003635 sqlite3VdbeGoto(v, addrEofB);
drhb21e7c72008-06-22 12:37:57 +00003636 }
3637
drh92b01d52008-06-24 00:32:35 +00003638 /* Generate code to handle the case of A<B
3639 */
drhb21e7c72008-06-22 12:37:57 +00003640 VdbeNoopComment((v, "A-lt-B subroutine"));
drh0acb7e42008-06-25 00:12:41 +00003641 addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
drh688852a2014-02-17 22:40:43 +00003642 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003643 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003644
drh92b01d52008-06-24 00:32:35 +00003645 /* Generate code to handle the case of A==B
3646 */
drhb21e7c72008-06-22 12:37:57 +00003647 if( op==TK_ALL ){
3648 addrAeqB = addrAltB;
drh0acb7e42008-06-25 00:12:41 +00003649 }else if( op==TK_INTERSECT ){
3650 addrAeqB = addrAltB;
3651 addrAltB++;
drh92b01d52008-06-24 00:32:35 +00003652 }else{
drhb21e7c72008-06-22 12:37:57 +00003653 VdbeNoopComment((v, "A-eq-B subroutine"));
drh0acb7e42008-06-25 00:12:41 +00003654 addrAeqB =
drh688852a2014-02-17 22:40:43 +00003655 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003656 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003657 }
3658
drh92b01d52008-06-24 00:32:35 +00003659 /* Generate code to handle the case of A>B
3660 */
drhb21e7c72008-06-22 12:37:57 +00003661 VdbeNoopComment((v, "A-gt-B subroutine"));
3662 addrAgtB = sqlite3VdbeCurrentAddr(v);
3663 if( op==TK_ALL || op==TK_UNION ){
3664 sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3665 }
drh688852a2014-02-17 22:40:43 +00003666 sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003667 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003668
drh92b01d52008-06-24 00:32:35 +00003669 /* This code runs once to initialize everything.
3670 */
drh728e0f92015-10-10 14:41:28 +00003671 sqlite3VdbeJumpHere(v, addr1);
drh688852a2014-02-17 22:40:43 +00003672 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
3673 sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003674
3675 /* Implement the main merge loop
3676 */
3677 sqlite3VdbeResolveLabel(v, labelCmpr);
drh0acb7e42008-06-25 00:12:41 +00003678 sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
drh2b596da2012-07-23 21:43:19 +00003679 sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
drh2ec2fb22013-11-06 19:59:23 +00003680 (char*)pKeyMerge, P4_KEYINFO);
drh953f7612012-12-07 22:18:54 +00003681 sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
drh688852a2014-02-17 22:40:43 +00003682 sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003683
3684 /* Jump to the this point in order to terminate the query.
3685 */
drhb21e7c72008-06-22 12:37:57 +00003686 sqlite3VdbeResolveLabel(v, labelEnd);
drh92b01d52008-06-24 00:32:35 +00003687
drh0acb7e42008-06-25 00:12:41 +00003688 /* Reassembly the compound query so that it will be freed correctly
3689 ** by the calling function */
drh38cebe02021-12-30 00:37:11 +00003690 if( pSplit->pPrior ){
3691 sqlite3SelectDelete(db, pSplit->pPrior);
danielk19775e7ad502008-07-01 17:39:27 +00003692 }
drh38cebe02021-12-30 00:37:11 +00003693 pSplit->pPrior = pPrior;
3694 pPrior->pNext = pSplit;
dancd0b2452021-04-12 12:02:49 +00003695 sqlite3ExprListDelete(db, pPrior->pOrderBy);
3696 pPrior->pOrderBy = 0;
3697
drh92b01d52008-06-24 00:32:35 +00003698 /*** TBD: Insert subroutine calls to close cursors on incomplete
3699 **** subqueries ****/
drhe2ca99c2018-05-02 00:33:43 +00003700 ExplainQueryPlanPop(pParse);
drh3dc4cc62015-04-15 07:10:25 +00003701 return pParse->nErr!=0;
drhb21e7c72008-06-22 12:37:57 +00003702}
danielk1977de3e41e2008-08-04 03:51:24 +00003703#endif
drhb21e7c72008-06-22 12:37:57 +00003704
shane3514b6f2008-07-22 05:00:55 +00003705#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh46967de2017-04-14 12:39:37 +00003706
3707/* An instance of the SubstContext object describes an substitution edit
3708** to be performed on a parse tree.
3709**
3710** All references to columns in table iTable are to be replaced by corresponding
3711** expressions in pEList.
drhc133bab2022-04-11 20:15:52 +00003712**
3713** ## About "isOuterJoin":
3714**
3715** The isOuterJoin column indicates that the replacement will occur into a
3716** position in the parent that NULL-able due to an OUTER JOIN. Either the
3717** target slot in the parent is the right operand of a LEFT JOIN, or one of
3718** the left operands of a RIGHT JOIN. In either case, we need to potentially
3719** bypass the substituted expression with OP_IfNullRow.
3720**
3721** Suppose the original expression integer constant. Even though the table
3722** has the nullRow flag set, because the expression is an integer constant,
3723** it will not be NULLed out. So instead, we insert an OP_IfNullRow opcode
3724** that checks to see if the nullRow flag is set on the table. If the nullRow
3725** flag is set, then the value in the register is set to NULL and the original
3726** expression is bypassed. If the nullRow flag is not set, then the original
3727** expression runs to populate the register.
3728**
3729** Example where this is needed:
3730**
3731** CREATE TABLE t1(a INTEGER PRIMARY KEY, b INT);
3732** CREATE TABLE t2(x INT UNIQUE);
3733**
3734** SELECT a,b,m,x FROM t1 LEFT JOIN (SELECT 59 AS m,x FROM t2) ON b=x;
3735**
3736** When the subquery on the right side of the LEFT JOIN is flattened, we
3737** have to add OP_IfNullRow in front of the OP_Integer that implements the
3738** "m" value of the subquery so that a NULL will be loaded instead of 59
3739** when processing a non-matched row of the left.
drh46967de2017-04-14 12:39:37 +00003740*/
3741typedef struct SubstContext {
3742 Parse *pParse; /* The parsing context */
3743 int iTable; /* Replace references to this table */
drh31d6fd52017-04-14 19:03:10 +00003744 int iNewTable; /* New table number */
drhc133bab2022-04-11 20:15:52 +00003745 int isOuterJoin; /* Add TK_IF_NULL_ROW opcodes on each replacement */
drh46967de2017-04-14 12:39:37 +00003746 ExprList *pEList; /* Replacement expressions */
3747} SubstContext;
3748
drh17435752007-08-16 04:30:38 +00003749/* Forward Declarations */
drh46967de2017-04-14 12:39:37 +00003750static void substExprList(SubstContext*, ExprList*);
3751static void substSelect(SubstContext*, Select*, int);
drh17435752007-08-16 04:30:38 +00003752
drh22827922000-06-06 17:27:05 +00003753/*
drh832508b2002-03-02 17:04:07 +00003754** Scan through the expression pExpr. Replace every reference to
drh6a3ea0e2003-05-02 14:32:12 +00003755** a column in table number iTable with a copy of the iColumn-th
drh84e59202002-03-14 14:33:31 +00003756** entry in pEList. (But leave references to the ROWID column
drh6a3ea0e2003-05-02 14:32:12 +00003757** unchanged.)
drh832508b2002-03-02 17:04:07 +00003758**
3759** This routine is part of the flattening procedure. A subquery
3760** whose result set is defined by pEList appears as entry in the
3761** FROM clause of a SELECT such that the VDBE cursor assigned to that
drhaca19e12017-04-07 19:41:31 +00003762** FORM clause entry is iTable. This routine makes the necessary
drh832508b2002-03-02 17:04:07 +00003763** changes to pExpr so that it refers directly to the source table
3764** of the subquery rather the result set of the subquery.
3765*/
drhb7916a72009-05-27 10:31:29 +00003766static Expr *substExpr(
drh46967de2017-04-14 12:39:37 +00003767 SubstContext *pSubst, /* Description of the substitution */
3768 Expr *pExpr /* Expr in which substitution occurs */
drh17435752007-08-16 04:30:38 +00003769){
drhb7916a72009-05-27 10:31:29 +00003770 if( pExpr==0 ) return 0;
drh33b2cb92022-06-07 13:09:58 +00003771 if( ExprHasProperty(pExpr, EP_OuterON|EP_InnerON)
drhd1985262022-04-11 11:25:28 +00003772 && pExpr->w.iJoin==pSubst->iTable
drh3d240d22017-09-28 16:56:55 +00003773 ){
drh33b2cb92022-06-07 13:09:58 +00003774 testcase( ExprHasProperty(pExpr, EP_InnerON) );
drhd1985262022-04-11 11:25:28 +00003775 pExpr->w.iJoin = pSubst->iNewTable;
drh399c7e22017-04-14 17:18:45 +00003776 }
drh2e52a9c2020-04-04 00:15:54 +00003777 if( pExpr->op==TK_COLUMN
3778 && pExpr->iTable==pSubst->iTable
3779 && !ExprHasProperty(pExpr, EP_FixedCol)
3780 ){
drh6e5020e2021-04-07 15:45:01 +00003781#ifdef SQLITE_ALLOW_ROWID_IN_VIEW
drh50350a12004-02-13 16:22:22 +00003782 if( pExpr->iColumn<0 ){
3783 pExpr->op = TK_NULL;
drh6e5020e2021-04-07 15:45:01 +00003784 }else
3785#endif
3786 {
drh50350a12004-02-13 16:22:22 +00003787 Expr *pNew;
drh46967de2017-04-14 12:39:37 +00003788 Expr *pCopy = pSubst->pEList->a[pExpr->iColumn].pExpr;
drh31d6fd52017-04-14 19:03:10 +00003789 Expr ifNullRow;
drh46967de2017-04-14 12:39:37 +00003790 assert( pSubst->pEList!=0 && pExpr->iColumn<pSubst->pEList->nExpr );
drh1fd4e7b2018-07-28 14:56:56 +00003791 assert( pExpr->pRight==0 );
dan44c56042016-12-07 15:38:37 +00003792 if( sqlite3ExprIsVector(pCopy) ){
drh46967de2017-04-14 12:39:37 +00003793 sqlite3VectorErrorMsg(pSubst->pParse, pCopy);
dan44c56042016-12-07 15:38:37 +00003794 }else{
drh46967de2017-04-14 12:39:37 +00003795 sqlite3 *db = pSubst->pParse->db;
drhc133bab2022-04-11 20:15:52 +00003796 if( pSubst->isOuterJoin && pCopy->op!=TK_COLUMN ){
drh31d6fd52017-04-14 19:03:10 +00003797 memset(&ifNullRow, 0, sizeof(ifNullRow));
3798 ifNullRow.op = TK_IF_NULL_ROW;
3799 ifNullRow.pLeft = pCopy;
3800 ifNullRow.iTable = pSubst->iNewTable;
drh46fe1382020-08-19 23:32:06 +00003801 ifNullRow.flags = EP_IfNullRow;
drh31d6fd52017-04-14 19:03:10 +00003802 pCopy = &ifNullRow;
3803 }
drh11df7d22018-12-06 19:15:36 +00003804 testcase( ExprHasProperty(pCopy, EP_Subquery) );
dan44c56042016-12-07 15:38:37 +00003805 pNew = sqlite3ExprDup(db, pCopy, 0);
drh8c6cb1b2021-04-19 20:36:13 +00003806 if( db->mallocFailed ){
3807 sqlite3ExprDelete(db, pNew);
3808 return pExpr;
3809 }
drhc133bab2022-04-11 20:15:52 +00003810 if( pSubst->isOuterJoin ){
danbd11a2a2017-06-20 17:43:26 +00003811 ExprSetProperty(pNew, EP_CanBeNull);
3812 }
drh67a99db2022-05-13 14:52:04 +00003813 if( ExprHasProperty(pExpr,EP_OuterON|EP_InnerON) ){
drh3a6e4c52022-04-11 12:38:06 +00003814 sqlite3SetJoinExpr(pNew, pExpr->w.iJoin,
drh67a99db2022-05-13 14:52:04 +00003815 pExpr->flags & (EP_OuterON|EP_InnerON));
dan44c56042016-12-07 15:38:37 +00003816 }
3817 sqlite3ExprDelete(db, pExpr);
3818 pExpr = pNew;
dan410fac32022-06-02 16:26:21 +00003819 if( pExpr->op==TK_TRUEFALSE ){
3820 pExpr->u.iValue = sqlite3ExprTruthValue(pExpr);
3821 pExpr->op = TK_INTEGER;
3822 ExprSetProperty(pExpr, EP_IntValue);
3823 }
dane0866392019-09-09 19:49:42 +00003824
danfa508342019-09-10 15:33:52 +00003825 /* Ensure that the expression now has an implicit collation sequence,
3826 ** just as it did when it was a column of a view or sub-query. */
drh60b95332021-04-19 15:05:27 +00003827 if( pExpr->op!=TK_COLUMN && pExpr->op!=TK_COLLATE ){
3828 CollSeq *pColl = sqlite3ExprCollSeq(pSubst->pParse, pExpr);
3829 pExpr = sqlite3ExprAddCollateString(pSubst->pParse, pExpr,
3830 (pColl ? pColl->zName : "BINARY")
3831 );
dane0866392019-09-09 19:49:42 +00003832 }
drh60b95332021-04-19 15:05:27 +00003833 ExprClearProperty(pExpr, EP_Collate);
dan92ddb3b2016-12-01 19:38:05 +00003834 }
drh50350a12004-02-13 16:22:22 +00003835 }
drh832508b2002-03-02 17:04:07 +00003836 }else{
drh7c1544e2017-05-23 12:44:57 +00003837 if( pExpr->op==TK_IF_NULL_ROW && pExpr->iTable==pSubst->iTable ){
3838 pExpr->iTable = pSubst->iNewTable;
3839 }
drh46967de2017-04-14 12:39:37 +00003840 pExpr->pLeft = substExpr(pSubst, pExpr->pLeft);
3841 pExpr->pRight = substExpr(pSubst, pExpr->pRight);
drha4eeccd2021-10-07 17:43:30 +00003842 if( ExprUseXSelect(pExpr) ){
drh46967de2017-04-14 12:39:37 +00003843 substSelect(pSubst, pExpr->x.pSelect, 1);
danielk19776ab3a2e2009-02-19 14:39:25 +00003844 }else{
drh46967de2017-04-14 12:39:37 +00003845 substExprList(pSubst, pExpr->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +00003846 }
dan3703edf2019-10-10 15:17:09 +00003847#ifndef SQLITE_OMIT_WINDOWFUNC
3848 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3849 Window *pWin = pExpr->y.pWin;
3850 pWin->pFilter = substExpr(pSubst, pWin->pFilter);
3851 substExprList(pSubst, pWin->pPartition);
3852 substExprList(pSubst, pWin->pOrderBy);
3853 }
3854#endif
drh832508b2002-03-02 17:04:07 +00003855 }
drhb7916a72009-05-27 10:31:29 +00003856 return pExpr;
drh832508b2002-03-02 17:04:07 +00003857}
drh17435752007-08-16 04:30:38 +00003858static void substExprList(
drh46967de2017-04-14 12:39:37 +00003859 SubstContext *pSubst, /* Description of the substitution */
3860 ExprList *pList /* List to scan and in which to make substitutes */
drh17435752007-08-16 04:30:38 +00003861){
drh832508b2002-03-02 17:04:07 +00003862 int i;
3863 if( pList==0 ) return;
3864 for(i=0; i<pList->nExpr; i++){
drh46967de2017-04-14 12:39:37 +00003865 pList->a[i].pExpr = substExpr(pSubst, pList->a[i].pExpr);
drh832508b2002-03-02 17:04:07 +00003866 }
3867}
drh17435752007-08-16 04:30:38 +00003868static void substSelect(
drh46967de2017-04-14 12:39:37 +00003869 SubstContext *pSubst, /* Description of the substitution */
3870 Select *p, /* SELECT statement in which to make substitutions */
3871 int doPrior /* Do substitutes on p->pPrior too */
drh17435752007-08-16 04:30:38 +00003872){
drh588a9a12008-09-01 15:52:10 +00003873 SrcList *pSrc;
drh76012942021-02-21 21:04:54 +00003874 SrcItem *pItem;
drh588a9a12008-09-01 15:52:10 +00003875 int i;
danielk1977b3bce662005-01-29 08:32:43 +00003876 if( !p ) return;
drhd12b6362015-10-11 19:46:59 +00003877 do{
drh46967de2017-04-14 12:39:37 +00003878 substExprList(pSubst, p->pEList);
3879 substExprList(pSubst, p->pGroupBy);
3880 substExprList(pSubst, p->pOrderBy);
3881 p->pHaving = substExpr(pSubst, p->pHaving);
3882 p->pWhere = substExpr(pSubst, p->pWhere);
drhd12b6362015-10-11 19:46:59 +00003883 pSrc = p->pSrc;
drh29064902015-10-11 20:08:31 +00003884 assert( pSrc!=0 );
drh588a9a12008-09-01 15:52:10 +00003885 for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
drh46967de2017-04-14 12:39:37 +00003886 substSelect(pSubst, pItem->pSelect, 1);
drh29064902015-10-11 20:08:31 +00003887 if( pItem->fg.isTabFunc ){
drh46967de2017-04-14 12:39:37 +00003888 substExprList(pSubst, pItem->u1.pFuncArg);
drhd12b6362015-10-11 19:46:59 +00003889 }
drh588a9a12008-09-01 15:52:10 +00003890 }
drhd12b6362015-10-11 19:46:59 +00003891 }while( doPrior && (p = p->pPrior)!=0 );
danielk1977b3bce662005-01-29 08:32:43 +00003892}
shane3514b6f2008-07-22 05:00:55 +00003893#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
drh832508b2002-03-02 17:04:07 +00003894
shane3514b6f2008-07-22 05:00:55 +00003895#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh832508b2002-03-02 17:04:07 +00003896/*
drh2aee5142020-03-21 00:05:53 +00003897** pSelect is a SELECT statement and pSrcItem is one item in the FROM
3898** clause of that SELECT.
3899**
3900** This routine scans the entire SELECT statement and recomputes the
3901** pSrcItem->colUsed mask.
3902*/
3903static int recomputeColumnsUsedExpr(Walker *pWalker, Expr *pExpr){
drh76012942021-02-21 21:04:54 +00003904 SrcItem *pItem;
drh2aee5142020-03-21 00:05:53 +00003905 if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
3906 pItem = pWalker->u.pSrcItem;
3907 if( pItem->iCursor!=pExpr->iTable ) return WRC_Continue;
drh74a07982020-03-21 23:10:38 +00003908 if( pExpr->iColumn<0 ) return WRC_Continue;
3909 pItem->colUsed |= sqlite3ExprColUsed(pExpr);
drh2aee5142020-03-21 00:05:53 +00003910 return WRC_Continue;
3911}
3912static void recomputeColumnsUsed(
3913 Select *pSelect, /* The complete SELECT statement */
drh76012942021-02-21 21:04:54 +00003914 SrcItem *pSrcItem /* Which FROM clause item to recompute */
drh2aee5142020-03-21 00:05:53 +00003915){
3916 Walker w;
3917 if( NEVER(pSrcItem->pTab==0) ) return;
3918 memset(&w, 0, sizeof(w));
3919 w.xExprCallback = recomputeColumnsUsedExpr;
3920 w.xSelectCallback = sqlite3SelectWalkNoop;
3921 w.u.pSrcItem = pSrcItem;
3922 pSrcItem->colUsed = 0;
3923 sqlite3WalkSelect(&w, pSelect);
3924}
3925#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3926
3927#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3928/*
dan964fa262020-12-18 16:13:39 +00003929** Assign new cursor numbers to each of the items in pSrc. For each
3930** new cursor number assigned, set an entry in the aCsrMap[] array
3931** to map the old cursor number to the new:
3932**
drhc8d21472021-07-21 15:42:05 +00003933** aCsrMap[iOld+1] = iNew;
dan964fa262020-12-18 16:13:39 +00003934**
3935** The array is guaranteed by the caller to be large enough for all
drhc8d21472021-07-21 15:42:05 +00003936** existing cursor numbers in pSrc. aCsrMap[0] is the array size.
dan964fa262020-12-18 16:13:39 +00003937**
3938** If pSrc contains any sub-selects, call this routine recursively
3939** on the FROM clause of each such sub-select, with iExcept set to -1.
3940*/
3941static void srclistRenumberCursors(
3942 Parse *pParse, /* Parse context */
3943 int *aCsrMap, /* Array to store cursor mappings in */
3944 SrcList *pSrc, /* FROM clause to renumber */
3945 int iExcept /* FROM clause item to skip */
3946){
3947 int i;
drh76012942021-02-21 21:04:54 +00003948 SrcItem *pItem;
dan964fa262020-12-18 16:13:39 +00003949 for(i=0, pItem=pSrc->a; i<pSrc->nSrc; i++, pItem++){
3950 if( i!=iExcept ){
dand131b512020-12-18 18:04:44 +00003951 Select *p;
drhc8d21472021-07-21 15:42:05 +00003952 assert( pItem->iCursor < aCsrMap[0] );
3953 if( !pItem->fg.isRecursive || aCsrMap[pItem->iCursor+1]==0 ){
3954 aCsrMap[pItem->iCursor+1] = pParse->nTab++;
drhc7f50772021-04-26 21:23:01 +00003955 }
drhc8d21472021-07-21 15:42:05 +00003956 pItem->iCursor = aCsrMap[pItem->iCursor+1];
dand131b512020-12-18 18:04:44 +00003957 for(p=pItem->pSelect; p; p=p->pPrior){
3958 srclistRenumberCursors(pParse, aCsrMap, p->pSrc, -1);
dan964fa262020-12-18 16:13:39 +00003959 }
3960 }
3961 }
3962}
3963
3964/*
drhc8d21472021-07-21 15:42:05 +00003965** *piCursor is a cursor number. Change it if it needs to be mapped.
3966*/
3967static void renumberCursorDoMapping(Walker *pWalker, int *piCursor){
3968 int *aCsrMap = pWalker->u.aiCol;
3969 int iCsr = *piCursor;
3970 if( iCsr < aCsrMap[0] && aCsrMap[iCsr+1]>0 ){
3971 *piCursor = aCsrMap[iCsr+1];
3972 }
3973}
3974
3975/*
dan964fa262020-12-18 16:13:39 +00003976** Expression walker callback used by renumberCursors() to update
3977** Expr objects to match newly assigned cursor numbers.
3978*/
3979static int renumberCursorsCb(Walker *pWalker, Expr *pExpr){
dane8f14902021-02-13 14:26:25 +00003980 int op = pExpr->op;
drhc8d21472021-07-21 15:42:05 +00003981 if( op==TK_COLUMN || op==TK_IF_NULL_ROW ){
3982 renumberCursorDoMapping(pWalker, &pExpr->iTable);
dan964fa262020-12-18 16:13:39 +00003983 }
drh67a99db2022-05-13 14:52:04 +00003984 if( ExprHasProperty(pExpr, EP_OuterON) ){
drhd1985262022-04-11 11:25:28 +00003985 renumberCursorDoMapping(pWalker, &pExpr->w.iJoin);
dan961a7262020-12-21 19:50:10 +00003986 }
dan964fa262020-12-18 16:13:39 +00003987 return WRC_Continue;
3988}
3989
3990/*
3991** Assign a new cursor number to each cursor in the FROM clause (Select.pSrc)
3992** of the SELECT statement passed as the second argument, and to each
3993** cursor in the FROM clause of any FROM clause sub-selects, recursively.
3994** Except, do not assign a new cursor number to the iExcept'th element in
3995** the FROM clause of (*p). Update all expressions and other references
3996** to refer to the new cursor numbers.
3997**
3998** Argument aCsrMap is an array that may be used for temporary working
3999** space. Two guarantees are made by the caller:
4000**
4001** * the array is larger than the largest cursor number used within the
4002** select statement passed as an argument, and
4003**
4004** * the array entries for all cursor numbers that do *not* appear in
4005** FROM clauses of the select statement as described above are
4006** initialized to zero.
4007*/
4008static void renumberCursors(
4009 Parse *pParse, /* Parse context */
4010 Select *p, /* Select to renumber cursors within */
4011 int iExcept, /* FROM clause item to skip */
4012 int *aCsrMap /* Working space */
4013){
4014 Walker w;
4015 srclistRenumberCursors(pParse, aCsrMap, p->pSrc, iExcept);
4016 memset(&w, 0, sizeof(w));
4017 w.u.aiCol = aCsrMap;
4018 w.xExprCallback = renumberCursorsCb;
4019 w.xSelectCallback = sqlite3SelectWalkNoop;
4020 sqlite3WalkSelect(&w, p);
4021}
4022#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4023
4024#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4025/*
drh630d2962011-12-11 21:51:04 +00004026** This routine attempts to flatten subqueries as a performance optimization.
4027** This routine returns 1 if it makes changes and 0 if no flattening occurs.
drh1350b032002-02-27 19:00:20 +00004028**
4029** To understand the concept of flattening, consider the following
4030** query:
4031**
4032** SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
4033**
4034** The default way of implementing this query is to execute the
4035** subquery first and store the results in a temporary table, then
4036** run the outer query on that temporary table. This requires two
4037** passes over the data. Furthermore, because the temporary table
4038** has no indices, the WHERE clause on the outer query cannot be
drh832508b2002-03-02 17:04:07 +00004039** optimized.
drh1350b032002-02-27 19:00:20 +00004040**
drh832508b2002-03-02 17:04:07 +00004041** This routine attempts to rewrite queries such as the above into
drh1350b032002-02-27 19:00:20 +00004042** a single flat select, like this:
4043**
4044** SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
4045**
peter.d.reid60ec9142014-09-06 16:39:46 +00004046** The code generated for this simplification gives the same result
drh832508b2002-03-02 17:04:07 +00004047** but only has to scan the data once. And because indices might
4048** exist on the table t1, a complete scan of the data might be
4049** avoided.
drh1350b032002-02-27 19:00:20 +00004050**
drhd981e822017-09-29 16:07:56 +00004051** Flattening is subject to the following constraints:
drh1350b032002-02-27 19:00:20 +00004052**
drh25c221e2017-09-29 22:13:24 +00004053** (**) We no longer attempt to flatten aggregate subqueries. Was:
4054** The subquery and the outer query cannot both be aggregates.
drh1350b032002-02-27 19:00:20 +00004055**
drh25c221e2017-09-29 22:13:24 +00004056** (**) We no longer attempt to flatten aggregate subqueries. Was:
4057** (2) If the subquery is an aggregate then
drhd981e822017-09-29 16:07:56 +00004058** (2a) the outer query must not be a join and
4059** (2b) the outer query must not use subqueries
4060** other than the one FROM-clause subquery that is a candidate
4061** for flattening. (This is due to ticket [2f7170d73bf9abf80]
4062** from 2015-02-09.)
drh832508b2002-03-02 17:04:07 +00004063**
drhd981e822017-09-29 16:07:56 +00004064** (3) If the subquery is the right operand of a LEFT JOIN then
4065** (3a) the subquery may not be a join and
4066** (3b) the FROM clause of the subquery may not contain a virtual
4067** table and
drhee373022022-07-25 15:54:23 +00004068** (**) Was: "The outer query may not have a GROUP BY." This case
4069** is now managed correctly
drh396afe62019-12-18 20:51:58 +00004070** (3d) the outer query may not be DISTINCT.
drh41798d52022-04-11 00:21:53 +00004071** See also (26) for restrictions on RIGHT JOIN.
drh832508b2002-03-02 17:04:07 +00004072**
drhd981e822017-09-29 16:07:56 +00004073** (4) The subquery can not be DISTINCT.
drh832508b2002-03-02 17:04:07 +00004074**
dan49ad3302010-08-13 16:38:48 +00004075** (**) At one point restrictions (4) and (5) defined a subset of DISTINCT
4076** sub-queries that were excluded from this optimization. Restriction
4077** (4) has since been expanded to exclude all DISTINCT subqueries.
drh832508b2002-03-02 17:04:07 +00004078**
drh25c221e2017-09-29 22:13:24 +00004079** (**) We no longer attempt to flatten aggregate subqueries. Was:
4080** If the subquery is aggregate, the outer query may not be DISTINCT.
drh832508b2002-03-02 17:04:07 +00004081**
drhd981e822017-09-29 16:07:56 +00004082** (7) The subquery must have a FROM clause. TODO: For subqueries without
drh31d6fd52017-04-14 19:03:10 +00004083** A FROM clause, consider adding a FROM clause with the special
drh630d2962011-12-11 21:51:04 +00004084** table sqlite_once that consists of a single row containing a
4085** single NULL.
drh08192d52002-04-30 19:20:28 +00004086**
drhd981e822017-09-29 16:07:56 +00004087** (8) If the subquery uses LIMIT then the outer query may not be a join.
drhdf199a22002-06-14 22:38:41 +00004088**
drhd981e822017-09-29 16:07:56 +00004089** (9) If the subquery uses LIMIT then the outer query may not be aggregate.
drhdf199a22002-06-14 22:38:41 +00004090**
drh6092d2b2014-09-15 11:14:50 +00004091** (**) Restriction (10) was removed from the code on 2005-02-05 but we
4092** accidently carried the comment forward until 2014-09-15. Original
drhd981e822017-09-29 16:07:56 +00004093** constraint: "If the subquery is aggregate then the outer query
4094** may not use LIMIT."
drhdf199a22002-06-14 22:38:41 +00004095**
drhd981e822017-09-29 16:07:56 +00004096** (11) The subquery and the outer query may not both have ORDER BY clauses.
drh174b6192002-12-03 02:22:52 +00004097**
drh7b688ed2009-12-22 00:29:53 +00004098** (**) Not implemented. Subsumed into restriction (3). Was previously
drh2b300d52008-08-14 00:19:48 +00004099** a separate restriction deriving from ticket #350.
drh3fc673e2003-06-16 00:40:34 +00004100**
drhd981e822017-09-29 16:07:56 +00004101** (13) The subquery and outer query may not both use LIMIT.
drhac839632006-01-21 22:19:54 +00004102**
drhd981e822017-09-29 16:07:56 +00004103** (14) The subquery may not use OFFSET.
drhac839632006-01-21 22:19:54 +00004104**
drhd981e822017-09-29 16:07:56 +00004105** (15) If the outer query is part of a compound select, then the
4106** subquery may not use LIMIT.
drhf3913272010-04-15 23:24:29 +00004107** (See ticket #2339 and ticket [02a8e81d44]).
drhad91c6c2007-05-06 20:04:24 +00004108**
drhd981e822017-09-29 16:07:56 +00004109** (16) If the outer query is aggregate, then the subquery may not
4110** use ORDER BY. (Ticket #2942) This used to not matter
drhc52e3552008-02-15 14:33:03 +00004111** until we introduced the group_concat() function.
4112**
drhd981e822017-09-29 16:07:56 +00004113** (17) If the subquery is a compound select, then
4114** (17a) all compound operators must be a UNION ALL, and
4115** (17b) no terms within the subquery compound may be aggregate
drhe76acc62017-10-04 02:30:45 +00004116** or DISTINCT, and
drhd981e822017-09-29 16:07:56 +00004117** (17c) every term within the subquery compound must have a FROM clause
4118** (17d) the outer query may not be
4119** (17d1) aggregate, or
dan8daf5ae2020-12-17 16:48:04 +00004120** (17d2) DISTINCT
4121** (17e) the subquery may not contain window functions, and
4122** (17f) the subquery must not be the RHS of a LEFT JOIN.
drhb88bf862022-07-13 15:52:15 +00004123** (17g) either the subquery is the first element of the outer
4124** query or there are no RIGHT or FULL JOINs in any arm
4125** of the subquery. (This is a duplicate of condition (27b).)
danielk1977f23329a2008-07-01 14:09:13 +00004126**
danielk19774914cf92008-07-01 18:26:49 +00004127** The parent and sub-query may contain WHERE clauses. Subject to
4128** rules (11), (13) and (14), they may also contain ORDER BY,
drh630d2962011-12-11 21:51:04 +00004129** LIMIT and OFFSET clauses. The subquery cannot use any compound
4130** operator other than UNION ALL because all the other compound
4131** operators have an implied DISTINCT which is disallowed by
4132** restriction (4).
danielk1977f23329a2008-07-01 14:09:13 +00004133**
dan67c70142012-08-28 14:45:50 +00004134** Also, each component of the sub-query must return the same number
4135** of result columns. This is actually a requirement for any compound
4136** SELECT statement, but all the code here does is make sure that no
4137** such (illegal) sub-query is flattened. The caller will detect the
4138** syntax error and return a detailed message.
4139**
danielk197749fc1f62008-07-08 17:43:56 +00004140** (18) If the sub-query is a compound select, then all terms of the
dan9353bea2020-12-17 17:17:12 +00004141** ORDER BY clause of the parent must be copies of a term returned
4142** by the parent query.
danielk197749fc1f62008-07-08 17:43:56 +00004143**
drhd981e822017-09-29 16:07:56 +00004144** (19) If the subquery uses LIMIT then the outer query may not
drh229cf702008-08-26 12:56:14 +00004145** have a WHERE clause.
4146**
drhfca23552017-10-28 20:51:54 +00004147** (20) If the sub-query is a compound select, then it must not use
4148** an ORDER BY clause. Ticket #3773. We could relax this constraint
4149** somewhat by saying that the terms of the ORDER BY clause must
4150** appear as unmodified result columns in the outer query. But we
4151** have other optimizations in mind to deal with that case.
drhe8902a72009-04-02 16:59:47 +00004152**
drhd981e822017-09-29 16:07:56 +00004153** (21) If the subquery uses LIMIT then the outer query may not be
shaneha91491e2011-02-11 20:52:20 +00004154** DISTINCT. (See ticket [752e1646fc]).
4155**
drhd981e822017-09-29 16:07:56 +00004156** (22) The subquery may not be a recursive CTE.
dan8290c2a2014-01-16 10:58:39 +00004157**
dan8daf5ae2020-12-17 16:48:04 +00004158** (23) If the outer query is a recursive CTE, then the sub-query may not be
4159** a compound query. This restriction is because transforming the
dan8290c2a2014-01-16 10:58:39 +00004160** parent to a compound query confuses the code that handles
4161** recursive queries in multiSelect().
4162**
drh508e2d02017-09-30 01:25:04 +00004163** (**) We no longer attempt to flatten aggregate subqueries. Was:
4164** The subquery may not be an aggregate that uses the built-in min() or
drh9588ad92014-09-15 14:46:02 +00004165** or max() functions. (Without this restriction, a query like:
4166** "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
4167** return the value X for which Y was maximal.)
4168**
dan9a947222018-06-14 19:06:36 +00004169** (25) If either the subquery or the parent query contains a window
4170** function in the select list or ORDER BY clause, flattening
4171** is not attempted.
4172**
drh41798d52022-04-11 00:21:53 +00004173** (26) The subquery may not be the right operand of a RIGHT JOIN.
4174** See also (3) for restrictions on LEFT JOIN.
4175**
drh1c2bf412022-04-18 23:20:02 +00004176** (27) The subquery may not contain a FULL or RIGHT JOIN unless it
drhb88bf862022-07-13 15:52:15 +00004177** is the first element of the parent query. This must be the
4178** the case if:
4179** (27a) the subquery is not compound query, and
4180** (27b) the subquery is a compound query and the RIGHT JOIN occurs
4181** in any arm of the compound query. (See also (17g).)
drh1c2bf412022-04-18 23:20:02 +00004182**
drh67f70be2022-04-22 16:15:48 +00004183** (28) The subquery is not a MATERIALIZED CTE.
4184**
drh5c118e32022-06-08 15:30:39 +00004185** (29) Either the subquery is not the right-hand operand of a join with an
4186** ON or USING clause nor the right-hand operand of a NATURAL JOIN, or
4187** the right-most table within the FROM clause of the subquery
4188** is not part of an outer join.
4189**
dan8290c2a2014-01-16 10:58:39 +00004190**
drh832508b2002-03-02 17:04:07 +00004191** In this routine, the "p" parameter is a pointer to the outer query.
4192** The subquery is p->pSrc->a[iFrom]. isAgg is true if the outer query
drh25c221e2017-09-29 22:13:24 +00004193** uses aggregates.
drh832508b2002-03-02 17:04:07 +00004194**
drh665de472003-03-31 13:36:09 +00004195** If flattening is not attempted, this routine is a no-op and returns 0.
drh832508b2002-03-02 17:04:07 +00004196** If flattening is attempted this routine returns 1.
4197**
4198** All of the expression analysis must occur on both the outer query and
4199** the subquery before this routine runs.
drh1350b032002-02-27 19:00:20 +00004200*/
drh8c74a8c2002-08-25 19:20:40 +00004201static int flattenSubquery(
danielk1977524cc212008-07-02 13:13:51 +00004202 Parse *pParse, /* Parsing context */
drh8c74a8c2002-08-25 19:20:40 +00004203 Select *p, /* The parent or outer SELECT statement */
4204 int iFrom, /* Index in p->pSrc->a[] of the inner subquery */
drh25c221e2017-09-29 22:13:24 +00004205 int isAgg /* True if outer SELECT uses aggregate functions */
drh8c74a8c2002-08-25 19:20:40 +00004206){
danielk1977524cc212008-07-02 13:13:51 +00004207 const char *zSavedAuthContext = pParse->zAuthContext;
drhd12b6362015-10-11 19:46:59 +00004208 Select *pParent; /* Current UNION ALL term of the other query */
drh0bb28102002-05-08 11:54:14 +00004209 Select *pSub; /* The inner query or "subquery" */
danielk1977f23329a2008-07-01 14:09:13 +00004210 Select *pSub1; /* Pointer to the rightmost select in sub-query */
drhad3cab52002-05-24 02:04:32 +00004211 SrcList *pSrc; /* The FROM clause of the outer query */
4212 SrcList *pSubSrc; /* The FROM clause of the subquery */
drh6a3ea0e2003-05-02 14:32:12 +00004213 int iParent; /* VDBE cursor number of the pSub result set temp table */
drh399c7e22017-04-14 17:18:45 +00004214 int iNewParent = -1;/* Replacement table for iParent */
drhc133bab2022-04-11 20:15:52 +00004215 int isOuterJoin = 0; /* True if pSub is the right side of a LEFT JOIN */
drh91bb0ee2004-09-01 03:06:34 +00004216 int i; /* Loop counter */
4217 Expr *pWhere; /* The WHERE clause */
drh76012942021-02-21 21:04:54 +00004218 SrcItem *pSubitem; /* The subquery */
danielk1977524cc212008-07-02 13:13:51 +00004219 sqlite3 *db = pParse->db;
drh89636622020-06-07 17:33:18 +00004220 Walker w; /* Walker to persist agginfo data */
dan964fa262020-12-18 16:13:39 +00004221 int *aCsrMap = 0;
drh1350b032002-02-27 19:00:20 +00004222
drh832508b2002-03-02 17:04:07 +00004223 /* Check to see if flattening is permitted. Return 0 if not.
4224 */
drha78c22c2008-11-11 18:28:58 +00004225 assert( p!=0 );
drhd981e822017-09-29 16:07:56 +00004226 assert( p->pPrior==0 );
drh7e5418e2012-09-27 15:05:54 +00004227 if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
drh832508b2002-03-02 17:04:07 +00004228 pSrc = p->pSrc;
drhad3cab52002-05-24 02:04:32 +00004229 assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
drh91bb0ee2004-09-01 03:06:34 +00004230 pSubitem = &pSrc->a[iFrom];
danielk197749fc1f62008-07-08 17:43:56 +00004231 iParent = pSubitem->iCursor;
drh91bb0ee2004-09-01 03:06:34 +00004232 pSub = pSubitem->pSelect;
drh832508b2002-03-02 17:04:07 +00004233 assert( pSub!=0 );
drh399c7e22017-04-14 17:18:45 +00004234
dan67a9b8e2018-06-22 20:51:35 +00004235#ifndef SQLITE_OMIT_WINDOWFUNC
dan9a947222018-06-14 19:06:36 +00004236 if( p->pWin || pSub->pWin ) return 0; /* Restriction (25) */
dan67a9b8e2018-06-22 20:51:35 +00004237#endif
dan86fb6e12018-05-16 20:58:07 +00004238
drh832508b2002-03-02 17:04:07 +00004239 pSubSrc = pSub->pSrc;
4240 assert( pSubSrc );
drhac839632006-01-21 22:19:54 +00004241 /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
peter.d.reid60ec9142014-09-06 16:39:46 +00004242 ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
drhac839632006-01-21 22:19:54 +00004243 ** because they could be computed at compile-time. But when LIMIT and OFFSET
4244 ** became arbitrary expressions, we were forced to add restrictions (13)
4245 ** and (14). */
4246 if( pSub->pLimit && p->pLimit ) return 0; /* Restriction (13) */
drh8c0833f2017-11-14 23:48:23 +00004247 if( pSub->pLimit && pSub->pLimit->pRight ) return 0; /* Restriction (14) */
drhd227a292014-02-09 18:02:09 +00004248 if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
drhad91c6c2007-05-06 20:04:24 +00004249 return 0; /* Restriction (15) */
4250 }
drhac839632006-01-21 22:19:54 +00004251 if( pSubSrc->nSrc==0 ) return 0; /* Restriction (7) */
drhd981e822017-09-29 16:07:56 +00004252 if( pSub->selFlags & SF_Distinct ) return 0; /* Restriction (4) */
dan49ad3302010-08-13 16:38:48 +00004253 if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
4254 return 0; /* Restrictions (8)(9) */
drhdf199a22002-06-14 22:38:41 +00004255 }
drh7d10d5a2008-08-20 16:35:10 +00004256 if( p->pOrderBy && pSub->pOrderBy ){
drhac839632006-01-21 22:19:54 +00004257 return 0; /* Restriction (11) */
4258 }
drhc52e3552008-02-15 14:33:03 +00004259 if( isAgg && pSub->pOrderBy ) return 0; /* Restriction (16) */
drh229cf702008-08-26 12:56:14 +00004260 if( pSub->pLimit && p->pWhere ) return 0; /* Restriction (19) */
shaneha91491e2011-02-11 20:52:20 +00004261 if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
4262 return 0; /* Restriction (21) */
4263 }
drh508e2d02017-09-30 01:25:04 +00004264 if( pSub->selFlags & (SF_Recursive) ){
4265 return 0; /* Restrictions (22) */
drh9588ad92014-09-15 14:46:02 +00004266 }
drh832508b2002-03-02 17:04:07 +00004267
drh399c7e22017-04-14 17:18:45 +00004268 /*
4269 ** If the subquery is the right operand of a LEFT JOIN, then the
drhd981e822017-09-29 16:07:56 +00004270 ** subquery may not be a join itself (3a). Example of why this is not
4271 ** allowed:
drh8af4d3a2003-05-06 20:35:16 +00004272 **
4273 ** t1 LEFT OUTER JOIN (t2 JOIN t3)
4274 **
4275 ** If we flatten the above, we would get
4276 **
4277 ** (t1 LEFT OUTER JOIN t2) JOIN t3
4278 **
4279 ** which is not at all the same thing.
drh2b300d52008-08-14 00:19:48 +00004280 **
drh31d6fd52017-04-14 19:03:10 +00004281 ** See also tickets #306, #350, and #3300.
drh3fc673e2003-06-16 00:40:34 +00004282 */
drhc133bab2022-04-11 20:15:52 +00004283 if( (pSubitem->fg.jointype & (JT_OUTER|JT_LTORJ))!=0 ){
drh41798d52022-04-11 00:21:53 +00004284 if( pSubSrc->nSrc>1 /* (3a) */
drh9efc6182022-06-23 12:36:56 +00004285 || IsVirtual(pSubSrc->a[0].pTab) /* (3b) */
drh41798d52022-04-11 00:21:53 +00004286 || (p->selFlags & SF_Distinct)!=0 /* (3d) */
4287 || (pSubitem->fg.jointype & JT_RIGHT)!=0 /* (26) */
drh396afe62019-12-18 20:51:58 +00004288 ){
drhd981e822017-09-29 16:07:56 +00004289 return 0;
drh399c7e22017-04-14 17:18:45 +00004290 }
drhc133bab2022-04-11 20:15:52 +00004291 isOuterJoin = 1;
drh3fc673e2003-06-16 00:40:34 +00004292 }
drhdc6de472017-05-25 11:39:50 +00004293#ifdef SQLITE_EXTRA_IFNULLROW
4294 else if( iFrom>0 && !isAgg ){
drhc133bab2022-04-11 20:15:52 +00004295 /* Setting isOuterJoin to -1 causes OP_IfNullRow opcodes to be generated for
drh3d240d22017-09-28 16:56:55 +00004296 ** every reference to any result column from subquery in a join, even
4297 ** though they are not necessary. This will stress-test the OP_IfNullRow
4298 ** opcode. */
drhc133bab2022-04-11 20:15:52 +00004299 isOuterJoin = -1;
drhdc6de472017-05-25 11:39:50 +00004300 }
4301#endif
drh3fc673e2003-06-16 00:40:34 +00004302
drh1c2bf412022-04-18 23:20:02 +00004303 assert( pSubSrc->nSrc>0 ); /* True by restriction (7) */
4304 if( iFrom>0 && (pSubSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
drhb88bf862022-07-13 15:52:15 +00004305 return 0; /* Restriction (27a) */
drh1c2bf412022-04-18 23:20:02 +00004306 }
drh67f70be2022-04-22 16:15:48 +00004307 if( pSubitem->fg.isCte && pSubitem->u2.pCteUse->eM10d==M10d_Yes ){
4308 return 0; /* (28) */
4309 }
drh1c2bf412022-04-18 23:20:02 +00004310
drh8a5469b2022-06-08 17:48:14 +00004311 /* Restriction (29):
4312 **
4313 ** We do not want two constraints on the same term of the flattened
4314 ** query where one constraint has EP_InnerON and the other is EP_OuterON.
4315 ** To prevent this, one or the other of the following conditions must be
4316 ** false:
4317 **
4318 ** (29a) The right-most entry in the FROM clause of the subquery
4319 ** must not be part of an outer join.
4320 **
4321 ** (29b) The subquery itself must not be the right operand of a
4322 ** NATURAL join or a join that as an ON or USING clause.
4323 **
4324 ** These conditions are sufficient to keep an EP_OuterON from being
drhb88bf862022-07-13 15:52:15 +00004325 ** flattened into an EP_InnerON. Restrictions (3a) and (27a) prevent
drh8a5469b2022-06-08 17:48:14 +00004326 ** an EP_InnerON from being flattened into an EP_OuterON.
4327 */
drh5c118e32022-06-08 15:30:39 +00004328 if( pSubSrc->nSrc>=2
4329 && (pSubSrc->a[pSubSrc->nSrc-1].fg.jointype & JT_OUTER)!=0
4330 ){
drh8a5469b2022-06-08 17:48:14 +00004331 if( (pSubitem->fg.jointype & JT_NATURAL)!=0
drh5c118e32022-06-08 15:30:39 +00004332 || pSubitem->fg.isUsing
drh8a5469b2022-06-08 17:48:14 +00004333 || NEVER(pSubitem->u3.pOn!=0) /* ON clause already shifted into WHERE */
drh5c118e32022-06-08 15:30:39 +00004334 || pSubitem->fg.isOn
4335 ){
4336 return 0;
4337 }
4338 }
4339
drhd981e822017-09-29 16:07:56 +00004340 /* Restriction (17): If the sub-query is a compound SELECT, then it must
danielk1977f23329a2008-07-01 14:09:13 +00004341 ** use only the UNION ALL operator. And none of the simple select queries
4342 ** that make up the compound SELECT are allowed to be aggregate or distinct
4343 ** queries.
4344 */
4345 if( pSub->pPrior ){
drhfca23552017-10-28 20:51:54 +00004346 if( pSub->pOrderBy ){
4347 return 0; /* Restriction (20) */
4348 }
drhc133bab2022-04-11 20:15:52 +00004349 if( isAgg || (p->selFlags & SF_Distinct)!=0 || isOuterJoin>0 ){
dan8daf5ae2020-12-17 16:48:04 +00004350 return 0; /* (17d1), (17d2), or (17f) */
danielk1977f23329a2008-07-01 14:09:13 +00004351 }
4352 for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
drhccfcbce2009-05-18 15:46:07 +00004353 testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
4354 testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
drh4b3ac732011-12-10 23:18:32 +00004355 assert( pSub->pSrc!=0 );
dan8daf5ae2020-12-17 16:48:04 +00004356 assert( (pSub->selFlags & SF_Recursive)==0 );
drh2ec18a32015-06-23 23:31:52 +00004357 assert( pSub->pEList->nExpr==pSub1->pEList->nExpr );
drhd981e822017-09-29 16:07:56 +00004358 if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0 /* (17b) */
4359 || (pSub1->pPrior && pSub1->op!=TK_ALL) /* (17a) */
4360 || pSub1->pSrc->nSrc<1 /* (17c) */
drhef9f7192020-01-17 19:14:08 +00004361#ifndef SQLITE_OMIT_WINDOWFUNC
drh8d95ed72019-12-30 20:42:17 +00004362 || pSub1->pWin /* (17e) */
drhef9f7192020-01-17 19:14:08 +00004363#endif
danielk197780b3c542008-07-10 17:59:12 +00004364 ){
danielk1977f23329a2008-07-01 14:09:13 +00004365 return 0;
4366 }
drhb88bf862022-07-13 15:52:15 +00004367 if( iFrom>0 && (pSub1->pSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
4368 /* Without this restriction, the JT_LTORJ flag would end up being
4369 ** omitted on left-hand tables of the right join that is being
4370 ** flattened. */
4371 return 0; /* Restrictions (17g), (27b) */
4372 }
drh4b3ac732011-12-10 23:18:32 +00004373 testcase( pSub1->pSrc->nSrc>1 );
danielk1977f23329a2008-07-01 14:09:13 +00004374 }
danielk197749fc1f62008-07-08 17:43:56 +00004375
drhd981e822017-09-29 16:07:56 +00004376 /* Restriction (18). */
danielk197749fc1f62008-07-08 17:43:56 +00004377 if( p->pOrderBy ){
4378 int ii;
4379 for(ii=0; ii<p->pOrderBy->nExpr; ii++){
drhc2acc4e2013-11-15 18:15:19 +00004380 if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
danielk197749fc1f62008-07-08 17:43:56 +00004381 }
4382 }
danielk1977f23329a2008-07-01 14:09:13 +00004383
dande9ed622020-12-16 20:00:46 +00004384 /* Restriction (23) */
4385 if( (p->selFlags & SF_Recursive) ) return 0;
dan964fa262020-12-18 16:13:39 +00004386
4387 if( pSrc->nSrc>1 ){
dan51ddfef2021-03-17 14:29:37 +00004388 if( pParse->nSelect>500 ) return 0;
drh95fe38f2022-04-25 14:59:59 +00004389 if( OptimizationDisabled(db, SQLITE_FlttnUnionAll) ) return 0;
drh913306a2021-11-26 17:10:18 +00004390 aCsrMap = sqlite3DbMallocZero(db, ((i64)pParse->nTab+1)*sizeof(int));
drhc8d21472021-07-21 15:42:05 +00004391 if( aCsrMap ) aCsrMap[0] = pParse->nTab;
dan964fa262020-12-18 16:13:39 +00004392 }
dande9ed622020-12-16 20:00:46 +00004393 }
drhcdb2f602017-10-04 05:59:54 +00004394
drh7d10d5a2008-08-20 16:35:10 +00004395 /***** If we reach this point, flattening is permitted. *****/
drhfef37762018-07-10 19:48:35 +00004396 SELECTTRACE(1,pParse,p,("flatten %u.%p from term %d\n",
4397 pSub->selId, pSub, iFrom));
drh7d10d5a2008-08-20 16:35:10 +00004398
4399 /* Authorize the subquery */
danielk1977524cc212008-07-02 13:13:51 +00004400 pParse->zAuthContext = pSubitem->zName;
drha2acb0d2012-04-11 23:22:37 +00004401 TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
4402 testcase( i==SQLITE_DENY );
danielk1977524cc212008-07-02 13:13:51 +00004403 pParse->zAuthContext = zSavedAuthContext;
4404
dande9ed622020-12-16 20:00:46 +00004405 /* Delete the transient structures associated with thesubquery */
4406 pSub1 = pSubitem->pSelect;
4407 sqlite3DbFree(db, pSubitem->zDatabase);
4408 sqlite3DbFree(db, pSubitem->zName);
4409 sqlite3DbFree(db, pSubitem->zAlias);
4410 pSubitem->zDatabase = 0;
4411 pSubitem->zName = 0;
4412 pSubitem->zAlias = 0;
4413 pSubitem->pSelect = 0;
drhd44f8b22022-04-07 01:11:13 +00004414 assert( pSubitem->fg.isUsing!=0 || pSubitem->u3.pOn==0 );
dande9ed622020-12-16 20:00:46 +00004415
drh7d10d5a2008-08-20 16:35:10 +00004416 /* If the sub-query is a compound SELECT statement, then (by restrictions
4417 ** 17 and 18 above) it must be a UNION ALL and the parent query must
4418 ** be of the form:
danielk1977f23329a2008-07-01 14:09:13 +00004419 **
4420 ** SELECT <expr-list> FROM (<sub-query>) <where-clause>
4421 **
4422 ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
drha78c22c2008-11-11 18:28:58 +00004423 ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
danielk1977f23329a2008-07-01 14:09:13 +00004424 ** OFFSET clauses and joins them to the left-hand-side of the original
4425 ** using UNION ALL operators. In this case N is the number of simple
4426 ** select statements in the compound sub-query.
drha78c22c2008-11-11 18:28:58 +00004427 **
4428 ** Example:
4429 **
4430 ** SELECT a+1 FROM (
4431 ** SELECT x FROM tab
4432 ** UNION ALL
4433 ** SELECT y FROM tab
4434 ** UNION ALL
4435 ** SELECT abs(z*2) FROM tab2
4436 ** ) WHERE a!=5 ORDER BY 1
4437 **
4438 ** Transformed into:
4439 **
4440 ** SELECT x+1 FROM tab WHERE x+1!=5
4441 ** UNION ALL
4442 ** SELECT y+1 FROM tab WHERE y+1!=5
4443 ** UNION ALL
4444 ** SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
4445 ** ORDER BY 1
4446 **
4447 ** We call this the "compound-subquery flattening".
danielk1977f23329a2008-07-01 14:09:13 +00004448 */
4449 for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
4450 Select *pNew;
4451 ExprList *pOrderBy = p->pOrderBy;
danielk19774b86ef12008-07-01 14:39:35 +00004452 Expr *pLimit = p->pLimit;
danielk1977f23329a2008-07-01 14:09:13 +00004453 Select *pPrior = p->pPrior;
dande9ed622020-12-16 20:00:46 +00004454 Table *pItemTab = pSubitem->pTab;
4455 pSubitem->pTab = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004456 p->pOrderBy = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004457 p->pPrior = 0;
danielk19774b86ef12008-07-01 14:39:35 +00004458 p->pLimit = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00004459 pNew = sqlite3SelectDup(db, p, 0);
danielk19774b86ef12008-07-01 14:39:35 +00004460 p->pLimit = pLimit;
drha78c22c2008-11-11 18:28:58 +00004461 p->pOrderBy = pOrderBy;
drha78c22c2008-11-11 18:28:58 +00004462 p->op = TK_ALL;
dande9ed622020-12-16 20:00:46 +00004463 pSubitem->pTab = pItemTab;
drha78c22c2008-11-11 18:28:58 +00004464 if( pNew==0 ){
drhd227a292014-02-09 18:02:09 +00004465 p->pPrior = pPrior;
drha78c22c2008-11-11 18:28:58 +00004466 }else{
dan51ddfef2021-03-17 14:29:37 +00004467 pNew->selId = ++pParse->nSelect;
drh9da977f2021-04-20 12:14:12 +00004468 if( aCsrMap && ALWAYS(db->mallocFailed==0) ){
dan964fa262020-12-18 16:13:39 +00004469 renumberCursors(pParse, pNew, iFrom, aCsrMap);
4470 }
drha78c22c2008-11-11 18:28:58 +00004471 pNew->pPrior = pPrior;
drhd227a292014-02-09 18:02:09 +00004472 if( pPrior ) pPrior->pNext = pNew;
4473 pNew->pNext = p;
4474 p->pPrior = pNew;
drhe2243d22018-04-23 17:18:03 +00004475 SELECTTRACE(2,pParse,p,("compound-subquery flattener"
drhfef37762018-07-10 19:48:35 +00004476 " creates %u as peer\n",pNew->selId));
drha78c22c2008-11-11 18:28:58 +00004477 }
dande9ed622020-12-16 20:00:46 +00004478 assert( pSubitem->pSelect==0 );
dan964fa262020-12-18 16:13:39 +00004479 }
4480 sqlite3DbFree(db, aCsrMap);
4481 if( db->mallocFailed ){
4482 pSubitem->pSelect = pSub1;
4483 return 1;
danielk1977f23329a2008-07-01 14:09:13 +00004484 }
4485
drha78c22c2008-11-11 18:28:58 +00004486 /* Defer deleting the Table object associated with the
4487 ** subquery until code generation is
4488 ** complete, since there may still exist Expr.pTab entries that
4489 ** refer to the subquery even after flattening. Ticket #3346.
drhccfcbce2009-05-18 15:46:07 +00004490 **
4491 ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
drha78c22c2008-11-11 18:28:58 +00004492 */
drhccfcbce2009-05-18 15:46:07 +00004493 if( ALWAYS(pSubitem->pTab!=0) ){
drha78c22c2008-11-11 18:28:58 +00004494 Table *pTabToDel = pSubitem->pTab;
drh79df7782016-12-14 14:07:35 +00004495 if( pTabToDel->nTabRef==1 ){
dan65a7cd12009-09-01 12:16:01 +00004496 Parse *pToplevel = sqlite3ParseToplevel(pParse);
drhcf3c0782021-01-11 20:37:02 +00004497 sqlite3ParserAddCleanup(pToplevel,
4498 (void(*)(sqlite3*,void*))sqlite3DeleteTable,
4499 pTabToDel);
drh21d4f5b2021-01-12 15:30:01 +00004500 testcase( pToplevel->earlyCleanup );
drha78c22c2008-11-11 18:28:58 +00004501 }else{
drh79df7782016-12-14 14:07:35 +00004502 pTabToDel->nTabRef--;
drha78c22c2008-11-11 18:28:58 +00004503 }
4504 pSubitem->pTab = 0;
4505 }
4506
4507 /* The following loop runs once for each term in a compound-subquery
4508 ** flattening (as described above). If we are doing a different kind
4509 ** of flattening - a flattening other than a compound-subquery flattening -
4510 ** then this loop only runs once.
4511 **
4512 ** This loop moves all of the FROM elements of the subquery into the
4513 ** the FROM clause of the outer query. Before doing this, remember
4514 ** the cursor number for the original outer query FROM element in
4515 ** iParent. The iParent cursor will never be used. Subsequent code
4516 ** will scan expressions looking for iParent references and replace
4517 ** those references with expressions that resolve to the subquery FROM
4518 ** elements we are now copying in.
4519 */
dande9ed622020-12-16 20:00:46 +00004520 pSub = pSub1;
danielk1977f23329a2008-07-01 14:09:13 +00004521 for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
drha78c22c2008-11-11 18:28:58 +00004522 int nSubSrc;
drhea678832008-12-10 19:26:22 +00004523 u8 jointype = 0;
drh79d26582022-04-11 10:38:28 +00004524 u8 ltorj = pSrc->a[iFrom].fg.jointype & JT_LTORJ;
drh55f66b32019-07-16 19:44:32 +00004525 assert( pSub!=0 );
drha78c22c2008-11-11 18:28:58 +00004526 pSubSrc = pSub->pSrc; /* FROM clause of subquery */
4527 nSubSrc = pSubSrc->nSrc; /* Number of terms in subquery FROM clause */
4528 pSrc = pParent->pSrc; /* FROM clause of the outer query */
drhc31c2eb2003-05-02 16:04:17 +00004529
dande9ed622020-12-16 20:00:46 +00004530 if( pParent==p ){
4531 jointype = pSubitem->fg.jointype; /* First time through the loop */
drha78c22c2008-11-11 18:28:58 +00004532 }
dande9ed622020-12-16 20:00:46 +00004533
drha78c22c2008-11-11 18:28:58 +00004534 /* The subquery uses a single slot of the FROM clause of the outer
4535 ** query. If the subquery has more than one element in its FROM clause,
4536 ** then expand the outer query to make space for it to hold all elements
4537 ** of the subquery.
4538 **
4539 ** Example:
4540 **
4541 ** SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
4542 **
4543 ** The outer query has 3 slots in its FROM clause. One slot of the
4544 ** outer query (the middle slot) is used by the subquery. The next
drhd12b6362015-10-11 19:46:59 +00004545 ** block of code will expand the outer query FROM clause to 4 slots.
4546 ** The middle slot is expanded to two slots in order to make space
4547 ** for the two elements in the FROM clause of the subquery.
drha78c22c2008-11-11 18:28:58 +00004548 */
4549 if( nSubSrc>1 ){
drh29c992c2019-01-17 15:40:41 +00004550 pSrc = sqlite3SrcListEnlarge(pParse, pSrc, nSubSrc-1,iFrom+1);
4551 if( pSrc==0 ) break;
4552 pParent->pSrc = pSrc;
drhc31c2eb2003-05-02 16:04:17 +00004553 }
drha78c22c2008-11-11 18:28:58 +00004554
4555 /* Transfer the FROM clause terms from the subquery into the
4556 ** outer query.
4557 */
drhc31c2eb2003-05-02 16:04:17 +00004558 for(i=0; i<nSubSrc; i++){
drhd44f8b22022-04-07 01:11:13 +00004559 SrcItem *pItem = &pSrc->a[i+iFrom];
4560 if( pItem->fg.isUsing ) sqlite3IdListDelete(db, pItem->u3.pUsing);
4561 assert( pItem->fg.isTabFunc==0 );
4562 *pItem = pSubSrc->a[i];
drh79d26582022-04-11 10:38:28 +00004563 pItem->fg.jointype |= ltorj;
drh399c7e22017-04-14 17:18:45 +00004564 iNewParent = pSubSrc->a[i].iCursor;
drhc31c2eb2003-05-02 16:04:17 +00004565 memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
4566 }
drhf7309bc2022-04-12 20:20:54 +00004567 pSrc->a[iFrom].fg.jointype &= JT_LTORJ;
4568 pSrc->a[iFrom].fg.jointype |= jointype | ltorj;
danielk1977f23329a2008-07-01 14:09:13 +00004569
4570 /* Now begin substituting subquery result set expressions for
4571 ** references to the iParent in the outer query.
4572 **
4573 ** Example:
4574 **
4575 ** SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
4576 ** \ \_____________ subquery __________/ /
4577 ** \_____________________ outer query ______________________________/
4578 **
4579 ** We look at every expression in the outer query and every place we see
4580 ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
4581 */
drhb7cbf5c2020-06-15 13:51:34 +00004582 if( pSub->pOrderBy && (pParent->selFlags & SF_NoopOrderBy)==0 ){
dan7c0a4722014-09-20 20:38:48 +00004583 /* At this point, any non-zero iOrderByCol values indicate that the
4584 ** ORDER BY column expression is identical to the iOrderByCol'th
4585 ** expression returned by SELECT statement pSub. Since these values
4586 ** do not necessarily correspond to columns in SELECT statement pParent,
4587 ** zero them before transfering the ORDER BY clause.
4588 **
4589 ** Not doing this may cause an error if a subsequent call to this
4590 ** function attempts to flatten a compound sub-query into pParent
4591 ** (the only way this can happen is if the compound sub-query is
4592 ** currently part of pSub->pSrc). See ticket [d11a6e908f]. */
4593 ExprList *pOrderBy = pSub->pOrderBy;
4594 for(i=0; i<pOrderBy->nExpr; i++){
4595 pOrderBy->a[i].u.x.iOrderByCol = 0;
4596 }
danielk1977f23329a2008-07-01 14:09:13 +00004597 assert( pParent->pOrderBy==0 );
dan7c0a4722014-09-20 20:38:48 +00004598 pParent->pOrderBy = pOrderBy;
danielk1977f23329a2008-07-01 14:09:13 +00004599 pSub->pOrderBy = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004600 }
drh11df7d22018-12-06 19:15:36 +00004601 pWhere = pSub->pWhere;
4602 pSub->pWhere = 0;
drhc133bab2022-04-11 20:15:52 +00004603 if( isOuterJoin>0 ){
drh67a99db2022-05-13 14:52:04 +00004604 sqlite3SetJoinExpr(pWhere, iNewParent, EP_OuterON);
drh399c7e22017-04-14 17:18:45 +00004605 }
dancd653a32020-06-13 21:24:40 +00004606 if( pWhere ){
4607 if( pParent->pWhere ){
4608 pParent->pWhere = sqlite3PExpr(pParse, TK_AND, pWhere, pParent->pWhere);
4609 }else{
4610 pParent->pWhere = pWhere;
4611 }
4612 }
danc3becdd2017-03-13 14:30:40 +00004613 if( db->mallocFailed==0 ){
drh46967de2017-04-14 12:39:37 +00004614 SubstContext x;
4615 x.pParse = pParse;
4616 x.iTable = iParent;
drh399c7e22017-04-14 17:18:45 +00004617 x.iNewTable = iNewParent;
drhc133bab2022-04-11 20:15:52 +00004618 x.isOuterJoin = isOuterJoin;
drh46967de2017-04-14 12:39:37 +00004619 x.pEList = pSub->pEList;
4620 substSelect(&x, pParent, 0);
danc3becdd2017-03-13 14:30:40 +00004621 }
danielk1977f23329a2008-07-01 14:09:13 +00004622
drh7cd5e852019-05-29 17:22:38 +00004623 /* The flattened query is a compound if either the inner or the
4624 ** outer query is a compound. */
4625 pParent->selFlags |= pSub->selFlags & SF_Compound;
4626 assert( (pSub->selFlags & SF_Distinct)==0 ); /* restriction (17b) */
danielk1977f23329a2008-07-01 14:09:13 +00004627
4628 /*
4629 ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
4630 **
4631 ** One is tempted to try to add a and b to combine the limits. But this
4632 ** does not work if either limit is negative.
4633 */
4634 if( pSub->pLimit ){
4635 pParent->pLimit = pSub->pLimit;
4636 pSub->pLimit = 0;
4637 }
drh2aee5142020-03-21 00:05:53 +00004638
4639 /* Recompute the SrcList_item.colUsed masks for the flattened
4640 ** tables. */
4641 for(i=0; i<nSubSrc; i++){
4642 recomputeColumnsUsed(pParent, &pSrc->a[i+iFrom]);
4643 }
drhdf199a22002-06-14 22:38:41 +00004644 }
drh8c74a8c2002-08-25 19:20:40 +00004645
drhc31c2eb2003-05-02 16:04:17 +00004646 /* Finially, delete what is left of the subquery and return
4647 ** success.
4648 */
drh89636622020-06-07 17:33:18 +00004649 sqlite3AggInfoPersistWalkerInit(&w, pParse);
4650 sqlite3WalkSelect(&w,pSub1);
drh633e6d52008-07-28 19:34:53 +00004651 sqlite3SelectDelete(db, pSub1);
danielk1977f23329a2008-07-01 14:09:13 +00004652
drh5e431be2022-04-06 11:08:38 +00004653#if TREETRACE_ENABLED
4654 if( sqlite3TreeTrace & 0x100 ){
drhbc8edba2015-06-05 20:27:26 +00004655 SELECTTRACE(0x100,pParse,p,("After flattening:\n"));
drhc90713d2014-09-30 13:46:49 +00004656 sqlite3TreeViewSelect(0, p, 0);
4657 }
4658#endif
4659
drh832508b2002-03-02 17:04:07 +00004660 return 1;
4661}
shane3514b6f2008-07-22 05:00:55 +00004662#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
drh1350b032002-02-27 19:00:20 +00004663
drh660ee552018-07-26 21:16:53 +00004664/*
drh8e5bfed2018-10-25 14:15:37 +00004665** A structure to keep track of all of the column values that are fixed to
drhefad2e22018-07-27 16:57:11 +00004666** a known value due to WHERE clause constraints of the form COLUMN=VALUE.
drh660ee552018-07-26 21:16:53 +00004667*/
4668typedef struct WhereConst WhereConst;
4669struct WhereConst {
drhefad2e22018-07-27 16:57:11 +00004670 Parse *pParse; /* Parsing context */
drh75016052021-06-10 14:36:23 +00004671 u8 *pOomFault; /* Pointer to pParse->db->mallocFailed */
drh660ee552018-07-26 21:16:53 +00004672 int nConst; /* Number for COLUMN=CONSTANT terms */
4673 int nChng; /* Number of times a constant is propagated */
dan40b82f92021-05-26 18:51:57 +00004674 int bHasAffBlob; /* At least one column in apExpr[] as affinity BLOB */
drhae8776e2022-06-20 12:42:28 +00004675 u32 mExcludeOn; /* Which ON expressions to exclude from considertion.
4676 ** Either EP_OuterON or EP_InnerON|EP_OuterON */
drhefad2e22018-07-27 16:57:11 +00004677 Expr **apExpr; /* [i*2] is COLUMN and [i*2+1] is VALUE */
drh660ee552018-07-26 21:16:53 +00004678};
drh69b72d52015-06-01 20:28:03 +00004679
drh660ee552018-07-26 21:16:53 +00004680/*
drh8e5bfed2018-10-25 14:15:37 +00004681** Add a new entry to the pConst object. Except, do not add duplicate
drhf8f76d62020-01-08 04:36:01 +00004682** pColumn entires. Also, do not add if doing so would not be appropriate.
4683**
4684** The caller guarantees the pColumn is a column and pValue is a constant.
4685** This routine has to do some additional checks before completing the
4686** insert.
drh660ee552018-07-26 21:16:53 +00004687*/
4688static void constInsert(
drhf8f76d62020-01-08 04:36:01 +00004689 WhereConst *pConst, /* The WhereConst into which we are inserting */
4690 Expr *pColumn, /* The COLUMN part of the constraint */
4691 Expr *pValue, /* The VALUE part of the constraint */
4692 Expr *pExpr /* Overall expression: COLUMN=VALUE or VALUE=COLUMN */
drh660ee552018-07-26 21:16:53 +00004693){
drh8e5bfed2018-10-25 14:15:37 +00004694 int i;
4695 assert( pColumn->op==TK_COLUMN );
drhf8f76d62020-01-08 04:36:01 +00004696 assert( sqlite3ExprIsConstant(pValue) );
4697
drhfdfd45a2020-02-13 22:12:35 +00004698 if( ExprHasProperty(pColumn, EP_FixedCol) ) return;
4699 if( sqlite3ExprAffinity(pValue)!=0 ) return;
drhf8f76d62020-01-08 04:36:01 +00004700 if( !sqlite3IsBinary(sqlite3ExprCompareCollSeq(pConst->pParse,pExpr)) ){
4701 return;
4702 }
drh8e5bfed2018-10-25 14:15:37 +00004703
4704 /* 2018-10-25 ticket [cf5ed20f]
4705 ** Make sure the same pColumn is not inserted more than once */
4706 for(i=0; i<pConst->nConst; i++){
drh7be5e3d2020-01-09 20:33:13 +00004707 const Expr *pE2 = pConst->apExpr[i*2];
4708 assert( pE2->op==TK_COLUMN );
4709 if( pE2->iTable==pColumn->iTable
4710 && pE2->iColumn==pColumn->iColumn
drh8e5bfed2018-10-25 14:15:37 +00004711 ){
4712 return; /* Already present. Return without doing anything. */
4713 }
4714 }
dan40b82f92021-05-26 18:51:57 +00004715 if( sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4716 pConst->bHasAffBlob = 1;
4717 }
drh9cbf4f32018-07-27 20:01:00 +00004718
drh660ee552018-07-26 21:16:53 +00004719 pConst->nConst++;
drhefad2e22018-07-27 16:57:11 +00004720 pConst->apExpr = sqlite3DbReallocOrFree(pConst->pParse->db, pConst->apExpr,
drh660ee552018-07-26 21:16:53 +00004721 pConst->nConst*2*sizeof(Expr*));
4722 if( pConst->apExpr==0 ){
4723 pConst->nConst = 0;
4724 }else{
4725 pConst->apExpr[pConst->nConst*2-2] = pColumn;
4726 pConst->apExpr[pConst->nConst*2-1] = pValue;
4727 }
4728}
4729
4730/*
drhefad2e22018-07-27 16:57:11 +00004731** Find all terms of COLUMN=VALUE or VALUE=COLUMN in pExpr where VALUE
4732** is a constant expression and where the term must be true because it
4733** is part of the AND-connected terms of the expression. For each term
4734** found, add it to the pConst structure.
drh660ee552018-07-26 21:16:53 +00004735*/
4736static void findConstInWhere(WhereConst *pConst, Expr *pExpr){
drhefad2e22018-07-27 16:57:11 +00004737 Expr *pRight, *pLeft;
drhb775c972021-05-14 14:26:57 +00004738 if( NEVER(pExpr==0) ) return;
drhae8776e2022-06-20 12:42:28 +00004739 if( ExprHasProperty(pExpr, pConst->mExcludeOn) ){
drh958fcd42022-06-10 11:28:52 +00004740 testcase( ExprHasProperty(pExpr, EP_OuterON) );
4741 testcase( ExprHasProperty(pExpr, EP_InnerON) );
4742 return;
4743 }
drh660ee552018-07-26 21:16:53 +00004744 if( pExpr->op==TK_AND ){
4745 findConstInWhere(pConst, pExpr->pRight);
4746 findConstInWhere(pConst, pExpr->pLeft);
4747 return;
4748 }
4749 if( pExpr->op!=TK_EQ ) return;
drhefad2e22018-07-27 16:57:11 +00004750 pRight = pExpr->pRight;
4751 pLeft = pExpr->pLeft;
4752 assert( pRight!=0 );
4753 assert( pLeft!=0 );
drhf8f76d62020-01-08 04:36:01 +00004754 if( pRight->op==TK_COLUMN && sqlite3ExprIsConstant(pLeft) ){
4755 constInsert(pConst,pRight,pLeft,pExpr);
4756 }
4757 if( pLeft->op==TK_COLUMN && sqlite3ExprIsConstant(pRight) ){
4758 constInsert(pConst,pLeft,pRight,pExpr);
drh660ee552018-07-26 21:16:53 +00004759 }
4760}
4761
4762/*
dan40b82f92021-05-26 18:51:57 +00004763** This is a helper function for Walker callback propagateConstantExprRewrite().
4764**
4765** Argument pExpr is a candidate expression to be replaced by a value. If
4766** pExpr is equivalent to one of the columns named in pWalker->u.pConst,
4767** then overwrite it with the corresponding value. Except, do not do so
4768** if argument bIgnoreAffBlob is non-zero and the affinity of pExpr
4769** is SQLITE_AFF_BLOB.
drh660ee552018-07-26 21:16:53 +00004770*/
dan40b82f92021-05-26 18:51:57 +00004771static int propagateConstantExprRewriteOne(
4772 WhereConst *pConst,
4773 Expr *pExpr,
4774 int bIgnoreAffBlob
4775){
drh660ee552018-07-26 21:16:53 +00004776 int i;
drh75016052021-06-10 14:36:23 +00004777 if( pConst->pOomFault[0] ) return WRC_Prune;
drh660ee552018-07-26 21:16:53 +00004778 if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
drhae8776e2022-06-20 12:42:28 +00004779 if( ExprHasProperty(pExpr, EP_FixedCol|pConst->mExcludeOn) ){
drhbe0330e2020-01-16 17:53:24 +00004780 testcase( ExprHasProperty(pExpr, EP_FixedCol) );
drh67a99db2022-05-13 14:52:04 +00004781 testcase( ExprHasProperty(pExpr, EP_OuterON) );
drhae8776e2022-06-20 12:42:28 +00004782 testcase( ExprHasProperty(pExpr, EP_InnerON) );
drhbe0330e2020-01-16 17:53:24 +00004783 return WRC_Continue;
4784 }
drh660ee552018-07-26 21:16:53 +00004785 for(i=0; i<pConst->nConst; i++){
4786 Expr *pColumn = pConst->apExpr[i*2];
4787 if( pColumn==pExpr ) continue;
4788 if( pColumn->iTable!=pExpr->iTable ) continue;
4789 if( pColumn->iColumn!=pExpr->iColumn ) continue;
dan40b82f92021-05-26 18:51:57 +00004790 if( bIgnoreAffBlob && sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4791 break;
4792 }
drhefad2e22018-07-27 16:57:11 +00004793 /* A match is found. Add the EP_FixedCol property */
drh660ee552018-07-26 21:16:53 +00004794 pConst->nChng++;
4795 ExprClearProperty(pExpr, EP_Leaf);
drhefad2e22018-07-27 16:57:11 +00004796 ExprSetProperty(pExpr, EP_FixedCol);
4797 assert( pExpr->pLeft==0 );
4798 pExpr->pLeft = sqlite3ExprDup(pConst->pParse->db, pConst->apExpr[i*2+1], 0);
drh75016052021-06-10 14:36:23 +00004799 if( pConst->pParse->db->mallocFailed ) return WRC_Prune;
drh660ee552018-07-26 21:16:53 +00004800 break;
4801 }
4802 return WRC_Prune;
4803}
4804
4805/*
dan40b82f92021-05-26 18:51:57 +00004806** This is a Walker expression callback. pExpr is a node from the WHERE
4807** clause of a SELECT statement. This function examines pExpr to see if
4808** any substitutions based on the contents of pWalker->u.pConst should
4809** be made to pExpr or its immediate children.
4810**
4811** A substitution is made if:
4812**
4813** + pExpr is a column with an affinity other than BLOB that matches
4814** one of the columns in pWalker->u.pConst, or
4815**
4816** + pExpr is a binary comparison operator (=, <=, >=, <, >) that
4817** uses an affinity other than TEXT and one of its immediate
4818** children is a column that matches one of the columns in
4819** pWalker->u.pConst.
4820*/
4821static int propagateConstantExprRewrite(Walker *pWalker, Expr *pExpr){
4822 WhereConst *pConst = pWalker->u.pConst;
drha8ed5152021-05-26 19:52:21 +00004823 assert( TK_GT==TK_EQ+1 );
4824 assert( TK_LE==TK_EQ+2 );
4825 assert( TK_LT==TK_EQ+3 );
4826 assert( TK_GE==TK_EQ+4 );
dan40b82f92021-05-26 18:51:57 +00004827 if( pConst->bHasAffBlob ){
drha8ed5152021-05-26 19:52:21 +00004828 if( (pExpr->op>=TK_EQ && pExpr->op<=TK_GE)
dan40b82f92021-05-26 18:51:57 +00004829 || pExpr->op==TK_IS
4830 ){
4831 propagateConstantExprRewriteOne(pConst, pExpr->pLeft, 0);
drh75016052021-06-10 14:36:23 +00004832 if( pConst->pOomFault[0] ) return WRC_Prune;
dan40b82f92021-05-26 18:51:57 +00004833 if( sqlite3ExprAffinity(pExpr->pLeft)!=SQLITE_AFF_TEXT ){
4834 propagateConstantExprRewriteOne(pConst, pExpr->pRight, 0);
4835 }
4836 }
4837 }
4838 return propagateConstantExprRewriteOne(pConst, pExpr, pConst->bHasAffBlob);
4839}
4840
4841/*
drh660ee552018-07-26 21:16:53 +00004842** The WHERE-clause constant propagation optimization.
4843**
4844** If the WHERE clause contains terms of the form COLUMN=CONSTANT or
drh97bffe62020-01-08 00:39:37 +00004845** CONSTANT=COLUMN that are top-level AND-connected terms that are not
4846** part of a ON clause from a LEFT JOIN, then throughout the query
4847** replace all other occurrences of COLUMN with CONSTANT.
drh660ee552018-07-26 21:16:53 +00004848**
4849** For example, the query:
4850**
4851** SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=t1.a AND t3.c=t2.b
4852**
4853** Is transformed into
4854**
4855** SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=39 AND t3.c=39
4856**
4857** Return true if any transformations where made and false if not.
drhefad2e22018-07-27 16:57:11 +00004858**
4859** Implementation note: Constant propagation is tricky due to affinity
4860** and collating sequence interactions. Consider this example:
4861**
4862** CREATE TABLE t1(a INT,b TEXT);
4863** INSERT INTO t1 VALUES(123,'0123');
4864** SELECT * FROM t1 WHERE a=123 AND b=a;
4865** SELECT * FROM t1 WHERE a=123 AND b=123;
4866**
4867** The two SELECT statements above should return different answers. b=a
4868** is alway true because the comparison uses numeric affinity, but b=123
4869** is false because it uses text affinity and '0123' is not the same as '123'.
4870** To work around this, the expression tree is not actually changed from
4871** "b=a" to "b=123" but rather the "a" in "b=a" is tagged with EP_FixedCol
4872** and the "123" value is hung off of the pLeft pointer. Code generator
4873** routines know to generate the constant "123" instead of looking up the
4874** column value. Also, to avoid collation problems, this optimization is
4875** only attempted if the "a=123" term uses the default BINARY collation.
drh342cb332021-05-27 14:09:01 +00004876**
4877** 2021-05-25 forum post 6a06202608: Another troublesome case is...
4878**
4879** CREATE TABLE t1(x);
4880** INSERT INTO t1 VALUES(10.0);
4881** SELECT 1 FROM t1 WHERE x=10 AND x LIKE 10;
4882**
4883** The query should return no rows, because the t1.x value is '10.0' not '10'
4884** and '10.0' is not LIKE '10'. But if we are not careful, the first WHERE
4885** term "x=10" will cause the second WHERE term to become "10 LIKE 10",
4886** resulting in a false positive. To avoid this, constant propagation for
4887** columns with BLOB affinity is only allowed if the constant is used with
4888** operators ==, <=, <, >=, >, or IS in a way that will cause the correct
4889** type conversions to occur. See logic associated with the bHasAffBlob flag
4890** for details.
drh660ee552018-07-26 21:16:53 +00004891*/
4892static int propagateConstants(
4893 Parse *pParse, /* The parsing context */
4894 Select *p /* The query in which to propagate constants */
4895){
4896 WhereConst x;
4897 Walker w;
4898 int nChng = 0;
drhefad2e22018-07-27 16:57:11 +00004899 x.pParse = pParse;
drh75016052021-06-10 14:36:23 +00004900 x.pOomFault = &pParse->db->mallocFailed;
drh660ee552018-07-26 21:16:53 +00004901 do{
4902 x.nConst = 0;
4903 x.nChng = 0;
4904 x.apExpr = 0;
dan40b82f92021-05-26 18:51:57 +00004905 x.bHasAffBlob = 0;
drhae8776e2022-06-20 12:42:28 +00004906 if( ALWAYS(p->pSrc!=0)
4907 && p->pSrc->nSrc>0
4908 && (p->pSrc->a[0].fg.jointype & JT_LTORJ)!=0
4909 ){
4910 /* Do not propagate constants on any ON clause if there is a
4911 ** RIGHT JOIN anywhere in the query */
4912 x.mExcludeOn = EP_InnerON | EP_OuterON;
4913 }else{
4914 /* Do not propagate constants through the ON clause of a LEFT JOIN */
4915 x.mExcludeOn = EP_OuterON;
4916 }
drh660ee552018-07-26 21:16:53 +00004917 findConstInWhere(&x, p->pWhere);
4918 if( x.nConst ){
4919 memset(&w, 0, sizeof(w));
4920 w.pParse = pParse;
4921 w.xExprCallback = propagateConstantExprRewrite;
4922 w.xSelectCallback = sqlite3SelectWalkNoop;
4923 w.xSelectCallback2 = 0;
4924 w.walkerDepth = 0;
4925 w.u.pConst = &x;
drhefad2e22018-07-27 16:57:11 +00004926 sqlite3WalkExpr(&w, p->pWhere);
4927 sqlite3DbFree(x.pParse->db, x.apExpr);
drh660ee552018-07-26 21:16:53 +00004928 nChng += x.nChng;
4929 }
4930 }while( x.nChng );
4931 return nChng;
4932}
drh69b72d52015-06-01 20:28:03 +00004933
4934#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
dan903fdd42021-02-22 20:56:13 +00004935# if !defined(SQLITE_OMIT_WINDOWFUNC)
4936/*
4937** This function is called to determine whether or not it is safe to
4938** push WHERE clause expression pExpr down to FROM clause sub-query
4939** pSubq, which contains at least one window function. Return 1
4940** if it is safe and the expression should be pushed down, or 0
4941** otherwise.
4942**
4943** It is only safe to push the expression down if it consists only
4944** of constants and copies of expressions that appear in the PARTITION
4945** BY clause of all window function used by the sub-query. It is safe
4946** to filter out entire partitions, but not rows within partitions, as
4947** this may change the results of the window functions.
4948**
4949** At the time this function is called it is guaranteed that
4950**
4951** * the sub-query uses only one distinct window frame, and
4952** * that the window frame has a PARTITION BY clase.
4953*/
4954static int pushDownWindowCheck(Parse *pParse, Select *pSubq, Expr *pExpr){
4955 assert( pSubq->pWin->pPartition );
4956 assert( (pSubq->selFlags & SF_MultiPart)==0 );
4957 assert( pSubq->pPrior==0 );
4958 return sqlite3ExprIsConstantOrGroupBy(pParse, pExpr, pSubq->pWin->pPartition);
4959}
4960# endif /* SQLITE_OMIT_WINDOWFUNC */
4961#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4962
4963#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh69b72d52015-06-01 20:28:03 +00004964/*
4965** Make copies of relevant WHERE clause terms of the outer query into
4966** the WHERE clause of subquery. Example:
4967**
4968** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1) WHERE x=5 AND y=10;
4969**
4970** Transformed into:
4971**
4972** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1 WHERE a=5 AND c-d=10)
4973** WHERE x=5 AND y=10;
4974**
4975** The hope is that the terms added to the inner query will make it more
4976** efficient.
4977**
4978** Do not attempt this optimization if:
4979**
drh25c221e2017-09-29 22:13:24 +00004980** (1) (** This restriction was removed on 2017-09-29. We used to
4981** disallow this optimization for aggregate subqueries, but now
drh67cc51a2017-09-30 11:47:06 +00004982** it is allowed by putting the extra terms on the HAVING clause.
4983** The added HAVING clause is pointless if the subquery lacks
4984** a GROUP BY clause. But such a HAVING clause is also harmless
4985** so there does not appear to be any reason to add extra logic
4986** to suppress it. **)
drh69b72d52015-06-01 20:28:03 +00004987**
4988** (2) The inner query is the recursive part of a common table expression.
4989**
4990** (3) The inner query has a LIMIT clause (since the changes to the WHERE
dance103732018-06-23 07:59:39 +00004991** clause would change the meaning of the LIMIT).
drh69b72d52015-06-01 20:28:03 +00004992**
drh6a9b9522018-03-27 15:13:43 +00004993** (4) The inner query is the right operand of a LEFT JOIN and the
4994** expression to be pushed down does not come from the ON clause
4995** on that LEFT JOIN.
drh69b72d52015-06-01 20:28:03 +00004996**
drh38978dd2015-08-22 01:32:29 +00004997** (5) The WHERE clause expression originates in the ON or USING clause
drh7fbb1012018-03-21 01:59:46 +00004998** of a LEFT JOIN where iCursor is not the right-hand table of that
4999** left join. An example:
5000**
5001** SELECT *
5002** FROM (SELECT 1 AS a1 UNION ALL SELECT 2) AS aa
5003** JOIN (SELECT 1 AS b2 UNION ALL SELECT 2) AS bb ON (a1=b2)
5004** LEFT JOIN (SELECT 8 AS c3 UNION ALL SELECT 9) AS cc ON (b2=2);
5005**
5006** The correct answer is three rows: (1,1,NULL),(2,2,8),(2,2,9).
5007** But if the (b2=2) term were to be pushed down into the bb subquery,
5008** then the (1,1,NULL) row would be suppressed.
drh38978dd2015-08-22 01:32:29 +00005009**
dan903fdd42021-02-22 20:56:13 +00005010** (6) Window functions make things tricky as changes to the WHERE clause
5011** of the inner query could change the window over which window
5012** functions are calculated. Therefore, do not attempt the optimization
5013** if:
5014**
5015** (6a) The inner query uses multiple incompatible window partitions.
5016**
5017** (6b) The inner query is a compound and uses window-functions.
5018**
5019** (6c) The WHERE clause does not consist entirely of constants and
5020** copies of expressions found in the PARTITION BY clause of
5021** all window-functions used by the sub-query. It is safe to
5022** filter out entire partitions, as this does not change the
5023** window over which any window-function is calculated.
dance103732018-06-23 07:59:39 +00005024**
drh745912e2021-02-22 03:04:25 +00005025** (7) The inner query is a Common Table Expression (CTE) that should
5026** be materialized. (This restriction is implemented in the calling
5027** routine.)
5028**
drh69b72d52015-06-01 20:28:03 +00005029** Return 0 if no changes are made and non-zero if one or more WHERE clause
5030** terms are duplicated into the subquery.
5031*/
5032static int pushDownWhereTerms(
dan44c56042016-12-07 15:38:37 +00005033 Parse *pParse, /* Parse context (for malloc() and error reporting) */
drh69b72d52015-06-01 20:28:03 +00005034 Select *pSubq, /* The subquery whose WHERE clause is to be augmented */
5035 Expr *pWhere, /* The WHERE clause of the outer query */
drha9cdb902022-04-25 19:40:33 +00005036 SrcItem *pSrc /* The subquery term of the outer FROM clause */
drh69b72d52015-06-01 20:28:03 +00005037){
5038 Expr *pNew;
5039 int nChng = 0;
5040 if( pWhere==0 ) return 0;
dan903fdd42021-02-22 20:56:13 +00005041 if( pSubq->selFlags & (SF_Recursive|SF_MultiPart) ) return 0;
drh0e464b52022-04-25 20:47:58 +00005042 if( pSrc->fg.jointype & (JT_LTORJ|JT_RIGHT) ) return 0;
drh508e2d02017-09-30 01:25:04 +00005043
dance103732018-06-23 07:59:39 +00005044#ifndef SQLITE_OMIT_WINDOWFUNC
dan903fdd42021-02-22 20:56:13 +00005045 if( pSubq->pPrior ){
5046 Select *pSel;
5047 for(pSel=pSubq; pSel; pSel=pSel->pPrior){
5048 if( pSel->pWin ) return 0; /* restriction (6b) */
5049 }
5050 }else{
5051 if( pSubq->pWin && pSubq->pWin->pPartition==0 ) return 0;
danf65e3792020-06-10 10:58:15 +00005052 }
dance103732018-06-23 07:59:39 +00005053#endif
5054
drh508e2d02017-09-30 01:25:04 +00005055#ifdef SQLITE_DEBUG
5056 /* Only the first term of a compound can have a WITH clause. But make
5057 ** sure no other terms are marked SF_Recursive in case something changes
5058 ** in the future.
5059 */
5060 {
5061 Select *pX;
5062 for(pX=pSubq; pX; pX=pX->pPrior){
5063 assert( (pX->selFlags & (SF_Recursive))==0 );
drhb1ec87a2016-04-25 02:20:10 +00005064 }
drh69b72d52015-06-01 20:28:03 +00005065 }
drh508e2d02017-09-30 01:25:04 +00005066#endif
5067
drh69b72d52015-06-01 20:28:03 +00005068 if( pSubq->pLimit!=0 ){
drhb1ec87a2016-04-25 02:20:10 +00005069 return 0; /* restriction (3) */
drh69b72d52015-06-01 20:28:03 +00005070 }
5071 while( pWhere->op==TK_AND ){
drha9cdb902022-04-25 19:40:33 +00005072 nChng += pushDownWhereTerms(pParse, pSubq, pWhere->pRight, pSrc);
drh69b72d52015-06-01 20:28:03 +00005073 pWhere = pWhere->pLeft;
5074 }
drha9cdb902022-04-25 19:40:33 +00005075
5076#if 0 /* Legacy code. Checks now done by sqlite3ExprIsTableConstraint() */
drh6a9b9522018-03-27 15:13:43 +00005077 if( isLeftJoin
drh67a99db2022-05-13 14:52:04 +00005078 && (ExprHasProperty(pWhere,EP_OuterON)==0
drhd1985262022-04-11 11:25:28 +00005079 || pWhere->w.iJoin!=iCursor)
drh6a9b9522018-03-27 15:13:43 +00005080 ){
5081 return 0; /* restriction (4) */
5082 }
drh67a99db2022-05-13 14:52:04 +00005083 if( ExprHasProperty(pWhere,EP_OuterON)
drhd1985262022-04-11 11:25:28 +00005084 && pWhere->w.iJoin!=iCursor
drh796588a2022-02-05 21:49:47 +00005085 ){
drh7fbb1012018-03-21 01:59:46 +00005086 return 0; /* restriction (5) */
5087 }
drha9cdb902022-04-25 19:40:33 +00005088#endif
5089
drh5eb6e092022-04-25 20:38:42 +00005090 if( sqlite3ExprIsTableConstraint(pWhere, pSrc) ){
drh69b72d52015-06-01 20:28:03 +00005091 nChng++;
drh8794c682021-02-13 16:39:24 +00005092 pSubq->selFlags |= SF_PushDown;
drh69b72d52015-06-01 20:28:03 +00005093 while( pSubq ){
drh46967de2017-04-14 12:39:37 +00005094 SubstContext x;
dan44c56042016-12-07 15:38:37 +00005095 pNew = sqlite3ExprDup(pParse->db, pWhere, 0);
drh92d1afb2022-06-13 12:42:24 +00005096 unsetJoinExpr(pNew, -1, 1);
drh46967de2017-04-14 12:39:37 +00005097 x.pParse = pParse;
drha9cdb902022-04-25 19:40:33 +00005098 x.iTable = pSrc->iCursor;
5099 x.iNewTable = pSrc->iCursor;
drhc133bab2022-04-11 20:15:52 +00005100 x.isOuterJoin = 0;
drh46967de2017-04-14 12:39:37 +00005101 x.pEList = pSubq->pEList;
5102 pNew = substExpr(&x, pNew);
dan903fdd42021-02-22 20:56:13 +00005103#ifndef SQLITE_OMIT_WINDOWFUNC
5104 if( pSubq->pWin && 0==pushDownWindowCheck(pParse, pSubq, pNew) ){
5105 /* Restriction 6c has prevented push-down in this case */
5106 sqlite3ExprDelete(pParse->db, pNew);
5107 nChng--;
5108 break;
5109 }
5110#endif
drh25c221e2017-09-29 22:13:24 +00005111 if( pSubq->selFlags & SF_Aggregate ){
drhd5c851c2019-04-19 13:38:34 +00005112 pSubq->pHaving = sqlite3ExprAnd(pParse, pSubq->pHaving, pNew);
drh25c221e2017-09-29 22:13:24 +00005113 }else{
drhd5c851c2019-04-19 13:38:34 +00005114 pSubq->pWhere = sqlite3ExprAnd(pParse, pSubq->pWhere, pNew);
drh25c221e2017-09-29 22:13:24 +00005115 }
drh69b72d52015-06-01 20:28:03 +00005116 pSubq = pSubq->pPrior;
5117 }
5118 }
5119 return nChng;
5120}
5121#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
5122
drh1350b032002-02-27 19:00:20 +00005123/*
drh47d9f832017-10-26 20:04:28 +00005124** The pFunc is the only aggregate function in the query. Check to see
5125** if the query is a candidate for the min/max optimization.
danielk1977a9d1ccb2008-01-05 17:39:29 +00005126**
drh47d9f832017-10-26 20:04:28 +00005127** If the query is a candidate for the min/max optimization, then set
5128** *ppMinMax to be an ORDER BY clause to be used for the optimization
5129** and return either WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX depending on
5130** whether pFunc is a min() or max() function.
danielk1977738bdcf2008-01-07 10:16:40 +00005131**
drh47d9f832017-10-26 20:04:28 +00005132** If the query is not a candidate for the min/max optimization, return
5133** WHERE_ORDERBY_NORMAL (which must be zero).
dan4ac391f2012-12-13 16:37:10 +00005134**
drh47d9f832017-10-26 20:04:28 +00005135** This routine must be called after aggregate functions have been
5136** located but before their arguments have been subjected to aggregate
5137** analysis.
danielk1977a9d1ccb2008-01-05 17:39:29 +00005138*/
drh47d9f832017-10-26 20:04:28 +00005139static u8 minMaxQuery(sqlite3 *db, Expr *pFunc, ExprList **ppMinMax){
5140 int eRet = WHERE_ORDERBY_NORMAL; /* Return value */
drha4eeccd2021-10-07 17:43:30 +00005141 ExprList *pEList; /* Arguments to agg function */
drh47d9f832017-10-26 20:04:28 +00005142 const char *zFunc; /* Name of aggregate function pFunc */
5143 ExprList *pOrderBy;
drhbe284e42020-02-27 16:21:39 +00005144 u8 sortFlags = 0;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005145
drh47d9f832017-10-26 20:04:28 +00005146 assert( *ppMinMax==0 );
5147 assert( pFunc->op==TK_AGG_FUNCTION );
dan4f9adee2019-07-13 16:22:50 +00005148 assert( !IsWindowFunc(pFunc) );
drha4eeccd2021-10-07 17:43:30 +00005149 assert( ExprUseXList(pFunc) );
5150 pEList = pFunc->x.pList;
drhaf7b7652021-01-13 19:28:17 +00005151 if( pEList==0
5152 || pEList->nExpr!=1
5153 || ExprHasProperty(pFunc, EP_WinFunc)
5154 || OptimizationDisabled(db, SQLITE_MinMaxOpt)
5155 ){
dan6ba7ab02019-07-02 11:56:47 +00005156 return eRet;
5157 }
drhf9751072021-10-07 13:40:29 +00005158 assert( !ExprHasProperty(pFunc, EP_IntValue) );
drh47d9f832017-10-26 20:04:28 +00005159 zFunc = pFunc->u.zToken;
5160 if( sqlite3StrICmp(zFunc, "min")==0 ){
5161 eRet = WHERE_ORDERBY_MIN;
dan67e2bb92020-02-27 15:07:16 +00005162 if( sqlite3ExprCanBeNull(pEList->a[0].pExpr) ){
5163 sortFlags = KEYINFO_ORDER_BIGNULL;
5164 }
drh47d9f832017-10-26 20:04:28 +00005165 }else if( sqlite3StrICmp(zFunc, "max")==0 ){
5166 eRet = WHERE_ORDERBY_MAX;
dan5b32bdf2019-08-17 15:47:32 +00005167 sortFlags = KEYINFO_ORDER_DESC;
drh47d9f832017-10-26 20:04:28 +00005168 }else{
5169 return eRet;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005170 }
drh47d9f832017-10-26 20:04:28 +00005171 *ppMinMax = pOrderBy = sqlite3ExprListDup(db, pEList, 0);
5172 assert( pOrderBy!=0 || db->mallocFailed );
drhd88fd532022-05-02 20:49:30 +00005173 if( pOrderBy ) pOrderBy->a[0].fg.sortFlags = sortFlags;
dan4ac391f2012-12-13 16:37:10 +00005174 return eRet;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005175}
5176
5177/*
danielk1977a5533162009-02-24 10:01:51 +00005178** The select statement passed as the first argument is an aggregate query.
peter.d.reid60ec9142014-09-06 16:39:46 +00005179** The second argument is the associated aggregate-info object. This
danielk1977a5533162009-02-24 10:01:51 +00005180** function tests if the SELECT is of the form:
5181**
5182** SELECT count(*) FROM <tbl>
5183**
5184** where table is a database table, not a sub-select or view. If the query
5185** does match this pattern, then a pointer to the Table object representing
drha1c4c3c2021-11-05 11:52:33 +00005186** <tbl> is returned. Otherwise, NULL is returned.
5187**
drhe574a922021-11-26 15:08:55 +00005188** This routine checks to see if it is safe to use the count optimization.
5189** A correct answer is still obtained (though perhaps more slowly) if
5190** this routine returns NULL when it could have returned a table pointer.
5191** But returning the pointer when NULL should have been returned can
5192** result in incorrect answers and/or crashes. So, when in doubt, return NULL.
danielk1977a5533162009-02-24 10:01:51 +00005193*/
5194static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
5195 Table *pTab;
5196 Expr *pExpr;
5197
5198 assert( !p->pGroupBy );
5199
drha1c4c3c2021-11-05 11:52:33 +00005200 if( p->pWhere
5201 || p->pEList->nExpr!=1
5202 || p->pSrc->nSrc!=1
5203 || p->pSrc->a[0].pSelect
5204 || pAggInfo->nFunc!=1
dan2c1b1dd2022-07-01 21:03:19 +00005205 || p->pHaving
danielk1977a5533162009-02-24 10:01:51 +00005206 ){
5207 return 0;
5208 }
danielk1977a5533162009-02-24 10:01:51 +00005209 pTab = p->pSrc->a[0].pTab;
drha1c4c3c2021-11-05 11:52:33 +00005210 assert( pTab!=0 );
5211 assert( !IsView(pTab) );
5212 if( !IsOrdinaryTable(pTab) ) return 0;
danielk1977a5533162009-02-24 10:01:51 +00005213 pExpr = p->pEList->a[0].pExpr;
drha1c4c3c2021-11-05 11:52:33 +00005214 assert( pExpr!=0 );
danielk1977a5533162009-02-24 10:01:51 +00005215 if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
dan8745f8a2021-11-15 14:11:23 +00005216 if( pExpr->pAggInfo!=pAggInfo ) return 0;
drhd36e1042013-09-06 13:10:12 +00005217 if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
drha1c4c3c2021-11-05 11:52:33 +00005218 assert( pAggInfo->aFunc[0].pFExpr==pExpr );
5219 testcase( ExprHasProperty(pExpr, EP_Distinct) );
5220 testcase( ExprHasProperty(pExpr, EP_WinFunc) );
dan4f9adee2019-07-13 16:22:50 +00005221 if( ExprHasProperty(pExpr, EP_Distinct|EP_WinFunc) ) return 0;
danielk1977a5533162009-02-24 10:01:51 +00005222
5223 return pTab;
5224}
5225
5226/*
danielk1977b1c685b2008-10-06 16:18:39 +00005227** If the source-list item passed as an argument was augmented with an
5228** INDEXED BY clause, then try to locate the specified index. If there
5229** was such a clause and the named index cannot be found, return
5230** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
5231** pFrom->pIndex and return SQLITE_OK.
5232*/
drh76012942021-02-21 21:04:54 +00005233int sqlite3IndexedByLookup(Parse *pParse, SrcItem *pFrom){
drh18622712021-02-20 21:20:54 +00005234 Table *pTab = pFrom->pTab;
5235 char *zIndexedBy = pFrom->u1.zIndexedBy;
5236 Index *pIdx;
5237 assert( pTab!=0 );
5238 assert( pFrom->fg.isIndexedBy!=0 );
5239
5240 for(pIdx=pTab->pIndex;
5241 pIdx && sqlite3StrICmp(pIdx->zName, zIndexedBy);
5242 pIdx=pIdx->pNext
5243 );
5244 if( !pIdx ){
5245 sqlite3ErrorMsg(pParse, "no such index: %s", zIndexedBy, 0);
5246 pParse->checkSchema = 1;
5247 return SQLITE_ERROR;
danielk1977b1c685b2008-10-06 16:18:39 +00005248 }
drhdbfbb5a2021-10-07 23:04:50 +00005249 assert( pFrom->fg.isCte==0 );
drha79e2a22021-02-21 23:44:14 +00005250 pFrom->u2.pIBIndex = pIdx;
danielk1977b1c685b2008-10-06 16:18:39 +00005251 return SQLITE_OK;
5252}
drh18622712021-02-20 21:20:54 +00005253
drhc01b7302013-05-07 17:49:08 +00005254/*
5255** Detect compound SELECT statements that use an ORDER BY clause with
5256** an alternative collating sequence.
5257**
5258** SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
5259**
5260** These are rewritten as a subquery:
5261**
5262** SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
5263** ORDER BY ... COLLATE ...
5264**
5265** This transformation is necessary because the multiSelectOrderBy() routine
5266** above that generates the code for a compound SELECT with an ORDER BY clause
5267** uses a merge algorithm that requires the same collating sequence on the
5268** result columns as on the ORDER BY clause. See ticket
5269** http://www.sqlite.org/src/info/6709574d2a
5270**
5271** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
5272** The UNION ALL operator works fine with multiSelectOrderBy() even when
5273** there are COLLATE terms in the ORDER BY.
5274*/
5275static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
5276 int i;
5277 Select *pNew;
5278 Select *pX;
5279 sqlite3 *db;
5280 struct ExprList_item *a;
5281 SrcList *pNewSrc;
5282 Parse *pParse;
5283 Token dummy;
5284
5285 if( p->pPrior==0 ) return WRC_Continue;
5286 if( p->pOrderBy==0 ) return WRC_Continue;
5287 for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
5288 if( pX==0 ) return WRC_Continue;
5289 a = p->pOrderBy->a;
dan46daa992020-06-11 15:53:54 +00005290#ifndef SQLITE_OMIT_WINDOWFUNC
5291 /* If iOrderByCol is already non-zero, then it has already been matched
5292 ** to a result column of the SELECT statement. This occurs when the
5293 ** SELECT is rewritten for window-functions processing and then passed
5294 ** to sqlite3SelectPrep() and similar a second time. The rewriting done
5295 ** by this function is not required in this case. */
5296 if( a[0].u.x.iOrderByCol ) return WRC_Continue;
5297#endif
drhc01b7302013-05-07 17:49:08 +00005298 for(i=p->pOrderBy->nExpr-1; i>=0; i--){
5299 if( a[i].pExpr->flags & EP_Collate ) break;
5300 }
5301 if( i<0 ) return WRC_Continue;
5302
5303 /* If we reach this point, that means the transformation is required. */
5304
5305 pParse = pWalker->pParse;
5306 db = pParse->db;
5307 pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
5308 if( pNew==0 ) return WRC_Abort;
5309 memset(&dummy, 0, sizeof(dummy));
drhd44f8b22022-04-07 01:11:13 +00005310 pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0);
drhc01b7302013-05-07 17:49:08 +00005311 if( pNewSrc==0 ) return WRC_Abort;
5312 *pNew = *p;
5313 p->pSrc = pNewSrc;
drh1a1d3cd2015-11-19 16:33:31 +00005314 p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ASTERISK, 0));
drhc01b7302013-05-07 17:49:08 +00005315 p->op = TK_SELECT;
5316 p->pWhere = 0;
5317 pNew->pGroupBy = 0;
5318 pNew->pHaving = 0;
5319 pNew->pOrderBy = 0;
5320 p->pPrior = 0;
drh8af9ad92014-02-10 18:56:05 +00005321 p->pNext = 0;
drhf932f712015-04-12 17:35:27 +00005322 p->pWith = 0;
danfcc057d2019-12-04 01:42:07 +00005323#ifndef SQLITE_OMIT_WINDOWFUNC
5324 p->pWinDefn = 0;
5325#endif
drh8af9ad92014-02-10 18:56:05 +00005326 p->selFlags &= ~SF_Compound;
danb33c50f2015-04-04 16:43:16 +00005327 assert( (p->selFlags & SF_Converted)==0 );
5328 p->selFlags |= SF_Converted;
drha6e3a8c2014-02-10 21:07:51 +00005329 assert( pNew->pPrior!=0 );
5330 pNew->pPrior->pNext = pNew;
drhc01b7302013-05-07 17:49:08 +00005331 pNew->pLimit = 0;
drhc01b7302013-05-07 17:49:08 +00005332 return WRC_Continue;
5333}
danielk1977b1c685b2008-10-06 16:18:39 +00005334
drh20292312015-11-21 13:24:46 +00005335/*
5336** Check to see if the FROM clause term pFrom has table-valued function
5337** arguments. If it does, leave an error message in pParse and return
5338** non-zero, since pFrom is not allowed to be a table-valued function.
5339*/
drh76012942021-02-21 21:04:54 +00005340static int cannotBeFunction(Parse *pParse, SrcItem *pFrom){
drh20292312015-11-21 13:24:46 +00005341 if( pFrom->fg.isTabFunc ){
5342 sqlite3ErrorMsg(pParse, "'%s' is not a function", pFrom->zName);
5343 return 1;
5344 }
5345 return 0;
5346}
5347
daneede6a52014-01-15 19:42:23 +00005348#ifndef SQLITE_OMIT_CTE
5349/*
5350** Argument pWith (which may be NULL) points to a linked list of nested
5351** WITH contexts, from inner to outermost. If the table identified by
5352** FROM clause element pItem is really a common-table-expression (CTE)
5353** then return a pointer to the CTE definition for that table. Otherwise
5354** return NULL.
dan98f45e52014-01-17 17:40:46 +00005355**
5356** If a non-NULL value is returned, set *ppContext to point to the With
5357** object that the returned CTE belongs to.
drh60c1a2f2014-01-15 18:23:00 +00005358*/
dan98f45e52014-01-17 17:40:46 +00005359static struct Cte *searchWith(
drh2476a6f2015-11-07 15:19:59 +00005360 With *pWith, /* Current innermost WITH clause */
drh76012942021-02-21 21:04:54 +00005361 SrcItem *pItem, /* FROM clause element to resolve */
dan98f45e52014-01-17 17:40:46 +00005362 With **ppContext /* OUT: WITH clause return value belongs to */
5363){
drh5abe1d32021-02-21 01:19:42 +00005364 const char *zName = pItem->zName;
5365 With *p;
5366 assert( pItem->zDatabase==0 );
5367 assert( zName!=0 );
5368 for(p=pWith; p; p=p->pOuter){
5369 int i;
5370 for(i=0; i<p->nCte; i++){
5371 if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
5372 *ppContext = p;
5373 return &p->a[i];
dan4e9119d2014-01-13 15:12:23 +00005374 }
5375 }
dan90bc36f2021-05-20 17:15:06 +00005376 if( p->bView ) break;
dan4e9119d2014-01-13 15:12:23 +00005377 }
5378 return 0;
5379}
5380
drhc49832c2014-01-15 18:35:52 +00005381/* The code generator maintains a stack of active WITH clauses
5382** with the inner-most WITH clause being at the top of the stack.
5383**
danb290f112014-01-17 14:59:27 +00005384** This routine pushes the WITH clause passed as the second argument
5385** onto the top of the stack. If argument bFree is true, then this
drh7cc73b32021-05-23 17:47:04 +00005386** WITH clause will never be popped from the stack but should instead
5387** be freed along with the Parse object. In other cases, when
danb290f112014-01-17 14:59:27 +00005388** bFree==0, the With object will be freed along with the SELECT
5389** statement with which it is associated.
drh24ce9442021-06-12 17:45:32 +00005390**
5391** This routine returns a copy of pWith. Or, if bFree is true and
5392** the pWith object is destroyed immediately due to an OOM condition,
5393** then this routine return NULL.
5394**
5395** If bFree is true, do not continue to use the pWith pointer after
5396** calling this routine, Instead, use only the return value.
drhc49832c2014-01-15 18:35:52 +00005397*/
drh24ce9442021-06-12 17:45:32 +00005398With *sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
dan4e9119d2014-01-13 15:12:23 +00005399 if( pWith ){
drh24ce9442021-06-12 17:45:32 +00005400 if( bFree ){
5401 pWith = (With*)sqlite3ParserAddCleanup(pParse,
5402 (void(*)(sqlite3*,void*))sqlite3WithDelete,
5403 pWith);
5404 if( pWith==0 ) return 0;
5405 }
drh7cc73b32021-05-23 17:47:04 +00005406 if( pParse->nErr==0 ){
5407 assert( pParse->pWith!=pWith );
5408 pWith->pOuter = pParse->pWith;
5409 pParse->pWith = pWith;
5410 }
dan4e9119d2014-01-13 15:12:23 +00005411 }
drh24ce9442021-06-12 17:45:32 +00005412 return pWith;
dan4e9119d2014-01-13 15:12:23 +00005413}
dan4e9119d2014-01-13 15:12:23 +00005414
daneede6a52014-01-15 19:42:23 +00005415/*
daneede6a52014-01-15 19:42:23 +00005416** This function checks if argument pFrom refers to a CTE declared by
drh5abe1d32021-02-21 01:19:42 +00005417** a WITH clause on the stack currently maintained by the parser (on the
5418** pParse->pWith linked list). And if currently processing a CTE
5419** CTE expression, through routine checks to see if the reference is
5420** a recursive reference to the CTE.
daneede6a52014-01-15 19:42:23 +00005421**
drh5abe1d32021-02-21 01:19:42 +00005422** If pFrom matches a CTE according to either of these two above, pFrom->pTab
5423** and other fields are populated accordingly.
daneede6a52014-01-15 19:42:23 +00005424**
drh5abe1d32021-02-21 01:19:42 +00005425** Return 0 if no match is found.
5426** Return 1 if a match is found.
5427** Return 2 if an error condition is detected.
daneede6a52014-01-15 19:42:23 +00005428*/
drh5abe1d32021-02-21 01:19:42 +00005429static int resolveFromTermToCte(
5430 Parse *pParse, /* The parsing context */
5431 Walker *pWalker, /* Current tree walker */
drh76012942021-02-21 21:04:54 +00005432 SrcItem *pFrom /* The FROM clause term to check */
dan8ce71842014-01-14 20:14:09 +00005433){
drh5abe1d32021-02-21 01:19:42 +00005434 Cte *pCte; /* Matched CTE (or NULL if no match) */
5435 With *pWith; /* The matching WITH */
dan8ce71842014-01-14 20:14:09 +00005436
dan8ce71842014-01-14 20:14:09 +00005437 assert( pFrom->pTab==0 );
drh5abe1d32021-02-21 01:19:42 +00005438 if( pParse->pWith==0 ){
5439 /* There are no WITH clauses in the stack. No match is possible */
5440 return 0;
drh46a31cd2019-11-09 14:38:58 +00005441 }
drh93c81392021-05-21 21:49:07 +00005442 if( pParse->nErr ){
5443 /* Prior errors might have left pParse->pWith in a goofy state, so
5444 ** go no further. */
5445 return 0;
5446 }
drh5abe1d32021-02-21 01:19:42 +00005447 if( pFrom->zDatabase!=0 ){
5448 /* The FROM term contains a schema qualifier (ex: main.t1) and so
5449 ** it cannot possibly be a CTE reference. */
5450 return 0;
5451 }
drhcd1499f2021-05-20 00:44:04 +00005452 if( pFrom->fg.notCte ){
5453 /* The FROM term is specifically excluded from matching a CTE.
5454 ** (1) It is part of a trigger that used to have zDatabase but had
5455 ** zDatabase removed by sqlite3FixTriggerStep().
5456 ** (2) This is the first term in the FROM clause of an UPDATE.
5457 */
5458 return 0;
5459 }
dan98f45e52014-01-17 17:40:46 +00005460 pCte = searchWith(pParse->pWith, pFrom, &pWith);
daneae73fb2014-01-16 18:34:33 +00005461 if( pCte ){
drh5abe1d32021-02-21 01:19:42 +00005462 sqlite3 *db = pParse->db;
dan98f45e52014-01-17 17:40:46 +00005463 Table *pTab;
dan8ce71842014-01-14 20:14:09 +00005464 ExprList *pEList;
5465 Select *pSel;
dan60e70682014-01-15 15:27:51 +00005466 Select *pLeft; /* Left-most SELECT statement */
drh34055852020-10-19 01:23:48 +00005467 Select *pRecTerm; /* Left-most recursive term */
danf2655fe2014-01-16 21:02:02 +00005468 int bMayRecursive; /* True if compound joined by UNION [ALL] */
dan98f45e52014-01-17 17:40:46 +00005469 With *pSavedWith; /* Initial value of pParse->pWith */
drh34055852020-10-19 01:23:48 +00005470 int iRecTab = -1; /* Cursor for recursive table */
drh745912e2021-02-22 03:04:25 +00005471 CteUse *pCteUse;
danf2655fe2014-01-16 21:02:02 +00005472
drh0576bc52015-08-26 11:40:11 +00005473 /* If pCte->zCteErr is non-NULL at this point, then this is an illegal
danf2655fe2014-01-16 21:02:02 +00005474 ** recursive reference to CTE pCte. Leave an error in pParse and return
drh0576bc52015-08-26 11:40:11 +00005475 ** early. If pCte->zCteErr is NULL, then this is not a recursive reference.
danf2655fe2014-01-16 21:02:02 +00005476 ** In this case, proceed. */
drh0576bc52015-08-26 11:40:11 +00005477 if( pCte->zCteErr ){
5478 sqlite3ErrorMsg(pParse, pCte->zCteErr, pCte->zName);
drh5abe1d32021-02-21 01:19:42 +00005479 return 2;
danf2655fe2014-01-16 21:02:02 +00005480 }
drh5abe1d32021-02-21 01:19:42 +00005481 if( cannotBeFunction(pParse, pFrom) ) return 2;
dan8ce71842014-01-14 20:14:09 +00005482
drhc25e2eb2014-01-20 14:58:55 +00005483 assert( pFrom->pTab==0 );
drha79e2a22021-02-21 23:44:14 +00005484 pTab = sqlite3DbMallocZero(db, sizeof(Table));
drh5abe1d32021-02-21 01:19:42 +00005485 if( pTab==0 ) return 2;
drh745912e2021-02-22 03:04:25 +00005486 pCteUse = pCte->pUse;
5487 if( pCteUse==0 ){
5488 pCte->pUse = pCteUse = sqlite3DbMallocZero(db, sizeof(pCteUse[0]));
5489 if( pCteUse==0
5490 || sqlite3ParserAddCleanup(pParse,sqlite3DbFree,pCteUse)==0
drha79e2a22021-02-21 23:44:14 +00005491 ){
5492 sqlite3DbFree(db, pTab);
5493 return 2;
5494 }
drh745912e2021-02-22 03:04:25 +00005495 pCteUse->eM10d = pCte->eM10d;
drha79e2a22021-02-21 23:44:14 +00005496 }
5497 pFrom->pTab = pTab;
drh79df7782016-12-14 14:07:35 +00005498 pTab->nTabRef = 1;
dan2d4dc5f2014-01-17 11:48:24 +00005499 pTab->zName = sqlite3DbStrDup(db, pCte->zName);
dan8ce71842014-01-14 20:14:09 +00005500 pTab->iPKey = -1;
dancfc9df72014-04-25 15:01:01 +00005501 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drhfccda8a2015-05-27 13:06:55 +00005502 pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
dan8ce71842014-01-14 20:14:09 +00005503 pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
drh5abe1d32021-02-21 01:19:42 +00005504 if( db->mallocFailed ) return 2;
danac67f562021-06-14 20:08:48 +00005505 pFrom->pSelect->selFlags |= SF_CopyCte;
dan8ce71842014-01-14 20:14:09 +00005506 assert( pFrom->pSelect );
drh0c1da682021-10-09 16:00:56 +00005507 if( pFrom->fg.isIndexedBy ){
5508 sqlite3ErrorMsg(pParse, "no such index: \"%s\"", pFrom->u1.zIndexedBy);
5509 return 2;
5510 }
drha79e2a22021-02-21 23:44:14 +00005511 pFrom->fg.isCte = 1;
drh745912e2021-02-22 03:04:25 +00005512 pFrom->u2.pCteUse = pCteUse;
5513 pCteUse->nUse++;
5514 if( pCteUse->nUse>=2 && pCteUse->eM10d==M10d_Any ){
5515 pCteUse->eM10d = M10d_Yes;
5516 }
dan8ce71842014-01-14 20:14:09 +00005517
daneae73fb2014-01-16 18:34:33 +00005518 /* Check if this is a recursive CTE. */
drh34055852020-10-19 01:23:48 +00005519 pRecTerm = pSel = pFrom->pSelect;
danf2655fe2014-01-16 21:02:02 +00005520 bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
drh34055852020-10-19 01:23:48 +00005521 while( bMayRecursive && pRecTerm->op==pSel->op ){
daneae73fb2014-01-16 18:34:33 +00005522 int i;
drh34055852020-10-19 01:23:48 +00005523 SrcList *pSrc = pRecTerm->pSrc;
5524 assert( pRecTerm->pPrior!=0 );
daneae73fb2014-01-16 18:34:33 +00005525 for(i=0; i<pSrc->nSrc; i++){
drh76012942021-02-21 21:04:54 +00005526 SrcItem *pItem = &pSrc->a[i];
daneae73fb2014-01-16 18:34:33 +00005527 if( pItem->zDatabase==0
5528 && pItem->zName!=0
5529 && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
drh34055852020-10-19 01:23:48 +00005530 ){
daneae73fb2014-01-16 18:34:33 +00005531 pItem->pTab = pTab;
drh94d6f3f2020-10-19 20:49:54 +00005532 pTab->nTabRef++;
drh8a48b9c2015-08-19 15:20:00 +00005533 pItem->fg.isRecursive = 1;
drh34055852020-10-19 01:23:48 +00005534 if( pRecTerm->selFlags & SF_Recursive ){
5535 sqlite3ErrorMsg(pParse,
5536 "multiple references to recursive table: %s", pCte->zName
5537 );
drh5abe1d32021-02-21 01:19:42 +00005538 return 2;
drh34055852020-10-19 01:23:48 +00005539 }
drh34055852020-10-19 01:23:48 +00005540 pRecTerm->selFlags |= SF_Recursive;
5541 if( iRecTab<0 ) iRecTab = pParse->nTab++;
5542 pItem->iCursor = iRecTab;
daneae73fb2014-01-16 18:34:33 +00005543 }
5544 }
drh34055852020-10-19 01:23:48 +00005545 if( (pRecTerm->selFlags & SF_Recursive)==0 ) break;
5546 pRecTerm = pRecTerm->pPrior;
dan8ce71842014-01-14 20:14:09 +00005547 }
5548
drh0576bc52015-08-26 11:40:11 +00005549 pCte->zCteErr = "circular reference: %s";
dan98f45e52014-01-17 17:40:46 +00005550 pSavedWith = pParse->pWith;
5551 pParse->pWith = pWith;
drh34055852020-10-19 01:23:48 +00005552 if( pSel->selFlags & SF_Recursive ){
danca237a82021-03-18 18:25:43 +00005553 int rc;
drh34055852020-10-19 01:23:48 +00005554 assert( pRecTerm!=0 );
5555 assert( (pRecTerm->selFlags & SF_Recursive)==0 );
5556 assert( pRecTerm->pNext!=0 );
5557 assert( (pRecTerm->pNext->selFlags & SF_Recursive)!=0 );
5558 assert( pRecTerm->pWith==0 );
5559 pRecTerm->pWith = pSel->pWith;
danca237a82021-03-18 18:25:43 +00005560 rc = sqlite3WalkSelect(pWalker, pRecTerm);
drh34055852020-10-19 01:23:48 +00005561 pRecTerm->pWith = 0;
danca237a82021-03-18 18:25:43 +00005562 if( rc ){
5563 pParse->pWith = pSavedWith;
5564 return 2;
5565 }
dan067cd832017-02-03 19:16:39 +00005566 }else{
danca237a82021-03-18 18:25:43 +00005567 if( sqlite3WalkSelect(pWalker, pSel) ){
5568 pParse->pWith = pSavedWith;
5569 return 2;
5570 }
dan067cd832017-02-03 19:16:39 +00005571 }
drh6e772262015-11-07 17:48:21 +00005572 pParse->pWith = pWith;
daneae73fb2014-01-16 18:34:33 +00005573
dan60e70682014-01-15 15:27:51 +00005574 for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
5575 pEList = pLeft->pEList;
dan8ce71842014-01-14 20:14:09 +00005576 if( pCte->pCols ){
drh8f9d0b22015-03-21 03:18:22 +00005577 if( pEList && pEList->nExpr!=pCte->pCols->nExpr ){
drh727a99f2014-01-16 21:59:51 +00005578 sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
dan60e70682014-01-15 15:27:51 +00005579 pCte->zName, pEList->nExpr, pCte->pCols->nExpr
5580 );
dan98f45e52014-01-17 17:40:46 +00005581 pParse->pWith = pSavedWith;
drh5abe1d32021-02-21 01:19:42 +00005582 return 2;
dan60e70682014-01-15 15:27:51 +00005583 }
dan8ce71842014-01-14 20:14:09 +00005584 pEList = pCte->pCols;
dan8ce71842014-01-14 20:14:09 +00005585 }
dan8ce71842014-01-14 20:14:09 +00005586
drh8981b902015-08-24 17:42:49 +00005587 sqlite3ColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
danf2655fe2014-01-16 21:02:02 +00005588 if( bMayRecursive ){
5589 if( pSel->selFlags & SF_Recursive ){
drh0576bc52015-08-26 11:40:11 +00005590 pCte->zCteErr = "multiple recursive references: %s";
danf2655fe2014-01-16 21:02:02 +00005591 }else{
drh0576bc52015-08-26 11:40:11 +00005592 pCte->zCteErr = "recursive reference in a subquery: %s";
danf2655fe2014-01-16 21:02:02 +00005593 }
5594 sqlite3WalkSelect(pWalker, pSel);
5595 }
drh0576bc52015-08-26 11:40:11 +00005596 pCte->zCteErr = 0;
dan98f45e52014-01-17 17:40:46 +00005597 pParse->pWith = pSavedWith;
drh5abe1d32021-02-21 01:19:42 +00005598 return 1; /* Success */
dan8ce71842014-01-14 20:14:09 +00005599 }
drh5abe1d32021-02-21 01:19:42 +00005600 return 0; /* No match */
dan8ce71842014-01-14 20:14:09 +00005601}
daneede6a52014-01-15 19:42:23 +00005602#endif
dan4e9119d2014-01-13 15:12:23 +00005603
danb290f112014-01-17 14:59:27 +00005604#ifndef SQLITE_OMIT_CTE
dan71856942014-01-17 15:15:10 +00005605/*
5606** If the SELECT passed as the second argument has an associated WITH
5607** clause, pop it from the stack stored as part of the Parse object.
5608**
5609** This function is used as the xSelectCallback2() callback by
5610** sqlite3SelectExpand() when walking a SELECT tree to resolve table
5611** names and other FROM clause elements.
5612*/
danbe120832021-05-17 16:20:41 +00005613void sqlite3SelectPopWith(Walker *pWalker, Select *p){
danb290f112014-01-17 14:59:27 +00005614 Parse *pParse = pWalker->pParse;
drh2f65b2f2017-10-02 21:29:51 +00005615 if( OK_IF_ALWAYS_TRUE(pParse->pWith) && p->pPrior==0 ){
dan067cd832017-02-03 19:16:39 +00005616 With *pWith = findRightmost(p)->pWith;
5617 if( pWith!=0 ){
dan70a32702020-01-21 14:42:48 +00005618 assert( pParse->pWith==pWith || pParse->nErr );
dan067cd832017-02-03 19:16:39 +00005619 pParse->pWith = pWith->pOuter;
5620 }
danb290f112014-01-17 14:59:27 +00005621 }
danb290f112014-01-17 14:59:27 +00005622}
danb290f112014-01-17 14:59:27 +00005623#endif
5624
dan9a947222018-06-14 19:06:36 +00005625/*
5626** The SrcList_item structure passed as the second argument represents a
5627** sub-query in the FROM clause of a SELECT statement. This function
5628** allocates and populates the SrcList_item.pTab object. If successful,
5629** SQLITE_OK is returned. Otherwise, if an OOM error is encountered,
5630** SQLITE_NOMEM.
5631*/
drh76012942021-02-21 21:04:54 +00005632int sqlite3ExpandSubquery(Parse *pParse, SrcItem *pFrom){
dan86fb6e12018-05-16 20:58:07 +00005633 Select *pSel = pFrom->pSelect;
5634 Table *pTab;
5635
dan9a947222018-06-14 19:06:36 +00005636 assert( pSel );
dan86fb6e12018-05-16 20:58:07 +00005637 pFrom->pTab = pTab = sqlite3DbMallocZero(pParse->db, sizeof(Table));
dan9a947222018-06-14 19:06:36 +00005638 if( pTab==0 ) return SQLITE_NOMEM;
dan86fb6e12018-05-16 20:58:07 +00005639 pTab->nTabRef = 1;
5640 if( pFrom->zAlias ){
5641 pTab->zName = sqlite3DbStrDup(pParse->db, pFrom->zAlias);
5642 }else{
drhd6bb6002022-04-22 18:07:38 +00005643 pTab->zName = sqlite3MPrintf(pParse->db, "%!S", pFrom);
dan86fb6e12018-05-16 20:58:07 +00005644 }
5645 while( pSel->pPrior ){ pSel = pSel->pPrior; }
5646 sqlite3ColumnsFromExprList(pParse, pSel->pEList,&pTab->nCol,&pTab->aCol);
5647 pTab->iPKey = -1;
5648 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drh6e5020e2021-04-07 15:45:01 +00005649#ifndef SQLITE_ALLOW_ROWID_IN_VIEW
5650 /* The usual case - do not allow ROWID on a subquery */
5651 pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
5652#else
5653 pTab->tabFlags |= TF_Ephemeral; /* Legacy compatibility mode */
5654#endif
drhf4b33152019-04-23 12:30:15 +00005655 return pParse->nErr ? SQLITE_ERROR : SQLITE_OK;
dan86fb6e12018-05-16 20:58:07 +00005656}
5657
drh4ce7bf92022-04-15 18:30:48 +00005658
5659/*
5660** Check the N SrcItem objects to the right of pBase. (N might be zero!)
5661** If any of those SrcItem objects have a USING clause containing zName
5662** then return true.
5663**
5664** If N is zero, or none of the N SrcItem objects to the right of pBase
5665** contains a USING clause, or if none of the USING clauses contain zName,
5666** then return false.
5667*/
5668static int inAnyUsingClause(
5669 const char *zName, /* Name we are looking for */
5670 SrcItem *pBase, /* The base SrcItem. Looking at pBase[1] and following */
5671 int N /* How many SrcItems to check */
5672){
5673 while( N>0 ){
5674 N--;
5675 pBase++;
5676 if( pBase->fg.isUsing==0 ) continue;
drhe32d6a02022-04-19 15:56:03 +00005677 if( NEVER(pBase->u3.pUsing==0) ) continue;
drh4ce7bf92022-04-15 18:30:48 +00005678 if( sqlite3IdListIndex(pBase->u3.pUsing, zName)>=0 ) return 1;
5679 }
5680 return 0;
5681}
5682
5683
danielk1977b1c685b2008-10-06 16:18:39 +00005684/*
drh7d10d5a2008-08-20 16:35:10 +00005685** This routine is a Walker callback for "expanding" a SELECT statement.
5686** "Expanding" means to do the following:
5687**
5688** (1) Make sure VDBE cursor numbers have been assigned to every
5689** element of the FROM clause.
5690**
5691** (2) Fill in the pTabList->a[].pTab fields in the SrcList that
5692** defines FROM clause. When views appear in the FROM clause,
5693** fill pTabList->a[].pSelect with a copy of the SELECT statement
5694** that implements the view. A copy is made of the view's SELECT
5695** statement so that we can freely modify or delete that statement
peter.d.reid60ec9142014-09-06 16:39:46 +00005696** without worrying about messing up the persistent representation
drh7d10d5a2008-08-20 16:35:10 +00005697** of the view.
5698**
peter.d.reid60ec9142014-09-06 16:39:46 +00005699** (3) Add terms to the WHERE clause to accommodate the NATURAL keyword
drh7d10d5a2008-08-20 16:35:10 +00005700** on joins and the ON and USING clause of joins.
5701**
5702** (4) Scan the list of columns in the result set (pEList) looking
5703** for instances of the "*" operator or the TABLE.* operator.
5704** If found, expand each "*" to be every column in every table
5705** and TABLE.* to be every column in TABLE.
5706**
danielk1977b3bce662005-01-29 08:32:43 +00005707*/
drh7d10d5a2008-08-20 16:35:10 +00005708static int selectExpander(Walker *pWalker, Select *p){
5709 Parse *pParse = pWalker->pParse;
drh5abe1d32021-02-21 01:19:42 +00005710 int i, j, k, rc;
drh7d10d5a2008-08-20 16:35:10 +00005711 SrcList *pTabList;
5712 ExprList *pEList;
drh76012942021-02-21 21:04:54 +00005713 SrcItem *pFrom;
drh7d10d5a2008-08-20 16:35:10 +00005714 sqlite3 *db = pParse->db;
drh3e3f1a52013-01-03 00:45:56 +00005715 Expr *pE, *pRight, *pExpr;
drh785097d2013-02-12 22:09:48 +00005716 u16 selFlags = p->selFlags;
drhfca23552017-10-28 20:51:54 +00005717 u32 elistFlags = 0;
danielk1977b3bce662005-01-29 08:32:43 +00005718
drh785097d2013-02-12 22:09:48 +00005719 p->selFlags |= SF_Expanded;
drh7d10d5a2008-08-20 16:35:10 +00005720 if( db->mallocFailed ){
5721 return WRC_Abort;
danielk1977b3bce662005-01-29 08:32:43 +00005722 }
drh9d9c41e2017-10-31 03:40:15 +00005723 assert( p->pSrc!=0 );
5724 if( (selFlags & SF_Expanded)!=0 ){
drh7d10d5a2008-08-20 16:35:10 +00005725 return WRC_Prune;
danielk1977b3bce662005-01-29 08:32:43 +00005726 }
drh59145812019-05-22 22:49:23 +00005727 if( pWalker->eCode ){
5728 /* Renumber selId because it has been copied from a view */
5729 p->selId = ++pParse->nSelect;
5730 }
drh7d10d5a2008-08-20 16:35:10 +00005731 pTabList = p->pSrc;
danielk1977b3bce662005-01-29 08:32:43 +00005732 pEList = p->pEList;
dan90bc36f2021-05-20 17:15:06 +00005733 if( pParse->pWith && (p->selFlags & SF_View) ){
5734 if( p->pWith==0 ){
5735 p->pWith = (With*)sqlite3DbMallocZero(db, sizeof(With));
5736 if( p->pWith==0 ){
5737 return WRC_Abort;
5738 }
5739 }
5740 p->pWith->bView = 1;
5741 }
drha5746e02018-04-09 20:36:09 +00005742 sqlite3WithPush(pParse, p->pWith, 0);
drh7d10d5a2008-08-20 16:35:10 +00005743
5744 /* Make sure cursor numbers have been assigned to all entries in
5745 ** the FROM clause of the SELECT statement.
5746 */
5747 sqlite3SrcListAssignCursors(pParse, pTabList);
5748
5749 /* Look up every table named in the FROM clause of the select. If
5750 ** an entry of the FROM clause is a subquery instead of a table or view,
5751 ** then create a transient table structure to describe the subquery.
5752 */
5753 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5754 Table *pTab;
drhe2b7d7a2015-09-29 15:50:04 +00005755 assert( pFrom->fg.isRecursive==0 || pFrom->pTab!=0 );
dan69887c92020-04-27 20:55:33 +00005756 if( pFrom->pTab ) continue;
5757 assert( pFrom->fg.isRecursive==0 );
drh7d10d5a2008-08-20 16:35:10 +00005758 if( pFrom->zName==0 ){
5759#ifndef SQLITE_OMIT_SUBQUERY
5760 Select *pSel = pFrom->pSelect;
5761 /* A sub-query in the FROM clause of a SELECT */
5762 assert( pSel!=0 );
5763 assert( pFrom->pTab==0 );
drh2b8c5a02015-01-22 12:00:17 +00005764 if( sqlite3WalkSelect(pWalker, pSel) ) return WRC_Abort;
dandfa552f2018-06-02 21:04:28 +00005765 if( sqlite3ExpandSubquery(pParse, pFrom) ) return WRC_Abort;
dan86fb6e12018-05-16 20:58:07 +00005766#endif
drh5abe1d32021-02-21 01:19:42 +00005767#ifndef SQLITE_OMIT_CTE
5768 }else if( (rc = resolveFromTermToCte(pParse, pWalker, pFrom))!=0 ){
5769 if( rc>1 ) return WRC_Abort;
5770 pTab = pFrom->pTab;
5771 assert( pTab!=0 );
5772#endif
drh7d10d5a2008-08-20 16:35:10 +00005773 }else{
5774 /* An ordinary table or view name in the FROM clause */
5775 assert( pFrom->pTab==0 );
dan41fb5cd2012-10-04 19:33:00 +00005776 pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
drh7d10d5a2008-08-20 16:35:10 +00005777 if( pTab==0 ) return WRC_Abort;
drh79df7782016-12-14 14:07:35 +00005778 if( pTab->nTabRef>=0xffff ){
drhd2a56232013-01-28 19:00:20 +00005779 sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
5780 pTab->zName);
5781 pFrom->pTab = 0;
5782 return WRC_Abort;
5783 }
drh79df7782016-12-14 14:07:35 +00005784 pTab->nTabRef++;
drh20292312015-11-21 13:24:46 +00005785 if( !IsVirtual(pTab) && cannotBeFunction(pParse, pFrom) ){
5786 return WRC_Abort;
5787 }
dan8c812f92020-01-21 16:23:17 +00005788#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhf38524d2021-08-02 16:41:57 +00005789 if( !IsOrdinaryTable(pTab) ){
drhbfad7be2015-10-11 20:39:46 +00005790 i16 nCol;
drh59145812019-05-22 22:49:23 +00005791 u8 eCodeOrig = pWalker->eCode;
drh7d10d5a2008-08-20 16:35:10 +00005792 if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
drh43152cf2009-05-19 19:04:58 +00005793 assert( pFrom->pSelect==0 );
drhf38524d2021-08-02 16:41:57 +00005794 if( IsView(pTab) ){
5795 if( (db->flags & SQLITE_EnableView)==0
5796 && pTab->pSchema!=db->aDb[1].pSchema
5797 ){
5798 sqlite3ErrorMsg(pParse, "access to view \"%s\" prohibited",
5799 pTab->zName);
5800 }
5801 pFrom->pSelect = sqlite3SelectDup(db, pTab->u.view.pSelect, 0);
danafaa6602021-09-30 18:42:52 +00005802 }
dan8c812f92020-01-21 16:23:17 +00005803#ifndef SQLITE_OMIT_VIRTUALTABLE
danafaa6602021-09-30 18:42:52 +00005804 else if( ALWAYS(IsVirtual(pTab))
drh3f681422020-01-07 18:10:56 +00005805 && pFrom->fg.fromDDL
drhf38524d2021-08-02 16:41:57 +00005806 && ALWAYS(pTab->u.vtab.p!=0)
5807 && pTab->u.vtab.p->eVtabRisk > ((db->flags & SQLITE_TrustedSchema)!=0)
drh3f681422020-01-07 18:10:56 +00005808 ){
drh32266a12020-01-09 13:08:28 +00005809 sqlite3ErrorMsg(pParse, "unsafe use of virtual table \"%s\"",
5810 pTab->zName);
drh11d88e62019-08-15 21:27:20 +00005811 }
drhf38524d2021-08-02 16:41:57 +00005812 assert( SQLITE_VTABRISK_Normal==1 && SQLITE_VTABRISK_High==2 );
dan8c812f92020-01-21 16:23:17 +00005813#endif
drhbfad7be2015-10-11 20:39:46 +00005814 nCol = pTab->nCol;
5815 pTab->nCol = -1;
drh59145812019-05-22 22:49:23 +00005816 pWalker->eCode = 1; /* Turn on Select.selId renumbering */
drh43152cf2009-05-19 19:04:58 +00005817 sqlite3WalkSelect(pWalker, pFrom->pSelect);
drh59145812019-05-22 22:49:23 +00005818 pWalker->eCode = eCodeOrig;
drhbfad7be2015-10-11 20:39:46 +00005819 pTab->nCol = nCol;
drh7d10d5a2008-08-20 16:35:10 +00005820 }
5821#endif
danielk1977b3bce662005-01-29 08:32:43 +00005822 }
danielk197785574e32008-10-06 05:32:18 +00005823
5824 /* Locate the index named by the INDEXED BY clause, if any. */
drh18622712021-02-20 21:20:54 +00005825 if( pFrom->fg.isIndexedBy && sqlite3IndexedByLookup(pParse, pFrom) ){
danielk1977b1c685b2008-10-06 16:18:39 +00005826 return WRC_Abort;
danielk197785574e32008-10-06 05:32:18 +00005827 }
danielk1977b3bce662005-01-29 08:32:43 +00005828 }
5829
drh7d10d5a2008-08-20 16:35:10 +00005830 /* Process NATURAL keywords, and ON and USING clauses of joins.
danielk1977b3bce662005-01-29 08:32:43 +00005831 */
drh0c7d3d32022-01-24 16:47:12 +00005832 assert( db->mallocFailed==0 || pParse->nErr!=0 );
drh358424a2022-04-15 15:15:01 +00005833 if( pParse->nErr || sqlite3ProcessJoin(pParse, p) ){
drh7d10d5a2008-08-20 16:35:10 +00005834 return WRC_Abort;
danielk1977b3bce662005-01-29 08:32:43 +00005835 }
5836
drh7d10d5a2008-08-20 16:35:10 +00005837 /* For every "*" that occurs in the column list, insert the names of
5838 ** all columns in all tables. And for every TABLE.* insert the names
5839 ** of all columns in TABLE. The parser inserted a special expression
drh1a1d3cd2015-11-19 16:33:31 +00005840 ** with the TK_ASTERISK operator for each "*" that it found in the column
5841 ** list. The following code just has to locate the TK_ASTERISK
5842 ** expressions and expand each one to the list of all columns in
5843 ** all tables.
danielk1977b3bce662005-01-29 08:32:43 +00005844 **
drh7d10d5a2008-08-20 16:35:10 +00005845 ** The first loop just checks to see if there are any "*" operators
5846 ** that need expanding.
danielk1977b3bce662005-01-29 08:32:43 +00005847 */
drh7d10d5a2008-08-20 16:35:10 +00005848 for(k=0; k<pEList->nExpr; k++){
drh3e3f1a52013-01-03 00:45:56 +00005849 pE = pEList->a[k].pExpr;
drh1a1d3cd2015-11-19 16:33:31 +00005850 if( pE->op==TK_ASTERISK ) break;
drh43152cf2009-05-19 19:04:58 +00005851 assert( pE->op!=TK_DOT || pE->pRight!=0 );
5852 assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
drh1a1d3cd2015-11-19 16:33:31 +00005853 if( pE->op==TK_DOT && pE->pRight->op==TK_ASTERISK ) break;
drhfca23552017-10-28 20:51:54 +00005854 elistFlags |= pE->flags;
danielk1977b3bce662005-01-29 08:32:43 +00005855 }
drh7d10d5a2008-08-20 16:35:10 +00005856 if( k<pEList->nExpr ){
5857 /*
5858 ** If we get here it means the result set contains one or more "*"
5859 ** operators that need to be expanded. Loop through each expression
5860 ** in the result set and expand them one by one.
5861 */
5862 struct ExprList_item *a = pEList->a;
5863 ExprList *pNew = 0;
5864 int flags = pParse->db->flags;
5865 int longNames = (flags & SQLITE_FullColNames)!=0
drh38b384a2013-01-03 17:34:28 +00005866 && (flags & SQLITE_ShortColNames)==0;
5867
drh7d10d5a2008-08-20 16:35:10 +00005868 for(k=0; k<pEList->nExpr; k++){
drh3e3f1a52013-01-03 00:45:56 +00005869 pE = a[k].pExpr;
drhfca23552017-10-28 20:51:54 +00005870 elistFlags |= pE->flags;
drh3e3f1a52013-01-03 00:45:56 +00005871 pRight = pE->pRight;
5872 assert( pE->op!=TK_DOT || pRight!=0 );
drh1a1d3cd2015-11-19 16:33:31 +00005873 if( pE->op!=TK_ASTERISK
5874 && (pE->op!=TK_DOT || pRight->op!=TK_ASTERISK)
5875 ){
drh7d10d5a2008-08-20 16:35:10 +00005876 /* This particular expression does not need to be expanded.
5877 */
drhb7916a72009-05-27 10:31:29 +00005878 pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
drh7d10d5a2008-08-20 16:35:10 +00005879 if( pNew ){
drh41cee662019-12-12 20:22:34 +00005880 pNew->a[pNew->nExpr-1].zEName = a[k].zEName;
drhd88fd532022-05-02 20:49:30 +00005881 pNew->a[pNew->nExpr-1].fg.eEName = a[k].fg.eEName;
drh41cee662019-12-12 20:22:34 +00005882 a[k].zEName = 0;
drh7d10d5a2008-08-20 16:35:10 +00005883 }
5884 a[k].pExpr = 0;
drh7d10d5a2008-08-20 16:35:10 +00005885 }else{
5886 /* This expression is a "*" or a "TABLE.*" and needs to be
5887 ** expanded. */
5888 int tableSeen = 0; /* Set to 1 when TABLE matches */
drh3e3f1a52013-01-03 00:45:56 +00005889 char *zTName = 0; /* text of name of TABLE */
drh43152cf2009-05-19 19:04:58 +00005890 if( pE->op==TK_DOT ){
5891 assert( pE->pLeft!=0 );
drh33e619f2009-05-28 01:00:55 +00005892 assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
5893 zTName = pE->pLeft->u.zToken;
drh7d10d5a2008-08-20 16:35:10 +00005894 }
5895 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
drh9c2d7aa2022-04-22 12:46:46 +00005896 Table *pTab = pFrom->pTab; /* Table for this data source */
5897 ExprList *pNestedFrom; /* Result-set of a nested FROM clause */
5898 char *zTabName; /* AS name for this data source */
5899 const char *zSchemaName = 0; /* Schema name for this data source */
5900 int iDb; /* Schema index for this data src */
drh63879a22022-05-02 20:04:34 +00005901 IdList *pUsing; /* USING clause for pFrom[1] */
drh9c2d7aa2022-04-22 12:46:46 +00005902
5903 if( (zTabName = pFrom->zAlias)==0 ){
drh7d10d5a2008-08-20 16:35:10 +00005904 zTabName = pTab->zName;
5905 }
5906 if( db->mallocFailed ) break;
mistachkin07fae322022-07-06 23:50:01 +00005907 assert( (int)pFrom->fg.isNestedFrom == IsNestedFrom(pFrom->pSelect) );
drh815b7822022-04-20 15:07:39 +00005908 if( pFrom->fg.isNestedFrom ){
drh9c2d7aa2022-04-22 12:46:46 +00005909 assert( pFrom->pSelect!=0 );
5910 pNestedFrom = pFrom->pSelect->pEList;
5911 assert( pNestedFrom!=0 );
5912 assert( pNestedFrom->nExpr==pTab->nCol );
drh815b7822022-04-20 15:07:39 +00005913 }else{
drh3e3f1a52013-01-03 00:45:56 +00005914 if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
5915 continue;
5916 }
drh9c2d7aa2022-04-22 12:46:46 +00005917 pNestedFrom = 0;
drh3e3f1a52013-01-03 00:45:56 +00005918 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh69c33822016-08-18 14:33:11 +00005919 zSchemaName = iDb>=0 ? db->aDb[iDb].zDbSName : "*";
drh7d10d5a2008-08-20 16:35:10 +00005920 }
drh45e41b72022-04-22 23:18:21 +00005921 if( i+1<pTabList->nSrc
5922 && pFrom[1].fg.isUsing
5923 && (selFlags & SF_NestedFrom)!=0
5924 ){
5925 int ii;
drh72d620b2022-05-02 19:59:03 +00005926 pUsing = pFrom[1].u3.pUsing;
drh45e41b72022-04-22 23:18:21 +00005927 for(ii=0; ii<pUsing->nId; ii++){
5928 const char *zUName = pUsing->a[ii].zName;
5929 pRight = sqlite3Expr(db, TK_ID, zUName);
5930 pNew = sqlite3ExprListAppend(pParse, pNew, pRight);
5931 if( pNew ){
5932 struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
5933 assert( pX->zEName==0 );
5934 pX->zEName = sqlite3MPrintf(db,"..%s", zUName);
drhd88fd532022-05-02 20:49:30 +00005935 pX->fg.eEName = ENAME_TAB;
5936 pX->fg.bUsingTerm = 1;
drh45e41b72022-04-22 23:18:21 +00005937 }
5938 }
drh72d620b2022-05-02 19:59:03 +00005939 }else{
5940 pUsing = 0;
drh45e41b72022-04-22 23:18:21 +00005941 }
drh7d10d5a2008-08-20 16:35:10 +00005942 for(j=0; j<pTab->nCol; j++){
drhcf9d36d2021-08-02 18:03:43 +00005943 char *zName = pTab->aCol[j].zCnName;
drh18f86002022-04-21 13:11:26 +00005944 struct ExprList_item *pX; /* Newly added ExprList term */
drh7d10d5a2008-08-20 16:35:10 +00005945
drhc75e09c2013-01-03 16:54:20 +00005946 assert( zName );
drh9c2d7aa2022-04-22 12:46:46 +00005947 if( zTName
5948 && pNestedFrom
5949 && sqlite3MatchEName(&pNestedFrom->a[j], 0, zTName, 0)==0
drh3e3f1a52013-01-03 00:45:56 +00005950 ){
5951 continue;
5952 }
5953
drh80090f92015-11-19 17:55:11 +00005954 /* If a column is marked as 'hidden', omit it from the expanded
5955 ** result-set list unless the SELECT has the SF_IncludeHidden
5956 ** bit set.
drh7d10d5a2008-08-20 16:35:10 +00005957 */
drhadef1592022-05-10 00:24:01 +00005958 if( (p->selFlags & SF_IncludeHidden)==0
5959 && IsHiddenColumn(&pTab->aCol[j])
5960 ){
5961 continue;
5962 }
5963 if( (pTab->aCol[j].colFlags & COLFLAG_NOEXPAND)!=0
5964 && zTName==0
5965 && (selFlags & (SF_NestedFrom))==0
5966 ){
5967 continue;
drh7d10d5a2008-08-20 16:35:10 +00005968 }
drh3e3f1a52013-01-03 00:45:56 +00005969 tableSeen = 1;
drh7d10d5a2008-08-20 16:35:10 +00005970
drh45e41b72022-04-22 23:18:21 +00005971 if( i>0 && zTName==0 && (selFlags & SF_NestedFrom)==0 ){
drhd44f8b22022-04-07 01:11:13 +00005972 if( pFrom->fg.isUsing
5973 && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0
5974 ){
drh7d10d5a2008-08-20 16:35:10 +00005975 /* In a join with a USING clause, omit columns in the
5976 ** using clause from the table on the right. */
5977 continue;
5978 }
5979 }
drhb7916a72009-05-27 10:31:29 +00005980 pRight = sqlite3Expr(db, TK_ID, zName);
drhbefbb402022-04-19 23:00:32 +00005981 if( (pTabList->nSrc>1
5982 && ( (pFrom->fg.jointype & JT_LTORJ)==0
drhd63c07e2022-04-23 14:30:22 +00005983 || (selFlags & SF_NestedFrom)!=0
drhbefbb402022-04-19 23:00:32 +00005984 || !inAnyUsingClause(zName,pFrom,pTabList->nSrc-i-1)
5985 )
5986 )
5987 || IN_RENAME_OBJECT
drh4ce7bf92022-04-15 18:30:48 +00005988 ){
drhb7916a72009-05-27 10:31:29 +00005989 Expr *pLeft;
5990 pLeft = sqlite3Expr(db, TK_ID, zTabName);
drhabfd35e2016-12-06 22:47:23 +00005991 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight);
dancbde37d2022-04-19 20:47:18 +00005992 if( IN_RENAME_OBJECT && pE->pLeft ){
5993 sqlite3RenameTokenRemap(pParse, pLeft, pE->pLeft);
5994 }
drh38b384a2013-01-03 17:34:28 +00005995 if( zSchemaName ){
drhc75e09c2013-01-03 16:54:20 +00005996 pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
drhabfd35e2016-12-06 22:47:23 +00005997 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr);
drhc75e09c2013-01-03 16:54:20 +00005998 }
drh7d10d5a2008-08-20 16:35:10 +00005999 }else{
6000 pExpr = pRight;
drh7d10d5a2008-08-20 16:35:10 +00006001 }
drhb7916a72009-05-27 10:31:29 +00006002 pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
drh18f86002022-04-21 13:11:26 +00006003 if( pNew==0 ){
6004 break; /* OOM */
6005 }
6006 pX = &pNew->a[pNew->nExpr-1];
6007 assert( pX->zEName==0 );
6008 if( (selFlags & SF_NestedFrom)!=0 && !IN_RENAME_OBJECT ){
drh9c2d7aa2022-04-22 12:46:46 +00006009 if( pNestedFrom ){
6010 pX->zEName = sqlite3DbStrDup(db, pNestedFrom->a[j].zEName);
drhcbb9da32019-12-12 22:11:33 +00006011 testcase( pX->zEName==0 );
drh3e3f1a52013-01-03 00:45:56 +00006012 }else{
drhcbb9da32019-12-12 22:11:33 +00006013 pX->zEName = sqlite3MPrintf(db, "%s.%s.%s",
drh18f86002022-04-21 13:11:26 +00006014 zSchemaName, zTabName, zName);
drhcbb9da32019-12-12 22:11:33 +00006015 testcase( pX->zEName==0 );
drh3e3f1a52013-01-03 00:45:56 +00006016 }
drhd88fd532022-05-02 20:49:30 +00006017 pX->fg.eEName = ENAME_TAB;
drh72d620b2022-05-02 19:59:03 +00006018 if( (pFrom->fg.isUsing
6019 && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0)
6020 || (pUsing && sqlite3IdListIndex(pUsing, zName)>=0)
6021 || (pTab->aCol[j].colFlags & COLFLAG_NOEXPAND)!=0
6022 ){
drhd88fd532022-05-02 20:49:30 +00006023 pX->fg.bNoExpand = 1;
drh72d620b2022-05-02 19:59:03 +00006024 }
drh18f86002022-04-21 13:11:26 +00006025 }else if( longNames ){
6026 pX->zEName = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
drhd88fd532022-05-02 20:49:30 +00006027 pX->fg.eEName = ENAME_NAME;
drh18f86002022-04-21 13:11:26 +00006028 }else{
6029 pX->zEName = sqlite3DbStrDup(db, zName);
drhd88fd532022-05-02 20:49:30 +00006030 pX->fg.eEName = ENAME_NAME;
drh8f25d182012-12-19 02:36:45 +00006031 }
drh7d10d5a2008-08-20 16:35:10 +00006032 }
6033 }
6034 if( !tableSeen ){
6035 if( zTName ){
6036 sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
6037 }else{
6038 sqlite3ErrorMsg(pParse, "no tables specified");
6039 }
6040 }
drh7d10d5a2008-08-20 16:35:10 +00006041 }
drh9a993342007-12-13 02:45:31 +00006042 }
drh7d10d5a2008-08-20 16:35:10 +00006043 sqlite3ExprListDelete(db, pEList);
6044 p->pEList = pNew;
drh4c774312007-12-08 21:10:20 +00006045 }
drhfca23552017-10-28 20:51:54 +00006046 if( p->pEList ){
6047 if( p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
6048 sqlite3ErrorMsg(pParse, "too many columns in result set");
6049 return WRC_Abort;
6050 }
6051 if( (elistFlags & (EP_HasFunc|EP_Subquery))!=0 ){
6052 p->selFlags |= SF_ComplexResult;
6053 }
drh994c80a2007-04-12 21:25:01 +00006054 }
drhcebc8002022-04-16 18:33:22 +00006055#if TREETRACE_ENABLED
6056 if( sqlite3TreeTrace & 0x100 ){
6057 SELECTTRACE(0x100,pParse,p,("After result-set wildcard expansion:\n"));
6058 sqlite3TreeViewSelect(0, p, 0);
6059 }
6060#endif
drh7d10d5a2008-08-20 16:35:10 +00006061 return WRC_Continue;
6062}
danielk1977b3bce662005-01-29 08:32:43 +00006063
drh979dd1b2017-05-29 14:26:07 +00006064#if SQLITE_DEBUG
6065/*
6066** Always assert. This xSelectCallback2 implementation proves that the
6067** xSelectCallback2 is never invoked.
6068*/
6069void sqlite3SelectWalkAssert2(Walker *NotUsed, Select *NotUsed2){
6070 UNUSED_PARAMETER2(NotUsed, NotUsed2);
6071 assert( 0 );
6072}
6073#endif
6074/*
drh7d10d5a2008-08-20 16:35:10 +00006075** This routine "expands" a SELECT statement and all of its subqueries.
6076** For additional information on what it means to "expand" a SELECT
6077** statement, see the comment on the selectExpand worker callback above.
6078**
6079** Expanding a SELECT statement is the first step in processing a
6080** SELECT statement. The SELECT statement must be expanded before
6081** name resolution is performed.
6082**
6083** If anything goes wrong, an error message is written into pParse.
6084** The calling function can detect the problem by looking at pParse->nErr
6085** and/or pParse->db->mallocFailed.
6086*/
6087static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
6088 Walker w;
drh5b88bc42013-12-07 23:35:21 +00006089 w.xExprCallback = sqlite3ExprWalkNoop;
drh7d10d5a2008-08-20 16:35:10 +00006090 w.pParse = pParse;
drh878fcf92017-10-02 23:50:08 +00006091 if( OK_IF_ALWAYS_TRUE(pParse->hasCompound) ){
drhd58d3272013-08-05 22:05:02 +00006092 w.xSelectCallback = convertCompoundSelectToSubquery;
drh979dd1b2017-05-29 14:26:07 +00006093 w.xSelectCallback2 = 0;
drhd58d3272013-08-05 22:05:02 +00006094 sqlite3WalkSelect(&w, pSelect);
6095 }
drhc01b7302013-05-07 17:49:08 +00006096 w.xSelectCallback = selectExpander;
danbe120832021-05-17 16:20:41 +00006097 w.xSelectCallback2 = sqlite3SelectPopWith;
drh59145812019-05-22 22:49:23 +00006098 w.eCode = 0;
drhc01b7302013-05-07 17:49:08 +00006099 sqlite3WalkSelect(&w, pSelect);
drh7d10d5a2008-08-20 16:35:10 +00006100}
6101
6102
6103#ifndef SQLITE_OMIT_SUBQUERY
6104/*
6105** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
6106** interface.
6107**
6108** For each FROM-clause subquery, add Column.zType and Column.zColl
6109** information to the Table structure that represents the result set
6110** of that subquery.
6111**
6112** The Table structure that represents the result set was constructed
6113** by selectExpander() but the type and collation information was omitted
6114** at that point because identifiers had not yet been resolved. This
6115** routine is called after identifier resolution.
6116*/
danb290f112014-01-17 14:59:27 +00006117static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
drh7d10d5a2008-08-20 16:35:10 +00006118 Parse *pParse;
6119 int i;
6120 SrcList *pTabList;
drh76012942021-02-21 21:04:54 +00006121 SrcItem *pFrom;
drh7d10d5a2008-08-20 16:35:10 +00006122
drh9d8b3072008-08-22 16:29:51 +00006123 assert( p->selFlags & SF_Resolved );
dancc464412018-06-19 18:11:05 +00006124 if( p->selFlags & SF_HasTypeInfo ) return;
drhe2b7d7a2015-09-29 15:50:04 +00006125 p->selFlags |= SF_HasTypeInfo;
6126 pParse = pWalker->pParse;
6127 pTabList = p->pSrc;
6128 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
6129 Table *pTab = pFrom->pTab;
6130 assert( pTab!=0 );
6131 if( (pTab->tabFlags & TF_Ephemeral)!=0 ){
6132 /* A sub-query in the FROM clause of a SELECT */
6133 Select *pSel = pFrom->pSelect;
6134 if( pSel ){
6135 while( pSel->pPrior ) pSel = pSel->pPrior;
drh96fb16e2019-08-06 14:37:24 +00006136 sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSel,
6137 SQLITE_AFF_NONE);
drh5a29d9c2010-02-24 15:10:14 +00006138 }
drh13449892005-09-07 21:22:45 +00006139 }
6140 }
drh7d10d5a2008-08-20 16:35:10 +00006141}
6142#endif
drh13449892005-09-07 21:22:45 +00006143
drh7d10d5a2008-08-20 16:35:10 +00006144
6145/*
6146** This routine adds datatype and collating sequence information to
6147** the Table structures of all FROM-clause subqueries in a
6148** SELECT statement.
6149**
6150** Use this routine after name resolution.
6151*/
6152static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
6153#ifndef SQLITE_OMIT_SUBQUERY
6154 Walker w;
drh979dd1b2017-05-29 14:26:07 +00006155 w.xSelectCallback = sqlite3SelectWalkNoop;
danb290f112014-01-17 14:59:27 +00006156 w.xSelectCallback2 = selectAddSubqueryTypeInfo;
drh5b88bc42013-12-07 23:35:21 +00006157 w.xExprCallback = sqlite3ExprWalkNoop;
drh7d10d5a2008-08-20 16:35:10 +00006158 w.pParse = pParse;
6159 sqlite3WalkSelect(&w, pSelect);
6160#endif
6161}
6162
6163
6164/*
drh030796d2012-08-23 16:18:10 +00006165** This routine sets up a SELECT statement for processing. The
drh7d10d5a2008-08-20 16:35:10 +00006166** following is accomplished:
6167**
6168** * VDBE Cursor numbers are assigned to all FROM-clause terms.
6169** * Ephemeral Table objects are created for all FROM-clause subqueries.
6170** * ON and USING clauses are shifted into WHERE statements
6171** * Wildcards "*" and "TABLE.*" in result sets are expanded.
6172** * Identifiers in expression are matched to tables.
6173**
6174** This routine acts recursively on all subqueries within the SELECT.
6175*/
6176void sqlite3SelectPrep(
6177 Parse *pParse, /* The parser context */
6178 Select *p, /* The SELECT statement being coded. */
6179 NameContext *pOuterNC /* Name context for container */
6180){
drhe2463392017-10-03 14:24:24 +00006181 assert( p!=0 || pParse->db->mallocFailed );
drh0c7d3d32022-01-24 16:47:12 +00006182 assert( pParse->db->pParse==pParse );
drhe2463392017-10-03 14:24:24 +00006183 if( pParse->db->mallocFailed ) return;
drh7d10d5a2008-08-20 16:35:10 +00006184 if( p->selFlags & SF_HasTypeInfo ) return;
drh7d10d5a2008-08-20 16:35:10 +00006185 sqlite3SelectExpand(pParse, p);
drh0c7d3d32022-01-24 16:47:12 +00006186 if( pParse->nErr ) return;
drh7d10d5a2008-08-20 16:35:10 +00006187 sqlite3ResolveSelectNames(pParse, p, pOuterNC);
drh0c7d3d32022-01-24 16:47:12 +00006188 if( pParse->nErr ) return;
drh7d10d5a2008-08-20 16:35:10 +00006189 sqlite3SelectAddTypeInfo(pParse, p);
danielk1977b3bce662005-01-29 08:32:43 +00006190}
6191
6192/*
drh13449892005-09-07 21:22:45 +00006193** Reset the aggregate accumulator.
6194**
6195** The aggregate accumulator is a set of memory cells that hold
6196** intermediate results while calculating an aggregate. This
drh030796d2012-08-23 16:18:10 +00006197** routine generates code that stores NULLs in all of those memory
6198** cells.
danielk1977b3bce662005-01-29 08:32:43 +00006199*/
drh13449892005-09-07 21:22:45 +00006200static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
6201 Vdbe *v = pParse->pVdbe;
6202 int i;
drhc99130f2005-09-11 11:56:27 +00006203 struct AggInfo_func *pFunc;
drh7e61d182013-12-20 13:11:45 +00006204 int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
drh0c7d3d32022-01-24 16:47:12 +00006205 assert( pParse->db->pParse==pParse );
6206 assert( pParse->db->mallocFailed==0 || pParse->nErr!=0 );
drh7e61d182013-12-20 13:11:45 +00006207 if( nReg==0 ) return;
drh0c7d3d32022-01-24 16:47:12 +00006208 if( pParse->nErr ) return;
drh7e61d182013-12-20 13:11:45 +00006209#ifdef SQLITE_DEBUG
6210 /* Verify that all AggInfo registers are within the range specified by
6211 ** AggInfo.mnReg..AggInfo.mxReg */
6212 assert( nReg==pAggInfo->mxReg-pAggInfo->mnReg+1 );
drh13449892005-09-07 21:22:45 +00006213 for(i=0; i<pAggInfo->nColumn; i++){
drh7e61d182013-12-20 13:11:45 +00006214 assert( pAggInfo->aCol[i].iMem>=pAggInfo->mnReg
6215 && pAggInfo->aCol[i].iMem<=pAggInfo->mxReg );
drh13449892005-09-07 21:22:45 +00006216 }
drh7e61d182013-12-20 13:11:45 +00006217 for(i=0; i<pAggInfo->nFunc; i++){
6218 assert( pAggInfo->aFunc[i].iMem>=pAggInfo->mnReg
6219 && pAggInfo->aFunc[i].iMem<=pAggInfo->mxReg );
6220 }
6221#endif
6222 sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->mnReg, pAggInfo->mxReg);
drhc99130f2005-09-11 11:56:27 +00006223 for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
drhc99130f2005-09-11 11:56:27 +00006224 if( pFunc->iDistinct>=0 ){
drh81185a52020-06-09 13:38:12 +00006225 Expr *pE = pFunc->pFExpr;
drha4eeccd2021-10-07 17:43:30 +00006226 assert( ExprUseXList(pE) );
danielk19776ab3a2e2009-02-19 14:39:25 +00006227 if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
drh0daa0022009-02-09 13:19:28 +00006228 sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
6229 "argument");
drhc99130f2005-09-11 11:56:27 +00006230 pFunc->iDistinct = -1;
6231 }else{
danf9eae182018-05-21 19:45:11 +00006232 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pE->x.pList,0,0);
dan4fcb30b2021-03-09 16:06:25 +00006233 pFunc->iDistAddr = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
6234 pFunc->iDistinct, 0, 0, (char*)pKeyInfo, P4_KEYINFO);
drh9be13392021-03-24 19:44:01 +00006235 ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s(DISTINCT)",
6236 pFunc->pFunc->zName));
drhc99130f2005-09-11 11:56:27 +00006237 }
6238 }
drh13449892005-09-07 21:22:45 +00006239 }
danielk1977b3bce662005-01-29 08:32:43 +00006240}
6241
6242/*
drh13449892005-09-07 21:22:45 +00006243** Invoke the OP_AggFinalize opcode for every aggregate function
6244** in the AggInfo structure.
danielk1977b3bce662005-01-29 08:32:43 +00006245*/
drh13449892005-09-07 21:22:45 +00006246static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
6247 Vdbe *v = pParse->pVdbe;
6248 int i;
6249 struct AggInfo_func *pF;
6250 for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
drha4eeccd2021-10-07 17:43:30 +00006251 ExprList *pList;
6252 assert( ExprUseXList(pF->pFExpr) );
6253 pList = pF->pFExpr->x.pList;
drh2700aca2016-12-08 01:38:24 +00006254 sqlite3VdbeAddOp2(v, OP_AggFinal, pF->iMem, pList ? pList->nExpr : 0);
6255 sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
drh13449892005-09-07 21:22:45 +00006256 }
danielk1977b3bce662005-01-29 08:32:43 +00006257}
drh13449892005-09-07 21:22:45 +00006258
dan280c8942018-06-05 20:04:28 +00006259
drh13449892005-09-07 21:22:45 +00006260/*
6261** Update the accumulator memory cells for an aggregate based on
6262** the current cursor position.
dan280c8942018-06-05 20:04:28 +00006263**
6264** If regAcc is non-zero and there are no min() or max() aggregates
6265** in pAggInfo, then only populate the pAggInfo->nAccumulator accumulator
drh10cc16c2019-03-01 21:12:40 +00006266** registers if register regAcc contains 0. The caller will take care
dan280c8942018-06-05 20:04:28 +00006267** of setting and clearing regAcc.
drh13449892005-09-07 21:22:45 +00006268*/
dan4fcb30b2021-03-09 16:06:25 +00006269static void updateAccumulator(
6270 Parse *pParse,
6271 int regAcc,
6272 AggInfo *pAggInfo,
6273 int eDistinctType
6274){
drh13449892005-09-07 21:22:45 +00006275 Vdbe *v = pParse->pVdbe;
6276 int i;
drh7a957892012-02-02 17:35:43 +00006277 int regHit = 0;
6278 int addrHitTest = 0;
drh13449892005-09-07 21:22:45 +00006279 struct AggInfo_func *pF;
6280 struct AggInfo_col *pC;
drh13449892005-09-07 21:22:45 +00006281
6282 pAggInfo->directMode = 1;
6283 for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
6284 int nArg;
drhc99130f2005-09-11 11:56:27 +00006285 int addrNext = 0;
drh98757152008-01-09 23:04:12 +00006286 int regAgg;
drha4eeccd2021-10-07 17:43:30 +00006287 ExprList *pList;
6288 assert( ExprUseXList(pF->pFExpr) );
drh81185a52020-06-09 13:38:12 +00006289 assert( !IsWindowFunc(pF->pFExpr) );
drha4eeccd2021-10-07 17:43:30 +00006290 pList = pF->pFExpr->x.pList;
drh81185a52020-06-09 13:38:12 +00006291 if( ExprHasProperty(pF->pFExpr, EP_WinFunc) ){
6292 Expr *pFilter = pF->pFExpr->y.pWin->pFilter;
daned09ddd2019-09-20 20:52:16 +00006293 if( pAggInfo->nAccumulator
6294 && (pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL)
danfa4b0d42020-07-01 14:07:45 +00006295 && regAcc
daned09ddd2019-09-20 20:52:16 +00006296 ){
danfa4b0d42020-07-01 14:07:45 +00006297 /* If regAcc==0, there there exists some min() or max() function
6298 ** without a FILTER clause that will ensure the magnet registers
6299 ** are populated. */
daned09ddd2019-09-20 20:52:16 +00006300 if( regHit==0 ) regHit = ++pParse->nMem;
danfa4b0d42020-07-01 14:07:45 +00006301 /* If this is the first row of the group (regAcc contains 0), clear the
daned09ddd2019-09-20 20:52:16 +00006302 ** "magnet" register regHit so that the accumulator registers
danaf9b58b2019-09-20 21:12:40 +00006303 ** are populated if the FILTER clause jumps over the the
6304 ** invocation of min() or max() altogether. Or, if this is not
danfa4b0d42020-07-01 14:07:45 +00006305 ** the first row (regAcc contains 1), set the magnet register so that
6306 ** the accumulators are not populated unless the min()/max() is invoked
6307 ** and indicates that they should be. */
daned09ddd2019-09-20 20:52:16 +00006308 sqlite3VdbeAddOp2(v, OP_Copy, regAcc, regHit);
6309 }
dan6ba7ab02019-07-02 11:56:47 +00006310 addrNext = sqlite3VdbeMakeLabel(pParse);
6311 sqlite3ExprIfFalse(pParse, pFilter, addrNext, SQLITE_JUMPIFNULL);
6312 }
drh13449892005-09-07 21:22:45 +00006313 if( pList ){
6314 nArg = pList->nExpr;
drh892d3172008-01-10 03:46:36 +00006315 regAgg = sqlite3GetTempRange(pParse, nArg);
drh5579d592015-08-26 14:01:41 +00006316 sqlite3ExprCodeExprList(pParse, pList, regAgg, 0, SQLITE_ECEL_DUP);
drh13449892005-09-07 21:22:45 +00006317 }else{
6318 nArg = 0;
drh98757152008-01-09 23:04:12 +00006319 regAgg = 0;
drh13449892005-09-07 21:22:45 +00006320 }
dan4fcb30b2021-03-09 16:06:25 +00006321 if( pF->iDistinct>=0 && pList ){
dan6ba7ab02019-07-02 11:56:47 +00006322 if( addrNext==0 ){
6323 addrNext = sqlite3VdbeMakeLabel(pParse);
6324 }
dan5383db72021-03-12 18:24:31 +00006325 pF->iDistinct = codeDistinct(pParse, eDistinctType,
6326 pF->iDistinct, addrNext, pList, regAgg);
drhc99130f2005-09-11 11:56:27 +00006327 }
drhd36e1042013-09-06 13:10:12 +00006328 if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh13449892005-09-07 21:22:45 +00006329 CollSeq *pColl = 0;
6330 struct ExprList_item *pItem;
6331 int j;
drhe82f5d02008-10-07 19:53:14 +00006332 assert( pList!=0 ); /* pList!=0 if pF->pFunc has NEEDCOLL */
drh43617e92006-03-06 20:55:46 +00006333 for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
drh13449892005-09-07 21:22:45 +00006334 pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
6335 }
6336 if( !pColl ){
6337 pColl = pParse->db->pDfltColl;
6338 }
drh7a957892012-02-02 17:35:43 +00006339 if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
6340 sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
drh13449892005-09-07 21:22:45 +00006341 }
drh8f26da62018-07-05 21:22:57 +00006342 sqlite3VdbeAddOp3(v, OP_AggStep, 0, regAgg, pF->iMem);
drh2700aca2016-12-08 01:38:24 +00006343 sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
drhea678832008-12-10 19:26:22 +00006344 sqlite3VdbeChangeP5(v, (u8)nArg);
drhf49f3522009-12-30 14:12:38 +00006345 sqlite3ReleaseTempRange(pParse, regAgg, nArg);
drhc99130f2005-09-11 11:56:27 +00006346 if( addrNext ){
6347 sqlite3VdbeResolveLabel(v, addrNext);
6348 }
drh13449892005-09-07 21:22:45 +00006349 }
dan280c8942018-06-05 20:04:28 +00006350 if( regHit==0 && pAggInfo->nAccumulator ){
6351 regHit = regAcc;
6352 }
drh7a957892012-02-02 17:35:43 +00006353 if( regHit ){
drh688852a2014-02-17 22:40:43 +00006354 addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
drh7a957892012-02-02 17:35:43 +00006355 }
drh13449892005-09-07 21:22:45 +00006356 for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
drh81185a52020-06-09 13:38:12 +00006357 sqlite3ExprCode(pParse, pC->pCExpr, pC->iMem);
drh13449892005-09-07 21:22:45 +00006358 }
daned09ddd2019-09-20 20:52:16 +00006359
drh13449892005-09-07 21:22:45 +00006360 pAggInfo->directMode = 0;
drh7a957892012-02-02 17:35:43 +00006361 if( addrHitTest ){
drhdc4f6fc2020-02-07 19:44:13 +00006362 sqlite3VdbeJumpHereOrPopInst(v, addrHitTest);
drh7a957892012-02-02 17:35:43 +00006363 }
drh13449892005-09-07 21:22:45 +00006364}
6365
danielk1977b3bce662005-01-29 08:32:43 +00006366/*
danef7075d2011-02-21 17:49:49 +00006367** Add a single OP_Explain instruction to the VDBE to explain a simple
6368** count(*) query ("SELECT count(*) FROM pTab").
6369*/
6370#ifndef SQLITE_OMIT_EXPLAIN
6371static void explainSimpleCount(
6372 Parse *pParse, /* Parse context */
6373 Table *pTab, /* Table being queried */
6374 Index *pIdx /* Index used to optimize scan, or NULL */
6375){
6376 if( pParse->explain==2 ){
drh48dd1d82014-05-27 18:18:58 +00006377 int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
drh82102332021-03-20 15:11:29 +00006378 sqlite3VdbeExplain(pParse, 0, "SCAN %s%s%s",
dane96f2df2014-05-23 17:17:06 +00006379 pTab->zName,
6380 bCover ? " USING COVERING INDEX " : "",
6381 bCover ? pIdx->zName : ""
danef7075d2011-02-21 17:49:49 +00006382 );
danef7075d2011-02-21 17:49:49 +00006383 }
6384}
6385#else
6386# define explainSimpleCount(a,b,c)
6387#endif
6388
6389/*
danab31a842017-04-29 20:53:09 +00006390** sqlite3WalkExpr() callback used by havingToWhere().
6391**
6392** If the node passed to the callback is a TK_AND node, return
6393** WRC_Continue to tell sqlite3WalkExpr() to iterate through child nodes.
6394**
6395** Otherwise, return WRC_Prune. In this case, also check if the
6396** sub-expression matches the criteria for being moved to the WHERE
6397** clause. If so, add it to the WHERE clause and replace the sub-expression
6398** within the HAVING expression with a constant "1".
6399*/
6400static int havingToWhereExprCb(Walker *pWalker, Expr *pExpr){
6401 if( pExpr->op!=TK_AND ){
drhcd0abc22018-03-20 18:08:33 +00006402 Select *pS = pWalker->u.pSelect;
dand59f9832021-07-20 14:57:49 +00006403 /* This routine is called before the HAVING clause of the current
6404 ** SELECT is analyzed for aggregates. So if pExpr->pAggInfo is set
6405 ** here, it indicates that the expression is a correlated reference to a
6406 ** column from an outer aggregate query, or an aggregate function that
6407 ** belongs to an outer query. Do not move the expression to the WHERE
6408 ** clause in this obscure case, as doing so may corrupt the outer Select
6409 ** statements AggInfo structure. */
danf39168e2020-12-22 16:23:29 +00006410 if( sqlite3ExprIsConstantOrGroupBy(pWalker->pParse, pExpr, pS->pGroupBy)
6411 && ExprAlwaysFalse(pExpr)==0
dand59f9832021-07-20 14:57:49 +00006412 && pExpr->pAggInfo==0
danf39168e2020-12-22 16:23:29 +00006413 ){
danab31a842017-04-29 20:53:09 +00006414 sqlite3 *db = pWalker->pParse->db;
drh5776ee52019-09-23 12:38:10 +00006415 Expr *pNew = sqlite3Expr(db, TK_INTEGER, "1");
danab31a842017-04-29 20:53:09 +00006416 if( pNew ){
drhcd0abc22018-03-20 18:08:33 +00006417 Expr *pWhere = pS->pWhere;
danab31a842017-04-29 20:53:09 +00006418 SWAP(Expr, *pNew, *pExpr);
drhd5c851c2019-04-19 13:38:34 +00006419 pNew = sqlite3ExprAnd(pWalker->pParse, pWhere, pNew);
drhcd0abc22018-03-20 18:08:33 +00006420 pS->pWhere = pNew;
6421 pWalker->eCode = 1;
danab31a842017-04-29 20:53:09 +00006422 }
6423 }
6424 return WRC_Prune;
6425 }
6426 return WRC_Continue;
6427}
6428
6429/*
6430** Transfer eligible terms from the HAVING clause of a query, which is
6431** processed after grouping, to the WHERE clause, which is processed before
6432** grouping. For example, the query:
6433**
6434** SELECT * FROM <tables> WHERE a=? GROUP BY b HAVING b=? AND c=?
6435**
6436** can be rewritten as:
6437**
6438** SELECT * FROM <tables> WHERE a=? AND b=? GROUP BY b HAVING c=?
6439**
6440** A term of the HAVING expression is eligible for transfer if it consists
6441** entirely of constants and expressions that are also GROUP BY terms that
6442** use the "BINARY" collation sequence.
6443*/
drhcd0abc22018-03-20 18:08:33 +00006444static void havingToWhere(Parse *pParse, Select *p){
danab31a842017-04-29 20:53:09 +00006445 Walker sWalker;
danab31a842017-04-29 20:53:09 +00006446 memset(&sWalker, 0, sizeof(sWalker));
6447 sWalker.pParse = pParse;
6448 sWalker.xExprCallback = havingToWhereExprCb;
drhcd0abc22018-03-20 18:08:33 +00006449 sWalker.u.pSelect = p;
6450 sqlite3WalkExpr(&sWalker, p->pHaving);
drh5e431be2022-04-06 11:08:38 +00006451#if TREETRACE_ENABLED
6452 if( sWalker.eCode && (sqlite3TreeTrace & 0x100)!=0 ){
drhcd0abc22018-03-20 18:08:33 +00006453 SELECTTRACE(0x100,pParse,p,("Move HAVING terms into WHERE:\n"));
6454 sqlite3TreeViewSelect(0, p, 0);
6455 }
6456#endif
danab31a842017-04-29 20:53:09 +00006457}
6458
6459/*
drhe08e8d62017-05-01 15:15:41 +00006460** Check to see if the pThis entry of pTabList is a self-join of a prior view.
6461** If it is, then return the SrcList_item for the prior view. If it is not,
6462** then return 0.
6463*/
drh76012942021-02-21 21:04:54 +00006464static SrcItem *isSelfJoinView(
drhe08e8d62017-05-01 15:15:41 +00006465 SrcList *pTabList, /* Search for self-joins in this FROM clause */
drh76012942021-02-21 21:04:54 +00006466 SrcItem *pThis /* Search for prior reference to this subquery */
drhe08e8d62017-05-01 15:15:41 +00006467){
drh76012942021-02-21 21:04:54 +00006468 SrcItem *pItem;
drh8794c682021-02-13 16:39:24 +00006469 assert( pThis->pSelect!=0 );
6470 if( pThis->pSelect->selFlags & SF_PushDown ) return 0;
drhe08e8d62017-05-01 15:15:41 +00006471 for(pItem = pTabList->a; pItem<pThis; pItem++){
drhbdefaf02018-12-27 02:16:01 +00006472 Select *pS1;
drhe08e8d62017-05-01 15:15:41 +00006473 if( pItem->pSelect==0 ) continue;
6474 if( pItem->fg.viaCoroutine ) continue;
drh33543c22017-05-01 16:37:20 +00006475 if( pItem->zName==0 ) continue;
drh30ad79a2019-05-23 16:38:12 +00006476 assert( pItem->pTab!=0 );
6477 assert( pThis->pTab!=0 );
6478 if( pItem->pTab->pSchema!=pThis->pTab->pSchema ) continue;
drhed712982017-05-01 17:04:35 +00006479 if( sqlite3_stricmp(pItem->zName, pThis->zName)!=0 ) continue;
drhbdefaf02018-12-27 02:16:01 +00006480 pS1 = pItem->pSelect;
drh30ad79a2019-05-23 16:38:12 +00006481 if( pItem->pTab->pSchema==0 && pThis->pSelect->selId!=pS1->selId ){
drhbdefaf02018-12-27 02:16:01 +00006482 /* The query flattener left two different CTE tables with identical
6483 ** names in the same FROM clause. */
6484 continue;
6485 }
drh8794c682021-02-13 16:39:24 +00006486 if( pItem->pSelect->selFlags & SF_PushDown ){
drhed712982017-05-01 17:04:35 +00006487 /* The view was modified by some other optimization such as
6488 ** pushDownWhereTerms() */
6489 continue;
6490 }
6491 return pItem;
drhe08e8d62017-05-01 15:15:41 +00006492 }
6493 return 0;
6494}
6495
drhc54246f2021-02-17 21:13:14 +00006496/*
6497** Deallocate a single AggInfo object
6498*/
6499static void agginfoFree(sqlite3 *db, AggInfo *p){
6500 sqlite3DbFree(db, p->aCol);
6501 sqlite3DbFree(db, p->aFunc);
6502 sqlite3DbFreeNN(db, p);
6503}
6504
drh269ba802017-07-04 19:34:36 +00006505#ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6506/*
6507** Attempt to transform a query of the form
6508**
6509** SELECT count(*) FROM (SELECT x FROM t1 UNION ALL SELECT y FROM t2)
6510**
6511** Into this:
6512**
6513** SELECT (SELECT count(*) FROM t1)+(SELECT count(*) FROM t2)
6514**
6515** The transformation only works if all of the following are true:
6516**
6517** * The subquery is a UNION ALL of two or more terms
dana4b5fb52018-08-03 20:19:52 +00006518** * The subquery does not have a LIMIT clause
drh269ba802017-07-04 19:34:36 +00006519** * There is no WHERE or GROUP BY or HAVING clauses on the subqueries
drh73c53b32019-05-15 18:42:15 +00006520** * The outer query is a simple count(*) with no WHERE clause or other
6521** extraneous syntax.
drh269ba802017-07-04 19:34:36 +00006522**
6523** Return TRUE if the optimization is undertaken.
6524*/
6525static int countOfViewOptimization(Parse *pParse, Select *p){
6526 Select *pSub, *pPrior;
6527 Expr *pExpr;
6528 Expr *pCount;
6529 sqlite3 *db;
drh3d240d22017-09-28 16:56:55 +00006530 if( (p->selFlags & SF_Aggregate)==0 ) return 0; /* This is an aggregate */
drh269ba802017-07-04 19:34:36 +00006531 if( p->pEList->nExpr!=1 ) return 0; /* Single result column */
drh73c53b32019-05-15 18:42:15 +00006532 if( p->pWhere ) return 0;
6533 if( p->pGroupBy ) return 0;
drh269ba802017-07-04 19:34:36 +00006534 pExpr = p->pEList->a[0].pExpr;
6535 if( pExpr->op!=TK_AGG_FUNCTION ) return 0; /* Result is an aggregate */
drha4eeccd2021-10-07 17:43:30 +00006536 assert( ExprUseUToken(pExpr) );
drh3d240d22017-09-28 16:56:55 +00006537 if( sqlite3_stricmp(pExpr->u.zToken,"count") ) return 0; /* Is count() */
drha4eeccd2021-10-07 17:43:30 +00006538 assert( ExprUseXList(pExpr) );
drh269ba802017-07-04 19:34:36 +00006539 if( pExpr->x.pList!=0 ) return 0; /* Must be count(*) */
drh3d240d22017-09-28 16:56:55 +00006540 if( p->pSrc->nSrc!=1 ) return 0; /* One table in FROM */
drh269ba802017-07-04 19:34:36 +00006541 pSub = p->pSrc->a[0].pSelect;
6542 if( pSub==0 ) return 0; /* The FROM is a subquery */
drh3d240d22017-09-28 16:56:55 +00006543 if( pSub->pPrior==0 ) return 0; /* Must be a compound ry */
drh269ba802017-07-04 19:34:36 +00006544 do{
6545 if( pSub->op!=TK_ALL && pSub->pPrior ) return 0; /* Must be UNION ALL */
6546 if( pSub->pWhere ) return 0; /* No WHERE clause */
dana4b5fb52018-08-03 20:19:52 +00006547 if( pSub->pLimit ) return 0; /* No LIMIT clause */
drh269ba802017-07-04 19:34:36 +00006548 if( pSub->selFlags & SF_Aggregate ) return 0; /* Not an aggregate */
drh3d240d22017-09-28 16:56:55 +00006549 pSub = pSub->pPrior; /* Repeat over compound */
drh269ba802017-07-04 19:34:36 +00006550 }while( pSub );
6551
drh3d240d22017-09-28 16:56:55 +00006552 /* If we reach this point then it is OK to perform the transformation */
drh269ba802017-07-04 19:34:36 +00006553
6554 db = pParse->db;
6555 pCount = pExpr;
6556 pExpr = 0;
6557 pSub = p->pSrc->a[0].pSelect;
6558 p->pSrc->a[0].pSelect = 0;
6559 sqlite3SrcListDelete(db, p->pSrc);
6560 p->pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*p->pSrc));
6561 while( pSub ){
6562 Expr *pTerm;
6563 pPrior = pSub->pPrior;
6564 pSub->pPrior = 0;
6565 pSub->pNext = 0;
6566 pSub->selFlags |= SF_Aggregate;
6567 pSub->selFlags &= ~SF_Compound;
6568 pSub->nSelectRow = 0;
6569 sqlite3ExprListDelete(db, pSub->pEList);
6570 pTerm = pPrior ? sqlite3ExprDup(db, pCount, 0) : pCount;
6571 pSub->pEList = sqlite3ExprListAppend(pParse, 0, pTerm);
6572 pTerm = sqlite3PExpr(pParse, TK_SELECT, 0, 0);
6573 sqlite3PExprAddSelect(pParse, pTerm, pSub);
6574 if( pExpr==0 ){
6575 pExpr = pTerm;
6576 }else{
6577 pExpr = sqlite3PExpr(pParse, TK_PLUS, pTerm, pExpr);
6578 }
6579 pSub = pPrior;
6580 }
6581 p->pEList->a[0].pExpr = pExpr;
6582 p->selFlags &= ~SF_Aggregate;
6583
drh5e431be2022-04-06 11:08:38 +00006584#if TREETRACE_ENABLED
6585 if( sqlite3TreeTrace & 0x400 ){
drh269ba802017-07-04 19:34:36 +00006586 SELECTTRACE(0x400,pParse,p,("After count-of-view optimization:\n"));
6587 sqlite3TreeViewSelect(0, p, 0);
6588 }
6589#endif
6590 return 1;
6591}
6592#endif /* SQLITE_COUNTOFVIEW_OPTIMIZATION */
6593
drhe08e8d62017-05-01 15:15:41 +00006594/*
drhfb98dac2022-05-25 02:32:11 +00006595** If any term of pSrc, or any SF_NestedFrom sub-query, is not the same
6596** as pSrcItem but has the same alias as p0, then return true.
6597** Otherwise return false.
6598*/
6599static int sameSrcAlias(SrcItem *p0, SrcList *pSrc){
6600 int i;
6601 for(i=0; i<pSrc->nSrc; i++){
6602 SrcItem *p1 = &pSrc->a[i];
6603 if( p1==p0 ) continue;
6604 if( p0->pTab==p1->pTab && 0==sqlite3_stricmp(p0->zAlias, p1->zAlias) ){
6605 return 1;
6606 }
6607 if( p1->pSelect
6608 && (p1->pSelect->selFlags & SF_NestedFrom)!=0
6609 && sameSrcAlias(p0, p1->pSelect->pSrc)
6610 ){
6611 return 1;
6612 }
6613 }
6614 return 0;
6615}
6616
6617/*
drh7d10d5a2008-08-20 16:35:10 +00006618** Generate code for the SELECT statement given in the p argument.
drh9bb61fe2000-06-05 16:01:39 +00006619**
drh340309f2014-01-22 00:23:49 +00006620** The results are returned according to the SelectDest structure.
6621** See comments in sqliteInt.h for further information.
drhe78e8282003-01-19 03:59:45 +00006622**
drh9bb61fe2000-06-05 16:01:39 +00006623** This routine returns the number of errors. If any errors are
6624** encountered, then an appropriate error message is left in
6625** pParse->zErrMsg.
6626**
6627** This routine does NOT free the Select structure passed in. The
6628** calling function needs to do that.
6629*/
danielk19774adee202004-05-08 08:23:19 +00006630int sqlite3Select(
drhcce7d172000-05-31 15:34:51 +00006631 Parse *pParse, /* The parser context */
drh9bb61fe2000-06-05 16:01:39 +00006632 Select *p, /* The SELECT statement being coded. */
drh7d10d5a2008-08-20 16:35:10 +00006633 SelectDest *pDest /* What to do with the query results */
drhcce7d172000-05-31 15:34:51 +00006634){
drh13449892005-09-07 21:22:45 +00006635 int i, j; /* Loop counters */
6636 WhereInfo *pWInfo; /* Return from sqlite3WhereBegin() */
6637 Vdbe *v; /* The virtual machine under construction */
danielk1977b3bce662005-01-29 08:32:43 +00006638 int isAgg; /* True for select lists like "count(*)" */
mistachkinc29cbb02015-07-02 16:52:01 +00006639 ExprList *pEList = 0; /* List of columns to extract. */
drhad3cab52002-05-24 02:04:32 +00006640 SrcList *pTabList; /* List of tables to select from */
drh9bb61fe2000-06-05 16:01:39 +00006641 Expr *pWhere; /* The WHERE clause. May be NULL */
drh22827922000-06-06 17:27:05 +00006642 ExprList *pGroupBy; /* The GROUP BY clause. May be NULL */
6643 Expr *pHaving; /* The HAVING clause. May be NULL */
drhbf790972020-06-07 20:18:07 +00006644 AggInfo *pAggInfo = 0; /* Aggregate information */
drh1d83f052002-02-17 00:30:36 +00006645 int rc = 1; /* Value to return from this function */
drhe8e4af72012-09-21 00:04:28 +00006646 DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
drh079a3072014-03-19 14:10:55 +00006647 SortCtx sSort; /* Info on how to code the ORDER BY clause */
drhec7429a2005-10-06 16:53:14 +00006648 int iEnd; /* Address of the end of the query */
drh17435752007-08-16 04:30:38 +00006649 sqlite3 *db; /* The database connection */
drh47d9f832017-10-26 20:04:28 +00006650 ExprList *pMinMaxOrderBy = 0; /* Added ORDER BY for min/max queries */
6651 u8 minMaxFlag; /* Flag for min/max queries */
drh9bb61fe2000-06-05 16:01:39 +00006652
drh17435752007-08-16 04:30:38 +00006653 db = pParse->db;
drh0c7d3d32022-01-24 16:47:12 +00006654 assert( pParse==db->pParse );
drhe2ca99c2018-05-02 00:33:43 +00006655 v = sqlite3GetVdbe(pParse);
drh0c7d3d32022-01-24 16:47:12 +00006656 if( p==0 || pParse->nErr ){
drh6f7adc82006-01-11 21:41:20 +00006657 return 1;
6658 }
drh0c7d3d32022-01-24 16:47:12 +00006659 assert( db->mallocFailed==0 );
danielk19774adee202004-05-08 08:23:19 +00006660 if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
drh5e431be2022-04-06 11:08:38 +00006661#if TREETRACE_ENABLED
drhe2ca99c2018-05-02 00:33:43 +00006662 SELECTTRACE(1,pParse,p, ("begin processing:\n", pParse->addrExplain));
drhc2d0df92022-04-06 18:30:17 +00006663 if( sqlite3TreeTrace & 0x10100 ){
6664 if( (sqlite3TreeTrace & 0x10001)==0x10000 ){
6665 sqlite3TreeViewLine(0, "In sqlite3Select() at %s:%d",
6666 __FILE__, __LINE__);
6667 }
6668 sqlite3ShowSelect(p);
drhc90713d2014-09-30 13:46:49 +00006669 }
drheb9b8842014-09-21 00:27:26 +00006670#endif
drhdaffd0e2001-04-11 14:28:42 +00006671
drh8e1ee882014-03-21 19:56:09 +00006672 assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
6673 assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
dan9afccba2014-03-21 19:27:54 +00006674 assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
6675 assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
drhf1ea4252020-09-17 00:46:09 +00006676 if( IgnorableDistinct(pDest) ){
6677 assert(pDest->eDest==SRT_Exists || pDest->eDest==SRT_Union ||
6678 pDest->eDest==SRT_Except || pDest->eDest==SRT_Discard ||
6679 pDest->eDest==SRT_DistQueue || pDest->eDest==SRT_DistFifo );
6680 /* All of these destinations are also able to ignore the ORDER BY clause */
drhfad1ad02021-03-03 14:07:52 +00006681 if( p->pOrderBy ){
drh5e431be2022-04-06 11:08:38 +00006682#if TREETRACE_ENABLED
drhfad1ad02021-03-03 14:07:52 +00006683 SELECTTRACE(1,pParse,p, ("dropping superfluous ORDER BY:\n"));
drh5e431be2022-04-06 11:08:38 +00006684 if( sqlite3TreeTrace & 0x100 ){
drhfad1ad02021-03-03 14:07:52 +00006685 sqlite3TreeViewExprList(0, p->pOrderBy, 0, "ORDERBY");
6686 }
6687#endif
6688 sqlite3ParserAddCleanup(pParse,
6689 (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
6690 p->pOrderBy);
drh6d0053c2021-03-09 19:32:37 +00006691 testcase( pParse->earlyCleanup );
drhfad1ad02021-03-03 14:07:52 +00006692 p->pOrderBy = 0;
6693 }
drh7d10d5a2008-08-20 16:35:10 +00006694 p->selFlags &= ~SF_Distinct;
drhb7cbf5c2020-06-15 13:51:34 +00006695 p->selFlags |= SF_NoopOrderBy;
drh9a993342007-12-13 02:45:31 +00006696 }
drh7d10d5a2008-08-20 16:35:10 +00006697 sqlite3SelectPrep(pParse, p, 0);
drh0c7d3d32022-01-24 16:47:12 +00006698 if( pParse->nErr ){
drh9a993342007-12-13 02:45:31 +00006699 goto select_end;
6700 }
drh0c7d3d32022-01-24 16:47:12 +00006701 assert( db->mallocFailed==0 );
drhadc57f62015-06-06 00:18:01 +00006702 assert( p->pEList!=0 );
drh5e431be2022-04-06 11:08:38 +00006703#if TREETRACE_ENABLED
6704 if( sqlite3TreeTrace & 0x104 ){
drhe2243d22018-04-23 17:18:03 +00006705 SELECTTRACE(0x104,pParse,p, ("after name resolution:\n"));
drh17645f52015-02-09 13:42:59 +00006706 sqlite3TreeViewSelect(0, p, 0);
6707 }
6708#endif
drhcce7d172000-05-31 15:34:51 +00006709
dan5daf69e2021-07-05 11:27:13 +00006710 /* If the SF_UFSrcCheck flag is set, then this function is being called
dan07ca7d62020-07-17 16:31:37 +00006711 ** as part of populating the temp table for an UPDATE...FROM statement.
6712 ** In this case, it is an error if the target object (pSrc->a[0]) name
dan5daf69e2021-07-05 11:27:13 +00006713 ** or alias is duplicated within FROM clause (pSrc->a[1..n]).
6714 **
6715 ** Postgres disallows this case too. The reason is that some other
6716 ** systems handle this case differently, and not all the same way,
6717 ** which is just confusing. To avoid this, we follow PG's lead and
6718 ** disallow it altogether. */
6719 if( p->selFlags & SF_UFSrcCheck ){
drh76012942021-02-21 21:04:54 +00006720 SrcItem *p0 = &p->pSrc->a[0];
drhfb98dac2022-05-25 02:32:11 +00006721 if( sameSrcAlias(p0, p->pSrc) ){
6722 sqlite3ErrorMsg(pParse,
6723 "target object/alias may not appear in FROM clause: %s",
6724 p0->zAlias ? p0->zAlias : p0->pTab->zName
6725 );
6726 goto select_end;
dan07ca7d62020-07-17 16:31:37 +00006727 }
dan5daf69e2021-07-05 11:27:13 +00006728
6729 /* Clear the SF_UFSrcCheck flag. The check has already been performed,
6730 ** and leaving this flag set can cause errors if a compound sub-query
6731 ** in p->pSrc is flattened into this query and this function called
6732 ** again as part of compound SELECT processing. */
6733 p->selFlags &= ~SF_UFSrcCheck;
dan07ca7d62020-07-17 16:31:37 +00006734 }
6735
drhf35f2f92017-07-29 16:01:55 +00006736 if( pDest->eDest==SRT_Output ){
drh90881862021-05-19 12:17:03 +00006737 sqlite3GenerateColumnNames(pParse, p);
drhf35f2f92017-07-29 16:01:55 +00006738 }
6739
dan67a9b8e2018-06-22 20:51:35 +00006740#ifndef SQLITE_OMIT_WINDOWFUNC
dan44918c72021-04-17 14:42:37 +00006741 if( sqlite3WindowRewrite(pParse, p) ){
drh0c7d3d32022-01-24 16:47:12 +00006742 assert( pParse->nErr );
dan86fb6e12018-05-16 20:58:07 +00006743 goto select_end;
6744 }
drh5e431be2022-04-06 11:08:38 +00006745#if TREETRACE_ENABLED
6746 if( p->pWin && (sqlite3TreeTrace & 0x108)!=0 ){
dandfa552f2018-06-02 21:04:28 +00006747 SELECTTRACE(0x104,pParse,p, ("after window rewrite:\n"));
6748 sqlite3TreeViewSelect(0, p, 0);
6749 }
6750#endif
dan67a9b8e2018-06-22 20:51:35 +00006751#endif /* SQLITE_OMIT_WINDOWFUNC */
dan86fb6e12018-05-16 20:58:07 +00006752 pTabList = p->pSrc;
dan73925692018-06-12 18:40:17 +00006753 isAgg = (p->selFlags & SF_Aggregate)!=0;
danf02cdd32018-06-27 19:48:50 +00006754 memset(&sSort, 0, sizeof(sSort));
6755 sSort.pOrderBy = p->pOrderBy;
dan86fb6e12018-05-16 20:58:07 +00006756
drh9216de82020-06-11 00:57:09 +00006757 /* Try to do various optimizations (flattening subqueries, and strength
drh25897872018-03-20 21:16:15 +00006758 ** reduction of join operators) in the FROM clause up into the main query
drhd820cb12002-02-18 03:21:45 +00006759 */
drh51522cd2005-01-20 13:36:19 +00006760#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
danielk1977f23329a2008-07-01 14:09:13 +00006761 for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
drh76012942021-02-21 21:04:54 +00006762 SrcItem *pItem = &pTabList->a[i];
danielk1977daf79ac2008-06-30 18:12:28 +00006763 Select *pSub = pItem->pSelect;
drh2679f142015-09-25 13:42:55 +00006764 Table *pTab = pItem->pTab;
drh25897872018-03-20 21:16:15 +00006765
drhb5aaee52020-06-11 16:04:10 +00006766 /* The expander should have already created transient Table objects
6767 ** even for FROM clause elements such as subqueries that do not correspond
6768 ** to a real table */
6769 assert( pTab!=0 );
6770
drh25897872018-03-20 21:16:15 +00006771 /* Convert LEFT JOIN into JOIN if there are terms of the right table
6772 ** of the LEFT JOIN used in the WHERE clause.
6773 */
drhff02ac72022-04-11 14:43:11 +00006774 if( (pItem->fg.jointype & (JT_LEFT|JT_RIGHT))==JT_LEFT
drh25897872018-03-20 21:16:15 +00006775 && sqlite3ExprImpliesNonNullRow(p->pWhere, pItem->iCursor)
6776 && OptimizationEnabled(db, SQLITE_SimplifyJoin)
6777 ){
6778 SELECTTRACE(0x100,pParse,p,
6779 ("LEFT-JOIN simplifies to JOIN on term %d\n",i));
drhefce69d2018-03-20 22:52:27 +00006780 pItem->fg.jointype &= ~(JT_LEFT|JT_OUTER);
drhd7480402022-06-20 17:04:44 +00006781 assert( pItem->iCursor>=0 );
drh92d1afb2022-06-13 12:42:24 +00006782 unsetJoinExpr(p->pWhere, pItem->iCursor,
6783 pTabList->a[0].fg.jointype & JT_LTORJ);
drh25897872018-03-20 21:16:15 +00006784 }
6785
6786 /* No futher action if this term of the FROM clause is no a subquery */
drh4490c402015-06-05 22:33:39 +00006787 if( pSub==0 ) continue;
drh2679f142015-09-25 13:42:55 +00006788
6789 /* Catch mismatch in the declared columns of a view and the number of
6790 ** columns in the SELECT on the RHS */
6791 if( pTab->nCol!=pSub->pEList->nExpr ){
6792 sqlite3ErrorMsg(pParse, "expected %d columns for '%s' but got %d",
6793 pTab->nCol, pTab->zName, pSub->pEList->nExpr);
6794 goto select_end;
6795 }
6796
drh25c221e2017-09-29 22:13:24 +00006797 /* Do not try to flatten an aggregate subquery.
6798 **
6799 ** Flattening an aggregate subquery is only possible if the outer query
6800 ** is not a join. But if the outer query is not a join, then the subquery
6801 ** will be implemented as a co-routine and there is no advantage to
6802 ** flattening in that case.
6803 */
6804 if( (pSub->selFlags & SF_Aggregate)!=0 ) continue;
6805 assert( pSub->pGroupBy==0 );
6806
drhbb301232021-07-15 19:29:43 +00006807 /* If a FROM-clause subquery has an ORDER BY clause that is not
6808 ** really doing anything, then delete it now so that it does not
drh0fb78f02021-07-16 01:19:19 +00006809 ** interfere with query flattening. See the discussion at
6810 ** https://sqlite.org/forum/forumpost/2d76f2bcf65d256a
drhbb301232021-07-15 19:29:43 +00006811 **
6812 ** Beware of these cases where the ORDER BY clause may not be safely
6813 ** omitted:
6814 **
6815 ** (1) There is also a LIMIT clause
6816 ** (2) The subquery was added to help with window-function
6817 ** processing
drh0fb78f02021-07-16 01:19:19 +00006818 ** (3) The subquery is in the FROM clause of an UPDATE
6819 ** (4) The outer query uses an aggregate function other than
drhbb301232021-07-15 19:29:43 +00006820 ** the built-in count(), min(), or max().
drh0fb78f02021-07-16 01:19:19 +00006821 ** (5) The ORDER BY isn't going to accomplish anything because
6822 ** one of:
6823 ** (a) The outer query has a different ORDER BY clause
6824 ** (b) The subquery is part of a join
6825 ** See forum post 062d576715d277c8
drhbb301232021-07-15 19:29:43 +00006826 */
6827 if( pSub->pOrderBy!=0
drh0fb78f02021-07-16 01:19:19 +00006828 && (p->pOrderBy!=0 || pTabList->nSrc>1) /* Condition (5) */
drhbb301232021-07-15 19:29:43 +00006829 && pSub->pLimit==0 /* Condition (1) */
6830 && (pSub->selFlags & SF_OrderByReqd)==0 /* Condition (2) */
drh0fb78f02021-07-16 01:19:19 +00006831 && (p->selFlags & SF_OrderByReqd)==0 /* Condition (3) and (4) */
drhbb301232021-07-15 19:29:43 +00006832 && OptimizationEnabled(db, SQLITE_OmitOrderBy)
6833 ){
6834 SELECTTRACE(0x100,pParse,p,
6835 ("omit superfluous ORDER BY on %r FROM-clause subquery\n",i+1));
drhe8344842022-07-14 01:48:27 +00006836 sqlite3ParserAddCleanup(pParse,
6837 (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
6838 pSub->pOrderBy);
drhbb301232021-07-15 19:29:43 +00006839 pSub->pOrderBy = 0;
6840 }
6841
drhfca23552017-10-28 20:51:54 +00006842 /* If the outer query contains a "complex" result set (that is,
6843 ** if the result set of the outer query uses functions or subqueries)
6844 ** and if the subquery contains an ORDER BY clause and if
drh648fe492017-09-28 20:06:53 +00006845 ** it will be implemented as a co-routine, then do not flatten. This
6846 ** restriction allows SQL constructs like this:
6847 **
6848 ** SELECT expensive_function(x)
6849 ** FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
6850 **
6851 ** The expensive_function() is only computed on the 10 rows that
6852 ** are output, rather than every row of the table.
drhfca23552017-10-28 20:51:54 +00006853 **
6854 ** The requirement that the outer query have a complex result set
6855 ** means that flattening does occur on simpler SQL constraints without
6856 ** the expensive_function() like:
6857 **
6858 ** SELECT x FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
drh648fe492017-09-28 20:06:53 +00006859 */
drh25c221e2017-09-29 22:13:24 +00006860 if( pSub->pOrderBy!=0
drh648fe492017-09-28 20:06:53 +00006861 && i==0
drhfca23552017-10-28 20:51:54 +00006862 && (p->selFlags & SF_ComplexResult)!=0
drh648fe492017-09-28 20:06:53 +00006863 && (pTabList->nSrc==1
drha76ac882022-04-08 19:20:12 +00006864 || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0)
drh648fe492017-09-28 20:06:53 +00006865 ){
6866 continue;
6867 }
6868
drh25c221e2017-09-29 22:13:24 +00006869 if( flattenSubquery(pParse, p, i, isAgg) ){
drh4acd7542019-02-06 00:55:47 +00006870 if( pParse->nErr ) goto select_end;
drh4490c402015-06-05 22:33:39 +00006871 /* This subquery can be absorbed into its parent. */
drh4490c402015-06-05 22:33:39 +00006872 i = -1;
6873 }
6874 pTabList = p->pSrc;
6875 if( db->mallocFailed ) goto select_end;
6876 if( !IgnorableOrderby(pDest) ){
6877 sSort.pOrderBy = p->pOrderBy;
6878 }
6879 }
6880#endif
6881
drh4490c402015-06-05 22:33:39 +00006882#ifndef SQLITE_OMIT_COMPOUND_SELECT
6883 /* Handle compound SELECT statements using the separate multiSelect()
6884 ** procedure.
6885 */
6886 if( p->pPrior ){
6887 rc = multiSelect(pParse, p, pDest);
drh5e431be2022-04-06 11:08:38 +00006888#if TREETRACE_ENABLED
drhf20609d2018-04-23 17:43:35 +00006889 SELECTTRACE(0x1,pParse,p,("end compound-select processing\n"));
drh5e431be2022-04-06 11:08:38 +00006890 if( (sqlite3TreeTrace & 0x2000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
drhf20609d2018-04-23 17:43:35 +00006891 sqlite3TreeViewSelect(0, p, 0);
6892 }
drh4490c402015-06-05 22:33:39 +00006893#endif
drhc631ded2018-05-02 02:22:22 +00006894 if( p->pNext==0 ) ExplainQueryPlanPop(pParse);
drh4490c402015-06-05 22:33:39 +00006895 return rc;
6896 }
6897#endif
6898
drh7810ab62018-07-27 17:51:20 +00006899 /* Do the WHERE-clause constant propagation optimization if this is
6900 ** a join. No need to speed time on this operation for non-join queries
6901 ** as the equivalent optimization will be handled by query planner in
6902 ** sqlite3WhereBegin().
6903 */
drhb775c972021-05-14 14:26:57 +00006904 if( p->pWhere!=0
6905 && p->pWhere->op==TK_AND
drh7810ab62018-07-27 17:51:20 +00006906 && OptimizationEnabled(db, SQLITE_PropagateConst)
drh24e11162018-07-26 23:47:11 +00006907 && propagateConstants(pParse, p)
6908 ){
drh5e431be2022-04-06 11:08:38 +00006909#if TREETRACE_ENABLED
6910 if( sqlite3TreeTrace & 0x100 ){
drh24e11162018-07-26 23:47:11 +00006911 SELECTTRACE(0x100,pParse,p,("After constant propagation:\n"));
6912 sqlite3TreeViewSelect(0, p, 0);
6913 }
6914#endif
6915 }else{
drh7810ab62018-07-27 17:51:20 +00006916 SELECTTRACE(0x100,pParse,p,("Constant propagation not helpful\n"));
drh24e11162018-07-26 23:47:11 +00006917 }
6918
dana4b5fb52018-08-03 20:19:52 +00006919#ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6920 if( OptimizationEnabled(db, SQLITE_QueryFlattener|SQLITE_CountOfView)
6921 && countOfViewOptimization(pParse, p)
6922 ){
6923 if( db->mallocFailed ) goto select_end;
6924 pEList = p->pEList;
6925 pTabList = p->pSrc;
6926 }
6927#endif
6928
drh701caf12017-05-10 16:12:00 +00006929 /* For each term in the FROM clause, do two things:
6930 ** (1) Authorized unreferenced tables
6931 ** (2) Generate code for all sub-queries
drhd820cb12002-02-18 03:21:45 +00006932 */
drh4490c402015-06-05 22:33:39 +00006933 for(i=0; i<pTabList->nSrc; i++){
drh76012942021-02-21 21:04:54 +00006934 SrcItem *pItem = &pTabList->a[i];
drha79e2a22021-02-21 23:44:14 +00006935 SrcItem *pPrior;
drh13449892005-09-07 21:22:45 +00006936 SelectDest dest;
drh701caf12017-05-10 16:12:00 +00006937 Select *pSub;
drh824d21a2017-09-29 12:44:52 +00006938#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6939 const char *zSavedAuthContext;
6940#endif
drh701caf12017-05-10 16:12:00 +00006941
drh3d240d22017-09-28 16:56:55 +00006942 /* Issue SQLITE_READ authorizations with a fake column name for any
6943 ** tables that are referenced but from which no values are extracted.
6944 ** Examples of where these kinds of null SQLITE_READ authorizations
6945 ** would occur:
drh701caf12017-05-10 16:12:00 +00006946 **
drh2336c932017-05-11 12:05:23 +00006947 ** SELECT count(*) FROM t1; -- SQLITE_READ t1.""
6948 ** SELECT t1.* FROM t1, t2; -- SQLITE_READ t2.""
6949 **
6950 ** The fake column name is an empty string. It is possible for a table to
6951 ** have a column named by the empty string, in which case there is no way to
6952 ** distinguish between an unreferenced table and an actual reference to the
drh3d240d22017-09-28 16:56:55 +00006953 ** "" column. The original design was for the fake column name to be a NULL,
drh2336c932017-05-11 12:05:23 +00006954 ** which would be unambiguous. But legacy authorization callbacks might
drh3d240d22017-09-28 16:56:55 +00006955 ** assume the column name is non-NULL and segfault. The use of an empty
6956 ** string for the fake column name seems safer.
drh701caf12017-05-10 16:12:00 +00006957 */
drh74c490e2019-08-07 13:25:21 +00006958 if( pItem->colUsed==0 && pItem->zName!=0 ){
drh2336c932017-05-11 12:05:23 +00006959 sqlite3AuthCheck(pParse, SQLITE_READ, pItem->zName, "", pItem->zDatabase);
drh701caf12017-05-10 16:12:00 +00006960 }
6961
6962#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6963 /* Generate code for all sub-queries in the FROM clause
6964 */
6965 pSub = pItem->pSelect;
drh5b6a9ed2011-09-15 23:58:14 +00006966 if( pSub==0 ) continue;
drh21172c42012-10-30 00:29:07 +00006967
drh14c4d422021-05-26 18:46:51 +00006968 /* The code for a subquery should only be generated once. */
6969 assert( pItem->addrFillSub==0 );
danielk1977daf79ac2008-06-30 18:12:28 +00006970
danielk1977fc976062007-05-10 10:46:56 +00006971 /* Increment Parse.nHeight by the height of the largest expression
drhf7b54962013-05-28 12:11:54 +00006972 ** tree referred to by this, the parent select. The child select
danielk1977fc976062007-05-10 10:46:56 +00006973 ** may contain expression trees of at most
6974 ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
6975 ** more conservative than necessary, but much easier than enforcing
6976 ** an exact limit.
6977 */
6978 pParse->nHeight += sqlite3SelectExprHeight(p);
danielk1977daf79ac2008-06-30 18:12:28 +00006979
drhadc57f62015-06-06 00:18:01 +00006980 /* Make copies of constant WHERE-clause terms in the outer query down
6981 ** inside the subquery. This can help the subquery to run more efficiently.
6982 */
drh7fbb1012018-03-21 01:59:46 +00006983 if( OptimizationEnabled(db, SQLITE_PushDown)
drhdf67ec02021-08-11 13:48:56 +00006984 && (pItem->fg.isCte==0
6985 || (pItem->u2.pCteUse->eM10d!=M10d_Yes && pItem->u2.pCteUse->nUse<2))
drha9cdb902022-04-25 19:40:33 +00006986 && pushDownWhereTerms(pParse, pSub, p->pWhere, pItem)
drh4490c402015-06-05 22:33:39 +00006987 ){
drh5e431be2022-04-06 11:08:38 +00006988#if TREETRACE_ENABLED
6989 if( sqlite3TreeTrace & 0x100 ){
drhd2a44012018-07-28 14:34:22 +00006990 SELECTTRACE(0x100,pParse,p,
6991 ("After WHERE-clause push-down into subquery %d:\n", pSub->selId));
drh4490c402015-06-05 22:33:39 +00006992 sqlite3TreeViewSelect(0, p, 0);
danielk1977daf79ac2008-06-30 18:12:28 +00006993 }
drh69b72d52015-06-01 20:28:03 +00006994#endif
drh8794c682021-02-13 16:39:24 +00006995 assert( pItem->pSelect && (pItem->pSelect->selFlags & SF_PushDown)!=0 );
drh2d277bb2018-03-20 11:24:30 +00006996 }else{
6997 SELECTTRACE(0x100,pParse,p,("Push-down not possible\n"));
drh4490c402015-06-05 22:33:39 +00006998 }
drhadc57f62015-06-06 00:18:01 +00006999
drh824d21a2017-09-29 12:44:52 +00007000 zSavedAuthContext = pParse->zAuthContext;
7001 pParse->zAuthContext = pItem->zName;
7002
drhadc57f62015-06-06 00:18:01 +00007003 /* Generate code to implement the subquery
drh0ff47e92016-03-15 17:52:12 +00007004 **
drhcf5cab02022-06-22 15:55:28 +00007005 ** The subquery is implemented as a co-routine if all of the following are
drh9debb582022-04-10 23:01:20 +00007006 ** true:
7007 **
drha79e2a22021-02-21 23:44:14 +00007008 ** (1) the subquery is guaranteed to be the outer loop (so that
7009 ** it does not need to be computed more than once), and
drh745912e2021-02-22 03:04:25 +00007010 ** (2) the subquery is not a CTE that should be materialized
drh9debb582022-04-10 23:01:20 +00007011 ** (3) the subquery is not part of a left operand for a RIGHT JOIN
drhadc57f62015-06-06 00:18:01 +00007012 */
drh0ff47e92016-03-15 17:52:12 +00007013 if( i==0
7014 && (pTabList->nSrc==1
drha76ac882022-04-08 19:20:12 +00007015 || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0) /* (1) */
7016 && (pItem->fg.isCte==0 || pItem->u2.pCteUse->eM10d!=M10d_Yes) /* (2) */
drh9debb582022-04-10 23:01:20 +00007017 && (pTabList->a[0].fg.jointype & JT_LTORJ)==0 /* (3) */
drha5759672012-10-30 14:39:12 +00007018 ){
drh21172c42012-10-30 00:29:07 +00007019 /* Implement a co-routine that will return a single row of the result
7020 ** set on each invocation.
7021 */
drh4490c402015-06-05 22:33:39 +00007022 int addrTop = sqlite3VdbeCurrentAddr(v)+1;
drh824d21a2017-09-29 12:44:52 +00007023
drh21172c42012-10-30 00:29:07 +00007024 pItem->regReturn = ++pParse->nMem;
drh4490c402015-06-05 22:33:39 +00007025 sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
drha9799932021-03-19 13:00:28 +00007026 VdbeComment((v, "%!S", pItem));
drh21172c42012-10-30 00:29:07 +00007027 pItem->addrFillSub = addrTop;
drh21172c42012-10-30 00:29:07 +00007028 sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
drha9799932021-03-19 13:00:28 +00007029 ExplainQueryPlan((pParse, 1, "CO-ROUTINE %!S", pItem));
drh21172c42012-10-30 00:29:07 +00007030 sqlite3Select(pParse, pSub, &dest);
drhc3489bb2016-02-25 16:04:59 +00007031 pItem->pTab->nRowLogEst = pSub->nSelectRow;
drh8a48b9c2015-08-19 15:20:00 +00007032 pItem->fg.viaCoroutine = 1;
drh4490c402015-06-05 22:33:39 +00007033 pItem->regResult = dest.iSdst;
drh2fade2f2016-02-09 02:12:20 +00007034 sqlite3VdbeEndCoroutine(v, pItem->regReturn);
drh21172c42012-10-30 00:29:07 +00007035 sqlite3VdbeJumpHere(v, addrTop-1);
7036 sqlite3ClearTempRegCache(pParse);
drha79e2a22021-02-21 23:44:14 +00007037 }else if( pItem->fg.isCte && pItem->u2.pCteUse->addrM9e>0 ){
7038 /* This is a CTE for which materialization code has already been
7039 ** generated. Invoke the subroutine to compute the materialization,
7040 ** the make the pItem->iCursor be a copy of the ephemerial table that
7041 ** holds the result of the materialization. */
7042 CteUse *pCteUse = pItem->u2.pCteUse;
7043 sqlite3VdbeAddOp2(v, OP_Gosub, pCteUse->regRtn, pCteUse->addrM9e);
7044 if( pItem->iCursor!=pCteUse->iCur ){
7045 sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pCteUse->iCur);
drh834c6882021-08-11 13:19:13 +00007046 VdbeComment((v, "%!S", pItem));
drha79e2a22021-02-21 23:44:14 +00007047 }
7048 pSub->nSelectRow = pCteUse->nRowEst;
7049 }else if( (pPrior = isSelfJoinView(pTabList, pItem))!=0 ){
7050 /* This view has already been materialized by a prior entry in
7051 ** this same FROM clause. Reuse it. */
7052 if( pPrior->addrFillSub ){
7053 sqlite3VdbeAddOp2(v, OP_Gosub, pPrior->regReturn, pPrior->addrFillSub);
7054 }
7055 sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pPrior->iCursor);
7056 pSub->nSelectRow = pPrior->pSelect->nSelectRow;
danielk1977daf79ac2008-06-30 18:12:28 +00007057 }else{
drh14c4d422021-05-26 18:46:51 +00007058 /* Materialize the view. If the view is not correlated, generate a
drhd685dd62021-03-19 13:53:34 +00007059 ** subroutine to do the materialization so that subsequent uses of
7060 ** the same view can reuse the materialization. */
drh7157e8e2011-09-16 16:00:51 +00007061 int topAddr;
drh48f2d3b2011-09-16 01:34:43 +00007062 int onceAddr = 0;
drhe08e8d62017-05-01 15:15:41 +00007063
drh5b6a9ed2011-09-15 23:58:14 +00007064 pItem->regReturn = ++pParse->nMem;
drh40822eb2022-05-21 18:03:33 +00007065 topAddr = sqlite3VdbeAddOp0(v, OP_Goto);
drh7157e8e2011-09-16 16:00:51 +00007066 pItem->addrFillSub = topAddr+1;
drh40822eb2022-05-21 18:03:33 +00007067 pItem->fg.isMaterialized = 1;
drh8a48b9c2015-08-19 15:20:00 +00007068 if( pItem->fg.isCorrelated==0 ){
drhed171672013-04-24 13:50:09 +00007069 /* If the subquery is not correlated and if we are not inside of
drh5b6a9ed2011-09-15 23:58:14 +00007070 ** a trigger, then we only need to compute the value of the subquery
7071 ** once. */
drh511f9e82016-09-22 18:53:13 +00007072 onceAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drha9799932021-03-19 13:00:28 +00007073 VdbeComment((v, "materialize %!S", pItem));
drh69b72d52015-06-01 20:28:03 +00007074 }else{
drha9799932021-03-19 13:00:28 +00007075 VdbeNoopComment((v, "materialize %!S", pItem));
drh5b6a9ed2011-09-15 23:58:14 +00007076 }
drha79e2a22021-02-21 23:44:14 +00007077 sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
drha9799932021-03-19 13:00:28 +00007078 ExplainQueryPlan((pParse, 1, "MATERIALIZE %!S", pItem));
drha79e2a22021-02-21 23:44:14 +00007079 sqlite3Select(pParse, pSub, &dest);
drhc3489bb2016-02-25 16:04:59 +00007080 pItem->pTab->nRowLogEst = pSub->nSelectRow;
drh48f2d3b2011-09-16 01:34:43 +00007081 if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
drh40822eb2022-05-21 18:03:33 +00007082 sqlite3VdbeAddOp2(v, OP_Return, pItem->regReturn, topAddr+1);
drha9799932021-03-19 13:00:28 +00007083 VdbeComment((v, "end %!S", pItem));
drh40822eb2022-05-21 18:03:33 +00007084 sqlite3VdbeJumpHere(v, topAddr);
drhcdc69552011-12-06 13:24:59 +00007085 sqlite3ClearTempRegCache(pParse);
drhd685dd62021-03-19 13:53:34 +00007086 if( pItem->fg.isCte && pItem->fg.isCorrelated==0 ){
drha79e2a22021-02-21 23:44:14 +00007087 CteUse *pCteUse = pItem->u2.pCteUse;
7088 pCteUse->addrM9e = pItem->addrFillSub;
7089 pCteUse->regRtn = pItem->regReturn;
7090 pCteUse->iCur = pItem->iCursor;
7091 pCteUse->nRowEst = pSub->nSelectRow;
7092 }
danielk1977daf79ac2008-06-30 18:12:28 +00007093 }
drhadc57f62015-06-06 00:18:01 +00007094 if( db->mallocFailed ) goto select_end;
danielk1977fc976062007-05-10 10:46:56 +00007095 pParse->nHeight -= sqlite3SelectExprHeight(p);
drh824d21a2017-09-29 12:44:52 +00007096 pParse->zAuthContext = zSavedAuthContext;
drh51522cd2005-01-20 13:36:19 +00007097#endif
drh701caf12017-05-10 16:12:00 +00007098 }
drhadc57f62015-06-06 00:18:01 +00007099
drh38b41492015-06-08 15:08:15 +00007100 /* Various elements of the SELECT copied into local variables for
7101 ** convenience */
drhadc57f62015-06-06 00:18:01 +00007102 pEList = p->pEList;
danielk1977daf79ac2008-06-30 18:12:28 +00007103 pWhere = p->pWhere;
7104 pGroupBy = p->pGroupBy;
7105 pHaving = p->pHaving;
drhe8e4af72012-09-21 00:04:28 +00007106 sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
drh832508b2002-03-02 17:04:07 +00007107
drh5e431be2022-04-06 11:08:38 +00007108#if TREETRACE_ENABLED
7109 if( sqlite3TreeTrace & 0x400 ){
drhbc8edba2015-06-05 20:27:26 +00007110 SELECTTRACE(0x400,pParse,p,("After all FROM-clause analysis:\n"));
7111 sqlite3TreeViewSelect(0, p, 0);
danielk1977f23329a2008-07-01 14:09:13 +00007112 }
7113#endif
7114
dan50118cd2011-07-01 14:21:38 +00007115 /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
7116 ** if the select-list is the same as the ORDER BY list, then this query
7117 ** can be rewritten as a GROUP BY. In other words, this:
7118 **
7119 ** SELECT DISTINCT xyz FROM ... ORDER BY xyz
7120 **
7121 ** is transformed to:
7122 **
drhdea7d702014-12-04 21:54:58 +00007123 ** SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
dan50118cd2011-07-01 14:21:38 +00007124 **
7125 ** The second form is preferred as a single index (or temp-table) may be
7126 ** used for both the ORDER BY and DISTINCT processing. As originally
7127 ** written the query must use a temp-table for at least one of the ORDER
7128 ** BY and DISTINCT, and an index or separate temp-table for the other.
7129 */
7130 if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
drhadc57f62015-06-06 00:18:01 +00007131 && sqlite3ExprListCompare(sSort.pOrderBy, pEList, -1)==0
drhef9f7192020-01-17 19:14:08 +00007132#ifndef SQLITE_OMIT_WINDOWFUNC
dane59c5622019-11-22 10:14:01 +00007133 && p->pWin==0
drhef9f7192020-01-17 19:14:08 +00007134#endif
dan50118cd2011-07-01 14:21:38 +00007135 ){
7136 p->selFlags &= ~SF_Distinct;
drhadc57f62015-06-06 00:18:01 +00007137 pGroupBy = p->pGroupBy = sqlite3ExprListDup(db, pEList, 0);
dan9e10f9a2020-01-06 17:06:12 +00007138 p->selFlags |= SF_Aggregate;
drhe8e4af72012-09-21 00:04:28 +00007139 /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
7140 ** the sDistinct.isTnct is still set. Hence, isTnct represents the
7141 ** original setting of the SF_Distinct flag, not the current setting */
7142 assert( sDistinct.isTnct );
danece092e2022-03-16 12:06:00 +00007143 sDistinct.isTnct = 2;
drh7512cb42016-04-14 13:06:49 +00007144
drh5e431be2022-04-06 11:08:38 +00007145#if TREETRACE_ENABLED
7146 if( sqlite3TreeTrace & 0x400 ){
drh7512cb42016-04-14 13:06:49 +00007147 SELECTTRACE(0x400,pParse,p,("Transform DISTINCT into GROUP BY:\n"));
7148 sqlite3TreeViewSelect(0, p, 0);
7149 }
7150#endif
dan50118cd2011-07-01 14:21:38 +00007151 }
7152
drhadc57f62015-06-06 00:18:01 +00007153 /* If there is an ORDER BY clause, then create an ephemeral index to
7154 ** do the sorting. But this sorting ephemeral index might end up
7155 ** being unused if the data can be extracted in pre-sorted order.
7156 ** If that is the case, then the OP_OpenEphemeral instruction will be
7157 ** changed to an OP_Noop once we figure out that the sorting index is
7158 ** not needed. The sSort.addrSortIndex variable is used to facilitate
7159 ** that change.
danielk19777cedc8d2004-06-10 10:50:08 +00007160 */
drh079a3072014-03-19 14:10:55 +00007161 if( sSort.pOrderBy ){
drh0342b1f2005-09-01 03:07:44 +00007162 KeyInfo *pKeyInfo;
danf9eae182018-05-21 19:45:11 +00007163 pKeyInfo = sqlite3KeyInfoFromExprList(
7164 pParse, sSort.pOrderBy, 0, pEList->nExpr);
drh079a3072014-03-19 14:10:55 +00007165 sSort.iECursor = pParse->nTab++;
7166 sSort.addrSortIndex =
drh66a51672008-01-03 00:01:23 +00007167 sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
drhf45f2322014-03-23 17:45:03 +00007168 sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
7169 (char*)pKeyInfo, P4_KEYINFO
7170 );
drh9d2985c2005-09-08 01:58:42 +00007171 }else{
drh079a3072014-03-19 14:10:55 +00007172 sSort.addrSortIndex = -1;
danielk19777cedc8d2004-06-10 10:50:08 +00007173 }
7174
drh2d0794e2002-03-03 03:03:52 +00007175 /* If the output is destined for a temporary table, open that table.
7176 */
danielk19776c8c8ce2008-01-02 16:27:09 +00007177 if( pDest->eDest==SRT_EphemTab ){
drh2b596da2012-07-23 21:43:19 +00007178 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
drh18f86002022-04-21 13:11:26 +00007179 if( p->selFlags & SF_NestedFrom ){
7180 /* Delete or NULL-out result columns that will never be used */
7181 int ii;
drhd88fd532022-05-02 20:49:30 +00007182 for(ii=pEList->nExpr-1; ii>0 && pEList->a[ii].fg.bUsed==0; ii--){
drh18f86002022-04-21 13:11:26 +00007183 sqlite3ExprDelete(db, pEList->a[ii].pExpr);
7184 sqlite3DbFree(db, pEList->a[ii].zEName);
7185 pEList->nExpr--;
7186 }
7187 for(ii=0; ii<pEList->nExpr; ii++){
drhd88fd532022-05-02 20:49:30 +00007188 if( pEList->a[ii].fg.bUsed==0 ) pEList->a[ii].pExpr->op = TK_NULL;
drh18f86002022-04-21 13:11:26 +00007189 }
7190 }
drh2d0794e2002-03-03 03:03:52 +00007191 }
7192
drhf42bacc2006-04-26 17:39:34 +00007193 /* Set the limiter.
7194 */
drhec4ccdb2018-12-29 02:26:59 +00007195 iEnd = sqlite3VdbeMakeLabel(pParse);
dan69b93832016-12-16 15:05:40 +00007196 if( (p->selFlags & SF_FixedLimit)==0 ){
7197 p->nSelectRow = 320; /* 4 billion rows */
7198 }
drh3c8fb6f2022-07-26 01:20:18 +00007199 if( p->pLimit ) computeLimitRegisters(pParse, p, iEnd);
drh079a3072014-03-19 14:10:55 +00007200 if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
drh0ff287f2015-09-02 18:40:33 +00007201 sqlite3VdbeChangeOpcode(v, sSort.addrSortIndex, OP_SorterOpen);
drh079a3072014-03-19 14:10:55 +00007202 sSort.sortFlags |= SORTFLAG_UseSorter;
drhc6aff302011-09-01 15:32:47 +00007203 }
drhf42bacc2006-04-26 17:39:34 +00007204
drhadc57f62015-06-06 00:18:01 +00007205 /* Open an ephemeral index to use for the distinct set.
drhefb72512000-05-31 20:00:52 +00007206 */
dan2ce22452010-11-08 19:01:16 +00007207 if( p->selFlags & SF_Distinct ){
drhe8e4af72012-09-21 00:04:28 +00007208 sDistinct.tabTnct = pParse->nTab++;
7209 sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
danf9eae182018-05-21 19:45:11 +00007210 sDistinct.tabTnct, 0, 0,
7211 (char*)sqlite3KeyInfoFromExprList(pParse, p->pEList,0,0),
7212 P4_KEYINFO);
drhd4187c72010-08-30 22:15:45 +00007213 sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
drhe8e4af72012-09-21 00:04:28 +00007214 sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
drh832508b2002-03-02 17:04:07 +00007215 }else{
drhe8e4af72012-09-21 00:04:28 +00007216 sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
drhefb72512000-05-31 20:00:52 +00007217 }
drh832508b2002-03-02 17:04:07 +00007218
drh13449892005-09-07 21:22:45 +00007219 if( !isAgg && pGroupBy==0 ){
drhe8e4af72012-09-21 00:04:28 +00007220 /* No aggregate functions and no GROUP BY clause */
dan67a9b8e2018-06-22 20:51:35 +00007221 u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0)
7222 | (p->selFlags & SF_FixedLimit);
7223#ifndef SQLITE_OMIT_WINDOWFUNC
drh067b92b2020-06-19 15:24:12 +00007224 Window *pWin = p->pWin; /* Main window object (or NULL) */
danf9eae182018-05-21 19:45:11 +00007225 if( pWin ){
dan4ea562e2020-01-01 20:17:15 +00007226 sqlite3WindowCodeInit(pParse, p);
dan86fb6e12018-05-16 20:58:07 +00007227 }
dan67a9b8e2018-06-22 20:51:35 +00007228#endif
7229 assert( WHERE_USE_LIMIT==SF_FixedLimit );
7230
dan86fb6e12018-05-16 20:58:07 +00007231
dan38cc40c2011-06-30 20:17:15 +00007232 /* Begin the database scan. */
drhcfd74702018-03-19 22:28:34 +00007233 SELECTTRACE(1,pParse,p,("WhereBegin\n"));
drh079a3072014-03-19 14:10:55 +00007234 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
drh895bab32022-01-27 16:14:50 +00007235 p->pEList, p, wctrlFlags, p->nSelectRow);
drh13449892005-09-07 21:22:45 +00007236 if( pWInfo==0 ) goto select_end;
drh6f328482013-06-05 23:39:34 +00007237 if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
7238 p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
7239 }
drh6457a352013-06-21 00:35:37 +00007240 if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
drh6f328482013-06-05 23:39:34 +00007241 sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
7242 }
drh079a3072014-03-19 14:10:55 +00007243 if( sSort.pOrderBy ){
7244 sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
drh6ee5a7b2018-09-08 20:09:46 +00007245 sSort.labelOBLopt = sqlite3WhereOrderByLimitOptLabel(pWInfo);
drh079a3072014-03-19 14:10:55 +00007246 if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
7247 sSort.pOrderBy = 0;
7248 }
7249 }
drh13162ef2021-02-16 20:01:08 +00007250 SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
drhcce7d172000-05-31 15:34:51 +00007251
drhb9bb7c12006-06-11 23:41:55 +00007252 /* If sorting index that was created by a prior OP_OpenEphemeral
7253 ** instruction ended up not being needed, then change the OP_OpenEphemeral
drh9d2985c2005-09-08 01:58:42 +00007254 ** into an OP_Noop.
7255 */
drh079a3072014-03-19 14:10:55 +00007256 if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
7257 sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
drh9d2985c2005-09-08 01:58:42 +00007258 }
7259
drh2def2f72017-09-15 17:40:34 +00007260 assert( p->pEList==pEList );
dan67a9b8e2018-06-22 20:51:35 +00007261#ifndef SQLITE_OMIT_WINDOWFUNC
danf9eae182018-05-21 19:45:11 +00007262 if( pWin ){
drhec4ccdb2018-12-29 02:26:59 +00007263 int addrGosub = sqlite3VdbeMakeLabel(pParse);
7264 int iCont = sqlite3VdbeMakeLabel(pParse);
7265 int iBreak = sqlite3VdbeMakeLabel(pParse);
danf9eae182018-05-21 19:45:11 +00007266 int regGosub = ++pParse->nMem;
drhefb72512000-05-31 20:00:52 +00007267
dandacf1de2018-06-08 16:11:55 +00007268 sqlite3WindowCodeStep(pParse, p, pWInfo, regGosub, addrGosub);
dan86fb6e12018-05-16 20:58:07 +00007269
danefa3a3c2018-06-23 16:26:20 +00007270 sqlite3VdbeAddOp2(v, OP_Goto, 0, iBreak);
danf9eae182018-05-21 19:45:11 +00007271 sqlite3VdbeResolveLabel(v, addrGosub);
drhb0225bc2018-07-10 20:50:27 +00007272 VdbeNoopComment((v, "inner-loop subroutine"));
drhd4cb09e2018-09-17 15:19:13 +00007273 sSort.labelOBLopt = 0;
danefa3a3c2018-06-23 16:26:20 +00007274 selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest, iCont, iBreak);
dandacf1de2018-06-08 16:11:55 +00007275 sqlite3VdbeResolveLabel(v, iCont);
dan86fb6e12018-05-16 20:58:07 +00007276 sqlite3VdbeAddOp1(v, OP_Return, regGosub);
drh0b3b0dd2018-07-10 05:11:03 +00007277 VdbeComment((v, "end inner-loop subroutine"));
danefa3a3c2018-06-23 16:26:20 +00007278 sqlite3VdbeResolveLabel(v, iBreak);
dan67a9b8e2018-06-22 20:51:35 +00007279 }else
7280#endif /* SQLITE_OMIT_WINDOWFUNC */
7281 {
dan86fb6e12018-05-16 20:58:07 +00007282 /* Use the standard inner loop. */
7283 selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest,
7284 sqlite3WhereContinueLabel(pWInfo),
7285 sqlite3WhereBreakLabel(pWInfo));
7286
7287 /* End the database scan loop.
7288 */
drh13162ef2021-02-16 20:01:08 +00007289 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
dan86fb6e12018-05-16 20:58:07 +00007290 sqlite3WhereEnd(pWInfo);
7291 }
drh13449892005-09-07 21:22:45 +00007292 }else{
drhe8e4af72012-09-21 00:04:28 +00007293 /* This case when there exist aggregate functions or a GROUP BY clause
7294 ** or both */
drh13449892005-09-07 21:22:45 +00007295 NameContext sNC; /* Name context for processing aggregate information */
7296 int iAMem; /* First Mem address for storing current GROUP BY */
7297 int iBMem; /* First Mem address for previous GROUP BY */
7298 int iUseFlag; /* Mem address holding flag indicating that at least
7299 ** one row of the input to the aggregator has been
7300 ** processed */
7301 int iAbortFlag; /* Mem address which causes query abort if positive */
7302 int groupBySort; /* Rows come from source in GROUP BY order */
drhd1766112008-09-17 00:13:12 +00007303 int addrEnd; /* End of processing for this SELECT */
drh1c9d8352011-09-01 16:01:27 +00007304 int sortPTab = 0; /* Pseudotable used to decode sorting results */
7305 int sortOut = 0; /* Output register from the sorter */
dan374cd782014-04-21 13:21:56 +00007306 int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
drhcce7d172000-05-31 15:34:51 +00007307
drhd1766112008-09-17 00:13:12 +00007308 /* Remove any and all aliases between the result set and the
7309 ** GROUP BY clause.
7310 */
7311 if( pGroupBy ){
drhdc5ea5c2008-12-10 17:19:59 +00007312 int k; /* Loop counter */
drhd1766112008-09-17 00:13:12 +00007313 struct ExprList_item *pItem; /* For looping over expression in a list */
drhcce7d172000-05-31 15:34:51 +00007314
drhdc5ea5c2008-12-10 17:19:59 +00007315 for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
drhc2acc4e2013-11-15 18:15:19 +00007316 pItem->u.x.iAlias = 0;
drhd1766112008-09-17 00:13:12 +00007317 }
drhdc5ea5c2008-12-10 17:19:59 +00007318 for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
drhc2acc4e2013-11-15 18:15:19 +00007319 pItem->u.x.iAlias = 0;
drhd1766112008-09-17 00:13:12 +00007320 }
drhc3489bb2016-02-25 16:04:59 +00007321 assert( 66==sqlite3LogEst(100) );
7322 if( p->nSelectRow>66 ) p->nSelectRow = 66;
dan8c9bcb22019-09-21 15:44:12 +00007323
7324 /* If there is both a GROUP BY and an ORDER BY clause and they are
7325 ** identical, then it may be possible to disable the ORDER BY clause
7326 ** on the grounds that the GROUP BY will cause elements to come out
7327 ** in the correct order. It also may not - the GROUP BY might use a
7328 ** database index that causes rows to be grouped together as required
7329 ** but not actually sorted. Either way, record the fact that the
7330 ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
7331 ** variable. */
7332 if( sSort.pOrderBy && pGroupBy->nExpr==sSort.pOrderBy->nExpr ){
drhe39f3882019-09-21 17:31:03 +00007333 int ii;
dan8c9bcb22019-09-21 15:44:12 +00007334 /* The GROUP BY processing doesn't care whether rows are delivered in
7335 ** ASC or DESC order - only that each group is returned contiguously.
7336 ** So set the ASC/DESC flags in the GROUP BY to match those in the
7337 ** ORDER BY to maximize the chances of rows being delivered in an
7338 ** order that makes the ORDER BY redundant. */
drhe39f3882019-09-21 17:31:03 +00007339 for(ii=0; ii<pGroupBy->nExpr; ii++){
drhd88fd532022-05-02 20:49:30 +00007340 u8 sortFlags;
7341 sortFlags = sSort.pOrderBy->a[ii].fg.sortFlags & KEYINFO_ORDER_DESC;
7342 pGroupBy->a[ii].fg.sortFlags = sortFlags;
dan8c9bcb22019-09-21 15:44:12 +00007343 }
7344 if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
7345 orderByGrp = 1;
7346 }
7347 }
drh95aa47b2010-11-16 02:49:15 +00007348 }else{
drhc3489bb2016-02-25 16:04:59 +00007349 assert( 0==sqlite3LogEst(1) );
7350 p->nSelectRow = 0;
drhd1766112008-09-17 00:13:12 +00007351 }
drh13449892005-09-07 21:22:45 +00007352
drhd1766112008-09-17 00:13:12 +00007353 /* Create a label to jump to when we want to abort the query */
drhec4ccdb2018-12-29 02:26:59 +00007354 addrEnd = sqlite3VdbeMakeLabel(pParse);
drh13449892005-09-07 21:22:45 +00007355
7356 /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
7357 ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
7358 ** SELECT statement.
7359 */
drhbf790972020-06-07 20:18:07 +00007360 pAggInfo = sqlite3DbMallocZero(db, sizeof(*pAggInfo) );
drhc54246f2021-02-17 21:13:14 +00007361 if( pAggInfo ){
7362 sqlite3ParserAddCleanup(pParse,
7363 (void(*)(sqlite3*,void*))agginfoFree, pAggInfo);
drh6d0053c2021-03-09 19:32:37 +00007364 testcase( pParse->earlyCleanup );
drhc54246f2021-02-17 21:13:14 +00007365 }
7366 if( db->mallocFailed ){
drhbf790972020-06-07 20:18:07 +00007367 goto select_end;
7368 }
drhe26d4282020-06-09 11:59:15 +00007369 pAggInfo->selId = p->selId;
drh13449892005-09-07 21:22:45 +00007370 memset(&sNC, 0, sizeof(sNC));
7371 sNC.pParse = pParse;
7372 sNC.pSrcList = pTabList;
drhbf790972020-06-07 20:18:07 +00007373 sNC.uNC.pAggInfo = pAggInfo;
drh25c3b8c2018-04-16 10:34:13 +00007374 VVA_ONLY( sNC.ncFlags = NC_UAggInfo; )
drhbf790972020-06-07 20:18:07 +00007375 pAggInfo->mnReg = pParse->nMem+1;
7376 pAggInfo->nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
7377 pAggInfo->pGroupBy = pGroupBy;
drhd2b3e232008-01-23 14:51:49 +00007378 sqlite3ExprAnalyzeAggList(&sNC, pEList);
drh079a3072014-03-19 14:10:55 +00007379 sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
drhd2b3e232008-01-23 14:51:49 +00007380 if( pHaving ){
danab31a842017-04-29 20:53:09 +00007381 if( pGroupBy ){
7382 assert( pWhere==p->pWhere );
drhcd0abc22018-03-20 18:08:33 +00007383 assert( pHaving==p->pHaving );
7384 assert( pGroupBy==p->pGroupBy );
7385 havingToWhere(pParse, p);
danab31a842017-04-29 20:53:09 +00007386 pWhere = p->pWhere;
7387 }
drhd2b3e232008-01-23 14:51:49 +00007388 sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
drh13449892005-09-07 21:22:45 +00007389 }
drhbf790972020-06-07 20:18:07 +00007390 pAggInfo->nAccumulator = pAggInfo->nColumn;
7391 if( p->pGroupBy==0 && p->pHaving==0 && pAggInfo->nFunc==1 ){
drh81185a52020-06-09 13:38:12 +00007392 minMaxFlag = minMaxQuery(db, pAggInfo->aFunc[0].pFExpr, &pMinMaxOrderBy);
drh47d9f832017-10-26 20:04:28 +00007393 }else{
7394 minMaxFlag = WHERE_ORDERBY_NORMAL;
7395 }
drhbf790972020-06-07 20:18:07 +00007396 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00007397 Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
drha4eeccd2021-10-07 17:43:30 +00007398 assert( ExprUseXList(pExpr) );
drh3a8c4be2012-05-21 20:13:39 +00007399 sNC.ncFlags |= NC_InAggFunc;
dan6ba7ab02019-07-02 11:56:47 +00007400 sqlite3ExprAnalyzeAggList(&sNC, pExpr->x.pList);
7401#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00007402 assert( !IsWindowFunc(pExpr) );
7403 if( ExprHasProperty(pExpr, EP_WinFunc) ){
7404 sqlite3ExprAnalyzeAggregates(&sNC, pExpr->y.pWin->pFilter);
danb28c4e52019-07-05 17:38:55 +00007405 }
dan6ba7ab02019-07-02 11:56:47 +00007406#endif
drh3a8c4be2012-05-21 20:13:39 +00007407 sNC.ncFlags &= ~NC_InAggFunc;
drh13449892005-09-07 21:22:45 +00007408 }
drhbf790972020-06-07 20:18:07 +00007409 pAggInfo->mxReg = pParse->nMem;
drh17435752007-08-16 04:30:38 +00007410 if( db->mallocFailed ) goto select_end;
drh5e431be2022-04-06 11:08:38 +00007411#if TREETRACE_ENABLED
7412 if( sqlite3TreeTrace & 0x400 ){
drh7ea11062017-10-26 18:43:19 +00007413 int ii;
drhbf790972020-06-07 20:18:07 +00007414 SELECTTRACE(0x400,pParse,p,("After aggregate analysis %p:\n", pAggInfo));
drh7ea11062017-10-26 18:43:19 +00007415 sqlite3TreeViewSelect(0, p, 0);
drhb9366f82021-01-13 11:44:51 +00007416 if( minMaxFlag ){
7417 sqlite3DebugPrintf("MIN/MAX Optimization (0x%02x) adds:\n", minMaxFlag);
7418 sqlite3TreeViewExprList(0, pMinMaxOrderBy, 0, "ORDERBY");
7419 }
drhbf790972020-06-07 20:18:07 +00007420 for(ii=0; ii<pAggInfo->nColumn; ii++){
drhf4c29122022-07-26 14:37:04 +00007421 struct AggInfo_col *pCol = &pAggInfo->aCol[ii];
7422 sqlite3DebugPrintf(
7423 "agg-column[%d] pTab=%s iTable=%d iColumn=%d iMem=%d"
7424 " iSorterColumn=%d\n",
7425 ii, pCol->pTab ? pCol->pTab->zName : "NULL",
7426 pCol->iTable, pCol->iColumn, pCol->iMem,
7427 pCol->iSorterColumn);
drh81185a52020-06-09 13:38:12 +00007428 sqlite3TreeViewExpr(0, pAggInfo->aCol[ii].pCExpr, 0);
drh7ea11062017-10-26 18:43:19 +00007429 }
drhbf790972020-06-07 20:18:07 +00007430 for(ii=0; ii<pAggInfo->nFunc; ii++){
drh7ea11062017-10-26 18:43:19 +00007431 sqlite3DebugPrintf("agg-func[%d]: iMem=%d\n",
drhbf790972020-06-07 20:18:07 +00007432 ii, pAggInfo->aFunc[ii].iMem);
drh81185a52020-06-09 13:38:12 +00007433 sqlite3TreeViewExpr(0, pAggInfo->aFunc[ii].pFExpr, 0);
drh7ea11062017-10-26 18:43:19 +00007434 }
7435 }
7436#endif
7437
drh13449892005-09-07 21:22:45 +00007438
7439 /* Processing for aggregates with GROUP BY is very different and
danielk19773c4809a2007-11-12 15:29:18 +00007440 ** much more complex than aggregates without a GROUP BY.
drh13449892005-09-07 21:22:45 +00007441 */
7442 if( pGroupBy ){
7443 KeyInfo *pKeyInfo; /* Keying information for the group by clause */
drh728e0f92015-10-10 14:41:28 +00007444 int addr1; /* A-vs-B comparision jump */
drhd1766112008-09-17 00:13:12 +00007445 int addrOutputRow; /* Start of subroutine that outputs a result row */
7446 int regOutputRow; /* Return address register for output subroutine */
7447 int addrSetAbort; /* Set the abort flag and return */
7448 int addrTopOfLoop; /* Top of the input loop */
7449 int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
7450 int addrReset; /* Subroutine for resetting the accumulator */
7451 int regReset; /* Return address register for reset subroutine */
dan5383db72021-03-12 18:24:31 +00007452 ExprList *pDistinct = 0;
7453 u16 distFlag = 0;
7454 int eDist = WHERE_DISTINCT_NOOP;
7455
7456 if( pAggInfo->nFunc==1
7457 && pAggInfo->aFunc[0].iDistinct>=0
drha4eeccd2021-10-07 17:43:30 +00007458 && ALWAYS(pAggInfo->aFunc[0].pFExpr!=0)
7459 && ALWAYS(ExprUseXList(pAggInfo->aFunc[0].pFExpr))
7460 && pAggInfo->aFunc[0].pFExpr->x.pList!=0
dan5383db72021-03-12 18:24:31 +00007461 ){
7462 Expr *pExpr = pAggInfo->aFunc[0].pFExpr->x.pList->a[0].pExpr;
7463 pExpr = sqlite3ExprDup(db, pExpr, 0);
7464 pDistinct = sqlite3ExprListDup(db, pGroupBy, 0);
7465 pDistinct = sqlite3ExprListAppend(pParse, pDistinct, pExpr);
danf330d532021-04-03 19:23:59 +00007466 distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
dan5383db72021-03-12 18:24:31 +00007467 }
drh13449892005-09-07 21:22:45 +00007468
7469 /* If there is a GROUP BY clause we might need a sorting index to
7470 ** implement it. Allocate that sorting index now. If it turns out
drh1c9d8352011-09-01 16:01:27 +00007471 ** that we do not need it after all, the OP_SorterOpen instruction
drh13449892005-09-07 21:22:45 +00007472 ** will be converted into a Noop.
7473 */
drhbf790972020-06-07 20:18:07 +00007474 pAggInfo->sortingIdx = pParse->nTab++;
7475 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pGroupBy,
7476 0, pAggInfo->nColumn);
drh1c9d8352011-09-01 16:01:27 +00007477 addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
drhbf790972020-06-07 20:18:07 +00007478 pAggInfo->sortingIdx, pAggInfo->nSortingColumn,
drh2ec2fb22013-11-06 19:59:23 +00007479 0, (char*)pKeyInfo, P4_KEYINFO);
drh13449892005-09-07 21:22:45 +00007480
7481 /* Initialize memory locations used by GROUP BY aggregate processing
7482 */
drh0a07c102008-01-03 18:03:08 +00007483 iUseFlag = ++pParse->nMem;
7484 iAbortFlag = ++pParse->nMem;
drhd1766112008-09-17 00:13:12 +00007485 regOutputRow = ++pParse->nMem;
drhec4ccdb2018-12-29 02:26:59 +00007486 addrOutputRow = sqlite3VdbeMakeLabel(pParse);
drhd1766112008-09-17 00:13:12 +00007487 regReset = ++pParse->nMem;
drhec4ccdb2018-12-29 02:26:59 +00007488 addrReset = sqlite3VdbeMakeLabel(pParse);
drh0a07c102008-01-03 18:03:08 +00007489 iAMem = pParse->nMem + 1;
drh13449892005-09-07 21:22:45 +00007490 pParse->nMem += pGroupBy->nExpr;
drh0a07c102008-01-03 18:03:08 +00007491 iBMem = pParse->nMem + 1;
drh13449892005-09-07 21:22:45 +00007492 pParse->nMem += pGroupBy->nExpr;
drh4c583122008-01-04 22:01:03 +00007493 sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
drhd4e70eb2008-01-02 00:34:36 +00007494 VdbeComment((v, "clear abort flag"));
drhb8475df2011-12-09 16:21:19 +00007495 sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
drhe3133822005-09-20 13:11:59 +00007496
drh13449892005-09-07 21:22:45 +00007497 /* Begin a loop that will extract all source rows in GROUP BY order.
7498 ** This might involve two separate loops with an OP_Sort in between, or
7499 ** it might be a single loop that uses an index to extract information
7500 ** in the right order to begin with.
7501 */
drh2eb95372008-06-06 15:04:36 +00007502 sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
drhcfd74702018-03-19 22:28:34 +00007503 SELECTTRACE(1,pParse,p,("WhereBegin\n"));
dan5383db72021-03-12 18:24:31 +00007504 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, pDistinct,
danece092e2022-03-16 12:06:00 +00007505 0, (sDistinct.isTnct==2 ? WHERE_DISTINCTBY : WHERE_GROUPBY)
7506 | (orderByGrp ? WHERE_SORTBYGROUP : 0) | distFlag, 0
dan374cd782014-04-21 13:21:56 +00007507 );
danbfd6f1b2021-04-08 20:29:12 +00007508 if( pWInfo==0 ){
7509 sqlite3ExprListDelete(db, pDistinct);
7510 goto select_end;
7511 }
dan76075802021-03-12 21:09:20 +00007512 eDist = sqlite3WhereIsDistinct(pWInfo);
drh13162ef2021-02-16 20:01:08 +00007513 SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
drhddba0c22014-03-18 20:33:42 +00007514 if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
drh13449892005-09-07 21:22:45 +00007515 /* The optimizer is able to deliver rows in group by order so
drhb9bb7c12006-06-11 23:41:55 +00007516 ** we do not have to sort. The OP_OpenEphemeral table will be
drh13449892005-09-07 21:22:45 +00007517 ** cancelled later because we still need to use the pKeyInfo
7518 */
drh13449892005-09-07 21:22:45 +00007519 groupBySort = 0;
7520 }else{
7521 /* Rows are coming out in undetermined order. We have to push
7522 ** each row into a sorting index, terminate the first loop,
7523 ** then loop over the sorting index in order to get the output
7524 ** in sorted order
7525 */
drh892d3172008-01-10 03:46:36 +00007526 int regBase;
7527 int regRecord;
7528 int nCol;
7529 int nGroupBy;
7530
dan2ce22452010-11-08 19:01:16 +00007531 explainTempTable(pParse,
drhe8e4af72012-09-21 00:04:28 +00007532 (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
7533 "DISTINCT" : "GROUP BY");
dan2ce22452010-11-08 19:01:16 +00007534
drh13449892005-09-07 21:22:45 +00007535 groupBySort = 1;
drh892d3172008-01-10 03:46:36 +00007536 nGroupBy = pGroupBy->nExpr;
dandd23c6b2014-03-24 20:19:07 +00007537 nCol = nGroupBy;
7538 j = nGroupBy;
drhbf790972020-06-07 20:18:07 +00007539 for(i=0; i<pAggInfo->nColumn; i++){
7540 if( pAggInfo->aCol[i].iSorterColumn>=j ){
drh892d3172008-01-10 03:46:36 +00007541 nCol++;
7542 j++;
7543 }
7544 }
7545 regBase = sqlite3GetTempRange(pParse, nCol);
drh5579d592015-08-26 14:01:41 +00007546 sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0, 0);
dandd23c6b2014-03-24 20:19:07 +00007547 j = nGroupBy;
drhee373022022-07-25 15:54:23 +00007548 pAggInfo->directMode = 1;
drhbf790972020-06-07 20:18:07 +00007549 for(i=0; i<pAggInfo->nColumn; i++){
7550 struct AggInfo_col *pCol = &pAggInfo->aCol[i];
drh892d3172008-01-10 03:46:36 +00007551 if( pCol->iSorterColumn>=j ){
drhee373022022-07-25 15:54:23 +00007552 sqlite3ExprCode(pParse, pCol->pCExpr, j + regBase);
drh6a012f02008-08-21 14:15:59 +00007553 j++;
drh892d3172008-01-10 03:46:36 +00007554 }
drh13449892005-09-07 21:22:45 +00007555 }
drhee373022022-07-25 15:54:23 +00007556 pAggInfo->directMode = 0;
drh892d3172008-01-10 03:46:36 +00007557 regRecord = sqlite3GetTempReg(pParse);
drh1db639c2008-01-17 02:36:28 +00007558 sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
drhbf790972020-06-07 20:18:07 +00007559 sqlite3VdbeAddOp2(v, OP_SorterInsert, pAggInfo->sortingIdx, regRecord);
drh892d3172008-01-10 03:46:36 +00007560 sqlite3ReleaseTempReg(pParse, regRecord);
7561 sqlite3ReleaseTempRange(pParse, regBase, nCol);
drh13162ef2021-02-16 20:01:08 +00007562 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
drh13449892005-09-07 21:22:45 +00007563 sqlite3WhereEnd(pWInfo);
drhbf790972020-06-07 20:18:07 +00007564 pAggInfo->sortingIdxPTab = sortPTab = pParse->nTab++;
drh1c9d8352011-09-01 16:01:27 +00007565 sortOut = sqlite3GetTempReg(pParse);
7566 sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
drhbf790972020-06-07 20:18:07 +00007567 sqlite3VdbeAddOp2(v, OP_SorterSort, pAggInfo->sortingIdx, addrEnd);
drh688852a2014-02-17 22:40:43 +00007568 VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
drhbf790972020-06-07 20:18:07 +00007569 pAggInfo->useSortingIdx = 1;
dan374cd782014-04-21 13:21:56 +00007570 }
7571
7572 /* If the index or temporary table used by the GROUP BY sort
7573 ** will naturally deliver rows in the order required by the ORDER BY
7574 ** clause, cancel the ephemeral table open coded earlier.
7575 **
7576 ** This is an optimization - the correct answer should result regardless.
7577 ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
7578 ** disable this optimization for testing purposes. */
7579 if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
7580 && (groupBySort || sqlite3WhereIsSorted(pWInfo))
7581 ){
7582 sSort.pOrderBy = 0;
7583 sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
drh13449892005-09-07 21:22:45 +00007584 }
7585
7586 /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
7587 ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
7588 ** Then compare the current GROUP BY terms against the GROUP BY terms
7589 ** from the previous row currently stored in a0, a1, a2...
7590 */
7591 addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
drh1c9d8352011-09-01 16:01:27 +00007592 if( groupBySort ){
drhbf790972020-06-07 20:18:07 +00007593 sqlite3VdbeAddOp3(v, OP_SorterData, pAggInfo->sortingIdx,
drh38b41492015-06-08 15:08:15 +00007594 sortOut, sortPTab);
drh1c9d8352011-09-01 16:01:27 +00007595 }
drh13449892005-09-07 21:22:45 +00007596 for(j=0; j<pGroupBy->nExpr; j++){
7597 if( groupBySort ){
drh1c9d8352011-09-01 16:01:27 +00007598 sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
drh13449892005-09-07 21:22:45 +00007599 }else{
drhbf790972020-06-07 20:18:07 +00007600 pAggInfo->directMode = 1;
drh2dcef112008-01-12 19:03:48 +00007601 sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
drh13449892005-09-07 21:22:45 +00007602 }
drh13449892005-09-07 21:22:45 +00007603 }
drh16ee60f2008-06-20 18:13:25 +00007604 sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
drh2ec2fb22013-11-06 19:59:23 +00007605 (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
drh728e0f92015-10-10 14:41:28 +00007606 addr1 = sqlite3VdbeCurrentAddr(v);
7607 sqlite3VdbeAddOp3(v, OP_Jump, addr1+1, 0, addr1+1); VdbeCoverage(v);
drh13449892005-09-07 21:22:45 +00007608
7609 /* Generate code that runs whenever the GROUP BY changes.
drhe00ee6e2008-06-20 15:24:01 +00007610 ** Changes in the GROUP BY are detected by the previous code
drh13449892005-09-07 21:22:45 +00007611 ** block. If there were no changes, this block is skipped.
7612 **
7613 ** This code copies current group by terms in b0,b1,b2,...
7614 ** over to a0,a1,a2. It then calls the output subroutine
7615 ** and resets the aggregate accumulator registers in preparation
7616 ** for the next GROUP BY batch.
7617 */
drhb21e7c72008-06-22 12:37:57 +00007618 sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
drh2eb95372008-06-06 15:04:36 +00007619 sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
drhd4e70eb2008-01-02 00:34:36 +00007620 VdbeComment((v, "output one row"));
drh688852a2014-02-17 22:40:43 +00007621 sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
drhd4e70eb2008-01-02 00:34:36 +00007622 VdbeComment((v, "check abort flag"));
drh2eb95372008-06-06 15:04:36 +00007623 sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
drhd4e70eb2008-01-02 00:34:36 +00007624 VdbeComment((v, "reset accumulator"));
drh13449892005-09-07 21:22:45 +00007625
7626 /* Update the aggregate accumulators based on the content of
7627 ** the current row
7628 */
drh728e0f92015-10-10 14:41:28 +00007629 sqlite3VdbeJumpHere(v, addr1);
dan5383db72021-03-12 18:24:31 +00007630 updateAccumulator(pParse, iUseFlag, pAggInfo, eDist);
drh4c583122008-01-04 22:01:03 +00007631 sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
drhd4e70eb2008-01-02 00:34:36 +00007632 VdbeComment((v, "indicate data in accumulator"));
drh13449892005-09-07 21:22:45 +00007633
7634 /* End of the loop
7635 */
7636 if( groupBySort ){
drhd1930572021-01-13 15:23:17 +00007637 sqlite3VdbeAddOp2(v, OP_SorterNext, pAggInfo->sortingIdx,addrTopOfLoop);
drh688852a2014-02-17 22:40:43 +00007638 VdbeCoverage(v);
drh13449892005-09-07 21:22:45 +00007639 }else{
drh13162ef2021-02-16 20:01:08 +00007640 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
drh13449892005-09-07 21:22:45 +00007641 sqlite3WhereEnd(pWInfo);
drh48f2d3b2011-09-16 01:34:43 +00007642 sqlite3VdbeChangeToNoop(v, addrSortingIdx);
drh13449892005-09-07 21:22:45 +00007643 }
danbfd6f1b2021-04-08 20:29:12 +00007644 sqlite3ExprListDelete(db, pDistinct);
drh13449892005-09-07 21:22:45 +00007645
7646 /* Output the final row of result
7647 */
drh2eb95372008-06-06 15:04:36 +00007648 sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
drhd4e70eb2008-01-02 00:34:36 +00007649 VdbeComment((v, "output final row"));
drhd1766112008-09-17 00:13:12 +00007650
7651 /* Jump over the subroutines
7652 */
drh076e85f2015-09-03 13:46:12 +00007653 sqlite3VdbeGoto(v, addrEnd);
drhd1766112008-09-17 00:13:12 +00007654
7655 /* Generate a subroutine that outputs a single row of the result
7656 ** set. This subroutine first looks at the iUseFlag. If iUseFlag
7657 ** is less than or equal to zero, the subroutine is a no-op. If
7658 ** the processing calls for the query to abort, this subroutine
7659 ** increments the iAbortFlag memory location before returning in
7660 ** order to signal the caller to abort.
7661 */
7662 addrSetAbort = sqlite3VdbeCurrentAddr(v);
7663 sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
7664 VdbeComment((v, "set abort flag"));
7665 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7666 sqlite3VdbeResolveLabel(v, addrOutputRow);
7667 addrOutputRow = sqlite3VdbeCurrentAddr(v);
7668 sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2);
drh38b41492015-06-08 15:08:15 +00007669 VdbeCoverage(v);
drhd1766112008-09-17 00:13:12 +00007670 VdbeComment((v, "Groupby result generator entry point"));
7671 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
drhbf790972020-06-07 20:18:07 +00007672 finalizeAggFunctions(pParse, pAggInfo);
drh33cd4902009-05-30 20:49:20 +00007673 sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
drh2def2f72017-09-15 17:40:34 +00007674 selectInnerLoop(pParse, p, -1, &sSort,
drhe8e4af72012-09-21 00:04:28 +00007675 &sDistinct, pDest,
drhd1766112008-09-17 00:13:12 +00007676 addrOutputRow+1, addrSetAbort);
7677 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7678 VdbeComment((v, "end groupby result generator"));
7679
7680 /* Generate a subroutine that will reset the group-by accumulator
7681 */
7682 sqlite3VdbeResolveLabel(v, addrReset);
drhbf790972020-06-07 20:18:07 +00007683 resetAccumulator(pParse, pAggInfo);
dan280c8942018-06-05 20:04:28 +00007684 sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
7685 VdbeComment((v, "indicate accumulator empty"));
drhd1766112008-09-17 00:13:12 +00007686 sqlite3VdbeAddOp1(v, OP_Return, regReset);
dan5383db72021-03-12 18:24:31 +00007687
danece092e2022-03-16 12:06:00 +00007688 if( distFlag!=0 && eDist!=WHERE_DISTINCT_NOOP ){
dan5383db72021-03-12 18:24:31 +00007689 struct AggInfo_func *pF = &pAggInfo->aFunc[0];
7690 fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7691 }
drh43152cf2009-05-19 19:04:58 +00007692 } /* endif pGroupBy. Begin aggregate queries without GROUP BY: */
drh13449892005-09-07 21:22:45 +00007693 else {
danielk1977a5533162009-02-24 10:01:51 +00007694 Table *pTab;
drhbf790972020-06-07 20:18:07 +00007695 if( (pTab = isSimpleCount(p, pAggInfo))!=0 ){
danielk1977a5533162009-02-24 10:01:51 +00007696 /* If isSimpleCount() returns a pointer to a Table structure, then
7697 ** the SQL statement is of the form:
7698 **
7699 ** SELECT count(*) FROM <tbl>
7700 **
7701 ** where the Table structure returned represents table <tbl>.
7702 **
7703 ** This statement is so common that it is optimized specially. The
7704 ** OP_Count instruction is executed either on the intkey table that
7705 ** contains the data for table <tbl> or on one of its indexes. It
7706 ** is better to execute the op on an index, as indexes are almost
7707 ** always spread across less pages than their corresponding tables.
7708 */
7709 const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
7710 const int iCsr = pParse->nTab++; /* Cursor to scan b-tree */
7711 Index *pIdx; /* Iterator variable */
7712 KeyInfo *pKeyInfo = 0; /* Keyinfo for scanned index */
7713 Index *pBest = 0; /* Best index found so far */
drh013e7bb2020-07-30 17:37:49 +00007714 Pgno iRoot = pTab->tnum; /* Root page of scanned b-tree */
danielk1977a9d1ccb2008-01-05 17:39:29 +00007715
danielk1977a5533162009-02-24 10:01:51 +00007716 sqlite3CodeVerifySchema(pParse, iDb);
7717 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
7718
drhd9e3cad2013-10-04 02:36:19 +00007719 /* Search for the index that has the lowest scan cost.
danielk1977a5533162009-02-24 10:01:51 +00007720 **
drh3e9548b2011-04-15 14:46:27 +00007721 ** (2011-04-15) Do not do a full scan of an unordered index.
7722 **
drhabcc1942013-11-12 14:55:40 +00007723 ** (2013-10-03) Do not count the entries in a partial index.
drh5f33f372013-10-04 00:00:12 +00007724 **
danielk1977a5533162009-02-24 10:01:51 +00007725 ** In practice the KeyInfo structure will not be used. It is only
7726 ** passed to keep OP_OpenRead happy.
7727 */
drh5c7917e2013-11-12 15:33:40 +00007728 if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
drh98aa1d72020-05-08 18:22:00 +00007729 if( !p->pSrc->a[0].fg.notIndexed ){
7730 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
7731 if( pIdx->bUnordered==0
7732 && pIdx->szIdxRow<pTab->szTabRow
7733 && pIdx->pPartIdxWhere==0
7734 && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
7735 ){
7736 pBest = pIdx;
7737 }
danielk1977a5533162009-02-24 10:01:51 +00007738 }
7739 }
drhd9e3cad2013-10-04 02:36:19 +00007740 if( pBest ){
danielk1977a5533162009-02-24 10:01:51 +00007741 iRoot = pBest->tnum;
drh2ec2fb22013-11-06 19:59:23 +00007742 pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
danielk1977a5533162009-02-24 10:01:51 +00007743 }
7744
7745 /* Open a read-only cursor, execute the OP_Count, close the cursor. */
drh013e7bb2020-07-30 17:37:49 +00007746 sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, (int)iRoot, iDb, 1);
danielk1977a5533162009-02-24 10:01:51 +00007747 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00007748 sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
danielk1977a5533162009-02-24 10:01:51 +00007749 }
drhbf790972020-06-07 20:18:07 +00007750 sqlite3VdbeAddOp2(v, OP_Count, iCsr, pAggInfo->aFunc[0].iMem);
danielk1977a5533162009-02-24 10:01:51 +00007751 sqlite3VdbeAddOp1(v, OP_Close, iCsr);
danef7075d2011-02-21 17:49:49 +00007752 explainSimpleCount(pParse, pTab, pBest);
drhe50478d2020-03-17 13:41:51 +00007753 }else{
dan280c8942018-06-05 20:04:28 +00007754 int regAcc = 0; /* "populate accumulators" flag */
dan4fcb30b2021-03-09 16:06:25 +00007755 ExprList *pDistinct = 0;
7756 u16 distFlag = 0;
dan5383db72021-03-12 18:24:31 +00007757 int eDist;
dan280c8942018-06-05 20:04:28 +00007758
daned09ddd2019-09-20 20:52:16 +00007759 /* If there are accumulator registers but no min() or max() functions
7760 ** without FILTER clauses, allocate register regAcc. Register regAcc
7761 ** will contain 0 the first time the inner loop runs, and 1 thereafter.
7762 ** The code generated by updateAccumulator() uses this to ensure
7763 ** that the accumulator registers are (a) updated only once if
7764 ** there are no min() or max functions or (b) always updated for the
7765 ** first row visited by the aggregate, so that they are updated at
7766 ** least once even if the FILTER clause means the min() or max()
7767 ** function visits zero rows. */
drhbf790972020-06-07 20:18:07 +00007768 if( pAggInfo->nAccumulator ){
7769 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00007770 if( ExprHasProperty(pAggInfo->aFunc[i].pFExpr, EP_WinFunc) ){
drhbf790972020-06-07 20:18:07 +00007771 continue;
7772 }
7773 if( pAggInfo->aFunc[i].pFunc->funcFlags&SQLITE_FUNC_NEEDCOLL ){
7774 break;
7775 }
dan280c8942018-06-05 20:04:28 +00007776 }
drhbf790972020-06-07 20:18:07 +00007777 if( i==pAggInfo->nFunc ){
dan280c8942018-06-05 20:04:28 +00007778 regAcc = ++pParse->nMem;
7779 sqlite3VdbeAddOp2(v, OP_Integer, 0, regAcc);
7780 }
dan4fcb30b2021-03-09 16:06:25 +00007781 }else if( pAggInfo->nFunc==1 && pAggInfo->aFunc[0].iDistinct>=0 ){
drha4eeccd2021-10-07 17:43:30 +00007782 assert( ExprUseXList(pAggInfo->aFunc[0].pFExpr) );
dan4fcb30b2021-03-09 16:06:25 +00007783 pDistinct = pAggInfo->aFunc[0].pFExpr->x.pList;
danf330d532021-04-03 19:23:59 +00007784 distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
dan280c8942018-06-05 20:04:28 +00007785 }
7786
danielk1977a5533162009-02-24 10:01:51 +00007787 /* This case runs if the aggregate has no GROUP BY clause. The
7788 ** processing is much simpler since there is only a single row
7789 ** of output.
7790 */
drh47d9f832017-10-26 20:04:28 +00007791 assert( p->pGroupBy==0 );
drhbf790972020-06-07 20:18:07 +00007792 resetAccumulator(pParse, pAggInfo);
drh47d9f832017-10-26 20:04:28 +00007793
7794 /* If this query is a candidate for the min/max optimization, then
7795 ** minMaxFlag will have been previously set to either
7796 ** WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX and pMinMaxOrderBy will
7797 ** be an appropriate ORDER BY expression for the optimization.
7798 */
7799 assert( minMaxFlag==WHERE_ORDERBY_NORMAL || pMinMaxOrderBy!=0 );
7800 assert( pMinMaxOrderBy==0 || pMinMaxOrderBy->nExpr==1 );
7801
drhcfd74702018-03-19 22:28:34 +00007802 SELECTTRACE(1,pParse,p,("WhereBegin\n"));
drh47d9f832017-10-26 20:04:28 +00007803 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMaxOrderBy,
drh895bab32022-01-27 16:14:50 +00007804 pDistinct, 0, minMaxFlag|distFlag, 0);
danielk1977a5533162009-02-24 10:01:51 +00007805 if( pWInfo==0 ){
danielk1977a5533162009-02-24 10:01:51 +00007806 goto select_end;
7807 }
drh13162ef2021-02-16 20:01:08 +00007808 SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
dan5383db72021-03-12 18:24:31 +00007809 eDist = sqlite3WhereIsDistinct(pWInfo);
7810 updateAccumulator(pParse, regAcc, pAggInfo, eDist);
7811 if( eDist!=WHERE_DISTINCT_NOOP ){
drhde695ea2022-05-10 15:55:10 +00007812 struct AggInfo_func *pF = pAggInfo->aFunc;
drh3117b7b2022-04-19 18:23:01 +00007813 if( pF ){
7814 fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7815 }
dan5383db72021-03-12 18:24:31 +00007816 }
7817
dan280c8942018-06-05 20:04:28 +00007818 if( regAcc ) sqlite3VdbeAddOp2(v, OP_Integer, 1, regAcc);
drhd1930572021-01-13 15:23:17 +00007819 if( minMaxFlag ){
7820 sqlite3WhereMinMaxOptEarlyOut(v, pWInfo);
danielk1977a5533162009-02-24 10:01:51 +00007821 }
drh13162ef2021-02-16 20:01:08 +00007822 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
danielk1977a5533162009-02-24 10:01:51 +00007823 sqlite3WhereEnd(pWInfo);
drhbf790972020-06-07 20:18:07 +00007824 finalizeAggFunctions(pParse, pAggInfo);
danielk1977a9d1ccb2008-01-05 17:39:29 +00007825 }
7826
drh079a3072014-03-19 14:10:55 +00007827 sSort.pOrderBy = 0;
drh33cd4902009-05-30 20:49:20 +00007828 sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
drh2def2f72017-09-15 17:40:34 +00007829 selectInnerLoop(pParse, p, -1, 0, 0,
drha9671a22008-07-08 23:40:20 +00007830 pDest, addrEnd, addrEnd);
drh13449892005-09-07 21:22:45 +00007831 }
7832 sqlite3VdbeResolveLabel(v, addrEnd);
7833
7834 } /* endif aggregate query */
drh22827922000-06-06 17:27:05 +00007835
drhe8e4af72012-09-21 00:04:28 +00007836 if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
dan2ce22452010-11-08 19:01:16 +00007837 explainTempTable(pParse, "DISTINCT");
7838 }
7839
drhcce7d172000-05-31 15:34:51 +00007840 /* If there is an ORDER BY clause, then we need to sort the results
7841 ** and send them to the callback one by one.
7842 */
drh079a3072014-03-19 14:10:55 +00007843 if( sSort.pOrderBy ){
drh38b41492015-06-08 15:08:15 +00007844 explainTempTable(pParse,
7845 sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
dan24e25d32018-04-14 18:46:20 +00007846 assert( p->pEList==pEList );
drh079a3072014-03-19 14:10:55 +00007847 generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
drhcce7d172000-05-31 15:34:51 +00007848 }
drh6a535342001-10-19 16:44:56 +00007849
drhec7429a2005-10-06 16:53:14 +00007850 /* Jump here to skip this query
7851 */
7852 sqlite3VdbeResolveLabel(v, iEnd);
7853
dan5b1c07e2015-04-16 07:19:23 +00007854 /* The SELECT has been coded. If there is an error in the Parse structure,
7855 ** set the return code to 1. Otherwise 0. */
7856 rc = (pParse->nErr>0);
drh1d83f052002-02-17 00:30:36 +00007857
7858 /* Control jumps to here if an error is encountered above, or upon
7859 ** successful coding of the SELECT.
7860 */
7861select_end:
dan44918c72021-04-17 14:42:37 +00007862 assert( db->mallocFailed==0 || db->mallocFailed==1 );
drh0c7d3d32022-01-24 16:47:12 +00007863 assert( db->mallocFailed==0 || pParse->nErr!=0 );
drh47d9f832017-10-26 20:04:28 +00007864 sqlite3ExprListDelete(db, pMinMaxOrderBy);
drh89636622020-06-07 17:33:18 +00007865#ifdef SQLITE_DEBUG
drh7b4c4d42020-06-10 03:07:26 +00007866 if( pAggInfo && !db->mallocFailed ){
drhbf790972020-06-07 20:18:07 +00007867 for(i=0; i<pAggInfo->nColumn; i++){
drh81185a52020-06-09 13:38:12 +00007868 Expr *pExpr = pAggInfo->aCol[i].pCExpr;
drh06ddb082020-12-22 14:54:20 +00007869 assert( pExpr!=0 );
drhbf790972020-06-07 20:18:07 +00007870 assert( pExpr->pAggInfo==pAggInfo );
drh89636622020-06-07 17:33:18 +00007871 assert( pExpr->iAgg==i );
7872 }
drhbf790972020-06-07 20:18:07 +00007873 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00007874 Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
drh06ddb082020-12-22 14:54:20 +00007875 assert( pExpr!=0 );
drhbf790972020-06-07 20:18:07 +00007876 assert( pExpr->pAggInfo==pAggInfo );
drh89636622020-06-07 17:33:18 +00007877 assert( pExpr->iAgg==i );
7878 }
drh89636622020-06-07 17:33:18 +00007879 }
drh89636622020-06-07 17:33:18 +00007880#endif
7881
drh5e431be2022-04-06 11:08:38 +00007882#if TREETRACE_ENABLED
drhf20609d2018-04-23 17:43:35 +00007883 SELECTTRACE(0x1,pParse,p,("end processing\n"));
drh5e431be2022-04-06 11:08:38 +00007884 if( (sqlite3TreeTrace & 0x2000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
drhf20609d2018-04-23 17:43:35 +00007885 sqlite3TreeViewSelect(0, p, 0);
7886 }
drheb9b8842014-09-21 00:27:26 +00007887#endif
drhe2ca99c2018-05-02 00:33:43 +00007888 ExplainQueryPlanPop(pParse);
drh1d83f052002-02-17 00:30:36 +00007889 return rc;
drhcce7d172000-05-31 15:34:51 +00007890}