blob: 2d773b78dfa91ae10e79a0cb7b1a9b6cf9171af6 [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**
drh1c767f02009-01-09 02:49:31 +000019** $Id: where.c,v 1.362 2009/01/09 02:49:32 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
drh6df2acd2008-12-28 16:55:25 +000029#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;
drh111a6a72008-12-21 03:51:16 +000038typedef struct WhereMaskSet WhereMaskSet;
drh700a2262008-12-17 19:22:15 +000039typedef struct WhereOrInfo WhereOrInfo;
40typedef struct WhereAndInfo WhereAndInfo;
drh111a6a72008-12-21 03:51:16 +000041typedef struct WhereCost WhereCost;
drh0aa74ed2005-07-16 13:33:20 +000042
43/*
drh75897232000-05-29 14:26:00 +000044** The query generator uses an array of instances of this structure to
45** help it analyze the subexpressions of the WHERE clause. Each WHERE
drh6a1e0712008-12-05 15:24:15 +000046** clause subexpression is separated from the others by AND operators.
47** (Note: the same data structure is also reused to hold a group of terms
48** separated by OR operators. But at the top-level, everything is AND
49** separated.)
drh51669862004-12-18 18:40:26 +000050**
drh0fcef5e2005-07-19 17:38:22 +000051** All WhereTerms are collected into a single WhereClause structure.
52** The following identity holds:
drh51669862004-12-18 18:40:26 +000053**
drh0fcef5e2005-07-19 17:38:22 +000054** WhereTerm.pWC->a[WhereTerm.idx] == WhereTerm
drh51669862004-12-18 18:40:26 +000055**
drh0fcef5e2005-07-19 17:38:22 +000056** When a term is of the form:
57**
58** X <op> <expr>
59**
60** where X is a column name and <op> is one of certain operators,
drh700a2262008-12-17 19:22:15 +000061** then WhereTerm.leftCursor and WhereTerm.u.leftColumn record the
62** cursor number and column number for X. WhereTerm.eOperator records
drh51147ba2005-07-23 22:59:55 +000063** the <op> using a bitmask encoding defined by WO_xxx below. The
64** use of a bitmask encoding for the operator allows us to search
65** quickly for terms that match any of several different operators.
drh0fcef5e2005-07-19 17:38:22 +000066**
drh700a2262008-12-17 19:22:15 +000067** A WhereTerm might also be two or more subterms connected by OR:
68**
69** (t1.X <op> <expr>) OR (t1.Y <op> <expr>) OR ....
70**
71** In this second case, wtFlag as the TERM_ORINFO set and eOperator==WO_OR
72** and the WhereTerm.u.pOrInfo field points to auxiliary information that
73** is collected about the
74**
75** If a term in the WHERE clause does not match either of the two previous
76** categories, then eOperator==0. The WhereTerm.pExpr field is still set
77** to the original subexpression content and wtFlags is set up appropriately
78** but no other fields in the WhereTerm object are meaningful.
79**
80** When eOperator!=0, prereqRight and prereqAll record sets of cursor numbers,
drh111a6a72008-12-21 03:51:16 +000081** but they do so indirectly. A single WhereMaskSet structure translates
drh51669862004-12-18 18:40:26 +000082** cursor number into bits and the translated bit is stored in the prereq
83** fields. The translation is used in order to maximize the number of
84** bits that will fit in a Bitmask. The VDBE cursor numbers might be
85** spread out over the non-negative integers. For example, the cursor
drh111a6a72008-12-21 03:51:16 +000086** numbers might be 3, 8, 9, 10, 20, 23, 41, and 45. The WhereMaskSet
drh51669862004-12-18 18:40:26 +000087** translates these sparse cursor numbers into consecutive integers
88** beginning with 0 in order to make the best possible use of the available
89** bits in the Bitmask. So, in the example above, the cursor numbers
90** would be mapped into integers 0 through 7.
drh6a1e0712008-12-05 15:24:15 +000091**
92** The number of terms in a join is limited by the number of bits
93** in prereqRight and prereqAll. The default is 64 bits, hence SQLite
94** is only able to process joins with 64 or fewer tables.
drh75897232000-05-29 14:26:00 +000095*/
drh0aa74ed2005-07-16 13:33:20 +000096typedef struct WhereTerm WhereTerm;
97struct WhereTerm {
drh165be382008-12-05 02:36:33 +000098 Expr *pExpr; /* Pointer to the subexpression that is this term */
drhec1724e2008-12-09 01:32:03 +000099 int iParent; /* Disable pWC->a[iParent] when this term disabled */
100 int leftCursor; /* Cursor number of X in "X <op> <expr>" */
drh700a2262008-12-17 19:22:15 +0000101 union {
102 int leftColumn; /* Column number of X in "X <op> <expr>" */
103 WhereOrInfo *pOrInfo; /* Extra information if eOperator==WO_OR */
104 WhereAndInfo *pAndInfo; /* Extra information if eOperator==WO_AND */
105 } u;
drhb52076c2006-01-23 13:22:09 +0000106 u16 eOperator; /* A WO_xx value describing <op> */
drh165be382008-12-05 02:36:33 +0000107 u8 wtFlags; /* TERM_xxx bit flags. See below */
drh45b1ee42005-08-02 17:48:22 +0000108 u8 nChild; /* Number of children that must disable us */
drh0fcef5e2005-07-19 17:38:22 +0000109 WhereClause *pWC; /* The clause this term is part of */
drh165be382008-12-05 02:36:33 +0000110 Bitmask prereqRight; /* Bitmask of tables used by pExpr->pRight */
111 Bitmask prereqAll; /* Bitmask of tables referenced by pExpr */
drh75897232000-05-29 14:26:00 +0000112};
113
114/*
drh165be382008-12-05 02:36:33 +0000115** Allowed values of WhereTerm.wtFlags
drh0aa74ed2005-07-16 13:33:20 +0000116*/
drh633e6d52008-07-28 19:34:53 +0000117#define TERM_DYNAMIC 0x01 /* Need to call sqlite3ExprDelete(db, pExpr) */
drh6c30be82005-07-29 15:10:17 +0000118#define TERM_VIRTUAL 0x02 /* Added by the optimizer. Do not code */
119#define TERM_CODED 0x04 /* This term is already coded */
drh45b1ee42005-08-02 17:48:22 +0000120#define TERM_COPIED 0x08 /* Has a child */
drh700a2262008-12-17 19:22:15 +0000121#define TERM_ORINFO 0x10 /* Need to free the WhereTerm.u.pOrInfo object */
122#define TERM_ANDINFO 0x20 /* Need to free the WhereTerm.u.pAndInfo obj */
123#define TERM_OR_OK 0x40 /* Used during OR-clause processing */
drh0aa74ed2005-07-16 13:33:20 +0000124
125/*
126** An instance of the following structure holds all information about a
127** WHERE clause. Mostly this is a container for one or more WhereTerms.
128*/
drh0aa74ed2005-07-16 13:33:20 +0000129struct WhereClause {
drhfe05af82005-07-21 03:14:59 +0000130 Parse *pParse; /* The parser context */
drh111a6a72008-12-21 03:51:16 +0000131 WhereMaskSet *pMaskSet; /* Mapping of table cursor numbers to bitmasks */
drh29435252008-12-28 18:35:08 +0000132 u8 op; /* Split operator. TK_AND or TK_OR */
drh0aa74ed2005-07-16 13:33:20 +0000133 int nTerm; /* Number of terms */
134 int nSlot; /* Number of entries in a[] */
drh51147ba2005-07-23 22:59:55 +0000135 WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
drhec1724e2008-12-09 01:32:03 +0000136 WhereTerm aStatic[4]; /* Initial static space for a[] */
drhe23399f2005-07-22 00:31:39 +0000137};
138
139/*
drh700a2262008-12-17 19:22:15 +0000140** A WhereTerm with eOperator==WO_OR has its u.pOrInfo pointer set to
141** a dynamically allocated instance of the following structure.
142*/
143struct WhereOrInfo {
drh111a6a72008-12-21 03:51:16 +0000144 WhereClause wc; /* Decomposition into subterms */
drh1a58fe02008-12-20 02:06:13 +0000145 Bitmask indexable; /* Bitmask of all indexable tables in the clause */
drh700a2262008-12-17 19:22:15 +0000146};
147
148/*
149** A WhereTerm with eOperator==WO_AND has its u.pAndInfo pointer set to
150** a dynamically allocated instance of the following structure.
151*/
152struct WhereAndInfo {
drh29435252008-12-28 18:35:08 +0000153 WhereClause wc; /* The subexpression broken out */
drh700a2262008-12-17 19:22:15 +0000154};
155
156/*
drh6a3ea0e2003-05-02 14:32:12 +0000157** An instance of the following structure keeps track of a mapping
drh0aa74ed2005-07-16 13:33:20 +0000158** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
drh51669862004-12-18 18:40:26 +0000159**
160** The VDBE cursor numbers are small integers contained in
161** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
162** clause, the cursor numbers might not begin with 0 and they might
163** contain gaps in the numbering sequence. But we want to make maximum
164** use of the bits in our bitmasks. This structure provides a mapping
165** from the sparse cursor numbers into consecutive integers beginning
166** with 0.
167**
drh111a6a72008-12-21 03:51:16 +0000168** If WhereMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
drh51669862004-12-18 18:40:26 +0000169** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
170**
171** For example, if the WHERE clause expression used these VDBE
drh111a6a72008-12-21 03:51:16 +0000172** cursors: 4, 5, 8, 29, 57, 73. Then the WhereMaskSet structure
drh51669862004-12-18 18:40:26 +0000173** would map those cursor numbers into bits 0 through 5.
174**
175** Note that the mapping is not necessarily ordered. In the example
176** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
177** 57->5, 73->4. Or one of 719 other combinations might be used. It
178** does not really matter. What is important is that sparse cursor
179** numbers all get mapped into bit numbers that begin with 0 and contain
180** no gaps.
drh6a3ea0e2003-05-02 14:32:12 +0000181*/
drh111a6a72008-12-21 03:51:16 +0000182struct WhereMaskSet {
drh1398ad32005-01-19 23:24:50 +0000183 int n; /* Number of assigned cursor values */
danielk197723432972008-11-17 16:42:00 +0000184 int ix[BMS]; /* Cursor assigned to each bit */
drh6a3ea0e2003-05-02 14:32:12 +0000185};
186
drh111a6a72008-12-21 03:51:16 +0000187/*
188** A WhereCost object records a lookup strategy and the estimated
189** cost of pursuing that strategy.
190*/
191struct WhereCost {
192 WherePlan plan; /* The lookup strategy */
193 double rCost; /* Overall cost of pursuing this search strategy */
194 double nRow; /* Estimated number of output rows */
195};
drh0aa74ed2005-07-16 13:33:20 +0000196
drh6a3ea0e2003-05-02 14:32:12 +0000197/*
drh51147ba2005-07-23 22:59:55 +0000198** Bitmasks for the operators that indices are able to exploit. An
199** OR-ed combination of these values can be used when searching for
200** terms in the where clause.
201*/
drh165be382008-12-05 02:36:33 +0000202#define WO_IN 0x001
203#define WO_EQ 0x002
drh51147ba2005-07-23 22:59:55 +0000204#define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
205#define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
206#define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
207#define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
drh165be382008-12-05 02:36:33 +0000208#define WO_MATCH 0x040
209#define WO_ISNULL 0x080
drh700a2262008-12-17 19:22:15 +0000210#define WO_OR 0x100 /* Two or more OR-connected terms */
211#define WO_AND 0x200 /* Two or more AND-connected terms */
drh51147ba2005-07-23 22:59:55 +0000212
drhec1724e2008-12-09 01:32:03 +0000213#define WO_ALL 0xfff /* Mask of all possible WO_* values */
drh1a58fe02008-12-20 02:06:13 +0000214#define WO_SINGLE 0x0ff /* Mask of all non-compound WO_* values */
drhec1724e2008-12-09 01:32:03 +0000215
drh51147ba2005-07-23 22:59:55 +0000216/*
drh700a2262008-12-17 19:22:15 +0000217** Value for wsFlags returned by bestIndex() and stored in
218** WhereLevel.wsFlags. These flags determine which search
219** strategies are appropriate.
drhf2d315d2007-01-25 16:56:06 +0000220**
drh165be382008-12-05 02:36:33 +0000221** The least significant 12 bits is reserved as a mask for WO_ values above.
drh700a2262008-12-17 19:22:15 +0000222** The WhereLevel.wsFlags field is usually set to WO_IN|WO_EQ|WO_ISNULL.
223** But if the table is the right table of a left join, WhereLevel.wsFlags
224** is set to WO_IN|WO_EQ. The WhereLevel.wsFlags field can then be used as
drhf2d315d2007-01-25 16:56:06 +0000225** the "op" parameter to findTerm when we are resolving equality constraints.
226** ISNULL constraints will then not be used on the right table of a left
227** join. Tickets #2177 and #2189.
drh51147ba2005-07-23 22:59:55 +0000228*/
drh165be382008-12-05 02:36:33 +0000229#define WHERE_ROWID_EQ 0x00001000 /* rowid=EXPR or rowid IN (...) */
230#define WHERE_ROWID_RANGE 0x00002000 /* rowid<EXPR and/or rowid>EXPR */
231#define WHERE_COLUMN_EQ 0x00010000 /* x=EXPR or x IN (...) */
232#define WHERE_COLUMN_RANGE 0x00020000 /* x<EXPR and/or x>EXPR */
233#define WHERE_COLUMN_IN 0x00040000 /* x IN (...) */
drh111a6a72008-12-21 03:51:16 +0000234#define WHERE_INDEXED 0x00070000 /* Anything that uses an index */
235#define WHERE_IN_ABLE 0x00071000 /* Able to support an IN operator */
drh165be382008-12-05 02:36:33 +0000236#define WHERE_TOP_LIMIT 0x00100000 /* x<EXPR or x<=EXPR constraint */
237#define WHERE_BTM_LIMIT 0x00200000 /* x>EXPR or x>=EXPR constraint */
238#define WHERE_IDX_ONLY 0x00800000 /* Use index only - omit table */
239#define WHERE_ORDERBY 0x01000000 /* Output will appear in correct order */
240#define WHERE_REVERSE 0x02000000 /* Scan in reverse order */
241#define WHERE_UNIQUE 0x04000000 /* Selects no more than one row */
242#define WHERE_VIRTUALTABLE 0x08000000 /* Use virtual-table processing */
243#define WHERE_MULTI_OR 0x10000000 /* OR using multiple indices */
drh51147ba2005-07-23 22:59:55 +0000244
245/*
drh0aa74ed2005-07-16 13:33:20 +0000246** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000247*/
drh7b4fc6a2007-02-06 13:26:32 +0000248static void whereClauseInit(
249 WhereClause *pWC, /* The WhereClause to be initialized */
250 Parse *pParse, /* The parsing context */
drh111a6a72008-12-21 03:51:16 +0000251 WhereMaskSet *pMaskSet /* Mapping from table cursor numbers to bitmasks */
drh7b4fc6a2007-02-06 13:26:32 +0000252){
drhfe05af82005-07-21 03:14:59 +0000253 pWC->pParse = pParse;
drh7b4fc6a2007-02-06 13:26:32 +0000254 pWC->pMaskSet = pMaskSet;
drh0aa74ed2005-07-16 13:33:20 +0000255 pWC->nTerm = 0;
drhcad651e2007-04-20 12:22:01 +0000256 pWC->nSlot = ArraySize(pWC->aStatic);
drh0aa74ed2005-07-16 13:33:20 +0000257 pWC->a = pWC->aStatic;
258}
259
drh700a2262008-12-17 19:22:15 +0000260/* Forward reference */
261static void whereClauseClear(WhereClause*);
262
263/*
264** Deallocate all memory associated with a WhereOrInfo object.
265*/
266static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000267 whereClauseClear(&p->wc);
268 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000269}
270
271/*
272** Deallocate all memory associated with a WhereAndInfo object.
273*/
274static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000275 whereClauseClear(&p->wc);
276 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000277}
278
drh0aa74ed2005-07-16 13:33:20 +0000279/*
280** Deallocate a WhereClause structure. The WhereClause structure
281** itself is not freed. This routine is the inverse of whereClauseInit().
282*/
283static void whereClauseClear(WhereClause *pWC){
284 int i;
285 WhereTerm *a;
drh633e6d52008-07-28 19:34:53 +0000286 sqlite3 *db = pWC->pParse->db;
drh0aa74ed2005-07-16 13:33:20 +0000287 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
drh165be382008-12-05 02:36:33 +0000288 if( a->wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000289 sqlite3ExprDelete(db, a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000290 }
drh700a2262008-12-17 19:22:15 +0000291 if( a->wtFlags & TERM_ORINFO ){
292 whereOrInfoDelete(db, a->u.pOrInfo);
293 }else if( a->wtFlags & TERM_ANDINFO ){
294 whereAndInfoDelete(db, a->u.pAndInfo);
295 }
drh0aa74ed2005-07-16 13:33:20 +0000296 }
297 if( pWC->a!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000298 sqlite3DbFree(db, pWC->a);
drh0aa74ed2005-07-16 13:33:20 +0000299 }
300}
301
302/*
drh6a1e0712008-12-05 15:24:15 +0000303** Add a single new WhereTerm entry to the WhereClause object pWC.
304** The new WhereTerm object is constructed from Expr p and with wtFlags.
305** The index in pWC->a[] of the new WhereTerm is returned on success.
306** 0 is returned if the new WhereTerm could not be added due to a memory
307** allocation error. The memory allocation failure will be recorded in
308** the db->mallocFailed flag so that higher-level functions can detect it.
309**
310** This routine will increase the size of the pWC->a[] array as necessary.
drh9eb20282005-08-24 03:52:18 +0000311**
drh165be382008-12-05 02:36:33 +0000312** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
drh6a1e0712008-12-05 15:24:15 +0000313** for freeing the expression p is assumed by the WhereClause object pWC.
314** This is true even if this routine fails to allocate a new WhereTerm.
drhb63a53d2007-03-31 01:34:44 +0000315**
drh9eb20282005-08-24 03:52:18 +0000316** WARNING: This routine might reallocate the space used to store
drh909626d2008-05-30 14:58:37 +0000317** WhereTerms. All pointers to WhereTerms should be invalidated after
drh9eb20282005-08-24 03:52:18 +0000318** calling this routine. Such pointers may be reinitialized by referencing
319** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000320*/
drhec1724e2008-12-09 01:32:03 +0000321static int whereClauseInsert(WhereClause *pWC, Expr *p, u8 wtFlags){
drh0aa74ed2005-07-16 13:33:20 +0000322 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000323 int idx;
drh0aa74ed2005-07-16 13:33:20 +0000324 if( pWC->nTerm>=pWC->nSlot ){
325 WhereTerm *pOld = pWC->a;
drh633e6d52008-07-28 19:34:53 +0000326 sqlite3 *db = pWC->pParse->db;
327 pWC->a = sqlite3DbMallocRaw(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
drhb63a53d2007-03-31 01:34:44 +0000328 if( pWC->a==0 ){
drh165be382008-12-05 02:36:33 +0000329 if( wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000330 sqlite3ExprDelete(db, p);
drhb63a53d2007-03-31 01:34:44 +0000331 }
drhf998b732007-11-26 13:36:00 +0000332 pWC->a = pOld;
drhb63a53d2007-03-31 01:34:44 +0000333 return 0;
334 }
drh0aa74ed2005-07-16 13:33:20 +0000335 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
336 if( pOld!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000337 sqlite3DbFree(db, pOld);
drh0aa74ed2005-07-16 13:33:20 +0000338 }
drh6a1e0712008-12-05 15:24:15 +0000339 pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
drh0aa74ed2005-07-16 13:33:20 +0000340 }
drh6a1e0712008-12-05 15:24:15 +0000341 pTerm = &pWC->a[idx = pWC->nTerm++];
drh0fcef5e2005-07-19 17:38:22 +0000342 pTerm->pExpr = p;
drh165be382008-12-05 02:36:33 +0000343 pTerm->wtFlags = wtFlags;
drh0fcef5e2005-07-19 17:38:22 +0000344 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000345 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000346 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000347}
drh75897232000-05-29 14:26:00 +0000348
349/*
drh51669862004-12-18 18:40:26 +0000350** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000351** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000352** operator specified in the op parameter. The WhereClause structure
353** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000354**
drh51669862004-12-18 18:40:26 +0000355** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
356** \________/ \_______________/ \________________/
357** slot[0] slot[1] slot[2]
358**
359** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000360** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000361**
drh51147ba2005-07-23 22:59:55 +0000362** In the previous sentence and in the diagram, "slot[]" refers to
drh902b9ee2008-12-05 17:17:07 +0000363** the WhereClause.a[] array. The slot[] array grows as needed to contain
drh51147ba2005-07-23 22:59:55 +0000364** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000365*/
drh6c30be82005-07-29 15:10:17 +0000366static void whereSplit(WhereClause *pWC, Expr *pExpr, int op){
drh29435252008-12-28 18:35:08 +0000367 pWC->op = (u8)op;
drh0aa74ed2005-07-16 13:33:20 +0000368 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000369 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000370 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000371 }else{
drh6c30be82005-07-29 15:10:17 +0000372 whereSplit(pWC, pExpr->pLeft, op);
373 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000374 }
drh75897232000-05-29 14:26:00 +0000375}
376
377/*
drh6a3ea0e2003-05-02 14:32:12 +0000378** Initialize an expression mask set
379*/
380#define initMaskSet(P) memset(P, 0, sizeof(*P))
381
382/*
drh1398ad32005-01-19 23:24:50 +0000383** Return the bitmask for the given cursor number. Return 0 if
384** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000385*/
drh111a6a72008-12-21 03:51:16 +0000386static Bitmask getMask(WhereMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000387 int i;
388 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000389 if( pMaskSet->ix[i]==iCursor ){
390 return ((Bitmask)1)<<i;
391 }
drh6a3ea0e2003-05-02 14:32:12 +0000392 }
drh6a3ea0e2003-05-02 14:32:12 +0000393 return 0;
394}
395
396/*
drh1398ad32005-01-19 23:24:50 +0000397** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000398**
399** There is one cursor per table in the FROM clause. The number of
400** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000401** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000402** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000403*/
drh111a6a72008-12-21 03:51:16 +0000404static void createMask(WhereMaskSet *pMaskSet, int iCursor){
drhcad651e2007-04-20 12:22:01 +0000405 assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
drh0fcef5e2005-07-19 17:38:22 +0000406 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000407}
408
409/*
drh75897232000-05-29 14:26:00 +0000410** This routine walks (recursively) an expression tree and generates
411** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000412** tree.
drh75897232000-05-29 14:26:00 +0000413**
414** In order for this routine to work, the calling function must have
drh7d10d5a2008-08-20 16:35:10 +0000415** previously invoked sqlite3ResolveExprNames() on the expression. See
drh75897232000-05-29 14:26:00 +0000416** the header comment on that routine for additional information.
drh7d10d5a2008-08-20 16:35:10 +0000417** The sqlite3ResolveExprNames() routines looks for column names and
drh6a3ea0e2003-05-02 14:32:12 +0000418** sets their opcodes to TK_COLUMN and their Expr.iTable fields to
drh51147ba2005-07-23 22:59:55 +0000419** the VDBE cursor number of the table. This routine just has to
420** translate the cursor numbers into bitmask values and OR all
421** the bitmasks together.
drh75897232000-05-29 14:26:00 +0000422*/
drh111a6a72008-12-21 03:51:16 +0000423static Bitmask exprListTableUsage(WhereMaskSet*, ExprList*);
424static Bitmask exprSelectTableUsage(WhereMaskSet*, Select*);
425static Bitmask exprTableUsage(WhereMaskSet *pMaskSet, Expr *p){
drh51669862004-12-18 18:40:26 +0000426 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000427 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000428 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000429 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000430 return mask;
drh75897232000-05-29 14:26:00 +0000431 }
danielk1977b3bce662005-01-29 08:32:43 +0000432 mask = exprTableUsage(pMaskSet, p->pRight);
433 mask |= exprTableUsage(pMaskSet, p->pLeft);
434 mask |= exprListTableUsage(pMaskSet, p->pList);
drhf5b11382005-09-17 13:07:13 +0000435 mask |= exprSelectTableUsage(pMaskSet, p->pSelect);
danielk1977b3bce662005-01-29 08:32:43 +0000436 return mask;
437}
drh111a6a72008-12-21 03:51:16 +0000438static Bitmask exprListTableUsage(WhereMaskSet *pMaskSet, ExprList *pList){
danielk1977b3bce662005-01-29 08:32:43 +0000439 int i;
440 Bitmask mask = 0;
441 if( pList ){
442 for(i=0; i<pList->nExpr; i++){
443 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000444 }
445 }
drh75897232000-05-29 14:26:00 +0000446 return mask;
447}
drh111a6a72008-12-21 03:51:16 +0000448static Bitmask exprSelectTableUsage(WhereMaskSet *pMaskSet, Select *pS){
drha430ae82007-09-12 15:41:01 +0000449 Bitmask mask = 0;
450 while( pS ){
451 mask |= exprListTableUsage(pMaskSet, pS->pEList);
drhf5b11382005-09-17 13:07:13 +0000452 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
453 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
454 mask |= exprTableUsage(pMaskSet, pS->pWhere);
455 mask |= exprTableUsage(pMaskSet, pS->pHaving);
drha430ae82007-09-12 15:41:01 +0000456 pS = pS->pPrior;
drhf5b11382005-09-17 13:07:13 +0000457 }
458 return mask;
459}
drh75897232000-05-29 14:26:00 +0000460
461/*
drh487ab3c2001-11-08 00:45:21 +0000462** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000463** allowed for an indexable WHERE clause term. The allowed operators are
drhc27a1ce2002-06-14 20:58:45 +0000464** "=", "<", ">", "<=", ">=", and "IN".
drh487ab3c2001-11-08 00:45:21 +0000465*/
466static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000467 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
468 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
469 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
470 assert( TK_GE==TK_EQ+4 );
drh50b39962006-10-28 00:28:09 +0000471 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL;
drh487ab3c2001-11-08 00:45:21 +0000472}
473
474/*
drh902b9ee2008-12-05 17:17:07 +0000475** Swap two objects of type TYPE.
drh193bd772004-07-20 18:23:14 +0000476*/
477#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
478
479/*
drh909626d2008-05-30 14:58:37 +0000480** Commute a comparison operator. Expressions of the form "X op Y"
drh0fcef5e2005-07-19 17:38:22 +0000481** are converted into "Y op X".
danielk1977eb5453d2007-07-30 14:40:48 +0000482**
483** If a collation sequence is associated with either the left or right
484** side of the comparison, it remains associated with the same side after
485** the commutation. So "Y collate NOCASE op X" becomes
486** "X collate NOCASE op Y". This is because any collation sequence on
487** the left hand side of a comparison overrides any collation sequence
488** attached to the right. For the same reason the EP_ExpCollate flag
489** is not commuted.
drh193bd772004-07-20 18:23:14 +0000490*/
drh7d10d5a2008-08-20 16:35:10 +0000491static void exprCommute(Parse *pParse, Expr *pExpr){
danielk1977eb5453d2007-07-30 14:40:48 +0000492 u16 expRight = (pExpr->pRight->flags & EP_ExpCollate);
493 u16 expLeft = (pExpr->pLeft->flags & EP_ExpCollate);
drhfe05af82005-07-21 03:14:59 +0000494 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drh7d10d5a2008-08-20 16:35:10 +0000495 pExpr->pRight->pColl = sqlite3ExprCollSeq(pParse, pExpr->pRight);
496 pExpr->pLeft->pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drh0fcef5e2005-07-19 17:38:22 +0000497 SWAP(CollSeq*,pExpr->pRight->pColl,pExpr->pLeft->pColl);
danielk1977eb5453d2007-07-30 14:40:48 +0000498 pExpr->pRight->flags = (pExpr->pRight->flags & ~EP_ExpCollate) | expLeft;
499 pExpr->pLeft->flags = (pExpr->pLeft->flags & ~EP_ExpCollate) | expRight;
drh0fcef5e2005-07-19 17:38:22 +0000500 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
501 if( pExpr->op>=TK_GT ){
502 assert( TK_LT==TK_GT+2 );
503 assert( TK_GE==TK_LE+2 );
504 assert( TK_GT>TK_EQ );
505 assert( TK_GT<TK_LE );
506 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
507 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000508 }
drh193bd772004-07-20 18:23:14 +0000509}
510
511/*
drhfe05af82005-07-21 03:14:59 +0000512** Translate from TK_xx operator to WO_xx bitmask.
513*/
drhec1724e2008-12-09 01:32:03 +0000514static u16 operatorMask(int op){
515 u16 c;
drhfe05af82005-07-21 03:14:59 +0000516 assert( allowedOp(op) );
517 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000518 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000519 }else if( op==TK_ISNULL ){
520 c = WO_ISNULL;
drhfe05af82005-07-21 03:14:59 +0000521 }else{
drhec1724e2008-12-09 01:32:03 +0000522 assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
523 c = (u16)(WO_EQ<<(op-TK_EQ));
drhfe05af82005-07-21 03:14:59 +0000524 }
drh50b39962006-10-28 00:28:09 +0000525 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh51147ba2005-07-23 22:59:55 +0000526 assert( op!=TK_IN || c==WO_IN );
527 assert( op!=TK_EQ || c==WO_EQ );
528 assert( op!=TK_LT || c==WO_LT );
529 assert( op!=TK_LE || c==WO_LE );
530 assert( op!=TK_GT || c==WO_GT );
531 assert( op!=TK_GE || c==WO_GE );
532 return c;
drhfe05af82005-07-21 03:14:59 +0000533}
534
535/*
536** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
537** where X is a reference to the iColumn of table iCur and <op> is one of
538** the WO_xx operator codes specified by the op parameter.
539** Return a pointer to the term. Return 0 if not found.
540*/
541static WhereTerm *findTerm(
542 WhereClause *pWC, /* The WHERE clause to be searched */
543 int iCur, /* Cursor number of LHS */
544 int iColumn, /* Column number of LHS */
545 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000546 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000547 Index *pIdx /* Must be compatible with this index, if not NULL */
548){
549 WhereTerm *pTerm;
550 int k;
drh22c24032008-07-09 13:28:53 +0000551 assert( iCur>=0 );
drhec1724e2008-12-09 01:32:03 +0000552 op &= WO_ALL;
drhfe05af82005-07-21 03:14:59 +0000553 for(pTerm=pWC->a, k=pWC->nTerm; k; k--, pTerm++){
554 if( pTerm->leftCursor==iCur
555 && (pTerm->prereqRight & notReady)==0
drh700a2262008-12-17 19:22:15 +0000556 && pTerm->u.leftColumn==iColumn
drhb52076c2006-01-23 13:22:09 +0000557 && (pTerm->eOperator & op)!=0
drhfe05af82005-07-21 03:14:59 +0000558 ){
drh22c24032008-07-09 13:28:53 +0000559 if( pIdx && pTerm->eOperator!=WO_ISNULL ){
drhfe05af82005-07-21 03:14:59 +0000560 Expr *pX = pTerm->pExpr;
561 CollSeq *pColl;
562 char idxaff;
danielk1977f0113002006-01-24 12:09:17 +0000563 int j;
drhfe05af82005-07-21 03:14:59 +0000564 Parse *pParse = pWC->pParse;
565
566 idxaff = pIdx->pTable->aCol[iColumn].affinity;
567 if( !sqlite3IndexAffinityOk(pX, idxaff) ) continue;
danielk1977bcbb04e2007-05-29 12:11:29 +0000568
569 /* Figure out the collation sequence required from an index for
570 ** it to be useful for optimising expression pX. Store this
571 ** value in variable pColl.
572 */
573 assert(pX->pLeft);
574 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
danielk197793574162008-12-30 15:26:29 +0000575 assert(pColl || pParse->nErr);
danielk1977bcbb04e2007-05-29 12:11:29 +0000576
drh22c24032008-07-09 13:28:53 +0000577 for(j=0; pIdx->aiColumn[j]!=iColumn; j++){
drh34004ce2008-07-11 16:15:17 +0000578 if( NEVER(j>=pIdx->nColumn) ) return 0;
drh22c24032008-07-09 13:28:53 +0000579 }
danielk197793574162008-12-30 15:26:29 +0000580 if( pColl && sqlite3StrICmp(pColl->zName, pIdx->azColl[j]) ) continue;
drhfe05af82005-07-21 03:14:59 +0000581 }
582 return pTerm;
583 }
584 }
585 return 0;
586}
587
drh6c30be82005-07-29 15:10:17 +0000588/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000589static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000590
591/*
592** Call exprAnalyze on all terms in a WHERE clause.
593**
594**
595*/
596static void exprAnalyzeAll(
597 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000598 WhereClause *pWC /* the WHERE clause to be analyzed */
599){
drh6c30be82005-07-29 15:10:17 +0000600 int i;
drh9eb20282005-08-24 03:52:18 +0000601 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000602 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000603 }
604}
605
drhd2687b72005-08-12 22:56:09 +0000606#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
607/*
608** Check to see if the given expression is a LIKE or GLOB operator that
609** can be optimized using inequality constraints. Return TRUE if it is
610** so and false if not.
611**
612** In order for the operator to be optimizible, the RHS must be a string
613** literal that does not begin with a wildcard.
614*/
615static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000616 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000617 Expr *pExpr, /* Test this expression */
618 int *pnPattern, /* Number of non-wildcard prefix characters */
drh9f504ea2008-02-23 21:55:39 +0000619 int *pisComplete, /* True if the only wildcard is % in the last character */
620 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000621){
drh5bd98ae2009-01-07 18:24:03 +0000622 const char *z; /* String on RHS of LIKE operator */
623 Expr *pRight, *pLeft; /* Right and left size of LIKE operator */
624 ExprList *pList; /* List of operands to the LIKE operator */
625 int c; /* One character in z[] */
626 int cnt; /* Number of non-wildcard prefix characters */
627 char wc[3]; /* Wildcard characters */
628 CollSeq *pColl; /* Collating sequence for LHS */
629 sqlite3 *db = pParse->db; /* Database connection */
drhd64fe2f2005-08-28 17:00:23 +0000630
drh9f504ea2008-02-23 21:55:39 +0000631 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000632 return 0;
633 }
drh9f504ea2008-02-23 21:55:39 +0000634#ifdef SQLITE_EBCDIC
635 if( *pnoCase ) return 0;
636#endif
drh55ef4d92005-08-14 01:20:37 +0000637 pList = pExpr->pList;
638 pRight = pList->a[0].pExpr;
drh5bd98ae2009-01-07 18:24:03 +0000639 if( pRight->op!=TK_STRING ){
drhd2687b72005-08-12 22:56:09 +0000640 return 0;
641 }
drh55ef4d92005-08-14 01:20:37 +0000642 pLeft = pList->a[1].pExpr;
drhd2687b72005-08-12 22:56:09 +0000643 if( pLeft->op!=TK_COLUMN ){
644 return 0;
645 }
drh7d10d5a2008-08-20 16:35:10 +0000646 pColl = sqlite3ExprCollSeq(pParse, pLeft);
drh01495b92008-01-23 12:52:40 +0000647 assert( pColl!=0 || pLeft->iColumn==-1 );
drhd64fe2f2005-08-28 17:00:23 +0000648 if( pColl==0 ){
drh01495b92008-01-23 12:52:40 +0000649 /* No collation is defined for the ROWID. Use the default. */
drhd64fe2f2005-08-28 17:00:23 +0000650 pColl = db->pDfltColl;
651 }
drh9f504ea2008-02-23 21:55:39 +0000652 if( (pColl->type!=SQLITE_COLL_BINARY || *pnoCase) &&
653 (pColl->type!=SQLITE_COLL_NOCASE || !*pnoCase) ){
drhd64fe2f2005-08-28 17:00:23 +0000654 return 0;
655 }
drh17435752007-08-16 04:30:38 +0000656 sqlite3DequoteExpr(db, pRight);
danielk197700fd9572005-12-07 06:27:43 +0000657 z = (char *)pRight->token.z;
drhf998b732007-11-26 13:36:00 +0000658 cnt = 0;
659 if( z ){
660 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){ cnt++; }
661 }
drh5bd98ae2009-01-07 18:24:03 +0000662 if( cnt==0 || 255==(u8)z[cnt-1] ){
drhd2687b72005-08-12 22:56:09 +0000663 return 0;
664 }
drh55ef4d92005-08-14 01:20:37 +0000665 *pisComplete = z[cnt]==wc[0] && z[cnt+1]==0;
drhd2687b72005-08-12 22:56:09 +0000666 *pnPattern = cnt;
667 return 1;
668}
669#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
670
drhedb193b2006-06-27 13:20:21 +0000671
672#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000673/*
drh7f375902006-06-13 17:38:59 +0000674** Check to see if the given expression is of the form
675**
676** column MATCH expr
677**
678** If it is then return TRUE. If not, return FALSE.
679*/
680static int isMatchOfColumn(
681 Expr *pExpr /* Test this expression */
682){
683 ExprList *pList;
684
685 if( pExpr->op!=TK_FUNCTION ){
686 return 0;
687 }
drhedb193b2006-06-27 13:20:21 +0000688 if( pExpr->token.n!=5 ||
689 sqlite3StrNICmp((const char*)pExpr->token.z,"match",5)!=0 ){
drh7f375902006-06-13 17:38:59 +0000690 return 0;
691 }
692 pList = pExpr->pList;
693 if( pList->nExpr!=2 ){
694 return 0;
695 }
696 if( pList->a[1].pExpr->op != TK_COLUMN ){
697 return 0;
698 }
699 return 1;
700}
drhedb193b2006-06-27 13:20:21 +0000701#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000702
703/*
drh54a167d2005-11-26 14:08:07 +0000704** If the pBase expression originated in the ON or USING clause of
705** a join, then transfer the appropriate markings over to derived.
706*/
707static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
708 pDerived->flags |= pBase->flags & EP_FromJoin;
709 pDerived->iRightJoinTable = pBase->iRightJoinTable;
710}
711
drh3e355802007-02-23 23:13:33 +0000712#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
713/*
drh1a58fe02008-12-20 02:06:13 +0000714** Analyze a term that consists of two or more OR-connected
715** subterms. So in:
drh3e355802007-02-23 23:13:33 +0000716**
drh1a58fe02008-12-20 02:06:13 +0000717** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
718** ^^^^^^^^^^^^^^^^^^^^
drh3e355802007-02-23 23:13:33 +0000719**
drh1a58fe02008-12-20 02:06:13 +0000720** This routine analyzes terms such as the middle term in the above example.
721** A WhereOrTerm object is computed and attached to the term under
722** analysis, regardless of the outcome of the analysis. Hence:
drh3e355802007-02-23 23:13:33 +0000723**
drh1a58fe02008-12-20 02:06:13 +0000724** WhereTerm.wtFlags |= TERM_ORINFO
725** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
drh3e355802007-02-23 23:13:33 +0000726**
drh1a58fe02008-12-20 02:06:13 +0000727** The term being analyzed must have two or more of OR-connected subterms.
danielk1977fdc40192008-12-29 18:33:32 +0000728** A single subterm might be a set of AND-connected sub-subterms.
drh1a58fe02008-12-20 02:06:13 +0000729** Examples of terms under analysis:
drh3e355802007-02-23 23:13:33 +0000730**
drh1a58fe02008-12-20 02:06:13 +0000731** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
732** (B) x=expr1 OR expr2=x OR x=expr3
733** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
734** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
735** (E) (p.a=1 AND q.b=2 AND r.c=3) OR (p.x=4 AND q.y=5 AND r.z=6)
drh3e355802007-02-23 23:13:33 +0000736**
drh1a58fe02008-12-20 02:06:13 +0000737** CASE 1:
738**
739** If all subterms are of the form T.C=expr for some single column of C
740** a single table T (as shown in example B above) then create a new virtual
741** term that is an equivalent IN expression. In other words, if the term
742** being analyzed is:
743**
744** x = expr1 OR expr2 = x OR x = expr3
745**
746** then create a new virtual term like this:
747**
748** x IN (expr1,expr2,expr3)
749**
750** CASE 2:
751**
752** If all subterms are indexable by a single table T, then set
753**
754** WhereTerm.eOperator = WO_OR
755** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
756**
757** A subterm is "indexable" if it is of the form
758** "T.C <op> <expr>" where C is any column of table T and
759** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
760** A subterm is also indexable if it is an AND of two or more
761** subsubterms at least one of which is indexable. Indexable AND
762** subterms have their eOperator set to WO_AND and they have
763** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
764**
765** From another point of view, "indexable" means that the subterm could
766** potentially be used with an index if an appropriate index exists.
767** This analysis does not consider whether or not the index exists; that
768** is something the bestIndex() routine will determine. This analysis
769** only looks at whether subterms appropriate for indexing exist.
770**
771** All examples A through E above all satisfy case 2. But if a term
772** also statisfies case 1 (such as B) we know that the optimizer will
773** always prefer case 1, so in that case we pretend that case 2 is not
774** satisfied.
775**
776** It might be the case that multiple tables are indexable. For example,
777** (E) above is indexable on tables P, Q, and R.
778**
779** Terms that satisfy case 2 are candidates for lookup by using
780** separate indices to find rowids for each subterm and composing
781** the union of all rowids using a RowSet object. This is similar
782** to "bitmap indices" in other database engines.
783**
784** OTHERWISE:
785**
786** If neither case 1 nor case 2 apply, then leave the eOperator set to
787** zero. This term is not useful for search.
drh3e355802007-02-23 23:13:33 +0000788*/
drh1a58fe02008-12-20 02:06:13 +0000789static void exprAnalyzeOrTerm(
790 SrcList *pSrc, /* the FROM clause */
791 WhereClause *pWC, /* the complete WHERE clause */
792 int idxTerm /* Index of the OR-term to be analyzed */
793){
794 Parse *pParse = pWC->pParse; /* Parser context */
795 sqlite3 *db = pParse->db; /* Database connection */
796 WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
797 Expr *pExpr = pTerm->pExpr; /* The expression of the term */
drh111a6a72008-12-21 03:51:16 +0000798 WhereMaskSet *pMaskSet = pWC->pMaskSet; /* Table use masks */
drh1a58fe02008-12-20 02:06:13 +0000799 int i; /* Loop counters */
800 WhereClause *pOrWc; /* Breakup of pTerm into subterms */
801 WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
802 WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
803 Bitmask chngToIN; /* Tables that might satisfy case 1 */
804 Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
drh3e355802007-02-23 23:13:33 +0000805
drh1a58fe02008-12-20 02:06:13 +0000806 /*
807 ** Break the OR clause into its separate subterms. The subterms are
808 ** stored in a WhereClause structure containing within the WhereOrInfo
809 ** object that is attached to the original OR clause term.
810 */
811 assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
812 assert( pExpr->op==TK_OR );
drh954701a2008-12-29 23:45:07 +0000813 pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
drh1a58fe02008-12-20 02:06:13 +0000814 if( pOrInfo==0 ) return;
815 pTerm->wtFlags |= TERM_ORINFO;
816 pOrWc = &pOrInfo->wc;
817 whereClauseInit(pOrWc, pWC->pParse, pMaskSet);
818 whereSplit(pOrWc, pExpr, TK_OR);
819 exprAnalyzeAll(pSrc, pOrWc);
820 if( db->mallocFailed ) return;
821 assert( pOrWc->nTerm>=2 );
822
823 /*
824 ** Compute the set of tables that might satisfy cases 1 or 2.
825 */
826 indexable = chngToIN = ~(Bitmask)0;
827 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
828 if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
drh29435252008-12-28 18:35:08 +0000829 WhereAndInfo *pAndInfo;
830 assert( pOrTerm->eOperator==0 );
831 assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
drh1a58fe02008-12-20 02:06:13 +0000832 chngToIN = 0;
drh29435252008-12-28 18:35:08 +0000833 pAndInfo = sqlite3DbMallocRaw(db, sizeof(*pAndInfo));
834 if( pAndInfo ){
835 WhereClause *pAndWC;
836 WhereTerm *pAndTerm;
837 int j;
838 Bitmask b = 0;
839 pOrTerm->u.pAndInfo = pAndInfo;
840 pOrTerm->wtFlags |= TERM_ANDINFO;
841 pOrTerm->eOperator = WO_AND;
842 pAndWC = &pAndInfo->wc;
843 whereClauseInit(pAndWC, pWC->pParse, pMaskSet);
844 whereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
845 exprAnalyzeAll(pSrc, pAndWC);
drh7c2fbde2009-01-07 20:58:57 +0000846 testcase( db->mallocFailed );
drh29435252008-12-28 18:35:08 +0000847 for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
drh7c2fbde2009-01-07 20:58:57 +0000848 assert( pAndTerm->pExpr );
849 if( allowedOp(pAndTerm->pExpr->op) ){
drh29435252008-12-28 18:35:08 +0000850 b |= getMask(pMaskSet, pAndTerm->leftCursor);
851 }
852 }
853 indexable &= b;
854 }
drh1a58fe02008-12-20 02:06:13 +0000855 }else if( pOrTerm->wtFlags & TERM_COPIED ){
856 /* Skip this term for now. We revisit it when we process the
857 ** corresponding TERM_VIRTUAL term */
858 }else{
859 Bitmask b;
860 b = getMask(pMaskSet, pOrTerm->leftCursor);
861 if( pOrTerm->wtFlags & TERM_VIRTUAL ){
862 WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
863 b |= getMask(pMaskSet, pOther->leftCursor);
864 }
865 indexable &= b;
866 if( pOrTerm->eOperator!=WO_EQ ){
867 chngToIN = 0;
868 }else{
869 chngToIN &= b;
870 }
871 }
drh3e355802007-02-23 23:13:33 +0000872 }
drh1a58fe02008-12-20 02:06:13 +0000873
874 /*
875 ** Record the set of tables that satisfy case 2. The set might be
drh111a6a72008-12-21 03:51:16 +0000876 ** empty.
drh1a58fe02008-12-20 02:06:13 +0000877 */
878 pOrInfo->indexable = indexable;
drh111a6a72008-12-21 03:51:16 +0000879 pTerm->eOperator = indexable==0 ? 0 : WO_OR;
drh1a58fe02008-12-20 02:06:13 +0000880
881 /*
882 ** chngToIN holds a set of tables that *might* satisfy case 1. But
883 ** we have to do some additional checking to see if case 1 really
884 ** is satisfied.
885 */
886 if( chngToIN ){
887 int okToChngToIN = 0; /* True if the conversion to IN is valid */
888 int iColumn = -1; /* Column index on lhs of IN operator */
889 int iCursor; /* Table cursor common to all terms */
890 int j = 0; /* Loop counter */
891
892 /* Search for a table and column that appears on one side or the
893 ** other of the == operator in every subterm. That table and column
894 ** will be recorded in iCursor and iColumn. There might not be any
895 ** such table and column. Set okToChngToIN if an appropriate table
896 ** and column is found but leave okToChngToIN false if not found.
897 */
898 for(j=0; j<2 && !okToChngToIN; j++){
899 pOrTerm = pOrWc->a;
900 for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
901 assert( pOrTerm->eOperator==WO_EQ );
902 pOrTerm->wtFlags &= ~TERM_OR_OK;
903 if( pOrTerm->leftCursor==iColumn ) continue;
904 if( (chngToIN & getMask(pMaskSet, pOrTerm->leftCursor))==0 ) continue;
905 iColumn = pOrTerm->u.leftColumn;
906 iCursor = pOrTerm->leftCursor;
907 break;
908 }
909 if( i<0 ){
910 assert( j==1 );
911 assert( (chngToIN&(chngToIN-1))==0 );
912 assert( chngToIN==getMask(pMaskSet, iColumn) );
913 break;
914 }
915 okToChngToIN = 1;
916 for(; i>=0 && okToChngToIN; i--, pOrTerm++){
917 assert( pOrTerm->eOperator==WO_EQ );
918 if( pOrTerm->leftCursor!=iCursor ){
919 pOrTerm->wtFlags &= ~TERM_OR_OK;
920 }else if( pOrTerm->u.leftColumn!=iColumn ){
921 okToChngToIN = 0;
922 }else{
923 int affLeft, affRight;
924 /* If the right-hand side is also a column, then the affinities
925 ** of both right and left sides must be such that no type
926 ** conversions are required on the right. (Ticket #2249)
927 */
928 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
929 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
930 if( affRight!=0 && affRight!=affLeft ){
931 okToChngToIN = 0;
932 }else{
933 pOrTerm->wtFlags |= TERM_OR_OK;
934 }
935 }
936 }
937 }
938
939 /* At this point, okToChngToIN is true if original pTerm satisfies
940 ** case 1. In that case, construct a new virtual term that is
941 ** pTerm converted into an IN operator.
942 */
943 if( okToChngToIN ){
944 Expr *pDup; /* A transient duplicate expression */
945 ExprList *pList = 0; /* The RHS of the IN operator */
946 Expr *pLeft = 0; /* The LHS of the IN operator */
947 Expr *pNew; /* The complete IN operator */
948
949 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
950 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
951 assert( pOrTerm->eOperator==WO_EQ );
952 assert( pOrTerm->leftCursor==iCursor );
953 assert( pOrTerm->u.leftColumn==iColumn );
954 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight);
955 pList = sqlite3ExprListAppend(pWC->pParse, pList, pDup, 0);
956 pLeft = pOrTerm->pExpr->pLeft;
957 }
958 assert( pLeft!=0 );
959 pDup = sqlite3ExprDup(db, pLeft);
960 pNew = sqlite3Expr(db, TK_IN, pDup, 0, 0);
961 if( pNew ){
962 int idxNew;
963 transferJoinMarkings(pNew, pExpr);
964 pNew->pList = pList;
965 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
966 testcase( idxNew==0 );
967 exprAnalyze(pSrc, pWC, idxNew);
968 pTerm = &pWC->a[idxTerm];
969 pWC->a[idxNew].iParent = idxTerm;
970 pTerm->nChild = 1;
971 }else{
972 sqlite3ExprListDelete(db, pList);
973 }
974 pTerm->eOperator = 0; /* case 1 trumps case 2 */
975 }
drh3e355802007-02-23 23:13:33 +0000976 }
drh3e355802007-02-23 23:13:33 +0000977}
978#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +0000979
drh1a58fe02008-12-20 02:06:13 +0000980
drh54a167d2005-11-26 14:08:07 +0000981/*
drh0aa74ed2005-07-16 13:33:20 +0000982** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +0000983** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +0000984** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +0000985** structure.
drh51147ba2005-07-23 22:59:55 +0000986**
987** If the expression is of the form "<expr> <op> X" it gets commuted
drh1a58fe02008-12-20 02:06:13 +0000988** to the standard form of "X <op> <expr>".
989**
990** If the expression is of the form "X <op> Y" where both X and Y are
991** columns, then the original expression is unchanged and a new virtual
992** term of the form "Y <op> X" is added to the WHERE clause and
993** analyzed separately. The original term is marked with TERM_COPIED
994** and the new term is marked with TERM_DYNAMIC (because it's pExpr
995** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
996** is a commuted copy of a prior term.) The original term has nChild=1
997** and the copy has idxParent set to the index of the original term.
drh75897232000-05-29 14:26:00 +0000998*/
drh0fcef5e2005-07-19 17:38:22 +0000999static void exprAnalyze(
1000 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +00001001 WhereClause *pWC, /* the WHERE clause */
1002 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +00001003){
drh1a58fe02008-12-20 02:06:13 +00001004 WhereTerm *pTerm; /* The term to be analyzed */
drh111a6a72008-12-21 03:51:16 +00001005 WhereMaskSet *pMaskSet; /* Set of table index masks */
drh1a58fe02008-12-20 02:06:13 +00001006 Expr *pExpr; /* The expression to be analyzed */
1007 Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
1008 Bitmask prereqAll; /* Prerequesites of pExpr */
drhdafc0ce2008-04-17 19:14:02 +00001009 Bitmask extraRight = 0;
drhd2687b72005-08-12 22:56:09 +00001010 int nPattern;
1011 int isComplete;
drh9f504ea2008-02-23 21:55:39 +00001012 int noCase;
drh1a58fe02008-12-20 02:06:13 +00001013 int op; /* Top-level operator. pExpr->op */
1014 Parse *pParse = pWC->pParse; /* Parsing context */
1015 sqlite3 *db = pParse->db; /* Database connection */
drh0fcef5e2005-07-19 17:38:22 +00001016
drhf998b732007-11-26 13:36:00 +00001017 if( db->mallocFailed ){
1018 return;
1019 }
1020 pTerm = &pWC->a[idxTerm];
1021 pMaskSet = pWC->pMaskSet;
1022 pExpr = pTerm->pExpr;
drh0fcef5e2005-07-19 17:38:22 +00001023 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +00001024 op = pExpr->op;
1025 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +00001026 assert( pExpr->pRight==0 );
1027 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->pList)
1028 | exprSelectTableUsage(pMaskSet, pExpr->pSelect);
drh50b39962006-10-28 00:28:09 +00001029 }else if( op==TK_ISNULL ){
1030 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +00001031 }else{
1032 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
1033 }
drh22d6a532005-09-19 21:05:48 +00001034 prereqAll = exprTableUsage(pMaskSet, pExpr);
1035 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +00001036 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
1037 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +00001038 extraRight = x-1; /* ON clause terms may not be used with an index
1039 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +00001040 }
1041 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +00001042 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +00001043 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +00001044 pTerm->eOperator = 0;
drh50b39962006-10-28 00:28:09 +00001045 if( allowedOp(op) && (pTerm->prereqRight & prereqLeft)==0 ){
drh0fcef5e2005-07-19 17:38:22 +00001046 Expr *pLeft = pExpr->pLeft;
1047 Expr *pRight = pExpr->pRight;
1048 if( pLeft->op==TK_COLUMN ){
1049 pTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001050 pTerm->u.leftColumn = pLeft->iColumn;
drh50b39962006-10-28 00:28:09 +00001051 pTerm->eOperator = operatorMask(op);
drh75897232000-05-29 14:26:00 +00001052 }
drh0fcef5e2005-07-19 17:38:22 +00001053 if( pRight && pRight->op==TK_COLUMN ){
1054 WhereTerm *pNew;
1055 Expr *pDup;
1056 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +00001057 int idxNew;
drh17435752007-08-16 04:30:38 +00001058 pDup = sqlite3ExprDup(db, pExpr);
1059 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +00001060 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +00001061 return;
1062 }
drh9eb20282005-08-24 03:52:18 +00001063 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
1064 if( idxNew==0 ) return;
1065 pNew = &pWC->a[idxNew];
1066 pNew->iParent = idxTerm;
1067 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +00001068 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001069 pTerm->wtFlags |= TERM_COPIED;
drh0fcef5e2005-07-19 17:38:22 +00001070 }else{
1071 pDup = pExpr;
1072 pNew = pTerm;
1073 }
drh7d10d5a2008-08-20 16:35:10 +00001074 exprCommute(pParse, pDup);
drh0fcef5e2005-07-19 17:38:22 +00001075 pLeft = pDup->pLeft;
1076 pNew->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001077 pNew->u.leftColumn = pLeft->iColumn;
drh0fcef5e2005-07-19 17:38:22 +00001078 pNew->prereqRight = prereqLeft;
1079 pNew->prereqAll = prereqAll;
drhb52076c2006-01-23 13:22:09 +00001080 pNew->eOperator = operatorMask(pDup->op);
drh75897232000-05-29 14:26:00 +00001081 }
1082 }
drhed378002005-07-28 23:12:08 +00001083
drhd2687b72005-08-12 22:56:09 +00001084#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +00001085 /* If a term is the BETWEEN operator, create two new virtual terms
drh1a58fe02008-12-20 02:06:13 +00001086 ** that define the range that the BETWEEN implements. For example:
1087 **
1088 ** a BETWEEN b AND c
1089 **
1090 ** is converted into:
1091 **
1092 ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
1093 **
1094 ** The two new terms are added onto the end of the WhereClause object.
1095 ** The new terms are "dynamic" and are children of the original BETWEEN
1096 ** term. That means that if the BETWEEN term is coded, the children are
1097 ** skipped. Or, if the children are satisfied by an index, the original
1098 ** BETWEEN term is skipped.
drhed378002005-07-28 23:12:08 +00001099 */
drh29435252008-12-28 18:35:08 +00001100 else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
drhed378002005-07-28 23:12:08 +00001101 ExprList *pList = pExpr->pList;
1102 int i;
1103 static const u8 ops[] = {TK_GE, TK_LE};
1104 assert( pList!=0 );
1105 assert( pList->nExpr==2 );
1106 for(i=0; i<2; i++){
1107 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +00001108 int idxNew;
danielk1977a1644fd2007-08-29 12:31:25 +00001109 pNewExpr = sqlite3Expr(db, ops[i], sqlite3ExprDup(db, pExpr->pLeft),
drh17435752007-08-16 04:30:38 +00001110 sqlite3ExprDup(db, pList->a[i].pExpr), 0);
drh9eb20282005-08-24 03:52:18 +00001111 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001112 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001113 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +00001114 pTerm = &pWC->a[idxTerm];
1115 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +00001116 }
drh45b1ee42005-08-02 17:48:22 +00001117 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +00001118 }
drhd2687b72005-08-12 22:56:09 +00001119#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +00001120
danielk19771576cd92006-01-14 08:02:28 +00001121#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh1a58fe02008-12-20 02:06:13 +00001122 /* Analyze a term that is composed of two or more subterms connected by
1123 ** an OR operator.
drh6c30be82005-07-29 15:10:17 +00001124 */
1125 else if( pExpr->op==TK_OR ){
drh29435252008-12-28 18:35:08 +00001126 assert( pWC->op==TK_AND );
drh1a58fe02008-12-20 02:06:13 +00001127 exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
drh6c30be82005-07-29 15:10:17 +00001128 }
drhd2687b72005-08-12 22:56:09 +00001129#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1130
1131#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
1132 /* Add constraints to reduce the search space on a LIKE or GLOB
1133 ** operator.
drh9f504ea2008-02-23 21:55:39 +00001134 **
1135 ** A like pattern of the form "x LIKE 'abc%'" is changed into constraints
1136 **
1137 ** x>='abc' AND x<'abd' AND x LIKE 'abc%'
1138 **
1139 ** The last character of the prefix "abc" is incremented to form the
shane7bc71e52008-05-28 18:01:44 +00001140 ** termination condition "abd".
drhd2687b72005-08-12 22:56:09 +00001141 */
drh29435252008-12-28 18:35:08 +00001142 if( isLikeOrGlob(pParse, pExpr, &nPattern, &isComplete, &noCase)
1143 && pWC->op==TK_AND ){
drhd2687b72005-08-12 22:56:09 +00001144 Expr *pLeft, *pRight;
1145 Expr *pStr1, *pStr2;
1146 Expr *pNewExpr1, *pNewExpr2;
drh9eb20282005-08-24 03:52:18 +00001147 int idxNew1, idxNew2;
1148
drhd2687b72005-08-12 22:56:09 +00001149 pLeft = pExpr->pList->a[1].pExpr;
1150 pRight = pExpr->pList->a[0].pExpr;
drh17435752007-08-16 04:30:38 +00001151 pStr1 = sqlite3PExpr(pParse, TK_STRING, 0, 0, 0);
drhd2687b72005-08-12 22:56:09 +00001152 if( pStr1 ){
drh17435752007-08-16 04:30:38 +00001153 sqlite3TokenCopy(db, &pStr1->token, &pRight->token);
drhd2687b72005-08-12 22:56:09 +00001154 pStr1->token.n = nPattern;
drh9c86df52007-06-11 12:56:15 +00001155 pStr1->flags = EP_Dequoted;
drhd2687b72005-08-12 22:56:09 +00001156 }
drh17435752007-08-16 04:30:38 +00001157 pStr2 = sqlite3ExprDup(db, pStr1);
drhf998b732007-11-26 13:36:00 +00001158 if( !db->mallocFailed ){
drh9f504ea2008-02-23 21:55:39 +00001159 u8 c, *pC;
drhd2687b72005-08-12 22:56:09 +00001160 assert( pStr2->token.dyn );
drh9f504ea2008-02-23 21:55:39 +00001161 pC = (u8*)&pStr2->token.z[nPattern-1];
1162 c = *pC;
drh02a50b72008-05-26 18:33:40 +00001163 if( noCase ){
1164 if( c=='@' ) isComplete = 0;
1165 c = sqlite3UpperToLower[c];
1166 }
drh9f504ea2008-02-23 21:55:39 +00001167 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +00001168 }
drh17435752007-08-16 04:30:38 +00001169 pNewExpr1 = sqlite3PExpr(pParse, TK_GE, sqlite3ExprDup(db,pLeft), pStr1, 0);
drh9eb20282005-08-24 03:52:18 +00001170 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001171 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001172 exprAnalyze(pSrc, pWC, idxNew1);
drh17435752007-08-16 04:30:38 +00001173 pNewExpr2 = sqlite3PExpr(pParse, TK_LT, sqlite3ExprDup(db,pLeft), pStr2, 0);
drh9eb20282005-08-24 03:52:18 +00001174 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001175 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001176 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +00001177 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +00001178 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +00001179 pWC->a[idxNew1].iParent = idxTerm;
1180 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +00001181 pTerm->nChild = 2;
1182 }
1183 }
1184#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +00001185
1186#ifndef SQLITE_OMIT_VIRTUALTABLE
1187 /* Add a WO_MATCH auxiliary term to the constraint set if the
1188 ** current expression is of the form: column MATCH expr.
1189 ** This information is used by the xBestIndex methods of
1190 ** virtual tables. The native query optimizer does not attempt
1191 ** to do anything with MATCH functions.
1192 */
1193 if( isMatchOfColumn(pExpr) ){
1194 int idxNew;
1195 Expr *pRight, *pLeft;
1196 WhereTerm *pNewTerm;
1197 Bitmask prereqColumn, prereqExpr;
1198
1199 pRight = pExpr->pList->a[0].pExpr;
1200 pLeft = pExpr->pList->a[1].pExpr;
1201 prereqExpr = exprTableUsage(pMaskSet, pRight);
1202 prereqColumn = exprTableUsage(pMaskSet, pLeft);
1203 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +00001204 Expr *pNewExpr;
danielk1977a1644fd2007-08-29 12:31:25 +00001205 pNewExpr = sqlite3Expr(db, TK_MATCH, 0, sqlite3ExprDup(db, pRight), 0);
drh1a90e092006-06-14 22:07:10 +00001206 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001207 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001208 pNewTerm = &pWC->a[idxNew];
1209 pNewTerm->prereqRight = prereqExpr;
1210 pNewTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001211 pNewTerm->u.leftColumn = pLeft->iColumn;
drh7f375902006-06-13 17:38:59 +00001212 pNewTerm->eOperator = WO_MATCH;
1213 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +00001214 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +00001215 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001216 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001217 pNewTerm->prereqAll = pTerm->prereqAll;
1218 }
1219 }
1220#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001221
1222 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1223 ** an index for tables to the left of the join.
1224 */
1225 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001226}
1227
drh7b4fc6a2007-02-06 13:26:32 +00001228/*
1229** Return TRUE if any of the expressions in pList->a[iFirst...] contain
1230** a reference to any table other than the iBase table.
1231*/
1232static int referencesOtherTables(
1233 ExprList *pList, /* Search expressions in ths list */
drh111a6a72008-12-21 03:51:16 +00001234 WhereMaskSet *pMaskSet, /* Mapping from tables to bitmaps */
drh7b4fc6a2007-02-06 13:26:32 +00001235 int iFirst, /* Be searching with the iFirst-th expression */
1236 int iBase /* Ignore references to this table */
1237){
1238 Bitmask allowed = ~getMask(pMaskSet, iBase);
1239 while( iFirst<pList->nExpr ){
1240 if( (exprTableUsage(pMaskSet, pList->a[iFirst++].pExpr)&allowed)!=0 ){
1241 return 1;
1242 }
1243 }
1244 return 0;
1245}
1246
drh0fcef5e2005-07-19 17:38:22 +00001247
drh75897232000-05-29 14:26:00 +00001248/*
drh51669862004-12-18 18:40:26 +00001249** This routine decides if pIdx can be used to satisfy the ORDER BY
1250** clause. If it can, it returns 1. If pIdx cannot satisfy the
1251** ORDER BY clause, this routine returns 0.
1252**
1253** pOrderBy is an ORDER BY clause from a SELECT statement. pTab is the
1254** left-most table in the FROM clause of that same SELECT statement and
1255** the table has a cursor number of "base". pIdx is an index on pTab.
1256**
1257** nEqCol is the number of columns of pIdx that are used as equality
1258** constraints. Any of these columns may be missing from the ORDER BY
1259** clause and the match can still be a success.
1260**
drh51669862004-12-18 18:40:26 +00001261** All terms of the ORDER BY that match against the index must be either
1262** ASC or DESC. (Terms of the ORDER BY clause past the end of a UNIQUE
1263** index do not need to satisfy this constraint.) The *pbRev value is
1264** set to 1 if the ORDER BY clause is all DESC and it is set to 0 if
1265** the ORDER BY clause is all ASC.
1266*/
1267static int isSortingIndex(
1268 Parse *pParse, /* Parsing context */
drh111a6a72008-12-21 03:51:16 +00001269 WhereMaskSet *pMaskSet, /* Mapping from table cursor numbers to bitmaps */
drh51669862004-12-18 18:40:26 +00001270 Index *pIdx, /* The index we are testing */
drh74161702006-02-24 02:53:49 +00001271 int base, /* Cursor number for the table to be sorted */
drh51669862004-12-18 18:40:26 +00001272 ExprList *pOrderBy, /* The ORDER BY clause */
1273 int nEqCol, /* Number of index columns with == constraints */
1274 int *pbRev /* Set to 1 if ORDER BY is DESC */
1275){
drhb46b5772005-08-29 16:40:52 +00001276 int i, j; /* Loop counters */
drh85eeb692005-12-21 03:16:42 +00001277 int sortOrder = 0; /* XOR of index and ORDER BY sort direction */
drhb46b5772005-08-29 16:40:52 +00001278 int nTerm; /* Number of ORDER BY terms */
1279 struct ExprList_item *pTerm; /* A term of the ORDER BY clause */
drh51669862004-12-18 18:40:26 +00001280 sqlite3 *db = pParse->db;
1281
1282 assert( pOrderBy!=0 );
1283 nTerm = pOrderBy->nExpr;
1284 assert( nTerm>0 );
1285
1286 /* Match terms of the ORDER BY clause against columns of
1287 ** the index.
drhcc192542006-12-20 03:24:19 +00001288 **
1289 ** Note that indices have pIdx->nColumn regular columns plus
1290 ** one additional column containing the rowid. The rowid column
1291 ** of the index is also allowed to match against the ORDER BY
1292 ** clause.
drh51669862004-12-18 18:40:26 +00001293 */
drhcc192542006-12-20 03:24:19 +00001294 for(i=j=0, pTerm=pOrderBy->a; j<nTerm && i<=pIdx->nColumn; i++){
drh51669862004-12-18 18:40:26 +00001295 Expr *pExpr; /* The expression of the ORDER BY pTerm */
1296 CollSeq *pColl; /* The collating sequence of pExpr */
drh85eeb692005-12-21 03:16:42 +00001297 int termSortOrder; /* Sort order for this term */
drhcc192542006-12-20 03:24:19 +00001298 int iColumn; /* The i-th column of the index. -1 for rowid */
1299 int iSortOrder; /* 1 for DESC, 0 for ASC on the i-th index term */
1300 const char *zColl; /* Name of the collating sequence for i-th index term */
drh51669862004-12-18 18:40:26 +00001301
1302 pExpr = pTerm->pExpr;
1303 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=base ){
1304 /* Can not use an index sort on anything that is not a column in the
1305 ** left-most table of the FROM clause */
drh7b4fc6a2007-02-06 13:26:32 +00001306 break;
drh51669862004-12-18 18:40:26 +00001307 }
1308 pColl = sqlite3ExprCollSeq(pParse, pExpr);
drhcc192542006-12-20 03:24:19 +00001309 if( !pColl ){
1310 pColl = db->pDfltColl;
1311 }
1312 if( i<pIdx->nColumn ){
1313 iColumn = pIdx->aiColumn[i];
1314 if( iColumn==pIdx->pTable->iPKey ){
1315 iColumn = -1;
1316 }
1317 iSortOrder = pIdx->aSortOrder[i];
1318 zColl = pIdx->azColl[i];
1319 }else{
1320 iColumn = -1;
1321 iSortOrder = 0;
1322 zColl = pColl->zName;
1323 }
1324 if( pExpr->iColumn!=iColumn || sqlite3StrICmp(pColl->zName, zColl) ){
drh9012bcb2004-12-19 00:11:35 +00001325 /* Term j of the ORDER BY clause does not match column i of the index */
1326 if( i<nEqCol ){
drh51669862004-12-18 18:40:26 +00001327 /* If an index column that is constrained by == fails to match an
1328 ** ORDER BY term, that is OK. Just ignore that column of the index
1329 */
1330 continue;
drhff354e92008-06-25 02:47:57 +00001331 }else if( i==pIdx->nColumn ){
1332 /* Index column i is the rowid. All other terms match. */
1333 break;
drh51669862004-12-18 18:40:26 +00001334 }else{
1335 /* If an index column fails to match and is not constrained by ==
1336 ** then the index cannot satisfy the ORDER BY constraint.
1337 */
1338 return 0;
1339 }
1340 }
danielk1977b3bf5562006-01-10 17:58:23 +00001341 assert( pIdx->aSortOrder!=0 );
drh85eeb692005-12-21 03:16:42 +00001342 assert( pTerm->sortOrder==0 || pTerm->sortOrder==1 );
drhcc192542006-12-20 03:24:19 +00001343 assert( iSortOrder==0 || iSortOrder==1 );
1344 termSortOrder = iSortOrder ^ pTerm->sortOrder;
drh51669862004-12-18 18:40:26 +00001345 if( i>nEqCol ){
drh85eeb692005-12-21 03:16:42 +00001346 if( termSortOrder!=sortOrder ){
drh51669862004-12-18 18:40:26 +00001347 /* Indices can only be used if all ORDER BY terms past the
1348 ** equality constraints are all either DESC or ASC. */
1349 return 0;
1350 }
1351 }else{
drh85eeb692005-12-21 03:16:42 +00001352 sortOrder = termSortOrder;
drh51669862004-12-18 18:40:26 +00001353 }
1354 j++;
1355 pTerm++;
drh7b4fc6a2007-02-06 13:26:32 +00001356 if( iColumn<0 && !referencesOtherTables(pOrderBy, pMaskSet, j, base) ){
drhcc192542006-12-20 03:24:19 +00001357 /* If the indexed column is the primary key and everything matches
drh7b4fc6a2007-02-06 13:26:32 +00001358 ** so far and none of the ORDER BY terms to the right reference other
1359 ** tables in the join, then we are assured that the index can be used
1360 ** to sort because the primary key is unique and so none of the other
1361 ** columns will make any difference
drhcc192542006-12-20 03:24:19 +00001362 */
1363 j = nTerm;
1364 }
drh51669862004-12-18 18:40:26 +00001365 }
1366
drhcc192542006-12-20 03:24:19 +00001367 *pbRev = sortOrder!=0;
drh8718f522005-08-13 16:13:04 +00001368 if( j>=nTerm ){
drhcc192542006-12-20 03:24:19 +00001369 /* All terms of the ORDER BY clause are covered by this index so
1370 ** this index can be used for sorting. */
1371 return 1;
1372 }
drh7b4fc6a2007-02-06 13:26:32 +00001373 if( pIdx->onError!=OE_None && i==pIdx->nColumn
1374 && !referencesOtherTables(pOrderBy, pMaskSet, j, base) ){
drhcc192542006-12-20 03:24:19 +00001375 /* All terms of this index match some prefix of the ORDER BY clause
drh7b4fc6a2007-02-06 13:26:32 +00001376 ** and the index is UNIQUE and no terms on the tail of the ORDER BY
1377 ** clause reference other tables in a join. If this is all true then
1378 ** the order by clause is superfluous. */
drh51669862004-12-18 18:40:26 +00001379 return 1;
1380 }
1381 return 0;
1382}
1383
1384/*
drhb6c29892004-11-22 19:12:19 +00001385** Check table to see if the ORDER BY clause in pOrderBy can be satisfied
1386** by sorting in order of ROWID. Return true if so and set *pbRev to be
1387** true for reverse ROWID and false for forward ROWID order.
1388*/
1389static int sortableByRowid(
1390 int base, /* Cursor number for table to be sorted */
1391 ExprList *pOrderBy, /* The ORDER BY clause */
drh111a6a72008-12-21 03:51:16 +00001392 WhereMaskSet *pMaskSet, /* Mapping from table cursors to bitmaps */
drhb6c29892004-11-22 19:12:19 +00001393 int *pbRev /* Set to 1 if ORDER BY is DESC */
1394){
1395 Expr *p;
1396
1397 assert( pOrderBy!=0 );
1398 assert( pOrderBy->nExpr>0 );
1399 p = pOrderBy->a[0].pExpr;
drh7b4fc6a2007-02-06 13:26:32 +00001400 if( p->op==TK_COLUMN && p->iTable==base && p->iColumn==-1
1401 && !referencesOtherTables(pOrderBy, pMaskSet, 1, base) ){
drhb6c29892004-11-22 19:12:19 +00001402 *pbRev = pOrderBy->a[0].sortOrder;
1403 return 1;
1404 }
1405 return 0;
1406}
1407
drhfe05af82005-07-21 03:14:59 +00001408/*
drhb6fb62d2005-09-20 08:47:20 +00001409** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +00001410** The results need not be exact. This is only used for estimating
drh909626d2008-05-30 14:58:37 +00001411** the total cost of performing operations with O(logN) or O(NlogN)
drh28c4cf42005-07-27 20:41:43 +00001412** complexity. Because N is just a guess, it is no great tragedy if
1413** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +00001414*/
1415static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +00001416 double logN = 1;
1417 double x = 10;
drh28c4cf42005-07-27 20:41:43 +00001418 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +00001419 logN += 1;
drh28c4cf42005-07-27 20:41:43 +00001420 x *= 10;
1421 }
1422 return logN;
1423}
1424
drh6d209d82006-06-27 01:54:26 +00001425/*
1426** Two routines for printing the content of an sqlite3_index_info
1427** structure. Used for testing and debugging only. If neither
1428** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1429** are no-ops.
1430*/
drh77a2a5e2007-04-06 01:04:39 +00001431#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_DEBUG)
drh6d209d82006-06-27 01:54:26 +00001432static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1433 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001434 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001435 for(i=0; i<p->nConstraint; i++){
1436 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1437 i,
1438 p->aConstraint[i].iColumn,
1439 p->aConstraint[i].iTermOffset,
1440 p->aConstraint[i].op,
1441 p->aConstraint[i].usable);
1442 }
1443 for(i=0; i<p->nOrderBy; i++){
1444 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1445 i,
1446 p->aOrderBy[i].iColumn,
1447 p->aOrderBy[i].desc);
1448 }
1449}
1450static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1451 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001452 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001453 for(i=0; i<p->nConstraint; i++){
1454 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1455 i,
1456 p->aConstraintUsage[i].argvIndex,
1457 p->aConstraintUsage[i].omit);
1458 }
1459 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1460 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1461 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1462 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
1463}
1464#else
1465#define TRACE_IDX_INPUTS(A)
1466#define TRACE_IDX_OUTPUTS(A)
1467#endif
1468
drh9eff6162006-06-12 21:59:13 +00001469#ifndef SQLITE_OMIT_VIRTUALTABLE
1470/*
drh7f375902006-06-13 17:38:59 +00001471** Compute the best index for a virtual table.
1472**
1473** The best index is computed by the xBestIndex method of the virtual
1474** table module. This routine is really just a wrapper that sets up
1475** the sqlite3_index_info structure that is used to communicate with
1476** xBestIndex.
1477**
1478** In a join, this routine might be called multiple times for the
1479** same virtual table. The sqlite3_index_info structure is created
1480** and initialized on the first invocation and reused on all subsequent
1481** invocations. The sqlite3_index_info structure is also used when
1482** code is generated to access the virtual table. The whereInfoDelete()
1483** routine takes care of freeing the sqlite3_index_info structure after
1484** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00001485*/
1486static double bestVirtualIndex(
1487 Parse *pParse, /* The parsing context */
1488 WhereClause *pWC, /* The WHERE clause */
1489 struct SrcList_item *pSrc, /* The FROM clause term to search */
1490 Bitmask notReady, /* Mask of cursors that are not available */
1491 ExprList *pOrderBy, /* The order by clause */
1492 int orderByUsable, /* True if we can potential sort */
1493 sqlite3_index_info **ppIdxInfo /* Index information passed to xBestIndex */
1494){
1495 Table *pTab = pSrc->pTab;
danielk19773e3a84d2008-08-01 17:37:40 +00001496 sqlite3_vtab *pVtab = pTab->pVtab;
drh9eff6162006-06-12 21:59:13 +00001497 sqlite3_index_info *pIdxInfo;
1498 struct sqlite3_index_constraint *pIdxCons;
1499 struct sqlite3_index_orderby *pIdxOrderBy;
1500 struct sqlite3_index_constraint_usage *pUsage;
1501 WhereTerm *pTerm;
1502 int i, j;
1503 int nOrderBy;
danielk197774cdba42006-06-19 12:02:58 +00001504 int rc;
drh9eff6162006-06-12 21:59:13 +00001505
1506 /* If the sqlite3_index_info structure has not been previously
1507 ** allocated and initialized for this virtual table, then allocate
1508 ** and initialize it now
1509 */
1510 pIdxInfo = *ppIdxInfo;
1511 if( pIdxInfo==0 ){
drh9eff6162006-06-12 21:59:13 +00001512 int nTerm;
drh4f0c5872007-03-26 22:05:01 +00001513 WHERETRACE(("Recomputing index info for %s...\n", pTab->zName));
drh9eff6162006-06-12 21:59:13 +00001514
1515 /* Count the number of possible WHERE clause constraints referring
1516 ** to this virtual table */
1517 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1518 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh4d9f9e62008-08-25 12:08:22 +00001519 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
drh981642f2008-04-19 14:40:43 +00001520 testcase( pTerm->eOperator==WO_IN );
1521 testcase( pTerm->eOperator==WO_ISNULL );
1522 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drh9eff6162006-06-12 21:59:13 +00001523 nTerm++;
1524 }
1525
1526 /* If the ORDER BY clause contains only columns in the current
1527 ** virtual table then allocate space for the aOrderBy part of
1528 ** the sqlite3_index_info structure.
1529 */
1530 nOrderBy = 0;
1531 if( pOrderBy ){
1532 for(i=0; i<pOrderBy->nExpr; i++){
1533 Expr *pExpr = pOrderBy->a[i].pExpr;
1534 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
1535 }
1536 if( i==pOrderBy->nExpr ){
1537 nOrderBy = pOrderBy->nExpr;
1538 }
1539 }
1540
1541 /* Allocate the sqlite3_index_info structure
1542 */
danielk197726783a52007-08-29 14:06:22 +00001543 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
drh9eff6162006-06-12 21:59:13 +00001544 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
1545 + sizeof(*pIdxOrderBy)*nOrderBy );
1546 if( pIdxInfo==0 ){
1547 sqlite3ErrorMsg(pParse, "out of memory");
1548 return 0.0;
1549 }
1550 *ppIdxInfo = pIdxInfo;
1551
1552 /* Initialize the structure. The sqlite3_index_info structure contains
1553 ** many fields that are declared "const" to prevent xBestIndex from
1554 ** changing them. We have to do some funky casting in order to
1555 ** initialize those fields.
1556 */
1557 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
1558 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
1559 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
1560 *(int*)&pIdxInfo->nConstraint = nTerm;
1561 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
1562 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
1563 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
1564 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
1565 pUsage;
1566
1567 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1568 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh4d9f9e62008-08-25 12:08:22 +00001569 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
drh981642f2008-04-19 14:40:43 +00001570 testcase( pTerm->eOperator==WO_IN );
1571 testcase( pTerm->eOperator==WO_ISNULL );
1572 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drh700a2262008-12-17 19:22:15 +00001573 pIdxCons[j].iColumn = pTerm->u.leftColumn;
drh9eff6162006-06-12 21:59:13 +00001574 pIdxCons[j].iTermOffset = i;
drhec1724e2008-12-09 01:32:03 +00001575 pIdxCons[j].op = (u8)pTerm->eOperator;
drh7f375902006-06-13 17:38:59 +00001576 /* The direct assignment in the previous line is possible only because
1577 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
1578 ** following asserts verify this fact. */
drh9eff6162006-06-12 21:59:13 +00001579 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
1580 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
1581 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
1582 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
1583 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
drh7f375902006-06-13 17:38:59 +00001584 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
1585 assert( pTerm->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
drh9eff6162006-06-12 21:59:13 +00001586 j++;
1587 }
1588 for(i=0; i<nOrderBy; i++){
1589 Expr *pExpr = pOrderBy->a[i].pExpr;
1590 pIdxOrderBy[i].iColumn = pExpr->iColumn;
1591 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
1592 }
1593 }
1594
drh7f375902006-06-13 17:38:59 +00001595 /* At this point, the sqlite3_index_info structure that pIdxInfo points
1596 ** to will have been initialized, either during the current invocation or
1597 ** during some prior invocation. Now we just have to customize the
1598 ** details of pIdxInfo for the current invocation and pass it to
1599 ** xBestIndex.
1600 */
1601
danielk1977935ed5e2007-03-30 09:13:13 +00001602 /* The module name must be defined. Also, by this point there must
1603 ** be a pointer to an sqlite3_vtab structure. Otherwise
1604 ** sqlite3ViewGetColumnNames() would have picked up the error.
1605 */
drh9eff6162006-06-12 21:59:13 +00001606 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
danielk19773e3a84d2008-08-01 17:37:40 +00001607 assert( pVtab );
danielk1977935ed5e2007-03-30 09:13:13 +00001608#if 0
drh9eff6162006-06-12 21:59:13 +00001609 if( pTab->pVtab==0 ){
1610 sqlite3ErrorMsg(pParse, "undefined module %s for table %s",
1611 pTab->azModuleArg[0], pTab->zName);
1612 return 0.0;
1613 }
danielk1977935ed5e2007-03-30 09:13:13 +00001614#endif
drh9eff6162006-06-12 21:59:13 +00001615
1616 /* Set the aConstraint[].usable fields and initialize all
drh7f375902006-06-13 17:38:59 +00001617 ** output variables to zero.
1618 **
1619 ** aConstraint[].usable is true for constraints where the right-hand
1620 ** side contains only references to tables to the left of the current
1621 ** table. In other words, if the constraint is of the form:
1622 **
1623 ** column = expr
1624 **
1625 ** and we are evaluating a join, then the constraint on column is
1626 ** only valid if all tables referenced in expr occur to the left
1627 ** of the table containing column.
1628 **
1629 ** The aConstraints[] array contains entries for all constraints
1630 ** on the current table. That way we only have to compute it once
1631 ** even though we might try to pick the best index multiple times.
1632 ** For each attempt at picking an index, the order of tables in the
1633 ** join might be different so we have to recompute the usable flag
1634 ** each time.
drh9eff6162006-06-12 21:59:13 +00001635 */
1636 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
1637 pUsage = pIdxInfo->aConstraintUsage;
1638 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
1639 j = pIdxCons->iTermOffset;
1640 pTerm = &pWC->a[j];
drhec1724e2008-12-09 01:32:03 +00001641 pIdxCons->usable = (pTerm->prereqRight & notReady)==0 ?1:0;
drh9eff6162006-06-12 21:59:13 +00001642 }
1643 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
drh4be8b512006-06-13 23:51:34 +00001644 if( pIdxInfo->needToFreeIdxStr ){
1645 sqlite3_free(pIdxInfo->idxStr);
1646 }
1647 pIdxInfo->idxStr = 0;
1648 pIdxInfo->idxNum = 0;
1649 pIdxInfo->needToFreeIdxStr = 0;
drh9eff6162006-06-12 21:59:13 +00001650 pIdxInfo->orderByConsumed = 0;
danielk197793626f42006-06-20 13:07:27 +00001651 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / 2.0;
drh9eff6162006-06-12 21:59:13 +00001652 nOrderBy = pIdxInfo->nOrderBy;
1653 if( pIdxInfo->nOrderBy && !orderByUsable ){
drha967e882006-06-13 01:04:52 +00001654 *(int*)&pIdxInfo->nOrderBy = 0;
drh9eff6162006-06-12 21:59:13 +00001655 }
danielk197774cdba42006-06-19 12:02:58 +00001656
drh7e8b8482008-01-23 03:03:05 +00001657 (void)sqlite3SafetyOff(pParse->db);
drh4f0c5872007-03-26 22:05:01 +00001658 WHERETRACE(("xBestIndex for %s\n", pTab->zName));
drh6d209d82006-06-27 01:54:26 +00001659 TRACE_IDX_INPUTS(pIdxInfo);
danielk19773e3a84d2008-08-01 17:37:40 +00001660 rc = pVtab->pModule->xBestIndex(pVtab, pIdxInfo);
drh6d209d82006-06-27 01:54:26 +00001661 TRACE_IDX_OUTPUTS(pIdxInfo);
danielk197739359dc2008-03-17 09:36:44 +00001662 (void)sqlite3SafetyOn(pParse->db);
1663
danielk19773e3a84d2008-08-01 17:37:40 +00001664 if( rc!=SQLITE_OK ){
1665 if( rc==SQLITE_NOMEM ){
1666 pParse->db->mallocFailed = 1;
1667 }else if( !pVtab->zErrMsg ){
1668 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
1669 }else{
1670 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
1671 }
1672 }
1673 sqlite3DbFree(pParse->db, pVtab->zErrMsg);
1674 pVtab->zErrMsg = 0;
1675
danielk197739359dc2008-03-17 09:36:44 +00001676 for(i=0; i<pIdxInfo->nConstraint; i++){
1677 if( !pIdxInfo->aConstraint[i].usable && pUsage[i].argvIndex>0 ){
1678 sqlite3ErrorMsg(pParse,
1679 "table %s: xBestIndex returned an invalid plan", pTab->zName);
1680 return 0.0;
1681 }
1682 }
1683
drha967e882006-06-13 01:04:52 +00001684 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
drh9eff6162006-06-12 21:59:13 +00001685 return pIdxInfo->estimatedCost;
1686}
1687#endif /* SQLITE_OMIT_VIRTUALTABLE */
1688
drh28c4cf42005-07-27 20:41:43 +00001689/*
drh111a6a72008-12-21 03:51:16 +00001690** Find the query plan for accessing a particular table. Write the
1691** best query plan and its cost into the WhereCost object supplied as the
1692** last parameter.
drh51147ba2005-07-23 22:59:55 +00001693**
drh111a6a72008-12-21 03:51:16 +00001694** The lowest cost plan wins. The cost is an estimate of the amount of
1695** CPU and disk I/O need to process the request using the selected plan.
drh51147ba2005-07-23 22:59:55 +00001696** Factors that influence cost include:
1697**
1698** * The estimated number of rows that will be retrieved. (The
1699** fewer the better.)
1700**
1701** * Whether or not sorting must occur.
1702**
1703** * Whether or not there must be separate lookups in the
1704** index and in the main table.
1705**
danielk197785574e32008-10-06 05:32:18 +00001706** If there was an INDEXED BY clause attached to the table in the SELECT
drh111a6a72008-12-21 03:51:16 +00001707** statement, then this function only considers plans using the
danielk197785574e32008-10-06 05:32:18 +00001708** named index. If one cannot be found, then the returned cost is
drh111a6a72008-12-21 03:51:16 +00001709** SQLITE_BIG_DBL. If a plan can be found that uses the named index,
danielk197785574e32008-10-06 05:32:18 +00001710** then the cost is calculated in the usual way.
1711**
1712** If a NOT INDEXED clause was attached to the table in the SELECT
1713** statement, then no indexes are considered. However, the selected
drh111a6a72008-12-21 03:51:16 +00001714** plan may still take advantage of the tables built-in rowid
danielk197785574e32008-10-06 05:32:18 +00001715** index.
drhfe05af82005-07-21 03:14:59 +00001716*/
drh111a6a72008-12-21 03:51:16 +00001717static void bestIndex(
drhfe05af82005-07-21 03:14:59 +00001718 Parse *pParse, /* The parsing context */
1719 WhereClause *pWC, /* The WHERE clause */
1720 struct SrcList_item *pSrc, /* The FROM clause term to search */
1721 Bitmask notReady, /* Mask of cursors that are not available */
drh111a6a72008-12-21 03:51:16 +00001722 ExprList *pOrderBy, /* The ORDER BY clause */
1723 WhereCost *pCost /* Lowest cost query plan */
drhfe05af82005-07-21 03:14:59 +00001724){
drh111a6a72008-12-21 03:51:16 +00001725 WhereTerm *pTerm; /* A single term of the WHERE clause */
drh51147ba2005-07-23 22:59:55 +00001726 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
1727 Index *pProbe; /* An index we are evaluating */
1728 int rev; /* True to scan in reverse order */
drh165be382008-12-05 02:36:33 +00001729 int wsFlags; /* Flags associated with pProbe */
drh51147ba2005-07-23 22:59:55 +00001730 int nEq; /* Number of == or IN constraints */
drhc49de5d2007-01-19 01:06:01 +00001731 int eqTermMask; /* Mask of valid equality operators */
drh51147ba2005-07-23 22:59:55 +00001732 double cost; /* Cost of using pProbe */
drh111a6a72008-12-21 03:51:16 +00001733 double nRow; /* Estimated number of rows in result set */
drhdd5f5a62008-12-23 13:35:23 +00001734 int i; /* Loop counter */
1735 Bitmask maskSrc; /* Bitmask for the pSrc table */
drhfe05af82005-07-21 03:14:59 +00001736
drh165be382008-12-05 02:36:33 +00001737 WHERETRACE(("bestIndex: tbl=%s notReady=%llx\n", pSrc->pTab->zName,notReady));
drh4dd238a2006-03-28 23:55:57 +00001738 pProbe = pSrc->pTab->pIndex;
danielk197785574e32008-10-06 05:32:18 +00001739 if( pSrc->notIndexed ){
1740 pProbe = 0;
1741 }
drh4dd238a2006-03-28 23:55:57 +00001742
1743 /* If the table has no indices and there are no terms in the where
1744 ** clause that refer to the ROWID, then we will never be able to do
1745 ** anything other than a full table scan on this table. We might as
1746 ** well put it first in the join order. That way, perhaps it can be
1747 ** referenced by other tables in the join.
1748 */
drh111a6a72008-12-21 03:51:16 +00001749 memset(pCost, 0, sizeof(*pCost));
drh4dd238a2006-03-28 23:55:57 +00001750 if( pProbe==0 &&
1751 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 +00001752 (pOrderBy==0 || !sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev)) ){
drh111a6a72008-12-21 03:51:16 +00001753 return;
drh4dd238a2006-03-28 23:55:57 +00001754 }
drh111a6a72008-12-21 03:51:16 +00001755 pCost->rCost = SQLITE_BIG_DBL;
drh51147ba2005-07-23 22:59:55 +00001756
danielk197785574e32008-10-06 05:32:18 +00001757 /* Check for a rowid=EXPR or rowid IN (...) constraints. If there was
1758 ** an INDEXED BY clause attached to this table, skip this step.
drhfe05af82005-07-21 03:14:59 +00001759 */
danielk197785574e32008-10-06 05:32:18 +00001760 if( !pSrc->pIndex ){
1761 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
1762 if( pTerm ){
1763 Expr *pExpr;
drh111a6a72008-12-21 03:51:16 +00001764 pCost->plan.wsFlags = WHERE_ROWID_EQ;
danielk197785574e32008-10-06 05:32:18 +00001765 if( pTerm->eOperator & WO_EQ ){
1766 /* Rowid== is always the best pick. Look no further. Because only
1767 ** a single row is generated, output is always in sorted order */
drh111a6a72008-12-21 03:51:16 +00001768 pCost->plan.wsFlags = WHERE_ROWID_EQ | WHERE_UNIQUE;
1769 pCost->plan.nEq = 1;
danielk197785574e32008-10-06 05:32:18 +00001770 WHERETRACE(("... best is rowid\n"));
drh111a6a72008-12-21 03:51:16 +00001771 pCost->rCost = 0;
1772 pCost->nRow = 1;
1773 return;
danielk197785574e32008-10-06 05:32:18 +00001774 }else if( (pExpr = pTerm->pExpr)->pList!=0 ){
1775 /* Rowid IN (LIST): cost is NlogN where N is the number of list
1776 ** elements. */
drh111a6a72008-12-21 03:51:16 +00001777 pCost->rCost = pCost->nRow = pExpr->pList->nExpr;
1778 pCost->rCost *= estLog(pCost->rCost);
danielk197785574e32008-10-06 05:32:18 +00001779 }else{
1780 /* Rowid IN (SELECT): cost is NlogN where N is the number of rows
1781 ** in the result of the inner select. We have no way to estimate
1782 ** that value so make a wild guess. */
drh111a6a72008-12-21 03:51:16 +00001783 pCost->nRow = 100;
1784 pCost->rCost = 200;
drh28c4cf42005-07-27 20:41:43 +00001785 }
drh111a6a72008-12-21 03:51:16 +00001786 WHERETRACE(("... rowid IN cost: %.9g\n", pCost->rCost));
drh51147ba2005-07-23 22:59:55 +00001787 }
danielk197785574e32008-10-06 05:32:18 +00001788
1789 /* Estimate the cost of a table scan. If we do not know how many
1790 ** entries are in the table, use 1 million as a guess.
1791 */
1792 cost = pProbe ? pProbe->aiRowEst[0] : 1000000;
1793 WHERETRACE(("... table scan base cost: %.9g\n", cost));
drh165be382008-12-05 02:36:33 +00001794 wsFlags = WHERE_ROWID_RANGE;
danielk197785574e32008-10-06 05:32:18 +00001795
1796 /* Check for constraints on a range of rowids in a table scan.
1797 */
1798 pTerm = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE|WO_GT|WO_GE, 0);
1799 if( pTerm ){
1800 if( findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0) ){
drh165be382008-12-05 02:36:33 +00001801 wsFlags |= WHERE_TOP_LIMIT;
drh700a2262008-12-17 19:22:15 +00001802 cost /= 3; /* Guess that rowid<EXPR eliminates two-thirds of rows */
danielk197785574e32008-10-06 05:32:18 +00001803 }
1804 if( findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0) ){
drh165be382008-12-05 02:36:33 +00001805 wsFlags |= WHERE_BTM_LIMIT;
danielk197785574e32008-10-06 05:32:18 +00001806 cost /= 3; /* Guess that rowid>EXPR eliminates two-thirds of rows */
1807 }
1808 WHERETRACE(("... rowid range reduces cost to %.9g\n", cost));
1809 }else{
drh165be382008-12-05 02:36:33 +00001810 wsFlags = 0;
danielk197785574e32008-10-06 05:32:18 +00001811 }
drh111a6a72008-12-21 03:51:16 +00001812 nRow = cost;
danielk197785574e32008-10-06 05:32:18 +00001813
1814 /* If the table scan does not satisfy the ORDER BY clause, increase
1815 ** the cost by NlogN to cover the expense of sorting. */
1816 if( pOrderBy ){
1817 if( sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev) ){
drh165be382008-12-05 02:36:33 +00001818 wsFlags |= WHERE_ORDERBY|WHERE_ROWID_RANGE;
danielk197785574e32008-10-06 05:32:18 +00001819 if( rev ){
drh165be382008-12-05 02:36:33 +00001820 wsFlags |= WHERE_REVERSE;
danielk197785574e32008-10-06 05:32:18 +00001821 }
1822 }else{
1823 cost += cost*estLog(cost);
1824 WHERETRACE(("... sorting increases cost to %.9g\n", cost));
1825 }
1826 }
drh111a6a72008-12-21 03:51:16 +00001827 if( cost<pCost->rCost ){
1828 pCost->rCost = cost;
1829 pCost->nRow = nRow;
1830 pCost->plan.wsFlags = wsFlags;
danielk197785574e32008-10-06 05:32:18 +00001831 }
drhfe05af82005-07-21 03:14:59 +00001832 }
1833
drh23d04d52008-12-23 23:56:22 +00001834#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00001835 /* Search for an OR-clause that can be used to look up the table.
1836 */
1837 maskSrc = getMask(pWC->pMaskSet, iCur);
1838 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1839 WhereClause tempWC;
1840 tempWC = *pWC;
drhdd5f5a62008-12-23 13:35:23 +00001841 if( pTerm->eOperator==WO_OR
1842 && ((pTerm->prereqAll & ~maskSrc) & notReady)==0
1843 && (pTerm->u.pOrInfo->indexable & maskSrc)!=0 ){
1844 WhereClause *pOrWC = &pTerm->u.pOrInfo->wc;
1845 WhereTerm *pOrTerm;
1846 int j;
1847 double rTotal = 0;
drh1c8781f2009-01-06 14:19:36 +00001848 nRow = 0;
drhdd5f5a62008-12-23 13:35:23 +00001849 for(j=0, pOrTerm=pOrWC->a; j<pOrWC->nTerm; j++, pOrTerm++){
1850 WhereCost sTermCost;
drh04bbcd52008-12-30 17:55:00 +00001851 WHERETRACE(("... Multi-index OR testing for term %d of %d....\n", j,i));
drh29435252008-12-28 18:35:08 +00001852 if( pOrTerm->eOperator==WO_AND ){
1853 WhereClause *pAndWC = &pOrTerm->u.pAndInfo->wc;
1854 bestIndex(pParse, pAndWC, pSrc, notReady, 0, &sTermCost);
1855 }else if( pOrTerm->leftCursor==iCur ){
1856 tempWC.a = pOrTerm;
drh04bbcd52008-12-30 17:55:00 +00001857 tempWC.nTerm = 1;
drh29435252008-12-28 18:35:08 +00001858 bestIndex(pParse, &tempWC, pSrc, notReady, 0, &sTermCost);
1859 }else{
1860 continue;
1861 }
drhdd5f5a62008-12-23 13:35:23 +00001862 rTotal += sTermCost.rCost;
1863 nRow += sTermCost.nRow;
drh103bd882009-01-08 21:00:02 +00001864 if( rTotal>=pCost->rCost ) break;
drhdd5f5a62008-12-23 13:35:23 +00001865 }
drh04bbcd52008-12-30 17:55:00 +00001866 WHERETRACE(("... multi-index OR cost=%.9g nrow=%.9g\n",
1867 rTotal, nRow));
drhdd5f5a62008-12-23 13:35:23 +00001868 if( rTotal<pCost->rCost ){
1869 pCost->rCost = rTotal;
1870 pCost->nRow = nRow;
1871 pCost->plan.wsFlags = WHERE_MULTI_OR;
1872 pCost->plan.u.pTerm = pTerm;
drhca8c4662008-12-28 20:47:02 +00001873 if( pOrderBy!=0
1874 && sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev)
1875 && !rev
1876 ){
1877 pCost->plan.wsFlags = WHERE_ORDERBY|WHERE_MULTI_OR;
1878 }
drhdd5f5a62008-12-23 13:35:23 +00001879 }
1880 }
1881 }
drh23d04d52008-12-23 23:56:22 +00001882#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00001883
drhc49de5d2007-01-19 01:06:01 +00001884 /* If the pSrc table is the right table of a LEFT JOIN then we may not
1885 ** use an index to satisfy IS NULL constraints on that table. This is
1886 ** because columns might end up being NULL if the table does not match -
1887 ** a circumstance which the index cannot help us discover. Ticket #2177.
1888 */
1889 if( (pSrc->jointype & JT_LEFT)!=0 ){
1890 eqTermMask = WO_EQ|WO_IN;
1891 }else{
1892 eqTermMask = WO_EQ|WO_IN|WO_ISNULL;
1893 }
1894
drhfe05af82005-07-21 03:14:59 +00001895 /* Look at each index.
1896 */
danielk197785574e32008-10-06 05:32:18 +00001897 if( pSrc->pIndex ){
1898 pProbe = pSrc->pIndex;
1899 }
1900 for(; pProbe; pProbe=(pSrc->pIndex ? 0 : pProbe->pNext)){
drhb37df7b2005-10-13 02:09:49 +00001901 double inMultiplier = 1;
drh51147ba2005-07-23 22:59:55 +00001902
drh4f0c5872007-03-26 22:05:01 +00001903 WHERETRACE(("... index %s:\n", pProbe->zName));
drhfe05af82005-07-21 03:14:59 +00001904
1905 /* Count the number of columns in the index that are satisfied
1906 ** by x=EXPR constraints or x IN (...) constraints.
1907 */
drh165be382008-12-05 02:36:33 +00001908 wsFlags = 0;
drhfe05af82005-07-21 03:14:59 +00001909 for(i=0; i<pProbe->nColumn; i++){
1910 int j = pProbe->aiColumn[i];
drhc49de5d2007-01-19 01:06:01 +00001911 pTerm = findTerm(pWC, iCur, j, notReady, eqTermMask, pProbe);
drhfe05af82005-07-21 03:14:59 +00001912 if( pTerm==0 ) break;
drh165be382008-12-05 02:36:33 +00001913 wsFlags |= WHERE_COLUMN_EQ;
drhb52076c2006-01-23 13:22:09 +00001914 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00001915 Expr *pExpr = pTerm->pExpr;
drh165be382008-12-05 02:36:33 +00001916 wsFlags |= WHERE_COLUMN_IN;
drha6110402005-07-28 20:51:19 +00001917 if( pExpr->pSelect!=0 ){
drhffe0f892006-05-11 13:26:25 +00001918 inMultiplier *= 25;
drh34004ce2008-07-11 16:15:17 +00001919 }else if( ALWAYS(pExpr->pList) ){
drhb37df7b2005-10-13 02:09:49 +00001920 inMultiplier *= pExpr->pList->nExpr + 1;
drhfe05af82005-07-21 03:14:59 +00001921 }
1922 }
1923 }
drh111a6a72008-12-21 03:51:16 +00001924 nRow = pProbe->aiRowEst[i] * inMultiplier;
1925 cost = nRow * estLog(inMultiplier);
drh51147ba2005-07-23 22:59:55 +00001926 nEq = i;
drh165be382008-12-05 02:36:33 +00001927 if( pProbe->onError!=OE_None && (wsFlags & WHERE_COLUMN_IN)==0
drh943af3c2005-07-29 19:43:58 +00001928 && nEq==pProbe->nColumn ){
drh165be382008-12-05 02:36:33 +00001929 wsFlags |= WHERE_UNIQUE;
drh943af3c2005-07-29 19:43:58 +00001930 }
drh8e70e342007-09-13 17:54:40 +00001931 WHERETRACE(("...... nEq=%d inMult=%.9g cost=%.9g\n",nEq,inMultiplier,cost));
drhfe05af82005-07-21 03:14:59 +00001932
drh51147ba2005-07-23 22:59:55 +00001933 /* Look for range constraints
drhfe05af82005-07-21 03:14:59 +00001934 */
drh51147ba2005-07-23 22:59:55 +00001935 if( nEq<pProbe->nColumn ){
1936 int j = pProbe->aiColumn[nEq];
1937 pTerm = findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE|WO_GT|WO_GE, pProbe);
1938 if( pTerm ){
drh165be382008-12-05 02:36:33 +00001939 wsFlags |= WHERE_COLUMN_RANGE;
drh51147ba2005-07-23 22:59:55 +00001940 if( findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE, pProbe) ){
drh165be382008-12-05 02:36:33 +00001941 wsFlags |= WHERE_TOP_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001942 cost /= 3;
drh111a6a72008-12-21 03:51:16 +00001943 nRow /= 3;
drh51147ba2005-07-23 22:59:55 +00001944 }
1945 if( findTerm(pWC, iCur, j, notReady, WO_GT|WO_GE, pProbe) ){
drh165be382008-12-05 02:36:33 +00001946 wsFlags |= WHERE_BTM_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001947 cost /= 3;
drh111a6a72008-12-21 03:51:16 +00001948 nRow /= 3;
drh51147ba2005-07-23 22:59:55 +00001949 }
drh4f0c5872007-03-26 22:05:01 +00001950 WHERETRACE(("...... range reduces cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001951 }
1952 }
1953
drh28c4cf42005-07-27 20:41:43 +00001954 /* Add the additional cost of sorting if that is a factor.
drh51147ba2005-07-23 22:59:55 +00001955 */
drh28c4cf42005-07-27 20:41:43 +00001956 if( pOrderBy ){
drh165be382008-12-05 02:36:33 +00001957 if( (wsFlags & WHERE_COLUMN_IN)==0 &&
drh7b4fc6a2007-02-06 13:26:32 +00001958 isSortingIndex(pParse,pWC->pMaskSet,pProbe,iCur,pOrderBy,nEq,&rev) ){
drh165be382008-12-05 02:36:33 +00001959 if( wsFlags==0 ){
1960 wsFlags = WHERE_COLUMN_RANGE;
drh28c4cf42005-07-27 20:41:43 +00001961 }
drh165be382008-12-05 02:36:33 +00001962 wsFlags |= WHERE_ORDERBY;
drh28c4cf42005-07-27 20:41:43 +00001963 if( rev ){
drh165be382008-12-05 02:36:33 +00001964 wsFlags |= WHERE_REVERSE;
drh28c4cf42005-07-27 20:41:43 +00001965 }
1966 }else{
1967 cost += cost*estLog(cost);
drh4f0c5872007-03-26 22:05:01 +00001968 WHERETRACE(("...... orderby increases cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001969 }
drhfe05af82005-07-21 03:14:59 +00001970 }
1971
1972 /* Check to see if we can get away with using just the index without
drh51147ba2005-07-23 22:59:55 +00001973 ** ever reading the table. If that is the case, then halve the
1974 ** cost of this index.
drhfe05af82005-07-21 03:14:59 +00001975 */
drh165be382008-12-05 02:36:33 +00001976 if( wsFlags && pSrc->colUsed < (((Bitmask)1)<<(BMS-1)) ){
drhfe05af82005-07-21 03:14:59 +00001977 Bitmask m = pSrc->colUsed;
1978 int j;
1979 for(j=0; j<pProbe->nColumn; j++){
1980 int x = pProbe->aiColumn[j];
1981 if( x<BMS-1 ){
1982 m &= ~(((Bitmask)1)<<x);
1983 }
1984 }
1985 if( m==0 ){
drh165be382008-12-05 02:36:33 +00001986 wsFlags |= WHERE_IDX_ONLY;
drhb37df7b2005-10-13 02:09:49 +00001987 cost /= 2;
drh4f0c5872007-03-26 22:05:01 +00001988 WHERETRACE(("...... idx-only reduces cost to %.9g\n", cost));
drhfe05af82005-07-21 03:14:59 +00001989 }
1990 }
1991
drh51147ba2005-07-23 22:59:55 +00001992 /* If this index has achieved the lowest cost so far, then use it.
drhfe05af82005-07-21 03:14:59 +00001993 */
drh111a6a72008-12-21 03:51:16 +00001994 if( wsFlags!=0 && cost < pCost->rCost ){
1995 pCost->rCost = cost;
1996 pCost->nRow = nRow;
1997 pCost->plan.wsFlags = wsFlags;
1998 pCost->plan.nEq = nEq;
1999 assert( pCost->plan.wsFlags & WHERE_INDEXED );
2000 pCost->plan.u.pIdx = pProbe;
drhfe05af82005-07-21 03:14:59 +00002001 }
2002 }
2003
drhfe05af82005-07-21 03:14:59 +00002004 /* Report the best result
2005 */
drh111a6a72008-12-21 03:51:16 +00002006 pCost->plan.wsFlags |= eqTermMask;
2007 WHERETRACE(("best index is %s, cost=%.9g, nrow=%.9g, wsFlags=%x, nEq=%d\n",
2008 (pCost->plan.wsFlags & WHERE_INDEXED)!=0 ?
2009 pCost->plan.u.pIdx->zName : "(none)", pCost->nRow,
2010 pCost->rCost, pCost->plan.wsFlags, pCost->plan.nEq));
drhfe05af82005-07-21 03:14:59 +00002011}
2012
drhb6c29892004-11-22 19:12:19 +00002013
2014/*
drh2ffb1182004-07-19 19:14:01 +00002015** Disable a term in the WHERE clause. Except, do not disable the term
2016** if it controls a LEFT OUTER JOIN and it did not originate in the ON
2017** or USING clause of that join.
2018**
2019** Consider the term t2.z='ok' in the following queries:
2020**
2021** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
2022** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
2023** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
2024**
drh23bf66d2004-12-14 03:34:34 +00002025** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00002026** in the ON clause. The term is disabled in (3) because it is not part
2027** of a LEFT OUTER JOIN. In (1), the term is not disabled.
2028**
2029** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00002030** of the join. Disabling is an optimization. When terms are satisfied
2031** by indices, we disable them to prevent redundant tests in the inner
2032** loop. We would get the correct results if nothing were ever disabled,
2033** but joins might run a little slower. The trick is to disable as much
2034** as we can without disabling too much. If we disabled in (1), we'd get
2035** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00002036*/
drh0fcef5e2005-07-19 17:38:22 +00002037static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
2038 if( pTerm
drh165be382008-12-05 02:36:33 +00002039 && ALWAYS((pTerm->wtFlags & TERM_CODED)==0)
drh0fcef5e2005-07-19 17:38:22 +00002040 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
2041 ){
drh165be382008-12-05 02:36:33 +00002042 pTerm->wtFlags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00002043 if( pTerm->iParent>=0 ){
2044 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
2045 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00002046 disableTerm(pLevel, pOther);
2047 }
drh0fcef5e2005-07-19 17:38:22 +00002048 }
drh2ffb1182004-07-19 19:14:01 +00002049 }
2050}
2051
2052/*
danielk1977b790c6c2008-04-18 10:25:24 +00002053** Apply the affinities associated with the first n columns of index
2054** pIdx to the values in the n registers starting at base.
drh94a11212004-09-25 13:12:14 +00002055*/
danielk1977b790c6c2008-04-18 10:25:24 +00002056static void codeApplyAffinity(Parse *pParse, int base, int n, Index *pIdx){
2057 if( n>0 ){
2058 Vdbe *v = pParse->pVdbe;
2059 assert( v!=0 );
2060 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
2061 sqlite3IndexAffinityStr(v, pIdx);
2062 sqlite3ExprCacheAffinityChange(pParse, base, n);
2063 }
drh94a11212004-09-25 13:12:14 +00002064}
2065
drhe8b97272005-07-19 22:22:12 +00002066
2067/*
drh51147ba2005-07-23 22:59:55 +00002068** Generate code for a single equality term of the WHERE clause. An equality
2069** term can be either X=expr or X IN (...). pTerm is the term to be
2070** coded.
2071**
drh1db639c2008-01-17 02:36:28 +00002072** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00002073**
2074** For a constraint of the form X=expr, the expression is evaluated and its
2075** result is left on the stack. For constraints of the form X IN (...)
2076** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00002077*/
drh678ccce2008-03-31 18:19:54 +00002078static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00002079 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00002080 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh1db639c2008-01-17 02:36:28 +00002081 WhereLevel *pLevel, /* When level of the FROM clause we are working on */
drh678ccce2008-03-31 18:19:54 +00002082 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00002083){
drh0fcef5e2005-07-19 17:38:22 +00002084 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00002085 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00002086 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00002087
danielk19772d605492008-10-01 08:43:03 +00002088 assert( iTarget>0 );
drh50b39962006-10-28 00:28:09 +00002089 if( pX->op==TK_EQ ){
drh678ccce2008-03-31 18:19:54 +00002090 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00002091 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00002092 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00002093 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00002094#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00002095 }else{
danielk19779a96b662007-11-29 17:05:18 +00002096 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00002097 int iTab;
drh72e8fa42007-03-28 14:30:06 +00002098 struct InLoop *pIn;
danielk1977b3bce662005-01-29 08:32:43 +00002099
drh50b39962006-10-28 00:28:09 +00002100 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00002101 iReg = iTarget;
danielk19770cdc0222008-06-26 18:04:03 +00002102 eType = sqlite3FindInIndex(pParse, pX, 0);
danielk1977b3bce662005-01-29 08:32:43 +00002103 iTab = pX->iTable;
drh66a51672008-01-03 00:01:23 +00002104 sqlite3VdbeAddOp2(v, OP_Rewind, iTab, 0);
drhd4e70eb2008-01-02 00:34:36 +00002105 VdbeComment((v, "%.*s", pX->span.n, pX->span.z));
drh111a6a72008-12-21 03:51:16 +00002106 assert( pLevel->plan.wsFlags & WHERE_IN_ABLE );
2107 if( pLevel->u.in.nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00002108 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00002109 }
drh111a6a72008-12-21 03:51:16 +00002110 pLevel->u.in.nIn++;
2111 pLevel->u.in.aInLoop =
2112 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
2113 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
2114 pIn = pLevel->u.in.aInLoop;
drh72e8fa42007-03-28 14:30:06 +00002115 if( pIn ){
drh111a6a72008-12-21 03:51:16 +00002116 pIn += pLevel->u.in.nIn - 1;
drh72e8fa42007-03-28 14:30:06 +00002117 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00002118 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00002119 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00002120 }else{
drhb3190c12008-12-08 21:37:14 +00002121 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00002122 }
2123 sqlite3VdbeAddOp1(v, OP_IsNull, iReg);
drha6110402005-07-28 20:51:19 +00002124 }else{
drh111a6a72008-12-21 03:51:16 +00002125 pLevel->u.in.nIn = 0;
drhe23399f2005-07-22 00:31:39 +00002126 }
danielk1977b3bce662005-01-29 08:32:43 +00002127#endif
drh94a11212004-09-25 13:12:14 +00002128 }
drh0fcef5e2005-07-19 17:38:22 +00002129 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00002130 return iReg;
drh94a11212004-09-25 13:12:14 +00002131}
2132
drh51147ba2005-07-23 22:59:55 +00002133/*
2134** Generate code that will evaluate all == and IN constraints for an
2135** index. The values for all constraints are left on the stack.
2136**
2137** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
2138** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
2139** The index has as many as three equality constraints, but in this
2140** example, the third "c" value is an inequality. So only two
2141** constraints are coded. This routine will generate code to evaluate
drh6df2acd2008-12-28 16:55:25 +00002142** a==5 and b IN (1,2,3). The current values for a and b will be stored
2143** in consecutive registers and the index of the first register is returned.
drh51147ba2005-07-23 22:59:55 +00002144**
2145** In the example above nEq==2. But this subroutine works for any value
2146** of nEq including 0. If nEq==0, this routine is nearly a no-op.
2147** The only thing it does is allocate the pLevel->iMem memory cell.
2148**
drh700a2262008-12-17 19:22:15 +00002149** This routine always allocates at least one memory cell and returns
2150** the index of that memory cell. The code that
2151** calls this routine will use that memory cell to store the termination
drh51147ba2005-07-23 22:59:55 +00002152** key value of the loop. If one or more IN operators appear, then
2153** this routine allocates an additional nEq memory cells for internal
2154** use.
2155*/
drh1db639c2008-01-17 02:36:28 +00002156static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00002157 Parse *pParse, /* Parsing context */
2158 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
2159 WhereClause *pWC, /* The WHERE clause */
drh1db639c2008-01-17 02:36:28 +00002160 Bitmask notReady, /* Which parts of FROM have not yet been coded */
2161 int nExtraReg /* Number of extra registers to allocate */
drh51147ba2005-07-23 22:59:55 +00002162){
drh111a6a72008-12-21 03:51:16 +00002163 int nEq = pLevel->plan.nEq; /* The number of == or IN constraints to code */
2164 Vdbe *v = pParse->pVdbe; /* The vm under construction */
2165 Index *pIdx; /* The index being used for this loop */
drh51147ba2005-07-23 22:59:55 +00002166 int iCur = pLevel->iTabCur; /* The cursor of the table */
2167 WhereTerm *pTerm; /* A single constraint term */
2168 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00002169 int regBase; /* Base register */
drh6df2acd2008-12-28 16:55:25 +00002170 int nReg; /* Number of registers to allocate */
drh51147ba2005-07-23 22:59:55 +00002171
drh111a6a72008-12-21 03:51:16 +00002172 /* This module is only called on query plans that use an index. */
2173 assert( pLevel->plan.wsFlags & WHERE_INDEXED );
2174 pIdx = pLevel->plan.u.pIdx;
2175
drh51147ba2005-07-23 22:59:55 +00002176 /* Figure out how many memory cells we will need then allocate them.
drh51147ba2005-07-23 22:59:55 +00002177 */
drh700a2262008-12-17 19:22:15 +00002178 regBase = pParse->nMem + 1;
drh6df2acd2008-12-28 16:55:25 +00002179 nReg = pLevel->plan.nEq + nExtraReg;
2180 pParse->nMem += nReg;
drh51147ba2005-07-23 22:59:55 +00002181
2182 /* Evaluate the equality constraints
2183 */
drhc49de5d2007-01-19 01:06:01 +00002184 assert( pIdx->nColumn>=nEq );
2185 for(j=0; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00002186 int r1;
drh51147ba2005-07-23 22:59:55 +00002187 int k = pIdx->aiColumn[j];
drh111a6a72008-12-21 03:51:16 +00002188 pTerm = findTerm(pWC, iCur, k, notReady, pLevel->plan.wsFlags, pIdx);
drh34004ce2008-07-11 16:15:17 +00002189 if( NEVER(pTerm==0) ) break;
drh165be382008-12-05 02:36:33 +00002190 assert( (pTerm->wtFlags & TERM_CODED)==0 );
drh678ccce2008-03-31 18:19:54 +00002191 r1 = codeEqualityTerm(pParse, pTerm, pLevel, regBase+j);
2192 if( r1!=regBase+j ){
drh6df2acd2008-12-28 16:55:25 +00002193 if( nReg==1 ){
2194 sqlite3ReleaseTempReg(pParse, regBase);
2195 regBase = r1;
2196 }else{
2197 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
2198 }
drh678ccce2008-03-31 18:19:54 +00002199 }
drh981642f2008-04-19 14:40:43 +00002200 testcase( pTerm->eOperator & WO_ISNULL );
2201 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00002202 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drhb3190c12008-12-08 21:37:14 +00002203 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
drh51147ba2005-07-23 22:59:55 +00002204 }
2205 }
drh1db639c2008-01-17 02:36:28 +00002206 return regBase;
drh51147ba2005-07-23 22:59:55 +00002207}
2208
drh111a6a72008-12-21 03:51:16 +00002209/*
drh23d04d52008-12-23 23:56:22 +00002210** Return TRUE if the WhereClause pWC contains no terms that
2211** are not virtual and which have not been coded.
2212**
2213** To put it another way, return TRUE if no additional WHERE clauses
2214** tests are required in order to establish that the current row
2215** should go to output and return FALSE if there are some terms of
2216** the WHERE clause that need to be validated before outputing the row.
2217*/
2218static int whereRowReadyForOutput(WhereClause *pWC){
2219 WhereTerm *pTerm;
2220 int j;
2221
2222 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2223 if( (pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED))==0 ) return 0;
2224 }
2225 return 1;
2226}
2227
2228/*
drh111a6a72008-12-21 03:51:16 +00002229** Generate code for the start of the iLevel-th loop in the WHERE clause
2230** implementation described by pWInfo.
2231*/
2232static Bitmask codeOneLoopStart(
2233 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
2234 int iLevel, /* Which level of pWInfo->a[] should be coded */
2235 u8 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
2236 Bitmask notReady /* Which tables are currently available */
2237){
2238 int j, k; /* Loop counters */
2239 int iCur; /* The VDBE cursor for the table */
2240 int addrNxt; /* Where to jump to continue with the next IN case */
2241 int omitTable; /* True if we use the index only */
2242 int bRev; /* True if we need to scan in reverse order */
2243 WhereLevel *pLevel; /* The where level to be coded */
2244 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
2245 WhereTerm *pTerm; /* A WHERE clause term */
2246 Parse *pParse; /* Parsing context */
2247 Vdbe *v; /* The prepared stmt under constructions */
2248 struct SrcList_item *pTabItem; /* FROM clause term being coded */
drh23d04d52008-12-23 23:56:22 +00002249 int addrBrk; /* Jump here to break out of the loop */
2250 int addrCont; /* Jump here to continue with next cycle */
2251 int regRowSet; /* Write rowids to this RowSet if non-negative */
2252 int codeRowSetEarly; /* True if index fully constrains the search */
drh111a6a72008-12-21 03:51:16 +00002253
2254
2255 pParse = pWInfo->pParse;
2256 v = pParse->pVdbe;
2257 pWC = pWInfo->pWC;
2258 pLevel = &pWInfo->a[iLevel];
2259 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
2260 iCur = pTabItem->iCursor;
2261 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
2262 omitTable = (pLevel->plan.wsFlags & WHERE_IDX_ONLY)!=0;
drh23d04d52008-12-23 23:56:22 +00002263 regRowSet = pWInfo->regRowSet;
2264 codeRowSetEarly = 0;
drh111a6a72008-12-21 03:51:16 +00002265
2266 /* Create labels for the "break" and "continue" instructions
2267 ** for the current loop. Jump to addrBrk to break out of a loop.
2268 ** Jump to cont to go immediately to the next iteration of the
2269 ** loop.
2270 **
2271 ** When there is an IN operator, we also have a "addrNxt" label that
2272 ** means to continue with the next IN value combination. When
2273 ** there are no IN operators in the constraints, the "addrNxt" label
2274 ** is the same as "addrBrk".
2275 */
2276 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
2277 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
2278
2279 /* If this is the right table of a LEFT OUTER JOIN, allocate and
2280 ** initialize a memory cell that records if this table matches any
2281 ** row of the left table of the join.
2282 */
2283 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
2284 pLevel->iLeftJoin = ++pParse->nMem;
2285 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
2286 VdbeComment((v, "init LEFT JOIN no-match flag"));
2287 }
2288
2289#ifndef SQLITE_OMIT_VIRTUALTABLE
2290 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
2291 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
2292 ** to access the data.
2293 */
2294 int iReg; /* P3 Value for OP_VFilter */
2295 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
2296 int nConstraint = pVtabIdx->nConstraint;
2297 struct sqlite3_index_constraint_usage *aUsage =
2298 pVtabIdx->aConstraintUsage;
2299 const struct sqlite3_index_constraint *aConstraint =
2300 pVtabIdx->aConstraint;
2301
2302 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
2303 pParse->disableColCache++;
2304 for(j=1; j<=nConstraint; j++){
2305 for(k=0; k<nConstraint; k++){
2306 if( aUsage[k].argvIndex==j ){
2307 int iTerm = aConstraint[k].iTermOffset;
2308 assert( pParse->disableColCache );
2309 sqlite3ExprCode(pParse, pWC->a[iTerm].pExpr->pRight, iReg+j+1);
2310 break;
2311 }
2312 }
2313 if( k==nConstraint ) break;
2314 }
2315 assert( pParse->disableColCache );
2316 pParse->disableColCache--;
2317 sqlite3VdbeAddOp2(v, OP_Integer, pVtabIdx->idxNum, iReg);
2318 sqlite3VdbeAddOp2(v, OP_Integer, j-1, iReg+1);
2319 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrBrk, iReg, pVtabIdx->idxStr,
2320 pVtabIdx->needToFreeIdxStr ? P4_MPRINTF : P4_STATIC);
drh111a6a72008-12-21 03:51:16 +00002321 pVtabIdx->needToFreeIdxStr = 0;
2322 for(j=0; j<nConstraint; j++){
2323 if( aUsage[j].omit ){
2324 int iTerm = aConstraint[j].iTermOffset;
2325 disableTerm(pLevel, &pWC->a[iTerm]);
2326 }
2327 }
2328 pLevel->op = OP_VNext;
2329 pLevel->p1 = iCur;
2330 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh23d04d52008-12-23 23:56:22 +00002331 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2332 if( codeRowSetEarly ){
2333 sqlite3VdbeAddOp2(v, OP_VRowid, iCur, iReg);
2334 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, iReg);
2335 }
2336 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drh111a6a72008-12-21 03:51:16 +00002337 }else
2338#endif /* SQLITE_OMIT_VIRTUALTABLE */
2339
2340 if( pLevel->plan.wsFlags & WHERE_ROWID_EQ ){
2341 /* Case 1: We can directly reference a single row using an
2342 ** equality comparison against the ROWID field. Or
2343 ** we reference multiple rows using a "rowid IN (...)"
2344 ** construct.
2345 */
2346 int r1;
2347 int rtmp = sqlite3GetTempReg(pParse);
2348 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
2349 assert( pTerm!=0 );
2350 assert( pTerm->pExpr!=0 );
2351 assert( pTerm->leftCursor==iCur );
2352 assert( omitTable==0 );
2353 r1 = codeEqualityTerm(pParse, pTerm, pLevel, rtmp);
2354 addrNxt = pLevel->addrNxt;
2355 sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, addrNxt);
2356 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, r1);
drh23d04d52008-12-23 23:56:22 +00002357 codeRowSetEarly = (pWC->nTerm==1 && regRowSet>=0) ?1:0;
2358 if( codeRowSetEarly ){
2359 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2360 }
drh111a6a72008-12-21 03:51:16 +00002361 sqlite3ReleaseTempReg(pParse, rtmp);
2362 VdbeComment((v, "pk"));
2363 pLevel->op = OP_Noop;
2364 }else if( pLevel->plan.wsFlags & WHERE_ROWID_RANGE ){
2365 /* Case 2: We have an inequality comparison against the ROWID field.
2366 */
2367 int testOp = OP_Noop;
2368 int start;
2369 int memEndValue = 0;
2370 WhereTerm *pStart, *pEnd;
2371
2372 assert( omitTable==0 );
2373 pStart = findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0);
2374 pEnd = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0);
2375 if( bRev ){
2376 pTerm = pStart;
2377 pStart = pEnd;
2378 pEnd = pTerm;
2379 }
2380 if( pStart ){
2381 Expr *pX; /* The expression that defines the start bound */
2382 int r1, rTemp; /* Registers for holding the start boundary */
2383
2384 /* The following constant maps TK_xx codes into corresponding
2385 ** seek opcodes. It depends on a particular ordering of TK_xx
2386 */
2387 const u8 aMoveOp[] = {
2388 /* TK_GT */ OP_SeekGt,
2389 /* TK_LE */ OP_SeekLe,
2390 /* TK_LT */ OP_SeekLt,
2391 /* TK_GE */ OP_SeekGe
2392 };
2393 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
2394 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
2395 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
2396
2397 pX = pStart->pExpr;
2398 assert( pX!=0 );
2399 assert( pStart->leftCursor==iCur );
2400 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
2401 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
2402 VdbeComment((v, "pk"));
2403 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
2404 sqlite3ReleaseTempReg(pParse, rTemp);
2405 disableTerm(pLevel, pStart);
2406 }else{
2407 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
2408 }
2409 if( pEnd ){
2410 Expr *pX;
2411 pX = pEnd->pExpr;
2412 assert( pX!=0 );
2413 assert( pEnd->leftCursor==iCur );
2414 memEndValue = ++pParse->nMem;
2415 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
2416 if( pX->op==TK_LT || pX->op==TK_GT ){
2417 testOp = bRev ? OP_Le : OP_Ge;
2418 }else{
2419 testOp = bRev ? OP_Lt : OP_Gt;
2420 }
2421 disableTerm(pLevel, pEnd);
2422 }
2423 start = sqlite3VdbeCurrentAddr(v);
2424 pLevel->op = bRev ? OP_Prev : OP_Next;
2425 pLevel->p1 = iCur;
2426 pLevel->p2 = start;
drhca8c4662008-12-28 20:47:02 +00002427 pLevel->p5 = (pStart==0 && pEnd==0) ?1:0;
drh23d04d52008-12-23 23:56:22 +00002428 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2429 if( codeRowSetEarly || testOp!=OP_Noop ){
drh111a6a72008-12-21 03:51:16 +00002430 int r1 = sqlite3GetTempReg(pParse);
2431 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, r1);
drh23d04d52008-12-23 23:56:22 +00002432 if( testOp!=OP_Noop ){
2433 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, r1);
2434 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
2435 }
2436 if( codeRowSetEarly ){
2437 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2438 }
drh111a6a72008-12-21 03:51:16 +00002439 sqlite3ReleaseTempReg(pParse, r1);
2440 }
2441 }else if( pLevel->plan.wsFlags & (WHERE_COLUMN_RANGE|WHERE_COLUMN_EQ) ){
2442 /* Case 3: A scan using an index.
2443 **
2444 ** The WHERE clause may contain zero or more equality
2445 ** terms ("==" or "IN" operators) that refer to the N
2446 ** left-most columns of the index. It may also contain
2447 ** inequality constraints (>, <, >= or <=) on the indexed
2448 ** column that immediately follows the N equalities. Only
2449 ** the right-most column can be an inequality - the rest must
2450 ** use the "==" and "IN" operators. For example, if the
2451 ** index is on (x,y,z), then the following clauses are all
2452 ** optimized:
2453 **
2454 ** x=5
2455 ** x=5 AND y=10
2456 ** x=5 AND y<10
2457 ** x=5 AND y>5 AND y<10
2458 ** x=5 AND y=5 AND z<=10
2459 **
2460 ** The z<10 term of the following cannot be used, only
2461 ** the x=5 term:
2462 **
2463 ** x=5 AND z<10
2464 **
2465 ** N may be zero if there are inequality constraints.
2466 ** If there are no inequality constraints, then N is at
2467 ** least one.
2468 **
2469 ** This case is also used when there are no WHERE clause
2470 ** constraints but an index is selected anyway, in order
2471 ** to force the output order to conform to an ORDER BY.
2472 */
2473 int aStartOp[] = {
2474 0,
2475 0,
2476 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
2477 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
2478 OP_SeekGt, /* 4: (start_constraints && !startEq && !bRev) */
2479 OP_SeekLt, /* 5: (start_constraints && !startEq && bRev) */
2480 OP_SeekGe, /* 6: (start_constraints && startEq && !bRev) */
2481 OP_SeekLe /* 7: (start_constraints && startEq && bRev) */
2482 };
2483 int aEndOp[] = {
2484 OP_Noop, /* 0: (!end_constraints) */
2485 OP_IdxGE, /* 1: (end_constraints && !bRev) */
2486 OP_IdxLT /* 2: (end_constraints && bRev) */
2487 };
2488 int nEq = pLevel->plan.nEq;
2489 int isMinQuery = 0; /* If this is an optimized SELECT min(x).. */
2490 int regBase; /* Base register holding constraint values */
2491 int r1; /* Temp register */
2492 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
2493 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
2494 int startEq; /* True if range start uses ==, >= or <= */
2495 int endEq; /* True if range end uses ==, >= or <= */
2496 int start_constraints; /* Start of range is constrained */
2497 int nConstraint; /* Number of constraint terms */
2498 Index *pIdx; /* The index we will be using */
2499 int iIdxCur; /* The VDBE cursor for the index */
drh6df2acd2008-12-28 16:55:25 +00002500 int nExtraReg = 0; /* Number of extra registers needed */
2501 int op; /* Instruction opcode */
drh111a6a72008-12-21 03:51:16 +00002502
2503 pIdx = pLevel->plan.u.pIdx;
2504 iIdxCur = pLevel->iIdxCur;
2505 k = pIdx->aiColumn[nEq]; /* Column for inequality constraints */
2506
drh111a6a72008-12-21 03:51:16 +00002507 /* If this loop satisfies a sort order (pOrderBy) request that
2508 ** was passed to this function to implement a "SELECT min(x) ..."
2509 ** query, then the caller will only allow the loop to run for
2510 ** a single iteration. This means that the first row returned
2511 ** should not have a NULL value stored in 'x'. If column 'x' is
2512 ** the first one after the nEq equality constraints in the index,
2513 ** this requires some special handling.
2514 */
2515 if( (wctrlFlags&WHERE_ORDERBY_MIN)!=0
2516 && (pLevel->plan.wsFlags&WHERE_ORDERBY)
2517 && (pIdx->nColumn>nEq)
2518 ){
2519 /* assert( pOrderBy->nExpr==1 ); */
2520 /* assert( pOrderBy->a[0].pExpr->iColumn==pIdx->aiColumn[nEq] ); */
2521 isMinQuery = 1;
drh6df2acd2008-12-28 16:55:25 +00002522 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002523 }
2524
2525 /* Find any inequality constraint terms for the start and end
2526 ** of the range.
2527 */
2528 if( pLevel->plan.wsFlags & WHERE_TOP_LIMIT ){
2529 pRangeEnd = findTerm(pWC, iCur, k, notReady, (WO_LT|WO_LE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00002530 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002531 }
2532 if( pLevel->plan.wsFlags & WHERE_BTM_LIMIT ){
2533 pRangeStart = findTerm(pWC, iCur, k, notReady, (WO_GT|WO_GE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00002534 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002535 }
2536
drh6df2acd2008-12-28 16:55:25 +00002537 /* Generate code to evaluate all constraint terms using == or IN
2538 ** and store the values of those terms in an array of registers
2539 ** starting at regBase.
2540 */
2541 regBase = codeAllEqualityTerms(pParse, pLevel, pWC, notReady, nExtraReg);
2542 addrNxt = pLevel->addrNxt;
2543
2544
drh111a6a72008-12-21 03:51:16 +00002545 /* If we are doing a reverse order scan on an ascending index, or
2546 ** a forward order scan on a descending index, interchange the
2547 ** start and end terms (pRangeStart and pRangeEnd).
2548 */
2549 if( bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC) ){
2550 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
2551 }
2552
2553 testcase( pRangeStart && pRangeStart->eOperator & WO_LE );
2554 testcase( pRangeStart && pRangeStart->eOperator & WO_GE );
2555 testcase( pRangeEnd && pRangeEnd->eOperator & WO_LE );
2556 testcase( pRangeEnd && pRangeEnd->eOperator & WO_GE );
2557 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
2558 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
2559 start_constraints = pRangeStart || nEq>0;
2560
2561 /* Seek the index cursor to the start of the range. */
2562 nConstraint = nEq;
2563 if( pRangeStart ){
2564 int dcc = pParse->disableColCache;
2565 if( pRangeEnd ){
2566 pParse->disableColCache++;
2567 }
2568 sqlite3ExprCode(pParse, pRangeStart->pExpr->pRight, regBase+nEq);
2569 pParse->disableColCache = dcc;
2570 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2571 nConstraint++;
2572 }else if( isMinQuery ){
2573 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2574 nConstraint++;
2575 startEq = 0;
2576 start_constraints = 1;
2577 }
2578 codeApplyAffinity(pParse, regBase, nConstraint, pIdx);
2579 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
2580 assert( op!=0 );
2581 testcase( op==OP_Rewind );
2582 testcase( op==OP_Last );
2583 testcase( op==OP_SeekGt );
2584 testcase( op==OP_SeekGe );
2585 testcase( op==OP_SeekLe );
2586 testcase( op==OP_SeekLt );
2587 sqlite3VdbeAddOp4(v, op, iIdxCur, addrNxt, regBase,
2588 SQLITE_INT_TO_PTR(nConstraint), P4_INT32);
2589
2590 /* Load the value for the inequality constraint at the end of the
2591 ** range (if any).
2592 */
2593 nConstraint = nEq;
2594 if( pRangeEnd ){
2595 sqlite3ExprCode(pParse, pRangeEnd->pExpr->pRight, regBase+nEq);
2596 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2597 codeApplyAffinity(pParse, regBase, nEq+1, pIdx);
2598 nConstraint++;
2599 }
2600
2601 /* Top of the loop body */
2602 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2603
2604 /* Check if the index cursor is past the end of the range. */
2605 op = aEndOp[(pRangeEnd || nEq) * (1 + bRev)];
2606 testcase( op==OP_Noop );
2607 testcase( op==OP_IdxGE );
2608 testcase( op==OP_IdxLT );
drh6df2acd2008-12-28 16:55:25 +00002609 if( op!=OP_Noop ){
2610 sqlite3VdbeAddOp4(v, op, iIdxCur, addrNxt, regBase,
2611 SQLITE_INT_TO_PTR(nConstraint), P4_INT32);
2612 sqlite3VdbeChangeP5(v, endEq!=bRev ?1:0);
2613 }
drh111a6a72008-12-21 03:51:16 +00002614
2615 /* If there are inequality constraints, check that the value
2616 ** of the table column that the inequality contrains is not NULL.
2617 ** If it is, jump to the next iteration of the loop.
2618 */
2619 r1 = sqlite3GetTempReg(pParse);
2620 testcase( pLevel->plan.wsFlags & WHERE_BTM_LIMIT );
2621 testcase( pLevel->plan.wsFlags & WHERE_TOP_LIMIT );
2622 if( pLevel->plan.wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT) ){
2623 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, nEq, r1);
2624 sqlite3VdbeAddOp2(v, OP_IsNull, r1, addrCont);
2625 }
2626
2627 /* Seek the table cursor, if required */
drh23d04d52008-12-23 23:56:22 +00002628 disableTerm(pLevel, pRangeStart);
2629 disableTerm(pLevel, pRangeEnd);
2630 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2631 if( !omitTable || codeRowSetEarly ){
drh111a6a72008-12-21 03:51:16 +00002632 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, r1);
drh23d04d52008-12-23 23:56:22 +00002633 if( codeRowSetEarly ){
2634 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2635 }else{
2636 sqlite3VdbeAddOp2(v, OP_Seek, iCur, r1); /* Deferred seek */
2637 }
drh111a6a72008-12-21 03:51:16 +00002638 }
2639 sqlite3ReleaseTempReg(pParse, r1);
2640
2641 /* Record the instruction used to terminate the loop. Disable
2642 ** WHERE clause terms made redundant by the index range scan.
2643 */
2644 pLevel->op = bRev ? OP_Prev : OP_Next;
2645 pLevel->p1 = iIdxCur;
drhdd5f5a62008-12-23 13:35:23 +00002646 }else
2647
drh23d04d52008-12-23 23:56:22 +00002648#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00002649 if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drh111a6a72008-12-21 03:51:16 +00002650 /* Case 4: Two or more separately indexed terms connected by OR
2651 **
2652 ** Example:
2653 **
2654 ** CREATE TABLE t1(a,b,c,d);
2655 ** CREATE INDEX i1 ON t1(a);
2656 ** CREATE INDEX i2 ON t1(b);
2657 ** CREATE INDEX i3 ON t1(c);
2658 **
2659 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2660 **
2661 ** In the example, there are three indexed terms connected by OR.
2662 ** The top of the loop is constructed by creating a RowSet object
2663 ** and populating it. Then looping over elements of the rowset.
2664 **
2665 ** Null 1
2666 ** # fill RowSet 1 with entries where a=5 using i1
2667 ** # fill Rowset 1 with entries where b=7 using i2
2668 ** # fill Rowset 1 with entries where c=11 and d=13 i3 and t1
2669 ** A: RowSetRead 1, B, 2
2670 ** Seek i, 2
2671 **
2672 ** The bottom of the loop looks like this:
2673 **
2674 ** Goto 0, A
2675 ** B:
2676 */
drh23d04d52008-12-23 23:56:22 +00002677 int regOrRowset; /* Register holding the RowSet object */
drh111a6a72008-12-21 03:51:16 +00002678 int regNextRowid; /* Register holding next rowid */
drh111a6a72008-12-21 03:51:16 +00002679 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
2680 WhereTerm *pOrTerm; /* A single subterm within the OR-clause */
drhdd5f5a62008-12-23 13:35:23 +00002681 SrcList oneTab; /* Shortened table list */
drh111a6a72008-12-21 03:51:16 +00002682
2683 pTerm = pLevel->plan.u.pTerm;
2684 assert( pTerm!=0 );
2685 assert( pTerm->eOperator==WO_OR );
2686 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2687 pOrWc = &pTerm->u.pOrInfo->wc;
drh23d04d52008-12-23 23:56:22 +00002688 codeRowSetEarly = (regRowSet>=0 && pWC->nTerm==1) ?1:0;
2689
2690 if( codeRowSetEarly ){
2691 regOrRowset = regRowSet;
2692 }else{
2693 regOrRowset = sqlite3GetTempReg(pParse);
2694 sqlite3VdbeAddOp2(v, OP_Null, 0, regOrRowset);
2695 }
drhdd5f5a62008-12-23 13:35:23 +00002696 oneTab.nSrc = 1;
2697 oneTab.nAlloc = 1;
2698 oneTab.a[0] = *pTabItem;
2699 for(j=0, pOrTerm=pOrWc->a; j<pOrWc->nTerm; j++, pOrTerm++){
2700 WhereInfo *pSubWInfo;
drh29435252008-12-28 18:35:08 +00002701 if( pOrTerm->leftCursor!=iCur && pOrTerm->eOperator!=WO_AND ) continue;
drh23d04d52008-12-23 23:56:22 +00002702 pSubWInfo = sqlite3WhereBegin(pParse, &oneTab, pOrTerm->pExpr, 0,
drh6df2acd2008-12-28 16:55:25 +00002703 WHERE_FILL_ROWSET | WHERE_OMIT_OPEN | WHERE_OMIT_CLOSE,
2704 regOrRowset);
drhdd5f5a62008-12-23 13:35:23 +00002705 if( pSubWInfo ){
drhdd5f5a62008-12-23 13:35:23 +00002706 sqlite3WhereEnd(pSubWInfo);
2707 }
2708 }
drh111a6a72008-12-21 03:51:16 +00002709 sqlite3VdbeResolveLabel(v, addrCont);
drh23d04d52008-12-23 23:56:22 +00002710 if( !codeRowSetEarly ){
2711 regNextRowid = sqlite3GetTempReg(pParse);
2712 addrCont =
2713 sqlite3VdbeAddOp3(v, OP_RowSetRead, regOrRowset,addrBrk,regNextRowid);
2714 sqlite3VdbeAddOp2(v, OP_Seek, iCur, regNextRowid);
2715 sqlite3ReleaseTempReg(pParse, regNextRowid);
2716 /* sqlite3ReleaseTempReg(pParse, regOrRowset); // Preserve the RowSet */
2717 pLevel->op = OP_Goto;
2718 pLevel->p2 = addrCont;
drh171256c2009-01-08 03:11:19 +00002719 }else{
2720 pLevel->op = OP_Noop;
drh23d04d52008-12-23 23:56:22 +00002721 }
2722 disableTerm(pLevel, pTerm);
drhdd5f5a62008-12-23 13:35:23 +00002723 }else
drh23d04d52008-12-23 23:56:22 +00002724#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00002725
2726 {
drh111a6a72008-12-21 03:51:16 +00002727 /* Case 5: There is no usable index. We must do a complete
2728 ** scan of the entire table.
2729 */
2730 assert( omitTable==0 );
2731 assert( bRev==0 );
2732 pLevel->op = OP_Next;
2733 pLevel->p1 = iCur;
2734 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, OP_Rewind, iCur, addrBrk);
2735 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
drh23d04d52008-12-23 23:56:22 +00002736 codeRowSetEarly = 0;
drh111a6a72008-12-21 03:51:16 +00002737 }
2738 notReady &= ~getMask(pWC->pMaskSet, iCur);
2739
2740 /* Insert code to test every subexpression that can be completely
2741 ** computed using the current set of tables.
2742 */
2743 k = 0;
2744 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2745 Expr *pE;
2746 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2747 testcase( pTerm->wtFlags & TERM_CODED );
2748 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2749 if( (pTerm->prereqAll & notReady)!=0 ) continue;
2750 pE = pTerm->pExpr;
2751 assert( pE!=0 );
2752 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
2753 continue;
2754 }
2755 pParse->disableColCache += k;
2756 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2757 pParse->disableColCache -= k;
2758 k = 1;
2759 pTerm->wtFlags |= TERM_CODED;
2760 }
2761
2762 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2763 ** at least one row of the right table has matched the left table.
2764 */
2765 if( pLevel->iLeftJoin ){
2766 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2767 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2768 VdbeComment((v, "record LEFT JOIN hit"));
2769 sqlite3ExprClearColumnCache(pParse, pLevel->iTabCur);
2770 sqlite3ExprClearColumnCache(pParse, pLevel->iIdxCur);
2771 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
2772 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2773 testcase( pTerm->wtFlags & TERM_CODED );
2774 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2775 if( (pTerm->prereqAll & notReady)!=0 ) continue;
2776 assert( pTerm->pExpr );
2777 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2778 pTerm->wtFlags |= TERM_CODED;
2779 }
2780 }
drh23d04d52008-12-23 23:56:22 +00002781
2782 /*
2783 ** If it was requested to store the results in a rowset and that has
2784 ** not already been do, then do so now.
2785 */
2786 if( regRowSet>=0 && !codeRowSetEarly ){
2787 int r1 = sqlite3GetTempReg(pParse);
2788#ifndef SQLITE_OMIT_VIRTUALTABLE
2789 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
2790 sqlite3VdbeAddOp2(v, OP_VRowid, iCur, r1);
2791 }else
2792#endif
2793 {
2794 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, r1);
2795 }
2796 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2797 sqlite3ReleaseTempReg(pParse, r1);
2798 }
2799
drh111a6a72008-12-21 03:51:16 +00002800 return notReady;
2801}
2802
drh549c8b62005-09-19 13:15:23 +00002803#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00002804/*
2805** The following variable holds a text description of query plan generated
2806** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
2807** overwrites the previous. This information is used for testing and
2808** analysis only.
2809*/
2810char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
2811static int nQPlan = 0; /* Next free slow in _query_plan[] */
2812
2813#endif /* SQLITE_TEST */
2814
2815
drh9eff6162006-06-12 21:59:13 +00002816/*
2817** Free a WhereInfo structure
2818*/
drh10fe8402008-10-11 16:47:35 +00002819static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh9eff6162006-06-12 21:59:13 +00002820 if( pWInfo ){
2821 int i;
2822 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00002823 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
2824 if( pInfo ){
danielk197780442942008-12-24 11:25:39 +00002825 assert( pInfo->needToFreeIdxStr==0 || db->mallocFailed );
2826 if( pInfo->needToFreeIdxStr ){
2827 sqlite3_free(pInfo->idxStr);
2828 }
drh633e6d52008-07-28 19:34:53 +00002829 sqlite3DbFree(db, pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00002830 }
drh9eff6162006-06-12 21:59:13 +00002831 }
drh111a6a72008-12-21 03:51:16 +00002832 whereClauseClear(pWInfo->pWC);
drh633e6d52008-07-28 19:34:53 +00002833 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00002834 }
2835}
2836
drh94a11212004-09-25 13:12:14 +00002837
2838/*
drhe3184742002-06-19 14:27:05 +00002839** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00002840** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00002841** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00002842** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00002843** in order to complete the WHERE clause processing.
2844**
2845** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00002846**
2847** The basic idea is to do a nested loop, one loop for each table in
2848** the FROM clause of a select. (INSERT and UPDATE statements are the
2849** same as a SELECT with only a single table in the FROM clause.) For
2850** example, if the SQL is this:
2851**
2852** SELECT * FROM t1, t2, t3 WHERE ...;
2853**
2854** Then the code generated is conceptually like the following:
2855**
2856** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00002857** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00002858** foreach row3 in t3 do /
2859** ...
2860** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00002861** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00002862** end /
2863**
drh29dda4a2005-07-21 18:23:20 +00002864** Note that the loops might not be nested in the order in which they
2865** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00002866** use of indices. Note also that when the IN operator appears in
2867** the WHERE clause, it might result in additional nested loops for
2868** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00002869**
drhc27a1ce2002-06-14 20:58:45 +00002870** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00002871** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
2872** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00002873** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00002874**
drhe6f85e72004-12-25 01:03:13 +00002875** The code that sqlite3WhereBegin() generates leaves the cursors named
2876** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00002877** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00002878** data from the various tables of the loop.
2879**
drhc27a1ce2002-06-14 20:58:45 +00002880** If the WHERE clause is empty, the foreach loops must each scan their
2881** entire tables. Thus a three-way join is an O(N^3) operation. But if
2882** the tables have indices and there are terms in the WHERE clause that
2883** refer to those indices, a complete table scan can be avoided and the
2884** code will run much faster. Most of the work of this routine is checking
2885** to see if there are indices that can be used to speed up the loop.
2886**
2887** Terms of the WHERE clause are also used to limit which rows actually
2888** make it to the "..." in the middle of the loop. After each "foreach",
2889** terms of the WHERE clause that use only terms in that loop and outer
2890** loops are evaluated and if false a jump is made around all subsequent
2891** inner loops (or around the "..." if the test occurs within the inner-
2892** most loop)
2893**
2894** OUTER JOINS
2895**
2896** An outer join of tables t1 and t2 is conceptally coded as follows:
2897**
2898** foreach row1 in t1 do
2899** flag = 0
2900** foreach row2 in t2 do
2901** start:
2902** ...
2903** flag = 1
2904** end
drhe3184742002-06-19 14:27:05 +00002905** if flag==0 then
2906** move the row2 cursor to a null row
2907** goto start
2908** fi
drhc27a1ce2002-06-14 20:58:45 +00002909** end
2910**
drhe3184742002-06-19 14:27:05 +00002911** ORDER BY CLAUSE PROCESSING
2912**
2913** *ppOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
2914** if there is one. If there is no ORDER BY clause or if this routine
2915** is called from an UPDATE or DELETE statement, then ppOrderBy is NULL.
2916**
2917** If an index can be used so that the natural output order of the table
2918** scan is correct for the ORDER BY clause, then that index is used and
2919** *ppOrderBy is set to NULL. This is an optimization that prevents an
2920** unnecessary sort of the result set if an index appropriate for the
2921** ORDER BY clause already exists.
2922**
2923** If the where clause loops cannot be arranged to provide the correct
2924** output order, then the *ppOrderBy is unchanged.
drh75897232000-05-29 14:26:00 +00002925*/
danielk19774adee202004-05-08 08:23:19 +00002926WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00002927 Parse *pParse, /* The parser context */
2928 SrcList *pTabList, /* A list of all tables to be scanned */
2929 Expr *pWhere, /* The WHERE clause */
danielk1977a9d1ccb2008-01-05 17:39:29 +00002930 ExprList **ppOrderBy, /* An ORDER BY clause, or NULL */
drh23d04d52008-12-23 23:56:22 +00002931 u8 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
2932 int regRowSet /* Register hold RowSet if WHERE_FILL_ROWSET is set */
drh75897232000-05-29 14:26:00 +00002933){
2934 int i; /* Loop counter */
2935 WhereInfo *pWInfo; /* Will become the return value of this function */
2936 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhfe05af82005-07-21 03:14:59 +00002937 Bitmask notReady; /* Cursors that are not yet positioned */
drh111a6a72008-12-21 03:51:16 +00002938 WhereMaskSet *pMaskSet; /* The expression mask set */
drh111a6a72008-12-21 03:51:16 +00002939 WhereClause *pWC; /* Decomposition of the WHERE clause */
drh9012bcb2004-12-19 00:11:35 +00002940 struct SrcList_item *pTabItem; /* A single entry from pTabList */
2941 WhereLevel *pLevel; /* A single level in the pWInfo list */
drh29dda4a2005-07-21 18:23:20 +00002942 int iFrom; /* First unused FROM clause element */
drh111a6a72008-12-21 03:51:16 +00002943 int andFlags; /* AND-ed combination of all pWC->a[].wtFlags */
drh17435752007-08-16 04:30:38 +00002944 sqlite3 *db; /* Database connection */
danielk1977a9d1ccb2008-01-05 17:39:29 +00002945 ExprList *pOrderBy = 0;
drh75897232000-05-29 14:26:00 +00002946
drh29dda4a2005-07-21 18:23:20 +00002947 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00002948 ** bits in a Bitmask
2949 */
drh29dda4a2005-07-21 18:23:20 +00002950 if( pTabList->nSrc>BMS ){
2951 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00002952 return 0;
2953 }
2954
danielk1977a9d1ccb2008-01-05 17:39:29 +00002955 if( ppOrderBy ){
2956 pOrderBy = *ppOrderBy;
2957 }
2958
drh75897232000-05-29 14:26:00 +00002959 /* Allocate and initialize the WhereInfo structure that will become the
2960 ** return value.
2961 */
drh17435752007-08-16 04:30:38 +00002962 db = pParse->db;
2963 pWInfo = sqlite3DbMallocZero(db,
drh111a6a72008-12-21 03:51:16 +00002964 sizeof(WhereInfo)
2965 + (pTabList->nSrc-1)*sizeof(WhereLevel)
2966 + sizeof(WhereClause)
2967 + sizeof(WhereMaskSet)
2968 );
drh17435752007-08-16 04:30:38 +00002969 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00002970 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00002971 }
danielk197770b6d572006-06-19 04:49:34 +00002972 pWInfo->nLevel = pTabList->nSrc;
drh75897232000-05-29 14:26:00 +00002973 pWInfo->pParse = pParse;
2974 pWInfo->pTabList = pTabList;
danielk19774adee202004-05-08 08:23:19 +00002975 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh23d04d52008-12-23 23:56:22 +00002976 pWInfo->regRowSet = (wctrlFlags & WHERE_FILL_ROWSET) ? regRowSet : -1;
drh111a6a72008-12-21 03:51:16 +00002977 pWInfo->pWC = pWC = (WhereClause*)&pWInfo->a[pWInfo->nLevel];
drh6df2acd2008-12-28 16:55:25 +00002978 pWInfo->wctrlFlags = wctrlFlags;
drh111a6a72008-12-21 03:51:16 +00002979 pMaskSet = (WhereMaskSet*)&pWC[1];
drh08192d52002-04-30 19:20:28 +00002980
drh111a6a72008-12-21 03:51:16 +00002981 /* Split the WHERE clause into separate subexpressions where each
2982 ** subexpression is separated by an AND operator.
2983 */
2984 initMaskSet(pMaskSet);
2985 whereClauseInit(pWC, pParse, pMaskSet);
2986 sqlite3ExprCodeConstants(pParse, pWhere);
2987 whereSplit(pWC, pWhere, TK_AND);
2988
drh08192d52002-04-30 19:20:28 +00002989 /* Special case: a WHERE clause that is constant. Evaluate the
2990 ** expression and either jump over all of the code or fall thru.
2991 */
drh0a168372007-06-08 00:20:47 +00002992 if( pWhere && (pTabList->nSrc==0 || sqlite3ExprIsConstantNotJoin(pWhere)) ){
drh35573352008-01-08 23:54:25 +00002993 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, SQLITE_JUMPIFNULL);
drhdf199a22002-06-14 22:38:41 +00002994 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00002995 }
drh75897232000-05-29 14:26:00 +00002996
drh42165be2008-03-26 14:56:34 +00002997 /* Assign a bit from the bitmask to every term in the FROM clause.
2998 **
2999 ** When assigning bitmask values to FROM clause cursors, it must be
3000 ** the case that if X is the bitmask for the N-th FROM clause term then
3001 ** the bitmask for all FROM clause terms to the left of the N-th term
3002 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
3003 ** its Expr.iRightJoinTable value to find the bitmask of the right table
3004 ** of the join. Subtracting one from the right table bitmask gives a
3005 ** bitmask for all tables to the left of the join. Knowing the bitmask
3006 ** for all tables to the left of a left join is important. Ticket #3015.
3007 */
3008 for(i=0; i<pTabList->nSrc; i++){
drh111a6a72008-12-21 03:51:16 +00003009 createMask(pMaskSet, pTabList->a[i].iCursor);
drh42165be2008-03-26 14:56:34 +00003010 }
3011#ifndef NDEBUG
3012 {
3013 Bitmask toTheLeft = 0;
3014 for(i=0; i<pTabList->nSrc; i++){
drh111a6a72008-12-21 03:51:16 +00003015 Bitmask m = getMask(pMaskSet, pTabList->a[i].iCursor);
drh42165be2008-03-26 14:56:34 +00003016 assert( (m-1)==toTheLeft );
3017 toTheLeft |= m;
3018 }
3019 }
3020#endif
3021
drh29dda4a2005-07-21 18:23:20 +00003022 /* Analyze all of the subexpressions. Note that exprAnalyze() might
3023 ** add new virtual terms onto the end of the WHERE clause. We do not
3024 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00003025 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00003026 */
drh111a6a72008-12-21 03:51:16 +00003027 exprAnalyzeAll(pTabList, pWC);
drh17435752007-08-16 04:30:38 +00003028 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00003029 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00003030 }
drh75897232000-05-29 14:26:00 +00003031
drh29dda4a2005-07-21 18:23:20 +00003032 /* Chose the best index to use for each table in the FROM clause.
3033 **
drh51147ba2005-07-23 22:59:55 +00003034 ** This loop fills in the following fields:
3035 **
3036 ** pWInfo->a[].pIdx The index to use for this level of the loop.
drh165be382008-12-05 02:36:33 +00003037 ** pWInfo->a[].wsFlags WHERE_xxx flags associated with pIdx
drh51147ba2005-07-23 22:59:55 +00003038 ** pWInfo->a[].nEq The number of == and IN constraints
danielk197785574e32008-10-06 05:32:18 +00003039 ** pWInfo->a[].iFrom Which term of the FROM clause is being coded
drh51147ba2005-07-23 22:59:55 +00003040 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
3041 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
drh111a6a72008-12-21 03:51:16 +00003042 ** pWInfo->a[].pTerm When wsFlags==WO_OR, the OR-clause term
drh51147ba2005-07-23 22:59:55 +00003043 **
3044 ** This loop also figures out the nesting order of tables in the FROM
3045 ** clause.
drh75897232000-05-29 14:26:00 +00003046 */
drhfe05af82005-07-21 03:14:59 +00003047 notReady = ~(Bitmask)0;
drh9012bcb2004-12-19 00:11:35 +00003048 pTabItem = pTabList->a;
3049 pLevel = pWInfo->a;
drh943af3c2005-07-29 19:43:58 +00003050 andFlags = ~0;
drh4f0c5872007-03-26 22:05:01 +00003051 WHERETRACE(("*** Optimizer Start ***\n"));
drh29dda4a2005-07-21 18:23:20 +00003052 for(i=iFrom=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
drh111a6a72008-12-21 03:51:16 +00003053 WhereCost bestPlan; /* Most efficient plan seen so far */
drh29dda4a2005-07-21 18:23:20 +00003054 Index *pIdx; /* Index for FROM table at pTabItem */
drh29dda4a2005-07-21 18:23:20 +00003055 int j; /* For looping over FROM tables */
drh02afc862006-01-20 18:10:57 +00003056 int bestJ = 0; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00003057 Bitmask m; /* Bitmask value for j or bestJ */
drh570b9352006-02-01 02:45:02 +00003058 int once = 0; /* True when first table is seen */
drh29dda4a2005-07-21 18:23:20 +00003059
drh111a6a72008-12-21 03:51:16 +00003060 memset(&bestPlan, 0, sizeof(bestPlan));
3061 bestPlan.rCost = SQLITE_BIG_DBL;
drh29dda4a2005-07-21 18:23:20 +00003062 for(j=iFrom, pTabItem=&pTabList->a[j]; j<pTabList->nSrc; j++, pTabItem++){
drhdf26fd52006-06-06 11:45:54 +00003063 int doNotReorder; /* True if this table should not be reordered */
drh111a6a72008-12-21 03:51:16 +00003064 WhereCost sCost; /* Cost information from bestIndex() */
drhdf26fd52006-06-06 11:45:54 +00003065
drh61dfc312006-12-16 16:25:15 +00003066 doNotReorder = (pTabItem->jointype & (JT_LEFT|JT_CROSS))!=0;
drhdf26fd52006-06-06 11:45:54 +00003067 if( once && doNotReorder ) break;
drh111a6a72008-12-21 03:51:16 +00003068 m = getMask(pMaskSet, pTabItem->iCursor);
drh29dda4a2005-07-21 18:23:20 +00003069 if( (m & notReady)==0 ){
3070 if( j==iFrom ) iFrom++;
3071 continue;
3072 }
drh9eff6162006-06-12 21:59:13 +00003073 assert( pTabItem->pTab );
3074#ifndef SQLITE_OMIT_VIRTUALTABLE
drh4cbdda92006-06-14 19:00:20 +00003075 if( IsVirtual(pTabItem->pTab) ){
drh111a6a72008-12-21 03:51:16 +00003076 sqlite3_index_info *pVtabIdx; /* Current virtual index */
drh6d209d82006-06-27 01:54:26 +00003077 sqlite3_index_info **ppIdxInfo = &pWInfo->a[j].pIdxInfo;
drh111a6a72008-12-21 03:51:16 +00003078 sCost.rCost = bestVirtualIndex(pParse, pWC, pTabItem, notReady,
3079 ppOrderBy ? *ppOrderBy : 0, i==0,
3080 ppIdxInfo);
3081 sCost.plan.wsFlags = WHERE_VIRTUALTABLE;
3082 sCost.plan.u.pVtabIdx = pVtabIdx = *ppIdxInfo;
3083 if( pVtabIdx && pVtabIdx->orderByConsumed ){
3084 sCost.plan.wsFlags = WHERE_VIRTUALTABLE | WHERE_ORDERBY;
drh1a90e092006-06-14 22:07:10 +00003085 }
drh111a6a72008-12-21 03:51:16 +00003086 sCost.plan.nEq = 0;
3087 if( (SQLITE_BIG_DBL/2.0)<sCost.rCost ){
danielk19778efe5412007-03-02 08:12:22 +00003088 /* The cost is not allowed to be larger than SQLITE_BIG_DBL (the
3089 ** inital value of lowestCost in this loop. If it is, then
drh111a6a72008-12-21 03:51:16 +00003090 ** the (cost<lowestCost) test below will never be true.
danielk19778efe5412007-03-02 08:12:22 +00003091 */
drh111a6a72008-12-21 03:51:16 +00003092 sCost.rCost = (SQLITE_BIG_DBL/2.0);
danielk19778efe5412007-03-02 08:12:22 +00003093 }
drh9eff6162006-06-12 21:59:13 +00003094 }else
3095#endif
3096 {
drh111a6a72008-12-21 03:51:16 +00003097 bestIndex(pParse, pWC, pTabItem, notReady,
3098 (i==0 && ppOrderBy) ? *ppOrderBy : 0, &sCost);
drh9eff6162006-06-12 21:59:13 +00003099 }
danielk1977992347f2008-12-30 09:45:45 +00003100 if( once==0 || sCost.rCost<bestPlan.rCost ){
drh570b9352006-02-01 02:45:02 +00003101 once = 1;
drh111a6a72008-12-21 03:51:16 +00003102 bestPlan = sCost;
drh29dda4a2005-07-21 18:23:20 +00003103 bestJ = j;
3104 }
drhdf26fd52006-06-06 11:45:54 +00003105 if( doNotReorder ) break;
drh29dda4a2005-07-21 18:23:20 +00003106 }
danielk1977992347f2008-12-30 09:45:45 +00003107 assert( once );
3108 assert( notReady & getMask(pMaskSet, pTabList->a[bestJ].iCursor) );
drhcb041342008-06-12 00:07:29 +00003109 WHERETRACE(("*** Optimizer selects table %d for loop %d\n", bestJ,
drh3dec2232005-09-10 15:28:09 +00003110 pLevel-pWInfo->a));
drh111a6a72008-12-21 03:51:16 +00003111 if( (bestPlan.plan.wsFlags & WHERE_ORDERBY)!=0 ){
drhfe05af82005-07-21 03:14:59 +00003112 *ppOrderBy = 0;
drhc4a3c772001-04-04 11:48:57 +00003113 }
drh111a6a72008-12-21 03:51:16 +00003114 andFlags &= bestPlan.plan.wsFlags;
3115 pLevel->plan = bestPlan.plan;
3116 if( bestPlan.plan.wsFlags & WHERE_INDEXED ){
drh9012bcb2004-12-19 00:11:35 +00003117 pLevel->iIdxCur = pParse->nTab++;
drhfe05af82005-07-21 03:14:59 +00003118 }else{
3119 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00003120 }
drh111a6a72008-12-21 03:51:16 +00003121 notReady &= ~getMask(pMaskSet, pTabList->a[bestJ].iCursor);
drh29dda4a2005-07-21 18:23:20 +00003122 pLevel->iFrom = bestJ;
danielk197785574e32008-10-06 05:32:18 +00003123
3124 /* Check that if the table scanned by this loop iteration had an
3125 ** INDEXED BY clause attached to it, that the named index is being
3126 ** used for the scan. If not, then query compilation has failed.
3127 ** Return an error.
3128 */
3129 pIdx = pTabList->a[bestJ].pIndex;
drh171256c2009-01-08 03:11:19 +00003130 if( pIdx ){
3131 if( (bestPlan.plan.wsFlags & WHERE_INDEXED)==0 ){
3132 sqlite3ErrorMsg(pParse, "cannot use index: %s", pIdx->zName);
3133 goto whereBeginError;
3134 }else{
3135 /* If an INDEXED BY clause is used, the bestIndex() function is
3136 ** guaranteed to find the index specified in the INDEXED BY clause
3137 ** if it find an index at all. */
3138 assert( bestPlan.plan.u.pIdx==pIdx );
3139 }
danielk197785574e32008-10-06 05:32:18 +00003140 }
drh75897232000-05-29 14:26:00 +00003141 }
drh4f0c5872007-03-26 22:05:01 +00003142 WHERETRACE(("*** Optimizer Finished ***\n"));
danielk197780442942008-12-24 11:25:39 +00003143 if( db->mallocFailed ){
3144 goto whereBeginError;
3145 }
drh75897232000-05-29 14:26:00 +00003146
drh943af3c2005-07-29 19:43:58 +00003147 /* If the total query only selects a single row, then the ORDER BY
3148 ** clause is irrelevant.
3149 */
3150 if( (andFlags & WHERE_UNIQUE)!=0 && ppOrderBy ){
3151 *ppOrderBy = 0;
3152 }
3153
drh08c88eb2008-04-10 13:33:18 +00003154 /* If the caller is an UPDATE or DELETE statement that is requesting
3155 ** to use a one-pass algorithm, determine if this is appropriate.
3156 ** The one-pass algorithm only works if the WHERE clause constraints
3157 ** the statement to update a single row.
3158 */
drh165be382008-12-05 02:36:33 +00003159 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
3160 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 && (andFlags & WHERE_UNIQUE)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00003161 pWInfo->okOnePass = 1;
drh111a6a72008-12-21 03:51:16 +00003162 pWInfo->a[0].plan.wsFlags &= ~WHERE_IDX_ONLY;
drh08c88eb2008-04-10 13:33:18 +00003163 }
3164
drh9012bcb2004-12-19 00:11:35 +00003165 /* Open all tables in the pTabList and any indices selected for
3166 ** searching those tables.
3167 */
3168 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh29dda4a2005-07-21 18:23:20 +00003169 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00003170 Table *pTab; /* Table to open */
danielk1977da184232006-01-05 11:34:32 +00003171 int iDb; /* Index of database containing table/index */
drh9012bcb2004-12-19 00:11:35 +00003172
drhecc92422005-09-10 16:46:12 +00003173#ifndef SQLITE_OMIT_EXPLAIN
3174 if( pParse->explain==2 ){
3175 char *zMsg;
3176 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
danielk19771e536952007-08-16 10:09:01 +00003177 zMsg = sqlite3MPrintf(db, "TABLE %s", pItem->zName);
drhecc92422005-09-10 16:46:12 +00003178 if( pItem->zAlias ){
drh633e6d52008-07-28 19:34:53 +00003179 zMsg = sqlite3MAppendf(db, zMsg, "%s AS %s", zMsg, pItem->zAlias);
drhecc92422005-09-10 16:46:12 +00003180 }
drh111a6a72008-12-21 03:51:16 +00003181 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3182 zMsg = sqlite3MAppendf(db, zMsg, "%s WITH INDEX %s",
3183 zMsg, pLevel->plan.u.pIdx->zName);
drh46129af2008-12-30 16:18:47 +00003184 }else if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
3185 zMsg = sqlite3MAppendf(db, zMsg, "%s VIA MULTI-INDEX UNION", zMsg);
drh111a6a72008-12-21 03:51:16 +00003186 }else if( pLevel->plan.wsFlags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh633e6d52008-07-28 19:34:53 +00003187 zMsg = sqlite3MAppendf(db, zMsg, "%s USING PRIMARY KEY", zMsg);
drhecc92422005-09-10 16:46:12 +00003188 }
drh9eff6162006-06-12 21:59:13 +00003189#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00003190 else if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
3191 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
drh633e6d52008-07-28 19:34:53 +00003192 zMsg = sqlite3MAppendf(db, zMsg, "%s VIRTUAL TABLE INDEX %d:%s", zMsg,
drh111a6a72008-12-21 03:51:16 +00003193 pVtabIdx->idxNum, pVtabIdx->idxStr);
drh9eff6162006-06-12 21:59:13 +00003194 }
3195#endif
drh111a6a72008-12-21 03:51:16 +00003196 if( pLevel->plan.wsFlags & WHERE_ORDERBY ){
drh633e6d52008-07-28 19:34:53 +00003197 zMsg = sqlite3MAppendf(db, zMsg, "%s ORDER BY", zMsg);
drhe2b39092006-04-21 09:38:36 +00003198 }
drh66a51672008-01-03 00:01:23 +00003199 sqlite3VdbeAddOp4(v, OP_Explain, i, pLevel->iFrom, 0, zMsg, P4_DYNAMIC);
drhecc92422005-09-10 16:46:12 +00003200 }
3201#endif /* SQLITE_OMIT_EXPLAIN */
drh29dda4a2005-07-21 18:23:20 +00003202 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00003203 pTab = pTabItem->pTab;
danielk1977da184232006-01-05 11:34:32 +00003204 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drh7d10d5a2008-08-20 16:35:10 +00003205 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ) continue;
drh9eff6162006-06-12 21:59:13 +00003206#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00003207 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
danielk197793626f42006-06-20 13:07:27 +00003208 int iCur = pTabItem->iCursor;
drh66a51672008-01-03 00:01:23 +00003209 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0,
3210 (const char*)pTab->pVtab, P4_VTAB);
drh9eff6162006-06-12 21:59:13 +00003211 }else
3212#endif
drh6df2acd2008-12-28 16:55:25 +00003213 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
3214 && (wctrlFlags & WHERE_OMIT_OPEN)==0 ){
drh08c88eb2008-04-10 13:33:18 +00003215 int op = pWInfo->okOnePass ? OP_OpenWrite : OP_OpenRead;
3216 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
danielk197723432972008-11-17 16:42:00 +00003217 if( !pWInfo->okOnePass && pTab->nCol<BMS ){
danielk19779792eef2006-01-13 15:58:43 +00003218 Bitmask b = pTabItem->colUsed;
3219 int n = 0;
drh74161702006-02-24 02:53:49 +00003220 for(; b; b=b>>1, n++){}
danielk1977cd3e8f72008-03-25 09:47:35 +00003221 sqlite3VdbeChangeP2(v, sqlite3VdbeCurrentAddr(v)-2, n);
danielk19779792eef2006-01-13 15:58:43 +00003222 assert( n<=pTab->nCol );
3223 }
danielk1977c00da102006-01-07 13:21:04 +00003224 }else{
3225 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00003226 }
3227 pLevel->iTabCur = pTabItem->iCursor;
drh111a6a72008-12-21 03:51:16 +00003228 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3229 Index *pIx = pLevel->plan.u.pIdx;
danielk1977b3bf5562006-01-10 17:58:23 +00003230 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
drh111a6a72008-12-21 03:51:16 +00003231 int iIdxCur = pLevel->iIdxCur;
danielk1977da184232006-01-05 11:34:32 +00003232 assert( pIx->pSchema==pTab->pSchema );
drh111a6a72008-12-21 03:51:16 +00003233 assert( iIdxCur>=0 );
danielk1977cd3e8f72008-03-25 09:47:35 +00003234 sqlite3VdbeAddOp2(v, OP_SetNumColumns, 0, pIx->nColumn+1);
danielk1977207872a2008-01-03 07:54:23 +00003235 sqlite3VdbeAddOp4(v, OP_OpenRead, iIdxCur, pIx->tnum, iDb,
drh66a51672008-01-03 00:01:23 +00003236 (char*)pKey, P4_KEYINFO_HANDOFF);
danielk1977207872a2008-01-03 07:54:23 +00003237 VdbeComment((v, "%s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00003238 }
danielk1977da184232006-01-05 11:34:32 +00003239 sqlite3CodeVerifySchema(pParse, iDb);
drh9012bcb2004-12-19 00:11:35 +00003240 }
3241 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
3242
drh29dda4a2005-07-21 18:23:20 +00003243 /* Generate the code to do the search. Each iteration of the for
3244 ** loop below generates code for a single nested loop of the VM
3245 ** program.
drh75897232000-05-29 14:26:00 +00003246 */
drhfe05af82005-07-21 03:14:59 +00003247 notReady = ~(Bitmask)0;
drh111a6a72008-12-21 03:51:16 +00003248 for(i=0; i<pTabList->nSrc; i++){
3249 notReady = codeOneLoopStart(pWInfo, i, wctrlFlags, notReady);
drh813f31e2009-01-06 00:08:02 +00003250 pWInfo->iContinue = pWInfo->a[i].addrCont;
drh75897232000-05-29 14:26:00 +00003251 }
drh7ec764a2005-07-21 03:48:20 +00003252
3253#ifdef SQLITE_TEST /* For testing and debugging use only */
3254 /* Record in the query plan information about the current table
3255 ** and the index used to access it (if any). If the table itself
3256 ** is not used, its name is just '{}'. If no index is used
3257 ** the index is listed as "{}". If the primary key is used the
3258 ** index name is '*'.
3259 */
3260 for(i=0; i<pTabList->nSrc; i++){
3261 char *z;
3262 int n;
drh7ec764a2005-07-21 03:48:20 +00003263 pLevel = &pWInfo->a[i];
drh29dda4a2005-07-21 18:23:20 +00003264 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00003265 z = pTabItem->zAlias;
3266 if( z==0 ) z = pTabItem->pTab->zName;
drhea678832008-12-10 19:26:22 +00003267 n = sqlite3Strlen30(z);
drh7ec764a2005-07-21 03:48:20 +00003268 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
drh111a6a72008-12-21 03:51:16 +00003269 if( pLevel->plan.wsFlags & WHERE_IDX_ONLY ){
drh5bb3eb92007-05-04 13:15:55 +00003270 memcpy(&sqlite3_query_plan[nQPlan], "{}", 2);
drh7ec764a2005-07-21 03:48:20 +00003271 nQPlan += 2;
3272 }else{
drh5bb3eb92007-05-04 13:15:55 +00003273 memcpy(&sqlite3_query_plan[nQPlan], z, n);
drh7ec764a2005-07-21 03:48:20 +00003274 nQPlan += n;
3275 }
3276 sqlite3_query_plan[nQPlan++] = ' ';
3277 }
drh111a6a72008-12-21 03:51:16 +00003278 testcase( pLevel->plan.wsFlags & WHERE_ROWID_EQ );
3279 testcase( pLevel->plan.wsFlags & WHERE_ROWID_RANGE );
3280 if( pLevel->plan.wsFlags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh5bb3eb92007-05-04 13:15:55 +00003281 memcpy(&sqlite3_query_plan[nQPlan], "* ", 2);
drh7ec764a2005-07-21 03:48:20 +00003282 nQPlan += 2;
drh111a6a72008-12-21 03:51:16 +00003283 }else if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3284 n = sqlite3Strlen30(pLevel->plan.u.pIdx->zName);
drh7ec764a2005-07-21 03:48:20 +00003285 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
drh111a6a72008-12-21 03:51:16 +00003286 memcpy(&sqlite3_query_plan[nQPlan], pLevel->plan.u.pIdx->zName, n);
drh7ec764a2005-07-21 03:48:20 +00003287 nQPlan += n;
3288 sqlite3_query_plan[nQPlan++] = ' ';
3289 }
drh111a6a72008-12-21 03:51:16 +00003290 }else{
3291 memcpy(&sqlite3_query_plan[nQPlan], "{} ", 3);
3292 nQPlan += 3;
drh7ec764a2005-07-21 03:48:20 +00003293 }
3294 }
3295 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
3296 sqlite3_query_plan[--nQPlan] = 0;
3297 }
3298 sqlite3_query_plan[nQPlan] = 0;
3299 nQPlan = 0;
3300#endif /* SQLITE_TEST // Testing and debugging use only */
3301
drh29dda4a2005-07-21 18:23:20 +00003302 /* Record the continuation address in the WhereInfo structure. Then
3303 ** clean up and return.
3304 */
drh75897232000-05-29 14:26:00 +00003305 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00003306
3307 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00003308whereBeginError:
drh10fe8402008-10-11 16:47:35 +00003309 whereInfoFree(db, pWInfo);
drhe23399f2005-07-22 00:31:39 +00003310 return 0;
drh75897232000-05-29 14:26:00 +00003311}
3312
3313/*
drhc27a1ce2002-06-14 20:58:45 +00003314** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00003315** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00003316*/
danielk19774adee202004-05-08 08:23:19 +00003317void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00003318 Parse *pParse = pWInfo->pParse;
3319 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00003320 int i;
drh6b563442001-11-07 16:48:26 +00003321 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00003322 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00003323 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00003324
drh9012bcb2004-12-19 00:11:35 +00003325 /* Generate loop termination code.
3326 */
drh633e6d52008-07-28 19:34:53 +00003327 sqlite3ExprClearColumnCache(pParse, -1);
drhad3cab52002-05-24 02:04:32 +00003328 for(i=pTabList->nSrc-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00003329 pLevel = &pWInfo->a[i];
drhb3190c12008-12-08 21:37:14 +00003330 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00003331 if( pLevel->op!=OP_Noop ){
drh66a51672008-01-03 00:01:23 +00003332 sqlite3VdbeAddOp2(v, pLevel->op, pLevel->p1, pLevel->p2);
drhd1d38482008-10-07 23:46:38 +00003333 sqlite3VdbeChangeP5(v, pLevel->p5);
drh19a775c2000-06-05 18:54:46 +00003334 }
drh111a6a72008-12-21 03:51:16 +00003335 if( pLevel->plan.wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
drh72e8fa42007-03-28 14:30:06 +00003336 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00003337 int j;
drhb3190c12008-12-08 21:37:14 +00003338 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh111a6a72008-12-21 03:51:16 +00003339 for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00003340 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
3341 sqlite3VdbeAddOp2(v, OP_Next, pIn->iCur, pIn->addrInTop);
3342 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00003343 }
drh111a6a72008-12-21 03:51:16 +00003344 sqlite3DbFree(db, pLevel->u.in.aInLoop);
drhd99f7062002-06-08 23:25:08 +00003345 }
drhb3190c12008-12-08 21:37:14 +00003346 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhad2d8302002-05-24 20:31:36 +00003347 if( pLevel->iLeftJoin ){
3348 int addr;
drh3c84ddf2008-01-09 02:15:38 +00003349 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin);
3350 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
drh9012bcb2004-12-19 00:11:35 +00003351 if( pLevel->iIdxCur>=0 ){
drh3c84ddf2008-01-09 02:15:38 +00003352 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00003353 }
drhb3190c12008-12-08 21:37:14 +00003354 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
drhd654be82005-09-20 17:42:23 +00003355 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00003356 }
drh19a775c2000-06-05 18:54:46 +00003357 }
drh9012bcb2004-12-19 00:11:35 +00003358
3359 /* The "break" point is here, just past the end of the outer loop.
3360 ** Set it.
3361 */
danielk19774adee202004-05-08 08:23:19 +00003362 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00003363
drh29dda4a2005-07-21 18:23:20 +00003364 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00003365 */
drh29dda4a2005-07-21 18:23:20 +00003366 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
3367 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00003368 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00003369 assert( pTab!=0 );
drh7d10d5a2008-08-20 16:35:10 +00003370 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ) continue;
drh6df2acd2008-12-28 16:55:25 +00003371 if( (pWInfo->wctrlFlags & WHERE_OMIT_CLOSE)==0 ){
3372 if( !pWInfo->okOnePass && (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0 ){
3373 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
3374 }
3375 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3376 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
3377 }
drh9012bcb2004-12-19 00:11:35 +00003378 }
3379
danielk197721de2e72007-11-29 17:43:27 +00003380 /* If this scan uses an index, make code substitutions to read data
3381 ** from the index in preference to the table. Sometimes, this means
3382 ** the table need never be read from. This is a performance boost,
3383 ** as the vdbe level waits until the table is read before actually
3384 ** seeking the table cursor to the record corresponding to the current
3385 ** position in the index.
drh9012bcb2004-12-19 00:11:35 +00003386 **
3387 ** Calls to the code generator in between sqlite3WhereBegin and
3388 ** sqlite3WhereEnd will have created code that references the table
3389 ** directly. This loop scans all that code looking for opcodes
3390 ** that reference the table and converts them into opcodes that
3391 ** reference the index.
3392 */
drh111a6a72008-12-21 03:51:16 +00003393 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
danielk1977f0113002006-01-24 12:09:17 +00003394 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00003395 VdbeOp *pOp;
drh111a6a72008-12-21 03:51:16 +00003396 Index *pIdx = pLevel->plan.u.pIdx;
3397 int useIndexOnly = pLevel->plan.wsFlags & WHERE_IDX_ONLY;
drh9012bcb2004-12-19 00:11:35 +00003398
3399 assert( pIdx!=0 );
3400 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
3401 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00003402 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00003403 if( pOp->p1!=pLevel->iTabCur ) continue;
3404 if( pOp->opcode==OP_Column ){
drh9012bcb2004-12-19 00:11:35 +00003405 for(j=0; j<pIdx->nColumn; j++){
3406 if( pOp->p2==pIdx->aiColumn[j] ){
3407 pOp->p2 = j;
danielk197721de2e72007-11-29 17:43:27 +00003408 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00003409 break;
3410 }
3411 }
danielk197721de2e72007-11-29 17:43:27 +00003412 assert(!useIndexOnly || j<pIdx->nColumn);
drhf0863fe2005-06-12 21:35:51 +00003413 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00003414 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00003415 pOp->opcode = OP_IdxRowid;
danielk197721de2e72007-11-29 17:43:27 +00003416 }else if( pOp->opcode==OP_NullRow && useIndexOnly ){
danielk19776c18b6e2005-01-30 09:17:58 +00003417 pOp->opcode = OP_Noop;
drh9012bcb2004-12-19 00:11:35 +00003418 }
3419 }
drh6b563442001-11-07 16:48:26 +00003420 }
drh19a775c2000-06-05 18:54:46 +00003421 }
drh9012bcb2004-12-19 00:11:35 +00003422
3423 /* Final cleanup
3424 */
drh10fe8402008-10-11 16:47:35 +00003425 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00003426 return;
3427}