blob: 41b0e7a48824e70d567184a9d33428182201e139 [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
53** objects using (iTab,prereq,iOb,nOb) as the primary key. Note that the
54** 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[] */
drhf1b5f5b2013-05-02 00:15:01 +000061 u16 iOb, nOb; /* ORDER BY terms satisfied by this strategy */
62 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 */
65 u32 wsFlags; /* WHERE_* flags describing the plan */
drh5346e952013-05-08 14:14:26 +000066 union {
67 struct { /* Information for internal btree tables */
68 int nEq; /* Number of equality constraints */
69 Index *pIndex; /* Index used, or NULL */
70 } btree;
71 struct { /* Information for virtualt tables */
72 int idxNum; /* Index number */
73 int needFree; /* True if sqlite3_free(idxStr) is needed */
74 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 */
drha18f3d22013-05-08 03:05:41 +000089 WhereLoop **aLoop; /* Array of WhereLoop objects implementing this path */
drhf1b5f5b2013-05-02 00:15:01 +000090};
drh0aa74ed2005-07-16 13:33:20 +000091
92/*
drh75897232000-05-29 14:26:00 +000093** The query generator uses an array of instances of this structure to
94** help it analyze the subexpressions of the WHERE clause. Each WHERE
drh61495262009-04-22 15:32:59 +000095** clause subexpression is separated from the others by AND operators,
96** usually, or sometimes subexpressions separated by OR.
drh51669862004-12-18 18:40:26 +000097**
drh0fcef5e2005-07-19 17:38:22 +000098** All WhereTerms are collected into a single WhereClause structure.
99** The following identity holds:
drh51669862004-12-18 18:40:26 +0000100**
drh0fcef5e2005-07-19 17:38:22 +0000101** WhereTerm.pWC->a[WhereTerm.idx] == WhereTerm
drh51669862004-12-18 18:40:26 +0000102**
drh0fcef5e2005-07-19 17:38:22 +0000103** When a term is of the form:
104**
105** X <op> <expr>
106**
107** where X is a column name and <op> is one of certain operators,
drh700a2262008-12-17 19:22:15 +0000108** then WhereTerm.leftCursor and WhereTerm.u.leftColumn record the
109** cursor number and column number for X. WhereTerm.eOperator records
drh51147ba2005-07-23 22:59:55 +0000110** the <op> using a bitmask encoding defined by WO_xxx below. The
111** use of a bitmask encoding for the operator allows us to search
112** quickly for terms that match any of several different operators.
drh0fcef5e2005-07-19 17:38:22 +0000113**
drh700a2262008-12-17 19:22:15 +0000114** A WhereTerm might also be two or more subterms connected by OR:
115**
116** (t1.X <op> <expr>) OR (t1.Y <op> <expr>) OR ....
117**
118** In this second case, wtFlag as the TERM_ORINFO set and eOperator==WO_OR
119** and the WhereTerm.u.pOrInfo field points to auxiliary information that
120** is collected about the
121**
122** If a term in the WHERE clause does not match either of the two previous
123** categories, then eOperator==0. The WhereTerm.pExpr field is still set
124** to the original subexpression content and wtFlags is set up appropriately
125** but no other fields in the WhereTerm object are meaningful.
126**
127** When eOperator!=0, prereqRight and prereqAll record sets of cursor numbers,
drh111a6a72008-12-21 03:51:16 +0000128** but they do so indirectly. A single WhereMaskSet structure translates
drh51669862004-12-18 18:40:26 +0000129** cursor number into bits and the translated bit is stored in the prereq
130** fields. The translation is used in order to maximize the number of
131** bits that will fit in a Bitmask. The VDBE cursor numbers might be
132** spread out over the non-negative integers. For example, the cursor
drh111a6a72008-12-21 03:51:16 +0000133** numbers might be 3, 8, 9, 10, 20, 23, 41, and 45. The WhereMaskSet
drh51669862004-12-18 18:40:26 +0000134** translates these sparse cursor numbers into consecutive integers
135** beginning with 0 in order to make the best possible use of the available
136** bits in the Bitmask. So, in the example above, the cursor numbers
137** would be mapped into integers 0 through 7.
drh6a1e0712008-12-05 15:24:15 +0000138**
139** The number of terms in a join is limited by the number of bits
140** in prereqRight and prereqAll. The default is 64 bits, hence SQLite
141** is only able to process joins with 64 or fewer tables.
drh75897232000-05-29 14:26:00 +0000142*/
drh0aa74ed2005-07-16 13:33:20 +0000143struct WhereTerm {
drh165be382008-12-05 02:36:33 +0000144 Expr *pExpr; /* Pointer to the subexpression that is this term */
drhec1724e2008-12-09 01:32:03 +0000145 int iParent; /* Disable pWC->a[iParent] when this term disabled */
146 int leftCursor; /* Cursor number of X in "X <op> <expr>" */
drh700a2262008-12-17 19:22:15 +0000147 union {
148 int leftColumn; /* Column number of X in "X <op> <expr>" */
drh7a5bcc02013-01-16 17:08:58 +0000149 WhereOrInfo *pOrInfo; /* Extra information if (eOperator & WO_OR)!=0 */
150 WhereAndInfo *pAndInfo; /* Extra information if (eOperator& WO_AND)!=0 */
drh700a2262008-12-17 19:22:15 +0000151 } u;
drhb52076c2006-01-23 13:22:09 +0000152 u16 eOperator; /* A WO_xx value describing <op> */
drh165be382008-12-05 02:36:33 +0000153 u8 wtFlags; /* TERM_xxx bit flags. See below */
drh45b1ee42005-08-02 17:48:22 +0000154 u8 nChild; /* Number of children that must disable us */
drh0fcef5e2005-07-19 17:38:22 +0000155 WhereClause *pWC; /* The clause this term is part of */
drh165be382008-12-05 02:36:33 +0000156 Bitmask prereqRight; /* Bitmask of tables used by pExpr->pRight */
157 Bitmask prereqAll; /* Bitmask of tables referenced by pExpr */
drh75897232000-05-29 14:26:00 +0000158};
159
160/*
drh165be382008-12-05 02:36:33 +0000161** Allowed values of WhereTerm.wtFlags
drh0aa74ed2005-07-16 13:33:20 +0000162*/
drh633e6d52008-07-28 19:34:53 +0000163#define TERM_DYNAMIC 0x01 /* Need to call sqlite3ExprDelete(db, pExpr) */
drh6c30be82005-07-29 15:10:17 +0000164#define TERM_VIRTUAL 0x02 /* Added by the optimizer. Do not code */
165#define TERM_CODED 0x04 /* This term is already coded */
drh45b1ee42005-08-02 17:48:22 +0000166#define TERM_COPIED 0x08 /* Has a child */
drh700a2262008-12-17 19:22:15 +0000167#define TERM_ORINFO 0x10 /* Need to free the WhereTerm.u.pOrInfo object */
168#define TERM_ANDINFO 0x20 /* Need to free the WhereTerm.u.pAndInfo obj */
169#define TERM_OR_OK 0x40 /* Used during OR-clause processing */
drhfaacf172011-08-12 01:51:45 +0000170#ifdef SQLITE_ENABLE_STAT3
drh59b61882011-02-11 02:43:14 +0000171# define TERM_VNULL 0x80 /* Manufactured x>NULL or x<=NULL term */
172#else
drhd3ed7342011-09-21 00:09:41 +0000173# define TERM_VNULL 0x00 /* Disabled if not using stat3 */
drh59b61882011-02-11 02:43:14 +0000174#endif
drh0aa74ed2005-07-16 13:33:20 +0000175
176/*
drh1c8148f2013-05-04 20:25:23 +0000177** An instance of the WhereScan object is used as an iterator for locating
178** terms in the WHERE clause that are useful to the query planner.
179*/
180struct WhereScan {
181 WhereTerm *pCurrent; /* Most recent match */
182 WhereClause *pOrigWC; /* Original, innermost WhereClause */
183 WhereClause *pWC; /* WhereClause currently being scanned */
184 char *zCollName; /* Must have this collating sequence, if not NULL */
185 char idxaff; /* Must match this affinity, if zCollName!=NULL */
186 unsigned char nEquiv; /* Number of entries in aEquiv[] */
187 unsigned char iEquiv; /* Next unused slot in aEquiv[] */
188 u32 opMask; /* Acceptable operators */
189 int k; /* Resume scanning at this->pWC->a[this->k] */
190 int aEquiv[22]; /* Cursor,Column pairs for equivalence classes */
191};
192
193/*
drh0aa74ed2005-07-16 13:33:20 +0000194** An instance of the following structure holds all information about a
195** WHERE clause. Mostly this is a container for one or more WhereTerms.
drh8871ef52011-10-07 13:33:10 +0000196**
197** Explanation of pOuter: For a WHERE clause of the form
198**
199** a AND ((b AND c) OR (d AND e)) AND f
200**
201** There are separate WhereClause objects for the whole clause and for
202** the subclauses "(b AND c)" and "(d AND e)". The pOuter field of the
203** subclauses points to the WhereClause object for the whole clause.
drh0aa74ed2005-07-16 13:33:20 +0000204*/
drh0aa74ed2005-07-16 13:33:20 +0000205struct WhereClause {
drhfe05af82005-07-21 03:14:59 +0000206 Parse *pParse; /* The parser context */
drh111a6a72008-12-21 03:51:16 +0000207 WhereMaskSet *pMaskSet; /* Mapping of table cursor numbers to bitmasks */
drh8871ef52011-10-07 13:33:10 +0000208 WhereClause *pOuter; /* Outer conjunction */
drh29435252008-12-28 18:35:08 +0000209 u8 op; /* Split operator. TK_AND or TK_OR */
drh9ef61f42011-10-07 14:40:59 +0000210 u16 wctrlFlags; /* Might include WHERE_AND_ONLY */
drh0aa74ed2005-07-16 13:33:20 +0000211 int nTerm; /* Number of terms */
212 int nSlot; /* Number of entries in a[] */
drh51147ba2005-07-23 22:59:55 +0000213 WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
drh50d654d2009-06-03 01:24:54 +0000214#if defined(SQLITE_SMALL_STACK)
215 WhereTerm aStatic[1]; /* Initial static space for a[] */
216#else
217 WhereTerm aStatic[8]; /* Initial static space for a[] */
218#endif
drhe23399f2005-07-22 00:31:39 +0000219};
220
221/*
drh700a2262008-12-17 19:22:15 +0000222** A WhereTerm with eOperator==WO_OR has its u.pOrInfo pointer set to
223** a dynamically allocated instance of the following structure.
224*/
225struct WhereOrInfo {
drh111a6a72008-12-21 03:51:16 +0000226 WhereClause wc; /* Decomposition into subterms */
drh1a58fe02008-12-20 02:06:13 +0000227 Bitmask indexable; /* Bitmask of all indexable tables in the clause */
drh700a2262008-12-17 19:22:15 +0000228};
229
230/*
231** A WhereTerm with eOperator==WO_AND has its u.pAndInfo pointer set to
232** a dynamically allocated instance of the following structure.
233*/
234struct WhereAndInfo {
drh29435252008-12-28 18:35:08 +0000235 WhereClause wc; /* The subexpression broken out */
drh700a2262008-12-17 19:22:15 +0000236};
237
238/*
drh6a3ea0e2003-05-02 14:32:12 +0000239** An instance of the following structure keeps track of a mapping
drh0aa74ed2005-07-16 13:33:20 +0000240** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
drh51669862004-12-18 18:40:26 +0000241**
242** The VDBE cursor numbers are small integers contained in
243** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
244** clause, the cursor numbers might not begin with 0 and they might
245** contain gaps in the numbering sequence. But we want to make maximum
246** use of the bits in our bitmasks. This structure provides a mapping
247** from the sparse cursor numbers into consecutive integers beginning
248** with 0.
249**
drh111a6a72008-12-21 03:51:16 +0000250** If WhereMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
drh51669862004-12-18 18:40:26 +0000251** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
252**
253** For example, if the WHERE clause expression used these VDBE
drh111a6a72008-12-21 03:51:16 +0000254** cursors: 4, 5, 8, 29, 57, 73. Then the WhereMaskSet structure
drh51669862004-12-18 18:40:26 +0000255** would map those cursor numbers into bits 0 through 5.
256**
257** Note that the mapping is not necessarily ordered. In the example
258** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
259** 57->5, 73->4. Or one of 719 other combinations might be used. It
260** does not really matter. What is important is that sparse cursor
261** numbers all get mapped into bit numbers that begin with 0 and contain
262** no gaps.
drh6a3ea0e2003-05-02 14:32:12 +0000263*/
drh111a6a72008-12-21 03:51:16 +0000264struct WhereMaskSet {
drh1398ad32005-01-19 23:24:50 +0000265 int n; /* Number of assigned cursor values */
danielk197723432972008-11-17 16:42:00 +0000266 int ix[BMS]; /* Cursor assigned to each bit */
drh6a3ea0e2003-05-02 14:32:12 +0000267};
268
drh111a6a72008-12-21 03:51:16 +0000269/*
270** A WhereCost object records a lookup strategy and the estimated
271** cost of pursuing that strategy.
272*/
273struct WhereCost {
274 WherePlan plan; /* The lookup strategy */
275 double rCost; /* Overall cost of pursuing this search strategy */
dan5236ac12009-08-13 07:09:33 +0000276 Bitmask used; /* Bitmask of cursors used by this plan */
drh111a6a72008-12-21 03:51:16 +0000277};
drh0aa74ed2005-07-16 13:33:20 +0000278
drh6a3ea0e2003-05-02 14:32:12 +0000279/*
drh1c8148f2013-05-04 20:25:23 +0000280** This object is a factory for WhereLoop objects for a particular query.
281*/
282struct WhereLoopBuilder {
283 WhereInfo *pWInfo; /* Information about this WHERE */
284 sqlite3 *db; /* Database connection */
285 Parse *pParse; /* Parsing context */
286 WhereClause *pWC; /* WHERE clause terms */
287 SrcList *pTabList; /* FROM clause */
288 ExprList *pOrderBy; /* ORDER BY clause */
289 WhereLoop *pNew; /* Template WhereLoop */
290};
291
292/*
drh51147ba2005-07-23 22:59:55 +0000293** Bitmasks for the operators that indices are able to exploit. An
294** OR-ed combination of these values can be used when searching for
295** terms in the where clause.
296*/
drh165be382008-12-05 02:36:33 +0000297#define WO_IN 0x001
298#define WO_EQ 0x002
drh51147ba2005-07-23 22:59:55 +0000299#define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
300#define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
301#define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
302#define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
drh165be382008-12-05 02:36:33 +0000303#define WO_MATCH 0x040
304#define WO_ISNULL 0x080
drh700a2262008-12-17 19:22:15 +0000305#define WO_OR 0x100 /* Two or more OR-connected terms */
306#define WO_AND 0x200 /* Two or more AND-connected terms */
drh7a5bcc02013-01-16 17:08:58 +0000307#define WO_EQUIV 0x400 /* Of the form A==B, both columns */
drh534230c2011-01-22 00:10:45 +0000308#define WO_NOOP 0x800 /* This term does not restrict search space */
drh51147ba2005-07-23 22:59:55 +0000309
drhec1724e2008-12-09 01:32:03 +0000310#define WO_ALL 0xfff /* Mask of all possible WO_* values */
drh1a58fe02008-12-20 02:06:13 +0000311#define WO_SINGLE 0x0ff /* Mask of all non-compound WO_* values */
drhec1724e2008-12-09 01:32:03 +0000312
drh51147ba2005-07-23 22:59:55 +0000313/*
drh700a2262008-12-17 19:22:15 +0000314** Value for wsFlags returned by bestIndex() and stored in
315** WhereLevel.wsFlags. These flags determine which search
316** strategies are appropriate.
drhf2d315d2007-01-25 16:56:06 +0000317**
drh165be382008-12-05 02:36:33 +0000318** The least significant 12 bits is reserved as a mask for WO_ values above.
drh700a2262008-12-17 19:22:15 +0000319** The WhereLevel.wsFlags field is usually set to WO_IN|WO_EQ|WO_ISNULL.
320** But if the table is the right table of a left join, WhereLevel.wsFlags
321** is set to WO_IN|WO_EQ. The WhereLevel.wsFlags field can then be used as
drhf2d315d2007-01-25 16:56:06 +0000322** the "op" parameter to findTerm when we are resolving equality constraints.
323** ISNULL constraints will then not be used on the right table of a left
324** join. Tickets #2177 and #2189.
drh51147ba2005-07-23 22:59:55 +0000325*/
drh165be382008-12-05 02:36:33 +0000326#define WHERE_ROWID_EQ 0x00001000 /* rowid=EXPR or rowid IN (...) */
327#define WHERE_ROWID_RANGE 0x00002000 /* rowid<EXPR and/or rowid>EXPR */
drh5346e952013-05-08 14:14:26 +0000328#define WHERE_IPK 0x00008000 /* x is the INTEGER PRIMARY KEY */
drh46619d62009-04-24 14:51:42 +0000329#define WHERE_COLUMN_EQ 0x00010000 /* x=EXPR or x IN (...) or x IS NULL */
drh165be382008-12-05 02:36:33 +0000330#define WHERE_COLUMN_RANGE 0x00020000 /* x<EXPR and/or x>EXPR */
331#define WHERE_COLUMN_IN 0x00040000 /* x IN (...) */
drh46619d62009-04-24 14:51:42 +0000332#define WHERE_COLUMN_NULL 0x00080000 /* x IS NULL */
333#define WHERE_INDEXED 0x000f0000 /* Anything that uses an index */
drh75ad2602010-10-21 02:05:06 +0000334#define WHERE_NOT_FULLSCAN 0x100f3000 /* Does not do a full table scan */
drh281bbe22012-10-16 23:17:14 +0000335#define WHERE_IN_ABLE 0x080f1000 /* Able to support an IN operator */
drh165be382008-12-05 02:36:33 +0000336#define WHERE_TOP_LIMIT 0x00100000 /* x<EXPR or x<=EXPR constraint */
337#define WHERE_BTM_LIMIT 0x00200000 /* x>EXPR or x>=EXPR constraint */
drh04098e62010-11-15 21:50:19 +0000338#define WHERE_BOTH_LIMIT 0x00300000 /* Both x>EXPR and x<EXPR */
drh60441af2012-09-29 19:10:29 +0000339#define WHERE_IDX_ONLY 0x00400000 /* Use index only - omit table */
drhd663b5b2012-10-03 00:25:54 +0000340#define WHERE_ORDERED 0x00800000 /* Output will appear in correct order */
drh60441af2012-09-29 19:10:29 +0000341#define WHERE_REVERSE 0x01000000 /* Scan in reverse order */
342#define WHERE_UNIQUE 0x02000000 /* Selects no more than one row */
343#define WHERE_ALL_UNIQUE 0x04000000 /* This and all prior have one row */
drh8a1b87c2013-03-27 15:04:28 +0000344#define WHERE_OB_UNIQUE 0x00004000 /* Values in ORDER BY columns are
345 ** different for every output row */
drh165be382008-12-05 02:36:33 +0000346#define WHERE_VIRTUALTABLE 0x08000000 /* Use virtual-table processing */
drh5346e952013-05-08 14:14:26 +0000347#define WHERE_FREEIDXSTR 0x04000000 /* neeed to free WhereLoop.u.idxStr */
drh165be382008-12-05 02:36:33 +0000348#define WHERE_MULTI_OR 0x10000000 /* OR using multiple indices */
drh8b307fb2010-04-06 15:57:05 +0000349#define WHERE_TEMP_INDEX 0x20000000 /* Uses an ephemeral index */
dan38cc40c2011-06-30 20:17:15 +0000350#define WHERE_DISTINCT 0x40000000 /* Correct order for DISTINCT */
drh3f4d1d12012-09-15 18:45:54 +0000351#define WHERE_COVER_SCAN 0x80000000 /* Full scan of a covering index */
drh51147ba2005-07-23 22:59:55 +0000352
353/*
drh56f1b992012-09-25 14:29:39 +0000354** This module contains many separate subroutines that work together to
355** find the best indices to use for accessing a particular table in a query.
356** An instance of the following structure holds context information about the
357** index search so that it can be more easily passed between the various
358** routines.
359*/
360typedef struct WhereBestIdx WhereBestIdx;
361struct WhereBestIdx {
362 Parse *pParse; /* Parser context */
363 WhereClause *pWC; /* The WHERE clause */
364 struct SrcList_item *pSrc; /* The FROM clause term to search */
365 Bitmask notReady; /* Mask of cursors not available */
366 Bitmask notValid; /* Cursors not available for any purpose */
367 ExprList *pOrderBy; /* The ORDER BY clause */
368 ExprList *pDistinct; /* The select-list if query is DISTINCT */
369 sqlite3_index_info **ppIdxInfo; /* Index information passed to xBestIndex */
drh9cd1c992012-09-25 20:43:35 +0000370 int i, n; /* Which loop is being coded; # of loops */
drh46c35f92012-09-26 23:17:01 +0000371 WhereLevel *aLevel; /* Info about outer loops */
drh56f1b992012-09-25 14:29:39 +0000372 WhereCost cost; /* Lowest cost query plan */
373};
374
375/*
drhd663b5b2012-10-03 00:25:54 +0000376** Return TRUE if the probe cost is less than the baseline cost
377*/
378static int compareCost(const WhereCost *pProbe, const WhereCost *pBaseline){
379 if( pProbe->rCost<pBaseline->rCost ) return 1;
380 if( pProbe->rCost>pBaseline->rCost ) return 0;
381 if( pProbe->plan.nOBSat>pBaseline->plan.nOBSat ) return 1;
382 if( pProbe->plan.nRow<pBaseline->plan.nRow ) return 1;
383 return 0;
384}
385
386/*
drh0aa74ed2005-07-16 13:33:20 +0000387** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000388*/
drh7b4fc6a2007-02-06 13:26:32 +0000389static void whereClauseInit(
390 WhereClause *pWC, /* The WhereClause to be initialized */
391 Parse *pParse, /* The parsing context */
drh9ef61f42011-10-07 14:40:59 +0000392 WhereMaskSet *pMaskSet, /* Mapping from table cursor numbers to bitmasks */
393 u16 wctrlFlags /* Might include WHERE_AND_ONLY */
drh7b4fc6a2007-02-06 13:26:32 +0000394){
drhfe05af82005-07-21 03:14:59 +0000395 pWC->pParse = pParse;
drh7b4fc6a2007-02-06 13:26:32 +0000396 pWC->pMaskSet = pMaskSet;
drh8871ef52011-10-07 13:33:10 +0000397 pWC->pOuter = 0;
drh0aa74ed2005-07-16 13:33:20 +0000398 pWC->nTerm = 0;
drhcad651e2007-04-20 12:22:01 +0000399 pWC->nSlot = ArraySize(pWC->aStatic);
drh0aa74ed2005-07-16 13:33:20 +0000400 pWC->a = pWC->aStatic;
drh9ef61f42011-10-07 14:40:59 +0000401 pWC->wctrlFlags = wctrlFlags;
drh0aa74ed2005-07-16 13:33:20 +0000402}
403
drh700a2262008-12-17 19:22:15 +0000404/* Forward reference */
405static void whereClauseClear(WhereClause*);
406
407/*
408** Deallocate all memory associated with a WhereOrInfo object.
409*/
410static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000411 whereClauseClear(&p->wc);
412 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000413}
414
415/*
416** Deallocate all memory associated with a WhereAndInfo object.
417*/
418static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000419 whereClauseClear(&p->wc);
420 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000421}
422
drh0aa74ed2005-07-16 13:33:20 +0000423/*
424** Deallocate a WhereClause structure. The WhereClause structure
425** itself is not freed. This routine is the inverse of whereClauseInit().
426*/
427static void whereClauseClear(WhereClause *pWC){
428 int i;
429 WhereTerm *a;
drh633e6d52008-07-28 19:34:53 +0000430 sqlite3 *db = pWC->pParse->db;
drh0aa74ed2005-07-16 13:33:20 +0000431 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
drh165be382008-12-05 02:36:33 +0000432 if( a->wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000433 sqlite3ExprDelete(db, a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000434 }
drh700a2262008-12-17 19:22:15 +0000435 if( a->wtFlags & TERM_ORINFO ){
436 whereOrInfoDelete(db, a->u.pOrInfo);
437 }else if( a->wtFlags & TERM_ANDINFO ){
438 whereAndInfoDelete(db, a->u.pAndInfo);
439 }
drh0aa74ed2005-07-16 13:33:20 +0000440 }
441 if( pWC->a!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000442 sqlite3DbFree(db, pWC->a);
drh0aa74ed2005-07-16 13:33:20 +0000443 }
444}
445
446/*
drh6a1e0712008-12-05 15:24:15 +0000447** Add a single new WhereTerm entry to the WhereClause object pWC.
448** The new WhereTerm object is constructed from Expr p and with wtFlags.
449** The index in pWC->a[] of the new WhereTerm is returned on success.
450** 0 is returned if the new WhereTerm could not be added due to a memory
451** allocation error. The memory allocation failure will be recorded in
452** the db->mallocFailed flag so that higher-level functions can detect it.
453**
454** This routine will increase the size of the pWC->a[] array as necessary.
drh9eb20282005-08-24 03:52:18 +0000455**
drh165be382008-12-05 02:36:33 +0000456** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
drh6a1e0712008-12-05 15:24:15 +0000457** for freeing the expression p is assumed by the WhereClause object pWC.
458** This is true even if this routine fails to allocate a new WhereTerm.
drhb63a53d2007-03-31 01:34:44 +0000459**
drh9eb20282005-08-24 03:52:18 +0000460** WARNING: This routine might reallocate the space used to store
drh909626d2008-05-30 14:58:37 +0000461** WhereTerms. All pointers to WhereTerms should be invalidated after
drh9eb20282005-08-24 03:52:18 +0000462** calling this routine. Such pointers may be reinitialized by referencing
463** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000464*/
drhec1724e2008-12-09 01:32:03 +0000465static int whereClauseInsert(WhereClause *pWC, Expr *p, u8 wtFlags){
drh0aa74ed2005-07-16 13:33:20 +0000466 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000467 int idx;
drhe9cdcea2010-07-22 22:40:03 +0000468 testcase( wtFlags & TERM_VIRTUAL ); /* EV: R-00211-15100 */
drh0aa74ed2005-07-16 13:33:20 +0000469 if( pWC->nTerm>=pWC->nSlot ){
470 WhereTerm *pOld = pWC->a;
drh633e6d52008-07-28 19:34:53 +0000471 sqlite3 *db = pWC->pParse->db;
472 pWC->a = sqlite3DbMallocRaw(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
drhb63a53d2007-03-31 01:34:44 +0000473 if( pWC->a==0 ){
drh165be382008-12-05 02:36:33 +0000474 if( wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000475 sqlite3ExprDelete(db, p);
drhb63a53d2007-03-31 01:34:44 +0000476 }
drhf998b732007-11-26 13:36:00 +0000477 pWC->a = pOld;
drhb63a53d2007-03-31 01:34:44 +0000478 return 0;
479 }
drh0aa74ed2005-07-16 13:33:20 +0000480 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
481 if( pOld!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000482 sqlite3DbFree(db, pOld);
drh0aa74ed2005-07-16 13:33:20 +0000483 }
drh6a1e0712008-12-05 15:24:15 +0000484 pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
drh0aa74ed2005-07-16 13:33:20 +0000485 }
drh6a1e0712008-12-05 15:24:15 +0000486 pTerm = &pWC->a[idx = pWC->nTerm++];
drh7ee751d2012-12-19 15:53:51 +0000487 pTerm->pExpr = sqlite3ExprSkipCollate(p);
drh165be382008-12-05 02:36:33 +0000488 pTerm->wtFlags = wtFlags;
drh0fcef5e2005-07-19 17:38:22 +0000489 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000490 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000491 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000492}
drh75897232000-05-29 14:26:00 +0000493
494/*
drh51669862004-12-18 18:40:26 +0000495** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000496** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000497** operator specified in the op parameter. The WhereClause structure
498** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000499**
drh51669862004-12-18 18:40:26 +0000500** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
501** \________/ \_______________/ \________________/
502** slot[0] slot[1] slot[2]
503**
504** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000505** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000506**
drh51147ba2005-07-23 22:59:55 +0000507** In the previous sentence and in the diagram, "slot[]" refers to
drh902b9ee2008-12-05 17:17:07 +0000508** the WhereClause.a[] array. The slot[] array grows as needed to contain
drh51147ba2005-07-23 22:59:55 +0000509** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000510*/
drh6c30be82005-07-29 15:10:17 +0000511static void whereSplit(WhereClause *pWC, Expr *pExpr, int op){
drh29435252008-12-28 18:35:08 +0000512 pWC->op = (u8)op;
drh0aa74ed2005-07-16 13:33:20 +0000513 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000514 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000515 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000516 }else{
drh6c30be82005-07-29 15:10:17 +0000517 whereSplit(pWC, pExpr->pLeft, op);
518 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000519 }
drh75897232000-05-29 14:26:00 +0000520}
521
522/*
drh61495262009-04-22 15:32:59 +0000523** Initialize an expression mask set (a WhereMaskSet object)
drh6a3ea0e2003-05-02 14:32:12 +0000524*/
525#define initMaskSet(P) memset(P, 0, sizeof(*P))
526
527/*
drh1398ad32005-01-19 23:24:50 +0000528** Return the bitmask for the given cursor number. Return 0 if
529** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000530*/
drh111a6a72008-12-21 03:51:16 +0000531static Bitmask getMask(WhereMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000532 int i;
drhfcd71b62011-04-05 22:08:24 +0000533 assert( pMaskSet->n<=(int)sizeof(Bitmask)*8 );
drh6a3ea0e2003-05-02 14:32:12 +0000534 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000535 if( pMaskSet->ix[i]==iCursor ){
536 return ((Bitmask)1)<<i;
537 }
drh6a3ea0e2003-05-02 14:32:12 +0000538 }
drh6a3ea0e2003-05-02 14:32:12 +0000539 return 0;
540}
541
542/*
drh1398ad32005-01-19 23:24:50 +0000543** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000544**
545** There is one cursor per table in the FROM clause. The number of
546** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000547** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000548** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000549*/
drh111a6a72008-12-21 03:51:16 +0000550static void createMask(WhereMaskSet *pMaskSet, int iCursor){
drhcad651e2007-04-20 12:22:01 +0000551 assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
drh0fcef5e2005-07-19 17:38:22 +0000552 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000553}
554
555/*
drh75897232000-05-29 14:26:00 +0000556** This routine walks (recursively) an expression tree and generates
557** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000558** tree.
drh75897232000-05-29 14:26:00 +0000559**
560** In order for this routine to work, the calling function must have
drh7d10d5a2008-08-20 16:35:10 +0000561** previously invoked sqlite3ResolveExprNames() on the expression. See
drh75897232000-05-29 14:26:00 +0000562** the header comment on that routine for additional information.
drh7d10d5a2008-08-20 16:35:10 +0000563** The sqlite3ResolveExprNames() routines looks for column names and
drh6a3ea0e2003-05-02 14:32:12 +0000564** sets their opcodes to TK_COLUMN and their Expr.iTable fields to
drh51147ba2005-07-23 22:59:55 +0000565** the VDBE cursor number of the table. This routine just has to
566** translate the cursor numbers into bitmask values and OR all
567** the bitmasks together.
drh75897232000-05-29 14:26:00 +0000568*/
drh111a6a72008-12-21 03:51:16 +0000569static Bitmask exprListTableUsage(WhereMaskSet*, ExprList*);
570static Bitmask exprSelectTableUsage(WhereMaskSet*, Select*);
571static Bitmask exprTableUsage(WhereMaskSet *pMaskSet, Expr *p){
drh51669862004-12-18 18:40:26 +0000572 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000573 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000574 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000575 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000576 return mask;
drh75897232000-05-29 14:26:00 +0000577 }
danielk1977b3bce662005-01-29 08:32:43 +0000578 mask = exprTableUsage(pMaskSet, p->pRight);
579 mask |= exprTableUsage(pMaskSet, p->pLeft);
danielk19776ab3a2e2009-02-19 14:39:25 +0000580 if( ExprHasProperty(p, EP_xIsSelect) ){
581 mask |= exprSelectTableUsage(pMaskSet, p->x.pSelect);
582 }else{
583 mask |= exprListTableUsage(pMaskSet, p->x.pList);
584 }
danielk1977b3bce662005-01-29 08:32:43 +0000585 return mask;
586}
drh111a6a72008-12-21 03:51:16 +0000587static Bitmask exprListTableUsage(WhereMaskSet *pMaskSet, ExprList *pList){
danielk1977b3bce662005-01-29 08:32:43 +0000588 int i;
589 Bitmask mask = 0;
590 if( pList ){
591 for(i=0; i<pList->nExpr; i++){
592 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000593 }
594 }
drh75897232000-05-29 14:26:00 +0000595 return mask;
596}
drh111a6a72008-12-21 03:51:16 +0000597static Bitmask exprSelectTableUsage(WhereMaskSet *pMaskSet, Select *pS){
drha430ae82007-09-12 15:41:01 +0000598 Bitmask mask = 0;
599 while( pS ){
drha464c232011-09-16 19:04:03 +0000600 SrcList *pSrc = pS->pSrc;
drha430ae82007-09-12 15:41:01 +0000601 mask |= exprListTableUsage(pMaskSet, pS->pEList);
drhf5b11382005-09-17 13:07:13 +0000602 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
603 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
604 mask |= exprTableUsage(pMaskSet, pS->pWhere);
605 mask |= exprTableUsage(pMaskSet, pS->pHaving);
drha464c232011-09-16 19:04:03 +0000606 if( ALWAYS(pSrc!=0) ){
drh88501772011-09-16 17:43:06 +0000607 int i;
608 for(i=0; i<pSrc->nSrc; i++){
609 mask |= exprSelectTableUsage(pMaskSet, pSrc->a[i].pSelect);
610 mask |= exprTableUsage(pMaskSet, pSrc->a[i].pOn);
611 }
612 }
drha430ae82007-09-12 15:41:01 +0000613 pS = pS->pPrior;
drhf5b11382005-09-17 13:07:13 +0000614 }
615 return mask;
616}
drh75897232000-05-29 14:26:00 +0000617
618/*
drh487ab3c2001-11-08 00:45:21 +0000619** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000620** allowed for an indexable WHERE clause term. The allowed operators are
drhc27a1ce2002-06-14 20:58:45 +0000621** "=", "<", ">", "<=", ">=", and "IN".
drhe9cdcea2010-07-22 22:40:03 +0000622**
623** IMPLEMENTATION-OF: R-59926-26393 To be usable by an index a term must be
624** of one of the following forms: column = expression column > expression
625** column >= expression column < expression column <= expression
626** expression = column expression > column expression >= column
627** expression < column expression <= column column IN
628** (expression-list) column IN (subquery) column IS NULL
drh487ab3c2001-11-08 00:45:21 +0000629*/
630static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000631 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
632 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
633 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
634 assert( TK_GE==TK_EQ+4 );
drh50b39962006-10-28 00:28:09 +0000635 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL;
drh487ab3c2001-11-08 00:45:21 +0000636}
637
638/*
drh902b9ee2008-12-05 17:17:07 +0000639** Swap two objects of type TYPE.
drh193bd772004-07-20 18:23:14 +0000640*/
641#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
642
643/*
drh909626d2008-05-30 14:58:37 +0000644** Commute a comparison operator. Expressions of the form "X op Y"
drh0fcef5e2005-07-19 17:38:22 +0000645** are converted into "Y op X".
danielk1977eb5453d2007-07-30 14:40:48 +0000646**
mistachkin48864df2013-03-21 21:20:32 +0000647** If left/right precedence rules come into play when determining the
drhae80dde2012-12-06 21:16:43 +0000648** collating
danielk1977eb5453d2007-07-30 14:40:48 +0000649** side of the comparison, it remains associated with the same side after
650** the commutation. So "Y collate NOCASE op X" becomes
drhae80dde2012-12-06 21:16:43 +0000651** "X op Y". This is because any collation sequence on
danielk1977eb5453d2007-07-30 14:40:48 +0000652** the left hand side of a comparison overrides any collation sequence
drhae80dde2012-12-06 21:16:43 +0000653** attached to the right. For the same reason the EP_Collate flag
danielk1977eb5453d2007-07-30 14:40:48 +0000654** is not commuted.
drh193bd772004-07-20 18:23:14 +0000655*/
drh7d10d5a2008-08-20 16:35:10 +0000656static void exprCommute(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000657 u16 expRight = (pExpr->pRight->flags & EP_Collate);
658 u16 expLeft = (pExpr->pLeft->flags & EP_Collate);
drhfe05af82005-07-21 03:14:59 +0000659 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drhae80dde2012-12-06 21:16:43 +0000660 if( expRight==expLeft ){
661 /* Either X and Y both have COLLATE operator or neither do */
662 if( expRight ){
663 /* Both X and Y have COLLATE operators. Make sure X is always
664 ** used by clearing the EP_Collate flag from Y. */
665 pExpr->pRight->flags &= ~EP_Collate;
666 }else if( sqlite3ExprCollSeq(pParse, pExpr->pLeft)!=0 ){
667 /* Neither X nor Y have COLLATE operators, but X has a non-default
668 ** collating sequence. So add the EP_Collate marker on X to cause
669 ** it to be searched first. */
670 pExpr->pLeft->flags |= EP_Collate;
671 }
672 }
drh0fcef5e2005-07-19 17:38:22 +0000673 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
674 if( pExpr->op>=TK_GT ){
675 assert( TK_LT==TK_GT+2 );
676 assert( TK_GE==TK_LE+2 );
677 assert( TK_GT>TK_EQ );
678 assert( TK_GT<TK_LE );
679 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
680 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000681 }
drh193bd772004-07-20 18:23:14 +0000682}
683
684/*
drhfe05af82005-07-21 03:14:59 +0000685** Translate from TK_xx operator to WO_xx bitmask.
686*/
drhec1724e2008-12-09 01:32:03 +0000687static u16 operatorMask(int op){
688 u16 c;
drhfe05af82005-07-21 03:14:59 +0000689 assert( allowedOp(op) );
690 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000691 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000692 }else if( op==TK_ISNULL ){
693 c = WO_ISNULL;
drhfe05af82005-07-21 03:14:59 +0000694 }else{
drhec1724e2008-12-09 01:32:03 +0000695 assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
696 c = (u16)(WO_EQ<<(op-TK_EQ));
drhfe05af82005-07-21 03:14:59 +0000697 }
drh50b39962006-10-28 00:28:09 +0000698 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh51147ba2005-07-23 22:59:55 +0000699 assert( op!=TK_IN || c==WO_IN );
700 assert( op!=TK_EQ || c==WO_EQ );
701 assert( op!=TK_LT || c==WO_LT );
702 assert( op!=TK_LE || c==WO_LE );
703 assert( op!=TK_GT || c==WO_GT );
704 assert( op!=TK_GE || c==WO_GE );
705 return c;
drhfe05af82005-07-21 03:14:59 +0000706}
707
708/*
drh1c8148f2013-05-04 20:25:23 +0000709** Advance to the next WhereTerm that matches according to the criteria
710** established when the pScan object was initialized by whereScanInit().
711** Return NULL if there are no more matching WhereTerms.
712*/
713WhereTerm *whereScanNext(WhereScan *pScan){
714 int iCur; /* The cursor on the LHS of the term */
715 int iColumn; /* The column on the LHS of the term. -1 for IPK */
716 Expr *pX; /* An expression being tested */
717 WhereClause *pWC; /* Shorthand for pScan->pWC */
718 WhereTerm *pTerm; /* The term being tested */
719
720 while( pScan->iEquiv<=pScan->nEquiv ){
721 iCur = pScan->aEquiv[pScan->iEquiv-2];
722 iColumn = pScan->aEquiv[pScan->iEquiv-1];
723 while( (pWC = pScan->pWC)!=0 ){
724 for(pTerm=pWC->a+pScan->k; pScan->k<pWC->nTerm; pScan->k++, pTerm++){
725 if( pTerm->leftCursor==iCur && pTerm->u.leftColumn==iColumn ){
726 if( (pTerm->eOperator & WO_EQUIV)!=0
727 && pScan->nEquiv<ArraySize(pScan->aEquiv)
728 ){
729 int j;
730 pX = sqlite3ExprSkipCollate(pTerm->pExpr->pRight);
731 assert( pX->op==TK_COLUMN );
732 for(j=0; j<pScan->nEquiv; j+=2){
733 if( pScan->aEquiv[j]==pX->iTable
734 && pScan->aEquiv[j+1]==pX->iColumn ){
735 break;
736 }
737 }
738 if( j==pScan->nEquiv ){
739 pScan->aEquiv[j] = pX->iTable;
740 pScan->aEquiv[j+1] = pX->iColumn;
741 pScan->nEquiv += 2;
742 }
743 }
744 if( (pTerm->eOperator & pScan->opMask)!=0 ){
745 /* Verify the affinity and collating sequence match */
746 if( pScan->zCollName && (pTerm->eOperator & WO_ISNULL)==0 ){
747 CollSeq *pColl;
748 pX = pTerm->pExpr;
749 if( !sqlite3IndexAffinityOk(pX, pScan->idxaff) ){
750 continue;
751 }
752 assert(pX->pLeft);
753 pColl = sqlite3BinaryCompareCollSeq(pWC->pParse,
754 pX->pLeft, pX->pRight);
755 if( pColl==0 ) pColl = pWC->pParse->db->pDfltColl;
756 if( sqlite3StrICmp(pColl->zName, pScan->zCollName) ){
757 continue;
758 }
759 }
drha184fb82013-05-08 04:22:59 +0000760 if( (pTerm->eOperator & WO_EQ)!=0
761 && (pX = pTerm->pExpr->pRight)->op==TK_COLUMN
762 && pX->iTable==pScan->aEquiv[0]
763 && pX->iColumn==pScan->aEquiv[1]
764 ){
765 continue;
766 }
drh1c8148f2013-05-04 20:25:23 +0000767 pScan->pCurrent = pTerm;
768 pScan->k++;
769 return pTerm;
770 }
771 }
772 }
773 pWC = pScan->pWC = pScan->pWC->pOuter;
774 pScan->k = 0;
775 }
776 pScan->pWC = pScan->pOrigWC;
777 pScan->k = 0;
778 pScan->iEquiv += 2;
779 }
780 pScan->pCurrent = 0;
781 return 0;
782}
783
784/*
785** Initialize a WHERE clause scanner object. Return a pointer to the
786** first match. Return NULL if there are no matches.
787**
788** The scanner will be searching the WHERE clause pWC. It will look
789** for terms of the form "X <op> <expr>" where X is column iColumn of table
790** iCur. The <op> must be one of the operators described by opMask.
791**
792** If X is not the INTEGER PRIMARY KEY then X must be compatible with
793** index pIdx.
794*/
795WhereTerm *whereScanInit(
796 WhereScan *pScan, /* The WhereScan object being initialized */
797 WhereClause *pWC, /* The WHERE clause to be scanned */
798 int iCur, /* Cursor to scan for */
799 int iColumn, /* Column to scan for */
800 u32 opMask, /* Operator(s) to scan for */
801 Index *pIdx /* Must be compatible with this index */
802){
803 int j;
804
805 memset(pScan, 0, sizeof(*pScan));
806 pScan->pOrigWC = pWC;
807 pScan->pWC = pWC;
808 if( pIdx && iColumn>=0 ){
809 pScan->idxaff = pIdx->pTable->aCol[iColumn].affinity;
810 for(j=0; pIdx->aiColumn[j]!=iColumn; j++){
811 if( NEVER(j>=pIdx->nColumn) ) return 0;
812 }
813 pScan->zCollName = pIdx->azColl[j];
814 }
815 pScan->opMask = opMask;
816 pScan->aEquiv[0] = iCur;
817 pScan->aEquiv[1] = iColumn;
818 pScan->nEquiv = 2;
819 pScan->iEquiv = 2;
820 return whereScanNext(pScan);
821}
822
823/*
drhfe05af82005-07-21 03:14:59 +0000824** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
825** where X is a reference to the iColumn of table iCur and <op> is one of
826** the WO_xx operator codes specified by the op parameter.
827** Return a pointer to the term. Return 0 if not found.
drh58eb1c02013-01-17 00:08:42 +0000828**
829** The term returned might by Y=<expr> if there is another constraint in
830** the WHERE clause that specifies that X=Y. Any such constraints will be
831** identified by the WO_EQUIV bit in the pTerm->eOperator field. The
832** aEquiv[] array holds X and all its equivalents, with each SQL variable
833** taking up two slots in aEquiv[]. The first slot is for the cursor number
834** and the second is for the column number. There are 22 slots in aEquiv[]
835** so that means we can look for X plus up to 10 other equivalent values.
836** Hence a search for X will return <expr> if X=A1 and A1=A2 and A2=A3
837** and ... and A9=A10 and A10=<expr>.
838**
839** If there are multiple terms in the WHERE clause of the form "X <op> <expr>"
840** then try for the one with no dependencies on <expr> - in other words where
841** <expr> is a constant expression of some kind. Only return entries of
842** the form "X <op> Y" where Y is a column in another table if no terms of
drh459f63e2013-03-06 01:55:27 +0000843** the form "X <op> <const-expr>" exist. If no terms with a constant RHS
844** exist, try to return a term that does not use WO_EQUIV.
drhfe05af82005-07-21 03:14:59 +0000845*/
846static WhereTerm *findTerm(
847 WhereClause *pWC, /* The WHERE clause to be searched */
848 int iCur, /* Cursor number of LHS */
849 int iColumn, /* Column number of LHS */
850 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000851 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000852 Index *pIdx /* Must be compatible with this index, if not NULL */
853){
drh1c8148f2013-05-04 20:25:23 +0000854 WhereTerm *pResult = 0;
855 WhereTerm *p;
856 WhereScan scan;
drh7a5bcc02013-01-16 17:08:58 +0000857
drh1c8148f2013-05-04 20:25:23 +0000858 p = whereScanInit(&scan, pWC, iCur, iColumn, op, pIdx);
859 while( p ){
860 if( (p->prereqRight & notReady)==0 ){
861 if( p->prereqRight==0 && (p->eOperator&WO_EQ)!=0 ){
862 return p;
drhfe05af82005-07-21 03:14:59 +0000863 }
drh1c8148f2013-05-04 20:25:23 +0000864 if( pResult==0 ) pResult = p;
drhfe05af82005-07-21 03:14:59 +0000865 }
drh1c8148f2013-05-04 20:25:23 +0000866 p = whereScanNext(&scan);
drhfe05af82005-07-21 03:14:59 +0000867 }
drh7a5bcc02013-01-16 17:08:58 +0000868 return pResult;
drhfe05af82005-07-21 03:14:59 +0000869}
870
drh6c30be82005-07-29 15:10:17 +0000871/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000872static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000873
874/*
875** Call exprAnalyze on all terms in a WHERE clause.
876**
877**
878*/
879static void exprAnalyzeAll(
880 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000881 WhereClause *pWC /* the WHERE clause to be analyzed */
882){
drh6c30be82005-07-29 15:10:17 +0000883 int i;
drh9eb20282005-08-24 03:52:18 +0000884 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000885 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000886 }
887}
888
drhd2687b72005-08-12 22:56:09 +0000889#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
890/*
891** Check to see if the given expression is a LIKE or GLOB operator that
892** can be optimized using inequality constraints. Return TRUE if it is
893** so and false if not.
894**
895** In order for the operator to be optimizible, the RHS must be a string
896** literal that does not begin with a wildcard.
897*/
898static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000899 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000900 Expr *pExpr, /* Test this expression */
dan937d0de2009-10-15 18:35:38 +0000901 Expr **ppPrefix, /* Pointer to TK_STRING expression with pattern prefix */
drh9f504ea2008-02-23 21:55:39 +0000902 int *pisComplete, /* True if the only wildcard is % in the last character */
903 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000904){
dan937d0de2009-10-15 18:35:38 +0000905 const char *z = 0; /* String on RHS of LIKE operator */
drh5bd98ae2009-01-07 18:24:03 +0000906 Expr *pRight, *pLeft; /* Right and left size of LIKE operator */
907 ExprList *pList; /* List of operands to the LIKE operator */
908 int c; /* One character in z[] */
909 int cnt; /* Number of non-wildcard prefix characters */
910 char wc[3]; /* Wildcard characters */
drh5bd98ae2009-01-07 18:24:03 +0000911 sqlite3 *db = pParse->db; /* Database connection */
dan937d0de2009-10-15 18:35:38 +0000912 sqlite3_value *pVal = 0;
913 int op; /* Opcode of pRight */
drhd64fe2f2005-08-28 17:00:23 +0000914
drh9f504ea2008-02-23 21:55:39 +0000915 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000916 return 0;
917 }
drh9f504ea2008-02-23 21:55:39 +0000918#ifdef SQLITE_EBCDIC
919 if( *pnoCase ) return 0;
920#endif
danielk19776ab3a2e2009-02-19 14:39:25 +0000921 pList = pExpr->x.pList;
drh55ef4d92005-08-14 01:20:37 +0000922 pLeft = pList->a[1].pExpr;
danc68939e2012-03-29 14:29:07 +0000923 if( pLeft->op!=TK_COLUMN
924 || sqlite3ExprAffinity(pLeft)!=SQLITE_AFF_TEXT
925 || IsVirtual(pLeft->pTab)
926 ){
drhd91ca492009-10-22 20:50:36 +0000927 /* IMP: R-02065-49465 The left-hand side of the LIKE or GLOB operator must
928 ** be the name of an indexed column with TEXT affinity. */
drhd2687b72005-08-12 22:56:09 +0000929 return 0;
930 }
drhd91ca492009-10-22 20:50:36 +0000931 assert( pLeft->iColumn!=(-1) ); /* Because IPK never has AFF_TEXT */
dan937d0de2009-10-15 18:35:38 +0000932
933 pRight = pList->a[0].pExpr;
934 op = pRight->op;
935 if( op==TK_REGISTER ){
936 op = pRight->op2;
937 }
938 if( op==TK_VARIABLE ){
939 Vdbe *pReprepare = pParse->pReprepare;
drha7044002010-09-14 18:22:59 +0000940 int iCol = pRight->iColumn;
941 pVal = sqlite3VdbeGetValue(pReprepare, iCol, SQLITE_AFF_NONE);
dan937d0de2009-10-15 18:35:38 +0000942 if( pVal && sqlite3_value_type(pVal)==SQLITE_TEXT ){
943 z = (char *)sqlite3_value_text(pVal);
944 }
drhf9b22ca2011-10-21 16:47:31 +0000945 sqlite3VdbeSetVarmask(pParse->pVdbe, iCol);
dan937d0de2009-10-15 18:35:38 +0000946 assert( pRight->op==TK_VARIABLE || pRight->op==TK_REGISTER );
947 }else if( op==TK_STRING ){
948 z = pRight->u.zToken;
949 }
950 if( z ){
shane85095702009-06-15 16:27:08 +0000951 cnt = 0;
drhb7916a72009-05-27 10:31:29 +0000952 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){
drh24fb6272009-05-01 21:13:36 +0000953 cnt++;
954 }
drh93ee23c2010-07-22 12:33:57 +0000955 if( cnt!=0 && 255!=(u8)z[cnt-1] ){
dan937d0de2009-10-15 18:35:38 +0000956 Expr *pPrefix;
drh93ee23c2010-07-22 12:33:57 +0000957 *pisComplete = c==wc[0] && z[cnt+1]==0;
dan937d0de2009-10-15 18:35:38 +0000958 pPrefix = sqlite3Expr(db, TK_STRING, z);
959 if( pPrefix ) pPrefix->u.zToken[cnt] = 0;
960 *ppPrefix = pPrefix;
961 if( op==TK_VARIABLE ){
962 Vdbe *v = pParse->pVdbe;
drhf9b22ca2011-10-21 16:47:31 +0000963 sqlite3VdbeSetVarmask(v, pRight->iColumn);
dan937d0de2009-10-15 18:35:38 +0000964 if( *pisComplete && pRight->u.zToken[1] ){
965 /* If the rhs of the LIKE expression is a variable, and the current
966 ** value of the variable means there is no need to invoke the LIKE
967 ** function, then no OP_Variable will be added to the program.
968 ** This causes problems for the sqlite3_bind_parameter_name()
drhbec451f2009-10-17 13:13:02 +0000969 ** API. To workaround them, add a dummy OP_Variable here.
970 */
971 int r1 = sqlite3GetTempReg(pParse);
972 sqlite3ExprCodeTarget(pParse, pRight, r1);
dan937d0de2009-10-15 18:35:38 +0000973 sqlite3VdbeChangeP3(v, sqlite3VdbeCurrentAddr(v)-1, 0);
drhbec451f2009-10-17 13:13:02 +0000974 sqlite3ReleaseTempReg(pParse, r1);
dan937d0de2009-10-15 18:35:38 +0000975 }
976 }
977 }else{
978 z = 0;
shane85095702009-06-15 16:27:08 +0000979 }
drhf998b732007-11-26 13:36:00 +0000980 }
dan937d0de2009-10-15 18:35:38 +0000981
982 sqlite3ValueFree(pVal);
983 return (z!=0);
drhd2687b72005-08-12 22:56:09 +0000984}
985#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
986
drhedb193b2006-06-27 13:20:21 +0000987
988#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000989/*
drh7f375902006-06-13 17:38:59 +0000990** Check to see if the given expression is of the form
991**
992** column MATCH expr
993**
994** If it is then return TRUE. If not, return FALSE.
995*/
996static int isMatchOfColumn(
997 Expr *pExpr /* Test this expression */
998){
999 ExprList *pList;
1000
1001 if( pExpr->op!=TK_FUNCTION ){
1002 return 0;
1003 }
drh33e619f2009-05-28 01:00:55 +00001004 if( sqlite3StrICmp(pExpr->u.zToken,"match")!=0 ){
drh7f375902006-06-13 17:38:59 +00001005 return 0;
1006 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001007 pList = pExpr->x.pList;
drh7f375902006-06-13 17:38:59 +00001008 if( pList->nExpr!=2 ){
1009 return 0;
1010 }
1011 if( pList->a[1].pExpr->op != TK_COLUMN ){
1012 return 0;
1013 }
1014 return 1;
1015}
drhedb193b2006-06-27 13:20:21 +00001016#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +00001017
1018/*
drh54a167d2005-11-26 14:08:07 +00001019** If the pBase expression originated in the ON or USING clause of
1020** a join, then transfer the appropriate markings over to derived.
1021*/
1022static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
1023 pDerived->flags |= pBase->flags & EP_FromJoin;
1024 pDerived->iRightJoinTable = pBase->iRightJoinTable;
1025}
1026
drh3e355802007-02-23 23:13:33 +00001027#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
1028/*
drh1a58fe02008-12-20 02:06:13 +00001029** Analyze a term that consists of two or more OR-connected
1030** subterms. So in:
drh3e355802007-02-23 23:13:33 +00001031**
drh1a58fe02008-12-20 02:06:13 +00001032** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
1033** ^^^^^^^^^^^^^^^^^^^^
drh3e355802007-02-23 23:13:33 +00001034**
drh1a58fe02008-12-20 02:06:13 +00001035** This routine analyzes terms such as the middle term in the above example.
1036** A WhereOrTerm object is computed and attached to the term under
1037** analysis, regardless of the outcome of the analysis. Hence:
drh3e355802007-02-23 23:13:33 +00001038**
drh1a58fe02008-12-20 02:06:13 +00001039** WhereTerm.wtFlags |= TERM_ORINFO
1040** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
drh3e355802007-02-23 23:13:33 +00001041**
drh1a58fe02008-12-20 02:06:13 +00001042** The term being analyzed must have two or more of OR-connected subterms.
danielk1977fdc40192008-12-29 18:33:32 +00001043** A single subterm might be a set of AND-connected sub-subterms.
drh1a58fe02008-12-20 02:06:13 +00001044** Examples of terms under analysis:
drh3e355802007-02-23 23:13:33 +00001045**
drh1a58fe02008-12-20 02:06:13 +00001046** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
1047** (B) x=expr1 OR expr2=x OR x=expr3
1048** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
1049** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
1050** (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 +00001051**
drh1a58fe02008-12-20 02:06:13 +00001052** CASE 1:
1053**
drhc3e552f2013-02-08 16:04:19 +00001054** If all subterms are of the form T.C=expr for some single column of C and
drh1a58fe02008-12-20 02:06:13 +00001055** a single table T (as shown in example B above) then create a new virtual
1056** term that is an equivalent IN expression. In other words, if the term
1057** being analyzed is:
1058**
1059** x = expr1 OR expr2 = x OR x = expr3
1060**
1061** then create a new virtual term like this:
1062**
1063** x IN (expr1,expr2,expr3)
1064**
1065** CASE 2:
1066**
1067** If all subterms are indexable by a single table T, then set
1068**
1069** WhereTerm.eOperator = WO_OR
1070** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
1071**
1072** A subterm is "indexable" if it is of the form
1073** "T.C <op> <expr>" where C is any column of table T and
1074** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
1075** A subterm is also indexable if it is an AND of two or more
1076** subsubterms at least one of which is indexable. Indexable AND
1077** subterms have their eOperator set to WO_AND and they have
1078** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
1079**
1080** From another point of view, "indexable" means that the subterm could
1081** potentially be used with an index if an appropriate index exists.
1082** This analysis does not consider whether or not the index exists; that
1083** is something the bestIndex() routine will determine. This analysis
1084** only looks at whether subterms appropriate for indexing exist.
1085**
1086** All examples A through E above all satisfy case 2. But if a term
1087** also statisfies case 1 (such as B) we know that the optimizer will
1088** always prefer case 1, so in that case we pretend that case 2 is not
1089** satisfied.
1090**
1091** It might be the case that multiple tables are indexable. For example,
1092** (E) above is indexable on tables P, Q, and R.
1093**
1094** Terms that satisfy case 2 are candidates for lookup by using
1095** separate indices to find rowids for each subterm and composing
1096** the union of all rowids using a RowSet object. This is similar
1097** to "bitmap indices" in other database engines.
1098**
1099** OTHERWISE:
1100**
1101** If neither case 1 nor case 2 apply, then leave the eOperator set to
1102** zero. This term is not useful for search.
drh3e355802007-02-23 23:13:33 +00001103*/
drh1a58fe02008-12-20 02:06:13 +00001104static void exprAnalyzeOrTerm(
1105 SrcList *pSrc, /* the FROM clause */
1106 WhereClause *pWC, /* the complete WHERE clause */
1107 int idxTerm /* Index of the OR-term to be analyzed */
1108){
1109 Parse *pParse = pWC->pParse; /* Parser context */
1110 sqlite3 *db = pParse->db; /* Database connection */
1111 WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
1112 Expr *pExpr = pTerm->pExpr; /* The expression of the term */
drh111a6a72008-12-21 03:51:16 +00001113 WhereMaskSet *pMaskSet = pWC->pMaskSet; /* Table use masks */
drh1a58fe02008-12-20 02:06:13 +00001114 int i; /* Loop counters */
1115 WhereClause *pOrWc; /* Breakup of pTerm into subterms */
1116 WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
1117 WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
1118 Bitmask chngToIN; /* Tables that might satisfy case 1 */
1119 Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
drh3e355802007-02-23 23:13:33 +00001120
drh1a58fe02008-12-20 02:06:13 +00001121 /*
1122 ** Break the OR clause into its separate subterms. The subterms are
1123 ** stored in a WhereClause structure containing within the WhereOrInfo
1124 ** object that is attached to the original OR clause term.
1125 */
1126 assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
1127 assert( pExpr->op==TK_OR );
drh954701a2008-12-29 23:45:07 +00001128 pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
drh1a58fe02008-12-20 02:06:13 +00001129 if( pOrInfo==0 ) return;
1130 pTerm->wtFlags |= TERM_ORINFO;
1131 pOrWc = &pOrInfo->wc;
drh9ef61f42011-10-07 14:40:59 +00001132 whereClauseInit(pOrWc, pWC->pParse, pMaskSet, pWC->wctrlFlags);
drh1a58fe02008-12-20 02:06:13 +00001133 whereSplit(pOrWc, pExpr, TK_OR);
1134 exprAnalyzeAll(pSrc, pOrWc);
1135 if( db->mallocFailed ) return;
1136 assert( pOrWc->nTerm>=2 );
1137
1138 /*
1139 ** Compute the set of tables that might satisfy cases 1 or 2.
1140 */
danielk1977e672c8e2009-05-22 15:43:26 +00001141 indexable = ~(Bitmask)0;
drhc3e552f2013-02-08 16:04:19 +00001142 chngToIN = ~(Bitmask)0;
drh1a58fe02008-12-20 02:06:13 +00001143 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
1144 if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
drh29435252008-12-28 18:35:08 +00001145 WhereAndInfo *pAndInfo;
drh29435252008-12-28 18:35:08 +00001146 assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
drh1a58fe02008-12-20 02:06:13 +00001147 chngToIN = 0;
drh29435252008-12-28 18:35:08 +00001148 pAndInfo = sqlite3DbMallocRaw(db, sizeof(*pAndInfo));
1149 if( pAndInfo ){
1150 WhereClause *pAndWC;
1151 WhereTerm *pAndTerm;
1152 int j;
1153 Bitmask b = 0;
1154 pOrTerm->u.pAndInfo = pAndInfo;
1155 pOrTerm->wtFlags |= TERM_ANDINFO;
1156 pOrTerm->eOperator = WO_AND;
1157 pAndWC = &pAndInfo->wc;
drh9ef61f42011-10-07 14:40:59 +00001158 whereClauseInit(pAndWC, pWC->pParse, pMaskSet, pWC->wctrlFlags);
drh29435252008-12-28 18:35:08 +00001159 whereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
1160 exprAnalyzeAll(pSrc, pAndWC);
drh8871ef52011-10-07 13:33:10 +00001161 pAndWC->pOuter = pWC;
drh7c2fbde2009-01-07 20:58:57 +00001162 testcase( db->mallocFailed );
drh96c7a7d2009-01-10 15:34:12 +00001163 if( !db->mallocFailed ){
1164 for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
1165 assert( pAndTerm->pExpr );
1166 if( allowedOp(pAndTerm->pExpr->op) ){
1167 b |= getMask(pMaskSet, pAndTerm->leftCursor);
1168 }
drh29435252008-12-28 18:35:08 +00001169 }
1170 }
1171 indexable &= b;
1172 }
drh1a58fe02008-12-20 02:06:13 +00001173 }else if( pOrTerm->wtFlags & TERM_COPIED ){
1174 /* Skip this term for now. We revisit it when we process the
1175 ** corresponding TERM_VIRTUAL term */
1176 }else{
1177 Bitmask b;
1178 b = getMask(pMaskSet, pOrTerm->leftCursor);
1179 if( pOrTerm->wtFlags & TERM_VIRTUAL ){
1180 WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
1181 b |= getMask(pMaskSet, pOther->leftCursor);
1182 }
1183 indexable &= b;
drh7a5bcc02013-01-16 17:08:58 +00001184 if( (pOrTerm->eOperator & WO_EQ)==0 ){
drh1a58fe02008-12-20 02:06:13 +00001185 chngToIN = 0;
1186 }else{
1187 chngToIN &= b;
1188 }
1189 }
drh3e355802007-02-23 23:13:33 +00001190 }
drh1a58fe02008-12-20 02:06:13 +00001191
1192 /*
1193 ** Record the set of tables that satisfy case 2. The set might be
drh111a6a72008-12-21 03:51:16 +00001194 ** empty.
drh1a58fe02008-12-20 02:06:13 +00001195 */
1196 pOrInfo->indexable = indexable;
drh111a6a72008-12-21 03:51:16 +00001197 pTerm->eOperator = indexable==0 ? 0 : WO_OR;
drh1a58fe02008-12-20 02:06:13 +00001198
1199 /*
1200 ** chngToIN holds a set of tables that *might* satisfy case 1. But
1201 ** we have to do some additional checking to see if case 1 really
1202 ** is satisfied.
drh4e8be3b2009-06-08 17:11:08 +00001203 **
1204 ** chngToIN will hold either 0, 1, or 2 bits. The 0-bit case means
1205 ** that there is no possibility of transforming the OR clause into an
1206 ** IN operator because one or more terms in the OR clause contain
1207 ** something other than == on a column in the single table. The 1-bit
1208 ** case means that every term of the OR clause is of the form
1209 ** "table.column=expr" for some single table. The one bit that is set
1210 ** will correspond to the common table. We still need to check to make
1211 ** sure the same column is used on all terms. The 2-bit case is when
1212 ** the all terms are of the form "table1.column=table2.column". It
1213 ** might be possible to form an IN operator with either table1.column
1214 ** or table2.column as the LHS if either is common to every term of
1215 ** the OR clause.
1216 **
1217 ** Note that terms of the form "table.column1=table.column2" (the
1218 ** same table on both sizes of the ==) cannot be optimized.
drh1a58fe02008-12-20 02:06:13 +00001219 */
1220 if( chngToIN ){
1221 int okToChngToIN = 0; /* True if the conversion to IN is valid */
1222 int iColumn = -1; /* Column index on lhs of IN operator */
shane63207ab2009-02-04 01:49:30 +00001223 int iCursor = -1; /* Table cursor common to all terms */
drh1a58fe02008-12-20 02:06:13 +00001224 int j = 0; /* Loop counter */
1225
1226 /* Search for a table and column that appears on one side or the
1227 ** other of the == operator in every subterm. That table and column
1228 ** will be recorded in iCursor and iColumn. There might not be any
1229 ** such table and column. Set okToChngToIN if an appropriate table
1230 ** and column is found but leave okToChngToIN false if not found.
1231 */
1232 for(j=0; j<2 && !okToChngToIN; j++){
1233 pOrTerm = pOrWc->a;
1234 for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001235 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001236 pOrTerm->wtFlags &= ~TERM_OR_OK;
drh4e8be3b2009-06-08 17:11:08 +00001237 if( pOrTerm->leftCursor==iCursor ){
1238 /* This is the 2-bit case and we are on the second iteration and
1239 ** current term is from the first iteration. So skip this term. */
1240 assert( j==1 );
1241 continue;
1242 }
1243 if( (chngToIN & getMask(pMaskSet, pOrTerm->leftCursor))==0 ){
1244 /* This term must be of the form t1.a==t2.b where t2 is in the
1245 ** chngToIN set but t1 is not. This term will be either preceeded
1246 ** or follwed by an inverted copy (t2.b==t1.a). Skip this term
1247 ** and use its inversion. */
1248 testcase( pOrTerm->wtFlags & TERM_COPIED );
1249 testcase( pOrTerm->wtFlags & TERM_VIRTUAL );
1250 assert( pOrTerm->wtFlags & (TERM_COPIED|TERM_VIRTUAL) );
1251 continue;
1252 }
drh1a58fe02008-12-20 02:06:13 +00001253 iColumn = pOrTerm->u.leftColumn;
1254 iCursor = pOrTerm->leftCursor;
1255 break;
1256 }
1257 if( i<0 ){
drh4e8be3b2009-06-08 17:11:08 +00001258 /* No candidate table+column was found. This can only occur
1259 ** on the second iteration */
drh1a58fe02008-12-20 02:06:13 +00001260 assert( j==1 );
drh7a5bcc02013-01-16 17:08:58 +00001261 assert( IsPowerOfTwo(chngToIN) );
drh4e8be3b2009-06-08 17:11:08 +00001262 assert( chngToIN==getMask(pMaskSet, iCursor) );
drh1a58fe02008-12-20 02:06:13 +00001263 break;
1264 }
drh4e8be3b2009-06-08 17:11:08 +00001265 testcase( j==1 );
1266
1267 /* We have found a candidate table and column. Check to see if that
1268 ** table and column is common to every term in the OR clause */
drh1a58fe02008-12-20 02:06:13 +00001269 okToChngToIN = 1;
1270 for(; i>=0 && okToChngToIN; i--, pOrTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001271 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001272 if( pOrTerm->leftCursor!=iCursor ){
1273 pOrTerm->wtFlags &= ~TERM_OR_OK;
1274 }else if( pOrTerm->u.leftColumn!=iColumn ){
1275 okToChngToIN = 0;
1276 }else{
1277 int affLeft, affRight;
1278 /* If the right-hand side is also a column, then the affinities
1279 ** of both right and left sides must be such that no type
1280 ** conversions are required on the right. (Ticket #2249)
1281 */
1282 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
1283 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
1284 if( affRight!=0 && affRight!=affLeft ){
1285 okToChngToIN = 0;
1286 }else{
1287 pOrTerm->wtFlags |= TERM_OR_OK;
1288 }
1289 }
1290 }
1291 }
1292
1293 /* At this point, okToChngToIN is true if original pTerm satisfies
1294 ** case 1. In that case, construct a new virtual term that is
1295 ** pTerm converted into an IN operator.
drhe9cdcea2010-07-22 22:40:03 +00001296 **
1297 ** EV: R-00211-15100
drh1a58fe02008-12-20 02:06:13 +00001298 */
1299 if( okToChngToIN ){
1300 Expr *pDup; /* A transient duplicate expression */
1301 ExprList *pList = 0; /* The RHS of the IN operator */
1302 Expr *pLeft = 0; /* The LHS of the IN operator */
1303 Expr *pNew; /* The complete IN operator */
1304
1305 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
1306 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
drh7a5bcc02013-01-16 17:08:58 +00001307 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001308 assert( pOrTerm->leftCursor==iCursor );
1309 assert( pOrTerm->u.leftColumn==iColumn );
danielk19776ab3a2e2009-02-19 14:39:25 +00001310 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight, 0);
drhb7916a72009-05-27 10:31:29 +00001311 pList = sqlite3ExprListAppend(pWC->pParse, pList, pDup);
drh1a58fe02008-12-20 02:06:13 +00001312 pLeft = pOrTerm->pExpr->pLeft;
1313 }
1314 assert( pLeft!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001315 pDup = sqlite3ExprDup(db, pLeft, 0);
drhb7916a72009-05-27 10:31:29 +00001316 pNew = sqlite3PExpr(pParse, TK_IN, pDup, 0, 0);
drh1a58fe02008-12-20 02:06:13 +00001317 if( pNew ){
1318 int idxNew;
1319 transferJoinMarkings(pNew, pExpr);
danielk19776ab3a2e2009-02-19 14:39:25 +00001320 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
1321 pNew->x.pList = pList;
drh1a58fe02008-12-20 02:06:13 +00001322 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
1323 testcase( idxNew==0 );
1324 exprAnalyze(pSrc, pWC, idxNew);
1325 pTerm = &pWC->a[idxTerm];
1326 pWC->a[idxNew].iParent = idxTerm;
1327 pTerm->nChild = 1;
1328 }else{
1329 sqlite3ExprListDelete(db, pList);
1330 }
drh534230c2011-01-22 00:10:45 +00001331 pTerm->eOperator = WO_NOOP; /* case 1 trumps case 2 */
drh1a58fe02008-12-20 02:06:13 +00001332 }
drh3e355802007-02-23 23:13:33 +00001333 }
drh3e355802007-02-23 23:13:33 +00001334}
1335#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +00001336
drh7a5bcc02013-01-16 17:08:58 +00001337/*
drh0aa74ed2005-07-16 13:33:20 +00001338** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +00001339** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +00001340** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +00001341** structure.
drh51147ba2005-07-23 22:59:55 +00001342**
1343** If the expression is of the form "<expr> <op> X" it gets commuted
drh1a58fe02008-12-20 02:06:13 +00001344** to the standard form of "X <op> <expr>".
1345**
1346** If the expression is of the form "X <op> Y" where both X and Y are
1347** columns, then the original expression is unchanged and a new virtual
1348** term of the form "Y <op> X" is added to the WHERE clause and
1349** analyzed separately. The original term is marked with TERM_COPIED
1350** and the new term is marked with TERM_DYNAMIC (because it's pExpr
1351** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
1352** is a commuted copy of a prior term.) The original term has nChild=1
1353** and the copy has idxParent set to the index of the original term.
drh75897232000-05-29 14:26:00 +00001354*/
drh0fcef5e2005-07-19 17:38:22 +00001355static void exprAnalyze(
1356 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +00001357 WhereClause *pWC, /* the WHERE clause */
1358 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +00001359){
drh1a58fe02008-12-20 02:06:13 +00001360 WhereTerm *pTerm; /* The term to be analyzed */
drh111a6a72008-12-21 03:51:16 +00001361 WhereMaskSet *pMaskSet; /* Set of table index masks */
drh1a58fe02008-12-20 02:06:13 +00001362 Expr *pExpr; /* The expression to be analyzed */
1363 Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
1364 Bitmask prereqAll; /* Prerequesites of pExpr */
drh5e767c52010-02-25 04:15:47 +00001365 Bitmask extraRight = 0; /* Extra dependencies on LEFT JOIN */
drh1d452e12009-11-01 19:26:59 +00001366 Expr *pStr1 = 0; /* RHS of LIKE/GLOB operator */
1367 int isComplete = 0; /* RHS of LIKE/GLOB ends with wildcard */
1368 int noCase = 0; /* LIKE/GLOB distinguishes case */
drh1a58fe02008-12-20 02:06:13 +00001369 int op; /* Top-level operator. pExpr->op */
1370 Parse *pParse = pWC->pParse; /* Parsing context */
1371 sqlite3 *db = pParse->db; /* Database connection */
drh0fcef5e2005-07-19 17:38:22 +00001372
drhf998b732007-11-26 13:36:00 +00001373 if( db->mallocFailed ){
1374 return;
1375 }
1376 pTerm = &pWC->a[idxTerm];
1377 pMaskSet = pWC->pMaskSet;
drh7ee751d2012-12-19 15:53:51 +00001378 pExpr = pTerm->pExpr;
1379 assert( pExpr->op!=TK_AS && pExpr->op!=TK_COLLATE );
drh0fcef5e2005-07-19 17:38:22 +00001380 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +00001381 op = pExpr->op;
1382 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +00001383 assert( pExpr->pRight==0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001384 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1385 pTerm->prereqRight = exprSelectTableUsage(pMaskSet, pExpr->x.pSelect);
1386 }else{
1387 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->x.pList);
1388 }
drh50b39962006-10-28 00:28:09 +00001389 }else if( op==TK_ISNULL ){
1390 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +00001391 }else{
1392 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
1393 }
drh22d6a532005-09-19 21:05:48 +00001394 prereqAll = exprTableUsage(pMaskSet, pExpr);
1395 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +00001396 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
1397 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +00001398 extraRight = x-1; /* ON clause terms may not be used with an index
1399 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +00001400 }
1401 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +00001402 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +00001403 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +00001404 pTerm->eOperator = 0;
drh738fc792013-01-17 15:05:17 +00001405 if( allowedOp(op) ){
drh7a66da12012-12-07 20:31:11 +00001406 Expr *pLeft = sqlite3ExprSkipCollate(pExpr->pLeft);
1407 Expr *pRight = sqlite3ExprSkipCollate(pExpr->pRight);
drh738fc792013-01-17 15:05:17 +00001408 u16 opMask = (pTerm->prereqRight & prereqLeft)==0 ? WO_ALL : WO_EQUIV;
drh0fcef5e2005-07-19 17:38:22 +00001409 if( pLeft->op==TK_COLUMN ){
1410 pTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001411 pTerm->u.leftColumn = pLeft->iColumn;
drh738fc792013-01-17 15:05:17 +00001412 pTerm->eOperator = operatorMask(op) & opMask;
drh75897232000-05-29 14:26:00 +00001413 }
drh0fcef5e2005-07-19 17:38:22 +00001414 if( pRight && pRight->op==TK_COLUMN ){
1415 WhereTerm *pNew;
1416 Expr *pDup;
drh7a5bcc02013-01-16 17:08:58 +00001417 u16 eExtraOp = 0; /* Extra bits for pNew->eOperator */
drh0fcef5e2005-07-19 17:38:22 +00001418 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +00001419 int idxNew;
danielk19776ab3a2e2009-02-19 14:39:25 +00001420 pDup = sqlite3ExprDup(db, pExpr, 0);
drh17435752007-08-16 04:30:38 +00001421 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +00001422 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +00001423 return;
1424 }
drh9eb20282005-08-24 03:52:18 +00001425 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
1426 if( idxNew==0 ) return;
1427 pNew = &pWC->a[idxNew];
1428 pNew->iParent = idxTerm;
1429 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +00001430 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001431 pTerm->wtFlags |= TERM_COPIED;
drheb5bc922013-01-17 16:43:33 +00001432 if( pExpr->op==TK_EQ
1433 && !ExprHasProperty(pExpr, EP_FromJoin)
1434 && OptimizationEnabled(db, SQLITE_Transitive)
1435 ){
drh7a5bcc02013-01-16 17:08:58 +00001436 pTerm->eOperator |= WO_EQUIV;
1437 eExtraOp = WO_EQUIV;
1438 }
drh0fcef5e2005-07-19 17:38:22 +00001439 }else{
1440 pDup = pExpr;
1441 pNew = pTerm;
1442 }
drh7d10d5a2008-08-20 16:35:10 +00001443 exprCommute(pParse, pDup);
drhfb76f5a2012-12-08 14:16:47 +00001444 pLeft = sqlite3ExprSkipCollate(pDup->pLeft);
drh0fcef5e2005-07-19 17:38:22 +00001445 pNew->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001446 pNew->u.leftColumn = pLeft->iColumn;
drh5e767c52010-02-25 04:15:47 +00001447 testcase( (prereqLeft | extraRight) != prereqLeft );
1448 pNew->prereqRight = prereqLeft | extraRight;
drh0fcef5e2005-07-19 17:38:22 +00001449 pNew->prereqAll = prereqAll;
drh738fc792013-01-17 15:05:17 +00001450 pNew->eOperator = (operatorMask(pDup->op) + eExtraOp) & opMask;
drh75897232000-05-29 14:26:00 +00001451 }
1452 }
drhed378002005-07-28 23:12:08 +00001453
drhd2687b72005-08-12 22:56:09 +00001454#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +00001455 /* If a term is the BETWEEN operator, create two new virtual terms
drh1a58fe02008-12-20 02:06:13 +00001456 ** that define the range that the BETWEEN implements. For example:
1457 **
1458 ** a BETWEEN b AND c
1459 **
1460 ** is converted into:
1461 **
1462 ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
1463 **
1464 ** The two new terms are added onto the end of the WhereClause object.
1465 ** The new terms are "dynamic" and are children of the original BETWEEN
1466 ** term. That means that if the BETWEEN term is coded, the children are
1467 ** skipped. Or, if the children are satisfied by an index, the original
1468 ** BETWEEN term is skipped.
drhed378002005-07-28 23:12:08 +00001469 */
drh29435252008-12-28 18:35:08 +00001470 else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001471 ExprList *pList = pExpr->x.pList;
drhed378002005-07-28 23:12:08 +00001472 int i;
1473 static const u8 ops[] = {TK_GE, TK_LE};
1474 assert( pList!=0 );
1475 assert( pList->nExpr==2 );
1476 for(i=0; i<2; i++){
1477 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +00001478 int idxNew;
drhb7916a72009-05-27 10:31:29 +00001479 pNewExpr = sqlite3PExpr(pParse, ops[i],
1480 sqlite3ExprDup(db, pExpr->pLeft, 0),
danielk19776ab3a2e2009-02-19 14:39:25 +00001481 sqlite3ExprDup(db, pList->a[i].pExpr, 0), 0);
drh9eb20282005-08-24 03:52:18 +00001482 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001483 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001484 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +00001485 pTerm = &pWC->a[idxTerm];
1486 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +00001487 }
drh45b1ee42005-08-02 17:48:22 +00001488 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +00001489 }
drhd2687b72005-08-12 22:56:09 +00001490#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +00001491
danielk19771576cd92006-01-14 08:02:28 +00001492#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh1a58fe02008-12-20 02:06:13 +00001493 /* Analyze a term that is composed of two or more subterms connected by
1494 ** an OR operator.
drh6c30be82005-07-29 15:10:17 +00001495 */
1496 else if( pExpr->op==TK_OR ){
drh29435252008-12-28 18:35:08 +00001497 assert( pWC->op==TK_AND );
drh1a58fe02008-12-20 02:06:13 +00001498 exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
danielk1977f51d1bd2009-07-31 06:14:51 +00001499 pTerm = &pWC->a[idxTerm];
drh6c30be82005-07-29 15:10:17 +00001500 }
drhd2687b72005-08-12 22:56:09 +00001501#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1502
1503#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
1504 /* Add constraints to reduce the search space on a LIKE or GLOB
1505 ** operator.
drh9f504ea2008-02-23 21:55:39 +00001506 **
1507 ** A like pattern of the form "x LIKE 'abc%'" is changed into constraints
1508 **
1509 ** x>='abc' AND x<'abd' AND x LIKE 'abc%'
1510 **
1511 ** The last character of the prefix "abc" is incremented to form the
shane7bc71e52008-05-28 18:01:44 +00001512 ** termination condition "abd".
drhd2687b72005-08-12 22:56:09 +00001513 */
dan937d0de2009-10-15 18:35:38 +00001514 if( pWC->op==TK_AND
1515 && isLikeOrGlob(pParse, pExpr, &pStr1, &isComplete, &noCase)
1516 ){
drh1d452e12009-11-01 19:26:59 +00001517 Expr *pLeft; /* LHS of LIKE/GLOB operator */
1518 Expr *pStr2; /* Copy of pStr1 - RHS of LIKE/GLOB operator */
1519 Expr *pNewExpr1;
1520 Expr *pNewExpr2;
1521 int idxNew1;
1522 int idxNew2;
drhae80dde2012-12-06 21:16:43 +00001523 Token sCollSeqName; /* Name of collating sequence */
drh9eb20282005-08-24 03:52:18 +00001524
danielk19776ab3a2e2009-02-19 14:39:25 +00001525 pLeft = pExpr->x.pList->a[1].pExpr;
danielk19776ab3a2e2009-02-19 14:39:25 +00001526 pStr2 = sqlite3ExprDup(db, pStr1, 0);
drhf998b732007-11-26 13:36:00 +00001527 if( !db->mallocFailed ){
drh254993e2009-06-08 19:44:36 +00001528 u8 c, *pC; /* Last character before the first wildcard */
dan937d0de2009-10-15 18:35:38 +00001529 pC = (u8*)&pStr2->u.zToken[sqlite3Strlen30(pStr2->u.zToken)-1];
drh9f504ea2008-02-23 21:55:39 +00001530 c = *pC;
drh02a50b72008-05-26 18:33:40 +00001531 if( noCase ){
drh254993e2009-06-08 19:44:36 +00001532 /* The point is to increment the last character before the first
1533 ** wildcard. But if we increment '@', that will push it into the
1534 ** alphabetic range where case conversions will mess up the
1535 ** inequality. To avoid this, make sure to also run the full
1536 ** LIKE on all candidate expressions by clearing the isComplete flag
1537 */
drhe9cdcea2010-07-22 22:40:03 +00001538 if( c=='A'-1 ) isComplete = 0; /* EV: R-64339-08207 */
1539
drh254993e2009-06-08 19:44:36 +00001540
drh02a50b72008-05-26 18:33:40 +00001541 c = sqlite3UpperToLower[c];
1542 }
drh9f504ea2008-02-23 21:55:39 +00001543 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +00001544 }
drhae80dde2012-12-06 21:16:43 +00001545 sCollSeqName.z = noCase ? "NOCASE" : "BINARY";
1546 sCollSeqName.n = 6;
1547 pNewExpr1 = sqlite3ExprDup(db, pLeft, 0);
drh8342e492010-07-22 17:49:52 +00001548 pNewExpr1 = sqlite3PExpr(pParse, TK_GE,
drh0a8a4062012-12-07 18:38:16 +00001549 sqlite3ExprAddCollateToken(pParse,pNewExpr1,&sCollSeqName),
drhae80dde2012-12-06 21:16:43 +00001550 pStr1, 0);
drh9eb20282005-08-24 03:52:18 +00001551 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001552 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001553 exprAnalyze(pSrc, pWC, idxNew1);
drhae80dde2012-12-06 21:16:43 +00001554 pNewExpr2 = sqlite3ExprDup(db, pLeft, 0);
drh8342e492010-07-22 17:49:52 +00001555 pNewExpr2 = sqlite3PExpr(pParse, TK_LT,
drh0a8a4062012-12-07 18:38:16 +00001556 sqlite3ExprAddCollateToken(pParse,pNewExpr2,&sCollSeqName),
drhae80dde2012-12-06 21:16:43 +00001557 pStr2, 0);
drh9eb20282005-08-24 03:52:18 +00001558 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001559 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001560 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +00001561 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +00001562 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +00001563 pWC->a[idxNew1].iParent = idxTerm;
1564 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +00001565 pTerm->nChild = 2;
1566 }
1567 }
1568#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +00001569
1570#ifndef SQLITE_OMIT_VIRTUALTABLE
1571 /* Add a WO_MATCH auxiliary term to the constraint set if the
1572 ** current expression is of the form: column MATCH expr.
1573 ** This information is used by the xBestIndex methods of
1574 ** virtual tables. The native query optimizer does not attempt
1575 ** to do anything with MATCH functions.
1576 */
1577 if( isMatchOfColumn(pExpr) ){
1578 int idxNew;
1579 Expr *pRight, *pLeft;
1580 WhereTerm *pNewTerm;
1581 Bitmask prereqColumn, prereqExpr;
1582
danielk19776ab3a2e2009-02-19 14:39:25 +00001583 pRight = pExpr->x.pList->a[0].pExpr;
1584 pLeft = pExpr->x.pList->a[1].pExpr;
drh7f375902006-06-13 17:38:59 +00001585 prereqExpr = exprTableUsage(pMaskSet, pRight);
1586 prereqColumn = exprTableUsage(pMaskSet, pLeft);
1587 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +00001588 Expr *pNewExpr;
drhb7916a72009-05-27 10:31:29 +00001589 pNewExpr = sqlite3PExpr(pParse, TK_MATCH,
1590 0, sqlite3ExprDup(db, pRight, 0), 0);
drh1a90e092006-06-14 22:07:10 +00001591 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001592 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001593 pNewTerm = &pWC->a[idxNew];
1594 pNewTerm->prereqRight = prereqExpr;
1595 pNewTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001596 pNewTerm->u.leftColumn = pLeft->iColumn;
drh7f375902006-06-13 17:38:59 +00001597 pNewTerm->eOperator = WO_MATCH;
1598 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +00001599 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +00001600 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001601 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001602 pNewTerm->prereqAll = pTerm->prereqAll;
1603 }
1604 }
1605#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001606
drhfaacf172011-08-12 01:51:45 +00001607#ifdef SQLITE_ENABLE_STAT3
drhd3ed7342011-09-21 00:09:41 +00001608 /* When sqlite_stat3 histogram data is available an operator of the
drh534230c2011-01-22 00:10:45 +00001609 ** form "x IS NOT NULL" can sometimes be evaluated more efficiently
1610 ** as "x>NULL" if x is not an INTEGER PRIMARY KEY. So construct a
1611 ** virtual term of that form.
1612 **
1613 ** Note that the virtual term must be tagged with TERM_VNULL. This
1614 ** TERM_VNULL tag will suppress the not-null check at the beginning
1615 ** of the loop. Without the TERM_VNULL flag, the not-null check at
1616 ** the start of the loop will prevent any results from being returned.
1617 */
drhea6dc442011-04-08 21:35:26 +00001618 if( pExpr->op==TK_NOTNULL
1619 && pExpr->pLeft->op==TK_COLUMN
1620 && pExpr->pLeft->iColumn>=0
1621 ){
drh534230c2011-01-22 00:10:45 +00001622 Expr *pNewExpr;
1623 Expr *pLeft = pExpr->pLeft;
1624 int idxNew;
1625 WhereTerm *pNewTerm;
1626
1627 pNewExpr = sqlite3PExpr(pParse, TK_GT,
1628 sqlite3ExprDup(db, pLeft, 0),
1629 sqlite3PExpr(pParse, TK_NULL, 0, 0, 0), 0);
1630
1631 idxNew = whereClauseInsert(pWC, pNewExpr,
1632 TERM_VIRTUAL|TERM_DYNAMIC|TERM_VNULL);
drhda91e712011-02-11 06:59:02 +00001633 if( idxNew ){
1634 pNewTerm = &pWC->a[idxNew];
1635 pNewTerm->prereqRight = 0;
1636 pNewTerm->leftCursor = pLeft->iTable;
1637 pNewTerm->u.leftColumn = pLeft->iColumn;
1638 pNewTerm->eOperator = WO_GT;
1639 pNewTerm->iParent = idxTerm;
1640 pTerm = &pWC->a[idxTerm];
1641 pTerm->nChild = 1;
1642 pTerm->wtFlags |= TERM_COPIED;
1643 pNewTerm->prereqAll = pTerm->prereqAll;
1644 }
drh534230c2011-01-22 00:10:45 +00001645 }
drhfaacf172011-08-12 01:51:45 +00001646#endif /* SQLITE_ENABLE_STAT */
drh534230c2011-01-22 00:10:45 +00001647
drhdafc0ce2008-04-17 19:14:02 +00001648 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1649 ** an index for tables to the left of the join.
1650 */
1651 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001652}
1653
drh7b4fc6a2007-02-06 13:26:32 +00001654/*
dan6f343962011-07-01 18:26:40 +00001655** This function searches the expression list passed as the second argument
1656** for an expression of type TK_COLUMN that refers to the same column and
1657** uses the same collation sequence as the iCol'th column of index pIdx.
1658** Argument iBase is the cursor number used for the table that pIdx refers
1659** to.
1660**
1661** If such an expression is found, its index in pList->a[] is returned. If
1662** no expression is found, -1 is returned.
1663*/
1664static int findIndexCol(
1665 Parse *pParse, /* Parse context */
1666 ExprList *pList, /* Expression list to search */
1667 int iBase, /* Cursor for table associated with pIdx */
1668 Index *pIdx, /* Index to match column of */
1669 int iCol /* Column of index to match */
1670){
1671 int i;
1672 const char *zColl = pIdx->azColl[iCol];
1673
1674 for(i=0; i<pList->nExpr; i++){
drh580c8c12012-12-08 03:34:04 +00001675 Expr *p = sqlite3ExprSkipCollate(pList->a[i].pExpr);
drhf1d3e322011-07-09 13:00:41 +00001676 if( p->op==TK_COLUMN
1677 && p->iColumn==pIdx->aiColumn[iCol]
1678 && p->iTable==iBase
1679 ){
drh580c8c12012-12-08 03:34:04 +00001680 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pList->a[i].pExpr);
drhf1d3e322011-07-09 13:00:41 +00001681 if( ALWAYS(pColl) && 0==sqlite3StrICmp(pColl->zName, zColl) ){
dan6f343962011-07-01 18:26:40 +00001682 return i;
1683 }
1684 }
1685 }
1686
1687 return -1;
1688}
1689
1690/*
1691** This routine determines if pIdx can be used to assist in processing a
1692** DISTINCT qualifier. In other words, it tests whether or not using this
1693** index for the outer loop guarantees that rows with equal values for
1694** all expressions in the pDistinct list are delivered grouped together.
1695**
1696** For example, the query
1697**
1698** SELECT DISTINCT a, b, c FROM tbl WHERE a = ?
1699**
1700** can benefit from any index on columns "b" and "c".
1701*/
1702static int isDistinctIndex(
1703 Parse *pParse, /* Parsing context */
1704 WhereClause *pWC, /* The WHERE clause */
1705 Index *pIdx, /* The index being considered */
1706 int base, /* Cursor number for the table pIdx is on */
1707 ExprList *pDistinct, /* The DISTINCT expressions */
1708 int nEqCol /* Number of index columns with == */
1709){
1710 Bitmask mask = 0; /* Mask of unaccounted for pDistinct exprs */
1711 int i; /* Iterator variable */
1712
drh04b85bc2012-10-01 17:44:05 +00001713 assert( pDistinct!=0 );
1714 if( pIdx->zName==0 || pDistinct->nExpr>=BMS ) return 0;
drhb24d83f2011-07-02 19:12:05 +00001715 testcase( pDistinct->nExpr==BMS-1 );
dan6f343962011-07-01 18:26:40 +00001716
1717 /* Loop through all the expressions in the distinct list. If any of them
1718 ** are not simple column references, return early. Otherwise, test if the
1719 ** WHERE clause contains a "col=X" clause. If it does, the expression
1720 ** can be ignored. If it does not, and the column does not belong to the
1721 ** same table as index pIdx, return early. Finally, if there is no
1722 ** matching "col=X" expression and the column is on the same table as pIdx,
1723 ** set the corresponding bit in variable mask.
1724 */
1725 for(i=0; i<pDistinct->nExpr; i++){
1726 WhereTerm *pTerm;
drh580c8c12012-12-08 03:34:04 +00001727 Expr *p = sqlite3ExprSkipCollate(pDistinct->a[i].pExpr);
dan6f343962011-07-01 18:26:40 +00001728 if( p->op!=TK_COLUMN ) return 0;
1729 pTerm = findTerm(pWC, p->iTable, p->iColumn, ~(Bitmask)0, WO_EQ, 0);
1730 if( pTerm ){
1731 Expr *pX = pTerm->pExpr;
1732 CollSeq *p1 = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
1733 CollSeq *p2 = sqlite3ExprCollSeq(pParse, p);
1734 if( p1==p2 ) continue;
1735 }
1736 if( p->iTable!=base ) return 0;
1737 mask |= (((Bitmask)1) << i);
1738 }
1739
1740 for(i=nEqCol; mask && i<pIdx->nColumn; i++){
1741 int iExpr = findIndexCol(pParse, pDistinct, base, pIdx, i);
1742 if( iExpr<0 ) break;
1743 mask &= ~(((Bitmask)1) << iExpr);
1744 }
1745
1746 return (mask==0);
1747}
1748
1749
1750/*
1751** Return true if the DISTINCT expression-list passed as the third argument
1752** is redundant. A DISTINCT list is redundant if the database contains a
1753** UNIQUE index that guarantees that the result of the query will be distinct
1754** anyway.
1755*/
1756static int isDistinctRedundant(
1757 Parse *pParse,
1758 SrcList *pTabList,
1759 WhereClause *pWC,
1760 ExprList *pDistinct
1761){
1762 Table *pTab;
1763 Index *pIdx;
1764 int i;
1765 int iBase;
1766
1767 /* If there is more than one table or sub-select in the FROM clause of
1768 ** this query, then it will not be possible to show that the DISTINCT
1769 ** clause is redundant. */
1770 if( pTabList->nSrc!=1 ) return 0;
1771 iBase = pTabList->a[0].iCursor;
1772 pTab = pTabList->a[0].pTab;
1773
dan94e08d92011-07-02 06:44:05 +00001774 /* If any of the expressions is an IPK column on table iBase, then return
1775 ** true. Note: The (p->iTable==iBase) part of this test may be false if the
1776 ** current SELECT is a correlated sub-query.
1777 */
dan6f343962011-07-01 18:26:40 +00001778 for(i=0; i<pDistinct->nExpr; i++){
drh580c8c12012-12-08 03:34:04 +00001779 Expr *p = sqlite3ExprSkipCollate(pDistinct->a[i].pExpr);
dan94e08d92011-07-02 06:44:05 +00001780 if( p->op==TK_COLUMN && p->iTable==iBase && p->iColumn<0 ) return 1;
dan6f343962011-07-01 18:26:40 +00001781 }
1782
1783 /* Loop through all indices on the table, checking each to see if it makes
1784 ** the DISTINCT qualifier redundant. It does so if:
1785 **
1786 ** 1. The index is itself UNIQUE, and
1787 **
1788 ** 2. All of the columns in the index are either part of the pDistinct
1789 ** list, or else the WHERE clause contains a term of the form "col=X",
1790 ** where X is a constant value. The collation sequences of the
1791 ** comparison and select-list expressions must match those of the index.
dan6a36f432012-04-20 16:59:24 +00001792 **
1793 ** 3. All of those index columns for which the WHERE clause does not
1794 ** contain a "col=X" term are subject to a NOT NULL constraint.
dan6f343962011-07-01 18:26:40 +00001795 */
1796 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1797 if( pIdx->onError==OE_None ) continue;
1798 for(i=0; i<pIdx->nColumn; i++){
1799 int iCol = pIdx->aiColumn[i];
dan6a36f432012-04-20 16:59:24 +00001800 if( 0==findTerm(pWC, iBase, iCol, ~(Bitmask)0, WO_EQ, pIdx) ){
1801 int iIdxCol = findIndexCol(pParse, pDistinct, iBase, pIdx, i);
1802 if( iIdxCol<0 || pTab->aCol[pIdx->aiColumn[i]].notNull==0 ){
1803 break;
1804 }
dan6f343962011-07-01 18:26:40 +00001805 }
1806 }
1807 if( i==pIdx->nColumn ){
1808 /* This index implies that the DISTINCT qualifier is redundant. */
1809 return 1;
1810 }
1811 }
1812
1813 return 0;
1814}
drh0fcef5e2005-07-19 17:38:22 +00001815
drh75897232000-05-29 14:26:00 +00001816/*
drhb6fb62d2005-09-20 08:47:20 +00001817** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +00001818** The results need not be exact. This is only used for estimating
drh909626d2008-05-30 14:58:37 +00001819** the total cost of performing operations with O(logN) or O(NlogN)
drh28c4cf42005-07-27 20:41:43 +00001820** complexity. Because N is just a guess, it is no great tragedy if
1821** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +00001822*/
1823static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +00001824 double logN = 1;
1825 double x = 10;
drh28c4cf42005-07-27 20:41:43 +00001826 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +00001827 logN += 1;
drh28c4cf42005-07-27 20:41:43 +00001828 x *= 10;
1829 }
1830 return logN;
1831}
1832
drh6d209d82006-06-27 01:54:26 +00001833/*
1834** Two routines for printing the content of an sqlite3_index_info
1835** structure. Used for testing and debugging only. If neither
1836** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1837** are no-ops.
1838*/
drh77a2a5e2007-04-06 01:04:39 +00001839#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_DEBUG)
drh6d209d82006-06-27 01:54:26 +00001840static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1841 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001842 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001843 for(i=0; i<p->nConstraint; i++){
1844 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1845 i,
1846 p->aConstraint[i].iColumn,
1847 p->aConstraint[i].iTermOffset,
1848 p->aConstraint[i].op,
1849 p->aConstraint[i].usable);
1850 }
1851 for(i=0; i<p->nOrderBy; i++){
1852 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1853 i,
1854 p->aOrderBy[i].iColumn,
1855 p->aOrderBy[i].desc);
1856 }
1857}
1858static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1859 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001860 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001861 for(i=0; i<p->nConstraint; i++){
1862 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1863 i,
1864 p->aConstraintUsage[i].argvIndex,
1865 p->aConstraintUsage[i].omit);
1866 }
1867 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1868 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1869 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1870 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
1871}
1872#else
1873#define TRACE_IDX_INPUTS(A)
1874#define TRACE_IDX_OUTPUTS(A)
1875#endif
1876
danielk19771d461462009-04-21 09:02:45 +00001877/*
1878** Required because bestIndex() is called by bestOrClauseIndex()
1879*/
drh56f1b992012-09-25 14:29:39 +00001880static void bestIndex(WhereBestIdx*);
danielk19771d461462009-04-21 09:02:45 +00001881
1882/*
1883** This routine attempts to find an scanning strategy that can be used
1884** to optimize an 'OR' expression that is part of a WHERE clause.
1885**
1886** The table associated with FROM clause term pSrc may be either a
1887** regular B-Tree table or a virtual table.
1888*/
drh56f1b992012-09-25 14:29:39 +00001889static void bestOrClauseIndex(WhereBestIdx *p){
danielk19771d461462009-04-21 09:02:45 +00001890#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drh56f1b992012-09-25 14:29:39 +00001891 WhereClause *pWC = p->pWC; /* The WHERE clause */
1892 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
1893 const int iCur = pSrc->iCursor; /* The cursor of the table */
danielk19771d461462009-04-21 09:02:45 +00001894 const Bitmask maskSrc = getMask(pWC->pMaskSet, iCur); /* Bitmask for pSrc */
1895 WhereTerm * const pWCEnd = &pWC->a[pWC->nTerm]; /* End of pWC->a[] */
drh56f1b992012-09-25 14:29:39 +00001896 WhereTerm *pTerm; /* A single term of the WHERE clause */
danielk19771d461462009-04-21 09:02:45 +00001897
drh9ef61f42011-10-07 14:40:59 +00001898 /* The OR-clause optimization is disallowed if the INDEXED BY or
1899 ** NOT INDEXED clauses are used or if the WHERE_AND_ONLY bit is set. */
drh75ad2602010-10-21 02:05:06 +00001900 if( pSrc->notIndexed || pSrc->pIndex!=0 ){
drhed754ce2010-04-15 01:04:54 +00001901 return;
1902 }
drh9ef61f42011-10-07 14:40:59 +00001903 if( pWC->wctrlFlags & WHERE_AND_ONLY ){
1904 return;
1905 }
drhed754ce2010-04-15 01:04:54 +00001906
danielk19771d461462009-04-21 09:02:45 +00001907 /* Search the WHERE clause terms for a usable WO_OR term. */
1908 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001909 if( (pTerm->eOperator & WO_OR)!=0
drh56f1b992012-09-25 14:29:39 +00001910 && ((pTerm->prereqAll & ~maskSrc) & p->notReady)==0
danielk19771d461462009-04-21 09:02:45 +00001911 && (pTerm->u.pOrInfo->indexable & maskSrc)!=0
1912 ){
1913 WhereClause * const pOrWC = &pTerm->u.pOrInfo->wc;
1914 WhereTerm * const pOrWCEnd = &pOrWC->a[pOrWC->nTerm];
1915 WhereTerm *pOrTerm;
1916 int flags = WHERE_MULTI_OR;
1917 double rTotal = 0;
1918 double nRow = 0;
dan5236ac12009-08-13 07:09:33 +00001919 Bitmask used = 0;
drh56f1b992012-09-25 14:29:39 +00001920 WhereBestIdx sBOI;
danielk19771d461462009-04-21 09:02:45 +00001921
drh56f1b992012-09-25 14:29:39 +00001922 sBOI = *p;
1923 sBOI.pOrderBy = 0;
1924 sBOI.pDistinct = 0;
1925 sBOI.ppIdxInfo = 0;
danielk19771d461462009-04-21 09:02:45 +00001926 for(pOrTerm=pOrWC->a; pOrTerm<pOrWCEnd; pOrTerm++){
drhf1b5f5b2013-05-02 00:15:01 +00001927 /*WHERETRACE(("... Multi-index OR testing for term %d of %d....\n",
danielk19771d461462009-04-21 09:02:45 +00001928 (pOrTerm - pOrWC->a), (pTerm - pWC->a)
drhf1b5f5b2013-05-02 00:15:01 +00001929 ));*/
drh7a5bcc02013-01-16 17:08:58 +00001930 if( (pOrTerm->eOperator& WO_AND)!=0 ){
drh56f1b992012-09-25 14:29:39 +00001931 sBOI.pWC = &pOrTerm->u.pAndInfo->wc;
1932 bestIndex(&sBOI);
danielk19771d461462009-04-21 09:02:45 +00001933 }else if( pOrTerm->leftCursor==iCur ){
1934 WhereClause tempWC;
1935 tempWC.pParse = pWC->pParse;
1936 tempWC.pMaskSet = pWC->pMaskSet;
drh8871ef52011-10-07 13:33:10 +00001937 tempWC.pOuter = pWC;
danielk19771d461462009-04-21 09:02:45 +00001938 tempWC.op = TK_AND;
1939 tempWC.a = pOrTerm;
drha2153f72011-10-18 19:14:33 +00001940 tempWC.wctrlFlags = 0;
danielk19771d461462009-04-21 09:02:45 +00001941 tempWC.nTerm = 1;
drh56f1b992012-09-25 14:29:39 +00001942 sBOI.pWC = &tempWC;
1943 bestIndex(&sBOI);
danielk19771d461462009-04-21 09:02:45 +00001944 }else{
1945 continue;
1946 }
drh56f1b992012-09-25 14:29:39 +00001947 rTotal += sBOI.cost.rCost;
1948 nRow += sBOI.cost.plan.nRow;
1949 used |= sBOI.cost.used;
1950 if( rTotal>=p->cost.rCost ) break;
danielk19771d461462009-04-21 09:02:45 +00001951 }
1952
1953 /* If there is an ORDER BY clause, increase the scan cost to account
1954 ** for the cost of the sort. */
drh56f1b992012-09-25 14:29:39 +00001955 if( p->pOrderBy!=0 ){
drhf1b5f5b2013-05-02 00:15:01 +00001956 /*WHERETRACE(("... sorting increases OR cost %.9g to %.9g\n",
1957 rTotal, rTotal+nRow*estLog(nRow)));*/
danielk19771d461462009-04-21 09:02:45 +00001958 rTotal += nRow*estLog(nRow);
danielk19771d461462009-04-21 09:02:45 +00001959 }
1960
1961 /* If the cost of scanning using this OR term for optimization is
1962 ** less than the current cost stored in pCost, replace the contents
1963 ** of pCost. */
drhf1b5f5b2013-05-02 00:15:01 +00001964 /*WHERETRACE(("... multi-index OR cost=%.9g nrow=%.9g\n", rTotal, nRow));*/
drh56f1b992012-09-25 14:29:39 +00001965 if( rTotal<p->cost.rCost ){
1966 p->cost.rCost = rTotal;
1967 p->cost.used = used;
1968 p->cost.plan.nRow = nRow;
drhd663b5b2012-10-03 00:25:54 +00001969 p->cost.plan.nOBSat = p->i ? p->aLevel[p->i-1].plan.nOBSat : 0;
drh56f1b992012-09-25 14:29:39 +00001970 p->cost.plan.wsFlags = flags;
1971 p->cost.plan.u.pTerm = pTerm;
danielk19771d461462009-04-21 09:02:45 +00001972 }
1973 }
1974 }
1975#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1976}
1977
drhc6339082010-04-07 16:54:58 +00001978#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00001979/*
drh4139c992010-04-07 14:59:45 +00001980** Return TRUE if the WHERE clause term pTerm is of a form where it
1981** could be used with an index to access pSrc, assuming an appropriate
1982** index existed.
1983*/
1984static int termCanDriveIndex(
1985 WhereTerm *pTerm, /* WHERE clause term to check */
1986 struct SrcList_item *pSrc, /* Table we are trying to access */
1987 Bitmask notReady /* Tables in outer loops of the join */
1988){
1989 char aff;
1990 if( pTerm->leftCursor!=pSrc->iCursor ) return 0;
drh7a5bcc02013-01-16 17:08:58 +00001991 if( (pTerm->eOperator & WO_EQ)==0 ) return 0;
drh4139c992010-04-07 14:59:45 +00001992 if( (pTerm->prereqRight & notReady)!=0 ) return 0;
1993 aff = pSrc->pTab->aCol[pTerm->u.leftColumn].affinity;
1994 if( !sqlite3IndexAffinityOk(pTerm->pExpr, aff) ) return 0;
1995 return 1;
1996}
drhc6339082010-04-07 16:54:58 +00001997#endif
drh4139c992010-04-07 14:59:45 +00001998
drhc6339082010-04-07 16:54:58 +00001999#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh4139c992010-04-07 14:59:45 +00002000/*
drh8b307fb2010-04-06 15:57:05 +00002001** If the query plan for pSrc specified in pCost is a full table scan
drh4139c992010-04-07 14:59:45 +00002002** and indexing is allows (if there is no NOT INDEXED clause) and it
drh8b307fb2010-04-06 15:57:05 +00002003** possible to construct a transient index that would perform better
2004** than a full table scan even when the cost of constructing the index
2005** is taken into account, then alter the query plan to use the
2006** transient index.
2007*/
drh56f1b992012-09-25 14:29:39 +00002008static void bestAutomaticIndex(WhereBestIdx *p){
2009 Parse *pParse = p->pParse; /* The parsing context */
2010 WhereClause *pWC = p->pWC; /* The WHERE clause */
2011 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
2012 double nTableRow; /* Rows in the input table */
2013 double logN; /* log(nTableRow) */
drh8b307fb2010-04-06 15:57:05 +00002014 double costTempIdx; /* per-query cost of the transient index */
2015 WhereTerm *pTerm; /* A single term of the WHERE clause */
2016 WhereTerm *pWCEnd; /* End of pWC->a[] */
drh424aab82010-04-06 18:28:20 +00002017 Table *pTable; /* Table tht might be indexed */
drh8b307fb2010-04-06 15:57:05 +00002018
dan969e5592011-07-02 15:32:57 +00002019 if( pParse->nQueryLoop<=(double)1 ){
2020 /* There is no point in building an automatic index for a single scan */
2021 return;
2022 }
drhc6339082010-04-07 16:54:58 +00002023 if( (pParse->db->flags & SQLITE_AutoIndex)==0 ){
2024 /* Automatic indices are disabled at run-time */
2025 return;
2026 }
drh447b2892012-10-26 18:40:01 +00002027 if( (p->cost.plan.wsFlags & WHERE_NOT_FULLSCAN)!=0
2028 && (p->cost.plan.wsFlags & WHERE_COVER_SCAN)==0
2029 ){
drh8b307fb2010-04-06 15:57:05 +00002030 /* We already have some kind of index in use for this query. */
2031 return;
2032 }
drhda998c82012-10-30 15:31:31 +00002033 if( pSrc->viaCoroutine ){
2034 /* Cannot index a co-routine */
2035 return;
2036 }
drh8b307fb2010-04-06 15:57:05 +00002037 if( pSrc->notIndexed ){
2038 /* The NOT INDEXED clause appears in the SQL. */
2039 return;
2040 }
danda79cf02011-07-08 16:10:54 +00002041 if( pSrc->isCorrelated ){
2042 /* The source is a correlated sub-query. No point in indexing it. */
2043 return;
2044 }
drh8b307fb2010-04-06 15:57:05 +00002045
2046 assert( pParse->nQueryLoop >= (double)1 );
drh8bd54122010-04-08 15:00:59 +00002047 pTable = pSrc->pTab;
drh15564052010-09-25 22:32:56 +00002048 nTableRow = pTable->nRowEst;
drh8b307fb2010-04-06 15:57:05 +00002049 logN = estLog(nTableRow);
2050 costTempIdx = 2*logN*(nTableRow/pParse->nQueryLoop + 1);
drh56f1b992012-09-25 14:29:39 +00002051 if( costTempIdx>=p->cost.rCost ){
drh8b307fb2010-04-06 15:57:05 +00002052 /* The cost of creating the transient table would be greater than
2053 ** doing the full table scan */
2054 return;
2055 }
2056
2057 /* Search for any equality comparison term */
2058 pWCEnd = &pWC->a[pWC->nTerm];
2059 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh56f1b992012-09-25 14:29:39 +00002060 if( termCanDriveIndex(pTerm, pSrc, p->notReady) ){
drhf1b5f5b2013-05-02 00:15:01 +00002061 /*WHERETRACE(("auto-index reduces cost from %.1f to %.1f\n",
2062 p->cost.rCost, costTempIdx));*/
drh56f1b992012-09-25 14:29:39 +00002063 p->cost.rCost = costTempIdx;
2064 p->cost.plan.nRow = logN + 1;
2065 p->cost.plan.wsFlags = WHERE_TEMP_INDEX;
2066 p->cost.used = pTerm->prereqRight;
drh8b307fb2010-04-06 15:57:05 +00002067 break;
2068 }
2069 }
2070}
drhc6339082010-04-07 16:54:58 +00002071#else
drh56f1b992012-09-25 14:29:39 +00002072# define bestAutomaticIndex(A) /* no-op */
drhc6339082010-04-07 16:54:58 +00002073#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh8b307fb2010-04-06 15:57:05 +00002074
drhc6339082010-04-07 16:54:58 +00002075
2076#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00002077/*
drhc6339082010-04-07 16:54:58 +00002078** Generate code to construct the Index object for an automatic index
2079** and to set up the WhereLevel object pLevel so that the code generator
2080** makes use of the automatic index.
drh8b307fb2010-04-06 15:57:05 +00002081*/
drhc6339082010-04-07 16:54:58 +00002082static void constructAutomaticIndex(
drh8b307fb2010-04-06 15:57:05 +00002083 Parse *pParse, /* The parsing context */
2084 WhereClause *pWC, /* The WHERE clause */
2085 struct SrcList_item *pSrc, /* The FROM clause term to get the next index */
2086 Bitmask notReady, /* Mask of cursors that are not available */
2087 WhereLevel *pLevel /* Write new index here */
2088){
2089 int nColumn; /* Number of columns in the constructed index */
2090 WhereTerm *pTerm; /* A single term of the WHERE clause */
2091 WhereTerm *pWCEnd; /* End of pWC->a[] */
2092 int nByte; /* Byte of memory needed for pIdx */
2093 Index *pIdx; /* Object describing the transient index */
2094 Vdbe *v; /* Prepared statement under construction */
drh8b307fb2010-04-06 15:57:05 +00002095 int addrInit; /* Address of the initialization bypass jump */
2096 Table *pTable; /* The table being indexed */
2097 KeyInfo *pKeyinfo; /* Key information for the index */
2098 int addrTop; /* Top of the index fill loop */
2099 int regRecord; /* Register holding an index record */
2100 int n; /* Column counter */
drh4139c992010-04-07 14:59:45 +00002101 int i; /* Loop counter */
2102 int mxBitCol; /* Maximum column in pSrc->colUsed */
drh424aab82010-04-06 18:28:20 +00002103 CollSeq *pColl; /* Collating sequence to on a column */
drh4139c992010-04-07 14:59:45 +00002104 Bitmask idxCols; /* Bitmap of columns used for indexing */
2105 Bitmask extraCols; /* Bitmap of additional columns */
drh8b307fb2010-04-06 15:57:05 +00002106
2107 /* Generate code to skip over the creation and initialization of the
2108 ** transient index on 2nd and subsequent iterations of the loop. */
2109 v = pParse->pVdbe;
2110 assert( v!=0 );
dan1d8cb212011-12-09 13:24:16 +00002111 addrInit = sqlite3CodeOnce(pParse);
drh8b307fb2010-04-06 15:57:05 +00002112
drh4139c992010-04-07 14:59:45 +00002113 /* Count the number of columns that will be added to the index
2114 ** and used to match WHERE clause constraints */
drh8b307fb2010-04-06 15:57:05 +00002115 nColumn = 0;
drh424aab82010-04-06 18:28:20 +00002116 pTable = pSrc->pTab;
drh8b307fb2010-04-06 15:57:05 +00002117 pWCEnd = &pWC->a[pWC->nTerm];
drh4139c992010-04-07 14:59:45 +00002118 idxCols = 0;
drh8b307fb2010-04-06 15:57:05 +00002119 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00002120 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
2121 int iCol = pTerm->u.leftColumn;
drh0013e722010-04-08 00:40:15 +00002122 Bitmask cMask = iCol>=BMS ? ((Bitmask)1)<<(BMS-1) : ((Bitmask)1)<<iCol;
drh52ff8ea2010-04-08 14:15:56 +00002123 testcase( iCol==BMS );
2124 testcase( iCol==BMS-1 );
drh0013e722010-04-08 00:40:15 +00002125 if( (idxCols & cMask)==0 ){
2126 nColumn++;
2127 idxCols |= cMask;
2128 }
drh8b307fb2010-04-06 15:57:05 +00002129 }
2130 }
2131 assert( nColumn>0 );
drh424aab82010-04-06 18:28:20 +00002132 pLevel->plan.nEq = nColumn;
drh4139c992010-04-07 14:59:45 +00002133
2134 /* Count the number of additional columns needed to create a
2135 ** covering index. A "covering index" is an index that contains all
2136 ** columns that are needed by the query. With a covering index, the
2137 ** original table never needs to be accessed. Automatic indices must
2138 ** be a covering index because the index will not be updated if the
2139 ** original table changes and the index and table cannot both be used
2140 ** if they go out of sync.
2141 */
drh0013e722010-04-08 00:40:15 +00002142 extraCols = pSrc->colUsed & (~idxCols | (((Bitmask)1)<<(BMS-1)));
drh4139c992010-04-07 14:59:45 +00002143 mxBitCol = (pTable->nCol >= BMS-1) ? BMS-1 : pTable->nCol;
drh52ff8ea2010-04-08 14:15:56 +00002144 testcase( pTable->nCol==BMS-1 );
2145 testcase( pTable->nCol==BMS-2 );
drh4139c992010-04-07 14:59:45 +00002146 for(i=0; i<mxBitCol; i++){
drh67ae0cb2010-04-08 14:38:51 +00002147 if( extraCols & (((Bitmask)1)<<i) ) nColumn++;
drh4139c992010-04-07 14:59:45 +00002148 }
2149 if( pSrc->colUsed & (((Bitmask)1)<<(BMS-1)) ){
2150 nColumn += pTable->nCol - BMS + 1;
2151 }
2152 pLevel->plan.wsFlags |= WHERE_COLUMN_EQ | WHERE_IDX_ONLY | WO_EQ;
drh8b307fb2010-04-06 15:57:05 +00002153
2154 /* Construct the Index object to describe this index */
2155 nByte = sizeof(Index);
2156 nByte += nColumn*sizeof(int); /* Index.aiColumn */
2157 nByte += nColumn*sizeof(char*); /* Index.azColl */
2158 nByte += nColumn; /* Index.aSortOrder */
2159 pIdx = sqlite3DbMallocZero(pParse->db, nByte);
2160 if( pIdx==0 ) return;
2161 pLevel->plan.u.pIdx = pIdx;
2162 pIdx->azColl = (char**)&pIdx[1];
2163 pIdx->aiColumn = (int*)&pIdx->azColl[nColumn];
2164 pIdx->aSortOrder = (u8*)&pIdx->aiColumn[nColumn];
2165 pIdx->zName = "auto-index";
2166 pIdx->nColumn = nColumn;
drh424aab82010-04-06 18:28:20 +00002167 pIdx->pTable = pTable;
drh8b307fb2010-04-06 15:57:05 +00002168 n = 0;
drh0013e722010-04-08 00:40:15 +00002169 idxCols = 0;
drh8b307fb2010-04-06 15:57:05 +00002170 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00002171 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
drh0013e722010-04-08 00:40:15 +00002172 int iCol = pTerm->u.leftColumn;
2173 Bitmask cMask = iCol>=BMS ? ((Bitmask)1)<<(BMS-1) : ((Bitmask)1)<<iCol;
2174 if( (idxCols & cMask)==0 ){
2175 Expr *pX = pTerm->pExpr;
2176 idxCols |= cMask;
2177 pIdx->aiColumn[n] = pTerm->u.leftColumn;
2178 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
drh6f2e6c02011-02-17 13:33:15 +00002179 pIdx->azColl[n] = ALWAYS(pColl) ? pColl->zName : "BINARY";
drh0013e722010-04-08 00:40:15 +00002180 n++;
2181 }
drh8b307fb2010-04-06 15:57:05 +00002182 }
2183 }
shaneh5eba1f62010-07-02 17:05:03 +00002184 assert( (u32)n==pLevel->plan.nEq );
drh4139c992010-04-07 14:59:45 +00002185
drhc6339082010-04-07 16:54:58 +00002186 /* Add additional columns needed to make the automatic index into
2187 ** a covering index */
drh4139c992010-04-07 14:59:45 +00002188 for(i=0; i<mxBitCol; i++){
drh67ae0cb2010-04-08 14:38:51 +00002189 if( extraCols & (((Bitmask)1)<<i) ){
drh4139c992010-04-07 14:59:45 +00002190 pIdx->aiColumn[n] = i;
2191 pIdx->azColl[n] = "BINARY";
2192 n++;
2193 }
2194 }
2195 if( pSrc->colUsed & (((Bitmask)1)<<(BMS-1)) ){
2196 for(i=BMS-1; i<pTable->nCol; i++){
2197 pIdx->aiColumn[n] = i;
2198 pIdx->azColl[n] = "BINARY";
2199 n++;
2200 }
2201 }
2202 assert( n==nColumn );
drh8b307fb2010-04-06 15:57:05 +00002203
drhc6339082010-04-07 16:54:58 +00002204 /* Create the automatic index */
drh8b307fb2010-04-06 15:57:05 +00002205 pKeyinfo = sqlite3IndexKeyinfo(pParse, pIdx);
2206 assert( pLevel->iIdxCur>=0 );
drha21a64d2010-04-06 22:33:55 +00002207 sqlite3VdbeAddOp4(v, OP_OpenAutoindex, pLevel->iIdxCur, nColumn+1, 0,
drh8b307fb2010-04-06 15:57:05 +00002208 (char*)pKeyinfo, P4_KEYINFO_HANDOFF);
drha21a64d2010-04-06 22:33:55 +00002209 VdbeComment((v, "for %s", pTable->zName));
drh8b307fb2010-04-06 15:57:05 +00002210
drhc6339082010-04-07 16:54:58 +00002211 /* Fill the automatic index with content */
drh8b307fb2010-04-06 15:57:05 +00002212 addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, pLevel->iTabCur);
2213 regRecord = sqlite3GetTempReg(pParse);
2214 sqlite3GenerateIndexKey(pParse, pIdx, pLevel->iTabCur, regRecord, 1);
2215 sqlite3VdbeAddOp2(v, OP_IdxInsert, pLevel->iIdxCur, regRecord);
2216 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2217 sqlite3VdbeAddOp2(v, OP_Next, pLevel->iTabCur, addrTop+1);
drha21a64d2010-04-06 22:33:55 +00002218 sqlite3VdbeChangeP5(v, SQLITE_STMTSTATUS_AUTOINDEX);
drh8b307fb2010-04-06 15:57:05 +00002219 sqlite3VdbeJumpHere(v, addrTop);
2220 sqlite3ReleaseTempReg(pParse, regRecord);
2221
2222 /* Jump here when skipping the initialization */
2223 sqlite3VdbeJumpHere(v, addrInit);
2224}
drhc6339082010-04-07 16:54:58 +00002225#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh8b307fb2010-04-06 15:57:05 +00002226
drh9eff6162006-06-12 21:59:13 +00002227#ifndef SQLITE_OMIT_VIRTUALTABLE
2228/*
danielk19771d461462009-04-21 09:02:45 +00002229** Allocate and populate an sqlite3_index_info structure. It is the
2230** responsibility of the caller to eventually release the structure
2231** by passing the pointer returned by this function to sqlite3_free().
2232*/
drh5346e952013-05-08 14:14:26 +00002233static sqlite3_index_info *allocateIndexInfo(
2234 Parse *pParse,
2235 WhereClause *pWC,
2236 struct SrcList_item *pSrc,
2237 ExprList *pOrderBy
2238){
danielk19771d461462009-04-21 09:02:45 +00002239 int i, j;
2240 int nTerm;
2241 struct sqlite3_index_constraint *pIdxCons;
2242 struct sqlite3_index_orderby *pIdxOrderBy;
2243 struct sqlite3_index_constraint_usage *pUsage;
2244 WhereTerm *pTerm;
2245 int nOrderBy;
2246 sqlite3_index_info *pIdxInfo;
2247
drhf1b5f5b2013-05-02 00:15:01 +00002248 /*WHERETRACE(("Recomputing index info for %s...\n", pSrc->pTab->zName));*/
danielk19771d461462009-04-21 09:02:45 +00002249
2250 /* Count the number of possible WHERE clause constraints referring
2251 ** to this virtual table */
2252 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
2253 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh7a5bcc02013-01-16 17:08:58 +00002254 assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
2255 testcase( pTerm->eOperator & WO_IN );
2256 testcase( pTerm->eOperator & WO_ISNULL );
drh281bbe22012-10-16 23:17:14 +00002257 if( pTerm->eOperator & (WO_ISNULL) ) continue;
drhb4256992011-08-02 01:57:39 +00002258 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00002259 nTerm++;
2260 }
2261
2262 /* If the ORDER BY clause contains only columns in the current
2263 ** virtual table then allocate space for the aOrderBy part of
2264 ** the sqlite3_index_info structure.
2265 */
2266 nOrderBy = 0;
2267 if( pOrderBy ){
drh56f1b992012-09-25 14:29:39 +00002268 int n = pOrderBy->nExpr;
2269 for(i=0; i<n; i++){
danielk19771d461462009-04-21 09:02:45 +00002270 Expr *pExpr = pOrderBy->a[i].pExpr;
2271 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
2272 }
drh56f1b992012-09-25 14:29:39 +00002273 if( i==n){
2274 nOrderBy = n;
danielk19771d461462009-04-21 09:02:45 +00002275 }
2276 }
2277
2278 /* Allocate the sqlite3_index_info structure
2279 */
2280 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
2281 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
2282 + sizeof(*pIdxOrderBy)*nOrderBy );
2283 if( pIdxInfo==0 ){
2284 sqlite3ErrorMsg(pParse, "out of memory");
2285 /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
2286 return 0;
2287 }
2288
2289 /* Initialize the structure. The sqlite3_index_info structure contains
2290 ** many fields that are declared "const" to prevent xBestIndex from
2291 ** changing them. We have to do some funky casting in order to
2292 ** initialize those fields.
2293 */
2294 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
2295 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
2296 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
2297 *(int*)&pIdxInfo->nConstraint = nTerm;
2298 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
2299 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
2300 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
2301 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
2302 pUsage;
2303
2304 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
drh281bbe22012-10-16 23:17:14 +00002305 u8 op;
danielk19771d461462009-04-21 09:02:45 +00002306 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh7a5bcc02013-01-16 17:08:58 +00002307 assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
2308 testcase( pTerm->eOperator & WO_IN );
2309 testcase( pTerm->eOperator & WO_ISNULL );
drh281bbe22012-10-16 23:17:14 +00002310 if( pTerm->eOperator & (WO_ISNULL) ) continue;
drhb4256992011-08-02 01:57:39 +00002311 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00002312 pIdxCons[j].iColumn = pTerm->u.leftColumn;
2313 pIdxCons[j].iTermOffset = i;
drh7a5bcc02013-01-16 17:08:58 +00002314 op = (u8)pTerm->eOperator & WO_ALL;
drh281bbe22012-10-16 23:17:14 +00002315 if( op==WO_IN ) op = WO_EQ;
2316 pIdxCons[j].op = op;
danielk19771d461462009-04-21 09:02:45 +00002317 /* The direct assignment in the previous line is possible only because
2318 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
2319 ** following asserts verify this fact. */
2320 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
2321 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
2322 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
2323 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
2324 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
2325 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
drh281bbe22012-10-16 23:17:14 +00002326 assert( pTerm->eOperator & (WO_IN|WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
danielk19771d461462009-04-21 09:02:45 +00002327 j++;
2328 }
2329 for(i=0; i<nOrderBy; i++){
2330 Expr *pExpr = pOrderBy->a[i].pExpr;
2331 pIdxOrderBy[i].iColumn = pExpr->iColumn;
2332 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
2333 }
2334
2335 return pIdxInfo;
2336}
2337
2338/*
2339** The table object reference passed as the second argument to this function
2340** must represent a virtual table. This function invokes the xBestIndex()
2341** method of the virtual table with the sqlite3_index_info pointer passed
2342** as the argument.
2343**
2344** If an error occurs, pParse is populated with an error message and a
2345** non-zero value is returned. Otherwise, 0 is returned and the output
2346** part of the sqlite3_index_info structure is left populated.
2347**
2348** Whether or not an error is returned, it is the responsibility of the
2349** caller to eventually free p->idxStr if p->needToFreeIdxStr indicates
2350** that this is required.
2351*/
2352static int vtabBestIndex(Parse *pParse, Table *pTab, sqlite3_index_info *p){
danielk1977595a5232009-07-24 17:58:53 +00002353 sqlite3_vtab *pVtab = sqlite3GetVTable(pParse->db, pTab)->pVtab;
danielk19771d461462009-04-21 09:02:45 +00002354 int i;
2355 int rc;
2356
drhf1b5f5b2013-05-02 00:15:01 +00002357 /*WHERETRACE(("xBestIndex for %s\n", pTab->zName));*/
danielk19771d461462009-04-21 09:02:45 +00002358 TRACE_IDX_INPUTS(p);
2359 rc = pVtab->pModule->xBestIndex(pVtab, p);
2360 TRACE_IDX_OUTPUTS(p);
danielk19771d461462009-04-21 09:02:45 +00002361
2362 if( rc!=SQLITE_OK ){
2363 if( rc==SQLITE_NOMEM ){
2364 pParse->db->mallocFailed = 1;
2365 }else if( !pVtab->zErrMsg ){
2366 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
2367 }else{
2368 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
2369 }
2370 }
drhb9755982010-07-24 16:34:37 +00002371 sqlite3_free(pVtab->zErrMsg);
danielk19771d461462009-04-21 09:02:45 +00002372 pVtab->zErrMsg = 0;
2373
2374 for(i=0; i<p->nConstraint; i++){
2375 if( !p->aConstraint[i].usable && p->aConstraintUsage[i].argvIndex>0 ){
2376 sqlite3ErrorMsg(pParse,
2377 "table %s: xBestIndex returned an invalid plan", pTab->zName);
2378 }
2379 }
2380
2381 return pParse->nErr;
2382}
2383
2384
2385/*
drh7f375902006-06-13 17:38:59 +00002386** Compute the best index for a virtual table.
2387**
2388** The best index is computed by the xBestIndex method of the virtual
2389** table module. This routine is really just a wrapper that sets up
2390** the sqlite3_index_info structure that is used to communicate with
2391** xBestIndex.
2392**
2393** In a join, this routine might be called multiple times for the
2394** same virtual table. The sqlite3_index_info structure is created
2395** and initialized on the first invocation and reused on all subsequent
2396** invocations. The sqlite3_index_info structure is also used when
2397** code is generated to access the virtual table. The whereInfoDelete()
2398** routine takes care of freeing the sqlite3_index_info structure after
2399** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00002400*/
drh56f1b992012-09-25 14:29:39 +00002401static void bestVirtualIndex(WhereBestIdx *p){
2402 Parse *pParse = p->pParse; /* The parsing context */
2403 WhereClause *pWC = p->pWC; /* The WHERE clause */
2404 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
drh9eff6162006-06-12 21:59:13 +00002405 Table *pTab = pSrc->pTab;
2406 sqlite3_index_info *pIdxInfo;
2407 struct sqlite3_index_constraint *pIdxCons;
drh9eff6162006-06-12 21:59:13 +00002408 struct sqlite3_index_constraint_usage *pUsage;
2409 WhereTerm *pTerm;
drh83b5bfc2013-04-18 02:55:54 +00002410 int i, j;
drh9eff6162006-06-12 21:59:13 +00002411 int nOrderBy;
drhe40ed782012-12-14 15:36:17 +00002412 int bAllowIN; /* Allow IN optimizations */
danc26c0042010-03-27 09:44:42 +00002413 double rCost;
drh9eff6162006-06-12 21:59:13 +00002414
danielk19776eacd282009-04-29 11:50:53 +00002415 /* Make sure wsFlags is initialized to some sane value. Otherwise, if the
2416 ** malloc in allocateIndexInfo() fails and this function returns leaving
2417 ** wsFlags in an uninitialized state, the caller may behave unpredictably.
2418 */
drh56f1b992012-09-25 14:29:39 +00002419 memset(&p->cost, 0, sizeof(p->cost));
2420 p->cost.plan.wsFlags = WHERE_VIRTUALTABLE;
danielk19776eacd282009-04-29 11:50:53 +00002421
drh9eff6162006-06-12 21:59:13 +00002422 /* If the sqlite3_index_info structure has not been previously
danielk19771d461462009-04-21 09:02:45 +00002423 ** allocated and initialized, then allocate and initialize it now.
drh9eff6162006-06-12 21:59:13 +00002424 */
drh56f1b992012-09-25 14:29:39 +00002425 pIdxInfo = *p->ppIdxInfo;
drh9eff6162006-06-12 21:59:13 +00002426 if( pIdxInfo==0 ){
drh5346e952013-05-08 14:14:26 +00002427 *p->ppIdxInfo = pIdxInfo = allocateIndexInfo(pParse,pWC,pSrc,p->pOrderBy);
drh9eff6162006-06-12 21:59:13 +00002428 }
danielk1977732dc552009-04-21 17:23:04 +00002429 if( pIdxInfo==0 ){
2430 return;
2431 }
drh9eff6162006-06-12 21:59:13 +00002432
drh7f375902006-06-13 17:38:59 +00002433 /* At this point, the sqlite3_index_info structure that pIdxInfo points
2434 ** to will have been initialized, either during the current invocation or
2435 ** during some prior invocation. Now we just have to customize the
2436 ** details of pIdxInfo for the current invocation and pass it to
2437 ** xBestIndex.
2438 */
2439
danielk1977935ed5e2007-03-30 09:13:13 +00002440 /* The module name must be defined. Also, by this point there must
2441 ** be a pointer to an sqlite3_vtab structure. Otherwise
2442 ** sqlite3ViewGetColumnNames() would have picked up the error.
2443 */
drh9eff6162006-06-12 21:59:13 +00002444 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
danielk1977595a5232009-07-24 17:58:53 +00002445 assert( sqlite3GetVTable(pParse->db, pTab) );
drh9eff6162006-06-12 21:59:13 +00002446
drhe40ed782012-12-14 15:36:17 +00002447 /* Try once or twice. On the first attempt, allow IN optimizations.
drhd0302532012-12-14 17:48:08 +00002448 ** If an IN optimization is accepted by the virtual table xBestIndex
2449 ** method, but the pInfo->aConstrainUsage.omit flag is not set, then
2450 ** the query will not work because it might allow duplicate rows in
2451 ** output. In that case, run the xBestIndex method a second time
2452 ** without the IN constraints. Usually this loop only runs once.
2453 ** The loop will exit using a "break" statement.
drh9eff6162006-06-12 21:59:13 +00002454 */
drhd0302532012-12-14 17:48:08 +00002455 for(bAllowIN=1; 1; bAllowIN--){
2456 assert( bAllowIN==0 || bAllowIN==1 );
2457
drhe40ed782012-12-14 15:36:17 +00002458 /* Set the aConstraint[].usable fields and initialize all
2459 ** output variables to zero.
2460 **
2461 ** aConstraint[].usable is true for constraints where the right-hand
2462 ** side contains only references to tables to the left of the current
2463 ** table. In other words, if the constraint is of the form:
2464 **
2465 ** column = expr
2466 **
2467 ** and we are evaluating a join, then the constraint on column is
2468 ** only valid if all tables referenced in expr occur to the left
2469 ** of the table containing column.
2470 **
2471 ** The aConstraints[] array contains entries for all constraints
2472 ** on the current table. That way we only have to compute it once
2473 ** even though we might try to pick the best index multiple times.
2474 ** For each attempt at picking an index, the order of tables in the
2475 ** join might be different so we have to recompute the usable flag
2476 ** each time.
2477 */
2478 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
2479 pUsage = pIdxInfo->aConstraintUsage;
2480 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
2481 j = pIdxCons->iTermOffset;
2482 pTerm = &pWC->a[j];
2483 if( (pTerm->prereqRight&p->notReady)==0
drh7a5bcc02013-01-16 17:08:58 +00002484 && (bAllowIN || (pTerm->eOperator & WO_IN)==0)
drhe40ed782012-12-14 15:36:17 +00002485 ){
2486 pIdxCons->usable = 1;
2487 }else{
2488 pIdxCons->usable = 0;
2489 }
dan5236ac12009-08-13 07:09:33 +00002490 }
drhe40ed782012-12-14 15:36:17 +00002491 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
2492 if( pIdxInfo->needToFreeIdxStr ){
2493 sqlite3_free(pIdxInfo->idxStr);
2494 }
2495 pIdxInfo->idxStr = 0;
2496 pIdxInfo->idxNum = 0;
2497 pIdxInfo->needToFreeIdxStr = 0;
2498 pIdxInfo->orderByConsumed = 0;
2499 /* ((double)2) In case of SQLITE_OMIT_FLOATING_POINT... */
2500 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / ((double)2);
2501 nOrderBy = pIdxInfo->nOrderBy;
2502 if( !p->pOrderBy ){
2503 pIdxInfo->nOrderBy = 0;
2504 }
2505
2506 if( vtabBestIndex(pParse, pTab, pIdxInfo) ){
2507 return;
2508 }
2509
2510 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
2511 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
2512 if( pUsage[i].argvIndex>0 ){
2513 j = pIdxCons->iTermOffset;
2514 pTerm = &pWC->a[j];
2515 p->cost.used |= pTerm->prereqRight;
drh36670332013-02-08 20:39:02 +00002516 if( (pTerm->eOperator & WO_IN)!=0 ){
2517 if( pUsage[i].omit==0 ){
2518 /* Do not attempt to use an IN constraint if the virtual table
2519 ** says that the equivalent EQ constraint cannot be safely omitted.
2520 ** If we do attempt to use such a constraint, some rows might be
2521 ** repeated in the output. */
2522 break;
2523 }
drh83b5bfc2013-04-18 02:55:54 +00002524 /* A virtual table that is constrained by an IN clause may not
2525 ** consume the ORDER BY clause because (1) the order of IN terms
2526 ** is not necessarily related to the order of output terms and
2527 ** (2) Multiple outputs from a single IN value will not merge
2528 ** together. */
2529 pIdxInfo->orderByConsumed = 0;
drhe40ed782012-12-14 15:36:17 +00002530 }
2531 }
2532 }
2533 if( i>=pIdxInfo->nConstraint ) break;
dan5236ac12009-08-13 07:09:33 +00002534 }
drhd99aaf12013-04-22 19:56:12 +00002535
2536 /* The orderByConsumed signal is only valid if all outer loops collectively
2537 ** generate just a single row of output.
2538 */
2539 if( pIdxInfo->orderByConsumed ){
2540 for(i=0; i<p->i; i++){
2541 if( (p->aLevel[i].plan.wsFlags & WHERE_UNIQUE)==0 ){
2542 pIdxInfo->orderByConsumed = 0;
2543 }
2544 }
2545 }
drhe40ed782012-12-14 15:36:17 +00002546
danc26c0042010-03-27 09:44:42 +00002547 /* If there is an ORDER BY clause, and the selected virtual table index
2548 ** does not satisfy it, increase the cost of the scan accordingly. This
2549 ** matches the processing for non-virtual tables in bestBtreeIndex().
2550 */
2551 rCost = pIdxInfo->estimatedCost;
drh56f1b992012-09-25 14:29:39 +00002552 if( p->pOrderBy && pIdxInfo->orderByConsumed==0 ){
danc26c0042010-03-27 09:44:42 +00002553 rCost += estLog(rCost)*rCost;
2554 }
2555
danielk19771d461462009-04-21 09:02:45 +00002556 /* The cost is not allowed to be larger than SQLITE_BIG_DBL (the
2557 ** inital value of lowestCost in this loop. If it is, then the
2558 ** (cost<lowestCost) test below will never be true.
2559 **
2560 ** Use "(double)2" instead of "2.0" in case OMIT_FLOATING_POINT
2561 ** is defined.
2562 */
danc26c0042010-03-27 09:44:42 +00002563 if( (SQLITE_BIG_DBL/((double)2))<rCost ){
drh56f1b992012-09-25 14:29:39 +00002564 p->cost.rCost = (SQLITE_BIG_DBL/((double)2));
danielk19771d461462009-04-21 09:02:45 +00002565 }else{
drh56f1b992012-09-25 14:29:39 +00002566 p->cost.rCost = rCost;
danielk19771d461462009-04-21 09:02:45 +00002567 }
drh56f1b992012-09-25 14:29:39 +00002568 p->cost.plan.u.pVtabIdx = pIdxInfo;
drh5901b572009-06-10 19:33:28 +00002569 if( pIdxInfo->orderByConsumed ){
drh83b5bfc2013-04-18 02:55:54 +00002570 p->cost.plan.wsFlags |= WHERE_ORDERED;
drhd663b5b2012-10-03 00:25:54 +00002571 p->cost.plan.nOBSat = nOrderBy;
2572 }else{
2573 p->cost.plan.nOBSat = p->i ? p->aLevel[p->i-1].plan.nOBSat : 0;
danielk19771d461462009-04-21 09:02:45 +00002574 }
drh56f1b992012-09-25 14:29:39 +00002575 p->cost.plan.nEq = 0;
danielk19771d461462009-04-21 09:02:45 +00002576 pIdxInfo->nOrderBy = nOrderBy;
2577
2578 /* Try to find a more efficient access pattern by using multiple indexes
2579 ** to optimize an OR expression within the WHERE clause.
2580 */
drh56f1b992012-09-25 14:29:39 +00002581 bestOrClauseIndex(p);
drh9eff6162006-06-12 21:59:13 +00002582}
2583#endif /* SQLITE_OMIT_VIRTUALTABLE */
2584
drhfaacf172011-08-12 01:51:45 +00002585#ifdef SQLITE_ENABLE_STAT3
drh28c4cf42005-07-27 20:41:43 +00002586/*
drhfaacf172011-08-12 01:51:45 +00002587** Estimate the location of a particular key among all keys in an
2588** index. Store the results in aStat as follows:
drhe847d322011-01-20 02:56:37 +00002589**
drhfaacf172011-08-12 01:51:45 +00002590** aStat[0] Est. number of rows less than pVal
2591** aStat[1] Est. number of rows equal to pVal
dan02fa4692009-08-17 17:06:58 +00002592**
drhfaacf172011-08-12 01:51:45 +00002593** Return SQLITE_OK on success.
dan02fa4692009-08-17 17:06:58 +00002594*/
drhfaacf172011-08-12 01:51:45 +00002595static int whereKeyStats(
dan02fa4692009-08-17 17:06:58 +00002596 Parse *pParse, /* Database connection */
2597 Index *pIdx, /* Index to consider domain of */
2598 sqlite3_value *pVal, /* Value to consider */
drhfaacf172011-08-12 01:51:45 +00002599 int roundUp, /* Round up if true. Round down if false */
2600 tRowcnt *aStat /* OUT: stats written here */
dan02fa4692009-08-17 17:06:58 +00002601){
drhfaacf172011-08-12 01:51:45 +00002602 tRowcnt n;
2603 IndexSample *aSample;
2604 int i, eType;
2605 int isEq = 0;
drh4e50c5e2011-08-13 19:35:19 +00002606 i64 v;
2607 double r, rS;
dan02fa4692009-08-17 17:06:58 +00002608
drhfaacf172011-08-12 01:51:45 +00002609 assert( roundUp==0 || roundUp==1 );
drh5c624862011-09-22 18:46:34 +00002610 assert( pIdx->nSample>0 );
drhfaacf172011-08-12 01:51:45 +00002611 if( pVal==0 ) return SQLITE_ERROR;
2612 n = pIdx->aiRowEst[0];
2613 aSample = pIdx->aSample;
drhfaacf172011-08-12 01:51:45 +00002614 eType = sqlite3_value_type(pVal);
2615
2616 if( eType==SQLITE_INTEGER ){
drh4e50c5e2011-08-13 19:35:19 +00002617 v = sqlite3_value_int64(pVal);
2618 r = (i64)v;
drhfaacf172011-08-12 01:51:45 +00002619 for(i=0; i<pIdx->nSample; i++){
2620 if( aSample[i].eType==SQLITE_NULL ) continue;
2621 if( aSample[i].eType>=SQLITE_TEXT ) break;
drh4e50c5e2011-08-13 19:35:19 +00002622 if( aSample[i].eType==SQLITE_INTEGER ){
2623 if( aSample[i].u.i>=v ){
2624 isEq = aSample[i].u.i==v;
2625 break;
2626 }
2627 }else{
2628 assert( aSample[i].eType==SQLITE_FLOAT );
2629 if( aSample[i].u.r>=r ){
2630 isEq = aSample[i].u.r==r;
2631 break;
2632 }
dan02fa4692009-08-17 17:06:58 +00002633 }
drhfaacf172011-08-12 01:51:45 +00002634 }
2635 }else if( eType==SQLITE_FLOAT ){
drh4e50c5e2011-08-13 19:35:19 +00002636 r = sqlite3_value_double(pVal);
drhfaacf172011-08-12 01:51:45 +00002637 for(i=0; i<pIdx->nSample; i++){
2638 if( aSample[i].eType==SQLITE_NULL ) continue;
2639 if( aSample[i].eType>=SQLITE_TEXT ) break;
drh4e50c5e2011-08-13 19:35:19 +00002640 if( aSample[i].eType==SQLITE_FLOAT ){
2641 rS = aSample[i].u.r;
2642 }else{
2643 rS = aSample[i].u.i;
2644 }
2645 if( rS>=r ){
2646 isEq = rS==r;
drhfaacf172011-08-12 01:51:45 +00002647 break;
drh9b3eb0a2011-01-21 14:37:04 +00002648 }
drhfaacf172011-08-12 01:51:45 +00002649 }
2650 }else if( eType==SQLITE_NULL ){
2651 i = 0;
drh5c624862011-09-22 18:46:34 +00002652 if( aSample[0].eType==SQLITE_NULL ) isEq = 1;
drhfaacf172011-08-12 01:51:45 +00002653 }else{
2654 assert( eType==SQLITE_TEXT || eType==SQLITE_BLOB );
2655 for(i=0; i<pIdx->nSample; i++){
2656 if( aSample[i].eType==SQLITE_TEXT || aSample[i].eType==SQLITE_BLOB ){
2657 break;
2658 }
2659 }
2660 if( i<pIdx->nSample ){
dan02fa4692009-08-17 17:06:58 +00002661 sqlite3 *db = pParse->db;
2662 CollSeq *pColl;
2663 const u8 *z;
dan02fa4692009-08-17 17:06:58 +00002664 if( eType==SQLITE_BLOB ){
2665 z = (const u8 *)sqlite3_value_blob(pVal);
2666 pColl = db->pDfltColl;
dane275dc32009-08-18 16:24:58 +00002667 assert( pColl->enc==SQLITE_UTF8 );
dan02fa4692009-08-17 17:06:58 +00002668 }else{
drh79e72a52012-10-05 14:43:40 +00002669 pColl = sqlite3GetCollSeq(pParse, SQLITE_UTF8, 0, *pIdx->azColl);
drh9aeda792009-08-20 02:34:15 +00002670 if( pColl==0 ){
dane275dc32009-08-18 16:24:58 +00002671 return SQLITE_ERROR;
2672 }
dan02fa4692009-08-17 17:06:58 +00002673 z = (const u8 *)sqlite3ValueText(pVal, pColl->enc);
dane275dc32009-08-18 16:24:58 +00002674 if( !z ){
2675 return SQLITE_NOMEM;
2676 }
dan02fa4692009-08-17 17:06:58 +00002677 assert( z && pColl && pColl->xCmp );
2678 }
2679 n = sqlite3ValueBytes(pVal, pColl->enc);
drhfaacf172011-08-12 01:51:45 +00002680
2681 for(; i<pIdx->nSample; i++){
drhe847d322011-01-20 02:56:37 +00002682 int c;
dan02fa4692009-08-17 17:06:58 +00002683 int eSampletype = aSample[i].eType;
drhfaacf172011-08-12 01:51:45 +00002684 if( eSampletype<eType ) continue;
2685 if( eSampletype!=eType ) break;
dane83c4f32009-09-21 16:34:24 +00002686#ifndef SQLITE_OMIT_UTF16
2687 if( pColl->enc!=SQLITE_UTF8 ){
dane275dc32009-08-18 16:24:58 +00002688 int nSample;
2689 char *zSample = sqlite3Utf8to16(
dan02fa4692009-08-17 17:06:58 +00002690 db, pColl->enc, aSample[i].u.z, aSample[i].nByte, &nSample
2691 );
dane275dc32009-08-18 16:24:58 +00002692 if( !zSample ){
2693 assert( db->mallocFailed );
2694 return SQLITE_NOMEM;
2695 }
drhe847d322011-01-20 02:56:37 +00002696 c = pColl->xCmp(pColl->pUser, nSample, zSample, n, z);
dane275dc32009-08-18 16:24:58 +00002697 sqlite3DbFree(db, zSample);
dane83c4f32009-09-21 16:34:24 +00002698 }else
2699#endif
2700 {
drhe847d322011-01-20 02:56:37 +00002701 c = pColl->xCmp(pColl->pUser, aSample[i].nByte, aSample[i].u.z, n, z);
dan02fa4692009-08-17 17:06:58 +00002702 }
drhfaacf172011-08-12 01:51:45 +00002703 if( c>=0 ){
2704 if( c==0 ) isEq = 1;
2705 break;
2706 }
dan02fa4692009-08-17 17:06:58 +00002707 }
2708 }
drhfaacf172011-08-12 01:51:45 +00002709 }
dan02fa4692009-08-17 17:06:58 +00002710
drhfaacf172011-08-12 01:51:45 +00002711 /* At this point, aSample[i] is the first sample that is greater than
2712 ** or equal to pVal. Or if i==pIdx->nSample, then all samples are less
2713 ** than pVal. If aSample[i]==pVal, then isEq==1.
2714 */
2715 if( isEq ){
2716 assert( i<pIdx->nSample );
2717 aStat[0] = aSample[i].nLt;
2718 aStat[1] = aSample[i].nEq;
2719 }else{
2720 tRowcnt iLower, iUpper, iGap;
2721 if( i==0 ){
2722 iLower = 0;
2723 iUpper = aSample[0].nLt;
drhfaacf172011-08-12 01:51:45 +00002724 }else{
drh4e50c5e2011-08-13 19:35:19 +00002725 iUpper = i>=pIdx->nSample ? n : aSample[i].nLt;
drhfaacf172011-08-12 01:51:45 +00002726 iLower = aSample[i-1].nEq + aSample[i-1].nLt;
drhfaacf172011-08-12 01:51:45 +00002727 }
drh4e50c5e2011-08-13 19:35:19 +00002728 aStat[1] = pIdx->avgEq;
drhfaacf172011-08-12 01:51:45 +00002729 if( iLower>=iUpper ){
2730 iGap = 0;
2731 }else{
2732 iGap = iUpper - iLower;
drhfaacf172011-08-12 01:51:45 +00002733 }
2734 if( roundUp ){
2735 iGap = (iGap*2)/3;
2736 }else{
2737 iGap = iGap/3;
2738 }
2739 aStat[0] = iLower + iGap;
dan02fa4692009-08-17 17:06:58 +00002740 }
2741 return SQLITE_OK;
2742}
drhfaacf172011-08-12 01:51:45 +00002743#endif /* SQLITE_ENABLE_STAT3 */
dan02fa4692009-08-17 17:06:58 +00002744
2745/*
dan937d0de2009-10-15 18:35:38 +00002746** If expression pExpr represents a literal value, set *pp to point to
2747** an sqlite3_value structure containing the same value, with affinity
2748** aff applied to it, before returning. It is the responsibility of the
2749** caller to eventually release this structure by passing it to
2750** sqlite3ValueFree().
2751**
2752** If the current parse is a recompile (sqlite3Reprepare()) and pExpr
2753** is an SQL variable that currently has a non-NULL value bound to it,
2754** create an sqlite3_value structure containing this value, again with
2755** affinity aff applied to it, instead.
2756**
2757** If neither of the above apply, set *pp to NULL.
2758**
2759** If an error occurs, return an error code. Otherwise, SQLITE_OK.
2760*/
drhfaacf172011-08-12 01:51:45 +00002761#ifdef SQLITE_ENABLE_STAT3
dan937d0de2009-10-15 18:35:38 +00002762static int valueFromExpr(
2763 Parse *pParse,
2764 Expr *pExpr,
2765 u8 aff,
2766 sqlite3_value **pp
2767){
drh4278d532010-12-16 19:52:52 +00002768 if( pExpr->op==TK_VARIABLE
2769 || (pExpr->op==TK_REGISTER && pExpr->op2==TK_VARIABLE)
2770 ){
dan937d0de2009-10-15 18:35:38 +00002771 int iVar = pExpr->iColumn;
drhf9b22ca2011-10-21 16:47:31 +00002772 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan937d0de2009-10-15 18:35:38 +00002773 *pp = sqlite3VdbeGetValue(pParse->pReprepare, iVar, aff);
2774 return SQLITE_OK;
2775 }
2776 return sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, aff, pp);
2777}
danf7b0b0a2009-10-19 15:52:32 +00002778#endif
dan937d0de2009-10-15 18:35:38 +00002779
2780/*
dan02fa4692009-08-17 17:06:58 +00002781** This function is used to estimate the number of rows that will be visited
2782** by scanning an index for a range of values. The range may have an upper
2783** bound, a lower bound, or both. The WHERE clause terms that set the upper
2784** and lower bounds are represented by pLower and pUpper respectively. For
2785** example, assuming that index p is on t1(a):
2786**
2787** ... FROM t1 WHERE a > ? AND a < ? ...
2788** |_____| |_____|
2789** | |
2790** pLower pUpper
2791**
drh98cdf622009-08-20 18:14:42 +00002792** If either of the upper or lower bound is not present, then NULL is passed in
drhcdaca552009-08-20 13:45:07 +00002793** place of the corresponding WhereTerm.
dan02fa4692009-08-17 17:06:58 +00002794**
2795** The nEq parameter is passed the index of the index column subject to the
2796** range constraint. Or, equivalently, the number of equality constraints
2797** optimized by the proposed index scan. For example, assuming index p is
2798** on t1(a, b), and the SQL query is:
2799**
2800** ... FROM t1 WHERE a = ? AND b > ? AND b < ? ...
2801**
2802** then nEq should be passed the value 1 (as the range restricted column,
2803** b, is the second left-most column of the index). Or, if the query is:
2804**
2805** ... FROM t1 WHERE a > ? AND a < ? ...
2806**
2807** then nEq should be passed 0.
2808**
drhfaacf172011-08-12 01:51:45 +00002809** The returned value is an integer divisor to reduce the estimated
2810** search space. A return value of 1 means that range constraints are
2811** no help at all. A return value of 2 means range constraints are
2812** expected to reduce the search space by half. And so forth...
drh98cdf622009-08-20 18:14:42 +00002813**
drhfaacf172011-08-12 01:51:45 +00002814** In the absence of sqlite_stat3 ANALYZE data, each range inequality
2815** reduces the search space by a factor of 4. Hence a single constraint (x>?)
2816** results in a return of 4 and a range constraint (x>? AND x<?) results
2817** in a return of 16.
dan02fa4692009-08-17 17:06:58 +00002818*/
2819static int whereRangeScanEst(
drhcdaca552009-08-20 13:45:07 +00002820 Parse *pParse, /* Parsing & code generating context */
2821 Index *p, /* The index containing the range-compared column; "x" */
2822 int nEq, /* index into p->aCol[] of the range-compared column */
2823 WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
2824 WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
drh4e50c5e2011-08-13 19:35:19 +00002825 double *pRangeDiv /* OUT: Reduce search space by this divisor */
dan02fa4692009-08-17 17:06:58 +00002826){
dan69188d92009-08-19 08:18:32 +00002827 int rc = SQLITE_OK;
2828
drhfaacf172011-08-12 01:51:45 +00002829#ifdef SQLITE_ENABLE_STAT3
dan02fa4692009-08-17 17:06:58 +00002830
drhfaacf172011-08-12 01:51:45 +00002831 if( nEq==0 && p->nSample ){
2832 sqlite3_value *pRangeVal;
2833 tRowcnt iLower = 0;
2834 tRowcnt iUpper = p->aiRowEst[0];
2835 tRowcnt a[2];
dan937d0de2009-10-15 18:35:38 +00002836 u8 aff = p->pTable->aCol[p->aiColumn[0]].affinity;
drh98cdf622009-08-20 18:14:42 +00002837
dan02fa4692009-08-17 17:06:58 +00002838 if( pLower ){
2839 Expr *pExpr = pLower->pExpr->pRight;
drhfaacf172011-08-12 01:51:45 +00002840 rc = valueFromExpr(pParse, pExpr, aff, &pRangeVal);
drh7a5bcc02013-01-16 17:08:58 +00002841 assert( (pLower->eOperator & (WO_GT|WO_GE))!=0 );
drhfaacf172011-08-12 01:51:45 +00002842 if( rc==SQLITE_OK
2843 && whereKeyStats(pParse, p, pRangeVal, 0, a)==SQLITE_OK
2844 ){
2845 iLower = a[0];
drh7a5bcc02013-01-16 17:08:58 +00002846 if( (pLower->eOperator & WO_GT)!=0 ) iLower += a[1];
drhfaacf172011-08-12 01:51:45 +00002847 }
2848 sqlite3ValueFree(pRangeVal);
dan02fa4692009-08-17 17:06:58 +00002849 }
drh98cdf622009-08-20 18:14:42 +00002850 if( rc==SQLITE_OK && pUpper ){
dan02fa4692009-08-17 17:06:58 +00002851 Expr *pExpr = pUpper->pExpr->pRight;
drhfaacf172011-08-12 01:51:45 +00002852 rc = valueFromExpr(pParse, pExpr, aff, &pRangeVal);
drh7a5bcc02013-01-16 17:08:58 +00002853 assert( (pUpper->eOperator & (WO_LT|WO_LE))!=0 );
drhfaacf172011-08-12 01:51:45 +00002854 if( rc==SQLITE_OK
2855 && whereKeyStats(pParse, p, pRangeVal, 1, a)==SQLITE_OK
2856 ){
2857 iUpper = a[0];
drh7a5bcc02013-01-16 17:08:58 +00002858 if( (pUpper->eOperator & WO_LE)!=0 ) iUpper += a[1];
dan02fa4692009-08-17 17:06:58 +00002859 }
drhfaacf172011-08-12 01:51:45 +00002860 sqlite3ValueFree(pRangeVal);
dan02fa4692009-08-17 17:06:58 +00002861 }
drhfaacf172011-08-12 01:51:45 +00002862 if( rc==SQLITE_OK ){
2863 if( iUpper<=iLower ){
drh4e50c5e2011-08-13 19:35:19 +00002864 *pRangeDiv = (double)p->aiRowEst[0];
drhfaacf172011-08-12 01:51:45 +00002865 }else{
drh4e50c5e2011-08-13 19:35:19 +00002866 *pRangeDiv = (double)p->aiRowEst[0]/(double)(iUpper - iLower);
drhfaacf172011-08-12 01:51:45 +00002867 }
drhf1b5f5b2013-05-02 00:15:01 +00002868 /*WHERETRACE(("range scan regions: %u..%u div=%g\n",
2869 (u32)iLower, (u32)iUpper, *pRangeDiv));*/
drhfaacf172011-08-12 01:51:45 +00002870 return SQLITE_OK;
drh98cdf622009-08-20 18:14:42 +00002871 }
dan02fa4692009-08-17 17:06:58 +00002872 }
drh3f022182009-09-09 16:10:50 +00002873#else
2874 UNUSED_PARAMETER(pParse);
2875 UNUSED_PARAMETER(p);
2876 UNUSED_PARAMETER(nEq);
dan69188d92009-08-19 08:18:32 +00002877#endif
dan02fa4692009-08-17 17:06:58 +00002878 assert( pLower || pUpper );
drh4e50c5e2011-08-13 19:35:19 +00002879 *pRangeDiv = (double)1;
2880 if( pLower && (pLower->wtFlags & TERM_VNULL)==0 ) *pRangeDiv *= (double)4;
2881 if( pUpper ) *pRangeDiv *= (double)4;
dan02fa4692009-08-17 17:06:58 +00002882 return rc;
2883}
2884
drhfaacf172011-08-12 01:51:45 +00002885#ifdef SQLITE_ENABLE_STAT3
drh82759752011-01-20 16:52:09 +00002886/*
2887** Estimate the number of rows that will be returned based on
2888** an equality constraint x=VALUE and where that VALUE occurs in
2889** the histogram data. This only works when x is the left-most
drhfaacf172011-08-12 01:51:45 +00002890** column of an index and sqlite_stat3 histogram data is available
drhac8eb112011-03-17 01:58:21 +00002891** for that index. When pExpr==NULL that means the constraint is
2892** "x IS NULL" instead of "x=VALUE".
drh82759752011-01-20 16:52:09 +00002893**
drh0c50fa02011-01-21 16:27:18 +00002894** Write the estimated row count into *pnRow and return SQLITE_OK.
2895** If unable to make an estimate, leave *pnRow unchanged and return
2896** non-zero.
drh9b3eb0a2011-01-21 14:37:04 +00002897**
2898** This routine can fail if it is unable to load a collating sequence
2899** required for string comparison, or if unable to allocate memory
2900** for a UTF conversion required for comparison. The error is stored
2901** in the pParse structure.
drh82759752011-01-20 16:52:09 +00002902*/
drh041e09f2011-04-07 19:56:21 +00002903static int whereEqualScanEst(
drh82759752011-01-20 16:52:09 +00002904 Parse *pParse, /* Parsing & code generating context */
2905 Index *p, /* The index whose left-most column is pTerm */
drh0c50fa02011-01-21 16:27:18 +00002906 Expr *pExpr, /* Expression for VALUE in the x=VALUE constraint */
drh82759752011-01-20 16:52:09 +00002907 double *pnRow /* Write the revised row estimate here */
2908){
2909 sqlite3_value *pRhs = 0; /* VALUE on right-hand side of pTerm */
drh82759752011-01-20 16:52:09 +00002910 u8 aff; /* Column affinity */
2911 int rc; /* Subfunction return code */
drhfaacf172011-08-12 01:51:45 +00002912 tRowcnt a[2]; /* Statistics */
drh82759752011-01-20 16:52:09 +00002913
2914 assert( p->aSample!=0 );
drh5c624862011-09-22 18:46:34 +00002915 assert( p->nSample>0 );
drh82759752011-01-20 16:52:09 +00002916 aff = p->pTable->aCol[p->aiColumn[0]].affinity;
drh1f9c7662011-03-17 01:34:26 +00002917 if( pExpr ){
2918 rc = valueFromExpr(pParse, pExpr, aff, &pRhs);
2919 if( rc ) goto whereEqualScanEst_cancel;
2920 }else{
2921 pRhs = sqlite3ValueNew(pParse->db);
2922 }
drh0c50fa02011-01-21 16:27:18 +00002923 if( pRhs==0 ) return SQLITE_NOTFOUND;
drhfaacf172011-08-12 01:51:45 +00002924 rc = whereKeyStats(pParse, p, pRhs, 0, a);
2925 if( rc==SQLITE_OK ){
drhf1b5f5b2013-05-02 00:15:01 +00002926 /*WHERETRACE(("equality scan regions: %d\n", (int)a[1]));*/
drhfaacf172011-08-12 01:51:45 +00002927 *pnRow = a[1];
drh82759752011-01-20 16:52:09 +00002928 }
drh0c50fa02011-01-21 16:27:18 +00002929whereEqualScanEst_cancel:
drh82759752011-01-20 16:52:09 +00002930 sqlite3ValueFree(pRhs);
drh0c50fa02011-01-21 16:27:18 +00002931 return rc;
2932}
drhfaacf172011-08-12 01:51:45 +00002933#endif /* defined(SQLITE_ENABLE_STAT3) */
drh0c50fa02011-01-21 16:27:18 +00002934
drhfaacf172011-08-12 01:51:45 +00002935#ifdef SQLITE_ENABLE_STAT3
drh0c50fa02011-01-21 16:27:18 +00002936/*
2937** Estimate the number of rows that will be returned based on
drh5ac06072011-01-21 18:18:13 +00002938** an IN constraint where the right-hand side of the IN operator
2939** is a list of values. Example:
2940**
2941** WHERE x IN (1,2,3,4)
drh0c50fa02011-01-21 16:27:18 +00002942**
2943** Write the estimated row count into *pnRow and return SQLITE_OK.
2944** If unable to make an estimate, leave *pnRow unchanged and return
2945** non-zero.
2946**
2947** This routine can fail if it is unable to load a collating sequence
2948** required for string comparison, or if unable to allocate memory
2949** for a UTF conversion required for comparison. The error is stored
2950** in the pParse structure.
2951*/
drh041e09f2011-04-07 19:56:21 +00002952static int whereInScanEst(
drh0c50fa02011-01-21 16:27:18 +00002953 Parse *pParse, /* Parsing & code generating context */
2954 Index *p, /* The index whose left-most column is pTerm */
2955 ExprList *pList, /* The value list on the RHS of "x IN (v1,v2,v3,...)" */
2956 double *pnRow /* Write the revised row estimate here */
2957){
drh68257192011-08-16 17:06:21 +00002958 int rc = SQLITE_OK; /* Subfunction return code */
2959 double nEst; /* Number of rows for a single term */
2960 double nRowEst = (double)0; /* New estimate of the number of rows */
2961 int i; /* Loop counter */
drh0c50fa02011-01-21 16:27:18 +00002962
2963 assert( p->aSample!=0 );
drhfaacf172011-08-12 01:51:45 +00002964 for(i=0; rc==SQLITE_OK && i<pList->nExpr; i++){
2965 nEst = p->aiRowEst[0];
2966 rc = whereEqualScanEst(pParse, p, pList->a[i].pExpr, &nEst);
2967 nRowEst += nEst;
drh0c50fa02011-01-21 16:27:18 +00002968 }
2969 if( rc==SQLITE_OK ){
drh0c50fa02011-01-21 16:27:18 +00002970 if( nRowEst > p->aiRowEst[0] ) nRowEst = p->aiRowEst[0];
2971 *pnRow = nRowEst;
drhf1b5f5b2013-05-02 00:15:01 +00002972 /*WHERETRACE(("IN row estimate: est=%g\n", nRowEst));*/
drh0c50fa02011-01-21 16:27:18 +00002973 }
drh0c50fa02011-01-21 16:27:18 +00002974 return rc;
drh82759752011-01-20 16:52:09 +00002975}
drhfaacf172011-08-12 01:51:45 +00002976#endif /* defined(SQLITE_ENABLE_STAT3) */
drh82759752011-01-20 16:52:09 +00002977
drh46c35f92012-09-26 23:17:01 +00002978/*
drh32634d22012-09-27 14:11:36 +00002979** Check to see if column iCol of the table with cursor iTab will appear
drh8e4af1b2012-10-08 18:23:51 +00002980** in sorted order according to the current query plan.
drh32634d22012-09-27 14:11:36 +00002981**
drh8e4af1b2012-10-08 18:23:51 +00002982** Return values:
2983**
2984** 0 iCol is not ordered
2985** 1 iCol has only a single value
2986** 2 iCol is in ASC order
2987** 3 iCol is in DESC order
drh32634d22012-09-27 14:11:36 +00002988*/
drh8e4af1b2012-10-08 18:23:51 +00002989static int isOrderedColumn(
2990 WhereBestIdx *p,
2991 int iTab,
2992 int iCol
2993){
drh32634d22012-09-27 14:11:36 +00002994 int i, j;
2995 WhereLevel *pLevel = &p->aLevel[p->i-1];
2996 Index *pIdx;
2997 u8 sortOrder;
2998 for(i=p->i-1; i>=0; i--, pLevel--){
2999 if( pLevel->iTabCur!=iTab ) continue;
drh60441af2012-09-29 19:10:29 +00003000 if( (pLevel->plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
3001 return 1;
3002 }
drh69a76ba2012-10-09 01:23:25 +00003003 assert( (pLevel->plan.wsFlags & WHERE_ORDERED)!=0 );
drhd663b5b2012-10-03 00:25:54 +00003004 if( (pIdx = pLevel->plan.u.pIdx)!=0 ){
drh6b10a6a2012-09-27 17:31:32 +00003005 if( iCol<0 ){
3006 sortOrder = 0;
3007 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
3008 }else{
drhafcd5222012-10-02 15:19:19 +00003009 int n = pIdx->nColumn;
drh178eb612012-10-02 14:11:29 +00003010 for(j=0; j<n; j++){
drh6b10a6a2012-09-27 17:31:32 +00003011 if( iCol==pIdx->aiColumn[j] ) break;
3012 }
drh178eb612012-10-02 14:11:29 +00003013 if( j>=n ) return 0;
drh6b10a6a2012-09-27 17:31:32 +00003014 sortOrder = pIdx->aSortOrder[j];
3015 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
drh32634d22012-09-27 14:11:36 +00003016 }
drh32634d22012-09-27 14:11:36 +00003017 }else{
3018 if( iCol!=(-1) ) return 0;
3019 sortOrder = 0;
drh6b10a6a2012-09-27 17:31:32 +00003020 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
drh32634d22012-09-27 14:11:36 +00003021 }
drh6b10a6a2012-09-27 17:31:32 +00003022 if( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 ){
3023 assert( sortOrder==0 || sortOrder==1 );
3024 testcase( sortOrder==1 );
3025 sortOrder = 1 - sortOrder;
3026 }
drh8e4af1b2012-10-08 18:23:51 +00003027 return sortOrder+2;
drh32634d22012-09-27 14:11:36 +00003028 }
3029 return 0;
3030}
3031
3032/*
drh60441af2012-09-29 19:10:29 +00003033** This routine decides if pIdx can be used to satisfy the ORDER BY
3034** clause, either in whole or in part. The return value is the
3035** cumulative number of terms in the ORDER BY clause that are satisfied
3036** by the index pIdx and other indices in outer loops.
3037**
3038** The table being queried has a cursor number of "base". pIdx is the
3039** index that is postulated for use to access the table.
3040**
drh60441af2012-09-29 19:10:29 +00003041** The *pbRev value is set to 0 order 1 depending on whether or not
3042** pIdx should be run in the forward order or in reverse order.
3043*/
3044static int isSortingIndex(
3045 WhereBestIdx *p, /* Best index search context */
3046 Index *pIdx, /* The index we are testing */
3047 int base, /* Cursor number for the table to be sorted */
drh8a1b87c2013-03-27 15:04:28 +00003048 int *pbRev, /* Set to 1 for reverse-order scan of pIdx */
3049 int *pbObUnique /* ORDER BY column values will different in every row */
drh60441af2012-09-29 19:10:29 +00003050){
3051 int i; /* Number of pIdx terms used */
3052 int j; /* Number of ORDER BY terms satisfied */
drh4f68d6c2012-10-04 12:10:25 +00003053 int sortOrder = 2; /* 0: forward. 1: backward. 2: unknown */
drh60441af2012-09-29 19:10:29 +00003054 int nTerm; /* Number of ORDER BY terms */
drh8e4af1b2012-10-08 18:23:51 +00003055 struct ExprList_item *pOBItem;/* A term of the ORDER BY clause */
drh4f68d6c2012-10-04 12:10:25 +00003056 Table *pTab = pIdx->pTable; /* Table that owns index pIdx */
drh60441af2012-09-29 19:10:29 +00003057 ExprList *pOrderBy; /* The ORDER BY clause */
3058 Parse *pParse = p->pParse; /* Parser context */
3059 sqlite3 *db = pParse->db; /* Database connection */
3060 int nPriorSat; /* ORDER BY terms satisfied by outer loops */
3061 int seenRowid = 0; /* True if an ORDER BY rowid term is seen */
drh0a4c7412012-10-08 19:41:38 +00003062 int uniqueNotNull; /* pIdx is UNIQUE with all terms are NOT NULL */
drh8a1b87c2013-03-27 15:04:28 +00003063 int outerObUnique; /* Outer loops generate different values in
3064 ** every row for the ORDER BY columns */
drh60441af2012-09-29 19:10:29 +00003065
3066 if( p->i==0 ){
3067 nPriorSat = 0;
drh8a1b87c2013-03-27 15:04:28 +00003068 outerObUnique = 1;
drh60441af2012-09-29 19:10:29 +00003069 }else{
drhe6a8bbb2013-03-27 16:42:21 +00003070 u32 wsFlags = p->aLevel[p->i-1].plan.wsFlags;
drh60441af2012-09-29 19:10:29 +00003071 nPriorSat = p->aLevel[p->i-1].plan.nOBSat;
drhe6a8bbb2013-03-27 16:42:21 +00003072 if( (wsFlags & WHERE_ORDERED)==0 ){
drh0a4c7412012-10-08 19:41:38 +00003073 /* This loop cannot be ordered unless the next outer loop is
3074 ** also ordered */
drhd663b5b2012-10-03 00:25:54 +00003075 return nPriorSat;
3076 }
drh0a4c7412012-10-08 19:41:38 +00003077 if( OptimizationDisabled(db, SQLITE_OrderByIdxJoin) ){
3078 /* Only look at the outer-most loop if the OrderByIdxJoin
3079 ** optimization is disabled */
3080 return nPriorSat;
3081 }
drhe6a8bbb2013-03-27 16:42:21 +00003082 testcase( wsFlags & WHERE_OB_UNIQUE );
3083 testcase( wsFlags & WHERE_ALL_UNIQUE );
3084 outerObUnique = (wsFlags & (WHERE_OB_UNIQUE|WHERE_ALL_UNIQUE))!=0;
drh60441af2012-09-29 19:10:29 +00003085 }
3086 pOrderBy = p->pOrderBy;
3087 assert( pOrderBy!=0 );
drh0a4c7412012-10-08 19:41:38 +00003088 if( pIdx->bUnordered ){
3089 /* Hash indices (indicated by the "unordered" tag on sqlite_stat1) cannot
3090 ** be used for sorting */
3091 return nPriorSat;
3092 }
drh60441af2012-09-29 19:10:29 +00003093 nTerm = pOrderBy->nExpr;
drh8e4af1b2012-10-08 18:23:51 +00003094 uniqueNotNull = pIdx->onError!=OE_None;
drh60441af2012-09-29 19:10:29 +00003095 assert( nTerm>0 );
3096
3097 /* Argument pIdx must either point to a 'real' named index structure,
3098 ** or an index structure allocated on the stack by bestBtreeIndex() to
3099 ** represent the rowid index that is part of every table. */
3100 assert( pIdx->zName || (pIdx->nColumn==1 && pIdx->aiColumn[0]==-1) );
3101
3102 /* Match terms of the ORDER BY clause against columns of
3103 ** the index.
3104 **
3105 ** Note that indices have pIdx->nColumn regular columns plus
3106 ** one additional column containing the rowid. The rowid column
3107 ** of the index is also allowed to match against the ORDER BY
3108 ** clause.
3109 */
drh8e4af1b2012-10-08 18:23:51 +00003110 j = nPriorSat;
3111 for(i=0,pOBItem=&pOrderBy->a[j]; j<nTerm && i<=pIdx->nColumn; i++){
3112 Expr *pOBExpr; /* The expression of the ORDER BY pOBItem */
3113 CollSeq *pColl; /* The collating sequence of pOBExpr */
3114 int termSortOrder; /* Sort order for this term */
3115 int iColumn; /* The i-th column of the index. -1 for rowid */
3116 int iSortOrder; /* 1 for DESC, 0 for ASC on the i-th index term */
3117 int isEq; /* Subject to an == or IS NULL constraint */
3118 int isMatch; /* ORDER BY term matches the index term */
3119 const char *zColl; /* Name of collating sequence for i-th index term */
3120 WhereTerm *pConstraint; /* A constraint in the WHERE clause */
drh60441af2012-09-29 19:10:29 +00003121
drh8e4af1b2012-10-08 18:23:51 +00003122 /* If the next term of the ORDER BY clause refers to anything other than
3123 ** a column in the "base" table, then this index will not be of any
3124 ** further use in handling the ORDER BY. */
drh7a66da12012-12-07 20:31:11 +00003125 pOBExpr = sqlite3ExprSkipCollate(pOBItem->pExpr);
drh8e4af1b2012-10-08 18:23:51 +00003126 if( pOBExpr->op!=TK_COLUMN || pOBExpr->iTable!=base ){
drh60441af2012-09-29 19:10:29 +00003127 break;
3128 }
drh8e4af1b2012-10-08 18:23:51 +00003129
3130 /* Find column number and collating sequence for the next entry
3131 ** in the index */
drh60441af2012-09-29 19:10:29 +00003132 if( pIdx->zName && i<pIdx->nColumn ){
3133 iColumn = pIdx->aiColumn[i];
3134 if( iColumn==pIdx->pTable->iPKey ){
3135 iColumn = -1;
3136 }
3137 iSortOrder = pIdx->aSortOrder[i];
3138 zColl = pIdx->azColl[i];
drh8e4af1b2012-10-08 18:23:51 +00003139 assert( zColl!=0 );
drh60441af2012-09-29 19:10:29 +00003140 }else{
3141 iColumn = -1;
3142 iSortOrder = 0;
drh8e4af1b2012-10-08 18:23:51 +00003143 zColl = 0;
drh60441af2012-09-29 19:10:29 +00003144 }
drh8e4af1b2012-10-08 18:23:51 +00003145
3146 /* Check to see if the column number and collating sequence of the
3147 ** index match the column number and collating sequence of the ORDER BY
3148 ** clause entry. Set isMatch to 1 if they both match. */
3149 if( pOBExpr->iColumn==iColumn ){
3150 if( zColl ){
drh7a66da12012-12-07 20:31:11 +00003151 pColl = sqlite3ExprCollSeq(pParse, pOBItem->pExpr);
drh8e4af1b2012-10-08 18:23:51 +00003152 if( !pColl ) pColl = db->pDfltColl;
3153 isMatch = sqlite3StrICmp(pColl->zName, zColl)==0;
drh60441af2012-09-29 19:10:29 +00003154 }else{
drh8e4af1b2012-10-08 18:23:51 +00003155 isMatch = 1;
drh60441af2012-09-29 19:10:29 +00003156 }
3157 }else{
drh8e4af1b2012-10-08 18:23:51 +00003158 isMatch = 0;
3159 }
3160
3161 /* termSortOrder is 0 or 1 for whether or not the access loop should
3162 ** run forward or backwards (respectively) in order to satisfy this
3163 ** term of the ORDER BY clause. */
drh2f546ee2012-10-09 09:26:28 +00003164 assert( pOBItem->sortOrder==0 || pOBItem->sortOrder==1 );
3165 assert( iSortOrder==0 || iSortOrder==1 );
drh8e4af1b2012-10-08 18:23:51 +00003166 termSortOrder = iSortOrder ^ pOBItem->sortOrder;
3167
3168 /* If X is the column in the index and ORDER BY clause, check to see
3169 ** if there are any X= or X IS NULL constraints in the WHERE clause. */
3170 pConstraint = findTerm(p->pWC, base, iColumn, p->notReady,
3171 WO_EQ|WO_ISNULL|WO_IN, pIdx);
3172 if( pConstraint==0 ){
3173 isEq = 0;
drh7a5bcc02013-01-16 17:08:58 +00003174 }else if( (pConstraint->eOperator & WO_IN)!=0 ){
drh1b8fc652013-02-07 21:15:14 +00003175 isEq = 0;
drh7a5bcc02013-01-16 17:08:58 +00003176 }else if( (pConstraint->eOperator & WO_ISNULL)!=0 ){
drh8e4af1b2012-10-08 18:23:51 +00003177 uniqueNotNull = 0;
drh2f546ee2012-10-09 09:26:28 +00003178 isEq = 1; /* "X IS NULL" means X has only a single value */
drh6b9e5652012-10-08 20:27:35 +00003179 }else if( pConstraint->prereqRight==0 ){
drh2f546ee2012-10-09 09:26:28 +00003180 isEq = 1; /* Constraint "X=constant" means X has only a single value */
drh8e4af1b2012-10-08 18:23:51 +00003181 }else{
3182 Expr *pRight = pConstraint->pExpr->pRight;
3183 if( pRight->op==TK_COLUMN ){
drhf1b5f5b2013-05-02 00:15:01 +00003184 /*WHERETRACE((" .. isOrderedColumn(tab=%d,col=%d)",
3185 pRight->iTable, pRight->iColumn));*/
drh8e4af1b2012-10-08 18:23:51 +00003186 isEq = isOrderedColumn(p, pRight->iTable, pRight->iColumn);
drhf1b5f5b2013-05-02 00:15:01 +00003187 /*WHERETRACE((" -> isEq=%d\n", isEq));*/
drh2f546ee2012-10-09 09:26:28 +00003188
3189 /* If the constraint is of the form X=Y where Y is an ordered value
3190 ** in an outer loop, then make sure the sort order of Y matches the
3191 ** sort order required for X. */
drh2fad8152012-10-08 21:01:15 +00003192 if( isMatch && isEq>=2 && isEq!=pOBItem->sortOrder+2 ){
drh2f546ee2012-10-09 09:26:28 +00003193 testcase( isEq==2 );
3194 testcase( isEq==3 );
drh8e4af1b2012-10-08 18:23:51 +00003195 break;
3196 }
3197 }else{
drh2f546ee2012-10-09 09:26:28 +00003198 isEq = 0; /* "X=expr" places no ordering constraints on X */
drh8e4af1b2012-10-08 18:23:51 +00003199 }
3200 }
drh8e4af1b2012-10-08 18:23:51 +00003201 if( !isMatch ){
3202 if( isEq==0 ){
3203 break;
3204 }else{
3205 continue;
3206 }
drh6b9e5652012-10-08 20:27:35 +00003207 }else if( isEq!=1 ){
3208 if( sortOrder==2 ){
3209 sortOrder = termSortOrder;
3210 }else if( termSortOrder!=sortOrder ){
3211 break;
3212 }
drh60441af2012-09-29 19:10:29 +00003213 }
3214 j++;
drh8e4af1b2012-10-08 18:23:51 +00003215 pOBItem++;
drh60441af2012-09-29 19:10:29 +00003216 if( iColumn<0 ){
3217 seenRowid = 1;
3218 break;
drh2f546ee2012-10-09 09:26:28 +00003219 }else if( pTab->aCol[iColumn].notNull==0 && isEq!=1 ){
3220 testcase( isEq==0 );
3221 testcase( isEq==2 );
3222 testcase( isEq==3 );
drh4f68d6c2012-10-04 12:10:25 +00003223 uniqueNotNull = 0;
drh60441af2012-09-29 19:10:29 +00003224 }
3225 }
drh8a1b87c2013-03-27 15:04:28 +00003226 if( seenRowid ){
3227 uniqueNotNull = 1;
3228 }else if( uniqueNotNull==0 || i<pIdx->nColumn ){
3229 uniqueNotNull = 0;
3230 }
drh0a4c7412012-10-08 19:41:38 +00003231
3232 /* If we have not found at least one ORDER BY term that matches the
3233 ** index, then show no progress. */
3234 if( pOBItem==&pOrderBy->a[nPriorSat] ) return nPriorSat;
3235
drhd9883572013-03-27 17:20:10 +00003236 /* Either the outer queries must generate rows where there are no two
3237 ** rows with the same values in all ORDER BY columns, or else this
3238 ** loop must generate just a single row of output. Example: Suppose
3239 ** the outer loops generate A=1 and A=1, and this loop generates B=3
3240 ** and B=4. Then without the following test, ORDER BY A,B would
3241 ** generate the wrong order output: 1,3 1,4 1,3 1,4
3242 */
drh8a1b87c2013-03-27 15:04:28 +00003243 if( outerObUnique==0 && uniqueNotNull==0 ) return nPriorSat;
3244 *pbObUnique = uniqueNotNull;
3245
drh0a4c7412012-10-08 19:41:38 +00003246 /* Return the necessary scan order back to the caller */
drh4f68d6c2012-10-04 12:10:25 +00003247 *pbRev = sortOrder & 1;
drh60441af2012-09-29 19:10:29 +00003248
3249 /* If there was an "ORDER BY rowid" term that matched, or it is only
3250 ** possible for a single row from this table to match, then skip over
3251 ** any additional ORDER BY terms dealing with this table.
3252 */
drh8a1b87c2013-03-27 15:04:28 +00003253 if( uniqueNotNull ){
drh60441af2012-09-29 19:10:29 +00003254 /* Advance j over additional ORDER BY terms associated with base */
3255 WhereMaskSet *pMS = p->pWC->pMaskSet;
3256 Bitmask m = ~getMask(pMS, base);
3257 while( j<nTerm && (exprTableUsage(pMS, pOrderBy->a[j].pExpr)&m)==0 ){
3258 j++;
3259 }
3260 }
3261 return j;
3262}
dan02fa4692009-08-17 17:06:58 +00003263
3264/*
drh083310d2011-01-28 01:57:41 +00003265** Find the best query plan for accessing a particular table. Write the
drh56f1b992012-09-25 14:29:39 +00003266** best query plan and its cost into the p->cost.
drh51147ba2005-07-23 22:59:55 +00003267**
drh111a6a72008-12-21 03:51:16 +00003268** The lowest cost plan wins. The cost is an estimate of the amount of
drh083310d2011-01-28 01:57:41 +00003269** CPU and disk I/O needed to process the requested result.
drh51147ba2005-07-23 22:59:55 +00003270** Factors that influence cost include:
3271**
3272** * The estimated number of rows that will be retrieved. (The
3273** fewer the better.)
3274**
3275** * Whether or not sorting must occur.
3276**
3277** * Whether or not there must be separate lookups in the
3278** index and in the main table.
3279**
danielk1977e2d7b242009-02-23 17:33:49 +00003280** If there was an INDEXED BY clause (pSrc->pIndex) attached to the table in
3281** the SQL statement, then this function only considers plans using the
drh296a4832009-03-22 20:36:18 +00003282** named index. If no such plan is found, then the returned cost is
3283** SQLITE_BIG_DBL. If a plan is found that uses the named index,
danielk197785574e32008-10-06 05:32:18 +00003284** then the cost is calculated in the usual way.
3285**
drh21172c42012-10-30 00:29:07 +00003286** If a NOT INDEXED clause was attached to the table
danielk1977e2d7b242009-02-23 17:33:49 +00003287** in the SELECT statement, then no indexes are considered. However, the
drh083310d2011-01-28 01:57:41 +00003288** selected plan may still take advantage of the built-in rowid primary key
danielk197785574e32008-10-06 05:32:18 +00003289** index.
drhfe05af82005-07-21 03:14:59 +00003290*/
drh56f1b992012-09-25 14:29:39 +00003291static void bestBtreeIndex(WhereBestIdx *p){
3292 Parse *pParse = p->pParse; /* The parsing context */
3293 WhereClause *pWC = p->pWC; /* The WHERE clause */
3294 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
drh51147ba2005-07-23 22:59:55 +00003295 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
3296 Index *pProbe; /* An index we are evaluating */
dan5236ac12009-08-13 07:09:33 +00003297 Index *pIdx; /* Copy of pProbe, or zero for IPK index */
3298 int eqTermMask; /* Current mask of valid equality operators */
3299 int idxEqTermMask; /* Index mask of valid equality operators */
drhcdaca552009-08-20 13:45:07 +00003300 Index sPk; /* A fake index object for the primary key */
drhfaacf172011-08-12 01:51:45 +00003301 tRowcnt aiRowEstPk[2]; /* The aiRowEst[] value for the sPk index */
drhcdaca552009-08-20 13:45:07 +00003302 int aiColumnPk = -1; /* The aColumn[] value for the sPk index */
drh56f1b992012-09-25 14:29:39 +00003303 int wsFlagMask; /* Allowed flags in p->cost.plan.wsFlag */
drh04229ac2012-12-08 22:14:29 +00003304 int nPriorSat; /* ORDER BY terms satisfied by outer loops */
3305 int nOrderBy; /* Number of ORDER BY terms */
3306 char bSortInit; /* Initializer for bSort in inner loop */
3307 char bDistInit; /* Initializer for bDist in inner loop */
3308
drhfe05af82005-07-21 03:14:59 +00003309
drhcdaca552009-08-20 13:45:07 +00003310 /* Initialize the cost to a worst-case value */
drh56f1b992012-09-25 14:29:39 +00003311 memset(&p->cost, 0, sizeof(p->cost));
3312 p->cost.rCost = SQLITE_BIG_DBL;
drh51147ba2005-07-23 22:59:55 +00003313
drhc49de5d2007-01-19 01:06:01 +00003314 /* If the pSrc table is the right table of a LEFT JOIN then we may not
3315 ** use an index to satisfy IS NULL constraints on that table. This is
3316 ** because columns might end up being NULL if the table does not match -
3317 ** a circumstance which the index cannot help us discover. Ticket #2177.
3318 */
dan5236ac12009-08-13 07:09:33 +00003319 if( pSrc->jointype & JT_LEFT ){
3320 idxEqTermMask = WO_EQ|WO_IN;
drhc49de5d2007-01-19 01:06:01 +00003321 }else{
dan5236ac12009-08-13 07:09:33 +00003322 idxEqTermMask = WO_EQ|WO_IN|WO_ISNULL;
drhc49de5d2007-01-19 01:06:01 +00003323 }
3324
danielk197785574e32008-10-06 05:32:18 +00003325 if( pSrc->pIndex ){
drhcdaca552009-08-20 13:45:07 +00003326 /* An INDEXED BY clause specifies a particular index to use */
dan5236ac12009-08-13 07:09:33 +00003327 pIdx = pProbe = pSrc->pIndex;
3328 wsFlagMask = ~(WHERE_ROWID_EQ|WHERE_ROWID_RANGE);
3329 eqTermMask = idxEqTermMask;
3330 }else{
drh083310d2011-01-28 01:57:41 +00003331 /* There is no INDEXED BY clause. Create a fake Index object in local
3332 ** variable sPk to represent the rowid primary key index. Make this
3333 ** fake index the first in a chain of Index objects with all of the real
3334 ** indices to follow */
3335 Index *pFirst; /* First of real indices on the table */
drhcdaca552009-08-20 13:45:07 +00003336 memset(&sPk, 0, sizeof(Index));
3337 sPk.nColumn = 1;
3338 sPk.aiColumn = &aiColumnPk;
3339 sPk.aiRowEst = aiRowEstPk;
drhcdaca552009-08-20 13:45:07 +00003340 sPk.onError = OE_Replace;
3341 sPk.pTable = pSrc->pTab;
drh15564052010-09-25 22:32:56 +00003342 aiRowEstPk[0] = pSrc->pTab->nRowEst;
3343 aiRowEstPk[1] = 1;
drhcdaca552009-08-20 13:45:07 +00003344 pFirst = pSrc->pTab->pIndex;
dan5236ac12009-08-13 07:09:33 +00003345 if( pSrc->notIndexed==0 ){
drh083310d2011-01-28 01:57:41 +00003346 /* The real indices of the table are only considered if the
3347 ** NOT INDEXED qualifier is omitted from the FROM clause */
drhcdaca552009-08-20 13:45:07 +00003348 sPk.pNext = pFirst;
dan5236ac12009-08-13 07:09:33 +00003349 }
drhcdaca552009-08-20 13:45:07 +00003350 pProbe = &sPk;
dan5236ac12009-08-13 07:09:33 +00003351 wsFlagMask = ~(
3352 WHERE_COLUMN_IN|WHERE_COLUMN_EQ|WHERE_COLUMN_NULL|WHERE_COLUMN_RANGE
3353 );
3354 eqTermMask = WO_EQ|WO_IN;
3355 pIdx = 0;
danielk197785574e32008-10-06 05:32:18 +00003356 }
drh51147ba2005-07-23 22:59:55 +00003357
drh04229ac2012-12-08 22:14:29 +00003358 nOrderBy = p->pOrderBy ? p->pOrderBy->nExpr : 0;
3359 if( p->i ){
3360 nPriorSat = p->aLevel[p->i-1].plan.nOBSat;
3361 bSortInit = nPriorSat<nOrderBy;
3362 bDistInit = 0;
3363 }else{
3364 nPriorSat = 0;
3365 bSortInit = nOrderBy>0;
3366 bDistInit = p->pDistinct!=0;
3367 }
3368
drhcdaca552009-08-20 13:45:07 +00003369 /* Loop over all indices looking for the best one to use
3370 */
dan5236ac12009-08-13 07:09:33 +00003371 for(; pProbe; pIdx=pProbe=pProbe->pNext){
drhfaacf172011-08-12 01:51:45 +00003372 const tRowcnt * const aiRowEst = pProbe->aiRowEst;
drhd663b5b2012-10-03 00:25:54 +00003373 WhereCost pc; /* Cost of using pProbe */
drh93c63842011-09-22 00:28:55 +00003374 double log10N = (double)1; /* base-10 logarithm of nRow (inexact) */
drh8e4af1b2012-10-08 18:23:51 +00003375
dan5236ac12009-08-13 07:09:33 +00003376 /* The following variables are populated based on the properties of
drh083310d2011-01-28 01:57:41 +00003377 ** index being evaluated. They are then used to determine the expected
dan5236ac12009-08-13 07:09:33 +00003378 ** cost and number of rows returned.
3379 **
drhd663b5b2012-10-03 00:25:54 +00003380 ** pc.plan.nEq:
dan5236ac12009-08-13 07:09:33 +00003381 ** Number of equality terms that can be implemented using the index.
drh083310d2011-01-28 01:57:41 +00003382 ** In other words, the number of initial fields in the index that
3383 ** are used in == or IN or NOT NULL constraints of the WHERE clause.
dan5236ac12009-08-13 07:09:33 +00003384 **
3385 ** nInMul:
3386 ** The "in-multiplier". This is an estimate of how many seek operations
3387 ** SQLite must perform on the index in question. For example, if the
3388 ** WHERE clause is:
3389 **
3390 ** WHERE a IN (1, 2, 3) AND b IN (4, 5, 6)
3391 **
3392 ** SQLite must perform 9 lookups on an index on (a, b), so nInMul is
3393 ** set to 9. Given the same schema and either of the following WHERE
3394 ** clauses:
3395 **
3396 ** WHERE a = 1
3397 ** WHERE a >= 2
3398 **
3399 ** nInMul is set to 1.
3400 **
3401 ** If there exists a WHERE term of the form "x IN (SELECT ...)", then
3402 ** the sub-select is assumed to return 25 rows for the purposes of
3403 ** determining nInMul.
3404 **
3405 ** bInEst:
3406 ** Set to true if there was at least one "x IN (SELECT ...)" term used
drh083310d2011-01-28 01:57:41 +00003407 ** in determining the value of nInMul. Note that the RHS of the
3408 ** IN operator must be a SELECT, not a value list, for this variable
3409 ** to be true.
dan5236ac12009-08-13 07:09:33 +00003410 **
drhfaacf172011-08-12 01:51:45 +00003411 ** rangeDiv:
3412 ** An estimate of a divisor by which to reduce the search space due
3413 ** to inequality constraints. In the absence of sqlite_stat3 ANALYZE
3414 ** data, a single inequality reduces the search space to 1/4rd its
3415 ** original size (rangeDiv==4). Two inequalities reduce the search
3416 ** space to 1/16th of its original size (rangeDiv==16).
dan5236ac12009-08-13 07:09:33 +00003417 **
3418 ** bSort:
3419 ** Boolean. True if there is an ORDER BY clause that will require an
3420 ** external sort (i.e. scanning the index being evaluated will not
3421 ** correctly order records).
3422 **
drh04b85bc2012-10-01 17:44:05 +00003423 ** bDist:
drh46c35f92012-09-26 23:17:01 +00003424 ** Boolean. True if there is a DISTINCT clause that will require an
3425 ** external btree.
3426 **
dan5236ac12009-08-13 07:09:33 +00003427 ** bLookup:
drh083310d2011-01-28 01:57:41 +00003428 ** Boolean. True if a table lookup is required for each index entry
3429 ** visited. In other words, true if this is not a covering index.
3430 ** This is always false for the rowid primary key index of a table.
3431 ** For other indexes, it is true unless all the columns of the table
3432 ** used by the SELECT statement are present in the index (such an
3433 ** index is sometimes described as a covering index).
dan5236ac12009-08-13 07:09:33 +00003434 ** For example, given the index on (a, b), the second of the following
drh083310d2011-01-28 01:57:41 +00003435 ** two queries requires table b-tree lookups in order to find the value
3436 ** of column c, but the first does not because columns a and b are
3437 ** both available in the index.
dan5236ac12009-08-13 07:09:33 +00003438 **
3439 ** SELECT a, b FROM tbl WHERE a = 1;
3440 ** SELECT a, b, c FROM tbl WHERE a = 1;
drhfe05af82005-07-21 03:14:59 +00003441 */
drh083310d2011-01-28 01:57:41 +00003442 int bInEst = 0; /* True if "x IN (SELECT...)" seen */
3443 int nInMul = 1; /* Number of distinct equalities to lookup */
drh4e50c5e2011-08-13 19:35:19 +00003444 double rangeDiv = (double)1; /* Estimated reduction in search space */
drh82759752011-01-20 16:52:09 +00003445 int nBound = 0; /* Number of range constraints seen */
drh04229ac2012-12-08 22:14:29 +00003446 char bSort = bSortInit; /* True if external sort required */
3447 char bDist = bDistInit; /* True if index cannot help with DISTINCT */
3448 char bLookup = 0; /* True if not a covering index */
drh82759752011-01-20 16:52:09 +00003449 WhereTerm *pTerm; /* A single term of the WHERE clause */
drhfaacf172011-08-12 01:51:45 +00003450#ifdef SQLITE_ENABLE_STAT3
drh0c50fa02011-01-21 16:27:18 +00003451 WhereTerm *pFirstTerm = 0; /* First term matching the index */
drh82759752011-01-20 16:52:09 +00003452#endif
dan5236ac12009-08-13 07:09:33 +00003453
drhf1b5f5b2013-05-02 00:15:01 +00003454 /*WHERETRACE((
drh86257ff2012-10-09 01:39:25 +00003455 " %s(%s):\n",
3456 pSrc->pTab->zName, (pIdx ? pIdx->zName : "ipk")
drhf1b5f5b2013-05-02 00:15:01 +00003457 ));*/
drh613a53a2012-10-03 18:09:32 +00003458 memset(&pc, 0, sizeof(pc));
drh04229ac2012-12-08 22:14:29 +00003459 pc.plan.nOBSat = nPriorSat;
drh9cd1c992012-09-25 20:43:35 +00003460
drhd663b5b2012-10-03 00:25:54 +00003461 /* Determine the values of pc.plan.nEq and nInMul */
drh4f68d6c2012-10-04 12:10:25 +00003462 for(pc.plan.nEq=0; pc.plan.nEq<pProbe->nColumn; pc.plan.nEq++){
drhd663b5b2012-10-03 00:25:54 +00003463 int j = pProbe->aiColumn[pc.plan.nEq];
drh56f1b992012-09-25 14:29:39 +00003464 pTerm = findTerm(pWC, iCur, j, p->notReady, eqTermMask, pIdx);
drhfe05af82005-07-21 03:14:59 +00003465 if( pTerm==0 ) break;
drhd663b5b2012-10-03 00:25:54 +00003466 pc.plan.wsFlags |= (WHERE_COLUMN_EQ|WHERE_ROWID_EQ);
drh0a61df62011-10-07 17:45:58 +00003467 testcase( pTerm->pWC!=pWC );
drhb52076c2006-01-23 13:22:09 +00003468 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00003469 Expr *pExpr = pTerm->pExpr;
drhd663b5b2012-10-03 00:25:54 +00003470 pc.plan.wsFlags |= WHERE_COLUMN_IN;
danielk19776ab3a2e2009-02-19 14:39:25 +00003471 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drh9b3eb0a2011-01-21 14:37:04 +00003472 /* "x IN (SELECT ...)": Assume the SELECT returns 25 rows */
dan5236ac12009-08-13 07:09:33 +00003473 nInMul *= 25;
3474 bInEst = 1;
drh083310d2011-01-28 01:57:41 +00003475 }else if( ALWAYS(pExpr->x.pList && pExpr->x.pList->nExpr) ){
drh9b3eb0a2011-01-21 14:37:04 +00003476 /* "x IN (value, value, ...)" */
drh083310d2011-01-28 01:57:41 +00003477 nInMul *= pExpr->x.pList->nExpr;
drhfe05af82005-07-21 03:14:59 +00003478 }
drh46619d62009-04-24 14:51:42 +00003479 }else if( pTerm->eOperator & WO_ISNULL ){
drhd663b5b2012-10-03 00:25:54 +00003480 pc.plan.wsFlags |= WHERE_COLUMN_NULL;
drhfe05af82005-07-21 03:14:59 +00003481 }
drhfaacf172011-08-12 01:51:45 +00003482#ifdef SQLITE_ENABLE_STAT3
drhd663b5b2012-10-03 00:25:54 +00003483 if( pc.plan.nEq==0 && pProbe->aSample ) pFirstTerm = pTerm;
drh82759752011-01-20 16:52:09 +00003484#endif
drhd663b5b2012-10-03 00:25:54 +00003485 pc.used |= pTerm->prereqRight;
drhfe05af82005-07-21 03:14:59 +00003486 }
dan0c733f62011-11-16 15:27:09 +00003487
3488 /* If the index being considered is UNIQUE, and there is an equality
3489 ** constraint for all columns in the index, then this search will find
3490 ** at most a single row. In this case set the WHERE_UNIQUE flag to
3491 ** indicate this to the caller.
3492 **
3493 ** Otherwise, if the search may find more than one row, test to see if
drh1b8fc652013-02-07 21:15:14 +00003494 ** there is a range constraint on indexed column (pc.plan.nEq+1) that
3495 ** can be optimized using the index.
dan0c733f62011-11-16 15:27:09 +00003496 */
drhd663b5b2012-10-03 00:25:54 +00003497 if( pc.plan.nEq==pProbe->nColumn && pProbe->onError!=OE_None ){
3498 testcase( pc.plan.wsFlags & WHERE_COLUMN_IN );
3499 testcase( pc.plan.wsFlags & WHERE_COLUMN_NULL );
3500 if( (pc.plan.wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_NULL))==0 ){
3501 pc.plan.wsFlags |= WHERE_UNIQUE;
drh60441af2012-09-29 19:10:29 +00003502 if( p->i==0 || (p->aLevel[p->i-1].plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
drhd663b5b2012-10-03 00:25:54 +00003503 pc.plan.wsFlags |= WHERE_ALL_UNIQUE;
drh60441af2012-09-29 19:10:29 +00003504 }
dan0c733f62011-11-16 15:27:09 +00003505 }
3506 }else if( pProbe->bUnordered==0 ){
drhd663b5b2012-10-03 00:25:54 +00003507 int j;
3508 j = (pc.plan.nEq==pProbe->nColumn ? -1 : pProbe->aiColumn[pc.plan.nEq]);
drh56f1b992012-09-25 14:29:39 +00003509 if( findTerm(pWC, iCur, j, p->notReady, WO_LT|WO_LE|WO_GT|WO_GE, pIdx) ){
3510 WhereTerm *pTop, *pBtm;
3511 pTop = findTerm(pWC, iCur, j, p->notReady, WO_LT|WO_LE, pIdx);
3512 pBtm = findTerm(pWC, iCur, j, p->notReady, WO_GT|WO_GE, pIdx);
drhd663b5b2012-10-03 00:25:54 +00003513 whereRangeScanEst(pParse, pProbe, pc.plan.nEq, pBtm, pTop, &rangeDiv);
dan5236ac12009-08-13 07:09:33 +00003514 if( pTop ){
drhed754ce2010-04-15 01:04:54 +00003515 nBound = 1;
drhd663b5b2012-10-03 00:25:54 +00003516 pc.plan.wsFlags |= WHERE_TOP_LIMIT;
3517 pc.used |= pTop->prereqRight;
drh0a61df62011-10-07 17:45:58 +00003518 testcase( pTop->pWC!=pWC );
dan5236ac12009-08-13 07:09:33 +00003519 }
3520 if( pBtm ){
drhed754ce2010-04-15 01:04:54 +00003521 nBound++;
drhd663b5b2012-10-03 00:25:54 +00003522 pc.plan.wsFlags |= WHERE_BTM_LIMIT;
3523 pc.used |= pBtm->prereqRight;
drh0a61df62011-10-07 17:45:58 +00003524 testcase( pBtm->pWC!=pWC );
dan5236ac12009-08-13 07:09:33 +00003525 }
drhd663b5b2012-10-03 00:25:54 +00003526 pc.plan.wsFlags |= (WHERE_COLUMN_RANGE|WHERE_ROWID_RANGE);
dan5236ac12009-08-13 07:09:33 +00003527 }
drh943af3c2005-07-29 19:43:58 +00003528 }
drhfe05af82005-07-21 03:14:59 +00003529
dan5236ac12009-08-13 07:09:33 +00003530 /* If there is an ORDER BY clause and the index being considered will
3531 ** naturally scan rows in the required order, set the appropriate flags
drhd663b5b2012-10-03 00:25:54 +00003532 ** in pc.plan.wsFlags. Otherwise, if there is an ORDER BY clause but
3533 ** the index will scan rows in a different order, set the bSort
3534 ** variable. */
drh8e4af1b2012-10-08 18:23:51 +00003535 if( bSort && (pSrc->jointype & JT_LEFT)==0 ){
3536 int bRev = 2;
drh8a1b87c2013-03-27 15:04:28 +00003537 int bObUnique = 0;
drhf1b5f5b2013-05-02 00:15:01 +00003538 /*WHERETRACE((" --> before isSortIndex: nPriorSat=%d\n",nPriorSat));*/
drh8a1b87c2013-03-27 15:04:28 +00003539 pc.plan.nOBSat = isSortingIndex(p, pProbe, iCur, &bRev, &bObUnique);
drhf1b5f5b2013-05-02 00:15:01 +00003540 /*WHERETRACE((" --> after isSortIndex: bRev=%d bObU=%d nOBSat=%d\n",
3541 bRev, bObUnique, pc.plan.nOBSat));*/
drh29a8bf82013-01-09 11:31:17 +00003542 if( nPriorSat<pc.plan.nOBSat || (pc.plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
drhd663b5b2012-10-03 00:25:54 +00003543 pc.plan.wsFlags |= WHERE_ORDERED;
drh8a1b87c2013-03-27 15:04:28 +00003544 if( bObUnique ) pc.plan.wsFlags |= WHERE_OB_UNIQUE;
drh46c35f92012-09-26 23:17:01 +00003545 }
drhd663b5b2012-10-03 00:25:54 +00003546 if( nOrderBy==pc.plan.nOBSat ){
3547 bSort = 0;
3548 pc.plan.wsFlags |= WHERE_ROWID_RANGE|WHERE_COLUMN_RANGE;
3549 }
3550 if( bRev & 1 ) pc.plan.wsFlags |= WHERE_REVERSE;
dan38cc40c2011-06-30 20:17:15 +00003551 }
3552
3553 /* If there is a DISTINCT qualifier and this index will scan rows in
3554 ** order of the DISTINCT expressions, clear bDist and set the appropriate
drhd663b5b2012-10-03 00:25:54 +00003555 ** flags in pc.plan.wsFlags. */
drh9cd1c992012-09-25 20:43:35 +00003556 if( bDist
drhd663b5b2012-10-03 00:25:54 +00003557 && isDistinctIndex(pParse, pWC, pProbe, iCur, p->pDistinct, pc.plan.nEq)
3558 && (pc.plan.wsFlags & WHERE_COLUMN_IN)==0
drh7f67d942012-03-03 00:34:47 +00003559 ){
dan38cc40c2011-06-30 20:17:15 +00003560 bDist = 0;
drhd663b5b2012-10-03 00:25:54 +00003561 pc.plan.wsFlags |= WHERE_ROWID_RANGE|WHERE_COLUMN_RANGE|WHERE_DISTINCT;
drhfe05af82005-07-21 03:14:59 +00003562 }
3563
dan5236ac12009-08-13 07:09:33 +00003564 /* If currently calculating the cost of using an index (not the IPK
3565 ** index), determine if all required column data may be obtained without
drh4139c992010-04-07 14:59:45 +00003566 ** using the main table (i.e. if the index is a covering
dan5236ac12009-08-13 07:09:33 +00003567 ** index for this query). If it is, set the WHERE_IDX_ONLY flag in
drhd663b5b2012-10-03 00:25:54 +00003568 ** pc.plan.wsFlags. Otherwise, set the bLookup variable to true. */
drh3f4d1d12012-09-15 18:45:54 +00003569 if( pIdx ){
drhfe05af82005-07-21 03:14:59 +00003570 Bitmask m = pSrc->colUsed;
3571 int j;
dan5236ac12009-08-13 07:09:33 +00003572 for(j=0; j<pIdx->nColumn; j++){
3573 int x = pIdx->aiColumn[j];
drhfe05af82005-07-21 03:14:59 +00003574 if( x<BMS-1 ){
3575 m &= ~(((Bitmask)1)<<x);
3576 }
3577 }
3578 if( m==0 ){
drhd663b5b2012-10-03 00:25:54 +00003579 pc.plan.wsFlags |= WHERE_IDX_ONLY;
dan5236ac12009-08-13 07:09:33 +00003580 }else{
3581 bLookup = 1;
drhfe05af82005-07-21 03:14:59 +00003582 }
3583 }
3584
drh1e0f4a82010-04-14 19:01:44 +00003585 /*
drh9b3eb0a2011-01-21 14:37:04 +00003586 ** Estimate the number of rows of output. For an "x IN (SELECT...)"
3587 ** constraint, do not let the estimate exceed half the rows in the table.
drhcdaca552009-08-20 13:45:07 +00003588 */
drhd663b5b2012-10-03 00:25:54 +00003589 pc.plan.nRow = (double)(aiRowEst[pc.plan.nEq] * nInMul);
3590 if( bInEst && pc.plan.nRow*2>aiRowEst[0] ){
3591 pc.plan.nRow = aiRowEst[0]/2;
3592 nInMul = (int)(pc.plan.nRow / aiRowEst[pc.plan.nEq]);
dan5236ac12009-08-13 07:09:33 +00003593 }
drhcdaca552009-08-20 13:45:07 +00003594
drhfaacf172011-08-12 01:51:45 +00003595#ifdef SQLITE_ENABLE_STAT3
drhbf4ec552011-07-13 18:31:10 +00003596 /* If the constraint is of the form x=VALUE or x IN (E1,E2,...)
3597 ** and we do not think that values of x are unique and if histogram
drh82759752011-01-20 16:52:09 +00003598 ** data is available for column x, then it might be possible
3599 ** to get a better estimate on the number of rows based on
3600 ** VALUE and how common that value is according to the histogram.
3601 */
drhd663b5b2012-10-03 00:25:54 +00003602 if( pc.plan.nRow>(double)1 && pc.plan.nEq==1
3603 && pFirstTerm!=0 && aiRowEst[1]>1 ){
drh567211e2011-09-23 13:59:33 +00003604 assert( (pFirstTerm->eOperator & (WO_EQ|WO_ISNULL|WO_IN))!=0 );
drh1f9c7662011-03-17 01:34:26 +00003605 if( pFirstTerm->eOperator & (WO_EQ|WO_ISNULL) ){
drh7a5bcc02013-01-16 17:08:58 +00003606 testcase( pFirstTerm->eOperator & WO_EQ );
3607 testcase( pFirstTerm->eOperator & WO_EQUIV );
3608 testcase( pFirstTerm->eOperator & WO_ISNULL );
drhd663b5b2012-10-03 00:25:54 +00003609 whereEqualScanEst(pParse, pProbe, pFirstTerm->pExpr->pRight,
3610 &pc.plan.nRow);
drh567211e2011-09-23 13:59:33 +00003611 }else if( bInEst==0 ){
drh7a5bcc02013-01-16 17:08:58 +00003612 assert( pFirstTerm->eOperator & WO_IN );
drhd663b5b2012-10-03 00:25:54 +00003613 whereInScanEst(pParse, pProbe, pFirstTerm->pExpr->x.pList,
3614 &pc.plan.nRow);
drh0c50fa02011-01-21 16:27:18 +00003615 }
drh82759752011-01-20 16:52:09 +00003616 }
drhfaacf172011-08-12 01:51:45 +00003617#endif /* SQLITE_ENABLE_STAT3 */
drh82759752011-01-20 16:52:09 +00003618
drh37722062011-02-10 00:08:47 +00003619 /* Adjust the number of output rows and downward to reflect rows
drhcdaca552009-08-20 13:45:07 +00003620 ** that are excluded by range constraints.
3621 */
drhd663b5b2012-10-03 00:25:54 +00003622 pc.plan.nRow = pc.plan.nRow/rangeDiv;
3623 if( pc.plan.nRow<1 ) pc.plan.nRow = 1;
drhcdaca552009-08-20 13:45:07 +00003624
drh37722062011-02-10 00:08:47 +00003625 /* Experiments run on real SQLite databases show that the time needed
3626 ** to do a binary search to locate a row in a table or index is roughly
3627 ** log10(N) times the time to move from one row to the next row within
3628 ** a table or index. The actual times can vary, with the size of
3629 ** records being an important factor. Both moves and searches are
3630 ** slower with larger records, presumably because fewer records fit
3631 ** on one page and hence more pages have to be fetched.
drh083310d2011-01-28 01:57:41 +00003632 **
drh74e7c8f2011-10-21 19:06:32 +00003633 ** The ANALYZE command and the sqlite_stat1 and sqlite_stat3 tables do
drh37722062011-02-10 00:08:47 +00003634 ** not give us data on the relative sizes of table and index records.
3635 ** So this computation assumes table records are about twice as big
3636 ** as index records
drhb9661942011-01-24 15:11:23 +00003637 */
drh2b6c8742013-03-27 16:05:30 +00003638 if( (pc.plan.wsFlags&~(WHERE_REVERSE|WHERE_ORDERED|WHERE_OB_UNIQUE))
3639 ==WHERE_IDX_ONLY
drh3f4d1d12012-09-15 18:45:54 +00003640 && (pWC->wctrlFlags & WHERE_ONEPASS_DESIRED)==0
drhde9a7b82012-09-17 20:44:46 +00003641 && sqlite3GlobalConfig.bUseCis
drh7e5418e2012-09-27 15:05:54 +00003642 && OptimizationEnabled(pParse->db, SQLITE_CoverIdxScan)
drh3f4d1d12012-09-15 18:45:54 +00003643 ){
3644 /* This index is not useful for indexing, but it is a covering index.
3645 ** A full-scan of the index might be a little faster than a full-scan
3646 ** of the table, so give this case a cost slightly less than a table
3647 ** scan. */
drhd663b5b2012-10-03 00:25:54 +00003648 pc.rCost = aiRowEst[0]*3 + pProbe->nColumn;
3649 pc.plan.wsFlags |= WHERE_COVER_SCAN|WHERE_COLUMN_RANGE;
3650 }else if( (pc.plan.wsFlags & WHERE_NOT_FULLSCAN)==0 ){
drh37722062011-02-10 00:08:47 +00003651 /* The cost of a full table scan is a number of move operations equal
3652 ** to the number of rows in the table.
3653 **
3654 ** We add an additional 4x penalty to full table scans. This causes
3655 ** the cost function to err on the side of choosing an index over
3656 ** choosing a full scan. This 4x full-scan penalty is an arguable
3657 ** decision and one which we expect to revisit in the future. But
3658 ** it seems to be working well enough at the moment.
drh083310d2011-01-28 01:57:41 +00003659 */
drhd663b5b2012-10-03 00:25:54 +00003660 pc.rCost = aiRowEst[0]*4;
3661 pc.plan.wsFlags &= ~WHERE_IDX_ONLY;
drh8e4af1b2012-10-08 18:23:51 +00003662 if( pIdx ){
3663 pc.plan.wsFlags &= ~WHERE_ORDERED;
3664 pc.plan.nOBSat = nPriorSat;
3665 }
drh37722062011-02-10 00:08:47 +00003666 }else{
3667 log10N = estLog(aiRowEst[0]);
drhd663b5b2012-10-03 00:25:54 +00003668 pc.rCost = pc.plan.nRow;
drh37722062011-02-10 00:08:47 +00003669 if( pIdx ){
3670 if( bLookup ){
3671 /* For an index lookup followed by a table lookup:
3672 ** nInMul index searches to find the start of each index range
3673 ** + nRow steps through the index
3674 ** + nRow table searches to lookup the table entry using the rowid
3675 */
drhd663b5b2012-10-03 00:25:54 +00003676 pc.rCost += (nInMul + pc.plan.nRow)*log10N;
drh37722062011-02-10 00:08:47 +00003677 }else{
3678 /* For a covering index:
3679 ** nInMul index searches to find the initial entry
3680 ** + nRow steps through the index
3681 */
drhd663b5b2012-10-03 00:25:54 +00003682 pc.rCost += nInMul*log10N;
drh37722062011-02-10 00:08:47 +00003683 }
3684 }else{
3685 /* For a rowid primary key lookup:
3686 ** nInMult table searches to find the initial entry for each range
3687 ** + nRow steps through the table
3688 */
drhd663b5b2012-10-03 00:25:54 +00003689 pc.rCost += nInMul*log10N;
drh37722062011-02-10 00:08:47 +00003690 }
drhb9661942011-01-24 15:11:23 +00003691 }
3692
drh37722062011-02-10 00:08:47 +00003693 /* Add in the estimated cost of sorting the result. Actual experimental
3694 ** measurements of sorting performance in SQLite show that sorting time
3695 ** adds C*N*log10(N) to the cost, where N is the number of rows to be
3696 ** sorted and C is a factor between 1.95 and 4.3. We will split the
3697 ** difference and select C of 3.0.
drhcdaca552009-08-20 13:45:07 +00003698 */
dan5236ac12009-08-13 07:09:33 +00003699 if( bSort ){
drhd663b5b2012-10-03 00:25:54 +00003700 double m = estLog(pc.plan.nRow*(nOrderBy - pc.plan.nOBSat)/nOrderBy);
3701 m *= (double)(pc.plan.nOBSat ? 2 : 3);
3702 pc.rCost += pc.plan.nRow*m;
dan5236ac12009-08-13 07:09:33 +00003703 }
dan38cc40c2011-06-30 20:17:15 +00003704 if( bDist ){
drhd663b5b2012-10-03 00:25:54 +00003705 pc.rCost += pc.plan.nRow*estLog(pc.plan.nRow)*3;
dan38cc40c2011-06-30 20:17:15 +00003706 }
drhcdaca552009-08-20 13:45:07 +00003707
drhcdaca552009-08-20 13:45:07 +00003708 /**** Cost of using this index has now been computed ****/
dan5236ac12009-08-13 07:09:33 +00003709
drh1e0f4a82010-04-14 19:01:44 +00003710 /* If there are additional constraints on this table that cannot
3711 ** be used with the current index, but which might lower the number
3712 ** of output rows, adjust the nRow value accordingly. This only
3713 ** matters if the current index is the least costly, so do not bother
3714 ** with this step if we already know this index will not be chosen.
drhed754ce2010-04-15 01:04:54 +00003715 ** Also, never reduce the output row count below 2 using this step.
drhed808ac2010-04-15 13:29:37 +00003716 **
drh547caad2010-10-04 23:55:50 +00003717 ** It is critical that the notValid mask be used here instead of
3718 ** the notReady mask. When computing an "optimal" index, the notReady
3719 ** mask will only have one bit set - the bit for the current table.
3720 ** The notValid mask, on the other hand, always has all bits set for
3721 ** tables that are not in outer loops. If notReady is used here instead
3722 ** of notValid, then a optimal index that depends on inner joins loops
3723 ** might be selected even when there exists an optimal index that has
3724 ** no such dependency.
drh1e0f4a82010-04-14 19:01:44 +00003725 */
drhd663b5b2012-10-03 00:25:54 +00003726 if( pc.plan.nRow>2 && pc.rCost<=p->cost.rCost ){
drhed808ac2010-04-15 13:29:37 +00003727 int k; /* Loop counter */
drhd663b5b2012-10-03 00:25:54 +00003728 int nSkipEq = pc.plan.nEq; /* Number of == constraints to skip */
drhed808ac2010-04-15 13:29:37 +00003729 int nSkipRange = nBound; /* Number of < constraints to skip */
3730 Bitmask thisTab; /* Bitmap for pSrc */
3731
3732 thisTab = getMask(pWC->pMaskSet, iCur);
drhd663b5b2012-10-03 00:25:54 +00003733 for(pTerm=pWC->a, k=pWC->nTerm; pc.plan.nRow>2 && k; k--, pTerm++){
drh534230c2011-01-22 00:10:45 +00003734 if( pTerm->wtFlags & TERM_VIRTUAL ) continue;
drh56f1b992012-09-25 14:29:39 +00003735 if( (pTerm->prereqAll & p->notValid)!=thisTab ) continue;
drh1e0f4a82010-04-14 19:01:44 +00003736 if( pTerm->eOperator & (WO_EQ|WO_IN|WO_ISNULL) ){
drhed754ce2010-04-15 01:04:54 +00003737 if( nSkipEq ){
drhd663b5b2012-10-03 00:25:54 +00003738 /* Ignore the first pc.plan.nEq equality matches since the index
drh1e0f4a82010-04-14 19:01:44 +00003739 ** has already accounted for these */
drhed754ce2010-04-15 01:04:54 +00003740 nSkipEq--;
drh1e0f4a82010-04-14 19:01:44 +00003741 }else{
3742 /* Assume each additional equality match reduces the result
3743 ** set size by a factor of 10 */
drhd663b5b2012-10-03 00:25:54 +00003744 pc.plan.nRow /= 10;
drh1e0f4a82010-04-14 19:01:44 +00003745 }
drhed754ce2010-04-15 01:04:54 +00003746 }else if( pTerm->eOperator & (WO_LT|WO_LE|WO_GT|WO_GE) ){
3747 if( nSkipRange ){
drh5ac06072011-01-21 18:18:13 +00003748 /* Ignore the first nSkipRange range constraints since the index
drhed754ce2010-04-15 01:04:54 +00003749 ** has already accounted for these */
3750 nSkipRange--;
3751 }else{
3752 /* Assume each additional range constraint reduces the result
drh083310d2011-01-28 01:57:41 +00003753 ** set size by a factor of 3. Indexed range constraints reduce
3754 ** the search space by a larger factor: 4. We make indexed range
3755 ** more selective intentionally because of the subjective
3756 ** observation that indexed range constraints really are more
3757 ** selective in practice, on average. */
drhd663b5b2012-10-03 00:25:54 +00003758 pc.plan.nRow /= 3;
drhed754ce2010-04-15 01:04:54 +00003759 }
drh7a5bcc02013-01-16 17:08:58 +00003760 }else if( (pTerm->eOperator & WO_NOOP)==0 ){
drh1e0f4a82010-04-14 19:01:44 +00003761 /* Any other expression lowers the output row count by half */
drhd663b5b2012-10-03 00:25:54 +00003762 pc.plan.nRow /= 2;
drh1e0f4a82010-04-14 19:01:44 +00003763 }
3764 }
drhd663b5b2012-10-03 00:25:54 +00003765 if( pc.plan.nRow<2 ) pc.plan.nRow = 2;
drh1e0f4a82010-04-14 19:01:44 +00003766 }
3767
3768
drhf1b5f5b2013-05-02 00:15:01 +00003769 /*WHERETRACE((
drh8e4af1b2012-10-08 18:23:51 +00003770 " nEq=%d nInMul=%d rangeDiv=%d bSort=%d bLookup=%d wsFlags=0x%08x\n"
3771 " notReady=0x%llx log10N=%.1f nRow=%.1f cost=%.1f\n"
3772 " used=0x%llx nOBSat=%d\n",
drhd663b5b2012-10-03 00:25:54 +00003773 pc.plan.nEq, nInMul, (int)rangeDiv, bSort, bLookup, pc.plan.wsFlags,
drh4f68d6c2012-10-04 12:10:25 +00003774 p->notReady, log10N, pc.plan.nRow, pc.rCost, pc.used,
drhd663b5b2012-10-03 00:25:54 +00003775 pc.plan.nOBSat
drhf1b5f5b2013-05-02 00:15:01 +00003776 ));*/
dan5236ac12009-08-13 07:09:33 +00003777
drhcdaca552009-08-20 13:45:07 +00003778 /* If this index is the best we have seen so far, then record this
drhd663b5b2012-10-03 00:25:54 +00003779 ** index and its cost in the p->cost structure.
drhcdaca552009-08-20 13:45:07 +00003780 */
drhd663b5b2012-10-03 00:25:54 +00003781 if( (!pIdx || pc.plan.wsFlags) && compareCost(&pc, &p->cost) ){
3782 p->cost = pc;
3783 p->cost.plan.wsFlags &= wsFlagMask;
drh56f1b992012-09-25 14:29:39 +00003784 p->cost.plan.u.pIdx = pIdx;
drhfe05af82005-07-21 03:14:59 +00003785 }
dan5236ac12009-08-13 07:09:33 +00003786
drhcdaca552009-08-20 13:45:07 +00003787 /* If there was an INDEXED BY clause, then only that one index is
3788 ** considered. */
dan5236ac12009-08-13 07:09:33 +00003789 if( pSrc->pIndex ) break;
drhcdaca552009-08-20 13:45:07 +00003790
3791 /* Reset masks for the next index in the loop */
dan5236ac12009-08-13 07:09:33 +00003792 wsFlagMask = ~(WHERE_ROWID_EQ|WHERE_ROWID_RANGE);
3793 eqTermMask = idxEqTermMask;
drhfe05af82005-07-21 03:14:59 +00003794 }
3795
dan5236ac12009-08-13 07:09:33 +00003796 /* If there is no ORDER BY clause and the SQLITE_ReverseOrder flag
3797 ** is set, then reverse the order that the index will be scanned
3798 ** in. This is used for application testing, to help find cases
mistachkin48864df2013-03-21 21:20:32 +00003799 ** where application behavior depends on the (undefined) order that
dan5236ac12009-08-13 07:09:33 +00003800 ** SQLite outputs rows in in the absence of an ORDER BY clause. */
drh56f1b992012-09-25 14:29:39 +00003801 if( !p->pOrderBy && pParse->db->flags & SQLITE_ReverseOrder ){
3802 p->cost.plan.wsFlags |= WHERE_REVERSE;
dan5236ac12009-08-13 07:09:33 +00003803 }
3804
drhd663b5b2012-10-03 00:25:54 +00003805 assert( p->pOrderBy || (p->cost.plan.wsFlags&WHERE_ORDERED)==0 );
drh56f1b992012-09-25 14:29:39 +00003806 assert( p->cost.plan.u.pIdx==0 || (p->cost.plan.wsFlags&WHERE_ROWID_EQ)==0 );
dan5236ac12009-08-13 07:09:33 +00003807 assert( pSrc->pIndex==0
drh56f1b992012-09-25 14:29:39 +00003808 || p->cost.plan.u.pIdx==0
3809 || p->cost.plan.u.pIdx==pSrc->pIndex
dan5236ac12009-08-13 07:09:33 +00003810 );
3811
drhf1b5f5b2013-05-02 00:15:01 +00003812 /*WHERETRACE((" best index is %s cost=%.1f\n",
drhea84a652013-01-15 18:49:07 +00003813 p->cost.plan.u.pIdx ? p->cost.plan.u.pIdx->zName : "ipk",
drhf1b5f5b2013-05-02 00:15:01 +00003814 p->cost.rCost));*/
dan5236ac12009-08-13 07:09:33 +00003815
drh56f1b992012-09-25 14:29:39 +00003816 bestOrClauseIndex(p);
3817 bestAutomaticIndex(p);
3818 p->cost.plan.wsFlags |= eqTermMask;
drhfe05af82005-07-21 03:14:59 +00003819}
3820
danielk19771d461462009-04-21 09:02:45 +00003821/*
3822** Find the query plan for accessing table pSrc->pTab. Write the
3823** best query plan and its cost into the WhereCost object supplied
3824** as the last parameter. This function may calculate the cost of
3825** both real and virtual table scans.
drh4d85fa72012-09-24 19:50:00 +00003826**
3827** This function does not take ORDER BY or DISTINCT into account. Nor
3828** does it remember the virtual table query plan. All it does is compute
3829** the cost while determining if an OR optimization is applicable. The
3830** details will be reconsidered later if the optimization is found to be
3831** applicable.
danielk19771d461462009-04-21 09:02:45 +00003832*/
drh56f1b992012-09-25 14:29:39 +00003833static void bestIndex(WhereBestIdx *p){
shanee26fa4c2009-06-16 14:15:22 +00003834#ifndef SQLITE_OMIT_VIRTUALTABLE
drh56f1b992012-09-25 14:29:39 +00003835 if( IsVirtual(p->pSrc->pTab) ){
3836 sqlite3_index_info *pIdxInfo = 0;
3837 p->ppIdxInfo = &pIdxInfo;
3838 bestVirtualIndex(p);
drh5edf8432013-02-08 23:18:18 +00003839 assert( pIdxInfo!=0 || p->pParse->db->mallocFailed );
3840 if( pIdxInfo && pIdxInfo->needToFreeIdxStr ){
drh56f1b992012-09-25 14:29:39 +00003841 sqlite3_free(pIdxInfo->idxStr);
danielk19771d461462009-04-21 09:02:45 +00003842 }
drh56f1b992012-09-25 14:29:39 +00003843 sqlite3DbFree(p->pParse->db, pIdxInfo);
shanee26fa4c2009-06-16 14:15:22 +00003844 }else
3845#endif
3846 {
drh56f1b992012-09-25 14:29:39 +00003847 bestBtreeIndex(p);
danielk19771d461462009-04-21 09:02:45 +00003848 }
3849}
drhb6c29892004-11-22 19:12:19 +00003850
3851/*
drh2ffb1182004-07-19 19:14:01 +00003852** Disable a term in the WHERE clause. Except, do not disable the term
3853** if it controls a LEFT OUTER JOIN and it did not originate in the ON
3854** or USING clause of that join.
3855**
3856** Consider the term t2.z='ok' in the following queries:
3857**
3858** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
3859** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
3860** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
3861**
drh23bf66d2004-12-14 03:34:34 +00003862** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00003863** in the ON clause. The term is disabled in (3) because it is not part
3864** of a LEFT OUTER JOIN. In (1), the term is not disabled.
3865**
drhe9cdcea2010-07-22 22:40:03 +00003866** IMPLEMENTATION-OF: R-24597-58655 No tests are done for terms that are
3867** completely satisfied by indices.
3868**
drh2ffb1182004-07-19 19:14:01 +00003869** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00003870** of the join. Disabling is an optimization. When terms are satisfied
3871** by indices, we disable them to prevent redundant tests in the inner
3872** loop. We would get the correct results if nothing were ever disabled,
3873** but joins might run a little slower. The trick is to disable as much
3874** as we can without disabling too much. If we disabled in (1), we'd get
3875** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00003876*/
drh0fcef5e2005-07-19 17:38:22 +00003877static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
3878 if( pTerm
drhbe837bd2010-04-30 21:03:24 +00003879 && (pTerm->wtFlags & TERM_CODED)==0
drh0fcef5e2005-07-19 17:38:22 +00003880 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
3881 ){
drh165be382008-12-05 02:36:33 +00003882 pTerm->wtFlags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00003883 if( pTerm->iParent>=0 ){
3884 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
3885 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00003886 disableTerm(pLevel, pOther);
3887 }
drh0fcef5e2005-07-19 17:38:22 +00003888 }
drh2ffb1182004-07-19 19:14:01 +00003889 }
3890}
3891
3892/*
dan69f8bb92009-08-13 19:21:16 +00003893** Code an OP_Affinity opcode to apply the column affinity string zAff
3894** to the n registers starting at base.
3895**
drh039fc322009-11-17 18:31:47 +00003896** As an optimization, SQLITE_AFF_NONE entries (which are no-ops) at the
3897** beginning and end of zAff are ignored. If all entries in zAff are
3898** SQLITE_AFF_NONE, then no code gets generated.
3899**
3900** This routine makes its own copy of zAff so that the caller is free
3901** to modify zAff after this routine returns.
drh94a11212004-09-25 13:12:14 +00003902*/
dan69f8bb92009-08-13 19:21:16 +00003903static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
3904 Vdbe *v = pParse->pVdbe;
drh039fc322009-11-17 18:31:47 +00003905 if( zAff==0 ){
3906 assert( pParse->db->mallocFailed );
3907 return;
3908 }
dan69f8bb92009-08-13 19:21:16 +00003909 assert( v!=0 );
drh039fc322009-11-17 18:31:47 +00003910
3911 /* Adjust base and n to skip over SQLITE_AFF_NONE entries at the beginning
3912 ** and end of the affinity string.
3913 */
3914 while( n>0 && zAff[0]==SQLITE_AFF_NONE ){
3915 n--;
3916 base++;
3917 zAff++;
3918 }
3919 while( n>1 && zAff[n-1]==SQLITE_AFF_NONE ){
3920 n--;
3921 }
3922
3923 /* Code the OP_Affinity opcode if there is anything left to do. */
3924 if( n>0 ){
3925 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
3926 sqlite3VdbeChangeP4(v, -1, zAff, n);
3927 sqlite3ExprCacheAffinityChange(pParse, base, n);
3928 }
drh94a11212004-09-25 13:12:14 +00003929}
3930
drhe8b97272005-07-19 22:22:12 +00003931
3932/*
drh51147ba2005-07-23 22:59:55 +00003933** Generate code for a single equality term of the WHERE clause. An equality
3934** term can be either X=expr or X IN (...). pTerm is the term to be
3935** coded.
3936**
drh1db639c2008-01-17 02:36:28 +00003937** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00003938**
3939** For a constraint of the form X=expr, the expression is evaluated and its
3940** result is left on the stack. For constraints of the form X IN (...)
3941** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00003942*/
drh678ccce2008-03-31 18:19:54 +00003943static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00003944 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00003945 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh0fe456b2013-03-12 18:34:50 +00003946 WhereLevel *pLevel, /* The level of the FROM clause we are working on */
3947 int iEq, /* Index of the equality term within this level */
drh678ccce2008-03-31 18:19:54 +00003948 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00003949){
drh0fcef5e2005-07-19 17:38:22 +00003950 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00003951 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00003952 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00003953
danielk19772d605492008-10-01 08:43:03 +00003954 assert( iTarget>0 );
drh50b39962006-10-28 00:28:09 +00003955 if( pX->op==TK_EQ ){
drh678ccce2008-03-31 18:19:54 +00003956 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00003957 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00003958 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00003959 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00003960#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00003961 }else{
danielk19779a96b662007-11-29 17:05:18 +00003962 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00003963 int iTab;
drh72e8fa42007-03-28 14:30:06 +00003964 struct InLoop *pIn;
drhd3832162013-03-12 18:49:25 +00003965 u8 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
danielk1977b3bce662005-01-29 08:32:43 +00003966
drhd3832162013-03-12 18:49:25 +00003967 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0
3968 && pLevel->plan.u.pIdx->aSortOrder[iEq]
3969 ){
drh725e1ae2013-03-12 23:58:42 +00003970 testcase( iEq==0 );
3971 testcase( iEq==pLevel->plan.u.pIdx->nColumn-1 );
3972 testcase( iEq>0 && iEq+1<pLevel->plan.u.pIdx->nColumn );
3973 testcase( bRev );
drh1ccce442013-03-12 20:38:51 +00003974 bRev = !bRev;
drh0fe456b2013-03-12 18:34:50 +00003975 }
drh50b39962006-10-28 00:28:09 +00003976 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00003977 iReg = iTarget;
danielk19770cdc0222008-06-26 18:04:03 +00003978 eType = sqlite3FindInIndex(pParse, pX, 0);
drh725e1ae2013-03-12 23:58:42 +00003979 if( eType==IN_INDEX_INDEX_DESC ){
3980 testcase( bRev );
3981 bRev = !bRev;
3982 }
danielk1977b3bce662005-01-29 08:32:43 +00003983 iTab = pX->iTable;
drh2d96b932013-02-08 18:48:23 +00003984 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
drh111a6a72008-12-21 03:51:16 +00003985 assert( pLevel->plan.wsFlags & WHERE_IN_ABLE );
3986 if( pLevel->u.in.nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00003987 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00003988 }
drh111a6a72008-12-21 03:51:16 +00003989 pLevel->u.in.nIn++;
3990 pLevel->u.in.aInLoop =
3991 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
3992 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
3993 pIn = pLevel->u.in.aInLoop;
drh72e8fa42007-03-28 14:30:06 +00003994 if( pIn ){
drh111a6a72008-12-21 03:51:16 +00003995 pIn += pLevel->u.in.nIn - 1;
drh72e8fa42007-03-28 14:30:06 +00003996 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00003997 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00003998 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00003999 }else{
drhb3190c12008-12-08 21:37:14 +00004000 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00004001 }
drh2d96b932013-02-08 18:48:23 +00004002 pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
drh1db639c2008-01-17 02:36:28 +00004003 sqlite3VdbeAddOp1(v, OP_IsNull, iReg);
drha6110402005-07-28 20:51:19 +00004004 }else{
drh111a6a72008-12-21 03:51:16 +00004005 pLevel->u.in.nIn = 0;
drhe23399f2005-07-22 00:31:39 +00004006 }
danielk1977b3bce662005-01-29 08:32:43 +00004007#endif
drh94a11212004-09-25 13:12:14 +00004008 }
drh0fcef5e2005-07-19 17:38:22 +00004009 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00004010 return iReg;
drh94a11212004-09-25 13:12:14 +00004011}
4012
drh51147ba2005-07-23 22:59:55 +00004013/*
4014** Generate code that will evaluate all == and IN constraints for an
drh039fc322009-11-17 18:31:47 +00004015** index.
drh51147ba2005-07-23 22:59:55 +00004016**
4017** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
4018** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
4019** The index has as many as three equality constraints, but in this
4020** example, the third "c" value is an inequality. So only two
4021** constraints are coded. This routine will generate code to evaluate
drh6df2acd2008-12-28 16:55:25 +00004022** a==5 and b IN (1,2,3). The current values for a and b will be stored
4023** in consecutive registers and the index of the first register is returned.
drh51147ba2005-07-23 22:59:55 +00004024**
4025** In the example above nEq==2. But this subroutine works for any value
4026** of nEq including 0. If nEq==0, this routine is nearly a no-op.
drh039fc322009-11-17 18:31:47 +00004027** The only thing it does is allocate the pLevel->iMem memory cell and
4028** compute the affinity string.
drh51147ba2005-07-23 22:59:55 +00004029**
drh700a2262008-12-17 19:22:15 +00004030** This routine always allocates at least one memory cell and returns
4031** the index of that memory cell. The code that
4032** calls this routine will use that memory cell to store the termination
drh51147ba2005-07-23 22:59:55 +00004033** key value of the loop. If one or more IN operators appear, then
4034** this routine allocates an additional nEq memory cells for internal
4035** use.
dan69f8bb92009-08-13 19:21:16 +00004036**
4037** Before returning, *pzAff is set to point to a buffer containing a
4038** copy of the column affinity string of the index allocated using
4039** sqlite3DbMalloc(). Except, entries in the copy of the string associated
4040** with equality constraints that use NONE affinity are set to
4041** SQLITE_AFF_NONE. This is to deal with SQL such as the following:
4042**
4043** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
4044** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
4045**
4046** In the example above, the index on t1(a) has TEXT affinity. But since
4047** the right hand side of the equality constraint (t2.b) has NONE affinity,
4048** no conversion should be attempted before using a t2.b value as part of
4049** a key to search the index. Hence the first byte in the returned affinity
4050** string in this example would be set to SQLITE_AFF_NONE.
drh51147ba2005-07-23 22:59:55 +00004051*/
drh1db639c2008-01-17 02:36:28 +00004052static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00004053 Parse *pParse, /* Parsing context */
4054 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
4055 WhereClause *pWC, /* The WHERE clause */
drh1db639c2008-01-17 02:36:28 +00004056 Bitmask notReady, /* Which parts of FROM have not yet been coded */
dan69f8bb92009-08-13 19:21:16 +00004057 int nExtraReg, /* Number of extra registers to allocate */
4058 char **pzAff /* OUT: Set to point to affinity string */
drh51147ba2005-07-23 22:59:55 +00004059){
drh111a6a72008-12-21 03:51:16 +00004060 int nEq = pLevel->plan.nEq; /* The number of == or IN constraints to code */
4061 Vdbe *v = pParse->pVdbe; /* The vm under construction */
4062 Index *pIdx; /* The index being used for this loop */
drh51147ba2005-07-23 22:59:55 +00004063 int iCur = pLevel->iTabCur; /* The cursor of the table */
4064 WhereTerm *pTerm; /* A single constraint term */
4065 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00004066 int regBase; /* Base register */
drh6df2acd2008-12-28 16:55:25 +00004067 int nReg; /* Number of registers to allocate */
dan69f8bb92009-08-13 19:21:16 +00004068 char *zAff; /* Affinity string to return */
drh51147ba2005-07-23 22:59:55 +00004069
drh111a6a72008-12-21 03:51:16 +00004070 /* This module is only called on query plans that use an index. */
4071 assert( pLevel->plan.wsFlags & WHERE_INDEXED );
4072 pIdx = pLevel->plan.u.pIdx;
4073
drh51147ba2005-07-23 22:59:55 +00004074 /* Figure out how many memory cells we will need then allocate them.
drh51147ba2005-07-23 22:59:55 +00004075 */
drh700a2262008-12-17 19:22:15 +00004076 regBase = pParse->nMem + 1;
drh6df2acd2008-12-28 16:55:25 +00004077 nReg = pLevel->plan.nEq + nExtraReg;
4078 pParse->nMem += nReg;
drh51147ba2005-07-23 22:59:55 +00004079
dan69f8bb92009-08-13 19:21:16 +00004080 zAff = sqlite3DbStrDup(pParse->db, sqlite3IndexAffinityStr(v, pIdx));
4081 if( !zAff ){
4082 pParse->db->mallocFailed = 1;
4083 }
4084
drh51147ba2005-07-23 22:59:55 +00004085 /* Evaluate the equality constraints
4086 */
drhc49de5d2007-01-19 01:06:01 +00004087 assert( pIdx->nColumn>=nEq );
4088 for(j=0; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00004089 int r1;
drh51147ba2005-07-23 22:59:55 +00004090 int k = pIdx->aiColumn[j];
drh111a6a72008-12-21 03:51:16 +00004091 pTerm = findTerm(pWC, iCur, k, notReady, pLevel->plan.wsFlags, pIdx);
drh7b36ba32012-08-24 21:54:11 +00004092 if( pTerm==0 ) break;
drhbe837bd2010-04-30 21:03:24 +00004093 /* The following true for indices with redundant columns.
4094 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
4095 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
drhe9cdcea2010-07-22 22:40:03 +00004096 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh0fe456b2013-03-12 18:34:50 +00004097 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, regBase+j);
drh678ccce2008-03-31 18:19:54 +00004098 if( r1!=regBase+j ){
drh6df2acd2008-12-28 16:55:25 +00004099 if( nReg==1 ){
4100 sqlite3ReleaseTempReg(pParse, regBase);
4101 regBase = r1;
4102 }else{
4103 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
4104 }
drh678ccce2008-03-31 18:19:54 +00004105 }
drh981642f2008-04-19 14:40:43 +00004106 testcase( pTerm->eOperator & WO_ISNULL );
4107 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00004108 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drh039fc322009-11-17 18:31:47 +00004109 Expr *pRight = pTerm->pExpr->pRight;
drh2f2855b2009-11-18 01:25:26 +00004110 sqlite3ExprCodeIsNullJump(v, pRight, regBase+j, pLevel->addrBrk);
drh039fc322009-11-17 18:31:47 +00004111 if( zAff ){
4112 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_NONE ){
4113 zAff[j] = SQLITE_AFF_NONE;
4114 }
4115 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
4116 zAff[j] = SQLITE_AFF_NONE;
4117 }
dan69f8bb92009-08-13 19:21:16 +00004118 }
drh51147ba2005-07-23 22:59:55 +00004119 }
4120 }
dan69f8bb92009-08-13 19:21:16 +00004121 *pzAff = zAff;
drh1db639c2008-01-17 02:36:28 +00004122 return regBase;
drh51147ba2005-07-23 22:59:55 +00004123}
4124
dan2ce22452010-11-08 19:01:16 +00004125#ifndef SQLITE_OMIT_EXPLAIN
dan17c0bc02010-11-09 17:35:19 +00004126/*
drh69174c42010-11-12 15:35:59 +00004127** This routine is a helper for explainIndexRange() below
4128**
4129** pStr holds the text of an expression that we are building up one term
4130** at a time. This routine adds a new term to the end of the expression.
4131** Terms are separated by AND so add the "AND" text for second and subsequent
4132** terms only.
4133*/
4134static void explainAppendTerm(
4135 StrAccum *pStr, /* The text expression being built */
4136 int iTerm, /* Index of this term. First is zero */
4137 const char *zColumn, /* Name of the column */
4138 const char *zOp /* Name of the operator */
4139){
4140 if( iTerm ) sqlite3StrAccumAppend(pStr, " AND ", 5);
4141 sqlite3StrAccumAppend(pStr, zColumn, -1);
4142 sqlite3StrAccumAppend(pStr, zOp, 1);
4143 sqlite3StrAccumAppend(pStr, "?", 1);
4144}
4145
4146/*
dan17c0bc02010-11-09 17:35:19 +00004147** Argument pLevel describes a strategy for scanning table pTab. This
4148** function returns a pointer to a string buffer containing a description
4149** of the subset of table rows scanned by the strategy in the form of an
4150** SQL expression. Or, if all rows are scanned, NULL is returned.
4151**
4152** For example, if the query:
4153**
4154** SELECT * FROM t1 WHERE a=1 AND b>2;
4155**
4156** is run and there is an index on (a, b), then this function returns a
4157** string similar to:
4158**
4159** "a=? AND b>?"
4160**
4161** The returned pointer points to memory obtained from sqlite3DbMalloc().
4162** It is the responsibility of the caller to free the buffer when it is
4163** no longer required.
4164*/
4165static char *explainIndexRange(sqlite3 *db, WhereLevel *pLevel, Table *pTab){
dan2ce22452010-11-08 19:01:16 +00004166 WherePlan *pPlan = &pLevel->plan;
4167 Index *pIndex = pPlan->u.pIdx;
4168 int nEq = pPlan->nEq;
drh69174c42010-11-12 15:35:59 +00004169 int i, j;
4170 Column *aCol = pTab->aCol;
4171 int *aiColumn = pIndex->aiColumn;
4172 StrAccum txt;
dan2ce22452010-11-08 19:01:16 +00004173
drh69174c42010-11-12 15:35:59 +00004174 if( nEq==0 && (pPlan->wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ){
4175 return 0;
4176 }
4177 sqlite3StrAccumInit(&txt, 0, 0, SQLITE_MAX_LENGTH);
drh03b6df12010-11-15 16:29:30 +00004178 txt.db = db;
drh69174c42010-11-12 15:35:59 +00004179 sqlite3StrAccumAppend(&txt, " (", 2);
dan2ce22452010-11-08 19:01:16 +00004180 for(i=0; i<nEq; i++){
drh69174c42010-11-12 15:35:59 +00004181 explainAppendTerm(&txt, i, aCol[aiColumn[i]].zName, "=");
dan2ce22452010-11-08 19:01:16 +00004182 }
4183
drh69174c42010-11-12 15:35:59 +00004184 j = i;
dan2ce22452010-11-08 19:01:16 +00004185 if( pPlan->wsFlags&WHERE_BTM_LIMIT ){
dan0c733f62011-11-16 15:27:09 +00004186 char *z = (j==pIndex->nColumn ) ? "rowid" : aCol[aiColumn[j]].zName;
4187 explainAppendTerm(&txt, i++, z, ">");
dan2ce22452010-11-08 19:01:16 +00004188 }
4189 if( pPlan->wsFlags&WHERE_TOP_LIMIT ){
dan0c733f62011-11-16 15:27:09 +00004190 char *z = (j==pIndex->nColumn ) ? "rowid" : aCol[aiColumn[j]].zName;
4191 explainAppendTerm(&txt, i, z, "<");
dan2ce22452010-11-08 19:01:16 +00004192 }
drh69174c42010-11-12 15:35:59 +00004193 sqlite3StrAccumAppend(&txt, ")", 1);
4194 return sqlite3StrAccumFinish(&txt);
dan2ce22452010-11-08 19:01:16 +00004195}
4196
dan17c0bc02010-11-09 17:35:19 +00004197/*
4198** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
4199** command. If the query being compiled is an EXPLAIN QUERY PLAN, a single
4200** record is added to the output to describe the table scan strategy in
4201** pLevel.
4202*/
4203static void explainOneScan(
dan2ce22452010-11-08 19:01:16 +00004204 Parse *pParse, /* Parse context */
4205 SrcList *pTabList, /* Table list this loop refers to */
4206 WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
4207 int iLevel, /* Value for "level" column of output */
dan4a07e3d2010-11-09 14:48:59 +00004208 int iFrom, /* Value for "from" column of output */
4209 u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
dan2ce22452010-11-08 19:01:16 +00004210){
4211 if( pParse->explain==2 ){
4212 u32 flags = pLevel->plan.wsFlags;
4213 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
dan17c0bc02010-11-09 17:35:19 +00004214 Vdbe *v = pParse->pVdbe; /* VM being constructed */
4215 sqlite3 *db = pParse->db; /* Database handle */
4216 char *zMsg; /* Text to add to EQP output */
dan4a07e3d2010-11-09 14:48:59 +00004217 sqlite3_int64 nRow; /* Expected number of rows visited by scan */
4218 int iId = pParse->iSelectId; /* Select id (left-most output column) */
dan4bc39fa2010-11-13 16:42:27 +00004219 int isSearch; /* True for a SEARCH. False for SCAN. */
dan2ce22452010-11-08 19:01:16 +00004220
dan4a07e3d2010-11-09 14:48:59 +00004221 if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_ONETABLE_ONLY) ) return;
dan2ce22452010-11-08 19:01:16 +00004222
drh04098e62010-11-15 21:50:19 +00004223 isSearch = (pLevel->plan.nEq>0)
4224 || (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
4225 || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
dan4bc39fa2010-11-13 16:42:27 +00004226
4227 zMsg = sqlite3MPrintf(db, "%s", isSearch?"SEARCH":"SCAN");
dan4a07e3d2010-11-09 14:48:59 +00004228 if( pItem->pSelect ){
dan4bc39fa2010-11-13 16:42:27 +00004229 zMsg = sqlite3MAppendf(db, zMsg, "%s SUBQUERY %d", zMsg,pItem->iSelectId);
dan4a07e3d2010-11-09 14:48:59 +00004230 }else{
dan4bc39fa2010-11-13 16:42:27 +00004231 zMsg = sqlite3MAppendf(db, zMsg, "%s TABLE %s", zMsg, pItem->zName);
dan4a07e3d2010-11-09 14:48:59 +00004232 }
4233
dan2ce22452010-11-08 19:01:16 +00004234 if( pItem->zAlias ){
4235 zMsg = sqlite3MAppendf(db, zMsg, "%s AS %s", zMsg, pItem->zAlias);
4236 }
4237 if( (flags & WHERE_INDEXED)!=0 ){
dan17c0bc02010-11-09 17:35:19 +00004238 char *zWhere = explainIndexRange(db, pLevel, pItem->pTab);
dan4bc39fa2010-11-13 16:42:27 +00004239 zMsg = sqlite3MAppendf(db, zMsg, "%s USING %s%sINDEX%s%s%s", zMsg,
dan2ce22452010-11-08 19:01:16 +00004240 ((flags & WHERE_TEMP_INDEX)?"AUTOMATIC ":""),
4241 ((flags & WHERE_IDX_ONLY)?"COVERING ":""),
4242 ((flags & WHERE_TEMP_INDEX)?"":" "),
4243 ((flags & WHERE_TEMP_INDEX)?"": pLevel->plan.u.pIdx->zName),
4244 zWhere
4245 );
4246 sqlite3DbFree(db, zWhere);
4247 }else if( flags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
dan4bc39fa2010-11-13 16:42:27 +00004248 zMsg = sqlite3MAppendf(db, zMsg, "%s USING INTEGER PRIMARY KEY", zMsg);
dan2ce22452010-11-08 19:01:16 +00004249
4250 if( flags&WHERE_ROWID_EQ ){
4251 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid=?)", zMsg);
drh04098e62010-11-15 21:50:19 +00004252 }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
dan2ce22452010-11-08 19:01:16 +00004253 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid>? AND rowid<?)", zMsg);
4254 }else if( flags&WHERE_BTM_LIMIT ){
4255 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid>?)", zMsg);
4256 }else if( flags&WHERE_TOP_LIMIT ){
4257 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid<?)", zMsg);
4258 }
4259 }
4260#ifndef SQLITE_OMIT_VIRTUALTABLE
4261 else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
4262 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
4263 zMsg = sqlite3MAppendf(db, zMsg, "%s VIRTUAL TABLE INDEX %d:%s", zMsg,
4264 pVtabIdx->idxNum, pVtabIdx->idxStr);
4265 }
4266#endif
dan4a07e3d2010-11-09 14:48:59 +00004267 if( wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX) ){
drh04098e62010-11-15 21:50:19 +00004268 testcase( wctrlFlags & WHERE_ORDERBY_MIN );
dan4a07e3d2010-11-09 14:48:59 +00004269 nRow = 1;
4270 }else{
4271 nRow = (sqlite3_int64)pLevel->plan.nRow;
4272 }
4273 zMsg = sqlite3MAppendf(db, zMsg, "%s (~%lld rows)", zMsg, nRow);
4274 sqlite3VdbeAddOp4(v, OP_Explain, iId, iLevel, iFrom, zMsg, P4_DYNAMIC);
dan2ce22452010-11-08 19:01:16 +00004275 }
4276}
4277#else
dan17c0bc02010-11-09 17:35:19 +00004278# define explainOneScan(u,v,w,x,y,z)
dan2ce22452010-11-08 19:01:16 +00004279#endif /* SQLITE_OMIT_EXPLAIN */
4280
4281
drh111a6a72008-12-21 03:51:16 +00004282/*
4283** Generate code for the start of the iLevel-th loop in the WHERE clause
4284** implementation described by pWInfo.
4285*/
4286static Bitmask codeOneLoopStart(
4287 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
4288 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh336a5302009-04-24 15:46:21 +00004289 u16 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
drh7a484802012-03-16 00:28:11 +00004290 Bitmask notReady /* Which tables are currently available */
drh111a6a72008-12-21 03:51:16 +00004291){
4292 int j, k; /* Loop counters */
4293 int iCur; /* The VDBE cursor for the table */
4294 int addrNxt; /* Where to jump to continue with the next IN case */
4295 int omitTable; /* True if we use the index only */
4296 int bRev; /* True if we need to scan in reverse order */
4297 WhereLevel *pLevel; /* The where level to be coded */
4298 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
4299 WhereTerm *pTerm; /* A WHERE clause term */
4300 Parse *pParse; /* Parsing context */
4301 Vdbe *v; /* The prepared stmt under constructions */
4302 struct SrcList_item *pTabItem; /* FROM clause term being coded */
drh23d04d52008-12-23 23:56:22 +00004303 int addrBrk; /* Jump here to break out of the loop */
4304 int addrCont; /* Jump here to continue with next cycle */
drh61495262009-04-22 15:32:59 +00004305 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
4306 int iReleaseReg = 0; /* Temp register to free before returning */
drh0c41d222013-04-22 02:39:10 +00004307 Bitmask newNotReady; /* Return value */
drh111a6a72008-12-21 03:51:16 +00004308
4309 pParse = pWInfo->pParse;
4310 v = pParse->pVdbe;
4311 pWC = pWInfo->pWC;
4312 pLevel = &pWInfo->a[iLevel];
4313 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
4314 iCur = pTabItem->iCursor;
4315 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
danielk19771d461462009-04-21 09:02:45 +00004316 omitTable = (pLevel->plan.wsFlags & WHERE_IDX_ONLY)!=0
drh336a5302009-04-24 15:46:21 +00004317 && (wctrlFlags & WHERE_FORCE_TABLE)==0;
drh0c41d222013-04-22 02:39:10 +00004318 VdbeNoopComment((v, "Begin Join Loop %d", iLevel));
drh111a6a72008-12-21 03:51:16 +00004319
4320 /* Create labels for the "break" and "continue" instructions
4321 ** for the current loop. Jump to addrBrk to break out of a loop.
4322 ** Jump to cont to go immediately to the next iteration of the
4323 ** loop.
4324 **
4325 ** When there is an IN operator, we also have a "addrNxt" label that
4326 ** means to continue with the next IN value combination. When
4327 ** there are no IN operators in the constraints, the "addrNxt" label
4328 ** is the same as "addrBrk".
4329 */
4330 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
4331 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
4332
4333 /* If this is the right table of a LEFT OUTER JOIN, allocate and
4334 ** initialize a memory cell that records if this table matches any
4335 ** row of the left table of the join.
4336 */
4337 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
4338 pLevel->iLeftJoin = ++pParse->nMem;
4339 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
4340 VdbeComment((v, "init LEFT JOIN no-match flag"));
4341 }
4342
drh21172c42012-10-30 00:29:07 +00004343 /* Special case of a FROM clause subquery implemented as a co-routine */
4344 if( pTabItem->viaCoroutine ){
4345 int regYield = pTabItem->regReturn;
4346 sqlite3VdbeAddOp2(v, OP_Integer, pTabItem->addrFillSub-1, regYield);
4347 pLevel->p2 = sqlite3VdbeAddOp1(v, OP_Yield, regYield);
4348 VdbeComment((v, "next row of co-routine %s", pTabItem->pTab->zName));
4349 sqlite3VdbeAddOp2(v, OP_If, regYield+1, addrBrk);
4350 pLevel->op = OP_Goto;
4351 }else
4352
drh111a6a72008-12-21 03:51:16 +00004353#ifndef SQLITE_OMIT_VIRTUALTABLE
4354 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
4355 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
4356 ** to access the data.
4357 */
4358 int iReg; /* P3 Value for OP_VFilter */
drh281bbe22012-10-16 23:17:14 +00004359 int addrNotFound;
drh111a6a72008-12-21 03:51:16 +00004360 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
4361 int nConstraint = pVtabIdx->nConstraint;
4362 struct sqlite3_index_constraint_usage *aUsage =
4363 pVtabIdx->aConstraintUsage;
4364 const struct sqlite3_index_constraint *aConstraint =
4365 pVtabIdx->aConstraint;
4366
drha62bb8d2009-11-23 21:23:45 +00004367 sqlite3ExprCachePush(pParse);
drh111a6a72008-12-21 03:51:16 +00004368 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
drh281bbe22012-10-16 23:17:14 +00004369 addrNotFound = pLevel->addrBrk;
drh111a6a72008-12-21 03:51:16 +00004370 for(j=1; j<=nConstraint; j++){
4371 for(k=0; k<nConstraint; k++){
4372 if( aUsage[k].argvIndex==j ){
drh281bbe22012-10-16 23:17:14 +00004373 int iTarget = iReg+j+1;
drh928d9c62013-02-07 09:33:56 +00004374 pTerm = &pWC->a[aConstraint[k].iTermOffset];
drh281bbe22012-10-16 23:17:14 +00004375 if( pTerm->eOperator & WO_IN ){
drh0fe456b2013-03-12 18:34:50 +00004376 codeEqualityTerm(pParse, pTerm, pLevel, k, iTarget);
drh281bbe22012-10-16 23:17:14 +00004377 addrNotFound = pLevel->addrNxt;
4378 }else{
4379 sqlite3ExprCode(pParse, pTerm->pExpr->pRight, iTarget);
4380 }
drh111a6a72008-12-21 03:51:16 +00004381 break;
4382 }
4383 }
4384 if( k==nConstraint ) break;
4385 }
drh111a6a72008-12-21 03:51:16 +00004386 sqlite3VdbeAddOp2(v, OP_Integer, pVtabIdx->idxNum, iReg);
4387 sqlite3VdbeAddOp2(v, OP_Integer, j-1, iReg+1);
drh281bbe22012-10-16 23:17:14 +00004388 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg, pVtabIdx->idxStr,
drh111a6a72008-12-21 03:51:16 +00004389 pVtabIdx->needToFreeIdxStr ? P4_MPRINTF : P4_STATIC);
drh111a6a72008-12-21 03:51:16 +00004390 pVtabIdx->needToFreeIdxStr = 0;
4391 for(j=0; j<nConstraint; j++){
4392 if( aUsage[j].omit ){
4393 int iTerm = aConstraint[j].iTermOffset;
4394 disableTerm(pLevel, &pWC->a[iTerm]);
4395 }
4396 }
4397 pLevel->op = OP_VNext;
4398 pLevel->p1 = iCur;
4399 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh23d04d52008-12-23 23:56:22 +00004400 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drha62bb8d2009-11-23 21:23:45 +00004401 sqlite3ExprCachePop(pParse, 1);
drh111a6a72008-12-21 03:51:16 +00004402 }else
4403#endif /* SQLITE_OMIT_VIRTUALTABLE */
4404
4405 if( pLevel->plan.wsFlags & WHERE_ROWID_EQ ){
4406 /* Case 1: We can directly reference a single row using an
4407 ** equality comparison against the ROWID field. Or
4408 ** we reference multiple rows using a "rowid IN (...)"
4409 ** construct.
4410 */
danielk19771d461462009-04-21 09:02:45 +00004411 iReleaseReg = sqlite3GetTempReg(pParse);
drh111a6a72008-12-21 03:51:16 +00004412 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
4413 assert( pTerm!=0 );
4414 assert( pTerm->pExpr!=0 );
drh111a6a72008-12-21 03:51:16 +00004415 assert( omitTable==0 );
drhe9cdcea2010-07-22 22:40:03 +00004416 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh0fe456b2013-03-12 18:34:50 +00004417 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, iReleaseReg);
drh111a6a72008-12-21 03:51:16 +00004418 addrNxt = pLevel->addrNxt;
danielk19771d461462009-04-21 09:02:45 +00004419 sqlite3VdbeAddOp2(v, OP_MustBeInt, iRowidReg, addrNxt);
4420 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, iRowidReg);
drh459f63e2013-03-06 01:55:27 +00004421 sqlite3ExprCacheAffinityChange(pParse, iRowidReg, 1);
drhceea3322009-04-23 13:22:42 +00004422 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
drh111a6a72008-12-21 03:51:16 +00004423 VdbeComment((v, "pk"));
4424 pLevel->op = OP_Noop;
4425 }else if( pLevel->plan.wsFlags & WHERE_ROWID_RANGE ){
4426 /* Case 2: We have an inequality comparison against the ROWID field.
4427 */
4428 int testOp = OP_Noop;
4429 int start;
4430 int memEndValue = 0;
4431 WhereTerm *pStart, *pEnd;
4432
4433 assert( omitTable==0 );
4434 pStart = findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0);
4435 pEnd = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0);
4436 if( bRev ){
4437 pTerm = pStart;
4438 pStart = pEnd;
4439 pEnd = pTerm;
4440 }
4441 if( pStart ){
4442 Expr *pX; /* The expression that defines the start bound */
4443 int r1, rTemp; /* Registers for holding the start boundary */
4444
4445 /* The following constant maps TK_xx codes into corresponding
4446 ** seek opcodes. It depends on a particular ordering of TK_xx
4447 */
4448 const u8 aMoveOp[] = {
4449 /* TK_GT */ OP_SeekGt,
4450 /* TK_LE */ OP_SeekLe,
4451 /* TK_LT */ OP_SeekLt,
4452 /* TK_GE */ OP_SeekGe
4453 };
4454 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
4455 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
4456 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
4457
drhe9cdcea2010-07-22 22:40:03 +00004458 testcase( pStart->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004459 pX = pStart->pExpr;
4460 assert( pX!=0 );
4461 assert( pStart->leftCursor==iCur );
4462 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
4463 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
4464 VdbeComment((v, "pk"));
4465 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
4466 sqlite3ReleaseTempReg(pParse, rTemp);
4467 disableTerm(pLevel, pStart);
4468 }else{
4469 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
4470 }
4471 if( pEnd ){
4472 Expr *pX;
4473 pX = pEnd->pExpr;
4474 assert( pX!=0 );
4475 assert( pEnd->leftCursor==iCur );
drhe9cdcea2010-07-22 22:40:03 +00004476 testcase( pEnd->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004477 memEndValue = ++pParse->nMem;
4478 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
4479 if( pX->op==TK_LT || pX->op==TK_GT ){
4480 testOp = bRev ? OP_Le : OP_Ge;
4481 }else{
4482 testOp = bRev ? OP_Lt : OP_Gt;
4483 }
4484 disableTerm(pLevel, pEnd);
4485 }
4486 start = sqlite3VdbeCurrentAddr(v);
4487 pLevel->op = bRev ? OP_Prev : OP_Next;
4488 pLevel->p1 = iCur;
4489 pLevel->p2 = start;
drhafc266a2010-03-31 17:47:44 +00004490 if( pStart==0 && pEnd==0 ){
4491 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4492 }else{
4493 assert( pLevel->p5==0 );
4494 }
danielk19771d461462009-04-21 09:02:45 +00004495 if( testOp!=OP_Noop ){
4496 iRowidReg = iReleaseReg = sqlite3GetTempReg(pParse);
4497 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00004498 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00004499 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
4500 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00004501 }
4502 }else if( pLevel->plan.wsFlags & (WHERE_COLUMN_RANGE|WHERE_COLUMN_EQ) ){
4503 /* Case 3: A scan using an index.
4504 **
4505 ** The WHERE clause may contain zero or more equality
4506 ** terms ("==" or "IN" operators) that refer to the N
4507 ** left-most columns of the index. It may also contain
4508 ** inequality constraints (>, <, >= or <=) on the indexed
4509 ** column that immediately follows the N equalities. Only
4510 ** the right-most column can be an inequality - the rest must
4511 ** use the "==" and "IN" operators. For example, if the
4512 ** index is on (x,y,z), then the following clauses are all
4513 ** optimized:
4514 **
4515 ** x=5
4516 ** x=5 AND y=10
4517 ** x=5 AND y<10
4518 ** x=5 AND y>5 AND y<10
4519 ** x=5 AND y=5 AND z<=10
4520 **
4521 ** The z<10 term of the following cannot be used, only
4522 ** the x=5 term:
4523 **
4524 ** x=5 AND z<10
4525 **
4526 ** N may be zero if there are inequality constraints.
4527 ** If there are no inequality constraints, then N is at
4528 ** least one.
4529 **
4530 ** This case is also used when there are no WHERE clause
4531 ** constraints but an index is selected anyway, in order
4532 ** to force the output order to conform to an ORDER BY.
4533 */
drh3bb9b932010-08-06 02:10:00 +00004534 static const u8 aStartOp[] = {
drh111a6a72008-12-21 03:51:16 +00004535 0,
4536 0,
4537 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
4538 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
4539 OP_SeekGt, /* 4: (start_constraints && !startEq && !bRev) */
4540 OP_SeekLt, /* 5: (start_constraints && !startEq && bRev) */
4541 OP_SeekGe, /* 6: (start_constraints && startEq && !bRev) */
4542 OP_SeekLe /* 7: (start_constraints && startEq && bRev) */
4543 };
drh3bb9b932010-08-06 02:10:00 +00004544 static const u8 aEndOp[] = {
drh111a6a72008-12-21 03:51:16 +00004545 OP_Noop, /* 0: (!end_constraints) */
4546 OP_IdxGE, /* 1: (end_constraints && !bRev) */
4547 OP_IdxLT /* 2: (end_constraints && bRev) */
4548 };
drh3bb9b932010-08-06 02:10:00 +00004549 int nEq = pLevel->plan.nEq; /* Number of == or IN terms */
drh111a6a72008-12-21 03:51:16 +00004550 int isMinQuery = 0; /* If this is an optimized SELECT min(x).. */
4551 int regBase; /* Base register holding constraint values */
4552 int r1; /* Temp register */
4553 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
4554 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
4555 int startEq; /* True if range start uses ==, >= or <= */
4556 int endEq; /* True if range end uses ==, >= or <= */
4557 int start_constraints; /* Start of range is constrained */
4558 int nConstraint; /* Number of constraint terms */
drh3bb9b932010-08-06 02:10:00 +00004559 Index *pIdx; /* The index we will be using */
4560 int iIdxCur; /* The VDBE cursor for the index */
4561 int nExtraReg = 0; /* Number of extra registers needed */
4562 int op; /* Instruction opcode */
dan6ac43392010-06-09 15:47:11 +00004563 char *zStartAff; /* Affinity for start of range constraint */
4564 char *zEndAff; /* Affinity for end of range constraint */
drh111a6a72008-12-21 03:51:16 +00004565
4566 pIdx = pLevel->plan.u.pIdx;
4567 iIdxCur = pLevel->iIdxCur;
dan0c733f62011-11-16 15:27:09 +00004568 k = (nEq==pIdx->nColumn ? -1 : pIdx->aiColumn[nEq]);
drh111a6a72008-12-21 03:51:16 +00004569
drh111a6a72008-12-21 03:51:16 +00004570 /* If this loop satisfies a sort order (pOrderBy) request that
4571 ** was passed to this function to implement a "SELECT min(x) ..."
4572 ** query, then the caller will only allow the loop to run for
4573 ** a single iteration. This means that the first row returned
4574 ** should not have a NULL value stored in 'x'. If column 'x' is
4575 ** the first one after the nEq equality constraints in the index,
4576 ** this requires some special handling.
4577 */
4578 if( (wctrlFlags&WHERE_ORDERBY_MIN)!=0
drhd663b5b2012-10-03 00:25:54 +00004579 && (pLevel->plan.wsFlags&WHERE_ORDERED)
drh111a6a72008-12-21 03:51:16 +00004580 && (pIdx->nColumn>nEq)
4581 ){
4582 /* assert( pOrderBy->nExpr==1 ); */
4583 /* assert( pOrderBy->a[0].pExpr->iColumn==pIdx->aiColumn[nEq] ); */
4584 isMinQuery = 1;
drh6df2acd2008-12-28 16:55:25 +00004585 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004586 }
4587
4588 /* Find any inequality constraint terms for the start and end
4589 ** of the range.
4590 */
4591 if( pLevel->plan.wsFlags & WHERE_TOP_LIMIT ){
4592 pRangeEnd = findTerm(pWC, iCur, k, notReady, (WO_LT|WO_LE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00004593 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004594 }
4595 if( pLevel->plan.wsFlags & WHERE_BTM_LIMIT ){
4596 pRangeStart = findTerm(pWC, iCur, k, notReady, (WO_GT|WO_GE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00004597 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004598 }
4599
drh6df2acd2008-12-28 16:55:25 +00004600 /* Generate code to evaluate all constraint terms using == or IN
4601 ** and store the values of those terms in an array of registers
4602 ** starting at regBase.
4603 */
dan69f8bb92009-08-13 19:21:16 +00004604 regBase = codeAllEqualityTerms(
dan6ac43392010-06-09 15:47:11 +00004605 pParse, pLevel, pWC, notReady, nExtraReg, &zStartAff
dan69f8bb92009-08-13 19:21:16 +00004606 );
dan6ac43392010-06-09 15:47:11 +00004607 zEndAff = sqlite3DbStrDup(pParse->db, zStartAff);
drh6df2acd2008-12-28 16:55:25 +00004608 addrNxt = pLevel->addrNxt;
4609
drh111a6a72008-12-21 03:51:16 +00004610 /* If we are doing a reverse order scan on an ascending index, or
4611 ** a forward order scan on a descending index, interchange the
4612 ** start and end terms (pRangeStart and pRangeEnd).
4613 */
dan0c733f62011-11-16 15:27:09 +00004614 if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
4615 || (bRev && pIdx->nColumn==nEq)
4616 ){
drh111a6a72008-12-21 03:51:16 +00004617 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
4618 }
4619
4620 testcase( pRangeStart && pRangeStart->eOperator & WO_LE );
4621 testcase( pRangeStart && pRangeStart->eOperator & WO_GE );
4622 testcase( pRangeEnd && pRangeEnd->eOperator & WO_LE );
4623 testcase( pRangeEnd && pRangeEnd->eOperator & WO_GE );
4624 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
4625 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
4626 start_constraints = pRangeStart || nEq>0;
4627
4628 /* Seek the index cursor to the start of the range. */
4629 nConstraint = nEq;
4630 if( pRangeStart ){
dan69f8bb92009-08-13 19:21:16 +00004631 Expr *pRight = pRangeStart->pExpr->pRight;
4632 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh534230c2011-01-22 00:10:45 +00004633 if( (pRangeStart->wtFlags & TERM_VNULL)==0 ){
4634 sqlite3ExprCodeIsNullJump(v, pRight, regBase+nEq, addrNxt);
4635 }
dan6ac43392010-06-09 15:47:11 +00004636 if( zStartAff ){
4637 if( sqlite3CompareAffinity(pRight, zStartAff[nEq])==SQLITE_AFF_NONE){
drh039fc322009-11-17 18:31:47 +00004638 /* Since the comparison is to be performed with no conversions
4639 ** applied to the operands, set the affinity to apply to pRight to
4640 ** SQLITE_AFF_NONE. */
dan6ac43392010-06-09 15:47:11 +00004641 zStartAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004642 }
dan6ac43392010-06-09 15:47:11 +00004643 if( sqlite3ExprNeedsNoAffinityChange(pRight, zStartAff[nEq]) ){
4644 zStartAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004645 }
4646 }
drh111a6a72008-12-21 03:51:16 +00004647 nConstraint++;
drhe9cdcea2010-07-22 22:40:03 +00004648 testcase( pRangeStart->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004649 }else if( isMinQuery ){
4650 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
4651 nConstraint++;
4652 startEq = 0;
4653 start_constraints = 1;
4654 }
dan6ac43392010-06-09 15:47:11 +00004655 codeApplyAffinity(pParse, regBase, nConstraint, zStartAff);
drh111a6a72008-12-21 03:51:16 +00004656 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
4657 assert( op!=0 );
4658 testcase( op==OP_Rewind );
4659 testcase( op==OP_Last );
4660 testcase( op==OP_SeekGt );
4661 testcase( op==OP_SeekGe );
4662 testcase( op==OP_SeekLe );
4663 testcase( op==OP_SeekLt );
drh8cff69d2009-11-12 19:59:44 +00004664 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh111a6a72008-12-21 03:51:16 +00004665
4666 /* Load the value for the inequality constraint at the end of the
4667 ** range (if any).
4668 */
4669 nConstraint = nEq;
4670 if( pRangeEnd ){
dan69f8bb92009-08-13 19:21:16 +00004671 Expr *pRight = pRangeEnd->pExpr->pRight;
drhf49f3522009-12-30 14:12:38 +00004672 sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
dan69f8bb92009-08-13 19:21:16 +00004673 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh534230c2011-01-22 00:10:45 +00004674 if( (pRangeEnd->wtFlags & TERM_VNULL)==0 ){
4675 sqlite3ExprCodeIsNullJump(v, pRight, regBase+nEq, addrNxt);
4676 }
dan6ac43392010-06-09 15:47:11 +00004677 if( zEndAff ){
4678 if( sqlite3CompareAffinity(pRight, zEndAff[nEq])==SQLITE_AFF_NONE){
drh039fc322009-11-17 18:31:47 +00004679 /* Since the comparison is to be performed with no conversions
4680 ** applied to the operands, set the affinity to apply to pRight to
4681 ** SQLITE_AFF_NONE. */
dan6ac43392010-06-09 15:47:11 +00004682 zEndAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004683 }
dan6ac43392010-06-09 15:47:11 +00004684 if( sqlite3ExprNeedsNoAffinityChange(pRight, zEndAff[nEq]) ){
4685 zEndAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004686 }
4687 }
dan6ac43392010-06-09 15:47:11 +00004688 codeApplyAffinity(pParse, regBase, nEq+1, zEndAff);
drh111a6a72008-12-21 03:51:16 +00004689 nConstraint++;
drhe9cdcea2010-07-22 22:40:03 +00004690 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004691 }
dan6ac43392010-06-09 15:47:11 +00004692 sqlite3DbFree(pParse->db, zStartAff);
4693 sqlite3DbFree(pParse->db, zEndAff);
drh111a6a72008-12-21 03:51:16 +00004694
4695 /* Top of the loop body */
4696 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
4697
4698 /* Check if the index cursor is past the end of the range. */
4699 op = aEndOp[(pRangeEnd || nEq) * (1 + bRev)];
4700 testcase( op==OP_Noop );
4701 testcase( op==OP_IdxGE );
4702 testcase( op==OP_IdxLT );
drh6df2acd2008-12-28 16:55:25 +00004703 if( op!=OP_Noop ){
drh8cff69d2009-11-12 19:59:44 +00004704 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh6df2acd2008-12-28 16:55:25 +00004705 sqlite3VdbeChangeP5(v, endEq!=bRev ?1:0);
4706 }
drh111a6a72008-12-21 03:51:16 +00004707
4708 /* If there are inequality constraints, check that the value
4709 ** of the table column that the inequality contrains is not NULL.
4710 ** If it is, jump to the next iteration of the loop.
4711 */
4712 r1 = sqlite3GetTempReg(pParse);
4713 testcase( pLevel->plan.wsFlags & WHERE_BTM_LIMIT );
4714 testcase( pLevel->plan.wsFlags & WHERE_TOP_LIMIT );
drh04098e62010-11-15 21:50:19 +00004715 if( (pLevel->plan.wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0 ){
drh111a6a72008-12-21 03:51:16 +00004716 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, nEq, r1);
4717 sqlite3VdbeAddOp2(v, OP_IsNull, r1, addrCont);
4718 }
danielk19771d461462009-04-21 09:02:45 +00004719 sqlite3ReleaseTempReg(pParse, r1);
drh111a6a72008-12-21 03:51:16 +00004720
4721 /* Seek the table cursor, if required */
drh23d04d52008-12-23 23:56:22 +00004722 disableTerm(pLevel, pRangeStart);
4723 disableTerm(pLevel, pRangeEnd);
danielk19771d461462009-04-21 09:02:45 +00004724 if( !omitTable ){
4725 iRowidReg = iReleaseReg = sqlite3GetTempReg(pParse);
4726 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00004727 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00004728 sqlite3VdbeAddOp2(v, OP_Seek, iCur, iRowidReg); /* Deferred seek */
drh111a6a72008-12-21 03:51:16 +00004729 }
drh111a6a72008-12-21 03:51:16 +00004730
4731 /* Record the instruction used to terminate the loop. Disable
4732 ** WHERE clause terms made redundant by the index range scan.
4733 */
drh95e037b2011-03-09 21:02:31 +00004734 if( pLevel->plan.wsFlags & WHERE_UNIQUE ){
4735 pLevel->op = OP_Noop;
4736 }else if( bRev ){
4737 pLevel->op = OP_Prev;
4738 }else{
4739 pLevel->op = OP_Next;
4740 }
drh111a6a72008-12-21 03:51:16 +00004741 pLevel->p1 = iIdxCur;
drh3f4d1d12012-09-15 18:45:54 +00004742 if( pLevel->plan.wsFlags & WHERE_COVER_SCAN ){
4743 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4744 }else{
4745 assert( pLevel->p5==0 );
4746 }
drhdd5f5a62008-12-23 13:35:23 +00004747 }else
4748
drh23d04d52008-12-23 23:56:22 +00004749#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00004750 if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drh111a6a72008-12-21 03:51:16 +00004751 /* Case 4: Two or more separately indexed terms connected by OR
4752 **
4753 ** Example:
4754 **
4755 ** CREATE TABLE t1(a,b,c,d);
4756 ** CREATE INDEX i1 ON t1(a);
4757 ** CREATE INDEX i2 ON t1(b);
4758 ** CREATE INDEX i3 ON t1(c);
4759 **
4760 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
4761 **
4762 ** In the example, there are three indexed terms connected by OR.
danielk19771d461462009-04-21 09:02:45 +00004763 ** The top of the loop looks like this:
drh111a6a72008-12-21 03:51:16 +00004764 **
drh1b26c7c2009-04-22 02:15:47 +00004765 ** Null 1 # Zero the rowset in reg 1
drh111a6a72008-12-21 03:51:16 +00004766 **
danielk19771d461462009-04-21 09:02:45 +00004767 ** Then, for each indexed term, the following. The arguments to
drh1b26c7c2009-04-22 02:15:47 +00004768 ** RowSetTest are such that the rowid of the current row is inserted
4769 ** into the RowSet. If it is already present, control skips the
danielk19771d461462009-04-21 09:02:45 +00004770 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
drh111a6a72008-12-21 03:51:16 +00004771 **
danielk19771d461462009-04-21 09:02:45 +00004772 ** sqlite3WhereBegin(<term>)
drh1b26c7c2009-04-22 02:15:47 +00004773 ** RowSetTest # Insert rowid into rowset
danielk19771d461462009-04-21 09:02:45 +00004774 ** Gosub 2 A
4775 ** sqlite3WhereEnd()
4776 **
4777 ** Following the above, code to terminate the loop. Label A, the target
4778 ** of the Gosub above, jumps to the instruction right after the Goto.
4779 **
drh1b26c7c2009-04-22 02:15:47 +00004780 ** Null 1 # Zero the rowset in reg 1
danielk19771d461462009-04-21 09:02:45 +00004781 ** Goto B # The loop is finished.
4782 **
4783 ** A: <loop body> # Return data, whatever.
4784 **
4785 ** Return 2 # Jump back to the Gosub
4786 **
4787 ** B: <after the loop>
4788 **
drh111a6a72008-12-21 03:51:16 +00004789 */
drh111a6a72008-12-21 03:51:16 +00004790 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
drhc01a3c12009-12-16 22:10:49 +00004791 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
dan0efb72c2012-08-24 18:44:56 +00004792 Index *pCov = 0; /* Potential covering index (or NULL) */
4793 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
danielk19771d461462009-04-21 09:02:45 +00004794
4795 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
shane85095702009-06-15 16:27:08 +00004796 int regRowset = 0; /* Register for RowSet object */
4797 int regRowid = 0; /* Register holding rowid */
danielk19771d461462009-04-21 09:02:45 +00004798 int iLoopBody = sqlite3VdbeMakeLabel(v); /* Start of loop body */
4799 int iRetInit; /* Address of regReturn init */
drhc01a3c12009-12-16 22:10:49 +00004800 int untestedTerms = 0; /* Some terms not completely tested */
drh8871ef52011-10-07 13:33:10 +00004801 int ii; /* Loop counter */
4802 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
drh111a6a72008-12-21 03:51:16 +00004803
4804 pTerm = pLevel->plan.u.pTerm;
4805 assert( pTerm!=0 );
drh7a5bcc02013-01-16 17:08:58 +00004806 assert( pTerm->eOperator & WO_OR );
drh111a6a72008-12-21 03:51:16 +00004807 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
4808 pOrWc = &pTerm->u.pOrInfo->wc;
drhc01a3c12009-12-16 22:10:49 +00004809 pLevel->op = OP_Return;
4810 pLevel->p1 = regReturn;
drh23d04d52008-12-23 23:56:22 +00004811
danbfca6a42012-08-24 10:52:35 +00004812 /* Set up a new SrcList in pOrTab containing the table being scanned
drhc01a3c12009-12-16 22:10:49 +00004813 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
4814 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
4815 */
4816 if( pWInfo->nLevel>1 ){
4817 int nNotReady; /* The number of notReady tables */
4818 struct SrcList_item *origSrc; /* Original list of tables */
4819 nNotReady = pWInfo->nLevel - iLevel - 1;
4820 pOrTab = sqlite3StackAllocRaw(pParse->db,
4821 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
4822 if( pOrTab==0 ) return notReady;
shaneh46aae3c2009-12-31 19:06:23 +00004823 pOrTab->nAlloc = (i16)(nNotReady + 1);
4824 pOrTab->nSrc = pOrTab->nAlloc;
drhc01a3c12009-12-16 22:10:49 +00004825 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
4826 origSrc = pWInfo->pTabList->a;
4827 for(k=1; k<=nNotReady; k++){
4828 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
4829 }
4830 }else{
4831 pOrTab = pWInfo->pTabList;
4832 }
danielk19771d461462009-04-21 09:02:45 +00004833
drh1b26c7c2009-04-22 02:15:47 +00004834 /* Initialize the rowset register to contain NULL. An SQL NULL is
4835 ** equivalent to an empty rowset.
danielk19771d461462009-04-21 09:02:45 +00004836 **
4837 ** Also initialize regReturn to contain the address of the instruction
4838 ** immediately following the OP_Return at the bottom of the loop. This
4839 ** is required in a few obscure LEFT JOIN cases where control jumps
4840 ** over the top of the loop into the body of it. In this case the
4841 ** correct response for the end-of-loop code (the OP_Return) is to
4842 ** fall through to the next instruction, just as an OP_Next does if
4843 ** called on an uninitialized cursor.
4844 */
drh336a5302009-04-24 15:46:21 +00004845 if( (wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
4846 regRowset = ++pParse->nMem;
4847 regRowid = ++pParse->nMem;
4848 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
4849 }
danielk19771d461462009-04-21 09:02:45 +00004850 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
4851
drh8871ef52011-10-07 13:33:10 +00004852 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
4853 ** Then for every term xN, evaluate as the subexpression: xN AND z
4854 ** That way, terms in y that are factored into the disjunction will
4855 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
drh331b67c2012-03-09 22:02:08 +00004856 **
4857 ** Actually, each subexpression is converted to "xN AND w" where w is
4858 ** the "interesting" terms of z - terms that did not originate in the
4859 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
4860 ** indices.
drh8871ef52011-10-07 13:33:10 +00004861 */
4862 if( pWC->nTerm>1 ){
drh7a484802012-03-16 00:28:11 +00004863 int iTerm;
4864 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
4865 Expr *pExpr = pWC->a[iTerm].pExpr;
drh331b67c2012-03-09 22:02:08 +00004866 if( ExprHasProperty(pExpr, EP_FromJoin) ) continue;
drh7a484802012-03-16 00:28:11 +00004867 if( pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_ORINFO) ) continue;
4868 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drh331b67c2012-03-09 22:02:08 +00004869 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4870 pAndExpr = sqlite3ExprAnd(pParse->db, pAndExpr, pExpr);
4871 }
4872 if( pAndExpr ){
4873 pAndExpr = sqlite3PExpr(pParse, TK_AND, 0, pAndExpr, 0);
4874 }
drh8871ef52011-10-07 13:33:10 +00004875 }
4876
danielk19771d461462009-04-21 09:02:45 +00004877 for(ii=0; ii<pOrWc->nTerm; ii++){
4878 WhereTerm *pOrTerm = &pOrWc->a[ii];
drh7a5bcc02013-01-16 17:08:58 +00004879 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
danielk19771d461462009-04-21 09:02:45 +00004880 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
drh8871ef52011-10-07 13:33:10 +00004881 Expr *pOrExpr = pOrTerm->pExpr;
4882 if( pAndExpr ){
4883 pAndExpr->pLeft = pOrExpr;
4884 pOrExpr = pAndExpr;
4885 }
danielk19771d461462009-04-21 09:02:45 +00004886 /* Loop through table entries that match term pOrTerm. */
drh8871ef52011-10-07 13:33:10 +00004887 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
drh9ef61f42011-10-07 14:40:59 +00004888 WHERE_OMIT_OPEN_CLOSE | WHERE_AND_ONLY |
dan0efb72c2012-08-24 18:44:56 +00004889 WHERE_FORCE_TABLE | WHERE_ONETABLE_ONLY, iCovCur);
danbfca6a42012-08-24 10:52:35 +00004890 assert( pSubWInfo || pParse->nErr || pParse->db->mallocFailed );
danielk19771d461462009-04-21 09:02:45 +00004891 if( pSubWInfo ){
danbfca6a42012-08-24 10:52:35 +00004892 WhereLevel *pLvl;
dan17c0bc02010-11-09 17:35:19 +00004893 explainOneScan(
dan4a07e3d2010-11-09 14:48:59 +00004894 pParse, pOrTab, &pSubWInfo->a[0], iLevel, pLevel->iFrom, 0
dan2ce22452010-11-08 19:01:16 +00004895 );
drh336a5302009-04-24 15:46:21 +00004896 if( (wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
4897 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
4898 int r;
4899 r = sqlite3ExprCodeGetColumn(pParse, pTabItem->pTab, -1, iCur,
drha748fdc2012-03-28 01:34:47 +00004900 regRowid, 0);
drh8cff69d2009-11-12 19:59:44 +00004901 sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset,
4902 sqlite3VdbeCurrentAddr(v)+2, r, iSet);
drh336a5302009-04-24 15:46:21 +00004903 }
danielk19771d461462009-04-21 09:02:45 +00004904 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
4905
drhc01a3c12009-12-16 22:10:49 +00004906 /* The pSubWInfo->untestedTerms flag means that this OR term
4907 ** contained one or more AND term from a notReady table. The
4908 ** terms from the notReady table could not be tested and will
4909 ** need to be tested later.
4910 */
4911 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
4912
danbfca6a42012-08-24 10:52:35 +00004913 /* If all of the OR-connected terms are optimized using the same
4914 ** index, and the index is opened using the same cursor number
4915 ** by each call to sqlite3WhereBegin() made by this loop, it may
4916 ** be possible to use that index as a covering index.
4917 **
4918 ** If the call to sqlite3WhereBegin() above resulted in a scan that
4919 ** uses an index, and this is either the first OR-connected term
4920 ** processed or the index is the same as that used by all previous
dan0efb72c2012-08-24 18:44:56 +00004921 ** terms, set pCov to the candidate covering index. Otherwise, set
4922 ** pCov to NULL to indicate that no candidate covering index will
4923 ** be available.
danbfca6a42012-08-24 10:52:35 +00004924 */
4925 pLvl = &pSubWInfo->a[0];
4926 if( (pLvl->plan.wsFlags & WHERE_INDEXED)!=0
4927 && (pLvl->plan.wsFlags & WHERE_TEMP_INDEX)==0
dan0efb72c2012-08-24 18:44:56 +00004928 && (ii==0 || pLvl->plan.u.pIdx==pCov)
danbfca6a42012-08-24 10:52:35 +00004929 ){
dan0efb72c2012-08-24 18:44:56 +00004930 assert( pLvl->iIdxCur==iCovCur );
danbfca6a42012-08-24 10:52:35 +00004931 pCov = pLvl->plan.u.pIdx;
danbfca6a42012-08-24 10:52:35 +00004932 }else{
4933 pCov = 0;
4934 }
4935
danielk19771d461462009-04-21 09:02:45 +00004936 /* Finish the loop through table entries that match term pOrTerm. */
4937 sqlite3WhereEnd(pSubWInfo);
4938 }
drhdd5f5a62008-12-23 13:35:23 +00004939 }
4940 }
drhd40e2082012-08-24 23:24:15 +00004941 pLevel->u.pCovidx = pCov;
drh90abfd02012-10-09 21:07:23 +00004942 if( pCov ) pLevel->iIdxCur = iCovCur;
drh331b67c2012-03-09 22:02:08 +00004943 if( pAndExpr ){
4944 pAndExpr->pLeft = 0;
4945 sqlite3ExprDelete(pParse->db, pAndExpr);
4946 }
danielk19771d461462009-04-21 09:02:45 +00004947 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
danielk19771d461462009-04-21 09:02:45 +00004948 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrBrk);
4949 sqlite3VdbeResolveLabel(v, iLoopBody);
4950
drhc01a3c12009-12-16 22:10:49 +00004951 if( pWInfo->nLevel>1 ) sqlite3StackFree(pParse->db, pOrTab);
4952 if( !untestedTerms ) disableTerm(pLevel, pTerm);
drhdd5f5a62008-12-23 13:35:23 +00004953 }else
drh23d04d52008-12-23 23:56:22 +00004954#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00004955
4956 {
drh111a6a72008-12-21 03:51:16 +00004957 /* Case 5: There is no usable index. We must do a complete
4958 ** scan of the entire table.
4959 */
drh699b3d42009-02-23 16:52:07 +00004960 static const u8 aStep[] = { OP_Next, OP_Prev };
4961 static const u8 aStart[] = { OP_Rewind, OP_Last };
4962 assert( bRev==0 || bRev==1 );
drh111a6a72008-12-21 03:51:16 +00004963 assert( omitTable==0 );
drh699b3d42009-02-23 16:52:07 +00004964 pLevel->op = aStep[bRev];
drh111a6a72008-12-21 03:51:16 +00004965 pLevel->p1 = iCur;
drh699b3d42009-02-23 16:52:07 +00004966 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrBrk);
drh111a6a72008-12-21 03:51:16 +00004967 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4968 }
drh0c41d222013-04-22 02:39:10 +00004969 newNotReady = notReady & ~getMask(pWC->pMaskSet, iCur);
drh111a6a72008-12-21 03:51:16 +00004970
4971 /* Insert code to test every subexpression that can be completely
4972 ** computed using the current set of tables.
drhe9cdcea2010-07-22 22:40:03 +00004973 **
4974 ** IMPLEMENTATION-OF: R-49525-50935 Terms that cannot be satisfied through
4975 ** the use of indices become tests that are evaluated against each row of
4976 ** the relevant input tables.
drh111a6a72008-12-21 03:51:16 +00004977 */
drh111a6a72008-12-21 03:51:16 +00004978 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
4979 Expr *pE;
drhe9cdcea2010-07-22 22:40:03 +00004980 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* IMP: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004981 testcase( pTerm->wtFlags & TERM_CODED );
4982 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drh0c41d222013-04-22 02:39:10 +00004983 if( (pTerm->prereqAll & newNotReady)!=0 ){
drhc01a3c12009-12-16 22:10:49 +00004984 testcase( pWInfo->untestedTerms==0
4985 && (pWInfo->wctrlFlags & WHERE_ONETABLE_ONLY)!=0 );
4986 pWInfo->untestedTerms = 1;
4987 continue;
4988 }
drh111a6a72008-12-21 03:51:16 +00004989 pE = pTerm->pExpr;
4990 assert( pE!=0 );
4991 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
4992 continue;
4993 }
drh111a6a72008-12-21 03:51:16 +00004994 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00004995 pTerm->wtFlags |= TERM_CODED;
4996 }
4997
drh0c41d222013-04-22 02:39:10 +00004998 /* Insert code to test for implied constraints based on transitivity
4999 ** of the "==" operator.
5000 **
5001 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
5002 ** and we are coding the t1 loop and the t2 loop has not yet coded,
5003 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
5004 ** the implied "t1.a=123" constraint.
5005 */
5006 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
5007 Expr *pE;
5008 WhereTerm *pAlt;
5009 Expr sEq;
5010 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
5011 if( pTerm->eOperator!=(WO_EQUIV|WO_EQ) ) continue;
5012 if( pTerm->leftCursor!=iCur ) continue;
5013 pE = pTerm->pExpr;
5014 assert( !ExprHasProperty(pE, EP_FromJoin) );
5015 assert( (pTerm->prereqRight & newNotReady)!=0 );
5016 pAlt = findTerm(pWC, iCur, pTerm->u.leftColumn, notReady, WO_EQ|WO_IN, 0);
5017 if( pAlt==0 ) continue;
drh5c10f3b2013-05-01 17:22:38 +00005018 if( pAlt->wtFlags & (TERM_CODED) ) continue;
drh0c41d222013-04-22 02:39:10 +00005019 VdbeNoopComment((v, "begin transitive constraint"));
5020 sEq = *pAlt->pExpr;
5021 sEq.pLeft = pE->pLeft;
5022 sqlite3ExprIfFalse(pParse, &sEq, addrCont, SQLITE_JUMPIFNULL);
5023 }
5024
drh111a6a72008-12-21 03:51:16 +00005025 /* For a LEFT OUTER JOIN, generate code that will record the fact that
5026 ** at least one row of the right table has matched the left table.
5027 */
5028 if( pLevel->iLeftJoin ){
5029 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
5030 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
5031 VdbeComment((v, "record LEFT JOIN hit"));
drhceea3322009-04-23 13:22:42 +00005032 sqlite3ExprCacheClear(pParse);
drh111a6a72008-12-21 03:51:16 +00005033 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
drhe9cdcea2010-07-22 22:40:03 +00005034 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* IMP: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00005035 testcase( pTerm->wtFlags & TERM_CODED );
5036 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drh0c41d222013-04-22 02:39:10 +00005037 if( (pTerm->prereqAll & newNotReady)!=0 ){
drhb057e562009-12-16 23:43:55 +00005038 assert( pWInfo->untestedTerms );
drhc01a3c12009-12-16 22:10:49 +00005039 continue;
5040 }
drh111a6a72008-12-21 03:51:16 +00005041 assert( pTerm->pExpr );
5042 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
5043 pTerm->wtFlags |= TERM_CODED;
5044 }
5045 }
danielk19771d461462009-04-21 09:02:45 +00005046 sqlite3ReleaseTempReg(pParse, iReleaseReg);
drh23d04d52008-12-23 23:56:22 +00005047
drh0c41d222013-04-22 02:39:10 +00005048 return newNotReady;
drh111a6a72008-12-21 03:51:16 +00005049}
5050
drh549c8b62005-09-19 13:15:23 +00005051#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00005052/*
5053** The following variable holds a text description of query plan generated
5054** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
5055** overwrites the previous. This information is used for testing and
5056** analysis only.
5057*/
5058char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
5059static int nQPlan = 0; /* Next free slow in _query_plan[] */
5060
5061#endif /* SQLITE_TEST */
5062
drha18f3d22013-05-08 03:05:41 +00005063#if defined(SQLITE_DEBUG) \
5064 && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE))
5065/*
5066** Print a WhereLoop object for debugging purposes
5067*/
5068static void whereLoopPrint(WhereLoop *p, SrcList *pTabList){
5069 int nb = 2*((pTabList->nSrc+15)/16);
5070 struct SrcList_item *pItem = pTabList->a + p->iTab;
5071 Table *pTab = pItem->pTab;
drha184fb82013-05-08 04:22:59 +00005072 sqlite3DebugPrintf("%2d.%0*llx.%0*llx",
5073 p->iTab, nb, p->maskSelf, nb, p->prereq);
5074 sqlite3DebugPrintf(" %8s",
drha18f3d22013-05-08 03:05:41 +00005075 pItem->zAlias ? pItem->zAlias : pTab->zName);
drh5346e952013-05-08 14:14:26 +00005076 if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
5077 if( p->u.btree.pIndex ){
5078 sqlite3DebugPrintf(".%-12s %2d",
5079 p->u.btree.pIndex->zName, p->u.btree.nEq);
5080 }else{
5081 sqlite3DebugPrintf("%16s","");
5082 }
drha18f3d22013-05-08 03:05:41 +00005083 }else{
drh5346e952013-05-08 14:14:26 +00005084 char *z;
5085 if( p->u.vtab.idxStr ){
5086 z = sqlite3_mprintf("(%d,\"%s\")", p->u.vtab.idxNum,p->u.vtab.idxStr);
5087 }else{
5088 z = sqlite3_mprintf("(%d)", p->u.vtab.idxNum);
5089 }
5090 sqlite3DebugPrintf(" %-15s", z);
5091 sqlite3_free(z);
drha18f3d22013-05-08 03:05:41 +00005092 }
5093 sqlite3DebugPrintf(" fg %08x OB %d,%d N %2d",
5094 p->wsFlags, p->iOb, p->nOb, p->nTerm);
5095 sqlite3DebugPrintf(" cost %.4g,%.4g,%.4g\n",
5096 p->prereq, p->rSetup, p->rRun, p->nOut);
5097}
5098#endif
5099
drhf1b5f5b2013-05-02 00:15:01 +00005100/*
drh5346e952013-05-08 14:14:26 +00005101** Deallocate internal memory used by a WhereLoop object
5102*/
5103static void whereLoopClear(sqlite3 *db, WhereLoop *p){
5104 sqlite3DbFree(db, p->aTerm);
5105 p->aTerm = 0;
5106 p->nTerm = 0;
5107 if( (p->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
5108 if( p->u.vtab.needFree ) sqlite3_free(p->u.vtab.idxStr);
5109 p->u.vtab.needFree = 0;
5110 p->u.vtab.idxStr = 0;
5111 }
5112}
5113
5114/*
drhf1b5f5b2013-05-02 00:15:01 +00005115** Delete a WhereLoop object
5116*/
5117static void whereLoopDelete(sqlite3 *db, WhereLoop *p){
drh5346e952013-05-08 14:14:26 +00005118 whereLoopClear(db, p);
drhf1b5f5b2013-05-02 00:15:01 +00005119 sqlite3DbFree(db, p);
5120}
drh84bfda42005-07-15 13:05:21 +00005121
drh9eff6162006-06-12 21:59:13 +00005122/*
5123** Free a WhereInfo structure
5124*/
drh10fe8402008-10-11 16:47:35 +00005125static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh52ff8ea2010-04-08 14:15:56 +00005126 if( ALWAYS(pWInfo) ){
drh9eff6162006-06-12 21:59:13 +00005127 int i;
5128 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00005129 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
5130 if( pInfo ){
danielk19771d461462009-04-21 09:02:45 +00005131 /* assert( pInfo->needToFreeIdxStr==0 || db->mallocFailed ); */
danielk197780442942008-12-24 11:25:39 +00005132 if( pInfo->needToFreeIdxStr ){
5133 sqlite3_free(pInfo->idxStr);
danielk1977be229652009-03-20 14:18:51 +00005134 }
drh633e6d52008-07-28 19:34:53 +00005135 sqlite3DbFree(db, pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00005136 }
drh8b307fb2010-04-06 15:57:05 +00005137 if( pWInfo->a[i].plan.wsFlags & WHERE_TEMP_INDEX ){
drha21a64d2010-04-06 22:33:55 +00005138 Index *pIdx = pWInfo->a[i].plan.u.pIdx;
5139 if( pIdx ){
5140 sqlite3DbFree(db, pIdx->zColAff);
5141 sqlite3DbFree(db, pIdx);
5142 }
drh8b307fb2010-04-06 15:57:05 +00005143 }
drh9eff6162006-06-12 21:59:13 +00005144 }
drh111a6a72008-12-21 03:51:16 +00005145 whereClauseClear(pWInfo->pWC);
drhf1b5f5b2013-05-02 00:15:01 +00005146 while( pWInfo->pLoops ){
5147 WhereLoop *p = pWInfo->pLoops;
5148 pWInfo->pLoops = p->pNextLoop;
5149 whereLoopDelete(db, p);
5150 }
drh633e6d52008-07-28 19:34:53 +00005151 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00005152 }
5153}
5154
drhf1b5f5b2013-05-02 00:15:01 +00005155/*
5156** Insert or replace a WhereLoop entry using the template supplied.
5157**
5158** An existing WhereLoop entry might be overwritten if the new template
5159** is better and has fewer dependencies. Or the template will be ignored
5160** and no insert will occur if an existing WhereLoop is faster and has
5161** fewer dependencies than the template. Otherwise a new WhereLoop is
5162** added based no the template.
5163*/
5164static int whereLoopInsert(WhereInfo *pWInfo, WhereLoop *pTemplate){
drh43fe25f2013-05-07 23:06:23 +00005165 WhereLoop **ppPrev, *p, *pNext = 0, *pToFree = 0;
drha18f3d22013-05-08 03:05:41 +00005166 WhereTerm **paTerm = 0;
drhf1b5f5b2013-05-02 00:15:01 +00005167 sqlite3 *db = pWInfo->pParse->db;
5168
5169 /* Search for an existing WhereLoop to overwrite, or which takes
5170 ** priority over pTemplate.
5171 */
5172 for(ppPrev=&pWInfo->pLoops, p=*ppPrev; p; ppPrev=&p->pNextLoop, p=*ppPrev){
5173 if( p->iTab!=pTemplate->iTab ) continue;
5174 if( (p->prereq & pTemplate->prereq)==p->prereq
5175 && p->nOb>=pTemplate->nOb
5176 && p->iOb==pTemplate->iOb
5177 && p->rSetup<=pTemplate->rSetup
5178 && p->rRun<=pTemplate->rRun
5179 ){
5180 /* Already holding an equal or better WhereLoop.
5181 ** Return without changing or adding anything */
5182 return SQLITE_OK;
5183 }
5184 if( (p->prereq & pTemplate->prereq)==pTemplate->prereq
5185 && p->nOb<=pTemplate->nOb
5186 && p->iOb==pTemplate->iOb
5187 && p->rSetup>=pTemplate->rSetup
5188 && p->rRun>=pTemplate->rRun
5189 ){
5190 /* Overwrite an existing WhereLoop with a better one */
drh43fe25f2013-05-07 23:06:23 +00005191 pNext = p->pNextLoop;
drh5346e952013-05-08 14:14:26 +00005192 whereLoopClear(db, p);
drhf1b5f5b2013-05-02 00:15:01 +00005193 break;
5194 }
5195 }
5196
5197 /* If we reach this point it means that either p[] should be overwritten
5198 ** with pTemplate[] if p[] exists, or if p==NULL then allocate a new
5199 ** WhereLoop and insert it.
5200 */
5201 if( p==0 ){
drh43fe25f2013-05-07 23:06:23 +00005202 p = pToFree = sqlite3DbMallocRaw(db, sizeof(WhereLoop));
drhf1b5f5b2013-05-02 00:15:01 +00005203 if( p==0 ) return SQLITE_NOMEM;
5204 }
drha18f3d22013-05-08 03:05:41 +00005205 if( pTemplate->nTerm ){
5206 paTerm = sqlite3DbMallocRaw(db, pTemplate->nTerm*sizeof(p->aTerm[0]));
5207 if( paTerm==0 ){
5208 sqlite3DbFree(db, pToFree);
5209 return SQLITE_NOMEM;
5210 }
5211 }
drhf1b5f5b2013-05-02 00:15:01 +00005212 *p = *pTemplate;
drh43fe25f2013-05-07 23:06:23 +00005213 p->pNextLoop = pNext;
5214 *ppPrev = p;
drha18f3d22013-05-08 03:05:41 +00005215 p->aTerm = paTerm;
drha18f3d22013-05-08 03:05:41 +00005216 if( pTemplate->nTerm ){
5217 memcpy(p->aTerm, pTemplate->aTerm, pTemplate->nTerm*sizeof(p->aTerm[0]));
drhf1b5f5b2013-05-02 00:15:01 +00005218 }
drh5346e952013-05-08 14:14:26 +00005219 if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
5220 if( p->u.btree.pIndex && p->u.btree.pIndex->tnum==0 ) p->u.btree.pIndex = 0;
5221 }else{
5222 pTemplate->u.vtab.needFree = 0;
5223 }
drhf1b5f5b2013-05-02 00:15:01 +00005224 return SQLITE_OK;
5225}
5226
5227/*
drh5346e952013-05-08 14:14:26 +00005228** We have so far matched pBuilder->pNew->u.btree.nEq terms of the index pIndex.
drh1c8148f2013-05-04 20:25:23 +00005229** Try to match one more.
5230**
5231** If pProbe->tnum==0, that means pIndex is a fake index used for the
5232** INTEGER PRIMARY KEY.
5233*/
drh5346e952013-05-08 14:14:26 +00005234static int whereLoopAddBtreeIndex(
drh1c8148f2013-05-04 20:25:23 +00005235 WhereLoopBuilder *pBuilder, /* The WhereLoop factory */
5236 struct SrcList_item *pSrc, /* FROM clause term being analyzed */
5237 Index *pProbe, /* An index on pSrc */
5238 int nInMul /* Number of iterations due to IN */
5239){
5240 sqlite3 *db; /* Database connection malloc context */
5241 WhereLoop *pNew; /* Template WhereLoop under construction */
5242 WhereTerm *pTerm; /* A WhereTerm under consideration */
drh43fe25f2013-05-07 23:06:23 +00005243 int opMask; /* Valid operators for constraints */
drh1c8148f2013-05-04 20:25:23 +00005244 WhereScan scan; /* Iterator for WHERE terms */
drh43fe25f2013-05-07 23:06:23 +00005245 WhereLoop savedLoop; /* Saved original content of pNew[] */
drha18f3d22013-05-08 03:05:41 +00005246 int iCol; /* Index of the column in the table */
drh5346e952013-05-08 14:14:26 +00005247 int rc = SQLITE_OK; /* Return code */
drh1c8148f2013-05-04 20:25:23 +00005248
5249 db = pBuilder->db;
5250 pNew = pBuilder->pNew;
drh5346e952013-05-08 14:14:26 +00005251 if( db->mallocFailed ) return SQLITE_NOMEM;
drh1c8148f2013-05-04 20:25:23 +00005252
drh5346e952013-05-08 14:14:26 +00005253 assert( (pNew->wsFlags & WHERE_VIRTUALTABLE)==0 );
5254 assert( pNew->u.btree.nEq<pProbe->nColumn );
drh43fe25f2013-05-07 23:06:23 +00005255 assert( (pNew->wsFlags & WHERE_TOP_LIMIT)==0 );
5256 if( pNew->wsFlags & WHERE_BTM_LIMIT ){
5257 opMask = WO_LT|WO_LE;
5258 }else if( pProbe->tnum<=0 || (pSrc->jointype & JT_LEFT)!=0 ){
5259 opMask = WO_EQ|WO_IN|WO_GT|WO_GE|WO_LT|WO_LE;
drh1c8148f2013-05-04 20:25:23 +00005260 }else{
drh43fe25f2013-05-07 23:06:23 +00005261 opMask = WO_EQ|WO_IN|WO_ISNULL|WO_GT|WO_GE|WO_LT|WO_LE;
drh1c8148f2013-05-04 20:25:23 +00005262 }
5263
drh5346e952013-05-08 14:14:26 +00005264 iCol = pProbe->aiColumn[pNew->u.btree.nEq];
drha18f3d22013-05-08 03:05:41 +00005265 pTerm = whereScanInit(&scan, pBuilder->pWC, pSrc->iCursor, iCol,
5266 opMask, iCol>=0 ? pProbe : 0);
5267 savedLoop = *pNew;
5268 pNew->rSetup = (double)0;
drh5346e952013-05-08 14:14:26 +00005269 for(; rc==SQLITE_OK && pTerm!=0; pTerm = whereScanNext(&scan)){
drha18f3d22013-05-08 03:05:41 +00005270 int nIn = 1;
drh5346e952013-05-08 14:14:26 +00005271 pNew->u.btree.nEq = savedLoop.u.btree.nEq;
drha18f3d22013-05-08 03:05:41 +00005272 pNew->nTerm = savedLoop.nTerm;
5273 pNew->aTerm[pNew->nTerm++] = pTerm;
5274 pNew->prereq = (savedLoop.prereq | pTerm->prereqRight) & ~pNew->maskSelf;
5275 if( pTerm->eOperator & WO_IN ){
5276 Expr *pExpr = pTerm->pExpr;
5277 pNew->wsFlags |= WHERE_COLUMN_IN;
5278 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
5279 /* "x IN (SELECT ...)": Assume the SELECT returns 25 rows */
5280 nIn = 25;
5281 }else if( ALWAYS(pExpr->x.pList && pExpr->x.pList->nExpr) ){
5282 /* "x IN (value, value, ...)" */
5283 nIn = pExpr->x.pList->nExpr;
drhf1645f02013-05-07 19:44:38 +00005284 }
drh5346e952013-05-08 14:14:26 +00005285 pNew->u.btree.nEq++;
5286 pNew->nOut = (double)pProbe->aiRowEst[pNew->u.btree.nEq] * nInMul * nIn;
drha18f3d22013-05-08 03:05:41 +00005287 }else if( pTerm->eOperator & (WO_EQ|WO_ISNULL) ){
5288 pNew->wsFlags |= WHERE_COLUMN_EQ;
drh5346e952013-05-08 14:14:26 +00005289 pNew->u.btree.nEq++;
5290 pNew->nOut = (double)pProbe->aiRowEst[pNew->u.btree.nEq] * nInMul;
drha18f3d22013-05-08 03:05:41 +00005291 }else if( pTerm->eOperator & (WO_GT|WO_GE) ){
5292 pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_BTM_LIMIT;
5293 pNew->nOut = savedLoop.nOut/3;
5294 }else if( pTerm->eOperator & (WO_LT|WO_LE) ){
5295 pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_TOP_LIMIT;
5296 pNew->nOut = savedLoop.nOut/3;
drh1c8148f2013-05-04 20:25:23 +00005297 }
drha18f3d22013-05-08 03:05:41 +00005298 pNew->rRun = pNew->nOut + estLog(pProbe->aiRowEst[0])*nIn;
drh5346e952013-05-08 14:14:26 +00005299 rc = whereLoopInsert(pBuilder->pWInfo, pNew);
5300 if( (pNew->wsFlags & WHERE_TOP_LIMIT)==0
5301 && pNew->u.btree.nEq<pProbe->nColumn
5302 ){
drha18f3d22013-05-08 03:05:41 +00005303 whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, nInMul*nIn);
5304 }
drh1c8148f2013-05-04 20:25:23 +00005305 }
drha18f3d22013-05-08 03:05:41 +00005306 *pNew = savedLoop;
drh5346e952013-05-08 14:14:26 +00005307 return rc;
drh1c8148f2013-05-04 20:25:23 +00005308}
5309
5310/*
drhf1b5f5b2013-05-02 00:15:01 +00005311** Add all WhereLoop objects for the iTab-th table of the join. That
5312** table is guaranteed to be a b-tree table, not a virtual table.
5313*/
drh5346e952013-05-08 14:14:26 +00005314static int whereLoopAddBtree(
drh1c8148f2013-05-04 20:25:23 +00005315 WhereLoopBuilder *pBuilder, /* WHERE clause information */
5316 int iTab, /* The table to process */
5317 Bitmask mExtra /* Extra prerequesites for using this table */
drhf1b5f5b2013-05-02 00:15:01 +00005318){
drh1c8148f2013-05-04 20:25:23 +00005319 Index *pProbe; /* An index we are evaluating */
drh1c8148f2013-05-04 20:25:23 +00005320 Index sPk; /* A fake index object for the primary key */
5321 tRowcnt aiRowEstPk[2]; /* The aiRowEst[] value for the sPk index */
5322 int aiColumnPk = -1; /* The aColumn[] value for the sPk index */
5323 struct SrcList_item *pSrc; /* The FROM clause btree term to add */
5324 sqlite3 *db; /* The database connection */
5325 WhereLoop *pNew; /* Template WhereLoop object */
drh5346e952013-05-08 14:14:26 +00005326 int rc = SQLITE_OK; /* Return code */
drhf1b5f5b2013-05-02 00:15:01 +00005327
drh1c8148f2013-05-04 20:25:23 +00005328 pNew = pBuilder->pNew;
5329 db = pBuilder->db;
5330 pSrc = pBuilder->pTabList->a + iTab;
drha184fb82013-05-08 04:22:59 +00005331 pNew->maskSelf = getMask(pBuilder->pWC->pMaskSet, pSrc->iCursor);
drh1c8148f2013-05-04 20:25:23 +00005332
5333 if( pSrc->pIndex ){
5334 /* An INDEXED BY clause specifies a particular index to use */
5335 pProbe = pSrc->pIndex;
5336 }else{
5337 /* There is no INDEXED BY clause. Create a fake Index object in local
5338 ** variable sPk to represent the rowid primary key index. Make this
5339 ** fake index the first in a chain of Index objects with all of the real
5340 ** indices to follow */
5341 Index *pFirst; /* First of real indices on the table */
5342 memset(&sPk, 0, sizeof(Index));
5343 sPk.nColumn = 1;
5344 sPk.aiColumn = &aiColumnPk;
5345 sPk.aiRowEst = aiRowEstPk;
5346 sPk.onError = OE_Replace;
5347 sPk.pTable = pSrc->pTab;
5348 aiRowEstPk[0] = pSrc->pTab->nRowEst;
5349 aiRowEstPk[1] = 1;
5350 pFirst = pSrc->pTab->pIndex;
5351 if( pSrc->notIndexed==0 ){
5352 /* The real indices of the table are only considered if the
5353 ** NOT INDEXED qualifier is omitted from the FROM clause */
5354 sPk.pNext = pFirst;
5355 }
5356 pProbe = &sPk;
5357 }
5358
drh43fe25f2013-05-07 23:06:23 +00005359 /* Insert a full table scan */
5360 pNew->iTab = iTab;
drh5346e952013-05-08 14:14:26 +00005361 pNew->u.btree.nEq = 0;
drh43fe25f2013-05-07 23:06:23 +00005362 pNew->nTerm = 0;
5363 pNew->rSetup = (double)0;
5364 pNew->prereq = 0;
drh5346e952013-05-08 14:14:26 +00005365 pNew->u.btree.pIndex = 0;
drh43fe25f2013-05-07 23:06:23 +00005366 pNew->wsFlags = 0;
5367 pNew->iOb = pNew->nOb = 0;
5368 pNew->rRun = (double)pSrc->pTab->nRowEst;
5369 pNew->nOut = (double)pSrc->pTab->nRowEst;
drh5346e952013-05-08 14:14:26 +00005370 rc = whereLoopInsert(pBuilder->pWInfo, pNew);
drh43fe25f2013-05-07 23:06:23 +00005371
drh1c8148f2013-05-04 20:25:23 +00005372 /* Loop over all indices
5373 */
drh5346e952013-05-08 14:14:26 +00005374 for(; rc==SQLITE_OK && pProbe; pProbe=pProbe->pNext){
drhf1645f02013-05-07 19:44:38 +00005375 WhereTerm **paTerm;
drh1c8148f2013-05-04 20:25:23 +00005376 pNew->prereq = mExtra;
5377 pNew->iTab = iTab;
drh5346e952013-05-08 14:14:26 +00005378 pNew->u.btree.nEq = 0;
drh1c8148f2013-05-04 20:25:23 +00005379 pNew->nTerm = 0;
drh43fe25f2013-05-07 23:06:23 +00005380 if( pProbe->tnum<=0 ){
5381 /* Integer primary key index */
5382 pNew->wsFlags = WHERE_IPK;
5383 }else{
5384 Bitmask m = pSrc->colUsed;
5385 int j;
5386 for(j=pProbe->nColumn-1; j>=0; j--){
5387 int x = pProbe->aiColumn[j];
5388 if( x<BMS-1 ){
5389 m &= ~(((Bitmask)1)<<x);
5390 }
5391 }
5392 pNew->wsFlags = m==0 ? WHERE_IDX_ONLY : 0;
5393 }
drhf1645f02013-05-07 19:44:38 +00005394 paTerm = sqlite3DbRealloc(db, pNew->aTerm,
drh5346e952013-05-08 14:14:26 +00005395 (pProbe->nColumn+2)*sizeof(pNew->aTerm[0]));
5396 if( paTerm==0 ){ rc = SQLITE_NOMEM; break; }
drhf1645f02013-05-07 19:44:38 +00005397 pNew->aTerm = paTerm;
drh5346e952013-05-08 14:14:26 +00005398 pNew->u.btree.pIndex = pProbe;
drh1c8148f2013-05-04 20:25:23 +00005399
drh5346e952013-05-08 14:14:26 +00005400 rc = whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, 1);
drh1c8148f2013-05-04 20:25:23 +00005401
5402 /* If there was an INDEXED BY clause, then only that one index is
5403 ** considered. */
5404 if( pSrc->pIndex ) break;
5405 }
drh5346e952013-05-08 14:14:26 +00005406 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00005407}
5408
5409/*
5410** Add all WhereLoop objects for the iTab-th table of the join. That
5411** table is guaranteed to be a virtual table.
5412*/
drh5346e952013-05-08 14:14:26 +00005413static int whereLoopAddVirtual(
drh1c8148f2013-05-04 20:25:23 +00005414 WhereLoopBuilder *pBuilder, /* WHERE clause information */
5415 int iTab, /* The table to process */
5416 Bitmask mExtra /* Extra prerequesites for using this table */
drhf1b5f5b2013-05-02 00:15:01 +00005417){
drh5346e952013-05-08 14:14:26 +00005418 Parse *pParse; /* The parsing context */
5419 WhereClause *pWC; /* The WHERE clause */
5420 struct SrcList_item *pSrc; /* The FROM clause term to search */
5421 Table *pTab;
5422 sqlite3 *db;
5423 sqlite3_index_info *pIdxInfo;
5424 struct sqlite3_index_constraint *pIdxCons;
5425 struct sqlite3_index_constraint_usage *pUsage;
5426 WhereTerm *pTerm;
5427 int i, j;
5428 int iTerm, mxTerm;
5429 int seenIn = 0; /* True if an IN operator is seen */
5430 int seenVar = 0; /* True if a non-constant constraint is seen */
5431 int iPhase; /* 0: const w/o IN, 1: const, 2: no IN, 2: IN */
5432 WhereLoop *pNew;
5433 WhereTerm **paTerm;
5434 int rc = SQLITE_OK;
5435
5436 pParse = pBuilder->pParse;
5437 db = pParse->db;
5438 pWC = pBuilder->pWC;
5439 pSrc = &pBuilder->pTabList->a[iTab];
5440 pTab = pSrc->pTab;
5441 pNew = pBuilder->pNew;
5442 pIdxInfo = allocateIndexInfo(pParse,pWC,pSrc,pBuilder->pOrderBy);
5443 if( pIdxInfo==0 ) return SQLITE_NOMEM;
5444 paTerm = sqlite3DbRealloc(db, pNew->aTerm,
5445 pIdxInfo->nConstraint*sizeof(pNew->aTerm[0]));
5446 if( paTerm==0 ) return SQLITE_NOMEM;
5447 pNew->aTerm = paTerm;
5448 pNew->prereq = 0;
5449 pNew->iTab = iTab;
5450 pNew->maskSelf = getMask(pBuilder->pWC->pMaskSet, pSrc->iCursor);
5451 pNew->iOb = 0;
5452 pNew->nOb = 0;
5453 pNew->rSetup = 0;
5454 pNew->wsFlags = WHERE_VIRTUALTABLE;
5455 pNew->nTerm = 0;
5456 pNew->u.vtab.needFree = 0;
5457 pUsage = pIdxInfo->aConstraintUsage;
5458
5459 for(iPhase=0; iPhase<=2; iPhase++){
5460 if( !seenIn && (iPhase&1)!=0 ){
5461 iPhase++;
5462 if( iPhase>3 ) break;
5463 }
5464 if( !seenVar && iPhase>1 ) break;
5465 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
5466 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
5467 j = pIdxCons->iTermOffset;
5468 pTerm = &pWC->a[j];
5469 switch( iPhase ){
5470 case 0: /* Constants without IN operator */
5471 pIdxCons->usable = 0;
5472 if( (pTerm->eOperator & WO_IN)!=0 ){
5473 seenIn = 1;
5474 }else if( pTerm->prereqRight!=0 ){
5475 seenVar = 1;
5476 }else{
5477 pIdxCons->usable = 1;
5478 }
5479 break;
5480 case 1: /* Constants with IN operators */
5481 assert( seenIn );
5482 pIdxCons->usable = (pTerm->prereqRight==0);
5483 break;
5484 case 2: /* Variables without IN */
5485 assert( seenVar );
5486 pIdxCons->usable = (pTerm->eOperator & WO_IN)==0;
5487 break;
5488 default: /* Variables with IN */
5489 assert( seenVar && seenIn );
5490 pIdxCons->usable = 1;
5491 break;
5492 }
5493 }
5494 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
5495 if( pIdxInfo->needToFreeIdxStr ) sqlite3_free(pIdxInfo->idxStr);
5496 pIdxInfo->idxStr = 0;
5497 pIdxInfo->idxNum = 0;
5498 pIdxInfo->needToFreeIdxStr = 0;
5499 pIdxInfo->orderByConsumed = 0;
5500 /* ((double)2) In case of SQLITE_OMIT_FLOATING_POINT... */
5501 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / ((double)2);
5502 rc = vtabBestIndex(pParse, pTab, pIdxInfo);
5503 if( rc ) goto whereLoopAddVtab_exit;
5504 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
5505 pNew->prereq = 0;
5506 for(i=0; i<pIdxInfo->nConstraint; i++) pNew->aTerm[i] = 0;
5507 mxTerm = 0;
5508 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
5509 if( (iTerm = pUsage[i].argvIndex - 1)>=0 ){
5510 j = pIdxCons->iTermOffset;
5511 if( iTerm>=pIdxInfo->nConstraint
5512 || j<0
5513 || j>=pWC->nTerm
5514 || pNew->aTerm[iTerm]!=0
5515 ){
5516 rc = SQLITE_ERROR;
5517 sqlite3ErrorMsg(pParse, "%s.xBestIndex() malfunction", pTab->zName);
5518 goto whereLoopAddVtab_exit;
5519 }
5520 pTerm = &pWC->a[j];
5521 pNew->prereq |= pTerm->prereqRight;
5522 pNew->aTerm[iTerm] = pTerm;
5523 if( iTerm>mxTerm ) mxTerm = iTerm;
5524 if( (pTerm->eOperator & WO_IN)!=0 ){
5525 if( pUsage[i].omit==0 ){
5526 /* Do not attempt to use an IN constraint if the virtual table
5527 ** says that the equivalent EQ constraint cannot be safely omitted.
5528 ** If we do attempt to use such a constraint, some rows might be
5529 ** repeated in the output. */
5530 break;
5531 }
5532 /* A virtual table that is constrained by an IN clause may not
5533 ** consume the ORDER BY clause because (1) the order of IN terms
5534 ** is not necessarily related to the order of output terms and
5535 ** (2) Multiple outputs from a single IN value will not merge
5536 ** together. */
5537 pIdxInfo->orderByConsumed = 0;
5538 }
5539 }
5540 }
5541 if( i>=pIdxInfo->nConstraint ){
5542 pNew->nTerm = mxTerm+1;
5543 pNew->u.vtab.idxNum = pIdxInfo->idxNum;
5544 pNew->u.vtab.needFree = pIdxInfo->needToFreeIdxStr;
5545 pIdxInfo->needToFreeIdxStr = 0;
5546 pNew->u.vtab.idxStr = pIdxInfo->idxStr;
5547 pNew->iOb = 0;
5548 if( pIdxInfo->orderByConsumed ){
5549 pNew->nOb = (u16)(pIdxInfo->nOrderBy&0xffff);
5550 }else{
5551 pNew->nOb = 0;
5552 }
5553 pNew->rSetup = (double)0;
5554 pNew->rRun = pIdxInfo->estimatedCost;
5555 pNew->nOut = (double)25;
5556 whereLoopInsert(pBuilder->pWInfo, pNew);
5557 if( pNew->u.vtab.needFree ){
5558 sqlite3_free(pNew->u.vtab.idxStr);
5559 pNew->u.vtab.needFree = 0;
5560 }
5561 }
5562 }
5563
5564whereLoopAddVtab_exit:
5565 if( pIdxInfo->needToFreeIdxStr ) sqlite3_free(pIdxInfo->idxStr);
5566 sqlite3DbFree(db, pIdxInfo);
5567 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00005568}
5569
5570/*
5571** Add all WhereLoop objects for all tables
5572*/
drh5346e952013-05-08 14:14:26 +00005573static int whereLoopAddAll(WhereLoopBuilder *pBuilder){
drhf1b5f5b2013-05-02 00:15:01 +00005574 Bitmask mExtra = 0;
5575 Bitmask mPrior = 0;
5576 int iTab;
drh1c8148f2013-05-04 20:25:23 +00005577 SrcList *pTabList = pBuilder->pTabList;
drhf1b5f5b2013-05-02 00:15:01 +00005578 struct SrcList_item *pItem;
drh1c8148f2013-05-04 20:25:23 +00005579 WhereClause *pWC = pBuilder->pWC;
5580 sqlite3 *db = pBuilder->db;
drha18f3d22013-05-08 03:05:41 +00005581 int nTabList = pBuilder->pWInfo->nLevel;
drh5346e952013-05-08 14:14:26 +00005582 int rc = SQLITE_OK;
drhf1b5f5b2013-05-02 00:15:01 +00005583
5584 /* Loop over the tables in the join, from left to right */
drh1c8148f2013-05-04 20:25:23 +00005585 pBuilder->pNew = sqlite3DbMallocZero(db, sizeof(WhereLoop));
drh5346e952013-05-08 14:14:26 +00005586 if( pBuilder->pNew==0 ) return SQLITE_NOMEM;
drha18f3d22013-05-08 03:05:41 +00005587 for(iTab=0, pItem=pTabList->a; iTab<nTabList; iTab++, pItem++){
drhf1b5f5b2013-05-02 00:15:01 +00005588 if( IsVirtual(pItem->pTab) ){
drh5346e952013-05-08 14:14:26 +00005589 rc = whereLoopAddVirtual(pBuilder, iTab, mExtra);
drhf1b5f5b2013-05-02 00:15:01 +00005590 }else{
drh5346e952013-05-08 14:14:26 +00005591 rc = whereLoopAddBtree(pBuilder, iTab, mExtra);
drhf1b5f5b2013-05-02 00:15:01 +00005592 }
5593 mPrior |= getMask(pWC->pMaskSet, pItem->iCursor);
5594 if( (pItem->jointype & (JT_LEFT|JT_CROSS))!=0 ){
5595 mExtra = mPrior;
5596 }
drh5346e952013-05-08 14:14:26 +00005597 if( rc || db->mallocFailed ) break;
drhf1b5f5b2013-05-02 00:15:01 +00005598 }
drh1c8148f2013-05-04 20:25:23 +00005599 whereLoopDelete(db, pBuilder->pNew);
5600 pBuilder->pNew = 0;
drh5346e952013-05-08 14:14:26 +00005601 return rc;
drhf1b5f5b2013-05-02 00:15:01 +00005602}
5603
drha18f3d22013-05-08 03:05:41 +00005604/*
5605** Given the list of WhereLoop objects on pWInfo->pLoops, this routine
5606** attempts to find the lowest cost path that visits each WhereLoop
5607** once. This path is then loaded into the pWInfo->a[].pWLoop fields.
5608**
5609** Return SQLITE_OK on success or SQLITE_NOMEM of a memory allocation
5610** error occurs.
5611*/
5612static int wherePathSolver(WhereInfo *pWInfo){
5613 const int mxChoice = 10; /* Maximum number of simultaneous paths tracked */
5614 int nLoop; /* Number of terms in the join */
5615 sqlite3 *db; /* The database connection */
5616 int iLoop; /* Loop counter over the terms of the join */
5617 int ii, jj; /* Loop counters */
5618 double rCost; /* Cost of a path */
5619 double mxCost; /* Maximum cost of a set of paths */
5620 int nTo, nFrom; /* Number of valid entries in aTo[] and aFrom[] */
5621 WherePath *aFrom; /* All nFrom paths at the previous level */
5622 WherePath *aTo; /* The nTo best paths at the current level */
5623 WherePath *pFrom; /* An element of aFrom[] that we are working on */
5624 WherePath *pTo; /* An element of aTo[] that we are working on */
5625 WhereLoop *pWLoop; /* One of the WhereLoop objects */
5626 WhereLoop **pX; /* Used to divy up the pSpace memory */
5627 char *pSpace; /* Temporary memory used by this routine */
5628
5629 db = pWInfo->pParse->db;
5630 nLoop = pWInfo->nLevel;
5631 assert( nLoop<=pWInfo->pTabList->nSrc );
5632
5633 /* Allocate and initialize space for aTo and aFrom */
5634 ii = (sizeof(WherePath)+sizeof(WhereLoop*)*nLoop)*mxChoice*2;
5635 pSpace = sqlite3DbMallocRaw(db, ii);
5636 if( pSpace==0 ) return SQLITE_NOMEM;
5637 aTo = (WherePath*)pSpace;
5638 aFrom = aTo+mxChoice;
5639 memset(aFrom, 0, sizeof(aFrom[0]));
5640 pX = (WhereLoop**)(aFrom+mxChoice);
5641 for(ii=0, pFrom=aTo; ii<mxChoice*2; ii++, pFrom++, pX += nLoop){
5642 pFrom->aLoop = pX;
5643 }
5644
drhf204dac2013-05-08 03:22:07 +00005645 aFrom[0].nRow = (double)1;
drha18f3d22013-05-08 03:05:41 +00005646 nFrom = 1;
5647 for(iLoop=0; iLoop<nLoop; iLoop++){
5648 nTo = 0;
5649 for(ii=0, pFrom=aFrom; ii<nFrom; ii++, pFrom++){
5650 for(pWLoop=pWInfo->pLoops; pWLoop; pWLoop=pWLoop->pNextLoop){
5651 Bitmask maskNew;
5652 if( (pWLoop->prereq & ~pFrom->maskLoop)!=0 ) continue;
5653 if( (pWLoop->maskSelf & pFrom->maskLoop)!=0 ) continue;
5654 rCost = pWLoop->rSetup + pWLoop->rRun*pFrom->nRow + pFrom->rCost;
5655 maskNew = pFrom->maskLoop | pWLoop->maskSelf;
5656 for(jj=0, pTo=aTo; jj<nTo && pTo->maskLoop!=maskNew; jj++){}
5657 if( jj>=nTo ){
5658 if( nTo>=mxChoice && rCost>=mxCost ) continue;
5659 if( nTo<mxChoice ){
5660 jj = nTo++;
5661 }else{
drha184fb82013-05-08 04:22:59 +00005662 for(jj=nTo-1; aTo[jj].rCost>=mxCost; jj--){ assert(jj>0); }
drha18f3d22013-05-08 03:05:41 +00005663 }
5664 pTo = &aTo[jj];
drhf204dac2013-05-08 03:22:07 +00005665 }else{
5666 if( pTo->rCost<=rCost ) continue;
drha18f3d22013-05-08 03:05:41 +00005667 }
5668 pTo->maskLoop = pFrom->maskLoop | pWLoop->maskSelf;
5669 pTo->nRow = pFrom->nRow * pWLoop->nOut;
5670 pTo->rCost = rCost;
5671 memcpy(pTo->aLoop, pFrom->aLoop, sizeof(WhereLoop*)*iLoop);
5672 pTo->aLoop[iLoop] = pWLoop;
5673 if( nTo>=mxChoice ){
5674 mxCost = aTo[0].rCost;
5675 for(jj=1, pTo=&aTo[1]; jj<mxChoice; jj++, pTo++){
5676 if( pTo->rCost>mxCost ) mxCost = pTo->rCost;
5677 }
5678 }
5679 }
5680 }
5681
drhf204dac2013-05-08 03:22:07 +00005682#if 0
5683 if( sqlite3WhereTrace ){
5684 sqlite3DebugPrintf("---- round %d ---- nTo=%d\n", iLoop, nTo);
5685 for(ii=0; ii<nTo; ii++){
5686 sqlite3DebugPrintf("%03d: cost=%g nrow=%g\n",
5687 ii, aTo[ii].rCost, aTo[ii].nRow);
5688 for(jj=0; jj<=iLoop; jj++){
5689 whereLoopPrint(aTo[ii].aLoop[jj], pWInfo->pTabList);
5690 }
5691 }
5692 }
5693#endif
5694
drha18f3d22013-05-08 03:05:41 +00005695 /* Swap the roles of aFrom and aTo in preparation for the next
5696 ** cycle. */
5697 pFrom = aTo;
5698 aTo = aFrom;
5699 aFrom = pFrom;
5700 nFrom = nTo;
5701 }
5702
5703 /* TEMPORARY */
drh5346e952013-05-08 14:14:26 +00005704// if( nFrom==0 ){ sqlite3DbFree(db, pSpace); return SQLITE_ERROR; }
drha18f3d22013-05-08 03:05:41 +00005705 assert( nFrom>0 );
5706
5707 /* Find the lowest cost path and load it into pWInfo->a[].pWLoop */
5708 pFrom = aFrom;
5709 for(ii=1; ii<nFrom; ii++){
5710 if( pFrom->rCost>aFrom[ii].rCost ) pFrom = &aFrom[ii];
5711 }
5712 assert( pWInfo->nLevel==nLoop );
5713 for(iLoop=0; iLoop<nLoop; iLoop++){
5714 pWInfo->a[iLoop].pWLoop = pFrom->aLoop[iLoop];
5715 }
5716
5717 /* Free temporary memory and return success */
5718 sqlite3DbFree(db, pSpace);
5719 return SQLITE_OK;
5720}
drh94a11212004-09-25 13:12:14 +00005721
5722/*
drhe3184742002-06-19 14:27:05 +00005723** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00005724** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00005725** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00005726** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00005727** in order to complete the WHERE clause processing.
5728**
5729** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00005730**
5731** The basic idea is to do a nested loop, one loop for each table in
5732** the FROM clause of a select. (INSERT and UPDATE statements are the
5733** same as a SELECT with only a single table in the FROM clause.) For
5734** example, if the SQL is this:
5735**
5736** SELECT * FROM t1, t2, t3 WHERE ...;
5737**
5738** Then the code generated is conceptually like the following:
5739**
5740** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00005741** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00005742** foreach row3 in t3 do /
5743** ...
5744** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00005745** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00005746** end /
5747**
drh29dda4a2005-07-21 18:23:20 +00005748** Note that the loops might not be nested in the order in which they
5749** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00005750** use of indices. Note also that when the IN operator appears in
5751** the WHERE clause, it might result in additional nested loops for
5752** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00005753**
drhc27a1ce2002-06-14 20:58:45 +00005754** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00005755** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
5756** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00005757** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00005758**
drhe6f85e72004-12-25 01:03:13 +00005759** The code that sqlite3WhereBegin() generates leaves the cursors named
5760** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00005761** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00005762** data from the various tables of the loop.
5763**
drhc27a1ce2002-06-14 20:58:45 +00005764** If the WHERE clause is empty, the foreach loops must each scan their
5765** entire tables. Thus a three-way join is an O(N^3) operation. But if
5766** the tables have indices and there are terms in the WHERE clause that
5767** refer to those indices, a complete table scan can be avoided and the
5768** code will run much faster. Most of the work of this routine is checking
5769** to see if there are indices that can be used to speed up the loop.
5770**
5771** Terms of the WHERE clause are also used to limit which rows actually
5772** make it to the "..." in the middle of the loop. After each "foreach",
5773** terms of the WHERE clause that use only terms in that loop and outer
5774** loops are evaluated and if false a jump is made around all subsequent
5775** inner loops (or around the "..." if the test occurs within the inner-
5776** most loop)
5777**
5778** OUTER JOINS
5779**
5780** An outer join of tables t1 and t2 is conceptally coded as follows:
5781**
5782** foreach row1 in t1 do
5783** flag = 0
5784** foreach row2 in t2 do
5785** start:
5786** ...
5787** flag = 1
5788** end
drhe3184742002-06-19 14:27:05 +00005789** if flag==0 then
5790** move the row2 cursor to a null row
5791** goto start
5792** fi
drhc27a1ce2002-06-14 20:58:45 +00005793** end
5794**
drhe3184742002-06-19 14:27:05 +00005795** ORDER BY CLAUSE PROCESSING
5796**
drh46ec5b62012-09-24 15:30:54 +00005797** pOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
drhe3184742002-06-19 14:27:05 +00005798** if there is one. If there is no ORDER BY clause or if this routine
drh46ec5b62012-09-24 15:30:54 +00005799** is called from an UPDATE or DELETE statement, then pOrderBy is NULL.
drhe3184742002-06-19 14:27:05 +00005800**
5801** If an index can be used so that the natural output order of the table
5802** scan is correct for the ORDER BY clause, then that index is used and
drh46ec5b62012-09-24 15:30:54 +00005803** the returned WhereInfo.nOBSat field is set to pOrderBy->nExpr. This
5804** is an optimization that prevents an unnecessary sort of the result set
5805** if an index appropriate for the ORDER BY clause already exists.
drhe3184742002-06-19 14:27:05 +00005806**
5807** If the where clause loops cannot be arranged to provide the correct
drh46ec5b62012-09-24 15:30:54 +00005808** output order, then WhereInfo.nOBSat is 0.
drh75897232000-05-29 14:26:00 +00005809*/
danielk19774adee202004-05-08 08:23:19 +00005810WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00005811 Parse *pParse, /* The parser context */
5812 SrcList *pTabList, /* A list of all tables to be scanned */
5813 Expr *pWhere, /* The WHERE clause */
drh46ec5b62012-09-24 15:30:54 +00005814 ExprList *pOrderBy, /* An ORDER BY clause, or NULL */
dan38cc40c2011-06-30 20:17:15 +00005815 ExprList *pDistinct, /* The select-list for DISTINCT queries - or NULL */
dan0efb72c2012-08-24 18:44:56 +00005816 u16 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
5817 int iIdxCur /* If WHERE_ONETABLE_ONLY is set, index cursor number */
drh75897232000-05-29 14:26:00 +00005818){
danielk1977be229652009-03-20 14:18:51 +00005819 int nByteWInfo; /* Num. bytes allocated for WhereInfo struct */
drhc01a3c12009-12-16 22:10:49 +00005820 int nTabList; /* Number of elements in pTabList */
drh75897232000-05-29 14:26:00 +00005821 WhereInfo *pWInfo; /* Will become the return value of this function */
5822 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhfe05af82005-07-21 03:14:59 +00005823 Bitmask notReady; /* Cursors that are not yet positioned */
drh56f1b992012-09-25 14:29:39 +00005824 WhereBestIdx sWBI; /* Best index search context */
drh1c8148f2013-05-04 20:25:23 +00005825 WhereLoopBuilder sWLB; /* The WhereLoop builder */
drh111a6a72008-12-21 03:51:16 +00005826 WhereMaskSet *pMaskSet; /* The expression mask set */
drh56f1b992012-09-25 14:29:39 +00005827 WhereLevel *pLevel; /* A single level in pWInfo->a[] */
5828 int iFrom; /* First unused FROM clause element */
drh111a6a72008-12-21 03:51:16 +00005829 int andFlags; /* AND-ed combination of all pWC->a[].wtFlags */
drh9cd1c992012-09-25 20:43:35 +00005830 int ii; /* Loop counter */
drh17435752007-08-16 04:30:38 +00005831 sqlite3 *db; /* Database connection */
drh5346e952013-05-08 14:14:26 +00005832 int rc; /* Return code */
drh75897232000-05-29 14:26:00 +00005833
drh56f1b992012-09-25 14:29:39 +00005834
5835 /* Variable initialization */
5836 memset(&sWBI, 0, sizeof(sWBI));
5837 sWBI.pParse = pParse;
drh1c8148f2013-05-04 20:25:23 +00005838 memset(&sWLB, 0, sizeof(sWLB));
5839 sWLB.pParse = pParse;
5840 sWLB.db = pParse->db;
5841 sWLB.pTabList = pTabList;
5842 sWLB.pOrderBy = pOrderBy;
drh56f1b992012-09-25 14:29:39 +00005843
drh29dda4a2005-07-21 18:23:20 +00005844 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00005845 ** bits in a Bitmask
5846 */
drh67ae0cb2010-04-08 14:38:51 +00005847 testcase( pTabList->nSrc==BMS );
drh29dda4a2005-07-21 18:23:20 +00005848 if( pTabList->nSrc>BMS ){
5849 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00005850 return 0;
5851 }
5852
drhc01a3c12009-12-16 22:10:49 +00005853 /* This function normally generates a nested loop for all tables in
5854 ** pTabList. But if the WHERE_ONETABLE_ONLY flag is set, then we should
5855 ** only generate code for the first table in pTabList and assume that
5856 ** any cursors associated with subsequent tables are uninitialized.
5857 */
5858 nTabList = (wctrlFlags & WHERE_ONETABLE_ONLY) ? 1 : pTabList->nSrc;
5859
drh75897232000-05-29 14:26:00 +00005860 /* Allocate and initialize the WhereInfo structure that will become the
danielk1977be229652009-03-20 14:18:51 +00005861 ** return value. A single allocation is used to store the WhereInfo
5862 ** struct, the contents of WhereInfo.a[], the WhereClause structure
5863 ** and the WhereMaskSet structure. Since WhereClause contains an 8-byte
5864 ** field (type Bitmask) it must be aligned on an 8-byte boundary on
5865 ** some architectures. Hence the ROUND8() below.
drh75897232000-05-29 14:26:00 +00005866 */
drh17435752007-08-16 04:30:38 +00005867 db = pParse->db;
drhc01a3c12009-12-16 22:10:49 +00005868 nByteWInfo = ROUND8(sizeof(WhereInfo)+(nTabList-1)*sizeof(WhereLevel));
danielk1977be229652009-03-20 14:18:51 +00005869 pWInfo = sqlite3DbMallocZero(db,
5870 nByteWInfo +
5871 sizeof(WhereClause) +
5872 sizeof(WhereMaskSet)
5873 );
drh17435752007-08-16 04:30:38 +00005874 if( db->mallocFailed ){
drh8b307fb2010-04-06 15:57:05 +00005875 sqlite3DbFree(db, pWInfo);
5876 pWInfo = 0;
danielk197785574e32008-10-06 05:32:18 +00005877 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00005878 }
drhc01a3c12009-12-16 22:10:49 +00005879 pWInfo->nLevel = nTabList;
drh75897232000-05-29 14:26:00 +00005880 pWInfo->pParse = pParse;
5881 pWInfo->pTabList = pTabList;
danielk19774adee202004-05-08 08:23:19 +00005882 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh56f1b992012-09-25 14:29:39 +00005883 pWInfo->pWC = sWBI.pWC = (WhereClause *)&((u8 *)pWInfo)[nByteWInfo];
drh6df2acd2008-12-28 16:55:25 +00005884 pWInfo->wctrlFlags = wctrlFlags;
drh8b307fb2010-04-06 15:57:05 +00005885 pWInfo->savedNQueryLoop = pParse->nQueryLoop;
drh56f1b992012-09-25 14:29:39 +00005886 pMaskSet = (WhereMaskSet*)&sWBI.pWC[1];
drh46c35f92012-09-26 23:17:01 +00005887 sWBI.aLevel = pWInfo->a;
drh1c8148f2013-05-04 20:25:23 +00005888 sWLB.pWInfo = pWInfo;
5889 sWLB.pWC = pWInfo->pWC;
drh08192d52002-04-30 19:20:28 +00005890
drha9b1b912011-07-08 13:07:02 +00005891 /* Disable the DISTINCT optimization if SQLITE_DistinctOpt is set via
5892 ** sqlite3_test_ctrl(SQLITE_TESTCTRL_OPTIMIZATIONS,...) */
drh7e5418e2012-09-27 15:05:54 +00005893 if( OptimizationDisabled(db, SQLITE_DistinctOpt) ) pDistinct = 0;
drha9b1b912011-07-08 13:07:02 +00005894
drh111a6a72008-12-21 03:51:16 +00005895 /* Split the WHERE clause into separate subexpressions where each
5896 ** subexpression is separated by an AND operator.
5897 */
5898 initMaskSet(pMaskSet);
drh56f1b992012-09-25 14:29:39 +00005899 whereClauseInit(sWBI.pWC, pParse, pMaskSet, wctrlFlags);
drh111a6a72008-12-21 03:51:16 +00005900 sqlite3ExprCodeConstants(pParse, pWhere);
drh56f1b992012-09-25 14:29:39 +00005901 whereSplit(sWBI.pWC, pWhere, TK_AND); /* IMP: R-15842-53296 */
drh111a6a72008-12-21 03:51:16 +00005902
drh08192d52002-04-30 19:20:28 +00005903 /* Special case: a WHERE clause that is constant. Evaluate the
5904 ** expression and either jump over all of the code or fall thru.
5905 */
drhc01a3c12009-12-16 22:10:49 +00005906 if( pWhere && (nTabList==0 || sqlite3ExprIsConstantNotJoin(pWhere)) ){
drh35573352008-01-08 23:54:25 +00005907 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, SQLITE_JUMPIFNULL);
drhdf199a22002-06-14 22:38:41 +00005908 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00005909 }
drh75897232000-05-29 14:26:00 +00005910
drh42165be2008-03-26 14:56:34 +00005911 /* Assign a bit from the bitmask to every term in the FROM clause.
5912 **
5913 ** When assigning bitmask values to FROM clause cursors, it must be
5914 ** the case that if X is the bitmask for the N-th FROM clause term then
5915 ** the bitmask for all FROM clause terms to the left of the N-th term
5916 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
5917 ** its Expr.iRightJoinTable value to find the bitmask of the right table
5918 ** of the join. Subtracting one from the right table bitmask gives a
5919 ** bitmask for all tables to the left of the join. Knowing the bitmask
5920 ** for all tables to the left of a left join is important. Ticket #3015.
danielk1977e672c8e2009-05-22 15:43:26 +00005921 **
drhc01a3c12009-12-16 22:10:49 +00005922 ** Note that bitmasks are created for all pTabList->nSrc tables in
5923 ** pTabList, not just the first nTabList tables. nTabList is normally
5924 ** equal to pTabList->nSrc but might be shortened to 1 if the
5925 ** WHERE_ONETABLE_ONLY flag is set.
drh42165be2008-03-26 14:56:34 +00005926 */
drh9cd1c992012-09-25 20:43:35 +00005927 for(ii=0; ii<pTabList->nSrc; ii++){
5928 createMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00005929 }
5930#ifndef NDEBUG
5931 {
5932 Bitmask toTheLeft = 0;
drh9cd1c992012-09-25 20:43:35 +00005933 for(ii=0; ii<pTabList->nSrc; ii++){
5934 Bitmask m = getMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00005935 assert( (m-1)==toTheLeft );
5936 toTheLeft |= m;
5937 }
5938 }
5939#endif
5940
drh29dda4a2005-07-21 18:23:20 +00005941 /* Analyze all of the subexpressions. Note that exprAnalyze() might
5942 ** add new virtual terms onto the end of the WHERE clause. We do not
5943 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00005944 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00005945 */
drh56f1b992012-09-25 14:29:39 +00005946 exprAnalyzeAll(pTabList, sWBI.pWC);
drh17435752007-08-16 04:30:38 +00005947 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00005948 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00005949 }
drh75897232000-05-29 14:26:00 +00005950
dan38cc40c2011-06-30 20:17:15 +00005951 /* Check if the DISTINCT qualifier, if there is one, is redundant.
5952 ** If it is, then set pDistinct to NULL and WhereInfo.eDistinct to
5953 ** WHERE_DISTINCT_UNIQUE to tell the caller to ignore the DISTINCT.
5954 */
drh56f1b992012-09-25 14:29:39 +00005955 if( pDistinct && isDistinctRedundant(pParse, pTabList, sWBI.pWC, pDistinct) ){
dan38cc40c2011-06-30 20:17:15 +00005956 pDistinct = 0;
5957 pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
5958 }
5959
drhf1b5f5b2013-05-02 00:15:01 +00005960 /* Construct the WhereLoop objects */
5961 WHERETRACE(("*** Optimizer Start ***\n"));
drh5346e952013-05-08 14:14:26 +00005962 rc = whereLoopAddAll(&sWLB);
5963 if( rc ) goto whereBeginError;
drhf1b5f5b2013-05-02 00:15:01 +00005964
5965 /* Display all of the WhereLoop objects if wheretrace is enabled */
5966#if defined(SQLITE_DEBUG) \
5967 && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE))
5968 if( sqlite3WhereTrace ){
5969 WhereLoop *p;
drhf1b5f5b2013-05-02 00:15:01 +00005970 for(p=pWInfo->pLoops; p; p=p->pNextLoop){
drha18f3d22013-05-08 03:05:41 +00005971 whereLoopPrint(p, pTabList);
5972 }
5973 }
5974#endif
5975
5976 wherePathSolver(pWInfo);
5977 if( db->mallocFailed ) goto whereBeginError;
5978#if defined(SQLITE_DEBUG) \
5979 && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE))
5980 if( sqlite3WhereTrace ){
5981 int ii;
5982 sqlite3DebugPrintf("------------ Solution ----------------\n");
5983 for(ii=0; ii<nTabList; ii++){
5984 whereLoopPrint(pWInfo->a[ii].pWLoop, pTabList);
drhf1b5f5b2013-05-02 00:15:01 +00005985 }
5986 }
5987#endif
5988
drh29dda4a2005-07-21 18:23:20 +00005989 /* Chose the best index to use for each table in the FROM clause.
5990 **
drh51147ba2005-07-23 22:59:55 +00005991 ** This loop fills in the following fields:
5992 **
5993 ** pWInfo->a[].pIdx The index to use for this level of the loop.
drh165be382008-12-05 02:36:33 +00005994 ** pWInfo->a[].wsFlags WHERE_xxx flags associated with pIdx
drh51147ba2005-07-23 22:59:55 +00005995 ** pWInfo->a[].nEq The number of == and IN constraints
danielk197785574e32008-10-06 05:32:18 +00005996 ** pWInfo->a[].iFrom Which term of the FROM clause is being coded
drh51147ba2005-07-23 22:59:55 +00005997 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
5998 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
drh111a6a72008-12-21 03:51:16 +00005999 ** pWInfo->a[].pTerm When wsFlags==WO_OR, the OR-clause term
drh51147ba2005-07-23 22:59:55 +00006000 **
6001 ** This loop also figures out the nesting order of tables in the FROM
6002 ** clause.
drh75897232000-05-29 14:26:00 +00006003 */
drh9cd1c992012-09-25 20:43:35 +00006004 sWBI.notValid = ~(Bitmask)0;
6005 sWBI.pOrderBy = pOrderBy;
6006 sWBI.n = nTabList;
6007 sWBI.pDistinct = pDistinct;
drh943af3c2005-07-29 19:43:58 +00006008 andFlags = ~0;
drh9cd1c992012-09-25 20:43:35 +00006009 for(sWBI.i=iFrom=0, pLevel=pWInfo->a; sWBI.i<nTabList; sWBI.i++, pLevel++){
drh111a6a72008-12-21 03:51:16 +00006010 WhereCost bestPlan; /* Most efficient plan seen so far */
drh29dda4a2005-07-21 18:23:20 +00006011 Index *pIdx; /* Index for FROM table at pTabItem */
drh29dda4a2005-07-21 18:23:20 +00006012 int j; /* For looping over FROM tables */
dan5236ac12009-08-13 07:09:33 +00006013 int bestJ = -1; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00006014 Bitmask m; /* Bitmask value for j or bestJ */
dan5236ac12009-08-13 07:09:33 +00006015 int isOptimal; /* Iterator for optimal/non-optimal search */
drh3bd5ab82013-01-16 00:46:09 +00006016 int ckOptimal; /* Do the optimal scan check */
drh5e377d92010-08-04 21:17:16 +00006017 int nUnconstrained; /* Number tables without INDEXED BY */
drhaa0ba432010-08-05 02:52:32 +00006018 Bitmask notIndexed; /* Mask of tables that cannot use an index */
drh29dda4a2005-07-21 18:23:20 +00006019
drh111a6a72008-12-21 03:51:16 +00006020 memset(&bestPlan, 0, sizeof(bestPlan));
6021 bestPlan.rCost = SQLITE_BIG_DBL;
drhf1b5f5b2013-05-02 00:15:01 +00006022 /*WHERETRACE(("*** Begin search for loop %d ***\n", sWBI.i));*/
drhdf26fd52006-06-06 11:45:54 +00006023
dan5236ac12009-08-13 07:09:33 +00006024 /* Loop through the remaining entries in the FROM clause to find the
drhed754ce2010-04-15 01:04:54 +00006025 ** next nested loop. The loop tests all FROM clause entries
dan5236ac12009-08-13 07:09:33 +00006026 ** either once or twice.
6027 **
drhed754ce2010-04-15 01:04:54 +00006028 ** The first test is always performed if there are two or more entries
6029 ** remaining and never performed if there is only one FROM clause entry
6030 ** to choose from. The first test looks for an "optimal" scan. In
dan5236ac12009-08-13 07:09:33 +00006031 ** this context an optimal scan is one that uses the same strategy
6032 ** for the given FROM clause entry as would be selected if the entry
drhd0015162009-08-21 13:22:25 +00006033 ** were used as the innermost nested loop. In other words, a table
6034 ** is chosen such that the cost of running that table cannot be reduced
drhed754ce2010-04-15 01:04:54 +00006035 ** by waiting for other tables to run first. This "optimal" test works
6036 ** by first assuming that the FROM clause is on the inner loop and finding
6037 ** its query plan, then checking to see if that query plan uses any
drh9cd1c992012-09-25 20:43:35 +00006038 ** other FROM clause terms that are sWBI.notValid. If no notValid terms
6039 ** are used then the "optimal" query plan works.
dan5236ac12009-08-13 07:09:33 +00006040 **
drh547caad2010-10-04 23:55:50 +00006041 ** Note that the WhereCost.nRow parameter for an optimal scan might
6042 ** not be as small as it would be if the table really were the innermost
6043 ** join. The nRow value can be reduced by WHERE clause constraints
6044 ** that do not use indices. But this nRow reduction only happens if the
6045 ** table really is the innermost join.
6046 **
drhed754ce2010-04-15 01:04:54 +00006047 ** The second loop iteration is only performed if no optimal scan
drh547caad2010-10-04 23:55:50 +00006048 ** strategies were found by the first iteration. This second iteration
6049 ** is used to search for the lowest cost scan overall.
dan5236ac12009-08-13 07:09:33 +00006050 **
drh5d5cf012013-01-15 16:15:28 +00006051 ** Without the optimal scan step (the first iteration) a suboptimal
6052 ** plan might be chosen for queries like this:
dan5236ac12009-08-13 07:09:33 +00006053 **
6054 ** CREATE TABLE t1(a, b);
6055 ** CREATE TABLE t2(c, d);
6056 ** SELECT * FROM t2, t1 WHERE t2.rowid = t1.a;
6057 **
6058 ** The best strategy is to iterate through table t1 first. However it
6059 ** is not possible to determine this with a simple greedy algorithm.
drh15564052010-09-25 22:32:56 +00006060 ** Since the cost of a linear scan through table t2 is the same
dan5236ac12009-08-13 07:09:33 +00006061 ** as the cost of a linear scan through table t1, a simple greedy
6062 ** algorithm may choose to use t2 for the outer loop, which is a much
6063 ** costlier approach.
6064 */
drh5e377d92010-08-04 21:17:16 +00006065 nUnconstrained = 0;
drhaa0ba432010-08-05 02:52:32 +00006066 notIndexed = 0;
drh3bd5ab82013-01-16 00:46:09 +00006067
6068 /* The optimal scan check only occurs if there are two or more tables
6069 ** available to be reordered */
6070 if( iFrom==nTabList-1 ){
6071 ckOptimal = 0; /* Common case of just one table in the FROM clause */
6072 }else{
6073 ckOptimal = -1;
drh56f1b992012-09-25 14:29:39 +00006074 for(j=iFrom, sWBI.pSrc=&pTabList->a[j]; j<nTabList; j++, sWBI.pSrc++){
drh56f1b992012-09-25 14:29:39 +00006075 m = getMask(pMaskSet, sWBI.pSrc->iCursor);
drh9cd1c992012-09-25 20:43:35 +00006076 if( (m & sWBI.notValid)==0 ){
dan5236ac12009-08-13 07:09:33 +00006077 if( j==iFrom ) iFrom++;
6078 continue;
6079 }
drh3bd5ab82013-01-16 00:46:09 +00006080 if( j>iFrom && (sWBI.pSrc->jointype & (JT_LEFT|JT_CROSS))!=0 ) break;
6081 if( ++ckOptimal ) break;
6082 if( (sWBI.pSrc->jointype & JT_LEFT)!=0 ) break;
6083 }
6084 }
6085 assert( ckOptimal==0 || ckOptimal==1 );
6086
6087 for(isOptimal=ckOptimal; isOptimal>=0 && bestJ<0; isOptimal--){
6088 for(j=iFrom, sWBI.pSrc=&pTabList->a[j]; j<nTabList; j++, sWBI.pSrc++){
6089 if( j>iFrom && (sWBI.pSrc->jointype & (JT_LEFT|JT_CROSS))!=0 ){
6090 /* This break and one like it in the ckOptimal computation loop
6091 ** above prevent table reordering across LEFT and CROSS JOINs.
6092 ** The LEFT JOIN case is necessary for correctness. The prohibition
6093 ** against reordering across a CROSS JOIN is an SQLite feature that
6094 ** allows the developer to control table reordering */
6095 break;
6096 }
6097 m = getMask(pMaskSet, sWBI.pSrc->iCursor);
6098 if( (m & sWBI.notValid)==0 ){
6099 assert( j>iFrom );
6100 continue;
6101 }
drh9cd1c992012-09-25 20:43:35 +00006102 sWBI.notReady = (isOptimal ? m : sWBI.notValid);
drh56f1b992012-09-25 14:29:39 +00006103 if( sWBI.pSrc->pIndex==0 ) nUnconstrained++;
dan5236ac12009-08-13 07:09:33 +00006104
drhf1b5f5b2013-05-02 00:15:01 +00006105 /*WHERETRACE((" === trying table %d (%s) with isOptimal=%d ===\n",
6106 j, sWBI.pSrc->pTab->zName, isOptimal));*/
drh56f1b992012-09-25 14:29:39 +00006107 assert( sWBI.pSrc->pTab );
drh9eff6162006-06-12 21:59:13 +00006108#ifndef SQLITE_OMIT_VIRTUALTABLE
drh56f1b992012-09-25 14:29:39 +00006109 if( IsVirtual(sWBI.pSrc->pTab) ){
6110 sWBI.ppIdxInfo = &pWInfo->a[j].pIdxInfo;
6111 bestVirtualIndex(&sWBI);
dan5236ac12009-08-13 07:09:33 +00006112 }else
drh9eff6162006-06-12 21:59:13 +00006113#endif
dan5236ac12009-08-13 07:09:33 +00006114 {
drh56f1b992012-09-25 14:29:39 +00006115 bestBtreeIndex(&sWBI);
dan5236ac12009-08-13 07:09:33 +00006116 }
drh9cd1c992012-09-25 20:43:35 +00006117 assert( isOptimal || (sWBI.cost.used&sWBI.notValid)==0 );
dan5236ac12009-08-13 07:09:33 +00006118
drhaa0ba432010-08-05 02:52:32 +00006119 /* If an INDEXED BY clause is present, then the plan must use that
6120 ** index if it uses any index at all */
drh56f1b992012-09-25 14:29:39 +00006121 assert( sWBI.pSrc->pIndex==0
6122 || (sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)==0
6123 || sWBI.cost.plan.u.pIdx==sWBI.pSrc->pIndex );
drhaa0ba432010-08-05 02:52:32 +00006124
drh56f1b992012-09-25 14:29:39 +00006125 if( isOptimal && (sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)==0 ){
drhaa0ba432010-08-05 02:52:32 +00006126 notIndexed |= m;
6127 }
drh782d68a2012-11-09 17:59:26 +00006128 if( isOptimal ){
6129 pWInfo->a[j].rOptCost = sWBI.cost.rCost;
drh3bd5ab82013-01-16 00:46:09 +00006130 }else if( ckOptimal ){
drhea84a652013-01-15 18:49:07 +00006131 /* If two or more tables have nearly the same outer loop cost, but
drh782d68a2012-11-09 17:59:26 +00006132 ** very different inner loop (optimal) cost, we want to choose
6133 ** for the outer loop that table which benefits the least from
6134 ** being in the inner loop. The following code scales the
6135 ** outer loop cost estimate to accomplish that. */
drhf1b5f5b2013-05-02 00:15:01 +00006136 /*WHERETRACE((" scaling cost from %.1f to %.1f\n",
drh782d68a2012-11-09 17:59:26 +00006137 sWBI.cost.rCost,
drhf1b5f5b2013-05-02 00:15:01 +00006138 sWBI.cost.rCost/pWInfo->a[j].rOptCost));*/
drh782d68a2012-11-09 17:59:26 +00006139 sWBI.cost.rCost /= pWInfo->a[j].rOptCost;
6140 }
drhaa0ba432010-08-05 02:52:32 +00006141
drh5e377d92010-08-04 21:17:16 +00006142 /* Conditions under which this table becomes the best so far:
6143 **
6144 ** (1) The table must not depend on other tables that have not
drh9cd1c992012-09-25 20:43:35 +00006145 ** yet run. (In other words, it must not depend on tables
6146 ** in inner loops.)
drh5e377d92010-08-04 21:17:16 +00006147 **
drhada796b2012-11-09 18:22:26 +00006148 ** (2) (This rule was removed on 2012-11-09. The scaling of the
6149 ** cost using the optimal scan cost made this rule obsolete.)
drh5e377d92010-08-04 21:17:16 +00006150 **
drhaa0ba432010-08-05 02:52:32 +00006151 ** (3) All tables have an INDEXED BY clause or this table lacks an
drh5e377d92010-08-04 21:17:16 +00006152 ** INDEXED BY clause or this table uses the specific
drhaa0ba432010-08-05 02:52:32 +00006153 ** index specified by its INDEXED BY clause. This rule ensures
6154 ** that a best-so-far is always selected even if an impossible
6155 ** combination of INDEXED BY clauses are given. The error
6156 ** will be detected and relayed back to the application later.
6157 ** The NEVER() comes about because rule (2) above prevents
6158 ** An indexable full-table-scan from reaching rule (3).
6159 **
drhd663b5b2012-10-03 00:25:54 +00006160 ** (4) The plan cost must be lower than prior plans, where "cost"
6161 ** is defined by the compareCost() function above.
drh5e377d92010-08-04 21:17:16 +00006162 */
drh9cd1c992012-09-25 20:43:35 +00006163 if( (sWBI.cost.used&sWBI.notValid)==0 /* (1) */
drh56f1b992012-09-25 14:29:39 +00006164 && (nUnconstrained==0 || sWBI.pSrc->pIndex==0 /* (3) */
6165 || NEVER((sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)!=0))
drhd663b5b2012-10-03 00:25:54 +00006166 && (bestJ<0 || compareCost(&sWBI.cost, &bestPlan)) /* (4) */
dan5236ac12009-08-13 07:09:33 +00006167 ){
drhf1b5f5b2013-05-02 00:15:01 +00006168 /*WHERETRACE((" === table %d (%s) is best so far\n"
drh8e4af1b2012-10-08 18:23:51 +00006169 " cost=%.1f, nRow=%.1f, nOBSat=%d, wsFlags=%08x\n",
drh1afcaae2012-10-02 01:10:00 +00006170 j, sWBI.pSrc->pTab->zName,
6171 sWBI.cost.rCost, sWBI.cost.plan.nRow,
drhf1b5f5b2013-05-02 00:15:01 +00006172 sWBI.cost.plan.nOBSat, sWBI.cost.plan.wsFlags));*/
drh56f1b992012-09-25 14:29:39 +00006173 bestPlan = sWBI.cost;
dan5236ac12009-08-13 07:09:33 +00006174 bestJ = j;
6175 }
drh3bd5ab82013-01-16 00:46:09 +00006176
6177 /* In a join like "w JOIN x LEFT JOIN y JOIN z" make sure that
6178 ** table y (and not table z) is always the next inner loop inside
6179 ** of table x. */
6180 if( (sWBI.pSrc->jointype & JT_LEFT)!=0 ) break;
drh9eff6162006-06-12 21:59:13 +00006181 }
drh29dda4a2005-07-21 18:23:20 +00006182 }
dan5236ac12009-08-13 07:09:33 +00006183 assert( bestJ>=0 );
drh9cd1c992012-09-25 20:43:35 +00006184 assert( sWBI.notValid & getMask(pMaskSet, pTabList->a[bestJ].iCursor) );
drh3bd5ab82013-01-16 00:46:09 +00006185 assert( bestJ==iFrom || (pTabList->a[iFrom].jointype & JT_LEFT)==0 );
6186 testcase( bestJ>iFrom && (pTabList->a[iFrom].jointype & JT_CROSS)!=0 );
6187 testcase( bestJ>iFrom && bestJ<nTabList-1
6188 && (pTabList->a[bestJ+1].jointype & JT_LEFT)!=0 );
drhf1b5f5b2013-05-02 00:15:01 +00006189 /*WHERETRACE(("*** Optimizer selects table %d (%s) for loop %d with:\n"
drhd663b5b2012-10-03 00:25:54 +00006190 " cost=%.1f, nRow=%.1f, nOBSat=%d, wsFlags=0x%08x\n",
drh1afcaae2012-10-02 01:10:00 +00006191 bestJ, pTabList->a[bestJ].pTab->zName,
6192 pLevel-pWInfo->a, bestPlan.rCost, bestPlan.plan.nRow,
drhf1b5f5b2013-05-02 00:15:01 +00006193 bestPlan.plan.nOBSat, bestPlan.plan.wsFlags));*/
dan38cc40c2011-06-30 20:17:15 +00006194 if( (bestPlan.plan.wsFlags & WHERE_DISTINCT)!=0 ){
6195 assert( pWInfo->eDistinct==0 );
6196 pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
6197 }
drh111a6a72008-12-21 03:51:16 +00006198 andFlags &= bestPlan.plan.wsFlags;
6199 pLevel->plan = bestPlan.plan;
drha578d042012-10-02 01:25:16 +00006200 pLevel->iTabCur = pTabList->a[bestJ].iCursor;
drh8b307fb2010-04-06 15:57:05 +00006201 testcase( bestPlan.plan.wsFlags & WHERE_INDEXED );
6202 testcase( bestPlan.plan.wsFlags & WHERE_TEMP_INDEX );
6203 if( bestPlan.plan.wsFlags & (WHERE_INDEXED|WHERE_TEMP_INDEX) ){
dan0efb72c2012-08-24 18:44:56 +00006204 if( (wctrlFlags & WHERE_ONETABLE_ONLY)
6205 && (bestPlan.plan.wsFlags & WHERE_TEMP_INDEX)==0
6206 ){
6207 pLevel->iIdxCur = iIdxCur;
6208 }else{
6209 pLevel->iIdxCur = pParse->nTab++;
6210 }
drhfe05af82005-07-21 03:14:59 +00006211 }else{
6212 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00006213 }
drh9cd1c992012-09-25 20:43:35 +00006214 sWBI.notValid &= ~getMask(pMaskSet, pTabList->a[bestJ].iCursor);
shaned87897d2009-01-30 05:40:27 +00006215 pLevel->iFrom = (u8)bestJ;
dan2ce22452010-11-08 19:01:16 +00006216 if( bestPlan.plan.nRow>=(double)1 ){
6217 pParse->nQueryLoop *= bestPlan.plan.nRow;
6218 }
danielk197785574e32008-10-06 05:32:18 +00006219
6220 /* Check that if the table scanned by this loop iteration had an
6221 ** INDEXED BY clause attached to it, that the named index is being
6222 ** used for the scan. If not, then query compilation has failed.
6223 ** Return an error.
6224 */
6225 pIdx = pTabList->a[bestJ].pIndex;
drh171256c2009-01-08 03:11:19 +00006226 if( pIdx ){
6227 if( (bestPlan.plan.wsFlags & WHERE_INDEXED)==0 ){
6228 sqlite3ErrorMsg(pParse, "cannot use index: %s", pIdx->zName);
6229 goto whereBeginError;
6230 }else{
6231 /* If an INDEXED BY clause is used, the bestIndex() function is
6232 ** guaranteed to find the index specified in the INDEXED BY clause
6233 ** if it find an index at all. */
6234 assert( bestPlan.plan.u.pIdx==pIdx );
6235 }
danielk197785574e32008-10-06 05:32:18 +00006236 }
drh75897232000-05-29 14:26:00 +00006237 }
drh4f0c5872007-03-26 22:05:01 +00006238 WHERETRACE(("*** Optimizer Finished ***\n"));
danielk19771d461462009-04-21 09:02:45 +00006239 if( pParse->nErr || db->mallocFailed ){
danielk197780442942008-12-24 11:25:39 +00006240 goto whereBeginError;
6241 }
drhd663b5b2012-10-03 00:25:54 +00006242 if( nTabList ){
6243 pLevel--;
6244 pWInfo->nOBSat = pLevel->plan.nOBSat;
6245 }else{
6246 pWInfo->nOBSat = 0;
6247 }
drh75897232000-05-29 14:26:00 +00006248
drh943af3c2005-07-29 19:43:58 +00006249 /* If the total query only selects a single row, then the ORDER BY
6250 ** clause is irrelevant.
6251 */
drh46ec5b62012-09-24 15:30:54 +00006252 if( (andFlags & WHERE_UNIQUE)!=0 && pOrderBy ){
drhd663b5b2012-10-03 00:25:54 +00006253 assert( nTabList==0 || (pLevel->plan.wsFlags & WHERE_ALL_UNIQUE)!=0 );
drh46ec5b62012-09-24 15:30:54 +00006254 pWInfo->nOBSat = pOrderBy->nExpr;
drh943af3c2005-07-29 19:43:58 +00006255 }
6256
drh08c88eb2008-04-10 13:33:18 +00006257 /* If the caller is an UPDATE or DELETE statement that is requesting
6258 ** to use a one-pass algorithm, determine if this is appropriate.
6259 ** The one-pass algorithm only works if the WHERE clause constraints
6260 ** the statement to update a single row.
6261 */
drh165be382008-12-05 02:36:33 +00006262 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
6263 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 && (andFlags & WHERE_UNIQUE)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00006264 pWInfo->okOnePass = 1;
drh111a6a72008-12-21 03:51:16 +00006265 pWInfo->a[0].plan.wsFlags &= ~WHERE_IDX_ONLY;
drh08c88eb2008-04-10 13:33:18 +00006266 }
6267
drh9012bcb2004-12-19 00:11:35 +00006268 /* Open all tables in the pTabList and any indices selected for
6269 ** searching those tables.
6270 */
6271 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh8b307fb2010-04-06 15:57:05 +00006272 notReady = ~(Bitmask)0;
drh95aa47b2010-11-16 02:49:15 +00006273 pWInfo->nRowOut = (double)1;
drh9cd1c992012-09-25 20:43:35 +00006274 for(ii=0, pLevel=pWInfo->a; ii<nTabList; ii++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00006275 Table *pTab; /* Table to open */
danielk1977da184232006-01-05 11:34:32 +00006276 int iDb; /* Index of database containing table/index */
drh56f1b992012-09-25 14:29:39 +00006277 struct SrcList_item *pTabItem;
drh9012bcb2004-12-19 00:11:35 +00006278
drh29dda4a2005-07-21 18:23:20 +00006279 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00006280 pTab = pTabItem->pTab;
drh95aa47b2010-11-16 02:49:15 +00006281 pWInfo->nRowOut *= pLevel->plan.nRow;
danielk1977595a5232009-07-24 17:58:53 +00006282 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh424aab82010-04-06 18:28:20 +00006283 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ){
drh75bb9f52010-04-06 18:51:42 +00006284 /* Do nothing */
6285 }else
drh9eff6162006-06-12 21:59:13 +00006286#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00006287 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
danielk1977595a5232009-07-24 17:58:53 +00006288 const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
danielk197793626f42006-06-20 13:07:27 +00006289 int iCur = pTabItem->iCursor;
danielk1977595a5232009-07-24 17:58:53 +00006290 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0, pVTab, P4_VTAB);
drhfc5e5462012-12-03 17:04:40 +00006291 }else if( IsVirtual(pTab) ){
6292 /* noop */
drh9eff6162006-06-12 21:59:13 +00006293 }else
6294#endif
drh6df2acd2008-12-28 16:55:25 +00006295 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
drh9ef61f42011-10-07 14:40:59 +00006296 && (wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0 ){
drh08c88eb2008-04-10 13:33:18 +00006297 int op = pWInfo->okOnePass ? OP_OpenWrite : OP_OpenRead;
6298 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
drh67ae0cb2010-04-08 14:38:51 +00006299 testcase( pTab->nCol==BMS-1 );
6300 testcase( pTab->nCol==BMS );
danielk197723432972008-11-17 16:42:00 +00006301 if( !pWInfo->okOnePass && pTab->nCol<BMS ){
danielk19779792eef2006-01-13 15:58:43 +00006302 Bitmask b = pTabItem->colUsed;
6303 int n = 0;
drh74161702006-02-24 02:53:49 +00006304 for(; b; b=b>>1, n++){}
drh8cff69d2009-11-12 19:59:44 +00006305 sqlite3VdbeChangeP4(v, sqlite3VdbeCurrentAddr(v)-1,
6306 SQLITE_INT_TO_PTR(n), P4_INT32);
danielk19779792eef2006-01-13 15:58:43 +00006307 assert( n<=pTab->nCol );
6308 }
danielk1977c00da102006-01-07 13:21:04 +00006309 }else{
6310 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00006311 }
drhc6339082010-04-07 16:54:58 +00006312#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00006313 if( (pLevel->plan.wsFlags & WHERE_TEMP_INDEX)!=0 ){
drh56f1b992012-09-25 14:29:39 +00006314 constructAutomaticIndex(pParse, sWBI.pWC, pTabItem, notReady, pLevel);
drhc6339082010-04-07 16:54:58 +00006315 }else
6316#endif
6317 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
drh111a6a72008-12-21 03:51:16 +00006318 Index *pIx = pLevel->plan.u.pIdx;
danielk1977b3bf5562006-01-10 17:58:23 +00006319 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
drhb0367fb2012-08-25 02:11:13 +00006320 int iIndexCur = pLevel->iIdxCur;
danielk1977da184232006-01-05 11:34:32 +00006321 assert( pIx->pSchema==pTab->pSchema );
drhb0367fb2012-08-25 02:11:13 +00006322 assert( iIndexCur>=0 );
6323 sqlite3VdbeAddOp4(v, OP_OpenRead, iIndexCur, pIx->tnum, iDb,
drh66a51672008-01-03 00:01:23 +00006324 (char*)pKey, P4_KEYINFO_HANDOFF);
danielk1977207872a2008-01-03 07:54:23 +00006325 VdbeComment((v, "%s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00006326 }
danielk1977da184232006-01-05 11:34:32 +00006327 sqlite3CodeVerifySchema(pParse, iDb);
drh56f1b992012-09-25 14:29:39 +00006328 notReady &= ~getMask(sWBI.pWC->pMaskSet, pTabItem->iCursor);
drh9012bcb2004-12-19 00:11:35 +00006329 }
6330 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
drha21a64d2010-04-06 22:33:55 +00006331 if( db->mallocFailed ) goto whereBeginError;
drh9012bcb2004-12-19 00:11:35 +00006332
drh29dda4a2005-07-21 18:23:20 +00006333 /* Generate the code to do the search. Each iteration of the for
6334 ** loop below generates code for a single nested loop of the VM
6335 ** program.
drh75897232000-05-29 14:26:00 +00006336 */
drhfe05af82005-07-21 03:14:59 +00006337 notReady = ~(Bitmask)0;
drh9cd1c992012-09-25 20:43:35 +00006338 for(ii=0; ii<nTabList; ii++){
6339 pLevel = &pWInfo->a[ii];
6340 explainOneScan(pParse, pTabList, pLevel, ii, pLevel->iFrom, wctrlFlags);
6341 notReady = codeOneLoopStart(pWInfo, ii, wctrlFlags, notReady);
dan4a07e3d2010-11-09 14:48:59 +00006342 pWInfo->iContinue = pLevel->addrCont;
drh75897232000-05-29 14:26:00 +00006343 }
drh7ec764a2005-07-21 03:48:20 +00006344
6345#ifdef SQLITE_TEST /* For testing and debugging use only */
6346 /* Record in the query plan information about the current table
6347 ** and the index used to access it (if any). If the table itself
6348 ** is not used, its name is just '{}'. If no index is used
6349 ** the index is listed as "{}". If the primary key is used the
6350 ** index name is '*'.
6351 */
drh9cd1c992012-09-25 20:43:35 +00006352 for(ii=0; ii<nTabList; ii++){
drh7ec764a2005-07-21 03:48:20 +00006353 char *z;
6354 int n;
drh3f4d1d12012-09-15 18:45:54 +00006355 int w;
drh56f1b992012-09-25 14:29:39 +00006356 struct SrcList_item *pTabItem;
6357
drh9cd1c992012-09-25 20:43:35 +00006358 pLevel = &pWInfo->a[ii];
drh3f4d1d12012-09-15 18:45:54 +00006359 w = pLevel->plan.wsFlags;
drh29dda4a2005-07-21 18:23:20 +00006360 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00006361 z = pTabItem->zAlias;
6362 if( z==0 ) z = pTabItem->pTab->zName;
drhea678832008-12-10 19:26:22 +00006363 n = sqlite3Strlen30(z);
drh7ec764a2005-07-21 03:48:20 +00006364 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
drh3f4d1d12012-09-15 18:45:54 +00006365 if( (w & WHERE_IDX_ONLY)!=0 && (w & WHERE_COVER_SCAN)==0 ){
drh5bb3eb92007-05-04 13:15:55 +00006366 memcpy(&sqlite3_query_plan[nQPlan], "{}", 2);
drh7ec764a2005-07-21 03:48:20 +00006367 nQPlan += 2;
6368 }else{
drh5bb3eb92007-05-04 13:15:55 +00006369 memcpy(&sqlite3_query_plan[nQPlan], z, n);
drh7ec764a2005-07-21 03:48:20 +00006370 nQPlan += n;
6371 }
6372 sqlite3_query_plan[nQPlan++] = ' ';
6373 }
drh3f4d1d12012-09-15 18:45:54 +00006374 testcase( w & WHERE_ROWID_EQ );
6375 testcase( w & WHERE_ROWID_RANGE );
6376 if( w & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh5bb3eb92007-05-04 13:15:55 +00006377 memcpy(&sqlite3_query_plan[nQPlan], "* ", 2);
drh7ec764a2005-07-21 03:48:20 +00006378 nQPlan += 2;
drh3f4d1d12012-09-15 18:45:54 +00006379 }else if( (w & WHERE_INDEXED)!=0 && (w & WHERE_COVER_SCAN)==0 ){
drh111a6a72008-12-21 03:51:16 +00006380 n = sqlite3Strlen30(pLevel->plan.u.pIdx->zName);
drh7ec764a2005-07-21 03:48:20 +00006381 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
drh111a6a72008-12-21 03:51:16 +00006382 memcpy(&sqlite3_query_plan[nQPlan], pLevel->plan.u.pIdx->zName, n);
drh7ec764a2005-07-21 03:48:20 +00006383 nQPlan += n;
6384 sqlite3_query_plan[nQPlan++] = ' ';
6385 }
drh111a6a72008-12-21 03:51:16 +00006386 }else{
6387 memcpy(&sqlite3_query_plan[nQPlan], "{} ", 3);
6388 nQPlan += 3;
drh7ec764a2005-07-21 03:48:20 +00006389 }
6390 }
6391 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
6392 sqlite3_query_plan[--nQPlan] = 0;
6393 }
6394 sqlite3_query_plan[nQPlan] = 0;
6395 nQPlan = 0;
6396#endif /* SQLITE_TEST // Testing and debugging use only */
6397
drh29dda4a2005-07-21 18:23:20 +00006398 /* Record the continuation address in the WhereInfo structure. Then
6399 ** clean up and return.
6400 */
drh75897232000-05-29 14:26:00 +00006401 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00006402
6403 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00006404whereBeginError:
drh8b307fb2010-04-06 15:57:05 +00006405 if( pWInfo ){
6406 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
6407 whereInfoFree(db, pWInfo);
6408 }
drhe23399f2005-07-22 00:31:39 +00006409 return 0;
drh75897232000-05-29 14:26:00 +00006410}
6411
6412/*
drhc27a1ce2002-06-14 20:58:45 +00006413** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00006414** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00006415*/
danielk19774adee202004-05-08 08:23:19 +00006416void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00006417 Parse *pParse = pWInfo->pParse;
6418 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00006419 int i;
drh6b563442001-11-07 16:48:26 +00006420 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00006421 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00006422 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00006423
drh9012bcb2004-12-19 00:11:35 +00006424 /* Generate loop termination code.
6425 */
drhceea3322009-04-23 13:22:42 +00006426 sqlite3ExprCacheClear(pParse);
drhc01a3c12009-12-16 22:10:49 +00006427 for(i=pWInfo->nLevel-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00006428 pLevel = &pWInfo->a[i];
drhb3190c12008-12-08 21:37:14 +00006429 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00006430 if( pLevel->op!=OP_Noop ){
drh66a51672008-01-03 00:01:23 +00006431 sqlite3VdbeAddOp2(v, pLevel->op, pLevel->p1, pLevel->p2);
drhd1d38482008-10-07 23:46:38 +00006432 sqlite3VdbeChangeP5(v, pLevel->p5);
drh19a775c2000-06-05 18:54:46 +00006433 }
drh111a6a72008-12-21 03:51:16 +00006434 if( pLevel->plan.wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
drh72e8fa42007-03-28 14:30:06 +00006435 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00006436 int j;
drhb3190c12008-12-08 21:37:14 +00006437 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh111a6a72008-12-21 03:51:16 +00006438 for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00006439 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
drh2d96b932013-02-08 18:48:23 +00006440 sqlite3VdbeAddOp2(v, pIn->eEndLoopOp, pIn->iCur, pIn->addrInTop);
drhb3190c12008-12-08 21:37:14 +00006441 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00006442 }
drh111a6a72008-12-21 03:51:16 +00006443 sqlite3DbFree(db, pLevel->u.in.aInLoop);
drhd99f7062002-06-08 23:25:08 +00006444 }
drhb3190c12008-12-08 21:37:14 +00006445 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhad2d8302002-05-24 20:31:36 +00006446 if( pLevel->iLeftJoin ){
6447 int addr;
drh3c84ddf2008-01-09 02:15:38 +00006448 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin);
drh35451c62009-11-12 04:26:39 +00006449 assert( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
6450 || (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 );
6451 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0 ){
6452 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
6453 }
drh9012bcb2004-12-19 00:11:35 +00006454 if( pLevel->iIdxCur>=0 ){
drh3c84ddf2008-01-09 02:15:38 +00006455 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00006456 }
drh336a5302009-04-24 15:46:21 +00006457 if( pLevel->op==OP_Return ){
6458 sqlite3VdbeAddOp2(v, OP_Gosub, pLevel->p1, pLevel->addrFirst);
6459 }else{
6460 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
6461 }
drhd654be82005-09-20 17:42:23 +00006462 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00006463 }
drh19a775c2000-06-05 18:54:46 +00006464 }
drh9012bcb2004-12-19 00:11:35 +00006465
6466 /* The "break" point is here, just past the end of the outer loop.
6467 ** Set it.
6468 */
danielk19774adee202004-05-08 08:23:19 +00006469 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00006470
drh29dda4a2005-07-21 18:23:20 +00006471 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00006472 */
drhc01a3c12009-12-16 22:10:49 +00006473 assert( pWInfo->nLevel==1 || pWInfo->nLevel==pTabList->nSrc );
6474 for(i=0, pLevel=pWInfo->a; i<pWInfo->nLevel; i++, pLevel++){
danbfca6a42012-08-24 10:52:35 +00006475 Index *pIdx = 0;
drh29dda4a2005-07-21 18:23:20 +00006476 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00006477 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00006478 assert( pTab!=0 );
drh4139c992010-04-07 14:59:45 +00006479 if( (pTab->tabFlags & TF_Ephemeral)==0
6480 && pTab->pSelect==0
drh9ef61f42011-10-07 14:40:59 +00006481 && (pWInfo->wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0
drh4139c992010-04-07 14:59:45 +00006482 ){
drh8b307fb2010-04-06 15:57:05 +00006483 int ws = pLevel->plan.wsFlags;
6484 if( !pWInfo->okOnePass && (ws & WHERE_IDX_ONLY)==0 ){
drh6df2acd2008-12-28 16:55:25 +00006485 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
6486 }
drhf12cde52010-04-08 17:28:00 +00006487 if( (ws & WHERE_INDEXED)!=0 && (ws & WHERE_TEMP_INDEX)==0 ){
drh6df2acd2008-12-28 16:55:25 +00006488 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
6489 }
drh9012bcb2004-12-19 00:11:35 +00006490 }
6491
danielk197721de2e72007-11-29 17:43:27 +00006492 /* If this scan uses an index, make code substitutions to read data
6493 ** from the index in preference to the table. Sometimes, this means
6494 ** the table need never be read from. This is a performance boost,
6495 ** as the vdbe level waits until the table is read before actually
6496 ** seeking the table cursor to the record corresponding to the current
6497 ** position in the index.
drh9012bcb2004-12-19 00:11:35 +00006498 **
6499 ** Calls to the code generator in between sqlite3WhereBegin and
6500 ** sqlite3WhereEnd will have created code that references the table
6501 ** directly. This loop scans all that code looking for opcodes
6502 ** that reference the table and converts them into opcodes that
6503 ** reference the index.
6504 */
danbfca6a42012-08-24 10:52:35 +00006505 if( pLevel->plan.wsFlags & WHERE_INDEXED ){
6506 pIdx = pLevel->plan.u.pIdx;
6507 }else if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drhd40e2082012-08-24 23:24:15 +00006508 pIdx = pLevel->u.pCovidx;
danbfca6a42012-08-24 10:52:35 +00006509 }
6510 if( pIdx && !db->mallocFailed){
danielk1977f0113002006-01-24 12:09:17 +00006511 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00006512 VdbeOp *pOp;
drh9012bcb2004-12-19 00:11:35 +00006513
drh9012bcb2004-12-19 00:11:35 +00006514 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
6515 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00006516 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00006517 if( pOp->p1!=pLevel->iTabCur ) continue;
6518 if( pOp->opcode==OP_Column ){
drh9012bcb2004-12-19 00:11:35 +00006519 for(j=0; j<pIdx->nColumn; j++){
6520 if( pOp->p2==pIdx->aiColumn[j] ){
6521 pOp->p2 = j;
danielk197721de2e72007-11-29 17:43:27 +00006522 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00006523 break;
6524 }
6525 }
drh35451c62009-11-12 04:26:39 +00006526 assert( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
6527 || j<pIdx->nColumn );
drhf0863fe2005-06-12 21:35:51 +00006528 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00006529 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00006530 pOp->opcode = OP_IdxRowid;
drh9012bcb2004-12-19 00:11:35 +00006531 }
6532 }
drh6b563442001-11-07 16:48:26 +00006533 }
drh19a775c2000-06-05 18:54:46 +00006534 }
drh9012bcb2004-12-19 00:11:35 +00006535
6536 /* Final cleanup
6537 */
drhf12cde52010-04-08 17:28:00 +00006538 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
6539 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00006540 return;
6541}