blob: ecd6bd2a8f632c092deb862ce2876fd7434ae6da [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +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:
drh75897232000-05-29 14:26:00 +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.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** This module contains C code that generates VDBE code used to process
drh909626d2008-05-30 14:58:37 +000013** the WHERE clause of SQL statements. This module is responsible for
drh51669862004-12-18 18:40:26 +000014** generating the code that loops through a table looking for applicable
15** rows. Indices are selected and used to speed the search when doing
16** so is applicable. Because this module is responsible for selecting
17** indices, you might also think of this module as the "query optimizer".
drh75897232000-05-29 14:26:00 +000018*/
19#include "sqliteInt.h"
drhe54df422013-11-12 18:37:25 +000020#include "whereInt.h"
drh51147ba2005-07-23 22:59:55 +000021
22/*
drh6f328482013-06-05 23:39:34 +000023** Return the estimated number of output rows from a WHERE clause
24*/
drhc63367e2013-06-10 20:46:50 +000025u64 sqlite3WhereOutputRowCount(WhereInfo *pWInfo){
drhbf539c42013-10-05 18:16:02 +000026 return sqlite3LogEstToInt(pWInfo->nRowOut);
drh6f328482013-06-05 23:39:34 +000027}
28
29/*
30** Return one of the WHERE_DISTINCT_xxxxx values to indicate how this
31** WHERE clause returns outputs for DISTINCT processing.
32*/
33int sqlite3WhereIsDistinct(WhereInfo *pWInfo){
34 return pWInfo->eDistinct;
35}
36
37/*
38** Return TRUE if the WHERE clause returns rows in ORDER BY order.
39** Return FALSE if the output needs to be sorted.
40*/
41int sqlite3WhereIsOrdered(WhereInfo *pWInfo){
drhddba0c22014-03-18 20:33:42 +000042 return pWInfo->nOBSat;
drh6f328482013-06-05 23:39:34 +000043}
44
45/*
46** Return the VDBE address or label to jump to in order to continue
47** immediately with the next row of a WHERE clause.
48*/
49int sqlite3WhereContinueLabel(WhereInfo *pWInfo){
drha22a75e2014-03-21 18:16:23 +000050 assert( pWInfo->iContinue!=0 );
drh6f328482013-06-05 23:39:34 +000051 return pWInfo->iContinue;
52}
53
54/*
55** Return the VDBE address or label to jump to in order to break
56** out of a WHERE loop.
57*/
58int sqlite3WhereBreakLabel(WhereInfo *pWInfo){
59 return pWInfo->iBreak;
60}
61
62/*
63** Return TRUE if an UPDATE or DELETE statement can operate directly on
64** the rowids returned by a WHERE clause. Return FALSE if doing an
65** UPDATE or DELETE might change subsequent WHERE clause results.
drhfc8d4f92013-11-08 15:19:46 +000066**
67** If the ONEPASS optimization is used (if this routine returns true)
68** then also write the indices of open cursors used by ONEPASS
69** into aiCur[0] and aiCur[1]. iaCur[0] gets the cursor of the data
70** table and iaCur[1] gets the cursor used by an auxiliary index.
71** Either value may be -1, indicating that cursor is not used.
72** Any cursors returned will have been opened for writing.
73**
74** aiCur[0] and aiCur[1] both get -1 if the where-clause logic is
75** unable to use the ONEPASS optimization.
drh6f328482013-06-05 23:39:34 +000076*/
drhfc8d4f92013-11-08 15:19:46 +000077int sqlite3WhereOkOnePass(WhereInfo *pWInfo, int *aiCur){
78 memcpy(aiCur, pWInfo->aiCurOnePass, sizeof(int)*2);
drh6f328482013-06-05 23:39:34 +000079 return pWInfo->okOnePass;
80}
81
82/*
drhaa32e3c2013-07-16 21:31:23 +000083** Move the content of pSrc into pDest
84*/
85static void whereOrMove(WhereOrSet *pDest, WhereOrSet *pSrc){
86 pDest->n = pSrc->n;
87 memcpy(pDest->a, pSrc->a, pDest->n*sizeof(pDest->a[0]));
88}
89
90/*
91** Try to insert a new prerequisite/cost entry into the WhereOrSet pSet.
92**
93** The new entry might overwrite an existing entry, or it might be
94** appended, or it might be discarded. Do whatever is the right thing
95** so that pSet keeps the N_OR_COST best entries seen so far.
96*/
97static int whereOrInsert(
98 WhereOrSet *pSet, /* The WhereOrSet to be updated */
99 Bitmask prereq, /* Prerequisites of the new entry */
drhbf539c42013-10-05 18:16:02 +0000100 LogEst rRun, /* Run-cost of the new entry */
101 LogEst nOut /* Number of outputs for the new entry */
drhaa32e3c2013-07-16 21:31:23 +0000102){
103 u16 i;
104 WhereOrCost *p;
105 for(i=pSet->n, p=pSet->a; i>0; i--, p++){
106 if( rRun<=p->rRun && (prereq & p->prereq)==prereq ){
107 goto whereOrInsert_done;
108 }
109 if( p->rRun<=rRun && (p->prereq & prereq)==p->prereq ){
110 return 0;
111 }
112 }
113 if( pSet->n<N_OR_COST ){
114 p = &pSet->a[pSet->n++];
115 p->nOut = nOut;
116 }else{
117 p = pSet->a;
118 for(i=1; i<pSet->n; i++){
119 if( p->rRun>pSet->a[i].rRun ) p = pSet->a + i;
120 }
121 if( p->rRun<=rRun ) return 0;
122 }
123whereOrInsert_done:
124 p->prereq = prereq;
125 p->rRun = rRun;
126 if( p->nOut>nOut ) p->nOut = nOut;
127 return 1;
128}
129
130/*
drh0aa74ed2005-07-16 13:33:20 +0000131** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000132*/
drh7b4fc6a2007-02-06 13:26:32 +0000133static void whereClauseInit(
134 WhereClause *pWC, /* The WhereClause to be initialized */
drh70d18342013-06-06 19:16:33 +0000135 WhereInfo *pWInfo /* The WHERE processing context */
drh7b4fc6a2007-02-06 13:26:32 +0000136){
drh70d18342013-06-06 19:16:33 +0000137 pWC->pWInfo = pWInfo;
drh8871ef52011-10-07 13:33:10 +0000138 pWC->pOuter = 0;
drh0aa74ed2005-07-16 13:33:20 +0000139 pWC->nTerm = 0;
drhcad651e2007-04-20 12:22:01 +0000140 pWC->nSlot = ArraySize(pWC->aStatic);
drh0aa74ed2005-07-16 13:33:20 +0000141 pWC->a = pWC->aStatic;
142}
143
drh700a2262008-12-17 19:22:15 +0000144/* Forward reference */
145static void whereClauseClear(WhereClause*);
146
147/*
148** Deallocate all memory associated with a WhereOrInfo object.
149*/
150static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000151 whereClauseClear(&p->wc);
152 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000153}
154
155/*
156** Deallocate all memory associated with a WhereAndInfo object.
157*/
158static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000159 whereClauseClear(&p->wc);
160 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000161}
162
drh0aa74ed2005-07-16 13:33:20 +0000163/*
164** Deallocate a WhereClause structure. The WhereClause structure
165** itself is not freed. This routine is the inverse of whereClauseInit().
166*/
167static void whereClauseClear(WhereClause *pWC){
168 int i;
169 WhereTerm *a;
drh70d18342013-06-06 19:16:33 +0000170 sqlite3 *db = pWC->pWInfo->pParse->db;
drh0aa74ed2005-07-16 13:33:20 +0000171 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
drh165be382008-12-05 02:36:33 +0000172 if( a->wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000173 sqlite3ExprDelete(db, a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000174 }
drh700a2262008-12-17 19:22:15 +0000175 if( a->wtFlags & TERM_ORINFO ){
176 whereOrInfoDelete(db, a->u.pOrInfo);
177 }else if( a->wtFlags & TERM_ANDINFO ){
178 whereAndInfoDelete(db, a->u.pAndInfo);
179 }
drh0aa74ed2005-07-16 13:33:20 +0000180 }
181 if( pWC->a!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000182 sqlite3DbFree(db, pWC->a);
drh0aa74ed2005-07-16 13:33:20 +0000183 }
184}
185
186/*
drh6a1e0712008-12-05 15:24:15 +0000187** Add a single new WhereTerm entry to the WhereClause object pWC.
188** The new WhereTerm object is constructed from Expr p and with wtFlags.
189** The index in pWC->a[] of the new WhereTerm is returned on success.
190** 0 is returned if the new WhereTerm could not be added due to a memory
191** allocation error. The memory allocation failure will be recorded in
192** the db->mallocFailed flag so that higher-level functions can detect it.
193**
194** This routine will increase the size of the pWC->a[] array as necessary.
drh9eb20282005-08-24 03:52:18 +0000195**
drh165be382008-12-05 02:36:33 +0000196** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
drh6a1e0712008-12-05 15:24:15 +0000197** for freeing the expression p is assumed by the WhereClause object pWC.
198** This is true even if this routine fails to allocate a new WhereTerm.
drhb63a53d2007-03-31 01:34:44 +0000199**
drh9eb20282005-08-24 03:52:18 +0000200** WARNING: This routine might reallocate the space used to store
drh909626d2008-05-30 14:58:37 +0000201** WhereTerms. All pointers to WhereTerms should be invalidated after
drh9eb20282005-08-24 03:52:18 +0000202** calling this routine. Such pointers may be reinitialized by referencing
203** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000204*/
drhf07cf6e2015-03-06 16:45:16 +0000205static int whereClauseInsert(WhereClause *pWC, Expr *p, u16 wtFlags){
drh0aa74ed2005-07-16 13:33:20 +0000206 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000207 int idx;
drh39759742013-08-02 23:40:45 +0000208 testcase( wtFlags & TERM_VIRTUAL );
drh0aa74ed2005-07-16 13:33:20 +0000209 if( pWC->nTerm>=pWC->nSlot ){
210 WhereTerm *pOld = pWC->a;
drh70d18342013-06-06 19:16:33 +0000211 sqlite3 *db = pWC->pWInfo->pParse->db;
drh633e6d52008-07-28 19:34:53 +0000212 pWC->a = sqlite3DbMallocRaw(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
drhb63a53d2007-03-31 01:34:44 +0000213 if( pWC->a==0 ){
drh165be382008-12-05 02:36:33 +0000214 if( wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000215 sqlite3ExprDelete(db, p);
drhb63a53d2007-03-31 01:34:44 +0000216 }
drhf998b732007-11-26 13:36:00 +0000217 pWC->a = pOld;
drhb63a53d2007-03-31 01:34:44 +0000218 return 0;
219 }
drh0aa74ed2005-07-16 13:33:20 +0000220 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
221 if( pOld!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000222 sqlite3DbFree(db, pOld);
drh0aa74ed2005-07-16 13:33:20 +0000223 }
drh6a1e0712008-12-05 15:24:15 +0000224 pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
drhfe32daa2014-12-05 19:50:58 +0000225 memset(&pWC->a[pWC->nTerm], 0, sizeof(pWC->a[0])*(pWC->nSlot-pWC->nTerm));
drh0aa74ed2005-07-16 13:33:20 +0000226 }
drh6a1e0712008-12-05 15:24:15 +0000227 pTerm = &pWC->a[idx = pWC->nTerm++];
drha4c3c872013-09-12 17:29:25 +0000228 if( p && ExprHasProperty(p, EP_Unlikely) ){
drhd05ab6a2014-10-25 13:42:16 +0000229 pTerm->truthProb = sqlite3LogEst(p->iTable) - 270;
drhcca9f3d2013-09-06 15:23:29 +0000230 }else{
danaa9933c2014-04-24 20:04:49 +0000231 pTerm->truthProb = 1;
drhcca9f3d2013-09-06 15:23:29 +0000232 }
drh7ee751d2012-12-19 15:53:51 +0000233 pTerm->pExpr = sqlite3ExprSkipCollate(p);
drh165be382008-12-05 02:36:33 +0000234 pTerm->wtFlags = wtFlags;
drh0fcef5e2005-07-19 17:38:22 +0000235 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000236 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000237 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000238}
drh75897232000-05-29 14:26:00 +0000239
240/*
drh51669862004-12-18 18:40:26 +0000241** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000242** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000243** operator specified in the op parameter. The WhereClause structure
244** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000245**
drh51669862004-12-18 18:40:26 +0000246** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
247** \________/ \_______________/ \________________/
248** slot[0] slot[1] slot[2]
249**
250** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000251** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000252**
drh51147ba2005-07-23 22:59:55 +0000253** In the previous sentence and in the diagram, "slot[]" refers to
drh902b9ee2008-12-05 17:17:07 +0000254** the WhereClause.a[] array. The slot[] array grows as needed to contain
drh51147ba2005-07-23 22:59:55 +0000255** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000256*/
drh74f91d42013-06-19 18:01:44 +0000257static void whereSplit(WhereClause *pWC, Expr *pExpr, u8 op){
drh0f517ea2015-04-21 02:12:13 +0000258 Expr *pE2 = sqlite3ExprSkipCollate(pExpr);
drh74f91d42013-06-19 18:01:44 +0000259 pWC->op = op;
drh0f517ea2015-04-21 02:12:13 +0000260 if( pE2==0 ) return;
261 if( pE2->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000262 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000263 }else{
drh0f517ea2015-04-21 02:12:13 +0000264 whereSplit(pWC, pE2->pLeft, op);
265 whereSplit(pWC, pE2->pRight, op);
drh75897232000-05-29 14:26:00 +0000266 }
drh75897232000-05-29 14:26:00 +0000267}
268
269/*
drh3b48e8c2013-06-12 20:18:16 +0000270** Initialize a WhereMaskSet object
drh6a3ea0e2003-05-02 14:32:12 +0000271*/
drhfd5874d2013-06-12 14:52:39 +0000272#define initMaskSet(P) (P)->n=0
drh6a3ea0e2003-05-02 14:32:12 +0000273
274/*
drh1398ad32005-01-19 23:24:50 +0000275** Return the bitmask for the given cursor number. Return 0 if
276** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000277*/
drh111a6a72008-12-21 03:51:16 +0000278static Bitmask getMask(WhereMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000279 int i;
drhfcd71b62011-04-05 22:08:24 +0000280 assert( pMaskSet->n<=(int)sizeof(Bitmask)*8 );
drh6a3ea0e2003-05-02 14:32:12 +0000281 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000282 if( pMaskSet->ix[i]==iCursor ){
drh7699d1c2013-06-04 12:42:29 +0000283 return MASKBIT(i);
drh51669862004-12-18 18:40:26 +0000284 }
drh6a3ea0e2003-05-02 14:32:12 +0000285 }
drh6a3ea0e2003-05-02 14:32:12 +0000286 return 0;
287}
288
289/*
drh1398ad32005-01-19 23:24:50 +0000290** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000291**
292** There is one cursor per table in the FROM clause. The number of
293** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000294** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000295** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000296*/
drh111a6a72008-12-21 03:51:16 +0000297static void createMask(WhereMaskSet *pMaskSet, int iCursor){
drhcad651e2007-04-20 12:22:01 +0000298 assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
drh0fcef5e2005-07-19 17:38:22 +0000299 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000300}
301
302/*
drh4a6fc352013-08-07 01:18:38 +0000303** These routines walk (recursively) an expression tree and generate
drh75897232000-05-29 14:26:00 +0000304** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000305** tree.
drh75897232000-05-29 14:26:00 +0000306*/
drh111a6a72008-12-21 03:51:16 +0000307static Bitmask exprListTableUsage(WhereMaskSet*, ExprList*);
308static Bitmask exprSelectTableUsage(WhereMaskSet*, Select*);
309static Bitmask exprTableUsage(WhereMaskSet *pMaskSet, Expr *p){
drh51669862004-12-18 18:40:26 +0000310 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000311 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000312 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000313 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000314 return mask;
drh75897232000-05-29 14:26:00 +0000315 }
danielk1977b3bce662005-01-29 08:32:43 +0000316 mask = exprTableUsage(pMaskSet, p->pRight);
317 mask |= exprTableUsage(pMaskSet, p->pLeft);
danielk19776ab3a2e2009-02-19 14:39:25 +0000318 if( ExprHasProperty(p, EP_xIsSelect) ){
319 mask |= exprSelectTableUsage(pMaskSet, p->x.pSelect);
320 }else{
321 mask |= exprListTableUsage(pMaskSet, p->x.pList);
322 }
danielk1977b3bce662005-01-29 08:32:43 +0000323 return mask;
324}
drh111a6a72008-12-21 03:51:16 +0000325static Bitmask exprListTableUsage(WhereMaskSet *pMaskSet, ExprList *pList){
danielk1977b3bce662005-01-29 08:32:43 +0000326 int i;
327 Bitmask mask = 0;
328 if( pList ){
329 for(i=0; i<pList->nExpr; i++){
330 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000331 }
332 }
drh75897232000-05-29 14:26:00 +0000333 return mask;
334}
drh111a6a72008-12-21 03:51:16 +0000335static Bitmask exprSelectTableUsage(WhereMaskSet *pMaskSet, Select *pS){
drha430ae82007-09-12 15:41:01 +0000336 Bitmask mask = 0;
337 while( pS ){
drha464c232011-09-16 19:04:03 +0000338 SrcList *pSrc = pS->pSrc;
drha430ae82007-09-12 15:41:01 +0000339 mask |= exprListTableUsage(pMaskSet, pS->pEList);
drhf5b11382005-09-17 13:07:13 +0000340 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
341 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
342 mask |= exprTableUsage(pMaskSet, pS->pWhere);
343 mask |= exprTableUsage(pMaskSet, pS->pHaving);
drha464c232011-09-16 19:04:03 +0000344 if( ALWAYS(pSrc!=0) ){
drh88501772011-09-16 17:43:06 +0000345 int i;
346 for(i=0; i<pSrc->nSrc; i++){
347 mask |= exprSelectTableUsage(pMaskSet, pSrc->a[i].pSelect);
348 mask |= exprTableUsage(pMaskSet, pSrc->a[i].pOn);
349 }
350 }
drha430ae82007-09-12 15:41:01 +0000351 pS = pS->pPrior;
drhf5b11382005-09-17 13:07:13 +0000352 }
353 return mask;
354}
drh75897232000-05-29 14:26:00 +0000355
356/*
drh487ab3c2001-11-08 00:45:21 +0000357** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000358** allowed for an indexable WHERE clause term. The allowed operators are
drh3b48e8c2013-06-12 20:18:16 +0000359** "=", "<", ">", "<=", ">=", "IN", and "IS NULL"
drh487ab3c2001-11-08 00:45:21 +0000360*/
361static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000362 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
363 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
364 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
365 assert( TK_GE==TK_EQ+4 );
drhfcd49532015-05-13 15:24:07 +0000366 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL || op==TK_IS;
drh487ab3c2001-11-08 00:45:21 +0000367}
368
369/*
drh909626d2008-05-30 14:58:37 +0000370** Commute a comparison operator. Expressions of the form "X op Y"
drh0fcef5e2005-07-19 17:38:22 +0000371** are converted into "Y op X".
danielk1977eb5453d2007-07-30 14:40:48 +0000372**
mistachkin48864df2013-03-21 21:20:32 +0000373** If left/right precedence rules come into play when determining the
drh3b48e8c2013-06-12 20:18:16 +0000374** collating sequence, then COLLATE operators are adjusted to ensure
375** that the collating sequence does not change. For example:
376** "Y collate NOCASE op X" becomes "X op Y" because any collation sequence on
danielk1977eb5453d2007-07-30 14:40:48 +0000377** the left hand side of a comparison overrides any collation sequence
drhae80dde2012-12-06 21:16:43 +0000378** attached to the right. For the same reason the EP_Collate flag
danielk1977eb5453d2007-07-30 14:40:48 +0000379** is not commuted.
drh193bd772004-07-20 18:23:14 +0000380*/
drh7d10d5a2008-08-20 16:35:10 +0000381static void exprCommute(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000382 u16 expRight = (pExpr->pRight->flags & EP_Collate);
383 u16 expLeft = (pExpr->pLeft->flags & EP_Collate);
drhfe05af82005-07-21 03:14:59 +0000384 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drhae80dde2012-12-06 21:16:43 +0000385 if( expRight==expLeft ){
386 /* Either X and Y both have COLLATE operator or neither do */
387 if( expRight ){
388 /* Both X and Y have COLLATE operators. Make sure X is always
389 ** used by clearing the EP_Collate flag from Y. */
390 pExpr->pRight->flags &= ~EP_Collate;
391 }else if( sqlite3ExprCollSeq(pParse, pExpr->pLeft)!=0 ){
392 /* Neither X nor Y have COLLATE operators, but X has a non-default
393 ** collating sequence. So add the EP_Collate marker on X to cause
394 ** it to be searched first. */
395 pExpr->pLeft->flags |= EP_Collate;
396 }
397 }
drh0fcef5e2005-07-19 17:38:22 +0000398 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
399 if( pExpr->op>=TK_GT ){
400 assert( TK_LT==TK_GT+2 );
401 assert( TK_GE==TK_LE+2 );
402 assert( TK_GT>TK_EQ );
403 assert( TK_GT<TK_LE );
404 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
405 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000406 }
drh193bd772004-07-20 18:23:14 +0000407}
408
409/*
drhfe05af82005-07-21 03:14:59 +0000410** Translate from TK_xx operator to WO_xx bitmask.
411*/
drhec1724e2008-12-09 01:32:03 +0000412static u16 operatorMask(int op){
413 u16 c;
drhfe05af82005-07-21 03:14:59 +0000414 assert( allowedOp(op) );
415 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000416 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000417 }else if( op==TK_ISNULL ){
418 c = WO_ISNULL;
drhfcd49532015-05-13 15:24:07 +0000419 }else if( op==TK_IS ){
drhe8d0c612015-05-14 01:05:25 +0000420 c = WO_IS;
drhfe05af82005-07-21 03:14:59 +0000421 }else{
drhec1724e2008-12-09 01:32:03 +0000422 assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
423 c = (u16)(WO_EQ<<(op-TK_EQ));
drhfe05af82005-07-21 03:14:59 +0000424 }
drh50b39962006-10-28 00:28:09 +0000425 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh51147ba2005-07-23 22:59:55 +0000426 assert( op!=TK_IN || c==WO_IN );
427 assert( op!=TK_EQ || c==WO_EQ );
428 assert( op!=TK_LT || c==WO_LT );
429 assert( op!=TK_LE || c==WO_LE );
430 assert( op!=TK_GT || c==WO_GT );
431 assert( op!=TK_GE || c==WO_GE );
drhe8d0c612015-05-14 01:05:25 +0000432 assert( op!=TK_IS || c==WO_IS );
drh51147ba2005-07-23 22:59:55 +0000433 return c;
drhfe05af82005-07-21 03:14:59 +0000434}
435
436/*
drh1c8148f2013-05-04 20:25:23 +0000437** Advance to the next WhereTerm that matches according to the criteria
438** established when the pScan object was initialized by whereScanInit().
439** Return NULL if there are no more matching WhereTerms.
440*/
danb2cfc142013-07-05 11:10:54 +0000441static WhereTerm *whereScanNext(WhereScan *pScan){
drh1c8148f2013-05-04 20:25:23 +0000442 int iCur; /* The cursor on the LHS of the term */
443 int iColumn; /* The column on the LHS of the term. -1 for IPK */
444 Expr *pX; /* An expression being tested */
445 WhereClause *pWC; /* Shorthand for pScan->pWC */
446 WhereTerm *pTerm; /* The term being tested */
drh43b85ef2013-06-10 12:34:45 +0000447 int k = pScan->k; /* Where to start scanning */
drh1c8148f2013-05-04 20:25:23 +0000448
449 while( pScan->iEquiv<=pScan->nEquiv ){
450 iCur = pScan->aEquiv[pScan->iEquiv-2];
451 iColumn = pScan->aEquiv[pScan->iEquiv-1];
452 while( (pWC = pScan->pWC)!=0 ){
drh43b85ef2013-06-10 12:34:45 +0000453 for(pTerm=pWC->a+k; k<pWC->nTerm; k++, pTerm++){
drhe1a086e2013-10-28 20:15:56 +0000454 if( pTerm->leftCursor==iCur
455 && pTerm->u.leftColumn==iColumn
456 && (pScan->iEquiv<=2 || !ExprHasProperty(pTerm->pExpr, EP_FromJoin))
457 ){
drh1c8148f2013-05-04 20:25:23 +0000458 if( (pTerm->eOperator & WO_EQUIV)!=0
459 && pScan->nEquiv<ArraySize(pScan->aEquiv)
460 ){
461 int j;
462 pX = sqlite3ExprSkipCollate(pTerm->pExpr->pRight);
463 assert( pX->op==TK_COLUMN );
464 for(j=0; j<pScan->nEquiv; j+=2){
465 if( pScan->aEquiv[j]==pX->iTable
466 && pScan->aEquiv[j+1]==pX->iColumn ){
467 break;
468 }
469 }
470 if( j==pScan->nEquiv ){
471 pScan->aEquiv[j] = pX->iTable;
472 pScan->aEquiv[j+1] = pX->iColumn;
473 pScan->nEquiv += 2;
474 }
475 }
476 if( (pTerm->eOperator & pScan->opMask)!=0 ){
477 /* Verify the affinity and collating sequence match */
478 if( pScan->zCollName && (pTerm->eOperator & WO_ISNULL)==0 ){
479 CollSeq *pColl;
drh70d18342013-06-06 19:16:33 +0000480 Parse *pParse = pWC->pWInfo->pParse;
drh1c8148f2013-05-04 20:25:23 +0000481 pX = pTerm->pExpr;
482 if( !sqlite3IndexAffinityOk(pX, pScan->idxaff) ){
483 continue;
484 }
485 assert(pX->pLeft);
drh70d18342013-06-06 19:16:33 +0000486 pColl = sqlite3BinaryCompareCollSeq(pParse,
drh1c8148f2013-05-04 20:25:23 +0000487 pX->pLeft, pX->pRight);
drh70d18342013-06-06 19:16:33 +0000488 if( pColl==0 ) pColl = pParse->db->pDfltColl;
drh1c8148f2013-05-04 20:25:23 +0000489 if( sqlite3StrICmp(pColl->zName, pScan->zCollName) ){
490 continue;
491 }
492 }
drhe8d0c612015-05-14 01:05:25 +0000493 if( (pTerm->eOperator & (WO_EQ|WO_IS))!=0
drha184fb82013-05-08 04:22:59 +0000494 && (pX = pTerm->pExpr->pRight)->op==TK_COLUMN
495 && pX->iTable==pScan->aEquiv[0]
496 && pX->iColumn==pScan->aEquiv[1]
497 ){
drhe8d0c612015-05-14 01:05:25 +0000498 testcase( pTerm->eOperator & WO_IS );
drha184fb82013-05-08 04:22:59 +0000499 continue;
500 }
drh43b85ef2013-06-10 12:34:45 +0000501 pScan->k = k+1;
drh1c8148f2013-05-04 20:25:23 +0000502 return pTerm;
503 }
504 }
505 }
drhad01d892013-06-19 13:59:49 +0000506 pScan->pWC = pScan->pWC->pOuter;
drh43b85ef2013-06-10 12:34:45 +0000507 k = 0;
drh1c8148f2013-05-04 20:25:23 +0000508 }
509 pScan->pWC = pScan->pOrigWC;
drh43b85ef2013-06-10 12:34:45 +0000510 k = 0;
drh1c8148f2013-05-04 20:25:23 +0000511 pScan->iEquiv += 2;
512 }
drh1c8148f2013-05-04 20:25:23 +0000513 return 0;
514}
515
516/*
517** Initialize a WHERE clause scanner object. Return a pointer to the
518** first match. Return NULL if there are no matches.
519**
520** The scanner will be searching the WHERE clause pWC. It will look
521** for terms of the form "X <op> <expr>" where X is column iColumn of table
522** iCur. The <op> must be one of the operators described by opMask.
523**
drh3b48e8c2013-06-12 20:18:16 +0000524** If the search is for X and the WHERE clause contains terms of the
525** form X=Y then this routine might also return terms of the form
526** "Y <op> <expr>". The number of levels of transitivity is limited,
527** but is enough to handle most commonly occurring SQL statements.
528**
drh1c8148f2013-05-04 20:25:23 +0000529** If X is not the INTEGER PRIMARY KEY then X must be compatible with
530** index pIdx.
531*/
danb2cfc142013-07-05 11:10:54 +0000532static WhereTerm *whereScanInit(
drh1c8148f2013-05-04 20:25:23 +0000533 WhereScan *pScan, /* The WhereScan object being initialized */
534 WhereClause *pWC, /* The WHERE clause to be scanned */
535 int iCur, /* Cursor to scan for */
536 int iColumn, /* Column to scan for */
537 u32 opMask, /* Operator(s) to scan for */
538 Index *pIdx /* Must be compatible with this index */
539){
540 int j;
541
drhe9d935a2013-06-05 16:19:59 +0000542 /* memset(pScan, 0, sizeof(*pScan)); */
drh1c8148f2013-05-04 20:25:23 +0000543 pScan->pOrigWC = pWC;
544 pScan->pWC = pWC;
545 if( pIdx && iColumn>=0 ){
546 pScan->idxaff = pIdx->pTable->aCol[iColumn].affinity;
547 for(j=0; pIdx->aiColumn[j]!=iColumn; j++){
dan39129ce2014-06-30 15:23:57 +0000548 if( NEVER(j>pIdx->nColumn) ) return 0;
drh1c8148f2013-05-04 20:25:23 +0000549 }
550 pScan->zCollName = pIdx->azColl[j];
drhe9d935a2013-06-05 16:19:59 +0000551 }else{
552 pScan->idxaff = 0;
553 pScan->zCollName = 0;
drh1c8148f2013-05-04 20:25:23 +0000554 }
555 pScan->opMask = opMask;
drhe9d935a2013-06-05 16:19:59 +0000556 pScan->k = 0;
drh1c8148f2013-05-04 20:25:23 +0000557 pScan->aEquiv[0] = iCur;
558 pScan->aEquiv[1] = iColumn;
559 pScan->nEquiv = 2;
560 pScan->iEquiv = 2;
561 return whereScanNext(pScan);
562}
563
564/*
drhfe05af82005-07-21 03:14:59 +0000565** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
566** where X is a reference to the iColumn of table iCur and <op> is one of
567** the WO_xx operator codes specified by the op parameter.
568** Return a pointer to the term. Return 0 if not found.
drh58eb1c02013-01-17 00:08:42 +0000569**
570** The term returned might by Y=<expr> if there is another constraint in
571** the WHERE clause that specifies that X=Y. Any such constraints will be
572** identified by the WO_EQUIV bit in the pTerm->eOperator field. The
573** aEquiv[] array holds X and all its equivalents, with each SQL variable
574** taking up two slots in aEquiv[]. The first slot is for the cursor number
575** and the second is for the column number. There are 22 slots in aEquiv[]
576** so that means we can look for X plus up to 10 other equivalent values.
577** Hence a search for X will return <expr> if X=A1 and A1=A2 and A2=A3
578** and ... and A9=A10 and A10=<expr>.
579**
580** If there are multiple terms in the WHERE clause of the form "X <op> <expr>"
581** then try for the one with no dependencies on <expr> - in other words where
582** <expr> is a constant expression of some kind. Only return entries of
583** the form "X <op> Y" where Y is a column in another table if no terms of
drh459f63e2013-03-06 01:55:27 +0000584** the form "X <op> <const-expr>" exist. If no terms with a constant RHS
585** exist, try to return a term that does not use WO_EQUIV.
drhfe05af82005-07-21 03:14:59 +0000586*/
587static WhereTerm *findTerm(
588 WhereClause *pWC, /* The WHERE clause to be searched */
589 int iCur, /* Cursor number of LHS */
590 int iColumn, /* Column number of LHS */
591 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000592 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000593 Index *pIdx /* Must be compatible with this index, if not NULL */
594){
drh1c8148f2013-05-04 20:25:23 +0000595 WhereTerm *pResult = 0;
596 WhereTerm *p;
597 WhereScan scan;
drh7a5bcc02013-01-16 17:08:58 +0000598
drh1c8148f2013-05-04 20:25:23 +0000599 p = whereScanInit(&scan, pWC, iCur, iColumn, op, pIdx);
drhe8d0c612015-05-14 01:05:25 +0000600 op &= WO_EQ|WO_IS;
drh1c8148f2013-05-04 20:25:23 +0000601 while( p ){
602 if( (p->prereqRight & notReady)==0 ){
drhe8d0c612015-05-14 01:05:25 +0000603 if( p->prereqRight==0 && (p->eOperator&op)!=0 ){
604 testcase( p->eOperator & WO_IS );
drh1c8148f2013-05-04 20:25:23 +0000605 return p;
drhfe05af82005-07-21 03:14:59 +0000606 }
drh1c8148f2013-05-04 20:25:23 +0000607 if( pResult==0 ) pResult = p;
drhfe05af82005-07-21 03:14:59 +0000608 }
drh1c8148f2013-05-04 20:25:23 +0000609 p = whereScanNext(&scan);
drhfe05af82005-07-21 03:14:59 +0000610 }
drh7a5bcc02013-01-16 17:08:58 +0000611 return pResult;
drhfe05af82005-07-21 03:14:59 +0000612}
613
drh6c30be82005-07-29 15:10:17 +0000614/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000615static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000616
617/*
618** Call exprAnalyze on all terms in a WHERE clause.
drh6c30be82005-07-29 15:10:17 +0000619*/
620static void exprAnalyzeAll(
621 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000622 WhereClause *pWC /* the WHERE clause to be analyzed */
623){
drh6c30be82005-07-29 15:10:17 +0000624 int i;
drh9eb20282005-08-24 03:52:18 +0000625 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000626 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000627 }
628}
629
drhd2687b72005-08-12 22:56:09 +0000630#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
631/*
632** Check to see if the given expression is a LIKE or GLOB operator that
633** can be optimized using inequality constraints. Return TRUE if it is
634** so and false if not.
635**
636** In order for the operator to be optimizible, the RHS must be a string
drhf07cf6e2015-03-06 16:45:16 +0000637** literal that does not begin with a wildcard. The LHS must be a column
638** that may only be NULL, a string, or a BLOB, never a number. (This means
drhe655a0e2015-05-16 18:31:44 +0000639** that virtual tables cannot participate in the LIKE optimization.) The
drhf07cf6e2015-03-06 16:45:16 +0000640** collating sequence for the column on the LHS must be appropriate for
641** the operator.
drhd2687b72005-08-12 22:56:09 +0000642*/
643static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000644 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000645 Expr *pExpr, /* Test this expression */
dan937d0de2009-10-15 18:35:38 +0000646 Expr **ppPrefix, /* Pointer to TK_STRING expression with pattern prefix */
drh9f504ea2008-02-23 21:55:39 +0000647 int *pisComplete, /* True if the only wildcard is % in the last character */
648 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000649){
dan937d0de2009-10-15 18:35:38 +0000650 const char *z = 0; /* String on RHS of LIKE operator */
drh5bd98ae2009-01-07 18:24:03 +0000651 Expr *pRight, *pLeft; /* Right and left size of LIKE operator */
652 ExprList *pList; /* List of operands to the LIKE operator */
653 int c; /* One character in z[] */
654 int cnt; /* Number of non-wildcard prefix characters */
655 char wc[3]; /* Wildcard characters */
drh5bd98ae2009-01-07 18:24:03 +0000656 sqlite3 *db = pParse->db; /* Database connection */
dan937d0de2009-10-15 18:35:38 +0000657 sqlite3_value *pVal = 0;
658 int op; /* Opcode of pRight */
drhd64fe2f2005-08-28 17:00:23 +0000659
drh9f504ea2008-02-23 21:55:39 +0000660 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000661 return 0;
662 }
drh9f504ea2008-02-23 21:55:39 +0000663#ifdef SQLITE_EBCDIC
664 if( *pnoCase ) return 0;
665#endif
danielk19776ab3a2e2009-02-19 14:39:25 +0000666 pList = pExpr->x.pList;
drh55ef4d92005-08-14 01:20:37 +0000667 pLeft = pList->a[1].pExpr;
danc68939e2012-03-29 14:29:07 +0000668 if( pLeft->op!=TK_COLUMN
669 || sqlite3ExprAffinity(pLeft)!=SQLITE_AFF_TEXT
drhf07cf6e2015-03-06 16:45:16 +0000670 || IsVirtual(pLeft->pTab) /* Value might be numeric */
danc68939e2012-03-29 14:29:07 +0000671 ){
drhd91ca492009-10-22 20:50:36 +0000672 /* IMP: R-02065-49465 The left-hand side of the LIKE or GLOB operator must
673 ** be the name of an indexed column with TEXT affinity. */
drhd2687b72005-08-12 22:56:09 +0000674 return 0;
675 }
drhd91ca492009-10-22 20:50:36 +0000676 assert( pLeft->iColumn!=(-1) ); /* Because IPK never has AFF_TEXT */
dan937d0de2009-10-15 18:35:38 +0000677
drh6ade4532014-01-16 15:31:41 +0000678 pRight = sqlite3ExprSkipCollate(pList->a[0].pExpr);
dan937d0de2009-10-15 18:35:38 +0000679 op = pRight->op;
dan937d0de2009-10-15 18:35:38 +0000680 if( op==TK_VARIABLE ){
681 Vdbe *pReprepare = pParse->pReprepare;
drha7044002010-09-14 18:22:59 +0000682 int iCol = pRight->iColumn;
drh05883a32015-06-02 15:32:08 +0000683 pVal = sqlite3VdbeGetBoundValue(pReprepare, iCol, SQLITE_AFF_BLOB);
dan937d0de2009-10-15 18:35:38 +0000684 if( pVal && sqlite3_value_type(pVal)==SQLITE_TEXT ){
685 z = (char *)sqlite3_value_text(pVal);
686 }
drhf9b22ca2011-10-21 16:47:31 +0000687 sqlite3VdbeSetVarmask(pParse->pVdbe, iCol);
dan937d0de2009-10-15 18:35:38 +0000688 assert( pRight->op==TK_VARIABLE || pRight->op==TK_REGISTER );
689 }else if( op==TK_STRING ){
690 z = pRight->u.zToken;
691 }
692 if( z ){
shane85095702009-06-15 16:27:08 +0000693 cnt = 0;
drhb7916a72009-05-27 10:31:29 +0000694 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){
drh24fb6272009-05-01 21:13:36 +0000695 cnt++;
696 }
drh93ee23c2010-07-22 12:33:57 +0000697 if( cnt!=0 && 255!=(u8)z[cnt-1] ){
dan937d0de2009-10-15 18:35:38 +0000698 Expr *pPrefix;
drh93ee23c2010-07-22 12:33:57 +0000699 *pisComplete = c==wc[0] && z[cnt+1]==0;
dan937d0de2009-10-15 18:35:38 +0000700 pPrefix = sqlite3Expr(db, TK_STRING, z);
701 if( pPrefix ) pPrefix->u.zToken[cnt] = 0;
702 *ppPrefix = pPrefix;
703 if( op==TK_VARIABLE ){
704 Vdbe *v = pParse->pVdbe;
drhf9b22ca2011-10-21 16:47:31 +0000705 sqlite3VdbeSetVarmask(v, pRight->iColumn);
dan937d0de2009-10-15 18:35:38 +0000706 if( *pisComplete && pRight->u.zToken[1] ){
707 /* If the rhs of the LIKE expression is a variable, and the current
708 ** value of the variable means there is no need to invoke the LIKE
709 ** function, then no OP_Variable will be added to the program.
710 ** This causes problems for the sqlite3_bind_parameter_name()
peter.d.reid60ec9142014-09-06 16:39:46 +0000711 ** API. To work around them, add a dummy OP_Variable here.
drhbec451f2009-10-17 13:13:02 +0000712 */
713 int r1 = sqlite3GetTempReg(pParse);
714 sqlite3ExprCodeTarget(pParse, pRight, r1);
dan937d0de2009-10-15 18:35:38 +0000715 sqlite3VdbeChangeP3(v, sqlite3VdbeCurrentAddr(v)-1, 0);
drhbec451f2009-10-17 13:13:02 +0000716 sqlite3ReleaseTempReg(pParse, r1);
dan937d0de2009-10-15 18:35:38 +0000717 }
718 }
719 }else{
720 z = 0;
shane85095702009-06-15 16:27:08 +0000721 }
drhf998b732007-11-26 13:36:00 +0000722 }
dan937d0de2009-10-15 18:35:38 +0000723
724 sqlite3ValueFree(pVal);
725 return (z!=0);
drhd2687b72005-08-12 22:56:09 +0000726}
727#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
728
drhedb193b2006-06-27 13:20:21 +0000729
730#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000731/*
drh7f375902006-06-13 17:38:59 +0000732** Check to see if the given expression is of the form
733**
734** column MATCH expr
735**
736** If it is then return TRUE. If not, return FALSE.
737*/
738static int isMatchOfColumn(
739 Expr *pExpr /* Test this expression */
740){
741 ExprList *pList;
742
743 if( pExpr->op!=TK_FUNCTION ){
744 return 0;
745 }
drh33e619f2009-05-28 01:00:55 +0000746 if( sqlite3StrICmp(pExpr->u.zToken,"match")!=0 ){
drh7f375902006-06-13 17:38:59 +0000747 return 0;
748 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000749 pList = pExpr->x.pList;
drh7f375902006-06-13 17:38:59 +0000750 if( pList->nExpr!=2 ){
751 return 0;
752 }
753 if( pList->a[1].pExpr->op != TK_COLUMN ){
754 return 0;
755 }
756 return 1;
757}
drhedb193b2006-06-27 13:20:21 +0000758#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000759
760/*
drh54a167d2005-11-26 14:08:07 +0000761** If the pBase expression originated in the ON or USING clause of
762** a join, then transfer the appropriate markings over to derived.
763*/
764static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
drhd41d39f2013-08-28 16:27:01 +0000765 if( pDerived ){
766 pDerived->flags |= pBase->flags & EP_FromJoin;
767 pDerived->iRightJoinTable = pBase->iRightJoinTable;
768 }
drh54a167d2005-11-26 14:08:07 +0000769}
770
drh9769efc2014-10-24 14:32:21 +0000771/*
772** Mark term iChild as being a child of term iParent
773*/
774static void markTermAsChild(WhereClause *pWC, int iChild, int iParent){
775 pWC->a[iChild].iParent = iParent;
776 pWC->a[iChild].truthProb = pWC->a[iParent].truthProb;
777 pWC->a[iParent].nChild++;
778}
779
drh84266362015-03-16 12:13:31 +0000780/*
781** Return the N-th AND-connected subterm of pTerm. Or if pTerm is not
782** a conjunction, then return just pTerm when N==0. If N is exceeds
783** the number of available subterms, return NULL.
784*/
785static WhereTerm *whereNthSubterm(WhereTerm *pTerm, int N){
786 if( pTerm->eOperator!=WO_AND ){
787 return N==0 ? pTerm : 0;
788 }
789 if( N<pTerm->u.pAndInfo->wc.nTerm ){
790 return &pTerm->u.pAndInfo->wc.a[N];
791 }
792 return 0;
793}
794
795/*
796** Subterms pOne and pTwo are contained within WHERE clause pWC. The
797** two subterms are in disjunction - they are OR-ed together.
798**
799** If these two terms are both of the form: "A op B" with the same
800** A and B values but different operators and if the operators are
801** compatible (if one is = and the other is <, for example) then
drhc03acf22015-03-16 13:12:34 +0000802** add a new virtual AND term to pWC that is the combination of the
drh84266362015-03-16 12:13:31 +0000803** two.
804**
805** Some examples:
806**
807** x<y OR x=y --> x<=y
808** x=y OR x=y --> x=y
809** x<=y OR x<y --> x<=y
810**
811** The following is NOT generated:
812**
813** x<y OR x>y --> x!=y
814*/
815static void whereCombineDisjuncts(
816 SrcList *pSrc, /* the FROM clause */
817 WhereClause *pWC, /* The complete WHERE clause */
818 WhereTerm *pOne, /* First disjunct */
819 WhereTerm *pTwo /* Second disjunct */
820){
821 u16 eOp = pOne->eOperator | pTwo->eOperator;
822 sqlite3 *db; /* Database connection (for malloc) */
823 Expr *pNew; /* New virtual expression */
824 int op; /* Operator for the combined expression */
825 int idxNew; /* Index in pWC of the next virtual term */
826
827 if( (pOne->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE))==0 ) return;
828 if( (pTwo->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE))==0 ) return;
829 if( (eOp & (WO_EQ|WO_LT|WO_LE))!=eOp
830 && (eOp & (WO_EQ|WO_GT|WO_GE))!=eOp ) return;
831 assert( pOne->pExpr->pLeft!=0 && pOne->pExpr->pRight!=0 );
832 assert( pTwo->pExpr->pLeft!=0 && pTwo->pExpr->pRight!=0 );
833 if( sqlite3ExprCompare(pOne->pExpr->pLeft, pTwo->pExpr->pLeft, -1) ) return;
834 if( sqlite3ExprCompare(pOne->pExpr->pRight, pTwo->pExpr->pRight, -1) )return;
835 /* If we reach this point, it means the two subterms can be combined */
836 if( (eOp & (eOp-1))!=0 ){
837 if( eOp & (WO_LT|WO_LE) ){
838 eOp = WO_LE;
839 }else{
840 assert( eOp & (WO_GT|WO_GE) );
841 eOp = WO_GE;
842 }
843 }
844 db = pWC->pWInfo->pParse->db;
845 pNew = sqlite3ExprDup(db, pOne->pExpr, 0);
846 if( pNew==0 ) return;
847 for(op=TK_EQ; eOp!=(WO_EQ<<(op-TK_EQ)); op++){ assert( op<TK_GE ); }
848 pNew->op = op;
849 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
850 exprAnalyze(pSrc, pWC, idxNew);
851}
852
drh3e355802007-02-23 23:13:33 +0000853#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
854/*
drh1a58fe02008-12-20 02:06:13 +0000855** Analyze a term that consists of two or more OR-connected
856** subterms. So in:
drh3e355802007-02-23 23:13:33 +0000857**
drh1a58fe02008-12-20 02:06:13 +0000858** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
859** ^^^^^^^^^^^^^^^^^^^^
drh3e355802007-02-23 23:13:33 +0000860**
drh1a58fe02008-12-20 02:06:13 +0000861** This routine analyzes terms such as the middle term in the above example.
862** A WhereOrTerm object is computed and attached to the term under
863** analysis, regardless of the outcome of the analysis. Hence:
drh3e355802007-02-23 23:13:33 +0000864**
drh1a58fe02008-12-20 02:06:13 +0000865** WhereTerm.wtFlags |= TERM_ORINFO
866** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
drh3e355802007-02-23 23:13:33 +0000867**
drh1a58fe02008-12-20 02:06:13 +0000868** The term being analyzed must have two or more of OR-connected subterms.
danielk1977fdc40192008-12-29 18:33:32 +0000869** A single subterm might be a set of AND-connected sub-subterms.
drh1a58fe02008-12-20 02:06:13 +0000870** Examples of terms under analysis:
drh3e355802007-02-23 23:13:33 +0000871**
drh1a58fe02008-12-20 02:06:13 +0000872** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
873** (B) x=expr1 OR expr2=x OR x=expr3
874** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
875** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
876** (E) (p.a=1 AND q.b=2 AND r.c=3) OR (p.x=4 AND q.y=5 AND r.z=6)
drh84266362015-03-16 12:13:31 +0000877** (F) x>A OR (x=A AND y>=B)
drh3e355802007-02-23 23:13:33 +0000878**
drh1a58fe02008-12-20 02:06:13 +0000879** CASE 1:
880**
drhc3e552f2013-02-08 16:04:19 +0000881** If all subterms are of the form T.C=expr for some single column of C and
drh1a58fe02008-12-20 02:06:13 +0000882** a single table T (as shown in example B above) then create a new virtual
883** term that is an equivalent IN expression. In other words, if the term
884** being analyzed is:
885**
886** x = expr1 OR expr2 = x OR x = expr3
887**
888** then create a new virtual term like this:
889**
890** x IN (expr1,expr2,expr3)
891**
892** CASE 2:
893**
drhc03acf22015-03-16 13:12:34 +0000894** If there are exactly two disjuncts one side has x>A and the other side
895** has x=A (for the same x and A) then add a new virtual conjunct term to the
896** WHERE clause of the form "x>=A". Example:
897**
898** x>A OR (x=A AND y>B) adds: x>=A
899**
900** The added conjunct can sometimes be helpful in query planning.
drh84266362015-03-16 12:13:31 +0000901**
902** CASE 3:
903**
drh1a58fe02008-12-20 02:06:13 +0000904** If all subterms are indexable by a single table T, then set
905**
906** WhereTerm.eOperator = WO_OR
907** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
908**
909** A subterm is "indexable" if it is of the form
910** "T.C <op> <expr>" where C is any column of table T and
911** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
912** A subterm is also indexable if it is an AND of two or more
913** subsubterms at least one of which is indexable. Indexable AND
914** subterms have their eOperator set to WO_AND and they have
915** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
916**
917** From another point of view, "indexable" means that the subterm could
918** potentially be used with an index if an appropriate index exists.
919** This analysis does not consider whether or not the index exists; that
drh4a6fc352013-08-07 01:18:38 +0000920** is decided elsewhere. This analysis only looks at whether subterms
921** appropriate for indexing exist.
drh1a58fe02008-12-20 02:06:13 +0000922**
drh4a6fc352013-08-07 01:18:38 +0000923** All examples A through E above satisfy case 2. But if a term
peter.d.reid60ec9142014-09-06 16:39:46 +0000924** also satisfies case 1 (such as B) we know that the optimizer will
drh1a58fe02008-12-20 02:06:13 +0000925** always prefer case 1, so in that case we pretend that case 2 is not
926** satisfied.
927**
928** It might be the case that multiple tables are indexable. For example,
929** (E) above is indexable on tables P, Q, and R.
930**
931** Terms that satisfy case 2 are candidates for lookup by using
932** separate indices to find rowids for each subterm and composing
933** the union of all rowids using a RowSet object. This is similar
934** to "bitmap indices" in other database engines.
935**
936** OTHERWISE:
937**
938** If neither case 1 nor case 2 apply, then leave the eOperator set to
939** zero. This term is not useful for search.
drh3e355802007-02-23 23:13:33 +0000940*/
drh1a58fe02008-12-20 02:06:13 +0000941static void exprAnalyzeOrTerm(
942 SrcList *pSrc, /* the FROM clause */
943 WhereClause *pWC, /* the complete WHERE clause */
944 int idxTerm /* Index of the OR-term to be analyzed */
945){
drh70d18342013-06-06 19:16:33 +0000946 WhereInfo *pWInfo = pWC->pWInfo; /* WHERE clause processing context */
947 Parse *pParse = pWInfo->pParse; /* Parser context */
drh1a58fe02008-12-20 02:06:13 +0000948 sqlite3 *db = pParse->db; /* Database connection */
949 WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
950 Expr *pExpr = pTerm->pExpr; /* The expression of the term */
drh1a58fe02008-12-20 02:06:13 +0000951 int i; /* Loop counters */
952 WhereClause *pOrWc; /* Breakup of pTerm into subterms */
953 WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
954 WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
955 Bitmask chngToIN; /* Tables that might satisfy case 1 */
956 Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
drh3e355802007-02-23 23:13:33 +0000957
drh1a58fe02008-12-20 02:06:13 +0000958 /*
959 ** Break the OR clause into its separate subterms. The subterms are
960 ** stored in a WhereClause structure containing within the WhereOrInfo
961 ** object that is attached to the original OR clause term.
962 */
963 assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
964 assert( pExpr->op==TK_OR );
drh954701a2008-12-29 23:45:07 +0000965 pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
drh1a58fe02008-12-20 02:06:13 +0000966 if( pOrInfo==0 ) return;
967 pTerm->wtFlags |= TERM_ORINFO;
968 pOrWc = &pOrInfo->wc;
drh70d18342013-06-06 19:16:33 +0000969 whereClauseInit(pOrWc, pWInfo);
drh1a58fe02008-12-20 02:06:13 +0000970 whereSplit(pOrWc, pExpr, TK_OR);
971 exprAnalyzeAll(pSrc, pOrWc);
972 if( db->mallocFailed ) return;
973 assert( pOrWc->nTerm>=2 );
974
975 /*
976 ** Compute the set of tables that might satisfy cases 1 or 2.
977 */
danielk1977e672c8e2009-05-22 15:43:26 +0000978 indexable = ~(Bitmask)0;
drhc3e552f2013-02-08 16:04:19 +0000979 chngToIN = ~(Bitmask)0;
drh1a58fe02008-12-20 02:06:13 +0000980 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
981 if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
drh29435252008-12-28 18:35:08 +0000982 WhereAndInfo *pAndInfo;
drh29435252008-12-28 18:35:08 +0000983 assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
drh1a58fe02008-12-20 02:06:13 +0000984 chngToIN = 0;
drh29435252008-12-28 18:35:08 +0000985 pAndInfo = sqlite3DbMallocRaw(db, sizeof(*pAndInfo));
986 if( pAndInfo ){
987 WhereClause *pAndWC;
988 WhereTerm *pAndTerm;
989 int j;
990 Bitmask b = 0;
991 pOrTerm->u.pAndInfo = pAndInfo;
992 pOrTerm->wtFlags |= TERM_ANDINFO;
993 pOrTerm->eOperator = WO_AND;
994 pAndWC = &pAndInfo->wc;
drh70d18342013-06-06 19:16:33 +0000995 whereClauseInit(pAndWC, pWC->pWInfo);
drh29435252008-12-28 18:35:08 +0000996 whereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
997 exprAnalyzeAll(pSrc, pAndWC);
drh8871ef52011-10-07 13:33:10 +0000998 pAndWC->pOuter = pWC;
drh7c2fbde2009-01-07 20:58:57 +0000999 testcase( db->mallocFailed );
drh96c7a7d2009-01-10 15:34:12 +00001000 if( !db->mallocFailed ){
1001 for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
1002 assert( pAndTerm->pExpr );
1003 if( allowedOp(pAndTerm->pExpr->op) ){
drh70d18342013-06-06 19:16:33 +00001004 b |= getMask(&pWInfo->sMaskSet, pAndTerm->leftCursor);
drh96c7a7d2009-01-10 15:34:12 +00001005 }
drh29435252008-12-28 18:35:08 +00001006 }
1007 }
1008 indexable &= b;
1009 }
drh1a58fe02008-12-20 02:06:13 +00001010 }else if( pOrTerm->wtFlags & TERM_COPIED ){
1011 /* Skip this term for now. We revisit it when we process the
1012 ** corresponding TERM_VIRTUAL term */
1013 }else{
1014 Bitmask b;
drh70d18342013-06-06 19:16:33 +00001015 b = getMask(&pWInfo->sMaskSet, pOrTerm->leftCursor);
drh1a58fe02008-12-20 02:06:13 +00001016 if( pOrTerm->wtFlags & TERM_VIRTUAL ){
1017 WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
drh70d18342013-06-06 19:16:33 +00001018 b |= getMask(&pWInfo->sMaskSet, pOther->leftCursor);
drh1a58fe02008-12-20 02:06:13 +00001019 }
1020 indexable &= b;
drh7a5bcc02013-01-16 17:08:58 +00001021 if( (pOrTerm->eOperator & WO_EQ)==0 ){
drh1a58fe02008-12-20 02:06:13 +00001022 chngToIN = 0;
1023 }else{
1024 chngToIN &= b;
1025 }
1026 }
drh3e355802007-02-23 23:13:33 +00001027 }
drh1a58fe02008-12-20 02:06:13 +00001028
1029 /*
drh84266362015-03-16 12:13:31 +00001030 ** Record the set of tables that satisfy case 3. The set might be
drh111a6a72008-12-21 03:51:16 +00001031 ** empty.
drh1a58fe02008-12-20 02:06:13 +00001032 */
1033 pOrInfo->indexable = indexable;
drh111a6a72008-12-21 03:51:16 +00001034 pTerm->eOperator = indexable==0 ? 0 : WO_OR;
drh1a58fe02008-12-20 02:06:13 +00001035
drh84266362015-03-16 12:13:31 +00001036 /* For a two-way OR, attempt to implementation case 2.
1037 */
1038 if( indexable && pOrWc->nTerm==2 ){
1039 int iOne = 0;
1040 WhereTerm *pOne;
1041 while( (pOne = whereNthSubterm(&pOrWc->a[0],iOne++))!=0 ){
1042 int iTwo = 0;
1043 WhereTerm *pTwo;
1044 while( (pTwo = whereNthSubterm(&pOrWc->a[1],iTwo++))!=0 ){
1045 whereCombineDisjuncts(pSrc, pWC, pOne, pTwo);
1046 }
1047 }
1048 }
1049
drh1a58fe02008-12-20 02:06:13 +00001050 /*
1051 ** chngToIN holds a set of tables that *might* satisfy case 1. But
1052 ** we have to do some additional checking to see if case 1 really
1053 ** is satisfied.
drh4e8be3b2009-06-08 17:11:08 +00001054 **
1055 ** chngToIN will hold either 0, 1, or 2 bits. The 0-bit case means
1056 ** that there is no possibility of transforming the OR clause into an
1057 ** IN operator because one or more terms in the OR clause contain
1058 ** something other than == on a column in the single table. The 1-bit
1059 ** case means that every term of the OR clause is of the form
1060 ** "table.column=expr" for some single table. The one bit that is set
1061 ** will correspond to the common table. We still need to check to make
1062 ** sure the same column is used on all terms. The 2-bit case is when
1063 ** the all terms are of the form "table1.column=table2.column". It
1064 ** might be possible to form an IN operator with either table1.column
1065 ** or table2.column as the LHS if either is common to every term of
1066 ** the OR clause.
1067 **
1068 ** Note that terms of the form "table.column1=table.column2" (the
1069 ** same table on both sizes of the ==) cannot be optimized.
drh1a58fe02008-12-20 02:06:13 +00001070 */
1071 if( chngToIN ){
1072 int okToChngToIN = 0; /* True if the conversion to IN is valid */
1073 int iColumn = -1; /* Column index on lhs of IN operator */
shane63207ab2009-02-04 01:49:30 +00001074 int iCursor = -1; /* Table cursor common to all terms */
drh1a58fe02008-12-20 02:06:13 +00001075 int j = 0; /* Loop counter */
1076
1077 /* Search for a table and column that appears on one side or the
1078 ** other of the == operator in every subterm. That table and column
1079 ** will be recorded in iCursor and iColumn. There might not be any
1080 ** such table and column. Set okToChngToIN if an appropriate table
1081 ** and column is found but leave okToChngToIN false if not found.
1082 */
1083 for(j=0; j<2 && !okToChngToIN; j++){
1084 pOrTerm = pOrWc->a;
1085 for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001086 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001087 pOrTerm->wtFlags &= ~TERM_OR_OK;
drh4e8be3b2009-06-08 17:11:08 +00001088 if( pOrTerm->leftCursor==iCursor ){
1089 /* This is the 2-bit case and we are on the second iteration and
1090 ** current term is from the first iteration. So skip this term. */
1091 assert( j==1 );
1092 continue;
1093 }
drh70d18342013-06-06 19:16:33 +00001094 if( (chngToIN & getMask(&pWInfo->sMaskSet, pOrTerm->leftCursor))==0 ){
drh4e8be3b2009-06-08 17:11:08 +00001095 /* This term must be of the form t1.a==t2.b where t2 is in the
peter.d.reid60ec9142014-09-06 16:39:46 +00001096 ** chngToIN set but t1 is not. This term will be either preceded
drh4e8be3b2009-06-08 17:11:08 +00001097 ** or follwed by an inverted copy (t2.b==t1.a). Skip this term
1098 ** and use its inversion. */
1099 testcase( pOrTerm->wtFlags & TERM_COPIED );
1100 testcase( pOrTerm->wtFlags & TERM_VIRTUAL );
1101 assert( pOrTerm->wtFlags & (TERM_COPIED|TERM_VIRTUAL) );
1102 continue;
1103 }
drh1a58fe02008-12-20 02:06:13 +00001104 iColumn = pOrTerm->u.leftColumn;
1105 iCursor = pOrTerm->leftCursor;
1106 break;
1107 }
1108 if( i<0 ){
drh4e8be3b2009-06-08 17:11:08 +00001109 /* No candidate table+column was found. This can only occur
1110 ** on the second iteration */
drh1a58fe02008-12-20 02:06:13 +00001111 assert( j==1 );
drh7a5bcc02013-01-16 17:08:58 +00001112 assert( IsPowerOfTwo(chngToIN) );
drh70d18342013-06-06 19:16:33 +00001113 assert( chngToIN==getMask(&pWInfo->sMaskSet, iCursor) );
drh1a58fe02008-12-20 02:06:13 +00001114 break;
1115 }
drh4e8be3b2009-06-08 17:11:08 +00001116 testcase( j==1 );
1117
1118 /* We have found a candidate table and column. Check to see if that
1119 ** table and column is common to every term in the OR clause */
drh1a58fe02008-12-20 02:06:13 +00001120 okToChngToIN = 1;
1121 for(; i>=0 && okToChngToIN; i--, pOrTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001122 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001123 if( pOrTerm->leftCursor!=iCursor ){
1124 pOrTerm->wtFlags &= ~TERM_OR_OK;
1125 }else if( pOrTerm->u.leftColumn!=iColumn ){
1126 okToChngToIN = 0;
1127 }else{
1128 int affLeft, affRight;
1129 /* If the right-hand side is also a column, then the affinities
1130 ** of both right and left sides must be such that no type
1131 ** conversions are required on the right. (Ticket #2249)
1132 */
1133 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
1134 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
1135 if( affRight!=0 && affRight!=affLeft ){
1136 okToChngToIN = 0;
1137 }else{
1138 pOrTerm->wtFlags |= TERM_OR_OK;
1139 }
1140 }
1141 }
1142 }
1143
1144 /* At this point, okToChngToIN is true if original pTerm satisfies
1145 ** case 1. In that case, construct a new virtual term that is
1146 ** pTerm converted into an IN operator.
1147 */
1148 if( okToChngToIN ){
1149 Expr *pDup; /* A transient duplicate expression */
1150 ExprList *pList = 0; /* The RHS of the IN operator */
1151 Expr *pLeft = 0; /* The LHS of the IN operator */
1152 Expr *pNew; /* The complete IN operator */
1153
1154 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
1155 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
drh7a5bcc02013-01-16 17:08:58 +00001156 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001157 assert( pOrTerm->leftCursor==iCursor );
1158 assert( pOrTerm->u.leftColumn==iColumn );
danielk19776ab3a2e2009-02-19 14:39:25 +00001159 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight, 0);
drh70d18342013-06-06 19:16:33 +00001160 pList = sqlite3ExprListAppend(pWInfo->pParse, pList, pDup);
drh1a58fe02008-12-20 02:06:13 +00001161 pLeft = pOrTerm->pExpr->pLeft;
1162 }
1163 assert( pLeft!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001164 pDup = sqlite3ExprDup(db, pLeft, 0);
drhb7916a72009-05-27 10:31:29 +00001165 pNew = sqlite3PExpr(pParse, TK_IN, pDup, 0, 0);
drh1a58fe02008-12-20 02:06:13 +00001166 if( pNew ){
1167 int idxNew;
1168 transferJoinMarkings(pNew, pExpr);
danielk19776ab3a2e2009-02-19 14:39:25 +00001169 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
1170 pNew->x.pList = pList;
drh1a58fe02008-12-20 02:06:13 +00001171 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
1172 testcase( idxNew==0 );
1173 exprAnalyze(pSrc, pWC, idxNew);
1174 pTerm = &pWC->a[idxTerm];
drh9769efc2014-10-24 14:32:21 +00001175 markTermAsChild(pWC, idxNew, idxTerm);
drh1a58fe02008-12-20 02:06:13 +00001176 }else{
1177 sqlite3ExprListDelete(db, pList);
1178 }
drh84266362015-03-16 12:13:31 +00001179 pTerm->eOperator = WO_NOOP; /* case 1 trumps case 3 */
drh1a58fe02008-12-20 02:06:13 +00001180 }
drh3e355802007-02-23 23:13:33 +00001181 }
drh3e355802007-02-23 23:13:33 +00001182}
1183#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +00001184
drh7a5bcc02013-01-16 17:08:58 +00001185/*
drh58201182015-05-16 20:51:25 +00001186** We already know that pExpr is a binary operator where both operands are
1187** column references. This routine checks to see if pExpr is an equivalence
1188** relation:
1189** 1. The SQLITE_Transitive optimization must be enabled
1190** 2. Must be either an == or an IS operator
drh69c15fe2015-05-18 11:34:52 +00001191** 3. Not originating the ON clause of an OUTER JOIN
drh58201182015-05-16 20:51:25 +00001192** 4. The affinities of A and B must be compatible
drh69c15fe2015-05-18 11:34:52 +00001193** 5a. Both operands use the same collating sequence OR
1194** 5b. The overall collating sequence is BINARY
drh58201182015-05-16 20:51:25 +00001195** If this routine returns TRUE, that means that the RHS can be substituted
1196** for the LHS anyplace else in the WHERE clause where the LHS column occurs.
1197** This is an optimization. No harm comes from returning 0. But if 1 is
1198** returned when it should not be, then incorrect answers might result.
1199*/
drh69c15fe2015-05-18 11:34:52 +00001200static int termIsEquivalence(Parse *pParse, Expr *pExpr){
drh58201182015-05-16 20:51:25 +00001201 char aff1, aff2;
drh69c15fe2015-05-18 11:34:52 +00001202 CollSeq *pColl;
drh58201182015-05-16 20:51:25 +00001203 const char *zColl1, *zColl2;
1204 if( !OptimizationEnabled(pParse->db, SQLITE_Transitive) ) return 0;
1205 if( pExpr->op!=TK_EQ && pExpr->op!=TK_IS ) return 0;
1206 if( ExprHasProperty(pExpr, EP_FromJoin) ) return 0;
1207 aff1 = sqlite3ExprAffinity(pExpr->pLeft);
1208 aff2 = sqlite3ExprAffinity(pExpr->pRight);
1209 if( aff1!=aff2
1210 && (!sqlite3IsNumericAffinity(aff1) || !sqlite3IsNumericAffinity(aff2))
1211 ){
1212 return 0;
1213 }
drh69c15fe2015-05-18 11:34:52 +00001214 pColl = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft, pExpr->pRight);
1215 if( pColl==0 || sqlite3StrICmp(pColl->zName, "BINARY")==0 ) return 1;
1216 pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drhc4d56dd2015-05-18 12:18:37 +00001217 /* Since pLeft and pRight are both a column references, their collating
1218 ** sequence should always be defined. */
1219 zColl1 = ALWAYS(pColl) ? pColl->zName : 0;
drh69c15fe2015-05-18 11:34:52 +00001220 pColl = sqlite3ExprCollSeq(pParse, pExpr->pRight);
drhc4d56dd2015-05-18 12:18:37 +00001221 zColl2 = ALWAYS(pColl) ? pColl->zName : 0;
drh58201182015-05-16 20:51:25 +00001222 return sqlite3StrICmp(zColl1, zColl2)==0;
1223}
1224
1225/*
drh0aa74ed2005-07-16 13:33:20 +00001226** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +00001227** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +00001228** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +00001229** structure.
drh51147ba2005-07-23 22:59:55 +00001230**
1231** If the expression is of the form "<expr> <op> X" it gets commuted
drh1a58fe02008-12-20 02:06:13 +00001232** to the standard form of "X <op> <expr>".
1233**
1234** If the expression is of the form "X <op> Y" where both X and Y are
1235** columns, then the original expression is unchanged and a new virtual
1236** term of the form "Y <op> X" is added to the WHERE clause and
1237** analyzed separately. The original term is marked with TERM_COPIED
1238** and the new term is marked with TERM_DYNAMIC (because it's pExpr
1239** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
1240** is a commuted copy of a prior term.) The original term has nChild=1
1241** and the copy has idxParent set to the index of the original term.
drh75897232000-05-29 14:26:00 +00001242*/
drh0fcef5e2005-07-19 17:38:22 +00001243static void exprAnalyze(
1244 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +00001245 WhereClause *pWC, /* the WHERE clause */
1246 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +00001247){
drh70d18342013-06-06 19:16:33 +00001248 WhereInfo *pWInfo = pWC->pWInfo; /* WHERE clause processing context */
drh1a58fe02008-12-20 02:06:13 +00001249 WhereTerm *pTerm; /* The term to be analyzed */
drh111a6a72008-12-21 03:51:16 +00001250 WhereMaskSet *pMaskSet; /* Set of table index masks */
drh1a58fe02008-12-20 02:06:13 +00001251 Expr *pExpr; /* The expression to be analyzed */
1252 Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
1253 Bitmask prereqAll; /* Prerequesites of pExpr */
drh5e767c52010-02-25 04:15:47 +00001254 Bitmask extraRight = 0; /* Extra dependencies on LEFT JOIN */
drh1d452e12009-11-01 19:26:59 +00001255 Expr *pStr1 = 0; /* RHS of LIKE/GLOB operator */
1256 int isComplete = 0; /* RHS of LIKE/GLOB ends with wildcard */
drha9c18a92015-03-06 20:49:52 +00001257 int noCase = 0; /* uppercase equivalent to lowercase */
drh1a58fe02008-12-20 02:06:13 +00001258 int op; /* Top-level operator. pExpr->op */
drh70d18342013-06-06 19:16:33 +00001259 Parse *pParse = pWInfo->pParse; /* Parsing context */
drh1a58fe02008-12-20 02:06:13 +00001260 sqlite3 *db = pParse->db; /* Database connection */
drh0fcef5e2005-07-19 17:38:22 +00001261
drhf998b732007-11-26 13:36:00 +00001262 if( db->mallocFailed ){
1263 return;
1264 }
1265 pTerm = &pWC->a[idxTerm];
drh70d18342013-06-06 19:16:33 +00001266 pMaskSet = &pWInfo->sMaskSet;
drh7ee751d2012-12-19 15:53:51 +00001267 pExpr = pTerm->pExpr;
1268 assert( pExpr->op!=TK_AS && pExpr->op!=TK_COLLATE );
drh0fcef5e2005-07-19 17:38:22 +00001269 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +00001270 op = pExpr->op;
1271 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +00001272 assert( pExpr->pRight==0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001273 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1274 pTerm->prereqRight = exprSelectTableUsage(pMaskSet, pExpr->x.pSelect);
1275 }else{
1276 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->x.pList);
1277 }
drh50b39962006-10-28 00:28:09 +00001278 }else if( op==TK_ISNULL ){
1279 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +00001280 }else{
1281 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
1282 }
drh22d6a532005-09-19 21:05:48 +00001283 prereqAll = exprTableUsage(pMaskSet, pExpr);
1284 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +00001285 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
1286 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +00001287 extraRight = x-1; /* ON clause terms may not be used with an index
1288 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +00001289 }
1290 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +00001291 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +00001292 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +00001293 pTerm->eOperator = 0;
drh738fc792013-01-17 15:05:17 +00001294 if( allowedOp(op) ){
drh7a66da12012-12-07 20:31:11 +00001295 Expr *pLeft = sqlite3ExprSkipCollate(pExpr->pLeft);
1296 Expr *pRight = sqlite3ExprSkipCollate(pExpr->pRight);
drh738fc792013-01-17 15:05:17 +00001297 u16 opMask = (pTerm->prereqRight & prereqLeft)==0 ? WO_ALL : WO_EQUIV;
drh0fcef5e2005-07-19 17:38:22 +00001298 if( pLeft->op==TK_COLUMN ){
1299 pTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001300 pTerm->u.leftColumn = pLeft->iColumn;
drh738fc792013-01-17 15:05:17 +00001301 pTerm->eOperator = operatorMask(op) & opMask;
drh75897232000-05-29 14:26:00 +00001302 }
drh9be18702015-05-13 19:33:41 +00001303 if( op==TK_IS ) pTerm->wtFlags |= TERM_IS;
drh0fcef5e2005-07-19 17:38:22 +00001304 if( pRight && pRight->op==TK_COLUMN ){
1305 WhereTerm *pNew;
1306 Expr *pDup;
drh7a5bcc02013-01-16 17:08:58 +00001307 u16 eExtraOp = 0; /* Extra bits for pNew->eOperator */
drh0fcef5e2005-07-19 17:38:22 +00001308 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +00001309 int idxNew;
danielk19776ab3a2e2009-02-19 14:39:25 +00001310 pDup = sqlite3ExprDup(db, pExpr, 0);
drh17435752007-08-16 04:30:38 +00001311 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +00001312 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +00001313 return;
1314 }
drh9eb20282005-08-24 03:52:18 +00001315 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
1316 if( idxNew==0 ) return;
1317 pNew = &pWC->a[idxNew];
drh9769efc2014-10-24 14:32:21 +00001318 markTermAsChild(pWC, idxNew, idxTerm);
drhea19cc12015-05-16 19:17:17 +00001319 if( op==TK_IS ) pNew->wtFlags |= TERM_IS;
drh9eb20282005-08-24 03:52:18 +00001320 pTerm = &pWC->a[idxTerm];
drh165be382008-12-05 02:36:33 +00001321 pTerm->wtFlags |= TERM_COPIED;
drhea19cc12015-05-16 19:17:17 +00001322
drh69c15fe2015-05-18 11:34:52 +00001323 if( termIsEquivalence(pParse, pDup) ){
drh58201182015-05-16 20:51:25 +00001324 pTerm->eOperator |= WO_EQUIV;
1325 eExtraOp = WO_EQUIV;
drh7a5bcc02013-01-16 17:08:58 +00001326 }
drh0fcef5e2005-07-19 17:38:22 +00001327 }else{
1328 pDup = pExpr;
1329 pNew = pTerm;
1330 }
drh7d10d5a2008-08-20 16:35:10 +00001331 exprCommute(pParse, pDup);
drhfb76f5a2012-12-08 14:16:47 +00001332 pLeft = sqlite3ExprSkipCollate(pDup->pLeft);
drh0fcef5e2005-07-19 17:38:22 +00001333 pNew->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001334 pNew->u.leftColumn = pLeft->iColumn;
drh5e767c52010-02-25 04:15:47 +00001335 testcase( (prereqLeft | extraRight) != prereqLeft );
1336 pNew->prereqRight = prereqLeft | extraRight;
drh0fcef5e2005-07-19 17:38:22 +00001337 pNew->prereqAll = prereqAll;
drh738fc792013-01-17 15:05:17 +00001338 pNew->eOperator = (operatorMask(pDup->op) + eExtraOp) & opMask;
drh75897232000-05-29 14:26:00 +00001339 }
1340 }
drhed378002005-07-28 23:12:08 +00001341
drhd2687b72005-08-12 22:56:09 +00001342#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +00001343 /* If a term is the BETWEEN operator, create two new virtual terms
drh1a58fe02008-12-20 02:06:13 +00001344 ** that define the range that the BETWEEN implements. For example:
1345 **
1346 ** a BETWEEN b AND c
1347 **
1348 ** is converted into:
1349 **
1350 ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
1351 **
1352 ** The two new terms are added onto the end of the WhereClause object.
1353 ** The new terms are "dynamic" and are children of the original BETWEEN
1354 ** term. That means that if the BETWEEN term is coded, the children are
1355 ** skipped. Or, if the children are satisfied by an index, the original
1356 ** BETWEEN term is skipped.
drhed378002005-07-28 23:12:08 +00001357 */
drh29435252008-12-28 18:35:08 +00001358 else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001359 ExprList *pList = pExpr->x.pList;
drhed378002005-07-28 23:12:08 +00001360 int i;
1361 static const u8 ops[] = {TK_GE, TK_LE};
1362 assert( pList!=0 );
1363 assert( pList->nExpr==2 );
1364 for(i=0; i<2; i++){
1365 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +00001366 int idxNew;
drhb7916a72009-05-27 10:31:29 +00001367 pNewExpr = sqlite3PExpr(pParse, ops[i],
1368 sqlite3ExprDup(db, pExpr->pLeft, 0),
danielk19776ab3a2e2009-02-19 14:39:25 +00001369 sqlite3ExprDup(db, pList->a[i].pExpr, 0), 0);
drhd41d39f2013-08-28 16:27:01 +00001370 transferJoinMarkings(pNewExpr, pExpr);
drh9eb20282005-08-24 03:52:18 +00001371 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001372 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001373 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +00001374 pTerm = &pWC->a[idxTerm];
drh9769efc2014-10-24 14:32:21 +00001375 markTermAsChild(pWC, idxNew, idxTerm);
drhed378002005-07-28 23:12:08 +00001376 }
drhed378002005-07-28 23:12:08 +00001377 }
drhd2687b72005-08-12 22:56:09 +00001378#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +00001379
danielk19771576cd92006-01-14 08:02:28 +00001380#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh1a58fe02008-12-20 02:06:13 +00001381 /* Analyze a term that is composed of two or more subterms connected by
1382 ** an OR operator.
drh6c30be82005-07-29 15:10:17 +00001383 */
1384 else if( pExpr->op==TK_OR ){
drh29435252008-12-28 18:35:08 +00001385 assert( pWC->op==TK_AND );
drh1a58fe02008-12-20 02:06:13 +00001386 exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
danielk1977f51d1bd2009-07-31 06:14:51 +00001387 pTerm = &pWC->a[idxTerm];
drh6c30be82005-07-29 15:10:17 +00001388 }
drhd2687b72005-08-12 22:56:09 +00001389#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1390
1391#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
1392 /* Add constraints to reduce the search space on a LIKE or GLOB
1393 ** operator.
drh9f504ea2008-02-23 21:55:39 +00001394 **
drha9c18a92015-03-06 20:49:52 +00001395 ** A like pattern of the form "x LIKE 'aBc%'" is changed into constraints
drh9f504ea2008-02-23 21:55:39 +00001396 **
drha9c18a92015-03-06 20:49:52 +00001397 ** x>='ABC' AND x<'abd' AND x LIKE 'aBc%'
drh9f504ea2008-02-23 21:55:39 +00001398 **
1399 ** The last character of the prefix "abc" is incremented to form the
drha9c18a92015-03-06 20:49:52 +00001400 ** termination condition "abd". If case is not significant (the default
1401 ** for LIKE) then the lower-bound is made all uppercase and the upper-
1402 ** bound is made all lowercase so that the bounds also work when comparing
1403 ** BLOBs.
drhd2687b72005-08-12 22:56:09 +00001404 */
dan937d0de2009-10-15 18:35:38 +00001405 if( pWC->op==TK_AND
1406 && isLikeOrGlob(pParse, pExpr, &pStr1, &isComplete, &noCase)
1407 ){
drh1d452e12009-11-01 19:26:59 +00001408 Expr *pLeft; /* LHS of LIKE/GLOB operator */
1409 Expr *pStr2; /* Copy of pStr1 - RHS of LIKE/GLOB operator */
1410 Expr *pNewExpr1;
1411 Expr *pNewExpr2;
1412 int idxNew1;
1413 int idxNew2;
dan80103fc2015-03-20 08:43:59 +00001414 const char *zCollSeqName; /* Name of collating sequence */
drh8f1a7ed2015-03-06 19:47:38 +00001415 const u16 wtFlags = TERM_LIKEOPT | TERM_VIRTUAL | TERM_DYNAMIC;
drh9eb20282005-08-24 03:52:18 +00001416
danielk19776ab3a2e2009-02-19 14:39:25 +00001417 pLeft = pExpr->x.pList->a[1].pExpr;
danielk19776ab3a2e2009-02-19 14:39:25 +00001418 pStr2 = sqlite3ExprDup(db, pStr1, 0);
drh8f1a7ed2015-03-06 19:47:38 +00001419
1420 /* Convert the lower bound to upper-case and the upper bound to
1421 ** lower-case (upper-case is less than lower-case in ASCII) so that
1422 ** the range constraints also work for BLOBs
1423 */
1424 if( noCase && !pParse->db->mallocFailed ){
1425 int i;
1426 char c;
drha9c18a92015-03-06 20:49:52 +00001427 pTerm->wtFlags |= TERM_LIKE;
drh8f1a7ed2015-03-06 19:47:38 +00001428 for(i=0; (c = pStr1->u.zToken[i])!=0; i++){
1429 pStr1->u.zToken[i] = sqlite3Toupper(c);
1430 pStr2->u.zToken[i] = sqlite3Tolower(c);
1431 }
1432 }
1433
drhf998b732007-11-26 13:36:00 +00001434 if( !db->mallocFailed ){
drh254993e2009-06-08 19:44:36 +00001435 u8 c, *pC; /* Last character before the first wildcard */
dan937d0de2009-10-15 18:35:38 +00001436 pC = (u8*)&pStr2->u.zToken[sqlite3Strlen30(pStr2->u.zToken)-1];
drh9f504ea2008-02-23 21:55:39 +00001437 c = *pC;
drh02a50b72008-05-26 18:33:40 +00001438 if( noCase ){
drh254993e2009-06-08 19:44:36 +00001439 /* The point is to increment the last character before the first
1440 ** wildcard. But if we increment '@', that will push it into the
1441 ** alphabetic range where case conversions will mess up the
1442 ** inequality. To avoid this, make sure to also run the full
1443 ** LIKE on all candidate expressions by clearing the isComplete flag
1444 */
drh39759742013-08-02 23:40:45 +00001445 if( c=='A'-1 ) isComplete = 0;
drh02a50b72008-05-26 18:33:40 +00001446 c = sqlite3UpperToLower[c];
1447 }
drh9f504ea2008-02-23 21:55:39 +00001448 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +00001449 }
dan80103fc2015-03-20 08:43:59 +00001450 zCollSeqName = noCase ? "NOCASE" : "BINARY";
drhae80dde2012-12-06 21:16:43 +00001451 pNewExpr1 = sqlite3ExprDup(db, pLeft, 0);
drh8f1a7ed2015-03-06 19:47:38 +00001452 pNewExpr1 = sqlite3PExpr(pParse, TK_GE,
dan80103fc2015-03-20 08:43:59 +00001453 sqlite3ExprAddCollateString(pParse,pNewExpr1,zCollSeqName),
drhae80dde2012-12-06 21:16:43 +00001454 pStr1, 0);
drhd41d39f2013-08-28 16:27:01 +00001455 transferJoinMarkings(pNewExpr1, pExpr);
drh8f1a7ed2015-03-06 19:47:38 +00001456 idxNew1 = whereClauseInsert(pWC, pNewExpr1, wtFlags);
drh6a1e0712008-12-05 15:24:15 +00001457 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001458 exprAnalyze(pSrc, pWC, idxNew1);
drhae80dde2012-12-06 21:16:43 +00001459 pNewExpr2 = sqlite3ExprDup(db, pLeft, 0);
drh8342e492010-07-22 17:49:52 +00001460 pNewExpr2 = sqlite3PExpr(pParse, TK_LT,
dan80103fc2015-03-20 08:43:59 +00001461 sqlite3ExprAddCollateString(pParse,pNewExpr2,zCollSeqName),
drhae80dde2012-12-06 21:16:43 +00001462 pStr2, 0);
drhd41d39f2013-08-28 16:27:01 +00001463 transferJoinMarkings(pNewExpr2, pExpr);
drh8f1a7ed2015-03-06 19:47:38 +00001464 idxNew2 = whereClauseInsert(pWC, pNewExpr2, wtFlags);
drh6a1e0712008-12-05 15:24:15 +00001465 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001466 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +00001467 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +00001468 if( isComplete ){
drh9769efc2014-10-24 14:32:21 +00001469 markTermAsChild(pWC, idxNew1, idxTerm);
1470 markTermAsChild(pWC, idxNew2, idxTerm);
drhd2687b72005-08-12 22:56:09 +00001471 }
1472 }
1473#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +00001474
1475#ifndef SQLITE_OMIT_VIRTUALTABLE
1476 /* Add a WO_MATCH auxiliary term to the constraint set if the
1477 ** current expression is of the form: column MATCH expr.
1478 ** This information is used by the xBestIndex methods of
1479 ** virtual tables. The native query optimizer does not attempt
1480 ** to do anything with MATCH functions.
1481 */
1482 if( isMatchOfColumn(pExpr) ){
1483 int idxNew;
1484 Expr *pRight, *pLeft;
1485 WhereTerm *pNewTerm;
1486 Bitmask prereqColumn, prereqExpr;
1487
danielk19776ab3a2e2009-02-19 14:39:25 +00001488 pRight = pExpr->x.pList->a[0].pExpr;
1489 pLeft = pExpr->x.pList->a[1].pExpr;
drh7f375902006-06-13 17:38:59 +00001490 prereqExpr = exprTableUsage(pMaskSet, pRight);
1491 prereqColumn = exprTableUsage(pMaskSet, pLeft);
1492 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +00001493 Expr *pNewExpr;
drhb7916a72009-05-27 10:31:29 +00001494 pNewExpr = sqlite3PExpr(pParse, TK_MATCH,
1495 0, sqlite3ExprDup(db, pRight, 0), 0);
drh1a90e092006-06-14 22:07:10 +00001496 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001497 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001498 pNewTerm = &pWC->a[idxNew];
1499 pNewTerm->prereqRight = prereqExpr;
1500 pNewTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001501 pNewTerm->u.leftColumn = pLeft->iColumn;
drh7f375902006-06-13 17:38:59 +00001502 pNewTerm->eOperator = WO_MATCH;
drh9769efc2014-10-24 14:32:21 +00001503 markTermAsChild(pWC, idxNew, idxTerm);
drhd2ca60d2006-06-27 02:36:58 +00001504 pTerm = &pWC->a[idxTerm];
drh165be382008-12-05 02:36:33 +00001505 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001506 pNewTerm->prereqAll = pTerm->prereqAll;
1507 }
1508 }
1509#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001510
drh1435a9a2013-08-27 23:15:44 +00001511#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhd3ed7342011-09-21 00:09:41 +00001512 /* When sqlite_stat3 histogram data is available an operator of the
drh534230c2011-01-22 00:10:45 +00001513 ** form "x IS NOT NULL" can sometimes be evaluated more efficiently
1514 ** as "x>NULL" if x is not an INTEGER PRIMARY KEY. So construct a
1515 ** virtual term of that form.
1516 **
drh9be18702015-05-13 19:33:41 +00001517 ** Note that the virtual term must be tagged with TERM_VNULL.
drh534230c2011-01-22 00:10:45 +00001518 */
drhea6dc442011-04-08 21:35:26 +00001519 if( pExpr->op==TK_NOTNULL
1520 && pExpr->pLeft->op==TK_COLUMN
1521 && pExpr->pLeft->iColumn>=0
drhd7d71472014-10-22 19:57:16 +00001522 && OptimizationEnabled(db, SQLITE_Stat34)
drhea6dc442011-04-08 21:35:26 +00001523 ){
drh534230c2011-01-22 00:10:45 +00001524 Expr *pNewExpr;
1525 Expr *pLeft = pExpr->pLeft;
1526 int idxNew;
1527 WhereTerm *pNewTerm;
1528
1529 pNewExpr = sqlite3PExpr(pParse, TK_GT,
1530 sqlite3ExprDup(db, pLeft, 0),
1531 sqlite3PExpr(pParse, TK_NULL, 0, 0, 0), 0);
1532
1533 idxNew = whereClauseInsert(pWC, pNewExpr,
drh9be18702015-05-13 19:33:41 +00001534 TERM_VIRTUAL|TERM_DYNAMIC|TERM_VNULL);
drhda91e712011-02-11 06:59:02 +00001535 if( idxNew ){
1536 pNewTerm = &pWC->a[idxNew];
1537 pNewTerm->prereqRight = 0;
1538 pNewTerm->leftCursor = pLeft->iTable;
1539 pNewTerm->u.leftColumn = pLeft->iColumn;
1540 pNewTerm->eOperator = WO_GT;
drh9769efc2014-10-24 14:32:21 +00001541 markTermAsChild(pWC, idxNew, idxTerm);
drhda91e712011-02-11 06:59:02 +00001542 pTerm = &pWC->a[idxTerm];
drhda91e712011-02-11 06:59:02 +00001543 pTerm->wtFlags |= TERM_COPIED;
1544 pNewTerm->prereqAll = pTerm->prereqAll;
1545 }
drh534230c2011-01-22 00:10:45 +00001546 }
drh1435a9a2013-08-27 23:15:44 +00001547#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drh534230c2011-01-22 00:10:45 +00001548
drhdafc0ce2008-04-17 19:14:02 +00001549 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1550 ** an index for tables to the left of the join.
1551 */
1552 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001553}
1554
drh7b4fc6a2007-02-06 13:26:32 +00001555/*
peter.d.reid60ec9142014-09-06 16:39:46 +00001556** This function searches pList for an entry that matches the iCol-th column
drh3b48e8c2013-06-12 20:18:16 +00001557** of index pIdx.
dan6f343962011-07-01 18:26:40 +00001558**
1559** If such an expression is found, its index in pList->a[] is returned. If
1560** no expression is found, -1 is returned.
1561*/
1562static int findIndexCol(
1563 Parse *pParse, /* Parse context */
1564 ExprList *pList, /* Expression list to search */
1565 int iBase, /* Cursor for table associated with pIdx */
1566 Index *pIdx, /* Index to match column of */
1567 int iCol /* Column of index to match */
1568){
1569 int i;
1570 const char *zColl = pIdx->azColl[iCol];
1571
1572 for(i=0; i<pList->nExpr; i++){
drh580c8c12012-12-08 03:34:04 +00001573 Expr *p = sqlite3ExprSkipCollate(pList->a[i].pExpr);
drhf1d3e322011-07-09 13:00:41 +00001574 if( p->op==TK_COLUMN
1575 && p->iColumn==pIdx->aiColumn[iCol]
1576 && p->iTable==iBase
1577 ){
drh580c8c12012-12-08 03:34:04 +00001578 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pList->a[i].pExpr);
drh65df68e2015-04-15 05:31:02 +00001579 if( pColl && 0==sqlite3StrICmp(pColl->zName, zColl) ){
dan6f343962011-07-01 18:26:40 +00001580 return i;
1581 }
1582 }
1583 }
1584
1585 return -1;
1586}
1587
1588/*
dan6f343962011-07-01 18:26:40 +00001589** Return true if the DISTINCT expression-list passed as the third argument
drh4f402f22013-06-11 18:59:38 +00001590** is redundant.
1591**
drh3b48e8c2013-06-12 20:18:16 +00001592** A DISTINCT list is redundant if the database contains some subset of
drh4f402f22013-06-11 18:59:38 +00001593** columns that are unique and non-null.
dan6f343962011-07-01 18:26:40 +00001594*/
1595static int isDistinctRedundant(
drh4f402f22013-06-11 18:59:38 +00001596 Parse *pParse, /* Parsing context */
1597 SrcList *pTabList, /* The FROM clause */
1598 WhereClause *pWC, /* The WHERE clause */
1599 ExprList *pDistinct /* The result set that needs to be DISTINCT */
dan6f343962011-07-01 18:26:40 +00001600){
1601 Table *pTab;
1602 Index *pIdx;
1603 int i;
1604 int iBase;
1605
1606 /* If there is more than one table or sub-select in the FROM clause of
1607 ** this query, then it will not be possible to show that the DISTINCT
1608 ** clause is redundant. */
1609 if( pTabList->nSrc!=1 ) return 0;
1610 iBase = pTabList->a[0].iCursor;
1611 pTab = pTabList->a[0].pTab;
1612
dan94e08d92011-07-02 06:44:05 +00001613 /* If any of the expressions is an IPK column on table iBase, then return
1614 ** true. Note: The (p->iTable==iBase) part of this test may be false if the
1615 ** current SELECT is a correlated sub-query.
1616 */
dan6f343962011-07-01 18:26:40 +00001617 for(i=0; i<pDistinct->nExpr; i++){
drh580c8c12012-12-08 03:34:04 +00001618 Expr *p = sqlite3ExprSkipCollate(pDistinct->a[i].pExpr);
dan94e08d92011-07-02 06:44:05 +00001619 if( p->op==TK_COLUMN && p->iTable==iBase && p->iColumn<0 ) return 1;
dan6f343962011-07-01 18:26:40 +00001620 }
1621
1622 /* Loop through all indices on the table, checking each to see if it makes
1623 ** the DISTINCT qualifier redundant. It does so if:
1624 **
1625 ** 1. The index is itself UNIQUE, and
1626 **
1627 ** 2. All of the columns in the index are either part of the pDistinct
1628 ** list, or else the WHERE clause contains a term of the form "col=X",
1629 ** where X is a constant value. The collation sequences of the
1630 ** comparison and select-list expressions must match those of the index.
dan6a36f432012-04-20 16:59:24 +00001631 **
1632 ** 3. All of those index columns for which the WHERE clause does not
1633 ** contain a "col=X" term are subject to a NOT NULL constraint.
dan6f343962011-07-01 18:26:40 +00001634 */
1635 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
drh5f1d1d92014-07-31 22:59:04 +00001636 if( !IsUniqueIndex(pIdx) ) continue;
drhbbbdc832013-10-22 18:01:40 +00001637 for(i=0; i<pIdx->nKeyCol; i++){
1638 i16 iCol = pIdx->aiColumn[i];
dan6a36f432012-04-20 16:59:24 +00001639 if( 0==findTerm(pWC, iBase, iCol, ~(Bitmask)0, WO_EQ, pIdx) ){
1640 int iIdxCol = findIndexCol(pParse, pDistinct, iBase, pIdx, i);
drhbbbdc832013-10-22 18:01:40 +00001641 if( iIdxCol<0 || pTab->aCol[iCol].notNull==0 ){
dan6a36f432012-04-20 16:59:24 +00001642 break;
1643 }
dan6f343962011-07-01 18:26:40 +00001644 }
1645 }
drhbbbdc832013-10-22 18:01:40 +00001646 if( i==pIdx->nKeyCol ){
dan6f343962011-07-01 18:26:40 +00001647 /* This index implies that the DISTINCT qualifier is redundant. */
1648 return 1;
1649 }
1650 }
1651
1652 return 0;
1653}
drh0fcef5e2005-07-19 17:38:22 +00001654
drh8636e9c2013-06-11 01:50:08 +00001655
drh75897232000-05-29 14:26:00 +00001656/*
drh3b48e8c2013-06-12 20:18:16 +00001657** Estimate the logarithm of the input value to base 2.
drh28c4cf42005-07-27 20:41:43 +00001658*/
drhbf539c42013-10-05 18:16:02 +00001659static LogEst estLog(LogEst N){
drh696964d2014-06-12 15:46:46 +00001660 return N<=10 ? 0 : sqlite3LogEst(N) - 33;
drh28c4cf42005-07-27 20:41:43 +00001661}
1662
drh6d209d82006-06-27 01:54:26 +00001663/*
drh7b3aa082015-05-29 13:55:33 +00001664** Convert OP_Column opcodes to OP_Copy in previously generated code.
1665**
1666** This routine runs over generated VDBE code and translates OP_Column
1667** opcodes into OP_Copy, and OP_Rowid into OP_Null, when the table is being
1668** accessed via co-routine instead of via table lookup.
1669*/
1670static void translateColumnToCopy(
1671 Vdbe *v, /* The VDBE containing code to translate */
1672 int iStart, /* Translate from this opcode to the end */
1673 int iTabCur, /* OP_Column/OP_Rowid references to this table */
1674 int iRegister /* The first column is in this register */
1675){
1676 VdbeOp *pOp = sqlite3VdbeGetOp(v, iStart);
1677 int iEnd = sqlite3VdbeCurrentAddr(v);
1678 for(; iStart<iEnd; iStart++, pOp++){
1679 if( pOp->p1!=iTabCur ) continue;
1680 if( pOp->opcode==OP_Column ){
1681 pOp->opcode = OP_Copy;
1682 pOp->p1 = pOp->p2 + iRegister;
1683 pOp->p2 = pOp->p3;
1684 pOp->p3 = 0;
1685 }else if( pOp->opcode==OP_Rowid ){
1686 pOp->opcode = OP_Null;
1687 pOp->p1 = 0;
1688 pOp->p3 = 0;
1689 }
1690 }
1691}
1692
1693/*
drh6d209d82006-06-27 01:54:26 +00001694** Two routines for printing the content of an sqlite3_index_info
1695** structure. Used for testing and debugging only. If neither
1696** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1697** are no-ops.
1698*/
drhd15cb172013-05-21 19:23:10 +00001699#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(WHERETRACE_ENABLED)
drh6d209d82006-06-27 01:54:26 +00001700static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1701 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001702 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001703 for(i=0; i<p->nConstraint; i++){
1704 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1705 i,
1706 p->aConstraint[i].iColumn,
1707 p->aConstraint[i].iTermOffset,
1708 p->aConstraint[i].op,
1709 p->aConstraint[i].usable);
1710 }
1711 for(i=0; i<p->nOrderBy; i++){
1712 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1713 i,
1714 p->aOrderBy[i].iColumn,
1715 p->aOrderBy[i].desc);
1716 }
1717}
1718static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1719 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001720 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001721 for(i=0; i<p->nConstraint; i++){
1722 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1723 i,
1724 p->aConstraintUsage[i].argvIndex,
1725 p->aConstraintUsage[i].omit);
1726 }
1727 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1728 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1729 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1730 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
dana9f58152013-11-11 19:01:33 +00001731 sqlite3DebugPrintf(" estimatedRows=%lld\n", p->estimatedRows);
drh6d209d82006-06-27 01:54:26 +00001732}
1733#else
1734#define TRACE_IDX_INPUTS(A)
1735#define TRACE_IDX_OUTPUTS(A)
1736#endif
1737
drhc6339082010-04-07 16:54:58 +00001738#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00001739/*
drh4139c992010-04-07 14:59:45 +00001740** Return TRUE if the WHERE clause term pTerm is of a form where it
1741** could be used with an index to access pSrc, assuming an appropriate
1742** index existed.
1743*/
1744static int termCanDriveIndex(
1745 WhereTerm *pTerm, /* WHERE clause term to check */
1746 struct SrcList_item *pSrc, /* Table we are trying to access */
1747 Bitmask notReady /* Tables in outer loops of the join */
1748){
1749 char aff;
1750 if( pTerm->leftCursor!=pSrc->iCursor ) return 0;
drhe8d0c612015-05-14 01:05:25 +00001751 if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) return 0;
drh4139c992010-04-07 14:59:45 +00001752 if( (pTerm->prereqRight & notReady)!=0 ) return 0;
drh23f98da2013-05-21 15:52:07 +00001753 if( pTerm->u.leftColumn<0 ) return 0;
drh4139c992010-04-07 14:59:45 +00001754 aff = pSrc->pTab->aCol[pTerm->u.leftColumn].affinity;
1755 if( !sqlite3IndexAffinityOk(pTerm->pExpr, aff) ) return 0;
drhe0cc3c22015-05-13 17:54:08 +00001756 testcase( pTerm->pExpr->op==TK_IS );
drh4139c992010-04-07 14:59:45 +00001757 return 1;
1758}
drhc6339082010-04-07 16:54:58 +00001759#endif
drh4139c992010-04-07 14:59:45 +00001760
drhc6339082010-04-07 16:54:58 +00001761
1762#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00001763/*
drhc6339082010-04-07 16:54:58 +00001764** Generate code to construct the Index object for an automatic index
1765** and to set up the WhereLevel object pLevel so that the code generator
1766** makes use of the automatic index.
drh8b307fb2010-04-06 15:57:05 +00001767*/
drhc6339082010-04-07 16:54:58 +00001768static void constructAutomaticIndex(
drh8b307fb2010-04-06 15:57:05 +00001769 Parse *pParse, /* The parsing context */
1770 WhereClause *pWC, /* The WHERE clause */
1771 struct SrcList_item *pSrc, /* The FROM clause term to get the next index */
1772 Bitmask notReady, /* Mask of cursors that are not available */
1773 WhereLevel *pLevel /* Write new index here */
1774){
drhbbbdc832013-10-22 18:01:40 +00001775 int nKeyCol; /* Number of columns in the constructed index */
drh8b307fb2010-04-06 15:57:05 +00001776 WhereTerm *pTerm; /* A single term of the WHERE clause */
1777 WhereTerm *pWCEnd; /* End of pWC->a[] */
drh8b307fb2010-04-06 15:57:05 +00001778 Index *pIdx; /* Object describing the transient index */
1779 Vdbe *v; /* Prepared statement under construction */
drh8b307fb2010-04-06 15:57:05 +00001780 int addrInit; /* Address of the initialization bypass jump */
1781 Table *pTable; /* The table being indexed */
drh8b307fb2010-04-06 15:57:05 +00001782 int addrTop; /* Top of the index fill loop */
1783 int regRecord; /* Register holding an index record */
1784 int n; /* Column counter */
drh4139c992010-04-07 14:59:45 +00001785 int i; /* Loop counter */
1786 int mxBitCol; /* Maximum column in pSrc->colUsed */
drh424aab82010-04-06 18:28:20 +00001787 CollSeq *pColl; /* Collating sequence to on a column */
drh7ba39a92013-05-30 17:43:19 +00001788 WhereLoop *pLoop; /* The Loop object */
drh77e57df2013-10-22 14:28:02 +00001789 char *zNotUsed; /* Extra space on the end of pIdx */
drh4139c992010-04-07 14:59:45 +00001790 Bitmask idxCols; /* Bitmap of columns used for indexing */
1791 Bitmask extraCols; /* Bitmap of additional columns */
drh8d56e202013-06-28 23:55:45 +00001792 u8 sentWarning = 0; /* True if a warnning has been issued */
drh059b2d52014-10-24 19:28:09 +00001793 Expr *pPartial = 0; /* Partial Index Expression */
1794 int iContinue = 0; /* Jump here to skip excluded rows */
drh7b3aa082015-05-29 13:55:33 +00001795 struct SrcList_item *pTabItem; /* FROM clause term being indexed */
drh8b307fb2010-04-06 15:57:05 +00001796
1797 /* Generate code to skip over the creation and initialization of the
1798 ** transient index on 2nd and subsequent iterations of the loop. */
1799 v = pParse->pVdbe;
1800 assert( v!=0 );
drh7d176102014-02-18 03:07:12 +00001801 addrInit = sqlite3CodeOnce(pParse); VdbeCoverage(v);
drh8b307fb2010-04-06 15:57:05 +00001802
drh4139c992010-04-07 14:59:45 +00001803 /* Count the number of columns that will be added to the index
1804 ** and used to match WHERE clause constraints */
drhbbbdc832013-10-22 18:01:40 +00001805 nKeyCol = 0;
drh424aab82010-04-06 18:28:20 +00001806 pTable = pSrc->pTab;
drh8b307fb2010-04-06 15:57:05 +00001807 pWCEnd = &pWC->a[pWC->nTerm];
drh7ba39a92013-05-30 17:43:19 +00001808 pLoop = pLevel->pWLoop;
drh4139c992010-04-07 14:59:45 +00001809 idxCols = 0;
drh81186b42013-06-18 01:52:41 +00001810 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh13cc90c2015-02-25 00:24:41 +00001811 Expr *pExpr = pTerm->pExpr;
1812 assert( !ExprHasProperty(pExpr, EP_FromJoin) /* prereq always non-zero */
1813 || pExpr->iRightJoinTable!=pSrc->iCursor /* for the right-hand */
1814 || pLoop->prereq!=0 ); /* table of a LEFT JOIN */
drh059b2d52014-10-24 19:28:09 +00001815 if( pLoop->prereq==0
drh051575c2014-10-25 12:28:25 +00001816 && (pTerm->wtFlags & TERM_VIRTUAL)==0
drh13cc90c2015-02-25 00:24:41 +00001817 && !ExprHasProperty(pExpr, EP_FromJoin)
1818 && sqlite3ExprIsTableConstant(pExpr, pSrc->iCursor) ){
drh059b2d52014-10-24 19:28:09 +00001819 pPartial = sqlite3ExprAnd(pParse->db, pPartial,
drh13cc90c2015-02-25 00:24:41 +00001820 sqlite3ExprDup(pParse->db, pExpr, 0));
drh059b2d52014-10-24 19:28:09 +00001821 }
drh4139c992010-04-07 14:59:45 +00001822 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
1823 int iCol = pTerm->u.leftColumn;
drh7699d1c2013-06-04 12:42:29 +00001824 Bitmask cMask = iCol>=BMS ? MASKBIT(BMS-1) : MASKBIT(iCol);
drh52ff8ea2010-04-08 14:15:56 +00001825 testcase( iCol==BMS );
1826 testcase( iCol==BMS-1 );
drh8d56e202013-06-28 23:55:45 +00001827 if( !sentWarning ){
1828 sqlite3_log(SQLITE_WARNING_AUTOINDEX,
1829 "automatic index on %s(%s)", pTable->zName,
1830 pTable->aCol[iCol].zName);
1831 sentWarning = 1;
1832 }
drh0013e722010-04-08 00:40:15 +00001833 if( (idxCols & cMask)==0 ){
drh059b2d52014-10-24 19:28:09 +00001834 if( whereLoopResize(pParse->db, pLoop, nKeyCol+1) ){
1835 goto end_auto_index_create;
1836 }
drhbbbdc832013-10-22 18:01:40 +00001837 pLoop->aLTerm[nKeyCol++] = pTerm;
drh0013e722010-04-08 00:40:15 +00001838 idxCols |= cMask;
1839 }
drh8b307fb2010-04-06 15:57:05 +00001840 }
1841 }
drhbbbdc832013-10-22 18:01:40 +00001842 assert( nKeyCol>0 );
1843 pLoop->u.btree.nEq = pLoop->nLTerm = nKeyCol;
drh53b52f72013-05-31 11:57:39 +00001844 pLoop->wsFlags = WHERE_COLUMN_EQ | WHERE_IDX_ONLY | WHERE_INDEXED
drh986b3872013-06-28 21:12:20 +00001845 | WHERE_AUTO_INDEX;
drh4139c992010-04-07 14:59:45 +00001846
1847 /* Count the number of additional columns needed to create a
1848 ** covering index. A "covering index" is an index that contains all
1849 ** columns that are needed by the query. With a covering index, the
1850 ** original table never needs to be accessed. Automatic indices must
1851 ** be a covering index because the index will not be updated if the
1852 ** original table changes and the index and table cannot both be used
1853 ** if they go out of sync.
1854 */
drh7699d1c2013-06-04 12:42:29 +00001855 extraCols = pSrc->colUsed & (~idxCols | MASKBIT(BMS-1));
drhc3ef4fa2014-10-28 15:58:50 +00001856 mxBitCol = MIN(BMS-1,pTable->nCol);
drh52ff8ea2010-04-08 14:15:56 +00001857 testcase( pTable->nCol==BMS-1 );
1858 testcase( pTable->nCol==BMS-2 );
drh4139c992010-04-07 14:59:45 +00001859 for(i=0; i<mxBitCol; i++){
drhbbbdc832013-10-22 18:01:40 +00001860 if( extraCols & MASKBIT(i) ) nKeyCol++;
drh4139c992010-04-07 14:59:45 +00001861 }
drh7699d1c2013-06-04 12:42:29 +00001862 if( pSrc->colUsed & MASKBIT(BMS-1) ){
drhbbbdc832013-10-22 18:01:40 +00001863 nKeyCol += pTable->nCol - BMS + 1;
drh4139c992010-04-07 14:59:45 +00001864 }
drh8b307fb2010-04-06 15:57:05 +00001865
1866 /* Construct the Index object to describe this index */
drhbbbdc832013-10-22 18:01:40 +00001867 pIdx = sqlite3AllocateIndexObject(pParse->db, nKeyCol+1, 0, &zNotUsed);
drh059b2d52014-10-24 19:28:09 +00001868 if( pIdx==0 ) goto end_auto_index_create;
drh7ba39a92013-05-30 17:43:19 +00001869 pLoop->u.btree.pIndex = pIdx;
drh8b307fb2010-04-06 15:57:05 +00001870 pIdx->zName = "auto-index";
drh424aab82010-04-06 18:28:20 +00001871 pIdx->pTable = pTable;
drh8b307fb2010-04-06 15:57:05 +00001872 n = 0;
drh0013e722010-04-08 00:40:15 +00001873 idxCols = 0;
drh8b307fb2010-04-06 15:57:05 +00001874 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00001875 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
drh0013e722010-04-08 00:40:15 +00001876 int iCol = pTerm->u.leftColumn;
drh7699d1c2013-06-04 12:42:29 +00001877 Bitmask cMask = iCol>=BMS ? MASKBIT(BMS-1) : MASKBIT(iCol);
drh7963b0e2013-06-17 21:37:40 +00001878 testcase( iCol==BMS-1 );
1879 testcase( iCol==BMS );
drh0013e722010-04-08 00:40:15 +00001880 if( (idxCols & cMask)==0 ){
1881 Expr *pX = pTerm->pExpr;
1882 idxCols |= cMask;
1883 pIdx->aiColumn[n] = pTerm->u.leftColumn;
1884 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
drh29031832015-04-15 07:34:25 +00001885 pIdx->azColl[n] = pColl ? pColl->zName : "BINARY";
drh0013e722010-04-08 00:40:15 +00001886 n++;
1887 }
drh8b307fb2010-04-06 15:57:05 +00001888 }
1889 }
drh7ba39a92013-05-30 17:43:19 +00001890 assert( (u32)n==pLoop->u.btree.nEq );
drh4139c992010-04-07 14:59:45 +00001891
drhc6339082010-04-07 16:54:58 +00001892 /* Add additional columns needed to make the automatic index into
1893 ** a covering index */
drh4139c992010-04-07 14:59:45 +00001894 for(i=0; i<mxBitCol; i++){
drh7699d1c2013-06-04 12:42:29 +00001895 if( extraCols & MASKBIT(i) ){
drh4139c992010-04-07 14:59:45 +00001896 pIdx->aiColumn[n] = i;
1897 pIdx->azColl[n] = "BINARY";
1898 n++;
1899 }
1900 }
drh7699d1c2013-06-04 12:42:29 +00001901 if( pSrc->colUsed & MASKBIT(BMS-1) ){
drh4139c992010-04-07 14:59:45 +00001902 for(i=BMS-1; i<pTable->nCol; i++){
1903 pIdx->aiColumn[n] = i;
1904 pIdx->azColl[n] = "BINARY";
1905 n++;
1906 }
1907 }
drhbbbdc832013-10-22 18:01:40 +00001908 assert( n==nKeyCol );
drh44156282013-10-23 22:23:03 +00001909 pIdx->aiColumn[n] = -1;
1910 pIdx->azColl[n] = "BINARY";
drh8b307fb2010-04-06 15:57:05 +00001911
drhc6339082010-04-07 16:54:58 +00001912 /* Create the automatic index */
drh8b307fb2010-04-06 15:57:05 +00001913 assert( pLevel->iIdxCur>=0 );
drha1f41242013-05-31 20:00:58 +00001914 pLevel->iIdxCur = pParse->nTab++;
drh2ec2fb22013-11-06 19:59:23 +00001915 sqlite3VdbeAddOp2(v, OP_OpenAutoindex, pLevel->iIdxCur, nKeyCol+1);
1916 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
drha21a64d2010-04-06 22:33:55 +00001917 VdbeComment((v, "for %s", pTable->zName));
drh8b307fb2010-04-06 15:57:05 +00001918
drhc6339082010-04-07 16:54:58 +00001919 /* Fill the automatic index with content */
drh059b2d52014-10-24 19:28:09 +00001920 sqlite3ExprCachePush(pParse);
drh7b3aa082015-05-29 13:55:33 +00001921 pTabItem = &pWC->pWInfo->pTabList->a[pLevel->iFrom];
1922 if( pTabItem->viaCoroutine ){
1923 int regYield = pTabItem->regReturn;
1924 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
1925 addrTop = sqlite3VdbeAddOp1(v, OP_Yield, regYield);
1926 VdbeCoverage(v);
1927 VdbeComment((v, "next row of \"%s\"", pTabItem->pTab->zName));
1928 }else{
1929 addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, pLevel->iTabCur); VdbeCoverage(v);
1930 }
drh059b2d52014-10-24 19:28:09 +00001931 if( pPartial ){
1932 iContinue = sqlite3VdbeMakeLabel(v);
1933 sqlite3ExprIfFalse(pParse, pPartial, iContinue, SQLITE_JUMPIFNULL);
drh051575c2014-10-25 12:28:25 +00001934 pLoop->wsFlags |= WHERE_PARTIALIDX;
drh059b2d52014-10-24 19:28:09 +00001935 }
drh8b307fb2010-04-06 15:57:05 +00001936 regRecord = sqlite3GetTempReg(pParse);
drh1c2c0b72014-01-04 19:27:05 +00001937 sqlite3GenerateIndexKey(pParse, pIdx, pLevel->iTabCur, regRecord, 0, 0, 0, 0);
drh8b307fb2010-04-06 15:57:05 +00001938 sqlite3VdbeAddOp2(v, OP_IdxInsert, pLevel->iIdxCur, regRecord);
1939 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
drh059b2d52014-10-24 19:28:09 +00001940 if( pPartial ) sqlite3VdbeResolveLabel(v, iContinue);
drh7b3aa082015-05-29 13:55:33 +00001941 if( pTabItem->viaCoroutine ){
1942 translateColumnToCopy(v, addrTop, pLevel->iTabCur, pTabItem->regResult);
1943 sqlite3VdbeAddOp2(v, OP_Goto, 0, addrTop);
1944 pTabItem->viaCoroutine = 0;
1945 }else{
1946 sqlite3VdbeAddOp2(v, OP_Next, pLevel->iTabCur, addrTop+1); VdbeCoverage(v);
1947 }
drha21a64d2010-04-06 22:33:55 +00001948 sqlite3VdbeChangeP5(v, SQLITE_STMTSTATUS_AUTOINDEX);
drh8b307fb2010-04-06 15:57:05 +00001949 sqlite3VdbeJumpHere(v, addrTop);
1950 sqlite3ReleaseTempReg(pParse, regRecord);
drh059b2d52014-10-24 19:28:09 +00001951 sqlite3ExprCachePop(pParse);
drh8b307fb2010-04-06 15:57:05 +00001952
1953 /* Jump here when skipping the initialization */
1954 sqlite3VdbeJumpHere(v, addrInit);
drh059b2d52014-10-24 19:28:09 +00001955
1956end_auto_index_create:
1957 sqlite3ExprDelete(pParse->db, pPartial);
drh8b307fb2010-04-06 15:57:05 +00001958}
drhc6339082010-04-07 16:54:58 +00001959#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh8b307fb2010-04-06 15:57:05 +00001960
drh9eff6162006-06-12 21:59:13 +00001961#ifndef SQLITE_OMIT_VIRTUALTABLE
1962/*
danielk19771d461462009-04-21 09:02:45 +00001963** Allocate and populate an sqlite3_index_info structure. It is the
1964** responsibility of the caller to eventually release the structure
1965** by passing the pointer returned by this function to sqlite3_free().
1966*/
drh5346e952013-05-08 14:14:26 +00001967static sqlite3_index_info *allocateIndexInfo(
1968 Parse *pParse,
1969 WhereClause *pWC,
1970 struct SrcList_item *pSrc,
1971 ExprList *pOrderBy
1972){
danielk19771d461462009-04-21 09:02:45 +00001973 int i, j;
1974 int nTerm;
1975 struct sqlite3_index_constraint *pIdxCons;
1976 struct sqlite3_index_orderby *pIdxOrderBy;
1977 struct sqlite3_index_constraint_usage *pUsage;
1978 WhereTerm *pTerm;
1979 int nOrderBy;
1980 sqlite3_index_info *pIdxInfo;
1981
danielk19771d461462009-04-21 09:02:45 +00001982 /* Count the number of possible WHERE clause constraints referring
1983 ** to this virtual table */
1984 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1985 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh7a5bcc02013-01-16 17:08:58 +00001986 assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
1987 testcase( pTerm->eOperator & WO_IN );
1988 testcase( pTerm->eOperator & WO_ISNULL );
drhee145872015-05-14 13:18:47 +00001989 testcase( pTerm->eOperator & WO_IS );
dana4ff8252014-01-20 19:55:33 +00001990 testcase( pTerm->eOperator & WO_ALL );
drhee145872015-05-14 13:18:47 +00001991 if( (pTerm->eOperator & ~(WO_ISNULL|WO_EQUIV|WO_IS))==0 ) continue;
drhb4256992011-08-02 01:57:39 +00001992 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00001993 nTerm++;
1994 }
1995
1996 /* If the ORDER BY clause contains only columns in the current
1997 ** virtual table then allocate space for the aOrderBy part of
1998 ** the sqlite3_index_info structure.
1999 */
2000 nOrderBy = 0;
2001 if( pOrderBy ){
drh56f1b992012-09-25 14:29:39 +00002002 int n = pOrderBy->nExpr;
2003 for(i=0; i<n; i++){
danielk19771d461462009-04-21 09:02:45 +00002004 Expr *pExpr = pOrderBy->a[i].pExpr;
2005 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
2006 }
drh56f1b992012-09-25 14:29:39 +00002007 if( i==n){
2008 nOrderBy = n;
danielk19771d461462009-04-21 09:02:45 +00002009 }
2010 }
2011
2012 /* Allocate the sqlite3_index_info structure
2013 */
2014 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
2015 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
2016 + sizeof(*pIdxOrderBy)*nOrderBy );
2017 if( pIdxInfo==0 ){
2018 sqlite3ErrorMsg(pParse, "out of memory");
danielk19771d461462009-04-21 09:02:45 +00002019 return 0;
2020 }
2021
2022 /* Initialize the structure. The sqlite3_index_info structure contains
2023 ** many fields that are declared "const" to prevent xBestIndex from
2024 ** changing them. We have to do some funky casting in order to
2025 ** initialize those fields.
2026 */
2027 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
2028 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
2029 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
2030 *(int*)&pIdxInfo->nConstraint = nTerm;
2031 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
2032 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
2033 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
2034 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
2035 pUsage;
2036
2037 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
drh281bbe22012-10-16 23:17:14 +00002038 u8 op;
danielk19771d461462009-04-21 09:02:45 +00002039 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh7a5bcc02013-01-16 17:08:58 +00002040 assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
2041 testcase( pTerm->eOperator & WO_IN );
drhee145872015-05-14 13:18:47 +00002042 testcase( pTerm->eOperator & WO_IS );
drh7a5bcc02013-01-16 17:08:58 +00002043 testcase( pTerm->eOperator & WO_ISNULL );
dana4ff8252014-01-20 19:55:33 +00002044 testcase( pTerm->eOperator & WO_ALL );
drhe8d0c612015-05-14 01:05:25 +00002045 if( (pTerm->eOperator & ~(WO_ISNULL|WO_EQUIV|WO_IS))==0 ) continue;
drhb4256992011-08-02 01:57:39 +00002046 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00002047 pIdxCons[j].iColumn = pTerm->u.leftColumn;
2048 pIdxCons[j].iTermOffset = i;
drh7a5bcc02013-01-16 17:08:58 +00002049 op = (u8)pTerm->eOperator & WO_ALL;
drh281bbe22012-10-16 23:17:14 +00002050 if( op==WO_IN ) op = WO_EQ;
2051 pIdxCons[j].op = op;
danielk19771d461462009-04-21 09:02:45 +00002052 /* The direct assignment in the previous line is possible only because
2053 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
2054 ** following asserts verify this fact. */
2055 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
2056 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
2057 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
2058 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
2059 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
2060 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
drh281bbe22012-10-16 23:17:14 +00002061 assert( pTerm->eOperator & (WO_IN|WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
danielk19771d461462009-04-21 09:02:45 +00002062 j++;
2063 }
2064 for(i=0; i<nOrderBy; i++){
2065 Expr *pExpr = pOrderBy->a[i].pExpr;
2066 pIdxOrderBy[i].iColumn = pExpr->iColumn;
2067 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
2068 }
2069
2070 return pIdxInfo;
2071}
2072
2073/*
2074** The table object reference passed as the second argument to this function
2075** must represent a virtual table. This function invokes the xBestIndex()
drh3b48e8c2013-06-12 20:18:16 +00002076** method of the virtual table with the sqlite3_index_info object that
2077** comes in as the 3rd argument to this function.
danielk19771d461462009-04-21 09:02:45 +00002078**
2079** If an error occurs, pParse is populated with an error message and a
2080** non-zero value is returned. Otherwise, 0 is returned and the output
2081** part of the sqlite3_index_info structure is left populated.
2082**
2083** Whether or not an error is returned, it is the responsibility of the
2084** caller to eventually free p->idxStr if p->needToFreeIdxStr indicates
2085** that this is required.
2086*/
2087static int vtabBestIndex(Parse *pParse, Table *pTab, sqlite3_index_info *p){
danielk1977595a5232009-07-24 17:58:53 +00002088 sqlite3_vtab *pVtab = sqlite3GetVTable(pParse->db, pTab)->pVtab;
danielk19771d461462009-04-21 09:02:45 +00002089 int i;
2090 int rc;
2091
danielk19771d461462009-04-21 09:02:45 +00002092 TRACE_IDX_INPUTS(p);
2093 rc = pVtab->pModule->xBestIndex(pVtab, p);
2094 TRACE_IDX_OUTPUTS(p);
danielk19771d461462009-04-21 09:02:45 +00002095
2096 if( rc!=SQLITE_OK ){
2097 if( rc==SQLITE_NOMEM ){
2098 pParse->db->mallocFailed = 1;
2099 }else if( !pVtab->zErrMsg ){
2100 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
2101 }else{
2102 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
2103 }
2104 }
drhb9755982010-07-24 16:34:37 +00002105 sqlite3_free(pVtab->zErrMsg);
danielk19771d461462009-04-21 09:02:45 +00002106 pVtab->zErrMsg = 0;
2107
2108 for(i=0; i<p->nConstraint; i++){
2109 if( !p->aConstraint[i].usable && p->aConstraintUsage[i].argvIndex>0 ){
2110 sqlite3ErrorMsg(pParse,
2111 "table %s: xBestIndex returned an invalid plan", pTab->zName);
2112 }
2113 }
2114
2115 return pParse->nErr;
2116}
drh7ba39a92013-05-30 17:43:19 +00002117#endif /* !defined(SQLITE_OMIT_VIRTUALTABLE) */
danielk19771d461462009-04-21 09:02:45 +00002118
drh1435a9a2013-08-27 23:15:44 +00002119#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh28c4cf42005-07-27 20:41:43 +00002120/*
drhfaacf172011-08-12 01:51:45 +00002121** Estimate the location of a particular key among all keys in an
2122** index. Store the results in aStat as follows:
drhe847d322011-01-20 02:56:37 +00002123**
dana3d0c132015-03-14 18:59:58 +00002124** aStat[0] Est. number of rows less than pRec
2125** aStat[1] Est. number of rows equal to pRec
dan02fa4692009-08-17 17:06:58 +00002126**
drh6d3f91d2014-11-05 19:26:12 +00002127** Return the index of the sample that is the smallest sample that
dana3d0c132015-03-14 18:59:58 +00002128** is greater than or equal to pRec. Note that this index is not an index
2129** into the aSample[] array - it is an index into a virtual set of samples
2130** based on the contents of aSample[] and the number of fields in record
2131** pRec.
dan02fa4692009-08-17 17:06:58 +00002132*/
drh6d3f91d2014-11-05 19:26:12 +00002133static int whereKeyStats(
dan02fa4692009-08-17 17:06:58 +00002134 Parse *pParse, /* Database connection */
2135 Index *pIdx, /* Index to consider domain of */
dan7a419232013-08-06 20:01:43 +00002136 UnpackedRecord *pRec, /* Vector of values to consider */
drhfaacf172011-08-12 01:51:45 +00002137 int roundUp, /* Round up if true. Round down if false */
2138 tRowcnt *aStat /* OUT: stats written here */
dan02fa4692009-08-17 17:06:58 +00002139){
danf52bb8d2013-08-03 20:24:58 +00002140 IndexSample *aSample = pIdx->aSample;
drhfbc38de2013-09-03 19:26:22 +00002141 int iCol; /* Index of required stats in anEq[] etc. */
dana3d0c132015-03-14 18:59:58 +00002142 int i; /* Index of first sample >= pRec */
2143 int iSample; /* Smallest sample larger than or equal to pRec */
dan84c309b2013-08-08 16:17:12 +00002144 int iMin = 0; /* Smallest sample not yet tested */
dan84c309b2013-08-08 16:17:12 +00002145 int iTest; /* Next sample to test */
2146 int res; /* Result of comparison operation */
dana3d0c132015-03-14 18:59:58 +00002147 int nField; /* Number of fields in pRec */
2148 tRowcnt iLower = 0; /* anLt[] + anEq[] of largest sample pRec is > */
dan02fa4692009-08-17 17:06:58 +00002149
drh4f991892013-10-11 15:05:05 +00002150#ifndef SQLITE_DEBUG
2151 UNUSED_PARAMETER( pParse );
2152#endif
drh7f594752013-12-03 19:49:55 +00002153 assert( pRec!=0 );
drh5c624862011-09-22 18:46:34 +00002154 assert( pIdx->nSample>0 );
dana3d0c132015-03-14 18:59:58 +00002155 assert( pRec->nField>0 && pRec->nField<=pIdx->nSampleCol );
2156
2157 /* Do a binary search to find the first sample greater than or equal
2158 ** to pRec. If pRec contains a single field, the set of samples to search
2159 ** is simply the aSample[] array. If the samples in aSample[] contain more
2160 ** than one fields, all fields following the first are ignored.
2161 **
2162 ** If pRec contains N fields, where N is more than one, then as well as the
2163 ** samples in aSample[] (truncated to N fields), the search also has to
2164 ** consider prefixes of those samples. For example, if the set of samples
2165 ** in aSample is:
2166 **
2167 ** aSample[0] = (a, 5)
2168 ** aSample[1] = (a, 10)
2169 ** aSample[2] = (b, 5)
2170 ** aSample[3] = (c, 100)
2171 ** aSample[4] = (c, 105)
2172 **
2173 ** Then the search space should ideally be the samples above and the
2174 ** unique prefixes [a], [b] and [c]. But since that is hard to organize,
2175 ** the code actually searches this set:
2176 **
2177 ** 0: (a)
2178 ** 1: (a, 5)
2179 ** 2: (a, 10)
2180 ** 3: (a, 10)
2181 ** 4: (b)
2182 ** 5: (b, 5)
2183 ** 6: (c)
2184 ** 7: (c, 100)
2185 ** 8: (c, 105)
2186 ** 9: (c, 105)
2187 **
2188 ** For each sample in the aSample[] array, N samples are present in the
2189 ** effective sample array. In the above, samples 0 and 1 are based on
2190 ** sample aSample[0]. Samples 2 and 3 on aSample[1] etc.
2191 **
2192 ** Often, sample i of each block of N effective samples has (i+1) fields.
2193 ** Except, each sample may be extended to ensure that it is greater than or
2194 ** equal to the previous sample in the array. For example, in the above,
2195 ** sample 2 is the first sample of a block of N samples, so at first it
2196 ** appears that it should be 1 field in size. However, that would make it
2197 ** smaller than sample 1, so the binary search would not work. As a result,
2198 ** it is extended to two fields. The duplicates that this creates do not
2199 ** cause any problems.
2200 */
2201 nField = pRec->nField;
2202 iCol = 0;
2203 iSample = pIdx->nSample * nField;
dan84c309b2013-08-08 16:17:12 +00002204 do{
dana3d0c132015-03-14 18:59:58 +00002205 int iSamp; /* Index in aSample[] of test sample */
2206 int n; /* Number of fields in test sample */
2207
2208 iTest = (iMin+iSample)/2;
2209 iSamp = iTest / nField;
2210 if( iSamp>0 ){
2211 /* The proposed effective sample is a prefix of sample aSample[iSamp].
2212 ** Specifically, the shortest prefix of at least (1 + iTest%nField)
2213 ** fields that is greater than the previous effective sample. */
2214 for(n=(iTest % nField) + 1; n<nField; n++){
2215 if( aSample[iSamp-1].anLt[n-1]!=aSample[iSamp].anLt[n-1] ) break;
2216 }
dan84c309b2013-08-08 16:17:12 +00002217 }else{
dana3d0c132015-03-14 18:59:58 +00002218 n = iTest + 1;
dan02fa4692009-08-17 17:06:58 +00002219 }
dana3d0c132015-03-14 18:59:58 +00002220
2221 pRec->nField = n;
2222 res = sqlite3VdbeRecordCompare(aSample[iSamp].n, aSample[iSamp].p, pRec);
2223 if( res<0 ){
2224 iLower = aSample[iSamp].anLt[n-1] + aSample[iSamp].anEq[n-1];
2225 iMin = iTest+1;
2226 }else if( res==0 && n<nField ){
2227 iLower = aSample[iSamp].anLt[n-1];
2228 iMin = iTest+1;
2229 res = -1;
2230 }else{
2231 iSample = iTest;
2232 iCol = n-1;
2233 }
2234 }while( res && iMin<iSample );
2235 i = iSample / nField;
drh51147ba2005-07-23 22:59:55 +00002236
dan84c309b2013-08-08 16:17:12 +00002237#ifdef SQLITE_DEBUG
2238 /* The following assert statements check that the binary search code
2239 ** above found the right answer. This block serves no purpose other
2240 ** than to invoke the asserts. */
dana3d0c132015-03-14 18:59:58 +00002241 if( pParse->db->mallocFailed==0 ){
2242 if( res==0 ){
2243 /* If (res==0) is true, then pRec must be equal to sample i. */
2244 assert( i<pIdx->nSample );
2245 assert( iCol==nField-1 );
2246 pRec->nField = nField;
2247 assert( 0==sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec)
2248 || pParse->db->mallocFailed
2249 );
2250 }else{
2251 /* Unless i==pIdx->nSample, indicating that pRec is larger than
2252 ** all samples in the aSample[] array, pRec must be smaller than the
2253 ** (iCol+1) field prefix of sample i. */
2254 assert( i<=pIdx->nSample && i>=0 );
2255 pRec->nField = iCol+1;
2256 assert( i==pIdx->nSample
2257 || sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec)>0
2258 || pParse->db->mallocFailed );
2259
2260 /* if i==0 and iCol==0, then record pRec is smaller than all samples
2261 ** in the aSample[] array. Otherwise, if (iCol>0) then pRec must
2262 ** be greater than or equal to the (iCol) field prefix of sample i.
2263 ** If (i>0), then pRec must also be greater than sample (i-1). */
2264 if( iCol>0 ){
2265 pRec->nField = iCol;
2266 assert( sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec)<=0
2267 || pParse->db->mallocFailed );
2268 }
2269 if( i>0 ){
2270 pRec->nField = nField;
2271 assert( sqlite3VdbeRecordCompare(aSample[i-1].n, aSample[i-1].p, pRec)<0
2272 || pParse->db->mallocFailed );
2273 }
2274 }
drhfaacf172011-08-12 01:51:45 +00002275 }
dan84c309b2013-08-08 16:17:12 +00002276#endif /* ifdef SQLITE_DEBUG */
dan02fa4692009-08-17 17:06:58 +00002277
dan84c309b2013-08-08 16:17:12 +00002278 if( res==0 ){
dana3d0c132015-03-14 18:59:58 +00002279 /* Record pRec is equal to sample i */
2280 assert( iCol==nField-1 );
daneea568d2013-08-07 19:46:15 +00002281 aStat[0] = aSample[i].anLt[iCol];
2282 aStat[1] = aSample[i].anEq[iCol];
drhfaacf172011-08-12 01:51:45 +00002283 }else{
dana3d0c132015-03-14 18:59:58 +00002284 /* At this point, the (iCol+1) field prefix of aSample[i] is the first
2285 ** sample that is greater than pRec. Or, if i==pIdx->nSample then pRec
2286 ** is larger than all samples in the array. */
2287 tRowcnt iUpper, iGap;
2288 if( i>=pIdx->nSample ){
2289 iUpper = sqlite3LogEstToInt(pIdx->aiRowLogEst[0]);
drhfaacf172011-08-12 01:51:45 +00002290 }else{
dana3d0c132015-03-14 18:59:58 +00002291 iUpper = aSample[i].anLt[iCol];
drhfaacf172011-08-12 01:51:45 +00002292 }
dana3d0c132015-03-14 18:59:58 +00002293
drhfaacf172011-08-12 01:51:45 +00002294 if( iLower>=iUpper ){
2295 iGap = 0;
2296 }else{
2297 iGap = iUpper - iLower;
drhfaacf172011-08-12 01:51:45 +00002298 }
2299 if( roundUp ){
2300 iGap = (iGap*2)/3;
2301 }else{
2302 iGap = iGap/3;
2303 }
2304 aStat[0] = iLower + iGap;
dana3d0c132015-03-14 18:59:58 +00002305 aStat[1] = pIdx->aAvgEq[iCol];
dan02fa4692009-08-17 17:06:58 +00002306 }
dana3d0c132015-03-14 18:59:58 +00002307
2308 /* Restore the pRec->nField value before returning. */
2309 pRec->nField = nField;
drh6d3f91d2014-11-05 19:26:12 +00002310 return i;
dan02fa4692009-08-17 17:06:58 +00002311}
drh1435a9a2013-08-27 23:15:44 +00002312#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
dan937d0de2009-10-15 18:35:38 +00002313
2314/*
danaa9933c2014-04-24 20:04:49 +00002315** If it is not NULL, pTerm is a term that provides an upper or lower
2316** bound on a range scan. Without considering pTerm, it is estimated
2317** that the scan will visit nNew rows. This function returns the number
2318** estimated to be visited after taking pTerm into account.
2319**
2320** If the user explicitly specified a likelihood() value for this term,
2321** then the return value is the likelihood multiplied by the number of
2322** input rows. Otherwise, this function assumes that an "IS NOT NULL" term
2323** has a likelihood of 0.50, and any other term a likelihood of 0.25.
2324*/
2325static LogEst whereRangeAdjust(WhereTerm *pTerm, LogEst nNew){
2326 LogEst nRet = nNew;
2327 if( pTerm ){
2328 if( pTerm->truthProb<=0 ){
2329 nRet += pTerm->truthProb;
dan7de2a1f2014-04-28 20:11:20 +00002330 }else if( (pTerm->wtFlags & TERM_VNULL)==0 ){
danaa9933c2014-04-24 20:04:49 +00002331 nRet -= 20; assert( 20==sqlite3LogEst(4) );
2332 }
2333 }
2334 return nRet;
2335}
2336
mistachkin2d84ac42014-06-26 21:32:09 +00002337#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
danb0b82902014-06-26 20:21:46 +00002338/*
2339** This function is called to estimate the number of rows visited by a
2340** range-scan on a skip-scan index. For example:
2341**
2342** CREATE INDEX i1 ON t1(a, b, c);
2343** SELECT * FROM t1 WHERE a=? AND c BETWEEN ? AND ?;
2344**
2345** Value pLoop->nOut is currently set to the estimated number of rows
2346** visited for scanning (a=? AND b=?). This function reduces that estimate
2347** by some factor to account for the (c BETWEEN ? AND ?) expression based
2348** on the stat4 data for the index. this scan will be peformed multiple
2349** times (once for each (a,b) combination that matches a=?) is dealt with
2350** by the caller.
2351**
2352** It does this by scanning through all stat4 samples, comparing values
2353** extracted from pLower and pUpper with the corresponding column in each
2354** sample. If L and U are the number of samples found to be less than or
2355** equal to the values extracted from pLower and pUpper respectively, and
2356** N is the total number of samples, the pLoop->nOut value is adjusted
2357** as follows:
2358**
2359** nOut = nOut * ( min(U - L, 1) / N )
2360**
2361** If pLower is NULL, or a value cannot be extracted from the term, L is
2362** set to zero. If pUpper is NULL, or a value cannot be extracted from it,
2363** U is set to N.
2364**
2365** Normally, this function sets *pbDone to 1 before returning. However,
2366** if no value can be extracted from either pLower or pUpper (and so the
2367** estimate of the number of rows delivered remains unchanged), *pbDone
2368** is left as is.
2369**
2370** If an error occurs, an SQLite error code is returned. Otherwise,
2371** SQLITE_OK.
2372*/
2373static int whereRangeSkipScanEst(
2374 Parse *pParse, /* Parsing & code generating context */
2375 WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
2376 WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
2377 WhereLoop *pLoop, /* Update the .nOut value of this loop */
2378 int *pbDone /* Set to true if at least one expr. value extracted */
2379){
2380 Index *p = pLoop->u.btree.pIndex;
2381 int nEq = pLoop->u.btree.nEq;
2382 sqlite3 *db = pParse->db;
dan4e42ba42014-06-27 20:14:25 +00002383 int nLower = -1;
2384 int nUpper = p->nSample+1;
danb0b82902014-06-26 20:21:46 +00002385 int rc = SQLITE_OK;
drhd15f87e2014-07-24 22:41:20 +00002386 int iCol = p->aiColumn[nEq];
2387 u8 aff = iCol>=0 ? p->pTable->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
danb0b82902014-06-26 20:21:46 +00002388 CollSeq *pColl;
2389
2390 sqlite3_value *p1 = 0; /* Value extracted from pLower */
2391 sqlite3_value *p2 = 0; /* Value extracted from pUpper */
2392 sqlite3_value *pVal = 0; /* Value extracted from record */
2393
2394 pColl = sqlite3LocateCollSeq(pParse, p->azColl[nEq]);
2395 if( pLower ){
2396 rc = sqlite3Stat4ValueFromExpr(pParse, pLower->pExpr->pRight, aff, &p1);
dan4e42ba42014-06-27 20:14:25 +00002397 nLower = 0;
danb0b82902014-06-26 20:21:46 +00002398 }
2399 if( pUpper && rc==SQLITE_OK ){
2400 rc = sqlite3Stat4ValueFromExpr(pParse, pUpper->pExpr->pRight, aff, &p2);
dan4e42ba42014-06-27 20:14:25 +00002401 nUpper = p2 ? 0 : p->nSample;
danb0b82902014-06-26 20:21:46 +00002402 }
2403
2404 if( p1 || p2 ){
2405 int i;
2406 int nDiff;
2407 for(i=0; rc==SQLITE_OK && i<p->nSample; i++){
2408 rc = sqlite3Stat4Column(db, p->aSample[i].p, p->aSample[i].n, nEq, &pVal);
2409 if( rc==SQLITE_OK && p1 ){
2410 int res = sqlite3MemCompare(p1, pVal, pColl);
dan4e42ba42014-06-27 20:14:25 +00002411 if( res>=0 ) nLower++;
danb0b82902014-06-26 20:21:46 +00002412 }
2413 if( rc==SQLITE_OK && p2 ){
2414 int res = sqlite3MemCompare(p2, pVal, pColl);
dan4e42ba42014-06-27 20:14:25 +00002415 if( res>=0 ) nUpper++;
danb0b82902014-06-26 20:21:46 +00002416 }
2417 }
danb0b82902014-06-26 20:21:46 +00002418 nDiff = (nUpper - nLower);
2419 if( nDiff<=0 ) nDiff = 1;
dan4e42ba42014-06-27 20:14:25 +00002420
2421 /* If there is both an upper and lower bound specified, and the
2422 ** comparisons indicate that they are close together, use the fallback
2423 ** method (assume that the scan visits 1/64 of the rows) for estimating
2424 ** the number of rows visited. Otherwise, estimate the number of rows
2425 ** using the method described in the header comment for this function. */
2426 if( nDiff!=1 || pUpper==0 || pLower==0 ){
2427 int nAdjust = (sqlite3LogEst(p->nSample) - sqlite3LogEst(nDiff));
2428 pLoop->nOut -= nAdjust;
2429 *pbDone = 1;
2430 WHERETRACE(0x10, ("range skip-scan regions: %u..%u adjust=%d est=%d\n",
danfa887452014-06-28 15:26:10 +00002431 nLower, nUpper, nAdjust*-1, pLoop->nOut));
dan4e42ba42014-06-27 20:14:25 +00002432 }
2433
danb0b82902014-06-26 20:21:46 +00002434 }else{
2435 assert( *pbDone==0 );
2436 }
2437
2438 sqlite3ValueFree(p1);
2439 sqlite3ValueFree(p2);
2440 sqlite3ValueFree(pVal);
2441
2442 return rc;
2443}
mistachkin2d84ac42014-06-26 21:32:09 +00002444#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
danb0b82902014-06-26 20:21:46 +00002445
danaa9933c2014-04-24 20:04:49 +00002446/*
dan02fa4692009-08-17 17:06:58 +00002447** This function is used to estimate the number of rows that will be visited
2448** by scanning an index for a range of values. The range may have an upper
2449** bound, a lower bound, or both. The WHERE clause terms that set the upper
2450** and lower bounds are represented by pLower and pUpper respectively. For
2451** example, assuming that index p is on t1(a):
2452**
2453** ... FROM t1 WHERE a > ? AND a < ? ...
2454** |_____| |_____|
2455** | |
2456** pLower pUpper
2457**
drh98cdf622009-08-20 18:14:42 +00002458** If either of the upper or lower bound is not present, then NULL is passed in
drhcdaca552009-08-20 13:45:07 +00002459** place of the corresponding WhereTerm.
dan02fa4692009-08-17 17:06:58 +00002460**
drh6d3f91d2014-11-05 19:26:12 +00002461** The value in (pBuilder->pNew->u.btree.nEq) is the number of the index
dan6cb8d762013-08-08 11:48:57 +00002462** column subject to the range constraint. Or, equivalently, the number of
2463** equality constraints optimized by the proposed index scan. For example,
2464** assuming index p is on t1(a, b), and the SQL query is:
dan02fa4692009-08-17 17:06:58 +00002465**
2466** ... FROM t1 WHERE a = ? AND b > ? AND b < ? ...
2467**
dan6cb8d762013-08-08 11:48:57 +00002468** then nEq is set to 1 (as the range restricted column, b, is the second
2469** left-most column of the index). Or, if the query is:
dan02fa4692009-08-17 17:06:58 +00002470**
2471** ... FROM t1 WHERE a > ? AND a < ? ...
2472**
dan6cb8d762013-08-08 11:48:57 +00002473** then nEq is set to 0.
dan02fa4692009-08-17 17:06:58 +00002474**
drhbf539c42013-10-05 18:16:02 +00002475** When this function is called, *pnOut is set to the sqlite3LogEst() of the
dan6cb8d762013-08-08 11:48:57 +00002476** number of rows that the index scan is expected to visit without
drh6d3f91d2014-11-05 19:26:12 +00002477** considering the range constraints. If nEq is 0, then *pnOut is the number of
dan6cb8d762013-08-08 11:48:57 +00002478** rows in the index. Assuming no error occurs, *pnOut is adjusted (reduced)
peter.d.reid60ec9142014-09-06 16:39:46 +00002479** to account for the range constraints pLower and pUpper.
dan6cb8d762013-08-08 11:48:57 +00002480**
2481** In the absence of sqlite_stat4 ANALYZE data, or if such data cannot be
drh94aa7e02014-06-06 17:09:52 +00002482** used, a single range inequality reduces the search space by a factor of 4.
2483** and a pair of constraints (x>? AND x<?) reduces the expected number of
2484** rows visited by a factor of 64.
dan02fa4692009-08-17 17:06:58 +00002485*/
2486static int whereRangeScanEst(
drhcdaca552009-08-20 13:45:07 +00002487 Parse *pParse, /* Parsing & code generating context */
dan7a419232013-08-06 20:01:43 +00002488 WhereLoopBuilder *pBuilder,
drhcdaca552009-08-20 13:45:07 +00002489 WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
2490 WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
drh186ad8c2013-10-08 18:40:37 +00002491 WhereLoop *pLoop /* Modify the .nOut and maybe .rRun fields */
dan02fa4692009-08-17 17:06:58 +00002492){
dan69188d92009-08-19 08:18:32 +00002493 int rc = SQLITE_OK;
drh186ad8c2013-10-08 18:40:37 +00002494 int nOut = pLoop->nOut;
drhbf539c42013-10-05 18:16:02 +00002495 LogEst nNew;
dan69188d92009-08-19 08:18:32 +00002496
drh1435a9a2013-08-27 23:15:44 +00002497#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh186ad8c2013-10-08 18:40:37 +00002498 Index *p = pLoop->u.btree.pIndex;
drh4f991892013-10-11 15:05:05 +00002499 int nEq = pLoop->u.btree.nEq;
dan02fa4692009-08-17 17:06:58 +00002500
drh6d3f91d2014-11-05 19:26:12 +00002501 if( p->nSample>0 && nEq<p->nSampleCol ){
danb0b82902014-06-26 20:21:46 +00002502 if( nEq==pBuilder->nRecValid ){
2503 UnpackedRecord *pRec = pBuilder->pRec;
2504 tRowcnt a[2];
2505 u8 aff;
drh98cdf622009-08-20 18:14:42 +00002506
danb0b82902014-06-26 20:21:46 +00002507 /* Variable iLower will be set to the estimate of the number of rows in
2508 ** the index that are less than the lower bound of the range query. The
2509 ** lower bound being the concatenation of $P and $L, where $P is the
2510 ** key-prefix formed by the nEq values matched against the nEq left-most
2511 ** columns of the index, and $L is the value in pLower.
2512 **
2513 ** Or, if pLower is NULL or $L cannot be extracted from it (because it
2514 ** is not a simple variable or literal value), the lower bound of the
2515 ** range is $P. Due to a quirk in the way whereKeyStats() works, even
2516 ** if $L is available, whereKeyStats() is called for both ($P) and
drh6d3f91d2014-11-05 19:26:12 +00002517 ** ($P:$L) and the larger of the two returned values is used.
danb0b82902014-06-26 20:21:46 +00002518 **
2519 ** Similarly, iUpper is to be set to the estimate of the number of rows
2520 ** less than the upper bound of the range query. Where the upper bound
2521 ** is either ($P) or ($P:$U). Again, even if $U is available, both values
2522 ** of iUpper are requested of whereKeyStats() and the smaller used.
drh6d3f91d2014-11-05 19:26:12 +00002523 **
2524 ** The number of rows between the two bounds is then just iUpper-iLower.
danb0b82902014-06-26 20:21:46 +00002525 */
drh6d3f91d2014-11-05 19:26:12 +00002526 tRowcnt iLower; /* Rows less than the lower bound */
2527 tRowcnt iUpper; /* Rows less than the upper bound */
2528 int iLwrIdx = -2; /* aSample[] for the lower bound */
2529 int iUprIdx = -1; /* aSample[] for the upper bound */
danb3c02e22013-08-08 19:38:40 +00002530
drhb34fc5b2014-08-28 17:20:37 +00002531 if( pRec ){
2532 testcase( pRec->nField!=pBuilder->nRecValid );
2533 pRec->nField = pBuilder->nRecValid;
2534 }
danb0b82902014-06-26 20:21:46 +00002535 if( nEq==p->nKeyCol ){
2536 aff = SQLITE_AFF_INTEGER;
dan7a419232013-08-06 20:01:43 +00002537 }else{
danb0b82902014-06-26 20:21:46 +00002538 aff = p->pTable->aCol[p->aiColumn[nEq]].affinity;
drhfaacf172011-08-12 01:51:45 +00002539 }
danb0b82902014-06-26 20:21:46 +00002540 /* Determine iLower and iUpper using ($P) only. */
2541 if( nEq==0 ){
2542 iLower = 0;
drh9f07cf72014-10-22 15:27:05 +00002543 iUpper = p->nRowEst0;
danb0b82902014-06-26 20:21:46 +00002544 }else{
2545 /* Note: this call could be optimized away - since the same values must
2546 ** have been requested when testing key $P in whereEqualScanEst(). */
2547 whereKeyStats(pParse, p, pRec, 0, a);
2548 iLower = a[0];
2549 iUpper = a[0] + a[1];
dan6cb8d762013-08-08 11:48:57 +00002550 }
danb0b82902014-06-26 20:21:46 +00002551
drh69afd992014-10-08 02:53:25 +00002552 assert( pLower==0 || (pLower->eOperator & (WO_GT|WO_GE))!=0 );
2553 assert( pUpper==0 || (pUpper->eOperator & (WO_LT|WO_LE))!=0 );
drh681fca02014-10-10 15:01:46 +00002554 assert( p->aSortOrder!=0 );
2555 if( p->aSortOrder[nEq] ){
drh69afd992014-10-08 02:53:25 +00002556 /* The roles of pLower and pUpper are swapped for a DESC index */
2557 SWAP(WhereTerm*, pLower, pUpper);
2558 }
2559
danb0b82902014-06-26 20:21:46 +00002560 /* If possible, improve on the iLower estimate using ($P:$L). */
2561 if( pLower ){
2562 int bOk; /* True if value is extracted from pExpr */
2563 Expr *pExpr = pLower->pExpr->pRight;
danb0b82902014-06-26 20:21:46 +00002564 rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, aff, nEq, &bOk);
2565 if( rc==SQLITE_OK && bOk ){
2566 tRowcnt iNew;
drh6d3f91d2014-11-05 19:26:12 +00002567 iLwrIdx = whereKeyStats(pParse, p, pRec, 0, a);
drh69afd992014-10-08 02:53:25 +00002568 iNew = a[0] + ((pLower->eOperator & (WO_GT|WO_LE)) ? a[1] : 0);
danb0b82902014-06-26 20:21:46 +00002569 if( iNew>iLower ) iLower = iNew;
2570 nOut--;
danf741e042014-08-25 18:29:38 +00002571 pLower = 0;
danb0b82902014-06-26 20:21:46 +00002572 }
2573 }
2574
2575 /* If possible, improve on the iUpper estimate using ($P:$U). */
2576 if( pUpper ){
2577 int bOk; /* True if value is extracted from pExpr */
2578 Expr *pExpr = pUpper->pExpr->pRight;
danb0b82902014-06-26 20:21:46 +00002579 rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, aff, nEq, &bOk);
2580 if( rc==SQLITE_OK && bOk ){
2581 tRowcnt iNew;
drh6d3f91d2014-11-05 19:26:12 +00002582 iUprIdx = whereKeyStats(pParse, p, pRec, 1, a);
drh69afd992014-10-08 02:53:25 +00002583 iNew = a[0] + ((pUpper->eOperator & (WO_GT|WO_LE)) ? a[1] : 0);
danb0b82902014-06-26 20:21:46 +00002584 if( iNew<iUpper ) iUpper = iNew;
2585 nOut--;
danf741e042014-08-25 18:29:38 +00002586 pUpper = 0;
danb0b82902014-06-26 20:21:46 +00002587 }
2588 }
2589
2590 pBuilder->pRec = pRec;
2591 if( rc==SQLITE_OK ){
2592 if( iUpper>iLower ){
2593 nNew = sqlite3LogEst(iUpper - iLower);
drh6d3f91d2014-11-05 19:26:12 +00002594 /* TUNING: If both iUpper and iLower are derived from the same
2595 ** sample, then assume they are 4x more selective. This brings
2596 ** the estimated selectivity more in line with what it would be
2597 ** if estimated without the use of STAT3/4 tables. */
2598 if( iLwrIdx==iUprIdx ) nNew -= 20; assert( 20==sqlite3LogEst(4) );
danb0b82902014-06-26 20:21:46 +00002599 }else{
2600 nNew = 10; assert( 10==sqlite3LogEst(2) );
2601 }
2602 if( nNew<nOut ){
2603 nOut = nNew;
2604 }
drhae914d72014-08-28 19:38:22 +00002605 WHERETRACE(0x10, ("STAT4 range scan: %u..%u est=%d\n",
danb0b82902014-06-26 20:21:46 +00002606 (u32)iLower, (u32)iUpper, nOut));
danb0b82902014-06-26 20:21:46 +00002607 }
2608 }else{
2609 int bDone = 0;
2610 rc = whereRangeSkipScanEst(pParse, pLower, pUpper, pLoop, &bDone);
2611 if( bDone ) return rc;
drh98cdf622009-08-20 18:14:42 +00002612 }
dan02fa4692009-08-17 17:06:58 +00002613 }
drh3f022182009-09-09 16:10:50 +00002614#else
2615 UNUSED_PARAMETER(pParse);
dan7a419232013-08-06 20:01:43 +00002616 UNUSED_PARAMETER(pBuilder);
dan02fa4692009-08-17 17:06:58 +00002617 assert( pLower || pUpper );
danf741e042014-08-25 18:29:38 +00002618#endif
dan7de2a1f2014-04-28 20:11:20 +00002619 assert( pUpper==0 || (pUpper->wtFlags & TERM_VNULL)==0 );
danaa9933c2014-04-24 20:04:49 +00002620 nNew = whereRangeAdjust(pLower, nOut);
2621 nNew = whereRangeAdjust(pUpper, nNew);
dan7de2a1f2014-04-28 20:11:20 +00002622
drh4dd96a82014-10-24 15:26:29 +00002623 /* TUNING: If there is both an upper and lower limit and neither limit
2624 ** has an application-defined likelihood(), assume the range is
dan42685f22014-04-28 19:34:06 +00002625 ** reduced by an additional 75%. This means that, by default, an open-ended
2626 ** range query (e.g. col > ?) is assumed to match 1/4 of the rows in the
2627 ** index. While a closed range (e.g. col BETWEEN ? AND ?) is estimated to
2628 ** match 1/64 of the index. */
drh4dd96a82014-10-24 15:26:29 +00002629 if( pLower && pLower->truthProb>0 && pUpper && pUpper->truthProb>0 ){
2630 nNew -= 20;
2631 }
dan7de2a1f2014-04-28 20:11:20 +00002632
danaa9933c2014-04-24 20:04:49 +00002633 nOut -= (pLower!=0) + (pUpper!=0);
drhabfa6d52013-09-11 03:53:22 +00002634 if( nNew<10 ) nNew = 10;
2635 if( nNew<nOut ) nOut = nNew;
drhae914d72014-08-28 19:38:22 +00002636#if defined(WHERETRACE_ENABLED)
2637 if( pLoop->nOut>nOut ){
2638 WHERETRACE(0x10,("Range scan lowers nOut from %d to %d\n",
2639 pLoop->nOut, nOut));
2640 }
2641#endif
drh186ad8c2013-10-08 18:40:37 +00002642 pLoop->nOut = (LogEst)nOut;
dan02fa4692009-08-17 17:06:58 +00002643 return rc;
2644}
2645
drh1435a9a2013-08-27 23:15:44 +00002646#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh82759752011-01-20 16:52:09 +00002647/*
2648** Estimate the number of rows that will be returned based on
2649** an equality constraint x=VALUE and where that VALUE occurs in
2650** the histogram data. This only works when x is the left-most
drhfaacf172011-08-12 01:51:45 +00002651** column of an index and sqlite_stat3 histogram data is available
drhac8eb112011-03-17 01:58:21 +00002652** for that index. When pExpr==NULL that means the constraint is
2653** "x IS NULL" instead of "x=VALUE".
drh82759752011-01-20 16:52:09 +00002654**
drh0c50fa02011-01-21 16:27:18 +00002655** Write the estimated row count into *pnRow and return SQLITE_OK.
2656** If unable to make an estimate, leave *pnRow unchanged and return
2657** non-zero.
drh9b3eb0a2011-01-21 14:37:04 +00002658**
2659** This routine can fail if it is unable to load a collating sequence
2660** required for string comparison, or if unable to allocate memory
2661** for a UTF conversion required for comparison. The error is stored
2662** in the pParse structure.
drh82759752011-01-20 16:52:09 +00002663*/
drh041e09f2011-04-07 19:56:21 +00002664static int whereEqualScanEst(
drh82759752011-01-20 16:52:09 +00002665 Parse *pParse, /* Parsing & code generating context */
dan7a419232013-08-06 20:01:43 +00002666 WhereLoopBuilder *pBuilder,
drh0c50fa02011-01-21 16:27:18 +00002667 Expr *pExpr, /* Expression for VALUE in the x=VALUE constraint */
drhb8a8e8a2013-06-10 19:12:39 +00002668 tRowcnt *pnRow /* Write the revised row estimate here */
drh82759752011-01-20 16:52:09 +00002669){
dan7a419232013-08-06 20:01:43 +00002670 Index *p = pBuilder->pNew->u.btree.pIndex;
2671 int nEq = pBuilder->pNew->u.btree.nEq;
2672 UnpackedRecord *pRec = pBuilder->pRec;
drh82759752011-01-20 16:52:09 +00002673 u8 aff; /* Column affinity */
2674 int rc; /* Subfunction return code */
drhfaacf172011-08-12 01:51:45 +00002675 tRowcnt a[2]; /* Statistics */
dan7a419232013-08-06 20:01:43 +00002676 int bOk;
drh82759752011-01-20 16:52:09 +00002677
dan7a419232013-08-06 20:01:43 +00002678 assert( nEq>=1 );
danfd984b82014-06-30 18:02:20 +00002679 assert( nEq<=p->nColumn );
drh82759752011-01-20 16:52:09 +00002680 assert( p->aSample!=0 );
drh5c624862011-09-22 18:46:34 +00002681 assert( p->nSample>0 );
dan7a419232013-08-06 20:01:43 +00002682 assert( pBuilder->nRecValid<nEq );
2683
2684 /* If values are not available for all fields of the index to the left
2685 ** of this one, no estimate can be made. Return SQLITE_NOTFOUND. */
2686 if( pBuilder->nRecValid<(nEq-1) ){
2687 return SQLITE_NOTFOUND;
drh1f9c7662011-03-17 01:34:26 +00002688 }
dan7a419232013-08-06 20:01:43 +00002689
dandd6e1f12013-08-10 19:08:30 +00002690 /* This is an optimization only. The call to sqlite3Stat4ProbeSetValue()
2691 ** below would return the same value. */
danfd984b82014-06-30 18:02:20 +00002692 if( nEq>=p->nColumn ){
dan7a419232013-08-06 20:01:43 +00002693 *pnRow = 1;
2694 return SQLITE_OK;
drh82759752011-01-20 16:52:09 +00002695 }
dan7a419232013-08-06 20:01:43 +00002696
daneea568d2013-08-07 19:46:15 +00002697 aff = p->pTable->aCol[p->aiColumn[nEq-1]].affinity;
dan87cd9322013-08-07 15:52:41 +00002698 rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, aff, nEq-1, &bOk);
2699 pBuilder->pRec = pRec;
dan7a419232013-08-06 20:01:43 +00002700 if( rc!=SQLITE_OK ) return rc;
2701 if( bOk==0 ) return SQLITE_NOTFOUND;
dan7a419232013-08-06 20:01:43 +00002702 pBuilder->nRecValid = nEq;
dan7a419232013-08-06 20:01:43 +00002703
danb3c02e22013-08-08 19:38:40 +00002704 whereKeyStats(pParse, p, pRec, 0, a);
drh989578e2013-10-28 14:34:35 +00002705 WHERETRACE(0x10,("equality scan regions: %d\n", (int)a[1]));
danb3c02e22013-08-08 19:38:40 +00002706 *pnRow = a[1];
daneea568d2013-08-07 19:46:15 +00002707
drh0c50fa02011-01-21 16:27:18 +00002708 return rc;
2709}
drh1435a9a2013-08-27 23:15:44 +00002710#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drh0c50fa02011-01-21 16:27:18 +00002711
drh1435a9a2013-08-27 23:15:44 +00002712#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh0c50fa02011-01-21 16:27:18 +00002713/*
2714** Estimate the number of rows that will be returned based on
drh5ac06072011-01-21 18:18:13 +00002715** an IN constraint where the right-hand side of the IN operator
2716** is a list of values. Example:
2717**
2718** WHERE x IN (1,2,3,4)
drh0c50fa02011-01-21 16:27:18 +00002719**
2720** Write the estimated row count into *pnRow and return SQLITE_OK.
2721** If unable to make an estimate, leave *pnRow unchanged and return
2722** non-zero.
2723**
2724** This routine can fail if it is unable to load a collating sequence
2725** required for string comparison, or if unable to allocate memory
2726** for a UTF conversion required for comparison. The error is stored
2727** in the pParse structure.
2728*/
drh041e09f2011-04-07 19:56:21 +00002729static int whereInScanEst(
drh0c50fa02011-01-21 16:27:18 +00002730 Parse *pParse, /* Parsing & code generating context */
dan7a419232013-08-06 20:01:43 +00002731 WhereLoopBuilder *pBuilder,
drh0c50fa02011-01-21 16:27:18 +00002732 ExprList *pList, /* The value list on the RHS of "x IN (v1,v2,v3,...)" */
drhb8a8e8a2013-06-10 19:12:39 +00002733 tRowcnt *pnRow /* Write the revised row estimate here */
drh0c50fa02011-01-21 16:27:18 +00002734){
dan7a419232013-08-06 20:01:43 +00002735 Index *p = pBuilder->pNew->u.btree.pIndex;
dancfc9df72014-04-25 15:01:01 +00002736 i64 nRow0 = sqlite3LogEstToInt(p->aiRowLogEst[0]);
dan7a419232013-08-06 20:01:43 +00002737 int nRecValid = pBuilder->nRecValid;
drhb8a8e8a2013-06-10 19:12:39 +00002738 int rc = SQLITE_OK; /* Subfunction return code */
2739 tRowcnt nEst; /* Number of rows for a single term */
2740 tRowcnt nRowEst = 0; /* New estimate of the number of rows */
2741 int i; /* Loop counter */
drh0c50fa02011-01-21 16:27:18 +00002742
2743 assert( p->aSample!=0 );
drhfaacf172011-08-12 01:51:45 +00002744 for(i=0; rc==SQLITE_OK && i<pList->nExpr; i++){
dancfc9df72014-04-25 15:01:01 +00002745 nEst = nRow0;
dan7a419232013-08-06 20:01:43 +00002746 rc = whereEqualScanEst(pParse, pBuilder, pList->a[i].pExpr, &nEst);
drhfaacf172011-08-12 01:51:45 +00002747 nRowEst += nEst;
dan7a419232013-08-06 20:01:43 +00002748 pBuilder->nRecValid = nRecValid;
drh0c50fa02011-01-21 16:27:18 +00002749 }
dan7a419232013-08-06 20:01:43 +00002750
drh0c50fa02011-01-21 16:27:18 +00002751 if( rc==SQLITE_OK ){
dancfc9df72014-04-25 15:01:01 +00002752 if( nRowEst > nRow0 ) nRowEst = nRow0;
drh0c50fa02011-01-21 16:27:18 +00002753 *pnRow = nRowEst;
drh5418b122014-08-28 13:42:13 +00002754 WHERETRACE(0x10,("IN row estimate: est=%d\n", nRowEst));
drh0c50fa02011-01-21 16:27:18 +00002755 }
dan7a419232013-08-06 20:01:43 +00002756 assert( pBuilder->nRecValid==nRecValid );
drh0c50fa02011-01-21 16:27:18 +00002757 return rc;
drh82759752011-01-20 16:52:09 +00002758}
drh1435a9a2013-08-27 23:15:44 +00002759#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drh82759752011-01-20 16:52:09 +00002760
drh46c35f92012-09-26 23:17:01 +00002761/*
drh2ffb1182004-07-19 19:14:01 +00002762** Disable a term in the WHERE clause. Except, do not disable the term
2763** if it controls a LEFT OUTER JOIN and it did not originate in the ON
2764** or USING clause of that join.
2765**
2766** Consider the term t2.z='ok' in the following queries:
2767**
2768** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
2769** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
2770** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
2771**
drh23bf66d2004-12-14 03:34:34 +00002772** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00002773** in the ON clause. The term is disabled in (3) because it is not part
2774** of a LEFT OUTER JOIN. In (1), the term is not disabled.
2775**
2776** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00002777** of the join. Disabling is an optimization. When terms are satisfied
2778** by indices, we disable them to prevent redundant tests in the inner
2779** loop. We would get the correct results if nothing were ever disabled,
2780** but joins might run a little slower. The trick is to disable as much
2781** as we can without disabling too much. If we disabled in (1), we'd get
2782** the wrong answer. See ticket #813.
drh8f1a7ed2015-03-06 19:47:38 +00002783**
2784** If all the children of a term are disabled, then that term is also
2785** automatically disabled. In this way, terms get disabled if derived
2786** virtual terms are tested first. For example:
2787**
2788** x GLOB 'abc*' AND x>='abc' AND x<'acd'
2789** \___________/ \______/ \_____/
2790** parent child1 child2
2791**
2792** Only the parent term was in the original WHERE clause. The child1
2793** and child2 terms were added by the LIKE optimization. If both of
2794** the virtual child terms are valid, then testing of the parent can be
2795** skipped.
drha9c18a92015-03-06 20:49:52 +00002796**
2797** Usually the parent term is marked as TERM_CODED. But if the parent
2798** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
2799** The TERM_LIKECOND marking indicates that the term should be coded inside
2800** a conditional such that is only evaluated on the second pass of a
2801** LIKE-optimization loop, when scanning BLOBs instead of strings.
drh2ffb1182004-07-19 19:14:01 +00002802*/
drh0fcef5e2005-07-19 17:38:22 +00002803static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
drh8f1a7ed2015-03-06 19:47:38 +00002804 int nLoop = 0;
2805 while( pTerm
drhbe837bd2010-04-30 21:03:24 +00002806 && (pTerm->wtFlags & TERM_CODED)==0
drh0fcef5e2005-07-19 17:38:22 +00002807 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
drh0259bc32013-09-09 19:37:46 +00002808 && (pLevel->notReady & pTerm->prereqAll)==0
drh0fcef5e2005-07-19 17:38:22 +00002809 ){
drh8f1a7ed2015-03-06 19:47:38 +00002810 if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
2811 pTerm->wtFlags |= TERM_LIKECOND;
2812 }else{
2813 pTerm->wtFlags |= TERM_CODED;
drh0fcef5e2005-07-19 17:38:22 +00002814 }
drh8f1a7ed2015-03-06 19:47:38 +00002815 if( pTerm->iParent<0 ) break;
2816 pTerm = &pTerm->pWC->a[pTerm->iParent];
2817 pTerm->nChild--;
2818 if( pTerm->nChild!=0 ) break;
2819 nLoop++;
drh2ffb1182004-07-19 19:14:01 +00002820 }
2821}
2822
2823/*
dan69f8bb92009-08-13 19:21:16 +00002824** Code an OP_Affinity opcode to apply the column affinity string zAff
2825** to the n registers starting at base.
2826**
drh05883a32015-06-02 15:32:08 +00002827** As an optimization, SQLITE_AFF_BLOB entries (which are no-ops) at the
drh039fc322009-11-17 18:31:47 +00002828** beginning and end of zAff are ignored. If all entries in zAff are
drh05883a32015-06-02 15:32:08 +00002829** SQLITE_AFF_BLOB, then no code gets generated.
drh039fc322009-11-17 18:31:47 +00002830**
2831** This routine makes its own copy of zAff so that the caller is free
2832** to modify zAff after this routine returns.
drh94a11212004-09-25 13:12:14 +00002833*/
dan69f8bb92009-08-13 19:21:16 +00002834static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
2835 Vdbe *v = pParse->pVdbe;
drh039fc322009-11-17 18:31:47 +00002836 if( zAff==0 ){
2837 assert( pParse->db->mallocFailed );
2838 return;
2839 }
dan69f8bb92009-08-13 19:21:16 +00002840 assert( v!=0 );
drh039fc322009-11-17 18:31:47 +00002841
drh05883a32015-06-02 15:32:08 +00002842 /* Adjust base and n to skip over SQLITE_AFF_BLOB entries at the beginning
drh039fc322009-11-17 18:31:47 +00002843 ** and end of the affinity string.
2844 */
drh05883a32015-06-02 15:32:08 +00002845 while( n>0 && zAff[0]==SQLITE_AFF_BLOB ){
drh039fc322009-11-17 18:31:47 +00002846 n--;
2847 base++;
2848 zAff++;
2849 }
drh05883a32015-06-02 15:32:08 +00002850 while( n>1 && zAff[n-1]==SQLITE_AFF_BLOB ){
drh039fc322009-11-17 18:31:47 +00002851 n--;
2852 }
2853
2854 /* Code the OP_Affinity opcode if there is anything left to do. */
2855 if( n>0 ){
2856 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
2857 sqlite3VdbeChangeP4(v, -1, zAff, n);
2858 sqlite3ExprCacheAffinityChange(pParse, base, n);
2859 }
drh94a11212004-09-25 13:12:14 +00002860}
2861
drhe8b97272005-07-19 22:22:12 +00002862
2863/*
drh51147ba2005-07-23 22:59:55 +00002864** Generate code for a single equality term of the WHERE clause. An equality
2865** term can be either X=expr or X IN (...). pTerm is the term to be
2866** coded.
2867**
drh1db639c2008-01-17 02:36:28 +00002868** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00002869**
2870** For a constraint of the form X=expr, the expression is evaluated and its
2871** result is left on the stack. For constraints of the form X IN (...)
2872** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00002873*/
drh678ccce2008-03-31 18:19:54 +00002874static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00002875 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00002876 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh0fe456b2013-03-12 18:34:50 +00002877 WhereLevel *pLevel, /* The level of the FROM clause we are working on */
2878 int iEq, /* Index of the equality term within this level */
drh7ba39a92013-05-30 17:43:19 +00002879 int bRev, /* True for reverse-order IN operations */
drh678ccce2008-03-31 18:19:54 +00002880 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00002881){
drh0fcef5e2005-07-19 17:38:22 +00002882 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00002883 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00002884 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00002885
danielk19772d605492008-10-01 08:43:03 +00002886 assert( iTarget>0 );
drhfcd49532015-05-13 15:24:07 +00002887 if( pX->op==TK_EQ || pX->op==TK_IS ){
drh678ccce2008-03-31 18:19:54 +00002888 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00002889 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00002890 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00002891 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00002892#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00002893 }else{
danielk19779a96b662007-11-29 17:05:18 +00002894 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00002895 int iTab;
drh72e8fa42007-03-28 14:30:06 +00002896 struct InLoop *pIn;
drh7ba39a92013-05-30 17:43:19 +00002897 WhereLoop *pLoop = pLevel->pWLoop;
danielk1977b3bce662005-01-29 08:32:43 +00002898
drh7ba39a92013-05-30 17:43:19 +00002899 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
2900 && pLoop->u.btree.pIndex!=0
2901 && pLoop->u.btree.pIndex->aSortOrder[iEq]
drhd3832162013-03-12 18:49:25 +00002902 ){
drh725e1ae2013-03-12 23:58:42 +00002903 testcase( iEq==0 );
drh725e1ae2013-03-12 23:58:42 +00002904 testcase( bRev );
drh1ccce442013-03-12 20:38:51 +00002905 bRev = !bRev;
drh0fe456b2013-03-12 18:34:50 +00002906 }
drh50b39962006-10-28 00:28:09 +00002907 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00002908 iReg = iTarget;
drh3a856252014-08-01 14:46:57 +00002909 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0);
drh725e1ae2013-03-12 23:58:42 +00002910 if( eType==IN_INDEX_INDEX_DESC ){
2911 testcase( bRev );
2912 bRev = !bRev;
2913 }
danielk1977b3bce662005-01-29 08:32:43 +00002914 iTab = pX->iTable;
drh7d176102014-02-18 03:07:12 +00002915 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
2916 VdbeCoverageIf(v, bRev);
2917 VdbeCoverageIf(v, !bRev);
drh6fa978d2013-05-30 19:29:19 +00002918 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
2919 pLoop->wsFlags |= WHERE_IN_ABLE;
drh111a6a72008-12-21 03:51:16 +00002920 if( pLevel->u.in.nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00002921 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00002922 }
drh111a6a72008-12-21 03:51:16 +00002923 pLevel->u.in.nIn++;
2924 pLevel->u.in.aInLoop =
2925 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
2926 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
2927 pIn = pLevel->u.in.aInLoop;
drh72e8fa42007-03-28 14:30:06 +00002928 if( pIn ){
drh111a6a72008-12-21 03:51:16 +00002929 pIn += pLevel->u.in.nIn - 1;
drh72e8fa42007-03-28 14:30:06 +00002930 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00002931 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00002932 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00002933 }else{
drhb3190c12008-12-08 21:37:14 +00002934 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00002935 }
drhf93cd942013-11-21 03:12:25 +00002936 pIn->eEndLoopOp = bRev ? OP_PrevIfOpen : OP_NextIfOpen;
drh688852a2014-02-17 22:40:43 +00002937 sqlite3VdbeAddOp1(v, OP_IsNull, iReg); VdbeCoverage(v);
drha6110402005-07-28 20:51:19 +00002938 }else{
drh111a6a72008-12-21 03:51:16 +00002939 pLevel->u.in.nIn = 0;
drhe23399f2005-07-22 00:31:39 +00002940 }
danielk1977b3bce662005-01-29 08:32:43 +00002941#endif
drh94a11212004-09-25 13:12:14 +00002942 }
drh0fcef5e2005-07-19 17:38:22 +00002943 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00002944 return iReg;
drh94a11212004-09-25 13:12:14 +00002945}
2946
drh51147ba2005-07-23 22:59:55 +00002947/*
2948** Generate code that will evaluate all == and IN constraints for an
drhcd8629e2013-11-13 12:27:25 +00002949** index scan.
drh51147ba2005-07-23 22:59:55 +00002950**
2951** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
2952** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
2953** The index has as many as three equality constraints, but in this
2954** example, the third "c" value is an inequality. So only two
2955** constraints are coded. This routine will generate code to evaluate
drh6df2acd2008-12-28 16:55:25 +00002956** a==5 and b IN (1,2,3). The current values for a and b will be stored
2957** in consecutive registers and the index of the first register is returned.
drh51147ba2005-07-23 22:59:55 +00002958**
2959** In the example above nEq==2. But this subroutine works for any value
2960** of nEq including 0. If nEq==0, this routine is nearly a no-op.
drh039fc322009-11-17 18:31:47 +00002961** The only thing it does is allocate the pLevel->iMem memory cell and
2962** compute the affinity string.
drh51147ba2005-07-23 22:59:55 +00002963**
drhcd8629e2013-11-13 12:27:25 +00002964** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
2965** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
2966** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
2967** occurs after the nEq quality constraints.
2968**
2969** This routine allocates a range of nEq+nExtraReg memory cells and returns
2970** the index of the first memory cell in that range. The code that
2971** calls this routine will use that memory range to store keys for
2972** start and termination conditions of the loop.
drh51147ba2005-07-23 22:59:55 +00002973** key value of the loop. If one or more IN operators appear, then
2974** this routine allocates an additional nEq memory cells for internal
2975** use.
dan69f8bb92009-08-13 19:21:16 +00002976**
2977** Before returning, *pzAff is set to point to a buffer containing a
2978** copy of the column affinity string of the index allocated using
2979** sqlite3DbMalloc(). Except, entries in the copy of the string associated
drh05883a32015-06-02 15:32:08 +00002980** with equality constraints that use BLOB or NONE affinity are set to
2981** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
dan69f8bb92009-08-13 19:21:16 +00002982**
2983** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
2984** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
2985**
2986** In the example above, the index on t1(a) has TEXT affinity. But since
drh05883a32015-06-02 15:32:08 +00002987** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
dan69f8bb92009-08-13 19:21:16 +00002988** no conversion should be attempted before using a t2.b value as part of
2989** a key to search the index. Hence the first byte in the returned affinity
drh05883a32015-06-02 15:32:08 +00002990** string in this example would be set to SQLITE_AFF_BLOB.
drh51147ba2005-07-23 22:59:55 +00002991*/
drh1db639c2008-01-17 02:36:28 +00002992static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00002993 Parse *pParse, /* Parsing context */
2994 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
drh7ba39a92013-05-30 17:43:19 +00002995 int bRev, /* Reverse the order of IN operators */
dan69f8bb92009-08-13 19:21:16 +00002996 int nExtraReg, /* Number of extra registers to allocate */
2997 char **pzAff /* OUT: Set to point to affinity string */
drh51147ba2005-07-23 22:59:55 +00002998){
drhcd8629e2013-11-13 12:27:25 +00002999 u16 nEq; /* The number of == or IN constraints to code */
3000 u16 nSkip; /* Number of left-most columns to skip */
drh111a6a72008-12-21 03:51:16 +00003001 Vdbe *v = pParse->pVdbe; /* The vm under construction */
3002 Index *pIdx; /* The index being used for this loop */
drh51147ba2005-07-23 22:59:55 +00003003 WhereTerm *pTerm; /* A single constraint term */
drh7ba39a92013-05-30 17:43:19 +00003004 WhereLoop *pLoop; /* The WhereLoop object */
drh51147ba2005-07-23 22:59:55 +00003005 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00003006 int regBase; /* Base register */
drh6df2acd2008-12-28 16:55:25 +00003007 int nReg; /* Number of registers to allocate */
dan69f8bb92009-08-13 19:21:16 +00003008 char *zAff; /* Affinity string to return */
drh51147ba2005-07-23 22:59:55 +00003009
drh111a6a72008-12-21 03:51:16 +00003010 /* This module is only called on query plans that use an index. */
drh7ba39a92013-05-30 17:43:19 +00003011 pLoop = pLevel->pWLoop;
3012 assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
3013 nEq = pLoop->u.btree.nEq;
drhc8bbce12014-10-21 01:05:09 +00003014 nSkip = pLoop->nSkip;
drh7ba39a92013-05-30 17:43:19 +00003015 pIdx = pLoop->u.btree.pIndex;
3016 assert( pIdx!=0 );
drh111a6a72008-12-21 03:51:16 +00003017
drh51147ba2005-07-23 22:59:55 +00003018 /* Figure out how many memory cells we will need then allocate them.
drh51147ba2005-07-23 22:59:55 +00003019 */
drh700a2262008-12-17 19:22:15 +00003020 regBase = pParse->nMem + 1;
drh7ba39a92013-05-30 17:43:19 +00003021 nReg = pLoop->u.btree.nEq + nExtraReg;
drh6df2acd2008-12-28 16:55:25 +00003022 pParse->nMem += nReg;
drh51147ba2005-07-23 22:59:55 +00003023
dan69f8bb92009-08-13 19:21:16 +00003024 zAff = sqlite3DbStrDup(pParse->db, sqlite3IndexAffinityStr(v, pIdx));
3025 if( !zAff ){
3026 pParse->db->mallocFailed = 1;
3027 }
3028
drhcd8629e2013-11-13 12:27:25 +00003029 if( nSkip ){
3030 int iIdxCur = pLevel->iIdxCur;
drh7d176102014-02-18 03:07:12 +00003031 sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
3032 VdbeCoverageIf(v, bRev==0);
3033 VdbeCoverageIf(v, bRev!=0);
drhe084f402013-11-13 17:24:38 +00003034 VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
drh2e5ef4e2013-11-13 16:58:54 +00003035 j = sqlite3VdbeAddOp0(v, OP_Goto);
drh4a1d3652014-02-14 15:13:36 +00003036 pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
drh7d176102014-02-18 03:07:12 +00003037 iIdxCur, 0, regBase, nSkip);
3038 VdbeCoverageIf(v, bRev==0);
3039 VdbeCoverageIf(v, bRev!=0);
drh2e5ef4e2013-11-13 16:58:54 +00003040 sqlite3VdbeJumpHere(v, j);
drhcd8629e2013-11-13 12:27:25 +00003041 for(j=0; j<nSkip; j++){
3042 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
3043 assert( pIdx->aiColumn[j]>=0 );
3044 VdbeComment((v, "%s", pIdx->pTable->aCol[pIdx->aiColumn[j]].zName));
3045 }
3046 }
3047
drh51147ba2005-07-23 22:59:55 +00003048 /* Evaluate the equality constraints
3049 */
mistachkinf6418892013-08-28 01:54:12 +00003050 assert( zAff==0 || (int)strlen(zAff)>=nEq );
drhcd8629e2013-11-13 12:27:25 +00003051 for(j=nSkip; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00003052 int r1;
drh4efc9292013-06-06 23:02:03 +00003053 pTerm = pLoop->aLTerm[j];
drh7ba39a92013-05-30 17:43:19 +00003054 assert( pTerm!=0 );
drhcd8629e2013-11-13 12:27:25 +00003055 /* The following testcase is true for indices with redundant columns.
drhbe837bd2010-04-30 21:03:24 +00003056 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
3057 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
drh39759742013-08-02 23:40:45 +00003058 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh7ba39a92013-05-30 17:43:19 +00003059 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
drh678ccce2008-03-31 18:19:54 +00003060 if( r1!=regBase+j ){
drh6df2acd2008-12-28 16:55:25 +00003061 if( nReg==1 ){
3062 sqlite3ReleaseTempReg(pParse, regBase);
3063 regBase = r1;
3064 }else{
3065 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
3066 }
drh678ccce2008-03-31 18:19:54 +00003067 }
drh981642f2008-04-19 14:40:43 +00003068 testcase( pTerm->eOperator & WO_ISNULL );
3069 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00003070 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drh039fc322009-11-17 18:31:47 +00003071 Expr *pRight = pTerm->pExpr->pRight;
drh9be18702015-05-13 19:33:41 +00003072 if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
drh7d176102014-02-18 03:07:12 +00003073 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
3074 VdbeCoverage(v);
3075 }
drh039fc322009-11-17 18:31:47 +00003076 if( zAff ){
drh05883a32015-06-02 15:32:08 +00003077 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
3078 zAff[j] = SQLITE_AFF_BLOB;
drh039fc322009-11-17 18:31:47 +00003079 }
3080 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
drh05883a32015-06-02 15:32:08 +00003081 zAff[j] = SQLITE_AFF_BLOB;
drh039fc322009-11-17 18:31:47 +00003082 }
dan69f8bb92009-08-13 19:21:16 +00003083 }
drh51147ba2005-07-23 22:59:55 +00003084 }
3085 }
dan69f8bb92009-08-13 19:21:16 +00003086 *pzAff = zAff;
drh1db639c2008-01-17 02:36:28 +00003087 return regBase;
drh51147ba2005-07-23 22:59:55 +00003088}
3089
dan6f9702e2014-11-01 20:38:06 +00003090#ifndef SQLITE_OMIT_EXPLAIN
dan17c0bc02010-11-09 17:35:19 +00003091/*
drh69174c42010-11-12 15:35:59 +00003092** This routine is a helper for explainIndexRange() below
3093**
3094** pStr holds the text of an expression that we are building up one term
3095** at a time. This routine adds a new term to the end of the expression.
3096** Terms are separated by AND so add the "AND" text for second and subsequent
3097** terms only.
3098*/
3099static void explainAppendTerm(
3100 StrAccum *pStr, /* The text expression being built */
3101 int iTerm, /* Index of this term. First is zero */
3102 const char *zColumn, /* Name of the column */
3103 const char *zOp /* Name of the operator */
3104){
3105 if( iTerm ) sqlite3StrAccumAppend(pStr, " AND ", 5);
drha6353a32013-12-09 19:03:26 +00003106 sqlite3StrAccumAppendAll(pStr, zColumn);
drh69174c42010-11-12 15:35:59 +00003107 sqlite3StrAccumAppend(pStr, zOp, 1);
3108 sqlite3StrAccumAppend(pStr, "?", 1);
3109}
3110
3111/*
dan17c0bc02010-11-09 17:35:19 +00003112** Argument pLevel describes a strategy for scanning table pTab. This
drh6c977892014-10-10 15:47:46 +00003113** function appends text to pStr that describes the subset of table
3114** rows scanned by the strategy in the form of an SQL expression.
dan17c0bc02010-11-09 17:35:19 +00003115**
3116** For example, if the query:
3117**
3118** SELECT * FROM t1 WHERE a=1 AND b>2;
3119**
3120** is run and there is an index on (a, b), then this function returns a
3121** string similar to:
3122**
3123** "a=? AND b>?"
dan17c0bc02010-11-09 17:35:19 +00003124*/
drh1f8817c2014-10-10 19:15:35 +00003125static void explainIndexRange(StrAccum *pStr, WhereLoop *pLoop, Table *pTab){
drhef866372013-05-22 20:49:02 +00003126 Index *pIndex = pLoop->u.btree.pIndex;
drhcd8629e2013-11-13 12:27:25 +00003127 u16 nEq = pLoop->u.btree.nEq;
drhc8bbce12014-10-21 01:05:09 +00003128 u16 nSkip = pLoop->nSkip;
drh69174c42010-11-12 15:35:59 +00003129 int i, j;
3130 Column *aCol = pTab->aCol;
drhbbbdc832013-10-22 18:01:40 +00003131 i16 *aiColumn = pIndex->aiColumn;
dan2ce22452010-11-08 19:01:16 +00003132
drh6c977892014-10-10 15:47:46 +00003133 if( nEq==0 && (pLoop->wsFlags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ) return;
3134 sqlite3StrAccumAppend(pStr, " (", 2);
dan2ce22452010-11-08 19:01:16 +00003135 for(i=0; i<nEq; i++){
dan39129ce2014-06-30 15:23:57 +00003136 char *z = aiColumn[i] < 0 ? "rowid" : aCol[aiColumn[i]].zName;
drhcd8629e2013-11-13 12:27:25 +00003137 if( i>=nSkip ){
drh6c977892014-10-10 15:47:46 +00003138 explainAppendTerm(pStr, i, z, "=");
drhcd8629e2013-11-13 12:27:25 +00003139 }else{
drh6c977892014-10-10 15:47:46 +00003140 if( i ) sqlite3StrAccumAppend(pStr, " AND ", 5);
3141 sqlite3XPrintf(pStr, 0, "ANY(%s)", z);
drhcd8629e2013-11-13 12:27:25 +00003142 }
dan2ce22452010-11-08 19:01:16 +00003143 }
3144
drh69174c42010-11-12 15:35:59 +00003145 j = i;
drhef866372013-05-22 20:49:02 +00003146 if( pLoop->wsFlags&WHERE_BTM_LIMIT ){
dan39129ce2014-06-30 15:23:57 +00003147 char *z = aiColumn[j] < 0 ? "rowid" : aCol[aiColumn[j]].zName;
drh6c977892014-10-10 15:47:46 +00003148 explainAppendTerm(pStr, i++, z, ">");
dan2ce22452010-11-08 19:01:16 +00003149 }
drhef866372013-05-22 20:49:02 +00003150 if( pLoop->wsFlags&WHERE_TOP_LIMIT ){
dan39129ce2014-06-30 15:23:57 +00003151 char *z = aiColumn[j] < 0 ? "rowid" : aCol[aiColumn[j]].zName;
drh6c977892014-10-10 15:47:46 +00003152 explainAppendTerm(pStr, i, z, "<");
dan2ce22452010-11-08 19:01:16 +00003153 }
drh6c977892014-10-10 15:47:46 +00003154 sqlite3StrAccumAppend(pStr, ")", 1);
dan2ce22452010-11-08 19:01:16 +00003155}
3156
dan17c0bc02010-11-09 17:35:19 +00003157/*
3158** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
dan037b5322014-11-03 11:25:32 +00003159** command, or if either SQLITE_DEBUG or SQLITE_ENABLE_STMT_SCANSTATUS was
3160** defined at compile-time. If it is not a no-op, a single OP_Explain opcode
3161** is added to the output to describe the table scan strategy in pLevel.
3162**
3163** If an OP_Explain opcode is added to the VM, its address is returned.
3164** Otherwise, if no OP_Explain is coded, zero is returned.
dan17c0bc02010-11-09 17:35:19 +00003165*/
dan6f9702e2014-11-01 20:38:06 +00003166static int explainOneScan(
dan2ce22452010-11-08 19:01:16 +00003167 Parse *pParse, /* Parse context */
3168 SrcList *pTabList, /* Table list this loop refers to */
dan6f9702e2014-11-01 20:38:06 +00003169 WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
dan2ce22452010-11-08 19:01:16 +00003170 int iLevel, /* Value for "level" column of output */
dan6f9702e2014-11-01 20:38:06 +00003171 int iFrom, /* Value for "from" column of output */
dan4a07e3d2010-11-09 14:48:59 +00003172 u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
dan2ce22452010-11-08 19:01:16 +00003173){
dan6f9702e2014-11-01 20:38:06 +00003174 int ret = 0;
dan43764a82014-11-01 21:00:04 +00003175#if !defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
drh84e55a82013-11-13 17:58:23 +00003176 if( pParse->explain==2 )
3177#endif
3178 {
dan2ce22452010-11-08 19:01:16 +00003179 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
dan17c0bc02010-11-09 17:35:19 +00003180 Vdbe *v = pParse->pVdbe; /* VM being constructed */
3181 sqlite3 *db = pParse->db; /* Database handle */
dan6f9702e2014-11-01 20:38:06 +00003182 int iId = pParse->iSelectId; /* Select id (left-most output column) */
dan4bc39fa2010-11-13 16:42:27 +00003183 int isSearch; /* True for a SEARCH. False for SCAN. */
drhef866372013-05-22 20:49:02 +00003184 WhereLoop *pLoop; /* The controlling WhereLoop object */
3185 u32 flags; /* Flags that describe this loop */
dan6f9702e2014-11-01 20:38:06 +00003186 char *zMsg; /* Text to add to EQP output */
drh6c977892014-10-10 15:47:46 +00003187 StrAccum str; /* EQP output string */
3188 char zBuf[100]; /* Initial space for EQP output string */
dan2ce22452010-11-08 19:01:16 +00003189
drhef866372013-05-22 20:49:02 +00003190 pLoop = pLevel->pWLoop;
3191 flags = pLoop->wsFlags;
dan6f9702e2014-11-01 20:38:06 +00003192 if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_ONETABLE_ONLY) ) return 0;
dan2ce22452010-11-08 19:01:16 +00003193
drhef866372013-05-22 20:49:02 +00003194 isSearch = (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
3195 || ((flags&WHERE_VIRTUALTABLE)==0 && (pLoop->u.btree.nEq>0))
3196 || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
dan6f9702e2014-11-01 20:38:06 +00003197
drhc0490572015-05-02 11:45:53 +00003198 sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
drh6c977892014-10-10 15:47:46 +00003199 sqlite3StrAccumAppendAll(&str, isSearch ? "SEARCH" : "SCAN");
dan4a07e3d2010-11-09 14:48:59 +00003200 if( pItem->pSelect ){
drh6c977892014-10-10 15:47:46 +00003201 sqlite3XPrintf(&str, 0, " SUBQUERY %d", pItem->iSelectId);
dan4a07e3d2010-11-09 14:48:59 +00003202 }else{
drh6c977892014-10-10 15:47:46 +00003203 sqlite3XPrintf(&str, 0, " TABLE %s", pItem->zName);
dan4a07e3d2010-11-09 14:48:59 +00003204 }
3205
dan2ce22452010-11-08 19:01:16 +00003206 if( pItem->zAlias ){
drh6c977892014-10-10 15:47:46 +00003207 sqlite3XPrintf(&str, 0, " AS %s", pItem->zAlias);
dan2ce22452010-11-08 19:01:16 +00003208 }
drh6c977892014-10-10 15:47:46 +00003209 if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
3210 const char *zFmt = 0;
3211 Index *pIdx;
3212
3213 assert( pLoop->u.btree.pIndex!=0 );
3214 pIdx = pLoop->u.btree.pIndex;
dane96f2df2014-05-23 17:17:06 +00003215 assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
drh48dd1d82014-05-27 18:18:58 +00003216 if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
drhc631faa2014-10-11 01:22:16 +00003217 if( isSearch ){
drh6c977892014-10-10 15:47:46 +00003218 zFmt = "PRIMARY KEY";
3219 }
drh051575c2014-10-25 12:28:25 +00003220 }else if( flags & WHERE_PARTIALIDX ){
3221 zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
dane96f2df2014-05-23 17:17:06 +00003222 }else if( flags & WHERE_AUTO_INDEX ){
drh6c977892014-10-10 15:47:46 +00003223 zFmt = "AUTOMATIC COVERING INDEX";
dane96f2df2014-05-23 17:17:06 +00003224 }else if( flags & WHERE_IDX_ONLY ){
drh6c977892014-10-10 15:47:46 +00003225 zFmt = "COVERING INDEX %s";
dane96f2df2014-05-23 17:17:06 +00003226 }else{
drh6c977892014-10-10 15:47:46 +00003227 zFmt = "INDEX %s";
dane96f2df2014-05-23 17:17:06 +00003228 }
drh6c977892014-10-10 15:47:46 +00003229 if( zFmt ){
3230 sqlite3StrAccumAppend(&str, " USING ", 7);
3231 sqlite3XPrintf(&str, 0, zFmt, pIdx->zName);
3232 explainIndexRange(&str, pLoop, pItem->pTab);
3233 }
drhef71c1f2013-06-04 12:58:02 +00003234 }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
drh6c977892014-10-10 15:47:46 +00003235 const char *zRange;
drh8e23daf2013-06-11 13:30:04 +00003236 if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
drh6c977892014-10-10 15:47:46 +00003237 zRange = "(rowid=?)";
drh04098e62010-11-15 21:50:19 +00003238 }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
drh6c977892014-10-10 15:47:46 +00003239 zRange = "(rowid>? AND rowid<?)";
dan2ce22452010-11-08 19:01:16 +00003240 }else if( flags&WHERE_BTM_LIMIT ){
drh6c977892014-10-10 15:47:46 +00003241 zRange = "(rowid>?)";
3242 }else{
3243 assert( flags&WHERE_TOP_LIMIT);
3244 zRange = "(rowid<?)";
dan2ce22452010-11-08 19:01:16 +00003245 }
drh6c977892014-10-10 15:47:46 +00003246 sqlite3StrAccumAppendAll(&str, " USING INTEGER PRIMARY KEY ");
3247 sqlite3StrAccumAppendAll(&str, zRange);
dan2ce22452010-11-08 19:01:16 +00003248 }
3249#ifndef SQLITE_OMIT_VIRTUALTABLE
3250 else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
drh6c977892014-10-10 15:47:46 +00003251 sqlite3XPrintf(&str, 0, " VIRTUAL TABLE INDEX %d:%s",
drhef866372013-05-22 20:49:02 +00003252 pLoop->u.vtab.idxNum, pLoop->u.vtab.idxStr);
dan2ce22452010-11-08 19:01:16 +00003253 }
3254#endif
drh98545bb2014-10-10 17:20:39 +00003255#ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
dan6f9702e2014-11-01 20:38:06 +00003256 if( pLoop->nOut>=10 ){
3257 sqlite3XPrintf(&str, 0, " (~%llu rows)", sqlite3LogEstToInt(pLoop->nOut));
3258 }else{
3259 sqlite3StrAccumAppend(&str, " (~1 row)", 9);
dan04489b62014-10-31 20:11:32 +00003260 }
dan6f9702e2014-11-01 20:38:06 +00003261#endif
3262 zMsg = sqlite3StrAccumFinish(&str);
3263 ret = sqlite3VdbeAddOp4(v, OP_Explain, iId, iLevel, iFrom, zMsg,P4_DYNAMIC);
dan2ce22452010-11-08 19:01:16 +00003264 }
dan6f9702e2014-11-01 20:38:06 +00003265 return ret;
dan2ce22452010-11-08 19:01:16 +00003266}
3267#else
dan6f9702e2014-11-01 20:38:06 +00003268# define explainOneScan(u,v,w,x,y,z) 0
3269#endif /* SQLITE_OMIT_EXPLAIN */
3270
3271#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
dan037b5322014-11-03 11:25:32 +00003272/*
3273** Configure the VM passed as the first argument with an
3274** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
3275** implement level pLvl. Argument pSrclist is a pointer to the FROM
3276** clause that the scan reads data from.
3277**
3278** If argument addrExplain is not 0, it must be the address of an
3279** OP_Explain instruction that describes the same loop.
3280*/
dan6f9702e2014-11-01 20:38:06 +00003281static void addScanStatus(
dan037b5322014-11-03 11:25:32 +00003282 Vdbe *v, /* Vdbe to add scanstatus entry to */
3283 SrcList *pSrclist, /* FROM clause pLvl reads data from */
3284 WhereLevel *pLvl, /* Level to add scanstatus() entry for */
3285 int addrExplain /* Address of OP_Explain (or 0) */
dan6f9702e2014-11-01 20:38:06 +00003286){
3287 const char *zObj = 0;
dan6f9702e2014-11-01 20:38:06 +00003288 WhereLoop *pLoop = pLvl->pWLoop;
drhcd934c32014-12-05 21:18:19 +00003289 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 && pLoop->u.btree.pIndex!=0 ){
dan6f9702e2014-11-01 20:38:06 +00003290 zObj = pLoop->u.btree.pIndex->zName;
3291 }else{
3292 zObj = pSrclist->a[pLvl->iFrom].zName;
3293 }
dan037b5322014-11-03 11:25:32 +00003294 sqlite3VdbeScanStatus(
drh518140e2014-11-06 03:55:10 +00003295 v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
dan6f9702e2014-11-01 20:38:06 +00003296 );
3297}
3298#else
dane2f771b2014-11-03 15:33:17 +00003299# define addScanStatus(a, b, c, d) ((void)d)
dan6f9702e2014-11-01 20:38:06 +00003300#endif
3301
drhf07cf6e2015-03-06 16:45:16 +00003302/*
drha40da622015-03-09 12:11:56 +00003303** If the most recently coded instruction is a constant range contraint
3304** that originated from the LIKE optimization, then change the P3 to be
drhf07cf6e2015-03-06 16:45:16 +00003305** pLoop->iLikeRepCntr and set P5.
3306**
drh16897072015-03-07 00:57:37 +00003307** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
3308** expression: "x>='ABC' AND x<'abd'". But this requires that the range
3309** scan loop run twice, once for strings and a second time for BLOBs.
3310** The OP_String opcodes on the second pass convert the upper and lower
3311** bound string contants to blobs. This routine makes the necessary changes
3312** to the OP_String opcodes for that to happen.
drhf07cf6e2015-03-06 16:45:16 +00003313*/
drh52fc05b2015-03-07 20:32:49 +00003314static void whereLikeOptimizationStringFixup(
3315 Vdbe *v, /* prepared statement under construction */
3316 WhereLevel *pLevel, /* The loop that contains the LIKE operator */
3317 WhereTerm *pTerm /* The upper or lower bound just coded */
3318){
3319 if( pTerm->wtFlags & TERM_LIKEOPT ){
drha40da622015-03-09 12:11:56 +00003320 VdbeOp *pOp;
3321 assert( pLevel->iLikeRepCntr>0 );
3322 pOp = sqlite3VdbeGetOp(v, -1);
3323 assert( pOp!=0 );
3324 assert( pOp->opcode==OP_String8
3325 || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
drhf07cf6e2015-03-06 16:45:16 +00003326 pOp->p3 = pLevel->iLikeRepCntr;
3327 pOp->p5 = 1;
3328 }
3329}
dan2ce22452010-11-08 19:01:16 +00003330
drh111a6a72008-12-21 03:51:16 +00003331/*
3332** Generate code for the start of the iLevel-th loop in the WHERE clause
3333** implementation described by pWInfo.
3334*/
3335static Bitmask codeOneLoopStart(
3336 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
3337 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh7a484802012-03-16 00:28:11 +00003338 Bitmask notReady /* Which tables are currently available */
drh111a6a72008-12-21 03:51:16 +00003339){
3340 int j, k; /* Loop counters */
3341 int iCur; /* The VDBE cursor for the table */
3342 int addrNxt; /* Where to jump to continue with the next IN case */
3343 int omitTable; /* True if we use the index only */
3344 int bRev; /* True if we need to scan in reverse order */
3345 WhereLevel *pLevel; /* The where level to be coded */
drh7ba39a92013-05-30 17:43:19 +00003346 WhereLoop *pLoop; /* The WhereLoop object being coded */
drh111a6a72008-12-21 03:51:16 +00003347 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
3348 WhereTerm *pTerm; /* A WHERE clause term */
3349 Parse *pParse; /* Parsing context */
drh6b36e822013-07-30 15:10:32 +00003350 sqlite3 *db; /* Database connection */
drh111a6a72008-12-21 03:51:16 +00003351 Vdbe *v; /* The prepared stmt under constructions */
3352 struct SrcList_item *pTabItem; /* FROM clause term being coded */
drh23d04d52008-12-23 23:56:22 +00003353 int addrBrk; /* Jump here to break out of the loop */
3354 int addrCont; /* Jump here to continue with next cycle */
drh61495262009-04-22 15:32:59 +00003355 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
3356 int iReleaseReg = 0; /* Temp register to free before returning */
drh111a6a72008-12-21 03:51:16 +00003357
3358 pParse = pWInfo->pParse;
3359 v = pParse->pVdbe;
drh70d18342013-06-06 19:16:33 +00003360 pWC = &pWInfo->sWC;
drh6b36e822013-07-30 15:10:32 +00003361 db = pParse->db;
drh111a6a72008-12-21 03:51:16 +00003362 pLevel = &pWInfo->a[iLevel];
drh7ba39a92013-05-30 17:43:19 +00003363 pLoop = pLevel->pWLoop;
drh111a6a72008-12-21 03:51:16 +00003364 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
3365 iCur = pTabItem->iCursor;
drh0259bc32013-09-09 19:37:46 +00003366 pLevel->notReady = notReady & ~getMask(&pWInfo->sMaskSet, iCur);
drh7ba39a92013-05-30 17:43:19 +00003367 bRev = (pWInfo->revMask>>iLevel)&1;
3368 omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
drh70d18342013-06-06 19:16:33 +00003369 && (pWInfo->wctrlFlags & WHERE_FORCE_TABLE)==0;
drh6bc69a22013-11-19 12:33:23 +00003370 VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
drh111a6a72008-12-21 03:51:16 +00003371
3372 /* Create labels for the "break" and "continue" instructions
3373 ** for the current loop. Jump to addrBrk to break out of a loop.
3374 ** Jump to cont to go immediately to the next iteration of the
3375 ** loop.
3376 **
3377 ** When there is an IN operator, we also have a "addrNxt" label that
3378 ** means to continue with the next IN value combination. When
3379 ** there are no IN operators in the constraints, the "addrNxt" label
3380 ** is the same as "addrBrk".
3381 */
3382 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
3383 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
3384
3385 /* If this is the right table of a LEFT OUTER JOIN, allocate and
3386 ** initialize a memory cell that records if this table matches any
3387 ** row of the left table of the join.
3388 */
3389 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
3390 pLevel->iLeftJoin = ++pParse->nMem;
3391 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
3392 VdbeComment((v, "init LEFT JOIN no-match flag"));
3393 }
3394
drh21172c42012-10-30 00:29:07 +00003395 /* Special case of a FROM clause subquery implemented as a co-routine */
3396 if( pTabItem->viaCoroutine ){
3397 int regYield = pTabItem->regReturn;
drhed71a832014-02-07 19:18:10 +00003398 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
drh81cf13e2014-02-07 18:27:53 +00003399 pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
drh688852a2014-02-17 22:40:43 +00003400 VdbeCoverage(v);
drh725de292014-02-08 13:12:19 +00003401 VdbeComment((v, "next row of \"%s\"", pTabItem->pTab->zName));
drh21172c42012-10-30 00:29:07 +00003402 pLevel->op = OP_Goto;
3403 }else
3404
drh111a6a72008-12-21 03:51:16 +00003405#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7ba39a92013-05-30 17:43:19 +00003406 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
3407 /* Case 1: The table is a virtual-table. Use the VFilter and VNext
drh111a6a72008-12-21 03:51:16 +00003408 ** to access the data.
3409 */
3410 int iReg; /* P3 Value for OP_VFilter */
drh281bbe22012-10-16 23:17:14 +00003411 int addrNotFound;
drh4efc9292013-06-06 23:02:03 +00003412 int nConstraint = pLoop->nLTerm;
drh111a6a72008-12-21 03:51:16 +00003413
drha62bb8d2009-11-23 21:23:45 +00003414 sqlite3ExprCachePush(pParse);
drh111a6a72008-12-21 03:51:16 +00003415 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
drh281bbe22012-10-16 23:17:14 +00003416 addrNotFound = pLevel->addrBrk;
drh111a6a72008-12-21 03:51:16 +00003417 for(j=0; j<nConstraint; j++){
drhe2250172013-05-31 18:13:50 +00003418 int iTarget = iReg+j+2;
drh4efc9292013-06-06 23:02:03 +00003419 pTerm = pLoop->aLTerm[j];
drh95ed68d2013-06-12 17:55:50 +00003420 if( pTerm==0 ) continue;
drh7ba39a92013-05-30 17:43:19 +00003421 if( pTerm->eOperator & WO_IN ){
3422 codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
3423 addrNotFound = pLevel->addrNxt;
3424 }else{
3425 sqlite3ExprCode(pParse, pTerm->pExpr->pRight, iTarget);
3426 }
3427 }
3428 sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
drh7e47cb82013-05-31 17:55:27 +00003429 sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
drh7ba39a92013-05-30 17:43:19 +00003430 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
3431 pLoop->u.vtab.idxStr,
3432 pLoop->u.vtab.needFree ? P4_MPRINTF : P4_STATIC);
drh688852a2014-02-17 22:40:43 +00003433 VdbeCoverage(v);
drh7ba39a92013-05-30 17:43:19 +00003434 pLoop->u.vtab.needFree = 0;
3435 for(j=0; j<nConstraint && j<16; j++){
3436 if( (pLoop->u.vtab.omitMask>>j)&1 ){
drh4efc9292013-06-06 23:02:03 +00003437 disableTerm(pLevel, pLoop->aLTerm[j]);
drh111a6a72008-12-21 03:51:16 +00003438 }
3439 }
3440 pLevel->op = OP_VNext;
3441 pLevel->p1 = iCur;
3442 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh23d04d52008-12-23 23:56:22 +00003443 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drhd2490902014-04-13 19:28:15 +00003444 sqlite3ExprCachePop(pParse);
drh111a6a72008-12-21 03:51:16 +00003445 }else
3446#endif /* SQLITE_OMIT_VIRTUALTABLE */
3447
drh7ba39a92013-05-30 17:43:19 +00003448 if( (pLoop->wsFlags & WHERE_IPK)!=0
3449 && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
3450 ){
3451 /* Case 2: We can directly reference a single row using an
drh111a6a72008-12-21 03:51:16 +00003452 ** equality comparison against the ROWID field. Or
3453 ** we reference multiple rows using a "rowid IN (...)"
3454 ** construct.
3455 */
drh7ba39a92013-05-30 17:43:19 +00003456 assert( pLoop->u.btree.nEq==1 );
drh4efc9292013-06-06 23:02:03 +00003457 pTerm = pLoop->aLTerm[0];
drh111a6a72008-12-21 03:51:16 +00003458 assert( pTerm!=0 );
3459 assert( pTerm->pExpr!=0 );
drh111a6a72008-12-21 03:51:16 +00003460 assert( omitTable==0 );
drh39759742013-08-02 23:40:45 +00003461 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh0baa0352014-02-25 21:55:16 +00003462 iReleaseReg = ++pParse->nMem;
drh7ba39a92013-05-30 17:43:19 +00003463 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
drh0baa0352014-02-25 21:55:16 +00003464 if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
drh111a6a72008-12-21 03:51:16 +00003465 addrNxt = pLevel->addrNxt;
drh688852a2014-02-17 22:40:43 +00003466 sqlite3VdbeAddOp2(v, OP_MustBeInt, iRowidReg, addrNxt); VdbeCoverage(v);
danielk19771d461462009-04-21 09:02:45 +00003467 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, iRowidReg);
drh688852a2014-02-17 22:40:43 +00003468 VdbeCoverage(v);
drh459f63e2013-03-06 01:55:27 +00003469 sqlite3ExprCacheAffinityChange(pParse, iRowidReg, 1);
drhceea3322009-04-23 13:22:42 +00003470 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
drh111a6a72008-12-21 03:51:16 +00003471 VdbeComment((v, "pk"));
3472 pLevel->op = OP_Noop;
drh7ba39a92013-05-30 17:43:19 +00003473 }else if( (pLoop->wsFlags & WHERE_IPK)!=0
3474 && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
3475 ){
3476 /* Case 3: We have an inequality comparison against the ROWID field.
drh111a6a72008-12-21 03:51:16 +00003477 */
3478 int testOp = OP_Noop;
3479 int start;
3480 int memEndValue = 0;
3481 WhereTerm *pStart, *pEnd;
3482
3483 assert( omitTable==0 );
drh7ba39a92013-05-30 17:43:19 +00003484 j = 0;
3485 pStart = pEnd = 0;
drh4efc9292013-06-06 23:02:03 +00003486 if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
3487 if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
drh81186b42013-06-18 01:52:41 +00003488 assert( pStart!=0 || pEnd!=0 );
drh111a6a72008-12-21 03:51:16 +00003489 if( bRev ){
3490 pTerm = pStart;
3491 pStart = pEnd;
3492 pEnd = pTerm;
3493 }
3494 if( pStart ){
3495 Expr *pX; /* The expression that defines the start bound */
3496 int r1, rTemp; /* Registers for holding the start boundary */
3497
3498 /* The following constant maps TK_xx codes into corresponding
3499 ** seek opcodes. It depends on a particular ordering of TK_xx
3500 */
3501 const u8 aMoveOp[] = {
drh4a1d3652014-02-14 15:13:36 +00003502 /* TK_GT */ OP_SeekGT,
3503 /* TK_LE */ OP_SeekLE,
3504 /* TK_LT */ OP_SeekLT,
3505 /* TK_GE */ OP_SeekGE
drh111a6a72008-12-21 03:51:16 +00003506 };
3507 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
3508 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
3509 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
3510
drhb5246e52013-07-08 21:12:57 +00003511 assert( (pStart->wtFlags & TERM_VNULL)==0 );
drh39759742013-08-02 23:40:45 +00003512 testcase( pStart->wtFlags & TERM_VIRTUAL );
drh111a6a72008-12-21 03:51:16 +00003513 pX = pStart->pExpr;
3514 assert( pX!=0 );
drhb5246e52013-07-08 21:12:57 +00003515 testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
drh111a6a72008-12-21 03:51:16 +00003516 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
3517 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
drh7d176102014-02-18 03:07:12 +00003518 VdbeComment((v, "pk"));
3519 VdbeCoverageIf(v, pX->op==TK_GT);
3520 VdbeCoverageIf(v, pX->op==TK_LE);
3521 VdbeCoverageIf(v, pX->op==TK_LT);
3522 VdbeCoverageIf(v, pX->op==TK_GE);
drh111a6a72008-12-21 03:51:16 +00003523 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
3524 sqlite3ReleaseTempReg(pParse, rTemp);
3525 disableTerm(pLevel, pStart);
3526 }else{
3527 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
drh7d176102014-02-18 03:07:12 +00003528 VdbeCoverageIf(v, bRev==0);
3529 VdbeCoverageIf(v, bRev!=0);
drh111a6a72008-12-21 03:51:16 +00003530 }
3531 if( pEnd ){
3532 Expr *pX;
3533 pX = pEnd->pExpr;
3534 assert( pX!=0 );
drhb5246e52013-07-08 21:12:57 +00003535 assert( (pEnd->wtFlags & TERM_VNULL)==0 );
3536 testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
drh39759742013-08-02 23:40:45 +00003537 testcase( pEnd->wtFlags & TERM_VIRTUAL );
drh111a6a72008-12-21 03:51:16 +00003538 memEndValue = ++pParse->nMem;
3539 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
3540 if( pX->op==TK_LT || pX->op==TK_GT ){
3541 testOp = bRev ? OP_Le : OP_Ge;
3542 }else{
3543 testOp = bRev ? OP_Lt : OP_Gt;
3544 }
3545 disableTerm(pLevel, pEnd);
3546 }
3547 start = sqlite3VdbeCurrentAddr(v);
3548 pLevel->op = bRev ? OP_Prev : OP_Next;
3549 pLevel->p1 = iCur;
3550 pLevel->p2 = start;
drh81186b42013-06-18 01:52:41 +00003551 assert( pLevel->p5==0 );
danielk19771d461462009-04-21 09:02:45 +00003552 if( testOp!=OP_Noop ){
drh0baa0352014-02-25 21:55:16 +00003553 iRowidReg = ++pParse->nMem;
danielk19771d461462009-04-21 09:02:45 +00003554 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00003555 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00003556 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
drh7d176102014-02-18 03:07:12 +00003557 VdbeCoverageIf(v, testOp==OP_Le);
3558 VdbeCoverageIf(v, testOp==OP_Lt);
3559 VdbeCoverageIf(v, testOp==OP_Ge);
3560 VdbeCoverageIf(v, testOp==OP_Gt);
danielk19771d461462009-04-21 09:02:45 +00003561 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00003562 }
drh1b0f0262013-05-30 22:27:09 +00003563 }else if( pLoop->wsFlags & WHERE_INDEXED ){
drh7ba39a92013-05-30 17:43:19 +00003564 /* Case 4: A scan using an index.
drh111a6a72008-12-21 03:51:16 +00003565 **
3566 ** The WHERE clause may contain zero or more equality
3567 ** terms ("==" or "IN" operators) that refer to the N
3568 ** left-most columns of the index. It may also contain
3569 ** inequality constraints (>, <, >= or <=) on the indexed
3570 ** column that immediately follows the N equalities. Only
3571 ** the right-most column can be an inequality - the rest must
3572 ** use the "==" and "IN" operators. For example, if the
3573 ** index is on (x,y,z), then the following clauses are all
3574 ** optimized:
3575 **
3576 ** x=5
3577 ** x=5 AND y=10
3578 ** x=5 AND y<10
3579 ** x=5 AND y>5 AND y<10
3580 ** x=5 AND y=5 AND z<=10
3581 **
3582 ** The z<10 term of the following cannot be used, only
3583 ** the x=5 term:
3584 **
3585 ** x=5 AND z<10
3586 **
3587 ** N may be zero if there are inequality constraints.
3588 ** If there are no inequality constraints, then N is at
3589 ** least one.
3590 **
3591 ** This case is also used when there are no WHERE clause
3592 ** constraints but an index is selected anyway, in order
3593 ** to force the output order to conform to an ORDER BY.
3594 */
drh3bb9b932010-08-06 02:10:00 +00003595 static const u8 aStartOp[] = {
drh111a6a72008-12-21 03:51:16 +00003596 0,
3597 0,
3598 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
3599 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
drh4a1d3652014-02-14 15:13:36 +00003600 OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
3601 OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
3602 OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
3603 OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
drh111a6a72008-12-21 03:51:16 +00003604 };
drh3bb9b932010-08-06 02:10:00 +00003605 static const u8 aEndOp[] = {
drh4a1d3652014-02-14 15:13:36 +00003606 OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
3607 OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
3608 OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
3609 OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
drh111a6a72008-12-21 03:51:16 +00003610 };
drhcd8629e2013-11-13 12:27:25 +00003611 u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
drh111a6a72008-12-21 03:51:16 +00003612 int regBase; /* Base register holding constraint values */
drh111a6a72008-12-21 03:51:16 +00003613 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
3614 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
3615 int startEq; /* True if range start uses ==, >= or <= */
3616 int endEq; /* True if range end uses ==, >= or <= */
3617 int start_constraints; /* Start of range is constrained */
3618 int nConstraint; /* Number of constraint terms */
drh3bb9b932010-08-06 02:10:00 +00003619 Index *pIdx; /* The index we will be using */
3620 int iIdxCur; /* The VDBE cursor for the index */
3621 int nExtraReg = 0; /* Number of extra registers needed */
3622 int op; /* Instruction opcode */
dan6ac43392010-06-09 15:47:11 +00003623 char *zStartAff; /* Affinity for start of range constraint */
drh33cad2f2013-11-15 12:41:01 +00003624 char cEndAff = 0; /* Affinity for end of range constraint */
drhcfc6ca42014-02-14 23:49:13 +00003625 u8 bSeekPastNull = 0; /* True to seek past initial nulls */
3626 u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
drh111a6a72008-12-21 03:51:16 +00003627
drh7ba39a92013-05-30 17:43:19 +00003628 pIdx = pLoop->u.btree.pIndex;
drh111a6a72008-12-21 03:51:16 +00003629 iIdxCur = pLevel->iIdxCur;
drhc8bbce12014-10-21 01:05:09 +00003630 assert( nEq>=pLoop->nSkip );
drh111a6a72008-12-21 03:51:16 +00003631
drh111a6a72008-12-21 03:51:16 +00003632 /* If this loop satisfies a sort order (pOrderBy) request that
3633 ** was passed to this function to implement a "SELECT min(x) ..."
3634 ** query, then the caller will only allow the loop to run for
3635 ** a single iteration. This means that the first row returned
3636 ** should not have a NULL value stored in 'x'. If column 'x' is
3637 ** the first one after the nEq equality constraints in the index,
3638 ** this requires some special handling.
3639 */
drhddba0c22014-03-18 20:33:42 +00003640 assert( pWInfo->pOrderBy==0
3641 || pWInfo->pOrderBy->nExpr==1
3642 || (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)==0 );
drh70d18342013-06-06 19:16:33 +00003643 if( (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)!=0
drhddba0c22014-03-18 20:33:42 +00003644 && pWInfo->nOBSat>0
drhbbbdc832013-10-22 18:01:40 +00003645 && (pIdx->nKeyCol>nEq)
drh111a6a72008-12-21 03:51:16 +00003646 ){
drhc8bbce12014-10-21 01:05:09 +00003647 assert( pLoop->nSkip==0 );
drhcfc6ca42014-02-14 23:49:13 +00003648 bSeekPastNull = 1;
drh6df2acd2008-12-28 16:55:25 +00003649 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00003650 }
3651
3652 /* Find any inequality constraint terms for the start and end
3653 ** of the range.
3654 */
drh7ba39a92013-05-30 17:43:19 +00003655 j = nEq;
3656 if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
drh4efc9292013-06-06 23:02:03 +00003657 pRangeStart = pLoop->aLTerm[j++];
drh6df2acd2008-12-28 16:55:25 +00003658 nExtraReg = 1;
drh80314622015-03-09 13:01:02 +00003659 /* Like optimization range constraints always occur in pairs */
3660 assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
3661 (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
drh111a6a72008-12-21 03:51:16 +00003662 }
drh7ba39a92013-05-30 17:43:19 +00003663 if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
drh4efc9292013-06-06 23:02:03 +00003664 pRangeEnd = pLoop->aLTerm[j++];
drh6df2acd2008-12-28 16:55:25 +00003665 nExtraReg = 1;
drha40da622015-03-09 12:11:56 +00003666 if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
drh80314622015-03-09 13:01:02 +00003667 assert( pRangeStart!=0 ); /* LIKE opt constraints */
3668 assert( pRangeStart->wtFlags & TERM_LIKEOPT ); /* occur in pairs */
drhf07cf6e2015-03-06 16:45:16 +00003669 pLevel->iLikeRepCntr = ++pParse->nMem;
drhb7c60ba2015-03-07 02:51:59 +00003670 testcase( bRev );
3671 testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
3672 sqlite3VdbeAddOp2(v, OP_Integer,
3673 bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC),
3674 pLevel->iLikeRepCntr);
drh16897072015-03-07 00:57:37 +00003675 VdbeComment((v, "LIKE loop counter"));
drhf07cf6e2015-03-06 16:45:16 +00003676 pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
3677 }
drhcfc6ca42014-02-14 23:49:13 +00003678 if( pRangeStart==0
drhcfc6ca42014-02-14 23:49:13 +00003679 && (j = pIdx->aiColumn[nEq])>=0
3680 && pIdx->pTable->aCol[j].notNull==0
3681 ){
3682 bSeekPastNull = 1;
3683 }
drh111a6a72008-12-21 03:51:16 +00003684 }
dan0df163a2014-03-06 12:36:26 +00003685 assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
drh111a6a72008-12-21 03:51:16 +00003686
drh6df2acd2008-12-28 16:55:25 +00003687 /* Generate code to evaluate all constraint terms using == or IN
3688 ** and store the values of those terms in an array of registers
3689 ** starting at regBase.
3690 */
drh613ba1e2013-06-15 15:11:45 +00003691 regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
drh33cad2f2013-11-15 12:41:01 +00003692 assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
3693 if( zStartAff ) cEndAff = zStartAff[nEq];
drh6df2acd2008-12-28 16:55:25 +00003694 addrNxt = pLevel->addrNxt;
3695
drh111a6a72008-12-21 03:51:16 +00003696 /* If we are doing a reverse order scan on an ascending index, or
3697 ** a forward order scan on a descending index, interchange the
3698 ** start and end terms (pRangeStart and pRangeEnd).
3699 */
drhbbbdc832013-10-22 18:01:40 +00003700 if( (nEq<pIdx->nKeyCol && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
3701 || (bRev && pIdx->nKeyCol==nEq)
dan0c733f62011-11-16 15:27:09 +00003702 ){
drh111a6a72008-12-21 03:51:16 +00003703 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
drhcfc6ca42014-02-14 23:49:13 +00003704 SWAP(u8, bSeekPastNull, bStopAtNull);
drh111a6a72008-12-21 03:51:16 +00003705 }
3706
drh7963b0e2013-06-17 21:37:40 +00003707 testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
3708 testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
3709 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
3710 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
drh111a6a72008-12-21 03:51:16 +00003711 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
3712 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
3713 start_constraints = pRangeStart || nEq>0;
3714
3715 /* Seek the index cursor to the start of the range. */
3716 nConstraint = nEq;
3717 if( pRangeStart ){
dan69f8bb92009-08-13 19:21:16 +00003718 Expr *pRight = pRangeStart->pExpr->pRight;
3719 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh52fc05b2015-03-07 20:32:49 +00003720 whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
drh9be18702015-05-13 19:33:41 +00003721 if( (pRangeStart->wtFlags & TERM_VNULL)==0
drh7d176102014-02-18 03:07:12 +00003722 && sqlite3ExprCanBeNull(pRight)
3723 ){
3724 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
3725 VdbeCoverage(v);
drh534230c2011-01-22 00:10:45 +00003726 }
dan6ac43392010-06-09 15:47:11 +00003727 if( zStartAff ){
drh05883a32015-06-02 15:32:08 +00003728 if( sqlite3CompareAffinity(pRight, zStartAff[nEq])==SQLITE_AFF_BLOB){
drh039fc322009-11-17 18:31:47 +00003729 /* Since the comparison is to be performed with no conversions
3730 ** applied to the operands, set the affinity to apply to pRight to
drh05883a32015-06-02 15:32:08 +00003731 ** SQLITE_AFF_BLOB. */
3732 zStartAff[nEq] = SQLITE_AFF_BLOB;
drh039fc322009-11-17 18:31:47 +00003733 }
dan6ac43392010-06-09 15:47:11 +00003734 if( sqlite3ExprNeedsNoAffinityChange(pRight, zStartAff[nEq]) ){
drh05883a32015-06-02 15:32:08 +00003735 zStartAff[nEq] = SQLITE_AFF_BLOB;
drh039fc322009-11-17 18:31:47 +00003736 }
3737 }
drh111a6a72008-12-21 03:51:16 +00003738 nConstraint++;
drh39759742013-08-02 23:40:45 +00003739 testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
drhcfc6ca42014-02-14 23:49:13 +00003740 }else if( bSeekPastNull ){
drh111a6a72008-12-21 03:51:16 +00003741 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
3742 nConstraint++;
3743 startEq = 0;
3744 start_constraints = 1;
3745 }
drhcfc6ca42014-02-14 23:49:13 +00003746 codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
drh111a6a72008-12-21 03:51:16 +00003747 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
3748 assert( op!=0 );
drh8cff69d2009-11-12 19:59:44 +00003749 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh688852a2014-02-17 22:40:43 +00003750 VdbeCoverage(v);
drh7d176102014-02-18 03:07:12 +00003751 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
3752 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
3753 VdbeCoverageIf(v, op==OP_SeekGT); testcase( op==OP_SeekGT );
3754 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
3755 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
3756 VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
drh111a6a72008-12-21 03:51:16 +00003757
3758 /* Load the value for the inequality constraint at the end of the
3759 ** range (if any).
3760 */
3761 nConstraint = nEq;
3762 if( pRangeEnd ){
dan69f8bb92009-08-13 19:21:16 +00003763 Expr *pRight = pRangeEnd->pExpr->pRight;
drhf49f3522009-12-30 14:12:38 +00003764 sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
dan69f8bb92009-08-13 19:21:16 +00003765 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh52fc05b2015-03-07 20:32:49 +00003766 whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
drh9be18702015-05-13 19:33:41 +00003767 if( (pRangeEnd->wtFlags & TERM_VNULL)==0
drh7d176102014-02-18 03:07:12 +00003768 && sqlite3ExprCanBeNull(pRight)
3769 ){
3770 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
3771 VdbeCoverage(v);
drh534230c2011-01-22 00:10:45 +00003772 }
drh05883a32015-06-02 15:32:08 +00003773 if( sqlite3CompareAffinity(pRight, cEndAff)!=SQLITE_AFF_BLOB
drh33cad2f2013-11-15 12:41:01 +00003774 && !sqlite3ExprNeedsNoAffinityChange(pRight, cEndAff)
3775 ){
3776 codeApplyAffinity(pParse, regBase+nEq, 1, &cEndAff);
3777 }
drh111a6a72008-12-21 03:51:16 +00003778 nConstraint++;
drh39759742013-08-02 23:40:45 +00003779 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
drhcfc6ca42014-02-14 23:49:13 +00003780 }else if( bStopAtNull ){
3781 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
3782 endEq = 0;
3783 nConstraint++;
drh111a6a72008-12-21 03:51:16 +00003784 }
drh6b36e822013-07-30 15:10:32 +00003785 sqlite3DbFree(db, zStartAff);
drh111a6a72008-12-21 03:51:16 +00003786
3787 /* Top of the loop body */
3788 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
3789
3790 /* Check if the index cursor is past the end of the range. */
drhcfc6ca42014-02-14 23:49:13 +00003791 if( nConstraint ){
drh4a1d3652014-02-14 15:13:36 +00003792 op = aEndOp[bRev*2 + endEq];
drh8cff69d2009-11-12 19:59:44 +00003793 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh7d176102014-02-18 03:07:12 +00003794 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
3795 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
3796 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
3797 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
drh6df2acd2008-12-28 16:55:25 +00003798 }
drh111a6a72008-12-21 03:51:16 +00003799
drh111a6a72008-12-21 03:51:16 +00003800 /* Seek the table cursor, if required */
drh23d04d52008-12-23 23:56:22 +00003801 disableTerm(pLevel, pRangeStart);
3802 disableTerm(pLevel, pRangeEnd);
drh85c1c552013-10-24 00:18:18 +00003803 if( omitTable ){
3804 /* pIdx is a covering index. No need to access the main table. */
3805 }else if( HasRowid(pIdx->pTable) ){
drh0baa0352014-02-25 21:55:16 +00003806 iRowidReg = ++pParse->nMem;
danielk19771d461462009-04-21 09:02:45 +00003807 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00003808 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00003809 sqlite3VdbeAddOp2(v, OP_Seek, iCur, iRowidReg); /* Deferred seek */
drha3bc66a2014-05-27 17:57:32 +00003810 }else if( iCur!=iIdxCur ){
drh85c1c552013-10-24 00:18:18 +00003811 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
3812 iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
3813 for(j=0; j<pPk->nKeyCol; j++){
3814 k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
3815 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
3816 }
drh261c02d2013-10-25 14:46:15 +00003817 sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
drh688852a2014-02-17 22:40:43 +00003818 iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
drh111a6a72008-12-21 03:51:16 +00003819 }
drh111a6a72008-12-21 03:51:16 +00003820
3821 /* Record the instruction used to terminate the loop. Disable
3822 ** WHERE clause terms made redundant by the index range scan.
3823 */
drh7699d1c2013-06-04 12:42:29 +00003824 if( pLoop->wsFlags & WHERE_ONEROW ){
drh95e037b2011-03-09 21:02:31 +00003825 pLevel->op = OP_Noop;
3826 }else if( bRev ){
3827 pLevel->op = OP_Prev;
3828 }else{
3829 pLevel->op = OP_Next;
3830 }
drh111a6a72008-12-21 03:51:16 +00003831 pLevel->p1 = iIdxCur;
drh0c8a9342014-03-20 12:17:35 +00003832 pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
drh53cfbe92013-06-13 17:28:22 +00003833 if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
drh3f4d1d12012-09-15 18:45:54 +00003834 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
3835 }else{
3836 assert( pLevel->p5==0 );
3837 }
drhdd5f5a62008-12-23 13:35:23 +00003838 }else
3839
drh23d04d52008-12-23 23:56:22 +00003840#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drh7ba39a92013-05-30 17:43:19 +00003841 if( pLoop->wsFlags & WHERE_MULTI_OR ){
3842 /* Case 5: Two or more separately indexed terms connected by OR
drh111a6a72008-12-21 03:51:16 +00003843 **
3844 ** Example:
3845 **
3846 ** CREATE TABLE t1(a,b,c,d);
3847 ** CREATE INDEX i1 ON t1(a);
3848 ** CREATE INDEX i2 ON t1(b);
3849 ** CREATE INDEX i3 ON t1(c);
3850 **
3851 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
3852 **
3853 ** In the example, there are three indexed terms connected by OR.
danielk19771d461462009-04-21 09:02:45 +00003854 ** The top of the loop looks like this:
drh111a6a72008-12-21 03:51:16 +00003855 **
drh1b26c7c2009-04-22 02:15:47 +00003856 ** Null 1 # Zero the rowset in reg 1
drh111a6a72008-12-21 03:51:16 +00003857 **
danielk19771d461462009-04-21 09:02:45 +00003858 ** Then, for each indexed term, the following. The arguments to
drh1b26c7c2009-04-22 02:15:47 +00003859 ** RowSetTest are such that the rowid of the current row is inserted
3860 ** into the RowSet. If it is already present, control skips the
danielk19771d461462009-04-21 09:02:45 +00003861 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
drh111a6a72008-12-21 03:51:16 +00003862 **
danielk19771d461462009-04-21 09:02:45 +00003863 ** sqlite3WhereBegin(<term>)
drh1b26c7c2009-04-22 02:15:47 +00003864 ** RowSetTest # Insert rowid into rowset
danielk19771d461462009-04-21 09:02:45 +00003865 ** Gosub 2 A
3866 ** sqlite3WhereEnd()
3867 **
3868 ** Following the above, code to terminate the loop. Label A, the target
3869 ** of the Gosub above, jumps to the instruction right after the Goto.
3870 **
drh1b26c7c2009-04-22 02:15:47 +00003871 ** Null 1 # Zero the rowset in reg 1
danielk19771d461462009-04-21 09:02:45 +00003872 ** Goto B # The loop is finished.
3873 **
3874 ** A: <loop body> # Return data, whatever.
3875 **
3876 ** Return 2 # Jump back to the Gosub
3877 **
3878 ** B: <after the loop>
3879 **
drh5609baf2014-05-26 22:01:00 +00003880 ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
peter.d.reid60ec9142014-09-06 16:39:46 +00003881 ** use an ephemeral index instead of a RowSet to record the primary
drh5609baf2014-05-26 22:01:00 +00003882 ** keys of the rows we have already seen.
3883 **
drh111a6a72008-12-21 03:51:16 +00003884 */
drh111a6a72008-12-21 03:51:16 +00003885 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
drhc01a3c12009-12-16 22:10:49 +00003886 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
dan0efb72c2012-08-24 18:44:56 +00003887 Index *pCov = 0; /* Potential covering index (or NULL) */
3888 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
danielk19771d461462009-04-21 09:02:45 +00003889
3890 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
shane85095702009-06-15 16:27:08 +00003891 int regRowset = 0; /* Register for RowSet object */
3892 int regRowid = 0; /* Register holding rowid */
danielk19771d461462009-04-21 09:02:45 +00003893 int iLoopBody = sqlite3VdbeMakeLabel(v); /* Start of loop body */
3894 int iRetInit; /* Address of regReturn init */
drhc01a3c12009-12-16 22:10:49 +00003895 int untestedTerms = 0; /* Some terms not completely tested */
drh8871ef52011-10-07 13:33:10 +00003896 int ii; /* Loop counter */
drh35263192014-07-22 20:02:19 +00003897 u16 wctrlFlags; /* Flags for sub-WHERE clause */
drh8871ef52011-10-07 13:33:10 +00003898 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
danf97dad82014-05-26 20:06:45 +00003899 Table *pTab = pTabItem->pTab;
drh111a6a72008-12-21 03:51:16 +00003900
drh4efc9292013-06-06 23:02:03 +00003901 pTerm = pLoop->aLTerm[0];
drh111a6a72008-12-21 03:51:16 +00003902 assert( pTerm!=0 );
drh7a5bcc02013-01-16 17:08:58 +00003903 assert( pTerm->eOperator & WO_OR );
drh111a6a72008-12-21 03:51:16 +00003904 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
3905 pOrWc = &pTerm->u.pOrInfo->wc;
drhc01a3c12009-12-16 22:10:49 +00003906 pLevel->op = OP_Return;
3907 pLevel->p1 = regReturn;
drh23d04d52008-12-23 23:56:22 +00003908
danbfca6a42012-08-24 10:52:35 +00003909 /* Set up a new SrcList in pOrTab containing the table being scanned
drhc01a3c12009-12-16 22:10:49 +00003910 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
3911 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
3912 */
3913 if( pWInfo->nLevel>1 ){
3914 int nNotReady; /* The number of notReady tables */
3915 struct SrcList_item *origSrc; /* Original list of tables */
3916 nNotReady = pWInfo->nLevel - iLevel - 1;
drh6b36e822013-07-30 15:10:32 +00003917 pOrTab = sqlite3StackAllocRaw(db,
drhc01a3c12009-12-16 22:10:49 +00003918 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
3919 if( pOrTab==0 ) return notReady;
drhad01d892013-06-19 13:59:49 +00003920 pOrTab->nAlloc = (u8)(nNotReady + 1);
shaneh46aae3c2009-12-31 19:06:23 +00003921 pOrTab->nSrc = pOrTab->nAlloc;
drhc01a3c12009-12-16 22:10:49 +00003922 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
3923 origSrc = pWInfo->pTabList->a;
3924 for(k=1; k<=nNotReady; k++){
3925 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
3926 }
3927 }else{
3928 pOrTab = pWInfo->pTabList;
3929 }
danielk19771d461462009-04-21 09:02:45 +00003930
drh1b26c7c2009-04-22 02:15:47 +00003931 /* Initialize the rowset register to contain NULL. An SQL NULL is
peter.d.reid60ec9142014-09-06 16:39:46 +00003932 ** equivalent to an empty rowset. Or, create an ephemeral index
drh5609baf2014-05-26 22:01:00 +00003933 ** capable of holding primary keys in the case of a WITHOUT ROWID.
danielk19771d461462009-04-21 09:02:45 +00003934 **
3935 ** Also initialize regReturn to contain the address of the instruction
3936 ** immediately following the OP_Return at the bottom of the loop. This
3937 ** is required in a few obscure LEFT JOIN cases where control jumps
3938 ** over the top of the loop into the body of it. In this case the
3939 ** correct response for the end-of-loop code (the OP_Return) is to
3940 ** fall through to the next instruction, just as an OP_Next does if
3941 ** called on an uninitialized cursor.
3942 */
drh70d18342013-06-06 19:16:33 +00003943 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
danf97dad82014-05-26 20:06:45 +00003944 if( HasRowid(pTab) ){
3945 regRowset = ++pParse->nMem;
3946 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
3947 }else{
3948 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
3949 regRowset = pParse->nTab++;
3950 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
3951 sqlite3VdbeSetP4KeyInfo(pParse, pPk);
3952 }
drh336a5302009-04-24 15:46:21 +00003953 regRowid = ++pParse->nMem;
drh336a5302009-04-24 15:46:21 +00003954 }
danielk19771d461462009-04-21 09:02:45 +00003955 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
3956
drh8871ef52011-10-07 13:33:10 +00003957 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
3958 ** Then for every term xN, evaluate as the subexpression: xN AND z
3959 ** That way, terms in y that are factored into the disjunction will
3960 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
drh331b67c2012-03-09 22:02:08 +00003961 **
3962 ** Actually, each subexpression is converted to "xN AND w" where w is
3963 ** the "interesting" terms of z - terms that did not originate in the
3964 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
3965 ** indices.
drhb3129fa2013-05-09 14:20:11 +00003966 **
3967 ** This optimization also only applies if the (x1 OR x2 OR ...) term
3968 ** is not contained in the ON clause of a LEFT JOIN.
3969 ** See ticket http://www.sqlite.org/src/info/f2369304e4
drh8871ef52011-10-07 13:33:10 +00003970 */
3971 if( pWC->nTerm>1 ){
drh7a484802012-03-16 00:28:11 +00003972 int iTerm;
3973 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
3974 Expr *pExpr = pWC->a[iTerm].pExpr;
drhaa32e3c2013-07-16 21:31:23 +00003975 if( &pWC->a[iTerm] == pTerm ) continue;
drh331b67c2012-03-09 22:02:08 +00003976 if( ExprHasProperty(pExpr, EP_FromJoin) ) continue;
drh1d324882014-12-04 20:24:50 +00003977 if( (pWC->a[iTerm].wtFlags & TERM_VIRTUAL)!=0 ) continue;
drh7a484802012-03-16 00:28:11 +00003978 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drh1d324882014-12-04 20:24:50 +00003979 testcase( pWC->a[iTerm].wtFlags & TERM_ORINFO );
drh6b36e822013-07-30 15:10:32 +00003980 pExpr = sqlite3ExprDup(db, pExpr, 0);
3981 pAndExpr = sqlite3ExprAnd(db, pAndExpr, pExpr);
drh331b67c2012-03-09 22:02:08 +00003982 }
3983 if( pAndExpr ){
3984 pAndExpr = sqlite3PExpr(pParse, TK_AND, 0, pAndExpr, 0);
3985 }
drh8871ef52011-10-07 13:33:10 +00003986 }
3987
drh3fb67302014-05-27 16:41:39 +00003988 /* Run a separate WHERE clause for each term of the OR clause. After
3989 ** eliminating duplicates from other WHERE clauses, the action for each
3990 ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
3991 */
drh36be4c42014-09-30 17:31:23 +00003992 wctrlFlags = WHERE_OMIT_OPEN_CLOSE
3993 | WHERE_FORCE_TABLE
drh8e8e7ef2015-03-02 17:25:00 +00003994 | WHERE_ONETABLE_ONLY
3995 | WHERE_NO_AUTOINDEX;
danielk19771d461462009-04-21 09:02:45 +00003996 for(ii=0; ii<pOrWc->nTerm; ii++){
3997 WhereTerm *pOrTerm = &pOrWc->a[ii];
drh7a5bcc02013-01-16 17:08:58 +00003998 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
drh3fb67302014-05-27 16:41:39 +00003999 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
4000 Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
4001 int j1 = 0; /* Address of jump operation */
drhb3129fa2013-05-09 14:20:11 +00004002 if( pAndExpr && !ExprHasProperty(pOrExpr, EP_FromJoin) ){
drh8871ef52011-10-07 13:33:10 +00004003 pAndExpr->pLeft = pOrExpr;
4004 pOrExpr = pAndExpr;
4005 }
danielk19771d461462009-04-21 09:02:45 +00004006 /* Loop through table entries that match term pOrTerm. */
drh0a99ba32014-09-30 17:03:35 +00004007 WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
drh8871ef52011-10-07 13:33:10 +00004008 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
drh35263192014-07-22 20:02:19 +00004009 wctrlFlags, iCovCur);
drh6b36e822013-07-30 15:10:32 +00004010 assert( pSubWInfo || pParse->nErr || db->mallocFailed );
danielk19771d461462009-04-21 09:02:45 +00004011 if( pSubWInfo ){
drh7ba39a92013-05-30 17:43:19 +00004012 WhereLoop *pSubLoop;
dan6f9702e2014-11-01 20:38:06 +00004013 int addrExplain = explainOneScan(
4014 pParse, pOrTab, &pSubWInfo->a[0], iLevel, pLevel->iFrom, 0
4015 );
4016 addScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
dan89e71642014-11-01 18:08:04 +00004017
drh3fb67302014-05-27 16:41:39 +00004018 /* This is the sub-WHERE clause body. First skip over
4019 ** duplicate rows from prior sub-WHERE clauses, and record the
4020 ** rowid (or PRIMARY KEY) for the current row so that the same
4021 ** row will be skipped in subsequent sub-WHERE clauses.
4022 */
drh70d18342013-06-06 19:16:33 +00004023 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
drh336a5302009-04-24 15:46:21 +00004024 int r;
danf97dad82014-05-26 20:06:45 +00004025 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
4026 if( HasRowid(pTab) ){
4027 r = sqlite3ExprCodeGetColumn(pParse, pTab, -1, iCur, regRowid, 0);
drh5609baf2014-05-26 22:01:00 +00004028 j1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0, r,iSet);
danf97dad82014-05-26 20:06:45 +00004029 VdbeCoverage(v);
4030 }else{
4031 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
4032 int nPk = pPk->nKeyCol;
4033 int iPk;
4034
4035 /* Read the PK into an array of temp registers. */
4036 r = sqlite3GetTempRange(pParse, nPk);
4037 for(iPk=0; iPk<nPk; iPk++){
4038 int iCol = pPk->aiColumn[iPk];
4039 sqlite3ExprCodeGetColumn(pParse, pTab, iCol, iCur, r+iPk, 0);
4040 }
4041
4042 /* Check if the temp table already contains this key. If so,
4043 ** the row has already been included in the result set and
4044 ** can be ignored (by jumping past the Gosub below). Otherwise,
4045 ** insert the key into the temp table and proceed with processing
4046 ** the row.
4047 **
4048 ** Use some of the same optimizations as OP_RowSetTest: If iSet
4049 ** is zero, assume that the key cannot already be present in
4050 ** the temp table. And if iSet is -1, assume that there is no
4051 ** need to insert the key into the temp table, as it will never
4052 ** be tested for. */
4053 if( iSet ){
drh5609baf2014-05-26 22:01:00 +00004054 j1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
drh68c12152014-05-26 20:25:34 +00004055 VdbeCoverage(v);
danf97dad82014-05-26 20:06:45 +00004056 }
4057 if( iSet>=0 ){
4058 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
4059 sqlite3VdbeAddOp3(v, OP_IdxInsert, regRowset, regRowid, 0);
4060 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
4061 }
4062
4063 /* Release the array of temp registers */
4064 sqlite3ReleaseTempRange(pParse, r, nPk);
4065 }
drh336a5302009-04-24 15:46:21 +00004066 }
drh3fb67302014-05-27 16:41:39 +00004067
4068 /* Invoke the main loop body as a subroutine */
danielk19771d461462009-04-21 09:02:45 +00004069 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
drh3fb67302014-05-27 16:41:39 +00004070
4071 /* Jump here (skipping the main loop body subroutine) if the
4072 ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
drh5609baf2014-05-26 22:01:00 +00004073 if( j1 ) sqlite3VdbeJumpHere(v, j1);
danielk19771d461462009-04-21 09:02:45 +00004074
drhc01a3c12009-12-16 22:10:49 +00004075 /* The pSubWInfo->untestedTerms flag means that this OR term
4076 ** contained one or more AND term from a notReady table. The
4077 ** terms from the notReady table could not be tested and will
4078 ** need to be tested later.
4079 */
4080 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
4081
danbfca6a42012-08-24 10:52:35 +00004082 /* If all of the OR-connected terms are optimized using the same
4083 ** index, and the index is opened using the same cursor number
4084 ** by each call to sqlite3WhereBegin() made by this loop, it may
4085 ** be possible to use that index as a covering index.
4086 **
4087 ** If the call to sqlite3WhereBegin() above resulted in a scan that
4088 ** uses an index, and this is either the first OR-connected term
4089 ** processed or the index is the same as that used by all previous
dan0efb72c2012-08-24 18:44:56 +00004090 ** terms, set pCov to the candidate covering index. Otherwise, set
4091 ** pCov to NULL to indicate that no candidate covering index will
4092 ** be available.
danbfca6a42012-08-24 10:52:35 +00004093 */
drh7ba39a92013-05-30 17:43:19 +00004094 pSubLoop = pSubWInfo->a[0].pWLoop;
drh986b3872013-06-28 21:12:20 +00004095 assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
drh7ba39a92013-05-30 17:43:19 +00004096 if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
drh7ba39a92013-05-30 17:43:19 +00004097 && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
drh48dd1d82014-05-27 18:18:58 +00004098 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
danbfca6a42012-08-24 10:52:35 +00004099 ){
drh7ba39a92013-05-30 17:43:19 +00004100 assert( pSubWInfo->a[0].iIdxCur==iCovCur );
drh907717f2013-06-04 18:03:22 +00004101 pCov = pSubLoop->u.btree.pIndex;
drh35263192014-07-22 20:02:19 +00004102 wctrlFlags |= WHERE_REOPEN_IDX;
danbfca6a42012-08-24 10:52:35 +00004103 }else{
4104 pCov = 0;
4105 }
4106
danielk19771d461462009-04-21 09:02:45 +00004107 /* Finish the loop through table entries that match term pOrTerm. */
4108 sqlite3WhereEnd(pSubWInfo);
4109 }
drhdd5f5a62008-12-23 13:35:23 +00004110 }
4111 }
drhd40e2082012-08-24 23:24:15 +00004112 pLevel->u.pCovidx = pCov;
drh90abfd02012-10-09 21:07:23 +00004113 if( pCov ) pLevel->iIdxCur = iCovCur;
drh331b67c2012-03-09 22:02:08 +00004114 if( pAndExpr ){
4115 pAndExpr->pLeft = 0;
drh6b36e822013-07-30 15:10:32 +00004116 sqlite3ExprDelete(db, pAndExpr);
drh331b67c2012-03-09 22:02:08 +00004117 }
danielk19771d461462009-04-21 09:02:45 +00004118 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
danielk19771d461462009-04-21 09:02:45 +00004119 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrBrk);
4120 sqlite3VdbeResolveLabel(v, iLoopBody);
4121
drh6b36e822013-07-30 15:10:32 +00004122 if( pWInfo->nLevel>1 ) sqlite3StackFree(db, pOrTab);
drhc01a3c12009-12-16 22:10:49 +00004123 if( !untestedTerms ) disableTerm(pLevel, pTerm);
drhdd5f5a62008-12-23 13:35:23 +00004124 }else
drh23d04d52008-12-23 23:56:22 +00004125#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00004126
4127 {
drh7ba39a92013-05-30 17:43:19 +00004128 /* Case 6: There is no usable index. We must do a complete
drh111a6a72008-12-21 03:51:16 +00004129 ** scan of the entire table.
4130 */
drh699b3d42009-02-23 16:52:07 +00004131 static const u8 aStep[] = { OP_Next, OP_Prev };
4132 static const u8 aStart[] = { OP_Rewind, OP_Last };
4133 assert( bRev==0 || bRev==1 );
drhe73f0592014-01-21 22:25:45 +00004134 if( pTabItem->isRecursive ){
drh340309f2014-01-22 00:23:49 +00004135 /* Tables marked isRecursive have only a single row that is stored in
dan41028152014-01-22 10:22:25 +00004136 ** a pseudo-cursor. No need to Rewind or Next such cursors. */
drhe73f0592014-01-21 22:25:45 +00004137 pLevel->op = OP_Noop;
4138 }else{
4139 pLevel->op = aStep[bRev];
4140 pLevel->p1 = iCur;
4141 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrBrk);
drh7d176102014-02-18 03:07:12 +00004142 VdbeCoverageIf(v, bRev==0);
4143 VdbeCoverageIf(v, bRev!=0);
drhe73f0592014-01-21 22:25:45 +00004144 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4145 }
drh111a6a72008-12-21 03:51:16 +00004146 }
drh111a6a72008-12-21 03:51:16 +00004147
dan6f9702e2014-11-01 20:38:06 +00004148#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
4149 pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
4150#endif
4151
drh111a6a72008-12-21 03:51:16 +00004152 /* Insert code to test every subexpression that can be completely
4153 ** computed using the current set of tables.
4154 */
drh111a6a72008-12-21 03:51:16 +00004155 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
4156 Expr *pE;
drh8f1a7ed2015-03-06 19:47:38 +00004157 int skipLikeAddr = 0;
drh39759742013-08-02 23:40:45 +00004158 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh111a6a72008-12-21 03:51:16 +00004159 testcase( pTerm->wtFlags & TERM_CODED );
4160 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drh0259bc32013-09-09 19:37:46 +00004161 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
drhc01a3c12009-12-16 22:10:49 +00004162 testcase( pWInfo->untestedTerms==0
4163 && (pWInfo->wctrlFlags & WHERE_ONETABLE_ONLY)!=0 );
4164 pWInfo->untestedTerms = 1;
4165 continue;
4166 }
drh111a6a72008-12-21 03:51:16 +00004167 pE = pTerm->pExpr;
4168 assert( pE!=0 );
4169 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
4170 continue;
4171 }
drh8f1a7ed2015-03-06 19:47:38 +00004172 if( pTerm->wtFlags & TERM_LIKECOND ){
4173 assert( pLevel->iLikeRepCntr>0 );
drh16897072015-03-07 00:57:37 +00004174 skipLikeAddr = sqlite3VdbeAddOp1(v, OP_IfNot, pLevel->iLikeRepCntr);
drh8f1a7ed2015-03-06 19:47:38 +00004175 VdbeCoverage(v);
4176 }
drh111a6a72008-12-21 03:51:16 +00004177 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
drh8f1a7ed2015-03-06 19:47:38 +00004178 if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
drh111a6a72008-12-21 03:51:16 +00004179 pTerm->wtFlags |= TERM_CODED;
4180 }
4181
drh0c41d222013-04-22 02:39:10 +00004182 /* Insert code to test for implied constraints based on transitivity
4183 ** of the "==" operator.
4184 **
4185 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
4186 ** and we are coding the t1 loop and the t2 loop has not yet coded,
4187 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
4188 ** the implied "t1.a=123" constraint.
4189 */
4190 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
drh6b36e822013-07-30 15:10:32 +00004191 Expr *pE, *pEAlt;
drh0c41d222013-04-22 02:39:10 +00004192 WhereTerm *pAlt;
drh0c41d222013-04-22 02:39:10 +00004193 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhee145872015-05-14 13:18:47 +00004194 if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
drh4a00b332015-05-14 13:41:22 +00004195 if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
drh0c41d222013-04-22 02:39:10 +00004196 if( pTerm->leftCursor!=iCur ) continue;
drhcdc2e432013-07-01 17:27:19 +00004197 if( pLevel->iLeftJoin ) continue;
drh0c41d222013-04-22 02:39:10 +00004198 pE = pTerm->pExpr;
4199 assert( !ExprHasProperty(pE, EP_FromJoin) );
drh0259bc32013-09-09 19:37:46 +00004200 assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
drhe8d0c612015-05-14 01:05:25 +00004201 pAlt = findTerm(pWC, iCur, pTerm->u.leftColumn, notReady,
4202 WO_EQ|WO_IN|WO_IS, 0);
drh0c41d222013-04-22 02:39:10 +00004203 if( pAlt==0 ) continue;
drh5c10f3b2013-05-01 17:22:38 +00004204 if( pAlt->wtFlags & (TERM_CODED) ) continue;
drhe8d0c612015-05-14 01:05:25 +00004205 testcase( pAlt->eOperator & WO_EQ );
4206 testcase( pAlt->eOperator & WO_IS );
drh7963b0e2013-06-17 21:37:40 +00004207 testcase( pAlt->eOperator & WO_IN );
drh6bc69a22013-11-19 12:33:23 +00004208 VdbeModuleComment((v, "begin transitive constraint"));
drh6b36e822013-07-30 15:10:32 +00004209 pEAlt = sqlite3StackAllocRaw(db, sizeof(*pEAlt));
4210 if( pEAlt ){
4211 *pEAlt = *pAlt->pExpr;
4212 pEAlt->pLeft = pE->pLeft;
4213 sqlite3ExprIfFalse(pParse, pEAlt, addrCont, SQLITE_JUMPIFNULL);
4214 sqlite3StackFree(db, pEAlt);
4215 }
drh0c41d222013-04-22 02:39:10 +00004216 }
4217
drh111a6a72008-12-21 03:51:16 +00004218 /* For a LEFT OUTER JOIN, generate code that will record the fact that
4219 ** at least one row of the right table has matched the left table.
4220 */
4221 if( pLevel->iLeftJoin ){
4222 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
4223 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
4224 VdbeComment((v, "record LEFT JOIN hit"));
drhceea3322009-04-23 13:22:42 +00004225 sqlite3ExprCacheClear(pParse);
drh111a6a72008-12-21 03:51:16 +00004226 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
drh39759742013-08-02 23:40:45 +00004227 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh111a6a72008-12-21 03:51:16 +00004228 testcase( pTerm->wtFlags & TERM_CODED );
4229 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drh0259bc32013-09-09 19:37:46 +00004230 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
drhb057e562009-12-16 23:43:55 +00004231 assert( pWInfo->untestedTerms );
drhc01a3c12009-12-16 22:10:49 +00004232 continue;
4233 }
drh111a6a72008-12-21 03:51:16 +00004234 assert( pTerm->pExpr );
4235 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
4236 pTerm->wtFlags |= TERM_CODED;
4237 }
4238 }
drh23d04d52008-12-23 23:56:22 +00004239
drh0259bc32013-09-09 19:37:46 +00004240 return pLevel->notReady;
drh111a6a72008-12-21 03:51:16 +00004241}
4242
drhd15cb172013-05-21 19:23:10 +00004243#ifdef WHERETRACE_ENABLED
drha18f3d22013-05-08 03:05:41 +00004244/*
drhc90713d2014-09-30 13:46:49 +00004245** Print the content of a WhereTerm object
4246*/
4247static void whereTermPrint(WhereTerm *pTerm, int iTerm){
drh0a99ba32014-09-30 17:03:35 +00004248 if( pTerm==0 ){
4249 sqlite3DebugPrintf("TERM-%-3d NULL\n", iTerm);
4250 }else{
4251 char zType[4];
4252 memcpy(zType, "...", 4);
4253 if( pTerm->wtFlags & TERM_VIRTUAL ) zType[0] = 'V';
4254 if( pTerm->eOperator & WO_EQUIV ) zType[1] = 'E';
4255 if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) zType[2] = 'L';
drhfcd49532015-05-13 15:24:07 +00004256 sqlite3DebugPrintf(
4257 "TERM-%-3d %p %s cursor=%-3d prob=%-3d op=0x%03x wtFlags=0x%04x\n",
4258 iTerm, pTerm, zType, pTerm->leftCursor, pTerm->truthProb,
4259 pTerm->eOperator, pTerm->wtFlags);
drh0a99ba32014-09-30 17:03:35 +00004260 sqlite3TreeViewExpr(0, pTerm->pExpr, 0);
4261 }
drhc90713d2014-09-30 13:46:49 +00004262}
4263#endif
4264
4265#ifdef WHERETRACE_ENABLED
4266/*
drha18f3d22013-05-08 03:05:41 +00004267** Print a WhereLoop object for debugging purposes
4268*/
drhc1ba2e72013-10-28 19:03:21 +00004269static void whereLoopPrint(WhereLoop *p, WhereClause *pWC){
4270 WhereInfo *pWInfo = pWC->pWInfo;
drh989578e2013-10-28 14:34:35 +00004271 int nb = 1+(pWInfo->pTabList->nSrc+7)/8;
4272 struct SrcList_item *pItem = pWInfo->pTabList->a + p->iTab;
drha18f3d22013-05-08 03:05:41 +00004273 Table *pTab = pItem->pTab;
drh6457a352013-06-21 00:35:37 +00004274 sqlite3DebugPrintf("%c%2d.%0*llx.%0*llx", p->cId,
drha184fb82013-05-08 04:22:59 +00004275 p->iTab, nb, p->maskSelf, nb, p->prereq);
drh6457a352013-06-21 00:35:37 +00004276 sqlite3DebugPrintf(" %12s",
drha18f3d22013-05-08 03:05:41 +00004277 pItem->zAlias ? pItem->zAlias : pTab->zName);
drh5346e952013-05-08 14:14:26 +00004278 if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
drhf3f69ac2014-08-20 23:38:07 +00004279 const char *zName;
4280 if( p->u.btree.pIndex && (zName = p->u.btree.pIndex->zName)!=0 ){
drh319f6772013-05-14 15:31:07 +00004281 if( strncmp(zName, "sqlite_autoindex_", 17)==0 ){
4282 int i = sqlite3Strlen30(zName) - 1;
4283 while( zName[i]!='_' ) i--;
4284 zName += i;
4285 }
drh6457a352013-06-21 00:35:37 +00004286 sqlite3DebugPrintf(".%-16s %2d", zName, p->u.btree.nEq);
drh5346e952013-05-08 14:14:26 +00004287 }else{
drh6457a352013-06-21 00:35:37 +00004288 sqlite3DebugPrintf("%20s","");
drh5346e952013-05-08 14:14:26 +00004289 }
drha18f3d22013-05-08 03:05:41 +00004290 }else{
drh5346e952013-05-08 14:14:26 +00004291 char *z;
4292 if( p->u.vtab.idxStr ){
drh3bd26f02013-05-24 14:52:03 +00004293 z = sqlite3_mprintf("(%d,\"%s\",%x)",
4294 p->u.vtab.idxNum, p->u.vtab.idxStr, p->u.vtab.omitMask);
drh5346e952013-05-08 14:14:26 +00004295 }else{
drh3bd26f02013-05-24 14:52:03 +00004296 z = sqlite3_mprintf("(%d,%x)", p->u.vtab.idxNum, p->u.vtab.omitMask);
drh5346e952013-05-08 14:14:26 +00004297 }
drh6457a352013-06-21 00:35:37 +00004298 sqlite3DebugPrintf(" %-19s", z);
drh5346e952013-05-08 14:14:26 +00004299 sqlite3_free(z);
drha18f3d22013-05-08 03:05:41 +00004300 }
drhf3f69ac2014-08-20 23:38:07 +00004301 if( p->wsFlags & WHERE_SKIPSCAN ){
drhc8bbce12014-10-21 01:05:09 +00004302 sqlite3DebugPrintf(" f %05x %d-%d", p->wsFlags, p->nLTerm,p->nSkip);
drhf3f69ac2014-08-20 23:38:07 +00004303 }else{
4304 sqlite3DebugPrintf(" f %05x N %d", p->wsFlags, p->nLTerm);
4305 }
drhb8a8e8a2013-06-10 19:12:39 +00004306 sqlite3DebugPrintf(" cost %d,%d,%d\n", p->rSetup, p->rRun, p->nOut);
drhc90713d2014-09-30 13:46:49 +00004307 if( p->nLTerm && (sqlite3WhereTrace & 0x100)!=0 ){
4308 int i;
4309 for(i=0; i<p->nLTerm; i++){
drh0a99ba32014-09-30 17:03:35 +00004310 whereTermPrint(p->aLTerm[i], i);
drhc90713d2014-09-30 13:46:49 +00004311 }
4312 }
drha18f3d22013-05-08 03:05:41 +00004313}
4314#endif
4315
drhf1b5f5b2013-05-02 00:15:01 +00004316/*
drh4efc9292013-06-06 23:02:03 +00004317** Convert bulk memory into a valid WhereLoop that can be passed
4318** to whereLoopClear harmlessly.
drh5346e952013-05-08 14:14:26 +00004319*/
drh4efc9292013-06-06 23:02:03 +00004320static void whereLoopInit(WhereLoop *p){
4321 p->aLTerm = p->aLTermSpace;
4322 p->nLTerm = 0;
4323 p->nLSlot = ArraySize(p->aLTermSpace);
4324 p->wsFlags = 0;
4325}
4326
4327/*
4328** Clear the WhereLoop.u union. Leave WhereLoop.pLTerm intact.
4329*/
4330static void whereLoopClearUnion(sqlite3 *db, WhereLoop *p){
drh986b3872013-06-28 21:12:20 +00004331 if( p->wsFlags & (WHERE_VIRTUALTABLE|WHERE_AUTO_INDEX) ){
drh13e11b42013-06-06 23:44:25 +00004332 if( (p->wsFlags & WHERE_VIRTUALTABLE)!=0 && p->u.vtab.needFree ){
4333 sqlite3_free(p->u.vtab.idxStr);
4334 p->u.vtab.needFree = 0;
4335 p->u.vtab.idxStr = 0;
drh986b3872013-06-28 21:12:20 +00004336 }else if( (p->wsFlags & WHERE_AUTO_INDEX)!=0 && p->u.btree.pIndex!=0 ){
drh13e11b42013-06-06 23:44:25 +00004337 sqlite3DbFree(db, p->u.btree.pIndex->zColAff);
4338 sqlite3DbFree(db, p->u.btree.pIndex);
4339 p->u.btree.pIndex = 0;
4340 }
drh5346e952013-05-08 14:14:26 +00004341 }
4342}
4343
drh4efc9292013-06-06 23:02:03 +00004344/*
4345** Deallocate internal memory used by a WhereLoop object
4346*/
4347static void whereLoopClear(sqlite3 *db, WhereLoop *p){
4348 if( p->aLTerm!=p->aLTermSpace ) sqlite3DbFree(db, p->aLTerm);
4349 whereLoopClearUnion(db, p);
4350 whereLoopInit(p);
4351}
4352
4353/*
4354** Increase the memory allocation for pLoop->aLTerm[] to be at least n.
4355*/
4356static int whereLoopResize(sqlite3 *db, WhereLoop *p, int n){
4357 WhereTerm **paNew;
4358 if( p->nLSlot>=n ) return SQLITE_OK;
4359 n = (n+7)&~7;
4360 paNew = sqlite3DbMallocRaw(db, sizeof(p->aLTerm[0])*n);
4361 if( paNew==0 ) return SQLITE_NOMEM;
4362 memcpy(paNew, p->aLTerm, sizeof(p->aLTerm[0])*p->nLSlot);
4363 if( p->aLTerm!=p->aLTermSpace ) sqlite3DbFree(db, p->aLTerm);
4364 p->aLTerm = paNew;
4365 p->nLSlot = n;
4366 return SQLITE_OK;
4367}
4368
4369/*
4370** Transfer content from the second pLoop into the first.
4371*/
4372static int whereLoopXfer(sqlite3 *db, WhereLoop *pTo, WhereLoop *pFrom){
drh4efc9292013-06-06 23:02:03 +00004373 whereLoopClearUnion(db, pTo);
drh0d31dc32013-09-06 00:40:59 +00004374 if( whereLoopResize(db, pTo, pFrom->nLTerm) ){
4375 memset(&pTo->u, 0, sizeof(pTo->u));
4376 return SQLITE_NOMEM;
4377 }
drha2014152013-06-07 00:29:23 +00004378 memcpy(pTo, pFrom, WHERE_LOOP_XFER_SZ);
4379 memcpy(pTo->aLTerm, pFrom->aLTerm, pTo->nLTerm*sizeof(pTo->aLTerm[0]));
drh4efc9292013-06-06 23:02:03 +00004380 if( pFrom->wsFlags & WHERE_VIRTUALTABLE ){
4381 pFrom->u.vtab.needFree = 0;
drh986b3872013-06-28 21:12:20 +00004382 }else if( (pFrom->wsFlags & WHERE_AUTO_INDEX)!=0 ){
drh4efc9292013-06-06 23:02:03 +00004383 pFrom->u.btree.pIndex = 0;
4384 }
4385 return SQLITE_OK;
4386}
4387
drh5346e952013-05-08 14:14:26 +00004388/*
drhf1b5f5b2013-05-02 00:15:01 +00004389** Delete a WhereLoop object
4390*/
4391static void whereLoopDelete(sqlite3 *db, WhereLoop *p){
drh5346e952013-05-08 14:14:26 +00004392 whereLoopClear(db, p);
drhf1b5f5b2013-05-02 00:15:01 +00004393 sqlite3DbFree(db, p);
4394}
drh84bfda42005-07-15 13:05:21 +00004395
drh9eff6162006-06-12 21:59:13 +00004396/*
4397** Free a WhereInfo structure
4398*/
drh10fe8402008-10-11 16:47:35 +00004399static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh52ff8ea2010-04-08 14:15:56 +00004400 if( ALWAYS(pWInfo) ){
danf89aa472015-04-25 12:20:24 +00004401 int i;
4402 for(i=0; i<pWInfo->nLevel; i++){
4403 WhereLevel *pLevel = &pWInfo->a[i];
4404 if( pLevel->pWLoop && (pLevel->pWLoop->wsFlags & WHERE_IN_ABLE) ){
4405 sqlite3DbFree(db, pLevel->u.in.aInLoop);
4406 }
4407 }
drh70d18342013-06-06 19:16:33 +00004408 whereClauseClear(&pWInfo->sWC);
drhf1b5f5b2013-05-02 00:15:01 +00004409 while( pWInfo->pLoops ){
4410 WhereLoop *p = pWInfo->pLoops;
4411 pWInfo->pLoops = p->pNextLoop;
4412 whereLoopDelete(db, p);
4413 }
drh633e6d52008-07-28 19:34:53 +00004414 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00004415 }
4416}
4417
drhf1b5f5b2013-05-02 00:15:01 +00004418/*
drhe0de8762014-11-05 13:13:13 +00004419** Return TRUE if all of the following are true:
drhb355c2c2014-04-18 22:20:31 +00004420**
4421** (1) X has the same or lower cost that Y
4422** (2) X is a proper subset of Y
drhe0de8762014-11-05 13:13:13 +00004423** (3) X skips at least as many columns as Y
drhb355c2c2014-04-18 22:20:31 +00004424**
4425** By "proper subset" we mean that X uses fewer WHERE clause terms
4426** than Y and that every WHERE clause term used by X is also used
4427** by Y.
4428**
4429** If X is a proper subset of Y then Y is a better choice and ought
4430** to have a lower cost. This routine returns TRUE when that cost
drhe0de8762014-11-05 13:13:13 +00004431** relationship is inverted and needs to be adjusted. The third rule
4432** was added because if X uses skip-scan less than Y it still might
4433** deserve a lower cost even if it is a proper subset of Y.
drh3fb183d2014-03-31 19:49:00 +00004434*/
drhb355c2c2014-04-18 22:20:31 +00004435static int whereLoopCheaperProperSubset(
4436 const WhereLoop *pX, /* First WhereLoop to compare */
4437 const WhereLoop *pY /* Compare against this WhereLoop */
4438){
drh3fb183d2014-03-31 19:49:00 +00004439 int i, j;
drhc8bbce12014-10-21 01:05:09 +00004440 if( pX->nLTerm-pX->nSkip >= pY->nLTerm-pY->nSkip ){
4441 return 0; /* X is not a subset of Y */
4442 }
drhe0de8762014-11-05 13:13:13 +00004443 if( pY->nSkip > pX->nSkip ) return 0;
drhb355c2c2014-04-18 22:20:31 +00004444 if( pX->rRun >= pY->rRun ){
4445 if( pX->rRun > pY->rRun ) return 0; /* X costs more than Y */
4446 if( pX->nOut > pY->nOut ) return 0; /* X costs more than Y */
drh3fb183d2014-03-31 19:49:00 +00004447 }
drh9ee88102014-05-07 20:33:17 +00004448 for(i=pX->nLTerm-1; i>=0; i--){
drhc8bbce12014-10-21 01:05:09 +00004449 if( pX->aLTerm[i]==0 ) continue;
drhb355c2c2014-04-18 22:20:31 +00004450 for(j=pY->nLTerm-1; j>=0; j--){
4451 if( pY->aLTerm[j]==pX->aLTerm[i] ) break;
4452 }
4453 if( j<0 ) return 0; /* X not a subset of Y since term X[i] not used by Y */
4454 }
4455 return 1; /* All conditions meet */
drh3fb183d2014-03-31 19:49:00 +00004456}
4457
4458/*
4459** Try to adjust the cost of WhereLoop pTemplate upwards or downwards so
4460** that:
drh53cd10a2014-03-31 18:24:18 +00004461**
drh3fb183d2014-03-31 19:49:00 +00004462** (1) pTemplate costs less than any other WhereLoops that are a proper
4463** subset of pTemplate
drh53cd10a2014-03-31 18:24:18 +00004464**
drh3fb183d2014-03-31 19:49:00 +00004465** (2) pTemplate costs more than any other WhereLoops for which pTemplate
4466** is a proper subset.
drh53cd10a2014-03-31 18:24:18 +00004467**
drh3fb183d2014-03-31 19:49:00 +00004468** To say "WhereLoop X is a proper subset of Y" means that X uses fewer
4469** WHERE clause terms than Y and that every WHERE clause term used by X is
4470** also used by Y.
drh53cd10a2014-03-31 18:24:18 +00004471*/
4472static void whereLoopAdjustCost(const WhereLoop *p, WhereLoop *pTemplate){
4473 if( (pTemplate->wsFlags & WHERE_INDEXED)==0 ) return;
drh53cd10a2014-03-31 18:24:18 +00004474 for(; p; p=p->pNextLoop){
drh3fb183d2014-03-31 19:49:00 +00004475 if( p->iTab!=pTemplate->iTab ) continue;
4476 if( (p->wsFlags & WHERE_INDEXED)==0 ) continue;
drhb355c2c2014-04-18 22:20:31 +00004477 if( whereLoopCheaperProperSubset(p, pTemplate) ){
4478 /* Adjust pTemplate cost downward so that it is cheaper than its
drhe0de8762014-11-05 13:13:13 +00004479 ** subset p. */
drh1b131b72014-10-21 16:01:40 +00004480 WHERETRACE(0x80,("subset cost adjustment %d,%d to %d,%d\n",
4481 pTemplate->rRun, pTemplate->nOut, p->rRun, p->nOut-1));
drh3fb183d2014-03-31 19:49:00 +00004482 pTemplate->rRun = p->rRun;
4483 pTemplate->nOut = p->nOut - 1;
drhb355c2c2014-04-18 22:20:31 +00004484 }else if( whereLoopCheaperProperSubset(pTemplate, p) ){
4485 /* Adjust pTemplate cost upward so that it is costlier than p since
4486 ** pTemplate is a proper subset of p */
drh1b131b72014-10-21 16:01:40 +00004487 WHERETRACE(0x80,("subset cost adjustment %d,%d to %d,%d\n",
4488 pTemplate->rRun, pTemplate->nOut, p->rRun, p->nOut+1));
drh3fb183d2014-03-31 19:49:00 +00004489 pTemplate->rRun = p->rRun;
4490 pTemplate->nOut = p->nOut + 1;
drh53cd10a2014-03-31 18:24:18 +00004491 }
4492 }
4493}
4494
4495/*
drh7a4b1642014-03-29 21:16:07 +00004496** Search the list of WhereLoops in *ppPrev looking for one that can be
4497** supplanted by pTemplate.
drhf1b5f5b2013-05-02 00:15:01 +00004498**
drh7a4b1642014-03-29 21:16:07 +00004499** Return NULL if the WhereLoop list contains an entry that can supplant
4500** pTemplate, in other words if pTemplate does not belong on the list.
drh23f98da2013-05-21 15:52:07 +00004501**
drh7a4b1642014-03-29 21:16:07 +00004502** If pX is a WhereLoop that pTemplate can supplant, then return the
4503** link that points to pX.
drh23f98da2013-05-21 15:52:07 +00004504**
drh7a4b1642014-03-29 21:16:07 +00004505** If pTemplate cannot supplant any existing element of the list but needs
4506** to be added to the list, then return a pointer to the tail of the list.
drhf1b5f5b2013-05-02 00:15:01 +00004507*/
drh7a4b1642014-03-29 21:16:07 +00004508static WhereLoop **whereLoopFindLesser(
4509 WhereLoop **ppPrev,
4510 const WhereLoop *pTemplate
4511){
4512 WhereLoop *p;
4513 for(p=(*ppPrev); p; ppPrev=&p->pNextLoop, p=*ppPrev){
drhdbb80232013-06-19 12:34:13 +00004514 if( p->iTab!=pTemplate->iTab || p->iSortIdx!=pTemplate->iSortIdx ){
4515 /* If either the iTab or iSortIdx values for two WhereLoop are different
4516 ** then those WhereLoops need to be considered separately. Neither is
4517 ** a candidate to replace the other. */
4518 continue;
4519 }
4520 /* In the current implementation, the rSetup value is either zero
4521 ** or the cost of building an automatic index (NlogN) and the NlogN
4522 ** is the same for compatible WhereLoops. */
4523 assert( p->rSetup==0 || pTemplate->rSetup==0
4524 || p->rSetup==pTemplate->rSetup );
4525
4526 /* whereLoopAddBtree() always generates and inserts the automatic index
4527 ** case first. Hence compatible candidate WhereLoops never have a larger
4528 ** rSetup. Call this SETUP-INVARIANT */
4529 assert( p->rSetup>=pTemplate->rSetup );
4530
drhdabe36d2014-06-17 20:16:43 +00004531 /* Any loop using an appliation-defined index (or PRIMARY KEY or
4532 ** UNIQUE constraint) with one or more == constraints is better
dan70273d02014-11-14 19:34:20 +00004533 ** than an automatic index. Unless it is a skip-scan. */
drhdabe36d2014-06-17 20:16:43 +00004534 if( (p->wsFlags & WHERE_AUTO_INDEX)!=0
dan70273d02014-11-14 19:34:20 +00004535 && (pTemplate->nSkip)==0
drhdabe36d2014-06-17 20:16:43 +00004536 && (pTemplate->wsFlags & WHERE_INDEXED)!=0
4537 && (pTemplate->wsFlags & WHERE_COLUMN_EQ)!=0
4538 && (p->prereq & pTemplate->prereq)==pTemplate->prereq
4539 ){
4540 break;
4541 }
4542
drh53cd10a2014-03-31 18:24:18 +00004543 /* If existing WhereLoop p is better than pTemplate, pTemplate can be
4544 ** discarded. WhereLoop p is better if:
4545 ** (1) p has no more dependencies than pTemplate, and
4546 ** (2) p has an equal or lower cost than pTemplate
4547 */
4548 if( (p->prereq & pTemplate->prereq)==p->prereq /* (1) */
4549 && p->rSetup<=pTemplate->rSetup /* (2a) */
4550 && p->rRun<=pTemplate->rRun /* (2b) */
4551 && p->nOut<=pTemplate->nOut /* (2c) */
drhf1b5f5b2013-05-02 00:15:01 +00004552 ){
drh53cd10a2014-03-31 18:24:18 +00004553 return 0; /* Discard pTemplate */
drhf1b5f5b2013-05-02 00:15:01 +00004554 }
drh53cd10a2014-03-31 18:24:18 +00004555
4556 /* If pTemplate is always better than p, then cause p to be overwritten
4557 ** with pTemplate. pTemplate is better than p if:
4558 ** (1) pTemplate has no more dependences than p, and
4559 ** (2) pTemplate has an equal or lower cost than p.
4560 */
4561 if( (p->prereq & pTemplate->prereq)==pTemplate->prereq /* (1) */
4562 && p->rRun>=pTemplate->rRun /* (2a) */
4563 && p->nOut>=pTemplate->nOut /* (2b) */
drhf1b5f5b2013-05-02 00:15:01 +00004564 ){
drhadd5ce32013-09-07 00:29:06 +00004565 assert( p->rSetup>=pTemplate->rSetup ); /* SETUP-INVARIANT above */
drh53cd10a2014-03-31 18:24:18 +00004566 break; /* Cause p to be overwritten by pTemplate */
drhf1b5f5b2013-05-02 00:15:01 +00004567 }
4568 }
drh7a4b1642014-03-29 21:16:07 +00004569 return ppPrev;
4570}
4571
4572/*
drh94a11212004-09-25 13:12:14 +00004573** Insert or replace a WhereLoop entry using the template supplied.
4574**
4575** An existing WhereLoop entry might be overwritten if the new template
4576** is better and has fewer dependencies. Or the template will be ignored
4577** and no insert will occur if an existing WhereLoop is faster and has
4578** fewer dependencies than the template. Otherwise a new WhereLoop is
4579** added based on the template.
drh51669862004-12-18 18:40:26 +00004580**
drh7a4b1642014-03-29 21:16:07 +00004581** If pBuilder->pOrSet is not NULL then we care about only the
drh94a11212004-09-25 13:12:14 +00004582** prerequisites and rRun and nOut costs of the N best loops. That
4583** information is gathered in the pBuilder->pOrSet object. This special
drh51669862004-12-18 18:40:26 +00004584** processing mode is used only for OR clause processing.
4585**
4586** When accumulating multiple loops (when pBuilder->pOrSet is NULL) we
4587** still might overwrite similar loops with the new template if the
drh53cd10a2014-03-31 18:24:18 +00004588** new template is better. Loops may be overwritten if the following
drh94a11212004-09-25 13:12:14 +00004589** conditions are met:
4590**
4591** (1) They have the same iTab.
4592** (2) They have the same iSortIdx.
4593** (3) The template has same or fewer dependencies than the current loop
4594** (4) The template has the same or lower cost than the current loop
drh94a11212004-09-25 13:12:14 +00004595*/
4596static int whereLoopInsert(WhereLoopBuilder *pBuilder, WhereLoop *pTemplate){
drh7a4b1642014-03-29 21:16:07 +00004597 WhereLoop **ppPrev, *p;
drh94a11212004-09-25 13:12:14 +00004598 WhereInfo *pWInfo = pBuilder->pWInfo;
4599 sqlite3 *db = pWInfo->pParse->db;
4600
4601 /* If pBuilder->pOrSet is defined, then only keep track of the costs
4602 ** and prereqs.
4603 */
4604 if( pBuilder->pOrSet!=0 ){
4605#if WHERETRACE_ENABLED
drh51669862004-12-18 18:40:26 +00004606 u16 n = pBuilder->pOrSet->n;
4607 int x =
4608#endif
4609 whereOrInsert(pBuilder->pOrSet, pTemplate->prereq, pTemplate->rRun,
4610 pTemplate->nOut);
drh94a11212004-09-25 13:12:14 +00004611#if WHERETRACE_ENABLED /* 0x8 */
4612 if( sqlite3WhereTrace & 0x8 ){
drhe3184742002-06-19 14:27:05 +00004613 sqlite3DebugPrintf(x?" or-%d: ":" or-X: ", n);
drhacf3b982005-01-03 01:27:18 +00004614 whereLoopPrint(pTemplate, pBuilder->pWC);
drh75897232000-05-29 14:26:00 +00004615 }
danielk19774adee202004-05-08 08:23:19 +00004616#endif
drh75897232000-05-29 14:26:00 +00004617 return SQLITE_OK;
4618 }
4619
drh7a4b1642014-03-29 21:16:07 +00004620 /* Look for an existing WhereLoop to replace with pTemplate
drh75897232000-05-29 14:26:00 +00004621 */
drh53cd10a2014-03-31 18:24:18 +00004622 whereLoopAdjustCost(pWInfo->pLoops, pTemplate);
drh7a4b1642014-03-29 21:16:07 +00004623 ppPrev = whereLoopFindLesser(&pWInfo->pLoops, pTemplate);
drhf1b5f5b2013-05-02 00:15:01 +00004624
drh7a4b1642014-03-29 21:16:07 +00004625 if( ppPrev==0 ){
4626 /* There already exists a WhereLoop on the list that is better
4627 ** than pTemplate, so just ignore pTemplate */
4628#if WHERETRACE_ENABLED /* 0x8 */
4629 if( sqlite3WhereTrace & 0x8 ){
drh9a7b41d2014-10-08 00:08:08 +00004630 sqlite3DebugPrintf(" skip: ");
drh7a4b1642014-03-29 21:16:07 +00004631 whereLoopPrint(pTemplate, pBuilder->pWC);
drhf1b5f5b2013-05-02 00:15:01 +00004632 }
drh7a4b1642014-03-29 21:16:07 +00004633#endif
4634 return SQLITE_OK;
4635 }else{
4636 p = *ppPrev;
drhf1b5f5b2013-05-02 00:15:01 +00004637 }
4638
4639 /* If we reach this point it means that either p[] should be overwritten
4640 ** with pTemplate[] if p[] exists, or if p==NULL then allocate a new
4641 ** WhereLoop and insert it.
4642 */
drh989578e2013-10-28 14:34:35 +00004643#if WHERETRACE_ENABLED /* 0x8 */
drhae70cf12013-05-31 15:18:46 +00004644 if( sqlite3WhereTrace & 0x8 ){
4645 if( p!=0 ){
drh9a7b41d2014-10-08 00:08:08 +00004646 sqlite3DebugPrintf("replace: ");
drhc1ba2e72013-10-28 19:03:21 +00004647 whereLoopPrint(p, pBuilder->pWC);
drhae70cf12013-05-31 15:18:46 +00004648 }
drh9a7b41d2014-10-08 00:08:08 +00004649 sqlite3DebugPrintf(" add: ");
drhc1ba2e72013-10-28 19:03:21 +00004650 whereLoopPrint(pTemplate, pBuilder->pWC);
drhae70cf12013-05-31 15:18:46 +00004651 }
4652#endif
drhf1b5f5b2013-05-02 00:15:01 +00004653 if( p==0 ){
drh7a4b1642014-03-29 21:16:07 +00004654 /* Allocate a new WhereLoop to add to the end of the list */
4655 *ppPrev = p = sqlite3DbMallocRaw(db, sizeof(WhereLoop));
drhf1b5f5b2013-05-02 00:15:01 +00004656 if( p==0 ) return SQLITE_NOMEM;
drh4efc9292013-06-06 23:02:03 +00004657 whereLoopInit(p);
drh7a4b1642014-03-29 21:16:07 +00004658 p->pNextLoop = 0;
4659 }else{
4660 /* We will be overwriting WhereLoop p[]. But before we do, first
4661 ** go through the rest of the list and delete any other entries besides
4662 ** p[] that are also supplated by pTemplate */
4663 WhereLoop **ppTail = &p->pNextLoop;
4664 WhereLoop *pToDel;
4665 while( *ppTail ){
4666 ppTail = whereLoopFindLesser(ppTail, pTemplate);
drhdabe36d2014-06-17 20:16:43 +00004667 if( ppTail==0 ) break;
drh7a4b1642014-03-29 21:16:07 +00004668 pToDel = *ppTail;
4669 if( pToDel==0 ) break;
4670 *ppTail = pToDel->pNextLoop;
4671#if WHERETRACE_ENABLED /* 0x8 */
4672 if( sqlite3WhereTrace & 0x8 ){
drh9a7b41d2014-10-08 00:08:08 +00004673 sqlite3DebugPrintf(" delete: ");
drh7a4b1642014-03-29 21:16:07 +00004674 whereLoopPrint(pToDel, pBuilder->pWC);
4675 }
4676#endif
4677 whereLoopDelete(db, pToDel);
4678 }
drhf1b5f5b2013-05-02 00:15:01 +00004679 }
drh4efc9292013-06-06 23:02:03 +00004680 whereLoopXfer(db, p, pTemplate);
drh5346e952013-05-08 14:14:26 +00004681 if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
drhef866372013-05-22 20:49:02 +00004682 Index *pIndex = p->u.btree.pIndex;
4683 if( pIndex && pIndex->tnum==0 ){
drhcf8fa7a2013-05-10 20:26:22 +00004684 p->u.btree.pIndex = 0;
4685 }
drh5346e952013-05-08 14:14:26 +00004686 }
drhf1b5f5b2013-05-02 00:15:01 +00004687 return SQLITE_OK;
4688}
4689
4690/*
drhcca9f3d2013-09-06 15:23:29 +00004691** Adjust the WhereLoop.nOut value downward to account for terms of the
4692** WHERE clause that reference the loop but which are not used by an
4693** index.
drh7a1bca72014-11-22 18:50:44 +00004694*
4695** For every WHERE clause term that is not used by the index
4696** and which has a truth probability assigned by one of the likelihood(),
4697** likely(), or unlikely() SQL functions, reduce the estimated number
4698** of output rows by the probability specified.
drhcca9f3d2013-09-06 15:23:29 +00004699**
drh7a1bca72014-11-22 18:50:44 +00004700** TUNING: For every WHERE clause term that is not used by the index
4701** and which does not have an assigned truth probability, heuristics
4702** described below are used to try to estimate the truth probability.
4703** TODO --> Perhaps this is something that could be improved by better
4704** table statistics.
4705**
drhab4624d2014-11-22 19:52:10 +00004706** Heuristic 1: Estimate the truth probability as 93.75%. The 93.75%
4707** value corresponds to -1 in LogEst notation, so this means decrement
drh7a1bca72014-11-22 18:50:44 +00004708** the WhereLoop.nOut field for every such WHERE clause term.
4709**
4710** Heuristic 2: If there exists one or more WHERE clause terms of the
4711** form "x==EXPR" and EXPR is not a constant 0 or 1, then make sure the
4712** final output row estimate is no greater than 1/4 of the total number
4713** of rows in the table. In other words, assume that x==EXPR will filter
4714** out at least 3 out of 4 rows. If EXPR is -1 or 0 or 1, then maybe the
4715** "x" column is boolean or else -1 or 0 or 1 is a common default value
4716** on the "x" column and so in that case only cap the output row estimate
4717** at 1/2 instead of 1/4.
drhcca9f3d2013-09-06 15:23:29 +00004718*/
drhd8b77e22014-09-06 01:35:57 +00004719static void whereLoopOutputAdjust(
4720 WhereClause *pWC, /* The WHERE clause */
4721 WhereLoop *pLoop, /* The loop to adjust downward */
4722 LogEst nRow /* Number of rows in the entire table */
4723){
drh7d9e7d82013-09-11 17:39:09 +00004724 WhereTerm *pTerm, *pX;
drhcca9f3d2013-09-06 15:23:29 +00004725 Bitmask notAllowed = ~(pLoop->prereq|pLoop->maskSelf);
drh7a1bca72014-11-22 18:50:44 +00004726 int i, j, k;
4727 LogEst iReduce = 0; /* pLoop->nOut should not exceed nRow-iReduce */
drhadd5ce32013-09-07 00:29:06 +00004728
drha3898252014-11-22 12:22:13 +00004729 assert( (pLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
drhcca9f3d2013-09-06 15:23:29 +00004730 for(i=pWC->nTerm, pTerm=pWC->a; i>0; i--, pTerm++){
drh7d9e7d82013-09-11 17:39:09 +00004731 if( (pTerm->wtFlags & TERM_VIRTUAL)!=0 ) break;
drhcca9f3d2013-09-06 15:23:29 +00004732 if( (pTerm->prereqAll & pLoop->maskSelf)==0 ) continue;
4733 if( (pTerm->prereqAll & notAllowed)!=0 ) continue;
drh7d9e7d82013-09-11 17:39:09 +00004734 for(j=pLoop->nLTerm-1; j>=0; j--){
4735 pX = pLoop->aLTerm[j];
drhd2447442013-11-13 19:01:41 +00004736 if( pX==0 ) continue;
drh7d9e7d82013-09-11 17:39:09 +00004737 if( pX==pTerm ) break;
4738 if( pX->iParent>=0 && (&pWC->a[pX->iParent])==pTerm ) break;
4739 }
danaa9933c2014-04-24 20:04:49 +00004740 if( j<0 ){
drhd8b77e22014-09-06 01:35:57 +00004741 if( pTerm->truthProb<=0 ){
drh7a1bca72014-11-22 18:50:44 +00004742 /* If a truth probability is specified using the likelihood() hints,
4743 ** then use the probability provided by the application. */
drhd8b77e22014-09-06 01:35:57 +00004744 pLoop->nOut += pTerm->truthProb;
4745 }else{
drh7a1bca72014-11-22 18:50:44 +00004746 /* In the absence of explicit truth probabilities, use heuristics to
4747 ** guess a reasonable truth probability. */
drhd8b77e22014-09-06 01:35:57 +00004748 pLoop->nOut--;
drhe8d0c612015-05-14 01:05:25 +00004749 if( pTerm->eOperator&(WO_EQ|WO_IS) ){
drh7a1bca72014-11-22 18:50:44 +00004750 Expr *pRight = pTerm->pExpr->pRight;
drhe0cc3c22015-05-13 17:54:08 +00004751 testcase( pTerm->pExpr->op==TK_IS );
drh7a1bca72014-11-22 18:50:44 +00004752 if( sqlite3ExprIsInteger(pRight, &k) && k>=(-1) && k<=1 ){
4753 k = 10;
4754 }else{
4755 k = 20;
4756 }
4757 if( iReduce<k ) iReduce = k;
4758 }
drhd8b77e22014-09-06 01:35:57 +00004759 }
danaa9933c2014-04-24 20:04:49 +00004760 }
drhcca9f3d2013-09-06 15:23:29 +00004761 }
drh7a1bca72014-11-22 18:50:44 +00004762 if( pLoop->nOut > nRow-iReduce ) pLoop->nOut = nRow - iReduce;
drhcca9f3d2013-09-06 15:23:29 +00004763}
4764
4765/*
drhdbd94862014-07-23 23:57:42 +00004766** Adjust the cost C by the costMult facter T. This only occurs if
4767** compiled with -DSQLITE_ENABLE_COSTMULT
4768*/
4769#ifdef SQLITE_ENABLE_COSTMULT
4770# define ApplyCostMultiplier(C,T) C += T
4771#else
4772# define ApplyCostMultiplier(C,T)
4773#endif
4774
4775/*
dan4a6b8a02014-04-30 14:47:01 +00004776** We have so far matched pBuilder->pNew->u.btree.nEq terms of the
4777** index pIndex. Try to match one more.
4778**
4779** When this function is called, pBuilder->pNew->nOut contains the
4780** number of rows expected to be visited by filtering using the nEq
4781** terms only. If it is modified, this value is restored before this
4782** function returns.
drh1c8148f2013-05-04 20:25:23 +00004783**
4784** If pProbe->tnum==0, that means pIndex is a fake index used for the
4785** INTEGER PRIMARY KEY.
4786*/
drh5346e952013-05-08 14:14:26 +00004787static int whereLoopAddBtreeIndex(
drh1c8148f2013-05-04 20:25:23 +00004788 WhereLoopBuilder *pBuilder, /* The WhereLoop factory */
4789 struct SrcList_item *pSrc, /* FROM clause term being analyzed */
4790 Index *pProbe, /* An index on pSrc */
drhbf539c42013-10-05 18:16:02 +00004791 LogEst nInMul /* log(Number of iterations due to IN) */
drh1c8148f2013-05-04 20:25:23 +00004792){
drh70d18342013-06-06 19:16:33 +00004793 WhereInfo *pWInfo = pBuilder->pWInfo; /* WHERE analyse context */
4794 Parse *pParse = pWInfo->pParse; /* Parsing context */
4795 sqlite3 *db = pParse->db; /* Database connection malloc context */
drh1c8148f2013-05-04 20:25:23 +00004796 WhereLoop *pNew; /* Template WhereLoop under construction */
4797 WhereTerm *pTerm; /* A WhereTerm under consideration */
drh43fe25f2013-05-07 23:06:23 +00004798 int opMask; /* Valid operators for constraints */
drh1c8148f2013-05-04 20:25:23 +00004799 WhereScan scan; /* Iterator for WHERE terms */
drh4efc9292013-06-06 23:02:03 +00004800 Bitmask saved_prereq; /* Original value of pNew->prereq */
4801 u16 saved_nLTerm; /* Original value of pNew->nLTerm */
drhcd8629e2013-11-13 12:27:25 +00004802 u16 saved_nEq; /* Original value of pNew->u.btree.nEq */
drhc8bbce12014-10-21 01:05:09 +00004803 u16 saved_nSkip; /* Original value of pNew->nSkip */
drh4efc9292013-06-06 23:02:03 +00004804 u32 saved_wsFlags; /* Original value of pNew->wsFlags */
drhbf539c42013-10-05 18:16:02 +00004805 LogEst saved_nOut; /* Original value of pNew->nOut */
drha18f3d22013-05-08 03:05:41 +00004806 int iCol; /* Index of the column in the table */
drh5346e952013-05-08 14:14:26 +00004807 int rc = SQLITE_OK; /* Return code */
drhd8b77e22014-09-06 01:35:57 +00004808 LogEst rSize; /* Number of rows in the table */
drhbf539c42013-10-05 18:16:02 +00004809 LogEst rLogSize; /* Logarithm of table size */
drhc7f0d222013-06-19 03:27:12 +00004810 WhereTerm *pTop = 0, *pBtm = 0; /* Top and bottom range constraints */
drh1c8148f2013-05-04 20:25:23 +00004811
drh1c8148f2013-05-04 20:25:23 +00004812 pNew = pBuilder->pNew;
drh5346e952013-05-08 14:14:26 +00004813 if( db->mallocFailed ) return SQLITE_NOMEM;
drh1c8148f2013-05-04 20:25:23 +00004814
drh5346e952013-05-08 14:14:26 +00004815 assert( (pNew->wsFlags & WHERE_VIRTUALTABLE)==0 );
drh43fe25f2013-05-07 23:06:23 +00004816 assert( (pNew->wsFlags & WHERE_TOP_LIMIT)==0 );
4817 if( pNew->wsFlags & WHERE_BTM_LIMIT ){
4818 opMask = WO_LT|WO_LE;
drhee145872015-05-14 13:18:47 +00004819 }else if( /*pProbe->tnum<=0 ||*/ (pSrc->jointype & JT_LEFT)!=0 ){
drh43fe25f2013-05-07 23:06:23 +00004820 opMask = WO_EQ|WO_IN|WO_GT|WO_GE|WO_LT|WO_LE;
drh1c8148f2013-05-04 20:25:23 +00004821 }else{
drhe8d0c612015-05-14 01:05:25 +00004822 opMask = WO_EQ|WO_IN|WO_GT|WO_GE|WO_LT|WO_LE|WO_ISNULL|WO_IS;
drh1c8148f2013-05-04 20:25:23 +00004823 }
drhef866372013-05-22 20:49:02 +00004824 if( pProbe->bUnordered ) opMask &= ~(WO_GT|WO_GE|WO_LT|WO_LE);
drh1c8148f2013-05-04 20:25:23 +00004825
dan39129ce2014-06-30 15:23:57 +00004826 assert( pNew->u.btree.nEq<pProbe->nColumn );
4827 iCol = pProbe->aiColumn[pNew->u.btree.nEq];
4828
drha18f3d22013-05-08 03:05:41 +00004829 pTerm = whereScanInit(&scan, pBuilder->pWC, pSrc->iCursor, iCol,
drh0f133a42013-05-22 17:01:17 +00004830 opMask, pProbe);
drh4efc9292013-06-06 23:02:03 +00004831 saved_nEq = pNew->u.btree.nEq;
drhc8bbce12014-10-21 01:05:09 +00004832 saved_nSkip = pNew->nSkip;
drh4efc9292013-06-06 23:02:03 +00004833 saved_nLTerm = pNew->nLTerm;
4834 saved_wsFlags = pNew->wsFlags;
4835 saved_prereq = pNew->prereq;
4836 saved_nOut = pNew->nOut;
drhb8a8e8a2013-06-10 19:12:39 +00004837 pNew->rSetup = 0;
drhd8b77e22014-09-06 01:35:57 +00004838 rSize = pProbe->aiRowLogEst[0];
4839 rLogSize = estLog(rSize);
drh5346e952013-05-08 14:14:26 +00004840 for(; rc==SQLITE_OK && pTerm!=0; pTerm = whereScanNext(&scan)){
dan8ad1d8b2014-04-25 20:22:45 +00004841 u16 eOp = pTerm->eOperator; /* Shorthand for pTerm->eOperator */
danaa9933c2014-04-24 20:04:49 +00004842 LogEst rCostIdx;
dan8ad1d8b2014-04-25 20:22:45 +00004843 LogEst nOutUnadjusted; /* nOut before IN() and WHERE adjustments */
drhb8a8e8a2013-06-10 19:12:39 +00004844 int nIn = 0;
drh1435a9a2013-08-27 23:15:44 +00004845#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan7a419232013-08-06 20:01:43 +00004846 int nRecValid = pBuilder->nRecValid;
drhb5246e52013-07-08 21:12:57 +00004847#endif
dan8ad1d8b2014-04-25 20:22:45 +00004848 if( (eOp==WO_ISNULL || (pTerm->wtFlags&TERM_VNULL)!=0)
dan8bff07a2013-08-29 14:56:14 +00004849 && (iCol<0 || pSrc->pTab->aCol[iCol].notNull)
4850 ){
4851 continue; /* ignore IS [NOT] NULL constraints on NOT NULL columns */
4852 }
dan7a419232013-08-06 20:01:43 +00004853 if( pTerm->prereqRight & pNew->maskSelf ) continue;
4854
drha40da622015-03-09 12:11:56 +00004855 /* Do not allow the upper bound of a LIKE optimization range constraint
4856 ** to mix with a lower range bound from some other source */
4857 if( pTerm->wtFlags & TERM_LIKEOPT && pTerm->eOperator==WO_LT ) continue;
4858
drh4efc9292013-06-06 23:02:03 +00004859 pNew->wsFlags = saved_wsFlags;
4860 pNew->u.btree.nEq = saved_nEq;
4861 pNew->nLTerm = saved_nLTerm;
4862 if( whereLoopResize(db, pNew, pNew->nLTerm+1) ) break; /* OOM */
4863 pNew->aLTerm[pNew->nLTerm++] = pTerm;
4864 pNew->prereq = (saved_prereq | pTerm->prereqRight) & ~pNew->maskSelf;
dan8ad1d8b2014-04-25 20:22:45 +00004865
4866 assert( nInMul==0
4867 || (pNew->wsFlags & WHERE_COLUMN_NULL)!=0
4868 || (pNew->wsFlags & WHERE_COLUMN_IN)!=0
4869 || (pNew->wsFlags & WHERE_SKIPSCAN)!=0
4870 );
4871
4872 if( eOp & WO_IN ){
drha18f3d22013-05-08 03:05:41 +00004873 Expr *pExpr = pTerm->pExpr;
4874 pNew->wsFlags |= WHERE_COLUMN_IN;
4875 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drhe1e2e9a2013-06-13 15:16:53 +00004876 /* "x IN (SELECT ...)": TUNING: the SELECT returns 25 rows */
drhbf539c42013-10-05 18:16:02 +00004877 nIn = 46; assert( 46==sqlite3LogEst(25) );
drha18f3d22013-05-08 03:05:41 +00004878 }else if( ALWAYS(pExpr->x.pList && pExpr->x.pList->nExpr) ){
4879 /* "x IN (value, value, ...)" */
drhbf539c42013-10-05 18:16:02 +00004880 nIn = sqlite3LogEst(pExpr->x.pList->nExpr);
drhf1645f02013-05-07 19:44:38 +00004881 }
drh2b59b3a2014-03-20 13:26:47 +00004882 assert( nIn>0 ); /* RHS always has 2 or more terms... The parser
4883 ** changes "x IN (?)" into "x=?". */
dan8ad1d8b2014-04-25 20:22:45 +00004884
drhe8d0c612015-05-14 01:05:25 +00004885 }else if( eOp & (WO_EQ|WO_IS) ){
drha18f3d22013-05-08 03:05:41 +00004886 pNew->wsFlags |= WHERE_COLUMN_EQ;
dan8ad1d8b2014-04-25 20:22:45 +00004887 if( iCol<0 || (nInMul==0 && pNew->u.btree.nEq==pProbe->nKeyCol-1) ){
dan2813bde2015-04-11 11:44:27 +00004888 if( iCol>=0 && pProbe->uniqNotNull==0 ){
drhe39a7322014-02-03 14:04:11 +00004889 pNew->wsFlags |= WHERE_UNQ_WANTED;
4890 }else{
4891 pNew->wsFlags |= WHERE_ONEROW;
4892 }
drh21f7ff72013-06-03 15:07:23 +00004893 }
dan2dd3cdc2014-04-26 20:21:14 +00004894 }else if( eOp & WO_ISNULL ){
4895 pNew->wsFlags |= WHERE_COLUMN_NULL;
dan8ad1d8b2014-04-25 20:22:45 +00004896 }else if( eOp & (WO_GT|WO_GE) ){
4897 testcase( eOp & WO_GT );
4898 testcase( eOp & WO_GE );
drha18f3d22013-05-08 03:05:41 +00004899 pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_BTM_LIMIT;
drh6f2bfad2013-06-03 17:35:22 +00004900 pBtm = pTerm;
4901 pTop = 0;
drha40da622015-03-09 12:11:56 +00004902 if( pTerm->wtFlags & TERM_LIKEOPT ){
drh80314622015-03-09 13:01:02 +00004903 /* Range contraints that come from the LIKE optimization are
4904 ** always used in pairs. */
drha40da622015-03-09 12:11:56 +00004905 pTop = &pTerm[1];
4906 assert( (pTop-(pTerm->pWC->a))<pTerm->pWC->nTerm );
4907 assert( pTop->wtFlags & TERM_LIKEOPT );
4908 assert( pTop->eOperator==WO_LT );
4909 if( whereLoopResize(db, pNew, pNew->nLTerm+1) ) break; /* OOM */
4910 pNew->aLTerm[pNew->nLTerm++] = pTop;
4911 pNew->wsFlags |= WHERE_TOP_LIMIT;
4912 }
dan2dd3cdc2014-04-26 20:21:14 +00004913 }else{
dan8ad1d8b2014-04-25 20:22:45 +00004914 assert( eOp & (WO_LT|WO_LE) );
4915 testcase( eOp & WO_LT );
4916 testcase( eOp & WO_LE );
drha18f3d22013-05-08 03:05:41 +00004917 pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_TOP_LIMIT;
drh6f2bfad2013-06-03 17:35:22 +00004918 pTop = pTerm;
4919 pBtm = (pNew->wsFlags & WHERE_BTM_LIMIT)!=0 ?
drh4efc9292013-06-06 23:02:03 +00004920 pNew->aLTerm[pNew->nLTerm-2] : 0;
drh1c8148f2013-05-04 20:25:23 +00004921 }
dan8ad1d8b2014-04-25 20:22:45 +00004922
4923 /* At this point pNew->nOut is set to the number of rows expected to
4924 ** be visited by the index scan before considering term pTerm, or the
4925 ** values of nIn and nInMul. In other words, assuming that all
4926 ** "x IN(...)" terms are replaced with "x = ?". This block updates
4927 ** the value of pNew->nOut to account for pTerm (but not nIn/nInMul). */
4928 assert( pNew->nOut==saved_nOut );
drh6f2bfad2013-06-03 17:35:22 +00004929 if( pNew->wsFlags & WHERE_COLUMN_RANGE ){
danaa9933c2014-04-24 20:04:49 +00004930 /* Adjust nOut using stat3/stat4 data. Or, if there is no stat3/stat4
4931 ** data, using some other estimate. */
drh186ad8c2013-10-08 18:40:37 +00004932 whereRangeScanEst(pParse, pBuilder, pBtm, pTop, pNew);
dan8ad1d8b2014-04-25 20:22:45 +00004933 }else{
4934 int nEq = ++pNew->u.btree.nEq;
drhe8d0c612015-05-14 01:05:25 +00004935 assert( eOp & (WO_ISNULL|WO_EQ|WO_IN|WO_IS) );
dan8ad1d8b2014-04-25 20:22:45 +00004936
4937 assert( pNew->nOut==saved_nOut );
dan09e1df62014-04-29 16:10:22 +00004938 if( pTerm->truthProb<=0 && iCol>=0 ){
dan8ad1d8b2014-04-25 20:22:45 +00004939 assert( (eOp & WO_IN) || nIn==0 );
drhc5f246e2014-05-01 20:24:21 +00004940 testcase( eOp & WO_IN );
dan8ad1d8b2014-04-25 20:22:45 +00004941 pNew->nOut += pTerm->truthProb;
4942 pNew->nOut -= nIn;
dan8ad1d8b2014-04-25 20:22:45 +00004943 }else{
drh1435a9a2013-08-27 23:15:44 +00004944#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan8ad1d8b2014-04-25 20:22:45 +00004945 tRowcnt nOut = 0;
4946 if( nInMul==0
4947 && pProbe->nSample
4948 && pNew->u.btree.nEq<=pProbe->nSampleCol
dan8ad1d8b2014-04-25 20:22:45 +00004949 && ((eOp & WO_IN)==0 || !ExprHasProperty(pTerm->pExpr, EP_xIsSelect))
dan8ad1d8b2014-04-25 20:22:45 +00004950 ){
4951 Expr *pExpr = pTerm->pExpr;
drhe8d0c612015-05-14 01:05:25 +00004952 if( (eOp & (WO_EQ|WO_ISNULL|WO_IS))!=0 ){
4953 testcase( eOp & WO_EQ );
4954 testcase( eOp & WO_IS );
dan8ad1d8b2014-04-25 20:22:45 +00004955 testcase( eOp & WO_ISNULL );
4956 rc = whereEqualScanEst(pParse, pBuilder, pExpr->pRight, &nOut);
4957 }else{
4958 rc = whereInScanEst(pParse, pBuilder, pExpr->x.pList, &nOut);
4959 }
dan8ad1d8b2014-04-25 20:22:45 +00004960 if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
4961 if( rc!=SQLITE_OK ) break; /* Jump out of the pTerm loop */
4962 if( nOut ){
4963 pNew->nOut = sqlite3LogEst(nOut);
4964 if( pNew->nOut>saved_nOut ) pNew->nOut = saved_nOut;
4965 pNew->nOut -= nIn;
4966 }
4967 }
4968 if( nOut==0 )
4969#endif
4970 {
4971 pNew->nOut += (pProbe->aiRowLogEst[nEq] - pProbe->aiRowLogEst[nEq-1]);
4972 if( eOp & WO_ISNULL ){
4973 /* TUNING: If there is no likelihood() value, assume that a
4974 ** "col IS NULL" expression matches twice as many rows
4975 ** as (col=?). */
4976 pNew->nOut += 10;
4977 }
4978 }
dan6cb8d762013-08-08 11:48:57 +00004979 }
drh6f2bfad2013-06-03 17:35:22 +00004980 }
dan8ad1d8b2014-04-25 20:22:45 +00004981
danaa9933c2014-04-24 20:04:49 +00004982 /* Set rCostIdx to the cost of visiting selected rows in index. Add
4983 ** it to pNew->rRun, which is currently set to the cost of the index
4984 ** seek only. Then, if this is a non-covering index, add the cost of
4985 ** visiting the rows in the main table. */
4986 rCostIdx = pNew->nOut + 1 + (15*pProbe->szIdxRow)/pSrc->pTab->szTabRow;
dan8ad1d8b2014-04-25 20:22:45 +00004987 pNew->rRun = sqlite3LogEstAdd(rLogSize, rCostIdx);
drhe217efc2013-06-12 03:48:41 +00004988 if( (pNew->wsFlags & (WHERE_IDX_ONLY|WHERE_IPK))==0 ){
danaa9933c2014-04-24 20:04:49 +00004989 pNew->rRun = sqlite3LogEstAdd(pNew->rRun, pNew->nOut + 16);
drheb04de32013-05-10 15:16:30 +00004990 }
drhdbd94862014-07-23 23:57:42 +00004991 ApplyCostMultiplier(pNew->rRun, pProbe->pTable->costMult);
danaa9933c2014-04-24 20:04:49 +00004992
dan8ad1d8b2014-04-25 20:22:45 +00004993 nOutUnadjusted = pNew->nOut;
4994 pNew->rRun += nInMul + nIn;
4995 pNew->nOut += nInMul + nIn;
drhd8b77e22014-09-06 01:35:57 +00004996 whereLoopOutputAdjust(pBuilder->pWC, pNew, rSize);
drhcf8fa7a2013-05-10 20:26:22 +00004997 rc = whereLoopInsert(pBuilder, pNew);
dan440e6ff2014-04-28 08:49:54 +00004998
4999 if( pNew->wsFlags & WHERE_COLUMN_RANGE ){
5000 pNew->nOut = saved_nOut;
5001 }else{
5002 pNew->nOut = nOutUnadjusted;
5003 }
dan8ad1d8b2014-04-25 20:22:45 +00005004
drh5346e952013-05-08 14:14:26 +00005005 if( (pNew->wsFlags & WHERE_TOP_LIMIT)==0
dan39129ce2014-06-30 15:23:57 +00005006 && pNew->u.btree.nEq<pProbe->nColumn
drh5346e952013-05-08 14:14:26 +00005007 ){
drhb8a8e8a2013-06-10 19:12:39 +00005008 whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, nInMul+nIn);
drha18f3d22013-05-08 03:05:41 +00005009 }
danad45ed72013-08-08 12:21:32 +00005010 pNew->nOut = saved_nOut;
drh1435a9a2013-08-27 23:15:44 +00005011#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan7a419232013-08-06 20:01:43 +00005012 pBuilder->nRecValid = nRecValid;
dan7a419232013-08-06 20:01:43 +00005013#endif
drh1c8148f2013-05-04 20:25:23 +00005014 }
drh4efc9292013-06-06 23:02:03 +00005015 pNew->prereq = saved_prereq;
5016 pNew->u.btree.nEq = saved_nEq;
drhc8bbce12014-10-21 01:05:09 +00005017 pNew->nSkip = saved_nSkip;
drh4efc9292013-06-06 23:02:03 +00005018 pNew->wsFlags = saved_wsFlags;
5019 pNew->nOut = saved_nOut;
5020 pNew->nLTerm = saved_nLTerm;
drhc8bbce12014-10-21 01:05:09 +00005021
5022 /* Consider using a skip-scan if there are no WHERE clause constraints
5023 ** available for the left-most terms of the index, and if the average
5024 ** number of repeats in the left-most terms is at least 18.
5025 **
5026 ** The magic number 18 is selected on the basis that scanning 17 rows
5027 ** is almost always quicker than an index seek (even though if the index
5028 ** contains fewer than 2^17 rows we assume otherwise in other parts of
5029 ** the code). And, even if it is not, it should not be too much slower.
5030 ** On the other hand, the extra seeks could end up being significantly
5031 ** more expensive. */
5032 assert( 42==sqlite3LogEst(18) );
5033 if( saved_nEq==saved_nSkip
5034 && saved_nEq+1<pProbe->nKeyCol
drhf9df2fb2014-11-15 19:08:13 +00005035 && pProbe->noSkipScan==0
drhc8bbce12014-10-21 01:05:09 +00005036 && pProbe->aiRowLogEst[saved_nEq+1]>=42 /* TUNING: Minimum for skip-scan */
5037 && (rc = whereLoopResize(db, pNew, pNew->nLTerm+1))==SQLITE_OK
5038 ){
5039 LogEst nIter;
5040 pNew->u.btree.nEq++;
5041 pNew->nSkip++;
5042 pNew->aLTerm[pNew->nLTerm++] = 0;
5043 pNew->wsFlags |= WHERE_SKIPSCAN;
5044 nIter = pProbe->aiRowLogEst[saved_nEq] - pProbe->aiRowLogEst[saved_nEq+1];
drhc8bbce12014-10-21 01:05:09 +00005045 pNew->nOut -= nIter;
5046 /* TUNING: Because uncertainties in the estimates for skip-scan queries,
5047 ** add a 1.375 fudge factor to make skip-scan slightly less likely. */
5048 nIter += 5;
5049 whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, nIter + nInMul);
5050 pNew->nOut = saved_nOut;
5051 pNew->u.btree.nEq = saved_nEq;
5052 pNew->nSkip = saved_nSkip;
5053 pNew->wsFlags = saved_wsFlags;
5054 }
5055
drh5346e952013-05-08 14:14:26 +00005056 return rc;
drh1c8148f2013-05-04 20:25:23 +00005057}
5058
5059/*
drh23f98da2013-05-21 15:52:07 +00005060** Return True if it is possible that pIndex might be useful in
5061** implementing the ORDER BY clause in pBuilder.
5062**
5063** Return False if pBuilder does not contain an ORDER BY clause or
5064** if there is no way for pIndex to be useful in implementing that
5065** ORDER BY clause.
5066*/
5067static int indexMightHelpWithOrderBy(
5068 WhereLoopBuilder *pBuilder,
5069 Index *pIndex,
5070 int iCursor
5071){
5072 ExprList *pOB;
drh6d381472013-06-13 17:58:08 +00005073 int ii, jj;
drh23f98da2013-05-21 15:52:07 +00005074
drh53cfbe92013-06-13 17:28:22 +00005075 if( pIndex->bUnordered ) return 0;
drh70d18342013-06-06 19:16:33 +00005076 if( (pOB = pBuilder->pWInfo->pOrderBy)==0 ) return 0;
drh23f98da2013-05-21 15:52:07 +00005077 for(ii=0; ii<pOB->nExpr; ii++){
drh45c154a2013-06-03 20:46:35 +00005078 Expr *pExpr = sqlite3ExprSkipCollate(pOB->a[ii].pExpr);
drh23f98da2013-05-21 15:52:07 +00005079 if( pExpr->op!=TK_COLUMN ) return 0;
5080 if( pExpr->iTable==iCursor ){
drh137fd4f2014-09-19 02:01:37 +00005081 if( pExpr->iColumn<0 ) return 1;
drhbbbdc832013-10-22 18:01:40 +00005082 for(jj=0; jj<pIndex->nKeyCol; jj++){
drh6d381472013-06-13 17:58:08 +00005083 if( pExpr->iColumn==pIndex->aiColumn[jj] ) return 1;
5084 }
drh23f98da2013-05-21 15:52:07 +00005085 }
5086 }
5087 return 0;
5088}
5089
5090/*
drh92a121f2013-06-10 12:15:47 +00005091** Return a bitmask where 1s indicate that the corresponding column of
5092** the table is used by an index. Only the first 63 columns are considered.
5093*/
drhfd5874d2013-06-12 14:52:39 +00005094static Bitmask columnsInIndex(Index *pIdx){
drh92a121f2013-06-10 12:15:47 +00005095 Bitmask m = 0;
5096 int j;
drhec95c442013-10-23 01:57:32 +00005097 for(j=pIdx->nColumn-1; j>=0; j--){
drh92a121f2013-06-10 12:15:47 +00005098 int x = pIdx->aiColumn[j];
drhec95c442013-10-23 01:57:32 +00005099 if( x>=0 ){
5100 testcase( x==BMS-1 );
5101 testcase( x==BMS-2 );
5102 if( x<BMS-1 ) m |= MASKBIT(x);
5103 }
drh92a121f2013-06-10 12:15:47 +00005104 }
5105 return m;
5106}
5107
drh4bd5f732013-07-31 23:22:39 +00005108/* Check to see if a partial index with pPartIndexWhere can be used
5109** in the current query. Return true if it can be and false if not.
5110*/
5111static int whereUsablePartialIndex(int iTab, WhereClause *pWC, Expr *pWhere){
5112 int i;
5113 WhereTerm *pTerm;
5114 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
dan2a45cb52015-02-24 20:10:49 +00005115 Expr *pExpr = pTerm->pExpr;
5116 if( sqlite3ExprImpliesExpr(pExpr, pWhere, iTab)
5117 && (!ExprHasProperty(pExpr, EP_FromJoin) || pExpr->iRightJoinTable==iTab)
drh077f06e2015-02-24 16:48:59 +00005118 ){
5119 return 1;
5120 }
drh4bd5f732013-07-31 23:22:39 +00005121 }
5122 return 0;
5123}
drh92a121f2013-06-10 12:15:47 +00005124
5125/*
dan51576f42013-07-02 10:06:15 +00005126** Add all WhereLoop objects for a single table of the join where the table
drh0823c892013-05-11 00:06:23 +00005127** is idenfied by pBuilder->pNew->iTab. That table is guaranteed to be
5128** a b-tree table, not a virtual table.
dan81647222014-04-30 15:00:16 +00005129**
5130** The costs (WhereLoop.rRun) of the b-tree loops added by this function
5131** are calculated as follows:
5132**
5133** For a full scan, assuming the table (or index) contains nRow rows:
5134**
5135** cost = nRow * 3.0 // full-table scan
5136** cost = nRow * K // scan of covering index
5137** cost = nRow * (K+3.0) // scan of non-covering index
5138**
5139** where K is a value between 1.1 and 3.0 set based on the relative
5140** estimated average size of the index and table records.
5141**
5142** For an index scan, where nVisit is the number of index rows visited
5143** by the scan, and nSeek is the number of seek operations required on
5144** the index b-tree:
5145**
5146** cost = nSeek * (log(nRow) + K * nVisit) // covering index
5147** cost = nSeek * (log(nRow) + (K+3.0) * nVisit) // non-covering index
5148**
5149** Normally, nSeek is 1. nSeek values greater than 1 come about if the
5150** WHERE clause includes "x IN (....)" terms used in place of "x=?". Or when
5151** implicit "x IN (SELECT x FROM tbl)" terms are added for skip-scans.
drh83a305f2014-07-22 12:05:32 +00005152**
5153** The estimated values (nRow, nVisit, nSeek) often contain a large amount
5154** of uncertainty. For this reason, scoring is designed to pick plans that
5155** "do the least harm" if the estimates are inaccurate. For example, a
5156** log(nRow) factor is omitted from a non-covering index scan in order to
5157** bias the scoring in favor of using an index, since the worst-case
5158** performance of using an index is far better than the worst-case performance
5159** of a full table scan.
drhf1b5f5b2013-05-02 00:15:01 +00005160*/
drh5346e952013-05-08 14:14:26 +00005161static int whereLoopAddBtree(
drh1c8148f2013-05-04 20:25:23 +00005162 WhereLoopBuilder *pBuilder, /* WHERE clause information */
drh1c8148f2013-05-04 20:25:23 +00005163 Bitmask mExtra /* Extra prerequesites for using this table */
drhf1b5f5b2013-05-02 00:15:01 +00005164){
drh70d18342013-06-06 19:16:33 +00005165 WhereInfo *pWInfo; /* WHERE analysis context */
drh1c8148f2013-05-04 20:25:23 +00005166 Index *pProbe; /* An index we are evaluating */
drh1c8148f2013-05-04 20:25:23 +00005167 Index sPk; /* A fake index object for the primary key */
dancfc9df72014-04-25 15:01:01 +00005168 LogEst aiRowEstPk[2]; /* The aiRowLogEst[] value for the sPk index */
drhbbbdc832013-10-22 18:01:40 +00005169 i16 aiColumnPk = -1; /* The aColumn[] value for the sPk index */
drh70d18342013-06-06 19:16:33 +00005170 SrcList *pTabList; /* The FROM clause */
drh1c8148f2013-05-04 20:25:23 +00005171 struct SrcList_item *pSrc; /* The FROM clause btree term to add */
drh1c8148f2013-05-04 20:25:23 +00005172 WhereLoop *pNew; /* Template WhereLoop object */
drh5346e952013-05-08 14:14:26 +00005173 int rc = SQLITE_OK; /* Return code */
drhd044d202013-05-31 12:43:55 +00005174 int iSortIdx = 1; /* Index number */
drh23f98da2013-05-21 15:52:07 +00005175 int b; /* A boolean value */
drhbf539c42013-10-05 18:16:02 +00005176 LogEst rSize; /* number of rows in the table */
5177 LogEst rLogSize; /* Logarithm of the number of rows in the table */
drh4bd5f732013-07-31 23:22:39 +00005178 WhereClause *pWC; /* The parsed WHERE clause */
drh3495d202013-10-07 17:32:15 +00005179 Table *pTab; /* Table being queried */
drh23f98da2013-05-21 15:52:07 +00005180
drh1c8148f2013-05-04 20:25:23 +00005181 pNew = pBuilder->pNew;
drh70d18342013-06-06 19:16:33 +00005182 pWInfo = pBuilder->pWInfo;
5183 pTabList = pWInfo->pTabList;
5184 pSrc = pTabList->a + pNew->iTab;
drh3495d202013-10-07 17:32:15 +00005185 pTab = pSrc->pTab;
drh4bd5f732013-07-31 23:22:39 +00005186 pWC = pBuilder->pWC;
drh0823c892013-05-11 00:06:23 +00005187 assert( !IsVirtual(pSrc->pTab) );
drh1c8148f2013-05-04 20:25:23 +00005188
5189 if( pSrc->pIndex ){
5190 /* An INDEXED BY clause specifies a particular index to use */
5191 pProbe = pSrc->pIndex;
drhec95c442013-10-23 01:57:32 +00005192 }else if( !HasRowid(pTab) ){
5193 pProbe = pTab->pIndex;
drh1c8148f2013-05-04 20:25:23 +00005194 }else{
5195 /* There is no INDEXED BY clause. Create a fake Index object in local
5196 ** variable sPk to represent the rowid primary key index. Make this
5197 ** fake index the first in a chain of Index objects with all of the real
5198 ** indices to follow */
5199 Index *pFirst; /* First of real indices on the table */
5200 memset(&sPk, 0, sizeof(Index));
drhbbbdc832013-10-22 18:01:40 +00005201 sPk.nKeyCol = 1;
dan39129ce2014-06-30 15:23:57 +00005202 sPk.nColumn = 1;
drh1c8148f2013-05-04 20:25:23 +00005203 sPk.aiColumn = &aiColumnPk;
dancfc9df72014-04-25 15:01:01 +00005204 sPk.aiRowLogEst = aiRowEstPk;
drh1c8148f2013-05-04 20:25:23 +00005205 sPk.onError = OE_Replace;
drh3495d202013-10-07 17:32:15 +00005206 sPk.pTable = pTab;
danaa9933c2014-04-24 20:04:49 +00005207 sPk.szIdxRow = pTab->szTabRow;
dancfc9df72014-04-25 15:01:01 +00005208 aiRowEstPk[0] = pTab->nRowLogEst;
5209 aiRowEstPk[1] = 0;
drh1c8148f2013-05-04 20:25:23 +00005210 pFirst = pSrc->pTab->pIndex;
5211 if( pSrc->notIndexed==0 ){
5212 /* The real indices of the table are only considered if the
5213 ** NOT INDEXED qualifier is omitted from the FROM clause */
5214 sPk.pNext = pFirst;
5215 }
5216 pProbe = &sPk;
5217 }
dancfc9df72014-04-25 15:01:01 +00005218 rSize = pTab->nRowLogEst;
drheb04de32013-05-10 15:16:30 +00005219 rLogSize = estLog(rSize);
5220
drhfeb56e02013-08-23 17:33:46 +00005221#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drheb04de32013-05-10 15:16:30 +00005222 /* Automatic indexes */
drhd092ed42015-05-29 14:36:30 +00005223 if( !pBuilder->pOrSet /* Not part of an OR optimization */
drh8e8e7ef2015-03-02 17:25:00 +00005224 && (pWInfo->wctrlFlags & WHERE_NO_AUTOINDEX)==0
drh4fe425a2013-06-12 17:08:06 +00005225 && (pWInfo->pParse->db->flags & SQLITE_AutoIndex)!=0
drhd092ed42015-05-29 14:36:30 +00005226 && pSrc->pIndex==0 /* Has no INDEXED BY clause */
5227 && !pSrc->notIndexed /* Has no NOT INDEXED clause */
5228 && HasRowid(pTab) /* Is not a WITHOUT ROWID table. (FIXME: Why not?) */
5229 && !pSrc->isCorrelated /* Not a correlated subquery */
5230 && !pSrc->isRecursive /* Not a recursive common table expression. */
drheb04de32013-05-10 15:16:30 +00005231 ){
5232 /* Generate auto-index WhereLoops */
drheb04de32013-05-10 15:16:30 +00005233 WhereTerm *pTerm;
5234 WhereTerm *pWCEnd = pWC->a + pWC->nTerm;
5235 for(pTerm=pWC->a; rc==SQLITE_OK && pTerm<pWCEnd; pTerm++){
drh79a13bf2013-05-31 20:28:28 +00005236 if( pTerm->prereqRight & pNew->maskSelf ) continue;
drheb04de32013-05-10 15:16:30 +00005237 if( termCanDriveIndex(pTerm, pSrc, 0) ){
5238 pNew->u.btree.nEq = 1;
drhc8bbce12014-10-21 01:05:09 +00005239 pNew->nSkip = 0;
drhef866372013-05-22 20:49:02 +00005240 pNew->u.btree.pIndex = 0;
drh4efc9292013-06-06 23:02:03 +00005241 pNew->nLTerm = 1;
5242 pNew->aLTerm[0] = pTerm;
drhe1e2e9a2013-06-13 15:16:53 +00005243 /* TUNING: One-time cost for computing the automatic index is
drh7e074332014-09-22 14:30:51 +00005244 ** estimated to be X*N*log2(N) where N is the number of rows in
5245 ** the table being indexed and where X is 7 (LogEst=28) for normal
5246 ** tables or 1.375 (LogEst=4) for views and subqueries. The value
5247 ** of X is smaller for views and subqueries so that the query planner
5248 ** will be more aggressive about generating automatic indexes for
5249 ** those objects, since there is no opportunity to add schema
5250 ** indexes on subqueries and views. */
5251 pNew->rSetup = rLogSize + rSize + 4;
5252 if( pTab->pSelect==0 && (pTab->tabFlags & TF_Ephemeral)==0 ){
5253 pNew->rSetup += 24;
5254 }
drhdbd94862014-07-23 23:57:42 +00005255 ApplyCostMultiplier(pNew->rSetup, pTab->costMult);
drh986b3872013-06-28 21:12:20 +00005256 /* TUNING: Each index lookup yields 20 rows in the table. This
5257 ** is more than the usual guess of 10 rows, since we have no way
peter.d.reid60ec9142014-09-06 16:39:46 +00005258 ** of knowing how selective the index will ultimately be. It would
drh986b3872013-06-28 21:12:20 +00005259 ** not be unreasonable to make this value much larger. */
drhbf539c42013-10-05 18:16:02 +00005260 pNew->nOut = 43; assert( 43==sqlite3LogEst(20) );
drhb50596d2013-10-08 20:42:41 +00005261 pNew->rRun = sqlite3LogEstAdd(rLogSize,pNew->nOut);
drh986b3872013-06-28 21:12:20 +00005262 pNew->wsFlags = WHERE_AUTO_INDEX;
drheb04de32013-05-10 15:16:30 +00005263 pNew->prereq = mExtra | pTerm->prereqRight;
drhcf8fa7a2013-05-10 20:26:22 +00005264 rc = whereLoopInsert(pBuilder, pNew);
drheb04de32013-05-10 15:16:30 +00005265 }
5266 }
5267 }
drhfeb56e02013-08-23 17:33:46 +00005268#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh1c8148f2013-05-04 20:25:23 +00005269
5270 /* Loop over all indices
5271 */
drh23f98da2013-05-21 15:52:07 +00005272 for(; rc==SQLITE_OK && pProbe; pProbe=pProbe->pNext, iSortIdx++){
drh4bd5f732013-07-31 23:22:39 +00005273 if( pProbe->pPartIdxWhere!=0
dan08291692014-08-27 17:37:20 +00005274 && !whereUsablePartialIndex(pSrc->iCursor, pWC, pProbe->pPartIdxWhere) ){
5275 testcase( pNew->iTab!=pSrc->iCursor ); /* See ticket [98d973b8f5] */
drh4bd5f732013-07-31 23:22:39 +00005276 continue; /* Partial index inappropriate for this query */
5277 }
dan7de2a1f2014-04-28 20:11:20 +00005278 rSize = pProbe->aiRowLogEst[0];
drh5346e952013-05-08 14:14:26 +00005279 pNew->u.btree.nEq = 0;
drhc8bbce12014-10-21 01:05:09 +00005280 pNew->nSkip = 0;
drh4efc9292013-06-06 23:02:03 +00005281 pNew->nLTerm = 0;
drh23f98da2013-05-21 15:52:07 +00005282 pNew->iSortIdx = 0;
drhb8a8e8a2013-06-10 19:12:39 +00005283 pNew->rSetup = 0;
drh23f98da2013-05-21 15:52:07 +00005284 pNew->prereq = mExtra;
drh74f91d42013-06-19 18:01:44 +00005285 pNew->nOut = rSize;
drh23f98da2013-05-21 15:52:07 +00005286 pNew->u.btree.pIndex = pProbe;
5287 b = indexMightHelpWithOrderBy(pBuilder, pProbe, pSrc->iCursor);
drh53cfbe92013-06-13 17:28:22 +00005288 /* The ONEPASS_DESIRED flags never occurs together with ORDER BY */
5289 assert( (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || b==0 );
drh43fe25f2013-05-07 23:06:23 +00005290 if( pProbe->tnum<=0 ){
5291 /* Integer primary key index */
5292 pNew->wsFlags = WHERE_IPK;
drh23f98da2013-05-21 15:52:07 +00005293
5294 /* Full table scan */
drhd044d202013-05-31 12:43:55 +00005295 pNew->iSortIdx = b ? iSortIdx : 0;
danaa9933c2014-04-24 20:04:49 +00005296 /* TUNING: Cost of full table scan is (N*3.0). */
5297 pNew->rRun = rSize + 16;
drhdbd94862014-07-23 23:57:42 +00005298 ApplyCostMultiplier(pNew->rRun, pTab->costMult);
drhd8b77e22014-09-06 01:35:57 +00005299 whereLoopOutputAdjust(pWC, pNew, rSize);
drh23f98da2013-05-21 15:52:07 +00005300 rc = whereLoopInsert(pBuilder, pNew);
drhcca9f3d2013-09-06 15:23:29 +00005301 pNew->nOut = rSize;
drh23f98da2013-05-21 15:52:07 +00005302 if( rc ) break;
drh43fe25f2013-05-07 23:06:23 +00005303 }else{
drhec95c442013-10-23 01:57:32 +00005304 Bitmask m;
5305 if( pProbe->isCovering ){
5306 pNew->wsFlags = WHERE_IDX_ONLY | WHERE_INDEXED;
5307 m = 0;
5308 }else{
5309 m = pSrc->colUsed & ~columnsInIndex(pProbe);
5310 pNew->wsFlags = (m==0) ? (WHERE_IDX_ONLY|WHERE_INDEXED) : WHERE_INDEXED;
5311 }
drh1c8148f2013-05-04 20:25:23 +00005312
drh23f98da2013-05-21 15:52:07 +00005313 /* Full scan via index */
drh53cfbe92013-06-13 17:28:22 +00005314 if( b
drh702ba9f2013-11-07 21:25:13 +00005315 || !HasRowid(pTab)
drh53cfbe92013-06-13 17:28:22 +00005316 || ( m==0
5317 && pProbe->bUnordered==0
drh702ba9f2013-11-07 21:25:13 +00005318 && (pProbe->szIdxRow<pTab->szTabRow)
drh53cfbe92013-06-13 17:28:22 +00005319 && (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0
5320 && sqlite3GlobalConfig.bUseCis
5321 && OptimizationEnabled(pWInfo->pParse->db, SQLITE_CoverIdxScan)
5322 )
drhe3b7c922013-06-03 19:17:40 +00005323 ){
drh23f98da2013-05-21 15:52:07 +00005324 pNew->iSortIdx = b ? iSortIdx : 0;
danaa9933c2014-04-24 20:04:49 +00005325
5326 /* The cost of visiting the index rows is N*K, where K is
5327 ** between 1.1 and 3.0, depending on the relative sizes of the
5328 ** index and table rows. If this is a non-covering index scan,
5329 ** also add the cost of visiting table rows (N*3.0). */
5330 pNew->rRun = rSize + 1 + (15*pProbe->szIdxRow)/pTab->szTabRow;
5331 if( m!=0 ){
5332 pNew->rRun = sqlite3LogEstAdd(pNew->rRun, rSize+16);
drhe1e2e9a2013-06-13 15:16:53 +00005333 }
drhdbd94862014-07-23 23:57:42 +00005334 ApplyCostMultiplier(pNew->rRun, pTab->costMult);
drhd8b77e22014-09-06 01:35:57 +00005335 whereLoopOutputAdjust(pWC, pNew, rSize);
drh23f98da2013-05-21 15:52:07 +00005336 rc = whereLoopInsert(pBuilder, pNew);
drhcca9f3d2013-09-06 15:23:29 +00005337 pNew->nOut = rSize;
drh23f98da2013-05-21 15:52:07 +00005338 if( rc ) break;
5339 }
5340 }
dan7a419232013-08-06 20:01:43 +00005341
drhb8a8e8a2013-06-10 19:12:39 +00005342 rc = whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, 0);
drh1435a9a2013-08-27 23:15:44 +00005343#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan87cd9322013-08-07 15:52:41 +00005344 sqlite3Stat4ProbeFree(pBuilder->pRec);
5345 pBuilder->nRecValid = 0;
5346 pBuilder->pRec = 0;
danddc2d6e2013-08-06 20:15:06 +00005347#endif
drh1c8148f2013-05-04 20:25:23 +00005348
5349 /* If there was an INDEXED BY clause, then only that one index is
5350 ** considered. */
5351 if( pSrc->pIndex ) break;
5352 }
drh5346e952013-05-08 14:14:26 +00005353 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00005354}
5355
drh8636e9c2013-06-11 01:50:08 +00005356#ifndef SQLITE_OMIT_VIRTUALTABLE
drhf1b5f5b2013-05-02 00:15:01 +00005357/*
drh0823c892013-05-11 00:06:23 +00005358** Add all WhereLoop objects for a table of the join identified by
5359** pBuilder->pNew->iTab. That table is guaranteed to be a virtual table.
drhf1b5f5b2013-05-02 00:15:01 +00005360*/
drh5346e952013-05-08 14:14:26 +00005361static int whereLoopAddVirtual(
danff4b23b2013-11-12 12:17:16 +00005362 WhereLoopBuilder *pBuilder, /* WHERE clause information */
5363 Bitmask mExtra
drhf1b5f5b2013-05-02 00:15:01 +00005364){
drh70d18342013-06-06 19:16:33 +00005365 WhereInfo *pWInfo; /* WHERE analysis context */
drh5346e952013-05-08 14:14:26 +00005366 Parse *pParse; /* The parsing context */
5367 WhereClause *pWC; /* The WHERE clause */
5368 struct SrcList_item *pSrc; /* The FROM clause term to search */
5369 Table *pTab;
5370 sqlite3 *db;
5371 sqlite3_index_info *pIdxInfo;
5372 struct sqlite3_index_constraint *pIdxCons;
5373 struct sqlite3_index_constraint_usage *pUsage;
5374 WhereTerm *pTerm;
5375 int i, j;
5376 int iTerm, mxTerm;
drh4efc9292013-06-06 23:02:03 +00005377 int nConstraint;
drh5346e952013-05-08 14:14:26 +00005378 int seenIn = 0; /* True if an IN operator is seen */
5379 int seenVar = 0; /* True if a non-constant constraint is seen */
5380 int iPhase; /* 0: const w/o IN, 1: const, 2: no IN, 2: IN */
5381 WhereLoop *pNew;
drh5346e952013-05-08 14:14:26 +00005382 int rc = SQLITE_OK;
5383
drh70d18342013-06-06 19:16:33 +00005384 pWInfo = pBuilder->pWInfo;
5385 pParse = pWInfo->pParse;
drh5346e952013-05-08 14:14:26 +00005386 db = pParse->db;
5387 pWC = pBuilder->pWC;
drh5346e952013-05-08 14:14:26 +00005388 pNew = pBuilder->pNew;
drh70d18342013-06-06 19:16:33 +00005389 pSrc = &pWInfo->pTabList->a[pNew->iTab];
drhb2a90f02013-05-10 03:30:49 +00005390 pTab = pSrc->pTab;
drh0823c892013-05-11 00:06:23 +00005391 assert( IsVirtual(pTab) );
drhb2a90f02013-05-10 03:30:49 +00005392 pIdxInfo = allocateIndexInfo(pParse, pWC, pSrc, pBuilder->pOrderBy);
drh5346e952013-05-08 14:14:26 +00005393 if( pIdxInfo==0 ) return SQLITE_NOMEM;
drh5346e952013-05-08 14:14:26 +00005394 pNew->prereq = 0;
drh5346e952013-05-08 14:14:26 +00005395 pNew->rSetup = 0;
5396 pNew->wsFlags = WHERE_VIRTUALTABLE;
drh4efc9292013-06-06 23:02:03 +00005397 pNew->nLTerm = 0;
drh5346e952013-05-08 14:14:26 +00005398 pNew->u.vtab.needFree = 0;
5399 pUsage = pIdxInfo->aConstraintUsage;
drh4efc9292013-06-06 23:02:03 +00005400 nConstraint = pIdxInfo->nConstraint;
drh7963b0e2013-06-17 21:37:40 +00005401 if( whereLoopResize(db, pNew, nConstraint) ){
5402 sqlite3DbFree(db, pIdxInfo);
5403 return SQLITE_NOMEM;
5404 }
drh5346e952013-05-08 14:14:26 +00005405
drh0823c892013-05-11 00:06:23 +00005406 for(iPhase=0; iPhase<=3; iPhase++){
drh5346e952013-05-08 14:14:26 +00005407 if( !seenIn && (iPhase&1)!=0 ){
5408 iPhase++;
5409 if( iPhase>3 ) break;
5410 }
5411 if( !seenVar && iPhase>1 ) break;
5412 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
5413 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
5414 j = pIdxCons->iTermOffset;
5415 pTerm = &pWC->a[j];
5416 switch( iPhase ){
5417 case 0: /* Constants without IN operator */
5418 pIdxCons->usable = 0;
5419 if( (pTerm->eOperator & WO_IN)!=0 ){
5420 seenIn = 1;
drh7963b0e2013-06-17 21:37:40 +00005421 }
5422 if( pTerm->prereqRight!=0 ){
drh5346e952013-05-08 14:14:26 +00005423 seenVar = 1;
drh7963b0e2013-06-17 21:37:40 +00005424 }else if( (pTerm->eOperator & WO_IN)==0 ){
drh5346e952013-05-08 14:14:26 +00005425 pIdxCons->usable = 1;
5426 }
5427 break;
5428 case 1: /* Constants with IN operators */
5429 assert( seenIn );
5430 pIdxCons->usable = (pTerm->prereqRight==0);
5431 break;
5432 case 2: /* Variables without IN */
5433 assert( seenVar );
5434 pIdxCons->usable = (pTerm->eOperator & WO_IN)==0;
5435 break;
5436 default: /* Variables with IN */
5437 assert( seenVar && seenIn );
5438 pIdxCons->usable = 1;
5439 break;
5440 }
5441 }
5442 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
5443 if( pIdxInfo->needToFreeIdxStr ) sqlite3_free(pIdxInfo->idxStr);
5444 pIdxInfo->idxStr = 0;
5445 pIdxInfo->idxNum = 0;
5446 pIdxInfo->needToFreeIdxStr = 0;
5447 pIdxInfo->orderByConsumed = 0;
drh8636e9c2013-06-11 01:50:08 +00005448 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / (double)2;
dana9f58152013-11-11 19:01:33 +00005449 pIdxInfo->estimatedRows = 25;
drh5346e952013-05-08 14:14:26 +00005450 rc = vtabBestIndex(pParse, pTab, pIdxInfo);
5451 if( rc ) goto whereLoopAddVtab_exit;
5452 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
danff4b23b2013-11-12 12:17:16 +00005453 pNew->prereq = mExtra;
drhc718f1c2013-05-08 20:05:58 +00005454 mxTerm = -1;
drh4efc9292013-06-06 23:02:03 +00005455 assert( pNew->nLSlot>=nConstraint );
5456 for(i=0; i<nConstraint; i++) pNew->aLTerm[i] = 0;
drh3bd26f02013-05-24 14:52:03 +00005457 pNew->u.vtab.omitMask = 0;
drh4efc9292013-06-06 23:02:03 +00005458 for(i=0; i<nConstraint; i++, pIdxCons++){
drh5346e952013-05-08 14:14:26 +00005459 if( (iTerm = pUsage[i].argvIndex - 1)>=0 ){
5460 j = pIdxCons->iTermOffset;
drh4efc9292013-06-06 23:02:03 +00005461 if( iTerm>=nConstraint
drh5346e952013-05-08 14:14:26 +00005462 || j<0
5463 || j>=pWC->nTerm
drh4efc9292013-06-06 23:02:03 +00005464 || pNew->aLTerm[iTerm]!=0
drh5346e952013-05-08 14:14:26 +00005465 ){
5466 rc = SQLITE_ERROR;
5467 sqlite3ErrorMsg(pParse, "%s.xBestIndex() malfunction", pTab->zName);
5468 goto whereLoopAddVtab_exit;
5469 }
drh7963b0e2013-06-17 21:37:40 +00005470 testcase( iTerm==nConstraint-1 );
5471 testcase( j==0 );
5472 testcase( j==pWC->nTerm-1 );
drh5346e952013-05-08 14:14:26 +00005473 pTerm = &pWC->a[j];
5474 pNew->prereq |= pTerm->prereqRight;
drh4efc9292013-06-06 23:02:03 +00005475 assert( iTerm<pNew->nLSlot );
5476 pNew->aLTerm[iTerm] = pTerm;
drh5346e952013-05-08 14:14:26 +00005477 if( iTerm>mxTerm ) mxTerm = iTerm;
drh7963b0e2013-06-17 21:37:40 +00005478 testcase( iTerm==15 );
5479 testcase( iTerm==16 );
drh52986302013-06-03 16:03:16 +00005480 if( iTerm<16 && pUsage[i].omit ) pNew->u.vtab.omitMask |= 1<<iTerm;
drh5346e952013-05-08 14:14:26 +00005481 if( (pTerm->eOperator & WO_IN)!=0 ){
5482 if( pUsage[i].omit==0 ){
5483 /* Do not attempt to use an IN constraint if the virtual table
5484 ** says that the equivalent EQ constraint cannot be safely omitted.
5485 ** If we do attempt to use such a constraint, some rows might be
5486 ** repeated in the output. */
5487 break;
5488 }
5489 /* A virtual table that is constrained by an IN clause may not
5490 ** consume the ORDER BY clause because (1) the order of IN terms
5491 ** is not necessarily related to the order of output terms and
5492 ** (2) Multiple outputs from a single IN value will not merge
5493 ** together. */
5494 pIdxInfo->orderByConsumed = 0;
5495 }
5496 }
5497 }
drh4efc9292013-06-06 23:02:03 +00005498 if( i>=nConstraint ){
5499 pNew->nLTerm = mxTerm+1;
5500 assert( pNew->nLTerm<=pNew->nLSlot );
drh5346e952013-05-08 14:14:26 +00005501 pNew->u.vtab.idxNum = pIdxInfo->idxNum;
5502 pNew->u.vtab.needFree = pIdxInfo->needToFreeIdxStr;
5503 pIdxInfo->needToFreeIdxStr = 0;
5504 pNew->u.vtab.idxStr = pIdxInfo->idxStr;
drh0401ace2014-03-18 15:30:27 +00005505 pNew->u.vtab.isOrdered = (i8)(pIdxInfo->orderByConsumed ?
5506 pIdxInfo->nOrderBy : 0);
drhb8a8e8a2013-06-10 19:12:39 +00005507 pNew->rSetup = 0;
drhb50596d2013-10-08 20:42:41 +00005508 pNew->rRun = sqlite3LogEstFromDouble(pIdxInfo->estimatedCost);
dana9f58152013-11-11 19:01:33 +00005509 pNew->nOut = sqlite3LogEst(pIdxInfo->estimatedRows);
drhcf8fa7a2013-05-10 20:26:22 +00005510 whereLoopInsert(pBuilder, pNew);
drh5346e952013-05-08 14:14:26 +00005511 if( pNew->u.vtab.needFree ){
5512 sqlite3_free(pNew->u.vtab.idxStr);
5513 pNew->u.vtab.needFree = 0;
5514 }
5515 }
5516 }
5517
5518whereLoopAddVtab_exit:
5519 if( pIdxInfo->needToFreeIdxStr ) sqlite3_free(pIdxInfo->idxStr);
5520 sqlite3DbFree(db, pIdxInfo);
5521 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00005522}
drh8636e9c2013-06-11 01:50:08 +00005523#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhf1b5f5b2013-05-02 00:15:01 +00005524
5525/*
drhcf8fa7a2013-05-10 20:26:22 +00005526** Add WhereLoop entries to handle OR terms. This works for either
5527** btrees or virtual tables.
5528*/
5529static int whereLoopAddOr(WhereLoopBuilder *pBuilder, Bitmask mExtra){
drh70d18342013-06-06 19:16:33 +00005530 WhereInfo *pWInfo = pBuilder->pWInfo;
drhcf8fa7a2013-05-10 20:26:22 +00005531 WhereClause *pWC;
5532 WhereLoop *pNew;
5533 WhereTerm *pTerm, *pWCEnd;
5534 int rc = SQLITE_OK;
5535 int iCur;
5536 WhereClause tempWC;
5537 WhereLoopBuilder sSubBuild;
dan5da73e12014-04-30 18:11:55 +00005538 WhereOrSet sSum, sCur;
drhcf8fa7a2013-05-10 20:26:22 +00005539 struct SrcList_item *pItem;
5540
drhcf8fa7a2013-05-10 20:26:22 +00005541 pWC = pBuilder->pWC;
drhcf8fa7a2013-05-10 20:26:22 +00005542 pWCEnd = pWC->a + pWC->nTerm;
5543 pNew = pBuilder->pNew;
drh77dfd5b2013-08-19 11:15:48 +00005544 memset(&sSum, 0, sizeof(sSum));
drh186ad8c2013-10-08 18:40:37 +00005545 pItem = pWInfo->pTabList->a + pNew->iTab;
5546 iCur = pItem->iCursor;
drhcf8fa7a2013-05-10 20:26:22 +00005547
5548 for(pTerm=pWC->a; pTerm<pWCEnd && rc==SQLITE_OK; pTerm++){
5549 if( (pTerm->eOperator & WO_OR)!=0
5550 && (pTerm->u.pOrInfo->indexable & pNew->maskSelf)!=0
5551 ){
5552 WhereClause * const pOrWC = &pTerm->u.pOrInfo->wc;
5553 WhereTerm * const pOrWCEnd = &pOrWC->a[pOrWC->nTerm];
5554 WhereTerm *pOrTerm;
drhaa32e3c2013-07-16 21:31:23 +00005555 int once = 1;
5556 int i, j;
drh783dece2013-06-05 17:53:43 +00005557
drh783dece2013-06-05 17:53:43 +00005558 sSubBuild = *pBuilder;
5559 sSubBuild.pOrderBy = 0;
drhaa32e3c2013-07-16 21:31:23 +00005560 sSubBuild.pOrSet = &sCur;
drhcf8fa7a2013-05-10 20:26:22 +00005561
drh0a99ba32014-09-30 17:03:35 +00005562 WHERETRACE(0x200, ("Begin processing OR-clause %p\n", pTerm));
drhc7f0d222013-06-19 03:27:12 +00005563 for(pOrTerm=pOrWC->a; pOrTerm<pOrWCEnd; pOrTerm++){
drh783dece2013-06-05 17:53:43 +00005564 if( (pOrTerm->eOperator & WO_AND)!=0 ){
drhcf8fa7a2013-05-10 20:26:22 +00005565 sSubBuild.pWC = &pOrTerm->u.pAndInfo->wc;
5566 }else if( pOrTerm->leftCursor==iCur ){
drh70d18342013-06-06 19:16:33 +00005567 tempWC.pWInfo = pWC->pWInfo;
drh783dece2013-06-05 17:53:43 +00005568 tempWC.pOuter = pWC;
5569 tempWC.op = TK_AND;
drh783dece2013-06-05 17:53:43 +00005570 tempWC.nTerm = 1;
drhcf8fa7a2013-05-10 20:26:22 +00005571 tempWC.a = pOrTerm;
5572 sSubBuild.pWC = &tempWC;
5573 }else{
5574 continue;
5575 }
drhaa32e3c2013-07-16 21:31:23 +00005576 sCur.n = 0;
drh52651492014-09-30 14:14:19 +00005577#ifdef WHERETRACE_ENABLED
drh0a99ba32014-09-30 17:03:35 +00005578 WHERETRACE(0x200, ("OR-term %d of %p has %d subterms:\n",
5579 (int)(pOrTerm-pOrWC->a), pTerm, sSubBuild.pWC->nTerm));
5580 if( sqlite3WhereTrace & 0x400 ){
5581 for(i=0; i<sSubBuild.pWC->nTerm; i++){
5582 whereTermPrint(&sSubBuild.pWC->a[i], i);
5583 }
drh52651492014-09-30 14:14:19 +00005584 }
5585#endif
drh8636e9c2013-06-11 01:50:08 +00005586#ifndef SQLITE_OMIT_VIRTUALTABLE
drhcf8fa7a2013-05-10 20:26:22 +00005587 if( IsVirtual(pItem->pTab) ){
danff4b23b2013-11-12 12:17:16 +00005588 rc = whereLoopAddVirtual(&sSubBuild, mExtra);
drh8636e9c2013-06-11 01:50:08 +00005589 }else
5590#endif
5591 {
drhcf8fa7a2013-05-10 20:26:22 +00005592 rc = whereLoopAddBtree(&sSubBuild, mExtra);
5593 }
drh36be4c42014-09-30 17:31:23 +00005594 if( rc==SQLITE_OK ){
5595 rc = whereLoopAddOr(&sSubBuild, mExtra);
5596 }
drhaa32e3c2013-07-16 21:31:23 +00005597 assert( rc==SQLITE_OK || sCur.n==0 );
5598 if( sCur.n==0 ){
5599 sSum.n = 0;
5600 break;
5601 }else if( once ){
5602 whereOrMove(&sSum, &sCur);
5603 once = 0;
5604 }else{
dan5da73e12014-04-30 18:11:55 +00005605 WhereOrSet sPrev;
drhaa32e3c2013-07-16 21:31:23 +00005606 whereOrMove(&sPrev, &sSum);
5607 sSum.n = 0;
5608 for(i=0; i<sPrev.n; i++){
5609 for(j=0; j<sCur.n; j++){
5610 whereOrInsert(&sSum, sPrev.a[i].prereq | sCur.a[j].prereq,
drhbf539c42013-10-05 18:16:02 +00005611 sqlite3LogEstAdd(sPrev.a[i].rRun, sCur.a[j].rRun),
5612 sqlite3LogEstAdd(sPrev.a[i].nOut, sCur.a[j].nOut));
drhaa32e3c2013-07-16 21:31:23 +00005613 }
5614 }
5615 }
drhcf8fa7a2013-05-10 20:26:22 +00005616 }
drhaa32e3c2013-07-16 21:31:23 +00005617 pNew->nLTerm = 1;
5618 pNew->aLTerm[0] = pTerm;
5619 pNew->wsFlags = WHERE_MULTI_OR;
5620 pNew->rSetup = 0;
5621 pNew->iSortIdx = 0;
5622 memset(&pNew->u, 0, sizeof(pNew->u));
5623 for(i=0; rc==SQLITE_OK && i<sSum.n; i++){
dan5da73e12014-04-30 18:11:55 +00005624 /* TUNING: Currently sSum.a[i].rRun is set to the sum of the costs
5625 ** of all sub-scans required by the OR-scan. However, due to rounding
5626 ** errors, it may be that the cost of the OR-scan is equal to its
5627 ** most expensive sub-scan. Add the smallest possible penalty
5628 ** (equivalent to multiplying the cost by 1.07) to ensure that
5629 ** this does not happen. Otherwise, for WHERE clauses such as the
5630 ** following where there is an index on "y":
5631 **
5632 ** WHERE likelihood(x=?, 0.99) OR y=?
5633 **
5634 ** the planner may elect to "OR" together a full-table scan and an
5635 ** index lookup. And other similarly odd results. */
5636 pNew->rRun = sSum.a[i].rRun + 1;
drhaa32e3c2013-07-16 21:31:23 +00005637 pNew->nOut = sSum.a[i].nOut;
5638 pNew->prereq = sSum.a[i].prereq;
drhfd5874d2013-06-12 14:52:39 +00005639 rc = whereLoopInsert(pBuilder, pNew);
5640 }
drh0a99ba32014-09-30 17:03:35 +00005641 WHERETRACE(0x200, ("End processing OR-clause %p\n", pTerm));
drhcf8fa7a2013-05-10 20:26:22 +00005642 }
5643 }
5644 return rc;
5645}
5646
5647/*
drhf1b5f5b2013-05-02 00:15:01 +00005648** Add all WhereLoop objects for all tables
5649*/
drh5346e952013-05-08 14:14:26 +00005650static int whereLoopAddAll(WhereLoopBuilder *pBuilder){
drh70d18342013-06-06 19:16:33 +00005651 WhereInfo *pWInfo = pBuilder->pWInfo;
drhf1b5f5b2013-05-02 00:15:01 +00005652 Bitmask mExtra = 0;
5653 Bitmask mPrior = 0;
5654 int iTab;
drh70d18342013-06-06 19:16:33 +00005655 SrcList *pTabList = pWInfo->pTabList;
drhf1b5f5b2013-05-02 00:15:01 +00005656 struct SrcList_item *pItem;
drh70d18342013-06-06 19:16:33 +00005657 sqlite3 *db = pWInfo->pParse->db;
5658 int nTabList = pWInfo->nLevel;
drh5346e952013-05-08 14:14:26 +00005659 int rc = SQLITE_OK;
drhc63367e2013-06-10 20:46:50 +00005660 u8 priorJoinType = 0;
drhb8a8e8a2013-06-10 19:12:39 +00005661 WhereLoop *pNew;
drhf1b5f5b2013-05-02 00:15:01 +00005662
5663 /* Loop over the tables in the join, from left to right */
drhb8a8e8a2013-06-10 19:12:39 +00005664 pNew = pBuilder->pNew;
drha2014152013-06-07 00:29:23 +00005665 whereLoopInit(pNew);
drha18f3d22013-05-08 03:05:41 +00005666 for(iTab=0, pItem=pTabList->a; iTab<nTabList; iTab++, pItem++){
drhb2a90f02013-05-10 03:30:49 +00005667 pNew->iTab = iTab;
drh70d18342013-06-06 19:16:33 +00005668 pNew->maskSelf = getMask(&pWInfo->sMaskSet, pItem->iCursor);
drhc63367e2013-06-10 20:46:50 +00005669 if( ((pItem->jointype|priorJoinType) & (JT_LEFT|JT_CROSS))!=0 ){
drhf1b5f5b2013-05-02 00:15:01 +00005670 mExtra = mPrior;
5671 }
drhc63367e2013-06-10 20:46:50 +00005672 priorJoinType = pItem->jointype;
drhb2a90f02013-05-10 03:30:49 +00005673 if( IsVirtual(pItem->pTab) ){
danff4b23b2013-11-12 12:17:16 +00005674 rc = whereLoopAddVirtual(pBuilder, mExtra);
drhb2a90f02013-05-10 03:30:49 +00005675 }else{
5676 rc = whereLoopAddBtree(pBuilder, mExtra);
5677 }
drhb2a90f02013-05-10 03:30:49 +00005678 if( rc==SQLITE_OK ){
5679 rc = whereLoopAddOr(pBuilder, mExtra);
5680 }
drhb2a90f02013-05-10 03:30:49 +00005681 mPrior |= pNew->maskSelf;
drh5346e952013-05-08 14:14:26 +00005682 if( rc || db->mallocFailed ) break;
drhf1b5f5b2013-05-02 00:15:01 +00005683 }
drha2014152013-06-07 00:29:23 +00005684 whereLoopClear(db, pNew);
drh5346e952013-05-08 14:14:26 +00005685 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00005686}
5687
drha18f3d22013-05-08 03:05:41 +00005688/*
drh7699d1c2013-06-04 12:42:29 +00005689** Examine a WherePath (with the addition of the extra WhereLoop of the 5th
drh319f6772013-05-14 15:31:07 +00005690** parameters) to see if it outputs rows in the requested ORDER BY
drh0401ace2014-03-18 15:30:27 +00005691** (or GROUP BY) without requiring a separate sort operation. Return N:
drh319f6772013-05-14 15:31:07 +00005692**
drh0401ace2014-03-18 15:30:27 +00005693** N>0: N terms of the ORDER BY clause are satisfied
5694** N==0: No terms of the ORDER BY clause are satisfied
5695** N<0: Unknown yet how many terms of ORDER BY might be satisfied.
drh319f6772013-05-14 15:31:07 +00005696**
drh94433422013-07-01 11:05:50 +00005697** Note that processing for WHERE_GROUPBY and WHERE_DISTINCTBY is not as
5698** strict. With GROUP BY and DISTINCT the only requirement is that
5699** equivalent rows appear immediately adjacent to one another. GROUP BY
dan374cd782014-04-21 13:21:56 +00005700** and DISTINCT do not require rows to appear in any particular order as long
peter.d.reid60ec9142014-09-06 16:39:46 +00005701** as equivalent rows are grouped together. Thus for GROUP BY and DISTINCT
drh94433422013-07-01 11:05:50 +00005702** the pOrderBy terms can be matched in any order. With ORDER BY, the
5703** pOrderBy terms must be matched in strict left-to-right order.
drh6b7157b2013-05-10 02:00:35 +00005704*/
drh0401ace2014-03-18 15:30:27 +00005705static i8 wherePathSatisfiesOrderBy(
drh6b7157b2013-05-10 02:00:35 +00005706 WhereInfo *pWInfo, /* The WHERE clause */
drh4f402f22013-06-11 18:59:38 +00005707 ExprList *pOrderBy, /* ORDER BY or GROUP BY or DISTINCT clause to check */
drh6b7157b2013-05-10 02:00:35 +00005708 WherePath *pPath, /* The WherePath to check */
drh4f402f22013-06-11 18:59:38 +00005709 u16 wctrlFlags, /* Might contain WHERE_GROUPBY or WHERE_DISTINCTBY */
5710 u16 nLoop, /* Number of entries in pPath->aLoop[] */
drh319f6772013-05-14 15:31:07 +00005711 WhereLoop *pLast, /* Add this WhereLoop to the end of pPath->aLoop[] */
drh4f402f22013-06-11 18:59:38 +00005712 Bitmask *pRevMask /* OUT: Mask of WhereLoops to run in reverse order */
drh6b7157b2013-05-10 02:00:35 +00005713){
drh88da6442013-05-27 17:59:37 +00005714 u8 revSet; /* True if rev is known */
5715 u8 rev; /* Composite sort order */
5716 u8 revIdx; /* Index sort order */
drhe353ee32013-06-04 23:40:53 +00005717 u8 isOrderDistinct; /* All prior WhereLoops are order-distinct */
5718 u8 distinctColumns; /* True if the loop has UNIQUE NOT NULL columns */
5719 u8 isMatch; /* iColumn matches a term of the ORDER BY clause */
drh416846a2013-11-06 12:56:04 +00005720 u16 nKeyCol; /* Number of key columns in pIndex */
5721 u16 nColumn; /* Total number of ordered columns in the index */
drh7699d1c2013-06-04 12:42:29 +00005722 u16 nOrderBy; /* Number terms in the ORDER BY clause */
5723 int iLoop; /* Index of WhereLoop in pPath being processed */
5724 int i, j; /* Loop counters */
5725 int iCur; /* Cursor number for current WhereLoop */
5726 int iColumn; /* A column number within table iCur */
drhe8ae5832013-06-19 13:32:46 +00005727 WhereLoop *pLoop = 0; /* Current WhereLoop being processed. */
drh7699d1c2013-06-04 12:42:29 +00005728 WhereTerm *pTerm; /* A single term of the WHERE clause */
5729 Expr *pOBExpr; /* An expression from the ORDER BY clause */
5730 CollSeq *pColl; /* COLLATE function from an ORDER BY clause term */
5731 Index *pIndex; /* The index associated with pLoop */
5732 sqlite3 *db = pWInfo->pParse->db; /* Database connection */
5733 Bitmask obSat = 0; /* Mask of ORDER BY terms satisfied so far */
5734 Bitmask obDone; /* Mask of all ORDER BY terms */
drhe353ee32013-06-04 23:40:53 +00005735 Bitmask orderDistinctMask; /* Mask of all well-ordered loops */
drhb8916be2013-06-14 02:51:48 +00005736 Bitmask ready; /* Mask of inner loops */
drh319f6772013-05-14 15:31:07 +00005737
5738 /*
drh7699d1c2013-06-04 12:42:29 +00005739 ** We say the WhereLoop is "one-row" if it generates no more than one
5740 ** row of output. A WhereLoop is one-row if all of the following are true:
drh319f6772013-05-14 15:31:07 +00005741 ** (a) All index columns match with WHERE_COLUMN_EQ.
5742 ** (b) The index is unique
drh7699d1c2013-06-04 12:42:29 +00005743 ** Any WhereLoop with an WHERE_COLUMN_EQ constraint on the rowid is one-row.
5744 ** Every one-row WhereLoop will have the WHERE_ONEROW bit set in wsFlags.
drh319f6772013-05-14 15:31:07 +00005745 **
drhe353ee32013-06-04 23:40:53 +00005746 ** We say the WhereLoop is "order-distinct" if the set of columns from
5747 ** that WhereLoop that are in the ORDER BY clause are different for every
5748 ** row of the WhereLoop. Every one-row WhereLoop is automatically
5749 ** order-distinct. A WhereLoop that has no columns in the ORDER BY clause
5750 ** is not order-distinct. To be order-distinct is not quite the same as being
5751 ** UNIQUE since a UNIQUE column or index can have multiple rows that
5752 ** are NULL and NULL values are equivalent for the purpose of order-distinct.
5753 ** To be order-distinct, the columns must be UNIQUE and NOT NULL.
5754 **
5755 ** The rowid for a table is always UNIQUE and NOT NULL so whenever the
5756 ** rowid appears in the ORDER BY clause, the corresponding WhereLoop is
5757 ** automatically order-distinct.
drh319f6772013-05-14 15:31:07 +00005758 */
5759
5760 assert( pOrderBy!=0 );
drh7699d1c2013-06-04 12:42:29 +00005761 if( nLoop && OptimizationDisabled(db, SQLITE_OrderByIdxJoin) ) return 0;
drh319f6772013-05-14 15:31:07 +00005762
drh319f6772013-05-14 15:31:07 +00005763 nOrderBy = pOrderBy->nExpr;
drh7963b0e2013-06-17 21:37:40 +00005764 testcase( nOrderBy==BMS-1 );
drhe353ee32013-06-04 23:40:53 +00005765 if( nOrderBy>BMS-1 ) return 0; /* Cannot optimize overly large ORDER BYs */
5766 isOrderDistinct = 1;
drh7699d1c2013-06-04 12:42:29 +00005767 obDone = MASKBIT(nOrderBy)-1;
drhe353ee32013-06-04 23:40:53 +00005768 orderDistinctMask = 0;
drhb8916be2013-06-14 02:51:48 +00005769 ready = 0;
drhe353ee32013-06-04 23:40:53 +00005770 for(iLoop=0; isOrderDistinct && obSat<obDone && iLoop<=nLoop; iLoop++){
drhb8916be2013-06-14 02:51:48 +00005771 if( iLoop>0 ) ready |= pLoop->maskSelf;
drh7699d1c2013-06-04 12:42:29 +00005772 pLoop = iLoop<nLoop ? pPath->aLoop[iLoop] : pLast;
drh9dfaf622014-04-25 14:42:17 +00005773 if( pLoop->wsFlags & WHERE_VIRTUALTABLE ){
5774 if( pLoop->u.vtab.isOrdered ) obSat = obDone;
5775 break;
5776 }
drh319f6772013-05-14 15:31:07 +00005777 iCur = pWInfo->pTabList->a[pLoop->iTab].iCursor;
drhb8916be2013-06-14 02:51:48 +00005778
5779 /* Mark off any ORDER BY term X that is a column in the table of
5780 ** the current loop for which there is term in the WHERE
5781 ** clause of the form X IS NULL or X=? that reference only outer
5782 ** loops.
5783 */
5784 for(i=0; i<nOrderBy; i++){
5785 if( MASKBIT(i) & obSat ) continue;
5786 pOBExpr = sqlite3ExprSkipCollate(pOrderBy->a[i].pExpr);
5787 if( pOBExpr->op!=TK_COLUMN ) continue;
5788 if( pOBExpr->iTable!=iCur ) continue;
5789 pTerm = findTerm(&pWInfo->sWC, iCur, pOBExpr->iColumn,
drhe8d0c612015-05-14 01:05:25 +00005790 ~ready, WO_EQ|WO_ISNULL|WO_IS, 0);
drhb8916be2013-06-14 02:51:48 +00005791 if( pTerm==0 ) continue;
drhe8d0c612015-05-14 01:05:25 +00005792 if( (pTerm->eOperator&(WO_EQ|WO_IS))!=0 && pOBExpr->iColumn>=0 ){
drhb8916be2013-06-14 02:51:48 +00005793 const char *z1, *z2;
5794 pColl = sqlite3ExprCollSeq(pWInfo->pParse, pOrderBy->a[i].pExpr);
5795 if( !pColl ) pColl = db->pDfltColl;
5796 z1 = pColl->zName;
5797 pColl = sqlite3ExprCollSeq(pWInfo->pParse, pTerm->pExpr);
5798 if( !pColl ) pColl = db->pDfltColl;
5799 z2 = pColl->zName;
5800 if( sqlite3StrICmp(z1, z2)!=0 ) continue;
drhe0cc3c22015-05-13 17:54:08 +00005801 testcase( pTerm->pExpr->op==TK_IS );
drhb8916be2013-06-14 02:51:48 +00005802 }
5803 obSat |= MASKBIT(i);
5804 }
5805
drh7699d1c2013-06-04 12:42:29 +00005806 if( (pLoop->wsFlags & WHERE_ONEROW)==0 ){
5807 if( pLoop->wsFlags & WHERE_IPK ){
5808 pIndex = 0;
drhbbbdc832013-10-22 18:01:40 +00005809 nKeyCol = 0;
drh416846a2013-11-06 12:56:04 +00005810 nColumn = 1;
drh7699d1c2013-06-04 12:42:29 +00005811 }else if( (pIndex = pLoop->u.btree.pIndex)==0 || pIndex->bUnordered ){
drh1b0f0262013-05-30 22:27:09 +00005812 return 0;
drh7699d1c2013-06-04 12:42:29 +00005813 }else{
drhbbbdc832013-10-22 18:01:40 +00005814 nKeyCol = pIndex->nKeyCol;
drh416846a2013-11-06 12:56:04 +00005815 nColumn = pIndex->nColumn;
5816 assert( nColumn==nKeyCol+1 || !HasRowid(pIndex->pTable) );
5817 assert( pIndex->aiColumn[nColumn-1]==(-1) || !HasRowid(pIndex->pTable));
drh5f1d1d92014-07-31 22:59:04 +00005818 isOrderDistinct = IsUniqueIndex(pIndex);
drh1b0f0262013-05-30 22:27:09 +00005819 }
drh7699d1c2013-06-04 12:42:29 +00005820
drh7699d1c2013-06-04 12:42:29 +00005821 /* Loop through all columns of the index and deal with the ones
5822 ** that are not constrained by == or IN.
5823 */
5824 rev = revSet = 0;
drhe353ee32013-06-04 23:40:53 +00005825 distinctColumns = 0;
drh416846a2013-11-06 12:56:04 +00005826 for(j=0; j<nColumn; j++){
drh7699d1c2013-06-04 12:42:29 +00005827 u8 bOnce; /* True to run the ORDER BY search loop */
5828
drhe353ee32013-06-04 23:40:53 +00005829 /* Skip over == and IS NULL terms */
drh7699d1c2013-06-04 12:42:29 +00005830 if( j<pLoop->u.btree.nEq
drhc8bbce12014-10-21 01:05:09 +00005831 && pLoop->nSkip==0
drhe8d0c612015-05-14 01:05:25 +00005832 && ((i = pLoop->aLTerm[j]->eOperator) & (WO_EQ|WO_ISNULL|WO_IS))!=0
drh7699d1c2013-06-04 12:42:29 +00005833 ){
drh7963b0e2013-06-17 21:37:40 +00005834 if( i & WO_ISNULL ){
5835 testcase( isOrderDistinct );
5836 isOrderDistinct = 0;
5837 }
drhe353ee32013-06-04 23:40:53 +00005838 continue;
drh7699d1c2013-06-04 12:42:29 +00005839 }
5840
drhe353ee32013-06-04 23:40:53 +00005841 /* Get the column number in the table (iColumn) and sort order
5842 ** (revIdx) for the j-th column of the index.
drh7699d1c2013-06-04 12:42:29 +00005843 */
drh416846a2013-11-06 12:56:04 +00005844 if( pIndex ){
drh7699d1c2013-06-04 12:42:29 +00005845 iColumn = pIndex->aiColumn[j];
5846 revIdx = pIndex->aSortOrder[j];
5847 if( iColumn==pIndex->pTable->iPKey ) iColumn = -1;
drhdc3cd4b2013-05-30 23:21:20 +00005848 }else{
drh7699d1c2013-06-04 12:42:29 +00005849 iColumn = -1;
5850 revIdx = 0;
drhdc3cd4b2013-05-30 23:21:20 +00005851 }
drh7699d1c2013-06-04 12:42:29 +00005852
5853 /* An unconstrained column that might be NULL means that this
drh416846a2013-11-06 12:56:04 +00005854 ** WhereLoop is not well-ordered
drh7699d1c2013-06-04 12:42:29 +00005855 */
drhe353ee32013-06-04 23:40:53 +00005856 if( isOrderDistinct
5857 && iColumn>=0
drh7699d1c2013-06-04 12:42:29 +00005858 && j>=pLoop->u.btree.nEq
5859 && pIndex->pTable->aCol[iColumn].notNull==0
5860 ){
drhe353ee32013-06-04 23:40:53 +00005861 isOrderDistinct = 0;
drh7699d1c2013-06-04 12:42:29 +00005862 }
5863
5864 /* Find the ORDER BY term that corresponds to the j-th column
dan374cd782014-04-21 13:21:56 +00005865 ** of the index and mark that ORDER BY term off
drh7699d1c2013-06-04 12:42:29 +00005866 */
5867 bOnce = 1;
drhe353ee32013-06-04 23:40:53 +00005868 isMatch = 0;
drh7699d1c2013-06-04 12:42:29 +00005869 for(i=0; bOnce && i<nOrderBy; i++){
5870 if( MASKBIT(i) & obSat ) continue;
5871 pOBExpr = sqlite3ExprSkipCollate(pOrderBy->a[i].pExpr);
drh93ec45d2013-06-17 18:20:48 +00005872 testcase( wctrlFlags & WHERE_GROUPBY );
5873 testcase( wctrlFlags & WHERE_DISTINCTBY );
drh4f402f22013-06-11 18:59:38 +00005874 if( (wctrlFlags & (WHERE_GROUPBY|WHERE_DISTINCTBY))==0 ) bOnce = 0;
drhe353ee32013-06-04 23:40:53 +00005875 if( pOBExpr->op!=TK_COLUMN ) continue;
drh7699d1c2013-06-04 12:42:29 +00005876 if( pOBExpr->iTable!=iCur ) continue;
5877 if( pOBExpr->iColumn!=iColumn ) continue;
5878 if( iColumn>=0 ){
5879 pColl = sqlite3ExprCollSeq(pWInfo->pParse, pOrderBy->a[i].pExpr);
5880 if( !pColl ) pColl = db->pDfltColl;
5881 if( sqlite3StrICmp(pColl->zName, pIndex->azColl[j])!=0 ) continue;
5882 }
drhe353ee32013-06-04 23:40:53 +00005883 isMatch = 1;
drh7699d1c2013-06-04 12:42:29 +00005884 break;
5885 }
drh49290472014-10-11 02:12:58 +00005886 if( isMatch && (wctrlFlags & WHERE_GROUPBY)==0 ){
drh59b8f2e2014-03-22 00:27:14 +00005887 /* Make sure the sort order is compatible in an ORDER BY clause.
5888 ** Sort order is irrelevant for a GROUP BY clause. */
5889 if( revSet ){
5890 if( (rev ^ revIdx)!=pOrderBy->a[i].sortOrder ) isMatch = 0;
5891 }else{
5892 rev = revIdx ^ pOrderBy->a[i].sortOrder;
5893 if( rev ) *pRevMask |= MASKBIT(iLoop);
5894 revSet = 1;
5895 }
5896 }
drhe353ee32013-06-04 23:40:53 +00005897 if( isMatch ){
drh7963b0e2013-06-17 21:37:40 +00005898 if( iColumn<0 ){
5899 testcase( distinctColumns==0 );
5900 distinctColumns = 1;
5901 }
drh7699d1c2013-06-04 12:42:29 +00005902 obSat |= MASKBIT(i);
drh7699d1c2013-06-04 12:42:29 +00005903 }else{
5904 /* No match found */
drhbbbdc832013-10-22 18:01:40 +00005905 if( j==0 || j<nKeyCol ){
drh7963b0e2013-06-17 21:37:40 +00005906 testcase( isOrderDistinct!=0 );
5907 isOrderDistinct = 0;
5908 }
drh7699d1c2013-06-04 12:42:29 +00005909 break;
5910 }
5911 } /* end Loop over all index columns */
drh81186b42013-06-18 01:52:41 +00005912 if( distinctColumns ){
5913 testcase( isOrderDistinct==0 );
5914 isOrderDistinct = 1;
5915 }
drh7699d1c2013-06-04 12:42:29 +00005916 } /* end-if not one-row */
5917
5918 /* Mark off any other ORDER BY terms that reference pLoop */
drhe353ee32013-06-04 23:40:53 +00005919 if( isOrderDistinct ){
5920 orderDistinctMask |= pLoop->maskSelf;
drh7699d1c2013-06-04 12:42:29 +00005921 for(i=0; i<nOrderBy; i++){
5922 Expr *p;
drh434a9312014-02-26 02:26:09 +00005923 Bitmask mTerm;
drh7699d1c2013-06-04 12:42:29 +00005924 if( MASKBIT(i) & obSat ) continue;
5925 p = pOrderBy->a[i].pExpr;
drh434a9312014-02-26 02:26:09 +00005926 mTerm = exprTableUsage(&pWInfo->sMaskSet,p);
5927 if( mTerm==0 && !sqlite3ExprIsConstant(p) ) continue;
5928 if( (mTerm&~orderDistinctMask)==0 ){
drh7699d1c2013-06-04 12:42:29 +00005929 obSat |= MASKBIT(i);
5930 }
drh0afb4232013-05-31 13:36:32 +00005931 }
drh319f6772013-05-14 15:31:07 +00005932 }
drhb8916be2013-06-14 02:51:48 +00005933 } /* End the loop over all WhereLoops from outer-most down to inner-most */
drh36ed0342014-03-28 12:56:57 +00005934 if( obSat==obDone ) return (i8)nOrderBy;
drhd2de8612014-03-18 18:59:07 +00005935 if( !isOrderDistinct ){
5936 for(i=nOrderBy-1; i>0; i--){
5937 Bitmask m = MASKBIT(i) - 1;
5938 if( (obSat&m)==m ) return i;
5939 }
5940 return 0;
5941 }
drh319f6772013-05-14 15:31:07 +00005942 return -1;
drh6b7157b2013-05-10 02:00:35 +00005943}
5944
dan374cd782014-04-21 13:21:56 +00005945
5946/*
5947** If the WHERE_GROUPBY flag is set in the mask passed to sqlite3WhereBegin(),
5948** the planner assumes that the specified pOrderBy list is actually a GROUP
5949** BY clause - and so any order that groups rows as required satisfies the
5950** request.
5951**
5952** Normally, in this case it is not possible for the caller to determine
5953** whether or not the rows are really being delivered in sorted order, or
5954** just in some other order that provides the required grouping. However,
5955** if the WHERE_SORTBYGROUP flag is also passed to sqlite3WhereBegin(), then
5956** this function may be called on the returned WhereInfo object. It returns
5957** true if the rows really will be sorted in the specified order, or false
5958** otherwise.
5959**
5960** For example, assuming:
5961**
5962** CREATE INDEX i1 ON t1(x, Y);
5963**
5964** then
5965**
5966** SELECT * FROM t1 GROUP BY x,y ORDER BY x,y; -- IsSorted()==1
5967** SELECT * FROM t1 GROUP BY y,x ORDER BY y,x; -- IsSorted()==0
5968*/
5969int sqlite3WhereIsSorted(WhereInfo *pWInfo){
5970 assert( pWInfo->wctrlFlags & WHERE_GROUPBY );
5971 assert( pWInfo->wctrlFlags & WHERE_SORTBYGROUP );
5972 return pWInfo->sorted;
5973}
5974
drhd15cb172013-05-21 19:23:10 +00005975#ifdef WHERETRACE_ENABLED
5976/* For debugging use only: */
5977static const char *wherePathName(WherePath *pPath, int nLoop, WhereLoop *pLast){
5978 static char zName[65];
5979 int i;
5980 for(i=0; i<nLoop; i++){ zName[i] = pPath->aLoop[i]->cId; }
5981 if( pLast ) zName[i++] = pLast->cId;
5982 zName[i] = 0;
5983 return zName;
5984}
5985#endif
5986
drh6b7157b2013-05-10 02:00:35 +00005987/*
dan50ae31e2014-08-08 16:52:28 +00005988** Return the cost of sorting nRow rows, assuming that the keys have
5989** nOrderby columns and that the first nSorted columns are already in
5990** order.
5991*/
5992static LogEst whereSortingCost(
5993 WhereInfo *pWInfo,
5994 LogEst nRow,
5995 int nOrderBy,
5996 int nSorted
5997){
5998 /* TUNING: Estimated cost of a full external sort, where N is
5999 ** the number of rows to sort is:
6000 **
6001 ** cost = (3.0 * N * log(N)).
6002 **
6003 ** Or, if the order-by clause has X terms but only the last Y
6004 ** terms are out of order, then block-sorting will reduce the
6005 ** sorting cost to:
6006 **
6007 ** cost = (3.0 * N * log(N)) * (Y/X)
6008 **
6009 ** The (Y/X) term is implemented using stack variable rScale
6010 ** below. */
6011 LogEst rScale, rSortCost;
6012 assert( nOrderBy>0 && 66==sqlite3LogEst(100) );
6013 rScale = sqlite3LogEst((nOrderBy-nSorted)*100/nOrderBy) - 66;
6014 rSortCost = nRow + estLog(nRow) + rScale + 16;
6015
6016 /* TUNING: The cost of implementing DISTINCT using a B-TREE is
6017 ** similar but with a larger constant of proportionality.
6018 ** Multiply by an additional factor of 3.0. */
6019 if( pWInfo->wctrlFlags & WHERE_WANT_DISTINCT ){
6020 rSortCost += 16;
6021 }
6022
6023 return rSortCost;
6024}
6025
6026/*
dan51576f42013-07-02 10:06:15 +00006027** Given the list of WhereLoop objects at pWInfo->pLoops, this routine
drha18f3d22013-05-08 03:05:41 +00006028** attempts to find the lowest cost path that visits each WhereLoop
6029** once. This path is then loaded into the pWInfo->a[].pWLoop fields.
6030**
drhc7f0d222013-06-19 03:27:12 +00006031** Assume that the total number of output rows that will need to be sorted
6032** will be nRowEst (in the 10*log2 representation). Or, ignore sorting
6033** costs if nRowEst==0.
6034**
drha18f3d22013-05-08 03:05:41 +00006035** Return SQLITE_OK on success or SQLITE_NOMEM of a memory allocation
6036** error occurs.
6037*/
drhbf539c42013-10-05 18:16:02 +00006038static int wherePathSolver(WhereInfo *pWInfo, LogEst nRowEst){
drh783dece2013-06-05 17:53:43 +00006039 int mxChoice; /* Maximum number of simultaneous paths tracked */
drha18f3d22013-05-08 03:05:41 +00006040 int nLoop; /* Number of terms in the join */
drhe1e2e9a2013-06-13 15:16:53 +00006041 Parse *pParse; /* Parsing context */
drha18f3d22013-05-08 03:05:41 +00006042 sqlite3 *db; /* The database connection */
6043 int iLoop; /* Loop counter over the terms of the join */
6044 int ii, jj; /* Loop counters */
drhfde1e6b2013-09-06 17:45:42 +00006045 int mxI = 0; /* Index of next entry to replace */
drhd2de8612014-03-18 18:59:07 +00006046 int nOrderBy; /* Number of ORDER BY clause terms */
drhbf539c42013-10-05 18:16:02 +00006047 LogEst mxCost = 0; /* Maximum cost of a set of paths */
dan50ae31e2014-08-08 16:52:28 +00006048 LogEst mxUnsorted = 0; /* Maximum unsorted cost of a set of path */
drha18f3d22013-05-08 03:05:41 +00006049 int nTo, nFrom; /* Number of valid entries in aTo[] and aFrom[] */
6050 WherePath *aFrom; /* All nFrom paths at the previous level */
6051 WherePath *aTo; /* The nTo best paths at the current level */
6052 WherePath *pFrom; /* An element of aFrom[] that we are working on */
6053 WherePath *pTo; /* An element of aTo[] that we are working on */
6054 WhereLoop *pWLoop; /* One of the WhereLoop objects */
6055 WhereLoop **pX; /* Used to divy up the pSpace memory */
dan50ae31e2014-08-08 16:52:28 +00006056 LogEst *aSortCost = 0; /* Sorting and partial sorting costs */
drha18f3d22013-05-08 03:05:41 +00006057 char *pSpace; /* Temporary memory used by this routine */
dane2c27852014-08-08 17:25:33 +00006058 int nSpace; /* Bytes of space allocated at pSpace */
drha18f3d22013-05-08 03:05:41 +00006059
drhe1e2e9a2013-06-13 15:16:53 +00006060 pParse = pWInfo->pParse;
6061 db = pParse->db;
drha18f3d22013-05-08 03:05:41 +00006062 nLoop = pWInfo->nLevel;
drhe1e2e9a2013-06-13 15:16:53 +00006063 /* TUNING: For simple queries, only the best path is tracked.
6064 ** For 2-way joins, the 5 best paths are followed.
6065 ** For joins of 3 or more tables, track the 10 best paths */
drh2504c6c2014-06-02 11:26:33 +00006066 mxChoice = (nLoop<=1) ? 1 : (nLoop==2 ? 5 : 10);
drha18f3d22013-05-08 03:05:41 +00006067 assert( nLoop<=pWInfo->pTabList->nSrc );
drhddef5dc2014-08-07 16:50:00 +00006068 WHERETRACE(0x002, ("---- begin solver. (nRowEst=%d)\n", nRowEst));
drha18f3d22013-05-08 03:05:41 +00006069
dan50ae31e2014-08-08 16:52:28 +00006070 /* If nRowEst is zero and there is an ORDER BY clause, ignore it. In this
6071 ** case the purpose of this call is to estimate the number of rows returned
6072 ** by the overall query. Once this estimate has been obtained, the caller
6073 ** will invoke this function a second time, passing the estimate as the
6074 ** nRowEst parameter. */
6075 if( pWInfo->pOrderBy==0 || nRowEst==0 ){
6076 nOrderBy = 0;
6077 }else{
6078 nOrderBy = pWInfo->pOrderBy->nExpr;
6079 }
6080
6081 /* Allocate and initialize space for aTo, aFrom and aSortCost[] */
dane2c27852014-08-08 17:25:33 +00006082 nSpace = (sizeof(WherePath)+sizeof(WhereLoop*)*nLoop)*mxChoice*2;
6083 nSpace += sizeof(LogEst) * nOrderBy;
6084 pSpace = sqlite3DbMallocRaw(db, nSpace);
drha18f3d22013-05-08 03:05:41 +00006085 if( pSpace==0 ) return SQLITE_NOMEM;
6086 aTo = (WherePath*)pSpace;
6087 aFrom = aTo+mxChoice;
6088 memset(aFrom, 0, sizeof(aFrom[0]));
6089 pX = (WhereLoop**)(aFrom+mxChoice);
drhe9d935a2013-06-05 16:19:59 +00006090 for(ii=mxChoice*2, pFrom=aTo; ii>0; ii--, pFrom++, pX += nLoop){
drha18f3d22013-05-08 03:05:41 +00006091 pFrom->aLoop = pX;
6092 }
dan50ae31e2014-08-08 16:52:28 +00006093 if( nOrderBy ){
6094 /* If there is an ORDER BY clause and it is not being ignored, set up
6095 ** space for the aSortCost[] array. Each element of the aSortCost array
6096 ** is either zero - meaning it has not yet been initialized - or the
6097 ** cost of sorting nRowEst rows of data where the first X terms of
6098 ** the ORDER BY clause are already in order, where X is the array
6099 ** index. */
6100 aSortCost = (LogEst*)pX;
dane2c27852014-08-08 17:25:33 +00006101 memset(aSortCost, 0, sizeof(LogEst) * nOrderBy);
dan50ae31e2014-08-08 16:52:28 +00006102 }
dane2c27852014-08-08 17:25:33 +00006103 assert( aSortCost==0 || &pSpace[nSpace]==(char*)&aSortCost[nOrderBy] );
6104 assert( aSortCost!=0 || &pSpace[nSpace]==(char*)pX );
drha18f3d22013-05-08 03:05:41 +00006105
drhe1e2e9a2013-06-13 15:16:53 +00006106 /* Seed the search with a single WherePath containing zero WhereLoops.
6107 **
danf104abb2015-03-16 20:40:00 +00006108 ** TUNING: Do not let the number of iterations go above 28. If the cost
6109 ** of computing an automatic index is not paid back within the first 28
drhe1e2e9a2013-06-13 15:16:53 +00006110 ** rows, then do not use the automatic index. */
danf104abb2015-03-16 20:40:00 +00006111 aFrom[0].nRow = MIN(pParse->nQueryLoop, 48); assert( 48==sqlite3LogEst(28) );
drha18f3d22013-05-08 03:05:41 +00006112 nFrom = 1;
dan50ae31e2014-08-08 16:52:28 +00006113 assert( aFrom[0].isOrdered==0 );
6114 if( nOrderBy ){
6115 /* If nLoop is zero, then there are no FROM terms in the query. Since
6116 ** in this case the query may return a maximum of one row, the results
6117 ** are already in the requested order. Set isOrdered to nOrderBy to
6118 ** indicate this. Or, if nLoop is greater than zero, set isOrdered to
6119 ** -1, indicating that the result set may or may not be ordered,
6120 ** depending on the loops added to the current plan. */
6121 aFrom[0].isOrdered = nLoop>0 ? -1 : nOrderBy;
drh6b7157b2013-05-10 02:00:35 +00006122 }
6123
6124 /* Compute successively longer WherePaths using the previous generation
6125 ** of WherePaths as the basis for the next. Keep track of the mxChoice
6126 ** best paths at each generation */
drha18f3d22013-05-08 03:05:41 +00006127 for(iLoop=0; iLoop<nLoop; iLoop++){
6128 nTo = 0;
6129 for(ii=0, pFrom=aFrom; ii<nFrom; ii++, pFrom++){
6130 for(pWLoop=pWInfo->pLoops; pWLoop; pWLoop=pWLoop->pNextLoop){
dan50ae31e2014-08-08 16:52:28 +00006131 LogEst nOut; /* Rows visited by (pFrom+pWLoop) */
6132 LogEst rCost; /* Cost of path (pFrom+pWLoop) */
6133 LogEst rUnsorted; /* Unsorted cost of (pFrom+pWLoop) */
6134 i8 isOrdered = pFrom->isOrdered; /* isOrdered for (pFrom+pWLoop) */
6135 Bitmask maskNew; /* Mask of src visited by (..) */
6136 Bitmask revMask = 0; /* Mask of rev-order loops for (..) */
6137
drha18f3d22013-05-08 03:05:41 +00006138 if( (pWLoop->prereq & ~pFrom->maskLoop)!=0 ) continue;
6139 if( (pWLoop->maskSelf & pFrom->maskLoop)!=0 ) continue;
drh6b7157b2013-05-10 02:00:35 +00006140 /* At this point, pWLoop is a candidate to be the next loop.
6141 ** Compute its cost */
dan50ae31e2014-08-08 16:52:28 +00006142 rUnsorted = sqlite3LogEstAdd(pWLoop->rSetup,pWLoop->rRun + pFrom->nRow);
6143 rUnsorted = sqlite3LogEstAdd(rUnsorted, pFrom->rUnsorted);
drhfde1e6b2013-09-06 17:45:42 +00006144 nOut = pFrom->nRow + pWLoop->nOut;
drha18f3d22013-05-08 03:05:41 +00006145 maskNew = pFrom->maskLoop | pWLoop->maskSelf;
drh0401ace2014-03-18 15:30:27 +00006146 if( isOrdered<0 ){
6147 isOrdered = wherePathSatisfiesOrderBy(pWInfo,
drh4f402f22013-06-11 18:59:38 +00006148 pWInfo->pOrderBy, pFrom, pWInfo->wctrlFlags,
drh0401ace2014-03-18 15:30:27 +00006149 iLoop, pWLoop, &revMask);
drh3a5ba8b2013-06-03 15:34:48 +00006150 }else{
6151 revMask = pFrom->revLoop;
drh6b7157b2013-05-10 02:00:35 +00006152 }
dan50ae31e2014-08-08 16:52:28 +00006153 if( isOrdered>=0 && isOrdered<nOrderBy ){
6154 if( aSortCost[isOrdered]==0 ){
6155 aSortCost[isOrdered] = whereSortingCost(
6156 pWInfo, nRowEst, nOrderBy, isOrdered
6157 );
6158 }
6159 rCost = sqlite3LogEstAdd(rUnsorted, aSortCost[isOrdered]);
6160
6161 WHERETRACE(0x002,
6162 ("---- sort cost=%-3d (%d/%d) increases cost %3d to %-3d\n",
6163 aSortCost[isOrdered], (nOrderBy-isOrdered), nOrderBy,
6164 rUnsorted, rCost));
6165 }else{
6166 rCost = rUnsorted;
6167 }
6168
drhddef5dc2014-08-07 16:50:00 +00006169 /* Check to see if pWLoop should be added to the set of
6170 ** mxChoice best-so-far paths.
6171 **
6172 ** First look for an existing path among best-so-far paths
6173 ** that covers the same set of loops and has the same isOrdered
6174 ** setting as the current path candidate.
drhf2a90302014-08-07 20:37:01 +00006175 **
6176 ** The term "((pTo->isOrdered^isOrdered)&0x80)==0" is equivalent
6177 ** to (pTo->isOrdered==(-1))==(isOrdered==(-1))" for the range
6178 ** of legal values for isOrdered, -1..64.
drhddef5dc2014-08-07 16:50:00 +00006179 */
drh6b7157b2013-05-10 02:00:35 +00006180 for(jj=0, pTo=aTo; jj<nTo; jj++, pTo++){
drhfde1e6b2013-09-06 17:45:42 +00006181 if( pTo->maskLoop==maskNew
drhf2a90302014-08-07 20:37:01 +00006182 && ((pTo->isOrdered^isOrdered)&0x80)==0
drhfde1e6b2013-09-06 17:45:42 +00006183 ){
drh7963b0e2013-06-17 21:37:40 +00006184 testcase( jj==nTo-1 );
drh6b7157b2013-05-10 02:00:35 +00006185 break;
6186 }
6187 }
drha18f3d22013-05-08 03:05:41 +00006188 if( jj>=nTo ){
drhddef5dc2014-08-07 16:50:00 +00006189 /* None of the existing best-so-far paths match the candidate. */
drhddef5dc2014-08-07 16:50:00 +00006190 if( nTo>=mxChoice
dan50ae31e2014-08-08 16:52:28 +00006191 && (rCost>mxCost || (rCost==mxCost && rUnsorted>=mxUnsorted))
drhddef5dc2014-08-07 16:50:00 +00006192 ){
6193 /* The current candidate is no better than any of the mxChoice
6194 ** paths currently in the best-so-far buffer. So discard
6195 ** this candidate as not viable. */
drh989578e2013-10-28 14:34:35 +00006196#ifdef WHERETRACE_ENABLED /* 0x4 */
drhae70cf12013-05-31 15:18:46 +00006197 if( sqlite3WhereTrace&0x4 ){
drhfde1e6b2013-09-06 17:45:42 +00006198 sqlite3DebugPrintf("Skip %s cost=%-3d,%3d order=%c\n",
6199 wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
drh0401ace2014-03-18 15:30:27 +00006200 isOrdered>=0 ? isOrdered+'0' : '?');
drhd15cb172013-05-21 19:23:10 +00006201 }
6202#endif
6203 continue;
6204 }
drhddef5dc2014-08-07 16:50:00 +00006205 /* If we reach this points it means that the new candidate path
6206 ** needs to be added to the set of best-so-far paths. */
drha18f3d22013-05-08 03:05:41 +00006207 if( nTo<mxChoice ){
drhd15cb172013-05-21 19:23:10 +00006208 /* Increase the size of the aTo set by one */
drha18f3d22013-05-08 03:05:41 +00006209 jj = nTo++;
6210 }else{
drhd15cb172013-05-21 19:23:10 +00006211 /* New path replaces the prior worst to keep count below mxChoice */
drhfde1e6b2013-09-06 17:45:42 +00006212 jj = mxI;
drha18f3d22013-05-08 03:05:41 +00006213 }
6214 pTo = &aTo[jj];
drh989578e2013-10-28 14:34:35 +00006215#ifdef WHERETRACE_ENABLED /* 0x4 */
drhae70cf12013-05-31 15:18:46 +00006216 if( sqlite3WhereTrace&0x4 ){
drhfde1e6b2013-09-06 17:45:42 +00006217 sqlite3DebugPrintf("New %s cost=%-3d,%3d order=%c\n",
6218 wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
drh0401ace2014-03-18 15:30:27 +00006219 isOrdered>=0 ? isOrdered+'0' : '?');
drhd15cb172013-05-21 19:23:10 +00006220 }
6221#endif
drhf204dac2013-05-08 03:22:07 +00006222 }else{
drhddef5dc2014-08-07 16:50:00 +00006223 /* Control reaches here if best-so-far path pTo=aTo[jj] covers the
6224 ** same set of loops and has the sam isOrdered setting as the
6225 ** candidate path. Check to see if the candidate should replace
6226 ** pTo or if the candidate should be skipped */
6227 if( pTo->rCost<rCost || (pTo->rCost==rCost && pTo->nRow<=nOut) ){
drh989578e2013-10-28 14:34:35 +00006228#ifdef WHERETRACE_ENABLED /* 0x4 */
drhae70cf12013-05-31 15:18:46 +00006229 if( sqlite3WhereTrace&0x4 ){
drhd15cb172013-05-21 19:23:10 +00006230 sqlite3DebugPrintf(
drhfde1e6b2013-09-06 17:45:42 +00006231 "Skip %s cost=%-3d,%3d order=%c",
6232 wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
drh0401ace2014-03-18 15:30:27 +00006233 isOrdered>=0 ? isOrdered+'0' : '?');
drhfde1e6b2013-09-06 17:45:42 +00006234 sqlite3DebugPrintf(" vs %s cost=%-3d,%d order=%c\n",
6235 wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
drh0401ace2014-03-18 15:30:27 +00006236 pTo->isOrdered>=0 ? pTo->isOrdered+'0' : '?');
drhd15cb172013-05-21 19:23:10 +00006237 }
6238#endif
drhddef5dc2014-08-07 16:50:00 +00006239 /* Discard the candidate path from further consideration */
drh7963b0e2013-06-17 21:37:40 +00006240 testcase( pTo->rCost==rCost );
drhd15cb172013-05-21 19:23:10 +00006241 continue;
6242 }
drh7963b0e2013-06-17 21:37:40 +00006243 testcase( pTo->rCost==rCost+1 );
drhddef5dc2014-08-07 16:50:00 +00006244 /* Control reaches here if the candidate path is better than the
6245 ** pTo path. Replace pTo with the candidate. */
drh989578e2013-10-28 14:34:35 +00006246#ifdef WHERETRACE_ENABLED /* 0x4 */
drhae70cf12013-05-31 15:18:46 +00006247 if( sqlite3WhereTrace&0x4 ){
drhd15cb172013-05-21 19:23:10 +00006248 sqlite3DebugPrintf(
drhfde1e6b2013-09-06 17:45:42 +00006249 "Update %s cost=%-3d,%3d order=%c",
6250 wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
drh0401ace2014-03-18 15:30:27 +00006251 isOrdered>=0 ? isOrdered+'0' : '?');
drhfde1e6b2013-09-06 17:45:42 +00006252 sqlite3DebugPrintf(" was %s cost=%-3d,%3d order=%c\n",
6253 wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
drh0401ace2014-03-18 15:30:27 +00006254 pTo->isOrdered>=0 ? pTo->isOrdered+'0' : '?');
drhd15cb172013-05-21 19:23:10 +00006255 }
6256#endif
drha18f3d22013-05-08 03:05:41 +00006257 }
drh6b7157b2013-05-10 02:00:35 +00006258 /* pWLoop is a winner. Add it to the set of best so far */
drha18f3d22013-05-08 03:05:41 +00006259 pTo->maskLoop = pFrom->maskLoop | pWLoop->maskSelf;
drh319f6772013-05-14 15:31:07 +00006260 pTo->revLoop = revMask;
drhfde1e6b2013-09-06 17:45:42 +00006261 pTo->nRow = nOut;
drha18f3d22013-05-08 03:05:41 +00006262 pTo->rCost = rCost;
dan50ae31e2014-08-08 16:52:28 +00006263 pTo->rUnsorted = rUnsorted;
drh6b7157b2013-05-10 02:00:35 +00006264 pTo->isOrdered = isOrdered;
drha18f3d22013-05-08 03:05:41 +00006265 memcpy(pTo->aLoop, pFrom->aLoop, sizeof(WhereLoop*)*iLoop);
6266 pTo->aLoop[iLoop] = pWLoop;
6267 if( nTo>=mxChoice ){
drhfde1e6b2013-09-06 17:45:42 +00006268 mxI = 0;
drha18f3d22013-05-08 03:05:41 +00006269 mxCost = aTo[0].rCost;
dan50ae31e2014-08-08 16:52:28 +00006270 mxUnsorted = aTo[0].nRow;
drha18f3d22013-05-08 03:05:41 +00006271 for(jj=1, pTo=&aTo[1]; jj<mxChoice; jj++, pTo++){
dan50ae31e2014-08-08 16:52:28 +00006272 if( pTo->rCost>mxCost
6273 || (pTo->rCost==mxCost && pTo->rUnsorted>mxUnsorted)
6274 ){
drhfde1e6b2013-09-06 17:45:42 +00006275 mxCost = pTo->rCost;
dan50ae31e2014-08-08 16:52:28 +00006276 mxUnsorted = pTo->rUnsorted;
drhfde1e6b2013-09-06 17:45:42 +00006277 mxI = jj;
6278 }
drha18f3d22013-05-08 03:05:41 +00006279 }
6280 }
6281 }
6282 }
6283
drh989578e2013-10-28 14:34:35 +00006284#ifdef WHERETRACE_ENABLED /* >=2 */
drh1b131b72014-10-21 16:01:40 +00006285 if( sqlite3WhereTrace & 0x02 ){
drha50ef112013-05-22 02:06:59 +00006286 sqlite3DebugPrintf("---- after round %d ----\n", iLoop);
drhd15cb172013-05-21 19:23:10 +00006287 for(ii=0, pTo=aTo; ii<nTo; ii++, pTo++){
drhb8a8e8a2013-06-10 19:12:39 +00006288 sqlite3DebugPrintf(" %s cost=%-3d nrow=%-3d order=%c",
drha50ef112013-05-22 02:06:59 +00006289 wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
drh0401ace2014-03-18 15:30:27 +00006290 pTo->isOrdered>=0 ? (pTo->isOrdered+'0') : '?');
6291 if( pTo->isOrdered>0 ){
drh88da6442013-05-27 17:59:37 +00006292 sqlite3DebugPrintf(" rev=0x%llx\n", pTo->revLoop);
6293 }else{
6294 sqlite3DebugPrintf("\n");
6295 }
drhf204dac2013-05-08 03:22:07 +00006296 }
6297 }
6298#endif
6299
drh6b7157b2013-05-10 02:00:35 +00006300 /* Swap the roles of aFrom and aTo for the next generation */
drha18f3d22013-05-08 03:05:41 +00006301 pFrom = aTo;
6302 aTo = aFrom;
6303 aFrom = pFrom;
6304 nFrom = nTo;
6305 }
6306
drh75b93402013-05-31 20:43:57 +00006307 if( nFrom==0 ){
drhe1e2e9a2013-06-13 15:16:53 +00006308 sqlite3ErrorMsg(pParse, "no query solution");
drh75b93402013-05-31 20:43:57 +00006309 sqlite3DbFree(db, pSpace);
6310 return SQLITE_ERROR;
6311 }
drha18f3d22013-05-08 03:05:41 +00006312
drh6b7157b2013-05-10 02:00:35 +00006313 /* Find the lowest cost path. pFrom will be left pointing to that path */
drha18f3d22013-05-08 03:05:41 +00006314 pFrom = aFrom;
6315 for(ii=1; ii<nFrom; ii++){
6316 if( pFrom->rCost>aFrom[ii].rCost ) pFrom = &aFrom[ii];
6317 }
6318 assert( pWInfo->nLevel==nLoop );
drh6b7157b2013-05-10 02:00:35 +00006319 /* Load the lowest cost path into pWInfo */
drha18f3d22013-05-08 03:05:41 +00006320 for(iLoop=0; iLoop<nLoop; iLoop++){
drh7ba39a92013-05-30 17:43:19 +00006321 WhereLevel *pLevel = pWInfo->a + iLoop;
6322 pLevel->pWLoop = pWLoop = pFrom->aLoop[iLoop];
drhe217efc2013-06-12 03:48:41 +00006323 pLevel->iFrom = pWLoop->iTab;
drh7ba39a92013-05-30 17:43:19 +00006324 pLevel->iTabCur = pWInfo->pTabList->a[pLevel->iFrom].iCursor;
drha18f3d22013-05-08 03:05:41 +00006325 }
drhfd636c72013-06-21 02:05:06 +00006326 if( (pWInfo->wctrlFlags & WHERE_WANT_DISTINCT)!=0
6327 && (pWInfo->wctrlFlags & WHERE_DISTINCTBY)==0
6328 && pWInfo->eDistinct==WHERE_DISTINCT_NOOP
drh4f402f22013-06-11 18:59:38 +00006329 && nRowEst
6330 ){
6331 Bitmask notUsed;
drh6457a352013-06-21 00:35:37 +00006332 int rc = wherePathSatisfiesOrderBy(pWInfo, pWInfo->pResultSet, pFrom,
drh93ec45d2013-06-17 18:20:48 +00006333 WHERE_DISTINCTBY, nLoop-1, pFrom->aLoop[nLoop-1], &notUsed);
drh0401ace2014-03-18 15:30:27 +00006334 if( rc==pWInfo->pResultSet->nExpr ){
6335 pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
6336 }
drh4f402f22013-06-11 18:59:38 +00006337 }
drh079a3072014-03-19 14:10:55 +00006338 if( pWInfo->pOrderBy ){
drh4f402f22013-06-11 18:59:38 +00006339 if( pWInfo->wctrlFlags & WHERE_DISTINCTBY ){
drh079a3072014-03-19 14:10:55 +00006340 if( pFrom->isOrdered==pWInfo->pOrderBy->nExpr ){
6341 pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
6342 }
drh4f402f22013-06-11 18:59:38 +00006343 }else{
drhddba0c22014-03-18 20:33:42 +00006344 pWInfo->nOBSat = pFrom->isOrdered;
drhea6c36e2014-03-19 14:30:55 +00006345 if( pWInfo->nOBSat<0 ) pWInfo->nOBSat = 0;
drh4f402f22013-06-11 18:59:38 +00006346 pWInfo->revMask = pFrom->revLoop;
6347 }
dan374cd782014-04-21 13:21:56 +00006348 if( (pWInfo->wctrlFlags & WHERE_SORTBYGROUP)
drh11b04812015-04-12 01:22:04 +00006349 && pWInfo->nOBSat==pWInfo->pOrderBy->nExpr && nLoop>0
dan374cd782014-04-21 13:21:56 +00006350 ){
danb6453202014-10-10 20:52:53 +00006351 Bitmask revMask = 0;
dan374cd782014-04-21 13:21:56 +00006352 int nOrder = wherePathSatisfiesOrderBy(pWInfo, pWInfo->pOrderBy,
danb6453202014-10-10 20:52:53 +00006353 pFrom, 0, nLoop-1, pFrom->aLoop[nLoop-1], &revMask
dan374cd782014-04-21 13:21:56 +00006354 );
6355 assert( pWInfo->sorted==0 );
danb6453202014-10-10 20:52:53 +00006356 if( nOrder==pWInfo->pOrderBy->nExpr ){
6357 pWInfo->sorted = 1;
6358 pWInfo->revMask = revMask;
6359 }
dan374cd782014-04-21 13:21:56 +00006360 }
drh6b7157b2013-05-10 02:00:35 +00006361 }
dan374cd782014-04-21 13:21:56 +00006362
6363
drha50ef112013-05-22 02:06:59 +00006364 pWInfo->nRowOut = pFrom->nRow;
drha18f3d22013-05-08 03:05:41 +00006365
6366 /* Free temporary memory and return success */
6367 sqlite3DbFree(db, pSpace);
6368 return SQLITE_OK;
6369}
drh75897232000-05-29 14:26:00 +00006370
6371/*
drh60c96cd2013-06-09 17:21:25 +00006372** Most queries use only a single table (they are not joins) and have
6373** simple == constraints against indexed fields. This routine attempts
6374** to plan those simple cases using much less ceremony than the
6375** general-purpose query planner, and thereby yield faster sqlite3_prepare()
6376** times for the common case.
6377**
6378** Return non-zero on success, if this query can be handled by this
6379** no-frills query planner. Return zero if this query needs the
6380** general-purpose query planner.
6381*/
drhb8a8e8a2013-06-10 19:12:39 +00006382static int whereShortCut(WhereLoopBuilder *pBuilder){
drh60c96cd2013-06-09 17:21:25 +00006383 WhereInfo *pWInfo;
6384 struct SrcList_item *pItem;
6385 WhereClause *pWC;
6386 WhereTerm *pTerm;
6387 WhereLoop *pLoop;
6388 int iCur;
drh92a121f2013-06-10 12:15:47 +00006389 int j;
drh60c96cd2013-06-09 17:21:25 +00006390 Table *pTab;
6391 Index *pIdx;
6392
6393 pWInfo = pBuilder->pWInfo;
drh5822d6f2013-06-10 23:30:09 +00006394 if( pWInfo->wctrlFlags & WHERE_FORCE_TABLE ) return 0;
drh60c96cd2013-06-09 17:21:25 +00006395 assert( pWInfo->pTabList->nSrc>=1 );
6396 pItem = pWInfo->pTabList->a;
6397 pTab = pItem->pTab;
6398 if( IsVirtual(pTab) ) return 0;
6399 if( pItem->zIndex ) return 0;
6400 iCur = pItem->iCursor;
6401 pWC = &pWInfo->sWC;
6402 pLoop = pBuilder->pNew;
drh60c96cd2013-06-09 17:21:25 +00006403 pLoop->wsFlags = 0;
drhc8bbce12014-10-21 01:05:09 +00006404 pLoop->nSkip = 0;
drhe8d0c612015-05-14 01:05:25 +00006405 pTerm = findTerm(pWC, iCur, -1, 0, WO_EQ|WO_IS, 0);
drh60c96cd2013-06-09 17:21:25 +00006406 if( pTerm ){
drhe8d0c612015-05-14 01:05:25 +00006407 testcase( pTerm->eOperator & WO_IS );
drh60c96cd2013-06-09 17:21:25 +00006408 pLoop->wsFlags = WHERE_COLUMN_EQ|WHERE_IPK|WHERE_ONEROW;
6409 pLoop->aLTerm[0] = pTerm;
6410 pLoop->nLTerm = 1;
6411 pLoop->u.btree.nEq = 1;
drhe1e2e9a2013-06-13 15:16:53 +00006412 /* TUNING: Cost of a rowid lookup is 10 */
drhbf539c42013-10-05 18:16:02 +00006413 pLoop->rRun = 33; /* 33==sqlite3LogEst(10) */
drh60c96cd2013-06-09 17:21:25 +00006414 }else{
6415 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
mistachkin4e5bef82015-05-15 20:14:00 +00006416 int opMask;
dancd40abb2013-08-29 10:46:05 +00006417 assert( pLoop->aLTermSpace==pLoop->aLTerm );
drh5f1d1d92014-07-31 22:59:04 +00006418 if( !IsUniqueIndex(pIdx)
dancd40abb2013-08-29 10:46:05 +00006419 || pIdx->pPartIdxWhere!=0
drhbbbdc832013-10-22 18:01:40 +00006420 || pIdx->nKeyCol>ArraySize(pLoop->aLTermSpace)
dancd40abb2013-08-29 10:46:05 +00006421 ) continue;
mistachkin4e5bef82015-05-15 20:14:00 +00006422 opMask = pIdx->uniqNotNull ? (WO_EQ|WO_IS) : WO_EQ;
drhbbbdc832013-10-22 18:01:40 +00006423 for(j=0; j<pIdx->nKeyCol; j++){
mistachkin4e5bef82015-05-15 20:14:00 +00006424 pTerm = findTerm(pWC, iCur, pIdx->aiColumn[j], 0, opMask, pIdx);
drh60c96cd2013-06-09 17:21:25 +00006425 if( pTerm==0 ) break;
dan3072b532015-05-15 19:59:23 +00006426 testcase( pTerm->eOperator & WO_IS );
drh60c96cd2013-06-09 17:21:25 +00006427 pLoop->aLTerm[j] = pTerm;
6428 }
drhbbbdc832013-10-22 18:01:40 +00006429 if( j!=pIdx->nKeyCol ) continue;
drh92a121f2013-06-10 12:15:47 +00006430 pLoop->wsFlags = WHERE_COLUMN_EQ|WHERE_ONEROW|WHERE_INDEXED;
drhec95c442013-10-23 01:57:32 +00006431 if( pIdx->isCovering || (pItem->colUsed & ~columnsInIndex(pIdx))==0 ){
drh92a121f2013-06-10 12:15:47 +00006432 pLoop->wsFlags |= WHERE_IDX_ONLY;
6433 }
drh60c96cd2013-06-09 17:21:25 +00006434 pLoop->nLTerm = j;
6435 pLoop->u.btree.nEq = j;
6436 pLoop->u.btree.pIndex = pIdx;
drhe1e2e9a2013-06-13 15:16:53 +00006437 /* TUNING: Cost of a unique index lookup is 15 */
drhbf539c42013-10-05 18:16:02 +00006438 pLoop->rRun = 39; /* 39==sqlite3LogEst(15) */
drh60c96cd2013-06-09 17:21:25 +00006439 break;
6440 }
6441 }
drh3b75ffa2013-06-10 14:56:25 +00006442 if( pLoop->wsFlags ){
drhbf539c42013-10-05 18:16:02 +00006443 pLoop->nOut = (LogEst)1;
drh3b75ffa2013-06-10 14:56:25 +00006444 pWInfo->a[0].pWLoop = pLoop;
6445 pLoop->maskSelf = getMask(&pWInfo->sMaskSet, iCur);
6446 pWInfo->a[0].iTabCur = iCur;
6447 pWInfo->nRowOut = 1;
drhddba0c22014-03-18 20:33:42 +00006448 if( pWInfo->pOrderBy ) pWInfo->nOBSat = pWInfo->pOrderBy->nExpr;
drh6457a352013-06-21 00:35:37 +00006449 if( pWInfo->wctrlFlags & WHERE_WANT_DISTINCT ){
6450 pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
6451 }
drh3b75ffa2013-06-10 14:56:25 +00006452#ifdef SQLITE_DEBUG
6453 pLoop->cId = '0';
6454#endif
6455 return 1;
6456 }
6457 return 0;
drh60c96cd2013-06-09 17:21:25 +00006458}
6459
6460/*
drh75897232000-05-29 14:26:00 +00006461** Generate the beginning of the loop used for WHERE clause processing.
6462** The return value is a pointer to an opaque structure that contains
6463** information needed to terminate the loop. Later, the calling routine
6464** should invoke sqlite3WhereEnd() with the return value of this function
6465** in order to complete the WHERE clause processing.
6466**
6467** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00006468**
6469** The basic idea is to do a nested loop, one loop for each table in
6470** the FROM clause of a select. (INSERT and UPDATE statements are the
6471** same as a SELECT with only a single table in the FROM clause.) For
6472** example, if the SQL is this:
6473**
6474** SELECT * FROM t1, t2, t3 WHERE ...;
6475**
6476** Then the code generated is conceptually like the following:
6477**
6478** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00006479** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00006480** foreach row3 in t3 do /
6481** ...
6482** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00006483** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00006484** end /
6485**
drh29dda4a2005-07-21 18:23:20 +00006486** Note that the loops might not be nested in the order in which they
6487** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00006488** use of indices. Note also that when the IN operator appears in
6489** the WHERE clause, it might result in additional nested loops for
6490** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00006491**
drhc27a1ce2002-06-14 20:58:45 +00006492** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00006493** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
6494** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00006495** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00006496**
drhe6f85e72004-12-25 01:03:13 +00006497** The code that sqlite3WhereBegin() generates leaves the cursors named
6498** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00006499** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00006500** data from the various tables of the loop.
6501**
drhc27a1ce2002-06-14 20:58:45 +00006502** If the WHERE clause is empty, the foreach loops must each scan their
6503** entire tables. Thus a three-way join is an O(N^3) operation. But if
6504** the tables have indices and there are terms in the WHERE clause that
6505** refer to those indices, a complete table scan can be avoided and the
6506** code will run much faster. Most of the work of this routine is checking
6507** to see if there are indices that can be used to speed up the loop.
6508**
6509** Terms of the WHERE clause are also used to limit which rows actually
6510** make it to the "..." in the middle of the loop. After each "foreach",
6511** terms of the WHERE clause that use only terms in that loop and outer
6512** loops are evaluated and if false a jump is made around all subsequent
6513** inner loops (or around the "..." if the test occurs within the inner-
6514** most loop)
6515**
6516** OUTER JOINS
6517**
6518** An outer join of tables t1 and t2 is conceptally coded as follows:
6519**
6520** foreach row1 in t1 do
6521** flag = 0
6522** foreach row2 in t2 do
6523** start:
6524** ...
6525** flag = 1
6526** end
drhe3184742002-06-19 14:27:05 +00006527** if flag==0 then
6528** move the row2 cursor to a null row
6529** goto start
6530** fi
drhc27a1ce2002-06-14 20:58:45 +00006531** end
6532**
drhe3184742002-06-19 14:27:05 +00006533** ORDER BY CLAUSE PROCESSING
6534**
drh94433422013-07-01 11:05:50 +00006535** pOrderBy is a pointer to the ORDER BY clause (or the GROUP BY clause
6536** if the WHERE_GROUPBY flag is set in wctrlFlags) of a SELECT statement
drhe3184742002-06-19 14:27:05 +00006537** if there is one. If there is no ORDER BY clause or if this routine
drh46ec5b62012-09-24 15:30:54 +00006538** is called from an UPDATE or DELETE statement, then pOrderBy is NULL.
drhfc8d4f92013-11-08 15:19:46 +00006539**
6540** The iIdxCur parameter is the cursor number of an index. If
6541** WHERE_ONETABLE_ONLY is set, iIdxCur is the cursor number of an index
6542** to use for OR clause processing. The WHERE clause should use this
6543** specific cursor. If WHERE_ONEPASS_DESIRED is set, then iIdxCur is
6544** the first cursor in an array of cursors for all indices. iIdxCur should
6545** be used to compute the appropriate cursor depending on which index is
6546** used.
drh75897232000-05-29 14:26:00 +00006547*/
danielk19774adee202004-05-08 08:23:19 +00006548WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00006549 Parse *pParse, /* The parser context */
drh6457a352013-06-21 00:35:37 +00006550 SrcList *pTabList, /* FROM clause: A list of all tables to be scanned */
danielk1977ed326d72004-11-16 15:50:19 +00006551 Expr *pWhere, /* The WHERE clause */
drh0401ace2014-03-18 15:30:27 +00006552 ExprList *pOrderBy, /* An ORDER BY (or GROUP BY) clause, or NULL */
drh6457a352013-06-21 00:35:37 +00006553 ExprList *pResultSet, /* Result set of the query */
dan0efb72c2012-08-24 18:44:56 +00006554 u16 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
6555 int iIdxCur /* If WHERE_ONETABLE_ONLY is set, index cursor number */
drh75897232000-05-29 14:26:00 +00006556){
danielk1977be229652009-03-20 14:18:51 +00006557 int nByteWInfo; /* Num. bytes allocated for WhereInfo struct */
drhc01a3c12009-12-16 22:10:49 +00006558 int nTabList; /* Number of elements in pTabList */
drh75897232000-05-29 14:26:00 +00006559 WhereInfo *pWInfo; /* Will become the return value of this function */
6560 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhfe05af82005-07-21 03:14:59 +00006561 Bitmask notReady; /* Cursors that are not yet positioned */
drh1c8148f2013-05-04 20:25:23 +00006562 WhereLoopBuilder sWLB; /* The WhereLoop builder */
drh111a6a72008-12-21 03:51:16 +00006563 WhereMaskSet *pMaskSet; /* The expression mask set */
drh56f1b992012-09-25 14:29:39 +00006564 WhereLevel *pLevel; /* A single level in pWInfo->a[] */
drhfd636c72013-06-21 02:05:06 +00006565 WhereLoop *pLoop; /* Pointer to a single WhereLoop object */
drh9cd1c992012-09-25 20:43:35 +00006566 int ii; /* Loop counter */
drh17435752007-08-16 04:30:38 +00006567 sqlite3 *db; /* Database connection */
drh5346e952013-05-08 14:14:26 +00006568 int rc; /* Return code */
drh75897232000-05-29 14:26:00 +00006569
drh56f1b992012-09-25 14:29:39 +00006570
6571 /* Variable initialization */
drhfd636c72013-06-21 02:05:06 +00006572 db = pParse->db;
drh1c8148f2013-05-04 20:25:23 +00006573 memset(&sWLB, 0, sizeof(sWLB));
drh0401ace2014-03-18 15:30:27 +00006574
6575 /* An ORDER/GROUP BY clause of more than 63 terms cannot be optimized */
6576 testcase( pOrderBy && pOrderBy->nExpr==BMS-1 );
6577 if( pOrderBy && pOrderBy->nExpr>=BMS ) pOrderBy = 0;
drh1c8148f2013-05-04 20:25:23 +00006578 sWLB.pOrderBy = pOrderBy;
drh56f1b992012-09-25 14:29:39 +00006579
drhfd636c72013-06-21 02:05:06 +00006580 /* Disable the DISTINCT optimization if SQLITE_DistinctOpt is set via
6581 ** sqlite3_test_ctrl(SQLITE_TESTCTRL_OPTIMIZATIONS,...) */
6582 if( OptimizationDisabled(db, SQLITE_DistinctOpt) ){
6583 wctrlFlags &= ~WHERE_WANT_DISTINCT;
6584 }
6585
drh29dda4a2005-07-21 18:23:20 +00006586 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00006587 ** bits in a Bitmask
6588 */
drh67ae0cb2010-04-08 14:38:51 +00006589 testcase( pTabList->nSrc==BMS );
drh29dda4a2005-07-21 18:23:20 +00006590 if( pTabList->nSrc>BMS ){
6591 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00006592 return 0;
6593 }
6594
drhc01a3c12009-12-16 22:10:49 +00006595 /* This function normally generates a nested loop for all tables in
6596 ** pTabList. But if the WHERE_ONETABLE_ONLY flag is set, then we should
6597 ** only generate code for the first table in pTabList and assume that
6598 ** any cursors associated with subsequent tables are uninitialized.
6599 */
6600 nTabList = (wctrlFlags & WHERE_ONETABLE_ONLY) ? 1 : pTabList->nSrc;
6601
drh75897232000-05-29 14:26:00 +00006602 /* Allocate and initialize the WhereInfo structure that will become the
danielk1977be229652009-03-20 14:18:51 +00006603 ** return value. A single allocation is used to store the WhereInfo
6604 ** struct, the contents of WhereInfo.a[], the WhereClause structure
6605 ** and the WhereMaskSet structure. Since WhereClause contains an 8-byte
6606 ** field (type Bitmask) it must be aligned on an 8-byte boundary on
6607 ** some architectures. Hence the ROUND8() below.
drh75897232000-05-29 14:26:00 +00006608 */
drhc01a3c12009-12-16 22:10:49 +00006609 nByteWInfo = ROUND8(sizeof(WhereInfo)+(nTabList-1)*sizeof(WhereLevel));
drh60c96cd2013-06-09 17:21:25 +00006610 pWInfo = sqlite3DbMallocZero(db, nByteWInfo + sizeof(WhereLoop));
drh17435752007-08-16 04:30:38 +00006611 if( db->mallocFailed ){
drh8b307fb2010-04-06 15:57:05 +00006612 sqlite3DbFree(db, pWInfo);
6613 pWInfo = 0;
danielk197785574e32008-10-06 05:32:18 +00006614 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00006615 }
drhfc8d4f92013-11-08 15:19:46 +00006616 pWInfo->aiCurOnePass[0] = pWInfo->aiCurOnePass[1] = -1;
drhc01a3c12009-12-16 22:10:49 +00006617 pWInfo->nLevel = nTabList;
drh75897232000-05-29 14:26:00 +00006618 pWInfo->pParse = pParse;
6619 pWInfo->pTabList = pTabList;
drh6b7157b2013-05-10 02:00:35 +00006620 pWInfo->pOrderBy = pOrderBy;
drh6457a352013-06-21 00:35:37 +00006621 pWInfo->pResultSet = pResultSet;
drha22a75e2014-03-21 18:16:23 +00006622 pWInfo->iBreak = pWInfo->iContinue = sqlite3VdbeMakeLabel(v);
drh6df2acd2008-12-28 16:55:25 +00006623 pWInfo->wctrlFlags = wctrlFlags;
drh8b307fb2010-04-06 15:57:05 +00006624 pWInfo->savedNQueryLoop = pParse->nQueryLoop;
drh70d18342013-06-06 19:16:33 +00006625 pMaskSet = &pWInfo->sMaskSet;
drh1c8148f2013-05-04 20:25:23 +00006626 sWLB.pWInfo = pWInfo;
drh70d18342013-06-06 19:16:33 +00006627 sWLB.pWC = &pWInfo->sWC;
drh1ac87e12013-07-18 14:50:56 +00006628 sWLB.pNew = (WhereLoop*)(((char*)pWInfo)+nByteWInfo);
6629 assert( EIGHT_BYTE_ALIGNMENT(sWLB.pNew) );
drh60c96cd2013-06-09 17:21:25 +00006630 whereLoopInit(sWLB.pNew);
drhb8a8e8a2013-06-10 19:12:39 +00006631#ifdef SQLITE_DEBUG
6632 sWLB.pNew->cId = '*';
6633#endif
drh08192d52002-04-30 19:20:28 +00006634
drh111a6a72008-12-21 03:51:16 +00006635 /* Split the WHERE clause into separate subexpressions where each
6636 ** subexpression is separated by an AND operator.
6637 */
6638 initMaskSet(pMaskSet);
drh70d18342013-06-06 19:16:33 +00006639 whereClauseInit(&pWInfo->sWC, pWInfo);
drh39759742013-08-02 23:40:45 +00006640 whereSplit(&pWInfo->sWC, pWhere, TK_AND);
drh111a6a72008-12-21 03:51:16 +00006641
drh08192d52002-04-30 19:20:28 +00006642 /* Special case: a WHERE clause that is constant. Evaluate the
6643 ** expression and either jump over all of the code or fall thru.
6644 */
drh759e8582014-01-02 21:05:10 +00006645 for(ii=0; ii<sWLB.pWC->nTerm; ii++){
6646 if( nTabList==0 || sqlite3ExprIsConstantNotJoin(sWLB.pWC->a[ii].pExpr) ){
6647 sqlite3ExprIfFalse(pParse, sWLB.pWC->a[ii].pExpr, pWInfo->iBreak,
6648 SQLITE_JUMPIFNULL);
6649 sWLB.pWC->a[ii].wtFlags |= TERM_CODED;
6650 }
drh08192d52002-04-30 19:20:28 +00006651 }
drh75897232000-05-29 14:26:00 +00006652
drh4fe425a2013-06-12 17:08:06 +00006653 /* Special case: No FROM clause
6654 */
6655 if( nTabList==0 ){
drhddba0c22014-03-18 20:33:42 +00006656 if( pOrderBy ) pWInfo->nOBSat = pOrderBy->nExpr;
drh6457a352013-06-21 00:35:37 +00006657 if( wctrlFlags & WHERE_WANT_DISTINCT ){
6658 pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
6659 }
drh4fe425a2013-06-12 17:08:06 +00006660 }
6661
drh42165be2008-03-26 14:56:34 +00006662 /* Assign a bit from the bitmask to every term in the FROM clause.
6663 **
6664 ** When assigning bitmask values to FROM clause cursors, it must be
6665 ** the case that if X is the bitmask for the N-th FROM clause term then
6666 ** the bitmask for all FROM clause terms to the left of the N-th term
6667 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
6668 ** its Expr.iRightJoinTable value to find the bitmask of the right table
6669 ** of the join. Subtracting one from the right table bitmask gives a
6670 ** bitmask for all tables to the left of the join. Knowing the bitmask
6671 ** for all tables to the left of a left join is important. Ticket #3015.
danielk1977e672c8e2009-05-22 15:43:26 +00006672 **
drhc01a3c12009-12-16 22:10:49 +00006673 ** Note that bitmasks are created for all pTabList->nSrc tables in
6674 ** pTabList, not just the first nTabList tables. nTabList is normally
6675 ** equal to pTabList->nSrc but might be shortened to 1 if the
6676 ** WHERE_ONETABLE_ONLY flag is set.
drh42165be2008-03-26 14:56:34 +00006677 */
drh9cd1c992012-09-25 20:43:35 +00006678 for(ii=0; ii<pTabList->nSrc; ii++){
6679 createMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00006680 }
6681#ifndef NDEBUG
6682 {
6683 Bitmask toTheLeft = 0;
drh9cd1c992012-09-25 20:43:35 +00006684 for(ii=0; ii<pTabList->nSrc; ii++){
6685 Bitmask m = getMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00006686 assert( (m-1)==toTheLeft );
6687 toTheLeft |= m;
6688 }
6689 }
6690#endif
6691
drh29dda4a2005-07-21 18:23:20 +00006692 /* Analyze all of the subexpressions. Note that exprAnalyze() might
6693 ** add new virtual terms onto the end of the WHERE clause. We do not
6694 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00006695 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00006696 */
drh70d18342013-06-06 19:16:33 +00006697 exprAnalyzeAll(pTabList, &pWInfo->sWC);
drh17435752007-08-16 04:30:38 +00006698 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00006699 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00006700 }
drh75897232000-05-29 14:26:00 +00006701
drh6457a352013-06-21 00:35:37 +00006702 if( wctrlFlags & WHERE_WANT_DISTINCT ){
6703 if( isDistinctRedundant(pParse, pTabList, &pWInfo->sWC, pResultSet) ){
6704 /* The DISTINCT marking is pointless. Ignore it. */
drh4f402f22013-06-11 18:59:38 +00006705 pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
6706 }else if( pOrderBy==0 ){
drh6457a352013-06-21 00:35:37 +00006707 /* Try to ORDER BY the result set to make distinct processing easier */
drh4f402f22013-06-11 18:59:38 +00006708 pWInfo->wctrlFlags |= WHERE_DISTINCTBY;
drh6457a352013-06-21 00:35:37 +00006709 pWInfo->pOrderBy = pResultSet;
drh4f402f22013-06-11 18:59:38 +00006710 }
dan38cc40c2011-06-30 20:17:15 +00006711 }
6712
drhf1b5f5b2013-05-02 00:15:01 +00006713 /* Construct the WhereLoop objects */
drh3b48e8c2013-06-12 20:18:16 +00006714 WHERETRACE(0xffff,("*** Optimizer Start ***\n"));
drhc90713d2014-09-30 13:46:49 +00006715#if defined(WHERETRACE_ENABLED)
6716 /* Display all terms of the WHERE clause */
6717 if( sqlite3WhereTrace & 0x100 ){
6718 int i;
6719 for(i=0; i<sWLB.pWC->nTerm; i++){
6720 whereTermPrint(&sWLB.pWC->a[i], i);
6721 }
6722 }
6723#endif
6724
drhb8a8e8a2013-06-10 19:12:39 +00006725 if( nTabList!=1 || whereShortCut(&sWLB)==0 ){
drh60c96cd2013-06-09 17:21:25 +00006726 rc = whereLoopAddAll(&sWLB);
6727 if( rc ) goto whereBeginError;
6728
6729 /* Display all of the WhereLoop objects if wheretrace is enabled */
drh989578e2013-10-28 14:34:35 +00006730#ifdef WHERETRACE_ENABLED /* !=0 */
drh60c96cd2013-06-09 17:21:25 +00006731 if( sqlite3WhereTrace ){
6732 WhereLoop *p;
drhfd636c72013-06-21 02:05:06 +00006733 int i;
drh60c96cd2013-06-09 17:21:25 +00006734 static char zLabel[] = "0123456789abcdefghijklmnopqrstuvwyxz"
6735 "ABCDEFGHIJKLMNOPQRSTUVWYXZ";
drhfd636c72013-06-21 02:05:06 +00006736 for(p=pWInfo->pLoops, i=0; p; p=p->pNextLoop, i++){
6737 p->cId = zLabel[i%sizeof(zLabel)];
drhc1ba2e72013-10-28 19:03:21 +00006738 whereLoopPrint(p, sWLB.pWC);
drh60c96cd2013-06-09 17:21:25 +00006739 }
6740 }
6741#endif
6742
drh4f402f22013-06-11 18:59:38 +00006743 wherePathSolver(pWInfo, 0);
drh60c96cd2013-06-09 17:21:25 +00006744 if( db->mallocFailed ) goto whereBeginError;
6745 if( pWInfo->pOrderBy ){
drhc7f0d222013-06-19 03:27:12 +00006746 wherePathSolver(pWInfo, pWInfo->nRowOut+1);
drh60c96cd2013-06-09 17:21:25 +00006747 if( db->mallocFailed ) goto whereBeginError;
drha18f3d22013-05-08 03:05:41 +00006748 }
6749 }
drh60c96cd2013-06-09 17:21:25 +00006750 if( pWInfo->pOrderBy==0 && (db->flags & SQLITE_ReverseOrder)!=0 ){
drhd84ce352013-06-04 18:27:41 +00006751 pWInfo->revMask = (Bitmask)(-1);
drha50ef112013-05-22 02:06:59 +00006752 }
drh81186b42013-06-18 01:52:41 +00006753 if( pParse->nErr || NEVER(db->mallocFailed) ){
drh75b93402013-05-31 20:43:57 +00006754 goto whereBeginError;
6755 }
drh989578e2013-10-28 14:34:35 +00006756#ifdef WHERETRACE_ENABLED /* !=0 */
drha18f3d22013-05-08 03:05:41 +00006757 if( sqlite3WhereTrace ){
drh4f402f22013-06-11 18:59:38 +00006758 sqlite3DebugPrintf("---- Solution nRow=%d", pWInfo->nRowOut);
drhddba0c22014-03-18 20:33:42 +00006759 if( pWInfo->nOBSat>0 ){
6760 sqlite3DebugPrintf(" ORDERBY=%d,0x%llx", pWInfo->nOBSat, pWInfo->revMask);
drh319f6772013-05-14 15:31:07 +00006761 }
drh4f402f22013-06-11 18:59:38 +00006762 switch( pWInfo->eDistinct ){
6763 case WHERE_DISTINCT_UNIQUE: {
6764 sqlite3DebugPrintf(" DISTINCT=unique");
6765 break;
6766 }
6767 case WHERE_DISTINCT_ORDERED: {
6768 sqlite3DebugPrintf(" DISTINCT=ordered");
6769 break;
6770 }
6771 case WHERE_DISTINCT_UNORDERED: {
6772 sqlite3DebugPrintf(" DISTINCT=unordered");
6773 break;
6774 }
6775 }
6776 sqlite3DebugPrintf("\n");
drhfd636c72013-06-21 02:05:06 +00006777 for(ii=0; ii<pWInfo->nLevel; ii++){
drhc1ba2e72013-10-28 19:03:21 +00006778 whereLoopPrint(pWInfo->a[ii].pWLoop, sWLB.pWC);
drhf1b5f5b2013-05-02 00:15:01 +00006779 }
6780 }
6781#endif
drhfd636c72013-06-21 02:05:06 +00006782 /* Attempt to omit tables from the join that do not effect the result */
drh1031bd92013-06-22 15:44:26 +00006783 if( pWInfo->nLevel>=2
6784 && pResultSet!=0
6785 && OptimizationEnabled(db, SQLITE_OmitNoopJoin)
6786 ){
drhfd636c72013-06-21 02:05:06 +00006787 Bitmask tabUsed = exprListTableUsage(pMaskSet, pResultSet);
drh67a5ec72013-09-03 14:03:47 +00006788 if( sWLB.pOrderBy ) tabUsed |= exprListTableUsage(pMaskSet, sWLB.pOrderBy);
drhfd636c72013-06-21 02:05:06 +00006789 while( pWInfo->nLevel>=2 ){
drh9d5a5792013-06-28 13:43:33 +00006790 WhereTerm *pTerm, *pEnd;
drhfd636c72013-06-21 02:05:06 +00006791 pLoop = pWInfo->a[pWInfo->nLevel-1].pWLoop;
drhbc71b1d2013-06-21 02:15:48 +00006792 if( (pWInfo->pTabList->a[pLoop->iTab].jointype & JT_LEFT)==0 ) break;
6793 if( (wctrlFlags & WHERE_WANT_DISTINCT)==0
6794 && (pLoop->wsFlags & WHERE_ONEROW)==0
drhfd636c72013-06-21 02:05:06 +00006795 ){
drhfd636c72013-06-21 02:05:06 +00006796 break;
6797 }
drhbc71b1d2013-06-21 02:15:48 +00006798 if( (tabUsed & pLoop->maskSelf)!=0 ) break;
drh9d5a5792013-06-28 13:43:33 +00006799 pEnd = sWLB.pWC->a + sWLB.pWC->nTerm;
6800 for(pTerm=sWLB.pWC->a; pTerm<pEnd; pTerm++){
6801 if( (pTerm->prereqAll & pLoop->maskSelf)!=0
6802 && !ExprHasProperty(pTerm->pExpr, EP_FromJoin)
6803 ){
6804 break;
6805 }
6806 }
6807 if( pTerm<pEnd ) break;
drhbc71b1d2013-06-21 02:15:48 +00006808 WHERETRACE(0xffff, ("-> drop loop %c not used\n", pLoop->cId));
6809 pWInfo->nLevel--;
6810 nTabList--;
drhfd636c72013-06-21 02:05:06 +00006811 }
6812 }
drh3b48e8c2013-06-12 20:18:16 +00006813 WHERETRACE(0xffff,("*** Optimizer Finished ***\n"));
drh8e23daf2013-06-11 13:30:04 +00006814 pWInfo->pParse->nQueryLoop += pWInfo->nRowOut;
drhf1b5f5b2013-05-02 00:15:01 +00006815
drh08c88eb2008-04-10 13:33:18 +00006816 /* If the caller is an UPDATE or DELETE statement that is requesting
6817 ** to use a one-pass algorithm, determine if this is appropriate.
drh24b7fe92013-09-30 19:33:06 +00006818 ** The one-pass algorithm only works if the WHERE clause constrains
drh08c88eb2008-04-10 13:33:18 +00006819 ** the statement to update a single row.
6820 */
drh165be382008-12-05 02:36:33 +00006821 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
drh3b48e8c2013-06-12 20:18:16 +00006822 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0
6823 && (pWInfo->a[0].pWLoop->wsFlags & WHERE_ONEROW)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00006824 pWInfo->okOnePass = 1;
drh702ba9f2013-11-07 21:25:13 +00006825 if( HasRowid(pTabList->a[0].pTab) ){
6826 pWInfo->a[0].pWLoop->wsFlags &= ~WHERE_IDX_ONLY;
6827 }
drh08c88eb2008-04-10 13:33:18 +00006828 }
drheb04de32013-05-10 15:16:30 +00006829
drh9012bcb2004-12-19 00:11:35 +00006830 /* Open all tables in the pTabList and any indices selected for
6831 ** searching those tables.
6832 */
drh8b307fb2010-04-06 15:57:05 +00006833 notReady = ~(Bitmask)0;
drh9cd1c992012-09-25 20:43:35 +00006834 for(ii=0, pLevel=pWInfo->a; ii<nTabList; ii++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00006835 Table *pTab; /* Table to open */
danielk1977da184232006-01-05 11:34:32 +00006836 int iDb; /* Index of database containing table/index */
drh56f1b992012-09-25 14:29:39 +00006837 struct SrcList_item *pTabItem;
drh9012bcb2004-12-19 00:11:35 +00006838
drh29dda4a2005-07-21 18:23:20 +00006839 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00006840 pTab = pTabItem->pTab;
danielk1977595a5232009-07-24 17:58:53 +00006841 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh7ba39a92013-05-30 17:43:19 +00006842 pLoop = pLevel->pWLoop;
drh424aab82010-04-06 18:28:20 +00006843 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ){
drh75bb9f52010-04-06 18:51:42 +00006844 /* Do nothing */
6845 }else
drh9eff6162006-06-12 21:59:13 +00006846#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7ba39a92013-05-30 17:43:19 +00006847 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
danielk1977595a5232009-07-24 17:58:53 +00006848 const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
danielk197793626f42006-06-20 13:07:27 +00006849 int iCur = pTabItem->iCursor;
danielk1977595a5232009-07-24 17:58:53 +00006850 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0, pVTab, P4_VTAB);
drhfc5e5462012-12-03 17:04:40 +00006851 }else if( IsVirtual(pTab) ){
6852 /* noop */
drh9eff6162006-06-12 21:59:13 +00006853 }else
6854#endif
drh7ba39a92013-05-30 17:43:19 +00006855 if( (pLoop->wsFlags & WHERE_IDX_ONLY)==0
drh9ef61f42011-10-07 14:40:59 +00006856 && (wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0 ){
drhfc8d4f92013-11-08 15:19:46 +00006857 int op = OP_OpenRead;
6858 if( pWInfo->okOnePass ){
6859 op = OP_OpenWrite;
6860 pWInfo->aiCurOnePass[0] = pTabItem->iCursor;
6861 };
drh08c88eb2008-04-10 13:33:18 +00006862 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
drhfc8d4f92013-11-08 15:19:46 +00006863 assert( pTabItem->iCursor==pLevel->iTabCur );
drh7963b0e2013-06-17 21:37:40 +00006864 testcase( !pWInfo->okOnePass && pTab->nCol==BMS-1 );
6865 testcase( !pWInfo->okOnePass && pTab->nCol==BMS );
drhdd9930e2013-10-23 23:37:02 +00006866 if( !pWInfo->okOnePass && pTab->nCol<BMS && HasRowid(pTab) ){
danielk19779792eef2006-01-13 15:58:43 +00006867 Bitmask b = pTabItem->colUsed;
6868 int n = 0;
drh74161702006-02-24 02:53:49 +00006869 for(; b; b=b>>1, n++){}
drh8cff69d2009-11-12 19:59:44 +00006870 sqlite3VdbeChangeP4(v, sqlite3VdbeCurrentAddr(v)-1,
6871 SQLITE_INT_TO_PTR(n), P4_INT32);
danielk19779792eef2006-01-13 15:58:43 +00006872 assert( n<=pTab->nCol );
6873 }
danielk1977c00da102006-01-07 13:21:04 +00006874 }else{
6875 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00006876 }
drh7e47cb82013-05-31 17:55:27 +00006877 if( pLoop->wsFlags & WHERE_INDEXED ){
drh7ba39a92013-05-30 17:43:19 +00006878 Index *pIx = pLoop->u.btree.pIndex;
drhfc8d4f92013-11-08 15:19:46 +00006879 int iIndexCur;
6880 int op = OP_OpenRead;
drh4308e342013-11-11 16:55:52 +00006881 /* iIdxCur is always set if to a positive value if ONEPASS is possible */
6882 assert( iIdxCur!=0 || (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0 );
drh48dd1d82014-05-27 18:18:58 +00006883 if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIx)
drha3bc66a2014-05-27 17:57:32 +00006884 && (wctrlFlags & WHERE_ONETABLE_ONLY)!=0
6885 ){
6886 /* This is one term of an OR-optimization using the PRIMARY KEY of a
6887 ** WITHOUT ROWID table. No need for a separate index */
6888 iIndexCur = pLevel->iTabCur;
6889 op = 0;
6890 }else if( pWInfo->okOnePass ){
drhfc8d4f92013-11-08 15:19:46 +00006891 Index *pJ = pTabItem->pTab->pIndex;
6892 iIndexCur = iIdxCur;
6893 assert( wctrlFlags & WHERE_ONEPASS_DESIRED );
6894 while( ALWAYS(pJ) && pJ!=pIx ){
6895 iIndexCur++;
6896 pJ = pJ->pNext;
6897 }
6898 op = OP_OpenWrite;
6899 pWInfo->aiCurOnePass[1] = iIndexCur;
6900 }else if( iIdxCur && (wctrlFlags & WHERE_ONETABLE_ONLY)!=0 ){
6901 iIndexCur = iIdxCur;
drh35263192014-07-22 20:02:19 +00006902 if( wctrlFlags & WHERE_REOPEN_IDX ) op = OP_ReopenIdx;
drhfc8d4f92013-11-08 15:19:46 +00006903 }else{
6904 iIndexCur = pParse->nTab++;
6905 }
6906 pLevel->iIdxCur = iIndexCur;
danielk1977da184232006-01-05 11:34:32 +00006907 assert( pIx->pSchema==pTab->pSchema );
drhb0367fb2012-08-25 02:11:13 +00006908 assert( iIndexCur>=0 );
drha3bc66a2014-05-27 17:57:32 +00006909 if( op ){
6910 sqlite3VdbeAddOp3(v, op, iIndexCur, pIx->tnum, iDb);
6911 sqlite3VdbeSetP4KeyInfo(pParse, pIx);
drhe0997b32015-03-20 14:57:50 +00006912 if( (pLoop->wsFlags & WHERE_CONSTRAINT)!=0
6913 && (pLoop->wsFlags & (WHERE_COLUMN_RANGE|WHERE_SKIPSCAN))==0
6914 && (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)==0
6915 ){
6916 sqlite3VdbeChangeP5(v, OPFLAG_SEEKEQ); /* Hint to COMDB2 */
6917 }
drha3bc66a2014-05-27 17:57:32 +00006918 VdbeComment((v, "%s", pIx->zName));
6919 }
drh9012bcb2004-12-19 00:11:35 +00006920 }
drhaceb31b2014-02-08 01:40:27 +00006921 if( iDb>=0 ) sqlite3CodeVerifySchema(pParse, iDb);
drh70d18342013-06-06 19:16:33 +00006922 notReady &= ~getMask(&pWInfo->sMaskSet, pTabItem->iCursor);
drh9012bcb2004-12-19 00:11:35 +00006923 }
6924 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
drha21a64d2010-04-06 22:33:55 +00006925 if( db->mallocFailed ) goto whereBeginError;
drh9012bcb2004-12-19 00:11:35 +00006926
drh29dda4a2005-07-21 18:23:20 +00006927 /* Generate the code to do the search. Each iteration of the for
6928 ** loop below generates code for a single nested loop of the VM
6929 ** program.
drh75897232000-05-29 14:26:00 +00006930 */
drhfe05af82005-07-21 03:14:59 +00006931 notReady = ~(Bitmask)0;
drh9cd1c992012-09-25 20:43:35 +00006932 for(ii=0; ii<nTabList; ii++){
dan6f9702e2014-11-01 20:38:06 +00006933 int addrExplain;
6934 int wsFlags;
drh9cd1c992012-09-25 20:43:35 +00006935 pLevel = &pWInfo->a[ii];
dan6f9702e2014-11-01 20:38:06 +00006936 wsFlags = pLevel->pWLoop->wsFlags;
drhcc04afd2013-08-22 02:56:28 +00006937#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
6938 if( (pLevel->pWLoop->wsFlags & WHERE_AUTO_INDEX)!=0 ){
6939 constructAutomaticIndex(pParse, &pWInfo->sWC,
6940 &pTabList->a[pLevel->iFrom], notReady, pLevel);
6941 if( db->mallocFailed ) goto whereBeginError;
6942 }
6943#endif
dan6f9702e2014-11-01 20:38:06 +00006944 addrExplain = explainOneScan(
6945 pParse, pTabList, pLevel, ii, pLevel->iFrom, wctrlFlags
6946 );
drhcc04afd2013-08-22 02:56:28 +00006947 pLevel->addrBody = sqlite3VdbeCurrentAddr(v);
drh70d18342013-06-06 19:16:33 +00006948 notReady = codeOneLoopStart(pWInfo, ii, notReady);
dan4a07e3d2010-11-09 14:48:59 +00006949 pWInfo->iContinue = pLevel->addrCont;
dan6f9702e2014-11-01 20:38:06 +00006950 if( (wsFlags&WHERE_MULTI_OR)==0 && (wctrlFlags&WHERE_ONETABLE_ONLY)==0 ){
6951 addScanStatus(v, pTabList, pLevel, addrExplain);
6952 }
drh75897232000-05-29 14:26:00 +00006953 }
drh7ec764a2005-07-21 03:48:20 +00006954
drh6fa978d2013-05-30 19:29:19 +00006955 /* Done. */
drh6bc69a22013-11-19 12:33:23 +00006956 VdbeModuleComment((v, "Begin WHERE-core"));
drh75897232000-05-29 14:26:00 +00006957 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00006958
6959 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00006960whereBeginError:
drh8b307fb2010-04-06 15:57:05 +00006961 if( pWInfo ){
6962 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
6963 whereInfoFree(db, pWInfo);
6964 }
drhe23399f2005-07-22 00:31:39 +00006965 return 0;
drh75897232000-05-29 14:26:00 +00006966}
6967
6968/*
drhc27a1ce2002-06-14 20:58:45 +00006969** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00006970** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00006971*/
danielk19774adee202004-05-08 08:23:19 +00006972void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00006973 Parse *pParse = pWInfo->pParse;
6974 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00006975 int i;
drh6b563442001-11-07 16:48:26 +00006976 WhereLevel *pLevel;
drh7ba39a92013-05-30 17:43:19 +00006977 WhereLoop *pLoop;
drhad3cab52002-05-24 02:04:32 +00006978 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00006979 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00006980
drh9012bcb2004-12-19 00:11:35 +00006981 /* Generate loop termination code.
6982 */
drh6bc69a22013-11-19 12:33:23 +00006983 VdbeModuleComment((v, "End WHERE-core"));
drhceea3322009-04-23 13:22:42 +00006984 sqlite3ExprCacheClear(pParse);
drhc01a3c12009-12-16 22:10:49 +00006985 for(i=pWInfo->nLevel-1; i>=0; i--){
drhcd8629e2013-11-13 12:27:25 +00006986 int addr;
drh6b563442001-11-07 16:48:26 +00006987 pLevel = &pWInfo->a[i];
drh7ba39a92013-05-30 17:43:19 +00006988 pLoop = pLevel->pWLoop;
drhb3190c12008-12-08 21:37:14 +00006989 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00006990 if( pLevel->op!=OP_Noop ){
drhe39a7322014-02-03 14:04:11 +00006991 sqlite3VdbeAddOp3(v, pLevel->op, pLevel->p1, pLevel->p2, pLevel->p3);
drhd1d38482008-10-07 23:46:38 +00006992 sqlite3VdbeChangeP5(v, pLevel->p5);
drh688852a2014-02-17 22:40:43 +00006993 VdbeCoverage(v);
drh7d176102014-02-18 03:07:12 +00006994 VdbeCoverageIf(v, pLevel->op==OP_Next);
6995 VdbeCoverageIf(v, pLevel->op==OP_Prev);
6996 VdbeCoverageIf(v, pLevel->op==OP_VNext);
drh19a775c2000-06-05 18:54:46 +00006997 }
drh7ba39a92013-05-30 17:43:19 +00006998 if( pLoop->wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
drh72e8fa42007-03-28 14:30:06 +00006999 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00007000 int j;
drhb3190c12008-12-08 21:37:14 +00007001 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh111a6a72008-12-21 03:51:16 +00007002 for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00007003 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
drh2d96b932013-02-08 18:48:23 +00007004 sqlite3VdbeAddOp2(v, pIn->eEndLoopOp, pIn->iCur, pIn->addrInTop);
drh688852a2014-02-17 22:40:43 +00007005 VdbeCoverage(v);
drh7d176102014-02-18 03:07:12 +00007006 VdbeCoverageIf(v, pIn->eEndLoopOp==OP_PrevIfOpen);
7007 VdbeCoverageIf(v, pIn->eEndLoopOp==OP_NextIfOpen);
drhb3190c12008-12-08 21:37:14 +00007008 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00007009 }
drhd99f7062002-06-08 23:25:08 +00007010 }
drhb3190c12008-12-08 21:37:14 +00007011 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhcd8629e2013-11-13 12:27:25 +00007012 if( pLevel->addrSkip ){
drhcd8629e2013-11-13 12:27:25 +00007013 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrSkip);
drhe084f402013-11-13 17:24:38 +00007014 VdbeComment((v, "next skip-scan on %s", pLoop->u.btree.pIndex->zName));
drh2e5ef4e2013-11-13 16:58:54 +00007015 sqlite3VdbeJumpHere(v, pLevel->addrSkip);
7016 sqlite3VdbeJumpHere(v, pLevel->addrSkip-2);
drhcd8629e2013-11-13 12:27:25 +00007017 }
drhf07cf6e2015-03-06 16:45:16 +00007018 if( pLevel->addrLikeRep ){
drhb7c60ba2015-03-07 02:51:59 +00007019 int op;
7020 if( sqlite3VdbeGetOp(v, pLevel->addrLikeRep-1)->p1 ){
7021 op = OP_DecrJumpZero;
7022 }else{
7023 op = OP_JumpZeroIncr;
7024 }
7025 sqlite3VdbeAddOp2(v, op, pLevel->iLikeRepCntr, pLevel->addrLikeRep);
drhf07cf6e2015-03-06 16:45:16 +00007026 VdbeCoverage(v);
drhf07cf6e2015-03-06 16:45:16 +00007027 }
drhad2d8302002-05-24 20:31:36 +00007028 if( pLevel->iLeftJoin ){
drh688852a2014-02-17 22:40:43 +00007029 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin); VdbeCoverage(v);
drh7ba39a92013-05-30 17:43:19 +00007030 assert( (pLoop->wsFlags & WHERE_IDX_ONLY)==0
7031 || (pLoop->wsFlags & WHERE_INDEXED)!=0 );
7032 if( (pLoop->wsFlags & WHERE_IDX_ONLY)==0 ){
drh35451c62009-11-12 04:26:39 +00007033 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
7034 }
drh76f4cfb2013-05-31 18:20:52 +00007035 if( pLoop->wsFlags & WHERE_INDEXED ){
drh3c84ddf2008-01-09 02:15:38 +00007036 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00007037 }
drh336a5302009-04-24 15:46:21 +00007038 if( pLevel->op==OP_Return ){
7039 sqlite3VdbeAddOp2(v, OP_Gosub, pLevel->p1, pLevel->addrFirst);
7040 }else{
7041 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
7042 }
drhd654be82005-09-20 17:42:23 +00007043 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00007044 }
drh6bc69a22013-11-19 12:33:23 +00007045 VdbeModuleComment((v, "End WHERE-loop%d: %s", i,
drhfc8d4f92013-11-08 15:19:46 +00007046 pWInfo->pTabList->a[pLevel->iFrom].pTab->zName));
drh19a775c2000-06-05 18:54:46 +00007047 }
drh9012bcb2004-12-19 00:11:35 +00007048
7049 /* The "break" point is here, just past the end of the outer loop.
7050 ** Set it.
7051 */
danielk19774adee202004-05-08 08:23:19 +00007052 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00007053
drhfd636c72013-06-21 02:05:06 +00007054 assert( pWInfo->nLevel<=pTabList->nSrc );
drhc01a3c12009-12-16 22:10:49 +00007055 for(i=0, pLevel=pWInfo->a; i<pWInfo->nLevel; i++, pLevel++){
drh5f612292014-02-08 23:20:32 +00007056 int k, last;
7057 VdbeOp *pOp;
danbfca6a42012-08-24 10:52:35 +00007058 Index *pIdx = 0;
drh29dda4a2005-07-21 18:23:20 +00007059 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00007060 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00007061 assert( pTab!=0 );
drh7ba39a92013-05-30 17:43:19 +00007062 pLoop = pLevel->pWLoop;
drhfc8d4f92013-11-08 15:19:46 +00007063
drh5f612292014-02-08 23:20:32 +00007064 /* For a co-routine, change all OP_Column references to the table of
drh7b3aa082015-05-29 13:55:33 +00007065 ** the co-routine into OP_Copy of result contained in a register.
drh5f612292014-02-08 23:20:32 +00007066 ** OP_Rowid becomes OP_Null.
7067 */
danfbf0f0e2014-03-03 14:20:30 +00007068 if( pTabItem->viaCoroutine && !db->mallocFailed ){
drh7b3aa082015-05-29 13:55:33 +00007069 translateColumnToCopy(v, pLevel->addrBody, pLevel->iTabCur,
7070 pTabItem->regResult);
drh5f612292014-02-08 23:20:32 +00007071 continue;
7072 }
7073
drhfc8d4f92013-11-08 15:19:46 +00007074 /* Close all of the cursors that were opened by sqlite3WhereBegin.
7075 ** Except, do not close cursors that will be reused by the OR optimization
7076 ** (WHERE_OMIT_OPEN_CLOSE). And do not close the OP_OpenWrite cursors
7077 ** created for the ONEPASS optimization.
7078 */
drh4139c992010-04-07 14:59:45 +00007079 if( (pTab->tabFlags & TF_Ephemeral)==0
7080 && pTab->pSelect==0
drh9ef61f42011-10-07 14:40:59 +00007081 && (pWInfo->wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0
drh4139c992010-04-07 14:59:45 +00007082 ){
drh7ba39a92013-05-30 17:43:19 +00007083 int ws = pLoop->wsFlags;
drh8b307fb2010-04-06 15:57:05 +00007084 if( !pWInfo->okOnePass && (ws & WHERE_IDX_ONLY)==0 ){
drh6df2acd2008-12-28 16:55:25 +00007085 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
7086 }
drhfc8d4f92013-11-08 15:19:46 +00007087 if( (ws & WHERE_INDEXED)!=0
7088 && (ws & (WHERE_IPK|WHERE_AUTO_INDEX))==0
7089 && pLevel->iIdxCur!=pWInfo->aiCurOnePass[1]
7090 ){
drh6df2acd2008-12-28 16:55:25 +00007091 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
7092 }
drh9012bcb2004-12-19 00:11:35 +00007093 }
7094
drhf0030762013-06-14 13:27:01 +00007095 /* If this scan uses an index, make VDBE code substitutions to read data
7096 ** from the index instead of from the table where possible. In some cases
7097 ** this optimization prevents the table from ever being read, which can
7098 ** yield a significant performance boost.
drh9012bcb2004-12-19 00:11:35 +00007099 **
7100 ** Calls to the code generator in between sqlite3WhereBegin and
7101 ** sqlite3WhereEnd will have created code that references the table
7102 ** directly. This loop scans all that code looking for opcodes
7103 ** that reference the table and converts them into opcodes that
7104 ** reference the index.
7105 */
drh7ba39a92013-05-30 17:43:19 +00007106 if( pLoop->wsFlags & (WHERE_INDEXED|WHERE_IDX_ONLY) ){
7107 pIdx = pLoop->u.btree.pIndex;
7108 }else if( pLoop->wsFlags & WHERE_MULTI_OR ){
drhd40e2082012-08-24 23:24:15 +00007109 pIdx = pLevel->u.pCovidx;
danbfca6a42012-08-24 10:52:35 +00007110 }
drh7ba39a92013-05-30 17:43:19 +00007111 if( pIdx && !db->mallocFailed ){
drh9012bcb2004-12-19 00:11:35 +00007112 last = sqlite3VdbeCurrentAddr(v);
drhcc04afd2013-08-22 02:56:28 +00007113 k = pLevel->addrBody;
7114 pOp = sqlite3VdbeGetOp(v, k);
7115 for(; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00007116 if( pOp->p1!=pLevel->iTabCur ) continue;
7117 if( pOp->opcode==OP_Column ){
drhee0ec8e2013-10-31 17:38:01 +00007118 int x = pOp->p2;
drh511717c2013-11-08 17:13:23 +00007119 assert( pIdx->pTable==pTab );
drhee0ec8e2013-10-31 17:38:01 +00007120 if( !HasRowid(pTab) ){
7121 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
7122 x = pPk->aiColumn[x];
7123 }
7124 x = sqlite3ColumnOfIndex(pIdx, x);
drh44156282013-10-23 22:23:03 +00007125 if( x>=0 ){
7126 pOp->p2 = x;
7127 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00007128 }
drh44156282013-10-23 22:23:03 +00007129 assert( (pLoop->wsFlags & WHERE_IDX_ONLY)==0 || x>=0 );
drhf0863fe2005-06-12 21:35:51 +00007130 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00007131 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00007132 pOp->opcode = OP_IdxRowid;
drh9012bcb2004-12-19 00:11:35 +00007133 }
7134 }
drh6b563442001-11-07 16:48:26 +00007135 }
drh19a775c2000-06-05 18:54:46 +00007136 }
drh9012bcb2004-12-19 00:11:35 +00007137
7138 /* Final cleanup
7139 */
drhf12cde52010-04-08 17:28:00 +00007140 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
7141 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00007142 return;
7143}