blob: fdadc3e7387e7ceacb841abf77a8bf8265edb51e [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** This module contains C code that generates VDBE code used to process
drh909626d2008-05-30 14:58:37 +000013** the WHERE clause of SQL statements. This module is responsible for
drh51669862004-12-18 18:40:26 +000014** generating the code that loops through a table looking for applicable
15** rows. Indices are selected and used to speed the search when doing
16** so is applicable. Because this module is responsible for selecting
17** indices, you might also think of this module as the "query optimizer".
drh75897232000-05-29 14:26:00 +000018*/
19#include "sqliteInt.h"
20
drh7924f3e2011-02-09 03:04:27 +000021
22/*
drh51147ba2005-07-23 22:59:55 +000023** Trace output macros
24*/
25#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
drhcef4fc82012-09-21 22:50:45 +000026/***/ int sqlite3WhereTrace = 0;
drhe8f52c52008-07-12 14:52:20 +000027#endif
drhcef4fc82012-09-21 22:50:45 +000028#if defined(SQLITE_DEBUG) \
29 && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE))
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;
drhf1b5f5b2013-05-02 00:15:01 +000042typedef struct WhereLoop WhereLoop;
43typedef struct WherePath WherePath;
44typedef struct WhereTerm WhereTerm;
drh1c8148f2013-05-04 20:25:23 +000045typedef struct WhereLoopBuilder WhereLoopBuilder;
46typedef struct WhereScan WhereScan;
drh5346e952013-05-08 14:14:26 +000047typedef struct WhereVtabPlan WhereVtabPlan;
48
drhf1b5f5b2013-05-02 00:15:01 +000049
50/*
51** Each instance of this object represents a way of evaluating one
52** term of a join. The WhereClause object holds a table of these
drh6b7157b2013-05-10 02:00:35 +000053** objects using (maskSelf,prereq,) as the primary key. Note that the
drhf1b5f5b2013-05-02 00:15:01 +000054** same join term might have multiple associated WhereLoop objects.
55*/
56struct WhereLoop {
57 Bitmask prereq; /* Bitmask of other loops that must run first */
drha18f3d22013-05-08 03:05:41 +000058 Bitmask maskSelf; /* Bitmask identifying table iTab */
drh5346e952013-05-08 14:14:26 +000059 u16 iTab; /* Index of the table coded by this loop */
60 u16 nTerm; /* Number of entries in aTerm[] */
drh6b7157b2013-05-10 02:00:35 +000061 u32 wsFlags; /* WHERE_* flags describing the plan */
drhf1b5f5b2013-05-02 00:15:01 +000062 double rSetup; /* One-time setup cost (ex: create transient index) */
63 double rRun; /* Cost of running each loop */
64 double nOut; /* Estimated number of output rows */
drh5346e952013-05-08 14:14:26 +000065 union {
66 struct { /* Information for internal btree tables */
67 int nEq; /* Number of equality constraints */
68 Index *pIndex; /* Index used, or NULL */
69 } btree;
drh6b7157b2013-05-10 02:00:35 +000070 struct { /* Information for virtual tables */
drh5346e952013-05-08 14:14:26 +000071 int idxNum; /* Index number */
drh6b7157b2013-05-10 02:00:35 +000072 u8 needFree; /* True if sqlite3_free(idxStr) is needed */
73 u8 isOrdered; /* True if satisfies ORDER BY */
drh5346e952013-05-08 14:14:26 +000074 char *idxStr; /* Index identifier string */
75 } vtab;
76 } u;
drh1c8148f2013-05-04 20:25:23 +000077 WhereTerm **aTerm; /* WhereTerms used */
drhf1b5f5b2013-05-02 00:15:01 +000078 WhereLoop *pNextLoop; /* Next WhereLoop object in the WhereClause */
79};
80
81/*
82** Each instance of this object holds a sequence of WhereLoop objects
83** that implement some or all of the entire query plan.
84*/
85struct WherePath {
86 Bitmask maskLoop; /* Bitmask of all WhereLoop objects in this path */
87 double nRow; /* Estimated number of rows generated by this path */
88 double rCost; /* Total cost of this path */
drh6b7157b2013-05-10 02:00:35 +000089 u8 isOrdered; /* True if this path satisfies ORDER BY */
90 u8 isOrderedValid; /* True if the isOrdered field is valid */
drha18f3d22013-05-08 03:05:41 +000091 WhereLoop **aLoop; /* Array of WhereLoop objects implementing this path */
drhf1b5f5b2013-05-02 00:15:01 +000092};
drh0aa74ed2005-07-16 13:33:20 +000093
94/*
drh75897232000-05-29 14:26:00 +000095** The query generator uses an array of instances of this structure to
96** help it analyze the subexpressions of the WHERE clause. Each WHERE
drh61495262009-04-22 15:32:59 +000097** clause subexpression is separated from the others by AND operators,
98** usually, or sometimes subexpressions separated by OR.
drh51669862004-12-18 18:40:26 +000099**
drh0fcef5e2005-07-19 17:38:22 +0000100** All WhereTerms are collected into a single WhereClause structure.
101** The following identity holds:
drh51669862004-12-18 18:40:26 +0000102**
drh0fcef5e2005-07-19 17:38:22 +0000103** WhereTerm.pWC->a[WhereTerm.idx] == WhereTerm
drh51669862004-12-18 18:40:26 +0000104**
drh0fcef5e2005-07-19 17:38:22 +0000105** When a term is of the form:
106**
107** X <op> <expr>
108**
109** where X is a column name and <op> is one of certain operators,
drh700a2262008-12-17 19:22:15 +0000110** then WhereTerm.leftCursor and WhereTerm.u.leftColumn record the
111** cursor number and column number for X. WhereTerm.eOperator records
drh51147ba2005-07-23 22:59:55 +0000112** the <op> using a bitmask encoding defined by WO_xxx below. The
113** use of a bitmask encoding for the operator allows us to search
114** quickly for terms that match any of several different operators.
drh0fcef5e2005-07-19 17:38:22 +0000115**
drh700a2262008-12-17 19:22:15 +0000116** A WhereTerm might also be two or more subterms connected by OR:
117**
118** (t1.X <op> <expr>) OR (t1.Y <op> <expr>) OR ....
119**
120** In this second case, wtFlag as the TERM_ORINFO set and eOperator==WO_OR
121** and the WhereTerm.u.pOrInfo field points to auxiliary information that
122** is collected about the
123**
124** If a term in the WHERE clause does not match either of the two previous
125** categories, then eOperator==0. The WhereTerm.pExpr field is still set
126** to the original subexpression content and wtFlags is set up appropriately
127** but no other fields in the WhereTerm object are meaningful.
128**
129** When eOperator!=0, prereqRight and prereqAll record sets of cursor numbers,
drh111a6a72008-12-21 03:51:16 +0000130** but they do so indirectly. A single WhereMaskSet structure translates
drh51669862004-12-18 18:40:26 +0000131** cursor number into bits and the translated bit is stored in the prereq
132** fields. The translation is used in order to maximize the number of
133** bits that will fit in a Bitmask. The VDBE cursor numbers might be
134** spread out over the non-negative integers. For example, the cursor
drh111a6a72008-12-21 03:51:16 +0000135** numbers might be 3, 8, 9, 10, 20, 23, 41, and 45. The WhereMaskSet
drh51669862004-12-18 18:40:26 +0000136** translates these sparse cursor numbers into consecutive integers
137** beginning with 0 in order to make the best possible use of the available
138** bits in the Bitmask. So, in the example above, the cursor numbers
139** would be mapped into integers 0 through 7.
drh6a1e0712008-12-05 15:24:15 +0000140**
141** The number of terms in a join is limited by the number of bits
142** in prereqRight and prereqAll. The default is 64 bits, hence SQLite
143** is only able to process joins with 64 or fewer tables.
drh75897232000-05-29 14:26:00 +0000144*/
drh0aa74ed2005-07-16 13:33:20 +0000145struct WhereTerm {
drh165be382008-12-05 02:36:33 +0000146 Expr *pExpr; /* Pointer to the subexpression that is this term */
drhec1724e2008-12-09 01:32:03 +0000147 int iParent; /* Disable pWC->a[iParent] when this term disabled */
148 int leftCursor; /* Cursor number of X in "X <op> <expr>" */
drh700a2262008-12-17 19:22:15 +0000149 union {
150 int leftColumn; /* Column number of X in "X <op> <expr>" */
drh7a5bcc02013-01-16 17:08:58 +0000151 WhereOrInfo *pOrInfo; /* Extra information if (eOperator & WO_OR)!=0 */
152 WhereAndInfo *pAndInfo; /* Extra information if (eOperator& WO_AND)!=0 */
drh700a2262008-12-17 19:22:15 +0000153 } u;
drhb52076c2006-01-23 13:22:09 +0000154 u16 eOperator; /* A WO_xx value describing <op> */
drh165be382008-12-05 02:36:33 +0000155 u8 wtFlags; /* TERM_xxx bit flags. See below */
drh45b1ee42005-08-02 17:48:22 +0000156 u8 nChild; /* Number of children that must disable us */
drh0fcef5e2005-07-19 17:38:22 +0000157 WhereClause *pWC; /* The clause this term is part of */
drh165be382008-12-05 02:36:33 +0000158 Bitmask prereqRight; /* Bitmask of tables used by pExpr->pRight */
159 Bitmask prereqAll; /* Bitmask of tables referenced by pExpr */
drh75897232000-05-29 14:26:00 +0000160};
161
162/*
drh165be382008-12-05 02:36:33 +0000163** Allowed values of WhereTerm.wtFlags
drh0aa74ed2005-07-16 13:33:20 +0000164*/
drh633e6d52008-07-28 19:34:53 +0000165#define TERM_DYNAMIC 0x01 /* Need to call sqlite3ExprDelete(db, pExpr) */
drh6c30be82005-07-29 15:10:17 +0000166#define TERM_VIRTUAL 0x02 /* Added by the optimizer. Do not code */
167#define TERM_CODED 0x04 /* This term is already coded */
drh45b1ee42005-08-02 17:48:22 +0000168#define TERM_COPIED 0x08 /* Has a child */
drh700a2262008-12-17 19:22:15 +0000169#define TERM_ORINFO 0x10 /* Need to free the WhereTerm.u.pOrInfo object */
170#define TERM_ANDINFO 0x20 /* Need to free the WhereTerm.u.pAndInfo obj */
171#define TERM_OR_OK 0x40 /* Used during OR-clause processing */
drhfaacf172011-08-12 01:51:45 +0000172#ifdef SQLITE_ENABLE_STAT3
drh59b61882011-02-11 02:43:14 +0000173# define TERM_VNULL 0x80 /* Manufactured x>NULL or x<=NULL term */
174#else
drhd3ed7342011-09-21 00:09:41 +0000175# define TERM_VNULL 0x00 /* Disabled if not using stat3 */
drh59b61882011-02-11 02:43:14 +0000176#endif
drh0aa74ed2005-07-16 13:33:20 +0000177
178/*
drh1c8148f2013-05-04 20:25:23 +0000179** An instance of the WhereScan object is used as an iterator for locating
180** terms in the WHERE clause that are useful to the query planner.
181*/
182struct WhereScan {
183 WhereTerm *pCurrent; /* Most recent match */
184 WhereClause *pOrigWC; /* Original, innermost WhereClause */
185 WhereClause *pWC; /* WhereClause currently being scanned */
186 char *zCollName; /* Must have this collating sequence, if not NULL */
187 char idxaff; /* Must match this affinity, if zCollName!=NULL */
188 unsigned char nEquiv; /* Number of entries in aEquiv[] */
189 unsigned char iEquiv; /* Next unused slot in aEquiv[] */
190 u32 opMask; /* Acceptable operators */
191 int k; /* Resume scanning at this->pWC->a[this->k] */
192 int aEquiv[22]; /* Cursor,Column pairs for equivalence classes */
193};
194
195/*
drh0aa74ed2005-07-16 13:33:20 +0000196** An instance of the following structure holds all information about a
197** WHERE clause. Mostly this is a container for one or more WhereTerms.
drh8871ef52011-10-07 13:33:10 +0000198**
199** Explanation of pOuter: For a WHERE clause of the form
200**
201** a AND ((b AND c) OR (d AND e)) AND f
202**
203** There are separate WhereClause objects for the whole clause and for
204** the subclauses "(b AND c)" and "(d AND e)". The pOuter field of the
205** subclauses points to the WhereClause object for the whole clause.
drh0aa74ed2005-07-16 13:33:20 +0000206*/
drh0aa74ed2005-07-16 13:33:20 +0000207struct WhereClause {
drhfe05af82005-07-21 03:14:59 +0000208 Parse *pParse; /* The parser context */
drh111a6a72008-12-21 03:51:16 +0000209 WhereMaskSet *pMaskSet; /* Mapping of table cursor numbers to bitmasks */
drh8871ef52011-10-07 13:33:10 +0000210 WhereClause *pOuter; /* Outer conjunction */
drh29435252008-12-28 18:35:08 +0000211 u8 op; /* Split operator. TK_AND or TK_OR */
drh9ef61f42011-10-07 14:40:59 +0000212 u16 wctrlFlags; /* Might include WHERE_AND_ONLY */
drh0aa74ed2005-07-16 13:33:20 +0000213 int nTerm; /* Number of terms */
214 int nSlot; /* Number of entries in a[] */
drh51147ba2005-07-23 22:59:55 +0000215 WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
drh50d654d2009-06-03 01:24:54 +0000216#if defined(SQLITE_SMALL_STACK)
217 WhereTerm aStatic[1]; /* Initial static space for a[] */
218#else
219 WhereTerm aStatic[8]; /* Initial static space for a[] */
220#endif
drhe23399f2005-07-22 00:31:39 +0000221};
222
223/*
drh700a2262008-12-17 19:22:15 +0000224** A WhereTerm with eOperator==WO_OR has its u.pOrInfo pointer set to
225** a dynamically allocated instance of the following structure.
226*/
227struct WhereOrInfo {
drh111a6a72008-12-21 03:51:16 +0000228 WhereClause wc; /* Decomposition into subterms */
drh1a58fe02008-12-20 02:06:13 +0000229 Bitmask indexable; /* Bitmask of all indexable tables in the clause */
drh700a2262008-12-17 19:22:15 +0000230};
231
232/*
233** A WhereTerm with eOperator==WO_AND has its u.pAndInfo pointer set to
234** a dynamically allocated instance of the following structure.
235*/
236struct WhereAndInfo {
drh29435252008-12-28 18:35:08 +0000237 WhereClause wc; /* The subexpression broken out */
drh700a2262008-12-17 19:22:15 +0000238};
239
240/*
drh6a3ea0e2003-05-02 14:32:12 +0000241** An instance of the following structure keeps track of a mapping
drh0aa74ed2005-07-16 13:33:20 +0000242** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
drh51669862004-12-18 18:40:26 +0000243**
244** The VDBE cursor numbers are small integers contained in
245** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
246** clause, the cursor numbers might not begin with 0 and they might
247** contain gaps in the numbering sequence. But we want to make maximum
248** use of the bits in our bitmasks. This structure provides a mapping
249** from the sparse cursor numbers into consecutive integers beginning
250** with 0.
251**
drh111a6a72008-12-21 03:51:16 +0000252** If WhereMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
drh51669862004-12-18 18:40:26 +0000253** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
254**
255** For example, if the WHERE clause expression used these VDBE
drh111a6a72008-12-21 03:51:16 +0000256** cursors: 4, 5, 8, 29, 57, 73. Then the WhereMaskSet structure
drh51669862004-12-18 18:40:26 +0000257** would map those cursor numbers into bits 0 through 5.
258**
259** Note that the mapping is not necessarily ordered. In the example
260** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
261** 57->5, 73->4. Or one of 719 other combinations might be used. It
262** does not really matter. What is important is that sparse cursor
263** numbers all get mapped into bit numbers that begin with 0 and contain
264** no gaps.
drh6a3ea0e2003-05-02 14:32:12 +0000265*/
drh111a6a72008-12-21 03:51:16 +0000266struct WhereMaskSet {
drh1398ad32005-01-19 23:24:50 +0000267 int n; /* Number of assigned cursor values */
danielk197723432972008-11-17 16:42:00 +0000268 int ix[BMS]; /* Cursor assigned to each bit */
drh6a3ea0e2003-05-02 14:32:12 +0000269};
270
drh111a6a72008-12-21 03:51:16 +0000271/*
272** A WhereCost object records a lookup strategy and the estimated
273** cost of pursuing that strategy.
274*/
275struct WhereCost {
276 WherePlan plan; /* The lookup strategy */
277 double rCost; /* Overall cost of pursuing this search strategy */
dan5236ac12009-08-13 07:09:33 +0000278 Bitmask used; /* Bitmask of cursors used by this plan */
drh111a6a72008-12-21 03:51:16 +0000279};
drh0aa74ed2005-07-16 13:33:20 +0000280
drh6a3ea0e2003-05-02 14:32:12 +0000281/*
drh1c8148f2013-05-04 20:25:23 +0000282** This object is a factory for WhereLoop objects for a particular query.
283*/
284struct WhereLoopBuilder {
285 WhereInfo *pWInfo; /* Information about this WHERE */
286 sqlite3 *db; /* Database connection */
287 Parse *pParse; /* Parsing context */
288 WhereClause *pWC; /* WHERE clause terms */
289 SrcList *pTabList; /* FROM clause */
290 ExprList *pOrderBy; /* ORDER BY clause */
291 WhereLoop *pNew; /* Template WhereLoop */
drhcf8fa7a2013-05-10 20:26:22 +0000292 WhereLoop *pBest; /* If non-NULL, store single best loop here */
drheb04de32013-05-10 15:16:30 +0000293 int mxTerm; /* Maximum number of aTerm[] entries on pNew */
drh1c8148f2013-05-04 20:25:23 +0000294};
295
296/*
drh51147ba2005-07-23 22:59:55 +0000297** Bitmasks for the operators that indices are able to exploit. An
298** OR-ed combination of these values can be used when searching for
299** terms in the where clause.
300*/
drh165be382008-12-05 02:36:33 +0000301#define WO_IN 0x001
302#define WO_EQ 0x002
drh51147ba2005-07-23 22:59:55 +0000303#define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
304#define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
305#define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
306#define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
drh165be382008-12-05 02:36:33 +0000307#define WO_MATCH 0x040
308#define WO_ISNULL 0x080
drh700a2262008-12-17 19:22:15 +0000309#define WO_OR 0x100 /* Two or more OR-connected terms */
310#define WO_AND 0x200 /* Two or more AND-connected terms */
drh7a5bcc02013-01-16 17:08:58 +0000311#define WO_EQUIV 0x400 /* Of the form A==B, both columns */
drh534230c2011-01-22 00:10:45 +0000312#define WO_NOOP 0x800 /* This term does not restrict search space */
drh51147ba2005-07-23 22:59:55 +0000313
drhec1724e2008-12-09 01:32:03 +0000314#define WO_ALL 0xfff /* Mask of all possible WO_* values */
drh1a58fe02008-12-20 02:06:13 +0000315#define WO_SINGLE 0x0ff /* Mask of all non-compound WO_* values */
drhec1724e2008-12-09 01:32:03 +0000316
drh51147ba2005-07-23 22:59:55 +0000317/*
drh700a2262008-12-17 19:22:15 +0000318** Value for wsFlags returned by bestIndex() and stored in
319** WhereLevel.wsFlags. These flags determine which search
320** strategies are appropriate.
drh51147ba2005-07-23 22:59:55 +0000321*/
drh6b7157b2013-05-10 02:00:35 +0000322#define WHERE_ROWID_EQ 0x00000001 /* rowid=EXPR or rowid IN (...) */
323#define WHERE_ROWID_RANGE 0x00000002 /* rowid<EXPR and/or rowid>EXPR */
324#define WHERE_NULL_OK 0x00000004 /* Ok to use WO_ISNULL */
325#define WHERE_IPK 0x00000008 /* x is the INTEGER PRIMARY KEY */
326#define WHERE_COLUMN_EQ 0x00000010 /* x=EXPR or x IN (...) or x IS NULL */
327#define WHERE_COLUMN_RANGE 0x00000020 /* x<EXPR and/or x>EXPR */
328#define WHERE_COLUMN_IN 0x00000040 /* x IN (...) */
329#define WHERE_COLUMN_NULL 0x00000080 /* x IS NULL */
330#define WHERE_INDEXED 0x000000f0 /* Anything that uses an index */
331#define WHERE_NOT_FULLSCAN 0x000200f3 /* Does not do a full table scan */
332#define WHERE_IN_ABLE 0x000100f1 /* Able to support an IN operator */
333#define WHERE_TOP_LIMIT 0x00000100 /* x<EXPR or x<=EXPR constraint */
334#define WHERE_BTM_LIMIT 0x00000200 /* x>EXPR or x>=EXPR constraint */
335#define WHERE_BOTH_LIMIT 0x00000300 /* Both x>EXPR and x<EXPR */
336#define WHERE_IDX_ONLY 0x00000400 /* Use index only - omit table */
337#define WHERE_ORDERED 0x00000800 /* Output will appear in correct order */
338#define WHERE_REVERSE 0x00001000 /* Scan in reverse order */
339#define WHERE_UNIQUE 0x00002000 /* Selects no more than one row */
340#define WHERE_ALL_UNIQUE 0x00004000 /* This and all prior have one row */
341#define WHERE_OB_UNIQUE 0x00008000 /* Values in ORDER BY columns are
drh8a1b87c2013-03-27 15:04:28 +0000342 ** different for every output row */
drh6b7157b2013-05-10 02:00:35 +0000343#define WHERE_VIRTUALTABLE 0x00010000 /* Use virtual-table processing */
344#define WHERE_MULTI_OR 0x00020000 /* OR using multiple indices */
345#define WHERE_TEMP_INDEX 0x00040000 /* Uses an ephemeral index */
346#define WHERE_DISTINCT 0x00080000 /* Correct order for DISTINCT */
347#define WHERE_COVER_SCAN 0x00100000 /* Full scan of a covering index */
348#define WHERE_SINGLE_ROW 0x00200000 /* No more than one row guaranteed */
drh51147ba2005-07-23 22:59:55 +0000349
350/*
drh56f1b992012-09-25 14:29:39 +0000351** This module contains many separate subroutines that work together to
352** find the best indices to use for accessing a particular table in a query.
353** An instance of the following structure holds context information about the
354** index search so that it can be more easily passed between the various
355** routines.
356*/
357typedef struct WhereBestIdx WhereBestIdx;
358struct WhereBestIdx {
359 Parse *pParse; /* Parser context */
360 WhereClause *pWC; /* The WHERE clause */
361 struct SrcList_item *pSrc; /* The FROM clause term to search */
362 Bitmask notReady; /* Mask of cursors not available */
363 Bitmask notValid; /* Cursors not available for any purpose */
364 ExprList *pOrderBy; /* The ORDER BY clause */
365 ExprList *pDistinct; /* The select-list if query is DISTINCT */
366 sqlite3_index_info **ppIdxInfo; /* Index information passed to xBestIndex */
drh9cd1c992012-09-25 20:43:35 +0000367 int i, n; /* Which loop is being coded; # of loops */
drh46c35f92012-09-26 23:17:01 +0000368 WhereLevel *aLevel; /* Info about outer loops */
drh56f1b992012-09-25 14:29:39 +0000369 WhereCost cost; /* Lowest cost query plan */
370};
371
372/*
drhd663b5b2012-10-03 00:25:54 +0000373** Return TRUE if the probe cost is less than the baseline cost
374*/
375static int compareCost(const WhereCost *pProbe, const WhereCost *pBaseline){
376 if( pProbe->rCost<pBaseline->rCost ) return 1;
377 if( pProbe->rCost>pBaseline->rCost ) return 0;
378 if( pProbe->plan.nOBSat>pBaseline->plan.nOBSat ) return 1;
379 if( pProbe->plan.nRow<pBaseline->plan.nRow ) return 1;
380 return 0;
381}
382
383/*
drh0aa74ed2005-07-16 13:33:20 +0000384** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000385*/
drh7b4fc6a2007-02-06 13:26:32 +0000386static void whereClauseInit(
387 WhereClause *pWC, /* The WhereClause to be initialized */
388 Parse *pParse, /* The parsing context */
drh9ef61f42011-10-07 14:40:59 +0000389 WhereMaskSet *pMaskSet, /* Mapping from table cursor numbers to bitmasks */
390 u16 wctrlFlags /* Might include WHERE_AND_ONLY */
drh7b4fc6a2007-02-06 13:26:32 +0000391){
drhfe05af82005-07-21 03:14:59 +0000392 pWC->pParse = pParse;
drh7b4fc6a2007-02-06 13:26:32 +0000393 pWC->pMaskSet = pMaskSet;
drh8871ef52011-10-07 13:33:10 +0000394 pWC->pOuter = 0;
drh0aa74ed2005-07-16 13:33:20 +0000395 pWC->nTerm = 0;
drhcad651e2007-04-20 12:22:01 +0000396 pWC->nSlot = ArraySize(pWC->aStatic);
drh0aa74ed2005-07-16 13:33:20 +0000397 pWC->a = pWC->aStatic;
drh9ef61f42011-10-07 14:40:59 +0000398 pWC->wctrlFlags = wctrlFlags;
drh0aa74ed2005-07-16 13:33:20 +0000399}
400
drh700a2262008-12-17 19:22:15 +0000401/* Forward reference */
402static void whereClauseClear(WhereClause*);
403
404/*
405** Deallocate all memory associated with a WhereOrInfo object.
406*/
407static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000408 whereClauseClear(&p->wc);
409 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000410}
411
412/*
413** Deallocate all memory associated with a WhereAndInfo object.
414*/
415static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000416 whereClauseClear(&p->wc);
417 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000418}
419
drh0aa74ed2005-07-16 13:33:20 +0000420/*
421** Deallocate a WhereClause structure. The WhereClause structure
422** itself is not freed. This routine is the inverse of whereClauseInit().
423*/
424static void whereClauseClear(WhereClause *pWC){
425 int i;
426 WhereTerm *a;
drh633e6d52008-07-28 19:34:53 +0000427 sqlite3 *db = pWC->pParse->db;
drh0aa74ed2005-07-16 13:33:20 +0000428 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
drh165be382008-12-05 02:36:33 +0000429 if( a->wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000430 sqlite3ExprDelete(db, a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000431 }
drh700a2262008-12-17 19:22:15 +0000432 if( a->wtFlags & TERM_ORINFO ){
433 whereOrInfoDelete(db, a->u.pOrInfo);
434 }else if( a->wtFlags & TERM_ANDINFO ){
435 whereAndInfoDelete(db, a->u.pAndInfo);
436 }
drh0aa74ed2005-07-16 13:33:20 +0000437 }
438 if( pWC->a!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000439 sqlite3DbFree(db, pWC->a);
drh0aa74ed2005-07-16 13:33:20 +0000440 }
441}
442
443/*
drh6a1e0712008-12-05 15:24:15 +0000444** Add a single new WhereTerm entry to the WhereClause object pWC.
445** The new WhereTerm object is constructed from Expr p and with wtFlags.
446** The index in pWC->a[] of the new WhereTerm is returned on success.
447** 0 is returned if the new WhereTerm could not be added due to a memory
448** allocation error. The memory allocation failure will be recorded in
449** the db->mallocFailed flag so that higher-level functions can detect it.
450**
451** This routine will increase the size of the pWC->a[] array as necessary.
drh9eb20282005-08-24 03:52:18 +0000452**
drh165be382008-12-05 02:36:33 +0000453** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
drh6a1e0712008-12-05 15:24:15 +0000454** for freeing the expression p is assumed by the WhereClause object pWC.
455** This is true even if this routine fails to allocate a new WhereTerm.
drhb63a53d2007-03-31 01:34:44 +0000456**
drh9eb20282005-08-24 03:52:18 +0000457** WARNING: This routine might reallocate the space used to store
drh909626d2008-05-30 14:58:37 +0000458** WhereTerms. All pointers to WhereTerms should be invalidated after
drh9eb20282005-08-24 03:52:18 +0000459** calling this routine. Such pointers may be reinitialized by referencing
460** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000461*/
drhec1724e2008-12-09 01:32:03 +0000462static int whereClauseInsert(WhereClause *pWC, Expr *p, u8 wtFlags){
drh0aa74ed2005-07-16 13:33:20 +0000463 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000464 int idx;
drhe9cdcea2010-07-22 22:40:03 +0000465 testcase( wtFlags & TERM_VIRTUAL ); /* EV: R-00211-15100 */
drh0aa74ed2005-07-16 13:33:20 +0000466 if( pWC->nTerm>=pWC->nSlot ){
467 WhereTerm *pOld = pWC->a;
drh633e6d52008-07-28 19:34:53 +0000468 sqlite3 *db = pWC->pParse->db;
469 pWC->a = sqlite3DbMallocRaw(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
drhb63a53d2007-03-31 01:34:44 +0000470 if( pWC->a==0 ){
drh165be382008-12-05 02:36:33 +0000471 if( wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000472 sqlite3ExprDelete(db, p);
drhb63a53d2007-03-31 01:34:44 +0000473 }
drhf998b732007-11-26 13:36:00 +0000474 pWC->a = pOld;
drhb63a53d2007-03-31 01:34:44 +0000475 return 0;
476 }
drh0aa74ed2005-07-16 13:33:20 +0000477 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
478 if( pOld!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000479 sqlite3DbFree(db, pOld);
drh0aa74ed2005-07-16 13:33:20 +0000480 }
drh6a1e0712008-12-05 15:24:15 +0000481 pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
drh0aa74ed2005-07-16 13:33:20 +0000482 }
drh6a1e0712008-12-05 15:24:15 +0000483 pTerm = &pWC->a[idx = pWC->nTerm++];
drh7ee751d2012-12-19 15:53:51 +0000484 pTerm->pExpr = sqlite3ExprSkipCollate(p);
drh165be382008-12-05 02:36:33 +0000485 pTerm->wtFlags = wtFlags;
drh0fcef5e2005-07-19 17:38:22 +0000486 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000487 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000488 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000489}
drh75897232000-05-29 14:26:00 +0000490
491/*
drh51669862004-12-18 18:40:26 +0000492** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000493** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000494** operator specified in the op parameter. The WhereClause structure
495** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000496**
drh51669862004-12-18 18:40:26 +0000497** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
498** \________/ \_______________/ \________________/
499** slot[0] slot[1] slot[2]
500**
501** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000502** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000503**
drh51147ba2005-07-23 22:59:55 +0000504** In the previous sentence and in the diagram, "slot[]" refers to
drh902b9ee2008-12-05 17:17:07 +0000505** the WhereClause.a[] array. The slot[] array grows as needed to contain
drh51147ba2005-07-23 22:59:55 +0000506** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000507*/
drh6c30be82005-07-29 15:10:17 +0000508static void whereSplit(WhereClause *pWC, Expr *pExpr, int op){
drh29435252008-12-28 18:35:08 +0000509 pWC->op = (u8)op;
drh0aa74ed2005-07-16 13:33:20 +0000510 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000511 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000512 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000513 }else{
drh6c30be82005-07-29 15:10:17 +0000514 whereSplit(pWC, pExpr->pLeft, op);
515 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000516 }
drh75897232000-05-29 14:26:00 +0000517}
518
519/*
drh61495262009-04-22 15:32:59 +0000520** Initialize an expression mask set (a WhereMaskSet object)
drh6a3ea0e2003-05-02 14:32:12 +0000521*/
522#define initMaskSet(P) memset(P, 0, sizeof(*P))
523
524/*
drh1398ad32005-01-19 23:24:50 +0000525** Return the bitmask for the given cursor number. Return 0 if
526** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000527*/
drh111a6a72008-12-21 03:51:16 +0000528static Bitmask getMask(WhereMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000529 int i;
drhfcd71b62011-04-05 22:08:24 +0000530 assert( pMaskSet->n<=(int)sizeof(Bitmask)*8 );
drh6a3ea0e2003-05-02 14:32:12 +0000531 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000532 if( pMaskSet->ix[i]==iCursor ){
533 return ((Bitmask)1)<<i;
534 }
drh6a3ea0e2003-05-02 14:32:12 +0000535 }
drh6a3ea0e2003-05-02 14:32:12 +0000536 return 0;
537}
538
539/*
drh1398ad32005-01-19 23:24:50 +0000540** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000541**
542** There is one cursor per table in the FROM clause. The number of
543** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000544** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000545** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000546*/
drh111a6a72008-12-21 03:51:16 +0000547static void createMask(WhereMaskSet *pMaskSet, int iCursor){
drhcad651e2007-04-20 12:22:01 +0000548 assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
drh0fcef5e2005-07-19 17:38:22 +0000549 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000550}
551
552/*
drh75897232000-05-29 14:26:00 +0000553** This routine walks (recursively) an expression tree and generates
554** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000555** tree.
drh75897232000-05-29 14:26:00 +0000556**
557** In order for this routine to work, the calling function must have
drh7d10d5a2008-08-20 16:35:10 +0000558** previously invoked sqlite3ResolveExprNames() on the expression. See
drh75897232000-05-29 14:26:00 +0000559** the header comment on that routine for additional information.
drh7d10d5a2008-08-20 16:35:10 +0000560** The sqlite3ResolveExprNames() routines looks for column names and
drh6a3ea0e2003-05-02 14:32:12 +0000561** sets their opcodes to TK_COLUMN and their Expr.iTable fields to
drh51147ba2005-07-23 22:59:55 +0000562** the VDBE cursor number of the table. This routine just has to
563** translate the cursor numbers into bitmask values and OR all
564** the bitmasks together.
drh75897232000-05-29 14:26:00 +0000565*/
drh111a6a72008-12-21 03:51:16 +0000566static Bitmask exprListTableUsage(WhereMaskSet*, ExprList*);
567static Bitmask exprSelectTableUsage(WhereMaskSet*, Select*);
568static Bitmask exprTableUsage(WhereMaskSet *pMaskSet, Expr *p){
drh51669862004-12-18 18:40:26 +0000569 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000570 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000571 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000572 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000573 return mask;
drh75897232000-05-29 14:26:00 +0000574 }
danielk1977b3bce662005-01-29 08:32:43 +0000575 mask = exprTableUsage(pMaskSet, p->pRight);
576 mask |= exprTableUsage(pMaskSet, p->pLeft);
danielk19776ab3a2e2009-02-19 14:39:25 +0000577 if( ExprHasProperty(p, EP_xIsSelect) ){
578 mask |= exprSelectTableUsage(pMaskSet, p->x.pSelect);
579 }else{
580 mask |= exprListTableUsage(pMaskSet, p->x.pList);
581 }
danielk1977b3bce662005-01-29 08:32:43 +0000582 return mask;
583}
drh111a6a72008-12-21 03:51:16 +0000584static Bitmask exprListTableUsage(WhereMaskSet *pMaskSet, ExprList *pList){
danielk1977b3bce662005-01-29 08:32:43 +0000585 int i;
586 Bitmask mask = 0;
587 if( pList ){
588 for(i=0; i<pList->nExpr; i++){
589 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000590 }
591 }
drh75897232000-05-29 14:26:00 +0000592 return mask;
593}
drh111a6a72008-12-21 03:51:16 +0000594static Bitmask exprSelectTableUsage(WhereMaskSet *pMaskSet, Select *pS){
drha430ae82007-09-12 15:41:01 +0000595 Bitmask mask = 0;
596 while( pS ){
drha464c232011-09-16 19:04:03 +0000597 SrcList *pSrc = pS->pSrc;
drha430ae82007-09-12 15:41:01 +0000598 mask |= exprListTableUsage(pMaskSet, pS->pEList);
drhf5b11382005-09-17 13:07:13 +0000599 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
600 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
601 mask |= exprTableUsage(pMaskSet, pS->pWhere);
602 mask |= exprTableUsage(pMaskSet, pS->pHaving);
drha464c232011-09-16 19:04:03 +0000603 if( ALWAYS(pSrc!=0) ){
drh88501772011-09-16 17:43:06 +0000604 int i;
605 for(i=0; i<pSrc->nSrc; i++){
606 mask |= exprSelectTableUsage(pMaskSet, pSrc->a[i].pSelect);
607 mask |= exprTableUsage(pMaskSet, pSrc->a[i].pOn);
608 }
609 }
drha430ae82007-09-12 15:41:01 +0000610 pS = pS->pPrior;
drhf5b11382005-09-17 13:07:13 +0000611 }
612 return mask;
613}
drh75897232000-05-29 14:26:00 +0000614
615/*
drh487ab3c2001-11-08 00:45:21 +0000616** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000617** allowed for an indexable WHERE clause term. The allowed operators are
drhc27a1ce2002-06-14 20:58:45 +0000618** "=", "<", ">", "<=", ">=", and "IN".
drhe9cdcea2010-07-22 22:40:03 +0000619**
620** IMPLEMENTATION-OF: R-59926-26393 To be usable by an index a term must be
621** of one of the following forms: column = expression column > expression
622** column >= expression column < expression column <= expression
623** expression = column expression > column expression >= column
624** expression < column expression <= column column IN
625** (expression-list) column IN (subquery) column IS NULL
drh487ab3c2001-11-08 00:45:21 +0000626*/
627static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000628 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
629 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
630 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
631 assert( TK_GE==TK_EQ+4 );
drh50b39962006-10-28 00:28:09 +0000632 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL;
drh487ab3c2001-11-08 00:45:21 +0000633}
634
635/*
drh902b9ee2008-12-05 17:17:07 +0000636** Swap two objects of type TYPE.
drh193bd772004-07-20 18:23:14 +0000637*/
638#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
639
640/*
drh909626d2008-05-30 14:58:37 +0000641** Commute a comparison operator. Expressions of the form "X op Y"
drh0fcef5e2005-07-19 17:38:22 +0000642** are converted into "Y op X".
danielk1977eb5453d2007-07-30 14:40:48 +0000643**
mistachkin48864df2013-03-21 21:20:32 +0000644** If left/right precedence rules come into play when determining the
drhae80dde2012-12-06 21:16:43 +0000645** collating
danielk1977eb5453d2007-07-30 14:40:48 +0000646** side of the comparison, it remains associated with the same side after
647** the commutation. So "Y collate NOCASE op X" becomes
drhae80dde2012-12-06 21:16:43 +0000648** "X op Y". This is because any collation sequence on
danielk1977eb5453d2007-07-30 14:40:48 +0000649** the left hand side of a comparison overrides any collation sequence
drhae80dde2012-12-06 21:16:43 +0000650** attached to the right. For the same reason the EP_Collate flag
danielk1977eb5453d2007-07-30 14:40:48 +0000651** is not commuted.
drh193bd772004-07-20 18:23:14 +0000652*/
drh7d10d5a2008-08-20 16:35:10 +0000653static void exprCommute(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000654 u16 expRight = (pExpr->pRight->flags & EP_Collate);
655 u16 expLeft = (pExpr->pLeft->flags & EP_Collate);
drhfe05af82005-07-21 03:14:59 +0000656 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drhae80dde2012-12-06 21:16:43 +0000657 if( expRight==expLeft ){
658 /* Either X and Y both have COLLATE operator or neither do */
659 if( expRight ){
660 /* Both X and Y have COLLATE operators. Make sure X is always
661 ** used by clearing the EP_Collate flag from Y. */
662 pExpr->pRight->flags &= ~EP_Collate;
663 }else if( sqlite3ExprCollSeq(pParse, pExpr->pLeft)!=0 ){
664 /* Neither X nor Y have COLLATE operators, but X has a non-default
665 ** collating sequence. So add the EP_Collate marker on X to cause
666 ** it to be searched first. */
667 pExpr->pLeft->flags |= EP_Collate;
668 }
669 }
drh0fcef5e2005-07-19 17:38:22 +0000670 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
671 if( pExpr->op>=TK_GT ){
672 assert( TK_LT==TK_GT+2 );
673 assert( TK_GE==TK_LE+2 );
674 assert( TK_GT>TK_EQ );
675 assert( TK_GT<TK_LE );
676 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
677 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000678 }
drh193bd772004-07-20 18:23:14 +0000679}
680
681/*
drhfe05af82005-07-21 03:14:59 +0000682** Translate from TK_xx operator to WO_xx bitmask.
683*/
drhec1724e2008-12-09 01:32:03 +0000684static u16 operatorMask(int op){
685 u16 c;
drhfe05af82005-07-21 03:14:59 +0000686 assert( allowedOp(op) );
687 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000688 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000689 }else if( op==TK_ISNULL ){
690 c = WO_ISNULL;
drhfe05af82005-07-21 03:14:59 +0000691 }else{
drhec1724e2008-12-09 01:32:03 +0000692 assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
693 c = (u16)(WO_EQ<<(op-TK_EQ));
drhfe05af82005-07-21 03:14:59 +0000694 }
drh50b39962006-10-28 00:28:09 +0000695 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh51147ba2005-07-23 22:59:55 +0000696 assert( op!=TK_IN || c==WO_IN );
697 assert( op!=TK_EQ || c==WO_EQ );
698 assert( op!=TK_LT || c==WO_LT );
699 assert( op!=TK_LE || c==WO_LE );
700 assert( op!=TK_GT || c==WO_GT );
701 assert( op!=TK_GE || c==WO_GE );
702 return c;
drhfe05af82005-07-21 03:14:59 +0000703}
704
705/*
drh1c8148f2013-05-04 20:25:23 +0000706** Advance to the next WhereTerm that matches according to the criteria
707** established when the pScan object was initialized by whereScanInit().
708** Return NULL if there are no more matching WhereTerms.
709*/
710WhereTerm *whereScanNext(WhereScan *pScan){
711 int iCur; /* The cursor on the LHS of the term */
712 int iColumn; /* The column on the LHS of the term. -1 for IPK */
713 Expr *pX; /* An expression being tested */
714 WhereClause *pWC; /* Shorthand for pScan->pWC */
715 WhereTerm *pTerm; /* The term being tested */
716
717 while( pScan->iEquiv<=pScan->nEquiv ){
718 iCur = pScan->aEquiv[pScan->iEquiv-2];
719 iColumn = pScan->aEquiv[pScan->iEquiv-1];
720 while( (pWC = pScan->pWC)!=0 ){
721 for(pTerm=pWC->a+pScan->k; pScan->k<pWC->nTerm; pScan->k++, pTerm++){
722 if( pTerm->leftCursor==iCur && pTerm->u.leftColumn==iColumn ){
723 if( (pTerm->eOperator & WO_EQUIV)!=0
724 && pScan->nEquiv<ArraySize(pScan->aEquiv)
725 ){
726 int j;
727 pX = sqlite3ExprSkipCollate(pTerm->pExpr->pRight);
728 assert( pX->op==TK_COLUMN );
729 for(j=0; j<pScan->nEquiv; j+=2){
730 if( pScan->aEquiv[j]==pX->iTable
731 && pScan->aEquiv[j+1]==pX->iColumn ){
732 break;
733 }
734 }
735 if( j==pScan->nEquiv ){
736 pScan->aEquiv[j] = pX->iTable;
737 pScan->aEquiv[j+1] = pX->iColumn;
738 pScan->nEquiv += 2;
739 }
740 }
741 if( (pTerm->eOperator & pScan->opMask)!=0 ){
742 /* Verify the affinity and collating sequence match */
743 if( pScan->zCollName && (pTerm->eOperator & WO_ISNULL)==0 ){
744 CollSeq *pColl;
745 pX = pTerm->pExpr;
746 if( !sqlite3IndexAffinityOk(pX, pScan->idxaff) ){
747 continue;
748 }
749 assert(pX->pLeft);
750 pColl = sqlite3BinaryCompareCollSeq(pWC->pParse,
751 pX->pLeft, pX->pRight);
752 if( pColl==0 ) pColl = pWC->pParse->db->pDfltColl;
753 if( sqlite3StrICmp(pColl->zName, pScan->zCollName) ){
754 continue;
755 }
756 }
drha184fb82013-05-08 04:22:59 +0000757 if( (pTerm->eOperator & WO_EQ)!=0
758 && (pX = pTerm->pExpr->pRight)->op==TK_COLUMN
759 && pX->iTable==pScan->aEquiv[0]
760 && pX->iColumn==pScan->aEquiv[1]
761 ){
762 continue;
763 }
drh1c8148f2013-05-04 20:25:23 +0000764 pScan->pCurrent = pTerm;
765 pScan->k++;
766 return pTerm;
767 }
768 }
769 }
770 pWC = pScan->pWC = pScan->pWC->pOuter;
771 pScan->k = 0;
772 }
773 pScan->pWC = pScan->pOrigWC;
774 pScan->k = 0;
775 pScan->iEquiv += 2;
776 }
777 pScan->pCurrent = 0;
778 return 0;
779}
780
781/*
782** Initialize a WHERE clause scanner object. Return a pointer to the
783** first match. Return NULL if there are no matches.
784**
785** The scanner will be searching the WHERE clause pWC. It will look
786** for terms of the form "X <op> <expr>" where X is column iColumn of table
787** iCur. The <op> must be one of the operators described by opMask.
788**
789** If X is not the INTEGER PRIMARY KEY then X must be compatible with
790** index pIdx.
791*/
792WhereTerm *whereScanInit(
793 WhereScan *pScan, /* The WhereScan object being initialized */
794 WhereClause *pWC, /* The WHERE clause to be scanned */
795 int iCur, /* Cursor to scan for */
796 int iColumn, /* Column to scan for */
797 u32 opMask, /* Operator(s) to scan for */
798 Index *pIdx /* Must be compatible with this index */
799){
800 int j;
801
802 memset(pScan, 0, sizeof(*pScan));
803 pScan->pOrigWC = pWC;
804 pScan->pWC = pWC;
805 if( pIdx && iColumn>=0 ){
806 pScan->idxaff = pIdx->pTable->aCol[iColumn].affinity;
807 for(j=0; pIdx->aiColumn[j]!=iColumn; j++){
808 if( NEVER(j>=pIdx->nColumn) ) return 0;
809 }
810 pScan->zCollName = pIdx->azColl[j];
811 }
812 pScan->opMask = opMask;
813 pScan->aEquiv[0] = iCur;
814 pScan->aEquiv[1] = iColumn;
815 pScan->nEquiv = 2;
816 pScan->iEquiv = 2;
817 return whereScanNext(pScan);
818}
819
820/*
drhfe05af82005-07-21 03:14:59 +0000821** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
822** where X is a reference to the iColumn of table iCur and <op> is one of
823** the WO_xx operator codes specified by the op parameter.
824** Return a pointer to the term. Return 0 if not found.
drh58eb1c02013-01-17 00:08:42 +0000825**
826** The term returned might by Y=<expr> if there is another constraint in
827** the WHERE clause that specifies that X=Y. Any such constraints will be
828** identified by the WO_EQUIV bit in the pTerm->eOperator field. The
829** aEquiv[] array holds X and all its equivalents, with each SQL variable
830** taking up two slots in aEquiv[]. The first slot is for the cursor number
831** and the second is for the column number. There are 22 slots in aEquiv[]
832** so that means we can look for X plus up to 10 other equivalent values.
833** Hence a search for X will return <expr> if X=A1 and A1=A2 and A2=A3
834** and ... and A9=A10 and A10=<expr>.
835**
836** If there are multiple terms in the WHERE clause of the form "X <op> <expr>"
837** then try for the one with no dependencies on <expr> - in other words where
838** <expr> is a constant expression of some kind. Only return entries of
839** the form "X <op> Y" where Y is a column in another table if no terms of
drh459f63e2013-03-06 01:55:27 +0000840** the form "X <op> <const-expr>" exist. If no terms with a constant RHS
841** exist, try to return a term that does not use WO_EQUIV.
drhfe05af82005-07-21 03:14:59 +0000842*/
843static WhereTerm *findTerm(
844 WhereClause *pWC, /* The WHERE clause to be searched */
845 int iCur, /* Cursor number of LHS */
846 int iColumn, /* Column number of LHS */
847 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000848 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000849 Index *pIdx /* Must be compatible with this index, if not NULL */
850){
drh1c8148f2013-05-04 20:25:23 +0000851 WhereTerm *pResult = 0;
852 WhereTerm *p;
853 WhereScan scan;
drh7a5bcc02013-01-16 17:08:58 +0000854
drh1c8148f2013-05-04 20:25:23 +0000855 p = whereScanInit(&scan, pWC, iCur, iColumn, op, pIdx);
856 while( p ){
857 if( (p->prereqRight & notReady)==0 ){
858 if( p->prereqRight==0 && (p->eOperator&WO_EQ)!=0 ){
859 return p;
drhfe05af82005-07-21 03:14:59 +0000860 }
drh1c8148f2013-05-04 20:25:23 +0000861 if( pResult==0 ) pResult = p;
drhfe05af82005-07-21 03:14:59 +0000862 }
drh1c8148f2013-05-04 20:25:23 +0000863 p = whereScanNext(&scan);
drhfe05af82005-07-21 03:14:59 +0000864 }
drh7a5bcc02013-01-16 17:08:58 +0000865 return pResult;
drhfe05af82005-07-21 03:14:59 +0000866}
867
drh6c30be82005-07-29 15:10:17 +0000868/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000869static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000870
871/*
872** Call exprAnalyze on all terms in a WHERE clause.
873**
874**
875*/
876static void exprAnalyzeAll(
877 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000878 WhereClause *pWC /* the WHERE clause to be analyzed */
879){
drh6c30be82005-07-29 15:10:17 +0000880 int i;
drh9eb20282005-08-24 03:52:18 +0000881 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000882 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000883 }
884}
885
drhd2687b72005-08-12 22:56:09 +0000886#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
887/*
888** Check to see if the given expression is a LIKE or GLOB operator that
889** can be optimized using inequality constraints. Return TRUE if it is
890** so and false if not.
891**
892** In order for the operator to be optimizible, the RHS must be a string
893** literal that does not begin with a wildcard.
894*/
895static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000896 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000897 Expr *pExpr, /* Test this expression */
dan937d0de2009-10-15 18:35:38 +0000898 Expr **ppPrefix, /* Pointer to TK_STRING expression with pattern prefix */
drh9f504ea2008-02-23 21:55:39 +0000899 int *pisComplete, /* True if the only wildcard is % in the last character */
900 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000901){
dan937d0de2009-10-15 18:35:38 +0000902 const char *z = 0; /* String on RHS of LIKE operator */
drh5bd98ae2009-01-07 18:24:03 +0000903 Expr *pRight, *pLeft; /* Right and left size of LIKE operator */
904 ExprList *pList; /* List of operands to the LIKE operator */
905 int c; /* One character in z[] */
906 int cnt; /* Number of non-wildcard prefix characters */
907 char wc[3]; /* Wildcard characters */
drh5bd98ae2009-01-07 18:24:03 +0000908 sqlite3 *db = pParse->db; /* Database connection */
dan937d0de2009-10-15 18:35:38 +0000909 sqlite3_value *pVal = 0;
910 int op; /* Opcode of pRight */
drhd64fe2f2005-08-28 17:00:23 +0000911
drh9f504ea2008-02-23 21:55:39 +0000912 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000913 return 0;
914 }
drh9f504ea2008-02-23 21:55:39 +0000915#ifdef SQLITE_EBCDIC
916 if( *pnoCase ) return 0;
917#endif
danielk19776ab3a2e2009-02-19 14:39:25 +0000918 pList = pExpr->x.pList;
drh55ef4d92005-08-14 01:20:37 +0000919 pLeft = pList->a[1].pExpr;
danc68939e2012-03-29 14:29:07 +0000920 if( pLeft->op!=TK_COLUMN
921 || sqlite3ExprAffinity(pLeft)!=SQLITE_AFF_TEXT
922 || IsVirtual(pLeft->pTab)
923 ){
drhd91ca492009-10-22 20:50:36 +0000924 /* IMP: R-02065-49465 The left-hand side of the LIKE or GLOB operator must
925 ** be the name of an indexed column with TEXT affinity. */
drhd2687b72005-08-12 22:56:09 +0000926 return 0;
927 }
drhd91ca492009-10-22 20:50:36 +0000928 assert( pLeft->iColumn!=(-1) ); /* Because IPK never has AFF_TEXT */
dan937d0de2009-10-15 18:35:38 +0000929
930 pRight = pList->a[0].pExpr;
931 op = pRight->op;
932 if( op==TK_REGISTER ){
933 op = pRight->op2;
934 }
935 if( op==TK_VARIABLE ){
936 Vdbe *pReprepare = pParse->pReprepare;
drha7044002010-09-14 18:22:59 +0000937 int iCol = pRight->iColumn;
938 pVal = sqlite3VdbeGetValue(pReprepare, iCol, SQLITE_AFF_NONE);
dan937d0de2009-10-15 18:35:38 +0000939 if( pVal && sqlite3_value_type(pVal)==SQLITE_TEXT ){
940 z = (char *)sqlite3_value_text(pVal);
941 }
drhf9b22ca2011-10-21 16:47:31 +0000942 sqlite3VdbeSetVarmask(pParse->pVdbe, iCol);
dan937d0de2009-10-15 18:35:38 +0000943 assert( pRight->op==TK_VARIABLE || pRight->op==TK_REGISTER );
944 }else if( op==TK_STRING ){
945 z = pRight->u.zToken;
946 }
947 if( z ){
shane85095702009-06-15 16:27:08 +0000948 cnt = 0;
drhb7916a72009-05-27 10:31:29 +0000949 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){
drh24fb6272009-05-01 21:13:36 +0000950 cnt++;
951 }
drh93ee23c2010-07-22 12:33:57 +0000952 if( cnt!=0 && 255!=(u8)z[cnt-1] ){
dan937d0de2009-10-15 18:35:38 +0000953 Expr *pPrefix;
drh93ee23c2010-07-22 12:33:57 +0000954 *pisComplete = c==wc[0] && z[cnt+1]==0;
dan937d0de2009-10-15 18:35:38 +0000955 pPrefix = sqlite3Expr(db, TK_STRING, z);
956 if( pPrefix ) pPrefix->u.zToken[cnt] = 0;
957 *ppPrefix = pPrefix;
958 if( op==TK_VARIABLE ){
959 Vdbe *v = pParse->pVdbe;
drhf9b22ca2011-10-21 16:47:31 +0000960 sqlite3VdbeSetVarmask(v, pRight->iColumn);
dan937d0de2009-10-15 18:35:38 +0000961 if( *pisComplete && pRight->u.zToken[1] ){
962 /* If the rhs of the LIKE expression is a variable, and the current
963 ** value of the variable means there is no need to invoke the LIKE
964 ** function, then no OP_Variable will be added to the program.
965 ** This causes problems for the sqlite3_bind_parameter_name()
drhbec451f2009-10-17 13:13:02 +0000966 ** API. To workaround them, add a dummy OP_Variable here.
967 */
968 int r1 = sqlite3GetTempReg(pParse);
969 sqlite3ExprCodeTarget(pParse, pRight, r1);
dan937d0de2009-10-15 18:35:38 +0000970 sqlite3VdbeChangeP3(v, sqlite3VdbeCurrentAddr(v)-1, 0);
drhbec451f2009-10-17 13:13:02 +0000971 sqlite3ReleaseTempReg(pParse, r1);
dan937d0de2009-10-15 18:35:38 +0000972 }
973 }
974 }else{
975 z = 0;
shane85095702009-06-15 16:27:08 +0000976 }
drhf998b732007-11-26 13:36:00 +0000977 }
dan937d0de2009-10-15 18:35:38 +0000978
979 sqlite3ValueFree(pVal);
980 return (z!=0);
drhd2687b72005-08-12 22:56:09 +0000981}
982#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
983
drhedb193b2006-06-27 13:20:21 +0000984
985#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000986/*
drh7f375902006-06-13 17:38:59 +0000987** Check to see if the given expression is of the form
988**
989** column MATCH expr
990**
991** If it is then return TRUE. If not, return FALSE.
992*/
993static int isMatchOfColumn(
994 Expr *pExpr /* Test this expression */
995){
996 ExprList *pList;
997
998 if( pExpr->op!=TK_FUNCTION ){
999 return 0;
1000 }
drh33e619f2009-05-28 01:00:55 +00001001 if( sqlite3StrICmp(pExpr->u.zToken,"match")!=0 ){
drh7f375902006-06-13 17:38:59 +00001002 return 0;
1003 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001004 pList = pExpr->x.pList;
drh7f375902006-06-13 17:38:59 +00001005 if( pList->nExpr!=2 ){
1006 return 0;
1007 }
1008 if( pList->a[1].pExpr->op != TK_COLUMN ){
1009 return 0;
1010 }
1011 return 1;
1012}
drhedb193b2006-06-27 13:20:21 +00001013#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +00001014
1015/*
drh54a167d2005-11-26 14:08:07 +00001016** If the pBase expression originated in the ON or USING clause of
1017** a join, then transfer the appropriate markings over to derived.
1018*/
1019static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
1020 pDerived->flags |= pBase->flags & EP_FromJoin;
1021 pDerived->iRightJoinTable = pBase->iRightJoinTable;
1022}
1023
drh3e355802007-02-23 23:13:33 +00001024#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
1025/*
drh1a58fe02008-12-20 02:06:13 +00001026** Analyze a term that consists of two or more OR-connected
1027** subterms. So in:
drh3e355802007-02-23 23:13:33 +00001028**
drh1a58fe02008-12-20 02:06:13 +00001029** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
1030** ^^^^^^^^^^^^^^^^^^^^
drh3e355802007-02-23 23:13:33 +00001031**
drh1a58fe02008-12-20 02:06:13 +00001032** This routine analyzes terms such as the middle term in the above example.
1033** A WhereOrTerm object is computed and attached to the term under
1034** analysis, regardless of the outcome of the analysis. Hence:
drh3e355802007-02-23 23:13:33 +00001035**
drh1a58fe02008-12-20 02:06:13 +00001036** WhereTerm.wtFlags |= TERM_ORINFO
1037** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
drh3e355802007-02-23 23:13:33 +00001038**
drh1a58fe02008-12-20 02:06:13 +00001039** The term being analyzed must have two or more of OR-connected subterms.
danielk1977fdc40192008-12-29 18:33:32 +00001040** A single subterm might be a set of AND-connected sub-subterms.
drh1a58fe02008-12-20 02:06:13 +00001041** Examples of terms under analysis:
drh3e355802007-02-23 23:13:33 +00001042**
drh1a58fe02008-12-20 02:06:13 +00001043** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
1044** (B) x=expr1 OR expr2=x OR x=expr3
1045** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
1046** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
1047** (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 +00001048**
drh1a58fe02008-12-20 02:06:13 +00001049** CASE 1:
1050**
drhc3e552f2013-02-08 16:04:19 +00001051** If all subterms are of the form T.C=expr for some single column of C and
drh1a58fe02008-12-20 02:06:13 +00001052** a single table T (as shown in example B above) then create a new virtual
1053** term that is an equivalent IN expression. In other words, if the term
1054** being analyzed is:
1055**
1056** x = expr1 OR expr2 = x OR x = expr3
1057**
1058** then create a new virtual term like this:
1059**
1060** x IN (expr1,expr2,expr3)
1061**
1062** CASE 2:
1063**
1064** If all subterms are indexable by a single table T, then set
1065**
1066** WhereTerm.eOperator = WO_OR
1067** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
1068**
1069** A subterm is "indexable" if it is of the form
1070** "T.C <op> <expr>" where C is any column of table T and
1071** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
1072** A subterm is also indexable if it is an AND of two or more
1073** subsubterms at least one of which is indexable. Indexable AND
1074** subterms have their eOperator set to WO_AND and they have
1075** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
1076**
1077** From another point of view, "indexable" means that the subterm could
1078** potentially be used with an index if an appropriate index exists.
1079** This analysis does not consider whether or not the index exists; that
1080** is something the bestIndex() routine will determine. This analysis
1081** only looks at whether subterms appropriate for indexing exist.
1082**
1083** All examples A through E above all satisfy case 2. But if a term
1084** also statisfies case 1 (such as B) we know that the optimizer will
1085** always prefer case 1, so in that case we pretend that case 2 is not
1086** satisfied.
1087**
1088** It might be the case that multiple tables are indexable. For example,
1089** (E) above is indexable on tables P, Q, and R.
1090**
1091** Terms that satisfy case 2 are candidates for lookup by using
1092** separate indices to find rowids for each subterm and composing
1093** the union of all rowids using a RowSet object. This is similar
1094** to "bitmap indices" in other database engines.
1095**
1096** OTHERWISE:
1097**
1098** If neither case 1 nor case 2 apply, then leave the eOperator set to
1099** zero. This term is not useful for search.
drh3e355802007-02-23 23:13:33 +00001100*/
drh1a58fe02008-12-20 02:06:13 +00001101static void exprAnalyzeOrTerm(
1102 SrcList *pSrc, /* the FROM clause */
1103 WhereClause *pWC, /* the complete WHERE clause */
1104 int idxTerm /* Index of the OR-term to be analyzed */
1105){
1106 Parse *pParse = pWC->pParse; /* Parser context */
1107 sqlite3 *db = pParse->db; /* Database connection */
1108 WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
1109 Expr *pExpr = pTerm->pExpr; /* The expression of the term */
drh111a6a72008-12-21 03:51:16 +00001110 WhereMaskSet *pMaskSet = pWC->pMaskSet; /* Table use masks */
drh1a58fe02008-12-20 02:06:13 +00001111 int i; /* Loop counters */
1112 WhereClause *pOrWc; /* Breakup of pTerm into subterms */
1113 WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
1114 WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
1115 Bitmask chngToIN; /* Tables that might satisfy case 1 */
1116 Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
drh3e355802007-02-23 23:13:33 +00001117
drh1a58fe02008-12-20 02:06:13 +00001118 /*
1119 ** Break the OR clause into its separate subterms. The subterms are
1120 ** stored in a WhereClause structure containing within the WhereOrInfo
1121 ** object that is attached to the original OR clause term.
1122 */
1123 assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
1124 assert( pExpr->op==TK_OR );
drh954701a2008-12-29 23:45:07 +00001125 pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
drh1a58fe02008-12-20 02:06:13 +00001126 if( pOrInfo==0 ) return;
1127 pTerm->wtFlags |= TERM_ORINFO;
1128 pOrWc = &pOrInfo->wc;
drh9ef61f42011-10-07 14:40:59 +00001129 whereClauseInit(pOrWc, pWC->pParse, pMaskSet, pWC->wctrlFlags);
drh1a58fe02008-12-20 02:06:13 +00001130 whereSplit(pOrWc, pExpr, TK_OR);
1131 exprAnalyzeAll(pSrc, pOrWc);
1132 if( db->mallocFailed ) return;
1133 assert( pOrWc->nTerm>=2 );
1134
1135 /*
1136 ** Compute the set of tables that might satisfy cases 1 or 2.
1137 */
danielk1977e672c8e2009-05-22 15:43:26 +00001138 indexable = ~(Bitmask)0;
drhc3e552f2013-02-08 16:04:19 +00001139 chngToIN = ~(Bitmask)0;
drh1a58fe02008-12-20 02:06:13 +00001140 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
1141 if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
drh29435252008-12-28 18:35:08 +00001142 WhereAndInfo *pAndInfo;
drh29435252008-12-28 18:35:08 +00001143 assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
drh1a58fe02008-12-20 02:06:13 +00001144 chngToIN = 0;
drh29435252008-12-28 18:35:08 +00001145 pAndInfo = sqlite3DbMallocRaw(db, sizeof(*pAndInfo));
1146 if( pAndInfo ){
1147 WhereClause *pAndWC;
1148 WhereTerm *pAndTerm;
1149 int j;
1150 Bitmask b = 0;
1151 pOrTerm->u.pAndInfo = pAndInfo;
1152 pOrTerm->wtFlags |= TERM_ANDINFO;
1153 pOrTerm->eOperator = WO_AND;
1154 pAndWC = &pAndInfo->wc;
drh9ef61f42011-10-07 14:40:59 +00001155 whereClauseInit(pAndWC, pWC->pParse, pMaskSet, pWC->wctrlFlags);
drh29435252008-12-28 18:35:08 +00001156 whereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
1157 exprAnalyzeAll(pSrc, pAndWC);
drh8871ef52011-10-07 13:33:10 +00001158 pAndWC->pOuter = pWC;
drh7c2fbde2009-01-07 20:58:57 +00001159 testcase( db->mallocFailed );
drh96c7a7d2009-01-10 15:34:12 +00001160 if( !db->mallocFailed ){
1161 for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
1162 assert( pAndTerm->pExpr );
1163 if( allowedOp(pAndTerm->pExpr->op) ){
1164 b |= getMask(pMaskSet, pAndTerm->leftCursor);
1165 }
drh29435252008-12-28 18:35:08 +00001166 }
1167 }
1168 indexable &= b;
1169 }
drh1a58fe02008-12-20 02:06:13 +00001170 }else if( pOrTerm->wtFlags & TERM_COPIED ){
1171 /* Skip this term for now. We revisit it when we process the
1172 ** corresponding TERM_VIRTUAL term */
1173 }else{
1174 Bitmask b;
1175 b = getMask(pMaskSet, pOrTerm->leftCursor);
1176 if( pOrTerm->wtFlags & TERM_VIRTUAL ){
1177 WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
1178 b |= getMask(pMaskSet, pOther->leftCursor);
1179 }
1180 indexable &= b;
drh7a5bcc02013-01-16 17:08:58 +00001181 if( (pOrTerm->eOperator & WO_EQ)==0 ){
drh1a58fe02008-12-20 02:06:13 +00001182 chngToIN = 0;
1183 }else{
1184 chngToIN &= b;
1185 }
1186 }
drh3e355802007-02-23 23:13:33 +00001187 }
drh1a58fe02008-12-20 02:06:13 +00001188
1189 /*
1190 ** Record the set of tables that satisfy case 2. The set might be
drh111a6a72008-12-21 03:51:16 +00001191 ** empty.
drh1a58fe02008-12-20 02:06:13 +00001192 */
1193 pOrInfo->indexable = indexable;
drh111a6a72008-12-21 03:51:16 +00001194 pTerm->eOperator = indexable==0 ? 0 : WO_OR;
drh1a58fe02008-12-20 02:06:13 +00001195
1196 /*
1197 ** chngToIN holds a set of tables that *might* satisfy case 1. But
1198 ** we have to do some additional checking to see if case 1 really
1199 ** is satisfied.
drh4e8be3b2009-06-08 17:11:08 +00001200 **
1201 ** chngToIN will hold either 0, 1, or 2 bits. The 0-bit case means
1202 ** that there is no possibility of transforming the OR clause into an
1203 ** IN operator because one or more terms in the OR clause contain
1204 ** something other than == on a column in the single table. The 1-bit
1205 ** case means that every term of the OR clause is of the form
1206 ** "table.column=expr" for some single table. The one bit that is set
1207 ** will correspond to the common table. We still need to check to make
1208 ** sure the same column is used on all terms. The 2-bit case is when
1209 ** the all terms are of the form "table1.column=table2.column". It
1210 ** might be possible to form an IN operator with either table1.column
1211 ** or table2.column as the LHS if either is common to every term of
1212 ** the OR clause.
1213 **
1214 ** Note that terms of the form "table.column1=table.column2" (the
1215 ** same table on both sizes of the ==) cannot be optimized.
drh1a58fe02008-12-20 02:06:13 +00001216 */
1217 if( chngToIN ){
1218 int okToChngToIN = 0; /* True if the conversion to IN is valid */
1219 int iColumn = -1; /* Column index on lhs of IN operator */
shane63207ab2009-02-04 01:49:30 +00001220 int iCursor = -1; /* Table cursor common to all terms */
drh1a58fe02008-12-20 02:06:13 +00001221 int j = 0; /* Loop counter */
1222
1223 /* Search for a table and column that appears on one side or the
1224 ** other of the == operator in every subterm. That table and column
1225 ** will be recorded in iCursor and iColumn. There might not be any
1226 ** such table and column. Set okToChngToIN if an appropriate table
1227 ** and column is found but leave okToChngToIN false if not found.
1228 */
1229 for(j=0; j<2 && !okToChngToIN; j++){
1230 pOrTerm = pOrWc->a;
1231 for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001232 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001233 pOrTerm->wtFlags &= ~TERM_OR_OK;
drh4e8be3b2009-06-08 17:11:08 +00001234 if( pOrTerm->leftCursor==iCursor ){
1235 /* This is the 2-bit case and we are on the second iteration and
1236 ** current term is from the first iteration. So skip this term. */
1237 assert( j==1 );
1238 continue;
1239 }
1240 if( (chngToIN & getMask(pMaskSet, pOrTerm->leftCursor))==0 ){
1241 /* This term must be of the form t1.a==t2.b where t2 is in the
1242 ** chngToIN set but t1 is not. This term will be either preceeded
1243 ** or follwed by an inverted copy (t2.b==t1.a). Skip this term
1244 ** and use its inversion. */
1245 testcase( pOrTerm->wtFlags & TERM_COPIED );
1246 testcase( pOrTerm->wtFlags & TERM_VIRTUAL );
1247 assert( pOrTerm->wtFlags & (TERM_COPIED|TERM_VIRTUAL) );
1248 continue;
1249 }
drh1a58fe02008-12-20 02:06:13 +00001250 iColumn = pOrTerm->u.leftColumn;
1251 iCursor = pOrTerm->leftCursor;
1252 break;
1253 }
1254 if( i<0 ){
drh4e8be3b2009-06-08 17:11:08 +00001255 /* No candidate table+column was found. This can only occur
1256 ** on the second iteration */
drh1a58fe02008-12-20 02:06:13 +00001257 assert( j==1 );
drh7a5bcc02013-01-16 17:08:58 +00001258 assert( IsPowerOfTwo(chngToIN) );
drh4e8be3b2009-06-08 17:11:08 +00001259 assert( chngToIN==getMask(pMaskSet, iCursor) );
drh1a58fe02008-12-20 02:06:13 +00001260 break;
1261 }
drh4e8be3b2009-06-08 17:11:08 +00001262 testcase( j==1 );
1263
1264 /* We have found a candidate table and column. Check to see if that
1265 ** table and column is common to every term in the OR clause */
drh1a58fe02008-12-20 02:06:13 +00001266 okToChngToIN = 1;
1267 for(; i>=0 && okToChngToIN; i--, pOrTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001268 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001269 if( pOrTerm->leftCursor!=iCursor ){
1270 pOrTerm->wtFlags &= ~TERM_OR_OK;
1271 }else if( pOrTerm->u.leftColumn!=iColumn ){
1272 okToChngToIN = 0;
1273 }else{
1274 int affLeft, affRight;
1275 /* If the right-hand side is also a column, then the affinities
1276 ** of both right and left sides must be such that no type
1277 ** conversions are required on the right. (Ticket #2249)
1278 */
1279 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
1280 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
1281 if( affRight!=0 && affRight!=affLeft ){
1282 okToChngToIN = 0;
1283 }else{
1284 pOrTerm->wtFlags |= TERM_OR_OK;
1285 }
1286 }
1287 }
1288 }
1289
1290 /* At this point, okToChngToIN is true if original pTerm satisfies
1291 ** case 1. In that case, construct a new virtual term that is
1292 ** pTerm converted into an IN operator.
drhe9cdcea2010-07-22 22:40:03 +00001293 **
1294 ** EV: R-00211-15100
drh1a58fe02008-12-20 02:06:13 +00001295 */
1296 if( okToChngToIN ){
1297 Expr *pDup; /* A transient duplicate expression */
1298 ExprList *pList = 0; /* The RHS of the IN operator */
1299 Expr *pLeft = 0; /* The LHS of the IN operator */
1300 Expr *pNew; /* The complete IN operator */
1301
1302 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
1303 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
drh7a5bcc02013-01-16 17:08:58 +00001304 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001305 assert( pOrTerm->leftCursor==iCursor );
1306 assert( pOrTerm->u.leftColumn==iColumn );
danielk19776ab3a2e2009-02-19 14:39:25 +00001307 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight, 0);
drhb7916a72009-05-27 10:31:29 +00001308 pList = sqlite3ExprListAppend(pWC->pParse, pList, pDup);
drh1a58fe02008-12-20 02:06:13 +00001309 pLeft = pOrTerm->pExpr->pLeft;
1310 }
1311 assert( pLeft!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001312 pDup = sqlite3ExprDup(db, pLeft, 0);
drhb7916a72009-05-27 10:31:29 +00001313 pNew = sqlite3PExpr(pParse, TK_IN, pDup, 0, 0);
drh1a58fe02008-12-20 02:06:13 +00001314 if( pNew ){
1315 int idxNew;
1316 transferJoinMarkings(pNew, pExpr);
danielk19776ab3a2e2009-02-19 14:39:25 +00001317 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
1318 pNew->x.pList = pList;
drh1a58fe02008-12-20 02:06:13 +00001319 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
1320 testcase( idxNew==0 );
1321 exprAnalyze(pSrc, pWC, idxNew);
1322 pTerm = &pWC->a[idxTerm];
1323 pWC->a[idxNew].iParent = idxTerm;
1324 pTerm->nChild = 1;
1325 }else{
1326 sqlite3ExprListDelete(db, pList);
1327 }
drh534230c2011-01-22 00:10:45 +00001328 pTerm->eOperator = WO_NOOP; /* case 1 trumps case 2 */
drh1a58fe02008-12-20 02:06:13 +00001329 }
drh3e355802007-02-23 23:13:33 +00001330 }
drh3e355802007-02-23 23:13:33 +00001331}
1332#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +00001333
drh7a5bcc02013-01-16 17:08:58 +00001334/*
drh0aa74ed2005-07-16 13:33:20 +00001335** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +00001336** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +00001337** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +00001338** structure.
drh51147ba2005-07-23 22:59:55 +00001339**
1340** If the expression is of the form "<expr> <op> X" it gets commuted
drh1a58fe02008-12-20 02:06:13 +00001341** to the standard form of "X <op> <expr>".
1342**
1343** If the expression is of the form "X <op> Y" where both X and Y are
1344** columns, then the original expression is unchanged and a new virtual
1345** term of the form "Y <op> X" is added to the WHERE clause and
1346** analyzed separately. The original term is marked with TERM_COPIED
1347** and the new term is marked with TERM_DYNAMIC (because it's pExpr
1348** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
1349** is a commuted copy of a prior term.) The original term has nChild=1
1350** and the copy has idxParent set to the index of the original term.
drh75897232000-05-29 14:26:00 +00001351*/
drh0fcef5e2005-07-19 17:38:22 +00001352static void exprAnalyze(
1353 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +00001354 WhereClause *pWC, /* the WHERE clause */
1355 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +00001356){
drh1a58fe02008-12-20 02:06:13 +00001357 WhereTerm *pTerm; /* The term to be analyzed */
drh111a6a72008-12-21 03:51:16 +00001358 WhereMaskSet *pMaskSet; /* Set of table index masks */
drh1a58fe02008-12-20 02:06:13 +00001359 Expr *pExpr; /* The expression to be analyzed */
1360 Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
1361 Bitmask prereqAll; /* Prerequesites of pExpr */
drh5e767c52010-02-25 04:15:47 +00001362 Bitmask extraRight = 0; /* Extra dependencies on LEFT JOIN */
drh1d452e12009-11-01 19:26:59 +00001363 Expr *pStr1 = 0; /* RHS of LIKE/GLOB operator */
1364 int isComplete = 0; /* RHS of LIKE/GLOB ends with wildcard */
1365 int noCase = 0; /* LIKE/GLOB distinguishes case */
drh1a58fe02008-12-20 02:06:13 +00001366 int op; /* Top-level operator. pExpr->op */
1367 Parse *pParse = pWC->pParse; /* Parsing context */
1368 sqlite3 *db = pParse->db; /* Database connection */
drh0fcef5e2005-07-19 17:38:22 +00001369
drhf998b732007-11-26 13:36:00 +00001370 if( db->mallocFailed ){
1371 return;
1372 }
1373 pTerm = &pWC->a[idxTerm];
1374 pMaskSet = pWC->pMaskSet;
drh7ee751d2012-12-19 15:53:51 +00001375 pExpr = pTerm->pExpr;
1376 assert( pExpr->op!=TK_AS && pExpr->op!=TK_COLLATE );
drh0fcef5e2005-07-19 17:38:22 +00001377 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +00001378 op = pExpr->op;
1379 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +00001380 assert( pExpr->pRight==0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001381 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1382 pTerm->prereqRight = exprSelectTableUsage(pMaskSet, pExpr->x.pSelect);
1383 }else{
1384 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->x.pList);
1385 }
drh50b39962006-10-28 00:28:09 +00001386 }else if( op==TK_ISNULL ){
1387 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +00001388 }else{
1389 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
1390 }
drh22d6a532005-09-19 21:05:48 +00001391 prereqAll = exprTableUsage(pMaskSet, pExpr);
1392 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +00001393 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
1394 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +00001395 extraRight = x-1; /* ON clause terms may not be used with an index
1396 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +00001397 }
1398 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +00001399 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +00001400 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +00001401 pTerm->eOperator = 0;
drh738fc792013-01-17 15:05:17 +00001402 if( allowedOp(op) ){
drh7a66da12012-12-07 20:31:11 +00001403 Expr *pLeft = sqlite3ExprSkipCollate(pExpr->pLeft);
1404 Expr *pRight = sqlite3ExprSkipCollate(pExpr->pRight);
drh738fc792013-01-17 15:05:17 +00001405 u16 opMask = (pTerm->prereqRight & prereqLeft)==0 ? WO_ALL : WO_EQUIV;
drh0fcef5e2005-07-19 17:38:22 +00001406 if( pLeft->op==TK_COLUMN ){
1407 pTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001408 pTerm->u.leftColumn = pLeft->iColumn;
drh738fc792013-01-17 15:05:17 +00001409 pTerm->eOperator = operatorMask(op) & opMask;
drh75897232000-05-29 14:26:00 +00001410 }
drh0fcef5e2005-07-19 17:38:22 +00001411 if( pRight && pRight->op==TK_COLUMN ){
1412 WhereTerm *pNew;
1413 Expr *pDup;
drh7a5bcc02013-01-16 17:08:58 +00001414 u16 eExtraOp = 0; /* Extra bits for pNew->eOperator */
drh0fcef5e2005-07-19 17:38:22 +00001415 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +00001416 int idxNew;
danielk19776ab3a2e2009-02-19 14:39:25 +00001417 pDup = sqlite3ExprDup(db, pExpr, 0);
drh17435752007-08-16 04:30:38 +00001418 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +00001419 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +00001420 return;
1421 }
drh9eb20282005-08-24 03:52:18 +00001422 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
1423 if( idxNew==0 ) return;
1424 pNew = &pWC->a[idxNew];
1425 pNew->iParent = idxTerm;
1426 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +00001427 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001428 pTerm->wtFlags |= TERM_COPIED;
drheb5bc922013-01-17 16:43:33 +00001429 if( pExpr->op==TK_EQ
1430 && !ExprHasProperty(pExpr, EP_FromJoin)
1431 && OptimizationEnabled(db, SQLITE_Transitive)
1432 ){
drh7a5bcc02013-01-16 17:08:58 +00001433 pTerm->eOperator |= WO_EQUIV;
1434 eExtraOp = WO_EQUIV;
1435 }
drh0fcef5e2005-07-19 17:38:22 +00001436 }else{
1437 pDup = pExpr;
1438 pNew = pTerm;
1439 }
drh7d10d5a2008-08-20 16:35:10 +00001440 exprCommute(pParse, pDup);
drhfb76f5a2012-12-08 14:16:47 +00001441 pLeft = sqlite3ExprSkipCollate(pDup->pLeft);
drh0fcef5e2005-07-19 17:38:22 +00001442 pNew->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001443 pNew->u.leftColumn = pLeft->iColumn;
drh5e767c52010-02-25 04:15:47 +00001444 testcase( (prereqLeft | extraRight) != prereqLeft );
1445 pNew->prereqRight = prereqLeft | extraRight;
drh0fcef5e2005-07-19 17:38:22 +00001446 pNew->prereqAll = prereqAll;
drh738fc792013-01-17 15:05:17 +00001447 pNew->eOperator = (operatorMask(pDup->op) + eExtraOp) & opMask;
drh75897232000-05-29 14:26:00 +00001448 }
1449 }
drhed378002005-07-28 23:12:08 +00001450
drhd2687b72005-08-12 22:56:09 +00001451#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +00001452 /* If a term is the BETWEEN operator, create two new virtual terms
drh1a58fe02008-12-20 02:06:13 +00001453 ** that define the range that the BETWEEN implements. For example:
1454 **
1455 ** a BETWEEN b AND c
1456 **
1457 ** is converted into:
1458 **
1459 ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
1460 **
1461 ** The two new terms are added onto the end of the WhereClause object.
1462 ** The new terms are "dynamic" and are children of the original BETWEEN
1463 ** term. That means that if the BETWEEN term is coded, the children are
1464 ** skipped. Or, if the children are satisfied by an index, the original
1465 ** BETWEEN term is skipped.
drhed378002005-07-28 23:12:08 +00001466 */
drh29435252008-12-28 18:35:08 +00001467 else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001468 ExprList *pList = pExpr->x.pList;
drhed378002005-07-28 23:12:08 +00001469 int i;
1470 static const u8 ops[] = {TK_GE, TK_LE};
1471 assert( pList!=0 );
1472 assert( pList->nExpr==2 );
1473 for(i=0; i<2; i++){
1474 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +00001475 int idxNew;
drhb7916a72009-05-27 10:31:29 +00001476 pNewExpr = sqlite3PExpr(pParse, ops[i],
1477 sqlite3ExprDup(db, pExpr->pLeft, 0),
danielk19776ab3a2e2009-02-19 14:39:25 +00001478 sqlite3ExprDup(db, pList->a[i].pExpr, 0), 0);
drh9eb20282005-08-24 03:52:18 +00001479 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001480 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001481 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +00001482 pTerm = &pWC->a[idxTerm];
1483 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +00001484 }
drh45b1ee42005-08-02 17:48:22 +00001485 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +00001486 }
drhd2687b72005-08-12 22:56:09 +00001487#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +00001488
danielk19771576cd92006-01-14 08:02:28 +00001489#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh1a58fe02008-12-20 02:06:13 +00001490 /* Analyze a term that is composed of two or more subterms connected by
1491 ** an OR operator.
drh6c30be82005-07-29 15:10:17 +00001492 */
1493 else if( pExpr->op==TK_OR ){
drh29435252008-12-28 18:35:08 +00001494 assert( pWC->op==TK_AND );
drh1a58fe02008-12-20 02:06:13 +00001495 exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
danielk1977f51d1bd2009-07-31 06:14:51 +00001496 pTerm = &pWC->a[idxTerm];
drh6c30be82005-07-29 15:10:17 +00001497 }
drhd2687b72005-08-12 22:56:09 +00001498#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1499
1500#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
1501 /* Add constraints to reduce the search space on a LIKE or GLOB
1502 ** operator.
drh9f504ea2008-02-23 21:55:39 +00001503 **
1504 ** A like pattern of the form "x LIKE 'abc%'" is changed into constraints
1505 **
1506 ** x>='abc' AND x<'abd' AND x LIKE 'abc%'
1507 **
1508 ** The last character of the prefix "abc" is incremented to form the
shane7bc71e52008-05-28 18:01:44 +00001509 ** termination condition "abd".
drhd2687b72005-08-12 22:56:09 +00001510 */
dan937d0de2009-10-15 18:35:38 +00001511 if( pWC->op==TK_AND
1512 && isLikeOrGlob(pParse, pExpr, &pStr1, &isComplete, &noCase)
1513 ){
drh1d452e12009-11-01 19:26:59 +00001514 Expr *pLeft; /* LHS of LIKE/GLOB operator */
1515 Expr *pStr2; /* Copy of pStr1 - RHS of LIKE/GLOB operator */
1516 Expr *pNewExpr1;
1517 Expr *pNewExpr2;
1518 int idxNew1;
1519 int idxNew2;
drhae80dde2012-12-06 21:16:43 +00001520 Token sCollSeqName; /* Name of collating sequence */
drh9eb20282005-08-24 03:52:18 +00001521
danielk19776ab3a2e2009-02-19 14:39:25 +00001522 pLeft = pExpr->x.pList->a[1].pExpr;
danielk19776ab3a2e2009-02-19 14:39:25 +00001523 pStr2 = sqlite3ExprDup(db, pStr1, 0);
drhf998b732007-11-26 13:36:00 +00001524 if( !db->mallocFailed ){
drh254993e2009-06-08 19:44:36 +00001525 u8 c, *pC; /* Last character before the first wildcard */
dan937d0de2009-10-15 18:35:38 +00001526 pC = (u8*)&pStr2->u.zToken[sqlite3Strlen30(pStr2->u.zToken)-1];
drh9f504ea2008-02-23 21:55:39 +00001527 c = *pC;
drh02a50b72008-05-26 18:33:40 +00001528 if( noCase ){
drh254993e2009-06-08 19:44:36 +00001529 /* The point is to increment the last character before the first
1530 ** wildcard. But if we increment '@', that will push it into the
1531 ** alphabetic range where case conversions will mess up the
1532 ** inequality. To avoid this, make sure to also run the full
1533 ** LIKE on all candidate expressions by clearing the isComplete flag
1534 */
drhe9cdcea2010-07-22 22:40:03 +00001535 if( c=='A'-1 ) isComplete = 0; /* EV: R-64339-08207 */
1536
drh254993e2009-06-08 19:44:36 +00001537
drh02a50b72008-05-26 18:33:40 +00001538 c = sqlite3UpperToLower[c];
1539 }
drh9f504ea2008-02-23 21:55:39 +00001540 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +00001541 }
drhae80dde2012-12-06 21:16:43 +00001542 sCollSeqName.z = noCase ? "NOCASE" : "BINARY";
1543 sCollSeqName.n = 6;
1544 pNewExpr1 = sqlite3ExprDup(db, pLeft, 0);
drh8342e492010-07-22 17:49:52 +00001545 pNewExpr1 = sqlite3PExpr(pParse, TK_GE,
drh0a8a4062012-12-07 18:38:16 +00001546 sqlite3ExprAddCollateToken(pParse,pNewExpr1,&sCollSeqName),
drhae80dde2012-12-06 21:16:43 +00001547 pStr1, 0);
drh9eb20282005-08-24 03:52:18 +00001548 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001549 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001550 exprAnalyze(pSrc, pWC, idxNew1);
drhae80dde2012-12-06 21:16:43 +00001551 pNewExpr2 = sqlite3ExprDup(db, pLeft, 0);
drh8342e492010-07-22 17:49:52 +00001552 pNewExpr2 = sqlite3PExpr(pParse, TK_LT,
drh0a8a4062012-12-07 18:38:16 +00001553 sqlite3ExprAddCollateToken(pParse,pNewExpr2,&sCollSeqName),
drhae80dde2012-12-06 21:16:43 +00001554 pStr2, 0);
drh9eb20282005-08-24 03:52:18 +00001555 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001556 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001557 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +00001558 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +00001559 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +00001560 pWC->a[idxNew1].iParent = idxTerm;
1561 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +00001562 pTerm->nChild = 2;
1563 }
1564 }
1565#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +00001566
1567#ifndef SQLITE_OMIT_VIRTUALTABLE
1568 /* Add a WO_MATCH auxiliary term to the constraint set if the
1569 ** current expression is of the form: column MATCH expr.
1570 ** This information is used by the xBestIndex methods of
1571 ** virtual tables. The native query optimizer does not attempt
1572 ** to do anything with MATCH functions.
1573 */
1574 if( isMatchOfColumn(pExpr) ){
1575 int idxNew;
1576 Expr *pRight, *pLeft;
1577 WhereTerm *pNewTerm;
1578 Bitmask prereqColumn, prereqExpr;
1579
danielk19776ab3a2e2009-02-19 14:39:25 +00001580 pRight = pExpr->x.pList->a[0].pExpr;
1581 pLeft = pExpr->x.pList->a[1].pExpr;
drh7f375902006-06-13 17:38:59 +00001582 prereqExpr = exprTableUsage(pMaskSet, pRight);
1583 prereqColumn = exprTableUsage(pMaskSet, pLeft);
1584 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +00001585 Expr *pNewExpr;
drhb7916a72009-05-27 10:31:29 +00001586 pNewExpr = sqlite3PExpr(pParse, TK_MATCH,
1587 0, sqlite3ExprDup(db, pRight, 0), 0);
drh1a90e092006-06-14 22:07:10 +00001588 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001589 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001590 pNewTerm = &pWC->a[idxNew];
1591 pNewTerm->prereqRight = prereqExpr;
1592 pNewTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001593 pNewTerm->u.leftColumn = pLeft->iColumn;
drh7f375902006-06-13 17:38:59 +00001594 pNewTerm->eOperator = WO_MATCH;
1595 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +00001596 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +00001597 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001598 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001599 pNewTerm->prereqAll = pTerm->prereqAll;
1600 }
1601 }
1602#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001603
drhfaacf172011-08-12 01:51:45 +00001604#ifdef SQLITE_ENABLE_STAT3
drhd3ed7342011-09-21 00:09:41 +00001605 /* When sqlite_stat3 histogram data is available an operator of the
drh534230c2011-01-22 00:10:45 +00001606 ** form "x IS NOT NULL" can sometimes be evaluated more efficiently
1607 ** as "x>NULL" if x is not an INTEGER PRIMARY KEY. So construct a
1608 ** virtual term of that form.
1609 **
1610 ** Note that the virtual term must be tagged with TERM_VNULL. This
1611 ** TERM_VNULL tag will suppress the not-null check at the beginning
1612 ** of the loop. Without the TERM_VNULL flag, the not-null check at
1613 ** the start of the loop will prevent any results from being returned.
1614 */
drhea6dc442011-04-08 21:35:26 +00001615 if( pExpr->op==TK_NOTNULL
1616 && pExpr->pLeft->op==TK_COLUMN
1617 && pExpr->pLeft->iColumn>=0
1618 ){
drh534230c2011-01-22 00:10:45 +00001619 Expr *pNewExpr;
1620 Expr *pLeft = pExpr->pLeft;
1621 int idxNew;
1622 WhereTerm *pNewTerm;
1623
1624 pNewExpr = sqlite3PExpr(pParse, TK_GT,
1625 sqlite3ExprDup(db, pLeft, 0),
1626 sqlite3PExpr(pParse, TK_NULL, 0, 0, 0), 0);
1627
1628 idxNew = whereClauseInsert(pWC, pNewExpr,
1629 TERM_VIRTUAL|TERM_DYNAMIC|TERM_VNULL);
drhda91e712011-02-11 06:59:02 +00001630 if( idxNew ){
1631 pNewTerm = &pWC->a[idxNew];
1632 pNewTerm->prereqRight = 0;
1633 pNewTerm->leftCursor = pLeft->iTable;
1634 pNewTerm->u.leftColumn = pLeft->iColumn;
1635 pNewTerm->eOperator = WO_GT;
1636 pNewTerm->iParent = idxTerm;
1637 pTerm = &pWC->a[idxTerm];
1638 pTerm->nChild = 1;
1639 pTerm->wtFlags |= TERM_COPIED;
1640 pNewTerm->prereqAll = pTerm->prereqAll;
1641 }
drh534230c2011-01-22 00:10:45 +00001642 }
drhfaacf172011-08-12 01:51:45 +00001643#endif /* SQLITE_ENABLE_STAT */
drh534230c2011-01-22 00:10:45 +00001644
drhdafc0ce2008-04-17 19:14:02 +00001645 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1646 ** an index for tables to the left of the join.
1647 */
1648 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001649}
1650
drh7b4fc6a2007-02-06 13:26:32 +00001651/*
dan6f343962011-07-01 18:26:40 +00001652** This function searches the expression list passed as the second argument
1653** for an expression of type TK_COLUMN that refers to the same column and
1654** uses the same collation sequence as the iCol'th column of index pIdx.
1655** Argument iBase is the cursor number used for the table that pIdx refers
1656** to.
1657**
1658** If such an expression is found, its index in pList->a[] is returned. If
1659** no expression is found, -1 is returned.
1660*/
1661static int findIndexCol(
1662 Parse *pParse, /* Parse context */
1663 ExprList *pList, /* Expression list to search */
1664 int iBase, /* Cursor for table associated with pIdx */
1665 Index *pIdx, /* Index to match column of */
1666 int iCol /* Column of index to match */
1667){
1668 int i;
1669 const char *zColl = pIdx->azColl[iCol];
1670
1671 for(i=0; i<pList->nExpr; i++){
drh580c8c12012-12-08 03:34:04 +00001672 Expr *p = sqlite3ExprSkipCollate(pList->a[i].pExpr);
drhf1d3e322011-07-09 13:00:41 +00001673 if( p->op==TK_COLUMN
1674 && p->iColumn==pIdx->aiColumn[iCol]
1675 && p->iTable==iBase
1676 ){
drh580c8c12012-12-08 03:34:04 +00001677 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pList->a[i].pExpr);
drhf1d3e322011-07-09 13:00:41 +00001678 if( ALWAYS(pColl) && 0==sqlite3StrICmp(pColl->zName, zColl) ){
dan6f343962011-07-01 18:26:40 +00001679 return i;
1680 }
1681 }
1682 }
1683
1684 return -1;
1685}
1686
1687/*
1688** This routine determines if pIdx can be used to assist in processing a
1689** DISTINCT qualifier. In other words, it tests whether or not using this
1690** index for the outer loop guarantees that rows with equal values for
1691** all expressions in the pDistinct list are delivered grouped together.
1692**
1693** For example, the query
1694**
1695** SELECT DISTINCT a, b, c FROM tbl WHERE a = ?
1696**
1697** can benefit from any index on columns "b" and "c".
1698*/
1699static int isDistinctIndex(
1700 Parse *pParse, /* Parsing context */
1701 WhereClause *pWC, /* The WHERE clause */
1702 Index *pIdx, /* The index being considered */
1703 int base, /* Cursor number for the table pIdx is on */
1704 ExprList *pDistinct, /* The DISTINCT expressions */
1705 int nEqCol /* Number of index columns with == */
1706){
1707 Bitmask mask = 0; /* Mask of unaccounted for pDistinct exprs */
1708 int i; /* Iterator variable */
1709
drh04b85bc2012-10-01 17:44:05 +00001710 assert( pDistinct!=0 );
1711 if( pIdx->zName==0 || pDistinct->nExpr>=BMS ) return 0;
drhb24d83f2011-07-02 19:12:05 +00001712 testcase( pDistinct->nExpr==BMS-1 );
dan6f343962011-07-01 18:26:40 +00001713
1714 /* Loop through all the expressions in the distinct list. If any of them
1715 ** are not simple column references, return early. Otherwise, test if the
1716 ** WHERE clause contains a "col=X" clause. If it does, the expression
1717 ** can be ignored. If it does not, and the column does not belong to the
1718 ** same table as index pIdx, return early. Finally, if there is no
1719 ** matching "col=X" expression and the column is on the same table as pIdx,
1720 ** set the corresponding bit in variable mask.
1721 */
1722 for(i=0; i<pDistinct->nExpr; i++){
1723 WhereTerm *pTerm;
drh580c8c12012-12-08 03:34:04 +00001724 Expr *p = sqlite3ExprSkipCollate(pDistinct->a[i].pExpr);
dan6f343962011-07-01 18:26:40 +00001725 if( p->op!=TK_COLUMN ) return 0;
1726 pTerm = findTerm(pWC, p->iTable, p->iColumn, ~(Bitmask)0, WO_EQ, 0);
1727 if( pTerm ){
1728 Expr *pX = pTerm->pExpr;
1729 CollSeq *p1 = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
1730 CollSeq *p2 = sqlite3ExprCollSeq(pParse, p);
1731 if( p1==p2 ) continue;
1732 }
1733 if( p->iTable!=base ) return 0;
1734 mask |= (((Bitmask)1) << i);
1735 }
1736
1737 for(i=nEqCol; mask && i<pIdx->nColumn; i++){
1738 int iExpr = findIndexCol(pParse, pDistinct, base, pIdx, i);
1739 if( iExpr<0 ) break;
1740 mask &= ~(((Bitmask)1) << iExpr);
1741 }
1742
1743 return (mask==0);
1744}
1745
1746
1747/*
1748** Return true if the DISTINCT expression-list passed as the third argument
1749** is redundant. A DISTINCT list is redundant if the database contains a
1750** UNIQUE index that guarantees that the result of the query will be distinct
1751** anyway.
1752*/
1753static int isDistinctRedundant(
1754 Parse *pParse,
1755 SrcList *pTabList,
1756 WhereClause *pWC,
1757 ExprList *pDistinct
1758){
1759 Table *pTab;
1760 Index *pIdx;
1761 int i;
1762 int iBase;
1763
1764 /* If there is more than one table or sub-select in the FROM clause of
1765 ** this query, then it will not be possible to show that the DISTINCT
1766 ** clause is redundant. */
1767 if( pTabList->nSrc!=1 ) return 0;
1768 iBase = pTabList->a[0].iCursor;
1769 pTab = pTabList->a[0].pTab;
1770
dan94e08d92011-07-02 06:44:05 +00001771 /* If any of the expressions is an IPK column on table iBase, then return
1772 ** true. Note: The (p->iTable==iBase) part of this test may be false if the
1773 ** current SELECT is a correlated sub-query.
1774 */
dan6f343962011-07-01 18:26:40 +00001775 for(i=0; i<pDistinct->nExpr; i++){
drh580c8c12012-12-08 03:34:04 +00001776 Expr *p = sqlite3ExprSkipCollate(pDistinct->a[i].pExpr);
dan94e08d92011-07-02 06:44:05 +00001777 if( p->op==TK_COLUMN && p->iTable==iBase && p->iColumn<0 ) return 1;
dan6f343962011-07-01 18:26:40 +00001778 }
1779
1780 /* Loop through all indices on the table, checking each to see if it makes
1781 ** the DISTINCT qualifier redundant. It does so if:
1782 **
1783 ** 1. The index is itself UNIQUE, and
1784 **
1785 ** 2. All of the columns in the index are either part of the pDistinct
1786 ** list, or else the WHERE clause contains a term of the form "col=X",
1787 ** where X is a constant value. The collation sequences of the
1788 ** comparison and select-list expressions must match those of the index.
dan6a36f432012-04-20 16:59:24 +00001789 **
1790 ** 3. All of those index columns for which the WHERE clause does not
1791 ** contain a "col=X" term are subject to a NOT NULL constraint.
dan6f343962011-07-01 18:26:40 +00001792 */
1793 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1794 if( pIdx->onError==OE_None ) continue;
1795 for(i=0; i<pIdx->nColumn; i++){
1796 int iCol = pIdx->aiColumn[i];
dan6a36f432012-04-20 16:59:24 +00001797 if( 0==findTerm(pWC, iBase, iCol, ~(Bitmask)0, WO_EQ, pIdx) ){
1798 int iIdxCol = findIndexCol(pParse, pDistinct, iBase, pIdx, i);
1799 if( iIdxCol<0 || pTab->aCol[pIdx->aiColumn[i]].notNull==0 ){
1800 break;
1801 }
dan6f343962011-07-01 18:26:40 +00001802 }
1803 }
1804 if( i==pIdx->nColumn ){
1805 /* This index implies that the DISTINCT qualifier is redundant. */
1806 return 1;
1807 }
1808 }
1809
1810 return 0;
1811}
drh0fcef5e2005-07-19 17:38:22 +00001812
drh75897232000-05-29 14:26:00 +00001813/*
drhb6fb62d2005-09-20 08:47:20 +00001814** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +00001815** The results need not be exact. This is only used for estimating
drh909626d2008-05-30 14:58:37 +00001816** the total cost of performing operations with O(logN) or O(NlogN)
drh28c4cf42005-07-27 20:41:43 +00001817** complexity. Because N is just a guess, it is no great tragedy if
1818** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +00001819*/
1820static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +00001821 double logN = 1;
1822 double x = 10;
drh28c4cf42005-07-27 20:41:43 +00001823 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +00001824 logN += 1;
drh28c4cf42005-07-27 20:41:43 +00001825 x *= 10;
1826 }
1827 return logN;
1828}
1829
drh6d209d82006-06-27 01:54:26 +00001830/*
1831** Two routines for printing the content of an sqlite3_index_info
1832** structure. Used for testing and debugging only. If neither
1833** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1834** are no-ops.
1835*/
drh77a2a5e2007-04-06 01:04:39 +00001836#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_DEBUG)
drh6d209d82006-06-27 01:54:26 +00001837static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1838 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001839 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001840 for(i=0; i<p->nConstraint; i++){
1841 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1842 i,
1843 p->aConstraint[i].iColumn,
1844 p->aConstraint[i].iTermOffset,
1845 p->aConstraint[i].op,
1846 p->aConstraint[i].usable);
1847 }
1848 for(i=0; i<p->nOrderBy; i++){
1849 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1850 i,
1851 p->aOrderBy[i].iColumn,
1852 p->aOrderBy[i].desc);
1853 }
1854}
1855static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1856 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001857 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001858 for(i=0; i<p->nConstraint; i++){
1859 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1860 i,
1861 p->aConstraintUsage[i].argvIndex,
1862 p->aConstraintUsage[i].omit);
1863 }
1864 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1865 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1866 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1867 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
1868}
1869#else
1870#define TRACE_IDX_INPUTS(A)
1871#define TRACE_IDX_OUTPUTS(A)
1872#endif
1873
danielk19771d461462009-04-21 09:02:45 +00001874/*
1875** Required because bestIndex() is called by bestOrClauseIndex()
1876*/
drh56f1b992012-09-25 14:29:39 +00001877static void bestIndex(WhereBestIdx*);
danielk19771d461462009-04-21 09:02:45 +00001878
1879/*
1880** This routine attempts to find an scanning strategy that can be used
1881** to optimize an 'OR' expression that is part of a WHERE clause.
1882**
1883** The table associated with FROM clause term pSrc may be either a
1884** regular B-Tree table or a virtual table.
1885*/
drh56f1b992012-09-25 14:29:39 +00001886static void bestOrClauseIndex(WhereBestIdx *p){
danielk19771d461462009-04-21 09:02:45 +00001887#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drh56f1b992012-09-25 14:29:39 +00001888 WhereClause *pWC = p->pWC; /* The WHERE clause */
1889 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
1890 const int iCur = pSrc->iCursor; /* The cursor of the table */
danielk19771d461462009-04-21 09:02:45 +00001891 const Bitmask maskSrc = getMask(pWC->pMaskSet, iCur); /* Bitmask for pSrc */
1892 WhereTerm * const pWCEnd = &pWC->a[pWC->nTerm]; /* End of pWC->a[] */
drh56f1b992012-09-25 14:29:39 +00001893 WhereTerm *pTerm; /* A single term of the WHERE clause */
danielk19771d461462009-04-21 09:02:45 +00001894
drh9ef61f42011-10-07 14:40:59 +00001895 /* The OR-clause optimization is disallowed if the INDEXED BY or
1896 ** NOT INDEXED clauses are used or if the WHERE_AND_ONLY bit is set. */
drh75ad2602010-10-21 02:05:06 +00001897 if( pSrc->notIndexed || pSrc->pIndex!=0 ){
drhed754ce2010-04-15 01:04:54 +00001898 return;
1899 }
drh9ef61f42011-10-07 14:40:59 +00001900 if( pWC->wctrlFlags & WHERE_AND_ONLY ){
1901 return;
1902 }
drhed754ce2010-04-15 01:04:54 +00001903
danielk19771d461462009-04-21 09:02:45 +00001904 /* Search the WHERE clause terms for a usable WO_OR term. */
1905 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001906 if( (pTerm->eOperator & WO_OR)!=0
drh56f1b992012-09-25 14:29:39 +00001907 && ((pTerm->prereqAll & ~maskSrc) & p->notReady)==0
danielk19771d461462009-04-21 09:02:45 +00001908 && (pTerm->u.pOrInfo->indexable & maskSrc)!=0
1909 ){
1910 WhereClause * const pOrWC = &pTerm->u.pOrInfo->wc;
1911 WhereTerm * const pOrWCEnd = &pOrWC->a[pOrWC->nTerm];
1912 WhereTerm *pOrTerm;
danielk19771d461462009-04-21 09:02:45 +00001913 double rTotal = 0;
1914 double nRow = 0;
dan5236ac12009-08-13 07:09:33 +00001915 Bitmask used = 0;
drh56f1b992012-09-25 14:29:39 +00001916 WhereBestIdx sBOI;
danielk19771d461462009-04-21 09:02:45 +00001917
drh56f1b992012-09-25 14:29:39 +00001918 sBOI = *p;
1919 sBOI.pOrderBy = 0;
1920 sBOI.pDistinct = 0;
1921 sBOI.ppIdxInfo = 0;
danielk19771d461462009-04-21 09:02:45 +00001922 for(pOrTerm=pOrWC->a; pOrTerm<pOrWCEnd; pOrTerm++){
drhf1b5f5b2013-05-02 00:15:01 +00001923 /*WHERETRACE(("... Multi-index OR testing for term %d of %d....\n",
danielk19771d461462009-04-21 09:02:45 +00001924 (pOrTerm - pOrWC->a), (pTerm - pWC->a)
drhf1b5f5b2013-05-02 00:15:01 +00001925 ));*/
drh7a5bcc02013-01-16 17:08:58 +00001926 if( (pOrTerm->eOperator& WO_AND)!=0 ){
drh56f1b992012-09-25 14:29:39 +00001927 sBOI.pWC = &pOrTerm->u.pAndInfo->wc;
1928 bestIndex(&sBOI);
danielk19771d461462009-04-21 09:02:45 +00001929 }else if( pOrTerm->leftCursor==iCur ){
1930 WhereClause tempWC;
1931 tempWC.pParse = pWC->pParse;
1932 tempWC.pMaskSet = pWC->pMaskSet;
drh8871ef52011-10-07 13:33:10 +00001933 tempWC.pOuter = pWC;
danielk19771d461462009-04-21 09:02:45 +00001934 tempWC.op = TK_AND;
1935 tempWC.a = pOrTerm;
drha2153f72011-10-18 19:14:33 +00001936 tempWC.wctrlFlags = 0;
danielk19771d461462009-04-21 09:02:45 +00001937 tempWC.nTerm = 1;
drh56f1b992012-09-25 14:29:39 +00001938 sBOI.pWC = &tempWC;
1939 bestIndex(&sBOI);
danielk19771d461462009-04-21 09:02:45 +00001940 }else{
1941 continue;
1942 }
drh56f1b992012-09-25 14:29:39 +00001943 rTotal += sBOI.cost.rCost;
1944 nRow += sBOI.cost.plan.nRow;
1945 used |= sBOI.cost.used;
1946 if( rTotal>=p->cost.rCost ) break;
danielk19771d461462009-04-21 09:02:45 +00001947 }
1948
1949 /* If there is an ORDER BY clause, increase the scan cost to account
1950 ** for the cost of the sort. */
drh56f1b992012-09-25 14:29:39 +00001951 if( p->pOrderBy!=0 ){
drhf1b5f5b2013-05-02 00:15:01 +00001952 /*WHERETRACE(("... sorting increases OR cost %.9g to %.9g\n",
1953 rTotal, rTotal+nRow*estLog(nRow)));*/
danielk19771d461462009-04-21 09:02:45 +00001954 rTotal += nRow*estLog(nRow);
danielk19771d461462009-04-21 09:02:45 +00001955 }
1956
1957 /* If the cost of scanning using this OR term for optimization is
1958 ** less than the current cost stored in pCost, replace the contents
1959 ** of pCost. */
drhf1b5f5b2013-05-02 00:15:01 +00001960 /*WHERETRACE(("... multi-index OR cost=%.9g nrow=%.9g\n", rTotal, nRow));*/
drh56f1b992012-09-25 14:29:39 +00001961 if( rTotal<p->cost.rCost ){
1962 p->cost.rCost = rTotal;
1963 p->cost.used = used;
1964 p->cost.plan.nRow = nRow;
drhd663b5b2012-10-03 00:25:54 +00001965 p->cost.plan.nOBSat = p->i ? p->aLevel[p->i-1].plan.nOBSat : 0;
drh6b7157b2013-05-10 02:00:35 +00001966 p->cost.plan.wsFlags = WHERE_MULTI_OR;
drh56f1b992012-09-25 14:29:39 +00001967 p->cost.plan.u.pTerm = pTerm;
danielk19771d461462009-04-21 09:02:45 +00001968 }
1969 }
1970 }
1971#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1972}
1973
drhc6339082010-04-07 16:54:58 +00001974#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00001975/*
drh4139c992010-04-07 14:59:45 +00001976** Return TRUE if the WHERE clause term pTerm is of a form where it
1977** could be used with an index to access pSrc, assuming an appropriate
1978** index existed.
1979*/
1980static int termCanDriveIndex(
1981 WhereTerm *pTerm, /* WHERE clause term to check */
1982 struct SrcList_item *pSrc, /* Table we are trying to access */
1983 Bitmask notReady /* Tables in outer loops of the join */
1984){
1985 char aff;
1986 if( pTerm->leftCursor!=pSrc->iCursor ) return 0;
drh7a5bcc02013-01-16 17:08:58 +00001987 if( (pTerm->eOperator & WO_EQ)==0 ) return 0;
drh4139c992010-04-07 14:59:45 +00001988 if( (pTerm->prereqRight & notReady)!=0 ) return 0;
1989 aff = pSrc->pTab->aCol[pTerm->u.leftColumn].affinity;
1990 if( !sqlite3IndexAffinityOk(pTerm->pExpr, aff) ) return 0;
1991 return 1;
1992}
drhc6339082010-04-07 16:54:58 +00001993#endif
drh4139c992010-04-07 14:59:45 +00001994
drhc6339082010-04-07 16:54:58 +00001995#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh4139c992010-04-07 14:59:45 +00001996/*
drh8b307fb2010-04-06 15:57:05 +00001997** If the query plan for pSrc specified in pCost is a full table scan
drh4139c992010-04-07 14:59:45 +00001998** and indexing is allows (if there is no NOT INDEXED clause) and it
drh8b307fb2010-04-06 15:57:05 +00001999** possible to construct a transient index that would perform better
2000** than a full table scan even when the cost of constructing the index
2001** is taken into account, then alter the query plan to use the
2002** transient index.
2003*/
drh56f1b992012-09-25 14:29:39 +00002004static void bestAutomaticIndex(WhereBestIdx *p){
2005 Parse *pParse = p->pParse; /* The parsing context */
2006 WhereClause *pWC = p->pWC; /* The WHERE clause */
2007 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
2008 double nTableRow; /* Rows in the input table */
2009 double logN; /* log(nTableRow) */
drh8b307fb2010-04-06 15:57:05 +00002010 double costTempIdx; /* per-query cost of the transient index */
2011 WhereTerm *pTerm; /* A single term of the WHERE clause */
2012 WhereTerm *pWCEnd; /* End of pWC->a[] */
drh424aab82010-04-06 18:28:20 +00002013 Table *pTable; /* Table tht might be indexed */
drh8b307fb2010-04-06 15:57:05 +00002014
dan969e5592011-07-02 15:32:57 +00002015 if( pParse->nQueryLoop<=(double)1 ){
2016 /* There is no point in building an automatic index for a single scan */
2017 return;
2018 }
drhc6339082010-04-07 16:54:58 +00002019 if( (pParse->db->flags & SQLITE_AutoIndex)==0 ){
2020 /* Automatic indices are disabled at run-time */
2021 return;
2022 }
drh447b2892012-10-26 18:40:01 +00002023 if( (p->cost.plan.wsFlags & WHERE_NOT_FULLSCAN)!=0
2024 && (p->cost.plan.wsFlags & WHERE_COVER_SCAN)==0
2025 ){
drh8b307fb2010-04-06 15:57:05 +00002026 /* We already have some kind of index in use for this query. */
2027 return;
2028 }
drhda998c82012-10-30 15:31:31 +00002029 if( pSrc->viaCoroutine ){
2030 /* Cannot index a co-routine */
2031 return;
2032 }
drh8b307fb2010-04-06 15:57:05 +00002033 if( pSrc->notIndexed ){
2034 /* The NOT INDEXED clause appears in the SQL. */
2035 return;
2036 }
danda79cf02011-07-08 16:10:54 +00002037 if( pSrc->isCorrelated ){
2038 /* The source is a correlated sub-query. No point in indexing it. */
2039 return;
2040 }
drh8b307fb2010-04-06 15:57:05 +00002041
2042 assert( pParse->nQueryLoop >= (double)1 );
drh8bd54122010-04-08 15:00:59 +00002043 pTable = pSrc->pTab;
drh15564052010-09-25 22:32:56 +00002044 nTableRow = pTable->nRowEst;
drh8b307fb2010-04-06 15:57:05 +00002045 logN = estLog(nTableRow);
2046 costTempIdx = 2*logN*(nTableRow/pParse->nQueryLoop + 1);
drh56f1b992012-09-25 14:29:39 +00002047 if( costTempIdx>=p->cost.rCost ){
drh8b307fb2010-04-06 15:57:05 +00002048 /* The cost of creating the transient table would be greater than
2049 ** doing the full table scan */
2050 return;
2051 }
2052
2053 /* Search for any equality comparison term */
2054 pWCEnd = &pWC->a[pWC->nTerm];
2055 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh56f1b992012-09-25 14:29:39 +00002056 if( termCanDriveIndex(pTerm, pSrc, p->notReady) ){
drhf1b5f5b2013-05-02 00:15:01 +00002057 /*WHERETRACE(("auto-index reduces cost from %.1f to %.1f\n",
2058 p->cost.rCost, costTempIdx));*/
drh56f1b992012-09-25 14:29:39 +00002059 p->cost.rCost = costTempIdx;
2060 p->cost.plan.nRow = logN + 1;
2061 p->cost.plan.wsFlags = WHERE_TEMP_INDEX;
2062 p->cost.used = pTerm->prereqRight;
drh8b307fb2010-04-06 15:57:05 +00002063 break;
2064 }
2065 }
2066}
drhc6339082010-04-07 16:54:58 +00002067#else
drh56f1b992012-09-25 14:29:39 +00002068# define bestAutomaticIndex(A) /* no-op */
drhc6339082010-04-07 16:54:58 +00002069#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh8b307fb2010-04-06 15:57:05 +00002070
drhc6339082010-04-07 16:54:58 +00002071
2072#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00002073/*
drhc6339082010-04-07 16:54:58 +00002074** Generate code to construct the Index object for an automatic index
2075** and to set up the WhereLevel object pLevel so that the code generator
2076** makes use of the automatic index.
drh8b307fb2010-04-06 15:57:05 +00002077*/
drhc6339082010-04-07 16:54:58 +00002078static void constructAutomaticIndex(
drh8b307fb2010-04-06 15:57:05 +00002079 Parse *pParse, /* The parsing context */
2080 WhereClause *pWC, /* The WHERE clause */
2081 struct SrcList_item *pSrc, /* The FROM clause term to get the next index */
2082 Bitmask notReady, /* Mask of cursors that are not available */
2083 WhereLevel *pLevel /* Write new index here */
2084){
2085 int nColumn; /* Number of columns in the constructed index */
2086 WhereTerm *pTerm; /* A single term of the WHERE clause */
2087 WhereTerm *pWCEnd; /* End of pWC->a[] */
2088 int nByte; /* Byte of memory needed for pIdx */
2089 Index *pIdx; /* Object describing the transient index */
2090 Vdbe *v; /* Prepared statement under construction */
drh8b307fb2010-04-06 15:57:05 +00002091 int addrInit; /* Address of the initialization bypass jump */
2092 Table *pTable; /* The table being indexed */
2093 KeyInfo *pKeyinfo; /* Key information for the index */
2094 int addrTop; /* Top of the index fill loop */
2095 int regRecord; /* Register holding an index record */
2096 int n; /* Column counter */
drh4139c992010-04-07 14:59:45 +00002097 int i; /* Loop counter */
2098 int mxBitCol; /* Maximum column in pSrc->colUsed */
drh424aab82010-04-06 18:28:20 +00002099 CollSeq *pColl; /* Collating sequence to on a column */
drh4139c992010-04-07 14:59:45 +00002100 Bitmask idxCols; /* Bitmap of columns used for indexing */
2101 Bitmask extraCols; /* Bitmap of additional columns */
drh8b307fb2010-04-06 15:57:05 +00002102
2103 /* Generate code to skip over the creation and initialization of the
2104 ** transient index on 2nd and subsequent iterations of the loop. */
2105 v = pParse->pVdbe;
2106 assert( v!=0 );
dan1d8cb212011-12-09 13:24:16 +00002107 addrInit = sqlite3CodeOnce(pParse);
drh8b307fb2010-04-06 15:57:05 +00002108
drh4139c992010-04-07 14:59:45 +00002109 /* Count the number of columns that will be added to the index
2110 ** and used to match WHERE clause constraints */
drh8b307fb2010-04-06 15:57:05 +00002111 nColumn = 0;
drh424aab82010-04-06 18:28:20 +00002112 pTable = pSrc->pTab;
drh8b307fb2010-04-06 15:57:05 +00002113 pWCEnd = &pWC->a[pWC->nTerm];
drh4139c992010-04-07 14:59:45 +00002114 idxCols = 0;
drh8b307fb2010-04-06 15:57:05 +00002115 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00002116 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
2117 int iCol = pTerm->u.leftColumn;
drh0013e722010-04-08 00:40:15 +00002118 Bitmask cMask = iCol>=BMS ? ((Bitmask)1)<<(BMS-1) : ((Bitmask)1)<<iCol;
drh52ff8ea2010-04-08 14:15:56 +00002119 testcase( iCol==BMS );
2120 testcase( iCol==BMS-1 );
drh0013e722010-04-08 00:40:15 +00002121 if( (idxCols & cMask)==0 ){
2122 nColumn++;
2123 idxCols |= cMask;
2124 }
drh8b307fb2010-04-06 15:57:05 +00002125 }
2126 }
2127 assert( nColumn>0 );
drh424aab82010-04-06 18:28:20 +00002128 pLevel->plan.nEq = nColumn;
drh4139c992010-04-07 14:59:45 +00002129
2130 /* Count the number of additional columns needed to create a
2131 ** covering index. A "covering index" is an index that contains all
2132 ** columns that are needed by the query. With a covering index, the
2133 ** original table never needs to be accessed. Automatic indices must
2134 ** be a covering index because the index will not be updated if the
2135 ** original table changes and the index and table cannot both be used
2136 ** if they go out of sync.
2137 */
drh0013e722010-04-08 00:40:15 +00002138 extraCols = pSrc->colUsed & (~idxCols | (((Bitmask)1)<<(BMS-1)));
drh4139c992010-04-07 14:59:45 +00002139 mxBitCol = (pTable->nCol >= BMS-1) ? BMS-1 : pTable->nCol;
drh52ff8ea2010-04-08 14:15:56 +00002140 testcase( pTable->nCol==BMS-1 );
2141 testcase( pTable->nCol==BMS-2 );
drh4139c992010-04-07 14:59:45 +00002142 for(i=0; i<mxBitCol; i++){
drh67ae0cb2010-04-08 14:38:51 +00002143 if( extraCols & (((Bitmask)1)<<i) ) nColumn++;
drh4139c992010-04-07 14:59:45 +00002144 }
2145 if( pSrc->colUsed & (((Bitmask)1)<<(BMS-1)) ){
2146 nColumn += pTable->nCol - BMS + 1;
2147 }
drh6b7157b2013-05-10 02:00:35 +00002148 pLevel->plan.wsFlags |= WHERE_COLUMN_EQ | WHERE_IDX_ONLY;
drh8b307fb2010-04-06 15:57:05 +00002149
2150 /* Construct the Index object to describe this index */
2151 nByte = sizeof(Index);
2152 nByte += nColumn*sizeof(int); /* Index.aiColumn */
2153 nByte += nColumn*sizeof(char*); /* Index.azColl */
2154 nByte += nColumn; /* Index.aSortOrder */
2155 pIdx = sqlite3DbMallocZero(pParse->db, nByte);
2156 if( pIdx==0 ) return;
2157 pLevel->plan.u.pIdx = pIdx;
2158 pIdx->azColl = (char**)&pIdx[1];
2159 pIdx->aiColumn = (int*)&pIdx->azColl[nColumn];
2160 pIdx->aSortOrder = (u8*)&pIdx->aiColumn[nColumn];
2161 pIdx->zName = "auto-index";
2162 pIdx->nColumn = nColumn;
drh424aab82010-04-06 18:28:20 +00002163 pIdx->pTable = pTable;
drh8b307fb2010-04-06 15:57:05 +00002164 n = 0;
drh0013e722010-04-08 00:40:15 +00002165 idxCols = 0;
drh8b307fb2010-04-06 15:57:05 +00002166 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00002167 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
drh0013e722010-04-08 00:40:15 +00002168 int iCol = pTerm->u.leftColumn;
2169 Bitmask cMask = iCol>=BMS ? ((Bitmask)1)<<(BMS-1) : ((Bitmask)1)<<iCol;
2170 if( (idxCols & cMask)==0 ){
2171 Expr *pX = pTerm->pExpr;
2172 idxCols |= cMask;
2173 pIdx->aiColumn[n] = pTerm->u.leftColumn;
2174 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
drh6f2e6c02011-02-17 13:33:15 +00002175 pIdx->azColl[n] = ALWAYS(pColl) ? pColl->zName : "BINARY";
drh0013e722010-04-08 00:40:15 +00002176 n++;
2177 }
drh8b307fb2010-04-06 15:57:05 +00002178 }
2179 }
shaneh5eba1f62010-07-02 17:05:03 +00002180 assert( (u32)n==pLevel->plan.nEq );
drh4139c992010-04-07 14:59:45 +00002181
drhc6339082010-04-07 16:54:58 +00002182 /* Add additional columns needed to make the automatic index into
2183 ** a covering index */
drh4139c992010-04-07 14:59:45 +00002184 for(i=0; i<mxBitCol; i++){
drh67ae0cb2010-04-08 14:38:51 +00002185 if( extraCols & (((Bitmask)1)<<i) ){
drh4139c992010-04-07 14:59:45 +00002186 pIdx->aiColumn[n] = i;
2187 pIdx->azColl[n] = "BINARY";
2188 n++;
2189 }
2190 }
2191 if( pSrc->colUsed & (((Bitmask)1)<<(BMS-1)) ){
2192 for(i=BMS-1; i<pTable->nCol; i++){
2193 pIdx->aiColumn[n] = i;
2194 pIdx->azColl[n] = "BINARY";
2195 n++;
2196 }
2197 }
2198 assert( n==nColumn );
drh8b307fb2010-04-06 15:57:05 +00002199
drhc6339082010-04-07 16:54:58 +00002200 /* Create the automatic index */
drh8b307fb2010-04-06 15:57:05 +00002201 pKeyinfo = sqlite3IndexKeyinfo(pParse, pIdx);
2202 assert( pLevel->iIdxCur>=0 );
drha21a64d2010-04-06 22:33:55 +00002203 sqlite3VdbeAddOp4(v, OP_OpenAutoindex, pLevel->iIdxCur, nColumn+1, 0,
drh8b307fb2010-04-06 15:57:05 +00002204 (char*)pKeyinfo, P4_KEYINFO_HANDOFF);
drha21a64d2010-04-06 22:33:55 +00002205 VdbeComment((v, "for %s", pTable->zName));
drh8b307fb2010-04-06 15:57:05 +00002206
drhc6339082010-04-07 16:54:58 +00002207 /* Fill the automatic index with content */
drh8b307fb2010-04-06 15:57:05 +00002208 addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, pLevel->iTabCur);
2209 regRecord = sqlite3GetTempReg(pParse);
2210 sqlite3GenerateIndexKey(pParse, pIdx, pLevel->iTabCur, regRecord, 1);
2211 sqlite3VdbeAddOp2(v, OP_IdxInsert, pLevel->iIdxCur, regRecord);
2212 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2213 sqlite3VdbeAddOp2(v, OP_Next, pLevel->iTabCur, addrTop+1);
drha21a64d2010-04-06 22:33:55 +00002214 sqlite3VdbeChangeP5(v, SQLITE_STMTSTATUS_AUTOINDEX);
drh8b307fb2010-04-06 15:57:05 +00002215 sqlite3VdbeJumpHere(v, addrTop);
2216 sqlite3ReleaseTempReg(pParse, regRecord);
2217
2218 /* Jump here when skipping the initialization */
2219 sqlite3VdbeJumpHere(v, addrInit);
2220}
drhc6339082010-04-07 16:54:58 +00002221#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh8b307fb2010-04-06 15:57:05 +00002222
drh9eff6162006-06-12 21:59:13 +00002223#ifndef SQLITE_OMIT_VIRTUALTABLE
2224/*
danielk19771d461462009-04-21 09:02:45 +00002225** Allocate and populate an sqlite3_index_info structure. It is the
2226** responsibility of the caller to eventually release the structure
2227** by passing the pointer returned by this function to sqlite3_free().
2228*/
drh5346e952013-05-08 14:14:26 +00002229static sqlite3_index_info *allocateIndexInfo(
2230 Parse *pParse,
2231 WhereClause *pWC,
2232 struct SrcList_item *pSrc,
2233 ExprList *pOrderBy
2234){
danielk19771d461462009-04-21 09:02:45 +00002235 int i, j;
2236 int nTerm;
2237 struct sqlite3_index_constraint *pIdxCons;
2238 struct sqlite3_index_orderby *pIdxOrderBy;
2239 struct sqlite3_index_constraint_usage *pUsage;
2240 WhereTerm *pTerm;
2241 int nOrderBy;
2242 sqlite3_index_info *pIdxInfo;
2243
drhf1b5f5b2013-05-02 00:15:01 +00002244 /*WHERETRACE(("Recomputing index info for %s...\n", pSrc->pTab->zName));*/
danielk19771d461462009-04-21 09:02:45 +00002245
2246 /* Count the number of possible WHERE clause constraints referring
2247 ** to this virtual table */
2248 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
2249 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh7a5bcc02013-01-16 17:08:58 +00002250 assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
2251 testcase( pTerm->eOperator & WO_IN );
2252 testcase( pTerm->eOperator & WO_ISNULL );
drh281bbe22012-10-16 23:17:14 +00002253 if( pTerm->eOperator & (WO_ISNULL) ) continue;
drhb4256992011-08-02 01:57:39 +00002254 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00002255 nTerm++;
2256 }
2257
2258 /* If the ORDER BY clause contains only columns in the current
2259 ** virtual table then allocate space for the aOrderBy part of
2260 ** the sqlite3_index_info structure.
2261 */
2262 nOrderBy = 0;
2263 if( pOrderBy ){
drh56f1b992012-09-25 14:29:39 +00002264 int n = pOrderBy->nExpr;
2265 for(i=0; i<n; i++){
danielk19771d461462009-04-21 09:02:45 +00002266 Expr *pExpr = pOrderBy->a[i].pExpr;
2267 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
2268 }
drh56f1b992012-09-25 14:29:39 +00002269 if( i==n){
2270 nOrderBy = n;
danielk19771d461462009-04-21 09:02:45 +00002271 }
2272 }
2273
2274 /* Allocate the sqlite3_index_info structure
2275 */
2276 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
2277 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
2278 + sizeof(*pIdxOrderBy)*nOrderBy );
2279 if( pIdxInfo==0 ){
2280 sqlite3ErrorMsg(pParse, "out of memory");
2281 /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
2282 return 0;
2283 }
2284
2285 /* Initialize the structure. The sqlite3_index_info structure contains
2286 ** many fields that are declared "const" to prevent xBestIndex from
2287 ** changing them. We have to do some funky casting in order to
2288 ** initialize those fields.
2289 */
2290 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
2291 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
2292 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
2293 *(int*)&pIdxInfo->nConstraint = nTerm;
2294 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
2295 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
2296 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
2297 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
2298 pUsage;
2299
2300 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
drh281bbe22012-10-16 23:17:14 +00002301 u8 op;
danielk19771d461462009-04-21 09:02:45 +00002302 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh7a5bcc02013-01-16 17:08:58 +00002303 assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
2304 testcase( pTerm->eOperator & WO_IN );
2305 testcase( pTerm->eOperator & WO_ISNULL );
drh281bbe22012-10-16 23:17:14 +00002306 if( pTerm->eOperator & (WO_ISNULL) ) continue;
drhb4256992011-08-02 01:57:39 +00002307 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00002308 pIdxCons[j].iColumn = pTerm->u.leftColumn;
2309 pIdxCons[j].iTermOffset = i;
drh7a5bcc02013-01-16 17:08:58 +00002310 op = (u8)pTerm->eOperator & WO_ALL;
drh281bbe22012-10-16 23:17:14 +00002311 if( op==WO_IN ) op = WO_EQ;
2312 pIdxCons[j].op = op;
danielk19771d461462009-04-21 09:02:45 +00002313 /* The direct assignment in the previous line is possible only because
2314 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
2315 ** following asserts verify this fact. */
2316 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
2317 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
2318 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
2319 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
2320 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
2321 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
drh281bbe22012-10-16 23:17:14 +00002322 assert( pTerm->eOperator & (WO_IN|WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
danielk19771d461462009-04-21 09:02:45 +00002323 j++;
2324 }
2325 for(i=0; i<nOrderBy; i++){
2326 Expr *pExpr = pOrderBy->a[i].pExpr;
2327 pIdxOrderBy[i].iColumn = pExpr->iColumn;
2328 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
2329 }
2330
2331 return pIdxInfo;
2332}
2333
2334/*
2335** The table object reference passed as the second argument to this function
2336** must represent a virtual table. This function invokes the xBestIndex()
2337** method of the virtual table with the sqlite3_index_info pointer passed
2338** as the argument.
2339**
2340** If an error occurs, pParse is populated with an error message and a
2341** non-zero value is returned. Otherwise, 0 is returned and the output
2342** part of the sqlite3_index_info structure is left populated.
2343**
2344** Whether or not an error is returned, it is the responsibility of the
2345** caller to eventually free p->idxStr if p->needToFreeIdxStr indicates
2346** that this is required.
2347*/
2348static int vtabBestIndex(Parse *pParse, Table *pTab, sqlite3_index_info *p){
danielk1977595a5232009-07-24 17:58:53 +00002349 sqlite3_vtab *pVtab = sqlite3GetVTable(pParse->db, pTab)->pVtab;
danielk19771d461462009-04-21 09:02:45 +00002350 int i;
2351 int rc;
2352
drhf1b5f5b2013-05-02 00:15:01 +00002353 /*WHERETRACE(("xBestIndex for %s\n", pTab->zName));*/
danielk19771d461462009-04-21 09:02:45 +00002354 TRACE_IDX_INPUTS(p);
2355 rc = pVtab->pModule->xBestIndex(pVtab, p);
2356 TRACE_IDX_OUTPUTS(p);
danielk19771d461462009-04-21 09:02:45 +00002357
2358 if( rc!=SQLITE_OK ){
2359 if( rc==SQLITE_NOMEM ){
2360 pParse->db->mallocFailed = 1;
2361 }else if( !pVtab->zErrMsg ){
2362 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
2363 }else{
2364 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
2365 }
2366 }
drhb9755982010-07-24 16:34:37 +00002367 sqlite3_free(pVtab->zErrMsg);
danielk19771d461462009-04-21 09:02:45 +00002368 pVtab->zErrMsg = 0;
2369
2370 for(i=0; i<p->nConstraint; i++){
2371 if( !p->aConstraint[i].usable && p->aConstraintUsage[i].argvIndex>0 ){
2372 sqlite3ErrorMsg(pParse,
2373 "table %s: xBestIndex returned an invalid plan", pTab->zName);
2374 }
2375 }
2376
2377 return pParse->nErr;
2378}
2379
2380
2381/*
drh7f375902006-06-13 17:38:59 +00002382** Compute the best index for a virtual table.
2383**
2384** The best index is computed by the xBestIndex method of the virtual
2385** table module. This routine is really just a wrapper that sets up
2386** the sqlite3_index_info structure that is used to communicate with
2387** xBestIndex.
2388**
2389** In a join, this routine might be called multiple times for the
2390** same virtual table. The sqlite3_index_info structure is created
2391** and initialized on the first invocation and reused on all subsequent
2392** invocations. The sqlite3_index_info structure is also used when
2393** code is generated to access the virtual table. The whereInfoDelete()
2394** routine takes care of freeing the sqlite3_index_info structure after
2395** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00002396*/
drh56f1b992012-09-25 14:29:39 +00002397static void bestVirtualIndex(WhereBestIdx *p){
2398 Parse *pParse = p->pParse; /* The parsing context */
2399 WhereClause *pWC = p->pWC; /* The WHERE clause */
2400 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
drh9eff6162006-06-12 21:59:13 +00002401 Table *pTab = pSrc->pTab;
2402 sqlite3_index_info *pIdxInfo;
2403 struct sqlite3_index_constraint *pIdxCons;
drh9eff6162006-06-12 21:59:13 +00002404 struct sqlite3_index_constraint_usage *pUsage;
2405 WhereTerm *pTerm;
drh83b5bfc2013-04-18 02:55:54 +00002406 int i, j;
drh9eff6162006-06-12 21:59:13 +00002407 int nOrderBy;
drhe40ed782012-12-14 15:36:17 +00002408 int bAllowIN; /* Allow IN optimizations */
danc26c0042010-03-27 09:44:42 +00002409 double rCost;
drh9eff6162006-06-12 21:59:13 +00002410
danielk19776eacd282009-04-29 11:50:53 +00002411 /* Make sure wsFlags is initialized to some sane value. Otherwise, if the
2412 ** malloc in allocateIndexInfo() fails and this function returns leaving
2413 ** wsFlags in an uninitialized state, the caller may behave unpredictably.
2414 */
drh56f1b992012-09-25 14:29:39 +00002415 memset(&p->cost, 0, sizeof(p->cost));
2416 p->cost.plan.wsFlags = WHERE_VIRTUALTABLE;
danielk19776eacd282009-04-29 11:50:53 +00002417
drh9eff6162006-06-12 21:59:13 +00002418 /* If the sqlite3_index_info structure has not been previously
danielk19771d461462009-04-21 09:02:45 +00002419 ** allocated and initialized, then allocate and initialize it now.
drh9eff6162006-06-12 21:59:13 +00002420 */
drh56f1b992012-09-25 14:29:39 +00002421 pIdxInfo = *p->ppIdxInfo;
drh9eff6162006-06-12 21:59:13 +00002422 if( pIdxInfo==0 ){
drh5346e952013-05-08 14:14:26 +00002423 *p->ppIdxInfo = pIdxInfo = allocateIndexInfo(pParse,pWC,pSrc,p->pOrderBy);
drh9eff6162006-06-12 21:59:13 +00002424 }
danielk1977732dc552009-04-21 17:23:04 +00002425 if( pIdxInfo==0 ){
2426 return;
2427 }
drh9eff6162006-06-12 21:59:13 +00002428
drh7f375902006-06-13 17:38:59 +00002429 /* At this point, the sqlite3_index_info structure that pIdxInfo points
2430 ** to will have been initialized, either during the current invocation or
2431 ** during some prior invocation. Now we just have to customize the
2432 ** details of pIdxInfo for the current invocation and pass it to
2433 ** xBestIndex.
2434 */
2435
danielk1977935ed5e2007-03-30 09:13:13 +00002436 /* The module name must be defined. Also, by this point there must
2437 ** be a pointer to an sqlite3_vtab structure. Otherwise
2438 ** sqlite3ViewGetColumnNames() would have picked up the error.
2439 */
drh9eff6162006-06-12 21:59:13 +00002440 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
danielk1977595a5232009-07-24 17:58:53 +00002441 assert( sqlite3GetVTable(pParse->db, pTab) );
drh9eff6162006-06-12 21:59:13 +00002442
drhe40ed782012-12-14 15:36:17 +00002443 /* Try once or twice. On the first attempt, allow IN optimizations.
drhd0302532012-12-14 17:48:08 +00002444 ** If an IN optimization is accepted by the virtual table xBestIndex
2445 ** method, but the pInfo->aConstrainUsage.omit flag is not set, then
2446 ** the query will not work because it might allow duplicate rows in
2447 ** output. In that case, run the xBestIndex method a second time
2448 ** without the IN constraints. Usually this loop only runs once.
2449 ** The loop will exit using a "break" statement.
drh9eff6162006-06-12 21:59:13 +00002450 */
drhd0302532012-12-14 17:48:08 +00002451 for(bAllowIN=1; 1; bAllowIN--){
2452 assert( bAllowIN==0 || bAllowIN==1 );
2453
drhe40ed782012-12-14 15:36:17 +00002454 /* Set the aConstraint[].usable fields and initialize all
2455 ** output variables to zero.
2456 **
2457 ** aConstraint[].usable is true for constraints where the right-hand
2458 ** side contains only references to tables to the left of the current
2459 ** table. In other words, if the constraint is of the form:
2460 **
2461 ** column = expr
2462 **
2463 ** and we are evaluating a join, then the constraint on column is
2464 ** only valid if all tables referenced in expr occur to the left
2465 ** of the table containing column.
2466 **
2467 ** The aConstraints[] array contains entries for all constraints
2468 ** on the current table. That way we only have to compute it once
2469 ** even though we might try to pick the best index multiple times.
2470 ** For each attempt at picking an index, the order of tables in the
2471 ** join might be different so we have to recompute the usable flag
2472 ** each time.
2473 */
2474 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
2475 pUsage = pIdxInfo->aConstraintUsage;
2476 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
2477 j = pIdxCons->iTermOffset;
2478 pTerm = &pWC->a[j];
2479 if( (pTerm->prereqRight&p->notReady)==0
drh7a5bcc02013-01-16 17:08:58 +00002480 && (bAllowIN || (pTerm->eOperator & WO_IN)==0)
drhe40ed782012-12-14 15:36:17 +00002481 ){
2482 pIdxCons->usable = 1;
2483 }else{
2484 pIdxCons->usable = 0;
2485 }
dan5236ac12009-08-13 07:09:33 +00002486 }
drhe40ed782012-12-14 15:36:17 +00002487 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
2488 if( pIdxInfo->needToFreeIdxStr ){
2489 sqlite3_free(pIdxInfo->idxStr);
2490 }
2491 pIdxInfo->idxStr = 0;
2492 pIdxInfo->idxNum = 0;
2493 pIdxInfo->needToFreeIdxStr = 0;
2494 pIdxInfo->orderByConsumed = 0;
2495 /* ((double)2) In case of SQLITE_OMIT_FLOATING_POINT... */
2496 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / ((double)2);
2497 nOrderBy = pIdxInfo->nOrderBy;
2498 if( !p->pOrderBy ){
2499 pIdxInfo->nOrderBy = 0;
2500 }
2501
2502 if( vtabBestIndex(pParse, pTab, pIdxInfo) ){
2503 return;
2504 }
2505
2506 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
2507 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
2508 if( pUsage[i].argvIndex>0 ){
2509 j = pIdxCons->iTermOffset;
2510 pTerm = &pWC->a[j];
2511 p->cost.used |= pTerm->prereqRight;
drh36670332013-02-08 20:39:02 +00002512 if( (pTerm->eOperator & WO_IN)!=0 ){
2513 if( pUsage[i].omit==0 ){
2514 /* Do not attempt to use an IN constraint if the virtual table
2515 ** says that the equivalent EQ constraint cannot be safely omitted.
2516 ** If we do attempt to use such a constraint, some rows might be
2517 ** repeated in the output. */
2518 break;
2519 }
drh83b5bfc2013-04-18 02:55:54 +00002520 /* A virtual table that is constrained by an IN clause may not
2521 ** consume the ORDER BY clause because (1) the order of IN terms
2522 ** is not necessarily related to the order of output terms and
2523 ** (2) Multiple outputs from a single IN value will not merge
2524 ** together. */
2525 pIdxInfo->orderByConsumed = 0;
drhe40ed782012-12-14 15:36:17 +00002526 }
2527 }
2528 }
2529 if( i>=pIdxInfo->nConstraint ) break;
dan5236ac12009-08-13 07:09:33 +00002530 }
drhd99aaf12013-04-22 19:56:12 +00002531
2532 /* The orderByConsumed signal is only valid if all outer loops collectively
2533 ** generate just a single row of output.
2534 */
2535 if( pIdxInfo->orderByConsumed ){
2536 for(i=0; i<p->i; i++){
2537 if( (p->aLevel[i].plan.wsFlags & WHERE_UNIQUE)==0 ){
2538 pIdxInfo->orderByConsumed = 0;
2539 }
2540 }
2541 }
drhe40ed782012-12-14 15:36:17 +00002542
danc26c0042010-03-27 09:44:42 +00002543 /* If there is an ORDER BY clause, and the selected virtual table index
2544 ** does not satisfy it, increase the cost of the scan accordingly. This
2545 ** matches the processing for non-virtual tables in bestBtreeIndex().
2546 */
2547 rCost = pIdxInfo->estimatedCost;
drh56f1b992012-09-25 14:29:39 +00002548 if( p->pOrderBy && pIdxInfo->orderByConsumed==0 ){
danc26c0042010-03-27 09:44:42 +00002549 rCost += estLog(rCost)*rCost;
2550 }
2551
danielk19771d461462009-04-21 09:02:45 +00002552 /* The cost is not allowed to be larger than SQLITE_BIG_DBL (the
2553 ** inital value of lowestCost in this loop. If it is, then the
2554 ** (cost<lowestCost) test below will never be true.
2555 **
2556 ** Use "(double)2" instead of "2.0" in case OMIT_FLOATING_POINT
2557 ** is defined.
2558 */
danc26c0042010-03-27 09:44:42 +00002559 if( (SQLITE_BIG_DBL/((double)2))<rCost ){
drh56f1b992012-09-25 14:29:39 +00002560 p->cost.rCost = (SQLITE_BIG_DBL/((double)2));
danielk19771d461462009-04-21 09:02:45 +00002561 }else{
drh56f1b992012-09-25 14:29:39 +00002562 p->cost.rCost = rCost;
danielk19771d461462009-04-21 09:02:45 +00002563 }
drh56f1b992012-09-25 14:29:39 +00002564 p->cost.plan.u.pVtabIdx = pIdxInfo;
drh5901b572009-06-10 19:33:28 +00002565 if( pIdxInfo->orderByConsumed ){
drh83b5bfc2013-04-18 02:55:54 +00002566 p->cost.plan.wsFlags |= WHERE_ORDERED;
drhd663b5b2012-10-03 00:25:54 +00002567 p->cost.plan.nOBSat = nOrderBy;
2568 }else{
2569 p->cost.plan.nOBSat = p->i ? p->aLevel[p->i-1].plan.nOBSat : 0;
danielk19771d461462009-04-21 09:02:45 +00002570 }
drh56f1b992012-09-25 14:29:39 +00002571 p->cost.plan.nEq = 0;
danielk19771d461462009-04-21 09:02:45 +00002572 pIdxInfo->nOrderBy = nOrderBy;
2573
2574 /* Try to find a more efficient access pattern by using multiple indexes
2575 ** to optimize an OR expression within the WHERE clause.
2576 */
drh56f1b992012-09-25 14:29:39 +00002577 bestOrClauseIndex(p);
drh9eff6162006-06-12 21:59:13 +00002578}
2579#endif /* SQLITE_OMIT_VIRTUALTABLE */
2580
drhfaacf172011-08-12 01:51:45 +00002581#ifdef SQLITE_ENABLE_STAT3
drh28c4cf42005-07-27 20:41:43 +00002582/*
drhfaacf172011-08-12 01:51:45 +00002583** Estimate the location of a particular key among all keys in an
2584** index. Store the results in aStat as follows:
drhe847d322011-01-20 02:56:37 +00002585**
drhfaacf172011-08-12 01:51:45 +00002586** aStat[0] Est. number of rows less than pVal
2587** aStat[1] Est. number of rows equal to pVal
dan02fa4692009-08-17 17:06:58 +00002588**
drhfaacf172011-08-12 01:51:45 +00002589** Return SQLITE_OK on success.
dan02fa4692009-08-17 17:06:58 +00002590*/
drhfaacf172011-08-12 01:51:45 +00002591static int whereKeyStats(
dan02fa4692009-08-17 17:06:58 +00002592 Parse *pParse, /* Database connection */
2593 Index *pIdx, /* Index to consider domain of */
2594 sqlite3_value *pVal, /* Value to consider */
drhfaacf172011-08-12 01:51:45 +00002595 int roundUp, /* Round up if true. Round down if false */
2596 tRowcnt *aStat /* OUT: stats written here */
dan02fa4692009-08-17 17:06:58 +00002597){
drhfaacf172011-08-12 01:51:45 +00002598 tRowcnt n;
2599 IndexSample *aSample;
2600 int i, eType;
2601 int isEq = 0;
drh4e50c5e2011-08-13 19:35:19 +00002602 i64 v;
2603 double r, rS;
dan02fa4692009-08-17 17:06:58 +00002604
drhfaacf172011-08-12 01:51:45 +00002605 assert( roundUp==0 || roundUp==1 );
drh5c624862011-09-22 18:46:34 +00002606 assert( pIdx->nSample>0 );
drhfaacf172011-08-12 01:51:45 +00002607 if( pVal==0 ) return SQLITE_ERROR;
2608 n = pIdx->aiRowEst[0];
2609 aSample = pIdx->aSample;
drhfaacf172011-08-12 01:51:45 +00002610 eType = sqlite3_value_type(pVal);
2611
2612 if( eType==SQLITE_INTEGER ){
drh4e50c5e2011-08-13 19:35:19 +00002613 v = sqlite3_value_int64(pVal);
2614 r = (i64)v;
drhfaacf172011-08-12 01:51:45 +00002615 for(i=0; i<pIdx->nSample; i++){
2616 if( aSample[i].eType==SQLITE_NULL ) continue;
2617 if( aSample[i].eType>=SQLITE_TEXT ) break;
drh4e50c5e2011-08-13 19:35:19 +00002618 if( aSample[i].eType==SQLITE_INTEGER ){
2619 if( aSample[i].u.i>=v ){
2620 isEq = aSample[i].u.i==v;
2621 break;
2622 }
2623 }else{
2624 assert( aSample[i].eType==SQLITE_FLOAT );
2625 if( aSample[i].u.r>=r ){
2626 isEq = aSample[i].u.r==r;
2627 break;
2628 }
dan02fa4692009-08-17 17:06:58 +00002629 }
drhfaacf172011-08-12 01:51:45 +00002630 }
2631 }else if( eType==SQLITE_FLOAT ){
drh4e50c5e2011-08-13 19:35:19 +00002632 r = sqlite3_value_double(pVal);
drhfaacf172011-08-12 01:51:45 +00002633 for(i=0; i<pIdx->nSample; i++){
2634 if( aSample[i].eType==SQLITE_NULL ) continue;
2635 if( aSample[i].eType>=SQLITE_TEXT ) break;
drh4e50c5e2011-08-13 19:35:19 +00002636 if( aSample[i].eType==SQLITE_FLOAT ){
2637 rS = aSample[i].u.r;
2638 }else{
2639 rS = aSample[i].u.i;
2640 }
2641 if( rS>=r ){
2642 isEq = rS==r;
drhfaacf172011-08-12 01:51:45 +00002643 break;
drh9b3eb0a2011-01-21 14:37:04 +00002644 }
drhfaacf172011-08-12 01:51:45 +00002645 }
2646 }else if( eType==SQLITE_NULL ){
2647 i = 0;
drh5c624862011-09-22 18:46:34 +00002648 if( aSample[0].eType==SQLITE_NULL ) isEq = 1;
drhfaacf172011-08-12 01:51:45 +00002649 }else{
2650 assert( eType==SQLITE_TEXT || eType==SQLITE_BLOB );
2651 for(i=0; i<pIdx->nSample; i++){
2652 if( aSample[i].eType==SQLITE_TEXT || aSample[i].eType==SQLITE_BLOB ){
2653 break;
2654 }
2655 }
2656 if( i<pIdx->nSample ){
dan02fa4692009-08-17 17:06:58 +00002657 sqlite3 *db = pParse->db;
2658 CollSeq *pColl;
2659 const u8 *z;
dan02fa4692009-08-17 17:06:58 +00002660 if( eType==SQLITE_BLOB ){
2661 z = (const u8 *)sqlite3_value_blob(pVal);
2662 pColl = db->pDfltColl;
dane275dc32009-08-18 16:24:58 +00002663 assert( pColl->enc==SQLITE_UTF8 );
dan02fa4692009-08-17 17:06:58 +00002664 }else{
drh79e72a52012-10-05 14:43:40 +00002665 pColl = sqlite3GetCollSeq(pParse, SQLITE_UTF8, 0, *pIdx->azColl);
drh9aeda792009-08-20 02:34:15 +00002666 if( pColl==0 ){
dane275dc32009-08-18 16:24:58 +00002667 return SQLITE_ERROR;
2668 }
dan02fa4692009-08-17 17:06:58 +00002669 z = (const u8 *)sqlite3ValueText(pVal, pColl->enc);
dane275dc32009-08-18 16:24:58 +00002670 if( !z ){
2671 return SQLITE_NOMEM;
2672 }
dan02fa4692009-08-17 17:06:58 +00002673 assert( z && pColl && pColl->xCmp );
2674 }
2675 n = sqlite3ValueBytes(pVal, pColl->enc);
drhfaacf172011-08-12 01:51:45 +00002676
2677 for(; i<pIdx->nSample; i++){
drhe847d322011-01-20 02:56:37 +00002678 int c;
dan02fa4692009-08-17 17:06:58 +00002679 int eSampletype = aSample[i].eType;
drhfaacf172011-08-12 01:51:45 +00002680 if( eSampletype<eType ) continue;
2681 if( eSampletype!=eType ) break;
dane83c4f32009-09-21 16:34:24 +00002682#ifndef SQLITE_OMIT_UTF16
2683 if( pColl->enc!=SQLITE_UTF8 ){
dane275dc32009-08-18 16:24:58 +00002684 int nSample;
2685 char *zSample = sqlite3Utf8to16(
dan02fa4692009-08-17 17:06:58 +00002686 db, pColl->enc, aSample[i].u.z, aSample[i].nByte, &nSample
2687 );
dane275dc32009-08-18 16:24:58 +00002688 if( !zSample ){
2689 assert( db->mallocFailed );
2690 return SQLITE_NOMEM;
2691 }
drhe847d322011-01-20 02:56:37 +00002692 c = pColl->xCmp(pColl->pUser, nSample, zSample, n, z);
dane275dc32009-08-18 16:24:58 +00002693 sqlite3DbFree(db, zSample);
dane83c4f32009-09-21 16:34:24 +00002694 }else
2695#endif
2696 {
drhe847d322011-01-20 02:56:37 +00002697 c = pColl->xCmp(pColl->pUser, aSample[i].nByte, aSample[i].u.z, n, z);
dan02fa4692009-08-17 17:06:58 +00002698 }
drhfaacf172011-08-12 01:51:45 +00002699 if( c>=0 ){
2700 if( c==0 ) isEq = 1;
2701 break;
2702 }
dan02fa4692009-08-17 17:06:58 +00002703 }
2704 }
drhfaacf172011-08-12 01:51:45 +00002705 }
dan02fa4692009-08-17 17:06:58 +00002706
drhfaacf172011-08-12 01:51:45 +00002707 /* At this point, aSample[i] is the first sample that is greater than
2708 ** or equal to pVal. Or if i==pIdx->nSample, then all samples are less
2709 ** than pVal. If aSample[i]==pVal, then isEq==1.
2710 */
2711 if( isEq ){
2712 assert( i<pIdx->nSample );
2713 aStat[0] = aSample[i].nLt;
2714 aStat[1] = aSample[i].nEq;
2715 }else{
2716 tRowcnt iLower, iUpper, iGap;
2717 if( i==0 ){
2718 iLower = 0;
2719 iUpper = aSample[0].nLt;
drhfaacf172011-08-12 01:51:45 +00002720 }else{
drh4e50c5e2011-08-13 19:35:19 +00002721 iUpper = i>=pIdx->nSample ? n : aSample[i].nLt;
drhfaacf172011-08-12 01:51:45 +00002722 iLower = aSample[i-1].nEq + aSample[i-1].nLt;
drhfaacf172011-08-12 01:51:45 +00002723 }
drh4e50c5e2011-08-13 19:35:19 +00002724 aStat[1] = pIdx->avgEq;
drhfaacf172011-08-12 01:51:45 +00002725 if( iLower>=iUpper ){
2726 iGap = 0;
2727 }else{
2728 iGap = iUpper - iLower;
drhfaacf172011-08-12 01:51:45 +00002729 }
2730 if( roundUp ){
2731 iGap = (iGap*2)/3;
2732 }else{
2733 iGap = iGap/3;
2734 }
2735 aStat[0] = iLower + iGap;
dan02fa4692009-08-17 17:06:58 +00002736 }
2737 return SQLITE_OK;
2738}
drhfaacf172011-08-12 01:51:45 +00002739#endif /* SQLITE_ENABLE_STAT3 */
dan02fa4692009-08-17 17:06:58 +00002740
2741/*
dan937d0de2009-10-15 18:35:38 +00002742** If expression pExpr represents a literal value, set *pp to point to
2743** an sqlite3_value structure containing the same value, with affinity
2744** aff applied to it, before returning. It is the responsibility of the
2745** caller to eventually release this structure by passing it to
2746** sqlite3ValueFree().
2747**
2748** If the current parse is a recompile (sqlite3Reprepare()) and pExpr
2749** is an SQL variable that currently has a non-NULL value bound to it,
2750** create an sqlite3_value structure containing this value, again with
2751** affinity aff applied to it, instead.
2752**
2753** If neither of the above apply, set *pp to NULL.
2754**
2755** If an error occurs, return an error code. Otherwise, SQLITE_OK.
2756*/
drhfaacf172011-08-12 01:51:45 +00002757#ifdef SQLITE_ENABLE_STAT3
dan937d0de2009-10-15 18:35:38 +00002758static int valueFromExpr(
2759 Parse *pParse,
2760 Expr *pExpr,
2761 u8 aff,
2762 sqlite3_value **pp
2763){
drh4278d532010-12-16 19:52:52 +00002764 if( pExpr->op==TK_VARIABLE
2765 || (pExpr->op==TK_REGISTER && pExpr->op2==TK_VARIABLE)
2766 ){
dan937d0de2009-10-15 18:35:38 +00002767 int iVar = pExpr->iColumn;
drhf9b22ca2011-10-21 16:47:31 +00002768 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan937d0de2009-10-15 18:35:38 +00002769 *pp = sqlite3VdbeGetValue(pParse->pReprepare, iVar, aff);
2770 return SQLITE_OK;
2771 }
2772 return sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, aff, pp);
2773}
danf7b0b0a2009-10-19 15:52:32 +00002774#endif
dan937d0de2009-10-15 18:35:38 +00002775
2776/*
dan02fa4692009-08-17 17:06:58 +00002777** This function is used to estimate the number of rows that will be visited
2778** by scanning an index for a range of values. The range may have an upper
2779** bound, a lower bound, or both. The WHERE clause terms that set the upper
2780** and lower bounds are represented by pLower and pUpper respectively. For
2781** example, assuming that index p is on t1(a):
2782**
2783** ... FROM t1 WHERE a > ? AND a < ? ...
2784** |_____| |_____|
2785** | |
2786** pLower pUpper
2787**
drh98cdf622009-08-20 18:14:42 +00002788** If either of the upper or lower bound is not present, then NULL is passed in
drhcdaca552009-08-20 13:45:07 +00002789** place of the corresponding WhereTerm.
dan02fa4692009-08-17 17:06:58 +00002790**
2791** The nEq parameter is passed the index of the index column subject to the
2792** range constraint. Or, equivalently, the number of equality constraints
2793** optimized by the proposed index scan. For example, assuming index p is
2794** on t1(a, b), and the SQL query is:
2795**
2796** ... FROM t1 WHERE a = ? AND b > ? AND b < ? ...
2797**
2798** then nEq should be passed the value 1 (as the range restricted column,
2799** b, is the second left-most column of the index). Or, if the query is:
2800**
2801** ... FROM t1 WHERE a > ? AND a < ? ...
2802**
2803** then nEq should be passed 0.
2804**
drhfaacf172011-08-12 01:51:45 +00002805** The returned value is an integer divisor to reduce the estimated
2806** search space. A return value of 1 means that range constraints are
2807** no help at all. A return value of 2 means range constraints are
2808** expected to reduce the search space by half. And so forth...
drh98cdf622009-08-20 18:14:42 +00002809**
drhfaacf172011-08-12 01:51:45 +00002810** In the absence of sqlite_stat3 ANALYZE data, each range inequality
2811** reduces the search space by a factor of 4. Hence a single constraint (x>?)
2812** results in a return of 4 and a range constraint (x>? AND x<?) results
2813** in a return of 16.
dan02fa4692009-08-17 17:06:58 +00002814*/
2815static int whereRangeScanEst(
drhcdaca552009-08-20 13:45:07 +00002816 Parse *pParse, /* Parsing & code generating context */
2817 Index *p, /* The index containing the range-compared column; "x" */
2818 int nEq, /* index into p->aCol[] of the range-compared column */
2819 WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
2820 WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
drh4e50c5e2011-08-13 19:35:19 +00002821 double *pRangeDiv /* OUT: Reduce search space by this divisor */
dan02fa4692009-08-17 17:06:58 +00002822){
dan69188d92009-08-19 08:18:32 +00002823 int rc = SQLITE_OK;
2824
drhfaacf172011-08-12 01:51:45 +00002825#ifdef SQLITE_ENABLE_STAT3
dan02fa4692009-08-17 17:06:58 +00002826
drhfaacf172011-08-12 01:51:45 +00002827 if( nEq==0 && p->nSample ){
2828 sqlite3_value *pRangeVal;
2829 tRowcnt iLower = 0;
2830 tRowcnt iUpper = p->aiRowEst[0];
2831 tRowcnt a[2];
dan937d0de2009-10-15 18:35:38 +00002832 u8 aff = p->pTable->aCol[p->aiColumn[0]].affinity;
drh98cdf622009-08-20 18:14:42 +00002833
dan02fa4692009-08-17 17:06:58 +00002834 if( pLower ){
2835 Expr *pExpr = pLower->pExpr->pRight;
drhfaacf172011-08-12 01:51:45 +00002836 rc = valueFromExpr(pParse, pExpr, aff, &pRangeVal);
drh7a5bcc02013-01-16 17:08:58 +00002837 assert( (pLower->eOperator & (WO_GT|WO_GE))!=0 );
drhfaacf172011-08-12 01:51:45 +00002838 if( rc==SQLITE_OK
2839 && whereKeyStats(pParse, p, pRangeVal, 0, a)==SQLITE_OK
2840 ){
2841 iLower = a[0];
drh7a5bcc02013-01-16 17:08:58 +00002842 if( (pLower->eOperator & WO_GT)!=0 ) iLower += a[1];
drhfaacf172011-08-12 01:51:45 +00002843 }
2844 sqlite3ValueFree(pRangeVal);
dan02fa4692009-08-17 17:06:58 +00002845 }
drh98cdf622009-08-20 18:14:42 +00002846 if( rc==SQLITE_OK && pUpper ){
dan02fa4692009-08-17 17:06:58 +00002847 Expr *pExpr = pUpper->pExpr->pRight;
drhfaacf172011-08-12 01:51:45 +00002848 rc = valueFromExpr(pParse, pExpr, aff, &pRangeVal);
drh7a5bcc02013-01-16 17:08:58 +00002849 assert( (pUpper->eOperator & (WO_LT|WO_LE))!=0 );
drhfaacf172011-08-12 01:51:45 +00002850 if( rc==SQLITE_OK
2851 && whereKeyStats(pParse, p, pRangeVal, 1, a)==SQLITE_OK
2852 ){
2853 iUpper = a[0];
drh7a5bcc02013-01-16 17:08:58 +00002854 if( (pUpper->eOperator & WO_LE)!=0 ) iUpper += a[1];
dan02fa4692009-08-17 17:06:58 +00002855 }
drhfaacf172011-08-12 01:51:45 +00002856 sqlite3ValueFree(pRangeVal);
dan02fa4692009-08-17 17:06:58 +00002857 }
drhfaacf172011-08-12 01:51:45 +00002858 if( rc==SQLITE_OK ){
2859 if( iUpper<=iLower ){
drh4e50c5e2011-08-13 19:35:19 +00002860 *pRangeDiv = (double)p->aiRowEst[0];
drhfaacf172011-08-12 01:51:45 +00002861 }else{
drh4e50c5e2011-08-13 19:35:19 +00002862 *pRangeDiv = (double)p->aiRowEst[0]/(double)(iUpper - iLower);
drhfaacf172011-08-12 01:51:45 +00002863 }
drhf1b5f5b2013-05-02 00:15:01 +00002864 /*WHERETRACE(("range scan regions: %u..%u div=%g\n",
2865 (u32)iLower, (u32)iUpper, *pRangeDiv));*/
drhfaacf172011-08-12 01:51:45 +00002866 return SQLITE_OK;
drh98cdf622009-08-20 18:14:42 +00002867 }
dan02fa4692009-08-17 17:06:58 +00002868 }
drh3f022182009-09-09 16:10:50 +00002869#else
2870 UNUSED_PARAMETER(pParse);
2871 UNUSED_PARAMETER(p);
2872 UNUSED_PARAMETER(nEq);
dan69188d92009-08-19 08:18:32 +00002873#endif
dan02fa4692009-08-17 17:06:58 +00002874 assert( pLower || pUpper );
drh4e50c5e2011-08-13 19:35:19 +00002875 *pRangeDiv = (double)1;
2876 if( pLower && (pLower->wtFlags & TERM_VNULL)==0 ) *pRangeDiv *= (double)4;
2877 if( pUpper ) *pRangeDiv *= (double)4;
dan02fa4692009-08-17 17:06:58 +00002878 return rc;
2879}
2880
drhfaacf172011-08-12 01:51:45 +00002881#ifdef SQLITE_ENABLE_STAT3
drh82759752011-01-20 16:52:09 +00002882/*
2883** Estimate the number of rows that will be returned based on
2884** an equality constraint x=VALUE and where that VALUE occurs in
2885** the histogram data. This only works when x is the left-most
drhfaacf172011-08-12 01:51:45 +00002886** column of an index and sqlite_stat3 histogram data is available
drhac8eb112011-03-17 01:58:21 +00002887** for that index. When pExpr==NULL that means the constraint is
2888** "x IS NULL" instead of "x=VALUE".
drh82759752011-01-20 16:52:09 +00002889**
drh0c50fa02011-01-21 16:27:18 +00002890** Write the estimated row count into *pnRow and return SQLITE_OK.
2891** If unable to make an estimate, leave *pnRow unchanged and return
2892** non-zero.
drh9b3eb0a2011-01-21 14:37:04 +00002893**
2894** This routine can fail if it is unable to load a collating sequence
2895** required for string comparison, or if unable to allocate memory
2896** for a UTF conversion required for comparison. The error is stored
2897** in the pParse structure.
drh82759752011-01-20 16:52:09 +00002898*/
drh041e09f2011-04-07 19:56:21 +00002899static int whereEqualScanEst(
drh82759752011-01-20 16:52:09 +00002900 Parse *pParse, /* Parsing & code generating context */
2901 Index *p, /* The index whose left-most column is pTerm */
drh0c50fa02011-01-21 16:27:18 +00002902 Expr *pExpr, /* Expression for VALUE in the x=VALUE constraint */
drh82759752011-01-20 16:52:09 +00002903 double *pnRow /* Write the revised row estimate here */
2904){
2905 sqlite3_value *pRhs = 0; /* VALUE on right-hand side of pTerm */
drh82759752011-01-20 16:52:09 +00002906 u8 aff; /* Column affinity */
2907 int rc; /* Subfunction return code */
drhfaacf172011-08-12 01:51:45 +00002908 tRowcnt a[2]; /* Statistics */
drh82759752011-01-20 16:52:09 +00002909
2910 assert( p->aSample!=0 );
drh5c624862011-09-22 18:46:34 +00002911 assert( p->nSample>0 );
drh82759752011-01-20 16:52:09 +00002912 aff = p->pTable->aCol[p->aiColumn[0]].affinity;
drh1f9c7662011-03-17 01:34:26 +00002913 if( pExpr ){
2914 rc = valueFromExpr(pParse, pExpr, aff, &pRhs);
2915 if( rc ) goto whereEqualScanEst_cancel;
2916 }else{
2917 pRhs = sqlite3ValueNew(pParse->db);
2918 }
drh0c50fa02011-01-21 16:27:18 +00002919 if( pRhs==0 ) return SQLITE_NOTFOUND;
drhfaacf172011-08-12 01:51:45 +00002920 rc = whereKeyStats(pParse, p, pRhs, 0, a);
2921 if( rc==SQLITE_OK ){
drhf1b5f5b2013-05-02 00:15:01 +00002922 /*WHERETRACE(("equality scan regions: %d\n", (int)a[1]));*/
drhfaacf172011-08-12 01:51:45 +00002923 *pnRow = a[1];
drh82759752011-01-20 16:52:09 +00002924 }
drh0c50fa02011-01-21 16:27:18 +00002925whereEqualScanEst_cancel:
drh82759752011-01-20 16:52:09 +00002926 sqlite3ValueFree(pRhs);
drh0c50fa02011-01-21 16:27:18 +00002927 return rc;
2928}
drhfaacf172011-08-12 01:51:45 +00002929#endif /* defined(SQLITE_ENABLE_STAT3) */
drh0c50fa02011-01-21 16:27:18 +00002930
drhfaacf172011-08-12 01:51:45 +00002931#ifdef SQLITE_ENABLE_STAT3
drh0c50fa02011-01-21 16:27:18 +00002932/*
2933** Estimate the number of rows that will be returned based on
drh5ac06072011-01-21 18:18:13 +00002934** an IN constraint where the right-hand side of the IN operator
2935** is a list of values. Example:
2936**
2937** WHERE x IN (1,2,3,4)
drh0c50fa02011-01-21 16:27:18 +00002938**
2939** Write the estimated row count into *pnRow and return SQLITE_OK.
2940** If unable to make an estimate, leave *pnRow unchanged and return
2941** non-zero.
2942**
2943** This routine can fail if it is unable to load a collating sequence
2944** required for string comparison, or if unable to allocate memory
2945** for a UTF conversion required for comparison. The error is stored
2946** in the pParse structure.
2947*/
drh041e09f2011-04-07 19:56:21 +00002948static int whereInScanEst(
drh0c50fa02011-01-21 16:27:18 +00002949 Parse *pParse, /* Parsing & code generating context */
2950 Index *p, /* The index whose left-most column is pTerm */
2951 ExprList *pList, /* The value list on the RHS of "x IN (v1,v2,v3,...)" */
2952 double *pnRow /* Write the revised row estimate here */
2953){
drh68257192011-08-16 17:06:21 +00002954 int rc = SQLITE_OK; /* Subfunction return code */
2955 double nEst; /* Number of rows for a single term */
2956 double nRowEst = (double)0; /* New estimate of the number of rows */
2957 int i; /* Loop counter */
drh0c50fa02011-01-21 16:27:18 +00002958
2959 assert( p->aSample!=0 );
drhfaacf172011-08-12 01:51:45 +00002960 for(i=0; rc==SQLITE_OK && i<pList->nExpr; i++){
2961 nEst = p->aiRowEst[0];
2962 rc = whereEqualScanEst(pParse, p, pList->a[i].pExpr, &nEst);
2963 nRowEst += nEst;
drh0c50fa02011-01-21 16:27:18 +00002964 }
2965 if( rc==SQLITE_OK ){
drh0c50fa02011-01-21 16:27:18 +00002966 if( nRowEst > p->aiRowEst[0] ) nRowEst = p->aiRowEst[0];
2967 *pnRow = nRowEst;
drhf1b5f5b2013-05-02 00:15:01 +00002968 /*WHERETRACE(("IN row estimate: est=%g\n", nRowEst));*/
drh0c50fa02011-01-21 16:27:18 +00002969 }
drh0c50fa02011-01-21 16:27:18 +00002970 return rc;
drh82759752011-01-20 16:52:09 +00002971}
drhfaacf172011-08-12 01:51:45 +00002972#endif /* defined(SQLITE_ENABLE_STAT3) */
drh82759752011-01-20 16:52:09 +00002973
drh46c35f92012-09-26 23:17:01 +00002974/*
drh32634d22012-09-27 14:11:36 +00002975** Check to see if column iCol of the table with cursor iTab will appear
drh8e4af1b2012-10-08 18:23:51 +00002976** in sorted order according to the current query plan.
drh32634d22012-09-27 14:11:36 +00002977**
drh8e4af1b2012-10-08 18:23:51 +00002978** Return values:
2979**
2980** 0 iCol is not ordered
2981** 1 iCol has only a single value
2982** 2 iCol is in ASC order
2983** 3 iCol is in DESC order
drh32634d22012-09-27 14:11:36 +00002984*/
drh8e4af1b2012-10-08 18:23:51 +00002985static int isOrderedColumn(
2986 WhereBestIdx *p,
2987 int iTab,
2988 int iCol
2989){
drh32634d22012-09-27 14:11:36 +00002990 int i, j;
2991 WhereLevel *pLevel = &p->aLevel[p->i-1];
2992 Index *pIdx;
2993 u8 sortOrder;
2994 for(i=p->i-1; i>=0; i--, pLevel--){
2995 if( pLevel->iTabCur!=iTab ) continue;
drh60441af2012-09-29 19:10:29 +00002996 if( (pLevel->plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
2997 return 1;
2998 }
drh69a76ba2012-10-09 01:23:25 +00002999 assert( (pLevel->plan.wsFlags & WHERE_ORDERED)!=0 );
drhd663b5b2012-10-03 00:25:54 +00003000 if( (pIdx = pLevel->plan.u.pIdx)!=0 ){
drh6b10a6a2012-09-27 17:31:32 +00003001 if( iCol<0 ){
3002 sortOrder = 0;
3003 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
3004 }else{
drhafcd5222012-10-02 15:19:19 +00003005 int n = pIdx->nColumn;
drh178eb612012-10-02 14:11:29 +00003006 for(j=0; j<n; j++){
drh6b10a6a2012-09-27 17:31:32 +00003007 if( iCol==pIdx->aiColumn[j] ) break;
3008 }
drh178eb612012-10-02 14:11:29 +00003009 if( j>=n ) return 0;
drh6b10a6a2012-09-27 17:31:32 +00003010 sortOrder = pIdx->aSortOrder[j];
3011 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
drh32634d22012-09-27 14:11:36 +00003012 }
drh32634d22012-09-27 14:11:36 +00003013 }else{
3014 if( iCol!=(-1) ) return 0;
3015 sortOrder = 0;
drh6b10a6a2012-09-27 17:31:32 +00003016 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
drh32634d22012-09-27 14:11:36 +00003017 }
drh6b10a6a2012-09-27 17:31:32 +00003018 if( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 ){
3019 assert( sortOrder==0 || sortOrder==1 );
3020 testcase( sortOrder==1 );
3021 sortOrder = 1 - sortOrder;
3022 }
drh8e4af1b2012-10-08 18:23:51 +00003023 return sortOrder+2;
drh32634d22012-09-27 14:11:36 +00003024 }
3025 return 0;
3026}
3027
3028/*
drh60441af2012-09-29 19:10:29 +00003029** This routine decides if pIdx can be used to satisfy the ORDER BY
3030** clause, either in whole or in part. The return value is the
3031** cumulative number of terms in the ORDER BY clause that are satisfied
3032** by the index pIdx and other indices in outer loops.
3033**
3034** The table being queried has a cursor number of "base". pIdx is the
3035** index that is postulated for use to access the table.
3036**
drh60441af2012-09-29 19:10:29 +00003037** The *pbRev value is set to 0 order 1 depending on whether or not
3038** pIdx should be run in the forward order or in reverse order.
3039*/
3040static int isSortingIndex(
3041 WhereBestIdx *p, /* Best index search context */
3042 Index *pIdx, /* The index we are testing */
3043 int base, /* Cursor number for the table to be sorted */
drh8a1b87c2013-03-27 15:04:28 +00003044 int *pbRev, /* Set to 1 for reverse-order scan of pIdx */
3045 int *pbObUnique /* ORDER BY column values will different in every row */
drh60441af2012-09-29 19:10:29 +00003046){
3047 int i; /* Number of pIdx terms used */
3048 int j; /* Number of ORDER BY terms satisfied */
drh4f68d6c2012-10-04 12:10:25 +00003049 int sortOrder = 2; /* 0: forward. 1: backward. 2: unknown */
drh60441af2012-09-29 19:10:29 +00003050 int nTerm; /* Number of ORDER BY terms */
drh8e4af1b2012-10-08 18:23:51 +00003051 struct ExprList_item *pOBItem;/* A term of the ORDER BY clause */
drh4f68d6c2012-10-04 12:10:25 +00003052 Table *pTab = pIdx->pTable; /* Table that owns index pIdx */
drh60441af2012-09-29 19:10:29 +00003053 ExprList *pOrderBy; /* The ORDER BY clause */
3054 Parse *pParse = p->pParse; /* Parser context */
3055 sqlite3 *db = pParse->db; /* Database connection */
3056 int nPriorSat; /* ORDER BY terms satisfied by outer loops */
3057 int seenRowid = 0; /* True if an ORDER BY rowid term is seen */
drh0a4c7412012-10-08 19:41:38 +00003058 int uniqueNotNull; /* pIdx is UNIQUE with all terms are NOT NULL */
drh8a1b87c2013-03-27 15:04:28 +00003059 int outerObUnique; /* Outer loops generate different values in
3060 ** every row for the ORDER BY columns */
drh60441af2012-09-29 19:10:29 +00003061
3062 if( p->i==0 ){
3063 nPriorSat = 0;
drh8a1b87c2013-03-27 15:04:28 +00003064 outerObUnique = 1;
drh60441af2012-09-29 19:10:29 +00003065 }else{
drhe6a8bbb2013-03-27 16:42:21 +00003066 u32 wsFlags = p->aLevel[p->i-1].plan.wsFlags;
drh60441af2012-09-29 19:10:29 +00003067 nPriorSat = p->aLevel[p->i-1].plan.nOBSat;
drhe6a8bbb2013-03-27 16:42:21 +00003068 if( (wsFlags & WHERE_ORDERED)==0 ){
drh0a4c7412012-10-08 19:41:38 +00003069 /* This loop cannot be ordered unless the next outer loop is
3070 ** also ordered */
drhd663b5b2012-10-03 00:25:54 +00003071 return nPriorSat;
3072 }
drh0a4c7412012-10-08 19:41:38 +00003073 if( OptimizationDisabled(db, SQLITE_OrderByIdxJoin) ){
3074 /* Only look at the outer-most loop if the OrderByIdxJoin
3075 ** optimization is disabled */
3076 return nPriorSat;
3077 }
drhe6a8bbb2013-03-27 16:42:21 +00003078 testcase( wsFlags & WHERE_OB_UNIQUE );
3079 testcase( wsFlags & WHERE_ALL_UNIQUE );
3080 outerObUnique = (wsFlags & (WHERE_OB_UNIQUE|WHERE_ALL_UNIQUE))!=0;
drh60441af2012-09-29 19:10:29 +00003081 }
3082 pOrderBy = p->pOrderBy;
3083 assert( pOrderBy!=0 );
drh0a4c7412012-10-08 19:41:38 +00003084 if( pIdx->bUnordered ){
3085 /* Hash indices (indicated by the "unordered" tag on sqlite_stat1) cannot
3086 ** be used for sorting */
3087 return nPriorSat;
3088 }
drh60441af2012-09-29 19:10:29 +00003089 nTerm = pOrderBy->nExpr;
drh8e4af1b2012-10-08 18:23:51 +00003090 uniqueNotNull = pIdx->onError!=OE_None;
drh60441af2012-09-29 19:10:29 +00003091 assert( nTerm>0 );
3092
3093 /* Argument pIdx must either point to a 'real' named index structure,
3094 ** or an index structure allocated on the stack by bestBtreeIndex() to
3095 ** represent the rowid index that is part of every table. */
3096 assert( pIdx->zName || (pIdx->nColumn==1 && pIdx->aiColumn[0]==-1) );
3097
3098 /* Match terms of the ORDER BY clause against columns of
3099 ** the index.
3100 **
3101 ** Note that indices have pIdx->nColumn regular columns plus
3102 ** one additional column containing the rowid. The rowid column
3103 ** of the index is also allowed to match against the ORDER BY
3104 ** clause.
3105 */
drh8e4af1b2012-10-08 18:23:51 +00003106 j = nPriorSat;
3107 for(i=0,pOBItem=&pOrderBy->a[j]; j<nTerm && i<=pIdx->nColumn; i++){
3108 Expr *pOBExpr; /* The expression of the ORDER BY pOBItem */
3109 CollSeq *pColl; /* The collating sequence of pOBExpr */
3110 int termSortOrder; /* Sort order for this term */
3111 int iColumn; /* The i-th column of the index. -1 for rowid */
3112 int iSortOrder; /* 1 for DESC, 0 for ASC on the i-th index term */
3113 int isEq; /* Subject to an == or IS NULL constraint */
3114 int isMatch; /* ORDER BY term matches the index term */
3115 const char *zColl; /* Name of collating sequence for i-th index term */
3116 WhereTerm *pConstraint; /* A constraint in the WHERE clause */
drh60441af2012-09-29 19:10:29 +00003117
drh8e4af1b2012-10-08 18:23:51 +00003118 /* If the next term of the ORDER BY clause refers to anything other than
3119 ** a column in the "base" table, then this index will not be of any
3120 ** further use in handling the ORDER BY. */
drh7a66da12012-12-07 20:31:11 +00003121 pOBExpr = sqlite3ExprSkipCollate(pOBItem->pExpr);
drh8e4af1b2012-10-08 18:23:51 +00003122 if( pOBExpr->op!=TK_COLUMN || pOBExpr->iTable!=base ){
drh60441af2012-09-29 19:10:29 +00003123 break;
3124 }
drh8e4af1b2012-10-08 18:23:51 +00003125
3126 /* Find column number and collating sequence for the next entry
3127 ** in the index */
drh60441af2012-09-29 19:10:29 +00003128 if( pIdx->zName && i<pIdx->nColumn ){
3129 iColumn = pIdx->aiColumn[i];
3130 if( iColumn==pIdx->pTable->iPKey ){
3131 iColumn = -1;
3132 }
3133 iSortOrder = pIdx->aSortOrder[i];
3134 zColl = pIdx->azColl[i];
drh8e4af1b2012-10-08 18:23:51 +00003135 assert( zColl!=0 );
drh60441af2012-09-29 19:10:29 +00003136 }else{
3137 iColumn = -1;
3138 iSortOrder = 0;
drh8e4af1b2012-10-08 18:23:51 +00003139 zColl = 0;
drh60441af2012-09-29 19:10:29 +00003140 }
drh8e4af1b2012-10-08 18:23:51 +00003141
3142 /* Check to see if the column number and collating sequence of the
3143 ** index match the column number and collating sequence of the ORDER BY
3144 ** clause entry. Set isMatch to 1 if they both match. */
3145 if( pOBExpr->iColumn==iColumn ){
3146 if( zColl ){
drh7a66da12012-12-07 20:31:11 +00003147 pColl = sqlite3ExprCollSeq(pParse, pOBItem->pExpr);
drh8e4af1b2012-10-08 18:23:51 +00003148 if( !pColl ) pColl = db->pDfltColl;
3149 isMatch = sqlite3StrICmp(pColl->zName, zColl)==0;
drh60441af2012-09-29 19:10:29 +00003150 }else{
drh8e4af1b2012-10-08 18:23:51 +00003151 isMatch = 1;
drh60441af2012-09-29 19:10:29 +00003152 }
3153 }else{
drh8e4af1b2012-10-08 18:23:51 +00003154 isMatch = 0;
3155 }
3156
3157 /* termSortOrder is 0 or 1 for whether or not the access loop should
3158 ** run forward or backwards (respectively) in order to satisfy this
3159 ** term of the ORDER BY clause. */
drh2f546ee2012-10-09 09:26:28 +00003160 assert( pOBItem->sortOrder==0 || pOBItem->sortOrder==1 );
3161 assert( iSortOrder==0 || iSortOrder==1 );
drh8e4af1b2012-10-08 18:23:51 +00003162 termSortOrder = iSortOrder ^ pOBItem->sortOrder;
3163
3164 /* If X is the column in the index and ORDER BY clause, check to see
3165 ** if there are any X= or X IS NULL constraints in the WHERE clause. */
3166 pConstraint = findTerm(p->pWC, base, iColumn, p->notReady,
3167 WO_EQ|WO_ISNULL|WO_IN, pIdx);
3168 if( pConstraint==0 ){
3169 isEq = 0;
drh7a5bcc02013-01-16 17:08:58 +00003170 }else if( (pConstraint->eOperator & WO_IN)!=0 ){
drh1b8fc652013-02-07 21:15:14 +00003171 isEq = 0;
drh7a5bcc02013-01-16 17:08:58 +00003172 }else if( (pConstraint->eOperator & WO_ISNULL)!=0 ){
drh8e4af1b2012-10-08 18:23:51 +00003173 uniqueNotNull = 0;
drh2f546ee2012-10-09 09:26:28 +00003174 isEq = 1; /* "X IS NULL" means X has only a single value */
drh6b9e5652012-10-08 20:27:35 +00003175 }else if( pConstraint->prereqRight==0 ){
drh2f546ee2012-10-09 09:26:28 +00003176 isEq = 1; /* Constraint "X=constant" means X has only a single value */
drh8e4af1b2012-10-08 18:23:51 +00003177 }else{
3178 Expr *pRight = pConstraint->pExpr->pRight;
3179 if( pRight->op==TK_COLUMN ){
drhf1b5f5b2013-05-02 00:15:01 +00003180 /*WHERETRACE((" .. isOrderedColumn(tab=%d,col=%d)",
3181 pRight->iTable, pRight->iColumn));*/
drh8e4af1b2012-10-08 18:23:51 +00003182 isEq = isOrderedColumn(p, pRight->iTable, pRight->iColumn);
drhf1b5f5b2013-05-02 00:15:01 +00003183 /*WHERETRACE((" -> isEq=%d\n", isEq));*/
drh2f546ee2012-10-09 09:26:28 +00003184
3185 /* If the constraint is of the form X=Y where Y is an ordered value
3186 ** in an outer loop, then make sure the sort order of Y matches the
3187 ** sort order required for X. */
drh2fad8152012-10-08 21:01:15 +00003188 if( isMatch && isEq>=2 && isEq!=pOBItem->sortOrder+2 ){
drh2f546ee2012-10-09 09:26:28 +00003189 testcase( isEq==2 );
3190 testcase( isEq==3 );
drh8e4af1b2012-10-08 18:23:51 +00003191 break;
3192 }
3193 }else{
drh2f546ee2012-10-09 09:26:28 +00003194 isEq = 0; /* "X=expr" places no ordering constraints on X */
drh8e4af1b2012-10-08 18:23:51 +00003195 }
3196 }
drh8e4af1b2012-10-08 18:23:51 +00003197 if( !isMatch ){
3198 if( isEq==0 ){
3199 break;
3200 }else{
3201 continue;
3202 }
drh6b9e5652012-10-08 20:27:35 +00003203 }else if( isEq!=1 ){
3204 if( sortOrder==2 ){
3205 sortOrder = termSortOrder;
3206 }else if( termSortOrder!=sortOrder ){
3207 break;
3208 }
drh60441af2012-09-29 19:10:29 +00003209 }
3210 j++;
drh8e4af1b2012-10-08 18:23:51 +00003211 pOBItem++;
drh60441af2012-09-29 19:10:29 +00003212 if( iColumn<0 ){
3213 seenRowid = 1;
3214 break;
drh2f546ee2012-10-09 09:26:28 +00003215 }else if( pTab->aCol[iColumn].notNull==0 && isEq!=1 ){
3216 testcase( isEq==0 );
3217 testcase( isEq==2 );
3218 testcase( isEq==3 );
drh4f68d6c2012-10-04 12:10:25 +00003219 uniqueNotNull = 0;
drh60441af2012-09-29 19:10:29 +00003220 }
3221 }
drh8a1b87c2013-03-27 15:04:28 +00003222 if( seenRowid ){
3223 uniqueNotNull = 1;
3224 }else if( uniqueNotNull==0 || i<pIdx->nColumn ){
3225 uniqueNotNull = 0;
3226 }
drh0a4c7412012-10-08 19:41:38 +00003227
3228 /* If we have not found at least one ORDER BY term that matches the
3229 ** index, then show no progress. */
3230 if( pOBItem==&pOrderBy->a[nPriorSat] ) return nPriorSat;
3231
drhd9883572013-03-27 17:20:10 +00003232 /* Either the outer queries must generate rows where there are no two
3233 ** rows with the same values in all ORDER BY columns, or else this
3234 ** loop must generate just a single row of output. Example: Suppose
3235 ** the outer loops generate A=1 and A=1, and this loop generates B=3
3236 ** and B=4. Then without the following test, ORDER BY A,B would
3237 ** generate the wrong order output: 1,3 1,4 1,3 1,4
3238 */
drh8a1b87c2013-03-27 15:04:28 +00003239 if( outerObUnique==0 && uniqueNotNull==0 ) return nPriorSat;
3240 *pbObUnique = uniqueNotNull;
3241
drh0a4c7412012-10-08 19:41:38 +00003242 /* Return the necessary scan order back to the caller */
drh4f68d6c2012-10-04 12:10:25 +00003243 *pbRev = sortOrder & 1;
drh60441af2012-09-29 19:10:29 +00003244
3245 /* If there was an "ORDER BY rowid" term that matched, or it is only
3246 ** possible for a single row from this table to match, then skip over
3247 ** any additional ORDER BY terms dealing with this table.
3248 */
drh8a1b87c2013-03-27 15:04:28 +00003249 if( uniqueNotNull ){
drh60441af2012-09-29 19:10:29 +00003250 /* Advance j over additional ORDER BY terms associated with base */
3251 WhereMaskSet *pMS = p->pWC->pMaskSet;
3252 Bitmask m = ~getMask(pMS, base);
3253 while( j<nTerm && (exprTableUsage(pMS, pOrderBy->a[j].pExpr)&m)==0 ){
3254 j++;
3255 }
3256 }
3257 return j;
3258}
dan02fa4692009-08-17 17:06:58 +00003259
3260/*
drh083310d2011-01-28 01:57:41 +00003261** Find the best query plan for accessing a particular table. Write the
drh56f1b992012-09-25 14:29:39 +00003262** best query plan and its cost into the p->cost.
drh51147ba2005-07-23 22:59:55 +00003263**
drh111a6a72008-12-21 03:51:16 +00003264** The lowest cost plan wins. The cost is an estimate of the amount of
drh083310d2011-01-28 01:57:41 +00003265** CPU and disk I/O needed to process the requested result.
drh51147ba2005-07-23 22:59:55 +00003266** Factors that influence cost include:
3267**
3268** * The estimated number of rows that will be retrieved. (The
3269** fewer the better.)
3270**
3271** * Whether or not sorting must occur.
3272**
3273** * Whether or not there must be separate lookups in the
3274** index and in the main table.
3275**
danielk1977e2d7b242009-02-23 17:33:49 +00003276** If there was an INDEXED BY clause (pSrc->pIndex) attached to the table in
3277** the SQL statement, then this function only considers plans using the
drh296a4832009-03-22 20:36:18 +00003278** named index. If no such plan is found, then the returned cost is
3279** SQLITE_BIG_DBL. If a plan is found that uses the named index,
danielk197785574e32008-10-06 05:32:18 +00003280** then the cost is calculated in the usual way.
3281**
drh21172c42012-10-30 00:29:07 +00003282** If a NOT INDEXED clause was attached to the table
danielk1977e2d7b242009-02-23 17:33:49 +00003283** in the SELECT statement, then no indexes are considered. However, the
drh083310d2011-01-28 01:57:41 +00003284** selected plan may still take advantage of the built-in rowid primary key
danielk197785574e32008-10-06 05:32:18 +00003285** index.
drhfe05af82005-07-21 03:14:59 +00003286*/
drh56f1b992012-09-25 14:29:39 +00003287static void bestBtreeIndex(WhereBestIdx *p){
3288 Parse *pParse = p->pParse; /* The parsing context */
3289 WhereClause *pWC = p->pWC; /* The WHERE clause */
3290 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
drh51147ba2005-07-23 22:59:55 +00003291 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
3292 Index *pProbe; /* An index we are evaluating */
dan5236ac12009-08-13 07:09:33 +00003293 Index *pIdx; /* Copy of pProbe, or zero for IPK index */
3294 int eqTermMask; /* Current mask of valid equality operators */
3295 int idxEqTermMask; /* Index mask of valid equality operators */
drhcdaca552009-08-20 13:45:07 +00003296 Index sPk; /* A fake index object for the primary key */
drhfaacf172011-08-12 01:51:45 +00003297 tRowcnt aiRowEstPk[2]; /* The aiRowEst[] value for the sPk index */
drhcdaca552009-08-20 13:45:07 +00003298 int aiColumnPk = -1; /* The aColumn[] value for the sPk index */
drh56f1b992012-09-25 14:29:39 +00003299 int wsFlagMask; /* Allowed flags in p->cost.plan.wsFlag */
drh04229ac2012-12-08 22:14:29 +00003300 int nPriorSat; /* ORDER BY terms satisfied by outer loops */
3301 int nOrderBy; /* Number of ORDER BY terms */
3302 char bSortInit; /* Initializer for bSort in inner loop */
3303 char bDistInit; /* Initializer for bDist in inner loop */
3304
drhfe05af82005-07-21 03:14:59 +00003305
drhcdaca552009-08-20 13:45:07 +00003306 /* Initialize the cost to a worst-case value */
drh56f1b992012-09-25 14:29:39 +00003307 memset(&p->cost, 0, sizeof(p->cost));
3308 p->cost.rCost = SQLITE_BIG_DBL;
drh51147ba2005-07-23 22:59:55 +00003309
drhc49de5d2007-01-19 01:06:01 +00003310 /* If the pSrc table is the right table of a LEFT JOIN then we may not
3311 ** use an index to satisfy IS NULL constraints on that table. This is
3312 ** because columns might end up being NULL if the table does not match -
3313 ** a circumstance which the index cannot help us discover. Ticket #2177.
3314 */
dan5236ac12009-08-13 07:09:33 +00003315 if( pSrc->jointype & JT_LEFT ){
3316 idxEqTermMask = WO_EQ|WO_IN;
drhc49de5d2007-01-19 01:06:01 +00003317 }else{
dan5236ac12009-08-13 07:09:33 +00003318 idxEqTermMask = WO_EQ|WO_IN|WO_ISNULL;
drhc49de5d2007-01-19 01:06:01 +00003319 }
3320
danielk197785574e32008-10-06 05:32:18 +00003321 if( pSrc->pIndex ){
drhcdaca552009-08-20 13:45:07 +00003322 /* An INDEXED BY clause specifies a particular index to use */
dan5236ac12009-08-13 07:09:33 +00003323 pIdx = pProbe = pSrc->pIndex;
3324 wsFlagMask = ~(WHERE_ROWID_EQ|WHERE_ROWID_RANGE);
3325 eqTermMask = idxEqTermMask;
3326 }else{
drh083310d2011-01-28 01:57:41 +00003327 /* There is no INDEXED BY clause. Create a fake Index object in local
3328 ** variable sPk to represent the rowid primary key index. Make this
3329 ** fake index the first in a chain of Index objects with all of the real
3330 ** indices to follow */
3331 Index *pFirst; /* First of real indices on the table */
drhcdaca552009-08-20 13:45:07 +00003332 memset(&sPk, 0, sizeof(Index));
3333 sPk.nColumn = 1;
3334 sPk.aiColumn = &aiColumnPk;
3335 sPk.aiRowEst = aiRowEstPk;
drhcdaca552009-08-20 13:45:07 +00003336 sPk.onError = OE_Replace;
3337 sPk.pTable = pSrc->pTab;
drh15564052010-09-25 22:32:56 +00003338 aiRowEstPk[0] = pSrc->pTab->nRowEst;
3339 aiRowEstPk[1] = 1;
drhcdaca552009-08-20 13:45:07 +00003340 pFirst = pSrc->pTab->pIndex;
dan5236ac12009-08-13 07:09:33 +00003341 if( pSrc->notIndexed==0 ){
drh083310d2011-01-28 01:57:41 +00003342 /* The real indices of the table are only considered if the
3343 ** NOT INDEXED qualifier is omitted from the FROM clause */
drhcdaca552009-08-20 13:45:07 +00003344 sPk.pNext = pFirst;
dan5236ac12009-08-13 07:09:33 +00003345 }
drhcdaca552009-08-20 13:45:07 +00003346 pProbe = &sPk;
dan5236ac12009-08-13 07:09:33 +00003347 wsFlagMask = ~(
3348 WHERE_COLUMN_IN|WHERE_COLUMN_EQ|WHERE_COLUMN_NULL|WHERE_COLUMN_RANGE
3349 );
3350 eqTermMask = WO_EQ|WO_IN;
3351 pIdx = 0;
danielk197785574e32008-10-06 05:32:18 +00003352 }
drh51147ba2005-07-23 22:59:55 +00003353
drh04229ac2012-12-08 22:14:29 +00003354 nOrderBy = p->pOrderBy ? p->pOrderBy->nExpr : 0;
3355 if( p->i ){
3356 nPriorSat = p->aLevel[p->i-1].plan.nOBSat;
3357 bSortInit = nPriorSat<nOrderBy;
3358 bDistInit = 0;
3359 }else{
3360 nPriorSat = 0;
3361 bSortInit = nOrderBy>0;
3362 bDistInit = p->pDistinct!=0;
3363 }
3364
drhcdaca552009-08-20 13:45:07 +00003365 /* Loop over all indices looking for the best one to use
3366 */
dan5236ac12009-08-13 07:09:33 +00003367 for(; pProbe; pIdx=pProbe=pProbe->pNext){
drhfaacf172011-08-12 01:51:45 +00003368 const tRowcnt * const aiRowEst = pProbe->aiRowEst;
drhd663b5b2012-10-03 00:25:54 +00003369 WhereCost pc; /* Cost of using pProbe */
drh93c63842011-09-22 00:28:55 +00003370 double log10N = (double)1; /* base-10 logarithm of nRow (inexact) */
drh8e4af1b2012-10-08 18:23:51 +00003371
dan5236ac12009-08-13 07:09:33 +00003372 /* The following variables are populated based on the properties of
drh083310d2011-01-28 01:57:41 +00003373 ** index being evaluated. They are then used to determine the expected
dan5236ac12009-08-13 07:09:33 +00003374 ** cost and number of rows returned.
3375 **
drhd663b5b2012-10-03 00:25:54 +00003376 ** pc.plan.nEq:
dan5236ac12009-08-13 07:09:33 +00003377 ** Number of equality terms that can be implemented using the index.
drh083310d2011-01-28 01:57:41 +00003378 ** In other words, the number of initial fields in the index that
3379 ** are used in == or IN or NOT NULL constraints of the WHERE clause.
dan5236ac12009-08-13 07:09:33 +00003380 **
3381 ** nInMul:
3382 ** The "in-multiplier". This is an estimate of how many seek operations
3383 ** SQLite must perform on the index in question. For example, if the
3384 ** WHERE clause is:
3385 **
3386 ** WHERE a IN (1, 2, 3) AND b IN (4, 5, 6)
3387 **
3388 ** SQLite must perform 9 lookups on an index on (a, b), so nInMul is
3389 ** set to 9. Given the same schema and either of the following WHERE
3390 ** clauses:
3391 **
3392 ** WHERE a = 1
3393 ** WHERE a >= 2
3394 **
3395 ** nInMul is set to 1.
3396 **
3397 ** If there exists a WHERE term of the form "x IN (SELECT ...)", then
3398 ** the sub-select is assumed to return 25 rows for the purposes of
3399 ** determining nInMul.
3400 **
3401 ** bInEst:
3402 ** Set to true if there was at least one "x IN (SELECT ...)" term used
drh083310d2011-01-28 01:57:41 +00003403 ** in determining the value of nInMul. Note that the RHS of the
3404 ** IN operator must be a SELECT, not a value list, for this variable
3405 ** to be true.
dan5236ac12009-08-13 07:09:33 +00003406 **
drhfaacf172011-08-12 01:51:45 +00003407 ** rangeDiv:
3408 ** An estimate of a divisor by which to reduce the search space due
3409 ** to inequality constraints. In the absence of sqlite_stat3 ANALYZE
3410 ** data, a single inequality reduces the search space to 1/4rd its
3411 ** original size (rangeDiv==4). Two inequalities reduce the search
3412 ** space to 1/16th of its original size (rangeDiv==16).
dan5236ac12009-08-13 07:09:33 +00003413 **
3414 ** bSort:
3415 ** Boolean. True if there is an ORDER BY clause that will require an
3416 ** external sort (i.e. scanning the index being evaluated will not
3417 ** correctly order records).
3418 **
drh04b85bc2012-10-01 17:44:05 +00003419 ** bDist:
drh46c35f92012-09-26 23:17:01 +00003420 ** Boolean. True if there is a DISTINCT clause that will require an
3421 ** external btree.
3422 **
dan5236ac12009-08-13 07:09:33 +00003423 ** bLookup:
drh083310d2011-01-28 01:57:41 +00003424 ** Boolean. True if a table lookup is required for each index entry
3425 ** visited. In other words, true if this is not a covering index.
3426 ** This is always false for the rowid primary key index of a table.
3427 ** For other indexes, it is true unless all the columns of the table
3428 ** used by the SELECT statement are present in the index (such an
3429 ** index is sometimes described as a covering index).
dan5236ac12009-08-13 07:09:33 +00003430 ** For example, given the index on (a, b), the second of the following
drh083310d2011-01-28 01:57:41 +00003431 ** two queries requires table b-tree lookups in order to find the value
3432 ** of column c, but the first does not because columns a and b are
3433 ** both available in the index.
dan5236ac12009-08-13 07:09:33 +00003434 **
3435 ** SELECT a, b FROM tbl WHERE a = 1;
3436 ** SELECT a, b, c FROM tbl WHERE a = 1;
drhfe05af82005-07-21 03:14:59 +00003437 */
drh083310d2011-01-28 01:57:41 +00003438 int bInEst = 0; /* True if "x IN (SELECT...)" seen */
3439 int nInMul = 1; /* Number of distinct equalities to lookup */
drh4e50c5e2011-08-13 19:35:19 +00003440 double rangeDiv = (double)1; /* Estimated reduction in search space */
drh82759752011-01-20 16:52:09 +00003441 int nBound = 0; /* Number of range constraints seen */
drh04229ac2012-12-08 22:14:29 +00003442 char bSort = bSortInit; /* True if external sort required */
3443 char bDist = bDistInit; /* True if index cannot help with DISTINCT */
3444 char bLookup = 0; /* True if not a covering index */
drh82759752011-01-20 16:52:09 +00003445 WhereTerm *pTerm; /* A single term of the WHERE clause */
drhfaacf172011-08-12 01:51:45 +00003446#ifdef SQLITE_ENABLE_STAT3
drh0c50fa02011-01-21 16:27:18 +00003447 WhereTerm *pFirstTerm = 0; /* First term matching the index */
drh82759752011-01-20 16:52:09 +00003448#endif
dan5236ac12009-08-13 07:09:33 +00003449
drhf1b5f5b2013-05-02 00:15:01 +00003450 /*WHERETRACE((
drh86257ff2012-10-09 01:39:25 +00003451 " %s(%s):\n",
3452 pSrc->pTab->zName, (pIdx ? pIdx->zName : "ipk")
drhf1b5f5b2013-05-02 00:15:01 +00003453 ));*/
drh613a53a2012-10-03 18:09:32 +00003454 memset(&pc, 0, sizeof(pc));
drh04229ac2012-12-08 22:14:29 +00003455 pc.plan.nOBSat = nPriorSat;
drh9cd1c992012-09-25 20:43:35 +00003456
drhd663b5b2012-10-03 00:25:54 +00003457 /* Determine the values of pc.plan.nEq and nInMul */
drh4f68d6c2012-10-04 12:10:25 +00003458 for(pc.plan.nEq=0; pc.plan.nEq<pProbe->nColumn; pc.plan.nEq++){
drhd663b5b2012-10-03 00:25:54 +00003459 int j = pProbe->aiColumn[pc.plan.nEq];
drh56f1b992012-09-25 14:29:39 +00003460 pTerm = findTerm(pWC, iCur, j, p->notReady, eqTermMask, pIdx);
drhfe05af82005-07-21 03:14:59 +00003461 if( pTerm==0 ) break;
drhd663b5b2012-10-03 00:25:54 +00003462 pc.plan.wsFlags |= (WHERE_COLUMN_EQ|WHERE_ROWID_EQ);
drh0a61df62011-10-07 17:45:58 +00003463 testcase( pTerm->pWC!=pWC );
drhb52076c2006-01-23 13:22:09 +00003464 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00003465 Expr *pExpr = pTerm->pExpr;
drhd663b5b2012-10-03 00:25:54 +00003466 pc.plan.wsFlags |= WHERE_COLUMN_IN;
danielk19776ab3a2e2009-02-19 14:39:25 +00003467 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drh9b3eb0a2011-01-21 14:37:04 +00003468 /* "x IN (SELECT ...)": Assume the SELECT returns 25 rows */
dan5236ac12009-08-13 07:09:33 +00003469 nInMul *= 25;
3470 bInEst = 1;
drh083310d2011-01-28 01:57:41 +00003471 }else if( ALWAYS(pExpr->x.pList && pExpr->x.pList->nExpr) ){
drh9b3eb0a2011-01-21 14:37:04 +00003472 /* "x IN (value, value, ...)" */
drh083310d2011-01-28 01:57:41 +00003473 nInMul *= pExpr->x.pList->nExpr;
drhfe05af82005-07-21 03:14:59 +00003474 }
drh46619d62009-04-24 14:51:42 +00003475 }else if( pTerm->eOperator & WO_ISNULL ){
drhd663b5b2012-10-03 00:25:54 +00003476 pc.plan.wsFlags |= WHERE_COLUMN_NULL;
drhfe05af82005-07-21 03:14:59 +00003477 }
drhfaacf172011-08-12 01:51:45 +00003478#ifdef SQLITE_ENABLE_STAT3
drhd663b5b2012-10-03 00:25:54 +00003479 if( pc.plan.nEq==0 && pProbe->aSample ) pFirstTerm = pTerm;
drh82759752011-01-20 16:52:09 +00003480#endif
drhd663b5b2012-10-03 00:25:54 +00003481 pc.used |= pTerm->prereqRight;
drhfe05af82005-07-21 03:14:59 +00003482 }
dan0c733f62011-11-16 15:27:09 +00003483
3484 /* If the index being considered is UNIQUE, and there is an equality
3485 ** constraint for all columns in the index, then this search will find
3486 ** at most a single row. In this case set the WHERE_UNIQUE flag to
3487 ** indicate this to the caller.
3488 **
3489 ** Otherwise, if the search may find more than one row, test to see if
drh1b8fc652013-02-07 21:15:14 +00003490 ** there is a range constraint on indexed column (pc.plan.nEq+1) that
3491 ** can be optimized using the index.
dan0c733f62011-11-16 15:27:09 +00003492 */
drhd663b5b2012-10-03 00:25:54 +00003493 if( pc.plan.nEq==pProbe->nColumn && pProbe->onError!=OE_None ){
3494 testcase( pc.plan.wsFlags & WHERE_COLUMN_IN );
3495 testcase( pc.plan.wsFlags & WHERE_COLUMN_NULL );
3496 if( (pc.plan.wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_NULL))==0 ){
3497 pc.plan.wsFlags |= WHERE_UNIQUE;
drh60441af2012-09-29 19:10:29 +00003498 if( p->i==0 || (p->aLevel[p->i-1].plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
drhd663b5b2012-10-03 00:25:54 +00003499 pc.plan.wsFlags |= WHERE_ALL_UNIQUE;
drh60441af2012-09-29 19:10:29 +00003500 }
dan0c733f62011-11-16 15:27:09 +00003501 }
3502 }else if( pProbe->bUnordered==0 ){
drhd663b5b2012-10-03 00:25:54 +00003503 int j;
3504 j = (pc.plan.nEq==pProbe->nColumn ? -1 : pProbe->aiColumn[pc.plan.nEq]);
drh56f1b992012-09-25 14:29:39 +00003505 if( findTerm(pWC, iCur, j, p->notReady, WO_LT|WO_LE|WO_GT|WO_GE, pIdx) ){
3506 WhereTerm *pTop, *pBtm;
3507 pTop = findTerm(pWC, iCur, j, p->notReady, WO_LT|WO_LE, pIdx);
3508 pBtm = findTerm(pWC, iCur, j, p->notReady, WO_GT|WO_GE, pIdx);
drhd663b5b2012-10-03 00:25:54 +00003509 whereRangeScanEst(pParse, pProbe, pc.plan.nEq, pBtm, pTop, &rangeDiv);
dan5236ac12009-08-13 07:09:33 +00003510 if( pTop ){
drhed754ce2010-04-15 01:04:54 +00003511 nBound = 1;
drhd663b5b2012-10-03 00:25:54 +00003512 pc.plan.wsFlags |= WHERE_TOP_LIMIT;
3513 pc.used |= pTop->prereqRight;
drh0a61df62011-10-07 17:45:58 +00003514 testcase( pTop->pWC!=pWC );
dan5236ac12009-08-13 07:09:33 +00003515 }
3516 if( pBtm ){
drhed754ce2010-04-15 01:04:54 +00003517 nBound++;
drhd663b5b2012-10-03 00:25:54 +00003518 pc.plan.wsFlags |= WHERE_BTM_LIMIT;
3519 pc.used |= pBtm->prereqRight;
drh0a61df62011-10-07 17:45:58 +00003520 testcase( pBtm->pWC!=pWC );
dan5236ac12009-08-13 07:09:33 +00003521 }
drhd663b5b2012-10-03 00:25:54 +00003522 pc.plan.wsFlags |= (WHERE_COLUMN_RANGE|WHERE_ROWID_RANGE);
dan5236ac12009-08-13 07:09:33 +00003523 }
drh943af3c2005-07-29 19:43:58 +00003524 }
drhfe05af82005-07-21 03:14:59 +00003525
dan5236ac12009-08-13 07:09:33 +00003526 /* If there is an ORDER BY clause and the index being considered will
3527 ** naturally scan rows in the required order, set the appropriate flags
drhd663b5b2012-10-03 00:25:54 +00003528 ** in pc.plan.wsFlags. Otherwise, if there is an ORDER BY clause but
3529 ** the index will scan rows in a different order, set the bSort
3530 ** variable. */
drh8e4af1b2012-10-08 18:23:51 +00003531 if( bSort && (pSrc->jointype & JT_LEFT)==0 ){
3532 int bRev = 2;
drh8a1b87c2013-03-27 15:04:28 +00003533 int bObUnique = 0;
drhf1b5f5b2013-05-02 00:15:01 +00003534 /*WHERETRACE((" --> before isSortIndex: nPriorSat=%d\n",nPriorSat));*/
drh8a1b87c2013-03-27 15:04:28 +00003535 pc.plan.nOBSat = isSortingIndex(p, pProbe, iCur, &bRev, &bObUnique);
drhf1b5f5b2013-05-02 00:15:01 +00003536 /*WHERETRACE((" --> after isSortIndex: bRev=%d bObU=%d nOBSat=%d\n",
3537 bRev, bObUnique, pc.plan.nOBSat));*/
drh29a8bf82013-01-09 11:31:17 +00003538 if( nPriorSat<pc.plan.nOBSat || (pc.plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
drhd663b5b2012-10-03 00:25:54 +00003539 pc.plan.wsFlags |= WHERE_ORDERED;
drh8a1b87c2013-03-27 15:04:28 +00003540 if( bObUnique ) pc.plan.wsFlags |= WHERE_OB_UNIQUE;
drh46c35f92012-09-26 23:17:01 +00003541 }
drhd663b5b2012-10-03 00:25:54 +00003542 if( nOrderBy==pc.plan.nOBSat ){
3543 bSort = 0;
3544 pc.plan.wsFlags |= WHERE_ROWID_RANGE|WHERE_COLUMN_RANGE;
3545 }
3546 if( bRev & 1 ) pc.plan.wsFlags |= WHERE_REVERSE;
dan38cc40c2011-06-30 20:17:15 +00003547 }
3548
3549 /* If there is a DISTINCT qualifier and this index will scan rows in
3550 ** order of the DISTINCT expressions, clear bDist and set the appropriate
drhd663b5b2012-10-03 00:25:54 +00003551 ** flags in pc.plan.wsFlags. */
drh9cd1c992012-09-25 20:43:35 +00003552 if( bDist
drhd663b5b2012-10-03 00:25:54 +00003553 && isDistinctIndex(pParse, pWC, pProbe, iCur, p->pDistinct, pc.plan.nEq)
3554 && (pc.plan.wsFlags & WHERE_COLUMN_IN)==0
drh7f67d942012-03-03 00:34:47 +00003555 ){
dan38cc40c2011-06-30 20:17:15 +00003556 bDist = 0;
drhd663b5b2012-10-03 00:25:54 +00003557 pc.plan.wsFlags |= WHERE_ROWID_RANGE|WHERE_COLUMN_RANGE|WHERE_DISTINCT;
drhfe05af82005-07-21 03:14:59 +00003558 }
3559
dan5236ac12009-08-13 07:09:33 +00003560 /* If currently calculating the cost of using an index (not the IPK
3561 ** index), determine if all required column data may be obtained without
drh4139c992010-04-07 14:59:45 +00003562 ** using the main table (i.e. if the index is a covering
dan5236ac12009-08-13 07:09:33 +00003563 ** index for this query). If it is, set the WHERE_IDX_ONLY flag in
drhd663b5b2012-10-03 00:25:54 +00003564 ** pc.plan.wsFlags. Otherwise, set the bLookup variable to true. */
drh3f4d1d12012-09-15 18:45:54 +00003565 if( pIdx ){
drhfe05af82005-07-21 03:14:59 +00003566 Bitmask m = pSrc->colUsed;
3567 int j;
dan5236ac12009-08-13 07:09:33 +00003568 for(j=0; j<pIdx->nColumn; j++){
3569 int x = pIdx->aiColumn[j];
drhfe05af82005-07-21 03:14:59 +00003570 if( x<BMS-1 ){
3571 m &= ~(((Bitmask)1)<<x);
3572 }
3573 }
3574 if( m==0 ){
drhd663b5b2012-10-03 00:25:54 +00003575 pc.plan.wsFlags |= WHERE_IDX_ONLY;
dan5236ac12009-08-13 07:09:33 +00003576 }else{
3577 bLookup = 1;
drhfe05af82005-07-21 03:14:59 +00003578 }
3579 }
3580
drh1e0f4a82010-04-14 19:01:44 +00003581 /*
drh9b3eb0a2011-01-21 14:37:04 +00003582 ** Estimate the number of rows of output. For an "x IN (SELECT...)"
3583 ** constraint, do not let the estimate exceed half the rows in the table.
drhcdaca552009-08-20 13:45:07 +00003584 */
drhd663b5b2012-10-03 00:25:54 +00003585 pc.plan.nRow = (double)(aiRowEst[pc.plan.nEq] * nInMul);
3586 if( bInEst && pc.plan.nRow*2>aiRowEst[0] ){
3587 pc.plan.nRow = aiRowEst[0]/2;
3588 nInMul = (int)(pc.plan.nRow / aiRowEst[pc.plan.nEq]);
dan5236ac12009-08-13 07:09:33 +00003589 }
drhcdaca552009-08-20 13:45:07 +00003590
drhfaacf172011-08-12 01:51:45 +00003591#ifdef SQLITE_ENABLE_STAT3
drhbf4ec552011-07-13 18:31:10 +00003592 /* If the constraint is of the form x=VALUE or x IN (E1,E2,...)
3593 ** and we do not think that values of x are unique and if histogram
drh82759752011-01-20 16:52:09 +00003594 ** data is available for column x, then it might be possible
3595 ** to get a better estimate on the number of rows based on
3596 ** VALUE and how common that value is according to the histogram.
3597 */
drhd663b5b2012-10-03 00:25:54 +00003598 if( pc.plan.nRow>(double)1 && pc.plan.nEq==1
3599 && pFirstTerm!=0 && aiRowEst[1]>1 ){
drh567211e2011-09-23 13:59:33 +00003600 assert( (pFirstTerm->eOperator & (WO_EQ|WO_ISNULL|WO_IN))!=0 );
drh1f9c7662011-03-17 01:34:26 +00003601 if( pFirstTerm->eOperator & (WO_EQ|WO_ISNULL) ){
drh7a5bcc02013-01-16 17:08:58 +00003602 testcase( pFirstTerm->eOperator & WO_EQ );
3603 testcase( pFirstTerm->eOperator & WO_EQUIV );
3604 testcase( pFirstTerm->eOperator & WO_ISNULL );
drhd663b5b2012-10-03 00:25:54 +00003605 whereEqualScanEst(pParse, pProbe, pFirstTerm->pExpr->pRight,
3606 &pc.plan.nRow);
drh567211e2011-09-23 13:59:33 +00003607 }else if( bInEst==0 ){
drh7a5bcc02013-01-16 17:08:58 +00003608 assert( pFirstTerm->eOperator & WO_IN );
drhd663b5b2012-10-03 00:25:54 +00003609 whereInScanEst(pParse, pProbe, pFirstTerm->pExpr->x.pList,
3610 &pc.plan.nRow);
drh0c50fa02011-01-21 16:27:18 +00003611 }
drh82759752011-01-20 16:52:09 +00003612 }
drhfaacf172011-08-12 01:51:45 +00003613#endif /* SQLITE_ENABLE_STAT3 */
drh82759752011-01-20 16:52:09 +00003614
drh37722062011-02-10 00:08:47 +00003615 /* Adjust the number of output rows and downward to reflect rows
drhcdaca552009-08-20 13:45:07 +00003616 ** that are excluded by range constraints.
3617 */
drhd663b5b2012-10-03 00:25:54 +00003618 pc.plan.nRow = pc.plan.nRow/rangeDiv;
3619 if( pc.plan.nRow<1 ) pc.plan.nRow = 1;
drhcdaca552009-08-20 13:45:07 +00003620
drh37722062011-02-10 00:08:47 +00003621 /* Experiments run on real SQLite databases show that the time needed
3622 ** to do a binary search to locate a row in a table or index is roughly
3623 ** log10(N) times the time to move from one row to the next row within
3624 ** a table or index. The actual times can vary, with the size of
3625 ** records being an important factor. Both moves and searches are
3626 ** slower with larger records, presumably because fewer records fit
3627 ** on one page and hence more pages have to be fetched.
drh083310d2011-01-28 01:57:41 +00003628 **
drh74e7c8f2011-10-21 19:06:32 +00003629 ** The ANALYZE command and the sqlite_stat1 and sqlite_stat3 tables do
drh37722062011-02-10 00:08:47 +00003630 ** not give us data on the relative sizes of table and index records.
3631 ** So this computation assumes table records are about twice as big
3632 ** as index records
drhb9661942011-01-24 15:11:23 +00003633 */
drh2b6c8742013-03-27 16:05:30 +00003634 if( (pc.plan.wsFlags&~(WHERE_REVERSE|WHERE_ORDERED|WHERE_OB_UNIQUE))
3635 ==WHERE_IDX_ONLY
drh3f4d1d12012-09-15 18:45:54 +00003636 && (pWC->wctrlFlags & WHERE_ONEPASS_DESIRED)==0
drhde9a7b82012-09-17 20:44:46 +00003637 && sqlite3GlobalConfig.bUseCis
drh7e5418e2012-09-27 15:05:54 +00003638 && OptimizationEnabled(pParse->db, SQLITE_CoverIdxScan)
drh3f4d1d12012-09-15 18:45:54 +00003639 ){
3640 /* This index is not useful for indexing, but it is a covering index.
3641 ** A full-scan of the index might be a little faster than a full-scan
3642 ** of the table, so give this case a cost slightly less than a table
3643 ** scan. */
drhd663b5b2012-10-03 00:25:54 +00003644 pc.rCost = aiRowEst[0]*3 + pProbe->nColumn;
3645 pc.plan.wsFlags |= WHERE_COVER_SCAN|WHERE_COLUMN_RANGE;
3646 }else if( (pc.plan.wsFlags & WHERE_NOT_FULLSCAN)==0 ){
drh37722062011-02-10 00:08:47 +00003647 /* The cost of a full table scan is a number of move operations equal
3648 ** to the number of rows in the table.
3649 **
3650 ** We add an additional 4x penalty to full table scans. This causes
3651 ** the cost function to err on the side of choosing an index over
3652 ** choosing a full scan. This 4x full-scan penalty is an arguable
3653 ** decision and one which we expect to revisit in the future. But
3654 ** it seems to be working well enough at the moment.
drh083310d2011-01-28 01:57:41 +00003655 */
drhd663b5b2012-10-03 00:25:54 +00003656 pc.rCost = aiRowEst[0]*4;
3657 pc.plan.wsFlags &= ~WHERE_IDX_ONLY;
drh8e4af1b2012-10-08 18:23:51 +00003658 if( pIdx ){
3659 pc.plan.wsFlags &= ~WHERE_ORDERED;
3660 pc.plan.nOBSat = nPriorSat;
3661 }
drh37722062011-02-10 00:08:47 +00003662 }else{
3663 log10N = estLog(aiRowEst[0]);
drhd663b5b2012-10-03 00:25:54 +00003664 pc.rCost = pc.plan.nRow;
drh37722062011-02-10 00:08:47 +00003665 if( pIdx ){
3666 if( bLookup ){
3667 /* For an index lookup followed by a table lookup:
3668 ** nInMul index searches to find the start of each index range
3669 ** + nRow steps through the index
3670 ** + nRow table searches to lookup the table entry using the rowid
3671 */
drhd663b5b2012-10-03 00:25:54 +00003672 pc.rCost += (nInMul + pc.plan.nRow)*log10N;
drh37722062011-02-10 00:08:47 +00003673 }else{
3674 /* For a covering index:
3675 ** nInMul index searches to find the initial entry
3676 ** + nRow steps through the index
3677 */
drhd663b5b2012-10-03 00:25:54 +00003678 pc.rCost += nInMul*log10N;
drh37722062011-02-10 00:08:47 +00003679 }
3680 }else{
3681 /* For a rowid primary key lookup:
3682 ** nInMult table searches to find the initial entry for each range
3683 ** + nRow steps through the table
3684 */
drhd663b5b2012-10-03 00:25:54 +00003685 pc.rCost += nInMul*log10N;
drh37722062011-02-10 00:08:47 +00003686 }
drhb9661942011-01-24 15:11:23 +00003687 }
3688
drh37722062011-02-10 00:08:47 +00003689 /* Add in the estimated cost of sorting the result. Actual experimental
3690 ** measurements of sorting performance in SQLite show that sorting time
3691 ** adds C*N*log10(N) to the cost, where N is the number of rows to be
3692 ** sorted and C is a factor between 1.95 and 4.3. We will split the
3693 ** difference and select C of 3.0.
drhcdaca552009-08-20 13:45:07 +00003694 */
dan5236ac12009-08-13 07:09:33 +00003695 if( bSort ){
drhd663b5b2012-10-03 00:25:54 +00003696 double m = estLog(pc.plan.nRow*(nOrderBy - pc.plan.nOBSat)/nOrderBy);
3697 m *= (double)(pc.plan.nOBSat ? 2 : 3);
3698 pc.rCost += pc.plan.nRow*m;
dan5236ac12009-08-13 07:09:33 +00003699 }
dan38cc40c2011-06-30 20:17:15 +00003700 if( bDist ){
drhd663b5b2012-10-03 00:25:54 +00003701 pc.rCost += pc.plan.nRow*estLog(pc.plan.nRow)*3;
dan38cc40c2011-06-30 20:17:15 +00003702 }
drhcdaca552009-08-20 13:45:07 +00003703
drhcdaca552009-08-20 13:45:07 +00003704 /**** Cost of using this index has now been computed ****/
dan5236ac12009-08-13 07:09:33 +00003705
drh1e0f4a82010-04-14 19:01:44 +00003706 /* If there are additional constraints on this table that cannot
3707 ** be used with the current index, but which might lower the number
3708 ** of output rows, adjust the nRow value accordingly. This only
3709 ** matters if the current index is the least costly, so do not bother
3710 ** with this step if we already know this index will not be chosen.
drhed754ce2010-04-15 01:04:54 +00003711 ** Also, never reduce the output row count below 2 using this step.
drhed808ac2010-04-15 13:29:37 +00003712 **
drh547caad2010-10-04 23:55:50 +00003713 ** It is critical that the notValid mask be used here instead of
3714 ** the notReady mask. When computing an "optimal" index, the notReady
3715 ** mask will only have one bit set - the bit for the current table.
3716 ** The notValid mask, on the other hand, always has all bits set for
3717 ** tables that are not in outer loops. If notReady is used here instead
3718 ** of notValid, then a optimal index that depends on inner joins loops
3719 ** might be selected even when there exists an optimal index that has
3720 ** no such dependency.
drh1e0f4a82010-04-14 19:01:44 +00003721 */
drhd663b5b2012-10-03 00:25:54 +00003722 if( pc.plan.nRow>2 && pc.rCost<=p->cost.rCost ){
drhed808ac2010-04-15 13:29:37 +00003723 int k; /* Loop counter */
drhd663b5b2012-10-03 00:25:54 +00003724 int nSkipEq = pc.plan.nEq; /* Number of == constraints to skip */
drhed808ac2010-04-15 13:29:37 +00003725 int nSkipRange = nBound; /* Number of < constraints to skip */
3726 Bitmask thisTab; /* Bitmap for pSrc */
3727
3728 thisTab = getMask(pWC->pMaskSet, iCur);
drhd663b5b2012-10-03 00:25:54 +00003729 for(pTerm=pWC->a, k=pWC->nTerm; pc.plan.nRow>2 && k; k--, pTerm++){
drh534230c2011-01-22 00:10:45 +00003730 if( pTerm->wtFlags & TERM_VIRTUAL ) continue;
drh56f1b992012-09-25 14:29:39 +00003731 if( (pTerm->prereqAll & p->notValid)!=thisTab ) continue;
drh1e0f4a82010-04-14 19:01:44 +00003732 if( pTerm->eOperator & (WO_EQ|WO_IN|WO_ISNULL) ){
drhed754ce2010-04-15 01:04:54 +00003733 if( nSkipEq ){
drhd663b5b2012-10-03 00:25:54 +00003734 /* Ignore the first pc.plan.nEq equality matches since the index
drh1e0f4a82010-04-14 19:01:44 +00003735 ** has already accounted for these */
drhed754ce2010-04-15 01:04:54 +00003736 nSkipEq--;
drh1e0f4a82010-04-14 19:01:44 +00003737 }else{
3738 /* Assume each additional equality match reduces the result
3739 ** set size by a factor of 10 */
drhd663b5b2012-10-03 00:25:54 +00003740 pc.plan.nRow /= 10;
drh1e0f4a82010-04-14 19:01:44 +00003741 }
drhed754ce2010-04-15 01:04:54 +00003742 }else if( pTerm->eOperator & (WO_LT|WO_LE|WO_GT|WO_GE) ){
3743 if( nSkipRange ){
drh5ac06072011-01-21 18:18:13 +00003744 /* Ignore the first nSkipRange range constraints since the index
drhed754ce2010-04-15 01:04:54 +00003745 ** has already accounted for these */
3746 nSkipRange--;
3747 }else{
3748 /* Assume each additional range constraint reduces the result
drh083310d2011-01-28 01:57:41 +00003749 ** set size by a factor of 3. Indexed range constraints reduce
3750 ** the search space by a larger factor: 4. We make indexed range
3751 ** more selective intentionally because of the subjective
3752 ** observation that indexed range constraints really are more
3753 ** selective in practice, on average. */
drhd663b5b2012-10-03 00:25:54 +00003754 pc.plan.nRow /= 3;
drhed754ce2010-04-15 01:04:54 +00003755 }
drh7a5bcc02013-01-16 17:08:58 +00003756 }else if( (pTerm->eOperator & WO_NOOP)==0 ){
drh1e0f4a82010-04-14 19:01:44 +00003757 /* Any other expression lowers the output row count by half */
drhd663b5b2012-10-03 00:25:54 +00003758 pc.plan.nRow /= 2;
drh1e0f4a82010-04-14 19:01:44 +00003759 }
3760 }
drhd663b5b2012-10-03 00:25:54 +00003761 if( pc.plan.nRow<2 ) pc.plan.nRow = 2;
drh1e0f4a82010-04-14 19:01:44 +00003762 }
3763
3764
drhf1b5f5b2013-05-02 00:15:01 +00003765 /*WHERETRACE((
drh8e4af1b2012-10-08 18:23:51 +00003766 " nEq=%d nInMul=%d rangeDiv=%d bSort=%d bLookup=%d wsFlags=0x%08x\n"
3767 " notReady=0x%llx log10N=%.1f nRow=%.1f cost=%.1f\n"
3768 " used=0x%llx nOBSat=%d\n",
drhd663b5b2012-10-03 00:25:54 +00003769 pc.plan.nEq, nInMul, (int)rangeDiv, bSort, bLookup, pc.plan.wsFlags,
drh4f68d6c2012-10-04 12:10:25 +00003770 p->notReady, log10N, pc.plan.nRow, pc.rCost, pc.used,
drhd663b5b2012-10-03 00:25:54 +00003771 pc.plan.nOBSat
drhf1b5f5b2013-05-02 00:15:01 +00003772 ));*/
dan5236ac12009-08-13 07:09:33 +00003773
drhcdaca552009-08-20 13:45:07 +00003774 /* If this index is the best we have seen so far, then record this
drhd663b5b2012-10-03 00:25:54 +00003775 ** index and its cost in the p->cost structure.
drhcdaca552009-08-20 13:45:07 +00003776 */
drhd663b5b2012-10-03 00:25:54 +00003777 if( (!pIdx || pc.plan.wsFlags) && compareCost(&pc, &p->cost) ){
3778 p->cost = pc;
3779 p->cost.plan.wsFlags &= wsFlagMask;
drh56f1b992012-09-25 14:29:39 +00003780 p->cost.plan.u.pIdx = pIdx;
drhfe05af82005-07-21 03:14:59 +00003781 }
dan5236ac12009-08-13 07:09:33 +00003782
drhcdaca552009-08-20 13:45:07 +00003783 /* If there was an INDEXED BY clause, then only that one index is
3784 ** considered. */
dan5236ac12009-08-13 07:09:33 +00003785 if( pSrc->pIndex ) break;
drhcdaca552009-08-20 13:45:07 +00003786
3787 /* Reset masks for the next index in the loop */
dan5236ac12009-08-13 07:09:33 +00003788 wsFlagMask = ~(WHERE_ROWID_EQ|WHERE_ROWID_RANGE);
3789 eqTermMask = idxEqTermMask;
drhfe05af82005-07-21 03:14:59 +00003790 }
3791
dan5236ac12009-08-13 07:09:33 +00003792 /* If there is no ORDER BY clause and the SQLITE_ReverseOrder flag
3793 ** is set, then reverse the order that the index will be scanned
3794 ** in. This is used for application testing, to help find cases
mistachkin48864df2013-03-21 21:20:32 +00003795 ** where application behavior depends on the (undefined) order that
dan5236ac12009-08-13 07:09:33 +00003796 ** SQLite outputs rows in in the absence of an ORDER BY clause. */
drh56f1b992012-09-25 14:29:39 +00003797 if( !p->pOrderBy && pParse->db->flags & SQLITE_ReverseOrder ){
3798 p->cost.plan.wsFlags |= WHERE_REVERSE;
dan5236ac12009-08-13 07:09:33 +00003799 }
3800
drhd663b5b2012-10-03 00:25:54 +00003801 assert( p->pOrderBy || (p->cost.plan.wsFlags&WHERE_ORDERED)==0 );
drh56f1b992012-09-25 14:29:39 +00003802 assert( p->cost.plan.u.pIdx==0 || (p->cost.plan.wsFlags&WHERE_ROWID_EQ)==0 );
dan5236ac12009-08-13 07:09:33 +00003803 assert( pSrc->pIndex==0
drh56f1b992012-09-25 14:29:39 +00003804 || p->cost.plan.u.pIdx==0
3805 || p->cost.plan.u.pIdx==pSrc->pIndex
dan5236ac12009-08-13 07:09:33 +00003806 );
3807
drhf1b5f5b2013-05-02 00:15:01 +00003808 /*WHERETRACE((" best index is %s cost=%.1f\n",
drhea84a652013-01-15 18:49:07 +00003809 p->cost.plan.u.pIdx ? p->cost.plan.u.pIdx->zName : "ipk",
drhf1b5f5b2013-05-02 00:15:01 +00003810 p->cost.rCost));*/
dan5236ac12009-08-13 07:09:33 +00003811
drh56f1b992012-09-25 14:29:39 +00003812 bestOrClauseIndex(p);
3813 bestAutomaticIndex(p);
drh6b7157b2013-05-10 02:00:35 +00003814 if( eqTermMask & WO_ISNULL ) p->cost.plan.wsFlags |= WHERE_NULL_OK;
drhfe05af82005-07-21 03:14:59 +00003815}
3816
danielk19771d461462009-04-21 09:02:45 +00003817/*
3818** Find the query plan for accessing table pSrc->pTab. Write the
3819** best query plan and its cost into the WhereCost object supplied
3820** as the last parameter. This function may calculate the cost of
3821** both real and virtual table scans.
drh4d85fa72012-09-24 19:50:00 +00003822**
3823** This function does not take ORDER BY or DISTINCT into account. Nor
3824** does it remember the virtual table query plan. All it does is compute
3825** the cost while determining if an OR optimization is applicable. The
3826** details will be reconsidered later if the optimization is found to be
3827** applicable.
danielk19771d461462009-04-21 09:02:45 +00003828*/
drh56f1b992012-09-25 14:29:39 +00003829static void bestIndex(WhereBestIdx *p){
shanee26fa4c2009-06-16 14:15:22 +00003830#ifndef SQLITE_OMIT_VIRTUALTABLE
drh56f1b992012-09-25 14:29:39 +00003831 if( IsVirtual(p->pSrc->pTab) ){
3832 sqlite3_index_info *pIdxInfo = 0;
3833 p->ppIdxInfo = &pIdxInfo;
3834 bestVirtualIndex(p);
drh5edf8432013-02-08 23:18:18 +00003835 assert( pIdxInfo!=0 || p->pParse->db->mallocFailed );
3836 if( pIdxInfo && pIdxInfo->needToFreeIdxStr ){
drh56f1b992012-09-25 14:29:39 +00003837 sqlite3_free(pIdxInfo->idxStr);
danielk19771d461462009-04-21 09:02:45 +00003838 }
drh56f1b992012-09-25 14:29:39 +00003839 sqlite3DbFree(p->pParse->db, pIdxInfo);
shanee26fa4c2009-06-16 14:15:22 +00003840 }else
3841#endif
3842 {
drh56f1b992012-09-25 14:29:39 +00003843 bestBtreeIndex(p);
danielk19771d461462009-04-21 09:02:45 +00003844 }
3845}
drhb6c29892004-11-22 19:12:19 +00003846
3847/*
drh2ffb1182004-07-19 19:14:01 +00003848** Disable a term in the WHERE clause. Except, do not disable the term
3849** if it controls a LEFT OUTER JOIN and it did not originate in the ON
3850** or USING clause of that join.
3851**
3852** Consider the term t2.z='ok' in the following queries:
3853**
3854** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
3855** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
3856** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
3857**
drh23bf66d2004-12-14 03:34:34 +00003858** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00003859** in the ON clause. The term is disabled in (3) because it is not part
3860** of a LEFT OUTER JOIN. In (1), the term is not disabled.
3861**
drhe9cdcea2010-07-22 22:40:03 +00003862** IMPLEMENTATION-OF: R-24597-58655 No tests are done for terms that are
3863** completely satisfied by indices.
3864**
drh2ffb1182004-07-19 19:14:01 +00003865** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00003866** of the join. Disabling is an optimization. When terms are satisfied
3867** by indices, we disable them to prevent redundant tests in the inner
3868** loop. We would get the correct results if nothing were ever disabled,
3869** but joins might run a little slower. The trick is to disable as much
3870** as we can without disabling too much. If we disabled in (1), we'd get
3871** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00003872*/
drh0fcef5e2005-07-19 17:38:22 +00003873static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
3874 if( pTerm
drhbe837bd2010-04-30 21:03:24 +00003875 && (pTerm->wtFlags & TERM_CODED)==0
drh0fcef5e2005-07-19 17:38:22 +00003876 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
3877 ){
drh165be382008-12-05 02:36:33 +00003878 pTerm->wtFlags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00003879 if( pTerm->iParent>=0 ){
3880 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
3881 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00003882 disableTerm(pLevel, pOther);
3883 }
drh0fcef5e2005-07-19 17:38:22 +00003884 }
drh2ffb1182004-07-19 19:14:01 +00003885 }
3886}
3887
3888/*
dan69f8bb92009-08-13 19:21:16 +00003889** Code an OP_Affinity opcode to apply the column affinity string zAff
3890** to the n registers starting at base.
3891**
drh039fc322009-11-17 18:31:47 +00003892** As an optimization, SQLITE_AFF_NONE entries (which are no-ops) at the
3893** beginning and end of zAff are ignored. If all entries in zAff are
3894** SQLITE_AFF_NONE, then no code gets generated.
3895**
3896** This routine makes its own copy of zAff so that the caller is free
3897** to modify zAff after this routine returns.
drh94a11212004-09-25 13:12:14 +00003898*/
dan69f8bb92009-08-13 19:21:16 +00003899static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
3900 Vdbe *v = pParse->pVdbe;
drh039fc322009-11-17 18:31:47 +00003901 if( zAff==0 ){
3902 assert( pParse->db->mallocFailed );
3903 return;
3904 }
dan69f8bb92009-08-13 19:21:16 +00003905 assert( v!=0 );
drh039fc322009-11-17 18:31:47 +00003906
3907 /* Adjust base and n to skip over SQLITE_AFF_NONE entries at the beginning
3908 ** and end of the affinity string.
3909 */
3910 while( n>0 && zAff[0]==SQLITE_AFF_NONE ){
3911 n--;
3912 base++;
3913 zAff++;
3914 }
3915 while( n>1 && zAff[n-1]==SQLITE_AFF_NONE ){
3916 n--;
3917 }
3918
3919 /* Code the OP_Affinity opcode if there is anything left to do. */
3920 if( n>0 ){
3921 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
3922 sqlite3VdbeChangeP4(v, -1, zAff, n);
3923 sqlite3ExprCacheAffinityChange(pParse, base, n);
3924 }
drh94a11212004-09-25 13:12:14 +00003925}
3926
drhe8b97272005-07-19 22:22:12 +00003927
3928/*
drh51147ba2005-07-23 22:59:55 +00003929** Generate code for a single equality term of the WHERE clause. An equality
3930** term can be either X=expr or X IN (...). pTerm is the term to be
3931** coded.
3932**
drh1db639c2008-01-17 02:36:28 +00003933** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00003934**
3935** For a constraint of the form X=expr, the expression is evaluated and its
3936** result is left on the stack. For constraints of the form X IN (...)
3937** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00003938*/
drh678ccce2008-03-31 18:19:54 +00003939static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00003940 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00003941 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh0fe456b2013-03-12 18:34:50 +00003942 WhereLevel *pLevel, /* The level of the FROM clause we are working on */
3943 int iEq, /* Index of the equality term within this level */
drh678ccce2008-03-31 18:19:54 +00003944 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00003945){
drh0fcef5e2005-07-19 17:38:22 +00003946 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00003947 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00003948 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00003949
danielk19772d605492008-10-01 08:43:03 +00003950 assert( iTarget>0 );
drh50b39962006-10-28 00:28:09 +00003951 if( pX->op==TK_EQ ){
drh678ccce2008-03-31 18:19:54 +00003952 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00003953 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00003954 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00003955 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00003956#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00003957 }else{
danielk19779a96b662007-11-29 17:05:18 +00003958 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00003959 int iTab;
drh72e8fa42007-03-28 14:30:06 +00003960 struct InLoop *pIn;
drhd3832162013-03-12 18:49:25 +00003961 u8 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
danielk1977b3bce662005-01-29 08:32:43 +00003962
drhd3832162013-03-12 18:49:25 +00003963 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0
3964 && pLevel->plan.u.pIdx->aSortOrder[iEq]
3965 ){
drh725e1ae2013-03-12 23:58:42 +00003966 testcase( iEq==0 );
3967 testcase( iEq==pLevel->plan.u.pIdx->nColumn-1 );
3968 testcase( iEq>0 && iEq+1<pLevel->plan.u.pIdx->nColumn );
3969 testcase( bRev );
drh1ccce442013-03-12 20:38:51 +00003970 bRev = !bRev;
drh0fe456b2013-03-12 18:34:50 +00003971 }
drh50b39962006-10-28 00:28:09 +00003972 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00003973 iReg = iTarget;
danielk19770cdc0222008-06-26 18:04:03 +00003974 eType = sqlite3FindInIndex(pParse, pX, 0);
drh725e1ae2013-03-12 23:58:42 +00003975 if( eType==IN_INDEX_INDEX_DESC ){
3976 testcase( bRev );
3977 bRev = !bRev;
3978 }
danielk1977b3bce662005-01-29 08:32:43 +00003979 iTab = pX->iTable;
drh2d96b932013-02-08 18:48:23 +00003980 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
drh111a6a72008-12-21 03:51:16 +00003981 assert( pLevel->plan.wsFlags & WHERE_IN_ABLE );
3982 if( pLevel->u.in.nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00003983 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00003984 }
drh111a6a72008-12-21 03:51:16 +00003985 pLevel->u.in.nIn++;
3986 pLevel->u.in.aInLoop =
3987 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
3988 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
3989 pIn = pLevel->u.in.aInLoop;
drh72e8fa42007-03-28 14:30:06 +00003990 if( pIn ){
drh111a6a72008-12-21 03:51:16 +00003991 pIn += pLevel->u.in.nIn - 1;
drh72e8fa42007-03-28 14:30:06 +00003992 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00003993 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00003994 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00003995 }else{
drhb3190c12008-12-08 21:37:14 +00003996 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00003997 }
drh2d96b932013-02-08 18:48:23 +00003998 pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
drh1db639c2008-01-17 02:36:28 +00003999 sqlite3VdbeAddOp1(v, OP_IsNull, iReg);
drha6110402005-07-28 20:51:19 +00004000 }else{
drh111a6a72008-12-21 03:51:16 +00004001 pLevel->u.in.nIn = 0;
drhe23399f2005-07-22 00:31:39 +00004002 }
danielk1977b3bce662005-01-29 08:32:43 +00004003#endif
drh94a11212004-09-25 13:12:14 +00004004 }
drh0fcef5e2005-07-19 17:38:22 +00004005 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00004006 return iReg;
drh94a11212004-09-25 13:12:14 +00004007}
4008
drh51147ba2005-07-23 22:59:55 +00004009/*
4010** Generate code that will evaluate all == and IN constraints for an
drh039fc322009-11-17 18:31:47 +00004011** index.
drh51147ba2005-07-23 22:59:55 +00004012**
4013** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
4014** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
4015** The index has as many as three equality constraints, but in this
4016** example, the third "c" value is an inequality. So only two
4017** constraints are coded. This routine will generate code to evaluate
drh6df2acd2008-12-28 16:55:25 +00004018** a==5 and b IN (1,2,3). The current values for a and b will be stored
4019** in consecutive registers and the index of the first register is returned.
drh51147ba2005-07-23 22:59:55 +00004020**
4021** In the example above nEq==2. But this subroutine works for any value
4022** of nEq including 0. If nEq==0, this routine is nearly a no-op.
drh039fc322009-11-17 18:31:47 +00004023** The only thing it does is allocate the pLevel->iMem memory cell and
4024** compute the affinity string.
drh51147ba2005-07-23 22:59:55 +00004025**
drh700a2262008-12-17 19:22:15 +00004026** This routine always allocates at least one memory cell and returns
4027** the index of that memory cell. The code that
4028** calls this routine will use that memory cell to store the termination
drh51147ba2005-07-23 22:59:55 +00004029** key value of the loop. If one or more IN operators appear, then
4030** this routine allocates an additional nEq memory cells for internal
4031** use.
dan69f8bb92009-08-13 19:21:16 +00004032**
4033** Before returning, *pzAff is set to point to a buffer containing a
4034** copy of the column affinity string of the index allocated using
4035** sqlite3DbMalloc(). Except, entries in the copy of the string associated
4036** with equality constraints that use NONE affinity are set to
4037** SQLITE_AFF_NONE. This is to deal with SQL such as the following:
4038**
4039** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
4040** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
4041**
4042** In the example above, the index on t1(a) has TEXT affinity. But since
4043** the right hand side of the equality constraint (t2.b) has NONE affinity,
4044** no conversion should be attempted before using a t2.b value as part of
4045** a key to search the index. Hence the first byte in the returned affinity
4046** string in this example would be set to SQLITE_AFF_NONE.
drh51147ba2005-07-23 22:59:55 +00004047*/
drh1db639c2008-01-17 02:36:28 +00004048static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00004049 Parse *pParse, /* Parsing context */
4050 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
4051 WhereClause *pWC, /* The WHERE clause */
drh1db639c2008-01-17 02:36:28 +00004052 Bitmask notReady, /* Which parts of FROM have not yet been coded */
dan69f8bb92009-08-13 19:21:16 +00004053 int nExtraReg, /* Number of extra registers to allocate */
4054 char **pzAff /* OUT: Set to point to affinity string */
drh51147ba2005-07-23 22:59:55 +00004055){
drh111a6a72008-12-21 03:51:16 +00004056 int nEq = pLevel->plan.nEq; /* The number of == or IN constraints to code */
4057 Vdbe *v = pParse->pVdbe; /* The vm under construction */
4058 Index *pIdx; /* The index being used for this loop */
drh51147ba2005-07-23 22:59:55 +00004059 int iCur = pLevel->iTabCur; /* The cursor of the table */
4060 WhereTerm *pTerm; /* A single constraint term */
4061 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00004062 int regBase; /* Base register */
drh6df2acd2008-12-28 16:55:25 +00004063 int nReg; /* Number of registers to allocate */
dan69f8bb92009-08-13 19:21:16 +00004064 char *zAff; /* Affinity string to return */
drh6b7157b2013-05-10 02:00:35 +00004065 int eqFlags; /* WO_EQ|WO_IN and maybe also WO_ISNULL */
drh51147ba2005-07-23 22:59:55 +00004066
drh111a6a72008-12-21 03:51:16 +00004067 /* This module is only called on query plans that use an index. */
4068 assert( pLevel->plan.wsFlags & WHERE_INDEXED );
4069 pIdx = pLevel->plan.u.pIdx;
4070
drh51147ba2005-07-23 22:59:55 +00004071 /* Figure out how many memory cells we will need then allocate them.
drh51147ba2005-07-23 22:59:55 +00004072 */
drh700a2262008-12-17 19:22:15 +00004073 regBase = pParse->nMem + 1;
drh6df2acd2008-12-28 16:55:25 +00004074 nReg = pLevel->plan.nEq + nExtraReg;
4075 pParse->nMem += nReg;
drh51147ba2005-07-23 22:59:55 +00004076
dan69f8bb92009-08-13 19:21:16 +00004077 zAff = sqlite3DbStrDup(pParse->db, sqlite3IndexAffinityStr(v, pIdx));
4078 if( !zAff ){
4079 pParse->db->mallocFailed = 1;
4080 }
4081
drh51147ba2005-07-23 22:59:55 +00004082 /* Evaluate the equality constraints
4083 */
drhc49de5d2007-01-19 01:06:01 +00004084 assert( pIdx->nColumn>=nEq );
drh6b7157b2013-05-10 02:00:35 +00004085 eqFlags = (pLevel->plan.wsFlags&WHERE_NULL_OK) ? (WO_EQ|WO_IN|WO_ISNULL)
4086 : (WO_EQ|WO_IN);
drhc49de5d2007-01-19 01:06:01 +00004087 for(j=0; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00004088 int r1;
drh51147ba2005-07-23 22:59:55 +00004089 int k = pIdx->aiColumn[j];
drh6b7157b2013-05-10 02:00:35 +00004090 pTerm = findTerm(pWC, iCur, k, notReady, eqFlags, pIdx);
drh7b36ba32012-08-24 21:54:11 +00004091 if( pTerm==0 ) break;
drhbe837bd2010-04-30 21:03:24 +00004092 /* The following true for indices with redundant columns.
4093 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
4094 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
drhe9cdcea2010-07-22 22:40:03 +00004095 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh0fe456b2013-03-12 18:34:50 +00004096 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, regBase+j);
drh678ccce2008-03-31 18:19:54 +00004097 if( r1!=regBase+j ){
drh6df2acd2008-12-28 16:55:25 +00004098 if( nReg==1 ){
4099 sqlite3ReleaseTempReg(pParse, regBase);
4100 regBase = r1;
4101 }else{
4102 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
4103 }
drh678ccce2008-03-31 18:19:54 +00004104 }
drh981642f2008-04-19 14:40:43 +00004105 testcase( pTerm->eOperator & WO_ISNULL );
4106 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00004107 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drh039fc322009-11-17 18:31:47 +00004108 Expr *pRight = pTerm->pExpr->pRight;
drh2f2855b2009-11-18 01:25:26 +00004109 sqlite3ExprCodeIsNullJump(v, pRight, regBase+j, pLevel->addrBrk);
drh039fc322009-11-17 18:31:47 +00004110 if( zAff ){
4111 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_NONE ){
4112 zAff[j] = SQLITE_AFF_NONE;
4113 }
4114 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
4115 zAff[j] = SQLITE_AFF_NONE;
4116 }
dan69f8bb92009-08-13 19:21:16 +00004117 }
drh51147ba2005-07-23 22:59:55 +00004118 }
4119 }
dan69f8bb92009-08-13 19:21:16 +00004120 *pzAff = zAff;
drh1db639c2008-01-17 02:36:28 +00004121 return regBase;
drh51147ba2005-07-23 22:59:55 +00004122}
4123
dan2ce22452010-11-08 19:01:16 +00004124#ifndef SQLITE_OMIT_EXPLAIN
dan17c0bc02010-11-09 17:35:19 +00004125/*
drh69174c42010-11-12 15:35:59 +00004126** This routine is a helper for explainIndexRange() below
4127**
4128** pStr holds the text of an expression that we are building up one term
4129** at a time. This routine adds a new term to the end of the expression.
4130** Terms are separated by AND so add the "AND" text for second and subsequent
4131** terms only.
4132*/
4133static void explainAppendTerm(
4134 StrAccum *pStr, /* The text expression being built */
4135 int iTerm, /* Index of this term. First is zero */
4136 const char *zColumn, /* Name of the column */
4137 const char *zOp /* Name of the operator */
4138){
4139 if( iTerm ) sqlite3StrAccumAppend(pStr, " AND ", 5);
4140 sqlite3StrAccumAppend(pStr, zColumn, -1);
4141 sqlite3StrAccumAppend(pStr, zOp, 1);
4142 sqlite3StrAccumAppend(pStr, "?", 1);
4143}
4144
4145/*
dan17c0bc02010-11-09 17:35:19 +00004146** Argument pLevel describes a strategy for scanning table pTab. This
4147** function returns a pointer to a string buffer containing a description
4148** of the subset of table rows scanned by the strategy in the form of an
4149** SQL expression. Or, if all rows are scanned, NULL is returned.
4150**
4151** For example, if the query:
4152**
4153** SELECT * FROM t1 WHERE a=1 AND b>2;
4154**
4155** is run and there is an index on (a, b), then this function returns a
4156** string similar to:
4157**
4158** "a=? AND b>?"
4159**
4160** The returned pointer points to memory obtained from sqlite3DbMalloc().
4161** It is the responsibility of the caller to free the buffer when it is
4162** no longer required.
4163*/
4164static char *explainIndexRange(sqlite3 *db, WhereLevel *pLevel, Table *pTab){
dan2ce22452010-11-08 19:01:16 +00004165 WherePlan *pPlan = &pLevel->plan;
4166 Index *pIndex = pPlan->u.pIdx;
4167 int nEq = pPlan->nEq;
drh69174c42010-11-12 15:35:59 +00004168 int i, j;
4169 Column *aCol = pTab->aCol;
4170 int *aiColumn = pIndex->aiColumn;
4171 StrAccum txt;
dan2ce22452010-11-08 19:01:16 +00004172
drh69174c42010-11-12 15:35:59 +00004173 if( nEq==0 && (pPlan->wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ){
4174 return 0;
4175 }
4176 sqlite3StrAccumInit(&txt, 0, 0, SQLITE_MAX_LENGTH);
drh03b6df12010-11-15 16:29:30 +00004177 txt.db = db;
drh69174c42010-11-12 15:35:59 +00004178 sqlite3StrAccumAppend(&txt, " (", 2);
dan2ce22452010-11-08 19:01:16 +00004179 for(i=0; i<nEq; i++){
drh69174c42010-11-12 15:35:59 +00004180 explainAppendTerm(&txt, i, aCol[aiColumn[i]].zName, "=");
dan2ce22452010-11-08 19:01:16 +00004181 }
4182
drh69174c42010-11-12 15:35:59 +00004183 j = i;
dan2ce22452010-11-08 19:01:16 +00004184 if( pPlan->wsFlags&WHERE_BTM_LIMIT ){
dan0c733f62011-11-16 15:27:09 +00004185 char *z = (j==pIndex->nColumn ) ? "rowid" : aCol[aiColumn[j]].zName;
4186 explainAppendTerm(&txt, i++, z, ">");
dan2ce22452010-11-08 19:01:16 +00004187 }
4188 if( pPlan->wsFlags&WHERE_TOP_LIMIT ){
dan0c733f62011-11-16 15:27:09 +00004189 char *z = (j==pIndex->nColumn ) ? "rowid" : aCol[aiColumn[j]].zName;
4190 explainAppendTerm(&txt, i, z, "<");
dan2ce22452010-11-08 19:01:16 +00004191 }
drh69174c42010-11-12 15:35:59 +00004192 sqlite3StrAccumAppend(&txt, ")", 1);
4193 return sqlite3StrAccumFinish(&txt);
dan2ce22452010-11-08 19:01:16 +00004194}
4195
dan17c0bc02010-11-09 17:35:19 +00004196/*
4197** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
4198** command. If the query being compiled is an EXPLAIN QUERY PLAN, a single
4199** record is added to the output to describe the table scan strategy in
4200** pLevel.
4201*/
4202static void explainOneScan(
dan2ce22452010-11-08 19:01:16 +00004203 Parse *pParse, /* Parse context */
4204 SrcList *pTabList, /* Table list this loop refers to */
4205 WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
4206 int iLevel, /* Value for "level" column of output */
dan4a07e3d2010-11-09 14:48:59 +00004207 int iFrom, /* Value for "from" column of output */
4208 u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
dan2ce22452010-11-08 19:01:16 +00004209){
4210 if( pParse->explain==2 ){
4211 u32 flags = pLevel->plan.wsFlags;
4212 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
dan17c0bc02010-11-09 17:35:19 +00004213 Vdbe *v = pParse->pVdbe; /* VM being constructed */
4214 sqlite3 *db = pParse->db; /* Database handle */
4215 char *zMsg; /* Text to add to EQP output */
dan4a07e3d2010-11-09 14:48:59 +00004216 sqlite3_int64 nRow; /* Expected number of rows visited by scan */
4217 int iId = pParse->iSelectId; /* Select id (left-most output column) */
dan4bc39fa2010-11-13 16:42:27 +00004218 int isSearch; /* True for a SEARCH. False for SCAN. */
dan2ce22452010-11-08 19:01:16 +00004219
dan4a07e3d2010-11-09 14:48:59 +00004220 if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_ONETABLE_ONLY) ) return;
dan2ce22452010-11-08 19:01:16 +00004221
drh04098e62010-11-15 21:50:19 +00004222 isSearch = (pLevel->plan.nEq>0)
4223 || (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
4224 || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
dan4bc39fa2010-11-13 16:42:27 +00004225
4226 zMsg = sqlite3MPrintf(db, "%s", isSearch?"SEARCH":"SCAN");
dan4a07e3d2010-11-09 14:48:59 +00004227 if( pItem->pSelect ){
dan4bc39fa2010-11-13 16:42:27 +00004228 zMsg = sqlite3MAppendf(db, zMsg, "%s SUBQUERY %d", zMsg,pItem->iSelectId);
dan4a07e3d2010-11-09 14:48:59 +00004229 }else{
dan4bc39fa2010-11-13 16:42:27 +00004230 zMsg = sqlite3MAppendf(db, zMsg, "%s TABLE %s", zMsg, pItem->zName);
dan4a07e3d2010-11-09 14:48:59 +00004231 }
4232
dan2ce22452010-11-08 19:01:16 +00004233 if( pItem->zAlias ){
4234 zMsg = sqlite3MAppendf(db, zMsg, "%s AS %s", zMsg, pItem->zAlias);
4235 }
4236 if( (flags & WHERE_INDEXED)!=0 ){
dan17c0bc02010-11-09 17:35:19 +00004237 char *zWhere = explainIndexRange(db, pLevel, pItem->pTab);
dan4bc39fa2010-11-13 16:42:27 +00004238 zMsg = sqlite3MAppendf(db, zMsg, "%s USING %s%sINDEX%s%s%s", zMsg,
dan2ce22452010-11-08 19:01:16 +00004239 ((flags & WHERE_TEMP_INDEX)?"AUTOMATIC ":""),
4240 ((flags & WHERE_IDX_ONLY)?"COVERING ":""),
4241 ((flags & WHERE_TEMP_INDEX)?"":" "),
4242 ((flags & WHERE_TEMP_INDEX)?"": pLevel->plan.u.pIdx->zName),
4243 zWhere
4244 );
4245 sqlite3DbFree(db, zWhere);
4246 }else if( flags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
dan4bc39fa2010-11-13 16:42:27 +00004247 zMsg = sqlite3MAppendf(db, zMsg, "%s USING INTEGER PRIMARY KEY", zMsg);
dan2ce22452010-11-08 19:01:16 +00004248
4249 if( flags&WHERE_ROWID_EQ ){
4250 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid=?)", zMsg);
drh04098e62010-11-15 21:50:19 +00004251 }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
dan2ce22452010-11-08 19:01:16 +00004252 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid>? AND rowid<?)", zMsg);
4253 }else if( flags&WHERE_BTM_LIMIT ){
4254 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid>?)", zMsg);
4255 }else if( flags&WHERE_TOP_LIMIT ){
4256 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid<?)", zMsg);
4257 }
4258 }
4259#ifndef SQLITE_OMIT_VIRTUALTABLE
4260 else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
4261 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
4262 zMsg = sqlite3MAppendf(db, zMsg, "%s VIRTUAL TABLE INDEX %d:%s", zMsg,
4263 pVtabIdx->idxNum, pVtabIdx->idxStr);
4264 }
4265#endif
dan4a07e3d2010-11-09 14:48:59 +00004266 if( wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX) ){
drh04098e62010-11-15 21:50:19 +00004267 testcase( wctrlFlags & WHERE_ORDERBY_MIN );
dan4a07e3d2010-11-09 14:48:59 +00004268 nRow = 1;
4269 }else{
4270 nRow = (sqlite3_int64)pLevel->plan.nRow;
4271 }
4272 zMsg = sqlite3MAppendf(db, zMsg, "%s (~%lld rows)", zMsg, nRow);
4273 sqlite3VdbeAddOp4(v, OP_Explain, iId, iLevel, iFrom, zMsg, P4_DYNAMIC);
dan2ce22452010-11-08 19:01:16 +00004274 }
4275}
4276#else
dan17c0bc02010-11-09 17:35:19 +00004277# define explainOneScan(u,v,w,x,y,z)
dan2ce22452010-11-08 19:01:16 +00004278#endif /* SQLITE_OMIT_EXPLAIN */
4279
4280
drh111a6a72008-12-21 03:51:16 +00004281/*
4282** Generate code for the start of the iLevel-th loop in the WHERE clause
4283** implementation described by pWInfo.
4284*/
4285static Bitmask codeOneLoopStart(
4286 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
4287 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh336a5302009-04-24 15:46:21 +00004288 u16 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
drh7a484802012-03-16 00:28:11 +00004289 Bitmask notReady /* Which tables are currently available */
drh111a6a72008-12-21 03:51:16 +00004290){
4291 int j, k; /* Loop counters */
4292 int iCur; /* The VDBE cursor for the table */
4293 int addrNxt; /* Where to jump to continue with the next IN case */
4294 int omitTable; /* True if we use the index only */
4295 int bRev; /* True if we need to scan in reverse order */
4296 WhereLevel *pLevel; /* The where level to be coded */
4297 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
4298 WhereTerm *pTerm; /* A WHERE clause term */
4299 Parse *pParse; /* Parsing context */
4300 Vdbe *v; /* The prepared stmt under constructions */
4301 struct SrcList_item *pTabItem; /* FROM clause term being coded */
drh23d04d52008-12-23 23:56:22 +00004302 int addrBrk; /* Jump here to break out of the loop */
4303 int addrCont; /* Jump here to continue with next cycle */
drh61495262009-04-22 15:32:59 +00004304 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
4305 int iReleaseReg = 0; /* Temp register to free before returning */
drh0c41d222013-04-22 02:39:10 +00004306 Bitmask newNotReady; /* Return value */
drh111a6a72008-12-21 03:51:16 +00004307
4308 pParse = pWInfo->pParse;
4309 v = pParse->pVdbe;
4310 pWC = pWInfo->pWC;
4311 pLevel = &pWInfo->a[iLevel];
4312 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
4313 iCur = pTabItem->iCursor;
4314 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
danielk19771d461462009-04-21 09:02:45 +00004315 omitTable = (pLevel->plan.wsFlags & WHERE_IDX_ONLY)!=0
drh336a5302009-04-24 15:46:21 +00004316 && (wctrlFlags & WHERE_FORCE_TABLE)==0;
drh0c41d222013-04-22 02:39:10 +00004317 VdbeNoopComment((v, "Begin Join Loop %d", iLevel));
drh111a6a72008-12-21 03:51:16 +00004318
4319 /* Create labels for the "break" and "continue" instructions
4320 ** for the current loop. Jump to addrBrk to break out of a loop.
4321 ** Jump to cont to go immediately to the next iteration of the
4322 ** loop.
4323 **
4324 ** When there is an IN operator, we also have a "addrNxt" label that
4325 ** means to continue with the next IN value combination. When
4326 ** there are no IN operators in the constraints, the "addrNxt" label
4327 ** is the same as "addrBrk".
4328 */
4329 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
4330 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
4331
4332 /* If this is the right table of a LEFT OUTER JOIN, allocate and
4333 ** initialize a memory cell that records if this table matches any
4334 ** row of the left table of the join.
4335 */
4336 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
4337 pLevel->iLeftJoin = ++pParse->nMem;
4338 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
4339 VdbeComment((v, "init LEFT JOIN no-match flag"));
4340 }
4341
drh21172c42012-10-30 00:29:07 +00004342 /* Special case of a FROM clause subquery implemented as a co-routine */
4343 if( pTabItem->viaCoroutine ){
4344 int regYield = pTabItem->regReturn;
4345 sqlite3VdbeAddOp2(v, OP_Integer, pTabItem->addrFillSub-1, regYield);
4346 pLevel->p2 = sqlite3VdbeAddOp1(v, OP_Yield, regYield);
4347 VdbeComment((v, "next row of co-routine %s", pTabItem->pTab->zName));
4348 sqlite3VdbeAddOp2(v, OP_If, regYield+1, addrBrk);
4349 pLevel->op = OP_Goto;
4350 }else
4351
drh111a6a72008-12-21 03:51:16 +00004352#ifndef SQLITE_OMIT_VIRTUALTABLE
4353 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
4354 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
4355 ** to access the data.
4356 */
4357 int iReg; /* P3 Value for OP_VFilter */
drh281bbe22012-10-16 23:17:14 +00004358 int addrNotFound;
drh111a6a72008-12-21 03:51:16 +00004359 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
4360 int nConstraint = pVtabIdx->nConstraint;
4361 struct sqlite3_index_constraint_usage *aUsage =
4362 pVtabIdx->aConstraintUsage;
4363 const struct sqlite3_index_constraint *aConstraint =
4364 pVtabIdx->aConstraint;
4365
drha62bb8d2009-11-23 21:23:45 +00004366 sqlite3ExprCachePush(pParse);
drh111a6a72008-12-21 03:51:16 +00004367 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
drh281bbe22012-10-16 23:17:14 +00004368 addrNotFound = pLevel->addrBrk;
drh111a6a72008-12-21 03:51:16 +00004369 for(j=1; j<=nConstraint; j++){
4370 for(k=0; k<nConstraint; k++){
4371 if( aUsage[k].argvIndex==j ){
drh281bbe22012-10-16 23:17:14 +00004372 int iTarget = iReg+j+1;
drh928d9c62013-02-07 09:33:56 +00004373 pTerm = &pWC->a[aConstraint[k].iTermOffset];
drh281bbe22012-10-16 23:17:14 +00004374 if( pTerm->eOperator & WO_IN ){
drh0fe456b2013-03-12 18:34:50 +00004375 codeEqualityTerm(pParse, pTerm, pLevel, k, iTarget);
drh281bbe22012-10-16 23:17:14 +00004376 addrNotFound = pLevel->addrNxt;
4377 }else{
4378 sqlite3ExprCode(pParse, pTerm->pExpr->pRight, iTarget);
4379 }
drh111a6a72008-12-21 03:51:16 +00004380 break;
4381 }
4382 }
4383 if( k==nConstraint ) break;
4384 }
drh111a6a72008-12-21 03:51:16 +00004385 sqlite3VdbeAddOp2(v, OP_Integer, pVtabIdx->idxNum, iReg);
4386 sqlite3VdbeAddOp2(v, OP_Integer, j-1, iReg+1);
drh281bbe22012-10-16 23:17:14 +00004387 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg, pVtabIdx->idxStr,
drh111a6a72008-12-21 03:51:16 +00004388 pVtabIdx->needToFreeIdxStr ? P4_MPRINTF : P4_STATIC);
drh111a6a72008-12-21 03:51:16 +00004389 pVtabIdx->needToFreeIdxStr = 0;
4390 for(j=0; j<nConstraint; j++){
4391 if( aUsage[j].omit ){
4392 int iTerm = aConstraint[j].iTermOffset;
4393 disableTerm(pLevel, &pWC->a[iTerm]);
4394 }
4395 }
4396 pLevel->op = OP_VNext;
4397 pLevel->p1 = iCur;
4398 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh23d04d52008-12-23 23:56:22 +00004399 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drha62bb8d2009-11-23 21:23:45 +00004400 sqlite3ExprCachePop(pParse, 1);
drh111a6a72008-12-21 03:51:16 +00004401 }else
4402#endif /* SQLITE_OMIT_VIRTUALTABLE */
4403
4404 if( pLevel->plan.wsFlags & WHERE_ROWID_EQ ){
4405 /* Case 1: We can directly reference a single row using an
4406 ** equality comparison against the ROWID field. Or
4407 ** we reference multiple rows using a "rowid IN (...)"
4408 ** construct.
4409 */
danielk19771d461462009-04-21 09:02:45 +00004410 iReleaseReg = sqlite3GetTempReg(pParse);
drh111a6a72008-12-21 03:51:16 +00004411 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
4412 assert( pTerm!=0 );
4413 assert( pTerm->pExpr!=0 );
drh111a6a72008-12-21 03:51:16 +00004414 assert( omitTable==0 );
drhe9cdcea2010-07-22 22:40:03 +00004415 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh0fe456b2013-03-12 18:34:50 +00004416 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, iReleaseReg);
drh111a6a72008-12-21 03:51:16 +00004417 addrNxt = pLevel->addrNxt;
danielk19771d461462009-04-21 09:02:45 +00004418 sqlite3VdbeAddOp2(v, OP_MustBeInt, iRowidReg, addrNxt);
4419 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, iRowidReg);
drh459f63e2013-03-06 01:55:27 +00004420 sqlite3ExprCacheAffinityChange(pParse, iRowidReg, 1);
drhceea3322009-04-23 13:22:42 +00004421 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
drh111a6a72008-12-21 03:51:16 +00004422 VdbeComment((v, "pk"));
4423 pLevel->op = OP_Noop;
4424 }else if( pLevel->plan.wsFlags & WHERE_ROWID_RANGE ){
4425 /* Case 2: We have an inequality comparison against the ROWID field.
4426 */
4427 int testOp = OP_Noop;
4428 int start;
4429 int memEndValue = 0;
4430 WhereTerm *pStart, *pEnd;
4431
4432 assert( omitTable==0 );
4433 pStart = findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0);
4434 pEnd = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0);
4435 if( bRev ){
4436 pTerm = pStart;
4437 pStart = pEnd;
4438 pEnd = pTerm;
4439 }
4440 if( pStart ){
4441 Expr *pX; /* The expression that defines the start bound */
4442 int r1, rTemp; /* Registers for holding the start boundary */
4443
4444 /* The following constant maps TK_xx codes into corresponding
4445 ** seek opcodes. It depends on a particular ordering of TK_xx
4446 */
4447 const u8 aMoveOp[] = {
4448 /* TK_GT */ OP_SeekGt,
4449 /* TK_LE */ OP_SeekLe,
4450 /* TK_LT */ OP_SeekLt,
4451 /* TK_GE */ OP_SeekGe
4452 };
4453 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
4454 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
4455 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
4456
drhe9cdcea2010-07-22 22:40:03 +00004457 testcase( pStart->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004458 pX = pStart->pExpr;
4459 assert( pX!=0 );
4460 assert( pStart->leftCursor==iCur );
4461 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
4462 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
4463 VdbeComment((v, "pk"));
4464 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
4465 sqlite3ReleaseTempReg(pParse, rTemp);
4466 disableTerm(pLevel, pStart);
4467 }else{
4468 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
4469 }
4470 if( pEnd ){
4471 Expr *pX;
4472 pX = pEnd->pExpr;
4473 assert( pX!=0 );
4474 assert( pEnd->leftCursor==iCur );
drhe9cdcea2010-07-22 22:40:03 +00004475 testcase( pEnd->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004476 memEndValue = ++pParse->nMem;
4477 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
4478 if( pX->op==TK_LT || pX->op==TK_GT ){
4479 testOp = bRev ? OP_Le : OP_Ge;
4480 }else{
4481 testOp = bRev ? OP_Lt : OP_Gt;
4482 }
4483 disableTerm(pLevel, pEnd);
4484 }
4485 start = sqlite3VdbeCurrentAddr(v);
4486 pLevel->op = bRev ? OP_Prev : OP_Next;
4487 pLevel->p1 = iCur;
4488 pLevel->p2 = start;
drhafc266a2010-03-31 17:47:44 +00004489 if( pStart==0 && pEnd==0 ){
4490 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4491 }else{
4492 assert( pLevel->p5==0 );
4493 }
danielk19771d461462009-04-21 09:02:45 +00004494 if( testOp!=OP_Noop ){
4495 iRowidReg = iReleaseReg = sqlite3GetTempReg(pParse);
4496 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00004497 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00004498 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
4499 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00004500 }
4501 }else if( pLevel->plan.wsFlags & (WHERE_COLUMN_RANGE|WHERE_COLUMN_EQ) ){
4502 /* Case 3: A scan using an index.
4503 **
4504 ** The WHERE clause may contain zero or more equality
4505 ** terms ("==" or "IN" operators) that refer to the N
4506 ** left-most columns of the index. It may also contain
4507 ** inequality constraints (>, <, >= or <=) on the indexed
4508 ** column that immediately follows the N equalities. Only
4509 ** the right-most column can be an inequality - the rest must
4510 ** use the "==" and "IN" operators. For example, if the
4511 ** index is on (x,y,z), then the following clauses are all
4512 ** optimized:
4513 **
4514 ** x=5
4515 ** x=5 AND y=10
4516 ** x=5 AND y<10
4517 ** x=5 AND y>5 AND y<10
4518 ** x=5 AND y=5 AND z<=10
4519 **
4520 ** The z<10 term of the following cannot be used, only
4521 ** the x=5 term:
4522 **
4523 ** x=5 AND z<10
4524 **
4525 ** N may be zero if there are inequality constraints.
4526 ** If there are no inequality constraints, then N is at
4527 ** least one.
4528 **
4529 ** This case is also used when there are no WHERE clause
4530 ** constraints but an index is selected anyway, in order
4531 ** to force the output order to conform to an ORDER BY.
4532 */
drh3bb9b932010-08-06 02:10:00 +00004533 static const u8 aStartOp[] = {
drh111a6a72008-12-21 03:51:16 +00004534 0,
4535 0,
4536 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
4537 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
4538 OP_SeekGt, /* 4: (start_constraints && !startEq && !bRev) */
4539 OP_SeekLt, /* 5: (start_constraints && !startEq && bRev) */
4540 OP_SeekGe, /* 6: (start_constraints && startEq && !bRev) */
4541 OP_SeekLe /* 7: (start_constraints && startEq && bRev) */
4542 };
drh3bb9b932010-08-06 02:10:00 +00004543 static const u8 aEndOp[] = {
drh111a6a72008-12-21 03:51:16 +00004544 OP_Noop, /* 0: (!end_constraints) */
4545 OP_IdxGE, /* 1: (end_constraints && !bRev) */
4546 OP_IdxLT /* 2: (end_constraints && bRev) */
4547 };
drh3bb9b932010-08-06 02:10:00 +00004548 int nEq = pLevel->plan.nEq; /* Number of == or IN terms */
drh111a6a72008-12-21 03:51:16 +00004549 int isMinQuery = 0; /* If this is an optimized SELECT min(x).. */
4550 int regBase; /* Base register holding constraint values */
4551 int r1; /* Temp register */
4552 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
4553 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
4554 int startEq; /* True if range start uses ==, >= or <= */
4555 int endEq; /* True if range end uses ==, >= or <= */
4556 int start_constraints; /* Start of range is constrained */
4557 int nConstraint; /* Number of constraint terms */
drh3bb9b932010-08-06 02:10:00 +00004558 Index *pIdx; /* The index we will be using */
4559 int iIdxCur; /* The VDBE cursor for the index */
4560 int nExtraReg = 0; /* Number of extra registers needed */
4561 int op; /* Instruction opcode */
dan6ac43392010-06-09 15:47:11 +00004562 char *zStartAff; /* Affinity for start of range constraint */
4563 char *zEndAff; /* Affinity for end of range constraint */
drh111a6a72008-12-21 03:51:16 +00004564
4565 pIdx = pLevel->plan.u.pIdx;
4566 iIdxCur = pLevel->iIdxCur;
dan0c733f62011-11-16 15:27:09 +00004567 k = (nEq==pIdx->nColumn ? -1 : pIdx->aiColumn[nEq]);
drh111a6a72008-12-21 03:51:16 +00004568
drh111a6a72008-12-21 03:51:16 +00004569 /* If this loop satisfies a sort order (pOrderBy) request that
4570 ** was passed to this function to implement a "SELECT min(x) ..."
4571 ** query, then the caller will only allow the loop to run for
4572 ** a single iteration. This means that the first row returned
4573 ** should not have a NULL value stored in 'x'. If column 'x' is
4574 ** the first one after the nEq equality constraints in the index,
4575 ** this requires some special handling.
4576 */
4577 if( (wctrlFlags&WHERE_ORDERBY_MIN)!=0
drhd663b5b2012-10-03 00:25:54 +00004578 && (pLevel->plan.wsFlags&WHERE_ORDERED)
drh111a6a72008-12-21 03:51:16 +00004579 && (pIdx->nColumn>nEq)
4580 ){
4581 /* assert( pOrderBy->nExpr==1 ); */
4582 /* assert( pOrderBy->a[0].pExpr->iColumn==pIdx->aiColumn[nEq] ); */
4583 isMinQuery = 1;
drh6df2acd2008-12-28 16:55:25 +00004584 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004585 }
4586
4587 /* Find any inequality constraint terms for the start and end
4588 ** of the range.
4589 */
4590 if( pLevel->plan.wsFlags & WHERE_TOP_LIMIT ){
4591 pRangeEnd = findTerm(pWC, iCur, k, notReady, (WO_LT|WO_LE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00004592 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004593 }
4594 if( pLevel->plan.wsFlags & WHERE_BTM_LIMIT ){
4595 pRangeStart = findTerm(pWC, iCur, k, notReady, (WO_GT|WO_GE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00004596 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004597 }
4598
drh6df2acd2008-12-28 16:55:25 +00004599 /* Generate code to evaluate all constraint terms using == or IN
4600 ** and store the values of those terms in an array of registers
4601 ** starting at regBase.
4602 */
dan69f8bb92009-08-13 19:21:16 +00004603 regBase = codeAllEqualityTerms(
dan6ac43392010-06-09 15:47:11 +00004604 pParse, pLevel, pWC, notReady, nExtraReg, &zStartAff
dan69f8bb92009-08-13 19:21:16 +00004605 );
dan6ac43392010-06-09 15:47:11 +00004606 zEndAff = sqlite3DbStrDup(pParse->db, zStartAff);
drh6df2acd2008-12-28 16:55:25 +00004607 addrNxt = pLevel->addrNxt;
4608
drh111a6a72008-12-21 03:51:16 +00004609 /* If we are doing a reverse order scan on an ascending index, or
4610 ** a forward order scan on a descending index, interchange the
4611 ** start and end terms (pRangeStart and pRangeEnd).
4612 */
dan0c733f62011-11-16 15:27:09 +00004613 if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
4614 || (bRev && pIdx->nColumn==nEq)
4615 ){
drh111a6a72008-12-21 03:51:16 +00004616 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
4617 }
4618
4619 testcase( pRangeStart && pRangeStart->eOperator & WO_LE );
4620 testcase( pRangeStart && pRangeStart->eOperator & WO_GE );
4621 testcase( pRangeEnd && pRangeEnd->eOperator & WO_LE );
4622 testcase( pRangeEnd && pRangeEnd->eOperator & WO_GE );
4623 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
4624 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
4625 start_constraints = pRangeStart || nEq>0;
4626
4627 /* Seek the index cursor to the start of the range. */
4628 nConstraint = nEq;
4629 if( pRangeStart ){
dan69f8bb92009-08-13 19:21:16 +00004630 Expr *pRight = pRangeStart->pExpr->pRight;
4631 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh534230c2011-01-22 00:10:45 +00004632 if( (pRangeStart->wtFlags & TERM_VNULL)==0 ){
4633 sqlite3ExprCodeIsNullJump(v, pRight, regBase+nEq, addrNxt);
4634 }
dan6ac43392010-06-09 15:47:11 +00004635 if( zStartAff ){
4636 if( sqlite3CompareAffinity(pRight, zStartAff[nEq])==SQLITE_AFF_NONE){
drh039fc322009-11-17 18:31:47 +00004637 /* Since the comparison is to be performed with no conversions
4638 ** applied to the operands, set the affinity to apply to pRight to
4639 ** SQLITE_AFF_NONE. */
dan6ac43392010-06-09 15:47:11 +00004640 zStartAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004641 }
dan6ac43392010-06-09 15:47:11 +00004642 if( sqlite3ExprNeedsNoAffinityChange(pRight, zStartAff[nEq]) ){
4643 zStartAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004644 }
4645 }
drh111a6a72008-12-21 03:51:16 +00004646 nConstraint++;
drhe9cdcea2010-07-22 22:40:03 +00004647 testcase( pRangeStart->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004648 }else if( isMinQuery ){
4649 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
4650 nConstraint++;
4651 startEq = 0;
4652 start_constraints = 1;
4653 }
dan6ac43392010-06-09 15:47:11 +00004654 codeApplyAffinity(pParse, regBase, nConstraint, zStartAff);
drh111a6a72008-12-21 03:51:16 +00004655 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
4656 assert( op!=0 );
4657 testcase( op==OP_Rewind );
4658 testcase( op==OP_Last );
4659 testcase( op==OP_SeekGt );
4660 testcase( op==OP_SeekGe );
4661 testcase( op==OP_SeekLe );
4662 testcase( op==OP_SeekLt );
drh8cff69d2009-11-12 19:59:44 +00004663 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh111a6a72008-12-21 03:51:16 +00004664
4665 /* Load the value for the inequality constraint at the end of the
4666 ** range (if any).
4667 */
4668 nConstraint = nEq;
4669 if( pRangeEnd ){
dan69f8bb92009-08-13 19:21:16 +00004670 Expr *pRight = pRangeEnd->pExpr->pRight;
drhf49f3522009-12-30 14:12:38 +00004671 sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
dan69f8bb92009-08-13 19:21:16 +00004672 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh534230c2011-01-22 00:10:45 +00004673 if( (pRangeEnd->wtFlags & TERM_VNULL)==0 ){
4674 sqlite3ExprCodeIsNullJump(v, pRight, regBase+nEq, addrNxt);
4675 }
dan6ac43392010-06-09 15:47:11 +00004676 if( zEndAff ){
4677 if( sqlite3CompareAffinity(pRight, zEndAff[nEq])==SQLITE_AFF_NONE){
drh039fc322009-11-17 18:31:47 +00004678 /* Since the comparison is to be performed with no conversions
4679 ** applied to the operands, set the affinity to apply to pRight to
4680 ** SQLITE_AFF_NONE. */
dan6ac43392010-06-09 15:47:11 +00004681 zEndAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004682 }
dan6ac43392010-06-09 15:47:11 +00004683 if( sqlite3ExprNeedsNoAffinityChange(pRight, zEndAff[nEq]) ){
4684 zEndAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004685 }
4686 }
dan6ac43392010-06-09 15:47:11 +00004687 codeApplyAffinity(pParse, regBase, nEq+1, zEndAff);
drh111a6a72008-12-21 03:51:16 +00004688 nConstraint++;
drhe9cdcea2010-07-22 22:40:03 +00004689 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004690 }
dan6ac43392010-06-09 15:47:11 +00004691 sqlite3DbFree(pParse->db, zStartAff);
4692 sqlite3DbFree(pParse->db, zEndAff);
drh111a6a72008-12-21 03:51:16 +00004693
4694 /* Top of the loop body */
4695 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
4696
4697 /* Check if the index cursor is past the end of the range. */
4698 op = aEndOp[(pRangeEnd || nEq) * (1 + bRev)];
4699 testcase( op==OP_Noop );
4700 testcase( op==OP_IdxGE );
4701 testcase( op==OP_IdxLT );
drh6df2acd2008-12-28 16:55:25 +00004702 if( op!=OP_Noop ){
drh8cff69d2009-11-12 19:59:44 +00004703 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh6df2acd2008-12-28 16:55:25 +00004704 sqlite3VdbeChangeP5(v, endEq!=bRev ?1:0);
4705 }
drh111a6a72008-12-21 03:51:16 +00004706
4707 /* If there are inequality constraints, check that the value
4708 ** of the table column that the inequality contrains is not NULL.
4709 ** If it is, jump to the next iteration of the loop.
4710 */
4711 r1 = sqlite3GetTempReg(pParse);
4712 testcase( pLevel->plan.wsFlags & WHERE_BTM_LIMIT );
4713 testcase( pLevel->plan.wsFlags & WHERE_TOP_LIMIT );
drh04098e62010-11-15 21:50:19 +00004714 if( (pLevel->plan.wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0 ){
drh111a6a72008-12-21 03:51:16 +00004715 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, nEq, r1);
4716 sqlite3VdbeAddOp2(v, OP_IsNull, r1, addrCont);
4717 }
danielk19771d461462009-04-21 09:02:45 +00004718 sqlite3ReleaseTempReg(pParse, r1);
drh111a6a72008-12-21 03:51:16 +00004719
4720 /* Seek the table cursor, if required */
drh23d04d52008-12-23 23:56:22 +00004721 disableTerm(pLevel, pRangeStart);
4722 disableTerm(pLevel, pRangeEnd);
danielk19771d461462009-04-21 09:02:45 +00004723 if( !omitTable ){
4724 iRowidReg = iReleaseReg = sqlite3GetTempReg(pParse);
4725 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00004726 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00004727 sqlite3VdbeAddOp2(v, OP_Seek, iCur, iRowidReg); /* Deferred seek */
drh111a6a72008-12-21 03:51:16 +00004728 }
drh111a6a72008-12-21 03:51:16 +00004729
4730 /* Record the instruction used to terminate the loop. Disable
4731 ** WHERE clause terms made redundant by the index range scan.
4732 */
drh95e037b2011-03-09 21:02:31 +00004733 if( pLevel->plan.wsFlags & WHERE_UNIQUE ){
4734 pLevel->op = OP_Noop;
4735 }else if( bRev ){
4736 pLevel->op = OP_Prev;
4737 }else{
4738 pLevel->op = OP_Next;
4739 }
drh111a6a72008-12-21 03:51:16 +00004740 pLevel->p1 = iIdxCur;
drh3f4d1d12012-09-15 18:45:54 +00004741 if( pLevel->plan.wsFlags & WHERE_COVER_SCAN ){
4742 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4743 }else{
4744 assert( pLevel->p5==0 );
4745 }
drhdd5f5a62008-12-23 13:35:23 +00004746 }else
4747
drh23d04d52008-12-23 23:56:22 +00004748#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00004749 if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drh111a6a72008-12-21 03:51:16 +00004750 /* Case 4: Two or more separately indexed terms connected by OR
4751 **
4752 ** Example:
4753 **
4754 ** CREATE TABLE t1(a,b,c,d);
4755 ** CREATE INDEX i1 ON t1(a);
4756 ** CREATE INDEX i2 ON t1(b);
4757 ** CREATE INDEX i3 ON t1(c);
4758 **
4759 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
4760 **
4761 ** In the example, there are three indexed terms connected by OR.
danielk19771d461462009-04-21 09:02:45 +00004762 ** The top of the loop looks like this:
drh111a6a72008-12-21 03:51:16 +00004763 **
drh1b26c7c2009-04-22 02:15:47 +00004764 ** Null 1 # Zero the rowset in reg 1
drh111a6a72008-12-21 03:51:16 +00004765 **
danielk19771d461462009-04-21 09:02:45 +00004766 ** Then, for each indexed term, the following. The arguments to
drh1b26c7c2009-04-22 02:15:47 +00004767 ** RowSetTest are such that the rowid of the current row is inserted
4768 ** into the RowSet. If it is already present, control skips the
danielk19771d461462009-04-21 09:02:45 +00004769 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
drh111a6a72008-12-21 03:51:16 +00004770 **
danielk19771d461462009-04-21 09:02:45 +00004771 ** sqlite3WhereBegin(<term>)
drh1b26c7c2009-04-22 02:15:47 +00004772 ** RowSetTest # Insert rowid into rowset
danielk19771d461462009-04-21 09:02:45 +00004773 ** Gosub 2 A
4774 ** sqlite3WhereEnd()
4775 **
4776 ** Following the above, code to terminate the loop. Label A, the target
4777 ** of the Gosub above, jumps to the instruction right after the Goto.
4778 **
drh1b26c7c2009-04-22 02:15:47 +00004779 ** Null 1 # Zero the rowset in reg 1
danielk19771d461462009-04-21 09:02:45 +00004780 ** Goto B # The loop is finished.
4781 **
4782 ** A: <loop body> # Return data, whatever.
4783 **
4784 ** Return 2 # Jump back to the Gosub
4785 **
4786 ** B: <after the loop>
4787 **
drh111a6a72008-12-21 03:51:16 +00004788 */
drh111a6a72008-12-21 03:51:16 +00004789 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
drhc01a3c12009-12-16 22:10:49 +00004790 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
dan0efb72c2012-08-24 18:44:56 +00004791 Index *pCov = 0; /* Potential covering index (or NULL) */
4792 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
danielk19771d461462009-04-21 09:02:45 +00004793
4794 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
shane85095702009-06-15 16:27:08 +00004795 int regRowset = 0; /* Register for RowSet object */
4796 int regRowid = 0; /* Register holding rowid */
danielk19771d461462009-04-21 09:02:45 +00004797 int iLoopBody = sqlite3VdbeMakeLabel(v); /* Start of loop body */
4798 int iRetInit; /* Address of regReturn init */
drhc01a3c12009-12-16 22:10:49 +00004799 int untestedTerms = 0; /* Some terms not completely tested */
drh8871ef52011-10-07 13:33:10 +00004800 int ii; /* Loop counter */
4801 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
drh111a6a72008-12-21 03:51:16 +00004802
4803 pTerm = pLevel->plan.u.pTerm;
4804 assert( pTerm!=0 );
drh7a5bcc02013-01-16 17:08:58 +00004805 assert( pTerm->eOperator & WO_OR );
drh111a6a72008-12-21 03:51:16 +00004806 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
4807 pOrWc = &pTerm->u.pOrInfo->wc;
drhc01a3c12009-12-16 22:10:49 +00004808 pLevel->op = OP_Return;
4809 pLevel->p1 = regReturn;
drh23d04d52008-12-23 23:56:22 +00004810
danbfca6a42012-08-24 10:52:35 +00004811 /* Set up a new SrcList in pOrTab containing the table being scanned
drhc01a3c12009-12-16 22:10:49 +00004812 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
4813 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
4814 */
4815 if( pWInfo->nLevel>1 ){
4816 int nNotReady; /* The number of notReady tables */
4817 struct SrcList_item *origSrc; /* Original list of tables */
4818 nNotReady = pWInfo->nLevel - iLevel - 1;
4819 pOrTab = sqlite3StackAllocRaw(pParse->db,
4820 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
4821 if( pOrTab==0 ) return notReady;
shaneh46aae3c2009-12-31 19:06:23 +00004822 pOrTab->nAlloc = (i16)(nNotReady + 1);
4823 pOrTab->nSrc = pOrTab->nAlloc;
drhc01a3c12009-12-16 22:10:49 +00004824 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
4825 origSrc = pWInfo->pTabList->a;
4826 for(k=1; k<=nNotReady; k++){
4827 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
4828 }
4829 }else{
4830 pOrTab = pWInfo->pTabList;
4831 }
danielk19771d461462009-04-21 09:02:45 +00004832
drh1b26c7c2009-04-22 02:15:47 +00004833 /* Initialize the rowset register to contain NULL. An SQL NULL is
4834 ** equivalent to an empty rowset.
danielk19771d461462009-04-21 09:02:45 +00004835 **
4836 ** Also initialize regReturn to contain the address of the instruction
4837 ** immediately following the OP_Return at the bottom of the loop. This
4838 ** is required in a few obscure LEFT JOIN cases where control jumps
4839 ** over the top of the loop into the body of it. In this case the
4840 ** correct response for the end-of-loop code (the OP_Return) is to
4841 ** fall through to the next instruction, just as an OP_Next does if
4842 ** called on an uninitialized cursor.
4843 */
drh336a5302009-04-24 15:46:21 +00004844 if( (wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
4845 regRowset = ++pParse->nMem;
4846 regRowid = ++pParse->nMem;
4847 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
4848 }
danielk19771d461462009-04-21 09:02:45 +00004849 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
4850
drh8871ef52011-10-07 13:33:10 +00004851 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
4852 ** Then for every term xN, evaluate as the subexpression: xN AND z
4853 ** That way, terms in y that are factored into the disjunction will
4854 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
drh331b67c2012-03-09 22:02:08 +00004855 **
4856 ** Actually, each subexpression is converted to "xN AND w" where w is
4857 ** the "interesting" terms of z - terms that did not originate in the
4858 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
4859 ** indices.
drhb3129fa2013-05-09 14:20:11 +00004860 **
4861 ** This optimization also only applies if the (x1 OR x2 OR ...) term
4862 ** is not contained in the ON clause of a LEFT JOIN.
4863 ** See ticket http://www.sqlite.org/src/info/f2369304e4
drh8871ef52011-10-07 13:33:10 +00004864 */
4865 if( pWC->nTerm>1 ){
drh7a484802012-03-16 00:28:11 +00004866 int iTerm;
4867 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
4868 Expr *pExpr = pWC->a[iTerm].pExpr;
drh331b67c2012-03-09 22:02:08 +00004869 if( ExprHasProperty(pExpr, EP_FromJoin) ) continue;
drh7a484802012-03-16 00:28:11 +00004870 if( pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_ORINFO) ) continue;
4871 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drh331b67c2012-03-09 22:02:08 +00004872 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4873 pAndExpr = sqlite3ExprAnd(pParse->db, pAndExpr, pExpr);
4874 }
4875 if( pAndExpr ){
4876 pAndExpr = sqlite3PExpr(pParse, TK_AND, 0, pAndExpr, 0);
4877 }
drh8871ef52011-10-07 13:33:10 +00004878 }
4879
danielk19771d461462009-04-21 09:02:45 +00004880 for(ii=0; ii<pOrWc->nTerm; ii++){
4881 WhereTerm *pOrTerm = &pOrWc->a[ii];
drh7a5bcc02013-01-16 17:08:58 +00004882 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
danielk19771d461462009-04-21 09:02:45 +00004883 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
drh8871ef52011-10-07 13:33:10 +00004884 Expr *pOrExpr = pOrTerm->pExpr;
drhb3129fa2013-05-09 14:20:11 +00004885 if( pAndExpr && !ExprHasProperty(pOrExpr, EP_FromJoin) ){
drh8871ef52011-10-07 13:33:10 +00004886 pAndExpr->pLeft = pOrExpr;
4887 pOrExpr = pAndExpr;
4888 }
danielk19771d461462009-04-21 09:02:45 +00004889 /* Loop through table entries that match term pOrTerm. */
drh8871ef52011-10-07 13:33:10 +00004890 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
drh9ef61f42011-10-07 14:40:59 +00004891 WHERE_OMIT_OPEN_CLOSE | WHERE_AND_ONLY |
dan0efb72c2012-08-24 18:44:56 +00004892 WHERE_FORCE_TABLE | WHERE_ONETABLE_ONLY, iCovCur);
danbfca6a42012-08-24 10:52:35 +00004893 assert( pSubWInfo || pParse->nErr || pParse->db->mallocFailed );
danielk19771d461462009-04-21 09:02:45 +00004894 if( pSubWInfo ){
danbfca6a42012-08-24 10:52:35 +00004895 WhereLevel *pLvl;
dan17c0bc02010-11-09 17:35:19 +00004896 explainOneScan(
dan4a07e3d2010-11-09 14:48:59 +00004897 pParse, pOrTab, &pSubWInfo->a[0], iLevel, pLevel->iFrom, 0
dan2ce22452010-11-08 19:01:16 +00004898 );
drh336a5302009-04-24 15:46:21 +00004899 if( (wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
4900 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
4901 int r;
4902 r = sqlite3ExprCodeGetColumn(pParse, pTabItem->pTab, -1, iCur,
drha748fdc2012-03-28 01:34:47 +00004903 regRowid, 0);
drh8cff69d2009-11-12 19:59:44 +00004904 sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset,
4905 sqlite3VdbeCurrentAddr(v)+2, r, iSet);
drh336a5302009-04-24 15:46:21 +00004906 }
danielk19771d461462009-04-21 09:02:45 +00004907 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
4908
drhc01a3c12009-12-16 22:10:49 +00004909 /* The pSubWInfo->untestedTerms flag means that this OR term
4910 ** contained one or more AND term from a notReady table. The
4911 ** terms from the notReady table could not be tested and will
4912 ** need to be tested later.
4913 */
4914 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
4915
danbfca6a42012-08-24 10:52:35 +00004916 /* If all of the OR-connected terms are optimized using the same
4917 ** index, and the index is opened using the same cursor number
4918 ** by each call to sqlite3WhereBegin() made by this loop, it may
4919 ** be possible to use that index as a covering index.
4920 **
4921 ** If the call to sqlite3WhereBegin() above resulted in a scan that
4922 ** uses an index, and this is either the first OR-connected term
4923 ** processed or the index is the same as that used by all previous
dan0efb72c2012-08-24 18:44:56 +00004924 ** terms, set pCov to the candidate covering index. Otherwise, set
4925 ** pCov to NULL to indicate that no candidate covering index will
4926 ** be available.
danbfca6a42012-08-24 10:52:35 +00004927 */
4928 pLvl = &pSubWInfo->a[0];
4929 if( (pLvl->plan.wsFlags & WHERE_INDEXED)!=0
4930 && (pLvl->plan.wsFlags & WHERE_TEMP_INDEX)==0
dan0efb72c2012-08-24 18:44:56 +00004931 && (ii==0 || pLvl->plan.u.pIdx==pCov)
danbfca6a42012-08-24 10:52:35 +00004932 ){
dan0efb72c2012-08-24 18:44:56 +00004933 assert( pLvl->iIdxCur==iCovCur );
danbfca6a42012-08-24 10:52:35 +00004934 pCov = pLvl->plan.u.pIdx;
danbfca6a42012-08-24 10:52:35 +00004935 }else{
4936 pCov = 0;
4937 }
4938
danielk19771d461462009-04-21 09:02:45 +00004939 /* Finish the loop through table entries that match term pOrTerm. */
4940 sqlite3WhereEnd(pSubWInfo);
4941 }
drhdd5f5a62008-12-23 13:35:23 +00004942 }
4943 }
drhd40e2082012-08-24 23:24:15 +00004944 pLevel->u.pCovidx = pCov;
drh90abfd02012-10-09 21:07:23 +00004945 if( pCov ) pLevel->iIdxCur = iCovCur;
drh331b67c2012-03-09 22:02:08 +00004946 if( pAndExpr ){
4947 pAndExpr->pLeft = 0;
4948 sqlite3ExprDelete(pParse->db, pAndExpr);
4949 }
danielk19771d461462009-04-21 09:02:45 +00004950 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
danielk19771d461462009-04-21 09:02:45 +00004951 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrBrk);
4952 sqlite3VdbeResolveLabel(v, iLoopBody);
4953
drhc01a3c12009-12-16 22:10:49 +00004954 if( pWInfo->nLevel>1 ) sqlite3StackFree(pParse->db, pOrTab);
4955 if( !untestedTerms ) disableTerm(pLevel, pTerm);
drhdd5f5a62008-12-23 13:35:23 +00004956 }else
drh23d04d52008-12-23 23:56:22 +00004957#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00004958
4959 {
drh111a6a72008-12-21 03:51:16 +00004960 /* Case 5: There is no usable index. We must do a complete
4961 ** scan of the entire table.
4962 */
drh699b3d42009-02-23 16:52:07 +00004963 static const u8 aStep[] = { OP_Next, OP_Prev };
4964 static const u8 aStart[] = { OP_Rewind, OP_Last };
4965 assert( bRev==0 || bRev==1 );
drh111a6a72008-12-21 03:51:16 +00004966 assert( omitTable==0 );
drh699b3d42009-02-23 16:52:07 +00004967 pLevel->op = aStep[bRev];
drh111a6a72008-12-21 03:51:16 +00004968 pLevel->p1 = iCur;
drh699b3d42009-02-23 16:52:07 +00004969 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrBrk);
drh111a6a72008-12-21 03:51:16 +00004970 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4971 }
drh0c41d222013-04-22 02:39:10 +00004972 newNotReady = notReady & ~getMask(pWC->pMaskSet, iCur);
drh111a6a72008-12-21 03:51:16 +00004973
4974 /* Insert code to test every subexpression that can be completely
4975 ** computed using the current set of tables.
drhe9cdcea2010-07-22 22:40:03 +00004976 **
4977 ** IMPLEMENTATION-OF: R-49525-50935 Terms that cannot be satisfied through
4978 ** the use of indices become tests that are evaluated against each row of
4979 ** the relevant input tables.
drh111a6a72008-12-21 03:51:16 +00004980 */
drh111a6a72008-12-21 03:51:16 +00004981 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
4982 Expr *pE;
drhe9cdcea2010-07-22 22:40:03 +00004983 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* IMP: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004984 testcase( pTerm->wtFlags & TERM_CODED );
4985 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drh0c41d222013-04-22 02:39:10 +00004986 if( (pTerm->prereqAll & newNotReady)!=0 ){
drhc01a3c12009-12-16 22:10:49 +00004987 testcase( pWInfo->untestedTerms==0
4988 && (pWInfo->wctrlFlags & WHERE_ONETABLE_ONLY)!=0 );
4989 pWInfo->untestedTerms = 1;
4990 continue;
4991 }
drh111a6a72008-12-21 03:51:16 +00004992 pE = pTerm->pExpr;
4993 assert( pE!=0 );
4994 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
4995 continue;
4996 }
drh111a6a72008-12-21 03:51:16 +00004997 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00004998 pTerm->wtFlags |= TERM_CODED;
4999 }
5000
drh0c41d222013-04-22 02:39:10 +00005001 /* Insert code to test for implied constraints based on transitivity
5002 ** of the "==" operator.
5003 **
5004 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
5005 ** and we are coding the t1 loop and the t2 loop has not yet coded,
5006 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
5007 ** the implied "t1.a=123" constraint.
5008 */
5009 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
5010 Expr *pE;
5011 WhereTerm *pAlt;
5012 Expr sEq;
5013 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
5014 if( pTerm->eOperator!=(WO_EQUIV|WO_EQ) ) continue;
5015 if( pTerm->leftCursor!=iCur ) continue;
5016 pE = pTerm->pExpr;
5017 assert( !ExprHasProperty(pE, EP_FromJoin) );
5018 assert( (pTerm->prereqRight & newNotReady)!=0 );
5019 pAlt = findTerm(pWC, iCur, pTerm->u.leftColumn, notReady, WO_EQ|WO_IN, 0);
5020 if( pAlt==0 ) continue;
drh5c10f3b2013-05-01 17:22:38 +00005021 if( pAlt->wtFlags & (TERM_CODED) ) continue;
drh0c41d222013-04-22 02:39:10 +00005022 VdbeNoopComment((v, "begin transitive constraint"));
5023 sEq = *pAlt->pExpr;
5024 sEq.pLeft = pE->pLeft;
5025 sqlite3ExprIfFalse(pParse, &sEq, addrCont, SQLITE_JUMPIFNULL);
5026 }
5027
drh111a6a72008-12-21 03:51:16 +00005028 /* For a LEFT OUTER JOIN, generate code that will record the fact that
5029 ** at least one row of the right table has matched the left table.
5030 */
5031 if( pLevel->iLeftJoin ){
5032 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
5033 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
5034 VdbeComment((v, "record LEFT JOIN hit"));
drhceea3322009-04-23 13:22:42 +00005035 sqlite3ExprCacheClear(pParse);
drh111a6a72008-12-21 03:51:16 +00005036 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
drhe9cdcea2010-07-22 22:40:03 +00005037 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* IMP: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00005038 testcase( pTerm->wtFlags & TERM_CODED );
5039 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drh0c41d222013-04-22 02:39:10 +00005040 if( (pTerm->prereqAll & newNotReady)!=0 ){
drhb057e562009-12-16 23:43:55 +00005041 assert( pWInfo->untestedTerms );
drhc01a3c12009-12-16 22:10:49 +00005042 continue;
5043 }
drh111a6a72008-12-21 03:51:16 +00005044 assert( pTerm->pExpr );
5045 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
5046 pTerm->wtFlags |= TERM_CODED;
5047 }
5048 }
danielk19771d461462009-04-21 09:02:45 +00005049 sqlite3ReleaseTempReg(pParse, iReleaseReg);
drh23d04d52008-12-23 23:56:22 +00005050
drh0c41d222013-04-22 02:39:10 +00005051 return newNotReady;
drh111a6a72008-12-21 03:51:16 +00005052}
5053
drh549c8b62005-09-19 13:15:23 +00005054#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00005055/*
5056** The following variable holds a text description of query plan generated
5057** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
5058** overwrites the previous. This information is used for testing and
5059** analysis only.
5060*/
5061char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
5062static int nQPlan = 0; /* Next free slow in _query_plan[] */
5063
5064#endif /* SQLITE_TEST */
5065
drha18f3d22013-05-08 03:05:41 +00005066#if defined(SQLITE_DEBUG) \
5067 && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE))
5068/*
5069** Print a WhereLoop object for debugging purposes
5070*/
5071static void whereLoopPrint(WhereLoop *p, SrcList *pTabList){
5072 int nb = 2*((pTabList->nSrc+15)/16);
5073 struct SrcList_item *pItem = pTabList->a + p->iTab;
5074 Table *pTab = pItem->pTab;
drha184fb82013-05-08 04:22:59 +00005075 sqlite3DebugPrintf("%2d.%0*llx.%0*llx",
5076 p->iTab, nb, p->maskSelf, nb, p->prereq);
5077 sqlite3DebugPrintf(" %8s",
drha18f3d22013-05-08 03:05:41 +00005078 pItem->zAlias ? pItem->zAlias : pTab->zName);
drh5346e952013-05-08 14:14:26 +00005079 if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
5080 if( p->u.btree.pIndex ){
5081 sqlite3DebugPrintf(".%-12s %2d",
5082 p->u.btree.pIndex->zName, p->u.btree.nEq);
5083 }else{
5084 sqlite3DebugPrintf("%16s","");
5085 }
drha18f3d22013-05-08 03:05:41 +00005086 }else{
drh5346e952013-05-08 14:14:26 +00005087 char *z;
5088 if( p->u.vtab.idxStr ){
5089 z = sqlite3_mprintf("(%d,\"%s\")", p->u.vtab.idxNum,p->u.vtab.idxStr);
5090 }else{
5091 z = sqlite3_mprintf("(%d)", p->u.vtab.idxNum);
5092 }
5093 sqlite3DebugPrintf(" %-15s", z);
5094 sqlite3_free(z);
drha18f3d22013-05-08 03:05:41 +00005095 }
drh6b7157b2013-05-10 02:00:35 +00005096 sqlite3DebugPrintf(" fg %08x N %2d", p->wsFlags, p->nTerm);
drha18f3d22013-05-08 03:05:41 +00005097 sqlite3DebugPrintf(" cost %.4g,%.4g,%.4g\n",
5098 p->prereq, p->rSetup, p->rRun, p->nOut);
5099}
5100#endif
5101
drhf1b5f5b2013-05-02 00:15:01 +00005102/*
drh5346e952013-05-08 14:14:26 +00005103** Deallocate internal memory used by a WhereLoop object
5104*/
5105static void whereLoopClear(sqlite3 *db, WhereLoop *p){
5106 sqlite3DbFree(db, p->aTerm);
5107 p->aTerm = 0;
5108 p->nTerm = 0;
5109 if( (p->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
5110 if( p->u.vtab.needFree ) sqlite3_free(p->u.vtab.idxStr);
5111 p->u.vtab.needFree = 0;
5112 p->u.vtab.idxStr = 0;
5113 }
5114}
5115
5116/*
drhf1b5f5b2013-05-02 00:15:01 +00005117** Delete a WhereLoop object
5118*/
5119static void whereLoopDelete(sqlite3 *db, WhereLoop *p){
drh5346e952013-05-08 14:14:26 +00005120 whereLoopClear(db, p);
drhf1b5f5b2013-05-02 00:15:01 +00005121 sqlite3DbFree(db, p);
5122}
drh84bfda42005-07-15 13:05:21 +00005123
drh9eff6162006-06-12 21:59:13 +00005124/*
5125** Free a WhereInfo structure
5126*/
drh10fe8402008-10-11 16:47:35 +00005127static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh52ff8ea2010-04-08 14:15:56 +00005128 if( ALWAYS(pWInfo) ){
drh9eff6162006-06-12 21:59:13 +00005129 int i;
5130 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00005131 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
5132 if( pInfo ){
danielk19771d461462009-04-21 09:02:45 +00005133 /* assert( pInfo->needToFreeIdxStr==0 || db->mallocFailed ); */
danielk197780442942008-12-24 11:25:39 +00005134 if( pInfo->needToFreeIdxStr ){
5135 sqlite3_free(pInfo->idxStr);
danielk1977be229652009-03-20 14:18:51 +00005136 }
drh633e6d52008-07-28 19:34:53 +00005137 sqlite3DbFree(db, pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00005138 }
drh8b307fb2010-04-06 15:57:05 +00005139 if( pWInfo->a[i].plan.wsFlags & WHERE_TEMP_INDEX ){
drha21a64d2010-04-06 22:33:55 +00005140 Index *pIdx = pWInfo->a[i].plan.u.pIdx;
5141 if( pIdx ){
5142 sqlite3DbFree(db, pIdx->zColAff);
5143 sqlite3DbFree(db, pIdx);
5144 }
drh8b307fb2010-04-06 15:57:05 +00005145 }
drh9eff6162006-06-12 21:59:13 +00005146 }
drh111a6a72008-12-21 03:51:16 +00005147 whereClauseClear(pWInfo->pWC);
drhf1b5f5b2013-05-02 00:15:01 +00005148 while( pWInfo->pLoops ){
5149 WhereLoop *p = pWInfo->pLoops;
5150 pWInfo->pLoops = p->pNextLoop;
5151 whereLoopDelete(db, p);
5152 }
drh633e6d52008-07-28 19:34:53 +00005153 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00005154 }
5155}
5156
drhf1b5f5b2013-05-02 00:15:01 +00005157/*
5158** Insert or replace a WhereLoop entry using the template supplied.
5159**
5160** An existing WhereLoop entry might be overwritten if the new template
5161** is better and has fewer dependencies. Or the template will be ignored
5162** and no insert will occur if an existing WhereLoop is faster and has
5163** fewer dependencies than the template. Otherwise a new WhereLoop is
5164** added based no the template.
5165*/
drhcf8fa7a2013-05-10 20:26:22 +00005166static int whereLoopInsert(WhereLoopBuilder *pBuilder, WhereLoop *pTemplate){
drh43fe25f2013-05-07 23:06:23 +00005167 WhereLoop **ppPrev, *p, *pNext = 0, *pToFree = 0;
drha18f3d22013-05-08 03:05:41 +00005168 WhereTerm **paTerm = 0;
drhcf8fa7a2013-05-10 20:26:22 +00005169 sqlite3 *db = pBuilder->db;
5170 WhereInfo *pWInfo = pBuilder->pWInfo;
5171
5172 if( (p = pBuilder->pBest)!=0 ){
5173 if( p->maskSelf!=0 ){
5174 if( p->rRun+p->rSetup < pTemplate->rRun+pTemplate->rSetup ){
5175 return SQLITE_OK;
5176 }
5177 if( p->rRun+p->rSetup == pTemplate->rRun+pTemplate->rSetup
5178 && p->prereq <= pTemplate->prereq ){
5179 return SQLITE_OK;
5180 }
5181 }
5182 *p = *pTemplate;
5183 p->aTerm = 0;
5184 p->u.vtab.needFree = 0;
5185 return SQLITE_OK;
5186 }
drhf1b5f5b2013-05-02 00:15:01 +00005187
5188 /* Search for an existing WhereLoop to overwrite, or which takes
5189 ** priority over pTemplate.
5190 */
5191 for(ppPrev=&pWInfo->pLoops, p=*ppPrev; p; ppPrev=&p->pNextLoop, p=*ppPrev){
5192 if( p->iTab!=pTemplate->iTab ) continue;
5193 if( (p->prereq & pTemplate->prereq)==p->prereq
drhf1b5f5b2013-05-02 00:15:01 +00005194 && p->rSetup<=pTemplate->rSetup
5195 && p->rRun<=pTemplate->rRun
5196 ){
5197 /* Already holding an equal or better WhereLoop.
5198 ** Return without changing or adding anything */
5199 return SQLITE_OK;
5200 }
5201 if( (p->prereq & pTemplate->prereq)==pTemplate->prereq
drhf1b5f5b2013-05-02 00:15:01 +00005202 && p->rSetup>=pTemplate->rSetup
5203 && p->rRun>=pTemplate->rRun
5204 ){
5205 /* Overwrite an existing WhereLoop with a better one */
drh43fe25f2013-05-07 23:06:23 +00005206 pNext = p->pNextLoop;
drh5346e952013-05-08 14:14:26 +00005207 whereLoopClear(db, p);
drhf1b5f5b2013-05-02 00:15:01 +00005208 break;
5209 }
5210 }
5211
5212 /* If we reach this point it means that either p[] should be overwritten
5213 ** with pTemplate[] if p[] exists, or if p==NULL then allocate a new
5214 ** WhereLoop and insert it.
5215 */
5216 if( p==0 ){
drh43fe25f2013-05-07 23:06:23 +00005217 p = pToFree = sqlite3DbMallocRaw(db, sizeof(WhereLoop));
drhf1b5f5b2013-05-02 00:15:01 +00005218 if( p==0 ) return SQLITE_NOMEM;
5219 }
drha18f3d22013-05-08 03:05:41 +00005220 if( pTemplate->nTerm ){
5221 paTerm = sqlite3DbMallocRaw(db, pTemplate->nTerm*sizeof(p->aTerm[0]));
5222 if( paTerm==0 ){
5223 sqlite3DbFree(db, pToFree);
5224 return SQLITE_NOMEM;
5225 }
5226 }
drhf1b5f5b2013-05-02 00:15:01 +00005227 *p = *pTemplate;
drh43fe25f2013-05-07 23:06:23 +00005228 p->pNextLoop = pNext;
5229 *ppPrev = p;
drha18f3d22013-05-08 03:05:41 +00005230 p->aTerm = paTerm;
drhcf8fa7a2013-05-10 20:26:22 +00005231 if( p->nTerm ){
5232 memcpy(p->aTerm, pTemplate->aTerm, p->nTerm*sizeof(p->aTerm[0]));
drhf1b5f5b2013-05-02 00:15:01 +00005233 }
drh5346e952013-05-08 14:14:26 +00005234 if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
drhcf8fa7a2013-05-10 20:26:22 +00005235 if( p->u.btree.pIndex && p->u.btree.pIndex->tnum==0 ){
5236 p->u.btree.pIndex = 0;
5237 }
drh5346e952013-05-08 14:14:26 +00005238 }else{
5239 pTemplate->u.vtab.needFree = 0;
5240 }
drhf1b5f5b2013-05-02 00:15:01 +00005241 return SQLITE_OK;
5242}
5243
5244/*
drh5346e952013-05-08 14:14:26 +00005245** We have so far matched pBuilder->pNew->u.btree.nEq terms of the index pIndex.
drh1c8148f2013-05-04 20:25:23 +00005246** Try to match one more.
5247**
5248** If pProbe->tnum==0, that means pIndex is a fake index used for the
5249** INTEGER PRIMARY KEY.
5250*/
drh5346e952013-05-08 14:14:26 +00005251static int whereLoopAddBtreeIndex(
drh1c8148f2013-05-04 20:25:23 +00005252 WhereLoopBuilder *pBuilder, /* The WhereLoop factory */
5253 struct SrcList_item *pSrc, /* FROM clause term being analyzed */
5254 Index *pProbe, /* An index on pSrc */
5255 int nInMul /* Number of iterations due to IN */
5256){
5257 sqlite3 *db; /* Database connection malloc context */
5258 WhereLoop *pNew; /* Template WhereLoop under construction */
5259 WhereTerm *pTerm; /* A WhereTerm under consideration */
drh43fe25f2013-05-07 23:06:23 +00005260 int opMask; /* Valid operators for constraints */
drh1c8148f2013-05-04 20:25:23 +00005261 WhereScan scan; /* Iterator for WHERE terms */
drh43fe25f2013-05-07 23:06:23 +00005262 WhereLoop savedLoop; /* Saved original content of pNew[] */
drha18f3d22013-05-08 03:05:41 +00005263 int iCol; /* Index of the column in the table */
drh5346e952013-05-08 14:14:26 +00005264 int rc = SQLITE_OK; /* Return code */
drheb04de32013-05-10 15:16:30 +00005265 double rLogSize; /* Logarithm of table size */
drh1c8148f2013-05-04 20:25:23 +00005266
5267 db = pBuilder->db;
5268 pNew = pBuilder->pNew;
drh5346e952013-05-08 14:14:26 +00005269 if( db->mallocFailed ) return SQLITE_NOMEM;
drh1c8148f2013-05-04 20:25:23 +00005270
drh5346e952013-05-08 14:14:26 +00005271 assert( (pNew->wsFlags & WHERE_VIRTUALTABLE)==0 );
5272 assert( pNew->u.btree.nEq<pProbe->nColumn );
drh43fe25f2013-05-07 23:06:23 +00005273 assert( (pNew->wsFlags & WHERE_TOP_LIMIT)==0 );
5274 if( pNew->wsFlags & WHERE_BTM_LIMIT ){
5275 opMask = WO_LT|WO_LE;
5276 }else if( pProbe->tnum<=0 || (pSrc->jointype & JT_LEFT)!=0 ){
5277 opMask = WO_EQ|WO_IN|WO_GT|WO_GE|WO_LT|WO_LE;
drh1c8148f2013-05-04 20:25:23 +00005278 }else{
drh43fe25f2013-05-07 23:06:23 +00005279 opMask = WO_EQ|WO_IN|WO_ISNULL|WO_GT|WO_GE|WO_LT|WO_LE;
drh1c8148f2013-05-04 20:25:23 +00005280 }
5281
drh5346e952013-05-08 14:14:26 +00005282 iCol = pProbe->aiColumn[pNew->u.btree.nEq];
drha18f3d22013-05-08 03:05:41 +00005283 pTerm = whereScanInit(&scan, pBuilder->pWC, pSrc->iCursor, iCol,
5284 opMask, iCol>=0 ? pProbe : 0);
5285 savedLoop = *pNew;
5286 pNew->rSetup = (double)0;
drheb04de32013-05-10 15:16:30 +00005287 rLogSize = estLog(pProbe->aiRowEst[0]);
drh5346e952013-05-08 14:14:26 +00005288 for(; rc==SQLITE_OK && pTerm!=0; pTerm = whereScanNext(&scan)){
drha18f3d22013-05-08 03:05:41 +00005289 int nIn = 1;
drh5346e952013-05-08 14:14:26 +00005290 pNew->u.btree.nEq = savedLoop.u.btree.nEq;
drha18f3d22013-05-08 03:05:41 +00005291 pNew->nTerm = savedLoop.nTerm;
drheb04de32013-05-10 15:16:30 +00005292 if( pNew->nTerm>=pBuilder->mxTerm ) break; /* Repeated column in index */
drha18f3d22013-05-08 03:05:41 +00005293 pNew->aTerm[pNew->nTerm++] = pTerm;
5294 pNew->prereq = (savedLoop.prereq | pTerm->prereqRight) & ~pNew->maskSelf;
5295 if( pTerm->eOperator & WO_IN ){
5296 Expr *pExpr = pTerm->pExpr;
5297 pNew->wsFlags |= WHERE_COLUMN_IN;
5298 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
5299 /* "x IN (SELECT ...)": Assume the SELECT returns 25 rows */
5300 nIn = 25;
5301 }else if( ALWAYS(pExpr->x.pList && pExpr->x.pList->nExpr) ){
5302 /* "x IN (value, value, ...)" */
5303 nIn = pExpr->x.pList->nExpr;
drhf1645f02013-05-07 19:44:38 +00005304 }
drh5346e952013-05-08 14:14:26 +00005305 pNew->u.btree.nEq++;
5306 pNew->nOut = (double)pProbe->aiRowEst[pNew->u.btree.nEq] * nInMul * nIn;
drha18f3d22013-05-08 03:05:41 +00005307 }else if( pTerm->eOperator & (WO_EQ|WO_ISNULL) ){
5308 pNew->wsFlags |= WHERE_COLUMN_EQ;
drh5346e952013-05-08 14:14:26 +00005309 pNew->u.btree.nEq++;
5310 pNew->nOut = (double)pProbe->aiRowEst[pNew->u.btree.nEq] * nInMul;
drha18f3d22013-05-08 03:05:41 +00005311 }else if( pTerm->eOperator & (WO_GT|WO_GE) ){
5312 pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_BTM_LIMIT;
5313 pNew->nOut = savedLoop.nOut/3;
5314 }else if( pTerm->eOperator & (WO_LT|WO_LE) ){
5315 pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_TOP_LIMIT;
5316 pNew->nOut = savedLoop.nOut/3;
drh1c8148f2013-05-04 20:25:23 +00005317 }
drheb04de32013-05-10 15:16:30 +00005318 pNew->rRun = rLogSize*nIn; /* Cost for nIn binary searches */
5319 if( pNew->wsFlags & (WHERE_IDX_ONLY|WHERE_IPK) ){
5320 pNew->rRun += pNew->nOut; /* Unit step cost to reach each row */
5321 }else{
5322 /* Each row involves a step of the index, then a binary search of
5323 ** the main table */
5324 pNew->rRun += pNew->nOut*(1 + rLogSize);
5325 }
5326 /* TBD: Adjust nOut and rRun for STAT3 range values */
5327 /* TBD: Adjust nOut for additional constraints */
drhcf8fa7a2013-05-10 20:26:22 +00005328 rc = whereLoopInsert(pBuilder, pNew);
drh5346e952013-05-08 14:14:26 +00005329 if( (pNew->wsFlags & WHERE_TOP_LIMIT)==0
5330 && pNew->u.btree.nEq<pProbe->nColumn
5331 ){
drha18f3d22013-05-08 03:05:41 +00005332 whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, nInMul*nIn);
5333 }
drh1c8148f2013-05-04 20:25:23 +00005334 }
drha18f3d22013-05-08 03:05:41 +00005335 *pNew = savedLoop;
drh5346e952013-05-08 14:14:26 +00005336 return rc;
drh1c8148f2013-05-04 20:25:23 +00005337}
5338
5339/*
drhf1b5f5b2013-05-02 00:15:01 +00005340** Add all WhereLoop objects for the iTab-th table of the join. That
5341** table is guaranteed to be a b-tree table, not a virtual table.
5342*/
drh5346e952013-05-08 14:14:26 +00005343static int whereLoopAddBtree(
drh1c8148f2013-05-04 20:25:23 +00005344 WhereLoopBuilder *pBuilder, /* WHERE clause information */
drh1c8148f2013-05-04 20:25:23 +00005345 Bitmask mExtra /* Extra prerequesites for using this table */
drhf1b5f5b2013-05-02 00:15:01 +00005346){
drh1c8148f2013-05-04 20:25:23 +00005347 Index *pProbe; /* An index we are evaluating */
drh1c8148f2013-05-04 20:25:23 +00005348 Index sPk; /* A fake index object for the primary key */
5349 tRowcnt aiRowEstPk[2]; /* The aiRowEst[] value for the sPk index */
5350 int aiColumnPk = -1; /* The aColumn[] value for the sPk index */
5351 struct SrcList_item *pSrc; /* The FROM clause btree term to add */
drh1c8148f2013-05-04 20:25:23 +00005352 WhereLoop *pNew; /* Template WhereLoop object */
drh5346e952013-05-08 14:14:26 +00005353 int rc = SQLITE_OK; /* Return code */
drheb04de32013-05-10 15:16:30 +00005354 double rSize; /* number of rows in the table */
5355 double rLogSize; /* Logarithm of the number of rows in the table */
drhf1b5f5b2013-05-02 00:15:01 +00005356
drh1c8148f2013-05-04 20:25:23 +00005357 pNew = pBuilder->pNew;
drhb2a90f02013-05-10 03:30:49 +00005358 pSrc = pBuilder->pTabList->a + pNew->iTab;
drh1c8148f2013-05-04 20:25:23 +00005359
5360 if( pSrc->pIndex ){
5361 /* An INDEXED BY clause specifies a particular index to use */
5362 pProbe = pSrc->pIndex;
5363 }else{
5364 /* There is no INDEXED BY clause. Create a fake Index object in local
5365 ** variable sPk to represent the rowid primary key index. Make this
5366 ** fake index the first in a chain of Index objects with all of the real
5367 ** indices to follow */
5368 Index *pFirst; /* First of real indices on the table */
5369 memset(&sPk, 0, sizeof(Index));
5370 sPk.nColumn = 1;
5371 sPk.aiColumn = &aiColumnPk;
5372 sPk.aiRowEst = aiRowEstPk;
5373 sPk.onError = OE_Replace;
5374 sPk.pTable = pSrc->pTab;
5375 aiRowEstPk[0] = pSrc->pTab->nRowEst;
5376 aiRowEstPk[1] = 1;
5377 pFirst = pSrc->pTab->pIndex;
5378 if( pSrc->notIndexed==0 ){
5379 /* The real indices of the table are only considered if the
5380 ** NOT INDEXED qualifier is omitted from the FROM clause */
5381 sPk.pNext = pFirst;
5382 }
5383 pProbe = &sPk;
5384 }
drheb04de32013-05-10 15:16:30 +00005385 rSize = (double)pSrc->pTab->nRowEst;
5386 rLogSize = estLog(rSize);
5387
5388 /* Automatic indexes */
drhcf8fa7a2013-05-10 20:26:22 +00005389 if( !pBuilder->pBest
5390 && (pBuilder->pParse->db->flags & SQLITE_AutoIndex)!=0
drheb04de32013-05-10 15:16:30 +00005391 && !pSrc->viaCoroutine
5392 && !pSrc->notIndexed
5393 && !pSrc->isCorrelated
5394 ){
5395 /* Generate auto-index WhereLoops */
5396 WhereClause *pWC = pBuilder->pWC;
5397 WhereTerm *pTerm;
5398 WhereTerm *pWCEnd = pWC->a + pWC->nTerm;
5399 for(pTerm=pWC->a; rc==SQLITE_OK && pTerm<pWCEnd; pTerm++){
5400 if( termCanDriveIndex(pTerm, pSrc, 0) ){
5401 pNew->u.btree.nEq = 1;
5402 pNew->nTerm = 1;
5403 pNew->aTerm[0] = pTerm;
5404 pNew->rSetup = 2*rLogSize*pSrc->pTab->nRowEst;
5405 pNew->nOut = (double)10;
5406 pNew->rRun = rLogSize + pNew->nOut;
5407 pNew->wsFlags = WHERE_TEMP_INDEX;
5408 pNew->prereq = mExtra | pTerm->prereqRight;
drhcf8fa7a2013-05-10 20:26:22 +00005409 rc = whereLoopInsert(pBuilder, pNew);
drheb04de32013-05-10 15:16:30 +00005410 }
5411 }
5412 }
drh1c8148f2013-05-04 20:25:23 +00005413
drh43fe25f2013-05-07 23:06:23 +00005414 /* Insert a full table scan */
drh5346e952013-05-08 14:14:26 +00005415 pNew->u.btree.nEq = 0;
drh43fe25f2013-05-07 23:06:23 +00005416 pNew->nTerm = 0;
5417 pNew->rSetup = (double)0;
drhb2a90f02013-05-10 03:30:49 +00005418 pNew->prereq = mExtra;
drh5346e952013-05-08 14:14:26 +00005419 pNew->u.btree.pIndex = 0;
drh43fe25f2013-05-07 23:06:23 +00005420 pNew->wsFlags = 0;
drheb04de32013-05-10 15:16:30 +00005421 pNew->nOut = rSize;
5422 pNew->rRun = rSize + rLogSize;
5423 /* TBD: Reduce nOut using constraints */
drhcf8fa7a2013-05-10 20:26:22 +00005424 rc = whereLoopInsert(pBuilder, pNew);
drh43fe25f2013-05-07 23:06:23 +00005425
drh1c8148f2013-05-04 20:25:23 +00005426 /* Loop over all indices
5427 */
drh5346e952013-05-08 14:14:26 +00005428 for(; rc==SQLITE_OK && pProbe; pProbe=pProbe->pNext){
drh5346e952013-05-08 14:14:26 +00005429 pNew->u.btree.nEq = 0;
drh1c8148f2013-05-04 20:25:23 +00005430 pNew->nTerm = 0;
drh43fe25f2013-05-07 23:06:23 +00005431 if( pProbe->tnum<=0 ){
5432 /* Integer primary key index */
5433 pNew->wsFlags = WHERE_IPK;
5434 }else{
5435 Bitmask m = pSrc->colUsed;
5436 int j;
5437 for(j=pProbe->nColumn-1; j>=0; j--){
5438 int x = pProbe->aiColumn[j];
5439 if( x<BMS-1 ){
5440 m &= ~(((Bitmask)1)<<x);
5441 }
5442 }
5443 pNew->wsFlags = m==0 ? WHERE_IDX_ONLY : 0;
5444 }
drh5346e952013-05-08 14:14:26 +00005445 pNew->u.btree.pIndex = pProbe;
drh1c8148f2013-05-04 20:25:23 +00005446
drh5346e952013-05-08 14:14:26 +00005447 rc = whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, 1);
drh1c8148f2013-05-04 20:25:23 +00005448
5449 /* If there was an INDEXED BY clause, then only that one index is
5450 ** considered. */
5451 if( pSrc->pIndex ) break;
5452 }
drh5346e952013-05-08 14:14:26 +00005453 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00005454}
5455
5456/*
5457** Add all WhereLoop objects for the iTab-th table of the join. That
5458** table is guaranteed to be a virtual table.
5459*/
drh5346e952013-05-08 14:14:26 +00005460static int whereLoopAddVirtual(
drh1c8148f2013-05-04 20:25:23 +00005461 WhereLoopBuilder *pBuilder, /* WHERE clause information */
drh1c8148f2013-05-04 20:25:23 +00005462 Bitmask mExtra /* Extra prerequesites for using this table */
drhf1b5f5b2013-05-02 00:15:01 +00005463){
drh5346e952013-05-08 14:14:26 +00005464 Parse *pParse; /* The parsing context */
5465 WhereClause *pWC; /* The WHERE clause */
5466 struct SrcList_item *pSrc; /* The FROM clause term to search */
5467 Table *pTab;
5468 sqlite3 *db;
5469 sqlite3_index_info *pIdxInfo;
5470 struct sqlite3_index_constraint *pIdxCons;
5471 struct sqlite3_index_constraint_usage *pUsage;
5472 WhereTerm *pTerm;
5473 int i, j;
5474 int iTerm, mxTerm;
5475 int seenIn = 0; /* True if an IN operator is seen */
5476 int seenVar = 0; /* True if a non-constant constraint is seen */
5477 int iPhase; /* 0: const w/o IN, 1: const, 2: no IN, 2: IN */
5478 WhereLoop *pNew;
drh5346e952013-05-08 14:14:26 +00005479 int rc = SQLITE_OK;
5480
5481 pParse = pBuilder->pParse;
5482 db = pParse->db;
5483 pWC = pBuilder->pWC;
drh5346e952013-05-08 14:14:26 +00005484 pNew = pBuilder->pNew;
drhb2a90f02013-05-10 03:30:49 +00005485 pSrc = &pBuilder->pTabList->a[pNew->iTab];
5486 pTab = pSrc->pTab;
5487 pIdxInfo = allocateIndexInfo(pParse, pWC, pSrc, pBuilder->pOrderBy);
drh5346e952013-05-08 14:14:26 +00005488 if( pIdxInfo==0 ) return SQLITE_NOMEM;
drh5346e952013-05-08 14:14:26 +00005489 pNew->prereq = 0;
drh5346e952013-05-08 14:14:26 +00005490 pNew->rSetup = 0;
5491 pNew->wsFlags = WHERE_VIRTUALTABLE;
5492 pNew->nTerm = 0;
5493 pNew->u.vtab.needFree = 0;
5494 pUsage = pIdxInfo->aConstraintUsage;
5495
5496 for(iPhase=0; iPhase<=2; iPhase++){
5497 if( !seenIn && (iPhase&1)!=0 ){
5498 iPhase++;
5499 if( iPhase>3 ) break;
5500 }
5501 if( !seenVar && iPhase>1 ) break;
5502 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
5503 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
5504 j = pIdxCons->iTermOffset;
5505 pTerm = &pWC->a[j];
5506 switch( iPhase ){
5507 case 0: /* Constants without IN operator */
5508 pIdxCons->usable = 0;
5509 if( (pTerm->eOperator & WO_IN)!=0 ){
5510 seenIn = 1;
5511 }else if( pTerm->prereqRight!=0 ){
5512 seenVar = 1;
5513 }else{
5514 pIdxCons->usable = 1;
5515 }
5516 break;
5517 case 1: /* Constants with IN operators */
5518 assert( seenIn );
5519 pIdxCons->usable = (pTerm->prereqRight==0);
5520 break;
5521 case 2: /* Variables without IN */
5522 assert( seenVar );
5523 pIdxCons->usable = (pTerm->eOperator & WO_IN)==0;
5524 break;
5525 default: /* Variables with IN */
5526 assert( seenVar && seenIn );
5527 pIdxCons->usable = 1;
5528 break;
5529 }
5530 }
5531 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
5532 if( pIdxInfo->needToFreeIdxStr ) sqlite3_free(pIdxInfo->idxStr);
5533 pIdxInfo->idxStr = 0;
5534 pIdxInfo->idxNum = 0;
5535 pIdxInfo->needToFreeIdxStr = 0;
5536 pIdxInfo->orderByConsumed = 0;
5537 /* ((double)2) In case of SQLITE_OMIT_FLOATING_POINT... */
5538 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / ((double)2);
5539 rc = vtabBestIndex(pParse, pTab, pIdxInfo);
5540 if( rc ) goto whereLoopAddVtab_exit;
5541 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
5542 pNew->prereq = 0;
drheb04de32013-05-10 15:16:30 +00005543 assert( pIdxInfo->nConstraint<=pBuilder->mxTerm );
drh5346e952013-05-08 14:14:26 +00005544 for(i=0; i<pIdxInfo->nConstraint; i++) pNew->aTerm[i] = 0;
drhc718f1c2013-05-08 20:05:58 +00005545 mxTerm = -1;
drh5346e952013-05-08 14:14:26 +00005546 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
5547 if( (iTerm = pUsage[i].argvIndex - 1)>=0 ){
5548 j = pIdxCons->iTermOffset;
5549 if( iTerm>=pIdxInfo->nConstraint
5550 || j<0
5551 || j>=pWC->nTerm
5552 || pNew->aTerm[iTerm]!=0
5553 ){
5554 rc = SQLITE_ERROR;
5555 sqlite3ErrorMsg(pParse, "%s.xBestIndex() malfunction", pTab->zName);
5556 goto whereLoopAddVtab_exit;
5557 }
5558 pTerm = &pWC->a[j];
5559 pNew->prereq |= pTerm->prereqRight;
5560 pNew->aTerm[iTerm] = pTerm;
5561 if( iTerm>mxTerm ) mxTerm = iTerm;
5562 if( (pTerm->eOperator & WO_IN)!=0 ){
5563 if( pUsage[i].omit==0 ){
5564 /* Do not attempt to use an IN constraint if the virtual table
5565 ** says that the equivalent EQ constraint cannot be safely omitted.
5566 ** If we do attempt to use such a constraint, some rows might be
5567 ** repeated in the output. */
5568 break;
5569 }
5570 /* A virtual table that is constrained by an IN clause may not
5571 ** consume the ORDER BY clause because (1) the order of IN terms
5572 ** is not necessarily related to the order of output terms and
5573 ** (2) Multiple outputs from a single IN value will not merge
5574 ** together. */
5575 pIdxInfo->orderByConsumed = 0;
5576 }
5577 }
5578 }
5579 if( i>=pIdxInfo->nConstraint ){
5580 pNew->nTerm = mxTerm+1;
5581 pNew->u.vtab.idxNum = pIdxInfo->idxNum;
5582 pNew->u.vtab.needFree = pIdxInfo->needToFreeIdxStr;
5583 pIdxInfo->needToFreeIdxStr = 0;
5584 pNew->u.vtab.idxStr = pIdxInfo->idxStr;
drh6b7157b2013-05-10 02:00:35 +00005585 pNew->u.vtab.isOrdered = (u8)(pIdxInfo->nOrderBy!=0);
drh5346e952013-05-08 14:14:26 +00005586 pNew->rSetup = (double)0;
5587 pNew->rRun = pIdxInfo->estimatedCost;
5588 pNew->nOut = (double)25;
drhcf8fa7a2013-05-10 20:26:22 +00005589 whereLoopInsert(pBuilder, pNew);
drh5346e952013-05-08 14:14:26 +00005590 if( pNew->u.vtab.needFree ){
5591 sqlite3_free(pNew->u.vtab.idxStr);
5592 pNew->u.vtab.needFree = 0;
5593 }
5594 }
5595 }
5596
5597whereLoopAddVtab_exit:
5598 if( pIdxInfo->needToFreeIdxStr ) sqlite3_free(pIdxInfo->idxStr);
5599 sqlite3DbFree(db, pIdxInfo);
5600 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00005601}
5602
5603/*
drhcf8fa7a2013-05-10 20:26:22 +00005604** Add WhereLoop entries to handle OR terms. This works for either
5605** btrees or virtual tables.
5606*/
5607static int whereLoopAddOr(WhereLoopBuilder *pBuilder, Bitmask mExtra){
5608 WhereClause *pWC;
5609 WhereLoop *pNew;
5610 WhereTerm *pTerm, *pWCEnd;
5611 int rc = SQLITE_OK;
5612 int iCur;
5613 WhereClause tempWC;
5614 WhereLoopBuilder sSubBuild;
5615 WhereLoop sBest;
5616 struct SrcList_item *pItem;
5617
5618
5619 pWC = pBuilder->pWC;
5620 if( pWC->wctrlFlags & WHERE_AND_ONLY ) return SQLITE_OK;
5621 pWCEnd = pWC->a + pWC->nTerm;
5622 pNew = pBuilder->pNew;
5623 pItem = pBuilder->pTabList->a + pNew->iTab;
5624 iCur = pItem->iCursor;
5625 sSubBuild = *pBuilder;
5626 sSubBuild.pOrderBy = 0;
5627 sSubBuild.pBest = &sBest;
5628 tempWC.pParse = pWC->pParse;
5629 tempWC.pMaskSet = pWC->pMaskSet;
5630 tempWC.pOuter = pWC;
5631 tempWC.op = TK_AND;
5632 tempWC.wctrlFlags = 0;
5633 tempWC.nTerm = 1;
5634
5635 for(pTerm=pWC->a; pTerm<pWCEnd && rc==SQLITE_OK; pTerm++){
5636 if( (pTerm->eOperator & WO_OR)!=0
5637 && (pTerm->u.pOrInfo->indexable & pNew->maskSelf)!=0
5638 ){
5639 WhereClause * const pOrWC = &pTerm->u.pOrInfo->wc;
5640 WhereTerm * const pOrWCEnd = &pOrWC->a[pOrWC->nTerm];
5641 WhereTerm *pOrTerm;
5642 double rTotal = 0;
5643 double nRow = 0;
5644 Bitmask prereq = mExtra;
5645
5646
5647 for(pOrTerm=pOrWC->a; pOrTerm<pOrWCEnd; pOrTerm++){
5648 if( (pOrTerm->eOperator& WO_AND)!=0 ){
5649 sSubBuild.pWC = &pOrTerm->u.pAndInfo->wc;
5650 }else if( pOrTerm->leftCursor==iCur ){
5651 tempWC.a = pOrTerm;
5652 sSubBuild.pWC = &tempWC;
5653 }else{
5654 continue;
5655 }
5656 sBest.maskSelf = 0;
5657 if( IsVirtual(pItem->pTab) ){
5658 rc = whereLoopAddVirtual(&sSubBuild, mExtra);
5659 }else{
5660 rc = whereLoopAddBtree(&sSubBuild, mExtra);
5661 }
5662 if( sBest.maskSelf==0 ) break;
5663 assert( sBest.rSetup==(double)0 );
5664 rTotal += sBest.rRun;
5665 nRow += sBest.nOut;
5666 prereq |= sBest.prereq;
5667 }
5668 pNew->nTerm = 1;
5669 pNew->aTerm[0] = pTerm;
5670 pNew->wsFlags = WHERE_MULTI_OR;
5671 pNew->rSetup = (double)0;
5672 pNew->rRun = rTotal;
5673 pNew->nOut = nRow;
5674 pNew->prereq = prereq;
5675 rc = whereLoopInsert(pBuilder, pNew);
5676 }
5677 }
5678 return rc;
5679}
5680
5681/*
drhf1b5f5b2013-05-02 00:15:01 +00005682** Add all WhereLoop objects for all tables
5683*/
drh5346e952013-05-08 14:14:26 +00005684static int whereLoopAddAll(WhereLoopBuilder *pBuilder){
drhf1b5f5b2013-05-02 00:15:01 +00005685 Bitmask mExtra = 0;
5686 Bitmask mPrior = 0;
5687 int iTab;
drh1c8148f2013-05-04 20:25:23 +00005688 SrcList *pTabList = pBuilder->pTabList;
drhf1b5f5b2013-05-02 00:15:01 +00005689 struct SrcList_item *pItem;
drh1c8148f2013-05-04 20:25:23 +00005690 WhereClause *pWC = pBuilder->pWC;
5691 sqlite3 *db = pBuilder->db;
drha18f3d22013-05-08 03:05:41 +00005692 int nTabList = pBuilder->pWInfo->nLevel;
drh5346e952013-05-08 14:14:26 +00005693 int rc = SQLITE_OK;
drhb2a90f02013-05-10 03:30:49 +00005694 WhereLoop *pNew;
drhf1b5f5b2013-05-02 00:15:01 +00005695
5696 /* Loop over the tables in the join, from left to right */
drhb2a90f02013-05-10 03:30:49 +00005697 pBuilder->pNew = pNew = sqlite3DbMallocZero(db, sizeof(WhereLoop));
5698 if( pNew==0 ) return SQLITE_NOMEM;
drheb04de32013-05-10 15:16:30 +00005699 pBuilder->mxTerm = pWC->nTerm+1;
5700 while( pWC->pOuter ){
5701 pWC = pWC->pOuter;
5702 pBuilder->mxTerm += pWC->nTerm;
5703 }
5704 pWC = pBuilder->pWC;
5705 pNew->aTerm = sqlite3DbMallocZero(db,pBuilder->mxTerm*sizeof(pNew->aTerm[0]));
drhb2a90f02013-05-10 03:30:49 +00005706 if( pNew->aTerm==0 ){
5707 rc = SQLITE_NOMEM;
5708 goto whereLoopAddAll_end;
5709 }
drha18f3d22013-05-08 03:05:41 +00005710 for(iTab=0, pItem=pTabList->a; iTab<nTabList; iTab++, pItem++){
drhb2a90f02013-05-10 03:30:49 +00005711 pNew->iTab = iTab;
5712 pNew->maskSelf = getMask(pWC->pMaskSet, pItem->iCursor);
drhf1b5f5b2013-05-02 00:15:01 +00005713 if( (pItem->jointype & (JT_LEFT|JT_CROSS))!=0 ){
5714 mExtra = mPrior;
5715 }
drhb2a90f02013-05-10 03:30:49 +00005716 if( IsVirtual(pItem->pTab) ){
5717 rc = whereLoopAddVirtual(pBuilder, mExtra);
5718 }else{
5719 rc = whereLoopAddBtree(pBuilder, mExtra);
5720 }
drhb2a90f02013-05-10 03:30:49 +00005721 if( rc==SQLITE_OK ){
5722 rc = whereLoopAddOr(pBuilder, mExtra);
5723 }
drhb2a90f02013-05-10 03:30:49 +00005724 mPrior |= pNew->maskSelf;
drh5346e952013-05-08 14:14:26 +00005725 if( rc || db->mallocFailed ) break;
drhf1b5f5b2013-05-02 00:15:01 +00005726 }
drhb2a90f02013-05-10 03:30:49 +00005727whereLoopAddAll_end:
drh1c8148f2013-05-04 20:25:23 +00005728 whereLoopDelete(db, pBuilder->pNew);
5729 pBuilder->pNew = 0;
drh5346e952013-05-08 14:14:26 +00005730 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00005731}
5732
drha18f3d22013-05-08 03:05:41 +00005733/*
drh6b7157b2013-05-10 02:00:35 +00005734** Examine a WherePath to see if it outputs rows in the requested ORDER BY
5735** (or GROUP BY) without requiring a separate source operation. Return 1
5736** if it does and 0 if it does not and -1 if we cannot tell.
5737*/
5738static int wherePathSatisfiesOrderBy(
5739 WhereInfo *pWInfo, /* The WHERE clause */
5740 WherePath *pPath, /* The WherePath to check */
5741 int nLoop, /* Number of entries in pPath->aLoop[] */
5742 WhereLoop *pLoop /* Add this WhereLoop to the end of pPath->aLoop[] */
5743){
5744 if( pLoop->wsFlags & WHERE_VIRTUALTABLE ){
5745 return nLoop==0 && pLoop->u.vtab.isOrdered;
5746 }else{
5747 /* TBD: Check to see if pFrom + pWLoop satisfies the ORDER BY.
5748 ** (1) If yes: set isOrderedValid and isOrdered to 1.
5749 ** (2) If no: set isOrderedValid to 1 and isOrdered to 0.
5750 ** (3) unknown: no-op */
5751 return 0;
5752 }
5753}
5754
5755
5756/*
drha18f3d22013-05-08 03:05:41 +00005757** Given the list of WhereLoop objects on pWInfo->pLoops, this routine
5758** attempts to find the lowest cost path that visits each WhereLoop
5759** once. This path is then loaded into the pWInfo->a[].pWLoop fields.
5760**
5761** Return SQLITE_OK on success or SQLITE_NOMEM of a memory allocation
5762** error occurs.
5763*/
5764static int wherePathSolver(WhereInfo *pWInfo){
5765 const int mxChoice = 10; /* Maximum number of simultaneous paths tracked */
5766 int nLoop; /* Number of terms in the join */
5767 sqlite3 *db; /* The database connection */
5768 int iLoop; /* Loop counter over the terms of the join */
5769 int ii, jj; /* Loop counters */
5770 double rCost; /* Cost of a path */
5771 double mxCost; /* Maximum cost of a set of paths */
drh6b7157b2013-05-10 02:00:35 +00005772 double rSortCost; /* Cost to do a sort */
drha18f3d22013-05-08 03:05:41 +00005773 int nTo, nFrom; /* Number of valid entries in aTo[] and aFrom[] */
5774 WherePath *aFrom; /* All nFrom paths at the previous level */
5775 WherePath *aTo; /* The nTo best paths at the current level */
5776 WherePath *pFrom; /* An element of aFrom[] that we are working on */
5777 WherePath *pTo; /* An element of aTo[] that we are working on */
5778 WhereLoop *pWLoop; /* One of the WhereLoop objects */
drh6b7157b2013-05-10 02:00:35 +00005779 WhereLoop *pNext; /* Next loop */
drha18f3d22013-05-08 03:05:41 +00005780 WhereLoop **pX; /* Used to divy up the pSpace memory */
5781 char *pSpace; /* Temporary memory used by this routine */
5782
5783 db = pWInfo->pParse->db;
5784 nLoop = pWInfo->nLevel;
5785 assert( nLoop<=pWInfo->pTabList->nSrc );
5786
5787 /* Allocate and initialize space for aTo and aFrom */
5788 ii = (sizeof(WherePath)+sizeof(WhereLoop*)*nLoop)*mxChoice*2;
5789 pSpace = sqlite3DbMallocRaw(db, ii);
5790 if( pSpace==0 ) return SQLITE_NOMEM;
5791 aTo = (WherePath*)pSpace;
5792 aFrom = aTo+mxChoice;
5793 memset(aFrom, 0, sizeof(aFrom[0]));
5794 pX = (WhereLoop**)(aFrom+mxChoice);
5795 for(ii=0, pFrom=aTo; ii<mxChoice*2; ii++, pFrom++, pX += nLoop){
5796 pFrom->aLoop = pX;
5797 }
5798
drh6b7157b2013-05-10 02:00:35 +00005799 /* Seed the search with a single WherePath containing zero WhereLoops */
drhf204dac2013-05-08 03:22:07 +00005800 aFrom[0].nRow = (double)1;
drha18f3d22013-05-08 03:05:41 +00005801 nFrom = 1;
drh6b7157b2013-05-10 02:00:35 +00005802
5803 /* Precompute the cost of sorting the final result set, if the caller
5804 ** to sqlite3WhereBegin() was concerned about sorting */
5805 rSortCost = (double)0;
5806 if( pWInfo->pOrderBy==0 ){
5807 aFrom[0].isOrderedValid = 1;
5808 }else{
5809 /* Compute an estimate on the cost to sort the entire result set */
5810 rSortCost = (double)1;
5811 for(pWLoop=pWInfo->pLoops; pWLoop; pWLoop=pNext){
5812 pNext = pWLoop->pNextLoop;
5813 rCost = pWLoop->nOut;
5814 while( pNext && pNext->iTab==pWLoop->iTab ){
5815 if( pNext->nOut<rCost ) rCost = pNext->nOut;
5816 pNext = pNext->pNextLoop;
5817 }
5818 rSortCost *= rCost;
5819 }
5820 rSortCost *= estLog(rSortCost);
5821 }
5822
5823 /* Compute successively longer WherePaths using the previous generation
5824 ** of WherePaths as the basis for the next. Keep track of the mxChoice
5825 ** best paths at each generation */
drha18f3d22013-05-08 03:05:41 +00005826 for(iLoop=0; iLoop<nLoop; iLoop++){
5827 nTo = 0;
5828 for(ii=0, pFrom=aFrom; ii<nFrom; ii++, pFrom++){
5829 for(pWLoop=pWInfo->pLoops; pWLoop; pWLoop=pWLoop->pNextLoop){
5830 Bitmask maskNew;
drh6b7157b2013-05-10 02:00:35 +00005831 u8 isOrderedValid = pFrom->isOrderedValid;
5832 u8 isOrdered = pFrom->isOrdered;
drha18f3d22013-05-08 03:05:41 +00005833 if( (pWLoop->prereq & ~pFrom->maskLoop)!=0 ) continue;
5834 if( (pWLoop->maskSelf & pFrom->maskLoop)!=0 ) continue;
drh6b7157b2013-05-10 02:00:35 +00005835 /* At this point, pWLoop is a candidate to be the next loop.
5836 ** Compute its cost */
drha18f3d22013-05-08 03:05:41 +00005837 rCost = pWLoop->rSetup + pWLoop->rRun*pFrom->nRow + pFrom->rCost;
5838 maskNew = pFrom->maskLoop | pWLoop->maskSelf;
drh6b7157b2013-05-10 02:00:35 +00005839 if( !isOrderedValid ){
5840 switch( wherePathSatisfiesOrderBy(pWInfo, pFrom, iLoop, pWLoop) ){
5841 case 1: /* Yes. pFrom+pWLoop does satisfy the ORDER BY clause */
5842 isOrdered = 1;
5843 isOrderedValid = 1;
5844 break;
5845 case 0: /* No. pFrom+pWLoop will require a separate sort */
5846 isOrdered = 0;
5847 isOrderedValid = 1;
5848 rCost += rSortCost;
5849 break;
5850 default: /* Cannot tell yet. Try again on the next iteration */
5851 break;
5852 }
5853 }
5854 /* Check to see if pWLoop should be added to the mxChoice best so far */
5855 for(jj=0, pTo=aTo; jj<nTo; jj++, pTo++){
5856 if( pTo->maskLoop==maskNew && pTo->isOrderedValid==isOrderedValid ){
5857 break;
5858 }
5859 }
drha18f3d22013-05-08 03:05:41 +00005860 if( jj>=nTo ){
5861 if( nTo>=mxChoice && rCost>=mxCost ) continue;
5862 if( nTo<mxChoice ){
5863 jj = nTo++;
5864 }else{
drhc718f1c2013-05-08 20:05:58 +00005865 for(jj=nTo-1; aTo[jj].rCost<mxCost; jj--){ assert(jj>0); }
drha18f3d22013-05-08 03:05:41 +00005866 }
5867 pTo = &aTo[jj];
drhf204dac2013-05-08 03:22:07 +00005868 }else{
5869 if( pTo->rCost<=rCost ) continue;
drha18f3d22013-05-08 03:05:41 +00005870 }
drh6b7157b2013-05-10 02:00:35 +00005871 /* pWLoop is a winner. Add it to the set of best so far */
drha18f3d22013-05-08 03:05:41 +00005872 pTo->maskLoop = pFrom->maskLoop | pWLoop->maskSelf;
5873 pTo->nRow = pFrom->nRow * pWLoop->nOut;
5874 pTo->rCost = rCost;
drh6b7157b2013-05-10 02:00:35 +00005875 pTo->isOrderedValid = isOrderedValid;
5876 pTo->isOrdered = isOrdered;
drha18f3d22013-05-08 03:05:41 +00005877 memcpy(pTo->aLoop, pFrom->aLoop, sizeof(WhereLoop*)*iLoop);
5878 pTo->aLoop[iLoop] = pWLoop;
5879 if( nTo>=mxChoice ){
5880 mxCost = aTo[0].rCost;
5881 for(jj=1, pTo=&aTo[1]; jj<mxChoice; jj++, pTo++){
5882 if( pTo->rCost>mxCost ) mxCost = pTo->rCost;
5883 }
5884 }
5885 }
5886 }
5887
drhf204dac2013-05-08 03:22:07 +00005888#if 0
5889 if( sqlite3WhereTrace ){
5890 sqlite3DebugPrintf("---- round %d ---- nTo=%d\n", iLoop, nTo);
5891 for(ii=0; ii<nTo; ii++){
5892 sqlite3DebugPrintf("%03d: cost=%g nrow=%g\n",
5893 ii, aTo[ii].rCost, aTo[ii].nRow);
5894 for(jj=0; jj<=iLoop; jj++){
5895 whereLoopPrint(aTo[ii].aLoop[jj], pWInfo->pTabList);
5896 }
5897 }
5898 }
5899#endif
5900
drh6b7157b2013-05-10 02:00:35 +00005901 /* Swap the roles of aFrom and aTo for the next generation */
drha18f3d22013-05-08 03:05:41 +00005902 pFrom = aTo;
5903 aTo = aFrom;
5904 aFrom = pFrom;
5905 nFrom = nTo;
5906 }
5907
5908 /* TEMPORARY */
drhc718f1c2013-05-08 20:05:58 +00005909 if( nFrom==0 ){ sqlite3DbFree(db, pSpace); return SQLITE_ERROR; }
drha18f3d22013-05-08 03:05:41 +00005910 assert( nFrom>0 );
5911
drh6b7157b2013-05-10 02:00:35 +00005912 /* Find the lowest cost path. pFrom will be left pointing to that path */
drha18f3d22013-05-08 03:05:41 +00005913 pFrom = aFrom;
5914 for(ii=1; ii<nFrom; ii++){
5915 if( pFrom->rCost>aFrom[ii].rCost ) pFrom = &aFrom[ii];
5916 }
5917 assert( pWInfo->nLevel==nLoop );
drh6b7157b2013-05-10 02:00:35 +00005918 /* Load the lowest cost path into pWInfo */
drha18f3d22013-05-08 03:05:41 +00005919 for(iLoop=0; iLoop<nLoop; iLoop++){
5920 pWInfo->a[iLoop].pWLoop = pFrom->aLoop[iLoop];
5921 }
drh6b7157b2013-05-10 02:00:35 +00005922 if( pFrom->isOrdered ){
5923 pWInfo->nOBSat = pWInfo->pOrderBy->nExpr;
5924 }
drha18f3d22013-05-08 03:05:41 +00005925
5926 /* Free temporary memory and return success */
5927 sqlite3DbFree(db, pSpace);
5928 return SQLITE_OK;
5929}
drh94a11212004-09-25 13:12:14 +00005930
5931/*
drhe3184742002-06-19 14:27:05 +00005932** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00005933** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00005934** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00005935** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00005936** in order to complete the WHERE clause processing.
5937**
5938** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00005939**
5940** The basic idea is to do a nested loop, one loop for each table in
5941** the FROM clause of a select. (INSERT and UPDATE statements are the
5942** same as a SELECT with only a single table in the FROM clause.) For
5943** example, if the SQL is this:
5944**
5945** SELECT * FROM t1, t2, t3 WHERE ...;
5946**
5947** Then the code generated is conceptually like the following:
5948**
5949** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00005950** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00005951** foreach row3 in t3 do /
5952** ...
5953** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00005954** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00005955** end /
5956**
drh29dda4a2005-07-21 18:23:20 +00005957** Note that the loops might not be nested in the order in which they
5958** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00005959** use of indices. Note also that when the IN operator appears in
5960** the WHERE clause, it might result in additional nested loops for
5961** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00005962**
drhc27a1ce2002-06-14 20:58:45 +00005963** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00005964** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
5965** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00005966** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00005967**
drhe6f85e72004-12-25 01:03:13 +00005968** The code that sqlite3WhereBegin() generates leaves the cursors named
5969** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00005970** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00005971** data from the various tables of the loop.
5972**
drhc27a1ce2002-06-14 20:58:45 +00005973** If the WHERE clause is empty, the foreach loops must each scan their
5974** entire tables. Thus a three-way join is an O(N^3) operation. But if
5975** the tables have indices and there are terms in the WHERE clause that
5976** refer to those indices, a complete table scan can be avoided and the
5977** code will run much faster. Most of the work of this routine is checking
5978** to see if there are indices that can be used to speed up the loop.
5979**
5980** Terms of the WHERE clause are also used to limit which rows actually
5981** make it to the "..." in the middle of the loop. After each "foreach",
5982** terms of the WHERE clause that use only terms in that loop and outer
5983** loops are evaluated and if false a jump is made around all subsequent
5984** inner loops (or around the "..." if the test occurs within the inner-
5985** most loop)
5986**
5987** OUTER JOINS
5988**
5989** An outer join of tables t1 and t2 is conceptally coded as follows:
5990**
5991** foreach row1 in t1 do
5992** flag = 0
5993** foreach row2 in t2 do
5994** start:
5995** ...
5996** flag = 1
5997** end
drhe3184742002-06-19 14:27:05 +00005998** if flag==0 then
5999** move the row2 cursor to a null row
6000** goto start
6001** fi
drhc27a1ce2002-06-14 20:58:45 +00006002** end
6003**
drhe3184742002-06-19 14:27:05 +00006004** ORDER BY CLAUSE PROCESSING
6005**
drh46ec5b62012-09-24 15:30:54 +00006006** pOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
drhe3184742002-06-19 14:27:05 +00006007** if there is one. If there is no ORDER BY clause or if this routine
drh46ec5b62012-09-24 15:30:54 +00006008** is called from an UPDATE or DELETE statement, then pOrderBy is NULL.
drhe3184742002-06-19 14:27:05 +00006009**
6010** If an index can be used so that the natural output order of the table
6011** scan is correct for the ORDER BY clause, then that index is used and
drh46ec5b62012-09-24 15:30:54 +00006012** the returned WhereInfo.nOBSat field is set to pOrderBy->nExpr. This
6013** is an optimization that prevents an unnecessary sort of the result set
6014** if an index appropriate for the ORDER BY clause already exists.
drhe3184742002-06-19 14:27:05 +00006015**
6016** If the where clause loops cannot be arranged to provide the correct
drh46ec5b62012-09-24 15:30:54 +00006017** output order, then WhereInfo.nOBSat is 0.
drh75897232000-05-29 14:26:00 +00006018*/
danielk19774adee202004-05-08 08:23:19 +00006019WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00006020 Parse *pParse, /* The parser context */
6021 SrcList *pTabList, /* A list of all tables to be scanned */
6022 Expr *pWhere, /* The WHERE clause */
drh46ec5b62012-09-24 15:30:54 +00006023 ExprList *pOrderBy, /* An ORDER BY clause, or NULL */
dan38cc40c2011-06-30 20:17:15 +00006024 ExprList *pDistinct, /* The select-list for DISTINCT queries - or NULL */
dan0efb72c2012-08-24 18:44:56 +00006025 u16 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
6026 int iIdxCur /* If WHERE_ONETABLE_ONLY is set, index cursor number */
drh75897232000-05-29 14:26:00 +00006027){
danielk1977be229652009-03-20 14:18:51 +00006028 int nByteWInfo; /* Num. bytes allocated for WhereInfo struct */
drhc01a3c12009-12-16 22:10:49 +00006029 int nTabList; /* Number of elements in pTabList */
drh75897232000-05-29 14:26:00 +00006030 WhereInfo *pWInfo; /* Will become the return value of this function */
6031 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhfe05af82005-07-21 03:14:59 +00006032 Bitmask notReady; /* Cursors that are not yet positioned */
drh56f1b992012-09-25 14:29:39 +00006033 WhereBestIdx sWBI; /* Best index search context */
drh1c8148f2013-05-04 20:25:23 +00006034 WhereLoopBuilder sWLB; /* The WhereLoop builder */
drh111a6a72008-12-21 03:51:16 +00006035 WhereMaskSet *pMaskSet; /* The expression mask set */
drh56f1b992012-09-25 14:29:39 +00006036 WhereLevel *pLevel; /* A single level in pWInfo->a[] */
6037 int iFrom; /* First unused FROM clause element */
drh111a6a72008-12-21 03:51:16 +00006038 int andFlags; /* AND-ed combination of all pWC->a[].wtFlags */
drh9cd1c992012-09-25 20:43:35 +00006039 int ii; /* Loop counter */
drh17435752007-08-16 04:30:38 +00006040 sqlite3 *db; /* Database connection */
drh5346e952013-05-08 14:14:26 +00006041 int rc; /* Return code */
drh75897232000-05-29 14:26:00 +00006042
drh56f1b992012-09-25 14:29:39 +00006043
6044 /* Variable initialization */
6045 memset(&sWBI, 0, sizeof(sWBI));
6046 sWBI.pParse = pParse;
drh1c8148f2013-05-04 20:25:23 +00006047 memset(&sWLB, 0, sizeof(sWLB));
6048 sWLB.pParse = pParse;
6049 sWLB.db = pParse->db;
6050 sWLB.pTabList = pTabList;
6051 sWLB.pOrderBy = pOrderBy;
drh56f1b992012-09-25 14:29:39 +00006052
drh29dda4a2005-07-21 18:23:20 +00006053 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00006054 ** bits in a Bitmask
6055 */
drh67ae0cb2010-04-08 14:38:51 +00006056 testcase( pTabList->nSrc==BMS );
drh29dda4a2005-07-21 18:23:20 +00006057 if( pTabList->nSrc>BMS ){
6058 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00006059 return 0;
6060 }
6061
drhc01a3c12009-12-16 22:10:49 +00006062 /* This function normally generates a nested loop for all tables in
6063 ** pTabList. But if the WHERE_ONETABLE_ONLY flag is set, then we should
6064 ** only generate code for the first table in pTabList and assume that
6065 ** any cursors associated with subsequent tables are uninitialized.
6066 */
6067 nTabList = (wctrlFlags & WHERE_ONETABLE_ONLY) ? 1 : pTabList->nSrc;
6068
drh75897232000-05-29 14:26:00 +00006069 /* Allocate and initialize the WhereInfo structure that will become the
danielk1977be229652009-03-20 14:18:51 +00006070 ** return value. A single allocation is used to store the WhereInfo
6071 ** struct, the contents of WhereInfo.a[], the WhereClause structure
6072 ** and the WhereMaskSet structure. Since WhereClause contains an 8-byte
6073 ** field (type Bitmask) it must be aligned on an 8-byte boundary on
6074 ** some architectures. Hence the ROUND8() below.
drh75897232000-05-29 14:26:00 +00006075 */
drh17435752007-08-16 04:30:38 +00006076 db = pParse->db;
drhc01a3c12009-12-16 22:10:49 +00006077 nByteWInfo = ROUND8(sizeof(WhereInfo)+(nTabList-1)*sizeof(WhereLevel));
danielk1977be229652009-03-20 14:18:51 +00006078 pWInfo = sqlite3DbMallocZero(db,
6079 nByteWInfo +
6080 sizeof(WhereClause) +
6081 sizeof(WhereMaskSet)
6082 );
drh17435752007-08-16 04:30:38 +00006083 if( db->mallocFailed ){
drh8b307fb2010-04-06 15:57:05 +00006084 sqlite3DbFree(db, pWInfo);
6085 pWInfo = 0;
danielk197785574e32008-10-06 05:32:18 +00006086 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00006087 }
drhc01a3c12009-12-16 22:10:49 +00006088 pWInfo->nLevel = nTabList;
drh75897232000-05-29 14:26:00 +00006089 pWInfo->pParse = pParse;
6090 pWInfo->pTabList = pTabList;
drh6b7157b2013-05-10 02:00:35 +00006091 pWInfo->pOrderBy = pOrderBy;
6092 pWInfo->pDistinct = pDistinct;
danielk19774adee202004-05-08 08:23:19 +00006093 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh56f1b992012-09-25 14:29:39 +00006094 pWInfo->pWC = sWBI.pWC = (WhereClause *)&((u8 *)pWInfo)[nByteWInfo];
drh6df2acd2008-12-28 16:55:25 +00006095 pWInfo->wctrlFlags = wctrlFlags;
drh8b307fb2010-04-06 15:57:05 +00006096 pWInfo->savedNQueryLoop = pParse->nQueryLoop;
drh56f1b992012-09-25 14:29:39 +00006097 pMaskSet = (WhereMaskSet*)&sWBI.pWC[1];
drh46c35f92012-09-26 23:17:01 +00006098 sWBI.aLevel = pWInfo->a;
drh1c8148f2013-05-04 20:25:23 +00006099 sWLB.pWInfo = pWInfo;
6100 sWLB.pWC = pWInfo->pWC;
drh08192d52002-04-30 19:20:28 +00006101
drha9b1b912011-07-08 13:07:02 +00006102 /* Disable the DISTINCT optimization if SQLITE_DistinctOpt is set via
6103 ** sqlite3_test_ctrl(SQLITE_TESTCTRL_OPTIMIZATIONS,...) */
drh7e5418e2012-09-27 15:05:54 +00006104 if( OptimizationDisabled(db, SQLITE_DistinctOpt) ) pDistinct = 0;
drha9b1b912011-07-08 13:07:02 +00006105
drh111a6a72008-12-21 03:51:16 +00006106 /* Split the WHERE clause into separate subexpressions where each
6107 ** subexpression is separated by an AND operator.
6108 */
6109 initMaskSet(pMaskSet);
drh56f1b992012-09-25 14:29:39 +00006110 whereClauseInit(sWBI.pWC, pParse, pMaskSet, wctrlFlags);
drh111a6a72008-12-21 03:51:16 +00006111 sqlite3ExprCodeConstants(pParse, pWhere);
drh56f1b992012-09-25 14:29:39 +00006112 whereSplit(sWBI.pWC, pWhere, TK_AND); /* IMP: R-15842-53296 */
drh111a6a72008-12-21 03:51:16 +00006113
drh08192d52002-04-30 19:20:28 +00006114 /* Special case: a WHERE clause that is constant. Evaluate the
6115 ** expression and either jump over all of the code or fall thru.
6116 */
drhc01a3c12009-12-16 22:10:49 +00006117 if( pWhere && (nTabList==0 || sqlite3ExprIsConstantNotJoin(pWhere)) ){
drh35573352008-01-08 23:54:25 +00006118 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, SQLITE_JUMPIFNULL);
drhdf199a22002-06-14 22:38:41 +00006119 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00006120 }
drh75897232000-05-29 14:26:00 +00006121
drh42165be2008-03-26 14:56:34 +00006122 /* Assign a bit from the bitmask to every term in the FROM clause.
6123 **
6124 ** When assigning bitmask values to FROM clause cursors, it must be
6125 ** the case that if X is the bitmask for the N-th FROM clause term then
6126 ** the bitmask for all FROM clause terms to the left of the N-th term
6127 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
6128 ** its Expr.iRightJoinTable value to find the bitmask of the right table
6129 ** of the join. Subtracting one from the right table bitmask gives a
6130 ** bitmask for all tables to the left of the join. Knowing the bitmask
6131 ** for all tables to the left of a left join is important. Ticket #3015.
danielk1977e672c8e2009-05-22 15:43:26 +00006132 **
drhc01a3c12009-12-16 22:10:49 +00006133 ** Note that bitmasks are created for all pTabList->nSrc tables in
6134 ** pTabList, not just the first nTabList tables. nTabList is normally
6135 ** equal to pTabList->nSrc but might be shortened to 1 if the
6136 ** WHERE_ONETABLE_ONLY flag is set.
drh42165be2008-03-26 14:56:34 +00006137 */
drh9cd1c992012-09-25 20:43:35 +00006138 for(ii=0; ii<pTabList->nSrc; ii++){
6139 createMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00006140 }
6141#ifndef NDEBUG
6142 {
6143 Bitmask toTheLeft = 0;
drh9cd1c992012-09-25 20:43:35 +00006144 for(ii=0; ii<pTabList->nSrc; ii++){
6145 Bitmask m = getMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00006146 assert( (m-1)==toTheLeft );
6147 toTheLeft |= m;
6148 }
6149 }
6150#endif
6151
drh29dda4a2005-07-21 18:23:20 +00006152 /* Analyze all of the subexpressions. Note that exprAnalyze() might
6153 ** add new virtual terms onto the end of the WHERE clause. We do not
6154 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00006155 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00006156 */
drh56f1b992012-09-25 14:29:39 +00006157 exprAnalyzeAll(pTabList, sWBI.pWC);
drh17435752007-08-16 04:30:38 +00006158 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00006159 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00006160 }
drh75897232000-05-29 14:26:00 +00006161
dan38cc40c2011-06-30 20:17:15 +00006162 /* Check if the DISTINCT qualifier, if there is one, is redundant.
6163 ** If it is, then set pDistinct to NULL and WhereInfo.eDistinct to
6164 ** WHERE_DISTINCT_UNIQUE to tell the caller to ignore the DISTINCT.
6165 */
drh56f1b992012-09-25 14:29:39 +00006166 if( pDistinct && isDistinctRedundant(pParse, pTabList, sWBI.pWC, pDistinct) ){
dan38cc40c2011-06-30 20:17:15 +00006167 pDistinct = 0;
6168 pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
6169 }
6170
drhf1b5f5b2013-05-02 00:15:01 +00006171 /* Construct the WhereLoop objects */
6172 WHERETRACE(("*** Optimizer Start ***\n"));
drh5346e952013-05-08 14:14:26 +00006173 rc = whereLoopAddAll(&sWLB);
6174 if( rc ) goto whereBeginError;
drhf1b5f5b2013-05-02 00:15:01 +00006175
6176 /* Display all of the WhereLoop objects if wheretrace is enabled */
6177#if defined(SQLITE_DEBUG) \
6178 && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE))
6179 if( sqlite3WhereTrace ){
6180 WhereLoop *p;
drhf1b5f5b2013-05-02 00:15:01 +00006181 for(p=pWInfo->pLoops; p; p=p->pNextLoop){
drha18f3d22013-05-08 03:05:41 +00006182 whereLoopPrint(p, pTabList);
6183 }
6184 }
6185#endif
6186
6187 wherePathSolver(pWInfo);
6188 if( db->mallocFailed ) goto whereBeginError;
6189#if defined(SQLITE_DEBUG) \
6190 && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE))
6191 if( sqlite3WhereTrace ){
6192 int ii;
6193 sqlite3DebugPrintf("------------ Solution ----------------\n");
6194 for(ii=0; ii<nTabList; ii++){
6195 whereLoopPrint(pWInfo->a[ii].pWLoop, pTabList);
drhf1b5f5b2013-05-02 00:15:01 +00006196 }
6197 }
6198#endif
6199
drh29dda4a2005-07-21 18:23:20 +00006200 /* Chose the best index to use for each table in the FROM clause.
6201 **
drh51147ba2005-07-23 22:59:55 +00006202 ** This loop fills in the following fields:
6203 **
6204 ** pWInfo->a[].pIdx The index to use for this level of the loop.
drh165be382008-12-05 02:36:33 +00006205 ** pWInfo->a[].wsFlags WHERE_xxx flags associated with pIdx
drh51147ba2005-07-23 22:59:55 +00006206 ** pWInfo->a[].nEq The number of == and IN constraints
danielk197785574e32008-10-06 05:32:18 +00006207 ** pWInfo->a[].iFrom Which term of the FROM clause is being coded
drh51147ba2005-07-23 22:59:55 +00006208 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
6209 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
drh111a6a72008-12-21 03:51:16 +00006210 ** pWInfo->a[].pTerm When wsFlags==WO_OR, the OR-clause term
drh51147ba2005-07-23 22:59:55 +00006211 **
6212 ** This loop also figures out the nesting order of tables in the FROM
6213 ** clause.
drh75897232000-05-29 14:26:00 +00006214 */
drh9cd1c992012-09-25 20:43:35 +00006215 sWBI.notValid = ~(Bitmask)0;
6216 sWBI.pOrderBy = pOrderBy;
6217 sWBI.n = nTabList;
6218 sWBI.pDistinct = pDistinct;
drh943af3c2005-07-29 19:43:58 +00006219 andFlags = ~0;
drh9cd1c992012-09-25 20:43:35 +00006220 for(sWBI.i=iFrom=0, pLevel=pWInfo->a; sWBI.i<nTabList; sWBI.i++, pLevel++){
drh111a6a72008-12-21 03:51:16 +00006221 WhereCost bestPlan; /* Most efficient plan seen so far */
drh29dda4a2005-07-21 18:23:20 +00006222 Index *pIdx; /* Index for FROM table at pTabItem */
drh29dda4a2005-07-21 18:23:20 +00006223 int j; /* For looping over FROM tables */
dan5236ac12009-08-13 07:09:33 +00006224 int bestJ = -1; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00006225 Bitmask m; /* Bitmask value for j or bestJ */
dan5236ac12009-08-13 07:09:33 +00006226 int isOptimal; /* Iterator for optimal/non-optimal search */
drh3bd5ab82013-01-16 00:46:09 +00006227 int ckOptimal; /* Do the optimal scan check */
drh5e377d92010-08-04 21:17:16 +00006228 int nUnconstrained; /* Number tables without INDEXED BY */
drhaa0ba432010-08-05 02:52:32 +00006229 Bitmask notIndexed; /* Mask of tables that cannot use an index */
drh29dda4a2005-07-21 18:23:20 +00006230
drh111a6a72008-12-21 03:51:16 +00006231 memset(&bestPlan, 0, sizeof(bestPlan));
6232 bestPlan.rCost = SQLITE_BIG_DBL;
drhf1b5f5b2013-05-02 00:15:01 +00006233 /*WHERETRACE(("*** Begin search for loop %d ***\n", sWBI.i));*/
drhdf26fd52006-06-06 11:45:54 +00006234
dan5236ac12009-08-13 07:09:33 +00006235 /* Loop through the remaining entries in the FROM clause to find the
drhed754ce2010-04-15 01:04:54 +00006236 ** next nested loop. The loop tests all FROM clause entries
dan5236ac12009-08-13 07:09:33 +00006237 ** either once or twice.
6238 **
drhed754ce2010-04-15 01:04:54 +00006239 ** The first test is always performed if there are two or more entries
6240 ** remaining and never performed if there is only one FROM clause entry
6241 ** to choose from. The first test looks for an "optimal" scan. In
dan5236ac12009-08-13 07:09:33 +00006242 ** this context an optimal scan is one that uses the same strategy
6243 ** for the given FROM clause entry as would be selected if the entry
drhd0015162009-08-21 13:22:25 +00006244 ** were used as the innermost nested loop. In other words, a table
6245 ** is chosen such that the cost of running that table cannot be reduced
drhed754ce2010-04-15 01:04:54 +00006246 ** by waiting for other tables to run first. This "optimal" test works
6247 ** by first assuming that the FROM clause is on the inner loop and finding
6248 ** its query plan, then checking to see if that query plan uses any
drh9cd1c992012-09-25 20:43:35 +00006249 ** other FROM clause terms that are sWBI.notValid. If no notValid terms
6250 ** are used then the "optimal" query plan works.
dan5236ac12009-08-13 07:09:33 +00006251 **
drh547caad2010-10-04 23:55:50 +00006252 ** Note that the WhereCost.nRow parameter for an optimal scan might
6253 ** not be as small as it would be if the table really were the innermost
6254 ** join. The nRow value can be reduced by WHERE clause constraints
6255 ** that do not use indices. But this nRow reduction only happens if the
6256 ** table really is the innermost join.
6257 **
drhed754ce2010-04-15 01:04:54 +00006258 ** The second loop iteration is only performed if no optimal scan
drh547caad2010-10-04 23:55:50 +00006259 ** strategies were found by the first iteration. This second iteration
6260 ** is used to search for the lowest cost scan overall.
dan5236ac12009-08-13 07:09:33 +00006261 **
drh5d5cf012013-01-15 16:15:28 +00006262 ** Without the optimal scan step (the first iteration) a suboptimal
6263 ** plan might be chosen for queries like this:
dan5236ac12009-08-13 07:09:33 +00006264 **
6265 ** CREATE TABLE t1(a, b);
6266 ** CREATE TABLE t2(c, d);
6267 ** SELECT * FROM t2, t1 WHERE t2.rowid = t1.a;
6268 **
6269 ** The best strategy is to iterate through table t1 first. However it
6270 ** is not possible to determine this with a simple greedy algorithm.
drh15564052010-09-25 22:32:56 +00006271 ** Since the cost of a linear scan through table t2 is the same
dan5236ac12009-08-13 07:09:33 +00006272 ** as the cost of a linear scan through table t1, a simple greedy
6273 ** algorithm may choose to use t2 for the outer loop, which is a much
6274 ** costlier approach.
6275 */
drh5e377d92010-08-04 21:17:16 +00006276 nUnconstrained = 0;
drhaa0ba432010-08-05 02:52:32 +00006277 notIndexed = 0;
drh3bd5ab82013-01-16 00:46:09 +00006278
6279 /* The optimal scan check only occurs if there are two or more tables
6280 ** available to be reordered */
6281 if( iFrom==nTabList-1 ){
6282 ckOptimal = 0; /* Common case of just one table in the FROM clause */
6283 }else{
6284 ckOptimal = -1;
drh56f1b992012-09-25 14:29:39 +00006285 for(j=iFrom, sWBI.pSrc=&pTabList->a[j]; j<nTabList; j++, sWBI.pSrc++){
drh56f1b992012-09-25 14:29:39 +00006286 m = getMask(pMaskSet, sWBI.pSrc->iCursor);
drh9cd1c992012-09-25 20:43:35 +00006287 if( (m & sWBI.notValid)==0 ){
dan5236ac12009-08-13 07:09:33 +00006288 if( j==iFrom ) iFrom++;
6289 continue;
6290 }
drh3bd5ab82013-01-16 00:46:09 +00006291 if( j>iFrom && (sWBI.pSrc->jointype & (JT_LEFT|JT_CROSS))!=0 ) break;
6292 if( ++ckOptimal ) break;
6293 if( (sWBI.pSrc->jointype & JT_LEFT)!=0 ) break;
6294 }
6295 }
6296 assert( ckOptimal==0 || ckOptimal==1 );
6297
6298 for(isOptimal=ckOptimal; isOptimal>=0 && bestJ<0; isOptimal--){
6299 for(j=iFrom, sWBI.pSrc=&pTabList->a[j]; j<nTabList; j++, sWBI.pSrc++){
6300 if( j>iFrom && (sWBI.pSrc->jointype & (JT_LEFT|JT_CROSS))!=0 ){
6301 /* This break and one like it in the ckOptimal computation loop
6302 ** above prevent table reordering across LEFT and CROSS JOINs.
6303 ** The LEFT JOIN case is necessary for correctness. The prohibition
6304 ** against reordering across a CROSS JOIN is an SQLite feature that
6305 ** allows the developer to control table reordering */
6306 break;
6307 }
6308 m = getMask(pMaskSet, sWBI.pSrc->iCursor);
6309 if( (m & sWBI.notValid)==0 ){
6310 assert( j>iFrom );
6311 continue;
6312 }
drh9cd1c992012-09-25 20:43:35 +00006313 sWBI.notReady = (isOptimal ? m : sWBI.notValid);
drh56f1b992012-09-25 14:29:39 +00006314 if( sWBI.pSrc->pIndex==0 ) nUnconstrained++;
dan5236ac12009-08-13 07:09:33 +00006315
drhf1b5f5b2013-05-02 00:15:01 +00006316 /*WHERETRACE((" === trying table %d (%s) with isOptimal=%d ===\n",
6317 j, sWBI.pSrc->pTab->zName, isOptimal));*/
drh56f1b992012-09-25 14:29:39 +00006318 assert( sWBI.pSrc->pTab );
drh9eff6162006-06-12 21:59:13 +00006319#ifndef SQLITE_OMIT_VIRTUALTABLE
drh56f1b992012-09-25 14:29:39 +00006320 if( IsVirtual(sWBI.pSrc->pTab) ){
6321 sWBI.ppIdxInfo = &pWInfo->a[j].pIdxInfo;
6322 bestVirtualIndex(&sWBI);
dan5236ac12009-08-13 07:09:33 +00006323 }else
drh9eff6162006-06-12 21:59:13 +00006324#endif
dan5236ac12009-08-13 07:09:33 +00006325 {
drh56f1b992012-09-25 14:29:39 +00006326 bestBtreeIndex(&sWBI);
dan5236ac12009-08-13 07:09:33 +00006327 }
drh9cd1c992012-09-25 20:43:35 +00006328 assert( isOptimal || (sWBI.cost.used&sWBI.notValid)==0 );
dan5236ac12009-08-13 07:09:33 +00006329
drhaa0ba432010-08-05 02:52:32 +00006330 /* If an INDEXED BY clause is present, then the plan must use that
6331 ** index if it uses any index at all */
drh56f1b992012-09-25 14:29:39 +00006332 assert( sWBI.pSrc->pIndex==0
6333 || (sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)==0
6334 || sWBI.cost.plan.u.pIdx==sWBI.pSrc->pIndex );
drhaa0ba432010-08-05 02:52:32 +00006335
drh56f1b992012-09-25 14:29:39 +00006336 if( isOptimal && (sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)==0 ){
drhaa0ba432010-08-05 02:52:32 +00006337 notIndexed |= m;
6338 }
drh782d68a2012-11-09 17:59:26 +00006339 if( isOptimal ){
6340 pWInfo->a[j].rOptCost = sWBI.cost.rCost;
drh3bd5ab82013-01-16 00:46:09 +00006341 }else if( ckOptimal ){
drhea84a652013-01-15 18:49:07 +00006342 /* If two or more tables have nearly the same outer loop cost, but
drh782d68a2012-11-09 17:59:26 +00006343 ** very different inner loop (optimal) cost, we want to choose
6344 ** for the outer loop that table which benefits the least from
6345 ** being in the inner loop. The following code scales the
6346 ** outer loop cost estimate to accomplish that. */
drhf1b5f5b2013-05-02 00:15:01 +00006347 /*WHERETRACE((" scaling cost from %.1f to %.1f\n",
drh782d68a2012-11-09 17:59:26 +00006348 sWBI.cost.rCost,
drhf1b5f5b2013-05-02 00:15:01 +00006349 sWBI.cost.rCost/pWInfo->a[j].rOptCost));*/
drh782d68a2012-11-09 17:59:26 +00006350 sWBI.cost.rCost /= pWInfo->a[j].rOptCost;
6351 }
drhaa0ba432010-08-05 02:52:32 +00006352
drh5e377d92010-08-04 21:17:16 +00006353 /* Conditions under which this table becomes the best so far:
6354 **
6355 ** (1) The table must not depend on other tables that have not
drh9cd1c992012-09-25 20:43:35 +00006356 ** yet run. (In other words, it must not depend on tables
6357 ** in inner loops.)
drh5e377d92010-08-04 21:17:16 +00006358 **
drhada796b2012-11-09 18:22:26 +00006359 ** (2) (This rule was removed on 2012-11-09. The scaling of the
6360 ** cost using the optimal scan cost made this rule obsolete.)
drh5e377d92010-08-04 21:17:16 +00006361 **
drhaa0ba432010-08-05 02:52:32 +00006362 ** (3) All tables have an INDEXED BY clause or this table lacks an
drh5e377d92010-08-04 21:17:16 +00006363 ** INDEXED BY clause or this table uses the specific
drhaa0ba432010-08-05 02:52:32 +00006364 ** index specified by its INDEXED BY clause. This rule ensures
6365 ** that a best-so-far is always selected even if an impossible
6366 ** combination of INDEXED BY clauses are given. The error
6367 ** will be detected and relayed back to the application later.
6368 ** The NEVER() comes about because rule (2) above prevents
6369 ** An indexable full-table-scan from reaching rule (3).
6370 **
drhd663b5b2012-10-03 00:25:54 +00006371 ** (4) The plan cost must be lower than prior plans, where "cost"
6372 ** is defined by the compareCost() function above.
drh5e377d92010-08-04 21:17:16 +00006373 */
drh9cd1c992012-09-25 20:43:35 +00006374 if( (sWBI.cost.used&sWBI.notValid)==0 /* (1) */
drh56f1b992012-09-25 14:29:39 +00006375 && (nUnconstrained==0 || sWBI.pSrc->pIndex==0 /* (3) */
6376 || NEVER((sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)!=0))
drhd663b5b2012-10-03 00:25:54 +00006377 && (bestJ<0 || compareCost(&sWBI.cost, &bestPlan)) /* (4) */
dan5236ac12009-08-13 07:09:33 +00006378 ){
drhf1b5f5b2013-05-02 00:15:01 +00006379 /*WHERETRACE((" === table %d (%s) is best so far\n"
drh8e4af1b2012-10-08 18:23:51 +00006380 " cost=%.1f, nRow=%.1f, nOBSat=%d, wsFlags=%08x\n",
drh1afcaae2012-10-02 01:10:00 +00006381 j, sWBI.pSrc->pTab->zName,
6382 sWBI.cost.rCost, sWBI.cost.plan.nRow,
drhf1b5f5b2013-05-02 00:15:01 +00006383 sWBI.cost.plan.nOBSat, sWBI.cost.plan.wsFlags));*/
drh56f1b992012-09-25 14:29:39 +00006384 bestPlan = sWBI.cost;
dan5236ac12009-08-13 07:09:33 +00006385 bestJ = j;
6386 }
drh3bd5ab82013-01-16 00:46:09 +00006387
6388 /* In a join like "w JOIN x LEFT JOIN y JOIN z" make sure that
6389 ** table y (and not table z) is always the next inner loop inside
6390 ** of table x. */
6391 if( (sWBI.pSrc->jointype & JT_LEFT)!=0 ) break;
drh9eff6162006-06-12 21:59:13 +00006392 }
drh29dda4a2005-07-21 18:23:20 +00006393 }
dan5236ac12009-08-13 07:09:33 +00006394 assert( bestJ>=0 );
drh9cd1c992012-09-25 20:43:35 +00006395 assert( sWBI.notValid & getMask(pMaskSet, pTabList->a[bestJ].iCursor) );
drh3bd5ab82013-01-16 00:46:09 +00006396 assert( bestJ==iFrom || (pTabList->a[iFrom].jointype & JT_LEFT)==0 );
6397 testcase( bestJ>iFrom && (pTabList->a[iFrom].jointype & JT_CROSS)!=0 );
6398 testcase( bestJ>iFrom && bestJ<nTabList-1
6399 && (pTabList->a[bestJ+1].jointype & JT_LEFT)!=0 );
drhf1b5f5b2013-05-02 00:15:01 +00006400 /*WHERETRACE(("*** Optimizer selects table %d (%s) for loop %d with:\n"
drhd663b5b2012-10-03 00:25:54 +00006401 " cost=%.1f, nRow=%.1f, nOBSat=%d, wsFlags=0x%08x\n",
drh1afcaae2012-10-02 01:10:00 +00006402 bestJ, pTabList->a[bestJ].pTab->zName,
6403 pLevel-pWInfo->a, bestPlan.rCost, bestPlan.plan.nRow,
drhf1b5f5b2013-05-02 00:15:01 +00006404 bestPlan.plan.nOBSat, bestPlan.plan.wsFlags));*/
dan38cc40c2011-06-30 20:17:15 +00006405 if( (bestPlan.plan.wsFlags & WHERE_DISTINCT)!=0 ){
6406 assert( pWInfo->eDistinct==0 );
6407 pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
6408 }
drh111a6a72008-12-21 03:51:16 +00006409 andFlags &= bestPlan.plan.wsFlags;
6410 pLevel->plan = bestPlan.plan;
drha578d042012-10-02 01:25:16 +00006411 pLevel->iTabCur = pTabList->a[bestJ].iCursor;
drh8b307fb2010-04-06 15:57:05 +00006412 testcase( bestPlan.plan.wsFlags & WHERE_INDEXED );
6413 testcase( bestPlan.plan.wsFlags & WHERE_TEMP_INDEX );
6414 if( bestPlan.plan.wsFlags & (WHERE_INDEXED|WHERE_TEMP_INDEX) ){
dan0efb72c2012-08-24 18:44:56 +00006415 if( (wctrlFlags & WHERE_ONETABLE_ONLY)
6416 && (bestPlan.plan.wsFlags & WHERE_TEMP_INDEX)==0
6417 ){
6418 pLevel->iIdxCur = iIdxCur;
6419 }else{
6420 pLevel->iIdxCur = pParse->nTab++;
6421 }
drhfe05af82005-07-21 03:14:59 +00006422 }else{
6423 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00006424 }
drh9cd1c992012-09-25 20:43:35 +00006425 sWBI.notValid &= ~getMask(pMaskSet, pTabList->a[bestJ].iCursor);
shaned87897d2009-01-30 05:40:27 +00006426 pLevel->iFrom = (u8)bestJ;
dan2ce22452010-11-08 19:01:16 +00006427 if( bestPlan.plan.nRow>=(double)1 ){
6428 pParse->nQueryLoop *= bestPlan.plan.nRow;
6429 }
danielk197785574e32008-10-06 05:32:18 +00006430
6431 /* Check that if the table scanned by this loop iteration had an
6432 ** INDEXED BY clause attached to it, that the named index is being
6433 ** used for the scan. If not, then query compilation has failed.
6434 ** Return an error.
6435 */
6436 pIdx = pTabList->a[bestJ].pIndex;
drh171256c2009-01-08 03:11:19 +00006437 if( pIdx ){
6438 if( (bestPlan.plan.wsFlags & WHERE_INDEXED)==0 ){
6439 sqlite3ErrorMsg(pParse, "cannot use index: %s", pIdx->zName);
6440 goto whereBeginError;
6441 }else{
6442 /* If an INDEXED BY clause is used, the bestIndex() function is
6443 ** guaranteed to find the index specified in the INDEXED BY clause
6444 ** if it find an index at all. */
6445 assert( bestPlan.plan.u.pIdx==pIdx );
6446 }
danielk197785574e32008-10-06 05:32:18 +00006447 }
drh75897232000-05-29 14:26:00 +00006448 }
drh4f0c5872007-03-26 22:05:01 +00006449 WHERETRACE(("*** Optimizer Finished ***\n"));
danielk19771d461462009-04-21 09:02:45 +00006450 if( pParse->nErr || db->mallocFailed ){
danielk197780442942008-12-24 11:25:39 +00006451 goto whereBeginError;
6452 }
drhd663b5b2012-10-03 00:25:54 +00006453 if( nTabList ){
6454 pLevel--;
6455 pWInfo->nOBSat = pLevel->plan.nOBSat;
6456 }else{
6457 pWInfo->nOBSat = 0;
6458 }
drh75897232000-05-29 14:26:00 +00006459
drh943af3c2005-07-29 19:43:58 +00006460 /* If the total query only selects a single row, then the ORDER BY
6461 ** clause is irrelevant.
6462 */
drh46ec5b62012-09-24 15:30:54 +00006463 if( (andFlags & WHERE_UNIQUE)!=0 && pOrderBy ){
drhd663b5b2012-10-03 00:25:54 +00006464 assert( nTabList==0 || (pLevel->plan.wsFlags & WHERE_ALL_UNIQUE)!=0 );
drh46ec5b62012-09-24 15:30:54 +00006465 pWInfo->nOBSat = pOrderBy->nExpr;
drh943af3c2005-07-29 19:43:58 +00006466 }
6467
drh08c88eb2008-04-10 13:33:18 +00006468 /* If the caller is an UPDATE or DELETE statement that is requesting
6469 ** to use a one-pass algorithm, determine if this is appropriate.
6470 ** The one-pass algorithm only works if the WHERE clause constraints
6471 ** the statement to update a single row.
6472 */
drh165be382008-12-05 02:36:33 +00006473 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
6474 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 && (andFlags & WHERE_UNIQUE)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00006475 pWInfo->okOnePass = 1;
drh111a6a72008-12-21 03:51:16 +00006476 pWInfo->a[0].plan.wsFlags &= ~WHERE_IDX_ONLY;
drh08c88eb2008-04-10 13:33:18 +00006477 }
6478
drheb04de32013-05-10 15:16:30 +00006479#if 0
6480 /* Scaffolding: Check the new query plan against the old. Report any
6481 ** discrepencies */
6482 for(ii=0; ii<nTabList; ii++){
6483 if( pWInfo->a[ii].iFrom!=pWInfo->a[ii].pWLoop->iTab ){
6484 sqlite3DebugPrintf("(QP-Mismatch)");
6485 break;
6486 }
6487 }
6488#endif
6489
drh9012bcb2004-12-19 00:11:35 +00006490 /* Open all tables in the pTabList and any indices selected for
6491 ** searching those tables.
6492 */
6493 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh8b307fb2010-04-06 15:57:05 +00006494 notReady = ~(Bitmask)0;
drh95aa47b2010-11-16 02:49:15 +00006495 pWInfo->nRowOut = (double)1;
drh9cd1c992012-09-25 20:43:35 +00006496 for(ii=0, pLevel=pWInfo->a; ii<nTabList; ii++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00006497 Table *pTab; /* Table to open */
danielk1977da184232006-01-05 11:34:32 +00006498 int iDb; /* Index of database containing table/index */
drh56f1b992012-09-25 14:29:39 +00006499 struct SrcList_item *pTabItem;
drh9012bcb2004-12-19 00:11:35 +00006500
drh29dda4a2005-07-21 18:23:20 +00006501 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00006502 pTab = pTabItem->pTab;
drh95aa47b2010-11-16 02:49:15 +00006503 pWInfo->nRowOut *= pLevel->plan.nRow;
danielk1977595a5232009-07-24 17:58:53 +00006504 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh424aab82010-04-06 18:28:20 +00006505 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ){
drh75bb9f52010-04-06 18:51:42 +00006506 /* Do nothing */
6507 }else
drh9eff6162006-06-12 21:59:13 +00006508#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00006509 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
danielk1977595a5232009-07-24 17:58:53 +00006510 const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
danielk197793626f42006-06-20 13:07:27 +00006511 int iCur = pTabItem->iCursor;
danielk1977595a5232009-07-24 17:58:53 +00006512 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0, pVTab, P4_VTAB);
drhfc5e5462012-12-03 17:04:40 +00006513 }else if( IsVirtual(pTab) ){
6514 /* noop */
drh9eff6162006-06-12 21:59:13 +00006515 }else
6516#endif
drh6df2acd2008-12-28 16:55:25 +00006517 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
drh9ef61f42011-10-07 14:40:59 +00006518 && (wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0 ){
drh08c88eb2008-04-10 13:33:18 +00006519 int op = pWInfo->okOnePass ? OP_OpenWrite : OP_OpenRead;
6520 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
drh67ae0cb2010-04-08 14:38:51 +00006521 testcase( pTab->nCol==BMS-1 );
6522 testcase( pTab->nCol==BMS );
danielk197723432972008-11-17 16:42:00 +00006523 if( !pWInfo->okOnePass && pTab->nCol<BMS ){
danielk19779792eef2006-01-13 15:58:43 +00006524 Bitmask b = pTabItem->colUsed;
6525 int n = 0;
drh74161702006-02-24 02:53:49 +00006526 for(; b; b=b>>1, n++){}
drh8cff69d2009-11-12 19:59:44 +00006527 sqlite3VdbeChangeP4(v, sqlite3VdbeCurrentAddr(v)-1,
6528 SQLITE_INT_TO_PTR(n), P4_INT32);
danielk19779792eef2006-01-13 15:58:43 +00006529 assert( n<=pTab->nCol );
6530 }
danielk1977c00da102006-01-07 13:21:04 +00006531 }else{
6532 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00006533 }
drhc6339082010-04-07 16:54:58 +00006534#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00006535 if( (pLevel->plan.wsFlags & WHERE_TEMP_INDEX)!=0 ){
drh56f1b992012-09-25 14:29:39 +00006536 constructAutomaticIndex(pParse, sWBI.pWC, pTabItem, notReady, pLevel);
drhc6339082010-04-07 16:54:58 +00006537 }else
6538#endif
6539 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
drh111a6a72008-12-21 03:51:16 +00006540 Index *pIx = pLevel->plan.u.pIdx;
danielk1977b3bf5562006-01-10 17:58:23 +00006541 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
drhb0367fb2012-08-25 02:11:13 +00006542 int iIndexCur = pLevel->iIdxCur;
danielk1977da184232006-01-05 11:34:32 +00006543 assert( pIx->pSchema==pTab->pSchema );
drhb0367fb2012-08-25 02:11:13 +00006544 assert( iIndexCur>=0 );
6545 sqlite3VdbeAddOp4(v, OP_OpenRead, iIndexCur, pIx->tnum, iDb,
drh66a51672008-01-03 00:01:23 +00006546 (char*)pKey, P4_KEYINFO_HANDOFF);
danielk1977207872a2008-01-03 07:54:23 +00006547 VdbeComment((v, "%s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00006548 }
danielk1977da184232006-01-05 11:34:32 +00006549 sqlite3CodeVerifySchema(pParse, iDb);
drh56f1b992012-09-25 14:29:39 +00006550 notReady &= ~getMask(sWBI.pWC->pMaskSet, pTabItem->iCursor);
drh9012bcb2004-12-19 00:11:35 +00006551 }
6552 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
drha21a64d2010-04-06 22:33:55 +00006553 if( db->mallocFailed ) goto whereBeginError;
drh9012bcb2004-12-19 00:11:35 +00006554
drh29dda4a2005-07-21 18:23:20 +00006555 /* Generate the code to do the search. Each iteration of the for
6556 ** loop below generates code for a single nested loop of the VM
6557 ** program.
drh75897232000-05-29 14:26:00 +00006558 */
drhfe05af82005-07-21 03:14:59 +00006559 notReady = ~(Bitmask)0;
drh9cd1c992012-09-25 20:43:35 +00006560 for(ii=0; ii<nTabList; ii++){
6561 pLevel = &pWInfo->a[ii];
6562 explainOneScan(pParse, pTabList, pLevel, ii, pLevel->iFrom, wctrlFlags);
6563 notReady = codeOneLoopStart(pWInfo, ii, wctrlFlags, notReady);
dan4a07e3d2010-11-09 14:48:59 +00006564 pWInfo->iContinue = pLevel->addrCont;
drh75897232000-05-29 14:26:00 +00006565 }
drh7ec764a2005-07-21 03:48:20 +00006566
6567#ifdef SQLITE_TEST /* For testing and debugging use only */
6568 /* Record in the query plan information about the current table
6569 ** and the index used to access it (if any). If the table itself
6570 ** is not used, its name is just '{}'. If no index is used
6571 ** the index is listed as "{}". If the primary key is used the
6572 ** index name is '*'.
6573 */
drh9cd1c992012-09-25 20:43:35 +00006574 for(ii=0; ii<nTabList; ii++){
drh7ec764a2005-07-21 03:48:20 +00006575 char *z;
6576 int n;
drh3f4d1d12012-09-15 18:45:54 +00006577 int w;
drh56f1b992012-09-25 14:29:39 +00006578 struct SrcList_item *pTabItem;
6579
drh9cd1c992012-09-25 20:43:35 +00006580 pLevel = &pWInfo->a[ii];
drh3f4d1d12012-09-15 18:45:54 +00006581 w = pLevel->plan.wsFlags;
drh29dda4a2005-07-21 18:23:20 +00006582 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00006583 z = pTabItem->zAlias;
6584 if( z==0 ) z = pTabItem->pTab->zName;
drhea678832008-12-10 19:26:22 +00006585 n = sqlite3Strlen30(z);
drh7ec764a2005-07-21 03:48:20 +00006586 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
drh3f4d1d12012-09-15 18:45:54 +00006587 if( (w & WHERE_IDX_ONLY)!=0 && (w & WHERE_COVER_SCAN)==0 ){
drh5bb3eb92007-05-04 13:15:55 +00006588 memcpy(&sqlite3_query_plan[nQPlan], "{}", 2);
drh7ec764a2005-07-21 03:48:20 +00006589 nQPlan += 2;
6590 }else{
drh5bb3eb92007-05-04 13:15:55 +00006591 memcpy(&sqlite3_query_plan[nQPlan], z, n);
drh7ec764a2005-07-21 03:48:20 +00006592 nQPlan += n;
6593 }
6594 sqlite3_query_plan[nQPlan++] = ' ';
6595 }
drh3f4d1d12012-09-15 18:45:54 +00006596 testcase( w & WHERE_ROWID_EQ );
6597 testcase( w & WHERE_ROWID_RANGE );
6598 if( w & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh5bb3eb92007-05-04 13:15:55 +00006599 memcpy(&sqlite3_query_plan[nQPlan], "* ", 2);
drh7ec764a2005-07-21 03:48:20 +00006600 nQPlan += 2;
drh3f4d1d12012-09-15 18:45:54 +00006601 }else if( (w & WHERE_INDEXED)!=0 && (w & WHERE_COVER_SCAN)==0 ){
drh111a6a72008-12-21 03:51:16 +00006602 n = sqlite3Strlen30(pLevel->plan.u.pIdx->zName);
drh7ec764a2005-07-21 03:48:20 +00006603 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
drh111a6a72008-12-21 03:51:16 +00006604 memcpy(&sqlite3_query_plan[nQPlan], pLevel->plan.u.pIdx->zName, n);
drh7ec764a2005-07-21 03:48:20 +00006605 nQPlan += n;
6606 sqlite3_query_plan[nQPlan++] = ' ';
6607 }
drh111a6a72008-12-21 03:51:16 +00006608 }else{
6609 memcpy(&sqlite3_query_plan[nQPlan], "{} ", 3);
6610 nQPlan += 3;
drh7ec764a2005-07-21 03:48:20 +00006611 }
6612 }
6613 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
6614 sqlite3_query_plan[--nQPlan] = 0;
6615 }
6616 sqlite3_query_plan[nQPlan] = 0;
6617 nQPlan = 0;
6618#endif /* SQLITE_TEST // Testing and debugging use only */
6619
drh29dda4a2005-07-21 18:23:20 +00006620 /* Record the continuation address in the WhereInfo structure. Then
6621 ** clean up and return.
6622 */
drh75897232000-05-29 14:26:00 +00006623 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00006624
6625 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00006626whereBeginError:
drh8b307fb2010-04-06 15:57:05 +00006627 if( pWInfo ){
6628 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
6629 whereInfoFree(db, pWInfo);
6630 }
drhe23399f2005-07-22 00:31:39 +00006631 return 0;
drh75897232000-05-29 14:26:00 +00006632}
6633
6634/*
drhc27a1ce2002-06-14 20:58:45 +00006635** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00006636** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00006637*/
danielk19774adee202004-05-08 08:23:19 +00006638void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00006639 Parse *pParse = pWInfo->pParse;
6640 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00006641 int i;
drh6b563442001-11-07 16:48:26 +00006642 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00006643 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00006644 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00006645
drh9012bcb2004-12-19 00:11:35 +00006646 /* Generate loop termination code.
6647 */
drhceea3322009-04-23 13:22:42 +00006648 sqlite3ExprCacheClear(pParse);
drhc01a3c12009-12-16 22:10:49 +00006649 for(i=pWInfo->nLevel-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00006650 pLevel = &pWInfo->a[i];
drhb3190c12008-12-08 21:37:14 +00006651 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00006652 if( pLevel->op!=OP_Noop ){
drh66a51672008-01-03 00:01:23 +00006653 sqlite3VdbeAddOp2(v, pLevel->op, pLevel->p1, pLevel->p2);
drhd1d38482008-10-07 23:46:38 +00006654 sqlite3VdbeChangeP5(v, pLevel->p5);
drh19a775c2000-06-05 18:54:46 +00006655 }
drh111a6a72008-12-21 03:51:16 +00006656 if( pLevel->plan.wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
drh72e8fa42007-03-28 14:30:06 +00006657 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00006658 int j;
drhb3190c12008-12-08 21:37:14 +00006659 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh111a6a72008-12-21 03:51:16 +00006660 for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00006661 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
drh2d96b932013-02-08 18:48:23 +00006662 sqlite3VdbeAddOp2(v, pIn->eEndLoopOp, pIn->iCur, pIn->addrInTop);
drhb3190c12008-12-08 21:37:14 +00006663 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00006664 }
drh111a6a72008-12-21 03:51:16 +00006665 sqlite3DbFree(db, pLevel->u.in.aInLoop);
drhd99f7062002-06-08 23:25:08 +00006666 }
drhb3190c12008-12-08 21:37:14 +00006667 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhad2d8302002-05-24 20:31:36 +00006668 if( pLevel->iLeftJoin ){
6669 int addr;
drh3c84ddf2008-01-09 02:15:38 +00006670 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin);
drh35451c62009-11-12 04:26:39 +00006671 assert( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
6672 || (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 );
6673 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0 ){
6674 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
6675 }
drh9012bcb2004-12-19 00:11:35 +00006676 if( pLevel->iIdxCur>=0 ){
drh3c84ddf2008-01-09 02:15:38 +00006677 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00006678 }
drh336a5302009-04-24 15:46:21 +00006679 if( pLevel->op==OP_Return ){
6680 sqlite3VdbeAddOp2(v, OP_Gosub, pLevel->p1, pLevel->addrFirst);
6681 }else{
6682 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
6683 }
drhd654be82005-09-20 17:42:23 +00006684 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00006685 }
drh19a775c2000-06-05 18:54:46 +00006686 }
drh9012bcb2004-12-19 00:11:35 +00006687
6688 /* The "break" point is here, just past the end of the outer loop.
6689 ** Set it.
6690 */
danielk19774adee202004-05-08 08:23:19 +00006691 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00006692
drh29dda4a2005-07-21 18:23:20 +00006693 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00006694 */
drhc01a3c12009-12-16 22:10:49 +00006695 assert( pWInfo->nLevel==1 || pWInfo->nLevel==pTabList->nSrc );
6696 for(i=0, pLevel=pWInfo->a; i<pWInfo->nLevel; i++, pLevel++){
danbfca6a42012-08-24 10:52:35 +00006697 Index *pIdx = 0;
drh29dda4a2005-07-21 18:23:20 +00006698 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00006699 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00006700 assert( pTab!=0 );
drh4139c992010-04-07 14:59:45 +00006701 if( (pTab->tabFlags & TF_Ephemeral)==0
6702 && pTab->pSelect==0
drh9ef61f42011-10-07 14:40:59 +00006703 && (pWInfo->wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0
drh4139c992010-04-07 14:59:45 +00006704 ){
drh8b307fb2010-04-06 15:57:05 +00006705 int ws = pLevel->plan.wsFlags;
6706 if( !pWInfo->okOnePass && (ws & WHERE_IDX_ONLY)==0 ){
drh6df2acd2008-12-28 16:55:25 +00006707 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
6708 }
drhf12cde52010-04-08 17:28:00 +00006709 if( (ws & WHERE_INDEXED)!=0 && (ws & WHERE_TEMP_INDEX)==0 ){
drh6df2acd2008-12-28 16:55:25 +00006710 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
6711 }
drh9012bcb2004-12-19 00:11:35 +00006712 }
6713
danielk197721de2e72007-11-29 17:43:27 +00006714 /* If this scan uses an index, make code substitutions to read data
6715 ** from the index in preference to the table. Sometimes, this means
6716 ** the table need never be read from. This is a performance boost,
6717 ** as the vdbe level waits until the table is read before actually
6718 ** seeking the table cursor to the record corresponding to the current
6719 ** position in the index.
drh9012bcb2004-12-19 00:11:35 +00006720 **
6721 ** Calls to the code generator in between sqlite3WhereBegin and
6722 ** sqlite3WhereEnd will have created code that references the table
6723 ** directly. This loop scans all that code looking for opcodes
6724 ** that reference the table and converts them into opcodes that
6725 ** reference the index.
6726 */
danbfca6a42012-08-24 10:52:35 +00006727 if( pLevel->plan.wsFlags & WHERE_INDEXED ){
6728 pIdx = pLevel->plan.u.pIdx;
6729 }else if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drhd40e2082012-08-24 23:24:15 +00006730 pIdx = pLevel->u.pCovidx;
danbfca6a42012-08-24 10:52:35 +00006731 }
6732 if( pIdx && !db->mallocFailed){
danielk1977f0113002006-01-24 12:09:17 +00006733 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00006734 VdbeOp *pOp;
drh9012bcb2004-12-19 00:11:35 +00006735
drh9012bcb2004-12-19 00:11:35 +00006736 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
6737 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00006738 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00006739 if( pOp->p1!=pLevel->iTabCur ) continue;
6740 if( pOp->opcode==OP_Column ){
drh9012bcb2004-12-19 00:11:35 +00006741 for(j=0; j<pIdx->nColumn; j++){
6742 if( pOp->p2==pIdx->aiColumn[j] ){
6743 pOp->p2 = j;
danielk197721de2e72007-11-29 17:43:27 +00006744 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00006745 break;
6746 }
6747 }
drh35451c62009-11-12 04:26:39 +00006748 assert( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
6749 || j<pIdx->nColumn );
drhf0863fe2005-06-12 21:35:51 +00006750 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00006751 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00006752 pOp->opcode = OP_IdxRowid;
drh9012bcb2004-12-19 00:11:35 +00006753 }
6754 }
drh6b563442001-11-07 16:48:26 +00006755 }
drh19a775c2000-06-05 18:54:46 +00006756 }
drh9012bcb2004-12-19 00:11:35 +00006757
6758 /* Final cleanup
6759 */
drhf12cde52010-04-08 17:28:00 +00006760 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
6761 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00006762 return;
6763}