blob: 769b70ac41f01409f6bbdd8c40774109f689ced7 [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**
drh954701a2008-12-29 23:45:07 +000019** $Id: where.c,v 1.350 2008/12/29 23:45:07 drh Exp $
drh75897232000-05-29 14:26:00 +000020*/
21#include "sqliteInt.h"
22
23/*
drh51147ba2005-07-23 22:59:55 +000024** Trace output macros
25*/
26#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
mlcreech3a00f902008-03-04 17:45:01 +000027int sqlite3WhereTrace = 0;
drhe8f52c52008-07-12 14:52:20 +000028#endif
drh6df2acd2008-12-28 16:55:25 +000029#if 0
mlcreech3a00f902008-03-04 17:45:01 +000030# define WHERETRACE(X) if(sqlite3WhereTrace) sqlite3DebugPrintf X
drh51147ba2005-07-23 22:59:55 +000031#else
drh4f0c5872007-03-26 22:05:01 +000032# define WHERETRACE(X)
drh51147ba2005-07-23 22:59:55 +000033#endif
34
drh0fcef5e2005-07-19 17:38:22 +000035/* Forward reference
36*/
37typedef struct WhereClause WhereClause;
drh111a6a72008-12-21 03:51:16 +000038typedef struct WhereMaskSet WhereMaskSet;
drh700a2262008-12-17 19:22:15 +000039typedef struct WhereOrInfo WhereOrInfo;
40typedef struct WhereAndInfo WhereAndInfo;
drh111a6a72008-12-21 03:51:16 +000041typedef struct WhereCost WhereCost;
drh0aa74ed2005-07-16 13:33:20 +000042
43/*
drh75897232000-05-29 14:26:00 +000044** The query generator uses an array of instances of this structure to
45** help it analyze the subexpressions of the WHERE clause. Each WHERE
drh6a1e0712008-12-05 15:24:15 +000046** clause subexpression is separated from the others by AND operators.
47** (Note: the same data structure is also reused to hold a group of terms
48** separated by OR operators. But at the top-level, everything is AND
49** separated.)
drh51669862004-12-18 18:40:26 +000050**
drh0fcef5e2005-07-19 17:38:22 +000051** All WhereTerms are collected into a single WhereClause structure.
52** The following identity holds:
drh51669862004-12-18 18:40:26 +000053**
drh0fcef5e2005-07-19 17:38:22 +000054** WhereTerm.pWC->a[WhereTerm.idx] == WhereTerm
drh51669862004-12-18 18:40:26 +000055**
drh0fcef5e2005-07-19 17:38:22 +000056** When a term is of the form:
57**
58** X <op> <expr>
59**
60** where X is a column name and <op> is one of certain operators,
drh700a2262008-12-17 19:22:15 +000061** then WhereTerm.leftCursor and WhereTerm.u.leftColumn record the
62** cursor number and column number for X. WhereTerm.eOperator records
drh51147ba2005-07-23 22:59:55 +000063** the <op> using a bitmask encoding defined by WO_xxx below. The
64** use of a bitmask encoding for the operator allows us to search
65** quickly for terms that match any of several different operators.
drh0fcef5e2005-07-19 17:38:22 +000066**
drh700a2262008-12-17 19:22:15 +000067** A WhereTerm might also be two or more subterms connected by OR:
68**
69** (t1.X <op> <expr>) OR (t1.Y <op> <expr>) OR ....
70**
71** In this second case, wtFlag as the TERM_ORINFO set and eOperator==WO_OR
72** and the WhereTerm.u.pOrInfo field points to auxiliary information that
73** is collected about the
74**
75** If a term in the WHERE clause does not match either of the two previous
76** categories, then eOperator==0. The WhereTerm.pExpr field is still set
77** to the original subexpression content and wtFlags is set up appropriately
78** but no other fields in the WhereTerm object are meaningful.
79**
80** When eOperator!=0, prereqRight and prereqAll record sets of cursor numbers,
drh111a6a72008-12-21 03:51:16 +000081** but they do so indirectly. A single WhereMaskSet structure translates
drh51669862004-12-18 18:40:26 +000082** cursor number into bits and the translated bit is stored in the prereq
83** fields. The translation is used in order to maximize the number of
84** bits that will fit in a Bitmask. The VDBE cursor numbers might be
85** spread out over the non-negative integers. For example, the cursor
drh111a6a72008-12-21 03:51:16 +000086** numbers might be 3, 8, 9, 10, 20, 23, 41, and 45. The WhereMaskSet
drh51669862004-12-18 18:40:26 +000087** translates these sparse cursor numbers into consecutive integers
88** beginning with 0 in order to make the best possible use of the available
89** bits in the Bitmask. So, in the example above, the cursor numbers
90** would be mapped into integers 0 through 7.
drh6a1e0712008-12-05 15:24:15 +000091**
92** The number of terms in a join is limited by the number of bits
93** in prereqRight and prereqAll. The default is 64 bits, hence SQLite
94** is only able to process joins with 64 or fewer tables.
drh75897232000-05-29 14:26:00 +000095*/
drh0aa74ed2005-07-16 13:33:20 +000096typedef struct WhereTerm WhereTerm;
97struct WhereTerm {
drh165be382008-12-05 02:36:33 +000098 Expr *pExpr; /* Pointer to the subexpression that is this term */
drhec1724e2008-12-09 01:32:03 +000099 int iParent; /* Disable pWC->a[iParent] when this term disabled */
100 int leftCursor; /* Cursor number of X in "X <op> <expr>" */
drh700a2262008-12-17 19:22:15 +0000101 union {
102 int leftColumn; /* Column number of X in "X <op> <expr>" */
103 WhereOrInfo *pOrInfo; /* Extra information if eOperator==WO_OR */
104 WhereAndInfo *pAndInfo; /* Extra information if eOperator==WO_AND */
105 } u;
drhb52076c2006-01-23 13:22:09 +0000106 u16 eOperator; /* A WO_xx value describing <op> */
drh165be382008-12-05 02:36:33 +0000107 u8 wtFlags; /* TERM_xxx bit flags. See below */
drh45b1ee42005-08-02 17:48:22 +0000108 u8 nChild; /* Number of children that must disable us */
drh0fcef5e2005-07-19 17:38:22 +0000109 WhereClause *pWC; /* The clause this term is part of */
drh165be382008-12-05 02:36:33 +0000110 Bitmask prereqRight; /* Bitmask of tables used by pExpr->pRight */
111 Bitmask prereqAll; /* Bitmask of tables referenced by pExpr */
drh75897232000-05-29 14:26:00 +0000112};
113
114/*
drh165be382008-12-05 02:36:33 +0000115** Allowed values of WhereTerm.wtFlags
drh0aa74ed2005-07-16 13:33:20 +0000116*/
drh633e6d52008-07-28 19:34:53 +0000117#define TERM_DYNAMIC 0x01 /* Need to call sqlite3ExprDelete(db, pExpr) */
drh6c30be82005-07-29 15:10:17 +0000118#define TERM_VIRTUAL 0x02 /* Added by the optimizer. Do not code */
119#define TERM_CODED 0x04 /* This term is already coded */
drh45b1ee42005-08-02 17:48:22 +0000120#define TERM_COPIED 0x08 /* Has a child */
drh700a2262008-12-17 19:22:15 +0000121#define TERM_ORINFO 0x10 /* Need to free the WhereTerm.u.pOrInfo object */
122#define TERM_ANDINFO 0x20 /* Need to free the WhereTerm.u.pAndInfo obj */
123#define TERM_OR_OK 0x40 /* Used during OR-clause processing */
drh0aa74ed2005-07-16 13:33:20 +0000124
125/*
126** An instance of the following structure holds all information about a
127** WHERE clause. Mostly this is a container for one or more WhereTerms.
128*/
drh0aa74ed2005-07-16 13:33:20 +0000129struct WhereClause {
drhfe05af82005-07-21 03:14:59 +0000130 Parse *pParse; /* The parser context */
drh111a6a72008-12-21 03:51:16 +0000131 WhereMaskSet *pMaskSet; /* Mapping of table cursor numbers to bitmasks */
drh29435252008-12-28 18:35:08 +0000132 u8 op; /* Split operator. TK_AND or TK_OR */
drh0aa74ed2005-07-16 13:33:20 +0000133 int nTerm; /* Number of terms */
134 int nSlot; /* Number of entries in a[] */
drh51147ba2005-07-23 22:59:55 +0000135 WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
drhec1724e2008-12-09 01:32:03 +0000136 WhereTerm aStatic[4]; /* Initial static space for a[] */
drhe23399f2005-07-22 00:31:39 +0000137};
138
139/*
drh700a2262008-12-17 19:22:15 +0000140** A WhereTerm with eOperator==WO_OR has its u.pOrInfo pointer set to
141** a dynamically allocated instance of the following structure.
142*/
143struct WhereOrInfo {
drh111a6a72008-12-21 03:51:16 +0000144 WhereClause wc; /* Decomposition into subterms */
drh1a58fe02008-12-20 02:06:13 +0000145 Bitmask indexable; /* Bitmask of all indexable tables in the clause */
drh700a2262008-12-17 19:22:15 +0000146};
147
148/*
149** A WhereTerm with eOperator==WO_AND has its u.pAndInfo pointer set to
150** a dynamically allocated instance of the following structure.
151*/
152struct WhereAndInfo {
drh29435252008-12-28 18:35:08 +0000153 WhereClause wc; /* The subexpression broken out */
drh700a2262008-12-17 19:22:15 +0000154};
155
156/*
drh6a3ea0e2003-05-02 14:32:12 +0000157** An instance of the following structure keeps track of a mapping
drh0aa74ed2005-07-16 13:33:20 +0000158** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
drh51669862004-12-18 18:40:26 +0000159**
160** The VDBE cursor numbers are small integers contained in
161** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
162** clause, the cursor numbers might not begin with 0 and they might
163** contain gaps in the numbering sequence. But we want to make maximum
164** use of the bits in our bitmasks. This structure provides a mapping
165** from the sparse cursor numbers into consecutive integers beginning
166** with 0.
167**
drh111a6a72008-12-21 03:51:16 +0000168** If WhereMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
drh51669862004-12-18 18:40:26 +0000169** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
170**
171** For example, if the WHERE clause expression used these VDBE
drh111a6a72008-12-21 03:51:16 +0000172** cursors: 4, 5, 8, 29, 57, 73. Then the WhereMaskSet structure
drh51669862004-12-18 18:40:26 +0000173** would map those cursor numbers into bits 0 through 5.
174**
175** Note that the mapping is not necessarily ordered. In the example
176** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
177** 57->5, 73->4. Or one of 719 other combinations might be used. It
178** does not really matter. What is important is that sparse cursor
179** numbers all get mapped into bit numbers that begin with 0 and contain
180** no gaps.
drh6a3ea0e2003-05-02 14:32:12 +0000181*/
drh111a6a72008-12-21 03:51:16 +0000182struct WhereMaskSet {
drh1398ad32005-01-19 23:24:50 +0000183 int n; /* Number of assigned cursor values */
danielk197723432972008-11-17 16:42:00 +0000184 int ix[BMS]; /* Cursor assigned to each bit */
drh6a3ea0e2003-05-02 14:32:12 +0000185};
186
drh111a6a72008-12-21 03:51:16 +0000187/*
188** A WhereCost object records a lookup strategy and the estimated
189** cost of pursuing that strategy.
190*/
191struct WhereCost {
192 WherePlan plan; /* The lookup strategy */
193 double rCost; /* Overall cost of pursuing this search strategy */
194 double nRow; /* Estimated number of output rows */
195};
drh0aa74ed2005-07-16 13:33:20 +0000196
drh6a3ea0e2003-05-02 14:32:12 +0000197/*
drh51147ba2005-07-23 22:59:55 +0000198** Bitmasks for the operators that indices are able to exploit. An
199** OR-ed combination of these values can be used when searching for
200** terms in the where clause.
201*/
drh165be382008-12-05 02:36:33 +0000202#define WO_IN 0x001
203#define WO_EQ 0x002
drh51147ba2005-07-23 22:59:55 +0000204#define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
205#define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
206#define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
207#define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
drh165be382008-12-05 02:36:33 +0000208#define WO_MATCH 0x040
209#define WO_ISNULL 0x080
drh700a2262008-12-17 19:22:15 +0000210#define WO_OR 0x100 /* Two or more OR-connected terms */
211#define WO_AND 0x200 /* Two or more AND-connected terms */
drh51147ba2005-07-23 22:59:55 +0000212
drhec1724e2008-12-09 01:32:03 +0000213#define WO_ALL 0xfff /* Mask of all possible WO_* values */
drh1a58fe02008-12-20 02:06:13 +0000214#define WO_SINGLE 0x0ff /* Mask of all non-compound WO_* values */
drhec1724e2008-12-09 01:32:03 +0000215
drh51147ba2005-07-23 22:59:55 +0000216/*
drh700a2262008-12-17 19:22:15 +0000217** Value for wsFlags returned by bestIndex() and stored in
218** WhereLevel.wsFlags. These flags determine which search
219** strategies are appropriate.
drhf2d315d2007-01-25 16:56:06 +0000220**
drh165be382008-12-05 02:36:33 +0000221** The least significant 12 bits is reserved as a mask for WO_ values above.
drh700a2262008-12-17 19:22:15 +0000222** The WhereLevel.wsFlags field is usually set to WO_IN|WO_EQ|WO_ISNULL.
223** But if the table is the right table of a left join, WhereLevel.wsFlags
224** is set to WO_IN|WO_EQ. The WhereLevel.wsFlags field can then be used as
drhf2d315d2007-01-25 16:56:06 +0000225** the "op" parameter to findTerm when we are resolving equality constraints.
226** ISNULL constraints will then not be used on the right table of a left
227** join. Tickets #2177 and #2189.
drh51147ba2005-07-23 22:59:55 +0000228*/
drh165be382008-12-05 02:36:33 +0000229#define WHERE_ROWID_EQ 0x00001000 /* rowid=EXPR or rowid IN (...) */
230#define WHERE_ROWID_RANGE 0x00002000 /* rowid<EXPR and/or rowid>EXPR */
231#define WHERE_COLUMN_EQ 0x00010000 /* x=EXPR or x IN (...) */
232#define WHERE_COLUMN_RANGE 0x00020000 /* x<EXPR and/or x>EXPR */
233#define WHERE_COLUMN_IN 0x00040000 /* x IN (...) */
drh111a6a72008-12-21 03:51:16 +0000234#define WHERE_INDEXED 0x00070000 /* Anything that uses an index */
235#define WHERE_IN_ABLE 0x00071000 /* Able to support an IN operator */
drh165be382008-12-05 02:36:33 +0000236#define WHERE_TOP_LIMIT 0x00100000 /* x<EXPR or x<=EXPR constraint */
237#define WHERE_BTM_LIMIT 0x00200000 /* x>EXPR or x>=EXPR constraint */
238#define WHERE_IDX_ONLY 0x00800000 /* Use index only - omit table */
239#define WHERE_ORDERBY 0x01000000 /* Output will appear in correct order */
240#define WHERE_REVERSE 0x02000000 /* Scan in reverse order */
241#define WHERE_UNIQUE 0x04000000 /* Selects no more than one row */
242#define WHERE_VIRTUALTABLE 0x08000000 /* Use virtual-table processing */
243#define WHERE_MULTI_OR 0x10000000 /* OR using multiple indices */
drh51147ba2005-07-23 22:59:55 +0000244
245/*
drh0aa74ed2005-07-16 13:33:20 +0000246** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000247*/
drh7b4fc6a2007-02-06 13:26:32 +0000248static void whereClauseInit(
249 WhereClause *pWC, /* The WhereClause to be initialized */
250 Parse *pParse, /* The parsing context */
drh111a6a72008-12-21 03:51:16 +0000251 WhereMaskSet *pMaskSet /* Mapping from table cursor numbers to bitmasks */
drh7b4fc6a2007-02-06 13:26:32 +0000252){
drhfe05af82005-07-21 03:14:59 +0000253 pWC->pParse = pParse;
drh7b4fc6a2007-02-06 13:26:32 +0000254 pWC->pMaskSet = pMaskSet;
drh0aa74ed2005-07-16 13:33:20 +0000255 pWC->nTerm = 0;
drhcad651e2007-04-20 12:22:01 +0000256 pWC->nSlot = ArraySize(pWC->aStatic);
drh0aa74ed2005-07-16 13:33:20 +0000257 pWC->a = pWC->aStatic;
258}
259
drh700a2262008-12-17 19:22:15 +0000260/* Forward reference */
261static void whereClauseClear(WhereClause*);
262
263/*
264** Deallocate all memory associated with a WhereOrInfo object.
265*/
266static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
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;
drh165be382008-12-05 02:36:33 +0000525 }else if( op==TK_OR ){
526 c = WO_OR;
drhfe05af82005-07-21 03:14:59 +0000527 }else{
drhec1724e2008-12-09 01:32:03 +0000528 assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
529 c = (u16)(WO_EQ<<(op-TK_EQ));
drhfe05af82005-07-21 03:14:59 +0000530 }
drh50b39962006-10-28 00:28:09 +0000531 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh165be382008-12-05 02:36:33 +0000532 assert( op!=TK_OR || c==WO_OR );
drh51147ba2005-07-23 22:59:55 +0000533 assert( op!=TK_IN || c==WO_IN );
534 assert( op!=TK_EQ || c==WO_EQ );
535 assert( op!=TK_LT || c==WO_LT );
536 assert( op!=TK_LE || c==WO_LE );
537 assert( op!=TK_GT || c==WO_GT );
538 assert( op!=TK_GE || c==WO_GE );
539 return c;
drhfe05af82005-07-21 03:14:59 +0000540}
541
542/*
543** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
544** where X is a reference to the iColumn of table iCur and <op> is one of
545** the WO_xx operator codes specified by the op parameter.
546** Return a pointer to the term. Return 0 if not found.
547*/
548static WhereTerm *findTerm(
549 WhereClause *pWC, /* The WHERE clause to be searched */
550 int iCur, /* Cursor number of LHS */
551 int iColumn, /* Column number of LHS */
552 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000553 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000554 Index *pIdx /* Must be compatible with this index, if not NULL */
555){
556 WhereTerm *pTerm;
557 int k;
drh22c24032008-07-09 13:28:53 +0000558 assert( iCur>=0 );
drhec1724e2008-12-09 01:32:03 +0000559 op &= WO_ALL;
drhfe05af82005-07-21 03:14:59 +0000560 for(pTerm=pWC->a, k=pWC->nTerm; k; k--, pTerm++){
561 if( pTerm->leftCursor==iCur
562 && (pTerm->prereqRight & notReady)==0
drh700a2262008-12-17 19:22:15 +0000563 && pTerm->u.leftColumn==iColumn
drhb52076c2006-01-23 13:22:09 +0000564 && (pTerm->eOperator & op)!=0
drhfe05af82005-07-21 03:14:59 +0000565 ){
drh22c24032008-07-09 13:28:53 +0000566 if( pIdx && pTerm->eOperator!=WO_ISNULL ){
drhfe05af82005-07-21 03:14:59 +0000567 Expr *pX = pTerm->pExpr;
568 CollSeq *pColl;
569 char idxaff;
danielk1977f0113002006-01-24 12:09:17 +0000570 int j;
drhfe05af82005-07-21 03:14:59 +0000571 Parse *pParse = pWC->pParse;
572
573 idxaff = pIdx->pTable->aCol[iColumn].affinity;
574 if( !sqlite3IndexAffinityOk(pX, idxaff) ) continue;
danielk1977bcbb04e2007-05-29 12:11:29 +0000575
576 /* Figure out the collation sequence required from an index for
577 ** it to be useful for optimising expression pX. Store this
578 ** value in variable pColl.
579 */
580 assert(pX->pLeft);
581 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
drhfe05af82005-07-21 03:14:59 +0000582 if( !pColl ){
danielk1977bcbb04e2007-05-29 12:11:29 +0000583 pColl = pParse->db->pDfltColl;
drhfe05af82005-07-21 03:14:59 +0000584 }
danielk1977bcbb04e2007-05-29 12:11:29 +0000585
drh22c24032008-07-09 13:28:53 +0000586 for(j=0; pIdx->aiColumn[j]!=iColumn; j++){
drh34004ce2008-07-11 16:15:17 +0000587 if( NEVER(j>=pIdx->nColumn) ) return 0;
drh22c24032008-07-09 13:28:53 +0000588 }
danielk1977f0113002006-01-24 12:09:17 +0000589 if( sqlite3StrICmp(pColl->zName, pIdx->azColl[j]) ) continue;
drhfe05af82005-07-21 03:14:59 +0000590 }
591 return pTerm;
592 }
593 }
594 return 0;
595}
596
drh6c30be82005-07-29 15:10:17 +0000597/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000598static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000599
600/*
601** Call exprAnalyze on all terms in a WHERE clause.
602**
603**
604*/
605static void exprAnalyzeAll(
606 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000607 WhereClause *pWC /* the WHERE clause to be analyzed */
608){
drh6c30be82005-07-29 15:10:17 +0000609 int i;
drh9eb20282005-08-24 03:52:18 +0000610 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000611 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000612 }
613}
614
drhd2687b72005-08-12 22:56:09 +0000615#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
616/*
617** Check to see if the given expression is a LIKE or GLOB operator that
618** can be optimized using inequality constraints. Return TRUE if it is
619** so and false if not.
620**
621** In order for the operator to be optimizible, the RHS must be a string
622** literal that does not begin with a wildcard.
623*/
624static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000625 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000626 Expr *pExpr, /* Test this expression */
627 int *pnPattern, /* Number of non-wildcard prefix characters */
drh9f504ea2008-02-23 21:55:39 +0000628 int *pisComplete, /* True if the only wildcard is % in the last character */
629 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000630){
631 const char *z;
632 Expr *pRight, *pLeft;
drh55ef4d92005-08-14 01:20:37 +0000633 ExprList *pList;
drhd2687b72005-08-12 22:56:09 +0000634 int c, cnt;
drh55ef4d92005-08-14 01:20:37 +0000635 char wc[3];
drhd64fe2f2005-08-28 17:00:23 +0000636 CollSeq *pColl;
drh7d10d5a2008-08-20 16:35:10 +0000637 sqlite3 *db = pParse->db;
drhd64fe2f2005-08-28 17:00:23 +0000638
drh9f504ea2008-02-23 21:55:39 +0000639 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000640 return 0;
641 }
drh9f504ea2008-02-23 21:55:39 +0000642#ifdef SQLITE_EBCDIC
643 if( *pnoCase ) return 0;
644#endif
drh55ef4d92005-08-14 01:20:37 +0000645 pList = pExpr->pList;
646 pRight = pList->a[0].pExpr;
drh678ccce2008-03-31 18:19:54 +0000647 if( pRight->op!=TK_STRING
648 && (pRight->op!=TK_REGISTER || pRight->iColumn!=TK_STRING) ){
drhd2687b72005-08-12 22:56:09 +0000649 return 0;
650 }
drh55ef4d92005-08-14 01:20:37 +0000651 pLeft = pList->a[1].pExpr;
drhd2687b72005-08-12 22:56:09 +0000652 if( pLeft->op!=TK_COLUMN ){
653 return 0;
654 }
drh7d10d5a2008-08-20 16:35:10 +0000655 pColl = sqlite3ExprCollSeq(pParse, pLeft);
drh01495b92008-01-23 12:52:40 +0000656 assert( pColl!=0 || pLeft->iColumn==-1 );
drhd64fe2f2005-08-28 17:00:23 +0000657 if( pColl==0 ){
drh01495b92008-01-23 12:52:40 +0000658 /* No collation is defined for the ROWID. Use the default. */
drhd64fe2f2005-08-28 17:00:23 +0000659 pColl = db->pDfltColl;
660 }
drh9f504ea2008-02-23 21:55:39 +0000661 if( (pColl->type!=SQLITE_COLL_BINARY || *pnoCase) &&
662 (pColl->type!=SQLITE_COLL_NOCASE || !*pnoCase) ){
drhd64fe2f2005-08-28 17:00:23 +0000663 return 0;
664 }
drh17435752007-08-16 04:30:38 +0000665 sqlite3DequoteExpr(db, pRight);
danielk197700fd9572005-12-07 06:27:43 +0000666 z = (char *)pRight->token.z;
drhf998b732007-11-26 13:36:00 +0000667 cnt = 0;
668 if( z ){
669 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){ cnt++; }
670 }
drhd2687b72005-08-12 22:56:09 +0000671 if( cnt==0 || 255==(u8)z[cnt] ){
672 return 0;
673 }
drh55ef4d92005-08-14 01:20:37 +0000674 *pisComplete = z[cnt]==wc[0] && z[cnt+1]==0;
drhd2687b72005-08-12 22:56:09 +0000675 *pnPattern = cnt;
676 return 1;
677}
678#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
679
drhedb193b2006-06-27 13:20:21 +0000680
681#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000682/*
drh7f375902006-06-13 17:38:59 +0000683** Check to see if the given expression is of the form
684**
685** column MATCH expr
686**
687** If it is then return TRUE. If not, return FALSE.
688*/
689static int isMatchOfColumn(
690 Expr *pExpr /* Test this expression */
691){
692 ExprList *pList;
693
694 if( pExpr->op!=TK_FUNCTION ){
695 return 0;
696 }
drhedb193b2006-06-27 13:20:21 +0000697 if( pExpr->token.n!=5 ||
698 sqlite3StrNICmp((const char*)pExpr->token.z,"match",5)!=0 ){
drh7f375902006-06-13 17:38:59 +0000699 return 0;
700 }
701 pList = pExpr->pList;
702 if( pList->nExpr!=2 ){
703 return 0;
704 }
705 if( pList->a[1].pExpr->op != TK_COLUMN ){
706 return 0;
707 }
708 return 1;
709}
drhedb193b2006-06-27 13:20:21 +0000710#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000711
712/*
drh54a167d2005-11-26 14:08:07 +0000713** If the pBase expression originated in the ON or USING clause of
714** a join, then transfer the appropriate markings over to derived.
715*/
716static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
717 pDerived->flags |= pBase->flags & EP_FromJoin;
718 pDerived->iRightJoinTable = pBase->iRightJoinTable;
719}
720
drh3e355802007-02-23 23:13:33 +0000721#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
722/*
drh1a58fe02008-12-20 02:06:13 +0000723** Analyze a term that consists of two or more OR-connected
724** subterms. So in:
drh3e355802007-02-23 23:13:33 +0000725**
drh1a58fe02008-12-20 02:06:13 +0000726** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
727** ^^^^^^^^^^^^^^^^^^^^
drh3e355802007-02-23 23:13:33 +0000728**
drh1a58fe02008-12-20 02:06:13 +0000729** This routine analyzes terms such as the middle term in the above example.
730** A WhereOrTerm object is computed and attached to the term under
731** analysis, regardless of the outcome of the analysis. Hence:
drh3e355802007-02-23 23:13:33 +0000732**
drh1a58fe02008-12-20 02:06:13 +0000733** WhereTerm.wtFlags |= TERM_ORINFO
734** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
drh3e355802007-02-23 23:13:33 +0000735**
drh1a58fe02008-12-20 02:06:13 +0000736** The term being analyzed must have two or more of OR-connected subterms.
danielk1977fdc40192008-12-29 18:33:32 +0000737** A single subterm might be a set of AND-connected sub-subterms.
drh1a58fe02008-12-20 02:06:13 +0000738** Examples of terms under analysis:
drh3e355802007-02-23 23:13:33 +0000739**
drh1a58fe02008-12-20 02:06:13 +0000740** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
741** (B) x=expr1 OR expr2=x OR x=expr3
742** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
743** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
744** (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 +0000745**
drh1a58fe02008-12-20 02:06:13 +0000746** CASE 1:
747**
748** If all subterms are of the form T.C=expr for some single column of C
749** a single table T (as shown in example B above) then create a new virtual
750** term that is an equivalent IN expression. In other words, if the term
751** being analyzed is:
752**
753** x = expr1 OR expr2 = x OR x = expr3
754**
755** then create a new virtual term like this:
756**
757** x IN (expr1,expr2,expr3)
758**
759** CASE 2:
760**
761** If all subterms are indexable by a single table T, then set
762**
763** WhereTerm.eOperator = WO_OR
764** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
765**
766** A subterm is "indexable" if it is of the form
767** "T.C <op> <expr>" where C is any column of table T and
768** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
769** A subterm is also indexable if it is an AND of two or more
770** subsubterms at least one of which is indexable. Indexable AND
771** subterms have their eOperator set to WO_AND and they have
772** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
773**
774** From another point of view, "indexable" means that the subterm could
775** potentially be used with an index if an appropriate index exists.
776** This analysis does not consider whether or not the index exists; that
777** is something the bestIndex() routine will determine. This analysis
778** only looks at whether subterms appropriate for indexing exist.
779**
780** All examples A through E above all satisfy case 2. But if a term
781** also statisfies case 1 (such as B) we know that the optimizer will
782** always prefer case 1, so in that case we pretend that case 2 is not
783** satisfied.
784**
785** It might be the case that multiple tables are indexable. For example,
786** (E) above is indexable on tables P, Q, and R.
787**
788** Terms that satisfy case 2 are candidates for lookup by using
789** separate indices to find rowids for each subterm and composing
790** the union of all rowids using a RowSet object. This is similar
791** to "bitmap indices" in other database engines.
792**
793** OTHERWISE:
794**
795** If neither case 1 nor case 2 apply, then leave the eOperator set to
796** zero. This term is not useful for search.
drh3e355802007-02-23 23:13:33 +0000797*/
drh1a58fe02008-12-20 02:06:13 +0000798static void exprAnalyzeOrTerm(
799 SrcList *pSrc, /* the FROM clause */
800 WhereClause *pWC, /* the complete WHERE clause */
801 int idxTerm /* Index of the OR-term to be analyzed */
802){
803 Parse *pParse = pWC->pParse; /* Parser context */
804 sqlite3 *db = pParse->db; /* Database connection */
805 WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
806 Expr *pExpr = pTerm->pExpr; /* The expression of the term */
drh111a6a72008-12-21 03:51:16 +0000807 WhereMaskSet *pMaskSet = pWC->pMaskSet; /* Table use masks */
drh1a58fe02008-12-20 02:06:13 +0000808 int i; /* Loop counters */
809 WhereClause *pOrWc; /* Breakup of pTerm into subterms */
810 WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
811 WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
812 Bitmask chngToIN; /* Tables that might satisfy case 1 */
813 Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
drh3e355802007-02-23 23:13:33 +0000814
drh1a58fe02008-12-20 02:06:13 +0000815 /*
816 ** Break the OR clause into its separate subterms. The subterms are
817 ** stored in a WhereClause structure containing within the WhereOrInfo
818 ** object that is attached to the original OR clause term.
819 */
820 assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
821 assert( pExpr->op==TK_OR );
drh954701a2008-12-29 23:45:07 +0000822 pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
drh1a58fe02008-12-20 02:06:13 +0000823 if( pOrInfo==0 ) return;
824 pTerm->wtFlags |= TERM_ORINFO;
825 pOrWc = &pOrInfo->wc;
826 whereClauseInit(pOrWc, pWC->pParse, pMaskSet);
827 whereSplit(pOrWc, pExpr, TK_OR);
828 exprAnalyzeAll(pSrc, pOrWc);
829 if( db->mallocFailed ) return;
830 assert( pOrWc->nTerm>=2 );
831
832 /*
833 ** Compute the set of tables that might satisfy cases 1 or 2.
834 */
835 indexable = chngToIN = ~(Bitmask)0;
836 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
837 if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
drh29435252008-12-28 18:35:08 +0000838 WhereAndInfo *pAndInfo;
839 assert( pOrTerm->eOperator==0 );
840 assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
drh1a58fe02008-12-20 02:06:13 +0000841 chngToIN = 0;
drh29435252008-12-28 18:35:08 +0000842 pAndInfo = sqlite3DbMallocRaw(db, sizeof(*pAndInfo));
843 if( pAndInfo ){
844 WhereClause *pAndWC;
845 WhereTerm *pAndTerm;
846 int j;
847 Bitmask b = 0;
848 pOrTerm->u.pAndInfo = pAndInfo;
849 pOrTerm->wtFlags |= TERM_ANDINFO;
850 pOrTerm->eOperator = WO_AND;
851 pAndWC = &pAndInfo->wc;
852 whereClauseInit(pAndWC, pWC->pParse, pMaskSet);
853 whereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
854 exprAnalyzeAll(pSrc, pAndWC);
855 for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
856 if( pAndTerm->pExpr && allowedOp(pAndTerm->pExpr->op) ){
857 b |= getMask(pMaskSet, pAndTerm->leftCursor);
858 }
859 }
860 indexable &= b;
861 }
drh1a58fe02008-12-20 02:06:13 +0000862 }else if( pOrTerm->wtFlags & TERM_COPIED ){
863 /* Skip this term for now. We revisit it when we process the
864 ** corresponding TERM_VIRTUAL term */
865 }else{
866 Bitmask b;
867 b = getMask(pMaskSet, pOrTerm->leftCursor);
868 if( pOrTerm->wtFlags & TERM_VIRTUAL ){
869 WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
870 b |= getMask(pMaskSet, pOther->leftCursor);
871 }
872 indexable &= b;
873 if( pOrTerm->eOperator!=WO_EQ ){
874 chngToIN = 0;
875 }else{
876 chngToIN &= b;
877 }
878 }
drh3e355802007-02-23 23:13:33 +0000879 }
drh1a58fe02008-12-20 02:06:13 +0000880
881 /*
882 ** Record the set of tables that satisfy case 2. The set might be
drh111a6a72008-12-21 03:51:16 +0000883 ** empty.
drh1a58fe02008-12-20 02:06:13 +0000884 */
885 pOrInfo->indexable = indexable;
drh111a6a72008-12-21 03:51:16 +0000886 pTerm->eOperator = indexable==0 ? 0 : WO_OR;
drh1a58fe02008-12-20 02:06:13 +0000887
888 /*
889 ** chngToIN holds a set of tables that *might* satisfy case 1. But
890 ** we have to do some additional checking to see if case 1 really
891 ** is satisfied.
892 */
893 if( chngToIN ){
894 int okToChngToIN = 0; /* True if the conversion to IN is valid */
895 int iColumn = -1; /* Column index on lhs of IN operator */
896 int iCursor; /* Table cursor common to all terms */
897 int j = 0; /* Loop counter */
898
899 /* Search for a table and column that appears on one side or the
900 ** other of the == operator in every subterm. That table and column
901 ** will be recorded in iCursor and iColumn. There might not be any
902 ** such table and column. Set okToChngToIN if an appropriate table
903 ** and column is found but leave okToChngToIN false if not found.
904 */
905 for(j=0; j<2 && !okToChngToIN; j++){
906 pOrTerm = pOrWc->a;
907 for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
908 assert( pOrTerm->eOperator==WO_EQ );
909 pOrTerm->wtFlags &= ~TERM_OR_OK;
910 if( pOrTerm->leftCursor==iColumn ) continue;
911 if( (chngToIN & getMask(pMaskSet, pOrTerm->leftCursor))==0 ) continue;
912 iColumn = pOrTerm->u.leftColumn;
913 iCursor = pOrTerm->leftCursor;
914 break;
915 }
916 if( i<0 ){
917 assert( j==1 );
918 assert( (chngToIN&(chngToIN-1))==0 );
919 assert( chngToIN==getMask(pMaskSet, iColumn) );
920 break;
921 }
922 okToChngToIN = 1;
923 for(; i>=0 && okToChngToIN; i--, pOrTerm++){
924 assert( pOrTerm->eOperator==WO_EQ );
925 if( pOrTerm->leftCursor!=iCursor ){
926 pOrTerm->wtFlags &= ~TERM_OR_OK;
927 }else if( pOrTerm->u.leftColumn!=iColumn ){
928 okToChngToIN = 0;
929 }else{
930 int affLeft, affRight;
931 /* If the right-hand side is also a column, then the affinities
932 ** of both right and left sides must be such that no type
933 ** conversions are required on the right. (Ticket #2249)
934 */
935 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
936 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
937 if( affRight!=0 && affRight!=affLeft ){
938 okToChngToIN = 0;
939 }else{
940 pOrTerm->wtFlags |= TERM_OR_OK;
941 }
942 }
943 }
944 }
945
946 /* At this point, okToChngToIN is true if original pTerm satisfies
947 ** case 1. In that case, construct a new virtual term that is
948 ** pTerm converted into an IN operator.
949 */
950 if( okToChngToIN ){
951 Expr *pDup; /* A transient duplicate expression */
952 ExprList *pList = 0; /* The RHS of the IN operator */
953 Expr *pLeft = 0; /* The LHS of the IN operator */
954 Expr *pNew; /* The complete IN operator */
955
956 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
957 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
958 assert( pOrTerm->eOperator==WO_EQ );
959 assert( pOrTerm->leftCursor==iCursor );
960 assert( pOrTerm->u.leftColumn==iColumn );
961 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight);
962 pList = sqlite3ExprListAppend(pWC->pParse, pList, pDup, 0);
963 pLeft = pOrTerm->pExpr->pLeft;
964 }
965 assert( pLeft!=0 );
966 pDup = sqlite3ExprDup(db, pLeft);
967 pNew = sqlite3Expr(db, TK_IN, pDup, 0, 0);
968 if( pNew ){
969 int idxNew;
970 transferJoinMarkings(pNew, pExpr);
971 pNew->pList = pList;
972 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
973 testcase( idxNew==0 );
974 exprAnalyze(pSrc, pWC, idxNew);
975 pTerm = &pWC->a[idxTerm];
976 pWC->a[idxNew].iParent = idxTerm;
977 pTerm->nChild = 1;
978 }else{
979 sqlite3ExprListDelete(db, pList);
980 }
981 pTerm->eOperator = 0; /* case 1 trumps case 2 */
982 }
drh3e355802007-02-23 23:13:33 +0000983 }
drh3e355802007-02-23 23:13:33 +0000984}
985#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +0000986
drh1a58fe02008-12-20 02:06:13 +0000987
drh54a167d2005-11-26 14:08:07 +0000988/*
drh0aa74ed2005-07-16 13:33:20 +0000989** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +0000990** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +0000991** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +0000992** structure.
drh51147ba2005-07-23 22:59:55 +0000993**
994** If the expression is of the form "<expr> <op> X" it gets commuted
drh1a58fe02008-12-20 02:06:13 +0000995** to the standard form of "X <op> <expr>".
996**
997** If the expression is of the form "X <op> Y" where both X and Y are
998** columns, then the original expression is unchanged and a new virtual
999** term of the form "Y <op> X" is added to the WHERE clause and
1000** analyzed separately. The original term is marked with TERM_COPIED
1001** and the new term is marked with TERM_DYNAMIC (because it's pExpr
1002** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
1003** is a commuted copy of a prior term.) The original term has nChild=1
1004** and the copy has idxParent set to the index of the original term.
drh75897232000-05-29 14:26:00 +00001005*/
drh0fcef5e2005-07-19 17:38:22 +00001006static void exprAnalyze(
1007 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +00001008 WhereClause *pWC, /* the WHERE clause */
1009 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +00001010){
drh1a58fe02008-12-20 02:06:13 +00001011 WhereTerm *pTerm; /* The term to be analyzed */
drh111a6a72008-12-21 03:51:16 +00001012 WhereMaskSet *pMaskSet; /* Set of table index masks */
drh1a58fe02008-12-20 02:06:13 +00001013 Expr *pExpr; /* The expression to be analyzed */
1014 Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
1015 Bitmask prereqAll; /* Prerequesites of pExpr */
drhdafc0ce2008-04-17 19:14:02 +00001016 Bitmask extraRight = 0;
drhd2687b72005-08-12 22:56:09 +00001017 int nPattern;
1018 int isComplete;
drh9f504ea2008-02-23 21:55:39 +00001019 int noCase;
drh1a58fe02008-12-20 02:06:13 +00001020 int op; /* Top-level operator. pExpr->op */
1021 Parse *pParse = pWC->pParse; /* Parsing context */
1022 sqlite3 *db = pParse->db; /* Database connection */
drh0fcef5e2005-07-19 17:38:22 +00001023
drhf998b732007-11-26 13:36:00 +00001024 if( db->mallocFailed ){
1025 return;
1026 }
1027 pTerm = &pWC->a[idxTerm];
1028 pMaskSet = pWC->pMaskSet;
1029 pExpr = pTerm->pExpr;
drh0fcef5e2005-07-19 17:38:22 +00001030 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +00001031 op = pExpr->op;
1032 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +00001033 assert( pExpr->pRight==0 );
1034 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->pList)
1035 | exprSelectTableUsage(pMaskSet, pExpr->pSelect);
drh50b39962006-10-28 00:28:09 +00001036 }else if( op==TK_ISNULL ){
1037 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +00001038 }else{
1039 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
1040 }
drh22d6a532005-09-19 21:05:48 +00001041 prereqAll = exprTableUsage(pMaskSet, pExpr);
1042 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +00001043 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
1044 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +00001045 extraRight = x-1; /* ON clause terms may not be used with an index
1046 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +00001047 }
1048 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +00001049 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +00001050 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +00001051 pTerm->eOperator = 0;
drh50b39962006-10-28 00:28:09 +00001052 if( allowedOp(op) && (pTerm->prereqRight & prereqLeft)==0 ){
drh0fcef5e2005-07-19 17:38:22 +00001053 Expr *pLeft = pExpr->pLeft;
1054 Expr *pRight = pExpr->pRight;
1055 if( pLeft->op==TK_COLUMN ){
1056 pTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001057 pTerm->u.leftColumn = pLeft->iColumn;
drh50b39962006-10-28 00:28:09 +00001058 pTerm->eOperator = operatorMask(op);
drh75897232000-05-29 14:26:00 +00001059 }
drh0fcef5e2005-07-19 17:38:22 +00001060 if( pRight && pRight->op==TK_COLUMN ){
1061 WhereTerm *pNew;
1062 Expr *pDup;
1063 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +00001064 int idxNew;
drh17435752007-08-16 04:30:38 +00001065 pDup = sqlite3ExprDup(db, pExpr);
1066 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +00001067 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +00001068 return;
1069 }
drh9eb20282005-08-24 03:52:18 +00001070 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
1071 if( idxNew==0 ) return;
1072 pNew = &pWC->a[idxNew];
1073 pNew->iParent = idxTerm;
1074 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +00001075 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001076 pTerm->wtFlags |= TERM_COPIED;
drh0fcef5e2005-07-19 17:38:22 +00001077 }else{
1078 pDup = pExpr;
1079 pNew = pTerm;
1080 }
drh7d10d5a2008-08-20 16:35:10 +00001081 exprCommute(pParse, pDup);
drh0fcef5e2005-07-19 17:38:22 +00001082 pLeft = pDup->pLeft;
1083 pNew->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001084 pNew->u.leftColumn = pLeft->iColumn;
drh0fcef5e2005-07-19 17:38:22 +00001085 pNew->prereqRight = prereqLeft;
1086 pNew->prereqAll = prereqAll;
drhb52076c2006-01-23 13:22:09 +00001087 pNew->eOperator = operatorMask(pDup->op);
drh75897232000-05-29 14:26:00 +00001088 }
1089 }
drhed378002005-07-28 23:12:08 +00001090
drhd2687b72005-08-12 22:56:09 +00001091#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +00001092 /* If a term is the BETWEEN operator, create two new virtual terms
drh1a58fe02008-12-20 02:06:13 +00001093 ** that define the range that the BETWEEN implements. For example:
1094 **
1095 ** a BETWEEN b AND c
1096 **
1097 ** is converted into:
1098 **
1099 ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
1100 **
1101 ** The two new terms are added onto the end of the WhereClause object.
1102 ** The new terms are "dynamic" and are children of the original BETWEEN
1103 ** term. That means that if the BETWEEN term is coded, the children are
1104 ** skipped. Or, if the children are satisfied by an index, the original
1105 ** BETWEEN term is skipped.
drhed378002005-07-28 23:12:08 +00001106 */
drh29435252008-12-28 18:35:08 +00001107 else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
drhed378002005-07-28 23:12:08 +00001108 ExprList *pList = pExpr->pList;
1109 int i;
1110 static const u8 ops[] = {TK_GE, TK_LE};
1111 assert( pList!=0 );
1112 assert( pList->nExpr==2 );
1113 for(i=0; i<2; i++){
1114 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +00001115 int idxNew;
danielk1977a1644fd2007-08-29 12:31:25 +00001116 pNewExpr = sqlite3Expr(db, ops[i], sqlite3ExprDup(db, pExpr->pLeft),
drh17435752007-08-16 04:30:38 +00001117 sqlite3ExprDup(db, pList->a[i].pExpr), 0);
drh9eb20282005-08-24 03:52:18 +00001118 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001119 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001120 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +00001121 pTerm = &pWC->a[idxTerm];
1122 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +00001123 }
drh45b1ee42005-08-02 17:48:22 +00001124 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +00001125 }
drhd2687b72005-08-12 22:56:09 +00001126#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +00001127
danielk19771576cd92006-01-14 08:02:28 +00001128#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh1a58fe02008-12-20 02:06:13 +00001129 /* Analyze a term that is composed of two or more subterms connected by
1130 ** an OR operator.
drh6c30be82005-07-29 15:10:17 +00001131 */
1132 else if( pExpr->op==TK_OR ){
drh29435252008-12-28 18:35:08 +00001133 assert( pWC->op==TK_AND );
drh1a58fe02008-12-20 02:06:13 +00001134 exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
drh6c30be82005-07-29 15:10:17 +00001135 }
drhd2687b72005-08-12 22:56:09 +00001136#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1137
1138#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
1139 /* Add constraints to reduce the search space on a LIKE or GLOB
1140 ** operator.
drh9f504ea2008-02-23 21:55:39 +00001141 **
1142 ** A like pattern of the form "x LIKE 'abc%'" is changed into constraints
1143 **
1144 ** x>='abc' AND x<'abd' AND x LIKE 'abc%'
1145 **
1146 ** The last character of the prefix "abc" is incremented to form the
shane7bc71e52008-05-28 18:01:44 +00001147 ** termination condition "abd".
drhd2687b72005-08-12 22:56:09 +00001148 */
drh29435252008-12-28 18:35:08 +00001149 if( isLikeOrGlob(pParse, pExpr, &nPattern, &isComplete, &noCase)
1150 && pWC->op==TK_AND ){
drhd2687b72005-08-12 22:56:09 +00001151 Expr *pLeft, *pRight;
1152 Expr *pStr1, *pStr2;
1153 Expr *pNewExpr1, *pNewExpr2;
drh9eb20282005-08-24 03:52:18 +00001154 int idxNew1, idxNew2;
1155
drhd2687b72005-08-12 22:56:09 +00001156 pLeft = pExpr->pList->a[1].pExpr;
1157 pRight = pExpr->pList->a[0].pExpr;
drh17435752007-08-16 04:30:38 +00001158 pStr1 = sqlite3PExpr(pParse, TK_STRING, 0, 0, 0);
drhd2687b72005-08-12 22:56:09 +00001159 if( pStr1 ){
drh17435752007-08-16 04:30:38 +00001160 sqlite3TokenCopy(db, &pStr1->token, &pRight->token);
drhd2687b72005-08-12 22:56:09 +00001161 pStr1->token.n = nPattern;
drh9c86df52007-06-11 12:56:15 +00001162 pStr1->flags = EP_Dequoted;
drhd2687b72005-08-12 22:56:09 +00001163 }
drh17435752007-08-16 04:30:38 +00001164 pStr2 = sqlite3ExprDup(db, pStr1);
drhf998b732007-11-26 13:36:00 +00001165 if( !db->mallocFailed ){
drh9f504ea2008-02-23 21:55:39 +00001166 u8 c, *pC;
drhd2687b72005-08-12 22:56:09 +00001167 assert( pStr2->token.dyn );
drh9f504ea2008-02-23 21:55:39 +00001168 pC = (u8*)&pStr2->token.z[nPattern-1];
1169 c = *pC;
drh02a50b72008-05-26 18:33:40 +00001170 if( noCase ){
1171 if( c=='@' ) isComplete = 0;
1172 c = sqlite3UpperToLower[c];
1173 }
drh9f504ea2008-02-23 21:55:39 +00001174 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +00001175 }
drh17435752007-08-16 04:30:38 +00001176 pNewExpr1 = sqlite3PExpr(pParse, TK_GE, sqlite3ExprDup(db,pLeft), pStr1, 0);
drh9eb20282005-08-24 03:52:18 +00001177 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001178 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001179 exprAnalyze(pSrc, pWC, idxNew1);
drh17435752007-08-16 04:30:38 +00001180 pNewExpr2 = sqlite3PExpr(pParse, TK_LT, sqlite3ExprDup(db,pLeft), pStr2, 0);
drh9eb20282005-08-24 03:52:18 +00001181 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001182 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001183 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +00001184 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +00001185 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +00001186 pWC->a[idxNew1].iParent = idxTerm;
1187 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +00001188 pTerm->nChild = 2;
1189 }
1190 }
1191#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +00001192
1193#ifndef SQLITE_OMIT_VIRTUALTABLE
1194 /* Add a WO_MATCH auxiliary term to the constraint set if the
1195 ** current expression is of the form: column MATCH expr.
1196 ** This information is used by the xBestIndex methods of
1197 ** virtual tables. The native query optimizer does not attempt
1198 ** to do anything with MATCH functions.
1199 */
1200 if( isMatchOfColumn(pExpr) ){
1201 int idxNew;
1202 Expr *pRight, *pLeft;
1203 WhereTerm *pNewTerm;
1204 Bitmask prereqColumn, prereqExpr;
1205
1206 pRight = pExpr->pList->a[0].pExpr;
1207 pLeft = pExpr->pList->a[1].pExpr;
1208 prereqExpr = exprTableUsage(pMaskSet, pRight);
1209 prereqColumn = exprTableUsage(pMaskSet, pLeft);
1210 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +00001211 Expr *pNewExpr;
danielk1977a1644fd2007-08-29 12:31:25 +00001212 pNewExpr = sqlite3Expr(db, TK_MATCH, 0, sqlite3ExprDup(db, pRight), 0);
drh1a90e092006-06-14 22:07:10 +00001213 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001214 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001215 pNewTerm = &pWC->a[idxNew];
1216 pNewTerm->prereqRight = prereqExpr;
1217 pNewTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001218 pNewTerm->u.leftColumn = pLeft->iColumn;
drh7f375902006-06-13 17:38:59 +00001219 pNewTerm->eOperator = WO_MATCH;
1220 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +00001221 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +00001222 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001223 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001224 pNewTerm->prereqAll = pTerm->prereqAll;
1225 }
1226 }
1227#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001228
1229 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1230 ** an index for tables to the left of the join.
1231 */
1232 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001233}
1234
drh7b4fc6a2007-02-06 13:26:32 +00001235/*
1236** Return TRUE if any of the expressions in pList->a[iFirst...] contain
1237** a reference to any table other than the iBase table.
1238*/
1239static int referencesOtherTables(
1240 ExprList *pList, /* Search expressions in ths list */
drh111a6a72008-12-21 03:51:16 +00001241 WhereMaskSet *pMaskSet, /* Mapping from tables to bitmaps */
drh7b4fc6a2007-02-06 13:26:32 +00001242 int iFirst, /* Be searching with the iFirst-th expression */
1243 int iBase /* Ignore references to this table */
1244){
1245 Bitmask allowed = ~getMask(pMaskSet, iBase);
1246 while( iFirst<pList->nExpr ){
1247 if( (exprTableUsage(pMaskSet, pList->a[iFirst++].pExpr)&allowed)!=0 ){
1248 return 1;
1249 }
1250 }
1251 return 0;
1252}
1253
drh0fcef5e2005-07-19 17:38:22 +00001254
drh75897232000-05-29 14:26:00 +00001255/*
drh51669862004-12-18 18:40:26 +00001256** This routine decides if pIdx can be used to satisfy the ORDER BY
1257** clause. If it can, it returns 1. If pIdx cannot satisfy the
1258** ORDER BY clause, this routine returns 0.
1259**
1260** pOrderBy is an ORDER BY clause from a SELECT statement. pTab is the
1261** left-most table in the FROM clause of that same SELECT statement and
1262** the table has a cursor number of "base". pIdx is an index on pTab.
1263**
1264** nEqCol is the number of columns of pIdx that are used as equality
1265** constraints. Any of these columns may be missing from the ORDER BY
1266** clause and the match can still be a success.
1267**
drh51669862004-12-18 18:40:26 +00001268** All terms of the ORDER BY that match against the index must be either
1269** ASC or DESC. (Terms of the ORDER BY clause past the end of a UNIQUE
1270** index do not need to satisfy this constraint.) The *pbRev value is
1271** set to 1 if the ORDER BY clause is all DESC and it is set to 0 if
1272** the ORDER BY clause is all ASC.
1273*/
1274static int isSortingIndex(
1275 Parse *pParse, /* Parsing context */
drh111a6a72008-12-21 03:51:16 +00001276 WhereMaskSet *pMaskSet, /* Mapping from table cursor numbers to bitmaps */
drh51669862004-12-18 18:40:26 +00001277 Index *pIdx, /* The index we are testing */
drh74161702006-02-24 02:53:49 +00001278 int base, /* Cursor number for the table to be sorted */
drh51669862004-12-18 18:40:26 +00001279 ExprList *pOrderBy, /* The ORDER BY clause */
1280 int nEqCol, /* Number of index columns with == constraints */
1281 int *pbRev /* Set to 1 if ORDER BY is DESC */
1282){
drhb46b5772005-08-29 16:40:52 +00001283 int i, j; /* Loop counters */
drh85eeb692005-12-21 03:16:42 +00001284 int sortOrder = 0; /* XOR of index and ORDER BY sort direction */
drhb46b5772005-08-29 16:40:52 +00001285 int nTerm; /* Number of ORDER BY terms */
1286 struct ExprList_item *pTerm; /* A term of the ORDER BY clause */
drh51669862004-12-18 18:40:26 +00001287 sqlite3 *db = pParse->db;
1288
1289 assert( pOrderBy!=0 );
1290 nTerm = pOrderBy->nExpr;
1291 assert( nTerm>0 );
1292
1293 /* Match terms of the ORDER BY clause against columns of
1294 ** the index.
drhcc192542006-12-20 03:24:19 +00001295 **
1296 ** Note that indices have pIdx->nColumn regular columns plus
1297 ** one additional column containing the rowid. The rowid column
1298 ** of the index is also allowed to match against the ORDER BY
1299 ** clause.
drh51669862004-12-18 18:40:26 +00001300 */
drhcc192542006-12-20 03:24:19 +00001301 for(i=j=0, pTerm=pOrderBy->a; j<nTerm && i<=pIdx->nColumn; i++){
drh51669862004-12-18 18:40:26 +00001302 Expr *pExpr; /* The expression of the ORDER BY pTerm */
1303 CollSeq *pColl; /* The collating sequence of pExpr */
drh85eeb692005-12-21 03:16:42 +00001304 int termSortOrder; /* Sort order for this term */
drhcc192542006-12-20 03:24:19 +00001305 int iColumn; /* The i-th column of the index. -1 for rowid */
1306 int iSortOrder; /* 1 for DESC, 0 for ASC on the i-th index term */
1307 const char *zColl; /* Name of the collating sequence for i-th index term */
drh51669862004-12-18 18:40:26 +00001308
1309 pExpr = pTerm->pExpr;
1310 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=base ){
1311 /* Can not use an index sort on anything that is not a column in the
1312 ** left-most table of the FROM clause */
drh7b4fc6a2007-02-06 13:26:32 +00001313 break;
drh51669862004-12-18 18:40:26 +00001314 }
1315 pColl = sqlite3ExprCollSeq(pParse, pExpr);
drhcc192542006-12-20 03:24:19 +00001316 if( !pColl ){
1317 pColl = db->pDfltColl;
1318 }
1319 if( i<pIdx->nColumn ){
1320 iColumn = pIdx->aiColumn[i];
1321 if( iColumn==pIdx->pTable->iPKey ){
1322 iColumn = -1;
1323 }
1324 iSortOrder = pIdx->aSortOrder[i];
1325 zColl = pIdx->azColl[i];
1326 }else{
1327 iColumn = -1;
1328 iSortOrder = 0;
1329 zColl = pColl->zName;
1330 }
1331 if( pExpr->iColumn!=iColumn || sqlite3StrICmp(pColl->zName, zColl) ){
drh9012bcb2004-12-19 00:11:35 +00001332 /* Term j of the ORDER BY clause does not match column i of the index */
1333 if( i<nEqCol ){
drh51669862004-12-18 18:40:26 +00001334 /* If an index column that is constrained by == fails to match an
1335 ** ORDER BY term, that is OK. Just ignore that column of the index
1336 */
1337 continue;
drhff354e92008-06-25 02:47:57 +00001338 }else if( i==pIdx->nColumn ){
1339 /* Index column i is the rowid. All other terms match. */
1340 break;
drh51669862004-12-18 18:40:26 +00001341 }else{
1342 /* If an index column fails to match and is not constrained by ==
1343 ** then the index cannot satisfy the ORDER BY constraint.
1344 */
1345 return 0;
1346 }
1347 }
danielk1977b3bf5562006-01-10 17:58:23 +00001348 assert( pIdx->aSortOrder!=0 );
drh85eeb692005-12-21 03:16:42 +00001349 assert( pTerm->sortOrder==0 || pTerm->sortOrder==1 );
drhcc192542006-12-20 03:24:19 +00001350 assert( iSortOrder==0 || iSortOrder==1 );
1351 termSortOrder = iSortOrder ^ pTerm->sortOrder;
drh51669862004-12-18 18:40:26 +00001352 if( i>nEqCol ){
drh85eeb692005-12-21 03:16:42 +00001353 if( termSortOrder!=sortOrder ){
drh51669862004-12-18 18:40:26 +00001354 /* Indices can only be used if all ORDER BY terms past the
1355 ** equality constraints are all either DESC or ASC. */
1356 return 0;
1357 }
1358 }else{
drh85eeb692005-12-21 03:16:42 +00001359 sortOrder = termSortOrder;
drh51669862004-12-18 18:40:26 +00001360 }
1361 j++;
1362 pTerm++;
drh7b4fc6a2007-02-06 13:26:32 +00001363 if( iColumn<0 && !referencesOtherTables(pOrderBy, pMaskSet, j, base) ){
drhcc192542006-12-20 03:24:19 +00001364 /* If the indexed column is the primary key and everything matches
drh7b4fc6a2007-02-06 13:26:32 +00001365 ** so far and none of the ORDER BY terms to the right reference other
1366 ** tables in the join, then we are assured that the index can be used
1367 ** to sort because the primary key is unique and so none of the other
1368 ** columns will make any difference
drhcc192542006-12-20 03:24:19 +00001369 */
1370 j = nTerm;
1371 }
drh51669862004-12-18 18:40:26 +00001372 }
1373
drhcc192542006-12-20 03:24:19 +00001374 *pbRev = sortOrder!=0;
drh8718f522005-08-13 16:13:04 +00001375 if( j>=nTerm ){
drhcc192542006-12-20 03:24:19 +00001376 /* All terms of the ORDER BY clause are covered by this index so
1377 ** this index can be used for sorting. */
1378 return 1;
1379 }
drh7b4fc6a2007-02-06 13:26:32 +00001380 if( pIdx->onError!=OE_None && i==pIdx->nColumn
1381 && !referencesOtherTables(pOrderBy, pMaskSet, j, base) ){
drhcc192542006-12-20 03:24:19 +00001382 /* All terms of this index match some prefix of the ORDER BY clause
drh7b4fc6a2007-02-06 13:26:32 +00001383 ** and the index is UNIQUE and no terms on the tail of the ORDER BY
1384 ** clause reference other tables in a join. If this is all true then
1385 ** the order by clause is superfluous. */
drh51669862004-12-18 18:40:26 +00001386 return 1;
1387 }
1388 return 0;
1389}
1390
1391/*
drhb6c29892004-11-22 19:12:19 +00001392** Check table to see if the ORDER BY clause in pOrderBy can be satisfied
1393** by sorting in order of ROWID. Return true if so and set *pbRev to be
1394** true for reverse ROWID and false for forward ROWID order.
1395*/
1396static int sortableByRowid(
1397 int base, /* Cursor number for table to be sorted */
1398 ExprList *pOrderBy, /* The ORDER BY clause */
drh111a6a72008-12-21 03:51:16 +00001399 WhereMaskSet *pMaskSet, /* Mapping from table cursors to bitmaps */
drhb6c29892004-11-22 19:12:19 +00001400 int *pbRev /* Set to 1 if ORDER BY is DESC */
1401){
1402 Expr *p;
1403
1404 assert( pOrderBy!=0 );
1405 assert( pOrderBy->nExpr>0 );
1406 p = pOrderBy->a[0].pExpr;
drh7b4fc6a2007-02-06 13:26:32 +00001407 if( p->op==TK_COLUMN && p->iTable==base && p->iColumn==-1
1408 && !referencesOtherTables(pOrderBy, pMaskSet, 1, base) ){
drhb6c29892004-11-22 19:12:19 +00001409 *pbRev = pOrderBy->a[0].sortOrder;
1410 return 1;
1411 }
1412 return 0;
1413}
1414
drhfe05af82005-07-21 03:14:59 +00001415/*
drhb6fb62d2005-09-20 08:47:20 +00001416** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +00001417** The results need not be exact. This is only used for estimating
drh909626d2008-05-30 14:58:37 +00001418** the total cost of performing operations with O(logN) or O(NlogN)
drh28c4cf42005-07-27 20:41:43 +00001419** complexity. Because N is just a guess, it is no great tragedy if
1420** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +00001421*/
1422static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +00001423 double logN = 1;
1424 double x = 10;
drh28c4cf42005-07-27 20:41:43 +00001425 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +00001426 logN += 1;
drh28c4cf42005-07-27 20:41:43 +00001427 x *= 10;
1428 }
1429 return logN;
1430}
1431
drh6d209d82006-06-27 01:54:26 +00001432/*
1433** Two routines for printing the content of an sqlite3_index_info
1434** structure. Used for testing and debugging only. If neither
1435** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1436** are no-ops.
1437*/
drh77a2a5e2007-04-06 01:04:39 +00001438#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_DEBUG)
drh6d209d82006-06-27 01:54:26 +00001439static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1440 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001441 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001442 for(i=0; i<p->nConstraint; i++){
1443 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1444 i,
1445 p->aConstraint[i].iColumn,
1446 p->aConstraint[i].iTermOffset,
1447 p->aConstraint[i].op,
1448 p->aConstraint[i].usable);
1449 }
1450 for(i=0; i<p->nOrderBy; i++){
1451 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1452 i,
1453 p->aOrderBy[i].iColumn,
1454 p->aOrderBy[i].desc);
1455 }
1456}
1457static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1458 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001459 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001460 for(i=0; i<p->nConstraint; i++){
1461 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1462 i,
1463 p->aConstraintUsage[i].argvIndex,
1464 p->aConstraintUsage[i].omit);
1465 }
1466 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1467 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1468 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1469 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
1470}
1471#else
1472#define TRACE_IDX_INPUTS(A)
1473#define TRACE_IDX_OUTPUTS(A)
1474#endif
1475
drh9eff6162006-06-12 21:59:13 +00001476#ifndef SQLITE_OMIT_VIRTUALTABLE
1477/*
drh7f375902006-06-13 17:38:59 +00001478** Compute the best index for a virtual table.
1479**
1480** The best index is computed by the xBestIndex method of the virtual
1481** table module. This routine is really just a wrapper that sets up
1482** the sqlite3_index_info structure that is used to communicate with
1483** xBestIndex.
1484**
1485** In a join, this routine might be called multiple times for the
1486** same virtual table. The sqlite3_index_info structure is created
1487** and initialized on the first invocation and reused on all subsequent
1488** invocations. The sqlite3_index_info structure is also used when
1489** code is generated to access the virtual table. The whereInfoDelete()
1490** routine takes care of freeing the sqlite3_index_info structure after
1491** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00001492*/
1493static double bestVirtualIndex(
1494 Parse *pParse, /* The parsing context */
1495 WhereClause *pWC, /* The WHERE clause */
1496 struct SrcList_item *pSrc, /* The FROM clause term to search */
1497 Bitmask notReady, /* Mask of cursors that are not available */
1498 ExprList *pOrderBy, /* The order by clause */
1499 int orderByUsable, /* True if we can potential sort */
1500 sqlite3_index_info **ppIdxInfo /* Index information passed to xBestIndex */
1501){
1502 Table *pTab = pSrc->pTab;
danielk19773e3a84d2008-08-01 17:37:40 +00001503 sqlite3_vtab *pVtab = pTab->pVtab;
drh9eff6162006-06-12 21:59:13 +00001504 sqlite3_index_info *pIdxInfo;
1505 struct sqlite3_index_constraint *pIdxCons;
1506 struct sqlite3_index_orderby *pIdxOrderBy;
1507 struct sqlite3_index_constraint_usage *pUsage;
1508 WhereTerm *pTerm;
1509 int i, j;
1510 int nOrderBy;
danielk197774cdba42006-06-19 12:02:58 +00001511 int rc;
drh9eff6162006-06-12 21:59:13 +00001512
1513 /* If the sqlite3_index_info structure has not been previously
1514 ** allocated and initialized for this virtual table, then allocate
1515 ** and initialize it now
1516 */
1517 pIdxInfo = *ppIdxInfo;
1518 if( pIdxInfo==0 ){
drh9eff6162006-06-12 21:59:13 +00001519 int nTerm;
drh4f0c5872007-03-26 22:05:01 +00001520 WHERETRACE(("Recomputing index info for %s...\n", pTab->zName));
drh9eff6162006-06-12 21:59:13 +00001521
1522 /* Count the number of possible WHERE clause constraints referring
1523 ** to this virtual table */
1524 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1525 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh4d9f9e62008-08-25 12:08:22 +00001526 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
drh981642f2008-04-19 14:40:43 +00001527 testcase( pTerm->eOperator==WO_IN );
1528 testcase( pTerm->eOperator==WO_ISNULL );
1529 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drh9eff6162006-06-12 21:59:13 +00001530 nTerm++;
1531 }
1532
1533 /* If the ORDER BY clause contains only columns in the current
1534 ** virtual table then allocate space for the aOrderBy part of
1535 ** the sqlite3_index_info structure.
1536 */
1537 nOrderBy = 0;
1538 if( pOrderBy ){
1539 for(i=0; i<pOrderBy->nExpr; i++){
1540 Expr *pExpr = pOrderBy->a[i].pExpr;
1541 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
1542 }
1543 if( i==pOrderBy->nExpr ){
1544 nOrderBy = pOrderBy->nExpr;
1545 }
1546 }
1547
1548 /* Allocate the sqlite3_index_info structure
1549 */
danielk197726783a52007-08-29 14:06:22 +00001550 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
drh9eff6162006-06-12 21:59:13 +00001551 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
1552 + sizeof(*pIdxOrderBy)*nOrderBy );
1553 if( pIdxInfo==0 ){
1554 sqlite3ErrorMsg(pParse, "out of memory");
1555 return 0.0;
1556 }
1557 *ppIdxInfo = pIdxInfo;
1558
1559 /* Initialize the structure. The sqlite3_index_info structure contains
1560 ** many fields that are declared "const" to prevent xBestIndex from
1561 ** changing them. We have to do some funky casting in order to
1562 ** initialize those fields.
1563 */
1564 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
1565 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
1566 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
1567 *(int*)&pIdxInfo->nConstraint = nTerm;
1568 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
1569 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
1570 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
1571 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
1572 pUsage;
1573
1574 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1575 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh4d9f9e62008-08-25 12:08:22 +00001576 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
drh981642f2008-04-19 14:40:43 +00001577 testcase( pTerm->eOperator==WO_IN );
1578 testcase( pTerm->eOperator==WO_ISNULL );
1579 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drh700a2262008-12-17 19:22:15 +00001580 pIdxCons[j].iColumn = pTerm->u.leftColumn;
drh9eff6162006-06-12 21:59:13 +00001581 pIdxCons[j].iTermOffset = i;
drhec1724e2008-12-09 01:32:03 +00001582 pIdxCons[j].op = (u8)pTerm->eOperator;
drh7f375902006-06-13 17:38:59 +00001583 /* The direct assignment in the previous line is possible only because
1584 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
1585 ** following asserts verify this fact. */
drh9eff6162006-06-12 21:59:13 +00001586 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
1587 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
1588 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
1589 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
1590 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
drh7f375902006-06-13 17:38:59 +00001591 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
1592 assert( pTerm->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
drh9eff6162006-06-12 21:59:13 +00001593 j++;
1594 }
1595 for(i=0; i<nOrderBy; i++){
1596 Expr *pExpr = pOrderBy->a[i].pExpr;
1597 pIdxOrderBy[i].iColumn = pExpr->iColumn;
1598 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
1599 }
1600 }
1601
drh7f375902006-06-13 17:38:59 +00001602 /* At this point, the sqlite3_index_info structure that pIdxInfo points
1603 ** to will have been initialized, either during the current invocation or
1604 ** during some prior invocation. Now we just have to customize the
1605 ** details of pIdxInfo for the current invocation and pass it to
1606 ** xBestIndex.
1607 */
1608
danielk1977935ed5e2007-03-30 09:13:13 +00001609 /* The module name must be defined. Also, by this point there must
1610 ** be a pointer to an sqlite3_vtab structure. Otherwise
1611 ** sqlite3ViewGetColumnNames() would have picked up the error.
1612 */
drh9eff6162006-06-12 21:59:13 +00001613 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
danielk19773e3a84d2008-08-01 17:37:40 +00001614 assert( pVtab );
danielk1977935ed5e2007-03-30 09:13:13 +00001615#if 0
drh9eff6162006-06-12 21:59:13 +00001616 if( pTab->pVtab==0 ){
1617 sqlite3ErrorMsg(pParse, "undefined module %s for table %s",
1618 pTab->azModuleArg[0], pTab->zName);
1619 return 0.0;
1620 }
danielk1977935ed5e2007-03-30 09:13:13 +00001621#endif
drh9eff6162006-06-12 21:59:13 +00001622
1623 /* Set the aConstraint[].usable fields and initialize all
drh7f375902006-06-13 17:38:59 +00001624 ** output variables to zero.
1625 **
1626 ** aConstraint[].usable is true for constraints where the right-hand
1627 ** side contains only references to tables to the left of the current
1628 ** table. In other words, if the constraint is of the form:
1629 **
1630 ** column = expr
1631 **
1632 ** and we are evaluating a join, then the constraint on column is
1633 ** only valid if all tables referenced in expr occur to the left
1634 ** of the table containing column.
1635 **
1636 ** The aConstraints[] array contains entries for all constraints
1637 ** on the current table. That way we only have to compute it once
1638 ** even though we might try to pick the best index multiple times.
1639 ** For each attempt at picking an index, the order of tables in the
1640 ** join might be different so we have to recompute the usable flag
1641 ** each time.
drh9eff6162006-06-12 21:59:13 +00001642 */
1643 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
1644 pUsage = pIdxInfo->aConstraintUsage;
1645 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
1646 j = pIdxCons->iTermOffset;
1647 pTerm = &pWC->a[j];
drhec1724e2008-12-09 01:32:03 +00001648 pIdxCons->usable = (pTerm->prereqRight & notReady)==0 ?1:0;
drh9eff6162006-06-12 21:59:13 +00001649 }
1650 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
drh4be8b512006-06-13 23:51:34 +00001651 if( pIdxInfo->needToFreeIdxStr ){
1652 sqlite3_free(pIdxInfo->idxStr);
1653 }
1654 pIdxInfo->idxStr = 0;
1655 pIdxInfo->idxNum = 0;
1656 pIdxInfo->needToFreeIdxStr = 0;
drh9eff6162006-06-12 21:59:13 +00001657 pIdxInfo->orderByConsumed = 0;
danielk197793626f42006-06-20 13:07:27 +00001658 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / 2.0;
drh9eff6162006-06-12 21:59:13 +00001659 nOrderBy = pIdxInfo->nOrderBy;
1660 if( pIdxInfo->nOrderBy && !orderByUsable ){
drha967e882006-06-13 01:04:52 +00001661 *(int*)&pIdxInfo->nOrderBy = 0;
drh9eff6162006-06-12 21:59:13 +00001662 }
danielk197774cdba42006-06-19 12:02:58 +00001663
drh7e8b8482008-01-23 03:03:05 +00001664 (void)sqlite3SafetyOff(pParse->db);
drh4f0c5872007-03-26 22:05:01 +00001665 WHERETRACE(("xBestIndex for %s\n", pTab->zName));
drh6d209d82006-06-27 01:54:26 +00001666 TRACE_IDX_INPUTS(pIdxInfo);
danielk19773e3a84d2008-08-01 17:37:40 +00001667 rc = pVtab->pModule->xBestIndex(pVtab, pIdxInfo);
drh6d209d82006-06-27 01:54:26 +00001668 TRACE_IDX_OUTPUTS(pIdxInfo);
danielk197739359dc2008-03-17 09:36:44 +00001669 (void)sqlite3SafetyOn(pParse->db);
1670
danielk19773e3a84d2008-08-01 17:37:40 +00001671 if( rc!=SQLITE_OK ){
1672 if( rc==SQLITE_NOMEM ){
1673 pParse->db->mallocFailed = 1;
1674 }else if( !pVtab->zErrMsg ){
1675 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
1676 }else{
1677 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
1678 }
1679 }
1680 sqlite3DbFree(pParse->db, pVtab->zErrMsg);
1681 pVtab->zErrMsg = 0;
1682
danielk197739359dc2008-03-17 09:36:44 +00001683 for(i=0; i<pIdxInfo->nConstraint; i++){
1684 if( !pIdxInfo->aConstraint[i].usable && pUsage[i].argvIndex>0 ){
1685 sqlite3ErrorMsg(pParse,
1686 "table %s: xBestIndex returned an invalid plan", pTab->zName);
1687 return 0.0;
1688 }
1689 }
1690
drha967e882006-06-13 01:04:52 +00001691 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
drh9eff6162006-06-12 21:59:13 +00001692 return pIdxInfo->estimatedCost;
1693}
1694#endif /* SQLITE_OMIT_VIRTUALTABLE */
1695
drh28c4cf42005-07-27 20:41:43 +00001696/*
drh111a6a72008-12-21 03:51:16 +00001697** Find the query plan for accessing a particular table. Write the
1698** best query plan and its cost into the WhereCost object supplied as the
1699** last parameter.
drh51147ba2005-07-23 22:59:55 +00001700**
drh111a6a72008-12-21 03:51:16 +00001701** The lowest cost plan wins. The cost is an estimate of the amount of
1702** CPU and disk I/O need to process the request using the selected plan.
drh51147ba2005-07-23 22:59:55 +00001703** Factors that influence cost include:
1704**
1705** * The estimated number of rows that will be retrieved. (The
1706** fewer the better.)
1707**
1708** * Whether or not sorting must occur.
1709**
1710** * Whether or not there must be separate lookups in the
1711** index and in the main table.
1712**
danielk197785574e32008-10-06 05:32:18 +00001713** If there was an INDEXED BY clause attached to the table in the SELECT
drh111a6a72008-12-21 03:51:16 +00001714** statement, then this function only considers plans using the
danielk197785574e32008-10-06 05:32:18 +00001715** named index. If one cannot be found, then the returned cost is
drh111a6a72008-12-21 03:51:16 +00001716** SQLITE_BIG_DBL. If a plan can be found that uses the named index,
danielk197785574e32008-10-06 05:32:18 +00001717** then the cost is calculated in the usual way.
1718**
1719** If a NOT INDEXED clause was attached to the table in the SELECT
1720** statement, then no indexes are considered. However, the selected
drh111a6a72008-12-21 03:51:16 +00001721** plan may still take advantage of the tables built-in rowid
danielk197785574e32008-10-06 05:32:18 +00001722** index.
drhfe05af82005-07-21 03:14:59 +00001723*/
drh111a6a72008-12-21 03:51:16 +00001724static void bestIndex(
drhfe05af82005-07-21 03:14:59 +00001725 Parse *pParse, /* The parsing context */
1726 WhereClause *pWC, /* The WHERE clause */
1727 struct SrcList_item *pSrc, /* The FROM clause term to search */
1728 Bitmask notReady, /* Mask of cursors that are not available */
drh111a6a72008-12-21 03:51:16 +00001729 ExprList *pOrderBy, /* The ORDER BY clause */
1730 WhereCost *pCost /* Lowest cost query plan */
drhfe05af82005-07-21 03:14:59 +00001731){
drh111a6a72008-12-21 03:51:16 +00001732 WhereTerm *pTerm; /* A single term of the WHERE clause */
drh51147ba2005-07-23 22:59:55 +00001733 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
1734 Index *pProbe; /* An index we are evaluating */
1735 int rev; /* True to scan in reverse order */
drh165be382008-12-05 02:36:33 +00001736 int wsFlags; /* Flags associated with pProbe */
drh51147ba2005-07-23 22:59:55 +00001737 int nEq; /* Number of == or IN constraints */
drhc49de5d2007-01-19 01:06:01 +00001738 int eqTermMask; /* Mask of valid equality operators */
drh51147ba2005-07-23 22:59:55 +00001739 double cost; /* Cost of using pProbe */
drh111a6a72008-12-21 03:51:16 +00001740 double nRow; /* Estimated number of rows in result set */
drhdd5f5a62008-12-23 13:35:23 +00001741 int i; /* Loop counter */
1742 Bitmask maskSrc; /* Bitmask for the pSrc table */
drhfe05af82005-07-21 03:14:59 +00001743
drh165be382008-12-05 02:36:33 +00001744 WHERETRACE(("bestIndex: tbl=%s notReady=%llx\n", pSrc->pTab->zName,notReady));
drh4dd238a2006-03-28 23:55:57 +00001745 pProbe = pSrc->pTab->pIndex;
danielk197785574e32008-10-06 05:32:18 +00001746 if( pSrc->notIndexed ){
1747 pProbe = 0;
1748 }
drh4dd238a2006-03-28 23:55:57 +00001749
1750 /* If the table has no indices and there are no terms in the where
1751 ** clause that refer to the ROWID, then we will never be able to do
1752 ** anything other than a full table scan on this table. We might as
1753 ** well put it first in the join order. That way, perhaps it can be
1754 ** referenced by other tables in the join.
1755 */
drh111a6a72008-12-21 03:51:16 +00001756 memset(pCost, 0, sizeof(*pCost));
drh4dd238a2006-03-28 23:55:57 +00001757 if( pProbe==0 &&
1758 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 +00001759 (pOrderBy==0 || !sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev)) ){
drh111a6a72008-12-21 03:51:16 +00001760 return;
drh4dd238a2006-03-28 23:55:57 +00001761 }
drh111a6a72008-12-21 03:51:16 +00001762 pCost->rCost = SQLITE_BIG_DBL;
drh51147ba2005-07-23 22:59:55 +00001763
danielk197785574e32008-10-06 05:32:18 +00001764 /* Check for a rowid=EXPR or rowid IN (...) constraints. If there was
1765 ** an INDEXED BY clause attached to this table, skip this step.
drhfe05af82005-07-21 03:14:59 +00001766 */
danielk197785574e32008-10-06 05:32:18 +00001767 if( !pSrc->pIndex ){
1768 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
1769 if( pTerm ){
1770 Expr *pExpr;
drh111a6a72008-12-21 03:51:16 +00001771 pCost->plan.wsFlags = WHERE_ROWID_EQ;
danielk197785574e32008-10-06 05:32:18 +00001772 if( pTerm->eOperator & WO_EQ ){
1773 /* Rowid== is always the best pick. Look no further. Because only
1774 ** a single row is generated, output is always in sorted order */
drh111a6a72008-12-21 03:51:16 +00001775 pCost->plan.wsFlags = WHERE_ROWID_EQ | WHERE_UNIQUE;
1776 pCost->plan.nEq = 1;
danielk197785574e32008-10-06 05:32:18 +00001777 WHERETRACE(("... best is rowid\n"));
drh111a6a72008-12-21 03:51:16 +00001778 pCost->rCost = 0;
1779 pCost->nRow = 1;
1780 return;
danielk197785574e32008-10-06 05:32:18 +00001781 }else if( (pExpr = pTerm->pExpr)->pList!=0 ){
1782 /* Rowid IN (LIST): cost is NlogN where N is the number of list
1783 ** elements. */
drh111a6a72008-12-21 03:51:16 +00001784 pCost->rCost = pCost->nRow = pExpr->pList->nExpr;
1785 pCost->rCost *= estLog(pCost->rCost);
danielk197785574e32008-10-06 05:32:18 +00001786 }else{
1787 /* Rowid IN (SELECT): cost is NlogN where N is the number of rows
1788 ** in the result of the inner select. We have no way to estimate
1789 ** that value so make a wild guess. */
drh111a6a72008-12-21 03:51:16 +00001790 pCost->nRow = 100;
1791 pCost->rCost = 200;
drh28c4cf42005-07-27 20:41:43 +00001792 }
drh111a6a72008-12-21 03:51:16 +00001793 WHERETRACE(("... rowid IN cost: %.9g\n", pCost->rCost));
drh51147ba2005-07-23 22:59:55 +00001794 }
danielk197785574e32008-10-06 05:32:18 +00001795
1796 /* Estimate the cost of a table scan. If we do not know how many
1797 ** entries are in the table, use 1 million as a guess.
1798 */
1799 cost = pProbe ? pProbe->aiRowEst[0] : 1000000;
1800 WHERETRACE(("... table scan base cost: %.9g\n", cost));
drh165be382008-12-05 02:36:33 +00001801 wsFlags = WHERE_ROWID_RANGE;
danielk197785574e32008-10-06 05:32:18 +00001802
1803 /* Check for constraints on a range of rowids in a table scan.
1804 */
1805 pTerm = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE|WO_GT|WO_GE, 0);
1806 if( pTerm ){
1807 if( findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0) ){
drh165be382008-12-05 02:36:33 +00001808 wsFlags |= WHERE_TOP_LIMIT;
drh700a2262008-12-17 19:22:15 +00001809 cost /= 3; /* Guess that rowid<EXPR eliminates two-thirds of rows */
danielk197785574e32008-10-06 05:32:18 +00001810 }
1811 if( findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0) ){
drh165be382008-12-05 02:36:33 +00001812 wsFlags |= WHERE_BTM_LIMIT;
danielk197785574e32008-10-06 05:32:18 +00001813 cost /= 3; /* Guess that rowid>EXPR eliminates two-thirds of rows */
1814 }
1815 WHERETRACE(("... rowid range reduces cost to %.9g\n", cost));
1816 }else{
drh165be382008-12-05 02:36:33 +00001817 wsFlags = 0;
danielk197785574e32008-10-06 05:32:18 +00001818 }
drh111a6a72008-12-21 03:51:16 +00001819 nRow = cost;
danielk197785574e32008-10-06 05:32:18 +00001820
1821 /* If the table scan does not satisfy the ORDER BY clause, increase
1822 ** the cost by NlogN to cover the expense of sorting. */
1823 if( pOrderBy ){
1824 if( sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev) ){
drh165be382008-12-05 02:36:33 +00001825 wsFlags |= WHERE_ORDERBY|WHERE_ROWID_RANGE;
danielk197785574e32008-10-06 05:32:18 +00001826 if( rev ){
drh165be382008-12-05 02:36:33 +00001827 wsFlags |= WHERE_REVERSE;
danielk197785574e32008-10-06 05:32:18 +00001828 }
1829 }else{
1830 cost += cost*estLog(cost);
1831 WHERETRACE(("... sorting increases cost to %.9g\n", cost));
1832 }
1833 }
drh111a6a72008-12-21 03:51:16 +00001834 if( cost<pCost->rCost ){
1835 pCost->rCost = cost;
1836 pCost->nRow = nRow;
1837 pCost->plan.wsFlags = wsFlags;
danielk197785574e32008-10-06 05:32:18 +00001838 }
drhfe05af82005-07-21 03:14:59 +00001839 }
1840
drh23d04d52008-12-23 23:56:22 +00001841#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00001842 /* Search for an OR-clause that can be used to look up the table.
1843 */
1844 maskSrc = getMask(pWC->pMaskSet, iCur);
1845 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1846 WhereClause tempWC;
1847 tempWC = *pWC;
1848 tempWC.nSlot = 1;
1849 if( pTerm->eOperator==WO_OR
1850 && ((pTerm->prereqAll & ~maskSrc) & notReady)==0
1851 && (pTerm->u.pOrInfo->indexable & maskSrc)!=0 ){
1852 WhereClause *pOrWC = &pTerm->u.pOrInfo->wc;
1853 WhereTerm *pOrTerm;
1854 int j;
1855 double rTotal = 0;
1856 double nRow = 0;
1857 for(j=0, pOrTerm=pOrWC->a; j<pOrWC->nTerm; j++, pOrTerm++){
1858 WhereCost sTermCost;
drh29435252008-12-28 18:35:08 +00001859 if( pOrTerm->eOperator==WO_AND ){
1860 WhereClause *pAndWC = &pOrTerm->u.pAndInfo->wc;
1861 bestIndex(pParse, pAndWC, pSrc, notReady, 0, &sTermCost);
1862 }else if( pOrTerm->leftCursor==iCur ){
1863 tempWC.a = pOrTerm;
1864 bestIndex(pParse, &tempWC, pSrc, notReady, 0, &sTermCost);
1865 }else{
1866 continue;
1867 }
drhdd5f5a62008-12-23 13:35:23 +00001868 if( sTermCost.plan.wsFlags==0 ){
1869 rTotal = pCost->rCost;
1870 break;
1871 }
1872 rTotal += sTermCost.rCost;
1873 nRow += sTermCost.nRow;
1874 }
1875 if( rTotal<pCost->rCost ){
1876 pCost->rCost = rTotal;
1877 pCost->nRow = nRow;
1878 pCost->plan.wsFlags = WHERE_MULTI_OR;
1879 pCost->plan.u.pTerm = pTerm;
drhca8c4662008-12-28 20:47:02 +00001880 if( pOrderBy!=0
1881 && sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev)
1882 && !rev
1883 ){
1884 pCost->plan.wsFlags = WHERE_ORDERBY|WHERE_MULTI_OR;
1885 }
drhdd5f5a62008-12-23 13:35:23 +00001886 }
1887 }
1888 }
drh23d04d52008-12-23 23:56:22 +00001889#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00001890
drhc49de5d2007-01-19 01:06:01 +00001891 /* If the pSrc table is the right table of a LEFT JOIN then we may not
1892 ** use an index to satisfy IS NULL constraints on that table. This is
1893 ** because columns might end up being NULL if the table does not match -
1894 ** a circumstance which the index cannot help us discover. Ticket #2177.
1895 */
1896 if( (pSrc->jointype & JT_LEFT)!=0 ){
1897 eqTermMask = WO_EQ|WO_IN;
1898 }else{
1899 eqTermMask = WO_EQ|WO_IN|WO_ISNULL;
1900 }
1901
drhfe05af82005-07-21 03:14:59 +00001902 /* Look at each index.
1903 */
danielk197785574e32008-10-06 05:32:18 +00001904 if( pSrc->pIndex ){
1905 pProbe = pSrc->pIndex;
1906 }
1907 for(; pProbe; pProbe=(pSrc->pIndex ? 0 : pProbe->pNext)){
drh51147ba2005-07-23 22:59:55 +00001908 int i; /* Loop counter */
drhb37df7b2005-10-13 02:09:49 +00001909 double inMultiplier = 1;
drh51147ba2005-07-23 22:59:55 +00001910
drh4f0c5872007-03-26 22:05:01 +00001911 WHERETRACE(("... index %s:\n", pProbe->zName));
drhfe05af82005-07-21 03:14:59 +00001912
1913 /* Count the number of columns in the index that are satisfied
1914 ** by x=EXPR constraints or x IN (...) constraints.
1915 */
drh165be382008-12-05 02:36:33 +00001916 wsFlags = 0;
drhfe05af82005-07-21 03:14:59 +00001917 for(i=0; i<pProbe->nColumn; i++){
1918 int j = pProbe->aiColumn[i];
drhc49de5d2007-01-19 01:06:01 +00001919 pTerm = findTerm(pWC, iCur, j, notReady, eqTermMask, pProbe);
drhfe05af82005-07-21 03:14:59 +00001920 if( pTerm==0 ) break;
drh165be382008-12-05 02:36:33 +00001921 wsFlags |= WHERE_COLUMN_EQ;
drhb52076c2006-01-23 13:22:09 +00001922 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00001923 Expr *pExpr = pTerm->pExpr;
drh165be382008-12-05 02:36:33 +00001924 wsFlags |= WHERE_COLUMN_IN;
drha6110402005-07-28 20:51:19 +00001925 if( pExpr->pSelect!=0 ){
drhffe0f892006-05-11 13:26:25 +00001926 inMultiplier *= 25;
drh34004ce2008-07-11 16:15:17 +00001927 }else if( ALWAYS(pExpr->pList) ){
drhb37df7b2005-10-13 02:09:49 +00001928 inMultiplier *= pExpr->pList->nExpr + 1;
drhfe05af82005-07-21 03:14:59 +00001929 }
1930 }
1931 }
drh111a6a72008-12-21 03:51:16 +00001932 nRow = pProbe->aiRowEst[i] * inMultiplier;
1933 cost = nRow * estLog(inMultiplier);
drh51147ba2005-07-23 22:59:55 +00001934 nEq = i;
drh165be382008-12-05 02:36:33 +00001935 if( pProbe->onError!=OE_None && (wsFlags & WHERE_COLUMN_IN)==0
drh943af3c2005-07-29 19:43:58 +00001936 && nEq==pProbe->nColumn ){
drh165be382008-12-05 02:36:33 +00001937 wsFlags |= WHERE_UNIQUE;
drh943af3c2005-07-29 19:43:58 +00001938 }
drh8e70e342007-09-13 17:54:40 +00001939 WHERETRACE(("...... nEq=%d inMult=%.9g cost=%.9g\n",nEq,inMultiplier,cost));
drhfe05af82005-07-21 03:14:59 +00001940
drh51147ba2005-07-23 22:59:55 +00001941 /* Look for range constraints
drhfe05af82005-07-21 03:14:59 +00001942 */
drh51147ba2005-07-23 22:59:55 +00001943 if( nEq<pProbe->nColumn ){
1944 int j = pProbe->aiColumn[nEq];
1945 pTerm = findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE|WO_GT|WO_GE, pProbe);
1946 if( pTerm ){
drh165be382008-12-05 02:36:33 +00001947 wsFlags |= WHERE_COLUMN_RANGE;
drh51147ba2005-07-23 22:59:55 +00001948 if( findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE, pProbe) ){
drh165be382008-12-05 02:36:33 +00001949 wsFlags |= WHERE_TOP_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001950 cost /= 3;
drh111a6a72008-12-21 03:51:16 +00001951 nRow /= 3;
drh51147ba2005-07-23 22:59:55 +00001952 }
1953 if( findTerm(pWC, iCur, j, notReady, WO_GT|WO_GE, pProbe) ){
drh165be382008-12-05 02:36:33 +00001954 wsFlags |= WHERE_BTM_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001955 cost /= 3;
drh111a6a72008-12-21 03:51:16 +00001956 nRow /= 3;
drh51147ba2005-07-23 22:59:55 +00001957 }
drh4f0c5872007-03-26 22:05:01 +00001958 WHERETRACE(("...... range reduces cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001959 }
1960 }
1961
drh28c4cf42005-07-27 20:41:43 +00001962 /* Add the additional cost of sorting if that is a factor.
drh51147ba2005-07-23 22:59:55 +00001963 */
drh28c4cf42005-07-27 20:41:43 +00001964 if( pOrderBy ){
drh165be382008-12-05 02:36:33 +00001965 if( (wsFlags & WHERE_COLUMN_IN)==0 &&
drh7b4fc6a2007-02-06 13:26:32 +00001966 isSortingIndex(pParse,pWC->pMaskSet,pProbe,iCur,pOrderBy,nEq,&rev) ){
drh165be382008-12-05 02:36:33 +00001967 if( wsFlags==0 ){
1968 wsFlags = WHERE_COLUMN_RANGE;
drh28c4cf42005-07-27 20:41:43 +00001969 }
drh165be382008-12-05 02:36:33 +00001970 wsFlags |= WHERE_ORDERBY;
drh28c4cf42005-07-27 20:41:43 +00001971 if( rev ){
drh165be382008-12-05 02:36:33 +00001972 wsFlags |= WHERE_REVERSE;
drh28c4cf42005-07-27 20:41:43 +00001973 }
1974 }else{
1975 cost += cost*estLog(cost);
drh4f0c5872007-03-26 22:05:01 +00001976 WHERETRACE(("...... orderby increases cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001977 }
drhfe05af82005-07-21 03:14:59 +00001978 }
1979
1980 /* Check to see if we can get away with using just the index without
drh51147ba2005-07-23 22:59:55 +00001981 ** ever reading the table. If that is the case, then halve the
1982 ** cost of this index.
drhfe05af82005-07-21 03:14:59 +00001983 */
drh165be382008-12-05 02:36:33 +00001984 if( wsFlags && pSrc->colUsed < (((Bitmask)1)<<(BMS-1)) ){
drhfe05af82005-07-21 03:14:59 +00001985 Bitmask m = pSrc->colUsed;
1986 int j;
1987 for(j=0; j<pProbe->nColumn; j++){
1988 int x = pProbe->aiColumn[j];
1989 if( x<BMS-1 ){
1990 m &= ~(((Bitmask)1)<<x);
1991 }
1992 }
1993 if( m==0 ){
drh165be382008-12-05 02:36:33 +00001994 wsFlags |= WHERE_IDX_ONLY;
drhb37df7b2005-10-13 02:09:49 +00001995 cost /= 2;
drh4f0c5872007-03-26 22:05:01 +00001996 WHERETRACE(("...... idx-only reduces cost to %.9g\n", cost));
drhfe05af82005-07-21 03:14:59 +00001997 }
1998 }
1999
drh51147ba2005-07-23 22:59:55 +00002000 /* If this index has achieved the lowest cost so far, then use it.
drhfe05af82005-07-21 03:14:59 +00002001 */
drh111a6a72008-12-21 03:51:16 +00002002 if( wsFlags!=0 && cost < pCost->rCost ){
2003 pCost->rCost = cost;
2004 pCost->nRow = nRow;
2005 pCost->plan.wsFlags = wsFlags;
2006 pCost->plan.nEq = nEq;
2007 assert( pCost->plan.wsFlags & WHERE_INDEXED );
2008 pCost->plan.u.pIdx = pProbe;
drhfe05af82005-07-21 03:14:59 +00002009 }
2010 }
2011
drhfe05af82005-07-21 03:14:59 +00002012 /* Report the best result
2013 */
drh111a6a72008-12-21 03:51:16 +00002014 pCost->plan.wsFlags |= eqTermMask;
2015 WHERETRACE(("best index is %s, cost=%.9g, nrow=%.9g, wsFlags=%x, nEq=%d\n",
2016 (pCost->plan.wsFlags & WHERE_INDEXED)!=0 ?
2017 pCost->plan.u.pIdx->zName : "(none)", pCost->nRow,
2018 pCost->rCost, pCost->plan.wsFlags, pCost->plan.nEq));
drhfe05af82005-07-21 03:14:59 +00002019}
2020
drhb6c29892004-11-22 19:12:19 +00002021
2022/*
drh2ffb1182004-07-19 19:14:01 +00002023** Disable a term in the WHERE clause. Except, do not disable the term
2024** if it controls a LEFT OUTER JOIN and it did not originate in the ON
2025** or USING clause of that join.
2026**
2027** Consider the term t2.z='ok' in the following queries:
2028**
2029** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
2030** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
2031** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
2032**
drh23bf66d2004-12-14 03:34:34 +00002033** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00002034** in the ON clause. The term is disabled in (3) because it is not part
2035** of a LEFT OUTER JOIN. In (1), the term is not disabled.
2036**
2037** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00002038** of the join. Disabling is an optimization. When terms are satisfied
2039** by indices, we disable them to prevent redundant tests in the inner
2040** loop. We would get the correct results if nothing were ever disabled,
2041** but joins might run a little slower. The trick is to disable as much
2042** as we can without disabling too much. If we disabled in (1), we'd get
2043** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00002044*/
drh0fcef5e2005-07-19 17:38:22 +00002045static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
2046 if( pTerm
drh165be382008-12-05 02:36:33 +00002047 && ALWAYS((pTerm->wtFlags & TERM_CODED)==0)
drh0fcef5e2005-07-19 17:38:22 +00002048 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
2049 ){
drh165be382008-12-05 02:36:33 +00002050 pTerm->wtFlags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00002051 if( pTerm->iParent>=0 ){
2052 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
2053 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00002054 disableTerm(pLevel, pOther);
2055 }
drh0fcef5e2005-07-19 17:38:22 +00002056 }
drh2ffb1182004-07-19 19:14:01 +00002057 }
2058}
2059
2060/*
danielk1977b790c6c2008-04-18 10:25:24 +00002061** Apply the affinities associated with the first n columns of index
2062** pIdx to the values in the n registers starting at base.
drh94a11212004-09-25 13:12:14 +00002063*/
danielk1977b790c6c2008-04-18 10:25:24 +00002064static void codeApplyAffinity(Parse *pParse, int base, int n, Index *pIdx){
2065 if( n>0 ){
2066 Vdbe *v = pParse->pVdbe;
2067 assert( v!=0 );
2068 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
2069 sqlite3IndexAffinityStr(v, pIdx);
2070 sqlite3ExprCacheAffinityChange(pParse, base, n);
2071 }
drh94a11212004-09-25 13:12:14 +00002072}
2073
drhe8b97272005-07-19 22:22:12 +00002074
2075/*
drh51147ba2005-07-23 22:59:55 +00002076** Generate code for a single equality term of the WHERE clause. An equality
2077** term can be either X=expr or X IN (...). pTerm is the term to be
2078** coded.
2079**
drh1db639c2008-01-17 02:36:28 +00002080** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00002081**
2082** For a constraint of the form X=expr, the expression is evaluated and its
2083** result is left on the stack. For constraints of the form X IN (...)
2084** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00002085*/
drh678ccce2008-03-31 18:19:54 +00002086static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00002087 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00002088 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh1db639c2008-01-17 02:36:28 +00002089 WhereLevel *pLevel, /* When level of the FROM clause we are working on */
drh678ccce2008-03-31 18:19:54 +00002090 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00002091){
drh0fcef5e2005-07-19 17:38:22 +00002092 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00002093 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00002094 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00002095
danielk19772d605492008-10-01 08:43:03 +00002096 assert( iTarget>0 );
drh50b39962006-10-28 00:28:09 +00002097 if( pX->op==TK_EQ ){
drh678ccce2008-03-31 18:19:54 +00002098 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00002099 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00002100 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00002101 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00002102#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00002103 }else{
danielk19779a96b662007-11-29 17:05:18 +00002104 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00002105 int iTab;
drh72e8fa42007-03-28 14:30:06 +00002106 struct InLoop *pIn;
danielk1977b3bce662005-01-29 08:32:43 +00002107
drh50b39962006-10-28 00:28:09 +00002108 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00002109 iReg = iTarget;
danielk19770cdc0222008-06-26 18:04:03 +00002110 eType = sqlite3FindInIndex(pParse, pX, 0);
danielk1977b3bce662005-01-29 08:32:43 +00002111 iTab = pX->iTable;
drh66a51672008-01-03 00:01:23 +00002112 sqlite3VdbeAddOp2(v, OP_Rewind, iTab, 0);
drhd4e70eb2008-01-02 00:34:36 +00002113 VdbeComment((v, "%.*s", pX->span.n, pX->span.z));
drh111a6a72008-12-21 03:51:16 +00002114 assert( pLevel->plan.wsFlags & WHERE_IN_ABLE );
2115 if( pLevel->u.in.nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00002116 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00002117 }
drh111a6a72008-12-21 03:51:16 +00002118 pLevel->u.in.nIn++;
2119 pLevel->u.in.aInLoop =
2120 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
2121 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
2122 pIn = pLevel->u.in.aInLoop;
drh72e8fa42007-03-28 14:30:06 +00002123 if( pIn ){
drh111a6a72008-12-21 03:51:16 +00002124 pIn += pLevel->u.in.nIn - 1;
drh72e8fa42007-03-28 14:30:06 +00002125 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00002126 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00002127 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00002128 }else{
drhb3190c12008-12-08 21:37:14 +00002129 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00002130 }
2131 sqlite3VdbeAddOp1(v, OP_IsNull, iReg);
drha6110402005-07-28 20:51:19 +00002132 }else{
drh111a6a72008-12-21 03:51:16 +00002133 pLevel->u.in.nIn = 0;
drhe23399f2005-07-22 00:31:39 +00002134 }
danielk1977b3bce662005-01-29 08:32:43 +00002135#endif
drh94a11212004-09-25 13:12:14 +00002136 }
drh0fcef5e2005-07-19 17:38:22 +00002137 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00002138 return iReg;
drh94a11212004-09-25 13:12:14 +00002139}
2140
drh51147ba2005-07-23 22:59:55 +00002141/*
2142** Generate code that will evaluate all == and IN constraints for an
2143** index. The values for all constraints are left on the stack.
2144**
2145** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
2146** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
2147** The index has as many as three equality constraints, but in this
2148** example, the third "c" value is an inequality. So only two
2149** constraints are coded. This routine will generate code to evaluate
drh6df2acd2008-12-28 16:55:25 +00002150** a==5 and b IN (1,2,3). The current values for a and b will be stored
2151** in consecutive registers and the index of the first register is returned.
drh51147ba2005-07-23 22:59:55 +00002152**
2153** In the example above nEq==2. But this subroutine works for any value
2154** of nEq including 0. If nEq==0, this routine is nearly a no-op.
2155** The only thing it does is allocate the pLevel->iMem memory cell.
2156**
drh700a2262008-12-17 19:22:15 +00002157** This routine always allocates at least one memory cell and returns
2158** the index of that memory cell. The code that
2159** calls this routine will use that memory cell to store the termination
drh51147ba2005-07-23 22:59:55 +00002160** key value of the loop. If one or more IN operators appear, then
2161** this routine allocates an additional nEq memory cells for internal
2162** use.
2163*/
drh1db639c2008-01-17 02:36:28 +00002164static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00002165 Parse *pParse, /* Parsing context */
2166 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
2167 WhereClause *pWC, /* The WHERE clause */
drh1db639c2008-01-17 02:36:28 +00002168 Bitmask notReady, /* Which parts of FROM have not yet been coded */
2169 int nExtraReg /* Number of extra registers to allocate */
drh51147ba2005-07-23 22:59:55 +00002170){
drh111a6a72008-12-21 03:51:16 +00002171 int nEq = pLevel->plan.nEq; /* The number of == or IN constraints to code */
2172 Vdbe *v = pParse->pVdbe; /* The vm under construction */
2173 Index *pIdx; /* The index being used for this loop */
drh51147ba2005-07-23 22:59:55 +00002174 int iCur = pLevel->iTabCur; /* The cursor of the table */
2175 WhereTerm *pTerm; /* A single constraint term */
2176 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00002177 int regBase; /* Base register */
drh6df2acd2008-12-28 16:55:25 +00002178 int nReg; /* Number of registers to allocate */
drh51147ba2005-07-23 22:59:55 +00002179
drh111a6a72008-12-21 03:51:16 +00002180 /* This module is only called on query plans that use an index. */
2181 assert( pLevel->plan.wsFlags & WHERE_INDEXED );
2182 pIdx = pLevel->plan.u.pIdx;
2183
drh51147ba2005-07-23 22:59:55 +00002184 /* Figure out how many memory cells we will need then allocate them.
drh51147ba2005-07-23 22:59:55 +00002185 */
drh700a2262008-12-17 19:22:15 +00002186 regBase = pParse->nMem + 1;
drh6df2acd2008-12-28 16:55:25 +00002187 nReg = pLevel->plan.nEq + nExtraReg;
2188 pParse->nMem += nReg;
drh51147ba2005-07-23 22:59:55 +00002189
2190 /* Evaluate the equality constraints
2191 */
drhc49de5d2007-01-19 01:06:01 +00002192 assert( pIdx->nColumn>=nEq );
2193 for(j=0; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00002194 int r1;
drh51147ba2005-07-23 22:59:55 +00002195 int k = pIdx->aiColumn[j];
drh111a6a72008-12-21 03:51:16 +00002196 pTerm = findTerm(pWC, iCur, k, notReady, pLevel->plan.wsFlags, pIdx);
drh34004ce2008-07-11 16:15:17 +00002197 if( NEVER(pTerm==0) ) break;
drh165be382008-12-05 02:36:33 +00002198 assert( (pTerm->wtFlags & TERM_CODED)==0 );
drh678ccce2008-03-31 18:19:54 +00002199 r1 = codeEqualityTerm(pParse, pTerm, pLevel, regBase+j);
2200 if( r1!=regBase+j ){
drh6df2acd2008-12-28 16:55:25 +00002201 if( nReg==1 ){
2202 sqlite3ReleaseTempReg(pParse, regBase);
2203 regBase = r1;
2204 }else{
2205 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
2206 }
drh678ccce2008-03-31 18:19:54 +00002207 }
drh981642f2008-04-19 14:40:43 +00002208 testcase( pTerm->eOperator & WO_ISNULL );
2209 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00002210 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drhb3190c12008-12-08 21:37:14 +00002211 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
drh51147ba2005-07-23 22:59:55 +00002212 }
2213 }
drh1db639c2008-01-17 02:36:28 +00002214 return regBase;
drh51147ba2005-07-23 22:59:55 +00002215}
2216
drh111a6a72008-12-21 03:51:16 +00002217/*
drh23d04d52008-12-23 23:56:22 +00002218** Return TRUE if the WhereClause pWC contains no terms that
2219** are not virtual and which have not been coded.
2220**
2221** To put it another way, return TRUE if no additional WHERE clauses
2222** tests are required in order to establish that the current row
2223** should go to output and return FALSE if there are some terms of
2224** the WHERE clause that need to be validated before outputing the row.
2225*/
2226static int whereRowReadyForOutput(WhereClause *pWC){
2227 WhereTerm *pTerm;
2228 int j;
2229
2230 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2231 if( (pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED))==0 ) return 0;
2232 }
2233 return 1;
2234}
2235
2236/*
drh111a6a72008-12-21 03:51:16 +00002237** Generate code for the start of the iLevel-th loop in the WHERE clause
2238** implementation described by pWInfo.
2239*/
2240static Bitmask codeOneLoopStart(
2241 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
2242 int iLevel, /* Which level of pWInfo->a[] should be coded */
2243 u8 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
2244 Bitmask notReady /* Which tables are currently available */
2245){
2246 int j, k; /* Loop counters */
2247 int iCur; /* The VDBE cursor for the table */
2248 int addrNxt; /* Where to jump to continue with the next IN case */
2249 int omitTable; /* True if we use the index only */
2250 int bRev; /* True if we need to scan in reverse order */
2251 WhereLevel *pLevel; /* The where level to be coded */
2252 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
2253 WhereTerm *pTerm; /* A WHERE clause term */
2254 Parse *pParse; /* Parsing context */
2255 Vdbe *v; /* The prepared stmt under constructions */
2256 struct SrcList_item *pTabItem; /* FROM clause term being coded */
drh23d04d52008-12-23 23:56:22 +00002257 int addrBrk; /* Jump here to break out of the loop */
2258 int addrCont; /* Jump here to continue with next cycle */
2259 int regRowSet; /* Write rowids to this RowSet if non-negative */
2260 int codeRowSetEarly; /* True if index fully constrains the search */
drh111a6a72008-12-21 03:51:16 +00002261
2262
2263 pParse = pWInfo->pParse;
2264 v = pParse->pVdbe;
2265 pWC = pWInfo->pWC;
2266 pLevel = &pWInfo->a[iLevel];
2267 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
2268 iCur = pTabItem->iCursor;
2269 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
2270 omitTable = (pLevel->plan.wsFlags & WHERE_IDX_ONLY)!=0;
drh23d04d52008-12-23 23:56:22 +00002271 regRowSet = pWInfo->regRowSet;
2272 codeRowSetEarly = 0;
drh111a6a72008-12-21 03:51:16 +00002273
2274 /* Create labels for the "break" and "continue" instructions
2275 ** for the current loop. Jump to addrBrk to break out of a loop.
2276 ** Jump to cont to go immediately to the next iteration of the
2277 ** loop.
2278 **
2279 ** When there is an IN operator, we also have a "addrNxt" label that
2280 ** means to continue with the next IN value combination. When
2281 ** there are no IN operators in the constraints, the "addrNxt" label
2282 ** is the same as "addrBrk".
2283 */
2284 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
2285 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
2286
2287 /* If this is the right table of a LEFT OUTER JOIN, allocate and
2288 ** initialize a memory cell that records if this table matches any
2289 ** row of the left table of the join.
2290 */
2291 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
2292 pLevel->iLeftJoin = ++pParse->nMem;
2293 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
2294 VdbeComment((v, "init LEFT JOIN no-match flag"));
2295 }
2296
2297#ifndef SQLITE_OMIT_VIRTUALTABLE
2298 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
2299 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
2300 ** to access the data.
2301 */
2302 int iReg; /* P3 Value for OP_VFilter */
2303 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
2304 int nConstraint = pVtabIdx->nConstraint;
2305 struct sqlite3_index_constraint_usage *aUsage =
2306 pVtabIdx->aConstraintUsage;
2307 const struct sqlite3_index_constraint *aConstraint =
2308 pVtabIdx->aConstraint;
2309
2310 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
2311 pParse->disableColCache++;
2312 for(j=1; j<=nConstraint; j++){
2313 for(k=0; k<nConstraint; k++){
2314 if( aUsage[k].argvIndex==j ){
2315 int iTerm = aConstraint[k].iTermOffset;
2316 assert( pParse->disableColCache );
2317 sqlite3ExprCode(pParse, pWC->a[iTerm].pExpr->pRight, iReg+j+1);
2318 break;
2319 }
2320 }
2321 if( k==nConstraint ) break;
2322 }
2323 assert( pParse->disableColCache );
2324 pParse->disableColCache--;
2325 sqlite3VdbeAddOp2(v, OP_Integer, pVtabIdx->idxNum, iReg);
2326 sqlite3VdbeAddOp2(v, OP_Integer, j-1, iReg+1);
2327 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrBrk, iReg, pVtabIdx->idxStr,
2328 pVtabIdx->needToFreeIdxStr ? P4_MPRINTF : P4_STATIC);
drh111a6a72008-12-21 03:51:16 +00002329 pVtabIdx->needToFreeIdxStr = 0;
2330 for(j=0; j<nConstraint; j++){
2331 if( aUsage[j].omit ){
2332 int iTerm = aConstraint[j].iTermOffset;
2333 disableTerm(pLevel, &pWC->a[iTerm]);
2334 }
2335 }
2336 pLevel->op = OP_VNext;
2337 pLevel->p1 = iCur;
2338 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh23d04d52008-12-23 23:56:22 +00002339 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2340 if( codeRowSetEarly ){
2341 sqlite3VdbeAddOp2(v, OP_VRowid, iCur, iReg);
2342 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, iReg);
2343 }
2344 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drh111a6a72008-12-21 03:51:16 +00002345 }else
2346#endif /* SQLITE_OMIT_VIRTUALTABLE */
2347
2348 if( pLevel->plan.wsFlags & WHERE_ROWID_EQ ){
2349 /* Case 1: We can directly reference a single row using an
2350 ** equality comparison against the ROWID field. Or
2351 ** we reference multiple rows using a "rowid IN (...)"
2352 ** construct.
2353 */
2354 int r1;
2355 int rtmp = sqlite3GetTempReg(pParse);
2356 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
2357 assert( pTerm!=0 );
2358 assert( pTerm->pExpr!=0 );
2359 assert( pTerm->leftCursor==iCur );
2360 assert( omitTable==0 );
2361 r1 = codeEqualityTerm(pParse, pTerm, pLevel, rtmp);
2362 addrNxt = pLevel->addrNxt;
2363 sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, addrNxt);
2364 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, r1);
drh23d04d52008-12-23 23:56:22 +00002365 codeRowSetEarly = (pWC->nTerm==1 && regRowSet>=0) ?1:0;
2366 if( codeRowSetEarly ){
2367 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2368 }
drh111a6a72008-12-21 03:51:16 +00002369 sqlite3ReleaseTempReg(pParse, rtmp);
2370 VdbeComment((v, "pk"));
2371 pLevel->op = OP_Noop;
2372 }else if( pLevel->plan.wsFlags & WHERE_ROWID_RANGE ){
2373 /* Case 2: We have an inequality comparison against the ROWID field.
2374 */
2375 int testOp = OP_Noop;
2376 int start;
2377 int memEndValue = 0;
2378 WhereTerm *pStart, *pEnd;
2379
2380 assert( omitTable==0 );
2381 pStart = findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0);
2382 pEnd = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0);
2383 if( bRev ){
2384 pTerm = pStart;
2385 pStart = pEnd;
2386 pEnd = pTerm;
2387 }
2388 if( pStart ){
2389 Expr *pX; /* The expression that defines the start bound */
2390 int r1, rTemp; /* Registers for holding the start boundary */
2391
2392 /* The following constant maps TK_xx codes into corresponding
2393 ** seek opcodes. It depends on a particular ordering of TK_xx
2394 */
2395 const u8 aMoveOp[] = {
2396 /* TK_GT */ OP_SeekGt,
2397 /* TK_LE */ OP_SeekLe,
2398 /* TK_LT */ OP_SeekLt,
2399 /* TK_GE */ OP_SeekGe
2400 };
2401 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
2402 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
2403 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
2404
2405 pX = pStart->pExpr;
2406 assert( pX!=0 );
2407 assert( pStart->leftCursor==iCur );
2408 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
2409 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
2410 VdbeComment((v, "pk"));
2411 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
2412 sqlite3ReleaseTempReg(pParse, rTemp);
2413 disableTerm(pLevel, pStart);
2414 }else{
2415 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
2416 }
2417 if( pEnd ){
2418 Expr *pX;
2419 pX = pEnd->pExpr;
2420 assert( pX!=0 );
2421 assert( pEnd->leftCursor==iCur );
2422 memEndValue = ++pParse->nMem;
2423 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
2424 if( pX->op==TK_LT || pX->op==TK_GT ){
2425 testOp = bRev ? OP_Le : OP_Ge;
2426 }else{
2427 testOp = bRev ? OP_Lt : OP_Gt;
2428 }
2429 disableTerm(pLevel, pEnd);
2430 }
2431 start = sqlite3VdbeCurrentAddr(v);
2432 pLevel->op = bRev ? OP_Prev : OP_Next;
2433 pLevel->p1 = iCur;
2434 pLevel->p2 = start;
drhca8c4662008-12-28 20:47:02 +00002435 pLevel->p5 = (pStart==0 && pEnd==0) ?1:0;
drh23d04d52008-12-23 23:56:22 +00002436 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2437 if( codeRowSetEarly || testOp!=OP_Noop ){
drh111a6a72008-12-21 03:51:16 +00002438 int r1 = sqlite3GetTempReg(pParse);
2439 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, r1);
drh23d04d52008-12-23 23:56:22 +00002440 if( testOp!=OP_Noop ){
2441 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, r1);
2442 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
2443 }
2444 if( codeRowSetEarly ){
2445 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2446 }
drh111a6a72008-12-21 03:51:16 +00002447 sqlite3ReleaseTempReg(pParse, r1);
2448 }
2449 }else if( pLevel->plan.wsFlags & (WHERE_COLUMN_RANGE|WHERE_COLUMN_EQ) ){
2450 /* Case 3: A scan using an index.
2451 **
2452 ** The WHERE clause may contain zero or more equality
2453 ** terms ("==" or "IN" operators) that refer to the N
2454 ** left-most columns of the index. It may also contain
2455 ** inequality constraints (>, <, >= or <=) on the indexed
2456 ** column that immediately follows the N equalities. Only
2457 ** the right-most column can be an inequality - the rest must
2458 ** use the "==" and "IN" operators. For example, if the
2459 ** index is on (x,y,z), then the following clauses are all
2460 ** optimized:
2461 **
2462 ** x=5
2463 ** x=5 AND y=10
2464 ** x=5 AND y<10
2465 ** x=5 AND y>5 AND y<10
2466 ** x=5 AND y=5 AND z<=10
2467 **
2468 ** The z<10 term of the following cannot be used, only
2469 ** the x=5 term:
2470 **
2471 ** x=5 AND z<10
2472 **
2473 ** N may be zero if there are inequality constraints.
2474 ** If there are no inequality constraints, then N is at
2475 ** least one.
2476 **
2477 ** This case is also used when there are no WHERE clause
2478 ** constraints but an index is selected anyway, in order
2479 ** to force the output order to conform to an ORDER BY.
2480 */
2481 int aStartOp[] = {
2482 0,
2483 0,
2484 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
2485 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
2486 OP_SeekGt, /* 4: (start_constraints && !startEq && !bRev) */
2487 OP_SeekLt, /* 5: (start_constraints && !startEq && bRev) */
2488 OP_SeekGe, /* 6: (start_constraints && startEq && !bRev) */
2489 OP_SeekLe /* 7: (start_constraints && startEq && bRev) */
2490 };
2491 int aEndOp[] = {
2492 OP_Noop, /* 0: (!end_constraints) */
2493 OP_IdxGE, /* 1: (end_constraints && !bRev) */
2494 OP_IdxLT /* 2: (end_constraints && bRev) */
2495 };
2496 int nEq = pLevel->plan.nEq;
2497 int isMinQuery = 0; /* If this is an optimized SELECT min(x).. */
2498 int regBase; /* Base register holding constraint values */
2499 int r1; /* Temp register */
2500 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
2501 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
2502 int startEq; /* True if range start uses ==, >= or <= */
2503 int endEq; /* True if range end uses ==, >= or <= */
2504 int start_constraints; /* Start of range is constrained */
2505 int nConstraint; /* Number of constraint terms */
2506 Index *pIdx; /* The index we will be using */
2507 int iIdxCur; /* The VDBE cursor for the index */
drh6df2acd2008-12-28 16:55:25 +00002508 int nExtraReg = 0; /* Number of extra registers needed */
2509 int op; /* Instruction opcode */
drh111a6a72008-12-21 03:51:16 +00002510
2511 pIdx = pLevel->plan.u.pIdx;
2512 iIdxCur = pLevel->iIdxCur;
2513 k = pIdx->aiColumn[nEq]; /* Column for inequality constraints */
2514
drh111a6a72008-12-21 03:51:16 +00002515 /* If this loop satisfies a sort order (pOrderBy) request that
2516 ** was passed to this function to implement a "SELECT min(x) ..."
2517 ** query, then the caller will only allow the loop to run for
2518 ** a single iteration. This means that the first row returned
2519 ** should not have a NULL value stored in 'x'. If column 'x' is
2520 ** the first one after the nEq equality constraints in the index,
2521 ** this requires some special handling.
2522 */
2523 if( (wctrlFlags&WHERE_ORDERBY_MIN)!=0
2524 && (pLevel->plan.wsFlags&WHERE_ORDERBY)
2525 && (pIdx->nColumn>nEq)
2526 ){
2527 /* assert( pOrderBy->nExpr==1 ); */
2528 /* assert( pOrderBy->a[0].pExpr->iColumn==pIdx->aiColumn[nEq] ); */
2529 isMinQuery = 1;
drh6df2acd2008-12-28 16:55:25 +00002530 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002531 }
2532
2533 /* Find any inequality constraint terms for the start and end
2534 ** of the range.
2535 */
2536 if( pLevel->plan.wsFlags & WHERE_TOP_LIMIT ){
2537 pRangeEnd = findTerm(pWC, iCur, k, notReady, (WO_LT|WO_LE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00002538 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002539 }
2540 if( pLevel->plan.wsFlags & WHERE_BTM_LIMIT ){
2541 pRangeStart = findTerm(pWC, iCur, k, notReady, (WO_GT|WO_GE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00002542 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002543 }
2544
drh6df2acd2008-12-28 16:55:25 +00002545 /* Generate code to evaluate all constraint terms using == or IN
2546 ** and store the values of those terms in an array of registers
2547 ** starting at regBase.
2548 */
2549 regBase = codeAllEqualityTerms(pParse, pLevel, pWC, notReady, nExtraReg);
2550 addrNxt = pLevel->addrNxt;
2551
2552
drh111a6a72008-12-21 03:51:16 +00002553 /* If we are doing a reverse order scan on an ascending index, or
2554 ** a forward order scan on a descending index, interchange the
2555 ** start and end terms (pRangeStart and pRangeEnd).
2556 */
2557 if( bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC) ){
2558 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
2559 }
2560
2561 testcase( pRangeStart && pRangeStart->eOperator & WO_LE );
2562 testcase( pRangeStart && pRangeStart->eOperator & WO_GE );
2563 testcase( pRangeEnd && pRangeEnd->eOperator & WO_LE );
2564 testcase( pRangeEnd && pRangeEnd->eOperator & WO_GE );
2565 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
2566 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
2567 start_constraints = pRangeStart || nEq>0;
2568
2569 /* Seek the index cursor to the start of the range. */
2570 nConstraint = nEq;
2571 if( pRangeStart ){
2572 int dcc = pParse->disableColCache;
2573 if( pRangeEnd ){
2574 pParse->disableColCache++;
2575 }
2576 sqlite3ExprCode(pParse, pRangeStart->pExpr->pRight, regBase+nEq);
2577 pParse->disableColCache = dcc;
2578 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2579 nConstraint++;
2580 }else if( isMinQuery ){
2581 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2582 nConstraint++;
2583 startEq = 0;
2584 start_constraints = 1;
2585 }
2586 codeApplyAffinity(pParse, regBase, nConstraint, pIdx);
2587 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
2588 assert( op!=0 );
2589 testcase( op==OP_Rewind );
2590 testcase( op==OP_Last );
2591 testcase( op==OP_SeekGt );
2592 testcase( op==OP_SeekGe );
2593 testcase( op==OP_SeekLe );
2594 testcase( op==OP_SeekLt );
2595 sqlite3VdbeAddOp4(v, op, iIdxCur, addrNxt, regBase,
2596 SQLITE_INT_TO_PTR(nConstraint), P4_INT32);
2597
2598 /* Load the value for the inequality constraint at the end of the
2599 ** range (if any).
2600 */
2601 nConstraint = nEq;
2602 if( pRangeEnd ){
2603 sqlite3ExprCode(pParse, pRangeEnd->pExpr->pRight, regBase+nEq);
2604 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2605 codeApplyAffinity(pParse, regBase, nEq+1, pIdx);
2606 nConstraint++;
2607 }
2608
2609 /* Top of the loop body */
2610 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2611
2612 /* Check if the index cursor is past the end of the range. */
2613 op = aEndOp[(pRangeEnd || nEq) * (1 + bRev)];
2614 testcase( op==OP_Noop );
2615 testcase( op==OP_IdxGE );
2616 testcase( op==OP_IdxLT );
drh6df2acd2008-12-28 16:55:25 +00002617 if( op!=OP_Noop ){
2618 sqlite3VdbeAddOp4(v, op, iIdxCur, addrNxt, regBase,
2619 SQLITE_INT_TO_PTR(nConstraint), P4_INT32);
2620 sqlite3VdbeChangeP5(v, endEq!=bRev ?1:0);
2621 }
drh111a6a72008-12-21 03:51:16 +00002622
2623 /* If there are inequality constraints, check that the value
2624 ** of the table column that the inequality contrains is not NULL.
2625 ** If it is, jump to the next iteration of the loop.
2626 */
2627 r1 = sqlite3GetTempReg(pParse);
2628 testcase( pLevel->plan.wsFlags & WHERE_BTM_LIMIT );
2629 testcase( pLevel->plan.wsFlags & WHERE_TOP_LIMIT );
2630 if( pLevel->plan.wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT) ){
2631 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, nEq, r1);
2632 sqlite3VdbeAddOp2(v, OP_IsNull, r1, addrCont);
2633 }
2634
2635 /* Seek the table cursor, if required */
drh23d04d52008-12-23 23:56:22 +00002636 disableTerm(pLevel, pRangeStart);
2637 disableTerm(pLevel, pRangeEnd);
2638 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2639 if( !omitTable || codeRowSetEarly ){
drh111a6a72008-12-21 03:51:16 +00002640 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, r1);
drh23d04d52008-12-23 23:56:22 +00002641 if( codeRowSetEarly ){
2642 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2643 }else{
2644 sqlite3VdbeAddOp2(v, OP_Seek, iCur, r1); /* Deferred seek */
2645 }
drh111a6a72008-12-21 03:51:16 +00002646 }
2647 sqlite3ReleaseTempReg(pParse, r1);
2648
2649 /* Record the instruction used to terminate the loop. Disable
2650 ** WHERE clause terms made redundant by the index range scan.
2651 */
2652 pLevel->op = bRev ? OP_Prev : OP_Next;
2653 pLevel->p1 = iIdxCur;
drhdd5f5a62008-12-23 13:35:23 +00002654 }else
2655
drh23d04d52008-12-23 23:56:22 +00002656#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00002657 if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drh111a6a72008-12-21 03:51:16 +00002658 /* Case 4: Two or more separately indexed terms connected by OR
2659 **
2660 ** Example:
2661 **
2662 ** CREATE TABLE t1(a,b,c,d);
2663 ** CREATE INDEX i1 ON t1(a);
2664 ** CREATE INDEX i2 ON t1(b);
2665 ** CREATE INDEX i3 ON t1(c);
2666 **
2667 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2668 **
2669 ** In the example, there are three indexed terms connected by OR.
2670 ** The top of the loop is constructed by creating a RowSet object
2671 ** and populating it. Then looping over elements of the rowset.
2672 **
2673 ** Null 1
2674 ** # fill RowSet 1 with entries where a=5 using i1
2675 ** # fill Rowset 1 with entries where b=7 using i2
2676 ** # fill Rowset 1 with entries where c=11 and d=13 i3 and t1
2677 ** A: RowSetRead 1, B, 2
2678 ** Seek i, 2
2679 **
2680 ** The bottom of the loop looks like this:
2681 **
2682 ** Goto 0, A
2683 ** B:
2684 */
drh23d04d52008-12-23 23:56:22 +00002685 int regOrRowset; /* Register holding the RowSet object */
drh111a6a72008-12-21 03:51:16 +00002686 int regNextRowid; /* Register holding next rowid */
2687 WhereTerm *pTerm; /* The complete OR-clause */
2688 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
2689 WhereTerm *pOrTerm; /* A single subterm within the OR-clause */
drhdd5f5a62008-12-23 13:35:23 +00002690 SrcList oneTab; /* Shortened table list */
drh111a6a72008-12-21 03:51:16 +00002691
2692 pTerm = pLevel->plan.u.pTerm;
2693 assert( pTerm!=0 );
2694 assert( pTerm->eOperator==WO_OR );
2695 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2696 pOrWc = &pTerm->u.pOrInfo->wc;
drh23d04d52008-12-23 23:56:22 +00002697 codeRowSetEarly = (regRowSet>=0 && pWC->nTerm==1) ?1:0;
2698
2699 if( codeRowSetEarly ){
2700 regOrRowset = regRowSet;
2701 }else{
2702 regOrRowset = sqlite3GetTempReg(pParse);
2703 sqlite3VdbeAddOp2(v, OP_Null, 0, regOrRowset);
2704 }
drhdd5f5a62008-12-23 13:35:23 +00002705 oneTab.nSrc = 1;
2706 oneTab.nAlloc = 1;
2707 oneTab.a[0] = *pTabItem;
2708 for(j=0, pOrTerm=pOrWc->a; j<pOrWc->nTerm; j++, pOrTerm++){
2709 WhereInfo *pSubWInfo;
drh29435252008-12-28 18:35:08 +00002710 if( pOrTerm->leftCursor!=iCur && pOrTerm->eOperator!=WO_AND ) continue;
drh23d04d52008-12-23 23:56:22 +00002711 pSubWInfo = sqlite3WhereBegin(pParse, &oneTab, pOrTerm->pExpr, 0,
drh6df2acd2008-12-28 16:55:25 +00002712 WHERE_FILL_ROWSET | WHERE_OMIT_OPEN | WHERE_OMIT_CLOSE,
2713 regOrRowset);
drhdd5f5a62008-12-23 13:35:23 +00002714 if( pSubWInfo ){
drhdd5f5a62008-12-23 13:35:23 +00002715 sqlite3WhereEnd(pSubWInfo);
2716 }
2717 }
drh111a6a72008-12-21 03:51:16 +00002718 sqlite3VdbeResolveLabel(v, addrCont);
drh23d04d52008-12-23 23:56:22 +00002719 if( !codeRowSetEarly ){
2720 regNextRowid = sqlite3GetTempReg(pParse);
2721 addrCont =
2722 sqlite3VdbeAddOp3(v, OP_RowSetRead, regOrRowset,addrBrk,regNextRowid);
2723 sqlite3VdbeAddOp2(v, OP_Seek, iCur, regNextRowid);
2724 sqlite3ReleaseTempReg(pParse, regNextRowid);
2725 /* sqlite3ReleaseTempReg(pParse, regOrRowset); // Preserve the RowSet */
2726 pLevel->op = OP_Goto;
2727 pLevel->p2 = addrCont;
2728 }
2729 disableTerm(pLevel, pTerm);
drhdd5f5a62008-12-23 13:35:23 +00002730 }else
drh23d04d52008-12-23 23:56:22 +00002731#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00002732
2733 {
drh111a6a72008-12-21 03:51:16 +00002734 /* Case 5: There is no usable index. We must do a complete
2735 ** scan of the entire table.
2736 */
2737 assert( omitTable==0 );
2738 assert( bRev==0 );
2739 pLevel->op = OP_Next;
2740 pLevel->p1 = iCur;
2741 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, OP_Rewind, iCur, addrBrk);
2742 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
drh23d04d52008-12-23 23:56:22 +00002743 codeRowSetEarly = 0;
drh111a6a72008-12-21 03:51:16 +00002744 }
2745 notReady &= ~getMask(pWC->pMaskSet, iCur);
2746
2747 /* Insert code to test every subexpression that can be completely
2748 ** computed using the current set of tables.
2749 */
2750 k = 0;
2751 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2752 Expr *pE;
2753 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2754 testcase( pTerm->wtFlags & TERM_CODED );
2755 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2756 if( (pTerm->prereqAll & notReady)!=0 ) continue;
2757 pE = pTerm->pExpr;
2758 assert( pE!=0 );
2759 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
2760 continue;
2761 }
2762 pParse->disableColCache += k;
2763 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2764 pParse->disableColCache -= k;
2765 k = 1;
2766 pTerm->wtFlags |= TERM_CODED;
2767 }
2768
2769 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2770 ** at least one row of the right table has matched the left table.
2771 */
2772 if( pLevel->iLeftJoin ){
2773 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2774 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2775 VdbeComment((v, "record LEFT JOIN hit"));
2776 sqlite3ExprClearColumnCache(pParse, pLevel->iTabCur);
2777 sqlite3ExprClearColumnCache(pParse, pLevel->iIdxCur);
2778 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
2779 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2780 testcase( pTerm->wtFlags & TERM_CODED );
2781 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2782 if( (pTerm->prereqAll & notReady)!=0 ) continue;
2783 assert( pTerm->pExpr );
2784 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2785 pTerm->wtFlags |= TERM_CODED;
2786 }
2787 }
drh23d04d52008-12-23 23:56:22 +00002788
2789 /*
2790 ** If it was requested to store the results in a rowset and that has
2791 ** not already been do, then do so now.
2792 */
2793 if( regRowSet>=0 && !codeRowSetEarly ){
2794 int r1 = sqlite3GetTempReg(pParse);
2795#ifndef SQLITE_OMIT_VIRTUALTABLE
2796 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
2797 sqlite3VdbeAddOp2(v, OP_VRowid, iCur, r1);
2798 }else
2799#endif
2800 {
2801 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, r1);
2802 }
2803 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2804 sqlite3ReleaseTempReg(pParse, r1);
2805 }
2806
drh111a6a72008-12-21 03:51:16 +00002807 return notReady;
2808}
2809
drh549c8b62005-09-19 13:15:23 +00002810#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00002811/*
2812** The following variable holds a text description of query plan generated
2813** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
2814** overwrites the previous. This information is used for testing and
2815** analysis only.
2816*/
2817char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
2818static int nQPlan = 0; /* Next free slow in _query_plan[] */
2819
2820#endif /* SQLITE_TEST */
2821
2822
drh9eff6162006-06-12 21:59:13 +00002823/*
2824** Free a WhereInfo structure
2825*/
drh10fe8402008-10-11 16:47:35 +00002826static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh9eff6162006-06-12 21:59:13 +00002827 if( pWInfo ){
2828 int i;
2829 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00002830 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
2831 if( pInfo ){
danielk197780442942008-12-24 11:25:39 +00002832 assert( pInfo->needToFreeIdxStr==0 || db->mallocFailed );
2833 if( pInfo->needToFreeIdxStr ){
2834 sqlite3_free(pInfo->idxStr);
2835 }
drh633e6d52008-07-28 19:34:53 +00002836 sqlite3DbFree(db, pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00002837 }
drh9eff6162006-06-12 21:59:13 +00002838 }
drh111a6a72008-12-21 03:51:16 +00002839 whereClauseClear(pWInfo->pWC);
drh633e6d52008-07-28 19:34:53 +00002840 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00002841 }
2842}
2843
drh94a11212004-09-25 13:12:14 +00002844
2845/*
drhe3184742002-06-19 14:27:05 +00002846** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00002847** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00002848** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00002849** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00002850** in order to complete the WHERE clause processing.
2851**
2852** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00002853**
2854** The basic idea is to do a nested loop, one loop for each table in
2855** the FROM clause of a select. (INSERT and UPDATE statements are the
2856** same as a SELECT with only a single table in the FROM clause.) For
2857** example, if the SQL is this:
2858**
2859** SELECT * FROM t1, t2, t3 WHERE ...;
2860**
2861** Then the code generated is conceptually like the following:
2862**
2863** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00002864** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00002865** foreach row3 in t3 do /
2866** ...
2867** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00002868** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00002869** end /
2870**
drh29dda4a2005-07-21 18:23:20 +00002871** Note that the loops might not be nested in the order in which they
2872** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00002873** use of indices. Note also that when the IN operator appears in
2874** the WHERE clause, it might result in additional nested loops for
2875** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00002876**
drhc27a1ce2002-06-14 20:58:45 +00002877** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00002878** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
2879** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00002880** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00002881**
drhe6f85e72004-12-25 01:03:13 +00002882** The code that sqlite3WhereBegin() generates leaves the cursors named
2883** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00002884** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00002885** data from the various tables of the loop.
2886**
drhc27a1ce2002-06-14 20:58:45 +00002887** If the WHERE clause is empty, the foreach loops must each scan their
2888** entire tables. Thus a three-way join is an O(N^3) operation. But if
2889** the tables have indices and there are terms in the WHERE clause that
2890** refer to those indices, a complete table scan can be avoided and the
2891** code will run much faster. Most of the work of this routine is checking
2892** to see if there are indices that can be used to speed up the loop.
2893**
2894** Terms of the WHERE clause are also used to limit which rows actually
2895** make it to the "..." in the middle of the loop. After each "foreach",
2896** terms of the WHERE clause that use only terms in that loop and outer
2897** loops are evaluated and if false a jump is made around all subsequent
2898** inner loops (or around the "..." if the test occurs within the inner-
2899** most loop)
2900**
2901** OUTER JOINS
2902**
2903** An outer join of tables t1 and t2 is conceptally coded as follows:
2904**
2905** foreach row1 in t1 do
2906** flag = 0
2907** foreach row2 in t2 do
2908** start:
2909** ...
2910** flag = 1
2911** end
drhe3184742002-06-19 14:27:05 +00002912** if flag==0 then
2913** move the row2 cursor to a null row
2914** goto start
2915** fi
drhc27a1ce2002-06-14 20:58:45 +00002916** end
2917**
drhe3184742002-06-19 14:27:05 +00002918** ORDER BY CLAUSE PROCESSING
2919**
2920** *ppOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
2921** if there is one. If there is no ORDER BY clause or if this routine
2922** is called from an UPDATE or DELETE statement, then ppOrderBy is NULL.
2923**
2924** If an index can be used so that the natural output order of the table
2925** scan is correct for the ORDER BY clause, then that index is used and
2926** *ppOrderBy is set to NULL. This is an optimization that prevents an
2927** unnecessary sort of the result set if an index appropriate for the
2928** ORDER BY clause already exists.
2929**
2930** If the where clause loops cannot be arranged to provide the correct
2931** output order, then the *ppOrderBy is unchanged.
drh75897232000-05-29 14:26:00 +00002932*/
danielk19774adee202004-05-08 08:23:19 +00002933WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00002934 Parse *pParse, /* The parser context */
2935 SrcList *pTabList, /* A list of all tables to be scanned */
2936 Expr *pWhere, /* The WHERE clause */
danielk1977a9d1ccb2008-01-05 17:39:29 +00002937 ExprList **ppOrderBy, /* An ORDER BY clause, or NULL */
drh23d04d52008-12-23 23:56:22 +00002938 u8 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
2939 int regRowSet /* Register hold RowSet if WHERE_FILL_ROWSET is set */
drh75897232000-05-29 14:26:00 +00002940){
2941 int i; /* Loop counter */
2942 WhereInfo *pWInfo; /* Will become the return value of this function */
2943 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhfe05af82005-07-21 03:14:59 +00002944 Bitmask notReady; /* Cursors that are not yet positioned */
drh111a6a72008-12-21 03:51:16 +00002945 WhereMaskSet *pMaskSet; /* The expression mask set */
drh111a6a72008-12-21 03:51:16 +00002946 WhereClause *pWC; /* Decomposition of the WHERE clause */
drh9012bcb2004-12-19 00:11:35 +00002947 struct SrcList_item *pTabItem; /* A single entry from pTabList */
2948 WhereLevel *pLevel; /* A single level in the pWInfo list */
drh29dda4a2005-07-21 18:23:20 +00002949 int iFrom; /* First unused FROM clause element */
drh111a6a72008-12-21 03:51:16 +00002950 int andFlags; /* AND-ed combination of all pWC->a[].wtFlags */
drh17435752007-08-16 04:30:38 +00002951 sqlite3 *db; /* Database connection */
danielk1977a9d1ccb2008-01-05 17:39:29 +00002952 ExprList *pOrderBy = 0;
drh75897232000-05-29 14:26:00 +00002953
drh29dda4a2005-07-21 18:23:20 +00002954 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00002955 ** bits in a Bitmask
2956 */
drh29dda4a2005-07-21 18:23:20 +00002957 if( pTabList->nSrc>BMS ){
2958 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00002959 return 0;
2960 }
2961
danielk1977a9d1ccb2008-01-05 17:39:29 +00002962 if( ppOrderBy ){
2963 pOrderBy = *ppOrderBy;
2964 }
2965
drh75897232000-05-29 14:26:00 +00002966 /* Allocate and initialize the WhereInfo structure that will become the
2967 ** return value.
2968 */
drh17435752007-08-16 04:30:38 +00002969 db = pParse->db;
2970 pWInfo = sqlite3DbMallocZero(db,
drh111a6a72008-12-21 03:51:16 +00002971 sizeof(WhereInfo)
2972 + (pTabList->nSrc-1)*sizeof(WhereLevel)
2973 + sizeof(WhereClause)
2974 + sizeof(WhereMaskSet)
2975 );
drh17435752007-08-16 04:30:38 +00002976 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00002977 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00002978 }
danielk197770b6d572006-06-19 04:49:34 +00002979 pWInfo->nLevel = pTabList->nSrc;
drh75897232000-05-29 14:26:00 +00002980 pWInfo->pParse = pParse;
2981 pWInfo->pTabList = pTabList;
danielk19774adee202004-05-08 08:23:19 +00002982 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh23d04d52008-12-23 23:56:22 +00002983 pWInfo->regRowSet = (wctrlFlags & WHERE_FILL_ROWSET) ? regRowSet : -1;
drh111a6a72008-12-21 03:51:16 +00002984 pWInfo->pWC = pWC = (WhereClause*)&pWInfo->a[pWInfo->nLevel];
drh6df2acd2008-12-28 16:55:25 +00002985 pWInfo->wctrlFlags = wctrlFlags;
drh111a6a72008-12-21 03:51:16 +00002986 pMaskSet = (WhereMaskSet*)&pWC[1];
drh08192d52002-04-30 19:20:28 +00002987
drh111a6a72008-12-21 03:51:16 +00002988 /* Split the WHERE clause into separate subexpressions where each
2989 ** subexpression is separated by an AND operator.
2990 */
2991 initMaskSet(pMaskSet);
2992 whereClauseInit(pWC, pParse, pMaskSet);
2993 sqlite3ExprCodeConstants(pParse, pWhere);
2994 whereSplit(pWC, pWhere, TK_AND);
2995
drh08192d52002-04-30 19:20:28 +00002996 /* Special case: a WHERE clause that is constant. Evaluate the
2997 ** expression and either jump over all of the code or fall thru.
2998 */
drh0a168372007-06-08 00:20:47 +00002999 if( pWhere && (pTabList->nSrc==0 || sqlite3ExprIsConstantNotJoin(pWhere)) ){
drh35573352008-01-08 23:54:25 +00003000 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, SQLITE_JUMPIFNULL);
drhdf199a22002-06-14 22:38:41 +00003001 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00003002 }
drh75897232000-05-29 14:26:00 +00003003
drh42165be2008-03-26 14:56:34 +00003004 /* Assign a bit from the bitmask to every term in the FROM clause.
3005 **
3006 ** When assigning bitmask values to FROM clause cursors, it must be
3007 ** the case that if X is the bitmask for the N-th FROM clause term then
3008 ** the bitmask for all FROM clause terms to the left of the N-th term
3009 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
3010 ** its Expr.iRightJoinTable value to find the bitmask of the right table
3011 ** of the join. Subtracting one from the right table bitmask gives a
3012 ** bitmask for all tables to the left of the join. Knowing the bitmask
3013 ** for all tables to the left of a left join is important. Ticket #3015.
3014 */
3015 for(i=0; i<pTabList->nSrc; i++){
drh111a6a72008-12-21 03:51:16 +00003016 createMask(pMaskSet, pTabList->a[i].iCursor);
drh42165be2008-03-26 14:56:34 +00003017 }
3018#ifndef NDEBUG
3019 {
3020 Bitmask toTheLeft = 0;
3021 for(i=0; i<pTabList->nSrc; i++){
drh111a6a72008-12-21 03:51:16 +00003022 Bitmask m = getMask(pMaskSet, pTabList->a[i].iCursor);
drh42165be2008-03-26 14:56:34 +00003023 assert( (m-1)==toTheLeft );
3024 toTheLeft |= m;
3025 }
3026 }
3027#endif
3028
drh29dda4a2005-07-21 18:23:20 +00003029 /* Analyze all of the subexpressions. Note that exprAnalyze() might
3030 ** add new virtual terms onto the end of the WHERE clause. We do not
3031 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00003032 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00003033 */
drh111a6a72008-12-21 03:51:16 +00003034 exprAnalyzeAll(pTabList, pWC);
drh17435752007-08-16 04:30:38 +00003035 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00003036 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00003037 }
drh75897232000-05-29 14:26:00 +00003038
drh29dda4a2005-07-21 18:23:20 +00003039 /* Chose the best index to use for each table in the FROM clause.
3040 **
drh51147ba2005-07-23 22:59:55 +00003041 ** This loop fills in the following fields:
3042 **
3043 ** pWInfo->a[].pIdx The index to use for this level of the loop.
drh165be382008-12-05 02:36:33 +00003044 ** pWInfo->a[].wsFlags WHERE_xxx flags associated with pIdx
drh51147ba2005-07-23 22:59:55 +00003045 ** pWInfo->a[].nEq The number of == and IN constraints
danielk197785574e32008-10-06 05:32:18 +00003046 ** pWInfo->a[].iFrom Which term of the FROM clause is being coded
drh51147ba2005-07-23 22:59:55 +00003047 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
3048 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
drh111a6a72008-12-21 03:51:16 +00003049 ** pWInfo->a[].pTerm When wsFlags==WO_OR, the OR-clause term
drh51147ba2005-07-23 22:59:55 +00003050 **
3051 ** This loop also figures out the nesting order of tables in the FROM
3052 ** clause.
drh75897232000-05-29 14:26:00 +00003053 */
drhfe05af82005-07-21 03:14:59 +00003054 notReady = ~(Bitmask)0;
drh9012bcb2004-12-19 00:11:35 +00003055 pTabItem = pTabList->a;
3056 pLevel = pWInfo->a;
drh943af3c2005-07-29 19:43:58 +00003057 andFlags = ~0;
drh4f0c5872007-03-26 22:05:01 +00003058 WHERETRACE(("*** Optimizer Start ***\n"));
drh29dda4a2005-07-21 18:23:20 +00003059 for(i=iFrom=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
drh111a6a72008-12-21 03:51:16 +00003060 WhereCost bestPlan; /* Most efficient plan seen so far */
drh29dda4a2005-07-21 18:23:20 +00003061 Index *pIdx; /* Index for FROM table at pTabItem */
drh29dda4a2005-07-21 18:23:20 +00003062 int j; /* For looping over FROM tables */
drh02afc862006-01-20 18:10:57 +00003063 int bestJ = 0; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00003064 Bitmask m; /* Bitmask value for j or bestJ */
drh570b9352006-02-01 02:45:02 +00003065 int once = 0; /* True when first table is seen */
drh29dda4a2005-07-21 18:23:20 +00003066
drh111a6a72008-12-21 03:51:16 +00003067 memset(&bestPlan, 0, sizeof(bestPlan));
3068 bestPlan.rCost = SQLITE_BIG_DBL;
drh29dda4a2005-07-21 18:23:20 +00003069 for(j=iFrom, pTabItem=&pTabList->a[j]; j<pTabList->nSrc; j++, pTabItem++){
drhdf26fd52006-06-06 11:45:54 +00003070 int doNotReorder; /* True if this table should not be reordered */
drh111a6a72008-12-21 03:51:16 +00003071 WhereCost sCost; /* Cost information from bestIndex() */
drhdf26fd52006-06-06 11:45:54 +00003072
drh61dfc312006-12-16 16:25:15 +00003073 doNotReorder = (pTabItem->jointype & (JT_LEFT|JT_CROSS))!=0;
drhdf26fd52006-06-06 11:45:54 +00003074 if( once && doNotReorder ) break;
drh111a6a72008-12-21 03:51:16 +00003075 m = getMask(pMaskSet, pTabItem->iCursor);
drh29dda4a2005-07-21 18:23:20 +00003076 if( (m & notReady)==0 ){
3077 if( j==iFrom ) iFrom++;
3078 continue;
3079 }
drh9eff6162006-06-12 21:59:13 +00003080 assert( pTabItem->pTab );
3081#ifndef SQLITE_OMIT_VIRTUALTABLE
drh4cbdda92006-06-14 19:00:20 +00003082 if( IsVirtual(pTabItem->pTab) ){
drh111a6a72008-12-21 03:51:16 +00003083 sqlite3_index_info *pVtabIdx; /* Current virtual index */
drh6d209d82006-06-27 01:54:26 +00003084 sqlite3_index_info **ppIdxInfo = &pWInfo->a[j].pIdxInfo;
drh111a6a72008-12-21 03:51:16 +00003085 sCost.rCost = bestVirtualIndex(pParse, pWC, pTabItem, notReady,
3086 ppOrderBy ? *ppOrderBy : 0, i==0,
3087 ppIdxInfo);
3088 sCost.plan.wsFlags = WHERE_VIRTUALTABLE;
3089 sCost.plan.u.pVtabIdx = pVtabIdx = *ppIdxInfo;
3090 if( pVtabIdx && pVtabIdx->orderByConsumed ){
3091 sCost.plan.wsFlags = WHERE_VIRTUALTABLE | WHERE_ORDERBY;
drh1a90e092006-06-14 22:07:10 +00003092 }
drh111a6a72008-12-21 03:51:16 +00003093 sCost.plan.nEq = 0;
3094 if( (SQLITE_BIG_DBL/2.0)<sCost.rCost ){
danielk19778efe5412007-03-02 08:12:22 +00003095 /* The cost is not allowed to be larger than SQLITE_BIG_DBL (the
3096 ** inital value of lowestCost in this loop. If it is, then
drh111a6a72008-12-21 03:51:16 +00003097 ** the (cost<lowestCost) test below will never be true.
danielk19778efe5412007-03-02 08:12:22 +00003098 */
drh111a6a72008-12-21 03:51:16 +00003099 sCost.rCost = (SQLITE_BIG_DBL/2.0);
danielk19778efe5412007-03-02 08:12:22 +00003100 }
drh9eff6162006-06-12 21:59:13 +00003101 }else
3102#endif
3103 {
drh111a6a72008-12-21 03:51:16 +00003104 bestIndex(pParse, pWC, pTabItem, notReady,
3105 (i==0 && ppOrderBy) ? *ppOrderBy : 0, &sCost);
drh9eff6162006-06-12 21:59:13 +00003106 }
drh111a6a72008-12-21 03:51:16 +00003107 if( sCost.rCost<bestPlan.rCost ){
drh570b9352006-02-01 02:45:02 +00003108 once = 1;
drh111a6a72008-12-21 03:51:16 +00003109 bestPlan = sCost;
drh29dda4a2005-07-21 18:23:20 +00003110 bestJ = j;
3111 }
drhdf26fd52006-06-06 11:45:54 +00003112 if( doNotReorder ) break;
drh29dda4a2005-07-21 18:23:20 +00003113 }
drhcb041342008-06-12 00:07:29 +00003114 WHERETRACE(("*** Optimizer selects table %d for loop %d\n", bestJ,
drh3dec2232005-09-10 15:28:09 +00003115 pLevel-pWInfo->a));
drh111a6a72008-12-21 03:51:16 +00003116 if( (bestPlan.plan.wsFlags & WHERE_ORDERBY)!=0 ){
drhfe05af82005-07-21 03:14:59 +00003117 *ppOrderBy = 0;
drhc4a3c772001-04-04 11:48:57 +00003118 }
drh111a6a72008-12-21 03:51:16 +00003119 andFlags &= bestPlan.plan.wsFlags;
3120 pLevel->plan = bestPlan.plan;
3121 if( bestPlan.plan.wsFlags & WHERE_INDEXED ){
drh9012bcb2004-12-19 00:11:35 +00003122 pLevel->iIdxCur = pParse->nTab++;
drhfe05af82005-07-21 03:14:59 +00003123 }else{
3124 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00003125 }
drh111a6a72008-12-21 03:51:16 +00003126 notReady &= ~getMask(pMaskSet, pTabList->a[bestJ].iCursor);
drh29dda4a2005-07-21 18:23:20 +00003127 pLevel->iFrom = bestJ;
danielk197785574e32008-10-06 05:32:18 +00003128
3129 /* Check that if the table scanned by this loop iteration had an
3130 ** INDEXED BY clause attached to it, that the named index is being
3131 ** used for the scan. If not, then query compilation has failed.
3132 ** Return an error.
3133 */
3134 pIdx = pTabList->a[bestJ].pIndex;
drh111a6a72008-12-21 03:51:16 +00003135 assert( !pIdx
3136 || (bestPlan.plan.wsFlags&WHERE_INDEXED)==0
3137 || pIdx==bestPlan.plan.u.pIdx );
3138 if( pIdx
3139 && ((bestPlan.plan.wsFlags & WHERE_INDEXED)==0
3140 || bestPlan.plan.u.pIdx!=pIdx)
3141 ){
danielk197785574e32008-10-06 05:32:18 +00003142 sqlite3ErrorMsg(pParse, "cannot use index: %s", pIdx->zName);
3143 goto whereBeginError;
3144 }
drh75897232000-05-29 14:26:00 +00003145 }
drh4f0c5872007-03-26 22:05:01 +00003146 WHERETRACE(("*** Optimizer Finished ***\n"));
danielk197780442942008-12-24 11:25:39 +00003147 if( db->mallocFailed ){
3148 goto whereBeginError;
3149 }
drh75897232000-05-29 14:26:00 +00003150
drh943af3c2005-07-29 19:43:58 +00003151 /* If the total query only selects a single row, then the ORDER BY
3152 ** clause is irrelevant.
3153 */
3154 if( (andFlags & WHERE_UNIQUE)!=0 && ppOrderBy ){
3155 *ppOrderBy = 0;
3156 }
3157
drh08c88eb2008-04-10 13:33:18 +00003158 /* If the caller is an UPDATE or DELETE statement that is requesting
3159 ** to use a one-pass algorithm, determine if this is appropriate.
3160 ** The one-pass algorithm only works if the WHERE clause constraints
3161 ** the statement to update a single row.
3162 */
drh165be382008-12-05 02:36:33 +00003163 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
3164 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 && (andFlags & WHERE_UNIQUE)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00003165 pWInfo->okOnePass = 1;
drh111a6a72008-12-21 03:51:16 +00003166 pWInfo->a[0].plan.wsFlags &= ~WHERE_IDX_ONLY;
drh08c88eb2008-04-10 13:33:18 +00003167 }
3168
drh9012bcb2004-12-19 00:11:35 +00003169 /* Open all tables in the pTabList and any indices selected for
3170 ** searching those tables.
3171 */
3172 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh29dda4a2005-07-21 18:23:20 +00003173 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00003174 Table *pTab; /* Table to open */
danielk1977da184232006-01-05 11:34:32 +00003175 int iDb; /* Index of database containing table/index */
drh9012bcb2004-12-19 00:11:35 +00003176
drhecc92422005-09-10 16:46:12 +00003177#ifndef SQLITE_OMIT_EXPLAIN
3178 if( pParse->explain==2 ){
3179 char *zMsg;
3180 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
danielk19771e536952007-08-16 10:09:01 +00003181 zMsg = sqlite3MPrintf(db, "TABLE %s", pItem->zName);
drhecc92422005-09-10 16:46:12 +00003182 if( pItem->zAlias ){
drh633e6d52008-07-28 19:34:53 +00003183 zMsg = sqlite3MAppendf(db, zMsg, "%s AS %s", zMsg, pItem->zAlias);
drhecc92422005-09-10 16:46:12 +00003184 }
drh111a6a72008-12-21 03:51:16 +00003185 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3186 zMsg = sqlite3MAppendf(db, zMsg, "%s WITH INDEX %s",
3187 zMsg, pLevel->plan.u.pIdx->zName);
3188 }else if( pLevel->plan.wsFlags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh633e6d52008-07-28 19:34:53 +00003189 zMsg = sqlite3MAppendf(db, zMsg, "%s USING PRIMARY KEY", zMsg);
drhecc92422005-09-10 16:46:12 +00003190 }
drh9eff6162006-06-12 21:59:13 +00003191#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00003192 else if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
3193 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
drh633e6d52008-07-28 19:34:53 +00003194 zMsg = sqlite3MAppendf(db, zMsg, "%s VIRTUAL TABLE INDEX %d:%s", zMsg,
drh111a6a72008-12-21 03:51:16 +00003195 pVtabIdx->idxNum, pVtabIdx->idxStr);
drh9eff6162006-06-12 21:59:13 +00003196 }
3197#endif
drh111a6a72008-12-21 03:51:16 +00003198 if( pLevel->plan.wsFlags & WHERE_ORDERBY ){
drh633e6d52008-07-28 19:34:53 +00003199 zMsg = sqlite3MAppendf(db, zMsg, "%s ORDER BY", zMsg);
drhe2b39092006-04-21 09:38:36 +00003200 }
drh66a51672008-01-03 00:01:23 +00003201 sqlite3VdbeAddOp4(v, OP_Explain, i, pLevel->iFrom, 0, zMsg, P4_DYNAMIC);
drhecc92422005-09-10 16:46:12 +00003202 }
3203#endif /* SQLITE_OMIT_EXPLAIN */
drh29dda4a2005-07-21 18:23:20 +00003204 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00003205 pTab = pTabItem->pTab;
danielk1977da184232006-01-05 11:34:32 +00003206 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drh7d10d5a2008-08-20 16:35:10 +00003207 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ) continue;
drh9eff6162006-06-12 21:59:13 +00003208#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00003209 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
danielk197793626f42006-06-20 13:07:27 +00003210 int iCur = pTabItem->iCursor;
drh66a51672008-01-03 00:01:23 +00003211 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0,
3212 (const char*)pTab->pVtab, P4_VTAB);
drh9eff6162006-06-12 21:59:13 +00003213 }else
3214#endif
drh6df2acd2008-12-28 16:55:25 +00003215 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
3216 && (wctrlFlags & WHERE_OMIT_OPEN)==0 ){
drh08c88eb2008-04-10 13:33:18 +00003217 int op = pWInfo->okOnePass ? OP_OpenWrite : OP_OpenRead;
3218 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
danielk197723432972008-11-17 16:42:00 +00003219 if( !pWInfo->okOnePass && pTab->nCol<BMS ){
danielk19779792eef2006-01-13 15:58:43 +00003220 Bitmask b = pTabItem->colUsed;
3221 int n = 0;
drh74161702006-02-24 02:53:49 +00003222 for(; b; b=b>>1, n++){}
danielk1977cd3e8f72008-03-25 09:47:35 +00003223 sqlite3VdbeChangeP2(v, sqlite3VdbeCurrentAddr(v)-2, n);
danielk19779792eef2006-01-13 15:58:43 +00003224 assert( n<=pTab->nCol );
3225 }
danielk1977c00da102006-01-07 13:21:04 +00003226 }else{
3227 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00003228 }
3229 pLevel->iTabCur = pTabItem->iCursor;
drh111a6a72008-12-21 03:51:16 +00003230 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3231 Index *pIx = pLevel->plan.u.pIdx;
danielk1977b3bf5562006-01-10 17:58:23 +00003232 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
drh111a6a72008-12-21 03:51:16 +00003233 int iIdxCur = pLevel->iIdxCur;
danielk1977da184232006-01-05 11:34:32 +00003234 assert( pIx->pSchema==pTab->pSchema );
drh111a6a72008-12-21 03:51:16 +00003235 assert( iIdxCur>=0 );
danielk1977cd3e8f72008-03-25 09:47:35 +00003236 sqlite3VdbeAddOp2(v, OP_SetNumColumns, 0, pIx->nColumn+1);
danielk1977207872a2008-01-03 07:54:23 +00003237 sqlite3VdbeAddOp4(v, OP_OpenRead, iIdxCur, pIx->tnum, iDb,
drh66a51672008-01-03 00:01:23 +00003238 (char*)pKey, P4_KEYINFO_HANDOFF);
danielk1977207872a2008-01-03 07:54:23 +00003239 VdbeComment((v, "%s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00003240 }
danielk1977da184232006-01-05 11:34:32 +00003241 sqlite3CodeVerifySchema(pParse, iDb);
drh9012bcb2004-12-19 00:11:35 +00003242 }
3243 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
3244
drh29dda4a2005-07-21 18:23:20 +00003245 /* Generate the code to do the search. Each iteration of the for
3246 ** loop below generates code for a single nested loop of the VM
3247 ** program.
drh75897232000-05-29 14:26:00 +00003248 */
drhfe05af82005-07-21 03:14:59 +00003249 notReady = ~(Bitmask)0;
drh111a6a72008-12-21 03:51:16 +00003250 for(i=0; i<pTabList->nSrc; i++){
3251 notReady = codeOneLoopStart(pWInfo, i, wctrlFlags, notReady);
drh75897232000-05-29 14:26:00 +00003252 }
drh111a6a72008-12-21 03:51:16 +00003253 pWInfo->iContinue = pWInfo->a[i-1].addrCont;
drh7ec764a2005-07-21 03:48:20 +00003254
3255#ifdef SQLITE_TEST /* For testing and debugging use only */
3256 /* Record in the query plan information about the current table
3257 ** and the index used to access it (if any). If the table itself
3258 ** is not used, its name is just '{}'. If no index is used
3259 ** the index is listed as "{}". If the primary key is used the
3260 ** index name is '*'.
3261 */
3262 for(i=0; i<pTabList->nSrc; i++){
3263 char *z;
3264 int n;
drh7ec764a2005-07-21 03:48:20 +00003265 pLevel = &pWInfo->a[i];
drh29dda4a2005-07-21 18:23:20 +00003266 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00003267 z = pTabItem->zAlias;
3268 if( z==0 ) z = pTabItem->pTab->zName;
drhea678832008-12-10 19:26:22 +00003269 n = sqlite3Strlen30(z);
drh7ec764a2005-07-21 03:48:20 +00003270 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
drh111a6a72008-12-21 03:51:16 +00003271 if( pLevel->plan.wsFlags & WHERE_IDX_ONLY ){
drh5bb3eb92007-05-04 13:15:55 +00003272 memcpy(&sqlite3_query_plan[nQPlan], "{}", 2);
drh7ec764a2005-07-21 03:48:20 +00003273 nQPlan += 2;
3274 }else{
drh5bb3eb92007-05-04 13:15:55 +00003275 memcpy(&sqlite3_query_plan[nQPlan], z, n);
drh7ec764a2005-07-21 03:48:20 +00003276 nQPlan += n;
3277 }
3278 sqlite3_query_plan[nQPlan++] = ' ';
3279 }
drh111a6a72008-12-21 03:51:16 +00003280 testcase( pLevel->plan.wsFlags & WHERE_ROWID_EQ );
3281 testcase( pLevel->plan.wsFlags & WHERE_ROWID_RANGE );
3282 if( pLevel->plan.wsFlags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh5bb3eb92007-05-04 13:15:55 +00003283 memcpy(&sqlite3_query_plan[nQPlan], "* ", 2);
drh7ec764a2005-07-21 03:48:20 +00003284 nQPlan += 2;
drh111a6a72008-12-21 03:51:16 +00003285 }else if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3286 n = sqlite3Strlen30(pLevel->plan.u.pIdx->zName);
drh7ec764a2005-07-21 03:48:20 +00003287 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
drh111a6a72008-12-21 03:51:16 +00003288 memcpy(&sqlite3_query_plan[nQPlan], pLevel->plan.u.pIdx->zName, n);
drh7ec764a2005-07-21 03:48:20 +00003289 nQPlan += n;
3290 sqlite3_query_plan[nQPlan++] = ' ';
3291 }
drh111a6a72008-12-21 03:51:16 +00003292 }else{
3293 memcpy(&sqlite3_query_plan[nQPlan], "{} ", 3);
3294 nQPlan += 3;
drh7ec764a2005-07-21 03:48:20 +00003295 }
3296 }
3297 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
3298 sqlite3_query_plan[--nQPlan] = 0;
3299 }
3300 sqlite3_query_plan[nQPlan] = 0;
3301 nQPlan = 0;
3302#endif /* SQLITE_TEST // Testing and debugging use only */
3303
drh29dda4a2005-07-21 18:23:20 +00003304 /* Record the continuation address in the WhereInfo structure. Then
3305 ** clean up and return.
3306 */
drh75897232000-05-29 14:26:00 +00003307 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00003308
3309 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00003310whereBeginError:
drh10fe8402008-10-11 16:47:35 +00003311 whereInfoFree(db, pWInfo);
drhe23399f2005-07-22 00:31:39 +00003312 return 0;
drh75897232000-05-29 14:26:00 +00003313}
3314
3315/*
drhc27a1ce2002-06-14 20:58:45 +00003316** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00003317** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00003318*/
danielk19774adee202004-05-08 08:23:19 +00003319void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00003320 Parse *pParse = pWInfo->pParse;
3321 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00003322 int i;
drh6b563442001-11-07 16:48:26 +00003323 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00003324 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00003325 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00003326
drh9012bcb2004-12-19 00:11:35 +00003327 /* Generate loop termination code.
3328 */
drh633e6d52008-07-28 19:34:53 +00003329 sqlite3ExprClearColumnCache(pParse, -1);
drhad3cab52002-05-24 02:04:32 +00003330 for(i=pTabList->nSrc-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00003331 pLevel = &pWInfo->a[i];
drhb3190c12008-12-08 21:37:14 +00003332 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00003333 if( pLevel->op!=OP_Noop ){
drh66a51672008-01-03 00:01:23 +00003334 sqlite3VdbeAddOp2(v, pLevel->op, pLevel->p1, pLevel->p2);
drhd1d38482008-10-07 23:46:38 +00003335 sqlite3VdbeChangeP5(v, pLevel->p5);
drh19a775c2000-06-05 18:54:46 +00003336 }
drh111a6a72008-12-21 03:51:16 +00003337 if( pLevel->plan.wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
drh72e8fa42007-03-28 14:30:06 +00003338 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00003339 int j;
drhb3190c12008-12-08 21:37:14 +00003340 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh111a6a72008-12-21 03:51:16 +00003341 for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00003342 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
3343 sqlite3VdbeAddOp2(v, OP_Next, pIn->iCur, pIn->addrInTop);
3344 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00003345 }
drh111a6a72008-12-21 03:51:16 +00003346 sqlite3DbFree(db, pLevel->u.in.aInLoop);
drhd99f7062002-06-08 23:25:08 +00003347 }
drhb3190c12008-12-08 21:37:14 +00003348 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhad2d8302002-05-24 20:31:36 +00003349 if( pLevel->iLeftJoin ){
3350 int addr;
drh3c84ddf2008-01-09 02:15:38 +00003351 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin);
3352 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
drh9012bcb2004-12-19 00:11:35 +00003353 if( pLevel->iIdxCur>=0 ){
drh3c84ddf2008-01-09 02:15:38 +00003354 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00003355 }
drhb3190c12008-12-08 21:37:14 +00003356 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
drhd654be82005-09-20 17:42:23 +00003357 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00003358 }
drh19a775c2000-06-05 18:54:46 +00003359 }
drh9012bcb2004-12-19 00:11:35 +00003360
3361 /* The "break" point is here, just past the end of the outer loop.
3362 ** Set it.
3363 */
danielk19774adee202004-05-08 08:23:19 +00003364 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00003365
drh29dda4a2005-07-21 18:23:20 +00003366 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00003367 */
drh29dda4a2005-07-21 18:23:20 +00003368 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
3369 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00003370 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00003371 assert( pTab!=0 );
drh7d10d5a2008-08-20 16:35:10 +00003372 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ) continue;
drh6df2acd2008-12-28 16:55:25 +00003373 if( (pWInfo->wctrlFlags & WHERE_OMIT_CLOSE)==0 ){
3374 if( !pWInfo->okOnePass && (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0 ){
3375 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
3376 }
3377 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3378 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
3379 }
drh9012bcb2004-12-19 00:11:35 +00003380 }
3381
danielk197721de2e72007-11-29 17:43:27 +00003382 /* If this scan uses an index, make code substitutions to read data
3383 ** from the index in preference to the table. Sometimes, this means
3384 ** the table need never be read from. This is a performance boost,
3385 ** as the vdbe level waits until the table is read before actually
3386 ** seeking the table cursor to the record corresponding to the current
3387 ** position in the index.
drh9012bcb2004-12-19 00:11:35 +00003388 **
3389 ** Calls to the code generator in between sqlite3WhereBegin and
3390 ** sqlite3WhereEnd will have created code that references the table
3391 ** directly. This loop scans all that code looking for opcodes
3392 ** that reference the table and converts them into opcodes that
3393 ** reference the index.
3394 */
drh111a6a72008-12-21 03:51:16 +00003395 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
danielk1977f0113002006-01-24 12:09:17 +00003396 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00003397 VdbeOp *pOp;
drh111a6a72008-12-21 03:51:16 +00003398 Index *pIdx = pLevel->plan.u.pIdx;
3399 int useIndexOnly = pLevel->plan.wsFlags & WHERE_IDX_ONLY;
drh9012bcb2004-12-19 00:11:35 +00003400
3401 assert( pIdx!=0 );
3402 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
3403 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00003404 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00003405 if( pOp->p1!=pLevel->iTabCur ) continue;
3406 if( pOp->opcode==OP_Column ){
drh9012bcb2004-12-19 00:11:35 +00003407 for(j=0; j<pIdx->nColumn; j++){
3408 if( pOp->p2==pIdx->aiColumn[j] ){
3409 pOp->p2 = j;
danielk197721de2e72007-11-29 17:43:27 +00003410 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00003411 break;
3412 }
3413 }
danielk197721de2e72007-11-29 17:43:27 +00003414 assert(!useIndexOnly || j<pIdx->nColumn);
drhf0863fe2005-06-12 21:35:51 +00003415 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00003416 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00003417 pOp->opcode = OP_IdxRowid;
danielk197721de2e72007-11-29 17:43:27 +00003418 }else if( pOp->opcode==OP_NullRow && useIndexOnly ){
danielk19776c18b6e2005-01-30 09:17:58 +00003419 pOp->opcode = OP_Noop;
drh9012bcb2004-12-19 00:11:35 +00003420 }
3421 }
drh6b563442001-11-07 16:48:26 +00003422 }
drh19a775c2000-06-05 18:54:46 +00003423 }
drh9012bcb2004-12-19 00:11:35 +00003424
3425 /* Final cleanup
3426 */
drh10fe8402008-10-11 16:47:35 +00003427 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00003428 return;
3429}