blob: 740e1607e0209eb9c0665e97af4a4ebca32e9afc [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){
50 return pWInfo->iContinue;
51}
52
53/*
54** Return the VDBE address or label to jump to in order to break
55** out of a WHERE loop.
56*/
57int sqlite3WhereBreakLabel(WhereInfo *pWInfo){
58 return pWInfo->iBreak;
59}
60
61/*
62** Return TRUE if an UPDATE or DELETE statement can operate directly on
63** the rowids returned by a WHERE clause. Return FALSE if doing an
64** UPDATE or DELETE might change subsequent WHERE clause results.
drhfc8d4f92013-11-08 15:19:46 +000065**
66** If the ONEPASS optimization is used (if this routine returns true)
67** then also write the indices of open cursors used by ONEPASS
68** into aiCur[0] and aiCur[1]. iaCur[0] gets the cursor of the data
69** table and iaCur[1] gets the cursor used by an auxiliary index.
70** Either value may be -1, indicating that cursor is not used.
71** Any cursors returned will have been opened for writing.
72**
73** aiCur[0] and aiCur[1] both get -1 if the where-clause logic is
74** unable to use the ONEPASS optimization.
drh6f328482013-06-05 23:39:34 +000075*/
drhfc8d4f92013-11-08 15:19:46 +000076int sqlite3WhereOkOnePass(WhereInfo *pWInfo, int *aiCur){
77 memcpy(aiCur, pWInfo->aiCurOnePass, sizeof(int)*2);
drh6f328482013-06-05 23:39:34 +000078 return pWInfo->okOnePass;
79}
80
81/*
drhaa32e3c2013-07-16 21:31:23 +000082** Move the content of pSrc into pDest
83*/
84static void whereOrMove(WhereOrSet *pDest, WhereOrSet *pSrc){
85 pDest->n = pSrc->n;
86 memcpy(pDest->a, pSrc->a, pDest->n*sizeof(pDest->a[0]));
87}
88
89/*
90** Try to insert a new prerequisite/cost entry into the WhereOrSet pSet.
91**
92** The new entry might overwrite an existing entry, or it might be
93** appended, or it might be discarded. Do whatever is the right thing
94** so that pSet keeps the N_OR_COST best entries seen so far.
95*/
96static int whereOrInsert(
97 WhereOrSet *pSet, /* The WhereOrSet to be updated */
98 Bitmask prereq, /* Prerequisites of the new entry */
drhbf539c42013-10-05 18:16:02 +000099 LogEst rRun, /* Run-cost of the new entry */
100 LogEst nOut /* Number of outputs for the new entry */
drhaa32e3c2013-07-16 21:31:23 +0000101){
102 u16 i;
103 WhereOrCost *p;
104 for(i=pSet->n, p=pSet->a; i>0; i--, p++){
105 if( rRun<=p->rRun && (prereq & p->prereq)==prereq ){
106 goto whereOrInsert_done;
107 }
108 if( p->rRun<=rRun && (p->prereq & prereq)==p->prereq ){
109 return 0;
110 }
111 }
112 if( pSet->n<N_OR_COST ){
113 p = &pSet->a[pSet->n++];
114 p->nOut = nOut;
115 }else{
116 p = pSet->a;
117 for(i=1; i<pSet->n; i++){
118 if( p->rRun>pSet->a[i].rRun ) p = pSet->a + i;
119 }
120 if( p->rRun<=rRun ) return 0;
121 }
122whereOrInsert_done:
123 p->prereq = prereq;
124 p->rRun = rRun;
125 if( p->nOut>nOut ) p->nOut = nOut;
126 return 1;
127}
128
129/*
drh0aa74ed2005-07-16 13:33:20 +0000130** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000131*/
drh7b4fc6a2007-02-06 13:26:32 +0000132static void whereClauseInit(
133 WhereClause *pWC, /* The WhereClause to be initialized */
drh70d18342013-06-06 19:16:33 +0000134 WhereInfo *pWInfo /* The WHERE processing context */
drh7b4fc6a2007-02-06 13:26:32 +0000135){
drh70d18342013-06-06 19:16:33 +0000136 pWC->pWInfo = pWInfo;
drh8871ef52011-10-07 13:33:10 +0000137 pWC->pOuter = 0;
drh0aa74ed2005-07-16 13:33:20 +0000138 pWC->nTerm = 0;
drhcad651e2007-04-20 12:22:01 +0000139 pWC->nSlot = ArraySize(pWC->aStatic);
drh0aa74ed2005-07-16 13:33:20 +0000140 pWC->a = pWC->aStatic;
141}
142
drh700a2262008-12-17 19:22:15 +0000143/* Forward reference */
144static void whereClauseClear(WhereClause*);
145
146/*
147** Deallocate all memory associated with a WhereOrInfo object.
148*/
149static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000150 whereClauseClear(&p->wc);
151 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000152}
153
154/*
155** Deallocate all memory associated with a WhereAndInfo object.
156*/
157static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000158 whereClauseClear(&p->wc);
159 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000160}
161
drh0aa74ed2005-07-16 13:33:20 +0000162/*
163** Deallocate a WhereClause structure. The WhereClause structure
164** itself is not freed. This routine is the inverse of whereClauseInit().
165*/
166static void whereClauseClear(WhereClause *pWC){
167 int i;
168 WhereTerm *a;
drh70d18342013-06-06 19:16:33 +0000169 sqlite3 *db = pWC->pWInfo->pParse->db;
drh0aa74ed2005-07-16 13:33:20 +0000170 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
drh165be382008-12-05 02:36:33 +0000171 if( a->wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000172 sqlite3ExprDelete(db, a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000173 }
drh700a2262008-12-17 19:22:15 +0000174 if( a->wtFlags & TERM_ORINFO ){
175 whereOrInfoDelete(db, a->u.pOrInfo);
176 }else if( a->wtFlags & TERM_ANDINFO ){
177 whereAndInfoDelete(db, a->u.pAndInfo);
178 }
drh0aa74ed2005-07-16 13:33:20 +0000179 }
180 if( pWC->a!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000181 sqlite3DbFree(db, pWC->a);
drh0aa74ed2005-07-16 13:33:20 +0000182 }
183}
184
185/*
drh6a1e0712008-12-05 15:24:15 +0000186** Add a single new WhereTerm entry to the WhereClause object pWC.
187** The new WhereTerm object is constructed from Expr p and with wtFlags.
188** The index in pWC->a[] of the new WhereTerm is returned on success.
189** 0 is returned if the new WhereTerm could not be added due to a memory
190** allocation error. The memory allocation failure will be recorded in
191** the db->mallocFailed flag so that higher-level functions can detect it.
192**
193** This routine will increase the size of the pWC->a[] array as necessary.
drh9eb20282005-08-24 03:52:18 +0000194**
drh165be382008-12-05 02:36:33 +0000195** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
drh6a1e0712008-12-05 15:24:15 +0000196** for freeing the expression p is assumed by the WhereClause object pWC.
197** This is true even if this routine fails to allocate a new WhereTerm.
drhb63a53d2007-03-31 01:34:44 +0000198**
drh9eb20282005-08-24 03:52:18 +0000199** WARNING: This routine might reallocate the space used to store
drh909626d2008-05-30 14:58:37 +0000200** WhereTerms. All pointers to WhereTerms should be invalidated after
drh9eb20282005-08-24 03:52:18 +0000201** calling this routine. Such pointers may be reinitialized by referencing
202** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000203*/
drhec1724e2008-12-09 01:32:03 +0000204static int whereClauseInsert(WhereClause *pWC, Expr *p, u8 wtFlags){
drh0aa74ed2005-07-16 13:33:20 +0000205 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000206 int idx;
drh39759742013-08-02 23:40:45 +0000207 testcase( wtFlags & TERM_VIRTUAL );
drh0aa74ed2005-07-16 13:33:20 +0000208 if( pWC->nTerm>=pWC->nSlot ){
209 WhereTerm *pOld = pWC->a;
drh70d18342013-06-06 19:16:33 +0000210 sqlite3 *db = pWC->pWInfo->pParse->db;
drh633e6d52008-07-28 19:34:53 +0000211 pWC->a = sqlite3DbMallocRaw(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
drhb63a53d2007-03-31 01:34:44 +0000212 if( pWC->a==0 ){
drh165be382008-12-05 02:36:33 +0000213 if( wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000214 sqlite3ExprDelete(db, p);
drhb63a53d2007-03-31 01:34:44 +0000215 }
drhf998b732007-11-26 13:36:00 +0000216 pWC->a = pOld;
drhb63a53d2007-03-31 01:34:44 +0000217 return 0;
218 }
drh0aa74ed2005-07-16 13:33:20 +0000219 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
220 if( pOld!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000221 sqlite3DbFree(db, pOld);
drh0aa74ed2005-07-16 13:33:20 +0000222 }
drh6a1e0712008-12-05 15:24:15 +0000223 pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
drh0aa74ed2005-07-16 13:33:20 +0000224 }
drh6a1e0712008-12-05 15:24:15 +0000225 pTerm = &pWC->a[idx = pWC->nTerm++];
drha4c3c872013-09-12 17:29:25 +0000226 if( p && ExprHasProperty(p, EP_Unlikely) ){
drhbf539c42013-10-05 18:16:02 +0000227 pTerm->truthProb = sqlite3LogEst(p->iTable) - 99;
drhcca9f3d2013-09-06 15:23:29 +0000228 }else{
229 pTerm->truthProb = -1;
230 }
drh7ee751d2012-12-19 15:53:51 +0000231 pTerm->pExpr = sqlite3ExprSkipCollate(p);
drh165be382008-12-05 02:36:33 +0000232 pTerm->wtFlags = wtFlags;
drh0fcef5e2005-07-19 17:38:22 +0000233 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000234 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000235 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000236}
drh75897232000-05-29 14:26:00 +0000237
238/*
drh51669862004-12-18 18:40:26 +0000239** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000240** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000241** operator specified in the op parameter. The WhereClause structure
242** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000243**
drh51669862004-12-18 18:40:26 +0000244** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
245** \________/ \_______________/ \________________/
246** slot[0] slot[1] slot[2]
247**
248** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000249** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000250**
drh51147ba2005-07-23 22:59:55 +0000251** In the previous sentence and in the diagram, "slot[]" refers to
drh902b9ee2008-12-05 17:17:07 +0000252** the WhereClause.a[] array. The slot[] array grows as needed to contain
drh51147ba2005-07-23 22:59:55 +0000253** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000254*/
drh74f91d42013-06-19 18:01:44 +0000255static void whereSplit(WhereClause *pWC, Expr *pExpr, u8 op){
256 pWC->op = op;
drh0aa74ed2005-07-16 13:33:20 +0000257 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000258 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000259 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000260 }else{
drh6c30be82005-07-29 15:10:17 +0000261 whereSplit(pWC, pExpr->pLeft, op);
262 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000263 }
drh75897232000-05-29 14:26:00 +0000264}
265
266/*
drh3b48e8c2013-06-12 20:18:16 +0000267** Initialize a WhereMaskSet object
drh6a3ea0e2003-05-02 14:32:12 +0000268*/
drhfd5874d2013-06-12 14:52:39 +0000269#define initMaskSet(P) (P)->n=0
drh6a3ea0e2003-05-02 14:32:12 +0000270
271/*
drh1398ad32005-01-19 23:24:50 +0000272** Return the bitmask for the given cursor number. Return 0 if
273** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000274*/
drh111a6a72008-12-21 03:51:16 +0000275static Bitmask getMask(WhereMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000276 int i;
drhfcd71b62011-04-05 22:08:24 +0000277 assert( pMaskSet->n<=(int)sizeof(Bitmask)*8 );
drh6a3ea0e2003-05-02 14:32:12 +0000278 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000279 if( pMaskSet->ix[i]==iCursor ){
drh7699d1c2013-06-04 12:42:29 +0000280 return MASKBIT(i);
drh51669862004-12-18 18:40:26 +0000281 }
drh6a3ea0e2003-05-02 14:32:12 +0000282 }
drh6a3ea0e2003-05-02 14:32:12 +0000283 return 0;
284}
285
286/*
drh1398ad32005-01-19 23:24:50 +0000287** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000288**
289** There is one cursor per table in the FROM clause. The number of
290** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000291** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000292** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000293*/
drh111a6a72008-12-21 03:51:16 +0000294static void createMask(WhereMaskSet *pMaskSet, int iCursor){
drhcad651e2007-04-20 12:22:01 +0000295 assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
drh0fcef5e2005-07-19 17:38:22 +0000296 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000297}
298
299/*
drh4a6fc352013-08-07 01:18:38 +0000300** These routines walk (recursively) an expression tree and generate
drh75897232000-05-29 14:26:00 +0000301** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000302** tree.
drh75897232000-05-29 14:26:00 +0000303*/
drh111a6a72008-12-21 03:51:16 +0000304static Bitmask exprListTableUsage(WhereMaskSet*, ExprList*);
305static Bitmask exprSelectTableUsage(WhereMaskSet*, Select*);
306static Bitmask exprTableUsage(WhereMaskSet *pMaskSet, Expr *p){
drh51669862004-12-18 18:40:26 +0000307 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000308 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000309 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000310 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000311 return mask;
drh75897232000-05-29 14:26:00 +0000312 }
danielk1977b3bce662005-01-29 08:32:43 +0000313 mask = exprTableUsage(pMaskSet, p->pRight);
314 mask |= exprTableUsage(pMaskSet, p->pLeft);
danielk19776ab3a2e2009-02-19 14:39:25 +0000315 if( ExprHasProperty(p, EP_xIsSelect) ){
316 mask |= exprSelectTableUsage(pMaskSet, p->x.pSelect);
317 }else{
318 mask |= exprListTableUsage(pMaskSet, p->x.pList);
319 }
danielk1977b3bce662005-01-29 08:32:43 +0000320 return mask;
321}
drh111a6a72008-12-21 03:51:16 +0000322static Bitmask exprListTableUsage(WhereMaskSet *pMaskSet, ExprList *pList){
danielk1977b3bce662005-01-29 08:32:43 +0000323 int i;
324 Bitmask mask = 0;
325 if( pList ){
326 for(i=0; i<pList->nExpr; i++){
327 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000328 }
329 }
drh75897232000-05-29 14:26:00 +0000330 return mask;
331}
drh111a6a72008-12-21 03:51:16 +0000332static Bitmask exprSelectTableUsage(WhereMaskSet *pMaskSet, Select *pS){
drha430ae82007-09-12 15:41:01 +0000333 Bitmask mask = 0;
334 while( pS ){
drha464c232011-09-16 19:04:03 +0000335 SrcList *pSrc = pS->pSrc;
drha430ae82007-09-12 15:41:01 +0000336 mask |= exprListTableUsage(pMaskSet, pS->pEList);
drhf5b11382005-09-17 13:07:13 +0000337 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
338 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
339 mask |= exprTableUsage(pMaskSet, pS->pWhere);
340 mask |= exprTableUsage(pMaskSet, pS->pHaving);
drha464c232011-09-16 19:04:03 +0000341 if( ALWAYS(pSrc!=0) ){
drh88501772011-09-16 17:43:06 +0000342 int i;
343 for(i=0; i<pSrc->nSrc; i++){
344 mask |= exprSelectTableUsage(pMaskSet, pSrc->a[i].pSelect);
345 mask |= exprTableUsage(pMaskSet, pSrc->a[i].pOn);
346 }
347 }
drha430ae82007-09-12 15:41:01 +0000348 pS = pS->pPrior;
drhf5b11382005-09-17 13:07:13 +0000349 }
350 return mask;
351}
drh75897232000-05-29 14:26:00 +0000352
353/*
drh487ab3c2001-11-08 00:45:21 +0000354** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000355** allowed for an indexable WHERE clause term. The allowed operators are
drh3b48e8c2013-06-12 20:18:16 +0000356** "=", "<", ">", "<=", ">=", "IN", and "IS NULL"
drh487ab3c2001-11-08 00:45:21 +0000357*/
358static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000359 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
360 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
361 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
362 assert( TK_GE==TK_EQ+4 );
drh50b39962006-10-28 00:28:09 +0000363 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL;
drh487ab3c2001-11-08 00:45:21 +0000364}
365
366/*
drh902b9ee2008-12-05 17:17:07 +0000367** Swap two objects of type TYPE.
drh193bd772004-07-20 18:23:14 +0000368*/
369#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
370
371/*
drh909626d2008-05-30 14:58:37 +0000372** Commute a comparison operator. Expressions of the form "X op Y"
drh0fcef5e2005-07-19 17:38:22 +0000373** are converted into "Y op X".
danielk1977eb5453d2007-07-30 14:40:48 +0000374**
mistachkin48864df2013-03-21 21:20:32 +0000375** If left/right precedence rules come into play when determining the
drh3b48e8c2013-06-12 20:18:16 +0000376** collating sequence, then COLLATE operators are adjusted to ensure
377** that the collating sequence does not change. For example:
378** "Y collate NOCASE op X" becomes "X op Y" because any collation sequence on
danielk1977eb5453d2007-07-30 14:40:48 +0000379** the left hand side of a comparison overrides any collation sequence
drhae80dde2012-12-06 21:16:43 +0000380** attached to the right. For the same reason the EP_Collate flag
danielk1977eb5453d2007-07-30 14:40:48 +0000381** is not commuted.
drh193bd772004-07-20 18:23:14 +0000382*/
drh7d10d5a2008-08-20 16:35:10 +0000383static void exprCommute(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000384 u16 expRight = (pExpr->pRight->flags & EP_Collate);
385 u16 expLeft = (pExpr->pLeft->flags & EP_Collate);
drhfe05af82005-07-21 03:14:59 +0000386 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drhae80dde2012-12-06 21:16:43 +0000387 if( expRight==expLeft ){
388 /* Either X and Y both have COLLATE operator or neither do */
389 if( expRight ){
390 /* Both X and Y have COLLATE operators. Make sure X is always
391 ** used by clearing the EP_Collate flag from Y. */
392 pExpr->pRight->flags &= ~EP_Collate;
393 }else if( sqlite3ExprCollSeq(pParse, pExpr->pLeft)!=0 ){
394 /* Neither X nor Y have COLLATE operators, but X has a non-default
395 ** collating sequence. So add the EP_Collate marker on X to cause
396 ** it to be searched first. */
397 pExpr->pLeft->flags |= EP_Collate;
398 }
399 }
drh0fcef5e2005-07-19 17:38:22 +0000400 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
401 if( pExpr->op>=TK_GT ){
402 assert( TK_LT==TK_GT+2 );
403 assert( TK_GE==TK_LE+2 );
404 assert( TK_GT>TK_EQ );
405 assert( TK_GT<TK_LE );
406 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
407 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000408 }
drh193bd772004-07-20 18:23:14 +0000409}
410
411/*
drhfe05af82005-07-21 03:14:59 +0000412** Translate from TK_xx operator to WO_xx bitmask.
413*/
drhec1724e2008-12-09 01:32:03 +0000414static u16 operatorMask(int op){
415 u16 c;
drhfe05af82005-07-21 03:14:59 +0000416 assert( allowedOp(op) );
417 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000418 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000419 }else if( op==TK_ISNULL ){
420 c = WO_ISNULL;
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 );
432 return c;
drhfe05af82005-07-21 03:14:59 +0000433}
434
435/*
drh1c8148f2013-05-04 20:25:23 +0000436** Advance to the next WhereTerm that matches according to the criteria
437** established when the pScan object was initialized by whereScanInit().
438** Return NULL if there are no more matching WhereTerms.
439*/
danb2cfc142013-07-05 11:10:54 +0000440static WhereTerm *whereScanNext(WhereScan *pScan){
drh1c8148f2013-05-04 20:25:23 +0000441 int iCur; /* The cursor on the LHS of the term */
442 int iColumn; /* The column on the LHS of the term. -1 for IPK */
443 Expr *pX; /* An expression being tested */
444 WhereClause *pWC; /* Shorthand for pScan->pWC */
445 WhereTerm *pTerm; /* The term being tested */
drh43b85ef2013-06-10 12:34:45 +0000446 int k = pScan->k; /* Where to start scanning */
drh1c8148f2013-05-04 20:25:23 +0000447
448 while( pScan->iEquiv<=pScan->nEquiv ){
449 iCur = pScan->aEquiv[pScan->iEquiv-2];
450 iColumn = pScan->aEquiv[pScan->iEquiv-1];
451 while( (pWC = pScan->pWC)!=0 ){
drh43b85ef2013-06-10 12:34:45 +0000452 for(pTerm=pWC->a+k; k<pWC->nTerm; k++, pTerm++){
drhe1a086e2013-10-28 20:15:56 +0000453 if( pTerm->leftCursor==iCur
454 && pTerm->u.leftColumn==iColumn
455 && (pScan->iEquiv<=2 || !ExprHasProperty(pTerm->pExpr, EP_FromJoin))
456 ){
drh1c8148f2013-05-04 20:25:23 +0000457 if( (pTerm->eOperator & WO_EQUIV)!=0
458 && pScan->nEquiv<ArraySize(pScan->aEquiv)
459 ){
460 int j;
461 pX = sqlite3ExprSkipCollate(pTerm->pExpr->pRight);
462 assert( pX->op==TK_COLUMN );
463 for(j=0; j<pScan->nEquiv; j+=2){
464 if( pScan->aEquiv[j]==pX->iTable
465 && pScan->aEquiv[j+1]==pX->iColumn ){
466 break;
467 }
468 }
469 if( j==pScan->nEquiv ){
470 pScan->aEquiv[j] = pX->iTable;
471 pScan->aEquiv[j+1] = pX->iColumn;
472 pScan->nEquiv += 2;
473 }
474 }
475 if( (pTerm->eOperator & pScan->opMask)!=0 ){
476 /* Verify the affinity and collating sequence match */
477 if( pScan->zCollName && (pTerm->eOperator & WO_ISNULL)==0 ){
478 CollSeq *pColl;
drh70d18342013-06-06 19:16:33 +0000479 Parse *pParse = pWC->pWInfo->pParse;
drh1c8148f2013-05-04 20:25:23 +0000480 pX = pTerm->pExpr;
481 if( !sqlite3IndexAffinityOk(pX, pScan->idxaff) ){
482 continue;
483 }
484 assert(pX->pLeft);
drh70d18342013-06-06 19:16:33 +0000485 pColl = sqlite3BinaryCompareCollSeq(pParse,
drh1c8148f2013-05-04 20:25:23 +0000486 pX->pLeft, pX->pRight);
drh70d18342013-06-06 19:16:33 +0000487 if( pColl==0 ) pColl = pParse->db->pDfltColl;
drh1c8148f2013-05-04 20:25:23 +0000488 if( sqlite3StrICmp(pColl->zName, pScan->zCollName) ){
489 continue;
490 }
491 }
drha184fb82013-05-08 04:22:59 +0000492 if( (pTerm->eOperator & WO_EQ)!=0
493 && (pX = pTerm->pExpr->pRight)->op==TK_COLUMN
494 && pX->iTable==pScan->aEquiv[0]
495 && pX->iColumn==pScan->aEquiv[1]
496 ){
497 continue;
498 }
drh43b85ef2013-06-10 12:34:45 +0000499 pScan->k = k+1;
drh1c8148f2013-05-04 20:25:23 +0000500 return pTerm;
501 }
502 }
503 }
drhad01d892013-06-19 13:59:49 +0000504 pScan->pWC = pScan->pWC->pOuter;
drh43b85ef2013-06-10 12:34:45 +0000505 k = 0;
drh1c8148f2013-05-04 20:25:23 +0000506 }
507 pScan->pWC = pScan->pOrigWC;
drh43b85ef2013-06-10 12:34:45 +0000508 k = 0;
drh1c8148f2013-05-04 20:25:23 +0000509 pScan->iEquiv += 2;
510 }
drh1c8148f2013-05-04 20:25:23 +0000511 return 0;
512}
513
514/*
515** Initialize a WHERE clause scanner object. Return a pointer to the
516** first match. Return NULL if there are no matches.
517**
518** The scanner will be searching the WHERE clause pWC. It will look
519** for terms of the form "X <op> <expr>" where X is column iColumn of table
520** iCur. The <op> must be one of the operators described by opMask.
521**
drh3b48e8c2013-06-12 20:18:16 +0000522** If the search is for X and the WHERE clause contains terms of the
523** form X=Y then this routine might also return terms of the form
524** "Y <op> <expr>". The number of levels of transitivity is limited,
525** but is enough to handle most commonly occurring SQL statements.
526**
drh1c8148f2013-05-04 20:25:23 +0000527** If X is not the INTEGER PRIMARY KEY then X must be compatible with
528** index pIdx.
529*/
danb2cfc142013-07-05 11:10:54 +0000530static WhereTerm *whereScanInit(
drh1c8148f2013-05-04 20:25:23 +0000531 WhereScan *pScan, /* The WhereScan object being initialized */
532 WhereClause *pWC, /* The WHERE clause to be scanned */
533 int iCur, /* Cursor to scan for */
534 int iColumn, /* Column to scan for */
535 u32 opMask, /* Operator(s) to scan for */
536 Index *pIdx /* Must be compatible with this index */
537){
538 int j;
539
drhe9d935a2013-06-05 16:19:59 +0000540 /* memset(pScan, 0, sizeof(*pScan)); */
drh1c8148f2013-05-04 20:25:23 +0000541 pScan->pOrigWC = pWC;
542 pScan->pWC = pWC;
543 if( pIdx && iColumn>=0 ){
544 pScan->idxaff = pIdx->pTable->aCol[iColumn].affinity;
545 for(j=0; pIdx->aiColumn[j]!=iColumn; j++){
drhbbbdc832013-10-22 18:01:40 +0000546 if( NEVER(j>=pIdx->nKeyCol) ) return 0;
drh1c8148f2013-05-04 20:25:23 +0000547 }
548 pScan->zCollName = pIdx->azColl[j];
drhe9d935a2013-06-05 16:19:59 +0000549 }else{
550 pScan->idxaff = 0;
551 pScan->zCollName = 0;
drh1c8148f2013-05-04 20:25:23 +0000552 }
553 pScan->opMask = opMask;
drhe9d935a2013-06-05 16:19:59 +0000554 pScan->k = 0;
drh1c8148f2013-05-04 20:25:23 +0000555 pScan->aEquiv[0] = iCur;
556 pScan->aEquiv[1] = iColumn;
557 pScan->nEquiv = 2;
558 pScan->iEquiv = 2;
559 return whereScanNext(pScan);
560}
561
562/*
drhfe05af82005-07-21 03:14:59 +0000563** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
564** where X is a reference to the iColumn of table iCur and <op> is one of
565** the WO_xx operator codes specified by the op parameter.
566** Return a pointer to the term. Return 0 if not found.
drh58eb1c02013-01-17 00:08:42 +0000567**
568** The term returned might by Y=<expr> if there is another constraint in
569** the WHERE clause that specifies that X=Y. Any such constraints will be
570** identified by the WO_EQUIV bit in the pTerm->eOperator field. The
571** aEquiv[] array holds X and all its equivalents, with each SQL variable
572** taking up two slots in aEquiv[]. The first slot is for the cursor number
573** and the second is for the column number. There are 22 slots in aEquiv[]
574** so that means we can look for X plus up to 10 other equivalent values.
575** Hence a search for X will return <expr> if X=A1 and A1=A2 and A2=A3
576** and ... and A9=A10 and A10=<expr>.
577**
578** If there are multiple terms in the WHERE clause of the form "X <op> <expr>"
579** then try for the one with no dependencies on <expr> - in other words where
580** <expr> is a constant expression of some kind. Only return entries of
581** the form "X <op> Y" where Y is a column in another table if no terms of
drh459f63e2013-03-06 01:55:27 +0000582** the form "X <op> <const-expr>" exist. If no terms with a constant RHS
583** exist, try to return a term that does not use WO_EQUIV.
drhfe05af82005-07-21 03:14:59 +0000584*/
585static WhereTerm *findTerm(
586 WhereClause *pWC, /* The WHERE clause to be searched */
587 int iCur, /* Cursor number of LHS */
588 int iColumn, /* Column number of LHS */
589 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000590 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000591 Index *pIdx /* Must be compatible with this index, if not NULL */
592){
drh1c8148f2013-05-04 20:25:23 +0000593 WhereTerm *pResult = 0;
594 WhereTerm *p;
595 WhereScan scan;
drh7a5bcc02013-01-16 17:08:58 +0000596
drh1c8148f2013-05-04 20:25:23 +0000597 p = whereScanInit(&scan, pWC, iCur, iColumn, op, pIdx);
598 while( p ){
599 if( (p->prereqRight & notReady)==0 ){
600 if( p->prereqRight==0 && (p->eOperator&WO_EQ)!=0 ){
601 return p;
drhfe05af82005-07-21 03:14:59 +0000602 }
drh1c8148f2013-05-04 20:25:23 +0000603 if( pResult==0 ) pResult = p;
drhfe05af82005-07-21 03:14:59 +0000604 }
drh1c8148f2013-05-04 20:25:23 +0000605 p = whereScanNext(&scan);
drhfe05af82005-07-21 03:14:59 +0000606 }
drh7a5bcc02013-01-16 17:08:58 +0000607 return pResult;
drhfe05af82005-07-21 03:14:59 +0000608}
609
drh6c30be82005-07-29 15:10:17 +0000610/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000611static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000612
613/*
614** Call exprAnalyze on all terms in a WHERE clause.
drh6c30be82005-07-29 15:10:17 +0000615*/
616static void exprAnalyzeAll(
617 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000618 WhereClause *pWC /* the WHERE clause to be analyzed */
619){
drh6c30be82005-07-29 15:10:17 +0000620 int i;
drh9eb20282005-08-24 03:52:18 +0000621 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000622 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000623 }
624}
625
drhd2687b72005-08-12 22:56:09 +0000626#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
627/*
628** Check to see if the given expression is a LIKE or GLOB operator that
629** can be optimized using inequality constraints. Return TRUE if it is
630** so and false if not.
631**
632** In order for the operator to be optimizible, the RHS must be a string
633** literal that does not begin with a wildcard.
634*/
635static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000636 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000637 Expr *pExpr, /* Test this expression */
dan937d0de2009-10-15 18:35:38 +0000638 Expr **ppPrefix, /* Pointer to TK_STRING expression with pattern prefix */
drh9f504ea2008-02-23 21:55:39 +0000639 int *pisComplete, /* True if the only wildcard is % in the last character */
640 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000641){
dan937d0de2009-10-15 18:35:38 +0000642 const char *z = 0; /* String on RHS of LIKE operator */
drh5bd98ae2009-01-07 18:24:03 +0000643 Expr *pRight, *pLeft; /* Right and left size of LIKE operator */
644 ExprList *pList; /* List of operands to the LIKE operator */
645 int c; /* One character in z[] */
646 int cnt; /* Number of non-wildcard prefix characters */
647 char wc[3]; /* Wildcard characters */
drh5bd98ae2009-01-07 18:24:03 +0000648 sqlite3 *db = pParse->db; /* Database connection */
dan937d0de2009-10-15 18:35:38 +0000649 sqlite3_value *pVal = 0;
650 int op; /* Opcode of pRight */
drhd64fe2f2005-08-28 17:00:23 +0000651
drh9f504ea2008-02-23 21:55:39 +0000652 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000653 return 0;
654 }
drh9f504ea2008-02-23 21:55:39 +0000655#ifdef SQLITE_EBCDIC
656 if( *pnoCase ) return 0;
657#endif
danielk19776ab3a2e2009-02-19 14:39:25 +0000658 pList = pExpr->x.pList;
drh55ef4d92005-08-14 01:20:37 +0000659 pLeft = pList->a[1].pExpr;
danc68939e2012-03-29 14:29:07 +0000660 if( pLeft->op!=TK_COLUMN
661 || sqlite3ExprAffinity(pLeft)!=SQLITE_AFF_TEXT
662 || IsVirtual(pLeft->pTab)
663 ){
drhd91ca492009-10-22 20:50:36 +0000664 /* IMP: R-02065-49465 The left-hand side of the LIKE or GLOB operator must
665 ** be the name of an indexed column with TEXT affinity. */
drhd2687b72005-08-12 22:56:09 +0000666 return 0;
667 }
drhd91ca492009-10-22 20:50:36 +0000668 assert( pLeft->iColumn!=(-1) ); /* Because IPK never has AFF_TEXT */
dan937d0de2009-10-15 18:35:38 +0000669
drh6ade4532014-01-16 15:31:41 +0000670 pRight = sqlite3ExprSkipCollate(pList->a[0].pExpr);
dan937d0de2009-10-15 18:35:38 +0000671 op = pRight->op;
dan937d0de2009-10-15 18:35:38 +0000672 if( op==TK_VARIABLE ){
673 Vdbe *pReprepare = pParse->pReprepare;
drha7044002010-09-14 18:22:59 +0000674 int iCol = pRight->iColumn;
drhcf0fd4a2013-08-01 12:21:58 +0000675 pVal = sqlite3VdbeGetBoundValue(pReprepare, iCol, SQLITE_AFF_NONE);
dan937d0de2009-10-15 18:35:38 +0000676 if( pVal && sqlite3_value_type(pVal)==SQLITE_TEXT ){
677 z = (char *)sqlite3_value_text(pVal);
678 }
drhf9b22ca2011-10-21 16:47:31 +0000679 sqlite3VdbeSetVarmask(pParse->pVdbe, iCol);
dan937d0de2009-10-15 18:35:38 +0000680 assert( pRight->op==TK_VARIABLE || pRight->op==TK_REGISTER );
681 }else if( op==TK_STRING ){
682 z = pRight->u.zToken;
683 }
684 if( z ){
shane85095702009-06-15 16:27:08 +0000685 cnt = 0;
drhb7916a72009-05-27 10:31:29 +0000686 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){
drh24fb6272009-05-01 21:13:36 +0000687 cnt++;
688 }
drh93ee23c2010-07-22 12:33:57 +0000689 if( cnt!=0 && 255!=(u8)z[cnt-1] ){
dan937d0de2009-10-15 18:35:38 +0000690 Expr *pPrefix;
drh93ee23c2010-07-22 12:33:57 +0000691 *pisComplete = c==wc[0] && z[cnt+1]==0;
dan937d0de2009-10-15 18:35:38 +0000692 pPrefix = sqlite3Expr(db, TK_STRING, z);
693 if( pPrefix ) pPrefix->u.zToken[cnt] = 0;
694 *ppPrefix = pPrefix;
695 if( op==TK_VARIABLE ){
696 Vdbe *v = pParse->pVdbe;
drhf9b22ca2011-10-21 16:47:31 +0000697 sqlite3VdbeSetVarmask(v, pRight->iColumn);
dan937d0de2009-10-15 18:35:38 +0000698 if( *pisComplete && pRight->u.zToken[1] ){
699 /* If the rhs of the LIKE expression is a variable, and the current
700 ** value of the variable means there is no need to invoke the LIKE
701 ** function, then no OP_Variable will be added to the program.
702 ** This causes problems for the sqlite3_bind_parameter_name()
drhbec451f2009-10-17 13:13:02 +0000703 ** API. To workaround them, add a dummy OP_Variable here.
704 */
705 int r1 = sqlite3GetTempReg(pParse);
706 sqlite3ExprCodeTarget(pParse, pRight, r1);
dan937d0de2009-10-15 18:35:38 +0000707 sqlite3VdbeChangeP3(v, sqlite3VdbeCurrentAddr(v)-1, 0);
drhbec451f2009-10-17 13:13:02 +0000708 sqlite3ReleaseTempReg(pParse, r1);
dan937d0de2009-10-15 18:35:38 +0000709 }
710 }
711 }else{
712 z = 0;
shane85095702009-06-15 16:27:08 +0000713 }
drhf998b732007-11-26 13:36:00 +0000714 }
dan937d0de2009-10-15 18:35:38 +0000715
716 sqlite3ValueFree(pVal);
717 return (z!=0);
drhd2687b72005-08-12 22:56:09 +0000718}
719#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
720
drhedb193b2006-06-27 13:20:21 +0000721
722#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000723/*
drh7f375902006-06-13 17:38:59 +0000724** Check to see if the given expression is of the form
725**
726** column MATCH expr
727**
728** If it is then return TRUE. If not, return FALSE.
729*/
730static int isMatchOfColumn(
731 Expr *pExpr /* Test this expression */
732){
733 ExprList *pList;
734
735 if( pExpr->op!=TK_FUNCTION ){
736 return 0;
737 }
drh33e619f2009-05-28 01:00:55 +0000738 if( sqlite3StrICmp(pExpr->u.zToken,"match")!=0 ){
drh7f375902006-06-13 17:38:59 +0000739 return 0;
740 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000741 pList = pExpr->x.pList;
drh7f375902006-06-13 17:38:59 +0000742 if( pList->nExpr!=2 ){
743 return 0;
744 }
745 if( pList->a[1].pExpr->op != TK_COLUMN ){
746 return 0;
747 }
748 return 1;
749}
drhedb193b2006-06-27 13:20:21 +0000750#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000751
752/*
drh54a167d2005-11-26 14:08:07 +0000753** If the pBase expression originated in the ON or USING clause of
754** a join, then transfer the appropriate markings over to derived.
755*/
756static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
drhd41d39f2013-08-28 16:27:01 +0000757 if( pDerived ){
758 pDerived->flags |= pBase->flags & EP_FromJoin;
759 pDerived->iRightJoinTable = pBase->iRightJoinTable;
760 }
drh54a167d2005-11-26 14:08:07 +0000761}
762
drh3e355802007-02-23 23:13:33 +0000763#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
764/*
drh1a58fe02008-12-20 02:06:13 +0000765** Analyze a term that consists of two or more OR-connected
766** subterms. So in:
drh3e355802007-02-23 23:13:33 +0000767**
drh1a58fe02008-12-20 02:06:13 +0000768** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
769** ^^^^^^^^^^^^^^^^^^^^
drh3e355802007-02-23 23:13:33 +0000770**
drh1a58fe02008-12-20 02:06:13 +0000771** This routine analyzes terms such as the middle term in the above example.
772** A WhereOrTerm object is computed and attached to the term under
773** analysis, regardless of the outcome of the analysis. Hence:
drh3e355802007-02-23 23:13:33 +0000774**
drh1a58fe02008-12-20 02:06:13 +0000775** WhereTerm.wtFlags |= TERM_ORINFO
776** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
drh3e355802007-02-23 23:13:33 +0000777**
drh1a58fe02008-12-20 02:06:13 +0000778** The term being analyzed must have two or more of OR-connected subterms.
danielk1977fdc40192008-12-29 18:33:32 +0000779** A single subterm might be a set of AND-connected sub-subterms.
drh1a58fe02008-12-20 02:06:13 +0000780** Examples of terms under analysis:
drh3e355802007-02-23 23:13:33 +0000781**
drh1a58fe02008-12-20 02:06:13 +0000782** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
783** (B) x=expr1 OR expr2=x OR x=expr3
784** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
785** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
786** (E) (p.a=1 AND q.b=2 AND r.c=3) OR (p.x=4 AND q.y=5 AND r.z=6)
drh3e355802007-02-23 23:13:33 +0000787**
drh1a58fe02008-12-20 02:06:13 +0000788** CASE 1:
789**
drhc3e552f2013-02-08 16:04:19 +0000790** If all subterms are of the form T.C=expr for some single column of C and
drh1a58fe02008-12-20 02:06:13 +0000791** a single table T (as shown in example B above) then create a new virtual
792** term that is an equivalent IN expression. In other words, if the term
793** being analyzed is:
794**
795** x = expr1 OR expr2 = x OR x = expr3
796**
797** then create a new virtual term like this:
798**
799** x IN (expr1,expr2,expr3)
800**
801** CASE 2:
802**
803** If all subterms are indexable by a single table T, then set
804**
805** WhereTerm.eOperator = WO_OR
806** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
807**
808** A subterm is "indexable" if it is of the form
809** "T.C <op> <expr>" where C is any column of table T and
810** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
811** A subterm is also indexable if it is an AND of two or more
812** subsubterms at least one of which is indexable. Indexable AND
813** subterms have their eOperator set to WO_AND and they have
814** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
815**
816** From another point of view, "indexable" means that the subterm could
817** potentially be used with an index if an appropriate index exists.
818** This analysis does not consider whether or not the index exists; that
drh4a6fc352013-08-07 01:18:38 +0000819** is decided elsewhere. This analysis only looks at whether subterms
820** appropriate for indexing exist.
drh1a58fe02008-12-20 02:06:13 +0000821**
drh4a6fc352013-08-07 01:18:38 +0000822** All examples A through E above satisfy case 2. But if a term
drh1a58fe02008-12-20 02:06:13 +0000823** also statisfies case 1 (such as B) we know that the optimizer will
824** always prefer case 1, so in that case we pretend that case 2 is not
825** satisfied.
826**
827** It might be the case that multiple tables are indexable. For example,
828** (E) above is indexable on tables P, Q, and R.
829**
830** Terms that satisfy case 2 are candidates for lookup by using
831** separate indices to find rowids for each subterm and composing
832** the union of all rowids using a RowSet object. This is similar
833** to "bitmap indices" in other database engines.
834**
835** OTHERWISE:
836**
837** If neither case 1 nor case 2 apply, then leave the eOperator set to
838** zero. This term is not useful for search.
drh3e355802007-02-23 23:13:33 +0000839*/
drh1a58fe02008-12-20 02:06:13 +0000840static void exprAnalyzeOrTerm(
841 SrcList *pSrc, /* the FROM clause */
842 WhereClause *pWC, /* the complete WHERE clause */
843 int idxTerm /* Index of the OR-term to be analyzed */
844){
drh70d18342013-06-06 19:16:33 +0000845 WhereInfo *pWInfo = pWC->pWInfo; /* WHERE clause processing context */
846 Parse *pParse = pWInfo->pParse; /* Parser context */
drh1a58fe02008-12-20 02:06:13 +0000847 sqlite3 *db = pParse->db; /* Database connection */
848 WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
849 Expr *pExpr = pTerm->pExpr; /* The expression of the term */
drh1a58fe02008-12-20 02:06:13 +0000850 int i; /* Loop counters */
851 WhereClause *pOrWc; /* Breakup of pTerm into subterms */
852 WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
853 WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
854 Bitmask chngToIN; /* Tables that might satisfy case 1 */
855 Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
drh3e355802007-02-23 23:13:33 +0000856
drh1a58fe02008-12-20 02:06:13 +0000857 /*
858 ** Break the OR clause into its separate subterms. The subterms are
859 ** stored in a WhereClause structure containing within the WhereOrInfo
860 ** object that is attached to the original OR clause term.
861 */
862 assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
863 assert( pExpr->op==TK_OR );
drh954701a2008-12-29 23:45:07 +0000864 pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
drh1a58fe02008-12-20 02:06:13 +0000865 if( pOrInfo==0 ) return;
866 pTerm->wtFlags |= TERM_ORINFO;
867 pOrWc = &pOrInfo->wc;
drh70d18342013-06-06 19:16:33 +0000868 whereClauseInit(pOrWc, pWInfo);
drh1a58fe02008-12-20 02:06:13 +0000869 whereSplit(pOrWc, pExpr, TK_OR);
870 exprAnalyzeAll(pSrc, pOrWc);
871 if( db->mallocFailed ) return;
872 assert( pOrWc->nTerm>=2 );
873
874 /*
875 ** Compute the set of tables that might satisfy cases 1 or 2.
876 */
danielk1977e672c8e2009-05-22 15:43:26 +0000877 indexable = ~(Bitmask)0;
drhc3e552f2013-02-08 16:04:19 +0000878 chngToIN = ~(Bitmask)0;
drh1a58fe02008-12-20 02:06:13 +0000879 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
880 if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
drh29435252008-12-28 18:35:08 +0000881 WhereAndInfo *pAndInfo;
drh29435252008-12-28 18:35:08 +0000882 assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
drh1a58fe02008-12-20 02:06:13 +0000883 chngToIN = 0;
drh29435252008-12-28 18:35:08 +0000884 pAndInfo = sqlite3DbMallocRaw(db, sizeof(*pAndInfo));
885 if( pAndInfo ){
886 WhereClause *pAndWC;
887 WhereTerm *pAndTerm;
888 int j;
889 Bitmask b = 0;
890 pOrTerm->u.pAndInfo = pAndInfo;
891 pOrTerm->wtFlags |= TERM_ANDINFO;
892 pOrTerm->eOperator = WO_AND;
893 pAndWC = &pAndInfo->wc;
drh70d18342013-06-06 19:16:33 +0000894 whereClauseInit(pAndWC, pWC->pWInfo);
drh29435252008-12-28 18:35:08 +0000895 whereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
896 exprAnalyzeAll(pSrc, pAndWC);
drh8871ef52011-10-07 13:33:10 +0000897 pAndWC->pOuter = pWC;
drh7c2fbde2009-01-07 20:58:57 +0000898 testcase( db->mallocFailed );
drh96c7a7d2009-01-10 15:34:12 +0000899 if( !db->mallocFailed ){
900 for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
901 assert( pAndTerm->pExpr );
902 if( allowedOp(pAndTerm->pExpr->op) ){
drh70d18342013-06-06 19:16:33 +0000903 b |= getMask(&pWInfo->sMaskSet, pAndTerm->leftCursor);
drh96c7a7d2009-01-10 15:34:12 +0000904 }
drh29435252008-12-28 18:35:08 +0000905 }
906 }
907 indexable &= b;
908 }
drh1a58fe02008-12-20 02:06:13 +0000909 }else if( pOrTerm->wtFlags & TERM_COPIED ){
910 /* Skip this term for now. We revisit it when we process the
911 ** corresponding TERM_VIRTUAL term */
912 }else{
913 Bitmask b;
drh70d18342013-06-06 19:16:33 +0000914 b = getMask(&pWInfo->sMaskSet, pOrTerm->leftCursor);
drh1a58fe02008-12-20 02:06:13 +0000915 if( pOrTerm->wtFlags & TERM_VIRTUAL ){
916 WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
drh70d18342013-06-06 19:16:33 +0000917 b |= getMask(&pWInfo->sMaskSet, pOther->leftCursor);
drh1a58fe02008-12-20 02:06:13 +0000918 }
919 indexable &= b;
drh7a5bcc02013-01-16 17:08:58 +0000920 if( (pOrTerm->eOperator & WO_EQ)==0 ){
drh1a58fe02008-12-20 02:06:13 +0000921 chngToIN = 0;
922 }else{
923 chngToIN &= b;
924 }
925 }
drh3e355802007-02-23 23:13:33 +0000926 }
drh1a58fe02008-12-20 02:06:13 +0000927
928 /*
929 ** Record the set of tables that satisfy case 2. The set might be
drh111a6a72008-12-21 03:51:16 +0000930 ** empty.
drh1a58fe02008-12-20 02:06:13 +0000931 */
932 pOrInfo->indexable = indexable;
drh111a6a72008-12-21 03:51:16 +0000933 pTerm->eOperator = indexable==0 ? 0 : WO_OR;
drh1a58fe02008-12-20 02:06:13 +0000934
935 /*
936 ** chngToIN holds a set of tables that *might* satisfy case 1. But
937 ** we have to do some additional checking to see if case 1 really
938 ** is satisfied.
drh4e8be3b2009-06-08 17:11:08 +0000939 **
940 ** chngToIN will hold either 0, 1, or 2 bits. The 0-bit case means
941 ** that there is no possibility of transforming the OR clause into an
942 ** IN operator because one or more terms in the OR clause contain
943 ** something other than == on a column in the single table. The 1-bit
944 ** case means that every term of the OR clause is of the form
945 ** "table.column=expr" for some single table. The one bit that is set
946 ** will correspond to the common table. We still need to check to make
947 ** sure the same column is used on all terms. The 2-bit case is when
948 ** the all terms are of the form "table1.column=table2.column". It
949 ** might be possible to form an IN operator with either table1.column
950 ** or table2.column as the LHS if either is common to every term of
951 ** the OR clause.
952 **
953 ** Note that terms of the form "table.column1=table.column2" (the
954 ** same table on both sizes of the ==) cannot be optimized.
drh1a58fe02008-12-20 02:06:13 +0000955 */
956 if( chngToIN ){
957 int okToChngToIN = 0; /* True if the conversion to IN is valid */
958 int iColumn = -1; /* Column index on lhs of IN operator */
shane63207ab2009-02-04 01:49:30 +0000959 int iCursor = -1; /* Table cursor common to all terms */
drh1a58fe02008-12-20 02:06:13 +0000960 int j = 0; /* Loop counter */
961
962 /* Search for a table and column that appears on one side or the
963 ** other of the == operator in every subterm. That table and column
964 ** will be recorded in iCursor and iColumn. There might not be any
965 ** such table and column. Set okToChngToIN if an appropriate table
966 ** and column is found but leave okToChngToIN false if not found.
967 */
968 for(j=0; j<2 && !okToChngToIN; j++){
969 pOrTerm = pOrWc->a;
970 for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
drh7a5bcc02013-01-16 17:08:58 +0000971 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +0000972 pOrTerm->wtFlags &= ~TERM_OR_OK;
drh4e8be3b2009-06-08 17:11:08 +0000973 if( pOrTerm->leftCursor==iCursor ){
974 /* This is the 2-bit case and we are on the second iteration and
975 ** current term is from the first iteration. So skip this term. */
976 assert( j==1 );
977 continue;
978 }
drh70d18342013-06-06 19:16:33 +0000979 if( (chngToIN & getMask(&pWInfo->sMaskSet, pOrTerm->leftCursor))==0 ){
drh4e8be3b2009-06-08 17:11:08 +0000980 /* This term must be of the form t1.a==t2.b where t2 is in the
981 ** chngToIN set but t1 is not. This term will be either preceeded
982 ** or follwed by an inverted copy (t2.b==t1.a). Skip this term
983 ** and use its inversion. */
984 testcase( pOrTerm->wtFlags & TERM_COPIED );
985 testcase( pOrTerm->wtFlags & TERM_VIRTUAL );
986 assert( pOrTerm->wtFlags & (TERM_COPIED|TERM_VIRTUAL) );
987 continue;
988 }
drh1a58fe02008-12-20 02:06:13 +0000989 iColumn = pOrTerm->u.leftColumn;
990 iCursor = pOrTerm->leftCursor;
991 break;
992 }
993 if( i<0 ){
drh4e8be3b2009-06-08 17:11:08 +0000994 /* No candidate table+column was found. This can only occur
995 ** on the second iteration */
drh1a58fe02008-12-20 02:06:13 +0000996 assert( j==1 );
drh7a5bcc02013-01-16 17:08:58 +0000997 assert( IsPowerOfTwo(chngToIN) );
drh70d18342013-06-06 19:16:33 +0000998 assert( chngToIN==getMask(&pWInfo->sMaskSet, iCursor) );
drh1a58fe02008-12-20 02:06:13 +0000999 break;
1000 }
drh4e8be3b2009-06-08 17:11:08 +00001001 testcase( j==1 );
1002
1003 /* We have found a candidate table and column. Check to see if that
1004 ** table and column is common to every term in the OR clause */
drh1a58fe02008-12-20 02:06:13 +00001005 okToChngToIN = 1;
1006 for(; i>=0 && okToChngToIN; i--, pOrTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001007 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001008 if( pOrTerm->leftCursor!=iCursor ){
1009 pOrTerm->wtFlags &= ~TERM_OR_OK;
1010 }else if( pOrTerm->u.leftColumn!=iColumn ){
1011 okToChngToIN = 0;
1012 }else{
1013 int affLeft, affRight;
1014 /* If the right-hand side is also a column, then the affinities
1015 ** of both right and left sides must be such that no type
1016 ** conversions are required on the right. (Ticket #2249)
1017 */
1018 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
1019 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
1020 if( affRight!=0 && affRight!=affLeft ){
1021 okToChngToIN = 0;
1022 }else{
1023 pOrTerm->wtFlags |= TERM_OR_OK;
1024 }
1025 }
1026 }
1027 }
1028
1029 /* At this point, okToChngToIN is true if original pTerm satisfies
1030 ** case 1. In that case, construct a new virtual term that is
1031 ** pTerm converted into an IN operator.
1032 */
1033 if( okToChngToIN ){
1034 Expr *pDup; /* A transient duplicate expression */
1035 ExprList *pList = 0; /* The RHS of the IN operator */
1036 Expr *pLeft = 0; /* The LHS of the IN operator */
1037 Expr *pNew; /* The complete IN operator */
1038
1039 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
1040 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
drh7a5bcc02013-01-16 17:08:58 +00001041 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001042 assert( pOrTerm->leftCursor==iCursor );
1043 assert( pOrTerm->u.leftColumn==iColumn );
danielk19776ab3a2e2009-02-19 14:39:25 +00001044 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight, 0);
drh70d18342013-06-06 19:16:33 +00001045 pList = sqlite3ExprListAppend(pWInfo->pParse, pList, pDup);
drh1a58fe02008-12-20 02:06:13 +00001046 pLeft = pOrTerm->pExpr->pLeft;
1047 }
1048 assert( pLeft!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001049 pDup = sqlite3ExprDup(db, pLeft, 0);
drhb7916a72009-05-27 10:31:29 +00001050 pNew = sqlite3PExpr(pParse, TK_IN, pDup, 0, 0);
drh1a58fe02008-12-20 02:06:13 +00001051 if( pNew ){
1052 int idxNew;
1053 transferJoinMarkings(pNew, pExpr);
danielk19776ab3a2e2009-02-19 14:39:25 +00001054 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
1055 pNew->x.pList = pList;
drh1a58fe02008-12-20 02:06:13 +00001056 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
1057 testcase( idxNew==0 );
1058 exprAnalyze(pSrc, pWC, idxNew);
1059 pTerm = &pWC->a[idxTerm];
1060 pWC->a[idxNew].iParent = idxTerm;
1061 pTerm->nChild = 1;
1062 }else{
1063 sqlite3ExprListDelete(db, pList);
1064 }
drh534230c2011-01-22 00:10:45 +00001065 pTerm->eOperator = WO_NOOP; /* case 1 trumps case 2 */
drh1a58fe02008-12-20 02:06:13 +00001066 }
drh3e355802007-02-23 23:13:33 +00001067 }
drh3e355802007-02-23 23:13:33 +00001068}
1069#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +00001070
drh7a5bcc02013-01-16 17:08:58 +00001071/*
drh0aa74ed2005-07-16 13:33:20 +00001072** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +00001073** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +00001074** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +00001075** structure.
drh51147ba2005-07-23 22:59:55 +00001076**
1077** If the expression is of the form "<expr> <op> X" it gets commuted
drh1a58fe02008-12-20 02:06:13 +00001078** to the standard form of "X <op> <expr>".
1079**
1080** If the expression is of the form "X <op> Y" where both X and Y are
1081** columns, then the original expression is unchanged and a new virtual
1082** term of the form "Y <op> X" is added to the WHERE clause and
1083** analyzed separately. The original term is marked with TERM_COPIED
1084** and the new term is marked with TERM_DYNAMIC (because it's pExpr
1085** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
1086** is a commuted copy of a prior term.) The original term has nChild=1
1087** and the copy has idxParent set to the index of the original term.
drh75897232000-05-29 14:26:00 +00001088*/
drh0fcef5e2005-07-19 17:38:22 +00001089static void exprAnalyze(
1090 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +00001091 WhereClause *pWC, /* the WHERE clause */
1092 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +00001093){
drh70d18342013-06-06 19:16:33 +00001094 WhereInfo *pWInfo = pWC->pWInfo; /* WHERE clause processing context */
drh1a58fe02008-12-20 02:06:13 +00001095 WhereTerm *pTerm; /* The term to be analyzed */
drh111a6a72008-12-21 03:51:16 +00001096 WhereMaskSet *pMaskSet; /* Set of table index masks */
drh1a58fe02008-12-20 02:06:13 +00001097 Expr *pExpr; /* The expression to be analyzed */
1098 Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
1099 Bitmask prereqAll; /* Prerequesites of pExpr */
drh5e767c52010-02-25 04:15:47 +00001100 Bitmask extraRight = 0; /* Extra dependencies on LEFT JOIN */
drh1d452e12009-11-01 19:26:59 +00001101 Expr *pStr1 = 0; /* RHS of LIKE/GLOB operator */
1102 int isComplete = 0; /* RHS of LIKE/GLOB ends with wildcard */
1103 int noCase = 0; /* LIKE/GLOB distinguishes case */
drh1a58fe02008-12-20 02:06:13 +00001104 int op; /* Top-level operator. pExpr->op */
drh70d18342013-06-06 19:16:33 +00001105 Parse *pParse = pWInfo->pParse; /* Parsing context */
drh1a58fe02008-12-20 02:06:13 +00001106 sqlite3 *db = pParse->db; /* Database connection */
drh0fcef5e2005-07-19 17:38:22 +00001107
drhf998b732007-11-26 13:36:00 +00001108 if( db->mallocFailed ){
1109 return;
1110 }
1111 pTerm = &pWC->a[idxTerm];
drh70d18342013-06-06 19:16:33 +00001112 pMaskSet = &pWInfo->sMaskSet;
drh7ee751d2012-12-19 15:53:51 +00001113 pExpr = pTerm->pExpr;
1114 assert( pExpr->op!=TK_AS && pExpr->op!=TK_COLLATE );
drh0fcef5e2005-07-19 17:38:22 +00001115 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +00001116 op = pExpr->op;
1117 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +00001118 assert( pExpr->pRight==0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001119 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1120 pTerm->prereqRight = exprSelectTableUsage(pMaskSet, pExpr->x.pSelect);
1121 }else{
1122 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->x.pList);
1123 }
drh50b39962006-10-28 00:28:09 +00001124 }else if( op==TK_ISNULL ){
1125 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +00001126 }else{
1127 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
1128 }
drh22d6a532005-09-19 21:05:48 +00001129 prereqAll = exprTableUsage(pMaskSet, pExpr);
1130 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +00001131 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
1132 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +00001133 extraRight = x-1; /* ON clause terms may not be used with an index
1134 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +00001135 }
1136 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +00001137 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +00001138 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +00001139 pTerm->eOperator = 0;
drh738fc792013-01-17 15:05:17 +00001140 if( allowedOp(op) ){
drh7a66da12012-12-07 20:31:11 +00001141 Expr *pLeft = sqlite3ExprSkipCollate(pExpr->pLeft);
1142 Expr *pRight = sqlite3ExprSkipCollate(pExpr->pRight);
drh738fc792013-01-17 15:05:17 +00001143 u16 opMask = (pTerm->prereqRight & prereqLeft)==0 ? WO_ALL : WO_EQUIV;
drh0fcef5e2005-07-19 17:38:22 +00001144 if( pLeft->op==TK_COLUMN ){
1145 pTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001146 pTerm->u.leftColumn = pLeft->iColumn;
drh738fc792013-01-17 15:05:17 +00001147 pTerm->eOperator = operatorMask(op) & opMask;
drh75897232000-05-29 14:26:00 +00001148 }
drh0fcef5e2005-07-19 17:38:22 +00001149 if( pRight && pRight->op==TK_COLUMN ){
1150 WhereTerm *pNew;
1151 Expr *pDup;
drh7a5bcc02013-01-16 17:08:58 +00001152 u16 eExtraOp = 0; /* Extra bits for pNew->eOperator */
drh0fcef5e2005-07-19 17:38:22 +00001153 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +00001154 int idxNew;
danielk19776ab3a2e2009-02-19 14:39:25 +00001155 pDup = sqlite3ExprDup(db, pExpr, 0);
drh17435752007-08-16 04:30:38 +00001156 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +00001157 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +00001158 return;
1159 }
drh9eb20282005-08-24 03:52:18 +00001160 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
1161 if( idxNew==0 ) return;
1162 pNew = &pWC->a[idxNew];
1163 pNew->iParent = idxTerm;
1164 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +00001165 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001166 pTerm->wtFlags |= TERM_COPIED;
drheb5bc922013-01-17 16:43:33 +00001167 if( pExpr->op==TK_EQ
1168 && !ExprHasProperty(pExpr, EP_FromJoin)
1169 && OptimizationEnabled(db, SQLITE_Transitive)
1170 ){
drh7a5bcc02013-01-16 17:08:58 +00001171 pTerm->eOperator |= WO_EQUIV;
1172 eExtraOp = WO_EQUIV;
1173 }
drh0fcef5e2005-07-19 17:38:22 +00001174 }else{
1175 pDup = pExpr;
1176 pNew = pTerm;
1177 }
drh7d10d5a2008-08-20 16:35:10 +00001178 exprCommute(pParse, pDup);
drhfb76f5a2012-12-08 14:16:47 +00001179 pLeft = sqlite3ExprSkipCollate(pDup->pLeft);
drh0fcef5e2005-07-19 17:38:22 +00001180 pNew->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001181 pNew->u.leftColumn = pLeft->iColumn;
drh5e767c52010-02-25 04:15:47 +00001182 testcase( (prereqLeft | extraRight) != prereqLeft );
1183 pNew->prereqRight = prereqLeft | extraRight;
drh0fcef5e2005-07-19 17:38:22 +00001184 pNew->prereqAll = prereqAll;
drh738fc792013-01-17 15:05:17 +00001185 pNew->eOperator = (operatorMask(pDup->op) + eExtraOp) & opMask;
drh75897232000-05-29 14:26:00 +00001186 }
1187 }
drhed378002005-07-28 23:12:08 +00001188
drhd2687b72005-08-12 22:56:09 +00001189#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +00001190 /* If a term is the BETWEEN operator, create two new virtual terms
drh1a58fe02008-12-20 02:06:13 +00001191 ** that define the range that the BETWEEN implements. For example:
1192 **
1193 ** a BETWEEN b AND c
1194 **
1195 ** is converted into:
1196 **
1197 ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
1198 **
1199 ** The two new terms are added onto the end of the WhereClause object.
1200 ** The new terms are "dynamic" and are children of the original BETWEEN
1201 ** term. That means that if the BETWEEN term is coded, the children are
1202 ** skipped. Or, if the children are satisfied by an index, the original
1203 ** BETWEEN term is skipped.
drhed378002005-07-28 23:12:08 +00001204 */
drh29435252008-12-28 18:35:08 +00001205 else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001206 ExprList *pList = pExpr->x.pList;
drhed378002005-07-28 23:12:08 +00001207 int i;
1208 static const u8 ops[] = {TK_GE, TK_LE};
1209 assert( pList!=0 );
1210 assert( pList->nExpr==2 );
1211 for(i=0; i<2; i++){
1212 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +00001213 int idxNew;
drhb7916a72009-05-27 10:31:29 +00001214 pNewExpr = sqlite3PExpr(pParse, ops[i],
1215 sqlite3ExprDup(db, pExpr->pLeft, 0),
danielk19776ab3a2e2009-02-19 14:39:25 +00001216 sqlite3ExprDup(db, pList->a[i].pExpr, 0), 0);
drhd41d39f2013-08-28 16:27:01 +00001217 transferJoinMarkings(pNewExpr, pExpr);
drh9eb20282005-08-24 03:52:18 +00001218 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001219 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001220 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +00001221 pTerm = &pWC->a[idxTerm];
1222 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +00001223 }
drh45b1ee42005-08-02 17:48:22 +00001224 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +00001225 }
drhd2687b72005-08-12 22:56:09 +00001226#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +00001227
danielk19771576cd92006-01-14 08:02:28 +00001228#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh1a58fe02008-12-20 02:06:13 +00001229 /* Analyze a term that is composed of two or more subterms connected by
1230 ** an OR operator.
drh6c30be82005-07-29 15:10:17 +00001231 */
1232 else if( pExpr->op==TK_OR ){
drh29435252008-12-28 18:35:08 +00001233 assert( pWC->op==TK_AND );
drh1a58fe02008-12-20 02:06:13 +00001234 exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
danielk1977f51d1bd2009-07-31 06:14:51 +00001235 pTerm = &pWC->a[idxTerm];
drh6c30be82005-07-29 15:10:17 +00001236 }
drhd2687b72005-08-12 22:56:09 +00001237#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1238
1239#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
1240 /* Add constraints to reduce the search space on a LIKE or GLOB
1241 ** operator.
drh9f504ea2008-02-23 21:55:39 +00001242 **
1243 ** A like pattern of the form "x LIKE 'abc%'" is changed into constraints
1244 **
1245 ** x>='abc' AND x<'abd' AND x LIKE 'abc%'
1246 **
1247 ** The last character of the prefix "abc" is incremented to form the
shane7bc71e52008-05-28 18:01:44 +00001248 ** termination condition "abd".
drhd2687b72005-08-12 22:56:09 +00001249 */
dan937d0de2009-10-15 18:35:38 +00001250 if( pWC->op==TK_AND
1251 && isLikeOrGlob(pParse, pExpr, &pStr1, &isComplete, &noCase)
1252 ){
drh1d452e12009-11-01 19:26:59 +00001253 Expr *pLeft; /* LHS of LIKE/GLOB operator */
1254 Expr *pStr2; /* Copy of pStr1 - RHS of LIKE/GLOB operator */
1255 Expr *pNewExpr1;
1256 Expr *pNewExpr2;
1257 int idxNew1;
1258 int idxNew2;
drhae80dde2012-12-06 21:16:43 +00001259 Token sCollSeqName; /* Name of collating sequence */
drh9eb20282005-08-24 03:52:18 +00001260
danielk19776ab3a2e2009-02-19 14:39:25 +00001261 pLeft = pExpr->x.pList->a[1].pExpr;
danielk19776ab3a2e2009-02-19 14:39:25 +00001262 pStr2 = sqlite3ExprDup(db, pStr1, 0);
drhf998b732007-11-26 13:36:00 +00001263 if( !db->mallocFailed ){
drh254993e2009-06-08 19:44:36 +00001264 u8 c, *pC; /* Last character before the first wildcard */
dan937d0de2009-10-15 18:35:38 +00001265 pC = (u8*)&pStr2->u.zToken[sqlite3Strlen30(pStr2->u.zToken)-1];
drh9f504ea2008-02-23 21:55:39 +00001266 c = *pC;
drh02a50b72008-05-26 18:33:40 +00001267 if( noCase ){
drh254993e2009-06-08 19:44:36 +00001268 /* The point is to increment the last character before the first
1269 ** wildcard. But if we increment '@', that will push it into the
1270 ** alphabetic range where case conversions will mess up the
1271 ** inequality. To avoid this, make sure to also run the full
1272 ** LIKE on all candidate expressions by clearing the isComplete flag
1273 */
drh39759742013-08-02 23:40:45 +00001274 if( c=='A'-1 ) isComplete = 0;
drh02a50b72008-05-26 18:33:40 +00001275 c = sqlite3UpperToLower[c];
1276 }
drh9f504ea2008-02-23 21:55:39 +00001277 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +00001278 }
drhae80dde2012-12-06 21:16:43 +00001279 sCollSeqName.z = noCase ? "NOCASE" : "BINARY";
1280 sCollSeqName.n = 6;
1281 pNewExpr1 = sqlite3ExprDup(db, pLeft, 0);
drh8342e492010-07-22 17:49:52 +00001282 pNewExpr1 = sqlite3PExpr(pParse, TK_GE,
drh0a8a4062012-12-07 18:38:16 +00001283 sqlite3ExprAddCollateToken(pParse,pNewExpr1,&sCollSeqName),
drhae80dde2012-12-06 21:16:43 +00001284 pStr1, 0);
drhd41d39f2013-08-28 16:27:01 +00001285 transferJoinMarkings(pNewExpr1, pExpr);
drh9eb20282005-08-24 03:52:18 +00001286 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001287 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001288 exprAnalyze(pSrc, pWC, idxNew1);
drhae80dde2012-12-06 21:16:43 +00001289 pNewExpr2 = sqlite3ExprDup(db, pLeft, 0);
drh8342e492010-07-22 17:49:52 +00001290 pNewExpr2 = sqlite3PExpr(pParse, TK_LT,
drh0a8a4062012-12-07 18:38:16 +00001291 sqlite3ExprAddCollateToken(pParse,pNewExpr2,&sCollSeqName),
drhae80dde2012-12-06 21:16:43 +00001292 pStr2, 0);
drhd41d39f2013-08-28 16:27:01 +00001293 transferJoinMarkings(pNewExpr2, pExpr);
drh9eb20282005-08-24 03:52:18 +00001294 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001295 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001296 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +00001297 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +00001298 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +00001299 pWC->a[idxNew1].iParent = idxTerm;
1300 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +00001301 pTerm->nChild = 2;
1302 }
1303 }
1304#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +00001305
1306#ifndef SQLITE_OMIT_VIRTUALTABLE
1307 /* Add a WO_MATCH auxiliary term to the constraint set if the
1308 ** current expression is of the form: column MATCH expr.
1309 ** This information is used by the xBestIndex methods of
1310 ** virtual tables. The native query optimizer does not attempt
1311 ** to do anything with MATCH functions.
1312 */
1313 if( isMatchOfColumn(pExpr) ){
1314 int idxNew;
1315 Expr *pRight, *pLeft;
1316 WhereTerm *pNewTerm;
1317 Bitmask prereqColumn, prereqExpr;
1318
danielk19776ab3a2e2009-02-19 14:39:25 +00001319 pRight = pExpr->x.pList->a[0].pExpr;
1320 pLeft = pExpr->x.pList->a[1].pExpr;
drh7f375902006-06-13 17:38:59 +00001321 prereqExpr = exprTableUsage(pMaskSet, pRight);
1322 prereqColumn = exprTableUsage(pMaskSet, pLeft);
1323 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +00001324 Expr *pNewExpr;
drhb7916a72009-05-27 10:31:29 +00001325 pNewExpr = sqlite3PExpr(pParse, TK_MATCH,
1326 0, sqlite3ExprDup(db, pRight, 0), 0);
drh1a90e092006-06-14 22:07:10 +00001327 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001328 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001329 pNewTerm = &pWC->a[idxNew];
1330 pNewTerm->prereqRight = prereqExpr;
1331 pNewTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001332 pNewTerm->u.leftColumn = pLeft->iColumn;
drh7f375902006-06-13 17:38:59 +00001333 pNewTerm->eOperator = WO_MATCH;
1334 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +00001335 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +00001336 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001337 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001338 pNewTerm->prereqAll = pTerm->prereqAll;
1339 }
1340 }
1341#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001342
drh1435a9a2013-08-27 23:15:44 +00001343#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhd3ed7342011-09-21 00:09:41 +00001344 /* When sqlite_stat3 histogram data is available an operator of the
drh534230c2011-01-22 00:10:45 +00001345 ** form "x IS NOT NULL" can sometimes be evaluated more efficiently
1346 ** as "x>NULL" if x is not an INTEGER PRIMARY KEY. So construct a
1347 ** virtual term of that form.
1348 **
1349 ** Note that the virtual term must be tagged with TERM_VNULL. This
1350 ** TERM_VNULL tag will suppress the not-null check at the beginning
1351 ** of the loop. Without the TERM_VNULL flag, the not-null check at
1352 ** the start of the loop will prevent any results from being returned.
1353 */
drhea6dc442011-04-08 21:35:26 +00001354 if( pExpr->op==TK_NOTNULL
1355 && pExpr->pLeft->op==TK_COLUMN
1356 && pExpr->pLeft->iColumn>=0
drh40aa9362013-06-28 17:29:25 +00001357 && OptimizationEnabled(db, SQLITE_Stat3)
drhea6dc442011-04-08 21:35:26 +00001358 ){
drh534230c2011-01-22 00:10:45 +00001359 Expr *pNewExpr;
1360 Expr *pLeft = pExpr->pLeft;
1361 int idxNew;
1362 WhereTerm *pNewTerm;
1363
1364 pNewExpr = sqlite3PExpr(pParse, TK_GT,
1365 sqlite3ExprDup(db, pLeft, 0),
1366 sqlite3PExpr(pParse, TK_NULL, 0, 0, 0), 0);
1367
1368 idxNew = whereClauseInsert(pWC, pNewExpr,
1369 TERM_VIRTUAL|TERM_DYNAMIC|TERM_VNULL);
drhda91e712011-02-11 06:59:02 +00001370 if( idxNew ){
1371 pNewTerm = &pWC->a[idxNew];
1372 pNewTerm->prereqRight = 0;
1373 pNewTerm->leftCursor = pLeft->iTable;
1374 pNewTerm->u.leftColumn = pLeft->iColumn;
1375 pNewTerm->eOperator = WO_GT;
1376 pNewTerm->iParent = idxTerm;
1377 pTerm = &pWC->a[idxTerm];
1378 pTerm->nChild = 1;
1379 pTerm->wtFlags |= TERM_COPIED;
1380 pNewTerm->prereqAll = pTerm->prereqAll;
1381 }
drh534230c2011-01-22 00:10:45 +00001382 }
drh1435a9a2013-08-27 23:15:44 +00001383#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drh534230c2011-01-22 00:10:45 +00001384
drhdafc0ce2008-04-17 19:14:02 +00001385 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1386 ** an index for tables to the left of the join.
1387 */
1388 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001389}
1390
drh7b4fc6a2007-02-06 13:26:32 +00001391/*
drh3b48e8c2013-06-12 20:18:16 +00001392** This function searches pList for a entry that matches the iCol-th column
1393** of index pIdx.
dan6f343962011-07-01 18:26:40 +00001394**
1395** If such an expression is found, its index in pList->a[] is returned. If
1396** no expression is found, -1 is returned.
1397*/
1398static int findIndexCol(
1399 Parse *pParse, /* Parse context */
1400 ExprList *pList, /* Expression list to search */
1401 int iBase, /* Cursor for table associated with pIdx */
1402 Index *pIdx, /* Index to match column of */
1403 int iCol /* Column of index to match */
1404){
1405 int i;
1406 const char *zColl = pIdx->azColl[iCol];
1407
1408 for(i=0; i<pList->nExpr; i++){
drh580c8c12012-12-08 03:34:04 +00001409 Expr *p = sqlite3ExprSkipCollate(pList->a[i].pExpr);
drhf1d3e322011-07-09 13:00:41 +00001410 if( p->op==TK_COLUMN
1411 && p->iColumn==pIdx->aiColumn[iCol]
1412 && p->iTable==iBase
1413 ){
drh580c8c12012-12-08 03:34:04 +00001414 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pList->a[i].pExpr);
drhf1d3e322011-07-09 13:00:41 +00001415 if( ALWAYS(pColl) && 0==sqlite3StrICmp(pColl->zName, zColl) ){
dan6f343962011-07-01 18:26:40 +00001416 return i;
1417 }
1418 }
1419 }
1420
1421 return -1;
1422}
1423
1424/*
dan6f343962011-07-01 18:26:40 +00001425** Return true if the DISTINCT expression-list passed as the third argument
drh4f402f22013-06-11 18:59:38 +00001426** is redundant.
1427**
drh3b48e8c2013-06-12 20:18:16 +00001428** A DISTINCT list is redundant if the database contains some subset of
drh4f402f22013-06-11 18:59:38 +00001429** columns that are unique and non-null.
dan6f343962011-07-01 18:26:40 +00001430*/
1431static int isDistinctRedundant(
drh4f402f22013-06-11 18:59:38 +00001432 Parse *pParse, /* Parsing context */
1433 SrcList *pTabList, /* The FROM clause */
1434 WhereClause *pWC, /* The WHERE clause */
1435 ExprList *pDistinct /* The result set that needs to be DISTINCT */
dan6f343962011-07-01 18:26:40 +00001436){
1437 Table *pTab;
1438 Index *pIdx;
1439 int i;
1440 int iBase;
1441
1442 /* If there is more than one table or sub-select in the FROM clause of
1443 ** this query, then it will not be possible to show that the DISTINCT
1444 ** clause is redundant. */
1445 if( pTabList->nSrc!=1 ) return 0;
1446 iBase = pTabList->a[0].iCursor;
1447 pTab = pTabList->a[0].pTab;
1448
dan94e08d92011-07-02 06:44:05 +00001449 /* If any of the expressions is an IPK column on table iBase, then return
1450 ** true. Note: The (p->iTable==iBase) part of this test may be false if the
1451 ** current SELECT is a correlated sub-query.
1452 */
dan6f343962011-07-01 18:26:40 +00001453 for(i=0; i<pDistinct->nExpr; i++){
drh580c8c12012-12-08 03:34:04 +00001454 Expr *p = sqlite3ExprSkipCollate(pDistinct->a[i].pExpr);
dan94e08d92011-07-02 06:44:05 +00001455 if( p->op==TK_COLUMN && p->iTable==iBase && p->iColumn<0 ) return 1;
dan6f343962011-07-01 18:26:40 +00001456 }
1457
1458 /* Loop through all indices on the table, checking each to see if it makes
1459 ** the DISTINCT qualifier redundant. It does so if:
1460 **
1461 ** 1. The index is itself UNIQUE, and
1462 **
1463 ** 2. All of the columns in the index are either part of the pDistinct
1464 ** list, or else the WHERE clause contains a term of the form "col=X",
1465 ** where X is a constant value. The collation sequences of the
1466 ** comparison and select-list expressions must match those of the index.
dan6a36f432012-04-20 16:59:24 +00001467 **
1468 ** 3. All of those index columns for which the WHERE clause does not
1469 ** contain a "col=X" term are subject to a NOT NULL constraint.
dan6f343962011-07-01 18:26:40 +00001470 */
1471 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1472 if( pIdx->onError==OE_None ) continue;
drhbbbdc832013-10-22 18:01:40 +00001473 for(i=0; i<pIdx->nKeyCol; i++){
1474 i16 iCol = pIdx->aiColumn[i];
dan6a36f432012-04-20 16:59:24 +00001475 if( 0==findTerm(pWC, iBase, iCol, ~(Bitmask)0, WO_EQ, pIdx) ){
1476 int iIdxCol = findIndexCol(pParse, pDistinct, iBase, pIdx, i);
drhbbbdc832013-10-22 18:01:40 +00001477 if( iIdxCol<0 || pTab->aCol[iCol].notNull==0 ){
dan6a36f432012-04-20 16:59:24 +00001478 break;
1479 }
dan6f343962011-07-01 18:26:40 +00001480 }
1481 }
drhbbbdc832013-10-22 18:01:40 +00001482 if( i==pIdx->nKeyCol ){
dan6f343962011-07-01 18:26:40 +00001483 /* This index implies that the DISTINCT qualifier is redundant. */
1484 return 1;
1485 }
1486 }
1487
1488 return 0;
1489}
drh0fcef5e2005-07-19 17:38:22 +00001490
drh8636e9c2013-06-11 01:50:08 +00001491
drh75897232000-05-29 14:26:00 +00001492/*
drh3b48e8c2013-06-12 20:18:16 +00001493** Estimate the logarithm of the input value to base 2.
drh28c4cf42005-07-27 20:41:43 +00001494*/
drhbf539c42013-10-05 18:16:02 +00001495static LogEst estLog(LogEst N){
1496 LogEst x = sqlite3LogEst(N);
drh4fe425a2013-06-12 17:08:06 +00001497 return x>33 ? x - 33 : 0;
drh28c4cf42005-07-27 20:41:43 +00001498}
1499
drh6d209d82006-06-27 01:54:26 +00001500/*
1501** Two routines for printing the content of an sqlite3_index_info
1502** structure. Used for testing and debugging only. If neither
1503** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1504** are no-ops.
1505*/
drhd15cb172013-05-21 19:23:10 +00001506#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(WHERETRACE_ENABLED)
drh6d209d82006-06-27 01:54:26 +00001507static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1508 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001509 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001510 for(i=0; i<p->nConstraint; i++){
1511 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1512 i,
1513 p->aConstraint[i].iColumn,
1514 p->aConstraint[i].iTermOffset,
1515 p->aConstraint[i].op,
1516 p->aConstraint[i].usable);
1517 }
1518 for(i=0; i<p->nOrderBy; i++){
1519 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1520 i,
1521 p->aOrderBy[i].iColumn,
1522 p->aOrderBy[i].desc);
1523 }
1524}
1525static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1526 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001527 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001528 for(i=0; i<p->nConstraint; i++){
1529 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1530 i,
1531 p->aConstraintUsage[i].argvIndex,
1532 p->aConstraintUsage[i].omit);
1533 }
1534 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1535 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1536 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1537 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
dana9f58152013-11-11 19:01:33 +00001538 sqlite3DebugPrintf(" estimatedRows=%lld\n", p->estimatedRows);
drh6d209d82006-06-27 01:54:26 +00001539}
1540#else
1541#define TRACE_IDX_INPUTS(A)
1542#define TRACE_IDX_OUTPUTS(A)
1543#endif
1544
drhc6339082010-04-07 16:54:58 +00001545#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00001546/*
drh4139c992010-04-07 14:59:45 +00001547** Return TRUE if the WHERE clause term pTerm is of a form where it
1548** could be used with an index to access pSrc, assuming an appropriate
1549** index existed.
1550*/
1551static int termCanDriveIndex(
1552 WhereTerm *pTerm, /* WHERE clause term to check */
1553 struct SrcList_item *pSrc, /* Table we are trying to access */
1554 Bitmask notReady /* Tables in outer loops of the join */
1555){
1556 char aff;
1557 if( pTerm->leftCursor!=pSrc->iCursor ) return 0;
drh7a5bcc02013-01-16 17:08:58 +00001558 if( (pTerm->eOperator & WO_EQ)==0 ) return 0;
drh4139c992010-04-07 14:59:45 +00001559 if( (pTerm->prereqRight & notReady)!=0 ) return 0;
drh23f98da2013-05-21 15:52:07 +00001560 if( pTerm->u.leftColumn<0 ) return 0;
drh4139c992010-04-07 14:59:45 +00001561 aff = pSrc->pTab->aCol[pTerm->u.leftColumn].affinity;
1562 if( !sqlite3IndexAffinityOk(pTerm->pExpr, aff) ) return 0;
1563 return 1;
1564}
drhc6339082010-04-07 16:54:58 +00001565#endif
drh4139c992010-04-07 14:59:45 +00001566
drhc6339082010-04-07 16:54:58 +00001567
1568#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00001569/*
drhc6339082010-04-07 16:54:58 +00001570** Generate code to construct the Index object for an automatic index
1571** and to set up the WhereLevel object pLevel so that the code generator
1572** makes use of the automatic index.
drh8b307fb2010-04-06 15:57:05 +00001573*/
drhc6339082010-04-07 16:54:58 +00001574static void constructAutomaticIndex(
drh8b307fb2010-04-06 15:57:05 +00001575 Parse *pParse, /* The parsing context */
1576 WhereClause *pWC, /* The WHERE clause */
1577 struct SrcList_item *pSrc, /* The FROM clause term to get the next index */
1578 Bitmask notReady, /* Mask of cursors that are not available */
1579 WhereLevel *pLevel /* Write new index here */
1580){
drhbbbdc832013-10-22 18:01:40 +00001581 int nKeyCol; /* Number of columns in the constructed index */
drh8b307fb2010-04-06 15:57:05 +00001582 WhereTerm *pTerm; /* A single term of the WHERE clause */
1583 WhereTerm *pWCEnd; /* End of pWC->a[] */
drh8b307fb2010-04-06 15:57:05 +00001584 Index *pIdx; /* Object describing the transient index */
1585 Vdbe *v; /* Prepared statement under construction */
drh8b307fb2010-04-06 15:57:05 +00001586 int addrInit; /* Address of the initialization bypass jump */
1587 Table *pTable; /* The table being indexed */
drh8b307fb2010-04-06 15:57:05 +00001588 int addrTop; /* Top of the index fill loop */
1589 int regRecord; /* Register holding an index record */
1590 int n; /* Column counter */
drh4139c992010-04-07 14:59:45 +00001591 int i; /* Loop counter */
1592 int mxBitCol; /* Maximum column in pSrc->colUsed */
drh424aab82010-04-06 18:28:20 +00001593 CollSeq *pColl; /* Collating sequence to on a column */
drh7ba39a92013-05-30 17:43:19 +00001594 WhereLoop *pLoop; /* The Loop object */
drh77e57df2013-10-22 14:28:02 +00001595 char *zNotUsed; /* Extra space on the end of pIdx */
drh4139c992010-04-07 14:59:45 +00001596 Bitmask idxCols; /* Bitmap of columns used for indexing */
1597 Bitmask extraCols; /* Bitmap of additional columns */
drh8d56e202013-06-28 23:55:45 +00001598 u8 sentWarning = 0; /* True if a warnning has been issued */
drh8b307fb2010-04-06 15:57:05 +00001599
1600 /* Generate code to skip over the creation and initialization of the
1601 ** transient index on 2nd and subsequent iterations of the loop. */
1602 v = pParse->pVdbe;
1603 assert( v!=0 );
drh7d176102014-02-18 03:07:12 +00001604 addrInit = sqlite3CodeOnce(pParse); VdbeCoverage(v);
drh8b307fb2010-04-06 15:57:05 +00001605
drh4139c992010-04-07 14:59:45 +00001606 /* Count the number of columns that will be added to the index
1607 ** and used to match WHERE clause constraints */
drhbbbdc832013-10-22 18:01:40 +00001608 nKeyCol = 0;
drh424aab82010-04-06 18:28:20 +00001609 pTable = pSrc->pTab;
drh8b307fb2010-04-06 15:57:05 +00001610 pWCEnd = &pWC->a[pWC->nTerm];
drh7ba39a92013-05-30 17:43:19 +00001611 pLoop = pLevel->pWLoop;
drh4139c992010-04-07 14:59:45 +00001612 idxCols = 0;
drh81186b42013-06-18 01:52:41 +00001613 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00001614 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
1615 int iCol = pTerm->u.leftColumn;
drh7699d1c2013-06-04 12:42:29 +00001616 Bitmask cMask = iCol>=BMS ? MASKBIT(BMS-1) : MASKBIT(iCol);
drh52ff8ea2010-04-08 14:15:56 +00001617 testcase( iCol==BMS );
1618 testcase( iCol==BMS-1 );
drh8d56e202013-06-28 23:55:45 +00001619 if( !sentWarning ){
1620 sqlite3_log(SQLITE_WARNING_AUTOINDEX,
1621 "automatic index on %s(%s)", pTable->zName,
1622 pTable->aCol[iCol].zName);
1623 sentWarning = 1;
1624 }
drh0013e722010-04-08 00:40:15 +00001625 if( (idxCols & cMask)==0 ){
drhbbbdc832013-10-22 18:01:40 +00001626 if( whereLoopResize(pParse->db, pLoop, nKeyCol+1) ) return;
1627 pLoop->aLTerm[nKeyCol++] = pTerm;
drh0013e722010-04-08 00:40:15 +00001628 idxCols |= cMask;
1629 }
drh8b307fb2010-04-06 15:57:05 +00001630 }
1631 }
drhbbbdc832013-10-22 18:01:40 +00001632 assert( nKeyCol>0 );
1633 pLoop->u.btree.nEq = pLoop->nLTerm = nKeyCol;
drh53b52f72013-05-31 11:57:39 +00001634 pLoop->wsFlags = WHERE_COLUMN_EQ | WHERE_IDX_ONLY | WHERE_INDEXED
drh986b3872013-06-28 21:12:20 +00001635 | WHERE_AUTO_INDEX;
drh4139c992010-04-07 14:59:45 +00001636
1637 /* Count the number of additional columns needed to create a
1638 ** covering index. A "covering index" is an index that contains all
1639 ** columns that are needed by the query. With a covering index, the
1640 ** original table never needs to be accessed. Automatic indices must
1641 ** be a covering index because the index will not be updated if the
1642 ** original table changes and the index and table cannot both be used
1643 ** if they go out of sync.
1644 */
drh7699d1c2013-06-04 12:42:29 +00001645 extraCols = pSrc->colUsed & (~idxCols | MASKBIT(BMS-1));
drh4139c992010-04-07 14:59:45 +00001646 mxBitCol = (pTable->nCol >= BMS-1) ? BMS-1 : pTable->nCol;
drh52ff8ea2010-04-08 14:15:56 +00001647 testcase( pTable->nCol==BMS-1 );
1648 testcase( pTable->nCol==BMS-2 );
drh4139c992010-04-07 14:59:45 +00001649 for(i=0; i<mxBitCol; i++){
drhbbbdc832013-10-22 18:01:40 +00001650 if( extraCols & MASKBIT(i) ) nKeyCol++;
drh4139c992010-04-07 14:59:45 +00001651 }
drh7699d1c2013-06-04 12:42:29 +00001652 if( pSrc->colUsed & MASKBIT(BMS-1) ){
drhbbbdc832013-10-22 18:01:40 +00001653 nKeyCol += pTable->nCol - BMS + 1;
drh4139c992010-04-07 14:59:45 +00001654 }
drh7ba39a92013-05-30 17:43:19 +00001655 pLoop->wsFlags |= WHERE_COLUMN_EQ | WHERE_IDX_ONLY;
drh8b307fb2010-04-06 15:57:05 +00001656
1657 /* Construct the Index object to describe this index */
drhbbbdc832013-10-22 18:01:40 +00001658 pIdx = sqlite3AllocateIndexObject(pParse->db, nKeyCol+1, 0, &zNotUsed);
drh8b307fb2010-04-06 15:57:05 +00001659 if( pIdx==0 ) return;
drh7ba39a92013-05-30 17:43:19 +00001660 pLoop->u.btree.pIndex = pIdx;
drh8b307fb2010-04-06 15:57:05 +00001661 pIdx->zName = "auto-index";
drh424aab82010-04-06 18:28:20 +00001662 pIdx->pTable = pTable;
drh8b307fb2010-04-06 15:57:05 +00001663 n = 0;
drh0013e722010-04-08 00:40:15 +00001664 idxCols = 0;
drh8b307fb2010-04-06 15:57:05 +00001665 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00001666 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
drh0013e722010-04-08 00:40:15 +00001667 int iCol = pTerm->u.leftColumn;
drh7699d1c2013-06-04 12:42:29 +00001668 Bitmask cMask = iCol>=BMS ? MASKBIT(BMS-1) : MASKBIT(iCol);
drh7963b0e2013-06-17 21:37:40 +00001669 testcase( iCol==BMS-1 );
1670 testcase( iCol==BMS );
drh0013e722010-04-08 00:40:15 +00001671 if( (idxCols & cMask)==0 ){
1672 Expr *pX = pTerm->pExpr;
1673 idxCols |= cMask;
1674 pIdx->aiColumn[n] = pTerm->u.leftColumn;
1675 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
drh6f2e6c02011-02-17 13:33:15 +00001676 pIdx->azColl[n] = ALWAYS(pColl) ? pColl->zName : "BINARY";
drh0013e722010-04-08 00:40:15 +00001677 n++;
1678 }
drh8b307fb2010-04-06 15:57:05 +00001679 }
1680 }
drh7ba39a92013-05-30 17:43:19 +00001681 assert( (u32)n==pLoop->u.btree.nEq );
drh4139c992010-04-07 14:59:45 +00001682
drhc6339082010-04-07 16:54:58 +00001683 /* Add additional columns needed to make the automatic index into
1684 ** a covering index */
drh4139c992010-04-07 14:59:45 +00001685 for(i=0; i<mxBitCol; i++){
drh7699d1c2013-06-04 12:42:29 +00001686 if( extraCols & MASKBIT(i) ){
drh4139c992010-04-07 14:59:45 +00001687 pIdx->aiColumn[n] = i;
1688 pIdx->azColl[n] = "BINARY";
1689 n++;
1690 }
1691 }
drh7699d1c2013-06-04 12:42:29 +00001692 if( pSrc->colUsed & MASKBIT(BMS-1) ){
drh4139c992010-04-07 14:59:45 +00001693 for(i=BMS-1; i<pTable->nCol; i++){
1694 pIdx->aiColumn[n] = i;
1695 pIdx->azColl[n] = "BINARY";
1696 n++;
1697 }
1698 }
drhbbbdc832013-10-22 18:01:40 +00001699 assert( n==nKeyCol );
drh44156282013-10-23 22:23:03 +00001700 pIdx->aiColumn[n] = -1;
1701 pIdx->azColl[n] = "BINARY";
drh8b307fb2010-04-06 15:57:05 +00001702
drhc6339082010-04-07 16:54:58 +00001703 /* Create the automatic index */
drh8b307fb2010-04-06 15:57:05 +00001704 assert( pLevel->iIdxCur>=0 );
drha1f41242013-05-31 20:00:58 +00001705 pLevel->iIdxCur = pParse->nTab++;
drh2ec2fb22013-11-06 19:59:23 +00001706 sqlite3VdbeAddOp2(v, OP_OpenAutoindex, pLevel->iIdxCur, nKeyCol+1);
1707 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
drha21a64d2010-04-06 22:33:55 +00001708 VdbeComment((v, "for %s", pTable->zName));
drh8b307fb2010-04-06 15:57:05 +00001709
drhc6339082010-04-07 16:54:58 +00001710 /* Fill the automatic index with content */
drh688852a2014-02-17 22:40:43 +00001711 addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, pLevel->iTabCur); VdbeCoverage(v);
drh8b307fb2010-04-06 15:57:05 +00001712 regRecord = sqlite3GetTempReg(pParse);
drh1c2c0b72014-01-04 19:27:05 +00001713 sqlite3GenerateIndexKey(pParse, pIdx, pLevel->iTabCur, regRecord, 0, 0, 0, 0);
drh8b307fb2010-04-06 15:57:05 +00001714 sqlite3VdbeAddOp2(v, OP_IdxInsert, pLevel->iIdxCur, regRecord);
1715 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
drh688852a2014-02-17 22:40:43 +00001716 sqlite3VdbeAddOp2(v, OP_Next, pLevel->iTabCur, addrTop+1); VdbeCoverage(v);
drha21a64d2010-04-06 22:33:55 +00001717 sqlite3VdbeChangeP5(v, SQLITE_STMTSTATUS_AUTOINDEX);
drh8b307fb2010-04-06 15:57:05 +00001718 sqlite3VdbeJumpHere(v, addrTop);
1719 sqlite3ReleaseTempReg(pParse, regRecord);
1720
1721 /* Jump here when skipping the initialization */
1722 sqlite3VdbeJumpHere(v, addrInit);
1723}
drhc6339082010-04-07 16:54:58 +00001724#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh8b307fb2010-04-06 15:57:05 +00001725
drh9eff6162006-06-12 21:59:13 +00001726#ifndef SQLITE_OMIT_VIRTUALTABLE
1727/*
danielk19771d461462009-04-21 09:02:45 +00001728** Allocate and populate an sqlite3_index_info structure. It is the
1729** responsibility of the caller to eventually release the structure
1730** by passing the pointer returned by this function to sqlite3_free().
1731*/
drh5346e952013-05-08 14:14:26 +00001732static sqlite3_index_info *allocateIndexInfo(
1733 Parse *pParse,
1734 WhereClause *pWC,
1735 struct SrcList_item *pSrc,
1736 ExprList *pOrderBy
1737){
danielk19771d461462009-04-21 09:02:45 +00001738 int i, j;
1739 int nTerm;
1740 struct sqlite3_index_constraint *pIdxCons;
1741 struct sqlite3_index_orderby *pIdxOrderBy;
1742 struct sqlite3_index_constraint_usage *pUsage;
1743 WhereTerm *pTerm;
1744 int nOrderBy;
1745 sqlite3_index_info *pIdxInfo;
1746
danielk19771d461462009-04-21 09:02:45 +00001747 /* Count the number of possible WHERE clause constraints referring
1748 ** to this virtual table */
1749 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1750 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh7a5bcc02013-01-16 17:08:58 +00001751 assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
1752 testcase( pTerm->eOperator & WO_IN );
1753 testcase( pTerm->eOperator & WO_ISNULL );
dana4ff8252014-01-20 19:55:33 +00001754 testcase( pTerm->eOperator & WO_ALL );
1755 if( (pTerm->eOperator & ~(WO_ISNULL|WO_EQUIV))==0 ) continue;
drhb4256992011-08-02 01:57:39 +00001756 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00001757 nTerm++;
1758 }
1759
1760 /* If the ORDER BY clause contains only columns in the current
1761 ** virtual table then allocate space for the aOrderBy part of
1762 ** the sqlite3_index_info structure.
1763 */
1764 nOrderBy = 0;
1765 if( pOrderBy ){
drh56f1b992012-09-25 14:29:39 +00001766 int n = pOrderBy->nExpr;
1767 for(i=0; i<n; i++){
danielk19771d461462009-04-21 09:02:45 +00001768 Expr *pExpr = pOrderBy->a[i].pExpr;
1769 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
1770 }
drh56f1b992012-09-25 14:29:39 +00001771 if( i==n){
1772 nOrderBy = n;
danielk19771d461462009-04-21 09:02:45 +00001773 }
1774 }
1775
1776 /* Allocate the sqlite3_index_info structure
1777 */
1778 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
1779 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
1780 + sizeof(*pIdxOrderBy)*nOrderBy );
1781 if( pIdxInfo==0 ){
1782 sqlite3ErrorMsg(pParse, "out of memory");
danielk19771d461462009-04-21 09:02:45 +00001783 return 0;
1784 }
1785
1786 /* Initialize the structure. The sqlite3_index_info structure contains
1787 ** many fields that are declared "const" to prevent xBestIndex from
1788 ** changing them. We have to do some funky casting in order to
1789 ** initialize those fields.
1790 */
1791 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
1792 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
1793 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
1794 *(int*)&pIdxInfo->nConstraint = nTerm;
1795 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
1796 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
1797 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
1798 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
1799 pUsage;
1800
1801 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
drh281bbe22012-10-16 23:17:14 +00001802 u8 op;
danielk19771d461462009-04-21 09:02:45 +00001803 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh7a5bcc02013-01-16 17:08:58 +00001804 assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
1805 testcase( pTerm->eOperator & WO_IN );
1806 testcase( pTerm->eOperator & WO_ISNULL );
dana4ff8252014-01-20 19:55:33 +00001807 testcase( pTerm->eOperator & WO_ALL );
1808 if( (pTerm->eOperator & ~(WO_ISNULL|WO_EQUIV))==0 ) continue;
drhb4256992011-08-02 01:57:39 +00001809 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00001810 pIdxCons[j].iColumn = pTerm->u.leftColumn;
1811 pIdxCons[j].iTermOffset = i;
drh7a5bcc02013-01-16 17:08:58 +00001812 op = (u8)pTerm->eOperator & WO_ALL;
drh281bbe22012-10-16 23:17:14 +00001813 if( op==WO_IN ) op = WO_EQ;
1814 pIdxCons[j].op = op;
danielk19771d461462009-04-21 09:02:45 +00001815 /* The direct assignment in the previous line is possible only because
1816 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
1817 ** following asserts verify this fact. */
1818 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
1819 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
1820 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
1821 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
1822 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
1823 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
drh281bbe22012-10-16 23:17:14 +00001824 assert( pTerm->eOperator & (WO_IN|WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
danielk19771d461462009-04-21 09:02:45 +00001825 j++;
1826 }
1827 for(i=0; i<nOrderBy; i++){
1828 Expr *pExpr = pOrderBy->a[i].pExpr;
1829 pIdxOrderBy[i].iColumn = pExpr->iColumn;
1830 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
1831 }
1832
1833 return pIdxInfo;
1834}
1835
1836/*
1837** The table object reference passed as the second argument to this function
1838** must represent a virtual table. This function invokes the xBestIndex()
drh3b48e8c2013-06-12 20:18:16 +00001839** method of the virtual table with the sqlite3_index_info object that
1840** comes in as the 3rd argument to this function.
danielk19771d461462009-04-21 09:02:45 +00001841**
1842** If an error occurs, pParse is populated with an error message and a
1843** non-zero value is returned. Otherwise, 0 is returned and the output
1844** part of the sqlite3_index_info structure is left populated.
1845**
1846** Whether or not an error is returned, it is the responsibility of the
1847** caller to eventually free p->idxStr if p->needToFreeIdxStr indicates
1848** that this is required.
1849*/
1850static int vtabBestIndex(Parse *pParse, Table *pTab, sqlite3_index_info *p){
danielk1977595a5232009-07-24 17:58:53 +00001851 sqlite3_vtab *pVtab = sqlite3GetVTable(pParse->db, pTab)->pVtab;
danielk19771d461462009-04-21 09:02:45 +00001852 int i;
1853 int rc;
1854
danielk19771d461462009-04-21 09:02:45 +00001855 TRACE_IDX_INPUTS(p);
1856 rc = pVtab->pModule->xBestIndex(pVtab, p);
1857 TRACE_IDX_OUTPUTS(p);
danielk19771d461462009-04-21 09:02:45 +00001858
1859 if( rc!=SQLITE_OK ){
1860 if( rc==SQLITE_NOMEM ){
1861 pParse->db->mallocFailed = 1;
1862 }else if( !pVtab->zErrMsg ){
1863 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
1864 }else{
1865 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
1866 }
1867 }
drhb9755982010-07-24 16:34:37 +00001868 sqlite3_free(pVtab->zErrMsg);
danielk19771d461462009-04-21 09:02:45 +00001869 pVtab->zErrMsg = 0;
1870
1871 for(i=0; i<p->nConstraint; i++){
1872 if( !p->aConstraint[i].usable && p->aConstraintUsage[i].argvIndex>0 ){
1873 sqlite3ErrorMsg(pParse,
1874 "table %s: xBestIndex returned an invalid plan", pTab->zName);
1875 }
1876 }
1877
1878 return pParse->nErr;
1879}
drh7ba39a92013-05-30 17:43:19 +00001880#endif /* !defined(SQLITE_OMIT_VIRTUALTABLE) */
danielk19771d461462009-04-21 09:02:45 +00001881
1882
drh1435a9a2013-08-27 23:15:44 +00001883#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh28c4cf42005-07-27 20:41:43 +00001884/*
drhfaacf172011-08-12 01:51:45 +00001885** Estimate the location of a particular key among all keys in an
1886** index. Store the results in aStat as follows:
drhe847d322011-01-20 02:56:37 +00001887**
drhfaacf172011-08-12 01:51:45 +00001888** aStat[0] Est. number of rows less than pVal
1889** aStat[1] Est. number of rows equal to pVal
dan02fa4692009-08-17 17:06:58 +00001890**
drhfaacf172011-08-12 01:51:45 +00001891** Return SQLITE_OK on success.
dan02fa4692009-08-17 17:06:58 +00001892*/
danb3c02e22013-08-08 19:38:40 +00001893static void whereKeyStats(
dan02fa4692009-08-17 17:06:58 +00001894 Parse *pParse, /* Database connection */
1895 Index *pIdx, /* Index to consider domain of */
dan7a419232013-08-06 20:01:43 +00001896 UnpackedRecord *pRec, /* Vector of values to consider */
drhfaacf172011-08-12 01:51:45 +00001897 int roundUp, /* Round up if true. Round down if false */
1898 tRowcnt *aStat /* OUT: stats written here */
dan02fa4692009-08-17 17:06:58 +00001899){
danf52bb8d2013-08-03 20:24:58 +00001900 IndexSample *aSample = pIdx->aSample;
drhfbc38de2013-09-03 19:26:22 +00001901 int iCol; /* Index of required stats in anEq[] etc. */
dan84c309b2013-08-08 16:17:12 +00001902 int iMin = 0; /* Smallest sample not yet tested */
1903 int i = pIdx->nSample; /* Smallest sample larger than or equal to pRec */
1904 int iTest; /* Next sample to test */
1905 int res; /* Result of comparison operation */
dan02fa4692009-08-17 17:06:58 +00001906
drh4f991892013-10-11 15:05:05 +00001907#ifndef SQLITE_DEBUG
1908 UNUSED_PARAMETER( pParse );
1909#endif
drh7f594752013-12-03 19:49:55 +00001910 assert( pRec!=0 );
drhfbc38de2013-09-03 19:26:22 +00001911 iCol = pRec->nField - 1;
drh5c624862011-09-22 18:46:34 +00001912 assert( pIdx->nSample>0 );
dan8ad169a2013-08-12 20:14:04 +00001913 assert( pRec->nField>0 && iCol<pIdx->nSampleCol );
dan84c309b2013-08-08 16:17:12 +00001914 do{
1915 iTest = (iMin+i)/2;
dan3833e932014-03-01 19:44:56 +00001916 res = sqlite3VdbeRecordCompare(aSample[iTest].n, aSample[iTest].p, pRec, 0);
dan84c309b2013-08-08 16:17:12 +00001917 if( res<0 ){
1918 iMin = iTest+1;
1919 }else{
1920 i = iTest;
dan02fa4692009-08-17 17:06:58 +00001921 }
dan84c309b2013-08-08 16:17:12 +00001922 }while( res && iMin<i );
drh51147ba2005-07-23 22:59:55 +00001923
dan84c309b2013-08-08 16:17:12 +00001924#ifdef SQLITE_DEBUG
1925 /* The following assert statements check that the binary search code
1926 ** above found the right answer. This block serves no purpose other
1927 ** than to invoke the asserts. */
1928 if( res==0 ){
1929 /* If (res==0) is true, then sample $i must be equal to pRec */
1930 assert( i<pIdx->nSample );
dan3833e932014-03-01 19:44:56 +00001931 assert( 0==sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec, 0)
drh0e1f0022013-08-16 14:49:00 +00001932 || pParse->db->mallocFailed );
dan02fa4692009-08-17 17:06:58 +00001933 }else{
dan84c309b2013-08-08 16:17:12 +00001934 /* Otherwise, pRec must be smaller than sample $i and larger than
1935 ** sample ($i-1). */
1936 assert( i==pIdx->nSample
dan3833e932014-03-01 19:44:56 +00001937 || sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec, 0)>0
drh0e1f0022013-08-16 14:49:00 +00001938 || pParse->db->mallocFailed );
dan84c309b2013-08-08 16:17:12 +00001939 assert( i==0
dan3833e932014-03-01 19:44:56 +00001940 || sqlite3VdbeRecordCompare(aSample[i-1].n, aSample[i-1].p, pRec, 0)<0
drh0e1f0022013-08-16 14:49:00 +00001941 || pParse->db->mallocFailed );
drhfaacf172011-08-12 01:51:45 +00001942 }
dan84c309b2013-08-08 16:17:12 +00001943#endif /* ifdef SQLITE_DEBUG */
dan02fa4692009-08-17 17:06:58 +00001944
drhfaacf172011-08-12 01:51:45 +00001945 /* At this point, aSample[i] is the first sample that is greater than
1946 ** or equal to pVal. Or if i==pIdx->nSample, then all samples are less
dan84c309b2013-08-08 16:17:12 +00001947 ** than pVal. If aSample[i]==pVal, then res==0.
drhfaacf172011-08-12 01:51:45 +00001948 */
dan84c309b2013-08-08 16:17:12 +00001949 if( res==0 ){
daneea568d2013-08-07 19:46:15 +00001950 aStat[0] = aSample[i].anLt[iCol];
1951 aStat[1] = aSample[i].anEq[iCol];
drhfaacf172011-08-12 01:51:45 +00001952 }else{
1953 tRowcnt iLower, iUpper, iGap;
1954 if( i==0 ){
1955 iLower = 0;
daneea568d2013-08-07 19:46:15 +00001956 iUpper = aSample[0].anLt[iCol];
drhfaacf172011-08-12 01:51:45 +00001957 }else{
daneea568d2013-08-07 19:46:15 +00001958 iUpper = i>=pIdx->nSample ? pIdx->aiRowEst[0] : aSample[i].anLt[iCol];
1959 iLower = aSample[i-1].anEq[iCol] + aSample[i-1].anLt[iCol];
drhfaacf172011-08-12 01:51:45 +00001960 }
drhbbbdc832013-10-22 18:01:40 +00001961 aStat[1] = (pIdx->nKeyCol>iCol ? pIdx->aAvgEq[iCol] : 1);
drhfaacf172011-08-12 01:51:45 +00001962 if( iLower>=iUpper ){
1963 iGap = 0;
1964 }else{
1965 iGap = iUpper - iLower;
drhfaacf172011-08-12 01:51:45 +00001966 }
1967 if( roundUp ){
1968 iGap = (iGap*2)/3;
1969 }else{
1970 iGap = iGap/3;
1971 }
1972 aStat[0] = iLower + iGap;
dan02fa4692009-08-17 17:06:58 +00001973 }
dan02fa4692009-08-17 17:06:58 +00001974}
drh1435a9a2013-08-27 23:15:44 +00001975#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
dan937d0de2009-10-15 18:35:38 +00001976
1977/*
dan02fa4692009-08-17 17:06:58 +00001978** This function is used to estimate the number of rows that will be visited
1979** by scanning an index for a range of values. The range may have an upper
1980** bound, a lower bound, or both. The WHERE clause terms that set the upper
1981** and lower bounds are represented by pLower and pUpper respectively. For
1982** example, assuming that index p is on t1(a):
1983**
1984** ... FROM t1 WHERE a > ? AND a < ? ...
1985** |_____| |_____|
1986** | |
1987** pLower pUpper
1988**
drh98cdf622009-08-20 18:14:42 +00001989** If either of the upper or lower bound is not present, then NULL is passed in
drhcdaca552009-08-20 13:45:07 +00001990** place of the corresponding WhereTerm.
dan02fa4692009-08-17 17:06:58 +00001991**
dan6cb8d762013-08-08 11:48:57 +00001992** The value in (pBuilder->pNew->u.btree.nEq) is the index of the index
1993** column subject to the range constraint. Or, equivalently, the number of
1994** equality constraints optimized by the proposed index scan. For example,
1995** assuming index p is on t1(a, b), and the SQL query is:
dan02fa4692009-08-17 17:06:58 +00001996**
1997** ... FROM t1 WHERE a = ? AND b > ? AND b < ? ...
1998**
dan6cb8d762013-08-08 11:48:57 +00001999** then nEq is set to 1 (as the range restricted column, b, is the second
2000** left-most column of the index). Or, if the query is:
dan02fa4692009-08-17 17:06:58 +00002001**
2002** ... FROM t1 WHERE a > ? AND a < ? ...
2003**
dan6cb8d762013-08-08 11:48:57 +00002004** then nEq is set to 0.
dan02fa4692009-08-17 17:06:58 +00002005**
drhbf539c42013-10-05 18:16:02 +00002006** When this function is called, *pnOut is set to the sqlite3LogEst() of the
dan6cb8d762013-08-08 11:48:57 +00002007** number of rows that the index scan is expected to visit without
2008** considering the range constraints. If nEq is 0, this is the number of
2009** rows in the index. Assuming no error occurs, *pnOut is adjusted (reduced)
2010** to account for the range contraints pLower and pUpper.
2011**
2012** In the absence of sqlite_stat4 ANALYZE data, or if such data cannot be
2013** used, each range inequality reduces the search space by a factor of 4.
2014** Hence a pair of constraints (x>? AND x<?) reduces the expected number of
2015** rows visited by a factor of 16.
dan02fa4692009-08-17 17:06:58 +00002016*/
2017static int whereRangeScanEst(
drhcdaca552009-08-20 13:45:07 +00002018 Parse *pParse, /* Parsing & code generating context */
dan7a419232013-08-06 20:01:43 +00002019 WhereLoopBuilder *pBuilder,
drhcdaca552009-08-20 13:45:07 +00002020 WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
2021 WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
drh186ad8c2013-10-08 18:40:37 +00002022 WhereLoop *pLoop /* Modify the .nOut and maybe .rRun fields */
dan02fa4692009-08-17 17:06:58 +00002023){
dan69188d92009-08-19 08:18:32 +00002024 int rc = SQLITE_OK;
drh186ad8c2013-10-08 18:40:37 +00002025 int nOut = pLoop->nOut;
drhbf539c42013-10-05 18:16:02 +00002026 LogEst nNew;
dan69188d92009-08-19 08:18:32 +00002027
drh1435a9a2013-08-27 23:15:44 +00002028#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh186ad8c2013-10-08 18:40:37 +00002029 Index *p = pLoop->u.btree.pIndex;
drh4f991892013-10-11 15:05:05 +00002030 int nEq = pLoop->u.btree.nEq;
dan02fa4692009-08-17 17:06:58 +00002031
drh74dade22013-09-04 18:14:53 +00002032 if( p->nSample>0
2033 && nEq==pBuilder->nRecValid
dan8ad169a2013-08-12 20:14:04 +00002034 && nEq<p->nSampleCol
dan7a419232013-08-06 20:01:43 +00002035 && OptimizationEnabled(pParse->db, SQLITE_Stat3)
2036 ){
2037 UnpackedRecord *pRec = pBuilder->pRec;
drhfaacf172011-08-12 01:51:45 +00002038 tRowcnt a[2];
dan575ab2f2013-09-02 07:16:40 +00002039 u8 aff;
drh98cdf622009-08-20 18:14:42 +00002040
danb3c02e22013-08-08 19:38:40 +00002041 /* Variable iLower will be set to the estimate of the number of rows in
2042 ** the index that are less than the lower bound of the range query. The
2043 ** lower bound being the concatenation of $P and $L, where $P is the
2044 ** key-prefix formed by the nEq values matched against the nEq left-most
2045 ** columns of the index, and $L is the value in pLower.
2046 **
2047 ** Or, if pLower is NULL or $L cannot be extracted from it (because it
2048 ** is not a simple variable or literal value), the lower bound of the
2049 ** range is $P. Due to a quirk in the way whereKeyStats() works, even
2050 ** if $L is available, whereKeyStats() is called for both ($P) and
2051 ** ($P:$L) and the larger of the two returned values used.
2052 **
2053 ** Similarly, iUpper is to be set to the estimate of the number of rows
2054 ** less than the upper bound of the range query. Where the upper bound
2055 ** is either ($P) or ($P:$U). Again, even if $U is available, both values
2056 ** of iUpper are requested of whereKeyStats() and the smaller used.
2057 */
2058 tRowcnt iLower;
2059 tRowcnt iUpper;
2060
drhbbbdc832013-10-22 18:01:40 +00002061 if( nEq==p->nKeyCol ){
mistachkinc2cfb512013-09-04 04:04:08 +00002062 aff = SQLITE_AFF_INTEGER;
2063 }else{
2064 aff = p->pTable->aCol[p->aiColumn[nEq]].affinity;
2065 }
danb3c02e22013-08-08 19:38:40 +00002066 /* Determine iLower and iUpper using ($P) only. */
2067 if( nEq==0 ){
2068 iLower = 0;
2069 iUpper = p->aiRowEst[0];
2070 }else{
2071 /* Note: this call could be optimized away - since the same values must
2072 ** have been requested when testing key $P in whereEqualScanEst(). */
2073 whereKeyStats(pParse, p, pRec, 0, a);
2074 iLower = a[0];
2075 iUpper = a[0] + a[1];
2076 }
2077
2078 /* If possible, improve on the iLower estimate using ($P:$L). */
dan02fa4692009-08-17 17:06:58 +00002079 if( pLower ){
dan7a419232013-08-06 20:01:43 +00002080 int bOk; /* True if value is extracted from pExpr */
dan02fa4692009-08-17 17:06:58 +00002081 Expr *pExpr = pLower->pExpr->pRight;
drh7a5bcc02013-01-16 17:08:58 +00002082 assert( (pLower->eOperator & (WO_GT|WO_GE))!=0 );
dan87cd9322013-08-07 15:52:41 +00002083 rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, aff, nEq, &bOk);
danb3c02e22013-08-08 19:38:40 +00002084 if( rc==SQLITE_OK && bOk ){
2085 tRowcnt iNew;
2086 whereKeyStats(pParse, p, pRec, 0, a);
2087 iNew = a[0] + ((pLower->eOperator & WO_GT) ? a[1] : 0);
2088 if( iNew>iLower ) iLower = iNew;
drhabfa6d52013-09-11 03:53:22 +00002089 nOut--;
drhfaacf172011-08-12 01:51:45 +00002090 }
dan02fa4692009-08-17 17:06:58 +00002091 }
danb3c02e22013-08-08 19:38:40 +00002092
2093 /* If possible, improve on the iUpper estimate using ($P:$U). */
2094 if( pUpper ){
dan7a419232013-08-06 20:01:43 +00002095 int bOk; /* True if value is extracted from pExpr */
dan02fa4692009-08-17 17:06:58 +00002096 Expr *pExpr = pUpper->pExpr->pRight;
drh7a5bcc02013-01-16 17:08:58 +00002097 assert( (pUpper->eOperator & (WO_LT|WO_LE))!=0 );
dan87cd9322013-08-07 15:52:41 +00002098 rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, aff, nEq, &bOk);
danb3c02e22013-08-08 19:38:40 +00002099 if( rc==SQLITE_OK && bOk ){
2100 tRowcnt iNew;
2101 whereKeyStats(pParse, p, pRec, 1, a);
2102 iNew = a[0] + ((pUpper->eOperator & WO_LE) ? a[1] : 0);
2103 if( iNew<iUpper ) iUpper = iNew;
drhabfa6d52013-09-11 03:53:22 +00002104 nOut--;
dan02fa4692009-08-17 17:06:58 +00002105 }
2106 }
danb3c02e22013-08-08 19:38:40 +00002107
dan87cd9322013-08-07 15:52:41 +00002108 pBuilder->pRec = pRec;
drhfaacf172011-08-12 01:51:45 +00002109 if( rc==SQLITE_OK ){
drhb8a8e8a2013-06-10 19:12:39 +00002110 if( iUpper>iLower ){
drhbf539c42013-10-05 18:16:02 +00002111 nNew = sqlite3LogEst(iUpper - iLower);
dan7a419232013-08-06 20:01:43 +00002112 }else{
drhbf539c42013-10-05 18:16:02 +00002113 nNew = 10; assert( 10==sqlite3LogEst(2) );
drhfaacf172011-08-12 01:51:45 +00002114 }
dan6cb8d762013-08-08 11:48:57 +00002115 if( nNew<nOut ){
2116 nOut = nNew;
2117 }
drh186ad8c2013-10-08 18:40:37 +00002118 pLoop->nOut = (LogEst)nOut;
drh989578e2013-10-28 14:34:35 +00002119 WHERETRACE(0x10, ("range scan regions: %u..%u est=%d\n",
dan6cb8d762013-08-08 11:48:57 +00002120 (u32)iLower, (u32)iUpper, nOut));
drhfaacf172011-08-12 01:51:45 +00002121 return SQLITE_OK;
drh98cdf622009-08-20 18:14:42 +00002122 }
dan02fa4692009-08-17 17:06:58 +00002123 }
drh3f022182009-09-09 16:10:50 +00002124#else
2125 UNUSED_PARAMETER(pParse);
dan7a419232013-08-06 20:01:43 +00002126 UNUSED_PARAMETER(pBuilder);
dan69188d92009-08-19 08:18:32 +00002127#endif
dan02fa4692009-08-17 17:06:58 +00002128 assert( pLower || pUpper );
drhe1e2e9a2013-06-13 15:16:53 +00002129 /* TUNING: Each inequality constraint reduces the search space 4-fold.
2130 ** A BETWEEN operator, therefore, reduces the search space 16-fold */
drhabfa6d52013-09-11 03:53:22 +00002131 nNew = nOut;
drhb8a8e8a2013-06-10 19:12:39 +00002132 if( pLower && (pLower->wtFlags & TERM_VNULL)==0 ){
drhbf539c42013-10-05 18:16:02 +00002133 nNew -= 20; assert( 20==sqlite3LogEst(4) );
drhabfa6d52013-09-11 03:53:22 +00002134 nOut--;
drhb8a8e8a2013-06-10 19:12:39 +00002135 }
2136 if( pUpper ){
drhbf539c42013-10-05 18:16:02 +00002137 nNew -= 20; assert( 20==sqlite3LogEst(4) );
drhabfa6d52013-09-11 03:53:22 +00002138 nOut--;
drhb8a8e8a2013-06-10 19:12:39 +00002139 }
drhabfa6d52013-09-11 03:53:22 +00002140 if( nNew<10 ) nNew = 10;
2141 if( nNew<nOut ) nOut = nNew;
drh186ad8c2013-10-08 18:40:37 +00002142 pLoop->nOut = (LogEst)nOut;
dan02fa4692009-08-17 17:06:58 +00002143 return rc;
2144}
2145
drh1435a9a2013-08-27 23:15:44 +00002146#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh82759752011-01-20 16:52:09 +00002147/*
2148** Estimate the number of rows that will be returned based on
2149** an equality constraint x=VALUE and where that VALUE occurs in
2150** the histogram data. This only works when x is the left-most
drhfaacf172011-08-12 01:51:45 +00002151** column of an index and sqlite_stat3 histogram data is available
drhac8eb112011-03-17 01:58:21 +00002152** for that index. When pExpr==NULL that means the constraint is
2153** "x IS NULL" instead of "x=VALUE".
drh82759752011-01-20 16:52:09 +00002154**
drh0c50fa02011-01-21 16:27:18 +00002155** Write the estimated row count into *pnRow and return SQLITE_OK.
2156** If unable to make an estimate, leave *pnRow unchanged and return
2157** non-zero.
drh9b3eb0a2011-01-21 14:37:04 +00002158**
2159** This routine can fail if it is unable to load a collating sequence
2160** required for string comparison, or if unable to allocate memory
2161** for a UTF conversion required for comparison. The error is stored
2162** in the pParse structure.
drh82759752011-01-20 16:52:09 +00002163*/
drh041e09f2011-04-07 19:56:21 +00002164static int whereEqualScanEst(
drh82759752011-01-20 16:52:09 +00002165 Parse *pParse, /* Parsing & code generating context */
dan7a419232013-08-06 20:01:43 +00002166 WhereLoopBuilder *pBuilder,
drh0c50fa02011-01-21 16:27:18 +00002167 Expr *pExpr, /* Expression for VALUE in the x=VALUE constraint */
drhb8a8e8a2013-06-10 19:12:39 +00002168 tRowcnt *pnRow /* Write the revised row estimate here */
drh82759752011-01-20 16:52:09 +00002169){
dan7a419232013-08-06 20:01:43 +00002170 Index *p = pBuilder->pNew->u.btree.pIndex;
2171 int nEq = pBuilder->pNew->u.btree.nEq;
2172 UnpackedRecord *pRec = pBuilder->pRec;
drh82759752011-01-20 16:52:09 +00002173 u8 aff; /* Column affinity */
2174 int rc; /* Subfunction return code */
drhfaacf172011-08-12 01:51:45 +00002175 tRowcnt a[2]; /* Statistics */
dan7a419232013-08-06 20:01:43 +00002176 int bOk;
drh82759752011-01-20 16:52:09 +00002177
dan7a419232013-08-06 20:01:43 +00002178 assert( nEq>=1 );
drhbbbdc832013-10-22 18:01:40 +00002179 assert( nEq<=(p->nKeyCol+1) );
drh82759752011-01-20 16:52:09 +00002180 assert( p->aSample!=0 );
drh5c624862011-09-22 18:46:34 +00002181 assert( p->nSample>0 );
dan7a419232013-08-06 20:01:43 +00002182 assert( pBuilder->nRecValid<nEq );
2183
2184 /* If values are not available for all fields of the index to the left
2185 ** of this one, no estimate can be made. Return SQLITE_NOTFOUND. */
2186 if( pBuilder->nRecValid<(nEq-1) ){
2187 return SQLITE_NOTFOUND;
drh1f9c7662011-03-17 01:34:26 +00002188 }
dan7a419232013-08-06 20:01:43 +00002189
dandd6e1f12013-08-10 19:08:30 +00002190 /* This is an optimization only. The call to sqlite3Stat4ProbeSetValue()
2191 ** below would return the same value. */
drhbbbdc832013-10-22 18:01:40 +00002192 if( nEq>p->nKeyCol ){
dan7a419232013-08-06 20:01:43 +00002193 *pnRow = 1;
2194 return SQLITE_OK;
drh82759752011-01-20 16:52:09 +00002195 }
dan7a419232013-08-06 20:01:43 +00002196
daneea568d2013-08-07 19:46:15 +00002197 aff = p->pTable->aCol[p->aiColumn[nEq-1]].affinity;
dan87cd9322013-08-07 15:52:41 +00002198 rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, aff, nEq-1, &bOk);
2199 pBuilder->pRec = pRec;
dan7a419232013-08-06 20:01:43 +00002200 if( rc!=SQLITE_OK ) return rc;
2201 if( bOk==0 ) return SQLITE_NOTFOUND;
dan7a419232013-08-06 20:01:43 +00002202 pBuilder->nRecValid = nEq;
dan7a419232013-08-06 20:01:43 +00002203
danb3c02e22013-08-08 19:38:40 +00002204 whereKeyStats(pParse, p, pRec, 0, a);
drh989578e2013-10-28 14:34:35 +00002205 WHERETRACE(0x10,("equality scan regions: %d\n", (int)a[1]));
danb3c02e22013-08-08 19:38:40 +00002206 *pnRow = a[1];
daneea568d2013-08-07 19:46:15 +00002207
drh0c50fa02011-01-21 16:27:18 +00002208 return rc;
2209}
drh1435a9a2013-08-27 23:15:44 +00002210#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drh0c50fa02011-01-21 16:27:18 +00002211
drh1435a9a2013-08-27 23:15:44 +00002212#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh0c50fa02011-01-21 16:27:18 +00002213/*
2214** Estimate the number of rows that will be returned based on
drh5ac06072011-01-21 18:18:13 +00002215** an IN constraint where the right-hand side of the IN operator
2216** is a list of values. Example:
2217**
2218** WHERE x IN (1,2,3,4)
drh0c50fa02011-01-21 16:27:18 +00002219**
2220** Write the estimated row count into *pnRow and return SQLITE_OK.
2221** If unable to make an estimate, leave *pnRow unchanged and return
2222** non-zero.
2223**
2224** This routine can fail if it is unable to load a collating sequence
2225** required for string comparison, or if unable to allocate memory
2226** for a UTF conversion required for comparison. The error is stored
2227** in the pParse structure.
2228*/
drh041e09f2011-04-07 19:56:21 +00002229static int whereInScanEst(
drh0c50fa02011-01-21 16:27:18 +00002230 Parse *pParse, /* Parsing & code generating context */
dan7a419232013-08-06 20:01:43 +00002231 WhereLoopBuilder *pBuilder,
drh0c50fa02011-01-21 16:27:18 +00002232 ExprList *pList, /* The value list on the RHS of "x IN (v1,v2,v3,...)" */
drhb8a8e8a2013-06-10 19:12:39 +00002233 tRowcnt *pnRow /* Write the revised row estimate here */
drh0c50fa02011-01-21 16:27:18 +00002234){
dan7a419232013-08-06 20:01:43 +00002235 Index *p = pBuilder->pNew->u.btree.pIndex;
2236 int nRecValid = pBuilder->nRecValid;
drhb8a8e8a2013-06-10 19:12:39 +00002237 int rc = SQLITE_OK; /* Subfunction return code */
2238 tRowcnt nEst; /* Number of rows for a single term */
2239 tRowcnt nRowEst = 0; /* New estimate of the number of rows */
2240 int i; /* Loop counter */
drh0c50fa02011-01-21 16:27:18 +00002241
2242 assert( p->aSample!=0 );
drhfaacf172011-08-12 01:51:45 +00002243 for(i=0; rc==SQLITE_OK && i<pList->nExpr; i++){
2244 nEst = p->aiRowEst[0];
dan7a419232013-08-06 20:01:43 +00002245 rc = whereEqualScanEst(pParse, pBuilder, pList->a[i].pExpr, &nEst);
drhfaacf172011-08-12 01:51:45 +00002246 nRowEst += nEst;
dan7a419232013-08-06 20:01:43 +00002247 pBuilder->nRecValid = nRecValid;
drh0c50fa02011-01-21 16:27:18 +00002248 }
dan7a419232013-08-06 20:01:43 +00002249
drh0c50fa02011-01-21 16:27:18 +00002250 if( rc==SQLITE_OK ){
drh0c50fa02011-01-21 16:27:18 +00002251 if( nRowEst > p->aiRowEst[0] ) nRowEst = p->aiRowEst[0];
2252 *pnRow = nRowEst;
drh989578e2013-10-28 14:34:35 +00002253 WHERETRACE(0x10,("IN row estimate: est=%g\n", nRowEst));
drh0c50fa02011-01-21 16:27:18 +00002254 }
dan7a419232013-08-06 20:01:43 +00002255 assert( pBuilder->nRecValid==nRecValid );
drh0c50fa02011-01-21 16:27:18 +00002256 return rc;
drh82759752011-01-20 16:52:09 +00002257}
drh1435a9a2013-08-27 23:15:44 +00002258#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drh82759752011-01-20 16:52:09 +00002259
drh46c35f92012-09-26 23:17:01 +00002260/*
drh2ffb1182004-07-19 19:14:01 +00002261** Disable a term in the WHERE clause. Except, do not disable the term
2262** if it controls a LEFT OUTER JOIN and it did not originate in the ON
2263** or USING clause of that join.
2264**
2265** Consider the term t2.z='ok' in the following queries:
2266**
2267** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
2268** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
2269** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
2270**
drh23bf66d2004-12-14 03:34:34 +00002271** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00002272** in the ON clause. The term is disabled in (3) because it is not part
2273** of a LEFT OUTER JOIN. In (1), the term is not disabled.
2274**
2275** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00002276** of the join. Disabling is an optimization. When terms are satisfied
2277** by indices, we disable them to prevent redundant tests in the inner
2278** loop. We would get the correct results if nothing were ever disabled,
2279** but joins might run a little slower. The trick is to disable as much
2280** as we can without disabling too much. If we disabled in (1), we'd get
2281** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00002282*/
drh0fcef5e2005-07-19 17:38:22 +00002283static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
2284 if( pTerm
drhbe837bd2010-04-30 21:03:24 +00002285 && (pTerm->wtFlags & TERM_CODED)==0
drh0fcef5e2005-07-19 17:38:22 +00002286 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
drh0259bc32013-09-09 19:37:46 +00002287 && (pLevel->notReady & pTerm->prereqAll)==0
drh0fcef5e2005-07-19 17:38:22 +00002288 ){
drh165be382008-12-05 02:36:33 +00002289 pTerm->wtFlags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00002290 if( pTerm->iParent>=0 ){
2291 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
2292 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00002293 disableTerm(pLevel, pOther);
2294 }
drh0fcef5e2005-07-19 17:38:22 +00002295 }
drh2ffb1182004-07-19 19:14:01 +00002296 }
2297}
2298
2299/*
dan69f8bb92009-08-13 19:21:16 +00002300** Code an OP_Affinity opcode to apply the column affinity string zAff
2301** to the n registers starting at base.
2302**
drh039fc322009-11-17 18:31:47 +00002303** As an optimization, SQLITE_AFF_NONE entries (which are no-ops) at the
2304** beginning and end of zAff are ignored. If all entries in zAff are
2305** SQLITE_AFF_NONE, then no code gets generated.
2306**
2307** This routine makes its own copy of zAff so that the caller is free
2308** to modify zAff after this routine returns.
drh94a11212004-09-25 13:12:14 +00002309*/
dan69f8bb92009-08-13 19:21:16 +00002310static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
2311 Vdbe *v = pParse->pVdbe;
drh039fc322009-11-17 18:31:47 +00002312 if( zAff==0 ){
2313 assert( pParse->db->mallocFailed );
2314 return;
2315 }
dan69f8bb92009-08-13 19:21:16 +00002316 assert( v!=0 );
drh039fc322009-11-17 18:31:47 +00002317
2318 /* Adjust base and n to skip over SQLITE_AFF_NONE entries at the beginning
2319 ** and end of the affinity string.
2320 */
2321 while( n>0 && zAff[0]==SQLITE_AFF_NONE ){
2322 n--;
2323 base++;
2324 zAff++;
2325 }
2326 while( n>1 && zAff[n-1]==SQLITE_AFF_NONE ){
2327 n--;
2328 }
2329
2330 /* Code the OP_Affinity opcode if there is anything left to do. */
2331 if( n>0 ){
2332 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
2333 sqlite3VdbeChangeP4(v, -1, zAff, n);
2334 sqlite3ExprCacheAffinityChange(pParse, base, n);
2335 }
drh94a11212004-09-25 13:12:14 +00002336}
2337
drhe8b97272005-07-19 22:22:12 +00002338
2339/*
drh51147ba2005-07-23 22:59:55 +00002340** Generate code for a single equality term of the WHERE clause. An equality
2341** term can be either X=expr or X IN (...). pTerm is the term to be
2342** coded.
2343**
drh1db639c2008-01-17 02:36:28 +00002344** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00002345**
2346** For a constraint of the form X=expr, the expression is evaluated and its
2347** result is left on the stack. For constraints of the form X IN (...)
2348** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00002349*/
drh678ccce2008-03-31 18:19:54 +00002350static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00002351 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00002352 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh0fe456b2013-03-12 18:34:50 +00002353 WhereLevel *pLevel, /* The level of the FROM clause we are working on */
2354 int iEq, /* Index of the equality term within this level */
drh7ba39a92013-05-30 17:43:19 +00002355 int bRev, /* True for reverse-order IN operations */
drh678ccce2008-03-31 18:19:54 +00002356 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00002357){
drh0fcef5e2005-07-19 17:38:22 +00002358 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00002359 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00002360 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00002361
danielk19772d605492008-10-01 08:43:03 +00002362 assert( iTarget>0 );
drh50b39962006-10-28 00:28:09 +00002363 if( pX->op==TK_EQ ){
drh678ccce2008-03-31 18:19:54 +00002364 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00002365 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00002366 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00002367 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00002368#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00002369 }else{
danielk19779a96b662007-11-29 17:05:18 +00002370 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00002371 int iTab;
drh72e8fa42007-03-28 14:30:06 +00002372 struct InLoop *pIn;
drh7ba39a92013-05-30 17:43:19 +00002373 WhereLoop *pLoop = pLevel->pWLoop;
danielk1977b3bce662005-01-29 08:32:43 +00002374
drh7ba39a92013-05-30 17:43:19 +00002375 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
2376 && pLoop->u.btree.pIndex!=0
2377 && pLoop->u.btree.pIndex->aSortOrder[iEq]
drhd3832162013-03-12 18:49:25 +00002378 ){
drh725e1ae2013-03-12 23:58:42 +00002379 testcase( iEq==0 );
drh725e1ae2013-03-12 23:58:42 +00002380 testcase( bRev );
drh1ccce442013-03-12 20:38:51 +00002381 bRev = !bRev;
drh0fe456b2013-03-12 18:34:50 +00002382 }
drh50b39962006-10-28 00:28:09 +00002383 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00002384 iReg = iTarget;
danielk19770cdc0222008-06-26 18:04:03 +00002385 eType = sqlite3FindInIndex(pParse, pX, 0);
drh725e1ae2013-03-12 23:58:42 +00002386 if( eType==IN_INDEX_INDEX_DESC ){
2387 testcase( bRev );
2388 bRev = !bRev;
2389 }
danielk1977b3bce662005-01-29 08:32:43 +00002390 iTab = pX->iTable;
drh7d176102014-02-18 03:07:12 +00002391 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
2392 VdbeCoverageIf(v, bRev);
2393 VdbeCoverageIf(v, !bRev);
drh6fa978d2013-05-30 19:29:19 +00002394 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
2395 pLoop->wsFlags |= WHERE_IN_ABLE;
drh111a6a72008-12-21 03:51:16 +00002396 if( pLevel->u.in.nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00002397 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00002398 }
drh111a6a72008-12-21 03:51:16 +00002399 pLevel->u.in.nIn++;
2400 pLevel->u.in.aInLoop =
2401 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
2402 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
2403 pIn = pLevel->u.in.aInLoop;
drh72e8fa42007-03-28 14:30:06 +00002404 if( pIn ){
drh111a6a72008-12-21 03:51:16 +00002405 pIn += pLevel->u.in.nIn - 1;
drh72e8fa42007-03-28 14:30:06 +00002406 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00002407 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00002408 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00002409 }else{
drhb3190c12008-12-08 21:37:14 +00002410 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00002411 }
drhf93cd942013-11-21 03:12:25 +00002412 pIn->eEndLoopOp = bRev ? OP_PrevIfOpen : OP_NextIfOpen;
drh688852a2014-02-17 22:40:43 +00002413 sqlite3VdbeAddOp1(v, OP_IsNull, iReg); VdbeCoverage(v);
drha6110402005-07-28 20:51:19 +00002414 }else{
drh111a6a72008-12-21 03:51:16 +00002415 pLevel->u.in.nIn = 0;
drhe23399f2005-07-22 00:31:39 +00002416 }
danielk1977b3bce662005-01-29 08:32:43 +00002417#endif
drh94a11212004-09-25 13:12:14 +00002418 }
drh0fcef5e2005-07-19 17:38:22 +00002419 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00002420 return iReg;
drh94a11212004-09-25 13:12:14 +00002421}
2422
drh51147ba2005-07-23 22:59:55 +00002423/*
2424** Generate code that will evaluate all == and IN constraints for an
drhcd8629e2013-11-13 12:27:25 +00002425** index scan.
drh51147ba2005-07-23 22:59:55 +00002426**
2427** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
2428** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
2429** The index has as many as three equality constraints, but in this
2430** example, the third "c" value is an inequality. So only two
2431** constraints are coded. This routine will generate code to evaluate
drh6df2acd2008-12-28 16:55:25 +00002432** a==5 and b IN (1,2,3). The current values for a and b will be stored
2433** in consecutive registers and the index of the first register is returned.
drh51147ba2005-07-23 22:59:55 +00002434**
2435** In the example above nEq==2. But this subroutine works for any value
2436** of nEq including 0. If nEq==0, this routine is nearly a no-op.
drh039fc322009-11-17 18:31:47 +00002437** The only thing it does is allocate the pLevel->iMem memory cell and
2438** compute the affinity string.
drh51147ba2005-07-23 22:59:55 +00002439**
drhcd8629e2013-11-13 12:27:25 +00002440** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
2441** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
2442** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
2443** occurs after the nEq quality constraints.
2444**
2445** This routine allocates a range of nEq+nExtraReg memory cells and returns
2446** the index of the first memory cell in that range. The code that
2447** calls this routine will use that memory range to store keys for
2448** start and termination conditions of the loop.
drh51147ba2005-07-23 22:59:55 +00002449** key value of the loop. If one or more IN operators appear, then
2450** this routine allocates an additional nEq memory cells for internal
2451** use.
dan69f8bb92009-08-13 19:21:16 +00002452**
2453** Before returning, *pzAff is set to point to a buffer containing a
2454** copy of the column affinity string of the index allocated using
2455** sqlite3DbMalloc(). Except, entries in the copy of the string associated
2456** with equality constraints that use NONE affinity are set to
2457** SQLITE_AFF_NONE. This is to deal with SQL such as the following:
2458**
2459** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
2460** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
2461**
2462** In the example above, the index on t1(a) has TEXT affinity. But since
2463** the right hand side of the equality constraint (t2.b) has NONE affinity,
2464** no conversion should be attempted before using a t2.b value as part of
2465** a key to search the index. Hence the first byte in the returned affinity
2466** string in this example would be set to SQLITE_AFF_NONE.
drh51147ba2005-07-23 22:59:55 +00002467*/
drh1db639c2008-01-17 02:36:28 +00002468static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00002469 Parse *pParse, /* Parsing context */
2470 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
drh7ba39a92013-05-30 17:43:19 +00002471 int bRev, /* Reverse the order of IN operators */
dan69f8bb92009-08-13 19:21:16 +00002472 int nExtraReg, /* Number of extra registers to allocate */
2473 char **pzAff /* OUT: Set to point to affinity string */
drh51147ba2005-07-23 22:59:55 +00002474){
drhcd8629e2013-11-13 12:27:25 +00002475 u16 nEq; /* The number of == or IN constraints to code */
2476 u16 nSkip; /* Number of left-most columns to skip */
drh111a6a72008-12-21 03:51:16 +00002477 Vdbe *v = pParse->pVdbe; /* The vm under construction */
2478 Index *pIdx; /* The index being used for this loop */
drh51147ba2005-07-23 22:59:55 +00002479 WhereTerm *pTerm; /* A single constraint term */
drh7ba39a92013-05-30 17:43:19 +00002480 WhereLoop *pLoop; /* The WhereLoop object */
drh51147ba2005-07-23 22:59:55 +00002481 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00002482 int regBase; /* Base register */
drh6df2acd2008-12-28 16:55:25 +00002483 int nReg; /* Number of registers to allocate */
dan69f8bb92009-08-13 19:21:16 +00002484 char *zAff; /* Affinity string to return */
drh51147ba2005-07-23 22:59:55 +00002485
drh111a6a72008-12-21 03:51:16 +00002486 /* This module is only called on query plans that use an index. */
drh7ba39a92013-05-30 17:43:19 +00002487 pLoop = pLevel->pWLoop;
2488 assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
2489 nEq = pLoop->u.btree.nEq;
drhcd8629e2013-11-13 12:27:25 +00002490 nSkip = pLoop->u.btree.nSkip;
drh7ba39a92013-05-30 17:43:19 +00002491 pIdx = pLoop->u.btree.pIndex;
2492 assert( pIdx!=0 );
drh111a6a72008-12-21 03:51:16 +00002493
drh51147ba2005-07-23 22:59:55 +00002494 /* Figure out how many memory cells we will need then allocate them.
drh51147ba2005-07-23 22:59:55 +00002495 */
drh700a2262008-12-17 19:22:15 +00002496 regBase = pParse->nMem + 1;
drh7ba39a92013-05-30 17:43:19 +00002497 nReg = pLoop->u.btree.nEq + nExtraReg;
drh6df2acd2008-12-28 16:55:25 +00002498 pParse->nMem += nReg;
drh51147ba2005-07-23 22:59:55 +00002499
dan69f8bb92009-08-13 19:21:16 +00002500 zAff = sqlite3DbStrDup(pParse->db, sqlite3IndexAffinityStr(v, pIdx));
2501 if( !zAff ){
2502 pParse->db->mallocFailed = 1;
2503 }
2504
drhcd8629e2013-11-13 12:27:25 +00002505 if( nSkip ){
2506 int iIdxCur = pLevel->iIdxCur;
drh7d176102014-02-18 03:07:12 +00002507 sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
2508 VdbeCoverageIf(v, bRev==0);
2509 VdbeCoverageIf(v, bRev!=0);
drhe084f402013-11-13 17:24:38 +00002510 VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
drh2e5ef4e2013-11-13 16:58:54 +00002511 j = sqlite3VdbeAddOp0(v, OP_Goto);
drh4a1d3652014-02-14 15:13:36 +00002512 pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
drh7d176102014-02-18 03:07:12 +00002513 iIdxCur, 0, regBase, nSkip);
2514 VdbeCoverageIf(v, bRev==0);
2515 VdbeCoverageIf(v, bRev!=0);
drh2e5ef4e2013-11-13 16:58:54 +00002516 sqlite3VdbeJumpHere(v, j);
drhcd8629e2013-11-13 12:27:25 +00002517 for(j=0; j<nSkip; j++){
2518 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
2519 assert( pIdx->aiColumn[j]>=0 );
2520 VdbeComment((v, "%s", pIdx->pTable->aCol[pIdx->aiColumn[j]].zName));
2521 }
2522 }
2523
drh51147ba2005-07-23 22:59:55 +00002524 /* Evaluate the equality constraints
2525 */
mistachkinf6418892013-08-28 01:54:12 +00002526 assert( zAff==0 || (int)strlen(zAff)>=nEq );
drhcd8629e2013-11-13 12:27:25 +00002527 for(j=nSkip; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00002528 int r1;
drh4efc9292013-06-06 23:02:03 +00002529 pTerm = pLoop->aLTerm[j];
drh7ba39a92013-05-30 17:43:19 +00002530 assert( pTerm!=0 );
drhcd8629e2013-11-13 12:27:25 +00002531 /* The following testcase is true for indices with redundant columns.
drhbe837bd2010-04-30 21:03:24 +00002532 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
2533 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
drh39759742013-08-02 23:40:45 +00002534 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh7ba39a92013-05-30 17:43:19 +00002535 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
drh678ccce2008-03-31 18:19:54 +00002536 if( r1!=regBase+j ){
drh6df2acd2008-12-28 16:55:25 +00002537 if( nReg==1 ){
2538 sqlite3ReleaseTempReg(pParse, regBase);
2539 regBase = r1;
2540 }else{
2541 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
2542 }
drh678ccce2008-03-31 18:19:54 +00002543 }
drh981642f2008-04-19 14:40:43 +00002544 testcase( pTerm->eOperator & WO_ISNULL );
2545 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00002546 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drh039fc322009-11-17 18:31:47 +00002547 Expr *pRight = pTerm->pExpr->pRight;
drh7d176102014-02-18 03:07:12 +00002548 if( sqlite3ExprCanBeNull(pRight) ){
2549 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
2550 VdbeCoverage(v);
2551 }
drh039fc322009-11-17 18:31:47 +00002552 if( zAff ){
2553 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_NONE ){
2554 zAff[j] = SQLITE_AFF_NONE;
2555 }
2556 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
2557 zAff[j] = SQLITE_AFF_NONE;
2558 }
dan69f8bb92009-08-13 19:21:16 +00002559 }
drh51147ba2005-07-23 22:59:55 +00002560 }
2561 }
dan69f8bb92009-08-13 19:21:16 +00002562 *pzAff = zAff;
drh1db639c2008-01-17 02:36:28 +00002563 return regBase;
drh51147ba2005-07-23 22:59:55 +00002564}
2565
dan2ce22452010-11-08 19:01:16 +00002566#ifndef SQLITE_OMIT_EXPLAIN
dan17c0bc02010-11-09 17:35:19 +00002567/*
drh69174c42010-11-12 15:35:59 +00002568** This routine is a helper for explainIndexRange() below
2569**
2570** pStr holds the text of an expression that we are building up one term
2571** at a time. This routine adds a new term to the end of the expression.
2572** Terms are separated by AND so add the "AND" text for second and subsequent
2573** terms only.
2574*/
2575static void explainAppendTerm(
2576 StrAccum *pStr, /* The text expression being built */
2577 int iTerm, /* Index of this term. First is zero */
2578 const char *zColumn, /* Name of the column */
2579 const char *zOp /* Name of the operator */
2580){
2581 if( iTerm ) sqlite3StrAccumAppend(pStr, " AND ", 5);
drha6353a32013-12-09 19:03:26 +00002582 sqlite3StrAccumAppendAll(pStr, zColumn);
drh69174c42010-11-12 15:35:59 +00002583 sqlite3StrAccumAppend(pStr, zOp, 1);
2584 sqlite3StrAccumAppend(pStr, "?", 1);
2585}
2586
2587/*
dan17c0bc02010-11-09 17:35:19 +00002588** Argument pLevel describes a strategy for scanning table pTab. This
2589** function returns a pointer to a string buffer containing a description
2590** of the subset of table rows scanned by the strategy in the form of an
2591** SQL expression. Or, if all rows are scanned, NULL is returned.
2592**
2593** For example, if the query:
2594**
2595** SELECT * FROM t1 WHERE a=1 AND b>2;
2596**
2597** is run and there is an index on (a, b), then this function returns a
2598** string similar to:
2599**
2600** "a=? AND b>?"
2601**
2602** The returned pointer points to memory obtained from sqlite3DbMalloc().
2603** It is the responsibility of the caller to free the buffer when it is
2604** no longer required.
2605*/
drhef866372013-05-22 20:49:02 +00002606static char *explainIndexRange(sqlite3 *db, WhereLoop *pLoop, Table *pTab){
2607 Index *pIndex = pLoop->u.btree.pIndex;
drhcd8629e2013-11-13 12:27:25 +00002608 u16 nEq = pLoop->u.btree.nEq;
2609 u16 nSkip = pLoop->u.btree.nSkip;
drh69174c42010-11-12 15:35:59 +00002610 int i, j;
2611 Column *aCol = pTab->aCol;
drhbbbdc832013-10-22 18:01:40 +00002612 i16 *aiColumn = pIndex->aiColumn;
drh69174c42010-11-12 15:35:59 +00002613 StrAccum txt;
dan2ce22452010-11-08 19:01:16 +00002614
drhef866372013-05-22 20:49:02 +00002615 if( nEq==0 && (pLoop->wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ){
drh69174c42010-11-12 15:35:59 +00002616 return 0;
2617 }
2618 sqlite3StrAccumInit(&txt, 0, 0, SQLITE_MAX_LENGTH);
drh03b6df12010-11-15 16:29:30 +00002619 txt.db = db;
drh69174c42010-11-12 15:35:59 +00002620 sqlite3StrAccumAppend(&txt, " (", 2);
dan2ce22452010-11-08 19:01:16 +00002621 for(i=0; i<nEq; i++){
drhbbbdc832013-10-22 18:01:40 +00002622 char *z = (i==pIndex->nKeyCol ) ? "rowid" : aCol[aiColumn[i]].zName;
drhcd8629e2013-11-13 12:27:25 +00002623 if( i>=nSkip ){
2624 explainAppendTerm(&txt, i, z, "=");
2625 }else{
2626 if( i ) sqlite3StrAccumAppend(&txt, " AND ", 5);
2627 sqlite3StrAccumAppend(&txt, "ANY(", 4);
drha6353a32013-12-09 19:03:26 +00002628 sqlite3StrAccumAppendAll(&txt, z);
drhcd8629e2013-11-13 12:27:25 +00002629 sqlite3StrAccumAppend(&txt, ")", 1);
2630 }
dan2ce22452010-11-08 19:01:16 +00002631 }
2632
drh69174c42010-11-12 15:35:59 +00002633 j = i;
drhef866372013-05-22 20:49:02 +00002634 if( pLoop->wsFlags&WHERE_BTM_LIMIT ){
drhbbbdc832013-10-22 18:01:40 +00002635 char *z = (j==pIndex->nKeyCol ) ? "rowid" : aCol[aiColumn[j]].zName;
dan0c733f62011-11-16 15:27:09 +00002636 explainAppendTerm(&txt, i++, z, ">");
dan2ce22452010-11-08 19:01:16 +00002637 }
drhef866372013-05-22 20:49:02 +00002638 if( pLoop->wsFlags&WHERE_TOP_LIMIT ){
drhbbbdc832013-10-22 18:01:40 +00002639 char *z = (j==pIndex->nKeyCol ) ? "rowid" : aCol[aiColumn[j]].zName;
dan0c733f62011-11-16 15:27:09 +00002640 explainAppendTerm(&txt, i, z, "<");
dan2ce22452010-11-08 19:01:16 +00002641 }
drh69174c42010-11-12 15:35:59 +00002642 sqlite3StrAccumAppend(&txt, ")", 1);
2643 return sqlite3StrAccumFinish(&txt);
dan2ce22452010-11-08 19:01:16 +00002644}
2645
dan17c0bc02010-11-09 17:35:19 +00002646/*
2647** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
2648** command. If the query being compiled is an EXPLAIN QUERY PLAN, a single
2649** record is added to the output to describe the table scan strategy in
2650** pLevel.
2651*/
2652static void explainOneScan(
dan2ce22452010-11-08 19:01:16 +00002653 Parse *pParse, /* Parse context */
2654 SrcList *pTabList, /* Table list this loop refers to */
2655 WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
2656 int iLevel, /* Value for "level" column of output */
dan4a07e3d2010-11-09 14:48:59 +00002657 int iFrom, /* Value for "from" column of output */
2658 u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
dan2ce22452010-11-08 19:01:16 +00002659){
drh84e55a82013-11-13 17:58:23 +00002660#ifndef SQLITE_DEBUG
2661 if( pParse->explain==2 )
2662#endif
2663 {
dan2ce22452010-11-08 19:01:16 +00002664 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
dan17c0bc02010-11-09 17:35:19 +00002665 Vdbe *v = pParse->pVdbe; /* VM being constructed */
2666 sqlite3 *db = pParse->db; /* Database handle */
2667 char *zMsg; /* Text to add to EQP output */
dan4a07e3d2010-11-09 14:48:59 +00002668 int iId = pParse->iSelectId; /* Select id (left-most output column) */
dan4bc39fa2010-11-13 16:42:27 +00002669 int isSearch; /* True for a SEARCH. False for SCAN. */
drhef866372013-05-22 20:49:02 +00002670 WhereLoop *pLoop; /* The controlling WhereLoop object */
2671 u32 flags; /* Flags that describe this loop */
dan2ce22452010-11-08 19:01:16 +00002672
drhef866372013-05-22 20:49:02 +00002673 pLoop = pLevel->pWLoop;
2674 flags = pLoop->wsFlags;
dan4a07e3d2010-11-09 14:48:59 +00002675 if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_ONETABLE_ONLY) ) return;
dan2ce22452010-11-08 19:01:16 +00002676
drhef866372013-05-22 20:49:02 +00002677 isSearch = (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
2678 || ((flags&WHERE_VIRTUALTABLE)==0 && (pLoop->u.btree.nEq>0))
2679 || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
dan4bc39fa2010-11-13 16:42:27 +00002680
2681 zMsg = sqlite3MPrintf(db, "%s", isSearch?"SEARCH":"SCAN");
dan4a07e3d2010-11-09 14:48:59 +00002682 if( pItem->pSelect ){
dan4bc39fa2010-11-13 16:42:27 +00002683 zMsg = sqlite3MAppendf(db, zMsg, "%s SUBQUERY %d", zMsg,pItem->iSelectId);
dan4a07e3d2010-11-09 14:48:59 +00002684 }else{
dan4bc39fa2010-11-13 16:42:27 +00002685 zMsg = sqlite3MAppendf(db, zMsg, "%s TABLE %s", zMsg, pItem->zName);
dan4a07e3d2010-11-09 14:48:59 +00002686 }
2687
dan2ce22452010-11-08 19:01:16 +00002688 if( pItem->zAlias ){
2689 zMsg = sqlite3MAppendf(db, zMsg, "%s AS %s", zMsg, pItem->zAlias);
2690 }
drhef866372013-05-22 20:49:02 +00002691 if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0
drh7963b0e2013-06-17 21:37:40 +00002692 && ALWAYS(pLoop->u.btree.pIndex!=0)
drhef866372013-05-22 20:49:02 +00002693 ){
2694 char *zWhere = explainIndexRange(db, pLoop, pItem->pTab);
drh986b3872013-06-28 21:12:20 +00002695 zMsg = sqlite3MAppendf(db, zMsg,
2696 ((flags & WHERE_AUTO_INDEX) ?
2697 "%s USING AUTOMATIC %sINDEX%.0s%s" :
2698 "%s USING %sINDEX %s%s"),
2699 zMsg, ((flags & WHERE_IDX_ONLY) ? "COVERING " : ""),
2700 pLoop->u.btree.pIndex->zName, zWhere);
dan2ce22452010-11-08 19:01:16 +00002701 sqlite3DbFree(db, zWhere);
drhef71c1f2013-06-04 12:58:02 +00002702 }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
dan4bc39fa2010-11-13 16:42:27 +00002703 zMsg = sqlite3MAppendf(db, zMsg, "%s USING INTEGER PRIMARY KEY", zMsg);
dan2ce22452010-11-08 19:01:16 +00002704
drh8e23daf2013-06-11 13:30:04 +00002705 if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
dan2ce22452010-11-08 19:01:16 +00002706 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid=?)", zMsg);
drh04098e62010-11-15 21:50:19 +00002707 }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
dan2ce22452010-11-08 19:01:16 +00002708 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid>? AND rowid<?)", zMsg);
2709 }else if( flags&WHERE_BTM_LIMIT ){
2710 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid>?)", zMsg);
drh7963b0e2013-06-17 21:37:40 +00002711 }else if( ALWAYS(flags&WHERE_TOP_LIMIT) ){
dan2ce22452010-11-08 19:01:16 +00002712 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid<?)", zMsg);
2713 }
2714 }
2715#ifndef SQLITE_OMIT_VIRTUALTABLE
2716 else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
dan2ce22452010-11-08 19:01:16 +00002717 zMsg = sqlite3MAppendf(db, zMsg, "%s VIRTUAL TABLE INDEX %d:%s", zMsg,
drhef866372013-05-22 20:49:02 +00002718 pLoop->u.vtab.idxNum, pLoop->u.vtab.idxStr);
dan2ce22452010-11-08 19:01:16 +00002719 }
2720#endif
drhb8a8e8a2013-06-10 19:12:39 +00002721 zMsg = sqlite3MAppendf(db, zMsg, "%s", zMsg);
dan4a07e3d2010-11-09 14:48:59 +00002722 sqlite3VdbeAddOp4(v, OP_Explain, iId, iLevel, iFrom, zMsg, P4_DYNAMIC);
dan2ce22452010-11-08 19:01:16 +00002723 }
2724}
2725#else
dan17c0bc02010-11-09 17:35:19 +00002726# define explainOneScan(u,v,w,x,y,z)
dan2ce22452010-11-08 19:01:16 +00002727#endif /* SQLITE_OMIT_EXPLAIN */
2728
2729
drh111a6a72008-12-21 03:51:16 +00002730/*
2731** Generate code for the start of the iLevel-th loop in the WHERE clause
2732** implementation described by pWInfo.
2733*/
2734static Bitmask codeOneLoopStart(
2735 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
2736 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh7a484802012-03-16 00:28:11 +00002737 Bitmask notReady /* Which tables are currently available */
drh111a6a72008-12-21 03:51:16 +00002738){
2739 int j, k; /* Loop counters */
2740 int iCur; /* The VDBE cursor for the table */
2741 int addrNxt; /* Where to jump to continue with the next IN case */
2742 int omitTable; /* True if we use the index only */
2743 int bRev; /* True if we need to scan in reverse order */
2744 WhereLevel *pLevel; /* The where level to be coded */
drh7ba39a92013-05-30 17:43:19 +00002745 WhereLoop *pLoop; /* The WhereLoop object being coded */
drh111a6a72008-12-21 03:51:16 +00002746 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
2747 WhereTerm *pTerm; /* A WHERE clause term */
2748 Parse *pParse; /* Parsing context */
drh6b36e822013-07-30 15:10:32 +00002749 sqlite3 *db; /* Database connection */
drh111a6a72008-12-21 03:51:16 +00002750 Vdbe *v; /* The prepared stmt under constructions */
2751 struct SrcList_item *pTabItem; /* FROM clause term being coded */
drh23d04d52008-12-23 23:56:22 +00002752 int addrBrk; /* Jump here to break out of the loop */
2753 int addrCont; /* Jump here to continue with next cycle */
drh61495262009-04-22 15:32:59 +00002754 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
2755 int iReleaseReg = 0; /* Temp register to free before returning */
drh111a6a72008-12-21 03:51:16 +00002756
2757 pParse = pWInfo->pParse;
2758 v = pParse->pVdbe;
drh70d18342013-06-06 19:16:33 +00002759 pWC = &pWInfo->sWC;
drh6b36e822013-07-30 15:10:32 +00002760 db = pParse->db;
drh111a6a72008-12-21 03:51:16 +00002761 pLevel = &pWInfo->a[iLevel];
drh7ba39a92013-05-30 17:43:19 +00002762 pLoop = pLevel->pWLoop;
drh111a6a72008-12-21 03:51:16 +00002763 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
2764 iCur = pTabItem->iCursor;
drh0259bc32013-09-09 19:37:46 +00002765 pLevel->notReady = notReady & ~getMask(&pWInfo->sMaskSet, iCur);
drh7ba39a92013-05-30 17:43:19 +00002766 bRev = (pWInfo->revMask>>iLevel)&1;
2767 omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
drh70d18342013-06-06 19:16:33 +00002768 && (pWInfo->wctrlFlags & WHERE_FORCE_TABLE)==0;
drh6bc69a22013-11-19 12:33:23 +00002769 VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
drh111a6a72008-12-21 03:51:16 +00002770
2771 /* Create labels for the "break" and "continue" instructions
2772 ** for the current loop. Jump to addrBrk to break out of a loop.
2773 ** Jump to cont to go immediately to the next iteration of the
2774 ** loop.
2775 **
2776 ** When there is an IN operator, we also have a "addrNxt" label that
2777 ** means to continue with the next IN value combination. When
2778 ** there are no IN operators in the constraints, the "addrNxt" label
2779 ** is the same as "addrBrk".
2780 */
2781 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
2782 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
2783
2784 /* If this is the right table of a LEFT OUTER JOIN, allocate and
2785 ** initialize a memory cell that records if this table matches any
2786 ** row of the left table of the join.
2787 */
2788 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
2789 pLevel->iLeftJoin = ++pParse->nMem;
2790 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
2791 VdbeComment((v, "init LEFT JOIN no-match flag"));
2792 }
2793
drh21172c42012-10-30 00:29:07 +00002794 /* Special case of a FROM clause subquery implemented as a co-routine */
2795 if( pTabItem->viaCoroutine ){
2796 int regYield = pTabItem->regReturn;
drhed71a832014-02-07 19:18:10 +00002797 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
drh81cf13e2014-02-07 18:27:53 +00002798 pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
drh688852a2014-02-17 22:40:43 +00002799 VdbeCoverage(v);
drh725de292014-02-08 13:12:19 +00002800 VdbeComment((v, "next row of \"%s\"", pTabItem->pTab->zName));
drh21172c42012-10-30 00:29:07 +00002801 pLevel->op = OP_Goto;
2802 }else
2803
drh111a6a72008-12-21 03:51:16 +00002804#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7ba39a92013-05-30 17:43:19 +00002805 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
2806 /* Case 1: The table is a virtual-table. Use the VFilter and VNext
drh111a6a72008-12-21 03:51:16 +00002807 ** to access the data.
2808 */
2809 int iReg; /* P3 Value for OP_VFilter */
drh281bbe22012-10-16 23:17:14 +00002810 int addrNotFound;
drh4efc9292013-06-06 23:02:03 +00002811 int nConstraint = pLoop->nLTerm;
drh111a6a72008-12-21 03:51:16 +00002812
drha62bb8d2009-11-23 21:23:45 +00002813 sqlite3ExprCachePush(pParse);
drh111a6a72008-12-21 03:51:16 +00002814 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
drh281bbe22012-10-16 23:17:14 +00002815 addrNotFound = pLevel->addrBrk;
drh111a6a72008-12-21 03:51:16 +00002816 for(j=0; j<nConstraint; j++){
drhe2250172013-05-31 18:13:50 +00002817 int iTarget = iReg+j+2;
drh4efc9292013-06-06 23:02:03 +00002818 pTerm = pLoop->aLTerm[j];
drh95ed68d2013-06-12 17:55:50 +00002819 if( pTerm==0 ) continue;
drh7ba39a92013-05-30 17:43:19 +00002820 if( pTerm->eOperator & WO_IN ){
2821 codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
2822 addrNotFound = pLevel->addrNxt;
2823 }else{
2824 sqlite3ExprCode(pParse, pTerm->pExpr->pRight, iTarget);
2825 }
2826 }
2827 sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
drh7e47cb82013-05-31 17:55:27 +00002828 sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
drh7ba39a92013-05-30 17:43:19 +00002829 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
2830 pLoop->u.vtab.idxStr,
2831 pLoop->u.vtab.needFree ? P4_MPRINTF : P4_STATIC);
drh688852a2014-02-17 22:40:43 +00002832 VdbeCoverage(v);
drh7ba39a92013-05-30 17:43:19 +00002833 pLoop->u.vtab.needFree = 0;
2834 for(j=0; j<nConstraint && j<16; j++){
2835 if( (pLoop->u.vtab.omitMask>>j)&1 ){
drh4efc9292013-06-06 23:02:03 +00002836 disableTerm(pLevel, pLoop->aLTerm[j]);
drh111a6a72008-12-21 03:51:16 +00002837 }
2838 }
2839 pLevel->op = OP_VNext;
2840 pLevel->p1 = iCur;
2841 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh23d04d52008-12-23 23:56:22 +00002842 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drha62bb8d2009-11-23 21:23:45 +00002843 sqlite3ExprCachePop(pParse, 1);
drh111a6a72008-12-21 03:51:16 +00002844 }else
2845#endif /* SQLITE_OMIT_VIRTUALTABLE */
2846
drh7ba39a92013-05-30 17:43:19 +00002847 if( (pLoop->wsFlags & WHERE_IPK)!=0
2848 && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
2849 ){
2850 /* Case 2: We can directly reference a single row using an
drh111a6a72008-12-21 03:51:16 +00002851 ** equality comparison against the ROWID field. Or
2852 ** we reference multiple rows using a "rowid IN (...)"
2853 ** construct.
2854 */
drh7ba39a92013-05-30 17:43:19 +00002855 assert( pLoop->u.btree.nEq==1 );
drh4efc9292013-06-06 23:02:03 +00002856 pTerm = pLoop->aLTerm[0];
drh111a6a72008-12-21 03:51:16 +00002857 assert( pTerm!=0 );
2858 assert( pTerm->pExpr!=0 );
drh111a6a72008-12-21 03:51:16 +00002859 assert( omitTable==0 );
drh39759742013-08-02 23:40:45 +00002860 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh0baa0352014-02-25 21:55:16 +00002861 iReleaseReg = ++pParse->nMem;
drh7ba39a92013-05-30 17:43:19 +00002862 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
drh0baa0352014-02-25 21:55:16 +00002863 if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
drh111a6a72008-12-21 03:51:16 +00002864 addrNxt = pLevel->addrNxt;
drh688852a2014-02-17 22:40:43 +00002865 sqlite3VdbeAddOp2(v, OP_MustBeInt, iRowidReg, addrNxt); VdbeCoverage(v);
danielk19771d461462009-04-21 09:02:45 +00002866 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, iRowidReg);
drh688852a2014-02-17 22:40:43 +00002867 VdbeCoverage(v);
drh459f63e2013-03-06 01:55:27 +00002868 sqlite3ExprCacheAffinityChange(pParse, iRowidReg, 1);
drhceea3322009-04-23 13:22:42 +00002869 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
drh111a6a72008-12-21 03:51:16 +00002870 VdbeComment((v, "pk"));
2871 pLevel->op = OP_Noop;
drh7ba39a92013-05-30 17:43:19 +00002872 }else if( (pLoop->wsFlags & WHERE_IPK)!=0
2873 && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
2874 ){
2875 /* Case 3: We have an inequality comparison against the ROWID field.
drh111a6a72008-12-21 03:51:16 +00002876 */
2877 int testOp = OP_Noop;
2878 int start;
2879 int memEndValue = 0;
2880 WhereTerm *pStart, *pEnd;
2881
2882 assert( omitTable==0 );
drh7ba39a92013-05-30 17:43:19 +00002883 j = 0;
2884 pStart = pEnd = 0;
drh4efc9292013-06-06 23:02:03 +00002885 if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
2886 if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
drh81186b42013-06-18 01:52:41 +00002887 assert( pStart!=0 || pEnd!=0 );
drh111a6a72008-12-21 03:51:16 +00002888 if( bRev ){
2889 pTerm = pStart;
2890 pStart = pEnd;
2891 pEnd = pTerm;
2892 }
2893 if( pStart ){
2894 Expr *pX; /* The expression that defines the start bound */
2895 int r1, rTemp; /* Registers for holding the start boundary */
2896
2897 /* The following constant maps TK_xx codes into corresponding
2898 ** seek opcodes. It depends on a particular ordering of TK_xx
2899 */
2900 const u8 aMoveOp[] = {
drh4a1d3652014-02-14 15:13:36 +00002901 /* TK_GT */ OP_SeekGT,
2902 /* TK_LE */ OP_SeekLE,
2903 /* TK_LT */ OP_SeekLT,
2904 /* TK_GE */ OP_SeekGE
drh111a6a72008-12-21 03:51:16 +00002905 };
2906 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
2907 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
2908 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
2909
drhb5246e52013-07-08 21:12:57 +00002910 assert( (pStart->wtFlags & TERM_VNULL)==0 );
drh39759742013-08-02 23:40:45 +00002911 testcase( pStart->wtFlags & TERM_VIRTUAL );
drh111a6a72008-12-21 03:51:16 +00002912 pX = pStart->pExpr;
2913 assert( pX!=0 );
drhb5246e52013-07-08 21:12:57 +00002914 testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
drh111a6a72008-12-21 03:51:16 +00002915 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
2916 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
drh7d176102014-02-18 03:07:12 +00002917 VdbeComment((v, "pk"));
2918 VdbeCoverageIf(v, pX->op==TK_GT);
2919 VdbeCoverageIf(v, pX->op==TK_LE);
2920 VdbeCoverageIf(v, pX->op==TK_LT);
2921 VdbeCoverageIf(v, pX->op==TK_GE);
drh111a6a72008-12-21 03:51:16 +00002922 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
2923 sqlite3ReleaseTempReg(pParse, rTemp);
2924 disableTerm(pLevel, pStart);
2925 }else{
2926 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
drh7d176102014-02-18 03:07:12 +00002927 VdbeCoverageIf(v, bRev==0);
2928 VdbeCoverageIf(v, bRev!=0);
drh111a6a72008-12-21 03:51:16 +00002929 }
2930 if( pEnd ){
2931 Expr *pX;
2932 pX = pEnd->pExpr;
2933 assert( pX!=0 );
drhb5246e52013-07-08 21:12:57 +00002934 assert( (pEnd->wtFlags & TERM_VNULL)==0 );
2935 testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
drh39759742013-08-02 23:40:45 +00002936 testcase( pEnd->wtFlags & TERM_VIRTUAL );
drh111a6a72008-12-21 03:51:16 +00002937 memEndValue = ++pParse->nMem;
2938 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
2939 if( pX->op==TK_LT || pX->op==TK_GT ){
2940 testOp = bRev ? OP_Le : OP_Ge;
2941 }else{
2942 testOp = bRev ? OP_Lt : OP_Gt;
2943 }
2944 disableTerm(pLevel, pEnd);
2945 }
2946 start = sqlite3VdbeCurrentAddr(v);
2947 pLevel->op = bRev ? OP_Prev : OP_Next;
2948 pLevel->p1 = iCur;
2949 pLevel->p2 = start;
drh81186b42013-06-18 01:52:41 +00002950 assert( pLevel->p5==0 );
danielk19771d461462009-04-21 09:02:45 +00002951 if( testOp!=OP_Noop ){
drh0baa0352014-02-25 21:55:16 +00002952 iRowidReg = ++pParse->nMem;
danielk19771d461462009-04-21 09:02:45 +00002953 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00002954 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00002955 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
drh7d176102014-02-18 03:07:12 +00002956 VdbeCoverageIf(v, testOp==OP_Le);
2957 VdbeCoverageIf(v, testOp==OP_Lt);
2958 VdbeCoverageIf(v, testOp==OP_Ge);
2959 VdbeCoverageIf(v, testOp==OP_Gt);
danielk19771d461462009-04-21 09:02:45 +00002960 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00002961 }
drh1b0f0262013-05-30 22:27:09 +00002962 }else if( pLoop->wsFlags & WHERE_INDEXED ){
drh7ba39a92013-05-30 17:43:19 +00002963 /* Case 4: A scan using an index.
drh111a6a72008-12-21 03:51:16 +00002964 **
2965 ** The WHERE clause may contain zero or more equality
2966 ** terms ("==" or "IN" operators) that refer to the N
2967 ** left-most columns of the index. It may also contain
2968 ** inequality constraints (>, <, >= or <=) on the indexed
2969 ** column that immediately follows the N equalities. Only
2970 ** the right-most column can be an inequality - the rest must
2971 ** use the "==" and "IN" operators. For example, if the
2972 ** index is on (x,y,z), then the following clauses are all
2973 ** optimized:
2974 **
2975 ** x=5
2976 ** x=5 AND y=10
2977 ** x=5 AND y<10
2978 ** x=5 AND y>5 AND y<10
2979 ** x=5 AND y=5 AND z<=10
2980 **
2981 ** The z<10 term of the following cannot be used, only
2982 ** the x=5 term:
2983 **
2984 ** x=5 AND z<10
2985 **
2986 ** N may be zero if there are inequality constraints.
2987 ** If there are no inequality constraints, then N is at
2988 ** least one.
2989 **
2990 ** This case is also used when there are no WHERE clause
2991 ** constraints but an index is selected anyway, in order
2992 ** to force the output order to conform to an ORDER BY.
2993 */
drh3bb9b932010-08-06 02:10:00 +00002994 static const u8 aStartOp[] = {
drh111a6a72008-12-21 03:51:16 +00002995 0,
2996 0,
2997 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
2998 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
drh4a1d3652014-02-14 15:13:36 +00002999 OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
3000 OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
3001 OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
3002 OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
drh111a6a72008-12-21 03:51:16 +00003003 };
drh3bb9b932010-08-06 02:10:00 +00003004 static const u8 aEndOp[] = {
drh4a1d3652014-02-14 15:13:36 +00003005 OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
3006 OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
3007 OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
3008 OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
drh111a6a72008-12-21 03:51:16 +00003009 };
drhcd8629e2013-11-13 12:27:25 +00003010 u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
drh111a6a72008-12-21 03:51:16 +00003011 int regBase; /* Base register holding constraint values */
drh111a6a72008-12-21 03:51:16 +00003012 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
3013 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
3014 int startEq; /* True if range start uses ==, >= or <= */
3015 int endEq; /* True if range end uses ==, >= or <= */
3016 int start_constraints; /* Start of range is constrained */
3017 int nConstraint; /* Number of constraint terms */
drh3bb9b932010-08-06 02:10:00 +00003018 Index *pIdx; /* The index we will be using */
3019 int iIdxCur; /* The VDBE cursor for the index */
3020 int nExtraReg = 0; /* Number of extra registers needed */
3021 int op; /* Instruction opcode */
dan6ac43392010-06-09 15:47:11 +00003022 char *zStartAff; /* Affinity for start of range constraint */
drh33cad2f2013-11-15 12:41:01 +00003023 char cEndAff = 0; /* Affinity for end of range constraint */
drhcfc6ca42014-02-14 23:49:13 +00003024 u8 bSeekPastNull = 0; /* True to seek past initial nulls */
3025 u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
drh111a6a72008-12-21 03:51:16 +00003026
drh7ba39a92013-05-30 17:43:19 +00003027 pIdx = pLoop->u.btree.pIndex;
drh111a6a72008-12-21 03:51:16 +00003028 iIdxCur = pLevel->iIdxCur;
drh052e6a82013-11-14 19:34:10 +00003029 assert( nEq>=pLoop->u.btree.nSkip );
drh111a6a72008-12-21 03:51:16 +00003030
drh111a6a72008-12-21 03:51:16 +00003031 /* If this loop satisfies a sort order (pOrderBy) request that
3032 ** was passed to this function to implement a "SELECT min(x) ..."
3033 ** query, then the caller will only allow the loop to run for
3034 ** a single iteration. This means that the first row returned
3035 ** should not have a NULL value stored in 'x'. If column 'x' is
3036 ** the first one after the nEq equality constraints in the index,
3037 ** this requires some special handling.
3038 */
drhddba0c22014-03-18 20:33:42 +00003039 assert( pWInfo->pOrderBy==0
3040 || pWInfo->pOrderBy->nExpr==1
3041 || (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)==0 );
drh70d18342013-06-06 19:16:33 +00003042 if( (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)!=0
drhddba0c22014-03-18 20:33:42 +00003043 && pWInfo->nOBSat>0
drhbbbdc832013-10-22 18:01:40 +00003044 && (pIdx->nKeyCol>nEq)
drh111a6a72008-12-21 03:51:16 +00003045 ){
drh052e6a82013-11-14 19:34:10 +00003046 assert( pLoop->u.btree.nSkip==0 );
drhcfc6ca42014-02-14 23:49:13 +00003047 bSeekPastNull = 1;
drh6df2acd2008-12-28 16:55:25 +00003048 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00003049 }
3050
3051 /* Find any inequality constraint terms for the start and end
3052 ** of the range.
3053 */
drh7ba39a92013-05-30 17:43:19 +00003054 j = nEq;
3055 if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
drh4efc9292013-06-06 23:02:03 +00003056 pRangeStart = pLoop->aLTerm[j++];
drh6df2acd2008-12-28 16:55:25 +00003057 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00003058 }
drh7ba39a92013-05-30 17:43:19 +00003059 if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
drh4efc9292013-06-06 23:02:03 +00003060 pRangeEnd = pLoop->aLTerm[j++];
drh6df2acd2008-12-28 16:55:25 +00003061 nExtraReg = 1;
drhcfc6ca42014-02-14 23:49:13 +00003062 if( pRangeStart==0
drhcfc6ca42014-02-14 23:49:13 +00003063 && (j = pIdx->aiColumn[nEq])>=0
3064 && pIdx->pTable->aCol[j].notNull==0
3065 ){
3066 bSeekPastNull = 1;
3067 }
drh111a6a72008-12-21 03:51:16 +00003068 }
dan0df163a2014-03-06 12:36:26 +00003069 assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
drh111a6a72008-12-21 03:51:16 +00003070
drh6df2acd2008-12-28 16:55:25 +00003071 /* Generate code to evaluate all constraint terms using == or IN
3072 ** and store the values of those terms in an array of registers
3073 ** starting at regBase.
3074 */
drh613ba1e2013-06-15 15:11:45 +00003075 regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
drh33cad2f2013-11-15 12:41:01 +00003076 assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
3077 if( zStartAff ) cEndAff = zStartAff[nEq];
drh6df2acd2008-12-28 16:55:25 +00003078 addrNxt = pLevel->addrNxt;
3079
drh111a6a72008-12-21 03:51:16 +00003080 /* If we are doing a reverse order scan on an ascending index, or
3081 ** a forward order scan on a descending index, interchange the
3082 ** start and end terms (pRangeStart and pRangeEnd).
3083 */
drhbbbdc832013-10-22 18:01:40 +00003084 if( (nEq<pIdx->nKeyCol && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
3085 || (bRev && pIdx->nKeyCol==nEq)
dan0c733f62011-11-16 15:27:09 +00003086 ){
drh111a6a72008-12-21 03:51:16 +00003087 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
drhcfc6ca42014-02-14 23:49:13 +00003088 SWAP(u8, bSeekPastNull, bStopAtNull);
drh111a6a72008-12-21 03:51:16 +00003089 }
3090
drh7963b0e2013-06-17 21:37:40 +00003091 testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
3092 testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
3093 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
3094 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
drh111a6a72008-12-21 03:51:16 +00003095 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
3096 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
3097 start_constraints = pRangeStart || nEq>0;
3098
3099 /* Seek the index cursor to the start of the range. */
3100 nConstraint = nEq;
3101 if( pRangeStart ){
dan69f8bb92009-08-13 19:21:16 +00003102 Expr *pRight = pRangeStart->pExpr->pRight;
3103 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh7d176102014-02-18 03:07:12 +00003104 if( (pRangeStart->wtFlags & TERM_VNULL)==0
3105 && sqlite3ExprCanBeNull(pRight)
3106 ){
3107 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
3108 VdbeCoverage(v);
drh534230c2011-01-22 00:10:45 +00003109 }
dan6ac43392010-06-09 15:47:11 +00003110 if( zStartAff ){
3111 if( sqlite3CompareAffinity(pRight, zStartAff[nEq])==SQLITE_AFF_NONE){
drh039fc322009-11-17 18:31:47 +00003112 /* Since the comparison is to be performed with no conversions
3113 ** applied to the operands, set the affinity to apply to pRight to
3114 ** SQLITE_AFF_NONE. */
dan6ac43392010-06-09 15:47:11 +00003115 zStartAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00003116 }
dan6ac43392010-06-09 15:47:11 +00003117 if( sqlite3ExprNeedsNoAffinityChange(pRight, zStartAff[nEq]) ){
3118 zStartAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00003119 }
3120 }
drh111a6a72008-12-21 03:51:16 +00003121 nConstraint++;
drh39759742013-08-02 23:40:45 +00003122 testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
drhcfc6ca42014-02-14 23:49:13 +00003123 }else if( bSeekPastNull ){
drh111a6a72008-12-21 03:51:16 +00003124 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
3125 nConstraint++;
3126 startEq = 0;
3127 start_constraints = 1;
3128 }
drhcfc6ca42014-02-14 23:49:13 +00003129 codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
drh111a6a72008-12-21 03:51:16 +00003130 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
3131 assert( op!=0 );
drh8cff69d2009-11-12 19:59:44 +00003132 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh688852a2014-02-17 22:40:43 +00003133 VdbeCoverage(v);
drh7d176102014-02-18 03:07:12 +00003134 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
3135 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
3136 VdbeCoverageIf(v, op==OP_SeekGT); testcase( op==OP_SeekGT );
3137 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
3138 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
3139 VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
drh111a6a72008-12-21 03:51:16 +00003140
3141 /* Load the value for the inequality constraint at the end of the
3142 ** range (if any).
3143 */
3144 nConstraint = nEq;
3145 if( pRangeEnd ){
dan69f8bb92009-08-13 19:21:16 +00003146 Expr *pRight = pRangeEnd->pExpr->pRight;
drhf49f3522009-12-30 14:12:38 +00003147 sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
dan69f8bb92009-08-13 19:21:16 +00003148 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh7d176102014-02-18 03:07:12 +00003149 if( (pRangeEnd->wtFlags & TERM_VNULL)==0
3150 && sqlite3ExprCanBeNull(pRight)
3151 ){
3152 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
3153 VdbeCoverage(v);
drh534230c2011-01-22 00:10:45 +00003154 }
drh33cad2f2013-11-15 12:41:01 +00003155 if( sqlite3CompareAffinity(pRight, cEndAff)!=SQLITE_AFF_NONE
3156 && !sqlite3ExprNeedsNoAffinityChange(pRight, cEndAff)
3157 ){
3158 codeApplyAffinity(pParse, regBase+nEq, 1, &cEndAff);
3159 }
drh111a6a72008-12-21 03:51:16 +00003160 nConstraint++;
drh39759742013-08-02 23:40:45 +00003161 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
drhcfc6ca42014-02-14 23:49:13 +00003162 }else if( bStopAtNull ){
3163 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
3164 endEq = 0;
3165 nConstraint++;
drh111a6a72008-12-21 03:51:16 +00003166 }
drh6b36e822013-07-30 15:10:32 +00003167 sqlite3DbFree(db, zStartAff);
drh111a6a72008-12-21 03:51:16 +00003168
3169 /* Top of the loop body */
3170 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
3171
3172 /* Check if the index cursor is past the end of the range. */
drhcfc6ca42014-02-14 23:49:13 +00003173 if( nConstraint ){
drh4a1d3652014-02-14 15:13:36 +00003174 op = aEndOp[bRev*2 + endEq];
drh8cff69d2009-11-12 19:59:44 +00003175 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh7d176102014-02-18 03:07:12 +00003176 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
3177 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
3178 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
3179 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
drh6df2acd2008-12-28 16:55:25 +00003180 }
drh111a6a72008-12-21 03:51:16 +00003181
drh111a6a72008-12-21 03:51:16 +00003182 /* Seek the table cursor, if required */
drh23d04d52008-12-23 23:56:22 +00003183 disableTerm(pLevel, pRangeStart);
3184 disableTerm(pLevel, pRangeEnd);
drh85c1c552013-10-24 00:18:18 +00003185 if( omitTable ){
3186 /* pIdx is a covering index. No need to access the main table. */
3187 }else if( HasRowid(pIdx->pTable) ){
drh0baa0352014-02-25 21:55:16 +00003188 iRowidReg = ++pParse->nMem;
danielk19771d461462009-04-21 09:02:45 +00003189 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00003190 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00003191 sqlite3VdbeAddOp2(v, OP_Seek, iCur, iRowidReg); /* Deferred seek */
drh85c1c552013-10-24 00:18:18 +00003192 }else{
3193 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
3194 iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
3195 for(j=0; j<pPk->nKeyCol; j++){
3196 k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
3197 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
3198 }
drh261c02d2013-10-25 14:46:15 +00003199 sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
drh688852a2014-02-17 22:40:43 +00003200 iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
drh111a6a72008-12-21 03:51:16 +00003201 }
drh111a6a72008-12-21 03:51:16 +00003202
3203 /* Record the instruction used to terminate the loop. Disable
3204 ** WHERE clause terms made redundant by the index range scan.
3205 */
drh7699d1c2013-06-04 12:42:29 +00003206 if( pLoop->wsFlags & WHERE_ONEROW ){
drh95e037b2011-03-09 21:02:31 +00003207 pLevel->op = OP_Noop;
3208 }else if( bRev ){
3209 pLevel->op = OP_Prev;
3210 }else{
3211 pLevel->op = OP_Next;
3212 }
drh111a6a72008-12-21 03:51:16 +00003213 pLevel->p1 = iIdxCur;
drhe39a7322014-02-03 14:04:11 +00003214 assert( (WHERE_UNQ_WANTED>>16)==1 );
3215 pLevel->p3 = (pLoop->wsFlags>>16)&1;
drh53cfbe92013-06-13 17:28:22 +00003216 if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
drh3f4d1d12012-09-15 18:45:54 +00003217 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
3218 }else{
3219 assert( pLevel->p5==0 );
3220 }
drhdd5f5a62008-12-23 13:35:23 +00003221 }else
3222
drh23d04d52008-12-23 23:56:22 +00003223#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drh7ba39a92013-05-30 17:43:19 +00003224 if( pLoop->wsFlags & WHERE_MULTI_OR ){
3225 /* Case 5: Two or more separately indexed terms connected by OR
drh111a6a72008-12-21 03:51:16 +00003226 **
3227 ** Example:
3228 **
3229 ** CREATE TABLE t1(a,b,c,d);
3230 ** CREATE INDEX i1 ON t1(a);
3231 ** CREATE INDEX i2 ON t1(b);
3232 ** CREATE INDEX i3 ON t1(c);
3233 **
3234 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
3235 **
3236 ** In the example, there are three indexed terms connected by OR.
danielk19771d461462009-04-21 09:02:45 +00003237 ** The top of the loop looks like this:
drh111a6a72008-12-21 03:51:16 +00003238 **
drh1b26c7c2009-04-22 02:15:47 +00003239 ** Null 1 # Zero the rowset in reg 1
drh111a6a72008-12-21 03:51:16 +00003240 **
danielk19771d461462009-04-21 09:02:45 +00003241 ** Then, for each indexed term, the following. The arguments to
drh1b26c7c2009-04-22 02:15:47 +00003242 ** RowSetTest are such that the rowid of the current row is inserted
3243 ** into the RowSet. If it is already present, control skips the
danielk19771d461462009-04-21 09:02:45 +00003244 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
drh111a6a72008-12-21 03:51:16 +00003245 **
danielk19771d461462009-04-21 09:02:45 +00003246 ** sqlite3WhereBegin(<term>)
drh1b26c7c2009-04-22 02:15:47 +00003247 ** RowSetTest # Insert rowid into rowset
danielk19771d461462009-04-21 09:02:45 +00003248 ** Gosub 2 A
3249 ** sqlite3WhereEnd()
3250 **
3251 ** Following the above, code to terminate the loop. Label A, the target
3252 ** of the Gosub above, jumps to the instruction right after the Goto.
3253 **
drh1b26c7c2009-04-22 02:15:47 +00003254 ** Null 1 # Zero the rowset in reg 1
danielk19771d461462009-04-21 09:02:45 +00003255 ** Goto B # The loop is finished.
3256 **
3257 ** A: <loop body> # Return data, whatever.
3258 **
3259 ** Return 2 # Jump back to the Gosub
3260 **
3261 ** B: <after the loop>
3262 **
drh111a6a72008-12-21 03:51:16 +00003263 */
drh111a6a72008-12-21 03:51:16 +00003264 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
drhc01a3c12009-12-16 22:10:49 +00003265 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
dan0efb72c2012-08-24 18:44:56 +00003266 Index *pCov = 0; /* Potential covering index (or NULL) */
3267 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
danielk19771d461462009-04-21 09:02:45 +00003268
3269 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
shane85095702009-06-15 16:27:08 +00003270 int regRowset = 0; /* Register for RowSet object */
3271 int regRowid = 0; /* Register holding rowid */
danielk19771d461462009-04-21 09:02:45 +00003272 int iLoopBody = sqlite3VdbeMakeLabel(v); /* Start of loop body */
3273 int iRetInit; /* Address of regReturn init */
drhc01a3c12009-12-16 22:10:49 +00003274 int untestedTerms = 0; /* Some terms not completely tested */
drh8871ef52011-10-07 13:33:10 +00003275 int ii; /* Loop counter */
3276 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
drh111a6a72008-12-21 03:51:16 +00003277
drh4efc9292013-06-06 23:02:03 +00003278 pTerm = pLoop->aLTerm[0];
drh111a6a72008-12-21 03:51:16 +00003279 assert( pTerm!=0 );
drh7a5bcc02013-01-16 17:08:58 +00003280 assert( pTerm->eOperator & WO_OR );
drh111a6a72008-12-21 03:51:16 +00003281 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
3282 pOrWc = &pTerm->u.pOrInfo->wc;
drhc01a3c12009-12-16 22:10:49 +00003283 pLevel->op = OP_Return;
3284 pLevel->p1 = regReturn;
drh23d04d52008-12-23 23:56:22 +00003285
danbfca6a42012-08-24 10:52:35 +00003286 /* Set up a new SrcList in pOrTab containing the table being scanned
drhc01a3c12009-12-16 22:10:49 +00003287 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
3288 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
3289 */
3290 if( pWInfo->nLevel>1 ){
3291 int nNotReady; /* The number of notReady tables */
3292 struct SrcList_item *origSrc; /* Original list of tables */
3293 nNotReady = pWInfo->nLevel - iLevel - 1;
drh6b36e822013-07-30 15:10:32 +00003294 pOrTab = sqlite3StackAllocRaw(db,
drhc01a3c12009-12-16 22:10:49 +00003295 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
3296 if( pOrTab==0 ) return notReady;
drhad01d892013-06-19 13:59:49 +00003297 pOrTab->nAlloc = (u8)(nNotReady + 1);
shaneh46aae3c2009-12-31 19:06:23 +00003298 pOrTab->nSrc = pOrTab->nAlloc;
drhc01a3c12009-12-16 22:10:49 +00003299 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
3300 origSrc = pWInfo->pTabList->a;
3301 for(k=1; k<=nNotReady; k++){
3302 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
3303 }
3304 }else{
3305 pOrTab = pWInfo->pTabList;
3306 }
danielk19771d461462009-04-21 09:02:45 +00003307
drh1b26c7c2009-04-22 02:15:47 +00003308 /* Initialize the rowset register to contain NULL. An SQL NULL is
3309 ** equivalent to an empty rowset.
danielk19771d461462009-04-21 09:02:45 +00003310 **
3311 ** Also initialize regReturn to contain the address of the instruction
3312 ** immediately following the OP_Return at the bottom of the loop. This
3313 ** is required in a few obscure LEFT JOIN cases where control jumps
3314 ** over the top of the loop into the body of it. In this case the
3315 ** correct response for the end-of-loop code (the OP_Return) is to
3316 ** fall through to the next instruction, just as an OP_Next does if
3317 ** called on an uninitialized cursor.
3318 */
drh70d18342013-06-06 19:16:33 +00003319 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
drh336a5302009-04-24 15:46:21 +00003320 regRowset = ++pParse->nMem;
3321 regRowid = ++pParse->nMem;
3322 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
3323 }
danielk19771d461462009-04-21 09:02:45 +00003324 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
3325
drh8871ef52011-10-07 13:33:10 +00003326 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
3327 ** Then for every term xN, evaluate as the subexpression: xN AND z
3328 ** That way, terms in y that are factored into the disjunction will
3329 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
drh331b67c2012-03-09 22:02:08 +00003330 **
3331 ** Actually, each subexpression is converted to "xN AND w" where w is
3332 ** the "interesting" terms of z - terms that did not originate in the
3333 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
3334 ** indices.
drhb3129fa2013-05-09 14:20:11 +00003335 **
3336 ** This optimization also only applies if the (x1 OR x2 OR ...) term
3337 ** is not contained in the ON clause of a LEFT JOIN.
3338 ** See ticket http://www.sqlite.org/src/info/f2369304e4
drh8871ef52011-10-07 13:33:10 +00003339 */
3340 if( pWC->nTerm>1 ){
drh7a484802012-03-16 00:28:11 +00003341 int iTerm;
3342 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
3343 Expr *pExpr = pWC->a[iTerm].pExpr;
drhaa32e3c2013-07-16 21:31:23 +00003344 if( &pWC->a[iTerm] == pTerm ) continue;
drh331b67c2012-03-09 22:02:08 +00003345 if( ExprHasProperty(pExpr, EP_FromJoin) ) continue;
drh7c328062014-02-11 01:50:29 +00003346 testcase( pWC->a[iTerm].wtFlags & TERM_ORINFO );
3347 testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
3348 if( pWC->a[iTerm].wtFlags & (TERM_ORINFO|TERM_VIRTUAL) ) continue;
drh7a484802012-03-16 00:28:11 +00003349 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drh6b36e822013-07-30 15:10:32 +00003350 pExpr = sqlite3ExprDup(db, pExpr, 0);
3351 pAndExpr = sqlite3ExprAnd(db, pAndExpr, pExpr);
drh331b67c2012-03-09 22:02:08 +00003352 }
3353 if( pAndExpr ){
3354 pAndExpr = sqlite3PExpr(pParse, TK_AND, 0, pAndExpr, 0);
3355 }
drh8871ef52011-10-07 13:33:10 +00003356 }
3357
danielk19771d461462009-04-21 09:02:45 +00003358 for(ii=0; ii<pOrWc->nTerm; ii++){
3359 WhereTerm *pOrTerm = &pOrWc->a[ii];
drh7a5bcc02013-01-16 17:08:58 +00003360 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
danielk19771d461462009-04-21 09:02:45 +00003361 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
drh8871ef52011-10-07 13:33:10 +00003362 Expr *pOrExpr = pOrTerm->pExpr;
drhb3129fa2013-05-09 14:20:11 +00003363 if( pAndExpr && !ExprHasProperty(pOrExpr, EP_FromJoin) ){
drh8871ef52011-10-07 13:33:10 +00003364 pAndExpr->pLeft = pOrExpr;
3365 pOrExpr = pAndExpr;
3366 }
danielk19771d461462009-04-21 09:02:45 +00003367 /* Loop through table entries that match term pOrTerm. */
drh8871ef52011-10-07 13:33:10 +00003368 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
drh9ef61f42011-10-07 14:40:59 +00003369 WHERE_OMIT_OPEN_CLOSE | WHERE_AND_ONLY |
dan0efb72c2012-08-24 18:44:56 +00003370 WHERE_FORCE_TABLE | WHERE_ONETABLE_ONLY, iCovCur);
drh6b36e822013-07-30 15:10:32 +00003371 assert( pSubWInfo || pParse->nErr || db->mallocFailed );
danielk19771d461462009-04-21 09:02:45 +00003372 if( pSubWInfo ){
drh7ba39a92013-05-30 17:43:19 +00003373 WhereLoop *pSubLoop;
dan17c0bc02010-11-09 17:35:19 +00003374 explainOneScan(
dan4a07e3d2010-11-09 14:48:59 +00003375 pParse, pOrTab, &pSubWInfo->a[0], iLevel, pLevel->iFrom, 0
dan2ce22452010-11-08 19:01:16 +00003376 );
drh70d18342013-06-06 19:16:33 +00003377 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
drh336a5302009-04-24 15:46:21 +00003378 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
3379 int r;
3380 r = sqlite3ExprCodeGetColumn(pParse, pTabItem->pTab, -1, iCur,
drha748fdc2012-03-28 01:34:47 +00003381 regRowid, 0);
drh8cff69d2009-11-12 19:59:44 +00003382 sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset,
3383 sqlite3VdbeCurrentAddr(v)+2, r, iSet);
drh688852a2014-02-17 22:40:43 +00003384 VdbeCoverage(v);
drh336a5302009-04-24 15:46:21 +00003385 }
danielk19771d461462009-04-21 09:02:45 +00003386 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
3387
drhc01a3c12009-12-16 22:10:49 +00003388 /* The pSubWInfo->untestedTerms flag means that this OR term
3389 ** contained one or more AND term from a notReady table. The
3390 ** terms from the notReady table could not be tested and will
3391 ** need to be tested later.
3392 */
3393 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
3394
danbfca6a42012-08-24 10:52:35 +00003395 /* If all of the OR-connected terms are optimized using the same
3396 ** index, and the index is opened using the same cursor number
3397 ** by each call to sqlite3WhereBegin() made by this loop, it may
3398 ** be possible to use that index as a covering index.
3399 **
3400 ** If the call to sqlite3WhereBegin() above resulted in a scan that
3401 ** uses an index, and this is either the first OR-connected term
3402 ** processed or the index is the same as that used by all previous
dan0efb72c2012-08-24 18:44:56 +00003403 ** terms, set pCov to the candidate covering index. Otherwise, set
3404 ** pCov to NULL to indicate that no candidate covering index will
3405 ** be available.
danbfca6a42012-08-24 10:52:35 +00003406 */
drh7ba39a92013-05-30 17:43:19 +00003407 pSubLoop = pSubWInfo->a[0].pWLoop;
drh986b3872013-06-28 21:12:20 +00003408 assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
drh7ba39a92013-05-30 17:43:19 +00003409 if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
drh7ba39a92013-05-30 17:43:19 +00003410 && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
danbfca6a42012-08-24 10:52:35 +00003411 ){
drh7ba39a92013-05-30 17:43:19 +00003412 assert( pSubWInfo->a[0].iIdxCur==iCovCur );
drh907717f2013-06-04 18:03:22 +00003413 pCov = pSubLoop->u.btree.pIndex;
danbfca6a42012-08-24 10:52:35 +00003414 }else{
3415 pCov = 0;
3416 }
3417
danielk19771d461462009-04-21 09:02:45 +00003418 /* Finish the loop through table entries that match term pOrTerm. */
3419 sqlite3WhereEnd(pSubWInfo);
3420 }
drhdd5f5a62008-12-23 13:35:23 +00003421 }
3422 }
drhd40e2082012-08-24 23:24:15 +00003423 pLevel->u.pCovidx = pCov;
drh90abfd02012-10-09 21:07:23 +00003424 if( pCov ) pLevel->iIdxCur = iCovCur;
drh331b67c2012-03-09 22:02:08 +00003425 if( pAndExpr ){
3426 pAndExpr->pLeft = 0;
drh6b36e822013-07-30 15:10:32 +00003427 sqlite3ExprDelete(db, pAndExpr);
drh331b67c2012-03-09 22:02:08 +00003428 }
danielk19771d461462009-04-21 09:02:45 +00003429 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
danielk19771d461462009-04-21 09:02:45 +00003430 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrBrk);
3431 sqlite3VdbeResolveLabel(v, iLoopBody);
3432
drh6b36e822013-07-30 15:10:32 +00003433 if( pWInfo->nLevel>1 ) sqlite3StackFree(db, pOrTab);
drhc01a3c12009-12-16 22:10:49 +00003434 if( !untestedTerms ) disableTerm(pLevel, pTerm);
drhdd5f5a62008-12-23 13:35:23 +00003435 }else
drh23d04d52008-12-23 23:56:22 +00003436#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00003437
3438 {
drh7ba39a92013-05-30 17:43:19 +00003439 /* Case 6: There is no usable index. We must do a complete
drh111a6a72008-12-21 03:51:16 +00003440 ** scan of the entire table.
3441 */
drh699b3d42009-02-23 16:52:07 +00003442 static const u8 aStep[] = { OP_Next, OP_Prev };
3443 static const u8 aStart[] = { OP_Rewind, OP_Last };
3444 assert( bRev==0 || bRev==1 );
drhe73f0592014-01-21 22:25:45 +00003445 if( pTabItem->isRecursive ){
drh340309f2014-01-22 00:23:49 +00003446 /* Tables marked isRecursive have only a single row that is stored in
dan41028152014-01-22 10:22:25 +00003447 ** a pseudo-cursor. No need to Rewind or Next such cursors. */
drhe73f0592014-01-21 22:25:45 +00003448 pLevel->op = OP_Noop;
3449 }else{
3450 pLevel->op = aStep[bRev];
3451 pLevel->p1 = iCur;
3452 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrBrk);
drh7d176102014-02-18 03:07:12 +00003453 VdbeCoverageIf(v, bRev==0);
3454 VdbeCoverageIf(v, bRev!=0);
drhe73f0592014-01-21 22:25:45 +00003455 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
3456 }
drh111a6a72008-12-21 03:51:16 +00003457 }
drh111a6a72008-12-21 03:51:16 +00003458
3459 /* Insert code to test every subexpression that can be completely
3460 ** computed using the current set of tables.
3461 */
drh111a6a72008-12-21 03:51:16 +00003462 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
3463 Expr *pE;
drh39759742013-08-02 23:40:45 +00003464 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh111a6a72008-12-21 03:51:16 +00003465 testcase( pTerm->wtFlags & TERM_CODED );
3466 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drh0259bc32013-09-09 19:37:46 +00003467 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
drhc01a3c12009-12-16 22:10:49 +00003468 testcase( pWInfo->untestedTerms==0
3469 && (pWInfo->wctrlFlags & WHERE_ONETABLE_ONLY)!=0 );
3470 pWInfo->untestedTerms = 1;
3471 continue;
3472 }
drh111a6a72008-12-21 03:51:16 +00003473 pE = pTerm->pExpr;
3474 assert( pE!=0 );
3475 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
3476 continue;
3477 }
drh111a6a72008-12-21 03:51:16 +00003478 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00003479 pTerm->wtFlags |= TERM_CODED;
3480 }
3481
drh0c41d222013-04-22 02:39:10 +00003482 /* Insert code to test for implied constraints based on transitivity
3483 ** of the "==" operator.
3484 **
3485 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
3486 ** and we are coding the t1 loop and the t2 loop has not yet coded,
3487 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
3488 ** the implied "t1.a=123" constraint.
3489 */
3490 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
drh6b36e822013-07-30 15:10:32 +00003491 Expr *pE, *pEAlt;
drh0c41d222013-04-22 02:39:10 +00003492 WhereTerm *pAlt;
drh0c41d222013-04-22 02:39:10 +00003493 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
3494 if( pTerm->eOperator!=(WO_EQUIV|WO_EQ) ) continue;
3495 if( pTerm->leftCursor!=iCur ) continue;
drhcdc2e432013-07-01 17:27:19 +00003496 if( pLevel->iLeftJoin ) continue;
drh0c41d222013-04-22 02:39:10 +00003497 pE = pTerm->pExpr;
3498 assert( !ExprHasProperty(pE, EP_FromJoin) );
drh0259bc32013-09-09 19:37:46 +00003499 assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
drh0c41d222013-04-22 02:39:10 +00003500 pAlt = findTerm(pWC, iCur, pTerm->u.leftColumn, notReady, WO_EQ|WO_IN, 0);
3501 if( pAlt==0 ) continue;
drh5c10f3b2013-05-01 17:22:38 +00003502 if( pAlt->wtFlags & (TERM_CODED) ) continue;
drh7963b0e2013-06-17 21:37:40 +00003503 testcase( pAlt->eOperator & WO_EQ );
3504 testcase( pAlt->eOperator & WO_IN );
drh6bc69a22013-11-19 12:33:23 +00003505 VdbeModuleComment((v, "begin transitive constraint"));
drh6b36e822013-07-30 15:10:32 +00003506 pEAlt = sqlite3StackAllocRaw(db, sizeof(*pEAlt));
3507 if( pEAlt ){
3508 *pEAlt = *pAlt->pExpr;
3509 pEAlt->pLeft = pE->pLeft;
3510 sqlite3ExprIfFalse(pParse, pEAlt, addrCont, SQLITE_JUMPIFNULL);
3511 sqlite3StackFree(db, pEAlt);
3512 }
drh0c41d222013-04-22 02:39:10 +00003513 }
3514
drh111a6a72008-12-21 03:51:16 +00003515 /* For a LEFT OUTER JOIN, generate code that will record the fact that
3516 ** at least one row of the right table has matched the left table.
3517 */
3518 if( pLevel->iLeftJoin ){
3519 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
3520 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
3521 VdbeComment((v, "record LEFT JOIN hit"));
drhceea3322009-04-23 13:22:42 +00003522 sqlite3ExprCacheClear(pParse);
drh111a6a72008-12-21 03:51:16 +00003523 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
drh39759742013-08-02 23:40:45 +00003524 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh111a6a72008-12-21 03:51:16 +00003525 testcase( pTerm->wtFlags & TERM_CODED );
3526 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drh0259bc32013-09-09 19:37:46 +00003527 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
drhb057e562009-12-16 23:43:55 +00003528 assert( pWInfo->untestedTerms );
drhc01a3c12009-12-16 22:10:49 +00003529 continue;
3530 }
drh111a6a72008-12-21 03:51:16 +00003531 assert( pTerm->pExpr );
3532 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
3533 pTerm->wtFlags |= TERM_CODED;
3534 }
3535 }
drh23d04d52008-12-23 23:56:22 +00003536
drh0259bc32013-09-09 19:37:46 +00003537 return pLevel->notReady;
drh111a6a72008-12-21 03:51:16 +00003538}
3539
drhf4e9cb02013-10-28 19:59:59 +00003540#if defined(WHERETRACE_ENABLED) && defined(SQLITE_ENABLE_TREE_EXPLAIN)
3541/*
3542** Generate "Explanation" text for a WhereTerm.
3543*/
3544static void whereExplainTerm(Vdbe *v, WhereTerm *pTerm){
3545 char zType[4];
3546 memcpy(zType, "...", 4);
3547 if( pTerm->wtFlags & TERM_VIRTUAL ) zType[0] = 'V';
3548 if( pTerm->eOperator & WO_EQUIV ) zType[1] = 'E';
3549 if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) zType[2] = 'L';
3550 sqlite3ExplainPrintf(v, "%s ", zType);
drhf4e9cb02013-10-28 19:59:59 +00003551 sqlite3ExplainExpr(v, pTerm->pExpr);
3552}
3553#endif /* WHERETRACE_ENABLED && SQLITE_ENABLE_TREE_EXPLAIN */
3554
3555
drhd15cb172013-05-21 19:23:10 +00003556#ifdef WHERETRACE_ENABLED
drha18f3d22013-05-08 03:05:41 +00003557/*
3558** Print a WhereLoop object for debugging purposes
3559*/
drhc1ba2e72013-10-28 19:03:21 +00003560static void whereLoopPrint(WhereLoop *p, WhereClause *pWC){
3561 WhereInfo *pWInfo = pWC->pWInfo;
drh989578e2013-10-28 14:34:35 +00003562 int nb = 1+(pWInfo->pTabList->nSrc+7)/8;
3563 struct SrcList_item *pItem = pWInfo->pTabList->a + p->iTab;
drha18f3d22013-05-08 03:05:41 +00003564 Table *pTab = pItem->pTab;
drh6457a352013-06-21 00:35:37 +00003565 sqlite3DebugPrintf("%c%2d.%0*llx.%0*llx", p->cId,
drha184fb82013-05-08 04:22:59 +00003566 p->iTab, nb, p->maskSelf, nb, p->prereq);
drh6457a352013-06-21 00:35:37 +00003567 sqlite3DebugPrintf(" %12s",
drha18f3d22013-05-08 03:05:41 +00003568 pItem->zAlias ? pItem->zAlias : pTab->zName);
drh5346e952013-05-08 14:14:26 +00003569 if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
drhc1ba2e72013-10-28 19:03:21 +00003570 const char *zName;
3571 if( p->u.btree.pIndex && (zName = p->u.btree.pIndex->zName)!=0 ){
drh319f6772013-05-14 15:31:07 +00003572 if( strncmp(zName, "sqlite_autoindex_", 17)==0 ){
3573 int i = sqlite3Strlen30(zName) - 1;
3574 while( zName[i]!='_' ) i--;
3575 zName += i;
3576 }
drh6457a352013-06-21 00:35:37 +00003577 sqlite3DebugPrintf(".%-16s %2d", zName, p->u.btree.nEq);
drh5346e952013-05-08 14:14:26 +00003578 }else{
drh6457a352013-06-21 00:35:37 +00003579 sqlite3DebugPrintf("%20s","");
drh5346e952013-05-08 14:14:26 +00003580 }
drha18f3d22013-05-08 03:05:41 +00003581 }else{
drh5346e952013-05-08 14:14:26 +00003582 char *z;
3583 if( p->u.vtab.idxStr ){
drh3bd26f02013-05-24 14:52:03 +00003584 z = sqlite3_mprintf("(%d,\"%s\",%x)",
3585 p->u.vtab.idxNum, p->u.vtab.idxStr, p->u.vtab.omitMask);
drh5346e952013-05-08 14:14:26 +00003586 }else{
drh3bd26f02013-05-24 14:52:03 +00003587 z = sqlite3_mprintf("(%d,%x)", p->u.vtab.idxNum, p->u.vtab.omitMask);
drh5346e952013-05-08 14:14:26 +00003588 }
drh6457a352013-06-21 00:35:37 +00003589 sqlite3DebugPrintf(" %-19s", z);
drh5346e952013-05-08 14:14:26 +00003590 sqlite3_free(z);
drha18f3d22013-05-08 03:05:41 +00003591 }
drh6457a352013-06-21 00:35:37 +00003592 sqlite3DebugPrintf(" f %04x N %d", p->wsFlags, p->nLTerm);
drhb8a8e8a2013-06-10 19:12:39 +00003593 sqlite3DebugPrintf(" cost %d,%d,%d\n", p->rSetup, p->rRun, p->nOut);
drh989578e2013-10-28 14:34:35 +00003594#ifdef SQLITE_ENABLE_TREE_EXPLAIN
3595 /* If the 0x100 bit of wheretracing is set, then show all of the constraint
3596 ** expressions in the WhereLoop.aLTerm[] array.
3597 */
3598 if( p->nLTerm && (sqlite3WhereTrace & 0x100)!=0 ){ /* WHERETRACE 0x100 */
3599 int i;
3600 Vdbe *v = pWInfo->pParse->pVdbe;
3601 sqlite3ExplainBegin(v);
3602 for(i=0; i<p->nLTerm; i++){
drhc1ba2e72013-10-28 19:03:21 +00003603 WhereTerm *pTerm = p->aLTerm[i];
drhcd8629e2013-11-13 12:27:25 +00003604 if( pTerm==0 ) continue;
drh7afc8b02013-10-28 22:33:36 +00003605 sqlite3ExplainPrintf(v, " (%d) #%-2d ", i+1, (int)(pTerm-pWC->a));
drh989578e2013-10-28 14:34:35 +00003606 sqlite3ExplainPush(v);
drhf4e9cb02013-10-28 19:59:59 +00003607 whereExplainTerm(v, pTerm);
drh989578e2013-10-28 14:34:35 +00003608 sqlite3ExplainPop(v);
3609 sqlite3ExplainNL(v);
3610 }
drh989578e2013-10-28 14:34:35 +00003611 sqlite3ExplainFinish(v);
drhc1ba2e72013-10-28 19:03:21 +00003612 sqlite3DebugPrintf("%s", sqlite3VdbeExplanation(v));
drh989578e2013-10-28 14:34:35 +00003613 }
3614#endif
drha18f3d22013-05-08 03:05:41 +00003615}
3616#endif
3617
drhf1b5f5b2013-05-02 00:15:01 +00003618/*
drh4efc9292013-06-06 23:02:03 +00003619** Convert bulk memory into a valid WhereLoop that can be passed
3620** to whereLoopClear harmlessly.
drh5346e952013-05-08 14:14:26 +00003621*/
drh4efc9292013-06-06 23:02:03 +00003622static void whereLoopInit(WhereLoop *p){
3623 p->aLTerm = p->aLTermSpace;
3624 p->nLTerm = 0;
3625 p->nLSlot = ArraySize(p->aLTermSpace);
3626 p->wsFlags = 0;
3627}
3628
3629/*
3630** Clear the WhereLoop.u union. Leave WhereLoop.pLTerm intact.
3631*/
3632static void whereLoopClearUnion(sqlite3 *db, WhereLoop *p){
drh986b3872013-06-28 21:12:20 +00003633 if( p->wsFlags & (WHERE_VIRTUALTABLE|WHERE_AUTO_INDEX) ){
drh13e11b42013-06-06 23:44:25 +00003634 if( (p->wsFlags & WHERE_VIRTUALTABLE)!=0 && p->u.vtab.needFree ){
3635 sqlite3_free(p->u.vtab.idxStr);
3636 p->u.vtab.needFree = 0;
3637 p->u.vtab.idxStr = 0;
drh986b3872013-06-28 21:12:20 +00003638 }else if( (p->wsFlags & WHERE_AUTO_INDEX)!=0 && p->u.btree.pIndex!=0 ){
drh13e11b42013-06-06 23:44:25 +00003639 sqlite3DbFree(db, p->u.btree.pIndex->zColAff);
drh2ec2fb22013-11-06 19:59:23 +00003640 sqlite3KeyInfoUnref(p->u.btree.pIndex->pKeyInfo);
drh13e11b42013-06-06 23:44:25 +00003641 sqlite3DbFree(db, p->u.btree.pIndex);
3642 p->u.btree.pIndex = 0;
3643 }
drh5346e952013-05-08 14:14:26 +00003644 }
3645}
3646
drh4efc9292013-06-06 23:02:03 +00003647/*
3648** Deallocate internal memory used by a WhereLoop object
3649*/
3650static void whereLoopClear(sqlite3 *db, WhereLoop *p){
3651 if( p->aLTerm!=p->aLTermSpace ) sqlite3DbFree(db, p->aLTerm);
3652 whereLoopClearUnion(db, p);
3653 whereLoopInit(p);
3654}
3655
3656/*
3657** Increase the memory allocation for pLoop->aLTerm[] to be at least n.
3658*/
3659static int whereLoopResize(sqlite3 *db, WhereLoop *p, int n){
3660 WhereTerm **paNew;
3661 if( p->nLSlot>=n ) return SQLITE_OK;
3662 n = (n+7)&~7;
3663 paNew = sqlite3DbMallocRaw(db, sizeof(p->aLTerm[0])*n);
3664 if( paNew==0 ) return SQLITE_NOMEM;
3665 memcpy(paNew, p->aLTerm, sizeof(p->aLTerm[0])*p->nLSlot);
3666 if( p->aLTerm!=p->aLTermSpace ) sqlite3DbFree(db, p->aLTerm);
3667 p->aLTerm = paNew;
3668 p->nLSlot = n;
3669 return SQLITE_OK;
3670}
3671
3672/*
3673** Transfer content from the second pLoop into the first.
3674*/
3675static int whereLoopXfer(sqlite3 *db, WhereLoop *pTo, WhereLoop *pFrom){
drh4efc9292013-06-06 23:02:03 +00003676 whereLoopClearUnion(db, pTo);
drh0d31dc32013-09-06 00:40:59 +00003677 if( whereLoopResize(db, pTo, pFrom->nLTerm) ){
3678 memset(&pTo->u, 0, sizeof(pTo->u));
3679 return SQLITE_NOMEM;
3680 }
drha2014152013-06-07 00:29:23 +00003681 memcpy(pTo, pFrom, WHERE_LOOP_XFER_SZ);
3682 memcpy(pTo->aLTerm, pFrom->aLTerm, pTo->nLTerm*sizeof(pTo->aLTerm[0]));
drh4efc9292013-06-06 23:02:03 +00003683 if( pFrom->wsFlags & WHERE_VIRTUALTABLE ){
3684 pFrom->u.vtab.needFree = 0;
drh986b3872013-06-28 21:12:20 +00003685 }else if( (pFrom->wsFlags & WHERE_AUTO_INDEX)!=0 ){
drh4efc9292013-06-06 23:02:03 +00003686 pFrom->u.btree.pIndex = 0;
3687 }
3688 return SQLITE_OK;
3689}
3690
drh5346e952013-05-08 14:14:26 +00003691/*
drhf1b5f5b2013-05-02 00:15:01 +00003692** Delete a WhereLoop object
3693*/
3694static void whereLoopDelete(sqlite3 *db, WhereLoop *p){
drh5346e952013-05-08 14:14:26 +00003695 whereLoopClear(db, p);
drhf1b5f5b2013-05-02 00:15:01 +00003696 sqlite3DbFree(db, p);
3697}
drh84bfda42005-07-15 13:05:21 +00003698
drh9eff6162006-06-12 21:59:13 +00003699/*
3700** Free a WhereInfo structure
3701*/
drh10fe8402008-10-11 16:47:35 +00003702static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh52ff8ea2010-04-08 14:15:56 +00003703 if( ALWAYS(pWInfo) ){
drh70d18342013-06-06 19:16:33 +00003704 whereClauseClear(&pWInfo->sWC);
drhf1b5f5b2013-05-02 00:15:01 +00003705 while( pWInfo->pLoops ){
3706 WhereLoop *p = pWInfo->pLoops;
3707 pWInfo->pLoops = p->pNextLoop;
3708 whereLoopDelete(db, p);
3709 }
drh633e6d52008-07-28 19:34:53 +00003710 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00003711 }
3712}
3713
drhf1b5f5b2013-05-02 00:15:01 +00003714/*
3715** Insert or replace a WhereLoop entry using the template supplied.
3716**
3717** An existing WhereLoop entry might be overwritten if the new template
3718** is better and has fewer dependencies. Or the template will be ignored
3719** and no insert will occur if an existing WhereLoop is faster and has
3720** fewer dependencies than the template. Otherwise a new WhereLoop is
drhd044d202013-05-31 12:43:55 +00003721** added based on the template.
drh23f98da2013-05-21 15:52:07 +00003722**
drhaa32e3c2013-07-16 21:31:23 +00003723** If pBuilder->pOrSet is not NULL then we only care about only the
3724** prerequisites and rRun and nOut costs of the N best loops. That
3725** information is gathered in the pBuilder->pOrSet object. This special
3726** processing mode is used only for OR clause processing.
drh23f98da2013-05-21 15:52:07 +00003727**
drhaa32e3c2013-07-16 21:31:23 +00003728** When accumulating multiple loops (when pBuilder->pOrSet is NULL) we
drh23f98da2013-05-21 15:52:07 +00003729** still might overwrite similar loops with the new template if the
3730** template is better. Loops may be overwritten if the following
3731** conditions are met:
3732**
3733** (1) They have the same iTab.
3734** (2) They have the same iSortIdx.
3735** (3) The template has same or fewer dependencies than the current loop
3736** (4) The template has the same or lower cost than the current loop
drhd044d202013-05-31 12:43:55 +00003737** (5) The template uses more terms of the same index but has no additional
3738** dependencies
drhf1b5f5b2013-05-02 00:15:01 +00003739*/
drhcf8fa7a2013-05-10 20:26:22 +00003740static int whereLoopInsert(WhereLoopBuilder *pBuilder, WhereLoop *pTemplate){
drh4efc9292013-06-06 23:02:03 +00003741 WhereLoop **ppPrev, *p, *pNext = 0;
drhcf8fa7a2013-05-10 20:26:22 +00003742 WhereInfo *pWInfo = pBuilder->pWInfo;
drh70d18342013-06-06 19:16:33 +00003743 sqlite3 *db = pWInfo->pParse->db;
drhcf8fa7a2013-05-10 20:26:22 +00003744
drhaa32e3c2013-07-16 21:31:23 +00003745 /* If pBuilder->pOrSet is defined, then only keep track of the costs
3746 ** and prereqs.
drh23f98da2013-05-21 15:52:07 +00003747 */
drhaa32e3c2013-07-16 21:31:23 +00003748 if( pBuilder->pOrSet!=0 ){
3749#if WHERETRACE_ENABLED
3750 u16 n = pBuilder->pOrSet->n;
3751 int x =
3752#endif
3753 whereOrInsert(pBuilder->pOrSet, pTemplate->prereq, pTemplate->rRun,
3754 pTemplate->nOut);
drh989578e2013-10-28 14:34:35 +00003755#if WHERETRACE_ENABLED /* 0x8 */
drhae70cf12013-05-31 15:18:46 +00003756 if( sqlite3WhereTrace & 0x8 ){
drhaa32e3c2013-07-16 21:31:23 +00003757 sqlite3DebugPrintf(x?" or-%d: ":" or-X: ", n);
drhc1ba2e72013-10-28 19:03:21 +00003758 whereLoopPrint(pTemplate, pBuilder->pWC);
drhae70cf12013-05-31 15:18:46 +00003759 }
3760#endif
drhcf8fa7a2013-05-10 20:26:22 +00003761 return SQLITE_OK;
3762 }
drhf1b5f5b2013-05-02 00:15:01 +00003763
3764 /* Search for an existing WhereLoop to overwrite, or which takes
3765 ** priority over pTemplate.
3766 */
3767 for(ppPrev=&pWInfo->pLoops, p=*ppPrev; p; ppPrev=&p->pNextLoop, p=*ppPrev){
drhdbb80232013-06-19 12:34:13 +00003768 if( p->iTab!=pTemplate->iTab || p->iSortIdx!=pTemplate->iSortIdx ){
3769 /* If either the iTab or iSortIdx values for two WhereLoop are different
3770 ** then those WhereLoops need to be considered separately. Neither is
3771 ** a candidate to replace the other. */
3772 continue;
3773 }
3774 /* In the current implementation, the rSetup value is either zero
3775 ** or the cost of building an automatic index (NlogN) and the NlogN
3776 ** is the same for compatible WhereLoops. */
3777 assert( p->rSetup==0 || pTemplate->rSetup==0
3778 || p->rSetup==pTemplate->rSetup );
3779
3780 /* whereLoopAddBtree() always generates and inserts the automatic index
3781 ** case first. Hence compatible candidate WhereLoops never have a larger
3782 ** rSetup. Call this SETUP-INVARIANT */
3783 assert( p->rSetup>=pTemplate->rSetup );
3784
drhf1b5f5b2013-05-02 00:15:01 +00003785 if( (p->prereq & pTemplate->prereq)==p->prereq
drhf1b5f5b2013-05-02 00:15:01 +00003786 && p->rSetup<=pTemplate->rSetup
3787 && p->rRun<=pTemplate->rRun
drhf46af732013-08-30 17:35:44 +00003788 && p->nOut<=pTemplate->nOut
drhf1b5f5b2013-05-02 00:15:01 +00003789 ){
drh4a5acf82013-06-18 20:06:23 +00003790 /* This branch taken when p is equal or better than pTemplate in
drhe56dd3a2013-08-30 17:50:35 +00003791 ** all of (1) dependencies (2) setup-cost, (3) run-cost, and
drhf46af732013-08-30 17:35:44 +00003792 ** (4) number of output rows. */
drhdbb80232013-06-19 12:34:13 +00003793 assert( p->rSetup==pTemplate->rSetup );
drh05db3c72013-09-02 20:22:18 +00003794 if( p->prereq==pTemplate->prereq
3795 && p->nLTerm<pTemplate->nLTerm
drhadd5ce32013-09-07 00:29:06 +00003796 && (p->wsFlags & pTemplate->wsFlags & WHERE_INDEXED)!=0
3797 && (p->u.btree.pIndex==pTemplate->u.btree.pIndex
drhabfa6d52013-09-11 03:53:22 +00003798 || pTemplate->rRun+p->nLTerm<=p->rRun+pTemplate->nLTerm)
drhcd0f4072013-06-05 12:47:59 +00003799 ){
3800 /* Overwrite an existing WhereLoop with an similar one that uses
3801 ** more terms of the index */
3802 pNext = p->pNextLoop;
drhcd0f4072013-06-05 12:47:59 +00003803 break;
3804 }else{
3805 /* pTemplate is not helpful.
3806 ** Return without changing or adding anything */
3807 goto whereLoopInsert_noop;
3808 }
drhf1b5f5b2013-05-02 00:15:01 +00003809 }
3810 if( (p->prereq & pTemplate->prereq)==pTemplate->prereq
drhf1b5f5b2013-05-02 00:15:01 +00003811 && p->rRun>=pTemplate->rRun
drhf46af732013-08-30 17:35:44 +00003812 && p->nOut>=pTemplate->nOut
drhf1b5f5b2013-05-02 00:15:01 +00003813 ){
drh4a5acf82013-06-18 20:06:23 +00003814 /* Overwrite an existing WhereLoop with a better one: one that is
drhe56dd3a2013-08-30 17:50:35 +00003815 ** better at one of (1) dependencies, (2) setup-cost, (3) run-cost
drhf46af732013-08-30 17:35:44 +00003816 ** or (4) number of output rows, and is no worse in any of those
3817 ** categories. */
drhadd5ce32013-09-07 00:29:06 +00003818 assert( p->rSetup>=pTemplate->rSetup ); /* SETUP-INVARIANT above */
drh43fe25f2013-05-07 23:06:23 +00003819 pNext = p->pNextLoop;
drhf1b5f5b2013-05-02 00:15:01 +00003820 break;
3821 }
3822 }
3823
3824 /* If we reach this point it means that either p[] should be overwritten
3825 ** with pTemplate[] if p[] exists, or if p==NULL then allocate a new
3826 ** WhereLoop and insert it.
3827 */
drh989578e2013-10-28 14:34:35 +00003828#if WHERETRACE_ENABLED /* 0x8 */
drhae70cf12013-05-31 15:18:46 +00003829 if( sqlite3WhereTrace & 0x8 ){
3830 if( p!=0 ){
3831 sqlite3DebugPrintf("ins-del: ");
drhc1ba2e72013-10-28 19:03:21 +00003832 whereLoopPrint(p, pBuilder->pWC);
drhae70cf12013-05-31 15:18:46 +00003833 }
3834 sqlite3DebugPrintf("ins-new: ");
drhc1ba2e72013-10-28 19:03:21 +00003835 whereLoopPrint(pTemplate, pBuilder->pWC);
drhae70cf12013-05-31 15:18:46 +00003836 }
3837#endif
drhf1b5f5b2013-05-02 00:15:01 +00003838 if( p==0 ){
drh4efc9292013-06-06 23:02:03 +00003839 p = sqlite3DbMallocRaw(db, sizeof(WhereLoop));
drhf1b5f5b2013-05-02 00:15:01 +00003840 if( p==0 ) return SQLITE_NOMEM;
drh4efc9292013-06-06 23:02:03 +00003841 whereLoopInit(p);
drhf1b5f5b2013-05-02 00:15:01 +00003842 }
drh4efc9292013-06-06 23:02:03 +00003843 whereLoopXfer(db, p, pTemplate);
drh43fe25f2013-05-07 23:06:23 +00003844 p->pNextLoop = pNext;
3845 *ppPrev = p;
drh5346e952013-05-08 14:14:26 +00003846 if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
drhef866372013-05-22 20:49:02 +00003847 Index *pIndex = p->u.btree.pIndex;
3848 if( pIndex && pIndex->tnum==0 ){
drhcf8fa7a2013-05-10 20:26:22 +00003849 p->u.btree.pIndex = 0;
3850 }
drh5346e952013-05-08 14:14:26 +00003851 }
drhf1b5f5b2013-05-02 00:15:01 +00003852 return SQLITE_OK;
drhae70cf12013-05-31 15:18:46 +00003853
3854 /* Jump here if the insert is a no-op */
3855whereLoopInsert_noop:
drh989578e2013-10-28 14:34:35 +00003856#if WHERETRACE_ENABLED /* 0x8 */
drhae70cf12013-05-31 15:18:46 +00003857 if( sqlite3WhereTrace & 0x8 ){
drhaa32e3c2013-07-16 21:31:23 +00003858 sqlite3DebugPrintf("ins-noop: ");
drhc1ba2e72013-10-28 19:03:21 +00003859 whereLoopPrint(pTemplate, pBuilder->pWC);
drhae70cf12013-05-31 15:18:46 +00003860 }
3861#endif
3862 return SQLITE_OK;
drhf1b5f5b2013-05-02 00:15:01 +00003863}
3864
3865/*
drhcca9f3d2013-09-06 15:23:29 +00003866** Adjust the WhereLoop.nOut value downward to account for terms of the
3867** WHERE clause that reference the loop but which are not used by an
3868** index.
3869**
3870** In the current implementation, the first extra WHERE clause term reduces
3871** the number of output rows by a factor of 10 and each additional term
3872** reduces the number of output rows by sqrt(2).
3873*/
drh4f991892013-10-11 15:05:05 +00003874static void whereLoopOutputAdjust(WhereClause *pWC, WhereLoop *pLoop){
drh7d9e7d82013-09-11 17:39:09 +00003875 WhereTerm *pTerm, *pX;
drhcca9f3d2013-09-06 15:23:29 +00003876 Bitmask notAllowed = ~(pLoop->prereq|pLoop->maskSelf);
drh7d9e7d82013-09-11 17:39:09 +00003877 int i, j;
drhadd5ce32013-09-07 00:29:06 +00003878
3879 if( !OptimizationEnabled(pWC->pWInfo->pParse->db, SQLITE_AdjustOutEst) ){
3880 return;
3881 }
drhcca9f3d2013-09-06 15:23:29 +00003882 for(i=pWC->nTerm, pTerm=pWC->a; i>0; i--, pTerm++){
drh7d9e7d82013-09-11 17:39:09 +00003883 if( (pTerm->wtFlags & TERM_VIRTUAL)!=0 ) break;
drhcca9f3d2013-09-06 15:23:29 +00003884 if( (pTerm->prereqAll & pLoop->maskSelf)==0 ) continue;
3885 if( (pTerm->prereqAll & notAllowed)!=0 ) continue;
drh7d9e7d82013-09-11 17:39:09 +00003886 for(j=pLoop->nLTerm-1; j>=0; j--){
3887 pX = pLoop->aLTerm[j];
drhd2447442013-11-13 19:01:41 +00003888 if( pX==0 ) continue;
drh7d9e7d82013-09-11 17:39:09 +00003889 if( pX==pTerm ) break;
3890 if( pX->iParent>=0 && (&pWC->a[pX->iParent])==pTerm ) break;
3891 }
3892 if( j<0 ) pLoop->nOut += pTerm->truthProb;
drhcca9f3d2013-09-06 15:23:29 +00003893 }
drhcca9f3d2013-09-06 15:23:29 +00003894}
3895
3896/*
drh5346e952013-05-08 14:14:26 +00003897** We have so far matched pBuilder->pNew->u.btree.nEq terms of the index pIndex.
drh1c8148f2013-05-04 20:25:23 +00003898** Try to match one more.
3899**
3900** If pProbe->tnum==0, that means pIndex is a fake index used for the
3901** INTEGER PRIMARY KEY.
3902*/
drh5346e952013-05-08 14:14:26 +00003903static int whereLoopAddBtreeIndex(
drh1c8148f2013-05-04 20:25:23 +00003904 WhereLoopBuilder *pBuilder, /* The WhereLoop factory */
3905 struct SrcList_item *pSrc, /* FROM clause term being analyzed */
3906 Index *pProbe, /* An index on pSrc */
drhbf539c42013-10-05 18:16:02 +00003907 LogEst nInMul /* log(Number of iterations due to IN) */
drh1c8148f2013-05-04 20:25:23 +00003908){
drh70d18342013-06-06 19:16:33 +00003909 WhereInfo *pWInfo = pBuilder->pWInfo; /* WHERE analyse context */
3910 Parse *pParse = pWInfo->pParse; /* Parsing context */
3911 sqlite3 *db = pParse->db; /* Database connection malloc context */
drh1c8148f2013-05-04 20:25:23 +00003912 WhereLoop *pNew; /* Template WhereLoop under construction */
3913 WhereTerm *pTerm; /* A WhereTerm under consideration */
drh43fe25f2013-05-07 23:06:23 +00003914 int opMask; /* Valid operators for constraints */
drh1c8148f2013-05-04 20:25:23 +00003915 WhereScan scan; /* Iterator for WHERE terms */
drh4efc9292013-06-06 23:02:03 +00003916 Bitmask saved_prereq; /* Original value of pNew->prereq */
3917 u16 saved_nLTerm; /* Original value of pNew->nLTerm */
drhcd8629e2013-11-13 12:27:25 +00003918 u16 saved_nEq; /* Original value of pNew->u.btree.nEq */
3919 u16 saved_nSkip; /* Original value of pNew->u.btree.nSkip */
drh4efc9292013-06-06 23:02:03 +00003920 u32 saved_wsFlags; /* Original value of pNew->wsFlags */
drhbf539c42013-10-05 18:16:02 +00003921 LogEst saved_nOut; /* Original value of pNew->nOut */
drha18f3d22013-05-08 03:05:41 +00003922 int iCol; /* Index of the column in the table */
drh5346e952013-05-08 14:14:26 +00003923 int rc = SQLITE_OK; /* Return code */
drhbf539c42013-10-05 18:16:02 +00003924 LogEst nRowEst; /* Estimated index selectivity */
3925 LogEst rLogSize; /* Logarithm of table size */
drhc7f0d222013-06-19 03:27:12 +00003926 WhereTerm *pTop = 0, *pBtm = 0; /* Top and bottom range constraints */
drh1c8148f2013-05-04 20:25:23 +00003927
drh1c8148f2013-05-04 20:25:23 +00003928 pNew = pBuilder->pNew;
drh5346e952013-05-08 14:14:26 +00003929 if( db->mallocFailed ) return SQLITE_NOMEM;
drh1c8148f2013-05-04 20:25:23 +00003930
drh5346e952013-05-08 14:14:26 +00003931 assert( (pNew->wsFlags & WHERE_VIRTUALTABLE)==0 );
drh43fe25f2013-05-07 23:06:23 +00003932 assert( (pNew->wsFlags & WHERE_TOP_LIMIT)==0 );
3933 if( pNew->wsFlags & WHERE_BTM_LIMIT ){
3934 opMask = WO_LT|WO_LE;
3935 }else if( pProbe->tnum<=0 || (pSrc->jointype & JT_LEFT)!=0 ){
3936 opMask = WO_EQ|WO_IN|WO_GT|WO_GE|WO_LT|WO_LE;
drh1c8148f2013-05-04 20:25:23 +00003937 }else{
drh43fe25f2013-05-07 23:06:23 +00003938 opMask = WO_EQ|WO_IN|WO_ISNULL|WO_GT|WO_GE|WO_LT|WO_LE;
drh1c8148f2013-05-04 20:25:23 +00003939 }
drhef866372013-05-22 20:49:02 +00003940 if( pProbe->bUnordered ) opMask &= ~(WO_GT|WO_GE|WO_LT|WO_LE);
drh1c8148f2013-05-04 20:25:23 +00003941
drhbbbdc832013-10-22 18:01:40 +00003942 assert( pNew->u.btree.nEq<=pProbe->nKeyCol );
3943 if( pNew->u.btree.nEq < pProbe->nKeyCol ){
drh0f133a42013-05-22 17:01:17 +00003944 iCol = pProbe->aiColumn[pNew->u.btree.nEq];
drhbf539c42013-10-05 18:16:02 +00003945 nRowEst = sqlite3LogEst(pProbe->aiRowEst[pNew->u.btree.nEq+1]);
drhc7f0d222013-06-19 03:27:12 +00003946 if( nRowEst==0 && pProbe->onError==OE_None ) nRowEst = 1;
drh0f133a42013-05-22 17:01:17 +00003947 }else{
3948 iCol = -1;
drhb8a8e8a2013-06-10 19:12:39 +00003949 nRowEst = 0;
drh0f133a42013-05-22 17:01:17 +00003950 }
drha18f3d22013-05-08 03:05:41 +00003951 pTerm = whereScanInit(&scan, pBuilder->pWC, pSrc->iCursor, iCol,
drh0f133a42013-05-22 17:01:17 +00003952 opMask, pProbe);
drh4efc9292013-06-06 23:02:03 +00003953 saved_nEq = pNew->u.btree.nEq;
drhcd8629e2013-11-13 12:27:25 +00003954 saved_nSkip = pNew->u.btree.nSkip;
drh4efc9292013-06-06 23:02:03 +00003955 saved_nLTerm = pNew->nLTerm;
3956 saved_wsFlags = pNew->wsFlags;
3957 saved_prereq = pNew->prereq;
3958 saved_nOut = pNew->nOut;
drhb8a8e8a2013-06-10 19:12:39 +00003959 pNew->rSetup = 0;
drhbf539c42013-10-05 18:16:02 +00003960 rLogSize = estLog(sqlite3LogEst(pProbe->aiRowEst[0]));
drh64ff26f2013-11-18 19:32:15 +00003961
3962 /* Consider using a skip-scan if there are no WHERE clause constraints
3963 ** available for the left-most terms of the index, and if the average
drhc964c392013-11-27 04:22:27 +00003964 ** number of repeats in the left-most terms is at least 18. The magic
3965 ** number 18 was found by experimentation to be the payoff point where
3966 ** skip-scan become faster than a full-scan.
drh64ff26f2013-11-18 19:32:15 +00003967 */
drhcd8629e2013-11-13 12:27:25 +00003968 if( pTerm==0
3969 && saved_nEq==saved_nSkip
3970 && saved_nEq+1<pProbe->nKeyCol
drhc964c392013-11-27 04:22:27 +00003971 && pProbe->aiRowEst[saved_nEq+1]>=18 /* TUNING: Minimum for skip-scan */
drh6c1de302013-12-22 20:44:10 +00003972 && (rc = whereLoopResize(db, pNew, pNew->nLTerm+1))==SQLITE_OK
drhcd8629e2013-11-13 12:27:25 +00003973 ){
drh2e5ef4e2013-11-13 16:58:54 +00003974 LogEst nIter;
drhcd8629e2013-11-13 12:27:25 +00003975 pNew->u.btree.nEq++;
3976 pNew->u.btree.nSkip++;
3977 pNew->aLTerm[pNew->nLTerm++] = 0;
drh2e5ef4e2013-11-13 16:58:54 +00003978 pNew->wsFlags |= WHERE_SKIPSCAN;
3979 nIter = sqlite3LogEst(pProbe->aiRowEst[0]/pProbe->aiRowEst[saved_nEq+1]);
drh89212fb2014-03-10 20:12:31 +00003980 pNew->rRun = rLogSize + nIter;
3981 pNew->nOut += nIter;
drh2e5ef4e2013-11-13 16:58:54 +00003982 whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, nIter);
drh89212fb2014-03-10 20:12:31 +00003983 pNew->nOut = saved_nOut;
drhcd8629e2013-11-13 12:27:25 +00003984 }
drh5346e952013-05-08 14:14:26 +00003985 for(; rc==SQLITE_OK && pTerm!=0; pTerm = whereScanNext(&scan)){
drhb8a8e8a2013-06-10 19:12:39 +00003986 int nIn = 0;
drh1435a9a2013-08-27 23:15:44 +00003987#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan7a419232013-08-06 20:01:43 +00003988 int nRecValid = pBuilder->nRecValid;
drhb5246e52013-07-08 21:12:57 +00003989#endif
dan8bff07a2013-08-29 14:56:14 +00003990 if( (pTerm->eOperator==WO_ISNULL || (pTerm->wtFlags&TERM_VNULL)!=0)
3991 && (iCol<0 || pSrc->pTab->aCol[iCol].notNull)
3992 ){
3993 continue; /* ignore IS [NOT] NULL constraints on NOT NULL columns */
3994 }
dan7a419232013-08-06 20:01:43 +00003995 if( pTerm->prereqRight & pNew->maskSelf ) continue;
3996
danad45ed72013-08-08 12:21:32 +00003997 assert( pNew->nOut==saved_nOut );
3998
drh4efc9292013-06-06 23:02:03 +00003999 pNew->wsFlags = saved_wsFlags;
4000 pNew->u.btree.nEq = saved_nEq;
4001 pNew->nLTerm = saved_nLTerm;
4002 if( whereLoopResize(db, pNew, pNew->nLTerm+1) ) break; /* OOM */
4003 pNew->aLTerm[pNew->nLTerm++] = pTerm;
4004 pNew->prereq = (saved_prereq | pTerm->prereqRight) & ~pNew->maskSelf;
drhe1e2e9a2013-06-13 15:16:53 +00004005 pNew->rRun = rLogSize; /* Baseline cost is log2(N). Adjustments below */
drha18f3d22013-05-08 03:05:41 +00004006 if( pTerm->eOperator & WO_IN ){
4007 Expr *pExpr = pTerm->pExpr;
4008 pNew->wsFlags |= WHERE_COLUMN_IN;
4009 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drhe1e2e9a2013-06-13 15:16:53 +00004010 /* "x IN (SELECT ...)": TUNING: the SELECT returns 25 rows */
drhbf539c42013-10-05 18:16:02 +00004011 nIn = 46; assert( 46==sqlite3LogEst(25) );
drha18f3d22013-05-08 03:05:41 +00004012 }else if( ALWAYS(pExpr->x.pList && pExpr->x.pList->nExpr) ){
4013 /* "x IN (value, value, ...)" */
drhbf539c42013-10-05 18:16:02 +00004014 nIn = sqlite3LogEst(pExpr->x.pList->nExpr);
drhf1645f02013-05-07 19:44:38 +00004015 }
drhb8a8e8a2013-06-10 19:12:39 +00004016 pNew->rRun += nIn;
drh5346e952013-05-08 14:14:26 +00004017 pNew->u.btree.nEq++;
drhb8a8e8a2013-06-10 19:12:39 +00004018 pNew->nOut = nRowEst + nInMul + nIn;
drh6fa978d2013-05-30 19:29:19 +00004019 }else if( pTerm->eOperator & (WO_EQ) ){
drh2e5ef4e2013-11-13 16:58:54 +00004020 assert(
4021 (pNew->wsFlags & (WHERE_COLUMN_NULL|WHERE_COLUMN_IN|WHERE_SKIPSCAN))!=0
4022 || nInMul==0
4023 );
drha18f3d22013-05-08 03:05:41 +00004024 pNew->wsFlags |= WHERE_COLUMN_EQ;
drhe39a7322014-02-03 14:04:11 +00004025 if( iCol<0 || (nInMul==0 && pNew->u.btree.nEq==pProbe->nKeyCol-1)){
drh4a5acf82013-06-18 20:06:23 +00004026 assert( (pNew->wsFlags & WHERE_COLUMN_IN)==0 || iCol<0 );
drhe39a7322014-02-03 14:04:11 +00004027 if( iCol>=0 && pProbe->onError==OE_None ){
4028 pNew->wsFlags |= WHERE_UNQ_WANTED;
4029 }else{
4030 pNew->wsFlags |= WHERE_ONEROW;
4031 }
drh21f7ff72013-06-03 15:07:23 +00004032 }
drh5346e952013-05-08 14:14:26 +00004033 pNew->u.btree.nEq++;
drhb8a8e8a2013-06-10 19:12:39 +00004034 pNew->nOut = nRowEst + nInMul;
drh6fa978d2013-05-30 19:29:19 +00004035 }else if( pTerm->eOperator & (WO_ISNULL) ){
4036 pNew->wsFlags |= WHERE_COLUMN_NULL;
4037 pNew->u.btree.nEq++;
drhe1e2e9a2013-06-13 15:16:53 +00004038 /* TUNING: IS NULL selects 2 rows */
drhbf539c42013-10-05 18:16:02 +00004039 nIn = 10; assert( 10==sqlite3LogEst(2) );
drhb8a8e8a2013-06-10 19:12:39 +00004040 pNew->nOut = nRowEst + nInMul + nIn;
drha18f3d22013-05-08 03:05:41 +00004041 }else if( pTerm->eOperator & (WO_GT|WO_GE) ){
drh7963b0e2013-06-17 21:37:40 +00004042 testcase( pTerm->eOperator & WO_GT );
4043 testcase( pTerm->eOperator & WO_GE );
drha18f3d22013-05-08 03:05:41 +00004044 pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_BTM_LIMIT;
drh6f2bfad2013-06-03 17:35:22 +00004045 pBtm = pTerm;
4046 pTop = 0;
drh7963b0e2013-06-17 21:37:40 +00004047 }else{
4048 assert( pTerm->eOperator & (WO_LT|WO_LE) );
4049 testcase( pTerm->eOperator & WO_LT );
4050 testcase( pTerm->eOperator & WO_LE );
drha18f3d22013-05-08 03:05:41 +00004051 pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_TOP_LIMIT;
drh6f2bfad2013-06-03 17:35:22 +00004052 pTop = pTerm;
4053 pBtm = (pNew->wsFlags & WHERE_BTM_LIMIT)!=0 ?
drh4efc9292013-06-06 23:02:03 +00004054 pNew->aLTerm[pNew->nLTerm-2] : 0;
drh1c8148f2013-05-04 20:25:23 +00004055 }
drh6f2bfad2013-06-03 17:35:22 +00004056 if( pNew->wsFlags & WHERE_COLUMN_RANGE ){
4057 /* Adjust nOut and rRun for STAT3 range values */
dan6cb8d762013-08-08 11:48:57 +00004058 assert( pNew->nOut==saved_nOut );
drh186ad8c2013-10-08 18:40:37 +00004059 whereRangeScanEst(pParse, pBuilder, pBtm, pTop, pNew);
drh6f2bfad2013-06-03 17:35:22 +00004060 }
drh1435a9a2013-08-27 23:15:44 +00004061#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan8ad169a2013-08-12 20:14:04 +00004062 if( nInMul==0
4063 && pProbe->nSample
4064 && pNew->u.btree.nEq<=pProbe->nSampleCol
4065 && OptimizationEnabled(db, SQLITE_Stat3)
4066 ){
dan7a419232013-08-06 20:01:43 +00004067 Expr *pExpr = pTerm->pExpr;
drhb8a8e8a2013-06-10 19:12:39 +00004068 tRowcnt nOut = 0;
drh6f2bfad2013-06-03 17:35:22 +00004069 if( (pTerm->eOperator & (WO_EQ|WO_ISNULL))!=0 ){
drh93ec45d2013-06-17 18:20:48 +00004070 testcase( pTerm->eOperator & WO_EQ );
4071 testcase( pTerm->eOperator & WO_ISNULL );
dan7a419232013-08-06 20:01:43 +00004072 rc = whereEqualScanEst(pParse, pBuilder, pExpr->pRight, &nOut);
drh6f2bfad2013-06-03 17:35:22 +00004073 }else if( (pTerm->eOperator & WO_IN)
dan7a419232013-08-06 20:01:43 +00004074 && !ExprHasProperty(pExpr, EP_xIsSelect) ){
4075 rc = whereInScanEst(pParse, pBuilder, pExpr->x.pList, &nOut);
drh6f2bfad2013-06-03 17:35:22 +00004076 }
drh82846332013-08-01 17:21:26 +00004077 assert( nOut==0 || rc==SQLITE_OK );
dan6cb8d762013-08-08 11:48:57 +00004078 if( nOut ){
drh4f991892013-10-11 15:05:05 +00004079 pNew->nOut = sqlite3LogEst(nOut);
4080 if( pNew->nOut>saved_nOut ) pNew->nOut = saved_nOut;
dan6cb8d762013-08-08 11:48:57 +00004081 }
drh6f2bfad2013-06-03 17:35:22 +00004082 }
4083#endif
drhe217efc2013-06-12 03:48:41 +00004084 if( (pNew->wsFlags & (WHERE_IDX_ONLY|WHERE_IPK))==0 ){
drheb04de32013-05-10 15:16:30 +00004085 /* Each row involves a step of the index, then a binary search of
4086 ** the main table */
drhbf539c42013-10-05 18:16:02 +00004087 pNew->rRun = sqlite3LogEstAdd(pNew->rRun,rLogSize>27 ? rLogSize-17 : 10);
drheb04de32013-05-10 15:16:30 +00004088 }
drhe217efc2013-06-12 03:48:41 +00004089 /* Step cost for each output row */
drhb50596d2013-10-08 20:42:41 +00004090 pNew->rRun = sqlite3LogEstAdd(pNew->rRun, pNew->nOut);
drh4f991892013-10-11 15:05:05 +00004091 whereLoopOutputAdjust(pBuilder->pWC, pNew);
drhcf8fa7a2013-05-10 20:26:22 +00004092 rc = whereLoopInsert(pBuilder, pNew);
drh5346e952013-05-08 14:14:26 +00004093 if( (pNew->wsFlags & WHERE_TOP_LIMIT)==0
drhbbbdc832013-10-22 18:01:40 +00004094 && pNew->u.btree.nEq<(pProbe->nKeyCol + (pProbe->zName!=0))
drh5346e952013-05-08 14:14:26 +00004095 ){
drhb8a8e8a2013-06-10 19:12:39 +00004096 whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, nInMul+nIn);
drha18f3d22013-05-08 03:05:41 +00004097 }
danad45ed72013-08-08 12:21:32 +00004098 pNew->nOut = saved_nOut;
drh1435a9a2013-08-27 23:15:44 +00004099#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan7a419232013-08-06 20:01:43 +00004100 pBuilder->nRecValid = nRecValid;
dan7a419232013-08-06 20:01:43 +00004101#endif
drh1c8148f2013-05-04 20:25:23 +00004102 }
drh4efc9292013-06-06 23:02:03 +00004103 pNew->prereq = saved_prereq;
4104 pNew->u.btree.nEq = saved_nEq;
drhcd8629e2013-11-13 12:27:25 +00004105 pNew->u.btree.nSkip = saved_nSkip;
drh4efc9292013-06-06 23:02:03 +00004106 pNew->wsFlags = saved_wsFlags;
4107 pNew->nOut = saved_nOut;
4108 pNew->nLTerm = saved_nLTerm;
drh5346e952013-05-08 14:14:26 +00004109 return rc;
drh1c8148f2013-05-04 20:25:23 +00004110}
4111
4112/*
drh23f98da2013-05-21 15:52:07 +00004113** Return True if it is possible that pIndex might be useful in
4114** implementing the ORDER BY clause in pBuilder.
4115**
4116** Return False if pBuilder does not contain an ORDER BY clause or
4117** if there is no way for pIndex to be useful in implementing that
4118** ORDER BY clause.
4119*/
4120static int indexMightHelpWithOrderBy(
4121 WhereLoopBuilder *pBuilder,
4122 Index *pIndex,
4123 int iCursor
4124){
4125 ExprList *pOB;
drh6d381472013-06-13 17:58:08 +00004126 int ii, jj;
drh23f98da2013-05-21 15:52:07 +00004127
drh53cfbe92013-06-13 17:28:22 +00004128 if( pIndex->bUnordered ) return 0;
drh70d18342013-06-06 19:16:33 +00004129 if( (pOB = pBuilder->pWInfo->pOrderBy)==0 ) return 0;
drh23f98da2013-05-21 15:52:07 +00004130 for(ii=0; ii<pOB->nExpr; ii++){
drh45c154a2013-06-03 20:46:35 +00004131 Expr *pExpr = sqlite3ExprSkipCollate(pOB->a[ii].pExpr);
drh23f98da2013-05-21 15:52:07 +00004132 if( pExpr->op!=TK_COLUMN ) return 0;
4133 if( pExpr->iTable==iCursor ){
drhbbbdc832013-10-22 18:01:40 +00004134 for(jj=0; jj<pIndex->nKeyCol; jj++){
drh6d381472013-06-13 17:58:08 +00004135 if( pExpr->iColumn==pIndex->aiColumn[jj] ) return 1;
4136 }
drh23f98da2013-05-21 15:52:07 +00004137 }
4138 }
4139 return 0;
4140}
4141
4142/*
drh92a121f2013-06-10 12:15:47 +00004143** Return a bitmask where 1s indicate that the corresponding column of
4144** the table is used by an index. Only the first 63 columns are considered.
4145*/
drhfd5874d2013-06-12 14:52:39 +00004146static Bitmask columnsInIndex(Index *pIdx){
drh92a121f2013-06-10 12:15:47 +00004147 Bitmask m = 0;
4148 int j;
drhec95c442013-10-23 01:57:32 +00004149 for(j=pIdx->nColumn-1; j>=0; j--){
drh92a121f2013-06-10 12:15:47 +00004150 int x = pIdx->aiColumn[j];
drhec95c442013-10-23 01:57:32 +00004151 if( x>=0 ){
4152 testcase( x==BMS-1 );
4153 testcase( x==BMS-2 );
4154 if( x<BMS-1 ) m |= MASKBIT(x);
4155 }
drh92a121f2013-06-10 12:15:47 +00004156 }
4157 return m;
4158}
4159
drh4bd5f732013-07-31 23:22:39 +00004160/* Check to see if a partial index with pPartIndexWhere can be used
4161** in the current query. Return true if it can be and false if not.
4162*/
4163static int whereUsablePartialIndex(int iTab, WhereClause *pWC, Expr *pWhere){
4164 int i;
4165 WhereTerm *pTerm;
4166 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
4167 if( sqlite3ExprImpliesExpr(pTerm->pExpr, pWhere, iTab) ) return 1;
4168 }
4169 return 0;
4170}
drh92a121f2013-06-10 12:15:47 +00004171
4172/*
dan51576f42013-07-02 10:06:15 +00004173** Add all WhereLoop objects for a single table of the join where the table
drh0823c892013-05-11 00:06:23 +00004174** is idenfied by pBuilder->pNew->iTab. That table is guaranteed to be
4175** a b-tree table, not a virtual table.
drhf1b5f5b2013-05-02 00:15:01 +00004176*/
drh5346e952013-05-08 14:14:26 +00004177static int whereLoopAddBtree(
drh1c8148f2013-05-04 20:25:23 +00004178 WhereLoopBuilder *pBuilder, /* WHERE clause information */
drh1c8148f2013-05-04 20:25:23 +00004179 Bitmask mExtra /* Extra prerequesites for using this table */
drhf1b5f5b2013-05-02 00:15:01 +00004180){
drh70d18342013-06-06 19:16:33 +00004181 WhereInfo *pWInfo; /* WHERE analysis context */
drh1c8148f2013-05-04 20:25:23 +00004182 Index *pProbe; /* An index we are evaluating */
drh1c8148f2013-05-04 20:25:23 +00004183 Index sPk; /* A fake index object for the primary key */
4184 tRowcnt aiRowEstPk[2]; /* The aiRowEst[] value for the sPk index */
drhbbbdc832013-10-22 18:01:40 +00004185 i16 aiColumnPk = -1; /* The aColumn[] value for the sPk index */
drh70d18342013-06-06 19:16:33 +00004186 SrcList *pTabList; /* The FROM clause */
drh1c8148f2013-05-04 20:25:23 +00004187 struct SrcList_item *pSrc; /* The FROM clause btree term to add */
drh1c8148f2013-05-04 20:25:23 +00004188 WhereLoop *pNew; /* Template WhereLoop object */
drh5346e952013-05-08 14:14:26 +00004189 int rc = SQLITE_OK; /* Return code */
drhd044d202013-05-31 12:43:55 +00004190 int iSortIdx = 1; /* Index number */
drh23f98da2013-05-21 15:52:07 +00004191 int b; /* A boolean value */
drhbf539c42013-10-05 18:16:02 +00004192 LogEst rSize; /* number of rows in the table */
4193 LogEst rLogSize; /* Logarithm of the number of rows in the table */
drh4bd5f732013-07-31 23:22:39 +00004194 WhereClause *pWC; /* The parsed WHERE clause */
drh3495d202013-10-07 17:32:15 +00004195 Table *pTab; /* Table being queried */
drh23f98da2013-05-21 15:52:07 +00004196
drh1c8148f2013-05-04 20:25:23 +00004197 pNew = pBuilder->pNew;
drh70d18342013-06-06 19:16:33 +00004198 pWInfo = pBuilder->pWInfo;
4199 pTabList = pWInfo->pTabList;
4200 pSrc = pTabList->a + pNew->iTab;
drh3495d202013-10-07 17:32:15 +00004201 pTab = pSrc->pTab;
drh4bd5f732013-07-31 23:22:39 +00004202 pWC = pBuilder->pWC;
drh0823c892013-05-11 00:06:23 +00004203 assert( !IsVirtual(pSrc->pTab) );
drh1c8148f2013-05-04 20:25:23 +00004204
4205 if( pSrc->pIndex ){
4206 /* An INDEXED BY clause specifies a particular index to use */
4207 pProbe = pSrc->pIndex;
drhec95c442013-10-23 01:57:32 +00004208 }else if( !HasRowid(pTab) ){
4209 pProbe = pTab->pIndex;
drh1c8148f2013-05-04 20:25:23 +00004210 }else{
4211 /* There is no INDEXED BY clause. Create a fake Index object in local
4212 ** variable sPk to represent the rowid primary key index. Make this
4213 ** fake index the first in a chain of Index objects with all of the real
4214 ** indices to follow */
4215 Index *pFirst; /* First of real indices on the table */
4216 memset(&sPk, 0, sizeof(Index));
drhbbbdc832013-10-22 18:01:40 +00004217 sPk.nKeyCol = 1;
drh1c8148f2013-05-04 20:25:23 +00004218 sPk.aiColumn = &aiColumnPk;
4219 sPk.aiRowEst = aiRowEstPk;
4220 sPk.onError = OE_Replace;
drh3495d202013-10-07 17:32:15 +00004221 sPk.pTable = pTab;
4222 aiRowEstPk[0] = pTab->nRowEst;
drh1c8148f2013-05-04 20:25:23 +00004223 aiRowEstPk[1] = 1;
4224 pFirst = pSrc->pTab->pIndex;
4225 if( pSrc->notIndexed==0 ){
4226 /* The real indices of the table are only considered if the
4227 ** NOT INDEXED qualifier is omitted from the FROM clause */
4228 sPk.pNext = pFirst;
4229 }
4230 pProbe = &sPk;
4231 }
drh3495d202013-10-07 17:32:15 +00004232 rSize = sqlite3LogEst(pTab->nRowEst);
drheb04de32013-05-10 15:16:30 +00004233 rLogSize = estLog(rSize);
4234
drhfeb56e02013-08-23 17:33:46 +00004235#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drheb04de32013-05-10 15:16:30 +00004236 /* Automatic indexes */
drhaa32e3c2013-07-16 21:31:23 +00004237 if( !pBuilder->pOrSet
drh4fe425a2013-06-12 17:08:06 +00004238 && (pWInfo->pParse->db->flags & SQLITE_AutoIndex)!=0
4239 && pSrc->pIndex==0
drheb04de32013-05-10 15:16:30 +00004240 && !pSrc->viaCoroutine
4241 && !pSrc->notIndexed
drhec95c442013-10-23 01:57:32 +00004242 && HasRowid(pTab)
drheb04de32013-05-10 15:16:30 +00004243 && !pSrc->isCorrelated
dan62ba4e42014-01-15 18:21:41 +00004244 && !pSrc->isRecursive
drheb04de32013-05-10 15:16:30 +00004245 ){
4246 /* Generate auto-index WhereLoops */
drheb04de32013-05-10 15:16:30 +00004247 WhereTerm *pTerm;
4248 WhereTerm *pWCEnd = pWC->a + pWC->nTerm;
4249 for(pTerm=pWC->a; rc==SQLITE_OK && pTerm<pWCEnd; pTerm++){
drh79a13bf2013-05-31 20:28:28 +00004250 if( pTerm->prereqRight & pNew->maskSelf ) continue;
drheb04de32013-05-10 15:16:30 +00004251 if( termCanDriveIndex(pTerm, pSrc, 0) ){
4252 pNew->u.btree.nEq = 1;
drhcd8629e2013-11-13 12:27:25 +00004253 pNew->u.btree.nSkip = 0;
drhef866372013-05-22 20:49:02 +00004254 pNew->u.btree.pIndex = 0;
drh4efc9292013-06-06 23:02:03 +00004255 pNew->nLTerm = 1;
4256 pNew->aLTerm[0] = pTerm;
drhe1e2e9a2013-06-13 15:16:53 +00004257 /* TUNING: One-time cost for computing the automatic index is
drh986b3872013-06-28 21:12:20 +00004258 ** approximately 7*N*log2(N) where N is the number of rows in
drhe1e2e9a2013-06-13 15:16:53 +00004259 ** the table being indexed. */
drhbf539c42013-10-05 18:16:02 +00004260 pNew->rSetup = rLogSize + rSize + 28; assert( 28==sqlite3LogEst(7) );
drh986b3872013-06-28 21:12:20 +00004261 /* TUNING: Each index lookup yields 20 rows in the table. This
4262 ** is more than the usual guess of 10 rows, since we have no way
4263 ** of knowning how selective the index will ultimately be. It would
4264 ** not be unreasonable to make this value much larger. */
drhbf539c42013-10-05 18:16:02 +00004265 pNew->nOut = 43; assert( 43==sqlite3LogEst(20) );
drhb50596d2013-10-08 20:42:41 +00004266 pNew->rRun = sqlite3LogEstAdd(rLogSize,pNew->nOut);
drh986b3872013-06-28 21:12:20 +00004267 pNew->wsFlags = WHERE_AUTO_INDEX;
drheb04de32013-05-10 15:16:30 +00004268 pNew->prereq = mExtra | pTerm->prereqRight;
drhcf8fa7a2013-05-10 20:26:22 +00004269 rc = whereLoopInsert(pBuilder, pNew);
drheb04de32013-05-10 15:16:30 +00004270 }
4271 }
4272 }
drhfeb56e02013-08-23 17:33:46 +00004273#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh1c8148f2013-05-04 20:25:23 +00004274
4275 /* Loop over all indices
4276 */
drh23f98da2013-05-21 15:52:07 +00004277 for(; rc==SQLITE_OK && pProbe; pProbe=pProbe->pNext, iSortIdx++){
drh4bd5f732013-07-31 23:22:39 +00004278 if( pProbe->pPartIdxWhere!=0
4279 && !whereUsablePartialIndex(pNew->iTab, pWC, pProbe->pPartIdxWhere) ){
4280 continue; /* Partial index inappropriate for this query */
4281 }
drh5346e952013-05-08 14:14:26 +00004282 pNew->u.btree.nEq = 0;
drhcd8629e2013-11-13 12:27:25 +00004283 pNew->u.btree.nSkip = 0;
drh4efc9292013-06-06 23:02:03 +00004284 pNew->nLTerm = 0;
drh23f98da2013-05-21 15:52:07 +00004285 pNew->iSortIdx = 0;
drhb8a8e8a2013-06-10 19:12:39 +00004286 pNew->rSetup = 0;
drh23f98da2013-05-21 15:52:07 +00004287 pNew->prereq = mExtra;
drh74f91d42013-06-19 18:01:44 +00004288 pNew->nOut = rSize;
drh23f98da2013-05-21 15:52:07 +00004289 pNew->u.btree.pIndex = pProbe;
4290 b = indexMightHelpWithOrderBy(pBuilder, pProbe, pSrc->iCursor);
drh53cfbe92013-06-13 17:28:22 +00004291 /* The ONEPASS_DESIRED flags never occurs together with ORDER BY */
4292 assert( (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || b==0 );
drh43fe25f2013-05-07 23:06:23 +00004293 if( pProbe->tnum<=0 ){
4294 /* Integer primary key index */
4295 pNew->wsFlags = WHERE_IPK;
drh23f98da2013-05-21 15:52:07 +00004296
4297 /* Full table scan */
drhd044d202013-05-31 12:43:55 +00004298 pNew->iSortIdx = b ? iSortIdx : 0;
drhe1e2e9a2013-06-13 15:16:53 +00004299 /* TUNING: Cost of full table scan is 3*(N + log2(N)).
drhbf539c42013-10-05 18:16:02 +00004300 ** + The extra 3 factor is to encourage the use of indexed lookups
drhe13e9f52013-10-05 19:18:00 +00004301 ** over full scans. FIXME */
drhb50596d2013-10-08 20:42:41 +00004302 pNew->rRun = sqlite3LogEstAdd(rSize,rLogSize) + 16;
drh4f991892013-10-11 15:05:05 +00004303 whereLoopOutputAdjust(pWC, pNew);
drh23f98da2013-05-21 15:52:07 +00004304 rc = whereLoopInsert(pBuilder, pNew);
drhcca9f3d2013-09-06 15:23:29 +00004305 pNew->nOut = rSize;
drh23f98da2013-05-21 15:52:07 +00004306 if( rc ) break;
drh43fe25f2013-05-07 23:06:23 +00004307 }else{
drhec95c442013-10-23 01:57:32 +00004308 Bitmask m;
4309 if( pProbe->isCovering ){
4310 pNew->wsFlags = WHERE_IDX_ONLY | WHERE_INDEXED;
4311 m = 0;
4312 }else{
4313 m = pSrc->colUsed & ~columnsInIndex(pProbe);
4314 pNew->wsFlags = (m==0) ? (WHERE_IDX_ONLY|WHERE_INDEXED) : WHERE_INDEXED;
4315 }
drh1c8148f2013-05-04 20:25:23 +00004316
drh23f98da2013-05-21 15:52:07 +00004317 /* Full scan via index */
drh53cfbe92013-06-13 17:28:22 +00004318 if( b
drh702ba9f2013-11-07 21:25:13 +00004319 || !HasRowid(pTab)
drh53cfbe92013-06-13 17:28:22 +00004320 || ( m==0
4321 && pProbe->bUnordered==0
drh702ba9f2013-11-07 21:25:13 +00004322 && (pProbe->szIdxRow<pTab->szTabRow)
drh53cfbe92013-06-13 17:28:22 +00004323 && (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0
4324 && sqlite3GlobalConfig.bUseCis
4325 && OptimizationEnabled(pWInfo->pParse->db, SQLITE_CoverIdxScan)
4326 )
drhe3b7c922013-06-03 19:17:40 +00004327 ){
drh23f98da2013-05-21 15:52:07 +00004328 pNew->iSortIdx = b ? iSortIdx : 0;
drhe1e2e9a2013-06-13 15:16:53 +00004329 if( m==0 ){
drhd9e3cad2013-10-04 02:36:19 +00004330 /* TUNING: Cost of a covering index scan is K*(N + log2(N)).
drhb50596d2013-10-08 20:42:41 +00004331 ** + The extra factor K of between 1.1 and 3.0 that depends
4332 ** on the relative sizes of the table and the index. K
4333 ** is smaller for smaller indices, thus favoring them.
drhd9e3cad2013-10-04 02:36:19 +00004334 */
drhb50596d2013-10-08 20:42:41 +00004335 pNew->rRun = sqlite3LogEstAdd(rSize,rLogSize) + 1 +
4336 (15*pProbe->szIdxRow)/pTab->szTabRow;
drhe1e2e9a2013-06-13 15:16:53 +00004337 }else{
drhe1e2e9a2013-06-13 15:16:53 +00004338 /* TUNING: Cost of scanning a non-covering index is (N+1)*log2(N)
4339 ** which we will simplify to just N*log2(N) */
4340 pNew->rRun = rSize + rLogSize;
4341 }
drh4f991892013-10-11 15:05:05 +00004342 whereLoopOutputAdjust(pWC, pNew);
drh23f98da2013-05-21 15:52:07 +00004343 rc = whereLoopInsert(pBuilder, pNew);
drhcca9f3d2013-09-06 15:23:29 +00004344 pNew->nOut = rSize;
drh23f98da2013-05-21 15:52:07 +00004345 if( rc ) break;
4346 }
4347 }
dan7a419232013-08-06 20:01:43 +00004348
drhb8a8e8a2013-06-10 19:12:39 +00004349 rc = whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, 0);
drh1435a9a2013-08-27 23:15:44 +00004350#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan87cd9322013-08-07 15:52:41 +00004351 sqlite3Stat4ProbeFree(pBuilder->pRec);
4352 pBuilder->nRecValid = 0;
4353 pBuilder->pRec = 0;
danddc2d6e2013-08-06 20:15:06 +00004354#endif
drh1c8148f2013-05-04 20:25:23 +00004355
4356 /* If there was an INDEXED BY clause, then only that one index is
4357 ** considered. */
4358 if( pSrc->pIndex ) break;
4359 }
drh5346e952013-05-08 14:14:26 +00004360 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00004361}
4362
drh8636e9c2013-06-11 01:50:08 +00004363#ifndef SQLITE_OMIT_VIRTUALTABLE
drhf1b5f5b2013-05-02 00:15:01 +00004364/*
drh0823c892013-05-11 00:06:23 +00004365** Add all WhereLoop objects for a table of the join identified by
4366** pBuilder->pNew->iTab. That table is guaranteed to be a virtual table.
drhf1b5f5b2013-05-02 00:15:01 +00004367*/
drh5346e952013-05-08 14:14:26 +00004368static int whereLoopAddVirtual(
danff4b23b2013-11-12 12:17:16 +00004369 WhereLoopBuilder *pBuilder, /* WHERE clause information */
4370 Bitmask mExtra
drhf1b5f5b2013-05-02 00:15:01 +00004371){
drh70d18342013-06-06 19:16:33 +00004372 WhereInfo *pWInfo; /* WHERE analysis context */
drh5346e952013-05-08 14:14:26 +00004373 Parse *pParse; /* The parsing context */
4374 WhereClause *pWC; /* The WHERE clause */
4375 struct SrcList_item *pSrc; /* The FROM clause term to search */
4376 Table *pTab;
4377 sqlite3 *db;
4378 sqlite3_index_info *pIdxInfo;
4379 struct sqlite3_index_constraint *pIdxCons;
4380 struct sqlite3_index_constraint_usage *pUsage;
4381 WhereTerm *pTerm;
4382 int i, j;
4383 int iTerm, mxTerm;
drh4efc9292013-06-06 23:02:03 +00004384 int nConstraint;
drh5346e952013-05-08 14:14:26 +00004385 int seenIn = 0; /* True if an IN operator is seen */
4386 int seenVar = 0; /* True if a non-constant constraint is seen */
4387 int iPhase; /* 0: const w/o IN, 1: const, 2: no IN, 2: IN */
4388 WhereLoop *pNew;
drh5346e952013-05-08 14:14:26 +00004389 int rc = SQLITE_OK;
4390
drh70d18342013-06-06 19:16:33 +00004391 pWInfo = pBuilder->pWInfo;
4392 pParse = pWInfo->pParse;
drh5346e952013-05-08 14:14:26 +00004393 db = pParse->db;
4394 pWC = pBuilder->pWC;
drh5346e952013-05-08 14:14:26 +00004395 pNew = pBuilder->pNew;
drh70d18342013-06-06 19:16:33 +00004396 pSrc = &pWInfo->pTabList->a[pNew->iTab];
drhb2a90f02013-05-10 03:30:49 +00004397 pTab = pSrc->pTab;
drh0823c892013-05-11 00:06:23 +00004398 assert( IsVirtual(pTab) );
drhb2a90f02013-05-10 03:30:49 +00004399 pIdxInfo = allocateIndexInfo(pParse, pWC, pSrc, pBuilder->pOrderBy);
drh5346e952013-05-08 14:14:26 +00004400 if( pIdxInfo==0 ) return SQLITE_NOMEM;
drh5346e952013-05-08 14:14:26 +00004401 pNew->prereq = 0;
drh5346e952013-05-08 14:14:26 +00004402 pNew->rSetup = 0;
4403 pNew->wsFlags = WHERE_VIRTUALTABLE;
drh4efc9292013-06-06 23:02:03 +00004404 pNew->nLTerm = 0;
drh5346e952013-05-08 14:14:26 +00004405 pNew->u.vtab.needFree = 0;
4406 pUsage = pIdxInfo->aConstraintUsage;
drh4efc9292013-06-06 23:02:03 +00004407 nConstraint = pIdxInfo->nConstraint;
drh7963b0e2013-06-17 21:37:40 +00004408 if( whereLoopResize(db, pNew, nConstraint) ){
4409 sqlite3DbFree(db, pIdxInfo);
4410 return SQLITE_NOMEM;
4411 }
drh5346e952013-05-08 14:14:26 +00004412
drh0823c892013-05-11 00:06:23 +00004413 for(iPhase=0; iPhase<=3; iPhase++){
drh5346e952013-05-08 14:14:26 +00004414 if( !seenIn && (iPhase&1)!=0 ){
4415 iPhase++;
4416 if( iPhase>3 ) break;
4417 }
4418 if( !seenVar && iPhase>1 ) break;
4419 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
4420 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
4421 j = pIdxCons->iTermOffset;
4422 pTerm = &pWC->a[j];
4423 switch( iPhase ){
4424 case 0: /* Constants without IN operator */
4425 pIdxCons->usable = 0;
4426 if( (pTerm->eOperator & WO_IN)!=0 ){
4427 seenIn = 1;
drh7963b0e2013-06-17 21:37:40 +00004428 }
4429 if( pTerm->prereqRight!=0 ){
drh5346e952013-05-08 14:14:26 +00004430 seenVar = 1;
drh7963b0e2013-06-17 21:37:40 +00004431 }else if( (pTerm->eOperator & WO_IN)==0 ){
drh5346e952013-05-08 14:14:26 +00004432 pIdxCons->usable = 1;
4433 }
4434 break;
4435 case 1: /* Constants with IN operators */
4436 assert( seenIn );
4437 pIdxCons->usable = (pTerm->prereqRight==0);
4438 break;
4439 case 2: /* Variables without IN */
4440 assert( seenVar );
4441 pIdxCons->usable = (pTerm->eOperator & WO_IN)==0;
4442 break;
4443 default: /* Variables with IN */
4444 assert( seenVar && seenIn );
4445 pIdxCons->usable = 1;
4446 break;
4447 }
4448 }
4449 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
4450 if( pIdxInfo->needToFreeIdxStr ) sqlite3_free(pIdxInfo->idxStr);
4451 pIdxInfo->idxStr = 0;
4452 pIdxInfo->idxNum = 0;
4453 pIdxInfo->needToFreeIdxStr = 0;
4454 pIdxInfo->orderByConsumed = 0;
drh8636e9c2013-06-11 01:50:08 +00004455 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / (double)2;
dana9f58152013-11-11 19:01:33 +00004456 pIdxInfo->estimatedRows = 25;
drh5346e952013-05-08 14:14:26 +00004457 rc = vtabBestIndex(pParse, pTab, pIdxInfo);
4458 if( rc ) goto whereLoopAddVtab_exit;
4459 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
danff4b23b2013-11-12 12:17:16 +00004460 pNew->prereq = mExtra;
drhc718f1c2013-05-08 20:05:58 +00004461 mxTerm = -1;
drh4efc9292013-06-06 23:02:03 +00004462 assert( pNew->nLSlot>=nConstraint );
4463 for(i=0; i<nConstraint; i++) pNew->aLTerm[i] = 0;
drh3bd26f02013-05-24 14:52:03 +00004464 pNew->u.vtab.omitMask = 0;
drh4efc9292013-06-06 23:02:03 +00004465 for(i=0; i<nConstraint; i++, pIdxCons++){
drh5346e952013-05-08 14:14:26 +00004466 if( (iTerm = pUsage[i].argvIndex - 1)>=0 ){
4467 j = pIdxCons->iTermOffset;
drh4efc9292013-06-06 23:02:03 +00004468 if( iTerm>=nConstraint
drh5346e952013-05-08 14:14:26 +00004469 || j<0
4470 || j>=pWC->nTerm
drh4efc9292013-06-06 23:02:03 +00004471 || pNew->aLTerm[iTerm]!=0
drh5346e952013-05-08 14:14:26 +00004472 ){
4473 rc = SQLITE_ERROR;
4474 sqlite3ErrorMsg(pParse, "%s.xBestIndex() malfunction", pTab->zName);
4475 goto whereLoopAddVtab_exit;
4476 }
drh7963b0e2013-06-17 21:37:40 +00004477 testcase( iTerm==nConstraint-1 );
4478 testcase( j==0 );
4479 testcase( j==pWC->nTerm-1 );
drh5346e952013-05-08 14:14:26 +00004480 pTerm = &pWC->a[j];
4481 pNew->prereq |= pTerm->prereqRight;
drh4efc9292013-06-06 23:02:03 +00004482 assert( iTerm<pNew->nLSlot );
4483 pNew->aLTerm[iTerm] = pTerm;
drh5346e952013-05-08 14:14:26 +00004484 if( iTerm>mxTerm ) mxTerm = iTerm;
drh7963b0e2013-06-17 21:37:40 +00004485 testcase( iTerm==15 );
4486 testcase( iTerm==16 );
drh52986302013-06-03 16:03:16 +00004487 if( iTerm<16 && pUsage[i].omit ) pNew->u.vtab.omitMask |= 1<<iTerm;
drh5346e952013-05-08 14:14:26 +00004488 if( (pTerm->eOperator & WO_IN)!=0 ){
4489 if( pUsage[i].omit==0 ){
4490 /* Do not attempt to use an IN constraint if the virtual table
4491 ** says that the equivalent EQ constraint cannot be safely omitted.
4492 ** If we do attempt to use such a constraint, some rows might be
4493 ** repeated in the output. */
4494 break;
4495 }
4496 /* A virtual table that is constrained by an IN clause may not
4497 ** consume the ORDER BY clause because (1) the order of IN terms
4498 ** is not necessarily related to the order of output terms and
4499 ** (2) Multiple outputs from a single IN value will not merge
4500 ** together. */
4501 pIdxInfo->orderByConsumed = 0;
4502 }
4503 }
4504 }
drh4efc9292013-06-06 23:02:03 +00004505 if( i>=nConstraint ){
4506 pNew->nLTerm = mxTerm+1;
4507 assert( pNew->nLTerm<=pNew->nLSlot );
drh5346e952013-05-08 14:14:26 +00004508 pNew->u.vtab.idxNum = pIdxInfo->idxNum;
4509 pNew->u.vtab.needFree = pIdxInfo->needToFreeIdxStr;
4510 pIdxInfo->needToFreeIdxStr = 0;
4511 pNew->u.vtab.idxStr = pIdxInfo->idxStr;
drh0401ace2014-03-18 15:30:27 +00004512 pNew->u.vtab.isOrdered = (i8)(pIdxInfo->orderByConsumed ?
4513 pIdxInfo->nOrderBy : 0);
drhb8a8e8a2013-06-10 19:12:39 +00004514 pNew->rSetup = 0;
drhb50596d2013-10-08 20:42:41 +00004515 pNew->rRun = sqlite3LogEstFromDouble(pIdxInfo->estimatedCost);
dana9f58152013-11-11 19:01:33 +00004516 pNew->nOut = sqlite3LogEst(pIdxInfo->estimatedRows);
drhcf8fa7a2013-05-10 20:26:22 +00004517 whereLoopInsert(pBuilder, pNew);
drh5346e952013-05-08 14:14:26 +00004518 if( pNew->u.vtab.needFree ){
4519 sqlite3_free(pNew->u.vtab.idxStr);
4520 pNew->u.vtab.needFree = 0;
4521 }
4522 }
4523 }
4524
4525whereLoopAddVtab_exit:
4526 if( pIdxInfo->needToFreeIdxStr ) sqlite3_free(pIdxInfo->idxStr);
4527 sqlite3DbFree(db, pIdxInfo);
4528 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00004529}
drh8636e9c2013-06-11 01:50:08 +00004530#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhf1b5f5b2013-05-02 00:15:01 +00004531
4532/*
drhcf8fa7a2013-05-10 20:26:22 +00004533** Add WhereLoop entries to handle OR terms. This works for either
4534** btrees or virtual tables.
4535*/
4536static int whereLoopAddOr(WhereLoopBuilder *pBuilder, Bitmask mExtra){
drh70d18342013-06-06 19:16:33 +00004537 WhereInfo *pWInfo = pBuilder->pWInfo;
drhcf8fa7a2013-05-10 20:26:22 +00004538 WhereClause *pWC;
4539 WhereLoop *pNew;
4540 WhereTerm *pTerm, *pWCEnd;
4541 int rc = SQLITE_OK;
4542 int iCur;
4543 WhereClause tempWC;
4544 WhereLoopBuilder sSubBuild;
drhaa32e3c2013-07-16 21:31:23 +00004545 WhereOrSet sSum, sCur, sPrev;
drhcf8fa7a2013-05-10 20:26:22 +00004546 struct SrcList_item *pItem;
4547
drhcf8fa7a2013-05-10 20:26:22 +00004548 pWC = pBuilder->pWC;
drh70d18342013-06-06 19:16:33 +00004549 if( pWInfo->wctrlFlags & WHERE_AND_ONLY ) return SQLITE_OK;
drhcf8fa7a2013-05-10 20:26:22 +00004550 pWCEnd = pWC->a + pWC->nTerm;
4551 pNew = pBuilder->pNew;
drh77dfd5b2013-08-19 11:15:48 +00004552 memset(&sSum, 0, sizeof(sSum));
drh186ad8c2013-10-08 18:40:37 +00004553 pItem = pWInfo->pTabList->a + pNew->iTab;
drhd4ddae92013-11-06 12:05:57 +00004554 if( !HasRowid(pItem->pTab) ) return SQLITE_OK;
drh186ad8c2013-10-08 18:40:37 +00004555 iCur = pItem->iCursor;
drhcf8fa7a2013-05-10 20:26:22 +00004556
4557 for(pTerm=pWC->a; pTerm<pWCEnd && rc==SQLITE_OK; pTerm++){
4558 if( (pTerm->eOperator & WO_OR)!=0
4559 && (pTerm->u.pOrInfo->indexable & pNew->maskSelf)!=0
4560 ){
4561 WhereClause * const pOrWC = &pTerm->u.pOrInfo->wc;
4562 WhereTerm * const pOrWCEnd = &pOrWC->a[pOrWC->nTerm];
4563 WhereTerm *pOrTerm;
drhaa32e3c2013-07-16 21:31:23 +00004564 int once = 1;
4565 int i, j;
drh783dece2013-06-05 17:53:43 +00004566
drh783dece2013-06-05 17:53:43 +00004567 sSubBuild = *pBuilder;
4568 sSubBuild.pOrderBy = 0;
drhaa32e3c2013-07-16 21:31:23 +00004569 sSubBuild.pOrSet = &sCur;
drhcf8fa7a2013-05-10 20:26:22 +00004570
drhc7f0d222013-06-19 03:27:12 +00004571 for(pOrTerm=pOrWC->a; pOrTerm<pOrWCEnd; pOrTerm++){
drh783dece2013-06-05 17:53:43 +00004572 if( (pOrTerm->eOperator & WO_AND)!=0 ){
drhcf8fa7a2013-05-10 20:26:22 +00004573 sSubBuild.pWC = &pOrTerm->u.pAndInfo->wc;
4574 }else if( pOrTerm->leftCursor==iCur ){
drh70d18342013-06-06 19:16:33 +00004575 tempWC.pWInfo = pWC->pWInfo;
drh783dece2013-06-05 17:53:43 +00004576 tempWC.pOuter = pWC;
4577 tempWC.op = TK_AND;
drh783dece2013-06-05 17:53:43 +00004578 tempWC.nTerm = 1;
drhcf8fa7a2013-05-10 20:26:22 +00004579 tempWC.a = pOrTerm;
4580 sSubBuild.pWC = &tempWC;
4581 }else{
4582 continue;
4583 }
drhaa32e3c2013-07-16 21:31:23 +00004584 sCur.n = 0;
drh8636e9c2013-06-11 01:50:08 +00004585#ifndef SQLITE_OMIT_VIRTUALTABLE
drhcf8fa7a2013-05-10 20:26:22 +00004586 if( IsVirtual(pItem->pTab) ){
danff4b23b2013-11-12 12:17:16 +00004587 rc = whereLoopAddVirtual(&sSubBuild, mExtra);
drh8636e9c2013-06-11 01:50:08 +00004588 }else
4589#endif
4590 {
drhcf8fa7a2013-05-10 20:26:22 +00004591 rc = whereLoopAddBtree(&sSubBuild, mExtra);
4592 }
drhaa32e3c2013-07-16 21:31:23 +00004593 assert( rc==SQLITE_OK || sCur.n==0 );
4594 if( sCur.n==0 ){
4595 sSum.n = 0;
4596 break;
4597 }else if( once ){
4598 whereOrMove(&sSum, &sCur);
4599 once = 0;
4600 }else{
4601 whereOrMove(&sPrev, &sSum);
4602 sSum.n = 0;
4603 for(i=0; i<sPrev.n; i++){
4604 for(j=0; j<sCur.n; j++){
4605 whereOrInsert(&sSum, sPrev.a[i].prereq | sCur.a[j].prereq,
drhbf539c42013-10-05 18:16:02 +00004606 sqlite3LogEstAdd(sPrev.a[i].rRun, sCur.a[j].rRun),
4607 sqlite3LogEstAdd(sPrev.a[i].nOut, sCur.a[j].nOut));
drhaa32e3c2013-07-16 21:31:23 +00004608 }
4609 }
4610 }
drhcf8fa7a2013-05-10 20:26:22 +00004611 }
drhaa32e3c2013-07-16 21:31:23 +00004612 pNew->nLTerm = 1;
4613 pNew->aLTerm[0] = pTerm;
4614 pNew->wsFlags = WHERE_MULTI_OR;
4615 pNew->rSetup = 0;
4616 pNew->iSortIdx = 0;
4617 memset(&pNew->u, 0, sizeof(pNew->u));
4618 for(i=0; rc==SQLITE_OK && i<sSum.n; i++){
drh74f91d42013-06-19 18:01:44 +00004619 /* TUNING: Multiple by 3.5 for the secondary table lookup */
drhaa32e3c2013-07-16 21:31:23 +00004620 pNew->rRun = sSum.a[i].rRun + 18;
4621 pNew->nOut = sSum.a[i].nOut;
4622 pNew->prereq = sSum.a[i].prereq;
drhfd5874d2013-06-12 14:52:39 +00004623 rc = whereLoopInsert(pBuilder, pNew);
4624 }
drhcf8fa7a2013-05-10 20:26:22 +00004625 }
4626 }
4627 return rc;
4628}
4629
4630/*
drhf1b5f5b2013-05-02 00:15:01 +00004631** Add all WhereLoop objects for all tables
4632*/
drh5346e952013-05-08 14:14:26 +00004633static int whereLoopAddAll(WhereLoopBuilder *pBuilder){
drh70d18342013-06-06 19:16:33 +00004634 WhereInfo *pWInfo = pBuilder->pWInfo;
drhf1b5f5b2013-05-02 00:15:01 +00004635 Bitmask mExtra = 0;
4636 Bitmask mPrior = 0;
4637 int iTab;
drh70d18342013-06-06 19:16:33 +00004638 SrcList *pTabList = pWInfo->pTabList;
drhf1b5f5b2013-05-02 00:15:01 +00004639 struct SrcList_item *pItem;
drh70d18342013-06-06 19:16:33 +00004640 sqlite3 *db = pWInfo->pParse->db;
4641 int nTabList = pWInfo->nLevel;
drh5346e952013-05-08 14:14:26 +00004642 int rc = SQLITE_OK;
drhc63367e2013-06-10 20:46:50 +00004643 u8 priorJoinType = 0;
drhb8a8e8a2013-06-10 19:12:39 +00004644 WhereLoop *pNew;
drhf1b5f5b2013-05-02 00:15:01 +00004645
4646 /* Loop over the tables in the join, from left to right */
drhb8a8e8a2013-06-10 19:12:39 +00004647 pNew = pBuilder->pNew;
drha2014152013-06-07 00:29:23 +00004648 whereLoopInit(pNew);
drha18f3d22013-05-08 03:05:41 +00004649 for(iTab=0, pItem=pTabList->a; iTab<nTabList; iTab++, pItem++){
drhb2a90f02013-05-10 03:30:49 +00004650 pNew->iTab = iTab;
drh70d18342013-06-06 19:16:33 +00004651 pNew->maskSelf = getMask(&pWInfo->sMaskSet, pItem->iCursor);
drhc63367e2013-06-10 20:46:50 +00004652 if( ((pItem->jointype|priorJoinType) & (JT_LEFT|JT_CROSS))!=0 ){
drhf1b5f5b2013-05-02 00:15:01 +00004653 mExtra = mPrior;
4654 }
drhc63367e2013-06-10 20:46:50 +00004655 priorJoinType = pItem->jointype;
drhb2a90f02013-05-10 03:30:49 +00004656 if( IsVirtual(pItem->pTab) ){
danff4b23b2013-11-12 12:17:16 +00004657 rc = whereLoopAddVirtual(pBuilder, mExtra);
drhb2a90f02013-05-10 03:30:49 +00004658 }else{
4659 rc = whereLoopAddBtree(pBuilder, mExtra);
4660 }
drhb2a90f02013-05-10 03:30:49 +00004661 if( rc==SQLITE_OK ){
4662 rc = whereLoopAddOr(pBuilder, mExtra);
4663 }
drhb2a90f02013-05-10 03:30:49 +00004664 mPrior |= pNew->maskSelf;
drh5346e952013-05-08 14:14:26 +00004665 if( rc || db->mallocFailed ) break;
drhf1b5f5b2013-05-02 00:15:01 +00004666 }
drha2014152013-06-07 00:29:23 +00004667 whereLoopClear(db, pNew);
drh5346e952013-05-08 14:14:26 +00004668 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00004669}
4670
drha18f3d22013-05-08 03:05:41 +00004671/*
drh7699d1c2013-06-04 12:42:29 +00004672** Examine a WherePath (with the addition of the extra WhereLoop of the 5th
drh319f6772013-05-14 15:31:07 +00004673** parameters) to see if it outputs rows in the requested ORDER BY
drh0401ace2014-03-18 15:30:27 +00004674** (or GROUP BY) without requiring a separate sort operation. Return N:
drh319f6772013-05-14 15:31:07 +00004675**
drh0401ace2014-03-18 15:30:27 +00004676** N>0: N terms of the ORDER BY clause are satisfied
4677** N==0: No terms of the ORDER BY clause are satisfied
4678** N<0: Unknown yet how many terms of ORDER BY might be satisfied.
drh319f6772013-05-14 15:31:07 +00004679**
drh94433422013-07-01 11:05:50 +00004680** Note that processing for WHERE_GROUPBY and WHERE_DISTINCTBY is not as
4681** strict. With GROUP BY and DISTINCT the only requirement is that
4682** equivalent rows appear immediately adjacent to one another. GROUP BY
4683** and DISTINT do not require rows to appear in any particular order as long
4684** as equivelent rows are grouped together. Thus for GROUP BY and DISTINCT
4685** the pOrderBy terms can be matched in any order. With ORDER BY, the
4686** pOrderBy terms must be matched in strict left-to-right order.
drh6b7157b2013-05-10 02:00:35 +00004687*/
drh0401ace2014-03-18 15:30:27 +00004688static i8 wherePathSatisfiesOrderBy(
drh6b7157b2013-05-10 02:00:35 +00004689 WhereInfo *pWInfo, /* The WHERE clause */
drh4f402f22013-06-11 18:59:38 +00004690 ExprList *pOrderBy, /* ORDER BY or GROUP BY or DISTINCT clause to check */
drh6b7157b2013-05-10 02:00:35 +00004691 WherePath *pPath, /* The WherePath to check */
drh4f402f22013-06-11 18:59:38 +00004692 u16 wctrlFlags, /* Might contain WHERE_GROUPBY or WHERE_DISTINCTBY */
4693 u16 nLoop, /* Number of entries in pPath->aLoop[] */
drh319f6772013-05-14 15:31:07 +00004694 WhereLoop *pLast, /* Add this WhereLoop to the end of pPath->aLoop[] */
drh4f402f22013-06-11 18:59:38 +00004695 Bitmask *pRevMask /* OUT: Mask of WhereLoops to run in reverse order */
drh6b7157b2013-05-10 02:00:35 +00004696){
drh88da6442013-05-27 17:59:37 +00004697 u8 revSet; /* True if rev is known */
4698 u8 rev; /* Composite sort order */
4699 u8 revIdx; /* Index sort order */
drhe353ee32013-06-04 23:40:53 +00004700 u8 isOrderDistinct; /* All prior WhereLoops are order-distinct */
4701 u8 distinctColumns; /* True if the loop has UNIQUE NOT NULL columns */
4702 u8 isMatch; /* iColumn matches a term of the ORDER BY clause */
drh416846a2013-11-06 12:56:04 +00004703 u16 nKeyCol; /* Number of key columns in pIndex */
4704 u16 nColumn; /* Total number of ordered columns in the index */
drh7699d1c2013-06-04 12:42:29 +00004705 u16 nOrderBy; /* Number terms in the ORDER BY clause */
4706 int iLoop; /* Index of WhereLoop in pPath being processed */
4707 int i, j; /* Loop counters */
4708 int iCur; /* Cursor number for current WhereLoop */
4709 int iColumn; /* A column number within table iCur */
drhe8ae5832013-06-19 13:32:46 +00004710 WhereLoop *pLoop = 0; /* Current WhereLoop being processed. */
drh7699d1c2013-06-04 12:42:29 +00004711 WhereTerm *pTerm; /* A single term of the WHERE clause */
4712 Expr *pOBExpr; /* An expression from the ORDER BY clause */
4713 CollSeq *pColl; /* COLLATE function from an ORDER BY clause term */
4714 Index *pIndex; /* The index associated with pLoop */
4715 sqlite3 *db = pWInfo->pParse->db; /* Database connection */
4716 Bitmask obSat = 0; /* Mask of ORDER BY terms satisfied so far */
4717 Bitmask obDone; /* Mask of all ORDER BY terms */
drhe353ee32013-06-04 23:40:53 +00004718 Bitmask orderDistinctMask; /* Mask of all well-ordered loops */
drhb8916be2013-06-14 02:51:48 +00004719 Bitmask ready; /* Mask of inner loops */
drh319f6772013-05-14 15:31:07 +00004720
4721 /*
drh7699d1c2013-06-04 12:42:29 +00004722 ** We say the WhereLoop is "one-row" if it generates no more than one
4723 ** row of output. A WhereLoop is one-row if all of the following are true:
drh319f6772013-05-14 15:31:07 +00004724 ** (a) All index columns match with WHERE_COLUMN_EQ.
4725 ** (b) The index is unique
drh7699d1c2013-06-04 12:42:29 +00004726 ** Any WhereLoop with an WHERE_COLUMN_EQ constraint on the rowid is one-row.
4727 ** Every one-row WhereLoop will have the WHERE_ONEROW bit set in wsFlags.
drh319f6772013-05-14 15:31:07 +00004728 **
drhe353ee32013-06-04 23:40:53 +00004729 ** We say the WhereLoop is "order-distinct" if the set of columns from
4730 ** that WhereLoop that are in the ORDER BY clause are different for every
4731 ** row of the WhereLoop. Every one-row WhereLoop is automatically
4732 ** order-distinct. A WhereLoop that has no columns in the ORDER BY clause
4733 ** is not order-distinct. To be order-distinct is not quite the same as being
4734 ** UNIQUE since a UNIQUE column or index can have multiple rows that
4735 ** are NULL and NULL values are equivalent for the purpose of order-distinct.
4736 ** To be order-distinct, the columns must be UNIQUE and NOT NULL.
4737 **
4738 ** The rowid for a table is always UNIQUE and NOT NULL so whenever the
4739 ** rowid appears in the ORDER BY clause, the corresponding WhereLoop is
4740 ** automatically order-distinct.
drh319f6772013-05-14 15:31:07 +00004741 */
4742
4743 assert( pOrderBy!=0 );
4744
4745 /* Sortability of virtual tables is determined by the xBestIndex method
4746 ** of the virtual table itself */
4747 if( pLast->wsFlags & WHERE_VIRTUALTABLE ){
drh7699d1c2013-06-04 12:42:29 +00004748 testcase( nLoop>0 ); /* True when outer loops are one-row and match
4749 ** no ORDER BY terms */
drh319f6772013-05-14 15:31:07 +00004750 return pLast->u.vtab.isOrdered;
drh6b7157b2013-05-10 02:00:35 +00004751 }
drh7699d1c2013-06-04 12:42:29 +00004752 if( nLoop && OptimizationDisabled(db, SQLITE_OrderByIdxJoin) ) return 0;
drh319f6772013-05-14 15:31:07 +00004753
drh319f6772013-05-14 15:31:07 +00004754 nOrderBy = pOrderBy->nExpr;
drh7963b0e2013-06-17 21:37:40 +00004755 testcase( nOrderBy==BMS-1 );
drhe353ee32013-06-04 23:40:53 +00004756 if( nOrderBy>BMS-1 ) return 0; /* Cannot optimize overly large ORDER BYs */
4757 isOrderDistinct = 1;
drh7699d1c2013-06-04 12:42:29 +00004758 obDone = MASKBIT(nOrderBy)-1;
drhe353ee32013-06-04 23:40:53 +00004759 orderDistinctMask = 0;
drhb8916be2013-06-14 02:51:48 +00004760 ready = 0;
drhe353ee32013-06-04 23:40:53 +00004761 for(iLoop=0; isOrderDistinct && obSat<obDone && iLoop<=nLoop; iLoop++){
drhb8916be2013-06-14 02:51:48 +00004762 if( iLoop>0 ) ready |= pLoop->maskSelf;
drh7699d1c2013-06-04 12:42:29 +00004763 pLoop = iLoop<nLoop ? pPath->aLoop[iLoop] : pLast;
drh319f6772013-05-14 15:31:07 +00004764 assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
drh319f6772013-05-14 15:31:07 +00004765 iCur = pWInfo->pTabList->a[pLoop->iTab].iCursor;
drhb8916be2013-06-14 02:51:48 +00004766
4767 /* Mark off any ORDER BY term X that is a column in the table of
4768 ** the current loop for which there is term in the WHERE
4769 ** clause of the form X IS NULL or X=? that reference only outer
4770 ** loops.
4771 */
4772 for(i=0; i<nOrderBy; i++){
4773 if( MASKBIT(i) & obSat ) continue;
4774 pOBExpr = sqlite3ExprSkipCollate(pOrderBy->a[i].pExpr);
4775 if( pOBExpr->op!=TK_COLUMN ) continue;
4776 if( pOBExpr->iTable!=iCur ) continue;
4777 pTerm = findTerm(&pWInfo->sWC, iCur, pOBExpr->iColumn,
4778 ~ready, WO_EQ|WO_ISNULL, 0);
4779 if( pTerm==0 ) continue;
drh7963b0e2013-06-17 21:37:40 +00004780 if( (pTerm->eOperator&WO_EQ)!=0 && pOBExpr->iColumn>=0 ){
drhb8916be2013-06-14 02:51:48 +00004781 const char *z1, *z2;
4782 pColl = sqlite3ExprCollSeq(pWInfo->pParse, pOrderBy->a[i].pExpr);
4783 if( !pColl ) pColl = db->pDfltColl;
4784 z1 = pColl->zName;
4785 pColl = sqlite3ExprCollSeq(pWInfo->pParse, pTerm->pExpr);
4786 if( !pColl ) pColl = db->pDfltColl;
4787 z2 = pColl->zName;
4788 if( sqlite3StrICmp(z1, z2)!=0 ) continue;
4789 }
4790 obSat |= MASKBIT(i);
4791 }
4792
drh7699d1c2013-06-04 12:42:29 +00004793 if( (pLoop->wsFlags & WHERE_ONEROW)==0 ){
4794 if( pLoop->wsFlags & WHERE_IPK ){
4795 pIndex = 0;
drhbbbdc832013-10-22 18:01:40 +00004796 nKeyCol = 0;
drh416846a2013-11-06 12:56:04 +00004797 nColumn = 1;
drh7699d1c2013-06-04 12:42:29 +00004798 }else if( (pIndex = pLoop->u.btree.pIndex)==0 || pIndex->bUnordered ){
drh1b0f0262013-05-30 22:27:09 +00004799 return 0;
drh7699d1c2013-06-04 12:42:29 +00004800 }else{
drhbbbdc832013-10-22 18:01:40 +00004801 nKeyCol = pIndex->nKeyCol;
drh416846a2013-11-06 12:56:04 +00004802 nColumn = pIndex->nColumn;
4803 assert( nColumn==nKeyCol+1 || !HasRowid(pIndex->pTable) );
4804 assert( pIndex->aiColumn[nColumn-1]==(-1) || !HasRowid(pIndex->pTable));
drhe353ee32013-06-04 23:40:53 +00004805 isOrderDistinct = pIndex->onError!=OE_None;
drh1b0f0262013-05-30 22:27:09 +00004806 }
drh7699d1c2013-06-04 12:42:29 +00004807
drh7699d1c2013-06-04 12:42:29 +00004808 /* Loop through all columns of the index and deal with the ones
4809 ** that are not constrained by == or IN.
4810 */
4811 rev = revSet = 0;
drhe353ee32013-06-04 23:40:53 +00004812 distinctColumns = 0;
drh416846a2013-11-06 12:56:04 +00004813 for(j=0; j<nColumn; j++){
drh7699d1c2013-06-04 12:42:29 +00004814 u8 bOnce; /* True to run the ORDER BY search loop */
4815
drhe353ee32013-06-04 23:40:53 +00004816 /* Skip over == and IS NULL terms */
drh7699d1c2013-06-04 12:42:29 +00004817 if( j<pLoop->u.btree.nEq
drhcd8629e2013-11-13 12:27:25 +00004818 && pLoop->u.btree.nSkip==0
drh4efc9292013-06-06 23:02:03 +00004819 && ((i = pLoop->aLTerm[j]->eOperator) & (WO_EQ|WO_ISNULL))!=0
drh7699d1c2013-06-04 12:42:29 +00004820 ){
drh7963b0e2013-06-17 21:37:40 +00004821 if( i & WO_ISNULL ){
4822 testcase( isOrderDistinct );
4823 isOrderDistinct = 0;
4824 }
drhe353ee32013-06-04 23:40:53 +00004825 continue;
drh7699d1c2013-06-04 12:42:29 +00004826 }
4827
drhe353ee32013-06-04 23:40:53 +00004828 /* Get the column number in the table (iColumn) and sort order
4829 ** (revIdx) for the j-th column of the index.
drh7699d1c2013-06-04 12:42:29 +00004830 */
drh416846a2013-11-06 12:56:04 +00004831 if( pIndex ){
drh7699d1c2013-06-04 12:42:29 +00004832 iColumn = pIndex->aiColumn[j];
4833 revIdx = pIndex->aSortOrder[j];
4834 if( iColumn==pIndex->pTable->iPKey ) iColumn = -1;
drhdc3cd4b2013-05-30 23:21:20 +00004835 }else{
drh7699d1c2013-06-04 12:42:29 +00004836 iColumn = -1;
4837 revIdx = 0;
drhdc3cd4b2013-05-30 23:21:20 +00004838 }
drh7699d1c2013-06-04 12:42:29 +00004839
4840 /* An unconstrained column that might be NULL means that this
drh416846a2013-11-06 12:56:04 +00004841 ** WhereLoop is not well-ordered
drh7699d1c2013-06-04 12:42:29 +00004842 */
drhe353ee32013-06-04 23:40:53 +00004843 if( isOrderDistinct
4844 && iColumn>=0
drh7699d1c2013-06-04 12:42:29 +00004845 && j>=pLoop->u.btree.nEq
4846 && pIndex->pTable->aCol[iColumn].notNull==0
4847 ){
drhe353ee32013-06-04 23:40:53 +00004848 isOrderDistinct = 0;
drh7699d1c2013-06-04 12:42:29 +00004849 }
4850
4851 /* Find the ORDER BY term that corresponds to the j-th column
4852 ** of the index and and mark that ORDER BY term off
4853 */
4854 bOnce = 1;
drhe353ee32013-06-04 23:40:53 +00004855 isMatch = 0;
drh7699d1c2013-06-04 12:42:29 +00004856 for(i=0; bOnce && i<nOrderBy; i++){
4857 if( MASKBIT(i) & obSat ) continue;
4858 pOBExpr = sqlite3ExprSkipCollate(pOrderBy->a[i].pExpr);
drh93ec45d2013-06-17 18:20:48 +00004859 testcase( wctrlFlags & WHERE_GROUPBY );
4860 testcase( wctrlFlags & WHERE_DISTINCTBY );
drh4f402f22013-06-11 18:59:38 +00004861 if( (wctrlFlags & (WHERE_GROUPBY|WHERE_DISTINCTBY))==0 ) bOnce = 0;
drhe353ee32013-06-04 23:40:53 +00004862 if( pOBExpr->op!=TK_COLUMN ) continue;
drh7699d1c2013-06-04 12:42:29 +00004863 if( pOBExpr->iTable!=iCur ) continue;
4864 if( pOBExpr->iColumn!=iColumn ) continue;
4865 if( iColumn>=0 ){
4866 pColl = sqlite3ExprCollSeq(pWInfo->pParse, pOrderBy->a[i].pExpr);
4867 if( !pColl ) pColl = db->pDfltColl;
4868 if( sqlite3StrICmp(pColl->zName, pIndex->azColl[j])!=0 ) continue;
4869 }
drhe353ee32013-06-04 23:40:53 +00004870 isMatch = 1;
drh7699d1c2013-06-04 12:42:29 +00004871 break;
4872 }
drhe353ee32013-06-04 23:40:53 +00004873 if( isMatch ){
drh7963b0e2013-06-17 21:37:40 +00004874 if( iColumn<0 ){
4875 testcase( distinctColumns==0 );
4876 distinctColumns = 1;
4877 }
drh7699d1c2013-06-04 12:42:29 +00004878 obSat |= MASKBIT(i);
4879 if( (pWInfo->wctrlFlags & WHERE_GROUPBY)==0 ){
drhe353ee32013-06-04 23:40:53 +00004880 /* Make sure the sort order is compatible in an ORDER BY clause.
4881 ** Sort order is irrelevant for a GROUP BY clause. */
drh7699d1c2013-06-04 12:42:29 +00004882 if( revSet ){
4883 if( (rev ^ revIdx)!=pOrderBy->a[i].sortOrder ) return 0;
4884 }else{
4885 rev = revIdx ^ pOrderBy->a[i].sortOrder;
4886 if( rev ) *pRevMask |= MASKBIT(iLoop);
4887 revSet = 1;
4888 }
4889 }
4890 }else{
4891 /* No match found */
drhbbbdc832013-10-22 18:01:40 +00004892 if( j==0 || j<nKeyCol ){
drh7963b0e2013-06-17 21:37:40 +00004893 testcase( isOrderDistinct!=0 );
4894 isOrderDistinct = 0;
4895 }
drh7699d1c2013-06-04 12:42:29 +00004896 break;
4897 }
4898 } /* end Loop over all index columns */
drh81186b42013-06-18 01:52:41 +00004899 if( distinctColumns ){
4900 testcase( isOrderDistinct==0 );
4901 isOrderDistinct = 1;
4902 }
drh7699d1c2013-06-04 12:42:29 +00004903 } /* end-if not one-row */
4904
4905 /* Mark off any other ORDER BY terms that reference pLoop */
drhe353ee32013-06-04 23:40:53 +00004906 if( isOrderDistinct ){
4907 orderDistinctMask |= pLoop->maskSelf;
drh7699d1c2013-06-04 12:42:29 +00004908 for(i=0; i<nOrderBy; i++){
4909 Expr *p;
drh434a9312014-02-26 02:26:09 +00004910 Bitmask mTerm;
drh7699d1c2013-06-04 12:42:29 +00004911 if( MASKBIT(i) & obSat ) continue;
4912 p = pOrderBy->a[i].pExpr;
drh434a9312014-02-26 02:26:09 +00004913 mTerm = exprTableUsage(&pWInfo->sMaskSet,p);
4914 if( mTerm==0 && !sqlite3ExprIsConstant(p) ) continue;
4915 if( (mTerm&~orderDistinctMask)==0 ){
drh7699d1c2013-06-04 12:42:29 +00004916 obSat |= MASKBIT(i);
4917 }
drh0afb4232013-05-31 13:36:32 +00004918 }
drh319f6772013-05-14 15:31:07 +00004919 }
drhb8916be2013-06-14 02:51:48 +00004920 } /* End the loop over all WhereLoops from outer-most down to inner-most */
drh0401ace2014-03-18 15:30:27 +00004921 if( obSat==obDone ) return nOrderBy;
drhd2de8612014-03-18 18:59:07 +00004922 if( !isOrderDistinct ){
4923 for(i=nOrderBy-1; i>0; i--){
4924 Bitmask m = MASKBIT(i) - 1;
4925 if( (obSat&m)==m ) return i;
4926 }
4927 return 0;
4928 }
drh319f6772013-05-14 15:31:07 +00004929 return -1;
drh6b7157b2013-05-10 02:00:35 +00004930}
4931
drhd15cb172013-05-21 19:23:10 +00004932#ifdef WHERETRACE_ENABLED
4933/* For debugging use only: */
4934static const char *wherePathName(WherePath *pPath, int nLoop, WhereLoop *pLast){
4935 static char zName[65];
4936 int i;
4937 for(i=0; i<nLoop; i++){ zName[i] = pPath->aLoop[i]->cId; }
4938 if( pLast ) zName[i++] = pLast->cId;
4939 zName[i] = 0;
4940 return zName;
4941}
4942#endif
4943
drh6b7157b2013-05-10 02:00:35 +00004944
4945/*
dan51576f42013-07-02 10:06:15 +00004946** Given the list of WhereLoop objects at pWInfo->pLoops, this routine
drha18f3d22013-05-08 03:05:41 +00004947** attempts to find the lowest cost path that visits each WhereLoop
4948** once. This path is then loaded into the pWInfo->a[].pWLoop fields.
4949**
drhc7f0d222013-06-19 03:27:12 +00004950** Assume that the total number of output rows that will need to be sorted
4951** will be nRowEst (in the 10*log2 representation). Or, ignore sorting
4952** costs if nRowEst==0.
4953**
drha18f3d22013-05-08 03:05:41 +00004954** Return SQLITE_OK on success or SQLITE_NOMEM of a memory allocation
4955** error occurs.
4956*/
drhbf539c42013-10-05 18:16:02 +00004957static int wherePathSolver(WhereInfo *pWInfo, LogEst nRowEst){
drh783dece2013-06-05 17:53:43 +00004958 int mxChoice; /* Maximum number of simultaneous paths tracked */
drha18f3d22013-05-08 03:05:41 +00004959 int nLoop; /* Number of terms in the join */
drhe1e2e9a2013-06-13 15:16:53 +00004960 Parse *pParse; /* Parsing context */
drha18f3d22013-05-08 03:05:41 +00004961 sqlite3 *db; /* The database connection */
4962 int iLoop; /* Loop counter over the terms of the join */
4963 int ii, jj; /* Loop counters */
drhfde1e6b2013-09-06 17:45:42 +00004964 int mxI = 0; /* Index of next entry to replace */
drhd2de8612014-03-18 18:59:07 +00004965 int nOrderBy; /* Number of ORDER BY clause terms */
drhbf539c42013-10-05 18:16:02 +00004966 LogEst rCost; /* Cost of a path */
4967 LogEst nOut; /* Number of outputs */
4968 LogEst mxCost = 0; /* Maximum cost of a set of paths */
4969 LogEst mxOut = 0; /* Maximum nOut value on the set of paths */
drha18f3d22013-05-08 03:05:41 +00004970 int nTo, nFrom; /* Number of valid entries in aTo[] and aFrom[] */
4971 WherePath *aFrom; /* All nFrom paths at the previous level */
4972 WherePath *aTo; /* The nTo best paths at the current level */
4973 WherePath *pFrom; /* An element of aFrom[] that we are working on */
4974 WherePath *pTo; /* An element of aTo[] that we are working on */
4975 WhereLoop *pWLoop; /* One of the WhereLoop objects */
4976 WhereLoop **pX; /* Used to divy up the pSpace memory */
4977 char *pSpace; /* Temporary memory used by this routine */
4978
drhe1e2e9a2013-06-13 15:16:53 +00004979 pParse = pWInfo->pParse;
4980 db = pParse->db;
drha18f3d22013-05-08 03:05:41 +00004981 nLoop = pWInfo->nLevel;
drhe1e2e9a2013-06-13 15:16:53 +00004982 /* TUNING: For simple queries, only the best path is tracked.
4983 ** For 2-way joins, the 5 best paths are followed.
4984 ** For joins of 3 or more tables, track the 10 best paths */
drhe9d935a2013-06-05 16:19:59 +00004985 mxChoice = (nLoop==1) ? 1 : (nLoop==2 ? 5 : 10);
drha18f3d22013-05-08 03:05:41 +00004986 assert( nLoop<=pWInfo->pTabList->nSrc );
drh3b48e8c2013-06-12 20:18:16 +00004987 WHERETRACE(0x002, ("---- begin solver\n"));
drha18f3d22013-05-08 03:05:41 +00004988
4989 /* Allocate and initialize space for aTo and aFrom */
4990 ii = (sizeof(WherePath)+sizeof(WhereLoop*)*nLoop)*mxChoice*2;
4991 pSpace = sqlite3DbMallocRaw(db, ii);
4992 if( pSpace==0 ) return SQLITE_NOMEM;
4993 aTo = (WherePath*)pSpace;
4994 aFrom = aTo+mxChoice;
4995 memset(aFrom, 0, sizeof(aFrom[0]));
4996 pX = (WhereLoop**)(aFrom+mxChoice);
drhe9d935a2013-06-05 16:19:59 +00004997 for(ii=mxChoice*2, pFrom=aTo; ii>0; ii--, pFrom++, pX += nLoop){
drha18f3d22013-05-08 03:05:41 +00004998 pFrom->aLoop = pX;
4999 }
5000
drhe1e2e9a2013-06-13 15:16:53 +00005001 /* Seed the search with a single WherePath containing zero WhereLoops.
5002 **
5003 ** TUNING: Do not let the number of iterations go above 25. If the cost
5004 ** of computing an automatic index is not paid back within the first 25
5005 ** rows, then do not use the automatic index. */
drhbf539c42013-10-05 18:16:02 +00005006 aFrom[0].nRow = MIN(pParse->nQueryLoop, 46); assert( 46==sqlite3LogEst(25) );
drha18f3d22013-05-08 03:05:41 +00005007 nFrom = 1;
drh6b7157b2013-05-10 02:00:35 +00005008
5009 /* Precompute the cost of sorting the final result set, if the caller
5010 ** to sqlite3WhereBegin() was concerned about sorting */
drhb8a8e8a2013-06-10 19:12:39 +00005011 if( pWInfo->pOrderBy==0 || nRowEst==0 ){
drh0401ace2014-03-18 15:30:27 +00005012 aFrom[0].isOrdered = 0;
drhd2de8612014-03-18 18:59:07 +00005013 nOrderBy = 0;
drh6b7157b2013-05-10 02:00:35 +00005014 }else{
drh0401ace2014-03-18 15:30:27 +00005015 aFrom[0].isOrdered = -1;
drhd2de8612014-03-18 18:59:07 +00005016 nOrderBy = pWInfo->pOrderBy->nExpr;
drh6b7157b2013-05-10 02:00:35 +00005017 }
5018
5019 /* Compute successively longer WherePaths using the previous generation
5020 ** of WherePaths as the basis for the next. Keep track of the mxChoice
5021 ** best paths at each generation */
drha18f3d22013-05-08 03:05:41 +00005022 for(iLoop=0; iLoop<nLoop; iLoop++){
5023 nTo = 0;
5024 for(ii=0, pFrom=aFrom; ii<nFrom; ii++, pFrom++){
5025 for(pWLoop=pWInfo->pLoops; pWLoop; pWLoop=pWLoop->pNextLoop){
5026 Bitmask maskNew;
drh319f6772013-05-14 15:31:07 +00005027 Bitmask revMask = 0;
drh0401ace2014-03-18 15:30:27 +00005028 i8 isOrdered = pFrom->isOrdered;
drha18f3d22013-05-08 03:05:41 +00005029 if( (pWLoop->prereq & ~pFrom->maskLoop)!=0 ) continue;
5030 if( (pWLoop->maskSelf & pFrom->maskLoop)!=0 ) continue;
drh6b7157b2013-05-10 02:00:35 +00005031 /* At this point, pWLoop is a candidate to be the next loop.
5032 ** Compute its cost */
drhbf539c42013-10-05 18:16:02 +00005033 rCost = sqlite3LogEstAdd(pWLoop->rSetup,pWLoop->rRun + pFrom->nRow);
5034 rCost = sqlite3LogEstAdd(rCost, pFrom->rCost);
drhfde1e6b2013-09-06 17:45:42 +00005035 nOut = pFrom->nRow + pWLoop->nOut;
drha18f3d22013-05-08 03:05:41 +00005036 maskNew = pFrom->maskLoop | pWLoop->maskSelf;
drh0401ace2014-03-18 15:30:27 +00005037 if( isOrdered<0 ){
5038 isOrdered = wherePathSatisfiesOrderBy(pWInfo,
drh4f402f22013-06-11 18:59:38 +00005039 pWInfo->pOrderBy, pFrom, pWInfo->wctrlFlags,
drh0401ace2014-03-18 15:30:27 +00005040 iLoop, pWLoop, &revMask);
drhd2de8612014-03-18 18:59:07 +00005041 if( isOrdered>=0 && isOrdered<nOrderBy ){
5042 /* TUNING: Estimated cost of sorting cost as roughly 4*N*log(N).
5043 ** If some but not all of the columns are in sorted order, then
5044 ** scale down the log(N) term. */
5045 LogEst rSortCost = 20 + nRowEst +
5046 estLog(nRowEst)*(nOrderBy-isOrdered)/nOrderBy;
5047 WHERETRACE(0x002,
5048 ("---- sort cost=%-3d (%d/%d) increases cost %3d to %-3d\n",
5049 rSortCost, (nOrderBy-isOrdered), nOrderBy, rCost,
5050 sqlite3LogEstAdd(rCost,rSortCost)));
drh0401ace2014-03-18 15:30:27 +00005051 rCost = sqlite3LogEstAdd(rCost, rSortCost);
drh6b7157b2013-05-10 02:00:35 +00005052 }
drh3a5ba8b2013-06-03 15:34:48 +00005053 }else{
5054 revMask = pFrom->revLoop;
drh6b7157b2013-05-10 02:00:35 +00005055 }
5056 /* Check to see if pWLoop should be added to the mxChoice best so far */
5057 for(jj=0, pTo=aTo; jj<nTo; jj++, pTo++){
drhfde1e6b2013-09-06 17:45:42 +00005058 if( pTo->maskLoop==maskNew
drh0401ace2014-03-18 15:30:27 +00005059 && ((pTo->isOrdered^isOrdered)&80)==0
drhfde1e6b2013-09-06 17:45:42 +00005060 && ((pTo->rCost<=rCost && pTo->nRow<=nOut) ||
5061 (pTo->rCost>=rCost && pTo->nRow>=nOut))
5062 ){
drh7963b0e2013-06-17 21:37:40 +00005063 testcase( jj==nTo-1 );
drh6b7157b2013-05-10 02:00:35 +00005064 break;
5065 }
5066 }
drha18f3d22013-05-08 03:05:41 +00005067 if( jj>=nTo ){
drh7d9e7d82013-09-11 17:39:09 +00005068 if( nTo>=mxChoice && rCost>=mxCost ){
drh989578e2013-10-28 14:34:35 +00005069#ifdef WHERETRACE_ENABLED /* 0x4 */
drhae70cf12013-05-31 15:18:46 +00005070 if( sqlite3WhereTrace&0x4 ){
drhfde1e6b2013-09-06 17:45:42 +00005071 sqlite3DebugPrintf("Skip %s cost=%-3d,%3d order=%c\n",
5072 wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
drh0401ace2014-03-18 15:30:27 +00005073 isOrdered>=0 ? isOrdered+'0' : '?');
drhd15cb172013-05-21 19:23:10 +00005074 }
5075#endif
5076 continue;
5077 }
5078 /* Add a new Path to the aTo[] set */
drha18f3d22013-05-08 03:05:41 +00005079 if( nTo<mxChoice ){
drhd15cb172013-05-21 19:23:10 +00005080 /* Increase the size of the aTo set by one */
drha18f3d22013-05-08 03:05:41 +00005081 jj = nTo++;
5082 }else{
drhd15cb172013-05-21 19:23:10 +00005083 /* New path replaces the prior worst to keep count below mxChoice */
drhfde1e6b2013-09-06 17:45:42 +00005084 jj = mxI;
drha18f3d22013-05-08 03:05:41 +00005085 }
5086 pTo = &aTo[jj];
drh989578e2013-10-28 14:34:35 +00005087#ifdef WHERETRACE_ENABLED /* 0x4 */
drhae70cf12013-05-31 15:18:46 +00005088 if( sqlite3WhereTrace&0x4 ){
drhfde1e6b2013-09-06 17:45:42 +00005089 sqlite3DebugPrintf("New %s cost=%-3d,%3d order=%c\n",
5090 wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
drh0401ace2014-03-18 15:30:27 +00005091 isOrdered>=0 ? isOrdered+'0' : '?');
drhd15cb172013-05-21 19:23:10 +00005092 }
5093#endif
drhf204dac2013-05-08 03:22:07 +00005094 }else{
drhfde1e6b2013-09-06 17:45:42 +00005095 if( pTo->rCost<=rCost && pTo->nRow<=nOut ){
drh989578e2013-10-28 14:34:35 +00005096#ifdef WHERETRACE_ENABLED /* 0x4 */
drhae70cf12013-05-31 15:18:46 +00005097 if( sqlite3WhereTrace&0x4 ){
drhd15cb172013-05-21 19:23:10 +00005098 sqlite3DebugPrintf(
drhfde1e6b2013-09-06 17:45:42 +00005099 "Skip %s cost=%-3d,%3d order=%c",
5100 wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
drh0401ace2014-03-18 15:30:27 +00005101 isOrdered>=0 ? isOrdered+'0' : '?');
drhfde1e6b2013-09-06 17:45:42 +00005102 sqlite3DebugPrintf(" vs %s cost=%-3d,%d order=%c\n",
5103 wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
drh0401ace2014-03-18 15:30:27 +00005104 pTo->isOrdered>=0 ? pTo->isOrdered+'0' : '?');
drhd15cb172013-05-21 19:23:10 +00005105 }
5106#endif
drh7963b0e2013-06-17 21:37:40 +00005107 testcase( pTo->rCost==rCost );
drhd15cb172013-05-21 19:23:10 +00005108 continue;
5109 }
drh7963b0e2013-06-17 21:37:40 +00005110 testcase( pTo->rCost==rCost+1 );
drhd15cb172013-05-21 19:23:10 +00005111 /* A new and better score for a previously created equivalent path */
drh989578e2013-10-28 14:34:35 +00005112#ifdef WHERETRACE_ENABLED /* 0x4 */
drhae70cf12013-05-31 15:18:46 +00005113 if( sqlite3WhereTrace&0x4 ){
drhd15cb172013-05-21 19:23:10 +00005114 sqlite3DebugPrintf(
drhfde1e6b2013-09-06 17:45:42 +00005115 "Update %s cost=%-3d,%3d order=%c",
5116 wherePathName(pFrom, iLoop, pWLoop), rCost, nOut,
drh0401ace2014-03-18 15:30:27 +00005117 isOrdered>=0 ? isOrdered+'0' : '?');
drhfde1e6b2013-09-06 17:45:42 +00005118 sqlite3DebugPrintf(" was %s cost=%-3d,%3d order=%c\n",
5119 wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
drh0401ace2014-03-18 15:30:27 +00005120 pTo->isOrdered>=0 ? pTo->isOrdered+'0' : '?');
drhd15cb172013-05-21 19:23:10 +00005121 }
5122#endif
drha18f3d22013-05-08 03:05:41 +00005123 }
drh6b7157b2013-05-10 02:00:35 +00005124 /* pWLoop is a winner. Add it to the set of best so far */
drha18f3d22013-05-08 03:05:41 +00005125 pTo->maskLoop = pFrom->maskLoop | pWLoop->maskSelf;
drh319f6772013-05-14 15:31:07 +00005126 pTo->revLoop = revMask;
drhfde1e6b2013-09-06 17:45:42 +00005127 pTo->nRow = nOut;
drha18f3d22013-05-08 03:05:41 +00005128 pTo->rCost = rCost;
drh6b7157b2013-05-10 02:00:35 +00005129 pTo->isOrdered = isOrdered;
drha18f3d22013-05-08 03:05:41 +00005130 memcpy(pTo->aLoop, pFrom->aLoop, sizeof(WhereLoop*)*iLoop);
5131 pTo->aLoop[iLoop] = pWLoop;
5132 if( nTo>=mxChoice ){
drhfde1e6b2013-09-06 17:45:42 +00005133 mxI = 0;
drha18f3d22013-05-08 03:05:41 +00005134 mxCost = aTo[0].rCost;
drhfde1e6b2013-09-06 17:45:42 +00005135 mxOut = aTo[0].nRow;
drha18f3d22013-05-08 03:05:41 +00005136 for(jj=1, pTo=&aTo[1]; jj<mxChoice; jj++, pTo++){
drhfde1e6b2013-09-06 17:45:42 +00005137 if( pTo->rCost>mxCost || (pTo->rCost==mxCost && pTo->nRow>mxOut) ){
5138 mxCost = pTo->rCost;
5139 mxOut = pTo->nRow;
5140 mxI = jj;
5141 }
drha18f3d22013-05-08 03:05:41 +00005142 }
5143 }
5144 }
5145 }
5146
drh989578e2013-10-28 14:34:35 +00005147#ifdef WHERETRACE_ENABLED /* >=2 */
drhd15cb172013-05-21 19:23:10 +00005148 if( sqlite3WhereTrace>=2 ){
drha50ef112013-05-22 02:06:59 +00005149 sqlite3DebugPrintf("---- after round %d ----\n", iLoop);
drhd15cb172013-05-21 19:23:10 +00005150 for(ii=0, pTo=aTo; ii<nTo; ii++, pTo++){
drhb8a8e8a2013-06-10 19:12:39 +00005151 sqlite3DebugPrintf(" %s cost=%-3d nrow=%-3d order=%c",
drha50ef112013-05-22 02:06:59 +00005152 wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
drh0401ace2014-03-18 15:30:27 +00005153 pTo->isOrdered>=0 ? (pTo->isOrdered+'0') : '?');
5154 if( pTo->isOrdered>0 ){
drh88da6442013-05-27 17:59:37 +00005155 sqlite3DebugPrintf(" rev=0x%llx\n", pTo->revLoop);
5156 }else{
5157 sqlite3DebugPrintf("\n");
5158 }
drhf204dac2013-05-08 03:22:07 +00005159 }
5160 }
5161#endif
5162
drh6b7157b2013-05-10 02:00:35 +00005163 /* Swap the roles of aFrom and aTo for the next generation */
drha18f3d22013-05-08 03:05:41 +00005164 pFrom = aTo;
5165 aTo = aFrom;
5166 aFrom = pFrom;
5167 nFrom = nTo;
5168 }
5169
drh75b93402013-05-31 20:43:57 +00005170 if( nFrom==0 ){
drhe1e2e9a2013-06-13 15:16:53 +00005171 sqlite3ErrorMsg(pParse, "no query solution");
drh75b93402013-05-31 20:43:57 +00005172 sqlite3DbFree(db, pSpace);
5173 return SQLITE_ERROR;
5174 }
drha18f3d22013-05-08 03:05:41 +00005175
drh6b7157b2013-05-10 02:00:35 +00005176 /* Find the lowest cost path. pFrom will be left pointing to that path */
drha18f3d22013-05-08 03:05:41 +00005177 pFrom = aFrom;
5178 for(ii=1; ii<nFrom; ii++){
5179 if( pFrom->rCost>aFrom[ii].rCost ) pFrom = &aFrom[ii];
5180 }
5181 assert( pWInfo->nLevel==nLoop );
drh6b7157b2013-05-10 02:00:35 +00005182 /* Load the lowest cost path into pWInfo */
drha18f3d22013-05-08 03:05:41 +00005183 for(iLoop=0; iLoop<nLoop; iLoop++){
drh7ba39a92013-05-30 17:43:19 +00005184 WhereLevel *pLevel = pWInfo->a + iLoop;
5185 pLevel->pWLoop = pWLoop = pFrom->aLoop[iLoop];
drhe217efc2013-06-12 03:48:41 +00005186 pLevel->iFrom = pWLoop->iTab;
drh7ba39a92013-05-30 17:43:19 +00005187 pLevel->iTabCur = pWInfo->pTabList->a[pLevel->iFrom].iCursor;
drha18f3d22013-05-08 03:05:41 +00005188 }
drhfd636c72013-06-21 02:05:06 +00005189 if( (pWInfo->wctrlFlags & WHERE_WANT_DISTINCT)!=0
5190 && (pWInfo->wctrlFlags & WHERE_DISTINCTBY)==0
5191 && pWInfo->eDistinct==WHERE_DISTINCT_NOOP
drh4f402f22013-06-11 18:59:38 +00005192 && nRowEst
5193 ){
5194 Bitmask notUsed;
drh6457a352013-06-21 00:35:37 +00005195 int rc = wherePathSatisfiesOrderBy(pWInfo, pWInfo->pResultSet, pFrom,
drh93ec45d2013-06-17 18:20:48 +00005196 WHERE_DISTINCTBY, nLoop-1, pFrom->aLoop[nLoop-1], &notUsed);
drh0401ace2014-03-18 15:30:27 +00005197 if( rc==pWInfo->pResultSet->nExpr ){
5198 pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
5199 }
drh4f402f22013-06-11 18:59:38 +00005200 }
drh079a3072014-03-19 14:10:55 +00005201 if( pWInfo->pOrderBy ){
drh4f402f22013-06-11 18:59:38 +00005202 if( pWInfo->wctrlFlags & WHERE_DISTINCTBY ){
drh079a3072014-03-19 14:10:55 +00005203 if( pFrom->isOrdered==pWInfo->pOrderBy->nExpr ){
5204 pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
5205 }
drh4f402f22013-06-11 18:59:38 +00005206 }else{
drhddba0c22014-03-18 20:33:42 +00005207 pWInfo->nOBSat = pFrom->isOrdered;
drhea6c36e2014-03-19 14:30:55 +00005208 if( pWInfo->nOBSat<0 ) pWInfo->nOBSat = 0;
drh4f402f22013-06-11 18:59:38 +00005209 pWInfo->revMask = pFrom->revLoop;
5210 }
drh6b7157b2013-05-10 02:00:35 +00005211 }
drha50ef112013-05-22 02:06:59 +00005212 pWInfo->nRowOut = pFrom->nRow;
drha18f3d22013-05-08 03:05:41 +00005213
5214 /* Free temporary memory and return success */
5215 sqlite3DbFree(db, pSpace);
5216 return SQLITE_OK;
5217}
drh94a11212004-09-25 13:12:14 +00005218
5219/*
drh60c96cd2013-06-09 17:21:25 +00005220** Most queries use only a single table (they are not joins) and have
5221** simple == constraints against indexed fields. This routine attempts
5222** to plan those simple cases using much less ceremony than the
5223** general-purpose query planner, and thereby yield faster sqlite3_prepare()
5224** times for the common case.
5225**
5226** Return non-zero on success, if this query can be handled by this
5227** no-frills query planner. Return zero if this query needs the
5228** general-purpose query planner.
5229*/
drhb8a8e8a2013-06-10 19:12:39 +00005230static int whereShortCut(WhereLoopBuilder *pBuilder){
drh60c96cd2013-06-09 17:21:25 +00005231 WhereInfo *pWInfo;
5232 struct SrcList_item *pItem;
5233 WhereClause *pWC;
5234 WhereTerm *pTerm;
5235 WhereLoop *pLoop;
5236 int iCur;
drh92a121f2013-06-10 12:15:47 +00005237 int j;
drh60c96cd2013-06-09 17:21:25 +00005238 Table *pTab;
5239 Index *pIdx;
5240
5241 pWInfo = pBuilder->pWInfo;
drh5822d6f2013-06-10 23:30:09 +00005242 if( pWInfo->wctrlFlags & WHERE_FORCE_TABLE ) return 0;
drh60c96cd2013-06-09 17:21:25 +00005243 assert( pWInfo->pTabList->nSrc>=1 );
5244 pItem = pWInfo->pTabList->a;
5245 pTab = pItem->pTab;
5246 if( IsVirtual(pTab) ) return 0;
5247 if( pItem->zIndex ) return 0;
5248 iCur = pItem->iCursor;
5249 pWC = &pWInfo->sWC;
5250 pLoop = pBuilder->pNew;
drh60c96cd2013-06-09 17:21:25 +00005251 pLoop->wsFlags = 0;
drhcd8629e2013-11-13 12:27:25 +00005252 pLoop->u.btree.nSkip = 0;
drh3b75ffa2013-06-10 14:56:25 +00005253 pTerm = findTerm(pWC, iCur, -1, 0, WO_EQ, 0);
drh60c96cd2013-06-09 17:21:25 +00005254 if( pTerm ){
5255 pLoop->wsFlags = WHERE_COLUMN_EQ|WHERE_IPK|WHERE_ONEROW;
5256 pLoop->aLTerm[0] = pTerm;
5257 pLoop->nLTerm = 1;
5258 pLoop->u.btree.nEq = 1;
drhe1e2e9a2013-06-13 15:16:53 +00005259 /* TUNING: Cost of a rowid lookup is 10 */
drhbf539c42013-10-05 18:16:02 +00005260 pLoop->rRun = 33; /* 33==sqlite3LogEst(10) */
drh60c96cd2013-06-09 17:21:25 +00005261 }else{
5262 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
dancd40abb2013-08-29 10:46:05 +00005263 assert( pLoop->aLTermSpace==pLoop->aLTerm );
5264 assert( ArraySize(pLoop->aLTermSpace)==4 );
5265 if( pIdx->onError==OE_None
5266 || pIdx->pPartIdxWhere!=0
drhbbbdc832013-10-22 18:01:40 +00005267 || pIdx->nKeyCol>ArraySize(pLoop->aLTermSpace)
dancd40abb2013-08-29 10:46:05 +00005268 ) continue;
drhbbbdc832013-10-22 18:01:40 +00005269 for(j=0; j<pIdx->nKeyCol; j++){
drh3b75ffa2013-06-10 14:56:25 +00005270 pTerm = findTerm(pWC, iCur, pIdx->aiColumn[j], 0, WO_EQ, pIdx);
drh60c96cd2013-06-09 17:21:25 +00005271 if( pTerm==0 ) break;
drh60c96cd2013-06-09 17:21:25 +00005272 pLoop->aLTerm[j] = pTerm;
5273 }
drhbbbdc832013-10-22 18:01:40 +00005274 if( j!=pIdx->nKeyCol ) continue;
drh92a121f2013-06-10 12:15:47 +00005275 pLoop->wsFlags = WHERE_COLUMN_EQ|WHERE_ONEROW|WHERE_INDEXED;
drhec95c442013-10-23 01:57:32 +00005276 if( pIdx->isCovering || (pItem->colUsed & ~columnsInIndex(pIdx))==0 ){
drh92a121f2013-06-10 12:15:47 +00005277 pLoop->wsFlags |= WHERE_IDX_ONLY;
5278 }
drh60c96cd2013-06-09 17:21:25 +00005279 pLoop->nLTerm = j;
5280 pLoop->u.btree.nEq = j;
5281 pLoop->u.btree.pIndex = pIdx;
drhe1e2e9a2013-06-13 15:16:53 +00005282 /* TUNING: Cost of a unique index lookup is 15 */
drhbf539c42013-10-05 18:16:02 +00005283 pLoop->rRun = 39; /* 39==sqlite3LogEst(15) */
drh60c96cd2013-06-09 17:21:25 +00005284 break;
5285 }
5286 }
drh3b75ffa2013-06-10 14:56:25 +00005287 if( pLoop->wsFlags ){
drhbf539c42013-10-05 18:16:02 +00005288 pLoop->nOut = (LogEst)1;
drh3b75ffa2013-06-10 14:56:25 +00005289 pWInfo->a[0].pWLoop = pLoop;
5290 pLoop->maskSelf = getMask(&pWInfo->sMaskSet, iCur);
5291 pWInfo->a[0].iTabCur = iCur;
5292 pWInfo->nRowOut = 1;
drhddba0c22014-03-18 20:33:42 +00005293 if( pWInfo->pOrderBy ) pWInfo->nOBSat = pWInfo->pOrderBy->nExpr;
drh6457a352013-06-21 00:35:37 +00005294 if( pWInfo->wctrlFlags & WHERE_WANT_DISTINCT ){
5295 pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
5296 }
drh3b75ffa2013-06-10 14:56:25 +00005297#ifdef SQLITE_DEBUG
5298 pLoop->cId = '0';
5299#endif
5300 return 1;
5301 }
5302 return 0;
drh60c96cd2013-06-09 17:21:25 +00005303}
5304
5305/*
drhe3184742002-06-19 14:27:05 +00005306** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00005307** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00005308** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00005309** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00005310** in order to complete the WHERE clause processing.
5311**
5312** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00005313**
5314** The basic idea is to do a nested loop, one loop for each table in
5315** the FROM clause of a select. (INSERT and UPDATE statements are the
5316** same as a SELECT with only a single table in the FROM clause.) For
5317** example, if the SQL is this:
5318**
5319** SELECT * FROM t1, t2, t3 WHERE ...;
5320**
5321** Then the code generated is conceptually like the following:
5322**
5323** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00005324** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00005325** foreach row3 in t3 do /
5326** ...
5327** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00005328** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00005329** end /
5330**
drh29dda4a2005-07-21 18:23:20 +00005331** Note that the loops might not be nested in the order in which they
5332** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00005333** use of indices. Note also that when the IN operator appears in
5334** the WHERE clause, it might result in additional nested loops for
5335** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00005336**
drhc27a1ce2002-06-14 20:58:45 +00005337** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00005338** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
5339** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00005340** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00005341**
drhe6f85e72004-12-25 01:03:13 +00005342** The code that sqlite3WhereBegin() generates leaves the cursors named
5343** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00005344** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00005345** data from the various tables of the loop.
5346**
drhc27a1ce2002-06-14 20:58:45 +00005347** If the WHERE clause is empty, the foreach loops must each scan their
5348** entire tables. Thus a three-way join is an O(N^3) operation. But if
5349** the tables have indices and there are terms in the WHERE clause that
5350** refer to those indices, a complete table scan can be avoided and the
5351** code will run much faster. Most of the work of this routine is checking
5352** to see if there are indices that can be used to speed up the loop.
5353**
5354** Terms of the WHERE clause are also used to limit which rows actually
5355** make it to the "..." in the middle of the loop. After each "foreach",
5356** terms of the WHERE clause that use only terms in that loop and outer
5357** loops are evaluated and if false a jump is made around all subsequent
5358** inner loops (or around the "..." if the test occurs within the inner-
5359** most loop)
5360**
5361** OUTER JOINS
5362**
5363** An outer join of tables t1 and t2 is conceptally coded as follows:
5364**
5365** foreach row1 in t1 do
5366** flag = 0
5367** foreach row2 in t2 do
5368** start:
5369** ...
5370** flag = 1
5371** end
drhe3184742002-06-19 14:27:05 +00005372** if flag==0 then
5373** move the row2 cursor to a null row
5374** goto start
5375** fi
drhc27a1ce2002-06-14 20:58:45 +00005376** end
5377**
drhe3184742002-06-19 14:27:05 +00005378** ORDER BY CLAUSE PROCESSING
5379**
drh94433422013-07-01 11:05:50 +00005380** pOrderBy is a pointer to the ORDER BY clause (or the GROUP BY clause
5381** if the WHERE_GROUPBY flag is set in wctrlFlags) of a SELECT statement
drhe3184742002-06-19 14:27:05 +00005382** if there is one. If there is no ORDER BY clause or if this routine
drh46ec5b62012-09-24 15:30:54 +00005383** is called from an UPDATE or DELETE statement, then pOrderBy is NULL.
drhfc8d4f92013-11-08 15:19:46 +00005384**
5385** The iIdxCur parameter is the cursor number of an index. If
5386** WHERE_ONETABLE_ONLY is set, iIdxCur is the cursor number of an index
5387** to use for OR clause processing. The WHERE clause should use this
5388** specific cursor. If WHERE_ONEPASS_DESIRED is set, then iIdxCur is
5389** the first cursor in an array of cursors for all indices. iIdxCur should
5390** be used to compute the appropriate cursor depending on which index is
5391** used.
drh75897232000-05-29 14:26:00 +00005392*/
danielk19774adee202004-05-08 08:23:19 +00005393WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00005394 Parse *pParse, /* The parser context */
drh6457a352013-06-21 00:35:37 +00005395 SrcList *pTabList, /* FROM clause: A list of all tables to be scanned */
danielk1977ed326d72004-11-16 15:50:19 +00005396 Expr *pWhere, /* The WHERE clause */
drh0401ace2014-03-18 15:30:27 +00005397 ExprList *pOrderBy, /* An ORDER BY (or GROUP BY) clause, or NULL */
drh6457a352013-06-21 00:35:37 +00005398 ExprList *pResultSet, /* Result set of the query */
dan0efb72c2012-08-24 18:44:56 +00005399 u16 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
5400 int iIdxCur /* If WHERE_ONETABLE_ONLY is set, index cursor number */
drh75897232000-05-29 14:26:00 +00005401){
danielk1977be229652009-03-20 14:18:51 +00005402 int nByteWInfo; /* Num. bytes allocated for WhereInfo struct */
drhc01a3c12009-12-16 22:10:49 +00005403 int nTabList; /* Number of elements in pTabList */
drh75897232000-05-29 14:26:00 +00005404 WhereInfo *pWInfo; /* Will become the return value of this function */
5405 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhfe05af82005-07-21 03:14:59 +00005406 Bitmask notReady; /* Cursors that are not yet positioned */
drh1c8148f2013-05-04 20:25:23 +00005407 WhereLoopBuilder sWLB; /* The WhereLoop builder */
drh111a6a72008-12-21 03:51:16 +00005408 WhereMaskSet *pMaskSet; /* The expression mask set */
drh56f1b992012-09-25 14:29:39 +00005409 WhereLevel *pLevel; /* A single level in pWInfo->a[] */
drhfd636c72013-06-21 02:05:06 +00005410 WhereLoop *pLoop; /* Pointer to a single WhereLoop object */
drh9cd1c992012-09-25 20:43:35 +00005411 int ii; /* Loop counter */
drh17435752007-08-16 04:30:38 +00005412 sqlite3 *db; /* Database connection */
drh5346e952013-05-08 14:14:26 +00005413 int rc; /* Return code */
drh75897232000-05-29 14:26:00 +00005414
drh56f1b992012-09-25 14:29:39 +00005415
5416 /* Variable initialization */
drhfd636c72013-06-21 02:05:06 +00005417 db = pParse->db;
drh1c8148f2013-05-04 20:25:23 +00005418 memset(&sWLB, 0, sizeof(sWLB));
drh0401ace2014-03-18 15:30:27 +00005419
5420 /* An ORDER/GROUP BY clause of more than 63 terms cannot be optimized */
5421 testcase( pOrderBy && pOrderBy->nExpr==BMS-1 );
5422 if( pOrderBy && pOrderBy->nExpr>=BMS ) pOrderBy = 0;
drh1c8148f2013-05-04 20:25:23 +00005423 sWLB.pOrderBy = pOrderBy;
drh56f1b992012-09-25 14:29:39 +00005424
drhfd636c72013-06-21 02:05:06 +00005425 /* Disable the DISTINCT optimization if SQLITE_DistinctOpt is set via
5426 ** sqlite3_test_ctrl(SQLITE_TESTCTRL_OPTIMIZATIONS,...) */
5427 if( OptimizationDisabled(db, SQLITE_DistinctOpt) ){
5428 wctrlFlags &= ~WHERE_WANT_DISTINCT;
5429 }
5430
drh29dda4a2005-07-21 18:23:20 +00005431 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00005432 ** bits in a Bitmask
5433 */
drh67ae0cb2010-04-08 14:38:51 +00005434 testcase( pTabList->nSrc==BMS );
drh29dda4a2005-07-21 18:23:20 +00005435 if( pTabList->nSrc>BMS ){
5436 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00005437 return 0;
5438 }
5439
drhc01a3c12009-12-16 22:10:49 +00005440 /* This function normally generates a nested loop for all tables in
5441 ** pTabList. But if the WHERE_ONETABLE_ONLY flag is set, then we should
5442 ** only generate code for the first table in pTabList and assume that
5443 ** any cursors associated with subsequent tables are uninitialized.
5444 */
5445 nTabList = (wctrlFlags & WHERE_ONETABLE_ONLY) ? 1 : pTabList->nSrc;
5446
drh75897232000-05-29 14:26:00 +00005447 /* Allocate and initialize the WhereInfo structure that will become the
danielk1977be229652009-03-20 14:18:51 +00005448 ** return value. A single allocation is used to store the WhereInfo
5449 ** struct, the contents of WhereInfo.a[], the WhereClause structure
5450 ** and the WhereMaskSet structure. Since WhereClause contains an 8-byte
5451 ** field (type Bitmask) it must be aligned on an 8-byte boundary on
5452 ** some architectures. Hence the ROUND8() below.
drh75897232000-05-29 14:26:00 +00005453 */
drhc01a3c12009-12-16 22:10:49 +00005454 nByteWInfo = ROUND8(sizeof(WhereInfo)+(nTabList-1)*sizeof(WhereLevel));
drh60c96cd2013-06-09 17:21:25 +00005455 pWInfo = sqlite3DbMallocZero(db, nByteWInfo + sizeof(WhereLoop));
drh17435752007-08-16 04:30:38 +00005456 if( db->mallocFailed ){
drh8b307fb2010-04-06 15:57:05 +00005457 sqlite3DbFree(db, pWInfo);
5458 pWInfo = 0;
danielk197785574e32008-10-06 05:32:18 +00005459 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00005460 }
drhfc8d4f92013-11-08 15:19:46 +00005461 pWInfo->aiCurOnePass[0] = pWInfo->aiCurOnePass[1] = -1;
drhc01a3c12009-12-16 22:10:49 +00005462 pWInfo->nLevel = nTabList;
drh75897232000-05-29 14:26:00 +00005463 pWInfo->pParse = pParse;
5464 pWInfo->pTabList = pTabList;
drh6b7157b2013-05-10 02:00:35 +00005465 pWInfo->pOrderBy = pOrderBy;
drh6457a352013-06-21 00:35:37 +00005466 pWInfo->pResultSet = pResultSet;
danielk19774adee202004-05-08 08:23:19 +00005467 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh6df2acd2008-12-28 16:55:25 +00005468 pWInfo->wctrlFlags = wctrlFlags;
drh8b307fb2010-04-06 15:57:05 +00005469 pWInfo->savedNQueryLoop = pParse->nQueryLoop;
drh70d18342013-06-06 19:16:33 +00005470 pMaskSet = &pWInfo->sMaskSet;
drh1c8148f2013-05-04 20:25:23 +00005471 sWLB.pWInfo = pWInfo;
drh70d18342013-06-06 19:16:33 +00005472 sWLB.pWC = &pWInfo->sWC;
drh1ac87e12013-07-18 14:50:56 +00005473 sWLB.pNew = (WhereLoop*)(((char*)pWInfo)+nByteWInfo);
5474 assert( EIGHT_BYTE_ALIGNMENT(sWLB.pNew) );
drh60c96cd2013-06-09 17:21:25 +00005475 whereLoopInit(sWLB.pNew);
drhb8a8e8a2013-06-10 19:12:39 +00005476#ifdef SQLITE_DEBUG
5477 sWLB.pNew->cId = '*';
5478#endif
drh08192d52002-04-30 19:20:28 +00005479
drh111a6a72008-12-21 03:51:16 +00005480 /* Split the WHERE clause into separate subexpressions where each
5481 ** subexpression is separated by an AND operator.
5482 */
5483 initMaskSet(pMaskSet);
drh70d18342013-06-06 19:16:33 +00005484 whereClauseInit(&pWInfo->sWC, pWInfo);
drh39759742013-08-02 23:40:45 +00005485 whereSplit(&pWInfo->sWC, pWhere, TK_AND);
drh111a6a72008-12-21 03:51:16 +00005486
drh08192d52002-04-30 19:20:28 +00005487 /* Special case: a WHERE clause that is constant. Evaluate the
5488 ** expression and either jump over all of the code or fall thru.
5489 */
drh759e8582014-01-02 21:05:10 +00005490 for(ii=0; ii<sWLB.pWC->nTerm; ii++){
5491 if( nTabList==0 || sqlite3ExprIsConstantNotJoin(sWLB.pWC->a[ii].pExpr) ){
5492 sqlite3ExprIfFalse(pParse, sWLB.pWC->a[ii].pExpr, pWInfo->iBreak,
5493 SQLITE_JUMPIFNULL);
5494 sWLB.pWC->a[ii].wtFlags |= TERM_CODED;
5495 }
drh08192d52002-04-30 19:20:28 +00005496 }
drh75897232000-05-29 14:26:00 +00005497
drh4fe425a2013-06-12 17:08:06 +00005498 /* Special case: No FROM clause
5499 */
5500 if( nTabList==0 ){
drhddba0c22014-03-18 20:33:42 +00005501 if( pOrderBy ) pWInfo->nOBSat = pOrderBy->nExpr;
drh6457a352013-06-21 00:35:37 +00005502 if( wctrlFlags & WHERE_WANT_DISTINCT ){
5503 pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
5504 }
drh4fe425a2013-06-12 17:08:06 +00005505 }
5506
drh42165be2008-03-26 14:56:34 +00005507 /* Assign a bit from the bitmask to every term in the FROM clause.
5508 **
5509 ** When assigning bitmask values to FROM clause cursors, it must be
5510 ** the case that if X is the bitmask for the N-th FROM clause term then
5511 ** the bitmask for all FROM clause terms to the left of the N-th term
5512 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
5513 ** its Expr.iRightJoinTable value to find the bitmask of the right table
5514 ** of the join. Subtracting one from the right table bitmask gives a
5515 ** bitmask for all tables to the left of the join. Knowing the bitmask
5516 ** for all tables to the left of a left join is important. Ticket #3015.
danielk1977e672c8e2009-05-22 15:43:26 +00005517 **
drhc01a3c12009-12-16 22:10:49 +00005518 ** Note that bitmasks are created for all pTabList->nSrc tables in
5519 ** pTabList, not just the first nTabList tables. nTabList is normally
5520 ** equal to pTabList->nSrc but might be shortened to 1 if the
5521 ** WHERE_ONETABLE_ONLY flag is set.
drh42165be2008-03-26 14:56:34 +00005522 */
drh9cd1c992012-09-25 20:43:35 +00005523 for(ii=0; ii<pTabList->nSrc; ii++){
5524 createMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00005525 }
5526#ifndef NDEBUG
5527 {
5528 Bitmask toTheLeft = 0;
drh9cd1c992012-09-25 20:43:35 +00005529 for(ii=0; ii<pTabList->nSrc; ii++){
5530 Bitmask m = getMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00005531 assert( (m-1)==toTheLeft );
5532 toTheLeft |= m;
5533 }
5534 }
5535#endif
5536
drh29dda4a2005-07-21 18:23:20 +00005537 /* Analyze all of the subexpressions. Note that exprAnalyze() might
5538 ** add new virtual terms onto the end of the WHERE clause. We do not
5539 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00005540 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00005541 */
drh70d18342013-06-06 19:16:33 +00005542 exprAnalyzeAll(pTabList, &pWInfo->sWC);
drh17435752007-08-16 04:30:38 +00005543 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00005544 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00005545 }
drh75897232000-05-29 14:26:00 +00005546
drh6457a352013-06-21 00:35:37 +00005547 if( wctrlFlags & WHERE_WANT_DISTINCT ){
5548 if( isDistinctRedundant(pParse, pTabList, &pWInfo->sWC, pResultSet) ){
5549 /* The DISTINCT marking is pointless. Ignore it. */
drh4f402f22013-06-11 18:59:38 +00005550 pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
5551 }else if( pOrderBy==0 ){
drh6457a352013-06-21 00:35:37 +00005552 /* Try to ORDER BY the result set to make distinct processing easier */
drh4f402f22013-06-11 18:59:38 +00005553 pWInfo->wctrlFlags |= WHERE_DISTINCTBY;
drh6457a352013-06-21 00:35:37 +00005554 pWInfo->pOrderBy = pResultSet;
drh4f402f22013-06-11 18:59:38 +00005555 }
dan38cc40c2011-06-30 20:17:15 +00005556 }
5557
drhf1b5f5b2013-05-02 00:15:01 +00005558 /* Construct the WhereLoop objects */
drh3b48e8c2013-06-12 20:18:16 +00005559 WHERETRACE(0xffff,("*** Optimizer Start ***\n"));
drhf4e9cb02013-10-28 19:59:59 +00005560 /* Display all terms of the WHERE clause */
5561#if defined(WHERETRACE_ENABLED) && defined(SQLITE_ENABLE_TREE_EXPLAIN)
5562 if( sqlite3WhereTrace & 0x100 ){
5563 int i;
5564 Vdbe *v = pParse->pVdbe;
5565 sqlite3ExplainBegin(v);
5566 for(i=0; i<sWLB.pWC->nTerm; i++){
drh7afc8b02013-10-28 22:33:36 +00005567 sqlite3ExplainPrintf(v, "#%-2d ", i);
drhf4e9cb02013-10-28 19:59:59 +00005568 sqlite3ExplainPush(v);
5569 whereExplainTerm(v, &sWLB.pWC->a[i]);
5570 sqlite3ExplainPop(v);
5571 sqlite3ExplainNL(v);
5572 }
5573 sqlite3ExplainFinish(v);
5574 sqlite3DebugPrintf("%s", sqlite3VdbeExplanation(v));
5575 }
5576#endif
drhb8a8e8a2013-06-10 19:12:39 +00005577 if( nTabList!=1 || whereShortCut(&sWLB)==0 ){
drh60c96cd2013-06-09 17:21:25 +00005578 rc = whereLoopAddAll(&sWLB);
5579 if( rc ) goto whereBeginError;
5580
5581 /* Display all of the WhereLoop objects if wheretrace is enabled */
drh989578e2013-10-28 14:34:35 +00005582#ifdef WHERETRACE_ENABLED /* !=0 */
drh60c96cd2013-06-09 17:21:25 +00005583 if( sqlite3WhereTrace ){
5584 WhereLoop *p;
drhfd636c72013-06-21 02:05:06 +00005585 int i;
drh60c96cd2013-06-09 17:21:25 +00005586 static char zLabel[] = "0123456789abcdefghijklmnopqrstuvwyxz"
5587 "ABCDEFGHIJKLMNOPQRSTUVWYXZ";
drhfd636c72013-06-21 02:05:06 +00005588 for(p=pWInfo->pLoops, i=0; p; p=p->pNextLoop, i++){
5589 p->cId = zLabel[i%sizeof(zLabel)];
drhc1ba2e72013-10-28 19:03:21 +00005590 whereLoopPrint(p, sWLB.pWC);
drh60c96cd2013-06-09 17:21:25 +00005591 }
5592 }
5593#endif
5594
drh4f402f22013-06-11 18:59:38 +00005595 wherePathSolver(pWInfo, 0);
drh60c96cd2013-06-09 17:21:25 +00005596 if( db->mallocFailed ) goto whereBeginError;
5597 if( pWInfo->pOrderBy ){
drhc7f0d222013-06-19 03:27:12 +00005598 wherePathSolver(pWInfo, pWInfo->nRowOut+1);
drh60c96cd2013-06-09 17:21:25 +00005599 if( db->mallocFailed ) goto whereBeginError;
drha18f3d22013-05-08 03:05:41 +00005600 }
5601 }
drh60c96cd2013-06-09 17:21:25 +00005602 if( pWInfo->pOrderBy==0 && (db->flags & SQLITE_ReverseOrder)!=0 ){
drhd84ce352013-06-04 18:27:41 +00005603 pWInfo->revMask = (Bitmask)(-1);
drha50ef112013-05-22 02:06:59 +00005604 }
drh81186b42013-06-18 01:52:41 +00005605 if( pParse->nErr || NEVER(db->mallocFailed) ){
drh75b93402013-05-31 20:43:57 +00005606 goto whereBeginError;
5607 }
drh989578e2013-10-28 14:34:35 +00005608#ifdef WHERETRACE_ENABLED /* !=0 */
drha18f3d22013-05-08 03:05:41 +00005609 if( sqlite3WhereTrace ){
5610 int ii;
drh4f402f22013-06-11 18:59:38 +00005611 sqlite3DebugPrintf("---- Solution nRow=%d", pWInfo->nRowOut);
drhddba0c22014-03-18 20:33:42 +00005612 if( pWInfo->nOBSat>0 ){
5613 sqlite3DebugPrintf(" ORDERBY=%d,0x%llx", pWInfo->nOBSat, pWInfo->revMask);
drh319f6772013-05-14 15:31:07 +00005614 }
drh4f402f22013-06-11 18:59:38 +00005615 switch( pWInfo->eDistinct ){
5616 case WHERE_DISTINCT_UNIQUE: {
5617 sqlite3DebugPrintf(" DISTINCT=unique");
5618 break;
5619 }
5620 case WHERE_DISTINCT_ORDERED: {
5621 sqlite3DebugPrintf(" DISTINCT=ordered");
5622 break;
5623 }
5624 case WHERE_DISTINCT_UNORDERED: {
5625 sqlite3DebugPrintf(" DISTINCT=unordered");
5626 break;
5627 }
5628 }
5629 sqlite3DebugPrintf("\n");
drhfd636c72013-06-21 02:05:06 +00005630 for(ii=0; ii<pWInfo->nLevel; ii++){
drhc1ba2e72013-10-28 19:03:21 +00005631 whereLoopPrint(pWInfo->a[ii].pWLoop, sWLB.pWC);
drhf1b5f5b2013-05-02 00:15:01 +00005632 }
5633 }
5634#endif
drhfd636c72013-06-21 02:05:06 +00005635 /* Attempt to omit tables from the join that do not effect the result */
drh1031bd92013-06-22 15:44:26 +00005636 if( pWInfo->nLevel>=2
5637 && pResultSet!=0
5638 && OptimizationEnabled(db, SQLITE_OmitNoopJoin)
5639 ){
drhfd636c72013-06-21 02:05:06 +00005640 Bitmask tabUsed = exprListTableUsage(pMaskSet, pResultSet);
drh67a5ec72013-09-03 14:03:47 +00005641 if( sWLB.pOrderBy ) tabUsed |= exprListTableUsage(pMaskSet, sWLB.pOrderBy);
drhfd636c72013-06-21 02:05:06 +00005642 while( pWInfo->nLevel>=2 ){
drh9d5a5792013-06-28 13:43:33 +00005643 WhereTerm *pTerm, *pEnd;
drhfd636c72013-06-21 02:05:06 +00005644 pLoop = pWInfo->a[pWInfo->nLevel-1].pWLoop;
drhbc71b1d2013-06-21 02:15:48 +00005645 if( (pWInfo->pTabList->a[pLoop->iTab].jointype & JT_LEFT)==0 ) break;
5646 if( (wctrlFlags & WHERE_WANT_DISTINCT)==0
5647 && (pLoop->wsFlags & WHERE_ONEROW)==0
drhfd636c72013-06-21 02:05:06 +00005648 ){
drhfd636c72013-06-21 02:05:06 +00005649 break;
5650 }
drhbc71b1d2013-06-21 02:15:48 +00005651 if( (tabUsed & pLoop->maskSelf)!=0 ) break;
drh9d5a5792013-06-28 13:43:33 +00005652 pEnd = sWLB.pWC->a + sWLB.pWC->nTerm;
5653 for(pTerm=sWLB.pWC->a; pTerm<pEnd; pTerm++){
5654 if( (pTerm->prereqAll & pLoop->maskSelf)!=0
5655 && !ExprHasProperty(pTerm->pExpr, EP_FromJoin)
5656 ){
5657 break;
5658 }
5659 }
5660 if( pTerm<pEnd ) break;
drhbc71b1d2013-06-21 02:15:48 +00005661 WHERETRACE(0xffff, ("-> drop loop %c not used\n", pLoop->cId));
5662 pWInfo->nLevel--;
5663 nTabList--;
drhfd636c72013-06-21 02:05:06 +00005664 }
5665 }
drh3b48e8c2013-06-12 20:18:16 +00005666 WHERETRACE(0xffff,("*** Optimizer Finished ***\n"));
drh8e23daf2013-06-11 13:30:04 +00005667 pWInfo->pParse->nQueryLoop += pWInfo->nRowOut;
drhf1b5f5b2013-05-02 00:15:01 +00005668
drh08c88eb2008-04-10 13:33:18 +00005669 /* If the caller is an UPDATE or DELETE statement that is requesting
5670 ** to use a one-pass algorithm, determine if this is appropriate.
drh24b7fe92013-09-30 19:33:06 +00005671 ** The one-pass algorithm only works if the WHERE clause constrains
drh08c88eb2008-04-10 13:33:18 +00005672 ** the statement to update a single row.
5673 */
drh165be382008-12-05 02:36:33 +00005674 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
drh3b48e8c2013-06-12 20:18:16 +00005675 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0
5676 && (pWInfo->a[0].pWLoop->wsFlags & WHERE_ONEROW)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00005677 pWInfo->okOnePass = 1;
drh702ba9f2013-11-07 21:25:13 +00005678 if( HasRowid(pTabList->a[0].pTab) ){
5679 pWInfo->a[0].pWLoop->wsFlags &= ~WHERE_IDX_ONLY;
5680 }
drh08c88eb2008-04-10 13:33:18 +00005681 }
drheb04de32013-05-10 15:16:30 +00005682
drh9012bcb2004-12-19 00:11:35 +00005683 /* Open all tables in the pTabList and any indices selected for
5684 ** searching those tables.
5685 */
drh8b307fb2010-04-06 15:57:05 +00005686 notReady = ~(Bitmask)0;
drh9cd1c992012-09-25 20:43:35 +00005687 for(ii=0, pLevel=pWInfo->a; ii<nTabList; ii++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00005688 Table *pTab; /* Table to open */
danielk1977da184232006-01-05 11:34:32 +00005689 int iDb; /* Index of database containing table/index */
drh56f1b992012-09-25 14:29:39 +00005690 struct SrcList_item *pTabItem;
drh9012bcb2004-12-19 00:11:35 +00005691
drh29dda4a2005-07-21 18:23:20 +00005692 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00005693 pTab = pTabItem->pTab;
danielk1977595a5232009-07-24 17:58:53 +00005694 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh7ba39a92013-05-30 17:43:19 +00005695 pLoop = pLevel->pWLoop;
drh424aab82010-04-06 18:28:20 +00005696 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ){
drh75bb9f52010-04-06 18:51:42 +00005697 /* Do nothing */
5698 }else
drh9eff6162006-06-12 21:59:13 +00005699#ifndef SQLITE_OMIT_VIRTUALTABLE
drh7ba39a92013-05-30 17:43:19 +00005700 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
danielk1977595a5232009-07-24 17:58:53 +00005701 const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
danielk197793626f42006-06-20 13:07:27 +00005702 int iCur = pTabItem->iCursor;
danielk1977595a5232009-07-24 17:58:53 +00005703 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0, pVTab, P4_VTAB);
drhfc5e5462012-12-03 17:04:40 +00005704 }else if( IsVirtual(pTab) ){
5705 /* noop */
drh9eff6162006-06-12 21:59:13 +00005706 }else
5707#endif
drh7ba39a92013-05-30 17:43:19 +00005708 if( (pLoop->wsFlags & WHERE_IDX_ONLY)==0
drh9ef61f42011-10-07 14:40:59 +00005709 && (wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0 ){
drhfc8d4f92013-11-08 15:19:46 +00005710 int op = OP_OpenRead;
5711 if( pWInfo->okOnePass ){
5712 op = OP_OpenWrite;
5713 pWInfo->aiCurOnePass[0] = pTabItem->iCursor;
5714 };
drh08c88eb2008-04-10 13:33:18 +00005715 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
drhfc8d4f92013-11-08 15:19:46 +00005716 assert( pTabItem->iCursor==pLevel->iTabCur );
drh7963b0e2013-06-17 21:37:40 +00005717 testcase( !pWInfo->okOnePass && pTab->nCol==BMS-1 );
5718 testcase( !pWInfo->okOnePass && pTab->nCol==BMS );
drhdd9930e2013-10-23 23:37:02 +00005719 if( !pWInfo->okOnePass && pTab->nCol<BMS && HasRowid(pTab) ){
danielk19779792eef2006-01-13 15:58:43 +00005720 Bitmask b = pTabItem->colUsed;
5721 int n = 0;
drh74161702006-02-24 02:53:49 +00005722 for(; b; b=b>>1, n++){}
drh8cff69d2009-11-12 19:59:44 +00005723 sqlite3VdbeChangeP4(v, sqlite3VdbeCurrentAddr(v)-1,
5724 SQLITE_INT_TO_PTR(n), P4_INT32);
danielk19779792eef2006-01-13 15:58:43 +00005725 assert( n<=pTab->nCol );
5726 }
danielk1977c00da102006-01-07 13:21:04 +00005727 }else{
5728 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00005729 }
drh7e47cb82013-05-31 17:55:27 +00005730 if( pLoop->wsFlags & WHERE_INDEXED ){
drh7ba39a92013-05-30 17:43:19 +00005731 Index *pIx = pLoop->u.btree.pIndex;
drhfc8d4f92013-11-08 15:19:46 +00005732 int iIndexCur;
5733 int op = OP_OpenRead;
drh4308e342013-11-11 16:55:52 +00005734 /* iIdxCur is always set if to a positive value if ONEPASS is possible */
5735 assert( iIdxCur!=0 || (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0 );
5736 if( pWInfo->okOnePass ){
drhfc8d4f92013-11-08 15:19:46 +00005737 Index *pJ = pTabItem->pTab->pIndex;
5738 iIndexCur = iIdxCur;
5739 assert( wctrlFlags & WHERE_ONEPASS_DESIRED );
5740 while( ALWAYS(pJ) && pJ!=pIx ){
5741 iIndexCur++;
5742 pJ = pJ->pNext;
5743 }
5744 op = OP_OpenWrite;
5745 pWInfo->aiCurOnePass[1] = iIndexCur;
5746 }else if( iIdxCur && (wctrlFlags & WHERE_ONETABLE_ONLY)!=0 ){
5747 iIndexCur = iIdxCur;
5748 }else{
5749 iIndexCur = pParse->nTab++;
5750 }
5751 pLevel->iIdxCur = iIndexCur;
danielk1977da184232006-01-05 11:34:32 +00005752 assert( pIx->pSchema==pTab->pSchema );
drhb0367fb2012-08-25 02:11:13 +00005753 assert( iIndexCur>=0 );
drhfc8d4f92013-11-08 15:19:46 +00005754 sqlite3VdbeAddOp3(v, op, iIndexCur, pIx->tnum, iDb);
drh2ec2fb22013-11-06 19:59:23 +00005755 sqlite3VdbeSetP4KeyInfo(pParse, pIx);
danielk1977207872a2008-01-03 07:54:23 +00005756 VdbeComment((v, "%s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00005757 }
drhaceb31b2014-02-08 01:40:27 +00005758 if( iDb>=0 ) sqlite3CodeVerifySchema(pParse, iDb);
drh70d18342013-06-06 19:16:33 +00005759 notReady &= ~getMask(&pWInfo->sMaskSet, pTabItem->iCursor);
drh9012bcb2004-12-19 00:11:35 +00005760 }
5761 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
drha21a64d2010-04-06 22:33:55 +00005762 if( db->mallocFailed ) goto whereBeginError;
drh9012bcb2004-12-19 00:11:35 +00005763
drh29dda4a2005-07-21 18:23:20 +00005764 /* Generate the code to do the search. Each iteration of the for
5765 ** loop below generates code for a single nested loop of the VM
5766 ** program.
drh75897232000-05-29 14:26:00 +00005767 */
drhfe05af82005-07-21 03:14:59 +00005768 notReady = ~(Bitmask)0;
drh9cd1c992012-09-25 20:43:35 +00005769 for(ii=0; ii<nTabList; ii++){
5770 pLevel = &pWInfo->a[ii];
drhcc04afd2013-08-22 02:56:28 +00005771#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
5772 if( (pLevel->pWLoop->wsFlags & WHERE_AUTO_INDEX)!=0 ){
5773 constructAutomaticIndex(pParse, &pWInfo->sWC,
5774 &pTabList->a[pLevel->iFrom], notReady, pLevel);
5775 if( db->mallocFailed ) goto whereBeginError;
5776 }
5777#endif
drh9cd1c992012-09-25 20:43:35 +00005778 explainOneScan(pParse, pTabList, pLevel, ii, pLevel->iFrom, wctrlFlags);
drhcc04afd2013-08-22 02:56:28 +00005779 pLevel->addrBody = sqlite3VdbeCurrentAddr(v);
drh70d18342013-06-06 19:16:33 +00005780 notReady = codeOneLoopStart(pWInfo, ii, notReady);
dan4a07e3d2010-11-09 14:48:59 +00005781 pWInfo->iContinue = pLevel->addrCont;
drh75897232000-05-29 14:26:00 +00005782 }
drh7ec764a2005-07-21 03:48:20 +00005783
drh6fa978d2013-05-30 19:29:19 +00005784 /* Done. */
drh6bc69a22013-11-19 12:33:23 +00005785 VdbeModuleComment((v, "Begin WHERE-core"));
drh75897232000-05-29 14:26:00 +00005786 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00005787
5788 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00005789whereBeginError:
drh8b307fb2010-04-06 15:57:05 +00005790 if( pWInfo ){
5791 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
5792 whereInfoFree(db, pWInfo);
5793 }
drhe23399f2005-07-22 00:31:39 +00005794 return 0;
drh75897232000-05-29 14:26:00 +00005795}
5796
5797/*
drhc27a1ce2002-06-14 20:58:45 +00005798** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00005799** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00005800*/
danielk19774adee202004-05-08 08:23:19 +00005801void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00005802 Parse *pParse = pWInfo->pParse;
5803 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00005804 int i;
drh6b563442001-11-07 16:48:26 +00005805 WhereLevel *pLevel;
drh7ba39a92013-05-30 17:43:19 +00005806 WhereLoop *pLoop;
drhad3cab52002-05-24 02:04:32 +00005807 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00005808 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00005809
drh9012bcb2004-12-19 00:11:35 +00005810 /* Generate loop termination code.
5811 */
drh6bc69a22013-11-19 12:33:23 +00005812 VdbeModuleComment((v, "End WHERE-core"));
drhceea3322009-04-23 13:22:42 +00005813 sqlite3ExprCacheClear(pParse);
drhc01a3c12009-12-16 22:10:49 +00005814 for(i=pWInfo->nLevel-1; i>=0; i--){
drhcd8629e2013-11-13 12:27:25 +00005815 int addr;
drh6b563442001-11-07 16:48:26 +00005816 pLevel = &pWInfo->a[i];
drh7ba39a92013-05-30 17:43:19 +00005817 pLoop = pLevel->pWLoop;
drhb3190c12008-12-08 21:37:14 +00005818 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00005819 if( pLevel->op!=OP_Noop ){
drhe39a7322014-02-03 14:04:11 +00005820 sqlite3VdbeAddOp3(v, pLevel->op, pLevel->p1, pLevel->p2, pLevel->p3);
drhd1d38482008-10-07 23:46:38 +00005821 sqlite3VdbeChangeP5(v, pLevel->p5);
drh688852a2014-02-17 22:40:43 +00005822 VdbeCoverage(v);
drh7d176102014-02-18 03:07:12 +00005823 VdbeCoverageIf(v, pLevel->op==OP_Next);
5824 VdbeCoverageIf(v, pLevel->op==OP_Prev);
5825 VdbeCoverageIf(v, pLevel->op==OP_VNext);
drh19a775c2000-06-05 18:54:46 +00005826 }
drh7ba39a92013-05-30 17:43:19 +00005827 if( pLoop->wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
drh72e8fa42007-03-28 14:30:06 +00005828 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00005829 int j;
drhb3190c12008-12-08 21:37:14 +00005830 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh111a6a72008-12-21 03:51:16 +00005831 for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00005832 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
drh2d96b932013-02-08 18:48:23 +00005833 sqlite3VdbeAddOp2(v, pIn->eEndLoopOp, pIn->iCur, pIn->addrInTop);
drh688852a2014-02-17 22:40:43 +00005834 VdbeCoverage(v);
drh7d176102014-02-18 03:07:12 +00005835 VdbeCoverageIf(v, pIn->eEndLoopOp==OP_PrevIfOpen);
5836 VdbeCoverageIf(v, pIn->eEndLoopOp==OP_NextIfOpen);
drhb3190c12008-12-08 21:37:14 +00005837 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00005838 }
drh111a6a72008-12-21 03:51:16 +00005839 sqlite3DbFree(db, pLevel->u.in.aInLoop);
drhd99f7062002-06-08 23:25:08 +00005840 }
drhb3190c12008-12-08 21:37:14 +00005841 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhcd8629e2013-11-13 12:27:25 +00005842 if( pLevel->addrSkip ){
drhcd8629e2013-11-13 12:27:25 +00005843 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrSkip);
drhe084f402013-11-13 17:24:38 +00005844 VdbeComment((v, "next skip-scan on %s", pLoop->u.btree.pIndex->zName));
drh2e5ef4e2013-11-13 16:58:54 +00005845 sqlite3VdbeJumpHere(v, pLevel->addrSkip);
5846 sqlite3VdbeJumpHere(v, pLevel->addrSkip-2);
drhcd8629e2013-11-13 12:27:25 +00005847 }
drhad2d8302002-05-24 20:31:36 +00005848 if( pLevel->iLeftJoin ){
drh688852a2014-02-17 22:40:43 +00005849 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin); VdbeCoverage(v);
drh7ba39a92013-05-30 17:43:19 +00005850 assert( (pLoop->wsFlags & WHERE_IDX_ONLY)==0
5851 || (pLoop->wsFlags & WHERE_INDEXED)!=0 );
5852 if( (pLoop->wsFlags & WHERE_IDX_ONLY)==0 ){
drh35451c62009-11-12 04:26:39 +00005853 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
5854 }
drh76f4cfb2013-05-31 18:20:52 +00005855 if( pLoop->wsFlags & WHERE_INDEXED ){
drh3c84ddf2008-01-09 02:15:38 +00005856 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00005857 }
drh336a5302009-04-24 15:46:21 +00005858 if( pLevel->op==OP_Return ){
5859 sqlite3VdbeAddOp2(v, OP_Gosub, pLevel->p1, pLevel->addrFirst);
5860 }else{
5861 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
5862 }
drhd654be82005-09-20 17:42:23 +00005863 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00005864 }
drh6bc69a22013-11-19 12:33:23 +00005865 VdbeModuleComment((v, "End WHERE-loop%d: %s", i,
drhfc8d4f92013-11-08 15:19:46 +00005866 pWInfo->pTabList->a[pLevel->iFrom].pTab->zName));
drh19a775c2000-06-05 18:54:46 +00005867 }
drh9012bcb2004-12-19 00:11:35 +00005868
5869 /* The "break" point is here, just past the end of the outer loop.
5870 ** Set it.
5871 */
danielk19774adee202004-05-08 08:23:19 +00005872 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00005873
drhfd636c72013-06-21 02:05:06 +00005874 assert( pWInfo->nLevel<=pTabList->nSrc );
drhc01a3c12009-12-16 22:10:49 +00005875 for(i=0, pLevel=pWInfo->a; i<pWInfo->nLevel; i++, pLevel++){
drh5f612292014-02-08 23:20:32 +00005876 int k, last;
5877 VdbeOp *pOp;
danbfca6a42012-08-24 10:52:35 +00005878 Index *pIdx = 0;
drh29dda4a2005-07-21 18:23:20 +00005879 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00005880 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00005881 assert( pTab!=0 );
drh7ba39a92013-05-30 17:43:19 +00005882 pLoop = pLevel->pWLoop;
drhfc8d4f92013-11-08 15:19:46 +00005883
drh5f612292014-02-08 23:20:32 +00005884 /* For a co-routine, change all OP_Column references to the table of
5885 ** the co-routine into OP_SCopy of result contained in a register.
5886 ** OP_Rowid becomes OP_Null.
5887 */
danfbf0f0e2014-03-03 14:20:30 +00005888 if( pTabItem->viaCoroutine && !db->mallocFailed ){
drh5f612292014-02-08 23:20:32 +00005889 last = sqlite3VdbeCurrentAddr(v);
5890 k = pLevel->addrBody;
5891 pOp = sqlite3VdbeGetOp(v, k);
5892 for(; k<last; k++, pOp++){
5893 if( pOp->p1!=pLevel->iTabCur ) continue;
5894 if( pOp->opcode==OP_Column ){
5895 pOp->opcode = OP_SCopy;
5896 pOp->p1 = pOp->p2 + pTabItem->regResult;
5897 pOp->p2 = pOp->p3;
5898 pOp->p3 = 0;
5899 }else if( pOp->opcode==OP_Rowid ){
5900 pOp->opcode = OP_Null;
5901 pOp->p1 = 0;
5902 pOp->p3 = 0;
5903 }
5904 }
5905 continue;
5906 }
5907
drhfc8d4f92013-11-08 15:19:46 +00005908 /* Close all of the cursors that were opened by sqlite3WhereBegin.
5909 ** Except, do not close cursors that will be reused by the OR optimization
5910 ** (WHERE_OMIT_OPEN_CLOSE). And do not close the OP_OpenWrite cursors
5911 ** created for the ONEPASS optimization.
5912 */
drh4139c992010-04-07 14:59:45 +00005913 if( (pTab->tabFlags & TF_Ephemeral)==0
5914 && pTab->pSelect==0
drh9ef61f42011-10-07 14:40:59 +00005915 && (pWInfo->wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0
drh4139c992010-04-07 14:59:45 +00005916 ){
drh7ba39a92013-05-30 17:43:19 +00005917 int ws = pLoop->wsFlags;
drh8b307fb2010-04-06 15:57:05 +00005918 if( !pWInfo->okOnePass && (ws & WHERE_IDX_ONLY)==0 ){
drh6df2acd2008-12-28 16:55:25 +00005919 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
5920 }
drhfc8d4f92013-11-08 15:19:46 +00005921 if( (ws & WHERE_INDEXED)!=0
5922 && (ws & (WHERE_IPK|WHERE_AUTO_INDEX))==0
5923 && pLevel->iIdxCur!=pWInfo->aiCurOnePass[1]
5924 ){
drh6df2acd2008-12-28 16:55:25 +00005925 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
5926 }
drh9012bcb2004-12-19 00:11:35 +00005927 }
5928
drhf0030762013-06-14 13:27:01 +00005929 /* If this scan uses an index, make VDBE code substitutions to read data
5930 ** from the index instead of from the table where possible. In some cases
5931 ** this optimization prevents the table from ever being read, which can
5932 ** yield a significant performance boost.
drh9012bcb2004-12-19 00:11:35 +00005933 **
5934 ** Calls to the code generator in between sqlite3WhereBegin and
5935 ** sqlite3WhereEnd will have created code that references the table
5936 ** directly. This loop scans all that code looking for opcodes
5937 ** that reference the table and converts them into opcodes that
5938 ** reference the index.
5939 */
drh7ba39a92013-05-30 17:43:19 +00005940 if( pLoop->wsFlags & (WHERE_INDEXED|WHERE_IDX_ONLY) ){
5941 pIdx = pLoop->u.btree.pIndex;
5942 }else if( pLoop->wsFlags & WHERE_MULTI_OR ){
drhd40e2082012-08-24 23:24:15 +00005943 pIdx = pLevel->u.pCovidx;
danbfca6a42012-08-24 10:52:35 +00005944 }
drh7ba39a92013-05-30 17:43:19 +00005945 if( pIdx && !db->mallocFailed ){
drh9012bcb2004-12-19 00:11:35 +00005946 last = sqlite3VdbeCurrentAddr(v);
drhcc04afd2013-08-22 02:56:28 +00005947 k = pLevel->addrBody;
5948 pOp = sqlite3VdbeGetOp(v, k);
5949 for(; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00005950 if( pOp->p1!=pLevel->iTabCur ) continue;
5951 if( pOp->opcode==OP_Column ){
drhee0ec8e2013-10-31 17:38:01 +00005952 int x = pOp->p2;
drh511717c2013-11-08 17:13:23 +00005953 assert( pIdx->pTable==pTab );
drhee0ec8e2013-10-31 17:38:01 +00005954 if( !HasRowid(pTab) ){
5955 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
5956 x = pPk->aiColumn[x];
5957 }
5958 x = sqlite3ColumnOfIndex(pIdx, x);
drh44156282013-10-23 22:23:03 +00005959 if( x>=0 ){
5960 pOp->p2 = x;
5961 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00005962 }
drh44156282013-10-23 22:23:03 +00005963 assert( (pLoop->wsFlags & WHERE_IDX_ONLY)==0 || x>=0 );
drhf0863fe2005-06-12 21:35:51 +00005964 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00005965 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00005966 pOp->opcode = OP_IdxRowid;
drh9012bcb2004-12-19 00:11:35 +00005967 }
5968 }
drh6b563442001-11-07 16:48:26 +00005969 }
drh19a775c2000-06-05 18:54:46 +00005970 }
drh9012bcb2004-12-19 00:11:35 +00005971
5972 /* Final cleanup
5973 */
drhf12cde52010-04-08 17:28:00 +00005974 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
5975 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00005976 return;
5977}