blob: 061b38a6d86d460d1cc7096021e79804909ad6ee [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**
danielk19775f0ff5d2008-12-30 12:00:12 +000019** $Id: where.c,v 1.352 2008/12/30 12:00:12 danielk1977 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){
267 if( p ){
268 whereClauseClear(&p->wc);
drh1a58fe02008-12-20 02:06:13 +0000269 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000270 }
271}
272
273/*
274** Deallocate all memory associated with a WhereAndInfo object.
275*/
276static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
277 if( p ){
278 whereClauseClear(&p->wc);
drh1a58fe02008-12-20 02:06:13 +0000279 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000280 }
281}
282
drh0aa74ed2005-07-16 13:33:20 +0000283/*
284** Deallocate a WhereClause structure. The WhereClause structure
285** itself is not freed. This routine is the inverse of whereClauseInit().
286*/
287static void whereClauseClear(WhereClause *pWC){
288 int i;
289 WhereTerm *a;
drh633e6d52008-07-28 19:34:53 +0000290 sqlite3 *db = pWC->pParse->db;
drh0aa74ed2005-07-16 13:33:20 +0000291 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
drh165be382008-12-05 02:36:33 +0000292 if( a->wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000293 sqlite3ExprDelete(db, a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000294 }
drh700a2262008-12-17 19:22:15 +0000295 if( a->wtFlags & TERM_ORINFO ){
296 whereOrInfoDelete(db, a->u.pOrInfo);
297 }else if( a->wtFlags & TERM_ANDINFO ){
298 whereAndInfoDelete(db, a->u.pAndInfo);
299 }
drh0aa74ed2005-07-16 13:33:20 +0000300 }
301 if( pWC->a!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000302 sqlite3DbFree(db, pWC->a);
drh0aa74ed2005-07-16 13:33:20 +0000303 }
304}
305
306/*
drh6a1e0712008-12-05 15:24:15 +0000307** Add a single new WhereTerm entry to the WhereClause object pWC.
308** The new WhereTerm object is constructed from Expr p and with wtFlags.
309** The index in pWC->a[] of the new WhereTerm is returned on success.
310** 0 is returned if the new WhereTerm could not be added due to a memory
311** allocation error. The memory allocation failure will be recorded in
312** the db->mallocFailed flag so that higher-level functions can detect it.
313**
314** This routine will increase the size of the pWC->a[] array as necessary.
drh9eb20282005-08-24 03:52:18 +0000315**
drh165be382008-12-05 02:36:33 +0000316** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
drh6a1e0712008-12-05 15:24:15 +0000317** for freeing the expression p is assumed by the WhereClause object pWC.
318** This is true even if this routine fails to allocate a new WhereTerm.
drhb63a53d2007-03-31 01:34:44 +0000319**
drh9eb20282005-08-24 03:52:18 +0000320** WARNING: This routine might reallocate the space used to store
drh909626d2008-05-30 14:58:37 +0000321** WhereTerms. All pointers to WhereTerms should be invalidated after
drh9eb20282005-08-24 03:52:18 +0000322** calling this routine. Such pointers may be reinitialized by referencing
323** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000324*/
drhec1724e2008-12-09 01:32:03 +0000325static int whereClauseInsert(WhereClause *pWC, Expr *p, u8 wtFlags){
drh0aa74ed2005-07-16 13:33:20 +0000326 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000327 int idx;
drh0aa74ed2005-07-16 13:33:20 +0000328 if( pWC->nTerm>=pWC->nSlot ){
329 WhereTerm *pOld = pWC->a;
drh633e6d52008-07-28 19:34:53 +0000330 sqlite3 *db = pWC->pParse->db;
331 pWC->a = sqlite3DbMallocRaw(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
drhb63a53d2007-03-31 01:34:44 +0000332 if( pWC->a==0 ){
drh165be382008-12-05 02:36:33 +0000333 if( wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000334 sqlite3ExprDelete(db, p);
drhb63a53d2007-03-31 01:34:44 +0000335 }
drhf998b732007-11-26 13:36:00 +0000336 pWC->a = pOld;
drhb63a53d2007-03-31 01:34:44 +0000337 return 0;
338 }
drh0aa74ed2005-07-16 13:33:20 +0000339 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
340 if( pOld!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000341 sqlite3DbFree(db, pOld);
drh0aa74ed2005-07-16 13:33:20 +0000342 }
drh6a1e0712008-12-05 15:24:15 +0000343 pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
drh0aa74ed2005-07-16 13:33:20 +0000344 }
drh6a1e0712008-12-05 15:24:15 +0000345 pTerm = &pWC->a[idx = pWC->nTerm++];
drh0fcef5e2005-07-19 17:38:22 +0000346 pTerm->pExpr = p;
drh165be382008-12-05 02:36:33 +0000347 pTerm->wtFlags = wtFlags;
drh0fcef5e2005-07-19 17:38:22 +0000348 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000349 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000350 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000351}
drh75897232000-05-29 14:26:00 +0000352
353/*
drh51669862004-12-18 18:40:26 +0000354** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000355** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000356** operator specified in the op parameter. The WhereClause structure
357** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000358**
drh51669862004-12-18 18:40:26 +0000359** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
360** \________/ \_______________/ \________________/
361** slot[0] slot[1] slot[2]
362**
363** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000364** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000365**
drh51147ba2005-07-23 22:59:55 +0000366** In the previous sentence and in the diagram, "slot[]" refers to
drh902b9ee2008-12-05 17:17:07 +0000367** the WhereClause.a[] array. The slot[] array grows as needed to contain
drh51147ba2005-07-23 22:59:55 +0000368** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000369*/
drh6c30be82005-07-29 15:10:17 +0000370static void whereSplit(WhereClause *pWC, Expr *pExpr, int op){
drh29435252008-12-28 18:35:08 +0000371 pWC->op = (u8)op;
drh0aa74ed2005-07-16 13:33:20 +0000372 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000373 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000374 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000375 }else{
drh6c30be82005-07-29 15:10:17 +0000376 whereSplit(pWC, pExpr->pLeft, op);
377 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000378 }
drh75897232000-05-29 14:26:00 +0000379}
380
381/*
drh6a3ea0e2003-05-02 14:32:12 +0000382** Initialize an expression mask set
383*/
384#define initMaskSet(P) memset(P, 0, sizeof(*P))
385
386/*
drh1398ad32005-01-19 23:24:50 +0000387** Return the bitmask for the given cursor number. Return 0 if
388** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000389*/
drh111a6a72008-12-21 03:51:16 +0000390static Bitmask getMask(WhereMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000391 int i;
392 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000393 if( pMaskSet->ix[i]==iCursor ){
394 return ((Bitmask)1)<<i;
395 }
drh6a3ea0e2003-05-02 14:32:12 +0000396 }
drh6a3ea0e2003-05-02 14:32:12 +0000397 return 0;
398}
399
400/*
drh1398ad32005-01-19 23:24:50 +0000401** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000402**
403** There is one cursor per table in the FROM clause. The number of
404** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000405** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000406** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000407*/
drh111a6a72008-12-21 03:51:16 +0000408static void createMask(WhereMaskSet *pMaskSet, int iCursor){
drhcad651e2007-04-20 12:22:01 +0000409 assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
drh0fcef5e2005-07-19 17:38:22 +0000410 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000411}
412
413/*
drh75897232000-05-29 14:26:00 +0000414** This routine walks (recursively) an expression tree and generates
415** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000416** tree.
drh75897232000-05-29 14:26:00 +0000417**
418** In order for this routine to work, the calling function must have
drh7d10d5a2008-08-20 16:35:10 +0000419** previously invoked sqlite3ResolveExprNames() on the expression. See
drh75897232000-05-29 14:26:00 +0000420** the header comment on that routine for additional information.
drh7d10d5a2008-08-20 16:35:10 +0000421** The sqlite3ResolveExprNames() routines looks for column names and
drh6a3ea0e2003-05-02 14:32:12 +0000422** sets their opcodes to TK_COLUMN and their Expr.iTable fields to
drh51147ba2005-07-23 22:59:55 +0000423** the VDBE cursor number of the table. This routine just has to
424** translate the cursor numbers into bitmask values and OR all
425** the bitmasks together.
drh75897232000-05-29 14:26:00 +0000426*/
drh111a6a72008-12-21 03:51:16 +0000427static Bitmask exprListTableUsage(WhereMaskSet*, ExprList*);
428static Bitmask exprSelectTableUsage(WhereMaskSet*, Select*);
429static Bitmask exprTableUsage(WhereMaskSet *pMaskSet, Expr *p){
drh51669862004-12-18 18:40:26 +0000430 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000431 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000432 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000433 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000434 return mask;
drh75897232000-05-29 14:26:00 +0000435 }
danielk1977b3bce662005-01-29 08:32:43 +0000436 mask = exprTableUsage(pMaskSet, p->pRight);
437 mask |= exprTableUsage(pMaskSet, p->pLeft);
438 mask |= exprListTableUsage(pMaskSet, p->pList);
drhf5b11382005-09-17 13:07:13 +0000439 mask |= exprSelectTableUsage(pMaskSet, p->pSelect);
danielk1977b3bce662005-01-29 08:32:43 +0000440 return mask;
441}
drh111a6a72008-12-21 03:51:16 +0000442static Bitmask exprListTableUsage(WhereMaskSet *pMaskSet, ExprList *pList){
danielk1977b3bce662005-01-29 08:32:43 +0000443 int i;
444 Bitmask mask = 0;
445 if( pList ){
446 for(i=0; i<pList->nExpr; i++){
447 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000448 }
449 }
drh75897232000-05-29 14:26:00 +0000450 return mask;
451}
drh111a6a72008-12-21 03:51:16 +0000452static Bitmask exprSelectTableUsage(WhereMaskSet *pMaskSet, Select *pS){
drha430ae82007-09-12 15:41:01 +0000453 Bitmask mask = 0;
454 while( pS ){
455 mask |= exprListTableUsage(pMaskSet, pS->pEList);
drhf5b11382005-09-17 13:07:13 +0000456 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
457 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
458 mask |= exprTableUsage(pMaskSet, pS->pWhere);
459 mask |= exprTableUsage(pMaskSet, pS->pHaving);
drha430ae82007-09-12 15:41:01 +0000460 pS = pS->pPrior;
drhf5b11382005-09-17 13:07:13 +0000461 }
462 return mask;
463}
drh75897232000-05-29 14:26:00 +0000464
465/*
drh487ab3c2001-11-08 00:45:21 +0000466** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000467** allowed for an indexable WHERE clause term. The allowed operators are
drhc27a1ce2002-06-14 20:58:45 +0000468** "=", "<", ">", "<=", ">=", and "IN".
drh487ab3c2001-11-08 00:45:21 +0000469*/
470static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000471 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
472 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
473 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
474 assert( TK_GE==TK_EQ+4 );
drh50b39962006-10-28 00:28:09 +0000475 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL;
drh487ab3c2001-11-08 00:45:21 +0000476}
477
478/*
drh902b9ee2008-12-05 17:17:07 +0000479** Swap two objects of type TYPE.
drh193bd772004-07-20 18:23:14 +0000480*/
481#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
482
483/*
drh909626d2008-05-30 14:58:37 +0000484** Commute a comparison operator. Expressions of the form "X op Y"
drh0fcef5e2005-07-19 17:38:22 +0000485** are converted into "Y op X".
danielk1977eb5453d2007-07-30 14:40:48 +0000486**
487** If a collation sequence is associated with either the left or right
488** side of the comparison, it remains associated with the same side after
489** the commutation. So "Y collate NOCASE op X" becomes
490** "X collate NOCASE op Y". This is because any collation sequence on
491** the left hand side of a comparison overrides any collation sequence
492** attached to the right. For the same reason the EP_ExpCollate flag
493** is not commuted.
drh193bd772004-07-20 18:23:14 +0000494*/
drh7d10d5a2008-08-20 16:35:10 +0000495static void exprCommute(Parse *pParse, Expr *pExpr){
danielk1977eb5453d2007-07-30 14:40:48 +0000496 u16 expRight = (pExpr->pRight->flags & EP_ExpCollate);
497 u16 expLeft = (pExpr->pLeft->flags & EP_ExpCollate);
drhfe05af82005-07-21 03:14:59 +0000498 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drh7d10d5a2008-08-20 16:35:10 +0000499 pExpr->pRight->pColl = sqlite3ExprCollSeq(pParse, pExpr->pRight);
500 pExpr->pLeft->pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drh0fcef5e2005-07-19 17:38:22 +0000501 SWAP(CollSeq*,pExpr->pRight->pColl,pExpr->pLeft->pColl);
danielk1977eb5453d2007-07-30 14:40:48 +0000502 pExpr->pRight->flags = (pExpr->pRight->flags & ~EP_ExpCollate) | expLeft;
503 pExpr->pLeft->flags = (pExpr->pLeft->flags & ~EP_ExpCollate) | expRight;
drh0fcef5e2005-07-19 17:38:22 +0000504 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
505 if( pExpr->op>=TK_GT ){
506 assert( TK_LT==TK_GT+2 );
507 assert( TK_GE==TK_LE+2 );
508 assert( TK_GT>TK_EQ );
509 assert( TK_GT<TK_LE );
510 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
511 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000512 }
drh193bd772004-07-20 18:23:14 +0000513}
514
515/*
drhfe05af82005-07-21 03:14:59 +0000516** Translate from TK_xx operator to WO_xx bitmask.
517*/
drhec1724e2008-12-09 01:32:03 +0000518static u16 operatorMask(int op){
519 u16 c;
drhfe05af82005-07-21 03:14:59 +0000520 assert( allowedOp(op) );
521 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000522 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000523 }else if( op==TK_ISNULL ){
524 c = WO_ISNULL;
drhfe05af82005-07-21 03:14:59 +0000525 }else{
drhec1724e2008-12-09 01:32:03 +0000526 assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
527 c = (u16)(WO_EQ<<(op-TK_EQ));
drhfe05af82005-07-21 03:14:59 +0000528 }
drh50b39962006-10-28 00:28:09 +0000529 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh51147ba2005-07-23 22:59:55 +0000530 assert( op!=TK_IN || c==WO_IN );
531 assert( op!=TK_EQ || c==WO_EQ );
532 assert( op!=TK_LT || c==WO_LT );
533 assert( op!=TK_LE || c==WO_LE );
534 assert( op!=TK_GT || c==WO_GT );
535 assert( op!=TK_GE || c==WO_GE );
536 return c;
drhfe05af82005-07-21 03:14:59 +0000537}
538
539/*
540** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
541** where X is a reference to the iColumn of table iCur and <op> is one of
542** the WO_xx operator codes specified by the op parameter.
543** Return a pointer to the term. Return 0 if not found.
544*/
545static WhereTerm *findTerm(
546 WhereClause *pWC, /* The WHERE clause to be searched */
547 int iCur, /* Cursor number of LHS */
548 int iColumn, /* Column number of LHS */
549 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000550 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000551 Index *pIdx /* Must be compatible with this index, if not NULL */
552){
553 WhereTerm *pTerm;
554 int k;
drh22c24032008-07-09 13:28:53 +0000555 assert( iCur>=0 );
drhec1724e2008-12-09 01:32:03 +0000556 op &= WO_ALL;
drhfe05af82005-07-21 03:14:59 +0000557 for(pTerm=pWC->a, k=pWC->nTerm; k; k--, pTerm++){
558 if( pTerm->leftCursor==iCur
559 && (pTerm->prereqRight & notReady)==0
drh700a2262008-12-17 19:22:15 +0000560 && pTerm->u.leftColumn==iColumn
drhb52076c2006-01-23 13:22:09 +0000561 && (pTerm->eOperator & op)!=0
drhfe05af82005-07-21 03:14:59 +0000562 ){
drh22c24032008-07-09 13:28:53 +0000563 if( pIdx && pTerm->eOperator!=WO_ISNULL ){
drhfe05af82005-07-21 03:14:59 +0000564 Expr *pX = pTerm->pExpr;
565 CollSeq *pColl;
566 char idxaff;
danielk1977f0113002006-01-24 12:09:17 +0000567 int j;
drhfe05af82005-07-21 03:14:59 +0000568 Parse *pParse = pWC->pParse;
569
570 idxaff = pIdx->pTable->aCol[iColumn].affinity;
571 if( !sqlite3IndexAffinityOk(pX, idxaff) ) continue;
danielk1977bcbb04e2007-05-29 12:11:29 +0000572
573 /* Figure out the collation sequence required from an index for
574 ** it to be useful for optimising expression pX. Store this
575 ** value in variable pColl.
576 */
577 assert(pX->pLeft);
578 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
drhfe05af82005-07-21 03:14:59 +0000579 if( !pColl ){
danielk1977bcbb04e2007-05-29 12:11:29 +0000580 pColl = pParse->db->pDfltColl;
drhfe05af82005-07-21 03:14:59 +0000581 }
danielk1977bcbb04e2007-05-29 12:11:29 +0000582
drh22c24032008-07-09 13:28:53 +0000583 for(j=0; pIdx->aiColumn[j]!=iColumn; j++){
drh34004ce2008-07-11 16:15:17 +0000584 if( NEVER(j>=pIdx->nColumn) ) return 0;
drh22c24032008-07-09 13:28:53 +0000585 }
danielk1977f0113002006-01-24 12:09:17 +0000586 if( sqlite3StrICmp(pColl->zName, pIdx->azColl[j]) ) continue;
drhfe05af82005-07-21 03:14:59 +0000587 }
588 return pTerm;
589 }
590 }
591 return 0;
592}
593
drh6c30be82005-07-29 15:10:17 +0000594/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000595static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000596
597/*
598** Call exprAnalyze on all terms in a WHERE clause.
599**
600**
601*/
602static void exprAnalyzeAll(
603 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000604 WhereClause *pWC /* the WHERE clause to be analyzed */
605){
drh6c30be82005-07-29 15:10:17 +0000606 int i;
drh9eb20282005-08-24 03:52:18 +0000607 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000608 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000609 }
610}
611
drhd2687b72005-08-12 22:56:09 +0000612#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
613/*
614** Check to see if the given expression is a LIKE or GLOB operator that
615** can be optimized using inequality constraints. Return TRUE if it is
616** so and false if not.
617**
618** In order for the operator to be optimizible, the RHS must be a string
619** literal that does not begin with a wildcard.
620*/
621static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000622 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000623 Expr *pExpr, /* Test this expression */
624 int *pnPattern, /* Number of non-wildcard prefix characters */
drh9f504ea2008-02-23 21:55:39 +0000625 int *pisComplete, /* True if the only wildcard is % in the last character */
626 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000627){
628 const char *z;
629 Expr *pRight, *pLeft;
drh55ef4d92005-08-14 01:20:37 +0000630 ExprList *pList;
drhd2687b72005-08-12 22:56:09 +0000631 int c, cnt;
drh55ef4d92005-08-14 01:20:37 +0000632 char wc[3];
drhd64fe2f2005-08-28 17:00:23 +0000633 CollSeq *pColl;
drh7d10d5a2008-08-20 16:35:10 +0000634 sqlite3 *db = pParse->db;
drhd64fe2f2005-08-28 17:00:23 +0000635
drh9f504ea2008-02-23 21:55:39 +0000636 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000637 return 0;
638 }
drh9f504ea2008-02-23 21:55:39 +0000639#ifdef SQLITE_EBCDIC
640 if( *pnoCase ) return 0;
641#endif
drh55ef4d92005-08-14 01:20:37 +0000642 pList = pExpr->pList;
643 pRight = pList->a[0].pExpr;
drh678ccce2008-03-31 18:19:54 +0000644 if( pRight->op!=TK_STRING
645 && (pRight->op!=TK_REGISTER || pRight->iColumn!=TK_STRING) ){
drhd2687b72005-08-12 22:56:09 +0000646 return 0;
647 }
drh55ef4d92005-08-14 01:20:37 +0000648 pLeft = pList->a[1].pExpr;
drhd2687b72005-08-12 22:56:09 +0000649 if( pLeft->op!=TK_COLUMN ){
650 return 0;
651 }
drh7d10d5a2008-08-20 16:35:10 +0000652 pColl = sqlite3ExprCollSeq(pParse, pLeft);
drh01495b92008-01-23 12:52:40 +0000653 assert( pColl!=0 || pLeft->iColumn==-1 );
drhd64fe2f2005-08-28 17:00:23 +0000654 if( pColl==0 ){
drh01495b92008-01-23 12:52:40 +0000655 /* No collation is defined for the ROWID. Use the default. */
drhd64fe2f2005-08-28 17:00:23 +0000656 pColl = db->pDfltColl;
657 }
drh9f504ea2008-02-23 21:55:39 +0000658 if( (pColl->type!=SQLITE_COLL_BINARY || *pnoCase) &&
659 (pColl->type!=SQLITE_COLL_NOCASE || !*pnoCase) ){
drhd64fe2f2005-08-28 17:00:23 +0000660 return 0;
661 }
drh17435752007-08-16 04:30:38 +0000662 sqlite3DequoteExpr(db, pRight);
danielk197700fd9572005-12-07 06:27:43 +0000663 z = (char *)pRight->token.z;
drhf998b732007-11-26 13:36:00 +0000664 cnt = 0;
665 if( z ){
666 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){ cnt++; }
667 }
drhd2687b72005-08-12 22:56:09 +0000668 if( cnt==0 || 255==(u8)z[cnt] ){
669 return 0;
670 }
drh55ef4d92005-08-14 01:20:37 +0000671 *pisComplete = z[cnt]==wc[0] && z[cnt+1]==0;
drhd2687b72005-08-12 22:56:09 +0000672 *pnPattern = cnt;
673 return 1;
674}
675#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
676
drhedb193b2006-06-27 13:20:21 +0000677
678#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000679/*
drh7f375902006-06-13 17:38:59 +0000680** Check to see if the given expression is of the form
681**
682** column MATCH expr
683**
684** If it is then return TRUE. If not, return FALSE.
685*/
686static int isMatchOfColumn(
687 Expr *pExpr /* Test this expression */
688){
689 ExprList *pList;
690
691 if( pExpr->op!=TK_FUNCTION ){
692 return 0;
693 }
drhedb193b2006-06-27 13:20:21 +0000694 if( pExpr->token.n!=5 ||
695 sqlite3StrNICmp((const char*)pExpr->token.z,"match",5)!=0 ){
drh7f375902006-06-13 17:38:59 +0000696 return 0;
697 }
698 pList = pExpr->pList;
699 if( pList->nExpr!=2 ){
700 return 0;
701 }
702 if( pList->a[1].pExpr->op != TK_COLUMN ){
703 return 0;
704 }
705 return 1;
706}
drhedb193b2006-06-27 13:20:21 +0000707#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000708
709/*
drh54a167d2005-11-26 14:08:07 +0000710** If the pBase expression originated in the ON or USING clause of
711** a join, then transfer the appropriate markings over to derived.
712*/
713static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
714 pDerived->flags |= pBase->flags & EP_FromJoin;
715 pDerived->iRightJoinTable = pBase->iRightJoinTable;
716}
717
drh3e355802007-02-23 23:13:33 +0000718#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
719/*
drh1a58fe02008-12-20 02:06:13 +0000720** Analyze a term that consists of two or more OR-connected
721** subterms. So in:
drh3e355802007-02-23 23:13:33 +0000722**
drh1a58fe02008-12-20 02:06:13 +0000723** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
724** ^^^^^^^^^^^^^^^^^^^^
drh3e355802007-02-23 23:13:33 +0000725**
drh1a58fe02008-12-20 02:06:13 +0000726** This routine analyzes terms such as the middle term in the above example.
727** A WhereOrTerm object is computed and attached to the term under
728** analysis, regardless of the outcome of the analysis. Hence:
drh3e355802007-02-23 23:13:33 +0000729**
drh1a58fe02008-12-20 02:06:13 +0000730** WhereTerm.wtFlags |= TERM_ORINFO
731** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
drh3e355802007-02-23 23:13:33 +0000732**
drh1a58fe02008-12-20 02:06:13 +0000733** The term being analyzed must have two or more of OR-connected subterms.
danielk1977fdc40192008-12-29 18:33:32 +0000734** A single subterm might be a set of AND-connected sub-subterms.
drh1a58fe02008-12-20 02:06:13 +0000735** Examples of terms under analysis:
drh3e355802007-02-23 23:13:33 +0000736**
drh1a58fe02008-12-20 02:06:13 +0000737** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
738** (B) x=expr1 OR expr2=x OR x=expr3
739** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
740** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
741** (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 +0000742**
drh1a58fe02008-12-20 02:06:13 +0000743** CASE 1:
744**
745** If all subterms are of the form T.C=expr for some single column of C
746** a single table T (as shown in example B above) then create a new virtual
747** term that is an equivalent IN expression. In other words, if the term
748** being analyzed is:
749**
750** x = expr1 OR expr2 = x OR x = expr3
751**
752** then create a new virtual term like this:
753**
754** x IN (expr1,expr2,expr3)
755**
756** CASE 2:
757**
758** If all subterms are indexable by a single table T, then set
759**
760** WhereTerm.eOperator = WO_OR
761** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
762**
763** A subterm is "indexable" if it is of the form
764** "T.C <op> <expr>" where C is any column of table T and
765** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
766** A subterm is also indexable if it is an AND of two or more
767** subsubterms at least one of which is indexable. Indexable AND
768** subterms have their eOperator set to WO_AND and they have
769** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
770**
771** From another point of view, "indexable" means that the subterm could
772** potentially be used with an index if an appropriate index exists.
773** This analysis does not consider whether or not the index exists; that
774** is something the bestIndex() routine will determine. This analysis
775** only looks at whether subterms appropriate for indexing exist.
776**
777** All examples A through E above all satisfy case 2. But if a term
778** also statisfies case 1 (such as B) we know that the optimizer will
779** always prefer case 1, so in that case we pretend that case 2 is not
780** satisfied.
781**
782** It might be the case that multiple tables are indexable. For example,
783** (E) above is indexable on tables P, Q, and R.
784**
785** Terms that satisfy case 2 are candidates for lookup by using
786** separate indices to find rowids for each subterm and composing
787** the union of all rowids using a RowSet object. This is similar
788** to "bitmap indices" in other database engines.
789**
790** OTHERWISE:
791**
792** If neither case 1 nor case 2 apply, then leave the eOperator set to
793** zero. This term is not useful for search.
drh3e355802007-02-23 23:13:33 +0000794*/
drh1a58fe02008-12-20 02:06:13 +0000795static void exprAnalyzeOrTerm(
796 SrcList *pSrc, /* the FROM clause */
797 WhereClause *pWC, /* the complete WHERE clause */
798 int idxTerm /* Index of the OR-term to be analyzed */
799){
800 Parse *pParse = pWC->pParse; /* Parser context */
801 sqlite3 *db = pParse->db; /* Database connection */
802 WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
803 Expr *pExpr = pTerm->pExpr; /* The expression of the term */
drh111a6a72008-12-21 03:51:16 +0000804 WhereMaskSet *pMaskSet = pWC->pMaskSet; /* Table use masks */
drh1a58fe02008-12-20 02:06:13 +0000805 int i; /* Loop counters */
806 WhereClause *pOrWc; /* Breakup of pTerm into subterms */
807 WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
808 WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
809 Bitmask chngToIN; /* Tables that might satisfy case 1 */
810 Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
drh3e355802007-02-23 23:13:33 +0000811
drh1a58fe02008-12-20 02:06:13 +0000812 /*
813 ** Break the OR clause into its separate subterms. The subterms are
814 ** stored in a WhereClause structure containing within the WhereOrInfo
815 ** object that is attached to the original OR clause term.
816 */
817 assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
818 assert( pExpr->op==TK_OR );
drh954701a2008-12-29 23:45:07 +0000819 pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
drh1a58fe02008-12-20 02:06:13 +0000820 if( pOrInfo==0 ) return;
821 pTerm->wtFlags |= TERM_ORINFO;
822 pOrWc = &pOrInfo->wc;
823 whereClauseInit(pOrWc, pWC->pParse, pMaskSet);
824 whereSplit(pOrWc, pExpr, TK_OR);
825 exprAnalyzeAll(pSrc, pOrWc);
826 if( db->mallocFailed ) return;
827 assert( pOrWc->nTerm>=2 );
828
829 /*
830 ** Compute the set of tables that might satisfy cases 1 or 2.
831 */
832 indexable = chngToIN = ~(Bitmask)0;
833 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
834 if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
drh29435252008-12-28 18:35:08 +0000835 WhereAndInfo *pAndInfo;
836 assert( pOrTerm->eOperator==0 );
837 assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
drh1a58fe02008-12-20 02:06:13 +0000838 chngToIN = 0;
drh29435252008-12-28 18:35:08 +0000839 pAndInfo = sqlite3DbMallocRaw(db, sizeof(*pAndInfo));
840 if( pAndInfo ){
841 WhereClause *pAndWC;
842 WhereTerm *pAndTerm;
843 int j;
844 Bitmask b = 0;
845 pOrTerm->u.pAndInfo = pAndInfo;
846 pOrTerm->wtFlags |= TERM_ANDINFO;
847 pOrTerm->eOperator = WO_AND;
848 pAndWC = &pAndInfo->wc;
849 whereClauseInit(pAndWC, pWC->pParse, pMaskSet);
850 whereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
851 exprAnalyzeAll(pSrc, pAndWC);
852 for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
853 if( pAndTerm->pExpr && allowedOp(pAndTerm->pExpr->op) ){
854 b |= getMask(pMaskSet, pAndTerm->leftCursor);
855 }
856 }
857 indexable &= b;
858 }
drh1a58fe02008-12-20 02:06:13 +0000859 }else if( pOrTerm->wtFlags & TERM_COPIED ){
860 /* Skip this term for now. We revisit it when we process the
861 ** corresponding TERM_VIRTUAL term */
862 }else{
863 Bitmask b;
864 b = getMask(pMaskSet, pOrTerm->leftCursor);
865 if( pOrTerm->wtFlags & TERM_VIRTUAL ){
866 WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
867 b |= getMask(pMaskSet, pOther->leftCursor);
868 }
869 indexable &= b;
870 if( pOrTerm->eOperator!=WO_EQ ){
871 chngToIN = 0;
872 }else{
873 chngToIN &= b;
874 }
875 }
drh3e355802007-02-23 23:13:33 +0000876 }
drh1a58fe02008-12-20 02:06:13 +0000877
878 /*
879 ** Record the set of tables that satisfy case 2. The set might be
drh111a6a72008-12-21 03:51:16 +0000880 ** empty.
drh1a58fe02008-12-20 02:06:13 +0000881 */
882 pOrInfo->indexable = indexable;
drh111a6a72008-12-21 03:51:16 +0000883 pTerm->eOperator = indexable==0 ? 0 : WO_OR;
drh1a58fe02008-12-20 02:06:13 +0000884
885 /*
886 ** chngToIN holds a set of tables that *might* satisfy case 1. But
887 ** we have to do some additional checking to see if case 1 really
888 ** is satisfied.
889 */
890 if( chngToIN ){
891 int okToChngToIN = 0; /* True if the conversion to IN is valid */
892 int iColumn = -1; /* Column index on lhs of IN operator */
893 int iCursor; /* Table cursor common to all terms */
894 int j = 0; /* Loop counter */
895
896 /* Search for a table and column that appears on one side or the
897 ** other of the == operator in every subterm. That table and column
898 ** will be recorded in iCursor and iColumn. There might not be any
899 ** such table and column. Set okToChngToIN if an appropriate table
900 ** and column is found but leave okToChngToIN false if not found.
901 */
902 for(j=0; j<2 && !okToChngToIN; j++){
903 pOrTerm = pOrWc->a;
904 for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
905 assert( pOrTerm->eOperator==WO_EQ );
906 pOrTerm->wtFlags &= ~TERM_OR_OK;
907 if( pOrTerm->leftCursor==iColumn ) continue;
908 if( (chngToIN & getMask(pMaskSet, pOrTerm->leftCursor))==0 ) continue;
909 iColumn = pOrTerm->u.leftColumn;
910 iCursor = pOrTerm->leftCursor;
911 break;
912 }
913 if( i<0 ){
914 assert( j==1 );
915 assert( (chngToIN&(chngToIN-1))==0 );
916 assert( chngToIN==getMask(pMaskSet, iColumn) );
917 break;
918 }
919 okToChngToIN = 1;
920 for(; i>=0 && okToChngToIN; i--, pOrTerm++){
921 assert( pOrTerm->eOperator==WO_EQ );
922 if( pOrTerm->leftCursor!=iCursor ){
923 pOrTerm->wtFlags &= ~TERM_OR_OK;
924 }else if( pOrTerm->u.leftColumn!=iColumn ){
925 okToChngToIN = 0;
926 }else{
927 int affLeft, affRight;
928 /* If the right-hand side is also a column, then the affinities
929 ** of both right and left sides must be such that no type
930 ** conversions are required on the right. (Ticket #2249)
931 */
932 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
933 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
934 if( affRight!=0 && affRight!=affLeft ){
935 okToChngToIN = 0;
936 }else{
937 pOrTerm->wtFlags |= TERM_OR_OK;
938 }
939 }
940 }
941 }
942
943 /* At this point, okToChngToIN is true if original pTerm satisfies
944 ** case 1. In that case, construct a new virtual term that is
945 ** pTerm converted into an IN operator.
946 */
947 if( okToChngToIN ){
948 Expr *pDup; /* A transient duplicate expression */
949 ExprList *pList = 0; /* The RHS of the IN operator */
950 Expr *pLeft = 0; /* The LHS of the IN operator */
951 Expr *pNew; /* The complete IN operator */
952
953 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
954 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
955 assert( pOrTerm->eOperator==WO_EQ );
956 assert( pOrTerm->leftCursor==iCursor );
957 assert( pOrTerm->u.leftColumn==iColumn );
958 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight);
959 pList = sqlite3ExprListAppend(pWC->pParse, pList, pDup, 0);
960 pLeft = pOrTerm->pExpr->pLeft;
961 }
962 assert( pLeft!=0 );
963 pDup = sqlite3ExprDup(db, pLeft);
964 pNew = sqlite3Expr(db, TK_IN, pDup, 0, 0);
965 if( pNew ){
966 int idxNew;
967 transferJoinMarkings(pNew, pExpr);
968 pNew->pList = pList;
969 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
970 testcase( idxNew==0 );
971 exprAnalyze(pSrc, pWC, idxNew);
972 pTerm = &pWC->a[idxTerm];
973 pWC->a[idxNew].iParent = idxTerm;
974 pTerm->nChild = 1;
975 }else{
976 sqlite3ExprListDelete(db, pList);
977 }
978 pTerm->eOperator = 0; /* case 1 trumps case 2 */
979 }
drh3e355802007-02-23 23:13:33 +0000980 }
drh3e355802007-02-23 23:13:33 +0000981}
982#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +0000983
drh1a58fe02008-12-20 02:06:13 +0000984
drh54a167d2005-11-26 14:08:07 +0000985/*
drh0aa74ed2005-07-16 13:33:20 +0000986** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +0000987** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +0000988** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +0000989** structure.
drh51147ba2005-07-23 22:59:55 +0000990**
991** If the expression is of the form "<expr> <op> X" it gets commuted
drh1a58fe02008-12-20 02:06:13 +0000992** to the standard form of "X <op> <expr>".
993**
994** If the expression is of the form "X <op> Y" where both X and Y are
995** columns, then the original expression is unchanged and a new virtual
996** term of the form "Y <op> X" is added to the WHERE clause and
997** analyzed separately. The original term is marked with TERM_COPIED
998** and the new term is marked with TERM_DYNAMIC (because it's pExpr
999** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
1000** is a commuted copy of a prior term.) The original term has nChild=1
1001** and the copy has idxParent set to the index of the original term.
drh75897232000-05-29 14:26:00 +00001002*/
drh0fcef5e2005-07-19 17:38:22 +00001003static void exprAnalyze(
1004 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +00001005 WhereClause *pWC, /* the WHERE clause */
1006 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +00001007){
drh1a58fe02008-12-20 02:06:13 +00001008 WhereTerm *pTerm; /* The term to be analyzed */
drh111a6a72008-12-21 03:51:16 +00001009 WhereMaskSet *pMaskSet; /* Set of table index masks */
drh1a58fe02008-12-20 02:06:13 +00001010 Expr *pExpr; /* The expression to be analyzed */
1011 Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
1012 Bitmask prereqAll; /* Prerequesites of pExpr */
drhdafc0ce2008-04-17 19:14:02 +00001013 Bitmask extraRight = 0;
drhd2687b72005-08-12 22:56:09 +00001014 int nPattern;
1015 int isComplete;
drh9f504ea2008-02-23 21:55:39 +00001016 int noCase;
drh1a58fe02008-12-20 02:06:13 +00001017 int op; /* Top-level operator. pExpr->op */
1018 Parse *pParse = pWC->pParse; /* Parsing context */
1019 sqlite3 *db = pParse->db; /* Database connection */
drh0fcef5e2005-07-19 17:38:22 +00001020
drhf998b732007-11-26 13:36:00 +00001021 if( db->mallocFailed ){
1022 return;
1023 }
1024 pTerm = &pWC->a[idxTerm];
1025 pMaskSet = pWC->pMaskSet;
1026 pExpr = pTerm->pExpr;
drh0fcef5e2005-07-19 17:38:22 +00001027 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +00001028 op = pExpr->op;
1029 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +00001030 assert( pExpr->pRight==0 );
1031 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->pList)
1032 | exprSelectTableUsage(pMaskSet, pExpr->pSelect);
drh50b39962006-10-28 00:28:09 +00001033 }else if( op==TK_ISNULL ){
1034 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +00001035 }else{
1036 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
1037 }
drh22d6a532005-09-19 21:05:48 +00001038 prereqAll = exprTableUsage(pMaskSet, pExpr);
1039 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +00001040 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
1041 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +00001042 extraRight = x-1; /* ON clause terms may not be used with an index
1043 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +00001044 }
1045 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +00001046 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +00001047 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +00001048 pTerm->eOperator = 0;
drh50b39962006-10-28 00:28:09 +00001049 if( allowedOp(op) && (pTerm->prereqRight & prereqLeft)==0 ){
drh0fcef5e2005-07-19 17:38:22 +00001050 Expr *pLeft = pExpr->pLeft;
1051 Expr *pRight = pExpr->pRight;
1052 if( pLeft->op==TK_COLUMN ){
1053 pTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001054 pTerm->u.leftColumn = pLeft->iColumn;
drh50b39962006-10-28 00:28:09 +00001055 pTerm->eOperator = operatorMask(op);
drh75897232000-05-29 14:26:00 +00001056 }
drh0fcef5e2005-07-19 17:38:22 +00001057 if( pRight && pRight->op==TK_COLUMN ){
1058 WhereTerm *pNew;
1059 Expr *pDup;
1060 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +00001061 int idxNew;
drh17435752007-08-16 04:30:38 +00001062 pDup = sqlite3ExprDup(db, pExpr);
1063 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +00001064 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +00001065 return;
1066 }
drh9eb20282005-08-24 03:52:18 +00001067 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
1068 if( idxNew==0 ) return;
1069 pNew = &pWC->a[idxNew];
1070 pNew->iParent = idxTerm;
1071 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +00001072 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001073 pTerm->wtFlags |= TERM_COPIED;
drh0fcef5e2005-07-19 17:38:22 +00001074 }else{
1075 pDup = pExpr;
1076 pNew = pTerm;
1077 }
drh7d10d5a2008-08-20 16:35:10 +00001078 exprCommute(pParse, pDup);
drh0fcef5e2005-07-19 17:38:22 +00001079 pLeft = pDup->pLeft;
1080 pNew->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001081 pNew->u.leftColumn = pLeft->iColumn;
drh0fcef5e2005-07-19 17:38:22 +00001082 pNew->prereqRight = prereqLeft;
1083 pNew->prereqAll = prereqAll;
drhb52076c2006-01-23 13:22:09 +00001084 pNew->eOperator = operatorMask(pDup->op);
drh75897232000-05-29 14:26:00 +00001085 }
1086 }
drhed378002005-07-28 23:12:08 +00001087
drhd2687b72005-08-12 22:56:09 +00001088#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +00001089 /* If a term is the BETWEEN operator, create two new virtual terms
drh1a58fe02008-12-20 02:06:13 +00001090 ** that define the range that the BETWEEN implements. For example:
1091 **
1092 ** a BETWEEN b AND c
1093 **
1094 ** is converted into:
1095 **
1096 ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
1097 **
1098 ** The two new terms are added onto the end of the WhereClause object.
1099 ** The new terms are "dynamic" and are children of the original BETWEEN
1100 ** term. That means that if the BETWEEN term is coded, the children are
1101 ** skipped. Or, if the children are satisfied by an index, the original
1102 ** BETWEEN term is skipped.
drhed378002005-07-28 23:12:08 +00001103 */
drh29435252008-12-28 18:35:08 +00001104 else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
drhed378002005-07-28 23:12:08 +00001105 ExprList *pList = pExpr->pList;
1106 int i;
1107 static const u8 ops[] = {TK_GE, TK_LE};
1108 assert( pList!=0 );
1109 assert( pList->nExpr==2 );
1110 for(i=0; i<2; i++){
1111 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +00001112 int idxNew;
danielk1977a1644fd2007-08-29 12:31:25 +00001113 pNewExpr = sqlite3Expr(db, ops[i], sqlite3ExprDup(db, pExpr->pLeft),
drh17435752007-08-16 04:30:38 +00001114 sqlite3ExprDup(db, pList->a[i].pExpr), 0);
drh9eb20282005-08-24 03:52:18 +00001115 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001116 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001117 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +00001118 pTerm = &pWC->a[idxTerm];
1119 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +00001120 }
drh45b1ee42005-08-02 17:48:22 +00001121 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +00001122 }
drhd2687b72005-08-12 22:56:09 +00001123#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +00001124
danielk19771576cd92006-01-14 08:02:28 +00001125#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh1a58fe02008-12-20 02:06:13 +00001126 /* Analyze a term that is composed of two or more subterms connected by
1127 ** an OR operator.
drh6c30be82005-07-29 15:10:17 +00001128 */
1129 else if( pExpr->op==TK_OR ){
drh29435252008-12-28 18:35:08 +00001130 assert( pWC->op==TK_AND );
drh1a58fe02008-12-20 02:06:13 +00001131 exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
drh6c30be82005-07-29 15:10:17 +00001132 }
drhd2687b72005-08-12 22:56:09 +00001133#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1134
1135#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
1136 /* Add constraints to reduce the search space on a LIKE or GLOB
1137 ** operator.
drh9f504ea2008-02-23 21:55:39 +00001138 **
1139 ** A like pattern of the form "x LIKE 'abc%'" is changed into constraints
1140 **
1141 ** x>='abc' AND x<'abd' AND x LIKE 'abc%'
1142 **
1143 ** The last character of the prefix "abc" is incremented to form the
shane7bc71e52008-05-28 18:01:44 +00001144 ** termination condition "abd".
drhd2687b72005-08-12 22:56:09 +00001145 */
drh29435252008-12-28 18:35:08 +00001146 if( isLikeOrGlob(pParse, pExpr, &nPattern, &isComplete, &noCase)
1147 && pWC->op==TK_AND ){
drhd2687b72005-08-12 22:56:09 +00001148 Expr *pLeft, *pRight;
1149 Expr *pStr1, *pStr2;
1150 Expr *pNewExpr1, *pNewExpr2;
drh9eb20282005-08-24 03:52:18 +00001151 int idxNew1, idxNew2;
1152
drhd2687b72005-08-12 22:56:09 +00001153 pLeft = pExpr->pList->a[1].pExpr;
1154 pRight = pExpr->pList->a[0].pExpr;
drh17435752007-08-16 04:30:38 +00001155 pStr1 = sqlite3PExpr(pParse, TK_STRING, 0, 0, 0);
drhd2687b72005-08-12 22:56:09 +00001156 if( pStr1 ){
drh17435752007-08-16 04:30:38 +00001157 sqlite3TokenCopy(db, &pStr1->token, &pRight->token);
drhd2687b72005-08-12 22:56:09 +00001158 pStr1->token.n = nPattern;
drh9c86df52007-06-11 12:56:15 +00001159 pStr1->flags = EP_Dequoted;
drhd2687b72005-08-12 22:56:09 +00001160 }
drh17435752007-08-16 04:30:38 +00001161 pStr2 = sqlite3ExprDup(db, pStr1);
drhf998b732007-11-26 13:36:00 +00001162 if( !db->mallocFailed ){
drh9f504ea2008-02-23 21:55:39 +00001163 u8 c, *pC;
drhd2687b72005-08-12 22:56:09 +00001164 assert( pStr2->token.dyn );
drh9f504ea2008-02-23 21:55:39 +00001165 pC = (u8*)&pStr2->token.z[nPattern-1];
1166 c = *pC;
drh02a50b72008-05-26 18:33:40 +00001167 if( noCase ){
1168 if( c=='@' ) isComplete = 0;
1169 c = sqlite3UpperToLower[c];
1170 }
drh9f504ea2008-02-23 21:55:39 +00001171 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +00001172 }
drh17435752007-08-16 04:30:38 +00001173 pNewExpr1 = sqlite3PExpr(pParse, TK_GE, sqlite3ExprDup(db,pLeft), pStr1, 0);
drh9eb20282005-08-24 03:52:18 +00001174 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001175 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001176 exprAnalyze(pSrc, pWC, idxNew1);
drh17435752007-08-16 04:30:38 +00001177 pNewExpr2 = sqlite3PExpr(pParse, TK_LT, sqlite3ExprDup(db,pLeft), pStr2, 0);
drh9eb20282005-08-24 03:52:18 +00001178 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001179 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001180 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +00001181 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +00001182 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +00001183 pWC->a[idxNew1].iParent = idxTerm;
1184 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +00001185 pTerm->nChild = 2;
1186 }
1187 }
1188#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +00001189
1190#ifndef SQLITE_OMIT_VIRTUALTABLE
1191 /* Add a WO_MATCH auxiliary term to the constraint set if the
1192 ** current expression is of the form: column MATCH expr.
1193 ** This information is used by the xBestIndex methods of
1194 ** virtual tables. The native query optimizer does not attempt
1195 ** to do anything with MATCH functions.
1196 */
1197 if( isMatchOfColumn(pExpr) ){
1198 int idxNew;
1199 Expr *pRight, *pLeft;
1200 WhereTerm *pNewTerm;
1201 Bitmask prereqColumn, prereqExpr;
1202
1203 pRight = pExpr->pList->a[0].pExpr;
1204 pLeft = pExpr->pList->a[1].pExpr;
1205 prereqExpr = exprTableUsage(pMaskSet, pRight);
1206 prereqColumn = exprTableUsage(pMaskSet, pLeft);
1207 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +00001208 Expr *pNewExpr;
danielk1977a1644fd2007-08-29 12:31:25 +00001209 pNewExpr = sqlite3Expr(db, TK_MATCH, 0, sqlite3ExprDup(db, pRight), 0);
drh1a90e092006-06-14 22:07:10 +00001210 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001211 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001212 pNewTerm = &pWC->a[idxNew];
1213 pNewTerm->prereqRight = prereqExpr;
1214 pNewTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001215 pNewTerm->u.leftColumn = pLeft->iColumn;
drh7f375902006-06-13 17:38:59 +00001216 pNewTerm->eOperator = WO_MATCH;
1217 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +00001218 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +00001219 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001220 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001221 pNewTerm->prereqAll = pTerm->prereqAll;
1222 }
1223 }
1224#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001225
1226 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1227 ** an index for tables to the left of the join.
1228 */
1229 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001230}
1231
drh7b4fc6a2007-02-06 13:26:32 +00001232/*
1233** Return TRUE if any of the expressions in pList->a[iFirst...] contain
1234** a reference to any table other than the iBase table.
1235*/
1236static int referencesOtherTables(
1237 ExprList *pList, /* Search expressions in ths list */
drh111a6a72008-12-21 03:51:16 +00001238 WhereMaskSet *pMaskSet, /* Mapping from tables to bitmaps */
drh7b4fc6a2007-02-06 13:26:32 +00001239 int iFirst, /* Be searching with the iFirst-th expression */
1240 int iBase /* Ignore references to this table */
1241){
1242 Bitmask allowed = ~getMask(pMaskSet, iBase);
1243 while( iFirst<pList->nExpr ){
1244 if( (exprTableUsage(pMaskSet, pList->a[iFirst++].pExpr)&allowed)!=0 ){
1245 return 1;
1246 }
1247 }
1248 return 0;
1249}
1250
drh0fcef5e2005-07-19 17:38:22 +00001251
drh75897232000-05-29 14:26:00 +00001252/*
drh51669862004-12-18 18:40:26 +00001253** This routine decides if pIdx can be used to satisfy the ORDER BY
1254** clause. If it can, it returns 1. If pIdx cannot satisfy the
1255** ORDER BY clause, this routine returns 0.
1256**
1257** pOrderBy is an ORDER BY clause from a SELECT statement. pTab is the
1258** left-most table in the FROM clause of that same SELECT statement and
1259** the table has a cursor number of "base". pIdx is an index on pTab.
1260**
1261** nEqCol is the number of columns of pIdx that are used as equality
1262** constraints. Any of these columns may be missing from the ORDER BY
1263** clause and the match can still be a success.
1264**
drh51669862004-12-18 18:40:26 +00001265** All terms of the ORDER BY that match against the index must be either
1266** ASC or DESC. (Terms of the ORDER BY clause past the end of a UNIQUE
1267** index do not need to satisfy this constraint.) The *pbRev value is
1268** set to 1 if the ORDER BY clause is all DESC and it is set to 0 if
1269** the ORDER BY clause is all ASC.
1270*/
1271static int isSortingIndex(
1272 Parse *pParse, /* Parsing context */
drh111a6a72008-12-21 03:51:16 +00001273 WhereMaskSet *pMaskSet, /* Mapping from table cursor numbers to bitmaps */
drh51669862004-12-18 18:40:26 +00001274 Index *pIdx, /* The index we are testing */
drh74161702006-02-24 02:53:49 +00001275 int base, /* Cursor number for the table to be sorted */
drh51669862004-12-18 18:40:26 +00001276 ExprList *pOrderBy, /* The ORDER BY clause */
1277 int nEqCol, /* Number of index columns with == constraints */
1278 int *pbRev /* Set to 1 if ORDER BY is DESC */
1279){
drhb46b5772005-08-29 16:40:52 +00001280 int i, j; /* Loop counters */
drh85eeb692005-12-21 03:16:42 +00001281 int sortOrder = 0; /* XOR of index and ORDER BY sort direction */
drhb46b5772005-08-29 16:40:52 +00001282 int nTerm; /* Number of ORDER BY terms */
1283 struct ExprList_item *pTerm; /* A term of the ORDER BY clause */
drh51669862004-12-18 18:40:26 +00001284 sqlite3 *db = pParse->db;
1285
1286 assert( pOrderBy!=0 );
1287 nTerm = pOrderBy->nExpr;
1288 assert( nTerm>0 );
1289
1290 /* Match terms of the ORDER BY clause against columns of
1291 ** the index.
drhcc192542006-12-20 03:24:19 +00001292 **
1293 ** Note that indices have pIdx->nColumn regular columns plus
1294 ** one additional column containing the rowid. The rowid column
1295 ** of the index is also allowed to match against the ORDER BY
1296 ** clause.
drh51669862004-12-18 18:40:26 +00001297 */
drhcc192542006-12-20 03:24:19 +00001298 for(i=j=0, pTerm=pOrderBy->a; j<nTerm && i<=pIdx->nColumn; i++){
drh51669862004-12-18 18:40:26 +00001299 Expr *pExpr; /* The expression of the ORDER BY pTerm */
1300 CollSeq *pColl; /* The collating sequence of pExpr */
drh85eeb692005-12-21 03:16:42 +00001301 int termSortOrder; /* Sort order for this term */
drhcc192542006-12-20 03:24:19 +00001302 int iColumn; /* The i-th column of the index. -1 for rowid */
1303 int iSortOrder; /* 1 for DESC, 0 for ASC on the i-th index term */
1304 const char *zColl; /* Name of the collating sequence for i-th index term */
drh51669862004-12-18 18:40:26 +00001305
1306 pExpr = pTerm->pExpr;
1307 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=base ){
1308 /* Can not use an index sort on anything that is not a column in the
1309 ** left-most table of the FROM clause */
drh7b4fc6a2007-02-06 13:26:32 +00001310 break;
drh51669862004-12-18 18:40:26 +00001311 }
1312 pColl = sqlite3ExprCollSeq(pParse, pExpr);
drhcc192542006-12-20 03:24:19 +00001313 if( !pColl ){
1314 pColl = db->pDfltColl;
1315 }
1316 if( i<pIdx->nColumn ){
1317 iColumn = pIdx->aiColumn[i];
1318 if( iColumn==pIdx->pTable->iPKey ){
1319 iColumn = -1;
1320 }
1321 iSortOrder = pIdx->aSortOrder[i];
1322 zColl = pIdx->azColl[i];
1323 }else{
1324 iColumn = -1;
1325 iSortOrder = 0;
1326 zColl = pColl->zName;
1327 }
1328 if( pExpr->iColumn!=iColumn || sqlite3StrICmp(pColl->zName, zColl) ){
drh9012bcb2004-12-19 00:11:35 +00001329 /* Term j of the ORDER BY clause does not match column i of the index */
1330 if( i<nEqCol ){
drh51669862004-12-18 18:40:26 +00001331 /* If an index column that is constrained by == fails to match an
1332 ** ORDER BY term, that is OK. Just ignore that column of the index
1333 */
1334 continue;
drhff354e92008-06-25 02:47:57 +00001335 }else if( i==pIdx->nColumn ){
1336 /* Index column i is the rowid. All other terms match. */
1337 break;
drh51669862004-12-18 18:40:26 +00001338 }else{
1339 /* If an index column fails to match and is not constrained by ==
1340 ** then the index cannot satisfy the ORDER BY constraint.
1341 */
1342 return 0;
1343 }
1344 }
danielk1977b3bf5562006-01-10 17:58:23 +00001345 assert( pIdx->aSortOrder!=0 );
drh85eeb692005-12-21 03:16:42 +00001346 assert( pTerm->sortOrder==0 || pTerm->sortOrder==1 );
drhcc192542006-12-20 03:24:19 +00001347 assert( iSortOrder==0 || iSortOrder==1 );
1348 termSortOrder = iSortOrder ^ pTerm->sortOrder;
drh51669862004-12-18 18:40:26 +00001349 if( i>nEqCol ){
drh85eeb692005-12-21 03:16:42 +00001350 if( termSortOrder!=sortOrder ){
drh51669862004-12-18 18:40:26 +00001351 /* Indices can only be used if all ORDER BY terms past the
1352 ** equality constraints are all either DESC or ASC. */
1353 return 0;
1354 }
1355 }else{
drh85eeb692005-12-21 03:16:42 +00001356 sortOrder = termSortOrder;
drh51669862004-12-18 18:40:26 +00001357 }
1358 j++;
1359 pTerm++;
drh7b4fc6a2007-02-06 13:26:32 +00001360 if( iColumn<0 && !referencesOtherTables(pOrderBy, pMaskSet, j, base) ){
drhcc192542006-12-20 03:24:19 +00001361 /* If the indexed column is the primary key and everything matches
drh7b4fc6a2007-02-06 13:26:32 +00001362 ** so far and none of the ORDER BY terms to the right reference other
1363 ** tables in the join, then we are assured that the index can be used
1364 ** to sort because the primary key is unique and so none of the other
1365 ** columns will make any difference
drhcc192542006-12-20 03:24:19 +00001366 */
1367 j = nTerm;
1368 }
drh51669862004-12-18 18:40:26 +00001369 }
1370
drhcc192542006-12-20 03:24:19 +00001371 *pbRev = sortOrder!=0;
drh8718f522005-08-13 16:13:04 +00001372 if( j>=nTerm ){
drhcc192542006-12-20 03:24:19 +00001373 /* All terms of the ORDER BY clause are covered by this index so
1374 ** this index can be used for sorting. */
1375 return 1;
1376 }
drh7b4fc6a2007-02-06 13:26:32 +00001377 if( pIdx->onError!=OE_None && i==pIdx->nColumn
1378 && !referencesOtherTables(pOrderBy, pMaskSet, j, base) ){
drhcc192542006-12-20 03:24:19 +00001379 /* All terms of this index match some prefix of the ORDER BY clause
drh7b4fc6a2007-02-06 13:26:32 +00001380 ** and the index is UNIQUE and no terms on the tail of the ORDER BY
1381 ** clause reference other tables in a join. If this is all true then
1382 ** the order by clause is superfluous. */
drh51669862004-12-18 18:40:26 +00001383 return 1;
1384 }
1385 return 0;
1386}
1387
1388/*
drhb6c29892004-11-22 19:12:19 +00001389** Check table to see if the ORDER BY clause in pOrderBy can be satisfied
1390** by sorting in order of ROWID. Return true if so and set *pbRev to be
1391** true for reverse ROWID and false for forward ROWID order.
1392*/
1393static int sortableByRowid(
1394 int base, /* Cursor number for table to be sorted */
1395 ExprList *pOrderBy, /* The ORDER BY clause */
drh111a6a72008-12-21 03:51:16 +00001396 WhereMaskSet *pMaskSet, /* Mapping from table cursors to bitmaps */
drhb6c29892004-11-22 19:12:19 +00001397 int *pbRev /* Set to 1 if ORDER BY is DESC */
1398){
1399 Expr *p;
1400
1401 assert( pOrderBy!=0 );
1402 assert( pOrderBy->nExpr>0 );
1403 p = pOrderBy->a[0].pExpr;
drh7b4fc6a2007-02-06 13:26:32 +00001404 if( p->op==TK_COLUMN && p->iTable==base && p->iColumn==-1
1405 && !referencesOtherTables(pOrderBy, pMaskSet, 1, base) ){
drhb6c29892004-11-22 19:12:19 +00001406 *pbRev = pOrderBy->a[0].sortOrder;
1407 return 1;
1408 }
1409 return 0;
1410}
1411
drhfe05af82005-07-21 03:14:59 +00001412/*
drhb6fb62d2005-09-20 08:47:20 +00001413** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +00001414** The results need not be exact. This is only used for estimating
drh909626d2008-05-30 14:58:37 +00001415** the total cost of performing operations with O(logN) or O(NlogN)
drh28c4cf42005-07-27 20:41:43 +00001416** complexity. Because N is just a guess, it is no great tragedy if
1417** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +00001418*/
1419static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +00001420 double logN = 1;
1421 double x = 10;
drh28c4cf42005-07-27 20:41:43 +00001422 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +00001423 logN += 1;
drh28c4cf42005-07-27 20:41:43 +00001424 x *= 10;
1425 }
1426 return logN;
1427}
1428
drh6d209d82006-06-27 01:54:26 +00001429/*
1430** Two routines for printing the content of an sqlite3_index_info
1431** structure. Used for testing and debugging only. If neither
1432** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1433** are no-ops.
1434*/
drh77a2a5e2007-04-06 01:04:39 +00001435#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_DEBUG)
drh6d209d82006-06-27 01:54:26 +00001436static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1437 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001438 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001439 for(i=0; i<p->nConstraint; i++){
1440 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1441 i,
1442 p->aConstraint[i].iColumn,
1443 p->aConstraint[i].iTermOffset,
1444 p->aConstraint[i].op,
1445 p->aConstraint[i].usable);
1446 }
1447 for(i=0; i<p->nOrderBy; i++){
1448 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1449 i,
1450 p->aOrderBy[i].iColumn,
1451 p->aOrderBy[i].desc);
1452 }
1453}
1454static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1455 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001456 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001457 for(i=0; i<p->nConstraint; i++){
1458 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1459 i,
1460 p->aConstraintUsage[i].argvIndex,
1461 p->aConstraintUsage[i].omit);
1462 }
1463 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1464 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1465 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1466 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
1467}
1468#else
1469#define TRACE_IDX_INPUTS(A)
1470#define TRACE_IDX_OUTPUTS(A)
1471#endif
1472
drh9eff6162006-06-12 21:59:13 +00001473#ifndef SQLITE_OMIT_VIRTUALTABLE
1474/*
drh7f375902006-06-13 17:38:59 +00001475** Compute the best index for a virtual table.
1476**
1477** The best index is computed by the xBestIndex method of the virtual
1478** table module. This routine is really just a wrapper that sets up
1479** the sqlite3_index_info structure that is used to communicate with
1480** xBestIndex.
1481**
1482** In a join, this routine might be called multiple times for the
1483** same virtual table. The sqlite3_index_info structure is created
1484** and initialized on the first invocation and reused on all subsequent
1485** invocations. The sqlite3_index_info structure is also used when
1486** code is generated to access the virtual table. The whereInfoDelete()
1487** routine takes care of freeing the sqlite3_index_info structure after
1488** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00001489*/
1490static double bestVirtualIndex(
1491 Parse *pParse, /* The parsing context */
1492 WhereClause *pWC, /* The WHERE clause */
1493 struct SrcList_item *pSrc, /* The FROM clause term to search */
1494 Bitmask notReady, /* Mask of cursors that are not available */
1495 ExprList *pOrderBy, /* The order by clause */
1496 int orderByUsable, /* True if we can potential sort */
1497 sqlite3_index_info **ppIdxInfo /* Index information passed to xBestIndex */
1498){
1499 Table *pTab = pSrc->pTab;
danielk19773e3a84d2008-08-01 17:37:40 +00001500 sqlite3_vtab *pVtab = pTab->pVtab;
drh9eff6162006-06-12 21:59:13 +00001501 sqlite3_index_info *pIdxInfo;
1502 struct sqlite3_index_constraint *pIdxCons;
1503 struct sqlite3_index_orderby *pIdxOrderBy;
1504 struct sqlite3_index_constraint_usage *pUsage;
1505 WhereTerm *pTerm;
1506 int i, j;
1507 int nOrderBy;
danielk197774cdba42006-06-19 12:02:58 +00001508 int rc;
drh9eff6162006-06-12 21:59:13 +00001509
1510 /* If the sqlite3_index_info structure has not been previously
1511 ** allocated and initialized for this virtual table, then allocate
1512 ** and initialize it now
1513 */
1514 pIdxInfo = *ppIdxInfo;
1515 if( pIdxInfo==0 ){
drh9eff6162006-06-12 21:59:13 +00001516 int nTerm;
drh4f0c5872007-03-26 22:05:01 +00001517 WHERETRACE(("Recomputing index info for %s...\n", pTab->zName));
drh9eff6162006-06-12 21:59:13 +00001518
1519 /* Count the number of possible WHERE clause constraints referring
1520 ** to this virtual table */
1521 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1522 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh4d9f9e62008-08-25 12:08:22 +00001523 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
drh981642f2008-04-19 14:40:43 +00001524 testcase( pTerm->eOperator==WO_IN );
1525 testcase( pTerm->eOperator==WO_ISNULL );
1526 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drh9eff6162006-06-12 21:59:13 +00001527 nTerm++;
1528 }
1529
1530 /* If the ORDER BY clause contains only columns in the current
1531 ** virtual table then allocate space for the aOrderBy part of
1532 ** the sqlite3_index_info structure.
1533 */
1534 nOrderBy = 0;
1535 if( pOrderBy ){
1536 for(i=0; i<pOrderBy->nExpr; i++){
1537 Expr *pExpr = pOrderBy->a[i].pExpr;
1538 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
1539 }
1540 if( i==pOrderBy->nExpr ){
1541 nOrderBy = pOrderBy->nExpr;
1542 }
1543 }
1544
1545 /* Allocate the sqlite3_index_info structure
1546 */
danielk197726783a52007-08-29 14:06:22 +00001547 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
drh9eff6162006-06-12 21:59:13 +00001548 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
1549 + sizeof(*pIdxOrderBy)*nOrderBy );
1550 if( pIdxInfo==0 ){
1551 sqlite3ErrorMsg(pParse, "out of memory");
1552 return 0.0;
1553 }
1554 *ppIdxInfo = pIdxInfo;
1555
1556 /* Initialize the structure. The sqlite3_index_info structure contains
1557 ** many fields that are declared "const" to prevent xBestIndex from
1558 ** changing them. We have to do some funky casting in order to
1559 ** initialize those fields.
1560 */
1561 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
1562 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
1563 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
1564 *(int*)&pIdxInfo->nConstraint = nTerm;
1565 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
1566 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
1567 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
1568 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
1569 pUsage;
1570
1571 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1572 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh4d9f9e62008-08-25 12:08:22 +00001573 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
drh981642f2008-04-19 14:40:43 +00001574 testcase( pTerm->eOperator==WO_IN );
1575 testcase( pTerm->eOperator==WO_ISNULL );
1576 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drh700a2262008-12-17 19:22:15 +00001577 pIdxCons[j].iColumn = pTerm->u.leftColumn;
drh9eff6162006-06-12 21:59:13 +00001578 pIdxCons[j].iTermOffset = i;
drhec1724e2008-12-09 01:32:03 +00001579 pIdxCons[j].op = (u8)pTerm->eOperator;
drh7f375902006-06-13 17:38:59 +00001580 /* The direct assignment in the previous line is possible only because
1581 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
1582 ** following asserts verify this fact. */
drh9eff6162006-06-12 21:59:13 +00001583 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
1584 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
1585 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
1586 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
1587 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
drh7f375902006-06-13 17:38:59 +00001588 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
1589 assert( pTerm->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
drh9eff6162006-06-12 21:59:13 +00001590 j++;
1591 }
1592 for(i=0; i<nOrderBy; i++){
1593 Expr *pExpr = pOrderBy->a[i].pExpr;
1594 pIdxOrderBy[i].iColumn = pExpr->iColumn;
1595 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
1596 }
1597 }
1598
drh7f375902006-06-13 17:38:59 +00001599 /* At this point, the sqlite3_index_info structure that pIdxInfo points
1600 ** to will have been initialized, either during the current invocation or
1601 ** during some prior invocation. Now we just have to customize the
1602 ** details of pIdxInfo for the current invocation and pass it to
1603 ** xBestIndex.
1604 */
1605
danielk1977935ed5e2007-03-30 09:13:13 +00001606 /* The module name must be defined. Also, by this point there must
1607 ** be a pointer to an sqlite3_vtab structure. Otherwise
1608 ** sqlite3ViewGetColumnNames() would have picked up the error.
1609 */
drh9eff6162006-06-12 21:59:13 +00001610 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
danielk19773e3a84d2008-08-01 17:37:40 +00001611 assert( pVtab );
danielk1977935ed5e2007-03-30 09:13:13 +00001612#if 0
drh9eff6162006-06-12 21:59:13 +00001613 if( pTab->pVtab==0 ){
1614 sqlite3ErrorMsg(pParse, "undefined module %s for table %s",
1615 pTab->azModuleArg[0], pTab->zName);
1616 return 0.0;
1617 }
danielk1977935ed5e2007-03-30 09:13:13 +00001618#endif
drh9eff6162006-06-12 21:59:13 +00001619
1620 /* Set the aConstraint[].usable fields and initialize all
drh7f375902006-06-13 17:38:59 +00001621 ** output variables to zero.
1622 **
1623 ** aConstraint[].usable is true for constraints where the right-hand
1624 ** side contains only references to tables to the left of the current
1625 ** table. In other words, if the constraint is of the form:
1626 **
1627 ** column = expr
1628 **
1629 ** and we are evaluating a join, then the constraint on column is
1630 ** only valid if all tables referenced in expr occur to the left
1631 ** of the table containing column.
1632 **
1633 ** The aConstraints[] array contains entries for all constraints
1634 ** on the current table. That way we only have to compute it once
1635 ** even though we might try to pick the best index multiple times.
1636 ** For each attempt at picking an index, the order of tables in the
1637 ** join might be different so we have to recompute the usable flag
1638 ** each time.
drh9eff6162006-06-12 21:59:13 +00001639 */
1640 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
1641 pUsage = pIdxInfo->aConstraintUsage;
1642 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
1643 j = pIdxCons->iTermOffset;
1644 pTerm = &pWC->a[j];
drhec1724e2008-12-09 01:32:03 +00001645 pIdxCons->usable = (pTerm->prereqRight & notReady)==0 ?1:0;
drh9eff6162006-06-12 21:59:13 +00001646 }
1647 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
drh4be8b512006-06-13 23:51:34 +00001648 if( pIdxInfo->needToFreeIdxStr ){
1649 sqlite3_free(pIdxInfo->idxStr);
1650 }
1651 pIdxInfo->idxStr = 0;
1652 pIdxInfo->idxNum = 0;
1653 pIdxInfo->needToFreeIdxStr = 0;
drh9eff6162006-06-12 21:59:13 +00001654 pIdxInfo->orderByConsumed = 0;
danielk197793626f42006-06-20 13:07:27 +00001655 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / 2.0;
drh9eff6162006-06-12 21:59:13 +00001656 nOrderBy = pIdxInfo->nOrderBy;
1657 if( pIdxInfo->nOrderBy && !orderByUsable ){
drha967e882006-06-13 01:04:52 +00001658 *(int*)&pIdxInfo->nOrderBy = 0;
drh9eff6162006-06-12 21:59:13 +00001659 }
danielk197774cdba42006-06-19 12:02:58 +00001660
drh7e8b8482008-01-23 03:03:05 +00001661 (void)sqlite3SafetyOff(pParse->db);
drh4f0c5872007-03-26 22:05:01 +00001662 WHERETRACE(("xBestIndex for %s\n", pTab->zName));
drh6d209d82006-06-27 01:54:26 +00001663 TRACE_IDX_INPUTS(pIdxInfo);
danielk19773e3a84d2008-08-01 17:37:40 +00001664 rc = pVtab->pModule->xBestIndex(pVtab, pIdxInfo);
drh6d209d82006-06-27 01:54:26 +00001665 TRACE_IDX_OUTPUTS(pIdxInfo);
danielk197739359dc2008-03-17 09:36:44 +00001666 (void)sqlite3SafetyOn(pParse->db);
1667
danielk19773e3a84d2008-08-01 17:37:40 +00001668 if( rc!=SQLITE_OK ){
1669 if( rc==SQLITE_NOMEM ){
1670 pParse->db->mallocFailed = 1;
1671 }else if( !pVtab->zErrMsg ){
1672 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
1673 }else{
1674 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
1675 }
1676 }
1677 sqlite3DbFree(pParse->db, pVtab->zErrMsg);
1678 pVtab->zErrMsg = 0;
1679
danielk197739359dc2008-03-17 09:36:44 +00001680 for(i=0; i<pIdxInfo->nConstraint; i++){
1681 if( !pIdxInfo->aConstraint[i].usable && pUsage[i].argvIndex>0 ){
1682 sqlite3ErrorMsg(pParse,
1683 "table %s: xBestIndex returned an invalid plan", pTab->zName);
1684 return 0.0;
1685 }
1686 }
1687
drha967e882006-06-13 01:04:52 +00001688 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
drh9eff6162006-06-12 21:59:13 +00001689 return pIdxInfo->estimatedCost;
1690}
1691#endif /* SQLITE_OMIT_VIRTUALTABLE */
1692
drh28c4cf42005-07-27 20:41:43 +00001693/*
drh111a6a72008-12-21 03:51:16 +00001694** Find the query plan for accessing a particular table. Write the
1695** best query plan and its cost into the WhereCost object supplied as the
1696** last parameter.
drh51147ba2005-07-23 22:59:55 +00001697**
drh111a6a72008-12-21 03:51:16 +00001698** The lowest cost plan wins. The cost is an estimate of the amount of
1699** CPU and disk I/O need to process the request using the selected plan.
drh51147ba2005-07-23 22:59:55 +00001700** Factors that influence cost include:
1701**
1702** * The estimated number of rows that will be retrieved. (The
1703** fewer the better.)
1704**
1705** * Whether or not sorting must occur.
1706**
1707** * Whether or not there must be separate lookups in the
1708** index and in the main table.
1709**
danielk197785574e32008-10-06 05:32:18 +00001710** If there was an INDEXED BY clause attached to the table in the SELECT
drh111a6a72008-12-21 03:51:16 +00001711** statement, then this function only considers plans using the
danielk197785574e32008-10-06 05:32:18 +00001712** named index. If one cannot be found, then the returned cost is
drh111a6a72008-12-21 03:51:16 +00001713** SQLITE_BIG_DBL. If a plan can be found that uses the named index,
danielk197785574e32008-10-06 05:32:18 +00001714** then the cost is calculated in the usual way.
1715**
1716** If a NOT INDEXED clause was attached to the table in the SELECT
1717** statement, then no indexes are considered. However, the selected
drh111a6a72008-12-21 03:51:16 +00001718** plan may still take advantage of the tables built-in rowid
danielk197785574e32008-10-06 05:32:18 +00001719** index.
drhfe05af82005-07-21 03:14:59 +00001720*/
drh111a6a72008-12-21 03:51:16 +00001721static void bestIndex(
drhfe05af82005-07-21 03:14:59 +00001722 Parse *pParse, /* The parsing context */
1723 WhereClause *pWC, /* The WHERE clause */
1724 struct SrcList_item *pSrc, /* The FROM clause term to search */
1725 Bitmask notReady, /* Mask of cursors that are not available */
drh111a6a72008-12-21 03:51:16 +00001726 ExprList *pOrderBy, /* The ORDER BY clause */
1727 WhereCost *pCost /* Lowest cost query plan */
drhfe05af82005-07-21 03:14:59 +00001728){
drh111a6a72008-12-21 03:51:16 +00001729 WhereTerm *pTerm; /* A single term of the WHERE clause */
drh51147ba2005-07-23 22:59:55 +00001730 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
1731 Index *pProbe; /* An index we are evaluating */
1732 int rev; /* True to scan in reverse order */
drh165be382008-12-05 02:36:33 +00001733 int wsFlags; /* Flags associated with pProbe */
drh51147ba2005-07-23 22:59:55 +00001734 int nEq; /* Number of == or IN constraints */
drhc49de5d2007-01-19 01:06:01 +00001735 int eqTermMask; /* Mask of valid equality operators */
drh51147ba2005-07-23 22:59:55 +00001736 double cost; /* Cost of using pProbe */
drh111a6a72008-12-21 03:51:16 +00001737 double nRow; /* Estimated number of rows in result set */
drhdd5f5a62008-12-23 13:35:23 +00001738 int i; /* Loop counter */
1739 Bitmask maskSrc; /* Bitmask for the pSrc table */
drhfe05af82005-07-21 03:14:59 +00001740
drh165be382008-12-05 02:36:33 +00001741 WHERETRACE(("bestIndex: tbl=%s notReady=%llx\n", pSrc->pTab->zName,notReady));
drh4dd238a2006-03-28 23:55:57 +00001742 pProbe = pSrc->pTab->pIndex;
danielk197785574e32008-10-06 05:32:18 +00001743 if( pSrc->notIndexed ){
1744 pProbe = 0;
1745 }
drh4dd238a2006-03-28 23:55:57 +00001746
1747 /* If the table has no indices and there are no terms in the where
1748 ** clause that refer to the ROWID, then we will never be able to do
1749 ** anything other than a full table scan on this table. We might as
1750 ** well put it first in the join order. That way, perhaps it can be
1751 ** referenced by other tables in the join.
1752 */
drh111a6a72008-12-21 03:51:16 +00001753 memset(pCost, 0, sizeof(*pCost));
drh4dd238a2006-03-28 23:55:57 +00001754 if( pProbe==0 &&
1755 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 +00001756 (pOrderBy==0 || !sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev)) ){
drh111a6a72008-12-21 03:51:16 +00001757 return;
drh4dd238a2006-03-28 23:55:57 +00001758 }
drh111a6a72008-12-21 03:51:16 +00001759 pCost->rCost = SQLITE_BIG_DBL;
drh51147ba2005-07-23 22:59:55 +00001760
danielk197785574e32008-10-06 05:32:18 +00001761 /* Check for a rowid=EXPR or rowid IN (...) constraints. If there was
1762 ** an INDEXED BY clause attached to this table, skip this step.
drhfe05af82005-07-21 03:14:59 +00001763 */
danielk197785574e32008-10-06 05:32:18 +00001764 if( !pSrc->pIndex ){
1765 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
1766 if( pTerm ){
1767 Expr *pExpr;
drh111a6a72008-12-21 03:51:16 +00001768 pCost->plan.wsFlags = WHERE_ROWID_EQ;
danielk197785574e32008-10-06 05:32:18 +00001769 if( pTerm->eOperator & WO_EQ ){
1770 /* Rowid== is always the best pick. Look no further. Because only
1771 ** a single row is generated, output is always in sorted order */
drh111a6a72008-12-21 03:51:16 +00001772 pCost->plan.wsFlags = WHERE_ROWID_EQ | WHERE_UNIQUE;
1773 pCost->plan.nEq = 1;
danielk197785574e32008-10-06 05:32:18 +00001774 WHERETRACE(("... best is rowid\n"));
drh111a6a72008-12-21 03:51:16 +00001775 pCost->rCost = 0;
1776 pCost->nRow = 1;
1777 return;
danielk197785574e32008-10-06 05:32:18 +00001778 }else if( (pExpr = pTerm->pExpr)->pList!=0 ){
1779 /* Rowid IN (LIST): cost is NlogN where N is the number of list
1780 ** elements. */
drh111a6a72008-12-21 03:51:16 +00001781 pCost->rCost = pCost->nRow = pExpr->pList->nExpr;
1782 pCost->rCost *= estLog(pCost->rCost);
danielk197785574e32008-10-06 05:32:18 +00001783 }else{
1784 /* Rowid IN (SELECT): cost is NlogN where N is the number of rows
1785 ** in the result of the inner select. We have no way to estimate
1786 ** that value so make a wild guess. */
drh111a6a72008-12-21 03:51:16 +00001787 pCost->nRow = 100;
1788 pCost->rCost = 200;
drh28c4cf42005-07-27 20:41:43 +00001789 }
drh111a6a72008-12-21 03:51:16 +00001790 WHERETRACE(("... rowid IN cost: %.9g\n", pCost->rCost));
drh51147ba2005-07-23 22:59:55 +00001791 }
danielk197785574e32008-10-06 05:32:18 +00001792
1793 /* Estimate the cost of a table scan. If we do not know how many
1794 ** entries are in the table, use 1 million as a guess.
1795 */
1796 cost = pProbe ? pProbe->aiRowEst[0] : 1000000;
1797 WHERETRACE(("... table scan base cost: %.9g\n", cost));
drh165be382008-12-05 02:36:33 +00001798 wsFlags = WHERE_ROWID_RANGE;
danielk197785574e32008-10-06 05:32:18 +00001799
1800 /* Check for constraints on a range of rowids in a table scan.
1801 */
1802 pTerm = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE|WO_GT|WO_GE, 0);
1803 if( pTerm ){
1804 if( findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0) ){
drh165be382008-12-05 02:36:33 +00001805 wsFlags |= WHERE_TOP_LIMIT;
drh700a2262008-12-17 19:22:15 +00001806 cost /= 3; /* Guess that rowid<EXPR eliminates two-thirds of rows */
danielk197785574e32008-10-06 05:32:18 +00001807 }
1808 if( findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0) ){
drh165be382008-12-05 02:36:33 +00001809 wsFlags |= WHERE_BTM_LIMIT;
danielk197785574e32008-10-06 05:32:18 +00001810 cost /= 3; /* Guess that rowid>EXPR eliminates two-thirds of rows */
1811 }
1812 WHERETRACE(("... rowid range reduces cost to %.9g\n", cost));
1813 }else{
drh165be382008-12-05 02:36:33 +00001814 wsFlags = 0;
danielk197785574e32008-10-06 05:32:18 +00001815 }
drh111a6a72008-12-21 03:51:16 +00001816 nRow = cost;
danielk197785574e32008-10-06 05:32:18 +00001817
1818 /* If the table scan does not satisfy the ORDER BY clause, increase
1819 ** the cost by NlogN to cover the expense of sorting. */
1820 if( pOrderBy ){
1821 if( sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev) ){
drh165be382008-12-05 02:36:33 +00001822 wsFlags |= WHERE_ORDERBY|WHERE_ROWID_RANGE;
danielk197785574e32008-10-06 05:32:18 +00001823 if( rev ){
drh165be382008-12-05 02:36:33 +00001824 wsFlags |= WHERE_REVERSE;
danielk197785574e32008-10-06 05:32:18 +00001825 }
1826 }else{
1827 cost += cost*estLog(cost);
1828 WHERETRACE(("... sorting increases cost to %.9g\n", cost));
1829 }
1830 }
drh111a6a72008-12-21 03:51:16 +00001831 if( cost<pCost->rCost ){
1832 pCost->rCost = cost;
1833 pCost->nRow = nRow;
1834 pCost->plan.wsFlags = wsFlags;
danielk197785574e32008-10-06 05:32:18 +00001835 }
drhfe05af82005-07-21 03:14:59 +00001836 }
1837
drh23d04d52008-12-23 23:56:22 +00001838#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00001839 /* Search for an OR-clause that can be used to look up the table.
1840 */
1841 maskSrc = getMask(pWC->pMaskSet, iCur);
1842 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1843 WhereClause tempWC;
1844 tempWC = *pWC;
1845 tempWC.nSlot = 1;
1846 if( pTerm->eOperator==WO_OR
1847 && ((pTerm->prereqAll & ~maskSrc) & notReady)==0
1848 && (pTerm->u.pOrInfo->indexable & maskSrc)!=0 ){
1849 WhereClause *pOrWC = &pTerm->u.pOrInfo->wc;
1850 WhereTerm *pOrTerm;
1851 int j;
1852 double rTotal = 0;
1853 double nRow = 0;
1854 for(j=0, pOrTerm=pOrWC->a; j<pOrWC->nTerm; j++, pOrTerm++){
1855 WhereCost sTermCost;
drh29435252008-12-28 18:35:08 +00001856 if( pOrTerm->eOperator==WO_AND ){
1857 WhereClause *pAndWC = &pOrTerm->u.pAndInfo->wc;
1858 bestIndex(pParse, pAndWC, pSrc, notReady, 0, &sTermCost);
1859 }else if( pOrTerm->leftCursor==iCur ){
1860 tempWC.a = pOrTerm;
1861 bestIndex(pParse, &tempWC, pSrc, notReady, 0, &sTermCost);
1862 }else{
1863 continue;
1864 }
drhdd5f5a62008-12-23 13:35:23 +00001865 if( sTermCost.plan.wsFlags==0 ){
1866 rTotal = pCost->rCost;
1867 break;
1868 }
1869 rTotal += sTermCost.rCost;
1870 nRow += sTermCost.nRow;
1871 }
1872 if( rTotal<pCost->rCost ){
1873 pCost->rCost = rTotal;
1874 pCost->nRow = nRow;
1875 pCost->plan.wsFlags = WHERE_MULTI_OR;
1876 pCost->plan.u.pTerm = pTerm;
drhca8c4662008-12-28 20:47:02 +00001877 if( pOrderBy!=0
1878 && sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev)
1879 && !rev
1880 ){
1881 pCost->plan.wsFlags = WHERE_ORDERBY|WHERE_MULTI_OR;
1882 }
drhdd5f5a62008-12-23 13:35:23 +00001883 }
1884 }
1885 }
drh23d04d52008-12-23 23:56:22 +00001886#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00001887
drhc49de5d2007-01-19 01:06:01 +00001888 /* If the pSrc table is the right table of a LEFT JOIN then we may not
1889 ** use an index to satisfy IS NULL constraints on that table. This is
1890 ** because columns might end up being NULL if the table does not match -
1891 ** a circumstance which the index cannot help us discover. Ticket #2177.
1892 */
1893 if( (pSrc->jointype & JT_LEFT)!=0 ){
1894 eqTermMask = WO_EQ|WO_IN;
1895 }else{
1896 eqTermMask = WO_EQ|WO_IN|WO_ISNULL;
1897 }
1898
drhfe05af82005-07-21 03:14:59 +00001899 /* Look at each index.
1900 */
danielk197785574e32008-10-06 05:32:18 +00001901 if( pSrc->pIndex ){
1902 pProbe = pSrc->pIndex;
1903 }
1904 for(; pProbe; pProbe=(pSrc->pIndex ? 0 : pProbe->pNext)){
drh51147ba2005-07-23 22:59:55 +00001905 int i; /* Loop counter */
drhb37df7b2005-10-13 02:09:49 +00001906 double inMultiplier = 1;
drh51147ba2005-07-23 22:59:55 +00001907
drh4f0c5872007-03-26 22:05:01 +00001908 WHERETRACE(("... index %s:\n", pProbe->zName));
drhfe05af82005-07-21 03:14:59 +00001909
1910 /* Count the number of columns in the index that are satisfied
1911 ** by x=EXPR constraints or x IN (...) constraints.
1912 */
drh165be382008-12-05 02:36:33 +00001913 wsFlags = 0;
drhfe05af82005-07-21 03:14:59 +00001914 for(i=0; i<pProbe->nColumn; i++){
1915 int j = pProbe->aiColumn[i];
drhc49de5d2007-01-19 01:06:01 +00001916 pTerm = findTerm(pWC, iCur, j, notReady, eqTermMask, pProbe);
drhfe05af82005-07-21 03:14:59 +00001917 if( pTerm==0 ) break;
drh165be382008-12-05 02:36:33 +00001918 wsFlags |= WHERE_COLUMN_EQ;
drhb52076c2006-01-23 13:22:09 +00001919 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00001920 Expr *pExpr = pTerm->pExpr;
drh165be382008-12-05 02:36:33 +00001921 wsFlags |= WHERE_COLUMN_IN;
drha6110402005-07-28 20:51:19 +00001922 if( pExpr->pSelect!=0 ){
drhffe0f892006-05-11 13:26:25 +00001923 inMultiplier *= 25;
drh34004ce2008-07-11 16:15:17 +00001924 }else if( ALWAYS(pExpr->pList) ){
drhb37df7b2005-10-13 02:09:49 +00001925 inMultiplier *= pExpr->pList->nExpr + 1;
drhfe05af82005-07-21 03:14:59 +00001926 }
1927 }
1928 }
drh111a6a72008-12-21 03:51:16 +00001929 nRow = pProbe->aiRowEst[i] * inMultiplier;
1930 cost = nRow * estLog(inMultiplier);
drh51147ba2005-07-23 22:59:55 +00001931 nEq = i;
drh165be382008-12-05 02:36:33 +00001932 if( pProbe->onError!=OE_None && (wsFlags & WHERE_COLUMN_IN)==0
drh943af3c2005-07-29 19:43:58 +00001933 && nEq==pProbe->nColumn ){
drh165be382008-12-05 02:36:33 +00001934 wsFlags |= WHERE_UNIQUE;
drh943af3c2005-07-29 19:43:58 +00001935 }
drh8e70e342007-09-13 17:54:40 +00001936 WHERETRACE(("...... nEq=%d inMult=%.9g cost=%.9g\n",nEq,inMultiplier,cost));
drhfe05af82005-07-21 03:14:59 +00001937
drh51147ba2005-07-23 22:59:55 +00001938 /* Look for range constraints
drhfe05af82005-07-21 03:14:59 +00001939 */
drh51147ba2005-07-23 22:59:55 +00001940 if( nEq<pProbe->nColumn ){
1941 int j = pProbe->aiColumn[nEq];
1942 pTerm = findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE|WO_GT|WO_GE, pProbe);
1943 if( pTerm ){
drh165be382008-12-05 02:36:33 +00001944 wsFlags |= WHERE_COLUMN_RANGE;
drh51147ba2005-07-23 22:59:55 +00001945 if( findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE, pProbe) ){
drh165be382008-12-05 02:36:33 +00001946 wsFlags |= WHERE_TOP_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 }
1950 if( findTerm(pWC, iCur, j, notReady, WO_GT|WO_GE, pProbe) ){
drh165be382008-12-05 02:36:33 +00001951 wsFlags |= WHERE_BTM_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001952 cost /= 3;
drh111a6a72008-12-21 03:51:16 +00001953 nRow /= 3;
drh51147ba2005-07-23 22:59:55 +00001954 }
drh4f0c5872007-03-26 22:05:01 +00001955 WHERETRACE(("...... range reduces cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001956 }
1957 }
1958
drh28c4cf42005-07-27 20:41:43 +00001959 /* Add the additional cost of sorting if that is a factor.
drh51147ba2005-07-23 22:59:55 +00001960 */
drh28c4cf42005-07-27 20:41:43 +00001961 if( pOrderBy ){
drh165be382008-12-05 02:36:33 +00001962 if( (wsFlags & WHERE_COLUMN_IN)==0 &&
drh7b4fc6a2007-02-06 13:26:32 +00001963 isSortingIndex(pParse,pWC->pMaskSet,pProbe,iCur,pOrderBy,nEq,&rev) ){
drh165be382008-12-05 02:36:33 +00001964 if( wsFlags==0 ){
1965 wsFlags = WHERE_COLUMN_RANGE;
drh28c4cf42005-07-27 20:41:43 +00001966 }
drh165be382008-12-05 02:36:33 +00001967 wsFlags |= WHERE_ORDERBY;
drh28c4cf42005-07-27 20:41:43 +00001968 if( rev ){
drh165be382008-12-05 02:36:33 +00001969 wsFlags |= WHERE_REVERSE;
drh28c4cf42005-07-27 20:41:43 +00001970 }
1971 }else{
1972 cost += cost*estLog(cost);
drh4f0c5872007-03-26 22:05:01 +00001973 WHERETRACE(("...... orderby increases cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001974 }
drhfe05af82005-07-21 03:14:59 +00001975 }
1976
1977 /* Check to see if we can get away with using just the index without
drh51147ba2005-07-23 22:59:55 +00001978 ** ever reading the table. If that is the case, then halve the
1979 ** cost of this index.
drhfe05af82005-07-21 03:14:59 +00001980 */
drh165be382008-12-05 02:36:33 +00001981 if( wsFlags && pSrc->colUsed < (((Bitmask)1)<<(BMS-1)) ){
drhfe05af82005-07-21 03:14:59 +00001982 Bitmask m = pSrc->colUsed;
1983 int j;
1984 for(j=0; j<pProbe->nColumn; j++){
1985 int x = pProbe->aiColumn[j];
1986 if( x<BMS-1 ){
1987 m &= ~(((Bitmask)1)<<x);
1988 }
1989 }
1990 if( m==0 ){
drh165be382008-12-05 02:36:33 +00001991 wsFlags |= WHERE_IDX_ONLY;
drhb37df7b2005-10-13 02:09:49 +00001992 cost /= 2;
drh4f0c5872007-03-26 22:05:01 +00001993 WHERETRACE(("...... idx-only reduces cost to %.9g\n", cost));
drhfe05af82005-07-21 03:14:59 +00001994 }
1995 }
1996
drh51147ba2005-07-23 22:59:55 +00001997 /* If this index has achieved the lowest cost so far, then use it.
drhfe05af82005-07-21 03:14:59 +00001998 */
drh111a6a72008-12-21 03:51:16 +00001999 if( wsFlags!=0 && cost < pCost->rCost ){
2000 pCost->rCost = cost;
2001 pCost->nRow = nRow;
2002 pCost->plan.wsFlags = wsFlags;
2003 pCost->plan.nEq = nEq;
2004 assert( pCost->plan.wsFlags & WHERE_INDEXED );
2005 pCost->plan.u.pIdx = pProbe;
drhfe05af82005-07-21 03:14:59 +00002006 }
2007 }
2008
drhfe05af82005-07-21 03:14:59 +00002009 /* Report the best result
2010 */
drh111a6a72008-12-21 03:51:16 +00002011 pCost->plan.wsFlags |= eqTermMask;
2012 WHERETRACE(("best index is %s, cost=%.9g, nrow=%.9g, wsFlags=%x, nEq=%d\n",
2013 (pCost->plan.wsFlags & WHERE_INDEXED)!=0 ?
2014 pCost->plan.u.pIdx->zName : "(none)", pCost->nRow,
2015 pCost->rCost, pCost->plan.wsFlags, pCost->plan.nEq));
drhfe05af82005-07-21 03:14:59 +00002016}
2017
drhb6c29892004-11-22 19:12:19 +00002018
2019/*
drh2ffb1182004-07-19 19:14:01 +00002020** Disable a term in the WHERE clause. Except, do not disable the term
2021** if it controls a LEFT OUTER JOIN and it did not originate in the ON
2022** or USING clause of that join.
2023**
2024** Consider the term t2.z='ok' in the following queries:
2025**
2026** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
2027** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
2028** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
2029**
drh23bf66d2004-12-14 03:34:34 +00002030** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00002031** in the ON clause. The term is disabled in (3) because it is not part
2032** of a LEFT OUTER JOIN. In (1), the term is not disabled.
2033**
2034** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00002035** of the join. Disabling is an optimization. When terms are satisfied
2036** by indices, we disable them to prevent redundant tests in the inner
2037** loop. We would get the correct results if nothing were ever disabled,
2038** but joins might run a little slower. The trick is to disable as much
2039** as we can without disabling too much. If we disabled in (1), we'd get
2040** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00002041*/
drh0fcef5e2005-07-19 17:38:22 +00002042static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
2043 if( pTerm
drh165be382008-12-05 02:36:33 +00002044 && ALWAYS((pTerm->wtFlags & TERM_CODED)==0)
drh0fcef5e2005-07-19 17:38:22 +00002045 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
2046 ){
drh165be382008-12-05 02:36:33 +00002047 pTerm->wtFlags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00002048 if( pTerm->iParent>=0 ){
2049 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
2050 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00002051 disableTerm(pLevel, pOther);
2052 }
drh0fcef5e2005-07-19 17:38:22 +00002053 }
drh2ffb1182004-07-19 19:14:01 +00002054 }
2055}
2056
2057/*
danielk1977b790c6c2008-04-18 10:25:24 +00002058** Apply the affinities associated with the first n columns of index
2059** pIdx to the values in the n registers starting at base.
drh94a11212004-09-25 13:12:14 +00002060*/
danielk1977b790c6c2008-04-18 10:25:24 +00002061static void codeApplyAffinity(Parse *pParse, int base, int n, Index *pIdx){
2062 if( n>0 ){
2063 Vdbe *v = pParse->pVdbe;
2064 assert( v!=0 );
2065 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
2066 sqlite3IndexAffinityStr(v, pIdx);
2067 sqlite3ExprCacheAffinityChange(pParse, base, n);
2068 }
drh94a11212004-09-25 13:12:14 +00002069}
2070
drhe8b97272005-07-19 22:22:12 +00002071
2072/*
drh51147ba2005-07-23 22:59:55 +00002073** Generate code for a single equality term of the WHERE clause. An equality
2074** term can be either X=expr or X IN (...). pTerm is the term to be
2075** coded.
2076**
drh1db639c2008-01-17 02:36:28 +00002077** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00002078**
2079** For a constraint of the form X=expr, the expression is evaluated and its
2080** result is left on the stack. For constraints of the form X IN (...)
2081** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00002082*/
drh678ccce2008-03-31 18:19:54 +00002083static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00002084 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00002085 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh1db639c2008-01-17 02:36:28 +00002086 WhereLevel *pLevel, /* When level of the FROM clause we are working on */
drh678ccce2008-03-31 18:19:54 +00002087 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00002088){
drh0fcef5e2005-07-19 17:38:22 +00002089 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00002090 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00002091 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00002092
danielk19772d605492008-10-01 08:43:03 +00002093 assert( iTarget>0 );
drh50b39962006-10-28 00:28:09 +00002094 if( pX->op==TK_EQ ){
drh678ccce2008-03-31 18:19:54 +00002095 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00002096 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00002097 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00002098 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00002099#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00002100 }else{
danielk19779a96b662007-11-29 17:05:18 +00002101 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00002102 int iTab;
drh72e8fa42007-03-28 14:30:06 +00002103 struct InLoop *pIn;
danielk1977b3bce662005-01-29 08:32:43 +00002104
drh50b39962006-10-28 00:28:09 +00002105 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00002106 iReg = iTarget;
danielk19770cdc0222008-06-26 18:04:03 +00002107 eType = sqlite3FindInIndex(pParse, pX, 0);
danielk1977b3bce662005-01-29 08:32:43 +00002108 iTab = pX->iTable;
drh66a51672008-01-03 00:01:23 +00002109 sqlite3VdbeAddOp2(v, OP_Rewind, iTab, 0);
drhd4e70eb2008-01-02 00:34:36 +00002110 VdbeComment((v, "%.*s", pX->span.n, pX->span.z));
drh111a6a72008-12-21 03:51:16 +00002111 assert( pLevel->plan.wsFlags & WHERE_IN_ABLE );
2112 if( pLevel->u.in.nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00002113 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00002114 }
drh111a6a72008-12-21 03:51:16 +00002115 pLevel->u.in.nIn++;
2116 pLevel->u.in.aInLoop =
2117 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
2118 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
2119 pIn = pLevel->u.in.aInLoop;
drh72e8fa42007-03-28 14:30:06 +00002120 if( pIn ){
drh111a6a72008-12-21 03:51:16 +00002121 pIn += pLevel->u.in.nIn - 1;
drh72e8fa42007-03-28 14:30:06 +00002122 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00002123 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00002124 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00002125 }else{
drhb3190c12008-12-08 21:37:14 +00002126 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00002127 }
2128 sqlite3VdbeAddOp1(v, OP_IsNull, iReg);
drha6110402005-07-28 20:51:19 +00002129 }else{
drh111a6a72008-12-21 03:51:16 +00002130 pLevel->u.in.nIn = 0;
drhe23399f2005-07-22 00:31:39 +00002131 }
danielk1977b3bce662005-01-29 08:32:43 +00002132#endif
drh94a11212004-09-25 13:12:14 +00002133 }
drh0fcef5e2005-07-19 17:38:22 +00002134 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00002135 return iReg;
drh94a11212004-09-25 13:12:14 +00002136}
2137
drh51147ba2005-07-23 22:59:55 +00002138/*
2139** Generate code that will evaluate all == and IN constraints for an
2140** index. The values for all constraints are left on the stack.
2141**
2142** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
2143** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
2144** The index has as many as three equality constraints, but in this
2145** example, the third "c" value is an inequality. So only two
2146** constraints are coded. This routine will generate code to evaluate
drh6df2acd2008-12-28 16:55:25 +00002147** a==5 and b IN (1,2,3). The current values for a and b will be stored
2148** in consecutive registers and the index of the first register is returned.
drh51147ba2005-07-23 22:59:55 +00002149**
2150** In the example above nEq==2. But this subroutine works for any value
2151** of nEq including 0. If nEq==0, this routine is nearly a no-op.
2152** The only thing it does is allocate the pLevel->iMem memory cell.
2153**
drh700a2262008-12-17 19:22:15 +00002154** This routine always allocates at least one memory cell and returns
2155** the index of that memory cell. The code that
2156** calls this routine will use that memory cell to store the termination
drh51147ba2005-07-23 22:59:55 +00002157** key value of the loop. If one or more IN operators appear, then
2158** this routine allocates an additional nEq memory cells for internal
2159** use.
2160*/
drh1db639c2008-01-17 02:36:28 +00002161static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00002162 Parse *pParse, /* Parsing context */
2163 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
2164 WhereClause *pWC, /* The WHERE clause */
drh1db639c2008-01-17 02:36:28 +00002165 Bitmask notReady, /* Which parts of FROM have not yet been coded */
2166 int nExtraReg /* Number of extra registers to allocate */
drh51147ba2005-07-23 22:59:55 +00002167){
drh111a6a72008-12-21 03:51:16 +00002168 int nEq = pLevel->plan.nEq; /* The number of == or IN constraints to code */
2169 Vdbe *v = pParse->pVdbe; /* The vm under construction */
2170 Index *pIdx; /* The index being used for this loop */
drh51147ba2005-07-23 22:59:55 +00002171 int iCur = pLevel->iTabCur; /* The cursor of the table */
2172 WhereTerm *pTerm; /* A single constraint term */
2173 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00002174 int regBase; /* Base register */
drh6df2acd2008-12-28 16:55:25 +00002175 int nReg; /* Number of registers to allocate */
drh51147ba2005-07-23 22:59:55 +00002176
drh111a6a72008-12-21 03:51:16 +00002177 /* This module is only called on query plans that use an index. */
2178 assert( pLevel->plan.wsFlags & WHERE_INDEXED );
2179 pIdx = pLevel->plan.u.pIdx;
2180
drh51147ba2005-07-23 22:59:55 +00002181 /* Figure out how many memory cells we will need then allocate them.
drh51147ba2005-07-23 22:59:55 +00002182 */
drh700a2262008-12-17 19:22:15 +00002183 regBase = pParse->nMem + 1;
drh6df2acd2008-12-28 16:55:25 +00002184 nReg = pLevel->plan.nEq + nExtraReg;
2185 pParse->nMem += nReg;
drh51147ba2005-07-23 22:59:55 +00002186
2187 /* Evaluate the equality constraints
2188 */
drhc49de5d2007-01-19 01:06:01 +00002189 assert( pIdx->nColumn>=nEq );
2190 for(j=0; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00002191 int r1;
drh51147ba2005-07-23 22:59:55 +00002192 int k = pIdx->aiColumn[j];
drh111a6a72008-12-21 03:51:16 +00002193 pTerm = findTerm(pWC, iCur, k, notReady, pLevel->plan.wsFlags, pIdx);
drh34004ce2008-07-11 16:15:17 +00002194 if( NEVER(pTerm==0) ) break;
drh165be382008-12-05 02:36:33 +00002195 assert( (pTerm->wtFlags & TERM_CODED)==0 );
drh678ccce2008-03-31 18:19:54 +00002196 r1 = codeEqualityTerm(pParse, pTerm, pLevel, regBase+j);
2197 if( r1!=regBase+j ){
drh6df2acd2008-12-28 16:55:25 +00002198 if( nReg==1 ){
2199 sqlite3ReleaseTempReg(pParse, regBase);
2200 regBase = r1;
2201 }else{
2202 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
2203 }
drh678ccce2008-03-31 18:19:54 +00002204 }
drh981642f2008-04-19 14:40:43 +00002205 testcase( pTerm->eOperator & WO_ISNULL );
2206 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00002207 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drhb3190c12008-12-08 21:37:14 +00002208 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
drh51147ba2005-07-23 22:59:55 +00002209 }
2210 }
drh1db639c2008-01-17 02:36:28 +00002211 return regBase;
drh51147ba2005-07-23 22:59:55 +00002212}
2213
drh111a6a72008-12-21 03:51:16 +00002214/*
drh23d04d52008-12-23 23:56:22 +00002215** Return TRUE if the WhereClause pWC contains no terms that
2216** are not virtual and which have not been coded.
2217**
2218** To put it another way, return TRUE if no additional WHERE clauses
2219** tests are required in order to establish that the current row
2220** should go to output and return FALSE if there are some terms of
2221** the WHERE clause that need to be validated before outputing the row.
2222*/
2223static int whereRowReadyForOutput(WhereClause *pWC){
2224 WhereTerm *pTerm;
2225 int j;
2226
2227 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2228 if( (pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED))==0 ) return 0;
2229 }
2230 return 1;
2231}
2232
2233/*
drh111a6a72008-12-21 03:51:16 +00002234** Generate code for the start of the iLevel-th loop in the WHERE clause
2235** implementation described by pWInfo.
2236*/
2237static Bitmask codeOneLoopStart(
2238 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
2239 int iLevel, /* Which level of pWInfo->a[] should be coded */
2240 u8 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
2241 Bitmask notReady /* Which tables are currently available */
2242){
2243 int j, k; /* Loop counters */
2244 int iCur; /* The VDBE cursor for the table */
2245 int addrNxt; /* Where to jump to continue with the next IN case */
2246 int omitTable; /* True if we use the index only */
2247 int bRev; /* True if we need to scan in reverse order */
2248 WhereLevel *pLevel; /* The where level to be coded */
2249 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
2250 WhereTerm *pTerm; /* A WHERE clause term */
2251 Parse *pParse; /* Parsing context */
2252 Vdbe *v; /* The prepared stmt under constructions */
2253 struct SrcList_item *pTabItem; /* FROM clause term being coded */
drh23d04d52008-12-23 23:56:22 +00002254 int addrBrk; /* Jump here to break out of the loop */
2255 int addrCont; /* Jump here to continue with next cycle */
2256 int regRowSet; /* Write rowids to this RowSet if non-negative */
2257 int codeRowSetEarly; /* True if index fully constrains the search */
drh111a6a72008-12-21 03:51:16 +00002258
2259
2260 pParse = pWInfo->pParse;
2261 v = pParse->pVdbe;
2262 pWC = pWInfo->pWC;
2263 pLevel = &pWInfo->a[iLevel];
2264 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
2265 iCur = pTabItem->iCursor;
2266 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
2267 omitTable = (pLevel->plan.wsFlags & WHERE_IDX_ONLY)!=0;
drh23d04d52008-12-23 23:56:22 +00002268 regRowSet = pWInfo->regRowSet;
2269 codeRowSetEarly = 0;
drh111a6a72008-12-21 03:51:16 +00002270
2271 /* Create labels for the "break" and "continue" instructions
2272 ** for the current loop. Jump to addrBrk to break out of a loop.
2273 ** Jump to cont to go immediately to the next iteration of the
2274 ** loop.
2275 **
2276 ** When there is an IN operator, we also have a "addrNxt" label that
2277 ** means to continue with the next IN value combination. When
2278 ** there are no IN operators in the constraints, the "addrNxt" label
2279 ** is the same as "addrBrk".
2280 */
2281 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
2282 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
2283
2284 /* If this is the right table of a LEFT OUTER JOIN, allocate and
2285 ** initialize a memory cell that records if this table matches any
2286 ** row of the left table of the join.
2287 */
2288 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
2289 pLevel->iLeftJoin = ++pParse->nMem;
2290 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
2291 VdbeComment((v, "init LEFT JOIN no-match flag"));
2292 }
2293
2294#ifndef SQLITE_OMIT_VIRTUALTABLE
2295 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
2296 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
2297 ** to access the data.
2298 */
2299 int iReg; /* P3 Value for OP_VFilter */
2300 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
2301 int nConstraint = pVtabIdx->nConstraint;
2302 struct sqlite3_index_constraint_usage *aUsage =
2303 pVtabIdx->aConstraintUsage;
2304 const struct sqlite3_index_constraint *aConstraint =
2305 pVtabIdx->aConstraint;
2306
2307 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
2308 pParse->disableColCache++;
2309 for(j=1; j<=nConstraint; j++){
2310 for(k=0; k<nConstraint; k++){
2311 if( aUsage[k].argvIndex==j ){
2312 int iTerm = aConstraint[k].iTermOffset;
2313 assert( pParse->disableColCache );
2314 sqlite3ExprCode(pParse, pWC->a[iTerm].pExpr->pRight, iReg+j+1);
2315 break;
2316 }
2317 }
2318 if( k==nConstraint ) break;
2319 }
2320 assert( pParse->disableColCache );
2321 pParse->disableColCache--;
2322 sqlite3VdbeAddOp2(v, OP_Integer, pVtabIdx->idxNum, iReg);
2323 sqlite3VdbeAddOp2(v, OP_Integer, j-1, iReg+1);
2324 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrBrk, iReg, pVtabIdx->idxStr,
2325 pVtabIdx->needToFreeIdxStr ? P4_MPRINTF : P4_STATIC);
drh111a6a72008-12-21 03:51:16 +00002326 pVtabIdx->needToFreeIdxStr = 0;
2327 for(j=0; j<nConstraint; j++){
2328 if( aUsage[j].omit ){
2329 int iTerm = aConstraint[j].iTermOffset;
2330 disableTerm(pLevel, &pWC->a[iTerm]);
2331 }
2332 }
2333 pLevel->op = OP_VNext;
2334 pLevel->p1 = iCur;
2335 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh23d04d52008-12-23 23:56:22 +00002336 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2337 if( codeRowSetEarly ){
2338 sqlite3VdbeAddOp2(v, OP_VRowid, iCur, iReg);
2339 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, iReg);
2340 }
2341 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drh111a6a72008-12-21 03:51:16 +00002342 }else
2343#endif /* SQLITE_OMIT_VIRTUALTABLE */
2344
2345 if( pLevel->plan.wsFlags & WHERE_ROWID_EQ ){
2346 /* Case 1: We can directly reference a single row using an
2347 ** equality comparison against the ROWID field. Or
2348 ** we reference multiple rows using a "rowid IN (...)"
2349 ** construct.
2350 */
2351 int r1;
2352 int rtmp = sqlite3GetTempReg(pParse);
2353 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
2354 assert( pTerm!=0 );
2355 assert( pTerm->pExpr!=0 );
2356 assert( pTerm->leftCursor==iCur );
2357 assert( omitTable==0 );
2358 r1 = codeEqualityTerm(pParse, pTerm, pLevel, rtmp);
2359 addrNxt = pLevel->addrNxt;
2360 sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, addrNxt);
2361 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, r1);
drh23d04d52008-12-23 23:56:22 +00002362 codeRowSetEarly = (pWC->nTerm==1 && regRowSet>=0) ?1:0;
2363 if( codeRowSetEarly ){
2364 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2365 }
drh111a6a72008-12-21 03:51:16 +00002366 sqlite3ReleaseTempReg(pParse, rtmp);
2367 VdbeComment((v, "pk"));
2368 pLevel->op = OP_Noop;
2369 }else if( pLevel->plan.wsFlags & WHERE_ROWID_RANGE ){
2370 /* Case 2: We have an inequality comparison against the ROWID field.
2371 */
2372 int testOp = OP_Noop;
2373 int start;
2374 int memEndValue = 0;
2375 WhereTerm *pStart, *pEnd;
2376
2377 assert( omitTable==0 );
2378 pStart = findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0);
2379 pEnd = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0);
2380 if( bRev ){
2381 pTerm = pStart;
2382 pStart = pEnd;
2383 pEnd = pTerm;
2384 }
2385 if( pStart ){
2386 Expr *pX; /* The expression that defines the start bound */
2387 int r1, rTemp; /* Registers for holding the start boundary */
2388
2389 /* The following constant maps TK_xx codes into corresponding
2390 ** seek opcodes. It depends on a particular ordering of TK_xx
2391 */
2392 const u8 aMoveOp[] = {
2393 /* TK_GT */ OP_SeekGt,
2394 /* TK_LE */ OP_SeekLe,
2395 /* TK_LT */ OP_SeekLt,
2396 /* TK_GE */ OP_SeekGe
2397 };
2398 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
2399 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
2400 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
2401
2402 pX = pStart->pExpr;
2403 assert( pX!=0 );
2404 assert( pStart->leftCursor==iCur );
2405 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
2406 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
2407 VdbeComment((v, "pk"));
2408 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
2409 sqlite3ReleaseTempReg(pParse, rTemp);
2410 disableTerm(pLevel, pStart);
2411 }else{
2412 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
2413 }
2414 if( pEnd ){
2415 Expr *pX;
2416 pX = pEnd->pExpr;
2417 assert( pX!=0 );
2418 assert( pEnd->leftCursor==iCur );
2419 memEndValue = ++pParse->nMem;
2420 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
2421 if( pX->op==TK_LT || pX->op==TK_GT ){
2422 testOp = bRev ? OP_Le : OP_Ge;
2423 }else{
2424 testOp = bRev ? OP_Lt : OP_Gt;
2425 }
2426 disableTerm(pLevel, pEnd);
2427 }
2428 start = sqlite3VdbeCurrentAddr(v);
2429 pLevel->op = bRev ? OP_Prev : OP_Next;
2430 pLevel->p1 = iCur;
2431 pLevel->p2 = start;
drhca8c4662008-12-28 20:47:02 +00002432 pLevel->p5 = (pStart==0 && pEnd==0) ?1:0;
drh23d04d52008-12-23 23:56:22 +00002433 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2434 if( codeRowSetEarly || testOp!=OP_Noop ){
drh111a6a72008-12-21 03:51:16 +00002435 int r1 = sqlite3GetTempReg(pParse);
2436 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, r1);
drh23d04d52008-12-23 23:56:22 +00002437 if( testOp!=OP_Noop ){
2438 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, r1);
2439 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
2440 }
2441 if( codeRowSetEarly ){
2442 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2443 }
drh111a6a72008-12-21 03:51:16 +00002444 sqlite3ReleaseTempReg(pParse, r1);
2445 }
2446 }else if( pLevel->plan.wsFlags & (WHERE_COLUMN_RANGE|WHERE_COLUMN_EQ) ){
2447 /* Case 3: A scan using an index.
2448 **
2449 ** The WHERE clause may contain zero or more equality
2450 ** terms ("==" or "IN" operators) that refer to the N
2451 ** left-most columns of the index. It may also contain
2452 ** inequality constraints (>, <, >= or <=) on the indexed
2453 ** column that immediately follows the N equalities. Only
2454 ** the right-most column can be an inequality - the rest must
2455 ** use the "==" and "IN" operators. For example, if the
2456 ** index is on (x,y,z), then the following clauses are all
2457 ** optimized:
2458 **
2459 ** x=5
2460 ** x=5 AND y=10
2461 ** x=5 AND y<10
2462 ** x=5 AND y>5 AND y<10
2463 ** x=5 AND y=5 AND z<=10
2464 **
2465 ** The z<10 term of the following cannot be used, only
2466 ** the x=5 term:
2467 **
2468 ** x=5 AND z<10
2469 **
2470 ** N may be zero if there are inequality constraints.
2471 ** If there are no inequality constraints, then N is at
2472 ** least one.
2473 **
2474 ** This case is also used when there are no WHERE clause
2475 ** constraints but an index is selected anyway, in order
2476 ** to force the output order to conform to an ORDER BY.
2477 */
2478 int aStartOp[] = {
2479 0,
2480 0,
2481 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
2482 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
2483 OP_SeekGt, /* 4: (start_constraints && !startEq && !bRev) */
2484 OP_SeekLt, /* 5: (start_constraints && !startEq && bRev) */
2485 OP_SeekGe, /* 6: (start_constraints && startEq && !bRev) */
2486 OP_SeekLe /* 7: (start_constraints && startEq && bRev) */
2487 };
2488 int aEndOp[] = {
2489 OP_Noop, /* 0: (!end_constraints) */
2490 OP_IdxGE, /* 1: (end_constraints && !bRev) */
2491 OP_IdxLT /* 2: (end_constraints && bRev) */
2492 };
2493 int nEq = pLevel->plan.nEq;
2494 int isMinQuery = 0; /* If this is an optimized SELECT min(x).. */
2495 int regBase; /* Base register holding constraint values */
2496 int r1; /* Temp register */
2497 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
2498 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
2499 int startEq; /* True if range start uses ==, >= or <= */
2500 int endEq; /* True if range end uses ==, >= or <= */
2501 int start_constraints; /* Start of range is constrained */
2502 int nConstraint; /* Number of constraint terms */
2503 Index *pIdx; /* The index we will be using */
2504 int iIdxCur; /* The VDBE cursor for the index */
drh6df2acd2008-12-28 16:55:25 +00002505 int nExtraReg = 0; /* Number of extra registers needed */
2506 int op; /* Instruction opcode */
drh111a6a72008-12-21 03:51:16 +00002507
2508 pIdx = pLevel->plan.u.pIdx;
2509 iIdxCur = pLevel->iIdxCur;
2510 k = pIdx->aiColumn[nEq]; /* Column for inequality constraints */
2511
drh111a6a72008-12-21 03:51:16 +00002512 /* If this loop satisfies a sort order (pOrderBy) request that
2513 ** was passed to this function to implement a "SELECT min(x) ..."
2514 ** query, then the caller will only allow the loop to run for
2515 ** a single iteration. This means that the first row returned
2516 ** should not have a NULL value stored in 'x'. If column 'x' is
2517 ** the first one after the nEq equality constraints in the index,
2518 ** this requires some special handling.
2519 */
2520 if( (wctrlFlags&WHERE_ORDERBY_MIN)!=0
2521 && (pLevel->plan.wsFlags&WHERE_ORDERBY)
2522 && (pIdx->nColumn>nEq)
2523 ){
2524 /* assert( pOrderBy->nExpr==1 ); */
2525 /* assert( pOrderBy->a[0].pExpr->iColumn==pIdx->aiColumn[nEq] ); */
2526 isMinQuery = 1;
drh6df2acd2008-12-28 16:55:25 +00002527 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002528 }
2529
2530 /* Find any inequality constraint terms for the start and end
2531 ** of the range.
2532 */
2533 if( pLevel->plan.wsFlags & WHERE_TOP_LIMIT ){
2534 pRangeEnd = findTerm(pWC, iCur, k, notReady, (WO_LT|WO_LE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00002535 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002536 }
2537 if( pLevel->plan.wsFlags & WHERE_BTM_LIMIT ){
2538 pRangeStart = findTerm(pWC, iCur, k, notReady, (WO_GT|WO_GE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00002539 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002540 }
2541
drh6df2acd2008-12-28 16:55:25 +00002542 /* Generate code to evaluate all constraint terms using == or IN
2543 ** and store the values of those terms in an array of registers
2544 ** starting at regBase.
2545 */
2546 regBase = codeAllEqualityTerms(pParse, pLevel, pWC, notReady, nExtraReg);
2547 addrNxt = pLevel->addrNxt;
2548
2549
drh111a6a72008-12-21 03:51:16 +00002550 /* If we are doing a reverse order scan on an ascending index, or
2551 ** a forward order scan on a descending index, interchange the
2552 ** start and end terms (pRangeStart and pRangeEnd).
2553 */
2554 if( bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC) ){
2555 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
2556 }
2557
2558 testcase( pRangeStart && pRangeStart->eOperator & WO_LE );
2559 testcase( pRangeStart && pRangeStart->eOperator & WO_GE );
2560 testcase( pRangeEnd && pRangeEnd->eOperator & WO_LE );
2561 testcase( pRangeEnd && pRangeEnd->eOperator & WO_GE );
2562 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
2563 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
2564 start_constraints = pRangeStart || nEq>0;
2565
2566 /* Seek the index cursor to the start of the range. */
2567 nConstraint = nEq;
2568 if( pRangeStart ){
2569 int dcc = pParse->disableColCache;
2570 if( pRangeEnd ){
2571 pParse->disableColCache++;
2572 }
2573 sqlite3ExprCode(pParse, pRangeStart->pExpr->pRight, regBase+nEq);
2574 pParse->disableColCache = dcc;
2575 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2576 nConstraint++;
2577 }else if( isMinQuery ){
2578 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2579 nConstraint++;
2580 startEq = 0;
2581 start_constraints = 1;
2582 }
2583 codeApplyAffinity(pParse, regBase, nConstraint, pIdx);
2584 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
2585 assert( op!=0 );
2586 testcase( op==OP_Rewind );
2587 testcase( op==OP_Last );
2588 testcase( op==OP_SeekGt );
2589 testcase( op==OP_SeekGe );
2590 testcase( op==OP_SeekLe );
2591 testcase( op==OP_SeekLt );
2592 sqlite3VdbeAddOp4(v, op, iIdxCur, addrNxt, regBase,
2593 SQLITE_INT_TO_PTR(nConstraint), P4_INT32);
2594
2595 /* Load the value for the inequality constraint at the end of the
2596 ** range (if any).
2597 */
2598 nConstraint = nEq;
2599 if( pRangeEnd ){
2600 sqlite3ExprCode(pParse, pRangeEnd->pExpr->pRight, regBase+nEq);
2601 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2602 codeApplyAffinity(pParse, regBase, nEq+1, pIdx);
2603 nConstraint++;
2604 }
2605
2606 /* Top of the loop body */
2607 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2608
2609 /* Check if the index cursor is past the end of the range. */
2610 op = aEndOp[(pRangeEnd || nEq) * (1 + bRev)];
2611 testcase( op==OP_Noop );
2612 testcase( op==OP_IdxGE );
2613 testcase( op==OP_IdxLT );
drh6df2acd2008-12-28 16:55:25 +00002614 if( op!=OP_Noop ){
2615 sqlite3VdbeAddOp4(v, op, iIdxCur, addrNxt, regBase,
2616 SQLITE_INT_TO_PTR(nConstraint), P4_INT32);
2617 sqlite3VdbeChangeP5(v, endEq!=bRev ?1:0);
2618 }
drh111a6a72008-12-21 03:51:16 +00002619
2620 /* If there are inequality constraints, check that the value
2621 ** of the table column that the inequality contrains is not NULL.
2622 ** If it is, jump to the next iteration of the loop.
2623 */
2624 r1 = sqlite3GetTempReg(pParse);
2625 testcase( pLevel->plan.wsFlags & WHERE_BTM_LIMIT );
2626 testcase( pLevel->plan.wsFlags & WHERE_TOP_LIMIT );
2627 if( pLevel->plan.wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT) ){
2628 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, nEq, r1);
2629 sqlite3VdbeAddOp2(v, OP_IsNull, r1, addrCont);
2630 }
2631
2632 /* Seek the table cursor, if required */
drh23d04d52008-12-23 23:56:22 +00002633 disableTerm(pLevel, pRangeStart);
2634 disableTerm(pLevel, pRangeEnd);
2635 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2636 if( !omitTable || codeRowSetEarly ){
drh111a6a72008-12-21 03:51:16 +00002637 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, r1);
drh23d04d52008-12-23 23:56:22 +00002638 if( codeRowSetEarly ){
2639 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2640 }else{
2641 sqlite3VdbeAddOp2(v, OP_Seek, iCur, r1); /* Deferred seek */
2642 }
drh111a6a72008-12-21 03:51:16 +00002643 }
2644 sqlite3ReleaseTempReg(pParse, r1);
2645
2646 /* Record the instruction used to terminate the loop. Disable
2647 ** WHERE clause terms made redundant by the index range scan.
2648 */
2649 pLevel->op = bRev ? OP_Prev : OP_Next;
2650 pLevel->p1 = iIdxCur;
drhdd5f5a62008-12-23 13:35:23 +00002651 }else
2652
drh23d04d52008-12-23 23:56:22 +00002653#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00002654 if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drh111a6a72008-12-21 03:51:16 +00002655 /* Case 4: Two or more separately indexed terms connected by OR
2656 **
2657 ** Example:
2658 **
2659 ** CREATE TABLE t1(a,b,c,d);
2660 ** CREATE INDEX i1 ON t1(a);
2661 ** CREATE INDEX i2 ON t1(b);
2662 ** CREATE INDEX i3 ON t1(c);
2663 **
2664 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2665 **
2666 ** In the example, there are three indexed terms connected by OR.
2667 ** The top of the loop is constructed by creating a RowSet object
2668 ** and populating it. Then looping over elements of the rowset.
2669 **
2670 ** Null 1
2671 ** # fill RowSet 1 with entries where a=5 using i1
2672 ** # fill Rowset 1 with entries where b=7 using i2
2673 ** # fill Rowset 1 with entries where c=11 and d=13 i3 and t1
2674 ** A: RowSetRead 1, B, 2
2675 ** Seek i, 2
2676 **
2677 ** The bottom of the loop looks like this:
2678 **
2679 ** Goto 0, A
2680 ** B:
2681 */
drh23d04d52008-12-23 23:56:22 +00002682 int regOrRowset; /* Register holding the RowSet object */
drh111a6a72008-12-21 03:51:16 +00002683 int regNextRowid; /* Register holding next rowid */
2684 WhereTerm *pTerm; /* The complete OR-clause */
2685 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
2686 WhereTerm *pOrTerm; /* A single subterm within the OR-clause */
drhdd5f5a62008-12-23 13:35:23 +00002687 SrcList oneTab; /* Shortened table list */
drh111a6a72008-12-21 03:51:16 +00002688
2689 pTerm = pLevel->plan.u.pTerm;
2690 assert( pTerm!=0 );
2691 assert( pTerm->eOperator==WO_OR );
2692 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2693 pOrWc = &pTerm->u.pOrInfo->wc;
drh23d04d52008-12-23 23:56:22 +00002694 codeRowSetEarly = (regRowSet>=0 && pWC->nTerm==1) ?1:0;
2695
2696 if( codeRowSetEarly ){
2697 regOrRowset = regRowSet;
2698 }else{
2699 regOrRowset = sqlite3GetTempReg(pParse);
2700 sqlite3VdbeAddOp2(v, OP_Null, 0, regOrRowset);
2701 }
drhdd5f5a62008-12-23 13:35:23 +00002702 oneTab.nSrc = 1;
2703 oneTab.nAlloc = 1;
2704 oneTab.a[0] = *pTabItem;
2705 for(j=0, pOrTerm=pOrWc->a; j<pOrWc->nTerm; j++, pOrTerm++){
2706 WhereInfo *pSubWInfo;
drh29435252008-12-28 18:35:08 +00002707 if( pOrTerm->leftCursor!=iCur && pOrTerm->eOperator!=WO_AND ) continue;
drh23d04d52008-12-23 23:56:22 +00002708 pSubWInfo = sqlite3WhereBegin(pParse, &oneTab, pOrTerm->pExpr, 0,
drh6df2acd2008-12-28 16:55:25 +00002709 WHERE_FILL_ROWSET | WHERE_OMIT_OPEN | WHERE_OMIT_CLOSE,
2710 regOrRowset);
drhdd5f5a62008-12-23 13:35:23 +00002711 if( pSubWInfo ){
drhdd5f5a62008-12-23 13:35:23 +00002712 sqlite3WhereEnd(pSubWInfo);
2713 }
2714 }
drh111a6a72008-12-21 03:51:16 +00002715 sqlite3VdbeResolveLabel(v, addrCont);
drh23d04d52008-12-23 23:56:22 +00002716 if( !codeRowSetEarly ){
2717 regNextRowid = sqlite3GetTempReg(pParse);
2718 addrCont =
2719 sqlite3VdbeAddOp3(v, OP_RowSetRead, regOrRowset,addrBrk,regNextRowid);
2720 sqlite3VdbeAddOp2(v, OP_Seek, iCur, regNextRowid);
2721 sqlite3ReleaseTempReg(pParse, regNextRowid);
2722 /* sqlite3ReleaseTempReg(pParse, regOrRowset); // Preserve the RowSet */
2723 pLevel->op = OP_Goto;
2724 pLevel->p2 = addrCont;
2725 }
2726 disableTerm(pLevel, pTerm);
drhdd5f5a62008-12-23 13:35:23 +00002727 }else
drh23d04d52008-12-23 23:56:22 +00002728#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00002729
2730 {
drh111a6a72008-12-21 03:51:16 +00002731 /* Case 5: There is no usable index. We must do a complete
2732 ** scan of the entire table.
2733 */
2734 assert( omitTable==0 );
2735 assert( bRev==0 );
2736 pLevel->op = OP_Next;
2737 pLevel->p1 = iCur;
2738 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, OP_Rewind, iCur, addrBrk);
2739 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
drh23d04d52008-12-23 23:56:22 +00002740 codeRowSetEarly = 0;
drh111a6a72008-12-21 03:51:16 +00002741 }
2742 notReady &= ~getMask(pWC->pMaskSet, iCur);
2743
2744 /* Insert code to test every subexpression that can be completely
2745 ** computed using the current set of tables.
2746 */
2747 k = 0;
2748 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2749 Expr *pE;
2750 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2751 testcase( pTerm->wtFlags & TERM_CODED );
2752 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2753 if( (pTerm->prereqAll & notReady)!=0 ) continue;
2754 pE = pTerm->pExpr;
2755 assert( pE!=0 );
2756 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
2757 continue;
2758 }
2759 pParse->disableColCache += k;
2760 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2761 pParse->disableColCache -= k;
2762 k = 1;
2763 pTerm->wtFlags |= TERM_CODED;
2764 }
2765
2766 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2767 ** at least one row of the right table has matched the left table.
2768 */
2769 if( pLevel->iLeftJoin ){
2770 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2771 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2772 VdbeComment((v, "record LEFT JOIN hit"));
2773 sqlite3ExprClearColumnCache(pParse, pLevel->iTabCur);
2774 sqlite3ExprClearColumnCache(pParse, pLevel->iIdxCur);
2775 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
2776 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2777 testcase( pTerm->wtFlags & TERM_CODED );
2778 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2779 if( (pTerm->prereqAll & notReady)!=0 ) continue;
2780 assert( pTerm->pExpr );
2781 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2782 pTerm->wtFlags |= TERM_CODED;
2783 }
2784 }
drh23d04d52008-12-23 23:56:22 +00002785
2786 /*
2787 ** If it was requested to store the results in a rowset and that has
2788 ** not already been do, then do so now.
2789 */
2790 if( regRowSet>=0 && !codeRowSetEarly ){
2791 int r1 = sqlite3GetTempReg(pParse);
2792#ifndef SQLITE_OMIT_VIRTUALTABLE
2793 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
2794 sqlite3VdbeAddOp2(v, OP_VRowid, iCur, r1);
2795 }else
2796#endif
2797 {
2798 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, r1);
2799 }
2800 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2801 sqlite3ReleaseTempReg(pParse, r1);
2802 }
2803
drh111a6a72008-12-21 03:51:16 +00002804 return notReady;
2805}
2806
drh549c8b62005-09-19 13:15:23 +00002807#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00002808/*
2809** The following variable holds a text description of query plan generated
2810** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
2811** overwrites the previous. This information is used for testing and
2812** analysis only.
2813*/
2814char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
2815static int nQPlan = 0; /* Next free slow in _query_plan[] */
2816
2817#endif /* SQLITE_TEST */
2818
2819
drh9eff6162006-06-12 21:59:13 +00002820/*
2821** Free a WhereInfo structure
2822*/
drh10fe8402008-10-11 16:47:35 +00002823static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh9eff6162006-06-12 21:59:13 +00002824 if( pWInfo ){
2825 int i;
2826 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00002827 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
2828 if( pInfo ){
danielk197780442942008-12-24 11:25:39 +00002829 assert( pInfo->needToFreeIdxStr==0 || db->mallocFailed );
2830 if( pInfo->needToFreeIdxStr ){
2831 sqlite3_free(pInfo->idxStr);
2832 }
drh633e6d52008-07-28 19:34:53 +00002833 sqlite3DbFree(db, pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00002834 }
drh9eff6162006-06-12 21:59:13 +00002835 }
drh111a6a72008-12-21 03:51:16 +00002836 whereClauseClear(pWInfo->pWC);
drh633e6d52008-07-28 19:34:53 +00002837 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00002838 }
2839}
2840
drh94a11212004-09-25 13:12:14 +00002841
2842/*
drhe3184742002-06-19 14:27:05 +00002843** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00002844** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00002845** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00002846** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00002847** in order to complete the WHERE clause processing.
2848**
2849** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00002850**
2851** The basic idea is to do a nested loop, one loop for each table in
2852** the FROM clause of a select. (INSERT and UPDATE statements are the
2853** same as a SELECT with only a single table in the FROM clause.) For
2854** example, if the SQL is this:
2855**
2856** SELECT * FROM t1, t2, t3 WHERE ...;
2857**
2858** Then the code generated is conceptually like the following:
2859**
2860** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00002861** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00002862** foreach row3 in t3 do /
2863** ...
2864** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00002865** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00002866** end /
2867**
drh29dda4a2005-07-21 18:23:20 +00002868** Note that the loops might not be nested in the order in which they
2869** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00002870** use of indices. Note also that when the IN operator appears in
2871** the WHERE clause, it might result in additional nested loops for
2872** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00002873**
drhc27a1ce2002-06-14 20:58:45 +00002874** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00002875** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
2876** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00002877** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00002878**
drhe6f85e72004-12-25 01:03:13 +00002879** The code that sqlite3WhereBegin() generates leaves the cursors named
2880** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00002881** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00002882** data from the various tables of the loop.
2883**
drhc27a1ce2002-06-14 20:58:45 +00002884** If the WHERE clause is empty, the foreach loops must each scan their
2885** entire tables. Thus a three-way join is an O(N^3) operation. But if
2886** the tables have indices and there are terms in the WHERE clause that
2887** refer to those indices, a complete table scan can be avoided and the
2888** code will run much faster. Most of the work of this routine is checking
2889** to see if there are indices that can be used to speed up the loop.
2890**
2891** Terms of the WHERE clause are also used to limit which rows actually
2892** make it to the "..." in the middle of the loop. After each "foreach",
2893** terms of the WHERE clause that use only terms in that loop and outer
2894** loops are evaluated and if false a jump is made around all subsequent
2895** inner loops (or around the "..." if the test occurs within the inner-
2896** most loop)
2897**
2898** OUTER JOINS
2899**
2900** An outer join of tables t1 and t2 is conceptally coded as follows:
2901**
2902** foreach row1 in t1 do
2903** flag = 0
2904** foreach row2 in t2 do
2905** start:
2906** ...
2907** flag = 1
2908** end
drhe3184742002-06-19 14:27:05 +00002909** if flag==0 then
2910** move the row2 cursor to a null row
2911** goto start
2912** fi
drhc27a1ce2002-06-14 20:58:45 +00002913** end
2914**
drhe3184742002-06-19 14:27:05 +00002915** ORDER BY CLAUSE PROCESSING
2916**
2917** *ppOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
2918** if there is one. If there is no ORDER BY clause or if this routine
2919** is called from an UPDATE or DELETE statement, then ppOrderBy is NULL.
2920**
2921** If an index can be used so that the natural output order of the table
2922** scan is correct for the ORDER BY clause, then that index is used and
2923** *ppOrderBy is set to NULL. This is an optimization that prevents an
2924** unnecessary sort of the result set if an index appropriate for the
2925** ORDER BY clause already exists.
2926**
2927** If the where clause loops cannot be arranged to provide the correct
2928** output order, then the *ppOrderBy is unchanged.
drh75897232000-05-29 14:26:00 +00002929*/
danielk19774adee202004-05-08 08:23:19 +00002930WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00002931 Parse *pParse, /* The parser context */
2932 SrcList *pTabList, /* A list of all tables to be scanned */
2933 Expr *pWhere, /* The WHERE clause */
danielk1977a9d1ccb2008-01-05 17:39:29 +00002934 ExprList **ppOrderBy, /* An ORDER BY clause, or NULL */
drh23d04d52008-12-23 23:56:22 +00002935 u8 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
2936 int regRowSet /* Register hold RowSet if WHERE_FILL_ROWSET is set */
drh75897232000-05-29 14:26:00 +00002937){
2938 int i; /* Loop counter */
2939 WhereInfo *pWInfo; /* Will become the return value of this function */
2940 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhfe05af82005-07-21 03:14:59 +00002941 Bitmask notReady; /* Cursors that are not yet positioned */
drh111a6a72008-12-21 03:51:16 +00002942 WhereMaskSet *pMaskSet; /* The expression mask set */
drh111a6a72008-12-21 03:51:16 +00002943 WhereClause *pWC; /* Decomposition of the WHERE clause */
drh9012bcb2004-12-19 00:11:35 +00002944 struct SrcList_item *pTabItem; /* A single entry from pTabList */
2945 WhereLevel *pLevel; /* A single level in the pWInfo list */
drh29dda4a2005-07-21 18:23:20 +00002946 int iFrom; /* First unused FROM clause element */
drh111a6a72008-12-21 03:51:16 +00002947 int andFlags; /* AND-ed combination of all pWC->a[].wtFlags */
drh17435752007-08-16 04:30:38 +00002948 sqlite3 *db; /* Database connection */
danielk1977a9d1ccb2008-01-05 17:39:29 +00002949 ExprList *pOrderBy = 0;
drh75897232000-05-29 14:26:00 +00002950
drh29dda4a2005-07-21 18:23:20 +00002951 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00002952 ** bits in a Bitmask
2953 */
drh29dda4a2005-07-21 18:23:20 +00002954 if( pTabList->nSrc>BMS ){
2955 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00002956 return 0;
2957 }
2958
danielk1977a9d1ccb2008-01-05 17:39:29 +00002959 if( ppOrderBy ){
2960 pOrderBy = *ppOrderBy;
2961 }
2962
drh75897232000-05-29 14:26:00 +00002963 /* Allocate and initialize the WhereInfo structure that will become the
2964 ** return value.
2965 */
drh17435752007-08-16 04:30:38 +00002966 db = pParse->db;
2967 pWInfo = sqlite3DbMallocZero(db,
drh111a6a72008-12-21 03:51:16 +00002968 sizeof(WhereInfo)
2969 + (pTabList->nSrc-1)*sizeof(WhereLevel)
2970 + sizeof(WhereClause)
2971 + sizeof(WhereMaskSet)
2972 );
drh17435752007-08-16 04:30:38 +00002973 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00002974 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00002975 }
danielk197770b6d572006-06-19 04:49:34 +00002976 pWInfo->nLevel = pTabList->nSrc;
drh75897232000-05-29 14:26:00 +00002977 pWInfo->pParse = pParse;
2978 pWInfo->pTabList = pTabList;
danielk19774adee202004-05-08 08:23:19 +00002979 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh23d04d52008-12-23 23:56:22 +00002980 pWInfo->regRowSet = (wctrlFlags & WHERE_FILL_ROWSET) ? regRowSet : -1;
drh111a6a72008-12-21 03:51:16 +00002981 pWInfo->pWC = pWC = (WhereClause*)&pWInfo->a[pWInfo->nLevel];
drh6df2acd2008-12-28 16:55:25 +00002982 pWInfo->wctrlFlags = wctrlFlags;
drh111a6a72008-12-21 03:51:16 +00002983 pMaskSet = (WhereMaskSet*)&pWC[1];
drh08192d52002-04-30 19:20:28 +00002984
drh111a6a72008-12-21 03:51:16 +00002985 /* Split the WHERE clause into separate subexpressions where each
2986 ** subexpression is separated by an AND operator.
2987 */
2988 initMaskSet(pMaskSet);
2989 whereClauseInit(pWC, pParse, pMaskSet);
2990 sqlite3ExprCodeConstants(pParse, pWhere);
2991 whereSplit(pWC, pWhere, TK_AND);
2992
drh08192d52002-04-30 19:20:28 +00002993 /* Special case: a WHERE clause that is constant. Evaluate the
2994 ** expression and either jump over all of the code or fall thru.
2995 */
drh0a168372007-06-08 00:20:47 +00002996 if( pWhere && (pTabList->nSrc==0 || sqlite3ExprIsConstantNotJoin(pWhere)) ){
drh35573352008-01-08 23:54:25 +00002997 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, SQLITE_JUMPIFNULL);
drhdf199a22002-06-14 22:38:41 +00002998 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00002999 }
drh75897232000-05-29 14:26:00 +00003000
drh42165be2008-03-26 14:56:34 +00003001 /* Assign a bit from the bitmask to every term in the FROM clause.
3002 **
3003 ** When assigning bitmask values to FROM clause cursors, it must be
3004 ** the case that if X is the bitmask for the N-th FROM clause term then
3005 ** the bitmask for all FROM clause terms to the left of the N-th term
3006 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
3007 ** its Expr.iRightJoinTable value to find the bitmask of the right table
3008 ** of the join. Subtracting one from the right table bitmask gives a
3009 ** bitmask for all tables to the left of the join. Knowing the bitmask
3010 ** for all tables to the left of a left join is important. Ticket #3015.
3011 */
3012 for(i=0; i<pTabList->nSrc; i++){
drh111a6a72008-12-21 03:51:16 +00003013 createMask(pMaskSet, pTabList->a[i].iCursor);
drh42165be2008-03-26 14:56:34 +00003014 }
3015#ifndef NDEBUG
3016 {
3017 Bitmask toTheLeft = 0;
3018 for(i=0; i<pTabList->nSrc; i++){
drh111a6a72008-12-21 03:51:16 +00003019 Bitmask m = getMask(pMaskSet, pTabList->a[i].iCursor);
drh42165be2008-03-26 14:56:34 +00003020 assert( (m-1)==toTheLeft );
3021 toTheLeft |= m;
3022 }
3023 }
3024#endif
3025
drh29dda4a2005-07-21 18:23:20 +00003026 /* Analyze all of the subexpressions. Note that exprAnalyze() might
3027 ** add new virtual terms onto the end of the WHERE clause. We do not
3028 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00003029 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00003030 */
drh111a6a72008-12-21 03:51:16 +00003031 exprAnalyzeAll(pTabList, pWC);
drh17435752007-08-16 04:30:38 +00003032 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00003033 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00003034 }
drh75897232000-05-29 14:26:00 +00003035
drh29dda4a2005-07-21 18:23:20 +00003036 /* Chose the best index to use for each table in the FROM clause.
3037 **
drh51147ba2005-07-23 22:59:55 +00003038 ** This loop fills in the following fields:
3039 **
3040 ** pWInfo->a[].pIdx The index to use for this level of the loop.
drh165be382008-12-05 02:36:33 +00003041 ** pWInfo->a[].wsFlags WHERE_xxx flags associated with pIdx
drh51147ba2005-07-23 22:59:55 +00003042 ** pWInfo->a[].nEq The number of == and IN constraints
danielk197785574e32008-10-06 05:32:18 +00003043 ** pWInfo->a[].iFrom Which term of the FROM clause is being coded
drh51147ba2005-07-23 22:59:55 +00003044 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
3045 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
drh111a6a72008-12-21 03:51:16 +00003046 ** pWInfo->a[].pTerm When wsFlags==WO_OR, the OR-clause term
drh51147ba2005-07-23 22:59:55 +00003047 **
3048 ** This loop also figures out the nesting order of tables in the FROM
3049 ** clause.
drh75897232000-05-29 14:26:00 +00003050 */
drhfe05af82005-07-21 03:14:59 +00003051 notReady = ~(Bitmask)0;
drh9012bcb2004-12-19 00:11:35 +00003052 pTabItem = pTabList->a;
3053 pLevel = pWInfo->a;
drh943af3c2005-07-29 19:43:58 +00003054 andFlags = ~0;
drh4f0c5872007-03-26 22:05:01 +00003055 WHERETRACE(("*** Optimizer Start ***\n"));
drh29dda4a2005-07-21 18:23:20 +00003056 for(i=iFrom=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
drh111a6a72008-12-21 03:51:16 +00003057 WhereCost bestPlan; /* Most efficient plan seen so far */
drh29dda4a2005-07-21 18:23:20 +00003058 Index *pIdx; /* Index for FROM table at pTabItem */
drh29dda4a2005-07-21 18:23:20 +00003059 int j; /* For looping over FROM tables */
drh02afc862006-01-20 18:10:57 +00003060 int bestJ = 0; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00003061 Bitmask m; /* Bitmask value for j or bestJ */
drh570b9352006-02-01 02:45:02 +00003062 int once = 0; /* True when first table is seen */
drh29dda4a2005-07-21 18:23:20 +00003063
drh111a6a72008-12-21 03:51:16 +00003064 memset(&bestPlan, 0, sizeof(bestPlan));
3065 bestPlan.rCost = SQLITE_BIG_DBL;
drh29dda4a2005-07-21 18:23:20 +00003066 for(j=iFrom, pTabItem=&pTabList->a[j]; j<pTabList->nSrc; j++, pTabItem++){
drhdf26fd52006-06-06 11:45:54 +00003067 int doNotReorder; /* True if this table should not be reordered */
drh111a6a72008-12-21 03:51:16 +00003068 WhereCost sCost; /* Cost information from bestIndex() */
drhdf26fd52006-06-06 11:45:54 +00003069
drh61dfc312006-12-16 16:25:15 +00003070 doNotReorder = (pTabItem->jointype & (JT_LEFT|JT_CROSS))!=0;
drhdf26fd52006-06-06 11:45:54 +00003071 if( once && doNotReorder ) break;
drh111a6a72008-12-21 03:51:16 +00003072 m = getMask(pMaskSet, pTabItem->iCursor);
drh29dda4a2005-07-21 18:23:20 +00003073 if( (m & notReady)==0 ){
3074 if( j==iFrom ) iFrom++;
3075 continue;
3076 }
drh9eff6162006-06-12 21:59:13 +00003077 assert( pTabItem->pTab );
3078#ifndef SQLITE_OMIT_VIRTUALTABLE
drh4cbdda92006-06-14 19:00:20 +00003079 if( IsVirtual(pTabItem->pTab) ){
drh111a6a72008-12-21 03:51:16 +00003080 sqlite3_index_info *pVtabIdx; /* Current virtual index */
drh6d209d82006-06-27 01:54:26 +00003081 sqlite3_index_info **ppIdxInfo = &pWInfo->a[j].pIdxInfo;
drh111a6a72008-12-21 03:51:16 +00003082 sCost.rCost = bestVirtualIndex(pParse, pWC, pTabItem, notReady,
3083 ppOrderBy ? *ppOrderBy : 0, i==0,
3084 ppIdxInfo);
3085 sCost.plan.wsFlags = WHERE_VIRTUALTABLE;
3086 sCost.plan.u.pVtabIdx = pVtabIdx = *ppIdxInfo;
3087 if( pVtabIdx && pVtabIdx->orderByConsumed ){
3088 sCost.plan.wsFlags = WHERE_VIRTUALTABLE | WHERE_ORDERBY;
drh1a90e092006-06-14 22:07:10 +00003089 }
drh111a6a72008-12-21 03:51:16 +00003090 sCost.plan.nEq = 0;
3091 if( (SQLITE_BIG_DBL/2.0)<sCost.rCost ){
danielk19778efe5412007-03-02 08:12:22 +00003092 /* The cost is not allowed to be larger than SQLITE_BIG_DBL (the
3093 ** inital value of lowestCost in this loop. If it is, then
drh111a6a72008-12-21 03:51:16 +00003094 ** the (cost<lowestCost) test below will never be true.
danielk19778efe5412007-03-02 08:12:22 +00003095 */
drh111a6a72008-12-21 03:51:16 +00003096 sCost.rCost = (SQLITE_BIG_DBL/2.0);
danielk19778efe5412007-03-02 08:12:22 +00003097 }
drh9eff6162006-06-12 21:59:13 +00003098 }else
3099#endif
3100 {
drh111a6a72008-12-21 03:51:16 +00003101 bestIndex(pParse, pWC, pTabItem, notReady,
3102 (i==0 && ppOrderBy) ? *ppOrderBy : 0, &sCost);
drh9eff6162006-06-12 21:59:13 +00003103 }
danielk1977992347f2008-12-30 09:45:45 +00003104 if( once==0 || sCost.rCost<bestPlan.rCost ){
drh570b9352006-02-01 02:45:02 +00003105 once = 1;
drh111a6a72008-12-21 03:51:16 +00003106 bestPlan = sCost;
drh29dda4a2005-07-21 18:23:20 +00003107 bestJ = j;
3108 }
drhdf26fd52006-06-06 11:45:54 +00003109 if( doNotReorder ) break;
drh29dda4a2005-07-21 18:23:20 +00003110 }
danielk1977992347f2008-12-30 09:45:45 +00003111 assert( once );
3112 assert( notReady & getMask(pMaskSet, pTabList->a[bestJ].iCursor) );
drhcb041342008-06-12 00:07:29 +00003113 WHERETRACE(("*** Optimizer selects table %d for loop %d\n", bestJ,
drh3dec2232005-09-10 15:28:09 +00003114 pLevel-pWInfo->a));
drh111a6a72008-12-21 03:51:16 +00003115 if( (bestPlan.plan.wsFlags & WHERE_ORDERBY)!=0 ){
drhfe05af82005-07-21 03:14:59 +00003116 *ppOrderBy = 0;
drhc4a3c772001-04-04 11:48:57 +00003117 }
drh111a6a72008-12-21 03:51:16 +00003118 andFlags &= bestPlan.plan.wsFlags;
3119 pLevel->plan = bestPlan.plan;
3120 if( bestPlan.plan.wsFlags & WHERE_INDEXED ){
drh9012bcb2004-12-19 00:11:35 +00003121 pLevel->iIdxCur = pParse->nTab++;
drhfe05af82005-07-21 03:14:59 +00003122 }else{
3123 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00003124 }
drh111a6a72008-12-21 03:51:16 +00003125 notReady &= ~getMask(pMaskSet, pTabList->a[bestJ].iCursor);
drh29dda4a2005-07-21 18:23:20 +00003126 pLevel->iFrom = bestJ;
danielk197785574e32008-10-06 05:32:18 +00003127
3128 /* Check that if the table scanned by this loop iteration had an
3129 ** INDEXED BY clause attached to it, that the named index is being
3130 ** used for the scan. If not, then query compilation has failed.
3131 ** Return an error.
3132 */
3133 pIdx = pTabList->a[bestJ].pIndex;
drh111a6a72008-12-21 03:51:16 +00003134 assert( !pIdx
3135 || (bestPlan.plan.wsFlags&WHERE_INDEXED)==0
3136 || pIdx==bestPlan.plan.u.pIdx );
3137 if( pIdx
3138 && ((bestPlan.plan.wsFlags & WHERE_INDEXED)==0
3139 || bestPlan.plan.u.pIdx!=pIdx)
3140 ){
danielk197785574e32008-10-06 05:32:18 +00003141 sqlite3ErrorMsg(pParse, "cannot use index: %s", pIdx->zName);
3142 goto whereBeginError;
3143 }
drh75897232000-05-29 14:26:00 +00003144 }
drh4f0c5872007-03-26 22:05:01 +00003145 WHERETRACE(("*** Optimizer Finished ***\n"));
danielk197780442942008-12-24 11:25:39 +00003146 if( db->mallocFailed ){
3147 goto whereBeginError;
3148 }
drh75897232000-05-29 14:26:00 +00003149
drh943af3c2005-07-29 19:43:58 +00003150 /* If the total query only selects a single row, then the ORDER BY
3151 ** clause is irrelevant.
3152 */
3153 if( (andFlags & WHERE_UNIQUE)!=0 && ppOrderBy ){
3154 *ppOrderBy = 0;
3155 }
3156
drh08c88eb2008-04-10 13:33:18 +00003157 /* If the caller is an UPDATE or DELETE statement that is requesting
3158 ** to use a one-pass algorithm, determine if this is appropriate.
3159 ** The one-pass algorithm only works if the WHERE clause constraints
3160 ** the statement to update a single row.
3161 */
drh165be382008-12-05 02:36:33 +00003162 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
3163 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 && (andFlags & WHERE_UNIQUE)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00003164 pWInfo->okOnePass = 1;
drh111a6a72008-12-21 03:51:16 +00003165 pWInfo->a[0].plan.wsFlags &= ~WHERE_IDX_ONLY;
drh08c88eb2008-04-10 13:33:18 +00003166 }
3167
drh9012bcb2004-12-19 00:11:35 +00003168 /* Open all tables in the pTabList and any indices selected for
3169 ** searching those tables.
3170 */
3171 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh29dda4a2005-07-21 18:23:20 +00003172 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00003173 Table *pTab; /* Table to open */
danielk1977da184232006-01-05 11:34:32 +00003174 int iDb; /* Index of database containing table/index */
drh9012bcb2004-12-19 00:11:35 +00003175
drhecc92422005-09-10 16:46:12 +00003176#ifndef SQLITE_OMIT_EXPLAIN
3177 if( pParse->explain==2 ){
3178 char *zMsg;
3179 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
danielk19771e536952007-08-16 10:09:01 +00003180 zMsg = sqlite3MPrintf(db, "TABLE %s", pItem->zName);
drhecc92422005-09-10 16:46:12 +00003181 if( pItem->zAlias ){
drh633e6d52008-07-28 19:34:53 +00003182 zMsg = sqlite3MAppendf(db, zMsg, "%s AS %s", zMsg, pItem->zAlias);
drhecc92422005-09-10 16:46:12 +00003183 }
drh111a6a72008-12-21 03:51:16 +00003184 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3185 zMsg = sqlite3MAppendf(db, zMsg, "%s WITH INDEX %s",
3186 zMsg, pLevel->plan.u.pIdx->zName);
3187 }else if( pLevel->plan.wsFlags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh633e6d52008-07-28 19:34:53 +00003188 zMsg = sqlite3MAppendf(db, zMsg, "%s USING PRIMARY KEY", zMsg);
drhecc92422005-09-10 16:46:12 +00003189 }
drh9eff6162006-06-12 21:59:13 +00003190#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00003191 else if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
3192 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
drh633e6d52008-07-28 19:34:53 +00003193 zMsg = sqlite3MAppendf(db, zMsg, "%s VIRTUAL TABLE INDEX %d:%s", zMsg,
drh111a6a72008-12-21 03:51:16 +00003194 pVtabIdx->idxNum, pVtabIdx->idxStr);
drh9eff6162006-06-12 21:59:13 +00003195 }
3196#endif
drh111a6a72008-12-21 03:51:16 +00003197 if( pLevel->plan.wsFlags & WHERE_ORDERBY ){
drh633e6d52008-07-28 19:34:53 +00003198 zMsg = sqlite3MAppendf(db, zMsg, "%s ORDER BY", zMsg);
drhe2b39092006-04-21 09:38:36 +00003199 }
drh66a51672008-01-03 00:01:23 +00003200 sqlite3VdbeAddOp4(v, OP_Explain, i, pLevel->iFrom, 0, zMsg, P4_DYNAMIC);
drhecc92422005-09-10 16:46:12 +00003201 }
3202#endif /* SQLITE_OMIT_EXPLAIN */
drh29dda4a2005-07-21 18:23:20 +00003203 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00003204 pTab = pTabItem->pTab;
danielk1977da184232006-01-05 11:34:32 +00003205 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drh7d10d5a2008-08-20 16:35:10 +00003206 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ) continue;
drh9eff6162006-06-12 21:59:13 +00003207#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00003208 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
danielk197793626f42006-06-20 13:07:27 +00003209 int iCur = pTabItem->iCursor;
drh66a51672008-01-03 00:01:23 +00003210 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0,
3211 (const char*)pTab->pVtab, P4_VTAB);
drh9eff6162006-06-12 21:59:13 +00003212 }else
3213#endif
drh6df2acd2008-12-28 16:55:25 +00003214 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
3215 && (wctrlFlags & WHERE_OMIT_OPEN)==0 ){
drh08c88eb2008-04-10 13:33:18 +00003216 int op = pWInfo->okOnePass ? OP_OpenWrite : OP_OpenRead;
3217 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
danielk197723432972008-11-17 16:42:00 +00003218 if( !pWInfo->okOnePass && pTab->nCol<BMS ){
danielk19779792eef2006-01-13 15:58:43 +00003219 Bitmask b = pTabItem->colUsed;
3220 int n = 0;
drh74161702006-02-24 02:53:49 +00003221 for(; b; b=b>>1, n++){}
danielk1977cd3e8f72008-03-25 09:47:35 +00003222 sqlite3VdbeChangeP2(v, sqlite3VdbeCurrentAddr(v)-2, n);
danielk19779792eef2006-01-13 15:58:43 +00003223 assert( n<=pTab->nCol );
3224 }
danielk1977c00da102006-01-07 13:21:04 +00003225 }else{
3226 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00003227 }
3228 pLevel->iTabCur = pTabItem->iCursor;
drh111a6a72008-12-21 03:51:16 +00003229 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3230 Index *pIx = pLevel->plan.u.pIdx;
danielk1977b3bf5562006-01-10 17:58:23 +00003231 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
drh111a6a72008-12-21 03:51:16 +00003232 int iIdxCur = pLevel->iIdxCur;
danielk1977da184232006-01-05 11:34:32 +00003233 assert( pIx->pSchema==pTab->pSchema );
drh111a6a72008-12-21 03:51:16 +00003234 assert( iIdxCur>=0 );
danielk1977cd3e8f72008-03-25 09:47:35 +00003235 sqlite3VdbeAddOp2(v, OP_SetNumColumns, 0, pIx->nColumn+1);
danielk1977207872a2008-01-03 07:54:23 +00003236 sqlite3VdbeAddOp4(v, OP_OpenRead, iIdxCur, pIx->tnum, iDb,
drh66a51672008-01-03 00:01:23 +00003237 (char*)pKey, P4_KEYINFO_HANDOFF);
danielk1977207872a2008-01-03 07:54:23 +00003238 VdbeComment((v, "%s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00003239 }
danielk1977da184232006-01-05 11:34:32 +00003240 sqlite3CodeVerifySchema(pParse, iDb);
drh9012bcb2004-12-19 00:11:35 +00003241 }
3242 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
3243
drh29dda4a2005-07-21 18:23:20 +00003244 /* Generate the code to do the search. Each iteration of the for
3245 ** loop below generates code for a single nested loop of the VM
3246 ** program.
drh75897232000-05-29 14:26:00 +00003247 */
drhfe05af82005-07-21 03:14:59 +00003248 notReady = ~(Bitmask)0;
drh111a6a72008-12-21 03:51:16 +00003249 for(i=0; i<pTabList->nSrc; i++){
3250 notReady = codeOneLoopStart(pWInfo, i, wctrlFlags, notReady);
drh75897232000-05-29 14:26:00 +00003251 }
drh111a6a72008-12-21 03:51:16 +00003252 pWInfo->iContinue = pWInfo->a[i-1].addrCont;
drh7ec764a2005-07-21 03:48:20 +00003253
3254#ifdef SQLITE_TEST /* For testing and debugging use only */
3255 /* Record in the query plan information about the current table
3256 ** and the index used to access it (if any). If the table itself
3257 ** is not used, its name is just '{}'. If no index is used
3258 ** the index is listed as "{}". If the primary key is used the
3259 ** index name is '*'.
3260 */
3261 for(i=0; i<pTabList->nSrc; i++){
3262 char *z;
3263 int n;
drh7ec764a2005-07-21 03:48:20 +00003264 pLevel = &pWInfo->a[i];
drh29dda4a2005-07-21 18:23:20 +00003265 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00003266 z = pTabItem->zAlias;
3267 if( z==0 ) z = pTabItem->pTab->zName;
drhea678832008-12-10 19:26:22 +00003268 n = sqlite3Strlen30(z);
drh7ec764a2005-07-21 03:48:20 +00003269 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
drh111a6a72008-12-21 03:51:16 +00003270 if( pLevel->plan.wsFlags & WHERE_IDX_ONLY ){
drh5bb3eb92007-05-04 13:15:55 +00003271 memcpy(&sqlite3_query_plan[nQPlan], "{}", 2);
drh7ec764a2005-07-21 03:48:20 +00003272 nQPlan += 2;
3273 }else{
drh5bb3eb92007-05-04 13:15:55 +00003274 memcpy(&sqlite3_query_plan[nQPlan], z, n);
drh7ec764a2005-07-21 03:48:20 +00003275 nQPlan += n;
3276 }
3277 sqlite3_query_plan[nQPlan++] = ' ';
3278 }
drh111a6a72008-12-21 03:51:16 +00003279 testcase( pLevel->plan.wsFlags & WHERE_ROWID_EQ );
3280 testcase( pLevel->plan.wsFlags & WHERE_ROWID_RANGE );
3281 if( pLevel->plan.wsFlags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh5bb3eb92007-05-04 13:15:55 +00003282 memcpy(&sqlite3_query_plan[nQPlan], "* ", 2);
drh7ec764a2005-07-21 03:48:20 +00003283 nQPlan += 2;
drh111a6a72008-12-21 03:51:16 +00003284 }else if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3285 n = sqlite3Strlen30(pLevel->plan.u.pIdx->zName);
drh7ec764a2005-07-21 03:48:20 +00003286 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
drh111a6a72008-12-21 03:51:16 +00003287 memcpy(&sqlite3_query_plan[nQPlan], pLevel->plan.u.pIdx->zName, n);
drh7ec764a2005-07-21 03:48:20 +00003288 nQPlan += n;
3289 sqlite3_query_plan[nQPlan++] = ' ';
3290 }
drh111a6a72008-12-21 03:51:16 +00003291 }else{
3292 memcpy(&sqlite3_query_plan[nQPlan], "{} ", 3);
3293 nQPlan += 3;
drh7ec764a2005-07-21 03:48:20 +00003294 }
3295 }
3296 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
3297 sqlite3_query_plan[--nQPlan] = 0;
3298 }
3299 sqlite3_query_plan[nQPlan] = 0;
3300 nQPlan = 0;
3301#endif /* SQLITE_TEST // Testing and debugging use only */
3302
drh29dda4a2005-07-21 18:23:20 +00003303 /* Record the continuation address in the WhereInfo structure. Then
3304 ** clean up and return.
3305 */
drh75897232000-05-29 14:26:00 +00003306 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00003307
3308 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00003309whereBeginError:
drh10fe8402008-10-11 16:47:35 +00003310 whereInfoFree(db, pWInfo);
drhe23399f2005-07-22 00:31:39 +00003311 return 0;
drh75897232000-05-29 14:26:00 +00003312}
3313
3314/*
drhc27a1ce2002-06-14 20:58:45 +00003315** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00003316** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00003317*/
danielk19774adee202004-05-08 08:23:19 +00003318void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00003319 Parse *pParse = pWInfo->pParse;
3320 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00003321 int i;
drh6b563442001-11-07 16:48:26 +00003322 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00003323 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00003324 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00003325
drh9012bcb2004-12-19 00:11:35 +00003326 /* Generate loop termination code.
3327 */
drh633e6d52008-07-28 19:34:53 +00003328 sqlite3ExprClearColumnCache(pParse, -1);
drhad3cab52002-05-24 02:04:32 +00003329 for(i=pTabList->nSrc-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00003330 pLevel = &pWInfo->a[i];
drhb3190c12008-12-08 21:37:14 +00003331 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00003332 if( pLevel->op!=OP_Noop ){
drh66a51672008-01-03 00:01:23 +00003333 sqlite3VdbeAddOp2(v, pLevel->op, pLevel->p1, pLevel->p2);
drhd1d38482008-10-07 23:46:38 +00003334 sqlite3VdbeChangeP5(v, pLevel->p5);
drh19a775c2000-06-05 18:54:46 +00003335 }
drh111a6a72008-12-21 03:51:16 +00003336 if( pLevel->plan.wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
drh72e8fa42007-03-28 14:30:06 +00003337 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00003338 int j;
drhb3190c12008-12-08 21:37:14 +00003339 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh111a6a72008-12-21 03:51:16 +00003340 for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00003341 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
3342 sqlite3VdbeAddOp2(v, OP_Next, pIn->iCur, pIn->addrInTop);
3343 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00003344 }
drh111a6a72008-12-21 03:51:16 +00003345 sqlite3DbFree(db, pLevel->u.in.aInLoop);
drhd99f7062002-06-08 23:25:08 +00003346 }
drhb3190c12008-12-08 21:37:14 +00003347 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhad2d8302002-05-24 20:31:36 +00003348 if( pLevel->iLeftJoin ){
3349 int addr;
drh3c84ddf2008-01-09 02:15:38 +00003350 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin);
3351 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
drh9012bcb2004-12-19 00:11:35 +00003352 if( pLevel->iIdxCur>=0 ){
drh3c84ddf2008-01-09 02:15:38 +00003353 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00003354 }
drhb3190c12008-12-08 21:37:14 +00003355 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
drhd654be82005-09-20 17:42:23 +00003356 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00003357 }
drh19a775c2000-06-05 18:54:46 +00003358 }
drh9012bcb2004-12-19 00:11:35 +00003359
3360 /* The "break" point is here, just past the end of the outer loop.
3361 ** Set it.
3362 */
danielk19774adee202004-05-08 08:23:19 +00003363 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00003364
drh29dda4a2005-07-21 18:23:20 +00003365 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00003366 */
drh29dda4a2005-07-21 18:23:20 +00003367 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
3368 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00003369 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00003370 assert( pTab!=0 );
drh7d10d5a2008-08-20 16:35:10 +00003371 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ) continue;
drh6df2acd2008-12-28 16:55:25 +00003372 if( (pWInfo->wctrlFlags & WHERE_OMIT_CLOSE)==0 ){
3373 if( !pWInfo->okOnePass && (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0 ){
3374 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
3375 }
3376 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3377 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
3378 }
drh9012bcb2004-12-19 00:11:35 +00003379 }
3380
danielk197721de2e72007-11-29 17:43:27 +00003381 /* If this scan uses an index, make code substitutions to read data
3382 ** from the index in preference to the table. Sometimes, this means
3383 ** the table need never be read from. This is a performance boost,
3384 ** as the vdbe level waits until the table is read before actually
3385 ** seeking the table cursor to the record corresponding to the current
3386 ** position in the index.
drh9012bcb2004-12-19 00:11:35 +00003387 **
3388 ** Calls to the code generator in between sqlite3WhereBegin and
3389 ** sqlite3WhereEnd will have created code that references the table
3390 ** directly. This loop scans all that code looking for opcodes
3391 ** that reference the table and converts them into opcodes that
3392 ** reference the index.
3393 */
drh111a6a72008-12-21 03:51:16 +00003394 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
danielk1977f0113002006-01-24 12:09:17 +00003395 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00003396 VdbeOp *pOp;
drh111a6a72008-12-21 03:51:16 +00003397 Index *pIdx = pLevel->plan.u.pIdx;
3398 int useIndexOnly = pLevel->plan.wsFlags & WHERE_IDX_ONLY;
drh9012bcb2004-12-19 00:11:35 +00003399
3400 assert( pIdx!=0 );
3401 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
3402 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00003403 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00003404 if( pOp->p1!=pLevel->iTabCur ) continue;
3405 if( pOp->opcode==OP_Column ){
drh9012bcb2004-12-19 00:11:35 +00003406 for(j=0; j<pIdx->nColumn; j++){
3407 if( pOp->p2==pIdx->aiColumn[j] ){
3408 pOp->p2 = j;
danielk197721de2e72007-11-29 17:43:27 +00003409 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00003410 break;
3411 }
3412 }
danielk197721de2e72007-11-29 17:43:27 +00003413 assert(!useIndexOnly || j<pIdx->nColumn);
drhf0863fe2005-06-12 21:35:51 +00003414 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00003415 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00003416 pOp->opcode = OP_IdxRowid;
danielk197721de2e72007-11-29 17:43:27 +00003417 }else if( pOp->opcode==OP_NullRow && useIndexOnly ){
danielk19776c18b6e2005-01-30 09:17:58 +00003418 pOp->opcode = OP_Noop;
drh9012bcb2004-12-19 00:11:35 +00003419 }
3420 }
drh6b563442001-11-07 16:48:26 +00003421 }
drh19a775c2000-06-05 18:54:46 +00003422 }
drh9012bcb2004-12-19 00:11:35 +00003423
3424 /* Final cleanup
3425 */
drh10fe8402008-10-11 16:47:35 +00003426 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00003427 return;
3428}