blob: c86ae1f52118e24118a0335a28a34a8a1a543d33 [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 );
327 assert( pItem->fg.isNestedFrom == IsNestedFrom(pItem->pSelect) );
328 if( pItem->fg.isNestedFrom ){
329 ExprList *pResults;
330 assert( pItem->pSelect!=0 );
331 pResults = pItem->pSelect->pEList;
332 assert( pResults!=0 );
333 assert( iCol>=0 && iCol<pResults->nExpr );
334 pResults->a[iCol].bUsed = 1;
335 }
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/*
drh1f162302002-10-27 19:35:33 +0000381** Set the EP_FromJoin 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**
drhe78e8282003-01-19 03:59:45 +0000385** The EP_FromJoin 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){
407 assert( joinFlag==EP_FromJoin || joinFlag==EP_InnerJoin );
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
drh8103a032019-11-15 00:52:13 +0000427/* Undo the work of sqlite3SetJoinExpr(). In the expression p, convert every
drhd1985262022-04-11 11:25:28 +0000428** term that is marked with EP_FromJoin and w.iJoin==iTable into
drh25897872018-03-20 21:16:15 +0000429** an ordinary term that omits the EP_FromJoin mark.
430**
431** This happens when a LEFT JOIN is simplified into an ordinary JOIN.
432*/
433static void unsetJoinExpr(Expr *p, int iTable){
434 while( p ){
drh7fbb1012018-03-21 01:59:46 +0000435 if( ExprHasProperty(p, EP_FromJoin)
drhd1985262022-04-11 11:25:28 +0000436 && (iTable<0 || p->w.iJoin==iTable) ){
drh25897872018-03-20 21:16:15 +0000437 ExprClearProperty(p, EP_FromJoin);
drh3a6e4c52022-04-11 12:38:06 +0000438 ExprSetProperty(p, EP_InnerJoin);
drh25897872018-03-20 21:16:15 +0000439 }
dan8ddf6862021-02-26 20:14:32 +0000440 if( p->op==TK_COLUMN && p->iTable==iTable ){
441 ExprClearProperty(p, EP_CanBeNull);
442 }
drha4eeccd2021-10-07 17:43:30 +0000443 if( p->op==TK_FUNCTION ){
444 assert( ExprUseXList(p) );
445 if( p->x.pList ){
446 int i;
447 for(i=0; i<p->x.pList->nExpr; i++){
448 unsetJoinExpr(p->x.pList->a[i].pExpr, iTable);
449 }
drh25897872018-03-20 21:16:15 +0000450 }
451 }
452 unsetJoinExpr(p->pLeft, iTable);
453 p = p->pRight;
454 }
455}
456
drh1cc093c2002-06-24 22:01:57 +0000457/*
drhad2d8302002-05-24 20:31:36 +0000458** This routine processes the join information for a SELECT statement.
drhbc656e22022-04-20 16:26:22 +0000459**
460** * A NATURAL join is converted into a USING join. After that, we
461** do not need to be concerned with NATURAL joins and we only have
462** think about USING joins.
463**
464** * ON and USING clauses result in extra terms being added to the
465** WHERE clause to enforce the specified constraints. The extra
466** WHERE clause terms will be tagged with EP_FromJoin or
467** EP_InnerJoin so that we know that they originated in ON/USING.
drhad2d8302002-05-24 20:31:36 +0000468**
drh91bb0ee2004-09-01 03:06:34 +0000469** The terms of a FROM clause are contained in the Select.pSrc structure.
470** The left most table is the first entry in Select.pSrc. The right-most
471** table is the last entry. The join operator is held in the entry to
drhbc656e22022-04-20 16:26:22 +0000472** the right. Thus entry 1 contains the join operator for the join between
drh91bb0ee2004-09-01 03:06:34 +0000473** entries 0 and 1. Any ON or USING clauses associated with the join are
drhbc656e22022-04-20 16:26:22 +0000474** also attached to the right entry.
drh91bb0ee2004-09-01 03:06:34 +0000475**
drhad2d8302002-05-24 20:31:36 +0000476** This routine returns the number of errors encountered.
477*/
drh358424a2022-04-15 15:15:01 +0000478static int sqlite3ProcessJoin(Parse *pParse, Select *p){
drh91bb0ee2004-09-01 03:06:34 +0000479 SrcList *pSrc; /* All tables in the FROM clause */
480 int i, j; /* Loop counters */
drh76012942021-02-21 21:04:54 +0000481 SrcItem *pLeft; /* Left table being joined */
482 SrcItem *pRight; /* Right table being joined */
drhad2d8302002-05-24 20:31:36 +0000483
drh91bb0ee2004-09-01 03:06:34 +0000484 pSrc = p->pSrc;
485 pLeft = &pSrc->a[0];
486 pRight = &pLeft[1];
487 for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
drh91bb0ee2004-09-01 03:06:34 +0000488 Table *pRightTab = pRight->pTab;
drh3a6e4c52022-04-11 12:38:06 +0000489 u32 joinType;
drh91bb0ee2004-09-01 03:06:34 +0000490
drhce2c4822017-10-03 17:17:34 +0000491 if( NEVER(pLeft->pTab==0 || pRightTab==0) ) continue;
drh3a6e4c52022-04-11 12:38:06 +0000492 joinType = (pRight->fg.jointype & JT_OUTER)!=0 ? EP_FromJoin : EP_InnerJoin;
drhad2d8302002-05-24 20:31:36 +0000493
drh22c4bc82022-04-15 17:08:40 +0000494 /* If this is a NATURAL join, synthesize an approprate USING clause
495 ** to specify which columns should be joined.
drhad2d8302002-05-24 20:31:36 +0000496 */
drh8a48b9c2015-08-19 15:20:00 +0000497 if( pRight->fg.jointype & JT_NATURAL ){
drh22c4bc82022-04-15 17:08:40 +0000498 IdList *pUsing = 0;
drhd44f8b22022-04-07 01:11:13 +0000499 if( pRight->fg.isUsing || pRight->u3.pOn ){
danielk19774adee202004-05-08 08:23:19 +0000500 sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
drhad2d8302002-05-24 20:31:36 +0000501 "an ON or USING clause", 0);
drhad2d8302002-05-24 20:31:36 +0000502 return 1;
503 }
drh2179b432009-12-09 17:36:39 +0000504 for(j=0; j<pRightTab->nCol; j++){
505 char *zName; /* Name of column in the right table */
drh2179b432009-12-09 17:36:39 +0000506
dan9d41af22019-12-30 14:32:27 +0000507 if( IsHiddenColumn(&pRightTab->aCol[j]) ) continue;
drhcf9d36d2021-08-02 18:03:43 +0000508 zName = pRightTab->aCol[j].zCnName;
drhfe146992022-04-17 18:46:17 +0000509 if( tableAndColumnIndex(pSrc, 0, i, zName, 0, 0, 1) ){
drhd0453f72022-04-18 00:04:15 +0000510 pUsing = sqlite3IdListAppend(pParse, pUsing, 0);
511 if( pUsing ){
512 assert( pUsing->nId>0 );
513 assert( pUsing->a[pUsing->nId-1].zName==0 );
514 pUsing->a[pUsing->nId-1].zName = sqlite3DbStrDup(pParse->db, zName);
515 }
drhad2d8302002-05-24 20:31:36 +0000516 }
517 }
drh22c4bc82022-04-15 17:08:40 +0000518 if( pUsing ){
519 pRight->fg.isUsing = 1;
drh4ce7bf92022-04-15 18:30:48 +0000520 pRight->fg.isSynthUsing = 1;
drh22c4bc82022-04-15 17:08:40 +0000521 pRight->u3.pUsing = pUsing;
522 }
drhabf86bd2022-04-18 09:59:33 +0000523 if( pParse->nErr ) return 1;
drhad2d8302002-05-24 20:31:36 +0000524 }
525
drhad2d8302002-05-24 20:31:36 +0000526 /* Create extra terms on the WHERE clause for each column named
527 ** in the USING clause. Example: If the two tables to be joined are
528 ** A and B and the USING clause names X, Y, and Z, then add this
529 ** to the WHERE clause: A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
530 ** Report an error if any column mentioned in the USING clause is
531 ** not contained in both tables to be joined.
532 */
drhd44f8b22022-04-07 01:11:13 +0000533 if( pRight->fg.isUsing ){
534 IdList *pList = pRight->u3.pUsing;
drhfe146992022-04-17 18:46:17 +0000535 sqlite3 *db = pParse->db;
drhd44f8b22022-04-07 01:11:13 +0000536 assert( pList!=0 );
drhad2d8302002-05-24 20:31:36 +0000537 for(j=0; j<pList->nId; j++){
drh2179b432009-12-09 17:36:39 +0000538 char *zName; /* Name of the term in the USING clause */
539 int iLeft; /* Table on the left with matching column name */
540 int iLeftCol; /* Column number of matching column on the left */
541 int iRightCol; /* Column number of matching column on the right */
drhfe146992022-04-17 18:46:17 +0000542 Expr *pE1; /* Reference to the column on the LEFT of the join */
543 Expr *pE2; /* Reference to the column on the RIGHT of the join */
544 Expr *pEq; /* Equality constraint. pE1 == pE2 */
drh2179b432009-12-09 17:36:39 +0000545
546 zName = pList->a[j].zName;
dan6e6d9832021-02-16 20:43:36 +0000547 iRightCol = sqlite3ColumnIndex(pRightTab, zName);
drh2179b432009-12-09 17:36:39 +0000548 if( iRightCol<0
drhfe146992022-04-17 18:46:17 +0000549 || tableAndColumnIndex(pSrc, 0, i, zName, &iLeft, &iLeftCol,
550 pRight->fg.isSynthUsing)==0
drh2179b432009-12-09 17:36:39 +0000551 ){
danielk19774adee202004-05-08 08:23:19 +0000552 sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
drh91bb0ee2004-09-01 03:06:34 +0000553 "not present in both tables", zName);
drhad2d8302002-05-24 20:31:36 +0000554 return 1;
555 }
drhfe146992022-04-17 18:46:17 +0000556 pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iLeftCol);
drh815b7822022-04-20 15:07:39 +0000557 sqlite3SrcItemColumnUsed(pLeft, iLeftCol);
drhfe146992022-04-17 18:46:17 +0000558 if( (pSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
559 /* This branch runs if the query contains one or more RIGHT or FULL
560 ** JOINs. If only a single table on the left side of this join
drhbc656e22022-04-20 16:26:22 +0000561 ** contains the zName column, then this branch is a no-op.
562 ** But if there are two or more tables on the left side
drhfe146992022-04-17 18:46:17 +0000563 ** of the join, construct a coalesce() function that gathers all
564 ** such tables. Raise an error if more than one of those references
565 ** to zName is not also within a prior USING clause.
566 **
567 ** We really ought to raise an error if there are two or more
568 ** non-USING references to zName on the left of an INNER or LEFT
569 ** JOIN. But older versions of SQLite do not do that, so we avoid
570 ** adding a new error so as to not break legacy applications.
drh052953a2022-04-16 22:57:41 +0000571 */
drhfe146992022-04-17 18:46:17 +0000572 ExprList *pFuncArgs = 0; /* Arguments to the coalesce() */
drh052953a2022-04-16 22:57:41 +0000573 static const Token tkCoalesce = { "coalesce", 8 };
drhfe146992022-04-17 18:46:17 +0000574 while( tableAndColumnIndex(pSrc, iLeft+1, i, zName, &iLeft, &iLeftCol,
575 pRight->fg.isSynthUsing)!=0 ){
576 if( pSrc->a[iLeft].fg.isUsing==0
577 || sqlite3IdListIndex(pSrc->a[iLeft].u3.pUsing, zName)<0
578 ){
579 sqlite3ErrorMsg(pParse, "ambiguous reference to %s in USING()",
580 zName);
581 break;
582 }
583 pFuncArgs = sqlite3ExprListAppend(pParse, pFuncArgs, pE1);
584 pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iLeftCol);
drh815b7822022-04-20 15:07:39 +0000585 sqlite3SrcItemColumnUsed(pLeft, iLeftCol);
drh052953a2022-04-16 22:57:41 +0000586 }
drhfe146992022-04-17 18:46:17 +0000587 if( pFuncArgs ){
588 pFuncArgs = sqlite3ExprListAppend(pParse, pFuncArgs, pE1);
589 pE1 = sqlite3ExprFunction(pParse, pFuncArgs, &tkCoalesce, 0);
drh052953a2022-04-16 22:57:41 +0000590 }
drh052953a2022-04-16 22:57:41 +0000591 }
drhfe146992022-04-17 18:46:17 +0000592 pE2 = sqlite3CreateColumnExpr(db, pSrc, i+1, iRightCol);
drh815b7822022-04-20 15:07:39 +0000593 sqlite3SrcItemColumnUsed(pRight, iRightCol);
drhfe146992022-04-17 18:46:17 +0000594 pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2);
595 assert( pE2!=0 || pEq==0 );
596 if( pEq ){
597 ExprSetProperty(pEq, joinType);
598 assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
599 ExprSetVVAProperty(pEq, EP_NoReduce);
600 pEq->w.iJoin = pE2->iTable;
601 }
602 p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pEq);
drhad2d8302002-05-24 20:31:36 +0000603 }
604 }
drhd44f8b22022-04-07 01:11:13 +0000605
606 /* Add the ON clause to the end of the WHERE clause, connected by
607 ** an AND operator.
608 */
609 else if( pRight->u3.pOn ){
drh3a6e4c52022-04-11 12:38:06 +0000610 sqlite3SetJoinExpr(pRight->u3.pOn, pRight->iCursor, joinType);
drhd44f8b22022-04-07 01:11:13 +0000611 p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pRight->u3.pOn);
612 pRight->u3.pOn = 0;
613 }
drhad2d8302002-05-24 20:31:36 +0000614 }
615 return 0;
616}
617
618/*
drhbbd4ae52018-04-30 19:32:49 +0000619** An instance of this object holds information (beyond pParse and pSelect)
620** needed to load the next result row that is to be added to the sorter.
621*/
622typedef struct RowLoadInfo RowLoadInfo;
623struct RowLoadInfo {
624 int regResult; /* Store results in array of registers here */
625 u8 ecelFlags; /* Flag argument to ExprCodeExprList() */
626#ifdef SQLITE_ENABLE_SORTER_REFERENCES
627 ExprList *pExtra; /* Extra columns needed by sorter refs */
628 int regExtraResult; /* Where to load the extra columns */
629#endif
630};
631
632/*
633** This routine does the work of loading query data into an array of
634** registers so that it can be added to the sorter.
635*/
636static void innerLoopLoadRow(
637 Parse *pParse, /* Statement under construction */
638 Select *pSelect, /* The query being coded */
639 RowLoadInfo *pInfo /* Info needed to complete the row load */
640){
641 sqlite3ExprCodeExprList(pParse, pSelect->pEList, pInfo->regResult,
642 0, pInfo->ecelFlags);
643#ifdef SQLITE_ENABLE_SORTER_REFERENCES
644 if( pInfo->pExtra ){
645 sqlite3ExprCodeExprList(pParse, pInfo->pExtra, pInfo->regExtraResult, 0, 0);
646 sqlite3ExprListDelete(pParse->db, pInfo->pExtra);
647 }
648#endif
649}
650
651/*
652** Code the OP_MakeRecord instruction that generates the entry to be
653** added into the sorter.
654**
655** Return the register in which the result is stored.
656*/
657static int makeSorterRecord(
658 Parse *pParse,
659 SortCtx *pSort,
660 Select *pSelect,
661 int regBase,
662 int nBase
663){
664 int nOBSat = pSort->nOBSat;
665 Vdbe *v = pParse->pVdbe;
666 int regOut = ++pParse->nMem;
667 if( pSort->pDeferredRowLoad ){
668 innerLoopLoadRow(pParse, pSelect, pSort->pDeferredRowLoad);
669 }
670 sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regOut);
671 return regOut;
672}
673
674/*
drhf45f2322014-03-23 17:45:03 +0000675** Generate code that will push the record in registers regData
676** through regData+nData-1 onto the sorter.
drhc926afb2002-06-20 03:38:26 +0000677*/
drhd59ba6c2006-01-08 05:02:54 +0000678static void pushOntoSorter(
679 Parse *pParse, /* Parser context */
drh079a3072014-03-19 14:10:55 +0000680 SortCtx *pSort, /* Information about the ORDER BY clause */
drhb7654112008-01-12 12:48:07 +0000681 Select *pSelect, /* The whole SELECT statement */
drhf45f2322014-03-23 17:45:03 +0000682 int regData, /* First register holding data to be sorted */
drh5579d592015-08-26 14:01:41 +0000683 int regOrigData, /* First register holding data before packing */
drhbbd4ae52018-04-30 19:32:49 +0000684 int nData, /* Number of elements in the regData data array */
drhfd0a2f92014-03-24 18:08:15 +0000685 int nPrefixReg /* No. of reg prior to regData available for use */
drhd59ba6c2006-01-08 05:02:54 +0000686){
drhf45f2322014-03-23 17:45:03 +0000687 Vdbe *v = pParse->pVdbe; /* Stmt under construction */
dan78d58432014-03-25 15:04:07 +0000688 int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
drhf45f2322014-03-23 17:45:03 +0000689 int nExpr = pSort->pOrderBy->nExpr; /* No. of ORDER BY terms */
dan78d58432014-03-25 15:04:07 +0000690 int nBase = nExpr + bSeq + nData; /* Fields in sorter record */
drhfd0a2f92014-03-24 18:08:15 +0000691 int regBase; /* Regs for sorter record */
drhbbd4ae52018-04-30 19:32:49 +0000692 int regRecord = 0; /* Assembled sorter record */
dan78d58432014-03-25 15:04:07 +0000693 int nOBSat = pSort->nOBSat; /* ORDER BY terms to skip */
694 int op; /* Opcode to add sorter record to sorter */
drha04a8be2016-01-13 17:50:10 +0000695 int iLimit; /* LIMIT counter */
drhbbd4ae52018-04-30 19:32:49 +0000696 int iSkip = 0; /* End of the sorter insert loop */
drhf45f2322014-03-23 17:45:03 +0000697
dan78d58432014-03-25 15:04:07 +0000698 assert( bSeq==0 || bSeq==1 );
drhbbd4ae52018-04-30 19:32:49 +0000699
700 /* Three cases:
701 ** (1) The data to be sorted has already been packed into a Record
702 ** by a prior OP_MakeRecord. In this case nData==1 and regData
703 ** will be completely unrelated to regOrigData.
704 ** (2) All output columns are included in the sort record. In that
705 ** case regData==regOrigData.
706 ** (3) Some output columns are omitted from the sort record due to
707 ** the SQLITE_ENABLE_SORTER_REFERENCE optimization, or due to the
drhc6f36fa2018-05-05 16:50:35 +0000708 ** SQLITE_ECEL_OMITREF optimization, or due to the
709 ** SortCtx.pDeferredRowLoad optimiation. In any of these cases
710 ** regOrigData is 0 to prevent this routine from trying to copy
711 ** values that might not yet exist.
drhbbd4ae52018-04-30 19:32:49 +0000712 */
dan9af90b72016-11-11 18:08:59 +0000713 assert( nData==1 || regData==regOrigData || regOrigData==0 );
drhbbd4ae52018-04-30 19:32:49 +0000714
drhfd0a2f92014-03-24 18:08:15 +0000715 if( nPrefixReg ){
dan78d58432014-03-25 15:04:07 +0000716 assert( nPrefixReg==nExpr+bSeq );
drhbbd4ae52018-04-30 19:32:49 +0000717 regBase = regData - nPrefixReg;
drhfd0a2f92014-03-24 18:08:15 +0000718 }else{
drhfb0d6e52014-05-02 13:09:06 +0000719 regBase = pParse->nMem + 1;
720 pParse->nMem += nBase;
drhfd0a2f92014-03-24 18:08:15 +0000721 }
drha04a8be2016-01-13 17:50:10 +0000722 assert( pSelect->iOffset==0 || pSelect->iLimit!=0 );
723 iLimit = pSelect->iOffset ? pSelect->iOffset+1 : pSelect->iLimit;
drhec4ccdb2018-12-29 02:26:59 +0000724 pSort->labelDone = sqlite3VdbeMakeLabel(pParse);
drh5579d592015-08-26 14:01:41 +0000725 sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, regOrigData,
dan9af90b72016-11-11 18:08:59 +0000726 SQLITE_ECEL_DUP | (regOrigData? SQLITE_ECEL_REF : 0));
dan78d58432014-03-25 15:04:07 +0000727 if( bSeq ){
728 sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
drhfd0a2f92014-03-24 18:08:15 +0000729 }
dan257c13f2016-11-10 20:14:06 +0000730 if( nPrefixReg==0 && nData>0 ){
drh236241a2014-09-12 17:41:30 +0000731 sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
dan78d58432014-03-25 15:04:07 +0000732 }
drh079a3072014-03-19 14:10:55 +0000733 if( nOBSat>0 ){
734 int regPrevKey; /* The first nOBSat columns of the previous row */
735 int addrFirst; /* Address of the OP_IfNot opcode */
736 int addrJmp; /* Address of the OP_Jump opcode */
737 VdbeOp *pOp; /* Opcode that opens the sorter */
738 int nKey; /* Number of sorting key columns, including OP_Sequence */
drhdbfca2b2014-03-22 02:19:53 +0000739 KeyInfo *pKI; /* Original KeyInfo on the sorter table */
drh079a3072014-03-19 14:10:55 +0000740
drhbbd4ae52018-04-30 19:32:49 +0000741 regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
drh26d7e7c2014-03-19 16:56:58 +0000742 regPrevKey = pParse->nMem+1;
743 pParse->nMem += pSort->nOBSat;
dan78d58432014-03-25 15:04:07 +0000744 nKey = nExpr - pSort->nOBSat + bSeq;
745 if( bSeq ){
746 addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
747 }else{
748 addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
749 }
750 VdbeCoverage(v);
drh26d7e7c2014-03-19 16:56:58 +0000751 sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
drh079a3072014-03-19 14:10:55 +0000752 pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
drh59b8f2e2014-03-22 00:27:14 +0000753 if( pParse->db->mallocFailed ) return;
drhfb0d6e52014-05-02 13:09:06 +0000754 pOp->p2 = nKey + nData;
drhdbfca2b2014-03-22 02:19:53 +0000755 pKI = pOp->p4.pKeyInfo;
dan6e118922019-08-12 16:36:38 +0000756 memset(pKI->aSortFlags, 0, pKI->nKeyField); /* Makes OP_Jump testable */
drhdbfca2b2014-03-22 02:19:53 +0000757 sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
drha485ad12017-08-02 22:43:14 +0000758 testcase( pKI->nAllField > pKI->nKeyField+2 );
danf9eae182018-05-21 19:45:11 +0000759 pOp->p4.pKeyInfo = sqlite3KeyInfoFromExprList(pParse,pSort->pOrderBy,nOBSat,
drha485ad12017-08-02 22:43:14 +0000760 pKI->nAllField-pKI->nKeyField-1);
drh166bc382019-10-26 15:40:17 +0000761 pOp = 0; /* Ensure pOp not used after sqltie3VdbeAddOp3() */
drh079a3072014-03-19 14:10:55 +0000762 addrJmp = sqlite3VdbeCurrentAddr(v);
763 sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
drhec4ccdb2018-12-29 02:26:59 +0000764 pSort->labelBkOut = sqlite3VdbeMakeLabel(pParse);
drh079a3072014-03-19 14:10:55 +0000765 pSort->regReturn = ++pParse->nMem;
766 sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
drh65ea12c2014-03-19 17:41:36 +0000767 sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
drha04a8be2016-01-13 17:50:10 +0000768 if( iLimit ){
769 sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, pSort->labelDone);
770 VdbeCoverage(v);
771 }
drh079a3072014-03-19 14:10:55 +0000772 sqlite3VdbeJumpHere(v, addrFirst);
drh236241a2014-09-12 17:41:30 +0000773 sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
drh079a3072014-03-19 14:10:55 +0000774 sqlite3VdbeJumpHere(v, addrJmp);
775 }
danf226f032018-04-26 16:13:47 +0000776 if( iLimit ){
777 /* At this point the values for the new sorter entry are stored
778 ** in an array of registers. They need to be composed into a record
779 ** and inserted into the sorter if either (a) there are currently
780 ** less than LIMIT+OFFSET items or (b) the new record is smaller than
781 ** the largest record currently in the sorter. If (b) is true and there
782 ** are already LIMIT+OFFSET items in the sorter, delete the largest
783 ** entry before inserting the new one. This way there are never more
784 ** than LIMIT+OFFSET items in the sorter.
785 **
786 ** If the new record does not need to be inserted into the sorter,
drh6ee5a7b2018-09-08 20:09:46 +0000787 ** jump to the next iteration of the loop. If the pSort->labelOBLopt
788 ** value is not zero, then it is a label of where to jump. Otherwise,
789 ** just bypass the row insert logic. See the header comment on the
790 ** sqlite3WhereOrderByLimitOptLabel() function for additional info.
danf226f032018-04-26 16:13:47 +0000791 */
792 int iCsr = pSort->iECursor;
danf226f032018-04-26 16:13:47 +0000793 sqlite3VdbeAddOp2(v, OP_IfNotZero, iLimit, sqlite3VdbeCurrentAddr(v)+4);
794 VdbeCoverage(v);
795 sqlite3VdbeAddOp2(v, OP_Last, iCsr, 0);
drhbbd4ae52018-04-30 19:32:49 +0000796 iSkip = sqlite3VdbeAddOp4Int(v, OP_IdxLE,
797 iCsr, 0, regBase+nOBSat, nExpr-nOBSat);
danf226f032018-04-26 16:13:47 +0000798 VdbeCoverage(v);
799 sqlite3VdbeAddOp1(v, OP_Delete, iCsr);
800 }
drhbbd4ae52018-04-30 19:32:49 +0000801 if( regRecord==0 ){
802 regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
danf226f032018-04-26 16:13:47 +0000803 }
drh079a3072014-03-19 14:10:55 +0000804 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drhc6aff302011-09-01 15:32:47 +0000805 op = OP_SorterInsert;
806 }else{
807 op = OP_IdxInsert;
808 }
drh4a8b0132016-11-09 01:38:56 +0000809 sqlite3VdbeAddOp4Int(v, op, pSort->iECursor, regRecord,
810 regBase+nOBSat, nBase-nOBSat);
drhbbd4ae52018-04-30 19:32:49 +0000811 if( iSkip ){
drhbbd4ae52018-04-30 19:32:49 +0000812 sqlite3VdbeChangeP2(v, iSkip,
drh6ee5a7b2018-09-08 20:09:46 +0000813 pSort->labelOBLopt ? pSort->labelOBLopt : sqlite3VdbeCurrentAddr(v));
drhbbd4ae52018-04-30 19:32:49 +0000814 }
drhc926afb2002-06-20 03:38:26 +0000815}
816
817/*
drhec7429a2005-10-06 16:53:14 +0000818** Add code to implement the OFFSET
drhea48eb22004-07-19 23:16:38 +0000819*/
drhec7429a2005-10-06 16:53:14 +0000820static void codeOffset(
drhbab39e12004-07-19 23:38:11 +0000821 Vdbe *v, /* Generate code into this VM */
drhaa9ce702014-01-22 18:07:04 +0000822 int iOffset, /* Register holding the offset counter */
drhb7654112008-01-12 12:48:07 +0000823 int iContinue /* Jump here to skip the current record */
drhea48eb22004-07-19 23:16:38 +0000824){
drha22a75e2014-03-21 18:16:23 +0000825 if( iOffset>0 ){
drh8b0cf382015-10-06 21:07:06 +0000826 sqlite3VdbeAddOp3(v, OP_IfPos, iOffset, iContinue, 1); VdbeCoverage(v);
827 VdbeComment((v, "OFFSET"));
drhea48eb22004-07-19 23:16:38 +0000828 }
drhea48eb22004-07-19 23:16:38 +0000829}
830
831/*
dan96ecb7b2021-03-09 16:47:33 +0000832** Add code that will check to make sure the array of registers starting at
833** iMem form a distinct entry. This is used by both "SELECT DISTINCT ..." and
dan76075802021-03-12 21:09:20 +0000834** distinct aggregates ("SELECT count(DISTINCT <expr>) ..."). Three strategies
835** are available. Which is used depends on the value of parameter eTnctType,
836** as follows:
drha2a49dc2008-01-02 14:28:13 +0000837**
dan96ecb7b2021-03-09 16:47:33 +0000838** WHERE_DISTINCT_UNORDERED/WHERE_DISTINCT_NOOP:
drh9be13392021-03-24 19:44:01 +0000839** Build an ephemeral table that contains all entries seen before and
840** skip entries which have been seen before.
841**
dan76075802021-03-12 21:09:20 +0000842** Parameter iTab is the cursor number of an ephemeral table that must
843** be opened before the VM code generated by this routine is executed.
dan5383db72021-03-12 18:24:31 +0000844** The ephemeral cursor table is queried for a record identical to the
dan96ecb7b2021-03-09 16:47:33 +0000845** record formed by the current array of registers. If one is found,
846** jump to VM address addrRepeat. Otherwise, insert a new record into
847** the ephemeral cursor and proceed.
848**
dan76075802021-03-12 21:09:20 +0000849** The returned value in this case is a copy of parameter iTab.
850**
dan96ecb7b2021-03-09 16:47:33 +0000851** WHERE_DISTINCT_ORDERED:
drh9be13392021-03-24 19:44:01 +0000852** In this case rows are being delivered sorted order. The ephermal
853** table is not required. Instead, the current set of values
854** is compared against previous row. If they match, the new row
dan96ecb7b2021-03-09 16:47:33 +0000855** is not distinct and control jumps to VM address addrRepeat. Otherwise,
856** the VM program proceeds with processing the new row.
857**
dan76075802021-03-12 21:09:20 +0000858** The returned value in this case is the register number of the first
859** in an array of registers used to store the previous result row so that
drh9be13392021-03-24 19:44:01 +0000860** it can be compared to the next. The caller must ensure that this
861** register is initialized to NULL. (The fixDistinctOpenEph() routine
862** will take care of this initialization.)
dan76075802021-03-12 21:09:20 +0000863**
dan96ecb7b2021-03-09 16:47:33 +0000864** WHERE_DISTINCT_UNIQUE:
865** In this case it has already been determined that the rows are distinct.
drh9be13392021-03-24 19:44:01 +0000866** No special action is required. The return value is zero.
dan96ecb7b2021-03-09 16:47:33 +0000867**
868** Parameter pEList is the list of expressions used to generated the
869** contents of each row. It is used by this routine to determine (a)
870** how many elements there are in the array of registers and (b) the
871** collation sequences that should be used for the comparisons if
872** eTnctType is WHERE_DISTINCT_ORDERED.
drha2a49dc2008-01-02 14:28:13 +0000873*/
dan5383db72021-03-12 18:24:31 +0000874static int codeDistinct(
drh2dcef112008-01-12 19:03:48 +0000875 Parse *pParse, /* Parsing and code generating context */
dan4fcb30b2021-03-09 16:06:25 +0000876 int eTnctType, /* WHERE_DISTINCT_* value */
drha2a49dc2008-01-02 14:28:13 +0000877 int iTab, /* A sorting index used to test for distinctness */
878 int addrRepeat, /* Jump to here if not distinct */
dan4fcb30b2021-03-09 16:06:25 +0000879 ExprList *pEList, /* Expression for each element */
880 int regElem /* First element */
drha2a49dc2008-01-02 14:28:13 +0000881){
dan5383db72021-03-12 18:24:31 +0000882 int iRet = 0;
dan4fcb30b2021-03-09 16:06:25 +0000883 int nResultCol = pEList->nExpr;
884 Vdbe *v = pParse->pVdbe;
drh2dcef112008-01-12 19:03:48 +0000885
dan4fcb30b2021-03-09 16:06:25 +0000886 switch( eTnctType ){
887 case WHERE_DISTINCT_ORDERED: {
888 int i;
dan4fcb30b2021-03-09 16:06:25 +0000889 int iJump; /* Jump destination */
890 int regPrev; /* Previous row content */
891
892 /* Allocate space for the previous row */
dan5383db72021-03-12 18:24:31 +0000893 iRet = regPrev = pParse->nMem+1;
dan4fcb30b2021-03-09 16:06:25 +0000894 pParse->nMem += nResultCol;
895
dan4fcb30b2021-03-09 16:06:25 +0000896 iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
897 for(i=0; i<nResultCol; i++){
898 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pEList->a[i].pExpr);
899 if( i<nResultCol-1 ){
900 sqlite3VdbeAddOp3(v, OP_Ne, regElem+i, iJump, regPrev+i);
901 VdbeCoverage(v);
902 }else{
903 sqlite3VdbeAddOp3(v, OP_Eq, regElem+i, addrRepeat, regPrev+i);
904 VdbeCoverage(v);
905 }
906 sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
907 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
908 }
909 assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
910 sqlite3VdbeAddOp3(v, OP_Copy, regElem, regPrev, nResultCol-1);
911 break;
912 }
913
914 case WHERE_DISTINCT_UNIQUE: {
dan5383db72021-03-12 18:24:31 +0000915 /* nothing to do */
dan4fcb30b2021-03-09 16:06:25 +0000916 break;
917 }
918
919 default: {
920 int r1 = sqlite3GetTempReg(pParse);
921 sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, regElem, nResultCol);
922 VdbeCoverage(v);
923 sqlite3VdbeAddOp3(v, OP_MakeRecord, regElem, nResultCol, r1);
924 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r1, regElem, nResultCol);
925 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
926 sqlite3ReleaseTempReg(pParse, r1);
dan5383db72021-03-12 18:24:31 +0000927 iRet = iTab;
dan4fcb30b2021-03-09 16:06:25 +0000928 break;
929 }
930 }
dan5383db72021-03-12 18:24:31 +0000931
932 return iRet;
933}
934
dan76075802021-03-12 21:09:20 +0000935/*
drh9be13392021-03-24 19:44:01 +0000936** This routine runs after codeDistinct(). It makes necessary
937** adjustments to the OP_OpenEphemeral opcode that the codeDistinct()
938** routine made use of. This processing must be done separately since
939** sometimes codeDistinct is called before the OP_OpenEphemeral is actually
940** laid down.
dan76075802021-03-12 21:09:20 +0000941**
drh9be13392021-03-24 19:44:01 +0000942** WHERE_DISTINCT_NOOP:
943** WHERE_DISTINCT_UNORDERED:
dan76075802021-03-12 21:09:20 +0000944**
drh9be13392021-03-24 19:44:01 +0000945** No adjustments necessary. This function is a no-op.
dan76075802021-03-12 21:09:20 +0000946**
drh9be13392021-03-24 19:44:01 +0000947** WHERE_DISTINCT_UNIQUE:
948**
949** The ephemeral table is not needed. So change the
950** OP_OpenEphemeral opcode into an OP_Noop.
951**
952** WHERE_DISTINCT_ORDERED:
953**
954** The ephemeral table is not needed. But we do need register
955** iVal to be initialized to NULL. So change the OP_OpenEphemeral
956** into an OP_Null on the iVal register.
dan76075802021-03-12 21:09:20 +0000957*/
dan5383db72021-03-12 18:24:31 +0000958static void fixDistinctOpenEph(
959 Parse *pParse, /* Parsing and code generating context */
960 int eTnctType, /* WHERE_DISTINCT_* value */
961 int iVal, /* Value returned by codeDistinct() */
dan76075802021-03-12 21:09:20 +0000962 int iOpenEphAddr /* Address of OP_OpenEphemeral instruction for iTab */
dan5383db72021-03-12 18:24:31 +0000963){
drhc6da6db2021-07-28 02:04:58 +0000964 if( pParse->nErr==0
965 && (eTnctType==WHERE_DISTINCT_UNIQUE || eTnctType==WHERE_DISTINCT_ORDERED)
966 ){
dan5383db72021-03-12 18:24:31 +0000967 Vdbe *v = pParse->pVdbe;
dan76075802021-03-12 21:09:20 +0000968 sqlite3VdbeChangeToNoop(v, iOpenEphAddr);
drh9be13392021-03-24 19:44:01 +0000969 if( sqlite3VdbeGetOp(v, iOpenEphAddr+1)->opcode==OP_Explain ){
970 sqlite3VdbeChangeToNoop(v, iOpenEphAddr+1);
971 }
dan5383db72021-03-12 18:24:31 +0000972 if( eTnctType==WHERE_DISTINCT_ORDERED ){
973 /* Change the OP_OpenEphemeral to an OP_Null that sets the MEM_Cleared
974 ** bit on the first register of the previous value. This will cause the
975 ** OP_Ne added in codeDistinct() to always fail on the first iteration of
976 ** the loop even if the first row is all NULLs. */
dan76075802021-03-12 21:09:20 +0000977 VdbeOp *pOp = sqlite3VdbeGetOp(v, iOpenEphAddr);
dan5383db72021-03-12 18:24:31 +0000978 pOp->opcode = OP_Null;
979 pOp->p1 = 1;
980 pOp->p2 = iVal;
981 }
982 }
drha2a49dc2008-01-02 14:28:13 +0000983}
984
dan24e25d32018-04-14 18:46:20 +0000985#ifdef SQLITE_ENABLE_SORTER_REFERENCES
986/*
987** This function is called as part of inner-loop generation for a SELECT
988** statement with an ORDER BY that is not optimized by an index. It
989** determines the expressions, if any, that the sorter-reference
990** optimization should be used for. The sorter-reference optimization
991** is used for SELECT queries like:
992**
993** SELECT a, bigblob FROM t1 ORDER BY a LIMIT 10
994**
995** If the optimization is used for expression "bigblob", then instead of
996** storing values read from that column in the sorter records, the PK of
997** the row from table t1 is stored instead. Then, as records are extracted from
998** the sorter to return to the user, the required value of bigblob is
999** retrieved directly from table t1. If the values are very large, this
1000** can be more efficient than storing them directly in the sorter records.
1001**
1002** The ExprList_item.bSorterRef flag is set for each expression in pEList
1003** for which the sorter-reference optimization should be enabled.
1004** Additionally, the pSort->aDefer[] array is populated with entries
1005** for all cursors required to evaluate all selected expressions. Finally.
1006** output variable (*ppExtra) is set to an expression list containing
1007** expressions for all extra PK values that should be stored in the
1008** sorter records.
1009*/
1010static void selectExprDefer(
1011 Parse *pParse, /* Leave any error here */
1012 SortCtx *pSort, /* Sorter context */
1013 ExprList *pEList, /* Expressions destined for sorter */
1014 ExprList **ppExtra /* Expressions to append to sorter record */
1015){
1016 int i;
1017 int nDefer = 0;
1018 ExprList *pExtra = 0;
1019 for(i=0; i<pEList->nExpr; i++){
1020 struct ExprList_item *pItem = &pEList->a[i];
1021 if( pItem->u.x.iOrderByCol==0 ){
1022 Expr *pExpr = pItem->pExpr;
drh477572b2021-10-07 20:46:29 +00001023 Table *pTab;
drhffa5b052021-10-12 18:05:55 +00001024 if( pExpr->op==TK_COLUMN
1025 && pExpr->iColumn>=0
1026 && ALWAYS( ExprUseYTab(pExpr) )
1027 && (pTab = pExpr->y.pTab)!=0
1028 && IsOrdinaryTable(pTab)
1029 && (pTab->aCol[pExpr->iColumn].colFlags & COLFLAG_SORTERREF)!=0
dan24e25d32018-04-14 18:46:20 +00001030 ){
1031 int j;
1032 for(j=0; j<nDefer; j++){
1033 if( pSort->aDefer[j].iCsr==pExpr->iTable ) break;
1034 }
1035 if( j==nDefer ){
1036 if( nDefer==ArraySize(pSort->aDefer) ){
1037 continue;
1038 }else{
1039 int nKey = 1;
1040 int k;
1041 Index *pPk = 0;
1042 if( !HasRowid(pTab) ){
1043 pPk = sqlite3PrimaryKeyIndex(pTab);
1044 nKey = pPk->nKeyCol;
1045 }
1046 for(k=0; k<nKey; k++){
1047 Expr *pNew = sqlite3PExpr(pParse, TK_COLUMN, 0, 0);
1048 if( pNew ){
1049 pNew->iTable = pExpr->iTable;
drh477572b2021-10-07 20:46:29 +00001050 assert( ExprUseYTab(pNew) );
drheda079c2018-09-20 19:02:15 +00001051 pNew->y.pTab = pExpr->y.pTab;
dan24e25d32018-04-14 18:46:20 +00001052 pNew->iColumn = pPk ? pPk->aiColumn[k] : -1;
1053 pExtra = sqlite3ExprListAppend(pParse, pExtra, pNew);
1054 }
1055 }
drheda079c2018-09-20 19:02:15 +00001056 pSort->aDefer[nDefer].pTab = pExpr->y.pTab;
dan24e25d32018-04-14 18:46:20 +00001057 pSort->aDefer[nDefer].iCsr = pExpr->iTable;
1058 pSort->aDefer[nDefer].nKey = nKey;
1059 nDefer++;
1060 }
1061 }
1062 pItem->bSorterRef = 1;
1063 }
1064 }
1065 }
1066 pSort->nDefer = (u8)nDefer;
1067 *ppExtra = pExtra;
1068}
1069#endif
1070
drhc99130f2005-09-11 11:56:27 +00001071/*
drh22827922000-06-06 17:27:05 +00001072** This routine generates the code for the inside of the inner loop
1073** of a SELECT.
drh82c3d632000-06-06 21:56:07 +00001074**
drh2def2f72017-09-15 17:40:34 +00001075** If srcTab is negative, then the p->pEList expressions
drh340309f2014-01-22 00:23:49 +00001076** are evaluated in order to get the data for this row. If srcTab is
drh2def2f72017-09-15 17:40:34 +00001077** zero or more, then data is pulled from srcTab and p->pEList is used only
dan257c13f2016-11-10 20:14:06 +00001078** to get the number of columns and the collation sequence for each column.
drh22827922000-06-06 17:27:05 +00001079*/
drhd2b3e232008-01-23 14:51:49 +00001080static void selectInnerLoop(
drh22827922000-06-06 17:27:05 +00001081 Parse *pParse, /* The parser context */
drhdf199a22002-06-14 22:38:41 +00001082 Select *p, /* The complete select statement being coded */
drh2def2f72017-09-15 17:40:34 +00001083 int srcTab, /* Pull data from this table if non-negative */
drh079a3072014-03-19 14:10:55 +00001084 SortCtx *pSort, /* If not NULL, info on how to process ORDER BY */
drhe8e4af72012-09-21 00:04:28 +00001085 DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
danielk19776c8c8ce2008-01-02 16:27:09 +00001086 SelectDest *pDest, /* How to dispose of the results */
drh22827922000-06-06 17:27:05 +00001087 int iContinue, /* Jump here to continue with next row */
drha9671a22008-07-08 23:40:20 +00001088 int iBreak /* Jump here to break out of the inner loop */
drh22827922000-06-06 17:27:05 +00001089){
1090 Vdbe *v = pParse->pVdbe;
drhd847eaa2008-01-17 17:15:56 +00001091 int i;
dan9af90b72016-11-11 18:08:59 +00001092 int hasDistinct; /* True if the DISTINCT keyword is present */
drhd847eaa2008-01-17 17:15:56 +00001093 int eDest = pDest->eDest; /* How to dispose of results */
drh2b596da2012-07-23 21:43:19 +00001094 int iParm = pDest->iSDParm; /* First argument to disposal method */
drhd847eaa2008-01-17 17:15:56 +00001095 int nResultCol; /* Number of result columns */
drhfd0a2f92014-03-24 18:08:15 +00001096 int nPrefixReg = 0; /* Number of extra registers before regResult */
drhbbd4ae52018-04-30 19:32:49 +00001097 RowLoadInfo sRowLoadInfo; /* Info for deferred row loading */
drh38640e12002-07-05 21:42:36 +00001098
dan9af90b72016-11-11 18:08:59 +00001099 /* Usually, regResult is the first cell in an array of memory cells
1100 ** containing the current result row. In this case regOrig is set to the
1101 ** same value. However, if the results are being sent to the sorter, the
1102 ** values for any expressions that are also part of the sort-key are omitted
1103 ** from this array. In this case regOrig is set to zero. */
1104 int regResult; /* Start of memory holding current results */
1105 int regOrig; /* Start of memory holding full result (or 0) */
1106
drh1c767f02009-01-09 02:49:31 +00001107 assert( v );
drh2def2f72017-09-15 17:40:34 +00001108 assert( p->pEList!=0 );
drhe8e4af72012-09-21 00:04:28 +00001109 hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
drh079a3072014-03-19 14:10:55 +00001110 if( pSort && pSort->pOrderBy==0 ) pSort = 0;
1111 if( pSort==0 && !hasDistinct ){
drha22a75e2014-03-21 18:16:23 +00001112 assert( iContinue!=0 );
drhaa9ce702014-01-22 18:07:04 +00001113 codeOffset(v, p->iOffset, iContinue);
drhdf199a22002-06-14 22:38:41 +00001114 }
1115
drh967e8b72000-06-21 13:59:10 +00001116 /* Pull the requested columns.
drh22827922000-06-06 17:27:05 +00001117 */
drh2def2f72017-09-15 17:40:34 +00001118 nResultCol = p->pEList->nExpr;
drh05a86c52014-02-16 01:55:49 +00001119
drh2b596da2012-07-23 21:43:19 +00001120 if( pDest->iSdst==0 ){
drhfd0a2f92014-03-24 18:08:15 +00001121 if( pSort ){
dan78d58432014-03-25 15:04:07 +00001122 nPrefixReg = pSort->pOrderBy->nExpr;
1123 if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
drhfd0a2f92014-03-24 18:08:15 +00001124 pParse->nMem += nPrefixReg;
1125 }
drh2b596da2012-07-23 21:43:19 +00001126 pDest->iSdst = pParse->nMem+1;
drh0acb7e42008-06-25 00:12:41 +00001127 pParse->nMem += nResultCol;
drh05a86c52014-02-16 01:55:49 +00001128 }else if( pDest->iSdst+nResultCol > pParse->nMem ){
1129 /* This is an error condition that can result, for example, when a SELECT
1130 ** on the right-hand side of an INSERT contains more result columns than
1131 ** there are columns in the table on the left. The error will be caught
1132 ** and reported later. But we need to make sure enough memory is allocated
1133 ** to avoid other spurious errors in the meantime. */
1134 pParse->nMem += nResultCol;
drh1013c932008-01-06 00:25:21 +00001135 }
drh05a86c52014-02-16 01:55:49 +00001136 pDest->nSdst = nResultCol;
dan9af90b72016-11-11 18:08:59 +00001137 regOrig = regResult = pDest->iSdst;
drh340309f2014-01-22 00:23:49 +00001138 if( srcTab>=0 ){
1139 for(i=0; i<nResultCol; i++){
drhd847eaa2008-01-17 17:15:56 +00001140 sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
drh41cee662019-12-12 20:22:34 +00001141 VdbeComment((v, "%s", p->pEList->a[i].zEName));
drh82c3d632000-06-06 21:56:07 +00001142 }
danielk19779ed1dfa2008-01-02 17:11:14 +00001143 }else if( eDest!=SRT_Exists ){
dan24e25d32018-04-14 18:46:20 +00001144#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1145 ExprList *pExtra = 0;
1146#endif
danielk19779ed1dfa2008-01-02 17:11:14 +00001147 /* If the destination is an EXISTS(...) expression, the actual
1148 ** values returned by the SELECT are not required.
1149 */
drhbbd4ae52018-04-30 19:32:49 +00001150 u8 ecelFlags; /* "ecel" is an abbreviation of "ExprCodeExprList" */
1151 ExprList *pEList;
drhdf553652015-05-18 04:24:27 +00001152 if( eDest==SRT_Mem || eDest==SRT_Output || eDest==SRT_Coroutine ){
1153 ecelFlags = SQLITE_ECEL_DUP;
1154 }else{
1155 ecelFlags = 0;
1156 }
danac56ab72017-01-05 17:23:11 +00001157 if( pSort && hasDistinct==0 && eDest!=SRT_EphemTab && eDest!=SRT_Table ){
drh2def2f72017-09-15 17:40:34 +00001158 /* For each expression in p->pEList that is a copy of an expression in
dan257c13f2016-11-10 20:14:06 +00001159 ** the ORDER BY clause (pSort->pOrderBy), set the associated
1160 ** iOrderByCol value to one more than the index of the ORDER BY
1161 ** expression within the sort-key that pushOntoSorter() will generate.
drh2def2f72017-09-15 17:40:34 +00001162 ** This allows the p->pEList field to be omitted from the sorted record,
dan257c13f2016-11-10 20:14:06 +00001163 ** saving space and CPU cycles. */
1164 ecelFlags |= (SQLITE_ECEL_OMITREF|SQLITE_ECEL_REF);
drhbbd4ae52018-04-30 19:32:49 +00001165
dan257c13f2016-11-10 20:14:06 +00001166 for(i=pSort->nOBSat; i<pSort->pOrderBy->nExpr; i++){
1167 int j;
1168 if( (j = pSort->pOrderBy->a[i].u.x.iOrderByCol)>0 ){
drh2def2f72017-09-15 17:40:34 +00001169 p->pEList->a[j-1].u.x.iOrderByCol = i+1-pSort->nOBSat;
dan257c13f2016-11-10 20:14:06 +00001170 }
1171 }
dan24e25d32018-04-14 18:46:20 +00001172#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1173 selectExprDefer(pParse, pSort, p->pEList, &pExtra);
drh5a2e65e2018-04-18 19:08:44 +00001174 if( pExtra && pParse->db->mallocFailed==0 ){
dan24e25d32018-04-14 18:46:20 +00001175 /* If there are any extra PK columns to add to the sorter records,
1176 ** allocate extra memory cells and adjust the OpenEphemeral
1177 ** instruction to account for the larger records. This is only
1178 ** required if there are one or more WITHOUT ROWID tables with
1179 ** composite primary keys in the SortCtx.aDefer[] array. */
1180 VdbeOp *pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
1181 pOp->p2 += (pExtra->nExpr - pSort->nDefer);
1182 pOp->p4.pKeyInfo->nAllField += (pExtra->nExpr - pSort->nDefer);
1183 pParse->nMem += pExtra->nExpr;
1184 }
1185#endif
drhbbd4ae52018-04-30 19:32:49 +00001186
1187 /* Adjust nResultCol to account for columns that are omitted
1188 ** from the sorter by the optimizations in this branch */
1189 pEList = p->pEList;
1190 for(i=0; i<pEList->nExpr; i++){
1191 if( pEList->a[i].u.x.iOrderByCol>0
1192#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1193 || pEList->a[i].bSorterRef
1194#endif
1195 ){
1196 nResultCol--;
1197 regOrig = 0;
1198 }
1199 }
1200
1201 testcase( regOrig );
1202 testcase( eDest==SRT_Set );
1203 testcase( eDest==SRT_Mem );
1204 testcase( eDest==SRT_Coroutine );
1205 testcase( eDest==SRT_Output );
dan257c13f2016-11-10 20:14:06 +00001206 assert( eDest==SRT_Set || eDest==SRT_Mem
danf2972b62020-04-29 20:11:01 +00001207 || eDest==SRT_Coroutine || eDest==SRT_Output
1208 || eDest==SRT_Upfrom );
dan257c13f2016-11-10 20:14:06 +00001209 }
drhbbd4ae52018-04-30 19:32:49 +00001210 sRowLoadInfo.regResult = regResult;
1211 sRowLoadInfo.ecelFlags = ecelFlags;
dan24e25d32018-04-14 18:46:20 +00001212#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhbbd4ae52018-04-30 19:32:49 +00001213 sRowLoadInfo.pExtra = pExtra;
1214 sRowLoadInfo.regExtraResult = regResult + nResultCol;
1215 if( pExtra ) nResultCol += pExtra->nExpr;
dan24e25d32018-04-14 18:46:20 +00001216#endif
drhbbd4ae52018-04-30 19:32:49 +00001217 if( p->iLimit
1218 && (ecelFlags & SQLITE_ECEL_OMITREF)!=0
1219 && nPrefixReg>0
1220 ){
1221 assert( pSort!=0 );
1222 assert( hasDistinct==0 );
1223 pSort->pDeferredRowLoad = &sRowLoadInfo;
drhc6f36fa2018-05-05 16:50:35 +00001224 regOrig = 0;
drhbbd4ae52018-04-30 19:32:49 +00001225 }else{
1226 innerLoopLoadRow(pParse, p, &sRowLoadInfo);
1227 }
drh22827922000-06-06 17:27:05 +00001228 }
1229
drhdaffd0e2001-04-11 14:28:42 +00001230 /* If the DISTINCT keyword was present on the SELECT statement
1231 ** and this row has been seen before, then do not make this row
1232 ** part of the result.
drh22827922000-06-06 17:27:05 +00001233 */
drhea48eb22004-07-19 23:16:38 +00001234 if( hasDistinct ){
dan5383db72021-03-12 18:24:31 +00001235 int eType = pDistinct->eTnctType;
1236 int iTab = pDistinct->tabTnct;
dan4fcb30b2021-03-09 16:06:25 +00001237 assert( nResultCol==p->pEList->nExpr );
dan5383db72021-03-12 18:24:31 +00001238 iTab = codeDistinct(pParse, eType, iTab, iContinue, p->pEList, regResult);
1239 fixDistinctOpenEph(pParse, eType, iTab, pDistinct->addrTnct);
drh079a3072014-03-19 14:10:55 +00001240 if( pSort==0 ){
drhaa9ce702014-01-22 18:07:04 +00001241 codeOffset(v, p->iOffset, iContinue);
drhea48eb22004-07-19 23:16:38 +00001242 }
drh22827922000-06-06 17:27:05 +00001243 }
drh82c3d632000-06-06 21:56:07 +00001244
drhc926afb2002-06-20 03:38:26 +00001245 switch( eDest ){
1246 /* In this mode, write each query result to the key of the temporary
1247 ** table iParm.
1248 */
drh13449892005-09-07 21:22:45 +00001249#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhc926afb2002-06-20 03:38:26 +00001250 case SRT_Union: {
drh9cbf3422008-01-17 16:22:13 +00001251 int r1;
1252 r1 = sqlite3GetTempReg(pParse);
drh340309f2014-01-22 00:23:49 +00001253 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
drh9b4eaeb2016-11-09 00:10:33 +00001254 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
drh9cbf3422008-01-17 16:22:13 +00001255 sqlite3ReleaseTempReg(pParse, r1);
drhc926afb2002-06-20 03:38:26 +00001256 break;
drh22827922000-06-06 17:27:05 +00001257 }
drh22827922000-06-06 17:27:05 +00001258
drhc926afb2002-06-20 03:38:26 +00001259 /* Construct a record from the query result, but instead of
1260 ** saving that record, use it as a key to delete elements from
1261 ** the temporary table iParm.
1262 */
1263 case SRT_Except: {
drh340309f2014-01-22 00:23:49 +00001264 sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
drhc926afb2002-06-20 03:38:26 +00001265 break;
1266 }
drh781def22014-01-22 13:35:53 +00001267#endif /* SQLITE_OMIT_COMPOUND_SELECT */
danielk19775338a5f2005-01-20 13:03:10 +00001268
1269 /* Store the result as data using a unique key.
1270 */
drh8e1ee882014-03-21 19:56:09 +00001271 case SRT_Fifo:
1272 case SRT_DistFifo:
danielk19775338a5f2005-01-20 13:03:10 +00001273 case SRT_Table:
drhb9bb7c12006-06-11 23:41:55 +00001274 case SRT_EphemTab: {
drhfd0a2f92014-03-24 18:08:15 +00001275 int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
drh373cc2d2009-05-17 02:06:14 +00001276 testcase( eDest==SRT_Table );
1277 testcase( eDest==SRT_EphemTab );
drhe2248cf2015-05-22 17:29:27 +00001278 testcase( eDest==SRT_Fifo );
1279 testcase( eDest==SRT_DistFifo );
drhfd0a2f92014-03-24 18:08:15 +00001280 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
dan8ce71842014-01-14 20:14:09 +00001281#ifndef SQLITE_OMIT_CTE
drh8e1ee882014-03-21 19:56:09 +00001282 if( eDest==SRT_DistFifo ){
1283 /* If the destination is DistFifo, then cursor (iParm+1) is open
dan8ce71842014-01-14 20:14:09 +00001284 ** on an ephemeral index. If the current row is already present
1285 ** in the index, do not write it to the output. If not, add the
1286 ** current row to the index and proceed with writing it to the
1287 ** output table as well. */
1288 int addr = sqlite3VdbeCurrentAddr(v) + 4;
drh38b41492015-06-08 15:08:15 +00001289 sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0);
1290 VdbeCoverage(v);
drh9b4eaeb2016-11-09 00:10:33 +00001291 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm+1, r1,regResult,nResultCol);
drh079a3072014-03-19 14:10:55 +00001292 assert( pSort==0 );
dan8ce71842014-01-14 20:14:09 +00001293 }
1294#endif
drh079a3072014-03-19 14:10:55 +00001295 if( pSort ){
drhbbd4ae52018-04-30 19:32:49 +00001296 assert( regResult==regOrig );
1297 pushOntoSorter(pParse, pSort, p, r1+nPrefixReg, regOrig, 1, nPrefixReg);
danielk19775338a5f2005-01-20 13:03:10 +00001298 }else{
drhb7654112008-01-12 12:48:07 +00001299 int r2 = sqlite3GetTempReg(pParse);
1300 sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
1301 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
1302 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1303 sqlite3ReleaseTempReg(pParse, r2);
danielk19775338a5f2005-01-20 13:03:10 +00001304 }
drhfd0a2f92014-03-24 18:08:15 +00001305 sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
danielk19775338a5f2005-01-20 13:03:10 +00001306 break;
1307 }
drh5974a302000-06-07 14:42:26 +00001308
dan9ed322d2020-04-29 17:41:29 +00001309 case SRT_Upfrom: {
danf2972b62020-04-29 20:11:01 +00001310 if( pSort ){
1311 pushOntoSorter(
1312 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drh2add24c2020-07-23 14:12:47 +00001313 }else{
danf2972b62020-04-29 20:11:01 +00001314 int i2 = pDest->iSDParm2;
1315 int r1 = sqlite3GetTempReg(pParse);
drh09cf5692020-07-20 18:07:35 +00001316
1317 /* If the UPDATE FROM join is an aggregate that matches no rows, it
1318 ** might still be trying to return one row, because that is what
1319 ** aggregates do. Don't record that empty row in the output table. */
1320 sqlite3VdbeAddOp2(v, OP_IsNull, regResult, iBreak); VdbeCoverage(v);
1321
1322 sqlite3VdbeAddOp3(v, OP_MakeRecord,
1323 regResult+(i2<0), nResultCol-(i2<0), r1);
danf2972b62020-04-29 20:11:01 +00001324 if( i2<0 ){
1325 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regResult);
1326 }else{
1327 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, i2);
1328 }
dan9ed322d2020-04-29 17:41:29 +00001329 }
1330 break;
1331 }
1332
1333#ifndef SQLITE_OMIT_SUBQUERY
drhc926afb2002-06-20 03:38:26 +00001334 /* If we are creating a set for an "expr IN (SELECT ...)" construct,
1335 ** then there should be a single item on the stack. Write this
1336 ** item into the set table with bogus data.
1337 */
1338 case SRT_Set: {
drh079a3072014-03-19 14:10:55 +00001339 if( pSort ){
drhde941c62005-08-28 01:34:21 +00001340 /* At first glance you would think we could optimize out the
1341 ** ORDER BY in this case since the order of entries in the set
1342 ** does not matter. But there might be a LIMIT clause, in which
1343 ** case the order does matter */
dan51d82d12016-08-02 18:50:15 +00001344 pushOntoSorter(
dan9af90b72016-11-11 18:08:59 +00001345 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drhc926afb2002-06-20 03:38:26 +00001346 }else{
drhb7654112008-01-12 12:48:07 +00001347 int r1 = sqlite3GetTempReg(pParse);
dan9ed322d2020-04-29 17:41:29 +00001348 assert( sqlite3Strlen30(pDest->zAffSdst)==nResultCol );
1349 sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult, nResultCol,
1350 r1, pDest->zAffSdst, nResultCol);
1351 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
drhb7654112008-01-12 12:48:07 +00001352 sqlite3ReleaseTempReg(pParse, r1);
drhc926afb2002-06-20 03:38:26 +00001353 }
1354 break;
1355 }
drh22827922000-06-06 17:27:05 +00001356
dan9ed322d2020-04-29 17:41:29 +00001357
drh504b6982006-01-22 21:52:56 +00001358 /* If any row exist in the result set, record that fact and abort.
drhec7429a2005-10-06 16:53:14 +00001359 */
1360 case SRT_Exists: {
drh4c583122008-01-04 22:01:03 +00001361 sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
drhec7429a2005-10-06 16:53:14 +00001362 /* The LIMIT clause will terminate the loop for us */
1363 break;
1364 }
1365
drhc926afb2002-06-20 03:38:26 +00001366 /* If this is a scalar select that is part of an expression, then
dan870a0702016-08-01 16:37:43 +00001367 ** store the results in the appropriate memory cell or array of
1368 ** memory cells and break out of the scan loop.
drhc926afb2002-06-20 03:38:26 +00001369 */
1370 case SRT_Mem: {
drh079a3072014-03-19 14:10:55 +00001371 if( pSort ){
dan257c13f2016-11-10 20:14:06 +00001372 assert( nResultCol<=pDest->nSdst );
dan870a0702016-08-01 16:37:43 +00001373 pushOntoSorter(
dan9af90b72016-11-11 18:08:59 +00001374 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drhc926afb2002-06-20 03:38:26 +00001375 }else{
dan257c13f2016-11-10 20:14:06 +00001376 assert( nResultCol==pDest->nSdst );
drh53932ce2014-08-29 12:29:39 +00001377 assert( regResult==iParm );
drhec7429a2005-10-06 16:53:14 +00001378 /* The LIMIT clause will jump out of the loop for us */
drhc926afb2002-06-20 03:38:26 +00001379 }
1380 break;
1381 }
danielk197793758c82005-01-21 08:13:14 +00001382#endif /* #ifndef SQLITE_OMIT_SUBQUERY */
drh22827922000-06-06 17:27:05 +00001383
drh81cf13e2014-02-07 18:27:53 +00001384 case SRT_Coroutine: /* Send data to a co-routine */
1385 case SRT_Output: { /* Return the results */
drh373cc2d2009-05-17 02:06:14 +00001386 testcase( eDest==SRT_Coroutine );
1387 testcase( eDest==SRT_Output );
drh079a3072014-03-19 14:10:55 +00001388 if( pSort ){
dan9af90b72016-11-11 18:08:59 +00001389 pushOntoSorter(pParse, pSort, p, regResult, regOrig, nResultCol,
drh5579d592015-08-26 14:01:41 +00001390 nPrefixReg);
drhe00ee6e2008-06-20 15:24:01 +00001391 }else if( eDest==SRT_Coroutine ){
drh2b596da2012-07-23 21:43:19 +00001392 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drhc182d162005-08-14 20:47:16 +00001393 }else{
drh340309f2014-01-22 00:23:49 +00001394 sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
drhac82fcf2002-09-08 17:23:41 +00001395 }
drh142e30d2002-08-28 03:00:58 +00001396 break;
1397 }
1398
drhfe1c6bb2014-01-22 17:28:35 +00001399#ifndef SQLITE_OMIT_CTE
1400 /* Write the results into a priority queue that is order according to
1401 ** pDest->pOrderBy (in pSO). pDest->iSDParm (in iParm) is the cursor for an
1402 ** index with pSO->nExpr+2 columns. Build a key using pSO for the first
1403 ** pSO->nExpr columns, then make sure all keys are unique by adding a
1404 ** final OP_Sequence column. The last column is the record as a blob.
1405 */
1406 case SRT_DistQueue:
1407 case SRT_Queue: {
1408 int nKey;
1409 int r1, r2, r3;
1410 int addrTest = 0;
1411 ExprList *pSO;
1412 pSO = pDest->pOrderBy;
1413 assert( pSO );
1414 nKey = pSO->nExpr;
1415 r1 = sqlite3GetTempReg(pParse);
1416 r2 = sqlite3GetTempRange(pParse, nKey+2);
1417 r3 = r2+nKey+1;
drhfe1c6bb2014-01-22 17:28:35 +00001418 if( eDest==SRT_DistQueue ){
1419 /* If the destination is DistQueue, then cursor (iParm+1) is open
1420 ** on a second ephemeral index that holds all values every previously
drh7e4efae2014-02-26 21:35:31 +00001421 ** added to the queue. */
1422 addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
1423 regResult, nResultCol);
drh688852a2014-02-17 22:40:43 +00001424 VdbeCoverage(v);
drh7e4efae2014-02-26 21:35:31 +00001425 }
1426 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
1427 if( eDest==SRT_DistQueue ){
drhfe1c6bb2014-01-22 17:28:35 +00001428 sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
dancfe24582014-01-22 19:23:30 +00001429 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
drhfe1c6bb2014-01-22 17:28:35 +00001430 }
1431 for(i=0; i<nKey; i++){
1432 sqlite3VdbeAddOp2(v, OP_SCopy,
1433 regResult + pSO->a[i].u.x.iOrderByCol - 1,
1434 r2+i);
1435 }
1436 sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
1437 sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
drh9b4eaeb2016-11-09 00:10:33 +00001438 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, r2, nKey+2);
drhfe1c6bb2014-01-22 17:28:35 +00001439 if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
1440 sqlite3ReleaseTempReg(pParse, r1);
1441 sqlite3ReleaseTempRange(pParse, r2, nKey+2);
1442 break;
1443 }
1444#endif /* SQLITE_OMIT_CTE */
1445
1446
1447
danielk19776a67fe82005-02-04 04:07:16 +00001448#if !defined(SQLITE_OMIT_TRIGGER)
drhc926afb2002-06-20 03:38:26 +00001449 /* Discard the results. This is used for SELECT statements inside
1450 ** the body of a TRIGGER. The purpose of such selects is to call
1451 ** user-defined functions that have side effects. We do not care
1452 ** about the actual results of the select.
1453 */
drhc926afb2002-06-20 03:38:26 +00001454 default: {
drhf46f9052002-06-22 02:33:38 +00001455 assert( eDest==SRT_Discard );
drhc926afb2002-06-20 03:38:26 +00001456 break;
1457 }
danielk197793758c82005-01-21 08:13:14 +00001458#endif
drh82c3d632000-06-06 21:56:07 +00001459 }
drhec7429a2005-10-06 16:53:14 +00001460
drh5e87be82010-10-06 18:55:37 +00001461 /* Jump to the end of the loop if the LIMIT is reached. Except, if
1462 ** there is a sorter, in which case the sorter has already limited
1463 ** the output for us.
drhec7429a2005-10-06 16:53:14 +00001464 */
drh079a3072014-03-19 14:10:55 +00001465 if( pSort==0 && p->iLimit ){
drh16897072015-03-07 00:57:37 +00001466 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
drhec7429a2005-10-06 16:53:14 +00001467 }
drh82c3d632000-06-06 21:56:07 +00001468}
1469
1470/*
drhad124322013-10-23 13:30:58 +00001471** Allocate a KeyInfo object sufficient for an index of N key columns and
1472** X extra columns.
drh323df792013-08-05 19:11:29 +00001473*/
drhad124322013-10-23 13:30:58 +00001474KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
drhd4ab0032017-05-31 13:45:59 +00001475 int nExtra = (N+X)*(sizeof(CollSeq*)+1) - sizeof(CollSeq*);
drhd8e4b132016-10-01 19:21:56 +00001476 KeyInfo *p = sqlite3DbMallocRawNN(db, sizeof(KeyInfo) + nExtra);
drh323df792013-08-05 19:11:29 +00001477 if( p ){
dan6e118922019-08-12 16:36:38 +00001478 p->aSortFlags = (u8*)&p->aColl[N+X];
drha485ad12017-08-02 22:43:14 +00001479 p->nKeyField = (u16)N;
1480 p->nAllField = (u16)(N+X);
drh323df792013-08-05 19:11:29 +00001481 p->enc = ENC(db);
1482 p->db = db;
drh2ec2fb22013-11-06 19:59:23 +00001483 p->nRef = 1;
drhc263f7c2016-01-18 13:18:54 +00001484 memset(&p[1], 0, nExtra);
drh2ec2fb22013-11-06 19:59:23 +00001485 }else{
drh3cdb1392022-01-24 12:48:54 +00001486 return (KeyInfo*)sqlite3OomFault(db);
drh323df792013-08-05 19:11:29 +00001487 }
1488 return p;
1489}
1490
1491/*
drh2ec2fb22013-11-06 19:59:23 +00001492** Deallocate a KeyInfo object
1493*/
1494void sqlite3KeyInfoUnref(KeyInfo *p){
1495 if( p ){
1496 assert( p->nRef>0 );
drh2ec2fb22013-11-06 19:59:23 +00001497 p->nRef--;
drhdbd6a7d2017-04-05 12:39:49 +00001498 if( p->nRef==0 ) sqlite3DbFreeNN(p->db, p);
drh2ec2fb22013-11-06 19:59:23 +00001499 }
1500}
1501
1502/*
1503** Make a new pointer to a KeyInfo object
1504*/
1505KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
1506 if( p ){
1507 assert( p->nRef>0 );
1508 p->nRef++;
1509 }
1510 return p;
1511}
1512
1513#ifdef SQLITE_DEBUG
1514/*
1515** Return TRUE if a KeyInfo object can be change. The KeyInfo object
1516** can only be changed if this is just a single reference to the object.
1517**
1518** This routine is used only inside of assert() statements.
1519*/
1520int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
1521#endif /* SQLITE_DEBUG */
1522
1523/*
drhdece1a82005-08-31 18:20:00 +00001524** Given an expression list, generate a KeyInfo structure that records
1525** the collating sequence for each expression in that expression list.
1526**
drh0342b1f2005-09-01 03:07:44 +00001527** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
1528** KeyInfo structure is appropriate for initializing a virtual index to
1529** implement that clause. If the ExprList is the result set of a SELECT
1530** then the KeyInfo structure is appropriate for initializing a virtual
1531** index to implement a DISTINCT test.
1532**
peter.d.reid60ec9142014-09-06 16:39:46 +00001533** Space to hold the KeyInfo structure is obtained from malloc. The calling
drhdece1a82005-08-31 18:20:00 +00001534** function is responsible for seeing that this structure is eventually
drh2ec2fb22013-11-06 19:59:23 +00001535** freed.
drhdece1a82005-08-31 18:20:00 +00001536*/
danf9eae182018-05-21 19:45:11 +00001537KeyInfo *sqlite3KeyInfoFromExprList(
drh079a3072014-03-19 14:10:55 +00001538 Parse *pParse, /* Parsing context */
1539 ExprList *pList, /* Form the KeyInfo object from this ExprList */
1540 int iStart, /* Begin with this column of pList */
1541 int nExtra /* Add this many extra columns to the end */
1542){
drhdece1a82005-08-31 18:20:00 +00001543 int nExpr;
1544 KeyInfo *pInfo;
1545 struct ExprList_item *pItem;
drh323df792013-08-05 19:11:29 +00001546 sqlite3 *db = pParse->db;
drhdece1a82005-08-31 18:20:00 +00001547 int i;
1548
1549 nExpr = pList->nExpr;
drh3f39bcf2015-01-19 20:59:34 +00001550 pInfo = sqlite3KeyInfoAlloc(db, nExpr-iStart, nExtra+1);
drhdece1a82005-08-31 18:20:00 +00001551 if( pInfo ){
drh2ec2fb22013-11-06 19:59:23 +00001552 assert( sqlite3KeyInfoIsWriteable(pInfo) );
drh6284db92014-03-19 23:24:49 +00001553 for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
drh70efa842017-09-28 01:58:23 +00001554 pInfo->aColl[i-iStart] = sqlite3ExprNNCollSeq(pParse, pItem->pExpr);
dan6e118922019-08-12 16:36:38 +00001555 pInfo->aSortFlags[i-iStart] = pItem->sortFlags;
drhdece1a82005-08-31 18:20:00 +00001556 }
1557 }
1558 return pInfo;
1559}
1560
dan7f61e922010-11-11 16:46:40 +00001561/*
1562** Name of the connection operator, used for error messages.
1563*/
drhaae0f742021-03-04 16:03:32 +00001564const char *sqlite3SelectOpName(int id){
dan7f61e922010-11-11 16:46:40 +00001565 char *z;
1566 switch( id ){
1567 case TK_ALL: z = "UNION ALL"; break;
1568 case TK_INTERSECT: z = "INTERSECT"; break;
1569 case TK_EXCEPT: z = "EXCEPT"; break;
1570 default: z = "UNION"; break;
1571 }
1572 return z;
1573}
dan7f61e922010-11-11 16:46:40 +00001574
dan2ce22452010-11-08 19:01:16 +00001575#ifndef SQLITE_OMIT_EXPLAIN
dan17c0bc02010-11-09 17:35:19 +00001576/*
1577** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
1578** is a no-op. Otherwise, it adds a single row of output to the EQP result,
1579** where the caption is of the form:
1580**
1581** "USE TEMP B-TREE FOR xxx"
1582**
1583** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
1584** is determined by the zUsage argument.
1585*/
dan2ce22452010-11-08 19:01:16 +00001586static void explainTempTable(Parse *pParse, const char *zUsage){
drhe2ca99c2018-05-02 00:33:43 +00001587 ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s", zUsage));
dan2ce22452010-11-08 19:01:16 +00001588}
dan17c0bc02010-11-09 17:35:19 +00001589
1590/*
danbb2b4412011-04-06 17:54:31 +00001591** Assign expression b to lvalue a. A second, no-op, version of this macro
1592** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
1593** in sqlite3Select() to assign values to structure member variables that
1594** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
1595** code with #ifndef directives.
1596*/
1597# define explainSetInteger(a, b) a = b
1598
1599#else
1600/* No-op versions of the explainXXX() functions and macros. */
1601# define explainTempTable(y,z)
1602# define explainSetInteger(y,z)
1603#endif
1604
drhdece1a82005-08-31 18:20:00 +00001605
1606/*
drhd8bc7082000-06-07 23:51:50 +00001607** If the inner loop was generated using a non-null pOrderBy argument,
1608** then the results were placed in a sorter. After the loop is terminated
1609** we need to run the sorter and output the results. The following
1610** routine generates the code needed to do that.
1611*/
drhc926afb2002-06-20 03:38:26 +00001612static void generateSortTail(
danielk19776c8c8ce2008-01-02 16:27:09 +00001613 Parse *pParse, /* Parsing context */
1614 Select *p, /* The SELECT statement */
drh079a3072014-03-19 14:10:55 +00001615 SortCtx *pSort, /* Information on the ORDER BY clause */
danielk19776c8c8ce2008-01-02 16:27:09 +00001616 int nColumn, /* Number of columns of data */
1617 SelectDest *pDest /* Write the sorted results here */
drhc926afb2002-06-20 03:38:26 +00001618){
drhddba0c22014-03-18 20:33:42 +00001619 Vdbe *v = pParse->pVdbe; /* The prepared statement */
drha04a8be2016-01-13 17:50:10 +00001620 int addrBreak = pSort->labelDone; /* Jump here to exit loop */
drhec4ccdb2018-12-29 02:26:59 +00001621 int addrContinue = sqlite3VdbeMakeLabel(pParse);/* Jump here for next cycle */
dan24e25d32018-04-14 18:46:20 +00001622 int addr; /* Top of output loop. Jump for Next. */
drh079a3072014-03-19 14:10:55 +00001623 int addrOnce = 0;
drh0342b1f2005-09-01 03:07:44 +00001624 int iTab;
drh079a3072014-03-19 14:10:55 +00001625 ExprList *pOrderBy = pSort->pOrderBy;
danielk19776c8c8ce2008-01-02 16:27:09 +00001626 int eDest = pDest->eDest;
drh2b596da2012-07-23 21:43:19 +00001627 int iParm = pDest->iSDParm;
drh2d401ab2008-01-10 23:50:11 +00001628 int regRow;
1629 int regRowid;
dan257c13f2016-11-10 20:14:06 +00001630 int iCol;
dan24e25d32018-04-14 18:46:20 +00001631 int nKey; /* Number of key columns in sorter record */
drhf45f2322014-03-23 17:45:03 +00001632 int iSortTab; /* Sorter cursor to read from */
drhf45f2322014-03-23 17:45:03 +00001633 int i;
dan78d58432014-03-25 15:04:07 +00001634 int bSeq; /* True if sorter record includes seq. no. */
dan24e25d32018-04-14 18:46:20 +00001635 int nRefKey = 0;
drh70f624c2014-03-24 01:43:50 +00001636 struct ExprList_item *aOutEx = p->pEList->a;
drh2d401ab2008-01-10 23:50:11 +00001637
drha04a8be2016-01-13 17:50:10 +00001638 assert( addrBreak<0 );
drh079a3072014-03-19 14:10:55 +00001639 if( pSort->labelBkOut ){
1640 sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
drh076e85f2015-09-03 13:46:12 +00001641 sqlite3VdbeGoto(v, addrBreak);
drh079a3072014-03-19 14:10:55 +00001642 sqlite3VdbeResolveLabel(v, pSort->labelBkOut);
drh079a3072014-03-19 14:10:55 +00001643 }
dan24e25d32018-04-14 18:46:20 +00001644
1645#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1646 /* Open any cursors needed for sorter-reference expressions */
1647 for(i=0; i<pSort->nDefer; i++){
1648 Table *pTab = pSort->aDefer[i].pTab;
1649 int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
1650 sqlite3OpenTable(pParse, pSort->aDefer[i].iCsr, iDb, pTab, OP_OpenRead);
1651 nRefKey = MAX(nRefKey, pSort->aDefer[i].nKey);
1652 }
1653#endif
1654
drh079a3072014-03-19 14:10:55 +00001655 iTab = pSort->iECursor;
dan71c57db2016-07-09 20:23:55 +00001656 if( eDest==SRT_Output || eDest==SRT_Coroutine || eDest==SRT_Mem ){
drh8efc6a82022-01-12 20:31:14 +00001657 if( eDest==SRT_Mem && p->iOffset ){
1658 sqlite3VdbeAddOp2(v, OP_Null, 0, pDest->iSdst);
1659 }
drh3e9ca092009-09-08 01:14:48 +00001660 regRowid = 0;
drhf45f2322014-03-23 17:45:03 +00001661 regRow = pDest->iSdst;
drhed24da42016-09-06 14:37:05 +00001662 }else{
dan51d82d12016-08-02 18:50:15 +00001663 regRowid = sqlite3GetTempReg(pParse);
drh375afb82019-01-16 19:26:31 +00001664 if( eDest==SRT_EphemTab || eDest==SRT_Table ){
1665 regRow = sqlite3GetTempReg(pParse);
1666 nColumn = 0;
1667 }else{
1668 regRow = sqlite3GetTempRange(pParse, nColumn);
1669 }
drhcdd536f2006-03-17 00:04:03 +00001670 }
drh079a3072014-03-19 14:10:55 +00001671 nKey = pOrderBy->nExpr - pSort->nOBSat;
1672 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drhc2bb3282011-09-04 01:11:46 +00001673 int regSortOut = ++pParse->nMem;
drhf45f2322014-03-23 17:45:03 +00001674 iSortTab = pParse->nTab++;
drh83553ee2014-03-24 02:20:53 +00001675 if( pSort->labelBkOut ){
drh511f9e82016-09-22 18:53:13 +00001676 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drh83553ee2014-03-24 02:20:53 +00001677 }
dan24e25d32018-04-14 18:46:20 +00001678 sqlite3VdbeAddOp3(v, OP_OpenPseudo, iSortTab, regSortOut,
1679 nKey+1+nColumn+nRefKey);
drh079a3072014-03-19 14:10:55 +00001680 if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
drhc6aff302011-09-01 15:32:47 +00001681 addr = 1 + sqlite3VdbeAddOp2(v, OP_SorterSort, iTab, addrBreak);
drh688852a2014-02-17 22:40:43 +00001682 VdbeCoverage(v);
drhaa9ce702014-01-22 18:07:04 +00001683 codeOffset(v, p->iOffset, addrContinue);
drh6cf4a7d2014-10-13 13:00:58 +00001684 sqlite3VdbeAddOp3(v, OP_SorterData, iTab, regSortOut, iSortTab);
dan78d58432014-03-25 15:04:07 +00001685 bSeq = 0;
drhc6aff302011-09-01 15:32:47 +00001686 }else{
drh688852a2014-02-17 22:40:43 +00001687 addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
drhaa9ce702014-01-22 18:07:04 +00001688 codeOffset(v, p->iOffset, addrContinue);
drhf45f2322014-03-23 17:45:03 +00001689 iSortTab = iTab;
dan78d58432014-03-25 15:04:07 +00001690 bSeq = 1;
drhf45f2322014-03-23 17:45:03 +00001691 }
dand6189ea2018-04-11 14:11:53 +00001692 for(i=0, iCol=nKey+bSeq-1; i<nColumn; i++){
dan24e25d32018-04-14 18:46:20 +00001693#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1694 if( aOutEx[i].bSorterRef ) continue;
1695#endif
drh9f895232018-01-24 20:42:42 +00001696 if( aOutEx[i].u.x.iOrderByCol==0 ) iCol++;
1697 }
dan24e25d32018-04-14 18:46:20 +00001698#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1699 if( pSort->nDefer ){
1700 int iKey = iCol+1;
1701 int regKey = sqlite3GetTempRange(pParse, nRefKey);
1702
1703 for(i=0; i<pSort->nDefer; i++){
1704 int iCsr = pSort->aDefer[i].iCsr;
1705 Table *pTab = pSort->aDefer[i].pTab;
1706 int nKey = pSort->aDefer[i].nKey;
1707
1708 sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1709 if( HasRowid(pTab) ){
1710 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey);
1711 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCsr,
1712 sqlite3VdbeCurrentAddr(v)+1, regKey);
1713 }else{
dan24e25d32018-04-14 18:46:20 +00001714 int k;
1715 int iJmp;
drh7590d092018-04-18 14:04:19 +00001716 assert( sqlite3PrimaryKeyIndex(pTab)->nKeyCol==nKey );
dan24e25d32018-04-14 18:46:20 +00001717 for(k=0; k<nKey; k++){
1718 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey+k);
1719 }
1720 iJmp = sqlite3VdbeCurrentAddr(v);
1721 sqlite3VdbeAddOp4Int(v, OP_SeekGE, iCsr, iJmp+2, regKey, nKey);
1722 sqlite3VdbeAddOp4Int(v, OP_IdxLE, iCsr, iJmp+3, regKey, nKey);
1723 sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1724 }
dan257c13f2016-11-10 20:14:06 +00001725 }
dan24e25d32018-04-14 18:46:20 +00001726 sqlite3ReleaseTempRange(pParse, regKey, nRefKey);
1727 }
1728#endif
1729 for(i=nColumn-1; i>=0; i--){
1730#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1731 if( aOutEx[i].bSorterRef ){
1732 sqlite3ExprCode(pParse, aOutEx[i].pExpr, regRow+i);
1733 }else
1734#endif
1735 {
1736 int iRead;
1737 if( aOutEx[i].u.x.iOrderByCol ){
1738 iRead = aOutEx[i].u.x.iOrderByCol-1;
1739 }else{
1740 iRead = iCol--;
1741 }
1742 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iRead, regRow+i);
drhcbb9da32019-12-12 22:11:33 +00001743 VdbeComment((v, "%s", aOutEx[i].zEName));
dan24e25d32018-04-14 18:46:20 +00001744 }
drhc6aff302011-09-01 15:32:47 +00001745 }
drhc926afb2002-06-20 03:38:26 +00001746 switch( eDest ){
danac56ab72017-01-05 17:23:11 +00001747 case SRT_Table:
drhb9bb7c12006-06-11 23:41:55 +00001748 case SRT_EphemTab: {
drh375afb82019-01-16 19:26:31 +00001749 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, nKey+bSeq, regRow);
drh2d401ab2008-01-10 23:50:11 +00001750 sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
1751 sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
1752 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
drhc926afb2002-06-20 03:38:26 +00001753 break;
1754 }
danielk197793758c82005-01-21 08:13:14 +00001755#ifndef SQLITE_OMIT_SUBQUERY
drhc926afb2002-06-20 03:38:26 +00001756 case SRT_Set: {
dan71c57db2016-07-09 20:23:55 +00001757 assert( nColumn==sqlite3Strlen30(pDest->zAffSdst) );
1758 sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, nColumn, regRowid,
dan553168c2016-08-01 20:14:31 +00001759 pDest->zAffSdst, nColumn);
drh9b4eaeb2016-11-09 00:10:33 +00001760 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, regRowid, regRow, nColumn);
drhc926afb2002-06-20 03:38:26 +00001761 break;
1762 }
1763 case SRT_Mem: {
drhec7429a2005-10-06 16:53:14 +00001764 /* The LIMIT clause will terminate the loop for us */
drhc926afb2002-06-20 03:38:26 +00001765 break;
1766 }
danielk197793758c82005-01-21 08:13:14 +00001767#endif
danf2972b62020-04-29 20:11:01 +00001768 case SRT_Upfrom: {
1769 int i2 = pDest->iSDParm2;
1770 int r1 = sqlite3GetTempReg(pParse);
1771 sqlite3VdbeAddOp3(v, OP_MakeRecord,regRow+(i2<0),nColumn-(i2<0),r1);
1772 if( i2<0 ){
1773 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regRow);
1774 }else{
1775 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regRow, i2);
1776 }
1777 break;
1778 }
drh373cc2d2009-05-17 02:06:14 +00001779 default: {
drh373cc2d2009-05-17 02:06:14 +00001780 assert( eDest==SRT_Output || eDest==SRT_Coroutine );
drh1c767f02009-01-09 02:49:31 +00001781 testcase( eDest==SRT_Output );
1782 testcase( eDest==SRT_Coroutine );
drh7d10d5a2008-08-20 16:35:10 +00001783 if( eDest==SRT_Output ){
drh2b596da2012-07-23 21:43:19 +00001784 sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
drha9671a22008-07-08 23:40:20 +00001785 }else{
drh2b596da2012-07-23 21:43:19 +00001786 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drhce665cf2004-05-21 03:01:58 +00001787 }
drhac82fcf2002-09-08 17:23:41 +00001788 break;
1789 }
drhc926afb2002-06-20 03:38:26 +00001790 }
drhf45f2322014-03-23 17:45:03 +00001791 if( regRowid ){
dan51d82d12016-08-02 18:50:15 +00001792 if( eDest==SRT_Set ){
1793 sqlite3ReleaseTempRange(pParse, regRow, nColumn);
1794 }else{
1795 sqlite3ReleaseTempReg(pParse, regRow);
1796 }
drhf45f2322014-03-23 17:45:03 +00001797 sqlite3ReleaseTempReg(pParse, regRowid);
1798 }
drhec7429a2005-10-06 16:53:14 +00001799 /* The bottom of the loop
1800 */
drhdc5ea5c2008-12-10 17:19:59 +00001801 sqlite3VdbeResolveLabel(v, addrContinue);
drh079a3072014-03-19 14:10:55 +00001802 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drh688852a2014-02-17 22:40:43 +00001803 sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
drhc6aff302011-09-01 15:32:47 +00001804 }else{
drh688852a2014-02-17 22:40:43 +00001805 sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
drhc6aff302011-09-01 15:32:47 +00001806 }
drh079a3072014-03-19 14:10:55 +00001807 if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
drhdc5ea5c2008-12-10 17:19:59 +00001808 sqlite3VdbeResolveLabel(v, addrBreak);
drhd8bc7082000-06-07 23:51:50 +00001809}
1810
1811/*
danielk1977517eb642004-06-07 10:00:31 +00001812** Return a pointer to a string containing the 'declaration type' of the
1813** expression pExpr. The string may be treated as static by the caller.
drhe78e8282003-01-19 03:59:45 +00001814**
drh5f3e5e72013-10-08 20:01:35 +00001815** Also try to estimate the size of the returned value and return that
1816** result in *pEstWidth.
1817**
danielk1977955de522006-02-10 02:27:42 +00001818** The declaration type is the exact datatype definition extracted from the
1819** original CREATE TABLE statement if the expression is a column. The
1820** declaration type for a ROWID field is INTEGER. Exactly when an expression
1821** is considered a column can be complex in the presence of subqueries. The
1822** result-set expression in all of the following SELECT statements is
1823** considered a column by this function.
1824**
1825** SELECT col FROM tbl;
1826** SELECT (SELECT col FROM tbl;
1827** SELECT (SELECT col FROM tbl);
1828** SELECT abc FROM (SELECT col AS abc FROM tbl);
danielk1977517eb642004-06-07 10:00:31 +00001829**
danielk1977955de522006-02-10 02:27:42 +00001830** The declaration type for any expression other than a column is NULL.
drh5f3e5e72013-10-08 20:01:35 +00001831**
1832** This routine has either 3 or 6 parameters depending on whether or not
1833** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
danielk1977517eb642004-06-07 10:00:31 +00001834*/
drh5f3e5e72013-10-08 20:01:35 +00001835#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhcafc2f72017-10-03 03:01:09 +00001836# define columnType(A,B,C,D,E) columnTypeImpl(A,B,C,D,E)
drhb121dd12015-06-06 18:30:17 +00001837#else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
drhcafc2f72017-10-03 03:01:09 +00001838# define columnType(A,B,C,D,E) columnTypeImpl(A,B)
drhb121dd12015-06-06 18:30:17 +00001839#endif
drh5f3e5e72013-10-08 20:01:35 +00001840static const char *columnTypeImpl(
danielk1977955de522006-02-10 02:27:42 +00001841 NameContext *pNC,
drhcafc2f72017-10-03 03:01:09 +00001842#ifndef SQLITE_ENABLE_COLUMN_METADATA
1843 Expr *pExpr
1844#else
danielk1977955de522006-02-10 02:27:42 +00001845 Expr *pExpr,
drh5f3e5e72013-10-08 20:01:35 +00001846 const char **pzOrigDb,
1847 const char **pzOrigTab,
drhcafc2f72017-10-03 03:01:09 +00001848 const char **pzOrigCol
drhb121dd12015-06-06 18:30:17 +00001849#endif
danielk1977955de522006-02-10 02:27:42 +00001850){
1851 char const *zType = 0;
danielk1977517eb642004-06-07 10:00:31 +00001852 int j;
drhb121dd12015-06-06 18:30:17 +00001853#ifdef SQLITE_ENABLE_COLUMN_METADATA
1854 char const *zOrigDb = 0;
1855 char const *zOrigTab = 0;
1856 char const *zOrigCol = 0;
1857#endif
danielk19775338a5f2005-01-20 13:03:10 +00001858
drhf7ce4292015-12-02 19:46:12 +00001859 assert( pExpr!=0 );
1860 assert( pNC->pSrcList!=0 );
danielk197700e279d2004-06-21 07:36:32 +00001861 switch( pExpr->op ){
1862 case TK_COLUMN: {
danielk1977955de522006-02-10 02:27:42 +00001863 /* The expression is a column. Locate the table the column is being
1864 ** extracted from in NameContext.pSrcList. This table may be real
1865 ** database table or a subquery.
1866 */
1867 Table *pTab = 0; /* Table structure column is extracted from */
1868 Select *pS = 0; /* Select the column is extracted from */
1869 int iCol = pExpr->iColumn; /* Index of column in pTab */
dan43bc88b2009-09-10 10:15:59 +00001870 while( pNC && !pTab ){
danielk1977b3bce662005-01-29 08:32:43 +00001871 SrcList *pTabList = pNC->pSrcList;
1872 for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
1873 if( j<pTabList->nSrc ){
1874 pTab = pTabList->a[j].pTab;
danielk1977955de522006-02-10 02:27:42 +00001875 pS = pTabList->a[j].pSelect;
danielk1977b3bce662005-01-29 08:32:43 +00001876 }else{
1877 pNC = pNC->pNext;
1878 }
1879 }
danielk1977955de522006-02-10 02:27:42 +00001880
dan43bc88b2009-09-10 10:15:59 +00001881 if( pTab==0 ){
drh417168a2009-09-07 18:14:02 +00001882 /* At one time, code such as "SELECT new.x" within a trigger would
1883 ** cause this condition to run. Since then, we have restructured how
1884 ** trigger code is generated and so this condition is no longer
dan43bc88b2009-09-10 10:15:59 +00001885 ** possible. However, it can still be true for statements like
1886 ** the following:
1887 **
1888 ** CREATE TABLE t1(col INTEGER);
1889 ** SELECT (SELECT t1.col) FROM FROM t1;
1890 **
1891 ** when columnType() is called on the expression "t1.col" in the
1892 ** sub-select. In this case, set the column type to NULL, even
1893 ** though it should really be "INTEGER".
1894 **
1895 ** This is not a problem, as the column type of "t1.col" is never
1896 ** used. When columnType() is called on the expression
1897 ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
1898 ** branch below. */
drh7e627792005-04-29 02:10:00 +00001899 break;
1900 }
danielk1977955de522006-02-10 02:27:42 +00001901
drh477572b2021-10-07 20:46:29 +00001902 assert( pTab && ExprUseYTab(pExpr) && pExpr->y.pTab==pTab );
danielk1977955de522006-02-10 02:27:42 +00001903 if( pS ){
1904 /* The "table" is actually a sub-select or a view in the FROM clause
1905 ** of the SELECT statement. Return the declaration type and origin
1906 ** data for the result-set column of the sub-select.
1907 */
drh6e5020e2021-04-07 15:45:01 +00001908 if( iCol<pS->pEList->nExpr
1909#ifdef SQLITE_ALLOW_ROWID_IN_VIEW
1910 && iCol>=0
1911#else
1912 && ALWAYS(iCol>=0)
1913#endif
1914 ){
danielk1977955de522006-02-10 02:27:42 +00001915 /* If iCol is less than zero, then the expression requests the
1916 ** rowid of the sub-select or view. This expression is legal (see
1917 ** test case misc2.2.2) - it always evaluates to NULL.
1918 */
1919 NameContext sNC;
1920 Expr *p = pS->pEList->a[iCol].pExpr;
1921 sNC.pSrcList = pS->pSrc;
dan43bc88b2009-09-10 10:15:59 +00001922 sNC.pNext = pNC;
danielk1977955de522006-02-10 02:27:42 +00001923 sNC.pParse = pNC->pParse;
drhcafc2f72017-10-03 03:01:09 +00001924 zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol);
danielk1977955de522006-02-10 02:27:42 +00001925 }
drha78d7572017-10-03 16:57:33 +00001926 }else{
1927 /* A real table or a CTE table */
danielk1977955de522006-02-10 02:27:42 +00001928 assert( !pS );
drh5f3e5e72013-10-08 20:01:35 +00001929#ifdef SQLITE_ENABLE_COLUMN_METADATA
drha78d7572017-10-03 16:57:33 +00001930 if( iCol<0 ) iCol = pTab->iPKey;
1931 assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
danielk1977955de522006-02-10 02:27:42 +00001932 if( iCol<0 ){
1933 zType = "INTEGER";
drh5f3e5e72013-10-08 20:01:35 +00001934 zOrigCol = "rowid";
danielk1977955de522006-02-10 02:27:42 +00001935 }else{
drhcf9d36d2021-08-02 18:03:43 +00001936 zOrigCol = pTab->aCol[iCol].zCnName;
drhd7564862016-03-22 20:05:09 +00001937 zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
danielk1977955de522006-02-10 02:27:42 +00001938 }
drh5f3e5e72013-10-08 20:01:35 +00001939 zOrigTab = pTab->zName;
drha78d7572017-10-03 16:57:33 +00001940 if( pNC->pParse && pTab->pSchema ){
danielk1977955de522006-02-10 02:27:42 +00001941 int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
drhe59be012016-08-18 20:56:39 +00001942 zOrigDb = pNC->pParse->db->aDb[iDb].zDbSName;
danielk1977955de522006-02-10 02:27:42 +00001943 }
drh5f3e5e72013-10-08 20:01:35 +00001944#else
drha78d7572017-10-03 16:57:33 +00001945 assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
drh5f3e5e72013-10-08 20:01:35 +00001946 if( iCol<0 ){
1947 zType = "INTEGER";
1948 }else{
drhd7564862016-03-22 20:05:09 +00001949 zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
drh5f3e5e72013-10-08 20:01:35 +00001950 }
1951#endif
danielk197700e279d2004-06-21 07:36:32 +00001952 }
1953 break;
danielk1977517eb642004-06-07 10:00:31 +00001954 }
danielk197793758c82005-01-21 08:13:14 +00001955#ifndef SQLITE_OMIT_SUBQUERY
danielk197700e279d2004-06-21 07:36:32 +00001956 case TK_SELECT: {
danielk1977955de522006-02-10 02:27:42 +00001957 /* The expression is a sub-select. Return the declaration type and
1958 ** origin info for the single column in the result set of the SELECT
1959 ** statement.
1960 */
danielk1977b3bce662005-01-29 08:32:43 +00001961 NameContext sNC;
drha4eeccd2021-10-07 17:43:30 +00001962 Select *pS;
1963 Expr *p;
1964 assert( ExprUseXSelect(pExpr) );
1965 pS = pExpr->x.pSelect;
1966 p = pS->pEList->a[0].pExpr;
danielk1977955de522006-02-10 02:27:42 +00001967 sNC.pSrcList = pS->pSrc;
danielk1977b3bce662005-01-29 08:32:43 +00001968 sNC.pNext = pNC;
danielk1977955de522006-02-10 02:27:42 +00001969 sNC.pParse = pNC->pParse;
drhcafc2f72017-10-03 03:01:09 +00001970 zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
danielk197700e279d2004-06-21 07:36:32 +00001971 break;
danielk1977517eb642004-06-07 10:00:31 +00001972 }
danielk197793758c82005-01-21 08:13:14 +00001973#endif
danielk1977517eb642004-06-07 10:00:31 +00001974 }
drh5f3e5e72013-10-08 20:01:35 +00001975
1976#ifdef SQLITE_ENABLE_COLUMN_METADATA
1977 if( pzOrigDb ){
1978 assert( pzOrigTab && pzOrigCol );
1979 *pzOrigDb = zOrigDb;
1980 *pzOrigTab = zOrigTab;
1981 *pzOrigCol = zOrigCol;
danielk1977955de522006-02-10 02:27:42 +00001982 }
drh5f3e5e72013-10-08 20:01:35 +00001983#endif
danielk1977517eb642004-06-07 10:00:31 +00001984 return zType;
1985}
1986
1987/*
1988** Generate code that will tell the VDBE the declaration types of columns
1989** in the result set.
drhfcb78a42003-01-18 20:11:05 +00001990*/
1991static void generateColumnTypes(
1992 Parse *pParse, /* Parser context */
drhfcb78a42003-01-18 20:11:05 +00001993 SrcList *pTabList, /* List of tables */
1994 ExprList *pEList /* Expressions defining the result set */
1995){
drh3f913572008-03-22 01:07:17 +00001996#ifndef SQLITE_OMIT_DECLTYPE
drhfcb78a42003-01-18 20:11:05 +00001997 Vdbe *v = pParse->pVdbe;
danielk1977517eb642004-06-07 10:00:31 +00001998 int i;
danielk1977b3bce662005-01-29 08:32:43 +00001999 NameContext sNC;
2000 sNC.pSrcList = pTabList;
danielk1977955de522006-02-10 02:27:42 +00002001 sNC.pParse = pParse;
drheac5fc02017-04-11 01:01:27 +00002002 sNC.pNext = 0;
drhfcb78a42003-01-18 20:11:05 +00002003 for(i=0; i<pEList->nExpr; i++){
2004 Expr *p = pEList->a[i].pExpr;
drh3f913572008-03-22 01:07:17 +00002005 const char *zType;
2006#ifdef SQLITE_ENABLE_COLUMN_METADATA
danielk1977955de522006-02-10 02:27:42 +00002007 const char *zOrigDb = 0;
2008 const char *zOrigTab = 0;
2009 const char *zOrigCol = 0;
drhcafc2f72017-10-03 03:01:09 +00002010 zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
danielk1977955de522006-02-10 02:27:42 +00002011
drh85b623f2007-12-13 21:54:09 +00002012 /* The vdbe must make its own copy of the column-type and other
danielk19774b1ae992006-02-10 03:06:10 +00002013 ** column specific strings, in case the schema is reset before this
2014 ** virtual machine is deleted.
danielk1977fbcd5852004-06-15 02:44:18 +00002015 */
danielk197710fb7492008-10-31 10:53:22 +00002016 sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
2017 sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
2018 sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
drh3f913572008-03-22 01:07:17 +00002019#else
drhcafc2f72017-10-03 03:01:09 +00002020 zType = columnType(&sNC, p, 0, 0, 0);
drh3f913572008-03-22 01:07:17 +00002021#endif
danielk197710fb7492008-10-31 10:53:22 +00002022 sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
drhfcb78a42003-01-18 20:11:05 +00002023 }
drh5f3e5e72013-10-08 20:01:35 +00002024#endif /* !defined(SQLITE_OMIT_DECLTYPE) */
drhfcb78a42003-01-18 20:11:05 +00002025}
2026
drheac5fc02017-04-11 01:01:27 +00002027
2028/*
drhec360a82017-07-12 14:10:19 +00002029** Compute the column names for a SELECT statement.
2030**
2031** The only guarantee that SQLite makes about column names is that if the
2032** column has an AS clause assigning it a name, that will be the name used.
2033** That is the only documented guarantee. However, countless applications
2034** developed over the years have made baseless assumptions about column names
2035** and will break if those assumptions changes. Hence, use extreme caution
2036** when modifying this routine to avoid breaking legacy.
2037**
2038** See Also: sqlite3ColumnsFromExprList()
2039**
2040** The PRAGMA short_column_names and PRAGMA full_column_names settings are
2041** deprecated. The default setting is short=ON, full=OFF. 99.9% of all
2042** applications should operate this way. Nevertheless, we need to support the
2043** other modes for legacy:
2044**
2045** short=OFF, full=OFF: Column name is the text of the expression has it
2046** originally appears in the SELECT statement. In
2047** other words, the zSpan of the result expression.
2048**
2049** short=ON, full=OFF: (This is the default setting). If the result
drh3d240d22017-09-28 16:56:55 +00002050** refers directly to a table column, then the
2051** result column name is just the table column
2052** name: COLUMN. Otherwise use zSpan.
drhec360a82017-07-12 14:10:19 +00002053**
2054** full=ON, short=ANY: If the result refers directly to a table column,
2055** then the result column name with the table name
2056** prefix, ex: TABLE.COLUMN. Otherwise use zSpan.
drh82c3d632000-06-06 21:56:07 +00002057*/
drh90881862021-05-19 12:17:03 +00002058void sqlite3GenerateColumnNames(
drh832508b2002-03-02 17:04:07 +00002059 Parse *pParse, /* Parser context */
drhf35f2f92017-07-29 16:01:55 +00002060 Select *pSelect /* Generate column names for this SELECT statement */
drh832508b2002-03-02 17:04:07 +00002061){
drhd8bc7082000-06-07 23:51:50 +00002062 Vdbe *v = pParse->pVdbe;
drheac5fc02017-04-11 01:01:27 +00002063 int i;
2064 Table *pTab;
drhf35f2f92017-07-29 16:01:55 +00002065 SrcList *pTabList;
2066 ExprList *pEList;
drh9bb575f2004-09-06 17:24:11 +00002067 sqlite3 *db = pParse->db;
drhf35f2f92017-07-29 16:01:55 +00002068 int fullName; /* TABLE.COLUMN if no AS clause and is a direct table ref */
2069 int srcName; /* COLUMN or TABLE.COLUMN if no AS clause and is direct */
drhfcabd462004-02-20 14:50:58 +00002070
drhfe2093d2005-01-20 22:48:47 +00002071#ifndef SQLITE_OMIT_EXPLAIN
danielk19773cf86062004-05-26 10:11:05 +00002072 /* If this is an EXPLAIN, skip this step */
2073 if( pParse->explain ){
danielk197761de0d12004-05-27 23:56:16 +00002074 return;
danielk19773cf86062004-05-26 10:11:05 +00002075 }
danielk19775338a5f2005-01-20 13:03:10 +00002076#endif
danielk19773cf86062004-05-26 10:11:05 +00002077
drh5e8b9852018-05-03 22:52:56 +00002078 if( pParse->colNamesSet ) return;
drhf35f2f92017-07-29 16:01:55 +00002079 /* Column names are determined by the left-most term of a compound select */
2080 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh07859482017-12-23 11:51:40 +00002081 SELECTTRACE(1,pParse,pSelect,("generating column names\n"));
drhf35f2f92017-07-29 16:01:55 +00002082 pTabList = pSelect->pSrc;
2083 pEList = pSelect->pEList;
drh98029472015-12-03 21:47:30 +00002084 assert( v!=0 );
drhf7ce4292015-12-02 19:46:12 +00002085 assert( pTabList!=0 );
drhd8bc7082000-06-07 23:51:50 +00002086 pParse->colNamesSet = 1;
drhec360a82017-07-12 14:10:19 +00002087 fullName = (db->flags & SQLITE_FullColNames)!=0;
2088 srcName = (db->flags & SQLITE_ShortColNames)!=0 || fullName;
danielk197722322fd2004-05-25 23:35:17 +00002089 sqlite3VdbeSetNumCols(v, pEList->nExpr);
drh82c3d632000-06-06 21:56:07 +00002090 for(i=0; i<pEList->nExpr; i++){
drhec360a82017-07-12 14:10:19 +00002091 Expr *p = pEList->a[i].pExpr;
2092
2093 assert( p!=0 );
drh4dd89d52017-08-14 14:53:24 +00002094 assert( p->op!=TK_AGG_COLUMN ); /* Agg processing has not run yet */
drh477572b2021-10-07 20:46:29 +00002095 assert( p->op!=TK_COLUMN
2096 || (ExprUseYTab(p) && p->y.pTab!=0) ); /* Covering idx not yet coded */
drhcbb9da32019-12-12 22:11:33 +00002097 if( pEList->a[i].zEName && pEList->a[i].eEName==ENAME_NAME ){
drhec360a82017-07-12 14:10:19 +00002098 /* An AS clause always takes first priority */
drh41cee662019-12-12 20:22:34 +00002099 char *zName = pEList->a[i].zEName;
danielk197710fb7492008-10-31 10:53:22 +00002100 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
drhf35f2f92017-07-29 16:01:55 +00002101 }else if( srcName && p->op==TK_COLUMN ){
drh97665872002-02-13 23:22:53 +00002102 char *zCol;
drh8aff1012001-12-22 14:49:24 +00002103 int iCol = p->iColumn;
drheda079c2018-09-20 19:02:15 +00002104 pTab = p->y.pTab;
drhf35f2f92017-07-29 16:01:55 +00002105 assert( pTab!=0 );
drh8aff1012001-12-22 14:49:24 +00002106 if( iCol<0 ) iCol = pTab->iPKey;
drh97665872002-02-13 23:22:53 +00002107 assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
drhb1363202002-06-26 02:45:03 +00002108 if( iCol<0 ){
drh47a6db22005-01-18 16:02:40 +00002109 zCol = "rowid";
drhb1363202002-06-26 02:45:03 +00002110 }else{
drhcf9d36d2021-08-02 18:03:43 +00002111 zCol = pTab->aCol[iCol].zCnName;
drhb1363202002-06-26 02:45:03 +00002112 }
drhec360a82017-07-12 14:10:19 +00002113 if( fullName ){
drh82c3d632000-06-06 21:56:07 +00002114 char *zName = 0;
drh1c767f02009-01-09 02:49:31 +00002115 zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
danielk197710fb7492008-10-31 10:53:22 +00002116 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
drh82c3d632000-06-06 21:56:07 +00002117 }else{
danielk197710fb7492008-10-31 10:53:22 +00002118 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
drh82c3d632000-06-06 21:56:07 +00002119 }
drh1bee3d72001-10-15 00:44:35 +00002120 }else{
drhcbb9da32019-12-12 22:11:33 +00002121 const char *z = pEList->a[i].zEName;
drh859bc542014-01-13 20:32:18 +00002122 z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
2123 sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
drh82c3d632000-06-06 21:56:07 +00002124 }
2125 }
danielk197776d505b2004-05-28 13:13:02 +00002126 generateColumnTypes(pParse, pTabList, pEList);
drh82c3d632000-06-06 21:56:07 +00002127}
2128
drhd8bc7082000-06-07 23:51:50 +00002129/*
peter.d.reid60ec9142014-09-06 16:39:46 +00002130** Given an expression list (which is really the list of expressions
drh7d10d5a2008-08-20 16:35:10 +00002131** that form the result set of a SELECT statement) compute appropriate
2132** column names for a table that would hold the expression list.
2133**
2134** All column names will be unique.
2135**
2136** Only the column names are computed. Column.zType, Column.zColl,
2137** and other fields of Column are zeroed.
2138**
2139** Return SQLITE_OK on success. If a memory allocation error occurs,
2140** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
drhec360a82017-07-12 14:10:19 +00002141**
2142** The only guarantee that SQLite makes about column names is that if the
2143** column has an AS clause assigning it a name, that will be the name used.
2144** That is the only documented guarantee. However, countless applications
2145** developed over the years have made baseless assumptions about column names
2146** and will break if those assumptions changes. Hence, use extreme caution
2147** when modifying this routine to avoid breaking legacy.
2148**
drh90881862021-05-19 12:17:03 +00002149** See Also: sqlite3GenerateColumnNames()
drh315555c2002-10-20 15:53:03 +00002150*/
drh8981b902015-08-24 17:42:49 +00002151int sqlite3ColumnsFromExprList(
drh7d10d5a2008-08-20 16:35:10 +00002152 Parse *pParse, /* Parsing context */
2153 ExprList *pEList, /* Expr list from which to derive column names */
drhd815f172012-09-13 14:42:43 +00002154 i16 *pnCol, /* Write the number of columns here */
drh7d10d5a2008-08-20 16:35:10 +00002155 Column **paCol /* Write the new column list here */
2156){
drhdc5ea5c2008-12-10 17:19:59 +00002157 sqlite3 *db = pParse->db; /* Database connection */
2158 int i, j; /* Loop counters */
drhebed3fa2015-11-14 16:47:23 +00002159 u32 cnt; /* Index added to make the name unique */
drhdc5ea5c2008-12-10 17:19:59 +00002160 Column *aCol, *pCol; /* For looping over result columns */
2161 int nCol; /* Number of columns in the result set */
drhdc5ea5c2008-12-10 17:19:59 +00002162 char *zName; /* Column name */
2163 int nName; /* Size of name in zName[] */
drh0315e3c2015-11-14 20:52:43 +00002164 Hash ht; /* Hash table of column names */
drh6d5ab2a2020-11-02 00:40:05 +00002165 Table *pTab;
drh22f70c32002-02-18 01:17:00 +00002166
drh0315e3c2015-11-14 20:52:43 +00002167 sqlite3HashInit(&ht);
dan8c2e0f02012-03-31 15:08:56 +00002168 if( pEList ){
2169 nCol = pEList->nExpr;
2170 aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
2171 testcase( aCol==0 );
drh080fe6d2021-03-18 20:04:46 +00002172 if( NEVER(nCol>32767) ) nCol = 32767;
dan8c2e0f02012-03-31 15:08:56 +00002173 }else{
2174 nCol = 0;
2175 aCol = 0;
2176 }
dan8836cbb2015-11-21 19:43:29 +00002177 assert( nCol==(i16)nCol );
dan8c2e0f02012-03-31 15:08:56 +00002178 *pnCol = nCol;
2179 *paCol = aCol;
2180
drh0315e3c2015-11-14 20:52:43 +00002181 for(i=0, pCol=aCol; i<nCol && !db->mallocFailed; i++, pCol++){
drh79d5f632005-01-18 17:20:10 +00002182 /* Get an appropriate name for the column
2183 */
drhcbb9da32019-12-12 22:11:33 +00002184 if( (zName = pEList->a[i].zEName)!=0 && pEList->a[i].eEName==ENAME_NAME ){
drh79d5f632005-01-18 17:20:10 +00002185 /* If the column contains an "AS <name>" phrase, use <name> as the name */
drh93a960a2008-07-10 00:32:42 +00002186 }else{
drh0d950af2019-08-22 16:38:42 +00002187 Expr *pColExpr = sqlite3ExprSkipCollateAndLikely(pEList->a[i].pExpr);
drh235667a2020-11-08 20:44:30 +00002188 while( ALWAYS(pColExpr!=0) && pColExpr->op==TK_DOT ){
drhb07028f2011-10-14 21:49:18 +00002189 pColExpr = pColExpr->pRight;
2190 assert( pColExpr!=0 );
2191 }
drh477572b2021-10-07 20:46:29 +00002192 if( pColExpr->op==TK_COLUMN
2193 && ALWAYS( ExprUseYTab(pColExpr) )
2194 && (pTab = pColExpr->y.pTab)!=0
2195 ){
drh7d10d5a2008-08-20 16:35:10 +00002196 /* For columns use the column name name */
drhdc5ea5c2008-12-10 17:19:59 +00002197 int iCol = pColExpr->iColumn;
drhf0209f72008-08-21 14:54:28 +00002198 if( iCol<0 ) iCol = pTab->iPKey;
drhcf9d36d2021-08-02 18:03:43 +00002199 zName = iCol>=0 ? pTab->aCol[iCol].zCnName : "rowid";
drhb7916a72009-05-27 10:31:29 +00002200 }else if( pColExpr->op==TK_ID ){
drh33e619f2009-05-28 01:00:55 +00002201 assert( !ExprHasProperty(pColExpr, EP_IntValue) );
drh96ceaf82015-11-14 22:04:22 +00002202 zName = pColExpr->u.zToken;
drh7d10d5a2008-08-20 16:35:10 +00002203 }else{
2204 /* Use the original text of the column expression as its name */
drhcbb9da32019-12-12 22:11:33 +00002205 zName = pEList->a[i].zEName;
drh7d10d5a2008-08-20 16:35:10 +00002206 }
drh22f70c32002-02-18 01:17:00 +00002207 }
drh0cbec592020-01-03 02:20:37 +00002208 if( zName && !sqlite3IsTrueOrFalse(zName) ){
drhd7ca6002017-07-09 00:30:58 +00002209 zName = sqlite3DbStrDup(db, zName);
2210 }else{
drh155507b2017-07-09 18:55:29 +00002211 zName = sqlite3MPrintf(db,"column%d",i+1);
drhd7ca6002017-07-09 00:30:58 +00002212 }
drh79d5f632005-01-18 17:20:10 +00002213
2214 /* Make sure the column name is unique. If the name is not unique,
peter.d.reid60ec9142014-09-06 16:39:46 +00002215 ** append an integer to the name so that it becomes unique.
drh79d5f632005-01-18 17:20:10 +00002216 */
drh0315e3c2015-11-14 20:52:43 +00002217 cnt = 0;
2218 while( zName && sqlite3HashFind(&ht, zName)!=0 ){
drh0315e3c2015-11-14 20:52:43 +00002219 nName = sqlite3Strlen30(zName);
drhf7ee8962015-11-15 11:13:49 +00002220 if( nName>0 ){
2221 for(j=nName-1; j>0 && sqlite3Isdigit(zName[j]); j--){}
2222 if( zName[j]==':' ) nName = j;
2223 }
drh96ceaf82015-11-14 22:04:22 +00002224 zName = sqlite3MPrintf(db, "%.*z:%u", nName, zName, ++cnt);
drh0315e3c2015-11-14 20:52:43 +00002225 if( cnt>3 ) sqlite3_randomness(sizeof(cnt), &cnt);
drh79d5f632005-01-18 17:20:10 +00002226 }
drhcf9d36d2021-08-02 18:03:43 +00002227 pCol->zCnName = zName;
drhd44390c2020-04-06 18:16:31 +00002228 pCol->hName = sqlite3StrIHash(zName);
danba68f8f2015-11-19 16:46:46 +00002229 sqlite3ColumnPropertiesFromName(0, pCol);
drh03d69a62015-11-19 13:53:57 +00002230 if( zName && sqlite3HashInsert(&ht, zName, pCol)==pCol ){
drh4a642b62016-02-05 01:55:27 +00002231 sqlite3OomFault(db);
drh0315e3c2015-11-14 20:52:43 +00002232 }
drh7d10d5a2008-08-20 16:35:10 +00002233 }
drh0315e3c2015-11-14 20:52:43 +00002234 sqlite3HashClear(&ht);
drh7d10d5a2008-08-20 16:35:10 +00002235 if( db->mallocFailed ){
drh7d10d5a2008-08-20 16:35:10 +00002236 for(j=0; j<i; j++){
drhcf9d36d2021-08-02 18:03:43 +00002237 sqlite3DbFree(db, aCol[j].zCnName);
drh7d10d5a2008-08-20 16:35:10 +00002238 }
2239 sqlite3DbFree(db, aCol);
2240 *paCol = 0;
2241 *pnCol = 0;
mistachkinfad30392016-02-13 23:43:46 +00002242 return SQLITE_NOMEM_BKPT;
drh7d10d5a2008-08-20 16:35:10 +00002243 }
2244 return SQLITE_OK;
2245}
danielk1977517eb642004-06-07 10:00:31 +00002246
drh7d10d5a2008-08-20 16:35:10 +00002247/*
2248** Add type and collation information to a column list based on
2249** a SELECT statement.
2250**
2251** The column list presumably came from selectColumnNamesFromExprList().
2252** The column list has only names, not types or collations. This
2253** routine goes through and adds the types and collations.
2254**
shaneb08a67a2009-03-31 03:41:56 +00002255** This routine requires that all identifiers in the SELECT
drh7d10d5a2008-08-20 16:35:10 +00002256** statement be resolved.
2257*/
drhed06a132016-04-05 20:59:12 +00002258void sqlite3SelectAddColumnTypeAndCollation(
drh7d10d5a2008-08-20 16:35:10 +00002259 Parse *pParse, /* Parsing contexts */
drh186ad8c2013-10-08 18:40:37 +00002260 Table *pTab, /* Add column type information to this table */
drh81506b82019-08-05 19:32:06 +00002261 Select *pSelect, /* SELECT used to determine types and collations */
2262 char aff /* Default affinity for columns */
drh7d10d5a2008-08-20 16:35:10 +00002263){
2264 sqlite3 *db = pParse->db;
2265 NameContext sNC;
2266 Column *pCol;
2267 CollSeq *pColl;
2268 int i;
2269 Expr *p;
2270 struct ExprList_item *a;
2271
2272 assert( pSelect!=0 );
2273 assert( (pSelect->selFlags & SF_Resolved)!=0 );
drh186ad8c2013-10-08 18:40:37 +00002274 assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
drh7d10d5a2008-08-20 16:35:10 +00002275 if( db->mallocFailed ) return;
2276 memset(&sNC, 0, sizeof(sNC));
2277 sNC.pSrcList = pSelect->pSrc;
2278 a = pSelect->pEList->a;
drh186ad8c2013-10-08 18:40:37 +00002279 for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
drhed06a132016-04-05 20:59:12 +00002280 const char *zType;
drh913306a2021-11-26 17:10:18 +00002281 i64 n, m;
drh6f6e60d2021-02-18 15:45:34 +00002282 pTab->tabFlags |= (pCol->colFlags & COLFLAG_NOINSERT);
drh7d10d5a2008-08-20 16:35:10 +00002283 p = a[i].pExpr;
drhcafc2f72017-10-03 03:01:09 +00002284 zType = columnType(&sNC, p, 0, 0, 0);
2285 /* pCol->szEst = ... // Column size est for SELECT tables never used */
danielk1977c60e9b82005-01-31 12:42:29 +00002286 pCol->affinity = sqlite3ExprAffinity(p);
drh0c4db032017-10-03 19:53:12 +00002287 if( zType ){
2288 m = sqlite3Strlen30(zType);
drhcf9d36d2021-08-02 18:03:43 +00002289 n = sqlite3Strlen30(pCol->zCnName);
2290 pCol->zCnName = sqlite3DbReallocOrFree(db, pCol->zCnName, n+m+2);
2291 if( pCol->zCnName ){
2292 memcpy(&pCol->zCnName[n+1], zType, m+1);
drhed06a132016-04-05 20:59:12 +00002293 pCol->colFlags |= COLFLAG_HASTYPE;
drh146121f2021-11-12 14:39:49 +00002294 }else{
2295 testcase( pCol->colFlags & COLFLAG_HASTYPE );
2296 pCol->colFlags &= ~(COLFLAG_HASTYPE|COLFLAG_HASCOLL);
drhed06a132016-04-05 20:59:12 +00002297 }
2298 }
drh96fb16e2019-08-06 14:37:24 +00002299 if( pCol->affinity<=SQLITE_AFF_NONE ) pCol->affinity = aff;
danielk1977b3bf5562006-01-10 17:58:23 +00002300 pColl = sqlite3ExprCollSeq(pParse, p);
drh5ced0a92021-08-24 17:07:44 +00002301 if( pColl ){
drh65b40092021-08-05 15:27:19 +00002302 assert( pTab->pIndex==0 );
2303 sqlite3ColumnSetColl(db, pCol, pColl->zName);
danielk19770202b292004-06-09 09:55:16 +00002304 }
drh22f70c32002-02-18 01:17:00 +00002305 }
drhcafc2f72017-10-03 03:01:09 +00002306 pTab->szTabRow = 1; /* Any non-zero value works */
drh7d10d5a2008-08-20 16:35:10 +00002307}
2308
2309/*
2310** Given a SELECT statement, generate a Table structure that describes
2311** the result set of that SELECT.
2312*/
drh81506b82019-08-05 19:32:06 +00002313Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect, char aff){
drh7d10d5a2008-08-20 16:35:10 +00002314 Table *pTab;
2315 sqlite3 *db = pParse->db;
drh70d5dfb2018-12-06 16:50:55 +00002316 u64 savedFlags;
drh7d10d5a2008-08-20 16:35:10 +00002317
2318 savedFlags = db->flags;
drhd5b44d62018-12-06 17:06:02 +00002319 db->flags &= ~(u64)SQLITE_FullColNames;
drh7d10d5a2008-08-20 16:35:10 +00002320 db->flags |= SQLITE_ShortColNames;
2321 sqlite3SelectPrep(pParse, pSelect, 0);
drh491b6d82019-01-24 15:51:03 +00002322 db->flags = savedFlags;
drh7d10d5a2008-08-20 16:35:10 +00002323 if( pParse->nErr ) return 0;
2324 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh7d10d5a2008-08-20 16:35:10 +00002325 pTab = sqlite3DbMallocZero(db, sizeof(Table) );
2326 if( pTab==0 ){
2327 return 0;
2328 }
drh79df7782016-12-14 14:07:35 +00002329 pTab->nTabRef = 1;
drh7d10d5a2008-08-20 16:35:10 +00002330 pTab->zName = 0;
dancfc9df72014-04-25 15:01:01 +00002331 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drh8981b902015-08-24 17:42:49 +00002332 sqlite3ColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
drh81506b82019-08-05 19:32:06 +00002333 sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSelect, aff);
drh22f70c32002-02-18 01:17:00 +00002334 pTab->iPKey = -1;
drh7ce72f62008-07-24 15:50:41 +00002335 if( db->mallocFailed ){
dan1feeaed2010-07-23 15:41:47 +00002336 sqlite3DeleteTable(db, pTab);
drh7ce72f62008-07-24 15:50:41 +00002337 return 0;
2338 }
drh22f70c32002-02-18 01:17:00 +00002339 return pTab;
2340}
2341
2342/*
drhd8bc7082000-06-07 23:51:50 +00002343** Get a VDBE for the given parser context. Create a new one if necessary.
2344** If an error occurs, return NULL and leave a message in pParse.
2345*/
drh55965612017-09-16 20:58:41 +00002346Vdbe *sqlite3GetVdbe(Parse *pParse){
2347 if( pParse->pVdbe ){
2348 return pParse->pVdbe;
2349 }
drh6f077342016-04-12 00:26:59 +00002350 if( pParse->pToplevel==0
2351 && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
2352 ){
2353 pParse->okConstFactor = 1;
drhd8bc7082000-06-07 23:51:50 +00002354 }
drh55965612017-09-16 20:58:41 +00002355 return sqlite3VdbeCreate(pParse);
drh6f077342016-04-12 00:26:59 +00002356}
drhfcb78a42003-01-18 20:11:05 +00002357
drh15007a92006-01-08 18:10:17 +00002358
drhd8bc7082000-06-07 23:51:50 +00002359/*
drh7b58dae2003-07-20 01:16:46 +00002360** Compute the iLimit and iOffset fields of the SELECT based on the
drh8c0833f2017-11-14 23:48:23 +00002361** pLimit expressions. pLimit->pLeft and pLimit->pRight hold the expressions
drh7b58dae2003-07-20 01:16:46 +00002362** that appear in the original SQL statement after the LIMIT and OFFSET
danielk1977a2dc3b12005-02-05 12:48:48 +00002363** keywords. Or NULL if those keywords are omitted. iLimit and iOffset
2364** are the integer memory register numbers for counters used to compute
2365** the limit and offset. If there is no limit and/or offset, then
2366** iLimit and iOffset are negative.
drh7b58dae2003-07-20 01:16:46 +00002367**
drhd59ba6c2006-01-08 05:02:54 +00002368** This routine changes the values of iLimit and iOffset only if
drh8c0833f2017-11-14 23:48:23 +00002369** a limit or offset is defined by pLimit->pLeft and pLimit->pRight. iLimit
2370** and iOffset should have been preset to appropriate default values (zero)
drhaa9ce702014-01-22 18:07:04 +00002371** prior to calling this routine.
2372**
2373** The iOffset register (if it exists) is initialized to the value
2374** of the OFFSET. The iLimit register is initialized to LIMIT. Register
2375** iOffset+1 is initialized to LIMIT+OFFSET.
2376**
drh8c0833f2017-11-14 23:48:23 +00002377** Only if pLimit->pLeft!=0 do the limit registers get
drh7b58dae2003-07-20 01:16:46 +00002378** redefined. The UNION ALL operator uses this property to force
2379** the reuse of the same limit and offset registers across multiple
2380** SELECT statements.
2381*/
drhec7429a2005-10-06 16:53:14 +00002382static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
drh02afc862006-01-20 18:10:57 +00002383 Vdbe *v = 0;
2384 int iLimit = 0;
drh15007a92006-01-08 18:10:17 +00002385 int iOffset;
drh8b0cf382015-10-06 21:07:06 +00002386 int n;
drh8c0833f2017-11-14 23:48:23 +00002387 Expr *pLimit = p->pLimit;
2388
drh0acb7e42008-06-25 00:12:41 +00002389 if( p->iLimit ) return;
drh15007a92006-01-08 18:10:17 +00002390
drh7b58dae2003-07-20 01:16:46 +00002391 /*
drh7b58dae2003-07-20 01:16:46 +00002392 ** "LIMIT -1" always shows all rows. There is some
drhf7b54962013-05-28 12:11:54 +00002393 ** controversy about what the correct behavior should be.
drh7b58dae2003-07-20 01:16:46 +00002394 ** The current implementation interprets "LIMIT 0" to mean
2395 ** no rows.
2396 */
drh8c0833f2017-11-14 23:48:23 +00002397 if( pLimit ){
2398 assert( pLimit->op==TK_LIMIT );
2399 assert( pLimit->pLeft!=0 );
drh0a07c102008-01-03 18:03:08 +00002400 p->iLimit = iLimit = ++pParse->nMem;
drh15007a92006-01-08 18:10:17 +00002401 v = sqlite3GetVdbe(pParse);
drhaa9ce702014-01-22 18:07:04 +00002402 assert( v!=0 );
drh8c0833f2017-11-14 23:48:23 +00002403 if( sqlite3ExprIsInteger(pLimit->pLeft, &n) ){
drh456e4e42009-11-20 16:13:15 +00002404 sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
2405 VdbeComment((v, "LIMIT counter"));
drh9b918ed2009-11-12 03:13:26 +00002406 if( n==0 ){
drh076e85f2015-09-03 13:46:12 +00002407 sqlite3VdbeGoto(v, iBreak);
drhc3489bb2016-02-25 16:04:59 +00002408 }else if( n>=0 && p->nSelectRow>sqlite3LogEst((u64)n) ){
2409 p->nSelectRow = sqlite3LogEst((u64)n);
2410 p->selFlags |= SF_FixedLimit;
drh9b918ed2009-11-12 03:13:26 +00002411 }
2412 }else{
drh8c0833f2017-11-14 23:48:23 +00002413 sqlite3ExprCode(pParse, pLimit->pLeft, iLimit);
drh688852a2014-02-17 22:40:43 +00002414 sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
drh9b918ed2009-11-12 03:13:26 +00002415 VdbeComment((v, "LIMIT counter"));
drh16897072015-03-07 00:57:37 +00002416 sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, iBreak); VdbeCoverage(v);
drh9b918ed2009-11-12 03:13:26 +00002417 }
drh8c0833f2017-11-14 23:48:23 +00002418 if( pLimit->pRight ){
drh373cc2d2009-05-17 02:06:14 +00002419 p->iOffset = iOffset = ++pParse->nMem;
drhb7654112008-01-12 12:48:07 +00002420 pParse->nMem++; /* Allocate an extra register for limit+offset */
drh8c0833f2017-11-14 23:48:23 +00002421 sqlite3ExprCode(pParse, pLimit->pRight, iOffset);
drh688852a2014-02-17 22:40:43 +00002422 sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
drh373cc2d2009-05-17 02:06:14 +00002423 VdbeComment((v, "OFFSET counter"));
drhcc2fa4c2016-01-25 15:57:29 +00002424 sqlite3VdbeAddOp3(v, OP_OffsetLimit, iLimit, iOffset+1, iOffset);
drhb7654112008-01-12 12:48:07 +00002425 VdbeComment((v, "LIMIT+OFFSET"));
drhd59ba6c2006-01-08 05:02:54 +00002426 }
drh7b58dae2003-07-20 01:16:46 +00002427 }
2428}
2429
drhb7f91642004-10-31 02:22:47 +00002430#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhfbc4ee72004-08-29 01:31:05 +00002431/*
drhfbc4ee72004-08-29 01:31:05 +00002432** Return the appropriate collating sequence for the iCol-th column of
2433** the result set for the compound-select statement "p". Return NULL if
2434** the column has no default collating sequence.
2435**
2436** The collating sequence for the compound select is taken from the
2437** left-most term of the select that has a collating sequence.
2438*/
danielk1977dc1bdc42004-06-11 10:51:27 +00002439static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
drhfbc4ee72004-08-29 01:31:05 +00002440 CollSeq *pRet;
danielk1977dc1bdc42004-06-11 10:51:27 +00002441 if( p->pPrior ){
2442 pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
drhfbc4ee72004-08-29 01:31:05 +00002443 }else{
2444 pRet = 0;
danielk1977dc1bdc42004-06-11 10:51:27 +00002445 }
drh10c081a2009-04-16 00:24:23 +00002446 assert( iCol>=0 );
drh2ec18a32015-06-23 23:31:52 +00002447 /* iCol must be less than p->pEList->nExpr. Otherwise an error would
2448 ** have been thrown during name resolution and we would not have gotten
2449 ** this far */
2450 if( pRet==0 && ALWAYS(iCol<p->pEList->nExpr) ){
danielk1977dc1bdc42004-06-11 10:51:27 +00002451 pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
2452 }
2453 return pRet;
drhd3d39e92004-05-20 22:16:29 +00002454}
2455
dan53bed452014-01-24 20:37:18 +00002456/*
2457** The select statement passed as the second parameter is a compound SELECT
2458** with an ORDER BY clause. This function allocates and returns a KeyInfo
2459** structure suitable for implementing the ORDER BY.
2460**
2461** Space to hold the KeyInfo structure is obtained from malloc. The calling
2462** function is responsible for ensuring that this structure is eventually
2463** freed.
2464*/
2465static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
2466 ExprList *pOrderBy = p->pOrderBy;
drh7d4c94b2021-10-04 22:34:38 +00002467 int nOrderBy = ALWAYS(pOrderBy!=0) ? pOrderBy->nExpr : 0;
dan53bed452014-01-24 20:37:18 +00002468 sqlite3 *db = pParse->db;
2469 KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
2470 if( pRet ){
2471 int i;
2472 for(i=0; i<nOrderBy; i++){
2473 struct ExprList_item *pItem = &pOrderBy->a[i];
2474 Expr *pTerm = pItem->pExpr;
2475 CollSeq *pColl;
2476
2477 if( pTerm->flags & EP_Collate ){
2478 pColl = sqlite3ExprCollSeq(pParse, pTerm);
2479 }else{
2480 pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
2481 if( pColl==0 ) pColl = db->pDfltColl;
2482 pOrderBy->a[i].pExpr =
2483 sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
2484 }
2485 assert( sqlite3KeyInfoIsWriteable(pRet) );
2486 pRet->aColl[i] = pColl;
dan6e118922019-08-12 16:36:38 +00002487 pRet->aSortFlags[i] = pOrderBy->a[i].sortFlags;
dan53bed452014-01-24 20:37:18 +00002488 }
2489 }
2490
2491 return pRet;
2492}
drhd3d39e92004-05-20 22:16:29 +00002493
drh781def22014-01-22 13:35:53 +00002494#ifndef SQLITE_OMIT_CTE
2495/*
2496** This routine generates VDBE code to compute the content of a WITH RECURSIVE
2497** query of the form:
2498**
2499** <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
2500** \___________/ \_______________/
2501** p->pPrior p
2502**
2503**
2504** There is exactly one reference to the recursive-table in the FROM clause
drh8a48b9c2015-08-19 15:20:00 +00002505** of recursive-query, marked with the SrcList->a[].fg.isRecursive flag.
drh781def22014-01-22 13:35:53 +00002506**
2507** The setup-query runs once to generate an initial set of rows that go
2508** into a Queue table. Rows are extracted from the Queue table one by
drhfe1c6bb2014-01-22 17:28:35 +00002509** one. Each row extracted from Queue is output to pDest. Then the single
2510** extracted row (now in the iCurrent table) becomes the content of the
2511** recursive-table for a recursive-query run. The output of the recursive-query
drh781def22014-01-22 13:35:53 +00002512** is added back into the Queue table. Then another row is extracted from Queue
2513** and the iteration continues until the Queue table is empty.
2514**
2515** If the compound query operator is UNION then no duplicate rows are ever
2516** inserted into the Queue table. The iDistinct table keeps a copy of all rows
2517** that have ever been inserted into Queue and causes duplicates to be
2518** discarded. If the operator is UNION ALL, then duplicates are allowed.
2519**
2520** If the query has an ORDER BY, then entries in the Queue table are kept in
2521** ORDER BY order and the first entry is extracted for each cycle. Without
2522** an ORDER BY, the Queue table is just a FIFO.
2523**
2524** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
2525** have been output to pDest. A LIMIT of zero means to output no rows and a
2526** negative LIMIT means to output all rows. If there is also an OFFSET clause
2527** with a positive value, then the first OFFSET outputs are discarded rather
2528** than being sent to pDest. The LIMIT count does not begin until after OFFSET
2529** rows have been skipped.
2530*/
2531static void generateWithRecursiveQuery(
2532 Parse *pParse, /* Parsing context */
2533 Select *p, /* The recursive SELECT to be coded */
2534 SelectDest *pDest /* What to do with query results */
2535){
2536 SrcList *pSrc = p->pSrc; /* The FROM clause of the recursive query */
2537 int nCol = p->pEList->nExpr; /* Number of columns in the recursive table */
2538 Vdbe *v = pParse->pVdbe; /* The prepared statement under construction */
drhe85e1da2021-10-01 21:01:07 +00002539 Select *pSetup; /* The setup query */
drh34055852020-10-19 01:23:48 +00002540 Select *pFirstRec; /* Left-most recursive term */
drh781def22014-01-22 13:35:53 +00002541 int addrTop; /* Top of the loop */
2542 int addrCont, addrBreak; /* CONTINUE and BREAK addresses */
drhedf83d12014-01-22 18:31:27 +00002543 int iCurrent = 0; /* The Current table */
drh781def22014-01-22 13:35:53 +00002544 int regCurrent; /* Register holding Current table */
2545 int iQueue; /* The Queue table */
2546 int iDistinct = 0; /* To ensure unique results if UNION */
drh8e1ee882014-03-21 19:56:09 +00002547 int eDest = SRT_Fifo; /* How to write to Queue */
drh781def22014-01-22 13:35:53 +00002548 SelectDest destQueue; /* SelectDest targetting the Queue table */
2549 int i; /* Loop counter */
2550 int rc; /* Result code */
drhfe1c6bb2014-01-22 17:28:35 +00002551 ExprList *pOrderBy; /* The ORDER BY clause */
drh8c0833f2017-11-14 23:48:23 +00002552 Expr *pLimit; /* Saved LIMIT and OFFSET */
drhaa9ce702014-01-22 18:07:04 +00002553 int regLimit, regOffset; /* Registers used by LIMIT and OFFSET */
drh781def22014-01-22 13:35:53 +00002554
dan6afa35c2018-09-27 12:14:15 +00002555#ifndef SQLITE_OMIT_WINDOWFUNC
2556 if( p->pWin ){
2557 sqlite3ErrorMsg(pParse, "cannot use window functions in recursive queries");
2558 return;
2559 }
2560#endif
2561
drh781def22014-01-22 13:35:53 +00002562 /* Obtain authorization to do a recursive query */
2563 if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
drh781def22014-01-22 13:35:53 +00002564
drhaa9ce702014-01-22 18:07:04 +00002565 /* Process the LIMIT and OFFSET clauses, if they exist */
drhec4ccdb2018-12-29 02:26:59 +00002566 addrBreak = sqlite3VdbeMakeLabel(pParse);
dan69b93832016-12-16 15:05:40 +00002567 p->nSelectRow = 320; /* 4 billion rows */
drhaa9ce702014-01-22 18:07:04 +00002568 computeLimitRegisters(pParse, p, addrBreak);
2569 pLimit = p->pLimit;
drhaa9ce702014-01-22 18:07:04 +00002570 regLimit = p->iLimit;
2571 regOffset = p->iOffset;
drh8c0833f2017-11-14 23:48:23 +00002572 p->pLimit = 0;
drhaa9ce702014-01-22 18:07:04 +00002573 p->iLimit = p->iOffset = 0;
dan53bed452014-01-24 20:37:18 +00002574 pOrderBy = p->pOrderBy;
drh781def22014-01-22 13:35:53 +00002575
2576 /* Locate the cursor number of the Current table */
2577 for(i=0; ALWAYS(i<pSrc->nSrc); i++){
drh8a48b9c2015-08-19 15:20:00 +00002578 if( pSrc->a[i].fg.isRecursive ){
drh781def22014-01-22 13:35:53 +00002579 iCurrent = pSrc->a[i].iCursor;
2580 break;
2581 }
2582 }
2583
drhfe1c6bb2014-01-22 17:28:35 +00002584 /* Allocate cursors numbers for Queue and Distinct. The cursor number for
drh781def22014-01-22 13:35:53 +00002585 ** the Distinct table must be exactly one greater than Queue in order
drh8e1ee882014-03-21 19:56:09 +00002586 ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
drh781def22014-01-22 13:35:53 +00002587 iQueue = pParse->nTab++;
2588 if( p->op==TK_UNION ){
drh8e1ee882014-03-21 19:56:09 +00002589 eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
drh781def22014-01-22 13:35:53 +00002590 iDistinct = pParse->nTab++;
drhfe1c6bb2014-01-22 17:28:35 +00002591 }else{
drh8e1ee882014-03-21 19:56:09 +00002592 eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
drh781def22014-01-22 13:35:53 +00002593 }
2594 sqlite3SelectDestInit(&destQueue, eDest, iQueue);
2595
2596 /* Allocate cursors for Current, Queue, and Distinct. */
2597 regCurrent = ++pParse->nMem;
2598 sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
drhfe1c6bb2014-01-22 17:28:35 +00002599 if( pOrderBy ){
dan53bed452014-01-24 20:37:18 +00002600 KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
drhfe1c6bb2014-01-22 17:28:35 +00002601 sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
2602 (char*)pKeyInfo, P4_KEYINFO);
2603 destQueue.pOrderBy = pOrderBy;
2604 }else{
2605 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
2606 }
2607 VdbeComment((v, "Queue table"));
drh781def22014-01-22 13:35:53 +00002608 if( iDistinct ){
2609 p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
2610 p->selFlags |= SF_UsesEphemeral;
2611 }
2612
dan53bed452014-01-24 20:37:18 +00002613 /* Detach the ORDER BY clause from the compound SELECT */
2614 p->pOrderBy = 0;
2615
drh34055852020-10-19 01:23:48 +00002616 /* Figure out how many elements of the compound SELECT are part of the
2617 ** recursive query. Make sure no recursive elements use aggregate
2618 ** functions. Mark the recursive elements as UNION ALL even if they
2619 ** are really UNION because the distinctness will be enforced by the
2620 ** iDistinct table. pFirstRec is left pointing to the left-most
2621 ** recursive term of the CTE.
2622 */
drh34055852020-10-19 01:23:48 +00002623 for(pFirstRec=p; ALWAYS(pFirstRec!=0); pFirstRec=pFirstRec->pPrior){
2624 if( pFirstRec->selFlags & SF_Aggregate ){
2625 sqlite3ErrorMsg(pParse, "recursive aggregate queries not supported");
2626 goto end_of_recursive_query;
2627 }
2628 pFirstRec->op = TK_ALL;
2629 if( (pFirstRec->pPrior->selFlags & SF_Recursive)==0 ) break;
2630 }
2631
drh781def22014-01-22 13:35:53 +00002632 /* Store the results of the setup-query in Queue. */
drh34055852020-10-19 01:23:48 +00002633 pSetup = pFirstRec->pPrior;
drhd227a292014-02-09 18:02:09 +00002634 pSetup->pNext = 0;
drh84a01de2018-05-02 16:13:48 +00002635 ExplainQueryPlan((pParse, 1, "SETUP"));
drh781def22014-01-22 13:35:53 +00002636 rc = sqlite3Select(pParse, pSetup, &destQueue);
drhd227a292014-02-09 18:02:09 +00002637 pSetup->pNext = p;
drhfe1c6bb2014-01-22 17:28:35 +00002638 if( rc ) goto end_of_recursive_query;
drh781def22014-01-22 13:35:53 +00002639
2640 /* Find the next row in the Queue and output that row */
drh688852a2014-02-17 22:40:43 +00002641 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
drh781def22014-01-22 13:35:53 +00002642
2643 /* Transfer the next row in Queue over to Current */
2644 sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
drhfe1c6bb2014-01-22 17:28:35 +00002645 if( pOrderBy ){
2646 sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
2647 }else{
2648 sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
2649 }
drh781def22014-01-22 13:35:53 +00002650 sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
2651
drhfe1c6bb2014-01-22 17:28:35 +00002652 /* Output the single row in Current */
drhec4ccdb2018-12-29 02:26:59 +00002653 addrCont = sqlite3VdbeMakeLabel(pParse);
drhaa9ce702014-01-22 18:07:04 +00002654 codeOffset(v, regOffset, addrCont);
drh2def2f72017-09-15 17:40:34 +00002655 selectInnerLoop(pParse, p, iCurrent,
drh079a3072014-03-19 14:10:55 +00002656 0, 0, pDest, addrCont, addrBreak);
drh688852a2014-02-17 22:40:43 +00002657 if( regLimit ){
drh16897072015-03-07 00:57:37 +00002658 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, regLimit, addrBreak);
drh688852a2014-02-17 22:40:43 +00002659 VdbeCoverage(v);
2660 }
drhfe1c6bb2014-01-22 17:28:35 +00002661 sqlite3VdbeResolveLabel(v, addrCont);
2662
drh781def22014-01-22 13:35:53 +00002663 /* Execute the recursive SELECT taking the single row in Current as
2664 ** the value for the recursive-table. Store the results in the Queue.
2665 */
drh34055852020-10-19 01:23:48 +00002666 pFirstRec->pPrior = 0;
2667 ExplainQueryPlan((pParse, 1, "RECURSIVE STEP"));
2668 sqlite3Select(pParse, p, &destQueue);
2669 assert( pFirstRec->pPrior==0 );
2670 pFirstRec->pPrior = pSetup;
drh781def22014-01-22 13:35:53 +00002671
2672 /* Keep running the loop until the Queue is empty */
drh076e85f2015-09-03 13:46:12 +00002673 sqlite3VdbeGoto(v, addrTop);
drh781def22014-01-22 13:35:53 +00002674 sqlite3VdbeResolveLabel(v, addrBreak);
drhfe1c6bb2014-01-22 17:28:35 +00002675
2676end_of_recursive_query:
dan9afccba2014-03-21 19:27:54 +00002677 sqlite3ExprListDelete(pParse->db, p->pOrderBy);
drhfe1c6bb2014-01-22 17:28:35 +00002678 p->pOrderBy = pOrderBy;
drhaa9ce702014-01-22 18:07:04 +00002679 p->pLimit = pLimit;
drhfe1c6bb2014-01-22 17:28:35 +00002680 return;
drh781def22014-01-22 13:35:53 +00002681}
danb68b9772014-01-25 12:16:53 +00002682#endif /* SQLITE_OMIT_CTE */
drh781def22014-01-22 13:35:53 +00002683
2684/* Forward references */
drhb21e7c72008-06-22 12:37:57 +00002685static int multiSelectOrderBy(
2686 Parse *pParse, /* Parsing context */
2687 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00002688 SelectDest *pDest /* What to do with query results */
drhb21e7c72008-06-22 12:37:57 +00002689);
2690
drh45f54a52015-01-05 19:16:42 +00002691/*
drh45f54a52015-01-05 19:16:42 +00002692** Handle the special case of a compound-select that originates from a
2693** VALUES clause. By handling this as a special case, we avoid deep
2694** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
2695** on a VALUES clause.
2696**
2697** Because the Select object originates from a VALUES clause:
drhb058d052018-01-14 20:12:23 +00002698** (1) There is no LIMIT or OFFSET or else there is a LIMIT of exactly 1
drh45f54a52015-01-05 19:16:42 +00002699** (2) All terms are UNION ALL
2700** (3) There is no ORDER BY clause
drhb058d052018-01-14 20:12:23 +00002701**
2702** The "LIMIT of exactly 1" case of condition (1) comes about when a VALUES
2703** clause occurs within scalar expression (ex: "SELECT (VALUES(1),(2),(3))").
2704** The sqlite3CodeSubselect will have added the LIMIT 1 clause in tht case.
drhd1f0a862022-02-25 11:30:29 +00002705** Since the limit is exactly 1, we only need to evaluate the left-most VALUES.
drh45f54a52015-01-05 19:16:42 +00002706*/
2707static int multiSelectValues(
2708 Parse *pParse, /* Parsing context */
2709 Select *p, /* The right-most of SELECTs to be coded */
2710 SelectDest *pDest /* What to do with query results */
2711){
drh45f54a52015-01-05 19:16:42 +00002712 int nRow = 1;
2713 int rc = 0;
drhfa16f5d2018-05-03 01:37:13 +00002714 int bShowAll = p->pLimit==0;
drh772460f2015-04-16 14:13:12 +00002715 assert( p->selFlags & SF_MultiValue );
drh45f54a52015-01-05 19:16:42 +00002716 do{
2717 assert( p->selFlags & SF_Values );
2718 assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
dan923cadb2015-06-23 12:19:55 +00002719 assert( p->pNext==0 || p->pEList->nExpr==p->pNext->pEList->nExpr );
drhef9f7192020-01-17 19:14:08 +00002720#ifndef SQLITE_OMIT_WINDOWFUNC
drh29cdbad2019-12-07 13:42:47 +00002721 if( p->pWin ) return -1;
drhef9f7192020-01-17 19:14:08 +00002722#endif
drh45f54a52015-01-05 19:16:42 +00002723 if( p->pPrior==0 ) break;
2724 assert( p->pPrior->pNext==p );
2725 p = p->pPrior;
drhfa16f5d2018-05-03 01:37:13 +00002726 nRow += bShowAll;
drh45f54a52015-01-05 19:16:42 +00002727 }while(1);
drhfa16f5d2018-05-03 01:37:13 +00002728 ExplainQueryPlan((pParse, 0, "SCAN %d CONSTANT ROW%s", nRow,
2729 nRow==1 ? "" : "S"));
drh45f54a52015-01-05 19:16:42 +00002730 while( p ){
drhfa16f5d2018-05-03 01:37:13 +00002731 selectInnerLoop(pParse, p, -1, 0, 0, pDest, 1, 1);
2732 if( !bShowAll ) break;
drh45f54a52015-01-05 19:16:42 +00002733 p->nSelectRow = nRow;
2734 p = p->pNext;
2735 }
2736 return rc;
2737}
drhb21e7c72008-06-22 12:37:57 +00002738
drhd3d39e92004-05-20 22:16:29 +00002739/*
drh34055852020-10-19 01:23:48 +00002740** Return true if the SELECT statement which is known to be the recursive
2741** part of a recursive CTE still has its anchor terms attached. If the
2742** anchor terms have already been removed, then return false.
2743*/
2744static int hasAnchor(Select *p){
2745 while( p && (p->selFlags & SF_Recursive)!=0 ){ p = p->pPrior; }
2746 return p!=0;
2747}
2748
2749/*
drh16ee60f2008-06-20 18:13:25 +00002750** This routine is called to process a compound query form from
2751** two or more separate queries using UNION, UNION ALL, EXCEPT, or
2752** INTERSECT
drhc926afb2002-06-20 03:38:26 +00002753**
drhe78e8282003-01-19 03:59:45 +00002754** "p" points to the right-most of the two queries. the query on the
2755** left is p->pPrior. The left query could also be a compound query
2756** in which case this routine will be called recursively.
2757**
2758** The results of the total query are to be written into a destination
2759** of type eDest with parameter iParm.
2760**
2761** Example 1: Consider a three-way compound SQL statement.
2762**
2763** SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
2764**
2765** This statement is parsed up as follows:
2766**
2767** SELECT c FROM t3
2768** |
2769** `-----> SELECT b FROM t2
2770** |
jplyon4b11c6d2004-01-19 04:57:53 +00002771** `------> SELECT a FROM t1
drhe78e8282003-01-19 03:59:45 +00002772**
2773** The arrows in the diagram above represent the Select.pPrior pointer.
2774** So if this routine is called with p equal to the t3 query, then
2775** pPrior will be the t2 query. p->op will be TK_UNION in this case.
2776**
2777** Notice that because of the way SQLite parses compound SELECTs, the
2778** individual selects always group from left to right.
drh82c3d632000-06-06 21:56:07 +00002779*/
danielk197784ac9d02004-05-18 09:58:06 +00002780static int multiSelect(
drhfbc4ee72004-08-29 01:31:05 +00002781 Parse *pParse, /* Parsing context */
2782 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00002783 SelectDest *pDest /* What to do with query results */
danielk197784ac9d02004-05-18 09:58:06 +00002784){
drhfbc4ee72004-08-29 01:31:05 +00002785 int rc = SQLITE_OK; /* Success code from a subroutine */
2786 Select *pPrior; /* Another SELECT immediately to our left */
2787 Vdbe *v; /* Generate code to this VDBE */
drh1013c932008-01-06 00:25:21 +00002788 SelectDest dest; /* Alternative data destination */
danielk1977eca7e012008-07-01 16:05:25 +00002789 Select *pDelete = 0; /* Chain of simple selects to delete */
drh633e6d52008-07-28 19:34:53 +00002790 sqlite3 *db; /* Database connection */
drh82c3d632000-06-06 21:56:07 +00002791
drh7b58dae2003-07-20 01:16:46 +00002792 /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs. Only
drhfbc4ee72004-08-29 01:31:05 +00002793 ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
drh82c3d632000-06-06 21:56:07 +00002794 */
drh701bb3b2008-08-02 03:50:39 +00002795 assert( p && p->pPrior ); /* Calling function guarantees this much */
daneae73fb2014-01-16 18:34:33 +00002796 assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
drhb0968b62019-05-29 18:33:59 +00002797 assert( p->selFlags & SF_Compound );
drh633e6d52008-07-28 19:34:53 +00002798 db = pParse->db;
drhd8bc7082000-06-07 23:51:50 +00002799 pPrior = p->pPrior;
drhbc103772008-08-08 18:06:25 +00002800 dest = *pDest;
drhaae0f742021-03-04 16:03:32 +00002801 assert( pPrior->pOrderBy==0 );
2802 assert( pPrior->pLimit==0 );
drh82c3d632000-06-06 21:56:07 +00002803
danielk19774adee202004-05-08 08:23:19 +00002804 v = sqlite3GetVdbe(pParse);
drh701bb3b2008-08-02 03:50:39 +00002805 assert( v!=0 ); /* The VDBE already created by calling function */
drhd8bc7082000-06-07 23:51:50 +00002806
drh1cc3d752002-03-23 00:31:29 +00002807 /* Create the destination temporary table if necessary
2808 */
danielk19776c8c8ce2008-01-02 16:27:09 +00002809 if( dest.eDest==SRT_EphemTab ){
danielk1977b4964b72004-05-18 01:23:38 +00002810 assert( p->pEList );
drh2b596da2012-07-23 21:43:19 +00002811 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
danielk19776c8c8ce2008-01-02 16:27:09 +00002812 dest.eDest = SRT_Table;
drh1cc3d752002-03-23 00:31:29 +00002813 }
2814
drh45f54a52015-01-05 19:16:42 +00002815 /* Special handling for a compound-select that originates as a VALUES clause.
2816 */
drh772460f2015-04-16 14:13:12 +00002817 if( p->selFlags & SF_MultiValue ){
drh45f54a52015-01-05 19:16:42 +00002818 rc = multiSelectValues(pParse, p, &dest);
drh29cdbad2019-12-07 13:42:47 +00002819 if( rc>=0 ) goto multi_select_end;
2820 rc = SQLITE_OK;
drh45f54a52015-01-05 19:16:42 +00002821 }
2822
drhf6e369a2008-06-24 12:46:30 +00002823 /* Make sure all SELECTs in the statement have the same number of elements
2824 ** in their result sets.
2825 */
2826 assert( p->pEList && pPrior->pEList );
dan923cadb2015-06-23 12:19:55 +00002827 assert( p->pEList->nExpr==pPrior->pEList->nExpr );
drhf6e369a2008-06-24 12:46:30 +00002828
daneede6a52014-01-15 19:42:23 +00002829#ifndef SQLITE_OMIT_CTE
drh34055852020-10-19 01:23:48 +00002830 if( (p->selFlags & SF_Recursive)!=0 && hasAnchor(p) ){
drh781def22014-01-22 13:35:53 +00002831 generateWithRecursiveQuery(pParse, p, &dest);
dan8ce71842014-01-14 20:14:09 +00002832 }else
2833#endif
drhf6e369a2008-06-24 12:46:30 +00002834
drha9671a22008-07-08 23:40:20 +00002835 /* Compound SELECTs that have an ORDER BY clause are handled separately.
2836 */
drhf6e369a2008-06-24 12:46:30 +00002837 if( p->pOrderBy ){
drha9671a22008-07-08 23:40:20 +00002838 return multiSelectOrderBy(pParse, p, pDest);
drh03c39052018-05-02 14:24:34 +00002839 }else{
drhf6e369a2008-06-24 12:46:30 +00002840
drhc631ded2018-05-02 02:22:22 +00002841#ifndef SQLITE_OMIT_EXPLAIN
drh03c39052018-05-02 14:24:34 +00002842 if( pPrior->pPrior==0 ){
drh4d799832018-05-03 19:47:14 +00002843 ExplainQueryPlan((pParse, 1, "COMPOUND QUERY"));
drh03c39052018-05-02 14:24:34 +00002844 ExplainQueryPlan((pParse, 1, "LEFT-MOST SUBQUERY"));
drh03c39052018-05-02 14:24:34 +00002845 }
drhc631ded2018-05-02 02:22:22 +00002846#endif
2847
drh03c39052018-05-02 14:24:34 +00002848 /* Generate code for the left and right SELECT statements.
2849 */
2850 switch( p->op ){
2851 case TK_ALL: {
2852 int addr = 0;
drh252d5822021-04-07 13:20:34 +00002853 int nLimit = 0; /* Initialize to suppress harmless compiler warning */
drh03c39052018-05-02 14:24:34 +00002854 assert( !pPrior->pLimit );
2855 pPrior->iLimit = p->iLimit;
2856 pPrior->iOffset = p->iOffset;
2857 pPrior->pLimit = p->pLimit;
drh93ffb502021-05-18 19:10:10 +00002858 SELECTTRACE(1, pParse, p, ("multiSelect UNION ALL left...\n"));
drh03c39052018-05-02 14:24:34 +00002859 rc = sqlite3Select(pParse, pPrior, &dest);
drhbc7819d2021-03-05 14:08:45 +00002860 pPrior->pLimit = 0;
drh03c39052018-05-02 14:24:34 +00002861 if( rc ){
2862 goto multi_select_end;
drh9f1ef452015-10-06 17:27:18 +00002863 }
drh03c39052018-05-02 14:24:34 +00002864 p->pPrior = 0;
2865 p->iLimit = pPrior->iLimit;
2866 p->iOffset = pPrior->iOffset;
2867 if( p->iLimit ){
2868 addr = sqlite3VdbeAddOp1(v, OP_IfNot, p->iLimit); VdbeCoverage(v);
2869 VdbeComment((v, "Jump ahead if LIMIT reached"));
2870 if( p->iOffset ){
2871 sqlite3VdbeAddOp3(v, OP_OffsetLimit,
2872 p->iLimit, p->iOffset+1, p->iOffset);
2873 }
2874 }
2875 ExplainQueryPlan((pParse, 1, "UNION ALL"));
drh93ffb502021-05-18 19:10:10 +00002876 SELECTTRACE(1, pParse, p, ("multiSelect UNION ALL right...\n"));
drh03c39052018-05-02 14:24:34 +00002877 rc = sqlite3Select(pParse, p, &dest);
2878 testcase( rc!=SQLITE_OK );
2879 pDelete = p->pPrior;
2880 p->pPrior = pPrior;
2881 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
drhbc7819d2021-03-05 14:08:45 +00002882 if( p->pLimit
2883 && sqlite3ExprIsInteger(p->pLimit->pLeft, &nLimit)
drh03c39052018-05-02 14:24:34 +00002884 && nLimit>0 && p->nSelectRow > sqlite3LogEst((u64)nLimit)
2885 ){
2886 p->nSelectRow = sqlite3LogEst((u64)nLimit);
2887 }
2888 if( addr ){
2889 sqlite3VdbeJumpHere(v, addr);
2890 }
2891 break;
drha9671a22008-07-08 23:40:20 +00002892 }
drh03c39052018-05-02 14:24:34 +00002893 case TK_EXCEPT:
2894 case TK_UNION: {
2895 int unionTab; /* Cursor number of the temp table holding result */
2896 u8 op = 0; /* One of the SRT_ operations to apply to self */
2897 int priorOp; /* The SRT_ operation to apply to prior selects */
2898 Expr *pLimit; /* Saved values of p->nLimit */
2899 int addr;
2900 SelectDest uniondest;
2901
2902 testcase( p->op==TK_EXCEPT );
2903 testcase( p->op==TK_UNION );
2904 priorOp = SRT_Union;
2905 if( dest.eDest==priorOp ){
2906 /* We can reuse a temporary table generated by a SELECT to our
2907 ** right.
2908 */
2909 assert( p->pLimit==0 ); /* Not allowed on leftward elements */
2910 unionTab = dest.iSDParm;
2911 }else{
2912 /* We will need to create our own temporary table to hold the
2913 ** intermediate results.
2914 */
2915 unionTab = pParse->nTab++;
2916 assert( p->pOrderBy==0 );
2917 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
2918 assert( p->addrOpenEphm[0] == -1 );
2919 p->addrOpenEphm[0] = addr;
2920 findRightmost(p)->selFlags |= SF_UsesEphemeral;
2921 assert( p->pEList );
2922 }
drh34055852020-10-19 01:23:48 +00002923
drh03c39052018-05-02 14:24:34 +00002924
2925 /* Code the SELECT statements to our left
drhd8bc7082000-06-07 23:51:50 +00002926 */
drh03c39052018-05-02 14:24:34 +00002927 assert( !pPrior->pOrderBy );
2928 sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
drh93ffb502021-05-18 19:10:10 +00002929 SELECTTRACE(1, pParse, p, ("multiSelect EXCEPT/UNION left...\n"));
drh03c39052018-05-02 14:24:34 +00002930 rc = sqlite3Select(pParse, pPrior, &uniondest);
2931 if( rc ){
2932 goto multi_select_end;
2933 }
2934
2935 /* Code the current SELECT statement
drhd8bc7082000-06-07 23:51:50 +00002936 */
drh03c39052018-05-02 14:24:34 +00002937 if( p->op==TK_EXCEPT ){
2938 op = SRT_Except;
2939 }else{
2940 assert( p->op==TK_UNION );
2941 op = SRT_Union;
2942 }
2943 p->pPrior = 0;
2944 pLimit = p->pLimit;
2945 p->pLimit = 0;
2946 uniondest.eDest = op;
2947 ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
drhaae0f742021-03-04 16:03:32 +00002948 sqlite3SelectOpName(p->op)));
drh93ffb502021-05-18 19:10:10 +00002949 SELECTTRACE(1, pParse, p, ("multiSelect EXCEPT/UNION right...\n"));
drh03c39052018-05-02 14:24:34 +00002950 rc = sqlite3Select(pParse, p, &uniondest);
2951 testcase( rc!=SQLITE_OK );
drhb7cbf5c2020-06-15 13:51:34 +00002952 assert( p->pOrderBy==0 );
drh03c39052018-05-02 14:24:34 +00002953 pDelete = p->pPrior;
2954 p->pPrior = pPrior;
2955 p->pOrderBy = 0;
2956 if( p->op==TK_UNION ){
2957 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
2958 }
2959 sqlite3ExprDelete(db, p->pLimit);
2960 p->pLimit = pLimit;
2961 p->iLimit = 0;
2962 p->iOffset = 0;
2963
2964 /* Convert the data in the temporary table into whatever form
2965 ** it is that we currently need.
2966 */
2967 assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
drha9ebfe22019-12-25 23:54:21 +00002968 assert( p->pEList || db->mallocFailed );
2969 if( dest.eDest!=priorOp && db->mallocFailed==0 ){
drh03c39052018-05-02 14:24:34 +00002970 int iCont, iBreak, iStart;
drhec4ccdb2018-12-29 02:26:59 +00002971 iBreak = sqlite3VdbeMakeLabel(pParse);
2972 iCont = sqlite3VdbeMakeLabel(pParse);
drh03c39052018-05-02 14:24:34 +00002973 computeLimitRegisters(pParse, p, iBreak);
2974 sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
2975 iStart = sqlite3VdbeCurrentAddr(v);
2976 selectInnerLoop(pParse, p, unionTab,
2977 0, 0, &dest, iCont, iBreak);
2978 sqlite3VdbeResolveLabel(v, iCont);
2979 sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
2980 sqlite3VdbeResolveLabel(v, iBreak);
2981 sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
2982 }
2983 break;
2984 }
2985 default: assert( p->op==TK_INTERSECT ); {
2986 int tab1, tab2;
2987 int iCont, iBreak, iStart;
2988 Expr *pLimit;
2989 int addr;
2990 SelectDest intersectdest;
2991 int r1;
2992
2993 /* INTERSECT is different from the others since it requires
2994 ** two temporary tables. Hence it has its own case. Begin
2995 ** by allocating the tables we will need.
2996 */
2997 tab1 = pParse->nTab++;
2998 tab2 = pParse->nTab++;
drh93a960a2008-07-10 00:32:42 +00002999 assert( p->pOrderBy==0 );
drh03c39052018-05-02 14:24:34 +00003000
3001 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
drh93a960a2008-07-10 00:32:42 +00003002 assert( p->addrOpenEphm[0] == -1 );
3003 p->addrOpenEphm[0] = addr;
drhd227a292014-02-09 18:02:09 +00003004 findRightmost(p)->selFlags |= SF_UsesEphemeral;
danielk197784ac9d02004-05-18 09:58:06 +00003005 assert( p->pEList );
drh03c39052018-05-02 14:24:34 +00003006
3007 /* Code the SELECTs to our left into temporary table "tab1".
3008 */
3009 sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
drh93ffb502021-05-18 19:10:10 +00003010 SELECTTRACE(1, pParse, p, ("multiSelect INTERSECT left...\n"));
drh03c39052018-05-02 14:24:34 +00003011 rc = sqlite3Select(pParse, pPrior, &intersectdest);
3012 if( rc ){
3013 goto multi_select_end;
3014 }
3015
3016 /* Code the current SELECT into temporary table "tab2"
3017 */
3018 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
3019 assert( p->addrOpenEphm[1] == -1 );
3020 p->addrOpenEphm[1] = addr;
3021 p->pPrior = 0;
3022 pLimit = p->pLimit;
3023 p->pLimit = 0;
3024 intersectdest.iSDParm = tab2;
3025 ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
drhaae0f742021-03-04 16:03:32 +00003026 sqlite3SelectOpName(p->op)));
drh93ffb502021-05-18 19:10:10 +00003027 SELECTTRACE(1, pParse, p, ("multiSelect INTERSECT right...\n"));
drh03c39052018-05-02 14:24:34 +00003028 rc = sqlite3Select(pParse, p, &intersectdest);
3029 testcase( rc!=SQLITE_OK );
3030 pDelete = p->pPrior;
3031 p->pPrior = pPrior;
3032 if( p->nSelectRow>pPrior->nSelectRow ){
3033 p->nSelectRow = pPrior->nSelectRow;
3034 }
3035 sqlite3ExprDelete(db, p->pLimit);
3036 p->pLimit = pLimit;
3037
3038 /* Generate code to take the intersection of the two temporary
3039 ** tables.
3040 */
drh5f695122020-02-20 14:08:51 +00003041 if( rc ) break;
drh82c3d632000-06-06 21:56:07 +00003042 assert( p->pEList );
drhec4ccdb2018-12-29 02:26:59 +00003043 iBreak = sqlite3VdbeMakeLabel(pParse);
3044 iCont = sqlite3VdbeMakeLabel(pParse);
drhec7429a2005-10-06 16:53:14 +00003045 computeLimitRegisters(pParse, p, iBreak);
drh03c39052018-05-02 14:24:34 +00003046 sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
3047 r1 = sqlite3GetTempReg(pParse);
3048 iStart = sqlite3VdbeAddOp2(v, OP_RowData, tab1, r1);
3049 sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0);
3050 VdbeCoverage(v);
3051 sqlite3ReleaseTempReg(pParse, r1);
3052 selectInnerLoop(pParse, p, tab1,
drhe8e4af72012-09-21 00:04:28 +00003053 0, 0, &dest, iCont, iBreak);
danielk19774adee202004-05-08 08:23:19 +00003054 sqlite3VdbeResolveLabel(v, iCont);
drh03c39052018-05-02 14:24:34 +00003055 sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
danielk19774adee202004-05-08 08:23:19 +00003056 sqlite3VdbeResolveLabel(v, iBreak);
drh03c39052018-05-02 14:24:34 +00003057 sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
3058 sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
3059 break;
drh82c3d632000-06-06 21:56:07 +00003060 }
drh82c3d632000-06-06 21:56:07 +00003061 }
drh03c39052018-05-02 14:24:34 +00003062
3063 #ifndef SQLITE_OMIT_EXPLAIN
3064 if( p->pNext==0 ){
3065 ExplainQueryPlanPop(pParse);
drh82c3d632000-06-06 21:56:07 +00003066 }
drh03c39052018-05-02 14:24:34 +00003067 #endif
drh82c3d632000-06-06 21:56:07 +00003068 }
drh8428b3b2019-12-19 22:08:19 +00003069 if( pParse->nErr ) goto multi_select_end;
drh03c39052018-05-02 14:24:34 +00003070
drha9671a22008-07-08 23:40:20 +00003071 /* Compute collating sequences used by
3072 ** temporary tables needed to implement the compound select.
3073 ** Attach the KeyInfo structure to all temporary tables.
drh8cdbf832004-08-29 16:25:03 +00003074 **
3075 ** This section is run by the right-most SELECT statement only.
3076 ** SELECT statements to the left always skip this part. The right-most
3077 ** SELECT might also skip this part if it has no ORDER BY clause and
3078 ** no temp tables are required.
drhfbc4ee72004-08-29 01:31:05 +00003079 */
drh7d10d5a2008-08-20 16:35:10 +00003080 if( p->selFlags & SF_UsesEphemeral ){
drhfbc4ee72004-08-29 01:31:05 +00003081 int i; /* Loop counter */
3082 KeyInfo *pKeyInfo; /* Collating sequence for the result set */
drh0342b1f2005-09-01 03:07:44 +00003083 Select *pLoop; /* For looping through SELECT statements */
drhf68d7d12007-05-03 13:02:26 +00003084 CollSeq **apColl; /* For looping through pKeyInfo->aColl[] */
drh93a960a2008-07-10 00:32:42 +00003085 int nCol; /* Number of columns in result set */
drhfbc4ee72004-08-29 01:31:05 +00003086
drhd227a292014-02-09 18:02:09 +00003087 assert( p->pNext==0 );
drhaa6fe5b2021-10-04 13:18:44 +00003088 assert( p->pEList!=0 );
drh93a960a2008-07-10 00:32:42 +00003089 nCol = p->pEList->nExpr;
drhad124322013-10-23 13:30:58 +00003090 pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
danielk1977dc1bdc42004-06-11 10:51:27 +00003091 if( !pKeyInfo ){
mistachkinfad30392016-02-13 23:43:46 +00003092 rc = SQLITE_NOMEM_BKPT;
danielk1977dc1bdc42004-06-11 10:51:27 +00003093 goto multi_select_end;
3094 }
drh0342b1f2005-09-01 03:07:44 +00003095 for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
3096 *apColl = multiSelectCollSeq(pParse, p, i);
3097 if( 0==*apColl ){
drh633e6d52008-07-28 19:34:53 +00003098 *apColl = db->pDfltColl;
danielk1977dc1bdc42004-06-11 10:51:27 +00003099 }
3100 }
3101
drh0342b1f2005-09-01 03:07:44 +00003102 for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
3103 for(i=0; i<2; i++){
drhb9bb7c12006-06-11 23:41:55 +00003104 int addr = pLoop->addrOpenEphm[i];
drh0342b1f2005-09-01 03:07:44 +00003105 if( addr<0 ){
3106 /* If [0] is unused then [1] is also unused. So we can
3107 ** always safely abort as soon as the first unused slot is found */
drhb9bb7c12006-06-11 23:41:55 +00003108 assert( pLoop->addrOpenEphm[1]<0 );
drh0342b1f2005-09-01 03:07:44 +00003109 break;
3110 }
3111 sqlite3VdbeChangeP2(v, addr, nCol);
drh2ec2fb22013-11-06 19:59:23 +00003112 sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
3113 P4_KEYINFO);
drh0ee5a1e2007-01-26 19:04:00 +00003114 pLoop->addrOpenEphm[i] = -1;
drh0342b1f2005-09-01 03:07:44 +00003115 }
danielk1977dc1bdc42004-06-11 10:51:27 +00003116 }
drh2ec2fb22013-11-06 19:59:23 +00003117 sqlite3KeyInfoUnref(pKeyInfo);
danielk197784ac9d02004-05-18 09:58:06 +00003118 }
danielk1977dc1bdc42004-06-11 10:51:27 +00003119
3120multi_select_end:
drh2b596da2012-07-23 21:43:19 +00003121 pDest->iSdst = dest.iSdst;
3122 pDest->nSdst = dest.nSdst;
drhce68b6b2021-08-21 16:42:58 +00003123 if( pDelete ){
3124 sqlite3ParserAddCleanup(pParse,
3125 (void(*)(sqlite3*,void*))sqlite3SelectDelete,
3126 pDelete);
3127 }
danielk197784ac9d02004-05-18 09:58:06 +00003128 return rc;
drh22827922000-06-06 17:27:05 +00003129}
drhb7f91642004-10-31 02:22:47 +00003130#endif /* SQLITE_OMIT_COMPOUND_SELECT */
drh22827922000-06-06 17:27:05 +00003131
drhb21e7c72008-06-22 12:37:57 +00003132/*
mistachkin89b31d72015-07-16 17:29:27 +00003133** Error message for when two or more terms of a compound select have different
3134** size result sets.
3135*/
3136void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p){
3137 if( p->selFlags & SF_Values ){
3138 sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
3139 }else{
3140 sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
drhaae0f742021-03-04 16:03:32 +00003141 " do not have the same number of result columns",
3142 sqlite3SelectOpName(p->op));
mistachkin89b31d72015-07-16 17:29:27 +00003143 }
3144}
3145
3146/*
drhb21e7c72008-06-22 12:37:57 +00003147** Code an output subroutine for a coroutine implementation of a
3148** SELECT statment.
drh0acb7e42008-06-25 00:12:41 +00003149**
drh2b596da2012-07-23 21:43:19 +00003150** The data to be output is contained in pIn->iSdst. There are
3151** pIn->nSdst columns to be output. pDest is where the output should
drh0acb7e42008-06-25 00:12:41 +00003152** be sent.
3153**
3154** regReturn is the number of the register holding the subroutine
3155** return address.
3156**
drhf053d5b2010-08-09 14:26:32 +00003157** If regPrev>0 then it is the first register in a vector that
drh0acb7e42008-06-25 00:12:41 +00003158** records the previous output. mem[regPrev] is a flag that is false
3159** if there has been no previous output. If regPrev>0 then code is
3160** generated to suppress duplicates. pKeyInfo is used for comparing
3161** keys.
3162**
3163** If the LIMIT found in p->iLimit is reached, jump immediately to
3164** iBreak.
drhb21e7c72008-06-22 12:37:57 +00003165*/
drh0acb7e42008-06-25 00:12:41 +00003166static int generateOutputSubroutine(
drh92b01d52008-06-24 00:32:35 +00003167 Parse *pParse, /* Parsing context */
3168 Select *p, /* The SELECT statement */
3169 SelectDest *pIn, /* Coroutine supplying data */
3170 SelectDest *pDest, /* Where to send the data */
3171 int regReturn, /* The return address register */
drh0acb7e42008-06-25 00:12:41 +00003172 int regPrev, /* Previous result register. No uniqueness if 0 */
3173 KeyInfo *pKeyInfo, /* For comparing with previous entry */
drh92b01d52008-06-24 00:32:35 +00003174 int iBreak /* Jump here if we hit the LIMIT */
drhb21e7c72008-06-22 12:37:57 +00003175){
3176 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003177 int iContinue;
3178 int addr;
drhb21e7c72008-06-22 12:37:57 +00003179
drh92b01d52008-06-24 00:32:35 +00003180 addr = sqlite3VdbeCurrentAddr(v);
drhec4ccdb2018-12-29 02:26:59 +00003181 iContinue = sqlite3VdbeMakeLabel(pParse);
drh0acb7e42008-06-25 00:12:41 +00003182
3183 /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
3184 */
3185 if( regPrev ){
drh728e0f92015-10-10 14:41:28 +00003186 int addr1, addr2;
3187 addr1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
3188 addr2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
drh2ec2fb22013-11-06 19:59:23 +00003189 (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
drh728e0f92015-10-10 14:41:28 +00003190 sqlite3VdbeAddOp3(v, OP_Jump, addr2+2, iContinue, addr2+2); VdbeCoverage(v);
3191 sqlite3VdbeJumpHere(v, addr1);
drhe8e4af72012-09-21 00:04:28 +00003192 sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
drhec86c722011-12-09 17:27:51 +00003193 sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
drh0acb7e42008-06-25 00:12:41 +00003194 }
danielk19771f9caa42008-07-02 16:10:45 +00003195 if( pParse->db->mallocFailed ) return 0;
drh0acb7e42008-06-25 00:12:41 +00003196
mistachkind5578432012-08-25 10:01:29 +00003197 /* Suppress the first OFFSET entries if there is an OFFSET clause
drh0acb7e42008-06-25 00:12:41 +00003198 */
drhaa9ce702014-01-22 18:07:04 +00003199 codeOffset(v, p->iOffset, iContinue);
drhb21e7c72008-06-22 12:37:57 +00003200
drhe2248cf2015-05-22 17:29:27 +00003201 assert( pDest->eDest!=SRT_Exists );
3202 assert( pDest->eDest!=SRT_Table );
drhb21e7c72008-06-22 12:37:57 +00003203 switch( pDest->eDest ){
3204 /* Store the result as data using a unique key.
3205 */
drhb21e7c72008-06-22 12:37:57 +00003206 case SRT_EphemTab: {
3207 int r1 = sqlite3GetTempReg(pParse);
3208 int r2 = sqlite3GetTempReg(pParse);
drh2b596da2012-07-23 21:43:19 +00003209 sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
3210 sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
3211 sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
drhb21e7c72008-06-22 12:37:57 +00003212 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
3213 sqlite3ReleaseTempReg(pParse, r2);
3214 sqlite3ReleaseTempReg(pParse, r1);
3215 break;
3216 }
3217
3218#ifndef SQLITE_OMIT_SUBQUERY
drh14318072016-09-06 18:51:25 +00003219 /* If we are creating a set for an "expr IN (SELECT ...)".
drhb21e7c72008-06-22 12:37:57 +00003220 */
3221 case SRT_Set: {
drh6fccc352008-06-27 00:52:45 +00003222 int r1;
drh63cecc42016-09-06 19:08:21 +00003223 testcase( pIn->nSdst>1 );
drhb21e7c72008-06-22 12:37:57 +00003224 r1 = sqlite3GetTempReg(pParse);
dan71c57db2016-07-09 20:23:55 +00003225 sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst,
drh14318072016-09-06 18:51:25 +00003226 r1, pDest->zAffSdst, pIn->nSdst);
drh9b4eaeb2016-11-09 00:10:33 +00003227 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pDest->iSDParm, r1,
3228 pIn->iSdst, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003229 sqlite3ReleaseTempReg(pParse, r1);
drhb21e7c72008-06-22 12:37:57 +00003230 break;
3231 }
3232
drhb21e7c72008-06-22 12:37:57 +00003233 /* If this is a scalar select that is part of an expression, then
3234 ** store the results in the appropriate memory cell and break out
drhcb99c572019-08-09 20:26:01 +00003235 ** of the scan loop. Note that the select might return multiple columns
3236 ** if it is the RHS of a row-value IN operator.
drhb21e7c72008-06-22 12:37:57 +00003237 */
3238 case SRT_Mem: {
drh5f0922b2021-03-04 16:32:28 +00003239 testcase( pIn->nSdst>1 );
3240 sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003241 /* The LIMIT clause will jump out of the loop for us */
3242 break;
3243 }
3244#endif /* #ifndef SQLITE_OMIT_SUBQUERY */
3245
drh7d10d5a2008-08-20 16:35:10 +00003246 /* The results are stored in a sequence of registers
drh2b596da2012-07-23 21:43:19 +00003247 ** starting at pDest->iSdst. Then the co-routine yields.
drhb21e7c72008-06-22 12:37:57 +00003248 */
drh92b01d52008-06-24 00:32:35 +00003249 case SRT_Coroutine: {
drh2b596da2012-07-23 21:43:19 +00003250 if( pDest->iSdst==0 ){
3251 pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
3252 pDest->nSdst = pIn->nSdst;
drhb21e7c72008-06-22 12:37:57 +00003253 }
dan4b79bde2015-04-21 15:49:04 +00003254 sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pIn->nSdst);
drh2b596da2012-07-23 21:43:19 +00003255 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drh92b01d52008-06-24 00:32:35 +00003256 break;
3257 }
3258
drhccfcbce2009-05-18 15:46:07 +00003259 /* If none of the above, then the result destination must be
3260 ** SRT_Output. This routine is never called with any other
3261 ** destination other than the ones handled above or SRT_Output.
3262 **
3263 ** For SRT_Output, results are stored in a sequence of registers.
3264 ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
3265 ** return the next row of result.
drh7d10d5a2008-08-20 16:35:10 +00003266 */
drhccfcbce2009-05-18 15:46:07 +00003267 default: {
3268 assert( pDest->eDest==SRT_Output );
drh2b596da2012-07-23 21:43:19 +00003269 sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003270 break;
3271 }
drhb21e7c72008-06-22 12:37:57 +00003272 }
drh92b01d52008-06-24 00:32:35 +00003273
3274 /* Jump to the end of the loop if the LIMIT is reached.
3275 */
3276 if( p->iLimit ){
drh16897072015-03-07 00:57:37 +00003277 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003278 }
3279
drh92b01d52008-06-24 00:32:35 +00003280 /* Generate the subroutine return
3281 */
drh0acb7e42008-06-25 00:12:41 +00003282 sqlite3VdbeResolveLabel(v, iContinue);
drh92b01d52008-06-24 00:32:35 +00003283 sqlite3VdbeAddOp1(v, OP_Return, regReturn);
3284
3285 return addr;
drhb21e7c72008-06-22 12:37:57 +00003286}
3287
3288/*
3289** Alternative compound select code generator for cases when there
3290** is an ORDER BY clause.
3291**
3292** We assume a query of the following form:
3293**
3294** <selectA> <operator> <selectB> ORDER BY <orderbylist>
3295**
3296** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT. The idea
3297** is to code both <selectA> and <selectB> with the ORDER BY clause as
3298** co-routines. Then run the co-routines in parallel and merge the results
3299** into the output. In addition to the two coroutines (called selectA and
3300** selectB) there are 7 subroutines:
3301**
3302** outA: Move the output of the selectA coroutine into the output
3303** of the compound query.
3304**
3305** outB: Move the output of the selectB coroutine into the output
3306** of the compound query. (Only generated for UNION and
3307** UNION ALL. EXCEPT and INSERTSECT never output a row that
3308** appears only in B.)
3309**
3310** AltB: Called when there is data from both coroutines and A<B.
3311**
3312** AeqB: Called when there is data from both coroutines and A==B.
3313**
3314** AgtB: Called when there is data from both coroutines and A>B.
3315**
3316** EofA: Called when data is exhausted from selectA.
3317**
3318** EofB: Called when data is exhausted from selectB.
3319**
3320** The implementation of the latter five subroutines depend on which
3321** <operator> is used:
3322**
3323**
3324** UNION ALL UNION EXCEPT INTERSECT
3325** ------------- ----------------- -------------- -----------------
drh0acb7e42008-06-25 00:12:41 +00003326** AltB: outA, nextA outA, nextA outA, nextA nextA
drhb21e7c72008-06-22 12:37:57 +00003327**
drh0acb7e42008-06-25 00:12:41 +00003328** AeqB: outA, nextA nextA nextA outA, nextA
drhb21e7c72008-06-22 12:37:57 +00003329**
drh0acb7e42008-06-25 00:12:41 +00003330** AgtB: outB, nextB outB, nextB nextB nextB
drhb21e7c72008-06-22 12:37:57 +00003331**
drh0acb7e42008-06-25 00:12:41 +00003332** EofA: outB, nextB outB, nextB halt halt
drhb21e7c72008-06-22 12:37:57 +00003333**
drh0acb7e42008-06-25 00:12:41 +00003334** EofB: outA, nextA outA, nextA outA, nextA halt
3335**
3336** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
3337** causes an immediate jump to EofA and an EOF on B following nextB causes
3338** an immediate jump to EofB. Within EofA and EofB, and EOF on entry or
3339** following nextX causes a jump to the end of the select processing.
3340**
3341** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
3342** within the output subroutine. The regPrev register set holds the previously
3343** output value. A comparison is made against this value and the output
3344** is skipped if the next results would be the same as the previous.
drhb21e7c72008-06-22 12:37:57 +00003345**
3346** The implementation plan is to implement the two coroutines and seven
3347** subroutines first, then put the control logic at the bottom. Like this:
3348**
3349** goto Init
3350** coA: coroutine for left query (A)
3351** coB: coroutine for right query (B)
3352** outA: output one row of A
3353** outB: output one row of B (UNION and UNION ALL only)
3354** EofA: ...
3355** EofB: ...
3356** AltB: ...
3357** AeqB: ...
3358** AgtB: ...
3359** Init: initialize coroutine registers
3360** yield coA
3361** if eof(A) goto EofA
3362** yield coB
3363** if eof(B) goto EofB
3364** Cmpr: Compare A, B
3365** Jump AltB, AeqB, AgtB
3366** End: ...
3367**
3368** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
3369** actually called using Gosub and they do not Return. EofA and EofB loop
3370** until all data is exhausted then jump to the "end" labe. AltB, AeqB,
3371** and AgtB jump to either L2 or to one of EofA or EofB.
3372*/
danielk1977de3e41e2008-08-04 03:51:24 +00003373#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhb21e7c72008-06-22 12:37:57 +00003374static int multiSelectOrderBy(
3375 Parse *pParse, /* Parsing context */
3376 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00003377 SelectDest *pDest /* What to do with query results */
drhb21e7c72008-06-22 12:37:57 +00003378){
drh0acb7e42008-06-25 00:12:41 +00003379 int i, j; /* Loop counters */
drhb21e7c72008-06-22 12:37:57 +00003380 Select *pPrior; /* Another SELECT immediately to our left */
drh38cebe02021-12-30 00:37:11 +00003381 Select *pSplit; /* Left-most SELECT in the right-hand group */
3382 int nSelect; /* Number of SELECT statements in the compound */
drhb21e7c72008-06-22 12:37:57 +00003383 Vdbe *v; /* Generate code to this VDBE */
drhb21e7c72008-06-22 12:37:57 +00003384 SelectDest destA; /* Destination for coroutine A */
3385 SelectDest destB; /* Destination for coroutine B */
drh92b01d52008-06-24 00:32:35 +00003386 int regAddrA; /* Address register for select-A coroutine */
drh92b01d52008-06-24 00:32:35 +00003387 int regAddrB; /* Address register for select-B coroutine */
drh92b01d52008-06-24 00:32:35 +00003388 int addrSelectA; /* Address of the select-A coroutine */
3389 int addrSelectB; /* Address of the select-B coroutine */
3390 int regOutA; /* Address register for the output-A subroutine */
3391 int regOutB; /* Address register for the output-B subroutine */
3392 int addrOutA; /* Address of the output-A subroutine */
drhb27b7f52008-12-10 18:03:45 +00003393 int addrOutB = 0; /* Address of the output-B subroutine */
drh92b01d52008-06-24 00:32:35 +00003394 int addrEofA; /* Address of the select-A-exhausted subroutine */
drh81cf13e2014-02-07 18:27:53 +00003395 int addrEofA_noB; /* Alternate addrEofA if B is uninitialized */
drh92b01d52008-06-24 00:32:35 +00003396 int addrEofB; /* Address of the select-B-exhausted subroutine */
3397 int addrAltB; /* Address of the A<B subroutine */
3398 int addrAeqB; /* Address of the A==B subroutine */
3399 int addrAgtB; /* Address of the A>B subroutine */
3400 int regLimitA; /* Limit register for select-A */
3401 int regLimitB; /* Limit register for select-A */
drh0acb7e42008-06-25 00:12:41 +00003402 int regPrev; /* A range of registers to hold previous output */
drh92b01d52008-06-24 00:32:35 +00003403 int savedLimit; /* Saved value of p->iLimit */
3404 int savedOffset; /* Saved value of p->iOffset */
3405 int labelCmpr; /* Label for the start of the merge algorithm */
3406 int labelEnd; /* Label for the end of the overall SELECT stmt */
drh728e0f92015-10-10 14:41:28 +00003407 int addr1; /* Jump instructions that get retargetted */
drh92b01d52008-06-24 00:32:35 +00003408 int op; /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
drh96067812008-09-23 09:36:10 +00003409 KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
drh0acb7e42008-06-25 00:12:41 +00003410 KeyInfo *pKeyMerge; /* Comparison information for merging rows */
3411 sqlite3 *db; /* Database connection */
3412 ExprList *pOrderBy; /* The ORDER BY clause */
3413 int nOrderBy; /* Number of terms in the ORDER BY clause */
drhabc38152020-07-22 13:38:04 +00003414 u32 *aPermute; /* Mapping from ORDER BY terms to result set columns */
drhb21e7c72008-06-22 12:37:57 +00003415
drh92b01d52008-06-24 00:32:35 +00003416 assert( p->pOrderBy!=0 );
drh96067812008-09-23 09:36:10 +00003417 assert( pKeyDup==0 ); /* "Managed" code needs this. Ticket #3382. */
drh0acb7e42008-06-25 00:12:41 +00003418 db = pParse->db;
drh92b01d52008-06-24 00:32:35 +00003419 v = pParse->pVdbe;
drhccfcbce2009-05-18 15:46:07 +00003420 assert( v!=0 ); /* Already thrown the error if VDBE alloc failed */
drhec4ccdb2018-12-29 02:26:59 +00003421 labelEnd = sqlite3VdbeMakeLabel(pParse);
3422 labelCmpr = sqlite3VdbeMakeLabel(pParse);
drh0acb7e42008-06-25 00:12:41 +00003423
drh92b01d52008-06-24 00:32:35 +00003424
3425 /* Patch up the ORDER BY clause
3426 */
3427 op = p->op;
drh38cebe02021-12-30 00:37:11 +00003428 assert( p->pPrior->pOrderBy==0 );
drh0acb7e42008-06-25 00:12:41 +00003429 pOrderBy = p->pOrderBy;
drh93a960a2008-07-10 00:32:42 +00003430 assert( pOrderBy );
drh93a960a2008-07-10 00:32:42 +00003431 nOrderBy = pOrderBy->nExpr;
3432
drh0acb7e42008-06-25 00:12:41 +00003433 /* For operators other than UNION ALL we have to make sure that
3434 ** the ORDER BY clause covers every term of the result set. Add
3435 ** terms to the ORDER BY clause as necessary.
3436 */
3437 if( op!=TK_ALL ){
3438 for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
drh7d10d5a2008-08-20 16:35:10 +00003439 struct ExprList_item *pItem;
3440 for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
drh7d4c94b2021-10-04 22:34:38 +00003441 assert( pItem!=0 );
drhc2acc4e2013-11-15 18:15:19 +00003442 assert( pItem->u.x.iOrderByCol>0 );
3443 if( pItem->u.x.iOrderByCol==i ) break;
drh0acb7e42008-06-25 00:12:41 +00003444 }
3445 if( j==nOrderBy ){
drhb7916a72009-05-27 10:31:29 +00003446 Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
mistachkinfad30392016-02-13 23:43:46 +00003447 if( pNew==0 ) return SQLITE_NOMEM_BKPT;
drh0acb7e42008-06-25 00:12:41 +00003448 pNew->flags |= EP_IntValue;
drh33e619f2009-05-28 01:00:55 +00003449 pNew->u.iValue = i;
drh43606172017-04-05 11:32:13 +00003450 p->pOrderBy = pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
drhc2acc4e2013-11-15 18:15:19 +00003451 if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
drh0acb7e42008-06-25 00:12:41 +00003452 }
3453 }
3454 }
3455
3456 /* Compute the comparison permutation and keyinfo that is used with
drh10c081a2009-04-16 00:24:23 +00003457 ** the permutation used to determine if the next
drh0acb7e42008-06-25 00:12:41 +00003458 ** row of results comes from selectA or selectB. Also add explicit
3459 ** collations to the ORDER BY clause terms so that when the subqueries
3460 ** to the right and the left are evaluated, they use the correct
3461 ** collation.
3462 */
drhabc38152020-07-22 13:38:04 +00003463 aPermute = sqlite3DbMallocRawNN(db, sizeof(u32)*(nOrderBy + 1));
drh0acb7e42008-06-25 00:12:41 +00003464 if( aPermute ){
drh7d10d5a2008-08-20 16:35:10 +00003465 struct ExprList_item *pItem;
drhb1702022016-01-30 00:45:18 +00003466 aPermute[0] = nOrderBy;
3467 for(i=1, pItem=pOrderBy->a; i<=nOrderBy; i++, pItem++){
drh7d4c94b2021-10-04 22:34:38 +00003468 assert( pItem!=0 );
drh67366182015-04-16 14:33:35 +00003469 assert( pItem->u.x.iOrderByCol>0 );
drh2ec18a32015-06-23 23:31:52 +00003470 assert( pItem->u.x.iOrderByCol<=p->pEList->nExpr );
drhc2acc4e2013-11-15 18:15:19 +00003471 aPermute[i] = pItem->u.x.iOrderByCol - 1;
drh0acb7e42008-06-25 00:12:41 +00003472 }
dan53bed452014-01-24 20:37:18 +00003473 pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
drh0acb7e42008-06-25 00:12:41 +00003474 }else{
3475 pKeyMerge = 0;
3476 }
3477
drh0acb7e42008-06-25 00:12:41 +00003478 /* Allocate a range of temporary registers and the KeyInfo needed
3479 ** for the logic that removes duplicate result rows when the
3480 ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
3481 */
3482 if( op==TK_ALL ){
3483 regPrev = 0;
3484 }else{
3485 int nExpr = p->pEList->nExpr;
drh1c0dc822008-10-30 22:13:23 +00003486 assert( nOrderBy>=nExpr || db->mallocFailed );
drhc8ac0d12013-02-16 02:41:01 +00003487 regPrev = pParse->nMem+1;
3488 pParse->nMem += nExpr+1;
drh0acb7e42008-06-25 00:12:41 +00003489 sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
drhad124322013-10-23 13:30:58 +00003490 pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
drh0acb7e42008-06-25 00:12:41 +00003491 if( pKeyDup ){
drh2ec2fb22013-11-06 19:59:23 +00003492 assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
drh0acb7e42008-06-25 00:12:41 +00003493 for(i=0; i<nExpr; i++){
3494 pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
dan6e118922019-08-12 16:36:38 +00003495 pKeyDup->aSortFlags[i] = 0;
drh0acb7e42008-06-25 00:12:41 +00003496 }
3497 }
3498 }
drh92b01d52008-06-24 00:32:35 +00003499
3500 /* Separate the left and the right query from one another
3501 */
drh38cebe02021-12-30 00:37:11 +00003502 nSelect = 1;
3503 if( (op==TK_ALL || op==TK_UNION)
3504 && OptimizationEnabled(db, SQLITE_BalancedMerge)
3505 ){
3506 for(pSplit=p; pSplit->pPrior!=0 && pSplit->op==op; pSplit=pSplit->pPrior){
3507 nSelect++;
3508 assert( pSplit->pPrior->pNext==pSplit );
3509 }
3510 }
3511 if( nSelect<=3 ){
3512 pSplit = p;
3513 }else{
3514 pSplit = p;
3515 for(i=2; i<nSelect; i+=2){ pSplit = pSplit->pPrior; }
3516 }
3517 pPrior = pSplit->pPrior;
drh98bb34c2022-01-20 12:58:15 +00003518 assert( pPrior!=0 );
drh38cebe02021-12-30 00:37:11 +00003519 pSplit->pPrior = 0;
drhd227a292014-02-09 18:02:09 +00003520 pPrior->pNext = 0;
drh38cebe02021-12-30 00:37:11 +00003521 assert( p->pOrderBy == pOrderBy );
3522 assert( pOrderBy!=0 || db->mallocFailed );
3523 pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
drh9aff8242021-12-30 17:46:15 +00003524 sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
3525 sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
drh0acb7e42008-06-25 00:12:41 +00003526
drh92b01d52008-06-24 00:32:35 +00003527 /* Compute the limit registers */
3528 computeLimitRegisters(pParse, p, labelEnd);
drh0acb7e42008-06-25 00:12:41 +00003529 if( p->iLimit && op==TK_ALL ){
drh92b01d52008-06-24 00:32:35 +00003530 regLimitA = ++pParse->nMem;
3531 regLimitB = ++pParse->nMem;
3532 sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
3533 regLimitA);
3534 sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
3535 }else{
3536 regLimitA = regLimitB = 0;
3537 }
drh633e6d52008-07-28 19:34:53 +00003538 sqlite3ExprDelete(db, p->pLimit);
drh0acb7e42008-06-25 00:12:41 +00003539 p->pLimit = 0;
drh92b01d52008-06-24 00:32:35 +00003540
drhb21e7c72008-06-22 12:37:57 +00003541 regAddrA = ++pParse->nMem;
drhb21e7c72008-06-22 12:37:57 +00003542 regAddrB = ++pParse->nMem;
drhb21e7c72008-06-22 12:37:57 +00003543 regOutA = ++pParse->nMem;
3544 regOutB = ++pParse->nMem;
3545 sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
3546 sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
drhe2ca99c2018-05-02 00:33:43 +00003547
drhaae0f742021-03-04 16:03:32 +00003548 ExplainQueryPlan((pParse, 1, "MERGE (%s)", sqlite3SelectOpName(p->op)));
drhb21e7c72008-06-22 12:37:57 +00003549
drh92b01d52008-06-24 00:32:35 +00003550 /* Generate a coroutine to evaluate the SELECT statement to the
drh0acb7e42008-06-25 00:12:41 +00003551 ** left of the compound operator - the "A" select.
3552 */
drhed71a832014-02-07 19:18:10 +00003553 addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
drh728e0f92015-10-10 14:41:28 +00003554 addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
drhed71a832014-02-07 19:18:10 +00003555 VdbeComment((v, "left SELECT"));
drh92b01d52008-06-24 00:32:35 +00003556 pPrior->iLimit = regLimitA;
drhc631ded2018-05-02 02:22:22 +00003557 ExplainQueryPlan((pParse, 1, "LEFT"));
drh7d10d5a2008-08-20 16:35:10 +00003558 sqlite3Select(pParse, pPrior, &destA);
drh2fade2f2016-02-09 02:12:20 +00003559 sqlite3VdbeEndCoroutine(v, regAddrA);
drh728e0f92015-10-10 14:41:28 +00003560 sqlite3VdbeJumpHere(v, addr1);
drhb21e7c72008-06-22 12:37:57 +00003561
drh92b01d52008-06-24 00:32:35 +00003562 /* Generate a coroutine to evaluate the SELECT statement on
3563 ** the right - the "B" select
3564 */
drhed71a832014-02-07 19:18:10 +00003565 addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
drh728e0f92015-10-10 14:41:28 +00003566 addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
drhed71a832014-02-07 19:18:10 +00003567 VdbeComment((v, "right SELECT"));
drh92b01d52008-06-24 00:32:35 +00003568 savedLimit = p->iLimit;
3569 savedOffset = p->iOffset;
3570 p->iLimit = regLimitB;
3571 p->iOffset = 0;
drhc631ded2018-05-02 02:22:22 +00003572 ExplainQueryPlan((pParse, 1, "RIGHT"));
drh7d10d5a2008-08-20 16:35:10 +00003573 sqlite3Select(pParse, p, &destB);
drh92b01d52008-06-24 00:32:35 +00003574 p->iLimit = savedLimit;
3575 p->iOffset = savedOffset;
drh2fade2f2016-02-09 02:12:20 +00003576 sqlite3VdbeEndCoroutine(v, regAddrB);
drhb21e7c72008-06-22 12:37:57 +00003577
drh92b01d52008-06-24 00:32:35 +00003578 /* Generate a subroutine that outputs the current row of the A
drh0acb7e42008-06-25 00:12:41 +00003579 ** select as the next output row of the compound select.
drh92b01d52008-06-24 00:32:35 +00003580 */
drhb21e7c72008-06-22 12:37:57 +00003581 VdbeNoopComment((v, "Output routine for A"));
drh0acb7e42008-06-25 00:12:41 +00003582 addrOutA = generateOutputSubroutine(pParse,
3583 p, &destA, pDest, regOutA,
drh2ec2fb22013-11-06 19:59:23 +00003584 regPrev, pKeyDup, labelEnd);
drhb21e7c72008-06-22 12:37:57 +00003585
drh92b01d52008-06-24 00:32:35 +00003586 /* Generate a subroutine that outputs the current row of the B
drh0acb7e42008-06-25 00:12:41 +00003587 ** select as the next output row of the compound select.
drh92b01d52008-06-24 00:32:35 +00003588 */
drh0acb7e42008-06-25 00:12:41 +00003589 if( op==TK_ALL || op==TK_UNION ){
3590 VdbeNoopComment((v, "Output routine for B"));
3591 addrOutB = generateOutputSubroutine(pParse,
3592 p, &destB, pDest, regOutB,
drh2ec2fb22013-11-06 19:59:23 +00003593 regPrev, pKeyDup, labelEnd);
drh0acb7e42008-06-25 00:12:41 +00003594 }
drh2ec2fb22013-11-06 19:59:23 +00003595 sqlite3KeyInfoUnref(pKeyDup);
drhb21e7c72008-06-22 12:37:57 +00003596
drh92b01d52008-06-24 00:32:35 +00003597 /* Generate a subroutine to run when the results from select A
3598 ** are exhausted and only data in select B remains.
3599 */
drhb21e7c72008-06-22 12:37:57 +00003600 if( op==TK_EXCEPT || op==TK_INTERSECT ){
drh81cf13e2014-02-07 18:27:53 +00003601 addrEofA_noB = addrEofA = labelEnd;
drhb21e7c72008-06-22 12:37:57 +00003602 }else{
drh81cf13e2014-02-07 18:27:53 +00003603 VdbeNoopComment((v, "eof-A subroutine"));
3604 addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3605 addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
drh688852a2014-02-17 22:40:43 +00003606 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003607 sqlite3VdbeGoto(v, addrEofA);
drhc3489bb2016-02-25 16:04:59 +00003608 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
drhb21e7c72008-06-22 12:37:57 +00003609 }
3610
drh92b01d52008-06-24 00:32:35 +00003611 /* Generate a subroutine to run when the results from select B
3612 ** are exhausted and only data in select A remains.
3613 */
drhb21e7c72008-06-22 12:37:57 +00003614 if( op==TK_INTERSECT ){
drh92b01d52008-06-24 00:32:35 +00003615 addrEofB = addrEofA;
drh95aa47b2010-11-16 02:49:15 +00003616 if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
drhb21e7c72008-06-22 12:37:57 +00003617 }else{
drh92b01d52008-06-24 00:32:35 +00003618 VdbeNoopComment((v, "eof-B subroutine"));
drh81cf13e2014-02-07 18:27:53 +00003619 addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
drh688852a2014-02-17 22:40:43 +00003620 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003621 sqlite3VdbeGoto(v, addrEofB);
drhb21e7c72008-06-22 12:37:57 +00003622 }
3623
drh92b01d52008-06-24 00:32:35 +00003624 /* Generate code to handle the case of A<B
3625 */
drhb21e7c72008-06-22 12:37:57 +00003626 VdbeNoopComment((v, "A-lt-B subroutine"));
drh0acb7e42008-06-25 00:12:41 +00003627 addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
drh688852a2014-02-17 22:40:43 +00003628 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003629 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003630
drh92b01d52008-06-24 00:32:35 +00003631 /* Generate code to handle the case of A==B
3632 */
drhb21e7c72008-06-22 12:37:57 +00003633 if( op==TK_ALL ){
3634 addrAeqB = addrAltB;
drh0acb7e42008-06-25 00:12:41 +00003635 }else if( op==TK_INTERSECT ){
3636 addrAeqB = addrAltB;
3637 addrAltB++;
drh92b01d52008-06-24 00:32:35 +00003638 }else{
drhb21e7c72008-06-22 12:37:57 +00003639 VdbeNoopComment((v, "A-eq-B subroutine"));
drh0acb7e42008-06-25 00:12:41 +00003640 addrAeqB =
drh688852a2014-02-17 22:40:43 +00003641 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003642 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003643 }
3644
drh92b01d52008-06-24 00:32:35 +00003645 /* Generate code to handle the case of A>B
3646 */
drhb21e7c72008-06-22 12:37:57 +00003647 VdbeNoopComment((v, "A-gt-B subroutine"));
3648 addrAgtB = sqlite3VdbeCurrentAddr(v);
3649 if( op==TK_ALL || op==TK_UNION ){
3650 sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3651 }
drh688852a2014-02-17 22:40:43 +00003652 sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003653 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003654
drh92b01d52008-06-24 00:32:35 +00003655 /* This code runs once to initialize everything.
3656 */
drh728e0f92015-10-10 14:41:28 +00003657 sqlite3VdbeJumpHere(v, addr1);
drh688852a2014-02-17 22:40:43 +00003658 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
3659 sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003660
3661 /* Implement the main merge loop
3662 */
3663 sqlite3VdbeResolveLabel(v, labelCmpr);
drh0acb7e42008-06-25 00:12:41 +00003664 sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
drh2b596da2012-07-23 21:43:19 +00003665 sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
drh2ec2fb22013-11-06 19:59:23 +00003666 (char*)pKeyMerge, P4_KEYINFO);
drh953f7612012-12-07 22:18:54 +00003667 sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
drh688852a2014-02-17 22:40:43 +00003668 sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003669
3670 /* Jump to the this point in order to terminate the query.
3671 */
drhb21e7c72008-06-22 12:37:57 +00003672 sqlite3VdbeResolveLabel(v, labelEnd);
drh92b01d52008-06-24 00:32:35 +00003673
drh0acb7e42008-06-25 00:12:41 +00003674 /* Reassembly the compound query so that it will be freed correctly
3675 ** by the calling function */
drh38cebe02021-12-30 00:37:11 +00003676 if( pSplit->pPrior ){
3677 sqlite3SelectDelete(db, pSplit->pPrior);
danielk19775e7ad502008-07-01 17:39:27 +00003678 }
drh38cebe02021-12-30 00:37:11 +00003679 pSplit->pPrior = pPrior;
3680 pPrior->pNext = pSplit;
dancd0b2452021-04-12 12:02:49 +00003681 sqlite3ExprListDelete(db, pPrior->pOrderBy);
3682 pPrior->pOrderBy = 0;
3683
drh92b01d52008-06-24 00:32:35 +00003684 /*** TBD: Insert subroutine calls to close cursors on incomplete
3685 **** subqueries ****/
drhe2ca99c2018-05-02 00:33:43 +00003686 ExplainQueryPlanPop(pParse);
drh3dc4cc62015-04-15 07:10:25 +00003687 return pParse->nErr!=0;
drhb21e7c72008-06-22 12:37:57 +00003688}
danielk1977de3e41e2008-08-04 03:51:24 +00003689#endif
drhb21e7c72008-06-22 12:37:57 +00003690
shane3514b6f2008-07-22 05:00:55 +00003691#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh46967de2017-04-14 12:39:37 +00003692
3693/* An instance of the SubstContext object describes an substitution edit
3694** to be performed on a parse tree.
3695**
3696** All references to columns in table iTable are to be replaced by corresponding
3697** expressions in pEList.
drhc133bab2022-04-11 20:15:52 +00003698**
3699** ## About "isOuterJoin":
3700**
3701** The isOuterJoin column indicates that the replacement will occur into a
3702** position in the parent that NULL-able due to an OUTER JOIN. Either the
3703** target slot in the parent is the right operand of a LEFT JOIN, or one of
3704** the left operands of a RIGHT JOIN. In either case, we need to potentially
3705** bypass the substituted expression with OP_IfNullRow.
3706**
3707** Suppose the original expression integer constant. Even though the table
3708** has the nullRow flag set, because the expression is an integer constant,
3709** it will not be NULLed out. So instead, we insert an OP_IfNullRow opcode
3710** that checks to see if the nullRow flag is set on the table. If the nullRow
3711** flag is set, then the value in the register is set to NULL and the original
3712** expression is bypassed. If the nullRow flag is not set, then the original
3713** expression runs to populate the register.
3714**
3715** Example where this is needed:
3716**
3717** CREATE TABLE t1(a INTEGER PRIMARY KEY, b INT);
3718** CREATE TABLE t2(x INT UNIQUE);
3719**
3720** SELECT a,b,m,x FROM t1 LEFT JOIN (SELECT 59 AS m,x FROM t2) ON b=x;
3721**
3722** When the subquery on the right side of the LEFT JOIN is flattened, we
3723** have to add OP_IfNullRow in front of the OP_Integer that implements the
3724** "m" value of the subquery so that a NULL will be loaded instead of 59
3725** when processing a non-matched row of the left.
drh46967de2017-04-14 12:39:37 +00003726*/
3727typedef struct SubstContext {
3728 Parse *pParse; /* The parsing context */
3729 int iTable; /* Replace references to this table */
drh31d6fd52017-04-14 19:03:10 +00003730 int iNewTable; /* New table number */
drhc133bab2022-04-11 20:15:52 +00003731 int isOuterJoin; /* Add TK_IF_NULL_ROW opcodes on each replacement */
drh46967de2017-04-14 12:39:37 +00003732 ExprList *pEList; /* Replacement expressions */
3733} SubstContext;
3734
drh17435752007-08-16 04:30:38 +00003735/* Forward Declarations */
drh46967de2017-04-14 12:39:37 +00003736static void substExprList(SubstContext*, ExprList*);
3737static void substSelect(SubstContext*, Select*, int);
drh17435752007-08-16 04:30:38 +00003738
drh22827922000-06-06 17:27:05 +00003739/*
drh832508b2002-03-02 17:04:07 +00003740** Scan through the expression pExpr. Replace every reference to
drh6a3ea0e2003-05-02 14:32:12 +00003741** a column in table number iTable with a copy of the iColumn-th
drh84e59202002-03-14 14:33:31 +00003742** entry in pEList. (But leave references to the ROWID column
drh6a3ea0e2003-05-02 14:32:12 +00003743** unchanged.)
drh832508b2002-03-02 17:04:07 +00003744**
3745** This routine is part of the flattening procedure. A subquery
3746** whose result set is defined by pEList appears as entry in the
3747** FROM clause of a SELECT such that the VDBE cursor assigned to that
drhaca19e12017-04-07 19:41:31 +00003748** FORM clause entry is iTable. This routine makes the necessary
drh832508b2002-03-02 17:04:07 +00003749** changes to pExpr so that it refers directly to the source table
3750** of the subquery rather the result set of the subquery.
3751*/
drhb7916a72009-05-27 10:31:29 +00003752static Expr *substExpr(
drh46967de2017-04-14 12:39:37 +00003753 SubstContext *pSubst, /* Description of the substitution */
3754 Expr *pExpr /* Expr in which substitution occurs */
drh17435752007-08-16 04:30:38 +00003755){
drhb7916a72009-05-27 10:31:29 +00003756 if( pExpr==0 ) return 0;
drh3d240d22017-09-28 16:56:55 +00003757 if( ExprHasProperty(pExpr, EP_FromJoin)
drhd1985262022-04-11 11:25:28 +00003758 && pExpr->w.iJoin==pSubst->iTable
drh3d240d22017-09-28 16:56:55 +00003759 ){
drhd1985262022-04-11 11:25:28 +00003760 pExpr->w.iJoin = pSubst->iNewTable;
drh399c7e22017-04-14 17:18:45 +00003761 }
drh2e52a9c2020-04-04 00:15:54 +00003762 if( pExpr->op==TK_COLUMN
3763 && pExpr->iTable==pSubst->iTable
3764 && !ExprHasProperty(pExpr, EP_FixedCol)
3765 ){
drh6e5020e2021-04-07 15:45:01 +00003766#ifdef SQLITE_ALLOW_ROWID_IN_VIEW
drh50350a12004-02-13 16:22:22 +00003767 if( pExpr->iColumn<0 ){
3768 pExpr->op = TK_NULL;
drh6e5020e2021-04-07 15:45:01 +00003769 }else
3770#endif
3771 {
drh50350a12004-02-13 16:22:22 +00003772 Expr *pNew;
drh46967de2017-04-14 12:39:37 +00003773 Expr *pCopy = pSubst->pEList->a[pExpr->iColumn].pExpr;
drh31d6fd52017-04-14 19:03:10 +00003774 Expr ifNullRow;
drh46967de2017-04-14 12:39:37 +00003775 assert( pSubst->pEList!=0 && pExpr->iColumn<pSubst->pEList->nExpr );
drh1fd4e7b2018-07-28 14:56:56 +00003776 assert( pExpr->pRight==0 );
dan44c56042016-12-07 15:38:37 +00003777 if( sqlite3ExprIsVector(pCopy) ){
drh46967de2017-04-14 12:39:37 +00003778 sqlite3VectorErrorMsg(pSubst->pParse, pCopy);
dan44c56042016-12-07 15:38:37 +00003779 }else{
drh46967de2017-04-14 12:39:37 +00003780 sqlite3 *db = pSubst->pParse->db;
drhc133bab2022-04-11 20:15:52 +00003781 if( pSubst->isOuterJoin && pCopy->op!=TK_COLUMN ){
drh31d6fd52017-04-14 19:03:10 +00003782 memset(&ifNullRow, 0, sizeof(ifNullRow));
3783 ifNullRow.op = TK_IF_NULL_ROW;
3784 ifNullRow.pLeft = pCopy;
3785 ifNullRow.iTable = pSubst->iNewTable;
drh46fe1382020-08-19 23:32:06 +00003786 ifNullRow.flags = EP_IfNullRow;
drh31d6fd52017-04-14 19:03:10 +00003787 pCopy = &ifNullRow;
3788 }
drh11df7d22018-12-06 19:15:36 +00003789 testcase( ExprHasProperty(pCopy, EP_Subquery) );
dan44c56042016-12-07 15:38:37 +00003790 pNew = sqlite3ExprDup(db, pCopy, 0);
drh8c6cb1b2021-04-19 20:36:13 +00003791 if( db->mallocFailed ){
3792 sqlite3ExprDelete(db, pNew);
3793 return pExpr;
3794 }
drhc133bab2022-04-11 20:15:52 +00003795 if( pSubst->isOuterJoin ){
danbd11a2a2017-06-20 17:43:26 +00003796 ExprSetProperty(pNew, EP_CanBeNull);
3797 }
drh3a6e4c52022-04-11 12:38:06 +00003798 if( ExprHasProperty(pExpr,EP_FromJoin|EP_InnerJoin) ){
3799 sqlite3SetJoinExpr(pNew, pExpr->w.iJoin,
3800 pExpr->flags & (EP_FromJoin|EP_InnerJoin));
dan44c56042016-12-07 15:38:37 +00003801 }
3802 sqlite3ExprDelete(db, pExpr);
3803 pExpr = pNew;
dane0866392019-09-09 19:49:42 +00003804
danfa508342019-09-10 15:33:52 +00003805 /* Ensure that the expression now has an implicit collation sequence,
3806 ** just as it did when it was a column of a view or sub-query. */
drh60b95332021-04-19 15:05:27 +00003807 if( pExpr->op!=TK_COLUMN && pExpr->op!=TK_COLLATE ){
3808 CollSeq *pColl = sqlite3ExprCollSeq(pSubst->pParse, pExpr);
3809 pExpr = sqlite3ExprAddCollateString(pSubst->pParse, pExpr,
3810 (pColl ? pColl->zName : "BINARY")
3811 );
dane0866392019-09-09 19:49:42 +00003812 }
drh60b95332021-04-19 15:05:27 +00003813 ExprClearProperty(pExpr, EP_Collate);
dan92ddb3b2016-12-01 19:38:05 +00003814 }
drh50350a12004-02-13 16:22:22 +00003815 }
drh832508b2002-03-02 17:04:07 +00003816 }else{
drh7c1544e2017-05-23 12:44:57 +00003817 if( pExpr->op==TK_IF_NULL_ROW && pExpr->iTable==pSubst->iTable ){
3818 pExpr->iTable = pSubst->iNewTable;
3819 }
drh46967de2017-04-14 12:39:37 +00003820 pExpr->pLeft = substExpr(pSubst, pExpr->pLeft);
3821 pExpr->pRight = substExpr(pSubst, pExpr->pRight);
drha4eeccd2021-10-07 17:43:30 +00003822 if( ExprUseXSelect(pExpr) ){
drh46967de2017-04-14 12:39:37 +00003823 substSelect(pSubst, pExpr->x.pSelect, 1);
danielk19776ab3a2e2009-02-19 14:39:25 +00003824 }else{
drh46967de2017-04-14 12:39:37 +00003825 substExprList(pSubst, pExpr->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +00003826 }
dan3703edf2019-10-10 15:17:09 +00003827#ifndef SQLITE_OMIT_WINDOWFUNC
3828 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3829 Window *pWin = pExpr->y.pWin;
3830 pWin->pFilter = substExpr(pSubst, pWin->pFilter);
3831 substExprList(pSubst, pWin->pPartition);
3832 substExprList(pSubst, pWin->pOrderBy);
3833 }
3834#endif
drh832508b2002-03-02 17:04:07 +00003835 }
drhb7916a72009-05-27 10:31:29 +00003836 return pExpr;
drh832508b2002-03-02 17:04:07 +00003837}
drh17435752007-08-16 04:30:38 +00003838static void substExprList(
drh46967de2017-04-14 12:39:37 +00003839 SubstContext *pSubst, /* Description of the substitution */
3840 ExprList *pList /* List to scan and in which to make substitutes */
drh17435752007-08-16 04:30:38 +00003841){
drh832508b2002-03-02 17:04:07 +00003842 int i;
3843 if( pList==0 ) return;
3844 for(i=0; i<pList->nExpr; i++){
drh46967de2017-04-14 12:39:37 +00003845 pList->a[i].pExpr = substExpr(pSubst, pList->a[i].pExpr);
drh832508b2002-03-02 17:04:07 +00003846 }
3847}
drh17435752007-08-16 04:30:38 +00003848static void substSelect(
drh46967de2017-04-14 12:39:37 +00003849 SubstContext *pSubst, /* Description of the substitution */
3850 Select *p, /* SELECT statement in which to make substitutions */
3851 int doPrior /* Do substitutes on p->pPrior too */
drh17435752007-08-16 04:30:38 +00003852){
drh588a9a12008-09-01 15:52:10 +00003853 SrcList *pSrc;
drh76012942021-02-21 21:04:54 +00003854 SrcItem *pItem;
drh588a9a12008-09-01 15:52:10 +00003855 int i;
danielk1977b3bce662005-01-29 08:32:43 +00003856 if( !p ) return;
drhd12b6362015-10-11 19:46:59 +00003857 do{
drh46967de2017-04-14 12:39:37 +00003858 substExprList(pSubst, p->pEList);
3859 substExprList(pSubst, p->pGroupBy);
3860 substExprList(pSubst, p->pOrderBy);
3861 p->pHaving = substExpr(pSubst, p->pHaving);
3862 p->pWhere = substExpr(pSubst, p->pWhere);
drhd12b6362015-10-11 19:46:59 +00003863 pSrc = p->pSrc;
drh29064902015-10-11 20:08:31 +00003864 assert( pSrc!=0 );
drh588a9a12008-09-01 15:52:10 +00003865 for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
drh46967de2017-04-14 12:39:37 +00003866 substSelect(pSubst, pItem->pSelect, 1);
drh29064902015-10-11 20:08:31 +00003867 if( pItem->fg.isTabFunc ){
drh46967de2017-04-14 12:39:37 +00003868 substExprList(pSubst, pItem->u1.pFuncArg);
drhd12b6362015-10-11 19:46:59 +00003869 }
drh588a9a12008-09-01 15:52:10 +00003870 }
drhd12b6362015-10-11 19:46:59 +00003871 }while( doPrior && (p = p->pPrior)!=0 );
danielk1977b3bce662005-01-29 08:32:43 +00003872}
shane3514b6f2008-07-22 05:00:55 +00003873#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
drh832508b2002-03-02 17:04:07 +00003874
shane3514b6f2008-07-22 05:00:55 +00003875#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh832508b2002-03-02 17:04:07 +00003876/*
drh2aee5142020-03-21 00:05:53 +00003877** pSelect is a SELECT statement and pSrcItem is one item in the FROM
3878** clause of that SELECT.
3879**
3880** This routine scans the entire SELECT statement and recomputes the
3881** pSrcItem->colUsed mask.
3882*/
3883static int recomputeColumnsUsedExpr(Walker *pWalker, Expr *pExpr){
drh76012942021-02-21 21:04:54 +00003884 SrcItem *pItem;
drh2aee5142020-03-21 00:05:53 +00003885 if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
3886 pItem = pWalker->u.pSrcItem;
3887 if( pItem->iCursor!=pExpr->iTable ) return WRC_Continue;
drh74a07982020-03-21 23:10:38 +00003888 if( pExpr->iColumn<0 ) return WRC_Continue;
3889 pItem->colUsed |= sqlite3ExprColUsed(pExpr);
drh2aee5142020-03-21 00:05:53 +00003890 return WRC_Continue;
3891}
3892static void recomputeColumnsUsed(
3893 Select *pSelect, /* The complete SELECT statement */
drh76012942021-02-21 21:04:54 +00003894 SrcItem *pSrcItem /* Which FROM clause item to recompute */
drh2aee5142020-03-21 00:05:53 +00003895){
3896 Walker w;
3897 if( NEVER(pSrcItem->pTab==0) ) return;
3898 memset(&w, 0, sizeof(w));
3899 w.xExprCallback = recomputeColumnsUsedExpr;
3900 w.xSelectCallback = sqlite3SelectWalkNoop;
3901 w.u.pSrcItem = pSrcItem;
3902 pSrcItem->colUsed = 0;
3903 sqlite3WalkSelect(&w, pSelect);
3904}
3905#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3906
3907#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3908/*
dan964fa262020-12-18 16:13:39 +00003909** Assign new cursor numbers to each of the items in pSrc. For each
3910** new cursor number assigned, set an entry in the aCsrMap[] array
3911** to map the old cursor number to the new:
3912**
drhc8d21472021-07-21 15:42:05 +00003913** aCsrMap[iOld+1] = iNew;
dan964fa262020-12-18 16:13:39 +00003914**
3915** The array is guaranteed by the caller to be large enough for all
drhc8d21472021-07-21 15:42:05 +00003916** existing cursor numbers in pSrc. aCsrMap[0] is the array size.
dan964fa262020-12-18 16:13:39 +00003917**
3918** If pSrc contains any sub-selects, call this routine recursively
3919** on the FROM clause of each such sub-select, with iExcept set to -1.
3920*/
3921static void srclistRenumberCursors(
3922 Parse *pParse, /* Parse context */
3923 int *aCsrMap, /* Array to store cursor mappings in */
3924 SrcList *pSrc, /* FROM clause to renumber */
3925 int iExcept /* FROM clause item to skip */
3926){
3927 int i;
drh76012942021-02-21 21:04:54 +00003928 SrcItem *pItem;
dan964fa262020-12-18 16:13:39 +00003929 for(i=0, pItem=pSrc->a; i<pSrc->nSrc; i++, pItem++){
3930 if( i!=iExcept ){
dand131b512020-12-18 18:04:44 +00003931 Select *p;
drhc8d21472021-07-21 15:42:05 +00003932 assert( pItem->iCursor < aCsrMap[0] );
3933 if( !pItem->fg.isRecursive || aCsrMap[pItem->iCursor+1]==0 ){
3934 aCsrMap[pItem->iCursor+1] = pParse->nTab++;
drhc7f50772021-04-26 21:23:01 +00003935 }
drhc8d21472021-07-21 15:42:05 +00003936 pItem->iCursor = aCsrMap[pItem->iCursor+1];
dand131b512020-12-18 18:04:44 +00003937 for(p=pItem->pSelect; p; p=p->pPrior){
3938 srclistRenumberCursors(pParse, aCsrMap, p->pSrc, -1);
dan964fa262020-12-18 16:13:39 +00003939 }
3940 }
3941 }
3942}
3943
3944/*
drhc8d21472021-07-21 15:42:05 +00003945** *piCursor is a cursor number. Change it if it needs to be mapped.
3946*/
3947static void renumberCursorDoMapping(Walker *pWalker, int *piCursor){
3948 int *aCsrMap = pWalker->u.aiCol;
3949 int iCsr = *piCursor;
3950 if( iCsr < aCsrMap[0] && aCsrMap[iCsr+1]>0 ){
3951 *piCursor = aCsrMap[iCsr+1];
3952 }
3953}
3954
3955/*
dan964fa262020-12-18 16:13:39 +00003956** Expression walker callback used by renumberCursors() to update
3957** Expr objects to match newly assigned cursor numbers.
3958*/
3959static int renumberCursorsCb(Walker *pWalker, Expr *pExpr){
dane8f14902021-02-13 14:26:25 +00003960 int op = pExpr->op;
drhc8d21472021-07-21 15:42:05 +00003961 if( op==TK_COLUMN || op==TK_IF_NULL_ROW ){
3962 renumberCursorDoMapping(pWalker, &pExpr->iTable);
dan964fa262020-12-18 16:13:39 +00003963 }
drhc8d21472021-07-21 15:42:05 +00003964 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drhd1985262022-04-11 11:25:28 +00003965 renumberCursorDoMapping(pWalker, &pExpr->w.iJoin);
dan961a7262020-12-21 19:50:10 +00003966 }
dan964fa262020-12-18 16:13:39 +00003967 return WRC_Continue;
3968}
3969
3970/*
3971** Assign a new cursor number to each cursor in the FROM clause (Select.pSrc)
3972** of the SELECT statement passed as the second argument, and to each
3973** cursor in the FROM clause of any FROM clause sub-selects, recursively.
3974** Except, do not assign a new cursor number to the iExcept'th element in
3975** the FROM clause of (*p). Update all expressions and other references
3976** to refer to the new cursor numbers.
3977**
3978** Argument aCsrMap is an array that may be used for temporary working
3979** space. Two guarantees are made by the caller:
3980**
3981** * the array is larger than the largest cursor number used within the
3982** select statement passed as an argument, and
3983**
3984** * the array entries for all cursor numbers that do *not* appear in
3985** FROM clauses of the select statement as described above are
3986** initialized to zero.
3987*/
3988static void renumberCursors(
3989 Parse *pParse, /* Parse context */
3990 Select *p, /* Select to renumber cursors within */
3991 int iExcept, /* FROM clause item to skip */
3992 int *aCsrMap /* Working space */
3993){
3994 Walker w;
3995 srclistRenumberCursors(pParse, aCsrMap, p->pSrc, iExcept);
3996 memset(&w, 0, sizeof(w));
3997 w.u.aiCol = aCsrMap;
3998 w.xExprCallback = renumberCursorsCb;
3999 w.xSelectCallback = sqlite3SelectWalkNoop;
4000 sqlite3WalkSelect(&w, p);
4001}
4002#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4003
4004#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4005/*
drh630d2962011-12-11 21:51:04 +00004006** This routine attempts to flatten subqueries as a performance optimization.
4007** This routine returns 1 if it makes changes and 0 if no flattening occurs.
drh1350b032002-02-27 19:00:20 +00004008**
4009** To understand the concept of flattening, consider the following
4010** query:
4011**
4012** SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
4013**
4014** The default way of implementing this query is to execute the
4015** subquery first and store the results in a temporary table, then
4016** run the outer query on that temporary table. This requires two
4017** passes over the data. Furthermore, because the temporary table
4018** has no indices, the WHERE clause on the outer query cannot be
drh832508b2002-03-02 17:04:07 +00004019** optimized.
drh1350b032002-02-27 19:00:20 +00004020**
drh832508b2002-03-02 17:04:07 +00004021** This routine attempts to rewrite queries such as the above into
drh1350b032002-02-27 19:00:20 +00004022** a single flat select, like this:
4023**
4024** SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
4025**
peter.d.reid60ec9142014-09-06 16:39:46 +00004026** The code generated for this simplification gives the same result
drh832508b2002-03-02 17:04:07 +00004027** but only has to scan the data once. And because indices might
4028** exist on the table t1, a complete scan of the data might be
4029** avoided.
drh1350b032002-02-27 19:00:20 +00004030**
drhd981e822017-09-29 16:07:56 +00004031** Flattening is subject to the following constraints:
drh1350b032002-02-27 19:00:20 +00004032**
drh25c221e2017-09-29 22:13:24 +00004033** (**) We no longer attempt to flatten aggregate subqueries. Was:
4034** The subquery and the outer query cannot both be aggregates.
drh1350b032002-02-27 19:00:20 +00004035**
drh25c221e2017-09-29 22:13:24 +00004036** (**) We no longer attempt to flatten aggregate subqueries. Was:
4037** (2) If the subquery is an aggregate then
drhd981e822017-09-29 16:07:56 +00004038** (2a) the outer query must not be a join and
4039** (2b) the outer query must not use subqueries
4040** other than the one FROM-clause subquery that is a candidate
4041** for flattening. (This is due to ticket [2f7170d73bf9abf80]
4042** from 2015-02-09.)
drh832508b2002-03-02 17:04:07 +00004043**
drhd981e822017-09-29 16:07:56 +00004044** (3) If the subquery is the right operand of a LEFT JOIN then
4045** (3a) the subquery may not be a join and
4046** (3b) the FROM clause of the subquery may not contain a virtual
4047** table and
4048** (3c) the outer query may not be an aggregate.
drh396afe62019-12-18 20:51:58 +00004049** (3d) the outer query may not be DISTINCT.
drh41798d52022-04-11 00:21:53 +00004050** See also (26) for restrictions on RIGHT JOIN.
drh832508b2002-03-02 17:04:07 +00004051**
drhd981e822017-09-29 16:07:56 +00004052** (4) The subquery can not be DISTINCT.
drh832508b2002-03-02 17:04:07 +00004053**
dan49ad3302010-08-13 16:38:48 +00004054** (**) At one point restrictions (4) and (5) defined a subset of DISTINCT
4055** sub-queries that were excluded from this optimization. Restriction
4056** (4) has since been expanded to exclude all DISTINCT subqueries.
drh832508b2002-03-02 17:04:07 +00004057**
drh25c221e2017-09-29 22:13:24 +00004058** (**) We no longer attempt to flatten aggregate subqueries. Was:
4059** If the subquery is aggregate, the outer query may not be DISTINCT.
drh832508b2002-03-02 17:04:07 +00004060**
drhd981e822017-09-29 16:07:56 +00004061** (7) The subquery must have a FROM clause. TODO: For subqueries without
drh31d6fd52017-04-14 19:03:10 +00004062** A FROM clause, consider adding a FROM clause with the special
drh630d2962011-12-11 21:51:04 +00004063** table sqlite_once that consists of a single row containing a
4064** single NULL.
drh08192d52002-04-30 19:20:28 +00004065**
drhd981e822017-09-29 16:07:56 +00004066** (8) If the subquery uses LIMIT then the outer query may not be a join.
drhdf199a22002-06-14 22:38:41 +00004067**
drhd981e822017-09-29 16:07:56 +00004068** (9) If the subquery uses LIMIT then the outer query may not be aggregate.
drhdf199a22002-06-14 22:38:41 +00004069**
drh6092d2b2014-09-15 11:14:50 +00004070** (**) Restriction (10) was removed from the code on 2005-02-05 but we
4071** accidently carried the comment forward until 2014-09-15. Original
drhd981e822017-09-29 16:07:56 +00004072** constraint: "If the subquery is aggregate then the outer query
4073** may not use LIMIT."
drhdf199a22002-06-14 22:38:41 +00004074**
drhd981e822017-09-29 16:07:56 +00004075** (11) The subquery and the outer query may not both have ORDER BY clauses.
drh174b6192002-12-03 02:22:52 +00004076**
drh7b688ed2009-12-22 00:29:53 +00004077** (**) Not implemented. Subsumed into restriction (3). Was previously
drh2b300d52008-08-14 00:19:48 +00004078** a separate restriction deriving from ticket #350.
drh3fc673e2003-06-16 00:40:34 +00004079**
drhd981e822017-09-29 16:07:56 +00004080** (13) The subquery and outer query may not both use LIMIT.
drhac839632006-01-21 22:19:54 +00004081**
drhd981e822017-09-29 16:07:56 +00004082** (14) The subquery may not use OFFSET.
drhac839632006-01-21 22:19:54 +00004083**
drhd981e822017-09-29 16:07:56 +00004084** (15) If the outer query is part of a compound select, then the
4085** subquery may not use LIMIT.
drhf3913272010-04-15 23:24:29 +00004086** (See ticket #2339 and ticket [02a8e81d44]).
drhad91c6c2007-05-06 20:04:24 +00004087**
drhd981e822017-09-29 16:07:56 +00004088** (16) If the outer query is aggregate, then the subquery may not
4089** use ORDER BY. (Ticket #2942) This used to not matter
drhc52e3552008-02-15 14:33:03 +00004090** until we introduced the group_concat() function.
4091**
drhd981e822017-09-29 16:07:56 +00004092** (17) If the subquery is a compound select, then
4093** (17a) all compound operators must be a UNION ALL, and
4094** (17b) no terms within the subquery compound may be aggregate
drhe76acc62017-10-04 02:30:45 +00004095** or DISTINCT, and
drhd981e822017-09-29 16:07:56 +00004096** (17c) every term within the subquery compound must have a FROM clause
4097** (17d) the outer query may not be
4098** (17d1) aggregate, or
dan8daf5ae2020-12-17 16:48:04 +00004099** (17d2) DISTINCT
4100** (17e) the subquery may not contain window functions, and
4101** (17f) the subquery must not be the RHS of a LEFT JOIN.
danielk1977f23329a2008-07-01 14:09:13 +00004102**
danielk19774914cf92008-07-01 18:26:49 +00004103** The parent and sub-query may contain WHERE clauses. Subject to
4104** rules (11), (13) and (14), they may also contain ORDER BY,
drh630d2962011-12-11 21:51:04 +00004105** LIMIT and OFFSET clauses. The subquery cannot use any compound
4106** operator other than UNION ALL because all the other compound
4107** operators have an implied DISTINCT which is disallowed by
4108** restriction (4).
danielk1977f23329a2008-07-01 14:09:13 +00004109**
dan67c70142012-08-28 14:45:50 +00004110** Also, each component of the sub-query must return the same number
4111** of result columns. This is actually a requirement for any compound
4112** SELECT statement, but all the code here does is make sure that no
4113** such (illegal) sub-query is flattened. The caller will detect the
4114** syntax error and return a detailed message.
4115**
danielk197749fc1f62008-07-08 17:43:56 +00004116** (18) If the sub-query is a compound select, then all terms of the
dan9353bea2020-12-17 17:17:12 +00004117** ORDER BY clause of the parent must be copies of a term returned
4118** by the parent query.
danielk197749fc1f62008-07-08 17:43:56 +00004119**
drhd981e822017-09-29 16:07:56 +00004120** (19) If the subquery uses LIMIT then the outer query may not
drh229cf702008-08-26 12:56:14 +00004121** have a WHERE clause.
4122**
drhfca23552017-10-28 20:51:54 +00004123** (20) If the sub-query is a compound select, then it must not use
4124** an ORDER BY clause. Ticket #3773. We could relax this constraint
4125** somewhat by saying that the terms of the ORDER BY clause must
4126** appear as unmodified result columns in the outer query. But we
4127** have other optimizations in mind to deal with that case.
drhe8902a72009-04-02 16:59:47 +00004128**
drhd981e822017-09-29 16:07:56 +00004129** (21) If the subquery uses LIMIT then the outer query may not be
shaneha91491e2011-02-11 20:52:20 +00004130** DISTINCT. (See ticket [752e1646fc]).
4131**
drhd981e822017-09-29 16:07:56 +00004132** (22) The subquery may not be a recursive CTE.
dan8290c2a2014-01-16 10:58:39 +00004133**
dan8daf5ae2020-12-17 16:48:04 +00004134** (23) If the outer query is a recursive CTE, then the sub-query may not be
4135** a compound query. This restriction is because transforming the
dan8290c2a2014-01-16 10:58:39 +00004136** parent to a compound query confuses the code that handles
4137** recursive queries in multiSelect().
4138**
drh508e2d02017-09-30 01:25:04 +00004139** (**) We no longer attempt to flatten aggregate subqueries. Was:
4140** The subquery may not be an aggregate that uses the built-in min() or
drh9588ad92014-09-15 14:46:02 +00004141** or max() functions. (Without this restriction, a query like:
4142** "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
4143** return the value X for which Y was maximal.)
4144**
dan9a947222018-06-14 19:06:36 +00004145** (25) If either the subquery or the parent query contains a window
4146** function in the select list or ORDER BY clause, flattening
4147** is not attempted.
4148**
drh41798d52022-04-11 00:21:53 +00004149** (26) The subquery may not be the right operand of a RIGHT JOIN.
4150** See also (3) for restrictions on LEFT JOIN.
4151**
drh1c2bf412022-04-18 23:20:02 +00004152** (27) The subquery may not contain a FULL or RIGHT JOIN unless it
4153** is the first element of the parent query.
4154**
dan8290c2a2014-01-16 10:58:39 +00004155**
drh832508b2002-03-02 17:04:07 +00004156** In this routine, the "p" parameter is a pointer to the outer query.
4157** The subquery is p->pSrc->a[iFrom]. isAgg is true if the outer query
drh25c221e2017-09-29 22:13:24 +00004158** uses aggregates.
drh832508b2002-03-02 17:04:07 +00004159**
drh665de472003-03-31 13:36:09 +00004160** If flattening is not attempted, this routine is a no-op and returns 0.
drh832508b2002-03-02 17:04:07 +00004161** If flattening is attempted this routine returns 1.
4162**
4163** All of the expression analysis must occur on both the outer query and
4164** the subquery before this routine runs.
drh1350b032002-02-27 19:00:20 +00004165*/
drh8c74a8c2002-08-25 19:20:40 +00004166static int flattenSubquery(
danielk1977524cc212008-07-02 13:13:51 +00004167 Parse *pParse, /* Parsing context */
drh8c74a8c2002-08-25 19:20:40 +00004168 Select *p, /* The parent or outer SELECT statement */
4169 int iFrom, /* Index in p->pSrc->a[] of the inner subquery */
drh25c221e2017-09-29 22:13:24 +00004170 int isAgg /* True if outer SELECT uses aggregate functions */
drh8c74a8c2002-08-25 19:20:40 +00004171){
danielk1977524cc212008-07-02 13:13:51 +00004172 const char *zSavedAuthContext = pParse->zAuthContext;
drhd12b6362015-10-11 19:46:59 +00004173 Select *pParent; /* Current UNION ALL term of the other query */
drh0bb28102002-05-08 11:54:14 +00004174 Select *pSub; /* The inner query or "subquery" */
danielk1977f23329a2008-07-01 14:09:13 +00004175 Select *pSub1; /* Pointer to the rightmost select in sub-query */
drhad3cab52002-05-24 02:04:32 +00004176 SrcList *pSrc; /* The FROM clause of the outer query */
4177 SrcList *pSubSrc; /* The FROM clause of the subquery */
drh6a3ea0e2003-05-02 14:32:12 +00004178 int iParent; /* VDBE cursor number of the pSub result set temp table */
drh399c7e22017-04-14 17:18:45 +00004179 int iNewParent = -1;/* Replacement table for iParent */
drhc133bab2022-04-11 20:15:52 +00004180 int isOuterJoin = 0; /* True if pSub is the right side of a LEFT JOIN */
drh91bb0ee2004-09-01 03:06:34 +00004181 int i; /* Loop counter */
4182 Expr *pWhere; /* The WHERE clause */
drh76012942021-02-21 21:04:54 +00004183 SrcItem *pSubitem; /* The subquery */
danielk1977524cc212008-07-02 13:13:51 +00004184 sqlite3 *db = pParse->db;
drh89636622020-06-07 17:33:18 +00004185 Walker w; /* Walker to persist agginfo data */
dan964fa262020-12-18 16:13:39 +00004186 int *aCsrMap = 0;
drh1350b032002-02-27 19:00:20 +00004187
drh832508b2002-03-02 17:04:07 +00004188 /* Check to see if flattening is permitted. Return 0 if not.
4189 */
drha78c22c2008-11-11 18:28:58 +00004190 assert( p!=0 );
drhd981e822017-09-29 16:07:56 +00004191 assert( p->pPrior==0 );
drh7e5418e2012-09-27 15:05:54 +00004192 if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
drh832508b2002-03-02 17:04:07 +00004193 pSrc = p->pSrc;
drhad3cab52002-05-24 02:04:32 +00004194 assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
drh91bb0ee2004-09-01 03:06:34 +00004195 pSubitem = &pSrc->a[iFrom];
danielk197749fc1f62008-07-08 17:43:56 +00004196 iParent = pSubitem->iCursor;
drh91bb0ee2004-09-01 03:06:34 +00004197 pSub = pSubitem->pSelect;
drh832508b2002-03-02 17:04:07 +00004198 assert( pSub!=0 );
drh399c7e22017-04-14 17:18:45 +00004199
dan67a9b8e2018-06-22 20:51:35 +00004200#ifndef SQLITE_OMIT_WINDOWFUNC
dan9a947222018-06-14 19:06:36 +00004201 if( p->pWin || pSub->pWin ) return 0; /* Restriction (25) */
dan67a9b8e2018-06-22 20:51:35 +00004202#endif
dan86fb6e12018-05-16 20:58:07 +00004203
drh832508b2002-03-02 17:04:07 +00004204 pSubSrc = pSub->pSrc;
4205 assert( pSubSrc );
drhac839632006-01-21 22:19:54 +00004206 /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
peter.d.reid60ec9142014-09-06 16:39:46 +00004207 ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
drhac839632006-01-21 22:19:54 +00004208 ** because they could be computed at compile-time. But when LIMIT and OFFSET
4209 ** became arbitrary expressions, we were forced to add restrictions (13)
4210 ** and (14). */
4211 if( pSub->pLimit && p->pLimit ) return 0; /* Restriction (13) */
drh8c0833f2017-11-14 23:48:23 +00004212 if( pSub->pLimit && pSub->pLimit->pRight ) return 0; /* Restriction (14) */
drhd227a292014-02-09 18:02:09 +00004213 if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
drhad91c6c2007-05-06 20:04:24 +00004214 return 0; /* Restriction (15) */
4215 }
drhac839632006-01-21 22:19:54 +00004216 if( pSubSrc->nSrc==0 ) return 0; /* Restriction (7) */
drhd981e822017-09-29 16:07:56 +00004217 if( pSub->selFlags & SF_Distinct ) return 0; /* Restriction (4) */
dan49ad3302010-08-13 16:38:48 +00004218 if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
4219 return 0; /* Restrictions (8)(9) */
drhdf199a22002-06-14 22:38:41 +00004220 }
drh7d10d5a2008-08-20 16:35:10 +00004221 if( p->pOrderBy && pSub->pOrderBy ){
drhac839632006-01-21 22:19:54 +00004222 return 0; /* Restriction (11) */
4223 }
drhc52e3552008-02-15 14:33:03 +00004224 if( isAgg && pSub->pOrderBy ) return 0; /* Restriction (16) */
drh229cf702008-08-26 12:56:14 +00004225 if( pSub->pLimit && p->pWhere ) return 0; /* Restriction (19) */
shaneha91491e2011-02-11 20:52:20 +00004226 if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
4227 return 0; /* Restriction (21) */
4228 }
drh508e2d02017-09-30 01:25:04 +00004229 if( pSub->selFlags & (SF_Recursive) ){
4230 return 0; /* Restrictions (22) */
drh9588ad92014-09-15 14:46:02 +00004231 }
drh832508b2002-03-02 17:04:07 +00004232
drh399c7e22017-04-14 17:18:45 +00004233 /*
4234 ** If the subquery is the right operand of a LEFT JOIN, then the
drhd981e822017-09-29 16:07:56 +00004235 ** subquery may not be a join itself (3a). Example of why this is not
4236 ** allowed:
drh8af4d3a2003-05-06 20:35:16 +00004237 **
4238 ** t1 LEFT OUTER JOIN (t2 JOIN t3)
4239 **
4240 ** If we flatten the above, we would get
4241 **
4242 ** (t1 LEFT OUTER JOIN t2) JOIN t3
4243 **
4244 ** which is not at all the same thing.
drh2b300d52008-08-14 00:19:48 +00004245 **
drh3c790f22017-05-23 15:33:41 +00004246 ** If the subquery is the right operand of a LEFT JOIN, then the outer
drhd981e822017-09-29 16:07:56 +00004247 ** query cannot be an aggregate. (3c) This is an artifact of the way
4248 ** aggregates are processed - there is no mechanism to determine if
4249 ** the LEFT JOIN table should be all-NULL.
drh3c790f22017-05-23 15:33:41 +00004250 **
drh31d6fd52017-04-14 19:03:10 +00004251 ** See also tickets #306, #350, and #3300.
drh3fc673e2003-06-16 00:40:34 +00004252 */
drhc133bab2022-04-11 20:15:52 +00004253 if( (pSubitem->fg.jointype & (JT_OUTER|JT_LTORJ))!=0 ){
drh41798d52022-04-11 00:21:53 +00004254 if( pSubSrc->nSrc>1 /* (3a) */
4255 || isAgg /* (3b) */
4256 || IsVirtual(pSubSrc->a[0].pTab) /* (3c) */
4257 || (p->selFlags & SF_Distinct)!=0 /* (3d) */
4258 || (pSubitem->fg.jointype & JT_RIGHT)!=0 /* (26) */
drh396afe62019-12-18 20:51:58 +00004259 ){
drhd981e822017-09-29 16:07:56 +00004260 return 0;
drh399c7e22017-04-14 17:18:45 +00004261 }
drhc133bab2022-04-11 20:15:52 +00004262 isOuterJoin = 1;
drh3fc673e2003-06-16 00:40:34 +00004263 }
drhdc6de472017-05-25 11:39:50 +00004264#ifdef SQLITE_EXTRA_IFNULLROW
4265 else if( iFrom>0 && !isAgg ){
drhc133bab2022-04-11 20:15:52 +00004266 /* Setting isOuterJoin to -1 causes OP_IfNullRow opcodes to be generated for
drh3d240d22017-09-28 16:56:55 +00004267 ** every reference to any result column from subquery in a join, even
4268 ** though they are not necessary. This will stress-test the OP_IfNullRow
4269 ** opcode. */
drhc133bab2022-04-11 20:15:52 +00004270 isOuterJoin = -1;
drhdc6de472017-05-25 11:39:50 +00004271 }
4272#endif
drh3fc673e2003-06-16 00:40:34 +00004273
drh1c2bf412022-04-18 23:20:02 +00004274 assert( pSubSrc->nSrc>0 ); /* True by restriction (7) */
4275 if( iFrom>0 && (pSubSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
4276 return 0; /* Restriction (27) */
4277 }
4278
drhd981e822017-09-29 16:07:56 +00004279 /* Restriction (17): If the sub-query is a compound SELECT, then it must
danielk1977f23329a2008-07-01 14:09:13 +00004280 ** use only the UNION ALL operator. And none of the simple select queries
4281 ** that make up the compound SELECT are allowed to be aggregate or distinct
4282 ** queries.
4283 */
4284 if( pSub->pPrior ){
drhfca23552017-10-28 20:51:54 +00004285 if( pSub->pOrderBy ){
4286 return 0; /* Restriction (20) */
4287 }
drhc133bab2022-04-11 20:15:52 +00004288 if( isAgg || (p->selFlags & SF_Distinct)!=0 || isOuterJoin>0 ){
dan8daf5ae2020-12-17 16:48:04 +00004289 return 0; /* (17d1), (17d2), or (17f) */
danielk1977f23329a2008-07-01 14:09:13 +00004290 }
4291 for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
drhccfcbce2009-05-18 15:46:07 +00004292 testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
4293 testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
drh4b3ac732011-12-10 23:18:32 +00004294 assert( pSub->pSrc!=0 );
dan8daf5ae2020-12-17 16:48:04 +00004295 assert( (pSub->selFlags & SF_Recursive)==0 );
drh2ec18a32015-06-23 23:31:52 +00004296 assert( pSub->pEList->nExpr==pSub1->pEList->nExpr );
drhd981e822017-09-29 16:07:56 +00004297 if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0 /* (17b) */
4298 || (pSub1->pPrior && pSub1->op!=TK_ALL) /* (17a) */
4299 || pSub1->pSrc->nSrc<1 /* (17c) */
drhef9f7192020-01-17 19:14:08 +00004300#ifndef SQLITE_OMIT_WINDOWFUNC
drh8d95ed72019-12-30 20:42:17 +00004301 || pSub1->pWin /* (17e) */
drhef9f7192020-01-17 19:14:08 +00004302#endif
danielk197780b3c542008-07-10 17:59:12 +00004303 ){
danielk1977f23329a2008-07-01 14:09:13 +00004304 return 0;
4305 }
drh4b3ac732011-12-10 23:18:32 +00004306 testcase( pSub1->pSrc->nSrc>1 );
danielk1977f23329a2008-07-01 14:09:13 +00004307 }
danielk197749fc1f62008-07-08 17:43:56 +00004308
drhd981e822017-09-29 16:07:56 +00004309 /* Restriction (18). */
danielk197749fc1f62008-07-08 17:43:56 +00004310 if( p->pOrderBy ){
4311 int ii;
4312 for(ii=0; ii<p->pOrderBy->nExpr; ii++){
drhc2acc4e2013-11-15 18:15:19 +00004313 if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
danielk197749fc1f62008-07-08 17:43:56 +00004314 }
4315 }
danielk1977f23329a2008-07-01 14:09:13 +00004316
dande9ed622020-12-16 20:00:46 +00004317 /* Restriction (23) */
4318 if( (p->selFlags & SF_Recursive) ) return 0;
dan964fa262020-12-18 16:13:39 +00004319
4320 if( pSrc->nSrc>1 ){
dan51ddfef2021-03-17 14:29:37 +00004321 if( pParse->nSelect>500 ) return 0;
drh913306a2021-11-26 17:10:18 +00004322 aCsrMap = sqlite3DbMallocZero(db, ((i64)pParse->nTab+1)*sizeof(int));
drhc8d21472021-07-21 15:42:05 +00004323 if( aCsrMap ) aCsrMap[0] = pParse->nTab;
dan964fa262020-12-18 16:13:39 +00004324 }
dande9ed622020-12-16 20:00:46 +00004325 }
drhcdb2f602017-10-04 05:59:54 +00004326
drh7d10d5a2008-08-20 16:35:10 +00004327 /***** If we reach this point, flattening is permitted. *****/
drhfef37762018-07-10 19:48:35 +00004328 SELECTTRACE(1,pParse,p,("flatten %u.%p from term %d\n",
4329 pSub->selId, pSub, iFrom));
drh7d10d5a2008-08-20 16:35:10 +00004330
4331 /* Authorize the subquery */
danielk1977524cc212008-07-02 13:13:51 +00004332 pParse->zAuthContext = pSubitem->zName;
drha2acb0d2012-04-11 23:22:37 +00004333 TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
4334 testcase( i==SQLITE_DENY );
danielk1977524cc212008-07-02 13:13:51 +00004335 pParse->zAuthContext = zSavedAuthContext;
4336
dande9ed622020-12-16 20:00:46 +00004337 /* Delete the transient structures associated with thesubquery */
4338 pSub1 = pSubitem->pSelect;
4339 sqlite3DbFree(db, pSubitem->zDatabase);
4340 sqlite3DbFree(db, pSubitem->zName);
4341 sqlite3DbFree(db, pSubitem->zAlias);
4342 pSubitem->zDatabase = 0;
4343 pSubitem->zName = 0;
4344 pSubitem->zAlias = 0;
4345 pSubitem->pSelect = 0;
drhd44f8b22022-04-07 01:11:13 +00004346 assert( pSubitem->fg.isUsing!=0 || pSubitem->u3.pOn==0 );
dande9ed622020-12-16 20:00:46 +00004347
drh7d10d5a2008-08-20 16:35:10 +00004348 /* If the sub-query is a compound SELECT statement, then (by restrictions
4349 ** 17 and 18 above) it must be a UNION ALL and the parent query must
4350 ** be of the form:
danielk1977f23329a2008-07-01 14:09:13 +00004351 **
4352 ** SELECT <expr-list> FROM (<sub-query>) <where-clause>
4353 **
4354 ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
drha78c22c2008-11-11 18:28:58 +00004355 ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
danielk1977f23329a2008-07-01 14:09:13 +00004356 ** OFFSET clauses and joins them to the left-hand-side of the original
4357 ** using UNION ALL operators. In this case N is the number of simple
4358 ** select statements in the compound sub-query.
drha78c22c2008-11-11 18:28:58 +00004359 **
4360 ** Example:
4361 **
4362 ** SELECT a+1 FROM (
4363 ** SELECT x FROM tab
4364 ** UNION ALL
4365 ** SELECT y FROM tab
4366 ** UNION ALL
4367 ** SELECT abs(z*2) FROM tab2
4368 ** ) WHERE a!=5 ORDER BY 1
4369 **
4370 ** Transformed into:
4371 **
4372 ** SELECT x+1 FROM tab WHERE x+1!=5
4373 ** UNION ALL
4374 ** SELECT y+1 FROM tab WHERE y+1!=5
4375 ** UNION ALL
4376 ** SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
4377 ** ORDER BY 1
4378 **
4379 ** We call this the "compound-subquery flattening".
danielk1977f23329a2008-07-01 14:09:13 +00004380 */
4381 for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
4382 Select *pNew;
4383 ExprList *pOrderBy = p->pOrderBy;
danielk19774b86ef12008-07-01 14:39:35 +00004384 Expr *pLimit = p->pLimit;
danielk1977f23329a2008-07-01 14:09:13 +00004385 Select *pPrior = p->pPrior;
dande9ed622020-12-16 20:00:46 +00004386 Table *pItemTab = pSubitem->pTab;
4387 pSubitem->pTab = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004388 p->pOrderBy = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004389 p->pPrior = 0;
danielk19774b86ef12008-07-01 14:39:35 +00004390 p->pLimit = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00004391 pNew = sqlite3SelectDup(db, p, 0);
danielk19774b86ef12008-07-01 14:39:35 +00004392 p->pLimit = pLimit;
drha78c22c2008-11-11 18:28:58 +00004393 p->pOrderBy = pOrderBy;
drha78c22c2008-11-11 18:28:58 +00004394 p->op = TK_ALL;
dande9ed622020-12-16 20:00:46 +00004395 pSubitem->pTab = pItemTab;
drha78c22c2008-11-11 18:28:58 +00004396 if( pNew==0 ){
drhd227a292014-02-09 18:02:09 +00004397 p->pPrior = pPrior;
drha78c22c2008-11-11 18:28:58 +00004398 }else{
dan51ddfef2021-03-17 14:29:37 +00004399 pNew->selId = ++pParse->nSelect;
drh9da977f2021-04-20 12:14:12 +00004400 if( aCsrMap && ALWAYS(db->mallocFailed==0) ){
dan964fa262020-12-18 16:13:39 +00004401 renumberCursors(pParse, pNew, iFrom, aCsrMap);
4402 }
drha78c22c2008-11-11 18:28:58 +00004403 pNew->pPrior = pPrior;
drhd227a292014-02-09 18:02:09 +00004404 if( pPrior ) pPrior->pNext = pNew;
4405 pNew->pNext = p;
4406 p->pPrior = pNew;
drhe2243d22018-04-23 17:18:03 +00004407 SELECTTRACE(2,pParse,p,("compound-subquery flattener"
drhfef37762018-07-10 19:48:35 +00004408 " creates %u as peer\n",pNew->selId));
drha78c22c2008-11-11 18:28:58 +00004409 }
dande9ed622020-12-16 20:00:46 +00004410 assert( pSubitem->pSelect==0 );
dan964fa262020-12-18 16:13:39 +00004411 }
4412 sqlite3DbFree(db, aCsrMap);
4413 if( db->mallocFailed ){
4414 pSubitem->pSelect = pSub1;
4415 return 1;
danielk1977f23329a2008-07-01 14:09:13 +00004416 }
4417
drha78c22c2008-11-11 18:28:58 +00004418 /* Defer deleting the Table object associated with the
4419 ** subquery until code generation is
4420 ** complete, since there may still exist Expr.pTab entries that
4421 ** refer to the subquery even after flattening. Ticket #3346.
drhccfcbce2009-05-18 15:46:07 +00004422 **
4423 ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
drha78c22c2008-11-11 18:28:58 +00004424 */
drhccfcbce2009-05-18 15:46:07 +00004425 if( ALWAYS(pSubitem->pTab!=0) ){
drha78c22c2008-11-11 18:28:58 +00004426 Table *pTabToDel = pSubitem->pTab;
drh79df7782016-12-14 14:07:35 +00004427 if( pTabToDel->nTabRef==1 ){
dan65a7cd12009-09-01 12:16:01 +00004428 Parse *pToplevel = sqlite3ParseToplevel(pParse);
drhcf3c0782021-01-11 20:37:02 +00004429 sqlite3ParserAddCleanup(pToplevel,
4430 (void(*)(sqlite3*,void*))sqlite3DeleteTable,
4431 pTabToDel);
drh21d4f5b2021-01-12 15:30:01 +00004432 testcase( pToplevel->earlyCleanup );
drha78c22c2008-11-11 18:28:58 +00004433 }else{
drh79df7782016-12-14 14:07:35 +00004434 pTabToDel->nTabRef--;
drha78c22c2008-11-11 18:28:58 +00004435 }
4436 pSubitem->pTab = 0;
4437 }
4438
4439 /* The following loop runs once for each term in a compound-subquery
4440 ** flattening (as described above). If we are doing a different kind
4441 ** of flattening - a flattening other than a compound-subquery flattening -
4442 ** then this loop only runs once.
4443 **
4444 ** This loop moves all of the FROM elements of the subquery into the
4445 ** the FROM clause of the outer query. Before doing this, remember
4446 ** the cursor number for the original outer query FROM element in
4447 ** iParent. The iParent cursor will never be used. Subsequent code
4448 ** will scan expressions looking for iParent references and replace
4449 ** those references with expressions that resolve to the subquery FROM
4450 ** elements we are now copying in.
4451 */
dande9ed622020-12-16 20:00:46 +00004452 pSub = pSub1;
danielk1977f23329a2008-07-01 14:09:13 +00004453 for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
drha78c22c2008-11-11 18:28:58 +00004454 int nSubSrc;
drhea678832008-12-10 19:26:22 +00004455 u8 jointype = 0;
drh79d26582022-04-11 10:38:28 +00004456 u8 ltorj = pSrc->a[iFrom].fg.jointype & JT_LTORJ;
drh55f66b32019-07-16 19:44:32 +00004457 assert( pSub!=0 );
drha78c22c2008-11-11 18:28:58 +00004458 pSubSrc = pSub->pSrc; /* FROM clause of subquery */
4459 nSubSrc = pSubSrc->nSrc; /* Number of terms in subquery FROM clause */
4460 pSrc = pParent->pSrc; /* FROM clause of the outer query */
drhc31c2eb2003-05-02 16:04:17 +00004461
dande9ed622020-12-16 20:00:46 +00004462 if( pParent==p ){
4463 jointype = pSubitem->fg.jointype; /* First time through the loop */
drha78c22c2008-11-11 18:28:58 +00004464 }
dande9ed622020-12-16 20:00:46 +00004465
drha78c22c2008-11-11 18:28:58 +00004466 /* The subquery uses a single slot of the FROM clause of the outer
4467 ** query. If the subquery has more than one element in its FROM clause,
4468 ** then expand the outer query to make space for it to hold all elements
4469 ** of the subquery.
4470 **
4471 ** Example:
4472 **
4473 ** SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
4474 **
4475 ** The outer query has 3 slots in its FROM clause. One slot of the
4476 ** outer query (the middle slot) is used by the subquery. The next
drhd12b6362015-10-11 19:46:59 +00004477 ** block of code will expand the outer query FROM clause to 4 slots.
4478 ** The middle slot is expanded to two slots in order to make space
4479 ** for the two elements in the FROM clause of the subquery.
drha78c22c2008-11-11 18:28:58 +00004480 */
4481 if( nSubSrc>1 ){
drh29c992c2019-01-17 15:40:41 +00004482 pSrc = sqlite3SrcListEnlarge(pParse, pSrc, nSubSrc-1,iFrom+1);
4483 if( pSrc==0 ) break;
4484 pParent->pSrc = pSrc;
drhc31c2eb2003-05-02 16:04:17 +00004485 }
drha78c22c2008-11-11 18:28:58 +00004486
4487 /* Transfer the FROM clause terms from the subquery into the
4488 ** outer query.
4489 */
drhc31c2eb2003-05-02 16:04:17 +00004490 for(i=0; i<nSubSrc; i++){
drhd44f8b22022-04-07 01:11:13 +00004491 SrcItem *pItem = &pSrc->a[i+iFrom];
4492 if( pItem->fg.isUsing ) sqlite3IdListDelete(db, pItem->u3.pUsing);
4493 assert( pItem->fg.isTabFunc==0 );
4494 *pItem = pSubSrc->a[i];
drh79d26582022-04-11 10:38:28 +00004495 pItem->fg.jointype |= ltorj;
drh399c7e22017-04-14 17:18:45 +00004496 iNewParent = pSubSrc->a[i].iCursor;
drhc31c2eb2003-05-02 16:04:17 +00004497 memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
4498 }
drhf7309bc2022-04-12 20:20:54 +00004499 pSrc->a[iFrom].fg.jointype &= JT_LTORJ;
4500 pSrc->a[iFrom].fg.jointype |= jointype | ltorj;
danielk1977f23329a2008-07-01 14:09:13 +00004501
4502 /* Now begin substituting subquery result set expressions for
4503 ** references to the iParent in the outer query.
4504 **
4505 ** Example:
4506 **
4507 ** SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
4508 ** \ \_____________ subquery __________/ /
4509 ** \_____________________ outer query ______________________________/
4510 **
4511 ** We look at every expression in the outer query and every place we see
4512 ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
4513 */
drhb7cbf5c2020-06-15 13:51:34 +00004514 if( pSub->pOrderBy && (pParent->selFlags & SF_NoopOrderBy)==0 ){
dan7c0a4722014-09-20 20:38:48 +00004515 /* At this point, any non-zero iOrderByCol values indicate that the
4516 ** ORDER BY column expression is identical to the iOrderByCol'th
4517 ** expression returned by SELECT statement pSub. Since these values
4518 ** do not necessarily correspond to columns in SELECT statement pParent,
4519 ** zero them before transfering the ORDER BY clause.
4520 **
4521 ** Not doing this may cause an error if a subsequent call to this
4522 ** function attempts to flatten a compound sub-query into pParent
4523 ** (the only way this can happen is if the compound sub-query is
4524 ** currently part of pSub->pSrc). See ticket [d11a6e908f]. */
4525 ExprList *pOrderBy = pSub->pOrderBy;
4526 for(i=0; i<pOrderBy->nExpr; i++){
4527 pOrderBy->a[i].u.x.iOrderByCol = 0;
4528 }
danielk1977f23329a2008-07-01 14:09:13 +00004529 assert( pParent->pOrderBy==0 );
dan7c0a4722014-09-20 20:38:48 +00004530 pParent->pOrderBy = pOrderBy;
danielk1977f23329a2008-07-01 14:09:13 +00004531 pSub->pOrderBy = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004532 }
drh11df7d22018-12-06 19:15:36 +00004533 pWhere = pSub->pWhere;
4534 pSub->pWhere = 0;
drhc133bab2022-04-11 20:15:52 +00004535 if( isOuterJoin>0 ){
drh3a6e4c52022-04-11 12:38:06 +00004536 sqlite3SetJoinExpr(pWhere, iNewParent, EP_FromJoin);
drh399c7e22017-04-14 17:18:45 +00004537 }
dancd653a32020-06-13 21:24:40 +00004538 if( pWhere ){
4539 if( pParent->pWhere ){
4540 pParent->pWhere = sqlite3PExpr(pParse, TK_AND, pWhere, pParent->pWhere);
4541 }else{
4542 pParent->pWhere = pWhere;
4543 }
4544 }
danc3becdd2017-03-13 14:30:40 +00004545 if( db->mallocFailed==0 ){
drh46967de2017-04-14 12:39:37 +00004546 SubstContext x;
4547 x.pParse = pParse;
4548 x.iTable = iParent;
drh399c7e22017-04-14 17:18:45 +00004549 x.iNewTable = iNewParent;
drhc133bab2022-04-11 20:15:52 +00004550 x.isOuterJoin = isOuterJoin;
drh46967de2017-04-14 12:39:37 +00004551 x.pEList = pSub->pEList;
4552 substSelect(&x, pParent, 0);
danc3becdd2017-03-13 14:30:40 +00004553 }
danielk1977f23329a2008-07-01 14:09:13 +00004554
drh7cd5e852019-05-29 17:22:38 +00004555 /* The flattened query is a compound if either the inner or the
4556 ** outer query is a compound. */
4557 pParent->selFlags |= pSub->selFlags & SF_Compound;
4558 assert( (pSub->selFlags & SF_Distinct)==0 ); /* restriction (17b) */
danielk1977f23329a2008-07-01 14:09:13 +00004559
4560 /*
4561 ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
4562 **
4563 ** One is tempted to try to add a and b to combine the limits. But this
4564 ** does not work if either limit is negative.
4565 */
4566 if( pSub->pLimit ){
4567 pParent->pLimit = pSub->pLimit;
4568 pSub->pLimit = 0;
4569 }
drh2aee5142020-03-21 00:05:53 +00004570
4571 /* Recompute the SrcList_item.colUsed masks for the flattened
4572 ** tables. */
4573 for(i=0; i<nSubSrc; i++){
4574 recomputeColumnsUsed(pParent, &pSrc->a[i+iFrom]);
4575 }
drhdf199a22002-06-14 22:38:41 +00004576 }
drh8c74a8c2002-08-25 19:20:40 +00004577
drhc31c2eb2003-05-02 16:04:17 +00004578 /* Finially, delete what is left of the subquery and return
4579 ** success.
4580 */
drh89636622020-06-07 17:33:18 +00004581 sqlite3AggInfoPersistWalkerInit(&w, pParse);
4582 sqlite3WalkSelect(&w,pSub1);
drh633e6d52008-07-28 19:34:53 +00004583 sqlite3SelectDelete(db, pSub1);
danielk1977f23329a2008-07-01 14:09:13 +00004584
drh5e431be2022-04-06 11:08:38 +00004585#if TREETRACE_ENABLED
4586 if( sqlite3TreeTrace & 0x100 ){
drhbc8edba2015-06-05 20:27:26 +00004587 SELECTTRACE(0x100,pParse,p,("After flattening:\n"));
drhc90713d2014-09-30 13:46:49 +00004588 sqlite3TreeViewSelect(0, p, 0);
4589 }
4590#endif
4591
drh832508b2002-03-02 17:04:07 +00004592 return 1;
4593}
shane3514b6f2008-07-22 05:00:55 +00004594#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
drh1350b032002-02-27 19:00:20 +00004595
drh660ee552018-07-26 21:16:53 +00004596/*
drh8e5bfed2018-10-25 14:15:37 +00004597** A structure to keep track of all of the column values that are fixed to
drhefad2e22018-07-27 16:57:11 +00004598** a known value due to WHERE clause constraints of the form COLUMN=VALUE.
drh660ee552018-07-26 21:16:53 +00004599*/
4600typedef struct WhereConst WhereConst;
4601struct WhereConst {
drhefad2e22018-07-27 16:57:11 +00004602 Parse *pParse; /* Parsing context */
drh75016052021-06-10 14:36:23 +00004603 u8 *pOomFault; /* Pointer to pParse->db->mallocFailed */
drh660ee552018-07-26 21:16:53 +00004604 int nConst; /* Number for COLUMN=CONSTANT terms */
4605 int nChng; /* Number of times a constant is propagated */
dan40b82f92021-05-26 18:51:57 +00004606 int bHasAffBlob; /* At least one column in apExpr[] as affinity BLOB */
drhefad2e22018-07-27 16:57:11 +00004607 Expr **apExpr; /* [i*2] is COLUMN and [i*2+1] is VALUE */
drh660ee552018-07-26 21:16:53 +00004608};
drh69b72d52015-06-01 20:28:03 +00004609
drh660ee552018-07-26 21:16:53 +00004610/*
drh8e5bfed2018-10-25 14:15:37 +00004611** Add a new entry to the pConst object. Except, do not add duplicate
drhf8f76d62020-01-08 04:36:01 +00004612** pColumn entires. Also, do not add if doing so would not be appropriate.
4613**
4614** The caller guarantees the pColumn is a column and pValue is a constant.
4615** This routine has to do some additional checks before completing the
4616** insert.
drh660ee552018-07-26 21:16:53 +00004617*/
4618static void constInsert(
drhf8f76d62020-01-08 04:36:01 +00004619 WhereConst *pConst, /* The WhereConst into which we are inserting */
4620 Expr *pColumn, /* The COLUMN part of the constraint */
4621 Expr *pValue, /* The VALUE part of the constraint */
4622 Expr *pExpr /* Overall expression: COLUMN=VALUE or VALUE=COLUMN */
drh660ee552018-07-26 21:16:53 +00004623){
drh8e5bfed2018-10-25 14:15:37 +00004624 int i;
4625 assert( pColumn->op==TK_COLUMN );
drhf8f76d62020-01-08 04:36:01 +00004626 assert( sqlite3ExprIsConstant(pValue) );
4627
drhfdfd45a2020-02-13 22:12:35 +00004628 if( ExprHasProperty(pColumn, EP_FixedCol) ) return;
4629 if( sqlite3ExprAffinity(pValue)!=0 ) return;
drhf8f76d62020-01-08 04:36:01 +00004630 if( !sqlite3IsBinary(sqlite3ExprCompareCollSeq(pConst->pParse,pExpr)) ){
4631 return;
4632 }
drh8e5bfed2018-10-25 14:15:37 +00004633
4634 /* 2018-10-25 ticket [cf5ed20f]
4635 ** Make sure the same pColumn is not inserted more than once */
4636 for(i=0; i<pConst->nConst; i++){
drh7be5e3d2020-01-09 20:33:13 +00004637 const Expr *pE2 = pConst->apExpr[i*2];
4638 assert( pE2->op==TK_COLUMN );
4639 if( pE2->iTable==pColumn->iTable
4640 && pE2->iColumn==pColumn->iColumn
drh8e5bfed2018-10-25 14:15:37 +00004641 ){
4642 return; /* Already present. Return without doing anything. */
4643 }
4644 }
dan40b82f92021-05-26 18:51:57 +00004645 if( sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4646 pConst->bHasAffBlob = 1;
4647 }
drh9cbf4f32018-07-27 20:01:00 +00004648
drh660ee552018-07-26 21:16:53 +00004649 pConst->nConst++;
drhefad2e22018-07-27 16:57:11 +00004650 pConst->apExpr = sqlite3DbReallocOrFree(pConst->pParse->db, pConst->apExpr,
drh660ee552018-07-26 21:16:53 +00004651 pConst->nConst*2*sizeof(Expr*));
4652 if( pConst->apExpr==0 ){
4653 pConst->nConst = 0;
4654 }else{
4655 pConst->apExpr[pConst->nConst*2-2] = pColumn;
4656 pConst->apExpr[pConst->nConst*2-1] = pValue;
4657 }
4658}
4659
4660/*
drhefad2e22018-07-27 16:57:11 +00004661** Find all terms of COLUMN=VALUE or VALUE=COLUMN in pExpr where VALUE
4662** is a constant expression and where the term must be true because it
4663** is part of the AND-connected terms of the expression. For each term
4664** found, add it to the pConst structure.
drh660ee552018-07-26 21:16:53 +00004665*/
4666static void findConstInWhere(WhereConst *pConst, Expr *pExpr){
drhefad2e22018-07-27 16:57:11 +00004667 Expr *pRight, *pLeft;
drhb775c972021-05-14 14:26:57 +00004668 if( NEVER(pExpr==0) ) return;
drh660ee552018-07-26 21:16:53 +00004669 if( ExprHasProperty(pExpr, EP_FromJoin) ) return;
4670 if( pExpr->op==TK_AND ){
4671 findConstInWhere(pConst, pExpr->pRight);
4672 findConstInWhere(pConst, pExpr->pLeft);
4673 return;
4674 }
4675 if( pExpr->op!=TK_EQ ) return;
drhefad2e22018-07-27 16:57:11 +00004676 pRight = pExpr->pRight;
4677 pLeft = pExpr->pLeft;
4678 assert( pRight!=0 );
4679 assert( pLeft!=0 );
drhf8f76d62020-01-08 04:36:01 +00004680 if( pRight->op==TK_COLUMN && sqlite3ExprIsConstant(pLeft) ){
4681 constInsert(pConst,pRight,pLeft,pExpr);
4682 }
4683 if( pLeft->op==TK_COLUMN && sqlite3ExprIsConstant(pRight) ){
4684 constInsert(pConst,pLeft,pRight,pExpr);
drh660ee552018-07-26 21:16:53 +00004685 }
4686}
4687
4688/*
dan40b82f92021-05-26 18:51:57 +00004689** This is a helper function for Walker callback propagateConstantExprRewrite().
4690**
4691** Argument pExpr is a candidate expression to be replaced by a value. If
4692** pExpr is equivalent to one of the columns named in pWalker->u.pConst,
4693** then overwrite it with the corresponding value. Except, do not do so
4694** if argument bIgnoreAffBlob is non-zero and the affinity of pExpr
4695** is SQLITE_AFF_BLOB.
drh660ee552018-07-26 21:16:53 +00004696*/
dan40b82f92021-05-26 18:51:57 +00004697static int propagateConstantExprRewriteOne(
4698 WhereConst *pConst,
4699 Expr *pExpr,
4700 int bIgnoreAffBlob
4701){
drh660ee552018-07-26 21:16:53 +00004702 int i;
drh75016052021-06-10 14:36:23 +00004703 if( pConst->pOomFault[0] ) return WRC_Prune;
drh660ee552018-07-26 21:16:53 +00004704 if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
drhbe0330e2020-01-16 17:53:24 +00004705 if( ExprHasProperty(pExpr, EP_FixedCol|EP_FromJoin) ){
4706 testcase( ExprHasProperty(pExpr, EP_FixedCol) );
4707 testcase( ExprHasProperty(pExpr, EP_FromJoin) );
4708 return WRC_Continue;
4709 }
drh660ee552018-07-26 21:16:53 +00004710 for(i=0; i<pConst->nConst; i++){
4711 Expr *pColumn = pConst->apExpr[i*2];
4712 if( pColumn==pExpr ) continue;
4713 if( pColumn->iTable!=pExpr->iTable ) continue;
4714 if( pColumn->iColumn!=pExpr->iColumn ) continue;
dan40b82f92021-05-26 18:51:57 +00004715 if( bIgnoreAffBlob && sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4716 break;
4717 }
drhefad2e22018-07-27 16:57:11 +00004718 /* A match is found. Add the EP_FixedCol property */
drh660ee552018-07-26 21:16:53 +00004719 pConst->nChng++;
4720 ExprClearProperty(pExpr, EP_Leaf);
drhefad2e22018-07-27 16:57:11 +00004721 ExprSetProperty(pExpr, EP_FixedCol);
4722 assert( pExpr->pLeft==0 );
4723 pExpr->pLeft = sqlite3ExprDup(pConst->pParse->db, pConst->apExpr[i*2+1], 0);
drh75016052021-06-10 14:36:23 +00004724 if( pConst->pParse->db->mallocFailed ) return WRC_Prune;
drh660ee552018-07-26 21:16:53 +00004725 break;
4726 }
4727 return WRC_Prune;
4728}
4729
4730/*
dan40b82f92021-05-26 18:51:57 +00004731** This is a Walker expression callback. pExpr is a node from the WHERE
4732** clause of a SELECT statement. This function examines pExpr to see if
4733** any substitutions based on the contents of pWalker->u.pConst should
4734** be made to pExpr or its immediate children.
4735**
4736** A substitution is made if:
4737**
4738** + pExpr is a column with an affinity other than BLOB that matches
4739** one of the columns in pWalker->u.pConst, or
4740**
4741** + pExpr is a binary comparison operator (=, <=, >=, <, >) that
4742** uses an affinity other than TEXT and one of its immediate
4743** children is a column that matches one of the columns in
4744** pWalker->u.pConst.
4745*/
4746static int propagateConstantExprRewrite(Walker *pWalker, Expr *pExpr){
4747 WhereConst *pConst = pWalker->u.pConst;
drha8ed5152021-05-26 19:52:21 +00004748 assert( TK_GT==TK_EQ+1 );
4749 assert( TK_LE==TK_EQ+2 );
4750 assert( TK_LT==TK_EQ+3 );
4751 assert( TK_GE==TK_EQ+4 );
dan40b82f92021-05-26 18:51:57 +00004752 if( pConst->bHasAffBlob ){
drha8ed5152021-05-26 19:52:21 +00004753 if( (pExpr->op>=TK_EQ && pExpr->op<=TK_GE)
dan40b82f92021-05-26 18:51:57 +00004754 || pExpr->op==TK_IS
4755 ){
4756 propagateConstantExprRewriteOne(pConst, pExpr->pLeft, 0);
drh75016052021-06-10 14:36:23 +00004757 if( pConst->pOomFault[0] ) return WRC_Prune;
dan40b82f92021-05-26 18:51:57 +00004758 if( sqlite3ExprAffinity(pExpr->pLeft)!=SQLITE_AFF_TEXT ){
4759 propagateConstantExprRewriteOne(pConst, pExpr->pRight, 0);
4760 }
4761 }
4762 }
4763 return propagateConstantExprRewriteOne(pConst, pExpr, pConst->bHasAffBlob);
4764}
4765
4766/*
drh660ee552018-07-26 21:16:53 +00004767** The WHERE-clause constant propagation optimization.
4768**
4769** If the WHERE clause contains terms of the form COLUMN=CONSTANT or
drh97bffe62020-01-08 00:39:37 +00004770** CONSTANT=COLUMN that are top-level AND-connected terms that are not
4771** part of a ON clause from a LEFT JOIN, then throughout the query
4772** replace all other occurrences of COLUMN with CONSTANT.
drh660ee552018-07-26 21:16:53 +00004773**
4774** For example, the query:
4775**
4776** SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=t1.a AND t3.c=t2.b
4777**
4778** Is transformed into
4779**
4780** SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=39 AND t3.c=39
4781**
4782** Return true if any transformations where made and false if not.
drhefad2e22018-07-27 16:57:11 +00004783**
4784** Implementation note: Constant propagation is tricky due to affinity
4785** and collating sequence interactions. Consider this example:
4786**
4787** CREATE TABLE t1(a INT,b TEXT);
4788** INSERT INTO t1 VALUES(123,'0123');
4789** SELECT * FROM t1 WHERE a=123 AND b=a;
4790** SELECT * FROM t1 WHERE a=123 AND b=123;
4791**
4792** The two SELECT statements above should return different answers. b=a
4793** is alway true because the comparison uses numeric affinity, but b=123
4794** is false because it uses text affinity and '0123' is not the same as '123'.
4795** To work around this, the expression tree is not actually changed from
4796** "b=a" to "b=123" but rather the "a" in "b=a" is tagged with EP_FixedCol
4797** and the "123" value is hung off of the pLeft pointer. Code generator
4798** routines know to generate the constant "123" instead of looking up the
4799** column value. Also, to avoid collation problems, this optimization is
4800** only attempted if the "a=123" term uses the default BINARY collation.
drh342cb332021-05-27 14:09:01 +00004801**
4802** 2021-05-25 forum post 6a06202608: Another troublesome case is...
4803**
4804** CREATE TABLE t1(x);
4805** INSERT INTO t1 VALUES(10.0);
4806** SELECT 1 FROM t1 WHERE x=10 AND x LIKE 10;
4807**
4808** The query should return no rows, because the t1.x value is '10.0' not '10'
4809** and '10.0' is not LIKE '10'. But if we are not careful, the first WHERE
4810** term "x=10" will cause the second WHERE term to become "10 LIKE 10",
4811** resulting in a false positive. To avoid this, constant propagation for
4812** columns with BLOB affinity is only allowed if the constant is used with
4813** operators ==, <=, <, >=, >, or IS in a way that will cause the correct
4814** type conversions to occur. See logic associated with the bHasAffBlob flag
4815** for details.
drh660ee552018-07-26 21:16:53 +00004816*/
4817static int propagateConstants(
4818 Parse *pParse, /* The parsing context */
4819 Select *p /* The query in which to propagate constants */
4820){
4821 WhereConst x;
4822 Walker w;
4823 int nChng = 0;
drhefad2e22018-07-27 16:57:11 +00004824 x.pParse = pParse;
drh75016052021-06-10 14:36:23 +00004825 x.pOomFault = &pParse->db->mallocFailed;
drh660ee552018-07-26 21:16:53 +00004826 do{
4827 x.nConst = 0;
4828 x.nChng = 0;
4829 x.apExpr = 0;
dan40b82f92021-05-26 18:51:57 +00004830 x.bHasAffBlob = 0;
drh660ee552018-07-26 21:16:53 +00004831 findConstInWhere(&x, p->pWhere);
4832 if( x.nConst ){
4833 memset(&w, 0, sizeof(w));
4834 w.pParse = pParse;
4835 w.xExprCallback = propagateConstantExprRewrite;
4836 w.xSelectCallback = sqlite3SelectWalkNoop;
4837 w.xSelectCallback2 = 0;
4838 w.walkerDepth = 0;
4839 w.u.pConst = &x;
drhefad2e22018-07-27 16:57:11 +00004840 sqlite3WalkExpr(&w, p->pWhere);
4841 sqlite3DbFree(x.pParse->db, x.apExpr);
drh660ee552018-07-26 21:16:53 +00004842 nChng += x.nChng;
4843 }
4844 }while( x.nChng );
4845 return nChng;
4846}
drh69b72d52015-06-01 20:28:03 +00004847
4848#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
dan903fdd42021-02-22 20:56:13 +00004849# if !defined(SQLITE_OMIT_WINDOWFUNC)
4850/*
4851** This function is called to determine whether or not it is safe to
4852** push WHERE clause expression pExpr down to FROM clause sub-query
4853** pSubq, which contains at least one window function. Return 1
4854** if it is safe and the expression should be pushed down, or 0
4855** otherwise.
4856**
4857** It is only safe to push the expression down if it consists only
4858** of constants and copies of expressions that appear in the PARTITION
4859** BY clause of all window function used by the sub-query. It is safe
4860** to filter out entire partitions, but not rows within partitions, as
4861** this may change the results of the window functions.
4862**
4863** At the time this function is called it is guaranteed that
4864**
4865** * the sub-query uses only one distinct window frame, and
4866** * that the window frame has a PARTITION BY clase.
4867*/
4868static int pushDownWindowCheck(Parse *pParse, Select *pSubq, Expr *pExpr){
4869 assert( pSubq->pWin->pPartition );
4870 assert( (pSubq->selFlags & SF_MultiPart)==0 );
4871 assert( pSubq->pPrior==0 );
4872 return sqlite3ExprIsConstantOrGroupBy(pParse, pExpr, pSubq->pWin->pPartition);
4873}
4874# endif /* SQLITE_OMIT_WINDOWFUNC */
4875#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4876
4877#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh69b72d52015-06-01 20:28:03 +00004878/*
4879** Make copies of relevant WHERE clause terms of the outer query into
4880** the WHERE clause of subquery. Example:
4881**
4882** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1) WHERE x=5 AND y=10;
4883**
4884** Transformed into:
4885**
4886** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1 WHERE a=5 AND c-d=10)
4887** WHERE x=5 AND y=10;
4888**
4889** The hope is that the terms added to the inner query will make it more
4890** efficient.
4891**
4892** Do not attempt this optimization if:
4893**
drh25c221e2017-09-29 22:13:24 +00004894** (1) (** This restriction was removed on 2017-09-29. We used to
4895** disallow this optimization for aggregate subqueries, but now
drh67cc51a2017-09-30 11:47:06 +00004896** it is allowed by putting the extra terms on the HAVING clause.
4897** The added HAVING clause is pointless if the subquery lacks
4898** a GROUP BY clause. But such a HAVING clause is also harmless
4899** so there does not appear to be any reason to add extra logic
4900** to suppress it. **)
drh69b72d52015-06-01 20:28:03 +00004901**
4902** (2) The inner query is the recursive part of a common table expression.
4903**
4904** (3) The inner query has a LIMIT clause (since the changes to the WHERE
dance103732018-06-23 07:59:39 +00004905** clause would change the meaning of the LIMIT).
drh69b72d52015-06-01 20:28:03 +00004906**
drh6a9b9522018-03-27 15:13:43 +00004907** (4) The inner query is the right operand of a LEFT JOIN and the
4908** expression to be pushed down does not come from the ON clause
4909** on that LEFT JOIN.
drh69b72d52015-06-01 20:28:03 +00004910**
drh38978dd2015-08-22 01:32:29 +00004911** (5) The WHERE clause expression originates in the ON or USING clause
drh7fbb1012018-03-21 01:59:46 +00004912** of a LEFT JOIN where iCursor is not the right-hand table of that
4913** left join. An example:
4914**
4915** SELECT *
4916** FROM (SELECT 1 AS a1 UNION ALL SELECT 2) AS aa
4917** JOIN (SELECT 1 AS b2 UNION ALL SELECT 2) AS bb ON (a1=b2)
4918** LEFT JOIN (SELECT 8 AS c3 UNION ALL SELECT 9) AS cc ON (b2=2);
4919**
4920** The correct answer is three rows: (1,1,NULL),(2,2,8),(2,2,9).
4921** But if the (b2=2) term were to be pushed down into the bb subquery,
4922** then the (1,1,NULL) row would be suppressed.
drh38978dd2015-08-22 01:32:29 +00004923**
dan903fdd42021-02-22 20:56:13 +00004924** (6) Window functions make things tricky as changes to the WHERE clause
4925** of the inner query could change the window over which window
4926** functions are calculated. Therefore, do not attempt the optimization
4927** if:
4928**
4929** (6a) The inner query uses multiple incompatible window partitions.
4930**
4931** (6b) The inner query is a compound and uses window-functions.
4932**
4933** (6c) The WHERE clause does not consist entirely of constants and
4934** copies of expressions found in the PARTITION BY clause of
4935** all window-functions used by the sub-query. It is safe to
4936** filter out entire partitions, as this does not change the
4937** window over which any window-function is calculated.
dance103732018-06-23 07:59:39 +00004938**
drh745912e2021-02-22 03:04:25 +00004939** (7) The inner query is a Common Table Expression (CTE) that should
4940** be materialized. (This restriction is implemented in the calling
4941** routine.)
4942**
drh69b72d52015-06-01 20:28:03 +00004943** Return 0 if no changes are made and non-zero if one or more WHERE clause
4944** terms are duplicated into the subquery.
4945*/
4946static int pushDownWhereTerms(
dan44c56042016-12-07 15:38:37 +00004947 Parse *pParse, /* Parse context (for malloc() and error reporting) */
drh69b72d52015-06-01 20:28:03 +00004948 Select *pSubq, /* The subquery whose WHERE clause is to be augmented */
4949 Expr *pWhere, /* The WHERE clause of the outer query */
drh6a9b9522018-03-27 15:13:43 +00004950 int iCursor, /* Cursor number of the subquery */
4951 int isLeftJoin /* True if pSubq is the right term of a LEFT JOIN */
drh69b72d52015-06-01 20:28:03 +00004952){
4953 Expr *pNew;
4954 int nChng = 0;
4955 if( pWhere==0 ) return 0;
dan903fdd42021-02-22 20:56:13 +00004956 if( pSubq->selFlags & (SF_Recursive|SF_MultiPart) ) return 0;
drh508e2d02017-09-30 01:25:04 +00004957
dance103732018-06-23 07:59:39 +00004958#ifndef SQLITE_OMIT_WINDOWFUNC
dan903fdd42021-02-22 20:56:13 +00004959 if( pSubq->pPrior ){
4960 Select *pSel;
4961 for(pSel=pSubq; pSel; pSel=pSel->pPrior){
4962 if( pSel->pWin ) return 0; /* restriction (6b) */
4963 }
4964 }else{
4965 if( pSubq->pWin && pSubq->pWin->pPartition==0 ) return 0;
danf65e3792020-06-10 10:58:15 +00004966 }
dance103732018-06-23 07:59:39 +00004967#endif
4968
drh508e2d02017-09-30 01:25:04 +00004969#ifdef SQLITE_DEBUG
4970 /* Only the first term of a compound can have a WITH clause. But make
4971 ** sure no other terms are marked SF_Recursive in case something changes
4972 ** in the future.
4973 */
4974 {
4975 Select *pX;
4976 for(pX=pSubq; pX; pX=pX->pPrior){
4977 assert( (pX->selFlags & (SF_Recursive))==0 );
drhb1ec87a2016-04-25 02:20:10 +00004978 }
drh69b72d52015-06-01 20:28:03 +00004979 }
drh508e2d02017-09-30 01:25:04 +00004980#endif
4981
drh69b72d52015-06-01 20:28:03 +00004982 if( pSubq->pLimit!=0 ){
drhb1ec87a2016-04-25 02:20:10 +00004983 return 0; /* restriction (3) */
drh69b72d52015-06-01 20:28:03 +00004984 }
4985 while( pWhere->op==TK_AND ){
drh6a9b9522018-03-27 15:13:43 +00004986 nChng += pushDownWhereTerms(pParse, pSubq, pWhere->pRight,
4987 iCursor, isLeftJoin);
drh69b72d52015-06-01 20:28:03 +00004988 pWhere = pWhere->pLeft;
4989 }
drh6a9b9522018-03-27 15:13:43 +00004990 if( isLeftJoin
4991 && (ExprHasProperty(pWhere,EP_FromJoin)==0
drhd1985262022-04-11 11:25:28 +00004992 || pWhere->w.iJoin!=iCursor)
drh6a9b9522018-03-27 15:13:43 +00004993 ){
4994 return 0; /* restriction (4) */
4995 }
drh796588a2022-02-05 21:49:47 +00004996 if( ExprHasProperty(pWhere,EP_FromJoin)
drhd1985262022-04-11 11:25:28 +00004997 && pWhere->w.iJoin!=iCursor
drh796588a2022-02-05 21:49:47 +00004998 ){
drh7fbb1012018-03-21 01:59:46 +00004999 return 0; /* restriction (5) */
5000 }
drh69b72d52015-06-01 20:28:03 +00005001 if( sqlite3ExprIsTableConstant(pWhere, iCursor) ){
5002 nChng++;
drh8794c682021-02-13 16:39:24 +00005003 pSubq->selFlags |= SF_PushDown;
drh69b72d52015-06-01 20:28:03 +00005004 while( pSubq ){
drh46967de2017-04-14 12:39:37 +00005005 SubstContext x;
dan44c56042016-12-07 15:38:37 +00005006 pNew = sqlite3ExprDup(pParse->db, pWhere, 0);
drh7fbb1012018-03-21 01:59:46 +00005007 unsetJoinExpr(pNew, -1);
drh46967de2017-04-14 12:39:37 +00005008 x.pParse = pParse;
5009 x.iTable = iCursor;
drh399c7e22017-04-14 17:18:45 +00005010 x.iNewTable = iCursor;
drhc133bab2022-04-11 20:15:52 +00005011 x.isOuterJoin = 0;
drh46967de2017-04-14 12:39:37 +00005012 x.pEList = pSubq->pEList;
5013 pNew = substExpr(&x, pNew);
dan903fdd42021-02-22 20:56:13 +00005014#ifndef SQLITE_OMIT_WINDOWFUNC
5015 if( pSubq->pWin && 0==pushDownWindowCheck(pParse, pSubq, pNew) ){
5016 /* Restriction 6c has prevented push-down in this case */
5017 sqlite3ExprDelete(pParse->db, pNew);
5018 nChng--;
5019 break;
5020 }
5021#endif
drh25c221e2017-09-29 22:13:24 +00005022 if( pSubq->selFlags & SF_Aggregate ){
drhd5c851c2019-04-19 13:38:34 +00005023 pSubq->pHaving = sqlite3ExprAnd(pParse, pSubq->pHaving, pNew);
drh25c221e2017-09-29 22:13:24 +00005024 }else{
drhd5c851c2019-04-19 13:38:34 +00005025 pSubq->pWhere = sqlite3ExprAnd(pParse, pSubq->pWhere, pNew);
drh25c221e2017-09-29 22:13:24 +00005026 }
drh69b72d52015-06-01 20:28:03 +00005027 pSubq = pSubq->pPrior;
5028 }
5029 }
5030 return nChng;
5031}
5032#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
5033
drh1350b032002-02-27 19:00:20 +00005034/*
drh47d9f832017-10-26 20:04:28 +00005035** The pFunc is the only aggregate function in the query. Check to see
5036** if the query is a candidate for the min/max optimization.
danielk1977a9d1ccb2008-01-05 17:39:29 +00005037**
drh47d9f832017-10-26 20:04:28 +00005038** If the query is a candidate for the min/max optimization, then set
5039** *ppMinMax to be an ORDER BY clause to be used for the optimization
5040** and return either WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX depending on
5041** whether pFunc is a min() or max() function.
danielk1977738bdcf2008-01-07 10:16:40 +00005042**
drh47d9f832017-10-26 20:04:28 +00005043** If the query is not a candidate for the min/max optimization, return
5044** WHERE_ORDERBY_NORMAL (which must be zero).
dan4ac391f2012-12-13 16:37:10 +00005045**
drh47d9f832017-10-26 20:04:28 +00005046** This routine must be called after aggregate functions have been
5047** located but before their arguments have been subjected to aggregate
5048** analysis.
danielk1977a9d1ccb2008-01-05 17:39:29 +00005049*/
drh47d9f832017-10-26 20:04:28 +00005050static u8 minMaxQuery(sqlite3 *db, Expr *pFunc, ExprList **ppMinMax){
5051 int eRet = WHERE_ORDERBY_NORMAL; /* Return value */
drha4eeccd2021-10-07 17:43:30 +00005052 ExprList *pEList; /* Arguments to agg function */
drh47d9f832017-10-26 20:04:28 +00005053 const char *zFunc; /* Name of aggregate function pFunc */
5054 ExprList *pOrderBy;
drhbe284e42020-02-27 16:21:39 +00005055 u8 sortFlags = 0;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005056
drh47d9f832017-10-26 20:04:28 +00005057 assert( *ppMinMax==0 );
5058 assert( pFunc->op==TK_AGG_FUNCTION );
dan4f9adee2019-07-13 16:22:50 +00005059 assert( !IsWindowFunc(pFunc) );
drha4eeccd2021-10-07 17:43:30 +00005060 assert( ExprUseXList(pFunc) );
5061 pEList = pFunc->x.pList;
drhaf7b7652021-01-13 19:28:17 +00005062 if( pEList==0
5063 || pEList->nExpr!=1
5064 || ExprHasProperty(pFunc, EP_WinFunc)
5065 || OptimizationDisabled(db, SQLITE_MinMaxOpt)
5066 ){
dan6ba7ab02019-07-02 11:56:47 +00005067 return eRet;
5068 }
drhf9751072021-10-07 13:40:29 +00005069 assert( !ExprHasProperty(pFunc, EP_IntValue) );
drh47d9f832017-10-26 20:04:28 +00005070 zFunc = pFunc->u.zToken;
5071 if( sqlite3StrICmp(zFunc, "min")==0 ){
5072 eRet = WHERE_ORDERBY_MIN;
dan67e2bb92020-02-27 15:07:16 +00005073 if( sqlite3ExprCanBeNull(pEList->a[0].pExpr) ){
5074 sortFlags = KEYINFO_ORDER_BIGNULL;
5075 }
drh47d9f832017-10-26 20:04:28 +00005076 }else if( sqlite3StrICmp(zFunc, "max")==0 ){
5077 eRet = WHERE_ORDERBY_MAX;
dan5b32bdf2019-08-17 15:47:32 +00005078 sortFlags = KEYINFO_ORDER_DESC;
drh47d9f832017-10-26 20:04:28 +00005079 }else{
5080 return eRet;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005081 }
drh47d9f832017-10-26 20:04:28 +00005082 *ppMinMax = pOrderBy = sqlite3ExprListDup(db, pEList, 0);
5083 assert( pOrderBy!=0 || db->mallocFailed );
dan5b32bdf2019-08-17 15:47:32 +00005084 if( pOrderBy ) pOrderBy->a[0].sortFlags = sortFlags;
dan4ac391f2012-12-13 16:37:10 +00005085 return eRet;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005086}
5087
5088/*
danielk1977a5533162009-02-24 10:01:51 +00005089** The select statement passed as the first argument is an aggregate query.
peter.d.reid60ec9142014-09-06 16:39:46 +00005090** The second argument is the associated aggregate-info object. This
danielk1977a5533162009-02-24 10:01:51 +00005091** function tests if the SELECT is of the form:
5092**
5093** SELECT count(*) FROM <tbl>
5094**
5095** where table is a database table, not a sub-select or view. If the query
5096** does match this pattern, then a pointer to the Table object representing
drha1c4c3c2021-11-05 11:52:33 +00005097** <tbl> is returned. Otherwise, NULL is returned.
5098**
drhe574a922021-11-26 15:08:55 +00005099** This routine checks to see if it is safe to use the count optimization.
5100** A correct answer is still obtained (though perhaps more slowly) if
5101** this routine returns NULL when it could have returned a table pointer.
5102** But returning the pointer when NULL should have been returned can
5103** result in incorrect answers and/or crashes. So, when in doubt, return NULL.
danielk1977a5533162009-02-24 10:01:51 +00005104*/
5105static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
5106 Table *pTab;
5107 Expr *pExpr;
5108
5109 assert( !p->pGroupBy );
5110
drha1c4c3c2021-11-05 11:52:33 +00005111 if( p->pWhere
5112 || p->pEList->nExpr!=1
5113 || p->pSrc->nSrc!=1
5114 || p->pSrc->a[0].pSelect
5115 || pAggInfo->nFunc!=1
danielk1977a5533162009-02-24 10:01:51 +00005116 ){
5117 return 0;
5118 }
danielk1977a5533162009-02-24 10:01:51 +00005119 pTab = p->pSrc->a[0].pTab;
drha1c4c3c2021-11-05 11:52:33 +00005120 assert( pTab!=0 );
5121 assert( !IsView(pTab) );
5122 if( !IsOrdinaryTable(pTab) ) return 0;
danielk1977a5533162009-02-24 10:01:51 +00005123 pExpr = p->pEList->a[0].pExpr;
drha1c4c3c2021-11-05 11:52:33 +00005124 assert( pExpr!=0 );
danielk1977a5533162009-02-24 10:01:51 +00005125 if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
dan8745f8a2021-11-15 14:11:23 +00005126 if( pExpr->pAggInfo!=pAggInfo ) return 0;
drhd36e1042013-09-06 13:10:12 +00005127 if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
drha1c4c3c2021-11-05 11:52:33 +00005128 assert( pAggInfo->aFunc[0].pFExpr==pExpr );
5129 testcase( ExprHasProperty(pExpr, EP_Distinct) );
5130 testcase( ExprHasProperty(pExpr, EP_WinFunc) );
dan4f9adee2019-07-13 16:22:50 +00005131 if( ExprHasProperty(pExpr, EP_Distinct|EP_WinFunc) ) return 0;
danielk1977a5533162009-02-24 10:01:51 +00005132
5133 return pTab;
5134}
5135
5136/*
danielk1977b1c685b2008-10-06 16:18:39 +00005137** If the source-list item passed as an argument was augmented with an
5138** INDEXED BY clause, then try to locate the specified index. If there
5139** was such a clause and the named index cannot be found, return
5140** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
5141** pFrom->pIndex and return SQLITE_OK.
5142*/
drh76012942021-02-21 21:04:54 +00005143int sqlite3IndexedByLookup(Parse *pParse, SrcItem *pFrom){
drh18622712021-02-20 21:20:54 +00005144 Table *pTab = pFrom->pTab;
5145 char *zIndexedBy = pFrom->u1.zIndexedBy;
5146 Index *pIdx;
5147 assert( pTab!=0 );
5148 assert( pFrom->fg.isIndexedBy!=0 );
5149
5150 for(pIdx=pTab->pIndex;
5151 pIdx && sqlite3StrICmp(pIdx->zName, zIndexedBy);
5152 pIdx=pIdx->pNext
5153 );
5154 if( !pIdx ){
5155 sqlite3ErrorMsg(pParse, "no such index: %s", zIndexedBy, 0);
5156 pParse->checkSchema = 1;
5157 return SQLITE_ERROR;
danielk1977b1c685b2008-10-06 16:18:39 +00005158 }
drhdbfbb5a2021-10-07 23:04:50 +00005159 assert( pFrom->fg.isCte==0 );
drha79e2a22021-02-21 23:44:14 +00005160 pFrom->u2.pIBIndex = pIdx;
danielk1977b1c685b2008-10-06 16:18:39 +00005161 return SQLITE_OK;
5162}
drh18622712021-02-20 21:20:54 +00005163
drhc01b7302013-05-07 17:49:08 +00005164/*
5165** Detect compound SELECT statements that use an ORDER BY clause with
5166** an alternative collating sequence.
5167**
5168** SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
5169**
5170** These are rewritten as a subquery:
5171**
5172** SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
5173** ORDER BY ... COLLATE ...
5174**
5175** This transformation is necessary because the multiSelectOrderBy() routine
5176** above that generates the code for a compound SELECT with an ORDER BY clause
5177** uses a merge algorithm that requires the same collating sequence on the
5178** result columns as on the ORDER BY clause. See ticket
5179** http://www.sqlite.org/src/info/6709574d2a
5180**
5181** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
5182** The UNION ALL operator works fine with multiSelectOrderBy() even when
5183** there are COLLATE terms in the ORDER BY.
5184*/
5185static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
5186 int i;
5187 Select *pNew;
5188 Select *pX;
5189 sqlite3 *db;
5190 struct ExprList_item *a;
5191 SrcList *pNewSrc;
5192 Parse *pParse;
5193 Token dummy;
5194
5195 if( p->pPrior==0 ) return WRC_Continue;
5196 if( p->pOrderBy==0 ) return WRC_Continue;
5197 for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
5198 if( pX==0 ) return WRC_Continue;
5199 a = p->pOrderBy->a;
dan46daa992020-06-11 15:53:54 +00005200#ifndef SQLITE_OMIT_WINDOWFUNC
5201 /* If iOrderByCol is already non-zero, then it has already been matched
5202 ** to a result column of the SELECT statement. This occurs when the
5203 ** SELECT is rewritten for window-functions processing and then passed
5204 ** to sqlite3SelectPrep() and similar a second time. The rewriting done
5205 ** by this function is not required in this case. */
5206 if( a[0].u.x.iOrderByCol ) return WRC_Continue;
5207#endif
drhc01b7302013-05-07 17:49:08 +00005208 for(i=p->pOrderBy->nExpr-1; i>=0; i--){
5209 if( a[i].pExpr->flags & EP_Collate ) break;
5210 }
5211 if( i<0 ) return WRC_Continue;
5212
5213 /* If we reach this point, that means the transformation is required. */
5214
5215 pParse = pWalker->pParse;
5216 db = pParse->db;
5217 pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
5218 if( pNew==0 ) return WRC_Abort;
5219 memset(&dummy, 0, sizeof(dummy));
drhd44f8b22022-04-07 01:11:13 +00005220 pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0);
drhc01b7302013-05-07 17:49:08 +00005221 if( pNewSrc==0 ) return WRC_Abort;
5222 *pNew = *p;
5223 p->pSrc = pNewSrc;
drh1a1d3cd2015-11-19 16:33:31 +00005224 p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ASTERISK, 0));
drhc01b7302013-05-07 17:49:08 +00005225 p->op = TK_SELECT;
5226 p->pWhere = 0;
5227 pNew->pGroupBy = 0;
5228 pNew->pHaving = 0;
5229 pNew->pOrderBy = 0;
5230 p->pPrior = 0;
drh8af9ad92014-02-10 18:56:05 +00005231 p->pNext = 0;
drhf932f712015-04-12 17:35:27 +00005232 p->pWith = 0;
danfcc057d2019-12-04 01:42:07 +00005233#ifndef SQLITE_OMIT_WINDOWFUNC
5234 p->pWinDefn = 0;
5235#endif
drh8af9ad92014-02-10 18:56:05 +00005236 p->selFlags &= ~SF_Compound;
danb33c50f2015-04-04 16:43:16 +00005237 assert( (p->selFlags & SF_Converted)==0 );
5238 p->selFlags |= SF_Converted;
drha6e3a8c2014-02-10 21:07:51 +00005239 assert( pNew->pPrior!=0 );
5240 pNew->pPrior->pNext = pNew;
drhc01b7302013-05-07 17:49:08 +00005241 pNew->pLimit = 0;
drhc01b7302013-05-07 17:49:08 +00005242 return WRC_Continue;
5243}
danielk1977b1c685b2008-10-06 16:18:39 +00005244
drh20292312015-11-21 13:24:46 +00005245/*
5246** Check to see if the FROM clause term pFrom has table-valued function
5247** arguments. If it does, leave an error message in pParse and return
5248** non-zero, since pFrom is not allowed to be a table-valued function.
5249*/
drh76012942021-02-21 21:04:54 +00005250static int cannotBeFunction(Parse *pParse, SrcItem *pFrom){
drh20292312015-11-21 13:24:46 +00005251 if( pFrom->fg.isTabFunc ){
5252 sqlite3ErrorMsg(pParse, "'%s' is not a function", pFrom->zName);
5253 return 1;
5254 }
5255 return 0;
5256}
5257
daneede6a52014-01-15 19:42:23 +00005258#ifndef SQLITE_OMIT_CTE
5259/*
5260** Argument pWith (which may be NULL) points to a linked list of nested
5261** WITH contexts, from inner to outermost. If the table identified by
5262** FROM clause element pItem is really a common-table-expression (CTE)
5263** then return a pointer to the CTE definition for that table. Otherwise
5264** return NULL.
dan98f45e52014-01-17 17:40:46 +00005265**
5266** If a non-NULL value is returned, set *ppContext to point to the With
5267** object that the returned CTE belongs to.
drh60c1a2f2014-01-15 18:23:00 +00005268*/
dan98f45e52014-01-17 17:40:46 +00005269static struct Cte *searchWith(
drh2476a6f2015-11-07 15:19:59 +00005270 With *pWith, /* Current innermost WITH clause */
drh76012942021-02-21 21:04:54 +00005271 SrcItem *pItem, /* FROM clause element to resolve */
dan98f45e52014-01-17 17:40:46 +00005272 With **ppContext /* OUT: WITH clause return value belongs to */
5273){
drh5abe1d32021-02-21 01:19:42 +00005274 const char *zName = pItem->zName;
5275 With *p;
5276 assert( pItem->zDatabase==0 );
5277 assert( zName!=0 );
5278 for(p=pWith; p; p=p->pOuter){
5279 int i;
5280 for(i=0; i<p->nCte; i++){
5281 if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
5282 *ppContext = p;
5283 return &p->a[i];
dan4e9119d2014-01-13 15:12:23 +00005284 }
5285 }
dan90bc36f2021-05-20 17:15:06 +00005286 if( p->bView ) break;
dan4e9119d2014-01-13 15:12:23 +00005287 }
5288 return 0;
5289}
5290
drhc49832c2014-01-15 18:35:52 +00005291/* The code generator maintains a stack of active WITH clauses
5292** with the inner-most WITH clause being at the top of the stack.
5293**
danb290f112014-01-17 14:59:27 +00005294** This routine pushes the WITH clause passed as the second argument
5295** onto the top of the stack. If argument bFree is true, then this
drh7cc73b32021-05-23 17:47:04 +00005296** WITH clause will never be popped from the stack but should instead
5297** be freed along with the Parse object. In other cases, when
danb290f112014-01-17 14:59:27 +00005298** bFree==0, the With object will be freed along with the SELECT
5299** statement with which it is associated.
drh24ce9442021-06-12 17:45:32 +00005300**
5301** This routine returns a copy of pWith. Or, if bFree is true and
5302** the pWith object is destroyed immediately due to an OOM condition,
5303** then this routine return NULL.
5304**
5305** If bFree is true, do not continue to use the pWith pointer after
5306** calling this routine, Instead, use only the return value.
drhc49832c2014-01-15 18:35:52 +00005307*/
drh24ce9442021-06-12 17:45:32 +00005308With *sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
dan4e9119d2014-01-13 15:12:23 +00005309 if( pWith ){
drh24ce9442021-06-12 17:45:32 +00005310 if( bFree ){
5311 pWith = (With*)sqlite3ParserAddCleanup(pParse,
5312 (void(*)(sqlite3*,void*))sqlite3WithDelete,
5313 pWith);
5314 if( pWith==0 ) return 0;
5315 }
drh7cc73b32021-05-23 17:47:04 +00005316 if( pParse->nErr==0 ){
5317 assert( pParse->pWith!=pWith );
5318 pWith->pOuter = pParse->pWith;
5319 pParse->pWith = pWith;
5320 }
dan4e9119d2014-01-13 15:12:23 +00005321 }
drh24ce9442021-06-12 17:45:32 +00005322 return pWith;
dan4e9119d2014-01-13 15:12:23 +00005323}
dan4e9119d2014-01-13 15:12:23 +00005324
daneede6a52014-01-15 19:42:23 +00005325/*
daneede6a52014-01-15 19:42:23 +00005326** This function checks if argument pFrom refers to a CTE declared by
drh5abe1d32021-02-21 01:19:42 +00005327** a WITH clause on the stack currently maintained by the parser (on the
5328** pParse->pWith linked list). And if currently processing a CTE
5329** CTE expression, through routine checks to see if the reference is
5330** a recursive reference to the CTE.
daneede6a52014-01-15 19:42:23 +00005331**
drh5abe1d32021-02-21 01:19:42 +00005332** If pFrom matches a CTE according to either of these two above, pFrom->pTab
5333** and other fields are populated accordingly.
daneede6a52014-01-15 19:42:23 +00005334**
drh5abe1d32021-02-21 01:19:42 +00005335** Return 0 if no match is found.
5336** Return 1 if a match is found.
5337** Return 2 if an error condition is detected.
daneede6a52014-01-15 19:42:23 +00005338*/
drh5abe1d32021-02-21 01:19:42 +00005339static int resolveFromTermToCte(
5340 Parse *pParse, /* The parsing context */
5341 Walker *pWalker, /* Current tree walker */
drh76012942021-02-21 21:04:54 +00005342 SrcItem *pFrom /* The FROM clause term to check */
dan8ce71842014-01-14 20:14:09 +00005343){
drh5abe1d32021-02-21 01:19:42 +00005344 Cte *pCte; /* Matched CTE (or NULL if no match) */
5345 With *pWith; /* The matching WITH */
dan8ce71842014-01-14 20:14:09 +00005346
dan8ce71842014-01-14 20:14:09 +00005347 assert( pFrom->pTab==0 );
drh5abe1d32021-02-21 01:19:42 +00005348 if( pParse->pWith==0 ){
5349 /* There are no WITH clauses in the stack. No match is possible */
5350 return 0;
drh46a31cd2019-11-09 14:38:58 +00005351 }
drh93c81392021-05-21 21:49:07 +00005352 if( pParse->nErr ){
5353 /* Prior errors might have left pParse->pWith in a goofy state, so
5354 ** go no further. */
5355 return 0;
5356 }
drh5abe1d32021-02-21 01:19:42 +00005357 if( pFrom->zDatabase!=0 ){
5358 /* The FROM term contains a schema qualifier (ex: main.t1) and so
5359 ** it cannot possibly be a CTE reference. */
5360 return 0;
5361 }
drhcd1499f2021-05-20 00:44:04 +00005362 if( pFrom->fg.notCte ){
5363 /* The FROM term is specifically excluded from matching a CTE.
5364 ** (1) It is part of a trigger that used to have zDatabase but had
5365 ** zDatabase removed by sqlite3FixTriggerStep().
5366 ** (2) This is the first term in the FROM clause of an UPDATE.
5367 */
5368 return 0;
5369 }
dan98f45e52014-01-17 17:40:46 +00005370 pCte = searchWith(pParse->pWith, pFrom, &pWith);
daneae73fb2014-01-16 18:34:33 +00005371 if( pCte ){
drh5abe1d32021-02-21 01:19:42 +00005372 sqlite3 *db = pParse->db;
dan98f45e52014-01-17 17:40:46 +00005373 Table *pTab;
dan8ce71842014-01-14 20:14:09 +00005374 ExprList *pEList;
5375 Select *pSel;
dan60e70682014-01-15 15:27:51 +00005376 Select *pLeft; /* Left-most SELECT statement */
drh34055852020-10-19 01:23:48 +00005377 Select *pRecTerm; /* Left-most recursive term */
danf2655fe2014-01-16 21:02:02 +00005378 int bMayRecursive; /* True if compound joined by UNION [ALL] */
dan98f45e52014-01-17 17:40:46 +00005379 With *pSavedWith; /* Initial value of pParse->pWith */
drh34055852020-10-19 01:23:48 +00005380 int iRecTab = -1; /* Cursor for recursive table */
drh745912e2021-02-22 03:04:25 +00005381 CteUse *pCteUse;
danf2655fe2014-01-16 21:02:02 +00005382
drh0576bc52015-08-26 11:40:11 +00005383 /* If pCte->zCteErr is non-NULL at this point, then this is an illegal
danf2655fe2014-01-16 21:02:02 +00005384 ** recursive reference to CTE pCte. Leave an error in pParse and return
drh0576bc52015-08-26 11:40:11 +00005385 ** early. If pCte->zCteErr is NULL, then this is not a recursive reference.
danf2655fe2014-01-16 21:02:02 +00005386 ** In this case, proceed. */
drh0576bc52015-08-26 11:40:11 +00005387 if( pCte->zCteErr ){
5388 sqlite3ErrorMsg(pParse, pCte->zCteErr, pCte->zName);
drh5abe1d32021-02-21 01:19:42 +00005389 return 2;
danf2655fe2014-01-16 21:02:02 +00005390 }
drh5abe1d32021-02-21 01:19:42 +00005391 if( cannotBeFunction(pParse, pFrom) ) return 2;
dan8ce71842014-01-14 20:14:09 +00005392
drhc25e2eb2014-01-20 14:58:55 +00005393 assert( pFrom->pTab==0 );
drha79e2a22021-02-21 23:44:14 +00005394 pTab = sqlite3DbMallocZero(db, sizeof(Table));
drh5abe1d32021-02-21 01:19:42 +00005395 if( pTab==0 ) return 2;
drh745912e2021-02-22 03:04:25 +00005396 pCteUse = pCte->pUse;
5397 if( pCteUse==0 ){
5398 pCte->pUse = pCteUse = sqlite3DbMallocZero(db, sizeof(pCteUse[0]));
5399 if( pCteUse==0
5400 || sqlite3ParserAddCleanup(pParse,sqlite3DbFree,pCteUse)==0
drha79e2a22021-02-21 23:44:14 +00005401 ){
5402 sqlite3DbFree(db, pTab);
5403 return 2;
5404 }
drh745912e2021-02-22 03:04:25 +00005405 pCteUse->eM10d = pCte->eM10d;
drha79e2a22021-02-21 23:44:14 +00005406 }
5407 pFrom->pTab = pTab;
drh79df7782016-12-14 14:07:35 +00005408 pTab->nTabRef = 1;
dan2d4dc5f2014-01-17 11:48:24 +00005409 pTab->zName = sqlite3DbStrDup(db, pCte->zName);
dan8ce71842014-01-14 20:14:09 +00005410 pTab->iPKey = -1;
dancfc9df72014-04-25 15:01:01 +00005411 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drhfccda8a2015-05-27 13:06:55 +00005412 pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
dan8ce71842014-01-14 20:14:09 +00005413 pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
drh5abe1d32021-02-21 01:19:42 +00005414 if( db->mallocFailed ) return 2;
danac67f562021-06-14 20:08:48 +00005415 pFrom->pSelect->selFlags |= SF_CopyCte;
dan8ce71842014-01-14 20:14:09 +00005416 assert( pFrom->pSelect );
drh0c1da682021-10-09 16:00:56 +00005417 if( pFrom->fg.isIndexedBy ){
5418 sqlite3ErrorMsg(pParse, "no such index: \"%s\"", pFrom->u1.zIndexedBy);
5419 return 2;
5420 }
drha79e2a22021-02-21 23:44:14 +00005421 pFrom->fg.isCte = 1;
drh745912e2021-02-22 03:04:25 +00005422 pFrom->u2.pCteUse = pCteUse;
5423 pCteUse->nUse++;
5424 if( pCteUse->nUse>=2 && pCteUse->eM10d==M10d_Any ){
5425 pCteUse->eM10d = M10d_Yes;
5426 }
dan8ce71842014-01-14 20:14:09 +00005427
daneae73fb2014-01-16 18:34:33 +00005428 /* Check if this is a recursive CTE. */
drh34055852020-10-19 01:23:48 +00005429 pRecTerm = pSel = pFrom->pSelect;
danf2655fe2014-01-16 21:02:02 +00005430 bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
drh34055852020-10-19 01:23:48 +00005431 while( bMayRecursive && pRecTerm->op==pSel->op ){
daneae73fb2014-01-16 18:34:33 +00005432 int i;
drh34055852020-10-19 01:23:48 +00005433 SrcList *pSrc = pRecTerm->pSrc;
5434 assert( pRecTerm->pPrior!=0 );
daneae73fb2014-01-16 18:34:33 +00005435 for(i=0; i<pSrc->nSrc; i++){
drh76012942021-02-21 21:04:54 +00005436 SrcItem *pItem = &pSrc->a[i];
daneae73fb2014-01-16 18:34:33 +00005437 if( pItem->zDatabase==0
5438 && pItem->zName!=0
5439 && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
drh34055852020-10-19 01:23:48 +00005440 ){
daneae73fb2014-01-16 18:34:33 +00005441 pItem->pTab = pTab;
drh94d6f3f2020-10-19 20:49:54 +00005442 pTab->nTabRef++;
drh8a48b9c2015-08-19 15:20:00 +00005443 pItem->fg.isRecursive = 1;
drh34055852020-10-19 01:23:48 +00005444 if( pRecTerm->selFlags & SF_Recursive ){
5445 sqlite3ErrorMsg(pParse,
5446 "multiple references to recursive table: %s", pCte->zName
5447 );
drh5abe1d32021-02-21 01:19:42 +00005448 return 2;
drh34055852020-10-19 01:23:48 +00005449 }
drh34055852020-10-19 01:23:48 +00005450 pRecTerm->selFlags |= SF_Recursive;
5451 if( iRecTab<0 ) iRecTab = pParse->nTab++;
5452 pItem->iCursor = iRecTab;
daneae73fb2014-01-16 18:34:33 +00005453 }
5454 }
drh34055852020-10-19 01:23:48 +00005455 if( (pRecTerm->selFlags & SF_Recursive)==0 ) break;
5456 pRecTerm = pRecTerm->pPrior;
dan8ce71842014-01-14 20:14:09 +00005457 }
5458
drh0576bc52015-08-26 11:40:11 +00005459 pCte->zCteErr = "circular reference: %s";
dan98f45e52014-01-17 17:40:46 +00005460 pSavedWith = pParse->pWith;
5461 pParse->pWith = pWith;
drh34055852020-10-19 01:23:48 +00005462 if( pSel->selFlags & SF_Recursive ){
danca237a82021-03-18 18:25:43 +00005463 int rc;
drh34055852020-10-19 01:23:48 +00005464 assert( pRecTerm!=0 );
5465 assert( (pRecTerm->selFlags & SF_Recursive)==0 );
5466 assert( pRecTerm->pNext!=0 );
5467 assert( (pRecTerm->pNext->selFlags & SF_Recursive)!=0 );
5468 assert( pRecTerm->pWith==0 );
5469 pRecTerm->pWith = pSel->pWith;
danca237a82021-03-18 18:25:43 +00005470 rc = sqlite3WalkSelect(pWalker, pRecTerm);
drh34055852020-10-19 01:23:48 +00005471 pRecTerm->pWith = 0;
danca237a82021-03-18 18:25:43 +00005472 if( rc ){
5473 pParse->pWith = pSavedWith;
5474 return 2;
5475 }
dan067cd832017-02-03 19:16:39 +00005476 }else{
danca237a82021-03-18 18:25:43 +00005477 if( sqlite3WalkSelect(pWalker, pSel) ){
5478 pParse->pWith = pSavedWith;
5479 return 2;
5480 }
dan067cd832017-02-03 19:16:39 +00005481 }
drh6e772262015-11-07 17:48:21 +00005482 pParse->pWith = pWith;
daneae73fb2014-01-16 18:34:33 +00005483
dan60e70682014-01-15 15:27:51 +00005484 for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
5485 pEList = pLeft->pEList;
dan8ce71842014-01-14 20:14:09 +00005486 if( pCte->pCols ){
drh8f9d0b22015-03-21 03:18:22 +00005487 if( pEList && pEList->nExpr!=pCte->pCols->nExpr ){
drh727a99f2014-01-16 21:59:51 +00005488 sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
dan60e70682014-01-15 15:27:51 +00005489 pCte->zName, pEList->nExpr, pCte->pCols->nExpr
5490 );
dan98f45e52014-01-17 17:40:46 +00005491 pParse->pWith = pSavedWith;
drh5abe1d32021-02-21 01:19:42 +00005492 return 2;
dan60e70682014-01-15 15:27:51 +00005493 }
dan8ce71842014-01-14 20:14:09 +00005494 pEList = pCte->pCols;
dan8ce71842014-01-14 20:14:09 +00005495 }
dan8ce71842014-01-14 20:14:09 +00005496
drh8981b902015-08-24 17:42:49 +00005497 sqlite3ColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
danf2655fe2014-01-16 21:02:02 +00005498 if( bMayRecursive ){
5499 if( pSel->selFlags & SF_Recursive ){
drh0576bc52015-08-26 11:40:11 +00005500 pCte->zCteErr = "multiple recursive references: %s";
danf2655fe2014-01-16 21:02:02 +00005501 }else{
drh0576bc52015-08-26 11:40:11 +00005502 pCte->zCteErr = "recursive reference in a subquery: %s";
danf2655fe2014-01-16 21:02:02 +00005503 }
5504 sqlite3WalkSelect(pWalker, pSel);
5505 }
drh0576bc52015-08-26 11:40:11 +00005506 pCte->zCteErr = 0;
dan98f45e52014-01-17 17:40:46 +00005507 pParse->pWith = pSavedWith;
drh5abe1d32021-02-21 01:19:42 +00005508 return 1; /* Success */
dan8ce71842014-01-14 20:14:09 +00005509 }
drh5abe1d32021-02-21 01:19:42 +00005510 return 0; /* No match */
dan8ce71842014-01-14 20:14:09 +00005511}
daneede6a52014-01-15 19:42:23 +00005512#endif
dan4e9119d2014-01-13 15:12:23 +00005513
danb290f112014-01-17 14:59:27 +00005514#ifndef SQLITE_OMIT_CTE
dan71856942014-01-17 15:15:10 +00005515/*
5516** If the SELECT passed as the second argument has an associated WITH
5517** clause, pop it from the stack stored as part of the Parse object.
5518**
5519** This function is used as the xSelectCallback2() callback by
5520** sqlite3SelectExpand() when walking a SELECT tree to resolve table
5521** names and other FROM clause elements.
5522*/
danbe120832021-05-17 16:20:41 +00005523void sqlite3SelectPopWith(Walker *pWalker, Select *p){
danb290f112014-01-17 14:59:27 +00005524 Parse *pParse = pWalker->pParse;
drh2f65b2f2017-10-02 21:29:51 +00005525 if( OK_IF_ALWAYS_TRUE(pParse->pWith) && p->pPrior==0 ){
dan067cd832017-02-03 19:16:39 +00005526 With *pWith = findRightmost(p)->pWith;
5527 if( pWith!=0 ){
dan70a32702020-01-21 14:42:48 +00005528 assert( pParse->pWith==pWith || pParse->nErr );
dan067cd832017-02-03 19:16:39 +00005529 pParse->pWith = pWith->pOuter;
5530 }
danb290f112014-01-17 14:59:27 +00005531 }
danb290f112014-01-17 14:59:27 +00005532}
danb290f112014-01-17 14:59:27 +00005533#endif
5534
dan9a947222018-06-14 19:06:36 +00005535/*
5536** The SrcList_item structure passed as the second argument represents a
5537** sub-query in the FROM clause of a SELECT statement. This function
5538** allocates and populates the SrcList_item.pTab object. If successful,
5539** SQLITE_OK is returned. Otherwise, if an OOM error is encountered,
5540** SQLITE_NOMEM.
5541*/
drh76012942021-02-21 21:04:54 +00005542int sqlite3ExpandSubquery(Parse *pParse, SrcItem *pFrom){
dan86fb6e12018-05-16 20:58:07 +00005543 Select *pSel = pFrom->pSelect;
5544 Table *pTab;
5545
dan9a947222018-06-14 19:06:36 +00005546 assert( pSel );
dan86fb6e12018-05-16 20:58:07 +00005547 pFrom->pTab = pTab = sqlite3DbMallocZero(pParse->db, sizeof(Table));
dan9a947222018-06-14 19:06:36 +00005548 if( pTab==0 ) return SQLITE_NOMEM;
dan86fb6e12018-05-16 20:58:07 +00005549 pTab->nTabRef = 1;
5550 if( pFrom->zAlias ){
5551 pTab->zName = sqlite3DbStrDup(pParse->db, pFrom->zAlias);
5552 }else{
drhfef37762018-07-10 19:48:35 +00005553 pTab->zName = sqlite3MPrintf(pParse->db, "subquery_%u", pSel->selId);
dan86fb6e12018-05-16 20:58:07 +00005554 }
5555 while( pSel->pPrior ){ pSel = pSel->pPrior; }
5556 sqlite3ColumnsFromExprList(pParse, pSel->pEList,&pTab->nCol,&pTab->aCol);
5557 pTab->iPKey = -1;
5558 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drh6e5020e2021-04-07 15:45:01 +00005559#ifndef SQLITE_ALLOW_ROWID_IN_VIEW
5560 /* The usual case - do not allow ROWID on a subquery */
5561 pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
5562#else
5563 pTab->tabFlags |= TF_Ephemeral; /* Legacy compatibility mode */
5564#endif
drhf4b33152019-04-23 12:30:15 +00005565 return pParse->nErr ? SQLITE_ERROR : SQLITE_OK;
dan86fb6e12018-05-16 20:58:07 +00005566}
5567
drh4ce7bf92022-04-15 18:30:48 +00005568
5569/*
5570** Check the N SrcItem objects to the right of pBase. (N might be zero!)
5571** If any of those SrcItem objects have a USING clause containing zName
5572** then return true.
5573**
5574** If N is zero, or none of the N SrcItem objects to the right of pBase
5575** contains a USING clause, or if none of the USING clauses contain zName,
5576** then return false.
5577*/
5578static int inAnyUsingClause(
5579 const char *zName, /* Name we are looking for */
5580 SrcItem *pBase, /* The base SrcItem. Looking at pBase[1] and following */
5581 int N /* How many SrcItems to check */
5582){
5583 while( N>0 ){
5584 N--;
5585 pBase++;
5586 if( pBase->fg.isUsing==0 ) continue;
drhe32d6a02022-04-19 15:56:03 +00005587 if( NEVER(pBase->u3.pUsing==0) ) continue;
drh4ce7bf92022-04-15 18:30:48 +00005588 if( sqlite3IdListIndex(pBase->u3.pUsing, zName)>=0 ) return 1;
5589 }
5590 return 0;
5591}
5592
5593
danielk1977b1c685b2008-10-06 16:18:39 +00005594/*
drh7d10d5a2008-08-20 16:35:10 +00005595** This routine is a Walker callback for "expanding" a SELECT statement.
5596** "Expanding" means to do the following:
5597**
5598** (1) Make sure VDBE cursor numbers have been assigned to every
5599** element of the FROM clause.
5600**
5601** (2) Fill in the pTabList->a[].pTab fields in the SrcList that
5602** defines FROM clause. When views appear in the FROM clause,
5603** fill pTabList->a[].pSelect with a copy of the SELECT statement
5604** that implements the view. A copy is made of the view's SELECT
5605** statement so that we can freely modify or delete that statement
peter.d.reid60ec9142014-09-06 16:39:46 +00005606** without worrying about messing up the persistent representation
drh7d10d5a2008-08-20 16:35:10 +00005607** of the view.
5608**
peter.d.reid60ec9142014-09-06 16:39:46 +00005609** (3) Add terms to the WHERE clause to accommodate the NATURAL keyword
drh7d10d5a2008-08-20 16:35:10 +00005610** on joins and the ON and USING clause of joins.
5611**
5612** (4) Scan the list of columns in the result set (pEList) looking
5613** for instances of the "*" operator or the TABLE.* operator.
5614** If found, expand each "*" to be every column in every table
5615** and TABLE.* to be every column in TABLE.
5616**
danielk1977b3bce662005-01-29 08:32:43 +00005617*/
drh7d10d5a2008-08-20 16:35:10 +00005618static int selectExpander(Walker *pWalker, Select *p){
5619 Parse *pParse = pWalker->pParse;
drh5abe1d32021-02-21 01:19:42 +00005620 int i, j, k, rc;
drh7d10d5a2008-08-20 16:35:10 +00005621 SrcList *pTabList;
5622 ExprList *pEList;
drh76012942021-02-21 21:04:54 +00005623 SrcItem *pFrom;
drh7d10d5a2008-08-20 16:35:10 +00005624 sqlite3 *db = pParse->db;
drh3e3f1a52013-01-03 00:45:56 +00005625 Expr *pE, *pRight, *pExpr;
drh785097d2013-02-12 22:09:48 +00005626 u16 selFlags = p->selFlags;
drhfca23552017-10-28 20:51:54 +00005627 u32 elistFlags = 0;
danielk1977b3bce662005-01-29 08:32:43 +00005628
drh785097d2013-02-12 22:09:48 +00005629 p->selFlags |= SF_Expanded;
drh7d10d5a2008-08-20 16:35:10 +00005630 if( db->mallocFailed ){
5631 return WRC_Abort;
danielk1977b3bce662005-01-29 08:32:43 +00005632 }
drh9d9c41e2017-10-31 03:40:15 +00005633 assert( p->pSrc!=0 );
5634 if( (selFlags & SF_Expanded)!=0 ){
drh7d10d5a2008-08-20 16:35:10 +00005635 return WRC_Prune;
danielk1977b3bce662005-01-29 08:32:43 +00005636 }
drh59145812019-05-22 22:49:23 +00005637 if( pWalker->eCode ){
5638 /* Renumber selId because it has been copied from a view */
5639 p->selId = ++pParse->nSelect;
5640 }
drh7d10d5a2008-08-20 16:35:10 +00005641 pTabList = p->pSrc;
danielk1977b3bce662005-01-29 08:32:43 +00005642 pEList = p->pEList;
dan90bc36f2021-05-20 17:15:06 +00005643 if( pParse->pWith && (p->selFlags & SF_View) ){
5644 if( p->pWith==0 ){
5645 p->pWith = (With*)sqlite3DbMallocZero(db, sizeof(With));
5646 if( p->pWith==0 ){
5647 return WRC_Abort;
5648 }
5649 }
5650 p->pWith->bView = 1;
5651 }
drha5746e02018-04-09 20:36:09 +00005652 sqlite3WithPush(pParse, p->pWith, 0);
drh7d10d5a2008-08-20 16:35:10 +00005653
5654 /* Make sure cursor numbers have been assigned to all entries in
5655 ** the FROM clause of the SELECT statement.
5656 */
5657 sqlite3SrcListAssignCursors(pParse, pTabList);
5658
5659 /* Look up every table named in the FROM clause of the select. If
5660 ** an entry of the FROM clause is a subquery instead of a table or view,
5661 ** then create a transient table structure to describe the subquery.
5662 */
5663 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5664 Table *pTab;
drhe2b7d7a2015-09-29 15:50:04 +00005665 assert( pFrom->fg.isRecursive==0 || pFrom->pTab!=0 );
dan69887c92020-04-27 20:55:33 +00005666 if( pFrom->pTab ) continue;
5667 assert( pFrom->fg.isRecursive==0 );
drh7d10d5a2008-08-20 16:35:10 +00005668 if( pFrom->zName==0 ){
5669#ifndef SQLITE_OMIT_SUBQUERY
5670 Select *pSel = pFrom->pSelect;
5671 /* A sub-query in the FROM clause of a SELECT */
5672 assert( pSel!=0 );
5673 assert( pFrom->pTab==0 );
drh2b8c5a02015-01-22 12:00:17 +00005674 if( sqlite3WalkSelect(pWalker, pSel) ) return WRC_Abort;
dandfa552f2018-06-02 21:04:28 +00005675 if( sqlite3ExpandSubquery(pParse, pFrom) ) return WRC_Abort;
dan86fb6e12018-05-16 20:58:07 +00005676#endif
drh5abe1d32021-02-21 01:19:42 +00005677#ifndef SQLITE_OMIT_CTE
5678 }else if( (rc = resolveFromTermToCte(pParse, pWalker, pFrom))!=0 ){
5679 if( rc>1 ) return WRC_Abort;
5680 pTab = pFrom->pTab;
5681 assert( pTab!=0 );
5682#endif
drh7d10d5a2008-08-20 16:35:10 +00005683 }else{
5684 /* An ordinary table or view name in the FROM clause */
5685 assert( pFrom->pTab==0 );
dan41fb5cd2012-10-04 19:33:00 +00005686 pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
drh7d10d5a2008-08-20 16:35:10 +00005687 if( pTab==0 ) return WRC_Abort;
drh79df7782016-12-14 14:07:35 +00005688 if( pTab->nTabRef>=0xffff ){
drhd2a56232013-01-28 19:00:20 +00005689 sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
5690 pTab->zName);
5691 pFrom->pTab = 0;
5692 return WRC_Abort;
5693 }
drh79df7782016-12-14 14:07:35 +00005694 pTab->nTabRef++;
drh20292312015-11-21 13:24:46 +00005695 if( !IsVirtual(pTab) && cannotBeFunction(pParse, pFrom) ){
5696 return WRC_Abort;
5697 }
dan8c812f92020-01-21 16:23:17 +00005698#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhf38524d2021-08-02 16:41:57 +00005699 if( !IsOrdinaryTable(pTab) ){
drhbfad7be2015-10-11 20:39:46 +00005700 i16 nCol;
drh59145812019-05-22 22:49:23 +00005701 u8 eCodeOrig = pWalker->eCode;
drh7d10d5a2008-08-20 16:35:10 +00005702 if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
drh43152cf2009-05-19 19:04:58 +00005703 assert( pFrom->pSelect==0 );
drhf38524d2021-08-02 16:41:57 +00005704 if( IsView(pTab) ){
5705 if( (db->flags & SQLITE_EnableView)==0
5706 && pTab->pSchema!=db->aDb[1].pSchema
5707 ){
5708 sqlite3ErrorMsg(pParse, "access to view \"%s\" prohibited",
5709 pTab->zName);
5710 }
5711 pFrom->pSelect = sqlite3SelectDup(db, pTab->u.view.pSelect, 0);
danafaa6602021-09-30 18:42:52 +00005712 }
dan8c812f92020-01-21 16:23:17 +00005713#ifndef SQLITE_OMIT_VIRTUALTABLE
danafaa6602021-09-30 18:42:52 +00005714 else if( ALWAYS(IsVirtual(pTab))
drh3f681422020-01-07 18:10:56 +00005715 && pFrom->fg.fromDDL
drhf38524d2021-08-02 16:41:57 +00005716 && ALWAYS(pTab->u.vtab.p!=0)
5717 && pTab->u.vtab.p->eVtabRisk > ((db->flags & SQLITE_TrustedSchema)!=0)
drh3f681422020-01-07 18:10:56 +00005718 ){
drh32266a12020-01-09 13:08:28 +00005719 sqlite3ErrorMsg(pParse, "unsafe use of virtual table \"%s\"",
5720 pTab->zName);
drh11d88e62019-08-15 21:27:20 +00005721 }
drhf38524d2021-08-02 16:41:57 +00005722 assert( SQLITE_VTABRISK_Normal==1 && SQLITE_VTABRISK_High==2 );
dan8c812f92020-01-21 16:23:17 +00005723#endif
drhbfad7be2015-10-11 20:39:46 +00005724 nCol = pTab->nCol;
5725 pTab->nCol = -1;
drh59145812019-05-22 22:49:23 +00005726 pWalker->eCode = 1; /* Turn on Select.selId renumbering */
drh43152cf2009-05-19 19:04:58 +00005727 sqlite3WalkSelect(pWalker, pFrom->pSelect);
drh59145812019-05-22 22:49:23 +00005728 pWalker->eCode = eCodeOrig;
drhbfad7be2015-10-11 20:39:46 +00005729 pTab->nCol = nCol;
drh7d10d5a2008-08-20 16:35:10 +00005730 }
5731#endif
danielk1977b3bce662005-01-29 08:32:43 +00005732 }
danielk197785574e32008-10-06 05:32:18 +00005733
5734 /* Locate the index named by the INDEXED BY clause, if any. */
drh18622712021-02-20 21:20:54 +00005735 if( pFrom->fg.isIndexedBy && sqlite3IndexedByLookup(pParse, pFrom) ){
danielk1977b1c685b2008-10-06 16:18:39 +00005736 return WRC_Abort;
danielk197785574e32008-10-06 05:32:18 +00005737 }
danielk1977b3bce662005-01-29 08:32:43 +00005738 }
5739
drh7d10d5a2008-08-20 16:35:10 +00005740 /* Process NATURAL keywords, and ON and USING clauses of joins.
danielk1977b3bce662005-01-29 08:32:43 +00005741 */
drh0c7d3d32022-01-24 16:47:12 +00005742 assert( db->mallocFailed==0 || pParse->nErr!=0 );
drh358424a2022-04-15 15:15:01 +00005743 if( pParse->nErr || sqlite3ProcessJoin(pParse, p) ){
drh7d10d5a2008-08-20 16:35:10 +00005744 return WRC_Abort;
danielk1977b3bce662005-01-29 08:32:43 +00005745 }
5746
drh7d10d5a2008-08-20 16:35:10 +00005747 /* For every "*" that occurs in the column list, insert the names of
5748 ** all columns in all tables. And for every TABLE.* insert the names
5749 ** of all columns in TABLE. The parser inserted a special expression
drh1a1d3cd2015-11-19 16:33:31 +00005750 ** with the TK_ASTERISK operator for each "*" that it found in the column
5751 ** list. The following code just has to locate the TK_ASTERISK
5752 ** expressions and expand each one to the list of all columns in
5753 ** all tables.
danielk1977b3bce662005-01-29 08:32:43 +00005754 **
drh7d10d5a2008-08-20 16:35:10 +00005755 ** The first loop just checks to see if there are any "*" operators
5756 ** that need expanding.
danielk1977b3bce662005-01-29 08:32:43 +00005757 */
drh7d10d5a2008-08-20 16:35:10 +00005758 for(k=0; k<pEList->nExpr; k++){
drh3e3f1a52013-01-03 00:45:56 +00005759 pE = pEList->a[k].pExpr;
drh1a1d3cd2015-11-19 16:33:31 +00005760 if( pE->op==TK_ASTERISK ) break;
drh43152cf2009-05-19 19:04:58 +00005761 assert( pE->op!=TK_DOT || pE->pRight!=0 );
5762 assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
drh1a1d3cd2015-11-19 16:33:31 +00005763 if( pE->op==TK_DOT && pE->pRight->op==TK_ASTERISK ) break;
drhfca23552017-10-28 20:51:54 +00005764 elistFlags |= pE->flags;
danielk1977b3bce662005-01-29 08:32:43 +00005765 }
drh7d10d5a2008-08-20 16:35:10 +00005766 if( k<pEList->nExpr ){
5767 /*
5768 ** If we get here it means the result set contains one or more "*"
5769 ** operators that need to be expanded. Loop through each expression
5770 ** in the result set and expand them one by one.
5771 */
5772 struct ExprList_item *a = pEList->a;
5773 ExprList *pNew = 0;
5774 int flags = pParse->db->flags;
5775 int longNames = (flags & SQLITE_FullColNames)!=0
drh38b384a2013-01-03 17:34:28 +00005776 && (flags & SQLITE_ShortColNames)==0;
5777
drh7d10d5a2008-08-20 16:35:10 +00005778 for(k=0; k<pEList->nExpr; k++){
drh3e3f1a52013-01-03 00:45:56 +00005779 pE = a[k].pExpr;
drhfca23552017-10-28 20:51:54 +00005780 elistFlags |= pE->flags;
drh3e3f1a52013-01-03 00:45:56 +00005781 pRight = pE->pRight;
5782 assert( pE->op!=TK_DOT || pRight!=0 );
drh1a1d3cd2015-11-19 16:33:31 +00005783 if( pE->op!=TK_ASTERISK
5784 && (pE->op!=TK_DOT || pRight->op!=TK_ASTERISK)
5785 ){
drh7d10d5a2008-08-20 16:35:10 +00005786 /* This particular expression does not need to be expanded.
5787 */
drhb7916a72009-05-27 10:31:29 +00005788 pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
drh7d10d5a2008-08-20 16:35:10 +00005789 if( pNew ){
drh41cee662019-12-12 20:22:34 +00005790 pNew->a[pNew->nExpr-1].zEName = a[k].zEName;
drhcbb9da32019-12-12 22:11:33 +00005791 pNew->a[pNew->nExpr-1].eEName = a[k].eEName;
drh41cee662019-12-12 20:22:34 +00005792 a[k].zEName = 0;
drh7d10d5a2008-08-20 16:35:10 +00005793 }
5794 a[k].pExpr = 0;
drh7d10d5a2008-08-20 16:35:10 +00005795 }else{
5796 /* This expression is a "*" or a "TABLE.*" and needs to be
5797 ** expanded. */
5798 int tableSeen = 0; /* Set to 1 when TABLE matches */
drh3e3f1a52013-01-03 00:45:56 +00005799 char *zTName = 0; /* text of name of TABLE */
drh43152cf2009-05-19 19:04:58 +00005800 if( pE->op==TK_DOT ){
5801 assert( pE->pLeft!=0 );
drh33e619f2009-05-28 01:00:55 +00005802 assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
5803 zTName = pE->pLeft->u.zToken;
drh7d10d5a2008-08-20 16:35:10 +00005804 }
5805 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5806 Table *pTab = pFrom->pTab;
drh815b7822022-04-20 15:07:39 +00005807 Select *pSub;
drh7d10d5a2008-08-20 16:35:10 +00005808 char *zTabName = pFrom->zAlias;
drh3e3f1a52013-01-03 00:45:56 +00005809 const char *zSchemaName = 0;
drhc75e09c2013-01-03 16:54:20 +00005810 int iDb;
drh43152cf2009-05-19 19:04:58 +00005811 if( zTabName==0 ){
drh7d10d5a2008-08-20 16:35:10 +00005812 zTabName = pTab->zName;
5813 }
5814 if( db->mallocFailed ) break;
drh815b7822022-04-20 15:07:39 +00005815 assert( pFrom->fg.isNestedFrom == IsNestedFrom(pFrom->pSelect) );
5816 if( pFrom->fg.isNestedFrom ){
5817 pSub = pFrom->pSelect;
5818 assert( pSub->pEList!=0 );
5819 assert( pSub->pEList->nExpr==pTab->nCol );
5820 }else{
drh3e3f1a52013-01-03 00:45:56 +00005821 pSub = 0;
5822 if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
5823 continue;
5824 }
5825 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh69c33822016-08-18 14:33:11 +00005826 zSchemaName = iDb>=0 ? db->aDb[iDb].zDbSName : "*";
drh7d10d5a2008-08-20 16:35:10 +00005827 }
drh7d10d5a2008-08-20 16:35:10 +00005828 for(j=0; j<pTab->nCol; j++){
drhcf9d36d2021-08-02 18:03:43 +00005829 char *zName = pTab->aCol[j].zCnName;
drhb7916a72009-05-27 10:31:29 +00005830 char *zColname; /* The computed column name */
5831 char *zToFree; /* Malloced string that needs to be freed */
5832 Token sColname; /* Computed column name as a token */
drh7d10d5a2008-08-20 16:35:10 +00005833
drhc75e09c2013-01-03 16:54:20 +00005834 assert( zName );
drh3e3f1a52013-01-03 00:45:56 +00005835 if( zTName && pSub
drhc4938ea2019-12-13 00:49:42 +00005836 && sqlite3MatchEName(&pSub->pEList->a[j], 0, zTName, 0)==0
drh3e3f1a52013-01-03 00:45:56 +00005837 ){
5838 continue;
5839 }
5840
drh80090f92015-11-19 17:55:11 +00005841 /* If a column is marked as 'hidden', omit it from the expanded
5842 ** result-set list unless the SELECT has the SF_IncludeHidden
5843 ** bit set.
drh7d10d5a2008-08-20 16:35:10 +00005844 */
drh80090f92015-11-19 17:55:11 +00005845 if( (p->selFlags & SF_IncludeHidden)==0
5846 && IsHiddenColumn(&pTab->aCol[j])
5847 ){
drh7d10d5a2008-08-20 16:35:10 +00005848 continue;
5849 }
drh3e3f1a52013-01-03 00:45:56 +00005850 tableSeen = 1;
drh7d10d5a2008-08-20 16:35:10 +00005851
drhda55c482008-12-05 00:00:07 +00005852 if( i>0 && zTName==0 ){
drhd44f8b22022-04-07 01:11:13 +00005853 if( pFrom->fg.isUsing
5854 && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0
5855 ){
drh7d10d5a2008-08-20 16:35:10 +00005856 /* In a join with a USING clause, omit columns in the
5857 ** using clause from the table on the right. */
5858 continue;
5859 }
5860 }
drhb7916a72009-05-27 10:31:29 +00005861 pRight = sqlite3Expr(db, TK_ID, zName);
drh4ce7bf92022-04-15 18:30:48 +00005862 if( longNames ){
5863 zColname = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
5864 zToFree = zColname;
5865 }else{
5866 zColname = zName;
5867 zToFree = 0;
5868 }
drhbefbb402022-04-19 23:00:32 +00005869 if( (pTabList->nSrc>1
5870 && ( (pFrom->fg.jointype & JT_LTORJ)==0
5871 || !inAnyUsingClause(zName,pFrom,pTabList->nSrc-i-1)
5872 )
5873 )
5874 || IN_RENAME_OBJECT
drh4ce7bf92022-04-15 18:30:48 +00005875 ){
drhb7916a72009-05-27 10:31:29 +00005876 Expr *pLeft;
5877 pLeft = sqlite3Expr(db, TK_ID, zTabName);
drhabfd35e2016-12-06 22:47:23 +00005878 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight);
dancbde37d2022-04-19 20:47:18 +00005879 if( IN_RENAME_OBJECT && pE->pLeft ){
5880 sqlite3RenameTokenRemap(pParse, pLeft, pE->pLeft);
5881 }
drh38b384a2013-01-03 17:34:28 +00005882 if( zSchemaName ){
drhc75e09c2013-01-03 16:54:20 +00005883 pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
drhabfd35e2016-12-06 22:47:23 +00005884 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr);
drhc75e09c2013-01-03 16:54:20 +00005885 }
drh7d10d5a2008-08-20 16:35:10 +00005886 }else{
5887 pExpr = pRight;
drh7d10d5a2008-08-20 16:35:10 +00005888 }
drhb7916a72009-05-27 10:31:29 +00005889 pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
dancbde37d2022-04-19 20:47:18 +00005890
drh40aced52016-01-22 17:48:09 +00005891 sqlite3TokenInit(&sColname, zColname);
drhb7916a72009-05-27 10:31:29 +00005892 sqlite3ExprListSetName(pParse, pNew, &sColname, 0);
drh0990c412020-02-23 17:34:45 +00005893 if( pNew && (p->selFlags & SF_NestedFrom)!=0 && !IN_RENAME_OBJECT ){
drh3e3f1a52013-01-03 00:45:56 +00005894 struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
drhcbb9da32019-12-12 22:11:33 +00005895 sqlite3DbFree(db, pX->zEName);
drh3e3f1a52013-01-03 00:45:56 +00005896 if( pSub ){
drhcbb9da32019-12-12 22:11:33 +00005897 pX->zEName = sqlite3DbStrDup(db, pSub->pEList->a[j].zEName);
5898 testcase( pX->zEName==0 );
drh3e3f1a52013-01-03 00:45:56 +00005899 }else{
drhcbb9da32019-12-12 22:11:33 +00005900 pX->zEName = sqlite3MPrintf(db, "%s.%s.%s",
drh3e3f1a52013-01-03 00:45:56 +00005901 zSchemaName, zTabName, zColname);
drhcbb9da32019-12-12 22:11:33 +00005902 testcase( pX->zEName==0 );
drh3e3f1a52013-01-03 00:45:56 +00005903 }
drhcbb9da32019-12-12 22:11:33 +00005904 pX->eEName = ENAME_TAB;
drh8f25d182012-12-19 02:36:45 +00005905 }
drhb7916a72009-05-27 10:31:29 +00005906 sqlite3DbFree(db, zToFree);
drh7d10d5a2008-08-20 16:35:10 +00005907 }
5908 }
5909 if( !tableSeen ){
5910 if( zTName ){
5911 sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
5912 }else{
5913 sqlite3ErrorMsg(pParse, "no tables specified");
5914 }
5915 }
drh7d10d5a2008-08-20 16:35:10 +00005916 }
drh9a993342007-12-13 02:45:31 +00005917 }
drh7d10d5a2008-08-20 16:35:10 +00005918 sqlite3ExprListDelete(db, pEList);
5919 p->pEList = pNew;
drh4c774312007-12-08 21:10:20 +00005920 }
drhfca23552017-10-28 20:51:54 +00005921 if( p->pEList ){
5922 if( p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
5923 sqlite3ErrorMsg(pParse, "too many columns in result set");
5924 return WRC_Abort;
5925 }
5926 if( (elistFlags & (EP_HasFunc|EP_Subquery))!=0 ){
5927 p->selFlags |= SF_ComplexResult;
5928 }
drh994c80a2007-04-12 21:25:01 +00005929 }
drhcebc8002022-04-16 18:33:22 +00005930#if TREETRACE_ENABLED
5931 if( sqlite3TreeTrace & 0x100 ){
5932 SELECTTRACE(0x100,pParse,p,("After result-set wildcard expansion:\n"));
5933 sqlite3TreeViewSelect(0, p, 0);
5934 }
5935#endif
drh7d10d5a2008-08-20 16:35:10 +00005936 return WRC_Continue;
5937}
danielk1977b3bce662005-01-29 08:32:43 +00005938
drh979dd1b2017-05-29 14:26:07 +00005939#if SQLITE_DEBUG
5940/*
5941** Always assert. This xSelectCallback2 implementation proves that the
5942** xSelectCallback2 is never invoked.
5943*/
5944void sqlite3SelectWalkAssert2(Walker *NotUsed, Select *NotUsed2){
5945 UNUSED_PARAMETER2(NotUsed, NotUsed2);
5946 assert( 0 );
5947}
5948#endif
5949/*
drh7d10d5a2008-08-20 16:35:10 +00005950** This routine "expands" a SELECT statement and all of its subqueries.
5951** For additional information on what it means to "expand" a SELECT
5952** statement, see the comment on the selectExpand worker callback above.
5953**
5954** Expanding a SELECT statement is the first step in processing a
5955** SELECT statement. The SELECT statement must be expanded before
5956** name resolution is performed.
5957**
5958** If anything goes wrong, an error message is written into pParse.
5959** The calling function can detect the problem by looking at pParse->nErr
5960** and/or pParse->db->mallocFailed.
5961*/
5962static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
5963 Walker w;
drh5b88bc42013-12-07 23:35:21 +00005964 w.xExprCallback = sqlite3ExprWalkNoop;
drh7d10d5a2008-08-20 16:35:10 +00005965 w.pParse = pParse;
drh878fcf92017-10-02 23:50:08 +00005966 if( OK_IF_ALWAYS_TRUE(pParse->hasCompound) ){
drhd58d3272013-08-05 22:05:02 +00005967 w.xSelectCallback = convertCompoundSelectToSubquery;
drh979dd1b2017-05-29 14:26:07 +00005968 w.xSelectCallback2 = 0;
drhd58d3272013-08-05 22:05:02 +00005969 sqlite3WalkSelect(&w, pSelect);
5970 }
drhc01b7302013-05-07 17:49:08 +00005971 w.xSelectCallback = selectExpander;
danbe120832021-05-17 16:20:41 +00005972 w.xSelectCallback2 = sqlite3SelectPopWith;
drh59145812019-05-22 22:49:23 +00005973 w.eCode = 0;
drhc01b7302013-05-07 17:49:08 +00005974 sqlite3WalkSelect(&w, pSelect);
drh7d10d5a2008-08-20 16:35:10 +00005975}
5976
5977
5978#ifndef SQLITE_OMIT_SUBQUERY
5979/*
5980** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
5981** interface.
5982**
5983** For each FROM-clause subquery, add Column.zType and Column.zColl
5984** information to the Table structure that represents the result set
5985** of that subquery.
5986**
5987** The Table structure that represents the result set was constructed
5988** by selectExpander() but the type and collation information was omitted
5989** at that point because identifiers had not yet been resolved. This
5990** routine is called after identifier resolution.
5991*/
danb290f112014-01-17 14:59:27 +00005992static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
drh7d10d5a2008-08-20 16:35:10 +00005993 Parse *pParse;
5994 int i;
5995 SrcList *pTabList;
drh76012942021-02-21 21:04:54 +00005996 SrcItem *pFrom;
drh7d10d5a2008-08-20 16:35:10 +00005997
drh9d8b3072008-08-22 16:29:51 +00005998 assert( p->selFlags & SF_Resolved );
dancc464412018-06-19 18:11:05 +00005999 if( p->selFlags & SF_HasTypeInfo ) return;
drhe2b7d7a2015-09-29 15:50:04 +00006000 p->selFlags |= SF_HasTypeInfo;
6001 pParse = pWalker->pParse;
6002 pTabList = p->pSrc;
6003 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
6004 Table *pTab = pFrom->pTab;
6005 assert( pTab!=0 );
6006 if( (pTab->tabFlags & TF_Ephemeral)!=0 ){
6007 /* A sub-query in the FROM clause of a SELECT */
6008 Select *pSel = pFrom->pSelect;
6009 if( pSel ){
6010 while( pSel->pPrior ) pSel = pSel->pPrior;
drh96fb16e2019-08-06 14:37:24 +00006011 sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSel,
6012 SQLITE_AFF_NONE);
drh5a29d9c2010-02-24 15:10:14 +00006013 }
drh13449892005-09-07 21:22:45 +00006014 }
6015 }
drh7d10d5a2008-08-20 16:35:10 +00006016}
6017#endif
drh13449892005-09-07 21:22:45 +00006018
drh7d10d5a2008-08-20 16:35:10 +00006019
6020/*
6021** This routine adds datatype and collating sequence information to
6022** the Table structures of all FROM-clause subqueries in a
6023** SELECT statement.
6024**
6025** Use this routine after name resolution.
6026*/
6027static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
6028#ifndef SQLITE_OMIT_SUBQUERY
6029 Walker w;
drh979dd1b2017-05-29 14:26:07 +00006030 w.xSelectCallback = sqlite3SelectWalkNoop;
danb290f112014-01-17 14:59:27 +00006031 w.xSelectCallback2 = selectAddSubqueryTypeInfo;
drh5b88bc42013-12-07 23:35:21 +00006032 w.xExprCallback = sqlite3ExprWalkNoop;
drh7d10d5a2008-08-20 16:35:10 +00006033 w.pParse = pParse;
6034 sqlite3WalkSelect(&w, pSelect);
6035#endif
6036}
6037
6038
6039/*
drh030796d2012-08-23 16:18:10 +00006040** This routine sets up a SELECT statement for processing. The
drh7d10d5a2008-08-20 16:35:10 +00006041** following is accomplished:
6042**
6043** * VDBE Cursor numbers are assigned to all FROM-clause terms.
6044** * Ephemeral Table objects are created for all FROM-clause subqueries.
6045** * ON and USING clauses are shifted into WHERE statements
6046** * Wildcards "*" and "TABLE.*" in result sets are expanded.
6047** * Identifiers in expression are matched to tables.
6048**
6049** This routine acts recursively on all subqueries within the SELECT.
6050*/
6051void sqlite3SelectPrep(
6052 Parse *pParse, /* The parser context */
6053 Select *p, /* The SELECT statement being coded. */
6054 NameContext *pOuterNC /* Name context for container */
6055){
drhe2463392017-10-03 14:24:24 +00006056 assert( p!=0 || pParse->db->mallocFailed );
drh0c7d3d32022-01-24 16:47:12 +00006057 assert( pParse->db->pParse==pParse );
drhe2463392017-10-03 14:24:24 +00006058 if( pParse->db->mallocFailed ) return;
drh7d10d5a2008-08-20 16:35:10 +00006059 if( p->selFlags & SF_HasTypeInfo ) return;
drh7d10d5a2008-08-20 16:35:10 +00006060 sqlite3SelectExpand(pParse, p);
drh0c7d3d32022-01-24 16:47:12 +00006061 if( pParse->nErr ) return;
drh7d10d5a2008-08-20 16:35:10 +00006062 sqlite3ResolveSelectNames(pParse, p, pOuterNC);
drh0c7d3d32022-01-24 16:47:12 +00006063 if( pParse->nErr ) return;
drh7d10d5a2008-08-20 16:35:10 +00006064 sqlite3SelectAddTypeInfo(pParse, p);
danielk1977b3bce662005-01-29 08:32:43 +00006065}
6066
6067/*
drh13449892005-09-07 21:22:45 +00006068** Reset the aggregate accumulator.
6069**
6070** The aggregate accumulator is a set of memory cells that hold
6071** intermediate results while calculating an aggregate. This
drh030796d2012-08-23 16:18:10 +00006072** routine generates code that stores NULLs in all of those memory
6073** cells.
danielk1977b3bce662005-01-29 08:32:43 +00006074*/
drh13449892005-09-07 21:22:45 +00006075static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
6076 Vdbe *v = pParse->pVdbe;
6077 int i;
drhc99130f2005-09-11 11:56:27 +00006078 struct AggInfo_func *pFunc;
drh7e61d182013-12-20 13:11:45 +00006079 int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
drh0c7d3d32022-01-24 16:47:12 +00006080 assert( pParse->db->pParse==pParse );
6081 assert( pParse->db->mallocFailed==0 || pParse->nErr!=0 );
drh7e61d182013-12-20 13:11:45 +00006082 if( nReg==0 ) return;
drh0c7d3d32022-01-24 16:47:12 +00006083 if( pParse->nErr ) return;
drh7e61d182013-12-20 13:11:45 +00006084#ifdef SQLITE_DEBUG
6085 /* Verify that all AggInfo registers are within the range specified by
6086 ** AggInfo.mnReg..AggInfo.mxReg */
6087 assert( nReg==pAggInfo->mxReg-pAggInfo->mnReg+1 );
drh13449892005-09-07 21:22:45 +00006088 for(i=0; i<pAggInfo->nColumn; i++){
drh7e61d182013-12-20 13:11:45 +00006089 assert( pAggInfo->aCol[i].iMem>=pAggInfo->mnReg
6090 && pAggInfo->aCol[i].iMem<=pAggInfo->mxReg );
drh13449892005-09-07 21:22:45 +00006091 }
drh7e61d182013-12-20 13:11:45 +00006092 for(i=0; i<pAggInfo->nFunc; i++){
6093 assert( pAggInfo->aFunc[i].iMem>=pAggInfo->mnReg
6094 && pAggInfo->aFunc[i].iMem<=pAggInfo->mxReg );
6095 }
6096#endif
6097 sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->mnReg, pAggInfo->mxReg);
drhc99130f2005-09-11 11:56:27 +00006098 for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
drhc99130f2005-09-11 11:56:27 +00006099 if( pFunc->iDistinct>=0 ){
drh81185a52020-06-09 13:38:12 +00006100 Expr *pE = pFunc->pFExpr;
drha4eeccd2021-10-07 17:43:30 +00006101 assert( ExprUseXList(pE) );
danielk19776ab3a2e2009-02-19 14:39:25 +00006102 if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
drh0daa0022009-02-09 13:19:28 +00006103 sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
6104 "argument");
drhc99130f2005-09-11 11:56:27 +00006105 pFunc->iDistinct = -1;
6106 }else{
danf9eae182018-05-21 19:45:11 +00006107 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pE->x.pList,0,0);
dan4fcb30b2021-03-09 16:06:25 +00006108 pFunc->iDistAddr = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
6109 pFunc->iDistinct, 0, 0, (char*)pKeyInfo, P4_KEYINFO);
drh9be13392021-03-24 19:44:01 +00006110 ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s(DISTINCT)",
6111 pFunc->pFunc->zName));
drhc99130f2005-09-11 11:56:27 +00006112 }
6113 }
drh13449892005-09-07 21:22:45 +00006114 }
danielk1977b3bce662005-01-29 08:32:43 +00006115}
6116
6117/*
drh13449892005-09-07 21:22:45 +00006118** Invoke the OP_AggFinalize opcode for every aggregate function
6119** in the AggInfo structure.
danielk1977b3bce662005-01-29 08:32:43 +00006120*/
drh13449892005-09-07 21:22:45 +00006121static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
6122 Vdbe *v = pParse->pVdbe;
6123 int i;
6124 struct AggInfo_func *pF;
6125 for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
drha4eeccd2021-10-07 17:43:30 +00006126 ExprList *pList;
6127 assert( ExprUseXList(pF->pFExpr) );
6128 pList = pF->pFExpr->x.pList;
drh2700aca2016-12-08 01:38:24 +00006129 sqlite3VdbeAddOp2(v, OP_AggFinal, pF->iMem, pList ? pList->nExpr : 0);
6130 sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
drh13449892005-09-07 21:22:45 +00006131 }
danielk1977b3bce662005-01-29 08:32:43 +00006132}
drh13449892005-09-07 21:22:45 +00006133
dan280c8942018-06-05 20:04:28 +00006134
drh13449892005-09-07 21:22:45 +00006135/*
6136** Update the accumulator memory cells for an aggregate based on
6137** the current cursor position.
dan280c8942018-06-05 20:04:28 +00006138**
6139** If regAcc is non-zero and there are no min() or max() aggregates
6140** in pAggInfo, then only populate the pAggInfo->nAccumulator accumulator
drh10cc16c2019-03-01 21:12:40 +00006141** registers if register regAcc contains 0. The caller will take care
dan280c8942018-06-05 20:04:28 +00006142** of setting and clearing regAcc.
drh13449892005-09-07 21:22:45 +00006143*/
dan4fcb30b2021-03-09 16:06:25 +00006144static void updateAccumulator(
6145 Parse *pParse,
6146 int regAcc,
6147 AggInfo *pAggInfo,
6148 int eDistinctType
6149){
drh13449892005-09-07 21:22:45 +00006150 Vdbe *v = pParse->pVdbe;
6151 int i;
drh7a957892012-02-02 17:35:43 +00006152 int regHit = 0;
6153 int addrHitTest = 0;
drh13449892005-09-07 21:22:45 +00006154 struct AggInfo_func *pF;
6155 struct AggInfo_col *pC;
drh13449892005-09-07 21:22:45 +00006156
6157 pAggInfo->directMode = 1;
6158 for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
6159 int nArg;
drhc99130f2005-09-11 11:56:27 +00006160 int addrNext = 0;
drh98757152008-01-09 23:04:12 +00006161 int regAgg;
drha4eeccd2021-10-07 17:43:30 +00006162 ExprList *pList;
6163 assert( ExprUseXList(pF->pFExpr) );
drh81185a52020-06-09 13:38:12 +00006164 assert( !IsWindowFunc(pF->pFExpr) );
drha4eeccd2021-10-07 17:43:30 +00006165 pList = pF->pFExpr->x.pList;
drh81185a52020-06-09 13:38:12 +00006166 if( ExprHasProperty(pF->pFExpr, EP_WinFunc) ){
6167 Expr *pFilter = pF->pFExpr->y.pWin->pFilter;
daned09ddd2019-09-20 20:52:16 +00006168 if( pAggInfo->nAccumulator
6169 && (pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL)
danfa4b0d42020-07-01 14:07:45 +00006170 && regAcc
daned09ddd2019-09-20 20:52:16 +00006171 ){
danfa4b0d42020-07-01 14:07:45 +00006172 /* If regAcc==0, there there exists some min() or max() function
6173 ** without a FILTER clause that will ensure the magnet registers
6174 ** are populated. */
daned09ddd2019-09-20 20:52:16 +00006175 if( regHit==0 ) regHit = ++pParse->nMem;
danfa4b0d42020-07-01 14:07:45 +00006176 /* If this is the first row of the group (regAcc contains 0), clear the
daned09ddd2019-09-20 20:52:16 +00006177 ** "magnet" register regHit so that the accumulator registers
danaf9b58b2019-09-20 21:12:40 +00006178 ** are populated if the FILTER clause jumps over the the
6179 ** invocation of min() or max() altogether. Or, if this is not
danfa4b0d42020-07-01 14:07:45 +00006180 ** the first row (regAcc contains 1), set the magnet register so that
6181 ** the accumulators are not populated unless the min()/max() is invoked
6182 ** and indicates that they should be. */
daned09ddd2019-09-20 20:52:16 +00006183 sqlite3VdbeAddOp2(v, OP_Copy, regAcc, regHit);
6184 }
dan6ba7ab02019-07-02 11:56:47 +00006185 addrNext = sqlite3VdbeMakeLabel(pParse);
6186 sqlite3ExprIfFalse(pParse, pFilter, addrNext, SQLITE_JUMPIFNULL);
6187 }
drh13449892005-09-07 21:22:45 +00006188 if( pList ){
6189 nArg = pList->nExpr;
drh892d3172008-01-10 03:46:36 +00006190 regAgg = sqlite3GetTempRange(pParse, nArg);
drh5579d592015-08-26 14:01:41 +00006191 sqlite3ExprCodeExprList(pParse, pList, regAgg, 0, SQLITE_ECEL_DUP);
drh13449892005-09-07 21:22:45 +00006192 }else{
6193 nArg = 0;
drh98757152008-01-09 23:04:12 +00006194 regAgg = 0;
drh13449892005-09-07 21:22:45 +00006195 }
dan4fcb30b2021-03-09 16:06:25 +00006196 if( pF->iDistinct>=0 && pList ){
dan6ba7ab02019-07-02 11:56:47 +00006197 if( addrNext==0 ){
6198 addrNext = sqlite3VdbeMakeLabel(pParse);
6199 }
dan5383db72021-03-12 18:24:31 +00006200 pF->iDistinct = codeDistinct(pParse, eDistinctType,
6201 pF->iDistinct, addrNext, pList, regAgg);
drhc99130f2005-09-11 11:56:27 +00006202 }
drhd36e1042013-09-06 13:10:12 +00006203 if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh13449892005-09-07 21:22:45 +00006204 CollSeq *pColl = 0;
6205 struct ExprList_item *pItem;
6206 int j;
drhe82f5d02008-10-07 19:53:14 +00006207 assert( pList!=0 ); /* pList!=0 if pF->pFunc has NEEDCOLL */
drh43617e92006-03-06 20:55:46 +00006208 for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
drh13449892005-09-07 21:22:45 +00006209 pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
6210 }
6211 if( !pColl ){
6212 pColl = pParse->db->pDfltColl;
6213 }
drh7a957892012-02-02 17:35:43 +00006214 if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
6215 sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
drh13449892005-09-07 21:22:45 +00006216 }
drh8f26da62018-07-05 21:22:57 +00006217 sqlite3VdbeAddOp3(v, OP_AggStep, 0, regAgg, pF->iMem);
drh2700aca2016-12-08 01:38:24 +00006218 sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
drhea678832008-12-10 19:26:22 +00006219 sqlite3VdbeChangeP5(v, (u8)nArg);
drhf49f3522009-12-30 14:12:38 +00006220 sqlite3ReleaseTempRange(pParse, regAgg, nArg);
drhc99130f2005-09-11 11:56:27 +00006221 if( addrNext ){
6222 sqlite3VdbeResolveLabel(v, addrNext);
6223 }
drh13449892005-09-07 21:22:45 +00006224 }
dan280c8942018-06-05 20:04:28 +00006225 if( regHit==0 && pAggInfo->nAccumulator ){
6226 regHit = regAcc;
6227 }
drh7a957892012-02-02 17:35:43 +00006228 if( regHit ){
drh688852a2014-02-17 22:40:43 +00006229 addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
drh7a957892012-02-02 17:35:43 +00006230 }
drh13449892005-09-07 21:22:45 +00006231 for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
drh81185a52020-06-09 13:38:12 +00006232 sqlite3ExprCode(pParse, pC->pCExpr, pC->iMem);
drh13449892005-09-07 21:22:45 +00006233 }
daned09ddd2019-09-20 20:52:16 +00006234
drh13449892005-09-07 21:22:45 +00006235 pAggInfo->directMode = 0;
drh7a957892012-02-02 17:35:43 +00006236 if( addrHitTest ){
drhdc4f6fc2020-02-07 19:44:13 +00006237 sqlite3VdbeJumpHereOrPopInst(v, addrHitTest);
drh7a957892012-02-02 17:35:43 +00006238 }
drh13449892005-09-07 21:22:45 +00006239}
6240
danielk1977b3bce662005-01-29 08:32:43 +00006241/*
danef7075d2011-02-21 17:49:49 +00006242** Add a single OP_Explain instruction to the VDBE to explain a simple
6243** count(*) query ("SELECT count(*) FROM pTab").
6244*/
6245#ifndef SQLITE_OMIT_EXPLAIN
6246static void explainSimpleCount(
6247 Parse *pParse, /* Parse context */
6248 Table *pTab, /* Table being queried */
6249 Index *pIdx /* Index used to optimize scan, or NULL */
6250){
6251 if( pParse->explain==2 ){
drh48dd1d82014-05-27 18:18:58 +00006252 int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
drh82102332021-03-20 15:11:29 +00006253 sqlite3VdbeExplain(pParse, 0, "SCAN %s%s%s",
dane96f2df2014-05-23 17:17:06 +00006254 pTab->zName,
6255 bCover ? " USING COVERING INDEX " : "",
6256 bCover ? pIdx->zName : ""
danef7075d2011-02-21 17:49:49 +00006257 );
danef7075d2011-02-21 17:49:49 +00006258 }
6259}
6260#else
6261# define explainSimpleCount(a,b,c)
6262#endif
6263
6264/*
danab31a842017-04-29 20:53:09 +00006265** sqlite3WalkExpr() callback used by havingToWhere().
6266**
6267** If the node passed to the callback is a TK_AND node, return
6268** WRC_Continue to tell sqlite3WalkExpr() to iterate through child nodes.
6269**
6270** Otherwise, return WRC_Prune. In this case, also check if the
6271** sub-expression matches the criteria for being moved to the WHERE
6272** clause. If so, add it to the WHERE clause and replace the sub-expression
6273** within the HAVING expression with a constant "1".
6274*/
6275static int havingToWhereExprCb(Walker *pWalker, Expr *pExpr){
6276 if( pExpr->op!=TK_AND ){
drhcd0abc22018-03-20 18:08:33 +00006277 Select *pS = pWalker->u.pSelect;
dand59f9832021-07-20 14:57:49 +00006278 /* This routine is called before the HAVING clause of the current
6279 ** SELECT is analyzed for aggregates. So if pExpr->pAggInfo is set
6280 ** here, it indicates that the expression is a correlated reference to a
6281 ** column from an outer aggregate query, or an aggregate function that
6282 ** belongs to an outer query. Do not move the expression to the WHERE
6283 ** clause in this obscure case, as doing so may corrupt the outer Select
6284 ** statements AggInfo structure. */
danf39168e2020-12-22 16:23:29 +00006285 if( sqlite3ExprIsConstantOrGroupBy(pWalker->pParse, pExpr, pS->pGroupBy)
6286 && ExprAlwaysFalse(pExpr)==0
dand59f9832021-07-20 14:57:49 +00006287 && pExpr->pAggInfo==0
danf39168e2020-12-22 16:23:29 +00006288 ){
danab31a842017-04-29 20:53:09 +00006289 sqlite3 *db = pWalker->pParse->db;
drh5776ee52019-09-23 12:38:10 +00006290 Expr *pNew = sqlite3Expr(db, TK_INTEGER, "1");
danab31a842017-04-29 20:53:09 +00006291 if( pNew ){
drhcd0abc22018-03-20 18:08:33 +00006292 Expr *pWhere = pS->pWhere;
danab31a842017-04-29 20:53:09 +00006293 SWAP(Expr, *pNew, *pExpr);
drhd5c851c2019-04-19 13:38:34 +00006294 pNew = sqlite3ExprAnd(pWalker->pParse, pWhere, pNew);
drhcd0abc22018-03-20 18:08:33 +00006295 pS->pWhere = pNew;
6296 pWalker->eCode = 1;
danab31a842017-04-29 20:53:09 +00006297 }
6298 }
6299 return WRC_Prune;
6300 }
6301 return WRC_Continue;
6302}
6303
6304/*
6305** Transfer eligible terms from the HAVING clause of a query, which is
6306** processed after grouping, to the WHERE clause, which is processed before
6307** grouping. For example, the query:
6308**
6309** SELECT * FROM <tables> WHERE a=? GROUP BY b HAVING b=? AND c=?
6310**
6311** can be rewritten as:
6312**
6313** SELECT * FROM <tables> WHERE a=? AND b=? GROUP BY b HAVING c=?
6314**
6315** A term of the HAVING expression is eligible for transfer if it consists
6316** entirely of constants and expressions that are also GROUP BY terms that
6317** use the "BINARY" collation sequence.
6318*/
drhcd0abc22018-03-20 18:08:33 +00006319static void havingToWhere(Parse *pParse, Select *p){
danab31a842017-04-29 20:53:09 +00006320 Walker sWalker;
danab31a842017-04-29 20:53:09 +00006321 memset(&sWalker, 0, sizeof(sWalker));
6322 sWalker.pParse = pParse;
6323 sWalker.xExprCallback = havingToWhereExprCb;
drhcd0abc22018-03-20 18:08:33 +00006324 sWalker.u.pSelect = p;
6325 sqlite3WalkExpr(&sWalker, p->pHaving);
drh5e431be2022-04-06 11:08:38 +00006326#if TREETRACE_ENABLED
6327 if( sWalker.eCode && (sqlite3TreeTrace & 0x100)!=0 ){
drhcd0abc22018-03-20 18:08:33 +00006328 SELECTTRACE(0x100,pParse,p,("Move HAVING terms into WHERE:\n"));
6329 sqlite3TreeViewSelect(0, p, 0);
6330 }
6331#endif
danab31a842017-04-29 20:53:09 +00006332}
6333
6334/*
drhe08e8d62017-05-01 15:15:41 +00006335** Check to see if the pThis entry of pTabList is a self-join of a prior view.
6336** If it is, then return the SrcList_item for the prior view. If it is not,
6337** then return 0.
6338*/
drh76012942021-02-21 21:04:54 +00006339static SrcItem *isSelfJoinView(
drhe08e8d62017-05-01 15:15:41 +00006340 SrcList *pTabList, /* Search for self-joins in this FROM clause */
drh76012942021-02-21 21:04:54 +00006341 SrcItem *pThis /* Search for prior reference to this subquery */
drhe08e8d62017-05-01 15:15:41 +00006342){
drh76012942021-02-21 21:04:54 +00006343 SrcItem *pItem;
drh8794c682021-02-13 16:39:24 +00006344 assert( pThis->pSelect!=0 );
6345 if( pThis->pSelect->selFlags & SF_PushDown ) return 0;
drhe08e8d62017-05-01 15:15:41 +00006346 for(pItem = pTabList->a; pItem<pThis; pItem++){
drhbdefaf02018-12-27 02:16:01 +00006347 Select *pS1;
drhe08e8d62017-05-01 15:15:41 +00006348 if( pItem->pSelect==0 ) continue;
6349 if( pItem->fg.viaCoroutine ) continue;
drh33543c22017-05-01 16:37:20 +00006350 if( pItem->zName==0 ) continue;
drh30ad79a2019-05-23 16:38:12 +00006351 assert( pItem->pTab!=0 );
6352 assert( pThis->pTab!=0 );
6353 if( pItem->pTab->pSchema!=pThis->pTab->pSchema ) continue;
drhed712982017-05-01 17:04:35 +00006354 if( sqlite3_stricmp(pItem->zName, pThis->zName)!=0 ) continue;
drhbdefaf02018-12-27 02:16:01 +00006355 pS1 = pItem->pSelect;
drh30ad79a2019-05-23 16:38:12 +00006356 if( pItem->pTab->pSchema==0 && pThis->pSelect->selId!=pS1->selId ){
drhbdefaf02018-12-27 02:16:01 +00006357 /* The query flattener left two different CTE tables with identical
6358 ** names in the same FROM clause. */
6359 continue;
6360 }
drh8794c682021-02-13 16:39:24 +00006361 if( pItem->pSelect->selFlags & SF_PushDown ){
drhed712982017-05-01 17:04:35 +00006362 /* The view was modified by some other optimization such as
6363 ** pushDownWhereTerms() */
6364 continue;
6365 }
6366 return pItem;
drhe08e8d62017-05-01 15:15:41 +00006367 }
6368 return 0;
6369}
6370
drhc54246f2021-02-17 21:13:14 +00006371/*
6372** Deallocate a single AggInfo object
6373*/
6374static void agginfoFree(sqlite3 *db, AggInfo *p){
6375 sqlite3DbFree(db, p->aCol);
6376 sqlite3DbFree(db, p->aFunc);
6377 sqlite3DbFreeNN(db, p);
6378}
6379
drh269ba802017-07-04 19:34:36 +00006380#ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6381/*
6382** Attempt to transform a query of the form
6383**
6384** SELECT count(*) FROM (SELECT x FROM t1 UNION ALL SELECT y FROM t2)
6385**
6386** Into this:
6387**
6388** SELECT (SELECT count(*) FROM t1)+(SELECT count(*) FROM t2)
6389**
6390** The transformation only works if all of the following are true:
6391**
6392** * The subquery is a UNION ALL of two or more terms
dana4b5fb52018-08-03 20:19:52 +00006393** * The subquery does not have a LIMIT clause
drh269ba802017-07-04 19:34:36 +00006394** * There is no WHERE or GROUP BY or HAVING clauses on the subqueries
drh73c53b32019-05-15 18:42:15 +00006395** * The outer query is a simple count(*) with no WHERE clause or other
6396** extraneous syntax.
drh269ba802017-07-04 19:34:36 +00006397**
6398** Return TRUE if the optimization is undertaken.
6399*/
6400static int countOfViewOptimization(Parse *pParse, Select *p){
6401 Select *pSub, *pPrior;
6402 Expr *pExpr;
6403 Expr *pCount;
6404 sqlite3 *db;
drh3d240d22017-09-28 16:56:55 +00006405 if( (p->selFlags & SF_Aggregate)==0 ) return 0; /* This is an aggregate */
drh269ba802017-07-04 19:34:36 +00006406 if( p->pEList->nExpr!=1 ) return 0; /* Single result column */
drh73c53b32019-05-15 18:42:15 +00006407 if( p->pWhere ) return 0;
6408 if( p->pGroupBy ) return 0;
drh269ba802017-07-04 19:34:36 +00006409 pExpr = p->pEList->a[0].pExpr;
6410 if( pExpr->op!=TK_AGG_FUNCTION ) return 0; /* Result is an aggregate */
drha4eeccd2021-10-07 17:43:30 +00006411 assert( ExprUseUToken(pExpr) );
drh3d240d22017-09-28 16:56:55 +00006412 if( sqlite3_stricmp(pExpr->u.zToken,"count") ) return 0; /* Is count() */
drha4eeccd2021-10-07 17:43:30 +00006413 assert( ExprUseXList(pExpr) );
drh269ba802017-07-04 19:34:36 +00006414 if( pExpr->x.pList!=0 ) return 0; /* Must be count(*) */
drh3d240d22017-09-28 16:56:55 +00006415 if( p->pSrc->nSrc!=1 ) return 0; /* One table in FROM */
drh269ba802017-07-04 19:34:36 +00006416 pSub = p->pSrc->a[0].pSelect;
6417 if( pSub==0 ) return 0; /* The FROM is a subquery */
drh3d240d22017-09-28 16:56:55 +00006418 if( pSub->pPrior==0 ) return 0; /* Must be a compound ry */
drh269ba802017-07-04 19:34:36 +00006419 do{
6420 if( pSub->op!=TK_ALL && pSub->pPrior ) return 0; /* Must be UNION ALL */
6421 if( pSub->pWhere ) return 0; /* No WHERE clause */
dana4b5fb52018-08-03 20:19:52 +00006422 if( pSub->pLimit ) return 0; /* No LIMIT clause */
drh269ba802017-07-04 19:34:36 +00006423 if( pSub->selFlags & SF_Aggregate ) return 0; /* Not an aggregate */
drh3d240d22017-09-28 16:56:55 +00006424 pSub = pSub->pPrior; /* Repeat over compound */
drh269ba802017-07-04 19:34:36 +00006425 }while( pSub );
6426
drh3d240d22017-09-28 16:56:55 +00006427 /* If we reach this point then it is OK to perform the transformation */
drh269ba802017-07-04 19:34:36 +00006428
6429 db = pParse->db;
6430 pCount = pExpr;
6431 pExpr = 0;
6432 pSub = p->pSrc->a[0].pSelect;
6433 p->pSrc->a[0].pSelect = 0;
6434 sqlite3SrcListDelete(db, p->pSrc);
6435 p->pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*p->pSrc));
6436 while( pSub ){
6437 Expr *pTerm;
6438 pPrior = pSub->pPrior;
6439 pSub->pPrior = 0;
6440 pSub->pNext = 0;
6441 pSub->selFlags |= SF_Aggregate;
6442 pSub->selFlags &= ~SF_Compound;
6443 pSub->nSelectRow = 0;
6444 sqlite3ExprListDelete(db, pSub->pEList);
6445 pTerm = pPrior ? sqlite3ExprDup(db, pCount, 0) : pCount;
6446 pSub->pEList = sqlite3ExprListAppend(pParse, 0, pTerm);
6447 pTerm = sqlite3PExpr(pParse, TK_SELECT, 0, 0);
6448 sqlite3PExprAddSelect(pParse, pTerm, pSub);
6449 if( pExpr==0 ){
6450 pExpr = pTerm;
6451 }else{
6452 pExpr = sqlite3PExpr(pParse, TK_PLUS, pTerm, pExpr);
6453 }
6454 pSub = pPrior;
6455 }
6456 p->pEList->a[0].pExpr = pExpr;
6457 p->selFlags &= ~SF_Aggregate;
6458
drh5e431be2022-04-06 11:08:38 +00006459#if TREETRACE_ENABLED
6460 if( sqlite3TreeTrace & 0x400 ){
drh269ba802017-07-04 19:34:36 +00006461 SELECTTRACE(0x400,pParse,p,("After count-of-view optimization:\n"));
6462 sqlite3TreeViewSelect(0, p, 0);
6463 }
6464#endif
6465 return 1;
6466}
6467#endif /* SQLITE_COUNTOFVIEW_OPTIMIZATION */
6468
drhe08e8d62017-05-01 15:15:41 +00006469/*
drh7d10d5a2008-08-20 16:35:10 +00006470** Generate code for the SELECT statement given in the p argument.
drh9bb61fe2000-06-05 16:01:39 +00006471**
drh340309f2014-01-22 00:23:49 +00006472** The results are returned according to the SelectDest structure.
6473** See comments in sqliteInt.h for further information.
drhe78e8282003-01-19 03:59:45 +00006474**
drh9bb61fe2000-06-05 16:01:39 +00006475** This routine returns the number of errors. If any errors are
6476** encountered, then an appropriate error message is left in
6477** pParse->zErrMsg.
6478**
6479** This routine does NOT free the Select structure passed in. The
6480** calling function needs to do that.
6481*/
danielk19774adee202004-05-08 08:23:19 +00006482int sqlite3Select(
drhcce7d172000-05-31 15:34:51 +00006483 Parse *pParse, /* The parser context */
drh9bb61fe2000-06-05 16:01:39 +00006484 Select *p, /* The SELECT statement being coded. */
drh7d10d5a2008-08-20 16:35:10 +00006485 SelectDest *pDest /* What to do with the query results */
drhcce7d172000-05-31 15:34:51 +00006486){
drh13449892005-09-07 21:22:45 +00006487 int i, j; /* Loop counters */
6488 WhereInfo *pWInfo; /* Return from sqlite3WhereBegin() */
6489 Vdbe *v; /* The virtual machine under construction */
danielk1977b3bce662005-01-29 08:32:43 +00006490 int isAgg; /* True for select lists like "count(*)" */
mistachkinc29cbb02015-07-02 16:52:01 +00006491 ExprList *pEList = 0; /* List of columns to extract. */
drhad3cab52002-05-24 02:04:32 +00006492 SrcList *pTabList; /* List of tables to select from */
drh9bb61fe2000-06-05 16:01:39 +00006493 Expr *pWhere; /* The WHERE clause. May be NULL */
drh22827922000-06-06 17:27:05 +00006494 ExprList *pGroupBy; /* The GROUP BY clause. May be NULL */
6495 Expr *pHaving; /* The HAVING clause. May be NULL */
drhbf790972020-06-07 20:18:07 +00006496 AggInfo *pAggInfo = 0; /* Aggregate information */
drh1d83f052002-02-17 00:30:36 +00006497 int rc = 1; /* Value to return from this function */
drhe8e4af72012-09-21 00:04:28 +00006498 DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
drh079a3072014-03-19 14:10:55 +00006499 SortCtx sSort; /* Info on how to code the ORDER BY clause */
drhec7429a2005-10-06 16:53:14 +00006500 int iEnd; /* Address of the end of the query */
drh17435752007-08-16 04:30:38 +00006501 sqlite3 *db; /* The database connection */
drh47d9f832017-10-26 20:04:28 +00006502 ExprList *pMinMaxOrderBy = 0; /* Added ORDER BY for min/max queries */
6503 u8 minMaxFlag; /* Flag for min/max queries */
drh9bb61fe2000-06-05 16:01:39 +00006504
drh17435752007-08-16 04:30:38 +00006505 db = pParse->db;
drh0c7d3d32022-01-24 16:47:12 +00006506 assert( pParse==db->pParse );
drhe2ca99c2018-05-02 00:33:43 +00006507 v = sqlite3GetVdbe(pParse);
drh0c7d3d32022-01-24 16:47:12 +00006508 if( p==0 || pParse->nErr ){
drh6f7adc82006-01-11 21:41:20 +00006509 return 1;
6510 }
drh0c7d3d32022-01-24 16:47:12 +00006511 assert( db->mallocFailed==0 );
danielk19774adee202004-05-08 08:23:19 +00006512 if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
drh5e431be2022-04-06 11:08:38 +00006513#if TREETRACE_ENABLED
drhe2ca99c2018-05-02 00:33:43 +00006514 SELECTTRACE(1,pParse,p, ("begin processing:\n", pParse->addrExplain));
drhc2d0df92022-04-06 18:30:17 +00006515 if( sqlite3TreeTrace & 0x10100 ){
6516 if( (sqlite3TreeTrace & 0x10001)==0x10000 ){
6517 sqlite3TreeViewLine(0, "In sqlite3Select() at %s:%d",
6518 __FILE__, __LINE__);
6519 }
6520 sqlite3ShowSelect(p);
drhc90713d2014-09-30 13:46:49 +00006521 }
drheb9b8842014-09-21 00:27:26 +00006522#endif
drhdaffd0e2001-04-11 14:28:42 +00006523
drh8e1ee882014-03-21 19:56:09 +00006524 assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
6525 assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
dan9afccba2014-03-21 19:27:54 +00006526 assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
6527 assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
drhf1ea4252020-09-17 00:46:09 +00006528 if( IgnorableDistinct(pDest) ){
6529 assert(pDest->eDest==SRT_Exists || pDest->eDest==SRT_Union ||
6530 pDest->eDest==SRT_Except || pDest->eDest==SRT_Discard ||
6531 pDest->eDest==SRT_DistQueue || pDest->eDest==SRT_DistFifo );
6532 /* All of these destinations are also able to ignore the ORDER BY clause */
drhfad1ad02021-03-03 14:07:52 +00006533 if( p->pOrderBy ){
drh5e431be2022-04-06 11:08:38 +00006534#if TREETRACE_ENABLED
drhfad1ad02021-03-03 14:07:52 +00006535 SELECTTRACE(1,pParse,p, ("dropping superfluous ORDER BY:\n"));
drh5e431be2022-04-06 11:08:38 +00006536 if( sqlite3TreeTrace & 0x100 ){
drhfad1ad02021-03-03 14:07:52 +00006537 sqlite3TreeViewExprList(0, p->pOrderBy, 0, "ORDERBY");
6538 }
6539#endif
6540 sqlite3ParserAddCleanup(pParse,
6541 (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
6542 p->pOrderBy);
drh6d0053c2021-03-09 19:32:37 +00006543 testcase( pParse->earlyCleanup );
drhfad1ad02021-03-03 14:07:52 +00006544 p->pOrderBy = 0;
6545 }
drh7d10d5a2008-08-20 16:35:10 +00006546 p->selFlags &= ~SF_Distinct;
drhb7cbf5c2020-06-15 13:51:34 +00006547 p->selFlags |= SF_NoopOrderBy;
drh9a993342007-12-13 02:45:31 +00006548 }
drh7d10d5a2008-08-20 16:35:10 +00006549 sqlite3SelectPrep(pParse, p, 0);
drh0c7d3d32022-01-24 16:47:12 +00006550 if( pParse->nErr ){
drh9a993342007-12-13 02:45:31 +00006551 goto select_end;
6552 }
drh0c7d3d32022-01-24 16:47:12 +00006553 assert( db->mallocFailed==0 );
drhadc57f62015-06-06 00:18:01 +00006554 assert( p->pEList!=0 );
drh5e431be2022-04-06 11:08:38 +00006555#if TREETRACE_ENABLED
6556 if( sqlite3TreeTrace & 0x104 ){
drhe2243d22018-04-23 17:18:03 +00006557 SELECTTRACE(0x104,pParse,p, ("after name resolution:\n"));
drh17645f52015-02-09 13:42:59 +00006558 sqlite3TreeViewSelect(0, p, 0);
6559 }
6560#endif
drhcce7d172000-05-31 15:34:51 +00006561
dan5daf69e2021-07-05 11:27:13 +00006562 /* If the SF_UFSrcCheck flag is set, then this function is being called
dan07ca7d62020-07-17 16:31:37 +00006563 ** as part of populating the temp table for an UPDATE...FROM statement.
6564 ** In this case, it is an error if the target object (pSrc->a[0]) name
dan5daf69e2021-07-05 11:27:13 +00006565 ** or alias is duplicated within FROM clause (pSrc->a[1..n]).
6566 **
6567 ** Postgres disallows this case too. The reason is that some other
6568 ** systems handle this case differently, and not all the same way,
6569 ** which is just confusing. To avoid this, we follow PG's lead and
6570 ** disallow it altogether. */
6571 if( p->selFlags & SF_UFSrcCheck ){
drh76012942021-02-21 21:04:54 +00006572 SrcItem *p0 = &p->pSrc->a[0];
dan07ca7d62020-07-17 16:31:37 +00006573 for(i=1; i<p->pSrc->nSrc; i++){
drh76012942021-02-21 21:04:54 +00006574 SrcItem *p1 = &p->pSrc->a[i];
dan07ca7d62020-07-17 16:31:37 +00006575 if( p0->pTab==p1->pTab && 0==sqlite3_stricmp(p0->zAlias, p1->zAlias) ){
6576 sqlite3ErrorMsg(pParse,
6577 "target object/alias may not appear in FROM clause: %s",
6578 p0->zAlias ? p0->zAlias : p0->pTab->zName
6579 );
6580 goto select_end;
6581 }
6582 }
dan5daf69e2021-07-05 11:27:13 +00006583
6584 /* Clear the SF_UFSrcCheck flag. The check has already been performed,
6585 ** and leaving this flag set can cause errors if a compound sub-query
6586 ** in p->pSrc is flattened into this query and this function called
6587 ** again as part of compound SELECT processing. */
6588 p->selFlags &= ~SF_UFSrcCheck;
dan07ca7d62020-07-17 16:31:37 +00006589 }
6590
drhf35f2f92017-07-29 16:01:55 +00006591 if( pDest->eDest==SRT_Output ){
drh90881862021-05-19 12:17:03 +00006592 sqlite3GenerateColumnNames(pParse, p);
drhf35f2f92017-07-29 16:01:55 +00006593 }
6594
dan67a9b8e2018-06-22 20:51:35 +00006595#ifndef SQLITE_OMIT_WINDOWFUNC
dan44918c72021-04-17 14:42:37 +00006596 if( sqlite3WindowRewrite(pParse, p) ){
drh0c7d3d32022-01-24 16:47:12 +00006597 assert( pParse->nErr );
dan86fb6e12018-05-16 20:58:07 +00006598 goto select_end;
6599 }
drh5e431be2022-04-06 11:08:38 +00006600#if TREETRACE_ENABLED
6601 if( p->pWin && (sqlite3TreeTrace & 0x108)!=0 ){
dandfa552f2018-06-02 21:04:28 +00006602 SELECTTRACE(0x104,pParse,p, ("after window rewrite:\n"));
6603 sqlite3TreeViewSelect(0, p, 0);
6604 }
6605#endif
dan67a9b8e2018-06-22 20:51:35 +00006606#endif /* SQLITE_OMIT_WINDOWFUNC */
dan86fb6e12018-05-16 20:58:07 +00006607 pTabList = p->pSrc;
dan73925692018-06-12 18:40:17 +00006608 isAgg = (p->selFlags & SF_Aggregate)!=0;
danf02cdd32018-06-27 19:48:50 +00006609 memset(&sSort, 0, sizeof(sSort));
6610 sSort.pOrderBy = p->pOrderBy;
dan86fb6e12018-05-16 20:58:07 +00006611
drh9216de82020-06-11 00:57:09 +00006612 /* Try to do various optimizations (flattening subqueries, and strength
drh25897872018-03-20 21:16:15 +00006613 ** reduction of join operators) in the FROM clause up into the main query
drhd820cb12002-02-18 03:21:45 +00006614 */
drh51522cd2005-01-20 13:36:19 +00006615#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
danielk1977f23329a2008-07-01 14:09:13 +00006616 for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
drh76012942021-02-21 21:04:54 +00006617 SrcItem *pItem = &pTabList->a[i];
danielk1977daf79ac2008-06-30 18:12:28 +00006618 Select *pSub = pItem->pSelect;
drh2679f142015-09-25 13:42:55 +00006619 Table *pTab = pItem->pTab;
drh25897872018-03-20 21:16:15 +00006620
drhb5aaee52020-06-11 16:04:10 +00006621 /* The expander should have already created transient Table objects
6622 ** even for FROM clause elements such as subqueries that do not correspond
6623 ** to a real table */
6624 assert( pTab!=0 );
6625
drh25897872018-03-20 21:16:15 +00006626 /* Convert LEFT JOIN into JOIN if there are terms of the right table
6627 ** of the LEFT JOIN used in the WHERE clause.
6628 */
drhff02ac72022-04-11 14:43:11 +00006629 if( (pItem->fg.jointype & (JT_LEFT|JT_RIGHT))==JT_LEFT
drh25897872018-03-20 21:16:15 +00006630 && sqlite3ExprImpliesNonNullRow(p->pWhere, pItem->iCursor)
6631 && OptimizationEnabled(db, SQLITE_SimplifyJoin)
6632 ){
6633 SELECTTRACE(0x100,pParse,p,
6634 ("LEFT-JOIN simplifies to JOIN on term %d\n",i));
drhefce69d2018-03-20 22:52:27 +00006635 pItem->fg.jointype &= ~(JT_LEFT|JT_OUTER);
drh25897872018-03-20 21:16:15 +00006636 unsetJoinExpr(p->pWhere, pItem->iCursor);
6637 }
6638
6639 /* No futher action if this term of the FROM clause is no a subquery */
drh4490c402015-06-05 22:33:39 +00006640 if( pSub==0 ) continue;
drh2679f142015-09-25 13:42:55 +00006641
6642 /* Catch mismatch in the declared columns of a view and the number of
6643 ** columns in the SELECT on the RHS */
6644 if( pTab->nCol!=pSub->pEList->nExpr ){
6645 sqlite3ErrorMsg(pParse, "expected %d columns for '%s' but got %d",
6646 pTab->nCol, pTab->zName, pSub->pEList->nExpr);
6647 goto select_end;
6648 }
6649
drh25c221e2017-09-29 22:13:24 +00006650 /* Do not try to flatten an aggregate subquery.
6651 **
6652 ** Flattening an aggregate subquery is only possible if the outer query
6653 ** is not a join. But if the outer query is not a join, then the subquery
6654 ** will be implemented as a co-routine and there is no advantage to
6655 ** flattening in that case.
6656 */
6657 if( (pSub->selFlags & SF_Aggregate)!=0 ) continue;
6658 assert( pSub->pGroupBy==0 );
6659
drhbb301232021-07-15 19:29:43 +00006660 /* If a FROM-clause subquery has an ORDER BY clause that is not
6661 ** really doing anything, then delete it now so that it does not
drh0fb78f02021-07-16 01:19:19 +00006662 ** interfere with query flattening. See the discussion at
6663 ** https://sqlite.org/forum/forumpost/2d76f2bcf65d256a
drhbb301232021-07-15 19:29:43 +00006664 **
6665 ** Beware of these cases where the ORDER BY clause may not be safely
6666 ** omitted:
6667 **
6668 ** (1) There is also a LIMIT clause
6669 ** (2) The subquery was added to help with window-function
6670 ** processing
drh0fb78f02021-07-16 01:19:19 +00006671 ** (3) The subquery is in the FROM clause of an UPDATE
6672 ** (4) The outer query uses an aggregate function other than
drhbb301232021-07-15 19:29:43 +00006673 ** the built-in count(), min(), or max().
drh0fb78f02021-07-16 01:19:19 +00006674 ** (5) The ORDER BY isn't going to accomplish anything because
6675 ** one of:
6676 ** (a) The outer query has a different ORDER BY clause
6677 ** (b) The subquery is part of a join
6678 ** See forum post 062d576715d277c8
drhbb301232021-07-15 19:29:43 +00006679 */
6680 if( pSub->pOrderBy!=0
drh0fb78f02021-07-16 01:19:19 +00006681 && (p->pOrderBy!=0 || pTabList->nSrc>1) /* Condition (5) */
drhbb301232021-07-15 19:29:43 +00006682 && pSub->pLimit==0 /* Condition (1) */
6683 && (pSub->selFlags & SF_OrderByReqd)==0 /* Condition (2) */
drh0fb78f02021-07-16 01:19:19 +00006684 && (p->selFlags & SF_OrderByReqd)==0 /* Condition (3) and (4) */
drhbb301232021-07-15 19:29:43 +00006685 && OptimizationEnabled(db, SQLITE_OmitOrderBy)
6686 ){
6687 SELECTTRACE(0x100,pParse,p,
6688 ("omit superfluous ORDER BY on %r FROM-clause subquery\n",i+1));
6689 sqlite3ExprListDelete(db, pSub->pOrderBy);
6690 pSub->pOrderBy = 0;
6691 }
6692
drhfca23552017-10-28 20:51:54 +00006693 /* If the outer query contains a "complex" result set (that is,
6694 ** if the result set of the outer query uses functions or subqueries)
6695 ** and if the subquery contains an ORDER BY clause and if
drh648fe492017-09-28 20:06:53 +00006696 ** it will be implemented as a co-routine, then do not flatten. This
6697 ** restriction allows SQL constructs like this:
6698 **
6699 ** SELECT expensive_function(x)
6700 ** FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
6701 **
6702 ** The expensive_function() is only computed on the 10 rows that
6703 ** are output, rather than every row of the table.
drhfca23552017-10-28 20:51:54 +00006704 **
6705 ** The requirement that the outer query have a complex result set
6706 ** means that flattening does occur on simpler SQL constraints without
6707 ** the expensive_function() like:
6708 **
6709 ** SELECT x FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
drh648fe492017-09-28 20:06:53 +00006710 */
drh25c221e2017-09-29 22:13:24 +00006711 if( pSub->pOrderBy!=0
drh648fe492017-09-28 20:06:53 +00006712 && i==0
drhfca23552017-10-28 20:51:54 +00006713 && (p->selFlags & SF_ComplexResult)!=0
drh648fe492017-09-28 20:06:53 +00006714 && (pTabList->nSrc==1
drha76ac882022-04-08 19:20:12 +00006715 || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0)
drh648fe492017-09-28 20:06:53 +00006716 ){
6717 continue;
6718 }
6719
drh25c221e2017-09-29 22:13:24 +00006720 if( flattenSubquery(pParse, p, i, isAgg) ){
drh4acd7542019-02-06 00:55:47 +00006721 if( pParse->nErr ) goto select_end;
drh4490c402015-06-05 22:33:39 +00006722 /* This subquery can be absorbed into its parent. */
drh4490c402015-06-05 22:33:39 +00006723 i = -1;
6724 }
6725 pTabList = p->pSrc;
6726 if( db->mallocFailed ) goto select_end;
6727 if( !IgnorableOrderby(pDest) ){
6728 sSort.pOrderBy = p->pOrderBy;
6729 }
6730 }
6731#endif
6732
drh4490c402015-06-05 22:33:39 +00006733#ifndef SQLITE_OMIT_COMPOUND_SELECT
6734 /* Handle compound SELECT statements using the separate multiSelect()
6735 ** procedure.
6736 */
6737 if( p->pPrior ){
6738 rc = multiSelect(pParse, p, pDest);
drh5e431be2022-04-06 11:08:38 +00006739#if TREETRACE_ENABLED
drhf20609d2018-04-23 17:43:35 +00006740 SELECTTRACE(0x1,pParse,p,("end compound-select processing\n"));
drh5e431be2022-04-06 11:08:38 +00006741 if( (sqlite3TreeTrace & 0x2000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
drhf20609d2018-04-23 17:43:35 +00006742 sqlite3TreeViewSelect(0, p, 0);
6743 }
drh4490c402015-06-05 22:33:39 +00006744#endif
drhc631ded2018-05-02 02:22:22 +00006745 if( p->pNext==0 ) ExplainQueryPlanPop(pParse);
drh4490c402015-06-05 22:33:39 +00006746 return rc;
6747 }
6748#endif
6749
drh7810ab62018-07-27 17:51:20 +00006750 /* Do the WHERE-clause constant propagation optimization if this is
6751 ** a join. No need to speed time on this operation for non-join queries
6752 ** as the equivalent optimization will be handled by query planner in
6753 ** sqlite3WhereBegin().
6754 */
drhb775c972021-05-14 14:26:57 +00006755 if( p->pWhere!=0
6756 && p->pWhere->op==TK_AND
drh7810ab62018-07-27 17:51:20 +00006757 && OptimizationEnabled(db, SQLITE_PropagateConst)
drh24e11162018-07-26 23:47:11 +00006758 && propagateConstants(pParse, p)
6759 ){
drh5e431be2022-04-06 11:08:38 +00006760#if TREETRACE_ENABLED
6761 if( sqlite3TreeTrace & 0x100 ){
drh24e11162018-07-26 23:47:11 +00006762 SELECTTRACE(0x100,pParse,p,("After constant propagation:\n"));
6763 sqlite3TreeViewSelect(0, p, 0);
6764 }
6765#endif
6766 }else{
drh7810ab62018-07-27 17:51:20 +00006767 SELECTTRACE(0x100,pParse,p,("Constant propagation not helpful\n"));
drh24e11162018-07-26 23:47:11 +00006768 }
6769
dana4b5fb52018-08-03 20:19:52 +00006770#ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6771 if( OptimizationEnabled(db, SQLITE_QueryFlattener|SQLITE_CountOfView)
6772 && countOfViewOptimization(pParse, p)
6773 ){
6774 if( db->mallocFailed ) goto select_end;
6775 pEList = p->pEList;
6776 pTabList = p->pSrc;
6777 }
6778#endif
6779
drh701caf12017-05-10 16:12:00 +00006780 /* For each term in the FROM clause, do two things:
6781 ** (1) Authorized unreferenced tables
6782 ** (2) Generate code for all sub-queries
drhd820cb12002-02-18 03:21:45 +00006783 */
drh4490c402015-06-05 22:33:39 +00006784 for(i=0; i<pTabList->nSrc; i++){
drh76012942021-02-21 21:04:54 +00006785 SrcItem *pItem = &pTabList->a[i];
drha79e2a22021-02-21 23:44:14 +00006786 SrcItem *pPrior;
drh13449892005-09-07 21:22:45 +00006787 SelectDest dest;
drh701caf12017-05-10 16:12:00 +00006788 Select *pSub;
drh824d21a2017-09-29 12:44:52 +00006789#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6790 const char *zSavedAuthContext;
6791#endif
drh701caf12017-05-10 16:12:00 +00006792
drh3d240d22017-09-28 16:56:55 +00006793 /* Issue SQLITE_READ authorizations with a fake column name for any
6794 ** tables that are referenced but from which no values are extracted.
6795 ** Examples of where these kinds of null SQLITE_READ authorizations
6796 ** would occur:
drh701caf12017-05-10 16:12:00 +00006797 **
drh2336c932017-05-11 12:05:23 +00006798 ** SELECT count(*) FROM t1; -- SQLITE_READ t1.""
6799 ** SELECT t1.* FROM t1, t2; -- SQLITE_READ t2.""
6800 **
6801 ** The fake column name is an empty string. It is possible for a table to
6802 ** have a column named by the empty string, in which case there is no way to
6803 ** distinguish between an unreferenced table and an actual reference to the
drh3d240d22017-09-28 16:56:55 +00006804 ** "" column. The original design was for the fake column name to be a NULL,
drh2336c932017-05-11 12:05:23 +00006805 ** which would be unambiguous. But legacy authorization callbacks might
drh3d240d22017-09-28 16:56:55 +00006806 ** assume the column name is non-NULL and segfault. The use of an empty
6807 ** string for the fake column name seems safer.
drh701caf12017-05-10 16:12:00 +00006808 */
drh74c490e2019-08-07 13:25:21 +00006809 if( pItem->colUsed==0 && pItem->zName!=0 ){
drh2336c932017-05-11 12:05:23 +00006810 sqlite3AuthCheck(pParse, SQLITE_READ, pItem->zName, "", pItem->zDatabase);
drh701caf12017-05-10 16:12:00 +00006811 }
6812
6813#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6814 /* Generate code for all sub-queries in the FROM clause
6815 */
6816 pSub = pItem->pSelect;
drh5b6a9ed2011-09-15 23:58:14 +00006817 if( pSub==0 ) continue;
drh21172c42012-10-30 00:29:07 +00006818
drh14c4d422021-05-26 18:46:51 +00006819 /* The code for a subquery should only be generated once. */
6820 assert( pItem->addrFillSub==0 );
danielk1977daf79ac2008-06-30 18:12:28 +00006821
danielk1977fc976062007-05-10 10:46:56 +00006822 /* Increment Parse.nHeight by the height of the largest expression
drhf7b54962013-05-28 12:11:54 +00006823 ** tree referred to by this, the parent select. The child select
danielk1977fc976062007-05-10 10:46:56 +00006824 ** may contain expression trees of at most
6825 ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
6826 ** more conservative than necessary, but much easier than enforcing
6827 ** an exact limit.
6828 */
6829 pParse->nHeight += sqlite3SelectExprHeight(p);
danielk1977daf79ac2008-06-30 18:12:28 +00006830
drhadc57f62015-06-06 00:18:01 +00006831 /* Make copies of constant WHERE-clause terms in the outer query down
6832 ** inside the subquery. This can help the subquery to run more efficiently.
6833 */
drh7fbb1012018-03-21 01:59:46 +00006834 if( OptimizationEnabled(db, SQLITE_PushDown)
drhdf67ec02021-08-11 13:48:56 +00006835 && (pItem->fg.isCte==0
6836 || (pItem->u2.pCteUse->eM10d!=M10d_Yes && pItem->u2.pCteUse->nUse<2))
drh41798d52022-04-11 00:21:53 +00006837 && (pItem->fg.jointype & JT_RIGHT)==0
drh6a9b9522018-03-27 15:13:43 +00006838 && pushDownWhereTerms(pParse, pSub, p->pWhere, pItem->iCursor,
6839 (pItem->fg.jointype & JT_OUTER)!=0)
drh4490c402015-06-05 22:33:39 +00006840 ){
drh5e431be2022-04-06 11:08:38 +00006841#if TREETRACE_ENABLED
6842 if( sqlite3TreeTrace & 0x100 ){
drhd2a44012018-07-28 14:34:22 +00006843 SELECTTRACE(0x100,pParse,p,
6844 ("After WHERE-clause push-down into subquery %d:\n", pSub->selId));
drh4490c402015-06-05 22:33:39 +00006845 sqlite3TreeViewSelect(0, p, 0);
danielk1977daf79ac2008-06-30 18:12:28 +00006846 }
drh69b72d52015-06-01 20:28:03 +00006847#endif
drh8794c682021-02-13 16:39:24 +00006848 assert( pItem->pSelect && (pItem->pSelect->selFlags & SF_PushDown)!=0 );
drh2d277bb2018-03-20 11:24:30 +00006849 }else{
6850 SELECTTRACE(0x100,pParse,p,("Push-down not possible\n"));
drh4490c402015-06-05 22:33:39 +00006851 }
drhadc57f62015-06-06 00:18:01 +00006852
drh824d21a2017-09-29 12:44:52 +00006853 zSavedAuthContext = pParse->zAuthContext;
6854 pParse->zAuthContext = pItem->zName;
6855
drhadc57f62015-06-06 00:18:01 +00006856 /* Generate code to implement the subquery
drh0ff47e92016-03-15 17:52:12 +00006857 **
drh9debb582022-04-10 23:01:20 +00006858 ** The subquery is implemented as a co-routine all of the following are
6859 ** true:
6860 **
drha79e2a22021-02-21 23:44:14 +00006861 ** (1) the subquery is guaranteed to be the outer loop (so that
6862 ** it does not need to be computed more than once), and
drh745912e2021-02-22 03:04:25 +00006863 ** (2) the subquery is not a CTE that should be materialized
drh9debb582022-04-10 23:01:20 +00006864 ** (3) the subquery is not part of a left operand for a RIGHT JOIN
drhadc57f62015-06-06 00:18:01 +00006865 */
drh0ff47e92016-03-15 17:52:12 +00006866 if( i==0
6867 && (pTabList->nSrc==1
drha76ac882022-04-08 19:20:12 +00006868 || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0) /* (1) */
6869 && (pItem->fg.isCte==0 || pItem->u2.pCteUse->eM10d!=M10d_Yes) /* (2) */
drh9debb582022-04-10 23:01:20 +00006870 && (pTabList->a[0].fg.jointype & JT_LTORJ)==0 /* (3) */
drha5759672012-10-30 14:39:12 +00006871 ){
drh21172c42012-10-30 00:29:07 +00006872 /* Implement a co-routine that will return a single row of the result
6873 ** set on each invocation.
6874 */
drh4490c402015-06-05 22:33:39 +00006875 int addrTop = sqlite3VdbeCurrentAddr(v)+1;
drh824d21a2017-09-29 12:44:52 +00006876
drh21172c42012-10-30 00:29:07 +00006877 pItem->regReturn = ++pParse->nMem;
drh4490c402015-06-05 22:33:39 +00006878 sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
drha9799932021-03-19 13:00:28 +00006879 VdbeComment((v, "%!S", pItem));
drh21172c42012-10-30 00:29:07 +00006880 pItem->addrFillSub = addrTop;
drh21172c42012-10-30 00:29:07 +00006881 sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
drha9799932021-03-19 13:00:28 +00006882 ExplainQueryPlan((pParse, 1, "CO-ROUTINE %!S", pItem));
drh21172c42012-10-30 00:29:07 +00006883 sqlite3Select(pParse, pSub, &dest);
drhc3489bb2016-02-25 16:04:59 +00006884 pItem->pTab->nRowLogEst = pSub->nSelectRow;
drh8a48b9c2015-08-19 15:20:00 +00006885 pItem->fg.viaCoroutine = 1;
drh4490c402015-06-05 22:33:39 +00006886 pItem->regResult = dest.iSdst;
drh2fade2f2016-02-09 02:12:20 +00006887 sqlite3VdbeEndCoroutine(v, pItem->regReturn);
drh21172c42012-10-30 00:29:07 +00006888 sqlite3VdbeJumpHere(v, addrTop-1);
6889 sqlite3ClearTempRegCache(pParse);
drha79e2a22021-02-21 23:44:14 +00006890 }else if( pItem->fg.isCte && pItem->u2.pCteUse->addrM9e>0 ){
6891 /* This is a CTE for which materialization code has already been
6892 ** generated. Invoke the subroutine to compute the materialization,
6893 ** the make the pItem->iCursor be a copy of the ephemerial table that
6894 ** holds the result of the materialization. */
6895 CteUse *pCteUse = pItem->u2.pCteUse;
6896 sqlite3VdbeAddOp2(v, OP_Gosub, pCteUse->regRtn, pCteUse->addrM9e);
6897 if( pItem->iCursor!=pCteUse->iCur ){
6898 sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pCteUse->iCur);
drh834c6882021-08-11 13:19:13 +00006899 VdbeComment((v, "%!S", pItem));
drha79e2a22021-02-21 23:44:14 +00006900 }
6901 pSub->nSelectRow = pCteUse->nRowEst;
6902 }else if( (pPrior = isSelfJoinView(pTabList, pItem))!=0 ){
6903 /* This view has already been materialized by a prior entry in
6904 ** this same FROM clause. Reuse it. */
6905 if( pPrior->addrFillSub ){
6906 sqlite3VdbeAddOp2(v, OP_Gosub, pPrior->regReturn, pPrior->addrFillSub);
6907 }
6908 sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pPrior->iCursor);
6909 pSub->nSelectRow = pPrior->pSelect->nSelectRow;
danielk1977daf79ac2008-06-30 18:12:28 +00006910 }else{
drh14c4d422021-05-26 18:46:51 +00006911 /* Materialize the view. If the view is not correlated, generate a
drhd685dd62021-03-19 13:53:34 +00006912 ** subroutine to do the materialization so that subsequent uses of
6913 ** the same view can reuse the materialization. */
drh7157e8e2011-09-16 16:00:51 +00006914 int topAddr;
drh48f2d3b2011-09-16 01:34:43 +00006915 int onceAddr = 0;
drh7157e8e2011-09-16 16:00:51 +00006916 int retAddr;
drhe08e8d62017-05-01 15:15:41 +00006917
drh5b6a9ed2011-09-15 23:58:14 +00006918 pItem->regReturn = ++pParse->nMem;
drh7157e8e2011-09-16 16:00:51 +00006919 topAddr = sqlite3VdbeAddOp2(v, OP_Integer, 0, pItem->regReturn);
6920 pItem->addrFillSub = topAddr+1;
drh8a48b9c2015-08-19 15:20:00 +00006921 if( pItem->fg.isCorrelated==0 ){
drhed171672013-04-24 13:50:09 +00006922 /* If the subquery is not correlated and if we are not inside of
drh5b6a9ed2011-09-15 23:58:14 +00006923 ** a trigger, then we only need to compute the value of the subquery
6924 ** once. */
drh511f9e82016-09-22 18:53:13 +00006925 onceAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drha9799932021-03-19 13:00:28 +00006926 VdbeComment((v, "materialize %!S", pItem));
drh69b72d52015-06-01 20:28:03 +00006927 }else{
drha9799932021-03-19 13:00:28 +00006928 VdbeNoopComment((v, "materialize %!S", pItem));
drh5b6a9ed2011-09-15 23:58:14 +00006929 }
drha79e2a22021-02-21 23:44:14 +00006930 sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
drha9799932021-03-19 13:00:28 +00006931 ExplainQueryPlan((pParse, 1, "MATERIALIZE %!S", pItem));
drha79e2a22021-02-21 23:44:14 +00006932 sqlite3Select(pParse, pSub, &dest);
drhc3489bb2016-02-25 16:04:59 +00006933 pItem->pTab->nRowLogEst = pSub->nSelectRow;
drh48f2d3b2011-09-16 01:34:43 +00006934 if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
drh7157e8e2011-09-16 16:00:51 +00006935 retAddr = sqlite3VdbeAddOp1(v, OP_Return, pItem->regReturn);
drha9799932021-03-19 13:00:28 +00006936 VdbeComment((v, "end %!S", pItem));
drh7157e8e2011-09-16 16:00:51 +00006937 sqlite3VdbeChangeP1(v, topAddr, retAddr);
drhcdc69552011-12-06 13:24:59 +00006938 sqlite3ClearTempRegCache(pParse);
drhd685dd62021-03-19 13:53:34 +00006939 if( pItem->fg.isCte && pItem->fg.isCorrelated==0 ){
drha79e2a22021-02-21 23:44:14 +00006940 CteUse *pCteUse = pItem->u2.pCteUse;
6941 pCteUse->addrM9e = pItem->addrFillSub;
6942 pCteUse->regRtn = pItem->regReturn;
6943 pCteUse->iCur = pItem->iCursor;
6944 pCteUse->nRowEst = pSub->nSelectRow;
6945 }
danielk1977daf79ac2008-06-30 18:12:28 +00006946 }
drhadc57f62015-06-06 00:18:01 +00006947 if( db->mallocFailed ) goto select_end;
danielk1977fc976062007-05-10 10:46:56 +00006948 pParse->nHeight -= sqlite3SelectExprHeight(p);
drh824d21a2017-09-29 12:44:52 +00006949 pParse->zAuthContext = zSavedAuthContext;
drh51522cd2005-01-20 13:36:19 +00006950#endif
drh701caf12017-05-10 16:12:00 +00006951 }
drhadc57f62015-06-06 00:18:01 +00006952
drh38b41492015-06-08 15:08:15 +00006953 /* Various elements of the SELECT copied into local variables for
6954 ** convenience */
drhadc57f62015-06-06 00:18:01 +00006955 pEList = p->pEList;
danielk1977daf79ac2008-06-30 18:12:28 +00006956 pWhere = p->pWhere;
6957 pGroupBy = p->pGroupBy;
6958 pHaving = p->pHaving;
drhe8e4af72012-09-21 00:04:28 +00006959 sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
drh832508b2002-03-02 17:04:07 +00006960
drh5e431be2022-04-06 11:08:38 +00006961#if TREETRACE_ENABLED
6962 if( sqlite3TreeTrace & 0x400 ){
drhbc8edba2015-06-05 20:27:26 +00006963 SELECTTRACE(0x400,pParse,p,("After all FROM-clause analysis:\n"));
6964 sqlite3TreeViewSelect(0, p, 0);
danielk1977f23329a2008-07-01 14:09:13 +00006965 }
6966#endif
6967
dan50118cd2011-07-01 14:21:38 +00006968 /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
6969 ** if the select-list is the same as the ORDER BY list, then this query
6970 ** can be rewritten as a GROUP BY. In other words, this:
6971 **
6972 ** SELECT DISTINCT xyz FROM ... ORDER BY xyz
6973 **
6974 ** is transformed to:
6975 **
drhdea7d702014-12-04 21:54:58 +00006976 ** SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
dan50118cd2011-07-01 14:21:38 +00006977 **
6978 ** The second form is preferred as a single index (or temp-table) may be
6979 ** used for both the ORDER BY and DISTINCT processing. As originally
6980 ** written the query must use a temp-table for at least one of the ORDER
6981 ** BY and DISTINCT, and an index or separate temp-table for the other.
6982 */
6983 if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
drhadc57f62015-06-06 00:18:01 +00006984 && sqlite3ExprListCompare(sSort.pOrderBy, pEList, -1)==0
drhef9f7192020-01-17 19:14:08 +00006985#ifndef SQLITE_OMIT_WINDOWFUNC
dane59c5622019-11-22 10:14:01 +00006986 && p->pWin==0
drhef9f7192020-01-17 19:14:08 +00006987#endif
dan50118cd2011-07-01 14:21:38 +00006988 ){
6989 p->selFlags &= ~SF_Distinct;
drhadc57f62015-06-06 00:18:01 +00006990 pGroupBy = p->pGroupBy = sqlite3ExprListDup(db, pEList, 0);
dan9e10f9a2020-01-06 17:06:12 +00006991 p->selFlags |= SF_Aggregate;
drhe8e4af72012-09-21 00:04:28 +00006992 /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
6993 ** the sDistinct.isTnct is still set. Hence, isTnct represents the
6994 ** original setting of the SF_Distinct flag, not the current setting */
6995 assert( sDistinct.isTnct );
danece092e2022-03-16 12:06:00 +00006996 sDistinct.isTnct = 2;
drh7512cb42016-04-14 13:06:49 +00006997
drh5e431be2022-04-06 11:08:38 +00006998#if TREETRACE_ENABLED
6999 if( sqlite3TreeTrace & 0x400 ){
drh7512cb42016-04-14 13:06:49 +00007000 SELECTTRACE(0x400,pParse,p,("Transform DISTINCT into GROUP BY:\n"));
7001 sqlite3TreeViewSelect(0, p, 0);
7002 }
7003#endif
dan50118cd2011-07-01 14:21:38 +00007004 }
7005
drhadc57f62015-06-06 00:18:01 +00007006 /* If there is an ORDER BY clause, then create an ephemeral index to
7007 ** do the sorting. But this sorting ephemeral index might end up
7008 ** being unused if the data can be extracted in pre-sorted order.
7009 ** If that is the case, then the OP_OpenEphemeral instruction will be
7010 ** changed to an OP_Noop once we figure out that the sorting index is
7011 ** not needed. The sSort.addrSortIndex variable is used to facilitate
7012 ** that change.
danielk19777cedc8d2004-06-10 10:50:08 +00007013 */
drh079a3072014-03-19 14:10:55 +00007014 if( sSort.pOrderBy ){
drh0342b1f2005-09-01 03:07:44 +00007015 KeyInfo *pKeyInfo;
danf9eae182018-05-21 19:45:11 +00007016 pKeyInfo = sqlite3KeyInfoFromExprList(
7017 pParse, sSort.pOrderBy, 0, pEList->nExpr);
drh079a3072014-03-19 14:10:55 +00007018 sSort.iECursor = pParse->nTab++;
7019 sSort.addrSortIndex =
drh66a51672008-01-03 00:01:23 +00007020 sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
drhf45f2322014-03-23 17:45:03 +00007021 sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
7022 (char*)pKeyInfo, P4_KEYINFO
7023 );
drh9d2985c2005-09-08 01:58:42 +00007024 }else{
drh079a3072014-03-19 14:10:55 +00007025 sSort.addrSortIndex = -1;
danielk19777cedc8d2004-06-10 10:50:08 +00007026 }
7027
drh2d0794e2002-03-03 03:03:52 +00007028 /* If the output is destined for a temporary table, open that table.
7029 */
danielk19776c8c8ce2008-01-02 16:27:09 +00007030 if( pDest->eDest==SRT_EphemTab ){
drh2b596da2012-07-23 21:43:19 +00007031 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
drh2d0794e2002-03-03 03:03:52 +00007032 }
7033
drhf42bacc2006-04-26 17:39:34 +00007034 /* Set the limiter.
7035 */
drhec4ccdb2018-12-29 02:26:59 +00007036 iEnd = sqlite3VdbeMakeLabel(pParse);
dan69b93832016-12-16 15:05:40 +00007037 if( (p->selFlags & SF_FixedLimit)==0 ){
7038 p->nSelectRow = 320; /* 4 billion rows */
7039 }
drhf42bacc2006-04-26 17:39:34 +00007040 computeLimitRegisters(pParse, p, iEnd);
drh079a3072014-03-19 14:10:55 +00007041 if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
drh0ff287f2015-09-02 18:40:33 +00007042 sqlite3VdbeChangeOpcode(v, sSort.addrSortIndex, OP_SorterOpen);
drh079a3072014-03-19 14:10:55 +00007043 sSort.sortFlags |= SORTFLAG_UseSorter;
drhc6aff302011-09-01 15:32:47 +00007044 }
drhf42bacc2006-04-26 17:39:34 +00007045
drhadc57f62015-06-06 00:18:01 +00007046 /* Open an ephemeral index to use for the distinct set.
drhefb72512000-05-31 20:00:52 +00007047 */
dan2ce22452010-11-08 19:01:16 +00007048 if( p->selFlags & SF_Distinct ){
drhe8e4af72012-09-21 00:04:28 +00007049 sDistinct.tabTnct = pParse->nTab++;
7050 sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
danf9eae182018-05-21 19:45:11 +00007051 sDistinct.tabTnct, 0, 0,
7052 (char*)sqlite3KeyInfoFromExprList(pParse, p->pEList,0,0),
7053 P4_KEYINFO);
drhd4187c72010-08-30 22:15:45 +00007054 sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
drhe8e4af72012-09-21 00:04:28 +00007055 sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
drh832508b2002-03-02 17:04:07 +00007056 }else{
drhe8e4af72012-09-21 00:04:28 +00007057 sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
drhefb72512000-05-31 20:00:52 +00007058 }
drh832508b2002-03-02 17:04:07 +00007059
drh13449892005-09-07 21:22:45 +00007060 if( !isAgg && pGroupBy==0 ){
drhe8e4af72012-09-21 00:04:28 +00007061 /* No aggregate functions and no GROUP BY clause */
dan67a9b8e2018-06-22 20:51:35 +00007062 u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0)
7063 | (p->selFlags & SF_FixedLimit);
7064#ifndef SQLITE_OMIT_WINDOWFUNC
drh067b92b2020-06-19 15:24:12 +00007065 Window *pWin = p->pWin; /* Main window object (or NULL) */
danf9eae182018-05-21 19:45:11 +00007066 if( pWin ){
dan4ea562e2020-01-01 20:17:15 +00007067 sqlite3WindowCodeInit(pParse, p);
dan86fb6e12018-05-16 20:58:07 +00007068 }
dan67a9b8e2018-06-22 20:51:35 +00007069#endif
7070 assert( WHERE_USE_LIMIT==SF_FixedLimit );
7071
dan86fb6e12018-05-16 20:58:07 +00007072
dan38cc40c2011-06-30 20:17:15 +00007073 /* Begin the database scan. */
drhcfd74702018-03-19 22:28:34 +00007074 SELECTTRACE(1,pParse,p,("WhereBegin\n"));
drh079a3072014-03-19 14:10:55 +00007075 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
drh895bab32022-01-27 16:14:50 +00007076 p->pEList, p, wctrlFlags, p->nSelectRow);
drh13449892005-09-07 21:22:45 +00007077 if( pWInfo==0 ) goto select_end;
drh6f328482013-06-05 23:39:34 +00007078 if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
7079 p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
7080 }
drh6457a352013-06-21 00:35:37 +00007081 if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
drh6f328482013-06-05 23:39:34 +00007082 sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
7083 }
drh079a3072014-03-19 14:10:55 +00007084 if( sSort.pOrderBy ){
7085 sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
drh6ee5a7b2018-09-08 20:09:46 +00007086 sSort.labelOBLopt = sqlite3WhereOrderByLimitOptLabel(pWInfo);
drh079a3072014-03-19 14:10:55 +00007087 if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
7088 sSort.pOrderBy = 0;
7089 }
7090 }
drh13162ef2021-02-16 20:01:08 +00007091 SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
drhcce7d172000-05-31 15:34:51 +00007092
drhb9bb7c12006-06-11 23:41:55 +00007093 /* If sorting index that was created by a prior OP_OpenEphemeral
7094 ** instruction ended up not being needed, then change the OP_OpenEphemeral
drh9d2985c2005-09-08 01:58:42 +00007095 ** into an OP_Noop.
7096 */
drh079a3072014-03-19 14:10:55 +00007097 if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
7098 sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
drh9d2985c2005-09-08 01:58:42 +00007099 }
7100
drh2def2f72017-09-15 17:40:34 +00007101 assert( p->pEList==pEList );
dan67a9b8e2018-06-22 20:51:35 +00007102#ifndef SQLITE_OMIT_WINDOWFUNC
danf9eae182018-05-21 19:45:11 +00007103 if( pWin ){
drhec4ccdb2018-12-29 02:26:59 +00007104 int addrGosub = sqlite3VdbeMakeLabel(pParse);
7105 int iCont = sqlite3VdbeMakeLabel(pParse);
7106 int iBreak = sqlite3VdbeMakeLabel(pParse);
danf9eae182018-05-21 19:45:11 +00007107 int regGosub = ++pParse->nMem;
drhefb72512000-05-31 20:00:52 +00007108
dandacf1de2018-06-08 16:11:55 +00007109 sqlite3WindowCodeStep(pParse, p, pWInfo, regGosub, addrGosub);
dan86fb6e12018-05-16 20:58:07 +00007110
danefa3a3c2018-06-23 16:26:20 +00007111 sqlite3VdbeAddOp2(v, OP_Goto, 0, iBreak);
danf9eae182018-05-21 19:45:11 +00007112 sqlite3VdbeResolveLabel(v, addrGosub);
drhb0225bc2018-07-10 20:50:27 +00007113 VdbeNoopComment((v, "inner-loop subroutine"));
drhd4cb09e2018-09-17 15:19:13 +00007114 sSort.labelOBLopt = 0;
danefa3a3c2018-06-23 16:26:20 +00007115 selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest, iCont, iBreak);
dandacf1de2018-06-08 16:11:55 +00007116 sqlite3VdbeResolveLabel(v, iCont);
dan86fb6e12018-05-16 20:58:07 +00007117 sqlite3VdbeAddOp1(v, OP_Return, regGosub);
drh0b3b0dd2018-07-10 05:11:03 +00007118 VdbeComment((v, "end inner-loop subroutine"));
danefa3a3c2018-06-23 16:26:20 +00007119 sqlite3VdbeResolveLabel(v, iBreak);
dan67a9b8e2018-06-22 20:51:35 +00007120 }else
7121#endif /* SQLITE_OMIT_WINDOWFUNC */
7122 {
dan86fb6e12018-05-16 20:58:07 +00007123 /* Use the standard inner loop. */
7124 selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest,
7125 sqlite3WhereContinueLabel(pWInfo),
7126 sqlite3WhereBreakLabel(pWInfo));
7127
7128 /* End the database scan loop.
7129 */
drh13162ef2021-02-16 20:01:08 +00007130 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
dan86fb6e12018-05-16 20:58:07 +00007131 sqlite3WhereEnd(pWInfo);
7132 }
drh13449892005-09-07 21:22:45 +00007133 }else{
drhe8e4af72012-09-21 00:04:28 +00007134 /* This case when there exist aggregate functions or a GROUP BY clause
7135 ** or both */
drh13449892005-09-07 21:22:45 +00007136 NameContext sNC; /* Name context for processing aggregate information */
7137 int iAMem; /* First Mem address for storing current GROUP BY */
7138 int iBMem; /* First Mem address for previous GROUP BY */
7139 int iUseFlag; /* Mem address holding flag indicating that at least
7140 ** one row of the input to the aggregator has been
7141 ** processed */
7142 int iAbortFlag; /* Mem address which causes query abort if positive */
7143 int groupBySort; /* Rows come from source in GROUP BY order */
drhd1766112008-09-17 00:13:12 +00007144 int addrEnd; /* End of processing for this SELECT */
drh1c9d8352011-09-01 16:01:27 +00007145 int sortPTab = 0; /* Pseudotable used to decode sorting results */
7146 int sortOut = 0; /* Output register from the sorter */
dan374cd782014-04-21 13:21:56 +00007147 int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
drhcce7d172000-05-31 15:34:51 +00007148
drhd1766112008-09-17 00:13:12 +00007149 /* Remove any and all aliases between the result set and the
7150 ** GROUP BY clause.
7151 */
7152 if( pGroupBy ){
drhdc5ea5c2008-12-10 17:19:59 +00007153 int k; /* Loop counter */
drhd1766112008-09-17 00:13:12 +00007154 struct ExprList_item *pItem; /* For looping over expression in a list */
drhcce7d172000-05-31 15:34:51 +00007155
drhdc5ea5c2008-12-10 17:19:59 +00007156 for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
drhc2acc4e2013-11-15 18:15:19 +00007157 pItem->u.x.iAlias = 0;
drhd1766112008-09-17 00:13:12 +00007158 }
drhdc5ea5c2008-12-10 17:19:59 +00007159 for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
drhc2acc4e2013-11-15 18:15:19 +00007160 pItem->u.x.iAlias = 0;
drhd1766112008-09-17 00:13:12 +00007161 }
drhc3489bb2016-02-25 16:04:59 +00007162 assert( 66==sqlite3LogEst(100) );
7163 if( p->nSelectRow>66 ) p->nSelectRow = 66;
dan8c9bcb22019-09-21 15:44:12 +00007164
7165 /* If there is both a GROUP BY and an ORDER BY clause and they are
7166 ** identical, then it may be possible to disable the ORDER BY clause
7167 ** on the grounds that the GROUP BY will cause elements to come out
7168 ** in the correct order. It also may not - the GROUP BY might use a
7169 ** database index that causes rows to be grouped together as required
7170 ** but not actually sorted. Either way, record the fact that the
7171 ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
7172 ** variable. */
7173 if( sSort.pOrderBy && pGroupBy->nExpr==sSort.pOrderBy->nExpr ){
drhe39f3882019-09-21 17:31:03 +00007174 int ii;
dan8c9bcb22019-09-21 15:44:12 +00007175 /* The GROUP BY processing doesn't care whether rows are delivered in
7176 ** ASC or DESC order - only that each group is returned contiguously.
7177 ** So set the ASC/DESC flags in the GROUP BY to match those in the
7178 ** ORDER BY to maximize the chances of rows being delivered in an
7179 ** order that makes the ORDER BY redundant. */
drhe39f3882019-09-21 17:31:03 +00007180 for(ii=0; ii<pGroupBy->nExpr; ii++){
7181 u8 sortFlags = sSort.pOrderBy->a[ii].sortFlags & KEYINFO_ORDER_DESC;
7182 pGroupBy->a[ii].sortFlags = sortFlags;
dan8c9bcb22019-09-21 15:44:12 +00007183 }
7184 if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
7185 orderByGrp = 1;
7186 }
7187 }
drh95aa47b2010-11-16 02:49:15 +00007188 }else{
drhc3489bb2016-02-25 16:04:59 +00007189 assert( 0==sqlite3LogEst(1) );
7190 p->nSelectRow = 0;
drhd1766112008-09-17 00:13:12 +00007191 }
drh13449892005-09-07 21:22:45 +00007192
drhd1766112008-09-17 00:13:12 +00007193 /* Create a label to jump to when we want to abort the query */
drhec4ccdb2018-12-29 02:26:59 +00007194 addrEnd = sqlite3VdbeMakeLabel(pParse);
drh13449892005-09-07 21:22:45 +00007195
7196 /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
7197 ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
7198 ** SELECT statement.
7199 */
drhbf790972020-06-07 20:18:07 +00007200 pAggInfo = sqlite3DbMallocZero(db, sizeof(*pAggInfo) );
drhc54246f2021-02-17 21:13:14 +00007201 if( pAggInfo ){
7202 sqlite3ParserAddCleanup(pParse,
7203 (void(*)(sqlite3*,void*))agginfoFree, pAggInfo);
drh6d0053c2021-03-09 19:32:37 +00007204 testcase( pParse->earlyCleanup );
drhc54246f2021-02-17 21:13:14 +00007205 }
7206 if( db->mallocFailed ){
drhbf790972020-06-07 20:18:07 +00007207 goto select_end;
7208 }
drhe26d4282020-06-09 11:59:15 +00007209 pAggInfo->selId = p->selId;
drh13449892005-09-07 21:22:45 +00007210 memset(&sNC, 0, sizeof(sNC));
7211 sNC.pParse = pParse;
7212 sNC.pSrcList = pTabList;
drhbf790972020-06-07 20:18:07 +00007213 sNC.uNC.pAggInfo = pAggInfo;
drh25c3b8c2018-04-16 10:34:13 +00007214 VVA_ONLY( sNC.ncFlags = NC_UAggInfo; )
drhbf790972020-06-07 20:18:07 +00007215 pAggInfo->mnReg = pParse->nMem+1;
7216 pAggInfo->nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
7217 pAggInfo->pGroupBy = pGroupBy;
drhd2b3e232008-01-23 14:51:49 +00007218 sqlite3ExprAnalyzeAggList(&sNC, pEList);
drh079a3072014-03-19 14:10:55 +00007219 sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
drhd2b3e232008-01-23 14:51:49 +00007220 if( pHaving ){
danab31a842017-04-29 20:53:09 +00007221 if( pGroupBy ){
7222 assert( pWhere==p->pWhere );
drhcd0abc22018-03-20 18:08:33 +00007223 assert( pHaving==p->pHaving );
7224 assert( pGroupBy==p->pGroupBy );
7225 havingToWhere(pParse, p);
danab31a842017-04-29 20:53:09 +00007226 pWhere = p->pWhere;
7227 }
drhd2b3e232008-01-23 14:51:49 +00007228 sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
drh13449892005-09-07 21:22:45 +00007229 }
drhbf790972020-06-07 20:18:07 +00007230 pAggInfo->nAccumulator = pAggInfo->nColumn;
7231 if( p->pGroupBy==0 && p->pHaving==0 && pAggInfo->nFunc==1 ){
drh81185a52020-06-09 13:38:12 +00007232 minMaxFlag = minMaxQuery(db, pAggInfo->aFunc[0].pFExpr, &pMinMaxOrderBy);
drh47d9f832017-10-26 20:04:28 +00007233 }else{
7234 minMaxFlag = WHERE_ORDERBY_NORMAL;
7235 }
drhbf790972020-06-07 20:18:07 +00007236 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00007237 Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
drha4eeccd2021-10-07 17:43:30 +00007238 assert( ExprUseXList(pExpr) );
drh3a8c4be2012-05-21 20:13:39 +00007239 sNC.ncFlags |= NC_InAggFunc;
dan6ba7ab02019-07-02 11:56:47 +00007240 sqlite3ExprAnalyzeAggList(&sNC, pExpr->x.pList);
7241#ifndef SQLITE_OMIT_WINDOWFUNC
dan4f9adee2019-07-13 16:22:50 +00007242 assert( !IsWindowFunc(pExpr) );
7243 if( ExprHasProperty(pExpr, EP_WinFunc) ){
7244 sqlite3ExprAnalyzeAggregates(&sNC, pExpr->y.pWin->pFilter);
danb28c4e52019-07-05 17:38:55 +00007245 }
dan6ba7ab02019-07-02 11:56:47 +00007246#endif
drh3a8c4be2012-05-21 20:13:39 +00007247 sNC.ncFlags &= ~NC_InAggFunc;
drh13449892005-09-07 21:22:45 +00007248 }
drhbf790972020-06-07 20:18:07 +00007249 pAggInfo->mxReg = pParse->nMem;
drh17435752007-08-16 04:30:38 +00007250 if( db->mallocFailed ) goto select_end;
drh5e431be2022-04-06 11:08:38 +00007251#if TREETRACE_ENABLED
7252 if( sqlite3TreeTrace & 0x400 ){
drh7ea11062017-10-26 18:43:19 +00007253 int ii;
drhbf790972020-06-07 20:18:07 +00007254 SELECTTRACE(0x400,pParse,p,("After aggregate analysis %p:\n", pAggInfo));
drh7ea11062017-10-26 18:43:19 +00007255 sqlite3TreeViewSelect(0, p, 0);
drhb9366f82021-01-13 11:44:51 +00007256 if( minMaxFlag ){
7257 sqlite3DebugPrintf("MIN/MAX Optimization (0x%02x) adds:\n", minMaxFlag);
7258 sqlite3TreeViewExprList(0, pMinMaxOrderBy, 0, "ORDERBY");
7259 }
drhbf790972020-06-07 20:18:07 +00007260 for(ii=0; ii<pAggInfo->nColumn; ii++){
drh7ea11062017-10-26 18:43:19 +00007261 sqlite3DebugPrintf("agg-column[%d] iMem=%d\n",
drhbf790972020-06-07 20:18:07 +00007262 ii, pAggInfo->aCol[ii].iMem);
drh81185a52020-06-09 13:38:12 +00007263 sqlite3TreeViewExpr(0, pAggInfo->aCol[ii].pCExpr, 0);
drh7ea11062017-10-26 18:43:19 +00007264 }
drhbf790972020-06-07 20:18:07 +00007265 for(ii=0; ii<pAggInfo->nFunc; ii++){
drh7ea11062017-10-26 18:43:19 +00007266 sqlite3DebugPrintf("agg-func[%d]: iMem=%d\n",
drhbf790972020-06-07 20:18:07 +00007267 ii, pAggInfo->aFunc[ii].iMem);
drh81185a52020-06-09 13:38:12 +00007268 sqlite3TreeViewExpr(0, pAggInfo->aFunc[ii].pFExpr, 0);
drh7ea11062017-10-26 18:43:19 +00007269 }
7270 }
7271#endif
7272
drh13449892005-09-07 21:22:45 +00007273
7274 /* Processing for aggregates with GROUP BY is very different and
danielk19773c4809a2007-11-12 15:29:18 +00007275 ** much more complex than aggregates without a GROUP BY.
drh13449892005-09-07 21:22:45 +00007276 */
7277 if( pGroupBy ){
7278 KeyInfo *pKeyInfo; /* Keying information for the group by clause */
drh728e0f92015-10-10 14:41:28 +00007279 int addr1; /* A-vs-B comparision jump */
drhd1766112008-09-17 00:13:12 +00007280 int addrOutputRow; /* Start of subroutine that outputs a result row */
7281 int regOutputRow; /* Return address register for output subroutine */
7282 int addrSetAbort; /* Set the abort flag and return */
7283 int addrTopOfLoop; /* Top of the input loop */
7284 int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
7285 int addrReset; /* Subroutine for resetting the accumulator */
7286 int regReset; /* Return address register for reset subroutine */
dan5383db72021-03-12 18:24:31 +00007287 ExprList *pDistinct = 0;
7288 u16 distFlag = 0;
7289 int eDist = WHERE_DISTINCT_NOOP;
7290
7291 if( pAggInfo->nFunc==1
7292 && pAggInfo->aFunc[0].iDistinct>=0
drha4eeccd2021-10-07 17:43:30 +00007293 && ALWAYS(pAggInfo->aFunc[0].pFExpr!=0)
7294 && ALWAYS(ExprUseXList(pAggInfo->aFunc[0].pFExpr))
7295 && pAggInfo->aFunc[0].pFExpr->x.pList!=0
dan5383db72021-03-12 18:24:31 +00007296 ){
7297 Expr *pExpr = pAggInfo->aFunc[0].pFExpr->x.pList->a[0].pExpr;
7298 pExpr = sqlite3ExprDup(db, pExpr, 0);
7299 pDistinct = sqlite3ExprListDup(db, pGroupBy, 0);
7300 pDistinct = sqlite3ExprListAppend(pParse, pDistinct, pExpr);
danf330d532021-04-03 19:23:59 +00007301 distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
dan5383db72021-03-12 18:24:31 +00007302 }
drh13449892005-09-07 21:22:45 +00007303
7304 /* If there is a GROUP BY clause we might need a sorting index to
7305 ** implement it. Allocate that sorting index now. If it turns out
drh1c9d8352011-09-01 16:01:27 +00007306 ** that we do not need it after all, the OP_SorterOpen instruction
drh13449892005-09-07 21:22:45 +00007307 ** will be converted into a Noop.
7308 */
drhbf790972020-06-07 20:18:07 +00007309 pAggInfo->sortingIdx = pParse->nTab++;
7310 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pGroupBy,
7311 0, pAggInfo->nColumn);
drh1c9d8352011-09-01 16:01:27 +00007312 addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
drhbf790972020-06-07 20:18:07 +00007313 pAggInfo->sortingIdx, pAggInfo->nSortingColumn,
drh2ec2fb22013-11-06 19:59:23 +00007314 0, (char*)pKeyInfo, P4_KEYINFO);
drh13449892005-09-07 21:22:45 +00007315
7316 /* Initialize memory locations used by GROUP BY aggregate processing
7317 */
drh0a07c102008-01-03 18:03:08 +00007318 iUseFlag = ++pParse->nMem;
7319 iAbortFlag = ++pParse->nMem;
drhd1766112008-09-17 00:13:12 +00007320 regOutputRow = ++pParse->nMem;
drhec4ccdb2018-12-29 02:26:59 +00007321 addrOutputRow = sqlite3VdbeMakeLabel(pParse);
drhd1766112008-09-17 00:13:12 +00007322 regReset = ++pParse->nMem;
drhec4ccdb2018-12-29 02:26:59 +00007323 addrReset = sqlite3VdbeMakeLabel(pParse);
drh0a07c102008-01-03 18:03:08 +00007324 iAMem = pParse->nMem + 1;
drh13449892005-09-07 21:22:45 +00007325 pParse->nMem += pGroupBy->nExpr;
drh0a07c102008-01-03 18:03:08 +00007326 iBMem = pParse->nMem + 1;
drh13449892005-09-07 21:22:45 +00007327 pParse->nMem += pGroupBy->nExpr;
drh4c583122008-01-04 22:01:03 +00007328 sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
drhd4e70eb2008-01-02 00:34:36 +00007329 VdbeComment((v, "clear abort flag"));
drhb8475df2011-12-09 16:21:19 +00007330 sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
drhe3133822005-09-20 13:11:59 +00007331
drh13449892005-09-07 21:22:45 +00007332 /* Begin a loop that will extract all source rows in GROUP BY order.
7333 ** This might involve two separate loops with an OP_Sort in between, or
7334 ** it might be a single loop that uses an index to extract information
7335 ** in the right order to begin with.
7336 */
drh2eb95372008-06-06 15:04:36 +00007337 sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
drhcfd74702018-03-19 22:28:34 +00007338 SELECTTRACE(1,pParse,p,("WhereBegin\n"));
dan5383db72021-03-12 18:24:31 +00007339 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, pDistinct,
danece092e2022-03-16 12:06:00 +00007340 0, (sDistinct.isTnct==2 ? WHERE_DISTINCTBY : WHERE_GROUPBY)
7341 | (orderByGrp ? WHERE_SORTBYGROUP : 0) | distFlag, 0
dan374cd782014-04-21 13:21:56 +00007342 );
danbfd6f1b2021-04-08 20:29:12 +00007343 if( pWInfo==0 ){
7344 sqlite3ExprListDelete(db, pDistinct);
7345 goto select_end;
7346 }
dan76075802021-03-12 21:09:20 +00007347 eDist = sqlite3WhereIsDistinct(pWInfo);
drh13162ef2021-02-16 20:01:08 +00007348 SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
drhddba0c22014-03-18 20:33:42 +00007349 if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
drh13449892005-09-07 21:22:45 +00007350 /* The optimizer is able to deliver rows in group by order so
drhb9bb7c12006-06-11 23:41:55 +00007351 ** we do not have to sort. The OP_OpenEphemeral table will be
drh13449892005-09-07 21:22:45 +00007352 ** cancelled later because we still need to use the pKeyInfo
7353 */
drh13449892005-09-07 21:22:45 +00007354 groupBySort = 0;
7355 }else{
7356 /* Rows are coming out in undetermined order. We have to push
7357 ** each row into a sorting index, terminate the first loop,
7358 ** then loop over the sorting index in order to get the output
7359 ** in sorted order
7360 */
drh892d3172008-01-10 03:46:36 +00007361 int regBase;
7362 int regRecord;
7363 int nCol;
7364 int nGroupBy;
7365
dan2ce22452010-11-08 19:01:16 +00007366 explainTempTable(pParse,
drhe8e4af72012-09-21 00:04:28 +00007367 (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
7368 "DISTINCT" : "GROUP BY");
dan2ce22452010-11-08 19:01:16 +00007369
drh13449892005-09-07 21:22:45 +00007370 groupBySort = 1;
drh892d3172008-01-10 03:46:36 +00007371 nGroupBy = pGroupBy->nExpr;
dandd23c6b2014-03-24 20:19:07 +00007372 nCol = nGroupBy;
7373 j = nGroupBy;
drhbf790972020-06-07 20:18:07 +00007374 for(i=0; i<pAggInfo->nColumn; i++){
7375 if( pAggInfo->aCol[i].iSorterColumn>=j ){
drh892d3172008-01-10 03:46:36 +00007376 nCol++;
7377 j++;
7378 }
7379 }
7380 regBase = sqlite3GetTempRange(pParse, nCol);
drh5579d592015-08-26 14:01:41 +00007381 sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0, 0);
dandd23c6b2014-03-24 20:19:07 +00007382 j = nGroupBy;
drhbf790972020-06-07 20:18:07 +00007383 for(i=0; i<pAggInfo->nColumn; i++){
7384 struct AggInfo_col *pCol = &pAggInfo->aCol[i];
drh892d3172008-01-10 03:46:36 +00007385 if( pCol->iSorterColumn>=j ){
drhe55cbd72008-03-31 23:48:03 +00007386 int r1 = j + regBase;
drh8c607192018-08-04 15:53:55 +00007387 sqlite3ExprCodeGetColumnOfTable(v,
7388 pCol->pTab, pCol->iTable, pCol->iColumn, r1);
drh6a012f02008-08-21 14:15:59 +00007389 j++;
drh892d3172008-01-10 03:46:36 +00007390 }
drh13449892005-09-07 21:22:45 +00007391 }
drh892d3172008-01-10 03:46:36 +00007392 regRecord = sqlite3GetTempReg(pParse);
drh1db639c2008-01-17 02:36:28 +00007393 sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
drhbf790972020-06-07 20:18:07 +00007394 sqlite3VdbeAddOp2(v, OP_SorterInsert, pAggInfo->sortingIdx, regRecord);
drh892d3172008-01-10 03:46:36 +00007395 sqlite3ReleaseTempReg(pParse, regRecord);
7396 sqlite3ReleaseTempRange(pParse, regBase, nCol);
drh13162ef2021-02-16 20:01:08 +00007397 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
drh13449892005-09-07 21:22:45 +00007398 sqlite3WhereEnd(pWInfo);
drhbf790972020-06-07 20:18:07 +00007399 pAggInfo->sortingIdxPTab = sortPTab = pParse->nTab++;
drh1c9d8352011-09-01 16:01:27 +00007400 sortOut = sqlite3GetTempReg(pParse);
7401 sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
drhbf790972020-06-07 20:18:07 +00007402 sqlite3VdbeAddOp2(v, OP_SorterSort, pAggInfo->sortingIdx, addrEnd);
drh688852a2014-02-17 22:40:43 +00007403 VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
drhbf790972020-06-07 20:18:07 +00007404 pAggInfo->useSortingIdx = 1;
dan374cd782014-04-21 13:21:56 +00007405 }
7406
7407 /* If the index or temporary table used by the GROUP BY sort
7408 ** will naturally deliver rows in the order required by the ORDER BY
7409 ** clause, cancel the ephemeral table open coded earlier.
7410 **
7411 ** This is an optimization - the correct answer should result regardless.
7412 ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
7413 ** disable this optimization for testing purposes. */
7414 if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
7415 && (groupBySort || sqlite3WhereIsSorted(pWInfo))
7416 ){
7417 sSort.pOrderBy = 0;
7418 sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
drh13449892005-09-07 21:22:45 +00007419 }
7420
7421 /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
7422 ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
7423 ** Then compare the current GROUP BY terms against the GROUP BY terms
7424 ** from the previous row currently stored in a0, a1, a2...
7425 */
7426 addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
drh1c9d8352011-09-01 16:01:27 +00007427 if( groupBySort ){
drhbf790972020-06-07 20:18:07 +00007428 sqlite3VdbeAddOp3(v, OP_SorterData, pAggInfo->sortingIdx,
drh38b41492015-06-08 15:08:15 +00007429 sortOut, sortPTab);
drh1c9d8352011-09-01 16:01:27 +00007430 }
drh13449892005-09-07 21:22:45 +00007431 for(j=0; j<pGroupBy->nExpr; j++){
7432 if( groupBySort ){
drh1c9d8352011-09-01 16:01:27 +00007433 sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
drh13449892005-09-07 21:22:45 +00007434 }else{
drhbf790972020-06-07 20:18:07 +00007435 pAggInfo->directMode = 1;
drh2dcef112008-01-12 19:03:48 +00007436 sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
drh13449892005-09-07 21:22:45 +00007437 }
drh13449892005-09-07 21:22:45 +00007438 }
drh16ee60f2008-06-20 18:13:25 +00007439 sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
drh2ec2fb22013-11-06 19:59:23 +00007440 (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
drh728e0f92015-10-10 14:41:28 +00007441 addr1 = sqlite3VdbeCurrentAddr(v);
7442 sqlite3VdbeAddOp3(v, OP_Jump, addr1+1, 0, addr1+1); VdbeCoverage(v);
drh13449892005-09-07 21:22:45 +00007443
7444 /* Generate code that runs whenever the GROUP BY changes.
drhe00ee6e2008-06-20 15:24:01 +00007445 ** Changes in the GROUP BY are detected by the previous code
drh13449892005-09-07 21:22:45 +00007446 ** block. If there were no changes, this block is skipped.
7447 **
7448 ** This code copies current group by terms in b0,b1,b2,...
7449 ** over to a0,a1,a2. It then calls the output subroutine
7450 ** and resets the aggregate accumulator registers in preparation
7451 ** for the next GROUP BY batch.
7452 */
drhb21e7c72008-06-22 12:37:57 +00007453 sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
drh2eb95372008-06-06 15:04:36 +00007454 sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
drhd4e70eb2008-01-02 00:34:36 +00007455 VdbeComment((v, "output one row"));
drh688852a2014-02-17 22:40:43 +00007456 sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
drhd4e70eb2008-01-02 00:34:36 +00007457 VdbeComment((v, "check abort flag"));
drh2eb95372008-06-06 15:04:36 +00007458 sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
drhd4e70eb2008-01-02 00:34:36 +00007459 VdbeComment((v, "reset accumulator"));
drh13449892005-09-07 21:22:45 +00007460
7461 /* Update the aggregate accumulators based on the content of
7462 ** the current row
7463 */
drh728e0f92015-10-10 14:41:28 +00007464 sqlite3VdbeJumpHere(v, addr1);
dan5383db72021-03-12 18:24:31 +00007465 updateAccumulator(pParse, iUseFlag, pAggInfo, eDist);
drh4c583122008-01-04 22:01:03 +00007466 sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
drhd4e70eb2008-01-02 00:34:36 +00007467 VdbeComment((v, "indicate data in accumulator"));
drh13449892005-09-07 21:22:45 +00007468
7469 /* End of the loop
7470 */
7471 if( groupBySort ){
drhd1930572021-01-13 15:23:17 +00007472 sqlite3VdbeAddOp2(v, OP_SorterNext, pAggInfo->sortingIdx,addrTopOfLoop);
drh688852a2014-02-17 22:40:43 +00007473 VdbeCoverage(v);
drh13449892005-09-07 21:22:45 +00007474 }else{
drh13162ef2021-02-16 20:01:08 +00007475 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
drh13449892005-09-07 21:22:45 +00007476 sqlite3WhereEnd(pWInfo);
drh48f2d3b2011-09-16 01:34:43 +00007477 sqlite3VdbeChangeToNoop(v, addrSortingIdx);
drh13449892005-09-07 21:22:45 +00007478 }
danbfd6f1b2021-04-08 20:29:12 +00007479 sqlite3ExprListDelete(db, pDistinct);
drh13449892005-09-07 21:22:45 +00007480
7481 /* Output the final row of result
7482 */
drh2eb95372008-06-06 15:04:36 +00007483 sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
drhd4e70eb2008-01-02 00:34:36 +00007484 VdbeComment((v, "output final row"));
drhd1766112008-09-17 00:13:12 +00007485
7486 /* Jump over the subroutines
7487 */
drh076e85f2015-09-03 13:46:12 +00007488 sqlite3VdbeGoto(v, addrEnd);
drhd1766112008-09-17 00:13:12 +00007489
7490 /* Generate a subroutine that outputs a single row of the result
7491 ** set. This subroutine first looks at the iUseFlag. If iUseFlag
7492 ** is less than or equal to zero, the subroutine is a no-op. If
7493 ** the processing calls for the query to abort, this subroutine
7494 ** increments the iAbortFlag memory location before returning in
7495 ** order to signal the caller to abort.
7496 */
7497 addrSetAbort = sqlite3VdbeCurrentAddr(v);
7498 sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
7499 VdbeComment((v, "set abort flag"));
7500 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7501 sqlite3VdbeResolveLabel(v, addrOutputRow);
7502 addrOutputRow = sqlite3VdbeCurrentAddr(v);
7503 sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2);
drh38b41492015-06-08 15:08:15 +00007504 VdbeCoverage(v);
drhd1766112008-09-17 00:13:12 +00007505 VdbeComment((v, "Groupby result generator entry point"));
7506 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
drhbf790972020-06-07 20:18:07 +00007507 finalizeAggFunctions(pParse, pAggInfo);
drh33cd4902009-05-30 20:49:20 +00007508 sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
drh2def2f72017-09-15 17:40:34 +00007509 selectInnerLoop(pParse, p, -1, &sSort,
drhe8e4af72012-09-21 00:04:28 +00007510 &sDistinct, pDest,
drhd1766112008-09-17 00:13:12 +00007511 addrOutputRow+1, addrSetAbort);
7512 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7513 VdbeComment((v, "end groupby result generator"));
7514
7515 /* Generate a subroutine that will reset the group-by accumulator
7516 */
7517 sqlite3VdbeResolveLabel(v, addrReset);
drhbf790972020-06-07 20:18:07 +00007518 resetAccumulator(pParse, pAggInfo);
dan280c8942018-06-05 20:04:28 +00007519 sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
7520 VdbeComment((v, "indicate accumulator empty"));
drhd1766112008-09-17 00:13:12 +00007521 sqlite3VdbeAddOp1(v, OP_Return, regReset);
dan5383db72021-03-12 18:24:31 +00007522
danece092e2022-03-16 12:06:00 +00007523 if( distFlag!=0 && eDist!=WHERE_DISTINCT_NOOP ){
dan5383db72021-03-12 18:24:31 +00007524 struct AggInfo_func *pF = &pAggInfo->aFunc[0];
7525 fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7526 }
drh43152cf2009-05-19 19:04:58 +00007527 } /* endif pGroupBy. Begin aggregate queries without GROUP BY: */
drh13449892005-09-07 21:22:45 +00007528 else {
danielk1977a5533162009-02-24 10:01:51 +00007529 Table *pTab;
drhbf790972020-06-07 20:18:07 +00007530 if( (pTab = isSimpleCount(p, pAggInfo))!=0 ){
danielk1977a5533162009-02-24 10:01:51 +00007531 /* If isSimpleCount() returns a pointer to a Table structure, then
7532 ** the SQL statement is of the form:
7533 **
7534 ** SELECT count(*) FROM <tbl>
7535 **
7536 ** where the Table structure returned represents table <tbl>.
7537 **
7538 ** This statement is so common that it is optimized specially. The
7539 ** OP_Count instruction is executed either on the intkey table that
7540 ** contains the data for table <tbl> or on one of its indexes. It
7541 ** is better to execute the op on an index, as indexes are almost
7542 ** always spread across less pages than their corresponding tables.
7543 */
7544 const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
7545 const int iCsr = pParse->nTab++; /* Cursor to scan b-tree */
7546 Index *pIdx; /* Iterator variable */
7547 KeyInfo *pKeyInfo = 0; /* Keyinfo for scanned index */
7548 Index *pBest = 0; /* Best index found so far */
drh013e7bb2020-07-30 17:37:49 +00007549 Pgno iRoot = pTab->tnum; /* Root page of scanned b-tree */
danielk1977a9d1ccb2008-01-05 17:39:29 +00007550
danielk1977a5533162009-02-24 10:01:51 +00007551 sqlite3CodeVerifySchema(pParse, iDb);
7552 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
7553
drhd9e3cad2013-10-04 02:36:19 +00007554 /* Search for the index that has the lowest scan cost.
danielk1977a5533162009-02-24 10:01:51 +00007555 **
drh3e9548b2011-04-15 14:46:27 +00007556 ** (2011-04-15) Do not do a full scan of an unordered index.
7557 **
drhabcc1942013-11-12 14:55:40 +00007558 ** (2013-10-03) Do not count the entries in a partial index.
drh5f33f372013-10-04 00:00:12 +00007559 **
danielk1977a5533162009-02-24 10:01:51 +00007560 ** In practice the KeyInfo structure will not be used. It is only
7561 ** passed to keep OP_OpenRead happy.
7562 */
drh5c7917e2013-11-12 15:33:40 +00007563 if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
drh98aa1d72020-05-08 18:22:00 +00007564 if( !p->pSrc->a[0].fg.notIndexed ){
7565 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
7566 if( pIdx->bUnordered==0
7567 && pIdx->szIdxRow<pTab->szTabRow
7568 && pIdx->pPartIdxWhere==0
7569 && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
7570 ){
7571 pBest = pIdx;
7572 }
danielk1977a5533162009-02-24 10:01:51 +00007573 }
7574 }
drhd9e3cad2013-10-04 02:36:19 +00007575 if( pBest ){
danielk1977a5533162009-02-24 10:01:51 +00007576 iRoot = pBest->tnum;
drh2ec2fb22013-11-06 19:59:23 +00007577 pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
danielk1977a5533162009-02-24 10:01:51 +00007578 }
7579
7580 /* Open a read-only cursor, execute the OP_Count, close the cursor. */
drh013e7bb2020-07-30 17:37:49 +00007581 sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, (int)iRoot, iDb, 1);
danielk1977a5533162009-02-24 10:01:51 +00007582 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00007583 sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
danielk1977a5533162009-02-24 10:01:51 +00007584 }
drhbf790972020-06-07 20:18:07 +00007585 sqlite3VdbeAddOp2(v, OP_Count, iCsr, pAggInfo->aFunc[0].iMem);
danielk1977a5533162009-02-24 10:01:51 +00007586 sqlite3VdbeAddOp1(v, OP_Close, iCsr);
danef7075d2011-02-21 17:49:49 +00007587 explainSimpleCount(pParse, pTab, pBest);
drhe50478d2020-03-17 13:41:51 +00007588 }else{
dan280c8942018-06-05 20:04:28 +00007589 int regAcc = 0; /* "populate accumulators" flag */
dan4fcb30b2021-03-09 16:06:25 +00007590 ExprList *pDistinct = 0;
7591 u16 distFlag = 0;
dan5383db72021-03-12 18:24:31 +00007592 int eDist;
dan280c8942018-06-05 20:04:28 +00007593
daned09ddd2019-09-20 20:52:16 +00007594 /* If there are accumulator registers but no min() or max() functions
7595 ** without FILTER clauses, allocate register regAcc. Register regAcc
7596 ** will contain 0 the first time the inner loop runs, and 1 thereafter.
7597 ** The code generated by updateAccumulator() uses this to ensure
7598 ** that the accumulator registers are (a) updated only once if
7599 ** there are no min() or max functions or (b) always updated for the
7600 ** first row visited by the aggregate, so that they are updated at
7601 ** least once even if the FILTER clause means the min() or max()
7602 ** function visits zero rows. */
drhbf790972020-06-07 20:18:07 +00007603 if( pAggInfo->nAccumulator ){
7604 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00007605 if( ExprHasProperty(pAggInfo->aFunc[i].pFExpr, EP_WinFunc) ){
drhbf790972020-06-07 20:18:07 +00007606 continue;
7607 }
7608 if( pAggInfo->aFunc[i].pFunc->funcFlags&SQLITE_FUNC_NEEDCOLL ){
7609 break;
7610 }
dan280c8942018-06-05 20:04:28 +00007611 }
drhbf790972020-06-07 20:18:07 +00007612 if( i==pAggInfo->nFunc ){
dan280c8942018-06-05 20:04:28 +00007613 regAcc = ++pParse->nMem;
7614 sqlite3VdbeAddOp2(v, OP_Integer, 0, regAcc);
7615 }
dan4fcb30b2021-03-09 16:06:25 +00007616 }else if( pAggInfo->nFunc==1 && pAggInfo->aFunc[0].iDistinct>=0 ){
drha4eeccd2021-10-07 17:43:30 +00007617 assert( ExprUseXList(pAggInfo->aFunc[0].pFExpr) );
dan4fcb30b2021-03-09 16:06:25 +00007618 pDistinct = pAggInfo->aFunc[0].pFExpr->x.pList;
danf330d532021-04-03 19:23:59 +00007619 distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
dan280c8942018-06-05 20:04:28 +00007620 }
7621
danielk1977a5533162009-02-24 10:01:51 +00007622 /* This case runs if the aggregate has no GROUP BY clause. The
7623 ** processing is much simpler since there is only a single row
7624 ** of output.
7625 */
drh47d9f832017-10-26 20:04:28 +00007626 assert( p->pGroupBy==0 );
drhbf790972020-06-07 20:18:07 +00007627 resetAccumulator(pParse, pAggInfo);
drh47d9f832017-10-26 20:04:28 +00007628
7629 /* If this query is a candidate for the min/max optimization, then
7630 ** minMaxFlag will have been previously set to either
7631 ** WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX and pMinMaxOrderBy will
7632 ** be an appropriate ORDER BY expression for the optimization.
7633 */
7634 assert( minMaxFlag==WHERE_ORDERBY_NORMAL || pMinMaxOrderBy!=0 );
7635 assert( pMinMaxOrderBy==0 || pMinMaxOrderBy->nExpr==1 );
7636
drhcfd74702018-03-19 22:28:34 +00007637 SELECTTRACE(1,pParse,p,("WhereBegin\n"));
drh47d9f832017-10-26 20:04:28 +00007638 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMaxOrderBy,
drh895bab32022-01-27 16:14:50 +00007639 pDistinct, 0, minMaxFlag|distFlag, 0);
danielk1977a5533162009-02-24 10:01:51 +00007640 if( pWInfo==0 ){
danielk1977a5533162009-02-24 10:01:51 +00007641 goto select_end;
7642 }
drh13162ef2021-02-16 20:01:08 +00007643 SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
dan5383db72021-03-12 18:24:31 +00007644 eDist = sqlite3WhereIsDistinct(pWInfo);
7645 updateAccumulator(pParse, regAcc, pAggInfo, eDist);
7646 if( eDist!=WHERE_DISTINCT_NOOP ){
7647 struct AggInfo_func *pF = &pAggInfo->aFunc[0];
drh3117b7b2022-04-19 18:23:01 +00007648 if( pF ){
7649 fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7650 }
dan5383db72021-03-12 18:24:31 +00007651 }
7652
dan280c8942018-06-05 20:04:28 +00007653 if( regAcc ) sqlite3VdbeAddOp2(v, OP_Integer, 1, regAcc);
drhd1930572021-01-13 15:23:17 +00007654 if( minMaxFlag ){
7655 sqlite3WhereMinMaxOptEarlyOut(v, pWInfo);
danielk1977a5533162009-02-24 10:01:51 +00007656 }
drh13162ef2021-02-16 20:01:08 +00007657 SELECTTRACE(1,pParse,p,("WhereEnd\n"));
danielk1977a5533162009-02-24 10:01:51 +00007658 sqlite3WhereEnd(pWInfo);
drhbf790972020-06-07 20:18:07 +00007659 finalizeAggFunctions(pParse, pAggInfo);
danielk1977a9d1ccb2008-01-05 17:39:29 +00007660 }
7661
drh079a3072014-03-19 14:10:55 +00007662 sSort.pOrderBy = 0;
drh33cd4902009-05-30 20:49:20 +00007663 sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
drh2def2f72017-09-15 17:40:34 +00007664 selectInnerLoop(pParse, p, -1, 0, 0,
drha9671a22008-07-08 23:40:20 +00007665 pDest, addrEnd, addrEnd);
drh13449892005-09-07 21:22:45 +00007666 }
7667 sqlite3VdbeResolveLabel(v, addrEnd);
7668
7669 } /* endif aggregate query */
drh22827922000-06-06 17:27:05 +00007670
drhe8e4af72012-09-21 00:04:28 +00007671 if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
dan2ce22452010-11-08 19:01:16 +00007672 explainTempTable(pParse, "DISTINCT");
7673 }
7674
drhcce7d172000-05-31 15:34:51 +00007675 /* If there is an ORDER BY clause, then we need to sort the results
7676 ** and send them to the callback one by one.
7677 */
drh079a3072014-03-19 14:10:55 +00007678 if( sSort.pOrderBy ){
drh38b41492015-06-08 15:08:15 +00007679 explainTempTable(pParse,
7680 sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
dan24e25d32018-04-14 18:46:20 +00007681 assert( p->pEList==pEList );
drh079a3072014-03-19 14:10:55 +00007682 generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
drhcce7d172000-05-31 15:34:51 +00007683 }
drh6a535342001-10-19 16:44:56 +00007684
drhec7429a2005-10-06 16:53:14 +00007685 /* Jump here to skip this query
7686 */
7687 sqlite3VdbeResolveLabel(v, iEnd);
7688
dan5b1c07e2015-04-16 07:19:23 +00007689 /* The SELECT has been coded. If there is an error in the Parse structure,
7690 ** set the return code to 1. Otherwise 0. */
7691 rc = (pParse->nErr>0);
drh1d83f052002-02-17 00:30:36 +00007692
7693 /* Control jumps to here if an error is encountered above, or upon
7694 ** successful coding of the SELECT.
7695 */
7696select_end:
dan44918c72021-04-17 14:42:37 +00007697 assert( db->mallocFailed==0 || db->mallocFailed==1 );
drh0c7d3d32022-01-24 16:47:12 +00007698 assert( db->mallocFailed==0 || pParse->nErr!=0 );
drh47d9f832017-10-26 20:04:28 +00007699 sqlite3ExprListDelete(db, pMinMaxOrderBy);
drh89636622020-06-07 17:33:18 +00007700#ifdef SQLITE_DEBUG
drh7b4c4d42020-06-10 03:07:26 +00007701 if( pAggInfo && !db->mallocFailed ){
drhbf790972020-06-07 20:18:07 +00007702 for(i=0; i<pAggInfo->nColumn; i++){
drh81185a52020-06-09 13:38:12 +00007703 Expr *pExpr = pAggInfo->aCol[i].pCExpr;
drh06ddb082020-12-22 14:54:20 +00007704 assert( pExpr!=0 );
drhbf790972020-06-07 20:18:07 +00007705 assert( pExpr->pAggInfo==pAggInfo );
drh89636622020-06-07 17:33:18 +00007706 assert( pExpr->iAgg==i );
7707 }
drhbf790972020-06-07 20:18:07 +00007708 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00007709 Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
drh06ddb082020-12-22 14:54:20 +00007710 assert( pExpr!=0 );
drhbf790972020-06-07 20:18:07 +00007711 assert( pExpr->pAggInfo==pAggInfo );
drh89636622020-06-07 17:33:18 +00007712 assert( pExpr->iAgg==i );
7713 }
drh89636622020-06-07 17:33:18 +00007714 }
drh89636622020-06-07 17:33:18 +00007715#endif
7716
drh5e431be2022-04-06 11:08:38 +00007717#if TREETRACE_ENABLED
drhf20609d2018-04-23 17:43:35 +00007718 SELECTTRACE(0x1,pParse,p,("end processing\n"));
drh5e431be2022-04-06 11:08:38 +00007719 if( (sqlite3TreeTrace & 0x2000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
drhf20609d2018-04-23 17:43:35 +00007720 sqlite3TreeViewSelect(0, p, 0);
7721 }
drheb9b8842014-09-21 00:27:26 +00007722#endif
drhe2ca99c2018-05-02 00:33:43 +00007723 ExplainQueryPlanPop(pParse);
drh1d83f052002-02-17 00:30:36 +00007724 return rc;
drhcce7d172000-05-31 15:34:51 +00007725}