blob: 3f80e44ce25cba3e11253d7d2fd06804985441ea [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);
drhbffd5c12022-08-04 17:15:00 +00001691 assert( p->iLimit==0 && p->iOffset==0 );
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;
drhbffd5c12022-08-04 17:15:00 +00001699 if( p->iOffset>0 ){
1700 sqlite3VdbeAddOp2(v, OP_AddImm, p->iLimit, -1);
1701 }
drhf45f2322014-03-23 17:45:03 +00001702 }
dand6189ea2018-04-11 14:11:53 +00001703 for(i=0, iCol=nKey+bSeq-1; i<nColumn; i++){
dan24e25d32018-04-14 18:46:20 +00001704#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001705 if( aOutEx[i].fg.bSorterRef ) continue;
dan24e25d32018-04-14 18:46:20 +00001706#endif
drh9f895232018-01-24 20:42:42 +00001707 if( aOutEx[i].u.x.iOrderByCol==0 ) iCol++;
1708 }
dan24e25d32018-04-14 18:46:20 +00001709#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1710 if( pSort->nDefer ){
1711 int iKey = iCol+1;
1712 int regKey = sqlite3GetTempRange(pParse, nRefKey);
1713
1714 for(i=0; i<pSort->nDefer; i++){
1715 int iCsr = pSort->aDefer[i].iCsr;
1716 Table *pTab = pSort->aDefer[i].pTab;
1717 int nKey = pSort->aDefer[i].nKey;
1718
1719 sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1720 if( HasRowid(pTab) ){
1721 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey);
1722 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCsr,
1723 sqlite3VdbeCurrentAddr(v)+1, regKey);
1724 }else{
dan24e25d32018-04-14 18:46:20 +00001725 int k;
1726 int iJmp;
drh7590d092018-04-18 14:04:19 +00001727 assert( sqlite3PrimaryKeyIndex(pTab)->nKeyCol==nKey );
dan24e25d32018-04-14 18:46:20 +00001728 for(k=0; k<nKey; k++){
1729 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey+k);
1730 }
1731 iJmp = sqlite3VdbeCurrentAddr(v);
1732 sqlite3VdbeAddOp4Int(v, OP_SeekGE, iCsr, iJmp+2, regKey, nKey);
1733 sqlite3VdbeAddOp4Int(v, OP_IdxLE, iCsr, iJmp+3, regKey, nKey);
1734 sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1735 }
dan257c13f2016-11-10 20:14:06 +00001736 }
dan24e25d32018-04-14 18:46:20 +00001737 sqlite3ReleaseTempRange(pParse, regKey, nRefKey);
1738 }
1739#endif
1740 for(i=nColumn-1; i>=0; i--){
1741#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001742 if( aOutEx[i].fg.bSorterRef ){
dan24e25d32018-04-14 18:46:20 +00001743 sqlite3ExprCode(pParse, aOutEx[i].pExpr, regRow+i);
1744 }else
1745#endif
1746 {
1747 int iRead;
1748 if( aOutEx[i].u.x.iOrderByCol ){
1749 iRead = aOutEx[i].u.x.iOrderByCol-1;
1750 }else{
1751 iRead = iCol--;
1752 }
1753 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iRead, regRow+i);
drhcbb9da32019-12-12 22:11:33 +00001754 VdbeComment((v, "%s", aOutEx[i].zEName));
dan24e25d32018-04-14 18:46:20 +00001755 }
drhc6aff302011-09-01 15:32:47 +00001756 }
drhc926afb2002-06-20 03:38:26 +00001757 switch( eDest ){
danac56ab72017-01-05 17:23:11 +00001758 case SRT_Table:
drhb9bb7c12006-06-11 23:41:55 +00001759 case SRT_EphemTab: {
drh375afb82019-01-16 19:26:31 +00001760 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, nKey+bSeq, regRow);
drh2d401ab2008-01-10 23:50:11 +00001761 sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
1762 sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
1763 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
drhc926afb2002-06-20 03:38:26 +00001764 break;
1765 }
danielk197793758c82005-01-21 08:13:14 +00001766#ifndef SQLITE_OMIT_SUBQUERY
drhc926afb2002-06-20 03:38:26 +00001767 case SRT_Set: {
dan71c57db2016-07-09 20:23:55 +00001768 assert( nColumn==sqlite3Strlen30(pDest->zAffSdst) );
1769 sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, nColumn, regRowid,
dan553168c2016-08-01 20:14:31 +00001770 pDest->zAffSdst, nColumn);
drh9b4eaeb2016-11-09 00:10:33 +00001771 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, regRowid, regRow, nColumn);
drhc926afb2002-06-20 03:38:26 +00001772 break;
1773 }
1774 case SRT_Mem: {
drhec7429a2005-10-06 16:53:14 +00001775 /* The LIMIT clause will terminate the loop for us */
drhc926afb2002-06-20 03:38:26 +00001776 break;
1777 }
danielk197793758c82005-01-21 08:13:14 +00001778#endif
danf2972b62020-04-29 20:11:01 +00001779 case SRT_Upfrom: {
1780 int i2 = pDest->iSDParm2;
1781 int r1 = sqlite3GetTempReg(pParse);
1782 sqlite3VdbeAddOp3(v, OP_MakeRecord,regRow+(i2<0),nColumn-(i2<0),r1);
1783 if( i2<0 ){
1784 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regRow);
1785 }else{
1786 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regRow, i2);
1787 }
1788 break;
1789 }
drh373cc2d2009-05-17 02:06:14 +00001790 default: {
drh373cc2d2009-05-17 02:06:14 +00001791 assert( eDest==SRT_Output || eDest==SRT_Coroutine );
drh1c767f02009-01-09 02:49:31 +00001792 testcase( eDest==SRT_Output );
1793 testcase( eDest==SRT_Coroutine );
drh7d10d5a2008-08-20 16:35:10 +00001794 if( eDest==SRT_Output ){
drh2b596da2012-07-23 21:43:19 +00001795 sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
drha9671a22008-07-08 23:40:20 +00001796 }else{
drh2b596da2012-07-23 21:43:19 +00001797 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drhce665cf2004-05-21 03:01:58 +00001798 }
drhac82fcf2002-09-08 17:23:41 +00001799 break;
1800 }
drhc926afb2002-06-20 03:38:26 +00001801 }
drhf45f2322014-03-23 17:45:03 +00001802 if( regRowid ){
dan51d82d12016-08-02 18:50:15 +00001803 if( eDest==SRT_Set ){
1804 sqlite3ReleaseTempRange(pParse, regRow, nColumn);
1805 }else{
1806 sqlite3ReleaseTempReg(pParse, regRow);
1807 }
drhf45f2322014-03-23 17:45:03 +00001808 sqlite3ReleaseTempReg(pParse, regRowid);
1809 }
drhec7429a2005-10-06 16:53:14 +00001810 /* The bottom of the loop
1811 */
drhdc5ea5c2008-12-10 17:19:59 +00001812 sqlite3VdbeResolveLabel(v, addrContinue);
drh079a3072014-03-19 14:10:55 +00001813 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drh688852a2014-02-17 22:40:43 +00001814 sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
drhc6aff302011-09-01 15:32:47 +00001815 }else{
drh688852a2014-02-17 22:40:43 +00001816 sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
drhc6aff302011-09-01 15:32:47 +00001817 }
drh079a3072014-03-19 14:10:55 +00001818 if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
drhdc5ea5c2008-12-10 17:19:59 +00001819 sqlite3VdbeResolveLabel(v, addrBreak);
drhd8bc7082000-06-07 23:51:50 +00001820}
1821
1822/*
danielk1977517eb642004-06-07 10:00:31 +00001823** Return a pointer to a string containing the 'declaration type' of the
1824** expression pExpr. The string may be treated as static by the caller.
drhe78e8282003-01-19 03:59:45 +00001825**
danielk1977955de522006-02-10 02:27:42 +00001826** The declaration type is the exact datatype definition extracted from the
1827** original CREATE TABLE statement if the expression is a column. The
1828** declaration type for a ROWID field is INTEGER. Exactly when an expression
1829** is considered a column can be complex in the presence of subqueries. The
1830** result-set expression in all of the following SELECT statements is
1831** considered a column by this function.
1832**
1833** SELECT col FROM tbl;
1834** SELECT (SELECT col FROM tbl;
1835** SELECT (SELECT col FROM tbl);
1836** SELECT abc FROM (SELECT col AS abc FROM tbl);
danielk1977517eb642004-06-07 10:00:31 +00001837**
danielk1977955de522006-02-10 02:27:42 +00001838** The declaration type for any expression other than a column is NULL.
drh5f3e5e72013-10-08 20:01:35 +00001839**
1840** This routine has either 3 or 6 parameters depending on whether or not
1841** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
danielk1977517eb642004-06-07 10:00:31 +00001842*/
drh5f3e5e72013-10-08 20:01:35 +00001843#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhcafc2f72017-10-03 03:01:09 +00001844# define columnType(A,B,C,D,E) columnTypeImpl(A,B,C,D,E)
drhb121dd12015-06-06 18:30:17 +00001845#else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
drhcafc2f72017-10-03 03:01:09 +00001846# define columnType(A,B,C,D,E) columnTypeImpl(A,B)
drhb121dd12015-06-06 18:30:17 +00001847#endif
drh5f3e5e72013-10-08 20:01:35 +00001848static const char *columnTypeImpl(
danielk1977955de522006-02-10 02:27:42 +00001849 NameContext *pNC,
drhcafc2f72017-10-03 03:01:09 +00001850#ifndef SQLITE_ENABLE_COLUMN_METADATA
1851 Expr *pExpr
1852#else
danielk1977955de522006-02-10 02:27:42 +00001853 Expr *pExpr,
drh5f3e5e72013-10-08 20:01:35 +00001854 const char **pzOrigDb,
1855 const char **pzOrigTab,
drhcafc2f72017-10-03 03:01:09 +00001856 const char **pzOrigCol
drhb121dd12015-06-06 18:30:17 +00001857#endif
danielk1977955de522006-02-10 02:27:42 +00001858){
1859 char const *zType = 0;
danielk1977517eb642004-06-07 10:00:31 +00001860 int j;
drhb121dd12015-06-06 18:30:17 +00001861#ifdef SQLITE_ENABLE_COLUMN_METADATA
1862 char const *zOrigDb = 0;
1863 char const *zOrigTab = 0;
1864 char const *zOrigCol = 0;
1865#endif
danielk19775338a5f2005-01-20 13:03:10 +00001866
drhf7ce4292015-12-02 19:46:12 +00001867 assert( pExpr!=0 );
1868 assert( pNC->pSrcList!=0 );
danielk197700e279d2004-06-21 07:36:32 +00001869 switch( pExpr->op ){
1870 case TK_COLUMN: {
danielk1977955de522006-02-10 02:27:42 +00001871 /* The expression is a column. Locate the table the column is being
1872 ** extracted from in NameContext.pSrcList. This table may be real
1873 ** database table or a subquery.
1874 */
1875 Table *pTab = 0; /* Table structure column is extracted from */
1876 Select *pS = 0; /* Select the column is extracted from */
1877 int iCol = pExpr->iColumn; /* Index of column in pTab */
dan43bc88b2009-09-10 10:15:59 +00001878 while( pNC && !pTab ){
danielk1977b3bce662005-01-29 08:32:43 +00001879 SrcList *pTabList = pNC->pSrcList;
1880 for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
1881 if( j<pTabList->nSrc ){
1882 pTab = pTabList->a[j].pTab;
danielk1977955de522006-02-10 02:27:42 +00001883 pS = pTabList->a[j].pSelect;
danielk1977b3bce662005-01-29 08:32:43 +00001884 }else{
1885 pNC = pNC->pNext;
1886 }
1887 }
danielk1977955de522006-02-10 02:27:42 +00001888
dan43bc88b2009-09-10 10:15:59 +00001889 if( pTab==0 ){
drh417168a2009-09-07 18:14:02 +00001890 /* At one time, code such as "SELECT new.x" within a trigger would
1891 ** cause this condition to run. Since then, we have restructured how
1892 ** trigger code is generated and so this condition is no longer
dan43bc88b2009-09-10 10:15:59 +00001893 ** possible. However, it can still be true for statements like
1894 ** the following:
1895 **
1896 ** CREATE TABLE t1(col INTEGER);
1897 ** SELECT (SELECT t1.col) FROM FROM t1;
1898 **
1899 ** when columnType() is called on the expression "t1.col" in the
1900 ** sub-select. In this case, set the column type to NULL, even
1901 ** though it should really be "INTEGER".
1902 **
1903 ** This is not a problem, as the column type of "t1.col" is never
1904 ** used. When columnType() is called on the expression
1905 ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
1906 ** branch below. */
drh7e627792005-04-29 02:10:00 +00001907 break;
1908 }
danielk1977955de522006-02-10 02:27:42 +00001909
drh477572b2021-10-07 20:46:29 +00001910 assert( pTab && ExprUseYTab(pExpr) && pExpr->y.pTab==pTab );
danielk1977955de522006-02-10 02:27:42 +00001911 if( pS ){
1912 /* The "table" is actually a sub-select or a view in the FROM clause
1913 ** of the SELECT statement. Return the declaration type and origin
1914 ** data for the result-set column of the sub-select.
1915 */
drh6e5020e2021-04-07 15:45:01 +00001916 if( iCol<pS->pEList->nExpr
1917#ifdef SQLITE_ALLOW_ROWID_IN_VIEW
1918 && iCol>=0
1919#else
1920 && ALWAYS(iCol>=0)
1921#endif
1922 ){
danielk1977955de522006-02-10 02:27:42 +00001923 /* If iCol is less than zero, then the expression requests the
1924 ** rowid of the sub-select or view. This expression is legal (see
1925 ** test case misc2.2.2) - it always evaluates to NULL.
1926 */
1927 NameContext sNC;
1928 Expr *p = pS->pEList->a[iCol].pExpr;
1929 sNC.pSrcList = pS->pSrc;
dan43bc88b2009-09-10 10:15:59 +00001930 sNC.pNext = pNC;
danielk1977955de522006-02-10 02:27:42 +00001931 sNC.pParse = pNC->pParse;
drhcafc2f72017-10-03 03:01:09 +00001932 zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol);
danielk1977955de522006-02-10 02:27:42 +00001933 }
drha78d7572017-10-03 16:57:33 +00001934 }else{
1935 /* A real table or a CTE table */
danielk1977955de522006-02-10 02:27:42 +00001936 assert( !pS );
drh5f3e5e72013-10-08 20:01:35 +00001937#ifdef SQLITE_ENABLE_COLUMN_METADATA
drha78d7572017-10-03 16:57:33 +00001938 if( iCol<0 ) iCol = pTab->iPKey;
1939 assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
danielk1977955de522006-02-10 02:27:42 +00001940 if( iCol<0 ){
1941 zType = "INTEGER";
drh5f3e5e72013-10-08 20:01:35 +00001942 zOrigCol = "rowid";
danielk1977955de522006-02-10 02:27:42 +00001943 }else{
drhcf9d36d2021-08-02 18:03:43 +00001944 zOrigCol = pTab->aCol[iCol].zCnName;
drhd7564862016-03-22 20:05:09 +00001945 zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
danielk1977955de522006-02-10 02:27:42 +00001946 }
drh5f3e5e72013-10-08 20:01:35 +00001947 zOrigTab = pTab->zName;
drha78d7572017-10-03 16:57:33 +00001948 if( pNC->pParse && pTab->pSchema ){
danielk1977955de522006-02-10 02:27:42 +00001949 int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
drhe59be012016-08-18 20:56:39 +00001950 zOrigDb = pNC->pParse->db->aDb[iDb].zDbSName;
danielk1977955de522006-02-10 02:27:42 +00001951 }
drh5f3e5e72013-10-08 20:01:35 +00001952#else
drha78d7572017-10-03 16:57:33 +00001953 assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
drh5f3e5e72013-10-08 20:01:35 +00001954 if( iCol<0 ){
1955 zType = "INTEGER";
1956 }else{
drhd7564862016-03-22 20:05:09 +00001957 zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
drh5f3e5e72013-10-08 20:01:35 +00001958 }
1959#endif
danielk197700e279d2004-06-21 07:36:32 +00001960 }
1961 break;
danielk1977517eb642004-06-07 10:00:31 +00001962 }
danielk197793758c82005-01-21 08:13:14 +00001963#ifndef SQLITE_OMIT_SUBQUERY
danielk197700e279d2004-06-21 07:36:32 +00001964 case TK_SELECT: {
danielk1977955de522006-02-10 02:27:42 +00001965 /* The expression is a sub-select. Return the declaration type and
1966 ** origin info for the single column in the result set of the SELECT
1967 ** statement.
1968 */
danielk1977b3bce662005-01-29 08:32:43 +00001969 NameContext sNC;
drha4eeccd2021-10-07 17:43:30 +00001970 Select *pS;
1971 Expr *p;
1972 assert( ExprUseXSelect(pExpr) );
1973 pS = pExpr->x.pSelect;
1974 p = pS->pEList->a[0].pExpr;
danielk1977955de522006-02-10 02:27:42 +00001975 sNC.pSrcList = pS->pSrc;
danielk1977b3bce662005-01-29 08:32:43 +00001976 sNC.pNext = pNC;
danielk1977955de522006-02-10 02:27:42 +00001977 sNC.pParse = pNC->pParse;
drhcafc2f72017-10-03 03:01:09 +00001978 zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
danielk197700e279d2004-06-21 07:36:32 +00001979 break;
danielk1977517eb642004-06-07 10:00:31 +00001980 }
danielk197793758c82005-01-21 08:13:14 +00001981#endif
danielk1977517eb642004-06-07 10:00:31 +00001982 }
drh5f3e5e72013-10-08 20:01:35 +00001983
1984#ifdef SQLITE_ENABLE_COLUMN_METADATA
1985 if( pzOrigDb ){
1986 assert( pzOrigTab && pzOrigCol );
1987 *pzOrigDb = zOrigDb;
1988 *pzOrigTab = zOrigTab;
1989 *pzOrigCol = zOrigCol;
danielk1977955de522006-02-10 02:27:42 +00001990 }
drh5f3e5e72013-10-08 20:01:35 +00001991#endif
danielk1977517eb642004-06-07 10:00:31 +00001992 return zType;
1993}
1994
1995/*
1996** Generate code that will tell the VDBE the declaration types of columns
1997** in the result set.
drhfcb78a42003-01-18 20:11:05 +00001998*/
1999static void generateColumnTypes(
2000 Parse *pParse, /* Parser context */
drhfcb78a42003-01-18 20:11:05 +00002001 SrcList *pTabList, /* List of tables */
2002 ExprList *pEList /* Expressions defining the result set */
2003){
drh3f913572008-03-22 01:07:17 +00002004#ifndef SQLITE_OMIT_DECLTYPE
drhfcb78a42003-01-18 20:11:05 +00002005 Vdbe *v = pParse->pVdbe;
danielk1977517eb642004-06-07 10:00:31 +00002006 int i;
danielk1977b3bce662005-01-29 08:32:43 +00002007 NameContext sNC;
2008 sNC.pSrcList = pTabList;
danielk1977955de522006-02-10 02:27:42 +00002009 sNC.pParse = pParse;
drheac5fc02017-04-11 01:01:27 +00002010 sNC.pNext = 0;
drhfcb78a42003-01-18 20:11:05 +00002011 for(i=0; i<pEList->nExpr; i++){
2012 Expr *p = pEList->a[i].pExpr;
drh3f913572008-03-22 01:07:17 +00002013 const char *zType;
2014#ifdef SQLITE_ENABLE_COLUMN_METADATA
danielk1977955de522006-02-10 02:27:42 +00002015 const char *zOrigDb = 0;
2016 const char *zOrigTab = 0;
2017 const char *zOrigCol = 0;
drhcafc2f72017-10-03 03:01:09 +00002018 zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
danielk1977955de522006-02-10 02:27:42 +00002019
drh85b623f2007-12-13 21:54:09 +00002020 /* The vdbe must make its own copy of the column-type and other
danielk19774b1ae992006-02-10 03:06:10 +00002021 ** column specific strings, in case the schema is reset before this
2022 ** virtual machine is deleted.
danielk1977fbcd5852004-06-15 02:44:18 +00002023 */
danielk197710fb7492008-10-31 10:53:22 +00002024 sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
2025 sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
2026 sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
drh3f913572008-03-22 01:07:17 +00002027#else
drhcafc2f72017-10-03 03:01:09 +00002028 zType = columnType(&sNC, p, 0, 0, 0);
drh3f913572008-03-22 01:07:17 +00002029#endif
danielk197710fb7492008-10-31 10:53:22 +00002030 sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
drhfcb78a42003-01-18 20:11:05 +00002031 }
drh5f3e5e72013-10-08 20:01:35 +00002032#endif /* !defined(SQLITE_OMIT_DECLTYPE) */
drhfcb78a42003-01-18 20:11:05 +00002033}
2034
drheac5fc02017-04-11 01:01:27 +00002035
2036/*
drhec360a82017-07-12 14:10:19 +00002037** Compute the column names for a SELECT statement.
2038**
2039** The only guarantee that SQLite makes about column names is that if the
2040** column has an AS clause assigning it a name, that will be the name used.
2041** That is the only documented guarantee. However, countless applications
2042** developed over the years have made baseless assumptions about column names
2043** and will break if those assumptions changes. Hence, use extreme caution
2044** when modifying this routine to avoid breaking legacy.
2045**
2046** See Also: sqlite3ColumnsFromExprList()
2047**
2048** The PRAGMA short_column_names and PRAGMA full_column_names settings are
2049** deprecated. The default setting is short=ON, full=OFF. 99.9% of all
2050** applications should operate this way. Nevertheless, we need to support the
2051** other modes for legacy:
2052**
2053** short=OFF, full=OFF: Column name is the text of the expression has it
2054** originally appears in the SELECT statement. In
2055** other words, the zSpan of the result expression.
2056**
2057** short=ON, full=OFF: (This is the default setting). If the result
drh3d240d22017-09-28 16:56:55 +00002058** refers directly to a table column, then the
2059** result column name is just the table column
2060** name: COLUMN. Otherwise use zSpan.
drhec360a82017-07-12 14:10:19 +00002061**
2062** full=ON, short=ANY: If the result refers directly to a table column,
2063** then the result column name with the table name
2064** prefix, ex: TABLE.COLUMN. Otherwise use zSpan.
drh82c3d632000-06-06 21:56:07 +00002065*/
drh90881862021-05-19 12:17:03 +00002066void sqlite3GenerateColumnNames(
drh832508b2002-03-02 17:04:07 +00002067 Parse *pParse, /* Parser context */
drhf35f2f92017-07-29 16:01:55 +00002068 Select *pSelect /* Generate column names for this SELECT statement */
drh832508b2002-03-02 17:04:07 +00002069){
drhd8bc7082000-06-07 23:51:50 +00002070 Vdbe *v = pParse->pVdbe;
drheac5fc02017-04-11 01:01:27 +00002071 int i;
2072 Table *pTab;
drhf35f2f92017-07-29 16:01:55 +00002073 SrcList *pTabList;
2074 ExprList *pEList;
drh9bb575f2004-09-06 17:24:11 +00002075 sqlite3 *db = pParse->db;
drhf35f2f92017-07-29 16:01:55 +00002076 int fullName; /* TABLE.COLUMN if no AS clause and is a direct table ref */
2077 int srcName; /* COLUMN or TABLE.COLUMN if no AS clause and is direct */
drhfcabd462004-02-20 14:50:58 +00002078
drhfe2093d2005-01-20 22:48:47 +00002079#ifndef SQLITE_OMIT_EXPLAIN
danielk19773cf86062004-05-26 10:11:05 +00002080 /* If this is an EXPLAIN, skip this step */
2081 if( pParse->explain ){
danielk197761de0d12004-05-27 23:56:16 +00002082 return;
danielk19773cf86062004-05-26 10:11:05 +00002083 }
danielk19775338a5f2005-01-20 13:03:10 +00002084#endif
danielk19773cf86062004-05-26 10:11:05 +00002085
drh5e8b9852018-05-03 22:52:56 +00002086 if( pParse->colNamesSet ) return;
drhf35f2f92017-07-29 16:01:55 +00002087 /* Column names are determined by the left-most term of a compound select */
2088 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh07859482017-12-23 11:51:40 +00002089 SELECTTRACE(1,pParse,pSelect,("generating column names\n"));
drhf35f2f92017-07-29 16:01:55 +00002090 pTabList = pSelect->pSrc;
2091 pEList = pSelect->pEList;
drh98029472015-12-03 21:47:30 +00002092 assert( v!=0 );
drhf7ce4292015-12-02 19:46:12 +00002093 assert( pTabList!=0 );
drhd8bc7082000-06-07 23:51:50 +00002094 pParse->colNamesSet = 1;
drhec360a82017-07-12 14:10:19 +00002095 fullName = (db->flags & SQLITE_FullColNames)!=0;
2096 srcName = (db->flags & SQLITE_ShortColNames)!=0 || fullName;
danielk197722322fd2004-05-25 23:35:17 +00002097 sqlite3VdbeSetNumCols(v, pEList->nExpr);
drh82c3d632000-06-06 21:56:07 +00002098 for(i=0; i<pEList->nExpr; i++){
drhec360a82017-07-12 14:10:19 +00002099 Expr *p = pEList->a[i].pExpr;
2100
2101 assert( p!=0 );
drh4dd89d52017-08-14 14:53:24 +00002102 assert( p->op!=TK_AGG_COLUMN ); /* Agg processing has not run yet */
drh477572b2021-10-07 20:46:29 +00002103 assert( p->op!=TK_COLUMN
2104 || (ExprUseYTab(p) && p->y.pTab!=0) ); /* Covering idx not yet coded */
drhd88fd532022-05-02 20:49:30 +00002105 if( pEList->a[i].zEName && pEList->a[i].fg.eEName==ENAME_NAME ){
drhec360a82017-07-12 14:10:19 +00002106 /* An AS clause always takes first priority */
drh41cee662019-12-12 20:22:34 +00002107 char *zName = pEList->a[i].zEName;
danielk197710fb7492008-10-31 10:53:22 +00002108 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
drhf35f2f92017-07-29 16:01:55 +00002109 }else if( srcName && p->op==TK_COLUMN ){
drh97665872002-02-13 23:22:53 +00002110 char *zCol;
drh8aff1012001-12-22 14:49:24 +00002111 int iCol = p->iColumn;
drheda079c2018-09-20 19:02:15 +00002112 pTab = p->y.pTab;
drhf35f2f92017-07-29 16:01:55 +00002113 assert( pTab!=0 );
drh8aff1012001-12-22 14:49:24 +00002114 if( iCol<0 ) iCol = pTab->iPKey;
drh97665872002-02-13 23:22:53 +00002115 assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
drhb1363202002-06-26 02:45:03 +00002116 if( iCol<0 ){
drh47a6db22005-01-18 16:02:40 +00002117 zCol = "rowid";
drhb1363202002-06-26 02:45:03 +00002118 }else{
drhcf9d36d2021-08-02 18:03:43 +00002119 zCol = pTab->aCol[iCol].zCnName;
drhb1363202002-06-26 02:45:03 +00002120 }
drhec360a82017-07-12 14:10:19 +00002121 if( fullName ){
drh82c3d632000-06-06 21:56:07 +00002122 char *zName = 0;
drh1c767f02009-01-09 02:49:31 +00002123 zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
danielk197710fb7492008-10-31 10:53:22 +00002124 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
drh82c3d632000-06-06 21:56:07 +00002125 }else{
danielk197710fb7492008-10-31 10:53:22 +00002126 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
drh82c3d632000-06-06 21:56:07 +00002127 }
drh1bee3d72001-10-15 00:44:35 +00002128 }else{
drhcbb9da32019-12-12 22:11:33 +00002129 const char *z = pEList->a[i].zEName;
drh859bc542014-01-13 20:32:18 +00002130 z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
2131 sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
drh82c3d632000-06-06 21:56:07 +00002132 }
2133 }
danielk197776d505b2004-05-28 13:13:02 +00002134 generateColumnTypes(pParse, pTabList, pEList);
drh82c3d632000-06-06 21:56:07 +00002135}
2136
drhd8bc7082000-06-07 23:51:50 +00002137/*
peter.d.reid60ec9142014-09-06 16:39:46 +00002138** Given an expression list (which is really the list of expressions
drh7d10d5a2008-08-20 16:35:10 +00002139** that form the result set of a SELECT statement) compute appropriate
2140** column names for a table that would hold the expression list.
2141**
2142** All column names will be unique.
2143**
2144** Only the column names are computed. Column.zType, Column.zColl,
2145** and other fields of Column are zeroed.
2146**
2147** Return SQLITE_OK on success. If a memory allocation error occurs,
2148** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
drhec360a82017-07-12 14:10:19 +00002149**
2150** The only guarantee that SQLite makes about column names is that if the
2151** column has an AS clause assigning it a name, that will be the name used.
2152** That is the only documented guarantee. However, countless applications
2153** developed over the years have made baseless assumptions about column names
2154** and will break if those assumptions changes. Hence, use extreme caution
2155** when modifying this routine to avoid breaking legacy.
2156**
drh90881862021-05-19 12:17:03 +00002157** See Also: sqlite3GenerateColumnNames()
drh315555c2002-10-20 15:53:03 +00002158*/
drh8981b902015-08-24 17:42:49 +00002159int sqlite3ColumnsFromExprList(
drh7d10d5a2008-08-20 16:35:10 +00002160 Parse *pParse, /* Parsing context */
2161 ExprList *pEList, /* Expr list from which to derive column names */
drhd815f172012-09-13 14:42:43 +00002162 i16 *pnCol, /* Write the number of columns here */
drh7d10d5a2008-08-20 16:35:10 +00002163 Column **paCol /* Write the new column list here */
2164){
drhdc5ea5c2008-12-10 17:19:59 +00002165 sqlite3 *db = pParse->db; /* Database connection */
2166 int i, j; /* Loop counters */
drhebed3fa2015-11-14 16:47:23 +00002167 u32 cnt; /* Index added to make the name unique */
drhdc5ea5c2008-12-10 17:19:59 +00002168 Column *aCol, *pCol; /* For looping over result columns */
2169 int nCol; /* Number of columns in the result set */
drhdc5ea5c2008-12-10 17:19:59 +00002170 char *zName; /* Column name */
2171 int nName; /* Size of name in zName[] */
drh0315e3c2015-11-14 20:52:43 +00002172 Hash ht; /* Hash table of column names */
drh6d5ab2a2020-11-02 00:40:05 +00002173 Table *pTab;
drh22f70c32002-02-18 01:17:00 +00002174
drh0315e3c2015-11-14 20:52:43 +00002175 sqlite3HashInit(&ht);
dan8c2e0f02012-03-31 15:08:56 +00002176 if( pEList ){
2177 nCol = pEList->nExpr;
2178 aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
2179 testcase( aCol==0 );
drh080fe6d2021-03-18 20:04:46 +00002180 if( NEVER(nCol>32767) ) nCol = 32767;
dan8c2e0f02012-03-31 15:08:56 +00002181 }else{
2182 nCol = 0;
2183 aCol = 0;
2184 }
dan8836cbb2015-11-21 19:43:29 +00002185 assert( nCol==(i16)nCol );
dan8c2e0f02012-03-31 15:08:56 +00002186 *pnCol = nCol;
2187 *paCol = aCol;
2188
drh0315e3c2015-11-14 20:52:43 +00002189 for(i=0, pCol=aCol; i<nCol && !db->mallocFailed; i++, pCol++){
drh18f86002022-04-21 13:11:26 +00002190 struct ExprList_item *pX = &pEList->a[i];
drh45e41b72022-04-22 23:18:21 +00002191 struct ExprList_item *pCollide;
drh79d5f632005-01-18 17:20:10 +00002192 /* Get an appropriate name for the column
2193 */
drhd88fd532022-05-02 20:49:30 +00002194 if( (zName = pX->zEName)!=0 && pX->fg.eEName==ENAME_NAME ){
drh79d5f632005-01-18 17:20:10 +00002195 /* If the column contains an "AS <name>" phrase, use <name> as the name */
drh93a960a2008-07-10 00:32:42 +00002196 }else{
drh18f86002022-04-21 13:11:26 +00002197 Expr *pColExpr = sqlite3ExprSkipCollateAndLikely(pX->pExpr);
drh235667a2020-11-08 20:44:30 +00002198 while( ALWAYS(pColExpr!=0) && pColExpr->op==TK_DOT ){
drhb07028f2011-10-14 21:49:18 +00002199 pColExpr = pColExpr->pRight;
2200 assert( pColExpr!=0 );
2201 }
drh477572b2021-10-07 20:46:29 +00002202 if( pColExpr->op==TK_COLUMN
2203 && ALWAYS( ExprUseYTab(pColExpr) )
drh5af8a862022-05-27 18:06:49 +00002204 && ALWAYS( pColExpr->y.pTab!=0 )
drh477572b2021-10-07 20:46:29 +00002205 ){
drh7d10d5a2008-08-20 16:35:10 +00002206 /* For columns use the column name name */
drhdc5ea5c2008-12-10 17:19:59 +00002207 int iCol = pColExpr->iColumn;
drh5af8a862022-05-27 18:06:49 +00002208 pTab = pColExpr->y.pTab;
drhf0209f72008-08-21 14:54:28 +00002209 if( iCol<0 ) iCol = pTab->iPKey;
drhcf9d36d2021-08-02 18:03:43 +00002210 zName = iCol>=0 ? pTab->aCol[iCol].zCnName : "rowid";
drhb7916a72009-05-27 10:31:29 +00002211 }else if( pColExpr->op==TK_ID ){
drh33e619f2009-05-28 01:00:55 +00002212 assert( !ExprHasProperty(pColExpr, EP_IntValue) );
drh96ceaf82015-11-14 22:04:22 +00002213 zName = pColExpr->u.zToken;
drh7d10d5a2008-08-20 16:35:10 +00002214 }else{
2215 /* Use the original text of the column expression as its name */
drh18f86002022-04-21 13:11:26 +00002216 assert( zName==pX->zEName ); /* pointer comparison intended */
drh7d10d5a2008-08-20 16:35:10 +00002217 }
drh22f70c32002-02-18 01:17:00 +00002218 }
drh0cbec592020-01-03 02:20:37 +00002219 if( zName && !sqlite3IsTrueOrFalse(zName) ){
drhd7ca6002017-07-09 00:30:58 +00002220 zName = sqlite3DbStrDup(db, zName);
2221 }else{
drh155507b2017-07-09 18:55:29 +00002222 zName = sqlite3MPrintf(db,"column%d",i+1);
drhd7ca6002017-07-09 00:30:58 +00002223 }
drh79d5f632005-01-18 17:20:10 +00002224
2225 /* Make sure the column name is unique. If the name is not unique,
peter.d.reid60ec9142014-09-06 16:39:46 +00002226 ** append an integer to the name so that it becomes unique.
drh79d5f632005-01-18 17:20:10 +00002227 */
drh0315e3c2015-11-14 20:52:43 +00002228 cnt = 0;
drh45e41b72022-04-22 23:18:21 +00002229 while( zName && (pCollide = sqlite3HashFind(&ht, zName))!=0 ){
drhd88fd532022-05-02 20:49:30 +00002230 if( pCollide->fg.bUsingTerm ){
drhab843a52022-04-23 07:29:34 +00002231 pCol->colFlags |= COLFLAG_NOEXPAND;
drh45e41b72022-04-22 23:18:21 +00002232 }
drh0315e3c2015-11-14 20:52:43 +00002233 nName = sqlite3Strlen30(zName);
drhf7ee8962015-11-15 11:13:49 +00002234 if( nName>0 ){
2235 for(j=nName-1; j>0 && sqlite3Isdigit(zName[j]); j--){}
2236 if( zName[j]==':' ) nName = j;
2237 }
drh96ceaf82015-11-14 22:04:22 +00002238 zName = sqlite3MPrintf(db, "%.*z:%u", nName, zName, ++cnt);
drh0315e3c2015-11-14 20:52:43 +00002239 if( cnt>3 ) sqlite3_randomness(sizeof(cnt), &cnt);
drh79d5f632005-01-18 17:20:10 +00002240 }
drhcf9d36d2021-08-02 18:03:43 +00002241 pCol->zCnName = zName;
drhd44390c2020-04-06 18:16:31 +00002242 pCol->hName = sqlite3StrIHash(zName);
drhd88fd532022-05-02 20:49:30 +00002243 if( pX->fg.bNoExpand ){
drh72d620b2022-05-02 19:59:03 +00002244 pCol->colFlags |= COLFLAG_NOEXPAND;
2245 }
danba68f8f2015-11-19 16:46:46 +00002246 sqlite3ColumnPropertiesFromName(0, pCol);
drh45e41b72022-04-22 23:18:21 +00002247 if( zName && sqlite3HashInsert(&ht, zName, pX)==pX ){
drh4a642b62016-02-05 01:55:27 +00002248 sqlite3OomFault(db);
drh0315e3c2015-11-14 20:52:43 +00002249 }
drh7d10d5a2008-08-20 16:35:10 +00002250 }
drh0315e3c2015-11-14 20:52:43 +00002251 sqlite3HashClear(&ht);
drh7d10d5a2008-08-20 16:35:10 +00002252 if( db->mallocFailed ){
drh7d10d5a2008-08-20 16:35:10 +00002253 for(j=0; j<i; j++){
drhcf9d36d2021-08-02 18:03:43 +00002254 sqlite3DbFree(db, aCol[j].zCnName);
drh7d10d5a2008-08-20 16:35:10 +00002255 }
2256 sqlite3DbFree(db, aCol);
2257 *paCol = 0;
2258 *pnCol = 0;
mistachkinfad30392016-02-13 23:43:46 +00002259 return SQLITE_NOMEM_BKPT;
drh7d10d5a2008-08-20 16:35:10 +00002260 }
2261 return SQLITE_OK;
2262}
danielk1977517eb642004-06-07 10:00:31 +00002263
drh7d10d5a2008-08-20 16:35:10 +00002264/*
2265** Add type and collation information to a column list based on
2266** a SELECT statement.
2267**
2268** The column list presumably came from selectColumnNamesFromExprList().
2269** The column list has only names, not types or collations. This
2270** routine goes through and adds the types and collations.
2271**
shaneb08a67a2009-03-31 03:41:56 +00002272** This routine requires that all identifiers in the SELECT
drh7d10d5a2008-08-20 16:35:10 +00002273** statement be resolved.
2274*/
drhed06a132016-04-05 20:59:12 +00002275void sqlite3SelectAddColumnTypeAndCollation(
drh7d10d5a2008-08-20 16:35:10 +00002276 Parse *pParse, /* Parsing contexts */
drh186ad8c2013-10-08 18:40:37 +00002277 Table *pTab, /* Add column type information to this table */
drh81506b82019-08-05 19:32:06 +00002278 Select *pSelect, /* SELECT used to determine types and collations */
2279 char aff /* Default affinity for columns */
drh7d10d5a2008-08-20 16:35:10 +00002280){
2281 sqlite3 *db = pParse->db;
2282 NameContext sNC;
2283 Column *pCol;
2284 CollSeq *pColl;
2285 int i;
2286 Expr *p;
2287 struct ExprList_item *a;
2288
2289 assert( pSelect!=0 );
2290 assert( (pSelect->selFlags & SF_Resolved)!=0 );
drh186ad8c2013-10-08 18:40:37 +00002291 assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
drh7d10d5a2008-08-20 16:35:10 +00002292 if( db->mallocFailed ) return;
2293 memset(&sNC, 0, sizeof(sNC));
2294 sNC.pSrcList = pSelect->pSrc;
2295 a = pSelect->pEList->a;
drh186ad8c2013-10-08 18:40:37 +00002296 for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
drhed06a132016-04-05 20:59:12 +00002297 const char *zType;
drh913306a2021-11-26 17:10:18 +00002298 i64 n, m;
drh6f6e60d2021-02-18 15:45:34 +00002299 pTab->tabFlags |= (pCol->colFlags & COLFLAG_NOINSERT);
drh7d10d5a2008-08-20 16:35:10 +00002300 p = a[i].pExpr;
drhcafc2f72017-10-03 03:01:09 +00002301 zType = columnType(&sNC, p, 0, 0, 0);
2302 /* pCol->szEst = ... // Column size est for SELECT tables never used */
danielk1977c60e9b82005-01-31 12:42:29 +00002303 pCol->affinity = sqlite3ExprAffinity(p);
drh0c4db032017-10-03 19:53:12 +00002304 if( zType ){
2305 m = sqlite3Strlen30(zType);
drhcf9d36d2021-08-02 18:03:43 +00002306 n = sqlite3Strlen30(pCol->zCnName);
2307 pCol->zCnName = sqlite3DbReallocOrFree(db, pCol->zCnName, n+m+2);
2308 if( pCol->zCnName ){
2309 memcpy(&pCol->zCnName[n+1], zType, m+1);
drhed06a132016-04-05 20:59:12 +00002310 pCol->colFlags |= COLFLAG_HASTYPE;
drh146121f2021-11-12 14:39:49 +00002311 }else{
2312 testcase( pCol->colFlags & COLFLAG_HASTYPE );
2313 pCol->colFlags &= ~(COLFLAG_HASTYPE|COLFLAG_HASCOLL);
drhed06a132016-04-05 20:59:12 +00002314 }
2315 }
drh96fb16e2019-08-06 14:37:24 +00002316 if( pCol->affinity<=SQLITE_AFF_NONE ) pCol->affinity = aff;
danielk1977b3bf5562006-01-10 17:58:23 +00002317 pColl = sqlite3ExprCollSeq(pParse, p);
drh5ced0a92021-08-24 17:07:44 +00002318 if( pColl ){
drh65b40092021-08-05 15:27:19 +00002319 assert( pTab->pIndex==0 );
2320 sqlite3ColumnSetColl(db, pCol, pColl->zName);
danielk19770202b292004-06-09 09:55:16 +00002321 }
drh22f70c32002-02-18 01:17:00 +00002322 }
drhcafc2f72017-10-03 03:01:09 +00002323 pTab->szTabRow = 1; /* Any non-zero value works */
drh7d10d5a2008-08-20 16:35:10 +00002324}
2325
2326/*
2327** Given a SELECT statement, generate a Table structure that describes
2328** the result set of that SELECT.
2329*/
drh81506b82019-08-05 19:32:06 +00002330Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect, char aff){
drh7d10d5a2008-08-20 16:35:10 +00002331 Table *pTab;
2332 sqlite3 *db = pParse->db;
drh70d5dfb2018-12-06 16:50:55 +00002333 u64 savedFlags;
drh7d10d5a2008-08-20 16:35:10 +00002334
2335 savedFlags = db->flags;
drhd5b44d62018-12-06 17:06:02 +00002336 db->flags &= ~(u64)SQLITE_FullColNames;
drh7d10d5a2008-08-20 16:35:10 +00002337 db->flags |= SQLITE_ShortColNames;
2338 sqlite3SelectPrep(pParse, pSelect, 0);
drh491b6d82019-01-24 15:51:03 +00002339 db->flags = savedFlags;
drh7d10d5a2008-08-20 16:35:10 +00002340 if( pParse->nErr ) return 0;
2341 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh7d10d5a2008-08-20 16:35:10 +00002342 pTab = sqlite3DbMallocZero(db, sizeof(Table) );
2343 if( pTab==0 ){
2344 return 0;
2345 }
drh79df7782016-12-14 14:07:35 +00002346 pTab->nTabRef = 1;
drh7d10d5a2008-08-20 16:35:10 +00002347 pTab->zName = 0;
dancfc9df72014-04-25 15:01:01 +00002348 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drh8981b902015-08-24 17:42:49 +00002349 sqlite3ColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
drh81506b82019-08-05 19:32:06 +00002350 sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSelect, aff);
drh22f70c32002-02-18 01:17:00 +00002351 pTab->iPKey = -1;
drh7ce72f62008-07-24 15:50:41 +00002352 if( db->mallocFailed ){
dan1feeaed2010-07-23 15:41:47 +00002353 sqlite3DeleteTable(db, pTab);
drh7ce72f62008-07-24 15:50:41 +00002354 return 0;
2355 }
drh22f70c32002-02-18 01:17:00 +00002356 return pTab;
2357}
2358
2359/*
drhd8bc7082000-06-07 23:51:50 +00002360** Get a VDBE for the given parser context. Create a new one if necessary.
2361** If an error occurs, return NULL and leave a message in pParse.
2362*/
drh55965612017-09-16 20:58:41 +00002363Vdbe *sqlite3GetVdbe(Parse *pParse){
2364 if( pParse->pVdbe ){
2365 return pParse->pVdbe;
2366 }
drh6f077342016-04-12 00:26:59 +00002367 if( pParse->pToplevel==0
2368 && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
2369 ){
2370 pParse->okConstFactor = 1;
drhd8bc7082000-06-07 23:51:50 +00002371 }
drh55965612017-09-16 20:58:41 +00002372 return sqlite3VdbeCreate(pParse);
drh6f077342016-04-12 00:26:59 +00002373}
drhfcb78a42003-01-18 20:11:05 +00002374
drh15007a92006-01-08 18:10:17 +00002375
drhd8bc7082000-06-07 23:51:50 +00002376/*
drh7b58dae2003-07-20 01:16:46 +00002377** Compute the iLimit and iOffset fields of the SELECT based on the
drh8c0833f2017-11-14 23:48:23 +00002378** pLimit expressions. pLimit->pLeft and pLimit->pRight hold the expressions
drh7b58dae2003-07-20 01:16:46 +00002379** that appear in the original SQL statement after the LIMIT and OFFSET
danielk1977a2dc3b12005-02-05 12:48:48 +00002380** keywords. Or NULL if those keywords are omitted. iLimit and iOffset
2381** are the integer memory register numbers for counters used to compute
2382** the limit and offset. If there is no limit and/or offset, then
2383** iLimit and iOffset are negative.
drh7b58dae2003-07-20 01:16:46 +00002384**
drhd59ba6c2006-01-08 05:02:54 +00002385** This routine changes the values of iLimit and iOffset only if
drh8c0833f2017-11-14 23:48:23 +00002386** a limit or offset is defined by pLimit->pLeft and pLimit->pRight. iLimit
2387** and iOffset should have been preset to appropriate default values (zero)
drhaa9ce702014-01-22 18:07:04 +00002388** prior to calling this routine.
2389**
2390** The iOffset register (if it exists) is initialized to the value
2391** of the OFFSET. The iLimit register is initialized to LIMIT. Register
2392** iOffset+1 is initialized to LIMIT+OFFSET.
2393**
drh8c0833f2017-11-14 23:48:23 +00002394** Only if pLimit->pLeft!=0 do the limit registers get
drh7b58dae2003-07-20 01:16:46 +00002395** redefined. The UNION ALL operator uses this property to force
2396** the reuse of the same limit and offset registers across multiple
2397** SELECT statements.
2398*/
drhec7429a2005-10-06 16:53:14 +00002399static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
drh02afc862006-01-20 18:10:57 +00002400 Vdbe *v = 0;
2401 int iLimit = 0;
drh15007a92006-01-08 18:10:17 +00002402 int iOffset;
drh8b0cf382015-10-06 21:07:06 +00002403 int n;
drh8c0833f2017-11-14 23:48:23 +00002404 Expr *pLimit = p->pLimit;
2405
drh0acb7e42008-06-25 00:12:41 +00002406 if( p->iLimit ) return;
drh15007a92006-01-08 18:10:17 +00002407
drh7b58dae2003-07-20 01:16:46 +00002408 /*
drh7b58dae2003-07-20 01:16:46 +00002409 ** "LIMIT -1" always shows all rows. There is some
drhf7b54962013-05-28 12:11:54 +00002410 ** controversy about what the correct behavior should be.
drh7b58dae2003-07-20 01:16:46 +00002411 ** The current implementation interprets "LIMIT 0" to mean
2412 ** no rows.
2413 */
drh8c0833f2017-11-14 23:48:23 +00002414 if( pLimit ){
2415 assert( pLimit->op==TK_LIMIT );
2416 assert( pLimit->pLeft!=0 );
drh0a07c102008-01-03 18:03:08 +00002417 p->iLimit = iLimit = ++pParse->nMem;
drh15007a92006-01-08 18:10:17 +00002418 v = sqlite3GetVdbe(pParse);
drhaa9ce702014-01-22 18:07:04 +00002419 assert( v!=0 );
drh8c0833f2017-11-14 23:48:23 +00002420 if( sqlite3ExprIsInteger(pLimit->pLeft, &n) ){
drh456e4e42009-11-20 16:13:15 +00002421 sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
2422 VdbeComment((v, "LIMIT counter"));
drh9b918ed2009-11-12 03:13:26 +00002423 if( n==0 ){
drh076e85f2015-09-03 13:46:12 +00002424 sqlite3VdbeGoto(v, iBreak);
drhc3489bb2016-02-25 16:04:59 +00002425 }else if( n>=0 && p->nSelectRow>sqlite3LogEst((u64)n) ){
2426 p->nSelectRow = sqlite3LogEst((u64)n);
2427 p->selFlags |= SF_FixedLimit;
drh9b918ed2009-11-12 03:13:26 +00002428 }
2429 }else{
drh8c0833f2017-11-14 23:48:23 +00002430 sqlite3ExprCode(pParse, pLimit->pLeft, iLimit);
drh688852a2014-02-17 22:40:43 +00002431 sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
drh9b918ed2009-11-12 03:13:26 +00002432 VdbeComment((v, "LIMIT counter"));
drh16897072015-03-07 00:57:37 +00002433 sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, iBreak); VdbeCoverage(v);
drh9b918ed2009-11-12 03:13:26 +00002434 }
drh8c0833f2017-11-14 23:48:23 +00002435 if( pLimit->pRight ){
drh373cc2d2009-05-17 02:06:14 +00002436 p->iOffset = iOffset = ++pParse->nMem;
drhb7654112008-01-12 12:48:07 +00002437 pParse->nMem++; /* Allocate an extra register for limit+offset */
drh8c0833f2017-11-14 23:48:23 +00002438 sqlite3ExprCode(pParse, pLimit->pRight, iOffset);
drh688852a2014-02-17 22:40:43 +00002439 sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
drh373cc2d2009-05-17 02:06:14 +00002440 VdbeComment((v, "OFFSET counter"));
drhcc2fa4c2016-01-25 15:57:29 +00002441 sqlite3VdbeAddOp3(v, OP_OffsetLimit, iLimit, iOffset+1, iOffset);
drhb7654112008-01-12 12:48:07 +00002442 VdbeComment((v, "LIMIT+OFFSET"));
drhd59ba6c2006-01-08 05:02:54 +00002443 }
drh7b58dae2003-07-20 01:16:46 +00002444 }
2445}
2446
drhb7f91642004-10-31 02:22:47 +00002447#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhfbc4ee72004-08-29 01:31:05 +00002448/*
drhfbc4ee72004-08-29 01:31:05 +00002449** Return the appropriate collating sequence for the iCol-th column of
2450** the result set for the compound-select statement "p". Return NULL if
2451** the column has no default collating sequence.
2452**
2453** The collating sequence for the compound select is taken from the
2454** left-most term of the select that has a collating sequence.
2455*/
danielk1977dc1bdc42004-06-11 10:51:27 +00002456static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
drhfbc4ee72004-08-29 01:31:05 +00002457 CollSeq *pRet;
danielk1977dc1bdc42004-06-11 10:51:27 +00002458 if( p->pPrior ){
2459 pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
drhfbc4ee72004-08-29 01:31:05 +00002460 }else{
2461 pRet = 0;
danielk1977dc1bdc42004-06-11 10:51:27 +00002462 }
drh10c081a2009-04-16 00:24:23 +00002463 assert( iCol>=0 );
drh2ec18a32015-06-23 23:31:52 +00002464 /* iCol must be less than p->pEList->nExpr. Otherwise an error would
2465 ** have been thrown during name resolution and we would not have gotten
2466 ** this far */
2467 if( pRet==0 && ALWAYS(iCol<p->pEList->nExpr) ){
danielk1977dc1bdc42004-06-11 10:51:27 +00002468 pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
2469 }
2470 return pRet;
drhd3d39e92004-05-20 22:16:29 +00002471}
2472
dan53bed452014-01-24 20:37:18 +00002473/*
2474** The select statement passed as the second parameter is a compound SELECT
2475** with an ORDER BY clause. This function allocates and returns a KeyInfo
2476** structure suitable for implementing the ORDER BY.
2477**
2478** Space to hold the KeyInfo structure is obtained from malloc. The calling
2479** function is responsible for ensuring that this structure is eventually
2480** freed.
2481*/
2482static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
2483 ExprList *pOrderBy = p->pOrderBy;
drh7d4c94b2021-10-04 22:34:38 +00002484 int nOrderBy = ALWAYS(pOrderBy!=0) ? pOrderBy->nExpr : 0;
dan53bed452014-01-24 20:37:18 +00002485 sqlite3 *db = pParse->db;
2486 KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
2487 if( pRet ){
2488 int i;
2489 for(i=0; i<nOrderBy; i++){
2490 struct ExprList_item *pItem = &pOrderBy->a[i];
2491 Expr *pTerm = pItem->pExpr;
2492 CollSeq *pColl;
2493
2494 if( pTerm->flags & EP_Collate ){
2495 pColl = sqlite3ExprCollSeq(pParse, pTerm);
2496 }else{
2497 pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
2498 if( pColl==0 ) pColl = db->pDfltColl;
2499 pOrderBy->a[i].pExpr =
2500 sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
2501 }
2502 assert( sqlite3KeyInfoIsWriteable(pRet) );
2503 pRet->aColl[i] = pColl;
drhd88fd532022-05-02 20:49:30 +00002504 pRet->aSortFlags[i] = pOrderBy->a[i].fg.sortFlags;
dan53bed452014-01-24 20:37:18 +00002505 }
2506 }
2507
2508 return pRet;
2509}
drhd3d39e92004-05-20 22:16:29 +00002510
drh781def22014-01-22 13:35:53 +00002511#ifndef SQLITE_OMIT_CTE
2512/*
2513** This routine generates VDBE code to compute the content of a WITH RECURSIVE
2514** query of the form:
2515**
2516** <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
2517** \___________/ \_______________/
2518** p->pPrior p
2519**
2520**
2521** There is exactly one reference to the recursive-table in the FROM clause
drh8a48b9c2015-08-19 15:20:00 +00002522** of recursive-query, marked with the SrcList->a[].fg.isRecursive flag.
drh781def22014-01-22 13:35:53 +00002523**
2524** The setup-query runs once to generate an initial set of rows that go
2525** into a Queue table. Rows are extracted from the Queue table one by
drhfe1c6bb2014-01-22 17:28:35 +00002526** one. Each row extracted from Queue is output to pDest. Then the single
2527** extracted row (now in the iCurrent table) becomes the content of the
2528** recursive-table for a recursive-query run. The output of the recursive-query
drh781def22014-01-22 13:35:53 +00002529** is added back into the Queue table. Then another row is extracted from Queue
2530** and the iteration continues until the Queue table is empty.
2531**
2532** If the compound query operator is UNION then no duplicate rows are ever
2533** inserted into the Queue table. The iDistinct table keeps a copy of all rows
2534** that have ever been inserted into Queue and causes duplicates to be
2535** discarded. If the operator is UNION ALL, then duplicates are allowed.
2536**
2537** If the query has an ORDER BY, then entries in the Queue table are kept in
2538** ORDER BY order and the first entry is extracted for each cycle. Without
2539** an ORDER BY, the Queue table is just a FIFO.
2540**
2541** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
2542** have been output to pDest. A LIMIT of zero means to output no rows and a
2543** negative LIMIT means to output all rows. If there is also an OFFSET clause
2544** with a positive value, then the first OFFSET outputs are discarded rather
2545** than being sent to pDest. The LIMIT count does not begin until after OFFSET
2546** rows have been skipped.
2547*/
2548static void generateWithRecursiveQuery(
2549 Parse *pParse, /* Parsing context */
2550 Select *p, /* The recursive SELECT to be coded */
2551 SelectDest *pDest /* What to do with query results */
2552){
2553 SrcList *pSrc = p->pSrc; /* The FROM clause of the recursive query */
2554 int nCol = p->pEList->nExpr; /* Number of columns in the recursive table */
2555 Vdbe *v = pParse->pVdbe; /* The prepared statement under construction */
drhe85e1da2021-10-01 21:01:07 +00002556 Select *pSetup; /* The setup query */
drh34055852020-10-19 01:23:48 +00002557 Select *pFirstRec; /* Left-most recursive term */
drh781def22014-01-22 13:35:53 +00002558 int addrTop; /* Top of the loop */
2559 int addrCont, addrBreak; /* CONTINUE and BREAK addresses */
drhedf83d12014-01-22 18:31:27 +00002560 int iCurrent = 0; /* The Current table */
drh781def22014-01-22 13:35:53 +00002561 int regCurrent; /* Register holding Current table */
2562 int iQueue; /* The Queue table */
2563 int iDistinct = 0; /* To ensure unique results if UNION */
drh8e1ee882014-03-21 19:56:09 +00002564 int eDest = SRT_Fifo; /* How to write to Queue */
drh781def22014-01-22 13:35:53 +00002565 SelectDest destQueue; /* SelectDest targetting the Queue table */
2566 int i; /* Loop counter */
2567 int rc; /* Result code */
drhfe1c6bb2014-01-22 17:28:35 +00002568 ExprList *pOrderBy; /* The ORDER BY clause */
drh8c0833f2017-11-14 23:48:23 +00002569 Expr *pLimit; /* Saved LIMIT and OFFSET */
drhaa9ce702014-01-22 18:07:04 +00002570 int regLimit, regOffset; /* Registers used by LIMIT and OFFSET */
drh781def22014-01-22 13:35:53 +00002571
dan6afa35c2018-09-27 12:14:15 +00002572#ifndef SQLITE_OMIT_WINDOWFUNC
2573 if( p->pWin ){
2574 sqlite3ErrorMsg(pParse, "cannot use window functions in recursive queries");
2575 return;
2576 }
2577#endif
2578
drh781def22014-01-22 13:35:53 +00002579 /* Obtain authorization to do a recursive query */
2580 if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
drh781def22014-01-22 13:35:53 +00002581
drhaa9ce702014-01-22 18:07:04 +00002582 /* Process the LIMIT and OFFSET clauses, if they exist */
drhec4ccdb2018-12-29 02:26:59 +00002583 addrBreak = sqlite3VdbeMakeLabel(pParse);
dan69b93832016-12-16 15:05:40 +00002584 p->nSelectRow = 320; /* 4 billion rows */
drhaa9ce702014-01-22 18:07:04 +00002585 computeLimitRegisters(pParse, p, addrBreak);
2586 pLimit = p->pLimit;
drhaa9ce702014-01-22 18:07:04 +00002587 regLimit = p->iLimit;
2588 regOffset = p->iOffset;
drh8c0833f2017-11-14 23:48:23 +00002589 p->pLimit = 0;
drhaa9ce702014-01-22 18:07:04 +00002590 p->iLimit = p->iOffset = 0;
dan53bed452014-01-24 20:37:18 +00002591 pOrderBy = p->pOrderBy;
drh781def22014-01-22 13:35:53 +00002592
2593 /* Locate the cursor number of the Current table */
2594 for(i=0; ALWAYS(i<pSrc->nSrc); i++){
drh8a48b9c2015-08-19 15:20:00 +00002595 if( pSrc->a[i].fg.isRecursive ){
drh781def22014-01-22 13:35:53 +00002596 iCurrent = pSrc->a[i].iCursor;
2597 break;
2598 }
2599 }
2600
drhfe1c6bb2014-01-22 17:28:35 +00002601 /* Allocate cursors numbers for Queue and Distinct. The cursor number for
drh781def22014-01-22 13:35:53 +00002602 ** the Distinct table must be exactly one greater than Queue in order
drh8e1ee882014-03-21 19:56:09 +00002603 ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
drh781def22014-01-22 13:35:53 +00002604 iQueue = pParse->nTab++;
2605 if( p->op==TK_UNION ){
drh8e1ee882014-03-21 19:56:09 +00002606 eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
drh781def22014-01-22 13:35:53 +00002607 iDistinct = pParse->nTab++;
drhfe1c6bb2014-01-22 17:28:35 +00002608 }else{
drh8e1ee882014-03-21 19:56:09 +00002609 eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
drh781def22014-01-22 13:35:53 +00002610 }
2611 sqlite3SelectDestInit(&destQueue, eDest, iQueue);
2612
2613 /* Allocate cursors for Current, Queue, and Distinct. */
2614 regCurrent = ++pParse->nMem;
2615 sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
drhfe1c6bb2014-01-22 17:28:35 +00002616 if( pOrderBy ){
dan53bed452014-01-24 20:37:18 +00002617 KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
drhfe1c6bb2014-01-22 17:28:35 +00002618 sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
2619 (char*)pKeyInfo, P4_KEYINFO);
2620 destQueue.pOrderBy = pOrderBy;
2621 }else{
2622 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
2623 }
2624 VdbeComment((v, "Queue table"));
drh781def22014-01-22 13:35:53 +00002625 if( iDistinct ){
2626 p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
2627 p->selFlags |= SF_UsesEphemeral;
2628 }
2629
dan53bed452014-01-24 20:37:18 +00002630 /* Detach the ORDER BY clause from the compound SELECT */
2631 p->pOrderBy = 0;
2632
drh34055852020-10-19 01:23:48 +00002633 /* Figure out how many elements of the compound SELECT are part of the
2634 ** recursive query. Make sure no recursive elements use aggregate
2635 ** functions. Mark the recursive elements as UNION ALL even if they
2636 ** are really UNION because the distinctness will be enforced by the
2637 ** iDistinct table. pFirstRec is left pointing to the left-most
2638 ** recursive term of the CTE.
2639 */
drh34055852020-10-19 01:23:48 +00002640 for(pFirstRec=p; ALWAYS(pFirstRec!=0); pFirstRec=pFirstRec->pPrior){
2641 if( pFirstRec->selFlags & SF_Aggregate ){
2642 sqlite3ErrorMsg(pParse, "recursive aggregate queries not supported");
2643 goto end_of_recursive_query;
2644 }
2645 pFirstRec->op = TK_ALL;
2646 if( (pFirstRec->pPrior->selFlags & SF_Recursive)==0 ) break;
2647 }
2648
drh781def22014-01-22 13:35:53 +00002649 /* Store the results of the setup-query in Queue. */
drh34055852020-10-19 01:23:48 +00002650 pSetup = pFirstRec->pPrior;
drhd227a292014-02-09 18:02:09 +00002651 pSetup->pNext = 0;
drh84a01de2018-05-02 16:13:48 +00002652 ExplainQueryPlan((pParse, 1, "SETUP"));
drh781def22014-01-22 13:35:53 +00002653 rc = sqlite3Select(pParse, pSetup, &destQueue);
drhd227a292014-02-09 18:02:09 +00002654 pSetup->pNext = p;
drhfe1c6bb2014-01-22 17:28:35 +00002655 if( rc ) goto end_of_recursive_query;
drh781def22014-01-22 13:35:53 +00002656
2657 /* Find the next row in the Queue and output that row */
drh688852a2014-02-17 22:40:43 +00002658 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
drh781def22014-01-22 13:35:53 +00002659
2660 /* Transfer the next row in Queue over to Current */
2661 sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
drhfe1c6bb2014-01-22 17:28:35 +00002662 if( pOrderBy ){
2663 sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
2664 }else{
2665 sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
2666 }
drh781def22014-01-22 13:35:53 +00002667 sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
2668
drhfe1c6bb2014-01-22 17:28:35 +00002669 /* Output the single row in Current */
drhec4ccdb2018-12-29 02:26:59 +00002670 addrCont = sqlite3VdbeMakeLabel(pParse);
drhaa9ce702014-01-22 18:07:04 +00002671 codeOffset(v, regOffset, addrCont);
drh2def2f72017-09-15 17:40:34 +00002672 selectInnerLoop(pParse, p, iCurrent,
drh079a3072014-03-19 14:10:55 +00002673 0, 0, pDest, addrCont, addrBreak);
drh688852a2014-02-17 22:40:43 +00002674 if( regLimit ){
drh16897072015-03-07 00:57:37 +00002675 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, regLimit, addrBreak);
drh688852a2014-02-17 22:40:43 +00002676 VdbeCoverage(v);
2677 }
drhfe1c6bb2014-01-22 17:28:35 +00002678 sqlite3VdbeResolveLabel(v, addrCont);
2679
drh781def22014-01-22 13:35:53 +00002680 /* Execute the recursive SELECT taking the single row in Current as
2681 ** the value for the recursive-table. Store the results in the Queue.
2682 */
drh34055852020-10-19 01:23:48 +00002683 pFirstRec->pPrior = 0;
2684 ExplainQueryPlan((pParse, 1, "RECURSIVE STEP"));
2685 sqlite3Select(pParse, p, &destQueue);
2686 assert( pFirstRec->pPrior==0 );
2687 pFirstRec->pPrior = pSetup;
drh781def22014-01-22 13:35:53 +00002688
2689 /* Keep running the loop until the Queue is empty */
drh076e85f2015-09-03 13:46:12 +00002690 sqlite3VdbeGoto(v, addrTop);
drh781def22014-01-22 13:35:53 +00002691 sqlite3VdbeResolveLabel(v, addrBreak);
drhfe1c6bb2014-01-22 17:28:35 +00002692
2693end_of_recursive_query:
dan9afccba2014-03-21 19:27:54 +00002694 sqlite3ExprListDelete(pParse->db, p->pOrderBy);
drhfe1c6bb2014-01-22 17:28:35 +00002695 p->pOrderBy = pOrderBy;
drhaa9ce702014-01-22 18:07:04 +00002696 p->pLimit = pLimit;
drhfe1c6bb2014-01-22 17:28:35 +00002697 return;
drh781def22014-01-22 13:35:53 +00002698}
danb68b9772014-01-25 12:16:53 +00002699#endif /* SQLITE_OMIT_CTE */
drh781def22014-01-22 13:35:53 +00002700
2701/* Forward references */
drhb21e7c72008-06-22 12:37:57 +00002702static int multiSelectOrderBy(
2703 Parse *pParse, /* Parsing context */
2704 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00002705 SelectDest *pDest /* What to do with query results */
drhb21e7c72008-06-22 12:37:57 +00002706);
2707
drh45f54a52015-01-05 19:16:42 +00002708/*
drh45f54a52015-01-05 19:16:42 +00002709** Handle the special case of a compound-select that originates from a
2710** VALUES clause. By handling this as a special case, we avoid deep
2711** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
2712** on a VALUES clause.
2713**
2714** Because the Select object originates from a VALUES clause:
drhb058d052018-01-14 20:12:23 +00002715** (1) There is no LIMIT or OFFSET or else there is a LIMIT of exactly 1
drh45f54a52015-01-05 19:16:42 +00002716** (2) All terms are UNION ALL
2717** (3) There is no ORDER BY clause
drhb058d052018-01-14 20:12:23 +00002718**
2719** The "LIMIT of exactly 1" case of condition (1) comes about when a VALUES
2720** clause occurs within scalar expression (ex: "SELECT (VALUES(1),(2),(3))").
2721** The sqlite3CodeSubselect will have added the LIMIT 1 clause in tht case.
drhd1f0a862022-02-25 11:30:29 +00002722** Since the limit is exactly 1, we only need to evaluate the left-most VALUES.
drh45f54a52015-01-05 19:16:42 +00002723*/
2724static int multiSelectValues(
2725 Parse *pParse, /* Parsing context */
2726 Select *p, /* The right-most of SELECTs to be coded */
2727 SelectDest *pDest /* What to do with query results */
2728){
drh45f54a52015-01-05 19:16:42 +00002729 int nRow = 1;
2730 int rc = 0;
drhfa16f5d2018-05-03 01:37:13 +00002731 int bShowAll = p->pLimit==0;
drh772460f2015-04-16 14:13:12 +00002732 assert( p->selFlags & SF_MultiValue );
drh45f54a52015-01-05 19:16:42 +00002733 do{
2734 assert( p->selFlags & SF_Values );
2735 assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
dan923cadb2015-06-23 12:19:55 +00002736 assert( p->pNext==0 || p->pEList->nExpr==p->pNext->pEList->nExpr );
drhef9f7192020-01-17 19:14:08 +00002737#ifndef SQLITE_OMIT_WINDOWFUNC
drh29cdbad2019-12-07 13:42:47 +00002738 if( p->pWin ) return -1;
drhef9f7192020-01-17 19:14:08 +00002739#endif
drh45f54a52015-01-05 19:16:42 +00002740 if( p->pPrior==0 ) break;
2741 assert( p->pPrior->pNext==p );
2742 p = p->pPrior;
drhfa16f5d2018-05-03 01:37:13 +00002743 nRow += bShowAll;
drh45f54a52015-01-05 19:16:42 +00002744 }while(1);
drhfa16f5d2018-05-03 01:37:13 +00002745 ExplainQueryPlan((pParse, 0, "SCAN %d CONSTANT ROW%s", nRow,
2746 nRow==1 ? "" : "S"));
drh45f54a52015-01-05 19:16:42 +00002747 while( p ){
drhfa16f5d2018-05-03 01:37:13 +00002748 selectInnerLoop(pParse, p, -1, 0, 0, pDest, 1, 1);
2749 if( !bShowAll ) break;
drh45f54a52015-01-05 19:16:42 +00002750 p->nSelectRow = nRow;
2751 p = p->pNext;
2752 }
2753 return rc;
2754}
drhb21e7c72008-06-22 12:37:57 +00002755
drhd3d39e92004-05-20 22:16:29 +00002756/*
drh34055852020-10-19 01:23:48 +00002757** Return true if the SELECT statement which is known to be the recursive
2758** part of a recursive CTE still has its anchor terms attached. If the
2759** anchor terms have already been removed, then return false.
2760*/
2761static int hasAnchor(Select *p){
2762 while( p && (p->selFlags & SF_Recursive)!=0 ){ p = p->pPrior; }
2763 return p!=0;
2764}
2765
2766/*
drh16ee60f2008-06-20 18:13:25 +00002767** This routine is called to process a compound query form from
2768** two or more separate queries using UNION, UNION ALL, EXCEPT, or
2769** INTERSECT
drhc926afb2002-06-20 03:38:26 +00002770**
drhe78e8282003-01-19 03:59:45 +00002771** "p" points to the right-most of the two queries. the query on the
2772** left is p->pPrior. The left query could also be a compound query
2773** in which case this routine will be called recursively.
2774**
2775** The results of the total query are to be written into a destination
2776** of type eDest with parameter iParm.
2777**
2778** Example 1: Consider a three-way compound SQL statement.
2779**
2780** SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
2781**
2782** This statement is parsed up as follows:
2783**
2784** SELECT c FROM t3
2785** |
2786** `-----> SELECT b FROM t2
2787** |
jplyon4b11c6d2004-01-19 04:57:53 +00002788** `------> SELECT a FROM t1
drhe78e8282003-01-19 03:59:45 +00002789**
2790** The arrows in the diagram above represent the Select.pPrior pointer.
2791** So if this routine is called with p equal to the t3 query, then
2792** pPrior will be the t2 query. p->op will be TK_UNION in this case.
2793**
2794** Notice that because of the way SQLite parses compound SELECTs, the
2795** individual selects always group from left to right.
drh82c3d632000-06-06 21:56:07 +00002796*/
danielk197784ac9d02004-05-18 09:58:06 +00002797static int multiSelect(
drhfbc4ee72004-08-29 01:31:05 +00002798 Parse *pParse, /* Parsing context */
2799 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00002800 SelectDest *pDest /* What to do with query results */
danielk197784ac9d02004-05-18 09:58:06 +00002801){
drhfbc4ee72004-08-29 01:31:05 +00002802 int rc = SQLITE_OK; /* Success code from a subroutine */
2803 Select *pPrior; /* Another SELECT immediately to our left */
2804 Vdbe *v; /* Generate code to this VDBE */
drh1013c932008-01-06 00:25:21 +00002805 SelectDest dest; /* Alternative data destination */
danielk1977eca7e012008-07-01 16:05:25 +00002806 Select *pDelete = 0; /* Chain of simple selects to delete */
drh633e6d52008-07-28 19:34:53 +00002807 sqlite3 *db; /* Database connection */
drh82c3d632000-06-06 21:56:07 +00002808
drh7b58dae2003-07-20 01:16:46 +00002809 /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs. Only
drhfbc4ee72004-08-29 01:31:05 +00002810 ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
drh82c3d632000-06-06 21:56:07 +00002811 */
drh701bb3b2008-08-02 03:50:39 +00002812 assert( p && p->pPrior ); /* Calling function guarantees this much */
daneae73fb2014-01-16 18:34:33 +00002813 assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
drhb0968b62019-05-29 18:33:59 +00002814 assert( p->selFlags & SF_Compound );
drh633e6d52008-07-28 19:34:53 +00002815 db = pParse->db;
drhd8bc7082000-06-07 23:51:50 +00002816 pPrior = p->pPrior;
drhbc103772008-08-08 18:06:25 +00002817 dest = *pDest;
drhaae0f742021-03-04 16:03:32 +00002818 assert( pPrior->pOrderBy==0 );
2819 assert( pPrior->pLimit==0 );
drh82c3d632000-06-06 21:56:07 +00002820
danielk19774adee202004-05-08 08:23:19 +00002821 v = sqlite3GetVdbe(pParse);
drh701bb3b2008-08-02 03:50:39 +00002822 assert( v!=0 ); /* The VDBE already created by calling function */
drhd8bc7082000-06-07 23:51:50 +00002823
drh1cc3d752002-03-23 00:31:29 +00002824 /* Create the destination temporary table if necessary
2825 */
danielk19776c8c8ce2008-01-02 16:27:09 +00002826 if( dest.eDest==SRT_EphemTab ){
danielk1977b4964b72004-05-18 01:23:38 +00002827 assert( p->pEList );
drh2b596da2012-07-23 21:43:19 +00002828 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
danielk19776c8c8ce2008-01-02 16:27:09 +00002829 dest.eDest = SRT_Table;
drh1cc3d752002-03-23 00:31:29 +00002830 }
2831
drh45f54a52015-01-05 19:16:42 +00002832 /* Special handling for a compound-select that originates as a VALUES clause.
2833 */
drh772460f2015-04-16 14:13:12 +00002834 if( p->selFlags & SF_MultiValue ){
drh45f54a52015-01-05 19:16:42 +00002835 rc = multiSelectValues(pParse, p, &dest);
drh29cdbad2019-12-07 13:42:47 +00002836 if( rc>=0 ) goto multi_select_end;
2837 rc = SQLITE_OK;
drh45f54a52015-01-05 19:16:42 +00002838 }
2839
drhf6e369a2008-06-24 12:46:30 +00002840 /* Make sure all SELECTs in the statement have the same number of elements
2841 ** in their result sets.
2842 */
2843 assert( p->pEList && pPrior->pEList );
dan923cadb2015-06-23 12:19:55 +00002844 assert( p->pEList->nExpr==pPrior->pEList->nExpr );
drhf6e369a2008-06-24 12:46:30 +00002845
daneede6a52014-01-15 19:42:23 +00002846#ifndef SQLITE_OMIT_CTE
drh34055852020-10-19 01:23:48 +00002847 if( (p->selFlags & SF_Recursive)!=0 && hasAnchor(p) ){
drh781def22014-01-22 13:35:53 +00002848 generateWithRecursiveQuery(pParse, p, &dest);
dan8ce71842014-01-14 20:14:09 +00002849 }else
2850#endif
drhf6e369a2008-06-24 12:46:30 +00002851
drha9671a22008-07-08 23:40:20 +00002852 /* Compound SELECTs that have an ORDER BY clause are handled separately.
2853 */
drhf6e369a2008-06-24 12:46:30 +00002854 if( p->pOrderBy ){
drha9671a22008-07-08 23:40:20 +00002855 return multiSelectOrderBy(pParse, p, pDest);
drh03c39052018-05-02 14:24:34 +00002856 }else{
drhf6e369a2008-06-24 12:46:30 +00002857
drhc631ded2018-05-02 02:22:22 +00002858#ifndef SQLITE_OMIT_EXPLAIN
drh03c39052018-05-02 14:24:34 +00002859 if( pPrior->pPrior==0 ){
drh4d799832018-05-03 19:47:14 +00002860 ExplainQueryPlan((pParse, 1, "COMPOUND QUERY"));
drh03c39052018-05-02 14:24:34 +00002861 ExplainQueryPlan((pParse, 1, "LEFT-MOST SUBQUERY"));
drh03c39052018-05-02 14:24:34 +00002862 }
drhc631ded2018-05-02 02:22:22 +00002863#endif
2864
drh03c39052018-05-02 14:24:34 +00002865 /* Generate code for the left and right SELECT statements.
2866 */
2867 switch( p->op ){
2868 case TK_ALL: {
2869 int addr = 0;
drh252d5822021-04-07 13:20:34 +00002870 int nLimit = 0; /* Initialize to suppress harmless compiler warning */
drh03c39052018-05-02 14:24:34 +00002871 assert( !pPrior->pLimit );
2872 pPrior->iLimit = p->iLimit;
2873 pPrior->iOffset = p->iOffset;
2874 pPrior->pLimit = p->pLimit;
drh93ffb502021-05-18 19:10:10 +00002875 SELECTTRACE(1, pParse, p, ("multiSelect UNION ALL left...\n"));
drh03c39052018-05-02 14:24:34 +00002876 rc = sqlite3Select(pParse, pPrior, &dest);
drhbc7819d2021-03-05 14:08:45 +00002877 pPrior->pLimit = 0;
drh03c39052018-05-02 14:24:34 +00002878 if( rc ){
2879 goto multi_select_end;
drh9f1ef452015-10-06 17:27:18 +00002880 }
drh03c39052018-05-02 14:24:34 +00002881 p->pPrior = 0;
2882 p->iLimit = pPrior->iLimit;
2883 p->iOffset = pPrior->iOffset;
2884 if( p->iLimit ){
2885 addr = sqlite3VdbeAddOp1(v, OP_IfNot, p->iLimit); VdbeCoverage(v);
2886 VdbeComment((v, "Jump ahead if LIMIT reached"));
2887 if( p->iOffset ){
2888 sqlite3VdbeAddOp3(v, OP_OffsetLimit,
2889 p->iLimit, p->iOffset+1, p->iOffset);
2890 }
2891 }
2892 ExplainQueryPlan((pParse, 1, "UNION ALL"));
drh93ffb502021-05-18 19:10:10 +00002893 SELECTTRACE(1, pParse, p, ("multiSelect UNION ALL right...\n"));
drh03c39052018-05-02 14:24:34 +00002894 rc = sqlite3Select(pParse, p, &dest);
2895 testcase( rc!=SQLITE_OK );
2896 pDelete = p->pPrior;
2897 p->pPrior = pPrior;
2898 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
drhbc7819d2021-03-05 14:08:45 +00002899 if( p->pLimit
2900 && sqlite3ExprIsInteger(p->pLimit->pLeft, &nLimit)
drh03c39052018-05-02 14:24:34 +00002901 && nLimit>0 && p->nSelectRow > sqlite3LogEst((u64)nLimit)
2902 ){
2903 p->nSelectRow = sqlite3LogEst((u64)nLimit);
2904 }
2905 if( addr ){
2906 sqlite3VdbeJumpHere(v, addr);
2907 }
2908 break;
drha9671a22008-07-08 23:40:20 +00002909 }
drh03c39052018-05-02 14:24:34 +00002910 case TK_EXCEPT:
2911 case TK_UNION: {
2912 int unionTab; /* Cursor number of the temp table holding result */
2913 u8 op = 0; /* One of the SRT_ operations to apply to self */
2914 int priorOp; /* The SRT_ operation to apply to prior selects */
2915 Expr *pLimit; /* Saved values of p->nLimit */
2916 int addr;
2917 SelectDest uniondest;
2918
2919 testcase( p->op==TK_EXCEPT );
2920 testcase( p->op==TK_UNION );
2921 priorOp = SRT_Union;
2922 if( dest.eDest==priorOp ){
2923 /* We can reuse a temporary table generated by a SELECT to our
2924 ** right.
2925 */
2926 assert( p->pLimit==0 ); /* Not allowed on leftward elements */
2927 unionTab = dest.iSDParm;
2928 }else{
2929 /* We will need to create our own temporary table to hold the
2930 ** intermediate results.
2931 */
2932 unionTab = pParse->nTab++;
2933 assert( p->pOrderBy==0 );
2934 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
2935 assert( p->addrOpenEphm[0] == -1 );
2936 p->addrOpenEphm[0] = addr;
2937 findRightmost(p)->selFlags |= SF_UsesEphemeral;
2938 assert( p->pEList );
2939 }
drh34055852020-10-19 01:23:48 +00002940
drh03c39052018-05-02 14:24:34 +00002941
2942 /* Code the SELECT statements to our left
drhd8bc7082000-06-07 23:51:50 +00002943 */
drh03c39052018-05-02 14:24:34 +00002944 assert( !pPrior->pOrderBy );
2945 sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
drh93ffb502021-05-18 19:10:10 +00002946 SELECTTRACE(1, pParse, p, ("multiSelect EXCEPT/UNION left...\n"));
drh03c39052018-05-02 14:24:34 +00002947 rc = sqlite3Select(pParse, pPrior, &uniondest);
2948 if( rc ){
2949 goto multi_select_end;
2950 }
2951
2952 /* Code the current SELECT statement
drhd8bc7082000-06-07 23:51:50 +00002953 */
drh03c39052018-05-02 14:24:34 +00002954 if( p->op==TK_EXCEPT ){
2955 op = SRT_Except;
2956 }else{
2957 assert( p->op==TK_UNION );
2958 op = SRT_Union;
2959 }
2960 p->pPrior = 0;
2961 pLimit = p->pLimit;
2962 p->pLimit = 0;
2963 uniondest.eDest = op;
2964 ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
drhaae0f742021-03-04 16:03:32 +00002965 sqlite3SelectOpName(p->op)));
drh93ffb502021-05-18 19:10:10 +00002966 SELECTTRACE(1, pParse, p, ("multiSelect EXCEPT/UNION right...\n"));
drh03c39052018-05-02 14:24:34 +00002967 rc = sqlite3Select(pParse, p, &uniondest);
2968 testcase( rc!=SQLITE_OK );
drhb7cbf5c2020-06-15 13:51:34 +00002969 assert( p->pOrderBy==0 );
drh03c39052018-05-02 14:24:34 +00002970 pDelete = p->pPrior;
2971 p->pPrior = pPrior;
2972 p->pOrderBy = 0;
2973 if( p->op==TK_UNION ){
2974 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
2975 }
2976 sqlite3ExprDelete(db, p->pLimit);
2977 p->pLimit = pLimit;
2978 p->iLimit = 0;
2979 p->iOffset = 0;
2980
2981 /* Convert the data in the temporary table into whatever form
2982 ** it is that we currently need.
2983 */
2984 assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
drha9ebfe22019-12-25 23:54:21 +00002985 assert( p->pEList || db->mallocFailed );
2986 if( dest.eDest!=priorOp && db->mallocFailed==0 ){
drh03c39052018-05-02 14:24:34 +00002987 int iCont, iBreak, iStart;
drhec4ccdb2018-12-29 02:26:59 +00002988 iBreak = sqlite3VdbeMakeLabel(pParse);
2989 iCont = sqlite3VdbeMakeLabel(pParse);
drh03c39052018-05-02 14:24:34 +00002990 computeLimitRegisters(pParse, p, iBreak);
2991 sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
2992 iStart = sqlite3VdbeCurrentAddr(v);
2993 selectInnerLoop(pParse, p, unionTab,
2994 0, 0, &dest, iCont, iBreak);
2995 sqlite3VdbeResolveLabel(v, iCont);
2996 sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
2997 sqlite3VdbeResolveLabel(v, iBreak);
2998 sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
2999 }
3000 break;
3001 }
3002 default: assert( p->op==TK_INTERSECT ); {
3003 int tab1, tab2;
3004 int iCont, iBreak, iStart;
3005 Expr *pLimit;
3006 int addr;
3007 SelectDest intersectdest;
3008 int r1;
3009
3010 /* INTERSECT is different from the others since it requires
3011 ** two temporary tables. Hence it has its own case. Begin
3012 ** by allocating the tables we will need.
3013 */
3014 tab1 = pParse->nTab++;
3015 tab2 = pParse->nTab++;
drh93a960a2008-07-10 00:32:42 +00003016 assert( p->pOrderBy==0 );
drh03c39052018-05-02 14:24:34 +00003017
3018 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
drh93a960a2008-07-10 00:32:42 +00003019 assert( p->addrOpenEphm[0] == -1 );
3020 p->addrOpenEphm[0] = addr;
drhd227a292014-02-09 18:02:09 +00003021 findRightmost(p)->selFlags |= SF_UsesEphemeral;
danielk197784ac9d02004-05-18 09:58:06 +00003022 assert( p->pEList );
drh03c39052018-05-02 14:24:34 +00003023
3024 /* Code the SELECTs to our left into temporary table "tab1".
3025 */
3026 sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
drh93ffb502021-05-18 19:10:10 +00003027 SELECTTRACE(1, pParse, p, ("multiSelect INTERSECT left...\n"));
drh03c39052018-05-02 14:24:34 +00003028 rc = sqlite3Select(pParse, pPrior, &intersectdest);
3029 if( rc ){
3030 goto multi_select_end;
3031 }
3032
3033 /* Code the current SELECT into temporary table "tab2"
3034 */
3035 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
3036 assert( p->addrOpenEphm[1] == -1 );
3037 p->addrOpenEphm[1] = addr;
3038 p->pPrior = 0;
3039 pLimit = p->pLimit;
3040 p->pLimit = 0;
3041 intersectdest.iSDParm = tab2;
3042 ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
drhaae0f742021-03-04 16:03:32 +00003043 sqlite3SelectOpName(p->op)));
drh93ffb502021-05-18 19:10:10 +00003044 SELECTTRACE(1, pParse, p, ("multiSelect INTERSECT right...\n"));
drh03c39052018-05-02 14:24:34 +00003045 rc = sqlite3Select(pParse, p, &intersectdest);
3046 testcase( rc!=SQLITE_OK );
3047 pDelete = p->pPrior;
3048 p->pPrior = pPrior;
3049 if( p->nSelectRow>pPrior->nSelectRow ){
3050 p->nSelectRow = pPrior->nSelectRow;
3051 }
3052 sqlite3ExprDelete(db, p->pLimit);
3053 p->pLimit = pLimit;
3054
3055 /* Generate code to take the intersection of the two temporary
3056 ** tables.
3057 */
drh5f695122020-02-20 14:08:51 +00003058 if( rc ) break;
drh82c3d632000-06-06 21:56:07 +00003059 assert( p->pEList );
drhec4ccdb2018-12-29 02:26:59 +00003060 iBreak = sqlite3VdbeMakeLabel(pParse);
3061 iCont = sqlite3VdbeMakeLabel(pParse);
drhec7429a2005-10-06 16:53:14 +00003062 computeLimitRegisters(pParse, p, iBreak);
drh03c39052018-05-02 14:24:34 +00003063 sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
3064 r1 = sqlite3GetTempReg(pParse);
3065 iStart = sqlite3VdbeAddOp2(v, OP_RowData, tab1, r1);
3066 sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0);
3067 VdbeCoverage(v);
3068 sqlite3ReleaseTempReg(pParse, r1);
3069 selectInnerLoop(pParse, p, tab1,
drhe8e4af72012-09-21 00:04:28 +00003070 0, 0, &dest, iCont, iBreak);
danielk19774adee202004-05-08 08:23:19 +00003071 sqlite3VdbeResolveLabel(v, iCont);
drh03c39052018-05-02 14:24:34 +00003072 sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
danielk19774adee202004-05-08 08:23:19 +00003073 sqlite3VdbeResolveLabel(v, iBreak);
drh03c39052018-05-02 14:24:34 +00003074 sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
3075 sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
3076 break;
drh82c3d632000-06-06 21:56:07 +00003077 }
drh82c3d632000-06-06 21:56:07 +00003078 }
drh03c39052018-05-02 14:24:34 +00003079
3080 #ifndef SQLITE_OMIT_EXPLAIN
3081 if( p->pNext==0 ){
3082 ExplainQueryPlanPop(pParse);
drh82c3d632000-06-06 21:56:07 +00003083 }
drh03c39052018-05-02 14:24:34 +00003084 #endif
drh82c3d632000-06-06 21:56:07 +00003085 }
drh8428b3b2019-12-19 22:08:19 +00003086 if( pParse->nErr ) goto multi_select_end;
drh03c39052018-05-02 14:24:34 +00003087
drha9671a22008-07-08 23:40:20 +00003088 /* Compute collating sequences used by
3089 ** temporary tables needed to implement the compound select.
3090 ** Attach the KeyInfo structure to all temporary tables.
drh8cdbf832004-08-29 16:25:03 +00003091 **
3092 ** This section is run by the right-most SELECT statement only.
3093 ** SELECT statements to the left always skip this part. The right-most
3094 ** SELECT might also skip this part if it has no ORDER BY clause and
3095 ** no temp tables are required.
drhfbc4ee72004-08-29 01:31:05 +00003096 */
drh7d10d5a2008-08-20 16:35:10 +00003097 if( p->selFlags & SF_UsesEphemeral ){
drhfbc4ee72004-08-29 01:31:05 +00003098 int i; /* Loop counter */
3099 KeyInfo *pKeyInfo; /* Collating sequence for the result set */
drh0342b1f2005-09-01 03:07:44 +00003100 Select *pLoop; /* For looping through SELECT statements */
drhf68d7d12007-05-03 13:02:26 +00003101 CollSeq **apColl; /* For looping through pKeyInfo->aColl[] */
drh93a960a2008-07-10 00:32:42 +00003102 int nCol; /* Number of columns in result set */
drhfbc4ee72004-08-29 01:31:05 +00003103
drhd227a292014-02-09 18:02:09 +00003104 assert( p->pNext==0 );
drhaa6fe5b2021-10-04 13:18:44 +00003105 assert( p->pEList!=0 );
drh93a960a2008-07-10 00:32:42 +00003106 nCol = p->pEList->nExpr;
drhad124322013-10-23 13:30:58 +00003107 pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
danielk1977dc1bdc42004-06-11 10:51:27 +00003108 if( !pKeyInfo ){
mistachkinfad30392016-02-13 23:43:46 +00003109 rc = SQLITE_NOMEM_BKPT;
danielk1977dc1bdc42004-06-11 10:51:27 +00003110 goto multi_select_end;
3111 }
drh0342b1f2005-09-01 03:07:44 +00003112 for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
3113 *apColl = multiSelectCollSeq(pParse, p, i);
3114 if( 0==*apColl ){
drh633e6d52008-07-28 19:34:53 +00003115 *apColl = db->pDfltColl;
danielk1977dc1bdc42004-06-11 10:51:27 +00003116 }
3117 }
3118
drh0342b1f2005-09-01 03:07:44 +00003119 for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
3120 for(i=0; i<2; i++){
drhb9bb7c12006-06-11 23:41:55 +00003121 int addr = pLoop->addrOpenEphm[i];
drh0342b1f2005-09-01 03:07:44 +00003122 if( addr<0 ){
3123 /* If [0] is unused then [1] is also unused. So we can
3124 ** always safely abort as soon as the first unused slot is found */
drhb9bb7c12006-06-11 23:41:55 +00003125 assert( pLoop->addrOpenEphm[1]<0 );
drh0342b1f2005-09-01 03:07:44 +00003126 break;
3127 }
3128 sqlite3VdbeChangeP2(v, addr, nCol);
drh2ec2fb22013-11-06 19:59:23 +00003129 sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
3130 P4_KEYINFO);
drh0ee5a1e2007-01-26 19:04:00 +00003131 pLoop->addrOpenEphm[i] = -1;
drh0342b1f2005-09-01 03:07:44 +00003132 }
danielk1977dc1bdc42004-06-11 10:51:27 +00003133 }
drh2ec2fb22013-11-06 19:59:23 +00003134 sqlite3KeyInfoUnref(pKeyInfo);
danielk197784ac9d02004-05-18 09:58:06 +00003135 }
danielk1977dc1bdc42004-06-11 10:51:27 +00003136
3137multi_select_end:
drh2b596da2012-07-23 21:43:19 +00003138 pDest->iSdst = dest.iSdst;
3139 pDest->nSdst = dest.nSdst;
drhce68b6b2021-08-21 16:42:58 +00003140 if( pDelete ){
3141 sqlite3ParserAddCleanup(pParse,
3142 (void(*)(sqlite3*,void*))sqlite3SelectDelete,
3143 pDelete);
3144 }
danielk197784ac9d02004-05-18 09:58:06 +00003145 return rc;
drh22827922000-06-06 17:27:05 +00003146}
drhb7f91642004-10-31 02:22:47 +00003147#endif /* SQLITE_OMIT_COMPOUND_SELECT */
drh22827922000-06-06 17:27:05 +00003148
drhb21e7c72008-06-22 12:37:57 +00003149/*
mistachkin89b31d72015-07-16 17:29:27 +00003150** Error message for when two or more terms of a compound select have different
3151** size result sets.
3152*/
3153void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p){
3154 if( p->selFlags & SF_Values ){
3155 sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
3156 }else{
3157 sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
drhaae0f742021-03-04 16:03:32 +00003158 " do not have the same number of result columns",
3159 sqlite3SelectOpName(p->op));
mistachkin89b31d72015-07-16 17:29:27 +00003160 }
3161}
3162
3163/*
drhb21e7c72008-06-22 12:37:57 +00003164** Code an output subroutine for a coroutine implementation of a
3165** SELECT statment.
drh0acb7e42008-06-25 00:12:41 +00003166**
drh2b596da2012-07-23 21:43:19 +00003167** The data to be output is contained in pIn->iSdst. There are
3168** pIn->nSdst columns to be output. pDest is where the output should
drh0acb7e42008-06-25 00:12:41 +00003169** be sent.
3170**
3171** regReturn is the number of the register holding the subroutine
3172** return address.
3173**
drhf053d5b2010-08-09 14:26:32 +00003174** If regPrev>0 then it is the first register in a vector that
drh0acb7e42008-06-25 00:12:41 +00003175** records the previous output. mem[regPrev] is a flag that is false
3176** if there has been no previous output. If regPrev>0 then code is
3177** generated to suppress duplicates. pKeyInfo is used for comparing
3178** keys.
3179**
3180** If the LIMIT found in p->iLimit is reached, jump immediately to
3181** iBreak.
drhb21e7c72008-06-22 12:37:57 +00003182*/
drh0acb7e42008-06-25 00:12:41 +00003183static int generateOutputSubroutine(
drh92b01d52008-06-24 00:32:35 +00003184 Parse *pParse, /* Parsing context */
3185 Select *p, /* The SELECT statement */
3186 SelectDest *pIn, /* Coroutine supplying data */
3187 SelectDest *pDest, /* Where to send the data */
3188 int regReturn, /* The return address register */
drh0acb7e42008-06-25 00:12:41 +00003189 int regPrev, /* Previous result register. No uniqueness if 0 */
3190 KeyInfo *pKeyInfo, /* For comparing with previous entry */
drh92b01d52008-06-24 00:32:35 +00003191 int iBreak /* Jump here if we hit the LIMIT */
drhb21e7c72008-06-22 12:37:57 +00003192){
3193 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003194 int iContinue;
3195 int addr;
drhb21e7c72008-06-22 12:37:57 +00003196
drh92b01d52008-06-24 00:32:35 +00003197 addr = sqlite3VdbeCurrentAddr(v);
drhec4ccdb2018-12-29 02:26:59 +00003198 iContinue = sqlite3VdbeMakeLabel(pParse);
drh0acb7e42008-06-25 00:12:41 +00003199
3200 /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
3201 */
3202 if( regPrev ){
drh728e0f92015-10-10 14:41:28 +00003203 int addr1, addr2;
3204 addr1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
3205 addr2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
drh2ec2fb22013-11-06 19:59:23 +00003206 (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
drh728e0f92015-10-10 14:41:28 +00003207 sqlite3VdbeAddOp3(v, OP_Jump, addr2+2, iContinue, addr2+2); VdbeCoverage(v);
3208 sqlite3VdbeJumpHere(v, addr1);
drhe8e4af72012-09-21 00:04:28 +00003209 sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
drhec86c722011-12-09 17:27:51 +00003210 sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
drh0acb7e42008-06-25 00:12:41 +00003211 }
danielk19771f9caa42008-07-02 16:10:45 +00003212 if( pParse->db->mallocFailed ) return 0;
drh0acb7e42008-06-25 00:12:41 +00003213
mistachkind5578432012-08-25 10:01:29 +00003214 /* Suppress the first OFFSET entries if there is an OFFSET clause
drh0acb7e42008-06-25 00:12:41 +00003215 */
drhaa9ce702014-01-22 18:07:04 +00003216 codeOffset(v, p->iOffset, iContinue);
drhb21e7c72008-06-22 12:37:57 +00003217
drhe2248cf2015-05-22 17:29:27 +00003218 assert( pDest->eDest!=SRT_Exists );
3219 assert( pDest->eDest!=SRT_Table );
drhb21e7c72008-06-22 12:37:57 +00003220 switch( pDest->eDest ){
3221 /* Store the result as data using a unique key.
3222 */
drhb21e7c72008-06-22 12:37:57 +00003223 case SRT_EphemTab: {
3224 int r1 = sqlite3GetTempReg(pParse);
3225 int r2 = sqlite3GetTempReg(pParse);
drh2b596da2012-07-23 21:43:19 +00003226 sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
3227 sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
3228 sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
drhb21e7c72008-06-22 12:37:57 +00003229 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
3230 sqlite3ReleaseTempReg(pParse, r2);
3231 sqlite3ReleaseTempReg(pParse, r1);
3232 break;
3233 }
3234
3235#ifndef SQLITE_OMIT_SUBQUERY
drh14318072016-09-06 18:51:25 +00003236 /* If we are creating a set for an "expr IN (SELECT ...)".
drhb21e7c72008-06-22 12:37:57 +00003237 */
3238 case SRT_Set: {
drh6fccc352008-06-27 00:52:45 +00003239 int r1;
drh63cecc42016-09-06 19:08:21 +00003240 testcase( pIn->nSdst>1 );
drhb21e7c72008-06-22 12:37:57 +00003241 r1 = sqlite3GetTempReg(pParse);
dan71c57db2016-07-09 20:23:55 +00003242 sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst,
drh14318072016-09-06 18:51:25 +00003243 r1, pDest->zAffSdst, pIn->nSdst);
drh9b4eaeb2016-11-09 00:10:33 +00003244 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pDest->iSDParm, r1,
3245 pIn->iSdst, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003246 sqlite3ReleaseTempReg(pParse, r1);
drhb21e7c72008-06-22 12:37:57 +00003247 break;
3248 }
3249
drhb21e7c72008-06-22 12:37:57 +00003250 /* If this is a scalar select that is part of an expression, then
3251 ** store the results in the appropriate memory cell and break out
drhcb99c572019-08-09 20:26:01 +00003252 ** of the scan loop. Note that the select might return multiple columns
3253 ** if it is the RHS of a row-value IN operator.
drhb21e7c72008-06-22 12:37:57 +00003254 */
3255 case SRT_Mem: {
drh5f0922b2021-03-04 16:32:28 +00003256 testcase( pIn->nSdst>1 );
3257 sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003258 /* The LIMIT clause will jump out of the loop for us */
3259 break;
3260 }
3261#endif /* #ifndef SQLITE_OMIT_SUBQUERY */
3262
drh7d10d5a2008-08-20 16:35:10 +00003263 /* The results are stored in a sequence of registers
drh2b596da2012-07-23 21:43:19 +00003264 ** starting at pDest->iSdst. Then the co-routine yields.
drhb21e7c72008-06-22 12:37:57 +00003265 */
drh92b01d52008-06-24 00:32:35 +00003266 case SRT_Coroutine: {
drh2b596da2012-07-23 21:43:19 +00003267 if( pDest->iSdst==0 ){
3268 pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
3269 pDest->nSdst = pIn->nSdst;
drhb21e7c72008-06-22 12:37:57 +00003270 }
dan4b79bde2015-04-21 15:49:04 +00003271 sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pIn->nSdst);
drh2b596da2012-07-23 21:43:19 +00003272 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drh92b01d52008-06-24 00:32:35 +00003273 break;
3274 }
3275
drhccfcbce2009-05-18 15:46:07 +00003276 /* If none of the above, then the result destination must be
3277 ** SRT_Output. This routine is never called with any other
3278 ** destination other than the ones handled above or SRT_Output.
3279 **
3280 ** For SRT_Output, results are stored in a sequence of registers.
3281 ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
3282 ** return the next row of result.
drh7d10d5a2008-08-20 16:35:10 +00003283 */
drhccfcbce2009-05-18 15:46:07 +00003284 default: {
3285 assert( pDest->eDest==SRT_Output );
drh2b596da2012-07-23 21:43:19 +00003286 sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003287 break;
3288 }
drhb21e7c72008-06-22 12:37:57 +00003289 }
drh92b01d52008-06-24 00:32:35 +00003290
3291 /* Jump to the end of the loop if the LIMIT is reached.
3292 */
3293 if( p->iLimit ){
drh16897072015-03-07 00:57:37 +00003294 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003295 }
3296
drh92b01d52008-06-24 00:32:35 +00003297 /* Generate the subroutine return
3298 */
drh0acb7e42008-06-25 00:12:41 +00003299 sqlite3VdbeResolveLabel(v, iContinue);
drh92b01d52008-06-24 00:32:35 +00003300 sqlite3VdbeAddOp1(v, OP_Return, regReturn);
3301
3302 return addr;
drhb21e7c72008-06-22 12:37:57 +00003303}
3304
3305/*
3306** Alternative compound select code generator for cases when there
3307** is an ORDER BY clause.
3308**
3309** We assume a query of the following form:
3310**
3311** <selectA> <operator> <selectB> ORDER BY <orderbylist>
3312**
3313** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT. The idea
3314** is to code both <selectA> and <selectB> with the ORDER BY clause as
3315** co-routines. Then run the co-routines in parallel and merge the results
3316** into the output. In addition to the two coroutines (called selectA and
3317** selectB) there are 7 subroutines:
3318**
3319** outA: Move the output of the selectA coroutine into the output
3320** of the compound query.
3321**
3322** outB: Move the output of the selectB coroutine into the output
3323** of the compound query. (Only generated for UNION and
3324** UNION ALL. EXCEPT and INSERTSECT never output a row that
3325** appears only in B.)
3326**
3327** AltB: Called when there is data from both coroutines and A<B.
3328**
3329** AeqB: Called when there is data from both coroutines and A==B.
3330**
3331** AgtB: Called when there is data from both coroutines and A>B.
3332**
3333** EofA: Called when data is exhausted from selectA.
3334**
3335** EofB: Called when data is exhausted from selectB.
3336**
3337** The implementation of the latter five subroutines depend on which
3338** <operator> is used:
3339**
3340**
3341** UNION ALL UNION EXCEPT INTERSECT
3342** ------------- ----------------- -------------- -----------------
drh0acb7e42008-06-25 00:12:41 +00003343** AltB: outA, nextA outA, nextA outA, nextA nextA
drhb21e7c72008-06-22 12:37:57 +00003344**
drh0acb7e42008-06-25 00:12:41 +00003345** AeqB: outA, nextA nextA nextA outA, nextA
drhb21e7c72008-06-22 12:37:57 +00003346**
drh0acb7e42008-06-25 00:12:41 +00003347** AgtB: outB, nextB outB, nextB nextB nextB
drhb21e7c72008-06-22 12:37:57 +00003348**
drh0acb7e42008-06-25 00:12:41 +00003349** EofA: outB, nextB outB, nextB halt halt
drhb21e7c72008-06-22 12:37:57 +00003350**
drh0acb7e42008-06-25 00:12:41 +00003351** EofB: outA, nextA outA, nextA outA, nextA halt
3352**
3353** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
3354** causes an immediate jump to EofA and an EOF on B following nextB causes
3355** an immediate jump to EofB. Within EofA and EofB, and EOF on entry or
3356** following nextX causes a jump to the end of the select processing.
3357**
3358** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
3359** within the output subroutine. The regPrev register set holds the previously
3360** output value. A comparison is made against this value and the output
3361** is skipped if the next results would be the same as the previous.
drhb21e7c72008-06-22 12:37:57 +00003362**
3363** The implementation plan is to implement the two coroutines and seven
3364** subroutines first, then put the control logic at the bottom. Like this:
3365**
3366** goto Init
3367** coA: coroutine for left query (A)
3368** coB: coroutine for right query (B)
3369** outA: output one row of A
3370** outB: output one row of B (UNION and UNION ALL only)
3371** EofA: ...
3372** EofB: ...
3373** AltB: ...
3374** AeqB: ...
3375** AgtB: ...
3376** Init: initialize coroutine registers
3377** yield coA
3378** if eof(A) goto EofA
3379** yield coB
3380** if eof(B) goto EofB
3381** Cmpr: Compare A, B
3382** Jump AltB, AeqB, AgtB
3383** End: ...
3384**
3385** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
3386** actually called using Gosub and they do not Return. EofA and EofB loop
3387** until all data is exhausted then jump to the "end" labe. AltB, AeqB,
3388** and AgtB jump to either L2 or to one of EofA or EofB.
3389*/
danielk1977de3e41e2008-08-04 03:51:24 +00003390#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhb21e7c72008-06-22 12:37:57 +00003391static int multiSelectOrderBy(
3392 Parse *pParse, /* Parsing context */
3393 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00003394 SelectDest *pDest /* What to do with query results */
drhb21e7c72008-06-22 12:37:57 +00003395){
drh0acb7e42008-06-25 00:12:41 +00003396 int i, j; /* Loop counters */
drhb21e7c72008-06-22 12:37:57 +00003397 Select *pPrior; /* Another SELECT immediately to our left */
drh38cebe02021-12-30 00:37:11 +00003398 Select *pSplit; /* Left-most SELECT in the right-hand group */
3399 int nSelect; /* Number of SELECT statements in the compound */
drhb21e7c72008-06-22 12:37:57 +00003400 Vdbe *v; /* Generate code to this VDBE */
drhb21e7c72008-06-22 12:37:57 +00003401 SelectDest destA; /* Destination for coroutine A */
3402 SelectDest destB; /* Destination for coroutine B */
drh92b01d52008-06-24 00:32:35 +00003403 int regAddrA; /* Address register for select-A coroutine */
drh92b01d52008-06-24 00:32:35 +00003404 int regAddrB; /* Address register for select-B coroutine */
drh92b01d52008-06-24 00:32:35 +00003405 int addrSelectA; /* Address of the select-A coroutine */
3406 int addrSelectB; /* Address of the select-B coroutine */
3407 int regOutA; /* Address register for the output-A subroutine */
3408 int regOutB; /* Address register for the output-B subroutine */
3409 int addrOutA; /* Address of the output-A subroutine */
drhb27b7f52008-12-10 18:03:45 +00003410 int addrOutB = 0; /* Address of the output-B subroutine */
drh92b01d52008-06-24 00:32:35 +00003411 int addrEofA; /* Address of the select-A-exhausted subroutine */
drh81cf13e2014-02-07 18:27:53 +00003412 int addrEofA_noB; /* Alternate addrEofA if B is uninitialized */
drh92b01d52008-06-24 00:32:35 +00003413 int addrEofB; /* Address of the select-B-exhausted subroutine */
3414 int addrAltB; /* Address of the A<B subroutine */
3415 int addrAeqB; /* Address of the A==B subroutine */
3416 int addrAgtB; /* Address of the A>B subroutine */
3417 int regLimitA; /* Limit register for select-A */
3418 int regLimitB; /* Limit register for select-A */
drh0acb7e42008-06-25 00:12:41 +00003419 int regPrev; /* A range of registers to hold previous output */
drh92b01d52008-06-24 00:32:35 +00003420 int savedLimit; /* Saved value of p->iLimit */
3421 int savedOffset; /* Saved value of p->iOffset */
3422 int labelCmpr; /* Label for the start of the merge algorithm */
3423 int labelEnd; /* Label for the end of the overall SELECT stmt */
drh728e0f92015-10-10 14:41:28 +00003424 int addr1; /* Jump instructions that get retargetted */
drh92b01d52008-06-24 00:32:35 +00003425 int op; /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
drh96067812008-09-23 09:36:10 +00003426 KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
drh0acb7e42008-06-25 00:12:41 +00003427 KeyInfo *pKeyMerge; /* Comparison information for merging rows */
3428 sqlite3 *db; /* Database connection */
3429 ExprList *pOrderBy; /* The ORDER BY clause */
3430 int nOrderBy; /* Number of terms in the ORDER BY clause */
drhabc38152020-07-22 13:38:04 +00003431 u32 *aPermute; /* Mapping from ORDER BY terms to result set columns */
drhb21e7c72008-06-22 12:37:57 +00003432
drh92b01d52008-06-24 00:32:35 +00003433 assert( p->pOrderBy!=0 );
drh96067812008-09-23 09:36:10 +00003434 assert( pKeyDup==0 ); /* "Managed" code needs this. Ticket #3382. */
drh0acb7e42008-06-25 00:12:41 +00003435 db = pParse->db;
drh92b01d52008-06-24 00:32:35 +00003436 v = pParse->pVdbe;
drhccfcbce2009-05-18 15:46:07 +00003437 assert( v!=0 ); /* Already thrown the error if VDBE alloc failed */
drhec4ccdb2018-12-29 02:26:59 +00003438 labelEnd = sqlite3VdbeMakeLabel(pParse);
3439 labelCmpr = sqlite3VdbeMakeLabel(pParse);
drh0acb7e42008-06-25 00:12:41 +00003440
drh92b01d52008-06-24 00:32:35 +00003441
3442 /* Patch up the ORDER BY clause
3443 */
3444 op = p->op;
drh38cebe02021-12-30 00:37:11 +00003445 assert( p->pPrior->pOrderBy==0 );
drh0acb7e42008-06-25 00:12:41 +00003446 pOrderBy = p->pOrderBy;
drh93a960a2008-07-10 00:32:42 +00003447 assert( pOrderBy );
drh93a960a2008-07-10 00:32:42 +00003448 nOrderBy = pOrderBy->nExpr;
3449
drh0acb7e42008-06-25 00:12:41 +00003450 /* For operators other than UNION ALL we have to make sure that
3451 ** the ORDER BY clause covers every term of the result set. Add
3452 ** terms to the ORDER BY clause as necessary.
3453 */
3454 if( op!=TK_ALL ){
3455 for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
drh7d10d5a2008-08-20 16:35:10 +00003456 struct ExprList_item *pItem;
3457 for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
drh7d4c94b2021-10-04 22:34:38 +00003458 assert( pItem!=0 );
drhc2acc4e2013-11-15 18:15:19 +00003459 assert( pItem->u.x.iOrderByCol>0 );
3460 if( pItem->u.x.iOrderByCol==i ) break;
drh0acb7e42008-06-25 00:12:41 +00003461 }
3462 if( j==nOrderBy ){
drhb7916a72009-05-27 10:31:29 +00003463 Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
mistachkinfad30392016-02-13 23:43:46 +00003464 if( pNew==0 ) return SQLITE_NOMEM_BKPT;
drh0acb7e42008-06-25 00:12:41 +00003465 pNew->flags |= EP_IntValue;
drh33e619f2009-05-28 01:00:55 +00003466 pNew->u.iValue = i;
drh43606172017-04-05 11:32:13 +00003467 p->pOrderBy = pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
drhc2acc4e2013-11-15 18:15:19 +00003468 if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
drh0acb7e42008-06-25 00:12:41 +00003469 }
3470 }
3471 }
3472
3473 /* Compute the comparison permutation and keyinfo that is used with
drh10c081a2009-04-16 00:24:23 +00003474 ** the permutation used to determine if the next
drh0acb7e42008-06-25 00:12:41 +00003475 ** row of results comes from selectA or selectB. Also add explicit
3476 ** collations to the ORDER BY clause terms so that when the subqueries
3477 ** to the right and the left are evaluated, they use the correct
3478 ** collation.
3479 */
drhabc38152020-07-22 13:38:04 +00003480 aPermute = sqlite3DbMallocRawNN(db, sizeof(u32)*(nOrderBy + 1));
drh0acb7e42008-06-25 00:12:41 +00003481 if( aPermute ){
drh7d10d5a2008-08-20 16:35:10 +00003482 struct ExprList_item *pItem;
drhb1702022016-01-30 00:45:18 +00003483 aPermute[0] = nOrderBy;
3484 for(i=1, pItem=pOrderBy->a; i<=nOrderBy; i++, pItem++){
drh7d4c94b2021-10-04 22:34:38 +00003485 assert( pItem!=0 );
drh67366182015-04-16 14:33:35 +00003486 assert( pItem->u.x.iOrderByCol>0 );
drh2ec18a32015-06-23 23:31:52 +00003487 assert( pItem->u.x.iOrderByCol<=p->pEList->nExpr );
drhc2acc4e2013-11-15 18:15:19 +00003488 aPermute[i] = pItem->u.x.iOrderByCol - 1;
drh0acb7e42008-06-25 00:12:41 +00003489 }
dan53bed452014-01-24 20:37:18 +00003490 pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
drh0acb7e42008-06-25 00:12:41 +00003491 }else{
3492 pKeyMerge = 0;
3493 }
3494
drh0acb7e42008-06-25 00:12:41 +00003495 /* Allocate a range of temporary registers and the KeyInfo needed
3496 ** for the logic that removes duplicate result rows when the
3497 ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
3498 */
3499 if( op==TK_ALL ){
3500 regPrev = 0;
3501 }else{
3502 int nExpr = p->pEList->nExpr;
drh1c0dc822008-10-30 22:13:23 +00003503 assert( nOrderBy>=nExpr || db->mallocFailed );
drhc8ac0d12013-02-16 02:41:01 +00003504 regPrev = pParse->nMem+1;
3505 pParse->nMem += nExpr+1;
drh0acb7e42008-06-25 00:12:41 +00003506 sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
drhad124322013-10-23 13:30:58 +00003507 pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
drh0acb7e42008-06-25 00:12:41 +00003508 if( pKeyDup ){
drh2ec2fb22013-11-06 19:59:23 +00003509 assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
drh0acb7e42008-06-25 00:12:41 +00003510 for(i=0; i<nExpr; i++){
3511 pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
dan6e118922019-08-12 16:36:38 +00003512 pKeyDup->aSortFlags[i] = 0;
drh0acb7e42008-06-25 00:12:41 +00003513 }
3514 }
3515 }
drh92b01d52008-06-24 00:32:35 +00003516
3517 /* Separate the left and the right query from one another
3518 */
drh38cebe02021-12-30 00:37:11 +00003519 nSelect = 1;
3520 if( (op==TK_ALL || op==TK_UNION)
3521 && OptimizationEnabled(db, SQLITE_BalancedMerge)
3522 ){
3523 for(pSplit=p; pSplit->pPrior!=0 && pSplit->op==op; pSplit=pSplit->pPrior){
3524 nSelect++;
3525 assert( pSplit->pPrior->pNext==pSplit );
3526 }
3527 }
3528 if( nSelect<=3 ){
3529 pSplit = p;
3530 }else{
3531 pSplit = p;
3532 for(i=2; i<nSelect; i+=2){ pSplit = pSplit->pPrior; }
3533 }
3534 pPrior = pSplit->pPrior;
drh98bb34c2022-01-20 12:58:15 +00003535 assert( pPrior!=0 );
drh38cebe02021-12-30 00:37:11 +00003536 pSplit->pPrior = 0;
drhd227a292014-02-09 18:02:09 +00003537 pPrior->pNext = 0;
drh38cebe02021-12-30 00:37:11 +00003538 assert( p->pOrderBy == pOrderBy );
3539 assert( pOrderBy!=0 || db->mallocFailed );
3540 pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
drh9aff8242021-12-30 17:46:15 +00003541 sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
3542 sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
drh0acb7e42008-06-25 00:12:41 +00003543
drh92b01d52008-06-24 00:32:35 +00003544 /* Compute the limit registers */
3545 computeLimitRegisters(pParse, p, labelEnd);
drh0acb7e42008-06-25 00:12:41 +00003546 if( p->iLimit && op==TK_ALL ){
drh92b01d52008-06-24 00:32:35 +00003547 regLimitA = ++pParse->nMem;
3548 regLimitB = ++pParse->nMem;
3549 sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
3550 regLimitA);
3551 sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
3552 }else{
3553 regLimitA = regLimitB = 0;
3554 }
drh633e6d52008-07-28 19:34:53 +00003555 sqlite3ExprDelete(db, p->pLimit);
drh0acb7e42008-06-25 00:12:41 +00003556 p->pLimit = 0;
drh92b01d52008-06-24 00:32:35 +00003557
drhb21e7c72008-06-22 12:37:57 +00003558 regAddrA = ++pParse->nMem;
drhb21e7c72008-06-22 12:37:57 +00003559 regAddrB = ++pParse->nMem;
drhb21e7c72008-06-22 12:37:57 +00003560 regOutA = ++pParse->nMem;
3561 regOutB = ++pParse->nMem;
3562 sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
3563 sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
drhe2ca99c2018-05-02 00:33:43 +00003564
drhaae0f742021-03-04 16:03:32 +00003565 ExplainQueryPlan((pParse, 1, "MERGE (%s)", sqlite3SelectOpName(p->op)));
drhb21e7c72008-06-22 12:37:57 +00003566
drh92b01d52008-06-24 00:32:35 +00003567 /* Generate a coroutine to evaluate the SELECT statement to the
drh0acb7e42008-06-25 00:12:41 +00003568 ** left of the compound operator - the "A" select.
3569 */
drhed71a832014-02-07 19:18:10 +00003570 addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
drh728e0f92015-10-10 14:41:28 +00003571 addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
drhed71a832014-02-07 19:18:10 +00003572 VdbeComment((v, "left SELECT"));
drh92b01d52008-06-24 00:32:35 +00003573 pPrior->iLimit = regLimitA;
drhc631ded2018-05-02 02:22:22 +00003574 ExplainQueryPlan((pParse, 1, "LEFT"));
drh7d10d5a2008-08-20 16:35:10 +00003575 sqlite3Select(pParse, pPrior, &destA);
drh2fade2f2016-02-09 02:12:20 +00003576 sqlite3VdbeEndCoroutine(v, regAddrA);
drh728e0f92015-10-10 14:41:28 +00003577 sqlite3VdbeJumpHere(v, addr1);
drhb21e7c72008-06-22 12:37:57 +00003578
drh92b01d52008-06-24 00:32:35 +00003579 /* Generate a coroutine to evaluate the SELECT statement on
3580 ** the right - the "B" select
3581 */
drhed71a832014-02-07 19:18:10 +00003582 addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
drh728e0f92015-10-10 14:41:28 +00003583 addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
drhed71a832014-02-07 19:18:10 +00003584 VdbeComment((v, "right SELECT"));
drh92b01d52008-06-24 00:32:35 +00003585 savedLimit = p->iLimit;
3586 savedOffset = p->iOffset;
3587 p->iLimit = regLimitB;
3588 p->iOffset = 0;
drhc631ded2018-05-02 02:22:22 +00003589 ExplainQueryPlan((pParse, 1, "RIGHT"));
drh7d10d5a2008-08-20 16:35:10 +00003590 sqlite3Select(pParse, p, &destB);
drh92b01d52008-06-24 00:32:35 +00003591 p->iLimit = savedLimit;
3592 p->iOffset = savedOffset;
drh2fade2f2016-02-09 02:12:20 +00003593 sqlite3VdbeEndCoroutine(v, regAddrB);
drhb21e7c72008-06-22 12:37:57 +00003594
drh92b01d52008-06-24 00:32:35 +00003595 /* Generate a subroutine that outputs the current row of the A
drh0acb7e42008-06-25 00:12:41 +00003596 ** select as the next output row of the compound select.
drh92b01d52008-06-24 00:32:35 +00003597 */
drhb21e7c72008-06-22 12:37:57 +00003598 VdbeNoopComment((v, "Output routine for A"));
drh0acb7e42008-06-25 00:12:41 +00003599 addrOutA = generateOutputSubroutine(pParse,
3600 p, &destA, pDest, regOutA,
drh2ec2fb22013-11-06 19:59:23 +00003601 regPrev, pKeyDup, labelEnd);
drhb21e7c72008-06-22 12:37:57 +00003602
drh92b01d52008-06-24 00:32:35 +00003603 /* Generate a subroutine that outputs the current row of the B
drh0acb7e42008-06-25 00:12:41 +00003604 ** select as the next output row of the compound select.
drh92b01d52008-06-24 00:32:35 +00003605 */
drh0acb7e42008-06-25 00:12:41 +00003606 if( op==TK_ALL || op==TK_UNION ){
3607 VdbeNoopComment((v, "Output routine for B"));
3608 addrOutB = generateOutputSubroutine(pParse,
3609 p, &destB, pDest, regOutB,
drh2ec2fb22013-11-06 19:59:23 +00003610 regPrev, pKeyDup, labelEnd);
drh0acb7e42008-06-25 00:12:41 +00003611 }
drh2ec2fb22013-11-06 19:59:23 +00003612 sqlite3KeyInfoUnref(pKeyDup);
drhb21e7c72008-06-22 12:37:57 +00003613
drh92b01d52008-06-24 00:32:35 +00003614 /* Generate a subroutine to run when the results from select A
3615 ** are exhausted and only data in select B remains.
3616 */
drhb21e7c72008-06-22 12:37:57 +00003617 if( op==TK_EXCEPT || op==TK_INTERSECT ){
drh81cf13e2014-02-07 18:27:53 +00003618 addrEofA_noB = addrEofA = labelEnd;
drhb21e7c72008-06-22 12:37:57 +00003619 }else{
drh81cf13e2014-02-07 18:27:53 +00003620 VdbeNoopComment((v, "eof-A subroutine"));
3621 addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3622 addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
drh688852a2014-02-17 22:40:43 +00003623 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003624 sqlite3VdbeGoto(v, addrEofA);
drhc3489bb2016-02-25 16:04:59 +00003625 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
drhb21e7c72008-06-22 12:37:57 +00003626 }
3627
drh92b01d52008-06-24 00:32:35 +00003628 /* Generate a subroutine to run when the results from select B
3629 ** are exhausted and only data in select A remains.
3630 */
drhb21e7c72008-06-22 12:37:57 +00003631 if( op==TK_INTERSECT ){
drh92b01d52008-06-24 00:32:35 +00003632 addrEofB = addrEofA;
drh95aa47b2010-11-16 02:49:15 +00003633 if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
drhb21e7c72008-06-22 12:37:57 +00003634 }else{
drh92b01d52008-06-24 00:32:35 +00003635 VdbeNoopComment((v, "eof-B subroutine"));
drh81cf13e2014-02-07 18:27:53 +00003636 addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
drh688852a2014-02-17 22:40:43 +00003637 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003638 sqlite3VdbeGoto(v, addrEofB);
drhb21e7c72008-06-22 12:37:57 +00003639 }
3640
drh92b01d52008-06-24 00:32:35 +00003641 /* Generate code to handle the case of A<B
3642 */
drhb21e7c72008-06-22 12:37:57 +00003643 VdbeNoopComment((v, "A-lt-B subroutine"));
drh0acb7e42008-06-25 00:12:41 +00003644 addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
drh688852a2014-02-17 22:40:43 +00003645 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003646 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003647
drh92b01d52008-06-24 00:32:35 +00003648 /* Generate code to handle the case of A==B
3649 */
drhb21e7c72008-06-22 12:37:57 +00003650 if( op==TK_ALL ){
3651 addrAeqB = addrAltB;
drh0acb7e42008-06-25 00:12:41 +00003652 }else if( op==TK_INTERSECT ){
3653 addrAeqB = addrAltB;
3654 addrAltB++;
drh92b01d52008-06-24 00:32:35 +00003655 }else{
drhb21e7c72008-06-22 12:37:57 +00003656 VdbeNoopComment((v, "A-eq-B subroutine"));
drh0acb7e42008-06-25 00:12:41 +00003657 addrAeqB =
drh688852a2014-02-17 22:40:43 +00003658 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003659 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003660 }
3661
drh92b01d52008-06-24 00:32:35 +00003662 /* Generate code to handle the case of A>B
3663 */
drhb21e7c72008-06-22 12:37:57 +00003664 VdbeNoopComment((v, "A-gt-B subroutine"));
3665 addrAgtB = sqlite3VdbeCurrentAddr(v);
3666 if( op==TK_ALL || op==TK_UNION ){
3667 sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3668 }
drh688852a2014-02-17 22:40:43 +00003669 sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003670 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003671
drh92b01d52008-06-24 00:32:35 +00003672 /* This code runs once to initialize everything.
3673 */
drh728e0f92015-10-10 14:41:28 +00003674 sqlite3VdbeJumpHere(v, addr1);
drh688852a2014-02-17 22:40:43 +00003675 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
3676 sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003677
3678 /* Implement the main merge loop
3679 */
3680 sqlite3VdbeResolveLabel(v, labelCmpr);
drh0acb7e42008-06-25 00:12:41 +00003681 sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
drh2b596da2012-07-23 21:43:19 +00003682 sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
drh2ec2fb22013-11-06 19:59:23 +00003683 (char*)pKeyMerge, P4_KEYINFO);
drh953f7612012-12-07 22:18:54 +00003684 sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
drh688852a2014-02-17 22:40:43 +00003685 sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003686
3687 /* Jump to the this point in order to terminate the query.
3688 */
drhb21e7c72008-06-22 12:37:57 +00003689 sqlite3VdbeResolveLabel(v, labelEnd);
drh92b01d52008-06-24 00:32:35 +00003690
drh0acb7e42008-06-25 00:12:41 +00003691 /* Reassembly the compound query so that it will be freed correctly
3692 ** by the calling function */
drh38cebe02021-12-30 00:37:11 +00003693 if( pSplit->pPrior ){
3694 sqlite3SelectDelete(db, pSplit->pPrior);
danielk19775e7ad502008-07-01 17:39:27 +00003695 }
drh38cebe02021-12-30 00:37:11 +00003696 pSplit->pPrior = pPrior;
3697 pPrior->pNext = pSplit;
dancd0b2452021-04-12 12:02:49 +00003698 sqlite3ExprListDelete(db, pPrior->pOrderBy);
3699 pPrior->pOrderBy = 0;
3700
drh92b01d52008-06-24 00:32:35 +00003701 /*** TBD: Insert subroutine calls to close cursors on incomplete
3702 **** subqueries ****/
drhe2ca99c2018-05-02 00:33:43 +00003703 ExplainQueryPlanPop(pParse);
drh3dc4cc62015-04-15 07:10:25 +00003704 return pParse->nErr!=0;
drhb21e7c72008-06-22 12:37:57 +00003705}
danielk1977de3e41e2008-08-04 03:51:24 +00003706#endif
drhb21e7c72008-06-22 12:37:57 +00003707
shane3514b6f2008-07-22 05:00:55 +00003708#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh46967de2017-04-14 12:39:37 +00003709
3710/* An instance of the SubstContext object describes an substitution edit
3711** to be performed on a parse tree.
3712**
3713** All references to columns in table iTable are to be replaced by corresponding
3714** expressions in pEList.
drhc133bab2022-04-11 20:15:52 +00003715**
3716** ## About "isOuterJoin":
3717**
3718** The isOuterJoin column indicates that the replacement will occur into a
3719** position in the parent that NULL-able due to an OUTER JOIN. Either the
3720** target slot in the parent is the right operand of a LEFT JOIN, or one of
3721** the left operands of a RIGHT JOIN. In either case, we need to potentially
3722** bypass the substituted expression with OP_IfNullRow.
3723**
3724** Suppose the original expression integer constant. Even though the table
3725** has the nullRow flag set, because the expression is an integer constant,
3726** it will not be NULLed out. So instead, we insert an OP_IfNullRow opcode
3727** that checks to see if the nullRow flag is set on the table. If the nullRow
3728** flag is set, then the value in the register is set to NULL and the original
3729** expression is bypassed. If the nullRow flag is not set, then the original
3730** expression runs to populate the register.
3731**
3732** Example where this is needed:
3733**
3734** CREATE TABLE t1(a INTEGER PRIMARY KEY, b INT);
3735** CREATE TABLE t2(x INT UNIQUE);
3736**
3737** SELECT a,b,m,x FROM t1 LEFT JOIN (SELECT 59 AS m,x FROM t2) ON b=x;
3738**
3739** When the subquery on the right side of the LEFT JOIN is flattened, we
3740** have to add OP_IfNullRow in front of the OP_Integer that implements the
3741** "m" value of the subquery so that a NULL will be loaded instead of 59
3742** when processing a non-matched row of the left.
drh46967de2017-04-14 12:39:37 +00003743*/
3744typedef struct SubstContext {
3745 Parse *pParse; /* The parsing context */
3746 int iTable; /* Replace references to this table */
drh31d6fd52017-04-14 19:03:10 +00003747 int iNewTable; /* New table number */
drhc133bab2022-04-11 20:15:52 +00003748 int isOuterJoin; /* Add TK_IF_NULL_ROW opcodes on each replacement */
drh46967de2017-04-14 12:39:37 +00003749 ExprList *pEList; /* Replacement expressions */
3750} SubstContext;
3751
drh17435752007-08-16 04:30:38 +00003752/* Forward Declarations */
drh46967de2017-04-14 12:39:37 +00003753static void substExprList(SubstContext*, ExprList*);
3754static void substSelect(SubstContext*, Select*, int);
drh17435752007-08-16 04:30:38 +00003755
drh22827922000-06-06 17:27:05 +00003756/*
drh832508b2002-03-02 17:04:07 +00003757** Scan through the expression pExpr. Replace every reference to
drh6a3ea0e2003-05-02 14:32:12 +00003758** a column in table number iTable with a copy of the iColumn-th
drh84e59202002-03-14 14:33:31 +00003759** entry in pEList. (But leave references to the ROWID column
drh6a3ea0e2003-05-02 14:32:12 +00003760** unchanged.)
drh832508b2002-03-02 17:04:07 +00003761**
3762** This routine is part of the flattening procedure. A subquery
3763** whose result set is defined by pEList appears as entry in the
3764** FROM clause of a SELECT such that the VDBE cursor assigned to that
drhaca19e12017-04-07 19:41:31 +00003765** FORM clause entry is iTable. This routine makes the necessary
drh832508b2002-03-02 17:04:07 +00003766** changes to pExpr so that it refers directly to the source table
3767** of the subquery rather the result set of the subquery.
3768*/
drhb7916a72009-05-27 10:31:29 +00003769static Expr *substExpr(
drh46967de2017-04-14 12:39:37 +00003770 SubstContext *pSubst, /* Description of the substitution */
3771 Expr *pExpr /* Expr in which substitution occurs */
drh17435752007-08-16 04:30:38 +00003772){
drhb7916a72009-05-27 10:31:29 +00003773 if( pExpr==0 ) return 0;
drh33b2cb92022-06-07 13:09:58 +00003774 if( ExprHasProperty(pExpr, EP_OuterON|EP_InnerON)
drhd1985262022-04-11 11:25:28 +00003775 && pExpr->w.iJoin==pSubst->iTable
drh3d240d22017-09-28 16:56:55 +00003776 ){
drh33b2cb92022-06-07 13:09:58 +00003777 testcase( ExprHasProperty(pExpr, EP_InnerON) );
drhd1985262022-04-11 11:25:28 +00003778 pExpr->w.iJoin = pSubst->iNewTable;
drh399c7e22017-04-14 17:18:45 +00003779 }
drh2e52a9c2020-04-04 00:15:54 +00003780 if( pExpr->op==TK_COLUMN
3781 && pExpr->iTable==pSubst->iTable
3782 && !ExprHasProperty(pExpr, EP_FixedCol)
3783 ){
drh6e5020e2021-04-07 15:45:01 +00003784#ifdef SQLITE_ALLOW_ROWID_IN_VIEW
drh50350a12004-02-13 16:22:22 +00003785 if( pExpr->iColumn<0 ){
3786 pExpr->op = TK_NULL;
drh6e5020e2021-04-07 15:45:01 +00003787 }else
3788#endif
3789 {
drh50350a12004-02-13 16:22:22 +00003790 Expr *pNew;
drh46967de2017-04-14 12:39:37 +00003791 Expr *pCopy = pSubst->pEList->a[pExpr->iColumn].pExpr;
drh31d6fd52017-04-14 19:03:10 +00003792 Expr ifNullRow;
drh46967de2017-04-14 12:39:37 +00003793 assert( pSubst->pEList!=0 && pExpr->iColumn<pSubst->pEList->nExpr );
drh1fd4e7b2018-07-28 14:56:56 +00003794 assert( pExpr->pRight==0 );
dan44c56042016-12-07 15:38:37 +00003795 if( sqlite3ExprIsVector(pCopy) ){
drh46967de2017-04-14 12:39:37 +00003796 sqlite3VectorErrorMsg(pSubst->pParse, pCopy);
dan44c56042016-12-07 15:38:37 +00003797 }else{
drh46967de2017-04-14 12:39:37 +00003798 sqlite3 *db = pSubst->pParse->db;
drhc133bab2022-04-11 20:15:52 +00003799 if( pSubst->isOuterJoin && pCopy->op!=TK_COLUMN ){
drh31d6fd52017-04-14 19:03:10 +00003800 memset(&ifNullRow, 0, sizeof(ifNullRow));
3801 ifNullRow.op = TK_IF_NULL_ROW;
3802 ifNullRow.pLeft = pCopy;
3803 ifNullRow.iTable = pSubst->iNewTable;
drh4b1b65c2022-07-26 15:32:02 +00003804 ifNullRow.iColumn = -99;
drh46fe1382020-08-19 23:32:06 +00003805 ifNullRow.flags = EP_IfNullRow;
drh31d6fd52017-04-14 19:03:10 +00003806 pCopy = &ifNullRow;
3807 }
drh11df7d22018-12-06 19:15:36 +00003808 testcase( ExprHasProperty(pCopy, EP_Subquery) );
dan44c56042016-12-07 15:38:37 +00003809 pNew = sqlite3ExprDup(db, pCopy, 0);
drh8c6cb1b2021-04-19 20:36:13 +00003810 if( db->mallocFailed ){
3811 sqlite3ExprDelete(db, pNew);
3812 return pExpr;
3813 }
drhc133bab2022-04-11 20:15:52 +00003814 if( pSubst->isOuterJoin ){
danbd11a2a2017-06-20 17:43:26 +00003815 ExprSetProperty(pNew, EP_CanBeNull);
3816 }
drh67a99db2022-05-13 14:52:04 +00003817 if( ExprHasProperty(pExpr,EP_OuterON|EP_InnerON) ){
drh3a6e4c52022-04-11 12:38:06 +00003818 sqlite3SetJoinExpr(pNew, pExpr->w.iJoin,
drh67a99db2022-05-13 14:52:04 +00003819 pExpr->flags & (EP_OuterON|EP_InnerON));
dan44c56042016-12-07 15:38:37 +00003820 }
3821 sqlite3ExprDelete(db, pExpr);
3822 pExpr = pNew;
dan410fac32022-06-02 16:26:21 +00003823 if( pExpr->op==TK_TRUEFALSE ){
3824 pExpr->u.iValue = sqlite3ExprTruthValue(pExpr);
3825 pExpr->op = TK_INTEGER;
3826 ExprSetProperty(pExpr, EP_IntValue);
3827 }
dane0866392019-09-09 19:49:42 +00003828
danfa508342019-09-10 15:33:52 +00003829 /* Ensure that the expression now has an implicit collation sequence,
3830 ** just as it did when it was a column of a view or sub-query. */
drh60b95332021-04-19 15:05:27 +00003831 if( pExpr->op!=TK_COLUMN && pExpr->op!=TK_COLLATE ){
3832 CollSeq *pColl = sqlite3ExprCollSeq(pSubst->pParse, pExpr);
3833 pExpr = sqlite3ExprAddCollateString(pSubst->pParse, pExpr,
3834 (pColl ? pColl->zName : "BINARY")
3835 );
dane0866392019-09-09 19:49:42 +00003836 }
drh60b95332021-04-19 15:05:27 +00003837 ExprClearProperty(pExpr, EP_Collate);
dan92ddb3b2016-12-01 19:38:05 +00003838 }
drh50350a12004-02-13 16:22:22 +00003839 }
drh832508b2002-03-02 17:04:07 +00003840 }else{
drh7c1544e2017-05-23 12:44:57 +00003841 if( pExpr->op==TK_IF_NULL_ROW && pExpr->iTable==pSubst->iTable ){
3842 pExpr->iTable = pSubst->iNewTable;
3843 }
drh46967de2017-04-14 12:39:37 +00003844 pExpr->pLeft = substExpr(pSubst, pExpr->pLeft);
3845 pExpr->pRight = substExpr(pSubst, pExpr->pRight);
drha4eeccd2021-10-07 17:43:30 +00003846 if( ExprUseXSelect(pExpr) ){
drh46967de2017-04-14 12:39:37 +00003847 substSelect(pSubst, pExpr->x.pSelect, 1);
danielk19776ab3a2e2009-02-19 14:39:25 +00003848 }else{
drh46967de2017-04-14 12:39:37 +00003849 substExprList(pSubst, pExpr->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +00003850 }
dan3703edf2019-10-10 15:17:09 +00003851#ifndef SQLITE_OMIT_WINDOWFUNC
3852 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3853 Window *pWin = pExpr->y.pWin;
3854 pWin->pFilter = substExpr(pSubst, pWin->pFilter);
3855 substExprList(pSubst, pWin->pPartition);
3856 substExprList(pSubst, pWin->pOrderBy);
3857 }
3858#endif
drh832508b2002-03-02 17:04:07 +00003859 }
drhb7916a72009-05-27 10:31:29 +00003860 return pExpr;
drh832508b2002-03-02 17:04:07 +00003861}
drh17435752007-08-16 04:30:38 +00003862static void substExprList(
drh46967de2017-04-14 12:39:37 +00003863 SubstContext *pSubst, /* Description of the substitution */
3864 ExprList *pList /* List to scan and in which to make substitutes */
drh17435752007-08-16 04:30:38 +00003865){
drh832508b2002-03-02 17:04:07 +00003866 int i;
3867 if( pList==0 ) return;
3868 for(i=0; i<pList->nExpr; i++){
drh46967de2017-04-14 12:39:37 +00003869 pList->a[i].pExpr = substExpr(pSubst, pList->a[i].pExpr);
drh832508b2002-03-02 17:04:07 +00003870 }
3871}
drh17435752007-08-16 04:30:38 +00003872static void substSelect(
drh46967de2017-04-14 12:39:37 +00003873 SubstContext *pSubst, /* Description of the substitution */
3874 Select *p, /* SELECT statement in which to make substitutions */
3875 int doPrior /* Do substitutes on p->pPrior too */
drh17435752007-08-16 04:30:38 +00003876){
drh588a9a12008-09-01 15:52:10 +00003877 SrcList *pSrc;
drh76012942021-02-21 21:04:54 +00003878 SrcItem *pItem;
drh588a9a12008-09-01 15:52:10 +00003879 int i;
danielk1977b3bce662005-01-29 08:32:43 +00003880 if( !p ) return;
drhd12b6362015-10-11 19:46:59 +00003881 do{
drh46967de2017-04-14 12:39:37 +00003882 substExprList(pSubst, p->pEList);
3883 substExprList(pSubst, p->pGroupBy);
3884 substExprList(pSubst, p->pOrderBy);
3885 p->pHaving = substExpr(pSubst, p->pHaving);
3886 p->pWhere = substExpr(pSubst, p->pWhere);
drhd12b6362015-10-11 19:46:59 +00003887 pSrc = p->pSrc;
drh29064902015-10-11 20:08:31 +00003888 assert( pSrc!=0 );
drh588a9a12008-09-01 15:52:10 +00003889 for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
drh46967de2017-04-14 12:39:37 +00003890 substSelect(pSubst, pItem->pSelect, 1);
drh29064902015-10-11 20:08:31 +00003891 if( pItem->fg.isTabFunc ){
drh46967de2017-04-14 12:39:37 +00003892 substExprList(pSubst, pItem->u1.pFuncArg);
drhd12b6362015-10-11 19:46:59 +00003893 }
drh588a9a12008-09-01 15:52:10 +00003894 }
drhd12b6362015-10-11 19:46:59 +00003895 }while( doPrior && (p = p->pPrior)!=0 );
danielk1977b3bce662005-01-29 08:32:43 +00003896}
shane3514b6f2008-07-22 05:00:55 +00003897#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
drh832508b2002-03-02 17:04:07 +00003898
shane3514b6f2008-07-22 05:00:55 +00003899#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh832508b2002-03-02 17:04:07 +00003900/*
drh2aee5142020-03-21 00:05:53 +00003901** pSelect is a SELECT statement and pSrcItem is one item in the FROM
3902** clause of that SELECT.
3903**
3904** This routine scans the entire SELECT statement and recomputes the
3905** pSrcItem->colUsed mask.
3906*/
3907static int recomputeColumnsUsedExpr(Walker *pWalker, Expr *pExpr){
drh76012942021-02-21 21:04:54 +00003908 SrcItem *pItem;
drh2aee5142020-03-21 00:05:53 +00003909 if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
3910 pItem = pWalker->u.pSrcItem;
3911 if( pItem->iCursor!=pExpr->iTable ) return WRC_Continue;
drh74a07982020-03-21 23:10:38 +00003912 if( pExpr->iColumn<0 ) return WRC_Continue;
3913 pItem->colUsed |= sqlite3ExprColUsed(pExpr);
drh2aee5142020-03-21 00:05:53 +00003914 return WRC_Continue;
3915}
3916static void recomputeColumnsUsed(
3917 Select *pSelect, /* The complete SELECT statement */
drh76012942021-02-21 21:04:54 +00003918 SrcItem *pSrcItem /* Which FROM clause item to recompute */
drh2aee5142020-03-21 00:05:53 +00003919){
3920 Walker w;
3921 if( NEVER(pSrcItem->pTab==0) ) return;
3922 memset(&w, 0, sizeof(w));
3923 w.xExprCallback = recomputeColumnsUsedExpr;
3924 w.xSelectCallback = sqlite3SelectWalkNoop;
3925 w.u.pSrcItem = pSrcItem;
3926 pSrcItem->colUsed = 0;
3927 sqlite3WalkSelect(&w, pSelect);
3928}
3929#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3930
3931#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3932/*
dan964fa262020-12-18 16:13:39 +00003933** Assign new cursor numbers to each of the items in pSrc. For each
3934** new cursor number assigned, set an entry in the aCsrMap[] array
3935** to map the old cursor number to the new:
3936**
drhc8d21472021-07-21 15:42:05 +00003937** aCsrMap[iOld+1] = iNew;
dan964fa262020-12-18 16:13:39 +00003938**
3939** The array is guaranteed by the caller to be large enough for all
drhc8d21472021-07-21 15:42:05 +00003940** existing cursor numbers in pSrc. aCsrMap[0] is the array size.
dan964fa262020-12-18 16:13:39 +00003941**
3942** If pSrc contains any sub-selects, call this routine recursively
3943** on the FROM clause of each such sub-select, with iExcept set to -1.
3944*/
3945static void srclistRenumberCursors(
3946 Parse *pParse, /* Parse context */
3947 int *aCsrMap, /* Array to store cursor mappings in */
3948 SrcList *pSrc, /* FROM clause to renumber */
3949 int iExcept /* FROM clause item to skip */
3950){
3951 int i;
drh76012942021-02-21 21:04:54 +00003952 SrcItem *pItem;
dan964fa262020-12-18 16:13:39 +00003953 for(i=0, pItem=pSrc->a; i<pSrc->nSrc; i++, pItem++){
3954 if( i!=iExcept ){
dand131b512020-12-18 18:04:44 +00003955 Select *p;
drhc8d21472021-07-21 15:42:05 +00003956 assert( pItem->iCursor < aCsrMap[0] );
3957 if( !pItem->fg.isRecursive || aCsrMap[pItem->iCursor+1]==0 ){
3958 aCsrMap[pItem->iCursor+1] = pParse->nTab++;
drhc7f50772021-04-26 21:23:01 +00003959 }
drhc8d21472021-07-21 15:42:05 +00003960 pItem->iCursor = aCsrMap[pItem->iCursor+1];
dand131b512020-12-18 18:04:44 +00003961 for(p=pItem->pSelect; p; p=p->pPrior){
3962 srclistRenumberCursors(pParse, aCsrMap, p->pSrc, -1);
dan964fa262020-12-18 16:13:39 +00003963 }
3964 }
3965 }
3966}
3967
3968/*
drhc8d21472021-07-21 15:42:05 +00003969** *piCursor is a cursor number. Change it if it needs to be mapped.
3970*/
3971static void renumberCursorDoMapping(Walker *pWalker, int *piCursor){
3972 int *aCsrMap = pWalker->u.aiCol;
3973 int iCsr = *piCursor;
3974 if( iCsr < aCsrMap[0] && aCsrMap[iCsr+1]>0 ){
3975 *piCursor = aCsrMap[iCsr+1];
3976 }
3977}
3978
3979/*
dan964fa262020-12-18 16:13:39 +00003980** Expression walker callback used by renumberCursors() to update
3981** Expr objects to match newly assigned cursor numbers.
3982*/
3983static int renumberCursorsCb(Walker *pWalker, Expr *pExpr){
dane8f14902021-02-13 14:26:25 +00003984 int op = pExpr->op;
drhc8d21472021-07-21 15:42:05 +00003985 if( op==TK_COLUMN || op==TK_IF_NULL_ROW ){
3986 renumberCursorDoMapping(pWalker, &pExpr->iTable);
dan964fa262020-12-18 16:13:39 +00003987 }
drh67a99db2022-05-13 14:52:04 +00003988 if( ExprHasProperty(pExpr, EP_OuterON) ){
drhd1985262022-04-11 11:25:28 +00003989 renumberCursorDoMapping(pWalker, &pExpr->w.iJoin);
dan961a7262020-12-21 19:50:10 +00003990 }
dan964fa262020-12-18 16:13:39 +00003991 return WRC_Continue;
3992}
3993
3994/*
3995** Assign a new cursor number to each cursor in the FROM clause (Select.pSrc)
3996** of the SELECT statement passed as the second argument, and to each
3997** cursor in the FROM clause of any FROM clause sub-selects, recursively.
3998** Except, do not assign a new cursor number to the iExcept'th element in
3999** the FROM clause of (*p). Update all expressions and other references
4000** to refer to the new cursor numbers.
4001**
4002** Argument aCsrMap is an array that may be used for temporary working
4003** space. Two guarantees are made by the caller:
4004**
4005** * the array is larger than the largest cursor number used within the
4006** select statement passed as an argument, and
4007**
4008** * the array entries for all cursor numbers that do *not* appear in
4009** FROM clauses of the select statement as described above are
4010** initialized to zero.
4011*/
4012static void renumberCursors(
4013 Parse *pParse, /* Parse context */
4014 Select *p, /* Select to renumber cursors within */
4015 int iExcept, /* FROM clause item to skip */
4016 int *aCsrMap /* Working space */
4017){
4018 Walker w;
4019 srclistRenumberCursors(pParse, aCsrMap, p->pSrc, iExcept);
4020 memset(&w, 0, sizeof(w));
4021 w.u.aiCol = aCsrMap;
4022 w.xExprCallback = renumberCursorsCb;
4023 w.xSelectCallback = sqlite3SelectWalkNoop;
4024 sqlite3WalkSelect(&w, p);
4025}
4026#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4027
4028#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4029/*
drh630d2962011-12-11 21:51:04 +00004030** This routine attempts to flatten subqueries as a performance optimization.
4031** This routine returns 1 if it makes changes and 0 if no flattening occurs.
drh1350b032002-02-27 19:00:20 +00004032**
4033** To understand the concept of flattening, consider the following
4034** query:
4035**
4036** SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
4037**
4038** The default way of implementing this query is to execute the
4039** subquery first and store the results in a temporary table, then
4040** run the outer query on that temporary table. This requires two
4041** passes over the data. Furthermore, because the temporary table
4042** has no indices, the WHERE clause on the outer query cannot be
drh832508b2002-03-02 17:04:07 +00004043** optimized.
drh1350b032002-02-27 19:00:20 +00004044**
drh832508b2002-03-02 17:04:07 +00004045** This routine attempts to rewrite queries such as the above into
drh1350b032002-02-27 19:00:20 +00004046** a single flat select, like this:
4047**
4048** SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
4049**
peter.d.reid60ec9142014-09-06 16:39:46 +00004050** The code generated for this simplification gives the same result
drh832508b2002-03-02 17:04:07 +00004051** but only has to scan the data once. And because indices might
4052** exist on the table t1, a complete scan of the data might be
4053** avoided.
drh1350b032002-02-27 19:00:20 +00004054**
drhd981e822017-09-29 16:07:56 +00004055** Flattening is subject to the following constraints:
drh1350b032002-02-27 19:00:20 +00004056**
drh25c221e2017-09-29 22:13:24 +00004057** (**) We no longer attempt to flatten aggregate subqueries. Was:
4058** The subquery and the outer query cannot both be aggregates.
drh1350b032002-02-27 19:00:20 +00004059**
drh25c221e2017-09-29 22:13:24 +00004060** (**) We no longer attempt to flatten aggregate subqueries. Was:
4061** (2) If the subquery is an aggregate then
drhd981e822017-09-29 16:07:56 +00004062** (2a) the outer query must not be a join and
4063** (2b) the outer query must not use subqueries
4064** other than the one FROM-clause subquery that is a candidate
4065** for flattening. (This is due to ticket [2f7170d73bf9abf80]
4066** from 2015-02-09.)
drh832508b2002-03-02 17:04:07 +00004067**
drhd981e822017-09-29 16:07:56 +00004068** (3) If the subquery is the right operand of a LEFT JOIN then
4069** (3a) the subquery may not be a join and
4070** (3b) the FROM clause of the subquery may not contain a virtual
4071** table and
drhee373022022-07-25 15:54:23 +00004072** (**) Was: "The outer query may not have a GROUP BY." This case
4073** is now managed correctly
drh396afe62019-12-18 20:51:58 +00004074** (3d) the outer query may not be DISTINCT.
drh41798d52022-04-11 00:21:53 +00004075** See also (26) for restrictions on RIGHT JOIN.
drh832508b2002-03-02 17:04:07 +00004076**
drhd981e822017-09-29 16:07:56 +00004077** (4) The subquery can not be DISTINCT.
drh832508b2002-03-02 17:04:07 +00004078**
dan49ad3302010-08-13 16:38:48 +00004079** (**) At one point restrictions (4) and (5) defined a subset of DISTINCT
4080** sub-queries that were excluded from this optimization. Restriction
4081** (4) has since been expanded to exclude all DISTINCT subqueries.
drh832508b2002-03-02 17:04:07 +00004082**
drh25c221e2017-09-29 22:13:24 +00004083** (**) We no longer attempt to flatten aggregate subqueries. Was:
4084** If the subquery is aggregate, the outer query may not be DISTINCT.
drh832508b2002-03-02 17:04:07 +00004085**
drhd981e822017-09-29 16:07:56 +00004086** (7) The subquery must have a FROM clause. TODO: For subqueries without
drh31d6fd52017-04-14 19:03:10 +00004087** A FROM clause, consider adding a FROM clause with the special
drh630d2962011-12-11 21:51:04 +00004088** table sqlite_once that consists of a single row containing a
4089** single NULL.
drh08192d52002-04-30 19:20:28 +00004090**
drhd981e822017-09-29 16:07:56 +00004091** (8) If the subquery uses LIMIT then the outer query may not be a join.
drhdf199a22002-06-14 22:38:41 +00004092**
drhd981e822017-09-29 16:07:56 +00004093** (9) If the subquery uses LIMIT then the outer query may not be aggregate.
drhdf199a22002-06-14 22:38:41 +00004094**
drh6092d2b2014-09-15 11:14:50 +00004095** (**) Restriction (10) was removed from the code on 2005-02-05 but we
4096** accidently carried the comment forward until 2014-09-15. Original
drhd981e822017-09-29 16:07:56 +00004097** constraint: "If the subquery is aggregate then the outer query
4098** may not use LIMIT."
drhdf199a22002-06-14 22:38:41 +00004099**
drhd981e822017-09-29 16:07:56 +00004100** (11) The subquery and the outer query may not both have ORDER BY clauses.
drh174b6192002-12-03 02:22:52 +00004101**
drh7b688ed2009-12-22 00:29:53 +00004102** (**) Not implemented. Subsumed into restriction (3). Was previously
drh2b300d52008-08-14 00:19:48 +00004103** a separate restriction deriving from ticket #350.
drh3fc673e2003-06-16 00:40:34 +00004104**
drhd981e822017-09-29 16:07:56 +00004105** (13) The subquery and outer query may not both use LIMIT.
drhac839632006-01-21 22:19:54 +00004106**
drhd981e822017-09-29 16:07:56 +00004107** (14) The subquery may not use OFFSET.
drhac839632006-01-21 22:19:54 +00004108**
drhd981e822017-09-29 16:07:56 +00004109** (15) If the outer query is part of a compound select, then the
4110** subquery may not use LIMIT.
drhf3913272010-04-15 23:24:29 +00004111** (See ticket #2339 and ticket [02a8e81d44]).
drhad91c6c2007-05-06 20:04:24 +00004112**
drhd981e822017-09-29 16:07:56 +00004113** (16) If the outer query is aggregate, then the subquery may not
4114** use ORDER BY. (Ticket #2942) This used to not matter
drhc52e3552008-02-15 14:33:03 +00004115** until we introduced the group_concat() function.
4116**
drhd981e822017-09-29 16:07:56 +00004117** (17) If the subquery is a compound select, then
4118** (17a) all compound operators must be a UNION ALL, and
4119** (17b) no terms within the subquery compound may be aggregate
drhe76acc62017-10-04 02:30:45 +00004120** or DISTINCT, and
drhd981e822017-09-29 16:07:56 +00004121** (17c) every term within the subquery compound must have a FROM clause
4122** (17d) the outer query may not be
4123** (17d1) aggregate, or
dan8daf5ae2020-12-17 16:48:04 +00004124** (17d2) DISTINCT
4125** (17e) the subquery may not contain window functions, and
4126** (17f) the subquery must not be the RHS of a LEFT JOIN.
drhb88bf862022-07-13 15:52:15 +00004127** (17g) either the subquery is the first element of the outer
4128** query or there are no RIGHT or FULL JOINs in any arm
4129** of the subquery. (This is a duplicate of condition (27b).)
danielk1977f23329a2008-07-01 14:09:13 +00004130**
danielk19774914cf92008-07-01 18:26:49 +00004131** The parent and sub-query may contain WHERE clauses. Subject to
4132** rules (11), (13) and (14), they may also contain ORDER BY,
drh630d2962011-12-11 21:51:04 +00004133** LIMIT and OFFSET clauses. The subquery cannot use any compound
4134** operator other than UNION ALL because all the other compound
4135** operators have an implied DISTINCT which is disallowed by
4136** restriction (4).
danielk1977f23329a2008-07-01 14:09:13 +00004137**
dan67c70142012-08-28 14:45:50 +00004138** Also, each component of the sub-query must return the same number
4139** of result columns. This is actually a requirement for any compound
4140** SELECT statement, but all the code here does is make sure that no
4141** such (illegal) sub-query is flattened. The caller will detect the
4142** syntax error and return a detailed message.
4143**
danielk197749fc1f62008-07-08 17:43:56 +00004144** (18) If the sub-query is a compound select, then all terms of the
dan9353bea2020-12-17 17:17:12 +00004145** ORDER BY clause of the parent must be copies of a term returned
4146** by the parent query.
danielk197749fc1f62008-07-08 17:43:56 +00004147**
drhd981e822017-09-29 16:07:56 +00004148** (19) If the subquery uses LIMIT then the outer query may not
drh229cf702008-08-26 12:56:14 +00004149** have a WHERE clause.
4150**
drhfca23552017-10-28 20:51:54 +00004151** (20) If the sub-query is a compound select, then it must not use
4152** an ORDER BY clause. Ticket #3773. We could relax this constraint
4153** somewhat by saying that the terms of the ORDER BY clause must
4154** appear as unmodified result columns in the outer query. But we
4155** have other optimizations in mind to deal with that case.
drhe8902a72009-04-02 16:59:47 +00004156**
drhd981e822017-09-29 16:07:56 +00004157** (21) If the subquery uses LIMIT then the outer query may not be
shaneha91491e2011-02-11 20:52:20 +00004158** DISTINCT. (See ticket [752e1646fc]).
4159**
drhd981e822017-09-29 16:07:56 +00004160** (22) The subquery may not be a recursive CTE.
dan8290c2a2014-01-16 10:58:39 +00004161**
dan8daf5ae2020-12-17 16:48:04 +00004162** (23) If the outer query is a recursive CTE, then the sub-query may not be
4163** a compound query. This restriction is because transforming the
dan8290c2a2014-01-16 10:58:39 +00004164** parent to a compound query confuses the code that handles
4165** recursive queries in multiSelect().
4166**
drh508e2d02017-09-30 01:25:04 +00004167** (**) We no longer attempt to flatten aggregate subqueries. Was:
4168** The subquery may not be an aggregate that uses the built-in min() or
drh9588ad92014-09-15 14:46:02 +00004169** or max() functions. (Without this restriction, a query like:
4170** "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
4171** return the value X for which Y was maximal.)
4172**
dan9a947222018-06-14 19:06:36 +00004173** (25) If either the subquery or the parent query contains a window
4174** function in the select list or ORDER BY clause, flattening
4175** is not attempted.
4176**
drh41798d52022-04-11 00:21:53 +00004177** (26) The subquery may not be the right operand of a RIGHT JOIN.
4178** See also (3) for restrictions on LEFT JOIN.
4179**
drh1c2bf412022-04-18 23:20:02 +00004180** (27) The subquery may not contain a FULL or RIGHT JOIN unless it
drhb88bf862022-07-13 15:52:15 +00004181** is the first element of the parent query. This must be the
4182** the case if:
4183** (27a) the subquery is not compound query, and
4184** (27b) the subquery is a compound query and the RIGHT JOIN occurs
4185** in any arm of the compound query. (See also (17g).)
drh1c2bf412022-04-18 23:20:02 +00004186**
drh67f70be2022-04-22 16:15:48 +00004187** (28) The subquery is not a MATERIALIZED CTE.
4188**
drh5c118e32022-06-08 15:30:39 +00004189** (29) Either the subquery is not the right-hand operand of a join with an
4190** ON or USING clause nor the right-hand operand of a NATURAL JOIN, or
4191** the right-most table within the FROM clause of the subquery
4192** is not part of an outer join.
4193**
dan8290c2a2014-01-16 10:58:39 +00004194**
drh832508b2002-03-02 17:04:07 +00004195** In this routine, the "p" parameter is a pointer to the outer query.
4196** The subquery is p->pSrc->a[iFrom]. isAgg is true if the outer query
drh25c221e2017-09-29 22:13:24 +00004197** uses aggregates.
drh832508b2002-03-02 17:04:07 +00004198**
drh665de472003-03-31 13:36:09 +00004199** If flattening is not attempted, this routine is a no-op and returns 0.
drh832508b2002-03-02 17:04:07 +00004200** If flattening is attempted this routine returns 1.
4201**
4202** All of the expression analysis must occur on both the outer query and
4203** the subquery before this routine runs.
drh1350b032002-02-27 19:00:20 +00004204*/
drh8c74a8c2002-08-25 19:20:40 +00004205static int flattenSubquery(
danielk1977524cc212008-07-02 13:13:51 +00004206 Parse *pParse, /* Parsing context */
drh8c74a8c2002-08-25 19:20:40 +00004207 Select *p, /* The parent or outer SELECT statement */
4208 int iFrom, /* Index in p->pSrc->a[] of the inner subquery */
drh25c221e2017-09-29 22:13:24 +00004209 int isAgg /* True if outer SELECT uses aggregate functions */
drh8c74a8c2002-08-25 19:20:40 +00004210){
danielk1977524cc212008-07-02 13:13:51 +00004211 const char *zSavedAuthContext = pParse->zAuthContext;
drhd12b6362015-10-11 19:46:59 +00004212 Select *pParent; /* Current UNION ALL term of the other query */
drh0bb28102002-05-08 11:54:14 +00004213 Select *pSub; /* The inner query or "subquery" */
danielk1977f23329a2008-07-01 14:09:13 +00004214 Select *pSub1; /* Pointer to the rightmost select in sub-query */
drhad3cab52002-05-24 02:04:32 +00004215 SrcList *pSrc; /* The FROM clause of the outer query */
4216 SrcList *pSubSrc; /* The FROM clause of the subquery */
drh6a3ea0e2003-05-02 14:32:12 +00004217 int iParent; /* VDBE cursor number of the pSub result set temp table */
drh399c7e22017-04-14 17:18:45 +00004218 int iNewParent = -1;/* Replacement table for iParent */
drhc133bab2022-04-11 20:15:52 +00004219 int isOuterJoin = 0; /* True if pSub is the right side of a LEFT JOIN */
drh91bb0ee2004-09-01 03:06:34 +00004220 int i; /* Loop counter */
4221 Expr *pWhere; /* The WHERE clause */
drh76012942021-02-21 21:04:54 +00004222 SrcItem *pSubitem; /* The subquery */
danielk1977524cc212008-07-02 13:13:51 +00004223 sqlite3 *db = pParse->db;
drh89636622020-06-07 17:33:18 +00004224 Walker w; /* Walker to persist agginfo data */
dan964fa262020-12-18 16:13:39 +00004225 int *aCsrMap = 0;
drh1350b032002-02-27 19:00:20 +00004226
drh832508b2002-03-02 17:04:07 +00004227 /* Check to see if flattening is permitted. Return 0 if not.
4228 */
drha78c22c2008-11-11 18:28:58 +00004229 assert( p!=0 );
drhd981e822017-09-29 16:07:56 +00004230 assert( p->pPrior==0 );
drh7e5418e2012-09-27 15:05:54 +00004231 if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
drh832508b2002-03-02 17:04:07 +00004232 pSrc = p->pSrc;
drhad3cab52002-05-24 02:04:32 +00004233 assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
drh91bb0ee2004-09-01 03:06:34 +00004234 pSubitem = &pSrc->a[iFrom];
danielk197749fc1f62008-07-08 17:43:56 +00004235 iParent = pSubitem->iCursor;
drh91bb0ee2004-09-01 03:06:34 +00004236 pSub = pSubitem->pSelect;
drh832508b2002-03-02 17:04:07 +00004237 assert( pSub!=0 );
drh399c7e22017-04-14 17:18:45 +00004238
dan67a9b8e2018-06-22 20:51:35 +00004239#ifndef SQLITE_OMIT_WINDOWFUNC
dan9a947222018-06-14 19:06:36 +00004240 if( p->pWin || pSub->pWin ) return 0; /* Restriction (25) */
dan67a9b8e2018-06-22 20:51:35 +00004241#endif
dan86fb6e12018-05-16 20:58:07 +00004242
drh832508b2002-03-02 17:04:07 +00004243 pSubSrc = pSub->pSrc;
4244 assert( pSubSrc );
drhac839632006-01-21 22:19:54 +00004245 /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
peter.d.reid60ec9142014-09-06 16:39:46 +00004246 ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
drhac839632006-01-21 22:19:54 +00004247 ** because they could be computed at compile-time. But when LIMIT and OFFSET
4248 ** became arbitrary expressions, we were forced to add restrictions (13)
4249 ** and (14). */
4250 if( pSub->pLimit && p->pLimit ) return 0; /* Restriction (13) */
drh8c0833f2017-11-14 23:48:23 +00004251 if( pSub->pLimit && pSub->pLimit->pRight ) return 0; /* Restriction (14) */
drhd227a292014-02-09 18:02:09 +00004252 if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
drhad91c6c2007-05-06 20:04:24 +00004253 return 0; /* Restriction (15) */
4254 }
drhac839632006-01-21 22:19:54 +00004255 if( pSubSrc->nSrc==0 ) return 0; /* Restriction (7) */
drhd981e822017-09-29 16:07:56 +00004256 if( pSub->selFlags & SF_Distinct ) return 0; /* Restriction (4) */
dan49ad3302010-08-13 16:38:48 +00004257 if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
4258 return 0; /* Restrictions (8)(9) */
drhdf199a22002-06-14 22:38:41 +00004259 }
drh7d10d5a2008-08-20 16:35:10 +00004260 if( p->pOrderBy && pSub->pOrderBy ){
drhac839632006-01-21 22:19:54 +00004261 return 0; /* Restriction (11) */
4262 }
drhc52e3552008-02-15 14:33:03 +00004263 if( isAgg && pSub->pOrderBy ) return 0; /* Restriction (16) */
drh229cf702008-08-26 12:56:14 +00004264 if( pSub->pLimit && p->pWhere ) return 0; /* Restriction (19) */
shaneha91491e2011-02-11 20:52:20 +00004265 if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
4266 return 0; /* Restriction (21) */
4267 }
drh508e2d02017-09-30 01:25:04 +00004268 if( pSub->selFlags & (SF_Recursive) ){
4269 return 0; /* Restrictions (22) */
drh9588ad92014-09-15 14:46:02 +00004270 }
drh832508b2002-03-02 17:04:07 +00004271
drh399c7e22017-04-14 17:18:45 +00004272 /*
4273 ** If the subquery is the right operand of a LEFT JOIN, then the
drhd981e822017-09-29 16:07:56 +00004274 ** subquery may not be a join itself (3a). Example of why this is not
4275 ** allowed:
drh8af4d3a2003-05-06 20:35:16 +00004276 **
4277 ** t1 LEFT OUTER JOIN (t2 JOIN t3)
4278 **
4279 ** If we flatten the above, we would get
4280 **
4281 ** (t1 LEFT OUTER JOIN t2) JOIN t3
4282 **
4283 ** which is not at all the same thing.
drh2b300d52008-08-14 00:19:48 +00004284 **
drh31d6fd52017-04-14 19:03:10 +00004285 ** See also tickets #306, #350, and #3300.
drh3fc673e2003-06-16 00:40:34 +00004286 */
drhc133bab2022-04-11 20:15:52 +00004287 if( (pSubitem->fg.jointype & (JT_OUTER|JT_LTORJ))!=0 ){
drh41798d52022-04-11 00:21:53 +00004288 if( pSubSrc->nSrc>1 /* (3a) */
drh9efc6182022-06-23 12:36:56 +00004289 || IsVirtual(pSubSrc->a[0].pTab) /* (3b) */
drh41798d52022-04-11 00:21:53 +00004290 || (p->selFlags & SF_Distinct)!=0 /* (3d) */
4291 || (pSubitem->fg.jointype & JT_RIGHT)!=0 /* (26) */
drh396afe62019-12-18 20:51:58 +00004292 ){
drhd981e822017-09-29 16:07:56 +00004293 return 0;
drh399c7e22017-04-14 17:18:45 +00004294 }
drhc133bab2022-04-11 20:15:52 +00004295 isOuterJoin = 1;
drh3fc673e2003-06-16 00:40:34 +00004296 }
drhdc6de472017-05-25 11:39:50 +00004297#ifdef SQLITE_EXTRA_IFNULLROW
4298 else if( iFrom>0 && !isAgg ){
drhc133bab2022-04-11 20:15:52 +00004299 /* Setting isOuterJoin to -1 causes OP_IfNullRow opcodes to be generated for
drh3d240d22017-09-28 16:56:55 +00004300 ** every reference to any result column from subquery in a join, even
4301 ** though they are not necessary. This will stress-test the OP_IfNullRow
4302 ** opcode. */
drhc133bab2022-04-11 20:15:52 +00004303 isOuterJoin = -1;
drhdc6de472017-05-25 11:39:50 +00004304 }
4305#endif
drh3fc673e2003-06-16 00:40:34 +00004306
drh1c2bf412022-04-18 23:20:02 +00004307 assert( pSubSrc->nSrc>0 ); /* True by restriction (7) */
4308 if( iFrom>0 && (pSubSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
drhb88bf862022-07-13 15:52:15 +00004309 return 0; /* Restriction (27a) */
drh1c2bf412022-04-18 23:20:02 +00004310 }
drh67f70be2022-04-22 16:15:48 +00004311 if( pSubitem->fg.isCte && pSubitem->u2.pCteUse->eM10d==M10d_Yes ){
4312 return 0; /* (28) */
4313 }
drh1c2bf412022-04-18 23:20:02 +00004314
drh8a5469b2022-06-08 17:48:14 +00004315 /* Restriction (29):
4316 **
4317 ** We do not want two constraints on the same term of the flattened
4318 ** query where one constraint has EP_InnerON and the other is EP_OuterON.
4319 ** To prevent this, one or the other of the following conditions must be
4320 ** false:
4321 **
4322 ** (29a) The right-most entry in the FROM clause of the subquery
4323 ** must not be part of an outer join.
4324 **
4325 ** (29b) The subquery itself must not be the right operand of a
4326 ** NATURAL join or a join that as an ON or USING clause.
4327 **
4328 ** These conditions are sufficient to keep an EP_OuterON from being
drhb88bf862022-07-13 15:52:15 +00004329 ** flattened into an EP_InnerON. Restrictions (3a) and (27a) prevent
drh8a5469b2022-06-08 17:48:14 +00004330 ** an EP_InnerON from being flattened into an EP_OuterON.
4331 */
drh5c118e32022-06-08 15:30:39 +00004332 if( pSubSrc->nSrc>=2
4333 && (pSubSrc->a[pSubSrc->nSrc-1].fg.jointype & JT_OUTER)!=0
4334 ){
drh8a5469b2022-06-08 17:48:14 +00004335 if( (pSubitem->fg.jointype & JT_NATURAL)!=0
drh5c118e32022-06-08 15:30:39 +00004336 || pSubitem->fg.isUsing
drh8a5469b2022-06-08 17:48:14 +00004337 || NEVER(pSubitem->u3.pOn!=0) /* ON clause already shifted into WHERE */
drh5c118e32022-06-08 15:30:39 +00004338 || pSubitem->fg.isOn
4339 ){
4340 return 0;
4341 }
4342 }
4343
drhd981e822017-09-29 16:07:56 +00004344 /* Restriction (17): If the sub-query is a compound SELECT, then it must
danielk1977f23329a2008-07-01 14:09:13 +00004345 ** use only the UNION ALL operator. And none of the simple select queries
4346 ** that make up the compound SELECT are allowed to be aggregate or distinct
4347 ** queries.
4348 */
4349 if( pSub->pPrior ){
drhfca23552017-10-28 20:51:54 +00004350 if( pSub->pOrderBy ){
4351 return 0; /* Restriction (20) */
4352 }
drhc133bab2022-04-11 20:15:52 +00004353 if( isAgg || (p->selFlags & SF_Distinct)!=0 || isOuterJoin>0 ){
dan8daf5ae2020-12-17 16:48:04 +00004354 return 0; /* (17d1), (17d2), or (17f) */
danielk1977f23329a2008-07-01 14:09:13 +00004355 }
4356 for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
drhccfcbce2009-05-18 15:46:07 +00004357 testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
4358 testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
drh4b3ac732011-12-10 23:18:32 +00004359 assert( pSub->pSrc!=0 );
dan8daf5ae2020-12-17 16:48:04 +00004360 assert( (pSub->selFlags & SF_Recursive)==0 );
drh2ec18a32015-06-23 23:31:52 +00004361 assert( pSub->pEList->nExpr==pSub1->pEList->nExpr );
drhd981e822017-09-29 16:07:56 +00004362 if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0 /* (17b) */
4363 || (pSub1->pPrior && pSub1->op!=TK_ALL) /* (17a) */
4364 || pSub1->pSrc->nSrc<1 /* (17c) */
drhef9f7192020-01-17 19:14:08 +00004365#ifndef SQLITE_OMIT_WINDOWFUNC
drh8d95ed72019-12-30 20:42:17 +00004366 || pSub1->pWin /* (17e) */
drhef9f7192020-01-17 19:14:08 +00004367#endif
danielk197780b3c542008-07-10 17:59:12 +00004368 ){
danielk1977f23329a2008-07-01 14:09:13 +00004369 return 0;
4370 }
drhb88bf862022-07-13 15:52:15 +00004371 if( iFrom>0 && (pSub1->pSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
4372 /* Without this restriction, the JT_LTORJ flag would end up being
4373 ** omitted on left-hand tables of the right join that is being
4374 ** flattened. */
4375 return 0; /* Restrictions (17g), (27b) */
4376 }
drh4b3ac732011-12-10 23:18:32 +00004377 testcase( pSub1->pSrc->nSrc>1 );
danielk1977f23329a2008-07-01 14:09:13 +00004378 }
danielk197749fc1f62008-07-08 17:43:56 +00004379
drhd981e822017-09-29 16:07:56 +00004380 /* Restriction (18). */
danielk197749fc1f62008-07-08 17:43:56 +00004381 if( p->pOrderBy ){
4382 int ii;
4383 for(ii=0; ii<p->pOrderBy->nExpr; ii++){
drhc2acc4e2013-11-15 18:15:19 +00004384 if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
danielk197749fc1f62008-07-08 17:43:56 +00004385 }
4386 }
danielk1977f23329a2008-07-01 14:09:13 +00004387
dande9ed622020-12-16 20:00:46 +00004388 /* Restriction (23) */
4389 if( (p->selFlags & SF_Recursive) ) return 0;
dan964fa262020-12-18 16:13:39 +00004390
4391 if( pSrc->nSrc>1 ){
dan51ddfef2021-03-17 14:29:37 +00004392 if( pParse->nSelect>500 ) return 0;
drh95fe38f2022-04-25 14:59:59 +00004393 if( OptimizationDisabled(db, SQLITE_FlttnUnionAll) ) return 0;
drh913306a2021-11-26 17:10:18 +00004394 aCsrMap = sqlite3DbMallocZero(db, ((i64)pParse->nTab+1)*sizeof(int));
drhc8d21472021-07-21 15:42:05 +00004395 if( aCsrMap ) aCsrMap[0] = pParse->nTab;
dan964fa262020-12-18 16:13:39 +00004396 }
dande9ed622020-12-16 20:00:46 +00004397 }
drhcdb2f602017-10-04 05:59:54 +00004398
drh7d10d5a2008-08-20 16:35:10 +00004399 /***** If we reach this point, flattening is permitted. *****/
drhfef37762018-07-10 19:48:35 +00004400 SELECTTRACE(1,pParse,p,("flatten %u.%p from term %d\n",
4401 pSub->selId, pSub, iFrom));
drh7d10d5a2008-08-20 16:35:10 +00004402
4403 /* Authorize the subquery */
danielk1977524cc212008-07-02 13:13:51 +00004404 pParse->zAuthContext = pSubitem->zName;
drha2acb0d2012-04-11 23:22:37 +00004405 TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
4406 testcase( i==SQLITE_DENY );
danielk1977524cc212008-07-02 13:13:51 +00004407 pParse->zAuthContext = zSavedAuthContext;
4408
dande9ed622020-12-16 20:00:46 +00004409 /* Delete the transient structures associated with thesubquery */
4410 pSub1 = pSubitem->pSelect;
4411 sqlite3DbFree(db, pSubitem->zDatabase);
4412 sqlite3DbFree(db, pSubitem->zName);
4413 sqlite3DbFree(db, pSubitem->zAlias);
4414 pSubitem->zDatabase = 0;
4415 pSubitem->zName = 0;
4416 pSubitem->zAlias = 0;
4417 pSubitem->pSelect = 0;
drhd44f8b22022-04-07 01:11:13 +00004418 assert( pSubitem->fg.isUsing!=0 || pSubitem->u3.pOn==0 );
dande9ed622020-12-16 20:00:46 +00004419
drh7d10d5a2008-08-20 16:35:10 +00004420 /* If the sub-query is a compound SELECT statement, then (by restrictions
4421 ** 17 and 18 above) it must be a UNION ALL and the parent query must
4422 ** be of the form:
danielk1977f23329a2008-07-01 14:09:13 +00004423 **
4424 ** SELECT <expr-list> FROM (<sub-query>) <where-clause>
4425 **
4426 ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
drha78c22c2008-11-11 18:28:58 +00004427 ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
danielk1977f23329a2008-07-01 14:09:13 +00004428 ** OFFSET clauses and joins them to the left-hand-side of the original
4429 ** using UNION ALL operators. In this case N is the number of simple
4430 ** select statements in the compound sub-query.
drha78c22c2008-11-11 18:28:58 +00004431 **
4432 ** Example:
4433 **
4434 ** SELECT a+1 FROM (
4435 ** SELECT x FROM tab
4436 ** UNION ALL
4437 ** SELECT y FROM tab
4438 ** UNION ALL
4439 ** SELECT abs(z*2) FROM tab2
4440 ** ) WHERE a!=5 ORDER BY 1
4441 **
4442 ** Transformed into:
4443 **
4444 ** SELECT x+1 FROM tab WHERE x+1!=5
4445 ** UNION ALL
4446 ** SELECT y+1 FROM tab WHERE y+1!=5
4447 ** UNION ALL
4448 ** SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
4449 ** ORDER BY 1
4450 **
4451 ** We call this the "compound-subquery flattening".
danielk1977f23329a2008-07-01 14:09:13 +00004452 */
4453 for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
4454 Select *pNew;
4455 ExprList *pOrderBy = p->pOrderBy;
danielk19774b86ef12008-07-01 14:39:35 +00004456 Expr *pLimit = p->pLimit;
danielk1977f23329a2008-07-01 14:09:13 +00004457 Select *pPrior = p->pPrior;
dande9ed622020-12-16 20:00:46 +00004458 Table *pItemTab = pSubitem->pTab;
4459 pSubitem->pTab = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004460 p->pOrderBy = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004461 p->pPrior = 0;
danielk19774b86ef12008-07-01 14:39:35 +00004462 p->pLimit = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00004463 pNew = sqlite3SelectDup(db, p, 0);
danielk19774b86ef12008-07-01 14:39:35 +00004464 p->pLimit = pLimit;
drha78c22c2008-11-11 18:28:58 +00004465 p->pOrderBy = pOrderBy;
drha78c22c2008-11-11 18:28:58 +00004466 p->op = TK_ALL;
dande9ed622020-12-16 20:00:46 +00004467 pSubitem->pTab = pItemTab;
drha78c22c2008-11-11 18:28:58 +00004468 if( pNew==0 ){
drhd227a292014-02-09 18:02:09 +00004469 p->pPrior = pPrior;
drha78c22c2008-11-11 18:28:58 +00004470 }else{
dan51ddfef2021-03-17 14:29:37 +00004471 pNew->selId = ++pParse->nSelect;
drh9da977f2021-04-20 12:14:12 +00004472 if( aCsrMap && ALWAYS(db->mallocFailed==0) ){
dan964fa262020-12-18 16:13:39 +00004473 renumberCursors(pParse, pNew, iFrom, aCsrMap);
4474 }
drha78c22c2008-11-11 18:28:58 +00004475 pNew->pPrior = pPrior;
drhd227a292014-02-09 18:02:09 +00004476 if( pPrior ) pPrior->pNext = pNew;
4477 pNew->pNext = p;
4478 p->pPrior = pNew;
drhe2243d22018-04-23 17:18:03 +00004479 SELECTTRACE(2,pParse,p,("compound-subquery flattener"
drhfef37762018-07-10 19:48:35 +00004480 " creates %u as peer\n",pNew->selId));
drha78c22c2008-11-11 18:28:58 +00004481 }
dande9ed622020-12-16 20:00:46 +00004482 assert( pSubitem->pSelect==0 );
dan964fa262020-12-18 16:13:39 +00004483 }
4484 sqlite3DbFree(db, aCsrMap);
4485 if( db->mallocFailed ){
4486 pSubitem->pSelect = pSub1;
4487 return 1;
danielk1977f23329a2008-07-01 14:09:13 +00004488 }
4489
drha78c22c2008-11-11 18:28:58 +00004490 /* Defer deleting the Table object associated with the
4491 ** subquery until code generation is
4492 ** complete, since there may still exist Expr.pTab entries that
4493 ** refer to the subquery even after flattening. Ticket #3346.
drhccfcbce2009-05-18 15:46:07 +00004494 **
4495 ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
drha78c22c2008-11-11 18:28:58 +00004496 */
drhccfcbce2009-05-18 15:46:07 +00004497 if( ALWAYS(pSubitem->pTab!=0) ){
drha78c22c2008-11-11 18:28:58 +00004498 Table *pTabToDel = pSubitem->pTab;
drh79df7782016-12-14 14:07:35 +00004499 if( pTabToDel->nTabRef==1 ){
dan65a7cd12009-09-01 12:16:01 +00004500 Parse *pToplevel = sqlite3ParseToplevel(pParse);
drhcf3c0782021-01-11 20:37:02 +00004501 sqlite3ParserAddCleanup(pToplevel,
4502 (void(*)(sqlite3*,void*))sqlite3DeleteTable,
4503 pTabToDel);
drh21d4f5b2021-01-12 15:30:01 +00004504 testcase( pToplevel->earlyCleanup );
drha78c22c2008-11-11 18:28:58 +00004505 }else{
drh79df7782016-12-14 14:07:35 +00004506 pTabToDel->nTabRef--;
drha78c22c2008-11-11 18:28:58 +00004507 }
4508 pSubitem->pTab = 0;
4509 }
4510
4511 /* The following loop runs once for each term in a compound-subquery
4512 ** flattening (as described above). If we are doing a different kind
4513 ** of flattening - a flattening other than a compound-subquery flattening -
4514 ** then this loop only runs once.
4515 **
4516 ** This loop moves all of the FROM elements of the subquery into the
4517 ** the FROM clause of the outer query. Before doing this, remember
4518 ** the cursor number for the original outer query FROM element in
4519 ** iParent. The iParent cursor will never be used. Subsequent code
4520 ** will scan expressions looking for iParent references and replace
4521 ** those references with expressions that resolve to the subquery FROM
4522 ** elements we are now copying in.
4523 */
dande9ed622020-12-16 20:00:46 +00004524 pSub = pSub1;
danielk1977f23329a2008-07-01 14:09:13 +00004525 for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
drha78c22c2008-11-11 18:28:58 +00004526 int nSubSrc;
drhea678832008-12-10 19:26:22 +00004527 u8 jointype = 0;
drh79d26582022-04-11 10:38:28 +00004528 u8 ltorj = pSrc->a[iFrom].fg.jointype & JT_LTORJ;
drh55f66b32019-07-16 19:44:32 +00004529 assert( pSub!=0 );
drha78c22c2008-11-11 18:28:58 +00004530 pSubSrc = pSub->pSrc; /* FROM clause of subquery */
4531 nSubSrc = pSubSrc->nSrc; /* Number of terms in subquery FROM clause */
4532 pSrc = pParent->pSrc; /* FROM clause of the outer query */
drhc31c2eb2003-05-02 16:04:17 +00004533
dande9ed622020-12-16 20:00:46 +00004534 if( pParent==p ){
4535 jointype = pSubitem->fg.jointype; /* First time through the loop */
drha78c22c2008-11-11 18:28:58 +00004536 }
dande9ed622020-12-16 20:00:46 +00004537
drha78c22c2008-11-11 18:28:58 +00004538 /* The subquery uses a single slot of the FROM clause of the outer
4539 ** query. If the subquery has more than one element in its FROM clause,
4540 ** then expand the outer query to make space for it to hold all elements
4541 ** of the subquery.
4542 **
4543 ** Example:
4544 **
4545 ** SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
4546 **
4547 ** The outer query has 3 slots in its FROM clause. One slot of the
4548 ** outer query (the middle slot) is used by the subquery. The next
drhd12b6362015-10-11 19:46:59 +00004549 ** block of code will expand the outer query FROM clause to 4 slots.
4550 ** The middle slot is expanded to two slots in order to make space
4551 ** for the two elements in the FROM clause of the subquery.
drha78c22c2008-11-11 18:28:58 +00004552 */
4553 if( nSubSrc>1 ){
drh29c992c2019-01-17 15:40:41 +00004554 pSrc = sqlite3SrcListEnlarge(pParse, pSrc, nSubSrc-1,iFrom+1);
4555 if( pSrc==0 ) break;
4556 pParent->pSrc = pSrc;
drhc31c2eb2003-05-02 16:04:17 +00004557 }
drha78c22c2008-11-11 18:28:58 +00004558
4559 /* Transfer the FROM clause terms from the subquery into the
4560 ** outer query.
4561 */
drhc31c2eb2003-05-02 16:04:17 +00004562 for(i=0; i<nSubSrc; i++){
drhd44f8b22022-04-07 01:11:13 +00004563 SrcItem *pItem = &pSrc->a[i+iFrom];
4564 if( pItem->fg.isUsing ) sqlite3IdListDelete(db, pItem->u3.pUsing);
4565 assert( pItem->fg.isTabFunc==0 );
4566 *pItem = pSubSrc->a[i];
drh79d26582022-04-11 10:38:28 +00004567 pItem->fg.jointype |= ltorj;
drh399c7e22017-04-14 17:18:45 +00004568 iNewParent = pSubSrc->a[i].iCursor;
drhc31c2eb2003-05-02 16:04:17 +00004569 memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
4570 }
drhf7309bc2022-04-12 20:20:54 +00004571 pSrc->a[iFrom].fg.jointype &= JT_LTORJ;
4572 pSrc->a[iFrom].fg.jointype |= jointype | ltorj;
danielk1977f23329a2008-07-01 14:09:13 +00004573
4574 /* Now begin substituting subquery result set expressions for
4575 ** references to the iParent in the outer query.
4576 **
4577 ** Example:
4578 **
4579 ** SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
4580 ** \ \_____________ subquery __________/ /
4581 ** \_____________________ outer query ______________________________/
4582 **
4583 ** We look at every expression in the outer query and every place we see
4584 ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
4585 */
drhb7cbf5c2020-06-15 13:51:34 +00004586 if( pSub->pOrderBy && (pParent->selFlags & SF_NoopOrderBy)==0 ){
dan7c0a4722014-09-20 20:38:48 +00004587 /* At this point, any non-zero iOrderByCol values indicate that the
4588 ** ORDER BY column expression is identical to the iOrderByCol'th
4589 ** expression returned by SELECT statement pSub. Since these values
4590 ** do not necessarily correspond to columns in SELECT statement pParent,
4591 ** zero them before transfering the ORDER BY clause.
4592 **
4593 ** Not doing this may cause an error if a subsequent call to this
4594 ** function attempts to flatten a compound sub-query into pParent
4595 ** (the only way this can happen is if the compound sub-query is
4596 ** currently part of pSub->pSrc). See ticket [d11a6e908f]. */
4597 ExprList *pOrderBy = pSub->pOrderBy;
4598 for(i=0; i<pOrderBy->nExpr; i++){
4599 pOrderBy->a[i].u.x.iOrderByCol = 0;
4600 }
danielk1977f23329a2008-07-01 14:09:13 +00004601 assert( pParent->pOrderBy==0 );
dan7c0a4722014-09-20 20:38:48 +00004602 pParent->pOrderBy = pOrderBy;
danielk1977f23329a2008-07-01 14:09:13 +00004603 pSub->pOrderBy = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004604 }
drh11df7d22018-12-06 19:15:36 +00004605 pWhere = pSub->pWhere;
4606 pSub->pWhere = 0;
drhc133bab2022-04-11 20:15:52 +00004607 if( isOuterJoin>0 ){
drh67a99db2022-05-13 14:52:04 +00004608 sqlite3SetJoinExpr(pWhere, iNewParent, EP_OuterON);
drh399c7e22017-04-14 17:18:45 +00004609 }
dancd653a32020-06-13 21:24:40 +00004610 if( pWhere ){
4611 if( pParent->pWhere ){
4612 pParent->pWhere = sqlite3PExpr(pParse, TK_AND, pWhere, pParent->pWhere);
4613 }else{
4614 pParent->pWhere = pWhere;
4615 }
4616 }
danc3becdd2017-03-13 14:30:40 +00004617 if( db->mallocFailed==0 ){
drh46967de2017-04-14 12:39:37 +00004618 SubstContext x;
4619 x.pParse = pParse;
4620 x.iTable = iParent;
drh399c7e22017-04-14 17:18:45 +00004621 x.iNewTable = iNewParent;
drhc133bab2022-04-11 20:15:52 +00004622 x.isOuterJoin = isOuterJoin;
drh46967de2017-04-14 12:39:37 +00004623 x.pEList = pSub->pEList;
4624 substSelect(&x, pParent, 0);
danc3becdd2017-03-13 14:30:40 +00004625 }
danielk1977f23329a2008-07-01 14:09:13 +00004626
drh7cd5e852019-05-29 17:22:38 +00004627 /* The flattened query is a compound if either the inner or the
4628 ** outer query is a compound. */
4629 pParent->selFlags |= pSub->selFlags & SF_Compound;
4630 assert( (pSub->selFlags & SF_Distinct)==0 ); /* restriction (17b) */
danielk1977f23329a2008-07-01 14:09:13 +00004631
4632 /*
4633 ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
4634 **
4635 ** One is tempted to try to add a and b to combine the limits. But this
4636 ** does not work if either limit is negative.
4637 */
4638 if( pSub->pLimit ){
4639 pParent->pLimit = pSub->pLimit;
4640 pSub->pLimit = 0;
4641 }
drh2aee5142020-03-21 00:05:53 +00004642
4643 /* Recompute the SrcList_item.colUsed masks for the flattened
4644 ** tables. */
4645 for(i=0; i<nSubSrc; i++){
4646 recomputeColumnsUsed(pParent, &pSrc->a[i+iFrom]);
4647 }
drhdf199a22002-06-14 22:38:41 +00004648 }
drh8c74a8c2002-08-25 19:20:40 +00004649
drhc31c2eb2003-05-02 16:04:17 +00004650 /* Finially, delete what is left of the subquery and return
4651 ** success.
4652 */
drh89636622020-06-07 17:33:18 +00004653 sqlite3AggInfoPersistWalkerInit(&w, pParse);
4654 sqlite3WalkSelect(&w,pSub1);
drh633e6d52008-07-28 19:34:53 +00004655 sqlite3SelectDelete(db, pSub1);
danielk1977f23329a2008-07-01 14:09:13 +00004656
drh5e431be2022-04-06 11:08:38 +00004657#if TREETRACE_ENABLED
4658 if( sqlite3TreeTrace & 0x100 ){
drhbc8edba2015-06-05 20:27:26 +00004659 SELECTTRACE(0x100,pParse,p,("After flattening:\n"));
drhc90713d2014-09-30 13:46:49 +00004660 sqlite3TreeViewSelect(0, p, 0);
4661 }
4662#endif
4663
drh832508b2002-03-02 17:04:07 +00004664 return 1;
4665}
shane3514b6f2008-07-22 05:00:55 +00004666#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
drh1350b032002-02-27 19:00:20 +00004667
drh660ee552018-07-26 21:16:53 +00004668/*
drh8e5bfed2018-10-25 14:15:37 +00004669** A structure to keep track of all of the column values that are fixed to
drhefad2e22018-07-27 16:57:11 +00004670** a known value due to WHERE clause constraints of the form COLUMN=VALUE.
drh660ee552018-07-26 21:16:53 +00004671*/
4672typedef struct WhereConst WhereConst;
4673struct WhereConst {
drhefad2e22018-07-27 16:57:11 +00004674 Parse *pParse; /* Parsing context */
drh75016052021-06-10 14:36:23 +00004675 u8 *pOomFault; /* Pointer to pParse->db->mallocFailed */
drh660ee552018-07-26 21:16:53 +00004676 int nConst; /* Number for COLUMN=CONSTANT terms */
4677 int nChng; /* Number of times a constant is propagated */
dan40b82f92021-05-26 18:51:57 +00004678 int bHasAffBlob; /* At least one column in apExpr[] as affinity BLOB */
drhae8776e2022-06-20 12:42:28 +00004679 u32 mExcludeOn; /* Which ON expressions to exclude from considertion.
4680 ** Either EP_OuterON or EP_InnerON|EP_OuterON */
drhefad2e22018-07-27 16:57:11 +00004681 Expr **apExpr; /* [i*2] is COLUMN and [i*2+1] is VALUE */
drh660ee552018-07-26 21:16:53 +00004682};
drh69b72d52015-06-01 20:28:03 +00004683
drh660ee552018-07-26 21:16:53 +00004684/*
drh8e5bfed2018-10-25 14:15:37 +00004685** Add a new entry to the pConst object. Except, do not add duplicate
drhf8f76d62020-01-08 04:36:01 +00004686** pColumn entires. Also, do not add if doing so would not be appropriate.
4687**
4688** The caller guarantees the pColumn is a column and pValue is a constant.
4689** This routine has to do some additional checks before completing the
4690** insert.
drh660ee552018-07-26 21:16:53 +00004691*/
4692static void constInsert(
drhf8f76d62020-01-08 04:36:01 +00004693 WhereConst *pConst, /* The WhereConst into which we are inserting */
4694 Expr *pColumn, /* The COLUMN part of the constraint */
4695 Expr *pValue, /* The VALUE part of the constraint */
4696 Expr *pExpr /* Overall expression: COLUMN=VALUE or VALUE=COLUMN */
drh660ee552018-07-26 21:16:53 +00004697){
drh8e5bfed2018-10-25 14:15:37 +00004698 int i;
4699 assert( pColumn->op==TK_COLUMN );
drhf8f76d62020-01-08 04:36:01 +00004700 assert( sqlite3ExprIsConstant(pValue) );
4701
drhfdfd45a2020-02-13 22:12:35 +00004702 if( ExprHasProperty(pColumn, EP_FixedCol) ) return;
4703 if( sqlite3ExprAffinity(pValue)!=0 ) return;
drhf8f76d62020-01-08 04:36:01 +00004704 if( !sqlite3IsBinary(sqlite3ExprCompareCollSeq(pConst->pParse,pExpr)) ){
4705 return;
4706 }
drh8e5bfed2018-10-25 14:15:37 +00004707
4708 /* 2018-10-25 ticket [cf5ed20f]
4709 ** Make sure the same pColumn is not inserted more than once */
4710 for(i=0; i<pConst->nConst; i++){
drh7be5e3d2020-01-09 20:33:13 +00004711 const Expr *pE2 = pConst->apExpr[i*2];
4712 assert( pE2->op==TK_COLUMN );
4713 if( pE2->iTable==pColumn->iTable
4714 && pE2->iColumn==pColumn->iColumn
drh8e5bfed2018-10-25 14:15:37 +00004715 ){
4716 return; /* Already present. Return without doing anything. */
4717 }
4718 }
dan40b82f92021-05-26 18:51:57 +00004719 if( sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4720 pConst->bHasAffBlob = 1;
4721 }
drh9cbf4f32018-07-27 20:01:00 +00004722
drh660ee552018-07-26 21:16:53 +00004723 pConst->nConst++;
drhefad2e22018-07-27 16:57:11 +00004724 pConst->apExpr = sqlite3DbReallocOrFree(pConst->pParse->db, pConst->apExpr,
drh660ee552018-07-26 21:16:53 +00004725 pConst->nConst*2*sizeof(Expr*));
4726 if( pConst->apExpr==0 ){
4727 pConst->nConst = 0;
4728 }else{
4729 pConst->apExpr[pConst->nConst*2-2] = pColumn;
4730 pConst->apExpr[pConst->nConst*2-1] = pValue;
4731 }
4732}
4733
4734/*
drhefad2e22018-07-27 16:57:11 +00004735** Find all terms of COLUMN=VALUE or VALUE=COLUMN in pExpr where VALUE
4736** is a constant expression and where the term must be true because it
4737** is part of the AND-connected terms of the expression. For each term
4738** found, add it to the pConst structure.
drh660ee552018-07-26 21:16:53 +00004739*/
4740static void findConstInWhere(WhereConst *pConst, Expr *pExpr){
drhefad2e22018-07-27 16:57:11 +00004741 Expr *pRight, *pLeft;
drhb775c972021-05-14 14:26:57 +00004742 if( NEVER(pExpr==0) ) return;
drhae8776e2022-06-20 12:42:28 +00004743 if( ExprHasProperty(pExpr, pConst->mExcludeOn) ){
drh958fcd42022-06-10 11:28:52 +00004744 testcase( ExprHasProperty(pExpr, EP_OuterON) );
4745 testcase( ExprHasProperty(pExpr, EP_InnerON) );
4746 return;
4747 }
drh660ee552018-07-26 21:16:53 +00004748 if( pExpr->op==TK_AND ){
4749 findConstInWhere(pConst, pExpr->pRight);
4750 findConstInWhere(pConst, pExpr->pLeft);
4751 return;
4752 }
4753 if( pExpr->op!=TK_EQ ) return;
drhefad2e22018-07-27 16:57:11 +00004754 pRight = pExpr->pRight;
4755 pLeft = pExpr->pLeft;
4756 assert( pRight!=0 );
4757 assert( pLeft!=0 );
drhf8f76d62020-01-08 04:36:01 +00004758 if( pRight->op==TK_COLUMN && sqlite3ExprIsConstant(pLeft) ){
4759 constInsert(pConst,pRight,pLeft,pExpr);
4760 }
4761 if( pLeft->op==TK_COLUMN && sqlite3ExprIsConstant(pRight) ){
4762 constInsert(pConst,pLeft,pRight,pExpr);
drh660ee552018-07-26 21:16:53 +00004763 }
4764}
4765
4766/*
dan40b82f92021-05-26 18:51:57 +00004767** This is a helper function for Walker callback propagateConstantExprRewrite().
4768**
4769** Argument pExpr is a candidate expression to be replaced by a value. If
4770** pExpr is equivalent to one of the columns named in pWalker->u.pConst,
4771** then overwrite it with the corresponding value. Except, do not do so
4772** if argument bIgnoreAffBlob is non-zero and the affinity of pExpr
4773** is SQLITE_AFF_BLOB.
drh660ee552018-07-26 21:16:53 +00004774*/
dan40b82f92021-05-26 18:51:57 +00004775static int propagateConstantExprRewriteOne(
4776 WhereConst *pConst,
4777 Expr *pExpr,
4778 int bIgnoreAffBlob
4779){
drh660ee552018-07-26 21:16:53 +00004780 int i;
drh75016052021-06-10 14:36:23 +00004781 if( pConst->pOomFault[0] ) return WRC_Prune;
drh660ee552018-07-26 21:16:53 +00004782 if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
drhae8776e2022-06-20 12:42:28 +00004783 if( ExprHasProperty(pExpr, EP_FixedCol|pConst->mExcludeOn) ){
drhbe0330e2020-01-16 17:53:24 +00004784 testcase( ExprHasProperty(pExpr, EP_FixedCol) );
drh67a99db2022-05-13 14:52:04 +00004785 testcase( ExprHasProperty(pExpr, EP_OuterON) );
drhae8776e2022-06-20 12:42:28 +00004786 testcase( ExprHasProperty(pExpr, EP_InnerON) );
drhbe0330e2020-01-16 17:53:24 +00004787 return WRC_Continue;
4788 }
drh660ee552018-07-26 21:16:53 +00004789 for(i=0; i<pConst->nConst; i++){
4790 Expr *pColumn = pConst->apExpr[i*2];
4791 if( pColumn==pExpr ) continue;
4792 if( pColumn->iTable!=pExpr->iTable ) continue;
4793 if( pColumn->iColumn!=pExpr->iColumn ) continue;
dan40b82f92021-05-26 18:51:57 +00004794 if( bIgnoreAffBlob && sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4795 break;
4796 }
drhefad2e22018-07-27 16:57:11 +00004797 /* A match is found. Add the EP_FixedCol property */
drh660ee552018-07-26 21:16:53 +00004798 pConst->nChng++;
4799 ExprClearProperty(pExpr, EP_Leaf);
drhefad2e22018-07-27 16:57:11 +00004800 ExprSetProperty(pExpr, EP_FixedCol);
4801 assert( pExpr->pLeft==0 );
4802 pExpr->pLeft = sqlite3ExprDup(pConst->pParse->db, pConst->apExpr[i*2+1], 0);
drh75016052021-06-10 14:36:23 +00004803 if( pConst->pParse->db->mallocFailed ) return WRC_Prune;
drh660ee552018-07-26 21:16:53 +00004804 break;
4805 }
4806 return WRC_Prune;
4807}
4808
4809/*
dan40b82f92021-05-26 18:51:57 +00004810** This is a Walker expression callback. pExpr is a node from the WHERE
4811** clause of a SELECT statement. This function examines pExpr to see if
4812** any substitutions based on the contents of pWalker->u.pConst should
4813** be made to pExpr or its immediate children.
4814**
4815** A substitution is made if:
4816**
4817** + pExpr is a column with an affinity other than BLOB that matches
4818** one of the columns in pWalker->u.pConst, or
4819**
4820** + pExpr is a binary comparison operator (=, <=, >=, <, >) that
4821** uses an affinity other than TEXT and one of its immediate
4822** children is a column that matches one of the columns in
4823** pWalker->u.pConst.
4824*/
4825static int propagateConstantExprRewrite(Walker *pWalker, Expr *pExpr){
4826 WhereConst *pConst = pWalker->u.pConst;
drha8ed5152021-05-26 19:52:21 +00004827 assert( TK_GT==TK_EQ+1 );
4828 assert( TK_LE==TK_EQ+2 );
4829 assert( TK_LT==TK_EQ+3 );
4830 assert( TK_GE==TK_EQ+4 );
dan40b82f92021-05-26 18:51:57 +00004831 if( pConst->bHasAffBlob ){
drha8ed5152021-05-26 19:52:21 +00004832 if( (pExpr->op>=TK_EQ && pExpr->op<=TK_GE)
dan40b82f92021-05-26 18:51:57 +00004833 || pExpr->op==TK_IS
4834 ){
4835 propagateConstantExprRewriteOne(pConst, pExpr->pLeft, 0);
drh75016052021-06-10 14:36:23 +00004836 if( pConst->pOomFault[0] ) return WRC_Prune;
dan40b82f92021-05-26 18:51:57 +00004837 if( sqlite3ExprAffinity(pExpr->pLeft)!=SQLITE_AFF_TEXT ){
4838 propagateConstantExprRewriteOne(pConst, pExpr->pRight, 0);
4839 }
4840 }
4841 }
4842 return propagateConstantExprRewriteOne(pConst, pExpr, pConst->bHasAffBlob);
4843}
4844
4845/*
drh660ee552018-07-26 21:16:53 +00004846** The WHERE-clause constant propagation optimization.
4847**
4848** If the WHERE clause contains terms of the form COLUMN=CONSTANT or
drh97bffe62020-01-08 00:39:37 +00004849** CONSTANT=COLUMN that are top-level AND-connected terms that are not
4850** part of a ON clause from a LEFT JOIN, then throughout the query
4851** replace all other occurrences of COLUMN with CONSTANT.
drh660ee552018-07-26 21:16:53 +00004852**
4853** For example, the query:
4854**
4855** SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=t1.a AND t3.c=t2.b
4856**
4857** Is transformed into
4858**
4859** SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=39 AND t3.c=39
4860**
4861** Return true if any transformations where made and false if not.
drhefad2e22018-07-27 16:57:11 +00004862**
4863** Implementation note: Constant propagation is tricky due to affinity
4864** and collating sequence interactions. Consider this example:
4865**
4866** CREATE TABLE t1(a INT,b TEXT);
4867** INSERT INTO t1 VALUES(123,'0123');
4868** SELECT * FROM t1 WHERE a=123 AND b=a;
4869** SELECT * FROM t1 WHERE a=123 AND b=123;
4870**
4871** The two SELECT statements above should return different answers. b=a
4872** is alway true because the comparison uses numeric affinity, but b=123
4873** is false because it uses text affinity and '0123' is not the same as '123'.
4874** To work around this, the expression tree is not actually changed from
4875** "b=a" to "b=123" but rather the "a" in "b=a" is tagged with EP_FixedCol
4876** and the "123" value is hung off of the pLeft pointer. Code generator
4877** routines know to generate the constant "123" instead of looking up the
4878** column value. Also, to avoid collation problems, this optimization is
4879** only attempted if the "a=123" term uses the default BINARY collation.
drh342cb332021-05-27 14:09:01 +00004880**
4881** 2021-05-25 forum post 6a06202608: Another troublesome case is...
4882**
4883** CREATE TABLE t1(x);
4884** INSERT INTO t1 VALUES(10.0);
4885** SELECT 1 FROM t1 WHERE x=10 AND x LIKE 10;
4886**
4887** The query should return no rows, because the t1.x value is '10.0' not '10'
4888** and '10.0' is not LIKE '10'. But if we are not careful, the first WHERE
4889** term "x=10" will cause the second WHERE term to become "10 LIKE 10",
4890** resulting in a false positive. To avoid this, constant propagation for
4891** columns with BLOB affinity is only allowed if the constant is used with
4892** operators ==, <=, <, >=, >, or IS in a way that will cause the correct
4893** type conversions to occur. See logic associated with the bHasAffBlob flag
4894** for details.
drh660ee552018-07-26 21:16:53 +00004895*/
4896static int propagateConstants(
4897 Parse *pParse, /* The parsing context */
4898 Select *p /* The query in which to propagate constants */
4899){
4900 WhereConst x;
4901 Walker w;
4902 int nChng = 0;
drhefad2e22018-07-27 16:57:11 +00004903 x.pParse = pParse;
drh75016052021-06-10 14:36:23 +00004904 x.pOomFault = &pParse->db->mallocFailed;
drh660ee552018-07-26 21:16:53 +00004905 do{
4906 x.nConst = 0;
4907 x.nChng = 0;
4908 x.apExpr = 0;
dan40b82f92021-05-26 18:51:57 +00004909 x.bHasAffBlob = 0;
drhae8776e2022-06-20 12:42:28 +00004910 if( ALWAYS(p->pSrc!=0)
4911 && p->pSrc->nSrc>0
4912 && (p->pSrc->a[0].fg.jointype & JT_LTORJ)!=0
4913 ){
4914 /* Do not propagate constants on any ON clause if there is a
4915 ** RIGHT JOIN anywhere in the query */
4916 x.mExcludeOn = EP_InnerON | EP_OuterON;
4917 }else{
4918 /* Do not propagate constants through the ON clause of a LEFT JOIN */
4919 x.mExcludeOn = EP_OuterON;
4920 }
drh660ee552018-07-26 21:16:53 +00004921 findConstInWhere(&x, p->pWhere);
4922 if( x.nConst ){
4923 memset(&w, 0, sizeof(w));
4924 w.pParse = pParse;
4925 w.xExprCallback = propagateConstantExprRewrite;
4926 w.xSelectCallback = sqlite3SelectWalkNoop;
4927 w.xSelectCallback2 = 0;
4928 w.walkerDepth = 0;
4929 w.u.pConst = &x;
drhefad2e22018-07-27 16:57:11 +00004930 sqlite3WalkExpr(&w, p->pWhere);
4931 sqlite3DbFree(x.pParse->db, x.apExpr);
drh660ee552018-07-26 21:16:53 +00004932 nChng += x.nChng;
4933 }
4934 }while( x.nChng );
4935 return nChng;
4936}
drh69b72d52015-06-01 20:28:03 +00004937
4938#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
dan903fdd42021-02-22 20:56:13 +00004939# if !defined(SQLITE_OMIT_WINDOWFUNC)
4940/*
4941** This function is called to determine whether or not it is safe to
4942** push WHERE clause expression pExpr down to FROM clause sub-query
4943** pSubq, which contains at least one window function. Return 1
4944** if it is safe and the expression should be pushed down, or 0
4945** otherwise.
4946**
4947** It is only safe to push the expression down if it consists only
4948** of constants and copies of expressions that appear in the PARTITION
4949** BY clause of all window function used by the sub-query. It is safe
4950** to filter out entire partitions, but not rows within partitions, as
4951** this may change the results of the window functions.
4952**
4953** At the time this function is called it is guaranteed that
4954**
4955** * the sub-query uses only one distinct window frame, and
4956** * that the window frame has a PARTITION BY clase.
4957*/
4958static int pushDownWindowCheck(Parse *pParse, Select *pSubq, Expr *pExpr){
4959 assert( pSubq->pWin->pPartition );
4960 assert( (pSubq->selFlags & SF_MultiPart)==0 );
4961 assert( pSubq->pPrior==0 );
4962 return sqlite3ExprIsConstantOrGroupBy(pParse, pExpr, pSubq->pWin->pPartition);
4963}
4964# endif /* SQLITE_OMIT_WINDOWFUNC */
4965#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4966
4967#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh69b72d52015-06-01 20:28:03 +00004968/*
4969** Make copies of relevant WHERE clause terms of the outer query into
4970** the WHERE clause of subquery. Example:
4971**
4972** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1) WHERE x=5 AND y=10;
4973**
4974** Transformed into:
4975**
4976** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1 WHERE a=5 AND c-d=10)
4977** WHERE x=5 AND y=10;
4978**
4979** The hope is that the terms added to the inner query will make it more
4980** efficient.
4981**
4982** Do not attempt this optimization if:
4983**
drh25c221e2017-09-29 22:13:24 +00004984** (1) (** This restriction was removed on 2017-09-29. We used to
4985** disallow this optimization for aggregate subqueries, but now
drh67cc51a2017-09-30 11:47:06 +00004986** it is allowed by putting the extra terms on the HAVING clause.
4987** The added HAVING clause is pointless if the subquery lacks
4988** a GROUP BY clause. But such a HAVING clause is also harmless
4989** so there does not appear to be any reason to add extra logic
4990** to suppress it. **)
drh69b72d52015-06-01 20:28:03 +00004991**
4992** (2) The inner query is the recursive part of a common table expression.
4993**
4994** (3) The inner query has a LIMIT clause (since the changes to the WHERE
dance103732018-06-23 07:59:39 +00004995** clause would change the meaning of the LIMIT).
drh69b72d52015-06-01 20:28:03 +00004996**
drh6a9b9522018-03-27 15:13:43 +00004997** (4) The inner query is the right operand of a LEFT JOIN and the
4998** expression to be pushed down does not come from the ON clause
4999** on that LEFT JOIN.
drh69b72d52015-06-01 20:28:03 +00005000**
drh38978dd2015-08-22 01:32:29 +00005001** (5) The WHERE clause expression originates in the ON or USING clause
drh7fbb1012018-03-21 01:59:46 +00005002** of a LEFT JOIN where iCursor is not the right-hand table of that
5003** left join. An example:
5004**
5005** SELECT *
5006** FROM (SELECT 1 AS a1 UNION ALL SELECT 2) AS aa
5007** JOIN (SELECT 1 AS b2 UNION ALL SELECT 2) AS bb ON (a1=b2)
5008** LEFT JOIN (SELECT 8 AS c3 UNION ALL SELECT 9) AS cc ON (b2=2);
5009**
5010** The correct answer is three rows: (1,1,NULL),(2,2,8),(2,2,9).
5011** But if the (b2=2) term were to be pushed down into the bb subquery,
5012** then the (1,1,NULL) row would be suppressed.
drh38978dd2015-08-22 01:32:29 +00005013**
dan903fdd42021-02-22 20:56:13 +00005014** (6) Window functions make things tricky as changes to the WHERE clause
5015** of the inner query could change the window over which window
5016** functions are calculated. Therefore, do not attempt the optimization
5017** if:
5018**
5019** (6a) The inner query uses multiple incompatible window partitions.
5020**
5021** (6b) The inner query is a compound and uses window-functions.
5022**
5023** (6c) The WHERE clause does not consist entirely of constants and
5024** copies of expressions found in the PARTITION BY clause of
5025** all window-functions used by the sub-query. It is safe to
5026** filter out entire partitions, as this does not change the
5027** window over which any window-function is calculated.
dance103732018-06-23 07:59:39 +00005028**
drh745912e2021-02-22 03:04:25 +00005029** (7) The inner query is a Common Table Expression (CTE) that should
5030** be materialized. (This restriction is implemented in the calling
5031** routine.)
5032**
drh69b72d52015-06-01 20:28:03 +00005033** Return 0 if no changes are made and non-zero if one or more WHERE clause
5034** terms are duplicated into the subquery.
5035*/
5036static int pushDownWhereTerms(
dan44c56042016-12-07 15:38:37 +00005037 Parse *pParse, /* Parse context (for malloc() and error reporting) */
drh69b72d52015-06-01 20:28:03 +00005038 Select *pSubq, /* The subquery whose WHERE clause is to be augmented */
5039 Expr *pWhere, /* The WHERE clause of the outer query */
drha9cdb902022-04-25 19:40:33 +00005040 SrcItem *pSrc /* The subquery term of the outer FROM clause */
drh69b72d52015-06-01 20:28:03 +00005041){
5042 Expr *pNew;
5043 int nChng = 0;
5044 if( pWhere==0 ) return 0;
dan903fdd42021-02-22 20:56:13 +00005045 if( pSubq->selFlags & (SF_Recursive|SF_MultiPart) ) return 0;
drh0e464b52022-04-25 20:47:58 +00005046 if( pSrc->fg.jointype & (JT_LTORJ|JT_RIGHT) ) return 0;
drh508e2d02017-09-30 01:25:04 +00005047
dance103732018-06-23 07:59:39 +00005048#ifndef SQLITE_OMIT_WINDOWFUNC
dan903fdd42021-02-22 20:56:13 +00005049 if( pSubq->pPrior ){
5050 Select *pSel;
5051 for(pSel=pSubq; pSel; pSel=pSel->pPrior){
5052 if( pSel->pWin ) return 0; /* restriction (6b) */
5053 }
5054 }else{
5055 if( pSubq->pWin && pSubq->pWin->pPartition==0 ) return 0;
danf65e3792020-06-10 10:58:15 +00005056 }
dance103732018-06-23 07:59:39 +00005057#endif
5058
drh508e2d02017-09-30 01:25:04 +00005059#ifdef SQLITE_DEBUG
5060 /* Only the first term of a compound can have a WITH clause. But make
5061 ** sure no other terms are marked SF_Recursive in case something changes
5062 ** in the future.
5063 */
5064 {
5065 Select *pX;
5066 for(pX=pSubq; pX; pX=pX->pPrior){
5067 assert( (pX->selFlags & (SF_Recursive))==0 );
drhb1ec87a2016-04-25 02:20:10 +00005068 }
drh69b72d52015-06-01 20:28:03 +00005069 }
drh508e2d02017-09-30 01:25:04 +00005070#endif
5071
drh69b72d52015-06-01 20:28:03 +00005072 if( pSubq->pLimit!=0 ){
drhb1ec87a2016-04-25 02:20:10 +00005073 return 0; /* restriction (3) */
drh69b72d52015-06-01 20:28:03 +00005074 }
5075 while( pWhere->op==TK_AND ){
drha9cdb902022-04-25 19:40:33 +00005076 nChng += pushDownWhereTerms(pParse, pSubq, pWhere->pRight, pSrc);
drh69b72d52015-06-01 20:28:03 +00005077 pWhere = pWhere->pLeft;
5078 }
drha9cdb902022-04-25 19:40:33 +00005079
5080#if 0 /* Legacy code. Checks now done by sqlite3ExprIsTableConstraint() */
drh6a9b9522018-03-27 15:13:43 +00005081 if( isLeftJoin
drh67a99db2022-05-13 14:52:04 +00005082 && (ExprHasProperty(pWhere,EP_OuterON)==0
drhd1985262022-04-11 11:25:28 +00005083 || pWhere->w.iJoin!=iCursor)
drh6a9b9522018-03-27 15:13:43 +00005084 ){
5085 return 0; /* restriction (4) */
5086 }
drh67a99db2022-05-13 14:52:04 +00005087 if( ExprHasProperty(pWhere,EP_OuterON)
drhd1985262022-04-11 11:25:28 +00005088 && pWhere->w.iJoin!=iCursor
drh796588a2022-02-05 21:49:47 +00005089 ){
drh7fbb1012018-03-21 01:59:46 +00005090 return 0; /* restriction (5) */
5091 }
drha9cdb902022-04-25 19:40:33 +00005092#endif
5093
drh5eb6e092022-04-25 20:38:42 +00005094 if( sqlite3ExprIsTableConstraint(pWhere, pSrc) ){
drh69b72d52015-06-01 20:28:03 +00005095 nChng++;
drh8794c682021-02-13 16:39:24 +00005096 pSubq->selFlags |= SF_PushDown;
drh69b72d52015-06-01 20:28:03 +00005097 while( pSubq ){
drh46967de2017-04-14 12:39:37 +00005098 SubstContext x;
dan44c56042016-12-07 15:38:37 +00005099 pNew = sqlite3ExprDup(pParse->db, pWhere, 0);
drh92d1afb2022-06-13 12:42:24 +00005100 unsetJoinExpr(pNew, -1, 1);
drh46967de2017-04-14 12:39:37 +00005101 x.pParse = pParse;
drha9cdb902022-04-25 19:40:33 +00005102 x.iTable = pSrc->iCursor;
5103 x.iNewTable = pSrc->iCursor;
drhc133bab2022-04-11 20:15:52 +00005104 x.isOuterJoin = 0;
drh46967de2017-04-14 12:39:37 +00005105 x.pEList = pSubq->pEList;
5106 pNew = substExpr(&x, pNew);
dan903fdd42021-02-22 20:56:13 +00005107#ifndef SQLITE_OMIT_WINDOWFUNC
5108 if( pSubq->pWin && 0==pushDownWindowCheck(pParse, pSubq, pNew) ){
5109 /* Restriction 6c has prevented push-down in this case */
5110 sqlite3ExprDelete(pParse->db, pNew);
5111 nChng--;
5112 break;
5113 }
5114#endif
drh25c221e2017-09-29 22:13:24 +00005115 if( pSubq->selFlags & SF_Aggregate ){
drhd5c851c2019-04-19 13:38:34 +00005116 pSubq->pHaving = sqlite3ExprAnd(pParse, pSubq->pHaving, pNew);
drh25c221e2017-09-29 22:13:24 +00005117 }else{
drhd5c851c2019-04-19 13:38:34 +00005118 pSubq->pWhere = sqlite3ExprAnd(pParse, pSubq->pWhere, pNew);
drh25c221e2017-09-29 22:13:24 +00005119 }
drh69b72d52015-06-01 20:28:03 +00005120 pSubq = pSubq->pPrior;
5121 }
5122 }
5123 return nChng;
5124}
5125#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
5126
drh1350b032002-02-27 19:00:20 +00005127/*
drh47d9f832017-10-26 20:04:28 +00005128** The pFunc is the only aggregate function in the query. Check to see
5129** if the query is a candidate for the min/max optimization.
danielk1977a9d1ccb2008-01-05 17:39:29 +00005130**
drh47d9f832017-10-26 20:04:28 +00005131** If the query is a candidate for the min/max optimization, then set
5132** *ppMinMax to be an ORDER BY clause to be used for the optimization
5133** and return either WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX depending on
5134** whether pFunc is a min() or max() function.
danielk1977738bdcf2008-01-07 10:16:40 +00005135**
drh47d9f832017-10-26 20:04:28 +00005136** If the query is not a candidate for the min/max optimization, return
5137** WHERE_ORDERBY_NORMAL (which must be zero).
dan4ac391f2012-12-13 16:37:10 +00005138**
drh47d9f832017-10-26 20:04:28 +00005139** This routine must be called after aggregate functions have been
5140** located but before their arguments have been subjected to aggregate
5141** analysis.
danielk1977a9d1ccb2008-01-05 17:39:29 +00005142*/
drh47d9f832017-10-26 20:04:28 +00005143static u8 minMaxQuery(sqlite3 *db, Expr *pFunc, ExprList **ppMinMax){
5144 int eRet = WHERE_ORDERBY_NORMAL; /* Return value */
drha4eeccd2021-10-07 17:43:30 +00005145 ExprList *pEList; /* Arguments to agg function */
drh47d9f832017-10-26 20:04:28 +00005146 const char *zFunc; /* Name of aggregate function pFunc */
5147 ExprList *pOrderBy;
drhbe284e42020-02-27 16:21:39 +00005148 u8 sortFlags = 0;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005149
drh47d9f832017-10-26 20:04:28 +00005150 assert( *ppMinMax==0 );
5151 assert( pFunc->op==TK_AGG_FUNCTION );
dan4f9adee2019-07-13 16:22:50 +00005152 assert( !IsWindowFunc(pFunc) );
drha4eeccd2021-10-07 17:43:30 +00005153 assert( ExprUseXList(pFunc) );
5154 pEList = pFunc->x.pList;
drhaf7b7652021-01-13 19:28:17 +00005155 if( pEList==0
5156 || pEList->nExpr!=1
5157 || ExprHasProperty(pFunc, EP_WinFunc)
5158 || OptimizationDisabled(db, SQLITE_MinMaxOpt)
5159 ){
dan6ba7ab02019-07-02 11:56:47 +00005160 return eRet;
5161 }
drhf9751072021-10-07 13:40:29 +00005162 assert( !ExprHasProperty(pFunc, EP_IntValue) );
drh47d9f832017-10-26 20:04:28 +00005163 zFunc = pFunc->u.zToken;
5164 if( sqlite3StrICmp(zFunc, "min")==0 ){
5165 eRet = WHERE_ORDERBY_MIN;
dan67e2bb92020-02-27 15:07:16 +00005166 if( sqlite3ExprCanBeNull(pEList->a[0].pExpr) ){
5167 sortFlags = KEYINFO_ORDER_BIGNULL;
5168 }
drh47d9f832017-10-26 20:04:28 +00005169 }else if( sqlite3StrICmp(zFunc, "max")==0 ){
5170 eRet = WHERE_ORDERBY_MAX;
dan5b32bdf2019-08-17 15:47:32 +00005171 sortFlags = KEYINFO_ORDER_DESC;
drh47d9f832017-10-26 20:04:28 +00005172 }else{
5173 return eRet;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005174 }
drh47d9f832017-10-26 20:04:28 +00005175 *ppMinMax = pOrderBy = sqlite3ExprListDup(db, pEList, 0);
5176 assert( pOrderBy!=0 || db->mallocFailed );
drhd88fd532022-05-02 20:49:30 +00005177 if( pOrderBy ) pOrderBy->a[0].fg.sortFlags = sortFlags;
dan4ac391f2012-12-13 16:37:10 +00005178 return eRet;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005179}
5180
5181/*
danielk1977a5533162009-02-24 10:01:51 +00005182** The select statement passed as the first argument is an aggregate query.
peter.d.reid60ec9142014-09-06 16:39:46 +00005183** The second argument is the associated aggregate-info object. This
danielk1977a5533162009-02-24 10:01:51 +00005184** function tests if the SELECT is of the form:
5185**
5186** SELECT count(*) FROM <tbl>
5187**
5188** where table is a database table, not a sub-select or view. If the query
5189** does match this pattern, then a pointer to the Table object representing
drha1c4c3c2021-11-05 11:52:33 +00005190** <tbl> is returned. Otherwise, NULL is returned.
5191**
drhe574a922021-11-26 15:08:55 +00005192** This routine checks to see if it is safe to use the count optimization.
5193** A correct answer is still obtained (though perhaps more slowly) if
5194** this routine returns NULL when it could have returned a table pointer.
5195** But returning the pointer when NULL should have been returned can
5196** result in incorrect answers and/or crashes. So, when in doubt, return NULL.
danielk1977a5533162009-02-24 10:01:51 +00005197*/
5198static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
5199 Table *pTab;
5200 Expr *pExpr;
5201
5202 assert( !p->pGroupBy );
5203
drha1c4c3c2021-11-05 11:52:33 +00005204 if( p->pWhere
5205 || p->pEList->nExpr!=1
5206 || p->pSrc->nSrc!=1
5207 || p->pSrc->a[0].pSelect
5208 || pAggInfo->nFunc!=1
dan2c1b1dd2022-07-01 21:03:19 +00005209 || p->pHaving
danielk1977a5533162009-02-24 10:01:51 +00005210 ){
5211 return 0;
5212 }
danielk1977a5533162009-02-24 10:01:51 +00005213 pTab = p->pSrc->a[0].pTab;
drha1c4c3c2021-11-05 11:52:33 +00005214 assert( pTab!=0 );
5215 assert( !IsView(pTab) );
5216 if( !IsOrdinaryTable(pTab) ) return 0;
danielk1977a5533162009-02-24 10:01:51 +00005217 pExpr = p->pEList->a[0].pExpr;
drha1c4c3c2021-11-05 11:52:33 +00005218 assert( pExpr!=0 );
danielk1977a5533162009-02-24 10:01:51 +00005219 if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
dan8745f8a2021-11-15 14:11:23 +00005220 if( pExpr->pAggInfo!=pAggInfo ) return 0;
drhd36e1042013-09-06 13:10:12 +00005221 if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
drha1c4c3c2021-11-05 11:52:33 +00005222 assert( pAggInfo->aFunc[0].pFExpr==pExpr );
5223 testcase( ExprHasProperty(pExpr, EP_Distinct) );
5224 testcase( ExprHasProperty(pExpr, EP_WinFunc) );
dan4f9adee2019-07-13 16:22:50 +00005225 if( ExprHasProperty(pExpr, EP_Distinct|EP_WinFunc) ) return 0;
danielk1977a5533162009-02-24 10:01:51 +00005226
5227 return pTab;
5228}
5229
5230/*
danielk1977b1c685b2008-10-06 16:18:39 +00005231** If the source-list item passed as an argument was augmented with an
5232** INDEXED BY clause, then try to locate the specified index. If there
5233** was such a clause and the named index cannot be found, return
5234** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
5235** pFrom->pIndex and return SQLITE_OK.
5236*/
drh76012942021-02-21 21:04:54 +00005237int sqlite3IndexedByLookup(Parse *pParse, SrcItem *pFrom){
drh18622712021-02-20 21:20:54 +00005238 Table *pTab = pFrom->pTab;
5239 char *zIndexedBy = pFrom->u1.zIndexedBy;
5240 Index *pIdx;
5241 assert( pTab!=0 );
5242 assert( pFrom->fg.isIndexedBy!=0 );
5243
5244 for(pIdx=pTab->pIndex;
5245 pIdx && sqlite3StrICmp(pIdx->zName, zIndexedBy);
5246 pIdx=pIdx->pNext
5247 );
5248 if( !pIdx ){
5249 sqlite3ErrorMsg(pParse, "no such index: %s", zIndexedBy, 0);
5250 pParse->checkSchema = 1;
5251 return SQLITE_ERROR;
danielk1977b1c685b2008-10-06 16:18:39 +00005252 }
drhdbfbb5a2021-10-07 23:04:50 +00005253 assert( pFrom->fg.isCte==0 );
drha79e2a22021-02-21 23:44:14 +00005254 pFrom->u2.pIBIndex = pIdx;
danielk1977b1c685b2008-10-06 16:18:39 +00005255 return SQLITE_OK;
5256}
drh18622712021-02-20 21:20:54 +00005257
drhc01b7302013-05-07 17:49:08 +00005258/*
5259** Detect compound SELECT statements that use an ORDER BY clause with
5260** an alternative collating sequence.
5261**
5262** SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
5263**
5264** These are rewritten as a subquery:
5265**
5266** SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
5267** ORDER BY ... COLLATE ...
5268**
5269** This transformation is necessary because the multiSelectOrderBy() routine
5270** above that generates the code for a compound SELECT with an ORDER BY clause
5271** uses a merge algorithm that requires the same collating sequence on the
5272** result columns as on the ORDER BY clause. See ticket
5273** http://www.sqlite.org/src/info/6709574d2a
5274**
5275** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
5276** The UNION ALL operator works fine with multiSelectOrderBy() even when
5277** there are COLLATE terms in the ORDER BY.
5278*/
5279static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
5280 int i;
5281 Select *pNew;
5282 Select *pX;
5283 sqlite3 *db;
5284 struct ExprList_item *a;
5285 SrcList *pNewSrc;
5286 Parse *pParse;
5287 Token dummy;
5288
5289 if( p->pPrior==0 ) return WRC_Continue;
5290 if( p->pOrderBy==0 ) return WRC_Continue;
5291 for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
5292 if( pX==0 ) return WRC_Continue;
5293 a = p->pOrderBy->a;
dan46daa992020-06-11 15:53:54 +00005294#ifndef SQLITE_OMIT_WINDOWFUNC
5295 /* If iOrderByCol is already non-zero, then it has already been matched
5296 ** to a result column of the SELECT statement. This occurs when the
5297 ** SELECT is rewritten for window-functions processing and then passed
5298 ** to sqlite3SelectPrep() and similar a second time. The rewriting done
5299 ** by this function is not required in this case. */
5300 if( a[0].u.x.iOrderByCol ) return WRC_Continue;
5301#endif
drhc01b7302013-05-07 17:49:08 +00005302 for(i=p->pOrderBy->nExpr-1; i>=0; i--){
5303 if( a[i].pExpr->flags & EP_Collate ) break;
5304 }
5305 if( i<0 ) return WRC_Continue;
5306
5307 /* If we reach this point, that means the transformation is required. */
5308
5309 pParse = pWalker->pParse;
5310 db = pParse->db;
5311 pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
5312 if( pNew==0 ) return WRC_Abort;
5313 memset(&dummy, 0, sizeof(dummy));
drhd44f8b22022-04-07 01:11:13 +00005314 pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0);
drhc01b7302013-05-07 17:49:08 +00005315 if( pNewSrc==0 ) return WRC_Abort;
5316 *pNew = *p;
5317 p->pSrc = pNewSrc;
drh1a1d3cd2015-11-19 16:33:31 +00005318 p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ASTERISK, 0));
drhc01b7302013-05-07 17:49:08 +00005319 p->op = TK_SELECT;
5320 p->pWhere = 0;
5321 pNew->pGroupBy = 0;
5322 pNew->pHaving = 0;
5323 pNew->pOrderBy = 0;
5324 p->pPrior = 0;
drh8af9ad92014-02-10 18:56:05 +00005325 p->pNext = 0;
drhf932f712015-04-12 17:35:27 +00005326 p->pWith = 0;
danfcc057d2019-12-04 01:42:07 +00005327#ifndef SQLITE_OMIT_WINDOWFUNC
5328 p->pWinDefn = 0;
5329#endif
drh8af9ad92014-02-10 18:56:05 +00005330 p->selFlags &= ~SF_Compound;
danb33c50f2015-04-04 16:43:16 +00005331 assert( (p->selFlags & SF_Converted)==0 );
5332 p->selFlags |= SF_Converted;
drha6e3a8c2014-02-10 21:07:51 +00005333 assert( pNew->pPrior!=0 );
5334 pNew->pPrior->pNext = pNew;
drhc01b7302013-05-07 17:49:08 +00005335 pNew->pLimit = 0;
drhc01b7302013-05-07 17:49:08 +00005336 return WRC_Continue;
5337}
danielk1977b1c685b2008-10-06 16:18:39 +00005338
drh20292312015-11-21 13:24:46 +00005339/*
5340** Check to see if the FROM clause term pFrom has table-valued function
5341** arguments. If it does, leave an error message in pParse and return
5342** non-zero, since pFrom is not allowed to be a table-valued function.
5343*/
drh76012942021-02-21 21:04:54 +00005344static int cannotBeFunction(Parse *pParse, SrcItem *pFrom){
drh20292312015-11-21 13:24:46 +00005345 if( pFrom->fg.isTabFunc ){
5346 sqlite3ErrorMsg(pParse, "'%s' is not a function", pFrom->zName);
5347 return 1;
5348 }
5349 return 0;
5350}
5351
daneede6a52014-01-15 19:42:23 +00005352#ifndef SQLITE_OMIT_CTE
5353/*
5354** Argument pWith (which may be NULL) points to a linked list of nested
5355** WITH contexts, from inner to outermost. If the table identified by
5356** FROM clause element pItem is really a common-table-expression (CTE)
5357** then return a pointer to the CTE definition for that table. Otherwise
5358** return NULL.
dan98f45e52014-01-17 17:40:46 +00005359**
5360** If a non-NULL value is returned, set *ppContext to point to the With
5361** object that the returned CTE belongs to.
drh60c1a2f2014-01-15 18:23:00 +00005362*/
dan98f45e52014-01-17 17:40:46 +00005363static struct Cte *searchWith(
drh2476a6f2015-11-07 15:19:59 +00005364 With *pWith, /* Current innermost WITH clause */
drh76012942021-02-21 21:04:54 +00005365 SrcItem *pItem, /* FROM clause element to resolve */
dan98f45e52014-01-17 17:40:46 +00005366 With **ppContext /* OUT: WITH clause return value belongs to */
5367){
drh5abe1d32021-02-21 01:19:42 +00005368 const char *zName = pItem->zName;
5369 With *p;
5370 assert( pItem->zDatabase==0 );
5371 assert( zName!=0 );
5372 for(p=pWith; p; p=p->pOuter){
5373 int i;
5374 for(i=0; i<p->nCte; i++){
5375 if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
5376 *ppContext = p;
5377 return &p->a[i];
dan4e9119d2014-01-13 15:12:23 +00005378 }
5379 }
dan90bc36f2021-05-20 17:15:06 +00005380 if( p->bView ) break;
dan4e9119d2014-01-13 15:12:23 +00005381 }
5382 return 0;
5383}
5384
drhc49832c2014-01-15 18:35:52 +00005385/* The code generator maintains a stack of active WITH clauses
5386** with the inner-most WITH clause being at the top of the stack.
5387**
danb290f112014-01-17 14:59:27 +00005388** This routine pushes the WITH clause passed as the second argument
5389** onto the top of the stack. If argument bFree is true, then this
drh7cc73b32021-05-23 17:47:04 +00005390** WITH clause will never be popped from the stack but should instead
5391** be freed along with the Parse object. In other cases, when
danb290f112014-01-17 14:59:27 +00005392** bFree==0, the With object will be freed along with the SELECT
5393** statement with which it is associated.
drh24ce9442021-06-12 17:45:32 +00005394**
5395** This routine returns a copy of pWith. Or, if bFree is true and
5396** the pWith object is destroyed immediately due to an OOM condition,
5397** then this routine return NULL.
5398**
5399** If bFree is true, do not continue to use the pWith pointer after
5400** calling this routine, Instead, use only the return value.
drhc49832c2014-01-15 18:35:52 +00005401*/
drh24ce9442021-06-12 17:45:32 +00005402With *sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
dan4e9119d2014-01-13 15:12:23 +00005403 if( pWith ){
drh24ce9442021-06-12 17:45:32 +00005404 if( bFree ){
5405 pWith = (With*)sqlite3ParserAddCleanup(pParse,
5406 (void(*)(sqlite3*,void*))sqlite3WithDelete,
5407 pWith);
5408 if( pWith==0 ) return 0;
5409 }
drh7cc73b32021-05-23 17:47:04 +00005410 if( pParse->nErr==0 ){
5411 assert( pParse->pWith!=pWith );
5412 pWith->pOuter = pParse->pWith;
5413 pParse->pWith = pWith;
5414 }
dan4e9119d2014-01-13 15:12:23 +00005415 }
drh24ce9442021-06-12 17:45:32 +00005416 return pWith;
dan4e9119d2014-01-13 15:12:23 +00005417}
dan4e9119d2014-01-13 15:12:23 +00005418
daneede6a52014-01-15 19:42:23 +00005419/*
daneede6a52014-01-15 19:42:23 +00005420** This function checks if argument pFrom refers to a CTE declared by
drh5abe1d32021-02-21 01:19:42 +00005421** a WITH clause on the stack currently maintained by the parser (on the
5422** pParse->pWith linked list). And if currently processing a CTE
5423** CTE expression, through routine checks to see if the reference is
5424** a recursive reference to the CTE.
daneede6a52014-01-15 19:42:23 +00005425**
drh5abe1d32021-02-21 01:19:42 +00005426** If pFrom matches a CTE according to either of these two above, pFrom->pTab
5427** and other fields are populated accordingly.
daneede6a52014-01-15 19:42:23 +00005428**
drh5abe1d32021-02-21 01:19:42 +00005429** Return 0 if no match is found.
5430** Return 1 if a match is found.
5431** Return 2 if an error condition is detected.
daneede6a52014-01-15 19:42:23 +00005432*/
drh5abe1d32021-02-21 01:19:42 +00005433static int resolveFromTermToCte(
5434 Parse *pParse, /* The parsing context */
5435 Walker *pWalker, /* Current tree walker */
drh76012942021-02-21 21:04:54 +00005436 SrcItem *pFrom /* The FROM clause term to check */
dan8ce71842014-01-14 20:14:09 +00005437){
drh5abe1d32021-02-21 01:19:42 +00005438 Cte *pCte; /* Matched CTE (or NULL if no match) */
5439 With *pWith; /* The matching WITH */
dan8ce71842014-01-14 20:14:09 +00005440
dan8ce71842014-01-14 20:14:09 +00005441 assert( pFrom->pTab==0 );
drh5abe1d32021-02-21 01:19:42 +00005442 if( pParse->pWith==0 ){
5443 /* There are no WITH clauses in the stack. No match is possible */
5444 return 0;
drh46a31cd2019-11-09 14:38:58 +00005445 }
drh93c81392021-05-21 21:49:07 +00005446 if( pParse->nErr ){
5447 /* Prior errors might have left pParse->pWith in a goofy state, so
5448 ** go no further. */
5449 return 0;
5450 }
drh5abe1d32021-02-21 01:19:42 +00005451 if( pFrom->zDatabase!=0 ){
5452 /* The FROM term contains a schema qualifier (ex: main.t1) and so
5453 ** it cannot possibly be a CTE reference. */
5454 return 0;
5455 }
drhcd1499f2021-05-20 00:44:04 +00005456 if( pFrom->fg.notCte ){
5457 /* The FROM term is specifically excluded from matching a CTE.
5458 ** (1) It is part of a trigger that used to have zDatabase but had
5459 ** zDatabase removed by sqlite3FixTriggerStep().
5460 ** (2) This is the first term in the FROM clause of an UPDATE.
5461 */
5462 return 0;
5463 }
dan98f45e52014-01-17 17:40:46 +00005464 pCte = searchWith(pParse->pWith, pFrom, &pWith);
daneae73fb2014-01-16 18:34:33 +00005465 if( pCte ){
drh5abe1d32021-02-21 01:19:42 +00005466 sqlite3 *db = pParse->db;
dan98f45e52014-01-17 17:40:46 +00005467 Table *pTab;
dan8ce71842014-01-14 20:14:09 +00005468 ExprList *pEList;
5469 Select *pSel;
dan60e70682014-01-15 15:27:51 +00005470 Select *pLeft; /* Left-most SELECT statement */
drh34055852020-10-19 01:23:48 +00005471 Select *pRecTerm; /* Left-most recursive term */
danf2655fe2014-01-16 21:02:02 +00005472 int bMayRecursive; /* True if compound joined by UNION [ALL] */
dan98f45e52014-01-17 17:40:46 +00005473 With *pSavedWith; /* Initial value of pParse->pWith */
drh34055852020-10-19 01:23:48 +00005474 int iRecTab = -1; /* Cursor for recursive table */
drh745912e2021-02-22 03:04:25 +00005475 CteUse *pCteUse;
danf2655fe2014-01-16 21:02:02 +00005476
drh0576bc52015-08-26 11:40:11 +00005477 /* If pCte->zCteErr is non-NULL at this point, then this is an illegal
danf2655fe2014-01-16 21:02:02 +00005478 ** recursive reference to CTE pCte. Leave an error in pParse and return
drh0576bc52015-08-26 11:40:11 +00005479 ** early. If pCte->zCteErr is NULL, then this is not a recursive reference.
danf2655fe2014-01-16 21:02:02 +00005480 ** In this case, proceed. */
drh0576bc52015-08-26 11:40:11 +00005481 if( pCte->zCteErr ){
5482 sqlite3ErrorMsg(pParse, pCte->zCteErr, pCte->zName);
drh5abe1d32021-02-21 01:19:42 +00005483 return 2;
danf2655fe2014-01-16 21:02:02 +00005484 }
drh5abe1d32021-02-21 01:19:42 +00005485 if( cannotBeFunction(pParse, pFrom) ) return 2;
dan8ce71842014-01-14 20:14:09 +00005486
drhc25e2eb2014-01-20 14:58:55 +00005487 assert( pFrom->pTab==0 );
drha79e2a22021-02-21 23:44:14 +00005488 pTab = sqlite3DbMallocZero(db, sizeof(Table));
drh5abe1d32021-02-21 01:19:42 +00005489 if( pTab==0 ) return 2;
drh745912e2021-02-22 03:04:25 +00005490 pCteUse = pCte->pUse;
5491 if( pCteUse==0 ){
5492 pCte->pUse = pCteUse = sqlite3DbMallocZero(db, sizeof(pCteUse[0]));
5493 if( pCteUse==0
5494 || sqlite3ParserAddCleanup(pParse,sqlite3DbFree,pCteUse)==0
drha79e2a22021-02-21 23:44:14 +00005495 ){
5496 sqlite3DbFree(db, pTab);
5497 return 2;
5498 }
drh745912e2021-02-22 03:04:25 +00005499 pCteUse->eM10d = pCte->eM10d;
drha79e2a22021-02-21 23:44:14 +00005500 }
5501 pFrom->pTab = pTab;
drh79df7782016-12-14 14:07:35 +00005502 pTab->nTabRef = 1;
dan2d4dc5f2014-01-17 11:48:24 +00005503 pTab->zName = sqlite3DbStrDup(db, pCte->zName);
dan8ce71842014-01-14 20:14:09 +00005504 pTab->iPKey = -1;
dancfc9df72014-04-25 15:01:01 +00005505 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drhfccda8a2015-05-27 13:06:55 +00005506 pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
dan8ce71842014-01-14 20:14:09 +00005507 pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
drh5abe1d32021-02-21 01:19:42 +00005508 if( db->mallocFailed ) return 2;
danac67f562021-06-14 20:08:48 +00005509 pFrom->pSelect->selFlags |= SF_CopyCte;
dan8ce71842014-01-14 20:14:09 +00005510 assert( pFrom->pSelect );
drh0c1da682021-10-09 16:00:56 +00005511 if( pFrom->fg.isIndexedBy ){
5512 sqlite3ErrorMsg(pParse, "no such index: \"%s\"", pFrom->u1.zIndexedBy);
5513 return 2;
5514 }
drha79e2a22021-02-21 23:44:14 +00005515 pFrom->fg.isCte = 1;
drh745912e2021-02-22 03:04:25 +00005516 pFrom->u2.pCteUse = pCteUse;
5517 pCteUse->nUse++;
5518 if( pCteUse->nUse>=2 && pCteUse->eM10d==M10d_Any ){
5519 pCteUse->eM10d = M10d_Yes;
5520 }
dan8ce71842014-01-14 20:14:09 +00005521
daneae73fb2014-01-16 18:34:33 +00005522 /* Check if this is a recursive CTE. */
drh34055852020-10-19 01:23:48 +00005523 pRecTerm = pSel = pFrom->pSelect;
danf2655fe2014-01-16 21:02:02 +00005524 bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
drh34055852020-10-19 01:23:48 +00005525 while( bMayRecursive && pRecTerm->op==pSel->op ){
daneae73fb2014-01-16 18:34:33 +00005526 int i;
drh34055852020-10-19 01:23:48 +00005527 SrcList *pSrc = pRecTerm->pSrc;
5528 assert( pRecTerm->pPrior!=0 );
daneae73fb2014-01-16 18:34:33 +00005529 for(i=0; i<pSrc->nSrc; i++){
drh76012942021-02-21 21:04:54 +00005530 SrcItem *pItem = &pSrc->a[i];
daneae73fb2014-01-16 18:34:33 +00005531 if( pItem->zDatabase==0
5532 && pItem->zName!=0
5533 && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
drh34055852020-10-19 01:23:48 +00005534 ){
daneae73fb2014-01-16 18:34:33 +00005535 pItem->pTab = pTab;
drh94d6f3f2020-10-19 20:49:54 +00005536 pTab->nTabRef++;
drh8a48b9c2015-08-19 15:20:00 +00005537 pItem->fg.isRecursive = 1;
drh34055852020-10-19 01:23:48 +00005538 if( pRecTerm->selFlags & SF_Recursive ){
5539 sqlite3ErrorMsg(pParse,
5540 "multiple references to recursive table: %s", pCte->zName
5541 );
drh5abe1d32021-02-21 01:19:42 +00005542 return 2;
drh34055852020-10-19 01:23:48 +00005543 }
drh34055852020-10-19 01:23:48 +00005544 pRecTerm->selFlags |= SF_Recursive;
5545 if( iRecTab<0 ) iRecTab = pParse->nTab++;
5546 pItem->iCursor = iRecTab;
daneae73fb2014-01-16 18:34:33 +00005547 }
5548 }
drh34055852020-10-19 01:23:48 +00005549 if( (pRecTerm->selFlags & SF_Recursive)==0 ) break;
5550 pRecTerm = pRecTerm->pPrior;
dan8ce71842014-01-14 20:14:09 +00005551 }
5552
drh0576bc52015-08-26 11:40:11 +00005553 pCte->zCteErr = "circular reference: %s";
dan98f45e52014-01-17 17:40:46 +00005554 pSavedWith = pParse->pWith;
5555 pParse->pWith = pWith;
drh34055852020-10-19 01:23:48 +00005556 if( pSel->selFlags & SF_Recursive ){
danca237a82021-03-18 18:25:43 +00005557 int rc;
drh34055852020-10-19 01:23:48 +00005558 assert( pRecTerm!=0 );
5559 assert( (pRecTerm->selFlags & SF_Recursive)==0 );
5560 assert( pRecTerm->pNext!=0 );
5561 assert( (pRecTerm->pNext->selFlags & SF_Recursive)!=0 );
5562 assert( pRecTerm->pWith==0 );
5563 pRecTerm->pWith = pSel->pWith;
danca237a82021-03-18 18:25:43 +00005564 rc = sqlite3WalkSelect(pWalker, pRecTerm);
drh34055852020-10-19 01:23:48 +00005565 pRecTerm->pWith = 0;
danca237a82021-03-18 18:25:43 +00005566 if( rc ){
5567 pParse->pWith = pSavedWith;
5568 return 2;
5569 }
dan067cd832017-02-03 19:16:39 +00005570 }else{
danca237a82021-03-18 18:25:43 +00005571 if( sqlite3WalkSelect(pWalker, pSel) ){
5572 pParse->pWith = pSavedWith;
5573 return 2;
5574 }
dan067cd832017-02-03 19:16:39 +00005575 }
drh6e772262015-11-07 17:48:21 +00005576 pParse->pWith = pWith;
daneae73fb2014-01-16 18:34:33 +00005577
dan60e70682014-01-15 15:27:51 +00005578 for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
5579 pEList = pLeft->pEList;
dan8ce71842014-01-14 20:14:09 +00005580 if( pCte->pCols ){
drh8f9d0b22015-03-21 03:18:22 +00005581 if( pEList && pEList->nExpr!=pCte->pCols->nExpr ){
drh727a99f2014-01-16 21:59:51 +00005582 sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
dan60e70682014-01-15 15:27:51 +00005583 pCte->zName, pEList->nExpr, pCte->pCols->nExpr
5584 );
dan98f45e52014-01-17 17:40:46 +00005585 pParse->pWith = pSavedWith;
drh5abe1d32021-02-21 01:19:42 +00005586 return 2;
dan60e70682014-01-15 15:27:51 +00005587 }
dan8ce71842014-01-14 20:14:09 +00005588 pEList = pCte->pCols;
dan8ce71842014-01-14 20:14:09 +00005589 }
dan8ce71842014-01-14 20:14:09 +00005590
drh8981b902015-08-24 17:42:49 +00005591 sqlite3ColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
danf2655fe2014-01-16 21:02:02 +00005592 if( bMayRecursive ){
5593 if( pSel->selFlags & SF_Recursive ){
drh0576bc52015-08-26 11:40:11 +00005594 pCte->zCteErr = "multiple recursive references: %s";
danf2655fe2014-01-16 21:02:02 +00005595 }else{
drh0576bc52015-08-26 11:40:11 +00005596 pCte->zCteErr = "recursive reference in a subquery: %s";
danf2655fe2014-01-16 21:02:02 +00005597 }
5598 sqlite3WalkSelect(pWalker, pSel);
5599 }
drh0576bc52015-08-26 11:40:11 +00005600 pCte->zCteErr = 0;
dan98f45e52014-01-17 17:40:46 +00005601 pParse->pWith = pSavedWith;
drh5abe1d32021-02-21 01:19:42 +00005602 return 1; /* Success */
dan8ce71842014-01-14 20:14:09 +00005603 }
drh5abe1d32021-02-21 01:19:42 +00005604 return 0; /* No match */
dan8ce71842014-01-14 20:14:09 +00005605}
daneede6a52014-01-15 19:42:23 +00005606#endif
dan4e9119d2014-01-13 15:12:23 +00005607
danb290f112014-01-17 14:59:27 +00005608#ifndef SQLITE_OMIT_CTE
dan71856942014-01-17 15:15:10 +00005609/*
5610** If the SELECT passed as the second argument has an associated WITH
5611** clause, pop it from the stack stored as part of the Parse object.
5612**
5613** This function is used as the xSelectCallback2() callback by
5614** sqlite3SelectExpand() when walking a SELECT tree to resolve table
5615** names and other FROM clause elements.
5616*/
danbe120832021-05-17 16:20:41 +00005617void sqlite3SelectPopWith(Walker *pWalker, Select *p){
danb290f112014-01-17 14:59:27 +00005618 Parse *pParse = pWalker->pParse;
drh2f65b2f2017-10-02 21:29:51 +00005619 if( OK_IF_ALWAYS_TRUE(pParse->pWith) && p->pPrior==0 ){
dan067cd832017-02-03 19:16:39 +00005620 With *pWith = findRightmost(p)->pWith;
5621 if( pWith!=0 ){
dan70a32702020-01-21 14:42:48 +00005622 assert( pParse->pWith==pWith || pParse->nErr );
dan067cd832017-02-03 19:16:39 +00005623 pParse->pWith = pWith->pOuter;
5624 }
danb290f112014-01-17 14:59:27 +00005625 }
danb290f112014-01-17 14:59:27 +00005626}
danb290f112014-01-17 14:59:27 +00005627#endif
5628
dan9a947222018-06-14 19:06:36 +00005629/*
5630** The SrcList_item structure passed as the second argument represents a
5631** sub-query in the FROM clause of a SELECT statement. This function
5632** allocates and populates the SrcList_item.pTab object. If successful,
5633** SQLITE_OK is returned. Otherwise, if an OOM error is encountered,
5634** SQLITE_NOMEM.
5635*/
drh76012942021-02-21 21:04:54 +00005636int sqlite3ExpandSubquery(Parse *pParse, SrcItem *pFrom){
dan86fb6e12018-05-16 20:58:07 +00005637 Select *pSel = pFrom->pSelect;
5638 Table *pTab;
5639
dan9a947222018-06-14 19:06:36 +00005640 assert( pSel );
dan86fb6e12018-05-16 20:58:07 +00005641 pFrom->pTab = pTab = sqlite3DbMallocZero(pParse->db, sizeof(Table));
dan9a947222018-06-14 19:06:36 +00005642 if( pTab==0 ) return SQLITE_NOMEM;
dan86fb6e12018-05-16 20:58:07 +00005643 pTab->nTabRef = 1;
5644 if( pFrom->zAlias ){
5645 pTab->zName = sqlite3DbStrDup(pParse->db, pFrom->zAlias);
5646 }else{
drhd6bb6002022-04-22 18:07:38 +00005647 pTab->zName = sqlite3MPrintf(pParse->db, "%!S", pFrom);
dan86fb6e12018-05-16 20:58:07 +00005648 }
5649 while( pSel->pPrior ){ pSel = pSel->pPrior; }
5650 sqlite3ColumnsFromExprList(pParse, pSel->pEList,&pTab->nCol,&pTab->aCol);
5651 pTab->iPKey = -1;
5652 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drh6e5020e2021-04-07 15:45:01 +00005653#ifndef SQLITE_ALLOW_ROWID_IN_VIEW
5654 /* The usual case - do not allow ROWID on a subquery */
5655 pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
5656#else
5657 pTab->tabFlags |= TF_Ephemeral; /* Legacy compatibility mode */
5658#endif
drhf4b33152019-04-23 12:30:15 +00005659 return pParse->nErr ? SQLITE_ERROR : SQLITE_OK;
dan86fb6e12018-05-16 20:58:07 +00005660}
5661
drh4ce7bf92022-04-15 18:30:48 +00005662
5663/*
5664** Check the N SrcItem objects to the right of pBase. (N might be zero!)
5665** If any of those SrcItem objects have a USING clause containing zName
5666** then return true.
5667**
5668** If N is zero, or none of the N SrcItem objects to the right of pBase
5669** contains a USING clause, or if none of the USING clauses contain zName,
5670** then return false.
5671*/
5672static int inAnyUsingClause(
5673 const char *zName, /* Name we are looking for */
5674 SrcItem *pBase, /* The base SrcItem. Looking at pBase[1] and following */
5675 int N /* How many SrcItems to check */
5676){
5677 while( N>0 ){
5678 N--;
5679 pBase++;
5680 if( pBase->fg.isUsing==0 ) continue;
drhe32d6a02022-04-19 15:56:03 +00005681 if( NEVER(pBase->u3.pUsing==0) ) continue;
drh4ce7bf92022-04-15 18:30:48 +00005682 if( sqlite3IdListIndex(pBase->u3.pUsing, zName)>=0 ) return 1;
5683 }
5684 return 0;
5685}
5686
5687
danielk1977b1c685b2008-10-06 16:18:39 +00005688/*
drh7d10d5a2008-08-20 16:35:10 +00005689** This routine is a Walker callback for "expanding" a SELECT statement.
5690** "Expanding" means to do the following:
5691**
5692** (1) Make sure VDBE cursor numbers have been assigned to every
5693** element of the FROM clause.
5694**
5695** (2) Fill in the pTabList->a[].pTab fields in the SrcList that
5696** defines FROM clause. When views appear in the FROM clause,
5697** fill pTabList->a[].pSelect with a copy of the SELECT statement
5698** that implements the view. A copy is made of the view's SELECT
5699** statement so that we can freely modify or delete that statement
peter.d.reid60ec9142014-09-06 16:39:46 +00005700** without worrying about messing up the persistent representation
drh7d10d5a2008-08-20 16:35:10 +00005701** of the view.
5702**
peter.d.reid60ec9142014-09-06 16:39:46 +00005703** (3) Add terms to the WHERE clause to accommodate the NATURAL keyword
drh7d10d5a2008-08-20 16:35:10 +00005704** on joins and the ON and USING clause of joins.
5705**
5706** (4) Scan the list of columns in the result set (pEList) looking
5707** for instances of the "*" operator or the TABLE.* operator.
5708** If found, expand each "*" to be every column in every table
5709** and TABLE.* to be every column in TABLE.
5710**
danielk1977b3bce662005-01-29 08:32:43 +00005711*/
drh7d10d5a2008-08-20 16:35:10 +00005712static int selectExpander(Walker *pWalker, Select *p){
5713 Parse *pParse = pWalker->pParse;
drh5abe1d32021-02-21 01:19:42 +00005714 int i, j, k, rc;
drh7d10d5a2008-08-20 16:35:10 +00005715 SrcList *pTabList;
5716 ExprList *pEList;
drh76012942021-02-21 21:04:54 +00005717 SrcItem *pFrom;
drh7d10d5a2008-08-20 16:35:10 +00005718 sqlite3 *db = pParse->db;
drh3e3f1a52013-01-03 00:45:56 +00005719 Expr *pE, *pRight, *pExpr;
drh785097d2013-02-12 22:09:48 +00005720 u16 selFlags = p->selFlags;
drhfca23552017-10-28 20:51:54 +00005721 u32 elistFlags = 0;
danielk1977b3bce662005-01-29 08:32:43 +00005722
drh785097d2013-02-12 22:09:48 +00005723 p->selFlags |= SF_Expanded;
drh7d10d5a2008-08-20 16:35:10 +00005724 if( db->mallocFailed ){
5725 return WRC_Abort;
danielk1977b3bce662005-01-29 08:32:43 +00005726 }
drh9d9c41e2017-10-31 03:40:15 +00005727 assert( p->pSrc!=0 );
5728 if( (selFlags & SF_Expanded)!=0 ){
drh7d10d5a2008-08-20 16:35:10 +00005729 return WRC_Prune;
danielk1977b3bce662005-01-29 08:32:43 +00005730 }
drh59145812019-05-22 22:49:23 +00005731 if( pWalker->eCode ){
5732 /* Renumber selId because it has been copied from a view */
5733 p->selId = ++pParse->nSelect;
5734 }
drh7d10d5a2008-08-20 16:35:10 +00005735 pTabList = p->pSrc;
danielk1977b3bce662005-01-29 08:32:43 +00005736 pEList = p->pEList;
dan90bc36f2021-05-20 17:15:06 +00005737 if( pParse->pWith && (p->selFlags & SF_View) ){
5738 if( p->pWith==0 ){
5739 p->pWith = (With*)sqlite3DbMallocZero(db, sizeof(With));
5740 if( p->pWith==0 ){
5741 return WRC_Abort;
5742 }
5743 }
5744 p->pWith->bView = 1;
5745 }
drha5746e02018-04-09 20:36:09 +00005746 sqlite3WithPush(pParse, p->pWith, 0);
drh7d10d5a2008-08-20 16:35:10 +00005747
5748 /* Make sure cursor numbers have been assigned to all entries in
5749 ** the FROM clause of the SELECT statement.
5750 */
5751 sqlite3SrcListAssignCursors(pParse, pTabList);
5752
5753 /* Look up every table named in the FROM clause of the select. If
5754 ** an entry of the FROM clause is a subquery instead of a table or view,
5755 ** then create a transient table structure to describe the subquery.
5756 */
5757 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5758 Table *pTab;
drhe2b7d7a2015-09-29 15:50:04 +00005759 assert( pFrom->fg.isRecursive==0 || pFrom->pTab!=0 );
dan69887c92020-04-27 20:55:33 +00005760 if( pFrom->pTab ) continue;
5761 assert( pFrom->fg.isRecursive==0 );
drh7d10d5a2008-08-20 16:35:10 +00005762 if( pFrom->zName==0 ){
5763#ifndef SQLITE_OMIT_SUBQUERY
5764 Select *pSel = pFrom->pSelect;
5765 /* A sub-query in the FROM clause of a SELECT */
5766 assert( pSel!=0 );
5767 assert( pFrom->pTab==0 );
drh2b8c5a02015-01-22 12:00:17 +00005768 if( sqlite3WalkSelect(pWalker, pSel) ) return WRC_Abort;
dandfa552f2018-06-02 21:04:28 +00005769 if( sqlite3ExpandSubquery(pParse, pFrom) ) return WRC_Abort;
dan86fb6e12018-05-16 20:58:07 +00005770#endif
drh5abe1d32021-02-21 01:19:42 +00005771#ifndef SQLITE_OMIT_CTE
5772 }else if( (rc = resolveFromTermToCte(pParse, pWalker, pFrom))!=0 ){
5773 if( rc>1 ) return WRC_Abort;
5774 pTab = pFrom->pTab;
5775 assert( pTab!=0 );
5776#endif
drh7d10d5a2008-08-20 16:35:10 +00005777 }else{
5778 /* An ordinary table or view name in the FROM clause */
5779 assert( pFrom->pTab==0 );
dan41fb5cd2012-10-04 19:33:00 +00005780 pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
drh7d10d5a2008-08-20 16:35:10 +00005781 if( pTab==0 ) return WRC_Abort;
drh79df7782016-12-14 14:07:35 +00005782 if( pTab->nTabRef>=0xffff ){
drhd2a56232013-01-28 19:00:20 +00005783 sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
5784 pTab->zName);
5785 pFrom->pTab = 0;
5786 return WRC_Abort;
5787 }
drh79df7782016-12-14 14:07:35 +00005788 pTab->nTabRef++;
drh20292312015-11-21 13:24:46 +00005789 if( !IsVirtual(pTab) && cannotBeFunction(pParse, pFrom) ){
5790 return WRC_Abort;
5791 }
dan8c812f92020-01-21 16:23:17 +00005792#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhf38524d2021-08-02 16:41:57 +00005793 if( !IsOrdinaryTable(pTab) ){
drhbfad7be2015-10-11 20:39:46 +00005794 i16 nCol;
drh59145812019-05-22 22:49:23 +00005795 u8 eCodeOrig = pWalker->eCode;
drh7d10d5a2008-08-20 16:35:10 +00005796 if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
drh43152cf2009-05-19 19:04:58 +00005797 assert( pFrom->pSelect==0 );
drhf38524d2021-08-02 16:41:57 +00005798 if( IsView(pTab) ){
5799 if( (db->flags & SQLITE_EnableView)==0
5800 && pTab->pSchema!=db->aDb[1].pSchema
5801 ){
5802 sqlite3ErrorMsg(pParse, "access to view \"%s\" prohibited",
5803 pTab->zName);
5804 }
5805 pFrom->pSelect = sqlite3SelectDup(db, pTab->u.view.pSelect, 0);
danafaa6602021-09-30 18:42:52 +00005806 }
dan8c812f92020-01-21 16:23:17 +00005807#ifndef SQLITE_OMIT_VIRTUALTABLE
danafaa6602021-09-30 18:42:52 +00005808 else if( ALWAYS(IsVirtual(pTab))
drh3f681422020-01-07 18:10:56 +00005809 && pFrom->fg.fromDDL
drhf38524d2021-08-02 16:41:57 +00005810 && ALWAYS(pTab->u.vtab.p!=0)
5811 && pTab->u.vtab.p->eVtabRisk > ((db->flags & SQLITE_TrustedSchema)!=0)
drh3f681422020-01-07 18:10:56 +00005812 ){
drh32266a12020-01-09 13:08:28 +00005813 sqlite3ErrorMsg(pParse, "unsafe use of virtual table \"%s\"",
5814 pTab->zName);
drh11d88e62019-08-15 21:27:20 +00005815 }
drhf38524d2021-08-02 16:41:57 +00005816 assert( SQLITE_VTABRISK_Normal==1 && SQLITE_VTABRISK_High==2 );
dan8c812f92020-01-21 16:23:17 +00005817#endif
drhbfad7be2015-10-11 20:39:46 +00005818 nCol = pTab->nCol;
5819 pTab->nCol = -1;
drh59145812019-05-22 22:49:23 +00005820 pWalker->eCode = 1; /* Turn on Select.selId renumbering */
drh43152cf2009-05-19 19:04:58 +00005821 sqlite3WalkSelect(pWalker, pFrom->pSelect);
drh59145812019-05-22 22:49:23 +00005822 pWalker->eCode = eCodeOrig;
drhbfad7be2015-10-11 20:39:46 +00005823 pTab->nCol = nCol;
drh7d10d5a2008-08-20 16:35:10 +00005824 }
5825#endif
danielk1977b3bce662005-01-29 08:32:43 +00005826 }
danielk197785574e32008-10-06 05:32:18 +00005827
5828 /* Locate the index named by the INDEXED BY clause, if any. */
drh18622712021-02-20 21:20:54 +00005829 if( pFrom->fg.isIndexedBy && sqlite3IndexedByLookup(pParse, pFrom) ){
danielk1977b1c685b2008-10-06 16:18:39 +00005830 return WRC_Abort;
danielk197785574e32008-10-06 05:32:18 +00005831 }
danielk1977b3bce662005-01-29 08:32:43 +00005832 }
5833
drh7d10d5a2008-08-20 16:35:10 +00005834 /* Process NATURAL keywords, and ON and USING clauses of joins.
danielk1977b3bce662005-01-29 08:32:43 +00005835 */
drh0c7d3d32022-01-24 16:47:12 +00005836 assert( db->mallocFailed==0 || pParse->nErr!=0 );
drh358424a2022-04-15 15:15:01 +00005837 if( pParse->nErr || sqlite3ProcessJoin(pParse, p) ){
drh7d10d5a2008-08-20 16:35:10 +00005838 return WRC_Abort;
danielk1977b3bce662005-01-29 08:32:43 +00005839 }
5840
drh7d10d5a2008-08-20 16:35:10 +00005841 /* For every "*" that occurs in the column list, insert the names of
5842 ** all columns in all tables. And for every TABLE.* insert the names
5843 ** of all columns in TABLE. The parser inserted a special expression
drh1a1d3cd2015-11-19 16:33:31 +00005844 ** with the TK_ASTERISK operator for each "*" that it found in the column
5845 ** list. The following code just has to locate the TK_ASTERISK
5846 ** expressions and expand each one to the list of all columns in
5847 ** all tables.
danielk1977b3bce662005-01-29 08:32:43 +00005848 **
drh7d10d5a2008-08-20 16:35:10 +00005849 ** The first loop just checks to see if there are any "*" operators
5850 ** that need expanding.
danielk1977b3bce662005-01-29 08:32:43 +00005851 */
drh7d10d5a2008-08-20 16:35:10 +00005852 for(k=0; k<pEList->nExpr; k++){
drh3e3f1a52013-01-03 00:45:56 +00005853 pE = pEList->a[k].pExpr;
drh1a1d3cd2015-11-19 16:33:31 +00005854 if( pE->op==TK_ASTERISK ) break;
drh43152cf2009-05-19 19:04:58 +00005855 assert( pE->op!=TK_DOT || pE->pRight!=0 );
5856 assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
drh1a1d3cd2015-11-19 16:33:31 +00005857 if( pE->op==TK_DOT && pE->pRight->op==TK_ASTERISK ) break;
drhfca23552017-10-28 20:51:54 +00005858 elistFlags |= pE->flags;
danielk1977b3bce662005-01-29 08:32:43 +00005859 }
drh7d10d5a2008-08-20 16:35:10 +00005860 if( k<pEList->nExpr ){
5861 /*
5862 ** If we get here it means the result set contains one or more "*"
5863 ** operators that need to be expanded. Loop through each expression
5864 ** in the result set and expand them one by one.
5865 */
5866 struct ExprList_item *a = pEList->a;
5867 ExprList *pNew = 0;
5868 int flags = pParse->db->flags;
5869 int longNames = (flags & SQLITE_FullColNames)!=0
drh38b384a2013-01-03 17:34:28 +00005870 && (flags & SQLITE_ShortColNames)==0;
5871
drh7d10d5a2008-08-20 16:35:10 +00005872 for(k=0; k<pEList->nExpr; k++){
drh3e3f1a52013-01-03 00:45:56 +00005873 pE = a[k].pExpr;
drhfca23552017-10-28 20:51:54 +00005874 elistFlags |= pE->flags;
drh3e3f1a52013-01-03 00:45:56 +00005875 pRight = pE->pRight;
5876 assert( pE->op!=TK_DOT || pRight!=0 );
drh1a1d3cd2015-11-19 16:33:31 +00005877 if( pE->op!=TK_ASTERISK
5878 && (pE->op!=TK_DOT || pRight->op!=TK_ASTERISK)
5879 ){
drh7d10d5a2008-08-20 16:35:10 +00005880 /* This particular expression does not need to be expanded.
5881 */
drhb7916a72009-05-27 10:31:29 +00005882 pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
drh7d10d5a2008-08-20 16:35:10 +00005883 if( pNew ){
drh41cee662019-12-12 20:22:34 +00005884 pNew->a[pNew->nExpr-1].zEName = a[k].zEName;
drhd88fd532022-05-02 20:49:30 +00005885 pNew->a[pNew->nExpr-1].fg.eEName = a[k].fg.eEName;
drh41cee662019-12-12 20:22:34 +00005886 a[k].zEName = 0;
drh7d10d5a2008-08-20 16:35:10 +00005887 }
5888 a[k].pExpr = 0;
drh7d10d5a2008-08-20 16:35:10 +00005889 }else{
5890 /* This expression is a "*" or a "TABLE.*" and needs to be
5891 ** expanded. */
5892 int tableSeen = 0; /* Set to 1 when TABLE matches */
drh3e3f1a52013-01-03 00:45:56 +00005893 char *zTName = 0; /* text of name of TABLE */
drh43152cf2009-05-19 19:04:58 +00005894 if( pE->op==TK_DOT ){
5895 assert( pE->pLeft!=0 );
drh33e619f2009-05-28 01:00:55 +00005896 assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
5897 zTName = pE->pLeft->u.zToken;
drh7d10d5a2008-08-20 16:35:10 +00005898 }
5899 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
drh9c2d7aa2022-04-22 12:46:46 +00005900 Table *pTab = pFrom->pTab; /* Table for this data source */
5901 ExprList *pNestedFrom; /* Result-set of a nested FROM clause */
5902 char *zTabName; /* AS name for this data source */
5903 const char *zSchemaName = 0; /* Schema name for this data source */
5904 int iDb; /* Schema index for this data src */
drh63879a22022-05-02 20:04:34 +00005905 IdList *pUsing; /* USING clause for pFrom[1] */
drh9c2d7aa2022-04-22 12:46:46 +00005906
5907 if( (zTabName = pFrom->zAlias)==0 ){
drh7d10d5a2008-08-20 16:35:10 +00005908 zTabName = pTab->zName;
5909 }
5910 if( db->mallocFailed ) break;
mistachkin07fae322022-07-06 23:50:01 +00005911 assert( (int)pFrom->fg.isNestedFrom == IsNestedFrom(pFrom->pSelect) );
drh815b7822022-04-20 15:07:39 +00005912 if( pFrom->fg.isNestedFrom ){
drh9c2d7aa2022-04-22 12:46:46 +00005913 assert( pFrom->pSelect!=0 );
5914 pNestedFrom = pFrom->pSelect->pEList;
5915 assert( pNestedFrom!=0 );
5916 assert( pNestedFrom->nExpr==pTab->nCol );
drh815b7822022-04-20 15:07:39 +00005917 }else{
drh3e3f1a52013-01-03 00:45:56 +00005918 if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
5919 continue;
5920 }
drh9c2d7aa2022-04-22 12:46:46 +00005921 pNestedFrom = 0;
drh3e3f1a52013-01-03 00:45:56 +00005922 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh69c33822016-08-18 14:33:11 +00005923 zSchemaName = iDb>=0 ? db->aDb[iDb].zDbSName : "*";
drh7d10d5a2008-08-20 16:35:10 +00005924 }
drh45e41b72022-04-22 23:18:21 +00005925 if( i+1<pTabList->nSrc
5926 && pFrom[1].fg.isUsing
5927 && (selFlags & SF_NestedFrom)!=0
5928 ){
5929 int ii;
drh72d620b2022-05-02 19:59:03 +00005930 pUsing = pFrom[1].u3.pUsing;
drh45e41b72022-04-22 23:18:21 +00005931 for(ii=0; ii<pUsing->nId; ii++){
5932 const char *zUName = pUsing->a[ii].zName;
5933 pRight = sqlite3Expr(db, TK_ID, zUName);
5934 pNew = sqlite3ExprListAppend(pParse, pNew, pRight);
5935 if( pNew ){
5936 struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
5937 assert( pX->zEName==0 );
5938 pX->zEName = sqlite3MPrintf(db,"..%s", zUName);
drhd88fd532022-05-02 20:49:30 +00005939 pX->fg.eEName = ENAME_TAB;
5940 pX->fg.bUsingTerm = 1;
drh45e41b72022-04-22 23:18:21 +00005941 }
5942 }
drh72d620b2022-05-02 19:59:03 +00005943 }else{
5944 pUsing = 0;
drh45e41b72022-04-22 23:18:21 +00005945 }
drh7d10d5a2008-08-20 16:35:10 +00005946 for(j=0; j<pTab->nCol; j++){
drhcf9d36d2021-08-02 18:03:43 +00005947 char *zName = pTab->aCol[j].zCnName;
drh18f86002022-04-21 13:11:26 +00005948 struct ExprList_item *pX; /* Newly added ExprList term */
drh7d10d5a2008-08-20 16:35:10 +00005949
drhc75e09c2013-01-03 16:54:20 +00005950 assert( zName );
drh9c2d7aa2022-04-22 12:46:46 +00005951 if( zTName
5952 && pNestedFrom
5953 && sqlite3MatchEName(&pNestedFrom->a[j], 0, zTName, 0)==0
drh3e3f1a52013-01-03 00:45:56 +00005954 ){
5955 continue;
5956 }
5957
drh80090f92015-11-19 17:55:11 +00005958 /* If a column is marked as 'hidden', omit it from the expanded
5959 ** result-set list unless the SELECT has the SF_IncludeHidden
5960 ** bit set.
drh7d10d5a2008-08-20 16:35:10 +00005961 */
drhadef1592022-05-10 00:24:01 +00005962 if( (p->selFlags & SF_IncludeHidden)==0
5963 && IsHiddenColumn(&pTab->aCol[j])
5964 ){
5965 continue;
5966 }
5967 if( (pTab->aCol[j].colFlags & COLFLAG_NOEXPAND)!=0
5968 && zTName==0
5969 && (selFlags & (SF_NestedFrom))==0
5970 ){
5971 continue;
drh7d10d5a2008-08-20 16:35:10 +00005972 }
drh3e3f1a52013-01-03 00:45:56 +00005973 tableSeen = 1;
drh7d10d5a2008-08-20 16:35:10 +00005974
drh45e41b72022-04-22 23:18:21 +00005975 if( i>0 && zTName==0 && (selFlags & SF_NestedFrom)==0 ){
drhd44f8b22022-04-07 01:11:13 +00005976 if( pFrom->fg.isUsing
5977 && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0
5978 ){
drh7d10d5a2008-08-20 16:35:10 +00005979 /* In a join with a USING clause, omit columns in the
5980 ** using clause from the table on the right. */
5981 continue;
5982 }
5983 }
drhb7916a72009-05-27 10:31:29 +00005984 pRight = sqlite3Expr(db, TK_ID, zName);
drhbefbb402022-04-19 23:00:32 +00005985 if( (pTabList->nSrc>1
5986 && ( (pFrom->fg.jointype & JT_LTORJ)==0
drhd63c07e2022-04-23 14:30:22 +00005987 || (selFlags & SF_NestedFrom)!=0
drhbefbb402022-04-19 23:00:32 +00005988 || !inAnyUsingClause(zName,pFrom,pTabList->nSrc-i-1)
5989 )
5990 )
5991 || IN_RENAME_OBJECT
drh4ce7bf92022-04-15 18:30:48 +00005992 ){
drhb7916a72009-05-27 10:31:29 +00005993 Expr *pLeft;
5994 pLeft = sqlite3Expr(db, TK_ID, zTabName);
drhabfd35e2016-12-06 22:47:23 +00005995 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight);
dancbde37d2022-04-19 20:47:18 +00005996 if( IN_RENAME_OBJECT && pE->pLeft ){
5997 sqlite3RenameTokenRemap(pParse, pLeft, pE->pLeft);
5998 }
drh38b384a2013-01-03 17:34:28 +00005999 if( zSchemaName ){
drhc75e09c2013-01-03 16:54:20 +00006000 pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
drhabfd35e2016-12-06 22:47:23 +00006001 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr);
drhc75e09c2013-01-03 16:54:20 +00006002 }
drh7d10d5a2008-08-20 16:35:10 +00006003 }else{
6004 pExpr = pRight;
drh7d10d5a2008-08-20 16:35:10 +00006005 }
drhb7916a72009-05-27 10:31:29 +00006006 pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
drh18f86002022-04-21 13:11:26 +00006007 if( pNew==0 ){
6008 break; /* OOM */
6009 }
6010 pX = &pNew->a[pNew->nExpr-1];
6011 assert( pX->zEName==0 );
6012 if( (selFlags & SF_NestedFrom)!=0 && !IN_RENAME_OBJECT ){
drh9c2d7aa2022-04-22 12:46:46 +00006013 if( pNestedFrom ){
6014 pX->zEName = sqlite3DbStrDup(db, pNestedFrom->a[j].zEName);
drhcbb9da32019-12-12 22:11:33 +00006015 testcase( pX->zEName==0 );
drh3e3f1a52013-01-03 00:45:56 +00006016 }else{
drhcbb9da32019-12-12 22:11:33 +00006017 pX->zEName = sqlite3MPrintf(db, "%s.%s.%s",
drh18f86002022-04-21 13:11:26 +00006018 zSchemaName, zTabName, zName);
drhcbb9da32019-12-12 22:11:33 +00006019 testcase( pX->zEName==0 );
drh3e3f1a52013-01-03 00:45:56 +00006020 }
drhd88fd532022-05-02 20:49:30 +00006021 pX->fg.eEName = ENAME_TAB;
drh72d620b2022-05-02 19:59:03 +00006022 if( (pFrom->fg.isUsing
6023 && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0)
6024 || (pUsing && sqlite3IdListIndex(pUsing, zName)>=0)
6025 || (pTab->aCol[j].colFlags & COLFLAG_NOEXPAND)!=0
6026 ){
drhd88fd532022-05-02 20:49:30 +00006027 pX->fg.bNoExpand = 1;
drh72d620b2022-05-02 19:59:03 +00006028 }
drh18f86002022-04-21 13:11:26 +00006029 }else if( longNames ){
6030 pX->zEName = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
drhd88fd532022-05-02 20:49:30 +00006031 pX->fg.eEName = ENAME_NAME;
drh18f86002022-04-21 13:11:26 +00006032 }else{
6033 pX->zEName = sqlite3DbStrDup(db, zName);
drhd88fd532022-05-02 20:49:30 +00006034 pX->fg.eEName = ENAME_NAME;
drh8f25d182012-12-19 02:36:45 +00006035 }
drh7d10d5a2008-08-20 16:35:10 +00006036 }
6037 }
6038 if( !tableSeen ){
6039 if( zTName ){
6040 sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
6041 }else{
6042 sqlite3ErrorMsg(pParse, "no tables specified");
6043 }
6044 }
drh7d10d5a2008-08-20 16:35:10 +00006045 }
drh9a993342007-12-13 02:45:31 +00006046 }
drh7d10d5a2008-08-20 16:35:10 +00006047 sqlite3ExprListDelete(db, pEList);
6048 p->pEList = pNew;
drh4c774312007-12-08 21:10:20 +00006049 }
drhfca23552017-10-28 20:51:54 +00006050 if( p->pEList ){
6051 if( p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
6052 sqlite3ErrorMsg(pParse, "too many columns in result set");
6053 return WRC_Abort;
6054 }
6055 if( (elistFlags & (EP_HasFunc|EP_Subquery))!=0 ){
6056 p->selFlags |= SF_ComplexResult;
6057 }
drh994c80a2007-04-12 21:25:01 +00006058 }
drhcebc8002022-04-16 18:33:22 +00006059#if TREETRACE_ENABLED
6060 if( sqlite3TreeTrace & 0x100 ){
6061 SELECTTRACE(0x100,pParse,p,("After result-set wildcard expansion:\n"));
6062 sqlite3TreeViewSelect(0, p, 0);
6063 }
6064#endif
drh7d10d5a2008-08-20 16:35:10 +00006065 return WRC_Continue;
6066}
danielk1977b3bce662005-01-29 08:32:43 +00006067
drh979dd1b2017-05-29 14:26:07 +00006068#if SQLITE_DEBUG
6069/*
6070** Always assert. This xSelectCallback2 implementation proves that the
6071** xSelectCallback2 is never invoked.
6072*/
6073void sqlite3SelectWalkAssert2(Walker *NotUsed, Select *NotUsed2){
6074 UNUSED_PARAMETER2(NotUsed, NotUsed2);
6075 assert( 0 );
6076}
6077#endif
6078/*
drh7d10d5a2008-08-20 16:35:10 +00006079** This routine "expands" a SELECT statement and all of its subqueries.
6080** For additional information on what it means to "expand" a SELECT
6081** statement, see the comment on the selectExpand worker callback above.
6082**
6083** Expanding a SELECT statement is the first step in processing a
6084** SELECT statement. The SELECT statement must be expanded before
6085** name resolution is performed.
6086**
6087** If anything goes wrong, an error message is written into pParse.
6088** The calling function can detect the problem by looking at pParse->nErr
6089** and/or pParse->db->mallocFailed.
6090*/
6091static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
6092 Walker w;
drh5b88bc42013-12-07 23:35:21 +00006093 w.xExprCallback = sqlite3ExprWalkNoop;
drh7d10d5a2008-08-20 16:35:10 +00006094 w.pParse = pParse;
drh878fcf92017-10-02 23:50:08 +00006095 if( OK_IF_ALWAYS_TRUE(pParse->hasCompound) ){
drhd58d3272013-08-05 22:05:02 +00006096 w.xSelectCallback = convertCompoundSelectToSubquery;
drh979dd1b2017-05-29 14:26:07 +00006097 w.xSelectCallback2 = 0;
drhd58d3272013-08-05 22:05:02 +00006098 sqlite3WalkSelect(&w, pSelect);
6099 }
drhc01b7302013-05-07 17:49:08 +00006100 w.xSelectCallback = selectExpander;
danbe120832021-05-17 16:20:41 +00006101 w.xSelectCallback2 = sqlite3SelectPopWith;
drh59145812019-05-22 22:49:23 +00006102 w.eCode = 0;
drhc01b7302013-05-07 17:49:08 +00006103 sqlite3WalkSelect(&w, pSelect);
drh7d10d5a2008-08-20 16:35:10 +00006104}
6105
6106
6107#ifndef SQLITE_OMIT_SUBQUERY
6108/*
6109** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
6110** interface.
6111**
6112** For each FROM-clause subquery, add Column.zType and Column.zColl
6113** information to the Table structure that represents the result set
6114** of that subquery.
6115**
6116** The Table structure that represents the result set was constructed
6117** by selectExpander() but the type and collation information was omitted
6118** at that point because identifiers had not yet been resolved. This
6119** routine is called after identifier resolution.
6120*/
danb290f112014-01-17 14:59:27 +00006121static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
drh7d10d5a2008-08-20 16:35:10 +00006122 Parse *pParse;
6123 int i;
6124 SrcList *pTabList;
drh76012942021-02-21 21:04:54 +00006125 SrcItem *pFrom;
drh7d10d5a2008-08-20 16:35:10 +00006126
drh9d8b3072008-08-22 16:29:51 +00006127 assert( p->selFlags & SF_Resolved );
dancc464412018-06-19 18:11:05 +00006128 if( p->selFlags & SF_HasTypeInfo ) return;
drhe2b7d7a2015-09-29 15:50:04 +00006129 p->selFlags |= SF_HasTypeInfo;
6130 pParse = pWalker->pParse;
6131 pTabList = p->pSrc;
6132 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
6133 Table *pTab = pFrom->pTab;
6134 assert( pTab!=0 );
6135 if( (pTab->tabFlags & TF_Ephemeral)!=0 ){
6136 /* A sub-query in the FROM clause of a SELECT */
6137 Select *pSel = pFrom->pSelect;
6138 if( pSel ){
6139 while( pSel->pPrior ) pSel = pSel->pPrior;
drh96fb16e2019-08-06 14:37:24 +00006140 sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSel,
6141 SQLITE_AFF_NONE);
drh5a29d9c2010-02-24 15:10:14 +00006142 }
drh13449892005-09-07 21:22:45 +00006143 }
6144 }
drh7d10d5a2008-08-20 16:35:10 +00006145}
6146#endif
drh13449892005-09-07 21:22:45 +00006147
drh7d10d5a2008-08-20 16:35:10 +00006148
6149/*
6150** This routine adds datatype and collating sequence information to
6151** the Table structures of all FROM-clause subqueries in a
6152** SELECT statement.
6153**
6154** Use this routine after name resolution.
6155*/
6156static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
6157#ifndef SQLITE_OMIT_SUBQUERY
6158 Walker w;
drh979dd1b2017-05-29 14:26:07 +00006159 w.xSelectCallback = sqlite3SelectWalkNoop;
danb290f112014-01-17 14:59:27 +00006160 w.xSelectCallback2 = selectAddSubqueryTypeInfo;
drh5b88bc42013-12-07 23:35:21 +00006161 w.xExprCallback = sqlite3ExprWalkNoop;
drh7d10d5a2008-08-20 16:35:10 +00006162 w.pParse = pParse;
6163 sqlite3WalkSelect(&w, pSelect);
6164#endif
6165}
6166
6167
6168/*
drh030796d2012-08-23 16:18:10 +00006169** This routine sets up a SELECT statement for processing. The
drh7d10d5a2008-08-20 16:35:10 +00006170** following is accomplished:
6171**
6172** * VDBE Cursor numbers are assigned to all FROM-clause terms.
6173** * Ephemeral Table objects are created for all FROM-clause subqueries.
6174** * ON and USING clauses are shifted into WHERE statements
6175** * Wildcards "*" and "TABLE.*" in result sets are expanded.
6176** * Identifiers in expression are matched to tables.
6177**
6178** This routine acts recursively on all subqueries within the SELECT.
6179*/
6180void sqlite3SelectPrep(
6181 Parse *pParse, /* The parser context */
6182 Select *p, /* The SELECT statement being coded. */
6183 NameContext *pOuterNC /* Name context for container */
6184){
drhe2463392017-10-03 14:24:24 +00006185 assert( p!=0 || pParse->db->mallocFailed );
drh0c7d3d32022-01-24 16:47:12 +00006186 assert( pParse->db->pParse==pParse );
drhe2463392017-10-03 14:24:24 +00006187 if( pParse->db->mallocFailed ) return;
drh7d10d5a2008-08-20 16:35:10 +00006188 if( p->selFlags & SF_HasTypeInfo ) return;
drh7d10d5a2008-08-20 16:35:10 +00006189 sqlite3SelectExpand(pParse, p);
drh0c7d3d32022-01-24 16:47:12 +00006190 if( pParse->nErr ) return;
drh7d10d5a2008-08-20 16:35:10 +00006191 sqlite3ResolveSelectNames(pParse, p, pOuterNC);
drh0c7d3d32022-01-24 16:47:12 +00006192 if( pParse->nErr ) return;
drh7d10d5a2008-08-20 16:35:10 +00006193 sqlite3SelectAddTypeInfo(pParse, p);
danielk1977b3bce662005-01-29 08:32:43 +00006194}
6195
6196/*
drh13449892005-09-07 21:22:45 +00006197** Reset the aggregate accumulator.
6198**
6199** The aggregate accumulator is a set of memory cells that hold
6200** intermediate results while calculating an aggregate. This
drh030796d2012-08-23 16:18:10 +00006201** routine generates code that stores NULLs in all of those memory
6202** cells.
danielk1977b3bce662005-01-29 08:32:43 +00006203*/
drh13449892005-09-07 21:22:45 +00006204static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
6205 Vdbe *v = pParse->pVdbe;
6206 int i;
drhc99130f2005-09-11 11:56:27 +00006207 struct AggInfo_func *pFunc;
drh7e61d182013-12-20 13:11:45 +00006208 int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
drh0c7d3d32022-01-24 16:47:12 +00006209 assert( pParse->db->pParse==pParse );
6210 assert( pParse->db->mallocFailed==0 || pParse->nErr!=0 );
drh7e61d182013-12-20 13:11:45 +00006211 if( nReg==0 ) return;
drh0c7d3d32022-01-24 16:47:12 +00006212 if( pParse->nErr ) return;
drh7e61d182013-12-20 13:11:45 +00006213#ifdef SQLITE_DEBUG
6214 /* Verify that all AggInfo registers are within the range specified by
6215 ** AggInfo.mnReg..AggInfo.mxReg */
6216 assert( nReg==pAggInfo->mxReg-pAggInfo->mnReg+1 );
drh13449892005-09-07 21:22:45 +00006217 for(i=0; i<pAggInfo->nColumn; i++){
drh7e61d182013-12-20 13:11:45 +00006218 assert( pAggInfo->aCol[i].iMem>=pAggInfo->mnReg
6219 && pAggInfo->aCol[i].iMem<=pAggInfo->mxReg );
drh13449892005-09-07 21:22:45 +00006220 }
drh7e61d182013-12-20 13:11:45 +00006221 for(i=0; i<pAggInfo->nFunc; i++){
6222 assert( pAggInfo->aFunc[i].iMem>=pAggInfo->mnReg
6223 && pAggInfo->aFunc[i].iMem<=pAggInfo->mxReg );
6224 }
6225#endif
6226 sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->mnReg, pAggInfo->mxReg);
drhc99130f2005-09-11 11:56:27 +00006227 for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
drhc99130f2005-09-11 11:56:27 +00006228 if( pFunc->iDistinct>=0 ){
drh81185a52020-06-09 13:38:12 +00006229 Expr *pE = pFunc->pFExpr;
drha4eeccd2021-10-07 17:43:30 +00006230 assert( ExprUseXList(pE) );
danielk19776ab3a2e2009-02-19 14:39:25 +00006231 if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
drh0daa0022009-02-09 13:19:28 +00006232 sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
6233 "argument");
drhc99130f2005-09-11 11:56:27 +00006234 pFunc->iDistinct = -1;
6235 }else{
danf9eae182018-05-21 19:45:11 +00006236 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pE->x.pList,0,0);
dan4fcb30b2021-03-09 16:06:25 +00006237 pFunc->iDistAddr = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
6238 pFunc->iDistinct, 0, 0, (char*)pKeyInfo, P4_KEYINFO);
drh9be13392021-03-24 19:44:01 +00006239 ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s(DISTINCT)",
6240 pFunc->pFunc->zName));
drhc99130f2005-09-11 11:56:27 +00006241 }
6242 }
drh13449892005-09-07 21:22:45 +00006243 }
danielk1977b3bce662005-01-29 08:32:43 +00006244}
6245
6246/*
drh13449892005-09-07 21:22:45 +00006247** Invoke the OP_AggFinalize opcode for every aggregate function
6248** in the AggInfo structure.
danielk1977b3bce662005-01-29 08:32:43 +00006249*/
drh13449892005-09-07 21:22:45 +00006250static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
6251 Vdbe *v = pParse->pVdbe;
6252 int i;
6253 struct AggInfo_func *pF;
6254 for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
drha4eeccd2021-10-07 17:43:30 +00006255 ExprList *pList;
6256 assert( ExprUseXList(pF->pFExpr) );
6257 pList = pF->pFExpr->x.pList;
drh2700aca2016-12-08 01:38:24 +00006258 sqlite3VdbeAddOp2(v, OP_AggFinal, pF->iMem, pList ? pList->nExpr : 0);
6259 sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
drh13449892005-09-07 21:22:45 +00006260 }
danielk1977b3bce662005-01-29 08:32:43 +00006261}
drh13449892005-09-07 21:22:45 +00006262
dan280c8942018-06-05 20:04:28 +00006263
drh13449892005-09-07 21:22:45 +00006264/*
6265** Update the accumulator memory cells for an aggregate based on
6266** the current cursor position.
dan280c8942018-06-05 20:04:28 +00006267**
6268** If regAcc is non-zero and there are no min() or max() aggregates
6269** in pAggInfo, then only populate the pAggInfo->nAccumulator accumulator
drh10cc16c2019-03-01 21:12:40 +00006270** registers if register regAcc contains 0. The caller will take care
dan280c8942018-06-05 20:04:28 +00006271** of setting and clearing regAcc.
drh13449892005-09-07 21:22:45 +00006272*/
dan4fcb30b2021-03-09 16:06:25 +00006273static void updateAccumulator(
6274 Parse *pParse,
6275 int regAcc,
6276 AggInfo *pAggInfo,
6277 int eDistinctType
6278){
drh13449892005-09-07 21:22:45 +00006279 Vdbe *v = pParse->pVdbe;
6280 int i;
drh7a957892012-02-02 17:35:43 +00006281 int regHit = 0;
6282 int addrHitTest = 0;
drh13449892005-09-07 21:22:45 +00006283 struct AggInfo_func *pF;
6284 struct AggInfo_col *pC;
drh13449892005-09-07 21:22:45 +00006285
6286 pAggInfo->directMode = 1;
6287 for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
6288 int nArg;
drhc99130f2005-09-11 11:56:27 +00006289 int addrNext = 0;
drh98757152008-01-09 23:04:12 +00006290 int regAgg;
drha4eeccd2021-10-07 17:43:30 +00006291 ExprList *pList;
6292 assert( ExprUseXList(pF->pFExpr) );
drh81185a52020-06-09 13:38:12 +00006293 assert( !IsWindowFunc(pF->pFExpr) );
drha4eeccd2021-10-07 17:43:30 +00006294 pList = pF->pFExpr->x.pList;
drh81185a52020-06-09 13:38:12 +00006295 if( ExprHasProperty(pF->pFExpr, EP_WinFunc) ){
6296 Expr *pFilter = pF->pFExpr->y.pWin->pFilter;
daned09ddd2019-09-20 20:52:16 +00006297 if( pAggInfo->nAccumulator
6298 && (pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL)
danfa4b0d42020-07-01 14:07:45 +00006299 && regAcc
daned09ddd2019-09-20 20:52:16 +00006300 ){
danfa4b0d42020-07-01 14:07:45 +00006301 /* If regAcc==0, there there exists some min() or max() function
6302 ** without a FILTER clause that will ensure the magnet registers
6303 ** are populated. */
daned09ddd2019-09-20 20:52:16 +00006304 if( regHit==0 ) regHit = ++pParse->nMem;
danfa4b0d42020-07-01 14:07:45 +00006305 /* If this is the first row of the group (regAcc contains 0), clear the
daned09ddd2019-09-20 20:52:16 +00006306 ** "magnet" register regHit so that the accumulator registers
danaf9b58b2019-09-20 21:12:40 +00006307 ** are populated if the FILTER clause jumps over the the
6308 ** invocation of min() or max() altogether. Or, if this is not
danfa4b0d42020-07-01 14:07:45 +00006309 ** the first row (regAcc contains 1), set the magnet register so that
6310 ** the accumulators are not populated unless the min()/max() is invoked
6311 ** and indicates that they should be. */
daned09ddd2019-09-20 20:52:16 +00006312 sqlite3VdbeAddOp2(v, OP_Copy, regAcc, regHit);
6313 }
dan6ba7ab02019-07-02 11:56:47 +00006314 addrNext = sqlite3VdbeMakeLabel(pParse);
6315 sqlite3ExprIfFalse(pParse, pFilter, addrNext, SQLITE_JUMPIFNULL);
6316 }
drh13449892005-09-07 21:22:45 +00006317 if( pList ){
6318 nArg = pList->nExpr;
drh892d3172008-01-10 03:46:36 +00006319 regAgg = sqlite3GetTempRange(pParse, nArg);
drh5579d592015-08-26 14:01:41 +00006320 sqlite3ExprCodeExprList(pParse, pList, regAgg, 0, SQLITE_ECEL_DUP);
drh13449892005-09-07 21:22:45 +00006321 }else{
6322 nArg = 0;
drh98757152008-01-09 23:04:12 +00006323 regAgg = 0;
drh13449892005-09-07 21:22:45 +00006324 }
dan4fcb30b2021-03-09 16:06:25 +00006325 if( pF->iDistinct>=0 && pList ){
dan6ba7ab02019-07-02 11:56:47 +00006326 if( addrNext==0 ){
6327 addrNext = sqlite3VdbeMakeLabel(pParse);
6328 }
dan5383db72021-03-12 18:24:31 +00006329 pF->iDistinct = codeDistinct(pParse, eDistinctType,
6330 pF->iDistinct, addrNext, pList, regAgg);
drhc99130f2005-09-11 11:56:27 +00006331 }
drhd36e1042013-09-06 13:10:12 +00006332 if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh13449892005-09-07 21:22:45 +00006333 CollSeq *pColl = 0;
6334 struct ExprList_item *pItem;
6335 int j;
drhe82f5d02008-10-07 19:53:14 +00006336 assert( pList!=0 ); /* pList!=0 if pF->pFunc has NEEDCOLL */
drh43617e92006-03-06 20:55:46 +00006337 for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
drh13449892005-09-07 21:22:45 +00006338 pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
6339 }
6340 if( !pColl ){
6341 pColl = pParse->db->pDfltColl;
6342 }
drh7a957892012-02-02 17:35:43 +00006343 if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
6344 sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
drh13449892005-09-07 21:22:45 +00006345 }
drh8f26da62018-07-05 21:22:57 +00006346 sqlite3VdbeAddOp3(v, OP_AggStep, 0, regAgg, pF->iMem);
drh2700aca2016-12-08 01:38:24 +00006347 sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
drhea678832008-12-10 19:26:22 +00006348 sqlite3VdbeChangeP5(v, (u8)nArg);
drhf49f3522009-12-30 14:12:38 +00006349 sqlite3ReleaseTempRange(pParse, regAgg, nArg);
drhc99130f2005-09-11 11:56:27 +00006350 if( addrNext ){
6351 sqlite3VdbeResolveLabel(v, addrNext);
6352 }
drh13449892005-09-07 21:22:45 +00006353 }
dan280c8942018-06-05 20:04:28 +00006354 if( regHit==0 && pAggInfo->nAccumulator ){
6355 regHit = regAcc;
6356 }
drh7a957892012-02-02 17:35:43 +00006357 if( regHit ){
drh688852a2014-02-17 22:40:43 +00006358 addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
drh7a957892012-02-02 17:35:43 +00006359 }
drh13449892005-09-07 21:22:45 +00006360 for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
drh81185a52020-06-09 13:38:12 +00006361 sqlite3ExprCode(pParse, pC->pCExpr, pC->iMem);
drh13449892005-09-07 21:22:45 +00006362 }
daned09ddd2019-09-20 20:52:16 +00006363
drh13449892005-09-07 21:22:45 +00006364 pAggInfo->directMode = 0;
drh7a957892012-02-02 17:35:43 +00006365 if( addrHitTest ){
drhdc4f6fc2020-02-07 19:44:13 +00006366 sqlite3VdbeJumpHereOrPopInst(v, addrHitTest);
drh7a957892012-02-02 17:35:43 +00006367 }
drh13449892005-09-07 21:22:45 +00006368}
6369
danielk1977b3bce662005-01-29 08:32:43 +00006370/*
danef7075d2011-02-21 17:49:49 +00006371** Add a single OP_Explain instruction to the VDBE to explain a simple
6372** count(*) query ("SELECT count(*) FROM pTab").
6373*/
6374#ifndef SQLITE_OMIT_EXPLAIN
6375static void explainSimpleCount(
6376 Parse *pParse, /* Parse context */
6377 Table *pTab, /* Table being queried */
6378 Index *pIdx /* Index used to optimize scan, or NULL */
6379){
6380 if( pParse->explain==2 ){
drh48dd1d82014-05-27 18:18:58 +00006381 int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
drh82102332021-03-20 15:11:29 +00006382 sqlite3VdbeExplain(pParse, 0, "SCAN %s%s%s",
dane96f2df2014-05-23 17:17:06 +00006383 pTab->zName,
6384 bCover ? " USING COVERING INDEX " : "",
6385 bCover ? pIdx->zName : ""
danef7075d2011-02-21 17:49:49 +00006386 );
danef7075d2011-02-21 17:49:49 +00006387 }
6388}
6389#else
6390# define explainSimpleCount(a,b,c)
6391#endif
6392
6393/*
danab31a842017-04-29 20:53:09 +00006394** sqlite3WalkExpr() callback used by havingToWhere().
6395**
6396** If the node passed to the callback is a TK_AND node, return
6397** WRC_Continue to tell sqlite3WalkExpr() to iterate through child nodes.
6398**
6399** Otherwise, return WRC_Prune. In this case, also check if the
6400** sub-expression matches the criteria for being moved to the WHERE
6401** clause. If so, add it to the WHERE clause and replace the sub-expression
6402** within the HAVING expression with a constant "1".
6403*/
6404static int havingToWhereExprCb(Walker *pWalker, Expr *pExpr){
6405 if( pExpr->op!=TK_AND ){
drhcd0abc22018-03-20 18:08:33 +00006406 Select *pS = pWalker->u.pSelect;
dand59f9832021-07-20 14:57:49 +00006407 /* This routine is called before the HAVING clause of the current
6408 ** SELECT is analyzed for aggregates. So if pExpr->pAggInfo is set
6409 ** here, it indicates that the expression is a correlated reference to a
6410 ** column from an outer aggregate query, or an aggregate function that
6411 ** belongs to an outer query. Do not move the expression to the WHERE
6412 ** clause in this obscure case, as doing so may corrupt the outer Select
6413 ** statements AggInfo structure. */
danf39168e2020-12-22 16:23:29 +00006414 if( sqlite3ExprIsConstantOrGroupBy(pWalker->pParse, pExpr, pS->pGroupBy)
6415 && ExprAlwaysFalse(pExpr)==0
dand59f9832021-07-20 14:57:49 +00006416 && pExpr->pAggInfo==0
danf39168e2020-12-22 16:23:29 +00006417 ){
danab31a842017-04-29 20:53:09 +00006418 sqlite3 *db = pWalker->pParse->db;
drh5776ee52019-09-23 12:38:10 +00006419 Expr *pNew = sqlite3Expr(db, TK_INTEGER, "1");
danab31a842017-04-29 20:53:09 +00006420 if( pNew ){
drhcd0abc22018-03-20 18:08:33 +00006421 Expr *pWhere = pS->pWhere;
danab31a842017-04-29 20:53:09 +00006422 SWAP(Expr, *pNew, *pExpr);
drhd5c851c2019-04-19 13:38:34 +00006423 pNew = sqlite3ExprAnd(pWalker->pParse, pWhere, pNew);
drhcd0abc22018-03-20 18:08:33 +00006424 pS->pWhere = pNew;
6425 pWalker->eCode = 1;
danab31a842017-04-29 20:53:09 +00006426 }
6427 }
6428 return WRC_Prune;
6429 }
6430 return WRC_Continue;
6431}
6432
6433/*
6434** Transfer eligible terms from the HAVING clause of a query, which is
6435** processed after grouping, to the WHERE clause, which is processed before
6436** grouping. For example, the query:
6437**
6438** SELECT * FROM <tables> WHERE a=? GROUP BY b HAVING b=? AND c=?
6439**
6440** can be rewritten as:
6441**
6442** SELECT * FROM <tables> WHERE a=? AND b=? GROUP BY b HAVING c=?
6443**
6444** A term of the HAVING expression is eligible for transfer if it consists
6445** entirely of constants and expressions that are also GROUP BY terms that
6446** use the "BINARY" collation sequence.
6447*/
drhcd0abc22018-03-20 18:08:33 +00006448static void havingToWhere(Parse *pParse, Select *p){
danab31a842017-04-29 20:53:09 +00006449 Walker sWalker;
danab31a842017-04-29 20:53:09 +00006450 memset(&sWalker, 0, sizeof(sWalker));
6451 sWalker.pParse = pParse;
6452 sWalker.xExprCallback = havingToWhereExprCb;
drhcd0abc22018-03-20 18:08:33 +00006453 sWalker.u.pSelect = p;
6454 sqlite3WalkExpr(&sWalker, p->pHaving);
drh5e431be2022-04-06 11:08:38 +00006455#if TREETRACE_ENABLED
6456 if( sWalker.eCode && (sqlite3TreeTrace & 0x100)!=0 ){
drhcd0abc22018-03-20 18:08:33 +00006457 SELECTTRACE(0x100,pParse,p,("Move HAVING terms into WHERE:\n"));
6458 sqlite3TreeViewSelect(0, p, 0);
6459 }
6460#endif
danab31a842017-04-29 20:53:09 +00006461}
6462
6463/*
drhe08e8d62017-05-01 15:15:41 +00006464** Check to see if the pThis entry of pTabList is a self-join of a prior view.
6465** If it is, then return the SrcList_item for the prior view. If it is not,
6466** then return 0.
6467*/
drh76012942021-02-21 21:04:54 +00006468static SrcItem *isSelfJoinView(
drhe08e8d62017-05-01 15:15:41 +00006469 SrcList *pTabList, /* Search for self-joins in this FROM clause */
drh76012942021-02-21 21:04:54 +00006470 SrcItem *pThis /* Search for prior reference to this subquery */
drhe08e8d62017-05-01 15:15:41 +00006471){
drh76012942021-02-21 21:04:54 +00006472 SrcItem *pItem;
drh8794c682021-02-13 16:39:24 +00006473 assert( pThis->pSelect!=0 );
6474 if( pThis->pSelect->selFlags & SF_PushDown ) return 0;
drhe08e8d62017-05-01 15:15:41 +00006475 for(pItem = pTabList->a; pItem<pThis; pItem++){
drhbdefaf02018-12-27 02:16:01 +00006476 Select *pS1;
drhe08e8d62017-05-01 15:15:41 +00006477 if( pItem->pSelect==0 ) continue;
6478 if( pItem->fg.viaCoroutine ) continue;
drh33543c22017-05-01 16:37:20 +00006479 if( pItem->zName==0 ) continue;
drh30ad79a2019-05-23 16:38:12 +00006480 assert( pItem->pTab!=0 );
6481 assert( pThis->pTab!=0 );
6482 if( pItem->pTab->pSchema!=pThis->pTab->pSchema ) continue;
drhed712982017-05-01 17:04:35 +00006483 if( sqlite3_stricmp(pItem->zName, pThis->zName)!=0 ) continue;
drhbdefaf02018-12-27 02:16:01 +00006484 pS1 = pItem->pSelect;
drh30ad79a2019-05-23 16:38:12 +00006485 if( pItem->pTab->pSchema==0 && pThis->pSelect->selId!=pS1->selId ){
drhbdefaf02018-12-27 02:16:01 +00006486 /* The query flattener left two different CTE tables with identical
6487 ** names in the same FROM clause. */
6488 continue;
6489 }
drh8794c682021-02-13 16:39:24 +00006490 if( pItem->pSelect->selFlags & SF_PushDown ){
drhed712982017-05-01 17:04:35 +00006491 /* The view was modified by some other optimization such as
6492 ** pushDownWhereTerms() */
6493 continue;
6494 }
6495 return pItem;
drhe08e8d62017-05-01 15:15:41 +00006496 }
6497 return 0;
6498}
6499
drhc54246f2021-02-17 21:13:14 +00006500/*
6501** Deallocate a single AggInfo object
6502*/
6503static void agginfoFree(sqlite3 *db, AggInfo *p){
6504 sqlite3DbFree(db, p->aCol);
6505 sqlite3DbFree(db, p->aFunc);
6506 sqlite3DbFreeNN(db, p);
6507}
6508
drh269ba802017-07-04 19:34:36 +00006509#ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6510/*
6511** Attempt to transform a query of the form
6512**
6513** SELECT count(*) FROM (SELECT x FROM t1 UNION ALL SELECT y FROM t2)
6514**
6515** Into this:
6516**
6517** SELECT (SELECT count(*) FROM t1)+(SELECT count(*) FROM t2)
6518**
6519** The transformation only works if all of the following are true:
6520**
6521** * The subquery is a UNION ALL of two or more terms
dana4b5fb52018-08-03 20:19:52 +00006522** * The subquery does not have a LIMIT clause
drh269ba802017-07-04 19:34:36 +00006523** * There is no WHERE or GROUP BY or HAVING clauses on the subqueries
drh73c53b32019-05-15 18:42:15 +00006524** * The outer query is a simple count(*) with no WHERE clause or other
6525** extraneous syntax.
drh269ba802017-07-04 19:34:36 +00006526**
6527** Return TRUE if the optimization is undertaken.
6528*/
6529static int countOfViewOptimization(Parse *pParse, Select *p){
6530 Select *pSub, *pPrior;
6531 Expr *pExpr;
6532 Expr *pCount;
6533 sqlite3 *db;
drh3d240d22017-09-28 16:56:55 +00006534 if( (p->selFlags & SF_Aggregate)==0 ) return 0; /* This is an aggregate */
drh269ba802017-07-04 19:34:36 +00006535 if( p->pEList->nExpr!=1 ) return 0; /* Single result column */
drh73c53b32019-05-15 18:42:15 +00006536 if( p->pWhere ) return 0;
6537 if( p->pGroupBy ) return 0;
drh269ba802017-07-04 19:34:36 +00006538 pExpr = p->pEList->a[0].pExpr;
6539 if( pExpr->op!=TK_AGG_FUNCTION ) return 0; /* Result is an aggregate */
drha4eeccd2021-10-07 17:43:30 +00006540 assert( ExprUseUToken(pExpr) );
drh3d240d22017-09-28 16:56:55 +00006541 if( sqlite3_stricmp(pExpr->u.zToken,"count") ) return 0; /* Is count() */
drha4eeccd2021-10-07 17:43:30 +00006542 assert( ExprUseXList(pExpr) );
drh269ba802017-07-04 19:34:36 +00006543 if( pExpr->x.pList!=0 ) return 0; /* Must be count(*) */
drh3d240d22017-09-28 16:56:55 +00006544 if( p->pSrc->nSrc!=1 ) return 0; /* One table in FROM */
drh269ba802017-07-04 19:34:36 +00006545 pSub = p->pSrc->a[0].pSelect;
6546 if( pSub==0 ) return 0; /* The FROM is a subquery */
drh3d240d22017-09-28 16:56:55 +00006547 if( pSub->pPrior==0 ) return 0; /* Must be a compound ry */
drh269ba802017-07-04 19:34:36 +00006548 do{
6549 if( pSub->op!=TK_ALL && pSub->pPrior ) return 0; /* Must be UNION ALL */
6550 if( pSub->pWhere ) return 0; /* No WHERE clause */
dana4b5fb52018-08-03 20:19:52 +00006551 if( pSub->pLimit ) return 0; /* No LIMIT clause */
drh269ba802017-07-04 19:34:36 +00006552 if( pSub->selFlags & SF_Aggregate ) return 0; /* Not an aggregate */
drh3d240d22017-09-28 16:56:55 +00006553 pSub = pSub->pPrior; /* Repeat over compound */
drh269ba802017-07-04 19:34:36 +00006554 }while( pSub );
6555
drh3d240d22017-09-28 16:56:55 +00006556 /* If we reach this point then it is OK to perform the transformation */
drh269ba802017-07-04 19:34:36 +00006557
6558 db = pParse->db;
6559 pCount = pExpr;
6560 pExpr = 0;
6561 pSub = p->pSrc->a[0].pSelect;
6562 p->pSrc->a[0].pSelect = 0;
6563 sqlite3SrcListDelete(db, p->pSrc);
6564 p->pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*p->pSrc));
6565 while( pSub ){
6566 Expr *pTerm;
6567 pPrior = pSub->pPrior;
6568 pSub->pPrior = 0;
6569 pSub->pNext = 0;
6570 pSub->selFlags |= SF_Aggregate;
6571 pSub->selFlags &= ~SF_Compound;
6572 pSub->nSelectRow = 0;
6573 sqlite3ExprListDelete(db, pSub->pEList);
6574 pTerm = pPrior ? sqlite3ExprDup(db, pCount, 0) : pCount;
6575 pSub->pEList = sqlite3ExprListAppend(pParse, 0, pTerm);
6576 pTerm = sqlite3PExpr(pParse, TK_SELECT, 0, 0);
6577 sqlite3PExprAddSelect(pParse, pTerm, pSub);
6578 if( pExpr==0 ){
6579 pExpr = pTerm;
6580 }else{
6581 pExpr = sqlite3PExpr(pParse, TK_PLUS, pTerm, pExpr);
6582 }
6583 pSub = pPrior;
6584 }
6585 p->pEList->a[0].pExpr = pExpr;
6586 p->selFlags &= ~SF_Aggregate;
6587
drh5e431be2022-04-06 11:08:38 +00006588#if TREETRACE_ENABLED
6589 if( sqlite3TreeTrace & 0x400 ){
drh269ba802017-07-04 19:34:36 +00006590 SELECTTRACE(0x400,pParse,p,("After count-of-view optimization:\n"));
6591 sqlite3TreeViewSelect(0, p, 0);
6592 }
6593#endif
6594 return 1;
6595}
6596#endif /* SQLITE_COUNTOFVIEW_OPTIMIZATION */
6597
drhe08e8d62017-05-01 15:15:41 +00006598/*
drhfb98dac2022-05-25 02:32:11 +00006599** If any term of pSrc, or any SF_NestedFrom sub-query, is not the same
6600** as pSrcItem but has the same alias as p0, then return true.
6601** Otherwise return false.
6602*/
6603static int sameSrcAlias(SrcItem *p0, SrcList *pSrc){
6604 int i;
6605 for(i=0; i<pSrc->nSrc; i++){
6606 SrcItem *p1 = &pSrc->a[i];
6607 if( p1==p0 ) continue;
6608 if( p0->pTab==p1->pTab && 0==sqlite3_stricmp(p0->zAlias, p1->zAlias) ){
6609 return 1;
6610 }
6611 if( p1->pSelect
6612 && (p1->pSelect->selFlags & SF_NestedFrom)!=0
6613 && sameSrcAlias(p0, p1->pSelect->pSrc)
6614 ){
6615 return 1;
6616 }
6617 }
6618 return 0;
6619}
6620
6621/*
drh7d10d5a2008-08-20 16:35:10 +00006622** Generate code for the SELECT statement given in the p argument.
drh9bb61fe2000-06-05 16:01:39 +00006623**
drh340309f2014-01-22 00:23:49 +00006624** The results are returned according to the SelectDest structure.
6625** See comments in sqliteInt.h for further information.
drhe78e8282003-01-19 03:59:45 +00006626**
drh9bb61fe2000-06-05 16:01:39 +00006627** This routine returns the number of errors. If any errors are
6628** encountered, then an appropriate error message is left in
6629** pParse->zErrMsg.
6630**
6631** This routine does NOT free the Select structure passed in. The
6632** calling function needs to do that.
6633*/
danielk19774adee202004-05-08 08:23:19 +00006634int sqlite3Select(
drhcce7d172000-05-31 15:34:51 +00006635 Parse *pParse, /* The parser context */
drh9bb61fe2000-06-05 16:01:39 +00006636 Select *p, /* The SELECT statement being coded. */
drh7d10d5a2008-08-20 16:35:10 +00006637 SelectDest *pDest /* What to do with the query results */
drhcce7d172000-05-31 15:34:51 +00006638){
drh13449892005-09-07 21:22:45 +00006639 int i, j; /* Loop counters */
6640 WhereInfo *pWInfo; /* Return from sqlite3WhereBegin() */
6641 Vdbe *v; /* The virtual machine under construction */
danielk1977b3bce662005-01-29 08:32:43 +00006642 int isAgg; /* True for select lists like "count(*)" */
mistachkinc29cbb02015-07-02 16:52:01 +00006643 ExprList *pEList = 0; /* List of columns to extract. */
drhad3cab52002-05-24 02:04:32 +00006644 SrcList *pTabList; /* List of tables to select from */
drh9bb61fe2000-06-05 16:01:39 +00006645 Expr *pWhere; /* The WHERE clause. May be NULL */
drh22827922000-06-06 17:27:05 +00006646 ExprList *pGroupBy; /* The GROUP BY clause. May be NULL */
6647 Expr *pHaving; /* The HAVING clause. May be NULL */
drhbf790972020-06-07 20:18:07 +00006648 AggInfo *pAggInfo = 0; /* Aggregate information */
drh1d83f052002-02-17 00:30:36 +00006649 int rc = 1; /* Value to return from this function */
drhe8e4af72012-09-21 00:04:28 +00006650 DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
drh079a3072014-03-19 14:10:55 +00006651 SortCtx sSort; /* Info on how to code the ORDER BY clause */
drhec7429a2005-10-06 16:53:14 +00006652 int iEnd; /* Address of the end of the query */
drh17435752007-08-16 04:30:38 +00006653 sqlite3 *db; /* The database connection */
drh47d9f832017-10-26 20:04:28 +00006654 ExprList *pMinMaxOrderBy = 0; /* Added ORDER BY for min/max queries */
6655 u8 minMaxFlag; /* Flag for min/max queries */
drh9bb61fe2000-06-05 16:01:39 +00006656
drh17435752007-08-16 04:30:38 +00006657 db = pParse->db;
drh0c7d3d32022-01-24 16:47:12 +00006658 assert( pParse==db->pParse );
drhe2ca99c2018-05-02 00:33:43 +00006659 v = sqlite3GetVdbe(pParse);
drh0c7d3d32022-01-24 16:47:12 +00006660 if( p==0 || pParse->nErr ){
drh6f7adc82006-01-11 21:41:20 +00006661 return 1;
6662 }
drh0c7d3d32022-01-24 16:47:12 +00006663 assert( db->mallocFailed==0 );
danielk19774adee202004-05-08 08:23:19 +00006664 if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
drh5e431be2022-04-06 11:08:38 +00006665#if TREETRACE_ENABLED
drhe2ca99c2018-05-02 00:33:43 +00006666 SELECTTRACE(1,pParse,p, ("begin processing:\n", pParse->addrExplain));
drhc2d0df92022-04-06 18:30:17 +00006667 if( sqlite3TreeTrace & 0x10100 ){
6668 if( (sqlite3TreeTrace & 0x10001)==0x10000 ){
6669 sqlite3TreeViewLine(0, "In sqlite3Select() at %s:%d",
6670 __FILE__, __LINE__);
6671 }
6672 sqlite3ShowSelect(p);
drhc90713d2014-09-30 13:46:49 +00006673 }
drheb9b8842014-09-21 00:27:26 +00006674#endif
drhdaffd0e2001-04-11 14:28:42 +00006675
drh8e1ee882014-03-21 19:56:09 +00006676 assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
6677 assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
dan9afccba2014-03-21 19:27:54 +00006678 assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
6679 assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
drhf1ea4252020-09-17 00:46:09 +00006680 if( IgnorableDistinct(pDest) ){
6681 assert(pDest->eDest==SRT_Exists || pDest->eDest==SRT_Union ||
6682 pDest->eDest==SRT_Except || pDest->eDest==SRT_Discard ||
6683 pDest->eDest==SRT_DistQueue || pDest->eDest==SRT_DistFifo );
6684 /* All of these destinations are also able to ignore the ORDER BY clause */
drhfad1ad02021-03-03 14:07:52 +00006685 if( p->pOrderBy ){
drh5e431be2022-04-06 11:08:38 +00006686#if TREETRACE_ENABLED
drhfad1ad02021-03-03 14:07:52 +00006687 SELECTTRACE(1,pParse,p, ("dropping superfluous ORDER BY:\n"));
drh5e431be2022-04-06 11:08:38 +00006688 if( sqlite3TreeTrace & 0x100 ){
drhfad1ad02021-03-03 14:07:52 +00006689 sqlite3TreeViewExprList(0, p->pOrderBy, 0, "ORDERBY");
6690 }
6691#endif
6692 sqlite3ParserAddCleanup(pParse,
6693 (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
6694 p->pOrderBy);
drh6d0053c2021-03-09 19:32:37 +00006695 testcase( pParse->earlyCleanup );
drhfad1ad02021-03-03 14:07:52 +00006696 p->pOrderBy = 0;
6697 }
drh7d10d5a2008-08-20 16:35:10 +00006698 p->selFlags &= ~SF_Distinct;
drhb7cbf5c2020-06-15 13:51:34 +00006699 p->selFlags |= SF_NoopOrderBy;
drh9a993342007-12-13 02:45:31 +00006700 }
drh7d10d5a2008-08-20 16:35:10 +00006701 sqlite3SelectPrep(pParse, p, 0);
drh0c7d3d32022-01-24 16:47:12 +00006702 if( pParse->nErr ){
drh9a993342007-12-13 02:45:31 +00006703 goto select_end;
6704 }
drh0c7d3d32022-01-24 16:47:12 +00006705 assert( db->mallocFailed==0 );
drhadc57f62015-06-06 00:18:01 +00006706 assert( p->pEList!=0 );
drh5e431be2022-04-06 11:08:38 +00006707#if TREETRACE_ENABLED
6708 if( sqlite3TreeTrace & 0x104 ){
drhe2243d22018-04-23 17:18:03 +00006709 SELECTTRACE(0x104,pParse,p, ("after name resolution:\n"));
drh17645f52015-02-09 13:42:59 +00006710 sqlite3TreeViewSelect(0, p, 0);
6711 }
6712#endif
drhcce7d172000-05-31 15:34:51 +00006713
dan5daf69e2021-07-05 11:27:13 +00006714 /* If the SF_UFSrcCheck flag is set, then this function is being called
dan07ca7d62020-07-17 16:31:37 +00006715 ** as part of populating the temp table for an UPDATE...FROM statement.
6716 ** In this case, it is an error if the target object (pSrc->a[0]) name
dan5daf69e2021-07-05 11:27:13 +00006717 ** or alias is duplicated within FROM clause (pSrc->a[1..n]).
6718 **
6719 ** Postgres disallows this case too. The reason is that some other
6720 ** systems handle this case differently, and not all the same way,
6721 ** which is just confusing. To avoid this, we follow PG's lead and
6722 ** disallow it altogether. */
6723 if( p->selFlags & SF_UFSrcCheck ){
drh76012942021-02-21 21:04:54 +00006724 SrcItem *p0 = &p->pSrc->a[0];
drhfb98dac2022-05-25 02:32:11 +00006725 if( sameSrcAlias(p0, p->pSrc) ){
6726 sqlite3ErrorMsg(pParse,
6727 "target object/alias may not appear in FROM clause: %s",
6728 p0->zAlias ? p0->zAlias : p0->pTab->zName
6729 );
6730 goto select_end;
dan07ca7d62020-07-17 16:31:37 +00006731 }
dan5daf69e2021-07-05 11:27:13 +00006732
6733 /* Clear the SF_UFSrcCheck flag. The check has already been performed,
6734 ** and leaving this flag set can cause errors if a compound sub-query
6735 ** in p->pSrc is flattened into this query and this function called
6736 ** again as part of compound SELECT processing. */
6737 p->selFlags &= ~SF_UFSrcCheck;
dan07ca7d62020-07-17 16:31:37 +00006738 }
6739
drhf35f2f92017-07-29 16:01:55 +00006740 if( pDest->eDest==SRT_Output ){
drh90881862021-05-19 12:17:03 +00006741 sqlite3GenerateColumnNames(pParse, p);
drhf35f2f92017-07-29 16:01:55 +00006742 }
6743
dan67a9b8e2018-06-22 20:51:35 +00006744#ifndef SQLITE_OMIT_WINDOWFUNC
dan44918c72021-04-17 14:42:37 +00006745 if( sqlite3WindowRewrite(pParse, p) ){
drh0c7d3d32022-01-24 16:47:12 +00006746 assert( pParse->nErr );
dan86fb6e12018-05-16 20:58:07 +00006747 goto select_end;
6748 }
drh5e431be2022-04-06 11:08:38 +00006749#if TREETRACE_ENABLED
6750 if( p->pWin && (sqlite3TreeTrace & 0x108)!=0 ){
dandfa552f2018-06-02 21:04:28 +00006751 SELECTTRACE(0x104,pParse,p, ("after window rewrite:\n"));
6752 sqlite3TreeViewSelect(0, p, 0);
6753 }
6754#endif
dan67a9b8e2018-06-22 20:51:35 +00006755#endif /* SQLITE_OMIT_WINDOWFUNC */
dan86fb6e12018-05-16 20:58:07 +00006756 pTabList = p->pSrc;
dan73925692018-06-12 18:40:17 +00006757 isAgg = (p->selFlags & SF_Aggregate)!=0;
danf02cdd32018-06-27 19:48:50 +00006758 memset(&sSort, 0, sizeof(sSort));
6759 sSort.pOrderBy = p->pOrderBy;
dan86fb6e12018-05-16 20:58:07 +00006760
drh9216de82020-06-11 00:57:09 +00006761 /* Try to do various optimizations (flattening subqueries, and strength
drh25897872018-03-20 21:16:15 +00006762 ** reduction of join operators) in the FROM clause up into the main query
drhd820cb12002-02-18 03:21:45 +00006763 */
drh51522cd2005-01-20 13:36:19 +00006764#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
danielk1977f23329a2008-07-01 14:09:13 +00006765 for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
drh76012942021-02-21 21:04:54 +00006766 SrcItem *pItem = &pTabList->a[i];
danielk1977daf79ac2008-06-30 18:12:28 +00006767 Select *pSub = pItem->pSelect;
drh2679f142015-09-25 13:42:55 +00006768 Table *pTab = pItem->pTab;
drh25897872018-03-20 21:16:15 +00006769
drhb5aaee52020-06-11 16:04:10 +00006770 /* The expander should have already created transient Table objects
6771 ** even for FROM clause elements such as subqueries that do not correspond
6772 ** to a real table */
6773 assert( pTab!=0 );
6774
drh25897872018-03-20 21:16:15 +00006775 /* Convert LEFT JOIN into JOIN if there are terms of the right table
6776 ** of the LEFT JOIN used in the WHERE clause.
6777 */
drhff02ac72022-04-11 14:43:11 +00006778 if( (pItem->fg.jointype & (JT_LEFT|JT_RIGHT))==JT_LEFT
drh25897872018-03-20 21:16:15 +00006779 && sqlite3ExprImpliesNonNullRow(p->pWhere, pItem->iCursor)
6780 && OptimizationEnabled(db, SQLITE_SimplifyJoin)
6781 ){
6782 SELECTTRACE(0x100,pParse,p,
6783 ("LEFT-JOIN simplifies to JOIN on term %d\n",i));
drhefce69d2018-03-20 22:52:27 +00006784 pItem->fg.jointype &= ~(JT_LEFT|JT_OUTER);
drhd7480402022-06-20 17:04:44 +00006785 assert( pItem->iCursor>=0 );
drh92d1afb2022-06-13 12:42:24 +00006786 unsetJoinExpr(p->pWhere, pItem->iCursor,
6787 pTabList->a[0].fg.jointype & JT_LTORJ);
drh25897872018-03-20 21:16:15 +00006788 }
6789
6790 /* No futher action if this term of the FROM clause is no a subquery */
drh4490c402015-06-05 22:33:39 +00006791 if( pSub==0 ) continue;
drh2679f142015-09-25 13:42:55 +00006792
6793 /* Catch mismatch in the declared columns of a view and the number of
6794 ** columns in the SELECT on the RHS */
6795 if( pTab->nCol!=pSub->pEList->nExpr ){
6796 sqlite3ErrorMsg(pParse, "expected %d columns for '%s' but got %d",
6797 pTab->nCol, pTab->zName, pSub->pEList->nExpr);
6798 goto select_end;
6799 }
6800
drh25c221e2017-09-29 22:13:24 +00006801 /* Do not try to flatten an aggregate subquery.
6802 **
6803 ** Flattening an aggregate subquery is only possible if the outer query
6804 ** is not a join. But if the outer query is not a join, then the subquery
6805 ** will be implemented as a co-routine and there is no advantage to
6806 ** flattening in that case.
6807 */
6808 if( (pSub->selFlags & SF_Aggregate)!=0 ) continue;
6809 assert( pSub->pGroupBy==0 );
6810
drhbb301232021-07-15 19:29:43 +00006811 /* If a FROM-clause subquery has an ORDER BY clause that is not
6812 ** really doing anything, then delete it now so that it does not
drh0fb78f02021-07-16 01:19:19 +00006813 ** interfere with query flattening. See the discussion at
6814 ** https://sqlite.org/forum/forumpost/2d76f2bcf65d256a
drhbb301232021-07-15 19:29:43 +00006815 **
6816 ** Beware of these cases where the ORDER BY clause may not be safely
6817 ** omitted:
6818 **
6819 ** (1) There is also a LIMIT clause
6820 ** (2) The subquery was added to help with window-function
6821 ** processing
drh0fb78f02021-07-16 01:19:19 +00006822 ** (3) The subquery is in the FROM clause of an UPDATE
6823 ** (4) The outer query uses an aggregate function other than
drhbb301232021-07-15 19:29:43 +00006824 ** the built-in count(), min(), or max().
drh0fb78f02021-07-16 01:19:19 +00006825 ** (5) The ORDER BY isn't going to accomplish anything because
6826 ** one of:
6827 ** (a) The outer query has a different ORDER BY clause
6828 ** (b) The subquery is part of a join
6829 ** See forum post 062d576715d277c8
drhbb301232021-07-15 19:29:43 +00006830 */
6831 if( pSub->pOrderBy!=0
drh0fb78f02021-07-16 01:19:19 +00006832 && (p->pOrderBy!=0 || pTabList->nSrc>1) /* Condition (5) */
drhbb301232021-07-15 19:29:43 +00006833 && pSub->pLimit==0 /* Condition (1) */
6834 && (pSub->selFlags & SF_OrderByReqd)==0 /* Condition (2) */
drh0fb78f02021-07-16 01:19:19 +00006835 && (p->selFlags & SF_OrderByReqd)==0 /* Condition (3) and (4) */
drhbb301232021-07-15 19:29:43 +00006836 && OptimizationEnabled(db, SQLITE_OmitOrderBy)
6837 ){
6838 SELECTTRACE(0x100,pParse,p,
6839 ("omit superfluous ORDER BY on %r FROM-clause subquery\n",i+1));
drhe8344842022-07-14 01:48:27 +00006840 sqlite3ParserAddCleanup(pParse,
6841 (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
6842 pSub->pOrderBy);
drhbb301232021-07-15 19:29:43 +00006843 pSub->pOrderBy = 0;
6844 }
6845
drhfca23552017-10-28 20:51:54 +00006846 /* If the outer query contains a "complex" result set (that is,
6847 ** if the result set of the outer query uses functions or subqueries)
6848 ** and if the subquery contains an ORDER BY clause and if
drh648fe492017-09-28 20:06:53 +00006849 ** it will be implemented as a co-routine, then do not flatten. This
6850 ** restriction allows SQL constructs like this:
6851 **
6852 ** SELECT expensive_function(x)
6853 ** FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
6854 **
6855 ** The expensive_function() is only computed on the 10 rows that
6856 ** are output, rather than every row of the table.
drhfca23552017-10-28 20:51:54 +00006857 **
6858 ** The requirement that the outer query have a complex result set
6859 ** means that flattening does occur on simpler SQL constraints without
6860 ** the expensive_function() like:
6861 **
6862 ** SELECT x FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
drh648fe492017-09-28 20:06:53 +00006863 */
drh25c221e2017-09-29 22:13:24 +00006864 if( pSub->pOrderBy!=0
drh648fe492017-09-28 20:06:53 +00006865 && i==0
drhfca23552017-10-28 20:51:54 +00006866 && (p->selFlags & SF_ComplexResult)!=0
drh648fe492017-09-28 20:06:53 +00006867 && (pTabList->nSrc==1
drha76ac882022-04-08 19:20:12 +00006868 || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0)
drh648fe492017-09-28 20:06:53 +00006869 ){
6870 continue;
6871 }
6872
drh25c221e2017-09-29 22:13:24 +00006873 if( flattenSubquery(pParse, p, i, isAgg) ){
drh4acd7542019-02-06 00:55:47 +00006874 if( pParse->nErr ) goto select_end;
drh4490c402015-06-05 22:33:39 +00006875 /* This subquery can be absorbed into its parent. */
drh4490c402015-06-05 22:33:39 +00006876 i = -1;
6877 }
6878 pTabList = p->pSrc;
6879 if( db->mallocFailed ) goto select_end;
6880 if( !IgnorableOrderby(pDest) ){
6881 sSort.pOrderBy = p->pOrderBy;
6882 }
6883 }
6884#endif
6885
drh4490c402015-06-05 22:33:39 +00006886#ifndef SQLITE_OMIT_COMPOUND_SELECT
6887 /* Handle compound SELECT statements using the separate multiSelect()
6888 ** procedure.
6889 */
6890 if( p->pPrior ){
6891 rc = multiSelect(pParse, p, pDest);
drh5e431be2022-04-06 11:08:38 +00006892#if TREETRACE_ENABLED
drhf20609d2018-04-23 17:43:35 +00006893 SELECTTRACE(0x1,pParse,p,("end compound-select processing\n"));
drh5e431be2022-04-06 11:08:38 +00006894 if( (sqlite3TreeTrace & 0x2000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
drhf20609d2018-04-23 17:43:35 +00006895 sqlite3TreeViewSelect(0, p, 0);
6896 }
drh4490c402015-06-05 22:33:39 +00006897#endif
drhc631ded2018-05-02 02:22:22 +00006898 if( p->pNext==0 ) ExplainQueryPlanPop(pParse);
drh4490c402015-06-05 22:33:39 +00006899 return rc;
6900 }
6901#endif
6902
drh7810ab62018-07-27 17:51:20 +00006903 /* Do the WHERE-clause constant propagation optimization if this is
6904 ** a join. No need to speed time on this operation for non-join queries
6905 ** as the equivalent optimization will be handled by query planner in
6906 ** sqlite3WhereBegin().
6907 */
drhb775c972021-05-14 14:26:57 +00006908 if( p->pWhere!=0
6909 && p->pWhere->op==TK_AND
drh7810ab62018-07-27 17:51:20 +00006910 && OptimizationEnabled(db, SQLITE_PropagateConst)
drh24e11162018-07-26 23:47:11 +00006911 && propagateConstants(pParse, p)
6912 ){
drh5e431be2022-04-06 11:08:38 +00006913#if TREETRACE_ENABLED
6914 if( sqlite3TreeTrace & 0x100 ){
drh24e11162018-07-26 23:47:11 +00006915 SELECTTRACE(0x100,pParse,p,("After constant propagation:\n"));
6916 sqlite3TreeViewSelect(0, p, 0);
6917 }
6918#endif
6919 }else{
drh7810ab62018-07-27 17:51:20 +00006920 SELECTTRACE(0x100,pParse,p,("Constant propagation not helpful\n"));
drh24e11162018-07-26 23:47:11 +00006921 }
6922
dana4b5fb52018-08-03 20:19:52 +00006923#ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6924 if( OptimizationEnabled(db, SQLITE_QueryFlattener|SQLITE_CountOfView)
6925 && countOfViewOptimization(pParse, p)
6926 ){
6927 if( db->mallocFailed ) goto select_end;
6928 pEList = p->pEList;
6929 pTabList = p->pSrc;
6930 }
6931#endif
6932
drh701caf12017-05-10 16:12:00 +00006933 /* For each term in the FROM clause, do two things:
6934 ** (1) Authorized unreferenced tables
6935 ** (2) Generate code for all sub-queries
drhd820cb12002-02-18 03:21:45 +00006936 */
drh4490c402015-06-05 22:33:39 +00006937 for(i=0; i<pTabList->nSrc; i++){
drh76012942021-02-21 21:04:54 +00006938 SrcItem *pItem = &pTabList->a[i];
drha79e2a22021-02-21 23:44:14 +00006939 SrcItem *pPrior;
drh13449892005-09-07 21:22:45 +00006940 SelectDest dest;
drh701caf12017-05-10 16:12:00 +00006941 Select *pSub;
drh824d21a2017-09-29 12:44:52 +00006942#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6943 const char *zSavedAuthContext;
6944#endif
drh701caf12017-05-10 16:12:00 +00006945
drh3d240d22017-09-28 16:56:55 +00006946 /* Issue SQLITE_READ authorizations with a fake column name for any
6947 ** tables that are referenced but from which no values are extracted.
6948 ** Examples of where these kinds of null SQLITE_READ authorizations
6949 ** would occur:
drh701caf12017-05-10 16:12:00 +00006950 **
drh2336c932017-05-11 12:05:23 +00006951 ** SELECT count(*) FROM t1; -- SQLITE_READ t1.""
6952 ** SELECT t1.* FROM t1, t2; -- SQLITE_READ t2.""
6953 **
6954 ** The fake column name is an empty string. It is possible for a table to
6955 ** have a column named by the empty string, in which case there is no way to
6956 ** distinguish between an unreferenced table and an actual reference to the
drh3d240d22017-09-28 16:56:55 +00006957 ** "" column. The original design was for the fake column name to be a NULL,
drh2336c932017-05-11 12:05:23 +00006958 ** which would be unambiguous. But legacy authorization callbacks might
drh3d240d22017-09-28 16:56:55 +00006959 ** assume the column name is non-NULL and segfault. The use of an empty
6960 ** string for the fake column name seems safer.
drh701caf12017-05-10 16:12:00 +00006961 */
drh74c490e2019-08-07 13:25:21 +00006962 if( pItem->colUsed==0 && pItem->zName!=0 ){
drh2336c932017-05-11 12:05:23 +00006963 sqlite3AuthCheck(pParse, SQLITE_READ, pItem->zName, "", pItem->zDatabase);
drh701caf12017-05-10 16:12:00 +00006964 }
6965
6966#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6967 /* Generate code for all sub-queries in the FROM clause
6968 */
6969 pSub = pItem->pSelect;
drh5b6a9ed2011-09-15 23:58:14 +00006970 if( pSub==0 ) continue;
drh21172c42012-10-30 00:29:07 +00006971
drh14c4d422021-05-26 18:46:51 +00006972 /* The code for a subquery should only be generated once. */
6973 assert( pItem->addrFillSub==0 );
danielk1977daf79ac2008-06-30 18:12:28 +00006974
danielk1977fc976062007-05-10 10:46:56 +00006975 /* Increment Parse.nHeight by the height of the largest expression
drhf7b54962013-05-28 12:11:54 +00006976 ** tree referred to by this, the parent select. The child select
danielk1977fc976062007-05-10 10:46:56 +00006977 ** may contain expression trees of at most
6978 ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
6979 ** more conservative than necessary, but much easier than enforcing
6980 ** an exact limit.
6981 */
6982 pParse->nHeight += sqlite3SelectExprHeight(p);
danielk1977daf79ac2008-06-30 18:12:28 +00006983
drhadc57f62015-06-06 00:18:01 +00006984 /* Make copies of constant WHERE-clause terms in the outer query down
6985 ** inside the subquery. This can help the subquery to run more efficiently.
6986 */
drh7fbb1012018-03-21 01:59:46 +00006987 if( OptimizationEnabled(db, SQLITE_PushDown)
drhdf67ec02021-08-11 13:48:56 +00006988 && (pItem->fg.isCte==0
6989 || (pItem->u2.pCteUse->eM10d!=M10d_Yes && pItem->u2.pCteUse->nUse<2))
drha9cdb902022-04-25 19:40:33 +00006990 && pushDownWhereTerms(pParse, pSub, p->pWhere, pItem)
drh4490c402015-06-05 22:33:39 +00006991 ){
drh5e431be2022-04-06 11:08:38 +00006992#if TREETRACE_ENABLED
6993 if( sqlite3TreeTrace & 0x100 ){
drhd2a44012018-07-28 14:34:22 +00006994 SELECTTRACE(0x100,pParse,p,
6995 ("After WHERE-clause push-down into subquery %d:\n", pSub->selId));
drh4490c402015-06-05 22:33:39 +00006996 sqlite3TreeViewSelect(0, p, 0);
danielk1977daf79ac2008-06-30 18:12:28 +00006997 }
drh69b72d52015-06-01 20:28:03 +00006998#endif
drh8794c682021-02-13 16:39:24 +00006999 assert( pItem->pSelect && (pItem->pSelect->selFlags & SF_PushDown)!=0 );
drh2d277bb2018-03-20 11:24:30 +00007000 }else{
7001 SELECTTRACE(0x100,pParse,p,("Push-down not possible\n"));
drh4490c402015-06-05 22:33:39 +00007002 }
drhadc57f62015-06-06 00:18:01 +00007003
drh824d21a2017-09-29 12:44:52 +00007004 zSavedAuthContext = pParse->zAuthContext;
7005 pParse->zAuthContext = pItem->zName;
7006
drhadc57f62015-06-06 00:18:01 +00007007 /* Generate code to implement the subquery
drh0ff47e92016-03-15 17:52:12 +00007008 **
drhcf5cab02022-06-22 15:55:28 +00007009 ** The subquery is implemented as a co-routine if all of the following are
drh9debb582022-04-10 23:01:20 +00007010 ** true:
7011 **
drha79e2a22021-02-21 23:44:14 +00007012 ** (1) the subquery is guaranteed to be the outer loop (so that
7013 ** it does not need to be computed more than once), and
drh745912e2021-02-22 03:04:25 +00007014 ** (2) the subquery is not a CTE that should be materialized
drh9debb582022-04-10 23:01:20 +00007015 ** (3) the subquery is not part of a left operand for a RIGHT JOIN
drhadc57f62015-06-06 00:18:01 +00007016 */
drh0ff47e92016-03-15 17:52:12 +00007017 if( i==0
7018 && (pTabList->nSrc==1
drha76ac882022-04-08 19:20:12 +00007019 || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0) /* (1) */
7020 && (pItem->fg.isCte==0 || pItem->u2.pCteUse->eM10d!=M10d_Yes) /* (2) */
drh9debb582022-04-10 23:01:20 +00007021 && (pTabList->a[0].fg.jointype & JT_LTORJ)==0 /* (3) */
drha5759672012-10-30 14:39:12 +00007022 ){
drh21172c42012-10-30 00:29:07 +00007023 /* Implement a co-routine that will return a single row of the result
7024 ** set on each invocation.
7025 */
drh4490c402015-06-05 22:33:39 +00007026 int addrTop = sqlite3VdbeCurrentAddr(v)+1;
drh824d21a2017-09-29 12:44:52 +00007027
drh21172c42012-10-30 00:29:07 +00007028 pItem->regReturn = ++pParse->nMem;
drh4490c402015-06-05 22:33:39 +00007029 sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
drha9799932021-03-19 13:00:28 +00007030 VdbeComment((v, "%!S", pItem));
drh21172c42012-10-30 00:29:07 +00007031 pItem->addrFillSub = addrTop;
drh21172c42012-10-30 00:29:07 +00007032 sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
drha9799932021-03-19 13:00:28 +00007033 ExplainQueryPlan((pParse, 1, "CO-ROUTINE %!S", pItem));
drh21172c42012-10-30 00:29:07 +00007034 sqlite3Select(pParse, pSub, &dest);
drhc3489bb2016-02-25 16:04:59 +00007035 pItem->pTab->nRowLogEst = pSub->nSelectRow;
drh8a48b9c2015-08-19 15:20:00 +00007036 pItem->fg.viaCoroutine = 1;
drh4490c402015-06-05 22:33:39 +00007037 pItem->regResult = dest.iSdst;
drh2fade2f2016-02-09 02:12:20 +00007038 sqlite3VdbeEndCoroutine(v, pItem->regReturn);
drh21172c42012-10-30 00:29:07 +00007039 sqlite3VdbeJumpHere(v, addrTop-1);
7040 sqlite3ClearTempRegCache(pParse);
drha79e2a22021-02-21 23:44:14 +00007041 }else if( pItem->fg.isCte && pItem->u2.pCteUse->addrM9e>0 ){
7042 /* This is a CTE for which materialization code has already been
7043 ** generated. Invoke the subroutine to compute the materialization,
7044 ** the make the pItem->iCursor be a copy of the ephemerial table that
7045 ** holds the result of the materialization. */
7046 CteUse *pCteUse = pItem->u2.pCteUse;
7047 sqlite3VdbeAddOp2(v, OP_Gosub, pCteUse->regRtn, pCteUse->addrM9e);
7048 if( pItem->iCursor!=pCteUse->iCur ){
7049 sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pCteUse->iCur);
drh834c6882021-08-11 13:19:13 +00007050 VdbeComment((v, "%!S", pItem));
drha79e2a22021-02-21 23:44:14 +00007051 }
7052 pSub->nSelectRow = pCteUse->nRowEst;
7053 }else if( (pPrior = isSelfJoinView(pTabList, pItem))!=0 ){
7054 /* This view has already been materialized by a prior entry in
7055 ** this same FROM clause. Reuse it. */
7056 if( pPrior->addrFillSub ){
7057 sqlite3VdbeAddOp2(v, OP_Gosub, pPrior->regReturn, pPrior->addrFillSub);
7058 }
7059 sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pPrior->iCursor);
7060 pSub->nSelectRow = pPrior->pSelect->nSelectRow;
danielk1977daf79ac2008-06-30 18:12:28 +00007061 }else{
drh14c4d422021-05-26 18:46:51 +00007062 /* Materialize the view. If the view is not correlated, generate a
drhd685dd62021-03-19 13:53:34 +00007063 ** subroutine to do the materialization so that subsequent uses of
7064 ** the same view can reuse the materialization. */
drh7157e8e2011-09-16 16:00:51 +00007065 int topAddr;
drh48f2d3b2011-09-16 01:34:43 +00007066 int onceAddr = 0;
drhe08e8d62017-05-01 15:15:41 +00007067
drh5b6a9ed2011-09-15 23:58:14 +00007068 pItem->regReturn = ++pParse->nMem;
drh40822eb2022-05-21 18:03:33 +00007069 topAddr = sqlite3VdbeAddOp0(v, OP_Goto);
drh7157e8e2011-09-16 16:00:51 +00007070 pItem->addrFillSub = topAddr+1;
drh40822eb2022-05-21 18:03:33 +00007071 pItem->fg.isMaterialized = 1;
drh8a48b9c2015-08-19 15:20:00 +00007072 if( pItem->fg.isCorrelated==0 ){
drhed171672013-04-24 13:50:09 +00007073 /* If the subquery is not correlated and if we are not inside of
drh5b6a9ed2011-09-15 23:58:14 +00007074 ** a trigger, then we only need to compute the value of the subquery
7075 ** once. */
drh511f9e82016-09-22 18:53:13 +00007076 onceAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drha9799932021-03-19 13:00:28 +00007077 VdbeComment((v, "materialize %!S", pItem));
drh69b72d52015-06-01 20:28:03 +00007078 }else{
drha9799932021-03-19 13:00:28 +00007079 VdbeNoopComment((v, "materialize %!S", pItem));
drh5b6a9ed2011-09-15 23:58:14 +00007080 }
drha79e2a22021-02-21 23:44:14 +00007081 sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
drha9799932021-03-19 13:00:28 +00007082 ExplainQueryPlan((pParse, 1, "MATERIALIZE %!S", pItem));
drha79e2a22021-02-21 23:44:14 +00007083 sqlite3Select(pParse, pSub, &dest);
drhc3489bb2016-02-25 16:04:59 +00007084 pItem->pTab->nRowLogEst = pSub->nSelectRow;
drh48f2d3b2011-09-16 01:34:43 +00007085 if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
drh40822eb2022-05-21 18:03:33 +00007086 sqlite3VdbeAddOp2(v, OP_Return, pItem->regReturn, topAddr+1);
drha9799932021-03-19 13:00:28 +00007087 VdbeComment((v, "end %!S", pItem));
drh40822eb2022-05-21 18:03:33 +00007088 sqlite3VdbeJumpHere(v, topAddr);
drhcdc69552011-12-06 13:24:59 +00007089 sqlite3ClearTempRegCache(pParse);
drhd685dd62021-03-19 13:53:34 +00007090 if( pItem->fg.isCte && pItem->fg.isCorrelated==0 ){
drha79e2a22021-02-21 23:44:14 +00007091 CteUse *pCteUse = pItem->u2.pCteUse;
7092 pCteUse->addrM9e = pItem->addrFillSub;
7093 pCteUse->regRtn = pItem->regReturn;
7094 pCteUse->iCur = pItem->iCursor;
7095 pCteUse->nRowEst = pSub->nSelectRow;
7096 }
danielk1977daf79ac2008-06-30 18:12:28 +00007097 }
drhadc57f62015-06-06 00:18:01 +00007098 if( db->mallocFailed ) goto select_end;
danielk1977fc976062007-05-10 10:46:56 +00007099 pParse->nHeight -= sqlite3SelectExprHeight(p);
drh824d21a2017-09-29 12:44:52 +00007100 pParse->zAuthContext = zSavedAuthContext;
drh51522cd2005-01-20 13:36:19 +00007101#endif
drh701caf12017-05-10 16:12:00 +00007102 }
drhadc57f62015-06-06 00:18:01 +00007103
drh38b41492015-06-08 15:08:15 +00007104 /* Various elements of the SELECT copied into local variables for
7105 ** convenience */
drhadc57f62015-06-06 00:18:01 +00007106 pEList = p->pEList;
danielk1977daf79ac2008-06-30 18:12:28 +00007107 pWhere = p->pWhere;
7108 pGroupBy = p->pGroupBy;
7109 pHaving = p->pHaving;
drhe8e4af72012-09-21 00:04:28 +00007110 sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
drh832508b2002-03-02 17:04:07 +00007111
drh5e431be2022-04-06 11:08:38 +00007112#if TREETRACE_ENABLED
7113 if( sqlite3TreeTrace & 0x400 ){
drhbc8edba2015-06-05 20:27:26 +00007114 SELECTTRACE(0x400,pParse,p,("After all FROM-clause analysis:\n"));
7115 sqlite3TreeViewSelect(0, p, 0);
danielk1977f23329a2008-07-01 14:09:13 +00007116 }
7117#endif
7118
dan50118cd2011-07-01 14:21:38 +00007119 /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
7120 ** if the select-list is the same as the ORDER BY list, then this query
7121 ** can be rewritten as a GROUP BY. In other words, this:
7122 **
7123 ** SELECT DISTINCT xyz FROM ... ORDER BY xyz
7124 **
7125 ** is transformed to:
7126 **
drhdea7d702014-12-04 21:54:58 +00007127 ** SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
dan50118cd2011-07-01 14:21:38 +00007128 **
7129 ** The second form is preferred as a single index (or temp-table) may be
7130 ** used for both the ORDER BY and DISTINCT processing. As originally
7131 ** written the query must use a temp-table for at least one of the ORDER
7132 ** BY and DISTINCT, and an index or separate temp-table for the other.
7133 */
7134 if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
drhadc57f62015-06-06 00:18:01 +00007135 && sqlite3ExprListCompare(sSort.pOrderBy, pEList, -1)==0
drhef9f7192020-01-17 19:14:08 +00007136#ifndef SQLITE_OMIT_WINDOWFUNC
dane59c5622019-11-22 10:14:01 +00007137 && p->pWin==0
drhef9f7192020-01-17 19:14:08 +00007138#endif
dan50118cd2011-07-01 14:21:38 +00007139 ){
7140 p->selFlags &= ~SF_Distinct;
drhadc57f62015-06-06 00:18:01 +00007141 pGroupBy = p->pGroupBy = sqlite3ExprListDup(db, pEList, 0);
dan9e10f9a2020-01-06 17:06:12 +00007142 p->selFlags |= SF_Aggregate;
drhe8e4af72012-09-21 00:04:28 +00007143 /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
7144 ** the sDistinct.isTnct is still set. Hence, isTnct represents the
7145 ** original setting of the SF_Distinct flag, not the current setting */
7146 assert( sDistinct.isTnct );
danece092e2022-03-16 12:06:00 +00007147 sDistinct.isTnct = 2;
drh7512cb42016-04-14 13:06:49 +00007148
drh5e431be2022-04-06 11:08:38 +00007149#if TREETRACE_ENABLED
7150 if( sqlite3TreeTrace & 0x400 ){
drh7512cb42016-04-14 13:06:49 +00007151 SELECTTRACE(0x400,pParse,p,("Transform DISTINCT into GROUP BY:\n"));
7152 sqlite3TreeViewSelect(0, p, 0);
7153 }
7154#endif
dan50118cd2011-07-01 14:21:38 +00007155 }
7156
drhadc57f62015-06-06 00:18:01 +00007157 /* If there is an ORDER BY clause, then create an ephemeral index to
7158 ** do the sorting. But this sorting ephemeral index might end up
7159 ** being unused if the data can be extracted in pre-sorted order.
7160 ** If that is the case, then the OP_OpenEphemeral instruction will be
7161 ** changed to an OP_Noop once we figure out that the sorting index is
7162 ** not needed. The sSort.addrSortIndex variable is used to facilitate
7163 ** that change.
danielk19777cedc8d2004-06-10 10:50:08 +00007164 */
drh079a3072014-03-19 14:10:55 +00007165 if( sSort.pOrderBy ){
drh0342b1f2005-09-01 03:07:44 +00007166 KeyInfo *pKeyInfo;
danf9eae182018-05-21 19:45:11 +00007167 pKeyInfo = sqlite3KeyInfoFromExprList(
7168 pParse, sSort.pOrderBy, 0, pEList->nExpr);
drh079a3072014-03-19 14:10:55 +00007169 sSort.iECursor = pParse->nTab++;
7170 sSort.addrSortIndex =
drh66a51672008-01-03 00:01:23 +00007171 sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
drhf45f2322014-03-23 17:45:03 +00007172 sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
7173 (char*)pKeyInfo, P4_KEYINFO
7174 );
drh9d2985c2005-09-08 01:58:42 +00007175 }else{
drh079a3072014-03-19 14:10:55 +00007176 sSort.addrSortIndex = -1;
danielk19777cedc8d2004-06-10 10:50:08 +00007177 }
7178
drh2d0794e2002-03-03 03:03:52 +00007179 /* If the output is destined for a temporary table, open that table.
7180 */
danielk19776c8c8ce2008-01-02 16:27:09 +00007181 if( pDest->eDest==SRT_EphemTab ){
drh2b596da2012-07-23 21:43:19 +00007182 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
drh18f86002022-04-21 13:11:26 +00007183 if( p->selFlags & SF_NestedFrom ){
7184 /* Delete or NULL-out result columns that will never be used */
7185 int ii;
drhd88fd532022-05-02 20:49:30 +00007186 for(ii=pEList->nExpr-1; ii>0 && pEList->a[ii].fg.bUsed==0; ii--){
drh18f86002022-04-21 13:11:26 +00007187 sqlite3ExprDelete(db, pEList->a[ii].pExpr);
7188 sqlite3DbFree(db, pEList->a[ii].zEName);
7189 pEList->nExpr--;
7190 }
7191 for(ii=0; ii<pEList->nExpr; ii++){
drhd88fd532022-05-02 20:49:30 +00007192 if( pEList->a[ii].fg.bUsed==0 ) pEList->a[ii].pExpr->op = TK_NULL;
drh18f86002022-04-21 13:11:26 +00007193 }
7194 }
drh2d0794e2002-03-03 03:03:52 +00007195 }
7196
drhf42bacc2006-04-26 17:39:34 +00007197 /* Set the limiter.
7198 */
drhec4ccdb2018-12-29 02:26:59 +00007199 iEnd = sqlite3VdbeMakeLabel(pParse);
dan69b93832016-12-16 15:05:40 +00007200 if( (p->selFlags & SF_FixedLimit)==0 ){
7201 p->nSelectRow = 320; /* 4 billion rows */
7202 }
drh3c8fb6f2022-07-26 01:20:18 +00007203 if( p->pLimit ) computeLimitRegisters(pParse, p, iEnd);
drh079a3072014-03-19 14:10:55 +00007204 if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
drh0ff287f2015-09-02 18:40:33 +00007205 sqlite3VdbeChangeOpcode(v, sSort.addrSortIndex, OP_SorterOpen);
drh079a3072014-03-19 14:10:55 +00007206 sSort.sortFlags |= SORTFLAG_UseSorter;
drhc6aff302011-09-01 15:32:47 +00007207 }
drhf42bacc2006-04-26 17:39:34 +00007208
drhadc57f62015-06-06 00:18:01 +00007209 /* Open an ephemeral index to use for the distinct set.
drhefb72512000-05-31 20:00:52 +00007210 */
dan2ce22452010-11-08 19:01:16 +00007211 if( p->selFlags & SF_Distinct ){
drhe8e4af72012-09-21 00:04:28 +00007212 sDistinct.tabTnct = pParse->nTab++;
7213 sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
danf9eae182018-05-21 19:45:11 +00007214 sDistinct.tabTnct, 0, 0,
7215 (char*)sqlite3KeyInfoFromExprList(pParse, p->pEList,0,0),
7216 P4_KEYINFO);
drhd4187c72010-08-30 22:15:45 +00007217 sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
drhe8e4af72012-09-21 00:04:28 +00007218 sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
drh832508b2002-03-02 17:04:07 +00007219 }else{
drhe8e4af72012-09-21 00:04:28 +00007220 sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
drhefb72512000-05-31 20:00:52 +00007221 }
drh832508b2002-03-02 17:04:07 +00007222
drh13449892005-09-07 21:22:45 +00007223 if( !isAgg && pGroupBy==0 ){
drhe8e4af72012-09-21 00:04:28 +00007224 /* No aggregate functions and no GROUP BY clause */
dan67a9b8e2018-06-22 20:51:35 +00007225 u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0)
7226 | (p->selFlags & SF_FixedLimit);
7227#ifndef SQLITE_OMIT_WINDOWFUNC
drh067b92b2020-06-19 15:24:12 +00007228 Window *pWin = p->pWin; /* Main window object (or NULL) */
danf9eae182018-05-21 19:45:11 +00007229 if( pWin ){
dan4ea562e2020-01-01 20:17:15 +00007230 sqlite3WindowCodeInit(pParse, p);
dan86fb6e12018-05-16 20:58:07 +00007231 }
dan67a9b8e2018-06-22 20:51:35 +00007232#endif
7233 assert( WHERE_USE_LIMIT==SF_FixedLimit );
7234
dan86fb6e12018-05-16 20:58:07 +00007235
dan38cc40c2011-06-30 20:17:15 +00007236 /* Begin the database scan. */
drhcfd74702018-03-19 22:28:34 +00007237 SELECTTRACE(1,pParse,p,("WhereBegin\n"));
drh079a3072014-03-19 14:10:55 +00007238 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
drh895bab32022-01-27 16:14:50 +00007239 p->pEList, p, wctrlFlags, p->nSelectRow);
drh13449892005-09-07 21:22:45 +00007240 if( pWInfo==0 ) goto select_end;
drh6f328482013-06-05 23:39:34 +00007241 if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
7242 p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
7243 }
drh6457a352013-06-21 00:35:37 +00007244 if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
drh6f328482013-06-05 23:39:34 +00007245 sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
7246 }
drh079a3072014-03-19 14:10:55 +00007247 if( sSort.pOrderBy ){
7248 sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
drh6ee5a7b2018-09-08 20:09:46 +00007249 sSort.labelOBLopt = sqlite3WhereOrderByLimitOptLabel(pWInfo);
drh079a3072014-03-19 14:10:55 +00007250 if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
7251 sSort.pOrderBy = 0;
7252 }
7253 }
drh13162ef2021-02-16 20:01:08 +00007254 SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
drhcce7d172000-05-31 15:34:51 +00007255
drhb9bb7c12006-06-11 23:41:55 +00007256 /* If sorting index that was created by a prior OP_OpenEphemeral
7257 ** instruction ended up not being needed, then change the OP_OpenEphemeral
drh9d2985c2005-09-08 01:58:42 +00007258 ** into an OP_Noop.
7259 */
drh079a3072014-03-19 14:10:55 +00007260 if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
7261 sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
drh9d2985c2005-09-08 01:58:42 +00007262 }
7263
drh2def2f72017-09-15 17:40:34 +00007264 assert( p->pEList==pEList );
dan67a9b8e2018-06-22 20:51:35 +00007265#ifndef SQLITE_OMIT_WINDOWFUNC
danf9eae182018-05-21 19:45:11 +00007266 if( pWin ){
drhec4ccdb2018-12-29 02:26:59 +00007267 int addrGosub = sqlite3VdbeMakeLabel(pParse);
7268 int iCont = sqlite3VdbeMakeLabel(pParse);
7269 int iBreak = sqlite3VdbeMakeLabel(pParse);
danf9eae182018-05-21 19:45:11 +00007270 int regGosub = ++pParse->nMem;
drhefb72512000-05-31 20:00:52 +00007271
dandacf1de2018-06-08 16:11:55 +00007272 sqlite3WindowCodeStep(pParse, p, pWInfo, regGosub, addrGosub);
dan86fb6e12018-05-16 20:58:07 +00007273
danefa3a3c2018-06-23 16:26:20 +00007274 sqlite3VdbeAddOp2(v, OP_Goto, 0, iBreak);
danf9eae182018-05-21 19:45:11 +00007275 sqlite3VdbeResolveLabel(v, addrGosub);
drhb0225bc2018-07-10 20:50:27 +00007276 VdbeNoopComment((v, "inner-loop subroutine"));
drhd4cb09e2018-09-17 15:19:13 +00007277 sSort.labelOBLopt = 0;
danefa3a3c2018-06-23 16:26:20 +00007278 selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest, iCont, iBreak);
dandacf1de2018-06-08 16:11:55 +00007279 sqlite3VdbeResolveLabel(v, iCont);
dan86fb6e12018-05-16 20:58:07 +00007280 sqlite3VdbeAddOp1(v, OP_Return, regGosub);
drh0b3b0dd2018-07-10 05:11:03 +00007281 VdbeComment((v, "end inner-loop subroutine"));
danefa3a3c2018-06-23 16:26:20 +00007282 sqlite3VdbeResolveLabel(v, iBreak);
dan67a9b8e2018-06-22 20:51:35 +00007283 }else
7284#endif /* SQLITE_OMIT_WINDOWFUNC */
7285 {
dan86fb6e12018-05-16 20:58:07 +00007286 /* Use the standard inner loop. */
7287 selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest,
7288 sqlite3WhereContinueLabel(pWInfo),
7289 sqlite3WhereBreakLabel(pWInfo));
7290
7291 /* End the database scan loop.
7292 */
drh13162ef2021-02-16 20:01:08 +00007293 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
dan86fb6e12018-05-16 20:58:07 +00007294 sqlite3WhereEnd(pWInfo);
7295 }
drh13449892005-09-07 21:22:45 +00007296 }else{
drhe8e4af72012-09-21 00:04:28 +00007297 /* This case when there exist aggregate functions or a GROUP BY clause
7298 ** or both */
drh13449892005-09-07 21:22:45 +00007299 NameContext sNC; /* Name context for processing aggregate information */
7300 int iAMem; /* First Mem address for storing current GROUP BY */
7301 int iBMem; /* First Mem address for previous GROUP BY */
7302 int iUseFlag; /* Mem address holding flag indicating that at least
7303 ** one row of the input to the aggregator has been
7304 ** processed */
7305 int iAbortFlag; /* Mem address which causes query abort if positive */
7306 int groupBySort; /* Rows come from source in GROUP BY order */
drhd1766112008-09-17 00:13:12 +00007307 int addrEnd; /* End of processing for this SELECT */
drh1c9d8352011-09-01 16:01:27 +00007308 int sortPTab = 0; /* Pseudotable used to decode sorting results */
7309 int sortOut = 0; /* Output register from the sorter */
dan374cd782014-04-21 13:21:56 +00007310 int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
drhcce7d172000-05-31 15:34:51 +00007311
drhd1766112008-09-17 00:13:12 +00007312 /* Remove any and all aliases between the result set and the
7313 ** GROUP BY clause.
7314 */
7315 if( pGroupBy ){
drhdc5ea5c2008-12-10 17:19:59 +00007316 int k; /* Loop counter */
drhd1766112008-09-17 00:13:12 +00007317 struct ExprList_item *pItem; /* For looping over expression in a list */
drhcce7d172000-05-31 15:34:51 +00007318
drhdc5ea5c2008-12-10 17:19:59 +00007319 for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
drhc2acc4e2013-11-15 18:15:19 +00007320 pItem->u.x.iAlias = 0;
drhd1766112008-09-17 00:13:12 +00007321 }
drhdc5ea5c2008-12-10 17:19:59 +00007322 for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
drhc2acc4e2013-11-15 18:15:19 +00007323 pItem->u.x.iAlias = 0;
drhd1766112008-09-17 00:13:12 +00007324 }
drhc3489bb2016-02-25 16:04:59 +00007325 assert( 66==sqlite3LogEst(100) );
7326 if( p->nSelectRow>66 ) p->nSelectRow = 66;
dan8c9bcb22019-09-21 15:44:12 +00007327
7328 /* If there is both a GROUP BY and an ORDER BY clause and they are
7329 ** identical, then it may be possible to disable the ORDER BY clause
7330 ** on the grounds that the GROUP BY will cause elements to come out
7331 ** in the correct order. It also may not - the GROUP BY might use a
7332 ** database index that causes rows to be grouped together as required
7333 ** but not actually sorted. Either way, record the fact that the
7334 ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
7335 ** variable. */
7336 if( sSort.pOrderBy && pGroupBy->nExpr==sSort.pOrderBy->nExpr ){
drhe39f3882019-09-21 17:31:03 +00007337 int ii;
dan8c9bcb22019-09-21 15:44:12 +00007338 /* The GROUP BY processing doesn't care whether rows are delivered in
7339 ** ASC or DESC order - only that each group is returned contiguously.
7340 ** So set the ASC/DESC flags in the GROUP BY to match those in the
7341 ** ORDER BY to maximize the chances of rows being delivered in an
7342 ** order that makes the ORDER BY redundant. */
drhe39f3882019-09-21 17:31:03 +00007343 for(ii=0; ii<pGroupBy->nExpr; ii++){
drhd88fd532022-05-02 20:49:30 +00007344 u8 sortFlags;
7345 sortFlags = sSort.pOrderBy->a[ii].fg.sortFlags & KEYINFO_ORDER_DESC;
7346 pGroupBy->a[ii].fg.sortFlags = sortFlags;
dan8c9bcb22019-09-21 15:44:12 +00007347 }
7348 if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
7349 orderByGrp = 1;
7350 }
7351 }
drh95aa47b2010-11-16 02:49:15 +00007352 }else{
drhc3489bb2016-02-25 16:04:59 +00007353 assert( 0==sqlite3LogEst(1) );
7354 p->nSelectRow = 0;
drhd1766112008-09-17 00:13:12 +00007355 }
drh13449892005-09-07 21:22:45 +00007356
drhd1766112008-09-17 00:13:12 +00007357 /* Create a label to jump to when we want to abort the query */
drhec4ccdb2018-12-29 02:26:59 +00007358 addrEnd = sqlite3VdbeMakeLabel(pParse);
drh13449892005-09-07 21:22:45 +00007359
7360 /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
7361 ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
7362 ** SELECT statement.
7363 */
drhbf790972020-06-07 20:18:07 +00007364 pAggInfo = sqlite3DbMallocZero(db, sizeof(*pAggInfo) );
drhc54246f2021-02-17 21:13:14 +00007365 if( pAggInfo ){
7366 sqlite3ParserAddCleanup(pParse,
7367 (void(*)(sqlite3*,void*))agginfoFree, pAggInfo);
drh6d0053c2021-03-09 19:32:37 +00007368 testcase( pParse->earlyCleanup );
drhc54246f2021-02-17 21:13:14 +00007369 }
7370 if( db->mallocFailed ){
drhbf790972020-06-07 20:18:07 +00007371 goto select_end;
7372 }
drhe26d4282020-06-09 11:59:15 +00007373 pAggInfo->selId = p->selId;
drh13449892005-09-07 21:22:45 +00007374 memset(&sNC, 0, sizeof(sNC));
7375 sNC.pParse = pParse;
7376 sNC.pSrcList = pTabList;
drhbf790972020-06-07 20:18:07 +00007377 sNC.uNC.pAggInfo = pAggInfo;
drh25c3b8c2018-04-16 10:34:13 +00007378 VVA_ONLY( sNC.ncFlags = NC_UAggInfo; )
drhbf790972020-06-07 20:18:07 +00007379 pAggInfo->mnReg = pParse->nMem+1;
7380 pAggInfo->nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
7381 pAggInfo->pGroupBy = pGroupBy;
drhd2b3e232008-01-23 14:51:49 +00007382 sqlite3ExprAnalyzeAggList(&sNC, pEList);
drh079a3072014-03-19 14:10:55 +00007383 sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
drhd2b3e232008-01-23 14:51:49 +00007384 if( pHaving ){
danab31a842017-04-29 20:53:09 +00007385 if( pGroupBy ){
7386 assert( pWhere==p->pWhere );
drhcd0abc22018-03-20 18:08:33 +00007387 assert( pHaving==p->pHaving );
7388 assert( pGroupBy==p->pGroupBy );
7389 havingToWhere(pParse, p);
danab31a842017-04-29 20:53:09 +00007390 pWhere = p->pWhere;
7391 }
drhd2b3e232008-01-23 14:51:49 +00007392 sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
drh13449892005-09-07 21:22:45 +00007393 }
drhbf790972020-06-07 20:18:07 +00007394 pAggInfo->nAccumulator = pAggInfo->nColumn;
7395 if( p->pGroupBy==0 && p->pHaving==0 && pAggInfo->nFunc==1 ){
drh81185a52020-06-09 13:38:12 +00007396 minMaxFlag = minMaxQuery(db, pAggInfo->aFunc[0].pFExpr, &pMinMaxOrderBy);
drh47d9f832017-10-26 20:04:28 +00007397 }else{
7398 minMaxFlag = WHERE_ORDERBY_NORMAL;
7399 }
drhbf790972020-06-07 20:18:07 +00007400 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00007401 Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
drha4eeccd2021-10-07 17:43:30 +00007402 assert( ExprUseXList(pExpr) );
drh3a8c4be2012-05-21 20:13:39 +00007403 sNC.ncFlags |= NC_InAggFunc;
dan6ba7ab02019-07-02 11:56:47 +00007404 sqlite3ExprAnalyzeAggList(&sNC, pExpr->x.pList);
7405#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00007406 assert( !IsWindowFunc(pExpr) );
7407 if( ExprHasProperty(pExpr, EP_WinFunc) ){
7408 sqlite3ExprAnalyzeAggregates(&sNC, pExpr->y.pWin->pFilter);
danb28c4e52019-07-05 17:38:55 +00007409 }
dan6ba7ab02019-07-02 11:56:47 +00007410#endif
drh3a8c4be2012-05-21 20:13:39 +00007411 sNC.ncFlags &= ~NC_InAggFunc;
drh13449892005-09-07 21:22:45 +00007412 }
drhbf790972020-06-07 20:18:07 +00007413 pAggInfo->mxReg = pParse->nMem;
drh17435752007-08-16 04:30:38 +00007414 if( db->mallocFailed ) goto select_end;
drh5e431be2022-04-06 11:08:38 +00007415#if TREETRACE_ENABLED
7416 if( sqlite3TreeTrace & 0x400 ){
drh7ea11062017-10-26 18:43:19 +00007417 int ii;
drhbf790972020-06-07 20:18:07 +00007418 SELECTTRACE(0x400,pParse,p,("After aggregate analysis %p:\n", pAggInfo));
drh7ea11062017-10-26 18:43:19 +00007419 sqlite3TreeViewSelect(0, p, 0);
drhb9366f82021-01-13 11:44:51 +00007420 if( minMaxFlag ){
7421 sqlite3DebugPrintf("MIN/MAX Optimization (0x%02x) adds:\n", minMaxFlag);
7422 sqlite3TreeViewExprList(0, pMinMaxOrderBy, 0, "ORDERBY");
7423 }
drhbf790972020-06-07 20:18:07 +00007424 for(ii=0; ii<pAggInfo->nColumn; ii++){
drhf4c29122022-07-26 14:37:04 +00007425 struct AggInfo_col *pCol = &pAggInfo->aCol[ii];
7426 sqlite3DebugPrintf(
7427 "agg-column[%d] pTab=%s iTable=%d iColumn=%d iMem=%d"
7428 " iSorterColumn=%d\n",
7429 ii, pCol->pTab ? pCol->pTab->zName : "NULL",
7430 pCol->iTable, pCol->iColumn, pCol->iMem,
7431 pCol->iSorterColumn);
drh81185a52020-06-09 13:38:12 +00007432 sqlite3TreeViewExpr(0, pAggInfo->aCol[ii].pCExpr, 0);
drh7ea11062017-10-26 18:43:19 +00007433 }
drhbf790972020-06-07 20:18:07 +00007434 for(ii=0; ii<pAggInfo->nFunc; ii++){
drh7ea11062017-10-26 18:43:19 +00007435 sqlite3DebugPrintf("agg-func[%d]: iMem=%d\n",
drhbf790972020-06-07 20:18:07 +00007436 ii, pAggInfo->aFunc[ii].iMem);
drh81185a52020-06-09 13:38:12 +00007437 sqlite3TreeViewExpr(0, pAggInfo->aFunc[ii].pFExpr, 0);
drh7ea11062017-10-26 18:43:19 +00007438 }
7439 }
7440#endif
7441
drh13449892005-09-07 21:22:45 +00007442
7443 /* Processing for aggregates with GROUP BY is very different and
danielk19773c4809a2007-11-12 15:29:18 +00007444 ** much more complex than aggregates without a GROUP BY.
drh13449892005-09-07 21:22:45 +00007445 */
7446 if( pGroupBy ){
7447 KeyInfo *pKeyInfo; /* Keying information for the group by clause */
drh728e0f92015-10-10 14:41:28 +00007448 int addr1; /* A-vs-B comparision jump */
drhd1766112008-09-17 00:13:12 +00007449 int addrOutputRow; /* Start of subroutine that outputs a result row */
7450 int regOutputRow; /* Return address register for output subroutine */
7451 int addrSetAbort; /* Set the abort flag and return */
7452 int addrTopOfLoop; /* Top of the input loop */
7453 int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
7454 int addrReset; /* Subroutine for resetting the accumulator */
7455 int regReset; /* Return address register for reset subroutine */
dan5383db72021-03-12 18:24:31 +00007456 ExprList *pDistinct = 0;
7457 u16 distFlag = 0;
7458 int eDist = WHERE_DISTINCT_NOOP;
7459
7460 if( pAggInfo->nFunc==1
7461 && pAggInfo->aFunc[0].iDistinct>=0
drha4eeccd2021-10-07 17:43:30 +00007462 && ALWAYS(pAggInfo->aFunc[0].pFExpr!=0)
7463 && ALWAYS(ExprUseXList(pAggInfo->aFunc[0].pFExpr))
7464 && pAggInfo->aFunc[0].pFExpr->x.pList!=0
dan5383db72021-03-12 18:24:31 +00007465 ){
7466 Expr *pExpr = pAggInfo->aFunc[0].pFExpr->x.pList->a[0].pExpr;
7467 pExpr = sqlite3ExprDup(db, pExpr, 0);
7468 pDistinct = sqlite3ExprListDup(db, pGroupBy, 0);
7469 pDistinct = sqlite3ExprListAppend(pParse, pDistinct, pExpr);
danf330d532021-04-03 19:23:59 +00007470 distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
dan5383db72021-03-12 18:24:31 +00007471 }
drh13449892005-09-07 21:22:45 +00007472
7473 /* If there is a GROUP BY clause we might need a sorting index to
7474 ** implement it. Allocate that sorting index now. If it turns out
drh1c9d8352011-09-01 16:01:27 +00007475 ** that we do not need it after all, the OP_SorterOpen instruction
drh13449892005-09-07 21:22:45 +00007476 ** will be converted into a Noop.
7477 */
drhbf790972020-06-07 20:18:07 +00007478 pAggInfo->sortingIdx = pParse->nTab++;
7479 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pGroupBy,
7480 0, pAggInfo->nColumn);
drh1c9d8352011-09-01 16:01:27 +00007481 addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
drhbf790972020-06-07 20:18:07 +00007482 pAggInfo->sortingIdx, pAggInfo->nSortingColumn,
drh2ec2fb22013-11-06 19:59:23 +00007483 0, (char*)pKeyInfo, P4_KEYINFO);
drh13449892005-09-07 21:22:45 +00007484
7485 /* Initialize memory locations used by GROUP BY aggregate processing
7486 */
drh0a07c102008-01-03 18:03:08 +00007487 iUseFlag = ++pParse->nMem;
7488 iAbortFlag = ++pParse->nMem;
drhd1766112008-09-17 00:13:12 +00007489 regOutputRow = ++pParse->nMem;
drhec4ccdb2018-12-29 02:26:59 +00007490 addrOutputRow = sqlite3VdbeMakeLabel(pParse);
drhd1766112008-09-17 00:13:12 +00007491 regReset = ++pParse->nMem;
drhec4ccdb2018-12-29 02:26:59 +00007492 addrReset = sqlite3VdbeMakeLabel(pParse);
drh0a07c102008-01-03 18:03:08 +00007493 iAMem = pParse->nMem + 1;
drh13449892005-09-07 21:22:45 +00007494 pParse->nMem += pGroupBy->nExpr;
drh0a07c102008-01-03 18:03:08 +00007495 iBMem = pParse->nMem + 1;
drh13449892005-09-07 21:22:45 +00007496 pParse->nMem += pGroupBy->nExpr;
drh4c583122008-01-04 22:01:03 +00007497 sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
drhd4e70eb2008-01-02 00:34:36 +00007498 VdbeComment((v, "clear abort flag"));
drhb8475df2011-12-09 16:21:19 +00007499 sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
drhe3133822005-09-20 13:11:59 +00007500
drh13449892005-09-07 21:22:45 +00007501 /* Begin a loop that will extract all source rows in GROUP BY order.
7502 ** This might involve two separate loops with an OP_Sort in between, or
7503 ** it might be a single loop that uses an index to extract information
7504 ** in the right order to begin with.
7505 */
drh2eb95372008-06-06 15:04:36 +00007506 sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
drhcfd74702018-03-19 22:28:34 +00007507 SELECTTRACE(1,pParse,p,("WhereBegin\n"));
dan5383db72021-03-12 18:24:31 +00007508 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, pDistinct,
danece092e2022-03-16 12:06:00 +00007509 0, (sDistinct.isTnct==2 ? WHERE_DISTINCTBY : WHERE_GROUPBY)
7510 | (orderByGrp ? WHERE_SORTBYGROUP : 0) | distFlag, 0
dan374cd782014-04-21 13:21:56 +00007511 );
danbfd6f1b2021-04-08 20:29:12 +00007512 if( pWInfo==0 ){
7513 sqlite3ExprListDelete(db, pDistinct);
7514 goto select_end;
7515 }
dan76075802021-03-12 21:09:20 +00007516 eDist = sqlite3WhereIsDistinct(pWInfo);
drh13162ef2021-02-16 20:01:08 +00007517 SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
drhddba0c22014-03-18 20:33:42 +00007518 if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
drh13449892005-09-07 21:22:45 +00007519 /* The optimizer is able to deliver rows in group by order so
drhb9bb7c12006-06-11 23:41:55 +00007520 ** we do not have to sort. The OP_OpenEphemeral table will be
drh13449892005-09-07 21:22:45 +00007521 ** cancelled later because we still need to use the pKeyInfo
7522 */
drh13449892005-09-07 21:22:45 +00007523 groupBySort = 0;
7524 }else{
7525 /* Rows are coming out in undetermined order. We have to push
7526 ** each row into a sorting index, terminate the first loop,
7527 ** then loop over the sorting index in order to get the output
7528 ** in sorted order
7529 */
drh892d3172008-01-10 03:46:36 +00007530 int regBase;
7531 int regRecord;
7532 int nCol;
7533 int nGroupBy;
7534
dan2ce22452010-11-08 19:01:16 +00007535 explainTempTable(pParse,
drhe8e4af72012-09-21 00:04:28 +00007536 (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
7537 "DISTINCT" : "GROUP BY");
dan2ce22452010-11-08 19:01:16 +00007538
drh13449892005-09-07 21:22:45 +00007539 groupBySort = 1;
drh892d3172008-01-10 03:46:36 +00007540 nGroupBy = pGroupBy->nExpr;
dandd23c6b2014-03-24 20:19:07 +00007541 nCol = nGroupBy;
7542 j = nGroupBy;
drhbf790972020-06-07 20:18:07 +00007543 for(i=0; i<pAggInfo->nColumn; i++){
7544 if( pAggInfo->aCol[i].iSorterColumn>=j ){
drh892d3172008-01-10 03:46:36 +00007545 nCol++;
7546 j++;
7547 }
7548 }
7549 regBase = sqlite3GetTempRange(pParse, nCol);
drh5579d592015-08-26 14:01:41 +00007550 sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0, 0);
dandd23c6b2014-03-24 20:19:07 +00007551 j = nGroupBy;
drhee373022022-07-25 15:54:23 +00007552 pAggInfo->directMode = 1;
drhbf790972020-06-07 20:18:07 +00007553 for(i=0; i<pAggInfo->nColumn; i++){
7554 struct AggInfo_col *pCol = &pAggInfo->aCol[i];
drh892d3172008-01-10 03:46:36 +00007555 if( pCol->iSorterColumn>=j ){
drhee373022022-07-25 15:54:23 +00007556 sqlite3ExprCode(pParse, pCol->pCExpr, j + regBase);
drh6a012f02008-08-21 14:15:59 +00007557 j++;
drh892d3172008-01-10 03:46:36 +00007558 }
drh13449892005-09-07 21:22:45 +00007559 }
drhee373022022-07-25 15:54:23 +00007560 pAggInfo->directMode = 0;
drh892d3172008-01-10 03:46:36 +00007561 regRecord = sqlite3GetTempReg(pParse);
drh1db639c2008-01-17 02:36:28 +00007562 sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
drhbf790972020-06-07 20:18:07 +00007563 sqlite3VdbeAddOp2(v, OP_SorterInsert, pAggInfo->sortingIdx, regRecord);
drh892d3172008-01-10 03:46:36 +00007564 sqlite3ReleaseTempReg(pParse, regRecord);
7565 sqlite3ReleaseTempRange(pParse, regBase, nCol);
drh13162ef2021-02-16 20:01:08 +00007566 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
drh13449892005-09-07 21:22:45 +00007567 sqlite3WhereEnd(pWInfo);
drhbf790972020-06-07 20:18:07 +00007568 pAggInfo->sortingIdxPTab = sortPTab = pParse->nTab++;
drh1c9d8352011-09-01 16:01:27 +00007569 sortOut = sqlite3GetTempReg(pParse);
7570 sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
drhbf790972020-06-07 20:18:07 +00007571 sqlite3VdbeAddOp2(v, OP_SorterSort, pAggInfo->sortingIdx, addrEnd);
drh688852a2014-02-17 22:40:43 +00007572 VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
drhbf790972020-06-07 20:18:07 +00007573 pAggInfo->useSortingIdx = 1;
dan374cd782014-04-21 13:21:56 +00007574 }
7575
7576 /* If the index or temporary table used by the GROUP BY sort
7577 ** will naturally deliver rows in the order required by the ORDER BY
7578 ** clause, cancel the ephemeral table open coded earlier.
7579 **
7580 ** This is an optimization - the correct answer should result regardless.
7581 ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
7582 ** disable this optimization for testing purposes. */
7583 if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
7584 && (groupBySort || sqlite3WhereIsSorted(pWInfo))
7585 ){
7586 sSort.pOrderBy = 0;
7587 sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
drh13449892005-09-07 21:22:45 +00007588 }
7589
7590 /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
7591 ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
7592 ** Then compare the current GROUP BY terms against the GROUP BY terms
7593 ** from the previous row currently stored in a0, a1, a2...
7594 */
7595 addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
drh1c9d8352011-09-01 16:01:27 +00007596 if( groupBySort ){
drhbf790972020-06-07 20:18:07 +00007597 sqlite3VdbeAddOp3(v, OP_SorterData, pAggInfo->sortingIdx,
drh38b41492015-06-08 15:08:15 +00007598 sortOut, sortPTab);
drh1c9d8352011-09-01 16:01:27 +00007599 }
drh13449892005-09-07 21:22:45 +00007600 for(j=0; j<pGroupBy->nExpr; j++){
7601 if( groupBySort ){
drh1c9d8352011-09-01 16:01:27 +00007602 sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
drh13449892005-09-07 21:22:45 +00007603 }else{
drhbf790972020-06-07 20:18:07 +00007604 pAggInfo->directMode = 1;
drh2dcef112008-01-12 19:03:48 +00007605 sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
drh13449892005-09-07 21:22:45 +00007606 }
drh13449892005-09-07 21:22:45 +00007607 }
drh16ee60f2008-06-20 18:13:25 +00007608 sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
drh2ec2fb22013-11-06 19:59:23 +00007609 (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
drh728e0f92015-10-10 14:41:28 +00007610 addr1 = sqlite3VdbeCurrentAddr(v);
7611 sqlite3VdbeAddOp3(v, OP_Jump, addr1+1, 0, addr1+1); VdbeCoverage(v);
drh13449892005-09-07 21:22:45 +00007612
7613 /* Generate code that runs whenever the GROUP BY changes.
drhe00ee6e2008-06-20 15:24:01 +00007614 ** Changes in the GROUP BY are detected by the previous code
drh13449892005-09-07 21:22:45 +00007615 ** block. If there were no changes, this block is skipped.
7616 **
7617 ** This code copies current group by terms in b0,b1,b2,...
7618 ** over to a0,a1,a2. It then calls the output subroutine
7619 ** and resets the aggregate accumulator registers in preparation
7620 ** for the next GROUP BY batch.
7621 */
drhb21e7c72008-06-22 12:37:57 +00007622 sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
drh2eb95372008-06-06 15:04:36 +00007623 sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
drhd4e70eb2008-01-02 00:34:36 +00007624 VdbeComment((v, "output one row"));
drh688852a2014-02-17 22:40:43 +00007625 sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
drhd4e70eb2008-01-02 00:34:36 +00007626 VdbeComment((v, "check abort flag"));
drh2eb95372008-06-06 15:04:36 +00007627 sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
drhd4e70eb2008-01-02 00:34:36 +00007628 VdbeComment((v, "reset accumulator"));
drh13449892005-09-07 21:22:45 +00007629
7630 /* Update the aggregate accumulators based on the content of
7631 ** the current row
7632 */
drh728e0f92015-10-10 14:41:28 +00007633 sqlite3VdbeJumpHere(v, addr1);
dan5383db72021-03-12 18:24:31 +00007634 updateAccumulator(pParse, iUseFlag, pAggInfo, eDist);
drh4c583122008-01-04 22:01:03 +00007635 sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
drhd4e70eb2008-01-02 00:34:36 +00007636 VdbeComment((v, "indicate data in accumulator"));
drh13449892005-09-07 21:22:45 +00007637
7638 /* End of the loop
7639 */
7640 if( groupBySort ){
drhd1930572021-01-13 15:23:17 +00007641 sqlite3VdbeAddOp2(v, OP_SorterNext, pAggInfo->sortingIdx,addrTopOfLoop);
drh688852a2014-02-17 22:40:43 +00007642 VdbeCoverage(v);
drh13449892005-09-07 21:22:45 +00007643 }else{
drh13162ef2021-02-16 20:01:08 +00007644 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
drh13449892005-09-07 21:22:45 +00007645 sqlite3WhereEnd(pWInfo);
drh48f2d3b2011-09-16 01:34:43 +00007646 sqlite3VdbeChangeToNoop(v, addrSortingIdx);
drh13449892005-09-07 21:22:45 +00007647 }
danbfd6f1b2021-04-08 20:29:12 +00007648 sqlite3ExprListDelete(db, pDistinct);
drh13449892005-09-07 21:22:45 +00007649
7650 /* Output the final row of result
7651 */
drh2eb95372008-06-06 15:04:36 +00007652 sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
drhd4e70eb2008-01-02 00:34:36 +00007653 VdbeComment((v, "output final row"));
drhd1766112008-09-17 00:13:12 +00007654
7655 /* Jump over the subroutines
7656 */
drh076e85f2015-09-03 13:46:12 +00007657 sqlite3VdbeGoto(v, addrEnd);
drhd1766112008-09-17 00:13:12 +00007658
7659 /* Generate a subroutine that outputs a single row of the result
7660 ** set. This subroutine first looks at the iUseFlag. If iUseFlag
7661 ** is less than or equal to zero, the subroutine is a no-op. If
7662 ** the processing calls for the query to abort, this subroutine
7663 ** increments the iAbortFlag memory location before returning in
7664 ** order to signal the caller to abort.
7665 */
7666 addrSetAbort = sqlite3VdbeCurrentAddr(v);
7667 sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
7668 VdbeComment((v, "set abort flag"));
7669 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7670 sqlite3VdbeResolveLabel(v, addrOutputRow);
7671 addrOutputRow = sqlite3VdbeCurrentAddr(v);
7672 sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2);
drh38b41492015-06-08 15:08:15 +00007673 VdbeCoverage(v);
drhd1766112008-09-17 00:13:12 +00007674 VdbeComment((v, "Groupby result generator entry point"));
7675 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
drhbf790972020-06-07 20:18:07 +00007676 finalizeAggFunctions(pParse, pAggInfo);
drh33cd4902009-05-30 20:49:20 +00007677 sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
drh2def2f72017-09-15 17:40:34 +00007678 selectInnerLoop(pParse, p, -1, &sSort,
drhe8e4af72012-09-21 00:04:28 +00007679 &sDistinct, pDest,
drhd1766112008-09-17 00:13:12 +00007680 addrOutputRow+1, addrSetAbort);
7681 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7682 VdbeComment((v, "end groupby result generator"));
7683
7684 /* Generate a subroutine that will reset the group-by accumulator
7685 */
7686 sqlite3VdbeResolveLabel(v, addrReset);
drhbf790972020-06-07 20:18:07 +00007687 resetAccumulator(pParse, pAggInfo);
dan280c8942018-06-05 20:04:28 +00007688 sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
7689 VdbeComment((v, "indicate accumulator empty"));
drhd1766112008-09-17 00:13:12 +00007690 sqlite3VdbeAddOp1(v, OP_Return, regReset);
dan5383db72021-03-12 18:24:31 +00007691
danece092e2022-03-16 12:06:00 +00007692 if( distFlag!=0 && eDist!=WHERE_DISTINCT_NOOP ){
dan5383db72021-03-12 18:24:31 +00007693 struct AggInfo_func *pF = &pAggInfo->aFunc[0];
7694 fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7695 }
drh43152cf2009-05-19 19:04:58 +00007696 } /* endif pGroupBy. Begin aggregate queries without GROUP BY: */
drh13449892005-09-07 21:22:45 +00007697 else {
danielk1977a5533162009-02-24 10:01:51 +00007698 Table *pTab;
drhbf790972020-06-07 20:18:07 +00007699 if( (pTab = isSimpleCount(p, pAggInfo))!=0 ){
danielk1977a5533162009-02-24 10:01:51 +00007700 /* If isSimpleCount() returns a pointer to a Table structure, then
7701 ** the SQL statement is of the form:
7702 **
7703 ** SELECT count(*) FROM <tbl>
7704 **
7705 ** where the Table structure returned represents table <tbl>.
7706 **
7707 ** This statement is so common that it is optimized specially. The
7708 ** OP_Count instruction is executed either on the intkey table that
7709 ** contains the data for table <tbl> or on one of its indexes. It
7710 ** is better to execute the op on an index, as indexes are almost
7711 ** always spread across less pages than their corresponding tables.
7712 */
7713 const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
7714 const int iCsr = pParse->nTab++; /* Cursor to scan b-tree */
7715 Index *pIdx; /* Iterator variable */
7716 KeyInfo *pKeyInfo = 0; /* Keyinfo for scanned index */
7717 Index *pBest = 0; /* Best index found so far */
drh013e7bb2020-07-30 17:37:49 +00007718 Pgno iRoot = pTab->tnum; /* Root page of scanned b-tree */
danielk1977a9d1ccb2008-01-05 17:39:29 +00007719
danielk1977a5533162009-02-24 10:01:51 +00007720 sqlite3CodeVerifySchema(pParse, iDb);
7721 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
7722
drhd9e3cad2013-10-04 02:36:19 +00007723 /* Search for the index that has the lowest scan cost.
danielk1977a5533162009-02-24 10:01:51 +00007724 **
drh3e9548b2011-04-15 14:46:27 +00007725 ** (2011-04-15) Do not do a full scan of an unordered index.
7726 **
drhabcc1942013-11-12 14:55:40 +00007727 ** (2013-10-03) Do not count the entries in a partial index.
drh5f33f372013-10-04 00:00:12 +00007728 **
danielk1977a5533162009-02-24 10:01:51 +00007729 ** In practice the KeyInfo structure will not be used. It is only
7730 ** passed to keep OP_OpenRead happy.
7731 */
drh5c7917e2013-11-12 15:33:40 +00007732 if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
drh98aa1d72020-05-08 18:22:00 +00007733 if( !p->pSrc->a[0].fg.notIndexed ){
7734 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
7735 if( pIdx->bUnordered==0
7736 && pIdx->szIdxRow<pTab->szTabRow
7737 && pIdx->pPartIdxWhere==0
7738 && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
7739 ){
7740 pBest = pIdx;
7741 }
danielk1977a5533162009-02-24 10:01:51 +00007742 }
7743 }
drhd9e3cad2013-10-04 02:36:19 +00007744 if( pBest ){
danielk1977a5533162009-02-24 10:01:51 +00007745 iRoot = pBest->tnum;
drh2ec2fb22013-11-06 19:59:23 +00007746 pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
danielk1977a5533162009-02-24 10:01:51 +00007747 }
7748
7749 /* Open a read-only cursor, execute the OP_Count, close the cursor. */
drh013e7bb2020-07-30 17:37:49 +00007750 sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, (int)iRoot, iDb, 1);
danielk1977a5533162009-02-24 10:01:51 +00007751 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00007752 sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
danielk1977a5533162009-02-24 10:01:51 +00007753 }
drhbf790972020-06-07 20:18:07 +00007754 sqlite3VdbeAddOp2(v, OP_Count, iCsr, pAggInfo->aFunc[0].iMem);
danielk1977a5533162009-02-24 10:01:51 +00007755 sqlite3VdbeAddOp1(v, OP_Close, iCsr);
danef7075d2011-02-21 17:49:49 +00007756 explainSimpleCount(pParse, pTab, pBest);
drhe50478d2020-03-17 13:41:51 +00007757 }else{
dan280c8942018-06-05 20:04:28 +00007758 int regAcc = 0; /* "populate accumulators" flag */
dan4fcb30b2021-03-09 16:06:25 +00007759 ExprList *pDistinct = 0;
7760 u16 distFlag = 0;
dan5383db72021-03-12 18:24:31 +00007761 int eDist;
dan280c8942018-06-05 20:04:28 +00007762
daned09ddd2019-09-20 20:52:16 +00007763 /* If there are accumulator registers but no min() or max() functions
7764 ** without FILTER clauses, allocate register regAcc. Register regAcc
7765 ** will contain 0 the first time the inner loop runs, and 1 thereafter.
7766 ** The code generated by updateAccumulator() uses this to ensure
7767 ** that the accumulator registers are (a) updated only once if
7768 ** there are no min() or max functions or (b) always updated for the
7769 ** first row visited by the aggregate, so that they are updated at
7770 ** least once even if the FILTER clause means the min() or max()
7771 ** function visits zero rows. */
drhbf790972020-06-07 20:18:07 +00007772 if( pAggInfo->nAccumulator ){
7773 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00007774 if( ExprHasProperty(pAggInfo->aFunc[i].pFExpr, EP_WinFunc) ){
drhbf790972020-06-07 20:18:07 +00007775 continue;
7776 }
7777 if( pAggInfo->aFunc[i].pFunc->funcFlags&SQLITE_FUNC_NEEDCOLL ){
7778 break;
7779 }
dan280c8942018-06-05 20:04:28 +00007780 }
drhbf790972020-06-07 20:18:07 +00007781 if( i==pAggInfo->nFunc ){
dan280c8942018-06-05 20:04:28 +00007782 regAcc = ++pParse->nMem;
7783 sqlite3VdbeAddOp2(v, OP_Integer, 0, regAcc);
7784 }
dan4fcb30b2021-03-09 16:06:25 +00007785 }else if( pAggInfo->nFunc==1 && pAggInfo->aFunc[0].iDistinct>=0 ){
drha4eeccd2021-10-07 17:43:30 +00007786 assert( ExprUseXList(pAggInfo->aFunc[0].pFExpr) );
dan4fcb30b2021-03-09 16:06:25 +00007787 pDistinct = pAggInfo->aFunc[0].pFExpr->x.pList;
danf330d532021-04-03 19:23:59 +00007788 distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
dan280c8942018-06-05 20:04:28 +00007789 }
7790
danielk1977a5533162009-02-24 10:01:51 +00007791 /* This case runs if the aggregate has no GROUP BY clause. The
7792 ** processing is much simpler since there is only a single row
7793 ** of output.
7794 */
drh47d9f832017-10-26 20:04:28 +00007795 assert( p->pGroupBy==0 );
drhbf790972020-06-07 20:18:07 +00007796 resetAccumulator(pParse, pAggInfo);
drh47d9f832017-10-26 20:04:28 +00007797
7798 /* If this query is a candidate for the min/max optimization, then
7799 ** minMaxFlag will have been previously set to either
7800 ** WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX and pMinMaxOrderBy will
7801 ** be an appropriate ORDER BY expression for the optimization.
7802 */
7803 assert( minMaxFlag==WHERE_ORDERBY_NORMAL || pMinMaxOrderBy!=0 );
7804 assert( pMinMaxOrderBy==0 || pMinMaxOrderBy->nExpr==1 );
7805
drhcfd74702018-03-19 22:28:34 +00007806 SELECTTRACE(1,pParse,p,("WhereBegin\n"));
drh47d9f832017-10-26 20:04:28 +00007807 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMaxOrderBy,
drh895bab32022-01-27 16:14:50 +00007808 pDistinct, 0, minMaxFlag|distFlag, 0);
danielk1977a5533162009-02-24 10:01:51 +00007809 if( pWInfo==0 ){
danielk1977a5533162009-02-24 10:01:51 +00007810 goto select_end;
7811 }
drh13162ef2021-02-16 20:01:08 +00007812 SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
dan5383db72021-03-12 18:24:31 +00007813 eDist = sqlite3WhereIsDistinct(pWInfo);
7814 updateAccumulator(pParse, regAcc, pAggInfo, eDist);
7815 if( eDist!=WHERE_DISTINCT_NOOP ){
drhde695ea2022-05-10 15:55:10 +00007816 struct AggInfo_func *pF = pAggInfo->aFunc;
drh3117b7b2022-04-19 18:23:01 +00007817 if( pF ){
7818 fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7819 }
dan5383db72021-03-12 18:24:31 +00007820 }
7821
dan280c8942018-06-05 20:04:28 +00007822 if( regAcc ) sqlite3VdbeAddOp2(v, OP_Integer, 1, regAcc);
drhd1930572021-01-13 15:23:17 +00007823 if( minMaxFlag ){
7824 sqlite3WhereMinMaxOptEarlyOut(v, pWInfo);
danielk1977a5533162009-02-24 10:01:51 +00007825 }
drh13162ef2021-02-16 20:01:08 +00007826 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
danielk1977a5533162009-02-24 10:01:51 +00007827 sqlite3WhereEnd(pWInfo);
drhbf790972020-06-07 20:18:07 +00007828 finalizeAggFunctions(pParse, pAggInfo);
danielk1977a9d1ccb2008-01-05 17:39:29 +00007829 }
7830
drh079a3072014-03-19 14:10:55 +00007831 sSort.pOrderBy = 0;
drh33cd4902009-05-30 20:49:20 +00007832 sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
drh2def2f72017-09-15 17:40:34 +00007833 selectInnerLoop(pParse, p, -1, 0, 0,
drha9671a22008-07-08 23:40:20 +00007834 pDest, addrEnd, addrEnd);
drh13449892005-09-07 21:22:45 +00007835 }
7836 sqlite3VdbeResolveLabel(v, addrEnd);
7837
7838 } /* endif aggregate query */
drh22827922000-06-06 17:27:05 +00007839
drhe8e4af72012-09-21 00:04:28 +00007840 if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
dan2ce22452010-11-08 19:01:16 +00007841 explainTempTable(pParse, "DISTINCT");
7842 }
7843
drhcce7d172000-05-31 15:34:51 +00007844 /* If there is an ORDER BY clause, then we need to sort the results
7845 ** and send them to the callback one by one.
7846 */
drh079a3072014-03-19 14:10:55 +00007847 if( sSort.pOrderBy ){
drh38b41492015-06-08 15:08:15 +00007848 explainTempTable(pParse,
7849 sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
dan24e25d32018-04-14 18:46:20 +00007850 assert( p->pEList==pEList );
drh079a3072014-03-19 14:10:55 +00007851 generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
drhcce7d172000-05-31 15:34:51 +00007852 }
drh6a535342001-10-19 16:44:56 +00007853
drhec7429a2005-10-06 16:53:14 +00007854 /* Jump here to skip this query
7855 */
7856 sqlite3VdbeResolveLabel(v, iEnd);
7857
dan5b1c07e2015-04-16 07:19:23 +00007858 /* The SELECT has been coded. If there is an error in the Parse structure,
7859 ** set the return code to 1. Otherwise 0. */
7860 rc = (pParse->nErr>0);
drh1d83f052002-02-17 00:30:36 +00007861
7862 /* Control jumps to here if an error is encountered above, or upon
7863 ** successful coding of the SELECT.
7864 */
7865select_end:
dan44918c72021-04-17 14:42:37 +00007866 assert( db->mallocFailed==0 || db->mallocFailed==1 );
drh0c7d3d32022-01-24 16:47:12 +00007867 assert( db->mallocFailed==0 || pParse->nErr!=0 );
drh47d9f832017-10-26 20:04:28 +00007868 sqlite3ExprListDelete(db, pMinMaxOrderBy);
drh89636622020-06-07 17:33:18 +00007869#ifdef SQLITE_DEBUG
drh7b4c4d42020-06-10 03:07:26 +00007870 if( pAggInfo && !db->mallocFailed ){
drhbf790972020-06-07 20:18:07 +00007871 for(i=0; i<pAggInfo->nColumn; i++){
drh81185a52020-06-09 13:38:12 +00007872 Expr *pExpr = pAggInfo->aCol[i].pCExpr;
drh06ddb082020-12-22 14:54:20 +00007873 assert( pExpr!=0 );
drhbf790972020-06-07 20:18:07 +00007874 assert( pExpr->pAggInfo==pAggInfo );
drh89636622020-06-07 17:33:18 +00007875 assert( pExpr->iAgg==i );
7876 }
drhbf790972020-06-07 20:18:07 +00007877 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00007878 Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
drh06ddb082020-12-22 14:54:20 +00007879 assert( pExpr!=0 );
drhbf790972020-06-07 20:18:07 +00007880 assert( pExpr->pAggInfo==pAggInfo );
drh89636622020-06-07 17:33:18 +00007881 assert( pExpr->iAgg==i );
7882 }
drh89636622020-06-07 17:33:18 +00007883 }
drh89636622020-06-07 17:33:18 +00007884#endif
7885
drh5e431be2022-04-06 11:08:38 +00007886#if TREETRACE_ENABLED
drhf20609d2018-04-23 17:43:35 +00007887 SELECTTRACE(0x1,pParse,p,("end processing\n"));
drh5e431be2022-04-06 11:08:38 +00007888 if( (sqlite3TreeTrace & 0x2000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
drhf20609d2018-04-23 17:43:35 +00007889 sqlite3TreeViewSelect(0, p, 0);
7890 }
drheb9b8842014-09-21 00:27:26 +00007891#endif
drhe2ca99c2018-05-02 00:33:43 +00007892 ExplainQueryPlanPop(pParse);
drh1d83f052002-02-17 00:30:36 +00007893 return rc;
drhcce7d172000-05-31 15:34:51 +00007894}