blob: a3c5e24d39751d857142b95d7fae9519e7bb095b [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;
drh0aa74ed2005-07-16 13:33:20 +000042
43/*
drh75897232000-05-29 14:26:00 +000044** The query generator uses an array of instances of this structure to
45** help it analyze the subexpressions of the WHERE clause. Each WHERE
drh61495262009-04-22 15:32:59 +000046** clause subexpression is separated from the others by AND operators,
47** usually, or sometimes subexpressions separated by OR.
drh51669862004-12-18 18:40:26 +000048**
drh0fcef5e2005-07-19 17:38:22 +000049** All WhereTerms are collected into a single WhereClause structure.
50** The following identity holds:
drh51669862004-12-18 18:40:26 +000051**
drh0fcef5e2005-07-19 17:38:22 +000052** WhereTerm.pWC->a[WhereTerm.idx] == WhereTerm
drh51669862004-12-18 18:40:26 +000053**
drh0fcef5e2005-07-19 17:38:22 +000054** When a term is of the form:
55**
56** X <op> <expr>
57**
58** where X is a column name and <op> is one of certain operators,
drh700a2262008-12-17 19:22:15 +000059** then WhereTerm.leftCursor and WhereTerm.u.leftColumn record the
60** cursor number and column number for X. WhereTerm.eOperator records
drh51147ba2005-07-23 22:59:55 +000061** the <op> using a bitmask encoding defined by WO_xxx below. The
62** use of a bitmask encoding for the operator allows us to search
63** quickly for terms that match any of several different operators.
drh0fcef5e2005-07-19 17:38:22 +000064**
drh700a2262008-12-17 19:22:15 +000065** A WhereTerm might also be two or more subterms connected by OR:
66**
67** (t1.X <op> <expr>) OR (t1.Y <op> <expr>) OR ....
68**
69** In this second case, wtFlag as the TERM_ORINFO set and eOperator==WO_OR
70** and the WhereTerm.u.pOrInfo field points to auxiliary information that
71** is collected about the
72**
73** If a term in the WHERE clause does not match either of the two previous
74** categories, then eOperator==0. The WhereTerm.pExpr field is still set
75** to the original subexpression content and wtFlags is set up appropriately
76** but no other fields in the WhereTerm object are meaningful.
77**
78** When eOperator!=0, prereqRight and prereqAll record sets of cursor numbers,
drh111a6a72008-12-21 03:51:16 +000079** but they do so indirectly. A single WhereMaskSet structure translates
drh51669862004-12-18 18:40:26 +000080** cursor number into bits and the translated bit is stored in the prereq
81** fields. The translation is used in order to maximize the number of
82** bits that will fit in a Bitmask. The VDBE cursor numbers might be
83** spread out over the non-negative integers. For example, the cursor
drh111a6a72008-12-21 03:51:16 +000084** numbers might be 3, 8, 9, 10, 20, 23, 41, and 45. The WhereMaskSet
drh51669862004-12-18 18:40:26 +000085** translates these sparse cursor numbers into consecutive integers
86** beginning with 0 in order to make the best possible use of the available
87** bits in the Bitmask. So, in the example above, the cursor numbers
88** would be mapped into integers 0 through 7.
drh6a1e0712008-12-05 15:24:15 +000089**
90** The number of terms in a join is limited by the number of bits
91** in prereqRight and prereqAll. The default is 64 bits, hence SQLite
92** is only able to process joins with 64 or fewer tables.
drh75897232000-05-29 14:26:00 +000093*/
drh0aa74ed2005-07-16 13:33:20 +000094typedef struct WhereTerm WhereTerm;
95struct WhereTerm {
drh165be382008-12-05 02:36:33 +000096 Expr *pExpr; /* Pointer to the subexpression that is this term */
drhec1724e2008-12-09 01:32:03 +000097 int iParent; /* Disable pWC->a[iParent] when this term disabled */
98 int leftCursor; /* Cursor number of X in "X <op> <expr>" */
drh700a2262008-12-17 19:22:15 +000099 union {
100 int leftColumn; /* Column number of X in "X <op> <expr>" */
drh7a5bcc02013-01-16 17:08:58 +0000101 WhereOrInfo *pOrInfo; /* Extra information if (eOperator & WO_OR)!=0 */
102 WhereAndInfo *pAndInfo; /* Extra information if (eOperator& WO_AND)!=0 */
drh700a2262008-12-17 19:22:15 +0000103 } u;
drhb52076c2006-01-23 13:22:09 +0000104 u16 eOperator; /* A WO_xx value describing <op> */
drh165be382008-12-05 02:36:33 +0000105 u8 wtFlags; /* TERM_xxx bit flags. See below */
drh45b1ee42005-08-02 17:48:22 +0000106 u8 nChild; /* Number of children that must disable us */
drh0fcef5e2005-07-19 17:38:22 +0000107 WhereClause *pWC; /* The clause this term is part of */
drh165be382008-12-05 02:36:33 +0000108 Bitmask prereqRight; /* Bitmask of tables used by pExpr->pRight */
109 Bitmask prereqAll; /* Bitmask of tables referenced by pExpr */
drh75897232000-05-29 14:26:00 +0000110};
111
112/*
drh165be382008-12-05 02:36:33 +0000113** Allowed values of WhereTerm.wtFlags
drh0aa74ed2005-07-16 13:33:20 +0000114*/
drh633e6d52008-07-28 19:34:53 +0000115#define TERM_DYNAMIC 0x01 /* Need to call sqlite3ExprDelete(db, pExpr) */
drh6c30be82005-07-29 15:10:17 +0000116#define TERM_VIRTUAL 0x02 /* Added by the optimizer. Do not code */
117#define TERM_CODED 0x04 /* This term is already coded */
drh45b1ee42005-08-02 17:48:22 +0000118#define TERM_COPIED 0x08 /* Has a child */
drh700a2262008-12-17 19:22:15 +0000119#define TERM_ORINFO 0x10 /* Need to free the WhereTerm.u.pOrInfo object */
120#define TERM_ANDINFO 0x20 /* Need to free the WhereTerm.u.pAndInfo obj */
121#define TERM_OR_OK 0x40 /* Used during OR-clause processing */
drhfaacf172011-08-12 01:51:45 +0000122#ifdef SQLITE_ENABLE_STAT3
drh59b61882011-02-11 02:43:14 +0000123# define TERM_VNULL 0x80 /* Manufactured x>NULL or x<=NULL term */
124#else
drhd3ed7342011-09-21 00:09:41 +0000125# define TERM_VNULL 0x00 /* Disabled if not using stat3 */
drh59b61882011-02-11 02:43:14 +0000126#endif
drh0aa74ed2005-07-16 13:33:20 +0000127
128/*
129** An instance of the following structure holds all information about a
130** WHERE clause. Mostly this is a container for one or more WhereTerms.
drh8871ef52011-10-07 13:33:10 +0000131**
132** Explanation of pOuter: For a WHERE clause of the form
133**
134** a AND ((b AND c) OR (d AND e)) AND f
135**
136** There are separate WhereClause objects for the whole clause and for
137** the subclauses "(b AND c)" and "(d AND e)". The pOuter field of the
138** subclauses points to the WhereClause object for the whole clause.
drh0aa74ed2005-07-16 13:33:20 +0000139*/
drh0aa74ed2005-07-16 13:33:20 +0000140struct WhereClause {
drhfe05af82005-07-21 03:14:59 +0000141 Parse *pParse; /* The parser context */
drh111a6a72008-12-21 03:51:16 +0000142 WhereMaskSet *pMaskSet; /* Mapping of table cursor numbers to bitmasks */
drh8871ef52011-10-07 13:33:10 +0000143 WhereClause *pOuter; /* Outer conjunction */
drh29435252008-12-28 18:35:08 +0000144 u8 op; /* Split operator. TK_AND or TK_OR */
drh9ef61f42011-10-07 14:40:59 +0000145 u16 wctrlFlags; /* Might include WHERE_AND_ONLY */
drh0aa74ed2005-07-16 13:33:20 +0000146 int nTerm; /* Number of terms */
147 int nSlot; /* Number of entries in a[] */
drh51147ba2005-07-23 22:59:55 +0000148 WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
drh50d654d2009-06-03 01:24:54 +0000149#if defined(SQLITE_SMALL_STACK)
150 WhereTerm aStatic[1]; /* Initial static space for a[] */
151#else
152 WhereTerm aStatic[8]; /* Initial static space for a[] */
153#endif
drhe23399f2005-07-22 00:31:39 +0000154};
155
156/*
drh700a2262008-12-17 19:22:15 +0000157** A WhereTerm with eOperator==WO_OR has its u.pOrInfo pointer set to
158** a dynamically allocated instance of the following structure.
159*/
160struct WhereOrInfo {
drh111a6a72008-12-21 03:51:16 +0000161 WhereClause wc; /* Decomposition into subterms */
drh1a58fe02008-12-20 02:06:13 +0000162 Bitmask indexable; /* Bitmask of all indexable tables in the clause */
drh700a2262008-12-17 19:22:15 +0000163};
164
165/*
166** A WhereTerm with eOperator==WO_AND has its u.pAndInfo pointer set to
167** a dynamically allocated instance of the following structure.
168*/
169struct WhereAndInfo {
drh29435252008-12-28 18:35:08 +0000170 WhereClause wc; /* The subexpression broken out */
drh700a2262008-12-17 19:22:15 +0000171};
172
173/*
drh6a3ea0e2003-05-02 14:32:12 +0000174** An instance of the following structure keeps track of a mapping
drh0aa74ed2005-07-16 13:33:20 +0000175** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
drh51669862004-12-18 18:40:26 +0000176**
177** The VDBE cursor numbers are small integers contained in
178** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
179** clause, the cursor numbers might not begin with 0 and they might
180** contain gaps in the numbering sequence. But we want to make maximum
181** use of the bits in our bitmasks. This structure provides a mapping
182** from the sparse cursor numbers into consecutive integers beginning
183** with 0.
184**
drh111a6a72008-12-21 03:51:16 +0000185** If WhereMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
drh51669862004-12-18 18:40:26 +0000186** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
187**
188** For example, if the WHERE clause expression used these VDBE
drh111a6a72008-12-21 03:51:16 +0000189** cursors: 4, 5, 8, 29, 57, 73. Then the WhereMaskSet structure
drh51669862004-12-18 18:40:26 +0000190** would map those cursor numbers into bits 0 through 5.
191**
192** Note that the mapping is not necessarily ordered. In the example
193** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
194** 57->5, 73->4. Or one of 719 other combinations might be used. It
195** does not really matter. What is important is that sparse cursor
196** numbers all get mapped into bit numbers that begin with 0 and contain
197** no gaps.
drh6a3ea0e2003-05-02 14:32:12 +0000198*/
drh111a6a72008-12-21 03:51:16 +0000199struct WhereMaskSet {
drh1398ad32005-01-19 23:24:50 +0000200 int n; /* Number of assigned cursor values */
danielk197723432972008-11-17 16:42:00 +0000201 int ix[BMS]; /* Cursor assigned to each bit */
drh6a3ea0e2003-05-02 14:32:12 +0000202};
203
drh111a6a72008-12-21 03:51:16 +0000204/*
205** A WhereCost object records a lookup strategy and the estimated
206** cost of pursuing that strategy.
207*/
208struct WhereCost {
209 WherePlan plan; /* The lookup strategy */
210 double rCost; /* Overall cost of pursuing this search strategy */
dan5236ac12009-08-13 07:09:33 +0000211 Bitmask used; /* Bitmask of cursors used by this plan */
drh111a6a72008-12-21 03:51:16 +0000212};
drh0aa74ed2005-07-16 13:33:20 +0000213
drh6a3ea0e2003-05-02 14:32:12 +0000214/*
drh51147ba2005-07-23 22:59:55 +0000215** Bitmasks for the operators that indices are able to exploit. An
216** OR-ed combination of these values can be used when searching for
217** terms in the where clause.
218*/
drh165be382008-12-05 02:36:33 +0000219#define WO_IN 0x001
220#define WO_EQ 0x002
drh51147ba2005-07-23 22:59:55 +0000221#define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
222#define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
223#define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
224#define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
drh165be382008-12-05 02:36:33 +0000225#define WO_MATCH 0x040
226#define WO_ISNULL 0x080
drh700a2262008-12-17 19:22:15 +0000227#define WO_OR 0x100 /* Two or more OR-connected terms */
228#define WO_AND 0x200 /* Two or more AND-connected terms */
drh7a5bcc02013-01-16 17:08:58 +0000229#define WO_EQUIV 0x400 /* Of the form A==B, both columns */
drh534230c2011-01-22 00:10:45 +0000230#define WO_NOOP 0x800 /* This term does not restrict search space */
drh51147ba2005-07-23 22:59:55 +0000231
drhec1724e2008-12-09 01:32:03 +0000232#define WO_ALL 0xfff /* Mask of all possible WO_* values */
drh1a58fe02008-12-20 02:06:13 +0000233#define WO_SINGLE 0x0ff /* Mask of all non-compound WO_* values */
drhec1724e2008-12-09 01:32:03 +0000234
drh51147ba2005-07-23 22:59:55 +0000235/*
drh700a2262008-12-17 19:22:15 +0000236** Value for wsFlags returned by bestIndex() and stored in
237** WhereLevel.wsFlags. These flags determine which search
238** strategies are appropriate.
drhf2d315d2007-01-25 16:56:06 +0000239**
drh165be382008-12-05 02:36:33 +0000240** The least significant 12 bits is reserved as a mask for WO_ values above.
drh700a2262008-12-17 19:22:15 +0000241** The WhereLevel.wsFlags field is usually set to WO_IN|WO_EQ|WO_ISNULL.
242** But if the table is the right table of a left join, WhereLevel.wsFlags
243** is set to WO_IN|WO_EQ. The WhereLevel.wsFlags field can then be used as
drhf2d315d2007-01-25 16:56:06 +0000244** the "op" parameter to findTerm when we are resolving equality constraints.
245** ISNULL constraints will then not be used on the right table of a left
246** join. Tickets #2177 and #2189.
drh51147ba2005-07-23 22:59:55 +0000247*/
drh165be382008-12-05 02:36:33 +0000248#define WHERE_ROWID_EQ 0x00001000 /* rowid=EXPR or rowid IN (...) */
249#define WHERE_ROWID_RANGE 0x00002000 /* rowid<EXPR and/or rowid>EXPR */
drh46619d62009-04-24 14:51:42 +0000250#define WHERE_COLUMN_EQ 0x00010000 /* x=EXPR or x IN (...) or x IS NULL */
drh165be382008-12-05 02:36:33 +0000251#define WHERE_COLUMN_RANGE 0x00020000 /* x<EXPR and/or x>EXPR */
252#define WHERE_COLUMN_IN 0x00040000 /* x IN (...) */
drh46619d62009-04-24 14:51:42 +0000253#define WHERE_COLUMN_NULL 0x00080000 /* x IS NULL */
254#define WHERE_INDEXED 0x000f0000 /* Anything that uses an index */
drh75ad2602010-10-21 02:05:06 +0000255#define WHERE_NOT_FULLSCAN 0x100f3000 /* Does not do a full table scan */
drh281bbe22012-10-16 23:17:14 +0000256#define WHERE_IN_ABLE 0x080f1000 /* Able to support an IN operator */
drh165be382008-12-05 02:36:33 +0000257#define WHERE_TOP_LIMIT 0x00100000 /* x<EXPR or x<=EXPR constraint */
258#define WHERE_BTM_LIMIT 0x00200000 /* x>EXPR or x>=EXPR constraint */
drh04098e62010-11-15 21:50:19 +0000259#define WHERE_BOTH_LIMIT 0x00300000 /* Both x>EXPR and x<EXPR */
drh60441af2012-09-29 19:10:29 +0000260#define WHERE_IDX_ONLY 0x00400000 /* Use index only - omit table */
drhd663b5b2012-10-03 00:25:54 +0000261#define WHERE_ORDERED 0x00800000 /* Output will appear in correct order */
drh60441af2012-09-29 19:10:29 +0000262#define WHERE_REVERSE 0x01000000 /* Scan in reverse order */
263#define WHERE_UNIQUE 0x02000000 /* Selects no more than one row */
264#define WHERE_ALL_UNIQUE 0x04000000 /* This and all prior have one row */
drh165be382008-12-05 02:36:33 +0000265#define WHERE_VIRTUALTABLE 0x08000000 /* Use virtual-table processing */
266#define WHERE_MULTI_OR 0x10000000 /* OR using multiple indices */
drh8b307fb2010-04-06 15:57:05 +0000267#define WHERE_TEMP_INDEX 0x20000000 /* Uses an ephemeral index */
dan38cc40c2011-06-30 20:17:15 +0000268#define WHERE_DISTINCT 0x40000000 /* Correct order for DISTINCT */
drh3f4d1d12012-09-15 18:45:54 +0000269#define WHERE_COVER_SCAN 0x80000000 /* Full scan of a covering index */
drh51147ba2005-07-23 22:59:55 +0000270
271/*
drh56f1b992012-09-25 14:29:39 +0000272** This module contains many separate subroutines that work together to
273** find the best indices to use for accessing a particular table in a query.
274** An instance of the following structure holds context information about the
275** index search so that it can be more easily passed between the various
276** routines.
277*/
278typedef struct WhereBestIdx WhereBestIdx;
279struct WhereBestIdx {
280 Parse *pParse; /* Parser context */
281 WhereClause *pWC; /* The WHERE clause */
282 struct SrcList_item *pSrc; /* The FROM clause term to search */
283 Bitmask notReady; /* Mask of cursors not available */
284 Bitmask notValid; /* Cursors not available for any purpose */
285 ExprList *pOrderBy; /* The ORDER BY clause */
286 ExprList *pDistinct; /* The select-list if query is DISTINCT */
287 sqlite3_index_info **ppIdxInfo; /* Index information passed to xBestIndex */
drh9cd1c992012-09-25 20:43:35 +0000288 int i, n; /* Which loop is being coded; # of loops */
drh46c35f92012-09-26 23:17:01 +0000289 WhereLevel *aLevel; /* Info about outer loops */
drh56f1b992012-09-25 14:29:39 +0000290 WhereCost cost; /* Lowest cost query plan */
291};
292
293/*
drhd663b5b2012-10-03 00:25:54 +0000294** Return TRUE if the probe cost is less than the baseline cost
295*/
296static int compareCost(const WhereCost *pProbe, const WhereCost *pBaseline){
297 if( pProbe->rCost<pBaseline->rCost ) return 1;
298 if( pProbe->rCost>pBaseline->rCost ) return 0;
299 if( pProbe->plan.nOBSat>pBaseline->plan.nOBSat ) return 1;
300 if( pProbe->plan.nRow<pBaseline->plan.nRow ) return 1;
301 return 0;
302}
303
304/*
drh0aa74ed2005-07-16 13:33:20 +0000305** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000306*/
drh7b4fc6a2007-02-06 13:26:32 +0000307static void whereClauseInit(
308 WhereClause *pWC, /* The WhereClause to be initialized */
309 Parse *pParse, /* The parsing context */
drh9ef61f42011-10-07 14:40:59 +0000310 WhereMaskSet *pMaskSet, /* Mapping from table cursor numbers to bitmasks */
311 u16 wctrlFlags /* Might include WHERE_AND_ONLY */
drh7b4fc6a2007-02-06 13:26:32 +0000312){
drhfe05af82005-07-21 03:14:59 +0000313 pWC->pParse = pParse;
drh7b4fc6a2007-02-06 13:26:32 +0000314 pWC->pMaskSet = pMaskSet;
drh8871ef52011-10-07 13:33:10 +0000315 pWC->pOuter = 0;
drh0aa74ed2005-07-16 13:33:20 +0000316 pWC->nTerm = 0;
drhcad651e2007-04-20 12:22:01 +0000317 pWC->nSlot = ArraySize(pWC->aStatic);
drh0aa74ed2005-07-16 13:33:20 +0000318 pWC->a = pWC->aStatic;
drh9ef61f42011-10-07 14:40:59 +0000319 pWC->wctrlFlags = wctrlFlags;
drh0aa74ed2005-07-16 13:33:20 +0000320}
321
drh700a2262008-12-17 19:22:15 +0000322/* Forward reference */
323static void whereClauseClear(WhereClause*);
324
325/*
326** Deallocate all memory associated with a WhereOrInfo object.
327*/
328static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000329 whereClauseClear(&p->wc);
330 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000331}
332
333/*
334** Deallocate all memory associated with a WhereAndInfo object.
335*/
336static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000337 whereClauseClear(&p->wc);
338 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000339}
340
drh0aa74ed2005-07-16 13:33:20 +0000341/*
342** Deallocate a WhereClause structure. The WhereClause structure
343** itself is not freed. This routine is the inverse of whereClauseInit().
344*/
345static void whereClauseClear(WhereClause *pWC){
346 int i;
347 WhereTerm *a;
drh633e6d52008-07-28 19:34:53 +0000348 sqlite3 *db = pWC->pParse->db;
drh0aa74ed2005-07-16 13:33:20 +0000349 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
drh165be382008-12-05 02:36:33 +0000350 if( a->wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000351 sqlite3ExprDelete(db, a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000352 }
drh700a2262008-12-17 19:22:15 +0000353 if( a->wtFlags & TERM_ORINFO ){
354 whereOrInfoDelete(db, a->u.pOrInfo);
355 }else if( a->wtFlags & TERM_ANDINFO ){
356 whereAndInfoDelete(db, a->u.pAndInfo);
357 }
drh0aa74ed2005-07-16 13:33:20 +0000358 }
359 if( pWC->a!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000360 sqlite3DbFree(db, pWC->a);
drh0aa74ed2005-07-16 13:33:20 +0000361 }
362}
363
364/*
drh6a1e0712008-12-05 15:24:15 +0000365** Add a single new WhereTerm entry to the WhereClause object pWC.
366** The new WhereTerm object is constructed from Expr p and with wtFlags.
367** The index in pWC->a[] of the new WhereTerm is returned on success.
368** 0 is returned if the new WhereTerm could not be added due to a memory
369** allocation error. The memory allocation failure will be recorded in
370** the db->mallocFailed flag so that higher-level functions can detect it.
371**
372** This routine will increase the size of the pWC->a[] array as necessary.
drh9eb20282005-08-24 03:52:18 +0000373**
drh165be382008-12-05 02:36:33 +0000374** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
drh6a1e0712008-12-05 15:24:15 +0000375** for freeing the expression p is assumed by the WhereClause object pWC.
376** This is true even if this routine fails to allocate a new WhereTerm.
drhb63a53d2007-03-31 01:34:44 +0000377**
drh9eb20282005-08-24 03:52:18 +0000378** WARNING: This routine might reallocate the space used to store
drh909626d2008-05-30 14:58:37 +0000379** WhereTerms. All pointers to WhereTerms should be invalidated after
drh9eb20282005-08-24 03:52:18 +0000380** calling this routine. Such pointers may be reinitialized by referencing
381** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000382*/
drhec1724e2008-12-09 01:32:03 +0000383static int whereClauseInsert(WhereClause *pWC, Expr *p, u8 wtFlags){
drh0aa74ed2005-07-16 13:33:20 +0000384 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000385 int idx;
drhe9cdcea2010-07-22 22:40:03 +0000386 testcase( wtFlags & TERM_VIRTUAL ); /* EV: R-00211-15100 */
drh0aa74ed2005-07-16 13:33:20 +0000387 if( pWC->nTerm>=pWC->nSlot ){
388 WhereTerm *pOld = pWC->a;
drh633e6d52008-07-28 19:34:53 +0000389 sqlite3 *db = pWC->pParse->db;
390 pWC->a = sqlite3DbMallocRaw(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
drhb63a53d2007-03-31 01:34:44 +0000391 if( pWC->a==0 ){
drh165be382008-12-05 02:36:33 +0000392 if( wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000393 sqlite3ExprDelete(db, p);
drhb63a53d2007-03-31 01:34:44 +0000394 }
drhf998b732007-11-26 13:36:00 +0000395 pWC->a = pOld;
drhb63a53d2007-03-31 01:34:44 +0000396 return 0;
397 }
drh0aa74ed2005-07-16 13:33:20 +0000398 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
399 if( pOld!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000400 sqlite3DbFree(db, pOld);
drh0aa74ed2005-07-16 13:33:20 +0000401 }
drh6a1e0712008-12-05 15:24:15 +0000402 pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
drh0aa74ed2005-07-16 13:33:20 +0000403 }
drh6a1e0712008-12-05 15:24:15 +0000404 pTerm = &pWC->a[idx = pWC->nTerm++];
drh7ee751d2012-12-19 15:53:51 +0000405 pTerm->pExpr = sqlite3ExprSkipCollate(p);
drh165be382008-12-05 02:36:33 +0000406 pTerm->wtFlags = wtFlags;
drh0fcef5e2005-07-19 17:38:22 +0000407 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000408 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000409 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000410}
drh75897232000-05-29 14:26:00 +0000411
412/*
drh51669862004-12-18 18:40:26 +0000413** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000414** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000415** operator specified in the op parameter. The WhereClause structure
416** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000417**
drh51669862004-12-18 18:40:26 +0000418** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
419** \________/ \_______________/ \________________/
420** slot[0] slot[1] slot[2]
421**
422** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000423** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000424**
drh51147ba2005-07-23 22:59:55 +0000425** In the previous sentence and in the diagram, "slot[]" refers to
drh902b9ee2008-12-05 17:17:07 +0000426** the WhereClause.a[] array. The slot[] array grows as needed to contain
drh51147ba2005-07-23 22:59:55 +0000427** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000428*/
drh6c30be82005-07-29 15:10:17 +0000429static void whereSplit(WhereClause *pWC, Expr *pExpr, int op){
drh29435252008-12-28 18:35:08 +0000430 pWC->op = (u8)op;
drh0aa74ed2005-07-16 13:33:20 +0000431 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000432 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000433 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000434 }else{
drh6c30be82005-07-29 15:10:17 +0000435 whereSplit(pWC, pExpr->pLeft, op);
436 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000437 }
drh75897232000-05-29 14:26:00 +0000438}
439
440/*
drh61495262009-04-22 15:32:59 +0000441** Initialize an expression mask set (a WhereMaskSet object)
drh6a3ea0e2003-05-02 14:32:12 +0000442*/
443#define initMaskSet(P) memset(P, 0, sizeof(*P))
444
445/*
drh1398ad32005-01-19 23:24:50 +0000446** Return the bitmask for the given cursor number. Return 0 if
447** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000448*/
drh111a6a72008-12-21 03:51:16 +0000449static Bitmask getMask(WhereMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000450 int i;
drhfcd71b62011-04-05 22:08:24 +0000451 assert( pMaskSet->n<=(int)sizeof(Bitmask)*8 );
drh6a3ea0e2003-05-02 14:32:12 +0000452 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000453 if( pMaskSet->ix[i]==iCursor ){
454 return ((Bitmask)1)<<i;
455 }
drh6a3ea0e2003-05-02 14:32:12 +0000456 }
drh6a3ea0e2003-05-02 14:32:12 +0000457 return 0;
458}
459
460/*
drh1398ad32005-01-19 23:24:50 +0000461** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000462**
463** There is one cursor per table in the FROM clause. The number of
464** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000465** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000466** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000467*/
drh111a6a72008-12-21 03:51:16 +0000468static void createMask(WhereMaskSet *pMaskSet, int iCursor){
drhcad651e2007-04-20 12:22:01 +0000469 assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
drh0fcef5e2005-07-19 17:38:22 +0000470 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000471}
472
473/*
drh75897232000-05-29 14:26:00 +0000474** This routine walks (recursively) an expression tree and generates
475** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000476** tree.
drh75897232000-05-29 14:26:00 +0000477**
478** In order for this routine to work, the calling function must have
drh7d10d5a2008-08-20 16:35:10 +0000479** previously invoked sqlite3ResolveExprNames() on the expression. See
drh75897232000-05-29 14:26:00 +0000480** the header comment on that routine for additional information.
drh7d10d5a2008-08-20 16:35:10 +0000481** The sqlite3ResolveExprNames() routines looks for column names and
drh6a3ea0e2003-05-02 14:32:12 +0000482** sets their opcodes to TK_COLUMN and their Expr.iTable fields to
drh51147ba2005-07-23 22:59:55 +0000483** the VDBE cursor number of the table. This routine just has to
484** translate the cursor numbers into bitmask values and OR all
485** the bitmasks together.
drh75897232000-05-29 14:26:00 +0000486*/
drh111a6a72008-12-21 03:51:16 +0000487static Bitmask exprListTableUsage(WhereMaskSet*, ExprList*);
488static Bitmask exprSelectTableUsage(WhereMaskSet*, Select*);
489static Bitmask exprTableUsage(WhereMaskSet *pMaskSet, Expr *p){
drh51669862004-12-18 18:40:26 +0000490 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000491 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000492 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000493 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000494 return mask;
drh75897232000-05-29 14:26:00 +0000495 }
danielk1977b3bce662005-01-29 08:32:43 +0000496 mask = exprTableUsage(pMaskSet, p->pRight);
497 mask |= exprTableUsage(pMaskSet, p->pLeft);
danielk19776ab3a2e2009-02-19 14:39:25 +0000498 if( ExprHasProperty(p, EP_xIsSelect) ){
499 mask |= exprSelectTableUsage(pMaskSet, p->x.pSelect);
500 }else{
501 mask |= exprListTableUsage(pMaskSet, p->x.pList);
502 }
danielk1977b3bce662005-01-29 08:32:43 +0000503 return mask;
504}
drh111a6a72008-12-21 03:51:16 +0000505static Bitmask exprListTableUsage(WhereMaskSet *pMaskSet, ExprList *pList){
danielk1977b3bce662005-01-29 08:32:43 +0000506 int i;
507 Bitmask mask = 0;
508 if( pList ){
509 for(i=0; i<pList->nExpr; i++){
510 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000511 }
512 }
drh75897232000-05-29 14:26:00 +0000513 return mask;
514}
drh111a6a72008-12-21 03:51:16 +0000515static Bitmask exprSelectTableUsage(WhereMaskSet *pMaskSet, Select *pS){
drha430ae82007-09-12 15:41:01 +0000516 Bitmask mask = 0;
517 while( pS ){
drha464c232011-09-16 19:04:03 +0000518 SrcList *pSrc = pS->pSrc;
drha430ae82007-09-12 15:41:01 +0000519 mask |= exprListTableUsage(pMaskSet, pS->pEList);
drhf5b11382005-09-17 13:07:13 +0000520 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
521 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
522 mask |= exprTableUsage(pMaskSet, pS->pWhere);
523 mask |= exprTableUsage(pMaskSet, pS->pHaving);
drha464c232011-09-16 19:04:03 +0000524 if( ALWAYS(pSrc!=0) ){
drh88501772011-09-16 17:43:06 +0000525 int i;
526 for(i=0; i<pSrc->nSrc; i++){
527 mask |= exprSelectTableUsage(pMaskSet, pSrc->a[i].pSelect);
528 mask |= exprTableUsage(pMaskSet, pSrc->a[i].pOn);
529 }
530 }
drha430ae82007-09-12 15:41:01 +0000531 pS = pS->pPrior;
drhf5b11382005-09-17 13:07:13 +0000532 }
533 return mask;
534}
drh75897232000-05-29 14:26:00 +0000535
536/*
drh487ab3c2001-11-08 00:45:21 +0000537** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000538** allowed for an indexable WHERE clause term. The allowed operators are
drhc27a1ce2002-06-14 20:58:45 +0000539** "=", "<", ">", "<=", ">=", and "IN".
drhe9cdcea2010-07-22 22:40:03 +0000540**
541** IMPLEMENTATION-OF: R-59926-26393 To be usable by an index a term must be
542** of one of the following forms: column = expression column > expression
543** column >= expression column < expression column <= expression
544** expression = column expression > column expression >= column
545** expression < column expression <= column column IN
546** (expression-list) column IN (subquery) column IS NULL
drh487ab3c2001-11-08 00:45:21 +0000547*/
548static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000549 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
550 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
551 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
552 assert( TK_GE==TK_EQ+4 );
drh50b39962006-10-28 00:28:09 +0000553 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL;
drh487ab3c2001-11-08 00:45:21 +0000554}
555
556/*
drh902b9ee2008-12-05 17:17:07 +0000557** Swap two objects of type TYPE.
drh193bd772004-07-20 18:23:14 +0000558*/
559#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
560
561/*
drh909626d2008-05-30 14:58:37 +0000562** Commute a comparison operator. Expressions of the form "X op Y"
drh0fcef5e2005-07-19 17:38:22 +0000563** are converted into "Y op X".
danielk1977eb5453d2007-07-30 14:40:48 +0000564**
drhae80dde2012-12-06 21:16:43 +0000565** If left/right precendence rules come into play when determining the
566** collating
danielk1977eb5453d2007-07-30 14:40:48 +0000567** side of the comparison, it remains associated with the same side after
568** the commutation. So "Y collate NOCASE op X" becomes
drhae80dde2012-12-06 21:16:43 +0000569** "X op Y". This is because any collation sequence on
danielk1977eb5453d2007-07-30 14:40:48 +0000570** the left hand side of a comparison overrides any collation sequence
drhae80dde2012-12-06 21:16:43 +0000571** attached to the right. For the same reason the EP_Collate flag
danielk1977eb5453d2007-07-30 14:40:48 +0000572** is not commuted.
drh193bd772004-07-20 18:23:14 +0000573*/
drh7d10d5a2008-08-20 16:35:10 +0000574static void exprCommute(Parse *pParse, Expr *pExpr){
drhae80dde2012-12-06 21:16:43 +0000575 u16 expRight = (pExpr->pRight->flags & EP_Collate);
576 u16 expLeft = (pExpr->pLeft->flags & EP_Collate);
drhfe05af82005-07-21 03:14:59 +0000577 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drhae80dde2012-12-06 21:16:43 +0000578 if( expRight==expLeft ){
579 /* Either X and Y both have COLLATE operator or neither do */
580 if( expRight ){
581 /* Both X and Y have COLLATE operators. Make sure X is always
582 ** used by clearing the EP_Collate flag from Y. */
583 pExpr->pRight->flags &= ~EP_Collate;
584 }else if( sqlite3ExprCollSeq(pParse, pExpr->pLeft)!=0 ){
585 /* Neither X nor Y have COLLATE operators, but X has a non-default
586 ** collating sequence. So add the EP_Collate marker on X to cause
587 ** it to be searched first. */
588 pExpr->pLeft->flags |= EP_Collate;
589 }
590 }
drh0fcef5e2005-07-19 17:38:22 +0000591 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
592 if( pExpr->op>=TK_GT ){
593 assert( TK_LT==TK_GT+2 );
594 assert( TK_GE==TK_LE+2 );
595 assert( TK_GT>TK_EQ );
596 assert( TK_GT<TK_LE );
597 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
598 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000599 }
drh193bd772004-07-20 18:23:14 +0000600}
601
602/*
drhfe05af82005-07-21 03:14:59 +0000603** Translate from TK_xx operator to WO_xx bitmask.
604*/
drhec1724e2008-12-09 01:32:03 +0000605static u16 operatorMask(int op){
606 u16 c;
drhfe05af82005-07-21 03:14:59 +0000607 assert( allowedOp(op) );
608 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000609 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000610 }else if( op==TK_ISNULL ){
611 c = WO_ISNULL;
drhfe05af82005-07-21 03:14:59 +0000612 }else{
drhec1724e2008-12-09 01:32:03 +0000613 assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
614 c = (u16)(WO_EQ<<(op-TK_EQ));
drhfe05af82005-07-21 03:14:59 +0000615 }
drh50b39962006-10-28 00:28:09 +0000616 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh51147ba2005-07-23 22:59:55 +0000617 assert( op!=TK_IN || c==WO_IN );
618 assert( op!=TK_EQ || c==WO_EQ );
619 assert( op!=TK_LT || c==WO_LT );
620 assert( op!=TK_LE || c==WO_LE );
621 assert( op!=TK_GT || c==WO_GT );
622 assert( op!=TK_GE || c==WO_GE );
623 return c;
drhfe05af82005-07-21 03:14:59 +0000624}
625
626/*
627** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
628** where X is a reference to the iColumn of table iCur and <op> is one of
629** the WO_xx operator codes specified by the op parameter.
630** Return a pointer to the term. Return 0 if not found.
drh58eb1c02013-01-17 00:08:42 +0000631**
632** The term returned might by Y=<expr> if there is another constraint in
633** the WHERE clause that specifies that X=Y. Any such constraints will be
634** identified by the WO_EQUIV bit in the pTerm->eOperator field. The
635** aEquiv[] array holds X and all its equivalents, with each SQL variable
636** taking up two slots in aEquiv[]. The first slot is for the cursor number
637** and the second is for the column number. There are 22 slots in aEquiv[]
638** so that means we can look for X plus up to 10 other equivalent values.
639** Hence a search for X will return <expr> if X=A1 and A1=A2 and A2=A3
640** and ... and A9=A10 and A10=<expr>.
641**
642** If there are multiple terms in the WHERE clause of the form "X <op> <expr>"
643** then try for the one with no dependencies on <expr> - in other words where
644** <expr> is a constant expression of some kind. Only return entries of
645** the form "X <op> Y" where Y is a column in another table if no terms of
646** the form "X <op> <const-expr>" exist. Other than this priority, if there
647** are two or more terms that match, then the choice of which term to return
648** is arbitrary.
drhfe05af82005-07-21 03:14:59 +0000649*/
650static WhereTerm *findTerm(
651 WhereClause *pWC, /* The WHERE clause to be searched */
652 int iCur, /* Cursor number of LHS */
653 int iColumn, /* Column number of LHS */
654 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000655 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000656 Index *pIdx /* Must be compatible with this index, if not NULL */
657){
drh58eb1c02013-01-17 00:08:42 +0000658 WhereTerm *pTerm; /* Term being examined as possible result */
659 WhereTerm *pResult = 0; /* The answer to return */
660 WhereClause *pWCOrig = pWC; /* Original pWC value */
661 int j, k; /* Loop counters */
662 Expr *pX; /* Pointer to an expression */
663 Parse *pParse; /* Parsing context */
drh738fc792013-01-17 15:05:17 +0000664 int iOrigCol = iColumn; /* Original value of iColumn */
drh58eb1c02013-01-17 00:08:42 +0000665 int nEquiv = 2; /* Number of entires in aEquiv[] */
666 int iEquiv = 2; /* Number of entries of aEquiv[] processed so far */
667 int aEquiv[22]; /* iCur,iColumn and up to 10 other equivalents */
drh7a5bcc02013-01-16 17:08:58 +0000668
drh22c24032008-07-09 13:28:53 +0000669 assert( iCur>=0 );
drh7a5bcc02013-01-16 17:08:58 +0000670 aEquiv[0] = iCur;
671 aEquiv[1] = iColumn;
672 for(;;){
673 for(pWC=pWCOrig; pWC; pWC=pWC->pOuter){
674 for(pTerm=pWC->a, k=pWC->nTerm; k; k--, pTerm++){
675 if( pTerm->leftCursor==iCur
676 && pTerm->u.leftColumn==iColumn
drh7a5bcc02013-01-16 17:08:58 +0000677 ){
drh738fc792013-01-17 15:05:17 +0000678 if( (pTerm->prereqRight & notReady)==0
679 && (pTerm->eOperator & op & WO_ALL)!=0
680 ){
681 if( iOrigCol>=0 && pIdx && (pTerm->eOperator & WO_ISNULL)==0 ){
drh7a5bcc02013-01-16 17:08:58 +0000682 CollSeq *pColl;
683 char idxaff;
684
685 pX = pTerm->pExpr;
686 pParse = pWC->pParse;
drh738fc792013-01-17 15:05:17 +0000687 idxaff = pIdx->pTable->aCol[iOrigCol].affinity;
drh63db0392013-01-17 16:18:55 +0000688 if( !sqlite3IndexAffinityOk(pX, idxaff) ){
689 continue;
690 }
drh7a5bcc02013-01-16 17:08:58 +0000691
692 /* Figure out the collation sequence required from an index for
693 ** it to be useful for optimising expression pX. Store this
694 ** value in variable pColl.
695 */
696 assert(pX->pLeft);
697 pColl = sqlite3BinaryCompareCollSeq(pParse,pX->pLeft,pX->pRight);
698 if( pColl==0 ) pColl = pParse->db->pDfltColl;
699
drh738fc792013-01-17 15:05:17 +0000700 for(j=0; pIdx->aiColumn[j]!=iOrigCol; j++){
drh7a5bcc02013-01-16 17:08:58 +0000701 if( NEVER(j>=pIdx->nColumn) ) return 0;
702 }
drh63db0392013-01-17 16:18:55 +0000703 if( sqlite3StrICmp(pColl->zName, pIdx->azColl[j]) ){
704 continue;
705 }
drh7a5bcc02013-01-16 17:08:58 +0000706 }
707 pResult = pTerm;
708 if( pTerm->prereqRight==0 ) goto findTerm_success;
drh8871ef52011-10-07 13:33:10 +0000709 }
drh738fc792013-01-17 15:05:17 +0000710 if( (pTerm->eOperator & WO_EQUIV)!=0
drh7a5bcc02013-01-16 17:08:58 +0000711 && nEquiv<ArraySize(aEquiv)
712 ){
713 pX = sqlite3ExprSkipCollate(pTerm->pExpr->pRight);
714 assert( pX->op==TK_COLUMN );
715 for(j=0; j<nEquiv; j+=2){
716 if( aEquiv[j]==pX->iTable && aEquiv[j+1]==pX->iColumn ) break;
717 }
718 if( j==nEquiv ){
719 aEquiv[j] = pX->iTable;
720 aEquiv[j+1] = pX->iColumn;
721 nEquiv += 2;
722 }
723 }
drh22c24032008-07-09 13:28:53 +0000724 }
drhfe05af82005-07-21 03:14:59 +0000725 }
drhfe05af82005-07-21 03:14:59 +0000726 }
drh7a5bcc02013-01-16 17:08:58 +0000727 if( iEquiv>=nEquiv ) break;
728 iCur = aEquiv[iEquiv++];
729 iColumn = aEquiv[iEquiv++];
drhfe05af82005-07-21 03:14:59 +0000730 }
drh7a5bcc02013-01-16 17:08:58 +0000731findTerm_success:
732 return pResult;
drhfe05af82005-07-21 03:14:59 +0000733}
734
drh6c30be82005-07-29 15:10:17 +0000735/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000736static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000737
738/*
739** Call exprAnalyze on all terms in a WHERE clause.
740**
741**
742*/
743static void exprAnalyzeAll(
744 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000745 WhereClause *pWC /* the WHERE clause to be analyzed */
746){
drh6c30be82005-07-29 15:10:17 +0000747 int i;
drh9eb20282005-08-24 03:52:18 +0000748 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000749 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000750 }
751}
752
drhd2687b72005-08-12 22:56:09 +0000753#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
754/*
755** Check to see if the given expression is a LIKE or GLOB operator that
756** can be optimized using inequality constraints. Return TRUE if it is
757** so and false if not.
758**
759** In order for the operator to be optimizible, the RHS must be a string
760** literal that does not begin with a wildcard.
761*/
762static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000763 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000764 Expr *pExpr, /* Test this expression */
dan937d0de2009-10-15 18:35:38 +0000765 Expr **ppPrefix, /* Pointer to TK_STRING expression with pattern prefix */
drh9f504ea2008-02-23 21:55:39 +0000766 int *pisComplete, /* True if the only wildcard is % in the last character */
767 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000768){
dan937d0de2009-10-15 18:35:38 +0000769 const char *z = 0; /* String on RHS of LIKE operator */
drh5bd98ae2009-01-07 18:24:03 +0000770 Expr *pRight, *pLeft; /* Right and left size of LIKE operator */
771 ExprList *pList; /* List of operands to the LIKE operator */
772 int c; /* One character in z[] */
773 int cnt; /* Number of non-wildcard prefix characters */
774 char wc[3]; /* Wildcard characters */
drh5bd98ae2009-01-07 18:24:03 +0000775 sqlite3 *db = pParse->db; /* Database connection */
dan937d0de2009-10-15 18:35:38 +0000776 sqlite3_value *pVal = 0;
777 int op; /* Opcode of pRight */
drhd64fe2f2005-08-28 17:00:23 +0000778
drh9f504ea2008-02-23 21:55:39 +0000779 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000780 return 0;
781 }
drh9f504ea2008-02-23 21:55:39 +0000782#ifdef SQLITE_EBCDIC
783 if( *pnoCase ) return 0;
784#endif
danielk19776ab3a2e2009-02-19 14:39:25 +0000785 pList = pExpr->x.pList;
drh55ef4d92005-08-14 01:20:37 +0000786 pLeft = pList->a[1].pExpr;
danc68939e2012-03-29 14:29:07 +0000787 if( pLeft->op!=TK_COLUMN
788 || sqlite3ExprAffinity(pLeft)!=SQLITE_AFF_TEXT
789 || IsVirtual(pLeft->pTab)
790 ){
drhd91ca492009-10-22 20:50:36 +0000791 /* IMP: R-02065-49465 The left-hand side of the LIKE or GLOB operator must
792 ** be the name of an indexed column with TEXT affinity. */
drhd2687b72005-08-12 22:56:09 +0000793 return 0;
794 }
drhd91ca492009-10-22 20:50:36 +0000795 assert( pLeft->iColumn!=(-1) ); /* Because IPK never has AFF_TEXT */
dan937d0de2009-10-15 18:35:38 +0000796
797 pRight = pList->a[0].pExpr;
798 op = pRight->op;
799 if( op==TK_REGISTER ){
800 op = pRight->op2;
801 }
802 if( op==TK_VARIABLE ){
803 Vdbe *pReprepare = pParse->pReprepare;
drha7044002010-09-14 18:22:59 +0000804 int iCol = pRight->iColumn;
805 pVal = sqlite3VdbeGetValue(pReprepare, iCol, SQLITE_AFF_NONE);
dan937d0de2009-10-15 18:35:38 +0000806 if( pVal && sqlite3_value_type(pVal)==SQLITE_TEXT ){
807 z = (char *)sqlite3_value_text(pVal);
808 }
drhf9b22ca2011-10-21 16:47:31 +0000809 sqlite3VdbeSetVarmask(pParse->pVdbe, iCol);
dan937d0de2009-10-15 18:35:38 +0000810 assert( pRight->op==TK_VARIABLE || pRight->op==TK_REGISTER );
811 }else if( op==TK_STRING ){
812 z = pRight->u.zToken;
813 }
814 if( z ){
shane85095702009-06-15 16:27:08 +0000815 cnt = 0;
drhb7916a72009-05-27 10:31:29 +0000816 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){
drh24fb6272009-05-01 21:13:36 +0000817 cnt++;
818 }
drh93ee23c2010-07-22 12:33:57 +0000819 if( cnt!=0 && 255!=(u8)z[cnt-1] ){
dan937d0de2009-10-15 18:35:38 +0000820 Expr *pPrefix;
drh93ee23c2010-07-22 12:33:57 +0000821 *pisComplete = c==wc[0] && z[cnt+1]==0;
dan937d0de2009-10-15 18:35:38 +0000822 pPrefix = sqlite3Expr(db, TK_STRING, z);
823 if( pPrefix ) pPrefix->u.zToken[cnt] = 0;
824 *ppPrefix = pPrefix;
825 if( op==TK_VARIABLE ){
826 Vdbe *v = pParse->pVdbe;
drhf9b22ca2011-10-21 16:47:31 +0000827 sqlite3VdbeSetVarmask(v, pRight->iColumn);
dan937d0de2009-10-15 18:35:38 +0000828 if( *pisComplete && pRight->u.zToken[1] ){
829 /* If the rhs of the LIKE expression is a variable, and the current
830 ** value of the variable means there is no need to invoke the LIKE
831 ** function, then no OP_Variable will be added to the program.
832 ** This causes problems for the sqlite3_bind_parameter_name()
drhbec451f2009-10-17 13:13:02 +0000833 ** API. To workaround them, add a dummy OP_Variable here.
834 */
835 int r1 = sqlite3GetTempReg(pParse);
836 sqlite3ExprCodeTarget(pParse, pRight, r1);
dan937d0de2009-10-15 18:35:38 +0000837 sqlite3VdbeChangeP3(v, sqlite3VdbeCurrentAddr(v)-1, 0);
drhbec451f2009-10-17 13:13:02 +0000838 sqlite3ReleaseTempReg(pParse, r1);
dan937d0de2009-10-15 18:35:38 +0000839 }
840 }
841 }else{
842 z = 0;
shane85095702009-06-15 16:27:08 +0000843 }
drhf998b732007-11-26 13:36:00 +0000844 }
dan937d0de2009-10-15 18:35:38 +0000845
846 sqlite3ValueFree(pVal);
847 return (z!=0);
drhd2687b72005-08-12 22:56:09 +0000848}
849#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
850
drhedb193b2006-06-27 13:20:21 +0000851
852#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000853/*
drh7f375902006-06-13 17:38:59 +0000854** Check to see if the given expression is of the form
855**
856** column MATCH expr
857**
858** If it is then return TRUE. If not, return FALSE.
859*/
860static int isMatchOfColumn(
861 Expr *pExpr /* Test this expression */
862){
863 ExprList *pList;
864
865 if( pExpr->op!=TK_FUNCTION ){
866 return 0;
867 }
drh33e619f2009-05-28 01:00:55 +0000868 if( sqlite3StrICmp(pExpr->u.zToken,"match")!=0 ){
drh7f375902006-06-13 17:38:59 +0000869 return 0;
870 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000871 pList = pExpr->x.pList;
drh7f375902006-06-13 17:38:59 +0000872 if( pList->nExpr!=2 ){
873 return 0;
874 }
875 if( pList->a[1].pExpr->op != TK_COLUMN ){
876 return 0;
877 }
878 return 1;
879}
drhedb193b2006-06-27 13:20:21 +0000880#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000881
882/*
drh54a167d2005-11-26 14:08:07 +0000883** If the pBase expression originated in the ON or USING clause of
884** a join, then transfer the appropriate markings over to derived.
885*/
886static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
887 pDerived->flags |= pBase->flags & EP_FromJoin;
888 pDerived->iRightJoinTable = pBase->iRightJoinTable;
889}
890
drh3e355802007-02-23 23:13:33 +0000891#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
892/*
drh1a58fe02008-12-20 02:06:13 +0000893** Analyze a term that consists of two or more OR-connected
894** subterms. So in:
drh3e355802007-02-23 23:13:33 +0000895**
drh1a58fe02008-12-20 02:06:13 +0000896** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
897** ^^^^^^^^^^^^^^^^^^^^
drh3e355802007-02-23 23:13:33 +0000898**
drh1a58fe02008-12-20 02:06:13 +0000899** This routine analyzes terms such as the middle term in the above example.
900** A WhereOrTerm object is computed and attached to the term under
901** analysis, regardless of the outcome of the analysis. Hence:
drh3e355802007-02-23 23:13:33 +0000902**
drh1a58fe02008-12-20 02:06:13 +0000903** WhereTerm.wtFlags |= TERM_ORINFO
904** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
drh3e355802007-02-23 23:13:33 +0000905**
drh1a58fe02008-12-20 02:06:13 +0000906** The term being analyzed must have two or more of OR-connected subterms.
danielk1977fdc40192008-12-29 18:33:32 +0000907** A single subterm might be a set of AND-connected sub-subterms.
drh1a58fe02008-12-20 02:06:13 +0000908** Examples of terms under analysis:
drh3e355802007-02-23 23:13:33 +0000909**
drh1a58fe02008-12-20 02:06:13 +0000910** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
911** (B) x=expr1 OR expr2=x OR x=expr3
912** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
913** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
914** (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 +0000915**
drh1a58fe02008-12-20 02:06:13 +0000916** CASE 1:
917**
drhc3e552f2013-02-08 16:04:19 +0000918** If all subterms are of the form T.C=expr for some single column of C and
drh1a58fe02008-12-20 02:06:13 +0000919** a single table T (as shown in example B above) then create a new virtual
920** term that is an equivalent IN expression. In other words, if the term
921** being analyzed is:
922**
923** x = expr1 OR expr2 = x OR x = expr3
924**
925** then create a new virtual term like this:
926**
927** x IN (expr1,expr2,expr3)
928**
929** CASE 2:
930**
931** If all subterms are indexable by a single table T, then set
932**
933** WhereTerm.eOperator = WO_OR
934** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
935**
936** A subterm is "indexable" if it is of the form
937** "T.C <op> <expr>" where C is any column of table T and
938** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
939** A subterm is also indexable if it is an AND of two or more
940** subsubterms at least one of which is indexable. Indexable AND
941** subterms have their eOperator set to WO_AND and they have
942** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
943**
944** From another point of view, "indexable" means that the subterm could
945** potentially be used with an index if an appropriate index exists.
946** This analysis does not consider whether or not the index exists; that
947** is something the bestIndex() routine will determine. This analysis
948** only looks at whether subterms appropriate for indexing exist.
949**
950** All examples A through E above all satisfy case 2. But if a term
951** also statisfies case 1 (such as B) we know that the optimizer will
952** always prefer case 1, so in that case we pretend that case 2 is not
953** satisfied.
954**
955** It might be the case that multiple tables are indexable. For example,
956** (E) above is indexable on tables P, Q, and R.
957**
958** Terms that satisfy case 2 are candidates for lookup by using
959** separate indices to find rowids for each subterm and composing
960** the union of all rowids using a RowSet object. This is similar
961** to "bitmap indices" in other database engines.
962**
963** OTHERWISE:
964**
965** If neither case 1 nor case 2 apply, then leave the eOperator set to
966** zero. This term is not useful for search.
drh3e355802007-02-23 23:13:33 +0000967*/
drh1a58fe02008-12-20 02:06:13 +0000968static void exprAnalyzeOrTerm(
969 SrcList *pSrc, /* the FROM clause */
970 WhereClause *pWC, /* the complete WHERE clause */
971 int idxTerm /* Index of the OR-term to be analyzed */
972){
973 Parse *pParse = pWC->pParse; /* Parser context */
974 sqlite3 *db = pParse->db; /* Database connection */
975 WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
976 Expr *pExpr = pTerm->pExpr; /* The expression of the term */
drh111a6a72008-12-21 03:51:16 +0000977 WhereMaskSet *pMaskSet = pWC->pMaskSet; /* Table use masks */
drh1a58fe02008-12-20 02:06:13 +0000978 int i; /* Loop counters */
979 WhereClause *pOrWc; /* Breakup of pTerm into subterms */
980 WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
981 WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
982 Bitmask chngToIN; /* Tables that might satisfy case 1 */
983 Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
drh3e355802007-02-23 23:13:33 +0000984
drh1a58fe02008-12-20 02:06:13 +0000985 /*
986 ** Break the OR clause into its separate subterms. The subterms are
987 ** stored in a WhereClause structure containing within the WhereOrInfo
988 ** object that is attached to the original OR clause term.
989 */
990 assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
991 assert( pExpr->op==TK_OR );
drh954701a2008-12-29 23:45:07 +0000992 pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
drh1a58fe02008-12-20 02:06:13 +0000993 if( pOrInfo==0 ) return;
994 pTerm->wtFlags |= TERM_ORINFO;
995 pOrWc = &pOrInfo->wc;
drh9ef61f42011-10-07 14:40:59 +0000996 whereClauseInit(pOrWc, pWC->pParse, pMaskSet, pWC->wctrlFlags);
drh1a58fe02008-12-20 02:06:13 +0000997 whereSplit(pOrWc, pExpr, TK_OR);
998 exprAnalyzeAll(pSrc, pOrWc);
999 if( db->mallocFailed ) return;
1000 assert( pOrWc->nTerm>=2 );
1001
1002 /*
1003 ** Compute the set of tables that might satisfy cases 1 or 2.
1004 */
danielk1977e672c8e2009-05-22 15:43:26 +00001005 indexable = ~(Bitmask)0;
drhc3e552f2013-02-08 16:04:19 +00001006 chngToIN = ~(Bitmask)0;
drh1a58fe02008-12-20 02:06:13 +00001007 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
1008 if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
drh29435252008-12-28 18:35:08 +00001009 WhereAndInfo *pAndInfo;
drh29435252008-12-28 18:35:08 +00001010 assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
drh1a58fe02008-12-20 02:06:13 +00001011 chngToIN = 0;
drh29435252008-12-28 18:35:08 +00001012 pAndInfo = sqlite3DbMallocRaw(db, sizeof(*pAndInfo));
1013 if( pAndInfo ){
1014 WhereClause *pAndWC;
1015 WhereTerm *pAndTerm;
1016 int j;
1017 Bitmask b = 0;
1018 pOrTerm->u.pAndInfo = pAndInfo;
1019 pOrTerm->wtFlags |= TERM_ANDINFO;
1020 pOrTerm->eOperator = WO_AND;
1021 pAndWC = &pAndInfo->wc;
drh9ef61f42011-10-07 14:40:59 +00001022 whereClauseInit(pAndWC, pWC->pParse, pMaskSet, pWC->wctrlFlags);
drh29435252008-12-28 18:35:08 +00001023 whereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
1024 exprAnalyzeAll(pSrc, pAndWC);
drh8871ef52011-10-07 13:33:10 +00001025 pAndWC->pOuter = pWC;
drh7c2fbde2009-01-07 20:58:57 +00001026 testcase( db->mallocFailed );
drh96c7a7d2009-01-10 15:34:12 +00001027 if( !db->mallocFailed ){
1028 for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
1029 assert( pAndTerm->pExpr );
1030 if( allowedOp(pAndTerm->pExpr->op) ){
1031 b |= getMask(pMaskSet, pAndTerm->leftCursor);
1032 }
drh29435252008-12-28 18:35:08 +00001033 }
1034 }
1035 indexable &= b;
1036 }
drh1a58fe02008-12-20 02:06:13 +00001037 }else if( pOrTerm->wtFlags & TERM_COPIED ){
1038 /* Skip this term for now. We revisit it when we process the
1039 ** corresponding TERM_VIRTUAL term */
1040 }else{
1041 Bitmask b;
1042 b = getMask(pMaskSet, pOrTerm->leftCursor);
1043 if( pOrTerm->wtFlags & TERM_VIRTUAL ){
1044 WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
1045 b |= getMask(pMaskSet, pOther->leftCursor);
1046 }
1047 indexable &= b;
drh7a5bcc02013-01-16 17:08:58 +00001048 if( (pOrTerm->eOperator & WO_EQ)==0 ){
drh1a58fe02008-12-20 02:06:13 +00001049 chngToIN = 0;
1050 }else{
1051 chngToIN &= b;
1052 }
1053 }
drh3e355802007-02-23 23:13:33 +00001054 }
drh1a58fe02008-12-20 02:06:13 +00001055
1056 /*
1057 ** Record the set of tables that satisfy case 2. The set might be
drh111a6a72008-12-21 03:51:16 +00001058 ** empty.
drh1a58fe02008-12-20 02:06:13 +00001059 */
1060 pOrInfo->indexable = indexable;
drh111a6a72008-12-21 03:51:16 +00001061 pTerm->eOperator = indexable==0 ? 0 : WO_OR;
drh1a58fe02008-12-20 02:06:13 +00001062
1063 /*
1064 ** chngToIN holds a set of tables that *might* satisfy case 1. But
1065 ** we have to do some additional checking to see if case 1 really
1066 ** is satisfied.
drh4e8be3b2009-06-08 17:11:08 +00001067 **
1068 ** chngToIN will hold either 0, 1, or 2 bits. The 0-bit case means
1069 ** that there is no possibility of transforming the OR clause into an
1070 ** IN operator because one or more terms in the OR clause contain
1071 ** something other than == on a column in the single table. The 1-bit
1072 ** case means that every term of the OR clause is of the form
1073 ** "table.column=expr" for some single table. The one bit that is set
1074 ** will correspond to the common table. We still need to check to make
1075 ** sure the same column is used on all terms. The 2-bit case is when
1076 ** the all terms are of the form "table1.column=table2.column". It
1077 ** might be possible to form an IN operator with either table1.column
1078 ** or table2.column as the LHS if either is common to every term of
1079 ** the OR clause.
1080 **
1081 ** Note that terms of the form "table.column1=table.column2" (the
1082 ** same table on both sizes of the ==) cannot be optimized.
drh1a58fe02008-12-20 02:06:13 +00001083 */
1084 if( chngToIN ){
1085 int okToChngToIN = 0; /* True if the conversion to IN is valid */
1086 int iColumn = -1; /* Column index on lhs of IN operator */
shane63207ab2009-02-04 01:49:30 +00001087 int iCursor = -1; /* Table cursor common to all terms */
drh1a58fe02008-12-20 02:06:13 +00001088 int j = 0; /* Loop counter */
1089
1090 /* Search for a table and column that appears on one side or the
1091 ** other of the == operator in every subterm. That table and column
1092 ** will be recorded in iCursor and iColumn. There might not be any
1093 ** such table and column. Set okToChngToIN if an appropriate table
1094 ** and column is found but leave okToChngToIN false if not found.
1095 */
1096 for(j=0; j<2 && !okToChngToIN; j++){
1097 pOrTerm = pOrWc->a;
1098 for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001099 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001100 pOrTerm->wtFlags &= ~TERM_OR_OK;
drh4e8be3b2009-06-08 17:11:08 +00001101 if( pOrTerm->leftCursor==iCursor ){
1102 /* This is the 2-bit case and we are on the second iteration and
1103 ** current term is from the first iteration. So skip this term. */
1104 assert( j==1 );
1105 continue;
1106 }
1107 if( (chngToIN & getMask(pMaskSet, pOrTerm->leftCursor))==0 ){
1108 /* This term must be of the form t1.a==t2.b where t2 is in the
1109 ** chngToIN set but t1 is not. This term will be either preceeded
1110 ** or follwed by an inverted copy (t2.b==t1.a). Skip this term
1111 ** and use its inversion. */
1112 testcase( pOrTerm->wtFlags & TERM_COPIED );
1113 testcase( pOrTerm->wtFlags & TERM_VIRTUAL );
1114 assert( pOrTerm->wtFlags & (TERM_COPIED|TERM_VIRTUAL) );
1115 continue;
1116 }
drh1a58fe02008-12-20 02:06:13 +00001117 iColumn = pOrTerm->u.leftColumn;
1118 iCursor = pOrTerm->leftCursor;
1119 break;
1120 }
1121 if( i<0 ){
drh4e8be3b2009-06-08 17:11:08 +00001122 /* No candidate table+column was found. This can only occur
1123 ** on the second iteration */
drh1a58fe02008-12-20 02:06:13 +00001124 assert( j==1 );
drh7a5bcc02013-01-16 17:08:58 +00001125 assert( IsPowerOfTwo(chngToIN) );
drh4e8be3b2009-06-08 17:11:08 +00001126 assert( chngToIN==getMask(pMaskSet, iCursor) );
drh1a58fe02008-12-20 02:06:13 +00001127 break;
1128 }
drh4e8be3b2009-06-08 17:11:08 +00001129 testcase( j==1 );
1130
1131 /* We have found a candidate table and column. Check to see if that
1132 ** table and column is common to every term in the OR clause */
drh1a58fe02008-12-20 02:06:13 +00001133 okToChngToIN = 1;
1134 for(; i>=0 && okToChngToIN; i--, pOrTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001135 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001136 if( pOrTerm->leftCursor!=iCursor ){
1137 pOrTerm->wtFlags &= ~TERM_OR_OK;
1138 }else if( pOrTerm->u.leftColumn!=iColumn ){
1139 okToChngToIN = 0;
1140 }else{
1141 int affLeft, affRight;
1142 /* If the right-hand side is also a column, then the affinities
1143 ** of both right and left sides must be such that no type
1144 ** conversions are required on the right. (Ticket #2249)
1145 */
1146 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
1147 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
1148 if( affRight!=0 && affRight!=affLeft ){
1149 okToChngToIN = 0;
1150 }else{
1151 pOrTerm->wtFlags |= TERM_OR_OK;
1152 }
1153 }
1154 }
1155 }
1156
1157 /* At this point, okToChngToIN is true if original pTerm satisfies
1158 ** case 1. In that case, construct a new virtual term that is
1159 ** pTerm converted into an IN operator.
drhe9cdcea2010-07-22 22:40:03 +00001160 **
1161 ** EV: R-00211-15100
drh1a58fe02008-12-20 02:06:13 +00001162 */
1163 if( okToChngToIN ){
1164 Expr *pDup; /* A transient duplicate expression */
1165 ExprList *pList = 0; /* The RHS of the IN operator */
1166 Expr *pLeft = 0; /* The LHS of the IN operator */
1167 Expr *pNew; /* The complete IN operator */
1168
1169 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
1170 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
drh7a5bcc02013-01-16 17:08:58 +00001171 assert( pOrTerm->eOperator & WO_EQ );
drh1a58fe02008-12-20 02:06:13 +00001172 assert( pOrTerm->leftCursor==iCursor );
1173 assert( pOrTerm->u.leftColumn==iColumn );
danielk19776ab3a2e2009-02-19 14:39:25 +00001174 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight, 0);
drhb7916a72009-05-27 10:31:29 +00001175 pList = sqlite3ExprListAppend(pWC->pParse, pList, pDup);
drh1a58fe02008-12-20 02:06:13 +00001176 pLeft = pOrTerm->pExpr->pLeft;
1177 }
1178 assert( pLeft!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001179 pDup = sqlite3ExprDup(db, pLeft, 0);
drhb7916a72009-05-27 10:31:29 +00001180 pNew = sqlite3PExpr(pParse, TK_IN, pDup, 0, 0);
drh1a58fe02008-12-20 02:06:13 +00001181 if( pNew ){
1182 int idxNew;
1183 transferJoinMarkings(pNew, pExpr);
danielk19776ab3a2e2009-02-19 14:39:25 +00001184 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
1185 pNew->x.pList = pList;
drh1a58fe02008-12-20 02:06:13 +00001186 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
1187 testcase( idxNew==0 );
1188 exprAnalyze(pSrc, pWC, idxNew);
1189 pTerm = &pWC->a[idxTerm];
1190 pWC->a[idxNew].iParent = idxTerm;
1191 pTerm->nChild = 1;
1192 }else{
1193 sqlite3ExprListDelete(db, pList);
1194 }
drh534230c2011-01-22 00:10:45 +00001195 pTerm->eOperator = WO_NOOP; /* case 1 trumps case 2 */
drh1a58fe02008-12-20 02:06:13 +00001196 }
drh3e355802007-02-23 23:13:33 +00001197 }
drh3e355802007-02-23 23:13:33 +00001198}
1199#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +00001200
drh7a5bcc02013-01-16 17:08:58 +00001201/*
drh0aa74ed2005-07-16 13:33:20 +00001202** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +00001203** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +00001204** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +00001205** structure.
drh51147ba2005-07-23 22:59:55 +00001206**
1207** If the expression is of the form "<expr> <op> X" it gets commuted
drh1a58fe02008-12-20 02:06:13 +00001208** to the standard form of "X <op> <expr>".
1209**
1210** If the expression is of the form "X <op> Y" where both X and Y are
1211** columns, then the original expression is unchanged and a new virtual
1212** term of the form "Y <op> X" is added to the WHERE clause and
1213** analyzed separately. The original term is marked with TERM_COPIED
1214** and the new term is marked with TERM_DYNAMIC (because it's pExpr
1215** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
1216** is a commuted copy of a prior term.) The original term has nChild=1
1217** and the copy has idxParent set to the index of the original term.
drh75897232000-05-29 14:26:00 +00001218*/
drh0fcef5e2005-07-19 17:38:22 +00001219static void exprAnalyze(
1220 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +00001221 WhereClause *pWC, /* the WHERE clause */
1222 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +00001223){
drh1a58fe02008-12-20 02:06:13 +00001224 WhereTerm *pTerm; /* The term to be analyzed */
drh111a6a72008-12-21 03:51:16 +00001225 WhereMaskSet *pMaskSet; /* Set of table index masks */
drh1a58fe02008-12-20 02:06:13 +00001226 Expr *pExpr; /* The expression to be analyzed */
1227 Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
1228 Bitmask prereqAll; /* Prerequesites of pExpr */
drh5e767c52010-02-25 04:15:47 +00001229 Bitmask extraRight = 0; /* Extra dependencies on LEFT JOIN */
drh1d452e12009-11-01 19:26:59 +00001230 Expr *pStr1 = 0; /* RHS of LIKE/GLOB operator */
1231 int isComplete = 0; /* RHS of LIKE/GLOB ends with wildcard */
1232 int noCase = 0; /* LIKE/GLOB distinguishes case */
drh1a58fe02008-12-20 02:06:13 +00001233 int op; /* Top-level operator. pExpr->op */
1234 Parse *pParse = pWC->pParse; /* Parsing context */
1235 sqlite3 *db = pParse->db; /* Database connection */
drh0fcef5e2005-07-19 17:38:22 +00001236
drhf998b732007-11-26 13:36:00 +00001237 if( db->mallocFailed ){
1238 return;
1239 }
1240 pTerm = &pWC->a[idxTerm];
1241 pMaskSet = pWC->pMaskSet;
drh7ee751d2012-12-19 15:53:51 +00001242 pExpr = pTerm->pExpr;
1243 assert( pExpr->op!=TK_AS && pExpr->op!=TK_COLLATE );
drh0fcef5e2005-07-19 17:38:22 +00001244 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +00001245 op = pExpr->op;
1246 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +00001247 assert( pExpr->pRight==0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001248 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1249 pTerm->prereqRight = exprSelectTableUsage(pMaskSet, pExpr->x.pSelect);
1250 }else{
1251 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->x.pList);
1252 }
drh50b39962006-10-28 00:28:09 +00001253 }else if( op==TK_ISNULL ){
1254 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +00001255 }else{
1256 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
1257 }
drh22d6a532005-09-19 21:05:48 +00001258 prereqAll = exprTableUsage(pMaskSet, pExpr);
1259 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +00001260 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
1261 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +00001262 extraRight = x-1; /* ON clause terms may not be used with an index
1263 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +00001264 }
1265 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +00001266 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +00001267 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +00001268 pTerm->eOperator = 0;
drh738fc792013-01-17 15:05:17 +00001269 if( allowedOp(op) ){
drh7a66da12012-12-07 20:31:11 +00001270 Expr *pLeft = sqlite3ExprSkipCollate(pExpr->pLeft);
1271 Expr *pRight = sqlite3ExprSkipCollate(pExpr->pRight);
drh738fc792013-01-17 15:05:17 +00001272 u16 opMask = (pTerm->prereqRight & prereqLeft)==0 ? WO_ALL : WO_EQUIV;
drh0fcef5e2005-07-19 17:38:22 +00001273 if( pLeft->op==TK_COLUMN ){
1274 pTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001275 pTerm->u.leftColumn = pLeft->iColumn;
drh738fc792013-01-17 15:05:17 +00001276 pTerm->eOperator = operatorMask(op) & opMask;
drh75897232000-05-29 14:26:00 +00001277 }
drh0fcef5e2005-07-19 17:38:22 +00001278 if( pRight && pRight->op==TK_COLUMN ){
1279 WhereTerm *pNew;
1280 Expr *pDup;
drh7a5bcc02013-01-16 17:08:58 +00001281 u16 eExtraOp = 0; /* Extra bits for pNew->eOperator */
drh0fcef5e2005-07-19 17:38:22 +00001282 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +00001283 int idxNew;
danielk19776ab3a2e2009-02-19 14:39:25 +00001284 pDup = sqlite3ExprDup(db, pExpr, 0);
drh17435752007-08-16 04:30:38 +00001285 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +00001286 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +00001287 return;
1288 }
drh9eb20282005-08-24 03:52:18 +00001289 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
1290 if( idxNew==0 ) return;
1291 pNew = &pWC->a[idxNew];
1292 pNew->iParent = idxTerm;
1293 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +00001294 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001295 pTerm->wtFlags |= TERM_COPIED;
drheb5bc922013-01-17 16:43:33 +00001296 if( pExpr->op==TK_EQ
1297 && !ExprHasProperty(pExpr, EP_FromJoin)
1298 && OptimizationEnabled(db, SQLITE_Transitive)
1299 ){
drh7a5bcc02013-01-16 17:08:58 +00001300 pTerm->eOperator |= WO_EQUIV;
1301 eExtraOp = WO_EQUIV;
1302 }
drh0fcef5e2005-07-19 17:38:22 +00001303 }else{
1304 pDup = pExpr;
1305 pNew = pTerm;
1306 }
drh7d10d5a2008-08-20 16:35:10 +00001307 exprCommute(pParse, pDup);
drhfb76f5a2012-12-08 14:16:47 +00001308 pLeft = sqlite3ExprSkipCollate(pDup->pLeft);
drh0fcef5e2005-07-19 17:38:22 +00001309 pNew->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001310 pNew->u.leftColumn = pLeft->iColumn;
drh5e767c52010-02-25 04:15:47 +00001311 testcase( (prereqLeft | extraRight) != prereqLeft );
1312 pNew->prereqRight = prereqLeft | extraRight;
drh0fcef5e2005-07-19 17:38:22 +00001313 pNew->prereqAll = prereqAll;
drh738fc792013-01-17 15:05:17 +00001314 pNew->eOperator = (operatorMask(pDup->op) + eExtraOp) & opMask;
drh75897232000-05-29 14:26:00 +00001315 }
1316 }
drhed378002005-07-28 23:12:08 +00001317
drhd2687b72005-08-12 22:56:09 +00001318#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +00001319 /* If a term is the BETWEEN operator, create two new virtual terms
drh1a58fe02008-12-20 02:06:13 +00001320 ** that define the range that the BETWEEN implements. For example:
1321 **
1322 ** a BETWEEN b AND c
1323 **
1324 ** is converted into:
1325 **
1326 ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
1327 **
1328 ** The two new terms are added onto the end of the WhereClause object.
1329 ** The new terms are "dynamic" and are children of the original BETWEEN
1330 ** term. That means that if the BETWEEN term is coded, the children are
1331 ** skipped. Or, if the children are satisfied by an index, the original
1332 ** BETWEEN term is skipped.
drhed378002005-07-28 23:12:08 +00001333 */
drh29435252008-12-28 18:35:08 +00001334 else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001335 ExprList *pList = pExpr->x.pList;
drhed378002005-07-28 23:12:08 +00001336 int i;
1337 static const u8 ops[] = {TK_GE, TK_LE};
1338 assert( pList!=0 );
1339 assert( pList->nExpr==2 );
1340 for(i=0; i<2; i++){
1341 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +00001342 int idxNew;
drhb7916a72009-05-27 10:31:29 +00001343 pNewExpr = sqlite3PExpr(pParse, ops[i],
1344 sqlite3ExprDup(db, pExpr->pLeft, 0),
danielk19776ab3a2e2009-02-19 14:39:25 +00001345 sqlite3ExprDup(db, pList->a[i].pExpr, 0), 0);
drh9eb20282005-08-24 03:52:18 +00001346 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001347 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001348 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +00001349 pTerm = &pWC->a[idxTerm];
1350 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +00001351 }
drh45b1ee42005-08-02 17:48:22 +00001352 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +00001353 }
drhd2687b72005-08-12 22:56:09 +00001354#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +00001355
danielk19771576cd92006-01-14 08:02:28 +00001356#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh1a58fe02008-12-20 02:06:13 +00001357 /* Analyze a term that is composed of two or more subterms connected by
1358 ** an OR operator.
drh6c30be82005-07-29 15:10:17 +00001359 */
1360 else if( pExpr->op==TK_OR ){
drh29435252008-12-28 18:35:08 +00001361 assert( pWC->op==TK_AND );
drh1a58fe02008-12-20 02:06:13 +00001362 exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
danielk1977f51d1bd2009-07-31 06:14:51 +00001363 pTerm = &pWC->a[idxTerm];
drh6c30be82005-07-29 15:10:17 +00001364 }
drhd2687b72005-08-12 22:56:09 +00001365#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1366
1367#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
1368 /* Add constraints to reduce the search space on a LIKE or GLOB
1369 ** operator.
drh9f504ea2008-02-23 21:55:39 +00001370 **
1371 ** A like pattern of the form "x LIKE 'abc%'" is changed into constraints
1372 **
1373 ** x>='abc' AND x<'abd' AND x LIKE 'abc%'
1374 **
1375 ** The last character of the prefix "abc" is incremented to form the
shane7bc71e52008-05-28 18:01:44 +00001376 ** termination condition "abd".
drhd2687b72005-08-12 22:56:09 +00001377 */
dan937d0de2009-10-15 18:35:38 +00001378 if( pWC->op==TK_AND
1379 && isLikeOrGlob(pParse, pExpr, &pStr1, &isComplete, &noCase)
1380 ){
drh1d452e12009-11-01 19:26:59 +00001381 Expr *pLeft; /* LHS of LIKE/GLOB operator */
1382 Expr *pStr2; /* Copy of pStr1 - RHS of LIKE/GLOB operator */
1383 Expr *pNewExpr1;
1384 Expr *pNewExpr2;
1385 int idxNew1;
1386 int idxNew2;
drhae80dde2012-12-06 21:16:43 +00001387 Token sCollSeqName; /* Name of collating sequence */
drh9eb20282005-08-24 03:52:18 +00001388
danielk19776ab3a2e2009-02-19 14:39:25 +00001389 pLeft = pExpr->x.pList->a[1].pExpr;
danielk19776ab3a2e2009-02-19 14:39:25 +00001390 pStr2 = sqlite3ExprDup(db, pStr1, 0);
drhf998b732007-11-26 13:36:00 +00001391 if( !db->mallocFailed ){
drh254993e2009-06-08 19:44:36 +00001392 u8 c, *pC; /* Last character before the first wildcard */
dan937d0de2009-10-15 18:35:38 +00001393 pC = (u8*)&pStr2->u.zToken[sqlite3Strlen30(pStr2->u.zToken)-1];
drh9f504ea2008-02-23 21:55:39 +00001394 c = *pC;
drh02a50b72008-05-26 18:33:40 +00001395 if( noCase ){
drh254993e2009-06-08 19:44:36 +00001396 /* The point is to increment the last character before the first
1397 ** wildcard. But if we increment '@', that will push it into the
1398 ** alphabetic range where case conversions will mess up the
1399 ** inequality. To avoid this, make sure to also run the full
1400 ** LIKE on all candidate expressions by clearing the isComplete flag
1401 */
drhe9cdcea2010-07-22 22:40:03 +00001402 if( c=='A'-1 ) isComplete = 0; /* EV: R-64339-08207 */
1403
drh254993e2009-06-08 19:44:36 +00001404
drh02a50b72008-05-26 18:33:40 +00001405 c = sqlite3UpperToLower[c];
1406 }
drh9f504ea2008-02-23 21:55:39 +00001407 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +00001408 }
drhae80dde2012-12-06 21:16:43 +00001409 sCollSeqName.z = noCase ? "NOCASE" : "BINARY";
1410 sCollSeqName.n = 6;
1411 pNewExpr1 = sqlite3ExprDup(db, pLeft, 0);
drh8342e492010-07-22 17:49:52 +00001412 pNewExpr1 = sqlite3PExpr(pParse, TK_GE,
drh0a8a4062012-12-07 18:38:16 +00001413 sqlite3ExprAddCollateToken(pParse,pNewExpr1,&sCollSeqName),
drhae80dde2012-12-06 21:16:43 +00001414 pStr1, 0);
drh9eb20282005-08-24 03:52:18 +00001415 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001416 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001417 exprAnalyze(pSrc, pWC, idxNew1);
drhae80dde2012-12-06 21:16:43 +00001418 pNewExpr2 = sqlite3ExprDup(db, pLeft, 0);
drh8342e492010-07-22 17:49:52 +00001419 pNewExpr2 = sqlite3PExpr(pParse, TK_LT,
drh0a8a4062012-12-07 18:38:16 +00001420 sqlite3ExprAddCollateToken(pParse,pNewExpr2,&sCollSeqName),
drhae80dde2012-12-06 21:16:43 +00001421 pStr2, 0);
drh9eb20282005-08-24 03:52:18 +00001422 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001423 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001424 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +00001425 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +00001426 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +00001427 pWC->a[idxNew1].iParent = idxTerm;
1428 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +00001429 pTerm->nChild = 2;
1430 }
1431 }
1432#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +00001433
1434#ifndef SQLITE_OMIT_VIRTUALTABLE
1435 /* Add a WO_MATCH auxiliary term to the constraint set if the
1436 ** current expression is of the form: column MATCH expr.
1437 ** This information is used by the xBestIndex methods of
1438 ** virtual tables. The native query optimizer does not attempt
1439 ** to do anything with MATCH functions.
1440 */
1441 if( isMatchOfColumn(pExpr) ){
1442 int idxNew;
1443 Expr *pRight, *pLeft;
1444 WhereTerm *pNewTerm;
1445 Bitmask prereqColumn, prereqExpr;
1446
danielk19776ab3a2e2009-02-19 14:39:25 +00001447 pRight = pExpr->x.pList->a[0].pExpr;
1448 pLeft = pExpr->x.pList->a[1].pExpr;
drh7f375902006-06-13 17:38:59 +00001449 prereqExpr = exprTableUsage(pMaskSet, pRight);
1450 prereqColumn = exprTableUsage(pMaskSet, pLeft);
1451 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +00001452 Expr *pNewExpr;
drhb7916a72009-05-27 10:31:29 +00001453 pNewExpr = sqlite3PExpr(pParse, TK_MATCH,
1454 0, sqlite3ExprDup(db, pRight, 0), 0);
drh1a90e092006-06-14 22:07:10 +00001455 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001456 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001457 pNewTerm = &pWC->a[idxNew];
1458 pNewTerm->prereqRight = prereqExpr;
1459 pNewTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001460 pNewTerm->u.leftColumn = pLeft->iColumn;
drh7f375902006-06-13 17:38:59 +00001461 pNewTerm->eOperator = WO_MATCH;
1462 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +00001463 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +00001464 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001465 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001466 pNewTerm->prereqAll = pTerm->prereqAll;
1467 }
1468 }
1469#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001470
drhfaacf172011-08-12 01:51:45 +00001471#ifdef SQLITE_ENABLE_STAT3
drhd3ed7342011-09-21 00:09:41 +00001472 /* When sqlite_stat3 histogram data is available an operator of the
drh534230c2011-01-22 00:10:45 +00001473 ** form "x IS NOT NULL" can sometimes be evaluated more efficiently
1474 ** as "x>NULL" if x is not an INTEGER PRIMARY KEY. So construct a
1475 ** virtual term of that form.
1476 **
1477 ** Note that the virtual term must be tagged with TERM_VNULL. This
1478 ** TERM_VNULL tag will suppress the not-null check at the beginning
1479 ** of the loop. Without the TERM_VNULL flag, the not-null check at
1480 ** the start of the loop will prevent any results from being returned.
1481 */
drhea6dc442011-04-08 21:35:26 +00001482 if( pExpr->op==TK_NOTNULL
1483 && pExpr->pLeft->op==TK_COLUMN
1484 && pExpr->pLeft->iColumn>=0
1485 ){
drh534230c2011-01-22 00:10:45 +00001486 Expr *pNewExpr;
1487 Expr *pLeft = pExpr->pLeft;
1488 int idxNew;
1489 WhereTerm *pNewTerm;
1490
1491 pNewExpr = sqlite3PExpr(pParse, TK_GT,
1492 sqlite3ExprDup(db, pLeft, 0),
1493 sqlite3PExpr(pParse, TK_NULL, 0, 0, 0), 0);
1494
1495 idxNew = whereClauseInsert(pWC, pNewExpr,
1496 TERM_VIRTUAL|TERM_DYNAMIC|TERM_VNULL);
drhda91e712011-02-11 06:59:02 +00001497 if( idxNew ){
1498 pNewTerm = &pWC->a[idxNew];
1499 pNewTerm->prereqRight = 0;
1500 pNewTerm->leftCursor = pLeft->iTable;
1501 pNewTerm->u.leftColumn = pLeft->iColumn;
1502 pNewTerm->eOperator = WO_GT;
1503 pNewTerm->iParent = idxTerm;
1504 pTerm = &pWC->a[idxTerm];
1505 pTerm->nChild = 1;
1506 pTerm->wtFlags |= TERM_COPIED;
1507 pNewTerm->prereqAll = pTerm->prereqAll;
1508 }
drh534230c2011-01-22 00:10:45 +00001509 }
drhfaacf172011-08-12 01:51:45 +00001510#endif /* SQLITE_ENABLE_STAT */
drh534230c2011-01-22 00:10:45 +00001511
drhdafc0ce2008-04-17 19:14:02 +00001512 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1513 ** an index for tables to the left of the join.
1514 */
1515 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001516}
1517
drh7b4fc6a2007-02-06 13:26:32 +00001518/*
dan6f343962011-07-01 18:26:40 +00001519** This function searches the expression list passed as the second argument
1520** for an expression of type TK_COLUMN that refers to the same column and
1521** uses the same collation sequence as the iCol'th column of index pIdx.
1522** Argument iBase is the cursor number used for the table that pIdx refers
1523** to.
1524**
1525** If such an expression is found, its index in pList->a[] is returned. If
1526** no expression is found, -1 is returned.
1527*/
1528static int findIndexCol(
1529 Parse *pParse, /* Parse context */
1530 ExprList *pList, /* Expression list to search */
1531 int iBase, /* Cursor for table associated with pIdx */
1532 Index *pIdx, /* Index to match column of */
1533 int iCol /* Column of index to match */
1534){
1535 int i;
1536 const char *zColl = pIdx->azColl[iCol];
1537
1538 for(i=0; i<pList->nExpr; i++){
drh580c8c12012-12-08 03:34:04 +00001539 Expr *p = sqlite3ExprSkipCollate(pList->a[i].pExpr);
drhf1d3e322011-07-09 13:00:41 +00001540 if( p->op==TK_COLUMN
1541 && p->iColumn==pIdx->aiColumn[iCol]
1542 && p->iTable==iBase
1543 ){
drh580c8c12012-12-08 03:34:04 +00001544 CollSeq *pColl = sqlite3ExprCollSeq(pParse, pList->a[i].pExpr);
drhf1d3e322011-07-09 13:00:41 +00001545 if( ALWAYS(pColl) && 0==sqlite3StrICmp(pColl->zName, zColl) ){
dan6f343962011-07-01 18:26:40 +00001546 return i;
1547 }
1548 }
1549 }
1550
1551 return -1;
1552}
1553
1554/*
1555** This routine determines if pIdx can be used to assist in processing a
1556** DISTINCT qualifier. In other words, it tests whether or not using this
1557** index for the outer loop guarantees that rows with equal values for
1558** all expressions in the pDistinct list are delivered grouped together.
1559**
1560** For example, the query
1561**
1562** SELECT DISTINCT a, b, c FROM tbl WHERE a = ?
1563**
1564** can benefit from any index on columns "b" and "c".
1565*/
1566static int isDistinctIndex(
1567 Parse *pParse, /* Parsing context */
1568 WhereClause *pWC, /* The WHERE clause */
1569 Index *pIdx, /* The index being considered */
1570 int base, /* Cursor number for the table pIdx is on */
1571 ExprList *pDistinct, /* The DISTINCT expressions */
1572 int nEqCol /* Number of index columns with == */
1573){
1574 Bitmask mask = 0; /* Mask of unaccounted for pDistinct exprs */
1575 int i; /* Iterator variable */
1576
drh04b85bc2012-10-01 17:44:05 +00001577 assert( pDistinct!=0 );
1578 if( pIdx->zName==0 || pDistinct->nExpr>=BMS ) return 0;
drhb24d83f2011-07-02 19:12:05 +00001579 testcase( pDistinct->nExpr==BMS-1 );
dan6f343962011-07-01 18:26:40 +00001580
1581 /* Loop through all the expressions in the distinct list. If any of them
1582 ** are not simple column references, return early. Otherwise, test if the
1583 ** WHERE clause contains a "col=X" clause. If it does, the expression
1584 ** can be ignored. If it does not, and the column does not belong to the
1585 ** same table as index pIdx, return early. Finally, if there is no
1586 ** matching "col=X" expression and the column is on the same table as pIdx,
1587 ** set the corresponding bit in variable mask.
1588 */
1589 for(i=0; i<pDistinct->nExpr; i++){
1590 WhereTerm *pTerm;
drh580c8c12012-12-08 03:34:04 +00001591 Expr *p = sqlite3ExprSkipCollate(pDistinct->a[i].pExpr);
dan6f343962011-07-01 18:26:40 +00001592 if( p->op!=TK_COLUMN ) return 0;
1593 pTerm = findTerm(pWC, p->iTable, p->iColumn, ~(Bitmask)0, WO_EQ, 0);
1594 if( pTerm ){
1595 Expr *pX = pTerm->pExpr;
1596 CollSeq *p1 = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
1597 CollSeq *p2 = sqlite3ExprCollSeq(pParse, p);
1598 if( p1==p2 ) continue;
1599 }
1600 if( p->iTable!=base ) return 0;
1601 mask |= (((Bitmask)1) << i);
1602 }
1603
1604 for(i=nEqCol; mask && i<pIdx->nColumn; i++){
1605 int iExpr = findIndexCol(pParse, pDistinct, base, pIdx, i);
1606 if( iExpr<0 ) break;
1607 mask &= ~(((Bitmask)1) << iExpr);
1608 }
1609
1610 return (mask==0);
1611}
1612
1613
1614/*
1615** Return true if the DISTINCT expression-list passed as the third argument
1616** is redundant. A DISTINCT list is redundant if the database contains a
1617** UNIQUE index that guarantees that the result of the query will be distinct
1618** anyway.
1619*/
1620static int isDistinctRedundant(
1621 Parse *pParse,
1622 SrcList *pTabList,
1623 WhereClause *pWC,
1624 ExprList *pDistinct
1625){
1626 Table *pTab;
1627 Index *pIdx;
1628 int i;
1629 int iBase;
1630
1631 /* If there is more than one table or sub-select in the FROM clause of
1632 ** this query, then it will not be possible to show that the DISTINCT
1633 ** clause is redundant. */
1634 if( pTabList->nSrc!=1 ) return 0;
1635 iBase = pTabList->a[0].iCursor;
1636 pTab = pTabList->a[0].pTab;
1637
dan94e08d92011-07-02 06:44:05 +00001638 /* If any of the expressions is an IPK column on table iBase, then return
1639 ** true. Note: The (p->iTable==iBase) part of this test may be false if the
1640 ** current SELECT is a correlated sub-query.
1641 */
dan6f343962011-07-01 18:26:40 +00001642 for(i=0; i<pDistinct->nExpr; i++){
drh580c8c12012-12-08 03:34:04 +00001643 Expr *p = sqlite3ExprSkipCollate(pDistinct->a[i].pExpr);
dan94e08d92011-07-02 06:44:05 +00001644 if( p->op==TK_COLUMN && p->iTable==iBase && p->iColumn<0 ) return 1;
dan6f343962011-07-01 18:26:40 +00001645 }
1646
1647 /* Loop through all indices on the table, checking each to see if it makes
1648 ** the DISTINCT qualifier redundant. It does so if:
1649 **
1650 ** 1. The index is itself UNIQUE, and
1651 **
1652 ** 2. All of the columns in the index are either part of the pDistinct
1653 ** list, or else the WHERE clause contains a term of the form "col=X",
1654 ** where X is a constant value. The collation sequences of the
1655 ** comparison and select-list expressions must match those of the index.
dan6a36f432012-04-20 16:59:24 +00001656 **
1657 ** 3. All of those index columns for which the WHERE clause does not
1658 ** contain a "col=X" term are subject to a NOT NULL constraint.
dan6f343962011-07-01 18:26:40 +00001659 */
1660 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1661 if( pIdx->onError==OE_None ) continue;
1662 for(i=0; i<pIdx->nColumn; i++){
1663 int iCol = pIdx->aiColumn[i];
dan6a36f432012-04-20 16:59:24 +00001664 if( 0==findTerm(pWC, iBase, iCol, ~(Bitmask)0, WO_EQ, pIdx) ){
1665 int iIdxCol = findIndexCol(pParse, pDistinct, iBase, pIdx, i);
1666 if( iIdxCol<0 || pTab->aCol[pIdx->aiColumn[i]].notNull==0 ){
1667 break;
1668 }
dan6f343962011-07-01 18:26:40 +00001669 }
1670 }
1671 if( i==pIdx->nColumn ){
1672 /* This index implies that the DISTINCT qualifier is redundant. */
1673 return 1;
1674 }
1675 }
1676
1677 return 0;
1678}
drh0fcef5e2005-07-19 17:38:22 +00001679
drh75897232000-05-29 14:26:00 +00001680/*
drhb6fb62d2005-09-20 08:47:20 +00001681** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +00001682** The results need not be exact. This is only used for estimating
drh909626d2008-05-30 14:58:37 +00001683** the total cost of performing operations with O(logN) or O(NlogN)
drh28c4cf42005-07-27 20:41:43 +00001684** complexity. Because N is just a guess, it is no great tragedy if
1685** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +00001686*/
1687static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +00001688 double logN = 1;
1689 double x = 10;
drh28c4cf42005-07-27 20:41:43 +00001690 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +00001691 logN += 1;
drh28c4cf42005-07-27 20:41:43 +00001692 x *= 10;
1693 }
1694 return logN;
1695}
1696
drh6d209d82006-06-27 01:54:26 +00001697/*
1698** Two routines for printing the content of an sqlite3_index_info
1699** structure. Used for testing and debugging only. If neither
1700** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1701** are no-ops.
1702*/
drh77a2a5e2007-04-06 01:04:39 +00001703#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_DEBUG)
drh6d209d82006-06-27 01:54:26 +00001704static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1705 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001706 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001707 for(i=0; i<p->nConstraint; i++){
1708 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1709 i,
1710 p->aConstraint[i].iColumn,
1711 p->aConstraint[i].iTermOffset,
1712 p->aConstraint[i].op,
1713 p->aConstraint[i].usable);
1714 }
1715 for(i=0; i<p->nOrderBy; i++){
1716 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1717 i,
1718 p->aOrderBy[i].iColumn,
1719 p->aOrderBy[i].desc);
1720 }
1721}
1722static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1723 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001724 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001725 for(i=0; i<p->nConstraint; i++){
1726 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1727 i,
1728 p->aConstraintUsage[i].argvIndex,
1729 p->aConstraintUsage[i].omit);
1730 }
1731 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1732 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1733 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1734 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
1735}
1736#else
1737#define TRACE_IDX_INPUTS(A)
1738#define TRACE_IDX_OUTPUTS(A)
1739#endif
1740
danielk19771d461462009-04-21 09:02:45 +00001741/*
1742** Required because bestIndex() is called by bestOrClauseIndex()
1743*/
drh56f1b992012-09-25 14:29:39 +00001744static void bestIndex(WhereBestIdx*);
danielk19771d461462009-04-21 09:02:45 +00001745
1746/*
1747** This routine attempts to find an scanning strategy that can be used
1748** to optimize an 'OR' expression that is part of a WHERE clause.
1749**
1750** The table associated with FROM clause term pSrc may be either a
1751** regular B-Tree table or a virtual table.
1752*/
drh56f1b992012-09-25 14:29:39 +00001753static void bestOrClauseIndex(WhereBestIdx *p){
danielk19771d461462009-04-21 09:02:45 +00001754#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drh56f1b992012-09-25 14:29:39 +00001755 WhereClause *pWC = p->pWC; /* The WHERE clause */
1756 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
1757 const int iCur = pSrc->iCursor; /* The cursor of the table */
danielk19771d461462009-04-21 09:02:45 +00001758 const Bitmask maskSrc = getMask(pWC->pMaskSet, iCur); /* Bitmask for pSrc */
1759 WhereTerm * const pWCEnd = &pWC->a[pWC->nTerm]; /* End of pWC->a[] */
drh56f1b992012-09-25 14:29:39 +00001760 WhereTerm *pTerm; /* A single term of the WHERE clause */
danielk19771d461462009-04-21 09:02:45 +00001761
drh9ef61f42011-10-07 14:40:59 +00001762 /* The OR-clause optimization is disallowed if the INDEXED BY or
1763 ** NOT INDEXED clauses are used or if the WHERE_AND_ONLY bit is set. */
drh75ad2602010-10-21 02:05:06 +00001764 if( pSrc->notIndexed || pSrc->pIndex!=0 ){
drhed754ce2010-04-15 01:04:54 +00001765 return;
1766 }
drh9ef61f42011-10-07 14:40:59 +00001767 if( pWC->wctrlFlags & WHERE_AND_ONLY ){
1768 return;
1769 }
drhed754ce2010-04-15 01:04:54 +00001770
danielk19771d461462009-04-21 09:02:45 +00001771 /* Search the WHERE clause terms for a usable WO_OR term. */
1772 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh7a5bcc02013-01-16 17:08:58 +00001773 if( (pTerm->eOperator & WO_OR)!=0
drh56f1b992012-09-25 14:29:39 +00001774 && ((pTerm->prereqAll & ~maskSrc) & p->notReady)==0
danielk19771d461462009-04-21 09:02:45 +00001775 && (pTerm->u.pOrInfo->indexable & maskSrc)!=0
1776 ){
1777 WhereClause * const pOrWC = &pTerm->u.pOrInfo->wc;
1778 WhereTerm * const pOrWCEnd = &pOrWC->a[pOrWC->nTerm];
1779 WhereTerm *pOrTerm;
1780 int flags = WHERE_MULTI_OR;
1781 double rTotal = 0;
1782 double nRow = 0;
dan5236ac12009-08-13 07:09:33 +00001783 Bitmask used = 0;
drh56f1b992012-09-25 14:29:39 +00001784 WhereBestIdx sBOI;
danielk19771d461462009-04-21 09:02:45 +00001785
drh56f1b992012-09-25 14:29:39 +00001786 sBOI = *p;
1787 sBOI.pOrderBy = 0;
1788 sBOI.pDistinct = 0;
1789 sBOI.ppIdxInfo = 0;
danielk19771d461462009-04-21 09:02:45 +00001790 for(pOrTerm=pOrWC->a; pOrTerm<pOrWCEnd; pOrTerm++){
danielk19771d461462009-04-21 09:02:45 +00001791 WHERETRACE(("... Multi-index OR testing for term %d of %d....\n",
1792 (pOrTerm - pOrWC->a), (pTerm - pWC->a)
1793 ));
drh7a5bcc02013-01-16 17:08:58 +00001794 if( (pOrTerm->eOperator& WO_AND)!=0 ){
drh56f1b992012-09-25 14:29:39 +00001795 sBOI.pWC = &pOrTerm->u.pAndInfo->wc;
1796 bestIndex(&sBOI);
danielk19771d461462009-04-21 09:02:45 +00001797 }else if( pOrTerm->leftCursor==iCur ){
1798 WhereClause tempWC;
1799 tempWC.pParse = pWC->pParse;
1800 tempWC.pMaskSet = pWC->pMaskSet;
drh8871ef52011-10-07 13:33:10 +00001801 tempWC.pOuter = pWC;
danielk19771d461462009-04-21 09:02:45 +00001802 tempWC.op = TK_AND;
1803 tempWC.a = pOrTerm;
drha2153f72011-10-18 19:14:33 +00001804 tempWC.wctrlFlags = 0;
danielk19771d461462009-04-21 09:02:45 +00001805 tempWC.nTerm = 1;
drh56f1b992012-09-25 14:29:39 +00001806 sBOI.pWC = &tempWC;
1807 bestIndex(&sBOI);
danielk19771d461462009-04-21 09:02:45 +00001808 }else{
1809 continue;
1810 }
drh56f1b992012-09-25 14:29:39 +00001811 rTotal += sBOI.cost.rCost;
1812 nRow += sBOI.cost.plan.nRow;
1813 used |= sBOI.cost.used;
1814 if( rTotal>=p->cost.rCost ) break;
danielk19771d461462009-04-21 09:02:45 +00001815 }
1816
1817 /* If there is an ORDER BY clause, increase the scan cost to account
1818 ** for the cost of the sort. */
drh56f1b992012-09-25 14:29:39 +00001819 if( p->pOrderBy!=0 ){
drhed754ce2010-04-15 01:04:54 +00001820 WHERETRACE(("... sorting increases OR cost %.9g to %.9g\n",
1821 rTotal, rTotal+nRow*estLog(nRow)));
danielk19771d461462009-04-21 09:02:45 +00001822 rTotal += nRow*estLog(nRow);
danielk19771d461462009-04-21 09:02:45 +00001823 }
1824
1825 /* If the cost of scanning using this OR term for optimization is
1826 ** less than the current cost stored in pCost, replace the contents
1827 ** of pCost. */
1828 WHERETRACE(("... multi-index OR cost=%.9g nrow=%.9g\n", rTotal, nRow));
drh56f1b992012-09-25 14:29:39 +00001829 if( rTotal<p->cost.rCost ){
1830 p->cost.rCost = rTotal;
1831 p->cost.used = used;
1832 p->cost.plan.nRow = nRow;
drhd663b5b2012-10-03 00:25:54 +00001833 p->cost.plan.nOBSat = p->i ? p->aLevel[p->i-1].plan.nOBSat : 0;
drh56f1b992012-09-25 14:29:39 +00001834 p->cost.plan.wsFlags = flags;
1835 p->cost.plan.u.pTerm = pTerm;
danielk19771d461462009-04-21 09:02:45 +00001836 }
1837 }
1838 }
1839#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1840}
1841
drhc6339082010-04-07 16:54:58 +00001842#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00001843/*
drh4139c992010-04-07 14:59:45 +00001844** Return TRUE if the WHERE clause term pTerm is of a form where it
1845** could be used with an index to access pSrc, assuming an appropriate
1846** index existed.
1847*/
1848static int termCanDriveIndex(
1849 WhereTerm *pTerm, /* WHERE clause term to check */
1850 struct SrcList_item *pSrc, /* Table we are trying to access */
1851 Bitmask notReady /* Tables in outer loops of the join */
1852){
1853 char aff;
1854 if( pTerm->leftCursor!=pSrc->iCursor ) return 0;
drh7a5bcc02013-01-16 17:08:58 +00001855 if( (pTerm->eOperator & WO_EQ)==0 ) return 0;
drh4139c992010-04-07 14:59:45 +00001856 if( (pTerm->prereqRight & notReady)!=0 ) return 0;
1857 aff = pSrc->pTab->aCol[pTerm->u.leftColumn].affinity;
1858 if( !sqlite3IndexAffinityOk(pTerm->pExpr, aff) ) return 0;
1859 return 1;
1860}
drhc6339082010-04-07 16:54:58 +00001861#endif
drh4139c992010-04-07 14:59:45 +00001862
drhc6339082010-04-07 16:54:58 +00001863#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh4139c992010-04-07 14:59:45 +00001864/*
drh8b307fb2010-04-06 15:57:05 +00001865** If the query plan for pSrc specified in pCost is a full table scan
drh4139c992010-04-07 14:59:45 +00001866** and indexing is allows (if there is no NOT INDEXED clause) and it
drh8b307fb2010-04-06 15:57:05 +00001867** possible to construct a transient index that would perform better
1868** than a full table scan even when the cost of constructing the index
1869** is taken into account, then alter the query plan to use the
1870** transient index.
1871*/
drh56f1b992012-09-25 14:29:39 +00001872static void bestAutomaticIndex(WhereBestIdx *p){
1873 Parse *pParse = p->pParse; /* The parsing context */
1874 WhereClause *pWC = p->pWC; /* The WHERE clause */
1875 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
1876 double nTableRow; /* Rows in the input table */
1877 double logN; /* log(nTableRow) */
drh8b307fb2010-04-06 15:57:05 +00001878 double costTempIdx; /* per-query cost of the transient index */
1879 WhereTerm *pTerm; /* A single term of the WHERE clause */
1880 WhereTerm *pWCEnd; /* End of pWC->a[] */
drh424aab82010-04-06 18:28:20 +00001881 Table *pTable; /* Table tht might be indexed */
drh8b307fb2010-04-06 15:57:05 +00001882
dan969e5592011-07-02 15:32:57 +00001883 if( pParse->nQueryLoop<=(double)1 ){
1884 /* There is no point in building an automatic index for a single scan */
1885 return;
1886 }
drhc6339082010-04-07 16:54:58 +00001887 if( (pParse->db->flags & SQLITE_AutoIndex)==0 ){
1888 /* Automatic indices are disabled at run-time */
1889 return;
1890 }
drh447b2892012-10-26 18:40:01 +00001891 if( (p->cost.plan.wsFlags & WHERE_NOT_FULLSCAN)!=0
1892 && (p->cost.plan.wsFlags & WHERE_COVER_SCAN)==0
1893 ){
drh8b307fb2010-04-06 15:57:05 +00001894 /* We already have some kind of index in use for this query. */
1895 return;
1896 }
drhda998c82012-10-30 15:31:31 +00001897 if( pSrc->viaCoroutine ){
1898 /* Cannot index a co-routine */
1899 return;
1900 }
drh8b307fb2010-04-06 15:57:05 +00001901 if( pSrc->notIndexed ){
1902 /* The NOT INDEXED clause appears in the SQL. */
1903 return;
1904 }
danda79cf02011-07-08 16:10:54 +00001905 if( pSrc->isCorrelated ){
1906 /* The source is a correlated sub-query. No point in indexing it. */
1907 return;
1908 }
drh8b307fb2010-04-06 15:57:05 +00001909
1910 assert( pParse->nQueryLoop >= (double)1 );
drh8bd54122010-04-08 15:00:59 +00001911 pTable = pSrc->pTab;
drh15564052010-09-25 22:32:56 +00001912 nTableRow = pTable->nRowEst;
drh8b307fb2010-04-06 15:57:05 +00001913 logN = estLog(nTableRow);
1914 costTempIdx = 2*logN*(nTableRow/pParse->nQueryLoop + 1);
drh56f1b992012-09-25 14:29:39 +00001915 if( costTempIdx>=p->cost.rCost ){
drh8b307fb2010-04-06 15:57:05 +00001916 /* The cost of creating the transient table would be greater than
1917 ** doing the full table scan */
1918 return;
1919 }
1920
1921 /* Search for any equality comparison term */
1922 pWCEnd = &pWC->a[pWC->nTerm];
1923 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh56f1b992012-09-25 14:29:39 +00001924 if( termCanDriveIndex(pTerm, pSrc, p->notReady) ){
drh7924f3e2011-02-09 03:04:27 +00001925 WHERETRACE(("auto-index reduces cost from %.1f to %.1f\n",
drh56f1b992012-09-25 14:29:39 +00001926 p->cost.rCost, costTempIdx));
1927 p->cost.rCost = costTempIdx;
1928 p->cost.plan.nRow = logN + 1;
1929 p->cost.plan.wsFlags = WHERE_TEMP_INDEX;
1930 p->cost.used = pTerm->prereqRight;
drh8b307fb2010-04-06 15:57:05 +00001931 break;
1932 }
1933 }
1934}
drhc6339082010-04-07 16:54:58 +00001935#else
drh56f1b992012-09-25 14:29:39 +00001936# define bestAutomaticIndex(A) /* no-op */
drhc6339082010-04-07 16:54:58 +00001937#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh8b307fb2010-04-06 15:57:05 +00001938
drhc6339082010-04-07 16:54:58 +00001939
1940#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00001941/*
drhc6339082010-04-07 16:54:58 +00001942** Generate code to construct the Index object for an automatic index
1943** and to set up the WhereLevel object pLevel so that the code generator
1944** makes use of the automatic index.
drh8b307fb2010-04-06 15:57:05 +00001945*/
drhc6339082010-04-07 16:54:58 +00001946static void constructAutomaticIndex(
drh8b307fb2010-04-06 15:57:05 +00001947 Parse *pParse, /* The parsing context */
1948 WhereClause *pWC, /* The WHERE clause */
1949 struct SrcList_item *pSrc, /* The FROM clause term to get the next index */
1950 Bitmask notReady, /* Mask of cursors that are not available */
1951 WhereLevel *pLevel /* Write new index here */
1952){
1953 int nColumn; /* Number of columns in the constructed index */
1954 WhereTerm *pTerm; /* A single term of the WHERE clause */
1955 WhereTerm *pWCEnd; /* End of pWC->a[] */
1956 int nByte; /* Byte of memory needed for pIdx */
1957 Index *pIdx; /* Object describing the transient index */
1958 Vdbe *v; /* Prepared statement under construction */
drh8b307fb2010-04-06 15:57:05 +00001959 int addrInit; /* Address of the initialization bypass jump */
1960 Table *pTable; /* The table being indexed */
1961 KeyInfo *pKeyinfo; /* Key information for the index */
1962 int addrTop; /* Top of the index fill loop */
1963 int regRecord; /* Register holding an index record */
1964 int n; /* Column counter */
drh4139c992010-04-07 14:59:45 +00001965 int i; /* Loop counter */
1966 int mxBitCol; /* Maximum column in pSrc->colUsed */
drh424aab82010-04-06 18:28:20 +00001967 CollSeq *pColl; /* Collating sequence to on a column */
drh4139c992010-04-07 14:59:45 +00001968 Bitmask idxCols; /* Bitmap of columns used for indexing */
1969 Bitmask extraCols; /* Bitmap of additional columns */
drh8b307fb2010-04-06 15:57:05 +00001970
1971 /* Generate code to skip over the creation and initialization of the
1972 ** transient index on 2nd and subsequent iterations of the loop. */
1973 v = pParse->pVdbe;
1974 assert( v!=0 );
dan1d8cb212011-12-09 13:24:16 +00001975 addrInit = sqlite3CodeOnce(pParse);
drh8b307fb2010-04-06 15:57:05 +00001976
drh4139c992010-04-07 14:59:45 +00001977 /* Count the number of columns that will be added to the index
1978 ** and used to match WHERE clause constraints */
drh8b307fb2010-04-06 15:57:05 +00001979 nColumn = 0;
drh424aab82010-04-06 18:28:20 +00001980 pTable = pSrc->pTab;
drh8b307fb2010-04-06 15:57:05 +00001981 pWCEnd = &pWC->a[pWC->nTerm];
drh4139c992010-04-07 14:59:45 +00001982 idxCols = 0;
drh8b307fb2010-04-06 15:57:05 +00001983 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00001984 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
1985 int iCol = pTerm->u.leftColumn;
drh0013e722010-04-08 00:40:15 +00001986 Bitmask cMask = iCol>=BMS ? ((Bitmask)1)<<(BMS-1) : ((Bitmask)1)<<iCol;
drh52ff8ea2010-04-08 14:15:56 +00001987 testcase( iCol==BMS );
1988 testcase( iCol==BMS-1 );
drh0013e722010-04-08 00:40:15 +00001989 if( (idxCols & cMask)==0 ){
1990 nColumn++;
1991 idxCols |= cMask;
1992 }
drh8b307fb2010-04-06 15:57:05 +00001993 }
1994 }
1995 assert( nColumn>0 );
drh424aab82010-04-06 18:28:20 +00001996 pLevel->plan.nEq = nColumn;
drh4139c992010-04-07 14:59:45 +00001997
1998 /* Count the number of additional columns needed to create a
1999 ** covering index. A "covering index" is an index that contains all
2000 ** columns that are needed by the query. With a covering index, the
2001 ** original table never needs to be accessed. Automatic indices must
2002 ** be a covering index because the index will not be updated if the
2003 ** original table changes and the index and table cannot both be used
2004 ** if they go out of sync.
2005 */
drh0013e722010-04-08 00:40:15 +00002006 extraCols = pSrc->colUsed & (~idxCols | (((Bitmask)1)<<(BMS-1)));
drh4139c992010-04-07 14:59:45 +00002007 mxBitCol = (pTable->nCol >= BMS-1) ? BMS-1 : pTable->nCol;
drh52ff8ea2010-04-08 14:15:56 +00002008 testcase( pTable->nCol==BMS-1 );
2009 testcase( pTable->nCol==BMS-2 );
drh4139c992010-04-07 14:59:45 +00002010 for(i=0; i<mxBitCol; i++){
drh67ae0cb2010-04-08 14:38:51 +00002011 if( extraCols & (((Bitmask)1)<<i) ) nColumn++;
drh4139c992010-04-07 14:59:45 +00002012 }
2013 if( pSrc->colUsed & (((Bitmask)1)<<(BMS-1)) ){
2014 nColumn += pTable->nCol - BMS + 1;
2015 }
2016 pLevel->plan.wsFlags |= WHERE_COLUMN_EQ | WHERE_IDX_ONLY | WO_EQ;
drh8b307fb2010-04-06 15:57:05 +00002017
2018 /* Construct the Index object to describe this index */
2019 nByte = sizeof(Index);
2020 nByte += nColumn*sizeof(int); /* Index.aiColumn */
2021 nByte += nColumn*sizeof(char*); /* Index.azColl */
2022 nByte += nColumn; /* Index.aSortOrder */
2023 pIdx = sqlite3DbMallocZero(pParse->db, nByte);
2024 if( pIdx==0 ) return;
2025 pLevel->plan.u.pIdx = pIdx;
2026 pIdx->azColl = (char**)&pIdx[1];
2027 pIdx->aiColumn = (int*)&pIdx->azColl[nColumn];
2028 pIdx->aSortOrder = (u8*)&pIdx->aiColumn[nColumn];
2029 pIdx->zName = "auto-index";
2030 pIdx->nColumn = nColumn;
drh424aab82010-04-06 18:28:20 +00002031 pIdx->pTable = pTable;
drh8b307fb2010-04-06 15:57:05 +00002032 n = 0;
drh0013e722010-04-08 00:40:15 +00002033 idxCols = 0;
drh8b307fb2010-04-06 15:57:05 +00002034 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00002035 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
drh0013e722010-04-08 00:40:15 +00002036 int iCol = pTerm->u.leftColumn;
2037 Bitmask cMask = iCol>=BMS ? ((Bitmask)1)<<(BMS-1) : ((Bitmask)1)<<iCol;
2038 if( (idxCols & cMask)==0 ){
2039 Expr *pX = pTerm->pExpr;
2040 idxCols |= cMask;
2041 pIdx->aiColumn[n] = pTerm->u.leftColumn;
2042 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
drh6f2e6c02011-02-17 13:33:15 +00002043 pIdx->azColl[n] = ALWAYS(pColl) ? pColl->zName : "BINARY";
drh0013e722010-04-08 00:40:15 +00002044 n++;
2045 }
drh8b307fb2010-04-06 15:57:05 +00002046 }
2047 }
shaneh5eba1f62010-07-02 17:05:03 +00002048 assert( (u32)n==pLevel->plan.nEq );
drh4139c992010-04-07 14:59:45 +00002049
drhc6339082010-04-07 16:54:58 +00002050 /* Add additional columns needed to make the automatic index into
2051 ** a covering index */
drh4139c992010-04-07 14:59:45 +00002052 for(i=0; i<mxBitCol; i++){
drh67ae0cb2010-04-08 14:38:51 +00002053 if( extraCols & (((Bitmask)1)<<i) ){
drh4139c992010-04-07 14:59:45 +00002054 pIdx->aiColumn[n] = i;
2055 pIdx->azColl[n] = "BINARY";
2056 n++;
2057 }
2058 }
2059 if( pSrc->colUsed & (((Bitmask)1)<<(BMS-1)) ){
2060 for(i=BMS-1; i<pTable->nCol; i++){
2061 pIdx->aiColumn[n] = i;
2062 pIdx->azColl[n] = "BINARY";
2063 n++;
2064 }
2065 }
2066 assert( n==nColumn );
drh8b307fb2010-04-06 15:57:05 +00002067
drhc6339082010-04-07 16:54:58 +00002068 /* Create the automatic index */
drh8b307fb2010-04-06 15:57:05 +00002069 pKeyinfo = sqlite3IndexKeyinfo(pParse, pIdx);
2070 assert( pLevel->iIdxCur>=0 );
drha21a64d2010-04-06 22:33:55 +00002071 sqlite3VdbeAddOp4(v, OP_OpenAutoindex, pLevel->iIdxCur, nColumn+1, 0,
drh8b307fb2010-04-06 15:57:05 +00002072 (char*)pKeyinfo, P4_KEYINFO_HANDOFF);
drha21a64d2010-04-06 22:33:55 +00002073 VdbeComment((v, "for %s", pTable->zName));
drh8b307fb2010-04-06 15:57:05 +00002074
drhc6339082010-04-07 16:54:58 +00002075 /* Fill the automatic index with content */
drh8b307fb2010-04-06 15:57:05 +00002076 addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, pLevel->iTabCur);
2077 regRecord = sqlite3GetTempReg(pParse);
2078 sqlite3GenerateIndexKey(pParse, pIdx, pLevel->iTabCur, regRecord, 1);
2079 sqlite3VdbeAddOp2(v, OP_IdxInsert, pLevel->iIdxCur, regRecord);
2080 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2081 sqlite3VdbeAddOp2(v, OP_Next, pLevel->iTabCur, addrTop+1);
drha21a64d2010-04-06 22:33:55 +00002082 sqlite3VdbeChangeP5(v, SQLITE_STMTSTATUS_AUTOINDEX);
drh8b307fb2010-04-06 15:57:05 +00002083 sqlite3VdbeJumpHere(v, addrTop);
2084 sqlite3ReleaseTempReg(pParse, regRecord);
2085
2086 /* Jump here when skipping the initialization */
2087 sqlite3VdbeJumpHere(v, addrInit);
2088}
drhc6339082010-04-07 16:54:58 +00002089#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh8b307fb2010-04-06 15:57:05 +00002090
drh9eff6162006-06-12 21:59:13 +00002091#ifndef SQLITE_OMIT_VIRTUALTABLE
2092/*
danielk19771d461462009-04-21 09:02:45 +00002093** Allocate and populate an sqlite3_index_info structure. It is the
2094** responsibility of the caller to eventually release the structure
2095** by passing the pointer returned by this function to sqlite3_free().
2096*/
drh56f1b992012-09-25 14:29:39 +00002097static sqlite3_index_info *allocateIndexInfo(WhereBestIdx *p){
2098 Parse *pParse = p->pParse;
2099 WhereClause *pWC = p->pWC;
2100 struct SrcList_item *pSrc = p->pSrc;
2101 ExprList *pOrderBy = p->pOrderBy;
danielk19771d461462009-04-21 09:02:45 +00002102 int i, j;
2103 int nTerm;
2104 struct sqlite3_index_constraint *pIdxCons;
2105 struct sqlite3_index_orderby *pIdxOrderBy;
2106 struct sqlite3_index_constraint_usage *pUsage;
2107 WhereTerm *pTerm;
2108 int nOrderBy;
2109 sqlite3_index_info *pIdxInfo;
2110
2111 WHERETRACE(("Recomputing index info for %s...\n", pSrc->pTab->zName));
2112
2113 /* Count the number of possible WHERE clause constraints referring
2114 ** to this virtual table */
2115 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
2116 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh7a5bcc02013-01-16 17:08:58 +00002117 assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
2118 testcase( pTerm->eOperator & WO_IN );
2119 testcase( pTerm->eOperator & WO_ISNULL );
drh281bbe22012-10-16 23:17:14 +00002120 if( pTerm->eOperator & (WO_ISNULL) ) continue;
drhb4256992011-08-02 01:57:39 +00002121 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00002122 nTerm++;
2123 }
2124
2125 /* If the ORDER BY clause contains only columns in the current
2126 ** virtual table then allocate space for the aOrderBy part of
2127 ** the sqlite3_index_info structure.
2128 */
2129 nOrderBy = 0;
2130 if( pOrderBy ){
drh56f1b992012-09-25 14:29:39 +00002131 int n = pOrderBy->nExpr;
2132 for(i=0; i<n; i++){
danielk19771d461462009-04-21 09:02:45 +00002133 Expr *pExpr = pOrderBy->a[i].pExpr;
2134 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
2135 }
drh56f1b992012-09-25 14:29:39 +00002136 if( i==n){
2137 nOrderBy = n;
danielk19771d461462009-04-21 09:02:45 +00002138 }
2139 }
2140
2141 /* Allocate the sqlite3_index_info structure
2142 */
2143 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
2144 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
2145 + sizeof(*pIdxOrderBy)*nOrderBy );
2146 if( pIdxInfo==0 ){
2147 sqlite3ErrorMsg(pParse, "out of memory");
2148 /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
2149 return 0;
2150 }
2151
2152 /* Initialize the structure. The sqlite3_index_info structure contains
2153 ** many fields that are declared "const" to prevent xBestIndex from
2154 ** changing them. We have to do some funky casting in order to
2155 ** initialize those fields.
2156 */
2157 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
2158 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
2159 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
2160 *(int*)&pIdxInfo->nConstraint = nTerm;
2161 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
2162 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
2163 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
2164 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
2165 pUsage;
2166
2167 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
drh281bbe22012-10-16 23:17:14 +00002168 u8 op;
danielk19771d461462009-04-21 09:02:45 +00002169 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh7a5bcc02013-01-16 17:08:58 +00002170 assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
2171 testcase( pTerm->eOperator & WO_IN );
2172 testcase( pTerm->eOperator & WO_ISNULL );
drh281bbe22012-10-16 23:17:14 +00002173 if( pTerm->eOperator & (WO_ISNULL) ) continue;
drhb4256992011-08-02 01:57:39 +00002174 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00002175 pIdxCons[j].iColumn = pTerm->u.leftColumn;
2176 pIdxCons[j].iTermOffset = i;
drh7a5bcc02013-01-16 17:08:58 +00002177 op = (u8)pTerm->eOperator & WO_ALL;
drh281bbe22012-10-16 23:17:14 +00002178 if( op==WO_IN ) op = WO_EQ;
2179 pIdxCons[j].op = op;
danielk19771d461462009-04-21 09:02:45 +00002180 /* The direct assignment in the previous line is possible only because
2181 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
2182 ** following asserts verify this fact. */
2183 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
2184 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
2185 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
2186 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
2187 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
2188 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
drh281bbe22012-10-16 23:17:14 +00002189 assert( pTerm->eOperator & (WO_IN|WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
danielk19771d461462009-04-21 09:02:45 +00002190 j++;
2191 }
2192 for(i=0; i<nOrderBy; i++){
2193 Expr *pExpr = pOrderBy->a[i].pExpr;
2194 pIdxOrderBy[i].iColumn = pExpr->iColumn;
2195 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
2196 }
2197
2198 return pIdxInfo;
2199}
2200
2201/*
2202** The table object reference passed as the second argument to this function
2203** must represent a virtual table. This function invokes the xBestIndex()
2204** method of the virtual table with the sqlite3_index_info pointer passed
2205** as the argument.
2206**
2207** If an error occurs, pParse is populated with an error message and a
2208** non-zero value is returned. Otherwise, 0 is returned and the output
2209** part of the sqlite3_index_info structure is left populated.
2210**
2211** Whether or not an error is returned, it is the responsibility of the
2212** caller to eventually free p->idxStr if p->needToFreeIdxStr indicates
2213** that this is required.
2214*/
2215static int vtabBestIndex(Parse *pParse, Table *pTab, sqlite3_index_info *p){
danielk1977595a5232009-07-24 17:58:53 +00002216 sqlite3_vtab *pVtab = sqlite3GetVTable(pParse->db, pTab)->pVtab;
danielk19771d461462009-04-21 09:02:45 +00002217 int i;
2218 int rc;
2219
danielk19771d461462009-04-21 09:02:45 +00002220 WHERETRACE(("xBestIndex for %s\n", pTab->zName));
2221 TRACE_IDX_INPUTS(p);
2222 rc = pVtab->pModule->xBestIndex(pVtab, p);
2223 TRACE_IDX_OUTPUTS(p);
danielk19771d461462009-04-21 09:02:45 +00002224
2225 if( rc!=SQLITE_OK ){
2226 if( rc==SQLITE_NOMEM ){
2227 pParse->db->mallocFailed = 1;
2228 }else if( !pVtab->zErrMsg ){
2229 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
2230 }else{
2231 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
2232 }
2233 }
drhb9755982010-07-24 16:34:37 +00002234 sqlite3_free(pVtab->zErrMsg);
danielk19771d461462009-04-21 09:02:45 +00002235 pVtab->zErrMsg = 0;
2236
2237 for(i=0; i<p->nConstraint; i++){
2238 if( !p->aConstraint[i].usable && p->aConstraintUsage[i].argvIndex>0 ){
2239 sqlite3ErrorMsg(pParse,
2240 "table %s: xBestIndex returned an invalid plan", pTab->zName);
2241 }
2242 }
2243
2244 return pParse->nErr;
2245}
2246
2247
2248/*
drh7f375902006-06-13 17:38:59 +00002249** Compute the best index for a virtual table.
2250**
2251** The best index is computed by the xBestIndex method of the virtual
2252** table module. This routine is really just a wrapper that sets up
2253** the sqlite3_index_info structure that is used to communicate with
2254** xBestIndex.
2255**
2256** In a join, this routine might be called multiple times for the
2257** same virtual table. The sqlite3_index_info structure is created
2258** and initialized on the first invocation and reused on all subsequent
2259** invocations. The sqlite3_index_info structure is also used when
2260** code is generated to access the virtual table. The whereInfoDelete()
2261** routine takes care of freeing the sqlite3_index_info structure after
2262** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00002263*/
drh56f1b992012-09-25 14:29:39 +00002264static void bestVirtualIndex(WhereBestIdx *p){
2265 Parse *pParse = p->pParse; /* The parsing context */
2266 WhereClause *pWC = p->pWC; /* The WHERE clause */
2267 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
drh9eff6162006-06-12 21:59:13 +00002268 Table *pTab = pSrc->pTab;
2269 sqlite3_index_info *pIdxInfo;
2270 struct sqlite3_index_constraint *pIdxCons;
drh9eff6162006-06-12 21:59:13 +00002271 struct sqlite3_index_constraint_usage *pUsage;
2272 WhereTerm *pTerm;
2273 int i, j;
2274 int nOrderBy;
drhe40ed782012-12-14 15:36:17 +00002275 int bAllowIN; /* Allow IN optimizations */
danc26c0042010-03-27 09:44:42 +00002276 double rCost;
drh9eff6162006-06-12 21:59:13 +00002277
danielk19776eacd282009-04-29 11:50:53 +00002278 /* Make sure wsFlags is initialized to some sane value. Otherwise, if the
2279 ** malloc in allocateIndexInfo() fails and this function returns leaving
2280 ** wsFlags in an uninitialized state, the caller may behave unpredictably.
2281 */
drh56f1b992012-09-25 14:29:39 +00002282 memset(&p->cost, 0, sizeof(p->cost));
2283 p->cost.plan.wsFlags = WHERE_VIRTUALTABLE;
danielk19776eacd282009-04-29 11:50:53 +00002284
drh9eff6162006-06-12 21:59:13 +00002285 /* If the sqlite3_index_info structure has not been previously
danielk19771d461462009-04-21 09:02:45 +00002286 ** allocated and initialized, then allocate and initialize it now.
drh9eff6162006-06-12 21:59:13 +00002287 */
drh56f1b992012-09-25 14:29:39 +00002288 pIdxInfo = *p->ppIdxInfo;
drh9eff6162006-06-12 21:59:13 +00002289 if( pIdxInfo==0 ){
drh56f1b992012-09-25 14:29:39 +00002290 *p->ppIdxInfo = pIdxInfo = allocateIndexInfo(p);
drh9eff6162006-06-12 21:59:13 +00002291 }
danielk1977732dc552009-04-21 17:23:04 +00002292 if( pIdxInfo==0 ){
2293 return;
2294 }
drh9eff6162006-06-12 21:59:13 +00002295
drh7f375902006-06-13 17:38:59 +00002296 /* At this point, the sqlite3_index_info structure that pIdxInfo points
2297 ** to will have been initialized, either during the current invocation or
2298 ** during some prior invocation. Now we just have to customize the
2299 ** details of pIdxInfo for the current invocation and pass it to
2300 ** xBestIndex.
2301 */
2302
danielk1977935ed5e2007-03-30 09:13:13 +00002303 /* The module name must be defined. Also, by this point there must
2304 ** be a pointer to an sqlite3_vtab structure. Otherwise
2305 ** sqlite3ViewGetColumnNames() would have picked up the error.
2306 */
drh9eff6162006-06-12 21:59:13 +00002307 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
danielk1977595a5232009-07-24 17:58:53 +00002308 assert( sqlite3GetVTable(pParse->db, pTab) );
drh9eff6162006-06-12 21:59:13 +00002309
drhe40ed782012-12-14 15:36:17 +00002310 /* Try once or twice. On the first attempt, allow IN optimizations.
drhd0302532012-12-14 17:48:08 +00002311 ** If an IN optimization is accepted by the virtual table xBestIndex
2312 ** method, but the pInfo->aConstrainUsage.omit flag is not set, then
2313 ** the query will not work because it might allow duplicate rows in
2314 ** output. In that case, run the xBestIndex method a second time
2315 ** without the IN constraints. Usually this loop only runs once.
2316 ** The loop will exit using a "break" statement.
drh9eff6162006-06-12 21:59:13 +00002317 */
drhd0302532012-12-14 17:48:08 +00002318 for(bAllowIN=1; 1; bAllowIN--){
2319 assert( bAllowIN==0 || bAllowIN==1 );
2320
drhe40ed782012-12-14 15:36:17 +00002321 /* Set the aConstraint[].usable fields and initialize all
2322 ** output variables to zero.
2323 **
2324 ** aConstraint[].usable is true for constraints where the right-hand
2325 ** side contains only references to tables to the left of the current
2326 ** table. In other words, if the constraint is of the form:
2327 **
2328 ** column = expr
2329 **
2330 ** and we are evaluating a join, then the constraint on column is
2331 ** only valid if all tables referenced in expr occur to the left
2332 ** of the table containing column.
2333 **
2334 ** The aConstraints[] array contains entries for all constraints
2335 ** on the current table. That way we only have to compute it once
2336 ** even though we might try to pick the best index multiple times.
2337 ** For each attempt at picking an index, the order of tables in the
2338 ** join might be different so we have to recompute the usable flag
2339 ** each time.
2340 */
2341 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
2342 pUsage = pIdxInfo->aConstraintUsage;
2343 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
2344 j = pIdxCons->iTermOffset;
2345 pTerm = &pWC->a[j];
2346 if( (pTerm->prereqRight&p->notReady)==0
drh7a5bcc02013-01-16 17:08:58 +00002347 && (bAllowIN || (pTerm->eOperator & WO_IN)==0)
drhe40ed782012-12-14 15:36:17 +00002348 ){
2349 pIdxCons->usable = 1;
2350 }else{
2351 pIdxCons->usable = 0;
2352 }
dan5236ac12009-08-13 07:09:33 +00002353 }
drhe40ed782012-12-14 15:36:17 +00002354 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
2355 if( pIdxInfo->needToFreeIdxStr ){
2356 sqlite3_free(pIdxInfo->idxStr);
2357 }
2358 pIdxInfo->idxStr = 0;
2359 pIdxInfo->idxNum = 0;
2360 pIdxInfo->needToFreeIdxStr = 0;
2361 pIdxInfo->orderByConsumed = 0;
2362 /* ((double)2) In case of SQLITE_OMIT_FLOATING_POINT... */
2363 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / ((double)2);
2364 nOrderBy = pIdxInfo->nOrderBy;
2365 if( !p->pOrderBy ){
2366 pIdxInfo->nOrderBy = 0;
2367 }
2368
2369 if( vtabBestIndex(pParse, pTab, pIdxInfo) ){
2370 return;
2371 }
2372
2373 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
2374 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
2375 if( pUsage[i].argvIndex>0 ){
2376 j = pIdxCons->iTermOffset;
2377 pTerm = &pWC->a[j];
2378 p->cost.used |= pTerm->prereqRight;
drh7a5bcc02013-01-16 17:08:58 +00002379 if( (pTerm->eOperator & WO_IN)!=0 && pUsage[i].omit==0 ){
drhe40ed782012-12-14 15:36:17 +00002380 /* Do not attempt to use an IN constraint if the virtual table
2381 ** says that the equivalent EQ constraint cannot be safely omitted.
2382 ** If we do attempt to use such a constraint, some rows might be
2383 ** repeated in the output. */
2384 break;
2385 }
2386 }
2387 }
2388 if( i>=pIdxInfo->nConstraint ) break;
dan5236ac12009-08-13 07:09:33 +00002389 }
drhe40ed782012-12-14 15:36:17 +00002390
danc26c0042010-03-27 09:44:42 +00002391 /* If there is an ORDER BY clause, and the selected virtual table index
2392 ** does not satisfy it, increase the cost of the scan accordingly. This
2393 ** matches the processing for non-virtual tables in bestBtreeIndex().
2394 */
2395 rCost = pIdxInfo->estimatedCost;
drh56f1b992012-09-25 14:29:39 +00002396 if( p->pOrderBy && pIdxInfo->orderByConsumed==0 ){
danc26c0042010-03-27 09:44:42 +00002397 rCost += estLog(rCost)*rCost;
2398 }
2399
danielk19771d461462009-04-21 09:02:45 +00002400 /* The cost is not allowed to be larger than SQLITE_BIG_DBL (the
2401 ** inital value of lowestCost in this loop. If it is, then the
2402 ** (cost<lowestCost) test below will never be true.
2403 **
2404 ** Use "(double)2" instead of "2.0" in case OMIT_FLOATING_POINT
2405 ** is defined.
2406 */
danc26c0042010-03-27 09:44:42 +00002407 if( (SQLITE_BIG_DBL/((double)2))<rCost ){
drh56f1b992012-09-25 14:29:39 +00002408 p->cost.rCost = (SQLITE_BIG_DBL/((double)2));
danielk19771d461462009-04-21 09:02:45 +00002409 }else{
drh56f1b992012-09-25 14:29:39 +00002410 p->cost.rCost = rCost;
danielk19771d461462009-04-21 09:02:45 +00002411 }
drh56f1b992012-09-25 14:29:39 +00002412 p->cost.plan.u.pVtabIdx = pIdxInfo;
drh5901b572009-06-10 19:33:28 +00002413 if( pIdxInfo->orderByConsumed ){
drhd663b5b2012-10-03 00:25:54 +00002414 p->cost.plan.wsFlags |= WHERE_ORDERED;
2415 p->cost.plan.nOBSat = nOrderBy;
2416 }else{
2417 p->cost.plan.nOBSat = p->i ? p->aLevel[p->i-1].plan.nOBSat : 0;
danielk19771d461462009-04-21 09:02:45 +00002418 }
drh56f1b992012-09-25 14:29:39 +00002419 p->cost.plan.nEq = 0;
danielk19771d461462009-04-21 09:02:45 +00002420 pIdxInfo->nOrderBy = nOrderBy;
2421
2422 /* Try to find a more efficient access pattern by using multiple indexes
2423 ** to optimize an OR expression within the WHERE clause.
2424 */
drh56f1b992012-09-25 14:29:39 +00002425 bestOrClauseIndex(p);
drh9eff6162006-06-12 21:59:13 +00002426}
2427#endif /* SQLITE_OMIT_VIRTUALTABLE */
2428
drhfaacf172011-08-12 01:51:45 +00002429#ifdef SQLITE_ENABLE_STAT3
drh28c4cf42005-07-27 20:41:43 +00002430/*
drhfaacf172011-08-12 01:51:45 +00002431** Estimate the location of a particular key among all keys in an
2432** index. Store the results in aStat as follows:
drhe847d322011-01-20 02:56:37 +00002433**
drhfaacf172011-08-12 01:51:45 +00002434** aStat[0] Est. number of rows less than pVal
2435** aStat[1] Est. number of rows equal to pVal
dan02fa4692009-08-17 17:06:58 +00002436**
drhfaacf172011-08-12 01:51:45 +00002437** Return SQLITE_OK on success.
dan02fa4692009-08-17 17:06:58 +00002438*/
drhfaacf172011-08-12 01:51:45 +00002439static int whereKeyStats(
dan02fa4692009-08-17 17:06:58 +00002440 Parse *pParse, /* Database connection */
2441 Index *pIdx, /* Index to consider domain of */
2442 sqlite3_value *pVal, /* Value to consider */
drhfaacf172011-08-12 01:51:45 +00002443 int roundUp, /* Round up if true. Round down if false */
2444 tRowcnt *aStat /* OUT: stats written here */
dan02fa4692009-08-17 17:06:58 +00002445){
drhfaacf172011-08-12 01:51:45 +00002446 tRowcnt n;
2447 IndexSample *aSample;
2448 int i, eType;
2449 int isEq = 0;
drh4e50c5e2011-08-13 19:35:19 +00002450 i64 v;
2451 double r, rS;
dan02fa4692009-08-17 17:06:58 +00002452
drhfaacf172011-08-12 01:51:45 +00002453 assert( roundUp==0 || roundUp==1 );
drh5c624862011-09-22 18:46:34 +00002454 assert( pIdx->nSample>0 );
drhfaacf172011-08-12 01:51:45 +00002455 if( pVal==0 ) return SQLITE_ERROR;
2456 n = pIdx->aiRowEst[0];
2457 aSample = pIdx->aSample;
drhfaacf172011-08-12 01:51:45 +00002458 eType = sqlite3_value_type(pVal);
2459
2460 if( eType==SQLITE_INTEGER ){
drh4e50c5e2011-08-13 19:35:19 +00002461 v = sqlite3_value_int64(pVal);
2462 r = (i64)v;
drhfaacf172011-08-12 01:51:45 +00002463 for(i=0; i<pIdx->nSample; i++){
2464 if( aSample[i].eType==SQLITE_NULL ) continue;
2465 if( aSample[i].eType>=SQLITE_TEXT ) break;
drh4e50c5e2011-08-13 19:35:19 +00002466 if( aSample[i].eType==SQLITE_INTEGER ){
2467 if( aSample[i].u.i>=v ){
2468 isEq = aSample[i].u.i==v;
2469 break;
2470 }
2471 }else{
2472 assert( aSample[i].eType==SQLITE_FLOAT );
2473 if( aSample[i].u.r>=r ){
2474 isEq = aSample[i].u.r==r;
2475 break;
2476 }
dan02fa4692009-08-17 17:06:58 +00002477 }
drhfaacf172011-08-12 01:51:45 +00002478 }
2479 }else if( eType==SQLITE_FLOAT ){
drh4e50c5e2011-08-13 19:35:19 +00002480 r = sqlite3_value_double(pVal);
drhfaacf172011-08-12 01:51:45 +00002481 for(i=0; i<pIdx->nSample; i++){
2482 if( aSample[i].eType==SQLITE_NULL ) continue;
2483 if( aSample[i].eType>=SQLITE_TEXT ) break;
drh4e50c5e2011-08-13 19:35:19 +00002484 if( aSample[i].eType==SQLITE_FLOAT ){
2485 rS = aSample[i].u.r;
2486 }else{
2487 rS = aSample[i].u.i;
2488 }
2489 if( rS>=r ){
2490 isEq = rS==r;
drhfaacf172011-08-12 01:51:45 +00002491 break;
drh9b3eb0a2011-01-21 14:37:04 +00002492 }
drhfaacf172011-08-12 01:51:45 +00002493 }
2494 }else if( eType==SQLITE_NULL ){
2495 i = 0;
drh5c624862011-09-22 18:46:34 +00002496 if( aSample[0].eType==SQLITE_NULL ) isEq = 1;
drhfaacf172011-08-12 01:51:45 +00002497 }else{
2498 assert( eType==SQLITE_TEXT || eType==SQLITE_BLOB );
2499 for(i=0; i<pIdx->nSample; i++){
2500 if( aSample[i].eType==SQLITE_TEXT || aSample[i].eType==SQLITE_BLOB ){
2501 break;
2502 }
2503 }
2504 if( i<pIdx->nSample ){
dan02fa4692009-08-17 17:06:58 +00002505 sqlite3 *db = pParse->db;
2506 CollSeq *pColl;
2507 const u8 *z;
dan02fa4692009-08-17 17:06:58 +00002508 if( eType==SQLITE_BLOB ){
2509 z = (const u8 *)sqlite3_value_blob(pVal);
2510 pColl = db->pDfltColl;
dane275dc32009-08-18 16:24:58 +00002511 assert( pColl->enc==SQLITE_UTF8 );
dan02fa4692009-08-17 17:06:58 +00002512 }else{
drh79e72a52012-10-05 14:43:40 +00002513 pColl = sqlite3GetCollSeq(pParse, SQLITE_UTF8, 0, *pIdx->azColl);
drh9aeda792009-08-20 02:34:15 +00002514 if( pColl==0 ){
dane275dc32009-08-18 16:24:58 +00002515 return SQLITE_ERROR;
2516 }
dan02fa4692009-08-17 17:06:58 +00002517 z = (const u8 *)sqlite3ValueText(pVal, pColl->enc);
dane275dc32009-08-18 16:24:58 +00002518 if( !z ){
2519 return SQLITE_NOMEM;
2520 }
dan02fa4692009-08-17 17:06:58 +00002521 assert( z && pColl && pColl->xCmp );
2522 }
2523 n = sqlite3ValueBytes(pVal, pColl->enc);
drhfaacf172011-08-12 01:51:45 +00002524
2525 for(; i<pIdx->nSample; i++){
drhe847d322011-01-20 02:56:37 +00002526 int c;
dan02fa4692009-08-17 17:06:58 +00002527 int eSampletype = aSample[i].eType;
drhfaacf172011-08-12 01:51:45 +00002528 if( eSampletype<eType ) continue;
2529 if( eSampletype!=eType ) break;
dane83c4f32009-09-21 16:34:24 +00002530#ifndef SQLITE_OMIT_UTF16
2531 if( pColl->enc!=SQLITE_UTF8 ){
dane275dc32009-08-18 16:24:58 +00002532 int nSample;
2533 char *zSample = sqlite3Utf8to16(
dan02fa4692009-08-17 17:06:58 +00002534 db, pColl->enc, aSample[i].u.z, aSample[i].nByte, &nSample
2535 );
dane275dc32009-08-18 16:24:58 +00002536 if( !zSample ){
2537 assert( db->mallocFailed );
2538 return SQLITE_NOMEM;
2539 }
drhe847d322011-01-20 02:56:37 +00002540 c = pColl->xCmp(pColl->pUser, nSample, zSample, n, z);
dane275dc32009-08-18 16:24:58 +00002541 sqlite3DbFree(db, zSample);
dane83c4f32009-09-21 16:34:24 +00002542 }else
2543#endif
2544 {
drhe847d322011-01-20 02:56:37 +00002545 c = pColl->xCmp(pColl->pUser, aSample[i].nByte, aSample[i].u.z, n, z);
dan02fa4692009-08-17 17:06:58 +00002546 }
drhfaacf172011-08-12 01:51:45 +00002547 if( c>=0 ){
2548 if( c==0 ) isEq = 1;
2549 break;
2550 }
dan02fa4692009-08-17 17:06:58 +00002551 }
2552 }
drhfaacf172011-08-12 01:51:45 +00002553 }
dan02fa4692009-08-17 17:06:58 +00002554
drhfaacf172011-08-12 01:51:45 +00002555 /* At this point, aSample[i] is the first sample that is greater than
2556 ** or equal to pVal. Or if i==pIdx->nSample, then all samples are less
2557 ** than pVal. If aSample[i]==pVal, then isEq==1.
2558 */
2559 if( isEq ){
2560 assert( i<pIdx->nSample );
2561 aStat[0] = aSample[i].nLt;
2562 aStat[1] = aSample[i].nEq;
2563 }else{
2564 tRowcnt iLower, iUpper, iGap;
2565 if( i==0 ){
2566 iLower = 0;
2567 iUpper = aSample[0].nLt;
drhfaacf172011-08-12 01:51:45 +00002568 }else{
drh4e50c5e2011-08-13 19:35:19 +00002569 iUpper = i>=pIdx->nSample ? n : aSample[i].nLt;
drhfaacf172011-08-12 01:51:45 +00002570 iLower = aSample[i-1].nEq + aSample[i-1].nLt;
drhfaacf172011-08-12 01:51:45 +00002571 }
drh4e50c5e2011-08-13 19:35:19 +00002572 aStat[1] = pIdx->avgEq;
drhfaacf172011-08-12 01:51:45 +00002573 if( iLower>=iUpper ){
2574 iGap = 0;
2575 }else{
2576 iGap = iUpper - iLower;
drhfaacf172011-08-12 01:51:45 +00002577 }
2578 if( roundUp ){
2579 iGap = (iGap*2)/3;
2580 }else{
2581 iGap = iGap/3;
2582 }
2583 aStat[0] = iLower + iGap;
dan02fa4692009-08-17 17:06:58 +00002584 }
2585 return SQLITE_OK;
2586}
drhfaacf172011-08-12 01:51:45 +00002587#endif /* SQLITE_ENABLE_STAT3 */
dan02fa4692009-08-17 17:06:58 +00002588
2589/*
dan937d0de2009-10-15 18:35:38 +00002590** If expression pExpr represents a literal value, set *pp to point to
2591** an sqlite3_value structure containing the same value, with affinity
2592** aff applied to it, before returning. It is the responsibility of the
2593** caller to eventually release this structure by passing it to
2594** sqlite3ValueFree().
2595**
2596** If the current parse is a recompile (sqlite3Reprepare()) and pExpr
2597** is an SQL variable that currently has a non-NULL value bound to it,
2598** create an sqlite3_value structure containing this value, again with
2599** affinity aff applied to it, instead.
2600**
2601** If neither of the above apply, set *pp to NULL.
2602**
2603** If an error occurs, return an error code. Otherwise, SQLITE_OK.
2604*/
drhfaacf172011-08-12 01:51:45 +00002605#ifdef SQLITE_ENABLE_STAT3
dan937d0de2009-10-15 18:35:38 +00002606static int valueFromExpr(
2607 Parse *pParse,
2608 Expr *pExpr,
2609 u8 aff,
2610 sqlite3_value **pp
2611){
drh4278d532010-12-16 19:52:52 +00002612 if( pExpr->op==TK_VARIABLE
2613 || (pExpr->op==TK_REGISTER && pExpr->op2==TK_VARIABLE)
2614 ){
dan937d0de2009-10-15 18:35:38 +00002615 int iVar = pExpr->iColumn;
drhf9b22ca2011-10-21 16:47:31 +00002616 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan937d0de2009-10-15 18:35:38 +00002617 *pp = sqlite3VdbeGetValue(pParse->pReprepare, iVar, aff);
2618 return SQLITE_OK;
2619 }
2620 return sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, aff, pp);
2621}
danf7b0b0a2009-10-19 15:52:32 +00002622#endif
dan937d0de2009-10-15 18:35:38 +00002623
2624/*
dan02fa4692009-08-17 17:06:58 +00002625** This function is used to estimate the number of rows that will be visited
2626** by scanning an index for a range of values. The range may have an upper
2627** bound, a lower bound, or both. The WHERE clause terms that set the upper
2628** and lower bounds are represented by pLower and pUpper respectively. For
2629** example, assuming that index p is on t1(a):
2630**
2631** ... FROM t1 WHERE a > ? AND a < ? ...
2632** |_____| |_____|
2633** | |
2634** pLower pUpper
2635**
drh98cdf622009-08-20 18:14:42 +00002636** If either of the upper or lower bound is not present, then NULL is passed in
drhcdaca552009-08-20 13:45:07 +00002637** place of the corresponding WhereTerm.
dan02fa4692009-08-17 17:06:58 +00002638**
2639** The nEq parameter is passed the index of the index column subject to the
2640** range constraint. Or, equivalently, the number of equality constraints
2641** optimized by the proposed index scan. For example, assuming index p is
2642** on t1(a, b), and the SQL query is:
2643**
2644** ... FROM t1 WHERE a = ? AND b > ? AND b < ? ...
2645**
2646** then nEq should be passed the value 1 (as the range restricted column,
2647** b, is the second left-most column of the index). Or, if the query is:
2648**
2649** ... FROM t1 WHERE a > ? AND a < ? ...
2650**
2651** then nEq should be passed 0.
2652**
drhfaacf172011-08-12 01:51:45 +00002653** The returned value is an integer divisor to reduce the estimated
2654** search space. A return value of 1 means that range constraints are
2655** no help at all. A return value of 2 means range constraints are
2656** expected to reduce the search space by half. And so forth...
drh98cdf622009-08-20 18:14:42 +00002657**
drhfaacf172011-08-12 01:51:45 +00002658** In the absence of sqlite_stat3 ANALYZE data, each range inequality
2659** reduces the search space by a factor of 4. Hence a single constraint (x>?)
2660** results in a return of 4 and a range constraint (x>? AND x<?) results
2661** in a return of 16.
dan02fa4692009-08-17 17:06:58 +00002662*/
2663static int whereRangeScanEst(
drhcdaca552009-08-20 13:45:07 +00002664 Parse *pParse, /* Parsing & code generating context */
2665 Index *p, /* The index containing the range-compared column; "x" */
2666 int nEq, /* index into p->aCol[] of the range-compared column */
2667 WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
2668 WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
drh4e50c5e2011-08-13 19:35:19 +00002669 double *pRangeDiv /* OUT: Reduce search space by this divisor */
dan02fa4692009-08-17 17:06:58 +00002670){
dan69188d92009-08-19 08:18:32 +00002671 int rc = SQLITE_OK;
2672
drhfaacf172011-08-12 01:51:45 +00002673#ifdef SQLITE_ENABLE_STAT3
dan02fa4692009-08-17 17:06:58 +00002674
drhfaacf172011-08-12 01:51:45 +00002675 if( nEq==0 && p->nSample ){
2676 sqlite3_value *pRangeVal;
2677 tRowcnt iLower = 0;
2678 tRowcnt iUpper = p->aiRowEst[0];
2679 tRowcnt a[2];
dan937d0de2009-10-15 18:35:38 +00002680 u8 aff = p->pTable->aCol[p->aiColumn[0]].affinity;
drh98cdf622009-08-20 18:14:42 +00002681
dan02fa4692009-08-17 17:06:58 +00002682 if( pLower ){
2683 Expr *pExpr = pLower->pExpr->pRight;
drhfaacf172011-08-12 01:51:45 +00002684 rc = valueFromExpr(pParse, pExpr, aff, &pRangeVal);
drh7a5bcc02013-01-16 17:08:58 +00002685 assert( (pLower->eOperator & (WO_GT|WO_GE))!=0 );
drhfaacf172011-08-12 01:51:45 +00002686 if( rc==SQLITE_OK
2687 && whereKeyStats(pParse, p, pRangeVal, 0, a)==SQLITE_OK
2688 ){
2689 iLower = a[0];
drh7a5bcc02013-01-16 17:08:58 +00002690 if( (pLower->eOperator & WO_GT)!=0 ) iLower += a[1];
drhfaacf172011-08-12 01:51:45 +00002691 }
2692 sqlite3ValueFree(pRangeVal);
dan02fa4692009-08-17 17:06:58 +00002693 }
drh98cdf622009-08-20 18:14:42 +00002694 if( rc==SQLITE_OK && pUpper ){
dan02fa4692009-08-17 17:06:58 +00002695 Expr *pExpr = pUpper->pExpr->pRight;
drhfaacf172011-08-12 01:51:45 +00002696 rc = valueFromExpr(pParse, pExpr, aff, &pRangeVal);
drh7a5bcc02013-01-16 17:08:58 +00002697 assert( (pUpper->eOperator & (WO_LT|WO_LE))!=0 );
drhfaacf172011-08-12 01:51:45 +00002698 if( rc==SQLITE_OK
2699 && whereKeyStats(pParse, p, pRangeVal, 1, a)==SQLITE_OK
2700 ){
2701 iUpper = a[0];
drh7a5bcc02013-01-16 17:08:58 +00002702 if( (pUpper->eOperator & WO_LE)!=0 ) iUpper += a[1];
dan02fa4692009-08-17 17:06:58 +00002703 }
drhfaacf172011-08-12 01:51:45 +00002704 sqlite3ValueFree(pRangeVal);
dan02fa4692009-08-17 17:06:58 +00002705 }
drhfaacf172011-08-12 01:51:45 +00002706 if( rc==SQLITE_OK ){
2707 if( iUpper<=iLower ){
drh4e50c5e2011-08-13 19:35:19 +00002708 *pRangeDiv = (double)p->aiRowEst[0];
drhfaacf172011-08-12 01:51:45 +00002709 }else{
drh4e50c5e2011-08-13 19:35:19 +00002710 *pRangeDiv = (double)p->aiRowEst[0]/(double)(iUpper - iLower);
drhfaacf172011-08-12 01:51:45 +00002711 }
drh4e50c5e2011-08-13 19:35:19 +00002712 WHERETRACE(("range scan regions: %u..%u div=%g\n",
2713 (u32)iLower, (u32)iUpper, *pRangeDiv));
drhfaacf172011-08-12 01:51:45 +00002714 return SQLITE_OK;
drh98cdf622009-08-20 18:14:42 +00002715 }
dan02fa4692009-08-17 17:06:58 +00002716 }
drh3f022182009-09-09 16:10:50 +00002717#else
2718 UNUSED_PARAMETER(pParse);
2719 UNUSED_PARAMETER(p);
2720 UNUSED_PARAMETER(nEq);
dan69188d92009-08-19 08:18:32 +00002721#endif
dan02fa4692009-08-17 17:06:58 +00002722 assert( pLower || pUpper );
drh4e50c5e2011-08-13 19:35:19 +00002723 *pRangeDiv = (double)1;
2724 if( pLower && (pLower->wtFlags & TERM_VNULL)==0 ) *pRangeDiv *= (double)4;
2725 if( pUpper ) *pRangeDiv *= (double)4;
dan02fa4692009-08-17 17:06:58 +00002726 return rc;
2727}
2728
drhfaacf172011-08-12 01:51:45 +00002729#ifdef SQLITE_ENABLE_STAT3
drh82759752011-01-20 16:52:09 +00002730/*
2731** Estimate the number of rows that will be returned based on
2732** an equality constraint x=VALUE and where that VALUE occurs in
2733** the histogram data. This only works when x is the left-most
drhfaacf172011-08-12 01:51:45 +00002734** column of an index and sqlite_stat3 histogram data is available
drhac8eb112011-03-17 01:58:21 +00002735** for that index. When pExpr==NULL that means the constraint is
2736** "x IS NULL" instead of "x=VALUE".
drh82759752011-01-20 16:52:09 +00002737**
drh0c50fa02011-01-21 16:27:18 +00002738** Write the estimated row count into *pnRow and return SQLITE_OK.
2739** If unable to make an estimate, leave *pnRow unchanged and return
2740** non-zero.
drh9b3eb0a2011-01-21 14:37:04 +00002741**
2742** This routine can fail if it is unable to load a collating sequence
2743** required for string comparison, or if unable to allocate memory
2744** for a UTF conversion required for comparison. The error is stored
2745** in the pParse structure.
drh82759752011-01-20 16:52:09 +00002746*/
drh041e09f2011-04-07 19:56:21 +00002747static int whereEqualScanEst(
drh82759752011-01-20 16:52:09 +00002748 Parse *pParse, /* Parsing & code generating context */
2749 Index *p, /* The index whose left-most column is pTerm */
drh0c50fa02011-01-21 16:27:18 +00002750 Expr *pExpr, /* Expression for VALUE in the x=VALUE constraint */
drh82759752011-01-20 16:52:09 +00002751 double *pnRow /* Write the revised row estimate here */
2752){
2753 sqlite3_value *pRhs = 0; /* VALUE on right-hand side of pTerm */
drh82759752011-01-20 16:52:09 +00002754 u8 aff; /* Column affinity */
2755 int rc; /* Subfunction return code */
drhfaacf172011-08-12 01:51:45 +00002756 tRowcnt a[2]; /* Statistics */
drh82759752011-01-20 16:52:09 +00002757
2758 assert( p->aSample!=0 );
drh5c624862011-09-22 18:46:34 +00002759 assert( p->nSample>0 );
drh82759752011-01-20 16:52:09 +00002760 aff = p->pTable->aCol[p->aiColumn[0]].affinity;
drh1f9c7662011-03-17 01:34:26 +00002761 if( pExpr ){
2762 rc = valueFromExpr(pParse, pExpr, aff, &pRhs);
2763 if( rc ) goto whereEqualScanEst_cancel;
2764 }else{
2765 pRhs = sqlite3ValueNew(pParse->db);
2766 }
drh0c50fa02011-01-21 16:27:18 +00002767 if( pRhs==0 ) return SQLITE_NOTFOUND;
drhfaacf172011-08-12 01:51:45 +00002768 rc = whereKeyStats(pParse, p, pRhs, 0, a);
2769 if( rc==SQLITE_OK ){
2770 WHERETRACE(("equality scan regions: %d\n", (int)a[1]));
2771 *pnRow = a[1];
drh82759752011-01-20 16:52:09 +00002772 }
drh0c50fa02011-01-21 16:27:18 +00002773whereEqualScanEst_cancel:
drh82759752011-01-20 16:52:09 +00002774 sqlite3ValueFree(pRhs);
drh0c50fa02011-01-21 16:27:18 +00002775 return rc;
2776}
drhfaacf172011-08-12 01:51:45 +00002777#endif /* defined(SQLITE_ENABLE_STAT3) */
drh0c50fa02011-01-21 16:27:18 +00002778
drhfaacf172011-08-12 01:51:45 +00002779#ifdef SQLITE_ENABLE_STAT3
drh0c50fa02011-01-21 16:27:18 +00002780/*
2781** Estimate the number of rows that will be returned based on
drh5ac06072011-01-21 18:18:13 +00002782** an IN constraint where the right-hand side of the IN operator
2783** is a list of values. Example:
2784**
2785** WHERE x IN (1,2,3,4)
drh0c50fa02011-01-21 16:27:18 +00002786**
2787** Write the estimated row count into *pnRow and return SQLITE_OK.
2788** If unable to make an estimate, leave *pnRow unchanged and return
2789** non-zero.
2790**
2791** This routine can fail if it is unable to load a collating sequence
2792** required for string comparison, or if unable to allocate memory
2793** for a UTF conversion required for comparison. The error is stored
2794** in the pParse structure.
2795*/
drh041e09f2011-04-07 19:56:21 +00002796static int whereInScanEst(
drh0c50fa02011-01-21 16:27:18 +00002797 Parse *pParse, /* Parsing & code generating context */
2798 Index *p, /* The index whose left-most column is pTerm */
2799 ExprList *pList, /* The value list on the RHS of "x IN (v1,v2,v3,...)" */
2800 double *pnRow /* Write the revised row estimate here */
2801){
drh68257192011-08-16 17:06:21 +00002802 int rc = SQLITE_OK; /* Subfunction return code */
2803 double nEst; /* Number of rows for a single term */
2804 double nRowEst = (double)0; /* New estimate of the number of rows */
2805 int i; /* Loop counter */
drh0c50fa02011-01-21 16:27:18 +00002806
2807 assert( p->aSample!=0 );
drhfaacf172011-08-12 01:51:45 +00002808 for(i=0; rc==SQLITE_OK && i<pList->nExpr; i++){
2809 nEst = p->aiRowEst[0];
2810 rc = whereEqualScanEst(pParse, p, pList->a[i].pExpr, &nEst);
2811 nRowEst += nEst;
drh0c50fa02011-01-21 16:27:18 +00002812 }
2813 if( rc==SQLITE_OK ){
drh0c50fa02011-01-21 16:27:18 +00002814 if( nRowEst > p->aiRowEst[0] ) nRowEst = p->aiRowEst[0];
2815 *pnRow = nRowEst;
drhfaacf172011-08-12 01:51:45 +00002816 WHERETRACE(("IN row estimate: est=%g\n", nRowEst));
drh0c50fa02011-01-21 16:27:18 +00002817 }
drh0c50fa02011-01-21 16:27:18 +00002818 return rc;
drh82759752011-01-20 16:52:09 +00002819}
drhfaacf172011-08-12 01:51:45 +00002820#endif /* defined(SQLITE_ENABLE_STAT3) */
drh82759752011-01-20 16:52:09 +00002821
drh46c35f92012-09-26 23:17:01 +00002822/*
drh32634d22012-09-27 14:11:36 +00002823** Check to see if column iCol of the table with cursor iTab will appear
drh8e4af1b2012-10-08 18:23:51 +00002824** in sorted order according to the current query plan.
drh32634d22012-09-27 14:11:36 +00002825**
drh8e4af1b2012-10-08 18:23:51 +00002826** Return values:
2827**
2828** 0 iCol is not ordered
2829** 1 iCol has only a single value
2830** 2 iCol is in ASC order
2831** 3 iCol is in DESC order
drh32634d22012-09-27 14:11:36 +00002832*/
drh8e4af1b2012-10-08 18:23:51 +00002833static int isOrderedColumn(
2834 WhereBestIdx *p,
2835 int iTab,
2836 int iCol
2837){
drh32634d22012-09-27 14:11:36 +00002838 int i, j;
2839 WhereLevel *pLevel = &p->aLevel[p->i-1];
2840 Index *pIdx;
2841 u8 sortOrder;
2842 for(i=p->i-1; i>=0; i--, pLevel--){
2843 if( pLevel->iTabCur!=iTab ) continue;
drh60441af2012-09-29 19:10:29 +00002844 if( (pLevel->plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
2845 return 1;
2846 }
drh69a76ba2012-10-09 01:23:25 +00002847 assert( (pLevel->plan.wsFlags & WHERE_ORDERED)!=0 );
drhd663b5b2012-10-03 00:25:54 +00002848 if( (pIdx = pLevel->plan.u.pIdx)!=0 ){
drh6b10a6a2012-09-27 17:31:32 +00002849 if( iCol<0 ){
2850 sortOrder = 0;
2851 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
2852 }else{
drhafcd5222012-10-02 15:19:19 +00002853 int n = pIdx->nColumn;
drh178eb612012-10-02 14:11:29 +00002854 for(j=0; j<n; j++){
drh6b10a6a2012-09-27 17:31:32 +00002855 if( iCol==pIdx->aiColumn[j] ) break;
2856 }
drh178eb612012-10-02 14:11:29 +00002857 if( j>=n ) return 0;
drh6b10a6a2012-09-27 17:31:32 +00002858 sortOrder = pIdx->aSortOrder[j];
2859 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
drh32634d22012-09-27 14:11:36 +00002860 }
drh32634d22012-09-27 14:11:36 +00002861 }else{
2862 if( iCol!=(-1) ) return 0;
2863 sortOrder = 0;
drh6b10a6a2012-09-27 17:31:32 +00002864 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
drh32634d22012-09-27 14:11:36 +00002865 }
drh6b10a6a2012-09-27 17:31:32 +00002866 if( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 ){
2867 assert( sortOrder==0 || sortOrder==1 );
2868 testcase( sortOrder==1 );
2869 sortOrder = 1 - sortOrder;
2870 }
drh8e4af1b2012-10-08 18:23:51 +00002871 return sortOrder+2;
drh32634d22012-09-27 14:11:36 +00002872 }
2873 return 0;
2874}
2875
2876/*
drh60441af2012-09-29 19:10:29 +00002877** This routine decides if pIdx can be used to satisfy the ORDER BY
2878** clause, either in whole or in part. The return value is the
2879** cumulative number of terms in the ORDER BY clause that are satisfied
2880** by the index pIdx and other indices in outer loops.
2881**
2882** The table being queried has a cursor number of "base". pIdx is the
2883** index that is postulated for use to access the table.
2884**
drh60441af2012-09-29 19:10:29 +00002885** The *pbRev value is set to 0 order 1 depending on whether or not
2886** pIdx should be run in the forward order or in reverse order.
2887*/
2888static int isSortingIndex(
2889 WhereBestIdx *p, /* Best index search context */
2890 Index *pIdx, /* The index we are testing */
2891 int base, /* Cursor number for the table to be sorted */
drh60441af2012-09-29 19:10:29 +00002892 int *pbRev /* Set to 1 for reverse-order scan of pIdx */
2893){
2894 int i; /* Number of pIdx terms used */
2895 int j; /* Number of ORDER BY terms satisfied */
drh4f68d6c2012-10-04 12:10:25 +00002896 int sortOrder = 2; /* 0: forward. 1: backward. 2: unknown */
drh60441af2012-09-29 19:10:29 +00002897 int nTerm; /* Number of ORDER BY terms */
drh8e4af1b2012-10-08 18:23:51 +00002898 struct ExprList_item *pOBItem;/* A term of the ORDER BY clause */
drh4f68d6c2012-10-04 12:10:25 +00002899 Table *pTab = pIdx->pTable; /* Table that owns index pIdx */
drh60441af2012-09-29 19:10:29 +00002900 ExprList *pOrderBy; /* The ORDER BY clause */
2901 Parse *pParse = p->pParse; /* Parser context */
2902 sqlite3 *db = pParse->db; /* Database connection */
2903 int nPriorSat; /* ORDER BY terms satisfied by outer loops */
2904 int seenRowid = 0; /* True if an ORDER BY rowid term is seen */
drh0a4c7412012-10-08 19:41:38 +00002905 int uniqueNotNull; /* pIdx is UNIQUE with all terms are NOT NULL */
drh60441af2012-09-29 19:10:29 +00002906
2907 if( p->i==0 ){
2908 nPriorSat = 0;
2909 }else{
2910 nPriorSat = p->aLevel[p->i-1].plan.nOBSat;
drh0a4c7412012-10-08 19:41:38 +00002911 if( (p->aLevel[p->i-1].plan.wsFlags & WHERE_ORDERED)==0 ){
2912 /* This loop cannot be ordered unless the next outer loop is
2913 ** also ordered */
drhd663b5b2012-10-03 00:25:54 +00002914 return nPriorSat;
2915 }
drh0a4c7412012-10-08 19:41:38 +00002916 if( OptimizationDisabled(db, SQLITE_OrderByIdxJoin) ){
2917 /* Only look at the outer-most loop if the OrderByIdxJoin
2918 ** optimization is disabled */
2919 return nPriorSat;
2920 }
drh60441af2012-09-29 19:10:29 +00002921 }
2922 pOrderBy = p->pOrderBy;
2923 assert( pOrderBy!=0 );
drh0a4c7412012-10-08 19:41:38 +00002924 if( pIdx->bUnordered ){
2925 /* Hash indices (indicated by the "unordered" tag on sqlite_stat1) cannot
2926 ** be used for sorting */
2927 return nPriorSat;
2928 }
drh60441af2012-09-29 19:10:29 +00002929 nTerm = pOrderBy->nExpr;
drh8e4af1b2012-10-08 18:23:51 +00002930 uniqueNotNull = pIdx->onError!=OE_None;
drh60441af2012-09-29 19:10:29 +00002931 assert( nTerm>0 );
2932
2933 /* Argument pIdx must either point to a 'real' named index structure,
2934 ** or an index structure allocated on the stack by bestBtreeIndex() to
2935 ** represent the rowid index that is part of every table. */
2936 assert( pIdx->zName || (pIdx->nColumn==1 && pIdx->aiColumn[0]==-1) );
2937
2938 /* Match terms of the ORDER BY clause against columns of
2939 ** the index.
2940 **
2941 ** Note that indices have pIdx->nColumn regular columns plus
2942 ** one additional column containing the rowid. The rowid column
2943 ** of the index is also allowed to match against the ORDER BY
2944 ** clause.
2945 */
drh8e4af1b2012-10-08 18:23:51 +00002946 j = nPriorSat;
2947 for(i=0,pOBItem=&pOrderBy->a[j]; j<nTerm && i<=pIdx->nColumn; i++){
2948 Expr *pOBExpr; /* The expression of the ORDER BY pOBItem */
2949 CollSeq *pColl; /* The collating sequence of pOBExpr */
2950 int termSortOrder; /* Sort order for this term */
2951 int iColumn; /* The i-th column of the index. -1 for rowid */
2952 int iSortOrder; /* 1 for DESC, 0 for ASC on the i-th index term */
2953 int isEq; /* Subject to an == or IS NULL constraint */
2954 int isMatch; /* ORDER BY term matches the index term */
2955 const char *zColl; /* Name of collating sequence for i-th index term */
2956 WhereTerm *pConstraint; /* A constraint in the WHERE clause */
drh60441af2012-09-29 19:10:29 +00002957
drh8e4af1b2012-10-08 18:23:51 +00002958 /* If the next term of the ORDER BY clause refers to anything other than
2959 ** a column in the "base" table, then this index will not be of any
2960 ** further use in handling the ORDER BY. */
drh7a66da12012-12-07 20:31:11 +00002961 pOBExpr = sqlite3ExprSkipCollate(pOBItem->pExpr);
drh8e4af1b2012-10-08 18:23:51 +00002962 if( pOBExpr->op!=TK_COLUMN || pOBExpr->iTable!=base ){
drh60441af2012-09-29 19:10:29 +00002963 break;
2964 }
drh8e4af1b2012-10-08 18:23:51 +00002965
2966 /* Find column number and collating sequence for the next entry
2967 ** in the index */
drh60441af2012-09-29 19:10:29 +00002968 if( pIdx->zName && i<pIdx->nColumn ){
2969 iColumn = pIdx->aiColumn[i];
2970 if( iColumn==pIdx->pTable->iPKey ){
2971 iColumn = -1;
2972 }
2973 iSortOrder = pIdx->aSortOrder[i];
2974 zColl = pIdx->azColl[i];
drh8e4af1b2012-10-08 18:23:51 +00002975 assert( zColl!=0 );
drh60441af2012-09-29 19:10:29 +00002976 }else{
2977 iColumn = -1;
2978 iSortOrder = 0;
drh8e4af1b2012-10-08 18:23:51 +00002979 zColl = 0;
drh60441af2012-09-29 19:10:29 +00002980 }
drh8e4af1b2012-10-08 18:23:51 +00002981
2982 /* Check to see if the column number and collating sequence of the
2983 ** index match the column number and collating sequence of the ORDER BY
2984 ** clause entry. Set isMatch to 1 if they both match. */
2985 if( pOBExpr->iColumn==iColumn ){
2986 if( zColl ){
drh7a66da12012-12-07 20:31:11 +00002987 pColl = sqlite3ExprCollSeq(pParse, pOBItem->pExpr);
drh8e4af1b2012-10-08 18:23:51 +00002988 if( !pColl ) pColl = db->pDfltColl;
2989 isMatch = sqlite3StrICmp(pColl->zName, zColl)==0;
drh60441af2012-09-29 19:10:29 +00002990 }else{
drh8e4af1b2012-10-08 18:23:51 +00002991 isMatch = 1;
drh60441af2012-09-29 19:10:29 +00002992 }
2993 }else{
drh8e4af1b2012-10-08 18:23:51 +00002994 isMatch = 0;
2995 }
2996
2997 /* termSortOrder is 0 or 1 for whether or not the access loop should
2998 ** run forward or backwards (respectively) in order to satisfy this
2999 ** term of the ORDER BY clause. */
drh2f546ee2012-10-09 09:26:28 +00003000 assert( pOBItem->sortOrder==0 || pOBItem->sortOrder==1 );
3001 assert( iSortOrder==0 || iSortOrder==1 );
drh8e4af1b2012-10-08 18:23:51 +00003002 termSortOrder = iSortOrder ^ pOBItem->sortOrder;
3003
3004 /* If X is the column in the index and ORDER BY clause, check to see
3005 ** if there are any X= or X IS NULL constraints in the WHERE clause. */
3006 pConstraint = findTerm(p->pWC, base, iColumn, p->notReady,
3007 WO_EQ|WO_ISNULL|WO_IN, pIdx);
3008 if( pConstraint==0 ){
3009 isEq = 0;
drh7a5bcc02013-01-16 17:08:58 +00003010 }else if( (pConstraint->eOperator & WO_IN)!=0 ){
drh1b8fc652013-02-07 21:15:14 +00003011 isEq = 0;
drh7a5bcc02013-01-16 17:08:58 +00003012 }else if( (pConstraint->eOperator & WO_ISNULL)!=0 ){
drh8e4af1b2012-10-08 18:23:51 +00003013 uniqueNotNull = 0;
drh2f546ee2012-10-09 09:26:28 +00003014 isEq = 1; /* "X IS NULL" means X has only a single value */
drh6b9e5652012-10-08 20:27:35 +00003015 }else if( pConstraint->prereqRight==0 ){
drh2f546ee2012-10-09 09:26:28 +00003016 isEq = 1; /* Constraint "X=constant" means X has only a single value */
drh8e4af1b2012-10-08 18:23:51 +00003017 }else{
3018 Expr *pRight = pConstraint->pExpr->pRight;
3019 if( pRight->op==TK_COLUMN ){
3020 WHERETRACE((" .. isOrderedColumn(tab=%d,col=%d)",
3021 pRight->iTable, pRight->iColumn));
3022 isEq = isOrderedColumn(p, pRight->iTable, pRight->iColumn);
3023 WHERETRACE((" -> isEq=%d\n", isEq));
drh2f546ee2012-10-09 09:26:28 +00003024
3025 /* If the constraint is of the form X=Y where Y is an ordered value
3026 ** in an outer loop, then make sure the sort order of Y matches the
3027 ** sort order required for X. */
drh2fad8152012-10-08 21:01:15 +00003028 if( isMatch && isEq>=2 && isEq!=pOBItem->sortOrder+2 ){
drh2f546ee2012-10-09 09:26:28 +00003029 testcase( isEq==2 );
3030 testcase( isEq==3 );
drh8e4af1b2012-10-08 18:23:51 +00003031 break;
3032 }
3033 }else{
drh2f546ee2012-10-09 09:26:28 +00003034 isEq = 0; /* "X=expr" places no ordering constraints on X */
drh8e4af1b2012-10-08 18:23:51 +00003035 }
3036 }
drh8e4af1b2012-10-08 18:23:51 +00003037 if( !isMatch ){
3038 if( isEq==0 ){
3039 break;
3040 }else{
3041 continue;
3042 }
drh6b9e5652012-10-08 20:27:35 +00003043 }else if( isEq!=1 ){
3044 if( sortOrder==2 ){
3045 sortOrder = termSortOrder;
3046 }else if( termSortOrder!=sortOrder ){
3047 break;
3048 }
drh60441af2012-09-29 19:10:29 +00003049 }
3050 j++;
drh8e4af1b2012-10-08 18:23:51 +00003051 pOBItem++;
drh60441af2012-09-29 19:10:29 +00003052 if( iColumn<0 ){
3053 seenRowid = 1;
3054 break;
drh2f546ee2012-10-09 09:26:28 +00003055 }else if( pTab->aCol[iColumn].notNull==0 && isEq!=1 ){
3056 testcase( isEq==0 );
3057 testcase( isEq==2 );
3058 testcase( isEq==3 );
drh4f68d6c2012-10-04 12:10:25 +00003059 uniqueNotNull = 0;
drh60441af2012-09-29 19:10:29 +00003060 }
3061 }
drh0a4c7412012-10-08 19:41:38 +00003062
3063 /* If we have not found at least one ORDER BY term that matches the
3064 ** index, then show no progress. */
3065 if( pOBItem==&pOrderBy->a[nPriorSat] ) return nPriorSat;
3066
3067 /* Return the necessary scan order back to the caller */
drh4f68d6c2012-10-04 12:10:25 +00003068 *pbRev = sortOrder & 1;
drh60441af2012-09-29 19:10:29 +00003069
3070 /* If there was an "ORDER BY rowid" term that matched, or it is only
3071 ** possible for a single row from this table to match, then skip over
3072 ** any additional ORDER BY terms dealing with this table.
3073 */
drh4f68d6c2012-10-04 12:10:25 +00003074 if( seenRowid || (uniqueNotNull && i>=pIdx->nColumn) ){
drh60441af2012-09-29 19:10:29 +00003075 /* Advance j over additional ORDER BY terms associated with base */
3076 WhereMaskSet *pMS = p->pWC->pMaskSet;
3077 Bitmask m = ~getMask(pMS, base);
3078 while( j<nTerm && (exprTableUsage(pMS, pOrderBy->a[j].pExpr)&m)==0 ){
3079 j++;
3080 }
3081 }
3082 return j;
3083}
dan02fa4692009-08-17 17:06:58 +00003084
3085/*
drh083310d2011-01-28 01:57:41 +00003086** Find the best query plan for accessing a particular table. Write the
drh56f1b992012-09-25 14:29:39 +00003087** best query plan and its cost into the p->cost.
drh51147ba2005-07-23 22:59:55 +00003088**
drh111a6a72008-12-21 03:51:16 +00003089** The lowest cost plan wins. The cost is an estimate of the amount of
drh083310d2011-01-28 01:57:41 +00003090** CPU and disk I/O needed to process the requested result.
drh51147ba2005-07-23 22:59:55 +00003091** Factors that influence cost include:
3092**
3093** * The estimated number of rows that will be retrieved. (The
3094** fewer the better.)
3095**
3096** * Whether or not sorting must occur.
3097**
3098** * Whether or not there must be separate lookups in the
3099** index and in the main table.
3100**
danielk1977e2d7b242009-02-23 17:33:49 +00003101** If there was an INDEXED BY clause (pSrc->pIndex) attached to the table in
3102** the SQL statement, then this function only considers plans using the
drh296a4832009-03-22 20:36:18 +00003103** named index. If no such plan is found, then the returned cost is
3104** SQLITE_BIG_DBL. If a plan is found that uses the named index,
danielk197785574e32008-10-06 05:32:18 +00003105** then the cost is calculated in the usual way.
3106**
drh21172c42012-10-30 00:29:07 +00003107** If a NOT INDEXED clause was attached to the table
danielk1977e2d7b242009-02-23 17:33:49 +00003108** in the SELECT statement, then no indexes are considered. However, the
drh083310d2011-01-28 01:57:41 +00003109** selected plan may still take advantage of the built-in rowid primary key
danielk197785574e32008-10-06 05:32:18 +00003110** index.
drhfe05af82005-07-21 03:14:59 +00003111*/
drh56f1b992012-09-25 14:29:39 +00003112static void bestBtreeIndex(WhereBestIdx *p){
3113 Parse *pParse = p->pParse; /* The parsing context */
3114 WhereClause *pWC = p->pWC; /* The WHERE clause */
3115 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
drh51147ba2005-07-23 22:59:55 +00003116 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
3117 Index *pProbe; /* An index we are evaluating */
dan5236ac12009-08-13 07:09:33 +00003118 Index *pIdx; /* Copy of pProbe, or zero for IPK index */
3119 int eqTermMask; /* Current mask of valid equality operators */
3120 int idxEqTermMask; /* Index mask of valid equality operators */
drhcdaca552009-08-20 13:45:07 +00003121 Index sPk; /* A fake index object for the primary key */
drhfaacf172011-08-12 01:51:45 +00003122 tRowcnt aiRowEstPk[2]; /* The aiRowEst[] value for the sPk index */
drhcdaca552009-08-20 13:45:07 +00003123 int aiColumnPk = -1; /* The aColumn[] value for the sPk index */
drh56f1b992012-09-25 14:29:39 +00003124 int wsFlagMask; /* Allowed flags in p->cost.plan.wsFlag */
drh04229ac2012-12-08 22:14:29 +00003125 int nPriorSat; /* ORDER BY terms satisfied by outer loops */
3126 int nOrderBy; /* Number of ORDER BY terms */
3127 char bSortInit; /* Initializer for bSort in inner loop */
3128 char bDistInit; /* Initializer for bDist in inner loop */
3129
drhfe05af82005-07-21 03:14:59 +00003130
drhcdaca552009-08-20 13:45:07 +00003131 /* Initialize the cost to a worst-case value */
drh56f1b992012-09-25 14:29:39 +00003132 memset(&p->cost, 0, sizeof(p->cost));
3133 p->cost.rCost = SQLITE_BIG_DBL;
drh51147ba2005-07-23 22:59:55 +00003134
drhc49de5d2007-01-19 01:06:01 +00003135 /* If the pSrc table is the right table of a LEFT JOIN then we may not
3136 ** use an index to satisfy IS NULL constraints on that table. This is
3137 ** because columns might end up being NULL if the table does not match -
3138 ** a circumstance which the index cannot help us discover. Ticket #2177.
3139 */
dan5236ac12009-08-13 07:09:33 +00003140 if( pSrc->jointype & JT_LEFT ){
3141 idxEqTermMask = WO_EQ|WO_IN;
drhc49de5d2007-01-19 01:06:01 +00003142 }else{
dan5236ac12009-08-13 07:09:33 +00003143 idxEqTermMask = WO_EQ|WO_IN|WO_ISNULL;
drhc49de5d2007-01-19 01:06:01 +00003144 }
3145
danielk197785574e32008-10-06 05:32:18 +00003146 if( pSrc->pIndex ){
drhcdaca552009-08-20 13:45:07 +00003147 /* An INDEXED BY clause specifies a particular index to use */
dan5236ac12009-08-13 07:09:33 +00003148 pIdx = pProbe = pSrc->pIndex;
3149 wsFlagMask = ~(WHERE_ROWID_EQ|WHERE_ROWID_RANGE);
3150 eqTermMask = idxEqTermMask;
3151 }else{
drh083310d2011-01-28 01:57:41 +00003152 /* There is no INDEXED BY clause. Create a fake Index object in local
3153 ** variable sPk to represent the rowid primary key index. Make this
3154 ** fake index the first in a chain of Index objects with all of the real
3155 ** indices to follow */
3156 Index *pFirst; /* First of real indices on the table */
drhcdaca552009-08-20 13:45:07 +00003157 memset(&sPk, 0, sizeof(Index));
3158 sPk.nColumn = 1;
3159 sPk.aiColumn = &aiColumnPk;
3160 sPk.aiRowEst = aiRowEstPk;
drhcdaca552009-08-20 13:45:07 +00003161 sPk.onError = OE_Replace;
3162 sPk.pTable = pSrc->pTab;
drh15564052010-09-25 22:32:56 +00003163 aiRowEstPk[0] = pSrc->pTab->nRowEst;
3164 aiRowEstPk[1] = 1;
drhcdaca552009-08-20 13:45:07 +00003165 pFirst = pSrc->pTab->pIndex;
dan5236ac12009-08-13 07:09:33 +00003166 if( pSrc->notIndexed==0 ){
drh083310d2011-01-28 01:57:41 +00003167 /* The real indices of the table are only considered if the
3168 ** NOT INDEXED qualifier is omitted from the FROM clause */
drhcdaca552009-08-20 13:45:07 +00003169 sPk.pNext = pFirst;
dan5236ac12009-08-13 07:09:33 +00003170 }
drhcdaca552009-08-20 13:45:07 +00003171 pProbe = &sPk;
dan5236ac12009-08-13 07:09:33 +00003172 wsFlagMask = ~(
3173 WHERE_COLUMN_IN|WHERE_COLUMN_EQ|WHERE_COLUMN_NULL|WHERE_COLUMN_RANGE
3174 );
3175 eqTermMask = WO_EQ|WO_IN;
3176 pIdx = 0;
danielk197785574e32008-10-06 05:32:18 +00003177 }
drh51147ba2005-07-23 22:59:55 +00003178
drh04229ac2012-12-08 22:14:29 +00003179 nOrderBy = p->pOrderBy ? p->pOrderBy->nExpr : 0;
3180 if( p->i ){
3181 nPriorSat = p->aLevel[p->i-1].plan.nOBSat;
3182 bSortInit = nPriorSat<nOrderBy;
3183 bDistInit = 0;
3184 }else{
3185 nPriorSat = 0;
3186 bSortInit = nOrderBy>0;
3187 bDistInit = p->pDistinct!=0;
3188 }
3189
drhcdaca552009-08-20 13:45:07 +00003190 /* Loop over all indices looking for the best one to use
3191 */
dan5236ac12009-08-13 07:09:33 +00003192 for(; pProbe; pIdx=pProbe=pProbe->pNext){
drhfaacf172011-08-12 01:51:45 +00003193 const tRowcnt * const aiRowEst = pProbe->aiRowEst;
drhd663b5b2012-10-03 00:25:54 +00003194 WhereCost pc; /* Cost of using pProbe */
drh93c63842011-09-22 00:28:55 +00003195 double log10N = (double)1; /* base-10 logarithm of nRow (inexact) */
drh8e4af1b2012-10-08 18:23:51 +00003196
dan5236ac12009-08-13 07:09:33 +00003197 /* The following variables are populated based on the properties of
drh083310d2011-01-28 01:57:41 +00003198 ** index being evaluated. They are then used to determine the expected
dan5236ac12009-08-13 07:09:33 +00003199 ** cost and number of rows returned.
3200 **
drhd663b5b2012-10-03 00:25:54 +00003201 ** pc.plan.nEq:
dan5236ac12009-08-13 07:09:33 +00003202 ** Number of equality terms that can be implemented using the index.
drh083310d2011-01-28 01:57:41 +00003203 ** In other words, the number of initial fields in the index that
3204 ** are used in == or IN or NOT NULL constraints of the WHERE clause.
dan5236ac12009-08-13 07:09:33 +00003205 **
3206 ** nInMul:
3207 ** The "in-multiplier". This is an estimate of how many seek operations
3208 ** SQLite must perform on the index in question. For example, if the
3209 ** WHERE clause is:
3210 **
3211 ** WHERE a IN (1, 2, 3) AND b IN (4, 5, 6)
3212 **
3213 ** SQLite must perform 9 lookups on an index on (a, b), so nInMul is
3214 ** set to 9. Given the same schema and either of the following WHERE
3215 ** clauses:
3216 **
3217 ** WHERE a = 1
3218 ** WHERE a >= 2
3219 **
3220 ** nInMul is set to 1.
3221 **
3222 ** If there exists a WHERE term of the form "x IN (SELECT ...)", then
3223 ** the sub-select is assumed to return 25 rows for the purposes of
3224 ** determining nInMul.
3225 **
3226 ** bInEst:
3227 ** Set to true if there was at least one "x IN (SELECT ...)" term used
drh083310d2011-01-28 01:57:41 +00003228 ** in determining the value of nInMul. Note that the RHS of the
3229 ** IN operator must be a SELECT, not a value list, for this variable
3230 ** to be true.
dan5236ac12009-08-13 07:09:33 +00003231 **
drhfaacf172011-08-12 01:51:45 +00003232 ** rangeDiv:
3233 ** An estimate of a divisor by which to reduce the search space due
3234 ** to inequality constraints. In the absence of sqlite_stat3 ANALYZE
3235 ** data, a single inequality reduces the search space to 1/4rd its
3236 ** original size (rangeDiv==4). Two inequalities reduce the search
3237 ** space to 1/16th of its original size (rangeDiv==16).
dan5236ac12009-08-13 07:09:33 +00003238 **
3239 ** bSort:
3240 ** Boolean. True if there is an ORDER BY clause that will require an
3241 ** external sort (i.e. scanning the index being evaluated will not
3242 ** correctly order records).
3243 **
drh04b85bc2012-10-01 17:44:05 +00003244 ** bDist:
drh46c35f92012-09-26 23:17:01 +00003245 ** Boolean. True if there is a DISTINCT clause that will require an
3246 ** external btree.
3247 **
dan5236ac12009-08-13 07:09:33 +00003248 ** bLookup:
drh083310d2011-01-28 01:57:41 +00003249 ** Boolean. True if a table lookup is required for each index entry
3250 ** visited. In other words, true if this is not a covering index.
3251 ** This is always false for the rowid primary key index of a table.
3252 ** For other indexes, it is true unless all the columns of the table
3253 ** used by the SELECT statement are present in the index (such an
3254 ** index is sometimes described as a covering index).
dan5236ac12009-08-13 07:09:33 +00003255 ** For example, given the index on (a, b), the second of the following
drh083310d2011-01-28 01:57:41 +00003256 ** two queries requires table b-tree lookups in order to find the value
3257 ** of column c, but the first does not because columns a and b are
3258 ** both available in the index.
dan5236ac12009-08-13 07:09:33 +00003259 **
3260 ** SELECT a, b FROM tbl WHERE a = 1;
3261 ** SELECT a, b, c FROM tbl WHERE a = 1;
drhfe05af82005-07-21 03:14:59 +00003262 */
drh083310d2011-01-28 01:57:41 +00003263 int bInEst = 0; /* True if "x IN (SELECT...)" seen */
3264 int nInMul = 1; /* Number of distinct equalities to lookup */
drh4e50c5e2011-08-13 19:35:19 +00003265 double rangeDiv = (double)1; /* Estimated reduction in search space */
drh82759752011-01-20 16:52:09 +00003266 int nBound = 0; /* Number of range constraints seen */
drh04229ac2012-12-08 22:14:29 +00003267 char bSort = bSortInit; /* True if external sort required */
3268 char bDist = bDistInit; /* True if index cannot help with DISTINCT */
3269 char bLookup = 0; /* True if not a covering index */
drh82759752011-01-20 16:52:09 +00003270 WhereTerm *pTerm; /* A single term of the WHERE clause */
drhfaacf172011-08-12 01:51:45 +00003271#ifdef SQLITE_ENABLE_STAT3
drh0c50fa02011-01-21 16:27:18 +00003272 WhereTerm *pFirstTerm = 0; /* First term matching the index */
drh82759752011-01-20 16:52:09 +00003273#endif
dan5236ac12009-08-13 07:09:33 +00003274
drh86257ff2012-10-09 01:39:25 +00003275 WHERETRACE((
3276 " %s(%s):\n",
3277 pSrc->pTab->zName, (pIdx ? pIdx->zName : "ipk")
3278 ));
drh613a53a2012-10-03 18:09:32 +00003279 memset(&pc, 0, sizeof(pc));
drh04229ac2012-12-08 22:14:29 +00003280 pc.plan.nOBSat = nPriorSat;
drh9cd1c992012-09-25 20:43:35 +00003281
drhd663b5b2012-10-03 00:25:54 +00003282 /* Determine the values of pc.plan.nEq and nInMul */
drh4f68d6c2012-10-04 12:10:25 +00003283 for(pc.plan.nEq=0; pc.plan.nEq<pProbe->nColumn; pc.plan.nEq++){
drhd663b5b2012-10-03 00:25:54 +00003284 int j = pProbe->aiColumn[pc.plan.nEq];
drh56f1b992012-09-25 14:29:39 +00003285 pTerm = findTerm(pWC, iCur, j, p->notReady, eqTermMask, pIdx);
drhfe05af82005-07-21 03:14:59 +00003286 if( pTerm==0 ) break;
drhd663b5b2012-10-03 00:25:54 +00003287 pc.plan.wsFlags |= (WHERE_COLUMN_EQ|WHERE_ROWID_EQ);
drh0a61df62011-10-07 17:45:58 +00003288 testcase( pTerm->pWC!=pWC );
drhb52076c2006-01-23 13:22:09 +00003289 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00003290 Expr *pExpr = pTerm->pExpr;
drhd663b5b2012-10-03 00:25:54 +00003291 pc.plan.wsFlags |= WHERE_COLUMN_IN;
danielk19776ab3a2e2009-02-19 14:39:25 +00003292 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drh9b3eb0a2011-01-21 14:37:04 +00003293 /* "x IN (SELECT ...)": Assume the SELECT returns 25 rows */
dan5236ac12009-08-13 07:09:33 +00003294 nInMul *= 25;
3295 bInEst = 1;
drh083310d2011-01-28 01:57:41 +00003296 }else if( ALWAYS(pExpr->x.pList && pExpr->x.pList->nExpr) ){
drh9b3eb0a2011-01-21 14:37:04 +00003297 /* "x IN (value, value, ...)" */
drh083310d2011-01-28 01:57:41 +00003298 nInMul *= pExpr->x.pList->nExpr;
drhfe05af82005-07-21 03:14:59 +00003299 }
drh46619d62009-04-24 14:51:42 +00003300 }else if( pTerm->eOperator & WO_ISNULL ){
drhd663b5b2012-10-03 00:25:54 +00003301 pc.plan.wsFlags |= WHERE_COLUMN_NULL;
drhfe05af82005-07-21 03:14:59 +00003302 }
drhfaacf172011-08-12 01:51:45 +00003303#ifdef SQLITE_ENABLE_STAT3
drhd663b5b2012-10-03 00:25:54 +00003304 if( pc.plan.nEq==0 && pProbe->aSample ) pFirstTerm = pTerm;
drh82759752011-01-20 16:52:09 +00003305#endif
drhd663b5b2012-10-03 00:25:54 +00003306 pc.used |= pTerm->prereqRight;
drhfe05af82005-07-21 03:14:59 +00003307 }
dan0c733f62011-11-16 15:27:09 +00003308
3309 /* If the index being considered is UNIQUE, and there is an equality
3310 ** constraint for all columns in the index, then this search will find
3311 ** at most a single row. In this case set the WHERE_UNIQUE flag to
3312 ** indicate this to the caller.
3313 **
3314 ** Otherwise, if the search may find more than one row, test to see if
drh1b8fc652013-02-07 21:15:14 +00003315 ** there is a range constraint on indexed column (pc.plan.nEq+1) that
3316 ** can be optimized using the index.
dan0c733f62011-11-16 15:27:09 +00003317 */
drhd663b5b2012-10-03 00:25:54 +00003318 if( pc.plan.nEq==pProbe->nColumn && pProbe->onError!=OE_None ){
3319 testcase( pc.plan.wsFlags & WHERE_COLUMN_IN );
3320 testcase( pc.plan.wsFlags & WHERE_COLUMN_NULL );
3321 if( (pc.plan.wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_NULL))==0 ){
3322 pc.plan.wsFlags |= WHERE_UNIQUE;
drh60441af2012-09-29 19:10:29 +00003323 if( p->i==0 || (p->aLevel[p->i-1].plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
drhd663b5b2012-10-03 00:25:54 +00003324 pc.plan.wsFlags |= WHERE_ALL_UNIQUE;
drh60441af2012-09-29 19:10:29 +00003325 }
dan0c733f62011-11-16 15:27:09 +00003326 }
3327 }else if( pProbe->bUnordered==0 ){
drhd663b5b2012-10-03 00:25:54 +00003328 int j;
3329 j = (pc.plan.nEq==pProbe->nColumn ? -1 : pProbe->aiColumn[pc.plan.nEq]);
drh56f1b992012-09-25 14:29:39 +00003330 if( findTerm(pWC, iCur, j, p->notReady, WO_LT|WO_LE|WO_GT|WO_GE, pIdx) ){
3331 WhereTerm *pTop, *pBtm;
3332 pTop = findTerm(pWC, iCur, j, p->notReady, WO_LT|WO_LE, pIdx);
3333 pBtm = findTerm(pWC, iCur, j, p->notReady, WO_GT|WO_GE, pIdx);
drhd663b5b2012-10-03 00:25:54 +00003334 whereRangeScanEst(pParse, pProbe, pc.plan.nEq, pBtm, pTop, &rangeDiv);
dan5236ac12009-08-13 07:09:33 +00003335 if( pTop ){
drhed754ce2010-04-15 01:04:54 +00003336 nBound = 1;
drhd663b5b2012-10-03 00:25:54 +00003337 pc.plan.wsFlags |= WHERE_TOP_LIMIT;
3338 pc.used |= pTop->prereqRight;
drh0a61df62011-10-07 17:45:58 +00003339 testcase( pTop->pWC!=pWC );
dan5236ac12009-08-13 07:09:33 +00003340 }
3341 if( pBtm ){
drhed754ce2010-04-15 01:04:54 +00003342 nBound++;
drhd663b5b2012-10-03 00:25:54 +00003343 pc.plan.wsFlags |= WHERE_BTM_LIMIT;
3344 pc.used |= pBtm->prereqRight;
drh0a61df62011-10-07 17:45:58 +00003345 testcase( pBtm->pWC!=pWC );
dan5236ac12009-08-13 07:09:33 +00003346 }
drhd663b5b2012-10-03 00:25:54 +00003347 pc.plan.wsFlags |= (WHERE_COLUMN_RANGE|WHERE_ROWID_RANGE);
dan5236ac12009-08-13 07:09:33 +00003348 }
drh943af3c2005-07-29 19:43:58 +00003349 }
drhfe05af82005-07-21 03:14:59 +00003350
dan5236ac12009-08-13 07:09:33 +00003351 /* If there is an ORDER BY clause and the index being considered will
3352 ** naturally scan rows in the required order, set the appropriate flags
drhd663b5b2012-10-03 00:25:54 +00003353 ** in pc.plan.wsFlags. Otherwise, if there is an ORDER BY clause but
3354 ** the index will scan rows in a different order, set the bSort
3355 ** variable. */
drh8e4af1b2012-10-08 18:23:51 +00003356 if( bSort && (pSrc->jointype & JT_LEFT)==0 ){
3357 int bRev = 2;
3358 WHERETRACE((" --> before isSortingIndex: nPriorSat=%d\n",nPriorSat));
drh4f68d6c2012-10-04 12:10:25 +00003359 pc.plan.nOBSat = isSortingIndex(p, pProbe, iCur, &bRev);
drh8e4af1b2012-10-08 18:23:51 +00003360 WHERETRACE((" --> after isSortingIndex: bRev=%d nOBSat=%d\n",
3361 bRev, pc.plan.nOBSat));
drh29a8bf82013-01-09 11:31:17 +00003362 if( nPriorSat<pc.plan.nOBSat || (pc.plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
drhd663b5b2012-10-03 00:25:54 +00003363 pc.plan.wsFlags |= WHERE_ORDERED;
drh46c35f92012-09-26 23:17:01 +00003364 }
drhd663b5b2012-10-03 00:25:54 +00003365 if( nOrderBy==pc.plan.nOBSat ){
3366 bSort = 0;
3367 pc.plan.wsFlags |= WHERE_ROWID_RANGE|WHERE_COLUMN_RANGE;
3368 }
3369 if( bRev & 1 ) pc.plan.wsFlags |= WHERE_REVERSE;
dan38cc40c2011-06-30 20:17:15 +00003370 }
3371
3372 /* If there is a DISTINCT qualifier and this index will scan rows in
3373 ** order of the DISTINCT expressions, clear bDist and set the appropriate
drhd663b5b2012-10-03 00:25:54 +00003374 ** flags in pc.plan.wsFlags. */
drh9cd1c992012-09-25 20:43:35 +00003375 if( bDist
drhd663b5b2012-10-03 00:25:54 +00003376 && isDistinctIndex(pParse, pWC, pProbe, iCur, p->pDistinct, pc.plan.nEq)
3377 && (pc.plan.wsFlags & WHERE_COLUMN_IN)==0
drh7f67d942012-03-03 00:34:47 +00003378 ){
dan38cc40c2011-06-30 20:17:15 +00003379 bDist = 0;
drhd663b5b2012-10-03 00:25:54 +00003380 pc.plan.wsFlags |= WHERE_ROWID_RANGE|WHERE_COLUMN_RANGE|WHERE_DISTINCT;
drhfe05af82005-07-21 03:14:59 +00003381 }
3382
dan5236ac12009-08-13 07:09:33 +00003383 /* If currently calculating the cost of using an index (not the IPK
3384 ** index), determine if all required column data may be obtained without
drh4139c992010-04-07 14:59:45 +00003385 ** using the main table (i.e. if the index is a covering
dan5236ac12009-08-13 07:09:33 +00003386 ** index for this query). If it is, set the WHERE_IDX_ONLY flag in
drhd663b5b2012-10-03 00:25:54 +00003387 ** pc.plan.wsFlags. Otherwise, set the bLookup variable to true. */
drh3f4d1d12012-09-15 18:45:54 +00003388 if( pIdx ){
drhfe05af82005-07-21 03:14:59 +00003389 Bitmask m = pSrc->colUsed;
3390 int j;
dan5236ac12009-08-13 07:09:33 +00003391 for(j=0; j<pIdx->nColumn; j++){
3392 int x = pIdx->aiColumn[j];
drhfe05af82005-07-21 03:14:59 +00003393 if( x<BMS-1 ){
3394 m &= ~(((Bitmask)1)<<x);
3395 }
3396 }
3397 if( m==0 ){
drhd663b5b2012-10-03 00:25:54 +00003398 pc.plan.wsFlags |= WHERE_IDX_ONLY;
dan5236ac12009-08-13 07:09:33 +00003399 }else{
3400 bLookup = 1;
drhfe05af82005-07-21 03:14:59 +00003401 }
3402 }
3403
drh1e0f4a82010-04-14 19:01:44 +00003404 /*
drh9b3eb0a2011-01-21 14:37:04 +00003405 ** Estimate the number of rows of output. For an "x IN (SELECT...)"
3406 ** constraint, do not let the estimate exceed half the rows in the table.
drhcdaca552009-08-20 13:45:07 +00003407 */
drhd663b5b2012-10-03 00:25:54 +00003408 pc.plan.nRow = (double)(aiRowEst[pc.plan.nEq] * nInMul);
3409 if( bInEst && pc.plan.nRow*2>aiRowEst[0] ){
3410 pc.plan.nRow = aiRowEst[0]/2;
3411 nInMul = (int)(pc.plan.nRow / aiRowEst[pc.plan.nEq]);
dan5236ac12009-08-13 07:09:33 +00003412 }
drhcdaca552009-08-20 13:45:07 +00003413
drhfaacf172011-08-12 01:51:45 +00003414#ifdef SQLITE_ENABLE_STAT3
drhbf4ec552011-07-13 18:31:10 +00003415 /* If the constraint is of the form x=VALUE or x IN (E1,E2,...)
3416 ** and we do not think that values of x are unique and if histogram
drh82759752011-01-20 16:52:09 +00003417 ** data is available for column x, then it might be possible
3418 ** to get a better estimate on the number of rows based on
3419 ** VALUE and how common that value is according to the histogram.
3420 */
drhd663b5b2012-10-03 00:25:54 +00003421 if( pc.plan.nRow>(double)1 && pc.plan.nEq==1
3422 && pFirstTerm!=0 && aiRowEst[1]>1 ){
drh567211e2011-09-23 13:59:33 +00003423 assert( (pFirstTerm->eOperator & (WO_EQ|WO_ISNULL|WO_IN))!=0 );
drh1f9c7662011-03-17 01:34:26 +00003424 if( pFirstTerm->eOperator & (WO_EQ|WO_ISNULL) ){
drh7a5bcc02013-01-16 17:08:58 +00003425 testcase( pFirstTerm->eOperator & WO_EQ );
3426 testcase( pFirstTerm->eOperator & WO_EQUIV );
3427 testcase( pFirstTerm->eOperator & WO_ISNULL );
drhd663b5b2012-10-03 00:25:54 +00003428 whereEqualScanEst(pParse, pProbe, pFirstTerm->pExpr->pRight,
3429 &pc.plan.nRow);
drh567211e2011-09-23 13:59:33 +00003430 }else if( bInEst==0 ){
drh7a5bcc02013-01-16 17:08:58 +00003431 assert( pFirstTerm->eOperator & WO_IN );
drhd663b5b2012-10-03 00:25:54 +00003432 whereInScanEst(pParse, pProbe, pFirstTerm->pExpr->x.pList,
3433 &pc.plan.nRow);
drh0c50fa02011-01-21 16:27:18 +00003434 }
drh82759752011-01-20 16:52:09 +00003435 }
drhfaacf172011-08-12 01:51:45 +00003436#endif /* SQLITE_ENABLE_STAT3 */
drh82759752011-01-20 16:52:09 +00003437
drh37722062011-02-10 00:08:47 +00003438 /* Adjust the number of output rows and downward to reflect rows
drhcdaca552009-08-20 13:45:07 +00003439 ** that are excluded by range constraints.
3440 */
drhd663b5b2012-10-03 00:25:54 +00003441 pc.plan.nRow = pc.plan.nRow/rangeDiv;
3442 if( pc.plan.nRow<1 ) pc.plan.nRow = 1;
drhcdaca552009-08-20 13:45:07 +00003443
drh37722062011-02-10 00:08:47 +00003444 /* Experiments run on real SQLite databases show that the time needed
3445 ** to do a binary search to locate a row in a table or index is roughly
3446 ** log10(N) times the time to move from one row to the next row within
3447 ** a table or index. The actual times can vary, with the size of
3448 ** records being an important factor. Both moves and searches are
3449 ** slower with larger records, presumably because fewer records fit
3450 ** on one page and hence more pages have to be fetched.
drh083310d2011-01-28 01:57:41 +00003451 **
drh74e7c8f2011-10-21 19:06:32 +00003452 ** The ANALYZE command and the sqlite_stat1 and sqlite_stat3 tables do
drh37722062011-02-10 00:08:47 +00003453 ** not give us data on the relative sizes of table and index records.
3454 ** So this computation assumes table records are about twice as big
3455 ** as index records
drhb9661942011-01-24 15:11:23 +00003456 */
drhd663b5b2012-10-03 00:25:54 +00003457 if( (pc.plan.wsFlags&~(WHERE_REVERSE|WHERE_ORDERED))==WHERE_IDX_ONLY
drh3f4d1d12012-09-15 18:45:54 +00003458 && (pWC->wctrlFlags & WHERE_ONEPASS_DESIRED)==0
drhde9a7b82012-09-17 20:44:46 +00003459 && sqlite3GlobalConfig.bUseCis
drh7e5418e2012-09-27 15:05:54 +00003460 && OptimizationEnabled(pParse->db, SQLITE_CoverIdxScan)
drh3f4d1d12012-09-15 18:45:54 +00003461 ){
3462 /* This index is not useful for indexing, but it is a covering index.
3463 ** A full-scan of the index might be a little faster than a full-scan
3464 ** of the table, so give this case a cost slightly less than a table
3465 ** scan. */
drhd663b5b2012-10-03 00:25:54 +00003466 pc.rCost = aiRowEst[0]*3 + pProbe->nColumn;
3467 pc.plan.wsFlags |= WHERE_COVER_SCAN|WHERE_COLUMN_RANGE;
3468 }else if( (pc.plan.wsFlags & WHERE_NOT_FULLSCAN)==0 ){
drh37722062011-02-10 00:08:47 +00003469 /* The cost of a full table scan is a number of move operations equal
3470 ** to the number of rows in the table.
3471 **
3472 ** We add an additional 4x penalty to full table scans. This causes
3473 ** the cost function to err on the side of choosing an index over
3474 ** choosing a full scan. This 4x full-scan penalty is an arguable
3475 ** decision and one which we expect to revisit in the future. But
3476 ** it seems to be working well enough at the moment.
drh083310d2011-01-28 01:57:41 +00003477 */
drhd663b5b2012-10-03 00:25:54 +00003478 pc.rCost = aiRowEst[0]*4;
3479 pc.plan.wsFlags &= ~WHERE_IDX_ONLY;
drh8e4af1b2012-10-08 18:23:51 +00003480 if( pIdx ){
3481 pc.plan.wsFlags &= ~WHERE_ORDERED;
3482 pc.plan.nOBSat = nPriorSat;
3483 }
drh37722062011-02-10 00:08:47 +00003484 }else{
3485 log10N = estLog(aiRowEst[0]);
drhd663b5b2012-10-03 00:25:54 +00003486 pc.rCost = pc.plan.nRow;
drh37722062011-02-10 00:08:47 +00003487 if( pIdx ){
3488 if( bLookup ){
3489 /* For an index lookup followed by a table lookup:
3490 ** nInMul index searches to find the start of each index range
3491 ** + nRow steps through the index
3492 ** + nRow table searches to lookup the table entry using the rowid
3493 */
drhd663b5b2012-10-03 00:25:54 +00003494 pc.rCost += (nInMul + pc.plan.nRow)*log10N;
drh37722062011-02-10 00:08:47 +00003495 }else{
3496 /* For a covering index:
3497 ** nInMul index searches to find the initial entry
3498 ** + nRow steps through the index
3499 */
drhd663b5b2012-10-03 00:25:54 +00003500 pc.rCost += nInMul*log10N;
drh37722062011-02-10 00:08:47 +00003501 }
3502 }else{
3503 /* For a rowid primary key lookup:
3504 ** nInMult table searches to find the initial entry for each range
3505 ** + nRow steps through the table
3506 */
drhd663b5b2012-10-03 00:25:54 +00003507 pc.rCost += nInMul*log10N;
drh37722062011-02-10 00:08:47 +00003508 }
drhb9661942011-01-24 15:11:23 +00003509 }
3510
drh37722062011-02-10 00:08:47 +00003511 /* Add in the estimated cost of sorting the result. Actual experimental
3512 ** measurements of sorting performance in SQLite show that sorting time
3513 ** adds C*N*log10(N) to the cost, where N is the number of rows to be
3514 ** sorted and C is a factor between 1.95 and 4.3. We will split the
3515 ** difference and select C of 3.0.
drhcdaca552009-08-20 13:45:07 +00003516 */
dan5236ac12009-08-13 07:09:33 +00003517 if( bSort ){
drhd663b5b2012-10-03 00:25:54 +00003518 double m = estLog(pc.plan.nRow*(nOrderBy - pc.plan.nOBSat)/nOrderBy);
3519 m *= (double)(pc.plan.nOBSat ? 2 : 3);
3520 pc.rCost += pc.plan.nRow*m;
dan5236ac12009-08-13 07:09:33 +00003521 }
dan38cc40c2011-06-30 20:17:15 +00003522 if( bDist ){
drhd663b5b2012-10-03 00:25:54 +00003523 pc.rCost += pc.plan.nRow*estLog(pc.plan.nRow)*3;
dan38cc40c2011-06-30 20:17:15 +00003524 }
drhcdaca552009-08-20 13:45:07 +00003525
drhcdaca552009-08-20 13:45:07 +00003526 /**** Cost of using this index has now been computed ****/
dan5236ac12009-08-13 07:09:33 +00003527
drh1e0f4a82010-04-14 19:01:44 +00003528 /* If there are additional constraints on this table that cannot
3529 ** be used with the current index, but which might lower the number
3530 ** of output rows, adjust the nRow value accordingly. This only
3531 ** matters if the current index is the least costly, so do not bother
3532 ** with this step if we already know this index will not be chosen.
drhed754ce2010-04-15 01:04:54 +00003533 ** Also, never reduce the output row count below 2 using this step.
drhed808ac2010-04-15 13:29:37 +00003534 **
drh547caad2010-10-04 23:55:50 +00003535 ** It is critical that the notValid mask be used here instead of
3536 ** the notReady mask. When computing an "optimal" index, the notReady
3537 ** mask will only have one bit set - the bit for the current table.
3538 ** The notValid mask, on the other hand, always has all bits set for
3539 ** tables that are not in outer loops. If notReady is used here instead
3540 ** of notValid, then a optimal index that depends on inner joins loops
3541 ** might be selected even when there exists an optimal index that has
3542 ** no such dependency.
drh1e0f4a82010-04-14 19:01:44 +00003543 */
drhd663b5b2012-10-03 00:25:54 +00003544 if( pc.plan.nRow>2 && pc.rCost<=p->cost.rCost ){
drhed808ac2010-04-15 13:29:37 +00003545 int k; /* Loop counter */
drhd663b5b2012-10-03 00:25:54 +00003546 int nSkipEq = pc.plan.nEq; /* Number of == constraints to skip */
drhed808ac2010-04-15 13:29:37 +00003547 int nSkipRange = nBound; /* Number of < constraints to skip */
3548 Bitmask thisTab; /* Bitmap for pSrc */
3549
3550 thisTab = getMask(pWC->pMaskSet, iCur);
drhd663b5b2012-10-03 00:25:54 +00003551 for(pTerm=pWC->a, k=pWC->nTerm; pc.plan.nRow>2 && k; k--, pTerm++){
drh534230c2011-01-22 00:10:45 +00003552 if( pTerm->wtFlags & TERM_VIRTUAL ) continue;
drh56f1b992012-09-25 14:29:39 +00003553 if( (pTerm->prereqAll & p->notValid)!=thisTab ) continue;
drh1e0f4a82010-04-14 19:01:44 +00003554 if( pTerm->eOperator & (WO_EQ|WO_IN|WO_ISNULL) ){
drhed754ce2010-04-15 01:04:54 +00003555 if( nSkipEq ){
drhd663b5b2012-10-03 00:25:54 +00003556 /* Ignore the first pc.plan.nEq equality matches since the index
drh1e0f4a82010-04-14 19:01:44 +00003557 ** has already accounted for these */
drhed754ce2010-04-15 01:04:54 +00003558 nSkipEq--;
drh1e0f4a82010-04-14 19:01:44 +00003559 }else{
3560 /* Assume each additional equality match reduces the result
3561 ** set size by a factor of 10 */
drhd663b5b2012-10-03 00:25:54 +00003562 pc.plan.nRow /= 10;
drh1e0f4a82010-04-14 19:01:44 +00003563 }
drhed754ce2010-04-15 01:04:54 +00003564 }else if( pTerm->eOperator & (WO_LT|WO_LE|WO_GT|WO_GE) ){
3565 if( nSkipRange ){
drh5ac06072011-01-21 18:18:13 +00003566 /* Ignore the first nSkipRange range constraints since the index
drhed754ce2010-04-15 01:04:54 +00003567 ** has already accounted for these */
3568 nSkipRange--;
3569 }else{
3570 /* Assume each additional range constraint reduces the result
drh083310d2011-01-28 01:57:41 +00003571 ** set size by a factor of 3. Indexed range constraints reduce
3572 ** the search space by a larger factor: 4. We make indexed range
3573 ** more selective intentionally because of the subjective
3574 ** observation that indexed range constraints really are more
3575 ** selective in practice, on average. */
drhd663b5b2012-10-03 00:25:54 +00003576 pc.plan.nRow /= 3;
drhed754ce2010-04-15 01:04:54 +00003577 }
drh7a5bcc02013-01-16 17:08:58 +00003578 }else if( (pTerm->eOperator & WO_NOOP)==0 ){
drh1e0f4a82010-04-14 19:01:44 +00003579 /* Any other expression lowers the output row count by half */
drhd663b5b2012-10-03 00:25:54 +00003580 pc.plan.nRow /= 2;
drh1e0f4a82010-04-14 19:01:44 +00003581 }
3582 }
drhd663b5b2012-10-03 00:25:54 +00003583 if( pc.plan.nRow<2 ) pc.plan.nRow = 2;
drh1e0f4a82010-04-14 19:01:44 +00003584 }
3585
3586
dan5236ac12009-08-13 07:09:33 +00003587 WHERETRACE((
drh8e4af1b2012-10-08 18:23:51 +00003588 " nEq=%d nInMul=%d rangeDiv=%d bSort=%d bLookup=%d wsFlags=0x%08x\n"
3589 " notReady=0x%llx log10N=%.1f nRow=%.1f cost=%.1f\n"
3590 " used=0x%llx nOBSat=%d\n",
drhd663b5b2012-10-03 00:25:54 +00003591 pc.plan.nEq, nInMul, (int)rangeDiv, bSort, bLookup, pc.plan.wsFlags,
drh4f68d6c2012-10-04 12:10:25 +00003592 p->notReady, log10N, pc.plan.nRow, pc.rCost, pc.used,
drhd663b5b2012-10-03 00:25:54 +00003593 pc.plan.nOBSat
dan5236ac12009-08-13 07:09:33 +00003594 ));
3595
drhcdaca552009-08-20 13:45:07 +00003596 /* If this index is the best we have seen so far, then record this
drhd663b5b2012-10-03 00:25:54 +00003597 ** index and its cost in the p->cost structure.
drhcdaca552009-08-20 13:45:07 +00003598 */
drhd663b5b2012-10-03 00:25:54 +00003599 if( (!pIdx || pc.plan.wsFlags) && compareCost(&pc, &p->cost) ){
3600 p->cost = pc;
3601 p->cost.plan.wsFlags &= wsFlagMask;
drh56f1b992012-09-25 14:29:39 +00003602 p->cost.plan.u.pIdx = pIdx;
drhfe05af82005-07-21 03:14:59 +00003603 }
dan5236ac12009-08-13 07:09:33 +00003604
drhcdaca552009-08-20 13:45:07 +00003605 /* If there was an INDEXED BY clause, then only that one index is
3606 ** considered. */
dan5236ac12009-08-13 07:09:33 +00003607 if( pSrc->pIndex ) break;
drhcdaca552009-08-20 13:45:07 +00003608
3609 /* Reset masks for the next index in the loop */
dan5236ac12009-08-13 07:09:33 +00003610 wsFlagMask = ~(WHERE_ROWID_EQ|WHERE_ROWID_RANGE);
3611 eqTermMask = idxEqTermMask;
drhfe05af82005-07-21 03:14:59 +00003612 }
3613
dan5236ac12009-08-13 07:09:33 +00003614 /* If there is no ORDER BY clause and the SQLITE_ReverseOrder flag
3615 ** is set, then reverse the order that the index will be scanned
3616 ** in. This is used for application testing, to help find cases
3617 ** where application behaviour depends on the (undefined) order that
3618 ** SQLite outputs rows in in the absence of an ORDER BY clause. */
drh56f1b992012-09-25 14:29:39 +00003619 if( !p->pOrderBy && pParse->db->flags & SQLITE_ReverseOrder ){
3620 p->cost.plan.wsFlags |= WHERE_REVERSE;
dan5236ac12009-08-13 07:09:33 +00003621 }
3622
drhd663b5b2012-10-03 00:25:54 +00003623 assert( p->pOrderBy || (p->cost.plan.wsFlags&WHERE_ORDERED)==0 );
drh56f1b992012-09-25 14:29:39 +00003624 assert( p->cost.plan.u.pIdx==0 || (p->cost.plan.wsFlags&WHERE_ROWID_EQ)==0 );
dan5236ac12009-08-13 07:09:33 +00003625 assert( pSrc->pIndex==0
drh56f1b992012-09-25 14:29:39 +00003626 || p->cost.plan.u.pIdx==0
3627 || p->cost.plan.u.pIdx==pSrc->pIndex
dan5236ac12009-08-13 07:09:33 +00003628 );
3629
drhea84a652013-01-15 18:49:07 +00003630 WHERETRACE((" best index is %s cost=%.1f\n",
3631 p->cost.plan.u.pIdx ? p->cost.plan.u.pIdx->zName : "ipk",
3632 p->cost.rCost));
dan5236ac12009-08-13 07:09:33 +00003633
drh56f1b992012-09-25 14:29:39 +00003634 bestOrClauseIndex(p);
3635 bestAutomaticIndex(p);
3636 p->cost.plan.wsFlags |= eqTermMask;
drhfe05af82005-07-21 03:14:59 +00003637}
3638
danielk19771d461462009-04-21 09:02:45 +00003639/*
3640** Find the query plan for accessing table pSrc->pTab. Write the
3641** best query plan and its cost into the WhereCost object supplied
3642** as the last parameter. This function may calculate the cost of
3643** both real and virtual table scans.
drh4d85fa72012-09-24 19:50:00 +00003644**
3645** This function does not take ORDER BY or DISTINCT into account. Nor
3646** does it remember the virtual table query plan. All it does is compute
3647** the cost while determining if an OR optimization is applicable. The
3648** details will be reconsidered later if the optimization is found to be
3649** applicable.
danielk19771d461462009-04-21 09:02:45 +00003650*/
drh56f1b992012-09-25 14:29:39 +00003651static void bestIndex(WhereBestIdx *p){
shanee26fa4c2009-06-16 14:15:22 +00003652#ifndef SQLITE_OMIT_VIRTUALTABLE
drh56f1b992012-09-25 14:29:39 +00003653 if( IsVirtual(p->pSrc->pTab) ){
3654 sqlite3_index_info *pIdxInfo = 0;
3655 p->ppIdxInfo = &pIdxInfo;
3656 bestVirtualIndex(p);
3657 if( pIdxInfo->needToFreeIdxStr ){
3658 sqlite3_free(pIdxInfo->idxStr);
danielk19771d461462009-04-21 09:02:45 +00003659 }
drh56f1b992012-09-25 14:29:39 +00003660 sqlite3DbFree(p->pParse->db, pIdxInfo);
shanee26fa4c2009-06-16 14:15:22 +00003661 }else
3662#endif
3663 {
drh56f1b992012-09-25 14:29:39 +00003664 bestBtreeIndex(p);
danielk19771d461462009-04-21 09:02:45 +00003665 }
3666}
drhb6c29892004-11-22 19:12:19 +00003667
3668/*
drh2ffb1182004-07-19 19:14:01 +00003669** Disable a term in the WHERE clause. Except, do not disable the term
3670** if it controls a LEFT OUTER JOIN and it did not originate in the ON
3671** or USING clause of that join.
3672**
3673** Consider the term t2.z='ok' in the following queries:
3674**
3675** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
3676** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
3677** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
3678**
drh23bf66d2004-12-14 03:34:34 +00003679** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00003680** in the ON clause. The term is disabled in (3) because it is not part
3681** of a LEFT OUTER JOIN. In (1), the term is not disabled.
3682**
drhe9cdcea2010-07-22 22:40:03 +00003683** IMPLEMENTATION-OF: R-24597-58655 No tests are done for terms that are
3684** completely satisfied by indices.
3685**
drh2ffb1182004-07-19 19:14:01 +00003686** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00003687** of the join. Disabling is an optimization. When terms are satisfied
3688** by indices, we disable them to prevent redundant tests in the inner
3689** loop. We would get the correct results if nothing were ever disabled,
3690** but joins might run a little slower. The trick is to disable as much
3691** as we can without disabling too much. If we disabled in (1), we'd get
3692** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00003693*/
drh0fcef5e2005-07-19 17:38:22 +00003694static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
3695 if( pTerm
drhbe837bd2010-04-30 21:03:24 +00003696 && (pTerm->wtFlags & TERM_CODED)==0
drh0fcef5e2005-07-19 17:38:22 +00003697 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
3698 ){
drh165be382008-12-05 02:36:33 +00003699 pTerm->wtFlags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00003700 if( pTerm->iParent>=0 ){
3701 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
3702 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00003703 disableTerm(pLevel, pOther);
3704 }
drh0fcef5e2005-07-19 17:38:22 +00003705 }
drh2ffb1182004-07-19 19:14:01 +00003706 }
3707}
3708
3709/*
dan69f8bb92009-08-13 19:21:16 +00003710** Code an OP_Affinity opcode to apply the column affinity string zAff
3711** to the n registers starting at base.
3712**
drh039fc322009-11-17 18:31:47 +00003713** As an optimization, SQLITE_AFF_NONE entries (which are no-ops) at the
3714** beginning and end of zAff are ignored. If all entries in zAff are
3715** SQLITE_AFF_NONE, then no code gets generated.
3716**
3717** This routine makes its own copy of zAff so that the caller is free
3718** to modify zAff after this routine returns.
drh94a11212004-09-25 13:12:14 +00003719*/
dan69f8bb92009-08-13 19:21:16 +00003720static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
3721 Vdbe *v = pParse->pVdbe;
drh039fc322009-11-17 18:31:47 +00003722 if( zAff==0 ){
3723 assert( pParse->db->mallocFailed );
3724 return;
3725 }
dan69f8bb92009-08-13 19:21:16 +00003726 assert( v!=0 );
drh039fc322009-11-17 18:31:47 +00003727
3728 /* Adjust base and n to skip over SQLITE_AFF_NONE entries at the beginning
3729 ** and end of the affinity string.
3730 */
3731 while( n>0 && zAff[0]==SQLITE_AFF_NONE ){
3732 n--;
3733 base++;
3734 zAff++;
3735 }
3736 while( n>1 && zAff[n-1]==SQLITE_AFF_NONE ){
3737 n--;
3738 }
3739
3740 /* Code the OP_Affinity opcode if there is anything left to do. */
3741 if( n>0 ){
3742 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
3743 sqlite3VdbeChangeP4(v, -1, zAff, n);
3744 sqlite3ExprCacheAffinityChange(pParse, base, n);
3745 }
drh94a11212004-09-25 13:12:14 +00003746}
3747
drhe8b97272005-07-19 22:22:12 +00003748
3749/*
drh51147ba2005-07-23 22:59:55 +00003750** Generate code for a single equality term of the WHERE clause. An equality
3751** term can be either X=expr or X IN (...). pTerm is the term to be
3752** coded.
3753**
drh1db639c2008-01-17 02:36:28 +00003754** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00003755**
3756** For a constraint of the form X=expr, the expression is evaluated and its
3757** result is left on the stack. For constraints of the form X IN (...)
3758** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00003759*/
drh678ccce2008-03-31 18:19:54 +00003760static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00003761 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00003762 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh1db639c2008-01-17 02:36:28 +00003763 WhereLevel *pLevel, /* When level of the FROM clause we are working on */
drh678ccce2008-03-31 18:19:54 +00003764 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00003765){
drh0fcef5e2005-07-19 17:38:22 +00003766 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00003767 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00003768 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00003769
danielk19772d605492008-10-01 08:43:03 +00003770 assert( iTarget>0 );
drh50b39962006-10-28 00:28:09 +00003771 if( pX->op==TK_EQ ){
drh678ccce2008-03-31 18:19:54 +00003772 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00003773 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00003774 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00003775 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00003776#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00003777 }else{
danielk19779a96b662007-11-29 17:05:18 +00003778 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00003779 int iTab;
drh72e8fa42007-03-28 14:30:06 +00003780 struct InLoop *pIn;
drh2d96b932013-02-08 18:48:23 +00003781 u8 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
danielk1977b3bce662005-01-29 08:32:43 +00003782
drh50b39962006-10-28 00:28:09 +00003783 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00003784 iReg = iTarget;
danielk19770cdc0222008-06-26 18:04:03 +00003785 eType = sqlite3FindInIndex(pParse, pX, 0);
danielk1977b3bce662005-01-29 08:32:43 +00003786 iTab = pX->iTable;
drh2d96b932013-02-08 18:48:23 +00003787 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
drh111a6a72008-12-21 03:51:16 +00003788 assert( pLevel->plan.wsFlags & WHERE_IN_ABLE );
3789 if( pLevel->u.in.nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00003790 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00003791 }
drh111a6a72008-12-21 03:51:16 +00003792 pLevel->u.in.nIn++;
3793 pLevel->u.in.aInLoop =
3794 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
3795 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
3796 pIn = pLevel->u.in.aInLoop;
drh72e8fa42007-03-28 14:30:06 +00003797 if( pIn ){
drh111a6a72008-12-21 03:51:16 +00003798 pIn += pLevel->u.in.nIn - 1;
drh72e8fa42007-03-28 14:30:06 +00003799 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00003800 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00003801 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00003802 }else{
drhb3190c12008-12-08 21:37:14 +00003803 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00003804 }
drh2d96b932013-02-08 18:48:23 +00003805 pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
drh1db639c2008-01-17 02:36:28 +00003806 sqlite3VdbeAddOp1(v, OP_IsNull, iReg);
drha6110402005-07-28 20:51:19 +00003807 }else{
drh111a6a72008-12-21 03:51:16 +00003808 pLevel->u.in.nIn = 0;
drhe23399f2005-07-22 00:31:39 +00003809 }
danielk1977b3bce662005-01-29 08:32:43 +00003810#endif
drh94a11212004-09-25 13:12:14 +00003811 }
drh0fcef5e2005-07-19 17:38:22 +00003812 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00003813 return iReg;
drh94a11212004-09-25 13:12:14 +00003814}
3815
drh51147ba2005-07-23 22:59:55 +00003816/*
3817** Generate code that will evaluate all == and IN constraints for an
drh039fc322009-11-17 18:31:47 +00003818** index.
drh51147ba2005-07-23 22:59:55 +00003819**
3820** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
3821** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
3822** The index has as many as three equality constraints, but in this
3823** example, the third "c" value is an inequality. So only two
3824** constraints are coded. This routine will generate code to evaluate
drh6df2acd2008-12-28 16:55:25 +00003825** a==5 and b IN (1,2,3). The current values for a and b will be stored
3826** in consecutive registers and the index of the first register is returned.
drh51147ba2005-07-23 22:59:55 +00003827**
3828** In the example above nEq==2. But this subroutine works for any value
3829** of nEq including 0. If nEq==0, this routine is nearly a no-op.
drh039fc322009-11-17 18:31:47 +00003830** The only thing it does is allocate the pLevel->iMem memory cell and
3831** compute the affinity string.
drh51147ba2005-07-23 22:59:55 +00003832**
drh700a2262008-12-17 19:22:15 +00003833** This routine always allocates at least one memory cell and returns
3834** the index of that memory cell. The code that
3835** calls this routine will use that memory cell to store the termination
drh51147ba2005-07-23 22:59:55 +00003836** key value of the loop. If one or more IN operators appear, then
3837** this routine allocates an additional nEq memory cells for internal
3838** use.
dan69f8bb92009-08-13 19:21:16 +00003839**
3840** Before returning, *pzAff is set to point to a buffer containing a
3841** copy of the column affinity string of the index allocated using
3842** sqlite3DbMalloc(). Except, entries in the copy of the string associated
3843** with equality constraints that use NONE affinity are set to
3844** SQLITE_AFF_NONE. This is to deal with SQL such as the following:
3845**
3846** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
3847** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
3848**
3849** In the example above, the index on t1(a) has TEXT affinity. But since
3850** the right hand side of the equality constraint (t2.b) has NONE affinity,
3851** no conversion should be attempted before using a t2.b value as part of
3852** a key to search the index. Hence the first byte in the returned affinity
3853** string in this example would be set to SQLITE_AFF_NONE.
drh51147ba2005-07-23 22:59:55 +00003854*/
drh1db639c2008-01-17 02:36:28 +00003855static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00003856 Parse *pParse, /* Parsing context */
3857 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
3858 WhereClause *pWC, /* The WHERE clause */
drh1db639c2008-01-17 02:36:28 +00003859 Bitmask notReady, /* Which parts of FROM have not yet been coded */
dan69f8bb92009-08-13 19:21:16 +00003860 int nExtraReg, /* Number of extra registers to allocate */
3861 char **pzAff /* OUT: Set to point to affinity string */
drh51147ba2005-07-23 22:59:55 +00003862){
drh111a6a72008-12-21 03:51:16 +00003863 int nEq = pLevel->plan.nEq; /* The number of == or IN constraints to code */
3864 Vdbe *v = pParse->pVdbe; /* The vm under construction */
3865 Index *pIdx; /* The index being used for this loop */
drh51147ba2005-07-23 22:59:55 +00003866 int iCur = pLevel->iTabCur; /* The cursor of the table */
3867 WhereTerm *pTerm; /* A single constraint term */
3868 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00003869 int regBase; /* Base register */
drh6df2acd2008-12-28 16:55:25 +00003870 int nReg; /* Number of registers to allocate */
dan69f8bb92009-08-13 19:21:16 +00003871 char *zAff; /* Affinity string to return */
drh51147ba2005-07-23 22:59:55 +00003872
drh111a6a72008-12-21 03:51:16 +00003873 /* This module is only called on query plans that use an index. */
3874 assert( pLevel->plan.wsFlags & WHERE_INDEXED );
3875 pIdx = pLevel->plan.u.pIdx;
3876
drh51147ba2005-07-23 22:59:55 +00003877 /* Figure out how many memory cells we will need then allocate them.
drh51147ba2005-07-23 22:59:55 +00003878 */
drh700a2262008-12-17 19:22:15 +00003879 regBase = pParse->nMem + 1;
drh6df2acd2008-12-28 16:55:25 +00003880 nReg = pLevel->plan.nEq + nExtraReg;
3881 pParse->nMem += nReg;
drh51147ba2005-07-23 22:59:55 +00003882
dan69f8bb92009-08-13 19:21:16 +00003883 zAff = sqlite3DbStrDup(pParse->db, sqlite3IndexAffinityStr(v, pIdx));
3884 if( !zAff ){
3885 pParse->db->mallocFailed = 1;
3886 }
3887
drh51147ba2005-07-23 22:59:55 +00003888 /* Evaluate the equality constraints
3889 */
drhc49de5d2007-01-19 01:06:01 +00003890 assert( pIdx->nColumn>=nEq );
3891 for(j=0; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00003892 int r1;
drh51147ba2005-07-23 22:59:55 +00003893 int k = pIdx->aiColumn[j];
drh111a6a72008-12-21 03:51:16 +00003894 pTerm = findTerm(pWC, iCur, k, notReady, pLevel->plan.wsFlags, pIdx);
drh7b36ba32012-08-24 21:54:11 +00003895 if( pTerm==0 ) break;
drhbe837bd2010-04-30 21:03:24 +00003896 /* The following true for indices with redundant columns.
3897 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
3898 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
drhe9cdcea2010-07-22 22:40:03 +00003899 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh678ccce2008-03-31 18:19:54 +00003900 r1 = codeEqualityTerm(pParse, pTerm, pLevel, regBase+j);
3901 if( r1!=regBase+j ){
drh6df2acd2008-12-28 16:55:25 +00003902 if( nReg==1 ){
3903 sqlite3ReleaseTempReg(pParse, regBase);
3904 regBase = r1;
3905 }else{
3906 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
3907 }
drh678ccce2008-03-31 18:19:54 +00003908 }
drh981642f2008-04-19 14:40:43 +00003909 testcase( pTerm->eOperator & WO_ISNULL );
3910 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00003911 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drh039fc322009-11-17 18:31:47 +00003912 Expr *pRight = pTerm->pExpr->pRight;
drh2f2855b2009-11-18 01:25:26 +00003913 sqlite3ExprCodeIsNullJump(v, pRight, regBase+j, pLevel->addrBrk);
drh039fc322009-11-17 18:31:47 +00003914 if( zAff ){
3915 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_NONE ){
3916 zAff[j] = SQLITE_AFF_NONE;
3917 }
3918 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
3919 zAff[j] = SQLITE_AFF_NONE;
3920 }
dan69f8bb92009-08-13 19:21:16 +00003921 }
drh51147ba2005-07-23 22:59:55 +00003922 }
3923 }
dan69f8bb92009-08-13 19:21:16 +00003924 *pzAff = zAff;
drh1db639c2008-01-17 02:36:28 +00003925 return regBase;
drh51147ba2005-07-23 22:59:55 +00003926}
3927
dan2ce22452010-11-08 19:01:16 +00003928#ifndef SQLITE_OMIT_EXPLAIN
dan17c0bc02010-11-09 17:35:19 +00003929/*
drh69174c42010-11-12 15:35:59 +00003930** This routine is a helper for explainIndexRange() below
3931**
3932** pStr holds the text of an expression that we are building up one term
3933** at a time. This routine adds a new term to the end of the expression.
3934** Terms are separated by AND so add the "AND" text for second and subsequent
3935** terms only.
3936*/
3937static void explainAppendTerm(
3938 StrAccum *pStr, /* The text expression being built */
3939 int iTerm, /* Index of this term. First is zero */
3940 const char *zColumn, /* Name of the column */
3941 const char *zOp /* Name of the operator */
3942){
3943 if( iTerm ) sqlite3StrAccumAppend(pStr, " AND ", 5);
3944 sqlite3StrAccumAppend(pStr, zColumn, -1);
3945 sqlite3StrAccumAppend(pStr, zOp, 1);
3946 sqlite3StrAccumAppend(pStr, "?", 1);
3947}
3948
3949/*
dan17c0bc02010-11-09 17:35:19 +00003950** Argument pLevel describes a strategy for scanning table pTab. This
3951** function returns a pointer to a string buffer containing a description
3952** of the subset of table rows scanned by the strategy in the form of an
3953** SQL expression. Or, if all rows are scanned, NULL is returned.
3954**
3955** For example, if the query:
3956**
3957** SELECT * FROM t1 WHERE a=1 AND b>2;
3958**
3959** is run and there is an index on (a, b), then this function returns a
3960** string similar to:
3961**
3962** "a=? AND b>?"
3963**
3964** The returned pointer points to memory obtained from sqlite3DbMalloc().
3965** It is the responsibility of the caller to free the buffer when it is
3966** no longer required.
3967*/
3968static char *explainIndexRange(sqlite3 *db, WhereLevel *pLevel, Table *pTab){
dan2ce22452010-11-08 19:01:16 +00003969 WherePlan *pPlan = &pLevel->plan;
3970 Index *pIndex = pPlan->u.pIdx;
3971 int nEq = pPlan->nEq;
drh69174c42010-11-12 15:35:59 +00003972 int i, j;
3973 Column *aCol = pTab->aCol;
3974 int *aiColumn = pIndex->aiColumn;
3975 StrAccum txt;
dan2ce22452010-11-08 19:01:16 +00003976
drh69174c42010-11-12 15:35:59 +00003977 if( nEq==0 && (pPlan->wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ){
3978 return 0;
3979 }
3980 sqlite3StrAccumInit(&txt, 0, 0, SQLITE_MAX_LENGTH);
drh03b6df12010-11-15 16:29:30 +00003981 txt.db = db;
drh69174c42010-11-12 15:35:59 +00003982 sqlite3StrAccumAppend(&txt, " (", 2);
dan2ce22452010-11-08 19:01:16 +00003983 for(i=0; i<nEq; i++){
drh69174c42010-11-12 15:35:59 +00003984 explainAppendTerm(&txt, i, aCol[aiColumn[i]].zName, "=");
dan2ce22452010-11-08 19:01:16 +00003985 }
3986
drh69174c42010-11-12 15:35:59 +00003987 j = i;
dan2ce22452010-11-08 19:01:16 +00003988 if( pPlan->wsFlags&WHERE_BTM_LIMIT ){
dan0c733f62011-11-16 15:27:09 +00003989 char *z = (j==pIndex->nColumn ) ? "rowid" : aCol[aiColumn[j]].zName;
3990 explainAppendTerm(&txt, i++, z, ">");
dan2ce22452010-11-08 19:01:16 +00003991 }
3992 if( pPlan->wsFlags&WHERE_TOP_LIMIT ){
dan0c733f62011-11-16 15:27:09 +00003993 char *z = (j==pIndex->nColumn ) ? "rowid" : aCol[aiColumn[j]].zName;
3994 explainAppendTerm(&txt, i, z, "<");
dan2ce22452010-11-08 19:01:16 +00003995 }
drh69174c42010-11-12 15:35:59 +00003996 sqlite3StrAccumAppend(&txt, ")", 1);
3997 return sqlite3StrAccumFinish(&txt);
dan2ce22452010-11-08 19:01:16 +00003998}
3999
dan17c0bc02010-11-09 17:35:19 +00004000/*
4001** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
4002** command. If the query being compiled is an EXPLAIN QUERY PLAN, a single
4003** record is added to the output to describe the table scan strategy in
4004** pLevel.
4005*/
4006static void explainOneScan(
dan2ce22452010-11-08 19:01:16 +00004007 Parse *pParse, /* Parse context */
4008 SrcList *pTabList, /* Table list this loop refers to */
4009 WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
4010 int iLevel, /* Value for "level" column of output */
dan4a07e3d2010-11-09 14:48:59 +00004011 int iFrom, /* Value for "from" column of output */
4012 u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
dan2ce22452010-11-08 19:01:16 +00004013){
4014 if( pParse->explain==2 ){
4015 u32 flags = pLevel->plan.wsFlags;
4016 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
dan17c0bc02010-11-09 17:35:19 +00004017 Vdbe *v = pParse->pVdbe; /* VM being constructed */
4018 sqlite3 *db = pParse->db; /* Database handle */
4019 char *zMsg; /* Text to add to EQP output */
dan4a07e3d2010-11-09 14:48:59 +00004020 sqlite3_int64 nRow; /* Expected number of rows visited by scan */
4021 int iId = pParse->iSelectId; /* Select id (left-most output column) */
dan4bc39fa2010-11-13 16:42:27 +00004022 int isSearch; /* True for a SEARCH. False for SCAN. */
dan2ce22452010-11-08 19:01:16 +00004023
dan4a07e3d2010-11-09 14:48:59 +00004024 if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_ONETABLE_ONLY) ) return;
dan2ce22452010-11-08 19:01:16 +00004025
drh04098e62010-11-15 21:50:19 +00004026 isSearch = (pLevel->plan.nEq>0)
4027 || (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
4028 || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
dan4bc39fa2010-11-13 16:42:27 +00004029
4030 zMsg = sqlite3MPrintf(db, "%s", isSearch?"SEARCH":"SCAN");
dan4a07e3d2010-11-09 14:48:59 +00004031 if( pItem->pSelect ){
dan4bc39fa2010-11-13 16:42:27 +00004032 zMsg = sqlite3MAppendf(db, zMsg, "%s SUBQUERY %d", zMsg,pItem->iSelectId);
dan4a07e3d2010-11-09 14:48:59 +00004033 }else{
dan4bc39fa2010-11-13 16:42:27 +00004034 zMsg = sqlite3MAppendf(db, zMsg, "%s TABLE %s", zMsg, pItem->zName);
dan4a07e3d2010-11-09 14:48:59 +00004035 }
4036
dan2ce22452010-11-08 19:01:16 +00004037 if( pItem->zAlias ){
4038 zMsg = sqlite3MAppendf(db, zMsg, "%s AS %s", zMsg, pItem->zAlias);
4039 }
4040 if( (flags & WHERE_INDEXED)!=0 ){
dan17c0bc02010-11-09 17:35:19 +00004041 char *zWhere = explainIndexRange(db, pLevel, pItem->pTab);
dan4bc39fa2010-11-13 16:42:27 +00004042 zMsg = sqlite3MAppendf(db, zMsg, "%s USING %s%sINDEX%s%s%s", zMsg,
dan2ce22452010-11-08 19:01:16 +00004043 ((flags & WHERE_TEMP_INDEX)?"AUTOMATIC ":""),
4044 ((flags & WHERE_IDX_ONLY)?"COVERING ":""),
4045 ((flags & WHERE_TEMP_INDEX)?"":" "),
4046 ((flags & WHERE_TEMP_INDEX)?"": pLevel->plan.u.pIdx->zName),
4047 zWhere
4048 );
4049 sqlite3DbFree(db, zWhere);
4050 }else if( flags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
dan4bc39fa2010-11-13 16:42:27 +00004051 zMsg = sqlite3MAppendf(db, zMsg, "%s USING INTEGER PRIMARY KEY", zMsg);
dan2ce22452010-11-08 19:01:16 +00004052
4053 if( flags&WHERE_ROWID_EQ ){
4054 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid=?)", zMsg);
drh04098e62010-11-15 21:50:19 +00004055 }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
dan2ce22452010-11-08 19:01:16 +00004056 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid>? AND rowid<?)", zMsg);
4057 }else if( flags&WHERE_BTM_LIMIT ){
4058 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid>?)", zMsg);
4059 }else if( flags&WHERE_TOP_LIMIT ){
4060 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid<?)", zMsg);
4061 }
4062 }
4063#ifndef SQLITE_OMIT_VIRTUALTABLE
4064 else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
4065 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
4066 zMsg = sqlite3MAppendf(db, zMsg, "%s VIRTUAL TABLE INDEX %d:%s", zMsg,
4067 pVtabIdx->idxNum, pVtabIdx->idxStr);
4068 }
4069#endif
dan4a07e3d2010-11-09 14:48:59 +00004070 if( wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX) ){
drh04098e62010-11-15 21:50:19 +00004071 testcase( wctrlFlags & WHERE_ORDERBY_MIN );
dan4a07e3d2010-11-09 14:48:59 +00004072 nRow = 1;
4073 }else{
4074 nRow = (sqlite3_int64)pLevel->plan.nRow;
4075 }
4076 zMsg = sqlite3MAppendf(db, zMsg, "%s (~%lld rows)", zMsg, nRow);
4077 sqlite3VdbeAddOp4(v, OP_Explain, iId, iLevel, iFrom, zMsg, P4_DYNAMIC);
dan2ce22452010-11-08 19:01:16 +00004078 }
4079}
4080#else
dan17c0bc02010-11-09 17:35:19 +00004081# define explainOneScan(u,v,w,x,y,z)
dan2ce22452010-11-08 19:01:16 +00004082#endif /* SQLITE_OMIT_EXPLAIN */
4083
4084
drh111a6a72008-12-21 03:51:16 +00004085/*
4086** Generate code for the start of the iLevel-th loop in the WHERE clause
4087** implementation described by pWInfo.
4088*/
4089static Bitmask codeOneLoopStart(
4090 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
4091 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh336a5302009-04-24 15:46:21 +00004092 u16 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
drh7a484802012-03-16 00:28:11 +00004093 Bitmask notReady /* Which tables are currently available */
drh111a6a72008-12-21 03:51:16 +00004094){
4095 int j, k; /* Loop counters */
4096 int iCur; /* The VDBE cursor for the table */
4097 int addrNxt; /* Where to jump to continue with the next IN case */
4098 int omitTable; /* True if we use the index only */
4099 int bRev; /* True if we need to scan in reverse order */
4100 WhereLevel *pLevel; /* The where level to be coded */
4101 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
4102 WhereTerm *pTerm; /* A WHERE clause term */
4103 Parse *pParse; /* Parsing context */
4104 Vdbe *v; /* The prepared stmt under constructions */
4105 struct SrcList_item *pTabItem; /* FROM clause term being coded */
drh23d04d52008-12-23 23:56:22 +00004106 int addrBrk; /* Jump here to break out of the loop */
4107 int addrCont; /* Jump here to continue with next cycle */
drh61495262009-04-22 15:32:59 +00004108 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
4109 int iReleaseReg = 0; /* Temp register to free before returning */
drh111a6a72008-12-21 03:51:16 +00004110
4111 pParse = pWInfo->pParse;
4112 v = pParse->pVdbe;
4113 pWC = pWInfo->pWC;
4114 pLevel = &pWInfo->a[iLevel];
4115 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
4116 iCur = pTabItem->iCursor;
4117 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
danielk19771d461462009-04-21 09:02:45 +00004118 omitTable = (pLevel->plan.wsFlags & WHERE_IDX_ONLY)!=0
drh336a5302009-04-24 15:46:21 +00004119 && (wctrlFlags & WHERE_FORCE_TABLE)==0;
drh111a6a72008-12-21 03:51:16 +00004120
4121 /* Create labels for the "break" and "continue" instructions
4122 ** for the current loop. Jump to addrBrk to break out of a loop.
4123 ** Jump to cont to go immediately to the next iteration of the
4124 ** loop.
4125 **
4126 ** When there is an IN operator, we also have a "addrNxt" label that
4127 ** means to continue with the next IN value combination. When
4128 ** there are no IN operators in the constraints, the "addrNxt" label
4129 ** is the same as "addrBrk".
4130 */
4131 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
4132 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
4133
4134 /* If this is the right table of a LEFT OUTER JOIN, allocate and
4135 ** initialize a memory cell that records if this table matches any
4136 ** row of the left table of the join.
4137 */
4138 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
4139 pLevel->iLeftJoin = ++pParse->nMem;
4140 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
4141 VdbeComment((v, "init LEFT JOIN no-match flag"));
4142 }
4143
drh21172c42012-10-30 00:29:07 +00004144 /* Special case of a FROM clause subquery implemented as a co-routine */
4145 if( pTabItem->viaCoroutine ){
4146 int regYield = pTabItem->regReturn;
4147 sqlite3VdbeAddOp2(v, OP_Integer, pTabItem->addrFillSub-1, regYield);
4148 pLevel->p2 = sqlite3VdbeAddOp1(v, OP_Yield, regYield);
4149 VdbeComment((v, "next row of co-routine %s", pTabItem->pTab->zName));
4150 sqlite3VdbeAddOp2(v, OP_If, regYield+1, addrBrk);
4151 pLevel->op = OP_Goto;
4152 }else
4153
drh111a6a72008-12-21 03:51:16 +00004154#ifndef SQLITE_OMIT_VIRTUALTABLE
4155 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
4156 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
4157 ** to access the data.
4158 */
4159 int iReg; /* P3 Value for OP_VFilter */
drh281bbe22012-10-16 23:17:14 +00004160 int addrNotFound;
drh111a6a72008-12-21 03:51:16 +00004161 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
4162 int nConstraint = pVtabIdx->nConstraint;
4163 struct sqlite3_index_constraint_usage *aUsage =
4164 pVtabIdx->aConstraintUsage;
4165 const struct sqlite3_index_constraint *aConstraint =
4166 pVtabIdx->aConstraint;
4167
drha62bb8d2009-11-23 21:23:45 +00004168 sqlite3ExprCachePush(pParse);
drh111a6a72008-12-21 03:51:16 +00004169 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
drh281bbe22012-10-16 23:17:14 +00004170 addrNotFound = pLevel->addrBrk;
drh111a6a72008-12-21 03:51:16 +00004171 for(j=1; j<=nConstraint; j++){
4172 for(k=0; k<nConstraint; k++){
4173 if( aUsage[k].argvIndex==j ){
drh281bbe22012-10-16 23:17:14 +00004174 int iTarget = iReg+j+1;
drh928d9c62013-02-07 09:33:56 +00004175 pTerm = &pWC->a[aConstraint[k].iTermOffset];
drh281bbe22012-10-16 23:17:14 +00004176 if( pTerm->eOperator & WO_IN ){
4177 codeEqualityTerm(pParse, pTerm, pLevel, iTarget);
4178 addrNotFound = pLevel->addrNxt;
4179 }else{
4180 sqlite3ExprCode(pParse, pTerm->pExpr->pRight, iTarget);
4181 }
drh111a6a72008-12-21 03:51:16 +00004182 break;
4183 }
4184 }
4185 if( k==nConstraint ) break;
4186 }
drh111a6a72008-12-21 03:51:16 +00004187 sqlite3VdbeAddOp2(v, OP_Integer, pVtabIdx->idxNum, iReg);
4188 sqlite3VdbeAddOp2(v, OP_Integer, j-1, iReg+1);
drh281bbe22012-10-16 23:17:14 +00004189 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg, pVtabIdx->idxStr,
drh111a6a72008-12-21 03:51:16 +00004190 pVtabIdx->needToFreeIdxStr ? P4_MPRINTF : P4_STATIC);
drh111a6a72008-12-21 03:51:16 +00004191 pVtabIdx->needToFreeIdxStr = 0;
4192 for(j=0; j<nConstraint; j++){
4193 if( aUsage[j].omit ){
4194 int iTerm = aConstraint[j].iTermOffset;
4195 disableTerm(pLevel, &pWC->a[iTerm]);
4196 }
4197 }
4198 pLevel->op = OP_VNext;
4199 pLevel->p1 = iCur;
4200 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh23d04d52008-12-23 23:56:22 +00004201 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drha62bb8d2009-11-23 21:23:45 +00004202 sqlite3ExprCachePop(pParse, 1);
drh111a6a72008-12-21 03:51:16 +00004203 }else
4204#endif /* SQLITE_OMIT_VIRTUALTABLE */
4205
4206 if( pLevel->plan.wsFlags & WHERE_ROWID_EQ ){
4207 /* Case 1: We can directly reference a single row using an
4208 ** equality comparison against the ROWID field. Or
4209 ** we reference multiple rows using a "rowid IN (...)"
4210 ** construct.
4211 */
danielk19771d461462009-04-21 09:02:45 +00004212 iReleaseReg = sqlite3GetTempReg(pParse);
drh111a6a72008-12-21 03:51:16 +00004213 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
4214 assert( pTerm!=0 );
4215 assert( pTerm->pExpr!=0 );
drh111a6a72008-12-21 03:51:16 +00004216 assert( omitTable==0 );
drhe9cdcea2010-07-22 22:40:03 +00004217 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
danielk19771d461462009-04-21 09:02:45 +00004218 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, iReleaseReg);
drh111a6a72008-12-21 03:51:16 +00004219 addrNxt = pLevel->addrNxt;
danielk19771d461462009-04-21 09:02:45 +00004220 sqlite3VdbeAddOp2(v, OP_MustBeInt, iRowidReg, addrNxt);
4221 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, iRowidReg);
drhceea3322009-04-23 13:22:42 +00004222 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
drh111a6a72008-12-21 03:51:16 +00004223 VdbeComment((v, "pk"));
4224 pLevel->op = OP_Noop;
4225 }else if( pLevel->plan.wsFlags & WHERE_ROWID_RANGE ){
4226 /* Case 2: We have an inequality comparison against the ROWID field.
4227 */
4228 int testOp = OP_Noop;
4229 int start;
4230 int memEndValue = 0;
4231 WhereTerm *pStart, *pEnd;
4232
4233 assert( omitTable==0 );
4234 pStart = findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0);
4235 pEnd = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0);
4236 if( bRev ){
4237 pTerm = pStart;
4238 pStart = pEnd;
4239 pEnd = pTerm;
4240 }
4241 if( pStart ){
4242 Expr *pX; /* The expression that defines the start bound */
4243 int r1, rTemp; /* Registers for holding the start boundary */
4244
4245 /* The following constant maps TK_xx codes into corresponding
4246 ** seek opcodes. It depends on a particular ordering of TK_xx
4247 */
4248 const u8 aMoveOp[] = {
4249 /* TK_GT */ OP_SeekGt,
4250 /* TK_LE */ OP_SeekLe,
4251 /* TK_LT */ OP_SeekLt,
4252 /* TK_GE */ OP_SeekGe
4253 };
4254 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
4255 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
4256 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
4257
drhe9cdcea2010-07-22 22:40:03 +00004258 testcase( pStart->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004259 pX = pStart->pExpr;
4260 assert( pX!=0 );
4261 assert( pStart->leftCursor==iCur );
4262 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
4263 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
4264 VdbeComment((v, "pk"));
4265 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
4266 sqlite3ReleaseTempReg(pParse, rTemp);
4267 disableTerm(pLevel, pStart);
4268 }else{
4269 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
4270 }
4271 if( pEnd ){
4272 Expr *pX;
4273 pX = pEnd->pExpr;
4274 assert( pX!=0 );
4275 assert( pEnd->leftCursor==iCur );
drhe9cdcea2010-07-22 22:40:03 +00004276 testcase( pEnd->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004277 memEndValue = ++pParse->nMem;
4278 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
4279 if( pX->op==TK_LT || pX->op==TK_GT ){
4280 testOp = bRev ? OP_Le : OP_Ge;
4281 }else{
4282 testOp = bRev ? OP_Lt : OP_Gt;
4283 }
4284 disableTerm(pLevel, pEnd);
4285 }
4286 start = sqlite3VdbeCurrentAddr(v);
4287 pLevel->op = bRev ? OP_Prev : OP_Next;
4288 pLevel->p1 = iCur;
4289 pLevel->p2 = start;
drhafc266a2010-03-31 17:47:44 +00004290 if( pStart==0 && pEnd==0 ){
4291 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4292 }else{
4293 assert( pLevel->p5==0 );
4294 }
danielk19771d461462009-04-21 09:02:45 +00004295 if( testOp!=OP_Noop ){
4296 iRowidReg = iReleaseReg = sqlite3GetTempReg(pParse);
4297 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00004298 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00004299 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
4300 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00004301 }
4302 }else if( pLevel->plan.wsFlags & (WHERE_COLUMN_RANGE|WHERE_COLUMN_EQ) ){
4303 /* Case 3: A scan using an index.
4304 **
4305 ** The WHERE clause may contain zero or more equality
4306 ** terms ("==" or "IN" operators) that refer to the N
4307 ** left-most columns of the index. It may also contain
4308 ** inequality constraints (>, <, >= or <=) on the indexed
4309 ** column that immediately follows the N equalities. Only
4310 ** the right-most column can be an inequality - the rest must
4311 ** use the "==" and "IN" operators. For example, if the
4312 ** index is on (x,y,z), then the following clauses are all
4313 ** optimized:
4314 **
4315 ** x=5
4316 ** x=5 AND y=10
4317 ** x=5 AND y<10
4318 ** x=5 AND y>5 AND y<10
4319 ** x=5 AND y=5 AND z<=10
4320 **
4321 ** The z<10 term of the following cannot be used, only
4322 ** the x=5 term:
4323 **
4324 ** x=5 AND z<10
4325 **
4326 ** N may be zero if there are inequality constraints.
4327 ** If there are no inequality constraints, then N is at
4328 ** least one.
4329 **
4330 ** This case is also used when there are no WHERE clause
4331 ** constraints but an index is selected anyway, in order
4332 ** to force the output order to conform to an ORDER BY.
4333 */
drh3bb9b932010-08-06 02:10:00 +00004334 static const u8 aStartOp[] = {
drh111a6a72008-12-21 03:51:16 +00004335 0,
4336 0,
4337 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
4338 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
4339 OP_SeekGt, /* 4: (start_constraints && !startEq && !bRev) */
4340 OP_SeekLt, /* 5: (start_constraints && !startEq && bRev) */
4341 OP_SeekGe, /* 6: (start_constraints && startEq && !bRev) */
4342 OP_SeekLe /* 7: (start_constraints && startEq && bRev) */
4343 };
drh3bb9b932010-08-06 02:10:00 +00004344 static const u8 aEndOp[] = {
drh111a6a72008-12-21 03:51:16 +00004345 OP_Noop, /* 0: (!end_constraints) */
4346 OP_IdxGE, /* 1: (end_constraints && !bRev) */
4347 OP_IdxLT /* 2: (end_constraints && bRev) */
4348 };
drh3bb9b932010-08-06 02:10:00 +00004349 int nEq = pLevel->plan.nEq; /* Number of == or IN terms */
drh111a6a72008-12-21 03:51:16 +00004350 int isMinQuery = 0; /* If this is an optimized SELECT min(x).. */
4351 int regBase; /* Base register holding constraint values */
4352 int r1; /* Temp register */
4353 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
4354 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
4355 int startEq; /* True if range start uses ==, >= or <= */
4356 int endEq; /* True if range end uses ==, >= or <= */
4357 int start_constraints; /* Start of range is constrained */
4358 int nConstraint; /* Number of constraint terms */
drh3bb9b932010-08-06 02:10:00 +00004359 Index *pIdx; /* The index we will be using */
4360 int iIdxCur; /* The VDBE cursor for the index */
4361 int nExtraReg = 0; /* Number of extra registers needed */
4362 int op; /* Instruction opcode */
dan6ac43392010-06-09 15:47:11 +00004363 char *zStartAff; /* Affinity for start of range constraint */
4364 char *zEndAff; /* Affinity for end of range constraint */
drh111a6a72008-12-21 03:51:16 +00004365
4366 pIdx = pLevel->plan.u.pIdx;
4367 iIdxCur = pLevel->iIdxCur;
dan0c733f62011-11-16 15:27:09 +00004368 k = (nEq==pIdx->nColumn ? -1 : pIdx->aiColumn[nEq]);
drh111a6a72008-12-21 03:51:16 +00004369
drh111a6a72008-12-21 03:51:16 +00004370 /* If this loop satisfies a sort order (pOrderBy) request that
4371 ** was passed to this function to implement a "SELECT min(x) ..."
4372 ** query, then the caller will only allow the loop to run for
4373 ** a single iteration. This means that the first row returned
4374 ** should not have a NULL value stored in 'x'. If column 'x' is
4375 ** the first one after the nEq equality constraints in the index,
4376 ** this requires some special handling.
4377 */
4378 if( (wctrlFlags&WHERE_ORDERBY_MIN)!=0
drhd663b5b2012-10-03 00:25:54 +00004379 && (pLevel->plan.wsFlags&WHERE_ORDERED)
drh111a6a72008-12-21 03:51:16 +00004380 && (pIdx->nColumn>nEq)
4381 ){
4382 /* assert( pOrderBy->nExpr==1 ); */
4383 /* assert( pOrderBy->a[0].pExpr->iColumn==pIdx->aiColumn[nEq] ); */
4384 isMinQuery = 1;
drh6df2acd2008-12-28 16:55:25 +00004385 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004386 }
4387
4388 /* Find any inequality constraint terms for the start and end
4389 ** of the range.
4390 */
4391 if( pLevel->plan.wsFlags & WHERE_TOP_LIMIT ){
4392 pRangeEnd = findTerm(pWC, iCur, k, notReady, (WO_LT|WO_LE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00004393 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004394 }
4395 if( pLevel->plan.wsFlags & WHERE_BTM_LIMIT ){
4396 pRangeStart = findTerm(pWC, iCur, k, notReady, (WO_GT|WO_GE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00004397 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004398 }
4399
drh6df2acd2008-12-28 16:55:25 +00004400 /* Generate code to evaluate all constraint terms using == or IN
4401 ** and store the values of those terms in an array of registers
4402 ** starting at regBase.
4403 */
dan69f8bb92009-08-13 19:21:16 +00004404 regBase = codeAllEqualityTerms(
dan6ac43392010-06-09 15:47:11 +00004405 pParse, pLevel, pWC, notReady, nExtraReg, &zStartAff
dan69f8bb92009-08-13 19:21:16 +00004406 );
dan6ac43392010-06-09 15:47:11 +00004407 zEndAff = sqlite3DbStrDup(pParse->db, zStartAff);
drh6df2acd2008-12-28 16:55:25 +00004408 addrNxt = pLevel->addrNxt;
4409
drh111a6a72008-12-21 03:51:16 +00004410 /* If we are doing a reverse order scan on an ascending index, or
4411 ** a forward order scan on a descending index, interchange the
4412 ** start and end terms (pRangeStart and pRangeEnd).
4413 */
dan0c733f62011-11-16 15:27:09 +00004414 if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
4415 || (bRev && pIdx->nColumn==nEq)
4416 ){
drh111a6a72008-12-21 03:51:16 +00004417 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
4418 }
4419
4420 testcase( pRangeStart && pRangeStart->eOperator & WO_LE );
4421 testcase( pRangeStart && pRangeStart->eOperator & WO_GE );
4422 testcase( pRangeEnd && pRangeEnd->eOperator & WO_LE );
4423 testcase( pRangeEnd && pRangeEnd->eOperator & WO_GE );
4424 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
4425 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
4426 start_constraints = pRangeStart || nEq>0;
4427
4428 /* Seek the index cursor to the start of the range. */
4429 nConstraint = nEq;
4430 if( pRangeStart ){
dan69f8bb92009-08-13 19:21:16 +00004431 Expr *pRight = pRangeStart->pExpr->pRight;
4432 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh534230c2011-01-22 00:10:45 +00004433 if( (pRangeStart->wtFlags & TERM_VNULL)==0 ){
4434 sqlite3ExprCodeIsNullJump(v, pRight, regBase+nEq, addrNxt);
4435 }
dan6ac43392010-06-09 15:47:11 +00004436 if( zStartAff ){
4437 if( sqlite3CompareAffinity(pRight, zStartAff[nEq])==SQLITE_AFF_NONE){
drh039fc322009-11-17 18:31:47 +00004438 /* Since the comparison is to be performed with no conversions
4439 ** applied to the operands, set the affinity to apply to pRight to
4440 ** SQLITE_AFF_NONE. */
dan6ac43392010-06-09 15:47:11 +00004441 zStartAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004442 }
dan6ac43392010-06-09 15:47:11 +00004443 if( sqlite3ExprNeedsNoAffinityChange(pRight, zStartAff[nEq]) ){
4444 zStartAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004445 }
4446 }
drh111a6a72008-12-21 03:51:16 +00004447 nConstraint++;
drhe9cdcea2010-07-22 22:40:03 +00004448 testcase( pRangeStart->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004449 }else if( isMinQuery ){
4450 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
4451 nConstraint++;
4452 startEq = 0;
4453 start_constraints = 1;
4454 }
dan6ac43392010-06-09 15:47:11 +00004455 codeApplyAffinity(pParse, regBase, nConstraint, zStartAff);
drh111a6a72008-12-21 03:51:16 +00004456 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
4457 assert( op!=0 );
4458 testcase( op==OP_Rewind );
4459 testcase( op==OP_Last );
4460 testcase( op==OP_SeekGt );
4461 testcase( op==OP_SeekGe );
4462 testcase( op==OP_SeekLe );
4463 testcase( op==OP_SeekLt );
drh8cff69d2009-11-12 19:59:44 +00004464 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh111a6a72008-12-21 03:51:16 +00004465
4466 /* Load the value for the inequality constraint at the end of the
4467 ** range (if any).
4468 */
4469 nConstraint = nEq;
4470 if( pRangeEnd ){
dan69f8bb92009-08-13 19:21:16 +00004471 Expr *pRight = pRangeEnd->pExpr->pRight;
drhf49f3522009-12-30 14:12:38 +00004472 sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
dan69f8bb92009-08-13 19:21:16 +00004473 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh534230c2011-01-22 00:10:45 +00004474 if( (pRangeEnd->wtFlags & TERM_VNULL)==0 ){
4475 sqlite3ExprCodeIsNullJump(v, pRight, regBase+nEq, addrNxt);
4476 }
dan6ac43392010-06-09 15:47:11 +00004477 if( zEndAff ){
4478 if( sqlite3CompareAffinity(pRight, zEndAff[nEq])==SQLITE_AFF_NONE){
drh039fc322009-11-17 18:31:47 +00004479 /* Since the comparison is to be performed with no conversions
4480 ** applied to the operands, set the affinity to apply to pRight to
4481 ** SQLITE_AFF_NONE. */
dan6ac43392010-06-09 15:47:11 +00004482 zEndAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004483 }
dan6ac43392010-06-09 15:47:11 +00004484 if( sqlite3ExprNeedsNoAffinityChange(pRight, zEndAff[nEq]) ){
4485 zEndAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004486 }
4487 }
dan6ac43392010-06-09 15:47:11 +00004488 codeApplyAffinity(pParse, regBase, nEq+1, zEndAff);
drh111a6a72008-12-21 03:51:16 +00004489 nConstraint++;
drhe9cdcea2010-07-22 22:40:03 +00004490 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004491 }
dan6ac43392010-06-09 15:47:11 +00004492 sqlite3DbFree(pParse->db, zStartAff);
4493 sqlite3DbFree(pParse->db, zEndAff);
drh111a6a72008-12-21 03:51:16 +00004494
4495 /* Top of the loop body */
4496 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
4497
4498 /* Check if the index cursor is past the end of the range. */
4499 op = aEndOp[(pRangeEnd || nEq) * (1 + bRev)];
4500 testcase( op==OP_Noop );
4501 testcase( op==OP_IdxGE );
4502 testcase( op==OP_IdxLT );
drh6df2acd2008-12-28 16:55:25 +00004503 if( op!=OP_Noop ){
drh8cff69d2009-11-12 19:59:44 +00004504 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh6df2acd2008-12-28 16:55:25 +00004505 sqlite3VdbeChangeP5(v, endEq!=bRev ?1:0);
4506 }
drh111a6a72008-12-21 03:51:16 +00004507
4508 /* If there are inequality constraints, check that the value
4509 ** of the table column that the inequality contrains is not NULL.
4510 ** If it is, jump to the next iteration of the loop.
4511 */
4512 r1 = sqlite3GetTempReg(pParse);
4513 testcase( pLevel->plan.wsFlags & WHERE_BTM_LIMIT );
4514 testcase( pLevel->plan.wsFlags & WHERE_TOP_LIMIT );
drh04098e62010-11-15 21:50:19 +00004515 if( (pLevel->plan.wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0 ){
drh111a6a72008-12-21 03:51:16 +00004516 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, nEq, r1);
4517 sqlite3VdbeAddOp2(v, OP_IsNull, r1, addrCont);
4518 }
danielk19771d461462009-04-21 09:02:45 +00004519 sqlite3ReleaseTempReg(pParse, r1);
drh111a6a72008-12-21 03:51:16 +00004520
4521 /* Seek the table cursor, if required */
drh23d04d52008-12-23 23:56:22 +00004522 disableTerm(pLevel, pRangeStart);
4523 disableTerm(pLevel, pRangeEnd);
danielk19771d461462009-04-21 09:02:45 +00004524 if( !omitTable ){
4525 iRowidReg = iReleaseReg = sqlite3GetTempReg(pParse);
4526 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00004527 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00004528 sqlite3VdbeAddOp2(v, OP_Seek, iCur, iRowidReg); /* Deferred seek */
drh111a6a72008-12-21 03:51:16 +00004529 }
drh111a6a72008-12-21 03:51:16 +00004530
4531 /* Record the instruction used to terminate the loop. Disable
4532 ** WHERE clause terms made redundant by the index range scan.
4533 */
drh95e037b2011-03-09 21:02:31 +00004534 if( pLevel->plan.wsFlags & WHERE_UNIQUE ){
4535 pLevel->op = OP_Noop;
4536 }else if( bRev ){
4537 pLevel->op = OP_Prev;
4538 }else{
4539 pLevel->op = OP_Next;
4540 }
drh111a6a72008-12-21 03:51:16 +00004541 pLevel->p1 = iIdxCur;
drh3f4d1d12012-09-15 18:45:54 +00004542 if( pLevel->plan.wsFlags & WHERE_COVER_SCAN ){
4543 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4544 }else{
4545 assert( pLevel->p5==0 );
4546 }
drhdd5f5a62008-12-23 13:35:23 +00004547 }else
4548
drh23d04d52008-12-23 23:56:22 +00004549#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00004550 if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drh111a6a72008-12-21 03:51:16 +00004551 /* Case 4: Two or more separately indexed terms connected by OR
4552 **
4553 ** Example:
4554 **
4555 ** CREATE TABLE t1(a,b,c,d);
4556 ** CREATE INDEX i1 ON t1(a);
4557 ** CREATE INDEX i2 ON t1(b);
4558 ** CREATE INDEX i3 ON t1(c);
4559 **
4560 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
4561 **
4562 ** In the example, there are three indexed terms connected by OR.
danielk19771d461462009-04-21 09:02:45 +00004563 ** The top of the loop looks like this:
drh111a6a72008-12-21 03:51:16 +00004564 **
drh1b26c7c2009-04-22 02:15:47 +00004565 ** Null 1 # Zero the rowset in reg 1
drh111a6a72008-12-21 03:51:16 +00004566 **
danielk19771d461462009-04-21 09:02:45 +00004567 ** Then, for each indexed term, the following. The arguments to
drh1b26c7c2009-04-22 02:15:47 +00004568 ** RowSetTest are such that the rowid of the current row is inserted
4569 ** into the RowSet. If it is already present, control skips the
danielk19771d461462009-04-21 09:02:45 +00004570 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
drh111a6a72008-12-21 03:51:16 +00004571 **
danielk19771d461462009-04-21 09:02:45 +00004572 ** sqlite3WhereBegin(<term>)
drh1b26c7c2009-04-22 02:15:47 +00004573 ** RowSetTest # Insert rowid into rowset
danielk19771d461462009-04-21 09:02:45 +00004574 ** Gosub 2 A
4575 ** sqlite3WhereEnd()
4576 **
4577 ** Following the above, code to terminate the loop. Label A, the target
4578 ** of the Gosub above, jumps to the instruction right after the Goto.
4579 **
drh1b26c7c2009-04-22 02:15:47 +00004580 ** Null 1 # Zero the rowset in reg 1
danielk19771d461462009-04-21 09:02:45 +00004581 ** Goto B # The loop is finished.
4582 **
4583 ** A: <loop body> # Return data, whatever.
4584 **
4585 ** Return 2 # Jump back to the Gosub
4586 **
4587 ** B: <after the loop>
4588 **
drh111a6a72008-12-21 03:51:16 +00004589 */
drh111a6a72008-12-21 03:51:16 +00004590 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
drhc01a3c12009-12-16 22:10:49 +00004591 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
dan0efb72c2012-08-24 18:44:56 +00004592 Index *pCov = 0; /* Potential covering index (or NULL) */
4593 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
danielk19771d461462009-04-21 09:02:45 +00004594
4595 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
shane85095702009-06-15 16:27:08 +00004596 int regRowset = 0; /* Register for RowSet object */
4597 int regRowid = 0; /* Register holding rowid */
danielk19771d461462009-04-21 09:02:45 +00004598 int iLoopBody = sqlite3VdbeMakeLabel(v); /* Start of loop body */
4599 int iRetInit; /* Address of regReturn init */
drhc01a3c12009-12-16 22:10:49 +00004600 int untestedTerms = 0; /* Some terms not completely tested */
drh8871ef52011-10-07 13:33:10 +00004601 int ii; /* Loop counter */
4602 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
drh111a6a72008-12-21 03:51:16 +00004603
4604 pTerm = pLevel->plan.u.pTerm;
4605 assert( pTerm!=0 );
drh7a5bcc02013-01-16 17:08:58 +00004606 assert( pTerm->eOperator & WO_OR );
drh111a6a72008-12-21 03:51:16 +00004607 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
4608 pOrWc = &pTerm->u.pOrInfo->wc;
drhc01a3c12009-12-16 22:10:49 +00004609 pLevel->op = OP_Return;
4610 pLevel->p1 = regReturn;
drh23d04d52008-12-23 23:56:22 +00004611
danbfca6a42012-08-24 10:52:35 +00004612 /* Set up a new SrcList in pOrTab containing the table being scanned
drhc01a3c12009-12-16 22:10:49 +00004613 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
4614 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
4615 */
4616 if( pWInfo->nLevel>1 ){
4617 int nNotReady; /* The number of notReady tables */
4618 struct SrcList_item *origSrc; /* Original list of tables */
4619 nNotReady = pWInfo->nLevel - iLevel - 1;
4620 pOrTab = sqlite3StackAllocRaw(pParse->db,
4621 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
4622 if( pOrTab==0 ) return notReady;
shaneh46aae3c2009-12-31 19:06:23 +00004623 pOrTab->nAlloc = (i16)(nNotReady + 1);
4624 pOrTab->nSrc = pOrTab->nAlloc;
drhc01a3c12009-12-16 22:10:49 +00004625 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
4626 origSrc = pWInfo->pTabList->a;
4627 for(k=1; k<=nNotReady; k++){
4628 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
4629 }
4630 }else{
4631 pOrTab = pWInfo->pTabList;
4632 }
danielk19771d461462009-04-21 09:02:45 +00004633
drh1b26c7c2009-04-22 02:15:47 +00004634 /* Initialize the rowset register to contain NULL. An SQL NULL is
4635 ** equivalent to an empty rowset.
danielk19771d461462009-04-21 09:02:45 +00004636 **
4637 ** Also initialize regReturn to contain the address of the instruction
4638 ** immediately following the OP_Return at the bottom of the loop. This
4639 ** is required in a few obscure LEFT JOIN cases where control jumps
4640 ** over the top of the loop into the body of it. In this case the
4641 ** correct response for the end-of-loop code (the OP_Return) is to
4642 ** fall through to the next instruction, just as an OP_Next does if
4643 ** called on an uninitialized cursor.
4644 */
drh336a5302009-04-24 15:46:21 +00004645 if( (wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
4646 regRowset = ++pParse->nMem;
4647 regRowid = ++pParse->nMem;
4648 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
4649 }
danielk19771d461462009-04-21 09:02:45 +00004650 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
4651
drh8871ef52011-10-07 13:33:10 +00004652 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
4653 ** Then for every term xN, evaluate as the subexpression: xN AND z
4654 ** That way, terms in y that are factored into the disjunction will
4655 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
drh331b67c2012-03-09 22:02:08 +00004656 **
4657 ** Actually, each subexpression is converted to "xN AND w" where w is
4658 ** the "interesting" terms of z - terms that did not originate in the
4659 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
4660 ** indices.
drh8871ef52011-10-07 13:33:10 +00004661 */
4662 if( pWC->nTerm>1 ){
drh7a484802012-03-16 00:28:11 +00004663 int iTerm;
4664 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
4665 Expr *pExpr = pWC->a[iTerm].pExpr;
drh331b67c2012-03-09 22:02:08 +00004666 if( ExprHasProperty(pExpr, EP_FromJoin) ) continue;
drh7a484802012-03-16 00:28:11 +00004667 if( pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_ORINFO) ) continue;
4668 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drh331b67c2012-03-09 22:02:08 +00004669 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4670 pAndExpr = sqlite3ExprAnd(pParse->db, pAndExpr, pExpr);
4671 }
4672 if( pAndExpr ){
4673 pAndExpr = sqlite3PExpr(pParse, TK_AND, 0, pAndExpr, 0);
4674 }
drh8871ef52011-10-07 13:33:10 +00004675 }
4676
danielk19771d461462009-04-21 09:02:45 +00004677 for(ii=0; ii<pOrWc->nTerm; ii++){
4678 WhereTerm *pOrTerm = &pOrWc->a[ii];
drh7a5bcc02013-01-16 17:08:58 +00004679 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
danielk19771d461462009-04-21 09:02:45 +00004680 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
drh8871ef52011-10-07 13:33:10 +00004681 Expr *pOrExpr = pOrTerm->pExpr;
4682 if( pAndExpr ){
4683 pAndExpr->pLeft = pOrExpr;
4684 pOrExpr = pAndExpr;
4685 }
danielk19771d461462009-04-21 09:02:45 +00004686 /* Loop through table entries that match term pOrTerm. */
drh8871ef52011-10-07 13:33:10 +00004687 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
drh9ef61f42011-10-07 14:40:59 +00004688 WHERE_OMIT_OPEN_CLOSE | WHERE_AND_ONLY |
dan0efb72c2012-08-24 18:44:56 +00004689 WHERE_FORCE_TABLE | WHERE_ONETABLE_ONLY, iCovCur);
danbfca6a42012-08-24 10:52:35 +00004690 assert( pSubWInfo || pParse->nErr || pParse->db->mallocFailed );
danielk19771d461462009-04-21 09:02:45 +00004691 if( pSubWInfo ){
danbfca6a42012-08-24 10:52:35 +00004692 WhereLevel *pLvl;
dan17c0bc02010-11-09 17:35:19 +00004693 explainOneScan(
dan4a07e3d2010-11-09 14:48:59 +00004694 pParse, pOrTab, &pSubWInfo->a[0], iLevel, pLevel->iFrom, 0
dan2ce22452010-11-08 19:01:16 +00004695 );
drh336a5302009-04-24 15:46:21 +00004696 if( (wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
4697 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
4698 int r;
4699 r = sqlite3ExprCodeGetColumn(pParse, pTabItem->pTab, -1, iCur,
drha748fdc2012-03-28 01:34:47 +00004700 regRowid, 0);
drh8cff69d2009-11-12 19:59:44 +00004701 sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset,
4702 sqlite3VdbeCurrentAddr(v)+2, r, iSet);
drh336a5302009-04-24 15:46:21 +00004703 }
danielk19771d461462009-04-21 09:02:45 +00004704 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
4705
drhc01a3c12009-12-16 22:10:49 +00004706 /* The pSubWInfo->untestedTerms flag means that this OR term
4707 ** contained one or more AND term from a notReady table. The
4708 ** terms from the notReady table could not be tested and will
4709 ** need to be tested later.
4710 */
4711 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
4712
danbfca6a42012-08-24 10:52:35 +00004713 /* If all of the OR-connected terms are optimized using the same
4714 ** index, and the index is opened using the same cursor number
4715 ** by each call to sqlite3WhereBegin() made by this loop, it may
4716 ** be possible to use that index as a covering index.
4717 **
4718 ** If the call to sqlite3WhereBegin() above resulted in a scan that
4719 ** uses an index, and this is either the first OR-connected term
4720 ** processed or the index is the same as that used by all previous
dan0efb72c2012-08-24 18:44:56 +00004721 ** terms, set pCov to the candidate covering index. Otherwise, set
4722 ** pCov to NULL to indicate that no candidate covering index will
4723 ** be available.
danbfca6a42012-08-24 10:52:35 +00004724 */
4725 pLvl = &pSubWInfo->a[0];
4726 if( (pLvl->plan.wsFlags & WHERE_INDEXED)!=0
4727 && (pLvl->plan.wsFlags & WHERE_TEMP_INDEX)==0
dan0efb72c2012-08-24 18:44:56 +00004728 && (ii==0 || pLvl->plan.u.pIdx==pCov)
danbfca6a42012-08-24 10:52:35 +00004729 ){
dan0efb72c2012-08-24 18:44:56 +00004730 assert( pLvl->iIdxCur==iCovCur );
danbfca6a42012-08-24 10:52:35 +00004731 pCov = pLvl->plan.u.pIdx;
danbfca6a42012-08-24 10:52:35 +00004732 }else{
4733 pCov = 0;
4734 }
4735
danielk19771d461462009-04-21 09:02:45 +00004736 /* Finish the loop through table entries that match term pOrTerm. */
4737 sqlite3WhereEnd(pSubWInfo);
4738 }
drhdd5f5a62008-12-23 13:35:23 +00004739 }
4740 }
drhd40e2082012-08-24 23:24:15 +00004741 pLevel->u.pCovidx = pCov;
drh90abfd02012-10-09 21:07:23 +00004742 if( pCov ) pLevel->iIdxCur = iCovCur;
drh331b67c2012-03-09 22:02:08 +00004743 if( pAndExpr ){
4744 pAndExpr->pLeft = 0;
4745 sqlite3ExprDelete(pParse->db, pAndExpr);
4746 }
danielk19771d461462009-04-21 09:02:45 +00004747 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
danielk19771d461462009-04-21 09:02:45 +00004748 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrBrk);
4749 sqlite3VdbeResolveLabel(v, iLoopBody);
4750
drhc01a3c12009-12-16 22:10:49 +00004751 if( pWInfo->nLevel>1 ) sqlite3StackFree(pParse->db, pOrTab);
4752 if( !untestedTerms ) disableTerm(pLevel, pTerm);
drhdd5f5a62008-12-23 13:35:23 +00004753 }else
drh23d04d52008-12-23 23:56:22 +00004754#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00004755
4756 {
drh111a6a72008-12-21 03:51:16 +00004757 /* Case 5: There is no usable index. We must do a complete
4758 ** scan of the entire table.
4759 */
drh699b3d42009-02-23 16:52:07 +00004760 static const u8 aStep[] = { OP_Next, OP_Prev };
4761 static const u8 aStart[] = { OP_Rewind, OP_Last };
4762 assert( bRev==0 || bRev==1 );
drh111a6a72008-12-21 03:51:16 +00004763 assert( omitTable==0 );
drh699b3d42009-02-23 16:52:07 +00004764 pLevel->op = aStep[bRev];
drh111a6a72008-12-21 03:51:16 +00004765 pLevel->p1 = iCur;
drh699b3d42009-02-23 16:52:07 +00004766 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrBrk);
drh111a6a72008-12-21 03:51:16 +00004767 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4768 }
4769 notReady &= ~getMask(pWC->pMaskSet, iCur);
4770
4771 /* Insert code to test every subexpression that can be completely
4772 ** computed using the current set of tables.
drhe9cdcea2010-07-22 22:40:03 +00004773 **
4774 ** IMPLEMENTATION-OF: R-49525-50935 Terms that cannot be satisfied through
4775 ** the use of indices become tests that are evaluated against each row of
4776 ** the relevant input tables.
drh111a6a72008-12-21 03:51:16 +00004777 */
drh111a6a72008-12-21 03:51:16 +00004778 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
4779 Expr *pE;
drhe9cdcea2010-07-22 22:40:03 +00004780 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* IMP: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004781 testcase( pTerm->wtFlags & TERM_CODED );
4782 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhc01a3c12009-12-16 22:10:49 +00004783 if( (pTerm->prereqAll & notReady)!=0 ){
4784 testcase( pWInfo->untestedTerms==0
4785 && (pWInfo->wctrlFlags & WHERE_ONETABLE_ONLY)!=0 );
4786 pWInfo->untestedTerms = 1;
4787 continue;
4788 }
drh111a6a72008-12-21 03:51:16 +00004789 pE = pTerm->pExpr;
4790 assert( pE!=0 );
4791 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
4792 continue;
4793 }
drh111a6a72008-12-21 03:51:16 +00004794 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00004795 pTerm->wtFlags |= TERM_CODED;
4796 }
4797
4798 /* For a LEFT OUTER JOIN, generate code that will record the fact that
4799 ** at least one row of the right table has matched the left table.
4800 */
4801 if( pLevel->iLeftJoin ){
4802 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
4803 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
4804 VdbeComment((v, "record LEFT JOIN hit"));
drhceea3322009-04-23 13:22:42 +00004805 sqlite3ExprCacheClear(pParse);
drh111a6a72008-12-21 03:51:16 +00004806 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
drhe9cdcea2010-07-22 22:40:03 +00004807 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* IMP: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004808 testcase( pTerm->wtFlags & TERM_CODED );
4809 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhc01a3c12009-12-16 22:10:49 +00004810 if( (pTerm->prereqAll & notReady)!=0 ){
drhb057e562009-12-16 23:43:55 +00004811 assert( pWInfo->untestedTerms );
drhc01a3c12009-12-16 22:10:49 +00004812 continue;
4813 }
drh111a6a72008-12-21 03:51:16 +00004814 assert( pTerm->pExpr );
4815 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
4816 pTerm->wtFlags |= TERM_CODED;
4817 }
4818 }
danielk19771d461462009-04-21 09:02:45 +00004819 sqlite3ReleaseTempReg(pParse, iReleaseReg);
drh23d04d52008-12-23 23:56:22 +00004820
drh111a6a72008-12-21 03:51:16 +00004821 return notReady;
4822}
4823
drh549c8b62005-09-19 13:15:23 +00004824#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00004825/*
4826** The following variable holds a text description of query plan generated
4827** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
4828** overwrites the previous. This information is used for testing and
4829** analysis only.
4830*/
4831char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
4832static int nQPlan = 0; /* Next free slow in _query_plan[] */
4833
4834#endif /* SQLITE_TEST */
4835
4836
drh9eff6162006-06-12 21:59:13 +00004837/*
4838** Free a WhereInfo structure
4839*/
drh10fe8402008-10-11 16:47:35 +00004840static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh52ff8ea2010-04-08 14:15:56 +00004841 if( ALWAYS(pWInfo) ){
drh9eff6162006-06-12 21:59:13 +00004842 int i;
4843 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00004844 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
4845 if( pInfo ){
danielk19771d461462009-04-21 09:02:45 +00004846 /* assert( pInfo->needToFreeIdxStr==0 || db->mallocFailed ); */
danielk197780442942008-12-24 11:25:39 +00004847 if( pInfo->needToFreeIdxStr ){
4848 sqlite3_free(pInfo->idxStr);
danielk1977be229652009-03-20 14:18:51 +00004849 }
drh633e6d52008-07-28 19:34:53 +00004850 sqlite3DbFree(db, pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00004851 }
drh8b307fb2010-04-06 15:57:05 +00004852 if( pWInfo->a[i].plan.wsFlags & WHERE_TEMP_INDEX ){
drha21a64d2010-04-06 22:33:55 +00004853 Index *pIdx = pWInfo->a[i].plan.u.pIdx;
4854 if( pIdx ){
4855 sqlite3DbFree(db, pIdx->zColAff);
4856 sqlite3DbFree(db, pIdx);
4857 }
drh8b307fb2010-04-06 15:57:05 +00004858 }
drh9eff6162006-06-12 21:59:13 +00004859 }
drh111a6a72008-12-21 03:51:16 +00004860 whereClauseClear(pWInfo->pWC);
drh633e6d52008-07-28 19:34:53 +00004861 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00004862 }
4863}
4864
drh94a11212004-09-25 13:12:14 +00004865
4866/*
drhe3184742002-06-19 14:27:05 +00004867** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00004868** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00004869** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00004870** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00004871** in order to complete the WHERE clause processing.
4872**
4873** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00004874**
4875** The basic idea is to do a nested loop, one loop for each table in
4876** the FROM clause of a select. (INSERT and UPDATE statements are the
4877** same as a SELECT with only a single table in the FROM clause.) For
4878** example, if the SQL is this:
4879**
4880** SELECT * FROM t1, t2, t3 WHERE ...;
4881**
4882** Then the code generated is conceptually like the following:
4883**
4884** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00004885** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00004886** foreach row3 in t3 do /
4887** ...
4888** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00004889** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00004890** end /
4891**
drh29dda4a2005-07-21 18:23:20 +00004892** Note that the loops might not be nested in the order in which they
4893** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00004894** use of indices. Note also that when the IN operator appears in
4895** the WHERE clause, it might result in additional nested loops for
4896** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00004897**
drhc27a1ce2002-06-14 20:58:45 +00004898** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00004899** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
4900** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00004901** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00004902**
drhe6f85e72004-12-25 01:03:13 +00004903** The code that sqlite3WhereBegin() generates leaves the cursors named
4904** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00004905** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00004906** data from the various tables of the loop.
4907**
drhc27a1ce2002-06-14 20:58:45 +00004908** If the WHERE clause is empty, the foreach loops must each scan their
4909** entire tables. Thus a three-way join is an O(N^3) operation. But if
4910** the tables have indices and there are terms in the WHERE clause that
4911** refer to those indices, a complete table scan can be avoided and the
4912** code will run much faster. Most of the work of this routine is checking
4913** to see if there are indices that can be used to speed up the loop.
4914**
4915** Terms of the WHERE clause are also used to limit which rows actually
4916** make it to the "..." in the middle of the loop. After each "foreach",
4917** terms of the WHERE clause that use only terms in that loop and outer
4918** loops are evaluated and if false a jump is made around all subsequent
4919** inner loops (or around the "..." if the test occurs within the inner-
4920** most loop)
4921**
4922** OUTER JOINS
4923**
4924** An outer join of tables t1 and t2 is conceptally coded as follows:
4925**
4926** foreach row1 in t1 do
4927** flag = 0
4928** foreach row2 in t2 do
4929** start:
4930** ...
4931** flag = 1
4932** end
drhe3184742002-06-19 14:27:05 +00004933** if flag==0 then
4934** move the row2 cursor to a null row
4935** goto start
4936** fi
drhc27a1ce2002-06-14 20:58:45 +00004937** end
4938**
drhe3184742002-06-19 14:27:05 +00004939** ORDER BY CLAUSE PROCESSING
4940**
drh46ec5b62012-09-24 15:30:54 +00004941** pOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
drhe3184742002-06-19 14:27:05 +00004942** if there is one. If there is no ORDER BY clause or if this routine
drh46ec5b62012-09-24 15:30:54 +00004943** is called from an UPDATE or DELETE statement, then pOrderBy is NULL.
drhe3184742002-06-19 14:27:05 +00004944**
4945** If an index can be used so that the natural output order of the table
4946** scan is correct for the ORDER BY clause, then that index is used and
drh46ec5b62012-09-24 15:30:54 +00004947** the returned WhereInfo.nOBSat field is set to pOrderBy->nExpr. This
4948** is an optimization that prevents an unnecessary sort of the result set
4949** if an index appropriate for the ORDER BY clause already exists.
drhe3184742002-06-19 14:27:05 +00004950**
4951** If the where clause loops cannot be arranged to provide the correct
drh46ec5b62012-09-24 15:30:54 +00004952** output order, then WhereInfo.nOBSat is 0.
drh75897232000-05-29 14:26:00 +00004953*/
danielk19774adee202004-05-08 08:23:19 +00004954WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00004955 Parse *pParse, /* The parser context */
4956 SrcList *pTabList, /* A list of all tables to be scanned */
4957 Expr *pWhere, /* The WHERE clause */
drh46ec5b62012-09-24 15:30:54 +00004958 ExprList *pOrderBy, /* An ORDER BY clause, or NULL */
dan38cc40c2011-06-30 20:17:15 +00004959 ExprList *pDistinct, /* The select-list for DISTINCT queries - or NULL */
dan0efb72c2012-08-24 18:44:56 +00004960 u16 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
4961 int iIdxCur /* If WHERE_ONETABLE_ONLY is set, index cursor number */
drh75897232000-05-29 14:26:00 +00004962){
danielk1977be229652009-03-20 14:18:51 +00004963 int nByteWInfo; /* Num. bytes allocated for WhereInfo struct */
drhc01a3c12009-12-16 22:10:49 +00004964 int nTabList; /* Number of elements in pTabList */
drh75897232000-05-29 14:26:00 +00004965 WhereInfo *pWInfo; /* Will become the return value of this function */
4966 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhfe05af82005-07-21 03:14:59 +00004967 Bitmask notReady; /* Cursors that are not yet positioned */
drh56f1b992012-09-25 14:29:39 +00004968 WhereBestIdx sWBI; /* Best index search context */
drh111a6a72008-12-21 03:51:16 +00004969 WhereMaskSet *pMaskSet; /* The expression mask set */
drh56f1b992012-09-25 14:29:39 +00004970 WhereLevel *pLevel; /* A single level in pWInfo->a[] */
4971 int iFrom; /* First unused FROM clause element */
drh111a6a72008-12-21 03:51:16 +00004972 int andFlags; /* AND-ed combination of all pWC->a[].wtFlags */
drh9cd1c992012-09-25 20:43:35 +00004973 int ii; /* Loop counter */
drh17435752007-08-16 04:30:38 +00004974 sqlite3 *db; /* Database connection */
drh75897232000-05-29 14:26:00 +00004975
drh56f1b992012-09-25 14:29:39 +00004976
4977 /* Variable initialization */
4978 memset(&sWBI, 0, sizeof(sWBI));
4979 sWBI.pParse = pParse;
4980
drh29dda4a2005-07-21 18:23:20 +00004981 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00004982 ** bits in a Bitmask
4983 */
drh67ae0cb2010-04-08 14:38:51 +00004984 testcase( pTabList->nSrc==BMS );
drh29dda4a2005-07-21 18:23:20 +00004985 if( pTabList->nSrc>BMS ){
4986 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00004987 return 0;
4988 }
4989
drhc01a3c12009-12-16 22:10:49 +00004990 /* This function normally generates a nested loop for all tables in
4991 ** pTabList. But if the WHERE_ONETABLE_ONLY flag is set, then we should
4992 ** only generate code for the first table in pTabList and assume that
4993 ** any cursors associated with subsequent tables are uninitialized.
4994 */
4995 nTabList = (wctrlFlags & WHERE_ONETABLE_ONLY) ? 1 : pTabList->nSrc;
4996
drh75897232000-05-29 14:26:00 +00004997 /* Allocate and initialize the WhereInfo structure that will become the
danielk1977be229652009-03-20 14:18:51 +00004998 ** return value. A single allocation is used to store the WhereInfo
4999 ** struct, the contents of WhereInfo.a[], the WhereClause structure
5000 ** and the WhereMaskSet structure. Since WhereClause contains an 8-byte
5001 ** field (type Bitmask) it must be aligned on an 8-byte boundary on
5002 ** some architectures. Hence the ROUND8() below.
drh75897232000-05-29 14:26:00 +00005003 */
drh17435752007-08-16 04:30:38 +00005004 db = pParse->db;
drhc01a3c12009-12-16 22:10:49 +00005005 nByteWInfo = ROUND8(sizeof(WhereInfo)+(nTabList-1)*sizeof(WhereLevel));
danielk1977be229652009-03-20 14:18:51 +00005006 pWInfo = sqlite3DbMallocZero(db,
5007 nByteWInfo +
5008 sizeof(WhereClause) +
5009 sizeof(WhereMaskSet)
5010 );
drh17435752007-08-16 04:30:38 +00005011 if( db->mallocFailed ){
drh8b307fb2010-04-06 15:57:05 +00005012 sqlite3DbFree(db, pWInfo);
5013 pWInfo = 0;
danielk197785574e32008-10-06 05:32:18 +00005014 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00005015 }
drhc01a3c12009-12-16 22:10:49 +00005016 pWInfo->nLevel = nTabList;
drh75897232000-05-29 14:26:00 +00005017 pWInfo->pParse = pParse;
5018 pWInfo->pTabList = pTabList;
danielk19774adee202004-05-08 08:23:19 +00005019 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh56f1b992012-09-25 14:29:39 +00005020 pWInfo->pWC = sWBI.pWC = (WhereClause *)&((u8 *)pWInfo)[nByteWInfo];
drh6df2acd2008-12-28 16:55:25 +00005021 pWInfo->wctrlFlags = wctrlFlags;
drh8b307fb2010-04-06 15:57:05 +00005022 pWInfo->savedNQueryLoop = pParse->nQueryLoop;
drh56f1b992012-09-25 14:29:39 +00005023 pMaskSet = (WhereMaskSet*)&sWBI.pWC[1];
drh46c35f92012-09-26 23:17:01 +00005024 sWBI.aLevel = pWInfo->a;
drh08192d52002-04-30 19:20:28 +00005025
drha9b1b912011-07-08 13:07:02 +00005026 /* Disable the DISTINCT optimization if SQLITE_DistinctOpt is set via
5027 ** sqlite3_test_ctrl(SQLITE_TESTCTRL_OPTIMIZATIONS,...) */
drh7e5418e2012-09-27 15:05:54 +00005028 if( OptimizationDisabled(db, SQLITE_DistinctOpt) ) pDistinct = 0;
drha9b1b912011-07-08 13:07:02 +00005029
drh111a6a72008-12-21 03:51:16 +00005030 /* Split the WHERE clause into separate subexpressions where each
5031 ** subexpression is separated by an AND operator.
5032 */
5033 initMaskSet(pMaskSet);
drh56f1b992012-09-25 14:29:39 +00005034 whereClauseInit(sWBI.pWC, pParse, pMaskSet, wctrlFlags);
drh111a6a72008-12-21 03:51:16 +00005035 sqlite3ExprCodeConstants(pParse, pWhere);
drh56f1b992012-09-25 14:29:39 +00005036 whereSplit(sWBI.pWC, pWhere, TK_AND); /* IMP: R-15842-53296 */
drh111a6a72008-12-21 03:51:16 +00005037
drh08192d52002-04-30 19:20:28 +00005038 /* Special case: a WHERE clause that is constant. Evaluate the
5039 ** expression and either jump over all of the code or fall thru.
5040 */
drhc01a3c12009-12-16 22:10:49 +00005041 if( pWhere && (nTabList==0 || sqlite3ExprIsConstantNotJoin(pWhere)) ){
drh35573352008-01-08 23:54:25 +00005042 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, SQLITE_JUMPIFNULL);
drhdf199a22002-06-14 22:38:41 +00005043 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00005044 }
drh75897232000-05-29 14:26:00 +00005045
drh42165be2008-03-26 14:56:34 +00005046 /* Assign a bit from the bitmask to every term in the FROM clause.
5047 **
5048 ** When assigning bitmask values to FROM clause cursors, it must be
5049 ** the case that if X is the bitmask for the N-th FROM clause term then
5050 ** the bitmask for all FROM clause terms to the left of the N-th term
5051 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
5052 ** its Expr.iRightJoinTable value to find the bitmask of the right table
5053 ** of the join. Subtracting one from the right table bitmask gives a
5054 ** bitmask for all tables to the left of the join. Knowing the bitmask
5055 ** for all tables to the left of a left join is important. Ticket #3015.
danielk1977e672c8e2009-05-22 15:43:26 +00005056 **
drhc01a3c12009-12-16 22:10:49 +00005057 ** Note that bitmasks are created for all pTabList->nSrc tables in
5058 ** pTabList, not just the first nTabList tables. nTabList is normally
5059 ** equal to pTabList->nSrc but might be shortened to 1 if the
5060 ** WHERE_ONETABLE_ONLY flag is set.
drh42165be2008-03-26 14:56:34 +00005061 */
drh9cd1c992012-09-25 20:43:35 +00005062 for(ii=0; ii<pTabList->nSrc; ii++){
5063 createMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00005064 }
5065#ifndef NDEBUG
5066 {
5067 Bitmask toTheLeft = 0;
drh9cd1c992012-09-25 20:43:35 +00005068 for(ii=0; ii<pTabList->nSrc; ii++){
5069 Bitmask m = getMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00005070 assert( (m-1)==toTheLeft );
5071 toTheLeft |= m;
5072 }
5073 }
5074#endif
5075
drh29dda4a2005-07-21 18:23:20 +00005076 /* Analyze all of the subexpressions. Note that exprAnalyze() might
5077 ** add new virtual terms onto the end of the WHERE clause. We do not
5078 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00005079 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00005080 */
drh56f1b992012-09-25 14:29:39 +00005081 exprAnalyzeAll(pTabList, sWBI.pWC);
drh17435752007-08-16 04:30:38 +00005082 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00005083 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00005084 }
drh75897232000-05-29 14:26:00 +00005085
dan38cc40c2011-06-30 20:17:15 +00005086 /* Check if the DISTINCT qualifier, if there is one, is redundant.
5087 ** If it is, then set pDistinct to NULL and WhereInfo.eDistinct to
5088 ** WHERE_DISTINCT_UNIQUE to tell the caller to ignore the DISTINCT.
5089 */
drh56f1b992012-09-25 14:29:39 +00005090 if( pDistinct && isDistinctRedundant(pParse, pTabList, sWBI.pWC, pDistinct) ){
dan38cc40c2011-06-30 20:17:15 +00005091 pDistinct = 0;
5092 pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
5093 }
5094
drh29dda4a2005-07-21 18:23:20 +00005095 /* Chose the best index to use for each table in the FROM clause.
5096 **
drh51147ba2005-07-23 22:59:55 +00005097 ** This loop fills in the following fields:
5098 **
5099 ** pWInfo->a[].pIdx The index to use for this level of the loop.
drh165be382008-12-05 02:36:33 +00005100 ** pWInfo->a[].wsFlags WHERE_xxx flags associated with pIdx
drh51147ba2005-07-23 22:59:55 +00005101 ** pWInfo->a[].nEq The number of == and IN constraints
danielk197785574e32008-10-06 05:32:18 +00005102 ** pWInfo->a[].iFrom Which term of the FROM clause is being coded
drh51147ba2005-07-23 22:59:55 +00005103 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
5104 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
drh111a6a72008-12-21 03:51:16 +00005105 ** pWInfo->a[].pTerm When wsFlags==WO_OR, the OR-clause term
drh51147ba2005-07-23 22:59:55 +00005106 **
5107 ** This loop also figures out the nesting order of tables in the FROM
5108 ** clause.
drh75897232000-05-29 14:26:00 +00005109 */
drh9cd1c992012-09-25 20:43:35 +00005110 sWBI.notValid = ~(Bitmask)0;
5111 sWBI.pOrderBy = pOrderBy;
5112 sWBI.n = nTabList;
5113 sWBI.pDistinct = pDistinct;
drh943af3c2005-07-29 19:43:58 +00005114 andFlags = ~0;
drh4f0c5872007-03-26 22:05:01 +00005115 WHERETRACE(("*** Optimizer Start ***\n"));
drh9cd1c992012-09-25 20:43:35 +00005116 for(sWBI.i=iFrom=0, pLevel=pWInfo->a; sWBI.i<nTabList; sWBI.i++, pLevel++){
drh111a6a72008-12-21 03:51:16 +00005117 WhereCost bestPlan; /* Most efficient plan seen so far */
drh29dda4a2005-07-21 18:23:20 +00005118 Index *pIdx; /* Index for FROM table at pTabItem */
drh29dda4a2005-07-21 18:23:20 +00005119 int j; /* For looping over FROM tables */
dan5236ac12009-08-13 07:09:33 +00005120 int bestJ = -1; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00005121 Bitmask m; /* Bitmask value for j or bestJ */
dan5236ac12009-08-13 07:09:33 +00005122 int isOptimal; /* Iterator for optimal/non-optimal search */
drh3bd5ab82013-01-16 00:46:09 +00005123 int ckOptimal; /* Do the optimal scan check */
drh5e377d92010-08-04 21:17:16 +00005124 int nUnconstrained; /* Number tables without INDEXED BY */
drhaa0ba432010-08-05 02:52:32 +00005125 Bitmask notIndexed; /* Mask of tables that cannot use an index */
drh29dda4a2005-07-21 18:23:20 +00005126
drh111a6a72008-12-21 03:51:16 +00005127 memset(&bestPlan, 0, sizeof(bestPlan));
5128 bestPlan.rCost = SQLITE_BIG_DBL;
drh9cd1c992012-09-25 20:43:35 +00005129 WHERETRACE(("*** Begin search for loop %d ***\n", sWBI.i));
drhdf26fd52006-06-06 11:45:54 +00005130
dan5236ac12009-08-13 07:09:33 +00005131 /* Loop through the remaining entries in the FROM clause to find the
drhed754ce2010-04-15 01:04:54 +00005132 ** next nested loop. The loop tests all FROM clause entries
dan5236ac12009-08-13 07:09:33 +00005133 ** either once or twice.
5134 **
drhed754ce2010-04-15 01:04:54 +00005135 ** The first test is always performed if there are two or more entries
5136 ** remaining and never performed if there is only one FROM clause entry
5137 ** to choose from. The first test looks for an "optimal" scan. In
dan5236ac12009-08-13 07:09:33 +00005138 ** this context an optimal scan is one that uses the same strategy
5139 ** for the given FROM clause entry as would be selected if the entry
drhd0015162009-08-21 13:22:25 +00005140 ** were used as the innermost nested loop. In other words, a table
5141 ** is chosen such that the cost of running that table cannot be reduced
drhed754ce2010-04-15 01:04:54 +00005142 ** by waiting for other tables to run first. This "optimal" test works
5143 ** by first assuming that the FROM clause is on the inner loop and finding
5144 ** its query plan, then checking to see if that query plan uses any
drh9cd1c992012-09-25 20:43:35 +00005145 ** other FROM clause terms that are sWBI.notValid. If no notValid terms
5146 ** are used then the "optimal" query plan works.
dan5236ac12009-08-13 07:09:33 +00005147 **
drh547caad2010-10-04 23:55:50 +00005148 ** Note that the WhereCost.nRow parameter for an optimal scan might
5149 ** not be as small as it would be if the table really were the innermost
5150 ** join. The nRow value can be reduced by WHERE clause constraints
5151 ** that do not use indices. But this nRow reduction only happens if the
5152 ** table really is the innermost join.
5153 **
drhed754ce2010-04-15 01:04:54 +00005154 ** The second loop iteration is only performed if no optimal scan
drh547caad2010-10-04 23:55:50 +00005155 ** strategies were found by the first iteration. This second iteration
5156 ** is used to search for the lowest cost scan overall.
dan5236ac12009-08-13 07:09:33 +00005157 **
drh5d5cf012013-01-15 16:15:28 +00005158 ** Without the optimal scan step (the first iteration) a suboptimal
5159 ** plan might be chosen for queries like this:
dan5236ac12009-08-13 07:09:33 +00005160 **
5161 ** CREATE TABLE t1(a, b);
5162 ** CREATE TABLE t2(c, d);
5163 ** SELECT * FROM t2, t1 WHERE t2.rowid = t1.a;
5164 **
5165 ** The best strategy is to iterate through table t1 first. However it
5166 ** is not possible to determine this with a simple greedy algorithm.
drh15564052010-09-25 22:32:56 +00005167 ** Since the cost of a linear scan through table t2 is the same
dan5236ac12009-08-13 07:09:33 +00005168 ** as the cost of a linear scan through table t1, a simple greedy
5169 ** algorithm may choose to use t2 for the outer loop, which is a much
5170 ** costlier approach.
5171 */
drh5e377d92010-08-04 21:17:16 +00005172 nUnconstrained = 0;
drhaa0ba432010-08-05 02:52:32 +00005173 notIndexed = 0;
drh3bd5ab82013-01-16 00:46:09 +00005174
5175 /* The optimal scan check only occurs if there are two or more tables
5176 ** available to be reordered */
5177 if( iFrom==nTabList-1 ){
5178 ckOptimal = 0; /* Common case of just one table in the FROM clause */
5179 }else{
5180 ckOptimal = -1;
drh56f1b992012-09-25 14:29:39 +00005181 for(j=iFrom, sWBI.pSrc=&pTabList->a[j]; j<nTabList; j++, sWBI.pSrc++){
drh56f1b992012-09-25 14:29:39 +00005182 m = getMask(pMaskSet, sWBI.pSrc->iCursor);
drh9cd1c992012-09-25 20:43:35 +00005183 if( (m & sWBI.notValid)==0 ){
dan5236ac12009-08-13 07:09:33 +00005184 if( j==iFrom ) iFrom++;
5185 continue;
5186 }
drh3bd5ab82013-01-16 00:46:09 +00005187 if( j>iFrom && (sWBI.pSrc->jointype & (JT_LEFT|JT_CROSS))!=0 ) break;
5188 if( ++ckOptimal ) break;
5189 if( (sWBI.pSrc->jointype & JT_LEFT)!=0 ) break;
5190 }
5191 }
5192 assert( ckOptimal==0 || ckOptimal==1 );
5193
5194 for(isOptimal=ckOptimal; isOptimal>=0 && bestJ<0; isOptimal--){
5195 for(j=iFrom, sWBI.pSrc=&pTabList->a[j]; j<nTabList; j++, sWBI.pSrc++){
5196 if( j>iFrom && (sWBI.pSrc->jointype & (JT_LEFT|JT_CROSS))!=0 ){
5197 /* This break and one like it in the ckOptimal computation loop
5198 ** above prevent table reordering across LEFT and CROSS JOINs.
5199 ** The LEFT JOIN case is necessary for correctness. The prohibition
5200 ** against reordering across a CROSS JOIN is an SQLite feature that
5201 ** allows the developer to control table reordering */
5202 break;
5203 }
5204 m = getMask(pMaskSet, sWBI.pSrc->iCursor);
5205 if( (m & sWBI.notValid)==0 ){
5206 assert( j>iFrom );
5207 continue;
5208 }
drh9cd1c992012-09-25 20:43:35 +00005209 sWBI.notReady = (isOptimal ? m : sWBI.notValid);
drh56f1b992012-09-25 14:29:39 +00005210 if( sWBI.pSrc->pIndex==0 ) nUnconstrained++;
dan5236ac12009-08-13 07:09:33 +00005211
drh8e4af1b2012-10-08 18:23:51 +00005212 WHERETRACE((" === trying table %d (%s) with isOptimal=%d ===\n",
drh1afcaae2012-10-02 01:10:00 +00005213 j, sWBI.pSrc->pTab->zName, isOptimal));
drh56f1b992012-09-25 14:29:39 +00005214 assert( sWBI.pSrc->pTab );
drh9eff6162006-06-12 21:59:13 +00005215#ifndef SQLITE_OMIT_VIRTUALTABLE
drh56f1b992012-09-25 14:29:39 +00005216 if( IsVirtual(sWBI.pSrc->pTab) ){
5217 sWBI.ppIdxInfo = &pWInfo->a[j].pIdxInfo;
5218 bestVirtualIndex(&sWBI);
dan5236ac12009-08-13 07:09:33 +00005219 }else
drh9eff6162006-06-12 21:59:13 +00005220#endif
dan5236ac12009-08-13 07:09:33 +00005221 {
drh56f1b992012-09-25 14:29:39 +00005222 bestBtreeIndex(&sWBI);
dan5236ac12009-08-13 07:09:33 +00005223 }
drh9cd1c992012-09-25 20:43:35 +00005224 assert( isOptimal || (sWBI.cost.used&sWBI.notValid)==0 );
dan5236ac12009-08-13 07:09:33 +00005225
drhaa0ba432010-08-05 02:52:32 +00005226 /* If an INDEXED BY clause is present, then the plan must use that
5227 ** index if it uses any index at all */
drh56f1b992012-09-25 14:29:39 +00005228 assert( sWBI.pSrc->pIndex==0
5229 || (sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)==0
5230 || sWBI.cost.plan.u.pIdx==sWBI.pSrc->pIndex );
drhaa0ba432010-08-05 02:52:32 +00005231
drh56f1b992012-09-25 14:29:39 +00005232 if( isOptimal && (sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)==0 ){
drhaa0ba432010-08-05 02:52:32 +00005233 notIndexed |= m;
5234 }
drh782d68a2012-11-09 17:59:26 +00005235 if( isOptimal ){
5236 pWInfo->a[j].rOptCost = sWBI.cost.rCost;
drh3bd5ab82013-01-16 00:46:09 +00005237 }else if( ckOptimal ){
drhea84a652013-01-15 18:49:07 +00005238 /* If two or more tables have nearly the same outer loop cost, but
drh782d68a2012-11-09 17:59:26 +00005239 ** very different inner loop (optimal) cost, we want to choose
5240 ** for the outer loop that table which benefits the least from
5241 ** being in the inner loop. The following code scales the
5242 ** outer loop cost estimate to accomplish that. */
5243 WHERETRACE((" scaling cost from %.1f to %.1f\n",
5244 sWBI.cost.rCost,
5245 sWBI.cost.rCost/pWInfo->a[j].rOptCost));
5246 sWBI.cost.rCost /= pWInfo->a[j].rOptCost;
5247 }
drhaa0ba432010-08-05 02:52:32 +00005248
drh5e377d92010-08-04 21:17:16 +00005249 /* Conditions under which this table becomes the best so far:
5250 **
5251 ** (1) The table must not depend on other tables that have not
drh9cd1c992012-09-25 20:43:35 +00005252 ** yet run. (In other words, it must not depend on tables
5253 ** in inner loops.)
drh5e377d92010-08-04 21:17:16 +00005254 **
drhada796b2012-11-09 18:22:26 +00005255 ** (2) (This rule was removed on 2012-11-09. The scaling of the
5256 ** cost using the optimal scan cost made this rule obsolete.)
drh5e377d92010-08-04 21:17:16 +00005257 **
drhaa0ba432010-08-05 02:52:32 +00005258 ** (3) All tables have an INDEXED BY clause or this table lacks an
drh5e377d92010-08-04 21:17:16 +00005259 ** INDEXED BY clause or this table uses the specific
drhaa0ba432010-08-05 02:52:32 +00005260 ** index specified by its INDEXED BY clause. This rule ensures
5261 ** that a best-so-far is always selected even if an impossible
5262 ** combination of INDEXED BY clauses are given. The error
5263 ** will be detected and relayed back to the application later.
5264 ** The NEVER() comes about because rule (2) above prevents
5265 ** An indexable full-table-scan from reaching rule (3).
5266 **
drhd663b5b2012-10-03 00:25:54 +00005267 ** (4) The plan cost must be lower than prior plans, where "cost"
5268 ** is defined by the compareCost() function above.
drh5e377d92010-08-04 21:17:16 +00005269 */
drh9cd1c992012-09-25 20:43:35 +00005270 if( (sWBI.cost.used&sWBI.notValid)==0 /* (1) */
drh56f1b992012-09-25 14:29:39 +00005271 && (nUnconstrained==0 || sWBI.pSrc->pIndex==0 /* (3) */
5272 || NEVER((sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)!=0))
drhd663b5b2012-10-03 00:25:54 +00005273 && (bestJ<0 || compareCost(&sWBI.cost, &bestPlan)) /* (4) */
dan5236ac12009-08-13 07:09:33 +00005274 ){
drh8e4af1b2012-10-08 18:23:51 +00005275 WHERETRACE((" === table %d (%s) is best so far\n"
5276 " cost=%.1f, nRow=%.1f, nOBSat=%d, wsFlags=%08x\n",
drh1afcaae2012-10-02 01:10:00 +00005277 j, sWBI.pSrc->pTab->zName,
5278 sWBI.cost.rCost, sWBI.cost.plan.nRow,
drhd663b5b2012-10-03 00:25:54 +00005279 sWBI.cost.plan.nOBSat, sWBI.cost.plan.wsFlags));
drh56f1b992012-09-25 14:29:39 +00005280 bestPlan = sWBI.cost;
dan5236ac12009-08-13 07:09:33 +00005281 bestJ = j;
5282 }
drh3bd5ab82013-01-16 00:46:09 +00005283
5284 /* In a join like "w JOIN x LEFT JOIN y JOIN z" make sure that
5285 ** table y (and not table z) is always the next inner loop inside
5286 ** of table x. */
5287 if( (sWBI.pSrc->jointype & JT_LEFT)!=0 ) break;
drh9eff6162006-06-12 21:59:13 +00005288 }
drh29dda4a2005-07-21 18:23:20 +00005289 }
dan5236ac12009-08-13 07:09:33 +00005290 assert( bestJ>=0 );
drh9cd1c992012-09-25 20:43:35 +00005291 assert( sWBI.notValid & getMask(pMaskSet, pTabList->a[bestJ].iCursor) );
drh3bd5ab82013-01-16 00:46:09 +00005292 assert( bestJ==iFrom || (pTabList->a[iFrom].jointype & JT_LEFT)==0 );
5293 testcase( bestJ>iFrom && (pTabList->a[iFrom].jointype & JT_CROSS)!=0 );
5294 testcase( bestJ>iFrom && bestJ<nTabList-1
5295 && (pTabList->a[bestJ+1].jointype & JT_LEFT)!=0 );
drh1afcaae2012-10-02 01:10:00 +00005296 WHERETRACE(("*** Optimizer selects table %d (%s) for loop %d with:\n"
drhd663b5b2012-10-03 00:25:54 +00005297 " cost=%.1f, nRow=%.1f, nOBSat=%d, wsFlags=0x%08x\n",
drh1afcaae2012-10-02 01:10:00 +00005298 bestJ, pTabList->a[bestJ].pTab->zName,
5299 pLevel-pWInfo->a, bestPlan.rCost, bestPlan.plan.nRow,
drh5343b2d2012-09-27 19:53:38 +00005300 bestPlan.plan.nOBSat, bestPlan.plan.wsFlags));
dan38cc40c2011-06-30 20:17:15 +00005301 if( (bestPlan.plan.wsFlags & WHERE_DISTINCT)!=0 ){
5302 assert( pWInfo->eDistinct==0 );
5303 pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
5304 }
drh111a6a72008-12-21 03:51:16 +00005305 andFlags &= bestPlan.plan.wsFlags;
5306 pLevel->plan = bestPlan.plan;
drha578d042012-10-02 01:25:16 +00005307 pLevel->iTabCur = pTabList->a[bestJ].iCursor;
drh8b307fb2010-04-06 15:57:05 +00005308 testcase( bestPlan.plan.wsFlags & WHERE_INDEXED );
5309 testcase( bestPlan.plan.wsFlags & WHERE_TEMP_INDEX );
5310 if( bestPlan.plan.wsFlags & (WHERE_INDEXED|WHERE_TEMP_INDEX) ){
dan0efb72c2012-08-24 18:44:56 +00005311 if( (wctrlFlags & WHERE_ONETABLE_ONLY)
5312 && (bestPlan.plan.wsFlags & WHERE_TEMP_INDEX)==0
5313 ){
5314 pLevel->iIdxCur = iIdxCur;
5315 }else{
5316 pLevel->iIdxCur = pParse->nTab++;
5317 }
drhfe05af82005-07-21 03:14:59 +00005318 }else{
5319 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00005320 }
drh9cd1c992012-09-25 20:43:35 +00005321 sWBI.notValid &= ~getMask(pMaskSet, pTabList->a[bestJ].iCursor);
shaned87897d2009-01-30 05:40:27 +00005322 pLevel->iFrom = (u8)bestJ;
dan2ce22452010-11-08 19:01:16 +00005323 if( bestPlan.plan.nRow>=(double)1 ){
5324 pParse->nQueryLoop *= bestPlan.plan.nRow;
5325 }
danielk197785574e32008-10-06 05:32:18 +00005326
5327 /* Check that if the table scanned by this loop iteration had an
5328 ** INDEXED BY clause attached to it, that the named index is being
5329 ** used for the scan. If not, then query compilation has failed.
5330 ** Return an error.
5331 */
5332 pIdx = pTabList->a[bestJ].pIndex;
drh171256c2009-01-08 03:11:19 +00005333 if( pIdx ){
5334 if( (bestPlan.plan.wsFlags & WHERE_INDEXED)==0 ){
5335 sqlite3ErrorMsg(pParse, "cannot use index: %s", pIdx->zName);
5336 goto whereBeginError;
5337 }else{
5338 /* If an INDEXED BY clause is used, the bestIndex() function is
5339 ** guaranteed to find the index specified in the INDEXED BY clause
5340 ** if it find an index at all. */
5341 assert( bestPlan.plan.u.pIdx==pIdx );
5342 }
danielk197785574e32008-10-06 05:32:18 +00005343 }
drh75897232000-05-29 14:26:00 +00005344 }
drh4f0c5872007-03-26 22:05:01 +00005345 WHERETRACE(("*** Optimizer Finished ***\n"));
danielk19771d461462009-04-21 09:02:45 +00005346 if( pParse->nErr || db->mallocFailed ){
danielk197780442942008-12-24 11:25:39 +00005347 goto whereBeginError;
5348 }
drhd663b5b2012-10-03 00:25:54 +00005349 if( nTabList ){
5350 pLevel--;
5351 pWInfo->nOBSat = pLevel->plan.nOBSat;
5352 }else{
5353 pWInfo->nOBSat = 0;
5354 }
drh75897232000-05-29 14:26:00 +00005355
drh943af3c2005-07-29 19:43:58 +00005356 /* If the total query only selects a single row, then the ORDER BY
5357 ** clause is irrelevant.
5358 */
drh46ec5b62012-09-24 15:30:54 +00005359 if( (andFlags & WHERE_UNIQUE)!=0 && pOrderBy ){
drhd663b5b2012-10-03 00:25:54 +00005360 assert( nTabList==0 || (pLevel->plan.wsFlags & WHERE_ALL_UNIQUE)!=0 );
drh46ec5b62012-09-24 15:30:54 +00005361 pWInfo->nOBSat = pOrderBy->nExpr;
drh943af3c2005-07-29 19:43:58 +00005362 }
5363
drh08c88eb2008-04-10 13:33:18 +00005364 /* If the caller is an UPDATE or DELETE statement that is requesting
5365 ** to use a one-pass algorithm, determine if this is appropriate.
5366 ** The one-pass algorithm only works if the WHERE clause constraints
5367 ** the statement to update a single row.
5368 */
drh165be382008-12-05 02:36:33 +00005369 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
5370 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 && (andFlags & WHERE_UNIQUE)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00005371 pWInfo->okOnePass = 1;
drh111a6a72008-12-21 03:51:16 +00005372 pWInfo->a[0].plan.wsFlags &= ~WHERE_IDX_ONLY;
drh08c88eb2008-04-10 13:33:18 +00005373 }
5374
drh9012bcb2004-12-19 00:11:35 +00005375 /* Open all tables in the pTabList and any indices selected for
5376 ** searching those tables.
5377 */
5378 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh8b307fb2010-04-06 15:57:05 +00005379 notReady = ~(Bitmask)0;
drh95aa47b2010-11-16 02:49:15 +00005380 pWInfo->nRowOut = (double)1;
drh9cd1c992012-09-25 20:43:35 +00005381 for(ii=0, pLevel=pWInfo->a; ii<nTabList; ii++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00005382 Table *pTab; /* Table to open */
danielk1977da184232006-01-05 11:34:32 +00005383 int iDb; /* Index of database containing table/index */
drh56f1b992012-09-25 14:29:39 +00005384 struct SrcList_item *pTabItem;
drh9012bcb2004-12-19 00:11:35 +00005385
drh29dda4a2005-07-21 18:23:20 +00005386 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00005387 pTab = pTabItem->pTab;
drh95aa47b2010-11-16 02:49:15 +00005388 pWInfo->nRowOut *= pLevel->plan.nRow;
danielk1977595a5232009-07-24 17:58:53 +00005389 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh424aab82010-04-06 18:28:20 +00005390 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ){
drh75bb9f52010-04-06 18:51:42 +00005391 /* Do nothing */
5392 }else
drh9eff6162006-06-12 21:59:13 +00005393#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00005394 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
danielk1977595a5232009-07-24 17:58:53 +00005395 const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
danielk197793626f42006-06-20 13:07:27 +00005396 int iCur = pTabItem->iCursor;
danielk1977595a5232009-07-24 17:58:53 +00005397 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0, pVTab, P4_VTAB);
drhfc5e5462012-12-03 17:04:40 +00005398 }else if( IsVirtual(pTab) ){
5399 /* noop */
drh9eff6162006-06-12 21:59:13 +00005400 }else
5401#endif
drh6df2acd2008-12-28 16:55:25 +00005402 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
drh9ef61f42011-10-07 14:40:59 +00005403 && (wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0 ){
drh08c88eb2008-04-10 13:33:18 +00005404 int op = pWInfo->okOnePass ? OP_OpenWrite : OP_OpenRead;
5405 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
drh67ae0cb2010-04-08 14:38:51 +00005406 testcase( pTab->nCol==BMS-1 );
5407 testcase( pTab->nCol==BMS );
danielk197723432972008-11-17 16:42:00 +00005408 if( !pWInfo->okOnePass && pTab->nCol<BMS ){
danielk19779792eef2006-01-13 15:58:43 +00005409 Bitmask b = pTabItem->colUsed;
5410 int n = 0;
drh74161702006-02-24 02:53:49 +00005411 for(; b; b=b>>1, n++){}
drh8cff69d2009-11-12 19:59:44 +00005412 sqlite3VdbeChangeP4(v, sqlite3VdbeCurrentAddr(v)-1,
5413 SQLITE_INT_TO_PTR(n), P4_INT32);
danielk19779792eef2006-01-13 15:58:43 +00005414 assert( n<=pTab->nCol );
5415 }
danielk1977c00da102006-01-07 13:21:04 +00005416 }else{
5417 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00005418 }
drhc6339082010-04-07 16:54:58 +00005419#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00005420 if( (pLevel->plan.wsFlags & WHERE_TEMP_INDEX)!=0 ){
drh56f1b992012-09-25 14:29:39 +00005421 constructAutomaticIndex(pParse, sWBI.pWC, pTabItem, notReady, pLevel);
drhc6339082010-04-07 16:54:58 +00005422 }else
5423#endif
5424 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
drh111a6a72008-12-21 03:51:16 +00005425 Index *pIx = pLevel->plan.u.pIdx;
danielk1977b3bf5562006-01-10 17:58:23 +00005426 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
drhb0367fb2012-08-25 02:11:13 +00005427 int iIndexCur = pLevel->iIdxCur;
danielk1977da184232006-01-05 11:34:32 +00005428 assert( pIx->pSchema==pTab->pSchema );
drhb0367fb2012-08-25 02:11:13 +00005429 assert( iIndexCur>=0 );
5430 sqlite3VdbeAddOp4(v, OP_OpenRead, iIndexCur, pIx->tnum, iDb,
drh66a51672008-01-03 00:01:23 +00005431 (char*)pKey, P4_KEYINFO_HANDOFF);
danielk1977207872a2008-01-03 07:54:23 +00005432 VdbeComment((v, "%s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00005433 }
danielk1977da184232006-01-05 11:34:32 +00005434 sqlite3CodeVerifySchema(pParse, iDb);
drh56f1b992012-09-25 14:29:39 +00005435 notReady &= ~getMask(sWBI.pWC->pMaskSet, pTabItem->iCursor);
drh9012bcb2004-12-19 00:11:35 +00005436 }
5437 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
drha21a64d2010-04-06 22:33:55 +00005438 if( db->mallocFailed ) goto whereBeginError;
drh9012bcb2004-12-19 00:11:35 +00005439
drh29dda4a2005-07-21 18:23:20 +00005440 /* Generate the code to do the search. Each iteration of the for
5441 ** loop below generates code for a single nested loop of the VM
5442 ** program.
drh75897232000-05-29 14:26:00 +00005443 */
drhfe05af82005-07-21 03:14:59 +00005444 notReady = ~(Bitmask)0;
drh9cd1c992012-09-25 20:43:35 +00005445 for(ii=0; ii<nTabList; ii++){
5446 pLevel = &pWInfo->a[ii];
5447 explainOneScan(pParse, pTabList, pLevel, ii, pLevel->iFrom, wctrlFlags);
5448 notReady = codeOneLoopStart(pWInfo, ii, wctrlFlags, notReady);
dan4a07e3d2010-11-09 14:48:59 +00005449 pWInfo->iContinue = pLevel->addrCont;
drh75897232000-05-29 14:26:00 +00005450 }
drh7ec764a2005-07-21 03:48:20 +00005451
5452#ifdef SQLITE_TEST /* For testing and debugging use only */
5453 /* Record in the query plan information about the current table
5454 ** and the index used to access it (if any). If the table itself
5455 ** is not used, its name is just '{}'. If no index is used
5456 ** the index is listed as "{}". If the primary key is used the
5457 ** index name is '*'.
5458 */
drh9cd1c992012-09-25 20:43:35 +00005459 for(ii=0; ii<nTabList; ii++){
drh7ec764a2005-07-21 03:48:20 +00005460 char *z;
5461 int n;
drh3f4d1d12012-09-15 18:45:54 +00005462 int w;
drh56f1b992012-09-25 14:29:39 +00005463 struct SrcList_item *pTabItem;
5464
drh9cd1c992012-09-25 20:43:35 +00005465 pLevel = &pWInfo->a[ii];
drh3f4d1d12012-09-15 18:45:54 +00005466 w = pLevel->plan.wsFlags;
drh29dda4a2005-07-21 18:23:20 +00005467 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00005468 z = pTabItem->zAlias;
5469 if( z==0 ) z = pTabItem->pTab->zName;
drhea678832008-12-10 19:26:22 +00005470 n = sqlite3Strlen30(z);
drh7ec764a2005-07-21 03:48:20 +00005471 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
drh3f4d1d12012-09-15 18:45:54 +00005472 if( (w & WHERE_IDX_ONLY)!=0 && (w & WHERE_COVER_SCAN)==0 ){
drh5bb3eb92007-05-04 13:15:55 +00005473 memcpy(&sqlite3_query_plan[nQPlan], "{}", 2);
drh7ec764a2005-07-21 03:48:20 +00005474 nQPlan += 2;
5475 }else{
drh5bb3eb92007-05-04 13:15:55 +00005476 memcpy(&sqlite3_query_plan[nQPlan], z, n);
drh7ec764a2005-07-21 03:48:20 +00005477 nQPlan += n;
5478 }
5479 sqlite3_query_plan[nQPlan++] = ' ';
5480 }
drh3f4d1d12012-09-15 18:45:54 +00005481 testcase( w & WHERE_ROWID_EQ );
5482 testcase( w & WHERE_ROWID_RANGE );
5483 if( w & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh5bb3eb92007-05-04 13:15:55 +00005484 memcpy(&sqlite3_query_plan[nQPlan], "* ", 2);
drh7ec764a2005-07-21 03:48:20 +00005485 nQPlan += 2;
drh3f4d1d12012-09-15 18:45:54 +00005486 }else if( (w & WHERE_INDEXED)!=0 && (w & WHERE_COVER_SCAN)==0 ){
drh111a6a72008-12-21 03:51:16 +00005487 n = sqlite3Strlen30(pLevel->plan.u.pIdx->zName);
drh7ec764a2005-07-21 03:48:20 +00005488 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
drh111a6a72008-12-21 03:51:16 +00005489 memcpy(&sqlite3_query_plan[nQPlan], pLevel->plan.u.pIdx->zName, n);
drh7ec764a2005-07-21 03:48:20 +00005490 nQPlan += n;
5491 sqlite3_query_plan[nQPlan++] = ' ';
5492 }
drh111a6a72008-12-21 03:51:16 +00005493 }else{
5494 memcpy(&sqlite3_query_plan[nQPlan], "{} ", 3);
5495 nQPlan += 3;
drh7ec764a2005-07-21 03:48:20 +00005496 }
5497 }
5498 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
5499 sqlite3_query_plan[--nQPlan] = 0;
5500 }
5501 sqlite3_query_plan[nQPlan] = 0;
5502 nQPlan = 0;
5503#endif /* SQLITE_TEST // Testing and debugging use only */
5504
drh29dda4a2005-07-21 18:23:20 +00005505 /* Record the continuation address in the WhereInfo structure. Then
5506 ** clean up and return.
5507 */
drh75897232000-05-29 14:26:00 +00005508 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00005509
5510 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00005511whereBeginError:
drh8b307fb2010-04-06 15:57:05 +00005512 if( pWInfo ){
5513 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
5514 whereInfoFree(db, pWInfo);
5515 }
drhe23399f2005-07-22 00:31:39 +00005516 return 0;
drh75897232000-05-29 14:26:00 +00005517}
5518
5519/*
drhc27a1ce2002-06-14 20:58:45 +00005520** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00005521** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00005522*/
danielk19774adee202004-05-08 08:23:19 +00005523void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00005524 Parse *pParse = pWInfo->pParse;
5525 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00005526 int i;
drh6b563442001-11-07 16:48:26 +00005527 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00005528 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00005529 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00005530
drh9012bcb2004-12-19 00:11:35 +00005531 /* Generate loop termination code.
5532 */
drhceea3322009-04-23 13:22:42 +00005533 sqlite3ExprCacheClear(pParse);
drhc01a3c12009-12-16 22:10:49 +00005534 for(i=pWInfo->nLevel-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00005535 pLevel = &pWInfo->a[i];
drhb3190c12008-12-08 21:37:14 +00005536 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00005537 if( pLevel->op!=OP_Noop ){
drh66a51672008-01-03 00:01:23 +00005538 sqlite3VdbeAddOp2(v, pLevel->op, pLevel->p1, pLevel->p2);
drhd1d38482008-10-07 23:46:38 +00005539 sqlite3VdbeChangeP5(v, pLevel->p5);
drh19a775c2000-06-05 18:54:46 +00005540 }
drh111a6a72008-12-21 03:51:16 +00005541 if( pLevel->plan.wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
drh72e8fa42007-03-28 14:30:06 +00005542 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00005543 int j;
drhb3190c12008-12-08 21:37:14 +00005544 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh111a6a72008-12-21 03:51:16 +00005545 for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00005546 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
drh2d96b932013-02-08 18:48:23 +00005547 sqlite3VdbeAddOp2(v, pIn->eEndLoopOp, pIn->iCur, pIn->addrInTop);
drhb3190c12008-12-08 21:37:14 +00005548 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00005549 }
drh111a6a72008-12-21 03:51:16 +00005550 sqlite3DbFree(db, pLevel->u.in.aInLoop);
drhd99f7062002-06-08 23:25:08 +00005551 }
drhb3190c12008-12-08 21:37:14 +00005552 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhad2d8302002-05-24 20:31:36 +00005553 if( pLevel->iLeftJoin ){
5554 int addr;
drh3c84ddf2008-01-09 02:15:38 +00005555 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin);
drh35451c62009-11-12 04:26:39 +00005556 assert( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
5557 || (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 );
5558 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0 ){
5559 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
5560 }
drh9012bcb2004-12-19 00:11:35 +00005561 if( pLevel->iIdxCur>=0 ){
drh3c84ddf2008-01-09 02:15:38 +00005562 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00005563 }
drh336a5302009-04-24 15:46:21 +00005564 if( pLevel->op==OP_Return ){
5565 sqlite3VdbeAddOp2(v, OP_Gosub, pLevel->p1, pLevel->addrFirst);
5566 }else{
5567 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
5568 }
drhd654be82005-09-20 17:42:23 +00005569 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00005570 }
drh19a775c2000-06-05 18:54:46 +00005571 }
drh9012bcb2004-12-19 00:11:35 +00005572
5573 /* The "break" point is here, just past the end of the outer loop.
5574 ** Set it.
5575 */
danielk19774adee202004-05-08 08:23:19 +00005576 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00005577
drh29dda4a2005-07-21 18:23:20 +00005578 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00005579 */
drhc01a3c12009-12-16 22:10:49 +00005580 assert( pWInfo->nLevel==1 || pWInfo->nLevel==pTabList->nSrc );
5581 for(i=0, pLevel=pWInfo->a; i<pWInfo->nLevel; i++, pLevel++){
danbfca6a42012-08-24 10:52:35 +00005582 Index *pIdx = 0;
drh29dda4a2005-07-21 18:23:20 +00005583 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00005584 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00005585 assert( pTab!=0 );
drh4139c992010-04-07 14:59:45 +00005586 if( (pTab->tabFlags & TF_Ephemeral)==0
5587 && pTab->pSelect==0
drh9ef61f42011-10-07 14:40:59 +00005588 && (pWInfo->wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0
drh4139c992010-04-07 14:59:45 +00005589 ){
drh8b307fb2010-04-06 15:57:05 +00005590 int ws = pLevel->plan.wsFlags;
5591 if( !pWInfo->okOnePass && (ws & WHERE_IDX_ONLY)==0 ){
drh6df2acd2008-12-28 16:55:25 +00005592 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
5593 }
drhf12cde52010-04-08 17:28:00 +00005594 if( (ws & WHERE_INDEXED)!=0 && (ws & WHERE_TEMP_INDEX)==0 ){
drh6df2acd2008-12-28 16:55:25 +00005595 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
5596 }
drh9012bcb2004-12-19 00:11:35 +00005597 }
5598
danielk197721de2e72007-11-29 17:43:27 +00005599 /* If this scan uses an index, make code substitutions to read data
5600 ** from the index in preference to the table. Sometimes, this means
5601 ** the table need never be read from. This is a performance boost,
5602 ** as the vdbe level waits until the table is read before actually
5603 ** seeking the table cursor to the record corresponding to the current
5604 ** position in the index.
drh9012bcb2004-12-19 00:11:35 +00005605 **
5606 ** Calls to the code generator in between sqlite3WhereBegin and
5607 ** sqlite3WhereEnd will have created code that references the table
5608 ** directly. This loop scans all that code looking for opcodes
5609 ** that reference the table and converts them into opcodes that
5610 ** reference the index.
5611 */
danbfca6a42012-08-24 10:52:35 +00005612 if( pLevel->plan.wsFlags & WHERE_INDEXED ){
5613 pIdx = pLevel->plan.u.pIdx;
5614 }else if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drhd40e2082012-08-24 23:24:15 +00005615 pIdx = pLevel->u.pCovidx;
danbfca6a42012-08-24 10:52:35 +00005616 }
5617 if( pIdx && !db->mallocFailed){
danielk1977f0113002006-01-24 12:09:17 +00005618 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00005619 VdbeOp *pOp;
drh9012bcb2004-12-19 00:11:35 +00005620
drh9012bcb2004-12-19 00:11:35 +00005621 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
5622 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00005623 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00005624 if( pOp->p1!=pLevel->iTabCur ) continue;
5625 if( pOp->opcode==OP_Column ){
drh9012bcb2004-12-19 00:11:35 +00005626 for(j=0; j<pIdx->nColumn; j++){
5627 if( pOp->p2==pIdx->aiColumn[j] ){
5628 pOp->p2 = j;
danielk197721de2e72007-11-29 17:43:27 +00005629 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00005630 break;
5631 }
5632 }
drh35451c62009-11-12 04:26:39 +00005633 assert( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
5634 || j<pIdx->nColumn );
drhf0863fe2005-06-12 21:35:51 +00005635 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00005636 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00005637 pOp->opcode = OP_IdxRowid;
drh9012bcb2004-12-19 00:11:35 +00005638 }
5639 }
drh6b563442001-11-07 16:48:26 +00005640 }
drh19a775c2000-06-05 18:54:46 +00005641 }
drh9012bcb2004-12-19 00:11:35 +00005642
5643 /* Final cleanup
5644 */
drhf12cde52010-04-08 17:28:00 +00005645 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
5646 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00005647 return;
5648}