blob: d27bed026f7305bf50c21fa3334cf8982225e069 [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 */
danf6f01f12022-12-03 18:16:25 +000068#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dana3d0c152022-12-05 18:19:56 +000069 int addrPush; /* First instruction to push data into sorter */
danf6f01f12022-12-03 18:16:25 +000070 int addrPushEnd; /* Last instruction that pushes data into sorter */
71#endif
drh079a3072014-03-19 14:10:55 +000072};
73#define SORTFLAG_UseSorter 0x01 /* Use SorterOpen instead of OpenEphemeral */
drh315555c2002-10-20 15:53:03 +000074
drhcce7d172000-05-31 15:34:51 +000075/*
drhb87fbed2015-01-05 15:48:45 +000076** Delete all the content of a Select structure. Deallocate the structure
drha9ebfe22019-12-25 23:54:21 +000077** itself depending on the value of bFree
78**
79** If bFree==1, call sqlite3DbFree() on the p object.
80** If bFree==0, Leave the first Select object unfreed
drheda639e2006-01-22 00:42:09 +000081*/
drhb87fbed2015-01-05 15:48:45 +000082static void clearSelect(sqlite3 *db, Select *p, int bFree){
drh41ce47c2022-08-22 02:00:26 +000083 assert( db!=0 );
drhb87fbed2015-01-05 15:48:45 +000084 while( p ){
85 Select *pPrior = p->pPrior;
86 sqlite3ExprListDelete(db, p->pEList);
87 sqlite3SrcListDelete(db, p->pSrc);
88 sqlite3ExprDelete(db, p->pWhere);
89 sqlite3ExprListDelete(db, p->pGroupBy);
90 sqlite3ExprDelete(db, p->pHaving);
91 sqlite3ExprListDelete(db, p->pOrderBy);
92 sqlite3ExprDelete(db, p->pLimit);
dan50f9f6c2021-03-04 14:18:22 +000093 if( OK_IF_ALWAYS_TRUE(p->pWith) ) sqlite3WithDelete(db, p->pWith);
dan67a9b8e2018-06-22 20:51:35 +000094#ifndef SQLITE_OMIT_WINDOWFUNC
dane3bf6322018-06-08 20:58:27 +000095 if( OK_IF_ALWAYS_TRUE(p->pWinDefn) ){
96 sqlite3WindowListDelete(db, p->pWinDefn);
97 }
dan50f9f6c2021-03-04 14:18:22 +000098 while( p->pWin ){
99 assert( p->pWin->ppThis==&p->pWin );
100 sqlite3WindowUnlinkFromSelect(p->pWin);
101 }
dan67a9b8e2018-06-22 20:51:35 +0000102#endif
drh41ce47c2022-08-22 02:00:26 +0000103 if( bFree ) sqlite3DbNNFreeNN(db, p);
drhb87fbed2015-01-05 15:48:45 +0000104 p = pPrior;
105 bFree = 1;
106 }
drheda639e2006-01-22 00:42:09 +0000107}
108
drh1013c932008-01-06 00:25:21 +0000109/*
110** Initialize a SelectDest structure.
111*/
112void sqlite3SelectDestInit(SelectDest *pDest, int eDest, int iParm){
drhea678832008-12-10 19:26:22 +0000113 pDest->eDest = (u8)eDest;
drh2b596da2012-07-23 21:43:19 +0000114 pDest->iSDParm = iParm;
dan9ed322d2020-04-29 17:41:29 +0000115 pDest->iSDParm2 = 0;
dan71c57db2016-07-09 20:23:55 +0000116 pDest->zAffSdst = 0;
drh2b596da2012-07-23 21:43:19 +0000117 pDest->iSdst = 0;
118 pDest->nSdst = 0;
drh1013c932008-01-06 00:25:21 +0000119}
120
drheda639e2006-01-22 00:42:09 +0000121
122/*
drh9bb61fe2000-06-05 16:01:39 +0000123** Allocate a new Select structure and return a pointer to that
124** structure.
drhcce7d172000-05-31 15:34:51 +0000125*/
danielk19774adee202004-05-08 08:23:19 +0000126Select *sqlite3SelectNew(
drh17435752007-08-16 04:30:38 +0000127 Parse *pParse, /* Parsing context */
drhdaffd0e2001-04-11 14:28:42 +0000128 ExprList *pEList, /* which columns to include in the result */
drhad3cab52002-05-24 02:04:32 +0000129 SrcList *pSrc, /* the FROM clause -- which tables to scan */
drhdaffd0e2001-04-11 14:28:42 +0000130 Expr *pWhere, /* the WHERE clause */
131 ExprList *pGroupBy, /* the GROUP BY clause */
132 Expr *pHaving, /* the HAVING clause */
133 ExprList *pOrderBy, /* the ORDER BY clause */
drhc3489bb2016-02-25 16:04:59 +0000134 u32 selFlags, /* Flag parameters, such as SF_Distinct */
drh8c0833f2017-11-14 23:48:23 +0000135 Expr *pLimit /* LIMIT value. NULL means not used */
drh9bb61fe2000-06-05 16:01:39 +0000136){
drhd3bf7662020-05-25 01:31:09 +0000137 Select *pNew, *pAllocated;
drheda639e2006-01-22 00:42:09 +0000138 Select standin;
drhd3bf7662020-05-25 01:31:09 +0000139 pAllocated = pNew = sqlite3DbMallocRawNN(pParse->db, sizeof(*pNew) );
drhdaffd0e2001-04-11 14:28:42 +0000140 if( pNew==0 ){
drhef90a6b2017-04-11 16:44:39 +0000141 assert( pParse->db->mallocFailed );
drheda639e2006-01-22 00:42:09 +0000142 pNew = &standin;
drheda639e2006-01-22 00:42:09 +0000143 }
144 if( pEList==0 ){
drh3d240d22017-09-28 16:56:55 +0000145 pEList = sqlite3ExprListAppend(pParse, 0,
146 sqlite3Expr(pParse->db,TK_ASTERISK,0));
drheda639e2006-01-22 00:42:09 +0000147 }
148 pNew->pEList = pEList;
drhca3862d2016-01-08 12:46:39 +0000149 pNew->op = TK_SELECT;
150 pNew->selFlags = selFlags;
151 pNew->iLimit = 0;
152 pNew->iOffset = 0;
drhfef37762018-07-10 19:48:35 +0000153 pNew->selId = ++pParse->nSelect;
drhca3862d2016-01-08 12:46:39 +0000154 pNew->addrOpenEphm[0] = -1;
155 pNew->addrOpenEphm[1] = -1;
156 pNew->nSelectRow = 0;
drhef90a6b2017-04-11 16:44:39 +0000157 if( pSrc==0 ) pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*pSrc));
drheda639e2006-01-22 00:42:09 +0000158 pNew->pSrc = pSrc;
159 pNew->pWhere = pWhere;
160 pNew->pGroupBy = pGroupBy;
161 pNew->pHaving = pHaving;
162 pNew->pOrderBy = pOrderBy;
drhca3862d2016-01-08 12:46:39 +0000163 pNew->pPrior = 0;
164 pNew->pNext = 0;
drheda639e2006-01-22 00:42:09 +0000165 pNew->pLimit = pLimit;
drhca3862d2016-01-08 12:46:39 +0000166 pNew->pWith = 0;
dan67a9b8e2018-06-22 20:51:35 +0000167#ifndef SQLITE_OMIT_WINDOWFUNC
dan86fb6e12018-05-16 20:58:07 +0000168 pNew->pWin = 0;
dane3bf6322018-06-08 20:58:27 +0000169 pNew->pWinDefn = 0;
dan67a9b8e2018-06-22 20:51:35 +0000170#endif
drhef90a6b2017-04-11 16:44:39 +0000171 if( pParse->db->mallocFailed ) {
172 clearSelect(pParse->db, pNew, pNew!=&standin);
drhd3bf7662020-05-25 01:31:09 +0000173 pAllocated = 0;
drha464c232011-09-16 19:04:03 +0000174 }else{
175 assert( pNew->pSrc!=0 || pParse->nErr>0 );
drhdaffd0e2001-04-11 14:28:42 +0000176 }
drhd3bf7662020-05-25 01:31:09 +0000177 return pAllocated;
drh9bb61fe2000-06-05 16:01:39 +0000178}
179
drheb9b8842014-09-21 00:27:26 +0000180
drh9bb61fe2000-06-05 16:01:39 +0000181/*
drheda639e2006-01-22 00:42:09 +0000182** Delete the given Select structure and all of its substructures.
183*/
drh633e6d52008-07-28 19:34:53 +0000184void sqlite3SelectDelete(sqlite3 *db, Select *p){
drh8906a4b2017-10-03 17:29:40 +0000185 if( OK_IF_ALWAYS_TRUE(p) ) clearSelect(db, p, 1);
drheda639e2006-01-22 00:42:09 +0000186}
187
188/*
drhd227a292014-02-09 18:02:09 +0000189** Return a pointer to the right-most SELECT statement in a compound.
190*/
191static Select *findRightmost(Select *p){
192 while( p->pNext ) p = p->pNext;
193 return p;
drh9bb61fe2000-06-05 16:01:39 +0000194}
195
196/*
drhf7b54962013-05-28 12:11:54 +0000197** Given 1 to 3 identifiers preceding the JOIN keyword, determine the
drh01f3f252002-05-24 16:14:15 +0000198** type of join. Return an integer constant that expresses that type
199** in terms of the following bit values:
200**
201** JT_INNER
drh3dec2232005-09-10 15:28:09 +0000202** JT_CROSS
drh01f3f252002-05-24 16:14:15 +0000203** JT_OUTER
204** JT_NATURAL
205** JT_LEFT
206** JT_RIGHT
207**
208** A full outer join is the combination of JT_LEFT and JT_RIGHT.
209**
210** If an illegal or unsupported join type is seen, then still return
211** a join type, but put an error in the pParse structure.
drh81a23622022-04-08 15:11:10 +0000212**
213** These are the valid join types:
214**
215**
216** pA pB pC Return Value
217** ------- ----- ----- ------------
218** CROSS - - JT_CROSS
219** INNER - - JT_INNER
220** LEFT - - JT_LEFT|JT_OUTER
221** LEFT OUTER - JT_LEFT|JT_OUTER
222** RIGHT - - JT_RIGHT|JT_OUTER
223** RIGHT OUTER - JT_RIGHT|JT_OUTER
224** FULL - - JT_LEFT|JT_RIGHT|JT_OUTER
225** FULL OUTER - JT_LEFT|JT_RIGHT|JT_OUTER
226** NATURAL INNER - JT_NATURAL|JT_INNER
227** NATURAL LEFT - JT_NATURAL|JT_LEFT|JT_OUTER
228** NATURAL LEFT OUTER JT_NATURAL|JT_LEFT|JT_OUTER
229** NATURAL RIGHT - JT_NATURAL|JT_RIGHT|JT_OUTER
230** NATURAL RIGHT OUTER JT_NATURAL|JT_RIGHT|JT_OUTER
231** NATURAL FULL - JT_NATURAL|JT_LEFT|JT_RIGHT
232** NATURAL FULL OUTER JT_NATRUAL|JT_LEFT|JT_RIGHT
233**
234** To preserve historical compatibly, SQLite also accepts a variety
235** of other non-standard and in many cases non-sensical join types.
236** This routine makes as much sense at it can from the nonsense join
237** type and returns a result. Examples of accepted nonsense join types
238** include but are not limited to:
239**
240** INNER CROSS JOIN -> same as JOIN
241** NATURAL CROSS JOIN -> same as NATURAL JOIN
242** OUTER LEFT JOIN -> same as LEFT JOIN
243** LEFT NATURAL JOIN -> same as NATURAL LEFT JOIN
244** LEFT RIGHT JOIN -> same as FULL JOIN
245** RIGHT OUTER FULL JOIN -> same as FULL JOIN
246** CROSS CROSS CROSS JOIN -> same as JOIN
247**
248** The only restrictions on the join type name are:
249**
250** * "INNER" cannot appear together with "OUTER", "LEFT", "RIGHT",
251** or "FULL".
252**
253** * "CROSS" cannot appear together with "OUTER", "LEFT", "RIGHT,
254** or "FULL".
255**
256** * If "OUTER" is present then there must also be one of
257** "LEFT", "RIGHT", or "FULL"
drh01f3f252002-05-24 16:14:15 +0000258*/
danielk19774adee202004-05-08 08:23:19 +0000259int sqlite3JoinType(Parse *pParse, Token *pA, Token *pB, Token *pC){
drh01f3f252002-05-24 16:14:15 +0000260 int jointype = 0;
261 Token *apAll[3];
262 Token *p;
drh373cc2d2009-05-17 02:06:14 +0000263 /* 0123456789 123456789 123456789 123 */
264 static const char zKeyText[] = "naturaleftouterightfullinnercross";
drh57196282004-10-06 15:41:16 +0000265 static const struct {
drh373cc2d2009-05-17 02:06:14 +0000266 u8 i; /* Beginning of keyword text in zKeyText[] */
267 u8 nChar; /* Length of the keyword in characters */
268 u8 code; /* Join type mask */
269 } aKeyword[] = {
drh81a23622022-04-08 15:11:10 +0000270 /* (0) natural */ { 0, 7, JT_NATURAL },
271 /* (1) left */ { 6, 4, JT_LEFT|JT_OUTER },
272 /* (2) outer */ { 10, 5, JT_OUTER },
273 /* (3) right */ { 14, 5, JT_RIGHT|JT_OUTER },
274 /* (4) full */ { 19, 4, JT_LEFT|JT_RIGHT|JT_OUTER },
275 /* (5) inner */ { 23, 5, JT_INNER },
276 /* (6) cross */ { 28, 5, JT_INNER|JT_CROSS },
drh01f3f252002-05-24 16:14:15 +0000277 };
278 int i, j;
279 apAll[0] = pA;
280 apAll[1] = pB;
281 apAll[2] = pC;
drh195e6962002-05-25 00:18:20 +0000282 for(i=0; i<3 && apAll[i]; i++){
drh01f3f252002-05-24 16:14:15 +0000283 p = apAll[i];
drh373cc2d2009-05-17 02:06:14 +0000284 for(j=0; j<ArraySize(aKeyword); j++){
285 if( p->n==aKeyword[j].nChar
286 && sqlite3StrNICmp((char*)p->z, &zKeyText[aKeyword[j].i], p->n)==0 ){
287 jointype |= aKeyword[j].code;
drh01f3f252002-05-24 16:14:15 +0000288 break;
289 }
290 }
drh373cc2d2009-05-17 02:06:14 +0000291 testcase( j==0 || j==1 || j==2 || j==3 || j==4 || j==5 || j==6 );
292 if( j>=ArraySize(aKeyword) ){
drh01f3f252002-05-24 16:14:15 +0000293 jointype |= JT_ERROR;
294 break;
295 }
296 }
drhad2d8302002-05-24 20:31:36 +0000297 if(
298 (jointype & (JT_INNER|JT_OUTER))==(JT_INNER|JT_OUTER) ||
drh81a23622022-04-08 15:11:10 +0000299 (jointype & JT_ERROR)!=0 ||
300 (jointype & (JT_OUTER|JT_LEFT|JT_RIGHT))==JT_OUTER
drhad2d8302002-05-24 20:31:36 +0000301 ){
drh81a23622022-04-08 15:11:10 +0000302 const char *zSp1 = " ";
303 const char *zSp2 = " ";
304 if( pB==0 ){ zSp1++; }
305 if( pC==0 ){ zSp2++; }
drh0879d5f2022-04-12 18:40:14 +0000306 sqlite3ErrorMsg(pParse, "unknown join type: "
drh81a23622022-04-08 15:11:10 +0000307 "%T%s%T%s%T", pA, zSp1, pB, zSp2, pC);
drh01f3f252002-05-24 16:14:15 +0000308 jointype = JT_INNER;
309 }
310 return jointype;
311}
312
313/*
drhad2d8302002-05-24 20:31:36 +0000314** Return the index of a column in a table. Return -1 if the column
315** is not contained in the table.
316*/
dan6e6d9832021-02-16 20:43:36 +0000317int sqlite3ColumnIndex(Table *pTab, const char *zCol){
drhad2d8302002-05-24 20:31:36 +0000318 int i;
drha1928072020-07-20 13:11:19 +0000319 u8 h = sqlite3StrIHash(zCol);
320 Column *pCol;
321 for(pCol=pTab->aCol, i=0; i<pTab->nCol; pCol++, i++){
drhcf9d36d2021-08-02 18:03:43 +0000322 if( pCol->hName==h && sqlite3StrICmp(pCol->zCnName, zCol)==0 ) return i;
drhad2d8302002-05-24 20:31:36 +0000323 }
324 return -1;
325}
326
327/*
drh815b7822022-04-20 15:07:39 +0000328** Mark a subquery result column as having been used.
329*/
330void sqlite3SrcItemColumnUsed(SrcItem *pItem, int iCol){
331 assert( pItem!=0 );
mistachkin07fae322022-07-06 23:50:01 +0000332 assert( (int)pItem->fg.isNestedFrom == IsNestedFrom(pItem->pSelect) );
drh815b7822022-04-20 15:07:39 +0000333 if( pItem->fg.isNestedFrom ){
334 ExprList *pResults;
335 assert( pItem->pSelect!=0 );
336 pResults = pItem->pSelect->pEList;
337 assert( pResults!=0 );
338 assert( iCol>=0 && iCol<pResults->nExpr );
drhd88fd532022-05-02 20:49:30 +0000339 pResults->a[iCol].fg.bUsed = 1;
drh815b7822022-04-20 15:07:39 +0000340 }
341}
342
343/*
drhfe146992022-04-17 18:46:17 +0000344** Search the tables iStart..iEnd (inclusive) in pSrc, looking for a
345** table that has a column named zCol. The search is left-to-right.
346** The first match found is returned.
drh2179b432009-12-09 17:36:39 +0000347**
348** When found, set *piTab and *piCol to the table index and column index
349** of the matching column and return TRUE.
350**
351** If not found, return FALSE.
352*/
353static int tableAndColumnIndex(
354 SrcList *pSrc, /* Array of tables to search */
drhfe146992022-04-17 18:46:17 +0000355 int iStart, /* First member of pSrc->a[] to check */
356 int iEnd, /* Last member of pSrc->a[] to check */
drh2179b432009-12-09 17:36:39 +0000357 const char *zCol, /* Name of the column we are looking for */
358 int *piTab, /* Write index of pSrc->a[] here */
dan9d41af22019-12-30 14:32:27 +0000359 int *piCol, /* Write index of pSrc->a[*piTab].pTab->aCol[] here */
drhfe146992022-04-17 18:46:17 +0000360 int bIgnoreHidden /* Ignore hidden columns */
drh2179b432009-12-09 17:36:39 +0000361){
362 int i; /* For looping over tables in pSrc */
363 int iCol; /* Index of column matching zCol */
364
drhfe146992022-04-17 18:46:17 +0000365 assert( iEnd<pSrc->nSrc );
366 assert( iStart>=0 );
drh2179b432009-12-09 17:36:39 +0000367 assert( (piTab==0)==(piCol==0) ); /* Both or neither are NULL */
drhfe146992022-04-17 18:46:17 +0000368
369 for(i=iStart; i<=iEnd; i++){
dan6e6d9832021-02-16 20:43:36 +0000370 iCol = sqlite3ColumnIndex(pSrc->a[i].pTab, zCol);
dan9d41af22019-12-30 14:32:27 +0000371 if( iCol>=0
372 && (bIgnoreHidden==0 || IsHiddenColumn(&pSrc->a[i].pTab->aCol[iCol])==0)
373 ){
drh2179b432009-12-09 17:36:39 +0000374 if( piTab ){
drh815b7822022-04-20 15:07:39 +0000375 sqlite3SrcItemColumnUsed(&pSrc->a[i], iCol);
drh2179b432009-12-09 17:36:39 +0000376 *piTab = i;
377 *piCol = iCol;
378 }
drhfe146992022-04-17 18:46:17 +0000379 return 1;
drh2179b432009-12-09 17:36:39 +0000380 }
381 }
drhfe146992022-04-17 18:46:17 +0000382 return 0;
drhad2d8302002-05-24 20:31:36 +0000383}
384
385/*
drh67a99db2022-05-13 14:52:04 +0000386** Set the EP_OuterON property on all terms of the given expression.
drhd1985262022-04-11 11:25:28 +0000387** And set the Expr.w.iJoin to iTable for every term in the
drh22d6a532005-09-19 21:05:48 +0000388** expression.
drh1cc093c2002-06-24 22:01:57 +0000389**
drh67a99db2022-05-13 14:52:04 +0000390** The EP_OuterON property is used on terms of an expression to tell
drhb77c07a2022-04-11 11:59:25 +0000391** the OUTER JOIN processing logic that this term is part of the
drh1f162302002-10-27 19:35:33 +0000392** join restriction specified in the ON or USING clause and not a part
393** of the more general WHERE clause. These terms are moved over to the
394** WHERE clause during join processing but we need to remember that they
395** originated in the ON or USING clause.
drh22d6a532005-09-19 21:05:48 +0000396**
drhd1985262022-04-11 11:25:28 +0000397** The Expr.w.iJoin tells the WHERE clause processing that the
398** expression depends on table w.iJoin even if that table is not
drh22d6a532005-09-19 21:05:48 +0000399** explicitly mentioned in the expression. That information is needed
400** for cases like this:
401**
402** SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.b AND t1.x=5
403**
404** The where clause needs to defer the handling of the t1.x=5
405** term until after the t2 loop of the join. In that way, a
406** NULL t2 row will be inserted whenever t1.x!=5. If we do not
407** defer the handling of t1.x=5, it will be processed immediately
408** after the t1 loop and rows with t1.x!=5 will never appear in
409** the output, which is incorrect.
drh1cc093c2002-06-24 22:01:57 +0000410*/
drh3a6e4c52022-04-11 12:38:06 +0000411void sqlite3SetJoinExpr(Expr *p, int iTable, u32 joinFlag){
drh67a99db2022-05-13 14:52:04 +0000412 assert( joinFlag==EP_OuterON || joinFlag==EP_InnerON );
drh1cc093c2002-06-24 22:01:57 +0000413 while( p ){
drh3a6e4c52022-04-11 12:38:06 +0000414 ExprSetProperty(p, joinFlag);
drhc5cd1242013-09-12 16:50:49 +0000415 assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
drhebb6a652013-09-12 23:42:22 +0000416 ExprSetVVAProperty(p, EP_NoReduce);
drhd1985262022-04-11 11:25:28 +0000417 p->w.iJoin = iTable;
drha4eeccd2021-10-07 17:43:30 +0000418 if( p->op==TK_FUNCTION ){
419 assert( ExprUseXList(p) );
420 if( p->x.pList ){
421 int i;
422 for(i=0; i<p->x.pList->nExpr; i++){
drh3a6e4c52022-04-11 12:38:06 +0000423 sqlite3SetJoinExpr(p->x.pList->a[i].pExpr, iTable, joinFlag);
drha4eeccd2021-10-07 17:43:30 +0000424 }
drh606f2342015-06-18 14:32:51 +0000425 }
426 }
drh3a6e4c52022-04-11 12:38:06 +0000427 sqlite3SetJoinExpr(p->pLeft, iTable, joinFlag);
drh1cc093c2002-06-24 22:01:57 +0000428 p = p->pRight;
429 }
430}
431
drhd7480402022-06-20 17:04:44 +0000432/* Undo the work of sqlite3SetJoinExpr(). This is used when a LEFT JOIN
433** is simplified into an ordinary JOIN, and when an ON expression is
434** "pushed down" into the WHERE clause of a subquery.
drh25897872018-03-20 21:16:15 +0000435**
drhd7480402022-06-20 17:04:44 +0000436** Convert every term that is marked with EP_OuterON and w.iJoin==iTable into
437** an ordinary term that omits the EP_OuterON mark. Or if iTable<0, then
438** just clear every EP_OuterON and EP_InnerON mark from the expression tree.
drh92d1afb2022-06-13 12:42:24 +0000439**
440** If nullable is true, that means that Expr p might evaluate to NULL even
441** if it is a reference to a NOT NULL column. This can happen, for example,
442** if the table that p references is on the left side of a RIGHT JOIN.
443** If nullable is true, then take care to not remove the EP_CanBeNull bit.
444** See forum thread https://sqlite.org/forum/forumpost/b40696f50145d21c
drh25897872018-03-20 21:16:15 +0000445*/
drh92d1afb2022-06-13 12:42:24 +0000446static void unsetJoinExpr(Expr *p, int iTable, int nullable){
drh25897872018-03-20 21:16:15 +0000447 while( p ){
drhd7480402022-06-20 17:04:44 +0000448 if( iTable<0 || (ExprHasProperty(p, EP_OuterON) && p->w.iJoin==iTable) ){
449 ExprClearProperty(p, EP_OuterON|EP_InnerON);
450 if( iTable>=0 ) ExprSetProperty(p, EP_InnerON);
drh25897872018-03-20 21:16:15 +0000451 }
drh92d1afb2022-06-13 12:42:24 +0000452 if( p->op==TK_COLUMN && p->iTable==iTable && !nullable ){
dan8ddf6862021-02-26 20:14:32 +0000453 ExprClearProperty(p, EP_CanBeNull);
454 }
drha4eeccd2021-10-07 17:43:30 +0000455 if( p->op==TK_FUNCTION ){
456 assert( ExprUseXList(p) );
457 if( p->x.pList ){
458 int i;
459 for(i=0; i<p->x.pList->nExpr; i++){
drh92d1afb2022-06-13 12:42:24 +0000460 unsetJoinExpr(p->x.pList->a[i].pExpr, iTable, nullable);
drha4eeccd2021-10-07 17:43:30 +0000461 }
drh25897872018-03-20 21:16:15 +0000462 }
463 }
drh92d1afb2022-06-13 12:42:24 +0000464 unsetJoinExpr(p->pLeft, iTable, nullable);
drh25897872018-03-20 21:16:15 +0000465 p = p->pRight;
466 }
467}
468
drh1cc093c2002-06-24 22:01:57 +0000469/*
drhad2d8302002-05-24 20:31:36 +0000470** This routine processes the join information for a SELECT statement.
drhbc656e22022-04-20 16:26:22 +0000471**
472** * A NATURAL join is converted into a USING join. After that, we
473** do not need to be concerned with NATURAL joins and we only have
474** think about USING joins.
475**
476** * ON and USING clauses result in extra terms being added to the
477** WHERE clause to enforce the specified constraints. The extra
drh67a99db2022-05-13 14:52:04 +0000478** WHERE clause terms will be tagged with EP_OuterON or
479** EP_InnerON so that we know that they originated in ON/USING.
drhad2d8302002-05-24 20:31:36 +0000480**
drh91bb0ee2004-09-01 03:06:34 +0000481** The terms of a FROM clause are contained in the Select.pSrc structure.
482** The left most table is the first entry in Select.pSrc. The right-most
483** table is the last entry. The join operator is held in the entry to
drhbc656e22022-04-20 16:26:22 +0000484** the right. Thus entry 1 contains the join operator for the join between
drh91bb0ee2004-09-01 03:06:34 +0000485** entries 0 and 1. Any ON or USING clauses associated with the join are
drhbc656e22022-04-20 16:26:22 +0000486** also attached to the right entry.
drh91bb0ee2004-09-01 03:06:34 +0000487**
drhad2d8302002-05-24 20:31:36 +0000488** This routine returns the number of errors encountered.
489*/
drh358424a2022-04-15 15:15:01 +0000490static int sqlite3ProcessJoin(Parse *pParse, Select *p){
drh91bb0ee2004-09-01 03:06:34 +0000491 SrcList *pSrc; /* All tables in the FROM clause */
492 int i, j; /* Loop counters */
drh76012942021-02-21 21:04:54 +0000493 SrcItem *pLeft; /* Left table being joined */
494 SrcItem *pRight; /* Right table being joined */
drhad2d8302002-05-24 20:31:36 +0000495
drh91bb0ee2004-09-01 03:06:34 +0000496 pSrc = p->pSrc;
497 pLeft = &pSrc->a[0];
498 pRight = &pLeft[1];
499 for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
drh91bb0ee2004-09-01 03:06:34 +0000500 Table *pRightTab = pRight->pTab;
drh3a6e4c52022-04-11 12:38:06 +0000501 u32 joinType;
drh91bb0ee2004-09-01 03:06:34 +0000502
drhce2c4822017-10-03 17:17:34 +0000503 if( NEVER(pLeft->pTab==0 || pRightTab==0) ) continue;
drh67a99db2022-05-13 14:52:04 +0000504 joinType = (pRight->fg.jointype & JT_OUTER)!=0 ? EP_OuterON : EP_InnerON;
drhad2d8302002-05-24 20:31:36 +0000505
drh22c4bc82022-04-15 17:08:40 +0000506 /* If this is a NATURAL join, synthesize an approprate USING clause
507 ** to specify which columns should be joined.
drhad2d8302002-05-24 20:31:36 +0000508 */
drh8a48b9c2015-08-19 15:20:00 +0000509 if( pRight->fg.jointype & JT_NATURAL ){
drh22c4bc82022-04-15 17:08:40 +0000510 IdList *pUsing = 0;
drhd44f8b22022-04-07 01:11:13 +0000511 if( pRight->fg.isUsing || pRight->u3.pOn ){
danielk19774adee202004-05-08 08:23:19 +0000512 sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
drhad2d8302002-05-24 20:31:36 +0000513 "an ON or USING clause", 0);
drhad2d8302002-05-24 20:31:36 +0000514 return 1;
515 }
drh2179b432009-12-09 17:36:39 +0000516 for(j=0; j<pRightTab->nCol; j++){
517 char *zName; /* Name of column in the right table */
drh2179b432009-12-09 17:36:39 +0000518
dan9d41af22019-12-30 14:32:27 +0000519 if( IsHiddenColumn(&pRightTab->aCol[j]) ) continue;
drhcf9d36d2021-08-02 18:03:43 +0000520 zName = pRightTab->aCol[j].zCnName;
drhfe146992022-04-17 18:46:17 +0000521 if( tableAndColumnIndex(pSrc, 0, i, zName, 0, 0, 1) ){
drhd0453f72022-04-18 00:04:15 +0000522 pUsing = sqlite3IdListAppend(pParse, pUsing, 0);
523 if( pUsing ){
524 assert( pUsing->nId>0 );
525 assert( pUsing->a[pUsing->nId-1].zName==0 );
526 pUsing->a[pUsing->nId-1].zName = sqlite3DbStrDup(pParse->db, zName);
527 }
drhad2d8302002-05-24 20:31:36 +0000528 }
529 }
drh22c4bc82022-04-15 17:08:40 +0000530 if( pUsing ){
531 pRight->fg.isUsing = 1;
drh4ce7bf92022-04-15 18:30:48 +0000532 pRight->fg.isSynthUsing = 1;
drh22c4bc82022-04-15 17:08:40 +0000533 pRight->u3.pUsing = pUsing;
534 }
drhabf86bd2022-04-18 09:59:33 +0000535 if( pParse->nErr ) return 1;
drhad2d8302002-05-24 20:31:36 +0000536 }
537
drhad2d8302002-05-24 20:31:36 +0000538 /* Create extra terms on the WHERE clause for each column named
539 ** in the USING clause. Example: If the two tables to be joined are
540 ** A and B and the USING clause names X, Y, and Z, then add this
541 ** to the WHERE clause: A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
542 ** Report an error if any column mentioned in the USING clause is
543 ** not contained in both tables to be joined.
544 */
drhd44f8b22022-04-07 01:11:13 +0000545 if( pRight->fg.isUsing ){
546 IdList *pList = pRight->u3.pUsing;
drhfe146992022-04-17 18:46:17 +0000547 sqlite3 *db = pParse->db;
drhd44f8b22022-04-07 01:11:13 +0000548 assert( pList!=0 );
drhad2d8302002-05-24 20:31:36 +0000549 for(j=0; j<pList->nId; j++){
drh2179b432009-12-09 17:36:39 +0000550 char *zName; /* Name of the term in the USING clause */
551 int iLeft; /* Table on the left with matching column name */
552 int iLeftCol; /* Column number of matching column on the left */
553 int iRightCol; /* Column number of matching column on the right */
drhfe146992022-04-17 18:46:17 +0000554 Expr *pE1; /* Reference to the column on the LEFT of the join */
555 Expr *pE2; /* Reference to the column on the RIGHT of the join */
556 Expr *pEq; /* Equality constraint. pE1 == pE2 */
drh2179b432009-12-09 17:36:39 +0000557
558 zName = pList->a[j].zName;
dan6e6d9832021-02-16 20:43:36 +0000559 iRightCol = sqlite3ColumnIndex(pRightTab, zName);
drh2179b432009-12-09 17:36:39 +0000560 if( iRightCol<0
drhfe146992022-04-17 18:46:17 +0000561 || tableAndColumnIndex(pSrc, 0, i, zName, &iLeft, &iLeftCol,
562 pRight->fg.isSynthUsing)==0
drh2179b432009-12-09 17:36:39 +0000563 ){
danielk19774adee202004-05-08 08:23:19 +0000564 sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
drh91bb0ee2004-09-01 03:06:34 +0000565 "not present in both tables", zName);
drhad2d8302002-05-24 20:31:36 +0000566 return 1;
567 }
drhfe146992022-04-17 18:46:17 +0000568 pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iLeftCol);
drh22b410d2022-04-20 18:12:42 +0000569 sqlite3SrcItemColumnUsed(&pSrc->a[iLeft], iLeftCol);
drhfe146992022-04-17 18:46:17 +0000570 if( (pSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
571 /* This branch runs if the query contains one or more RIGHT or FULL
572 ** JOINs. If only a single table on the left side of this join
drhbc656e22022-04-20 16:26:22 +0000573 ** contains the zName column, then this branch is a no-op.
574 ** But if there are two or more tables on the left side
drhfe146992022-04-17 18:46:17 +0000575 ** of the join, construct a coalesce() function that gathers all
576 ** such tables. Raise an error if more than one of those references
577 ** to zName is not also within a prior USING clause.
578 **
579 ** We really ought to raise an error if there are two or more
580 ** non-USING references to zName on the left of an INNER or LEFT
581 ** JOIN. But older versions of SQLite do not do that, so we avoid
582 ** adding a new error so as to not break legacy applications.
drh052953a2022-04-16 22:57:41 +0000583 */
drhfe146992022-04-17 18:46:17 +0000584 ExprList *pFuncArgs = 0; /* Arguments to the coalesce() */
drh052953a2022-04-16 22:57:41 +0000585 static const Token tkCoalesce = { "coalesce", 8 };
drhfe146992022-04-17 18:46:17 +0000586 while( tableAndColumnIndex(pSrc, iLeft+1, i, zName, &iLeft, &iLeftCol,
587 pRight->fg.isSynthUsing)!=0 ){
588 if( pSrc->a[iLeft].fg.isUsing==0
589 || sqlite3IdListIndex(pSrc->a[iLeft].u3.pUsing, zName)<0
590 ){
591 sqlite3ErrorMsg(pParse, "ambiguous reference to %s in USING()",
592 zName);
593 break;
594 }
595 pFuncArgs = sqlite3ExprListAppend(pParse, pFuncArgs, pE1);
596 pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iLeftCol);
drh22b410d2022-04-20 18:12:42 +0000597 sqlite3SrcItemColumnUsed(&pSrc->a[iLeft], iLeftCol);
drh052953a2022-04-16 22:57:41 +0000598 }
drhfe146992022-04-17 18:46:17 +0000599 if( pFuncArgs ){
600 pFuncArgs = sqlite3ExprListAppend(pParse, pFuncArgs, pE1);
601 pE1 = sqlite3ExprFunction(pParse, pFuncArgs, &tkCoalesce, 0);
drh052953a2022-04-16 22:57:41 +0000602 }
drh052953a2022-04-16 22:57:41 +0000603 }
drhfe146992022-04-17 18:46:17 +0000604 pE2 = sqlite3CreateColumnExpr(db, pSrc, i+1, iRightCol);
drh815b7822022-04-20 15:07:39 +0000605 sqlite3SrcItemColumnUsed(pRight, iRightCol);
drhfe146992022-04-17 18:46:17 +0000606 pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2);
607 assert( pE2!=0 || pEq==0 );
608 if( pEq ){
609 ExprSetProperty(pEq, joinType);
610 assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
611 ExprSetVVAProperty(pEq, EP_NoReduce);
612 pEq->w.iJoin = pE2->iTable;
613 }
614 p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pEq);
drhad2d8302002-05-24 20:31:36 +0000615 }
616 }
drhd44f8b22022-04-07 01:11:13 +0000617
618 /* Add the ON clause to the end of the WHERE clause, connected by
619 ** an AND operator.
620 */
621 else if( pRight->u3.pOn ){
drh3a6e4c52022-04-11 12:38:06 +0000622 sqlite3SetJoinExpr(pRight->u3.pOn, pRight->iCursor, joinType);
drhd44f8b22022-04-07 01:11:13 +0000623 p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pRight->u3.pOn);
624 pRight->u3.pOn = 0;
drh5c118e32022-06-08 15:30:39 +0000625 pRight->fg.isOn = 1;
drhd44f8b22022-04-07 01:11:13 +0000626 }
drhad2d8302002-05-24 20:31:36 +0000627 }
628 return 0;
629}
630
631/*
drhbbd4ae52018-04-30 19:32:49 +0000632** An instance of this object holds information (beyond pParse and pSelect)
633** needed to load the next result row that is to be added to the sorter.
634*/
635typedef struct RowLoadInfo RowLoadInfo;
636struct RowLoadInfo {
637 int regResult; /* Store results in array of registers here */
638 u8 ecelFlags; /* Flag argument to ExprCodeExprList() */
639#ifdef SQLITE_ENABLE_SORTER_REFERENCES
640 ExprList *pExtra; /* Extra columns needed by sorter refs */
641 int regExtraResult; /* Where to load the extra columns */
642#endif
643};
644
645/*
646** This routine does the work of loading query data into an array of
647** registers so that it can be added to the sorter.
648*/
649static void innerLoopLoadRow(
650 Parse *pParse, /* Statement under construction */
651 Select *pSelect, /* The query being coded */
652 RowLoadInfo *pInfo /* Info needed to complete the row load */
653){
654 sqlite3ExprCodeExprList(pParse, pSelect->pEList, pInfo->regResult,
655 0, pInfo->ecelFlags);
656#ifdef SQLITE_ENABLE_SORTER_REFERENCES
657 if( pInfo->pExtra ){
658 sqlite3ExprCodeExprList(pParse, pInfo->pExtra, pInfo->regExtraResult, 0, 0);
659 sqlite3ExprListDelete(pParse->db, pInfo->pExtra);
660 }
661#endif
662}
663
664/*
665** Code the OP_MakeRecord instruction that generates the entry to be
666** added into the sorter.
667**
668** Return the register in which the result is stored.
669*/
670static int makeSorterRecord(
671 Parse *pParse,
672 SortCtx *pSort,
673 Select *pSelect,
674 int regBase,
675 int nBase
676){
677 int nOBSat = pSort->nOBSat;
678 Vdbe *v = pParse->pVdbe;
679 int regOut = ++pParse->nMem;
680 if( pSort->pDeferredRowLoad ){
681 innerLoopLoadRow(pParse, pSelect, pSort->pDeferredRowLoad);
682 }
683 sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regOut);
684 return regOut;
685}
686
687/*
drhf45f2322014-03-23 17:45:03 +0000688** Generate code that will push the record in registers regData
689** through regData+nData-1 onto the sorter.
drhc926afb2002-06-20 03:38:26 +0000690*/
drhd59ba6c2006-01-08 05:02:54 +0000691static void pushOntoSorter(
692 Parse *pParse, /* Parser context */
drh079a3072014-03-19 14:10:55 +0000693 SortCtx *pSort, /* Information about the ORDER BY clause */
drhb7654112008-01-12 12:48:07 +0000694 Select *pSelect, /* The whole SELECT statement */
drhf45f2322014-03-23 17:45:03 +0000695 int regData, /* First register holding data to be sorted */
drh5579d592015-08-26 14:01:41 +0000696 int regOrigData, /* First register holding data before packing */
drhbbd4ae52018-04-30 19:32:49 +0000697 int nData, /* Number of elements in the regData data array */
drhfd0a2f92014-03-24 18:08:15 +0000698 int nPrefixReg /* No. of reg prior to regData available for use */
drhd59ba6c2006-01-08 05:02:54 +0000699){
drhf45f2322014-03-23 17:45:03 +0000700 Vdbe *v = pParse->pVdbe; /* Stmt under construction */
dan78d58432014-03-25 15:04:07 +0000701 int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
drhf45f2322014-03-23 17:45:03 +0000702 int nExpr = pSort->pOrderBy->nExpr; /* No. of ORDER BY terms */
dan78d58432014-03-25 15:04:07 +0000703 int nBase = nExpr + bSeq + nData; /* Fields in sorter record */
drhfd0a2f92014-03-24 18:08:15 +0000704 int regBase; /* Regs for sorter record */
drhbbd4ae52018-04-30 19:32:49 +0000705 int regRecord = 0; /* Assembled sorter record */
dan78d58432014-03-25 15:04:07 +0000706 int nOBSat = pSort->nOBSat; /* ORDER BY terms to skip */
707 int op; /* Opcode to add sorter record to sorter */
drha04a8be2016-01-13 17:50:10 +0000708 int iLimit; /* LIMIT counter */
drhbbd4ae52018-04-30 19:32:49 +0000709 int iSkip = 0; /* End of the sorter insert loop */
drhf45f2322014-03-23 17:45:03 +0000710
dan78d58432014-03-25 15:04:07 +0000711 assert( bSeq==0 || bSeq==1 );
drhbbd4ae52018-04-30 19:32:49 +0000712
713 /* Three cases:
714 ** (1) The data to be sorted has already been packed into a Record
715 ** by a prior OP_MakeRecord. In this case nData==1 and regData
716 ** will be completely unrelated to regOrigData.
717 ** (2) All output columns are included in the sort record. In that
718 ** case regData==regOrigData.
719 ** (3) Some output columns are omitted from the sort record due to
720 ** the SQLITE_ENABLE_SORTER_REFERENCE optimization, or due to the
drhc6f36fa2018-05-05 16:50:35 +0000721 ** SQLITE_ECEL_OMITREF optimization, or due to the
722 ** SortCtx.pDeferredRowLoad optimiation. In any of these cases
723 ** regOrigData is 0 to prevent this routine from trying to copy
724 ** values that might not yet exist.
drhbbd4ae52018-04-30 19:32:49 +0000725 */
dan9af90b72016-11-11 18:08:59 +0000726 assert( nData==1 || regData==regOrigData || regOrigData==0 );
drhbbd4ae52018-04-30 19:32:49 +0000727
danf6f01f12022-12-03 18:16:25 +0000728#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dana3d0c152022-12-05 18:19:56 +0000729 pSort->addrPush = sqlite3VdbeCurrentAddr(v);
danf6f01f12022-12-03 18:16:25 +0000730#endif
731
drhfd0a2f92014-03-24 18:08:15 +0000732 if( nPrefixReg ){
dan78d58432014-03-25 15:04:07 +0000733 assert( nPrefixReg==nExpr+bSeq );
drhbbd4ae52018-04-30 19:32:49 +0000734 regBase = regData - nPrefixReg;
drhfd0a2f92014-03-24 18:08:15 +0000735 }else{
drhfb0d6e52014-05-02 13:09:06 +0000736 regBase = pParse->nMem + 1;
737 pParse->nMem += nBase;
drhfd0a2f92014-03-24 18:08:15 +0000738 }
drha04a8be2016-01-13 17:50:10 +0000739 assert( pSelect->iOffset==0 || pSelect->iLimit!=0 );
740 iLimit = pSelect->iOffset ? pSelect->iOffset+1 : pSelect->iLimit;
drhec4ccdb2018-12-29 02:26:59 +0000741 pSort->labelDone = sqlite3VdbeMakeLabel(pParse);
drh5579d592015-08-26 14:01:41 +0000742 sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, regOrigData,
dan9af90b72016-11-11 18:08:59 +0000743 SQLITE_ECEL_DUP | (regOrigData? SQLITE_ECEL_REF : 0));
dan78d58432014-03-25 15:04:07 +0000744 if( bSeq ){
745 sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
drhfd0a2f92014-03-24 18:08:15 +0000746 }
dan257c13f2016-11-10 20:14:06 +0000747 if( nPrefixReg==0 && nData>0 ){
drh236241a2014-09-12 17:41:30 +0000748 sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
dan78d58432014-03-25 15:04:07 +0000749 }
drh079a3072014-03-19 14:10:55 +0000750 if( nOBSat>0 ){
751 int regPrevKey; /* The first nOBSat columns of the previous row */
752 int addrFirst; /* Address of the OP_IfNot opcode */
753 int addrJmp; /* Address of the OP_Jump opcode */
754 VdbeOp *pOp; /* Opcode that opens the sorter */
755 int nKey; /* Number of sorting key columns, including OP_Sequence */
drhdbfca2b2014-03-22 02:19:53 +0000756 KeyInfo *pKI; /* Original KeyInfo on the sorter table */
drh079a3072014-03-19 14:10:55 +0000757
drhbbd4ae52018-04-30 19:32:49 +0000758 regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
drh26d7e7c2014-03-19 16:56:58 +0000759 regPrevKey = pParse->nMem+1;
760 pParse->nMem += pSort->nOBSat;
dan78d58432014-03-25 15:04:07 +0000761 nKey = nExpr - pSort->nOBSat + bSeq;
762 if( bSeq ){
763 addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
764 }else{
765 addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
766 }
767 VdbeCoverage(v);
drh26d7e7c2014-03-19 16:56:58 +0000768 sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
drh079a3072014-03-19 14:10:55 +0000769 pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
drh59b8f2e2014-03-22 00:27:14 +0000770 if( pParse->db->mallocFailed ) return;
drhfb0d6e52014-05-02 13:09:06 +0000771 pOp->p2 = nKey + nData;
drhdbfca2b2014-03-22 02:19:53 +0000772 pKI = pOp->p4.pKeyInfo;
dan6e118922019-08-12 16:36:38 +0000773 memset(pKI->aSortFlags, 0, pKI->nKeyField); /* Makes OP_Jump testable */
drhdbfca2b2014-03-22 02:19:53 +0000774 sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
drha485ad12017-08-02 22:43:14 +0000775 testcase( pKI->nAllField > pKI->nKeyField+2 );
danf9eae182018-05-21 19:45:11 +0000776 pOp->p4.pKeyInfo = sqlite3KeyInfoFromExprList(pParse,pSort->pOrderBy,nOBSat,
drha485ad12017-08-02 22:43:14 +0000777 pKI->nAllField-pKI->nKeyField-1);
drh166bc382019-10-26 15:40:17 +0000778 pOp = 0; /* Ensure pOp not used after sqltie3VdbeAddOp3() */
drh079a3072014-03-19 14:10:55 +0000779 addrJmp = sqlite3VdbeCurrentAddr(v);
780 sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
drhec4ccdb2018-12-29 02:26:59 +0000781 pSort->labelBkOut = sqlite3VdbeMakeLabel(pParse);
drh079a3072014-03-19 14:10:55 +0000782 pSort->regReturn = ++pParse->nMem;
783 sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
drh65ea12c2014-03-19 17:41:36 +0000784 sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
drha04a8be2016-01-13 17:50:10 +0000785 if( iLimit ){
786 sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, pSort->labelDone);
787 VdbeCoverage(v);
788 }
drh079a3072014-03-19 14:10:55 +0000789 sqlite3VdbeJumpHere(v, addrFirst);
drh236241a2014-09-12 17:41:30 +0000790 sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
drh079a3072014-03-19 14:10:55 +0000791 sqlite3VdbeJumpHere(v, addrJmp);
792 }
danf226f032018-04-26 16:13:47 +0000793 if( iLimit ){
794 /* At this point the values for the new sorter entry are stored
795 ** in an array of registers. They need to be composed into a record
796 ** and inserted into the sorter if either (a) there are currently
797 ** less than LIMIT+OFFSET items or (b) the new record is smaller than
798 ** the largest record currently in the sorter. If (b) is true and there
799 ** are already LIMIT+OFFSET items in the sorter, delete the largest
800 ** entry before inserting the new one. This way there are never more
801 ** than LIMIT+OFFSET items in the sorter.
802 **
803 ** If the new record does not need to be inserted into the sorter,
drh6ee5a7b2018-09-08 20:09:46 +0000804 ** jump to the next iteration of the loop. If the pSort->labelOBLopt
805 ** value is not zero, then it is a label of where to jump. Otherwise,
806 ** just bypass the row insert logic. See the header comment on the
807 ** sqlite3WhereOrderByLimitOptLabel() function for additional info.
danf226f032018-04-26 16:13:47 +0000808 */
809 int iCsr = pSort->iECursor;
danf226f032018-04-26 16:13:47 +0000810 sqlite3VdbeAddOp2(v, OP_IfNotZero, iLimit, sqlite3VdbeCurrentAddr(v)+4);
811 VdbeCoverage(v);
812 sqlite3VdbeAddOp2(v, OP_Last, iCsr, 0);
drhbbd4ae52018-04-30 19:32:49 +0000813 iSkip = sqlite3VdbeAddOp4Int(v, OP_IdxLE,
814 iCsr, 0, regBase+nOBSat, nExpr-nOBSat);
danf226f032018-04-26 16:13:47 +0000815 VdbeCoverage(v);
816 sqlite3VdbeAddOp1(v, OP_Delete, iCsr);
817 }
drhbbd4ae52018-04-30 19:32:49 +0000818 if( regRecord==0 ){
819 regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
danf226f032018-04-26 16:13:47 +0000820 }
drh079a3072014-03-19 14:10:55 +0000821 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drhc6aff302011-09-01 15:32:47 +0000822 op = OP_SorterInsert;
823 }else{
824 op = OP_IdxInsert;
825 }
drh4a8b0132016-11-09 01:38:56 +0000826 sqlite3VdbeAddOp4Int(v, op, pSort->iECursor, regRecord,
827 regBase+nOBSat, nBase-nOBSat);
drhbbd4ae52018-04-30 19:32:49 +0000828 if( iSkip ){
drhbbd4ae52018-04-30 19:32:49 +0000829 sqlite3VdbeChangeP2(v, iSkip,
drh6ee5a7b2018-09-08 20:09:46 +0000830 pSort->labelOBLopt ? pSort->labelOBLopt : sqlite3VdbeCurrentAddr(v));
drhbbd4ae52018-04-30 19:32:49 +0000831 }
danf6f01f12022-12-03 18:16:25 +0000832#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
833 pSort->addrPushEnd = sqlite3VdbeCurrentAddr(v)-1;
834#endif
drhc926afb2002-06-20 03:38:26 +0000835}
836
837/*
drhec7429a2005-10-06 16:53:14 +0000838** Add code to implement the OFFSET
drhea48eb22004-07-19 23:16:38 +0000839*/
drhec7429a2005-10-06 16:53:14 +0000840static void codeOffset(
drhbab39e12004-07-19 23:38:11 +0000841 Vdbe *v, /* Generate code into this VM */
drhaa9ce702014-01-22 18:07:04 +0000842 int iOffset, /* Register holding the offset counter */
drhb7654112008-01-12 12:48:07 +0000843 int iContinue /* Jump here to skip the current record */
drhea48eb22004-07-19 23:16:38 +0000844){
drha22a75e2014-03-21 18:16:23 +0000845 if( iOffset>0 ){
drh8b0cf382015-10-06 21:07:06 +0000846 sqlite3VdbeAddOp3(v, OP_IfPos, iOffset, iContinue, 1); VdbeCoverage(v);
847 VdbeComment((v, "OFFSET"));
drhea48eb22004-07-19 23:16:38 +0000848 }
drhea48eb22004-07-19 23:16:38 +0000849}
850
851/*
dan96ecb7b2021-03-09 16:47:33 +0000852** Add code that will check to make sure the array of registers starting at
853** iMem form a distinct entry. This is used by both "SELECT DISTINCT ..." and
dan76075802021-03-12 21:09:20 +0000854** distinct aggregates ("SELECT count(DISTINCT <expr>) ..."). Three strategies
855** are available. Which is used depends on the value of parameter eTnctType,
856** as follows:
drha2a49dc2008-01-02 14:28:13 +0000857**
dan96ecb7b2021-03-09 16:47:33 +0000858** WHERE_DISTINCT_UNORDERED/WHERE_DISTINCT_NOOP:
drh9be13392021-03-24 19:44:01 +0000859** Build an ephemeral table that contains all entries seen before and
860** skip entries which have been seen before.
861**
dan76075802021-03-12 21:09:20 +0000862** Parameter iTab is the cursor number of an ephemeral table that must
863** be opened before the VM code generated by this routine is executed.
dan5383db72021-03-12 18:24:31 +0000864** The ephemeral cursor table is queried for a record identical to the
dan96ecb7b2021-03-09 16:47:33 +0000865** record formed by the current array of registers. If one is found,
866** jump to VM address addrRepeat. Otherwise, insert a new record into
867** the ephemeral cursor and proceed.
868**
dan76075802021-03-12 21:09:20 +0000869** The returned value in this case is a copy of parameter iTab.
870**
dan96ecb7b2021-03-09 16:47:33 +0000871** WHERE_DISTINCT_ORDERED:
drh9be13392021-03-24 19:44:01 +0000872** In this case rows are being delivered sorted order. The ephermal
873** table is not required. Instead, the current set of values
874** is compared against previous row. If they match, the new row
dan96ecb7b2021-03-09 16:47:33 +0000875** is not distinct and control jumps to VM address addrRepeat. Otherwise,
876** the VM program proceeds with processing the new row.
877**
dan76075802021-03-12 21:09:20 +0000878** The returned value in this case is the register number of the first
879** in an array of registers used to store the previous result row so that
drh9be13392021-03-24 19:44:01 +0000880** it can be compared to the next. The caller must ensure that this
881** register is initialized to NULL. (The fixDistinctOpenEph() routine
882** will take care of this initialization.)
dan76075802021-03-12 21:09:20 +0000883**
dan96ecb7b2021-03-09 16:47:33 +0000884** WHERE_DISTINCT_UNIQUE:
885** In this case it has already been determined that the rows are distinct.
drh9be13392021-03-24 19:44:01 +0000886** No special action is required. The return value is zero.
dan96ecb7b2021-03-09 16:47:33 +0000887**
888** Parameter pEList is the list of expressions used to generated the
889** contents of each row. It is used by this routine to determine (a)
890** how many elements there are in the array of registers and (b) the
891** collation sequences that should be used for the comparisons if
892** eTnctType is WHERE_DISTINCT_ORDERED.
drha2a49dc2008-01-02 14:28:13 +0000893*/
dan5383db72021-03-12 18:24:31 +0000894static int codeDistinct(
drh2dcef112008-01-12 19:03:48 +0000895 Parse *pParse, /* Parsing and code generating context */
dan4fcb30b2021-03-09 16:06:25 +0000896 int eTnctType, /* WHERE_DISTINCT_* value */
drha2a49dc2008-01-02 14:28:13 +0000897 int iTab, /* A sorting index used to test for distinctness */
898 int addrRepeat, /* Jump to here if not distinct */
dan4fcb30b2021-03-09 16:06:25 +0000899 ExprList *pEList, /* Expression for each element */
900 int regElem /* First element */
drha2a49dc2008-01-02 14:28:13 +0000901){
dan5383db72021-03-12 18:24:31 +0000902 int iRet = 0;
dan4fcb30b2021-03-09 16:06:25 +0000903 int nResultCol = pEList->nExpr;
904 Vdbe *v = pParse->pVdbe;
drh2dcef112008-01-12 19:03:48 +0000905
dan4fcb30b2021-03-09 16:06:25 +0000906 switch( eTnctType ){
907 case WHERE_DISTINCT_ORDERED: {
908 int i;
dan4fcb30b2021-03-09 16:06:25 +0000909 int iJump; /* Jump destination */
910 int regPrev; /* Previous row content */
911
912 /* Allocate space for the previous row */
dan5383db72021-03-12 18:24:31 +0000913 iRet = regPrev = pParse->nMem+1;
dan4fcb30b2021-03-09 16:06:25 +0000914 pParse->nMem += nResultCol;
915
dan4fcb30b2021-03-09 16:06:25 +0000916 iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
917 for(i=0; i<nResultCol; i++){
918 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pEList->a[i].pExpr);
919 if( i<nResultCol-1 ){
920 sqlite3VdbeAddOp3(v, OP_Ne, regElem+i, iJump, regPrev+i);
921 VdbeCoverage(v);
922 }else{
923 sqlite3VdbeAddOp3(v, OP_Eq, regElem+i, addrRepeat, regPrev+i);
924 VdbeCoverage(v);
925 }
926 sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
927 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
928 }
929 assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
930 sqlite3VdbeAddOp3(v, OP_Copy, regElem, regPrev, nResultCol-1);
931 break;
932 }
933
934 case WHERE_DISTINCT_UNIQUE: {
dan5383db72021-03-12 18:24:31 +0000935 /* nothing to do */
dan4fcb30b2021-03-09 16:06:25 +0000936 break;
937 }
938
939 default: {
940 int r1 = sqlite3GetTempReg(pParse);
941 sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, regElem, nResultCol);
942 VdbeCoverage(v);
943 sqlite3VdbeAddOp3(v, OP_MakeRecord, regElem, nResultCol, r1);
944 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r1, regElem, nResultCol);
945 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
946 sqlite3ReleaseTempReg(pParse, r1);
dan5383db72021-03-12 18:24:31 +0000947 iRet = iTab;
dan4fcb30b2021-03-09 16:06:25 +0000948 break;
949 }
950 }
dan5383db72021-03-12 18:24:31 +0000951
952 return iRet;
953}
954
dan76075802021-03-12 21:09:20 +0000955/*
drh9be13392021-03-24 19:44:01 +0000956** This routine runs after codeDistinct(). It makes necessary
957** adjustments to the OP_OpenEphemeral opcode that the codeDistinct()
958** routine made use of. This processing must be done separately since
959** sometimes codeDistinct is called before the OP_OpenEphemeral is actually
960** laid down.
dan76075802021-03-12 21:09:20 +0000961**
drh9be13392021-03-24 19:44:01 +0000962** WHERE_DISTINCT_NOOP:
963** WHERE_DISTINCT_UNORDERED:
dan76075802021-03-12 21:09:20 +0000964**
drh9be13392021-03-24 19:44:01 +0000965** No adjustments necessary. This function is a no-op.
dan76075802021-03-12 21:09:20 +0000966**
drh9be13392021-03-24 19:44:01 +0000967** WHERE_DISTINCT_UNIQUE:
968**
969** The ephemeral table is not needed. So change the
970** OP_OpenEphemeral opcode into an OP_Noop.
971**
972** WHERE_DISTINCT_ORDERED:
973**
974** The ephemeral table is not needed. But we do need register
975** iVal to be initialized to NULL. So change the OP_OpenEphemeral
976** into an OP_Null on the iVal register.
dan76075802021-03-12 21:09:20 +0000977*/
dan5383db72021-03-12 18:24:31 +0000978static void fixDistinctOpenEph(
979 Parse *pParse, /* Parsing and code generating context */
980 int eTnctType, /* WHERE_DISTINCT_* value */
981 int iVal, /* Value returned by codeDistinct() */
dan76075802021-03-12 21:09:20 +0000982 int iOpenEphAddr /* Address of OP_OpenEphemeral instruction for iTab */
dan5383db72021-03-12 18:24:31 +0000983){
drhc6da6db2021-07-28 02:04:58 +0000984 if( pParse->nErr==0
985 && (eTnctType==WHERE_DISTINCT_UNIQUE || eTnctType==WHERE_DISTINCT_ORDERED)
986 ){
dan5383db72021-03-12 18:24:31 +0000987 Vdbe *v = pParse->pVdbe;
dan76075802021-03-12 21:09:20 +0000988 sqlite3VdbeChangeToNoop(v, iOpenEphAddr);
drh9be13392021-03-24 19:44:01 +0000989 if( sqlite3VdbeGetOp(v, iOpenEphAddr+1)->opcode==OP_Explain ){
990 sqlite3VdbeChangeToNoop(v, iOpenEphAddr+1);
991 }
dan5383db72021-03-12 18:24:31 +0000992 if( eTnctType==WHERE_DISTINCT_ORDERED ){
993 /* Change the OP_OpenEphemeral to an OP_Null that sets the MEM_Cleared
994 ** bit on the first register of the previous value. This will cause the
995 ** OP_Ne added in codeDistinct() to always fail on the first iteration of
996 ** the loop even if the first row is all NULLs. */
dan76075802021-03-12 21:09:20 +0000997 VdbeOp *pOp = sqlite3VdbeGetOp(v, iOpenEphAddr);
dan5383db72021-03-12 18:24:31 +0000998 pOp->opcode = OP_Null;
999 pOp->p1 = 1;
1000 pOp->p2 = iVal;
1001 }
1002 }
drha2a49dc2008-01-02 14:28:13 +00001003}
1004
dan24e25d32018-04-14 18:46:20 +00001005#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1006/*
1007** This function is called as part of inner-loop generation for a SELECT
1008** statement with an ORDER BY that is not optimized by an index. It
1009** determines the expressions, if any, that the sorter-reference
1010** optimization should be used for. The sorter-reference optimization
1011** is used for SELECT queries like:
1012**
1013** SELECT a, bigblob FROM t1 ORDER BY a LIMIT 10
1014**
1015** If the optimization is used for expression "bigblob", then instead of
1016** storing values read from that column in the sorter records, the PK of
1017** the row from table t1 is stored instead. Then, as records are extracted from
1018** the sorter to return to the user, the required value of bigblob is
1019** retrieved directly from table t1. If the values are very large, this
1020** can be more efficient than storing them directly in the sorter records.
1021**
drh00e5d3d2022-05-03 16:18:25 +00001022** The ExprList_item.fg.bSorterRef flag is set for each expression in pEList
dan24e25d32018-04-14 18:46:20 +00001023** for which the sorter-reference optimization should be enabled.
1024** Additionally, the pSort->aDefer[] array is populated with entries
1025** for all cursors required to evaluate all selected expressions. Finally.
1026** output variable (*ppExtra) is set to an expression list containing
1027** expressions for all extra PK values that should be stored in the
1028** sorter records.
1029*/
1030static void selectExprDefer(
1031 Parse *pParse, /* Leave any error here */
1032 SortCtx *pSort, /* Sorter context */
1033 ExprList *pEList, /* Expressions destined for sorter */
1034 ExprList **ppExtra /* Expressions to append to sorter record */
1035){
1036 int i;
1037 int nDefer = 0;
1038 ExprList *pExtra = 0;
1039 for(i=0; i<pEList->nExpr; i++){
1040 struct ExprList_item *pItem = &pEList->a[i];
1041 if( pItem->u.x.iOrderByCol==0 ){
1042 Expr *pExpr = pItem->pExpr;
drh477572b2021-10-07 20:46:29 +00001043 Table *pTab;
drhffa5b052021-10-12 18:05:55 +00001044 if( pExpr->op==TK_COLUMN
1045 && pExpr->iColumn>=0
1046 && ALWAYS( ExprUseYTab(pExpr) )
1047 && (pTab = pExpr->y.pTab)!=0
1048 && IsOrdinaryTable(pTab)
1049 && (pTab->aCol[pExpr->iColumn].colFlags & COLFLAG_SORTERREF)!=0
dan24e25d32018-04-14 18:46:20 +00001050 ){
1051 int j;
1052 for(j=0; j<nDefer; j++){
1053 if( pSort->aDefer[j].iCsr==pExpr->iTable ) break;
1054 }
1055 if( j==nDefer ){
1056 if( nDefer==ArraySize(pSort->aDefer) ){
1057 continue;
1058 }else{
1059 int nKey = 1;
1060 int k;
1061 Index *pPk = 0;
1062 if( !HasRowid(pTab) ){
1063 pPk = sqlite3PrimaryKeyIndex(pTab);
1064 nKey = pPk->nKeyCol;
1065 }
1066 for(k=0; k<nKey; k++){
1067 Expr *pNew = sqlite3PExpr(pParse, TK_COLUMN, 0, 0);
1068 if( pNew ){
1069 pNew->iTable = pExpr->iTable;
drh477572b2021-10-07 20:46:29 +00001070 assert( ExprUseYTab(pNew) );
drheda079c2018-09-20 19:02:15 +00001071 pNew->y.pTab = pExpr->y.pTab;
dan24e25d32018-04-14 18:46:20 +00001072 pNew->iColumn = pPk ? pPk->aiColumn[k] : -1;
1073 pExtra = sqlite3ExprListAppend(pParse, pExtra, pNew);
1074 }
1075 }
drheda079c2018-09-20 19:02:15 +00001076 pSort->aDefer[nDefer].pTab = pExpr->y.pTab;
dan24e25d32018-04-14 18:46:20 +00001077 pSort->aDefer[nDefer].iCsr = pExpr->iTable;
1078 pSort->aDefer[nDefer].nKey = nKey;
1079 nDefer++;
1080 }
1081 }
drhd88fd532022-05-02 20:49:30 +00001082 pItem->fg.bSorterRef = 1;
dan24e25d32018-04-14 18:46:20 +00001083 }
1084 }
1085 }
1086 pSort->nDefer = (u8)nDefer;
1087 *ppExtra = pExtra;
1088}
1089#endif
1090
drhc99130f2005-09-11 11:56:27 +00001091/*
drh22827922000-06-06 17:27:05 +00001092** This routine generates the code for the inside of the inner loop
1093** of a SELECT.
drh82c3d632000-06-06 21:56:07 +00001094**
drh2def2f72017-09-15 17:40:34 +00001095** If srcTab is negative, then the p->pEList expressions
drh340309f2014-01-22 00:23:49 +00001096** are evaluated in order to get the data for this row. If srcTab is
drh2def2f72017-09-15 17:40:34 +00001097** zero or more, then data is pulled from srcTab and p->pEList is used only
dan257c13f2016-11-10 20:14:06 +00001098** to get the number of columns and the collation sequence for each column.
drh22827922000-06-06 17:27:05 +00001099*/
drhd2b3e232008-01-23 14:51:49 +00001100static void selectInnerLoop(
drh22827922000-06-06 17:27:05 +00001101 Parse *pParse, /* The parser context */
drhdf199a22002-06-14 22:38:41 +00001102 Select *p, /* The complete select statement being coded */
drh2def2f72017-09-15 17:40:34 +00001103 int srcTab, /* Pull data from this table if non-negative */
drh079a3072014-03-19 14:10:55 +00001104 SortCtx *pSort, /* If not NULL, info on how to process ORDER BY */
drhe8e4af72012-09-21 00:04:28 +00001105 DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
danielk19776c8c8ce2008-01-02 16:27:09 +00001106 SelectDest *pDest, /* How to dispose of the results */
drh22827922000-06-06 17:27:05 +00001107 int iContinue, /* Jump here to continue with next row */
drha9671a22008-07-08 23:40:20 +00001108 int iBreak /* Jump here to break out of the inner loop */
drh22827922000-06-06 17:27:05 +00001109){
1110 Vdbe *v = pParse->pVdbe;
drhd847eaa2008-01-17 17:15:56 +00001111 int i;
dan9af90b72016-11-11 18:08:59 +00001112 int hasDistinct; /* True if the DISTINCT keyword is present */
drhd847eaa2008-01-17 17:15:56 +00001113 int eDest = pDest->eDest; /* How to dispose of results */
drh2b596da2012-07-23 21:43:19 +00001114 int iParm = pDest->iSDParm; /* First argument to disposal method */
drhd847eaa2008-01-17 17:15:56 +00001115 int nResultCol; /* Number of result columns */
drhfd0a2f92014-03-24 18:08:15 +00001116 int nPrefixReg = 0; /* Number of extra registers before regResult */
drhbbd4ae52018-04-30 19:32:49 +00001117 RowLoadInfo sRowLoadInfo; /* Info for deferred row loading */
drh38640e12002-07-05 21:42:36 +00001118
dan9af90b72016-11-11 18:08:59 +00001119 /* Usually, regResult is the first cell in an array of memory cells
1120 ** containing the current result row. In this case regOrig is set to the
1121 ** same value. However, if the results are being sent to the sorter, the
1122 ** values for any expressions that are also part of the sort-key are omitted
1123 ** from this array. In this case regOrig is set to zero. */
1124 int regResult; /* Start of memory holding current results */
1125 int regOrig; /* Start of memory holding full result (or 0) */
1126
drh1c767f02009-01-09 02:49:31 +00001127 assert( v );
drh2def2f72017-09-15 17:40:34 +00001128 assert( p->pEList!=0 );
drhe8e4af72012-09-21 00:04:28 +00001129 hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
drh079a3072014-03-19 14:10:55 +00001130 if( pSort && pSort->pOrderBy==0 ) pSort = 0;
1131 if( pSort==0 && !hasDistinct ){
drha22a75e2014-03-21 18:16:23 +00001132 assert( iContinue!=0 );
drhaa9ce702014-01-22 18:07:04 +00001133 codeOffset(v, p->iOffset, iContinue);
drhdf199a22002-06-14 22:38:41 +00001134 }
1135
drh967e8b72000-06-21 13:59:10 +00001136 /* Pull the requested columns.
drh22827922000-06-06 17:27:05 +00001137 */
drh2def2f72017-09-15 17:40:34 +00001138 nResultCol = p->pEList->nExpr;
drh05a86c52014-02-16 01:55:49 +00001139
drh2b596da2012-07-23 21:43:19 +00001140 if( pDest->iSdst==0 ){
drhfd0a2f92014-03-24 18:08:15 +00001141 if( pSort ){
dan78d58432014-03-25 15:04:07 +00001142 nPrefixReg = pSort->pOrderBy->nExpr;
1143 if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
drhfd0a2f92014-03-24 18:08:15 +00001144 pParse->nMem += nPrefixReg;
1145 }
drh2b596da2012-07-23 21:43:19 +00001146 pDest->iSdst = pParse->nMem+1;
drh0acb7e42008-06-25 00:12:41 +00001147 pParse->nMem += nResultCol;
drh05a86c52014-02-16 01:55:49 +00001148 }else if( pDest->iSdst+nResultCol > pParse->nMem ){
1149 /* This is an error condition that can result, for example, when a SELECT
1150 ** on the right-hand side of an INSERT contains more result columns than
1151 ** there are columns in the table on the left. The error will be caught
1152 ** and reported later. But we need to make sure enough memory is allocated
1153 ** to avoid other spurious errors in the meantime. */
1154 pParse->nMem += nResultCol;
drh1013c932008-01-06 00:25:21 +00001155 }
drh05a86c52014-02-16 01:55:49 +00001156 pDest->nSdst = nResultCol;
dan9af90b72016-11-11 18:08:59 +00001157 regOrig = regResult = pDest->iSdst;
drh340309f2014-01-22 00:23:49 +00001158 if( srcTab>=0 ){
1159 for(i=0; i<nResultCol; i++){
drhd847eaa2008-01-17 17:15:56 +00001160 sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
drh41cee662019-12-12 20:22:34 +00001161 VdbeComment((v, "%s", p->pEList->a[i].zEName));
drh82c3d632000-06-06 21:56:07 +00001162 }
danielk19779ed1dfa2008-01-02 17:11:14 +00001163 }else if( eDest!=SRT_Exists ){
dan24e25d32018-04-14 18:46:20 +00001164#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1165 ExprList *pExtra = 0;
1166#endif
danielk19779ed1dfa2008-01-02 17:11:14 +00001167 /* If the destination is an EXISTS(...) expression, the actual
1168 ** values returned by the SELECT are not required.
1169 */
drhbbd4ae52018-04-30 19:32:49 +00001170 u8 ecelFlags; /* "ecel" is an abbreviation of "ExprCodeExprList" */
1171 ExprList *pEList;
drhdf553652015-05-18 04:24:27 +00001172 if( eDest==SRT_Mem || eDest==SRT_Output || eDest==SRT_Coroutine ){
1173 ecelFlags = SQLITE_ECEL_DUP;
1174 }else{
1175 ecelFlags = 0;
1176 }
danac56ab72017-01-05 17:23:11 +00001177 if( pSort && hasDistinct==0 && eDest!=SRT_EphemTab && eDest!=SRT_Table ){
drh2def2f72017-09-15 17:40:34 +00001178 /* For each expression in p->pEList that is a copy of an expression in
dan257c13f2016-11-10 20:14:06 +00001179 ** the ORDER BY clause (pSort->pOrderBy), set the associated
1180 ** iOrderByCol value to one more than the index of the ORDER BY
1181 ** expression within the sort-key that pushOntoSorter() will generate.
drh2def2f72017-09-15 17:40:34 +00001182 ** This allows the p->pEList field to be omitted from the sorted record,
dan257c13f2016-11-10 20:14:06 +00001183 ** saving space and CPU cycles. */
1184 ecelFlags |= (SQLITE_ECEL_OMITREF|SQLITE_ECEL_REF);
drhbbd4ae52018-04-30 19:32:49 +00001185
dan257c13f2016-11-10 20:14:06 +00001186 for(i=pSort->nOBSat; i<pSort->pOrderBy->nExpr; i++){
1187 int j;
1188 if( (j = pSort->pOrderBy->a[i].u.x.iOrderByCol)>0 ){
drh2def2f72017-09-15 17:40:34 +00001189 p->pEList->a[j-1].u.x.iOrderByCol = i+1-pSort->nOBSat;
dan257c13f2016-11-10 20:14:06 +00001190 }
1191 }
dan24e25d32018-04-14 18:46:20 +00001192#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1193 selectExprDefer(pParse, pSort, p->pEList, &pExtra);
drh5a2e65e2018-04-18 19:08:44 +00001194 if( pExtra && pParse->db->mallocFailed==0 ){
dan24e25d32018-04-14 18:46:20 +00001195 /* If there are any extra PK columns to add to the sorter records,
1196 ** allocate extra memory cells and adjust the OpenEphemeral
1197 ** instruction to account for the larger records. This is only
1198 ** required if there are one or more WITHOUT ROWID tables with
1199 ** composite primary keys in the SortCtx.aDefer[] array. */
1200 VdbeOp *pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
1201 pOp->p2 += (pExtra->nExpr - pSort->nDefer);
1202 pOp->p4.pKeyInfo->nAllField += (pExtra->nExpr - pSort->nDefer);
1203 pParse->nMem += pExtra->nExpr;
1204 }
1205#endif
drhbbd4ae52018-04-30 19:32:49 +00001206
1207 /* Adjust nResultCol to account for columns that are omitted
1208 ** from the sorter by the optimizations in this branch */
1209 pEList = p->pEList;
1210 for(i=0; i<pEList->nExpr; i++){
1211 if( pEList->a[i].u.x.iOrderByCol>0
1212#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001213 || pEList->a[i].fg.bSorterRef
drhbbd4ae52018-04-30 19:32:49 +00001214#endif
1215 ){
1216 nResultCol--;
1217 regOrig = 0;
1218 }
1219 }
1220
1221 testcase( regOrig );
1222 testcase( eDest==SRT_Set );
1223 testcase( eDest==SRT_Mem );
1224 testcase( eDest==SRT_Coroutine );
1225 testcase( eDest==SRT_Output );
dan257c13f2016-11-10 20:14:06 +00001226 assert( eDest==SRT_Set || eDest==SRT_Mem
danf2972b62020-04-29 20:11:01 +00001227 || eDest==SRT_Coroutine || eDest==SRT_Output
1228 || eDest==SRT_Upfrom );
dan257c13f2016-11-10 20:14:06 +00001229 }
drhbbd4ae52018-04-30 19:32:49 +00001230 sRowLoadInfo.regResult = regResult;
1231 sRowLoadInfo.ecelFlags = ecelFlags;
dan24e25d32018-04-14 18:46:20 +00001232#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhbbd4ae52018-04-30 19:32:49 +00001233 sRowLoadInfo.pExtra = pExtra;
1234 sRowLoadInfo.regExtraResult = regResult + nResultCol;
1235 if( pExtra ) nResultCol += pExtra->nExpr;
dan24e25d32018-04-14 18:46:20 +00001236#endif
drhbbd4ae52018-04-30 19:32:49 +00001237 if( p->iLimit
1238 && (ecelFlags & SQLITE_ECEL_OMITREF)!=0
1239 && nPrefixReg>0
1240 ){
1241 assert( pSort!=0 );
1242 assert( hasDistinct==0 );
1243 pSort->pDeferredRowLoad = &sRowLoadInfo;
drhc6f36fa2018-05-05 16:50:35 +00001244 regOrig = 0;
drhbbd4ae52018-04-30 19:32:49 +00001245 }else{
1246 innerLoopLoadRow(pParse, p, &sRowLoadInfo);
1247 }
drh22827922000-06-06 17:27:05 +00001248 }
1249
drhdaffd0e2001-04-11 14:28:42 +00001250 /* If the DISTINCT keyword was present on the SELECT statement
1251 ** and this row has been seen before, then do not make this row
1252 ** part of the result.
drh22827922000-06-06 17:27:05 +00001253 */
drhea48eb22004-07-19 23:16:38 +00001254 if( hasDistinct ){
dan5383db72021-03-12 18:24:31 +00001255 int eType = pDistinct->eTnctType;
1256 int iTab = pDistinct->tabTnct;
dan4fcb30b2021-03-09 16:06:25 +00001257 assert( nResultCol==p->pEList->nExpr );
dan5383db72021-03-12 18:24:31 +00001258 iTab = codeDistinct(pParse, eType, iTab, iContinue, p->pEList, regResult);
1259 fixDistinctOpenEph(pParse, eType, iTab, pDistinct->addrTnct);
drh079a3072014-03-19 14:10:55 +00001260 if( pSort==0 ){
drhaa9ce702014-01-22 18:07:04 +00001261 codeOffset(v, p->iOffset, iContinue);
drhea48eb22004-07-19 23:16:38 +00001262 }
drh22827922000-06-06 17:27:05 +00001263 }
drh82c3d632000-06-06 21:56:07 +00001264
drhc926afb2002-06-20 03:38:26 +00001265 switch( eDest ){
1266 /* In this mode, write each query result to the key of the temporary
1267 ** table iParm.
1268 */
drh13449892005-09-07 21:22:45 +00001269#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhc926afb2002-06-20 03:38:26 +00001270 case SRT_Union: {
drh9cbf3422008-01-17 16:22:13 +00001271 int r1;
1272 r1 = sqlite3GetTempReg(pParse);
drh340309f2014-01-22 00:23:49 +00001273 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
drh9b4eaeb2016-11-09 00:10:33 +00001274 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
drh9cbf3422008-01-17 16:22:13 +00001275 sqlite3ReleaseTempReg(pParse, r1);
drhc926afb2002-06-20 03:38:26 +00001276 break;
drh22827922000-06-06 17:27:05 +00001277 }
drh22827922000-06-06 17:27:05 +00001278
drhc926afb2002-06-20 03:38:26 +00001279 /* Construct a record from the query result, but instead of
1280 ** saving that record, use it as a key to delete elements from
1281 ** the temporary table iParm.
1282 */
1283 case SRT_Except: {
drh340309f2014-01-22 00:23:49 +00001284 sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
drhc926afb2002-06-20 03:38:26 +00001285 break;
1286 }
drh781def22014-01-22 13:35:53 +00001287#endif /* SQLITE_OMIT_COMPOUND_SELECT */
danielk19775338a5f2005-01-20 13:03:10 +00001288
1289 /* Store the result as data using a unique key.
1290 */
drh8e1ee882014-03-21 19:56:09 +00001291 case SRT_Fifo:
1292 case SRT_DistFifo:
danielk19775338a5f2005-01-20 13:03:10 +00001293 case SRT_Table:
drhb9bb7c12006-06-11 23:41:55 +00001294 case SRT_EphemTab: {
drhfd0a2f92014-03-24 18:08:15 +00001295 int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
drh373cc2d2009-05-17 02:06:14 +00001296 testcase( eDest==SRT_Table );
1297 testcase( eDest==SRT_EphemTab );
drhe2248cf2015-05-22 17:29:27 +00001298 testcase( eDest==SRT_Fifo );
1299 testcase( eDest==SRT_DistFifo );
drhfd0a2f92014-03-24 18:08:15 +00001300 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
dan8ce71842014-01-14 20:14:09 +00001301#ifndef SQLITE_OMIT_CTE
drh8e1ee882014-03-21 19:56:09 +00001302 if( eDest==SRT_DistFifo ){
1303 /* If the destination is DistFifo, then cursor (iParm+1) is open
dan8ce71842014-01-14 20:14:09 +00001304 ** on an ephemeral index. If the current row is already present
1305 ** in the index, do not write it to the output. If not, add the
1306 ** current row to the index and proceed with writing it to the
1307 ** output table as well. */
1308 int addr = sqlite3VdbeCurrentAddr(v) + 4;
drh38b41492015-06-08 15:08:15 +00001309 sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0);
1310 VdbeCoverage(v);
drh9b4eaeb2016-11-09 00:10:33 +00001311 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm+1, r1,regResult,nResultCol);
drh079a3072014-03-19 14:10:55 +00001312 assert( pSort==0 );
dan8ce71842014-01-14 20:14:09 +00001313 }
1314#endif
drh079a3072014-03-19 14:10:55 +00001315 if( pSort ){
drhbbd4ae52018-04-30 19:32:49 +00001316 assert( regResult==regOrig );
1317 pushOntoSorter(pParse, pSort, p, r1+nPrefixReg, regOrig, 1, nPrefixReg);
danielk19775338a5f2005-01-20 13:03:10 +00001318 }else{
drhb7654112008-01-12 12:48:07 +00001319 int r2 = sqlite3GetTempReg(pParse);
1320 sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
1321 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
1322 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1323 sqlite3ReleaseTempReg(pParse, r2);
danielk19775338a5f2005-01-20 13:03:10 +00001324 }
drhfd0a2f92014-03-24 18:08:15 +00001325 sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
danielk19775338a5f2005-01-20 13:03:10 +00001326 break;
1327 }
drh5974a302000-06-07 14:42:26 +00001328
dan9ed322d2020-04-29 17:41:29 +00001329 case SRT_Upfrom: {
danf2972b62020-04-29 20:11:01 +00001330 if( pSort ){
1331 pushOntoSorter(
1332 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drh2add24c2020-07-23 14:12:47 +00001333 }else{
danf2972b62020-04-29 20:11:01 +00001334 int i2 = pDest->iSDParm2;
1335 int r1 = sqlite3GetTempReg(pParse);
drh09cf5692020-07-20 18:07:35 +00001336
1337 /* If the UPDATE FROM join is an aggregate that matches no rows, it
1338 ** might still be trying to return one row, because that is what
1339 ** aggregates do. Don't record that empty row in the output table. */
1340 sqlite3VdbeAddOp2(v, OP_IsNull, regResult, iBreak); VdbeCoverage(v);
1341
1342 sqlite3VdbeAddOp3(v, OP_MakeRecord,
1343 regResult+(i2<0), nResultCol-(i2<0), r1);
danf2972b62020-04-29 20:11:01 +00001344 if( i2<0 ){
1345 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regResult);
1346 }else{
1347 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, i2);
1348 }
dan9ed322d2020-04-29 17:41:29 +00001349 }
1350 break;
1351 }
1352
1353#ifndef SQLITE_OMIT_SUBQUERY
drhc926afb2002-06-20 03:38:26 +00001354 /* If we are creating a set for an "expr IN (SELECT ...)" construct,
1355 ** then there should be a single item on the stack. Write this
1356 ** item into the set table with bogus data.
1357 */
1358 case SRT_Set: {
drh079a3072014-03-19 14:10:55 +00001359 if( pSort ){
drhde941c62005-08-28 01:34:21 +00001360 /* At first glance you would think we could optimize out the
1361 ** ORDER BY in this case since the order of entries in the set
1362 ** does not matter. But there might be a LIMIT clause, in which
1363 ** case the order does matter */
dan51d82d12016-08-02 18:50:15 +00001364 pushOntoSorter(
dan9af90b72016-11-11 18:08:59 +00001365 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drhc926afb2002-06-20 03:38:26 +00001366 }else{
drhb7654112008-01-12 12:48:07 +00001367 int r1 = sqlite3GetTempReg(pParse);
dan9ed322d2020-04-29 17:41:29 +00001368 assert( sqlite3Strlen30(pDest->zAffSdst)==nResultCol );
1369 sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult, nResultCol,
1370 r1, pDest->zAffSdst, nResultCol);
1371 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
drhb7654112008-01-12 12:48:07 +00001372 sqlite3ReleaseTempReg(pParse, r1);
drhc926afb2002-06-20 03:38:26 +00001373 }
1374 break;
1375 }
drh22827922000-06-06 17:27:05 +00001376
dan9ed322d2020-04-29 17:41:29 +00001377
drh504b6982006-01-22 21:52:56 +00001378 /* If any row exist in the result set, record that fact and abort.
drhec7429a2005-10-06 16:53:14 +00001379 */
1380 case SRT_Exists: {
drh4c583122008-01-04 22:01:03 +00001381 sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
drhec7429a2005-10-06 16:53:14 +00001382 /* The LIMIT clause will terminate the loop for us */
1383 break;
1384 }
1385
drhc926afb2002-06-20 03:38:26 +00001386 /* If this is a scalar select that is part of an expression, then
dan870a0702016-08-01 16:37:43 +00001387 ** store the results in the appropriate memory cell or array of
1388 ** memory cells and break out of the scan loop.
drhc926afb2002-06-20 03:38:26 +00001389 */
1390 case SRT_Mem: {
drh079a3072014-03-19 14:10:55 +00001391 if( pSort ){
dan257c13f2016-11-10 20:14:06 +00001392 assert( nResultCol<=pDest->nSdst );
dan870a0702016-08-01 16:37:43 +00001393 pushOntoSorter(
dan9af90b72016-11-11 18:08:59 +00001394 pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
drhc926afb2002-06-20 03:38:26 +00001395 }else{
dan257c13f2016-11-10 20:14:06 +00001396 assert( nResultCol==pDest->nSdst );
drh53932ce2014-08-29 12:29:39 +00001397 assert( regResult==iParm );
drhec7429a2005-10-06 16:53:14 +00001398 /* The LIMIT clause will jump out of the loop for us */
drhc926afb2002-06-20 03:38:26 +00001399 }
1400 break;
1401 }
danielk197793758c82005-01-21 08:13:14 +00001402#endif /* #ifndef SQLITE_OMIT_SUBQUERY */
drh22827922000-06-06 17:27:05 +00001403
drh81cf13e2014-02-07 18:27:53 +00001404 case SRT_Coroutine: /* Send data to a co-routine */
1405 case SRT_Output: { /* Return the results */
drh373cc2d2009-05-17 02:06:14 +00001406 testcase( eDest==SRT_Coroutine );
1407 testcase( eDest==SRT_Output );
drh079a3072014-03-19 14:10:55 +00001408 if( pSort ){
dan9af90b72016-11-11 18:08:59 +00001409 pushOntoSorter(pParse, pSort, p, regResult, regOrig, nResultCol,
drh5579d592015-08-26 14:01:41 +00001410 nPrefixReg);
drhe00ee6e2008-06-20 15:24:01 +00001411 }else if( eDest==SRT_Coroutine ){
drh2b596da2012-07-23 21:43:19 +00001412 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drhc182d162005-08-14 20:47:16 +00001413 }else{
drh340309f2014-01-22 00:23:49 +00001414 sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
drhac82fcf2002-09-08 17:23:41 +00001415 }
drh142e30d2002-08-28 03:00:58 +00001416 break;
1417 }
1418
drhfe1c6bb2014-01-22 17:28:35 +00001419#ifndef SQLITE_OMIT_CTE
1420 /* Write the results into a priority queue that is order according to
1421 ** pDest->pOrderBy (in pSO). pDest->iSDParm (in iParm) is the cursor for an
1422 ** index with pSO->nExpr+2 columns. Build a key using pSO for the first
1423 ** pSO->nExpr columns, then make sure all keys are unique by adding a
1424 ** final OP_Sequence column. The last column is the record as a blob.
1425 */
1426 case SRT_DistQueue:
1427 case SRT_Queue: {
1428 int nKey;
1429 int r1, r2, r3;
1430 int addrTest = 0;
1431 ExprList *pSO;
1432 pSO = pDest->pOrderBy;
1433 assert( pSO );
1434 nKey = pSO->nExpr;
1435 r1 = sqlite3GetTempReg(pParse);
1436 r2 = sqlite3GetTempRange(pParse, nKey+2);
1437 r3 = r2+nKey+1;
drhfe1c6bb2014-01-22 17:28:35 +00001438 if( eDest==SRT_DistQueue ){
1439 /* If the destination is DistQueue, then cursor (iParm+1) is open
1440 ** on a second ephemeral index that holds all values every previously
drh7e4efae2014-02-26 21:35:31 +00001441 ** added to the queue. */
1442 addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
1443 regResult, nResultCol);
drh688852a2014-02-17 22:40:43 +00001444 VdbeCoverage(v);
drh7e4efae2014-02-26 21:35:31 +00001445 }
1446 sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
1447 if( eDest==SRT_DistQueue ){
drhfe1c6bb2014-01-22 17:28:35 +00001448 sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
dancfe24582014-01-22 19:23:30 +00001449 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
drhfe1c6bb2014-01-22 17:28:35 +00001450 }
1451 for(i=0; i<nKey; i++){
1452 sqlite3VdbeAddOp2(v, OP_SCopy,
1453 regResult + pSO->a[i].u.x.iOrderByCol - 1,
1454 r2+i);
1455 }
1456 sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
1457 sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
drh9b4eaeb2016-11-09 00:10:33 +00001458 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, r2, nKey+2);
drhfe1c6bb2014-01-22 17:28:35 +00001459 if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
1460 sqlite3ReleaseTempReg(pParse, r1);
1461 sqlite3ReleaseTempRange(pParse, r2, nKey+2);
1462 break;
1463 }
1464#endif /* SQLITE_OMIT_CTE */
1465
1466
1467
danielk19776a67fe82005-02-04 04:07:16 +00001468#if !defined(SQLITE_OMIT_TRIGGER)
drhc926afb2002-06-20 03:38:26 +00001469 /* Discard the results. This is used for SELECT statements inside
1470 ** the body of a TRIGGER. The purpose of such selects is to call
1471 ** user-defined functions that have side effects. We do not care
1472 ** about the actual results of the select.
1473 */
drhc926afb2002-06-20 03:38:26 +00001474 default: {
drhf46f9052002-06-22 02:33:38 +00001475 assert( eDest==SRT_Discard );
drhc926afb2002-06-20 03:38:26 +00001476 break;
1477 }
danielk197793758c82005-01-21 08:13:14 +00001478#endif
drh82c3d632000-06-06 21:56:07 +00001479 }
drhec7429a2005-10-06 16:53:14 +00001480
drh5e87be82010-10-06 18:55:37 +00001481 /* Jump to the end of the loop if the LIMIT is reached. Except, if
1482 ** there is a sorter, in which case the sorter has already limited
1483 ** the output for us.
drhec7429a2005-10-06 16:53:14 +00001484 */
drh079a3072014-03-19 14:10:55 +00001485 if( pSort==0 && p->iLimit ){
drh16897072015-03-07 00:57:37 +00001486 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
drhec7429a2005-10-06 16:53:14 +00001487 }
drh82c3d632000-06-06 21:56:07 +00001488}
1489
1490/*
drhad124322013-10-23 13:30:58 +00001491** Allocate a KeyInfo object sufficient for an index of N key columns and
1492** X extra columns.
drh323df792013-08-05 19:11:29 +00001493*/
drhad124322013-10-23 13:30:58 +00001494KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
drhd4ab0032017-05-31 13:45:59 +00001495 int nExtra = (N+X)*(sizeof(CollSeq*)+1) - sizeof(CollSeq*);
drhd8e4b132016-10-01 19:21:56 +00001496 KeyInfo *p = sqlite3DbMallocRawNN(db, sizeof(KeyInfo) + nExtra);
drh323df792013-08-05 19:11:29 +00001497 if( p ){
dan6e118922019-08-12 16:36:38 +00001498 p->aSortFlags = (u8*)&p->aColl[N+X];
drha485ad12017-08-02 22:43:14 +00001499 p->nKeyField = (u16)N;
1500 p->nAllField = (u16)(N+X);
drh323df792013-08-05 19:11:29 +00001501 p->enc = ENC(db);
1502 p->db = db;
drh2ec2fb22013-11-06 19:59:23 +00001503 p->nRef = 1;
drhc263f7c2016-01-18 13:18:54 +00001504 memset(&p[1], 0, nExtra);
drh2ec2fb22013-11-06 19:59:23 +00001505 }else{
drh3cdb1392022-01-24 12:48:54 +00001506 return (KeyInfo*)sqlite3OomFault(db);
drh323df792013-08-05 19:11:29 +00001507 }
1508 return p;
1509}
1510
1511/*
drh2ec2fb22013-11-06 19:59:23 +00001512** Deallocate a KeyInfo object
1513*/
1514void sqlite3KeyInfoUnref(KeyInfo *p){
1515 if( p ){
drh41ce47c2022-08-22 02:00:26 +00001516 assert( p->db!=0 );
drh2ec2fb22013-11-06 19:59:23 +00001517 assert( p->nRef>0 );
drh2ec2fb22013-11-06 19:59:23 +00001518 p->nRef--;
drh41ce47c2022-08-22 02:00:26 +00001519 if( p->nRef==0 ) sqlite3DbNNFreeNN(p->db, p);
drh2ec2fb22013-11-06 19:59:23 +00001520 }
1521}
1522
1523/*
1524** Make a new pointer to a KeyInfo object
1525*/
1526KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
1527 if( p ){
1528 assert( p->nRef>0 );
1529 p->nRef++;
1530 }
1531 return p;
1532}
1533
1534#ifdef SQLITE_DEBUG
1535/*
1536** Return TRUE if a KeyInfo object can be change. The KeyInfo object
1537** can only be changed if this is just a single reference to the object.
1538**
1539** This routine is used only inside of assert() statements.
1540*/
1541int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
1542#endif /* SQLITE_DEBUG */
1543
1544/*
drhdece1a82005-08-31 18:20:00 +00001545** Given an expression list, generate a KeyInfo structure that records
1546** the collating sequence for each expression in that expression list.
1547**
drh0342b1f2005-09-01 03:07:44 +00001548** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
1549** KeyInfo structure is appropriate for initializing a virtual index to
1550** implement that clause. If the ExprList is the result set of a SELECT
1551** then the KeyInfo structure is appropriate for initializing a virtual
1552** index to implement a DISTINCT test.
1553**
peter.d.reid60ec9142014-09-06 16:39:46 +00001554** Space to hold the KeyInfo structure is obtained from malloc. The calling
drhdece1a82005-08-31 18:20:00 +00001555** function is responsible for seeing that this structure is eventually
drh2ec2fb22013-11-06 19:59:23 +00001556** freed.
drhdece1a82005-08-31 18:20:00 +00001557*/
danf9eae182018-05-21 19:45:11 +00001558KeyInfo *sqlite3KeyInfoFromExprList(
drh079a3072014-03-19 14:10:55 +00001559 Parse *pParse, /* Parsing context */
1560 ExprList *pList, /* Form the KeyInfo object from this ExprList */
1561 int iStart, /* Begin with this column of pList */
1562 int nExtra /* Add this many extra columns to the end */
1563){
drhdece1a82005-08-31 18:20:00 +00001564 int nExpr;
1565 KeyInfo *pInfo;
1566 struct ExprList_item *pItem;
drh323df792013-08-05 19:11:29 +00001567 sqlite3 *db = pParse->db;
drhdece1a82005-08-31 18:20:00 +00001568 int i;
1569
1570 nExpr = pList->nExpr;
drh3f39bcf2015-01-19 20:59:34 +00001571 pInfo = sqlite3KeyInfoAlloc(db, nExpr-iStart, nExtra+1);
drhdece1a82005-08-31 18:20:00 +00001572 if( pInfo ){
drh2ec2fb22013-11-06 19:59:23 +00001573 assert( sqlite3KeyInfoIsWriteable(pInfo) );
drh6284db92014-03-19 23:24:49 +00001574 for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
drh70efa842017-09-28 01:58:23 +00001575 pInfo->aColl[i-iStart] = sqlite3ExprNNCollSeq(pParse, pItem->pExpr);
drhd88fd532022-05-02 20:49:30 +00001576 pInfo->aSortFlags[i-iStart] = pItem->fg.sortFlags;
drhdece1a82005-08-31 18:20:00 +00001577 }
1578 }
1579 return pInfo;
1580}
1581
dan7f61e922010-11-11 16:46:40 +00001582/*
1583** Name of the connection operator, used for error messages.
1584*/
drhaae0f742021-03-04 16:03:32 +00001585const char *sqlite3SelectOpName(int id){
dan7f61e922010-11-11 16:46:40 +00001586 char *z;
1587 switch( id ){
1588 case TK_ALL: z = "UNION ALL"; break;
1589 case TK_INTERSECT: z = "INTERSECT"; break;
1590 case TK_EXCEPT: z = "EXCEPT"; break;
1591 default: z = "UNION"; break;
1592 }
1593 return z;
1594}
dan7f61e922010-11-11 16:46:40 +00001595
dan2ce22452010-11-08 19:01:16 +00001596#ifndef SQLITE_OMIT_EXPLAIN
dan17c0bc02010-11-09 17:35:19 +00001597/*
1598** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
1599** is a no-op. Otherwise, it adds a single row of output to the EQP result,
1600** where the caption is of the form:
1601**
1602** "USE TEMP B-TREE FOR xxx"
1603**
1604** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
1605** is determined by the zUsage argument.
1606*/
dan2ce22452010-11-08 19:01:16 +00001607static void explainTempTable(Parse *pParse, const char *zUsage){
drhe2ca99c2018-05-02 00:33:43 +00001608 ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s", zUsage));
dan2ce22452010-11-08 19:01:16 +00001609}
dan17c0bc02010-11-09 17:35:19 +00001610
1611/*
danbb2b4412011-04-06 17:54:31 +00001612** Assign expression b to lvalue a. A second, no-op, version of this macro
1613** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
1614** in sqlite3Select() to assign values to structure member variables that
1615** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
1616** code with #ifndef directives.
1617*/
1618# define explainSetInteger(a, b) a = b
1619
1620#else
1621/* No-op versions of the explainXXX() functions and macros. */
1622# define explainTempTable(y,z)
1623# define explainSetInteger(y,z)
1624#endif
1625
drhdece1a82005-08-31 18:20:00 +00001626
1627/*
drhd8bc7082000-06-07 23:51:50 +00001628** If the inner loop was generated using a non-null pOrderBy argument,
1629** then the results were placed in a sorter. After the loop is terminated
1630** we need to run the sorter and output the results. The following
1631** routine generates the code needed to do that.
1632*/
drhc926afb2002-06-20 03:38:26 +00001633static void generateSortTail(
danielk19776c8c8ce2008-01-02 16:27:09 +00001634 Parse *pParse, /* Parsing context */
1635 Select *p, /* The SELECT statement */
drh079a3072014-03-19 14:10:55 +00001636 SortCtx *pSort, /* Information on the ORDER BY clause */
danielk19776c8c8ce2008-01-02 16:27:09 +00001637 int nColumn, /* Number of columns of data */
1638 SelectDest *pDest /* Write the sorted results here */
drhc926afb2002-06-20 03:38:26 +00001639){
drhddba0c22014-03-18 20:33:42 +00001640 Vdbe *v = pParse->pVdbe; /* The prepared statement */
drha04a8be2016-01-13 17:50:10 +00001641 int addrBreak = pSort->labelDone; /* Jump here to exit loop */
drhec4ccdb2018-12-29 02:26:59 +00001642 int addrContinue = sqlite3VdbeMakeLabel(pParse);/* Jump here for next cycle */
dan24e25d32018-04-14 18:46:20 +00001643 int addr; /* Top of output loop. Jump for Next. */
drh079a3072014-03-19 14:10:55 +00001644 int addrOnce = 0;
drh0342b1f2005-09-01 03:07:44 +00001645 int iTab;
drh079a3072014-03-19 14:10:55 +00001646 ExprList *pOrderBy = pSort->pOrderBy;
danielk19776c8c8ce2008-01-02 16:27:09 +00001647 int eDest = pDest->eDest;
drh2b596da2012-07-23 21:43:19 +00001648 int iParm = pDest->iSDParm;
drh2d401ab2008-01-10 23:50:11 +00001649 int regRow;
1650 int regRowid;
dan257c13f2016-11-10 20:14:06 +00001651 int iCol;
dan24e25d32018-04-14 18:46:20 +00001652 int nKey; /* Number of key columns in sorter record */
drhf45f2322014-03-23 17:45:03 +00001653 int iSortTab; /* Sorter cursor to read from */
drhf45f2322014-03-23 17:45:03 +00001654 int i;
dan78d58432014-03-25 15:04:07 +00001655 int bSeq; /* True if sorter record includes seq. no. */
dan24e25d32018-04-14 18:46:20 +00001656 int nRefKey = 0;
drh70f624c2014-03-24 01:43:50 +00001657 struct ExprList_item *aOutEx = p->pEList->a;
danf6f01f12022-12-03 18:16:25 +00001658#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
1659 int addrExplain; /* Address of OP_Explain instruction */
1660#endif
1661
1662 ExplainQueryPlan2(addrExplain, (pParse, 0,
1663 "USE TEMP B-TREE FOR %sORDER BY", pSort->nOBSat>0?"RIGHT PART OF ":"")
1664 );
dana3d0c152022-12-05 18:19:56 +00001665 sqlite3VdbeScanStatusRange(v, addrExplain,pSort->addrPush,pSort->addrPushEnd);
1666 sqlite3VdbeScanStatusCounters(v, addrExplain, addrExplain, pSort->addrPush);
1667
drh2d401ab2008-01-10 23:50:11 +00001668
drha04a8be2016-01-13 17:50:10 +00001669 assert( addrBreak<0 );
drh079a3072014-03-19 14:10:55 +00001670 if( pSort->labelBkOut ){
1671 sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
drh076e85f2015-09-03 13:46:12 +00001672 sqlite3VdbeGoto(v, addrBreak);
drh079a3072014-03-19 14:10:55 +00001673 sqlite3VdbeResolveLabel(v, pSort->labelBkOut);
drh079a3072014-03-19 14:10:55 +00001674 }
dan24e25d32018-04-14 18:46:20 +00001675
1676#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1677 /* Open any cursors needed for sorter-reference expressions */
1678 for(i=0; i<pSort->nDefer; i++){
1679 Table *pTab = pSort->aDefer[i].pTab;
1680 int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
1681 sqlite3OpenTable(pParse, pSort->aDefer[i].iCsr, iDb, pTab, OP_OpenRead);
1682 nRefKey = MAX(nRefKey, pSort->aDefer[i].nKey);
1683 }
1684#endif
1685
drh079a3072014-03-19 14:10:55 +00001686 iTab = pSort->iECursor;
dan71c57db2016-07-09 20:23:55 +00001687 if( eDest==SRT_Output || eDest==SRT_Coroutine || eDest==SRT_Mem ){
drh8efc6a82022-01-12 20:31:14 +00001688 if( eDest==SRT_Mem && p->iOffset ){
1689 sqlite3VdbeAddOp2(v, OP_Null, 0, pDest->iSdst);
1690 }
drh3e9ca092009-09-08 01:14:48 +00001691 regRowid = 0;
drhf45f2322014-03-23 17:45:03 +00001692 regRow = pDest->iSdst;
drhed24da42016-09-06 14:37:05 +00001693 }else{
dan51d82d12016-08-02 18:50:15 +00001694 regRowid = sqlite3GetTempReg(pParse);
drh375afb82019-01-16 19:26:31 +00001695 if( eDest==SRT_EphemTab || eDest==SRT_Table ){
1696 regRow = sqlite3GetTempReg(pParse);
1697 nColumn = 0;
1698 }else{
1699 regRow = sqlite3GetTempRange(pParse, nColumn);
1700 }
drhcdd536f2006-03-17 00:04:03 +00001701 }
drh079a3072014-03-19 14:10:55 +00001702 nKey = pOrderBy->nExpr - pSort->nOBSat;
1703 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drhc2bb3282011-09-04 01:11:46 +00001704 int regSortOut = ++pParse->nMem;
drhf45f2322014-03-23 17:45:03 +00001705 iSortTab = pParse->nTab++;
drh83553ee2014-03-24 02:20:53 +00001706 if( pSort->labelBkOut ){
drh511f9e82016-09-22 18:53:13 +00001707 addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drh83553ee2014-03-24 02:20:53 +00001708 }
dan24e25d32018-04-14 18:46:20 +00001709 sqlite3VdbeAddOp3(v, OP_OpenPseudo, iSortTab, regSortOut,
1710 nKey+1+nColumn+nRefKey);
drh079a3072014-03-19 14:10:55 +00001711 if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
drhc6aff302011-09-01 15:32:47 +00001712 addr = 1 + sqlite3VdbeAddOp2(v, OP_SorterSort, iTab, addrBreak);
drh688852a2014-02-17 22:40:43 +00001713 VdbeCoverage(v);
drhbffd5c12022-08-04 17:15:00 +00001714 assert( p->iLimit==0 && p->iOffset==0 );
drh6cf4a7d2014-10-13 13:00:58 +00001715 sqlite3VdbeAddOp3(v, OP_SorterData, iTab, regSortOut, iSortTab);
dan78d58432014-03-25 15:04:07 +00001716 bSeq = 0;
drhc6aff302011-09-01 15:32:47 +00001717 }else{
drh688852a2014-02-17 22:40:43 +00001718 addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
drhaa9ce702014-01-22 18:07:04 +00001719 codeOffset(v, p->iOffset, addrContinue);
drhf45f2322014-03-23 17:45:03 +00001720 iSortTab = iTab;
dan78d58432014-03-25 15:04:07 +00001721 bSeq = 1;
drhbffd5c12022-08-04 17:15:00 +00001722 if( p->iOffset>0 ){
1723 sqlite3VdbeAddOp2(v, OP_AddImm, p->iLimit, -1);
1724 }
drhf45f2322014-03-23 17:45:03 +00001725 }
dand6189ea2018-04-11 14:11:53 +00001726 for(i=0, iCol=nKey+bSeq-1; i<nColumn; i++){
dan24e25d32018-04-14 18:46:20 +00001727#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001728 if( aOutEx[i].fg.bSorterRef ) continue;
dan24e25d32018-04-14 18:46:20 +00001729#endif
drh9f895232018-01-24 20:42:42 +00001730 if( aOutEx[i].u.x.iOrderByCol==0 ) iCol++;
1731 }
dan24e25d32018-04-14 18:46:20 +00001732#ifdef SQLITE_ENABLE_SORTER_REFERENCES
1733 if( pSort->nDefer ){
1734 int iKey = iCol+1;
1735 int regKey = sqlite3GetTempRange(pParse, nRefKey);
1736
1737 for(i=0; i<pSort->nDefer; i++){
1738 int iCsr = pSort->aDefer[i].iCsr;
1739 Table *pTab = pSort->aDefer[i].pTab;
1740 int nKey = pSort->aDefer[i].nKey;
1741
1742 sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1743 if( HasRowid(pTab) ){
1744 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey);
1745 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCsr,
1746 sqlite3VdbeCurrentAddr(v)+1, regKey);
1747 }else{
dan24e25d32018-04-14 18:46:20 +00001748 int k;
1749 int iJmp;
drh7590d092018-04-18 14:04:19 +00001750 assert( sqlite3PrimaryKeyIndex(pTab)->nKeyCol==nKey );
dan24e25d32018-04-14 18:46:20 +00001751 for(k=0; k<nKey; k++){
1752 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey+k);
1753 }
1754 iJmp = sqlite3VdbeCurrentAddr(v);
1755 sqlite3VdbeAddOp4Int(v, OP_SeekGE, iCsr, iJmp+2, regKey, nKey);
1756 sqlite3VdbeAddOp4Int(v, OP_IdxLE, iCsr, iJmp+3, regKey, nKey);
1757 sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1758 }
dan257c13f2016-11-10 20:14:06 +00001759 }
dan24e25d32018-04-14 18:46:20 +00001760 sqlite3ReleaseTempRange(pParse, regKey, nRefKey);
1761 }
1762#endif
1763 for(i=nColumn-1; i>=0; i--){
1764#ifdef SQLITE_ENABLE_SORTER_REFERENCES
drhd88fd532022-05-02 20:49:30 +00001765 if( aOutEx[i].fg.bSorterRef ){
dan24e25d32018-04-14 18:46:20 +00001766 sqlite3ExprCode(pParse, aOutEx[i].pExpr, regRow+i);
1767 }else
1768#endif
1769 {
1770 int iRead;
1771 if( aOutEx[i].u.x.iOrderByCol ){
1772 iRead = aOutEx[i].u.x.iOrderByCol-1;
1773 }else{
1774 iRead = iCol--;
1775 }
1776 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iRead, regRow+i);
drhcbb9da32019-12-12 22:11:33 +00001777 VdbeComment((v, "%s", aOutEx[i].zEName));
dan24e25d32018-04-14 18:46:20 +00001778 }
drhc6aff302011-09-01 15:32:47 +00001779 }
danf6f01f12022-12-03 18:16:25 +00001780 sqlite3VdbeScanStatusRange(v, addrExplain, addrExplain, -1);
drhc926afb2002-06-20 03:38:26 +00001781 switch( eDest ){
danac56ab72017-01-05 17:23:11 +00001782 case SRT_Table:
drhb9bb7c12006-06-11 23:41:55 +00001783 case SRT_EphemTab: {
drh375afb82019-01-16 19:26:31 +00001784 sqlite3VdbeAddOp3(v, OP_Column, iSortTab, nKey+bSeq, regRow);
drh2d401ab2008-01-10 23:50:11 +00001785 sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
1786 sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
1787 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
drhc926afb2002-06-20 03:38:26 +00001788 break;
1789 }
danielk197793758c82005-01-21 08:13:14 +00001790#ifndef SQLITE_OMIT_SUBQUERY
drhc926afb2002-06-20 03:38:26 +00001791 case SRT_Set: {
dan71c57db2016-07-09 20:23:55 +00001792 assert( nColumn==sqlite3Strlen30(pDest->zAffSdst) );
1793 sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, nColumn, regRowid,
dan553168c2016-08-01 20:14:31 +00001794 pDest->zAffSdst, nColumn);
drh9b4eaeb2016-11-09 00:10:33 +00001795 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, regRowid, regRow, nColumn);
drhc926afb2002-06-20 03:38:26 +00001796 break;
1797 }
1798 case SRT_Mem: {
drhec7429a2005-10-06 16:53:14 +00001799 /* The LIMIT clause will terminate the loop for us */
drhc926afb2002-06-20 03:38:26 +00001800 break;
1801 }
danielk197793758c82005-01-21 08:13:14 +00001802#endif
danf2972b62020-04-29 20:11:01 +00001803 case SRT_Upfrom: {
1804 int i2 = pDest->iSDParm2;
1805 int r1 = sqlite3GetTempReg(pParse);
1806 sqlite3VdbeAddOp3(v, OP_MakeRecord,regRow+(i2<0),nColumn-(i2<0),r1);
1807 if( i2<0 ){
1808 sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regRow);
1809 }else{
1810 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regRow, i2);
1811 }
1812 break;
1813 }
drh373cc2d2009-05-17 02:06:14 +00001814 default: {
drh373cc2d2009-05-17 02:06:14 +00001815 assert( eDest==SRT_Output || eDest==SRT_Coroutine );
drh1c767f02009-01-09 02:49:31 +00001816 testcase( eDest==SRT_Output );
1817 testcase( eDest==SRT_Coroutine );
drh7d10d5a2008-08-20 16:35:10 +00001818 if( eDest==SRT_Output ){
drh2b596da2012-07-23 21:43:19 +00001819 sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
drha9671a22008-07-08 23:40:20 +00001820 }else{
drh2b596da2012-07-23 21:43:19 +00001821 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drhce665cf2004-05-21 03:01:58 +00001822 }
drhac82fcf2002-09-08 17:23:41 +00001823 break;
1824 }
drhc926afb2002-06-20 03:38:26 +00001825 }
drhf45f2322014-03-23 17:45:03 +00001826 if( regRowid ){
dan51d82d12016-08-02 18:50:15 +00001827 if( eDest==SRT_Set ){
1828 sqlite3ReleaseTempRange(pParse, regRow, nColumn);
1829 }else{
1830 sqlite3ReleaseTempReg(pParse, regRow);
1831 }
drhf45f2322014-03-23 17:45:03 +00001832 sqlite3ReleaseTempReg(pParse, regRowid);
1833 }
drhec7429a2005-10-06 16:53:14 +00001834 /* The bottom of the loop
1835 */
drhdc5ea5c2008-12-10 17:19:59 +00001836 sqlite3VdbeResolveLabel(v, addrContinue);
drh079a3072014-03-19 14:10:55 +00001837 if( pSort->sortFlags & SORTFLAG_UseSorter ){
drh688852a2014-02-17 22:40:43 +00001838 sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
drhc6aff302011-09-01 15:32:47 +00001839 }else{
drh688852a2014-02-17 22:40:43 +00001840 sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
drhc6aff302011-09-01 15:32:47 +00001841 }
danf6f01f12022-12-03 18:16:25 +00001842 sqlite3VdbeScanStatusRange(v, addrExplain, sqlite3VdbeCurrentAddr(v)-1, -1);
drh079a3072014-03-19 14:10:55 +00001843 if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
drhdc5ea5c2008-12-10 17:19:59 +00001844 sqlite3VdbeResolveLabel(v, addrBreak);
drhd8bc7082000-06-07 23:51:50 +00001845}
1846
1847/*
danielk1977517eb642004-06-07 10:00:31 +00001848** Return a pointer to a string containing the 'declaration type' of the
1849** expression pExpr. The string may be treated as static by the caller.
drhe78e8282003-01-19 03:59:45 +00001850**
danielk1977955de522006-02-10 02:27:42 +00001851** The declaration type is the exact datatype definition extracted from the
1852** original CREATE TABLE statement if the expression is a column. The
1853** declaration type for a ROWID field is INTEGER. Exactly when an expression
1854** is considered a column can be complex in the presence of subqueries. The
1855** result-set expression in all of the following SELECT statements is
1856** considered a column by this function.
1857**
1858** SELECT col FROM tbl;
1859** SELECT (SELECT col FROM tbl;
1860** SELECT (SELECT col FROM tbl);
1861** SELECT abc FROM (SELECT col AS abc FROM tbl);
danielk1977517eb642004-06-07 10:00:31 +00001862**
danielk1977955de522006-02-10 02:27:42 +00001863** The declaration type for any expression other than a column is NULL.
drh5f3e5e72013-10-08 20:01:35 +00001864**
1865** This routine has either 3 or 6 parameters depending on whether or not
1866** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
danielk1977517eb642004-06-07 10:00:31 +00001867*/
drh5f3e5e72013-10-08 20:01:35 +00001868#ifdef SQLITE_ENABLE_COLUMN_METADATA
drhcafc2f72017-10-03 03:01:09 +00001869# define columnType(A,B,C,D,E) columnTypeImpl(A,B,C,D,E)
drhb121dd12015-06-06 18:30:17 +00001870#else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
drhcafc2f72017-10-03 03:01:09 +00001871# define columnType(A,B,C,D,E) columnTypeImpl(A,B)
drhb121dd12015-06-06 18:30:17 +00001872#endif
drh5f3e5e72013-10-08 20:01:35 +00001873static const char *columnTypeImpl(
danielk1977955de522006-02-10 02:27:42 +00001874 NameContext *pNC,
drhcafc2f72017-10-03 03:01:09 +00001875#ifndef SQLITE_ENABLE_COLUMN_METADATA
1876 Expr *pExpr
1877#else
danielk1977955de522006-02-10 02:27:42 +00001878 Expr *pExpr,
drh5f3e5e72013-10-08 20:01:35 +00001879 const char **pzOrigDb,
1880 const char **pzOrigTab,
drhcafc2f72017-10-03 03:01:09 +00001881 const char **pzOrigCol
drhb121dd12015-06-06 18:30:17 +00001882#endif
danielk1977955de522006-02-10 02:27:42 +00001883){
1884 char const *zType = 0;
danielk1977517eb642004-06-07 10:00:31 +00001885 int j;
drhb121dd12015-06-06 18:30:17 +00001886#ifdef SQLITE_ENABLE_COLUMN_METADATA
1887 char const *zOrigDb = 0;
1888 char const *zOrigTab = 0;
1889 char const *zOrigCol = 0;
1890#endif
danielk19775338a5f2005-01-20 13:03:10 +00001891
drhf7ce4292015-12-02 19:46:12 +00001892 assert( pExpr!=0 );
1893 assert( pNC->pSrcList!=0 );
danielk197700e279d2004-06-21 07:36:32 +00001894 switch( pExpr->op ){
1895 case TK_COLUMN: {
danielk1977955de522006-02-10 02:27:42 +00001896 /* The expression is a column. Locate the table the column is being
1897 ** extracted from in NameContext.pSrcList. This table may be real
1898 ** database table or a subquery.
1899 */
1900 Table *pTab = 0; /* Table structure column is extracted from */
1901 Select *pS = 0; /* Select the column is extracted from */
1902 int iCol = pExpr->iColumn; /* Index of column in pTab */
drh706631d2023-01-10 19:57:26 +00001903 while( pNC && !pTab ){
danielk1977b3bce662005-01-29 08:32:43 +00001904 SrcList *pTabList = pNC->pSrcList;
1905 for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
1906 if( j<pTabList->nSrc ){
1907 pTab = pTabList->a[j].pTab;
danielk1977955de522006-02-10 02:27:42 +00001908 pS = pTabList->a[j].pSelect;
danielk1977b3bce662005-01-29 08:32:43 +00001909 }else{
1910 pNC = pNC->pNext;
1911 }
1912 }
danielk1977955de522006-02-10 02:27:42 +00001913
drh706631d2023-01-10 19:57:26 +00001914 if( pTab==0 ){
drh417168a2009-09-07 18:14:02 +00001915 /* At one time, code such as "SELECT new.x" within a trigger would
1916 ** cause this condition to run. Since then, we have restructured how
1917 ** trigger code is generated and so this condition is no longer
dan43bc88b2009-09-10 10:15:59 +00001918 ** possible. However, it can still be true for statements like
1919 ** the following:
1920 **
1921 ** CREATE TABLE t1(col INTEGER);
1922 ** SELECT (SELECT t1.col) FROM FROM t1;
1923 **
1924 ** when columnType() is called on the expression "t1.col" in the
1925 ** sub-select. In this case, set the column type to NULL, even
1926 ** though it should really be "INTEGER".
1927 **
1928 ** This is not a problem, as the column type of "t1.col" is never
1929 ** used. When columnType() is called on the expression
1930 ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
1931 ** branch below. */
drh7e627792005-04-29 02:10:00 +00001932 break;
1933 }
danielk1977955de522006-02-10 02:27:42 +00001934
drh477572b2021-10-07 20:46:29 +00001935 assert( pTab && ExprUseYTab(pExpr) && pExpr->y.pTab==pTab );
danielk1977955de522006-02-10 02:27:42 +00001936 if( pS ){
1937 /* The "table" is actually a sub-select or a view in the FROM clause
1938 ** of the SELECT statement. Return the declaration type and origin
1939 ** data for the result-set column of the sub-select.
1940 */
drh6e5020e2021-04-07 15:45:01 +00001941 if( iCol<pS->pEList->nExpr
1942#ifdef SQLITE_ALLOW_ROWID_IN_VIEW
1943 && iCol>=0
1944#else
1945 && ALWAYS(iCol>=0)
1946#endif
1947 ){
danielk1977955de522006-02-10 02:27:42 +00001948 /* If iCol is less than zero, then the expression requests the
1949 ** rowid of the sub-select or view. This expression is legal (see
1950 ** test case misc2.2.2) - it always evaluates to NULL.
1951 */
1952 NameContext sNC;
1953 Expr *p = pS->pEList->a[iCol].pExpr;
1954 sNC.pSrcList = pS->pSrc;
dan43bc88b2009-09-10 10:15:59 +00001955 sNC.pNext = pNC;
danielk1977955de522006-02-10 02:27:42 +00001956 sNC.pParse = pNC->pParse;
drhcafc2f72017-10-03 03:01:09 +00001957 zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol);
danielk1977955de522006-02-10 02:27:42 +00001958 }
drha78d7572017-10-03 16:57:33 +00001959 }else{
1960 /* A real table or a CTE table */
danielk1977955de522006-02-10 02:27:42 +00001961 assert( !pS );
drh5f3e5e72013-10-08 20:01:35 +00001962#ifdef SQLITE_ENABLE_COLUMN_METADATA
drha78d7572017-10-03 16:57:33 +00001963 if( iCol<0 ) iCol = pTab->iPKey;
1964 assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
danielk1977955de522006-02-10 02:27:42 +00001965 if( iCol<0 ){
1966 zType = "INTEGER";
drh5f3e5e72013-10-08 20:01:35 +00001967 zOrigCol = "rowid";
danielk1977955de522006-02-10 02:27:42 +00001968 }else{
drhcf9d36d2021-08-02 18:03:43 +00001969 zOrigCol = pTab->aCol[iCol].zCnName;
drhd7564862016-03-22 20:05:09 +00001970 zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
danielk1977955de522006-02-10 02:27:42 +00001971 }
drh5f3e5e72013-10-08 20:01:35 +00001972 zOrigTab = pTab->zName;
drha78d7572017-10-03 16:57:33 +00001973 if( pNC->pParse && pTab->pSchema ){
danielk1977955de522006-02-10 02:27:42 +00001974 int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
drhe59be012016-08-18 20:56:39 +00001975 zOrigDb = pNC->pParse->db->aDb[iDb].zDbSName;
danielk1977955de522006-02-10 02:27:42 +00001976 }
drh5f3e5e72013-10-08 20:01:35 +00001977#else
drha78d7572017-10-03 16:57:33 +00001978 assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
drh5f3e5e72013-10-08 20:01:35 +00001979 if( iCol<0 ){
1980 zType = "INTEGER";
1981 }else{
drhd7564862016-03-22 20:05:09 +00001982 zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
drh5f3e5e72013-10-08 20:01:35 +00001983 }
1984#endif
danielk197700e279d2004-06-21 07:36:32 +00001985 }
1986 break;
danielk1977517eb642004-06-07 10:00:31 +00001987 }
danielk197793758c82005-01-21 08:13:14 +00001988#ifndef SQLITE_OMIT_SUBQUERY
danielk197700e279d2004-06-21 07:36:32 +00001989 case TK_SELECT: {
danielk1977955de522006-02-10 02:27:42 +00001990 /* The expression is a sub-select. Return the declaration type and
1991 ** origin info for the single column in the result set of the SELECT
1992 ** statement.
1993 */
danielk1977b3bce662005-01-29 08:32:43 +00001994 NameContext sNC;
drha4eeccd2021-10-07 17:43:30 +00001995 Select *pS;
1996 Expr *p;
1997 assert( ExprUseXSelect(pExpr) );
1998 pS = pExpr->x.pSelect;
1999 p = pS->pEList->a[0].pExpr;
danielk1977955de522006-02-10 02:27:42 +00002000 sNC.pSrcList = pS->pSrc;
danielk1977b3bce662005-01-29 08:32:43 +00002001 sNC.pNext = pNC;
danielk1977955de522006-02-10 02:27:42 +00002002 sNC.pParse = pNC->pParse;
drhcafc2f72017-10-03 03:01:09 +00002003 zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
danielk197700e279d2004-06-21 07:36:32 +00002004 break;
danielk1977517eb642004-06-07 10:00:31 +00002005 }
danielk197793758c82005-01-21 08:13:14 +00002006#endif
danielk1977517eb642004-06-07 10:00:31 +00002007 }
drh5f3e5e72013-10-08 20:01:35 +00002008
2009#ifdef SQLITE_ENABLE_COLUMN_METADATA
2010 if( pzOrigDb ){
2011 assert( pzOrigTab && pzOrigCol );
2012 *pzOrigDb = zOrigDb;
2013 *pzOrigTab = zOrigTab;
2014 *pzOrigCol = zOrigCol;
danielk1977955de522006-02-10 02:27:42 +00002015 }
drh5f3e5e72013-10-08 20:01:35 +00002016#endif
danielk1977517eb642004-06-07 10:00:31 +00002017 return zType;
2018}
2019
2020/*
2021** Generate code that will tell the VDBE the declaration types of columns
2022** in the result set.
drhfcb78a42003-01-18 20:11:05 +00002023*/
2024static void generateColumnTypes(
2025 Parse *pParse, /* Parser context */
drhfcb78a42003-01-18 20:11:05 +00002026 SrcList *pTabList, /* List of tables */
2027 ExprList *pEList /* Expressions defining the result set */
2028){
drh3f913572008-03-22 01:07:17 +00002029#ifndef SQLITE_OMIT_DECLTYPE
drhfcb78a42003-01-18 20:11:05 +00002030 Vdbe *v = pParse->pVdbe;
danielk1977517eb642004-06-07 10:00:31 +00002031 int i;
danielk1977b3bce662005-01-29 08:32:43 +00002032 NameContext sNC;
2033 sNC.pSrcList = pTabList;
danielk1977955de522006-02-10 02:27:42 +00002034 sNC.pParse = pParse;
drheac5fc02017-04-11 01:01:27 +00002035 sNC.pNext = 0;
drhfcb78a42003-01-18 20:11:05 +00002036 for(i=0; i<pEList->nExpr; i++){
2037 Expr *p = pEList->a[i].pExpr;
drh3f913572008-03-22 01:07:17 +00002038 const char *zType;
2039#ifdef SQLITE_ENABLE_COLUMN_METADATA
danielk1977955de522006-02-10 02:27:42 +00002040 const char *zOrigDb = 0;
2041 const char *zOrigTab = 0;
2042 const char *zOrigCol = 0;
drhcafc2f72017-10-03 03:01:09 +00002043 zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
danielk1977955de522006-02-10 02:27:42 +00002044
drh85b623f2007-12-13 21:54:09 +00002045 /* The vdbe must make its own copy of the column-type and other
danielk19774b1ae992006-02-10 03:06:10 +00002046 ** column specific strings, in case the schema is reset before this
2047 ** virtual machine is deleted.
danielk1977fbcd5852004-06-15 02:44:18 +00002048 */
danielk197710fb7492008-10-31 10:53:22 +00002049 sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
2050 sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
2051 sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
drh3f913572008-03-22 01:07:17 +00002052#else
drhcafc2f72017-10-03 03:01:09 +00002053 zType = columnType(&sNC, p, 0, 0, 0);
drh3f913572008-03-22 01:07:17 +00002054#endif
danielk197710fb7492008-10-31 10:53:22 +00002055 sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
drhfcb78a42003-01-18 20:11:05 +00002056 }
drh5f3e5e72013-10-08 20:01:35 +00002057#endif /* !defined(SQLITE_OMIT_DECLTYPE) */
drhfcb78a42003-01-18 20:11:05 +00002058}
2059
drheac5fc02017-04-11 01:01:27 +00002060
2061/*
drhec360a82017-07-12 14:10:19 +00002062** Compute the column names for a SELECT statement.
2063**
2064** The only guarantee that SQLite makes about column names is that if the
2065** column has an AS clause assigning it a name, that will be the name used.
2066** That is the only documented guarantee. However, countless applications
2067** developed over the years have made baseless assumptions about column names
2068** and will break if those assumptions changes. Hence, use extreme caution
2069** when modifying this routine to avoid breaking legacy.
2070**
2071** See Also: sqlite3ColumnsFromExprList()
2072**
2073** The PRAGMA short_column_names and PRAGMA full_column_names settings are
2074** deprecated. The default setting is short=ON, full=OFF. 99.9% of all
2075** applications should operate this way. Nevertheless, we need to support the
2076** other modes for legacy:
2077**
2078** short=OFF, full=OFF: Column name is the text of the expression has it
2079** originally appears in the SELECT statement. In
2080** other words, the zSpan of the result expression.
2081**
2082** short=ON, full=OFF: (This is the default setting). If the result
drh3d240d22017-09-28 16:56:55 +00002083** refers directly to a table column, then the
2084** result column name is just the table column
2085** name: COLUMN. Otherwise use zSpan.
drhec360a82017-07-12 14:10:19 +00002086**
2087** full=ON, short=ANY: If the result refers directly to a table column,
2088** then the result column name with the table name
2089** prefix, ex: TABLE.COLUMN. Otherwise use zSpan.
drh82c3d632000-06-06 21:56:07 +00002090*/
drh90881862021-05-19 12:17:03 +00002091void sqlite3GenerateColumnNames(
drh832508b2002-03-02 17:04:07 +00002092 Parse *pParse, /* Parser context */
drhf35f2f92017-07-29 16:01:55 +00002093 Select *pSelect /* Generate column names for this SELECT statement */
drh832508b2002-03-02 17:04:07 +00002094){
drhd8bc7082000-06-07 23:51:50 +00002095 Vdbe *v = pParse->pVdbe;
drheac5fc02017-04-11 01:01:27 +00002096 int i;
2097 Table *pTab;
drhf35f2f92017-07-29 16:01:55 +00002098 SrcList *pTabList;
2099 ExprList *pEList;
drh9bb575f2004-09-06 17:24:11 +00002100 sqlite3 *db = pParse->db;
drhf35f2f92017-07-29 16:01:55 +00002101 int fullName; /* TABLE.COLUMN if no AS clause and is a direct table ref */
2102 int srcName; /* COLUMN or TABLE.COLUMN if no AS clause and is direct */
drhfcabd462004-02-20 14:50:58 +00002103
drhfe2093d2005-01-20 22:48:47 +00002104#ifndef SQLITE_OMIT_EXPLAIN
danielk19773cf86062004-05-26 10:11:05 +00002105 /* If this is an EXPLAIN, skip this step */
2106 if( pParse->explain ){
danielk197761de0d12004-05-27 23:56:16 +00002107 return;
danielk19773cf86062004-05-26 10:11:05 +00002108 }
danielk19775338a5f2005-01-20 13:03:10 +00002109#endif
danielk19773cf86062004-05-26 10:11:05 +00002110
drh5e8b9852018-05-03 22:52:56 +00002111 if( pParse->colNamesSet ) return;
drhf35f2f92017-07-29 16:01:55 +00002112 /* Column names are determined by the left-most term of a compound select */
2113 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh5d7aef12022-11-22 19:49:16 +00002114 TREETRACE(0x80,pParse,pSelect,("generating column names\n"));
drhf35f2f92017-07-29 16:01:55 +00002115 pTabList = pSelect->pSrc;
2116 pEList = pSelect->pEList;
drh98029472015-12-03 21:47:30 +00002117 assert( v!=0 );
drhf7ce4292015-12-02 19:46:12 +00002118 assert( pTabList!=0 );
drhd8bc7082000-06-07 23:51:50 +00002119 pParse->colNamesSet = 1;
drhec360a82017-07-12 14:10:19 +00002120 fullName = (db->flags & SQLITE_FullColNames)!=0;
2121 srcName = (db->flags & SQLITE_ShortColNames)!=0 || fullName;
danielk197722322fd2004-05-25 23:35:17 +00002122 sqlite3VdbeSetNumCols(v, pEList->nExpr);
drh82c3d632000-06-06 21:56:07 +00002123 for(i=0; i<pEList->nExpr; i++){
drhec360a82017-07-12 14:10:19 +00002124 Expr *p = pEList->a[i].pExpr;
2125
2126 assert( p!=0 );
drh4dd89d52017-08-14 14:53:24 +00002127 assert( p->op!=TK_AGG_COLUMN ); /* Agg processing has not run yet */
drh477572b2021-10-07 20:46:29 +00002128 assert( p->op!=TK_COLUMN
2129 || (ExprUseYTab(p) && p->y.pTab!=0) ); /* Covering idx not yet coded */
drhd88fd532022-05-02 20:49:30 +00002130 if( pEList->a[i].zEName && pEList->a[i].fg.eEName==ENAME_NAME ){
drhec360a82017-07-12 14:10:19 +00002131 /* An AS clause always takes first priority */
drh41cee662019-12-12 20:22:34 +00002132 char *zName = pEList->a[i].zEName;
danielk197710fb7492008-10-31 10:53:22 +00002133 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
drhf35f2f92017-07-29 16:01:55 +00002134 }else if( srcName && p->op==TK_COLUMN ){
drh97665872002-02-13 23:22:53 +00002135 char *zCol;
drh8aff1012001-12-22 14:49:24 +00002136 int iCol = p->iColumn;
drheda079c2018-09-20 19:02:15 +00002137 pTab = p->y.pTab;
drhf35f2f92017-07-29 16:01:55 +00002138 assert( pTab!=0 );
drh8aff1012001-12-22 14:49:24 +00002139 if( iCol<0 ) iCol = pTab->iPKey;
drh97665872002-02-13 23:22:53 +00002140 assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
drhb1363202002-06-26 02:45:03 +00002141 if( iCol<0 ){
drh47a6db22005-01-18 16:02:40 +00002142 zCol = "rowid";
drhb1363202002-06-26 02:45:03 +00002143 }else{
drhcf9d36d2021-08-02 18:03:43 +00002144 zCol = pTab->aCol[iCol].zCnName;
drhb1363202002-06-26 02:45:03 +00002145 }
drhec360a82017-07-12 14:10:19 +00002146 if( fullName ){
drh82c3d632000-06-06 21:56:07 +00002147 char *zName = 0;
drh1c767f02009-01-09 02:49:31 +00002148 zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
danielk197710fb7492008-10-31 10:53:22 +00002149 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
drh82c3d632000-06-06 21:56:07 +00002150 }else{
danielk197710fb7492008-10-31 10:53:22 +00002151 sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
drh82c3d632000-06-06 21:56:07 +00002152 }
drh1bee3d72001-10-15 00:44:35 +00002153 }else{
drhcbb9da32019-12-12 22:11:33 +00002154 const char *z = pEList->a[i].zEName;
drh859bc542014-01-13 20:32:18 +00002155 z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
2156 sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
drh82c3d632000-06-06 21:56:07 +00002157 }
2158 }
danielk197776d505b2004-05-28 13:13:02 +00002159 generateColumnTypes(pParse, pTabList, pEList);
drh82c3d632000-06-06 21:56:07 +00002160}
2161
drhd8bc7082000-06-07 23:51:50 +00002162/*
peter.d.reid60ec9142014-09-06 16:39:46 +00002163** Given an expression list (which is really the list of expressions
drh7d10d5a2008-08-20 16:35:10 +00002164** that form the result set of a SELECT statement) compute appropriate
2165** column names for a table that would hold the expression list.
2166**
2167** All column names will be unique.
2168**
2169** Only the column names are computed. Column.zType, Column.zColl,
2170** and other fields of Column are zeroed.
2171**
2172** Return SQLITE_OK on success. If a memory allocation error occurs,
2173** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
drhec360a82017-07-12 14:10:19 +00002174**
2175** The only guarantee that SQLite makes about column names is that if the
2176** column has an AS clause assigning it a name, that will be the name used.
2177** That is the only documented guarantee. However, countless applications
2178** developed over the years have made baseless assumptions about column names
2179** and will break if those assumptions changes. Hence, use extreme caution
2180** when modifying this routine to avoid breaking legacy.
2181**
drh90881862021-05-19 12:17:03 +00002182** See Also: sqlite3GenerateColumnNames()
drh315555c2002-10-20 15:53:03 +00002183*/
drh8981b902015-08-24 17:42:49 +00002184int sqlite3ColumnsFromExprList(
drh7d10d5a2008-08-20 16:35:10 +00002185 Parse *pParse, /* Parsing context */
2186 ExprList *pEList, /* Expr list from which to derive column names */
drhd815f172012-09-13 14:42:43 +00002187 i16 *pnCol, /* Write the number of columns here */
drh7d10d5a2008-08-20 16:35:10 +00002188 Column **paCol /* Write the new column list here */
2189){
drhdc5ea5c2008-12-10 17:19:59 +00002190 sqlite3 *db = pParse->db; /* Database connection */
2191 int i, j; /* Loop counters */
drhebed3fa2015-11-14 16:47:23 +00002192 u32 cnt; /* Index added to make the name unique */
drhdc5ea5c2008-12-10 17:19:59 +00002193 Column *aCol, *pCol; /* For looping over result columns */
2194 int nCol; /* Number of columns in the result set */
drhdc5ea5c2008-12-10 17:19:59 +00002195 char *zName; /* Column name */
2196 int nName; /* Size of name in zName[] */
drh0315e3c2015-11-14 20:52:43 +00002197 Hash ht; /* Hash table of column names */
drh6d5ab2a2020-11-02 00:40:05 +00002198 Table *pTab;
drh22f70c32002-02-18 01:17:00 +00002199
drh0315e3c2015-11-14 20:52:43 +00002200 sqlite3HashInit(&ht);
dan8c2e0f02012-03-31 15:08:56 +00002201 if( pEList ){
2202 nCol = pEList->nExpr;
2203 aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
2204 testcase( aCol==0 );
drh080fe6d2021-03-18 20:04:46 +00002205 if( NEVER(nCol>32767) ) nCol = 32767;
dan8c2e0f02012-03-31 15:08:56 +00002206 }else{
2207 nCol = 0;
2208 aCol = 0;
2209 }
dan8836cbb2015-11-21 19:43:29 +00002210 assert( nCol==(i16)nCol );
dan8c2e0f02012-03-31 15:08:56 +00002211 *pnCol = nCol;
2212 *paCol = aCol;
2213
drhf84cbd12023-01-12 13:25:48 +00002214 for(i=0, pCol=aCol; i<nCol && !pParse->nErr; i++, pCol++){
drh18f86002022-04-21 13:11:26 +00002215 struct ExprList_item *pX = &pEList->a[i];
drh45e41b72022-04-22 23:18:21 +00002216 struct ExprList_item *pCollide;
drh79d5f632005-01-18 17:20:10 +00002217 /* Get an appropriate name for the column
2218 */
drhd88fd532022-05-02 20:49:30 +00002219 if( (zName = pX->zEName)!=0 && pX->fg.eEName==ENAME_NAME ){
drh79d5f632005-01-18 17:20:10 +00002220 /* If the column contains an "AS <name>" phrase, use <name> as the name */
drh93a960a2008-07-10 00:32:42 +00002221 }else{
drh18f86002022-04-21 13:11:26 +00002222 Expr *pColExpr = sqlite3ExprSkipCollateAndLikely(pX->pExpr);
drh235667a2020-11-08 20:44:30 +00002223 while( ALWAYS(pColExpr!=0) && pColExpr->op==TK_DOT ){
drhb07028f2011-10-14 21:49:18 +00002224 pColExpr = pColExpr->pRight;
2225 assert( pColExpr!=0 );
2226 }
drh477572b2021-10-07 20:46:29 +00002227 if( pColExpr->op==TK_COLUMN
2228 && ALWAYS( ExprUseYTab(pColExpr) )
drh5af8a862022-05-27 18:06:49 +00002229 && ALWAYS( pColExpr->y.pTab!=0 )
drh477572b2021-10-07 20:46:29 +00002230 ){
drh7d10d5a2008-08-20 16:35:10 +00002231 /* For columns use the column name name */
drhdc5ea5c2008-12-10 17:19:59 +00002232 int iCol = pColExpr->iColumn;
drh5af8a862022-05-27 18:06:49 +00002233 pTab = pColExpr->y.pTab;
drhf0209f72008-08-21 14:54:28 +00002234 if( iCol<0 ) iCol = pTab->iPKey;
drhcf9d36d2021-08-02 18:03:43 +00002235 zName = iCol>=0 ? pTab->aCol[iCol].zCnName : "rowid";
drhb7916a72009-05-27 10:31:29 +00002236 }else if( pColExpr->op==TK_ID ){
drh33e619f2009-05-28 01:00:55 +00002237 assert( !ExprHasProperty(pColExpr, EP_IntValue) );
drh96ceaf82015-11-14 22:04:22 +00002238 zName = pColExpr->u.zToken;
drh7d10d5a2008-08-20 16:35:10 +00002239 }else{
2240 /* Use the original text of the column expression as its name */
drh18f86002022-04-21 13:11:26 +00002241 assert( zName==pX->zEName ); /* pointer comparison intended */
drh7d10d5a2008-08-20 16:35:10 +00002242 }
drh22f70c32002-02-18 01:17:00 +00002243 }
drh0cbec592020-01-03 02:20:37 +00002244 if( zName && !sqlite3IsTrueOrFalse(zName) ){
drhd7ca6002017-07-09 00:30:58 +00002245 zName = sqlite3DbStrDup(db, zName);
2246 }else{
drh155507b2017-07-09 18:55:29 +00002247 zName = sqlite3MPrintf(db,"column%d",i+1);
drhd7ca6002017-07-09 00:30:58 +00002248 }
drh79d5f632005-01-18 17:20:10 +00002249
2250 /* Make sure the column name is unique. If the name is not unique,
peter.d.reid60ec9142014-09-06 16:39:46 +00002251 ** append an integer to the name so that it becomes unique.
drh79d5f632005-01-18 17:20:10 +00002252 */
drh0315e3c2015-11-14 20:52:43 +00002253 cnt = 0;
drh45e41b72022-04-22 23:18:21 +00002254 while( zName && (pCollide = sqlite3HashFind(&ht, zName))!=0 ){
drhd88fd532022-05-02 20:49:30 +00002255 if( pCollide->fg.bUsingTerm ){
drhab843a52022-04-23 07:29:34 +00002256 pCol->colFlags |= COLFLAG_NOEXPAND;
drh45e41b72022-04-22 23:18:21 +00002257 }
drh0315e3c2015-11-14 20:52:43 +00002258 nName = sqlite3Strlen30(zName);
drhf7ee8962015-11-15 11:13:49 +00002259 if( nName>0 ){
2260 for(j=nName-1; j>0 && sqlite3Isdigit(zName[j]); j--){}
2261 if( zName[j]==':' ) nName = j;
2262 }
drh96ceaf82015-11-14 22:04:22 +00002263 zName = sqlite3MPrintf(db, "%.*z:%u", nName, zName, ++cnt);
drhf84cbd12023-01-12 13:25:48 +00002264 sqlite3ProgressCheck(pParse);
2265 if( cnt>3 ){
2266 sqlite3_randomness(sizeof(cnt), &cnt);
2267 }
drh79d5f632005-01-18 17:20:10 +00002268 }
drhcf9d36d2021-08-02 18:03:43 +00002269 pCol->zCnName = zName;
drhd44390c2020-04-06 18:16:31 +00002270 pCol->hName = sqlite3StrIHash(zName);
drhd88fd532022-05-02 20:49:30 +00002271 if( pX->fg.bNoExpand ){
drh72d620b2022-05-02 19:59:03 +00002272 pCol->colFlags |= COLFLAG_NOEXPAND;
2273 }
danba68f8f2015-11-19 16:46:46 +00002274 sqlite3ColumnPropertiesFromName(0, pCol);
drh45e41b72022-04-22 23:18:21 +00002275 if( zName && sqlite3HashInsert(&ht, zName, pX)==pX ){
drh4a642b62016-02-05 01:55:27 +00002276 sqlite3OomFault(db);
drh0315e3c2015-11-14 20:52:43 +00002277 }
drh7d10d5a2008-08-20 16:35:10 +00002278 }
drh0315e3c2015-11-14 20:52:43 +00002279 sqlite3HashClear(&ht);
drhf84cbd12023-01-12 13:25:48 +00002280 if( pParse->nErr ){
drh7d10d5a2008-08-20 16:35:10 +00002281 for(j=0; j<i; j++){
drhcf9d36d2021-08-02 18:03:43 +00002282 sqlite3DbFree(db, aCol[j].zCnName);
drh7d10d5a2008-08-20 16:35:10 +00002283 }
2284 sqlite3DbFree(db, aCol);
2285 *paCol = 0;
2286 *pnCol = 0;
drhf84cbd12023-01-12 13:25:48 +00002287 return pParse->rc;
drh7d10d5a2008-08-20 16:35:10 +00002288 }
2289 return SQLITE_OK;
2290}
danielk1977517eb642004-06-07 10:00:31 +00002291
drh7d10d5a2008-08-20 16:35:10 +00002292/*
drh9e660872022-12-13 15:54:43 +00002293** pTab is a transient Table object that represents a subquery of some
2294** kind (maybe a parenthesized subquery in the FROM clause of a larger
2295** query, or a VIEW, or a CTE). This routine computes type information
2296** for that Table object based on the Select object that implements the
2297** subquery. For the purposes of this routine, "type infomation" means:
drh7d10d5a2008-08-20 16:35:10 +00002298**
drh9e660872022-12-13 15:54:43 +00002299** * The datatype name, as it might appear in a CREATE TABLE statement
2300** * Which collating sequence to use for the column
2301** * The affinity of the column
drh7d10d5a2008-08-20 16:35:10 +00002302*/
drh9e660872022-12-13 15:54:43 +00002303void sqlite3SubqueryColumnTypes(
2304 Parse *pParse, /* Parsing contexts */
2305 Table *pTab, /* Add column type information to this table */
2306 Select *pSelect, /* SELECT used to determine types and collations */
drh00d6b272022-12-15 20:03:08 +00002307 char aff /* Default affinity. */
drh7d10d5a2008-08-20 16:35:10 +00002308){
2309 sqlite3 *db = pParse->db;
drh7d10d5a2008-08-20 16:35:10 +00002310 Column *pCol;
2311 CollSeq *pColl;
drh177b8c92022-12-13 16:55:23 +00002312 int i,j;
drh7d10d5a2008-08-20 16:35:10 +00002313 Expr *p;
2314 struct ExprList_item *a;
drh706631d2023-01-10 19:57:26 +00002315 NameContext sNC;
drh7d10d5a2008-08-20 16:35:10 +00002316
2317 assert( pSelect!=0 );
2318 assert( (pSelect->selFlags & SF_Resolved)!=0 );
drh2fc9dc92023-01-12 19:51:49 +00002319 assert( pTab->nCol==pSelect->pEList->nExpr || pParse->nErr>0 );
drh00d6b272022-12-15 20:03:08 +00002320 assert( aff==SQLITE_AFF_NONE || aff==SQLITE_AFF_BLOB );
drh7d10d5a2008-08-20 16:35:10 +00002321 if( db->mallocFailed ) return;
dan6fce5612022-12-10 17:54:55 +00002322 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh7d10d5a2008-08-20 16:35:10 +00002323 a = pSelect->pEList->a;
drh706631d2023-01-10 19:57:26 +00002324 memset(&sNC, 0, sizeof(sNC));
2325 sNC.pSrcList = pSelect->pSrc;
drh186ad8c2013-10-08 18:40:37 +00002326 for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
drhed06a132016-04-05 20:59:12 +00002327 const char *zType;
drh569aef02022-12-15 13:45:49 +00002328 i64 n;
drh6f6e60d2021-02-18 15:45:34 +00002329 pTab->tabFlags |= (pCol->colFlags & COLFLAG_NOINSERT);
drh7d10d5a2008-08-20 16:35:10 +00002330 p = a[i].pExpr;
drhcafc2f72017-10-03 03:01:09 +00002331 /* pCol->szEst = ... // Column size est for SELECT tables never used */
danielk1977c60e9b82005-01-31 12:42:29 +00002332 pCol->affinity = sqlite3ExprAffinity(p);
drh89e160a2022-12-12 18:58:53 +00002333 if( pCol->affinity<=SQLITE_AFF_NONE ){
drh00d6b272022-12-15 20:03:08 +00002334 pCol->affinity = aff;
2335 }else if( pCol->affinity>=SQLITE_AFF_NUMERIC && p->op==TK_CAST ){
2336 pCol->affinity = SQLITE_AFF_FLEXNUM;
drhed07d0e2022-12-14 14:41:35 +00002337 }
2338 if( pCol->affinity>=SQLITE_AFF_TEXT && pSelect->pNext ){
2339 int m = 0;
2340 Select *pS2;
2341 for(m=0, pS2=pSelect->pNext; pS2; pS2=pS2->pNext){
2342 m |= sqlite3ExprDataType(pS2->pEList->a[i].pExpr);
2343 }
2344 if( pCol->affinity==SQLITE_AFF_TEXT && (m&0x01)!=0 ){
2345 pCol->affinity = SQLITE_AFF_BLOB;
2346 }else
2347 if( pCol->affinity>=SQLITE_AFF_NUMERIC && (m&0x02)!=0 ){
2348 pCol->affinity = SQLITE_AFF_BLOB;
2349 }
2350 }
drh706631d2023-01-10 19:57:26 +00002351 zType = columnType(&sNC, p, 0, 0, 0);
2352 if( zType==0 || pCol->affinity!=sqlite3AffinityType(zType, 0) ){
2353 if( pCol->affinity==SQLITE_AFF_NUMERIC
2354 || pCol->affinity==SQLITE_AFF_FLEXNUM
2355 ){
2356 zType = "NUM";
drh146121f2021-11-12 14:39:49 +00002357 }else{
drh706631d2023-01-10 19:57:26 +00002358 zType = 0;
2359 for(j=1; j<SQLITE_N_STDTYPE; j++){
2360 if( sqlite3StdTypeAffinity[j]==pCol->affinity ){
2361 zType = sqlite3StdType[j];
2362 break;
2363 }
2364 }
2365 }
2366 }
2367 if( zType ){
2368 i64 m = sqlite3Strlen30(zType);
2369 n = sqlite3Strlen30(pCol->zCnName);
2370 pCol->zCnName = sqlite3DbReallocOrFree(db, pCol->zCnName, n+m+2);
2371 if( pCol->zCnName ){
2372 memcpy(&pCol->zCnName[n+1], zType, m+1);
2373 pCol->colFlags |= COLFLAG_HASTYPE;
2374 }else{
2375 testcase( pCol->colFlags & COLFLAG_HASTYPE );
drh146121f2021-11-12 14:39:49 +00002376 pCol->colFlags &= ~(COLFLAG_HASTYPE|COLFLAG_HASCOLL);
drhed06a132016-04-05 20:59:12 +00002377 }
2378 }
danielk1977b3bf5562006-01-10 17:58:23 +00002379 pColl = sqlite3ExprCollSeq(pParse, p);
drh5ced0a92021-08-24 17:07:44 +00002380 if( pColl ){
drh65b40092021-08-05 15:27:19 +00002381 assert( pTab->pIndex==0 );
2382 sqlite3ColumnSetColl(db, pCol, pColl->zName);
danielk19770202b292004-06-09 09:55:16 +00002383 }
drh22f70c32002-02-18 01:17:00 +00002384 }
drhcafc2f72017-10-03 03:01:09 +00002385 pTab->szTabRow = 1; /* Any non-zero value works */
drh7d10d5a2008-08-20 16:35:10 +00002386}
2387
2388/*
2389** Given a SELECT statement, generate a Table structure that describes
2390** the result set of that SELECT.
2391*/
drh81506b82019-08-05 19:32:06 +00002392Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect, char aff){
drh7d10d5a2008-08-20 16:35:10 +00002393 Table *pTab;
2394 sqlite3 *db = pParse->db;
drh70d5dfb2018-12-06 16:50:55 +00002395 u64 savedFlags;
drh7d10d5a2008-08-20 16:35:10 +00002396
2397 savedFlags = db->flags;
drhd5b44d62018-12-06 17:06:02 +00002398 db->flags &= ~(u64)SQLITE_FullColNames;
drh7d10d5a2008-08-20 16:35:10 +00002399 db->flags |= SQLITE_ShortColNames;
2400 sqlite3SelectPrep(pParse, pSelect, 0);
drh491b6d82019-01-24 15:51:03 +00002401 db->flags = savedFlags;
drh7d10d5a2008-08-20 16:35:10 +00002402 if( pParse->nErr ) return 0;
2403 while( pSelect->pPrior ) pSelect = pSelect->pPrior;
drh7d10d5a2008-08-20 16:35:10 +00002404 pTab = sqlite3DbMallocZero(db, sizeof(Table) );
2405 if( pTab==0 ){
2406 return 0;
2407 }
drh79df7782016-12-14 14:07:35 +00002408 pTab->nTabRef = 1;
drh7d10d5a2008-08-20 16:35:10 +00002409 pTab->zName = 0;
dancfc9df72014-04-25 15:01:01 +00002410 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drh8981b902015-08-24 17:42:49 +00002411 sqlite3ColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
drh9e660872022-12-13 15:54:43 +00002412 sqlite3SubqueryColumnTypes(pParse, pTab, pSelect, aff);
drh22f70c32002-02-18 01:17:00 +00002413 pTab->iPKey = -1;
drh7ce72f62008-07-24 15:50:41 +00002414 if( db->mallocFailed ){
dan1feeaed2010-07-23 15:41:47 +00002415 sqlite3DeleteTable(db, pTab);
drh7ce72f62008-07-24 15:50:41 +00002416 return 0;
2417 }
drh22f70c32002-02-18 01:17:00 +00002418 return pTab;
2419}
2420
2421/*
drhd8bc7082000-06-07 23:51:50 +00002422** Get a VDBE for the given parser context. Create a new one if necessary.
2423** If an error occurs, return NULL and leave a message in pParse.
2424*/
drh55965612017-09-16 20:58:41 +00002425Vdbe *sqlite3GetVdbe(Parse *pParse){
2426 if( pParse->pVdbe ){
2427 return pParse->pVdbe;
2428 }
drh6f077342016-04-12 00:26:59 +00002429 if( pParse->pToplevel==0
2430 && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
2431 ){
2432 pParse->okConstFactor = 1;
drhd8bc7082000-06-07 23:51:50 +00002433 }
drh55965612017-09-16 20:58:41 +00002434 return sqlite3VdbeCreate(pParse);
drh6f077342016-04-12 00:26:59 +00002435}
drhfcb78a42003-01-18 20:11:05 +00002436
drh15007a92006-01-08 18:10:17 +00002437
drhd8bc7082000-06-07 23:51:50 +00002438/*
drh7b58dae2003-07-20 01:16:46 +00002439** Compute the iLimit and iOffset fields of the SELECT based on the
drh8c0833f2017-11-14 23:48:23 +00002440** pLimit expressions. pLimit->pLeft and pLimit->pRight hold the expressions
drh7b58dae2003-07-20 01:16:46 +00002441** that appear in the original SQL statement after the LIMIT and OFFSET
danielk1977a2dc3b12005-02-05 12:48:48 +00002442** keywords. Or NULL if those keywords are omitted. iLimit and iOffset
2443** are the integer memory register numbers for counters used to compute
2444** the limit and offset. If there is no limit and/or offset, then
2445** iLimit and iOffset are negative.
drh7b58dae2003-07-20 01:16:46 +00002446**
drhd59ba6c2006-01-08 05:02:54 +00002447** This routine changes the values of iLimit and iOffset only if
drh8c0833f2017-11-14 23:48:23 +00002448** a limit or offset is defined by pLimit->pLeft and pLimit->pRight. iLimit
2449** and iOffset should have been preset to appropriate default values (zero)
drhaa9ce702014-01-22 18:07:04 +00002450** prior to calling this routine.
2451**
2452** The iOffset register (if it exists) is initialized to the value
2453** of the OFFSET. The iLimit register is initialized to LIMIT. Register
2454** iOffset+1 is initialized to LIMIT+OFFSET.
2455**
drh8c0833f2017-11-14 23:48:23 +00002456** Only if pLimit->pLeft!=0 do the limit registers get
drh7b58dae2003-07-20 01:16:46 +00002457** redefined. The UNION ALL operator uses this property to force
2458** the reuse of the same limit and offset registers across multiple
2459** SELECT statements.
2460*/
drhec7429a2005-10-06 16:53:14 +00002461static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
drh02afc862006-01-20 18:10:57 +00002462 Vdbe *v = 0;
2463 int iLimit = 0;
drh15007a92006-01-08 18:10:17 +00002464 int iOffset;
drh8b0cf382015-10-06 21:07:06 +00002465 int n;
drh8c0833f2017-11-14 23:48:23 +00002466 Expr *pLimit = p->pLimit;
2467
drh0acb7e42008-06-25 00:12:41 +00002468 if( p->iLimit ) return;
drh15007a92006-01-08 18:10:17 +00002469
drh7b58dae2003-07-20 01:16:46 +00002470 /*
drh7b58dae2003-07-20 01:16:46 +00002471 ** "LIMIT -1" always shows all rows. There is some
drhf7b54962013-05-28 12:11:54 +00002472 ** controversy about what the correct behavior should be.
drh7b58dae2003-07-20 01:16:46 +00002473 ** The current implementation interprets "LIMIT 0" to mean
2474 ** no rows.
2475 */
drh8c0833f2017-11-14 23:48:23 +00002476 if( pLimit ){
2477 assert( pLimit->op==TK_LIMIT );
2478 assert( pLimit->pLeft!=0 );
drh0a07c102008-01-03 18:03:08 +00002479 p->iLimit = iLimit = ++pParse->nMem;
drh15007a92006-01-08 18:10:17 +00002480 v = sqlite3GetVdbe(pParse);
drhaa9ce702014-01-22 18:07:04 +00002481 assert( v!=0 );
drh8c0833f2017-11-14 23:48:23 +00002482 if( sqlite3ExprIsInteger(pLimit->pLeft, &n) ){
drh456e4e42009-11-20 16:13:15 +00002483 sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
2484 VdbeComment((v, "LIMIT counter"));
drh9b918ed2009-11-12 03:13:26 +00002485 if( n==0 ){
drh076e85f2015-09-03 13:46:12 +00002486 sqlite3VdbeGoto(v, iBreak);
drhc3489bb2016-02-25 16:04:59 +00002487 }else if( n>=0 && p->nSelectRow>sqlite3LogEst((u64)n) ){
2488 p->nSelectRow = sqlite3LogEst((u64)n);
2489 p->selFlags |= SF_FixedLimit;
drh9b918ed2009-11-12 03:13:26 +00002490 }
2491 }else{
drh8c0833f2017-11-14 23:48:23 +00002492 sqlite3ExprCode(pParse, pLimit->pLeft, iLimit);
drh688852a2014-02-17 22:40:43 +00002493 sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
drh9b918ed2009-11-12 03:13:26 +00002494 VdbeComment((v, "LIMIT counter"));
drh16897072015-03-07 00:57:37 +00002495 sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, iBreak); VdbeCoverage(v);
drh9b918ed2009-11-12 03:13:26 +00002496 }
drh8c0833f2017-11-14 23:48:23 +00002497 if( pLimit->pRight ){
drh373cc2d2009-05-17 02:06:14 +00002498 p->iOffset = iOffset = ++pParse->nMem;
drhb7654112008-01-12 12:48:07 +00002499 pParse->nMem++; /* Allocate an extra register for limit+offset */
drh8c0833f2017-11-14 23:48:23 +00002500 sqlite3ExprCode(pParse, pLimit->pRight, iOffset);
drh688852a2014-02-17 22:40:43 +00002501 sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
drh373cc2d2009-05-17 02:06:14 +00002502 VdbeComment((v, "OFFSET counter"));
drhcc2fa4c2016-01-25 15:57:29 +00002503 sqlite3VdbeAddOp3(v, OP_OffsetLimit, iLimit, iOffset+1, iOffset);
drhb7654112008-01-12 12:48:07 +00002504 VdbeComment((v, "LIMIT+OFFSET"));
drhd59ba6c2006-01-08 05:02:54 +00002505 }
drh7b58dae2003-07-20 01:16:46 +00002506 }
2507}
2508
drhb7f91642004-10-31 02:22:47 +00002509#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhfbc4ee72004-08-29 01:31:05 +00002510/*
drhfbc4ee72004-08-29 01:31:05 +00002511** Return the appropriate collating sequence for the iCol-th column of
2512** the result set for the compound-select statement "p". Return NULL if
2513** the column has no default collating sequence.
2514**
2515** The collating sequence for the compound select is taken from the
2516** left-most term of the select that has a collating sequence.
2517*/
danielk1977dc1bdc42004-06-11 10:51:27 +00002518static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
drhfbc4ee72004-08-29 01:31:05 +00002519 CollSeq *pRet;
danielk1977dc1bdc42004-06-11 10:51:27 +00002520 if( p->pPrior ){
2521 pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
drhfbc4ee72004-08-29 01:31:05 +00002522 }else{
2523 pRet = 0;
danielk1977dc1bdc42004-06-11 10:51:27 +00002524 }
drh10c081a2009-04-16 00:24:23 +00002525 assert( iCol>=0 );
drh2ec18a32015-06-23 23:31:52 +00002526 /* iCol must be less than p->pEList->nExpr. Otherwise an error would
2527 ** have been thrown during name resolution and we would not have gotten
2528 ** this far */
2529 if( pRet==0 && ALWAYS(iCol<p->pEList->nExpr) ){
danielk1977dc1bdc42004-06-11 10:51:27 +00002530 pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
2531 }
2532 return pRet;
drhd3d39e92004-05-20 22:16:29 +00002533}
2534
dan53bed452014-01-24 20:37:18 +00002535/*
2536** The select statement passed as the second parameter is a compound SELECT
2537** with an ORDER BY clause. This function allocates and returns a KeyInfo
2538** structure suitable for implementing the ORDER BY.
2539**
2540** Space to hold the KeyInfo structure is obtained from malloc. The calling
2541** function is responsible for ensuring that this structure is eventually
2542** freed.
2543*/
2544static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
2545 ExprList *pOrderBy = p->pOrderBy;
drh7d4c94b2021-10-04 22:34:38 +00002546 int nOrderBy = ALWAYS(pOrderBy!=0) ? pOrderBy->nExpr : 0;
dan53bed452014-01-24 20:37:18 +00002547 sqlite3 *db = pParse->db;
2548 KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
2549 if( pRet ){
2550 int i;
2551 for(i=0; i<nOrderBy; i++){
2552 struct ExprList_item *pItem = &pOrderBy->a[i];
2553 Expr *pTerm = pItem->pExpr;
2554 CollSeq *pColl;
2555
2556 if( pTerm->flags & EP_Collate ){
2557 pColl = sqlite3ExprCollSeq(pParse, pTerm);
2558 }else{
2559 pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
2560 if( pColl==0 ) pColl = db->pDfltColl;
2561 pOrderBy->a[i].pExpr =
2562 sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
2563 }
2564 assert( sqlite3KeyInfoIsWriteable(pRet) );
2565 pRet->aColl[i] = pColl;
drhd88fd532022-05-02 20:49:30 +00002566 pRet->aSortFlags[i] = pOrderBy->a[i].fg.sortFlags;
dan53bed452014-01-24 20:37:18 +00002567 }
2568 }
2569
2570 return pRet;
2571}
drhd3d39e92004-05-20 22:16:29 +00002572
drh781def22014-01-22 13:35:53 +00002573#ifndef SQLITE_OMIT_CTE
2574/*
2575** This routine generates VDBE code to compute the content of a WITH RECURSIVE
2576** query of the form:
2577**
2578** <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
2579** \___________/ \_______________/
2580** p->pPrior p
2581**
2582**
2583** There is exactly one reference to the recursive-table in the FROM clause
drh8a48b9c2015-08-19 15:20:00 +00002584** of recursive-query, marked with the SrcList->a[].fg.isRecursive flag.
drh781def22014-01-22 13:35:53 +00002585**
2586** The setup-query runs once to generate an initial set of rows that go
2587** into a Queue table. Rows are extracted from the Queue table one by
drhfe1c6bb2014-01-22 17:28:35 +00002588** one. Each row extracted from Queue is output to pDest. Then the single
2589** extracted row (now in the iCurrent table) becomes the content of the
2590** recursive-table for a recursive-query run. The output of the recursive-query
drh781def22014-01-22 13:35:53 +00002591** is added back into the Queue table. Then another row is extracted from Queue
2592** and the iteration continues until the Queue table is empty.
2593**
2594** If the compound query operator is UNION then no duplicate rows are ever
2595** inserted into the Queue table. The iDistinct table keeps a copy of all rows
2596** that have ever been inserted into Queue and causes duplicates to be
2597** discarded. If the operator is UNION ALL, then duplicates are allowed.
2598**
2599** If the query has an ORDER BY, then entries in the Queue table are kept in
2600** ORDER BY order and the first entry is extracted for each cycle. Without
2601** an ORDER BY, the Queue table is just a FIFO.
2602**
2603** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
2604** have been output to pDest. A LIMIT of zero means to output no rows and a
2605** negative LIMIT means to output all rows. If there is also an OFFSET clause
2606** with a positive value, then the first OFFSET outputs are discarded rather
2607** than being sent to pDest. The LIMIT count does not begin until after OFFSET
2608** rows have been skipped.
2609*/
2610static void generateWithRecursiveQuery(
2611 Parse *pParse, /* Parsing context */
2612 Select *p, /* The recursive SELECT to be coded */
2613 SelectDest *pDest /* What to do with query results */
2614){
2615 SrcList *pSrc = p->pSrc; /* The FROM clause of the recursive query */
2616 int nCol = p->pEList->nExpr; /* Number of columns in the recursive table */
2617 Vdbe *v = pParse->pVdbe; /* The prepared statement under construction */
drhe85e1da2021-10-01 21:01:07 +00002618 Select *pSetup; /* The setup query */
drh34055852020-10-19 01:23:48 +00002619 Select *pFirstRec; /* Left-most recursive term */
drh781def22014-01-22 13:35:53 +00002620 int addrTop; /* Top of the loop */
2621 int addrCont, addrBreak; /* CONTINUE and BREAK addresses */
drhedf83d12014-01-22 18:31:27 +00002622 int iCurrent = 0; /* The Current table */
drh781def22014-01-22 13:35:53 +00002623 int regCurrent; /* Register holding Current table */
2624 int iQueue; /* The Queue table */
2625 int iDistinct = 0; /* To ensure unique results if UNION */
drh8e1ee882014-03-21 19:56:09 +00002626 int eDest = SRT_Fifo; /* How to write to Queue */
drh781def22014-01-22 13:35:53 +00002627 SelectDest destQueue; /* SelectDest targetting the Queue table */
2628 int i; /* Loop counter */
2629 int rc; /* Result code */
drhfe1c6bb2014-01-22 17:28:35 +00002630 ExprList *pOrderBy; /* The ORDER BY clause */
drh8c0833f2017-11-14 23:48:23 +00002631 Expr *pLimit; /* Saved LIMIT and OFFSET */
drhaa9ce702014-01-22 18:07:04 +00002632 int regLimit, regOffset; /* Registers used by LIMIT and OFFSET */
drh781def22014-01-22 13:35:53 +00002633
dan6afa35c2018-09-27 12:14:15 +00002634#ifndef SQLITE_OMIT_WINDOWFUNC
2635 if( p->pWin ){
2636 sqlite3ErrorMsg(pParse, "cannot use window functions in recursive queries");
2637 return;
2638 }
2639#endif
2640
drh781def22014-01-22 13:35:53 +00002641 /* Obtain authorization to do a recursive query */
2642 if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
drh781def22014-01-22 13:35:53 +00002643
drhaa9ce702014-01-22 18:07:04 +00002644 /* Process the LIMIT and OFFSET clauses, if they exist */
drhec4ccdb2018-12-29 02:26:59 +00002645 addrBreak = sqlite3VdbeMakeLabel(pParse);
dan69b93832016-12-16 15:05:40 +00002646 p->nSelectRow = 320; /* 4 billion rows */
drhaa9ce702014-01-22 18:07:04 +00002647 computeLimitRegisters(pParse, p, addrBreak);
2648 pLimit = p->pLimit;
drhaa9ce702014-01-22 18:07:04 +00002649 regLimit = p->iLimit;
2650 regOffset = p->iOffset;
drh8c0833f2017-11-14 23:48:23 +00002651 p->pLimit = 0;
drhaa9ce702014-01-22 18:07:04 +00002652 p->iLimit = p->iOffset = 0;
dan53bed452014-01-24 20:37:18 +00002653 pOrderBy = p->pOrderBy;
drh781def22014-01-22 13:35:53 +00002654
2655 /* Locate the cursor number of the Current table */
2656 for(i=0; ALWAYS(i<pSrc->nSrc); i++){
drh8a48b9c2015-08-19 15:20:00 +00002657 if( pSrc->a[i].fg.isRecursive ){
drh781def22014-01-22 13:35:53 +00002658 iCurrent = pSrc->a[i].iCursor;
2659 break;
2660 }
2661 }
2662
drhfe1c6bb2014-01-22 17:28:35 +00002663 /* Allocate cursors numbers for Queue and Distinct. The cursor number for
drh781def22014-01-22 13:35:53 +00002664 ** the Distinct table must be exactly one greater than Queue in order
drh8e1ee882014-03-21 19:56:09 +00002665 ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
drh781def22014-01-22 13:35:53 +00002666 iQueue = pParse->nTab++;
2667 if( p->op==TK_UNION ){
drh8e1ee882014-03-21 19:56:09 +00002668 eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
drh781def22014-01-22 13:35:53 +00002669 iDistinct = pParse->nTab++;
drhfe1c6bb2014-01-22 17:28:35 +00002670 }else{
drh8e1ee882014-03-21 19:56:09 +00002671 eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
drh781def22014-01-22 13:35:53 +00002672 }
2673 sqlite3SelectDestInit(&destQueue, eDest, iQueue);
2674
2675 /* Allocate cursors for Current, Queue, and Distinct. */
2676 regCurrent = ++pParse->nMem;
2677 sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
drhfe1c6bb2014-01-22 17:28:35 +00002678 if( pOrderBy ){
dan53bed452014-01-24 20:37:18 +00002679 KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
drhfe1c6bb2014-01-22 17:28:35 +00002680 sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
2681 (char*)pKeyInfo, P4_KEYINFO);
2682 destQueue.pOrderBy = pOrderBy;
2683 }else{
2684 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
2685 }
2686 VdbeComment((v, "Queue table"));
drh781def22014-01-22 13:35:53 +00002687 if( iDistinct ){
2688 p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
2689 p->selFlags |= SF_UsesEphemeral;
2690 }
2691
dan53bed452014-01-24 20:37:18 +00002692 /* Detach the ORDER BY clause from the compound SELECT */
2693 p->pOrderBy = 0;
2694
drh34055852020-10-19 01:23:48 +00002695 /* Figure out how many elements of the compound SELECT are part of the
2696 ** recursive query. Make sure no recursive elements use aggregate
2697 ** functions. Mark the recursive elements as UNION ALL even if they
2698 ** are really UNION because the distinctness will be enforced by the
2699 ** iDistinct table. pFirstRec is left pointing to the left-most
2700 ** recursive term of the CTE.
2701 */
drh34055852020-10-19 01:23:48 +00002702 for(pFirstRec=p; ALWAYS(pFirstRec!=0); pFirstRec=pFirstRec->pPrior){
2703 if( pFirstRec->selFlags & SF_Aggregate ){
2704 sqlite3ErrorMsg(pParse, "recursive aggregate queries not supported");
2705 goto end_of_recursive_query;
2706 }
2707 pFirstRec->op = TK_ALL;
2708 if( (pFirstRec->pPrior->selFlags & SF_Recursive)==0 ) break;
2709 }
2710
drh781def22014-01-22 13:35:53 +00002711 /* Store the results of the setup-query in Queue. */
drh34055852020-10-19 01:23:48 +00002712 pSetup = pFirstRec->pPrior;
drhd227a292014-02-09 18:02:09 +00002713 pSetup->pNext = 0;
drh84a01de2018-05-02 16:13:48 +00002714 ExplainQueryPlan((pParse, 1, "SETUP"));
drh781def22014-01-22 13:35:53 +00002715 rc = sqlite3Select(pParse, pSetup, &destQueue);
drhd227a292014-02-09 18:02:09 +00002716 pSetup->pNext = p;
drhfe1c6bb2014-01-22 17:28:35 +00002717 if( rc ) goto end_of_recursive_query;
drh781def22014-01-22 13:35:53 +00002718
2719 /* Find the next row in the Queue and output that row */
drh688852a2014-02-17 22:40:43 +00002720 addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
drh781def22014-01-22 13:35:53 +00002721
2722 /* Transfer the next row in Queue over to Current */
2723 sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
drhfe1c6bb2014-01-22 17:28:35 +00002724 if( pOrderBy ){
2725 sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
2726 }else{
2727 sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
2728 }
drh781def22014-01-22 13:35:53 +00002729 sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
2730
drhfe1c6bb2014-01-22 17:28:35 +00002731 /* Output the single row in Current */
drhec4ccdb2018-12-29 02:26:59 +00002732 addrCont = sqlite3VdbeMakeLabel(pParse);
drhaa9ce702014-01-22 18:07:04 +00002733 codeOffset(v, regOffset, addrCont);
drh2def2f72017-09-15 17:40:34 +00002734 selectInnerLoop(pParse, p, iCurrent,
drh079a3072014-03-19 14:10:55 +00002735 0, 0, pDest, addrCont, addrBreak);
drh688852a2014-02-17 22:40:43 +00002736 if( regLimit ){
drh16897072015-03-07 00:57:37 +00002737 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, regLimit, addrBreak);
drh688852a2014-02-17 22:40:43 +00002738 VdbeCoverage(v);
2739 }
drhfe1c6bb2014-01-22 17:28:35 +00002740 sqlite3VdbeResolveLabel(v, addrCont);
2741
drh781def22014-01-22 13:35:53 +00002742 /* Execute the recursive SELECT taking the single row in Current as
2743 ** the value for the recursive-table. Store the results in the Queue.
2744 */
drh34055852020-10-19 01:23:48 +00002745 pFirstRec->pPrior = 0;
2746 ExplainQueryPlan((pParse, 1, "RECURSIVE STEP"));
2747 sqlite3Select(pParse, p, &destQueue);
2748 assert( pFirstRec->pPrior==0 );
2749 pFirstRec->pPrior = pSetup;
drh781def22014-01-22 13:35:53 +00002750
2751 /* Keep running the loop until the Queue is empty */
drh076e85f2015-09-03 13:46:12 +00002752 sqlite3VdbeGoto(v, addrTop);
drh781def22014-01-22 13:35:53 +00002753 sqlite3VdbeResolveLabel(v, addrBreak);
drhfe1c6bb2014-01-22 17:28:35 +00002754
2755end_of_recursive_query:
dan9afccba2014-03-21 19:27:54 +00002756 sqlite3ExprListDelete(pParse->db, p->pOrderBy);
drhfe1c6bb2014-01-22 17:28:35 +00002757 p->pOrderBy = pOrderBy;
drhaa9ce702014-01-22 18:07:04 +00002758 p->pLimit = pLimit;
drhfe1c6bb2014-01-22 17:28:35 +00002759 return;
drh781def22014-01-22 13:35:53 +00002760}
danb68b9772014-01-25 12:16:53 +00002761#endif /* SQLITE_OMIT_CTE */
drh781def22014-01-22 13:35:53 +00002762
2763/* Forward references */
drhb21e7c72008-06-22 12:37:57 +00002764static int multiSelectOrderBy(
2765 Parse *pParse, /* Parsing context */
2766 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00002767 SelectDest *pDest /* What to do with query results */
drhb21e7c72008-06-22 12:37:57 +00002768);
2769
drh45f54a52015-01-05 19:16:42 +00002770/*
drh45f54a52015-01-05 19:16:42 +00002771** Handle the special case of a compound-select that originates from a
2772** VALUES clause. By handling this as a special case, we avoid deep
2773** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
2774** on a VALUES clause.
2775**
2776** Because the Select object originates from a VALUES clause:
drhb058d052018-01-14 20:12:23 +00002777** (1) There is no LIMIT or OFFSET or else there is a LIMIT of exactly 1
drh45f54a52015-01-05 19:16:42 +00002778** (2) All terms are UNION ALL
2779** (3) There is no ORDER BY clause
drhb058d052018-01-14 20:12:23 +00002780**
2781** The "LIMIT of exactly 1" case of condition (1) comes about when a VALUES
2782** clause occurs within scalar expression (ex: "SELECT (VALUES(1),(2),(3))").
2783** The sqlite3CodeSubselect will have added the LIMIT 1 clause in tht case.
drhd1f0a862022-02-25 11:30:29 +00002784** Since the limit is exactly 1, we only need to evaluate the left-most VALUES.
drh45f54a52015-01-05 19:16:42 +00002785*/
2786static int multiSelectValues(
2787 Parse *pParse, /* Parsing context */
2788 Select *p, /* The right-most of SELECTs to be coded */
2789 SelectDest *pDest /* What to do with query results */
2790){
drh45f54a52015-01-05 19:16:42 +00002791 int nRow = 1;
2792 int rc = 0;
drhfa16f5d2018-05-03 01:37:13 +00002793 int bShowAll = p->pLimit==0;
drh772460f2015-04-16 14:13:12 +00002794 assert( p->selFlags & SF_MultiValue );
drh45f54a52015-01-05 19:16:42 +00002795 do{
2796 assert( p->selFlags & SF_Values );
2797 assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
dan923cadb2015-06-23 12:19:55 +00002798 assert( p->pNext==0 || p->pEList->nExpr==p->pNext->pEList->nExpr );
drhef9f7192020-01-17 19:14:08 +00002799#ifndef SQLITE_OMIT_WINDOWFUNC
drh29cdbad2019-12-07 13:42:47 +00002800 if( p->pWin ) return -1;
drhef9f7192020-01-17 19:14:08 +00002801#endif
drh45f54a52015-01-05 19:16:42 +00002802 if( p->pPrior==0 ) break;
2803 assert( p->pPrior->pNext==p );
2804 p = p->pPrior;
drhfa16f5d2018-05-03 01:37:13 +00002805 nRow += bShowAll;
drh45f54a52015-01-05 19:16:42 +00002806 }while(1);
drhfa16f5d2018-05-03 01:37:13 +00002807 ExplainQueryPlan((pParse, 0, "SCAN %d CONSTANT ROW%s", nRow,
2808 nRow==1 ? "" : "S"));
drh45f54a52015-01-05 19:16:42 +00002809 while( p ){
drhfa16f5d2018-05-03 01:37:13 +00002810 selectInnerLoop(pParse, p, -1, 0, 0, pDest, 1, 1);
2811 if( !bShowAll ) break;
drh45f54a52015-01-05 19:16:42 +00002812 p->nSelectRow = nRow;
2813 p = p->pNext;
2814 }
2815 return rc;
2816}
drhb21e7c72008-06-22 12:37:57 +00002817
drhd3d39e92004-05-20 22:16:29 +00002818/*
drh34055852020-10-19 01:23:48 +00002819** Return true if the SELECT statement which is known to be the recursive
2820** part of a recursive CTE still has its anchor terms attached. If the
2821** anchor terms have already been removed, then return false.
2822*/
2823static int hasAnchor(Select *p){
2824 while( p && (p->selFlags & SF_Recursive)!=0 ){ p = p->pPrior; }
2825 return p!=0;
2826}
2827
2828/*
drh16ee60f2008-06-20 18:13:25 +00002829** This routine is called to process a compound query form from
2830** two or more separate queries using UNION, UNION ALL, EXCEPT, or
2831** INTERSECT
drhc926afb2002-06-20 03:38:26 +00002832**
drhe78e8282003-01-19 03:59:45 +00002833** "p" points to the right-most of the two queries. the query on the
2834** left is p->pPrior. The left query could also be a compound query
2835** in which case this routine will be called recursively.
2836**
2837** The results of the total query are to be written into a destination
2838** of type eDest with parameter iParm.
2839**
2840** Example 1: Consider a three-way compound SQL statement.
2841**
2842** SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
2843**
2844** This statement is parsed up as follows:
2845**
2846** SELECT c FROM t3
2847** |
2848** `-----> SELECT b FROM t2
2849** |
jplyon4b11c6d2004-01-19 04:57:53 +00002850** `------> SELECT a FROM t1
drhe78e8282003-01-19 03:59:45 +00002851**
2852** The arrows in the diagram above represent the Select.pPrior pointer.
2853** So if this routine is called with p equal to the t3 query, then
2854** pPrior will be the t2 query. p->op will be TK_UNION in this case.
2855**
2856** Notice that because of the way SQLite parses compound SELECTs, the
2857** individual selects always group from left to right.
drh82c3d632000-06-06 21:56:07 +00002858*/
danielk197784ac9d02004-05-18 09:58:06 +00002859static int multiSelect(
drhfbc4ee72004-08-29 01:31:05 +00002860 Parse *pParse, /* Parsing context */
2861 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00002862 SelectDest *pDest /* What to do with query results */
danielk197784ac9d02004-05-18 09:58:06 +00002863){
drhfbc4ee72004-08-29 01:31:05 +00002864 int rc = SQLITE_OK; /* Success code from a subroutine */
2865 Select *pPrior; /* Another SELECT immediately to our left */
2866 Vdbe *v; /* Generate code to this VDBE */
drh1013c932008-01-06 00:25:21 +00002867 SelectDest dest; /* Alternative data destination */
danielk1977eca7e012008-07-01 16:05:25 +00002868 Select *pDelete = 0; /* Chain of simple selects to delete */
drh633e6d52008-07-28 19:34:53 +00002869 sqlite3 *db; /* Database connection */
drh82c3d632000-06-06 21:56:07 +00002870
drh7b58dae2003-07-20 01:16:46 +00002871 /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs. Only
drhfbc4ee72004-08-29 01:31:05 +00002872 ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
drh82c3d632000-06-06 21:56:07 +00002873 */
drh701bb3b2008-08-02 03:50:39 +00002874 assert( p && p->pPrior ); /* Calling function guarantees this much */
daneae73fb2014-01-16 18:34:33 +00002875 assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
drhb0968b62019-05-29 18:33:59 +00002876 assert( p->selFlags & SF_Compound );
drh633e6d52008-07-28 19:34:53 +00002877 db = pParse->db;
drhd8bc7082000-06-07 23:51:50 +00002878 pPrior = p->pPrior;
drhbc103772008-08-08 18:06:25 +00002879 dest = *pDest;
drhaae0f742021-03-04 16:03:32 +00002880 assert( pPrior->pOrderBy==0 );
2881 assert( pPrior->pLimit==0 );
drh82c3d632000-06-06 21:56:07 +00002882
danielk19774adee202004-05-08 08:23:19 +00002883 v = sqlite3GetVdbe(pParse);
drh701bb3b2008-08-02 03:50:39 +00002884 assert( v!=0 ); /* The VDBE already created by calling function */
drhd8bc7082000-06-07 23:51:50 +00002885
drh1cc3d752002-03-23 00:31:29 +00002886 /* Create the destination temporary table if necessary
2887 */
danielk19776c8c8ce2008-01-02 16:27:09 +00002888 if( dest.eDest==SRT_EphemTab ){
danielk1977b4964b72004-05-18 01:23:38 +00002889 assert( p->pEList );
drh2b596da2012-07-23 21:43:19 +00002890 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
danielk19776c8c8ce2008-01-02 16:27:09 +00002891 dest.eDest = SRT_Table;
drh1cc3d752002-03-23 00:31:29 +00002892 }
2893
drh45f54a52015-01-05 19:16:42 +00002894 /* Special handling for a compound-select that originates as a VALUES clause.
2895 */
drh772460f2015-04-16 14:13:12 +00002896 if( p->selFlags & SF_MultiValue ){
drh45f54a52015-01-05 19:16:42 +00002897 rc = multiSelectValues(pParse, p, &dest);
drh29cdbad2019-12-07 13:42:47 +00002898 if( rc>=0 ) goto multi_select_end;
2899 rc = SQLITE_OK;
drh45f54a52015-01-05 19:16:42 +00002900 }
2901
drhf6e369a2008-06-24 12:46:30 +00002902 /* Make sure all SELECTs in the statement have the same number of elements
2903 ** in their result sets.
2904 */
2905 assert( p->pEList && pPrior->pEList );
dan923cadb2015-06-23 12:19:55 +00002906 assert( p->pEList->nExpr==pPrior->pEList->nExpr );
drhf6e369a2008-06-24 12:46:30 +00002907
daneede6a52014-01-15 19:42:23 +00002908#ifndef SQLITE_OMIT_CTE
drh34055852020-10-19 01:23:48 +00002909 if( (p->selFlags & SF_Recursive)!=0 && hasAnchor(p) ){
drh781def22014-01-22 13:35:53 +00002910 generateWithRecursiveQuery(pParse, p, &dest);
dan8ce71842014-01-14 20:14:09 +00002911 }else
2912#endif
drhf6e369a2008-06-24 12:46:30 +00002913
drha9671a22008-07-08 23:40:20 +00002914 /* Compound SELECTs that have an ORDER BY clause are handled separately.
2915 */
drhf6e369a2008-06-24 12:46:30 +00002916 if( p->pOrderBy ){
drha9671a22008-07-08 23:40:20 +00002917 return multiSelectOrderBy(pParse, p, pDest);
drh03c39052018-05-02 14:24:34 +00002918 }else{
drhf6e369a2008-06-24 12:46:30 +00002919
drhc631ded2018-05-02 02:22:22 +00002920#ifndef SQLITE_OMIT_EXPLAIN
drh03c39052018-05-02 14:24:34 +00002921 if( pPrior->pPrior==0 ){
drh4d799832018-05-03 19:47:14 +00002922 ExplainQueryPlan((pParse, 1, "COMPOUND QUERY"));
drh03c39052018-05-02 14:24:34 +00002923 ExplainQueryPlan((pParse, 1, "LEFT-MOST SUBQUERY"));
drh03c39052018-05-02 14:24:34 +00002924 }
drhc631ded2018-05-02 02:22:22 +00002925#endif
2926
drh03c39052018-05-02 14:24:34 +00002927 /* Generate code for the left and right SELECT statements.
2928 */
2929 switch( p->op ){
2930 case TK_ALL: {
2931 int addr = 0;
drh252d5822021-04-07 13:20:34 +00002932 int nLimit = 0; /* Initialize to suppress harmless compiler warning */
drh03c39052018-05-02 14:24:34 +00002933 assert( !pPrior->pLimit );
2934 pPrior->iLimit = p->iLimit;
2935 pPrior->iOffset = p->iOffset;
2936 pPrior->pLimit = p->pLimit;
drh5d7aef12022-11-22 19:49:16 +00002937 TREETRACE(0x200, pParse, p, ("multiSelect UNION ALL left...\n"));
drh03c39052018-05-02 14:24:34 +00002938 rc = sqlite3Select(pParse, pPrior, &dest);
drhbc7819d2021-03-05 14:08:45 +00002939 pPrior->pLimit = 0;
drh03c39052018-05-02 14:24:34 +00002940 if( rc ){
2941 goto multi_select_end;
drh9f1ef452015-10-06 17:27:18 +00002942 }
drh03c39052018-05-02 14:24:34 +00002943 p->pPrior = 0;
2944 p->iLimit = pPrior->iLimit;
2945 p->iOffset = pPrior->iOffset;
2946 if( p->iLimit ){
2947 addr = sqlite3VdbeAddOp1(v, OP_IfNot, p->iLimit); VdbeCoverage(v);
2948 VdbeComment((v, "Jump ahead if LIMIT reached"));
2949 if( p->iOffset ){
2950 sqlite3VdbeAddOp3(v, OP_OffsetLimit,
2951 p->iLimit, p->iOffset+1, p->iOffset);
2952 }
2953 }
2954 ExplainQueryPlan((pParse, 1, "UNION ALL"));
drh5d7aef12022-11-22 19:49:16 +00002955 TREETRACE(0x200, pParse, p, ("multiSelect UNION ALL right...\n"));
drh03c39052018-05-02 14:24:34 +00002956 rc = sqlite3Select(pParse, p, &dest);
2957 testcase( rc!=SQLITE_OK );
2958 pDelete = p->pPrior;
2959 p->pPrior = pPrior;
2960 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
drhbc7819d2021-03-05 14:08:45 +00002961 if( p->pLimit
2962 && sqlite3ExprIsInteger(p->pLimit->pLeft, &nLimit)
drh03c39052018-05-02 14:24:34 +00002963 && nLimit>0 && p->nSelectRow > sqlite3LogEst((u64)nLimit)
2964 ){
2965 p->nSelectRow = sqlite3LogEst((u64)nLimit);
2966 }
2967 if( addr ){
2968 sqlite3VdbeJumpHere(v, addr);
2969 }
2970 break;
drha9671a22008-07-08 23:40:20 +00002971 }
drh03c39052018-05-02 14:24:34 +00002972 case TK_EXCEPT:
2973 case TK_UNION: {
2974 int unionTab; /* Cursor number of the temp table holding result */
2975 u8 op = 0; /* One of the SRT_ operations to apply to self */
2976 int priorOp; /* The SRT_ operation to apply to prior selects */
2977 Expr *pLimit; /* Saved values of p->nLimit */
2978 int addr;
2979 SelectDest uniondest;
2980
2981 testcase( p->op==TK_EXCEPT );
2982 testcase( p->op==TK_UNION );
2983 priorOp = SRT_Union;
2984 if( dest.eDest==priorOp ){
2985 /* We can reuse a temporary table generated by a SELECT to our
2986 ** right.
2987 */
2988 assert( p->pLimit==0 ); /* Not allowed on leftward elements */
2989 unionTab = dest.iSDParm;
2990 }else{
2991 /* We will need to create our own temporary table to hold the
2992 ** intermediate results.
2993 */
2994 unionTab = pParse->nTab++;
2995 assert( p->pOrderBy==0 );
2996 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
2997 assert( p->addrOpenEphm[0] == -1 );
2998 p->addrOpenEphm[0] = addr;
2999 findRightmost(p)->selFlags |= SF_UsesEphemeral;
3000 assert( p->pEList );
3001 }
drh34055852020-10-19 01:23:48 +00003002
drh03c39052018-05-02 14:24:34 +00003003
3004 /* Code the SELECT statements to our left
drhd8bc7082000-06-07 23:51:50 +00003005 */
drh03c39052018-05-02 14:24:34 +00003006 assert( !pPrior->pOrderBy );
3007 sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
drh5d7aef12022-11-22 19:49:16 +00003008 TREETRACE(0x200, pParse, p, ("multiSelect EXCEPT/UNION left...\n"));
drh03c39052018-05-02 14:24:34 +00003009 rc = sqlite3Select(pParse, pPrior, &uniondest);
3010 if( rc ){
3011 goto multi_select_end;
3012 }
3013
3014 /* Code the current SELECT statement
drhd8bc7082000-06-07 23:51:50 +00003015 */
drh03c39052018-05-02 14:24:34 +00003016 if( p->op==TK_EXCEPT ){
3017 op = SRT_Except;
3018 }else{
3019 assert( p->op==TK_UNION );
3020 op = SRT_Union;
3021 }
3022 p->pPrior = 0;
3023 pLimit = p->pLimit;
3024 p->pLimit = 0;
3025 uniondest.eDest = op;
3026 ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
drhaae0f742021-03-04 16:03:32 +00003027 sqlite3SelectOpName(p->op)));
drh5d7aef12022-11-22 19:49:16 +00003028 TREETRACE(0x200, pParse, p, ("multiSelect EXCEPT/UNION right...\n"));
drh03c39052018-05-02 14:24:34 +00003029 rc = sqlite3Select(pParse, p, &uniondest);
3030 testcase( rc!=SQLITE_OK );
drhb7cbf5c2020-06-15 13:51:34 +00003031 assert( p->pOrderBy==0 );
drh03c39052018-05-02 14:24:34 +00003032 pDelete = p->pPrior;
3033 p->pPrior = pPrior;
3034 p->pOrderBy = 0;
3035 if( p->op==TK_UNION ){
3036 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
3037 }
3038 sqlite3ExprDelete(db, p->pLimit);
3039 p->pLimit = pLimit;
3040 p->iLimit = 0;
3041 p->iOffset = 0;
3042
3043 /* Convert the data in the temporary table into whatever form
3044 ** it is that we currently need.
3045 */
3046 assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
drha9ebfe22019-12-25 23:54:21 +00003047 assert( p->pEList || db->mallocFailed );
3048 if( dest.eDest!=priorOp && db->mallocFailed==0 ){
drh03c39052018-05-02 14:24:34 +00003049 int iCont, iBreak, iStart;
drhec4ccdb2018-12-29 02:26:59 +00003050 iBreak = sqlite3VdbeMakeLabel(pParse);
3051 iCont = sqlite3VdbeMakeLabel(pParse);
drh03c39052018-05-02 14:24:34 +00003052 computeLimitRegisters(pParse, p, iBreak);
3053 sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
3054 iStart = sqlite3VdbeCurrentAddr(v);
3055 selectInnerLoop(pParse, p, unionTab,
3056 0, 0, &dest, iCont, iBreak);
3057 sqlite3VdbeResolveLabel(v, iCont);
3058 sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
3059 sqlite3VdbeResolveLabel(v, iBreak);
3060 sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
3061 }
3062 break;
3063 }
3064 default: assert( p->op==TK_INTERSECT ); {
3065 int tab1, tab2;
3066 int iCont, iBreak, iStart;
3067 Expr *pLimit;
3068 int addr;
3069 SelectDest intersectdest;
3070 int r1;
3071
3072 /* INTERSECT is different from the others since it requires
3073 ** two temporary tables. Hence it has its own case. Begin
3074 ** by allocating the tables we will need.
3075 */
3076 tab1 = pParse->nTab++;
3077 tab2 = pParse->nTab++;
drh93a960a2008-07-10 00:32:42 +00003078 assert( p->pOrderBy==0 );
drh03c39052018-05-02 14:24:34 +00003079
3080 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
drh93a960a2008-07-10 00:32:42 +00003081 assert( p->addrOpenEphm[0] == -1 );
3082 p->addrOpenEphm[0] = addr;
drhd227a292014-02-09 18:02:09 +00003083 findRightmost(p)->selFlags |= SF_UsesEphemeral;
danielk197784ac9d02004-05-18 09:58:06 +00003084 assert( p->pEList );
drh03c39052018-05-02 14:24:34 +00003085
3086 /* Code the SELECTs to our left into temporary table "tab1".
3087 */
3088 sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
drh5d7aef12022-11-22 19:49:16 +00003089 TREETRACE(0x400, pParse, p, ("multiSelect INTERSECT left...\n"));
drh03c39052018-05-02 14:24:34 +00003090 rc = sqlite3Select(pParse, pPrior, &intersectdest);
3091 if( rc ){
3092 goto multi_select_end;
3093 }
3094
3095 /* Code the current SELECT into temporary table "tab2"
3096 */
3097 addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
3098 assert( p->addrOpenEphm[1] == -1 );
3099 p->addrOpenEphm[1] = addr;
3100 p->pPrior = 0;
3101 pLimit = p->pLimit;
3102 p->pLimit = 0;
3103 intersectdest.iSDParm = tab2;
3104 ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
drhaae0f742021-03-04 16:03:32 +00003105 sqlite3SelectOpName(p->op)));
drh5d7aef12022-11-22 19:49:16 +00003106 TREETRACE(0x400, pParse, p, ("multiSelect INTERSECT right...\n"));
drh03c39052018-05-02 14:24:34 +00003107 rc = sqlite3Select(pParse, p, &intersectdest);
3108 testcase( rc!=SQLITE_OK );
3109 pDelete = p->pPrior;
3110 p->pPrior = pPrior;
3111 if( p->nSelectRow>pPrior->nSelectRow ){
3112 p->nSelectRow = pPrior->nSelectRow;
3113 }
3114 sqlite3ExprDelete(db, p->pLimit);
3115 p->pLimit = pLimit;
3116
3117 /* Generate code to take the intersection of the two temporary
3118 ** tables.
3119 */
drh5f695122020-02-20 14:08:51 +00003120 if( rc ) break;
drh82c3d632000-06-06 21:56:07 +00003121 assert( p->pEList );
drhec4ccdb2018-12-29 02:26:59 +00003122 iBreak = sqlite3VdbeMakeLabel(pParse);
3123 iCont = sqlite3VdbeMakeLabel(pParse);
drhec7429a2005-10-06 16:53:14 +00003124 computeLimitRegisters(pParse, p, iBreak);
drh03c39052018-05-02 14:24:34 +00003125 sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
3126 r1 = sqlite3GetTempReg(pParse);
3127 iStart = sqlite3VdbeAddOp2(v, OP_RowData, tab1, r1);
3128 sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0);
3129 VdbeCoverage(v);
3130 sqlite3ReleaseTempReg(pParse, r1);
3131 selectInnerLoop(pParse, p, tab1,
drhe8e4af72012-09-21 00:04:28 +00003132 0, 0, &dest, iCont, iBreak);
danielk19774adee202004-05-08 08:23:19 +00003133 sqlite3VdbeResolveLabel(v, iCont);
drh03c39052018-05-02 14:24:34 +00003134 sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
danielk19774adee202004-05-08 08:23:19 +00003135 sqlite3VdbeResolveLabel(v, iBreak);
drh03c39052018-05-02 14:24:34 +00003136 sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
3137 sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
3138 break;
drh82c3d632000-06-06 21:56:07 +00003139 }
drh82c3d632000-06-06 21:56:07 +00003140 }
drh03c39052018-05-02 14:24:34 +00003141
3142 #ifndef SQLITE_OMIT_EXPLAIN
3143 if( p->pNext==0 ){
3144 ExplainQueryPlanPop(pParse);
drh82c3d632000-06-06 21:56:07 +00003145 }
drh03c39052018-05-02 14:24:34 +00003146 #endif
drh82c3d632000-06-06 21:56:07 +00003147 }
drh8428b3b2019-12-19 22:08:19 +00003148 if( pParse->nErr ) goto multi_select_end;
drh03c39052018-05-02 14:24:34 +00003149
drha9671a22008-07-08 23:40:20 +00003150 /* Compute collating sequences used by
3151 ** temporary tables needed to implement the compound select.
3152 ** Attach the KeyInfo structure to all temporary tables.
drh8cdbf832004-08-29 16:25:03 +00003153 **
3154 ** This section is run by the right-most SELECT statement only.
3155 ** SELECT statements to the left always skip this part. The right-most
3156 ** SELECT might also skip this part if it has no ORDER BY clause and
3157 ** no temp tables are required.
drhfbc4ee72004-08-29 01:31:05 +00003158 */
drh7d10d5a2008-08-20 16:35:10 +00003159 if( p->selFlags & SF_UsesEphemeral ){
drhfbc4ee72004-08-29 01:31:05 +00003160 int i; /* Loop counter */
3161 KeyInfo *pKeyInfo; /* Collating sequence for the result set */
drh0342b1f2005-09-01 03:07:44 +00003162 Select *pLoop; /* For looping through SELECT statements */
drhf68d7d12007-05-03 13:02:26 +00003163 CollSeq **apColl; /* For looping through pKeyInfo->aColl[] */
drh93a960a2008-07-10 00:32:42 +00003164 int nCol; /* Number of columns in result set */
drhfbc4ee72004-08-29 01:31:05 +00003165
drhd227a292014-02-09 18:02:09 +00003166 assert( p->pNext==0 );
drhaa6fe5b2021-10-04 13:18:44 +00003167 assert( p->pEList!=0 );
drh93a960a2008-07-10 00:32:42 +00003168 nCol = p->pEList->nExpr;
drhad124322013-10-23 13:30:58 +00003169 pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
danielk1977dc1bdc42004-06-11 10:51:27 +00003170 if( !pKeyInfo ){
mistachkinfad30392016-02-13 23:43:46 +00003171 rc = SQLITE_NOMEM_BKPT;
danielk1977dc1bdc42004-06-11 10:51:27 +00003172 goto multi_select_end;
3173 }
drh0342b1f2005-09-01 03:07:44 +00003174 for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
3175 *apColl = multiSelectCollSeq(pParse, p, i);
3176 if( 0==*apColl ){
drh633e6d52008-07-28 19:34:53 +00003177 *apColl = db->pDfltColl;
danielk1977dc1bdc42004-06-11 10:51:27 +00003178 }
3179 }
3180
drh0342b1f2005-09-01 03:07:44 +00003181 for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
3182 for(i=0; i<2; i++){
drhb9bb7c12006-06-11 23:41:55 +00003183 int addr = pLoop->addrOpenEphm[i];
drh0342b1f2005-09-01 03:07:44 +00003184 if( addr<0 ){
3185 /* If [0] is unused then [1] is also unused. So we can
3186 ** always safely abort as soon as the first unused slot is found */
drhb9bb7c12006-06-11 23:41:55 +00003187 assert( pLoop->addrOpenEphm[1]<0 );
drh0342b1f2005-09-01 03:07:44 +00003188 break;
3189 }
3190 sqlite3VdbeChangeP2(v, addr, nCol);
drh2ec2fb22013-11-06 19:59:23 +00003191 sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
3192 P4_KEYINFO);
drh0ee5a1e2007-01-26 19:04:00 +00003193 pLoop->addrOpenEphm[i] = -1;
drh0342b1f2005-09-01 03:07:44 +00003194 }
danielk1977dc1bdc42004-06-11 10:51:27 +00003195 }
drh2ec2fb22013-11-06 19:59:23 +00003196 sqlite3KeyInfoUnref(pKeyInfo);
danielk197784ac9d02004-05-18 09:58:06 +00003197 }
danielk1977dc1bdc42004-06-11 10:51:27 +00003198
3199multi_select_end:
drh2b596da2012-07-23 21:43:19 +00003200 pDest->iSdst = dest.iSdst;
3201 pDest->nSdst = dest.nSdst;
drhce68b6b2021-08-21 16:42:58 +00003202 if( pDelete ){
3203 sqlite3ParserAddCleanup(pParse,
3204 (void(*)(sqlite3*,void*))sqlite3SelectDelete,
3205 pDelete);
3206 }
danielk197784ac9d02004-05-18 09:58:06 +00003207 return rc;
drh22827922000-06-06 17:27:05 +00003208}
drhb7f91642004-10-31 02:22:47 +00003209#endif /* SQLITE_OMIT_COMPOUND_SELECT */
drh22827922000-06-06 17:27:05 +00003210
drhb21e7c72008-06-22 12:37:57 +00003211/*
mistachkin89b31d72015-07-16 17:29:27 +00003212** Error message for when two or more terms of a compound select have different
3213** size result sets.
3214*/
3215void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p){
3216 if( p->selFlags & SF_Values ){
3217 sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
3218 }else{
3219 sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
drhaae0f742021-03-04 16:03:32 +00003220 " do not have the same number of result columns",
3221 sqlite3SelectOpName(p->op));
mistachkin89b31d72015-07-16 17:29:27 +00003222 }
3223}
3224
3225/*
drhb21e7c72008-06-22 12:37:57 +00003226** Code an output subroutine for a coroutine implementation of a
3227** SELECT statment.
drh0acb7e42008-06-25 00:12:41 +00003228**
drh2b596da2012-07-23 21:43:19 +00003229** The data to be output is contained in pIn->iSdst. There are
3230** pIn->nSdst columns to be output. pDest is where the output should
drh0acb7e42008-06-25 00:12:41 +00003231** be sent.
3232**
3233** regReturn is the number of the register holding the subroutine
3234** return address.
3235**
drhf053d5b2010-08-09 14:26:32 +00003236** If regPrev>0 then it is the first register in a vector that
drh0acb7e42008-06-25 00:12:41 +00003237** records the previous output. mem[regPrev] is a flag that is false
3238** if there has been no previous output. If regPrev>0 then code is
3239** generated to suppress duplicates. pKeyInfo is used for comparing
3240** keys.
3241**
3242** If the LIMIT found in p->iLimit is reached, jump immediately to
3243** iBreak.
drhb21e7c72008-06-22 12:37:57 +00003244*/
drh0acb7e42008-06-25 00:12:41 +00003245static int generateOutputSubroutine(
drh92b01d52008-06-24 00:32:35 +00003246 Parse *pParse, /* Parsing context */
3247 Select *p, /* The SELECT statement */
3248 SelectDest *pIn, /* Coroutine supplying data */
3249 SelectDest *pDest, /* Where to send the data */
3250 int regReturn, /* The return address register */
drh0acb7e42008-06-25 00:12:41 +00003251 int regPrev, /* Previous result register. No uniqueness if 0 */
3252 KeyInfo *pKeyInfo, /* For comparing with previous entry */
drh92b01d52008-06-24 00:32:35 +00003253 int iBreak /* Jump here if we hit the LIMIT */
drhb21e7c72008-06-22 12:37:57 +00003254){
3255 Vdbe *v = pParse->pVdbe;
drh92b01d52008-06-24 00:32:35 +00003256 int iContinue;
3257 int addr;
drhb21e7c72008-06-22 12:37:57 +00003258
drh92b01d52008-06-24 00:32:35 +00003259 addr = sqlite3VdbeCurrentAddr(v);
drhec4ccdb2018-12-29 02:26:59 +00003260 iContinue = sqlite3VdbeMakeLabel(pParse);
drh0acb7e42008-06-25 00:12:41 +00003261
3262 /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
3263 */
3264 if( regPrev ){
drh728e0f92015-10-10 14:41:28 +00003265 int addr1, addr2;
3266 addr1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
3267 addr2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
drh2ec2fb22013-11-06 19:59:23 +00003268 (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
drh728e0f92015-10-10 14:41:28 +00003269 sqlite3VdbeAddOp3(v, OP_Jump, addr2+2, iContinue, addr2+2); VdbeCoverage(v);
3270 sqlite3VdbeJumpHere(v, addr1);
drhe8e4af72012-09-21 00:04:28 +00003271 sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
drhec86c722011-12-09 17:27:51 +00003272 sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
drh0acb7e42008-06-25 00:12:41 +00003273 }
danielk19771f9caa42008-07-02 16:10:45 +00003274 if( pParse->db->mallocFailed ) return 0;
drh0acb7e42008-06-25 00:12:41 +00003275
mistachkind5578432012-08-25 10:01:29 +00003276 /* Suppress the first OFFSET entries if there is an OFFSET clause
drh0acb7e42008-06-25 00:12:41 +00003277 */
drhaa9ce702014-01-22 18:07:04 +00003278 codeOffset(v, p->iOffset, iContinue);
drhb21e7c72008-06-22 12:37:57 +00003279
drhe2248cf2015-05-22 17:29:27 +00003280 assert( pDest->eDest!=SRT_Exists );
3281 assert( pDest->eDest!=SRT_Table );
drhb21e7c72008-06-22 12:37:57 +00003282 switch( pDest->eDest ){
3283 /* Store the result as data using a unique key.
3284 */
drhb21e7c72008-06-22 12:37:57 +00003285 case SRT_EphemTab: {
3286 int r1 = sqlite3GetTempReg(pParse);
3287 int r2 = sqlite3GetTempReg(pParse);
drh2b596da2012-07-23 21:43:19 +00003288 sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
3289 sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
3290 sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
drhb21e7c72008-06-22 12:37:57 +00003291 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
3292 sqlite3ReleaseTempReg(pParse, r2);
3293 sqlite3ReleaseTempReg(pParse, r1);
3294 break;
3295 }
3296
3297#ifndef SQLITE_OMIT_SUBQUERY
drh14318072016-09-06 18:51:25 +00003298 /* If we are creating a set for an "expr IN (SELECT ...)".
drhb21e7c72008-06-22 12:37:57 +00003299 */
3300 case SRT_Set: {
drh6fccc352008-06-27 00:52:45 +00003301 int r1;
drh63cecc42016-09-06 19:08:21 +00003302 testcase( pIn->nSdst>1 );
drhb21e7c72008-06-22 12:37:57 +00003303 r1 = sqlite3GetTempReg(pParse);
dan71c57db2016-07-09 20:23:55 +00003304 sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst,
drh14318072016-09-06 18:51:25 +00003305 r1, pDest->zAffSdst, pIn->nSdst);
drh9b4eaeb2016-11-09 00:10:33 +00003306 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pDest->iSDParm, r1,
3307 pIn->iSdst, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003308 sqlite3ReleaseTempReg(pParse, r1);
drhb21e7c72008-06-22 12:37:57 +00003309 break;
3310 }
3311
drhb21e7c72008-06-22 12:37:57 +00003312 /* If this is a scalar select that is part of an expression, then
3313 ** store the results in the appropriate memory cell and break out
drhcb99c572019-08-09 20:26:01 +00003314 ** of the scan loop. Note that the select might return multiple columns
3315 ** if it is the RHS of a row-value IN operator.
drhb21e7c72008-06-22 12:37:57 +00003316 */
3317 case SRT_Mem: {
drh5f0922b2021-03-04 16:32:28 +00003318 testcase( pIn->nSdst>1 );
3319 sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003320 /* The LIMIT clause will jump out of the loop for us */
3321 break;
3322 }
3323#endif /* #ifndef SQLITE_OMIT_SUBQUERY */
3324
drh7d10d5a2008-08-20 16:35:10 +00003325 /* The results are stored in a sequence of registers
drh2b596da2012-07-23 21:43:19 +00003326 ** starting at pDest->iSdst. Then the co-routine yields.
drhb21e7c72008-06-22 12:37:57 +00003327 */
drh92b01d52008-06-24 00:32:35 +00003328 case SRT_Coroutine: {
drh2b596da2012-07-23 21:43:19 +00003329 if( pDest->iSdst==0 ){
3330 pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
3331 pDest->nSdst = pIn->nSdst;
drhb21e7c72008-06-22 12:37:57 +00003332 }
dan4b79bde2015-04-21 15:49:04 +00003333 sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pIn->nSdst);
drh2b596da2012-07-23 21:43:19 +00003334 sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
drh92b01d52008-06-24 00:32:35 +00003335 break;
3336 }
3337
drhccfcbce2009-05-18 15:46:07 +00003338 /* If none of the above, then the result destination must be
3339 ** SRT_Output. This routine is never called with any other
3340 ** destination other than the ones handled above or SRT_Output.
3341 **
3342 ** For SRT_Output, results are stored in a sequence of registers.
3343 ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
3344 ** return the next row of result.
drh7d10d5a2008-08-20 16:35:10 +00003345 */
drhccfcbce2009-05-18 15:46:07 +00003346 default: {
3347 assert( pDest->eDest==SRT_Output );
drh2b596da2012-07-23 21:43:19 +00003348 sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
drhb21e7c72008-06-22 12:37:57 +00003349 break;
3350 }
drhb21e7c72008-06-22 12:37:57 +00003351 }
drh92b01d52008-06-24 00:32:35 +00003352
3353 /* Jump to the end of the loop if the LIMIT is reached.
3354 */
3355 if( p->iLimit ){
drh16897072015-03-07 00:57:37 +00003356 sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003357 }
3358
drh92b01d52008-06-24 00:32:35 +00003359 /* Generate the subroutine return
3360 */
drh0acb7e42008-06-25 00:12:41 +00003361 sqlite3VdbeResolveLabel(v, iContinue);
drh92b01d52008-06-24 00:32:35 +00003362 sqlite3VdbeAddOp1(v, OP_Return, regReturn);
3363
3364 return addr;
drhb21e7c72008-06-22 12:37:57 +00003365}
3366
3367/*
3368** Alternative compound select code generator for cases when there
3369** is an ORDER BY clause.
3370**
3371** We assume a query of the following form:
3372**
3373** <selectA> <operator> <selectB> ORDER BY <orderbylist>
3374**
3375** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT. The idea
3376** is to code both <selectA> and <selectB> with the ORDER BY clause as
3377** co-routines. Then run the co-routines in parallel and merge the results
3378** into the output. In addition to the two coroutines (called selectA and
3379** selectB) there are 7 subroutines:
3380**
3381** outA: Move the output of the selectA coroutine into the output
3382** of the compound query.
3383**
3384** outB: Move the output of the selectB coroutine into the output
3385** of the compound query. (Only generated for UNION and
3386** UNION ALL. EXCEPT and INSERTSECT never output a row that
3387** appears only in B.)
3388**
3389** AltB: Called when there is data from both coroutines and A<B.
3390**
3391** AeqB: Called when there is data from both coroutines and A==B.
3392**
3393** AgtB: Called when there is data from both coroutines and A>B.
3394**
3395** EofA: Called when data is exhausted from selectA.
3396**
3397** EofB: Called when data is exhausted from selectB.
3398**
3399** The implementation of the latter five subroutines depend on which
3400** <operator> is used:
3401**
3402**
3403** UNION ALL UNION EXCEPT INTERSECT
3404** ------------- ----------------- -------------- -----------------
drh0acb7e42008-06-25 00:12:41 +00003405** AltB: outA, nextA outA, nextA outA, nextA nextA
drhb21e7c72008-06-22 12:37:57 +00003406**
drh0acb7e42008-06-25 00:12:41 +00003407** AeqB: outA, nextA nextA nextA outA, nextA
drhb21e7c72008-06-22 12:37:57 +00003408**
drh0acb7e42008-06-25 00:12:41 +00003409** AgtB: outB, nextB outB, nextB nextB nextB
drhb21e7c72008-06-22 12:37:57 +00003410**
drh0acb7e42008-06-25 00:12:41 +00003411** EofA: outB, nextB outB, nextB halt halt
drhb21e7c72008-06-22 12:37:57 +00003412**
drh0acb7e42008-06-25 00:12:41 +00003413** EofB: outA, nextA outA, nextA outA, nextA halt
3414**
3415** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
3416** causes an immediate jump to EofA and an EOF on B following nextB causes
3417** an immediate jump to EofB. Within EofA and EofB, and EOF on entry or
3418** following nextX causes a jump to the end of the select processing.
3419**
3420** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
3421** within the output subroutine. The regPrev register set holds the previously
3422** output value. A comparison is made against this value and the output
3423** is skipped if the next results would be the same as the previous.
drhb21e7c72008-06-22 12:37:57 +00003424**
3425** The implementation plan is to implement the two coroutines and seven
3426** subroutines first, then put the control logic at the bottom. Like this:
3427**
3428** goto Init
3429** coA: coroutine for left query (A)
3430** coB: coroutine for right query (B)
3431** outA: output one row of A
3432** outB: output one row of B (UNION and UNION ALL only)
3433** EofA: ...
3434** EofB: ...
3435** AltB: ...
3436** AeqB: ...
3437** AgtB: ...
3438** Init: initialize coroutine registers
3439** yield coA
3440** if eof(A) goto EofA
3441** yield coB
3442** if eof(B) goto EofB
3443** Cmpr: Compare A, B
3444** Jump AltB, AeqB, AgtB
3445** End: ...
3446**
3447** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
3448** actually called using Gosub and they do not Return. EofA and EofB loop
3449** until all data is exhausted then jump to the "end" labe. AltB, AeqB,
3450** and AgtB jump to either L2 or to one of EofA or EofB.
3451*/
danielk1977de3e41e2008-08-04 03:51:24 +00003452#ifndef SQLITE_OMIT_COMPOUND_SELECT
drhb21e7c72008-06-22 12:37:57 +00003453static int multiSelectOrderBy(
3454 Parse *pParse, /* Parsing context */
3455 Select *p, /* The right-most of SELECTs to be coded */
drha9671a22008-07-08 23:40:20 +00003456 SelectDest *pDest /* What to do with query results */
drhb21e7c72008-06-22 12:37:57 +00003457){
drh0acb7e42008-06-25 00:12:41 +00003458 int i, j; /* Loop counters */
drhb21e7c72008-06-22 12:37:57 +00003459 Select *pPrior; /* Another SELECT immediately to our left */
drh38cebe02021-12-30 00:37:11 +00003460 Select *pSplit; /* Left-most SELECT in the right-hand group */
3461 int nSelect; /* Number of SELECT statements in the compound */
drhb21e7c72008-06-22 12:37:57 +00003462 Vdbe *v; /* Generate code to this VDBE */
drhb21e7c72008-06-22 12:37:57 +00003463 SelectDest destA; /* Destination for coroutine A */
3464 SelectDest destB; /* Destination for coroutine B */
drh92b01d52008-06-24 00:32:35 +00003465 int regAddrA; /* Address register for select-A coroutine */
drh92b01d52008-06-24 00:32:35 +00003466 int regAddrB; /* Address register for select-B coroutine */
drh92b01d52008-06-24 00:32:35 +00003467 int addrSelectA; /* Address of the select-A coroutine */
3468 int addrSelectB; /* Address of the select-B coroutine */
3469 int regOutA; /* Address register for the output-A subroutine */
3470 int regOutB; /* Address register for the output-B subroutine */
3471 int addrOutA; /* Address of the output-A subroutine */
drhb27b7f52008-12-10 18:03:45 +00003472 int addrOutB = 0; /* Address of the output-B subroutine */
drh92b01d52008-06-24 00:32:35 +00003473 int addrEofA; /* Address of the select-A-exhausted subroutine */
drh81cf13e2014-02-07 18:27:53 +00003474 int addrEofA_noB; /* Alternate addrEofA if B is uninitialized */
drh92b01d52008-06-24 00:32:35 +00003475 int addrEofB; /* Address of the select-B-exhausted subroutine */
3476 int addrAltB; /* Address of the A<B subroutine */
3477 int addrAeqB; /* Address of the A==B subroutine */
3478 int addrAgtB; /* Address of the A>B subroutine */
3479 int regLimitA; /* Limit register for select-A */
3480 int regLimitB; /* Limit register for select-A */
drh0acb7e42008-06-25 00:12:41 +00003481 int regPrev; /* A range of registers to hold previous output */
drh92b01d52008-06-24 00:32:35 +00003482 int savedLimit; /* Saved value of p->iLimit */
3483 int savedOffset; /* Saved value of p->iOffset */
3484 int labelCmpr; /* Label for the start of the merge algorithm */
3485 int labelEnd; /* Label for the end of the overall SELECT stmt */
drh728e0f92015-10-10 14:41:28 +00003486 int addr1; /* Jump instructions that get retargetted */
drh92b01d52008-06-24 00:32:35 +00003487 int op; /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
drh96067812008-09-23 09:36:10 +00003488 KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
drh0acb7e42008-06-25 00:12:41 +00003489 KeyInfo *pKeyMerge; /* Comparison information for merging rows */
3490 sqlite3 *db; /* Database connection */
3491 ExprList *pOrderBy; /* The ORDER BY clause */
3492 int nOrderBy; /* Number of terms in the ORDER BY clause */
drhabc38152020-07-22 13:38:04 +00003493 u32 *aPermute; /* Mapping from ORDER BY terms to result set columns */
drhb21e7c72008-06-22 12:37:57 +00003494
drh92b01d52008-06-24 00:32:35 +00003495 assert( p->pOrderBy!=0 );
drh96067812008-09-23 09:36:10 +00003496 assert( pKeyDup==0 ); /* "Managed" code needs this. Ticket #3382. */
drh0acb7e42008-06-25 00:12:41 +00003497 db = pParse->db;
drh92b01d52008-06-24 00:32:35 +00003498 v = pParse->pVdbe;
drhccfcbce2009-05-18 15:46:07 +00003499 assert( v!=0 ); /* Already thrown the error if VDBE alloc failed */
drhec4ccdb2018-12-29 02:26:59 +00003500 labelEnd = sqlite3VdbeMakeLabel(pParse);
3501 labelCmpr = sqlite3VdbeMakeLabel(pParse);
drh0acb7e42008-06-25 00:12:41 +00003502
drh92b01d52008-06-24 00:32:35 +00003503
3504 /* Patch up the ORDER BY clause
3505 */
3506 op = p->op;
drh38cebe02021-12-30 00:37:11 +00003507 assert( p->pPrior->pOrderBy==0 );
drh0acb7e42008-06-25 00:12:41 +00003508 pOrderBy = p->pOrderBy;
drh93a960a2008-07-10 00:32:42 +00003509 assert( pOrderBy );
drh93a960a2008-07-10 00:32:42 +00003510 nOrderBy = pOrderBy->nExpr;
3511
drh0acb7e42008-06-25 00:12:41 +00003512 /* For operators other than UNION ALL we have to make sure that
3513 ** the ORDER BY clause covers every term of the result set. Add
3514 ** terms to the ORDER BY clause as necessary.
3515 */
3516 if( op!=TK_ALL ){
3517 for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
drh7d10d5a2008-08-20 16:35:10 +00003518 struct ExprList_item *pItem;
3519 for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
drh7d4c94b2021-10-04 22:34:38 +00003520 assert( pItem!=0 );
drhc2acc4e2013-11-15 18:15:19 +00003521 assert( pItem->u.x.iOrderByCol>0 );
3522 if( pItem->u.x.iOrderByCol==i ) break;
drh0acb7e42008-06-25 00:12:41 +00003523 }
3524 if( j==nOrderBy ){
drhb7916a72009-05-27 10:31:29 +00003525 Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
mistachkinfad30392016-02-13 23:43:46 +00003526 if( pNew==0 ) return SQLITE_NOMEM_BKPT;
drh0acb7e42008-06-25 00:12:41 +00003527 pNew->flags |= EP_IntValue;
drh33e619f2009-05-28 01:00:55 +00003528 pNew->u.iValue = i;
drh43606172017-04-05 11:32:13 +00003529 p->pOrderBy = pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
drhc2acc4e2013-11-15 18:15:19 +00003530 if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
drh0acb7e42008-06-25 00:12:41 +00003531 }
3532 }
3533 }
3534
3535 /* Compute the comparison permutation and keyinfo that is used with
drh10c081a2009-04-16 00:24:23 +00003536 ** the permutation used to determine if the next
drh0acb7e42008-06-25 00:12:41 +00003537 ** row of results comes from selectA or selectB. Also add explicit
3538 ** collations to the ORDER BY clause terms so that when the subqueries
3539 ** to the right and the left are evaluated, they use the correct
3540 ** collation.
3541 */
drhabc38152020-07-22 13:38:04 +00003542 aPermute = sqlite3DbMallocRawNN(db, sizeof(u32)*(nOrderBy + 1));
drh0acb7e42008-06-25 00:12:41 +00003543 if( aPermute ){
drh7d10d5a2008-08-20 16:35:10 +00003544 struct ExprList_item *pItem;
drhb1702022016-01-30 00:45:18 +00003545 aPermute[0] = nOrderBy;
3546 for(i=1, pItem=pOrderBy->a; i<=nOrderBy; i++, pItem++){
drh7d4c94b2021-10-04 22:34:38 +00003547 assert( pItem!=0 );
drh67366182015-04-16 14:33:35 +00003548 assert( pItem->u.x.iOrderByCol>0 );
drh2ec18a32015-06-23 23:31:52 +00003549 assert( pItem->u.x.iOrderByCol<=p->pEList->nExpr );
drhc2acc4e2013-11-15 18:15:19 +00003550 aPermute[i] = pItem->u.x.iOrderByCol - 1;
drh0acb7e42008-06-25 00:12:41 +00003551 }
dan53bed452014-01-24 20:37:18 +00003552 pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
drh0acb7e42008-06-25 00:12:41 +00003553 }else{
3554 pKeyMerge = 0;
3555 }
3556
drh0acb7e42008-06-25 00:12:41 +00003557 /* Allocate a range of temporary registers and the KeyInfo needed
3558 ** for the logic that removes duplicate result rows when the
3559 ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
3560 */
3561 if( op==TK_ALL ){
3562 regPrev = 0;
3563 }else{
3564 int nExpr = p->pEList->nExpr;
drh1c0dc822008-10-30 22:13:23 +00003565 assert( nOrderBy>=nExpr || db->mallocFailed );
drhc8ac0d12013-02-16 02:41:01 +00003566 regPrev = pParse->nMem+1;
3567 pParse->nMem += nExpr+1;
drh0acb7e42008-06-25 00:12:41 +00003568 sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
drhad124322013-10-23 13:30:58 +00003569 pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
drh0acb7e42008-06-25 00:12:41 +00003570 if( pKeyDup ){
drh2ec2fb22013-11-06 19:59:23 +00003571 assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
drh0acb7e42008-06-25 00:12:41 +00003572 for(i=0; i<nExpr; i++){
3573 pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
dan6e118922019-08-12 16:36:38 +00003574 pKeyDup->aSortFlags[i] = 0;
drh0acb7e42008-06-25 00:12:41 +00003575 }
3576 }
3577 }
drh92b01d52008-06-24 00:32:35 +00003578
3579 /* Separate the left and the right query from one another
3580 */
drh38cebe02021-12-30 00:37:11 +00003581 nSelect = 1;
3582 if( (op==TK_ALL || op==TK_UNION)
3583 && OptimizationEnabled(db, SQLITE_BalancedMerge)
3584 ){
3585 for(pSplit=p; pSplit->pPrior!=0 && pSplit->op==op; pSplit=pSplit->pPrior){
3586 nSelect++;
3587 assert( pSplit->pPrior->pNext==pSplit );
3588 }
3589 }
3590 if( nSelect<=3 ){
3591 pSplit = p;
3592 }else{
3593 pSplit = p;
3594 for(i=2; i<nSelect; i+=2){ pSplit = pSplit->pPrior; }
3595 }
3596 pPrior = pSplit->pPrior;
drh98bb34c2022-01-20 12:58:15 +00003597 assert( pPrior!=0 );
drh38cebe02021-12-30 00:37:11 +00003598 pSplit->pPrior = 0;
drhd227a292014-02-09 18:02:09 +00003599 pPrior->pNext = 0;
drh38cebe02021-12-30 00:37:11 +00003600 assert( p->pOrderBy == pOrderBy );
3601 assert( pOrderBy!=0 || db->mallocFailed );
3602 pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
drh9aff8242021-12-30 17:46:15 +00003603 sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
3604 sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
drh0acb7e42008-06-25 00:12:41 +00003605
drh92b01d52008-06-24 00:32:35 +00003606 /* Compute the limit registers */
3607 computeLimitRegisters(pParse, p, labelEnd);
drh0acb7e42008-06-25 00:12:41 +00003608 if( p->iLimit && op==TK_ALL ){
drh92b01d52008-06-24 00:32:35 +00003609 regLimitA = ++pParse->nMem;
3610 regLimitB = ++pParse->nMem;
3611 sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
3612 regLimitA);
3613 sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
3614 }else{
3615 regLimitA = regLimitB = 0;
3616 }
drh633e6d52008-07-28 19:34:53 +00003617 sqlite3ExprDelete(db, p->pLimit);
drh0acb7e42008-06-25 00:12:41 +00003618 p->pLimit = 0;
drh92b01d52008-06-24 00:32:35 +00003619
drhb21e7c72008-06-22 12:37:57 +00003620 regAddrA = ++pParse->nMem;
drhb21e7c72008-06-22 12:37:57 +00003621 regAddrB = ++pParse->nMem;
drhb21e7c72008-06-22 12:37:57 +00003622 regOutA = ++pParse->nMem;
3623 regOutB = ++pParse->nMem;
3624 sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
3625 sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
drhe2ca99c2018-05-02 00:33:43 +00003626
drhaae0f742021-03-04 16:03:32 +00003627 ExplainQueryPlan((pParse, 1, "MERGE (%s)", sqlite3SelectOpName(p->op)));
drhb21e7c72008-06-22 12:37:57 +00003628
drh92b01d52008-06-24 00:32:35 +00003629 /* Generate a coroutine to evaluate the SELECT statement to the
drh0acb7e42008-06-25 00:12:41 +00003630 ** left of the compound operator - the "A" select.
3631 */
drhed71a832014-02-07 19:18:10 +00003632 addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
drh728e0f92015-10-10 14:41:28 +00003633 addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
drhed71a832014-02-07 19:18:10 +00003634 VdbeComment((v, "left SELECT"));
drh92b01d52008-06-24 00:32:35 +00003635 pPrior->iLimit = regLimitA;
drhc631ded2018-05-02 02:22:22 +00003636 ExplainQueryPlan((pParse, 1, "LEFT"));
drh7d10d5a2008-08-20 16:35:10 +00003637 sqlite3Select(pParse, pPrior, &destA);
drh2fade2f2016-02-09 02:12:20 +00003638 sqlite3VdbeEndCoroutine(v, regAddrA);
drh728e0f92015-10-10 14:41:28 +00003639 sqlite3VdbeJumpHere(v, addr1);
drhb21e7c72008-06-22 12:37:57 +00003640
drh92b01d52008-06-24 00:32:35 +00003641 /* Generate a coroutine to evaluate the SELECT statement on
3642 ** the right - the "B" select
3643 */
drhed71a832014-02-07 19:18:10 +00003644 addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
drh728e0f92015-10-10 14:41:28 +00003645 addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
drhed71a832014-02-07 19:18:10 +00003646 VdbeComment((v, "right SELECT"));
drh92b01d52008-06-24 00:32:35 +00003647 savedLimit = p->iLimit;
3648 savedOffset = p->iOffset;
3649 p->iLimit = regLimitB;
3650 p->iOffset = 0;
drhc631ded2018-05-02 02:22:22 +00003651 ExplainQueryPlan((pParse, 1, "RIGHT"));
drh7d10d5a2008-08-20 16:35:10 +00003652 sqlite3Select(pParse, p, &destB);
drh92b01d52008-06-24 00:32:35 +00003653 p->iLimit = savedLimit;
3654 p->iOffset = savedOffset;
drh2fade2f2016-02-09 02:12:20 +00003655 sqlite3VdbeEndCoroutine(v, regAddrB);
drhb21e7c72008-06-22 12:37:57 +00003656
drh92b01d52008-06-24 00:32:35 +00003657 /* Generate a subroutine that outputs the current row of the A
drh0acb7e42008-06-25 00:12:41 +00003658 ** select as the next output row of the compound select.
drh92b01d52008-06-24 00:32:35 +00003659 */
drhb21e7c72008-06-22 12:37:57 +00003660 VdbeNoopComment((v, "Output routine for A"));
drh0acb7e42008-06-25 00:12:41 +00003661 addrOutA = generateOutputSubroutine(pParse,
3662 p, &destA, pDest, regOutA,
drh2ec2fb22013-11-06 19:59:23 +00003663 regPrev, pKeyDup, labelEnd);
drhb21e7c72008-06-22 12:37:57 +00003664
drh92b01d52008-06-24 00:32:35 +00003665 /* Generate a subroutine that outputs the current row of the B
drh0acb7e42008-06-25 00:12:41 +00003666 ** select as the next output row of the compound select.
drh92b01d52008-06-24 00:32:35 +00003667 */
drh0acb7e42008-06-25 00:12:41 +00003668 if( op==TK_ALL || op==TK_UNION ){
3669 VdbeNoopComment((v, "Output routine for B"));
3670 addrOutB = generateOutputSubroutine(pParse,
3671 p, &destB, pDest, regOutB,
drh2ec2fb22013-11-06 19:59:23 +00003672 regPrev, pKeyDup, labelEnd);
drh0acb7e42008-06-25 00:12:41 +00003673 }
drh2ec2fb22013-11-06 19:59:23 +00003674 sqlite3KeyInfoUnref(pKeyDup);
drhb21e7c72008-06-22 12:37:57 +00003675
drh92b01d52008-06-24 00:32:35 +00003676 /* Generate a subroutine to run when the results from select A
3677 ** are exhausted and only data in select B remains.
3678 */
drhb21e7c72008-06-22 12:37:57 +00003679 if( op==TK_EXCEPT || op==TK_INTERSECT ){
drh81cf13e2014-02-07 18:27:53 +00003680 addrEofA_noB = addrEofA = labelEnd;
drhb21e7c72008-06-22 12:37:57 +00003681 }else{
drh81cf13e2014-02-07 18:27:53 +00003682 VdbeNoopComment((v, "eof-A subroutine"));
3683 addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3684 addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
drh688852a2014-02-17 22:40:43 +00003685 VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003686 sqlite3VdbeGoto(v, addrEofA);
drhc3489bb2016-02-25 16:04:59 +00003687 p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
drhb21e7c72008-06-22 12:37:57 +00003688 }
3689
drh92b01d52008-06-24 00:32:35 +00003690 /* Generate a subroutine to run when the results from select B
3691 ** are exhausted and only data in select A remains.
3692 */
drhb21e7c72008-06-22 12:37:57 +00003693 if( op==TK_INTERSECT ){
drh92b01d52008-06-24 00:32:35 +00003694 addrEofB = addrEofA;
drh95aa47b2010-11-16 02:49:15 +00003695 if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
drhb21e7c72008-06-22 12:37:57 +00003696 }else{
drh92b01d52008-06-24 00:32:35 +00003697 VdbeNoopComment((v, "eof-B subroutine"));
drh81cf13e2014-02-07 18:27:53 +00003698 addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
drh688852a2014-02-17 22:40:43 +00003699 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003700 sqlite3VdbeGoto(v, addrEofB);
drhb21e7c72008-06-22 12:37:57 +00003701 }
3702
drh92b01d52008-06-24 00:32:35 +00003703 /* Generate code to handle the case of A<B
3704 */
drhb21e7c72008-06-22 12:37:57 +00003705 VdbeNoopComment((v, "A-lt-B subroutine"));
drh0acb7e42008-06-25 00:12:41 +00003706 addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
drh688852a2014-02-17 22:40:43 +00003707 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003708 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003709
drh92b01d52008-06-24 00:32:35 +00003710 /* Generate code to handle the case of A==B
3711 */
drhb21e7c72008-06-22 12:37:57 +00003712 if( op==TK_ALL ){
3713 addrAeqB = addrAltB;
drh0acb7e42008-06-25 00:12:41 +00003714 }else if( op==TK_INTERSECT ){
3715 addrAeqB = addrAltB;
3716 addrAltB++;
drh92b01d52008-06-24 00:32:35 +00003717 }else{
drhb21e7c72008-06-22 12:37:57 +00003718 VdbeNoopComment((v, "A-eq-B subroutine"));
drh0acb7e42008-06-25 00:12:41 +00003719 addrAeqB =
drh688852a2014-02-17 22:40:43 +00003720 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003721 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003722 }
3723
drh92b01d52008-06-24 00:32:35 +00003724 /* Generate code to handle the case of A>B
3725 */
drhb21e7c72008-06-22 12:37:57 +00003726 VdbeNoopComment((v, "A-gt-B subroutine"));
3727 addrAgtB = sqlite3VdbeCurrentAddr(v);
3728 if( op==TK_ALL || op==TK_UNION ){
3729 sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3730 }
drh688852a2014-02-17 22:40:43 +00003731 sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
drh076e85f2015-09-03 13:46:12 +00003732 sqlite3VdbeGoto(v, labelCmpr);
drhb21e7c72008-06-22 12:37:57 +00003733
drh92b01d52008-06-24 00:32:35 +00003734 /* This code runs once to initialize everything.
3735 */
drh728e0f92015-10-10 14:41:28 +00003736 sqlite3VdbeJumpHere(v, addr1);
drh688852a2014-02-17 22:40:43 +00003737 sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
3738 sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003739
3740 /* Implement the main merge loop
3741 */
3742 sqlite3VdbeResolveLabel(v, labelCmpr);
drh0acb7e42008-06-25 00:12:41 +00003743 sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
drh2b596da2012-07-23 21:43:19 +00003744 sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
drh2ec2fb22013-11-06 19:59:23 +00003745 (char*)pKeyMerge, P4_KEYINFO);
drh953f7612012-12-07 22:18:54 +00003746 sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
drh688852a2014-02-17 22:40:43 +00003747 sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
drh92b01d52008-06-24 00:32:35 +00003748
3749 /* Jump to the this point in order to terminate the query.
3750 */
drhb21e7c72008-06-22 12:37:57 +00003751 sqlite3VdbeResolveLabel(v, labelEnd);
drh92b01d52008-06-24 00:32:35 +00003752
drh54422232022-11-07 15:23:51 +00003753 /* Make arrangements to free the 2nd and subsequent arms of the compound
3754 ** after the parse has finished */
drh38cebe02021-12-30 00:37:11 +00003755 if( pSplit->pPrior ){
drh44132242022-09-01 13:51:09 +00003756 sqlite3ParserAddCleanup(pParse,
3757 (void(*)(sqlite3*,void*))sqlite3SelectDelete, pSplit->pPrior);
danielk19775e7ad502008-07-01 17:39:27 +00003758 }
drh38cebe02021-12-30 00:37:11 +00003759 pSplit->pPrior = pPrior;
3760 pPrior->pNext = pSplit;
dancd0b2452021-04-12 12:02:49 +00003761 sqlite3ExprListDelete(db, pPrior->pOrderBy);
3762 pPrior->pOrderBy = 0;
3763
drh92b01d52008-06-24 00:32:35 +00003764 /*** TBD: Insert subroutine calls to close cursors on incomplete
3765 **** subqueries ****/
drhe2ca99c2018-05-02 00:33:43 +00003766 ExplainQueryPlanPop(pParse);
drh3dc4cc62015-04-15 07:10:25 +00003767 return pParse->nErr!=0;
drhb21e7c72008-06-22 12:37:57 +00003768}
danielk1977de3e41e2008-08-04 03:51:24 +00003769#endif
drhb21e7c72008-06-22 12:37:57 +00003770
shane3514b6f2008-07-22 05:00:55 +00003771#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh46967de2017-04-14 12:39:37 +00003772
3773/* An instance of the SubstContext object describes an substitution edit
3774** to be performed on a parse tree.
3775**
3776** All references to columns in table iTable are to be replaced by corresponding
3777** expressions in pEList.
drhc133bab2022-04-11 20:15:52 +00003778**
3779** ## About "isOuterJoin":
3780**
3781** The isOuterJoin column indicates that the replacement will occur into a
3782** position in the parent that NULL-able due to an OUTER JOIN. Either the
3783** target slot in the parent is the right operand of a LEFT JOIN, or one of
3784** the left operands of a RIGHT JOIN. In either case, we need to potentially
3785** bypass the substituted expression with OP_IfNullRow.
3786**
drh40c9bec2022-09-20 16:57:49 +00003787** Suppose the original expression is an integer constant. Even though the table
drhc133bab2022-04-11 20:15:52 +00003788** has the nullRow flag set, because the expression is an integer constant,
3789** it will not be NULLed out. So instead, we insert an OP_IfNullRow opcode
3790** that checks to see if the nullRow flag is set on the table. If the nullRow
3791** flag is set, then the value in the register is set to NULL and the original
3792** expression is bypassed. If the nullRow flag is not set, then the original
3793** expression runs to populate the register.
3794**
3795** Example where this is needed:
3796**
3797** CREATE TABLE t1(a INTEGER PRIMARY KEY, b INT);
3798** CREATE TABLE t2(x INT UNIQUE);
3799**
3800** SELECT a,b,m,x FROM t1 LEFT JOIN (SELECT 59 AS m,x FROM t2) ON b=x;
3801**
3802** When the subquery on the right side of the LEFT JOIN is flattened, we
3803** have to add OP_IfNullRow in front of the OP_Integer that implements the
3804** "m" value of the subquery so that a NULL will be loaded instead of 59
3805** when processing a non-matched row of the left.
drh46967de2017-04-14 12:39:37 +00003806*/
3807typedef struct SubstContext {
3808 Parse *pParse; /* The parsing context */
3809 int iTable; /* Replace references to this table */
drh31d6fd52017-04-14 19:03:10 +00003810 int iNewTable; /* New table number */
drhc133bab2022-04-11 20:15:52 +00003811 int isOuterJoin; /* Add TK_IF_NULL_ROW opcodes on each replacement */
drh46967de2017-04-14 12:39:37 +00003812 ExprList *pEList; /* Replacement expressions */
dan879164e2022-10-14 19:30:34 +00003813 ExprList *pCList; /* Collation sequences for replacement expr */
drh46967de2017-04-14 12:39:37 +00003814} SubstContext;
3815
drh17435752007-08-16 04:30:38 +00003816/* Forward Declarations */
drh46967de2017-04-14 12:39:37 +00003817static void substExprList(SubstContext*, ExprList*);
3818static void substSelect(SubstContext*, Select*, int);
drh17435752007-08-16 04:30:38 +00003819
drh22827922000-06-06 17:27:05 +00003820/*
drh832508b2002-03-02 17:04:07 +00003821** Scan through the expression pExpr. Replace every reference to
drh6a3ea0e2003-05-02 14:32:12 +00003822** a column in table number iTable with a copy of the iColumn-th
drh84e59202002-03-14 14:33:31 +00003823** entry in pEList. (But leave references to the ROWID column
drh6a3ea0e2003-05-02 14:32:12 +00003824** unchanged.)
drh832508b2002-03-02 17:04:07 +00003825**
3826** This routine is part of the flattening procedure. A subquery
3827** whose result set is defined by pEList appears as entry in the
3828** FROM clause of a SELECT such that the VDBE cursor assigned to that
drhaca19e12017-04-07 19:41:31 +00003829** FORM clause entry is iTable. This routine makes the necessary
drh832508b2002-03-02 17:04:07 +00003830** changes to pExpr so that it refers directly to the source table
3831** of the subquery rather the result set of the subquery.
3832*/
drhb7916a72009-05-27 10:31:29 +00003833static Expr *substExpr(
drh46967de2017-04-14 12:39:37 +00003834 SubstContext *pSubst, /* Description of the substitution */
3835 Expr *pExpr /* Expr in which substitution occurs */
drh17435752007-08-16 04:30:38 +00003836){
drhb7916a72009-05-27 10:31:29 +00003837 if( pExpr==0 ) return 0;
drh33b2cb92022-06-07 13:09:58 +00003838 if( ExprHasProperty(pExpr, EP_OuterON|EP_InnerON)
drhd1985262022-04-11 11:25:28 +00003839 && pExpr->w.iJoin==pSubst->iTable
drh3d240d22017-09-28 16:56:55 +00003840 ){
drh33b2cb92022-06-07 13:09:58 +00003841 testcase( ExprHasProperty(pExpr, EP_InnerON) );
drhd1985262022-04-11 11:25:28 +00003842 pExpr->w.iJoin = pSubst->iNewTable;
drh399c7e22017-04-14 17:18:45 +00003843 }
drh2e52a9c2020-04-04 00:15:54 +00003844 if( pExpr->op==TK_COLUMN
3845 && pExpr->iTable==pSubst->iTable
3846 && !ExprHasProperty(pExpr, EP_FixedCol)
3847 ){
drh6e5020e2021-04-07 15:45:01 +00003848#ifdef SQLITE_ALLOW_ROWID_IN_VIEW
drh50350a12004-02-13 16:22:22 +00003849 if( pExpr->iColumn<0 ){
3850 pExpr->op = TK_NULL;
drh6e5020e2021-04-07 15:45:01 +00003851 }else
3852#endif
3853 {
drh50350a12004-02-13 16:22:22 +00003854 Expr *pNew;
dan879164e2022-10-14 19:30:34 +00003855 int iColumn = pExpr->iColumn;
3856 Expr *pCopy = pSubst->pEList->a[iColumn].pExpr;
drh31d6fd52017-04-14 19:03:10 +00003857 Expr ifNullRow;
dan879164e2022-10-14 19:30:34 +00003858 assert( pSubst->pEList!=0 && iColumn<pSubst->pEList->nExpr );
drh1fd4e7b2018-07-28 14:56:56 +00003859 assert( pExpr->pRight==0 );
dan44c56042016-12-07 15:38:37 +00003860 if( sqlite3ExprIsVector(pCopy) ){
drh46967de2017-04-14 12:39:37 +00003861 sqlite3VectorErrorMsg(pSubst->pParse, pCopy);
dan44c56042016-12-07 15:38:37 +00003862 }else{
drh46967de2017-04-14 12:39:37 +00003863 sqlite3 *db = pSubst->pParse->db;
drhc133bab2022-04-11 20:15:52 +00003864 if( pSubst->isOuterJoin && pCopy->op!=TK_COLUMN ){
drh31d6fd52017-04-14 19:03:10 +00003865 memset(&ifNullRow, 0, sizeof(ifNullRow));
3866 ifNullRow.op = TK_IF_NULL_ROW;
3867 ifNullRow.pLeft = pCopy;
3868 ifNullRow.iTable = pSubst->iNewTable;
drh4b1b65c2022-07-26 15:32:02 +00003869 ifNullRow.iColumn = -99;
drh46fe1382020-08-19 23:32:06 +00003870 ifNullRow.flags = EP_IfNullRow;
drh31d6fd52017-04-14 19:03:10 +00003871 pCopy = &ifNullRow;
3872 }
drh11df7d22018-12-06 19:15:36 +00003873 testcase( ExprHasProperty(pCopy, EP_Subquery) );
dan44c56042016-12-07 15:38:37 +00003874 pNew = sqlite3ExprDup(db, pCopy, 0);
drh8c6cb1b2021-04-19 20:36:13 +00003875 if( db->mallocFailed ){
3876 sqlite3ExprDelete(db, pNew);
3877 return pExpr;
3878 }
drhc133bab2022-04-11 20:15:52 +00003879 if( pSubst->isOuterJoin ){
danbd11a2a2017-06-20 17:43:26 +00003880 ExprSetProperty(pNew, EP_CanBeNull);
3881 }
drh67a99db2022-05-13 14:52:04 +00003882 if( ExprHasProperty(pExpr,EP_OuterON|EP_InnerON) ){
drh3a6e4c52022-04-11 12:38:06 +00003883 sqlite3SetJoinExpr(pNew, pExpr->w.iJoin,
drh67a99db2022-05-13 14:52:04 +00003884 pExpr->flags & (EP_OuterON|EP_InnerON));
dan44c56042016-12-07 15:38:37 +00003885 }
3886 sqlite3ExprDelete(db, pExpr);
3887 pExpr = pNew;
dan410fac32022-06-02 16:26:21 +00003888 if( pExpr->op==TK_TRUEFALSE ){
3889 pExpr->u.iValue = sqlite3ExprTruthValue(pExpr);
3890 pExpr->op = TK_INTEGER;
3891 ExprSetProperty(pExpr, EP_IntValue);
3892 }
dane0866392019-09-09 19:49:42 +00003893
danfa508342019-09-10 15:33:52 +00003894 /* Ensure that the expression now has an implicit collation sequence,
3895 ** just as it did when it was a column of a view or sub-query. */
dan879164e2022-10-14 19:30:34 +00003896 {
3897 CollSeq *pNat = sqlite3ExprCollSeq(pSubst->pParse, pExpr);
3898 CollSeq *pColl = sqlite3ExprCollSeq(pSubst->pParse,
3899 pSubst->pCList->a[iColumn].pExpr
drh60b95332021-04-19 15:05:27 +00003900 );
dan879164e2022-10-14 19:30:34 +00003901 if( pNat!=pColl || (pExpr->op!=TK_COLUMN && pExpr->op!=TK_COLLATE) ){
3902 pExpr = sqlite3ExprAddCollateString(pSubst->pParse, pExpr,
3903 (pColl ? pColl->zName : "BINARY")
3904 );
3905 }
dane0866392019-09-09 19:49:42 +00003906 }
drh60b95332021-04-19 15:05:27 +00003907 ExprClearProperty(pExpr, EP_Collate);
dan92ddb3b2016-12-01 19:38:05 +00003908 }
drh50350a12004-02-13 16:22:22 +00003909 }
drh832508b2002-03-02 17:04:07 +00003910 }else{
drh7c1544e2017-05-23 12:44:57 +00003911 if( pExpr->op==TK_IF_NULL_ROW && pExpr->iTable==pSubst->iTable ){
3912 pExpr->iTable = pSubst->iNewTable;
3913 }
drh46967de2017-04-14 12:39:37 +00003914 pExpr->pLeft = substExpr(pSubst, pExpr->pLeft);
3915 pExpr->pRight = substExpr(pSubst, pExpr->pRight);
drha4eeccd2021-10-07 17:43:30 +00003916 if( ExprUseXSelect(pExpr) ){
drh46967de2017-04-14 12:39:37 +00003917 substSelect(pSubst, pExpr->x.pSelect, 1);
danielk19776ab3a2e2009-02-19 14:39:25 +00003918 }else{
drh46967de2017-04-14 12:39:37 +00003919 substExprList(pSubst, pExpr->x.pList);
danielk19776ab3a2e2009-02-19 14:39:25 +00003920 }
dan3703edf2019-10-10 15:17:09 +00003921#ifndef SQLITE_OMIT_WINDOWFUNC
3922 if( ExprHasProperty(pExpr, EP_WinFunc) ){
3923 Window *pWin = pExpr->y.pWin;
3924 pWin->pFilter = substExpr(pSubst, pWin->pFilter);
3925 substExprList(pSubst, pWin->pPartition);
3926 substExprList(pSubst, pWin->pOrderBy);
3927 }
3928#endif
drh832508b2002-03-02 17:04:07 +00003929 }
drhb7916a72009-05-27 10:31:29 +00003930 return pExpr;
drh832508b2002-03-02 17:04:07 +00003931}
drh17435752007-08-16 04:30:38 +00003932static void substExprList(
drh46967de2017-04-14 12:39:37 +00003933 SubstContext *pSubst, /* Description of the substitution */
3934 ExprList *pList /* List to scan and in which to make substitutes */
drh17435752007-08-16 04:30:38 +00003935){
drh832508b2002-03-02 17:04:07 +00003936 int i;
3937 if( pList==0 ) return;
3938 for(i=0; i<pList->nExpr; i++){
drh46967de2017-04-14 12:39:37 +00003939 pList->a[i].pExpr = substExpr(pSubst, pList->a[i].pExpr);
drh832508b2002-03-02 17:04:07 +00003940 }
3941}
drh17435752007-08-16 04:30:38 +00003942static void substSelect(
drh46967de2017-04-14 12:39:37 +00003943 SubstContext *pSubst, /* Description of the substitution */
3944 Select *p, /* SELECT statement in which to make substitutions */
3945 int doPrior /* Do substitutes on p->pPrior too */
drh17435752007-08-16 04:30:38 +00003946){
drh588a9a12008-09-01 15:52:10 +00003947 SrcList *pSrc;
drh76012942021-02-21 21:04:54 +00003948 SrcItem *pItem;
drh588a9a12008-09-01 15:52:10 +00003949 int i;
danielk1977b3bce662005-01-29 08:32:43 +00003950 if( !p ) return;
drhd12b6362015-10-11 19:46:59 +00003951 do{
drh46967de2017-04-14 12:39:37 +00003952 substExprList(pSubst, p->pEList);
3953 substExprList(pSubst, p->pGroupBy);
3954 substExprList(pSubst, p->pOrderBy);
3955 p->pHaving = substExpr(pSubst, p->pHaving);
3956 p->pWhere = substExpr(pSubst, p->pWhere);
drhd12b6362015-10-11 19:46:59 +00003957 pSrc = p->pSrc;
drh29064902015-10-11 20:08:31 +00003958 assert( pSrc!=0 );
drh588a9a12008-09-01 15:52:10 +00003959 for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
drh46967de2017-04-14 12:39:37 +00003960 substSelect(pSubst, pItem->pSelect, 1);
drh29064902015-10-11 20:08:31 +00003961 if( pItem->fg.isTabFunc ){
drh46967de2017-04-14 12:39:37 +00003962 substExprList(pSubst, pItem->u1.pFuncArg);
drhd12b6362015-10-11 19:46:59 +00003963 }
drh588a9a12008-09-01 15:52:10 +00003964 }
drhd12b6362015-10-11 19:46:59 +00003965 }while( doPrior && (p = p->pPrior)!=0 );
danielk1977b3bce662005-01-29 08:32:43 +00003966}
shane3514b6f2008-07-22 05:00:55 +00003967#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
drh832508b2002-03-02 17:04:07 +00003968
shane3514b6f2008-07-22 05:00:55 +00003969#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh832508b2002-03-02 17:04:07 +00003970/*
drh2aee5142020-03-21 00:05:53 +00003971** pSelect is a SELECT statement and pSrcItem is one item in the FROM
3972** clause of that SELECT.
3973**
3974** This routine scans the entire SELECT statement and recomputes the
3975** pSrcItem->colUsed mask.
3976*/
3977static int recomputeColumnsUsedExpr(Walker *pWalker, Expr *pExpr){
drh76012942021-02-21 21:04:54 +00003978 SrcItem *pItem;
drh2aee5142020-03-21 00:05:53 +00003979 if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
3980 pItem = pWalker->u.pSrcItem;
3981 if( pItem->iCursor!=pExpr->iTable ) return WRC_Continue;
drh74a07982020-03-21 23:10:38 +00003982 if( pExpr->iColumn<0 ) return WRC_Continue;
3983 pItem->colUsed |= sqlite3ExprColUsed(pExpr);
drh2aee5142020-03-21 00:05:53 +00003984 return WRC_Continue;
3985}
3986static void recomputeColumnsUsed(
3987 Select *pSelect, /* The complete SELECT statement */
drh76012942021-02-21 21:04:54 +00003988 SrcItem *pSrcItem /* Which FROM clause item to recompute */
drh2aee5142020-03-21 00:05:53 +00003989){
3990 Walker w;
3991 if( NEVER(pSrcItem->pTab==0) ) return;
3992 memset(&w, 0, sizeof(w));
3993 w.xExprCallback = recomputeColumnsUsedExpr;
3994 w.xSelectCallback = sqlite3SelectWalkNoop;
3995 w.u.pSrcItem = pSrcItem;
3996 pSrcItem->colUsed = 0;
3997 sqlite3WalkSelect(&w, pSelect);
3998}
3999#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4000
4001#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4002/*
dan964fa262020-12-18 16:13:39 +00004003** Assign new cursor numbers to each of the items in pSrc. For each
4004** new cursor number assigned, set an entry in the aCsrMap[] array
4005** to map the old cursor number to the new:
4006**
drhc8d21472021-07-21 15:42:05 +00004007** aCsrMap[iOld+1] = iNew;
dan964fa262020-12-18 16:13:39 +00004008**
4009** The array is guaranteed by the caller to be large enough for all
drhc8d21472021-07-21 15:42:05 +00004010** existing cursor numbers in pSrc. aCsrMap[0] is the array size.
dan964fa262020-12-18 16:13:39 +00004011**
4012** If pSrc contains any sub-selects, call this routine recursively
4013** on the FROM clause of each such sub-select, with iExcept set to -1.
4014*/
4015static void srclistRenumberCursors(
4016 Parse *pParse, /* Parse context */
4017 int *aCsrMap, /* Array to store cursor mappings in */
4018 SrcList *pSrc, /* FROM clause to renumber */
4019 int iExcept /* FROM clause item to skip */
4020){
4021 int i;
drh76012942021-02-21 21:04:54 +00004022 SrcItem *pItem;
dan964fa262020-12-18 16:13:39 +00004023 for(i=0, pItem=pSrc->a; i<pSrc->nSrc; i++, pItem++){
4024 if( i!=iExcept ){
dand131b512020-12-18 18:04:44 +00004025 Select *p;
drhc8d21472021-07-21 15:42:05 +00004026 assert( pItem->iCursor < aCsrMap[0] );
4027 if( !pItem->fg.isRecursive || aCsrMap[pItem->iCursor+1]==0 ){
4028 aCsrMap[pItem->iCursor+1] = pParse->nTab++;
drhc7f50772021-04-26 21:23:01 +00004029 }
drhc8d21472021-07-21 15:42:05 +00004030 pItem->iCursor = aCsrMap[pItem->iCursor+1];
dand131b512020-12-18 18:04:44 +00004031 for(p=pItem->pSelect; p; p=p->pPrior){
4032 srclistRenumberCursors(pParse, aCsrMap, p->pSrc, -1);
dan964fa262020-12-18 16:13:39 +00004033 }
4034 }
4035 }
4036}
4037
4038/*
drhc8d21472021-07-21 15:42:05 +00004039** *piCursor is a cursor number. Change it if it needs to be mapped.
4040*/
4041static void renumberCursorDoMapping(Walker *pWalker, int *piCursor){
4042 int *aCsrMap = pWalker->u.aiCol;
4043 int iCsr = *piCursor;
4044 if( iCsr < aCsrMap[0] && aCsrMap[iCsr+1]>0 ){
4045 *piCursor = aCsrMap[iCsr+1];
4046 }
4047}
4048
4049/*
dan964fa262020-12-18 16:13:39 +00004050** Expression walker callback used by renumberCursors() to update
4051** Expr objects to match newly assigned cursor numbers.
4052*/
4053static int renumberCursorsCb(Walker *pWalker, Expr *pExpr){
dane8f14902021-02-13 14:26:25 +00004054 int op = pExpr->op;
drhc8d21472021-07-21 15:42:05 +00004055 if( op==TK_COLUMN || op==TK_IF_NULL_ROW ){
4056 renumberCursorDoMapping(pWalker, &pExpr->iTable);
dan964fa262020-12-18 16:13:39 +00004057 }
drh67a99db2022-05-13 14:52:04 +00004058 if( ExprHasProperty(pExpr, EP_OuterON) ){
drhd1985262022-04-11 11:25:28 +00004059 renumberCursorDoMapping(pWalker, &pExpr->w.iJoin);
dan961a7262020-12-21 19:50:10 +00004060 }
dan964fa262020-12-18 16:13:39 +00004061 return WRC_Continue;
4062}
4063
4064/*
4065** Assign a new cursor number to each cursor in the FROM clause (Select.pSrc)
4066** of the SELECT statement passed as the second argument, and to each
4067** cursor in the FROM clause of any FROM clause sub-selects, recursively.
4068** Except, do not assign a new cursor number to the iExcept'th element in
4069** the FROM clause of (*p). Update all expressions and other references
4070** to refer to the new cursor numbers.
4071**
4072** Argument aCsrMap is an array that may be used for temporary working
4073** space. Two guarantees are made by the caller:
4074**
4075** * the array is larger than the largest cursor number used within the
4076** select statement passed as an argument, and
4077**
4078** * the array entries for all cursor numbers that do *not* appear in
4079** FROM clauses of the select statement as described above are
4080** initialized to zero.
4081*/
4082static void renumberCursors(
4083 Parse *pParse, /* Parse context */
4084 Select *p, /* Select to renumber cursors within */
4085 int iExcept, /* FROM clause item to skip */
4086 int *aCsrMap /* Working space */
4087){
4088 Walker w;
4089 srclistRenumberCursors(pParse, aCsrMap, p->pSrc, iExcept);
4090 memset(&w, 0, sizeof(w));
4091 w.u.aiCol = aCsrMap;
4092 w.xExprCallback = renumberCursorsCb;
4093 w.xSelectCallback = sqlite3SelectWalkNoop;
4094 sqlite3WalkSelect(&w, p);
4095}
4096#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4097
dan879164e2022-10-14 19:30:34 +00004098/*
4099** If pSel is not part of a compound SELECT, return a pointer to its
4100** expression list. Otherwise, return a pointer to the expression list
4101** of the leftmost SELECT in the compound.
4102*/
4103static ExprList *findLeftmostExprlist(Select *pSel){
4104 while( pSel->pPrior ){
4105 pSel = pSel->pPrior;
4106 }
4107 return pSel->pEList;
4108}
4109
drh23f61a42022-11-25 15:52:00 +00004110/*
4111** Return true if any of the result-set columns in the compound query
4112** have incompatible affinities on one or more arms of the compound.
4113*/
4114static int compoundHasDifferentAffinities(Select *p){
4115 int ii;
4116 ExprList *pList;
4117 assert( p!=0 );
4118 assert( p->pEList!=0 );
4119 assert( p->pPrior!=0 );
4120 pList = p->pEList;
4121 for(ii=0; ii<pList->nExpr; ii++){
4122 char aff;
4123 Select *pSub1;
4124 assert( pList->a[ii].pExpr!=0 );
4125 aff = sqlite3ExprAffinity(pList->a[ii].pExpr);
4126 for(pSub1=p->pPrior; pSub1; pSub1=pSub1->pPrior){
4127 assert( pSub1->pEList!=0 );
4128 assert( pSub1->pEList->nExpr>ii );
4129 assert( pSub1->pEList->a[ii].pExpr!=0 );
4130 if( sqlite3ExprAffinity(pSub1->pEList->a[ii].pExpr)!=aff ){
4131 return 1;
4132 }
4133 }
4134 }
4135 return 0;
4136}
4137
dan964fa262020-12-18 16:13:39 +00004138#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4139/*
drh630d2962011-12-11 21:51:04 +00004140** This routine attempts to flatten subqueries as a performance optimization.
4141** This routine returns 1 if it makes changes and 0 if no flattening occurs.
drh1350b032002-02-27 19:00:20 +00004142**
4143** To understand the concept of flattening, consider the following
4144** query:
4145**
4146** SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
4147**
4148** The default way of implementing this query is to execute the
4149** subquery first and store the results in a temporary table, then
4150** run the outer query on that temporary table. This requires two
4151** passes over the data. Furthermore, because the temporary table
4152** has no indices, the WHERE clause on the outer query cannot be
drh832508b2002-03-02 17:04:07 +00004153** optimized.
drh1350b032002-02-27 19:00:20 +00004154**
drh832508b2002-03-02 17:04:07 +00004155** This routine attempts to rewrite queries such as the above into
drh1350b032002-02-27 19:00:20 +00004156** a single flat select, like this:
4157**
4158** SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
4159**
peter.d.reid60ec9142014-09-06 16:39:46 +00004160** The code generated for this simplification gives the same result
drh832508b2002-03-02 17:04:07 +00004161** but only has to scan the data once. And because indices might
4162** exist on the table t1, a complete scan of the data might be
4163** avoided.
drh1350b032002-02-27 19:00:20 +00004164**
drhd981e822017-09-29 16:07:56 +00004165** Flattening is subject to the following constraints:
drh1350b032002-02-27 19:00:20 +00004166**
drh25c221e2017-09-29 22:13:24 +00004167** (**) We no longer attempt to flatten aggregate subqueries. Was:
4168** The subquery and the outer query cannot both be aggregates.
drh1350b032002-02-27 19:00:20 +00004169**
drh25c221e2017-09-29 22:13:24 +00004170** (**) We no longer attempt to flatten aggregate subqueries. Was:
4171** (2) If the subquery is an aggregate then
drhd981e822017-09-29 16:07:56 +00004172** (2a) the outer query must not be a join and
4173** (2b) the outer query must not use subqueries
4174** other than the one FROM-clause subquery that is a candidate
4175** for flattening. (This is due to ticket [2f7170d73bf9abf80]
4176** from 2015-02-09.)
drh832508b2002-03-02 17:04:07 +00004177**
drhd981e822017-09-29 16:07:56 +00004178** (3) If the subquery is the right operand of a LEFT JOIN then
4179** (3a) the subquery may not be a join and
4180** (3b) the FROM clause of the subquery may not contain a virtual
4181** table and
drhee373022022-07-25 15:54:23 +00004182** (**) Was: "The outer query may not have a GROUP BY." This case
4183** is now managed correctly
drh396afe62019-12-18 20:51:58 +00004184** (3d) the outer query may not be DISTINCT.
drh41798d52022-04-11 00:21:53 +00004185** See also (26) for restrictions on RIGHT JOIN.
drh832508b2002-03-02 17:04:07 +00004186**
drhd981e822017-09-29 16:07:56 +00004187** (4) The subquery can not be DISTINCT.
drh832508b2002-03-02 17:04:07 +00004188**
dan49ad3302010-08-13 16:38:48 +00004189** (**) At one point restrictions (4) and (5) defined a subset of DISTINCT
4190** sub-queries that were excluded from this optimization. Restriction
4191** (4) has since been expanded to exclude all DISTINCT subqueries.
drh832508b2002-03-02 17:04:07 +00004192**
drh25c221e2017-09-29 22:13:24 +00004193** (**) We no longer attempt to flatten aggregate subqueries. Was:
4194** If the subquery is aggregate, the outer query may not be DISTINCT.
drh832508b2002-03-02 17:04:07 +00004195**
drhd981e822017-09-29 16:07:56 +00004196** (7) The subquery must have a FROM clause. TODO: For subqueries without
drh31d6fd52017-04-14 19:03:10 +00004197** A FROM clause, consider adding a FROM clause with the special
drh630d2962011-12-11 21:51:04 +00004198** table sqlite_once that consists of a single row containing a
4199** single NULL.
drh08192d52002-04-30 19:20:28 +00004200**
drhd981e822017-09-29 16:07:56 +00004201** (8) If the subquery uses LIMIT then the outer query may not be a join.
drhdf199a22002-06-14 22:38:41 +00004202**
drhd981e822017-09-29 16:07:56 +00004203** (9) If the subquery uses LIMIT then the outer query may not be aggregate.
drhdf199a22002-06-14 22:38:41 +00004204**
drh6092d2b2014-09-15 11:14:50 +00004205** (**) Restriction (10) was removed from the code on 2005-02-05 but we
4206** accidently carried the comment forward until 2014-09-15. Original
drhd981e822017-09-29 16:07:56 +00004207** constraint: "If the subquery is aggregate then the outer query
4208** may not use LIMIT."
drhdf199a22002-06-14 22:38:41 +00004209**
drhd981e822017-09-29 16:07:56 +00004210** (11) The subquery and the outer query may not both have ORDER BY clauses.
drh174b6192002-12-03 02:22:52 +00004211**
drh7b688ed2009-12-22 00:29:53 +00004212** (**) Not implemented. Subsumed into restriction (3). Was previously
drh2b300d52008-08-14 00:19:48 +00004213** a separate restriction deriving from ticket #350.
drh3fc673e2003-06-16 00:40:34 +00004214**
drhd981e822017-09-29 16:07:56 +00004215** (13) The subquery and outer query may not both use LIMIT.
drhac839632006-01-21 22:19:54 +00004216**
drhd981e822017-09-29 16:07:56 +00004217** (14) The subquery may not use OFFSET.
drhac839632006-01-21 22:19:54 +00004218**
drhd981e822017-09-29 16:07:56 +00004219** (15) If the outer query is part of a compound select, then the
4220** subquery may not use LIMIT.
drhf3913272010-04-15 23:24:29 +00004221** (See ticket #2339 and ticket [02a8e81d44]).
drhad91c6c2007-05-06 20:04:24 +00004222**
drhd981e822017-09-29 16:07:56 +00004223** (16) If the outer query is aggregate, then the subquery may not
4224** use ORDER BY. (Ticket #2942) This used to not matter
drhc52e3552008-02-15 14:33:03 +00004225** until we introduced the group_concat() function.
4226**
drhd981e822017-09-29 16:07:56 +00004227** (17) If the subquery is a compound select, then
4228** (17a) all compound operators must be a UNION ALL, and
4229** (17b) no terms within the subquery compound may be aggregate
drhe76acc62017-10-04 02:30:45 +00004230** or DISTINCT, and
drhd981e822017-09-29 16:07:56 +00004231** (17c) every term within the subquery compound must have a FROM clause
4232** (17d) the outer query may not be
4233** (17d1) aggregate, or
dan8daf5ae2020-12-17 16:48:04 +00004234** (17d2) DISTINCT
4235** (17e) the subquery may not contain window functions, and
4236** (17f) the subquery must not be the RHS of a LEFT JOIN.
drhb88bf862022-07-13 15:52:15 +00004237** (17g) either the subquery is the first element of the outer
4238** query or there are no RIGHT or FULL JOINs in any arm
4239** of the subquery. (This is a duplicate of condition (27b).)
drhb6d91672022-11-01 01:07:29 +00004240** (17h) The corresponding result set expressions in all arms of the
drh23f61a42022-11-25 15:52:00 +00004241** compound must have the same affinity. (See restriction (9)
4242** on the push-down optimization.)
danielk1977f23329a2008-07-01 14:09:13 +00004243**
danielk19774914cf92008-07-01 18:26:49 +00004244** The parent and sub-query may contain WHERE clauses. Subject to
4245** rules (11), (13) and (14), they may also contain ORDER BY,
drh630d2962011-12-11 21:51:04 +00004246** LIMIT and OFFSET clauses. The subquery cannot use any compound
4247** operator other than UNION ALL because all the other compound
4248** operators have an implied DISTINCT which is disallowed by
4249** restriction (4).
danielk1977f23329a2008-07-01 14:09:13 +00004250**
dan67c70142012-08-28 14:45:50 +00004251** Also, each component of the sub-query must return the same number
4252** of result columns. This is actually a requirement for any compound
4253** SELECT statement, but all the code here does is make sure that no
4254** such (illegal) sub-query is flattened. The caller will detect the
4255** syntax error and return a detailed message.
4256**
danielk197749fc1f62008-07-08 17:43:56 +00004257** (18) If the sub-query is a compound select, then all terms of the
dan9353bea2020-12-17 17:17:12 +00004258** ORDER BY clause of the parent must be copies of a term returned
4259** by the parent query.
danielk197749fc1f62008-07-08 17:43:56 +00004260**
drhd981e822017-09-29 16:07:56 +00004261** (19) If the subquery uses LIMIT then the outer query may not
drh229cf702008-08-26 12:56:14 +00004262** have a WHERE clause.
4263**
drhfca23552017-10-28 20:51:54 +00004264** (20) If the sub-query is a compound select, then it must not use
4265** an ORDER BY clause. Ticket #3773. We could relax this constraint
4266** somewhat by saying that the terms of the ORDER BY clause must
4267** appear as unmodified result columns in the outer query. But we
4268** have other optimizations in mind to deal with that case.
drhe8902a72009-04-02 16:59:47 +00004269**
drhd981e822017-09-29 16:07:56 +00004270** (21) If the subquery uses LIMIT then the outer query may not be
shaneha91491e2011-02-11 20:52:20 +00004271** DISTINCT. (See ticket [752e1646fc]).
4272**
drhd981e822017-09-29 16:07:56 +00004273** (22) The subquery may not be a recursive CTE.
dan8290c2a2014-01-16 10:58:39 +00004274**
dan8daf5ae2020-12-17 16:48:04 +00004275** (23) If the outer query is a recursive CTE, then the sub-query may not be
4276** a compound query. This restriction is because transforming the
dan8290c2a2014-01-16 10:58:39 +00004277** parent to a compound query confuses the code that handles
4278** recursive queries in multiSelect().
4279**
drh508e2d02017-09-30 01:25:04 +00004280** (**) We no longer attempt to flatten aggregate subqueries. Was:
4281** The subquery may not be an aggregate that uses the built-in min() or
drh9588ad92014-09-15 14:46:02 +00004282** or max() functions. (Without this restriction, a query like:
4283** "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
4284** return the value X for which Y was maximal.)
4285**
dan9a947222018-06-14 19:06:36 +00004286** (25) If either the subquery or the parent query contains a window
4287** function in the select list or ORDER BY clause, flattening
4288** is not attempted.
4289**
drh41798d52022-04-11 00:21:53 +00004290** (26) The subquery may not be the right operand of a RIGHT JOIN.
4291** See also (3) for restrictions on LEFT JOIN.
4292**
drh1c2bf412022-04-18 23:20:02 +00004293** (27) The subquery may not contain a FULL or RIGHT JOIN unless it
drhb22b4932022-09-19 19:25:15 +00004294** is the first element of the parent query. Two subcases:
4295** (27a) the subquery is not a compound query.
drhb88bf862022-07-13 15:52:15 +00004296** (27b) the subquery is a compound query and the RIGHT JOIN occurs
4297** in any arm of the compound query. (See also (17g).)
drh1c2bf412022-04-18 23:20:02 +00004298**
drh67f70be2022-04-22 16:15:48 +00004299** (28) The subquery is not a MATERIALIZED CTE.
4300**
dan8290c2a2014-01-16 10:58:39 +00004301**
drh832508b2002-03-02 17:04:07 +00004302** In this routine, the "p" parameter is a pointer to the outer query.
4303** The subquery is p->pSrc->a[iFrom]. isAgg is true if the outer query
drh25c221e2017-09-29 22:13:24 +00004304** uses aggregates.
drh832508b2002-03-02 17:04:07 +00004305**
drh665de472003-03-31 13:36:09 +00004306** If flattening is not attempted, this routine is a no-op and returns 0.
drh832508b2002-03-02 17:04:07 +00004307** If flattening is attempted this routine returns 1.
4308**
4309** All of the expression analysis must occur on both the outer query and
4310** the subquery before this routine runs.
drh1350b032002-02-27 19:00:20 +00004311*/
drh8c74a8c2002-08-25 19:20:40 +00004312static int flattenSubquery(
danielk1977524cc212008-07-02 13:13:51 +00004313 Parse *pParse, /* Parsing context */
drh8c74a8c2002-08-25 19:20:40 +00004314 Select *p, /* The parent or outer SELECT statement */
4315 int iFrom, /* Index in p->pSrc->a[] of the inner subquery */
drh25c221e2017-09-29 22:13:24 +00004316 int isAgg /* True if outer SELECT uses aggregate functions */
drh8c74a8c2002-08-25 19:20:40 +00004317){
danielk1977524cc212008-07-02 13:13:51 +00004318 const char *zSavedAuthContext = pParse->zAuthContext;
drhd12b6362015-10-11 19:46:59 +00004319 Select *pParent; /* Current UNION ALL term of the other query */
drh0bb28102002-05-08 11:54:14 +00004320 Select *pSub; /* The inner query or "subquery" */
danielk1977f23329a2008-07-01 14:09:13 +00004321 Select *pSub1; /* Pointer to the rightmost select in sub-query */
drhad3cab52002-05-24 02:04:32 +00004322 SrcList *pSrc; /* The FROM clause of the outer query */
4323 SrcList *pSubSrc; /* The FROM clause of the subquery */
drh6a3ea0e2003-05-02 14:32:12 +00004324 int iParent; /* VDBE cursor number of the pSub result set temp table */
drh399c7e22017-04-14 17:18:45 +00004325 int iNewParent = -1;/* Replacement table for iParent */
drhc133bab2022-04-11 20:15:52 +00004326 int isOuterJoin = 0; /* True if pSub is the right side of a LEFT JOIN */
drh91bb0ee2004-09-01 03:06:34 +00004327 int i; /* Loop counter */
4328 Expr *pWhere; /* The WHERE clause */
drh76012942021-02-21 21:04:54 +00004329 SrcItem *pSubitem; /* The subquery */
danielk1977524cc212008-07-02 13:13:51 +00004330 sqlite3 *db = pParse->db;
drh89636622020-06-07 17:33:18 +00004331 Walker w; /* Walker to persist agginfo data */
dan964fa262020-12-18 16:13:39 +00004332 int *aCsrMap = 0;
drh1350b032002-02-27 19:00:20 +00004333
drh832508b2002-03-02 17:04:07 +00004334 /* Check to see if flattening is permitted. Return 0 if not.
4335 */
drha78c22c2008-11-11 18:28:58 +00004336 assert( p!=0 );
drhd981e822017-09-29 16:07:56 +00004337 assert( p->pPrior==0 );
drh7e5418e2012-09-27 15:05:54 +00004338 if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
drh832508b2002-03-02 17:04:07 +00004339 pSrc = p->pSrc;
drhad3cab52002-05-24 02:04:32 +00004340 assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
drh91bb0ee2004-09-01 03:06:34 +00004341 pSubitem = &pSrc->a[iFrom];
danielk197749fc1f62008-07-08 17:43:56 +00004342 iParent = pSubitem->iCursor;
drh91bb0ee2004-09-01 03:06:34 +00004343 pSub = pSubitem->pSelect;
drh832508b2002-03-02 17:04:07 +00004344 assert( pSub!=0 );
drh399c7e22017-04-14 17:18:45 +00004345
dan67a9b8e2018-06-22 20:51:35 +00004346#ifndef SQLITE_OMIT_WINDOWFUNC
dan9a947222018-06-14 19:06:36 +00004347 if( p->pWin || pSub->pWin ) return 0; /* Restriction (25) */
dan67a9b8e2018-06-22 20:51:35 +00004348#endif
dan86fb6e12018-05-16 20:58:07 +00004349
drh832508b2002-03-02 17:04:07 +00004350 pSubSrc = pSub->pSrc;
4351 assert( pSubSrc );
drhac839632006-01-21 22:19:54 +00004352 /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
peter.d.reid60ec9142014-09-06 16:39:46 +00004353 ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
drhac839632006-01-21 22:19:54 +00004354 ** because they could be computed at compile-time. But when LIMIT and OFFSET
4355 ** became arbitrary expressions, we were forced to add restrictions (13)
4356 ** and (14). */
4357 if( pSub->pLimit && p->pLimit ) return 0; /* Restriction (13) */
drh8c0833f2017-11-14 23:48:23 +00004358 if( pSub->pLimit && pSub->pLimit->pRight ) return 0; /* Restriction (14) */
drhd227a292014-02-09 18:02:09 +00004359 if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
drhad91c6c2007-05-06 20:04:24 +00004360 return 0; /* Restriction (15) */
4361 }
drhac839632006-01-21 22:19:54 +00004362 if( pSubSrc->nSrc==0 ) return 0; /* Restriction (7) */
drhd981e822017-09-29 16:07:56 +00004363 if( pSub->selFlags & SF_Distinct ) return 0; /* Restriction (4) */
dan49ad3302010-08-13 16:38:48 +00004364 if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
4365 return 0; /* Restrictions (8)(9) */
drhdf199a22002-06-14 22:38:41 +00004366 }
drh7d10d5a2008-08-20 16:35:10 +00004367 if( p->pOrderBy && pSub->pOrderBy ){
drhac839632006-01-21 22:19:54 +00004368 return 0; /* Restriction (11) */
4369 }
drhc52e3552008-02-15 14:33:03 +00004370 if( isAgg && pSub->pOrderBy ) return 0; /* Restriction (16) */
drh229cf702008-08-26 12:56:14 +00004371 if( pSub->pLimit && p->pWhere ) return 0; /* Restriction (19) */
shaneha91491e2011-02-11 20:52:20 +00004372 if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
4373 return 0; /* Restriction (21) */
4374 }
drh508e2d02017-09-30 01:25:04 +00004375 if( pSub->selFlags & (SF_Recursive) ){
4376 return 0; /* Restrictions (22) */
drh9588ad92014-09-15 14:46:02 +00004377 }
drh832508b2002-03-02 17:04:07 +00004378
drh399c7e22017-04-14 17:18:45 +00004379 /*
4380 ** If the subquery is the right operand of a LEFT JOIN, then the
drhd981e822017-09-29 16:07:56 +00004381 ** subquery may not be a join itself (3a). Example of why this is not
4382 ** allowed:
drh8af4d3a2003-05-06 20:35:16 +00004383 **
4384 ** t1 LEFT OUTER JOIN (t2 JOIN t3)
4385 **
4386 ** If we flatten the above, we would get
4387 **
4388 ** (t1 LEFT OUTER JOIN t2) JOIN t3
4389 **
4390 ** which is not at all the same thing.
drh2b300d52008-08-14 00:19:48 +00004391 **
drh31d6fd52017-04-14 19:03:10 +00004392 ** See also tickets #306, #350, and #3300.
drh3fc673e2003-06-16 00:40:34 +00004393 */
drhc133bab2022-04-11 20:15:52 +00004394 if( (pSubitem->fg.jointype & (JT_OUTER|JT_LTORJ))!=0 ){
drh41798d52022-04-11 00:21:53 +00004395 if( pSubSrc->nSrc>1 /* (3a) */
drh9efc6182022-06-23 12:36:56 +00004396 || IsVirtual(pSubSrc->a[0].pTab) /* (3b) */
drh41798d52022-04-11 00:21:53 +00004397 || (p->selFlags & SF_Distinct)!=0 /* (3d) */
4398 || (pSubitem->fg.jointype & JT_RIGHT)!=0 /* (26) */
drh396afe62019-12-18 20:51:58 +00004399 ){
drhd981e822017-09-29 16:07:56 +00004400 return 0;
drh399c7e22017-04-14 17:18:45 +00004401 }
drhc133bab2022-04-11 20:15:52 +00004402 isOuterJoin = 1;
drh3fc673e2003-06-16 00:40:34 +00004403 }
4404
drh1c2bf412022-04-18 23:20:02 +00004405 assert( pSubSrc->nSrc>0 ); /* True by restriction (7) */
4406 if( iFrom>0 && (pSubSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
drhb88bf862022-07-13 15:52:15 +00004407 return 0; /* Restriction (27a) */
drh1c2bf412022-04-18 23:20:02 +00004408 }
drh67f70be2022-04-22 16:15:48 +00004409 if( pSubitem->fg.isCte && pSubitem->u2.pCteUse->eM10d==M10d_Yes ){
4410 return 0; /* (28) */
4411 }
drh1c2bf412022-04-18 23:20:02 +00004412
drhd981e822017-09-29 16:07:56 +00004413 /* Restriction (17): If the sub-query is a compound SELECT, then it must
danielk1977f23329a2008-07-01 14:09:13 +00004414 ** use only the UNION ALL operator. And none of the simple select queries
4415 ** that make up the compound SELECT are allowed to be aggregate or distinct
4416 ** queries.
4417 */
4418 if( pSub->pPrior ){
drhb6d91672022-11-01 01:07:29 +00004419 int ii;
drhfca23552017-10-28 20:51:54 +00004420 if( pSub->pOrderBy ){
4421 return 0; /* Restriction (20) */
4422 }
drhc133bab2022-04-11 20:15:52 +00004423 if( isAgg || (p->selFlags & SF_Distinct)!=0 || isOuterJoin>0 ){
dan8daf5ae2020-12-17 16:48:04 +00004424 return 0; /* (17d1), (17d2), or (17f) */
danielk1977f23329a2008-07-01 14:09:13 +00004425 }
4426 for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
drhccfcbce2009-05-18 15:46:07 +00004427 testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
4428 testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
drh4b3ac732011-12-10 23:18:32 +00004429 assert( pSub->pSrc!=0 );
dan8daf5ae2020-12-17 16:48:04 +00004430 assert( (pSub->selFlags & SF_Recursive)==0 );
drh2ec18a32015-06-23 23:31:52 +00004431 assert( pSub->pEList->nExpr==pSub1->pEList->nExpr );
drhd981e822017-09-29 16:07:56 +00004432 if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0 /* (17b) */
4433 || (pSub1->pPrior && pSub1->op!=TK_ALL) /* (17a) */
4434 || pSub1->pSrc->nSrc<1 /* (17c) */
drhef9f7192020-01-17 19:14:08 +00004435#ifndef SQLITE_OMIT_WINDOWFUNC
drh8d95ed72019-12-30 20:42:17 +00004436 || pSub1->pWin /* (17e) */
drhef9f7192020-01-17 19:14:08 +00004437#endif
danielk197780b3c542008-07-10 17:59:12 +00004438 ){
danielk1977f23329a2008-07-01 14:09:13 +00004439 return 0;
4440 }
drhb88bf862022-07-13 15:52:15 +00004441 if( iFrom>0 && (pSub1->pSrc->a[0].fg.jointype & JT_LTORJ)!=0 ){
4442 /* Without this restriction, the JT_LTORJ flag would end up being
4443 ** omitted on left-hand tables of the right join that is being
4444 ** flattened. */
4445 return 0; /* Restrictions (17g), (27b) */
4446 }
drh4b3ac732011-12-10 23:18:32 +00004447 testcase( pSub1->pSrc->nSrc>1 );
danielk1977f23329a2008-07-01 14:09:13 +00004448 }
danielk197749fc1f62008-07-08 17:43:56 +00004449
drhd981e822017-09-29 16:07:56 +00004450 /* Restriction (18). */
danielk197749fc1f62008-07-08 17:43:56 +00004451 if( p->pOrderBy ){
danielk197749fc1f62008-07-08 17:43:56 +00004452 for(ii=0; ii<p->pOrderBy->nExpr; ii++){
drhc2acc4e2013-11-15 18:15:19 +00004453 if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
danielk197749fc1f62008-07-08 17:43:56 +00004454 }
4455 }
danielk1977f23329a2008-07-01 14:09:13 +00004456
dande9ed622020-12-16 20:00:46 +00004457 /* Restriction (23) */
4458 if( (p->selFlags & SF_Recursive) ) return 0;
dan964fa262020-12-18 16:13:39 +00004459
drhb6d91672022-11-01 01:07:29 +00004460 /* Restriction (17h) */
drh23f61a42022-11-25 15:52:00 +00004461 if( compoundHasDifferentAffinities(pSub) ) return 0;
drhb6d91672022-11-01 01:07:29 +00004462
dan964fa262020-12-18 16:13:39 +00004463 if( pSrc->nSrc>1 ){
dan51ddfef2021-03-17 14:29:37 +00004464 if( pParse->nSelect>500 ) return 0;
drh95fe38f2022-04-25 14:59:59 +00004465 if( OptimizationDisabled(db, SQLITE_FlttnUnionAll) ) return 0;
drh913306a2021-11-26 17:10:18 +00004466 aCsrMap = sqlite3DbMallocZero(db, ((i64)pParse->nTab+1)*sizeof(int));
drhc8d21472021-07-21 15:42:05 +00004467 if( aCsrMap ) aCsrMap[0] = pParse->nTab;
dan964fa262020-12-18 16:13:39 +00004468 }
dande9ed622020-12-16 20:00:46 +00004469 }
drhcdb2f602017-10-04 05:59:54 +00004470
drh7d10d5a2008-08-20 16:35:10 +00004471 /***** If we reach this point, flattening is permitted. *****/
drh5d7aef12022-11-22 19:49:16 +00004472 TREETRACE(0x4,pParse,p,("flatten %u.%p from term %d\n",
drhfef37762018-07-10 19:48:35 +00004473 pSub->selId, pSub, iFrom));
drh7d10d5a2008-08-20 16:35:10 +00004474
4475 /* Authorize the subquery */
danielk1977524cc212008-07-02 13:13:51 +00004476 pParse->zAuthContext = pSubitem->zName;
drha2acb0d2012-04-11 23:22:37 +00004477 TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
4478 testcase( i==SQLITE_DENY );
danielk1977524cc212008-07-02 13:13:51 +00004479 pParse->zAuthContext = zSavedAuthContext;
4480
dande9ed622020-12-16 20:00:46 +00004481 /* Delete the transient structures associated with thesubquery */
4482 pSub1 = pSubitem->pSelect;
4483 sqlite3DbFree(db, pSubitem->zDatabase);
4484 sqlite3DbFree(db, pSubitem->zName);
4485 sqlite3DbFree(db, pSubitem->zAlias);
4486 pSubitem->zDatabase = 0;
4487 pSubitem->zName = 0;
4488 pSubitem->zAlias = 0;
4489 pSubitem->pSelect = 0;
drhd44f8b22022-04-07 01:11:13 +00004490 assert( pSubitem->fg.isUsing!=0 || pSubitem->u3.pOn==0 );
dande9ed622020-12-16 20:00:46 +00004491
drh7d10d5a2008-08-20 16:35:10 +00004492 /* If the sub-query is a compound SELECT statement, then (by restrictions
4493 ** 17 and 18 above) it must be a UNION ALL and the parent query must
4494 ** be of the form:
danielk1977f23329a2008-07-01 14:09:13 +00004495 **
4496 ** SELECT <expr-list> FROM (<sub-query>) <where-clause>
4497 **
4498 ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
drha78c22c2008-11-11 18:28:58 +00004499 ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
danielk1977f23329a2008-07-01 14:09:13 +00004500 ** OFFSET clauses and joins them to the left-hand-side of the original
4501 ** using UNION ALL operators. In this case N is the number of simple
4502 ** select statements in the compound sub-query.
drha78c22c2008-11-11 18:28:58 +00004503 **
4504 ** Example:
4505 **
4506 ** SELECT a+1 FROM (
4507 ** SELECT x FROM tab
4508 ** UNION ALL
4509 ** SELECT y FROM tab
4510 ** UNION ALL
4511 ** SELECT abs(z*2) FROM tab2
4512 ** ) WHERE a!=5 ORDER BY 1
4513 **
4514 ** Transformed into:
4515 **
4516 ** SELECT x+1 FROM tab WHERE x+1!=5
4517 ** UNION ALL
4518 ** SELECT y+1 FROM tab WHERE y+1!=5
4519 ** UNION ALL
4520 ** SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
4521 ** ORDER BY 1
4522 **
4523 ** We call this the "compound-subquery flattening".
danielk1977f23329a2008-07-01 14:09:13 +00004524 */
4525 for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
4526 Select *pNew;
4527 ExprList *pOrderBy = p->pOrderBy;
danielk19774b86ef12008-07-01 14:39:35 +00004528 Expr *pLimit = p->pLimit;
danielk1977f23329a2008-07-01 14:09:13 +00004529 Select *pPrior = p->pPrior;
dande9ed622020-12-16 20:00:46 +00004530 Table *pItemTab = pSubitem->pTab;
4531 pSubitem->pTab = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004532 p->pOrderBy = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004533 p->pPrior = 0;
danielk19774b86ef12008-07-01 14:39:35 +00004534 p->pLimit = 0;
danielk19776ab3a2e2009-02-19 14:39:25 +00004535 pNew = sqlite3SelectDup(db, p, 0);
danielk19774b86ef12008-07-01 14:39:35 +00004536 p->pLimit = pLimit;
drha78c22c2008-11-11 18:28:58 +00004537 p->pOrderBy = pOrderBy;
drha78c22c2008-11-11 18:28:58 +00004538 p->op = TK_ALL;
dande9ed622020-12-16 20:00:46 +00004539 pSubitem->pTab = pItemTab;
drha78c22c2008-11-11 18:28:58 +00004540 if( pNew==0 ){
drhd227a292014-02-09 18:02:09 +00004541 p->pPrior = pPrior;
drha78c22c2008-11-11 18:28:58 +00004542 }else{
dan51ddfef2021-03-17 14:29:37 +00004543 pNew->selId = ++pParse->nSelect;
drh9da977f2021-04-20 12:14:12 +00004544 if( aCsrMap && ALWAYS(db->mallocFailed==0) ){
dan964fa262020-12-18 16:13:39 +00004545 renumberCursors(pParse, pNew, iFrom, aCsrMap);
4546 }
drha78c22c2008-11-11 18:28:58 +00004547 pNew->pPrior = pPrior;
drhd227a292014-02-09 18:02:09 +00004548 if( pPrior ) pPrior->pNext = pNew;
4549 pNew->pNext = p;
4550 p->pPrior = pNew;
drh5d7aef12022-11-22 19:49:16 +00004551 TREETRACE(0x4,pParse,p,("compound-subquery flattener"
drhfef37762018-07-10 19:48:35 +00004552 " creates %u as peer\n",pNew->selId));
drha78c22c2008-11-11 18:28:58 +00004553 }
dande9ed622020-12-16 20:00:46 +00004554 assert( pSubitem->pSelect==0 );
dan964fa262020-12-18 16:13:39 +00004555 }
4556 sqlite3DbFree(db, aCsrMap);
4557 if( db->mallocFailed ){
4558 pSubitem->pSelect = pSub1;
4559 return 1;
danielk1977f23329a2008-07-01 14:09:13 +00004560 }
4561
drha78c22c2008-11-11 18:28:58 +00004562 /* Defer deleting the Table object associated with the
4563 ** subquery until code generation is
4564 ** complete, since there may still exist Expr.pTab entries that
4565 ** refer to the subquery even after flattening. Ticket #3346.
drhccfcbce2009-05-18 15:46:07 +00004566 **
4567 ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
drha78c22c2008-11-11 18:28:58 +00004568 */
drhccfcbce2009-05-18 15:46:07 +00004569 if( ALWAYS(pSubitem->pTab!=0) ){
drha78c22c2008-11-11 18:28:58 +00004570 Table *pTabToDel = pSubitem->pTab;
drh79df7782016-12-14 14:07:35 +00004571 if( pTabToDel->nTabRef==1 ){
dan65a7cd12009-09-01 12:16:01 +00004572 Parse *pToplevel = sqlite3ParseToplevel(pParse);
drhcf3c0782021-01-11 20:37:02 +00004573 sqlite3ParserAddCleanup(pToplevel,
4574 (void(*)(sqlite3*,void*))sqlite3DeleteTable,
4575 pTabToDel);
drh21d4f5b2021-01-12 15:30:01 +00004576 testcase( pToplevel->earlyCleanup );
drha78c22c2008-11-11 18:28:58 +00004577 }else{
drh79df7782016-12-14 14:07:35 +00004578 pTabToDel->nTabRef--;
drha78c22c2008-11-11 18:28:58 +00004579 }
4580 pSubitem->pTab = 0;
4581 }
4582
4583 /* The following loop runs once for each term in a compound-subquery
4584 ** flattening (as described above). If we are doing a different kind
4585 ** of flattening - a flattening other than a compound-subquery flattening -
4586 ** then this loop only runs once.
4587 **
4588 ** This loop moves all of the FROM elements of the subquery into the
4589 ** the FROM clause of the outer query. Before doing this, remember
4590 ** the cursor number for the original outer query FROM element in
4591 ** iParent. The iParent cursor will never be used. Subsequent code
4592 ** will scan expressions looking for iParent references and replace
4593 ** those references with expressions that resolve to the subquery FROM
4594 ** elements we are now copying in.
4595 */
dande9ed622020-12-16 20:00:46 +00004596 pSub = pSub1;
danielk1977f23329a2008-07-01 14:09:13 +00004597 for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
drha78c22c2008-11-11 18:28:58 +00004598 int nSubSrc;
drhea678832008-12-10 19:26:22 +00004599 u8 jointype = 0;
drh79d26582022-04-11 10:38:28 +00004600 u8 ltorj = pSrc->a[iFrom].fg.jointype & JT_LTORJ;
drh55f66b32019-07-16 19:44:32 +00004601 assert( pSub!=0 );
drha78c22c2008-11-11 18:28:58 +00004602 pSubSrc = pSub->pSrc; /* FROM clause of subquery */
4603 nSubSrc = pSubSrc->nSrc; /* Number of terms in subquery FROM clause */
4604 pSrc = pParent->pSrc; /* FROM clause of the outer query */
drhc31c2eb2003-05-02 16:04:17 +00004605
dande9ed622020-12-16 20:00:46 +00004606 if( pParent==p ){
4607 jointype = pSubitem->fg.jointype; /* First time through the loop */
drha78c22c2008-11-11 18:28:58 +00004608 }
dande9ed622020-12-16 20:00:46 +00004609
drha78c22c2008-11-11 18:28:58 +00004610 /* The subquery uses a single slot of the FROM clause of the outer
4611 ** query. If the subquery has more than one element in its FROM clause,
4612 ** then expand the outer query to make space for it to hold all elements
4613 ** of the subquery.
4614 **
4615 ** Example:
4616 **
4617 ** SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
4618 **
4619 ** The outer query has 3 slots in its FROM clause. One slot of the
4620 ** outer query (the middle slot) is used by the subquery. The next
drhd12b6362015-10-11 19:46:59 +00004621 ** block of code will expand the outer query FROM clause to 4 slots.
4622 ** The middle slot is expanded to two slots in order to make space
4623 ** for the two elements in the FROM clause of the subquery.
drha78c22c2008-11-11 18:28:58 +00004624 */
4625 if( nSubSrc>1 ){
drh29c992c2019-01-17 15:40:41 +00004626 pSrc = sqlite3SrcListEnlarge(pParse, pSrc, nSubSrc-1,iFrom+1);
4627 if( pSrc==0 ) break;
4628 pParent->pSrc = pSrc;
drhc31c2eb2003-05-02 16:04:17 +00004629 }
drha78c22c2008-11-11 18:28:58 +00004630
4631 /* Transfer the FROM clause terms from the subquery into the
4632 ** outer query.
4633 */
drhc31c2eb2003-05-02 16:04:17 +00004634 for(i=0; i<nSubSrc; i++){
drhd44f8b22022-04-07 01:11:13 +00004635 SrcItem *pItem = &pSrc->a[i+iFrom];
4636 if( pItem->fg.isUsing ) sqlite3IdListDelete(db, pItem->u3.pUsing);
4637 assert( pItem->fg.isTabFunc==0 );
4638 *pItem = pSubSrc->a[i];
drh79d26582022-04-11 10:38:28 +00004639 pItem->fg.jointype |= ltorj;
drh399c7e22017-04-14 17:18:45 +00004640 iNewParent = pSubSrc->a[i].iCursor;
drhc31c2eb2003-05-02 16:04:17 +00004641 memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
4642 }
drhf7309bc2022-04-12 20:20:54 +00004643 pSrc->a[iFrom].fg.jointype &= JT_LTORJ;
4644 pSrc->a[iFrom].fg.jointype |= jointype | ltorj;
danielk1977f23329a2008-07-01 14:09:13 +00004645
4646 /* Now begin substituting subquery result set expressions for
4647 ** references to the iParent in the outer query.
4648 **
4649 ** Example:
4650 **
4651 ** SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
4652 ** \ \_____________ subquery __________/ /
4653 ** \_____________________ outer query ______________________________/
4654 **
4655 ** We look at every expression in the outer query and every place we see
4656 ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
4657 */
drhb7cbf5c2020-06-15 13:51:34 +00004658 if( pSub->pOrderBy && (pParent->selFlags & SF_NoopOrderBy)==0 ){
dan7c0a4722014-09-20 20:38:48 +00004659 /* At this point, any non-zero iOrderByCol values indicate that the
4660 ** ORDER BY column expression is identical to the iOrderByCol'th
4661 ** expression returned by SELECT statement pSub. Since these values
4662 ** do not necessarily correspond to columns in SELECT statement pParent,
4663 ** zero them before transfering the ORDER BY clause.
4664 **
4665 ** Not doing this may cause an error if a subsequent call to this
4666 ** function attempts to flatten a compound sub-query into pParent
4667 ** (the only way this can happen is if the compound sub-query is
4668 ** currently part of pSub->pSrc). See ticket [d11a6e908f]. */
4669 ExprList *pOrderBy = pSub->pOrderBy;
4670 for(i=0; i<pOrderBy->nExpr; i++){
4671 pOrderBy->a[i].u.x.iOrderByCol = 0;
4672 }
danielk1977f23329a2008-07-01 14:09:13 +00004673 assert( pParent->pOrderBy==0 );
dan7c0a4722014-09-20 20:38:48 +00004674 pParent->pOrderBy = pOrderBy;
danielk1977f23329a2008-07-01 14:09:13 +00004675 pSub->pOrderBy = 0;
danielk1977f23329a2008-07-01 14:09:13 +00004676 }
drh11df7d22018-12-06 19:15:36 +00004677 pWhere = pSub->pWhere;
4678 pSub->pWhere = 0;
drhc133bab2022-04-11 20:15:52 +00004679 if( isOuterJoin>0 ){
drh67a99db2022-05-13 14:52:04 +00004680 sqlite3SetJoinExpr(pWhere, iNewParent, EP_OuterON);
drh399c7e22017-04-14 17:18:45 +00004681 }
dancd653a32020-06-13 21:24:40 +00004682 if( pWhere ){
4683 if( pParent->pWhere ){
4684 pParent->pWhere = sqlite3PExpr(pParse, TK_AND, pWhere, pParent->pWhere);
4685 }else{
4686 pParent->pWhere = pWhere;
4687 }
4688 }
danc3becdd2017-03-13 14:30:40 +00004689 if( db->mallocFailed==0 ){
drh46967de2017-04-14 12:39:37 +00004690 SubstContext x;
4691 x.pParse = pParse;
4692 x.iTable = iParent;
drh399c7e22017-04-14 17:18:45 +00004693 x.iNewTable = iNewParent;
drhc133bab2022-04-11 20:15:52 +00004694 x.isOuterJoin = isOuterJoin;
drh46967de2017-04-14 12:39:37 +00004695 x.pEList = pSub->pEList;
dan879164e2022-10-14 19:30:34 +00004696 x.pCList = findLeftmostExprlist(pSub);
drh46967de2017-04-14 12:39:37 +00004697 substSelect(&x, pParent, 0);
danc3becdd2017-03-13 14:30:40 +00004698 }
danielk1977f23329a2008-07-01 14:09:13 +00004699
drh7cd5e852019-05-29 17:22:38 +00004700 /* The flattened query is a compound if either the inner or the
4701 ** outer query is a compound. */
4702 pParent->selFlags |= pSub->selFlags & SF_Compound;
4703 assert( (pSub->selFlags & SF_Distinct)==0 ); /* restriction (17b) */
danielk1977f23329a2008-07-01 14:09:13 +00004704
4705 /*
4706 ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
4707 **
4708 ** One is tempted to try to add a and b to combine the limits. But this
4709 ** does not work if either limit is negative.
4710 */
4711 if( pSub->pLimit ){
4712 pParent->pLimit = pSub->pLimit;
4713 pSub->pLimit = 0;
4714 }
drh2aee5142020-03-21 00:05:53 +00004715
drh3b880652022-10-19 11:58:24 +00004716 /* Recompute the SrcItem.colUsed masks for the flattened
drh2aee5142020-03-21 00:05:53 +00004717 ** tables. */
4718 for(i=0; i<nSubSrc; i++){
4719 recomputeColumnsUsed(pParent, &pSrc->a[i+iFrom]);
4720 }
drhdf199a22002-06-14 22:38:41 +00004721 }
drh8c74a8c2002-08-25 19:20:40 +00004722
drhc31c2eb2003-05-02 16:04:17 +00004723 /* Finially, delete what is left of the subquery and return
4724 ** success.
4725 */
drh89636622020-06-07 17:33:18 +00004726 sqlite3AggInfoPersistWalkerInit(&w, pParse);
4727 sqlite3WalkSelect(&w,pSub1);
drh633e6d52008-07-28 19:34:53 +00004728 sqlite3SelectDelete(db, pSub1);
danielk1977f23329a2008-07-01 14:09:13 +00004729
drh5e431be2022-04-06 11:08:38 +00004730#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00004731 if( sqlite3TreeTrace & 0x4 ){
4732 TREETRACE(0x4,pParse,p,("After flattening:\n"));
drhc90713d2014-09-30 13:46:49 +00004733 sqlite3TreeViewSelect(0, p, 0);
4734 }
4735#endif
4736
drh832508b2002-03-02 17:04:07 +00004737 return 1;
4738}
shane3514b6f2008-07-22 05:00:55 +00004739#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
drh1350b032002-02-27 19:00:20 +00004740
drh660ee552018-07-26 21:16:53 +00004741/*
drh8e5bfed2018-10-25 14:15:37 +00004742** A structure to keep track of all of the column values that are fixed to
drhefad2e22018-07-27 16:57:11 +00004743** a known value due to WHERE clause constraints of the form COLUMN=VALUE.
drh660ee552018-07-26 21:16:53 +00004744*/
4745typedef struct WhereConst WhereConst;
4746struct WhereConst {
drhefad2e22018-07-27 16:57:11 +00004747 Parse *pParse; /* Parsing context */
drh75016052021-06-10 14:36:23 +00004748 u8 *pOomFault; /* Pointer to pParse->db->mallocFailed */
drh660ee552018-07-26 21:16:53 +00004749 int nConst; /* Number for COLUMN=CONSTANT terms */
4750 int nChng; /* Number of times a constant is propagated */
dan40b82f92021-05-26 18:51:57 +00004751 int bHasAffBlob; /* At least one column in apExpr[] as affinity BLOB */
drhae8776e2022-06-20 12:42:28 +00004752 u32 mExcludeOn; /* Which ON expressions to exclude from considertion.
4753 ** Either EP_OuterON or EP_InnerON|EP_OuterON */
drhefad2e22018-07-27 16:57:11 +00004754 Expr **apExpr; /* [i*2] is COLUMN and [i*2+1] is VALUE */
drh660ee552018-07-26 21:16:53 +00004755};
drh69b72d52015-06-01 20:28:03 +00004756
drh660ee552018-07-26 21:16:53 +00004757/*
drh8e5bfed2018-10-25 14:15:37 +00004758** Add a new entry to the pConst object. Except, do not add duplicate
drhf8f76d62020-01-08 04:36:01 +00004759** pColumn entires. Also, do not add if doing so would not be appropriate.
4760**
4761** The caller guarantees the pColumn is a column and pValue is a constant.
4762** This routine has to do some additional checks before completing the
4763** insert.
drh660ee552018-07-26 21:16:53 +00004764*/
4765static void constInsert(
drhf8f76d62020-01-08 04:36:01 +00004766 WhereConst *pConst, /* The WhereConst into which we are inserting */
4767 Expr *pColumn, /* The COLUMN part of the constraint */
4768 Expr *pValue, /* The VALUE part of the constraint */
4769 Expr *pExpr /* Overall expression: COLUMN=VALUE or VALUE=COLUMN */
drh660ee552018-07-26 21:16:53 +00004770){
drh8e5bfed2018-10-25 14:15:37 +00004771 int i;
4772 assert( pColumn->op==TK_COLUMN );
drhf8f76d62020-01-08 04:36:01 +00004773 assert( sqlite3ExprIsConstant(pValue) );
4774
drhfdfd45a2020-02-13 22:12:35 +00004775 if( ExprHasProperty(pColumn, EP_FixedCol) ) return;
4776 if( sqlite3ExprAffinity(pValue)!=0 ) return;
drhf8f76d62020-01-08 04:36:01 +00004777 if( !sqlite3IsBinary(sqlite3ExprCompareCollSeq(pConst->pParse,pExpr)) ){
4778 return;
4779 }
drh8e5bfed2018-10-25 14:15:37 +00004780
4781 /* 2018-10-25 ticket [cf5ed20f]
4782 ** Make sure the same pColumn is not inserted more than once */
4783 for(i=0; i<pConst->nConst; i++){
drh7be5e3d2020-01-09 20:33:13 +00004784 const Expr *pE2 = pConst->apExpr[i*2];
4785 assert( pE2->op==TK_COLUMN );
4786 if( pE2->iTable==pColumn->iTable
4787 && pE2->iColumn==pColumn->iColumn
drh8e5bfed2018-10-25 14:15:37 +00004788 ){
4789 return; /* Already present. Return without doing anything. */
4790 }
4791 }
dan40b82f92021-05-26 18:51:57 +00004792 if( sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4793 pConst->bHasAffBlob = 1;
4794 }
drh9cbf4f32018-07-27 20:01:00 +00004795
drh660ee552018-07-26 21:16:53 +00004796 pConst->nConst++;
drhefad2e22018-07-27 16:57:11 +00004797 pConst->apExpr = sqlite3DbReallocOrFree(pConst->pParse->db, pConst->apExpr,
drh660ee552018-07-26 21:16:53 +00004798 pConst->nConst*2*sizeof(Expr*));
4799 if( pConst->apExpr==0 ){
4800 pConst->nConst = 0;
4801 }else{
4802 pConst->apExpr[pConst->nConst*2-2] = pColumn;
4803 pConst->apExpr[pConst->nConst*2-1] = pValue;
4804 }
4805}
4806
4807/*
drhefad2e22018-07-27 16:57:11 +00004808** Find all terms of COLUMN=VALUE or VALUE=COLUMN in pExpr where VALUE
4809** is a constant expression and where the term must be true because it
4810** is part of the AND-connected terms of the expression. For each term
4811** found, add it to the pConst structure.
drh660ee552018-07-26 21:16:53 +00004812*/
4813static void findConstInWhere(WhereConst *pConst, Expr *pExpr){
drhefad2e22018-07-27 16:57:11 +00004814 Expr *pRight, *pLeft;
drhb775c972021-05-14 14:26:57 +00004815 if( NEVER(pExpr==0) ) return;
drhae8776e2022-06-20 12:42:28 +00004816 if( ExprHasProperty(pExpr, pConst->mExcludeOn) ){
drh958fcd42022-06-10 11:28:52 +00004817 testcase( ExprHasProperty(pExpr, EP_OuterON) );
4818 testcase( ExprHasProperty(pExpr, EP_InnerON) );
4819 return;
4820 }
drh660ee552018-07-26 21:16:53 +00004821 if( pExpr->op==TK_AND ){
4822 findConstInWhere(pConst, pExpr->pRight);
4823 findConstInWhere(pConst, pExpr->pLeft);
4824 return;
4825 }
4826 if( pExpr->op!=TK_EQ ) return;
drhefad2e22018-07-27 16:57:11 +00004827 pRight = pExpr->pRight;
4828 pLeft = pExpr->pLeft;
4829 assert( pRight!=0 );
4830 assert( pLeft!=0 );
drhf8f76d62020-01-08 04:36:01 +00004831 if( pRight->op==TK_COLUMN && sqlite3ExprIsConstant(pLeft) ){
4832 constInsert(pConst,pRight,pLeft,pExpr);
4833 }
4834 if( pLeft->op==TK_COLUMN && sqlite3ExprIsConstant(pRight) ){
4835 constInsert(pConst,pLeft,pRight,pExpr);
drh660ee552018-07-26 21:16:53 +00004836 }
4837}
4838
4839/*
dan40b82f92021-05-26 18:51:57 +00004840** This is a helper function for Walker callback propagateConstantExprRewrite().
4841**
4842** Argument pExpr is a candidate expression to be replaced by a value. If
4843** pExpr is equivalent to one of the columns named in pWalker->u.pConst,
4844** then overwrite it with the corresponding value. Except, do not do so
4845** if argument bIgnoreAffBlob is non-zero and the affinity of pExpr
4846** is SQLITE_AFF_BLOB.
drh660ee552018-07-26 21:16:53 +00004847*/
dan40b82f92021-05-26 18:51:57 +00004848static int propagateConstantExprRewriteOne(
4849 WhereConst *pConst,
4850 Expr *pExpr,
4851 int bIgnoreAffBlob
4852){
drh660ee552018-07-26 21:16:53 +00004853 int i;
drh75016052021-06-10 14:36:23 +00004854 if( pConst->pOomFault[0] ) return WRC_Prune;
drh660ee552018-07-26 21:16:53 +00004855 if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
drhae8776e2022-06-20 12:42:28 +00004856 if( ExprHasProperty(pExpr, EP_FixedCol|pConst->mExcludeOn) ){
drhbe0330e2020-01-16 17:53:24 +00004857 testcase( ExprHasProperty(pExpr, EP_FixedCol) );
drh67a99db2022-05-13 14:52:04 +00004858 testcase( ExprHasProperty(pExpr, EP_OuterON) );
drhae8776e2022-06-20 12:42:28 +00004859 testcase( ExprHasProperty(pExpr, EP_InnerON) );
drhbe0330e2020-01-16 17:53:24 +00004860 return WRC_Continue;
4861 }
drh660ee552018-07-26 21:16:53 +00004862 for(i=0; i<pConst->nConst; i++){
4863 Expr *pColumn = pConst->apExpr[i*2];
4864 if( pColumn==pExpr ) continue;
4865 if( pColumn->iTable!=pExpr->iTable ) continue;
4866 if( pColumn->iColumn!=pExpr->iColumn ) continue;
dan40b82f92021-05-26 18:51:57 +00004867 if( bIgnoreAffBlob && sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4868 break;
4869 }
drhefad2e22018-07-27 16:57:11 +00004870 /* A match is found. Add the EP_FixedCol property */
drh660ee552018-07-26 21:16:53 +00004871 pConst->nChng++;
4872 ExprClearProperty(pExpr, EP_Leaf);
drhefad2e22018-07-27 16:57:11 +00004873 ExprSetProperty(pExpr, EP_FixedCol);
4874 assert( pExpr->pLeft==0 );
4875 pExpr->pLeft = sqlite3ExprDup(pConst->pParse->db, pConst->apExpr[i*2+1], 0);
drh75016052021-06-10 14:36:23 +00004876 if( pConst->pParse->db->mallocFailed ) return WRC_Prune;
drh660ee552018-07-26 21:16:53 +00004877 break;
4878 }
4879 return WRC_Prune;
4880}
4881
4882/*
dan40b82f92021-05-26 18:51:57 +00004883** This is a Walker expression callback. pExpr is a node from the WHERE
4884** clause of a SELECT statement. This function examines pExpr to see if
4885** any substitutions based on the contents of pWalker->u.pConst should
4886** be made to pExpr or its immediate children.
4887**
4888** A substitution is made if:
4889**
4890** + pExpr is a column with an affinity other than BLOB that matches
4891** one of the columns in pWalker->u.pConst, or
4892**
4893** + pExpr is a binary comparison operator (=, <=, >=, <, >) that
4894** uses an affinity other than TEXT and one of its immediate
4895** children is a column that matches one of the columns in
4896** pWalker->u.pConst.
4897*/
4898static int propagateConstantExprRewrite(Walker *pWalker, Expr *pExpr){
4899 WhereConst *pConst = pWalker->u.pConst;
drha8ed5152021-05-26 19:52:21 +00004900 assert( TK_GT==TK_EQ+1 );
4901 assert( TK_LE==TK_EQ+2 );
4902 assert( TK_LT==TK_EQ+3 );
4903 assert( TK_GE==TK_EQ+4 );
dan40b82f92021-05-26 18:51:57 +00004904 if( pConst->bHasAffBlob ){
drha8ed5152021-05-26 19:52:21 +00004905 if( (pExpr->op>=TK_EQ && pExpr->op<=TK_GE)
dan40b82f92021-05-26 18:51:57 +00004906 || pExpr->op==TK_IS
4907 ){
4908 propagateConstantExprRewriteOne(pConst, pExpr->pLeft, 0);
drh75016052021-06-10 14:36:23 +00004909 if( pConst->pOomFault[0] ) return WRC_Prune;
dan40b82f92021-05-26 18:51:57 +00004910 if( sqlite3ExprAffinity(pExpr->pLeft)!=SQLITE_AFF_TEXT ){
4911 propagateConstantExprRewriteOne(pConst, pExpr->pRight, 0);
4912 }
4913 }
4914 }
4915 return propagateConstantExprRewriteOne(pConst, pExpr, pConst->bHasAffBlob);
4916}
4917
4918/*
drh660ee552018-07-26 21:16:53 +00004919** The WHERE-clause constant propagation optimization.
4920**
4921** If the WHERE clause contains terms of the form COLUMN=CONSTANT or
drh97bffe62020-01-08 00:39:37 +00004922** CONSTANT=COLUMN that are top-level AND-connected terms that are not
4923** part of a ON clause from a LEFT JOIN, then throughout the query
4924** replace all other occurrences of COLUMN with CONSTANT.
drh660ee552018-07-26 21:16:53 +00004925**
4926** For example, the query:
4927**
4928** SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=t1.a AND t3.c=t2.b
4929**
4930** Is transformed into
4931**
4932** SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=39 AND t3.c=39
4933**
4934** Return true if any transformations where made and false if not.
drhefad2e22018-07-27 16:57:11 +00004935**
4936** Implementation note: Constant propagation is tricky due to affinity
4937** and collating sequence interactions. Consider this example:
4938**
4939** CREATE TABLE t1(a INT,b TEXT);
4940** INSERT INTO t1 VALUES(123,'0123');
4941** SELECT * FROM t1 WHERE a=123 AND b=a;
4942** SELECT * FROM t1 WHERE a=123 AND b=123;
4943**
4944** The two SELECT statements above should return different answers. b=a
4945** is alway true because the comparison uses numeric affinity, but b=123
4946** is false because it uses text affinity and '0123' is not the same as '123'.
4947** To work around this, the expression tree is not actually changed from
4948** "b=a" to "b=123" but rather the "a" in "b=a" is tagged with EP_FixedCol
4949** and the "123" value is hung off of the pLeft pointer. Code generator
4950** routines know to generate the constant "123" instead of looking up the
4951** column value. Also, to avoid collation problems, this optimization is
4952** only attempted if the "a=123" term uses the default BINARY collation.
drh342cb332021-05-27 14:09:01 +00004953**
4954** 2021-05-25 forum post 6a06202608: Another troublesome case is...
4955**
4956** CREATE TABLE t1(x);
4957** INSERT INTO t1 VALUES(10.0);
4958** SELECT 1 FROM t1 WHERE x=10 AND x LIKE 10;
4959**
4960** The query should return no rows, because the t1.x value is '10.0' not '10'
4961** and '10.0' is not LIKE '10'. But if we are not careful, the first WHERE
4962** term "x=10" will cause the second WHERE term to become "10 LIKE 10",
4963** resulting in a false positive. To avoid this, constant propagation for
4964** columns with BLOB affinity is only allowed if the constant is used with
4965** operators ==, <=, <, >=, >, or IS in a way that will cause the correct
4966** type conversions to occur. See logic associated with the bHasAffBlob flag
4967** for details.
drh660ee552018-07-26 21:16:53 +00004968*/
4969static int propagateConstants(
4970 Parse *pParse, /* The parsing context */
4971 Select *p /* The query in which to propagate constants */
4972){
4973 WhereConst x;
4974 Walker w;
4975 int nChng = 0;
drhefad2e22018-07-27 16:57:11 +00004976 x.pParse = pParse;
drh75016052021-06-10 14:36:23 +00004977 x.pOomFault = &pParse->db->mallocFailed;
drh660ee552018-07-26 21:16:53 +00004978 do{
4979 x.nConst = 0;
4980 x.nChng = 0;
4981 x.apExpr = 0;
dan40b82f92021-05-26 18:51:57 +00004982 x.bHasAffBlob = 0;
drhae8776e2022-06-20 12:42:28 +00004983 if( ALWAYS(p->pSrc!=0)
4984 && p->pSrc->nSrc>0
4985 && (p->pSrc->a[0].fg.jointype & JT_LTORJ)!=0
4986 ){
4987 /* Do not propagate constants on any ON clause if there is a
4988 ** RIGHT JOIN anywhere in the query */
4989 x.mExcludeOn = EP_InnerON | EP_OuterON;
4990 }else{
4991 /* Do not propagate constants through the ON clause of a LEFT JOIN */
4992 x.mExcludeOn = EP_OuterON;
4993 }
drh660ee552018-07-26 21:16:53 +00004994 findConstInWhere(&x, p->pWhere);
4995 if( x.nConst ){
4996 memset(&w, 0, sizeof(w));
4997 w.pParse = pParse;
4998 w.xExprCallback = propagateConstantExprRewrite;
4999 w.xSelectCallback = sqlite3SelectWalkNoop;
5000 w.xSelectCallback2 = 0;
5001 w.walkerDepth = 0;
5002 w.u.pConst = &x;
drhefad2e22018-07-27 16:57:11 +00005003 sqlite3WalkExpr(&w, p->pWhere);
5004 sqlite3DbFree(x.pParse->db, x.apExpr);
drh660ee552018-07-26 21:16:53 +00005005 nChng += x.nChng;
5006 }
5007 }while( x.nChng );
5008 return nChng;
5009}
drh69b72d52015-06-01 20:28:03 +00005010
5011#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
dan903fdd42021-02-22 20:56:13 +00005012# if !defined(SQLITE_OMIT_WINDOWFUNC)
5013/*
5014** This function is called to determine whether or not it is safe to
5015** push WHERE clause expression pExpr down to FROM clause sub-query
5016** pSubq, which contains at least one window function. Return 1
5017** if it is safe and the expression should be pushed down, or 0
5018** otherwise.
5019**
5020** It is only safe to push the expression down if it consists only
5021** of constants and copies of expressions that appear in the PARTITION
5022** BY clause of all window function used by the sub-query. It is safe
5023** to filter out entire partitions, but not rows within partitions, as
5024** this may change the results of the window functions.
5025**
5026** At the time this function is called it is guaranteed that
5027**
5028** * the sub-query uses only one distinct window frame, and
5029** * that the window frame has a PARTITION BY clase.
5030*/
5031static int pushDownWindowCheck(Parse *pParse, Select *pSubq, Expr *pExpr){
5032 assert( pSubq->pWin->pPartition );
5033 assert( (pSubq->selFlags & SF_MultiPart)==0 );
5034 assert( pSubq->pPrior==0 );
5035 return sqlite3ExprIsConstantOrGroupBy(pParse, pExpr, pSubq->pWin->pPartition);
5036}
5037# endif /* SQLITE_OMIT_WINDOWFUNC */
5038#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
5039
5040#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
drh69b72d52015-06-01 20:28:03 +00005041/*
5042** Make copies of relevant WHERE clause terms of the outer query into
5043** the WHERE clause of subquery. Example:
5044**
5045** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1) WHERE x=5 AND y=10;
5046**
5047** Transformed into:
5048**
5049** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1 WHERE a=5 AND c-d=10)
5050** WHERE x=5 AND y=10;
5051**
5052** The hope is that the terms added to the inner query will make it more
5053** efficient.
5054**
5055** Do not attempt this optimization if:
5056**
drh25c221e2017-09-29 22:13:24 +00005057** (1) (** This restriction was removed on 2017-09-29. We used to
5058** disallow this optimization for aggregate subqueries, but now
drh67cc51a2017-09-30 11:47:06 +00005059** it is allowed by putting the extra terms on the HAVING clause.
5060** The added HAVING clause is pointless if the subquery lacks
5061** a GROUP BY clause. But such a HAVING clause is also harmless
5062** so there does not appear to be any reason to add extra logic
5063** to suppress it. **)
drh69b72d52015-06-01 20:28:03 +00005064**
5065** (2) The inner query is the recursive part of a common table expression.
5066**
5067** (3) The inner query has a LIMIT clause (since the changes to the WHERE
dance103732018-06-23 07:59:39 +00005068** clause would change the meaning of the LIMIT).
drh69b72d52015-06-01 20:28:03 +00005069**
drh6a9b9522018-03-27 15:13:43 +00005070** (4) The inner query is the right operand of a LEFT JOIN and the
5071** expression to be pushed down does not come from the ON clause
5072** on that LEFT JOIN.
drh69b72d52015-06-01 20:28:03 +00005073**
drh38978dd2015-08-22 01:32:29 +00005074** (5) The WHERE clause expression originates in the ON or USING clause
drh7fbb1012018-03-21 01:59:46 +00005075** of a LEFT JOIN where iCursor is not the right-hand table of that
5076** left join. An example:
5077**
5078** SELECT *
5079** FROM (SELECT 1 AS a1 UNION ALL SELECT 2) AS aa
5080** JOIN (SELECT 1 AS b2 UNION ALL SELECT 2) AS bb ON (a1=b2)
5081** LEFT JOIN (SELECT 8 AS c3 UNION ALL SELECT 9) AS cc ON (b2=2);
5082**
5083** The correct answer is three rows: (1,1,NULL),(2,2,8),(2,2,9).
5084** But if the (b2=2) term were to be pushed down into the bb subquery,
5085** then the (1,1,NULL) row would be suppressed.
drh38978dd2015-08-22 01:32:29 +00005086**
dan903fdd42021-02-22 20:56:13 +00005087** (6) Window functions make things tricky as changes to the WHERE clause
5088** of the inner query could change the window over which window
5089** functions are calculated. Therefore, do not attempt the optimization
5090** if:
5091**
5092** (6a) The inner query uses multiple incompatible window partitions.
5093**
5094** (6b) The inner query is a compound and uses window-functions.
5095**
5096** (6c) The WHERE clause does not consist entirely of constants and
5097** copies of expressions found in the PARTITION BY clause of
5098** all window-functions used by the sub-query. It is safe to
5099** filter out entire partitions, as this does not change the
5100** window over which any window-function is calculated.
dance103732018-06-23 07:59:39 +00005101**
drh745912e2021-02-22 03:04:25 +00005102** (7) The inner query is a Common Table Expression (CTE) that should
5103** be materialized. (This restriction is implemented in the calling
5104** routine.)
5105**
drh902ea832022-11-25 17:05:55 +00005106** (8) If the subquery is a compound that uses UNION, INTERSECT,
5107** or EXCEPT, then all of the result set columns for all arms of
5108** the compound must use the BINARY collating sequence.
dan195687f2022-10-26 21:14:21 +00005109**
drh23f61a42022-11-25 15:52:00 +00005110** (9) If the subquery is a compound, then all arms of the compound must
5111** have the same affinity. (This is the same as restriction (17h)
5112** for query flattening.)
5113**
5114**
drh69b72d52015-06-01 20:28:03 +00005115** Return 0 if no changes are made and non-zero if one or more WHERE clause
5116** terms are duplicated into the subquery.
5117*/
5118static int pushDownWhereTerms(
dan44c56042016-12-07 15:38:37 +00005119 Parse *pParse, /* Parse context (for malloc() and error reporting) */
drh69b72d52015-06-01 20:28:03 +00005120 Select *pSubq, /* The subquery whose WHERE clause is to be augmented */
5121 Expr *pWhere, /* The WHERE clause of the outer query */
drha9cdb902022-04-25 19:40:33 +00005122 SrcItem *pSrc /* The subquery term of the outer FROM clause */
drh69b72d52015-06-01 20:28:03 +00005123){
5124 Expr *pNew;
5125 int nChng = 0;
5126 if( pWhere==0 ) return 0;
dan903fdd42021-02-22 20:56:13 +00005127 if( pSubq->selFlags & (SF_Recursive|SF_MultiPart) ) return 0;
drh0e464b52022-04-25 20:47:58 +00005128 if( pSrc->fg.jointype & (JT_LTORJ|JT_RIGHT) ) return 0;
drh508e2d02017-09-30 01:25:04 +00005129
dan903fdd42021-02-22 20:56:13 +00005130 if( pSubq->pPrior ){
5131 Select *pSel;
drh902ea832022-11-25 17:05:55 +00005132 int notUnionAll = 0;
dan903fdd42021-02-22 20:56:13 +00005133 for(pSel=pSubq; pSel; pSel=pSel->pPrior){
dan195687f2022-10-26 21:14:21 +00005134 u8 op = pSel->op;
5135 assert( op==TK_ALL || op==TK_SELECT
5136 || op==TK_UNION || op==TK_INTERSECT || op==TK_EXCEPT );
drh902ea832022-11-25 17:05:55 +00005137 if( op!=TK_ALL && op!=TK_SELECT ){
5138 notUnionAll = 1;
5139 }
drh49d400b2022-11-25 16:32:59 +00005140#ifndef SQLITE_OMIT_WINDOWFUNC
dan903fdd42021-02-22 20:56:13 +00005141 if( pSel->pWin ) return 0; /* restriction (6b) */
drh49d400b2022-11-25 16:32:59 +00005142#endif
dan903fdd42021-02-22 20:56:13 +00005143 }
drh23f61a42022-11-25 15:52:00 +00005144 if( compoundHasDifferentAffinities(pSubq) ){
5145 return 0; /* restriction (9) */
5146 }
drh902ea832022-11-25 17:05:55 +00005147 if( notUnionAll ){
5148 /* If any of the compound arms are connected using UNION, INTERSECT,
5149 ** or EXCEPT, then we must ensure that none of the columns use a
5150 ** non-BINARY collating sequence. */
5151 for(pSel=pSubq; pSel; pSel=pSel->pPrior){
5152 int ii;
5153 const ExprList *pList = pSel->pEList;
5154 assert( pList!=0 );
5155 for(ii=0; ii<pList->nExpr; ii++){
5156 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pList->a[ii].pExpr);
5157 if( !sqlite3IsBinary(pColl) ){
5158 return 0; /* Restriction (8) */
5159 }
5160 }
5161 }
5162 }
dan903fdd42021-02-22 20:56:13 +00005163 }else{
drh49d400b2022-11-25 16:32:59 +00005164#ifndef SQLITE_OMIT_WINDOWFUNC
dan903fdd42021-02-22 20:56:13 +00005165 if( pSubq->pWin && pSubq->pWin->pPartition==0 ) return 0;
dance103732018-06-23 07:59:39 +00005166#endif
drh49d400b2022-11-25 16:32:59 +00005167 }
dance103732018-06-23 07:59:39 +00005168
drh508e2d02017-09-30 01:25:04 +00005169#ifdef SQLITE_DEBUG
5170 /* Only the first term of a compound can have a WITH clause. But make
5171 ** sure no other terms are marked SF_Recursive in case something changes
5172 ** in the future.
5173 */
5174 {
5175 Select *pX;
5176 for(pX=pSubq; pX; pX=pX->pPrior){
5177 assert( (pX->selFlags & (SF_Recursive))==0 );
drhb1ec87a2016-04-25 02:20:10 +00005178 }
drh69b72d52015-06-01 20:28:03 +00005179 }
drh508e2d02017-09-30 01:25:04 +00005180#endif
5181
drh69b72d52015-06-01 20:28:03 +00005182 if( pSubq->pLimit!=0 ){
drhb1ec87a2016-04-25 02:20:10 +00005183 return 0; /* restriction (3) */
drh69b72d52015-06-01 20:28:03 +00005184 }
5185 while( pWhere->op==TK_AND ){
drha9cdb902022-04-25 19:40:33 +00005186 nChng += pushDownWhereTerms(pParse, pSubq, pWhere->pRight, pSrc);
drh69b72d52015-06-01 20:28:03 +00005187 pWhere = pWhere->pLeft;
5188 }
drha9cdb902022-04-25 19:40:33 +00005189
5190#if 0 /* Legacy code. Checks now done by sqlite3ExprIsTableConstraint() */
drh6a9b9522018-03-27 15:13:43 +00005191 if( isLeftJoin
drh67a99db2022-05-13 14:52:04 +00005192 && (ExprHasProperty(pWhere,EP_OuterON)==0
drhd1985262022-04-11 11:25:28 +00005193 || pWhere->w.iJoin!=iCursor)
drh6a9b9522018-03-27 15:13:43 +00005194 ){
5195 return 0; /* restriction (4) */
5196 }
drh67a99db2022-05-13 14:52:04 +00005197 if( ExprHasProperty(pWhere,EP_OuterON)
drhd1985262022-04-11 11:25:28 +00005198 && pWhere->w.iJoin!=iCursor
drh796588a2022-02-05 21:49:47 +00005199 ){
drh7fbb1012018-03-21 01:59:46 +00005200 return 0; /* restriction (5) */
5201 }
drha9cdb902022-04-25 19:40:33 +00005202#endif
5203
drh5eb6e092022-04-25 20:38:42 +00005204 if( sqlite3ExprIsTableConstraint(pWhere, pSrc) ){
drh69b72d52015-06-01 20:28:03 +00005205 nChng++;
drh8794c682021-02-13 16:39:24 +00005206 pSubq->selFlags |= SF_PushDown;
drh69b72d52015-06-01 20:28:03 +00005207 while( pSubq ){
drh46967de2017-04-14 12:39:37 +00005208 SubstContext x;
dan44c56042016-12-07 15:38:37 +00005209 pNew = sqlite3ExprDup(pParse->db, pWhere, 0);
drh92d1afb2022-06-13 12:42:24 +00005210 unsetJoinExpr(pNew, -1, 1);
drh46967de2017-04-14 12:39:37 +00005211 x.pParse = pParse;
drha9cdb902022-04-25 19:40:33 +00005212 x.iTable = pSrc->iCursor;
5213 x.iNewTable = pSrc->iCursor;
drhc133bab2022-04-11 20:15:52 +00005214 x.isOuterJoin = 0;
drh46967de2017-04-14 12:39:37 +00005215 x.pEList = pSubq->pEList;
dan879164e2022-10-14 19:30:34 +00005216 x.pCList = findLeftmostExprlist(pSubq);
drh46967de2017-04-14 12:39:37 +00005217 pNew = substExpr(&x, pNew);
dan903fdd42021-02-22 20:56:13 +00005218#ifndef SQLITE_OMIT_WINDOWFUNC
5219 if( pSubq->pWin && 0==pushDownWindowCheck(pParse, pSubq, pNew) ){
5220 /* Restriction 6c has prevented push-down in this case */
5221 sqlite3ExprDelete(pParse->db, pNew);
5222 nChng--;
5223 break;
5224 }
5225#endif
drh25c221e2017-09-29 22:13:24 +00005226 if( pSubq->selFlags & SF_Aggregate ){
drhd5c851c2019-04-19 13:38:34 +00005227 pSubq->pHaving = sqlite3ExprAnd(pParse, pSubq->pHaving, pNew);
drh25c221e2017-09-29 22:13:24 +00005228 }else{
drhd5c851c2019-04-19 13:38:34 +00005229 pSubq->pWhere = sqlite3ExprAnd(pParse, pSubq->pWhere, pNew);
drh25c221e2017-09-29 22:13:24 +00005230 }
drh69b72d52015-06-01 20:28:03 +00005231 pSubq = pSubq->pPrior;
5232 }
5233 }
5234 return nChng;
5235}
5236#endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
5237
drh1350b032002-02-27 19:00:20 +00005238/*
drh47d9f832017-10-26 20:04:28 +00005239** The pFunc is the only aggregate function in the query. Check to see
5240** if the query is a candidate for the min/max optimization.
danielk1977a9d1ccb2008-01-05 17:39:29 +00005241**
drh47d9f832017-10-26 20:04:28 +00005242** If the query is a candidate for the min/max optimization, then set
5243** *ppMinMax to be an ORDER BY clause to be used for the optimization
5244** and return either WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX depending on
5245** whether pFunc is a min() or max() function.
danielk1977738bdcf2008-01-07 10:16:40 +00005246**
drh47d9f832017-10-26 20:04:28 +00005247** If the query is not a candidate for the min/max optimization, return
5248** WHERE_ORDERBY_NORMAL (which must be zero).
dan4ac391f2012-12-13 16:37:10 +00005249**
drh47d9f832017-10-26 20:04:28 +00005250** This routine must be called after aggregate functions have been
5251** located but before their arguments have been subjected to aggregate
5252** analysis.
danielk1977a9d1ccb2008-01-05 17:39:29 +00005253*/
drh47d9f832017-10-26 20:04:28 +00005254static u8 minMaxQuery(sqlite3 *db, Expr *pFunc, ExprList **ppMinMax){
5255 int eRet = WHERE_ORDERBY_NORMAL; /* Return value */
drha4eeccd2021-10-07 17:43:30 +00005256 ExprList *pEList; /* Arguments to agg function */
drh47d9f832017-10-26 20:04:28 +00005257 const char *zFunc; /* Name of aggregate function pFunc */
5258 ExprList *pOrderBy;
drhbe284e42020-02-27 16:21:39 +00005259 u8 sortFlags = 0;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005260
drh47d9f832017-10-26 20:04:28 +00005261 assert( *ppMinMax==0 );
5262 assert( pFunc->op==TK_AGG_FUNCTION );
dan4f9adee2019-07-13 16:22:50 +00005263 assert( !IsWindowFunc(pFunc) );
drha4eeccd2021-10-07 17:43:30 +00005264 assert( ExprUseXList(pFunc) );
5265 pEList = pFunc->x.pList;
drhaf7b7652021-01-13 19:28:17 +00005266 if( pEList==0
5267 || pEList->nExpr!=1
5268 || ExprHasProperty(pFunc, EP_WinFunc)
5269 || OptimizationDisabled(db, SQLITE_MinMaxOpt)
5270 ){
dan6ba7ab02019-07-02 11:56:47 +00005271 return eRet;
5272 }
drhf9751072021-10-07 13:40:29 +00005273 assert( !ExprHasProperty(pFunc, EP_IntValue) );
drh47d9f832017-10-26 20:04:28 +00005274 zFunc = pFunc->u.zToken;
5275 if( sqlite3StrICmp(zFunc, "min")==0 ){
5276 eRet = WHERE_ORDERBY_MIN;
dan67e2bb92020-02-27 15:07:16 +00005277 if( sqlite3ExprCanBeNull(pEList->a[0].pExpr) ){
5278 sortFlags = KEYINFO_ORDER_BIGNULL;
5279 }
drh47d9f832017-10-26 20:04:28 +00005280 }else if( sqlite3StrICmp(zFunc, "max")==0 ){
5281 eRet = WHERE_ORDERBY_MAX;
dan5b32bdf2019-08-17 15:47:32 +00005282 sortFlags = KEYINFO_ORDER_DESC;
drh47d9f832017-10-26 20:04:28 +00005283 }else{
5284 return eRet;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005285 }
drh47d9f832017-10-26 20:04:28 +00005286 *ppMinMax = pOrderBy = sqlite3ExprListDup(db, pEList, 0);
5287 assert( pOrderBy!=0 || db->mallocFailed );
drhd88fd532022-05-02 20:49:30 +00005288 if( pOrderBy ) pOrderBy->a[0].fg.sortFlags = sortFlags;
dan4ac391f2012-12-13 16:37:10 +00005289 return eRet;
danielk1977a9d1ccb2008-01-05 17:39:29 +00005290}
5291
5292/*
danielk1977a5533162009-02-24 10:01:51 +00005293** The select statement passed as the first argument is an aggregate query.
peter.d.reid60ec9142014-09-06 16:39:46 +00005294** The second argument is the associated aggregate-info object. This
danielk1977a5533162009-02-24 10:01:51 +00005295** function tests if the SELECT is of the form:
5296**
5297** SELECT count(*) FROM <tbl>
5298**
5299** where table is a database table, not a sub-select or view. If the query
5300** does match this pattern, then a pointer to the Table object representing
drha1c4c3c2021-11-05 11:52:33 +00005301** <tbl> is returned. Otherwise, NULL is returned.
5302**
drhe574a922021-11-26 15:08:55 +00005303** This routine checks to see if it is safe to use the count optimization.
5304** A correct answer is still obtained (though perhaps more slowly) if
5305** this routine returns NULL when it could have returned a table pointer.
5306** But returning the pointer when NULL should have been returned can
5307** result in incorrect answers and/or crashes. So, when in doubt, return NULL.
danielk1977a5533162009-02-24 10:01:51 +00005308*/
5309static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
5310 Table *pTab;
5311 Expr *pExpr;
5312
5313 assert( !p->pGroupBy );
5314
drha1c4c3c2021-11-05 11:52:33 +00005315 if( p->pWhere
5316 || p->pEList->nExpr!=1
5317 || p->pSrc->nSrc!=1
5318 || p->pSrc->a[0].pSelect
5319 || pAggInfo->nFunc!=1
dan2c1b1dd2022-07-01 21:03:19 +00005320 || p->pHaving
danielk1977a5533162009-02-24 10:01:51 +00005321 ){
5322 return 0;
5323 }
danielk1977a5533162009-02-24 10:01:51 +00005324 pTab = p->pSrc->a[0].pTab;
drha1c4c3c2021-11-05 11:52:33 +00005325 assert( pTab!=0 );
5326 assert( !IsView(pTab) );
5327 if( !IsOrdinaryTable(pTab) ) return 0;
danielk1977a5533162009-02-24 10:01:51 +00005328 pExpr = p->pEList->a[0].pExpr;
drha1c4c3c2021-11-05 11:52:33 +00005329 assert( pExpr!=0 );
danielk1977a5533162009-02-24 10:01:51 +00005330 if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
dan8745f8a2021-11-15 14:11:23 +00005331 if( pExpr->pAggInfo!=pAggInfo ) return 0;
drhd36e1042013-09-06 13:10:12 +00005332 if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
drha1c4c3c2021-11-05 11:52:33 +00005333 assert( pAggInfo->aFunc[0].pFExpr==pExpr );
5334 testcase( ExprHasProperty(pExpr, EP_Distinct) );
5335 testcase( ExprHasProperty(pExpr, EP_WinFunc) );
dan4f9adee2019-07-13 16:22:50 +00005336 if( ExprHasProperty(pExpr, EP_Distinct|EP_WinFunc) ) return 0;
danielk1977a5533162009-02-24 10:01:51 +00005337
5338 return pTab;
5339}
5340
5341/*
danielk1977b1c685b2008-10-06 16:18:39 +00005342** If the source-list item passed as an argument was augmented with an
5343** INDEXED BY clause, then try to locate the specified index. If there
5344** was such a clause and the named index cannot be found, return
5345** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
5346** pFrom->pIndex and return SQLITE_OK.
5347*/
drh76012942021-02-21 21:04:54 +00005348int sqlite3IndexedByLookup(Parse *pParse, SrcItem *pFrom){
drh18622712021-02-20 21:20:54 +00005349 Table *pTab = pFrom->pTab;
5350 char *zIndexedBy = pFrom->u1.zIndexedBy;
5351 Index *pIdx;
5352 assert( pTab!=0 );
5353 assert( pFrom->fg.isIndexedBy!=0 );
5354
5355 for(pIdx=pTab->pIndex;
5356 pIdx && sqlite3StrICmp(pIdx->zName, zIndexedBy);
5357 pIdx=pIdx->pNext
5358 );
5359 if( !pIdx ){
5360 sqlite3ErrorMsg(pParse, "no such index: %s", zIndexedBy, 0);
5361 pParse->checkSchema = 1;
5362 return SQLITE_ERROR;
danielk1977b1c685b2008-10-06 16:18:39 +00005363 }
drhdbfbb5a2021-10-07 23:04:50 +00005364 assert( pFrom->fg.isCte==0 );
drha79e2a22021-02-21 23:44:14 +00005365 pFrom->u2.pIBIndex = pIdx;
danielk1977b1c685b2008-10-06 16:18:39 +00005366 return SQLITE_OK;
5367}
drh18622712021-02-20 21:20:54 +00005368
drhc01b7302013-05-07 17:49:08 +00005369/*
5370** Detect compound SELECT statements that use an ORDER BY clause with
5371** an alternative collating sequence.
5372**
5373** SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
5374**
5375** These are rewritten as a subquery:
5376**
5377** SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
5378** ORDER BY ... COLLATE ...
5379**
5380** This transformation is necessary because the multiSelectOrderBy() routine
5381** above that generates the code for a compound SELECT with an ORDER BY clause
5382** uses a merge algorithm that requires the same collating sequence on the
5383** result columns as on the ORDER BY clause. See ticket
5384** http://www.sqlite.org/src/info/6709574d2a
5385**
5386** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
5387** The UNION ALL operator works fine with multiSelectOrderBy() even when
5388** there are COLLATE terms in the ORDER BY.
5389*/
5390static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
5391 int i;
5392 Select *pNew;
5393 Select *pX;
5394 sqlite3 *db;
5395 struct ExprList_item *a;
5396 SrcList *pNewSrc;
5397 Parse *pParse;
5398 Token dummy;
5399
5400 if( p->pPrior==0 ) return WRC_Continue;
5401 if( p->pOrderBy==0 ) return WRC_Continue;
5402 for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
5403 if( pX==0 ) return WRC_Continue;
5404 a = p->pOrderBy->a;
dan46daa992020-06-11 15:53:54 +00005405#ifndef SQLITE_OMIT_WINDOWFUNC
5406 /* If iOrderByCol is already non-zero, then it has already been matched
5407 ** to a result column of the SELECT statement. This occurs when the
5408 ** SELECT is rewritten for window-functions processing and then passed
5409 ** to sqlite3SelectPrep() and similar a second time. The rewriting done
5410 ** by this function is not required in this case. */
5411 if( a[0].u.x.iOrderByCol ) return WRC_Continue;
5412#endif
drhc01b7302013-05-07 17:49:08 +00005413 for(i=p->pOrderBy->nExpr-1; i>=0; i--){
5414 if( a[i].pExpr->flags & EP_Collate ) break;
5415 }
5416 if( i<0 ) return WRC_Continue;
5417
5418 /* If we reach this point, that means the transformation is required. */
5419
5420 pParse = pWalker->pParse;
5421 db = pParse->db;
5422 pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
5423 if( pNew==0 ) return WRC_Abort;
5424 memset(&dummy, 0, sizeof(dummy));
drhd44f8b22022-04-07 01:11:13 +00005425 pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0);
drhc01b7302013-05-07 17:49:08 +00005426 if( pNewSrc==0 ) return WRC_Abort;
5427 *pNew = *p;
5428 p->pSrc = pNewSrc;
drh1a1d3cd2015-11-19 16:33:31 +00005429 p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ASTERISK, 0));
drhc01b7302013-05-07 17:49:08 +00005430 p->op = TK_SELECT;
5431 p->pWhere = 0;
5432 pNew->pGroupBy = 0;
5433 pNew->pHaving = 0;
5434 pNew->pOrderBy = 0;
5435 p->pPrior = 0;
drh8af9ad92014-02-10 18:56:05 +00005436 p->pNext = 0;
drhf932f712015-04-12 17:35:27 +00005437 p->pWith = 0;
danfcc057d2019-12-04 01:42:07 +00005438#ifndef SQLITE_OMIT_WINDOWFUNC
5439 p->pWinDefn = 0;
5440#endif
drh8af9ad92014-02-10 18:56:05 +00005441 p->selFlags &= ~SF_Compound;
danb33c50f2015-04-04 16:43:16 +00005442 assert( (p->selFlags & SF_Converted)==0 );
5443 p->selFlags |= SF_Converted;
drha6e3a8c2014-02-10 21:07:51 +00005444 assert( pNew->pPrior!=0 );
5445 pNew->pPrior->pNext = pNew;
drhc01b7302013-05-07 17:49:08 +00005446 pNew->pLimit = 0;
drhc01b7302013-05-07 17:49:08 +00005447 return WRC_Continue;
5448}
danielk1977b1c685b2008-10-06 16:18:39 +00005449
drh20292312015-11-21 13:24:46 +00005450/*
5451** Check to see if the FROM clause term pFrom has table-valued function
5452** arguments. If it does, leave an error message in pParse and return
5453** non-zero, since pFrom is not allowed to be a table-valued function.
5454*/
drh76012942021-02-21 21:04:54 +00005455static int cannotBeFunction(Parse *pParse, SrcItem *pFrom){
drh20292312015-11-21 13:24:46 +00005456 if( pFrom->fg.isTabFunc ){
5457 sqlite3ErrorMsg(pParse, "'%s' is not a function", pFrom->zName);
5458 return 1;
5459 }
5460 return 0;
5461}
5462
daneede6a52014-01-15 19:42:23 +00005463#ifndef SQLITE_OMIT_CTE
5464/*
5465** Argument pWith (which may be NULL) points to a linked list of nested
5466** WITH contexts, from inner to outermost. If the table identified by
5467** FROM clause element pItem is really a common-table-expression (CTE)
5468** then return a pointer to the CTE definition for that table. Otherwise
5469** return NULL.
dan98f45e52014-01-17 17:40:46 +00005470**
5471** If a non-NULL value is returned, set *ppContext to point to the With
5472** object that the returned CTE belongs to.
drh60c1a2f2014-01-15 18:23:00 +00005473*/
dan98f45e52014-01-17 17:40:46 +00005474static struct Cte *searchWith(
drh2476a6f2015-11-07 15:19:59 +00005475 With *pWith, /* Current innermost WITH clause */
drh76012942021-02-21 21:04:54 +00005476 SrcItem *pItem, /* FROM clause element to resolve */
dan98f45e52014-01-17 17:40:46 +00005477 With **ppContext /* OUT: WITH clause return value belongs to */
5478){
drh5abe1d32021-02-21 01:19:42 +00005479 const char *zName = pItem->zName;
5480 With *p;
5481 assert( pItem->zDatabase==0 );
5482 assert( zName!=0 );
5483 for(p=pWith; p; p=p->pOuter){
5484 int i;
5485 for(i=0; i<p->nCte; i++){
5486 if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
5487 *ppContext = p;
5488 return &p->a[i];
dan4e9119d2014-01-13 15:12:23 +00005489 }
5490 }
dan90bc36f2021-05-20 17:15:06 +00005491 if( p->bView ) break;
dan4e9119d2014-01-13 15:12:23 +00005492 }
5493 return 0;
5494}
5495
drhc49832c2014-01-15 18:35:52 +00005496/* The code generator maintains a stack of active WITH clauses
5497** with the inner-most WITH clause being at the top of the stack.
5498**
danb290f112014-01-17 14:59:27 +00005499** This routine pushes the WITH clause passed as the second argument
5500** onto the top of the stack. If argument bFree is true, then this
drh7cc73b32021-05-23 17:47:04 +00005501** WITH clause will never be popped from the stack but should instead
5502** be freed along with the Parse object. In other cases, when
danb290f112014-01-17 14:59:27 +00005503** bFree==0, the With object will be freed along with the SELECT
5504** statement with which it is associated.
drh24ce9442021-06-12 17:45:32 +00005505**
5506** This routine returns a copy of pWith. Or, if bFree is true and
5507** the pWith object is destroyed immediately due to an OOM condition,
5508** then this routine return NULL.
5509**
5510** If bFree is true, do not continue to use the pWith pointer after
5511** calling this routine, Instead, use only the return value.
drhc49832c2014-01-15 18:35:52 +00005512*/
drh24ce9442021-06-12 17:45:32 +00005513With *sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
dan4e9119d2014-01-13 15:12:23 +00005514 if( pWith ){
drh24ce9442021-06-12 17:45:32 +00005515 if( bFree ){
5516 pWith = (With*)sqlite3ParserAddCleanup(pParse,
5517 (void(*)(sqlite3*,void*))sqlite3WithDelete,
5518 pWith);
5519 if( pWith==0 ) return 0;
5520 }
drh7cc73b32021-05-23 17:47:04 +00005521 if( pParse->nErr==0 ){
5522 assert( pParse->pWith!=pWith );
5523 pWith->pOuter = pParse->pWith;
5524 pParse->pWith = pWith;
5525 }
dan4e9119d2014-01-13 15:12:23 +00005526 }
drh24ce9442021-06-12 17:45:32 +00005527 return pWith;
dan4e9119d2014-01-13 15:12:23 +00005528}
dan4e9119d2014-01-13 15:12:23 +00005529
daneede6a52014-01-15 19:42:23 +00005530/*
daneede6a52014-01-15 19:42:23 +00005531** This function checks if argument pFrom refers to a CTE declared by
drh5abe1d32021-02-21 01:19:42 +00005532** a WITH clause on the stack currently maintained by the parser (on the
5533** pParse->pWith linked list). And if currently processing a CTE
5534** CTE expression, through routine checks to see if the reference is
5535** a recursive reference to the CTE.
daneede6a52014-01-15 19:42:23 +00005536**
drh5abe1d32021-02-21 01:19:42 +00005537** If pFrom matches a CTE according to either of these two above, pFrom->pTab
5538** and other fields are populated accordingly.
daneede6a52014-01-15 19:42:23 +00005539**
drh5abe1d32021-02-21 01:19:42 +00005540** Return 0 if no match is found.
5541** Return 1 if a match is found.
5542** Return 2 if an error condition is detected.
daneede6a52014-01-15 19:42:23 +00005543*/
drh5abe1d32021-02-21 01:19:42 +00005544static int resolveFromTermToCte(
5545 Parse *pParse, /* The parsing context */
5546 Walker *pWalker, /* Current tree walker */
drh76012942021-02-21 21:04:54 +00005547 SrcItem *pFrom /* The FROM clause term to check */
dan8ce71842014-01-14 20:14:09 +00005548){
drh5abe1d32021-02-21 01:19:42 +00005549 Cte *pCte; /* Matched CTE (or NULL if no match) */
5550 With *pWith; /* The matching WITH */
dan8ce71842014-01-14 20:14:09 +00005551
dan8ce71842014-01-14 20:14:09 +00005552 assert( pFrom->pTab==0 );
drh5abe1d32021-02-21 01:19:42 +00005553 if( pParse->pWith==0 ){
5554 /* There are no WITH clauses in the stack. No match is possible */
5555 return 0;
drh46a31cd2019-11-09 14:38:58 +00005556 }
drh93c81392021-05-21 21:49:07 +00005557 if( pParse->nErr ){
5558 /* Prior errors might have left pParse->pWith in a goofy state, so
5559 ** go no further. */
5560 return 0;
5561 }
drh5abe1d32021-02-21 01:19:42 +00005562 if( pFrom->zDatabase!=0 ){
5563 /* The FROM term contains a schema qualifier (ex: main.t1) and so
5564 ** it cannot possibly be a CTE reference. */
5565 return 0;
5566 }
drhcd1499f2021-05-20 00:44:04 +00005567 if( pFrom->fg.notCte ){
5568 /* The FROM term is specifically excluded from matching a CTE.
5569 ** (1) It is part of a trigger that used to have zDatabase but had
5570 ** zDatabase removed by sqlite3FixTriggerStep().
5571 ** (2) This is the first term in the FROM clause of an UPDATE.
5572 */
5573 return 0;
5574 }
dan98f45e52014-01-17 17:40:46 +00005575 pCte = searchWith(pParse->pWith, pFrom, &pWith);
daneae73fb2014-01-16 18:34:33 +00005576 if( pCte ){
drh5abe1d32021-02-21 01:19:42 +00005577 sqlite3 *db = pParse->db;
dan98f45e52014-01-17 17:40:46 +00005578 Table *pTab;
dan8ce71842014-01-14 20:14:09 +00005579 ExprList *pEList;
5580 Select *pSel;
dan60e70682014-01-15 15:27:51 +00005581 Select *pLeft; /* Left-most SELECT statement */
drh34055852020-10-19 01:23:48 +00005582 Select *pRecTerm; /* Left-most recursive term */
danf2655fe2014-01-16 21:02:02 +00005583 int bMayRecursive; /* True if compound joined by UNION [ALL] */
dan98f45e52014-01-17 17:40:46 +00005584 With *pSavedWith; /* Initial value of pParse->pWith */
drh34055852020-10-19 01:23:48 +00005585 int iRecTab = -1; /* Cursor for recursive table */
drh745912e2021-02-22 03:04:25 +00005586 CteUse *pCteUse;
danf2655fe2014-01-16 21:02:02 +00005587
drh0576bc52015-08-26 11:40:11 +00005588 /* If pCte->zCteErr is non-NULL at this point, then this is an illegal
danf2655fe2014-01-16 21:02:02 +00005589 ** recursive reference to CTE pCte. Leave an error in pParse and return
drh0576bc52015-08-26 11:40:11 +00005590 ** early. If pCte->zCteErr is NULL, then this is not a recursive reference.
danf2655fe2014-01-16 21:02:02 +00005591 ** In this case, proceed. */
drh0576bc52015-08-26 11:40:11 +00005592 if( pCte->zCteErr ){
5593 sqlite3ErrorMsg(pParse, pCte->zCteErr, pCte->zName);
drh5abe1d32021-02-21 01:19:42 +00005594 return 2;
danf2655fe2014-01-16 21:02:02 +00005595 }
drh5abe1d32021-02-21 01:19:42 +00005596 if( cannotBeFunction(pParse, pFrom) ) return 2;
dan8ce71842014-01-14 20:14:09 +00005597
drhc25e2eb2014-01-20 14:58:55 +00005598 assert( pFrom->pTab==0 );
drha79e2a22021-02-21 23:44:14 +00005599 pTab = sqlite3DbMallocZero(db, sizeof(Table));
drh5abe1d32021-02-21 01:19:42 +00005600 if( pTab==0 ) return 2;
drh745912e2021-02-22 03:04:25 +00005601 pCteUse = pCte->pUse;
5602 if( pCteUse==0 ){
5603 pCte->pUse = pCteUse = sqlite3DbMallocZero(db, sizeof(pCteUse[0]));
5604 if( pCteUse==0
5605 || sqlite3ParserAddCleanup(pParse,sqlite3DbFree,pCteUse)==0
drha79e2a22021-02-21 23:44:14 +00005606 ){
5607 sqlite3DbFree(db, pTab);
5608 return 2;
5609 }
drh745912e2021-02-22 03:04:25 +00005610 pCteUse->eM10d = pCte->eM10d;
drha79e2a22021-02-21 23:44:14 +00005611 }
5612 pFrom->pTab = pTab;
drh79df7782016-12-14 14:07:35 +00005613 pTab->nTabRef = 1;
dan2d4dc5f2014-01-17 11:48:24 +00005614 pTab->zName = sqlite3DbStrDup(db, pCte->zName);
dan8ce71842014-01-14 20:14:09 +00005615 pTab->iPKey = -1;
dancfc9df72014-04-25 15:01:01 +00005616 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drhfccda8a2015-05-27 13:06:55 +00005617 pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
dan8ce71842014-01-14 20:14:09 +00005618 pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
drh5abe1d32021-02-21 01:19:42 +00005619 if( db->mallocFailed ) return 2;
danac67f562021-06-14 20:08:48 +00005620 pFrom->pSelect->selFlags |= SF_CopyCte;
dan8ce71842014-01-14 20:14:09 +00005621 assert( pFrom->pSelect );
drh0c1da682021-10-09 16:00:56 +00005622 if( pFrom->fg.isIndexedBy ){
5623 sqlite3ErrorMsg(pParse, "no such index: \"%s\"", pFrom->u1.zIndexedBy);
5624 return 2;
5625 }
drha79e2a22021-02-21 23:44:14 +00005626 pFrom->fg.isCte = 1;
drh745912e2021-02-22 03:04:25 +00005627 pFrom->u2.pCteUse = pCteUse;
5628 pCteUse->nUse++;
5629 if( pCteUse->nUse>=2 && pCteUse->eM10d==M10d_Any ){
5630 pCteUse->eM10d = M10d_Yes;
5631 }
dan8ce71842014-01-14 20:14:09 +00005632
daneae73fb2014-01-16 18:34:33 +00005633 /* Check if this is a recursive CTE. */
drh34055852020-10-19 01:23:48 +00005634 pRecTerm = pSel = pFrom->pSelect;
danf2655fe2014-01-16 21:02:02 +00005635 bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
drh34055852020-10-19 01:23:48 +00005636 while( bMayRecursive && pRecTerm->op==pSel->op ){
daneae73fb2014-01-16 18:34:33 +00005637 int i;
drh34055852020-10-19 01:23:48 +00005638 SrcList *pSrc = pRecTerm->pSrc;
5639 assert( pRecTerm->pPrior!=0 );
daneae73fb2014-01-16 18:34:33 +00005640 for(i=0; i<pSrc->nSrc; i++){
drh76012942021-02-21 21:04:54 +00005641 SrcItem *pItem = &pSrc->a[i];
daneae73fb2014-01-16 18:34:33 +00005642 if( pItem->zDatabase==0
5643 && pItem->zName!=0
5644 && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
drh34055852020-10-19 01:23:48 +00005645 ){
daneae73fb2014-01-16 18:34:33 +00005646 pItem->pTab = pTab;
drh94d6f3f2020-10-19 20:49:54 +00005647 pTab->nTabRef++;
drh8a48b9c2015-08-19 15:20:00 +00005648 pItem->fg.isRecursive = 1;
drh34055852020-10-19 01:23:48 +00005649 if( pRecTerm->selFlags & SF_Recursive ){
5650 sqlite3ErrorMsg(pParse,
5651 "multiple references to recursive table: %s", pCte->zName
5652 );
drh5abe1d32021-02-21 01:19:42 +00005653 return 2;
drh34055852020-10-19 01:23:48 +00005654 }
drh34055852020-10-19 01:23:48 +00005655 pRecTerm->selFlags |= SF_Recursive;
5656 if( iRecTab<0 ) iRecTab = pParse->nTab++;
5657 pItem->iCursor = iRecTab;
daneae73fb2014-01-16 18:34:33 +00005658 }
5659 }
drh34055852020-10-19 01:23:48 +00005660 if( (pRecTerm->selFlags & SF_Recursive)==0 ) break;
5661 pRecTerm = pRecTerm->pPrior;
dan8ce71842014-01-14 20:14:09 +00005662 }
5663
drh0576bc52015-08-26 11:40:11 +00005664 pCte->zCteErr = "circular reference: %s";
dan98f45e52014-01-17 17:40:46 +00005665 pSavedWith = pParse->pWith;
5666 pParse->pWith = pWith;
drh34055852020-10-19 01:23:48 +00005667 if( pSel->selFlags & SF_Recursive ){
danca237a82021-03-18 18:25:43 +00005668 int rc;
drh34055852020-10-19 01:23:48 +00005669 assert( pRecTerm!=0 );
5670 assert( (pRecTerm->selFlags & SF_Recursive)==0 );
5671 assert( pRecTerm->pNext!=0 );
5672 assert( (pRecTerm->pNext->selFlags & SF_Recursive)!=0 );
5673 assert( pRecTerm->pWith==0 );
5674 pRecTerm->pWith = pSel->pWith;
danca237a82021-03-18 18:25:43 +00005675 rc = sqlite3WalkSelect(pWalker, pRecTerm);
drh34055852020-10-19 01:23:48 +00005676 pRecTerm->pWith = 0;
danca237a82021-03-18 18:25:43 +00005677 if( rc ){
5678 pParse->pWith = pSavedWith;
5679 return 2;
5680 }
dan067cd832017-02-03 19:16:39 +00005681 }else{
danca237a82021-03-18 18:25:43 +00005682 if( sqlite3WalkSelect(pWalker, pSel) ){
5683 pParse->pWith = pSavedWith;
5684 return 2;
5685 }
dan067cd832017-02-03 19:16:39 +00005686 }
drh6e772262015-11-07 17:48:21 +00005687 pParse->pWith = pWith;
daneae73fb2014-01-16 18:34:33 +00005688
dan60e70682014-01-15 15:27:51 +00005689 for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
5690 pEList = pLeft->pEList;
dan8ce71842014-01-14 20:14:09 +00005691 if( pCte->pCols ){
drh8f9d0b22015-03-21 03:18:22 +00005692 if( pEList && pEList->nExpr!=pCte->pCols->nExpr ){
drh727a99f2014-01-16 21:59:51 +00005693 sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
dan60e70682014-01-15 15:27:51 +00005694 pCte->zName, pEList->nExpr, pCte->pCols->nExpr
5695 );
dan98f45e52014-01-17 17:40:46 +00005696 pParse->pWith = pSavedWith;
drh5abe1d32021-02-21 01:19:42 +00005697 return 2;
dan60e70682014-01-15 15:27:51 +00005698 }
dan8ce71842014-01-14 20:14:09 +00005699 pEList = pCte->pCols;
dan8ce71842014-01-14 20:14:09 +00005700 }
dan8ce71842014-01-14 20:14:09 +00005701
drh8981b902015-08-24 17:42:49 +00005702 sqlite3ColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
danf2655fe2014-01-16 21:02:02 +00005703 if( bMayRecursive ){
5704 if( pSel->selFlags & SF_Recursive ){
drh0576bc52015-08-26 11:40:11 +00005705 pCte->zCteErr = "multiple recursive references: %s";
danf2655fe2014-01-16 21:02:02 +00005706 }else{
drh0576bc52015-08-26 11:40:11 +00005707 pCte->zCteErr = "recursive reference in a subquery: %s";
danf2655fe2014-01-16 21:02:02 +00005708 }
5709 sqlite3WalkSelect(pWalker, pSel);
5710 }
drh0576bc52015-08-26 11:40:11 +00005711 pCte->zCteErr = 0;
dan98f45e52014-01-17 17:40:46 +00005712 pParse->pWith = pSavedWith;
drh5abe1d32021-02-21 01:19:42 +00005713 return 1; /* Success */
dan8ce71842014-01-14 20:14:09 +00005714 }
drh5abe1d32021-02-21 01:19:42 +00005715 return 0; /* No match */
dan8ce71842014-01-14 20:14:09 +00005716}
daneede6a52014-01-15 19:42:23 +00005717#endif
dan4e9119d2014-01-13 15:12:23 +00005718
danb290f112014-01-17 14:59:27 +00005719#ifndef SQLITE_OMIT_CTE
dan71856942014-01-17 15:15:10 +00005720/*
5721** If the SELECT passed as the second argument has an associated WITH
5722** clause, pop it from the stack stored as part of the Parse object.
5723**
5724** This function is used as the xSelectCallback2() callback by
5725** sqlite3SelectExpand() when walking a SELECT tree to resolve table
5726** names and other FROM clause elements.
5727*/
danbe120832021-05-17 16:20:41 +00005728void sqlite3SelectPopWith(Walker *pWalker, Select *p){
danb290f112014-01-17 14:59:27 +00005729 Parse *pParse = pWalker->pParse;
drh2f65b2f2017-10-02 21:29:51 +00005730 if( OK_IF_ALWAYS_TRUE(pParse->pWith) && p->pPrior==0 ){
dan067cd832017-02-03 19:16:39 +00005731 With *pWith = findRightmost(p)->pWith;
5732 if( pWith!=0 ){
dan70a32702020-01-21 14:42:48 +00005733 assert( pParse->pWith==pWith || pParse->nErr );
dan067cd832017-02-03 19:16:39 +00005734 pParse->pWith = pWith->pOuter;
5735 }
danb290f112014-01-17 14:59:27 +00005736 }
danb290f112014-01-17 14:59:27 +00005737}
danb290f112014-01-17 14:59:27 +00005738#endif
5739
dan9a947222018-06-14 19:06:36 +00005740/*
drh3b880652022-10-19 11:58:24 +00005741** The SrcItem structure passed as the second argument represents a
dan9a947222018-06-14 19:06:36 +00005742** sub-query in the FROM clause of a SELECT statement. This function
drh3b880652022-10-19 11:58:24 +00005743** allocates and populates the SrcItem.pTab object. If successful,
dan9a947222018-06-14 19:06:36 +00005744** SQLITE_OK is returned. Otherwise, if an OOM error is encountered,
5745** SQLITE_NOMEM.
5746*/
drh76012942021-02-21 21:04:54 +00005747int sqlite3ExpandSubquery(Parse *pParse, SrcItem *pFrom){
dan86fb6e12018-05-16 20:58:07 +00005748 Select *pSel = pFrom->pSelect;
5749 Table *pTab;
5750
dan9a947222018-06-14 19:06:36 +00005751 assert( pSel );
dan86fb6e12018-05-16 20:58:07 +00005752 pFrom->pTab = pTab = sqlite3DbMallocZero(pParse->db, sizeof(Table));
dan9a947222018-06-14 19:06:36 +00005753 if( pTab==0 ) return SQLITE_NOMEM;
dan86fb6e12018-05-16 20:58:07 +00005754 pTab->nTabRef = 1;
5755 if( pFrom->zAlias ){
5756 pTab->zName = sqlite3DbStrDup(pParse->db, pFrom->zAlias);
5757 }else{
drhd6bb6002022-04-22 18:07:38 +00005758 pTab->zName = sqlite3MPrintf(pParse->db, "%!S", pFrom);
dan86fb6e12018-05-16 20:58:07 +00005759 }
5760 while( pSel->pPrior ){ pSel = pSel->pPrior; }
5761 sqlite3ColumnsFromExprList(pParse, pSel->pEList,&pTab->nCol,&pTab->aCol);
5762 pTab->iPKey = -1;
5763 pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
drh6e5020e2021-04-07 15:45:01 +00005764#ifndef SQLITE_ALLOW_ROWID_IN_VIEW
5765 /* The usual case - do not allow ROWID on a subquery */
5766 pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
5767#else
5768 pTab->tabFlags |= TF_Ephemeral; /* Legacy compatibility mode */
5769#endif
drhf4b33152019-04-23 12:30:15 +00005770 return pParse->nErr ? SQLITE_ERROR : SQLITE_OK;
dan86fb6e12018-05-16 20:58:07 +00005771}
5772
drh4ce7bf92022-04-15 18:30:48 +00005773
5774/*
5775** Check the N SrcItem objects to the right of pBase. (N might be zero!)
5776** If any of those SrcItem objects have a USING clause containing zName
5777** then return true.
5778**
5779** If N is zero, or none of the N SrcItem objects to the right of pBase
5780** contains a USING clause, or if none of the USING clauses contain zName,
5781** then return false.
5782*/
5783static int inAnyUsingClause(
5784 const char *zName, /* Name we are looking for */
5785 SrcItem *pBase, /* The base SrcItem. Looking at pBase[1] and following */
5786 int N /* How many SrcItems to check */
5787){
5788 while( N>0 ){
5789 N--;
5790 pBase++;
5791 if( pBase->fg.isUsing==0 ) continue;
drhe32d6a02022-04-19 15:56:03 +00005792 if( NEVER(pBase->u3.pUsing==0) ) continue;
drh4ce7bf92022-04-15 18:30:48 +00005793 if( sqlite3IdListIndex(pBase->u3.pUsing, zName)>=0 ) return 1;
5794 }
5795 return 0;
5796}
5797
5798
danielk1977b1c685b2008-10-06 16:18:39 +00005799/*
drh7d10d5a2008-08-20 16:35:10 +00005800** This routine is a Walker callback for "expanding" a SELECT statement.
5801** "Expanding" means to do the following:
5802**
5803** (1) Make sure VDBE cursor numbers have been assigned to every
5804** element of the FROM clause.
5805**
5806** (2) Fill in the pTabList->a[].pTab fields in the SrcList that
5807** defines FROM clause. When views appear in the FROM clause,
5808** fill pTabList->a[].pSelect with a copy of the SELECT statement
5809** that implements the view. A copy is made of the view's SELECT
5810** statement so that we can freely modify or delete that statement
peter.d.reid60ec9142014-09-06 16:39:46 +00005811** without worrying about messing up the persistent representation
drh7d10d5a2008-08-20 16:35:10 +00005812** of the view.
5813**
peter.d.reid60ec9142014-09-06 16:39:46 +00005814** (3) Add terms to the WHERE clause to accommodate the NATURAL keyword
drh7d10d5a2008-08-20 16:35:10 +00005815** on joins and the ON and USING clause of joins.
5816**
5817** (4) Scan the list of columns in the result set (pEList) looking
5818** for instances of the "*" operator or the TABLE.* operator.
5819** If found, expand each "*" to be every column in every table
5820** and TABLE.* to be every column in TABLE.
5821**
danielk1977b3bce662005-01-29 08:32:43 +00005822*/
drh7d10d5a2008-08-20 16:35:10 +00005823static int selectExpander(Walker *pWalker, Select *p){
5824 Parse *pParse = pWalker->pParse;
drh5abe1d32021-02-21 01:19:42 +00005825 int i, j, k, rc;
drh7d10d5a2008-08-20 16:35:10 +00005826 SrcList *pTabList;
5827 ExprList *pEList;
drh76012942021-02-21 21:04:54 +00005828 SrcItem *pFrom;
drh7d10d5a2008-08-20 16:35:10 +00005829 sqlite3 *db = pParse->db;
drh3e3f1a52013-01-03 00:45:56 +00005830 Expr *pE, *pRight, *pExpr;
drh785097d2013-02-12 22:09:48 +00005831 u16 selFlags = p->selFlags;
drhfca23552017-10-28 20:51:54 +00005832 u32 elistFlags = 0;
danielk1977b3bce662005-01-29 08:32:43 +00005833
drh785097d2013-02-12 22:09:48 +00005834 p->selFlags |= SF_Expanded;
drh7d10d5a2008-08-20 16:35:10 +00005835 if( db->mallocFailed ){
5836 return WRC_Abort;
danielk1977b3bce662005-01-29 08:32:43 +00005837 }
drh9d9c41e2017-10-31 03:40:15 +00005838 assert( p->pSrc!=0 );
5839 if( (selFlags & SF_Expanded)!=0 ){
drh7d10d5a2008-08-20 16:35:10 +00005840 return WRC_Prune;
danielk1977b3bce662005-01-29 08:32:43 +00005841 }
drh59145812019-05-22 22:49:23 +00005842 if( pWalker->eCode ){
5843 /* Renumber selId because it has been copied from a view */
5844 p->selId = ++pParse->nSelect;
5845 }
drh7d10d5a2008-08-20 16:35:10 +00005846 pTabList = p->pSrc;
danielk1977b3bce662005-01-29 08:32:43 +00005847 pEList = p->pEList;
dan90bc36f2021-05-20 17:15:06 +00005848 if( pParse->pWith && (p->selFlags & SF_View) ){
5849 if( p->pWith==0 ){
5850 p->pWith = (With*)sqlite3DbMallocZero(db, sizeof(With));
5851 if( p->pWith==0 ){
5852 return WRC_Abort;
5853 }
5854 }
5855 p->pWith->bView = 1;
5856 }
drha5746e02018-04-09 20:36:09 +00005857 sqlite3WithPush(pParse, p->pWith, 0);
drh7d10d5a2008-08-20 16:35:10 +00005858
5859 /* Make sure cursor numbers have been assigned to all entries in
5860 ** the FROM clause of the SELECT statement.
5861 */
5862 sqlite3SrcListAssignCursors(pParse, pTabList);
5863
5864 /* Look up every table named in the FROM clause of the select. If
5865 ** an entry of the FROM clause is a subquery instead of a table or view,
5866 ** then create a transient table structure to describe the subquery.
5867 */
5868 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5869 Table *pTab;
drhe2b7d7a2015-09-29 15:50:04 +00005870 assert( pFrom->fg.isRecursive==0 || pFrom->pTab!=0 );
dan69887c92020-04-27 20:55:33 +00005871 if( pFrom->pTab ) continue;
5872 assert( pFrom->fg.isRecursive==0 );
drh7d10d5a2008-08-20 16:35:10 +00005873 if( pFrom->zName==0 ){
5874#ifndef SQLITE_OMIT_SUBQUERY
5875 Select *pSel = pFrom->pSelect;
5876 /* A sub-query in the FROM clause of a SELECT */
5877 assert( pSel!=0 );
5878 assert( pFrom->pTab==0 );
drh2b8c5a02015-01-22 12:00:17 +00005879 if( sqlite3WalkSelect(pWalker, pSel) ) return WRC_Abort;
dandfa552f2018-06-02 21:04:28 +00005880 if( sqlite3ExpandSubquery(pParse, pFrom) ) return WRC_Abort;
dan86fb6e12018-05-16 20:58:07 +00005881#endif
drh5abe1d32021-02-21 01:19:42 +00005882#ifndef SQLITE_OMIT_CTE
5883 }else if( (rc = resolveFromTermToCte(pParse, pWalker, pFrom))!=0 ){
5884 if( rc>1 ) return WRC_Abort;
5885 pTab = pFrom->pTab;
5886 assert( pTab!=0 );
5887#endif
drh7d10d5a2008-08-20 16:35:10 +00005888 }else{
5889 /* An ordinary table or view name in the FROM clause */
5890 assert( pFrom->pTab==0 );
dan41fb5cd2012-10-04 19:33:00 +00005891 pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
drh7d10d5a2008-08-20 16:35:10 +00005892 if( pTab==0 ) return WRC_Abort;
drh79df7782016-12-14 14:07:35 +00005893 if( pTab->nTabRef>=0xffff ){
drhd2a56232013-01-28 19:00:20 +00005894 sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
5895 pTab->zName);
5896 pFrom->pTab = 0;
5897 return WRC_Abort;
5898 }
drh79df7782016-12-14 14:07:35 +00005899 pTab->nTabRef++;
drh20292312015-11-21 13:24:46 +00005900 if( !IsVirtual(pTab) && cannotBeFunction(pParse, pFrom) ){
5901 return WRC_Abort;
5902 }
dan8c812f92020-01-21 16:23:17 +00005903#if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
drhf38524d2021-08-02 16:41:57 +00005904 if( !IsOrdinaryTable(pTab) ){
drhbfad7be2015-10-11 20:39:46 +00005905 i16 nCol;
drh59145812019-05-22 22:49:23 +00005906 u8 eCodeOrig = pWalker->eCode;
drh7d10d5a2008-08-20 16:35:10 +00005907 if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
drh43152cf2009-05-19 19:04:58 +00005908 assert( pFrom->pSelect==0 );
drhf38524d2021-08-02 16:41:57 +00005909 if( IsView(pTab) ){
5910 if( (db->flags & SQLITE_EnableView)==0
5911 && pTab->pSchema!=db->aDb[1].pSchema
5912 ){
5913 sqlite3ErrorMsg(pParse, "access to view \"%s\" prohibited",
5914 pTab->zName);
5915 }
5916 pFrom->pSelect = sqlite3SelectDup(db, pTab->u.view.pSelect, 0);
danafaa6602021-09-30 18:42:52 +00005917 }
dan8c812f92020-01-21 16:23:17 +00005918#ifndef SQLITE_OMIT_VIRTUALTABLE
danafaa6602021-09-30 18:42:52 +00005919 else if( ALWAYS(IsVirtual(pTab))
drh3f681422020-01-07 18:10:56 +00005920 && pFrom->fg.fromDDL
drhf38524d2021-08-02 16:41:57 +00005921 && ALWAYS(pTab->u.vtab.p!=0)
5922 && pTab->u.vtab.p->eVtabRisk > ((db->flags & SQLITE_TrustedSchema)!=0)
drh3f681422020-01-07 18:10:56 +00005923 ){
drh32266a12020-01-09 13:08:28 +00005924 sqlite3ErrorMsg(pParse, "unsafe use of virtual table \"%s\"",
5925 pTab->zName);
drh11d88e62019-08-15 21:27:20 +00005926 }
drhf38524d2021-08-02 16:41:57 +00005927 assert( SQLITE_VTABRISK_Normal==1 && SQLITE_VTABRISK_High==2 );
dan8c812f92020-01-21 16:23:17 +00005928#endif
drhbfad7be2015-10-11 20:39:46 +00005929 nCol = pTab->nCol;
5930 pTab->nCol = -1;
drh59145812019-05-22 22:49:23 +00005931 pWalker->eCode = 1; /* Turn on Select.selId renumbering */
drh43152cf2009-05-19 19:04:58 +00005932 sqlite3WalkSelect(pWalker, pFrom->pSelect);
drh59145812019-05-22 22:49:23 +00005933 pWalker->eCode = eCodeOrig;
drhbfad7be2015-10-11 20:39:46 +00005934 pTab->nCol = nCol;
drh7d10d5a2008-08-20 16:35:10 +00005935 }
5936#endif
danielk1977b3bce662005-01-29 08:32:43 +00005937 }
danielk197785574e32008-10-06 05:32:18 +00005938
5939 /* Locate the index named by the INDEXED BY clause, if any. */
drh18622712021-02-20 21:20:54 +00005940 if( pFrom->fg.isIndexedBy && sqlite3IndexedByLookup(pParse, pFrom) ){
danielk1977b1c685b2008-10-06 16:18:39 +00005941 return WRC_Abort;
danielk197785574e32008-10-06 05:32:18 +00005942 }
danielk1977b3bce662005-01-29 08:32:43 +00005943 }
5944
drh7d10d5a2008-08-20 16:35:10 +00005945 /* Process NATURAL keywords, and ON and USING clauses of joins.
danielk1977b3bce662005-01-29 08:32:43 +00005946 */
drh0c7d3d32022-01-24 16:47:12 +00005947 assert( db->mallocFailed==0 || pParse->nErr!=0 );
drh358424a2022-04-15 15:15:01 +00005948 if( pParse->nErr || sqlite3ProcessJoin(pParse, p) ){
drh7d10d5a2008-08-20 16:35:10 +00005949 return WRC_Abort;
danielk1977b3bce662005-01-29 08:32:43 +00005950 }
5951
drh7d10d5a2008-08-20 16:35:10 +00005952 /* For every "*" that occurs in the column list, insert the names of
5953 ** all columns in all tables. And for every TABLE.* insert the names
5954 ** of all columns in TABLE. The parser inserted a special expression
drh1a1d3cd2015-11-19 16:33:31 +00005955 ** with the TK_ASTERISK operator for each "*" that it found in the column
5956 ** list. The following code just has to locate the TK_ASTERISK
5957 ** expressions and expand each one to the list of all columns in
5958 ** all tables.
danielk1977b3bce662005-01-29 08:32:43 +00005959 **
drh7d10d5a2008-08-20 16:35:10 +00005960 ** The first loop just checks to see if there are any "*" operators
5961 ** that need expanding.
danielk1977b3bce662005-01-29 08:32:43 +00005962 */
drh7d10d5a2008-08-20 16:35:10 +00005963 for(k=0; k<pEList->nExpr; k++){
drh3e3f1a52013-01-03 00:45:56 +00005964 pE = pEList->a[k].pExpr;
drh1a1d3cd2015-11-19 16:33:31 +00005965 if( pE->op==TK_ASTERISK ) break;
drh43152cf2009-05-19 19:04:58 +00005966 assert( pE->op!=TK_DOT || pE->pRight!=0 );
5967 assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
drh1a1d3cd2015-11-19 16:33:31 +00005968 if( pE->op==TK_DOT && pE->pRight->op==TK_ASTERISK ) break;
drhfca23552017-10-28 20:51:54 +00005969 elistFlags |= pE->flags;
danielk1977b3bce662005-01-29 08:32:43 +00005970 }
drh7d10d5a2008-08-20 16:35:10 +00005971 if( k<pEList->nExpr ){
5972 /*
5973 ** If we get here it means the result set contains one or more "*"
5974 ** operators that need to be expanded. Loop through each expression
5975 ** in the result set and expand them one by one.
5976 */
5977 struct ExprList_item *a = pEList->a;
5978 ExprList *pNew = 0;
5979 int flags = pParse->db->flags;
5980 int longNames = (flags & SQLITE_FullColNames)!=0
drh38b384a2013-01-03 17:34:28 +00005981 && (flags & SQLITE_ShortColNames)==0;
5982
drh7d10d5a2008-08-20 16:35:10 +00005983 for(k=0; k<pEList->nExpr; k++){
drh3e3f1a52013-01-03 00:45:56 +00005984 pE = a[k].pExpr;
drhfca23552017-10-28 20:51:54 +00005985 elistFlags |= pE->flags;
drh3e3f1a52013-01-03 00:45:56 +00005986 pRight = pE->pRight;
5987 assert( pE->op!=TK_DOT || pRight!=0 );
drh1a1d3cd2015-11-19 16:33:31 +00005988 if( pE->op!=TK_ASTERISK
5989 && (pE->op!=TK_DOT || pRight->op!=TK_ASTERISK)
5990 ){
drh7d10d5a2008-08-20 16:35:10 +00005991 /* This particular expression does not need to be expanded.
5992 */
drhb7916a72009-05-27 10:31:29 +00005993 pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
drh7d10d5a2008-08-20 16:35:10 +00005994 if( pNew ){
drh41cee662019-12-12 20:22:34 +00005995 pNew->a[pNew->nExpr-1].zEName = a[k].zEName;
drhd88fd532022-05-02 20:49:30 +00005996 pNew->a[pNew->nExpr-1].fg.eEName = a[k].fg.eEName;
drh41cee662019-12-12 20:22:34 +00005997 a[k].zEName = 0;
drh7d10d5a2008-08-20 16:35:10 +00005998 }
5999 a[k].pExpr = 0;
drh7d10d5a2008-08-20 16:35:10 +00006000 }else{
6001 /* This expression is a "*" or a "TABLE.*" and needs to be
6002 ** expanded. */
6003 int tableSeen = 0; /* Set to 1 when TABLE matches */
drh3e3f1a52013-01-03 00:45:56 +00006004 char *zTName = 0; /* text of name of TABLE */
drh43152cf2009-05-19 19:04:58 +00006005 if( pE->op==TK_DOT ){
6006 assert( pE->pLeft!=0 );
drh33e619f2009-05-28 01:00:55 +00006007 assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
6008 zTName = pE->pLeft->u.zToken;
drh7d10d5a2008-08-20 16:35:10 +00006009 }
6010 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
drh9c2d7aa2022-04-22 12:46:46 +00006011 Table *pTab = pFrom->pTab; /* Table for this data source */
6012 ExprList *pNestedFrom; /* Result-set of a nested FROM clause */
6013 char *zTabName; /* AS name for this data source */
6014 const char *zSchemaName = 0; /* Schema name for this data source */
6015 int iDb; /* Schema index for this data src */
drh63879a22022-05-02 20:04:34 +00006016 IdList *pUsing; /* USING clause for pFrom[1] */
drh9c2d7aa2022-04-22 12:46:46 +00006017
6018 if( (zTabName = pFrom->zAlias)==0 ){
drh7d10d5a2008-08-20 16:35:10 +00006019 zTabName = pTab->zName;
6020 }
6021 if( db->mallocFailed ) break;
mistachkin07fae322022-07-06 23:50:01 +00006022 assert( (int)pFrom->fg.isNestedFrom == IsNestedFrom(pFrom->pSelect) );
drh815b7822022-04-20 15:07:39 +00006023 if( pFrom->fg.isNestedFrom ){
drh9c2d7aa2022-04-22 12:46:46 +00006024 assert( pFrom->pSelect!=0 );
6025 pNestedFrom = pFrom->pSelect->pEList;
6026 assert( pNestedFrom!=0 );
6027 assert( pNestedFrom->nExpr==pTab->nCol );
drh815b7822022-04-20 15:07:39 +00006028 }else{
drh3e3f1a52013-01-03 00:45:56 +00006029 if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
6030 continue;
6031 }
drh9c2d7aa2022-04-22 12:46:46 +00006032 pNestedFrom = 0;
drh3e3f1a52013-01-03 00:45:56 +00006033 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh69c33822016-08-18 14:33:11 +00006034 zSchemaName = iDb>=0 ? db->aDb[iDb].zDbSName : "*";
drh7d10d5a2008-08-20 16:35:10 +00006035 }
drh45e41b72022-04-22 23:18:21 +00006036 if( i+1<pTabList->nSrc
6037 && pFrom[1].fg.isUsing
6038 && (selFlags & SF_NestedFrom)!=0
6039 ){
6040 int ii;
drh72d620b2022-05-02 19:59:03 +00006041 pUsing = pFrom[1].u3.pUsing;
drh45e41b72022-04-22 23:18:21 +00006042 for(ii=0; ii<pUsing->nId; ii++){
6043 const char *zUName = pUsing->a[ii].zName;
6044 pRight = sqlite3Expr(db, TK_ID, zUName);
6045 pNew = sqlite3ExprListAppend(pParse, pNew, pRight);
6046 if( pNew ){
6047 struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
6048 assert( pX->zEName==0 );
6049 pX->zEName = sqlite3MPrintf(db,"..%s", zUName);
drhd88fd532022-05-02 20:49:30 +00006050 pX->fg.eEName = ENAME_TAB;
6051 pX->fg.bUsingTerm = 1;
drh45e41b72022-04-22 23:18:21 +00006052 }
6053 }
drh72d620b2022-05-02 19:59:03 +00006054 }else{
6055 pUsing = 0;
drh45e41b72022-04-22 23:18:21 +00006056 }
drh7d10d5a2008-08-20 16:35:10 +00006057 for(j=0; j<pTab->nCol; j++){
drhcf9d36d2021-08-02 18:03:43 +00006058 char *zName = pTab->aCol[j].zCnName;
drh18f86002022-04-21 13:11:26 +00006059 struct ExprList_item *pX; /* Newly added ExprList term */
drh7d10d5a2008-08-20 16:35:10 +00006060
drhc75e09c2013-01-03 16:54:20 +00006061 assert( zName );
drh9c2d7aa2022-04-22 12:46:46 +00006062 if( zTName
6063 && pNestedFrom
6064 && sqlite3MatchEName(&pNestedFrom->a[j], 0, zTName, 0)==0
drh3e3f1a52013-01-03 00:45:56 +00006065 ){
6066 continue;
6067 }
6068
drh80090f92015-11-19 17:55:11 +00006069 /* If a column is marked as 'hidden', omit it from the expanded
6070 ** result-set list unless the SELECT has the SF_IncludeHidden
6071 ** bit set.
drh7d10d5a2008-08-20 16:35:10 +00006072 */
drhadef1592022-05-10 00:24:01 +00006073 if( (p->selFlags & SF_IncludeHidden)==0
6074 && IsHiddenColumn(&pTab->aCol[j])
6075 ){
6076 continue;
6077 }
6078 if( (pTab->aCol[j].colFlags & COLFLAG_NOEXPAND)!=0
6079 && zTName==0
6080 && (selFlags & (SF_NestedFrom))==0
6081 ){
6082 continue;
drh7d10d5a2008-08-20 16:35:10 +00006083 }
drh3e3f1a52013-01-03 00:45:56 +00006084 tableSeen = 1;
drh7d10d5a2008-08-20 16:35:10 +00006085
drh45e41b72022-04-22 23:18:21 +00006086 if( i>0 && zTName==0 && (selFlags & SF_NestedFrom)==0 ){
drhd44f8b22022-04-07 01:11:13 +00006087 if( pFrom->fg.isUsing
6088 && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0
6089 ){
drh7d10d5a2008-08-20 16:35:10 +00006090 /* In a join with a USING clause, omit columns in the
6091 ** using clause from the table on the right. */
6092 continue;
6093 }
6094 }
drhb7916a72009-05-27 10:31:29 +00006095 pRight = sqlite3Expr(db, TK_ID, zName);
drhbefbb402022-04-19 23:00:32 +00006096 if( (pTabList->nSrc>1
6097 && ( (pFrom->fg.jointype & JT_LTORJ)==0
drhd63c07e2022-04-23 14:30:22 +00006098 || (selFlags & SF_NestedFrom)!=0
drhbefbb402022-04-19 23:00:32 +00006099 || !inAnyUsingClause(zName,pFrom,pTabList->nSrc-i-1)
6100 )
6101 )
6102 || IN_RENAME_OBJECT
drh4ce7bf92022-04-15 18:30:48 +00006103 ){
drhb7916a72009-05-27 10:31:29 +00006104 Expr *pLeft;
6105 pLeft = sqlite3Expr(db, TK_ID, zTabName);
drhabfd35e2016-12-06 22:47:23 +00006106 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight);
dancbde37d2022-04-19 20:47:18 +00006107 if( IN_RENAME_OBJECT && pE->pLeft ){
6108 sqlite3RenameTokenRemap(pParse, pLeft, pE->pLeft);
6109 }
drh38b384a2013-01-03 17:34:28 +00006110 if( zSchemaName ){
drhc75e09c2013-01-03 16:54:20 +00006111 pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
drhabfd35e2016-12-06 22:47:23 +00006112 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr);
drhc75e09c2013-01-03 16:54:20 +00006113 }
drh7d10d5a2008-08-20 16:35:10 +00006114 }else{
6115 pExpr = pRight;
drh7d10d5a2008-08-20 16:35:10 +00006116 }
drhb7916a72009-05-27 10:31:29 +00006117 pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
drh18f86002022-04-21 13:11:26 +00006118 if( pNew==0 ){
6119 break; /* OOM */
6120 }
6121 pX = &pNew->a[pNew->nExpr-1];
6122 assert( pX->zEName==0 );
6123 if( (selFlags & SF_NestedFrom)!=0 && !IN_RENAME_OBJECT ){
drh9c2d7aa2022-04-22 12:46:46 +00006124 if( pNestedFrom ){
6125 pX->zEName = sqlite3DbStrDup(db, pNestedFrom->a[j].zEName);
drhcbb9da32019-12-12 22:11:33 +00006126 testcase( pX->zEName==0 );
drh3e3f1a52013-01-03 00:45:56 +00006127 }else{
drhcbb9da32019-12-12 22:11:33 +00006128 pX->zEName = sqlite3MPrintf(db, "%s.%s.%s",
drh18f86002022-04-21 13:11:26 +00006129 zSchemaName, zTabName, zName);
drhcbb9da32019-12-12 22:11:33 +00006130 testcase( pX->zEName==0 );
drh3e3f1a52013-01-03 00:45:56 +00006131 }
drhd88fd532022-05-02 20:49:30 +00006132 pX->fg.eEName = ENAME_TAB;
drh72d620b2022-05-02 19:59:03 +00006133 if( (pFrom->fg.isUsing
6134 && sqlite3IdListIndex(pFrom->u3.pUsing, zName)>=0)
6135 || (pUsing && sqlite3IdListIndex(pUsing, zName)>=0)
6136 || (pTab->aCol[j].colFlags & COLFLAG_NOEXPAND)!=0
6137 ){
drhd88fd532022-05-02 20:49:30 +00006138 pX->fg.bNoExpand = 1;
drh72d620b2022-05-02 19:59:03 +00006139 }
drh18f86002022-04-21 13:11:26 +00006140 }else if( longNames ){
6141 pX->zEName = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
drhd88fd532022-05-02 20:49:30 +00006142 pX->fg.eEName = ENAME_NAME;
drh18f86002022-04-21 13:11:26 +00006143 }else{
6144 pX->zEName = sqlite3DbStrDup(db, zName);
drhd88fd532022-05-02 20:49:30 +00006145 pX->fg.eEName = ENAME_NAME;
drh8f25d182012-12-19 02:36:45 +00006146 }
drh7d10d5a2008-08-20 16:35:10 +00006147 }
6148 }
6149 if( !tableSeen ){
6150 if( zTName ){
6151 sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
6152 }else{
6153 sqlite3ErrorMsg(pParse, "no tables specified");
6154 }
6155 }
drh7d10d5a2008-08-20 16:35:10 +00006156 }
drh9a993342007-12-13 02:45:31 +00006157 }
drh7d10d5a2008-08-20 16:35:10 +00006158 sqlite3ExprListDelete(db, pEList);
6159 p->pEList = pNew;
drh4c774312007-12-08 21:10:20 +00006160 }
drhfca23552017-10-28 20:51:54 +00006161 if( p->pEList ){
6162 if( p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
6163 sqlite3ErrorMsg(pParse, "too many columns in result set");
6164 return WRC_Abort;
6165 }
6166 if( (elistFlags & (EP_HasFunc|EP_Subquery))!=0 ){
6167 p->selFlags |= SF_ComplexResult;
6168 }
drh994c80a2007-04-12 21:25:01 +00006169 }
drhcebc8002022-04-16 18:33:22 +00006170#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00006171 if( sqlite3TreeTrace & 0x8 ){
6172 TREETRACE(0x8,pParse,p,("After result-set wildcard expansion:\n"));
drhcebc8002022-04-16 18:33:22 +00006173 sqlite3TreeViewSelect(0, p, 0);
6174 }
6175#endif
drh7d10d5a2008-08-20 16:35:10 +00006176 return WRC_Continue;
6177}
danielk1977b3bce662005-01-29 08:32:43 +00006178
drh979dd1b2017-05-29 14:26:07 +00006179#if SQLITE_DEBUG
6180/*
6181** Always assert. This xSelectCallback2 implementation proves that the
6182** xSelectCallback2 is never invoked.
6183*/
6184void sqlite3SelectWalkAssert2(Walker *NotUsed, Select *NotUsed2){
6185 UNUSED_PARAMETER2(NotUsed, NotUsed2);
6186 assert( 0 );
6187}
6188#endif
6189/*
drh7d10d5a2008-08-20 16:35:10 +00006190** This routine "expands" a SELECT statement and all of its subqueries.
6191** For additional information on what it means to "expand" a SELECT
6192** statement, see the comment on the selectExpand worker callback above.
6193**
6194** Expanding a SELECT statement is the first step in processing a
6195** SELECT statement. The SELECT statement must be expanded before
6196** name resolution is performed.
6197**
6198** If anything goes wrong, an error message is written into pParse.
6199** The calling function can detect the problem by looking at pParse->nErr
6200** and/or pParse->db->mallocFailed.
6201*/
6202static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
6203 Walker w;
drh5b88bc42013-12-07 23:35:21 +00006204 w.xExprCallback = sqlite3ExprWalkNoop;
drh7d10d5a2008-08-20 16:35:10 +00006205 w.pParse = pParse;
drh878fcf92017-10-02 23:50:08 +00006206 if( OK_IF_ALWAYS_TRUE(pParse->hasCompound) ){
drhd58d3272013-08-05 22:05:02 +00006207 w.xSelectCallback = convertCompoundSelectToSubquery;
drh979dd1b2017-05-29 14:26:07 +00006208 w.xSelectCallback2 = 0;
drhd58d3272013-08-05 22:05:02 +00006209 sqlite3WalkSelect(&w, pSelect);
6210 }
drhc01b7302013-05-07 17:49:08 +00006211 w.xSelectCallback = selectExpander;
danbe120832021-05-17 16:20:41 +00006212 w.xSelectCallback2 = sqlite3SelectPopWith;
drh59145812019-05-22 22:49:23 +00006213 w.eCode = 0;
drhc01b7302013-05-07 17:49:08 +00006214 sqlite3WalkSelect(&w, pSelect);
drh7d10d5a2008-08-20 16:35:10 +00006215}
6216
6217
6218#ifndef SQLITE_OMIT_SUBQUERY
6219/*
6220** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
6221** interface.
6222**
drh9e660872022-12-13 15:54:43 +00006223** For each FROM-clause subquery, add Column.zType, Column.zColl, and
6224** Column.affinity information to the Table structure that represents
6225** the result set of that subquery.
drh7d10d5a2008-08-20 16:35:10 +00006226**
6227** The Table structure that represents the result set was constructed
drh9e660872022-12-13 15:54:43 +00006228** by selectExpander() but the type and collation and affinity information
6229** was omitted at that point because identifiers had not yet been resolved.
6230** This routine is called after identifier resolution.
drh7d10d5a2008-08-20 16:35:10 +00006231*/
danb290f112014-01-17 14:59:27 +00006232static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
drh7d10d5a2008-08-20 16:35:10 +00006233 Parse *pParse;
6234 int i;
6235 SrcList *pTabList;
drh76012942021-02-21 21:04:54 +00006236 SrcItem *pFrom;
drh7d10d5a2008-08-20 16:35:10 +00006237
drh9d8b3072008-08-22 16:29:51 +00006238 assert( p->selFlags & SF_Resolved );
dancc464412018-06-19 18:11:05 +00006239 if( p->selFlags & SF_HasTypeInfo ) return;
drhe2b7d7a2015-09-29 15:50:04 +00006240 p->selFlags |= SF_HasTypeInfo;
6241 pParse = pWalker->pParse;
6242 pTabList = p->pSrc;
6243 for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
6244 Table *pTab = pFrom->pTab;
6245 assert( pTab!=0 );
6246 if( (pTab->tabFlags & TF_Ephemeral)!=0 ){
6247 /* A sub-query in the FROM clause of a SELECT */
6248 Select *pSel = pFrom->pSelect;
6249 if( pSel ){
drh00d6b272022-12-15 20:03:08 +00006250 sqlite3SubqueryColumnTypes(pParse, pTab, pSel, SQLITE_AFF_NONE);
drh5a29d9c2010-02-24 15:10:14 +00006251 }
drh13449892005-09-07 21:22:45 +00006252 }
6253 }
drh7d10d5a2008-08-20 16:35:10 +00006254}
6255#endif
drh13449892005-09-07 21:22:45 +00006256
drh7d10d5a2008-08-20 16:35:10 +00006257
6258/*
6259** This routine adds datatype and collating sequence information to
6260** the Table structures of all FROM-clause subqueries in a
6261** SELECT statement.
6262**
6263** Use this routine after name resolution.
6264*/
6265static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
6266#ifndef SQLITE_OMIT_SUBQUERY
6267 Walker w;
drh979dd1b2017-05-29 14:26:07 +00006268 w.xSelectCallback = sqlite3SelectWalkNoop;
danb290f112014-01-17 14:59:27 +00006269 w.xSelectCallback2 = selectAddSubqueryTypeInfo;
drh5b88bc42013-12-07 23:35:21 +00006270 w.xExprCallback = sqlite3ExprWalkNoop;
drh7d10d5a2008-08-20 16:35:10 +00006271 w.pParse = pParse;
6272 sqlite3WalkSelect(&w, pSelect);
6273#endif
6274}
6275
6276
6277/*
drh030796d2012-08-23 16:18:10 +00006278** This routine sets up a SELECT statement for processing. The
drh7d10d5a2008-08-20 16:35:10 +00006279** following is accomplished:
6280**
6281** * VDBE Cursor numbers are assigned to all FROM-clause terms.
6282** * Ephemeral Table objects are created for all FROM-clause subqueries.
6283** * ON and USING clauses are shifted into WHERE statements
6284** * Wildcards "*" and "TABLE.*" in result sets are expanded.
6285** * Identifiers in expression are matched to tables.
6286**
6287** This routine acts recursively on all subqueries within the SELECT.
6288*/
6289void sqlite3SelectPrep(
6290 Parse *pParse, /* The parser context */
6291 Select *p, /* The SELECT statement being coded. */
6292 NameContext *pOuterNC /* Name context for container */
6293){
drhe2463392017-10-03 14:24:24 +00006294 assert( p!=0 || pParse->db->mallocFailed );
drh0c7d3d32022-01-24 16:47:12 +00006295 assert( pParse->db->pParse==pParse );
drhe2463392017-10-03 14:24:24 +00006296 if( pParse->db->mallocFailed ) return;
drh7d10d5a2008-08-20 16:35:10 +00006297 if( p->selFlags & SF_HasTypeInfo ) return;
drh7d10d5a2008-08-20 16:35:10 +00006298 sqlite3SelectExpand(pParse, p);
drh0c7d3d32022-01-24 16:47:12 +00006299 if( pParse->nErr ) return;
drh7d10d5a2008-08-20 16:35:10 +00006300 sqlite3ResolveSelectNames(pParse, p, pOuterNC);
drh0c7d3d32022-01-24 16:47:12 +00006301 if( pParse->nErr ) return;
drh7d10d5a2008-08-20 16:35:10 +00006302 sqlite3SelectAddTypeInfo(pParse, p);
danielk1977b3bce662005-01-29 08:32:43 +00006303}
6304
drhc6138e92022-11-23 14:13:39 +00006305#if TREETRACE_ENABLED
danielk1977b3bce662005-01-29 08:32:43 +00006306/*
drhc6138e92022-11-23 14:13:39 +00006307** Display all information about an AggInfo object
6308*/
6309static void printAggInfo(AggInfo *pAggInfo){
6310 int ii;
6311 for(ii=0; ii<pAggInfo->nColumn; ii++){
6312 struct AggInfo_col *pCol = &pAggInfo->aCol[ii];
6313 sqlite3DebugPrintf(
6314 "agg-column[%d] pTab=%s iTable=%d iColumn=%d iMem=%d"
6315 " iSorterColumn=%d %s\n",
6316 ii, pCol->pTab ? pCol->pTab->zName : "NULL",
drh743c9ec2022-11-26 20:12:02 +00006317 pCol->iTable, pCol->iColumn, pAggInfo->iFirstReg+ii,
drhc6138e92022-11-23 14:13:39 +00006318 pCol->iSorterColumn,
6319 ii>=pAggInfo->nAccumulator ? "" : " Accumulator");
6320 sqlite3TreeViewExpr(0, pAggInfo->aCol[ii].pCExpr, 0);
6321 }
6322 for(ii=0; ii<pAggInfo->nFunc; ii++){
drh2e30d952022-11-23 18:51:04 +00006323 sqlite3DebugPrintf("agg-func[%d]: iMem=%d\n",
drha4569bd2022-12-19 12:25:41 +00006324 ii, pAggInfo->iFirstReg+pAggInfo->nColumn+ii);
drhc6138e92022-11-23 14:13:39 +00006325 sqlite3TreeViewExpr(0, pAggInfo->aFunc[ii].pFExpr, 0);
6326 }
6327}
6328#endif /* TREETRACE_ENABLED */
6329
6330/*
6331** Analyze the arguments to aggregate functions. Create new pAggInfo->aCol[]
6332** entries for columns that are arguments to aggregate functions but which
6333** are not otherwise used.
6334**
6335** The aCol[] entries in AggInfo prior to nAccumulator are columns that
6336** are referenced outside of aggregate functions. These might be columns
6337** that are part of the GROUP by clause, for example. Other database engines
6338** would throw an error if there is a column reference that is not in the
6339** GROUP BY clause and that is not part of an aggregate function argument.
6340** But SQLite allows this.
6341**
6342** The aCol[] entries beginning with the aCol[nAccumulator] and following
6343** are column references that are used exclusively as arguments to
6344** aggregate functions. This routine is responsible for computing
6345** (or recomputing) those aCol[] entries.
6346*/
6347static void analyzeAggFuncArgs(
drhc6138e92022-11-23 14:13:39 +00006348 AggInfo *pAggInfo,
6349 NameContext *pNC
6350){
6351 int i;
6352 assert( pAggInfo!=0 );
drh7960da02022-11-25 13:08:20 +00006353 assert( pAggInfo->iFirstReg==0 );
drhc6138e92022-11-23 14:13:39 +00006354 pNC->ncFlags |= NC_InAggFunc;
6355 for(i=0; i<pAggInfo->nFunc; i++){
6356 Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
6357 assert( ExprUseXList(pExpr) );
6358 sqlite3ExprAnalyzeAggList(pNC, pExpr->x.pList);
6359#ifndef SQLITE_OMIT_WINDOWFUNC
6360 assert( !IsWindowFunc(pExpr) );
6361 if( ExprHasProperty(pExpr, EP_WinFunc) ){
6362 sqlite3ExprAnalyzeAggregates(pNC, pExpr->y.pWin->pFilter);
6363 }
6364#endif
6365 }
6366 pNC->ncFlags &= ~NC_InAggFunc;
6367}
6368
6369/*
6370** An index on expressions is being used in the inner loop of an
6371** aggregate query with a GROUP BY clause. This routine attempts
6372** to adjust the AggInfo object to take advantage of index and to
6373** perhaps use the index as a covering index.
6374**
6375*/
6376static void optimizeAggregateUseOfIndexedExpr(
6377 Parse *pParse, /* Parsing context */
6378 Select *pSelect, /* The SELECT statement being processed */
6379 AggInfo *pAggInfo, /* The aggregate info */
6380 NameContext *pNC /* Name context used to resolve agg-func args */
6381){
drh7960da02022-11-25 13:08:20 +00006382 assert( pAggInfo->iFirstReg==0 );
drh590f0132022-11-23 17:56:00 +00006383 pAggInfo->nColumn = pAggInfo->nAccumulator;
drhc25f5ea2022-11-24 15:04:23 +00006384 if( ALWAYS(pAggInfo->nSortingColumn>0) ){
drh590f0132022-11-23 17:56:00 +00006385 if( pAggInfo->nColumn==0 ){
6386 pAggInfo->nSortingColumn = 0;
6387 }else{
6388 pAggInfo->nSortingColumn =
6389 pAggInfo->aCol[pAggInfo->nColumn-1].iSorterColumn+1;
6390 }
6391 }
drh5b046da2022-11-28 20:08:15 +00006392 analyzeAggFuncArgs(pAggInfo, pNC);
drhc6138e92022-11-23 14:13:39 +00006393#if TREETRACE_ENABLED
drh590f0132022-11-23 17:56:00 +00006394 if( sqlite3TreeTrace & 0x20 ){
drhc6138e92022-11-23 14:13:39 +00006395 IndexedExpr *pIEpr;
drh590f0132022-11-23 17:56:00 +00006396 TREETRACE(0x20, pParse, pSelect,
6397 ("AggInfo (possibly) adjusted for Indexed Exprs\n"));
6398 sqlite3TreeViewSelect(0, pSelect, 0);
drhc6138e92022-11-23 14:13:39 +00006399 for(pIEpr=pParse->pIdxEpr; pIEpr; pIEpr=pIEpr->pIENext){
6400 printf("data-cursor=%d index={%d,%d}\n",
6401 pIEpr->iDataCur, pIEpr->iIdxCur, pIEpr->iIdxCol);
6402 sqlite3TreeViewExpr(0, pIEpr->pExpr, 0);
6403 }
6404 printAggInfo(pAggInfo);
6405 }
6406#else
drh5b046da2022-11-28 20:08:15 +00006407 UNUSED_PARAMETER(pSelect);
6408 UNUSED_PARAMETER(pParse);
drhc6138e92022-11-23 14:13:39 +00006409#endif
drhc6138e92022-11-23 14:13:39 +00006410}
6411
6412/*
drh2e30d952022-11-23 18:51:04 +00006413** Walker callback for aggregateConvertIndexedExprRefToColumn().
6414*/
6415static int aggregateIdxEprRefToColCallback(Walker *pWalker, Expr *pExpr){
6416 AggInfo *pAggInfo;
6417 struct AggInfo_col *pCol;
drh5b046da2022-11-28 20:08:15 +00006418 UNUSED_PARAMETER(pWalker);
drh2e30d952022-11-23 18:51:04 +00006419 if( pExpr->pAggInfo==0 ) return WRC_Continue;
6420 if( pExpr->op==TK_AGG_COLUMN ) return WRC_Continue;
6421 if( pExpr->op==TK_AGG_FUNCTION ) return WRC_Continue;
drh8683c092022-11-24 23:35:27 +00006422 if( pExpr->op==TK_IF_NULL_ROW ) return WRC_Continue;
drh2e30d952022-11-23 18:51:04 +00006423 pAggInfo = pExpr->pAggInfo;
6424 assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
6425 pCol = &pAggInfo->aCol[pExpr->iAgg];
6426 pExpr->op = TK_AGG_COLUMN;
6427 pExpr->iTable = pCol->iTable;
6428 pExpr->iColumn = pCol->iColumn;
6429 return WRC_Prune;
6430}
6431
6432/*
6433** Convert every pAggInfo->aFunc[].pExpr such that any node within
6434** those expressions that has pAppInfo set is changed into a TK_AGG_COLUMN
6435** opcode.
6436*/
6437static void aggregateConvertIndexedExprRefToColumn(AggInfo *pAggInfo){
6438 int i;
6439 Walker w;
6440 memset(&w, 0, sizeof(w));
6441 w.xExprCallback = aggregateIdxEprRefToColCallback;
6442 for(i=0; i<pAggInfo->nFunc; i++){
6443 sqlite3WalkExpr(&w, pAggInfo->aFunc[i].pFExpr);
6444 }
6445}
6446
6447
6448/*
drhc6138e92022-11-23 14:13:39 +00006449** Allocate a block of registers so that there is one register for each
6450** pAggInfo->aCol[] and pAggInfo->aFunc[] entry in pAggInfo. The first
6451** register in this block is stored in pAggInfo->iFirstReg.
drh7960da02022-11-25 13:08:20 +00006452**
6453** This routine may only be called once for each AggInfo object. Prior
6454** to calling this routine:
6455**
6456** * The aCol[] and aFunc[] arrays may be modified
6457** * The AggInfoColumnReg() and AggInfoFuncReg() macros may not be used
6458**
6459** After clling this routine:
6460**
6461** * The aCol[] and aFunc[] arrays are fixed
6462** * The AggInfoColumnReg() and AggInfoFuncReg() macros may be used
6463**
drh42b78232022-11-22 14:10:22 +00006464*/
6465static void assignAggregateRegisters(Parse *pParse, AggInfo *pAggInfo){
drh42b78232022-11-22 14:10:22 +00006466 assert( pAggInfo!=0 );
drh3c8e4382022-11-22 15:43:16 +00006467 assert( pAggInfo->iFirstReg==0 );
6468 pAggInfo->iFirstReg = pParse->nMem + 1;
6469 pParse->nMem += pAggInfo->nColumn + pAggInfo->nFunc;
drh42b78232022-11-22 14:10:22 +00006470}
6471
danielk1977b3bce662005-01-29 08:32:43 +00006472/*
drh13449892005-09-07 21:22:45 +00006473** Reset the aggregate accumulator.
6474**
6475** The aggregate accumulator is a set of memory cells that hold
6476** intermediate results while calculating an aggregate. This
drh030796d2012-08-23 16:18:10 +00006477** routine generates code that stores NULLs in all of those memory
6478** cells.
danielk1977b3bce662005-01-29 08:32:43 +00006479*/
drh13449892005-09-07 21:22:45 +00006480static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
6481 Vdbe *v = pParse->pVdbe;
6482 int i;
drhc99130f2005-09-11 11:56:27 +00006483 struct AggInfo_func *pFunc;
drh7e61d182013-12-20 13:11:45 +00006484 int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
drh7960da02022-11-25 13:08:20 +00006485 assert( pAggInfo->iFirstReg>0 );
drh0c7d3d32022-01-24 16:47:12 +00006486 assert( pParse->db->pParse==pParse );
6487 assert( pParse->db->mallocFailed==0 || pParse->nErr!=0 );
drh7e61d182013-12-20 13:11:45 +00006488 if( nReg==0 ) return;
drh0c7d3d32022-01-24 16:47:12 +00006489 if( pParse->nErr ) return;
drh3c8e4382022-11-22 15:43:16 +00006490 sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->iFirstReg,
6491 pAggInfo->iFirstReg+nReg-1);
drhc99130f2005-09-11 11:56:27 +00006492 for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
drhc99130f2005-09-11 11:56:27 +00006493 if( pFunc->iDistinct>=0 ){
drh81185a52020-06-09 13:38:12 +00006494 Expr *pE = pFunc->pFExpr;
drha4eeccd2021-10-07 17:43:30 +00006495 assert( ExprUseXList(pE) );
danielk19776ab3a2e2009-02-19 14:39:25 +00006496 if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
drh0daa0022009-02-09 13:19:28 +00006497 sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
6498 "argument");
drhc99130f2005-09-11 11:56:27 +00006499 pFunc->iDistinct = -1;
6500 }else{
danf9eae182018-05-21 19:45:11 +00006501 KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pE->x.pList,0,0);
dan4fcb30b2021-03-09 16:06:25 +00006502 pFunc->iDistAddr = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
6503 pFunc->iDistinct, 0, 0, (char*)pKeyInfo, P4_KEYINFO);
drh9be13392021-03-24 19:44:01 +00006504 ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s(DISTINCT)",
6505 pFunc->pFunc->zName));
drhc99130f2005-09-11 11:56:27 +00006506 }
6507 }
drh13449892005-09-07 21:22:45 +00006508 }
danielk1977b3bce662005-01-29 08:32:43 +00006509}
6510
6511/*
drh13449892005-09-07 21:22:45 +00006512** Invoke the OP_AggFinalize opcode for every aggregate function
6513** in the AggInfo structure.
danielk1977b3bce662005-01-29 08:32:43 +00006514*/
drh13449892005-09-07 21:22:45 +00006515static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
6516 Vdbe *v = pParse->pVdbe;
6517 int i;
6518 struct AggInfo_func *pF;
6519 for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
drha4eeccd2021-10-07 17:43:30 +00006520 ExprList *pList;
6521 assert( ExprUseXList(pF->pFExpr) );
6522 pList = pF->pFExpr->x.pList;
drh3c8e4382022-11-22 15:43:16 +00006523 sqlite3VdbeAddOp2(v, OP_AggFinal, AggInfoFuncReg(pAggInfo,i),
6524 pList ? pList->nExpr : 0);
drh2700aca2016-12-08 01:38:24 +00006525 sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
drh13449892005-09-07 21:22:45 +00006526 }
danielk1977b3bce662005-01-29 08:32:43 +00006527}
drh13449892005-09-07 21:22:45 +00006528
dan280c8942018-06-05 20:04:28 +00006529
drh13449892005-09-07 21:22:45 +00006530/*
drhf5d06562022-11-25 13:15:48 +00006531** Generate code that will update the accumulator memory cells for an
6532** aggregate based on the current cursor position.
dan280c8942018-06-05 20:04:28 +00006533**
6534** If regAcc is non-zero and there are no min() or max() aggregates
6535** in pAggInfo, then only populate the pAggInfo->nAccumulator accumulator
drh10cc16c2019-03-01 21:12:40 +00006536** registers if register regAcc contains 0. The caller will take care
dan280c8942018-06-05 20:04:28 +00006537** of setting and clearing regAcc.
drh13449892005-09-07 21:22:45 +00006538*/
dan4fcb30b2021-03-09 16:06:25 +00006539static void updateAccumulator(
6540 Parse *pParse,
6541 int regAcc,
6542 AggInfo *pAggInfo,
6543 int eDistinctType
6544){
drh13449892005-09-07 21:22:45 +00006545 Vdbe *v = pParse->pVdbe;
6546 int i;
drh7a957892012-02-02 17:35:43 +00006547 int regHit = 0;
6548 int addrHitTest = 0;
drh13449892005-09-07 21:22:45 +00006549 struct AggInfo_func *pF;
6550 struct AggInfo_col *pC;
drh13449892005-09-07 21:22:45 +00006551
drh7960da02022-11-25 13:08:20 +00006552 assert( pAggInfo->iFirstReg>0 );
drhf5d06562022-11-25 13:15:48 +00006553 if( pParse->nErr ) return;
drh13449892005-09-07 21:22:45 +00006554 pAggInfo->directMode = 1;
6555 for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
6556 int nArg;
drhc99130f2005-09-11 11:56:27 +00006557 int addrNext = 0;
drh98757152008-01-09 23:04:12 +00006558 int regAgg;
drha4eeccd2021-10-07 17:43:30 +00006559 ExprList *pList;
6560 assert( ExprUseXList(pF->pFExpr) );
drh81185a52020-06-09 13:38:12 +00006561 assert( !IsWindowFunc(pF->pFExpr) );
drha4eeccd2021-10-07 17:43:30 +00006562 pList = pF->pFExpr->x.pList;
drh81185a52020-06-09 13:38:12 +00006563 if( ExprHasProperty(pF->pFExpr, EP_WinFunc) ){
6564 Expr *pFilter = pF->pFExpr->y.pWin->pFilter;
daned09ddd2019-09-20 20:52:16 +00006565 if( pAggInfo->nAccumulator
6566 && (pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL)
danfa4b0d42020-07-01 14:07:45 +00006567 && regAcc
daned09ddd2019-09-20 20:52:16 +00006568 ){
danfa4b0d42020-07-01 14:07:45 +00006569 /* If regAcc==0, there there exists some min() or max() function
6570 ** without a FILTER clause that will ensure the magnet registers
6571 ** are populated. */
daned09ddd2019-09-20 20:52:16 +00006572 if( regHit==0 ) regHit = ++pParse->nMem;
danfa4b0d42020-07-01 14:07:45 +00006573 /* If this is the first row of the group (regAcc contains 0), clear the
daned09ddd2019-09-20 20:52:16 +00006574 ** "magnet" register regHit so that the accumulator registers
danaf9b58b2019-09-20 21:12:40 +00006575 ** are populated if the FILTER clause jumps over the the
6576 ** invocation of min() or max() altogether. Or, if this is not
danfa4b0d42020-07-01 14:07:45 +00006577 ** the first row (regAcc contains 1), set the magnet register so that
6578 ** the accumulators are not populated unless the min()/max() is invoked
6579 ** and indicates that they should be. */
daned09ddd2019-09-20 20:52:16 +00006580 sqlite3VdbeAddOp2(v, OP_Copy, regAcc, regHit);
6581 }
dan6ba7ab02019-07-02 11:56:47 +00006582 addrNext = sqlite3VdbeMakeLabel(pParse);
6583 sqlite3ExprIfFalse(pParse, pFilter, addrNext, SQLITE_JUMPIFNULL);
6584 }
drh13449892005-09-07 21:22:45 +00006585 if( pList ){
6586 nArg = pList->nExpr;
drh892d3172008-01-10 03:46:36 +00006587 regAgg = sqlite3GetTempRange(pParse, nArg);
drh5579d592015-08-26 14:01:41 +00006588 sqlite3ExprCodeExprList(pParse, pList, regAgg, 0, SQLITE_ECEL_DUP);
drh13449892005-09-07 21:22:45 +00006589 }else{
6590 nArg = 0;
drh98757152008-01-09 23:04:12 +00006591 regAgg = 0;
drh13449892005-09-07 21:22:45 +00006592 }
dan4fcb30b2021-03-09 16:06:25 +00006593 if( pF->iDistinct>=0 && pList ){
dan6ba7ab02019-07-02 11:56:47 +00006594 if( addrNext==0 ){
6595 addrNext = sqlite3VdbeMakeLabel(pParse);
6596 }
dan5383db72021-03-12 18:24:31 +00006597 pF->iDistinct = codeDistinct(pParse, eDistinctType,
6598 pF->iDistinct, addrNext, pList, regAgg);
drhc99130f2005-09-11 11:56:27 +00006599 }
drhd36e1042013-09-06 13:10:12 +00006600 if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
drh13449892005-09-07 21:22:45 +00006601 CollSeq *pColl = 0;
6602 struct ExprList_item *pItem;
6603 int j;
drhe82f5d02008-10-07 19:53:14 +00006604 assert( pList!=0 ); /* pList!=0 if pF->pFunc has NEEDCOLL */
drh43617e92006-03-06 20:55:46 +00006605 for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
drh13449892005-09-07 21:22:45 +00006606 pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
6607 }
6608 if( !pColl ){
6609 pColl = pParse->db->pDfltColl;
6610 }
drh7a957892012-02-02 17:35:43 +00006611 if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
6612 sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
drh13449892005-09-07 21:22:45 +00006613 }
drh3c8e4382022-11-22 15:43:16 +00006614 sqlite3VdbeAddOp3(v, OP_AggStep, 0, regAgg, AggInfoFuncReg(pAggInfo,i));
drh2700aca2016-12-08 01:38:24 +00006615 sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
drhea678832008-12-10 19:26:22 +00006616 sqlite3VdbeChangeP5(v, (u8)nArg);
drhf49f3522009-12-30 14:12:38 +00006617 sqlite3ReleaseTempRange(pParse, regAgg, nArg);
drhc99130f2005-09-11 11:56:27 +00006618 if( addrNext ){
6619 sqlite3VdbeResolveLabel(v, addrNext);
6620 }
drh13449892005-09-07 21:22:45 +00006621 }
dan280c8942018-06-05 20:04:28 +00006622 if( regHit==0 && pAggInfo->nAccumulator ){
6623 regHit = regAcc;
6624 }
drh7a957892012-02-02 17:35:43 +00006625 if( regHit ){
drh688852a2014-02-17 22:40:43 +00006626 addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
drh7a957892012-02-02 17:35:43 +00006627 }
drh13449892005-09-07 21:22:45 +00006628 for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
drh3c8e4382022-11-22 15:43:16 +00006629 sqlite3ExprCode(pParse, pC->pCExpr, AggInfoColumnReg(pAggInfo,i));
drh13449892005-09-07 21:22:45 +00006630 }
daned09ddd2019-09-20 20:52:16 +00006631
drh13449892005-09-07 21:22:45 +00006632 pAggInfo->directMode = 0;
drh7a957892012-02-02 17:35:43 +00006633 if( addrHitTest ){
drhdc4f6fc2020-02-07 19:44:13 +00006634 sqlite3VdbeJumpHereOrPopInst(v, addrHitTest);
drh7a957892012-02-02 17:35:43 +00006635 }
drh13449892005-09-07 21:22:45 +00006636}
6637
danielk1977b3bce662005-01-29 08:32:43 +00006638/*
danef7075d2011-02-21 17:49:49 +00006639** Add a single OP_Explain instruction to the VDBE to explain a simple
6640** count(*) query ("SELECT count(*) FROM pTab").
6641*/
6642#ifndef SQLITE_OMIT_EXPLAIN
6643static void explainSimpleCount(
6644 Parse *pParse, /* Parse context */
6645 Table *pTab, /* Table being queried */
6646 Index *pIdx /* Index used to optimize scan, or NULL */
6647){
6648 if( pParse->explain==2 ){
drh48dd1d82014-05-27 18:18:58 +00006649 int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
drh82102332021-03-20 15:11:29 +00006650 sqlite3VdbeExplain(pParse, 0, "SCAN %s%s%s",
dane96f2df2014-05-23 17:17:06 +00006651 pTab->zName,
6652 bCover ? " USING COVERING INDEX " : "",
6653 bCover ? pIdx->zName : ""
danef7075d2011-02-21 17:49:49 +00006654 );
danef7075d2011-02-21 17:49:49 +00006655 }
6656}
6657#else
6658# define explainSimpleCount(a,b,c)
6659#endif
6660
6661/*
danab31a842017-04-29 20:53:09 +00006662** sqlite3WalkExpr() callback used by havingToWhere().
6663**
6664** If the node passed to the callback is a TK_AND node, return
6665** WRC_Continue to tell sqlite3WalkExpr() to iterate through child nodes.
6666**
6667** Otherwise, return WRC_Prune. In this case, also check if the
6668** sub-expression matches the criteria for being moved to the WHERE
6669** clause. If so, add it to the WHERE clause and replace the sub-expression
6670** within the HAVING expression with a constant "1".
6671*/
6672static int havingToWhereExprCb(Walker *pWalker, Expr *pExpr){
6673 if( pExpr->op!=TK_AND ){
drhcd0abc22018-03-20 18:08:33 +00006674 Select *pS = pWalker->u.pSelect;
dand59f9832021-07-20 14:57:49 +00006675 /* This routine is called before the HAVING clause of the current
6676 ** SELECT is analyzed for aggregates. So if pExpr->pAggInfo is set
6677 ** here, it indicates that the expression is a correlated reference to a
6678 ** column from an outer aggregate query, or an aggregate function that
6679 ** belongs to an outer query. Do not move the expression to the WHERE
6680 ** clause in this obscure case, as doing so may corrupt the outer Select
6681 ** statements AggInfo structure. */
danf39168e2020-12-22 16:23:29 +00006682 if( sqlite3ExprIsConstantOrGroupBy(pWalker->pParse, pExpr, pS->pGroupBy)
6683 && ExprAlwaysFalse(pExpr)==0
dand59f9832021-07-20 14:57:49 +00006684 && pExpr->pAggInfo==0
danf39168e2020-12-22 16:23:29 +00006685 ){
danab31a842017-04-29 20:53:09 +00006686 sqlite3 *db = pWalker->pParse->db;
drh5776ee52019-09-23 12:38:10 +00006687 Expr *pNew = sqlite3Expr(db, TK_INTEGER, "1");
danab31a842017-04-29 20:53:09 +00006688 if( pNew ){
drhcd0abc22018-03-20 18:08:33 +00006689 Expr *pWhere = pS->pWhere;
danab31a842017-04-29 20:53:09 +00006690 SWAP(Expr, *pNew, *pExpr);
drhd5c851c2019-04-19 13:38:34 +00006691 pNew = sqlite3ExprAnd(pWalker->pParse, pWhere, pNew);
drhcd0abc22018-03-20 18:08:33 +00006692 pS->pWhere = pNew;
6693 pWalker->eCode = 1;
danab31a842017-04-29 20:53:09 +00006694 }
6695 }
6696 return WRC_Prune;
6697 }
6698 return WRC_Continue;
6699}
6700
6701/*
6702** Transfer eligible terms from the HAVING clause of a query, which is
6703** processed after grouping, to the WHERE clause, which is processed before
6704** grouping. For example, the query:
6705**
6706** SELECT * FROM <tables> WHERE a=? GROUP BY b HAVING b=? AND c=?
6707**
6708** can be rewritten as:
6709**
6710** SELECT * FROM <tables> WHERE a=? AND b=? GROUP BY b HAVING c=?
6711**
6712** A term of the HAVING expression is eligible for transfer if it consists
6713** entirely of constants and expressions that are also GROUP BY terms that
6714** use the "BINARY" collation sequence.
6715*/
drhcd0abc22018-03-20 18:08:33 +00006716static void havingToWhere(Parse *pParse, Select *p){
danab31a842017-04-29 20:53:09 +00006717 Walker sWalker;
danab31a842017-04-29 20:53:09 +00006718 memset(&sWalker, 0, sizeof(sWalker));
6719 sWalker.pParse = pParse;
6720 sWalker.xExprCallback = havingToWhereExprCb;
drhcd0abc22018-03-20 18:08:33 +00006721 sWalker.u.pSelect = p;
6722 sqlite3WalkExpr(&sWalker, p->pHaving);
drh5e431be2022-04-06 11:08:38 +00006723#if TREETRACE_ENABLED
6724 if( sWalker.eCode && (sqlite3TreeTrace & 0x100)!=0 ){
drh5d7aef12022-11-22 19:49:16 +00006725 TREETRACE(0x100,pParse,p,("Move HAVING terms into WHERE:\n"));
drhcd0abc22018-03-20 18:08:33 +00006726 sqlite3TreeViewSelect(0, p, 0);
6727 }
6728#endif
danab31a842017-04-29 20:53:09 +00006729}
6730
6731/*
drh05cb9d82022-12-08 13:56:06 +00006732** Check to see if the pThis entry of pTabList is a self-join of another view.
6733** Search FROM-clause entries in the range of iFirst..iEnd, including iFirst
6734** but stopping before iEnd.
6735**
6736** If pThis is a self-join, then return the SrcItem for the first other
6737** instance of that view found. If pThis is not a self-join then return 0.
drhe08e8d62017-05-01 15:15:41 +00006738*/
drh76012942021-02-21 21:04:54 +00006739static SrcItem *isSelfJoinView(
drhe08e8d62017-05-01 15:15:41 +00006740 SrcList *pTabList, /* Search for self-joins in this FROM clause */
drh05cb9d82022-12-08 13:56:06 +00006741 SrcItem *pThis, /* Search for prior reference to this subquery */
6742 int iFirst, int iEnd /* Range of FROM-clause entries to search. */
drhe08e8d62017-05-01 15:15:41 +00006743){
drh76012942021-02-21 21:04:54 +00006744 SrcItem *pItem;
drh8794c682021-02-13 16:39:24 +00006745 assert( pThis->pSelect!=0 );
6746 if( pThis->pSelect->selFlags & SF_PushDown ) return 0;
drh05cb9d82022-12-08 13:56:06 +00006747 while( iFirst<iEnd ){
drhbdefaf02018-12-27 02:16:01 +00006748 Select *pS1;
drha60d61b2022-12-08 16:47:16 +00006749 pItem = &pTabList->a[iFirst++];
drhe08e8d62017-05-01 15:15:41 +00006750 if( pItem->pSelect==0 ) continue;
6751 if( pItem->fg.viaCoroutine ) continue;
drh33543c22017-05-01 16:37:20 +00006752 if( pItem->zName==0 ) continue;
drh30ad79a2019-05-23 16:38:12 +00006753 assert( pItem->pTab!=0 );
6754 assert( pThis->pTab!=0 );
6755 if( pItem->pTab->pSchema!=pThis->pTab->pSchema ) continue;
drhed712982017-05-01 17:04:35 +00006756 if( sqlite3_stricmp(pItem->zName, pThis->zName)!=0 ) continue;
drhbdefaf02018-12-27 02:16:01 +00006757 pS1 = pItem->pSelect;
drh30ad79a2019-05-23 16:38:12 +00006758 if( pItem->pTab->pSchema==0 && pThis->pSelect->selId!=pS1->selId ){
drhbdefaf02018-12-27 02:16:01 +00006759 /* The query flattener left two different CTE tables with identical
6760 ** names in the same FROM clause. */
6761 continue;
6762 }
drh8794c682021-02-13 16:39:24 +00006763 if( pItem->pSelect->selFlags & SF_PushDown ){
drhed712982017-05-01 17:04:35 +00006764 /* The view was modified by some other optimization such as
6765 ** pushDownWhereTerms() */
6766 continue;
6767 }
6768 return pItem;
drhe08e8d62017-05-01 15:15:41 +00006769 }
6770 return 0;
6771}
6772
drhc54246f2021-02-17 21:13:14 +00006773/*
6774** Deallocate a single AggInfo object
6775*/
6776static void agginfoFree(sqlite3 *db, AggInfo *p){
6777 sqlite3DbFree(db, p->aCol);
6778 sqlite3DbFree(db, p->aFunc);
6779 sqlite3DbFreeNN(db, p);
6780}
6781
drh269ba802017-07-04 19:34:36 +00006782#ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6783/*
6784** Attempt to transform a query of the form
6785**
6786** SELECT count(*) FROM (SELECT x FROM t1 UNION ALL SELECT y FROM t2)
6787**
6788** Into this:
6789**
6790** SELECT (SELECT count(*) FROM t1)+(SELECT count(*) FROM t2)
6791**
6792** The transformation only works if all of the following are true:
6793**
6794** * The subquery is a UNION ALL of two or more terms
dana4b5fb52018-08-03 20:19:52 +00006795** * The subquery does not have a LIMIT clause
drh269ba802017-07-04 19:34:36 +00006796** * There is no WHERE or GROUP BY or HAVING clauses on the subqueries
drh73c53b32019-05-15 18:42:15 +00006797** * The outer query is a simple count(*) with no WHERE clause or other
6798** extraneous syntax.
drh269ba802017-07-04 19:34:36 +00006799**
6800** Return TRUE if the optimization is undertaken.
6801*/
6802static int countOfViewOptimization(Parse *pParse, Select *p){
6803 Select *pSub, *pPrior;
6804 Expr *pExpr;
6805 Expr *pCount;
6806 sqlite3 *db;
drh3d240d22017-09-28 16:56:55 +00006807 if( (p->selFlags & SF_Aggregate)==0 ) return 0; /* This is an aggregate */
drh269ba802017-07-04 19:34:36 +00006808 if( p->pEList->nExpr!=1 ) return 0; /* Single result column */
drh73c53b32019-05-15 18:42:15 +00006809 if( p->pWhere ) return 0;
6810 if( p->pGroupBy ) return 0;
drh269ba802017-07-04 19:34:36 +00006811 pExpr = p->pEList->a[0].pExpr;
6812 if( pExpr->op!=TK_AGG_FUNCTION ) return 0; /* Result is an aggregate */
drha4eeccd2021-10-07 17:43:30 +00006813 assert( ExprUseUToken(pExpr) );
drh3d240d22017-09-28 16:56:55 +00006814 if( sqlite3_stricmp(pExpr->u.zToken,"count") ) return 0; /* Is count() */
drha4eeccd2021-10-07 17:43:30 +00006815 assert( ExprUseXList(pExpr) );
drh269ba802017-07-04 19:34:36 +00006816 if( pExpr->x.pList!=0 ) return 0; /* Must be count(*) */
drh3d240d22017-09-28 16:56:55 +00006817 if( p->pSrc->nSrc!=1 ) return 0; /* One table in FROM */
drh269ba802017-07-04 19:34:36 +00006818 pSub = p->pSrc->a[0].pSelect;
6819 if( pSub==0 ) return 0; /* The FROM is a subquery */
drh3d240d22017-09-28 16:56:55 +00006820 if( pSub->pPrior==0 ) return 0; /* Must be a compound ry */
drh269ba802017-07-04 19:34:36 +00006821 do{
6822 if( pSub->op!=TK_ALL && pSub->pPrior ) return 0; /* Must be UNION ALL */
6823 if( pSub->pWhere ) return 0; /* No WHERE clause */
dana4b5fb52018-08-03 20:19:52 +00006824 if( pSub->pLimit ) return 0; /* No LIMIT clause */
drh269ba802017-07-04 19:34:36 +00006825 if( pSub->selFlags & SF_Aggregate ) return 0; /* Not an aggregate */
drh3d240d22017-09-28 16:56:55 +00006826 pSub = pSub->pPrior; /* Repeat over compound */
drh269ba802017-07-04 19:34:36 +00006827 }while( pSub );
6828
drh3d240d22017-09-28 16:56:55 +00006829 /* If we reach this point then it is OK to perform the transformation */
drh269ba802017-07-04 19:34:36 +00006830
6831 db = pParse->db;
6832 pCount = pExpr;
6833 pExpr = 0;
6834 pSub = p->pSrc->a[0].pSelect;
6835 p->pSrc->a[0].pSelect = 0;
6836 sqlite3SrcListDelete(db, p->pSrc);
6837 p->pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*p->pSrc));
6838 while( pSub ){
6839 Expr *pTerm;
6840 pPrior = pSub->pPrior;
6841 pSub->pPrior = 0;
6842 pSub->pNext = 0;
6843 pSub->selFlags |= SF_Aggregate;
6844 pSub->selFlags &= ~SF_Compound;
6845 pSub->nSelectRow = 0;
6846 sqlite3ExprListDelete(db, pSub->pEList);
6847 pTerm = pPrior ? sqlite3ExprDup(db, pCount, 0) : pCount;
6848 pSub->pEList = sqlite3ExprListAppend(pParse, 0, pTerm);
6849 pTerm = sqlite3PExpr(pParse, TK_SELECT, 0, 0);
6850 sqlite3PExprAddSelect(pParse, pTerm, pSub);
6851 if( pExpr==0 ){
6852 pExpr = pTerm;
6853 }else{
6854 pExpr = sqlite3PExpr(pParse, TK_PLUS, pTerm, pExpr);
6855 }
6856 pSub = pPrior;
6857 }
6858 p->pEList->a[0].pExpr = pExpr;
6859 p->selFlags &= ~SF_Aggregate;
6860
drh5e431be2022-04-06 11:08:38 +00006861#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00006862 if( sqlite3TreeTrace & 0x200 ){
6863 TREETRACE(0x200,pParse,p,("After count-of-view optimization:\n"));
drh269ba802017-07-04 19:34:36 +00006864 sqlite3TreeViewSelect(0, p, 0);
6865 }
6866#endif
6867 return 1;
6868}
6869#endif /* SQLITE_COUNTOFVIEW_OPTIMIZATION */
6870
drhe08e8d62017-05-01 15:15:41 +00006871/*
drhfb98dac2022-05-25 02:32:11 +00006872** If any term of pSrc, or any SF_NestedFrom sub-query, is not the same
6873** as pSrcItem but has the same alias as p0, then return true.
6874** Otherwise return false.
6875*/
6876static int sameSrcAlias(SrcItem *p0, SrcList *pSrc){
6877 int i;
6878 for(i=0; i<pSrc->nSrc; i++){
6879 SrcItem *p1 = &pSrc->a[i];
6880 if( p1==p0 ) continue;
6881 if( p0->pTab==p1->pTab && 0==sqlite3_stricmp(p0->zAlias, p1->zAlias) ){
6882 return 1;
6883 }
6884 if( p1->pSelect
6885 && (p1->pSelect->selFlags & SF_NestedFrom)!=0
6886 && sameSrcAlias(p0, p1->pSelect->pSrc)
6887 ){
6888 return 1;
6889 }
6890 }
6891 return 0;
6892}
6893
6894/*
drhad9ff1d2022-12-06 15:24:05 +00006895** Return TRUE (non-zero) if the i-th entry in the pTabList SrcList can
6896** be implemented as a co-routine. The i-th entry is guaranteed to be
6897** a subquery.
6898**
6899** The subquery is implemented as a co-routine if all of the following are
6900** true:
6901**
drha60d61b2022-12-08 16:47:16 +00006902** (1) The subquery will likely be implemented in the outer loop of
6903** the query. This will be the case if any one of the following
6904** conditions hold:
6905** (a) The subquery is the only term in the FROM clause
6906** (b) The subquery is the left-most term and a CROSS JOIN or similar
6907** requires it to be the outer loop
6908** (c) All of the following are true:
6909** (i) The subquery is the left-most subquery in the FROM clause
6910** (ii) There is nothing that would prevent the subquery from
6911** being used as the outer loop if the sqlite3WhereBegin()
6912** routine nominates it to that position.
drh93f41e22022-12-09 18:26:15 +00006913** (iii) The query is not a UPDATE ... FROM
drha60d61b2022-12-08 16:47:16 +00006914** (2) The subquery is not a CTE that should be materialized because of
6915** the AS MATERIALIZED keywords
drhad9ff1d2022-12-06 15:24:05 +00006916** (3) The subquery is not part of a left operand for a RIGHT JOIN
6917** (4) The SQLITE_Coroutine optimization disable flag is not set
drh05cb9d82022-12-08 13:56:06 +00006918** (5) The subquery is not self-joined
drhad9ff1d2022-12-06 15:24:05 +00006919*/
6920static int fromClauseTermCanBeCoroutine(
drha60d61b2022-12-08 16:47:16 +00006921 Parse *pParse, /* Parsing context */
6922 SrcList *pTabList, /* FROM clause */
drh93f41e22022-12-09 18:26:15 +00006923 int i, /* Which term of the FROM clause holds the subquery */
6924 int selFlags /* Flags on the SELECT statement */
drhad9ff1d2022-12-06 15:24:05 +00006925){
6926 SrcItem *pItem = &pTabList->a[i];
6927 if( pItem->fg.isCte && pItem->u2.pCteUse->eM10d==M10d_Yes ) return 0;/* (2) */
6928 if( pTabList->a[0].fg.jointype & JT_LTORJ ) return 0; /* (3) */
6929 if( OptimizationDisabled(pParse->db, SQLITE_Coroutines) ) return 0; /* (4) */
drh05cb9d82022-12-08 13:56:06 +00006930 if( isSelfJoinView(pTabList, pItem, i+1, pTabList->nSrc)!=0 ){
drha60d61b2022-12-08 16:47:16 +00006931 return 0; /* (5) */
drh05cb9d82022-12-08 13:56:06 +00006932 }
drhad9ff1d2022-12-06 15:24:05 +00006933 if( i==0 ){
drha60d61b2022-12-08 16:47:16 +00006934 if( pTabList->nSrc==1 ) return 1; /* (1a) */
6935 if( pTabList->a[1].fg.jointype & JT_CROSS ) return 1; /* (1b) */
drh93f41e22022-12-09 18:26:15 +00006936 if( selFlags & SF_UpdateFrom ) return 0; /* (1c-iii) */
drhad9ff1d2022-12-06 15:24:05 +00006937 return 1;
6938 }
drh93f41e22022-12-09 18:26:15 +00006939 if( selFlags & SF_UpdateFrom ) return 0; /* (1c-iii) */
drhad9ff1d2022-12-06 15:24:05 +00006940 while( 1 /*exit-by-break*/ ){
drha60d61b2022-12-08 16:47:16 +00006941 if( pItem->fg.jointype & (JT_OUTER|JT_CROSS) ) return 0; /* (1c-ii) */
drhad9ff1d2022-12-06 15:24:05 +00006942 if( i==0 ) break;
6943 i--;
6944 pItem--;
drha60d61b2022-12-08 16:47:16 +00006945 if( pItem->pSelect!=0 ) return 0; /* (1c-i) */
drhad9ff1d2022-12-06 15:24:05 +00006946 }
6947 return 1;
6948}
6949
6950/*
drh7d10d5a2008-08-20 16:35:10 +00006951** Generate code for the SELECT statement given in the p argument.
drh9bb61fe2000-06-05 16:01:39 +00006952**
drh340309f2014-01-22 00:23:49 +00006953** The results are returned according to the SelectDest structure.
6954** See comments in sqliteInt.h for further information.
drhe78e8282003-01-19 03:59:45 +00006955**
drh9bb61fe2000-06-05 16:01:39 +00006956** This routine returns the number of errors. If any errors are
6957** encountered, then an appropriate error message is left in
6958** pParse->zErrMsg.
6959**
6960** This routine does NOT free the Select structure passed in. The
6961** calling function needs to do that.
6962*/
danielk19774adee202004-05-08 08:23:19 +00006963int sqlite3Select(
drhcce7d172000-05-31 15:34:51 +00006964 Parse *pParse, /* The parser context */
drh9bb61fe2000-06-05 16:01:39 +00006965 Select *p, /* The SELECT statement being coded. */
drh7d10d5a2008-08-20 16:35:10 +00006966 SelectDest *pDest /* What to do with the query results */
drhcce7d172000-05-31 15:34:51 +00006967){
drh13449892005-09-07 21:22:45 +00006968 int i, j; /* Loop counters */
6969 WhereInfo *pWInfo; /* Return from sqlite3WhereBegin() */
6970 Vdbe *v; /* The virtual machine under construction */
danielk1977b3bce662005-01-29 08:32:43 +00006971 int isAgg; /* True for select lists like "count(*)" */
mistachkinc29cbb02015-07-02 16:52:01 +00006972 ExprList *pEList = 0; /* List of columns to extract. */
drhad3cab52002-05-24 02:04:32 +00006973 SrcList *pTabList; /* List of tables to select from */
drh9bb61fe2000-06-05 16:01:39 +00006974 Expr *pWhere; /* The WHERE clause. May be NULL */
drh22827922000-06-06 17:27:05 +00006975 ExprList *pGroupBy; /* The GROUP BY clause. May be NULL */
6976 Expr *pHaving; /* The HAVING clause. May be NULL */
drhbf790972020-06-07 20:18:07 +00006977 AggInfo *pAggInfo = 0; /* Aggregate information */
drh1d83f052002-02-17 00:30:36 +00006978 int rc = 1; /* Value to return from this function */
drhe8e4af72012-09-21 00:04:28 +00006979 DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
drh079a3072014-03-19 14:10:55 +00006980 SortCtx sSort; /* Info on how to code the ORDER BY clause */
drhec7429a2005-10-06 16:53:14 +00006981 int iEnd; /* Address of the end of the query */
drh17435752007-08-16 04:30:38 +00006982 sqlite3 *db; /* The database connection */
drh47d9f832017-10-26 20:04:28 +00006983 ExprList *pMinMaxOrderBy = 0; /* Added ORDER BY for min/max queries */
6984 u8 minMaxFlag; /* Flag for min/max queries */
drh9bb61fe2000-06-05 16:01:39 +00006985
drh17435752007-08-16 04:30:38 +00006986 db = pParse->db;
drh0c7d3d32022-01-24 16:47:12 +00006987 assert( pParse==db->pParse );
drhe2ca99c2018-05-02 00:33:43 +00006988 v = sqlite3GetVdbe(pParse);
drh0c7d3d32022-01-24 16:47:12 +00006989 if( p==0 || pParse->nErr ){
drh6f7adc82006-01-11 21:41:20 +00006990 return 1;
6991 }
drh0c7d3d32022-01-24 16:47:12 +00006992 assert( db->mallocFailed==0 );
danielk19774adee202004-05-08 08:23:19 +00006993 if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
drh5e431be2022-04-06 11:08:38 +00006994#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00006995 TREETRACE(0x1,pParse,p, ("begin processing:\n", pParse->addrExplain));
6996 if( sqlite3TreeTrace & 0x10000 ){
drhc2d0df92022-04-06 18:30:17 +00006997 if( (sqlite3TreeTrace & 0x10001)==0x10000 ){
6998 sqlite3TreeViewLine(0, "In sqlite3Select() at %s:%d",
6999 __FILE__, __LINE__);
7000 }
7001 sqlite3ShowSelect(p);
drhc90713d2014-09-30 13:46:49 +00007002 }
drheb9b8842014-09-21 00:27:26 +00007003#endif
drhdaffd0e2001-04-11 14:28:42 +00007004
drh8e1ee882014-03-21 19:56:09 +00007005 assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
7006 assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
dan9afccba2014-03-21 19:27:54 +00007007 assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
7008 assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
drhf1ea4252020-09-17 00:46:09 +00007009 if( IgnorableDistinct(pDest) ){
7010 assert(pDest->eDest==SRT_Exists || pDest->eDest==SRT_Union ||
7011 pDest->eDest==SRT_Except || pDest->eDest==SRT_Discard ||
7012 pDest->eDest==SRT_DistQueue || pDest->eDest==SRT_DistFifo );
7013 /* All of these destinations are also able to ignore the ORDER BY clause */
drhfad1ad02021-03-03 14:07:52 +00007014 if( p->pOrderBy ){
drh5e431be2022-04-06 11:08:38 +00007015#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007016 TREETRACE(0x800,pParse,p, ("dropping superfluous ORDER BY:\n"));
7017 if( sqlite3TreeTrace & 0x800 ){
drhfad1ad02021-03-03 14:07:52 +00007018 sqlite3TreeViewExprList(0, p->pOrderBy, 0, "ORDERBY");
7019 }
7020#endif
7021 sqlite3ParserAddCleanup(pParse,
7022 (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
7023 p->pOrderBy);
drh6d0053c2021-03-09 19:32:37 +00007024 testcase( pParse->earlyCleanup );
drhfad1ad02021-03-03 14:07:52 +00007025 p->pOrderBy = 0;
7026 }
drh7d10d5a2008-08-20 16:35:10 +00007027 p->selFlags &= ~SF_Distinct;
drhb7cbf5c2020-06-15 13:51:34 +00007028 p->selFlags |= SF_NoopOrderBy;
drh9a993342007-12-13 02:45:31 +00007029 }
drh7d10d5a2008-08-20 16:35:10 +00007030 sqlite3SelectPrep(pParse, p, 0);
drh0c7d3d32022-01-24 16:47:12 +00007031 if( pParse->nErr ){
drh9a993342007-12-13 02:45:31 +00007032 goto select_end;
7033 }
drh0c7d3d32022-01-24 16:47:12 +00007034 assert( db->mallocFailed==0 );
drhadc57f62015-06-06 00:18:01 +00007035 assert( p->pEList!=0 );
drh5e431be2022-04-06 11:08:38 +00007036#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007037 if( sqlite3TreeTrace & 0x10 ){
7038 TREETRACE(0x10,pParse,p, ("after name resolution:\n"));
drh17645f52015-02-09 13:42:59 +00007039 sqlite3TreeViewSelect(0, p, 0);
7040 }
7041#endif
drhcce7d172000-05-31 15:34:51 +00007042
dan5daf69e2021-07-05 11:27:13 +00007043 /* If the SF_UFSrcCheck flag is set, then this function is being called
dan07ca7d62020-07-17 16:31:37 +00007044 ** as part of populating the temp table for an UPDATE...FROM statement.
7045 ** In this case, it is an error if the target object (pSrc->a[0]) name
dan5daf69e2021-07-05 11:27:13 +00007046 ** or alias is duplicated within FROM clause (pSrc->a[1..n]).
7047 **
7048 ** Postgres disallows this case too. The reason is that some other
7049 ** systems handle this case differently, and not all the same way,
7050 ** which is just confusing. To avoid this, we follow PG's lead and
7051 ** disallow it altogether. */
7052 if( p->selFlags & SF_UFSrcCheck ){
drh76012942021-02-21 21:04:54 +00007053 SrcItem *p0 = &p->pSrc->a[0];
drhfb98dac2022-05-25 02:32:11 +00007054 if( sameSrcAlias(p0, p->pSrc) ){
7055 sqlite3ErrorMsg(pParse,
7056 "target object/alias may not appear in FROM clause: %s",
7057 p0->zAlias ? p0->zAlias : p0->pTab->zName
7058 );
7059 goto select_end;
dan07ca7d62020-07-17 16:31:37 +00007060 }
dan5daf69e2021-07-05 11:27:13 +00007061
7062 /* Clear the SF_UFSrcCheck flag. The check has already been performed,
7063 ** and leaving this flag set can cause errors if a compound sub-query
7064 ** in p->pSrc is flattened into this query and this function called
7065 ** again as part of compound SELECT processing. */
7066 p->selFlags &= ~SF_UFSrcCheck;
dan07ca7d62020-07-17 16:31:37 +00007067 }
7068
drhf35f2f92017-07-29 16:01:55 +00007069 if( pDest->eDest==SRT_Output ){
drh90881862021-05-19 12:17:03 +00007070 sqlite3GenerateColumnNames(pParse, p);
drhf35f2f92017-07-29 16:01:55 +00007071 }
7072
dan67a9b8e2018-06-22 20:51:35 +00007073#ifndef SQLITE_OMIT_WINDOWFUNC
dan44918c72021-04-17 14:42:37 +00007074 if( sqlite3WindowRewrite(pParse, p) ){
drh0c7d3d32022-01-24 16:47:12 +00007075 assert( pParse->nErr );
dan86fb6e12018-05-16 20:58:07 +00007076 goto select_end;
7077 }
drh5e431be2022-04-06 11:08:38 +00007078#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007079 if( p->pWin && (sqlite3TreeTrace & 0x40)!=0 ){
7080 TREETRACE(0x40,pParse,p, ("after window rewrite:\n"));
dandfa552f2018-06-02 21:04:28 +00007081 sqlite3TreeViewSelect(0, p, 0);
7082 }
7083#endif
dan67a9b8e2018-06-22 20:51:35 +00007084#endif /* SQLITE_OMIT_WINDOWFUNC */
dan86fb6e12018-05-16 20:58:07 +00007085 pTabList = p->pSrc;
dan73925692018-06-12 18:40:17 +00007086 isAgg = (p->selFlags & SF_Aggregate)!=0;
danf02cdd32018-06-27 19:48:50 +00007087 memset(&sSort, 0, sizeof(sSort));
7088 sSort.pOrderBy = p->pOrderBy;
dan86fb6e12018-05-16 20:58:07 +00007089
drh9216de82020-06-11 00:57:09 +00007090 /* Try to do various optimizations (flattening subqueries, and strength
drh25897872018-03-20 21:16:15 +00007091 ** reduction of join operators) in the FROM clause up into the main query
drhd820cb12002-02-18 03:21:45 +00007092 */
drh51522cd2005-01-20 13:36:19 +00007093#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
danielk1977f23329a2008-07-01 14:09:13 +00007094 for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
drh76012942021-02-21 21:04:54 +00007095 SrcItem *pItem = &pTabList->a[i];
danielk1977daf79ac2008-06-30 18:12:28 +00007096 Select *pSub = pItem->pSelect;
drh2679f142015-09-25 13:42:55 +00007097 Table *pTab = pItem->pTab;
drh25897872018-03-20 21:16:15 +00007098
drhb5aaee52020-06-11 16:04:10 +00007099 /* The expander should have already created transient Table objects
7100 ** even for FROM clause elements such as subqueries that do not correspond
7101 ** to a real table */
7102 assert( pTab!=0 );
7103
drh25897872018-03-20 21:16:15 +00007104 /* Convert LEFT JOIN into JOIN if there are terms of the right table
7105 ** of the LEFT JOIN used in the WHERE clause.
7106 */
drhff02ac72022-04-11 14:43:11 +00007107 if( (pItem->fg.jointype & (JT_LEFT|JT_RIGHT))==JT_LEFT
drh25897872018-03-20 21:16:15 +00007108 && sqlite3ExprImpliesNonNullRow(p->pWhere, pItem->iCursor)
7109 && OptimizationEnabled(db, SQLITE_SimplifyJoin)
7110 ){
drh5d7aef12022-11-22 19:49:16 +00007111 TREETRACE(0x1000,pParse,p,
drh25897872018-03-20 21:16:15 +00007112 ("LEFT-JOIN simplifies to JOIN on term %d\n",i));
drhefce69d2018-03-20 22:52:27 +00007113 pItem->fg.jointype &= ~(JT_LEFT|JT_OUTER);
drhd7480402022-06-20 17:04:44 +00007114 assert( pItem->iCursor>=0 );
drh92d1afb2022-06-13 12:42:24 +00007115 unsetJoinExpr(p->pWhere, pItem->iCursor,
7116 pTabList->a[0].fg.jointype & JT_LTORJ);
drh25897872018-03-20 21:16:15 +00007117 }
7118
7119 /* No futher action if this term of the FROM clause is no a subquery */
drh4490c402015-06-05 22:33:39 +00007120 if( pSub==0 ) continue;
drh2679f142015-09-25 13:42:55 +00007121
7122 /* Catch mismatch in the declared columns of a view and the number of
7123 ** columns in the SELECT on the RHS */
7124 if( pTab->nCol!=pSub->pEList->nExpr ){
7125 sqlite3ErrorMsg(pParse, "expected %d columns for '%s' but got %d",
7126 pTab->nCol, pTab->zName, pSub->pEList->nExpr);
7127 goto select_end;
7128 }
7129
drh25c221e2017-09-29 22:13:24 +00007130 /* Do not try to flatten an aggregate subquery.
7131 **
7132 ** Flattening an aggregate subquery is only possible if the outer query
7133 ** is not a join. But if the outer query is not a join, then the subquery
7134 ** will be implemented as a co-routine and there is no advantage to
7135 ** flattening in that case.
7136 */
7137 if( (pSub->selFlags & SF_Aggregate)!=0 ) continue;
7138 assert( pSub->pGroupBy==0 );
7139
drhbb301232021-07-15 19:29:43 +00007140 /* If a FROM-clause subquery has an ORDER BY clause that is not
7141 ** really doing anything, then delete it now so that it does not
drh0fb78f02021-07-16 01:19:19 +00007142 ** interfere with query flattening. See the discussion at
7143 ** https://sqlite.org/forum/forumpost/2d76f2bcf65d256a
drhbb301232021-07-15 19:29:43 +00007144 **
7145 ** Beware of these cases where the ORDER BY clause may not be safely
7146 ** omitted:
7147 **
7148 ** (1) There is also a LIMIT clause
7149 ** (2) The subquery was added to help with window-function
7150 ** processing
drh0fb78f02021-07-16 01:19:19 +00007151 ** (3) The subquery is in the FROM clause of an UPDATE
7152 ** (4) The outer query uses an aggregate function other than
drhbb301232021-07-15 19:29:43 +00007153 ** the built-in count(), min(), or max().
drh0fb78f02021-07-16 01:19:19 +00007154 ** (5) The ORDER BY isn't going to accomplish anything because
7155 ** one of:
7156 ** (a) The outer query has a different ORDER BY clause
7157 ** (b) The subquery is part of a join
7158 ** See forum post 062d576715d277c8
drhbb301232021-07-15 19:29:43 +00007159 */
7160 if( pSub->pOrderBy!=0
drh0fb78f02021-07-16 01:19:19 +00007161 && (p->pOrderBy!=0 || pTabList->nSrc>1) /* Condition (5) */
drhbb301232021-07-15 19:29:43 +00007162 && pSub->pLimit==0 /* Condition (1) */
7163 && (pSub->selFlags & SF_OrderByReqd)==0 /* Condition (2) */
drh0fb78f02021-07-16 01:19:19 +00007164 && (p->selFlags & SF_OrderByReqd)==0 /* Condition (3) and (4) */
drhbb301232021-07-15 19:29:43 +00007165 && OptimizationEnabled(db, SQLITE_OmitOrderBy)
7166 ){
drh5d7aef12022-11-22 19:49:16 +00007167 TREETRACE(0x800,pParse,p,
drhbb301232021-07-15 19:29:43 +00007168 ("omit superfluous ORDER BY on %r FROM-clause subquery\n",i+1));
drhe8344842022-07-14 01:48:27 +00007169 sqlite3ParserAddCleanup(pParse,
7170 (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
7171 pSub->pOrderBy);
drhbb301232021-07-15 19:29:43 +00007172 pSub->pOrderBy = 0;
7173 }
7174
drhfca23552017-10-28 20:51:54 +00007175 /* If the outer query contains a "complex" result set (that is,
7176 ** if the result set of the outer query uses functions or subqueries)
7177 ** and if the subquery contains an ORDER BY clause and if
drh648fe492017-09-28 20:06:53 +00007178 ** it will be implemented as a co-routine, then do not flatten. This
7179 ** restriction allows SQL constructs like this:
7180 **
7181 ** SELECT expensive_function(x)
7182 ** FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
7183 **
7184 ** The expensive_function() is only computed on the 10 rows that
7185 ** are output, rather than every row of the table.
drhfca23552017-10-28 20:51:54 +00007186 **
7187 ** The requirement that the outer query have a complex result set
7188 ** means that flattening does occur on simpler SQL constraints without
7189 ** the expensive_function() like:
7190 **
7191 ** SELECT x FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
drh648fe492017-09-28 20:06:53 +00007192 */
drh25c221e2017-09-29 22:13:24 +00007193 if( pSub->pOrderBy!=0
drh648fe492017-09-28 20:06:53 +00007194 && i==0
drhfca23552017-10-28 20:51:54 +00007195 && (p->selFlags & SF_ComplexResult)!=0
drh648fe492017-09-28 20:06:53 +00007196 && (pTabList->nSrc==1
drha76ac882022-04-08 19:20:12 +00007197 || (pTabList->a[1].fg.jointype&(JT_OUTER|JT_CROSS))!=0)
drh648fe492017-09-28 20:06:53 +00007198 ){
7199 continue;
7200 }
7201
drh25c221e2017-09-29 22:13:24 +00007202 if( flattenSubquery(pParse, p, i, isAgg) ){
drh4acd7542019-02-06 00:55:47 +00007203 if( pParse->nErr ) goto select_end;
drh4490c402015-06-05 22:33:39 +00007204 /* This subquery can be absorbed into its parent. */
drh4490c402015-06-05 22:33:39 +00007205 i = -1;
7206 }
7207 pTabList = p->pSrc;
7208 if( db->mallocFailed ) goto select_end;
7209 if( !IgnorableOrderby(pDest) ){
7210 sSort.pOrderBy = p->pOrderBy;
7211 }
7212 }
7213#endif
7214
drh4490c402015-06-05 22:33:39 +00007215#ifndef SQLITE_OMIT_COMPOUND_SELECT
7216 /* Handle compound SELECT statements using the separate multiSelect()
7217 ** procedure.
7218 */
7219 if( p->pPrior ){
7220 rc = multiSelect(pParse, p, pDest);
drh5e431be2022-04-06 11:08:38 +00007221#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007222 TREETRACE(0x400,pParse,p,("end compound-select processing\n"));
7223 if( (sqlite3TreeTrace & 0x400)!=0 && ExplainQueryPlanParent(pParse)==0 ){
drhf20609d2018-04-23 17:43:35 +00007224 sqlite3TreeViewSelect(0, p, 0);
7225 }
drh4490c402015-06-05 22:33:39 +00007226#endif
drhc631ded2018-05-02 02:22:22 +00007227 if( p->pNext==0 ) ExplainQueryPlanPop(pParse);
drh4490c402015-06-05 22:33:39 +00007228 return rc;
7229 }
7230#endif
7231
drh7810ab62018-07-27 17:51:20 +00007232 /* Do the WHERE-clause constant propagation optimization if this is
7233 ** a join. No need to speed time on this operation for non-join queries
7234 ** as the equivalent optimization will be handled by query planner in
7235 ** sqlite3WhereBegin().
7236 */
drhb775c972021-05-14 14:26:57 +00007237 if( p->pWhere!=0
7238 && p->pWhere->op==TK_AND
drh7810ab62018-07-27 17:51:20 +00007239 && OptimizationEnabled(db, SQLITE_PropagateConst)
drh24e11162018-07-26 23:47:11 +00007240 && propagateConstants(pParse, p)
7241 ){
drh5e431be2022-04-06 11:08:38 +00007242#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007243 if( sqlite3TreeTrace & 0x2000 ){
7244 TREETRACE(0x2000,pParse,p,("After constant propagation:\n"));
drh24e11162018-07-26 23:47:11 +00007245 sqlite3TreeViewSelect(0, p, 0);
7246 }
7247#endif
7248 }else{
drh5d7aef12022-11-22 19:49:16 +00007249 TREETRACE(0x2000,pParse,p,("Constant propagation not helpful\n"));
drh24e11162018-07-26 23:47:11 +00007250 }
7251
dana4b5fb52018-08-03 20:19:52 +00007252#ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
7253 if( OptimizationEnabled(db, SQLITE_QueryFlattener|SQLITE_CountOfView)
7254 && countOfViewOptimization(pParse, p)
7255 ){
7256 if( db->mallocFailed ) goto select_end;
7257 pEList = p->pEList;
7258 pTabList = p->pSrc;
7259 }
7260#endif
7261
drh701caf12017-05-10 16:12:00 +00007262 /* For each term in the FROM clause, do two things:
7263 ** (1) Authorized unreferenced tables
7264 ** (2) Generate code for all sub-queries
drhd820cb12002-02-18 03:21:45 +00007265 */
drh4490c402015-06-05 22:33:39 +00007266 for(i=0; i<pTabList->nSrc; i++){
drh76012942021-02-21 21:04:54 +00007267 SrcItem *pItem = &pTabList->a[i];
drha79e2a22021-02-21 23:44:14 +00007268 SrcItem *pPrior;
drh13449892005-09-07 21:22:45 +00007269 SelectDest dest;
drh701caf12017-05-10 16:12:00 +00007270 Select *pSub;
drh824d21a2017-09-29 12:44:52 +00007271#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
7272 const char *zSavedAuthContext;
7273#endif
drh701caf12017-05-10 16:12:00 +00007274
drh3d240d22017-09-28 16:56:55 +00007275 /* Issue SQLITE_READ authorizations with a fake column name for any
7276 ** tables that are referenced but from which no values are extracted.
7277 ** Examples of where these kinds of null SQLITE_READ authorizations
7278 ** would occur:
drh701caf12017-05-10 16:12:00 +00007279 **
drh2336c932017-05-11 12:05:23 +00007280 ** SELECT count(*) FROM t1; -- SQLITE_READ t1.""
7281 ** SELECT t1.* FROM t1, t2; -- SQLITE_READ t2.""
7282 **
7283 ** The fake column name is an empty string. It is possible for a table to
7284 ** have a column named by the empty string, in which case there is no way to
7285 ** distinguish between an unreferenced table and an actual reference to the
drh3d240d22017-09-28 16:56:55 +00007286 ** "" column. The original design was for the fake column name to be a NULL,
drh2336c932017-05-11 12:05:23 +00007287 ** which would be unambiguous. But legacy authorization callbacks might
drh3d240d22017-09-28 16:56:55 +00007288 ** assume the column name is non-NULL and segfault. The use of an empty
7289 ** string for the fake column name seems safer.
drh701caf12017-05-10 16:12:00 +00007290 */
drh74c490e2019-08-07 13:25:21 +00007291 if( pItem->colUsed==0 && pItem->zName!=0 ){
drh2336c932017-05-11 12:05:23 +00007292 sqlite3AuthCheck(pParse, SQLITE_READ, pItem->zName, "", pItem->zDatabase);
drh701caf12017-05-10 16:12:00 +00007293 }
7294
7295#if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
7296 /* Generate code for all sub-queries in the FROM clause
7297 */
7298 pSub = pItem->pSelect;
drh5b6a9ed2011-09-15 23:58:14 +00007299 if( pSub==0 ) continue;
drh21172c42012-10-30 00:29:07 +00007300
drh14c4d422021-05-26 18:46:51 +00007301 /* The code for a subquery should only be generated once. */
7302 assert( pItem->addrFillSub==0 );
danielk1977daf79ac2008-06-30 18:12:28 +00007303
danielk1977fc976062007-05-10 10:46:56 +00007304 /* Increment Parse.nHeight by the height of the largest expression
drhf7b54962013-05-28 12:11:54 +00007305 ** tree referred to by this, the parent select. The child select
danielk1977fc976062007-05-10 10:46:56 +00007306 ** may contain expression trees of at most
7307 ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
7308 ** more conservative than necessary, but much easier than enforcing
7309 ** an exact limit.
7310 */
7311 pParse->nHeight += sqlite3SelectExprHeight(p);
danielk1977daf79ac2008-06-30 18:12:28 +00007312
drhadc57f62015-06-06 00:18:01 +00007313 /* Make copies of constant WHERE-clause terms in the outer query down
7314 ** inside the subquery. This can help the subquery to run more efficiently.
7315 */
drh7fbb1012018-03-21 01:59:46 +00007316 if( OptimizationEnabled(db, SQLITE_PushDown)
drhdf67ec02021-08-11 13:48:56 +00007317 && (pItem->fg.isCte==0
7318 || (pItem->u2.pCteUse->eM10d!=M10d_Yes && pItem->u2.pCteUse->nUse<2))
drha9cdb902022-04-25 19:40:33 +00007319 && pushDownWhereTerms(pParse, pSub, p->pWhere, pItem)
drh4490c402015-06-05 22:33:39 +00007320 ){
drh5e431be2022-04-06 11:08:38 +00007321#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007322 if( sqlite3TreeTrace & 0x4000 ){
7323 TREETRACE(0x4000,pParse,p,
drhd2a44012018-07-28 14:34:22 +00007324 ("After WHERE-clause push-down into subquery %d:\n", pSub->selId));
drh4490c402015-06-05 22:33:39 +00007325 sqlite3TreeViewSelect(0, p, 0);
danielk1977daf79ac2008-06-30 18:12:28 +00007326 }
drh69b72d52015-06-01 20:28:03 +00007327#endif
drh8794c682021-02-13 16:39:24 +00007328 assert( pItem->pSelect && (pItem->pSelect->selFlags & SF_PushDown)!=0 );
drh2d277bb2018-03-20 11:24:30 +00007329 }else{
drh5d7aef12022-11-22 19:49:16 +00007330 TREETRACE(0x4000,pParse,p,("Push-down not possible\n"));
drh4490c402015-06-05 22:33:39 +00007331 }
drhadc57f62015-06-06 00:18:01 +00007332
drh824d21a2017-09-29 12:44:52 +00007333 zSavedAuthContext = pParse->zAuthContext;
7334 pParse->zAuthContext = pItem->zName;
7335
drhadc57f62015-06-06 00:18:01 +00007336 /* Generate code to implement the subquery
7337 */
drh93f41e22022-12-09 18:26:15 +00007338 if( fromClauseTermCanBeCoroutine(pParse, pTabList, i, p->selFlags) ){
drh21172c42012-10-30 00:29:07 +00007339 /* Implement a co-routine that will return a single row of the result
7340 ** set on each invocation.
7341 */
drh4490c402015-06-05 22:33:39 +00007342 int addrTop = sqlite3VdbeCurrentAddr(v)+1;
drh824d21a2017-09-29 12:44:52 +00007343
drh21172c42012-10-30 00:29:07 +00007344 pItem->regReturn = ++pParse->nMem;
drh4490c402015-06-05 22:33:39 +00007345 sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
drha9799932021-03-19 13:00:28 +00007346 VdbeComment((v, "%!S", pItem));
drh21172c42012-10-30 00:29:07 +00007347 pItem->addrFillSub = addrTop;
drh21172c42012-10-30 00:29:07 +00007348 sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
drhad9ff1d2022-12-06 15:24:05 +00007349 ExplainQueryPlan((pParse, 1, "CO-ROUTINE %!S", pItem));
drh21172c42012-10-30 00:29:07 +00007350 sqlite3Select(pParse, pSub, &dest);
drhc3489bb2016-02-25 16:04:59 +00007351 pItem->pTab->nRowLogEst = pSub->nSelectRow;
drh8a48b9c2015-08-19 15:20:00 +00007352 pItem->fg.viaCoroutine = 1;
drh4490c402015-06-05 22:33:39 +00007353 pItem->regResult = dest.iSdst;
drh2fade2f2016-02-09 02:12:20 +00007354 sqlite3VdbeEndCoroutine(v, pItem->regReturn);
drh21172c42012-10-30 00:29:07 +00007355 sqlite3VdbeJumpHere(v, addrTop-1);
7356 sqlite3ClearTempRegCache(pParse);
drha79e2a22021-02-21 23:44:14 +00007357 }else if( pItem->fg.isCte && pItem->u2.pCteUse->addrM9e>0 ){
7358 /* This is a CTE for which materialization code has already been
7359 ** generated. Invoke the subroutine to compute the materialization,
7360 ** the make the pItem->iCursor be a copy of the ephemerial table that
7361 ** holds the result of the materialization. */
7362 CteUse *pCteUse = pItem->u2.pCteUse;
7363 sqlite3VdbeAddOp2(v, OP_Gosub, pCteUse->regRtn, pCteUse->addrM9e);
7364 if( pItem->iCursor!=pCteUse->iCur ){
7365 sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pCteUse->iCur);
drh834c6882021-08-11 13:19:13 +00007366 VdbeComment((v, "%!S", pItem));
drha79e2a22021-02-21 23:44:14 +00007367 }
7368 pSub->nSelectRow = pCteUse->nRowEst;
drh05cb9d82022-12-08 13:56:06 +00007369 }else if( (pPrior = isSelfJoinView(pTabList, pItem, 0, i))!=0 ){
drha79e2a22021-02-21 23:44:14 +00007370 /* This view has already been materialized by a prior entry in
7371 ** this same FROM clause. Reuse it. */
7372 if( pPrior->addrFillSub ){
7373 sqlite3VdbeAddOp2(v, OP_Gosub, pPrior->regReturn, pPrior->addrFillSub);
7374 }
7375 sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pPrior->iCursor);
7376 pSub->nSelectRow = pPrior->pSelect->nSelectRow;
danielk1977daf79ac2008-06-30 18:12:28 +00007377 }else{
drh14c4d422021-05-26 18:46:51 +00007378 /* Materialize the view. If the view is not correlated, generate a
drhd685dd62021-03-19 13:53:34 +00007379 ** subroutine to do the materialization so that subsequent uses of
7380 ** the same view can reuse the materialization. */
drh7157e8e2011-09-16 16:00:51 +00007381 int topAddr;
drh48f2d3b2011-09-16 01:34:43 +00007382 int onceAddr = 0;
dan231ff4b2022-12-02 20:32:22 +00007383#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
7384 int addrExplain;
7385#endif
drhe08e8d62017-05-01 15:15:41 +00007386
drh5b6a9ed2011-09-15 23:58:14 +00007387 pItem->regReturn = ++pParse->nMem;
drh40822eb2022-05-21 18:03:33 +00007388 topAddr = sqlite3VdbeAddOp0(v, OP_Goto);
drh7157e8e2011-09-16 16:00:51 +00007389 pItem->addrFillSub = topAddr+1;
drh40822eb2022-05-21 18:03:33 +00007390 pItem->fg.isMaterialized = 1;
drh8a48b9c2015-08-19 15:20:00 +00007391 if( pItem->fg.isCorrelated==0 ){
drhed171672013-04-24 13:50:09 +00007392 /* If the subquery is not correlated and if we are not inside of
drh5b6a9ed2011-09-15 23:58:14 +00007393 ** a trigger, then we only need to compute the value of the subquery
7394 ** once. */
drh511f9e82016-09-22 18:53:13 +00007395 onceAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
drha9799932021-03-19 13:00:28 +00007396 VdbeComment((v, "materialize %!S", pItem));
drh69b72d52015-06-01 20:28:03 +00007397 }else{
drha9799932021-03-19 13:00:28 +00007398 VdbeNoopComment((v, "materialize %!S", pItem));
drh5b6a9ed2011-09-15 23:58:14 +00007399 }
drha79e2a22021-02-21 23:44:14 +00007400 sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
dan231ff4b2022-12-02 20:32:22 +00007401
7402 ExplainQueryPlan2(addrExplain, (pParse, 1, "MATERIALIZE %!S", pItem));
drha79e2a22021-02-21 23:44:14 +00007403 sqlite3Select(pParse, pSub, &dest);
drhc3489bb2016-02-25 16:04:59 +00007404 pItem->pTab->nRowLogEst = pSub->nSelectRow;
drh48f2d3b2011-09-16 01:34:43 +00007405 if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
drh40822eb2022-05-21 18:03:33 +00007406 sqlite3VdbeAddOp2(v, OP_Return, pItem->regReturn, topAddr+1);
drha9799932021-03-19 13:00:28 +00007407 VdbeComment((v, "end %!S", pItem));
drhad9ff1d2022-12-06 15:24:05 +00007408 sqlite3VdbeScanStatusRange(v, addrExplain, addrExplain, -1);
drh40822eb2022-05-21 18:03:33 +00007409 sqlite3VdbeJumpHere(v, topAddr);
drhcdc69552011-12-06 13:24:59 +00007410 sqlite3ClearTempRegCache(pParse);
drhd685dd62021-03-19 13:53:34 +00007411 if( pItem->fg.isCte && pItem->fg.isCorrelated==0 ){
drha79e2a22021-02-21 23:44:14 +00007412 CteUse *pCteUse = pItem->u2.pCteUse;
7413 pCteUse->addrM9e = pItem->addrFillSub;
7414 pCteUse->regRtn = pItem->regReturn;
7415 pCteUse->iCur = pItem->iCursor;
7416 pCteUse->nRowEst = pSub->nSelectRow;
7417 }
danielk1977daf79ac2008-06-30 18:12:28 +00007418 }
drhadc57f62015-06-06 00:18:01 +00007419 if( db->mallocFailed ) goto select_end;
danielk1977fc976062007-05-10 10:46:56 +00007420 pParse->nHeight -= sqlite3SelectExprHeight(p);
drh824d21a2017-09-29 12:44:52 +00007421 pParse->zAuthContext = zSavedAuthContext;
drh51522cd2005-01-20 13:36:19 +00007422#endif
drh701caf12017-05-10 16:12:00 +00007423 }
drhadc57f62015-06-06 00:18:01 +00007424
drh38b41492015-06-08 15:08:15 +00007425 /* Various elements of the SELECT copied into local variables for
7426 ** convenience */
drhadc57f62015-06-06 00:18:01 +00007427 pEList = p->pEList;
danielk1977daf79ac2008-06-30 18:12:28 +00007428 pWhere = p->pWhere;
7429 pGroupBy = p->pGroupBy;
7430 pHaving = p->pHaving;
drhe8e4af72012-09-21 00:04:28 +00007431 sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
drh832508b2002-03-02 17:04:07 +00007432
drh5e431be2022-04-06 11:08:38 +00007433#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007434 if( sqlite3TreeTrace & 0x8000 ){
7435 TREETRACE(0x8000,pParse,p,("After all FROM-clause analysis:\n"));
drhbc8edba2015-06-05 20:27:26 +00007436 sqlite3TreeViewSelect(0, p, 0);
danielk1977f23329a2008-07-01 14:09:13 +00007437 }
7438#endif
7439
dan50118cd2011-07-01 14:21:38 +00007440 /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
7441 ** if the select-list is the same as the ORDER BY list, then this query
7442 ** can be rewritten as a GROUP BY. In other words, this:
7443 **
7444 ** SELECT DISTINCT xyz FROM ... ORDER BY xyz
7445 **
7446 ** is transformed to:
7447 **
drhdea7d702014-12-04 21:54:58 +00007448 ** SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
dan50118cd2011-07-01 14:21:38 +00007449 **
7450 ** The second form is preferred as a single index (or temp-table) may be
7451 ** used for both the ORDER BY and DISTINCT processing. As originally
7452 ** written the query must use a temp-table for at least one of the ORDER
7453 ** BY and DISTINCT, and an index or separate temp-table for the other.
7454 */
7455 if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
drhadc57f62015-06-06 00:18:01 +00007456 && sqlite3ExprListCompare(sSort.pOrderBy, pEList, -1)==0
drhef9f7192020-01-17 19:14:08 +00007457#ifndef SQLITE_OMIT_WINDOWFUNC
dane59c5622019-11-22 10:14:01 +00007458 && p->pWin==0
drhef9f7192020-01-17 19:14:08 +00007459#endif
dan50118cd2011-07-01 14:21:38 +00007460 ){
7461 p->selFlags &= ~SF_Distinct;
drhadc57f62015-06-06 00:18:01 +00007462 pGroupBy = p->pGroupBy = sqlite3ExprListDup(db, pEList, 0);
dan9e10f9a2020-01-06 17:06:12 +00007463 p->selFlags |= SF_Aggregate;
drhe8e4af72012-09-21 00:04:28 +00007464 /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
7465 ** the sDistinct.isTnct is still set. Hence, isTnct represents the
7466 ** original setting of the SF_Distinct flag, not the current setting */
7467 assert( sDistinct.isTnct );
danece092e2022-03-16 12:06:00 +00007468 sDistinct.isTnct = 2;
drh7512cb42016-04-14 13:06:49 +00007469
drh5e431be2022-04-06 11:08:38 +00007470#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007471 if( sqlite3TreeTrace & 0x20000 ){
7472 TREETRACE(0x20000,pParse,p,("Transform DISTINCT into GROUP BY:\n"));
drh7512cb42016-04-14 13:06:49 +00007473 sqlite3TreeViewSelect(0, p, 0);
7474 }
7475#endif
dan50118cd2011-07-01 14:21:38 +00007476 }
7477
drhadc57f62015-06-06 00:18:01 +00007478 /* If there is an ORDER BY clause, then create an ephemeral index to
7479 ** do the sorting. But this sorting ephemeral index might end up
7480 ** being unused if the data can be extracted in pre-sorted order.
7481 ** If that is the case, then the OP_OpenEphemeral instruction will be
7482 ** changed to an OP_Noop once we figure out that the sorting index is
7483 ** not needed. The sSort.addrSortIndex variable is used to facilitate
7484 ** that change.
danielk19777cedc8d2004-06-10 10:50:08 +00007485 */
drh079a3072014-03-19 14:10:55 +00007486 if( sSort.pOrderBy ){
drh0342b1f2005-09-01 03:07:44 +00007487 KeyInfo *pKeyInfo;
danf9eae182018-05-21 19:45:11 +00007488 pKeyInfo = sqlite3KeyInfoFromExprList(
7489 pParse, sSort.pOrderBy, 0, pEList->nExpr);
drh079a3072014-03-19 14:10:55 +00007490 sSort.iECursor = pParse->nTab++;
7491 sSort.addrSortIndex =
drh66a51672008-01-03 00:01:23 +00007492 sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
drhf45f2322014-03-23 17:45:03 +00007493 sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
7494 (char*)pKeyInfo, P4_KEYINFO
7495 );
drh9d2985c2005-09-08 01:58:42 +00007496 }else{
drh079a3072014-03-19 14:10:55 +00007497 sSort.addrSortIndex = -1;
danielk19777cedc8d2004-06-10 10:50:08 +00007498 }
7499
drh2d0794e2002-03-03 03:03:52 +00007500 /* If the output is destined for a temporary table, open that table.
7501 */
danielk19776c8c8ce2008-01-02 16:27:09 +00007502 if( pDest->eDest==SRT_EphemTab ){
drh2b596da2012-07-23 21:43:19 +00007503 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
drh18f86002022-04-21 13:11:26 +00007504 if( p->selFlags & SF_NestedFrom ){
7505 /* Delete or NULL-out result columns that will never be used */
7506 int ii;
drhd88fd532022-05-02 20:49:30 +00007507 for(ii=pEList->nExpr-1; ii>0 && pEList->a[ii].fg.bUsed==0; ii--){
drh18f86002022-04-21 13:11:26 +00007508 sqlite3ExprDelete(db, pEList->a[ii].pExpr);
7509 sqlite3DbFree(db, pEList->a[ii].zEName);
7510 pEList->nExpr--;
7511 }
7512 for(ii=0; ii<pEList->nExpr; ii++){
drhd88fd532022-05-02 20:49:30 +00007513 if( pEList->a[ii].fg.bUsed==0 ) pEList->a[ii].pExpr->op = TK_NULL;
drh18f86002022-04-21 13:11:26 +00007514 }
7515 }
drh2d0794e2002-03-03 03:03:52 +00007516 }
7517
drhf42bacc2006-04-26 17:39:34 +00007518 /* Set the limiter.
7519 */
drhec4ccdb2018-12-29 02:26:59 +00007520 iEnd = sqlite3VdbeMakeLabel(pParse);
dan69b93832016-12-16 15:05:40 +00007521 if( (p->selFlags & SF_FixedLimit)==0 ){
7522 p->nSelectRow = 320; /* 4 billion rows */
7523 }
drh3c8fb6f2022-07-26 01:20:18 +00007524 if( p->pLimit ) computeLimitRegisters(pParse, p, iEnd);
drh079a3072014-03-19 14:10:55 +00007525 if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
drh0ff287f2015-09-02 18:40:33 +00007526 sqlite3VdbeChangeOpcode(v, sSort.addrSortIndex, OP_SorterOpen);
drh079a3072014-03-19 14:10:55 +00007527 sSort.sortFlags |= SORTFLAG_UseSorter;
drhc6aff302011-09-01 15:32:47 +00007528 }
drhf42bacc2006-04-26 17:39:34 +00007529
drhadc57f62015-06-06 00:18:01 +00007530 /* Open an ephemeral index to use for the distinct set.
drhefb72512000-05-31 20:00:52 +00007531 */
dan2ce22452010-11-08 19:01:16 +00007532 if( p->selFlags & SF_Distinct ){
drhe8e4af72012-09-21 00:04:28 +00007533 sDistinct.tabTnct = pParse->nTab++;
7534 sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
danf9eae182018-05-21 19:45:11 +00007535 sDistinct.tabTnct, 0, 0,
7536 (char*)sqlite3KeyInfoFromExprList(pParse, p->pEList,0,0),
7537 P4_KEYINFO);
drhd4187c72010-08-30 22:15:45 +00007538 sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
drhe8e4af72012-09-21 00:04:28 +00007539 sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
drh832508b2002-03-02 17:04:07 +00007540 }else{
drhe8e4af72012-09-21 00:04:28 +00007541 sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
drhefb72512000-05-31 20:00:52 +00007542 }
drh832508b2002-03-02 17:04:07 +00007543
drh13449892005-09-07 21:22:45 +00007544 if( !isAgg && pGroupBy==0 ){
drhe8e4af72012-09-21 00:04:28 +00007545 /* No aggregate functions and no GROUP BY clause */
dan67a9b8e2018-06-22 20:51:35 +00007546 u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0)
7547 | (p->selFlags & SF_FixedLimit);
7548#ifndef SQLITE_OMIT_WINDOWFUNC
drh067b92b2020-06-19 15:24:12 +00007549 Window *pWin = p->pWin; /* Main window object (or NULL) */
danf9eae182018-05-21 19:45:11 +00007550 if( pWin ){
dan4ea562e2020-01-01 20:17:15 +00007551 sqlite3WindowCodeInit(pParse, p);
dan86fb6e12018-05-16 20:58:07 +00007552 }
dan67a9b8e2018-06-22 20:51:35 +00007553#endif
7554 assert( WHERE_USE_LIMIT==SF_FixedLimit );
7555
dan86fb6e12018-05-16 20:58:07 +00007556
dan38cc40c2011-06-30 20:17:15 +00007557 /* Begin the database scan. */
drh5d7aef12022-11-22 19:49:16 +00007558 TREETRACE(0x2,pParse,p,("WhereBegin\n"));
drh079a3072014-03-19 14:10:55 +00007559 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
drh895bab32022-01-27 16:14:50 +00007560 p->pEList, p, wctrlFlags, p->nSelectRow);
drh13449892005-09-07 21:22:45 +00007561 if( pWInfo==0 ) goto select_end;
drh6f328482013-06-05 23:39:34 +00007562 if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
7563 p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
7564 }
drh6457a352013-06-21 00:35:37 +00007565 if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
drh6f328482013-06-05 23:39:34 +00007566 sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
7567 }
drh079a3072014-03-19 14:10:55 +00007568 if( sSort.pOrderBy ){
7569 sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
drh6ee5a7b2018-09-08 20:09:46 +00007570 sSort.labelOBLopt = sqlite3WhereOrderByLimitOptLabel(pWInfo);
drh079a3072014-03-19 14:10:55 +00007571 if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
7572 sSort.pOrderBy = 0;
7573 }
7574 }
drh5d7aef12022-11-22 19:49:16 +00007575 TREETRACE(0x2,pParse,p,("WhereBegin returns\n"));
drhcce7d172000-05-31 15:34:51 +00007576
drhb9bb7c12006-06-11 23:41:55 +00007577 /* If sorting index that was created by a prior OP_OpenEphemeral
7578 ** instruction ended up not being needed, then change the OP_OpenEphemeral
drh9d2985c2005-09-08 01:58:42 +00007579 ** into an OP_Noop.
7580 */
drh079a3072014-03-19 14:10:55 +00007581 if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
7582 sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
drh9d2985c2005-09-08 01:58:42 +00007583 }
7584
drh2def2f72017-09-15 17:40:34 +00007585 assert( p->pEList==pEList );
dan67a9b8e2018-06-22 20:51:35 +00007586#ifndef SQLITE_OMIT_WINDOWFUNC
danf9eae182018-05-21 19:45:11 +00007587 if( pWin ){
drhec4ccdb2018-12-29 02:26:59 +00007588 int addrGosub = sqlite3VdbeMakeLabel(pParse);
7589 int iCont = sqlite3VdbeMakeLabel(pParse);
7590 int iBreak = sqlite3VdbeMakeLabel(pParse);
danf9eae182018-05-21 19:45:11 +00007591 int regGosub = ++pParse->nMem;
drhefb72512000-05-31 20:00:52 +00007592
dandacf1de2018-06-08 16:11:55 +00007593 sqlite3WindowCodeStep(pParse, p, pWInfo, regGosub, addrGosub);
dan86fb6e12018-05-16 20:58:07 +00007594
danefa3a3c2018-06-23 16:26:20 +00007595 sqlite3VdbeAddOp2(v, OP_Goto, 0, iBreak);
danf9eae182018-05-21 19:45:11 +00007596 sqlite3VdbeResolveLabel(v, addrGosub);
drhb0225bc2018-07-10 20:50:27 +00007597 VdbeNoopComment((v, "inner-loop subroutine"));
drhd4cb09e2018-09-17 15:19:13 +00007598 sSort.labelOBLopt = 0;
danefa3a3c2018-06-23 16:26:20 +00007599 selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest, iCont, iBreak);
dandacf1de2018-06-08 16:11:55 +00007600 sqlite3VdbeResolveLabel(v, iCont);
dan86fb6e12018-05-16 20:58:07 +00007601 sqlite3VdbeAddOp1(v, OP_Return, regGosub);
drh0b3b0dd2018-07-10 05:11:03 +00007602 VdbeComment((v, "end inner-loop subroutine"));
danefa3a3c2018-06-23 16:26:20 +00007603 sqlite3VdbeResolveLabel(v, iBreak);
dan67a9b8e2018-06-22 20:51:35 +00007604 }else
7605#endif /* SQLITE_OMIT_WINDOWFUNC */
7606 {
dan86fb6e12018-05-16 20:58:07 +00007607 /* Use the standard inner loop. */
7608 selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest,
7609 sqlite3WhereContinueLabel(pWInfo),
7610 sqlite3WhereBreakLabel(pWInfo));
7611
7612 /* End the database scan loop.
7613 */
drh5d7aef12022-11-22 19:49:16 +00007614 TREETRACE(0x2,pParse,p,("WhereEnd\n"));
dan86fb6e12018-05-16 20:58:07 +00007615 sqlite3WhereEnd(pWInfo);
7616 }
drh13449892005-09-07 21:22:45 +00007617 }else{
drhe8e4af72012-09-21 00:04:28 +00007618 /* This case when there exist aggregate functions or a GROUP BY clause
7619 ** or both */
drh13449892005-09-07 21:22:45 +00007620 NameContext sNC; /* Name context for processing aggregate information */
7621 int iAMem; /* First Mem address for storing current GROUP BY */
7622 int iBMem; /* First Mem address for previous GROUP BY */
7623 int iUseFlag; /* Mem address holding flag indicating that at least
7624 ** one row of the input to the aggregator has been
7625 ** processed */
7626 int iAbortFlag; /* Mem address which causes query abort if positive */
7627 int groupBySort; /* Rows come from source in GROUP BY order */
drhd1766112008-09-17 00:13:12 +00007628 int addrEnd; /* End of processing for this SELECT */
drh1c9d8352011-09-01 16:01:27 +00007629 int sortPTab = 0; /* Pseudotable used to decode sorting results */
7630 int sortOut = 0; /* Output register from the sorter */
dan374cd782014-04-21 13:21:56 +00007631 int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
drhcce7d172000-05-31 15:34:51 +00007632
drhd1766112008-09-17 00:13:12 +00007633 /* Remove any and all aliases between the result set and the
7634 ** GROUP BY clause.
7635 */
7636 if( pGroupBy ){
drhdc5ea5c2008-12-10 17:19:59 +00007637 int k; /* Loop counter */
drhd1766112008-09-17 00:13:12 +00007638 struct ExprList_item *pItem; /* For looping over expression in a list */
drhcce7d172000-05-31 15:34:51 +00007639
drhdc5ea5c2008-12-10 17:19:59 +00007640 for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
drhc2acc4e2013-11-15 18:15:19 +00007641 pItem->u.x.iAlias = 0;
drhd1766112008-09-17 00:13:12 +00007642 }
drhdc5ea5c2008-12-10 17:19:59 +00007643 for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
drhc2acc4e2013-11-15 18:15:19 +00007644 pItem->u.x.iAlias = 0;
drhd1766112008-09-17 00:13:12 +00007645 }
drhc3489bb2016-02-25 16:04:59 +00007646 assert( 66==sqlite3LogEst(100) );
7647 if( p->nSelectRow>66 ) p->nSelectRow = 66;
dan8c9bcb22019-09-21 15:44:12 +00007648
7649 /* If there is both a GROUP BY and an ORDER BY clause and they are
7650 ** identical, then it may be possible to disable the ORDER BY clause
7651 ** on the grounds that the GROUP BY will cause elements to come out
7652 ** in the correct order. It also may not - the GROUP BY might use a
7653 ** database index that causes rows to be grouped together as required
7654 ** but not actually sorted. Either way, record the fact that the
7655 ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
7656 ** variable. */
7657 if( sSort.pOrderBy && pGroupBy->nExpr==sSort.pOrderBy->nExpr ){
drhe39f3882019-09-21 17:31:03 +00007658 int ii;
dan8c9bcb22019-09-21 15:44:12 +00007659 /* The GROUP BY processing doesn't care whether rows are delivered in
7660 ** ASC or DESC order - only that each group is returned contiguously.
7661 ** So set the ASC/DESC flags in the GROUP BY to match those in the
7662 ** ORDER BY to maximize the chances of rows being delivered in an
7663 ** order that makes the ORDER BY redundant. */
drhe39f3882019-09-21 17:31:03 +00007664 for(ii=0; ii<pGroupBy->nExpr; ii++){
drhd88fd532022-05-02 20:49:30 +00007665 u8 sortFlags;
7666 sortFlags = sSort.pOrderBy->a[ii].fg.sortFlags & KEYINFO_ORDER_DESC;
7667 pGroupBy->a[ii].fg.sortFlags = sortFlags;
dan8c9bcb22019-09-21 15:44:12 +00007668 }
7669 if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
7670 orderByGrp = 1;
7671 }
7672 }
drh95aa47b2010-11-16 02:49:15 +00007673 }else{
drhc3489bb2016-02-25 16:04:59 +00007674 assert( 0==sqlite3LogEst(1) );
7675 p->nSelectRow = 0;
drhd1766112008-09-17 00:13:12 +00007676 }
drh13449892005-09-07 21:22:45 +00007677
drhd1766112008-09-17 00:13:12 +00007678 /* Create a label to jump to when we want to abort the query */
drhec4ccdb2018-12-29 02:26:59 +00007679 addrEnd = sqlite3VdbeMakeLabel(pParse);
drh13449892005-09-07 21:22:45 +00007680
7681 /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
7682 ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
7683 ** SELECT statement.
7684 */
drhbf790972020-06-07 20:18:07 +00007685 pAggInfo = sqlite3DbMallocZero(db, sizeof(*pAggInfo) );
drhc54246f2021-02-17 21:13:14 +00007686 if( pAggInfo ){
7687 sqlite3ParserAddCleanup(pParse,
7688 (void(*)(sqlite3*,void*))agginfoFree, pAggInfo);
drh6d0053c2021-03-09 19:32:37 +00007689 testcase( pParse->earlyCleanup );
drhc54246f2021-02-17 21:13:14 +00007690 }
7691 if( db->mallocFailed ){
drhbf790972020-06-07 20:18:07 +00007692 goto select_end;
7693 }
drhe26d4282020-06-09 11:59:15 +00007694 pAggInfo->selId = p->selId;
drh98164c32022-12-20 01:48:43 +00007695#ifdef SQLITE_DEBUG
7696 pAggInfo->pSelect = p;
7697#endif
drh13449892005-09-07 21:22:45 +00007698 memset(&sNC, 0, sizeof(sNC));
7699 sNC.pParse = pParse;
7700 sNC.pSrcList = pTabList;
drhbf790972020-06-07 20:18:07 +00007701 sNC.uNC.pAggInfo = pAggInfo;
drh25c3b8c2018-04-16 10:34:13 +00007702 VVA_ONLY( sNC.ncFlags = NC_UAggInfo; )
drhbf790972020-06-07 20:18:07 +00007703 pAggInfo->nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
7704 pAggInfo->pGroupBy = pGroupBy;
drhd2b3e232008-01-23 14:51:49 +00007705 sqlite3ExprAnalyzeAggList(&sNC, pEList);
drh079a3072014-03-19 14:10:55 +00007706 sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
drhd2b3e232008-01-23 14:51:49 +00007707 if( pHaving ){
danab31a842017-04-29 20:53:09 +00007708 if( pGroupBy ){
7709 assert( pWhere==p->pWhere );
drhcd0abc22018-03-20 18:08:33 +00007710 assert( pHaving==p->pHaving );
7711 assert( pGroupBy==p->pGroupBy );
7712 havingToWhere(pParse, p);
danab31a842017-04-29 20:53:09 +00007713 pWhere = p->pWhere;
7714 }
drhd2b3e232008-01-23 14:51:49 +00007715 sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
drh13449892005-09-07 21:22:45 +00007716 }
drhbf790972020-06-07 20:18:07 +00007717 pAggInfo->nAccumulator = pAggInfo->nColumn;
7718 if( p->pGroupBy==0 && p->pHaving==0 && pAggInfo->nFunc==1 ){
drh81185a52020-06-09 13:38:12 +00007719 minMaxFlag = minMaxQuery(db, pAggInfo->aFunc[0].pFExpr, &pMinMaxOrderBy);
drh47d9f832017-10-26 20:04:28 +00007720 }else{
7721 minMaxFlag = WHERE_ORDERBY_NORMAL;
7722 }
drh5b046da2022-11-28 20:08:15 +00007723 analyzeAggFuncArgs(pAggInfo, &sNC);
drh17435752007-08-16 04:30:38 +00007724 if( db->mallocFailed ) goto select_end;
drh5e431be2022-04-06 11:08:38 +00007725#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00007726 if( sqlite3TreeTrace & 0x20 ){
7727 TREETRACE(0x20,pParse,p,("After aggregate analysis %p:\n", pAggInfo));
drh7ea11062017-10-26 18:43:19 +00007728 sqlite3TreeViewSelect(0, p, 0);
drhb9366f82021-01-13 11:44:51 +00007729 if( minMaxFlag ){
7730 sqlite3DebugPrintf("MIN/MAX Optimization (0x%02x) adds:\n", minMaxFlag);
7731 sqlite3TreeViewExprList(0, pMinMaxOrderBy, 0, "ORDERBY");
7732 }
drhda217c92022-11-21 17:40:23 +00007733 printAggInfo(pAggInfo);
drh7ea11062017-10-26 18:43:19 +00007734 }
7735#endif
7736
drh13449892005-09-07 21:22:45 +00007737
7738 /* Processing for aggregates with GROUP BY is very different and
danielk19773c4809a2007-11-12 15:29:18 +00007739 ** much more complex than aggregates without a GROUP BY.
drh13449892005-09-07 21:22:45 +00007740 */
7741 if( pGroupBy ){
7742 KeyInfo *pKeyInfo; /* Keying information for the group by clause */
drh728e0f92015-10-10 14:41:28 +00007743 int addr1; /* A-vs-B comparision jump */
drhd1766112008-09-17 00:13:12 +00007744 int addrOutputRow; /* Start of subroutine that outputs a result row */
7745 int regOutputRow; /* Return address register for output subroutine */
7746 int addrSetAbort; /* Set the abort flag and return */
7747 int addrTopOfLoop; /* Top of the input loop */
7748 int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
7749 int addrReset; /* Subroutine for resetting the accumulator */
7750 int regReset; /* Return address register for reset subroutine */
dan5383db72021-03-12 18:24:31 +00007751 ExprList *pDistinct = 0;
7752 u16 distFlag = 0;
7753 int eDist = WHERE_DISTINCT_NOOP;
7754
7755 if( pAggInfo->nFunc==1
7756 && pAggInfo->aFunc[0].iDistinct>=0
drha4eeccd2021-10-07 17:43:30 +00007757 && ALWAYS(pAggInfo->aFunc[0].pFExpr!=0)
7758 && ALWAYS(ExprUseXList(pAggInfo->aFunc[0].pFExpr))
7759 && pAggInfo->aFunc[0].pFExpr->x.pList!=0
dan5383db72021-03-12 18:24:31 +00007760 ){
7761 Expr *pExpr = pAggInfo->aFunc[0].pFExpr->x.pList->a[0].pExpr;
7762 pExpr = sqlite3ExprDup(db, pExpr, 0);
7763 pDistinct = sqlite3ExprListDup(db, pGroupBy, 0);
7764 pDistinct = sqlite3ExprListAppend(pParse, pDistinct, pExpr);
danf330d532021-04-03 19:23:59 +00007765 distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
dan5383db72021-03-12 18:24:31 +00007766 }
drh13449892005-09-07 21:22:45 +00007767
7768 /* If there is a GROUP BY clause we might need a sorting index to
7769 ** implement it. Allocate that sorting index now. If it turns out
drh1c9d8352011-09-01 16:01:27 +00007770 ** that we do not need it after all, the OP_SorterOpen instruction
drh13449892005-09-07 21:22:45 +00007771 ** will be converted into a Noop.
7772 */
drhbf790972020-06-07 20:18:07 +00007773 pAggInfo->sortingIdx = pParse->nTab++;
7774 pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pGroupBy,
7775 0, pAggInfo->nColumn);
drh1c9d8352011-09-01 16:01:27 +00007776 addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
drhbf790972020-06-07 20:18:07 +00007777 pAggInfo->sortingIdx, pAggInfo->nSortingColumn,
drh2ec2fb22013-11-06 19:59:23 +00007778 0, (char*)pKeyInfo, P4_KEYINFO);
drh13449892005-09-07 21:22:45 +00007779
7780 /* Initialize memory locations used by GROUP BY aggregate processing
7781 */
drh0a07c102008-01-03 18:03:08 +00007782 iUseFlag = ++pParse->nMem;
7783 iAbortFlag = ++pParse->nMem;
drhd1766112008-09-17 00:13:12 +00007784 regOutputRow = ++pParse->nMem;
drhec4ccdb2018-12-29 02:26:59 +00007785 addrOutputRow = sqlite3VdbeMakeLabel(pParse);
drhd1766112008-09-17 00:13:12 +00007786 regReset = ++pParse->nMem;
drhec4ccdb2018-12-29 02:26:59 +00007787 addrReset = sqlite3VdbeMakeLabel(pParse);
drh0a07c102008-01-03 18:03:08 +00007788 iAMem = pParse->nMem + 1;
drh13449892005-09-07 21:22:45 +00007789 pParse->nMem += pGroupBy->nExpr;
drh0a07c102008-01-03 18:03:08 +00007790 iBMem = pParse->nMem + 1;
drh13449892005-09-07 21:22:45 +00007791 pParse->nMem += pGroupBy->nExpr;
drh4c583122008-01-04 22:01:03 +00007792 sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
drhd4e70eb2008-01-02 00:34:36 +00007793 VdbeComment((v, "clear abort flag"));
drhb8475df2011-12-09 16:21:19 +00007794 sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
drhe3133822005-09-20 13:11:59 +00007795
drh13449892005-09-07 21:22:45 +00007796 /* Begin a loop that will extract all source rows in GROUP BY order.
7797 ** This might involve two separate loops with an OP_Sort in between, or
7798 ** it might be a single loop that uses an index to extract information
7799 ** in the right order to begin with.
7800 */
drh2eb95372008-06-06 15:04:36 +00007801 sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
drh5d7aef12022-11-22 19:49:16 +00007802 TREETRACE(0x2,pParse,p,("WhereBegin\n"));
dan5383db72021-03-12 18:24:31 +00007803 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, pDistinct,
drhfb643592022-10-22 23:09:29 +00007804 p, (sDistinct.isTnct==2 ? WHERE_DISTINCTBY : WHERE_GROUPBY)
danece092e2022-03-16 12:06:00 +00007805 | (orderByGrp ? WHERE_SORTBYGROUP : 0) | distFlag, 0
dan374cd782014-04-21 13:21:56 +00007806 );
danbfd6f1b2021-04-08 20:29:12 +00007807 if( pWInfo==0 ){
7808 sqlite3ExprListDelete(db, pDistinct);
7809 goto select_end;
7810 }
drhb23f1572022-11-22 20:37:41 +00007811 if( pParse->pIdxEpr ){
drhc6138e92022-11-23 14:13:39 +00007812 optimizeAggregateUseOfIndexedExpr(pParse, p, pAggInfo, &sNC);
drhb23f1572022-11-22 20:37:41 +00007813 }
drh42b78232022-11-22 14:10:22 +00007814 assignAggregateRegisters(pParse, pAggInfo);
dan76075802021-03-12 21:09:20 +00007815 eDist = sqlite3WhereIsDistinct(pWInfo);
drh5d7aef12022-11-22 19:49:16 +00007816 TREETRACE(0x2,pParse,p,("WhereBegin returns\n"));
drhddba0c22014-03-18 20:33:42 +00007817 if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
drh13449892005-09-07 21:22:45 +00007818 /* The optimizer is able to deliver rows in group by order so
drhb9bb7c12006-06-11 23:41:55 +00007819 ** we do not have to sort. The OP_OpenEphemeral table will be
drh13449892005-09-07 21:22:45 +00007820 ** cancelled later because we still need to use the pKeyInfo
7821 */
drh13449892005-09-07 21:22:45 +00007822 groupBySort = 0;
7823 }else{
7824 /* Rows are coming out in undetermined order. We have to push
7825 ** each row into a sorting index, terminate the first loop,
7826 ** then loop over the sorting index in order to get the output
7827 ** in sorted order
7828 */
drh892d3172008-01-10 03:46:36 +00007829 int regBase;
7830 int regRecord;
7831 int nCol;
7832 int nGroupBy;
7833
dan2ce22452010-11-08 19:01:16 +00007834 explainTempTable(pParse,
drhe8e4af72012-09-21 00:04:28 +00007835 (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
7836 "DISTINCT" : "GROUP BY");
dan2ce22452010-11-08 19:01:16 +00007837
drh13449892005-09-07 21:22:45 +00007838 groupBySort = 1;
drh892d3172008-01-10 03:46:36 +00007839 nGroupBy = pGroupBy->nExpr;
dandd23c6b2014-03-24 20:19:07 +00007840 nCol = nGroupBy;
7841 j = nGroupBy;
drhbf790972020-06-07 20:18:07 +00007842 for(i=0; i<pAggInfo->nColumn; i++){
7843 if( pAggInfo->aCol[i].iSorterColumn>=j ){
drh892d3172008-01-10 03:46:36 +00007844 nCol++;
7845 j++;
7846 }
7847 }
7848 regBase = sqlite3GetTempRange(pParse, nCol);
drh5579d592015-08-26 14:01:41 +00007849 sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0, 0);
dandd23c6b2014-03-24 20:19:07 +00007850 j = nGroupBy;
drhee373022022-07-25 15:54:23 +00007851 pAggInfo->directMode = 1;
drhbf790972020-06-07 20:18:07 +00007852 for(i=0; i<pAggInfo->nColumn; i++){
7853 struct AggInfo_col *pCol = &pAggInfo->aCol[i];
drh892d3172008-01-10 03:46:36 +00007854 if( pCol->iSorterColumn>=j ){
drhee373022022-07-25 15:54:23 +00007855 sqlite3ExprCode(pParse, pCol->pCExpr, j + regBase);
drh6a012f02008-08-21 14:15:59 +00007856 j++;
drh892d3172008-01-10 03:46:36 +00007857 }
drh13449892005-09-07 21:22:45 +00007858 }
drhee373022022-07-25 15:54:23 +00007859 pAggInfo->directMode = 0;
drh892d3172008-01-10 03:46:36 +00007860 regRecord = sqlite3GetTempReg(pParse);
drh1db639c2008-01-17 02:36:28 +00007861 sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
drhbf790972020-06-07 20:18:07 +00007862 sqlite3VdbeAddOp2(v, OP_SorterInsert, pAggInfo->sortingIdx, regRecord);
drh892d3172008-01-10 03:46:36 +00007863 sqlite3ReleaseTempReg(pParse, regRecord);
7864 sqlite3ReleaseTempRange(pParse, regBase, nCol);
drh5d7aef12022-11-22 19:49:16 +00007865 TREETRACE(0x2,pParse,p,("WhereEnd\n"));
drh13449892005-09-07 21:22:45 +00007866 sqlite3WhereEnd(pWInfo);
drhbf790972020-06-07 20:18:07 +00007867 pAggInfo->sortingIdxPTab = sortPTab = pParse->nTab++;
drh1c9d8352011-09-01 16:01:27 +00007868 sortOut = sqlite3GetTempReg(pParse);
7869 sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
drhbf790972020-06-07 20:18:07 +00007870 sqlite3VdbeAddOp2(v, OP_SorterSort, pAggInfo->sortingIdx, addrEnd);
drh688852a2014-02-17 22:40:43 +00007871 VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
drhbf790972020-06-07 20:18:07 +00007872 pAggInfo->useSortingIdx = 1;
dan374cd782014-04-21 13:21:56 +00007873 }
7874
drh9b80cb52022-11-24 01:40:20 +00007875 /* If there entries in pAgggInfo->aFunc[] that contain subexpressions
7876 ** that are indexed (and that were previously identified and tagged
7877 ** in optimizeAggregateUseOfIndexedExpr()) then those subexpressions
7878 ** must now be converted into a TK_AGG_COLUMN node so that the value
7879 ** is correctly pulled from the index rather than being recomputed. */
drh2e30d952022-11-23 18:51:04 +00007880 if( pParse->pIdxEpr ){
7881 aggregateConvertIndexedExprRefToColumn(pAggInfo);
7882#if TREETRACE_ENABLED
7883 if( sqlite3TreeTrace & 0x20 ){
7884 TREETRACE(0x20, pParse, p,
7885 ("AggInfo function expressions converted to reference index\n"));
7886 sqlite3TreeViewSelect(0, p, 0);
7887 printAggInfo(pAggInfo);
7888 }
7889#endif
7890 }
7891
dan374cd782014-04-21 13:21:56 +00007892 /* If the index or temporary table used by the GROUP BY sort
7893 ** will naturally deliver rows in the order required by the ORDER BY
7894 ** clause, cancel the ephemeral table open coded earlier.
7895 **
7896 ** This is an optimization - the correct answer should result regardless.
7897 ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
7898 ** disable this optimization for testing purposes. */
7899 if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
7900 && (groupBySort || sqlite3WhereIsSorted(pWInfo))
7901 ){
7902 sSort.pOrderBy = 0;
7903 sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
drh13449892005-09-07 21:22:45 +00007904 }
7905
7906 /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
7907 ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
7908 ** Then compare the current GROUP BY terms against the GROUP BY terms
7909 ** from the previous row currently stored in a0, a1, a2...
7910 */
7911 addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
drh1c9d8352011-09-01 16:01:27 +00007912 if( groupBySort ){
drhbf790972020-06-07 20:18:07 +00007913 sqlite3VdbeAddOp3(v, OP_SorterData, pAggInfo->sortingIdx,
drh38b41492015-06-08 15:08:15 +00007914 sortOut, sortPTab);
drh1c9d8352011-09-01 16:01:27 +00007915 }
drh13449892005-09-07 21:22:45 +00007916 for(j=0; j<pGroupBy->nExpr; j++){
7917 if( groupBySort ){
drh1c9d8352011-09-01 16:01:27 +00007918 sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
drh13449892005-09-07 21:22:45 +00007919 }else{
drhbf790972020-06-07 20:18:07 +00007920 pAggInfo->directMode = 1;
drh2dcef112008-01-12 19:03:48 +00007921 sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
drh13449892005-09-07 21:22:45 +00007922 }
drh13449892005-09-07 21:22:45 +00007923 }
drh16ee60f2008-06-20 18:13:25 +00007924 sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
drh2ec2fb22013-11-06 19:59:23 +00007925 (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
drh728e0f92015-10-10 14:41:28 +00007926 addr1 = sqlite3VdbeCurrentAddr(v);
7927 sqlite3VdbeAddOp3(v, OP_Jump, addr1+1, 0, addr1+1); VdbeCoverage(v);
drh13449892005-09-07 21:22:45 +00007928
7929 /* Generate code that runs whenever the GROUP BY changes.
drhe00ee6e2008-06-20 15:24:01 +00007930 ** Changes in the GROUP BY are detected by the previous code
drh13449892005-09-07 21:22:45 +00007931 ** block. If there were no changes, this block is skipped.
7932 **
7933 ** This code copies current group by terms in b0,b1,b2,...
7934 ** over to a0,a1,a2. It then calls the output subroutine
7935 ** and resets the aggregate accumulator registers in preparation
7936 ** for the next GROUP BY batch.
7937 */
drhb21e7c72008-06-22 12:37:57 +00007938 sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
drh2eb95372008-06-06 15:04:36 +00007939 sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
drhd4e70eb2008-01-02 00:34:36 +00007940 VdbeComment((v, "output one row"));
drh688852a2014-02-17 22:40:43 +00007941 sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
drhd4e70eb2008-01-02 00:34:36 +00007942 VdbeComment((v, "check abort flag"));
drh2eb95372008-06-06 15:04:36 +00007943 sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
drhd4e70eb2008-01-02 00:34:36 +00007944 VdbeComment((v, "reset accumulator"));
drh13449892005-09-07 21:22:45 +00007945
7946 /* Update the aggregate accumulators based on the content of
7947 ** the current row
7948 */
drh728e0f92015-10-10 14:41:28 +00007949 sqlite3VdbeJumpHere(v, addr1);
dan5383db72021-03-12 18:24:31 +00007950 updateAccumulator(pParse, iUseFlag, pAggInfo, eDist);
drh4c583122008-01-04 22:01:03 +00007951 sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
drhd4e70eb2008-01-02 00:34:36 +00007952 VdbeComment((v, "indicate data in accumulator"));
drh13449892005-09-07 21:22:45 +00007953
7954 /* End of the loop
7955 */
7956 if( groupBySort ){
drhd1930572021-01-13 15:23:17 +00007957 sqlite3VdbeAddOp2(v, OP_SorterNext, pAggInfo->sortingIdx,addrTopOfLoop);
drh688852a2014-02-17 22:40:43 +00007958 VdbeCoverage(v);
drh13449892005-09-07 21:22:45 +00007959 }else{
drh5d7aef12022-11-22 19:49:16 +00007960 TREETRACE(0x2,pParse,p,("WhereEnd\n"));
drh13449892005-09-07 21:22:45 +00007961 sqlite3WhereEnd(pWInfo);
drh48f2d3b2011-09-16 01:34:43 +00007962 sqlite3VdbeChangeToNoop(v, addrSortingIdx);
drh13449892005-09-07 21:22:45 +00007963 }
danbfd6f1b2021-04-08 20:29:12 +00007964 sqlite3ExprListDelete(db, pDistinct);
drh13449892005-09-07 21:22:45 +00007965
7966 /* Output the final row of result
7967 */
drh2eb95372008-06-06 15:04:36 +00007968 sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
drhd4e70eb2008-01-02 00:34:36 +00007969 VdbeComment((v, "output final row"));
drhd1766112008-09-17 00:13:12 +00007970
7971 /* Jump over the subroutines
7972 */
drh076e85f2015-09-03 13:46:12 +00007973 sqlite3VdbeGoto(v, addrEnd);
drhd1766112008-09-17 00:13:12 +00007974
7975 /* Generate a subroutine that outputs a single row of the result
7976 ** set. This subroutine first looks at the iUseFlag. If iUseFlag
7977 ** is less than or equal to zero, the subroutine is a no-op. If
7978 ** the processing calls for the query to abort, this subroutine
7979 ** increments the iAbortFlag memory location before returning in
7980 ** order to signal the caller to abort.
7981 */
7982 addrSetAbort = sqlite3VdbeCurrentAddr(v);
7983 sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
7984 VdbeComment((v, "set abort flag"));
7985 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7986 sqlite3VdbeResolveLabel(v, addrOutputRow);
7987 addrOutputRow = sqlite3VdbeCurrentAddr(v);
7988 sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2);
drh38b41492015-06-08 15:08:15 +00007989 VdbeCoverage(v);
drhd1766112008-09-17 00:13:12 +00007990 VdbeComment((v, "Groupby result generator entry point"));
7991 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
drhbf790972020-06-07 20:18:07 +00007992 finalizeAggFunctions(pParse, pAggInfo);
drh33cd4902009-05-30 20:49:20 +00007993 sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
drh2def2f72017-09-15 17:40:34 +00007994 selectInnerLoop(pParse, p, -1, &sSort,
drhe8e4af72012-09-21 00:04:28 +00007995 &sDistinct, pDest,
drhd1766112008-09-17 00:13:12 +00007996 addrOutputRow+1, addrSetAbort);
7997 sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7998 VdbeComment((v, "end groupby result generator"));
7999
8000 /* Generate a subroutine that will reset the group-by accumulator
8001 */
8002 sqlite3VdbeResolveLabel(v, addrReset);
drhbf790972020-06-07 20:18:07 +00008003 resetAccumulator(pParse, pAggInfo);
dan280c8942018-06-05 20:04:28 +00008004 sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
8005 VdbeComment((v, "indicate accumulator empty"));
drhd1766112008-09-17 00:13:12 +00008006 sqlite3VdbeAddOp1(v, OP_Return, regReset);
dan5383db72021-03-12 18:24:31 +00008007
danece092e2022-03-16 12:06:00 +00008008 if( distFlag!=0 && eDist!=WHERE_DISTINCT_NOOP ){
dan5383db72021-03-12 18:24:31 +00008009 struct AggInfo_func *pF = &pAggInfo->aFunc[0];
8010 fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
8011 }
drh43152cf2009-05-19 19:04:58 +00008012 } /* endif pGroupBy. Begin aggregate queries without GROUP BY: */
drh13449892005-09-07 21:22:45 +00008013 else {
danielk1977a5533162009-02-24 10:01:51 +00008014 Table *pTab;
drhbf790972020-06-07 20:18:07 +00008015 if( (pTab = isSimpleCount(p, pAggInfo))!=0 ){
danielk1977a5533162009-02-24 10:01:51 +00008016 /* If isSimpleCount() returns a pointer to a Table structure, then
8017 ** the SQL statement is of the form:
8018 **
8019 ** SELECT count(*) FROM <tbl>
8020 **
8021 ** where the Table structure returned represents table <tbl>.
8022 **
8023 ** This statement is so common that it is optimized specially. The
8024 ** OP_Count instruction is executed either on the intkey table that
8025 ** contains the data for table <tbl> or on one of its indexes. It
8026 ** is better to execute the op on an index, as indexes are almost
8027 ** always spread across less pages than their corresponding tables.
8028 */
8029 const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
8030 const int iCsr = pParse->nTab++; /* Cursor to scan b-tree */
8031 Index *pIdx; /* Iterator variable */
8032 KeyInfo *pKeyInfo = 0; /* Keyinfo for scanned index */
8033 Index *pBest = 0; /* Best index found so far */
drh013e7bb2020-07-30 17:37:49 +00008034 Pgno iRoot = pTab->tnum; /* Root page of scanned b-tree */
danielk1977a9d1ccb2008-01-05 17:39:29 +00008035
danielk1977a5533162009-02-24 10:01:51 +00008036 sqlite3CodeVerifySchema(pParse, iDb);
8037 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
8038
drhd9e3cad2013-10-04 02:36:19 +00008039 /* Search for the index that has the lowest scan cost.
danielk1977a5533162009-02-24 10:01:51 +00008040 **
drh3e9548b2011-04-15 14:46:27 +00008041 ** (2011-04-15) Do not do a full scan of an unordered index.
8042 **
drhabcc1942013-11-12 14:55:40 +00008043 ** (2013-10-03) Do not count the entries in a partial index.
drh5f33f372013-10-04 00:00:12 +00008044 **
danielk1977a5533162009-02-24 10:01:51 +00008045 ** In practice the KeyInfo structure will not be used. It is only
8046 ** passed to keep OP_OpenRead happy.
8047 */
drh5c7917e2013-11-12 15:33:40 +00008048 if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
drh98aa1d72020-05-08 18:22:00 +00008049 if( !p->pSrc->a[0].fg.notIndexed ){
8050 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
8051 if( pIdx->bUnordered==0
8052 && pIdx->szIdxRow<pTab->szTabRow
8053 && pIdx->pPartIdxWhere==0
8054 && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
8055 ){
8056 pBest = pIdx;
8057 }
danielk1977a5533162009-02-24 10:01:51 +00008058 }
8059 }
drhd9e3cad2013-10-04 02:36:19 +00008060 if( pBest ){
danielk1977a5533162009-02-24 10:01:51 +00008061 iRoot = pBest->tnum;
drh2ec2fb22013-11-06 19:59:23 +00008062 pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
danielk1977a5533162009-02-24 10:01:51 +00008063 }
8064
8065 /* Open a read-only cursor, execute the OP_Count, close the cursor. */
drh013e7bb2020-07-30 17:37:49 +00008066 sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, (int)iRoot, iDb, 1);
danielk1977a5533162009-02-24 10:01:51 +00008067 if( pKeyInfo ){
drh2ec2fb22013-11-06 19:59:23 +00008068 sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
danielk1977a5533162009-02-24 10:01:51 +00008069 }
drh42b78232022-11-22 14:10:22 +00008070 assignAggregateRegisters(pParse, pAggInfo);
drh3c8e4382022-11-22 15:43:16 +00008071 sqlite3VdbeAddOp2(v, OP_Count, iCsr, AggInfoFuncReg(pAggInfo,0));
danielk1977a5533162009-02-24 10:01:51 +00008072 sqlite3VdbeAddOp1(v, OP_Close, iCsr);
danef7075d2011-02-21 17:49:49 +00008073 explainSimpleCount(pParse, pTab, pBest);
drhe50478d2020-03-17 13:41:51 +00008074 }else{
dan280c8942018-06-05 20:04:28 +00008075 int regAcc = 0; /* "populate accumulators" flag */
dan4fcb30b2021-03-09 16:06:25 +00008076 ExprList *pDistinct = 0;
8077 u16 distFlag = 0;
dan5383db72021-03-12 18:24:31 +00008078 int eDist;
dan280c8942018-06-05 20:04:28 +00008079
daned09ddd2019-09-20 20:52:16 +00008080 /* If there are accumulator registers but no min() or max() functions
8081 ** without FILTER clauses, allocate register regAcc. Register regAcc
8082 ** will contain 0 the first time the inner loop runs, and 1 thereafter.
8083 ** The code generated by updateAccumulator() uses this to ensure
8084 ** that the accumulator registers are (a) updated only once if
8085 ** there are no min() or max functions or (b) always updated for the
8086 ** first row visited by the aggregate, so that they are updated at
8087 ** least once even if the FILTER clause means the min() or max()
8088 ** function visits zero rows. */
drhbf790972020-06-07 20:18:07 +00008089 if( pAggInfo->nAccumulator ){
8090 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00008091 if( ExprHasProperty(pAggInfo->aFunc[i].pFExpr, EP_WinFunc) ){
drhbf790972020-06-07 20:18:07 +00008092 continue;
8093 }
8094 if( pAggInfo->aFunc[i].pFunc->funcFlags&SQLITE_FUNC_NEEDCOLL ){
8095 break;
8096 }
dan280c8942018-06-05 20:04:28 +00008097 }
drhbf790972020-06-07 20:18:07 +00008098 if( i==pAggInfo->nFunc ){
dan280c8942018-06-05 20:04:28 +00008099 regAcc = ++pParse->nMem;
8100 sqlite3VdbeAddOp2(v, OP_Integer, 0, regAcc);
8101 }
dan4fcb30b2021-03-09 16:06:25 +00008102 }else if( pAggInfo->nFunc==1 && pAggInfo->aFunc[0].iDistinct>=0 ){
drha4eeccd2021-10-07 17:43:30 +00008103 assert( ExprUseXList(pAggInfo->aFunc[0].pFExpr) );
dan4fcb30b2021-03-09 16:06:25 +00008104 pDistinct = pAggInfo->aFunc[0].pFExpr->x.pList;
danf330d532021-04-03 19:23:59 +00008105 distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
dan280c8942018-06-05 20:04:28 +00008106 }
drh42b78232022-11-22 14:10:22 +00008107 assignAggregateRegisters(pParse, pAggInfo);
dan280c8942018-06-05 20:04:28 +00008108
danielk1977a5533162009-02-24 10:01:51 +00008109 /* This case runs if the aggregate has no GROUP BY clause. The
8110 ** processing is much simpler since there is only a single row
8111 ** of output.
8112 */
drh47d9f832017-10-26 20:04:28 +00008113 assert( p->pGroupBy==0 );
drhbf790972020-06-07 20:18:07 +00008114 resetAccumulator(pParse, pAggInfo);
drh47d9f832017-10-26 20:04:28 +00008115
8116 /* If this query is a candidate for the min/max optimization, then
8117 ** minMaxFlag will have been previously set to either
8118 ** WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX and pMinMaxOrderBy will
8119 ** be an appropriate ORDER BY expression for the optimization.
8120 */
8121 assert( minMaxFlag==WHERE_ORDERBY_NORMAL || pMinMaxOrderBy!=0 );
8122 assert( pMinMaxOrderBy==0 || pMinMaxOrderBy->nExpr==1 );
8123
drh5d7aef12022-11-22 19:49:16 +00008124 TREETRACE(0x2,pParse,p,("WhereBegin\n"));
drh47d9f832017-10-26 20:04:28 +00008125 pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMaxOrderBy,
drhfb643592022-10-22 23:09:29 +00008126 pDistinct, p, minMaxFlag|distFlag, 0);
danielk1977a5533162009-02-24 10:01:51 +00008127 if( pWInfo==0 ){
danielk1977a5533162009-02-24 10:01:51 +00008128 goto select_end;
8129 }
drh5d7aef12022-11-22 19:49:16 +00008130 TREETRACE(0x2,pParse,p,("WhereBegin returns\n"));
dan5383db72021-03-12 18:24:31 +00008131 eDist = sqlite3WhereIsDistinct(pWInfo);
8132 updateAccumulator(pParse, regAcc, pAggInfo, eDist);
8133 if( eDist!=WHERE_DISTINCT_NOOP ){
drhde695ea2022-05-10 15:55:10 +00008134 struct AggInfo_func *pF = pAggInfo->aFunc;
drh3117b7b2022-04-19 18:23:01 +00008135 if( pF ){
8136 fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
8137 }
dan5383db72021-03-12 18:24:31 +00008138 }
8139
dan280c8942018-06-05 20:04:28 +00008140 if( regAcc ) sqlite3VdbeAddOp2(v, OP_Integer, 1, regAcc);
drhd1930572021-01-13 15:23:17 +00008141 if( minMaxFlag ){
8142 sqlite3WhereMinMaxOptEarlyOut(v, pWInfo);
danielk1977a5533162009-02-24 10:01:51 +00008143 }
drh5d7aef12022-11-22 19:49:16 +00008144 TREETRACE(0x2,pParse,p,("WhereEnd\n"));
danielk1977a5533162009-02-24 10:01:51 +00008145 sqlite3WhereEnd(pWInfo);
drhbf790972020-06-07 20:18:07 +00008146 finalizeAggFunctions(pParse, pAggInfo);
danielk1977a9d1ccb2008-01-05 17:39:29 +00008147 }
8148
drh079a3072014-03-19 14:10:55 +00008149 sSort.pOrderBy = 0;
drh33cd4902009-05-30 20:49:20 +00008150 sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
drh2def2f72017-09-15 17:40:34 +00008151 selectInnerLoop(pParse, p, -1, 0, 0,
drha9671a22008-07-08 23:40:20 +00008152 pDest, addrEnd, addrEnd);
drh13449892005-09-07 21:22:45 +00008153 }
8154 sqlite3VdbeResolveLabel(v, addrEnd);
8155
8156 } /* endif aggregate query */
drh22827922000-06-06 17:27:05 +00008157
drhe8e4af72012-09-21 00:04:28 +00008158 if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
dan2ce22452010-11-08 19:01:16 +00008159 explainTempTable(pParse, "DISTINCT");
8160 }
8161
drhcce7d172000-05-31 15:34:51 +00008162 /* If there is an ORDER BY clause, then we need to sort the results
8163 ** and send them to the callback one by one.
8164 */
drh079a3072014-03-19 14:10:55 +00008165 if( sSort.pOrderBy ){
dan24e25d32018-04-14 18:46:20 +00008166 assert( p->pEList==pEList );
drh079a3072014-03-19 14:10:55 +00008167 generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
drhcce7d172000-05-31 15:34:51 +00008168 }
drh6a535342001-10-19 16:44:56 +00008169
drhec7429a2005-10-06 16:53:14 +00008170 /* Jump here to skip this query
8171 */
8172 sqlite3VdbeResolveLabel(v, iEnd);
8173
dan5b1c07e2015-04-16 07:19:23 +00008174 /* The SELECT has been coded. If there is an error in the Parse structure,
8175 ** set the return code to 1. Otherwise 0. */
8176 rc = (pParse->nErr>0);
drh1d83f052002-02-17 00:30:36 +00008177
8178 /* Control jumps to here if an error is encountered above, or upon
8179 ** successful coding of the SELECT.
8180 */
8181select_end:
dan44918c72021-04-17 14:42:37 +00008182 assert( db->mallocFailed==0 || db->mallocFailed==1 );
drh0c7d3d32022-01-24 16:47:12 +00008183 assert( db->mallocFailed==0 || pParse->nErr!=0 );
drh47d9f832017-10-26 20:04:28 +00008184 sqlite3ExprListDelete(db, pMinMaxOrderBy);
drh89636622020-06-07 17:33:18 +00008185#ifdef SQLITE_DEBUG
drh7b4c4d42020-06-10 03:07:26 +00008186 if( pAggInfo && !db->mallocFailed ){
drhbf790972020-06-07 20:18:07 +00008187 for(i=0; i<pAggInfo->nColumn; i++){
drh81185a52020-06-09 13:38:12 +00008188 Expr *pExpr = pAggInfo->aCol[i].pCExpr;
drh590f0132022-11-23 17:56:00 +00008189 if( pExpr==0 ) continue;
drhbf790972020-06-07 20:18:07 +00008190 assert( pExpr->pAggInfo==pAggInfo );
drh89636622020-06-07 17:33:18 +00008191 assert( pExpr->iAgg==i );
8192 }
drhbf790972020-06-07 20:18:07 +00008193 for(i=0; i<pAggInfo->nFunc; i++){
drh81185a52020-06-09 13:38:12 +00008194 Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
drh06ddb082020-12-22 14:54:20 +00008195 assert( pExpr!=0 );
drhbf790972020-06-07 20:18:07 +00008196 assert( pExpr->pAggInfo==pAggInfo );
drh89636622020-06-07 17:33:18 +00008197 assert( pExpr->iAgg==i );
8198 }
drh89636622020-06-07 17:33:18 +00008199 }
drh89636622020-06-07 17:33:18 +00008200#endif
8201
drh5e431be2022-04-06 11:08:38 +00008202#if TREETRACE_ENABLED
drh5d7aef12022-11-22 19:49:16 +00008203 TREETRACE(0x1,pParse,p,("end processing\n"));
8204 if( (sqlite3TreeTrace & 0x40000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
drhf20609d2018-04-23 17:43:35 +00008205 sqlite3TreeViewSelect(0, p, 0);
8206 }
drheb9b8842014-09-21 00:27:26 +00008207#endif
drhe2ca99c2018-05-02 00:33:43 +00008208 ExplainQueryPlanPop(pParse);
drh1d83f052002-02-17 00:30:36 +00008209 return rc;
drhcce7d172000-05-31 15:34:51 +00008210}