blob: 93a932b5d2d94380f413a3947e0a97f7a89ed439 [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**
drhec1724e2008-12-09 01:32:03 +000019** $Id: where.c,v 1.335 2008/12/09 01:32:03 drh Exp $
drh75897232000-05-29 14:26:00 +000020*/
21#include "sqliteInt.h"
22
23/*
drh51147ba2005-07-23 22:59:55 +000024** Trace output macros
25*/
26#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
mlcreech3a00f902008-03-04 17:45:01 +000027int sqlite3WhereTrace = 0;
drhe8f52c52008-07-12 14:52:20 +000028#endif
29#if 0
mlcreech3a00f902008-03-04 17:45:01 +000030# define WHERETRACE(X) if(sqlite3WhereTrace) sqlite3DebugPrintf X
drh51147ba2005-07-23 22:59:55 +000031#else
drh4f0c5872007-03-26 22:05:01 +000032# define WHERETRACE(X)
drh51147ba2005-07-23 22:59:55 +000033#endif
34
drh0fcef5e2005-07-19 17:38:22 +000035/* Forward reference
36*/
37typedef struct WhereClause WhereClause;
drh7b4fc6a2007-02-06 13:26:32 +000038typedef struct ExprMaskSet ExprMaskSet;
drh0aa74ed2005-07-16 13:33:20 +000039
40/*
drh75897232000-05-29 14:26:00 +000041** The query generator uses an array of instances of this structure to
42** help it analyze the subexpressions of the WHERE clause. Each WHERE
drh6a1e0712008-12-05 15:24:15 +000043** clause subexpression is separated from the others by AND operators.
44** (Note: the same data structure is also reused to hold a group of terms
45** separated by OR operators. But at the top-level, everything is AND
46** separated.)
drh51669862004-12-18 18:40:26 +000047**
drh0fcef5e2005-07-19 17:38:22 +000048** All WhereTerms are collected into a single WhereClause structure.
49** The following identity holds:
drh51669862004-12-18 18:40:26 +000050**
drh0fcef5e2005-07-19 17:38:22 +000051** WhereTerm.pWC->a[WhereTerm.idx] == WhereTerm
drh51669862004-12-18 18:40:26 +000052**
drh0fcef5e2005-07-19 17:38:22 +000053** When a term is of the form:
54**
55** X <op> <expr>
56**
57** where X is a column name and <op> is one of certain operators,
58** then WhereTerm.leftCursor and WhereTerm.leftColumn record the
drh51147ba2005-07-23 22:59:55 +000059** cursor number and column number for X. WhereTerm.operator records
60** the <op> using a bitmask encoding defined by WO_xxx below. The
61** use of a bitmask encoding for the operator allows us to search
62** quickly for terms that match any of several different operators.
drh0fcef5e2005-07-19 17:38:22 +000063**
64** prereqRight and prereqAll record sets of cursor numbers,
drh51669862004-12-18 18:40:26 +000065** but they do so indirectly. A single ExprMaskSet structure translates
66** cursor number into bits and the translated bit is stored in the prereq
67** fields. The translation is used in order to maximize the number of
68** bits that will fit in a Bitmask. The VDBE cursor numbers might be
69** spread out over the non-negative integers. For example, the cursor
70** numbers might be 3, 8, 9, 10, 20, 23, 41, and 45. The ExprMaskSet
71** translates these sparse cursor numbers into consecutive integers
72** beginning with 0 in order to make the best possible use of the available
73** bits in the Bitmask. So, in the example above, the cursor numbers
74** would be mapped into integers 0 through 7.
drh6a1e0712008-12-05 15:24:15 +000075**
76** The number of terms in a join is limited by the number of bits
77** in prereqRight and prereqAll. The default is 64 bits, hence SQLite
78** is only able to process joins with 64 or fewer tables.
drh75897232000-05-29 14:26:00 +000079*/
drh0aa74ed2005-07-16 13:33:20 +000080typedef struct WhereTerm WhereTerm;
81struct WhereTerm {
drh165be382008-12-05 02:36:33 +000082 Expr *pExpr; /* Pointer to the subexpression that is this term */
drhec1724e2008-12-09 01:32:03 +000083 int iParent; /* Disable pWC->a[iParent] when this term disabled */
84 int leftCursor; /* Cursor number of X in "X <op> <expr>" */
85 int leftColumn; /* Column number of X in "X <op> <expr>" */
drhb52076c2006-01-23 13:22:09 +000086 u16 eOperator; /* A WO_xx value describing <op> */
drh165be382008-12-05 02:36:33 +000087 u8 wtFlags; /* TERM_xxx bit flags. See below */
drh45b1ee42005-08-02 17:48:22 +000088 u8 nChild; /* Number of children that must disable us */
drh0fcef5e2005-07-19 17:38:22 +000089 WhereClause *pWC; /* The clause this term is part of */
drh165be382008-12-05 02:36:33 +000090 Bitmask prereqRight; /* Bitmask of tables used by pExpr->pRight */
91 Bitmask prereqAll; /* Bitmask of tables referenced by pExpr */
drh75897232000-05-29 14:26:00 +000092};
93
94/*
drh165be382008-12-05 02:36:33 +000095** Allowed values of WhereTerm.wtFlags
drh0aa74ed2005-07-16 13:33:20 +000096*/
drh633e6d52008-07-28 19:34:53 +000097#define TERM_DYNAMIC 0x01 /* Need to call sqlite3ExprDelete(db, pExpr) */
drh6c30be82005-07-29 15:10:17 +000098#define TERM_VIRTUAL 0x02 /* Added by the optimizer. Do not code */
99#define TERM_CODED 0x04 /* This term is already coded */
drh45b1ee42005-08-02 17:48:22 +0000100#define TERM_COPIED 0x08 /* Has a child */
drh6c30be82005-07-29 15:10:17 +0000101#define TERM_OR_OK 0x10 /* Used during OR-clause processing */
drh0aa74ed2005-07-16 13:33:20 +0000102
103/*
104** An instance of the following structure holds all information about a
105** WHERE clause. Mostly this is a container for one or more WhereTerms.
106*/
drh0aa74ed2005-07-16 13:33:20 +0000107struct WhereClause {
drhfe05af82005-07-21 03:14:59 +0000108 Parse *pParse; /* The parser context */
drh7b4fc6a2007-02-06 13:26:32 +0000109 ExprMaskSet *pMaskSet; /* Mapping of table indices to bitmasks */
drh0aa74ed2005-07-16 13:33:20 +0000110 int nTerm; /* Number of terms */
111 int nSlot; /* Number of entries in a[] */
drh51147ba2005-07-23 22:59:55 +0000112 WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
drhec1724e2008-12-09 01:32:03 +0000113 WhereTerm aStatic[4]; /* Initial static space for a[] */
drhe23399f2005-07-22 00:31:39 +0000114};
115
116/*
drh6a3ea0e2003-05-02 14:32:12 +0000117** An instance of the following structure keeps track of a mapping
drh0aa74ed2005-07-16 13:33:20 +0000118** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
drh51669862004-12-18 18:40:26 +0000119**
120** The VDBE cursor numbers are small integers contained in
121** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
122** clause, the cursor numbers might not begin with 0 and they might
123** contain gaps in the numbering sequence. But we want to make maximum
124** use of the bits in our bitmasks. This structure provides a mapping
125** from the sparse cursor numbers into consecutive integers beginning
126** with 0.
127**
128** If ExprMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
129** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
130**
131** For example, if the WHERE clause expression used these VDBE
132** cursors: 4, 5, 8, 29, 57, 73. Then the ExprMaskSet structure
133** would map those cursor numbers into bits 0 through 5.
134**
135** Note that the mapping is not necessarily ordered. In the example
136** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
137** 57->5, 73->4. Or one of 719 other combinations might be used. It
138** does not really matter. What is important is that sparse cursor
139** numbers all get mapped into bit numbers that begin with 0 and contain
140** no gaps.
drh6a3ea0e2003-05-02 14:32:12 +0000141*/
drh6a3ea0e2003-05-02 14:32:12 +0000142struct ExprMaskSet {
drh1398ad32005-01-19 23:24:50 +0000143 int n; /* Number of assigned cursor values */
danielk197723432972008-11-17 16:42:00 +0000144 int ix[BMS]; /* Cursor assigned to each bit */
drh6a3ea0e2003-05-02 14:32:12 +0000145};
146
drh0aa74ed2005-07-16 13:33:20 +0000147
drh6a3ea0e2003-05-02 14:32:12 +0000148/*
drh51147ba2005-07-23 22:59:55 +0000149** Bitmasks for the operators that indices are able to exploit. An
150** OR-ed combination of these values can be used when searching for
151** terms in the where clause.
152*/
drh165be382008-12-05 02:36:33 +0000153#define WO_IN 0x001
154#define WO_EQ 0x002
drh51147ba2005-07-23 22:59:55 +0000155#define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
156#define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
157#define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
158#define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
drh165be382008-12-05 02:36:33 +0000159#define WO_MATCH 0x040
160#define WO_ISNULL 0x080
161#define WO_OR 0x100
drh51147ba2005-07-23 22:59:55 +0000162
drhec1724e2008-12-09 01:32:03 +0000163#define WO_ALL 0xfff /* Mask of all possible WO_* values */
164
drh51147ba2005-07-23 22:59:55 +0000165/*
drh165be382008-12-05 02:36:33 +0000166** Value for wsFlags returned by bestIndex(). These flags determine which
167** search strategies are appropriate.
drhf2d315d2007-01-25 16:56:06 +0000168**
drh165be382008-12-05 02:36:33 +0000169** The least significant 12 bits is reserved as a mask for WO_ values above.
170** The WhereLevel.wtFlags field is usually set to WO_IN|WO_EQ|WO_ISNULL.
171** But if the table is the right table of a left join, WhereLevel.wtFlags
172** is set to WO_IN|WO_EQ. The WhereLevel.wtFlags field can then be used as
drhf2d315d2007-01-25 16:56:06 +0000173** the "op" parameter to findTerm when we are resolving equality constraints.
174** ISNULL constraints will then not be used on the right table of a left
175** join. Tickets #2177 and #2189.
drh51147ba2005-07-23 22:59:55 +0000176*/
drh165be382008-12-05 02:36:33 +0000177#define WHERE_ROWID_EQ 0x00001000 /* rowid=EXPR or rowid IN (...) */
178#define WHERE_ROWID_RANGE 0x00002000 /* rowid<EXPR and/or rowid>EXPR */
179#define WHERE_COLUMN_EQ 0x00010000 /* x=EXPR or x IN (...) */
180#define WHERE_COLUMN_RANGE 0x00020000 /* x<EXPR and/or x>EXPR */
181#define WHERE_COLUMN_IN 0x00040000 /* x IN (...) */
182#define WHERE_TOP_LIMIT 0x00100000 /* x<EXPR or x<=EXPR constraint */
183#define WHERE_BTM_LIMIT 0x00200000 /* x>EXPR or x>=EXPR constraint */
184#define WHERE_IDX_ONLY 0x00800000 /* Use index only - omit table */
185#define WHERE_ORDERBY 0x01000000 /* Output will appear in correct order */
186#define WHERE_REVERSE 0x02000000 /* Scan in reverse order */
187#define WHERE_UNIQUE 0x04000000 /* Selects no more than one row */
188#define WHERE_VIRTUALTABLE 0x08000000 /* Use virtual-table processing */
189#define WHERE_MULTI_OR 0x10000000 /* OR using multiple indices */
drh51147ba2005-07-23 22:59:55 +0000190
191/*
drh0aa74ed2005-07-16 13:33:20 +0000192** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000193*/
drh7b4fc6a2007-02-06 13:26:32 +0000194static void whereClauseInit(
195 WhereClause *pWC, /* The WhereClause to be initialized */
196 Parse *pParse, /* The parsing context */
197 ExprMaskSet *pMaskSet /* Mapping from table indices to bitmasks */
198){
drhfe05af82005-07-21 03:14:59 +0000199 pWC->pParse = pParse;
drh7b4fc6a2007-02-06 13:26:32 +0000200 pWC->pMaskSet = pMaskSet;
drh0aa74ed2005-07-16 13:33:20 +0000201 pWC->nTerm = 0;
drhcad651e2007-04-20 12:22:01 +0000202 pWC->nSlot = ArraySize(pWC->aStatic);
drh0aa74ed2005-07-16 13:33:20 +0000203 pWC->a = pWC->aStatic;
204}
205
206/*
207** Deallocate a WhereClause structure. The WhereClause structure
208** itself is not freed. This routine is the inverse of whereClauseInit().
209*/
210static void whereClauseClear(WhereClause *pWC){
211 int i;
212 WhereTerm *a;
drh633e6d52008-07-28 19:34:53 +0000213 sqlite3 *db = pWC->pParse->db;
drh0aa74ed2005-07-16 13:33:20 +0000214 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
drh165be382008-12-05 02:36:33 +0000215 if( a->wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000216 sqlite3ExprDelete(db, a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000217 }
218 }
219 if( pWC->a!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000220 sqlite3DbFree(db, pWC->a);
drh0aa74ed2005-07-16 13:33:20 +0000221 }
222}
223
224/*
drh6a1e0712008-12-05 15:24:15 +0000225** Add a single new WhereTerm entry to the WhereClause object pWC.
226** The new WhereTerm object is constructed from Expr p and with wtFlags.
227** The index in pWC->a[] of the new WhereTerm is returned on success.
228** 0 is returned if the new WhereTerm could not be added due to a memory
229** allocation error. The memory allocation failure will be recorded in
230** the db->mallocFailed flag so that higher-level functions can detect it.
231**
232** This routine will increase the size of the pWC->a[] array as necessary.
drh9eb20282005-08-24 03:52:18 +0000233**
drh165be382008-12-05 02:36:33 +0000234** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
drh6a1e0712008-12-05 15:24:15 +0000235** for freeing the expression p is assumed by the WhereClause object pWC.
236** This is true even if this routine fails to allocate a new WhereTerm.
drhb63a53d2007-03-31 01:34:44 +0000237**
drh9eb20282005-08-24 03:52:18 +0000238** WARNING: This routine might reallocate the space used to store
drh909626d2008-05-30 14:58:37 +0000239** WhereTerms. All pointers to WhereTerms should be invalidated after
drh9eb20282005-08-24 03:52:18 +0000240** calling this routine. Such pointers may be reinitialized by referencing
241** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000242*/
drhec1724e2008-12-09 01:32:03 +0000243static int whereClauseInsert(WhereClause *pWC, Expr *p, u8 wtFlags){
drh0aa74ed2005-07-16 13:33:20 +0000244 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000245 int idx;
drh0aa74ed2005-07-16 13:33:20 +0000246 if( pWC->nTerm>=pWC->nSlot ){
247 WhereTerm *pOld = pWC->a;
drh633e6d52008-07-28 19:34:53 +0000248 sqlite3 *db = pWC->pParse->db;
249 pWC->a = sqlite3DbMallocRaw(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
drhb63a53d2007-03-31 01:34:44 +0000250 if( pWC->a==0 ){
drh165be382008-12-05 02:36:33 +0000251 if( wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000252 sqlite3ExprDelete(db, p);
drhb63a53d2007-03-31 01:34:44 +0000253 }
drhf998b732007-11-26 13:36:00 +0000254 pWC->a = pOld;
drhb63a53d2007-03-31 01:34:44 +0000255 return 0;
256 }
drh0aa74ed2005-07-16 13:33:20 +0000257 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
258 if( pOld!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000259 sqlite3DbFree(db, pOld);
drh0aa74ed2005-07-16 13:33:20 +0000260 }
drh6a1e0712008-12-05 15:24:15 +0000261 pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
drh0aa74ed2005-07-16 13:33:20 +0000262 }
drh6a1e0712008-12-05 15:24:15 +0000263 pTerm = &pWC->a[idx = pWC->nTerm++];
drh0fcef5e2005-07-19 17:38:22 +0000264 pTerm->pExpr = p;
drh165be382008-12-05 02:36:33 +0000265 pTerm->wtFlags = wtFlags;
drh0fcef5e2005-07-19 17:38:22 +0000266 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000267 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000268 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000269}
drh75897232000-05-29 14:26:00 +0000270
271/*
drh51669862004-12-18 18:40:26 +0000272** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000273** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000274** operator specified in the op parameter. The WhereClause structure
275** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000276**
drh51669862004-12-18 18:40:26 +0000277** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
278** \________/ \_______________/ \________________/
279** slot[0] slot[1] slot[2]
280**
281** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000282** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000283**
drh51147ba2005-07-23 22:59:55 +0000284** In the previous sentence and in the diagram, "slot[]" refers to
drh902b9ee2008-12-05 17:17:07 +0000285** the WhereClause.a[] array. The slot[] array grows as needed to contain
drh51147ba2005-07-23 22:59:55 +0000286** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000287*/
drh6c30be82005-07-29 15:10:17 +0000288static void whereSplit(WhereClause *pWC, Expr *pExpr, int op){
drh0aa74ed2005-07-16 13:33:20 +0000289 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000290 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000291 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000292 }else{
drh6c30be82005-07-29 15:10:17 +0000293 whereSplit(pWC, pExpr->pLeft, op);
294 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000295 }
drh75897232000-05-29 14:26:00 +0000296}
297
298/*
drh6a3ea0e2003-05-02 14:32:12 +0000299** Initialize an expression mask set
300*/
301#define initMaskSet(P) memset(P, 0, sizeof(*P))
302
303/*
drh1398ad32005-01-19 23:24:50 +0000304** Return the bitmask for the given cursor number. Return 0 if
305** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000306*/
drh51669862004-12-18 18:40:26 +0000307static Bitmask getMask(ExprMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000308 int i;
309 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000310 if( pMaskSet->ix[i]==iCursor ){
311 return ((Bitmask)1)<<i;
312 }
drh6a3ea0e2003-05-02 14:32:12 +0000313 }
drh6a3ea0e2003-05-02 14:32:12 +0000314 return 0;
315}
316
317/*
drh1398ad32005-01-19 23:24:50 +0000318** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000319**
320** There is one cursor per table in the FROM clause. The number of
321** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000322** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000323** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000324*/
325static void createMask(ExprMaskSet *pMaskSet, int iCursor){
drhcad651e2007-04-20 12:22:01 +0000326 assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
drh0fcef5e2005-07-19 17:38:22 +0000327 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000328}
329
330/*
drh75897232000-05-29 14:26:00 +0000331** This routine walks (recursively) an expression tree and generates
332** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000333** tree.
drh75897232000-05-29 14:26:00 +0000334**
335** In order for this routine to work, the calling function must have
drh7d10d5a2008-08-20 16:35:10 +0000336** previously invoked sqlite3ResolveExprNames() on the expression. See
drh75897232000-05-29 14:26:00 +0000337** the header comment on that routine for additional information.
drh7d10d5a2008-08-20 16:35:10 +0000338** The sqlite3ResolveExprNames() routines looks for column names and
drh6a3ea0e2003-05-02 14:32:12 +0000339** sets their opcodes to TK_COLUMN and their Expr.iTable fields to
drh51147ba2005-07-23 22:59:55 +0000340** the VDBE cursor number of the table. This routine just has to
341** translate the cursor numbers into bitmask values and OR all
342** the bitmasks together.
drh75897232000-05-29 14:26:00 +0000343*/
drhf5b11382005-09-17 13:07:13 +0000344static Bitmask exprListTableUsage(ExprMaskSet*, ExprList*);
345static Bitmask exprSelectTableUsage(ExprMaskSet*, Select*);
drh51669862004-12-18 18:40:26 +0000346static Bitmask exprTableUsage(ExprMaskSet *pMaskSet, Expr *p){
347 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000348 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000349 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000350 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000351 return mask;
drh75897232000-05-29 14:26:00 +0000352 }
danielk1977b3bce662005-01-29 08:32:43 +0000353 mask = exprTableUsage(pMaskSet, p->pRight);
354 mask |= exprTableUsage(pMaskSet, p->pLeft);
355 mask |= exprListTableUsage(pMaskSet, p->pList);
drhf5b11382005-09-17 13:07:13 +0000356 mask |= exprSelectTableUsage(pMaskSet, p->pSelect);
danielk1977b3bce662005-01-29 08:32:43 +0000357 return mask;
358}
359static Bitmask exprListTableUsage(ExprMaskSet *pMaskSet, ExprList *pList){
360 int i;
361 Bitmask mask = 0;
362 if( pList ){
363 for(i=0; i<pList->nExpr; i++){
364 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000365 }
366 }
drh75897232000-05-29 14:26:00 +0000367 return mask;
368}
drhf5b11382005-09-17 13:07:13 +0000369static Bitmask exprSelectTableUsage(ExprMaskSet *pMaskSet, Select *pS){
drha430ae82007-09-12 15:41:01 +0000370 Bitmask mask = 0;
371 while( pS ){
372 mask |= exprListTableUsage(pMaskSet, pS->pEList);
drhf5b11382005-09-17 13:07:13 +0000373 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
374 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
375 mask |= exprTableUsage(pMaskSet, pS->pWhere);
376 mask |= exprTableUsage(pMaskSet, pS->pHaving);
drha430ae82007-09-12 15:41:01 +0000377 pS = pS->pPrior;
drhf5b11382005-09-17 13:07:13 +0000378 }
379 return mask;
380}
drh75897232000-05-29 14:26:00 +0000381
382/*
drh487ab3c2001-11-08 00:45:21 +0000383** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000384** allowed for an indexable WHERE clause term. The allowed operators are
drhc27a1ce2002-06-14 20:58:45 +0000385** "=", "<", ">", "<=", ">=", and "IN".
drh487ab3c2001-11-08 00:45:21 +0000386*/
387static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000388 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
389 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
390 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
391 assert( TK_GE==TK_EQ+4 );
drh50b39962006-10-28 00:28:09 +0000392 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL;
drh487ab3c2001-11-08 00:45:21 +0000393}
394
395/*
drh902b9ee2008-12-05 17:17:07 +0000396** Swap two objects of type TYPE.
drh193bd772004-07-20 18:23:14 +0000397*/
398#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
399
400/*
drh909626d2008-05-30 14:58:37 +0000401** Commute a comparison operator. Expressions of the form "X op Y"
drh0fcef5e2005-07-19 17:38:22 +0000402** are converted into "Y op X".
danielk1977eb5453d2007-07-30 14:40:48 +0000403**
404** If a collation sequence is associated with either the left or right
405** side of the comparison, it remains associated with the same side after
406** the commutation. So "Y collate NOCASE op X" becomes
407** "X collate NOCASE op Y". This is because any collation sequence on
408** the left hand side of a comparison overrides any collation sequence
409** attached to the right. For the same reason the EP_ExpCollate flag
410** is not commuted.
drh193bd772004-07-20 18:23:14 +0000411*/
drh7d10d5a2008-08-20 16:35:10 +0000412static void exprCommute(Parse *pParse, Expr *pExpr){
danielk1977eb5453d2007-07-30 14:40:48 +0000413 u16 expRight = (pExpr->pRight->flags & EP_ExpCollate);
414 u16 expLeft = (pExpr->pLeft->flags & EP_ExpCollate);
drhfe05af82005-07-21 03:14:59 +0000415 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drh7d10d5a2008-08-20 16:35:10 +0000416 pExpr->pRight->pColl = sqlite3ExprCollSeq(pParse, pExpr->pRight);
417 pExpr->pLeft->pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drh0fcef5e2005-07-19 17:38:22 +0000418 SWAP(CollSeq*,pExpr->pRight->pColl,pExpr->pLeft->pColl);
danielk1977eb5453d2007-07-30 14:40:48 +0000419 pExpr->pRight->flags = (pExpr->pRight->flags & ~EP_ExpCollate) | expLeft;
420 pExpr->pLeft->flags = (pExpr->pLeft->flags & ~EP_ExpCollate) | expRight;
drh0fcef5e2005-07-19 17:38:22 +0000421 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
422 if( pExpr->op>=TK_GT ){
423 assert( TK_LT==TK_GT+2 );
424 assert( TK_GE==TK_LE+2 );
425 assert( TK_GT>TK_EQ );
426 assert( TK_GT<TK_LE );
427 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
428 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000429 }
drh193bd772004-07-20 18:23:14 +0000430}
431
432/*
drhfe05af82005-07-21 03:14:59 +0000433** Translate from TK_xx operator to WO_xx bitmask.
434*/
drhec1724e2008-12-09 01:32:03 +0000435static u16 operatorMask(int op){
436 u16 c;
drhfe05af82005-07-21 03:14:59 +0000437 assert( allowedOp(op) );
438 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000439 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000440 }else if( op==TK_ISNULL ){
441 c = WO_ISNULL;
drh165be382008-12-05 02:36:33 +0000442 }else if( op==TK_OR ){
443 c = WO_OR;
drhfe05af82005-07-21 03:14:59 +0000444 }else{
drhec1724e2008-12-09 01:32:03 +0000445 assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
446 c = (u16)(WO_EQ<<(op-TK_EQ));
drhfe05af82005-07-21 03:14:59 +0000447 }
drh50b39962006-10-28 00:28:09 +0000448 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh165be382008-12-05 02:36:33 +0000449 assert( op!=TK_OR || c==WO_OR );
drh51147ba2005-07-23 22:59:55 +0000450 assert( op!=TK_IN || c==WO_IN );
451 assert( op!=TK_EQ || c==WO_EQ );
452 assert( op!=TK_LT || c==WO_LT );
453 assert( op!=TK_LE || c==WO_LE );
454 assert( op!=TK_GT || c==WO_GT );
455 assert( op!=TK_GE || c==WO_GE );
456 return c;
drhfe05af82005-07-21 03:14:59 +0000457}
458
459/*
460** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
461** where X is a reference to the iColumn of table iCur and <op> is one of
462** the WO_xx operator codes specified by the op parameter.
463** Return a pointer to the term. Return 0 if not found.
464*/
465static WhereTerm *findTerm(
466 WhereClause *pWC, /* The WHERE clause to be searched */
467 int iCur, /* Cursor number of LHS */
468 int iColumn, /* Column number of LHS */
469 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000470 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000471 Index *pIdx /* Must be compatible with this index, if not NULL */
472){
473 WhereTerm *pTerm;
474 int k;
drh22c24032008-07-09 13:28:53 +0000475 assert( iCur>=0 );
drhec1724e2008-12-09 01:32:03 +0000476 op &= WO_ALL;
drhfe05af82005-07-21 03:14:59 +0000477 for(pTerm=pWC->a, k=pWC->nTerm; k; k--, pTerm++){
478 if( pTerm->leftCursor==iCur
479 && (pTerm->prereqRight & notReady)==0
480 && pTerm->leftColumn==iColumn
drhb52076c2006-01-23 13:22:09 +0000481 && (pTerm->eOperator & op)!=0
drhfe05af82005-07-21 03:14:59 +0000482 ){
drh22c24032008-07-09 13:28:53 +0000483 if( pIdx && pTerm->eOperator!=WO_ISNULL ){
drhfe05af82005-07-21 03:14:59 +0000484 Expr *pX = pTerm->pExpr;
485 CollSeq *pColl;
486 char idxaff;
danielk1977f0113002006-01-24 12:09:17 +0000487 int j;
drhfe05af82005-07-21 03:14:59 +0000488 Parse *pParse = pWC->pParse;
489
490 idxaff = pIdx->pTable->aCol[iColumn].affinity;
491 if( !sqlite3IndexAffinityOk(pX, idxaff) ) continue;
danielk1977bcbb04e2007-05-29 12:11:29 +0000492
493 /* Figure out the collation sequence required from an index for
494 ** it to be useful for optimising expression pX. Store this
495 ** value in variable pColl.
496 */
497 assert(pX->pLeft);
498 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
drhfe05af82005-07-21 03:14:59 +0000499 if( !pColl ){
danielk1977bcbb04e2007-05-29 12:11:29 +0000500 pColl = pParse->db->pDfltColl;
drhfe05af82005-07-21 03:14:59 +0000501 }
danielk1977bcbb04e2007-05-29 12:11:29 +0000502
drh22c24032008-07-09 13:28:53 +0000503 for(j=0; pIdx->aiColumn[j]!=iColumn; j++){
drh34004ce2008-07-11 16:15:17 +0000504 if( NEVER(j>=pIdx->nColumn) ) return 0;
drh22c24032008-07-09 13:28:53 +0000505 }
danielk1977f0113002006-01-24 12:09:17 +0000506 if( sqlite3StrICmp(pColl->zName, pIdx->azColl[j]) ) continue;
drhfe05af82005-07-21 03:14:59 +0000507 }
508 return pTerm;
509 }
510 }
511 return 0;
512}
513
drh6c30be82005-07-29 15:10:17 +0000514/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000515static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000516
517/*
518** Call exprAnalyze on all terms in a WHERE clause.
519**
520**
521*/
522static void exprAnalyzeAll(
523 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000524 WhereClause *pWC /* the WHERE clause to be analyzed */
525){
drh6c30be82005-07-29 15:10:17 +0000526 int i;
drh9eb20282005-08-24 03:52:18 +0000527 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000528 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000529 }
530}
531
drhd2687b72005-08-12 22:56:09 +0000532#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
533/*
534** Check to see if the given expression is a LIKE or GLOB operator that
535** can be optimized using inequality constraints. Return TRUE if it is
536** so and false if not.
537**
538** In order for the operator to be optimizible, the RHS must be a string
539** literal that does not begin with a wildcard.
540*/
541static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000542 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000543 Expr *pExpr, /* Test this expression */
544 int *pnPattern, /* Number of non-wildcard prefix characters */
drh9f504ea2008-02-23 21:55:39 +0000545 int *pisComplete, /* True if the only wildcard is % in the last character */
546 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000547){
548 const char *z;
549 Expr *pRight, *pLeft;
drh55ef4d92005-08-14 01:20:37 +0000550 ExprList *pList;
drhd2687b72005-08-12 22:56:09 +0000551 int c, cnt;
drh55ef4d92005-08-14 01:20:37 +0000552 char wc[3];
drhd64fe2f2005-08-28 17:00:23 +0000553 CollSeq *pColl;
drh7d10d5a2008-08-20 16:35:10 +0000554 sqlite3 *db = pParse->db;
drhd64fe2f2005-08-28 17:00:23 +0000555
drh9f504ea2008-02-23 21:55:39 +0000556 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000557 return 0;
558 }
drh9f504ea2008-02-23 21:55:39 +0000559#ifdef SQLITE_EBCDIC
560 if( *pnoCase ) return 0;
561#endif
drh55ef4d92005-08-14 01:20:37 +0000562 pList = pExpr->pList;
563 pRight = pList->a[0].pExpr;
drh678ccce2008-03-31 18:19:54 +0000564 if( pRight->op!=TK_STRING
565 && (pRight->op!=TK_REGISTER || pRight->iColumn!=TK_STRING) ){
drhd2687b72005-08-12 22:56:09 +0000566 return 0;
567 }
drh55ef4d92005-08-14 01:20:37 +0000568 pLeft = pList->a[1].pExpr;
drhd2687b72005-08-12 22:56:09 +0000569 if( pLeft->op!=TK_COLUMN ){
570 return 0;
571 }
drh7d10d5a2008-08-20 16:35:10 +0000572 pColl = sqlite3ExprCollSeq(pParse, pLeft);
drh01495b92008-01-23 12:52:40 +0000573 assert( pColl!=0 || pLeft->iColumn==-1 );
drhd64fe2f2005-08-28 17:00:23 +0000574 if( pColl==0 ){
drh01495b92008-01-23 12:52:40 +0000575 /* No collation is defined for the ROWID. Use the default. */
drhd64fe2f2005-08-28 17:00:23 +0000576 pColl = db->pDfltColl;
577 }
drh9f504ea2008-02-23 21:55:39 +0000578 if( (pColl->type!=SQLITE_COLL_BINARY || *pnoCase) &&
579 (pColl->type!=SQLITE_COLL_NOCASE || !*pnoCase) ){
drhd64fe2f2005-08-28 17:00:23 +0000580 return 0;
581 }
drh17435752007-08-16 04:30:38 +0000582 sqlite3DequoteExpr(db, pRight);
danielk197700fd9572005-12-07 06:27:43 +0000583 z = (char *)pRight->token.z;
drhf998b732007-11-26 13:36:00 +0000584 cnt = 0;
585 if( z ){
586 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){ cnt++; }
587 }
drhd2687b72005-08-12 22:56:09 +0000588 if( cnt==0 || 255==(u8)z[cnt] ){
589 return 0;
590 }
drh55ef4d92005-08-14 01:20:37 +0000591 *pisComplete = z[cnt]==wc[0] && z[cnt+1]==0;
drhd2687b72005-08-12 22:56:09 +0000592 *pnPattern = cnt;
593 return 1;
594}
595#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
596
drhedb193b2006-06-27 13:20:21 +0000597
598#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000599/*
drh7f375902006-06-13 17:38:59 +0000600** Check to see if the given expression is of the form
601**
602** column MATCH expr
603**
604** If it is then return TRUE. If not, return FALSE.
605*/
606static int isMatchOfColumn(
607 Expr *pExpr /* Test this expression */
608){
609 ExprList *pList;
610
611 if( pExpr->op!=TK_FUNCTION ){
612 return 0;
613 }
drhedb193b2006-06-27 13:20:21 +0000614 if( pExpr->token.n!=5 ||
615 sqlite3StrNICmp((const char*)pExpr->token.z,"match",5)!=0 ){
drh7f375902006-06-13 17:38:59 +0000616 return 0;
617 }
618 pList = pExpr->pList;
619 if( pList->nExpr!=2 ){
620 return 0;
621 }
622 if( pList->a[1].pExpr->op != TK_COLUMN ){
623 return 0;
624 }
625 return 1;
626}
drhedb193b2006-06-27 13:20:21 +0000627#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000628
629/*
drh54a167d2005-11-26 14:08:07 +0000630** If the pBase expression originated in the ON or USING clause of
631** a join, then transfer the appropriate markings over to derived.
632*/
633static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
634 pDerived->flags |= pBase->flags & EP_FromJoin;
635 pDerived->iRightJoinTable = pBase->iRightJoinTable;
636}
637
drh3e355802007-02-23 23:13:33 +0000638#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
639/*
640** Return TRUE if the given term of an OR clause can be converted
641** into an IN clause. The iCursor and iColumn define the left-hand
642** side of the IN clause.
643**
644** The context is that we have multiple OR-connected equality terms
645** like this:
646**
647** a=<expr1> OR a=<expr2> OR b=<expr3> OR ...
648**
649** The pOrTerm input to this routine corresponds to a single term of
drh909626d2008-05-30 14:58:37 +0000650** this OR clause. In order for the term to be a candidate for
drh3e355802007-02-23 23:13:33 +0000651** conversion to an IN operator, the following must be true:
652**
653** * The left-hand side of the term must be the column which
654** is identified by iCursor and iColumn.
655**
656** * If the right-hand side is also a column, then the affinities
657** of both right and left sides must be such that no type
658** conversions are required on the right. (Ticket #2249)
659**
660** If both of these conditions are true, then return true. Otherwise
661** return false.
662*/
663static int orTermIsOptCandidate(WhereTerm *pOrTerm, int iCursor, int iColumn){
664 int affLeft, affRight;
665 assert( pOrTerm->eOperator==WO_EQ );
666 if( pOrTerm->leftCursor!=iCursor ){
667 return 0;
668 }
669 if( pOrTerm->leftColumn!=iColumn ){
670 return 0;
671 }
672 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
673 if( affRight==0 ){
674 return 1;
675 }
676 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
677 if( affRight!=affLeft ){
678 return 0;
679 }
680 return 1;
681}
682
683/*
684** Return true if the given term of an OR clause can be ignored during
685** a check to make sure all OR terms are candidates for optimization.
686** In other words, return true if a call to the orTermIsOptCandidate()
687** above returned false but it is not necessary to disqualify the
688** optimization.
689**
690** Suppose the original OR phrase was this:
691**
692** a=4 OR a=11 OR a=b
693**
694** During analysis, the third term gets flipped around and duplicate
695** so that we are left with this:
696**
697** a=4 OR a=11 OR a=b OR b=a
698**
699** Since the last two terms are duplicates, only one of them
700** has to qualify in order for the whole phrase to qualify. When
701** this routine is called, we know that pOrTerm did not qualify.
702** This routine merely checks to see if pOrTerm has a duplicate that
703** might qualify. If there is a duplicate that has not yet been
704** disqualified, then return true. If there are no duplicates, or
drh909626d2008-05-30 14:58:37 +0000705** the duplicate has also been disqualified, return false.
drh3e355802007-02-23 23:13:33 +0000706*/
707static int orTermHasOkDuplicate(WhereClause *pOr, WhereTerm *pOrTerm){
drh165be382008-12-05 02:36:33 +0000708 if( pOrTerm->wtFlags & TERM_COPIED ){
drh3e355802007-02-23 23:13:33 +0000709 /* This is the original term. The duplicate is to the left had
710 ** has not yet been analyzed and thus has not yet been disqualified. */
711 return 1;
712 }
drh165be382008-12-05 02:36:33 +0000713 if( (pOrTerm->wtFlags & TERM_VIRTUAL)!=0
714 && (pOr->a[pOrTerm->iParent].wtFlags & TERM_OR_OK)!=0 ){
drh3e355802007-02-23 23:13:33 +0000715 /* This is a duplicate term. The original qualified so this one
716 ** does not have to. */
717 return 1;
718 }
719 /* This is either a singleton term or else it is a duplicate for
720 ** which the original did not qualify. Either way we are done for. */
721 return 0;
722}
723#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +0000724
725/*
drh0aa74ed2005-07-16 13:33:20 +0000726** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +0000727** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +0000728** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +0000729** structure.
drh51147ba2005-07-23 22:59:55 +0000730**
731** If the expression is of the form "<expr> <op> X" it gets commuted
732** to the standard form of "X <op> <expr>". If the expression is of
733** the form "X <op> Y" where both X and Y are columns, then the original
734** expression is unchanged and a new virtual expression of the form
drhb6fb62d2005-09-20 08:47:20 +0000735** "Y <op> X" is added to the WHERE clause and analyzed separately.
drh75897232000-05-29 14:26:00 +0000736*/
drh0fcef5e2005-07-19 17:38:22 +0000737static void exprAnalyze(
738 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +0000739 WhereClause *pWC, /* the WHERE clause */
740 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +0000741){
drhf998b732007-11-26 13:36:00 +0000742 WhereTerm *pTerm;
743 ExprMaskSet *pMaskSet;
744 Expr *pExpr;
drh0fcef5e2005-07-19 17:38:22 +0000745 Bitmask prereqLeft;
746 Bitmask prereqAll;
drhdafc0ce2008-04-17 19:14:02 +0000747 Bitmask extraRight = 0;
drhd2687b72005-08-12 22:56:09 +0000748 int nPattern;
749 int isComplete;
drh9f504ea2008-02-23 21:55:39 +0000750 int noCase;
drh50b39962006-10-28 00:28:09 +0000751 int op;
danielk19771e536952007-08-16 10:09:01 +0000752 Parse *pParse = pWC->pParse;
753 sqlite3 *db = pParse->db;
drh0fcef5e2005-07-19 17:38:22 +0000754
drhf998b732007-11-26 13:36:00 +0000755 if( db->mallocFailed ){
756 return;
757 }
758 pTerm = &pWC->a[idxTerm];
759 pMaskSet = pWC->pMaskSet;
760 pExpr = pTerm->pExpr;
drh0fcef5e2005-07-19 17:38:22 +0000761 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +0000762 op = pExpr->op;
763 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +0000764 assert( pExpr->pRight==0 );
765 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->pList)
766 | exprSelectTableUsage(pMaskSet, pExpr->pSelect);
drh50b39962006-10-28 00:28:09 +0000767 }else if( op==TK_ISNULL ){
768 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +0000769 }else{
770 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
771 }
drh22d6a532005-09-19 21:05:48 +0000772 prereqAll = exprTableUsage(pMaskSet, pExpr);
773 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +0000774 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
775 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +0000776 extraRight = x-1; /* ON clause terms may not be used with an index
777 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +0000778 }
779 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +0000780 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +0000781 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +0000782 pTerm->eOperator = 0;
drh50b39962006-10-28 00:28:09 +0000783 if( allowedOp(op) && (pTerm->prereqRight & prereqLeft)==0 ){
drh0fcef5e2005-07-19 17:38:22 +0000784 Expr *pLeft = pExpr->pLeft;
785 Expr *pRight = pExpr->pRight;
786 if( pLeft->op==TK_COLUMN ){
787 pTerm->leftCursor = pLeft->iTable;
788 pTerm->leftColumn = pLeft->iColumn;
drh50b39962006-10-28 00:28:09 +0000789 pTerm->eOperator = operatorMask(op);
drh75897232000-05-29 14:26:00 +0000790 }
drh0fcef5e2005-07-19 17:38:22 +0000791 if( pRight && pRight->op==TK_COLUMN ){
792 WhereTerm *pNew;
793 Expr *pDup;
794 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +0000795 int idxNew;
drh17435752007-08-16 04:30:38 +0000796 pDup = sqlite3ExprDup(db, pExpr);
797 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +0000798 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +0000799 return;
800 }
drh9eb20282005-08-24 03:52:18 +0000801 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
802 if( idxNew==0 ) return;
803 pNew = &pWC->a[idxNew];
804 pNew->iParent = idxTerm;
805 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +0000806 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +0000807 pTerm->wtFlags |= TERM_COPIED;
drh0fcef5e2005-07-19 17:38:22 +0000808 }else{
809 pDup = pExpr;
810 pNew = pTerm;
811 }
drh7d10d5a2008-08-20 16:35:10 +0000812 exprCommute(pParse, pDup);
drh0fcef5e2005-07-19 17:38:22 +0000813 pLeft = pDup->pLeft;
814 pNew->leftCursor = pLeft->iTable;
815 pNew->leftColumn = pLeft->iColumn;
816 pNew->prereqRight = prereqLeft;
817 pNew->prereqAll = prereqAll;
drhb52076c2006-01-23 13:22:09 +0000818 pNew->eOperator = operatorMask(pDup->op);
drh75897232000-05-29 14:26:00 +0000819 }
820 }
drhed378002005-07-28 23:12:08 +0000821
drhd2687b72005-08-12 22:56:09 +0000822#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +0000823 /* If a term is the BETWEEN operator, create two new virtual terms
824 ** that define the range that the BETWEEN implements.
825 */
826 else if( pExpr->op==TK_BETWEEN ){
827 ExprList *pList = pExpr->pList;
828 int i;
829 static const u8 ops[] = {TK_GE, TK_LE};
830 assert( pList!=0 );
831 assert( pList->nExpr==2 );
832 for(i=0; i<2; i++){
833 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +0000834 int idxNew;
danielk1977a1644fd2007-08-29 12:31:25 +0000835 pNewExpr = sqlite3Expr(db, ops[i], sqlite3ExprDup(db, pExpr->pLeft),
drh17435752007-08-16 04:30:38 +0000836 sqlite3ExprDup(db, pList->a[i].pExpr), 0);
drh9eb20282005-08-24 03:52:18 +0000837 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +0000838 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +0000839 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +0000840 pTerm = &pWC->a[idxTerm];
841 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +0000842 }
drh45b1ee42005-08-02 17:48:22 +0000843 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +0000844 }
drhd2687b72005-08-12 22:56:09 +0000845#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +0000846
danielk19771576cd92006-01-14 08:02:28 +0000847#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh6c30be82005-07-29 15:10:17 +0000848 /* Attempt to convert OR-connected terms into an IN operator so that
drhf5b11382005-09-17 13:07:13 +0000849 ** they can make use of indices. Example:
850 **
851 ** x = expr1 OR expr2 = x OR x = expr3
852 **
853 ** is converted into
854 **
855 ** x IN (expr1,expr2,expr3)
danielk19771576cd92006-01-14 08:02:28 +0000856 **
857 ** This optimization must be omitted if OMIT_SUBQUERY is defined because
858 ** the compiler for the the IN operator is part of sub-queries.
drh6c30be82005-07-29 15:10:17 +0000859 */
860 else if( pExpr->op==TK_OR ){
861 int ok;
862 int i, j;
863 int iColumn, iCursor;
864 WhereClause sOr;
865 WhereTerm *pOrTerm;
866
drh165be382008-12-05 02:36:33 +0000867 assert( (pTerm->wtFlags & TERM_DYNAMIC)==0 );
drh7b4fc6a2007-02-06 13:26:32 +0000868 whereClauseInit(&sOr, pWC->pParse, pMaskSet);
drh6c30be82005-07-29 15:10:17 +0000869 whereSplit(&sOr, pExpr, TK_OR);
drh7b4fc6a2007-02-06 13:26:32 +0000870 exprAnalyzeAll(pSrc, &sOr);
drh3e355802007-02-23 23:13:33 +0000871 assert( sOr.nTerm>=2 );
drh6c30be82005-07-29 15:10:17 +0000872 j = 0;
drha53b9142008-03-17 17:08:33 +0000873 if( db->mallocFailed ) goto or_not_possible;
drh6c30be82005-07-29 15:10:17 +0000874 do{
drh3e355802007-02-23 23:13:33 +0000875 assert( j<sOr.nTerm );
drh6c30be82005-07-29 15:10:17 +0000876 iColumn = sOr.a[j].leftColumn;
877 iCursor = sOr.a[j].leftCursor;
878 ok = iCursor>=0;
879 for(i=sOr.nTerm-1, pOrTerm=sOr.a; i>=0 && ok; i--, pOrTerm++){
drhb52076c2006-01-23 13:22:09 +0000880 if( pOrTerm->eOperator!=WO_EQ ){
drh6c30be82005-07-29 15:10:17 +0000881 goto or_not_possible;
882 }
drh3e355802007-02-23 23:13:33 +0000883 if( orTermIsOptCandidate(pOrTerm, iCursor, iColumn) ){
drh165be382008-12-05 02:36:33 +0000884 pOrTerm->wtFlags |= TERM_OR_OK;
drh3e355802007-02-23 23:13:33 +0000885 }else if( orTermHasOkDuplicate(&sOr, pOrTerm) ){
drh165be382008-12-05 02:36:33 +0000886 pOrTerm->wtFlags &= ~TERM_OR_OK;
drh6c30be82005-07-29 15:10:17 +0000887 }else{
888 ok = 0;
889 }
890 }
drh165be382008-12-05 02:36:33 +0000891 }while( !ok && (sOr.a[j++].wtFlags & TERM_COPIED)!=0 && j<2 );
drh6c30be82005-07-29 15:10:17 +0000892 if( ok ){
893 ExprList *pList = 0;
894 Expr *pNew, *pDup;
drh38276582006-11-06 15:10:05 +0000895 Expr *pLeft = 0;
drh22c24032008-07-09 13:28:53 +0000896 for(i=sOr.nTerm-1, pOrTerm=sOr.a; i>=0; i--, pOrTerm++){
drh165be382008-12-05 02:36:33 +0000897 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
drh17435752007-08-16 04:30:38 +0000898 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight);
899 pList = sqlite3ExprListAppend(pWC->pParse, pList, pDup, 0);
drh38276582006-11-06 15:10:05 +0000900 pLeft = pOrTerm->pExpr->pLeft;
drh6c30be82005-07-29 15:10:17 +0000901 }
drh38276582006-11-06 15:10:05 +0000902 assert( pLeft!=0 );
drh17435752007-08-16 04:30:38 +0000903 pDup = sqlite3ExprDup(db, pLeft);
danielk1977a1644fd2007-08-29 12:31:25 +0000904 pNew = sqlite3Expr(db, TK_IN, pDup, 0, 0);
drh53f733c2005-09-16 02:38:09 +0000905 if( pNew ){
drh9a5f7472005-11-26 14:24:40 +0000906 int idxNew;
drh54a167d2005-11-26 14:08:07 +0000907 transferJoinMarkings(pNew, pExpr);
drh53f733c2005-09-16 02:38:09 +0000908 pNew->pList = pList;
drh9a5f7472005-11-26 14:24:40 +0000909 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +0000910 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +0000911 exprAnalyze(pSrc, pWC, idxNew);
drh9a5f7472005-11-26 14:24:40 +0000912 pTerm = &pWC->a[idxTerm];
913 pWC->a[idxNew].iParent = idxTerm;
914 pTerm->nChild = 1;
drh53f733c2005-09-16 02:38:09 +0000915 }else{
drh633e6d52008-07-28 19:34:53 +0000916 sqlite3ExprListDelete(db, pList);
drh53f733c2005-09-16 02:38:09 +0000917 }
drh6c30be82005-07-29 15:10:17 +0000918 }
919or_not_possible:
920 whereClauseClear(&sOr);
921 }
drhd2687b72005-08-12 22:56:09 +0000922#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
923
924#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
925 /* Add constraints to reduce the search space on a LIKE or GLOB
926 ** operator.
drh9f504ea2008-02-23 21:55:39 +0000927 **
928 ** A like pattern of the form "x LIKE 'abc%'" is changed into constraints
929 **
930 ** x>='abc' AND x<'abd' AND x LIKE 'abc%'
931 **
932 ** The last character of the prefix "abc" is incremented to form the
shane7bc71e52008-05-28 18:01:44 +0000933 ** termination condition "abd".
drhd2687b72005-08-12 22:56:09 +0000934 */
drh7d10d5a2008-08-20 16:35:10 +0000935 if( isLikeOrGlob(pParse, pExpr, &nPattern, &isComplete, &noCase) ){
drhd2687b72005-08-12 22:56:09 +0000936 Expr *pLeft, *pRight;
937 Expr *pStr1, *pStr2;
938 Expr *pNewExpr1, *pNewExpr2;
drh9eb20282005-08-24 03:52:18 +0000939 int idxNew1, idxNew2;
940
drhd2687b72005-08-12 22:56:09 +0000941 pLeft = pExpr->pList->a[1].pExpr;
942 pRight = pExpr->pList->a[0].pExpr;
drh17435752007-08-16 04:30:38 +0000943 pStr1 = sqlite3PExpr(pParse, TK_STRING, 0, 0, 0);
drhd2687b72005-08-12 22:56:09 +0000944 if( pStr1 ){
drh17435752007-08-16 04:30:38 +0000945 sqlite3TokenCopy(db, &pStr1->token, &pRight->token);
drhd2687b72005-08-12 22:56:09 +0000946 pStr1->token.n = nPattern;
drh9c86df52007-06-11 12:56:15 +0000947 pStr1->flags = EP_Dequoted;
drhd2687b72005-08-12 22:56:09 +0000948 }
drh17435752007-08-16 04:30:38 +0000949 pStr2 = sqlite3ExprDup(db, pStr1);
drhf998b732007-11-26 13:36:00 +0000950 if( !db->mallocFailed ){
drh9f504ea2008-02-23 21:55:39 +0000951 u8 c, *pC;
drhd2687b72005-08-12 22:56:09 +0000952 assert( pStr2->token.dyn );
drh9f504ea2008-02-23 21:55:39 +0000953 pC = (u8*)&pStr2->token.z[nPattern-1];
954 c = *pC;
drh02a50b72008-05-26 18:33:40 +0000955 if( noCase ){
956 if( c=='@' ) isComplete = 0;
957 c = sqlite3UpperToLower[c];
958 }
drh9f504ea2008-02-23 21:55:39 +0000959 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +0000960 }
drh17435752007-08-16 04:30:38 +0000961 pNewExpr1 = sqlite3PExpr(pParse, TK_GE, sqlite3ExprDup(db,pLeft), pStr1, 0);
drh9eb20282005-08-24 03:52:18 +0000962 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +0000963 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +0000964 exprAnalyze(pSrc, pWC, idxNew1);
drh17435752007-08-16 04:30:38 +0000965 pNewExpr2 = sqlite3PExpr(pParse, TK_LT, sqlite3ExprDup(db,pLeft), pStr2, 0);
drh9eb20282005-08-24 03:52:18 +0000966 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +0000967 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +0000968 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +0000969 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +0000970 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +0000971 pWC->a[idxNew1].iParent = idxTerm;
972 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +0000973 pTerm->nChild = 2;
974 }
975 }
976#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +0000977
978#ifndef SQLITE_OMIT_VIRTUALTABLE
979 /* Add a WO_MATCH auxiliary term to the constraint set if the
980 ** current expression is of the form: column MATCH expr.
981 ** This information is used by the xBestIndex methods of
982 ** virtual tables. The native query optimizer does not attempt
983 ** to do anything with MATCH functions.
984 */
985 if( isMatchOfColumn(pExpr) ){
986 int idxNew;
987 Expr *pRight, *pLeft;
988 WhereTerm *pNewTerm;
989 Bitmask prereqColumn, prereqExpr;
990
991 pRight = pExpr->pList->a[0].pExpr;
992 pLeft = pExpr->pList->a[1].pExpr;
993 prereqExpr = exprTableUsage(pMaskSet, pRight);
994 prereqColumn = exprTableUsage(pMaskSet, pLeft);
995 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +0000996 Expr *pNewExpr;
danielk1977a1644fd2007-08-29 12:31:25 +0000997 pNewExpr = sqlite3Expr(db, TK_MATCH, 0, sqlite3ExprDup(db, pRight), 0);
drh1a90e092006-06-14 22:07:10 +0000998 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +0000999 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001000 pNewTerm = &pWC->a[idxNew];
1001 pNewTerm->prereqRight = prereqExpr;
1002 pNewTerm->leftCursor = pLeft->iTable;
1003 pNewTerm->leftColumn = pLeft->iColumn;
1004 pNewTerm->eOperator = WO_MATCH;
1005 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +00001006 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +00001007 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001008 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001009 pNewTerm->prereqAll = pTerm->prereqAll;
1010 }
1011 }
1012#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001013
1014 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1015 ** an index for tables to the left of the join.
1016 */
1017 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001018}
1019
drh7b4fc6a2007-02-06 13:26:32 +00001020/*
1021** Return TRUE if any of the expressions in pList->a[iFirst...] contain
1022** a reference to any table other than the iBase table.
1023*/
1024static int referencesOtherTables(
1025 ExprList *pList, /* Search expressions in ths list */
1026 ExprMaskSet *pMaskSet, /* Mapping from tables to bitmaps */
1027 int iFirst, /* Be searching with the iFirst-th expression */
1028 int iBase /* Ignore references to this table */
1029){
1030 Bitmask allowed = ~getMask(pMaskSet, iBase);
1031 while( iFirst<pList->nExpr ){
1032 if( (exprTableUsage(pMaskSet, pList->a[iFirst++].pExpr)&allowed)!=0 ){
1033 return 1;
1034 }
1035 }
1036 return 0;
1037}
1038
drh0fcef5e2005-07-19 17:38:22 +00001039
drh75897232000-05-29 14:26:00 +00001040/*
drh51669862004-12-18 18:40:26 +00001041** This routine decides if pIdx can be used to satisfy the ORDER BY
1042** clause. If it can, it returns 1. If pIdx cannot satisfy the
1043** ORDER BY clause, this routine returns 0.
1044**
1045** pOrderBy is an ORDER BY clause from a SELECT statement. pTab is the
1046** left-most table in the FROM clause of that same SELECT statement and
1047** the table has a cursor number of "base". pIdx is an index on pTab.
1048**
1049** nEqCol is the number of columns of pIdx that are used as equality
1050** constraints. Any of these columns may be missing from the ORDER BY
1051** clause and the match can still be a success.
1052**
drh51669862004-12-18 18:40:26 +00001053** All terms of the ORDER BY that match against the index must be either
1054** ASC or DESC. (Terms of the ORDER BY clause past the end of a UNIQUE
1055** index do not need to satisfy this constraint.) The *pbRev value is
1056** set to 1 if the ORDER BY clause is all DESC and it is set to 0 if
1057** the ORDER BY clause is all ASC.
1058*/
1059static int isSortingIndex(
1060 Parse *pParse, /* Parsing context */
drh7b4fc6a2007-02-06 13:26:32 +00001061 ExprMaskSet *pMaskSet, /* Mapping from table indices to bitmaps */
drh51669862004-12-18 18:40:26 +00001062 Index *pIdx, /* The index we are testing */
drh74161702006-02-24 02:53:49 +00001063 int base, /* Cursor number for the table to be sorted */
drh51669862004-12-18 18:40:26 +00001064 ExprList *pOrderBy, /* The ORDER BY clause */
1065 int nEqCol, /* Number of index columns with == constraints */
1066 int *pbRev /* Set to 1 if ORDER BY is DESC */
1067){
drhb46b5772005-08-29 16:40:52 +00001068 int i, j; /* Loop counters */
drh85eeb692005-12-21 03:16:42 +00001069 int sortOrder = 0; /* XOR of index and ORDER BY sort direction */
drhb46b5772005-08-29 16:40:52 +00001070 int nTerm; /* Number of ORDER BY terms */
1071 struct ExprList_item *pTerm; /* A term of the ORDER BY clause */
drh51669862004-12-18 18:40:26 +00001072 sqlite3 *db = pParse->db;
1073
1074 assert( pOrderBy!=0 );
1075 nTerm = pOrderBy->nExpr;
1076 assert( nTerm>0 );
1077
1078 /* Match terms of the ORDER BY clause against columns of
1079 ** the index.
drhcc192542006-12-20 03:24:19 +00001080 **
1081 ** Note that indices have pIdx->nColumn regular columns plus
1082 ** one additional column containing the rowid. The rowid column
1083 ** of the index is also allowed to match against the ORDER BY
1084 ** clause.
drh51669862004-12-18 18:40:26 +00001085 */
drhcc192542006-12-20 03:24:19 +00001086 for(i=j=0, pTerm=pOrderBy->a; j<nTerm && i<=pIdx->nColumn; i++){
drh51669862004-12-18 18:40:26 +00001087 Expr *pExpr; /* The expression of the ORDER BY pTerm */
1088 CollSeq *pColl; /* The collating sequence of pExpr */
drh85eeb692005-12-21 03:16:42 +00001089 int termSortOrder; /* Sort order for this term */
drhcc192542006-12-20 03:24:19 +00001090 int iColumn; /* The i-th column of the index. -1 for rowid */
1091 int iSortOrder; /* 1 for DESC, 0 for ASC on the i-th index term */
1092 const char *zColl; /* Name of the collating sequence for i-th index term */
drh51669862004-12-18 18:40:26 +00001093
1094 pExpr = pTerm->pExpr;
1095 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=base ){
1096 /* Can not use an index sort on anything that is not a column in the
1097 ** left-most table of the FROM clause */
drh7b4fc6a2007-02-06 13:26:32 +00001098 break;
drh51669862004-12-18 18:40:26 +00001099 }
1100 pColl = sqlite3ExprCollSeq(pParse, pExpr);
drhcc192542006-12-20 03:24:19 +00001101 if( !pColl ){
1102 pColl = db->pDfltColl;
1103 }
1104 if( i<pIdx->nColumn ){
1105 iColumn = pIdx->aiColumn[i];
1106 if( iColumn==pIdx->pTable->iPKey ){
1107 iColumn = -1;
1108 }
1109 iSortOrder = pIdx->aSortOrder[i];
1110 zColl = pIdx->azColl[i];
1111 }else{
1112 iColumn = -1;
1113 iSortOrder = 0;
1114 zColl = pColl->zName;
1115 }
1116 if( pExpr->iColumn!=iColumn || sqlite3StrICmp(pColl->zName, zColl) ){
drh9012bcb2004-12-19 00:11:35 +00001117 /* Term j of the ORDER BY clause does not match column i of the index */
1118 if( i<nEqCol ){
drh51669862004-12-18 18:40:26 +00001119 /* If an index column that is constrained by == fails to match an
1120 ** ORDER BY term, that is OK. Just ignore that column of the index
1121 */
1122 continue;
drhff354e92008-06-25 02:47:57 +00001123 }else if( i==pIdx->nColumn ){
1124 /* Index column i is the rowid. All other terms match. */
1125 break;
drh51669862004-12-18 18:40:26 +00001126 }else{
1127 /* If an index column fails to match and is not constrained by ==
1128 ** then the index cannot satisfy the ORDER BY constraint.
1129 */
1130 return 0;
1131 }
1132 }
danielk1977b3bf5562006-01-10 17:58:23 +00001133 assert( pIdx->aSortOrder!=0 );
drh85eeb692005-12-21 03:16:42 +00001134 assert( pTerm->sortOrder==0 || pTerm->sortOrder==1 );
drhcc192542006-12-20 03:24:19 +00001135 assert( iSortOrder==0 || iSortOrder==1 );
1136 termSortOrder = iSortOrder ^ pTerm->sortOrder;
drh51669862004-12-18 18:40:26 +00001137 if( i>nEqCol ){
drh85eeb692005-12-21 03:16:42 +00001138 if( termSortOrder!=sortOrder ){
drh51669862004-12-18 18:40:26 +00001139 /* Indices can only be used if all ORDER BY terms past the
1140 ** equality constraints are all either DESC or ASC. */
1141 return 0;
1142 }
1143 }else{
drh85eeb692005-12-21 03:16:42 +00001144 sortOrder = termSortOrder;
drh51669862004-12-18 18:40:26 +00001145 }
1146 j++;
1147 pTerm++;
drh7b4fc6a2007-02-06 13:26:32 +00001148 if( iColumn<0 && !referencesOtherTables(pOrderBy, pMaskSet, j, base) ){
drhcc192542006-12-20 03:24:19 +00001149 /* If the indexed column is the primary key and everything matches
drh7b4fc6a2007-02-06 13:26:32 +00001150 ** so far and none of the ORDER BY terms to the right reference other
1151 ** tables in the join, then we are assured that the index can be used
1152 ** to sort because the primary key is unique and so none of the other
1153 ** columns will make any difference
drhcc192542006-12-20 03:24:19 +00001154 */
1155 j = nTerm;
1156 }
drh51669862004-12-18 18:40:26 +00001157 }
1158
drhcc192542006-12-20 03:24:19 +00001159 *pbRev = sortOrder!=0;
drh8718f522005-08-13 16:13:04 +00001160 if( j>=nTerm ){
drhcc192542006-12-20 03:24:19 +00001161 /* All terms of the ORDER BY clause are covered by this index so
1162 ** this index can be used for sorting. */
1163 return 1;
1164 }
drh7b4fc6a2007-02-06 13:26:32 +00001165 if( pIdx->onError!=OE_None && i==pIdx->nColumn
1166 && !referencesOtherTables(pOrderBy, pMaskSet, j, base) ){
drhcc192542006-12-20 03:24:19 +00001167 /* All terms of this index match some prefix of the ORDER BY clause
drh7b4fc6a2007-02-06 13:26:32 +00001168 ** and the index is UNIQUE and no terms on the tail of the ORDER BY
1169 ** clause reference other tables in a join. If this is all true then
1170 ** the order by clause is superfluous. */
drh51669862004-12-18 18:40:26 +00001171 return 1;
1172 }
1173 return 0;
1174}
1175
1176/*
drhb6c29892004-11-22 19:12:19 +00001177** Check table to see if the ORDER BY clause in pOrderBy can be satisfied
1178** by sorting in order of ROWID. Return true if so and set *pbRev to be
1179** true for reverse ROWID and false for forward ROWID order.
1180*/
1181static int sortableByRowid(
1182 int base, /* Cursor number for table to be sorted */
1183 ExprList *pOrderBy, /* The ORDER BY clause */
drh7b4fc6a2007-02-06 13:26:32 +00001184 ExprMaskSet *pMaskSet, /* Mapping from tables to bitmaps */
drhb6c29892004-11-22 19:12:19 +00001185 int *pbRev /* Set to 1 if ORDER BY is DESC */
1186){
1187 Expr *p;
1188
1189 assert( pOrderBy!=0 );
1190 assert( pOrderBy->nExpr>0 );
1191 p = pOrderBy->a[0].pExpr;
drh7b4fc6a2007-02-06 13:26:32 +00001192 if( p->op==TK_COLUMN && p->iTable==base && p->iColumn==-1
1193 && !referencesOtherTables(pOrderBy, pMaskSet, 1, base) ){
drhb6c29892004-11-22 19:12:19 +00001194 *pbRev = pOrderBy->a[0].sortOrder;
1195 return 1;
1196 }
1197 return 0;
1198}
1199
drhfe05af82005-07-21 03:14:59 +00001200/*
drhb6fb62d2005-09-20 08:47:20 +00001201** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +00001202** The results need not be exact. This is only used for estimating
drh909626d2008-05-30 14:58:37 +00001203** the total cost of performing operations with O(logN) or O(NlogN)
drh28c4cf42005-07-27 20:41:43 +00001204** complexity. Because N is just a guess, it is no great tragedy if
1205** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +00001206*/
1207static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +00001208 double logN = 1;
1209 double x = 10;
drh28c4cf42005-07-27 20:41:43 +00001210 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +00001211 logN += 1;
drh28c4cf42005-07-27 20:41:43 +00001212 x *= 10;
1213 }
1214 return logN;
1215}
1216
drh6d209d82006-06-27 01:54:26 +00001217/*
1218** Two routines for printing the content of an sqlite3_index_info
1219** structure. Used for testing and debugging only. If neither
1220** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1221** are no-ops.
1222*/
drh77a2a5e2007-04-06 01:04:39 +00001223#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_DEBUG)
drh6d209d82006-06-27 01:54:26 +00001224static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1225 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001226 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001227 for(i=0; i<p->nConstraint; i++){
1228 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1229 i,
1230 p->aConstraint[i].iColumn,
1231 p->aConstraint[i].iTermOffset,
1232 p->aConstraint[i].op,
1233 p->aConstraint[i].usable);
1234 }
1235 for(i=0; i<p->nOrderBy; i++){
1236 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1237 i,
1238 p->aOrderBy[i].iColumn,
1239 p->aOrderBy[i].desc);
1240 }
1241}
1242static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1243 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001244 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001245 for(i=0; i<p->nConstraint; i++){
1246 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1247 i,
1248 p->aConstraintUsage[i].argvIndex,
1249 p->aConstraintUsage[i].omit);
1250 }
1251 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1252 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1253 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1254 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
1255}
1256#else
1257#define TRACE_IDX_INPUTS(A)
1258#define TRACE_IDX_OUTPUTS(A)
1259#endif
1260
drh9eff6162006-06-12 21:59:13 +00001261#ifndef SQLITE_OMIT_VIRTUALTABLE
1262/*
drh7f375902006-06-13 17:38:59 +00001263** Compute the best index for a virtual table.
1264**
1265** The best index is computed by the xBestIndex method of the virtual
1266** table module. This routine is really just a wrapper that sets up
1267** the sqlite3_index_info structure that is used to communicate with
1268** xBestIndex.
1269**
1270** In a join, this routine might be called multiple times for the
1271** same virtual table. The sqlite3_index_info structure is created
1272** and initialized on the first invocation and reused on all subsequent
1273** invocations. The sqlite3_index_info structure is also used when
1274** code is generated to access the virtual table. The whereInfoDelete()
1275** routine takes care of freeing the sqlite3_index_info structure after
1276** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00001277*/
1278static double bestVirtualIndex(
1279 Parse *pParse, /* The parsing context */
1280 WhereClause *pWC, /* The WHERE clause */
1281 struct SrcList_item *pSrc, /* The FROM clause term to search */
1282 Bitmask notReady, /* Mask of cursors that are not available */
1283 ExprList *pOrderBy, /* The order by clause */
1284 int orderByUsable, /* True if we can potential sort */
1285 sqlite3_index_info **ppIdxInfo /* Index information passed to xBestIndex */
1286){
1287 Table *pTab = pSrc->pTab;
danielk19773e3a84d2008-08-01 17:37:40 +00001288 sqlite3_vtab *pVtab = pTab->pVtab;
drh9eff6162006-06-12 21:59:13 +00001289 sqlite3_index_info *pIdxInfo;
1290 struct sqlite3_index_constraint *pIdxCons;
1291 struct sqlite3_index_orderby *pIdxOrderBy;
1292 struct sqlite3_index_constraint_usage *pUsage;
1293 WhereTerm *pTerm;
1294 int i, j;
1295 int nOrderBy;
danielk197774cdba42006-06-19 12:02:58 +00001296 int rc;
drh9eff6162006-06-12 21:59:13 +00001297
1298 /* If the sqlite3_index_info structure has not been previously
1299 ** allocated and initialized for this virtual table, then allocate
1300 ** and initialize it now
1301 */
1302 pIdxInfo = *ppIdxInfo;
1303 if( pIdxInfo==0 ){
drh9eff6162006-06-12 21:59:13 +00001304 int nTerm;
drh4f0c5872007-03-26 22:05:01 +00001305 WHERETRACE(("Recomputing index info for %s...\n", pTab->zName));
drh9eff6162006-06-12 21:59:13 +00001306
1307 /* Count the number of possible WHERE clause constraints referring
1308 ** to this virtual table */
1309 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1310 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh4d9f9e62008-08-25 12:08:22 +00001311 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
drh981642f2008-04-19 14:40:43 +00001312 testcase( pTerm->eOperator==WO_IN );
1313 testcase( pTerm->eOperator==WO_ISNULL );
1314 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drh9eff6162006-06-12 21:59:13 +00001315 nTerm++;
1316 }
1317
1318 /* If the ORDER BY clause contains only columns in the current
1319 ** virtual table then allocate space for the aOrderBy part of
1320 ** the sqlite3_index_info structure.
1321 */
1322 nOrderBy = 0;
1323 if( pOrderBy ){
1324 for(i=0; i<pOrderBy->nExpr; i++){
1325 Expr *pExpr = pOrderBy->a[i].pExpr;
1326 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
1327 }
1328 if( i==pOrderBy->nExpr ){
1329 nOrderBy = pOrderBy->nExpr;
1330 }
1331 }
1332
1333 /* Allocate the sqlite3_index_info structure
1334 */
danielk197726783a52007-08-29 14:06:22 +00001335 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
drh9eff6162006-06-12 21:59:13 +00001336 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
1337 + sizeof(*pIdxOrderBy)*nOrderBy );
1338 if( pIdxInfo==0 ){
1339 sqlite3ErrorMsg(pParse, "out of memory");
1340 return 0.0;
1341 }
1342 *ppIdxInfo = pIdxInfo;
1343
1344 /* Initialize the structure. The sqlite3_index_info structure contains
1345 ** many fields that are declared "const" to prevent xBestIndex from
1346 ** changing them. We have to do some funky casting in order to
1347 ** initialize those fields.
1348 */
1349 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
1350 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
1351 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
1352 *(int*)&pIdxInfo->nConstraint = nTerm;
1353 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
1354 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
1355 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
1356 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
1357 pUsage;
1358
1359 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1360 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh4d9f9e62008-08-25 12:08:22 +00001361 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
drh981642f2008-04-19 14:40:43 +00001362 testcase( pTerm->eOperator==WO_IN );
1363 testcase( pTerm->eOperator==WO_ISNULL );
1364 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drh9eff6162006-06-12 21:59:13 +00001365 pIdxCons[j].iColumn = pTerm->leftColumn;
1366 pIdxCons[j].iTermOffset = i;
drhec1724e2008-12-09 01:32:03 +00001367 pIdxCons[j].op = (u8)pTerm->eOperator;
drh7f375902006-06-13 17:38:59 +00001368 /* The direct assignment in the previous line is possible only because
1369 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
1370 ** following asserts verify this fact. */
drh9eff6162006-06-12 21:59:13 +00001371 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
1372 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
1373 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
1374 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
1375 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
drh7f375902006-06-13 17:38:59 +00001376 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
1377 assert( pTerm->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
drh9eff6162006-06-12 21:59:13 +00001378 j++;
1379 }
1380 for(i=0; i<nOrderBy; i++){
1381 Expr *pExpr = pOrderBy->a[i].pExpr;
1382 pIdxOrderBy[i].iColumn = pExpr->iColumn;
1383 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
1384 }
1385 }
1386
drh7f375902006-06-13 17:38:59 +00001387 /* At this point, the sqlite3_index_info structure that pIdxInfo points
1388 ** to will have been initialized, either during the current invocation or
1389 ** during some prior invocation. Now we just have to customize the
1390 ** details of pIdxInfo for the current invocation and pass it to
1391 ** xBestIndex.
1392 */
1393
danielk1977935ed5e2007-03-30 09:13:13 +00001394 /* The module name must be defined. Also, by this point there must
1395 ** be a pointer to an sqlite3_vtab structure. Otherwise
1396 ** sqlite3ViewGetColumnNames() would have picked up the error.
1397 */
drh9eff6162006-06-12 21:59:13 +00001398 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
danielk19773e3a84d2008-08-01 17:37:40 +00001399 assert( pVtab );
danielk1977935ed5e2007-03-30 09:13:13 +00001400#if 0
drh9eff6162006-06-12 21:59:13 +00001401 if( pTab->pVtab==0 ){
1402 sqlite3ErrorMsg(pParse, "undefined module %s for table %s",
1403 pTab->azModuleArg[0], pTab->zName);
1404 return 0.0;
1405 }
danielk1977935ed5e2007-03-30 09:13:13 +00001406#endif
drh9eff6162006-06-12 21:59:13 +00001407
1408 /* Set the aConstraint[].usable fields and initialize all
drh7f375902006-06-13 17:38:59 +00001409 ** output variables to zero.
1410 **
1411 ** aConstraint[].usable is true for constraints where the right-hand
1412 ** side contains only references to tables to the left of the current
1413 ** table. In other words, if the constraint is of the form:
1414 **
1415 ** column = expr
1416 **
1417 ** and we are evaluating a join, then the constraint on column is
1418 ** only valid if all tables referenced in expr occur to the left
1419 ** of the table containing column.
1420 **
1421 ** The aConstraints[] array contains entries for all constraints
1422 ** on the current table. That way we only have to compute it once
1423 ** even though we might try to pick the best index multiple times.
1424 ** For each attempt at picking an index, the order of tables in the
1425 ** join might be different so we have to recompute the usable flag
1426 ** each time.
drh9eff6162006-06-12 21:59:13 +00001427 */
1428 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
1429 pUsage = pIdxInfo->aConstraintUsage;
1430 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
1431 j = pIdxCons->iTermOffset;
1432 pTerm = &pWC->a[j];
drhec1724e2008-12-09 01:32:03 +00001433 pIdxCons->usable = (pTerm->prereqRight & notReady)==0 ?1:0;
drh9eff6162006-06-12 21:59:13 +00001434 }
1435 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
drh4be8b512006-06-13 23:51:34 +00001436 if( pIdxInfo->needToFreeIdxStr ){
1437 sqlite3_free(pIdxInfo->idxStr);
1438 }
1439 pIdxInfo->idxStr = 0;
1440 pIdxInfo->idxNum = 0;
1441 pIdxInfo->needToFreeIdxStr = 0;
drh9eff6162006-06-12 21:59:13 +00001442 pIdxInfo->orderByConsumed = 0;
danielk197793626f42006-06-20 13:07:27 +00001443 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / 2.0;
drh9eff6162006-06-12 21:59:13 +00001444 nOrderBy = pIdxInfo->nOrderBy;
1445 if( pIdxInfo->nOrderBy && !orderByUsable ){
drha967e882006-06-13 01:04:52 +00001446 *(int*)&pIdxInfo->nOrderBy = 0;
drh9eff6162006-06-12 21:59:13 +00001447 }
danielk197774cdba42006-06-19 12:02:58 +00001448
drh7e8b8482008-01-23 03:03:05 +00001449 (void)sqlite3SafetyOff(pParse->db);
drh4f0c5872007-03-26 22:05:01 +00001450 WHERETRACE(("xBestIndex for %s\n", pTab->zName));
drh6d209d82006-06-27 01:54:26 +00001451 TRACE_IDX_INPUTS(pIdxInfo);
danielk19773e3a84d2008-08-01 17:37:40 +00001452 rc = pVtab->pModule->xBestIndex(pVtab, pIdxInfo);
drh6d209d82006-06-27 01:54:26 +00001453 TRACE_IDX_OUTPUTS(pIdxInfo);
danielk197739359dc2008-03-17 09:36:44 +00001454 (void)sqlite3SafetyOn(pParse->db);
1455
danielk19773e3a84d2008-08-01 17:37:40 +00001456 if( rc!=SQLITE_OK ){
1457 if( rc==SQLITE_NOMEM ){
1458 pParse->db->mallocFailed = 1;
1459 }else if( !pVtab->zErrMsg ){
1460 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
1461 }else{
1462 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
1463 }
1464 }
1465 sqlite3DbFree(pParse->db, pVtab->zErrMsg);
1466 pVtab->zErrMsg = 0;
1467
danielk197739359dc2008-03-17 09:36:44 +00001468 for(i=0; i<pIdxInfo->nConstraint; i++){
1469 if( !pIdxInfo->aConstraint[i].usable && pUsage[i].argvIndex>0 ){
1470 sqlite3ErrorMsg(pParse,
1471 "table %s: xBestIndex returned an invalid plan", pTab->zName);
1472 return 0.0;
1473 }
1474 }
1475
drha967e882006-06-13 01:04:52 +00001476 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
drh9eff6162006-06-12 21:59:13 +00001477 return pIdxInfo->estimatedCost;
1478}
1479#endif /* SQLITE_OMIT_VIRTUALTABLE */
1480
drh28c4cf42005-07-27 20:41:43 +00001481/*
drh51147ba2005-07-23 22:59:55 +00001482** Find the best index for accessing a particular table. Return a pointer
1483** to the index, flags that describe how the index should be used, the
drha6110402005-07-28 20:51:19 +00001484** number of equality constraints, and the "cost" for this index.
drh51147ba2005-07-23 22:59:55 +00001485**
1486** The lowest cost index wins. The cost is an estimate of the amount of
1487** CPU and disk I/O need to process the request using the selected index.
1488** Factors that influence cost include:
1489**
1490** * The estimated number of rows that will be retrieved. (The
1491** fewer the better.)
1492**
1493** * Whether or not sorting must occur.
1494**
1495** * Whether or not there must be separate lookups in the
1496** index and in the main table.
1497**
danielk197785574e32008-10-06 05:32:18 +00001498** If there was an INDEXED BY clause attached to the table in the SELECT
1499** statement, then this function only considers strategies using the
1500** named index. If one cannot be found, then the returned cost is
1501** SQLITE_BIG_DBL. If a strategy can be found that uses the named index,
1502** then the cost is calculated in the usual way.
1503**
1504** If a NOT INDEXED clause was attached to the table in the SELECT
1505** statement, then no indexes are considered. However, the selected
1506** stategy may still take advantage of the tables built-in rowid
1507** index.
drhfe05af82005-07-21 03:14:59 +00001508*/
1509static double bestIndex(
1510 Parse *pParse, /* The parsing context */
1511 WhereClause *pWC, /* The WHERE clause */
1512 struct SrcList_item *pSrc, /* The FROM clause term to search */
1513 Bitmask notReady, /* Mask of cursors that are not available */
1514 ExprList *pOrderBy, /* The order by clause */
1515 Index **ppIndex, /* Make *ppIndex point to the best index */
drh165be382008-12-05 02:36:33 +00001516 int *pWsFlags, /* Put wsFlags describing scan strategy here */
drh51147ba2005-07-23 22:59:55 +00001517 int *pnEq /* Put the number of == or IN constraints here */
drhfe05af82005-07-21 03:14:59 +00001518){
1519 WhereTerm *pTerm;
drh51147ba2005-07-23 22:59:55 +00001520 Index *bestIdx = 0; /* Index that gives the lowest cost */
drhb37df7b2005-10-13 02:09:49 +00001521 double lowestCost; /* The cost of using bestIdx */
drh165be382008-12-05 02:36:33 +00001522 int bestWsFlags = 0; /* Flags associated with bestIdx */
drh51147ba2005-07-23 22:59:55 +00001523 int bestNEq = 0; /* Best value for nEq */
1524 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
1525 Index *pProbe; /* An index we are evaluating */
1526 int rev; /* True to scan in reverse order */
drh165be382008-12-05 02:36:33 +00001527 int wsFlags; /* Flags associated with pProbe */
drh51147ba2005-07-23 22:59:55 +00001528 int nEq; /* Number of == or IN constraints */
drhc49de5d2007-01-19 01:06:01 +00001529 int eqTermMask; /* Mask of valid equality operators */
drh51147ba2005-07-23 22:59:55 +00001530 double cost; /* Cost of using pProbe */
drhfe05af82005-07-21 03:14:59 +00001531
drh165be382008-12-05 02:36:33 +00001532 WHERETRACE(("bestIndex: tbl=%s notReady=%llx\n", pSrc->pTab->zName,notReady));
drhb37df7b2005-10-13 02:09:49 +00001533 lowestCost = SQLITE_BIG_DBL;
drh4dd238a2006-03-28 23:55:57 +00001534 pProbe = pSrc->pTab->pIndex;
danielk197785574e32008-10-06 05:32:18 +00001535 if( pSrc->notIndexed ){
1536 pProbe = 0;
1537 }
drh4dd238a2006-03-28 23:55:57 +00001538
1539 /* If the table has no indices and there are no terms in the where
1540 ** clause that refer to the ROWID, then we will never be able to do
1541 ** anything other than a full table scan on this table. We might as
1542 ** well put it first in the join order. That way, perhaps it can be
1543 ** referenced by other tables in the join.
1544 */
1545 if( pProbe==0 &&
1546 findTerm(pWC, iCur, -1, 0, WO_EQ|WO_IN|WO_LT|WO_LE|WO_GT|WO_GE,0)==0 &&
drh7b4fc6a2007-02-06 13:26:32 +00001547 (pOrderBy==0 || !sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev)) ){
drh165be382008-12-05 02:36:33 +00001548 *pWsFlags = 0;
drh4dd238a2006-03-28 23:55:57 +00001549 *ppIndex = 0;
1550 *pnEq = 0;
1551 return 0.0;
1552 }
drh51147ba2005-07-23 22:59:55 +00001553
danielk197785574e32008-10-06 05:32:18 +00001554 /* Check for a rowid=EXPR or rowid IN (...) constraints. If there was
1555 ** an INDEXED BY clause attached to this table, skip this step.
drhfe05af82005-07-21 03:14:59 +00001556 */
danielk197785574e32008-10-06 05:32:18 +00001557 if( !pSrc->pIndex ){
1558 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
1559 if( pTerm ){
1560 Expr *pExpr;
1561 *ppIndex = 0;
drh165be382008-12-05 02:36:33 +00001562 bestWsFlags = WHERE_ROWID_EQ;
danielk197785574e32008-10-06 05:32:18 +00001563 if( pTerm->eOperator & WO_EQ ){
1564 /* Rowid== is always the best pick. Look no further. Because only
1565 ** a single row is generated, output is always in sorted order */
drh165be382008-12-05 02:36:33 +00001566 *pWsFlags = WHERE_ROWID_EQ | WHERE_UNIQUE;
danielk197785574e32008-10-06 05:32:18 +00001567 *pnEq = 1;
1568 WHERETRACE(("... best is rowid\n"));
1569 return 0.0;
1570 }else if( (pExpr = pTerm->pExpr)->pList!=0 ){
1571 /* Rowid IN (LIST): cost is NlogN where N is the number of list
1572 ** elements. */
1573 lowestCost = pExpr->pList->nExpr;
1574 lowestCost *= estLog(lowestCost);
1575 }else{
1576 /* Rowid IN (SELECT): cost is NlogN where N is the number of rows
1577 ** in the result of the inner select. We have no way to estimate
1578 ** that value so make a wild guess. */
1579 lowestCost = 200;
drh28c4cf42005-07-27 20:41:43 +00001580 }
danielk197785574e32008-10-06 05:32:18 +00001581 WHERETRACE(("... rowid IN cost: %.9g\n", lowestCost));
drh51147ba2005-07-23 22:59:55 +00001582 }
danielk197785574e32008-10-06 05:32:18 +00001583
1584 /* Estimate the cost of a table scan. If we do not know how many
1585 ** entries are in the table, use 1 million as a guess.
1586 */
1587 cost = pProbe ? pProbe->aiRowEst[0] : 1000000;
1588 WHERETRACE(("... table scan base cost: %.9g\n", cost));
drh165be382008-12-05 02:36:33 +00001589 wsFlags = WHERE_ROWID_RANGE;
danielk197785574e32008-10-06 05:32:18 +00001590
1591 /* Check for constraints on a range of rowids in a table scan.
1592 */
1593 pTerm = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE|WO_GT|WO_GE, 0);
1594 if( pTerm ){
1595 if( findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0) ){
drh165be382008-12-05 02:36:33 +00001596 wsFlags |= WHERE_TOP_LIMIT;
danielk197785574e32008-10-06 05:32:18 +00001597 cost /= 3; /* Guess that rowid<EXPR eliminates two-thirds or rows */
1598 }
1599 if( findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0) ){
drh165be382008-12-05 02:36:33 +00001600 wsFlags |= WHERE_BTM_LIMIT;
danielk197785574e32008-10-06 05:32:18 +00001601 cost /= 3; /* Guess that rowid>EXPR eliminates two-thirds of rows */
1602 }
1603 WHERETRACE(("... rowid range reduces cost to %.9g\n", cost));
1604 }else{
drh165be382008-12-05 02:36:33 +00001605 wsFlags = 0;
danielk197785574e32008-10-06 05:32:18 +00001606 }
1607
1608 /* If the table scan does not satisfy the ORDER BY clause, increase
1609 ** the cost by NlogN to cover the expense of sorting. */
1610 if( pOrderBy ){
1611 if( sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev) ){
drh165be382008-12-05 02:36:33 +00001612 wsFlags |= WHERE_ORDERBY|WHERE_ROWID_RANGE;
danielk197785574e32008-10-06 05:32:18 +00001613 if( rev ){
drh165be382008-12-05 02:36:33 +00001614 wsFlags |= WHERE_REVERSE;
danielk197785574e32008-10-06 05:32:18 +00001615 }
1616 }else{
1617 cost += cost*estLog(cost);
1618 WHERETRACE(("... sorting increases cost to %.9g\n", cost));
1619 }
1620 }
1621 if( cost<lowestCost ){
1622 lowestCost = cost;
drh165be382008-12-05 02:36:33 +00001623 bestWsFlags = wsFlags;
danielk197785574e32008-10-06 05:32:18 +00001624 }
drhfe05af82005-07-21 03:14:59 +00001625 }
1626
drhc49de5d2007-01-19 01:06:01 +00001627 /* If the pSrc table is the right table of a LEFT JOIN then we may not
1628 ** use an index to satisfy IS NULL constraints on that table. This is
1629 ** because columns might end up being NULL if the table does not match -
1630 ** a circumstance which the index cannot help us discover. Ticket #2177.
1631 */
1632 if( (pSrc->jointype & JT_LEFT)!=0 ){
1633 eqTermMask = WO_EQ|WO_IN;
1634 }else{
1635 eqTermMask = WO_EQ|WO_IN|WO_ISNULL;
1636 }
1637
drhfe05af82005-07-21 03:14:59 +00001638 /* Look at each index.
1639 */
danielk197785574e32008-10-06 05:32:18 +00001640 if( pSrc->pIndex ){
1641 pProbe = pSrc->pIndex;
1642 }
1643 for(; pProbe; pProbe=(pSrc->pIndex ? 0 : pProbe->pNext)){
drh51147ba2005-07-23 22:59:55 +00001644 int i; /* Loop counter */
drhb37df7b2005-10-13 02:09:49 +00001645 double inMultiplier = 1;
drh51147ba2005-07-23 22:59:55 +00001646
drh4f0c5872007-03-26 22:05:01 +00001647 WHERETRACE(("... index %s:\n", pProbe->zName));
drhfe05af82005-07-21 03:14:59 +00001648
1649 /* Count the number of columns in the index that are satisfied
1650 ** by x=EXPR constraints or x IN (...) constraints.
1651 */
drh165be382008-12-05 02:36:33 +00001652 wsFlags = 0;
drhfe05af82005-07-21 03:14:59 +00001653 for(i=0; i<pProbe->nColumn; i++){
1654 int j = pProbe->aiColumn[i];
drhc49de5d2007-01-19 01:06:01 +00001655 pTerm = findTerm(pWC, iCur, j, notReady, eqTermMask, pProbe);
drhfe05af82005-07-21 03:14:59 +00001656 if( pTerm==0 ) break;
drh165be382008-12-05 02:36:33 +00001657 wsFlags |= WHERE_COLUMN_EQ;
drhb52076c2006-01-23 13:22:09 +00001658 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00001659 Expr *pExpr = pTerm->pExpr;
drh165be382008-12-05 02:36:33 +00001660 wsFlags |= WHERE_COLUMN_IN;
drha6110402005-07-28 20:51:19 +00001661 if( pExpr->pSelect!=0 ){
drhffe0f892006-05-11 13:26:25 +00001662 inMultiplier *= 25;
drh34004ce2008-07-11 16:15:17 +00001663 }else if( ALWAYS(pExpr->pList) ){
drhb37df7b2005-10-13 02:09:49 +00001664 inMultiplier *= pExpr->pList->nExpr + 1;
drhfe05af82005-07-21 03:14:59 +00001665 }
1666 }
1667 }
drh28c4cf42005-07-27 20:41:43 +00001668 cost = pProbe->aiRowEst[i] * inMultiplier * estLog(inMultiplier);
drh51147ba2005-07-23 22:59:55 +00001669 nEq = i;
drh165be382008-12-05 02:36:33 +00001670 if( pProbe->onError!=OE_None && (wsFlags & WHERE_COLUMN_IN)==0
drh943af3c2005-07-29 19:43:58 +00001671 && nEq==pProbe->nColumn ){
drh165be382008-12-05 02:36:33 +00001672 wsFlags |= WHERE_UNIQUE;
drh943af3c2005-07-29 19:43:58 +00001673 }
drh8e70e342007-09-13 17:54:40 +00001674 WHERETRACE(("...... nEq=%d inMult=%.9g cost=%.9g\n",nEq,inMultiplier,cost));
drhfe05af82005-07-21 03:14:59 +00001675
drh51147ba2005-07-23 22:59:55 +00001676 /* Look for range constraints
drhfe05af82005-07-21 03:14:59 +00001677 */
drh51147ba2005-07-23 22:59:55 +00001678 if( nEq<pProbe->nColumn ){
1679 int j = pProbe->aiColumn[nEq];
1680 pTerm = findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE|WO_GT|WO_GE, pProbe);
1681 if( pTerm ){
drh165be382008-12-05 02:36:33 +00001682 wsFlags |= WHERE_COLUMN_RANGE;
drh51147ba2005-07-23 22:59:55 +00001683 if( findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE, pProbe) ){
drh165be382008-12-05 02:36:33 +00001684 wsFlags |= WHERE_TOP_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001685 cost /= 3;
drh51147ba2005-07-23 22:59:55 +00001686 }
1687 if( findTerm(pWC, iCur, j, notReady, WO_GT|WO_GE, pProbe) ){
drh165be382008-12-05 02:36:33 +00001688 wsFlags |= WHERE_BTM_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001689 cost /= 3;
drh51147ba2005-07-23 22:59:55 +00001690 }
drh4f0c5872007-03-26 22:05:01 +00001691 WHERETRACE(("...... range reduces cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001692 }
1693 }
1694
drh28c4cf42005-07-27 20:41:43 +00001695 /* Add the additional cost of sorting if that is a factor.
drh51147ba2005-07-23 22:59:55 +00001696 */
drh28c4cf42005-07-27 20:41:43 +00001697 if( pOrderBy ){
drh165be382008-12-05 02:36:33 +00001698 if( (wsFlags & WHERE_COLUMN_IN)==0 &&
drh7b4fc6a2007-02-06 13:26:32 +00001699 isSortingIndex(pParse,pWC->pMaskSet,pProbe,iCur,pOrderBy,nEq,&rev) ){
drh165be382008-12-05 02:36:33 +00001700 if( wsFlags==0 ){
1701 wsFlags = WHERE_COLUMN_RANGE;
drh28c4cf42005-07-27 20:41:43 +00001702 }
drh165be382008-12-05 02:36:33 +00001703 wsFlags |= WHERE_ORDERBY;
drh28c4cf42005-07-27 20:41:43 +00001704 if( rev ){
drh165be382008-12-05 02:36:33 +00001705 wsFlags |= WHERE_REVERSE;
drh28c4cf42005-07-27 20:41:43 +00001706 }
1707 }else{
1708 cost += cost*estLog(cost);
drh4f0c5872007-03-26 22:05:01 +00001709 WHERETRACE(("...... orderby increases cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001710 }
drhfe05af82005-07-21 03:14:59 +00001711 }
1712
1713 /* Check to see if we can get away with using just the index without
drh51147ba2005-07-23 22:59:55 +00001714 ** ever reading the table. If that is the case, then halve the
1715 ** cost of this index.
drhfe05af82005-07-21 03:14:59 +00001716 */
drh165be382008-12-05 02:36:33 +00001717 if( wsFlags && pSrc->colUsed < (((Bitmask)1)<<(BMS-1)) ){
drhfe05af82005-07-21 03:14:59 +00001718 Bitmask m = pSrc->colUsed;
1719 int j;
1720 for(j=0; j<pProbe->nColumn; j++){
1721 int x = pProbe->aiColumn[j];
1722 if( x<BMS-1 ){
1723 m &= ~(((Bitmask)1)<<x);
1724 }
1725 }
1726 if( m==0 ){
drh165be382008-12-05 02:36:33 +00001727 wsFlags |= WHERE_IDX_ONLY;
drhb37df7b2005-10-13 02:09:49 +00001728 cost /= 2;
drh4f0c5872007-03-26 22:05:01 +00001729 WHERETRACE(("...... idx-only reduces cost to %.9g\n", cost));
drhfe05af82005-07-21 03:14:59 +00001730 }
1731 }
1732
drh51147ba2005-07-23 22:59:55 +00001733 /* If this index has achieved the lowest cost so far, then use it.
drhfe05af82005-07-21 03:14:59 +00001734 */
drh165be382008-12-05 02:36:33 +00001735 if( wsFlags && cost < lowestCost ){
drhfe05af82005-07-21 03:14:59 +00001736 bestIdx = pProbe;
drh51147ba2005-07-23 22:59:55 +00001737 lowestCost = cost;
drh165be382008-12-05 02:36:33 +00001738 bestWsFlags = wsFlags;
drh51147ba2005-07-23 22:59:55 +00001739 bestNEq = nEq;
drhfe05af82005-07-21 03:14:59 +00001740 }
1741 }
1742
drhfe05af82005-07-21 03:14:59 +00001743 /* Report the best result
1744 */
1745 *ppIndex = bestIdx;
drh165be382008-12-05 02:36:33 +00001746 WHERETRACE(("best index is %s, cost=%.9g, wsFlags=%x, nEq=%d\n",
1747 bestIdx ? bestIdx->zName : "(none)", lowestCost, bestWsFlags, bestNEq));
1748 *pWsFlags = bestWsFlags | eqTermMask;
drh51147ba2005-07-23 22:59:55 +00001749 *pnEq = bestNEq;
1750 return lowestCost;
drhfe05af82005-07-21 03:14:59 +00001751}
1752
drhb6c29892004-11-22 19:12:19 +00001753
1754/*
drh2ffb1182004-07-19 19:14:01 +00001755** Disable a term in the WHERE clause. Except, do not disable the term
1756** if it controls a LEFT OUTER JOIN and it did not originate in the ON
1757** or USING clause of that join.
1758**
1759** Consider the term t2.z='ok' in the following queries:
1760**
1761** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
1762** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
1763** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
1764**
drh23bf66d2004-12-14 03:34:34 +00001765** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00001766** in the ON clause. The term is disabled in (3) because it is not part
1767** of a LEFT OUTER JOIN. In (1), the term is not disabled.
1768**
1769** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00001770** of the join. Disabling is an optimization. When terms are satisfied
1771** by indices, we disable them to prevent redundant tests in the inner
1772** loop. We would get the correct results if nothing were ever disabled,
1773** but joins might run a little slower. The trick is to disable as much
1774** as we can without disabling too much. If we disabled in (1), we'd get
1775** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00001776*/
drh0fcef5e2005-07-19 17:38:22 +00001777static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
1778 if( pTerm
drh165be382008-12-05 02:36:33 +00001779 && ALWAYS((pTerm->wtFlags & TERM_CODED)==0)
drh0fcef5e2005-07-19 17:38:22 +00001780 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
1781 ){
drh165be382008-12-05 02:36:33 +00001782 pTerm->wtFlags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00001783 if( pTerm->iParent>=0 ){
1784 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
1785 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00001786 disableTerm(pLevel, pOther);
1787 }
drh0fcef5e2005-07-19 17:38:22 +00001788 }
drh2ffb1182004-07-19 19:14:01 +00001789 }
1790}
1791
1792/*
danielk1977b790c6c2008-04-18 10:25:24 +00001793** Apply the affinities associated with the first n columns of index
1794** pIdx to the values in the n registers starting at base.
drh94a11212004-09-25 13:12:14 +00001795*/
danielk1977b790c6c2008-04-18 10:25:24 +00001796static void codeApplyAffinity(Parse *pParse, int base, int n, Index *pIdx){
1797 if( n>0 ){
1798 Vdbe *v = pParse->pVdbe;
1799 assert( v!=0 );
1800 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
1801 sqlite3IndexAffinityStr(v, pIdx);
1802 sqlite3ExprCacheAffinityChange(pParse, base, n);
1803 }
drh94a11212004-09-25 13:12:14 +00001804}
1805
drhe8b97272005-07-19 22:22:12 +00001806
1807/*
drh51147ba2005-07-23 22:59:55 +00001808** Generate code for a single equality term of the WHERE clause. An equality
1809** term can be either X=expr or X IN (...). pTerm is the term to be
1810** coded.
1811**
drh1db639c2008-01-17 02:36:28 +00001812** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00001813**
1814** For a constraint of the form X=expr, the expression is evaluated and its
1815** result is left on the stack. For constraints of the form X IN (...)
1816** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00001817*/
drh678ccce2008-03-31 18:19:54 +00001818static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00001819 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00001820 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh1db639c2008-01-17 02:36:28 +00001821 WhereLevel *pLevel, /* When level of the FROM clause we are working on */
drh678ccce2008-03-31 18:19:54 +00001822 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00001823){
drh0fcef5e2005-07-19 17:38:22 +00001824 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00001825 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00001826 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00001827
danielk19772d605492008-10-01 08:43:03 +00001828 assert( iTarget>0 );
drh50b39962006-10-28 00:28:09 +00001829 if( pX->op==TK_EQ ){
drh678ccce2008-03-31 18:19:54 +00001830 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00001831 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00001832 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00001833 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00001834#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00001835 }else{
danielk19779a96b662007-11-29 17:05:18 +00001836 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00001837 int iTab;
drh72e8fa42007-03-28 14:30:06 +00001838 struct InLoop *pIn;
danielk1977b3bce662005-01-29 08:32:43 +00001839
drh50b39962006-10-28 00:28:09 +00001840 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00001841 iReg = iTarget;
danielk19770cdc0222008-06-26 18:04:03 +00001842 eType = sqlite3FindInIndex(pParse, pX, 0);
danielk1977b3bce662005-01-29 08:32:43 +00001843 iTab = pX->iTable;
drh66a51672008-01-03 00:01:23 +00001844 sqlite3VdbeAddOp2(v, OP_Rewind, iTab, 0);
drhd4e70eb2008-01-02 00:34:36 +00001845 VdbeComment((v, "%.*s", pX->span.n, pX->span.z));
drh72e8fa42007-03-28 14:30:06 +00001846 if( pLevel->nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00001847 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00001848 }
drhe23399f2005-07-22 00:31:39 +00001849 pLevel->nIn++;
drh17435752007-08-16 04:30:38 +00001850 pLevel->aInLoop = sqlite3DbReallocOrFree(pParse->db, pLevel->aInLoop,
drh72e8fa42007-03-28 14:30:06 +00001851 sizeof(pLevel->aInLoop[0])*pLevel->nIn);
1852 pIn = pLevel->aInLoop;
1853 if( pIn ){
1854 pIn += pLevel->nIn - 1;
1855 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00001856 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00001857 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00001858 }else{
drhb3190c12008-12-08 21:37:14 +00001859 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00001860 }
1861 sqlite3VdbeAddOp1(v, OP_IsNull, iReg);
drha6110402005-07-28 20:51:19 +00001862 }else{
1863 pLevel->nIn = 0;
drhe23399f2005-07-22 00:31:39 +00001864 }
danielk1977b3bce662005-01-29 08:32:43 +00001865#endif
drh94a11212004-09-25 13:12:14 +00001866 }
drh0fcef5e2005-07-19 17:38:22 +00001867 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00001868 return iReg;
drh94a11212004-09-25 13:12:14 +00001869}
1870
drh51147ba2005-07-23 22:59:55 +00001871/*
1872** Generate code that will evaluate all == and IN constraints for an
1873** index. The values for all constraints are left on the stack.
1874**
1875** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
1876** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
1877** The index has as many as three equality constraints, but in this
1878** example, the third "c" value is an inequality. So only two
1879** constraints are coded. This routine will generate code to evaluate
1880** a==5 and b IN (1,2,3). The current values for a and b will be left
1881** on the stack - a is the deepest and b the shallowest.
1882**
1883** In the example above nEq==2. But this subroutine works for any value
1884** of nEq including 0. If nEq==0, this routine is nearly a no-op.
1885** The only thing it does is allocate the pLevel->iMem memory cell.
1886**
1887** This routine always allocates at least one memory cell and puts
1888** the address of that memory cell in pLevel->iMem. The code that
1889** calls this routine will use pLevel->iMem to store the termination
1890** key value of the loop. If one or more IN operators appear, then
1891** this routine allocates an additional nEq memory cells for internal
1892** use.
1893*/
drh1db639c2008-01-17 02:36:28 +00001894static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00001895 Parse *pParse, /* Parsing context */
1896 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
1897 WhereClause *pWC, /* The WHERE clause */
drh1db639c2008-01-17 02:36:28 +00001898 Bitmask notReady, /* Which parts of FROM have not yet been coded */
1899 int nExtraReg /* Number of extra registers to allocate */
drh51147ba2005-07-23 22:59:55 +00001900){
1901 int nEq = pLevel->nEq; /* The number of == or IN constraints to code */
drh51147ba2005-07-23 22:59:55 +00001902 Vdbe *v = pParse->pVdbe; /* The virtual machine under construction */
1903 Index *pIdx = pLevel->pIdx; /* The index being used for this loop */
1904 int iCur = pLevel->iTabCur; /* The cursor of the table */
1905 WhereTerm *pTerm; /* A single constraint term */
1906 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00001907 int regBase; /* Base register */
drh51147ba2005-07-23 22:59:55 +00001908
1909 /* Figure out how many memory cells we will need then allocate them.
1910 ** We always need at least one used to store the loop terminator
1911 ** value. If there are IN operators we'll need one for each == or
1912 ** IN constraint.
1913 */
drh1db639c2008-01-17 02:36:28 +00001914 pLevel->iMem = pParse->nMem + 1;
1915 regBase = pParse->nMem + 2;
1916 pParse->nMem += pLevel->nEq + 2 + nExtraReg;
drh51147ba2005-07-23 22:59:55 +00001917
1918 /* Evaluate the equality constraints
1919 */
drhc49de5d2007-01-19 01:06:01 +00001920 assert( pIdx->nColumn>=nEq );
1921 for(j=0; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00001922 int r1;
drh51147ba2005-07-23 22:59:55 +00001923 int k = pIdx->aiColumn[j];
drh165be382008-12-05 02:36:33 +00001924 pTerm = findTerm(pWC, iCur, k, notReady, pLevel->wsFlags, pIdx);
drh34004ce2008-07-11 16:15:17 +00001925 if( NEVER(pTerm==0) ) break;
drh165be382008-12-05 02:36:33 +00001926 assert( (pTerm->wtFlags & TERM_CODED)==0 );
drh678ccce2008-03-31 18:19:54 +00001927 r1 = codeEqualityTerm(pParse, pTerm, pLevel, regBase+j);
1928 if( r1!=regBase+j ){
1929 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
1930 }
drh981642f2008-04-19 14:40:43 +00001931 testcase( pTerm->eOperator & WO_ISNULL );
1932 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00001933 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drhb3190c12008-12-08 21:37:14 +00001934 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
drh51147ba2005-07-23 22:59:55 +00001935 }
1936 }
drh1db639c2008-01-17 02:36:28 +00001937 return regBase;
drh51147ba2005-07-23 22:59:55 +00001938}
1939
drh549c8b62005-09-19 13:15:23 +00001940#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00001941/*
1942** The following variable holds a text description of query plan generated
1943** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
1944** overwrites the previous. This information is used for testing and
1945** analysis only.
1946*/
1947char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
1948static int nQPlan = 0; /* Next free slow in _query_plan[] */
1949
1950#endif /* SQLITE_TEST */
1951
1952
drh9eff6162006-06-12 21:59:13 +00001953/*
1954** Free a WhereInfo structure
1955*/
drh10fe8402008-10-11 16:47:35 +00001956static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh9eff6162006-06-12 21:59:13 +00001957 if( pWInfo ){
1958 int i;
1959 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00001960 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
1961 if( pInfo ){
drh01495b92008-01-23 12:52:40 +00001962 assert( pInfo->needToFreeIdxStr==0 );
drh633e6d52008-07-28 19:34:53 +00001963 sqlite3DbFree(db, pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00001964 }
drh9eff6162006-06-12 21:59:13 +00001965 }
drh633e6d52008-07-28 19:34:53 +00001966 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00001967 }
1968}
1969
drh94a11212004-09-25 13:12:14 +00001970
1971/*
drhe3184742002-06-19 14:27:05 +00001972** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00001973** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00001974** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00001975** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00001976** in order to complete the WHERE clause processing.
1977**
1978** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00001979**
1980** The basic idea is to do a nested loop, one loop for each table in
1981** the FROM clause of a select. (INSERT and UPDATE statements are the
1982** same as a SELECT with only a single table in the FROM clause.) For
1983** example, if the SQL is this:
1984**
1985** SELECT * FROM t1, t2, t3 WHERE ...;
1986**
1987** Then the code generated is conceptually like the following:
1988**
1989** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00001990** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00001991** foreach row3 in t3 do /
1992** ...
1993** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00001994** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00001995** end /
1996**
drh29dda4a2005-07-21 18:23:20 +00001997** Note that the loops might not be nested in the order in which they
1998** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00001999** use of indices. Note also that when the IN operator appears in
2000** the WHERE clause, it might result in additional nested loops for
2001** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00002002**
drhc27a1ce2002-06-14 20:58:45 +00002003** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00002004** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
2005** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00002006** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00002007**
drhe6f85e72004-12-25 01:03:13 +00002008** The code that sqlite3WhereBegin() generates leaves the cursors named
2009** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00002010** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00002011** data from the various tables of the loop.
2012**
drhc27a1ce2002-06-14 20:58:45 +00002013** If the WHERE clause is empty, the foreach loops must each scan their
2014** entire tables. Thus a three-way join is an O(N^3) operation. But if
2015** the tables have indices and there are terms in the WHERE clause that
2016** refer to those indices, a complete table scan can be avoided and the
2017** code will run much faster. Most of the work of this routine is checking
2018** to see if there are indices that can be used to speed up the loop.
2019**
2020** Terms of the WHERE clause are also used to limit which rows actually
2021** make it to the "..." in the middle of the loop. After each "foreach",
2022** terms of the WHERE clause that use only terms in that loop and outer
2023** loops are evaluated and if false a jump is made around all subsequent
2024** inner loops (or around the "..." if the test occurs within the inner-
2025** most loop)
2026**
2027** OUTER JOINS
2028**
2029** An outer join of tables t1 and t2 is conceptally coded as follows:
2030**
2031** foreach row1 in t1 do
2032** flag = 0
2033** foreach row2 in t2 do
2034** start:
2035** ...
2036** flag = 1
2037** end
drhe3184742002-06-19 14:27:05 +00002038** if flag==0 then
2039** move the row2 cursor to a null row
2040** goto start
2041** fi
drhc27a1ce2002-06-14 20:58:45 +00002042** end
2043**
drhe3184742002-06-19 14:27:05 +00002044** ORDER BY CLAUSE PROCESSING
2045**
2046** *ppOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
2047** if there is one. If there is no ORDER BY clause or if this routine
2048** is called from an UPDATE or DELETE statement, then ppOrderBy is NULL.
2049**
2050** If an index can be used so that the natural output order of the table
2051** scan is correct for the ORDER BY clause, then that index is used and
2052** *ppOrderBy is set to NULL. This is an optimization that prevents an
2053** unnecessary sort of the result set if an index appropriate for the
2054** ORDER BY clause already exists.
2055**
2056** If the where clause loops cannot be arranged to provide the correct
2057** output order, then the *ppOrderBy is unchanged.
drh75897232000-05-29 14:26:00 +00002058*/
danielk19774adee202004-05-08 08:23:19 +00002059WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00002060 Parse *pParse, /* The parser context */
2061 SrcList *pTabList, /* A list of all tables to be scanned */
2062 Expr *pWhere, /* The WHERE clause */
danielk1977a9d1ccb2008-01-05 17:39:29 +00002063 ExprList **ppOrderBy, /* An ORDER BY clause, or NULL */
drh165be382008-12-05 02:36:33 +00002064 u8 wctrlFlags /* One of the WHERE_* flags defined in sqliteInt.h */
drh75897232000-05-29 14:26:00 +00002065){
2066 int i; /* Loop counter */
2067 WhereInfo *pWInfo; /* Will become the return value of this function */
2068 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhb3190c12008-12-08 21:37:14 +00002069 int addrBrk, addrCont = 0; /* Addresses used during code generation */
drhfe05af82005-07-21 03:14:59 +00002070 Bitmask notReady; /* Cursors that are not yet positioned */
drh0aa74ed2005-07-16 13:33:20 +00002071 WhereTerm *pTerm; /* A single term in the WHERE clause */
2072 ExprMaskSet maskSet; /* The expression mask set */
drh0aa74ed2005-07-16 13:33:20 +00002073 WhereClause wc; /* The WHERE clause is divided into these terms */
drh9012bcb2004-12-19 00:11:35 +00002074 struct SrcList_item *pTabItem; /* A single entry from pTabList */
2075 WhereLevel *pLevel; /* A single level in the pWInfo list */
drh29dda4a2005-07-21 18:23:20 +00002076 int iFrom; /* First unused FROM clause element */
drh165be382008-12-05 02:36:33 +00002077 int andFlags; /* AND-ed combination of all wc.a[].wtFlags */
drh17435752007-08-16 04:30:38 +00002078 sqlite3 *db; /* Database connection */
danielk1977a9d1ccb2008-01-05 17:39:29 +00002079 ExprList *pOrderBy = 0;
drh75897232000-05-29 14:26:00 +00002080
drh29dda4a2005-07-21 18:23:20 +00002081 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00002082 ** bits in a Bitmask
2083 */
drh29dda4a2005-07-21 18:23:20 +00002084 if( pTabList->nSrc>BMS ){
2085 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00002086 return 0;
2087 }
2088
danielk1977a9d1ccb2008-01-05 17:39:29 +00002089 if( ppOrderBy ){
2090 pOrderBy = *ppOrderBy;
2091 }
2092
drh83dcb1a2002-06-28 01:02:38 +00002093 /* Split the WHERE clause into separate subexpressions where each
drh29dda4a2005-07-21 18:23:20 +00002094 ** subexpression is separated by an AND operator.
drh83dcb1a2002-06-28 01:02:38 +00002095 */
drh6a3ea0e2003-05-02 14:32:12 +00002096 initMaskSet(&maskSet);
drh7b4fc6a2007-02-06 13:26:32 +00002097 whereClauseInit(&wc, pParse, &maskSet);
drh678ccce2008-03-31 18:19:54 +00002098 sqlite3ExprCodeConstants(pParse, pWhere);
drh6c30be82005-07-29 15:10:17 +00002099 whereSplit(&wc, pWhere, TK_AND);
drh1398ad32005-01-19 23:24:50 +00002100
drh75897232000-05-29 14:26:00 +00002101 /* Allocate and initialize the WhereInfo structure that will become the
2102 ** return value.
2103 */
drh17435752007-08-16 04:30:38 +00002104 db = pParse->db;
2105 pWInfo = sqlite3DbMallocZero(db,
2106 sizeof(WhereInfo) + pTabList->nSrc*sizeof(WhereLevel));
2107 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00002108 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00002109 }
danielk197770b6d572006-06-19 04:49:34 +00002110 pWInfo->nLevel = pTabList->nSrc;
drh75897232000-05-29 14:26:00 +00002111 pWInfo->pParse = pParse;
2112 pWInfo->pTabList = pTabList;
danielk19774adee202004-05-08 08:23:19 +00002113 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh08192d52002-04-30 19:20:28 +00002114
2115 /* Special case: a WHERE clause that is constant. Evaluate the
2116 ** expression and either jump over all of the code or fall thru.
2117 */
drh0a168372007-06-08 00:20:47 +00002118 if( pWhere && (pTabList->nSrc==0 || sqlite3ExprIsConstantNotJoin(pWhere)) ){
drh35573352008-01-08 23:54:25 +00002119 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, SQLITE_JUMPIFNULL);
drhdf199a22002-06-14 22:38:41 +00002120 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00002121 }
drh75897232000-05-29 14:26:00 +00002122
drh42165be2008-03-26 14:56:34 +00002123 /* Assign a bit from the bitmask to every term in the FROM clause.
2124 **
2125 ** When assigning bitmask values to FROM clause cursors, it must be
2126 ** the case that if X is the bitmask for the N-th FROM clause term then
2127 ** the bitmask for all FROM clause terms to the left of the N-th term
2128 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
2129 ** its Expr.iRightJoinTable value to find the bitmask of the right table
2130 ** of the join. Subtracting one from the right table bitmask gives a
2131 ** bitmask for all tables to the left of the join. Knowing the bitmask
2132 ** for all tables to the left of a left join is important. Ticket #3015.
2133 */
2134 for(i=0; i<pTabList->nSrc; i++){
2135 createMask(&maskSet, pTabList->a[i].iCursor);
2136 }
2137#ifndef NDEBUG
2138 {
2139 Bitmask toTheLeft = 0;
2140 for(i=0; i<pTabList->nSrc; i++){
2141 Bitmask m = getMask(&maskSet, pTabList->a[i].iCursor);
2142 assert( (m-1)==toTheLeft );
2143 toTheLeft |= m;
2144 }
2145 }
2146#endif
2147
drh29dda4a2005-07-21 18:23:20 +00002148 /* Analyze all of the subexpressions. Note that exprAnalyze() might
2149 ** add new virtual terms onto the end of the WHERE clause. We do not
2150 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00002151 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00002152 */
drh7b4fc6a2007-02-06 13:26:32 +00002153 exprAnalyzeAll(pTabList, &wc);
drh17435752007-08-16 04:30:38 +00002154 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00002155 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00002156 }
drh75897232000-05-29 14:26:00 +00002157
drh29dda4a2005-07-21 18:23:20 +00002158 /* Chose the best index to use for each table in the FROM clause.
2159 **
drh51147ba2005-07-23 22:59:55 +00002160 ** This loop fills in the following fields:
2161 **
2162 ** pWInfo->a[].pIdx The index to use for this level of the loop.
drh165be382008-12-05 02:36:33 +00002163 ** pWInfo->a[].wsFlags WHERE_xxx flags associated with pIdx
drh51147ba2005-07-23 22:59:55 +00002164 ** pWInfo->a[].nEq The number of == and IN constraints
danielk197785574e32008-10-06 05:32:18 +00002165 ** pWInfo->a[].iFrom Which term of the FROM clause is being coded
drh51147ba2005-07-23 22:59:55 +00002166 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
2167 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
2168 **
2169 ** This loop also figures out the nesting order of tables in the FROM
2170 ** clause.
drh75897232000-05-29 14:26:00 +00002171 */
drhfe05af82005-07-21 03:14:59 +00002172 notReady = ~(Bitmask)0;
drh9012bcb2004-12-19 00:11:35 +00002173 pTabItem = pTabList->a;
2174 pLevel = pWInfo->a;
drh943af3c2005-07-29 19:43:58 +00002175 andFlags = ~0;
drh4f0c5872007-03-26 22:05:01 +00002176 WHERETRACE(("*** Optimizer Start ***\n"));
drh29dda4a2005-07-21 18:23:20 +00002177 for(i=iFrom=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
2178 Index *pIdx; /* Index for FROM table at pTabItem */
drh165be382008-12-05 02:36:33 +00002179 int wsFlags; /* Flags describing scan strategy */
drh51147ba2005-07-23 22:59:55 +00002180 int nEq; /* Number of == or IN constraints */
2181 double cost; /* The cost for pIdx */
drh29dda4a2005-07-21 18:23:20 +00002182 int j; /* For looping over FROM tables */
2183 Index *pBest = 0; /* The best index seen so far */
drh165be382008-12-05 02:36:33 +00002184 int bestWsFlags = 0; /* Flags associated with pBest */
drh51147ba2005-07-23 22:59:55 +00002185 int bestNEq = 0; /* nEq associated with pBest */
drhb37df7b2005-10-13 02:09:49 +00002186 double lowestCost; /* Cost of the pBest */
drh02afc862006-01-20 18:10:57 +00002187 int bestJ = 0; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00002188 Bitmask m; /* Bitmask value for j or bestJ */
drh570b9352006-02-01 02:45:02 +00002189 int once = 0; /* True when first table is seen */
drh6d209d82006-06-27 01:54:26 +00002190 sqlite3_index_info *pIndex; /* Current virtual index */
drh29dda4a2005-07-21 18:23:20 +00002191
drhb37df7b2005-10-13 02:09:49 +00002192 lowestCost = SQLITE_BIG_DBL;
drh29dda4a2005-07-21 18:23:20 +00002193 for(j=iFrom, pTabItem=&pTabList->a[j]; j<pTabList->nSrc; j++, pTabItem++){
drhdf26fd52006-06-06 11:45:54 +00002194 int doNotReorder; /* True if this table should not be reordered */
2195
drh61dfc312006-12-16 16:25:15 +00002196 doNotReorder = (pTabItem->jointype & (JT_LEFT|JT_CROSS))!=0;
drhdf26fd52006-06-06 11:45:54 +00002197 if( once && doNotReorder ) break;
drh29dda4a2005-07-21 18:23:20 +00002198 m = getMask(&maskSet, pTabItem->iCursor);
2199 if( (m & notReady)==0 ){
2200 if( j==iFrom ) iFrom++;
2201 continue;
2202 }
drh9eff6162006-06-12 21:59:13 +00002203 assert( pTabItem->pTab );
2204#ifndef SQLITE_OMIT_VIRTUALTABLE
drh4cbdda92006-06-14 19:00:20 +00002205 if( IsVirtual(pTabItem->pTab) ){
drh6d209d82006-06-27 01:54:26 +00002206 sqlite3_index_info **ppIdxInfo = &pWInfo->a[j].pIdxInfo;
drh9eff6162006-06-12 21:59:13 +00002207 cost = bestVirtualIndex(pParse, &wc, pTabItem, notReady,
2208 ppOrderBy ? *ppOrderBy : 0, i==0,
drh6d209d82006-06-27 01:54:26 +00002209 ppIdxInfo);
drh165be382008-12-05 02:36:33 +00002210 wsFlags = WHERE_VIRTUALTABLE;
drh6d209d82006-06-27 01:54:26 +00002211 pIndex = *ppIdxInfo;
drhc8c0f8f2008-07-08 19:45:02 +00002212 if( pIndex && pIndex->orderByConsumed ){
drh165be382008-12-05 02:36:33 +00002213 wsFlags = WHERE_VIRTUALTABLE | WHERE_ORDERBY;
drh1a90e092006-06-14 22:07:10 +00002214 }
drh9eff6162006-06-12 21:59:13 +00002215 pIdx = 0;
2216 nEq = 0;
danielk19778efe5412007-03-02 08:12:22 +00002217 if( (SQLITE_BIG_DBL/2.0)<cost ){
2218 /* The cost is not allowed to be larger than SQLITE_BIG_DBL (the
2219 ** inital value of lowestCost in this loop. If it is, then
2220 ** the (cost<lowestCost) test below will never be true and
2221 ** pLevel->pBestIdx never set.
2222 */
2223 cost = (SQLITE_BIG_DBL/2.0);
2224 }
drh9eff6162006-06-12 21:59:13 +00002225 }else
2226#endif
2227 {
2228 cost = bestIndex(pParse, &wc, pTabItem, notReady,
2229 (i==0 && ppOrderBy) ? *ppOrderBy : 0,
drh165be382008-12-05 02:36:33 +00002230 &pIdx, &wsFlags, &nEq);
drh9861a9f2006-06-27 02:33:40 +00002231 pIndex = 0;
drh9eff6162006-06-12 21:59:13 +00002232 }
drh51147ba2005-07-23 22:59:55 +00002233 if( cost<lowestCost ){
drh570b9352006-02-01 02:45:02 +00002234 once = 1;
drh51147ba2005-07-23 22:59:55 +00002235 lowestCost = cost;
drh29dda4a2005-07-21 18:23:20 +00002236 pBest = pIdx;
drh165be382008-12-05 02:36:33 +00002237 bestWsFlags = wsFlags;
drh51147ba2005-07-23 22:59:55 +00002238 bestNEq = nEq;
drh29dda4a2005-07-21 18:23:20 +00002239 bestJ = j;
drh6d209d82006-06-27 01:54:26 +00002240 pLevel->pBestIdx = pIndex;
drh29dda4a2005-07-21 18:23:20 +00002241 }
drhdf26fd52006-06-06 11:45:54 +00002242 if( doNotReorder ) break;
drh29dda4a2005-07-21 18:23:20 +00002243 }
drhcb041342008-06-12 00:07:29 +00002244 WHERETRACE(("*** Optimizer selects table %d for loop %d\n", bestJ,
drh3dec2232005-09-10 15:28:09 +00002245 pLevel-pWInfo->a));
drh165be382008-12-05 02:36:33 +00002246 if( (bestWsFlags & WHERE_ORDERBY)!=0 ){
drhfe05af82005-07-21 03:14:59 +00002247 *ppOrderBy = 0;
drhc4a3c772001-04-04 11:48:57 +00002248 }
drh165be382008-12-05 02:36:33 +00002249 andFlags &= bestWsFlags;
2250 pLevel->wsFlags = bestWsFlags;
drhfe05af82005-07-21 03:14:59 +00002251 pLevel->pIdx = pBest;
drh51147ba2005-07-23 22:59:55 +00002252 pLevel->nEq = bestNEq;
drhe23399f2005-07-22 00:31:39 +00002253 pLevel->aInLoop = 0;
2254 pLevel->nIn = 0;
drhfe05af82005-07-21 03:14:59 +00002255 if( pBest ){
drh9012bcb2004-12-19 00:11:35 +00002256 pLevel->iIdxCur = pParse->nTab++;
drhfe05af82005-07-21 03:14:59 +00002257 }else{
2258 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00002259 }
drh29dda4a2005-07-21 18:23:20 +00002260 notReady &= ~getMask(&maskSet, pTabList->a[bestJ].iCursor);
2261 pLevel->iFrom = bestJ;
danielk197785574e32008-10-06 05:32:18 +00002262
2263 /* Check that if the table scanned by this loop iteration had an
2264 ** INDEXED BY clause attached to it, that the named index is being
2265 ** used for the scan. If not, then query compilation has failed.
2266 ** Return an error.
2267 */
2268 pIdx = pTabList->a[bestJ].pIndex;
2269 assert( !pIdx || !pBest || pIdx==pBest );
2270 if( pIdx && pBest!=pIdx ){
2271 sqlite3ErrorMsg(pParse, "cannot use index: %s", pIdx->zName);
2272 goto whereBeginError;
2273 }
drh75897232000-05-29 14:26:00 +00002274 }
drh4f0c5872007-03-26 22:05:01 +00002275 WHERETRACE(("*** Optimizer Finished ***\n"));
drh75897232000-05-29 14:26:00 +00002276
drh943af3c2005-07-29 19:43:58 +00002277 /* If the total query only selects a single row, then the ORDER BY
2278 ** clause is irrelevant.
2279 */
2280 if( (andFlags & WHERE_UNIQUE)!=0 && ppOrderBy ){
2281 *ppOrderBy = 0;
2282 }
2283
drh08c88eb2008-04-10 13:33:18 +00002284 /* If the caller is an UPDATE or DELETE statement that is requesting
2285 ** to use a one-pass algorithm, determine if this is appropriate.
2286 ** The one-pass algorithm only works if the WHERE clause constraints
2287 ** the statement to update a single row.
2288 */
drh165be382008-12-05 02:36:33 +00002289 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
2290 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 && (andFlags & WHERE_UNIQUE)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00002291 pWInfo->okOnePass = 1;
drh165be382008-12-05 02:36:33 +00002292 pWInfo->a[0].wsFlags &= ~WHERE_IDX_ONLY;
drh08c88eb2008-04-10 13:33:18 +00002293 }
2294
drh9012bcb2004-12-19 00:11:35 +00002295 /* Open all tables in the pTabList and any indices selected for
2296 ** searching those tables.
2297 */
2298 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh29dda4a2005-07-21 18:23:20 +00002299 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00002300 Table *pTab; /* Table to open */
2301 Index *pIx; /* Index used to access pTab (if any) */
2302 int iDb; /* Index of database containing table/index */
drh9012bcb2004-12-19 00:11:35 +00002303 int iIdxCur = pLevel->iIdxCur;
2304
drhecc92422005-09-10 16:46:12 +00002305#ifndef SQLITE_OMIT_EXPLAIN
2306 if( pParse->explain==2 ){
2307 char *zMsg;
2308 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
danielk19771e536952007-08-16 10:09:01 +00002309 zMsg = sqlite3MPrintf(db, "TABLE %s", pItem->zName);
drhecc92422005-09-10 16:46:12 +00002310 if( pItem->zAlias ){
drh633e6d52008-07-28 19:34:53 +00002311 zMsg = sqlite3MAppendf(db, zMsg, "%s AS %s", zMsg, pItem->zAlias);
drhecc92422005-09-10 16:46:12 +00002312 }
2313 if( (pIx = pLevel->pIdx)!=0 ){
drh633e6d52008-07-28 19:34:53 +00002314 zMsg = sqlite3MAppendf(db, zMsg, "%s WITH INDEX %s", zMsg, pIx->zName);
drh165be382008-12-05 02:36:33 +00002315 }else if( pLevel->wsFlags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh633e6d52008-07-28 19:34:53 +00002316 zMsg = sqlite3MAppendf(db, zMsg, "%s USING PRIMARY KEY", zMsg);
drhecc92422005-09-10 16:46:12 +00002317 }
drh9eff6162006-06-12 21:59:13 +00002318#ifndef SQLITE_OMIT_VIRTUALTABLE
drh6d209d82006-06-27 01:54:26 +00002319 else if( pLevel->pBestIdx ){
2320 sqlite3_index_info *pBestIdx = pLevel->pBestIdx;
drh633e6d52008-07-28 19:34:53 +00002321 zMsg = sqlite3MAppendf(db, zMsg, "%s VIRTUAL TABLE INDEX %d:%s", zMsg,
drh6d209d82006-06-27 01:54:26 +00002322 pBestIdx->idxNum, pBestIdx->idxStr);
drh9eff6162006-06-12 21:59:13 +00002323 }
2324#endif
drh165be382008-12-05 02:36:33 +00002325 if( pLevel->wsFlags & WHERE_ORDERBY ){
drh633e6d52008-07-28 19:34:53 +00002326 zMsg = sqlite3MAppendf(db, zMsg, "%s ORDER BY", zMsg);
drhe2b39092006-04-21 09:38:36 +00002327 }
drh66a51672008-01-03 00:01:23 +00002328 sqlite3VdbeAddOp4(v, OP_Explain, i, pLevel->iFrom, 0, zMsg, P4_DYNAMIC);
drhecc92422005-09-10 16:46:12 +00002329 }
2330#endif /* SQLITE_OMIT_EXPLAIN */
drh29dda4a2005-07-21 18:23:20 +00002331 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00002332 pTab = pTabItem->pTab;
danielk1977da184232006-01-05 11:34:32 +00002333 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drh7d10d5a2008-08-20 16:35:10 +00002334 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ) continue;
drh9eff6162006-06-12 21:59:13 +00002335#ifndef SQLITE_OMIT_VIRTUALTABLE
drh6d209d82006-06-27 01:54:26 +00002336 if( pLevel->pBestIdx ){
danielk197793626f42006-06-20 13:07:27 +00002337 int iCur = pTabItem->iCursor;
drh66a51672008-01-03 00:01:23 +00002338 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0,
2339 (const char*)pTab->pVtab, P4_VTAB);
drh9eff6162006-06-12 21:59:13 +00002340 }else
2341#endif
drh165be382008-12-05 02:36:33 +00002342 if( (pLevel->wsFlags & WHERE_IDX_ONLY)==0 ){
drh08c88eb2008-04-10 13:33:18 +00002343 int op = pWInfo->okOnePass ? OP_OpenWrite : OP_OpenRead;
2344 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
danielk197723432972008-11-17 16:42:00 +00002345 if( !pWInfo->okOnePass && pTab->nCol<BMS ){
danielk19779792eef2006-01-13 15:58:43 +00002346 Bitmask b = pTabItem->colUsed;
2347 int n = 0;
drh74161702006-02-24 02:53:49 +00002348 for(; b; b=b>>1, n++){}
danielk1977cd3e8f72008-03-25 09:47:35 +00002349 sqlite3VdbeChangeP2(v, sqlite3VdbeCurrentAddr(v)-2, n);
danielk19779792eef2006-01-13 15:58:43 +00002350 assert( n<=pTab->nCol );
2351 }
danielk1977c00da102006-01-07 13:21:04 +00002352 }else{
2353 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00002354 }
2355 pLevel->iTabCur = pTabItem->iCursor;
2356 if( (pIx = pLevel->pIdx)!=0 ){
danielk1977b3bf5562006-01-10 17:58:23 +00002357 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
danielk1977da184232006-01-05 11:34:32 +00002358 assert( pIx->pSchema==pTab->pSchema );
danielk1977cd3e8f72008-03-25 09:47:35 +00002359 sqlite3VdbeAddOp2(v, OP_SetNumColumns, 0, pIx->nColumn+1);
danielk1977207872a2008-01-03 07:54:23 +00002360 sqlite3VdbeAddOp4(v, OP_OpenRead, iIdxCur, pIx->tnum, iDb,
drh66a51672008-01-03 00:01:23 +00002361 (char*)pKey, P4_KEYINFO_HANDOFF);
danielk1977207872a2008-01-03 07:54:23 +00002362 VdbeComment((v, "%s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00002363 }
danielk1977da184232006-01-05 11:34:32 +00002364 sqlite3CodeVerifySchema(pParse, iDb);
drh9012bcb2004-12-19 00:11:35 +00002365 }
2366 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
2367
drh29dda4a2005-07-21 18:23:20 +00002368 /* Generate the code to do the search. Each iteration of the for
2369 ** loop below generates code for a single nested loop of the VM
2370 ** program.
drh75897232000-05-29 14:26:00 +00002371 */
drhfe05af82005-07-21 03:14:59 +00002372 notReady = ~(Bitmask)0;
drh29dda4a2005-07-21 18:23:20 +00002373 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
drh31daa632008-10-25 15:03:20 +00002374 int j, k;
drh9012bcb2004-12-19 00:11:35 +00002375 int iCur = pTabItem->iCursor; /* The VDBE cursor for the table */
2376 Index *pIdx; /* The index we will be using */
drhb3190c12008-12-08 21:37:14 +00002377 int addrNxt; /* Where to jump to continue with the next IN case */
drh9012bcb2004-12-19 00:11:35 +00002378 int iIdxCur; /* The VDBE cursor for the index */
2379 int omitTable; /* True if we use the index only */
drh29dda4a2005-07-21 18:23:20 +00002380 int bRev; /* True if we need to scan in reverse order */
drh9012bcb2004-12-19 00:11:35 +00002381
drh29dda4a2005-07-21 18:23:20 +00002382 pTabItem = &pTabList->a[pLevel->iFrom];
2383 iCur = pTabItem->iCursor;
drh9012bcb2004-12-19 00:11:35 +00002384 pIdx = pLevel->pIdx;
2385 iIdxCur = pLevel->iIdxCur;
drh165be382008-12-05 02:36:33 +00002386 bRev = (pLevel->wsFlags & WHERE_REVERSE)!=0;
2387 omitTable = (pLevel->wsFlags & WHERE_IDX_ONLY)!=0;
drh75897232000-05-29 14:26:00 +00002388
drh29dda4a2005-07-21 18:23:20 +00002389 /* Create labels for the "break" and "continue" instructions
drhb3190c12008-12-08 21:37:14 +00002390 ** for the current loop. Jump to addrBrk to break out of a loop.
drh29dda4a2005-07-21 18:23:20 +00002391 ** Jump to cont to go immediately to the next iteration of the
2392 ** loop.
drh72e8fa42007-03-28 14:30:06 +00002393 **
drhb3190c12008-12-08 21:37:14 +00002394 ** When there is an IN operator, we also have a "addrNxt" label that
drh72e8fa42007-03-28 14:30:06 +00002395 ** means to continue with the next IN value combination. When
drhb3190c12008-12-08 21:37:14 +00002396 ** there are no IN operators in the constraints, the "addrNxt" label
2397 ** is the same as "addrBrk".
drh29dda4a2005-07-21 18:23:20 +00002398 */
drhb3190c12008-12-08 21:37:14 +00002399 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
2400 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
drh29dda4a2005-07-21 18:23:20 +00002401
drhad2d8302002-05-24 20:31:36 +00002402 /* If this is the right table of a LEFT OUTER JOIN, allocate and
drh174b6192002-12-03 02:22:52 +00002403 ** initialize a memory cell that records if this table matches any
drhc27a1ce2002-06-14 20:58:45 +00002404 ** row of the left table of the join.
drhad2d8302002-05-24 20:31:36 +00002405 */
drh61dfc312006-12-16 16:25:15 +00002406 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
drh0a07c102008-01-03 18:03:08 +00002407 pLevel->iLeftJoin = ++pParse->nMem;
drh4c583122008-01-04 22:01:03 +00002408 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
drhd4e70eb2008-01-02 00:34:36 +00002409 VdbeComment((v, "init LEFT JOIN no-match flag"));
drhad2d8302002-05-24 20:31:36 +00002410 }
2411
drh9eff6162006-06-12 21:59:13 +00002412#ifndef SQLITE_OMIT_VIRTUALTABLE
drh6d209d82006-06-27 01:54:26 +00002413 if( pLevel->pBestIdx ){
drh7f375902006-06-13 17:38:59 +00002414 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
2415 ** to access the data.
2416 */
danielk19776dbee812008-01-03 18:39:41 +00002417 int iReg; /* P3 Value for OP_VFilter */
drh6d209d82006-06-27 01:54:26 +00002418 sqlite3_index_info *pBestIdx = pLevel->pBestIdx;
2419 int nConstraint = pBestIdx->nConstraint;
drh4be8b512006-06-13 23:51:34 +00002420 struct sqlite3_index_constraint_usage *aUsage =
drh6d209d82006-06-27 01:54:26 +00002421 pBestIdx->aConstraintUsage;
drh4be8b512006-06-13 23:51:34 +00002422 const struct sqlite3_index_constraint *aConstraint =
drh6d209d82006-06-27 01:54:26 +00002423 pBestIdx->aConstraint;
drh4be8b512006-06-13 23:51:34 +00002424
drh1db639c2008-01-17 02:36:28 +00002425 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
danielk19772d1a8d22008-05-16 15:40:40 +00002426 pParse->disableColCache++;
drh9861a9f2006-06-27 02:33:40 +00002427 for(j=1; j<=nConstraint; j++){
drh9861a9f2006-06-27 02:33:40 +00002428 for(k=0; k<nConstraint; k++){
2429 if( aUsage[k].argvIndex==j ){
danielk19773851a652006-06-27 12:16:56 +00002430 int iTerm = aConstraint[k].iTermOffset;
drh174edc62008-05-29 05:23:41 +00002431 assert( pParse->disableColCache );
drh1db639c2008-01-17 02:36:28 +00002432 sqlite3ExprCode(pParse, wc.a[iTerm].pExpr->pRight, iReg+j+1);
drh9eff6162006-06-12 21:59:13 +00002433 break;
2434 }
2435 }
drh9861a9f2006-06-27 02:33:40 +00002436 if( k==nConstraint ) break;
drh9eff6162006-06-12 21:59:13 +00002437 }
drh174edc62008-05-29 05:23:41 +00002438 assert( pParse->disableColCache );
danielk19772d1a8d22008-05-16 15:40:40 +00002439 pParse->disableColCache--;
drh4c583122008-01-04 22:01:03 +00002440 sqlite3VdbeAddOp2(v, OP_Integer, pBestIdx->idxNum, iReg);
2441 sqlite3VdbeAddOp2(v, OP_Integer, j-1, iReg+1);
drhb3190c12008-12-08 21:37:14 +00002442 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrBrk, iReg, pBestIdx->idxStr,
drh66a51672008-01-03 00:01:23 +00002443 pBestIdx->needToFreeIdxStr ? P4_MPRINTF : P4_STATIC);
drh1db639c2008-01-17 02:36:28 +00002444 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drh6d209d82006-06-27 01:54:26 +00002445 pBestIdx->needToFreeIdxStr = 0;
drh174edc62008-05-29 05:23:41 +00002446 for(j=0; j<nConstraint; j++){
drh9861a9f2006-06-27 02:33:40 +00002447 if( aUsage[j].omit ){
2448 int iTerm = aConstraint[j].iTermOffset;
2449 disableTerm(pLevel, &wc.a[iTerm]);
drh9eff6162006-06-12 21:59:13 +00002450 }
2451 }
2452 pLevel->op = OP_VNext;
drha967e882006-06-13 01:04:52 +00002453 pLevel->p1 = iCur;
2454 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh9eff6162006-06-12 21:59:13 +00002455 }else
2456#endif /* SQLITE_OMIT_VIRTUALTABLE */
2457
drh165be382008-12-05 02:36:33 +00002458 if( pLevel->wsFlags & WHERE_ROWID_EQ ){
drh8aff1012001-12-22 14:49:24 +00002459 /* Case 1: We can directly reference a single row using an
drhc27a1ce2002-06-14 20:58:45 +00002460 ** equality comparison against the ROWID field. Or
2461 ** we reference multiple rows using a "rowid IN (...)"
2462 ** construct.
drhc4a3c772001-04-04 11:48:57 +00002463 */
drh1db639c2008-01-17 02:36:28 +00002464 int r1;
danielk19772d605492008-10-01 08:43:03 +00002465 int rtmp = sqlite3GetTempReg(pParse);
drhfe05af82005-07-21 03:14:59 +00002466 pTerm = findTerm(&wc, iCur, -1, notReady, WO_EQ|WO_IN, 0);
2467 assert( pTerm!=0 );
drh0fcef5e2005-07-19 17:38:22 +00002468 assert( pTerm->pExpr!=0 );
2469 assert( pTerm->leftCursor==iCur );
drh9012bcb2004-12-19 00:11:35 +00002470 assert( omitTable==0 );
danielk19772d605492008-10-01 08:43:03 +00002471 r1 = codeEqualityTerm(pParse, pTerm, pLevel, rtmp);
drhb3190c12008-12-08 21:37:14 +00002472 addrNxt = pLevel->addrNxt;
2473 sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, addrNxt);
2474 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, r1);
danielk19772d605492008-10-01 08:43:03 +00002475 sqlite3ReleaseTempReg(pParse, rtmp);
tpoindex7a9b1612005-01-03 18:13:18 +00002476 VdbeComment((v, "pk"));
drh6b563442001-11-07 16:48:26 +00002477 pLevel->op = OP_Noop;
drh165be382008-12-05 02:36:33 +00002478 }else if( pLevel->wsFlags & WHERE_ROWID_RANGE ){
drh51147ba2005-07-23 22:59:55 +00002479 /* Case 2: We have an inequality comparison against the ROWID field.
drh8aff1012001-12-22 14:49:24 +00002480 */
2481 int testOp = OP_Noop;
2482 int start;
drhfe05af82005-07-21 03:14:59 +00002483 WhereTerm *pStart, *pEnd;
drh8aff1012001-12-22 14:49:24 +00002484
drh9012bcb2004-12-19 00:11:35 +00002485 assert( omitTable==0 );
drha6110402005-07-28 20:51:19 +00002486 pStart = findTerm(&wc, iCur, -1, notReady, WO_GT|WO_GE, 0);
2487 pEnd = findTerm(&wc, iCur, -1, notReady, WO_LT|WO_LE, 0);
drhfe05af82005-07-21 03:14:59 +00002488 if( bRev ){
2489 pTerm = pStart;
2490 pStart = pEnd;
2491 pEnd = pTerm;
2492 }
2493 if( pStart ){
drh94a11212004-09-25 13:12:14 +00002494 Expr *pX;
danielk19773072c5e2008-11-03 09:06:05 +00002495 int r1;
drhfe05af82005-07-21 03:14:59 +00002496 pX = pStart->pExpr;
drh94a11212004-09-25 13:12:14 +00002497 assert( pX!=0 );
drhfe05af82005-07-21 03:14:59 +00002498 assert( pStart->leftCursor==iCur );
danielk19773072c5e2008-11-03 09:06:05 +00002499
2500 /* The ForceInt instruction may modify the register that it operates
2501 ** on. For example it may replace a real value with an integer one,
2502 ** or if p3 is true it may increment the register value. For this
2503 ** reason we need to make sure that register r1 is really a newly
2504 ** allocated temporary register, and not part of the column-cache.
2505 ** For this reason we cannot use sqlite3ExprCodeTemp() here.
2506 */
2507 r1 = sqlite3GetTempReg(pParse);
2508 sqlite3ExprCode(pParse, pX->pRight, r1);
2509
drhb3190c12008-12-08 21:37:14 +00002510 sqlite3VdbeAddOp3(v, OP_ForceInt, r1, addrBrk,
drh41c2bf02008-01-05 05:38:21 +00002511 pX->op==TK_LE || pX->op==TK_GT);
drhb3190c12008-12-08 21:37:14 +00002512 sqlite3VdbeAddOp3(v, bRev ? OP_MoveLt : OP_MoveGe, iCur, addrBrk, r1);
tpoindex7a9b1612005-01-03 18:13:18 +00002513 VdbeComment((v, "pk"));
danielk19773072c5e2008-11-03 09:06:05 +00002514 sqlite3ReleaseTempReg(pParse, r1);
drhfe05af82005-07-21 03:14:59 +00002515 disableTerm(pLevel, pStart);
drh8aff1012001-12-22 14:49:24 +00002516 }else{
drhb3190c12008-12-08 21:37:14 +00002517 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
drh8aff1012001-12-22 14:49:24 +00002518 }
drhfe05af82005-07-21 03:14:59 +00002519 if( pEnd ){
drh94a11212004-09-25 13:12:14 +00002520 Expr *pX;
drhfe05af82005-07-21 03:14:59 +00002521 pX = pEnd->pExpr;
drh94a11212004-09-25 13:12:14 +00002522 assert( pX!=0 );
drhfe05af82005-07-21 03:14:59 +00002523 assert( pEnd->leftCursor==iCur );
drh0a07c102008-01-03 18:03:08 +00002524 pLevel->iMem = ++pParse->nMem;
drh1db639c2008-01-17 02:36:28 +00002525 sqlite3ExprCode(pParse, pX->pRight, pLevel->iMem);
drh94a11212004-09-25 13:12:14 +00002526 if( pX->op==TK_LT || pX->op==TK_GT ){
drhb6c29892004-11-22 19:12:19 +00002527 testOp = bRev ? OP_Le : OP_Ge;
drh8aff1012001-12-22 14:49:24 +00002528 }else{
drhb6c29892004-11-22 19:12:19 +00002529 testOp = bRev ? OP_Lt : OP_Gt;
drh8aff1012001-12-22 14:49:24 +00002530 }
drhfe05af82005-07-21 03:14:59 +00002531 disableTerm(pLevel, pEnd);
drh8aff1012001-12-22 14:49:24 +00002532 }
danielk19774adee202004-05-08 08:23:19 +00002533 start = sqlite3VdbeCurrentAddr(v);
drhb6c29892004-11-22 19:12:19 +00002534 pLevel->op = bRev ? OP_Prev : OP_Next;
drh6a3ea0e2003-05-02 14:32:12 +00002535 pLevel->p1 = iCur;
drh8aff1012001-12-22 14:49:24 +00002536 pLevel->p2 = start;
2537 if( testOp!=OP_Noop ){
drh1db639c2008-01-17 02:36:28 +00002538 int r1 = sqlite3GetTempReg(pParse);
2539 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, r1);
2540 /* sqlite3VdbeAddOp2(v, OP_SCopy, pLevel->iMem, 0); */
drhb3190c12008-12-08 21:37:14 +00002541 sqlite3VdbeAddOp3(v, testOp, pLevel->iMem, addrBrk, r1);
drh35573352008-01-08 23:54:25 +00002542 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
drh1db639c2008-01-17 02:36:28 +00002543 sqlite3ReleaseTempReg(pParse, r1);
drh8aff1012001-12-22 14:49:24 +00002544 }
drh165be382008-12-05 02:36:33 +00002545 }else if( pLevel->wsFlags & (WHERE_COLUMN_RANGE|WHERE_COLUMN_EQ) ){
danielk1977b790c6c2008-04-18 10:25:24 +00002546 /* Case 3: A scan using an index.
2547 **
drh981642f2008-04-19 14:40:43 +00002548 ** The WHERE clause may contain zero or more equality
danielk1977b790c6c2008-04-18 10:25:24 +00002549 ** terms ("==" or "IN" operators) that refer to the N
2550 ** left-most columns of the index. It may also contain
2551 ** inequality constraints (>, <, >= or <=) on the indexed
2552 ** column that immediately follows the N equalities. Only
2553 ** the right-most column can be an inequality - the rest must
2554 ** use the "==" and "IN" operators. For example, if the
2555 ** index is on (x,y,z), then the following clauses are all
2556 ** optimized:
2557 **
2558 ** x=5
2559 ** x=5 AND y=10
2560 ** x=5 AND y<10
2561 ** x=5 AND y>5 AND y<10
2562 ** x=5 AND y=5 AND z<=10
2563 **
drh981642f2008-04-19 14:40:43 +00002564 ** The z<10 term of the following cannot be used, only
2565 ** the x=5 term:
danielk1977b790c6c2008-04-18 10:25:24 +00002566 **
2567 ** x=5 AND z<10
drhe3184742002-06-19 14:27:05 +00002568 **
drh981642f2008-04-19 14:40:43 +00002569 ** N may be zero if there are inequality constraints.
2570 ** If there are no inequality constraints, then N is at
2571 ** least one.
2572 **
drhe3184742002-06-19 14:27:05 +00002573 ** This case is also used when there are no WHERE clause
2574 ** constraints but an index is selected anyway, in order
2575 ** to force the output order to conform to an ORDER BY.
danielk1977b790c6c2008-04-18 10:25:24 +00002576 */
danielk1977751de562008-04-18 09:01:15 +00002577 int aStartOp[] = {
2578 0,
2579 0,
danielk1977b790c6c2008-04-18 10:25:24 +00002580 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
2581 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
danielk1977751de562008-04-18 09:01:15 +00002582 OP_MoveGt, /* 4: (start_constraints && !startEq && !bRev) */
danielk1977b790c6c2008-04-18 10:25:24 +00002583 OP_MoveLt, /* 5: (start_constraints && !startEq && bRev) */
danielk1977751de562008-04-18 09:01:15 +00002584 OP_MoveGe, /* 6: (start_constraints && startEq && !bRev) */
danielk1977b790c6c2008-04-18 10:25:24 +00002585 OP_MoveLe /* 7: (start_constraints && startEq && bRev) */
danielk1977751de562008-04-18 09:01:15 +00002586 };
2587 int aEndOp[] = {
danielk1977b790c6c2008-04-18 10:25:24 +00002588 OP_Noop, /* 0: (!end_constraints) */
danielk1977751de562008-04-18 09:01:15 +00002589 OP_IdxGE, /* 1: (end_constraints && !bRev) */
2590 OP_IdxLT /* 2: (end_constraints && bRev) */
2591 };
drh51147ba2005-07-23 22:59:55 +00002592 int nEq = pLevel->nEq;
danielk1977751de562008-04-18 09:01:15 +00002593 int isMinQuery = 0; /* If this is an optimized SELECT min(x).. */
2594 int regBase; /* Base register holding constraint values */
2595 int r1; /* Temp register */
2596 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
2597 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
2598 int startEq; /* True if range start uses ==, >= or <= */
2599 int endEq; /* True if range end uses ==, >= or <= */
2600 int start_constraints; /* Start of range is constrained */
drh981642f2008-04-19 14:40:43 +00002601 int nConstraint; /* Number of constraint terms */
danielk1977751de562008-04-18 09:01:15 +00002602 int op;
drh487ab3c2001-11-08 00:45:21 +00002603
drhec1724e2008-12-09 01:32:03 +00002604 k = pIdx->aiColumn[nEq]; /* Column for inequality constraints */
2605
drh51147ba2005-07-23 22:59:55 +00002606 /* Generate code to evaluate all constraint terms using == or IN
danielk1977751de562008-04-18 09:01:15 +00002607 ** and store the values of those terms in an array of registers
2608 ** starting at regBase.
drh487ab3c2001-11-08 00:45:21 +00002609 */
drh1db639c2008-01-17 02:36:28 +00002610 regBase = codeAllEqualityTerms(pParse, pLevel, &wc, notReady, 2);
drhb3190c12008-12-08 21:37:14 +00002611 addrNxt = pLevel->addrNxt;
drh85eeb692005-12-21 03:16:42 +00002612
danielk1977a9d1ccb2008-01-05 17:39:29 +00002613 /* If this loop satisfies a sort order (pOrderBy) request that
2614 ** was passed to this function to implement a "SELECT min(x) ..."
2615 ** query, then the caller will only allow the loop to run for
2616 ** a single iteration. This means that the first row returned
2617 ** should not have a NULL value stored in 'x'. If column 'x' is
2618 ** the first one after the nEq equality constraints in the index,
2619 ** this requires some special handling.
2620 */
drh165be382008-12-05 02:36:33 +00002621 if( (wctrlFlags&WHERE_ORDERBY_MIN)!=0
2622 && (pLevel->wsFlags&WHERE_ORDERBY)
danielk1977a9d1ccb2008-01-05 17:39:29 +00002623 && (pIdx->nColumn>nEq)
danielk1977a9d1ccb2008-01-05 17:39:29 +00002624 ){
drh0880a742008-07-08 18:05:26 +00002625 assert( pOrderBy->nExpr==1 );
2626 assert( pOrderBy->a[0].pExpr->iColumn==pIdx->aiColumn[nEq] );
danielk1977a9d1ccb2008-01-05 17:39:29 +00002627 isMinQuery = 1;
2628 }
2629
danielk1977b790c6c2008-04-18 10:25:24 +00002630 /* Find any inequality constraint terms for the start and end
danielk1977751de562008-04-18 09:01:15 +00002631 ** of the range.
drh487ab3c2001-11-08 00:45:21 +00002632 */
drh165be382008-12-05 02:36:33 +00002633 if( pLevel->wsFlags & WHERE_TOP_LIMIT ){
danielk1977751de562008-04-18 09:01:15 +00002634 pRangeEnd = findTerm(&wc, iCur, k, notReady, (WO_LT|WO_LE), pIdx);
drh487ab3c2001-11-08 00:45:21 +00002635 }
drh165be382008-12-05 02:36:33 +00002636 if( pLevel->wsFlags & WHERE_BTM_LIMIT ){
danielk1977751de562008-04-18 09:01:15 +00002637 pRangeStart = findTerm(&wc, iCur, k, notReady, (WO_GT|WO_GE), pIdx);
drh487ab3c2001-11-08 00:45:21 +00002638 }
2639
danielk1977751de562008-04-18 09:01:15 +00002640 /* If we are doing a reverse order scan on an ascending index, or
2641 ** a forward order scan on a descending index, interchange the
2642 ** start and end terms (pRangeStart and pRangeEnd).
drh487ab3c2001-11-08 00:45:21 +00002643 */
drh981642f2008-04-19 14:40:43 +00002644 if( bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC) ){
danielk1977751de562008-04-18 09:01:15 +00002645 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
drh487ab3c2001-11-08 00:45:21 +00002646 }
danielk1977751de562008-04-18 09:01:15 +00002647
drh981642f2008-04-19 14:40:43 +00002648 testcase( pRangeStart && pRangeStart->eOperator & WO_LE );
2649 testcase( pRangeStart && pRangeStart->eOperator & WO_GE );
2650 testcase( pRangeEnd && pRangeEnd->eOperator & WO_LE );
2651 testcase( pRangeEnd && pRangeEnd->eOperator & WO_GE );
2652 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
2653 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
2654 start_constraints = pRangeStart || nEq>0;
danielk1977751de562008-04-18 09:01:15 +00002655
2656 /* Seek the index cursor to the start of the range. */
drh981642f2008-04-19 14:40:43 +00002657 nConstraint = nEq;
danielk1977751de562008-04-18 09:01:15 +00002658 if( pRangeStart ){
2659 int dcc = pParse->disableColCache;
2660 if( pRangeEnd ){
drh174edc62008-05-29 05:23:41 +00002661 pParse->disableColCache++;
danielk1977751de562008-04-18 09:01:15 +00002662 }
2663 sqlite3ExprCode(pParse, pRangeStart->pExpr->pRight, regBase+nEq);
2664 pParse->disableColCache = dcc;
drhb3190c12008-12-08 21:37:14 +00002665 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
drh981642f2008-04-19 14:40:43 +00002666 nConstraint++;
danielk1977751de562008-04-18 09:01:15 +00002667 }else if( isMinQuery ){
2668 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
drh981642f2008-04-19 14:40:43 +00002669 nConstraint++;
danielk1977751de562008-04-18 09:01:15 +00002670 startEq = 0;
2671 start_constraints = 1;
2672 }
drh981642f2008-04-19 14:40:43 +00002673 codeApplyAffinity(pParse, regBase, nConstraint, pIdx);
danielk1977751de562008-04-18 09:01:15 +00002674 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
drh981642f2008-04-19 14:40:43 +00002675 assert( op!=0 );
2676 testcase( op==OP_Rewind );
2677 testcase( op==OP_Last );
2678 testcase( op==OP_MoveGt );
2679 testcase( op==OP_MoveGe );
2680 testcase( op==OP_MoveLe );
2681 testcase( op==OP_MoveLt );
drhb3190c12008-12-08 21:37:14 +00002682 sqlite3VdbeAddOp4(v, op, iIdxCur, addrNxt, regBase,
shane1fc41292008-07-08 22:28:48 +00002683 SQLITE_INT_TO_PTR(nConstraint), P4_INT32);
danielk1977751de562008-04-18 09:01:15 +00002684
2685 /* Load the value for the inequality constraint at the end of the
2686 ** range (if any).
2687 */
drh981642f2008-04-19 14:40:43 +00002688 nConstraint = nEq;
danielk1977751de562008-04-18 09:01:15 +00002689 if( pRangeEnd ){
2690 sqlite3ExprCode(pParse, pRangeEnd->pExpr->pRight, regBase+nEq);
drhb3190c12008-12-08 21:37:14 +00002691 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
danielk1977b790c6c2008-04-18 10:25:24 +00002692 codeApplyAffinity(pParse, regBase, nEq+1, pIdx);
drh981642f2008-04-19 14:40:43 +00002693 nConstraint++;
danielk1977751de562008-04-18 09:01:15 +00002694 }
danielk1977751de562008-04-18 09:01:15 +00002695
2696 /* Top of the loop body */
2697 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2698
2699 /* Check if the index cursor is past the end of the range. */
drh981642f2008-04-19 14:40:43 +00002700 op = aEndOp[(pRangeEnd || nEq) * (1 + bRev)];
2701 testcase( op==OP_Noop );
2702 testcase( op==OP_IdxGE );
2703 testcase( op==OP_IdxLT );
drhb3190c12008-12-08 21:37:14 +00002704 sqlite3VdbeAddOp4(v, op, iIdxCur, addrNxt, regBase,
shane1fc41292008-07-08 22:28:48 +00002705 SQLITE_INT_TO_PTR(nConstraint), P4_INT32);
drhec1724e2008-12-09 01:32:03 +00002706 sqlite3VdbeChangeP5(v, endEq!=bRev ?1:0);
danielk1977751de562008-04-18 09:01:15 +00002707
drh981642f2008-04-19 14:40:43 +00002708 /* If there are inequality constraints, check that the value
2709 ** of the table column that the inequality contrains is not NULL.
danielk1977751de562008-04-18 09:01:15 +00002710 ** If it is, jump to the next iteration of the loop.
2711 */
drh1db639c2008-01-17 02:36:28 +00002712 r1 = sqlite3GetTempReg(pParse);
drh165be382008-12-05 02:36:33 +00002713 testcase( pLevel->wsFlags & WHERE_BTM_LIMIT );
2714 testcase( pLevel->wsFlags & WHERE_TOP_LIMIT );
2715 if( pLevel->wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT) ){
drh1db639c2008-01-17 02:36:28 +00002716 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, nEq, r1);
drhb3190c12008-12-08 21:37:14 +00002717 sqlite3VdbeAddOp2(v, OP_IsNull, r1, addrCont);
drh50b39962006-10-28 00:28:09 +00002718 }
danielk1977751de562008-04-18 09:01:15 +00002719
2720 /* Seek the table cursor, if required */
drhe6f85e72004-12-25 01:03:13 +00002721 if( !omitTable ){
drh1db639c2008-01-17 02:36:28 +00002722 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, r1);
drh91fd4d42008-01-19 20:11:25 +00002723 sqlite3VdbeAddOp3(v, OP_MoveGe, iCur, 0, r1); /* Deferred seek */
drh487ab3c2001-11-08 00:45:21 +00002724 }
drh1db639c2008-01-17 02:36:28 +00002725 sqlite3ReleaseTempReg(pParse, r1);
drh487ab3c2001-11-08 00:45:21 +00002726
danielk1977751de562008-04-18 09:01:15 +00002727 /* Record the instruction used to terminate the loop. Disable
2728 ** WHERE clause terms made redundant by the index range scan.
drh487ab3c2001-11-08 00:45:21 +00002729 */
drhfe05af82005-07-21 03:14:59 +00002730 pLevel->op = bRev ? OP_Prev : OP_Next;
drh9012bcb2004-12-19 00:11:35 +00002731 pLevel->p1 = iIdxCur;
danielk1977751de562008-04-18 09:01:15 +00002732 disableTerm(pLevel, pRangeStart);
2733 disableTerm(pLevel, pRangeEnd);
drhfe05af82005-07-21 03:14:59 +00002734 }else{
drh981642f2008-04-19 14:40:43 +00002735 /* Case 4: There is no usable index. We must do a complete
drhfe05af82005-07-21 03:14:59 +00002736 ** scan of the entire table.
2737 */
drhfe05af82005-07-21 03:14:59 +00002738 assert( omitTable==0 );
drha6110402005-07-28 20:51:19 +00002739 assert( bRev==0 );
2740 pLevel->op = OP_Next;
drhfe05af82005-07-21 03:14:59 +00002741 pLevel->p1 = iCur;
drhb3190c12008-12-08 21:37:14 +00002742 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, OP_Rewind, iCur, addrBrk);
drhd1d38482008-10-07 23:46:38 +00002743 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
drh75897232000-05-29 14:26:00 +00002744 }
drhfe05af82005-07-21 03:14:59 +00002745 notReady &= ~getMask(&maskSet, iCur);
drh75897232000-05-29 14:26:00 +00002746
2747 /* Insert code to test every subexpression that can be completely
2748 ** computed using the current set of tables.
2749 */
drh31daa632008-10-25 15:03:20 +00002750 k = 0;
drh0fcef5e2005-07-19 17:38:22 +00002751 for(pTerm=wc.a, j=wc.nTerm; j>0; j--, pTerm++){
2752 Expr *pE;
drh165be382008-12-05 02:36:33 +00002753 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2754 testcase( pTerm->wtFlags & TERM_CODED );
2755 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhfe05af82005-07-21 03:14:59 +00002756 if( (pTerm->prereqAll & notReady)!=0 ) continue;
drh0fcef5e2005-07-19 17:38:22 +00002757 pE = pTerm->pExpr;
2758 assert( pE!=0 );
drh392e5972005-07-08 14:14:22 +00002759 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
drh1f162302002-10-27 19:35:33 +00002760 continue;
2761 }
drh31daa632008-10-25 15:03:20 +00002762 pParse->disableColCache += k;
drhb3190c12008-12-08 21:37:14 +00002763 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
drh31daa632008-10-25 15:03:20 +00002764 pParse->disableColCache -= k;
2765 k = 1;
drh165be382008-12-05 02:36:33 +00002766 pTerm->wtFlags |= TERM_CODED;
drh75897232000-05-29 14:26:00 +00002767 }
drhad2d8302002-05-24 20:31:36 +00002768
2769 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2770 ** at least one row of the right table has matched the left table.
2771 */
2772 if( pLevel->iLeftJoin ){
drhb3190c12008-12-08 21:37:14 +00002773 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
drh4c583122008-01-04 22:01:03 +00002774 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
drhd4e70eb2008-01-02 00:34:36 +00002775 VdbeComment((v, "record LEFT JOIN hit"));
drhe55cbd72008-03-31 23:48:03 +00002776 sqlite3ExprClearColumnCache(pParse, pLevel->iTabCur);
2777 sqlite3ExprClearColumnCache(pParse, pLevel->iIdxCur);
drh0aa74ed2005-07-16 13:33:20 +00002778 for(pTerm=wc.a, j=0; j<wc.nTerm; j++, pTerm++){
drh165be382008-12-05 02:36:33 +00002779 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2780 testcase( pTerm->wtFlags & TERM_CODED );
2781 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhfe05af82005-07-21 03:14:59 +00002782 if( (pTerm->prereqAll & notReady)!=0 ) continue;
drh0fcef5e2005-07-19 17:38:22 +00002783 assert( pTerm->pExpr );
drhb3190c12008-12-08 21:37:14 +00002784 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
drh165be382008-12-05 02:36:33 +00002785 pTerm->wtFlags |= TERM_CODED;
drh1cc093c2002-06-24 22:01:57 +00002786 }
drhad2d8302002-05-24 20:31:36 +00002787 }
drh75897232000-05-29 14:26:00 +00002788 }
drh7ec764a2005-07-21 03:48:20 +00002789
2790#ifdef SQLITE_TEST /* For testing and debugging use only */
2791 /* Record in the query plan information about the current table
2792 ** and the index used to access it (if any). If the table itself
2793 ** is not used, its name is just '{}'. If no index is used
2794 ** the index is listed as "{}". If the primary key is used the
2795 ** index name is '*'.
2796 */
2797 for(i=0; i<pTabList->nSrc; i++){
2798 char *z;
2799 int n;
drh7ec764a2005-07-21 03:48:20 +00002800 pLevel = &pWInfo->a[i];
drh29dda4a2005-07-21 18:23:20 +00002801 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00002802 z = pTabItem->zAlias;
2803 if( z==0 ) z = pTabItem->pTab->zName;
2804 n = strlen(z);
2805 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
drh165be382008-12-05 02:36:33 +00002806 if( pLevel->wsFlags & WHERE_IDX_ONLY ){
drh5bb3eb92007-05-04 13:15:55 +00002807 memcpy(&sqlite3_query_plan[nQPlan], "{}", 2);
drh7ec764a2005-07-21 03:48:20 +00002808 nQPlan += 2;
2809 }else{
drh5bb3eb92007-05-04 13:15:55 +00002810 memcpy(&sqlite3_query_plan[nQPlan], z, n);
drh7ec764a2005-07-21 03:48:20 +00002811 nQPlan += n;
2812 }
2813 sqlite3_query_plan[nQPlan++] = ' ';
2814 }
drh165be382008-12-05 02:36:33 +00002815 testcase( pLevel->wsFlags & WHERE_ROWID_EQ );
2816 testcase( pLevel->wsFlags & WHERE_ROWID_RANGE );
2817 if( pLevel->wsFlags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh5bb3eb92007-05-04 13:15:55 +00002818 memcpy(&sqlite3_query_plan[nQPlan], "* ", 2);
drh7ec764a2005-07-21 03:48:20 +00002819 nQPlan += 2;
2820 }else if( pLevel->pIdx==0 ){
drh5bb3eb92007-05-04 13:15:55 +00002821 memcpy(&sqlite3_query_plan[nQPlan], "{} ", 3);
drh7ec764a2005-07-21 03:48:20 +00002822 nQPlan += 3;
2823 }else{
2824 n = strlen(pLevel->pIdx->zName);
2825 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
drh5bb3eb92007-05-04 13:15:55 +00002826 memcpy(&sqlite3_query_plan[nQPlan], pLevel->pIdx->zName, n);
drh7ec764a2005-07-21 03:48:20 +00002827 nQPlan += n;
2828 sqlite3_query_plan[nQPlan++] = ' ';
2829 }
2830 }
2831 }
2832 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
2833 sqlite3_query_plan[--nQPlan] = 0;
2834 }
2835 sqlite3_query_plan[nQPlan] = 0;
2836 nQPlan = 0;
2837#endif /* SQLITE_TEST // Testing and debugging use only */
2838
drh29dda4a2005-07-21 18:23:20 +00002839 /* Record the continuation address in the WhereInfo structure. Then
2840 ** clean up and return.
2841 */
drhb3190c12008-12-08 21:37:14 +00002842 pWInfo->iContinue = addrCont;
drh0aa74ed2005-07-16 13:33:20 +00002843 whereClauseClear(&wc);
drh75897232000-05-29 14:26:00 +00002844 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00002845
2846 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00002847whereBeginError:
drhe23399f2005-07-22 00:31:39 +00002848 whereClauseClear(&wc);
drh10fe8402008-10-11 16:47:35 +00002849 whereInfoFree(db, pWInfo);
drhe23399f2005-07-22 00:31:39 +00002850 return 0;
drh75897232000-05-29 14:26:00 +00002851}
2852
2853/*
drhc27a1ce2002-06-14 20:58:45 +00002854** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00002855** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00002856*/
danielk19774adee202004-05-08 08:23:19 +00002857void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00002858 Parse *pParse = pWInfo->pParse;
2859 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00002860 int i;
drh6b563442001-11-07 16:48:26 +00002861 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00002862 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00002863 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00002864
drh9012bcb2004-12-19 00:11:35 +00002865 /* Generate loop termination code.
2866 */
drh633e6d52008-07-28 19:34:53 +00002867 sqlite3ExprClearColumnCache(pParse, -1);
drhad3cab52002-05-24 02:04:32 +00002868 for(i=pTabList->nSrc-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00002869 pLevel = &pWInfo->a[i];
drhb3190c12008-12-08 21:37:14 +00002870 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00002871 if( pLevel->op!=OP_Noop ){
drh66a51672008-01-03 00:01:23 +00002872 sqlite3VdbeAddOp2(v, pLevel->op, pLevel->p1, pLevel->p2);
drhd1d38482008-10-07 23:46:38 +00002873 sqlite3VdbeChangeP5(v, pLevel->p5);
drh19a775c2000-06-05 18:54:46 +00002874 }
drhe23399f2005-07-22 00:31:39 +00002875 if( pLevel->nIn ){
drh72e8fa42007-03-28 14:30:06 +00002876 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00002877 int j;
drhb3190c12008-12-08 21:37:14 +00002878 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh72e8fa42007-03-28 14:30:06 +00002879 for(j=pLevel->nIn, pIn=&pLevel->aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00002880 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
2881 sqlite3VdbeAddOp2(v, OP_Next, pIn->iCur, pIn->addrInTop);
2882 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00002883 }
drh633e6d52008-07-28 19:34:53 +00002884 sqlite3DbFree(db, pLevel->aInLoop);
drhd99f7062002-06-08 23:25:08 +00002885 }
drhb3190c12008-12-08 21:37:14 +00002886 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhad2d8302002-05-24 20:31:36 +00002887 if( pLevel->iLeftJoin ){
2888 int addr;
drh3c84ddf2008-01-09 02:15:38 +00002889 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin);
2890 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
drh9012bcb2004-12-19 00:11:35 +00002891 if( pLevel->iIdxCur>=0 ){
drh3c84ddf2008-01-09 02:15:38 +00002892 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00002893 }
drhb3190c12008-12-08 21:37:14 +00002894 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
drhd654be82005-09-20 17:42:23 +00002895 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00002896 }
drh19a775c2000-06-05 18:54:46 +00002897 }
drh9012bcb2004-12-19 00:11:35 +00002898
2899 /* The "break" point is here, just past the end of the outer loop.
2900 ** Set it.
2901 */
danielk19774adee202004-05-08 08:23:19 +00002902 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00002903
drh29dda4a2005-07-21 18:23:20 +00002904 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00002905 */
drh29dda4a2005-07-21 18:23:20 +00002906 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
2907 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00002908 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00002909 assert( pTab!=0 );
drh7d10d5a2008-08-20 16:35:10 +00002910 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ) continue;
drh165be382008-12-05 02:36:33 +00002911 if( !pWInfo->okOnePass && (pLevel->wsFlags & WHERE_IDX_ONLY)==0 ){
drh3c84ddf2008-01-09 02:15:38 +00002912 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
drh9012bcb2004-12-19 00:11:35 +00002913 }
drh6b563442001-11-07 16:48:26 +00002914 if( pLevel->pIdx!=0 ){
drh3c84ddf2008-01-09 02:15:38 +00002915 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
drh9012bcb2004-12-19 00:11:35 +00002916 }
2917
danielk197721de2e72007-11-29 17:43:27 +00002918 /* If this scan uses an index, make code substitutions to read data
2919 ** from the index in preference to the table. Sometimes, this means
2920 ** the table need never be read from. This is a performance boost,
2921 ** as the vdbe level waits until the table is read before actually
2922 ** seeking the table cursor to the record corresponding to the current
2923 ** position in the index.
drh9012bcb2004-12-19 00:11:35 +00002924 **
2925 ** Calls to the code generator in between sqlite3WhereBegin and
2926 ** sqlite3WhereEnd will have created code that references the table
2927 ** directly. This loop scans all that code looking for opcodes
2928 ** that reference the table and converts them into opcodes that
2929 ** reference the index.
2930 */
danielk197721de2e72007-11-29 17:43:27 +00002931 if( pLevel->pIdx ){
danielk1977f0113002006-01-24 12:09:17 +00002932 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00002933 VdbeOp *pOp;
2934 Index *pIdx = pLevel->pIdx;
drh165be382008-12-05 02:36:33 +00002935 int useIndexOnly = pLevel->wsFlags & WHERE_IDX_ONLY;
drh9012bcb2004-12-19 00:11:35 +00002936
2937 assert( pIdx!=0 );
2938 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
2939 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00002940 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00002941 if( pOp->p1!=pLevel->iTabCur ) continue;
2942 if( pOp->opcode==OP_Column ){
drh9012bcb2004-12-19 00:11:35 +00002943 for(j=0; j<pIdx->nColumn; j++){
2944 if( pOp->p2==pIdx->aiColumn[j] ){
2945 pOp->p2 = j;
danielk197721de2e72007-11-29 17:43:27 +00002946 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00002947 break;
2948 }
2949 }
danielk197721de2e72007-11-29 17:43:27 +00002950 assert(!useIndexOnly || j<pIdx->nColumn);
drhf0863fe2005-06-12 21:35:51 +00002951 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00002952 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00002953 pOp->opcode = OP_IdxRowid;
danielk197721de2e72007-11-29 17:43:27 +00002954 }else if( pOp->opcode==OP_NullRow && useIndexOnly ){
danielk19776c18b6e2005-01-30 09:17:58 +00002955 pOp->opcode = OP_Noop;
drh9012bcb2004-12-19 00:11:35 +00002956 }
2957 }
drh6b563442001-11-07 16:48:26 +00002958 }
drh19a775c2000-06-05 18:54:46 +00002959 }
drh9012bcb2004-12-19 00:11:35 +00002960
2961 /* Final cleanup
2962 */
drh10fe8402008-10-11 16:47:35 +00002963 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00002964 return;
2965}