blob: f9deb3d418dd8419c01cf59b3431a64cb8d4b670 [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>" */
101 WhereOrInfo *pOrInfo; /* Extra information if eOperator==WO_OR */
102 WhereAndInfo *pAndInfo; /* Extra information if eOperator==WO_AND */
103 } 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 */
danielk1977e672c8e2009-05-22 15:43:26 +0000143 Bitmask vmask; /* Bitmask identifying virtual table cursors */
drh8871ef52011-10-07 13:33:10 +0000144 WhereClause *pOuter; /* Outer conjunction */
drh29435252008-12-28 18:35:08 +0000145 u8 op; /* Split operator. TK_AND or TK_OR */
drh9ef61f42011-10-07 14:40:59 +0000146 u16 wctrlFlags; /* Might include WHERE_AND_ONLY */
drh0aa74ed2005-07-16 13:33:20 +0000147 int nTerm; /* Number of terms */
148 int nSlot; /* Number of entries in a[] */
drh51147ba2005-07-23 22:59:55 +0000149 WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
drh50d654d2009-06-03 01:24:54 +0000150#if defined(SQLITE_SMALL_STACK)
151 WhereTerm aStatic[1]; /* Initial static space for a[] */
152#else
153 WhereTerm aStatic[8]; /* Initial static space for a[] */
154#endif
drhe23399f2005-07-22 00:31:39 +0000155};
156
157/*
drh700a2262008-12-17 19:22:15 +0000158** A WhereTerm with eOperator==WO_OR has its u.pOrInfo pointer set to
159** a dynamically allocated instance of the following structure.
160*/
161struct WhereOrInfo {
drh111a6a72008-12-21 03:51:16 +0000162 WhereClause wc; /* Decomposition into subterms */
drh1a58fe02008-12-20 02:06:13 +0000163 Bitmask indexable; /* Bitmask of all indexable tables in the clause */
drh700a2262008-12-17 19:22:15 +0000164};
165
166/*
167** A WhereTerm with eOperator==WO_AND has its u.pAndInfo pointer set to
168** a dynamically allocated instance of the following structure.
169*/
170struct WhereAndInfo {
drh29435252008-12-28 18:35:08 +0000171 WhereClause wc; /* The subexpression broken out */
drh700a2262008-12-17 19:22:15 +0000172};
173
174/*
drh6a3ea0e2003-05-02 14:32:12 +0000175** An instance of the following structure keeps track of a mapping
drh0aa74ed2005-07-16 13:33:20 +0000176** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
drh51669862004-12-18 18:40:26 +0000177**
178** The VDBE cursor numbers are small integers contained in
179** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
180** clause, the cursor numbers might not begin with 0 and they might
181** contain gaps in the numbering sequence. But we want to make maximum
182** use of the bits in our bitmasks. This structure provides a mapping
183** from the sparse cursor numbers into consecutive integers beginning
184** with 0.
185**
drh111a6a72008-12-21 03:51:16 +0000186** If WhereMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
drh51669862004-12-18 18:40:26 +0000187** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
188**
189** For example, if the WHERE clause expression used these VDBE
drh111a6a72008-12-21 03:51:16 +0000190** cursors: 4, 5, 8, 29, 57, 73. Then the WhereMaskSet structure
drh51669862004-12-18 18:40:26 +0000191** would map those cursor numbers into bits 0 through 5.
192**
193** Note that the mapping is not necessarily ordered. In the example
194** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
195** 57->5, 73->4. Or one of 719 other combinations might be used. It
196** does not really matter. What is important is that sparse cursor
197** numbers all get mapped into bit numbers that begin with 0 and contain
198** no gaps.
drh6a3ea0e2003-05-02 14:32:12 +0000199*/
drh111a6a72008-12-21 03:51:16 +0000200struct WhereMaskSet {
drh1398ad32005-01-19 23:24:50 +0000201 int n; /* Number of assigned cursor values */
danielk197723432972008-11-17 16:42:00 +0000202 int ix[BMS]; /* Cursor assigned to each bit */
drh6a3ea0e2003-05-02 14:32:12 +0000203};
204
drh111a6a72008-12-21 03:51:16 +0000205/*
206** A WhereCost object records a lookup strategy and the estimated
207** cost of pursuing that strategy.
208*/
209struct WhereCost {
210 WherePlan plan; /* The lookup strategy */
211 double rCost; /* Overall cost of pursuing this search strategy */
dan5236ac12009-08-13 07:09:33 +0000212 Bitmask used; /* Bitmask of cursors used by this plan */
drh111a6a72008-12-21 03:51:16 +0000213};
drh0aa74ed2005-07-16 13:33:20 +0000214
drh6a3ea0e2003-05-02 14:32:12 +0000215/*
drh51147ba2005-07-23 22:59:55 +0000216** Bitmasks for the operators that indices are able to exploit. An
217** OR-ed combination of these values can be used when searching for
218** terms in the where clause.
219*/
drh165be382008-12-05 02:36:33 +0000220#define WO_IN 0x001
221#define WO_EQ 0x002
drh51147ba2005-07-23 22:59:55 +0000222#define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
223#define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
224#define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
225#define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
drh165be382008-12-05 02:36:33 +0000226#define WO_MATCH 0x040
227#define WO_ISNULL 0x080
drh700a2262008-12-17 19:22:15 +0000228#define WO_OR 0x100 /* Two or more OR-connected terms */
229#define WO_AND 0x200 /* Two or more AND-connected terms */
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 */
drh46619d62009-04-24 14:51:42 +0000256#define WHERE_IN_ABLE 0x000f1000 /* 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;
danielk1977e672c8e2009-05-22 15:43:26 +0000319 pWC->vmask = 0;
drh9ef61f42011-10-07 14:40:59 +0000320 pWC->wctrlFlags = wctrlFlags;
drh0aa74ed2005-07-16 13:33:20 +0000321}
322
drh700a2262008-12-17 19:22:15 +0000323/* Forward reference */
324static void whereClauseClear(WhereClause*);
325
326/*
327** Deallocate all memory associated with a WhereOrInfo object.
328*/
329static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000330 whereClauseClear(&p->wc);
331 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000332}
333
334/*
335** Deallocate all memory associated with a WhereAndInfo object.
336*/
337static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000338 whereClauseClear(&p->wc);
339 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000340}
341
drh0aa74ed2005-07-16 13:33:20 +0000342/*
343** Deallocate a WhereClause structure. The WhereClause structure
344** itself is not freed. This routine is the inverse of whereClauseInit().
345*/
346static void whereClauseClear(WhereClause *pWC){
347 int i;
348 WhereTerm *a;
drh633e6d52008-07-28 19:34:53 +0000349 sqlite3 *db = pWC->pParse->db;
drh0aa74ed2005-07-16 13:33:20 +0000350 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
drh165be382008-12-05 02:36:33 +0000351 if( a->wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000352 sqlite3ExprDelete(db, a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000353 }
drh700a2262008-12-17 19:22:15 +0000354 if( a->wtFlags & TERM_ORINFO ){
355 whereOrInfoDelete(db, a->u.pOrInfo);
356 }else if( a->wtFlags & TERM_ANDINFO ){
357 whereAndInfoDelete(db, a->u.pAndInfo);
358 }
drh0aa74ed2005-07-16 13:33:20 +0000359 }
360 if( pWC->a!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000361 sqlite3DbFree(db, pWC->a);
drh0aa74ed2005-07-16 13:33:20 +0000362 }
363}
364
365/*
drh6a1e0712008-12-05 15:24:15 +0000366** Add a single new WhereTerm entry to the WhereClause object pWC.
367** The new WhereTerm object is constructed from Expr p and with wtFlags.
368** The index in pWC->a[] of the new WhereTerm is returned on success.
369** 0 is returned if the new WhereTerm could not be added due to a memory
370** allocation error. The memory allocation failure will be recorded in
371** the db->mallocFailed flag so that higher-level functions can detect it.
372**
373** This routine will increase the size of the pWC->a[] array as necessary.
drh9eb20282005-08-24 03:52:18 +0000374**
drh165be382008-12-05 02:36:33 +0000375** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
drh6a1e0712008-12-05 15:24:15 +0000376** for freeing the expression p is assumed by the WhereClause object pWC.
377** This is true even if this routine fails to allocate a new WhereTerm.
drhb63a53d2007-03-31 01:34:44 +0000378**
drh9eb20282005-08-24 03:52:18 +0000379** WARNING: This routine might reallocate the space used to store
drh909626d2008-05-30 14:58:37 +0000380** WhereTerms. All pointers to WhereTerms should be invalidated after
drh9eb20282005-08-24 03:52:18 +0000381** calling this routine. Such pointers may be reinitialized by referencing
382** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000383*/
drhec1724e2008-12-09 01:32:03 +0000384static int whereClauseInsert(WhereClause *pWC, Expr *p, u8 wtFlags){
drh0aa74ed2005-07-16 13:33:20 +0000385 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000386 int idx;
drhe9cdcea2010-07-22 22:40:03 +0000387 testcase( wtFlags & TERM_VIRTUAL ); /* EV: R-00211-15100 */
drh0aa74ed2005-07-16 13:33:20 +0000388 if( pWC->nTerm>=pWC->nSlot ){
389 WhereTerm *pOld = pWC->a;
drh633e6d52008-07-28 19:34:53 +0000390 sqlite3 *db = pWC->pParse->db;
391 pWC->a = sqlite3DbMallocRaw(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
drhb63a53d2007-03-31 01:34:44 +0000392 if( pWC->a==0 ){
drh165be382008-12-05 02:36:33 +0000393 if( wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000394 sqlite3ExprDelete(db, p);
drhb63a53d2007-03-31 01:34:44 +0000395 }
drhf998b732007-11-26 13:36:00 +0000396 pWC->a = pOld;
drhb63a53d2007-03-31 01:34:44 +0000397 return 0;
398 }
drh0aa74ed2005-07-16 13:33:20 +0000399 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
400 if( pOld!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000401 sqlite3DbFree(db, pOld);
drh0aa74ed2005-07-16 13:33:20 +0000402 }
drh6a1e0712008-12-05 15:24:15 +0000403 pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
drh0aa74ed2005-07-16 13:33:20 +0000404 }
drh6a1e0712008-12-05 15:24:15 +0000405 pTerm = &pWC->a[idx = pWC->nTerm++];
drh0fcef5e2005-07-19 17:38:22 +0000406 pTerm->pExpr = p;
drh165be382008-12-05 02:36:33 +0000407 pTerm->wtFlags = wtFlags;
drh0fcef5e2005-07-19 17:38:22 +0000408 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000409 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000410 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000411}
drh75897232000-05-29 14:26:00 +0000412
413/*
drh51669862004-12-18 18:40:26 +0000414** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000415** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000416** operator specified in the op parameter. The WhereClause structure
417** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000418**
drh51669862004-12-18 18:40:26 +0000419** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
420** \________/ \_______________/ \________________/
421** slot[0] slot[1] slot[2]
422**
423** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000424** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000425**
drh51147ba2005-07-23 22:59:55 +0000426** In the previous sentence and in the diagram, "slot[]" refers to
drh902b9ee2008-12-05 17:17:07 +0000427** the WhereClause.a[] array. The slot[] array grows as needed to contain
drh51147ba2005-07-23 22:59:55 +0000428** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000429*/
drh6c30be82005-07-29 15:10:17 +0000430static void whereSplit(WhereClause *pWC, Expr *pExpr, int op){
drh29435252008-12-28 18:35:08 +0000431 pWC->op = (u8)op;
drh0aa74ed2005-07-16 13:33:20 +0000432 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000433 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000434 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000435 }else{
drh6c30be82005-07-29 15:10:17 +0000436 whereSplit(pWC, pExpr->pLeft, op);
437 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000438 }
drh75897232000-05-29 14:26:00 +0000439}
440
441/*
drh61495262009-04-22 15:32:59 +0000442** Initialize an expression mask set (a WhereMaskSet object)
drh6a3ea0e2003-05-02 14:32:12 +0000443*/
444#define initMaskSet(P) memset(P, 0, sizeof(*P))
445
446/*
drh1398ad32005-01-19 23:24:50 +0000447** Return the bitmask for the given cursor number. Return 0 if
448** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000449*/
drh111a6a72008-12-21 03:51:16 +0000450static Bitmask getMask(WhereMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000451 int i;
drhfcd71b62011-04-05 22:08:24 +0000452 assert( pMaskSet->n<=(int)sizeof(Bitmask)*8 );
drh6a3ea0e2003-05-02 14:32:12 +0000453 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000454 if( pMaskSet->ix[i]==iCursor ){
455 return ((Bitmask)1)<<i;
456 }
drh6a3ea0e2003-05-02 14:32:12 +0000457 }
drh6a3ea0e2003-05-02 14:32:12 +0000458 return 0;
459}
460
461/*
drh1398ad32005-01-19 23:24:50 +0000462** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000463**
464** There is one cursor per table in the FROM clause. The number of
465** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000466** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000467** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000468*/
drh111a6a72008-12-21 03:51:16 +0000469static void createMask(WhereMaskSet *pMaskSet, int iCursor){
drhcad651e2007-04-20 12:22:01 +0000470 assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
drh0fcef5e2005-07-19 17:38:22 +0000471 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000472}
473
474/*
drh75897232000-05-29 14:26:00 +0000475** This routine walks (recursively) an expression tree and generates
476** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000477** tree.
drh75897232000-05-29 14:26:00 +0000478**
479** In order for this routine to work, the calling function must have
drh7d10d5a2008-08-20 16:35:10 +0000480** previously invoked sqlite3ResolveExprNames() on the expression. See
drh75897232000-05-29 14:26:00 +0000481** the header comment on that routine for additional information.
drh7d10d5a2008-08-20 16:35:10 +0000482** The sqlite3ResolveExprNames() routines looks for column names and
drh6a3ea0e2003-05-02 14:32:12 +0000483** sets their opcodes to TK_COLUMN and their Expr.iTable fields to
drh51147ba2005-07-23 22:59:55 +0000484** the VDBE cursor number of the table. This routine just has to
485** translate the cursor numbers into bitmask values and OR all
486** the bitmasks together.
drh75897232000-05-29 14:26:00 +0000487*/
drh111a6a72008-12-21 03:51:16 +0000488static Bitmask exprListTableUsage(WhereMaskSet*, ExprList*);
489static Bitmask exprSelectTableUsage(WhereMaskSet*, Select*);
490static Bitmask exprTableUsage(WhereMaskSet *pMaskSet, Expr *p){
drh51669862004-12-18 18:40:26 +0000491 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000492 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000493 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000494 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000495 return mask;
drh75897232000-05-29 14:26:00 +0000496 }
danielk1977b3bce662005-01-29 08:32:43 +0000497 mask = exprTableUsage(pMaskSet, p->pRight);
498 mask |= exprTableUsage(pMaskSet, p->pLeft);
danielk19776ab3a2e2009-02-19 14:39:25 +0000499 if( ExprHasProperty(p, EP_xIsSelect) ){
500 mask |= exprSelectTableUsage(pMaskSet, p->x.pSelect);
501 }else{
502 mask |= exprListTableUsage(pMaskSet, p->x.pList);
503 }
danielk1977b3bce662005-01-29 08:32:43 +0000504 return mask;
505}
drh111a6a72008-12-21 03:51:16 +0000506static Bitmask exprListTableUsage(WhereMaskSet *pMaskSet, ExprList *pList){
danielk1977b3bce662005-01-29 08:32:43 +0000507 int i;
508 Bitmask mask = 0;
509 if( pList ){
510 for(i=0; i<pList->nExpr; i++){
511 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000512 }
513 }
drh75897232000-05-29 14:26:00 +0000514 return mask;
515}
drh111a6a72008-12-21 03:51:16 +0000516static Bitmask exprSelectTableUsage(WhereMaskSet *pMaskSet, Select *pS){
drha430ae82007-09-12 15:41:01 +0000517 Bitmask mask = 0;
518 while( pS ){
drha464c232011-09-16 19:04:03 +0000519 SrcList *pSrc = pS->pSrc;
drha430ae82007-09-12 15:41:01 +0000520 mask |= exprListTableUsage(pMaskSet, pS->pEList);
drhf5b11382005-09-17 13:07:13 +0000521 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
522 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
523 mask |= exprTableUsage(pMaskSet, pS->pWhere);
524 mask |= exprTableUsage(pMaskSet, pS->pHaving);
drha464c232011-09-16 19:04:03 +0000525 if( ALWAYS(pSrc!=0) ){
drh88501772011-09-16 17:43:06 +0000526 int i;
527 for(i=0; i<pSrc->nSrc; i++){
528 mask |= exprSelectTableUsage(pMaskSet, pSrc->a[i].pSelect);
529 mask |= exprTableUsage(pMaskSet, pSrc->a[i].pOn);
530 }
531 }
drha430ae82007-09-12 15:41:01 +0000532 pS = pS->pPrior;
drhf5b11382005-09-17 13:07:13 +0000533 }
534 return mask;
535}
drh75897232000-05-29 14:26:00 +0000536
537/*
drh487ab3c2001-11-08 00:45:21 +0000538** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000539** allowed for an indexable WHERE clause term. The allowed operators are
drhc27a1ce2002-06-14 20:58:45 +0000540** "=", "<", ">", "<=", ">=", and "IN".
drhe9cdcea2010-07-22 22:40:03 +0000541**
542** IMPLEMENTATION-OF: R-59926-26393 To be usable by an index a term must be
543** of one of the following forms: column = expression column > expression
544** column >= expression column < expression column <= expression
545** expression = column expression > column expression >= column
546** expression < column expression <= column column IN
547** (expression-list) column IN (subquery) column IS NULL
drh487ab3c2001-11-08 00:45:21 +0000548*/
549static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000550 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
551 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
552 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
553 assert( TK_GE==TK_EQ+4 );
drh50b39962006-10-28 00:28:09 +0000554 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL;
drh487ab3c2001-11-08 00:45:21 +0000555}
556
557/*
drh902b9ee2008-12-05 17:17:07 +0000558** Swap two objects of type TYPE.
drh193bd772004-07-20 18:23:14 +0000559*/
560#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
561
562/*
drh909626d2008-05-30 14:58:37 +0000563** Commute a comparison operator. Expressions of the form "X op Y"
drh0fcef5e2005-07-19 17:38:22 +0000564** are converted into "Y op X".
danielk1977eb5453d2007-07-30 14:40:48 +0000565**
566** If a collation sequence is associated with either the left or right
567** side of the comparison, it remains associated with the same side after
568** the commutation. So "Y collate NOCASE op X" becomes
569** "X collate NOCASE op Y". This is because any collation sequence on
570** the left hand side of a comparison overrides any collation sequence
571** attached to the right. For the same reason the EP_ExpCollate flag
572** is not commuted.
drh193bd772004-07-20 18:23:14 +0000573*/
drh7d10d5a2008-08-20 16:35:10 +0000574static void exprCommute(Parse *pParse, Expr *pExpr){
danielk1977eb5453d2007-07-30 14:40:48 +0000575 u16 expRight = (pExpr->pRight->flags & EP_ExpCollate);
576 u16 expLeft = (pExpr->pLeft->flags & EP_ExpCollate);
drhfe05af82005-07-21 03:14:59 +0000577 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drh7d10d5a2008-08-20 16:35:10 +0000578 pExpr->pRight->pColl = sqlite3ExprCollSeq(pParse, pExpr->pRight);
579 pExpr->pLeft->pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drh0fcef5e2005-07-19 17:38:22 +0000580 SWAP(CollSeq*,pExpr->pRight->pColl,pExpr->pLeft->pColl);
danielk1977eb5453d2007-07-30 14:40:48 +0000581 pExpr->pRight->flags = (pExpr->pRight->flags & ~EP_ExpCollate) | expLeft;
582 pExpr->pLeft->flags = (pExpr->pLeft->flags & ~EP_ExpCollate) | expRight;
drh0fcef5e2005-07-19 17:38:22 +0000583 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
584 if( pExpr->op>=TK_GT ){
585 assert( TK_LT==TK_GT+2 );
586 assert( TK_GE==TK_LE+2 );
587 assert( TK_GT>TK_EQ );
588 assert( TK_GT<TK_LE );
589 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
590 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000591 }
drh193bd772004-07-20 18:23:14 +0000592}
593
594/*
drhfe05af82005-07-21 03:14:59 +0000595** Translate from TK_xx operator to WO_xx bitmask.
596*/
drhec1724e2008-12-09 01:32:03 +0000597static u16 operatorMask(int op){
598 u16 c;
drhfe05af82005-07-21 03:14:59 +0000599 assert( allowedOp(op) );
600 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000601 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000602 }else if( op==TK_ISNULL ){
603 c = WO_ISNULL;
drhfe05af82005-07-21 03:14:59 +0000604 }else{
drhec1724e2008-12-09 01:32:03 +0000605 assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
606 c = (u16)(WO_EQ<<(op-TK_EQ));
drhfe05af82005-07-21 03:14:59 +0000607 }
drh50b39962006-10-28 00:28:09 +0000608 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh51147ba2005-07-23 22:59:55 +0000609 assert( op!=TK_IN || c==WO_IN );
610 assert( op!=TK_EQ || c==WO_EQ );
611 assert( op!=TK_LT || c==WO_LT );
612 assert( op!=TK_LE || c==WO_LE );
613 assert( op!=TK_GT || c==WO_GT );
614 assert( op!=TK_GE || c==WO_GE );
615 return c;
drhfe05af82005-07-21 03:14:59 +0000616}
617
618/*
619** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
620** where X is a reference to the iColumn of table iCur and <op> is one of
621** the WO_xx operator codes specified by the op parameter.
622** Return a pointer to the term. Return 0 if not found.
623*/
624static WhereTerm *findTerm(
625 WhereClause *pWC, /* The WHERE clause to be searched */
626 int iCur, /* Cursor number of LHS */
627 int iColumn, /* Column number of LHS */
628 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000629 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000630 Index *pIdx /* Must be compatible with this index, if not NULL */
631){
632 WhereTerm *pTerm;
633 int k;
drh22c24032008-07-09 13:28:53 +0000634 assert( iCur>=0 );
drhec1724e2008-12-09 01:32:03 +0000635 op &= WO_ALL;
drh8871ef52011-10-07 13:33:10 +0000636 for(; pWC; pWC=pWC->pOuter){
637 for(pTerm=pWC->a, k=pWC->nTerm; k; k--, pTerm++){
638 if( pTerm->leftCursor==iCur
639 && (pTerm->prereqRight & notReady)==0
640 && pTerm->u.leftColumn==iColumn
641 && (pTerm->eOperator & op)!=0
642 ){
dan0c733f62011-11-16 15:27:09 +0000643 if( iColumn>=0 && pIdx && pTerm->eOperator!=WO_ISNULL ){
drh8871ef52011-10-07 13:33:10 +0000644 Expr *pX = pTerm->pExpr;
645 CollSeq *pColl;
646 char idxaff;
647 int j;
648 Parse *pParse = pWC->pParse;
649
650 idxaff = pIdx->pTable->aCol[iColumn].affinity;
651 if( !sqlite3IndexAffinityOk(pX, idxaff) ) continue;
652
653 /* Figure out the collation sequence required from an index for
654 ** it to be useful for optimising expression pX. Store this
655 ** value in variable pColl.
656 */
657 assert(pX->pLeft);
658 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
659 assert(pColl || pParse->nErr);
660
661 for(j=0; pIdx->aiColumn[j]!=iColumn; j++){
662 if( NEVER(j>=pIdx->nColumn) ) return 0;
663 }
664 if( pColl && sqlite3StrICmp(pColl->zName, pIdx->azColl[j]) ) continue;
drh22c24032008-07-09 13:28:53 +0000665 }
drh8871ef52011-10-07 13:33:10 +0000666 return pTerm;
drhfe05af82005-07-21 03:14:59 +0000667 }
drhfe05af82005-07-21 03:14:59 +0000668 }
669 }
670 return 0;
671}
672
drh6c30be82005-07-29 15:10:17 +0000673/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000674static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000675
676/*
677** Call exprAnalyze on all terms in a WHERE clause.
678**
679**
680*/
681static void exprAnalyzeAll(
682 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000683 WhereClause *pWC /* the WHERE clause to be analyzed */
684){
drh6c30be82005-07-29 15:10:17 +0000685 int i;
drh9eb20282005-08-24 03:52:18 +0000686 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000687 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000688 }
689}
690
drhd2687b72005-08-12 22:56:09 +0000691#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
692/*
693** Check to see if the given expression is a LIKE or GLOB operator that
694** can be optimized using inequality constraints. Return TRUE if it is
695** so and false if not.
696**
697** In order for the operator to be optimizible, the RHS must be a string
698** literal that does not begin with a wildcard.
699*/
700static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000701 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000702 Expr *pExpr, /* Test this expression */
dan937d0de2009-10-15 18:35:38 +0000703 Expr **ppPrefix, /* Pointer to TK_STRING expression with pattern prefix */
drh9f504ea2008-02-23 21:55:39 +0000704 int *pisComplete, /* True if the only wildcard is % in the last character */
705 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000706){
dan937d0de2009-10-15 18:35:38 +0000707 const char *z = 0; /* String on RHS of LIKE operator */
drh5bd98ae2009-01-07 18:24:03 +0000708 Expr *pRight, *pLeft; /* Right and left size of LIKE operator */
709 ExprList *pList; /* List of operands to the LIKE operator */
710 int c; /* One character in z[] */
711 int cnt; /* Number of non-wildcard prefix characters */
712 char wc[3]; /* Wildcard characters */
drh5bd98ae2009-01-07 18:24:03 +0000713 sqlite3 *db = pParse->db; /* Database connection */
dan937d0de2009-10-15 18:35:38 +0000714 sqlite3_value *pVal = 0;
715 int op; /* Opcode of pRight */
drhd64fe2f2005-08-28 17:00:23 +0000716
drh9f504ea2008-02-23 21:55:39 +0000717 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000718 return 0;
719 }
drh9f504ea2008-02-23 21:55:39 +0000720#ifdef SQLITE_EBCDIC
721 if( *pnoCase ) return 0;
722#endif
danielk19776ab3a2e2009-02-19 14:39:25 +0000723 pList = pExpr->x.pList;
drh55ef4d92005-08-14 01:20:37 +0000724 pLeft = pList->a[1].pExpr;
danc68939e2012-03-29 14:29:07 +0000725 if( pLeft->op!=TK_COLUMN
726 || sqlite3ExprAffinity(pLeft)!=SQLITE_AFF_TEXT
727 || IsVirtual(pLeft->pTab)
728 ){
drhd91ca492009-10-22 20:50:36 +0000729 /* IMP: R-02065-49465 The left-hand side of the LIKE or GLOB operator must
730 ** be the name of an indexed column with TEXT affinity. */
drhd2687b72005-08-12 22:56:09 +0000731 return 0;
732 }
drhd91ca492009-10-22 20:50:36 +0000733 assert( pLeft->iColumn!=(-1) ); /* Because IPK never has AFF_TEXT */
dan937d0de2009-10-15 18:35:38 +0000734
735 pRight = pList->a[0].pExpr;
736 op = pRight->op;
737 if( op==TK_REGISTER ){
738 op = pRight->op2;
739 }
740 if( op==TK_VARIABLE ){
741 Vdbe *pReprepare = pParse->pReprepare;
drha7044002010-09-14 18:22:59 +0000742 int iCol = pRight->iColumn;
743 pVal = sqlite3VdbeGetValue(pReprepare, iCol, SQLITE_AFF_NONE);
dan937d0de2009-10-15 18:35:38 +0000744 if( pVal && sqlite3_value_type(pVal)==SQLITE_TEXT ){
745 z = (char *)sqlite3_value_text(pVal);
746 }
drhf9b22ca2011-10-21 16:47:31 +0000747 sqlite3VdbeSetVarmask(pParse->pVdbe, iCol);
dan937d0de2009-10-15 18:35:38 +0000748 assert( pRight->op==TK_VARIABLE || pRight->op==TK_REGISTER );
749 }else if( op==TK_STRING ){
750 z = pRight->u.zToken;
751 }
752 if( z ){
shane85095702009-06-15 16:27:08 +0000753 cnt = 0;
drhb7916a72009-05-27 10:31:29 +0000754 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){
drh24fb6272009-05-01 21:13:36 +0000755 cnt++;
756 }
drh93ee23c2010-07-22 12:33:57 +0000757 if( cnt!=0 && 255!=(u8)z[cnt-1] ){
dan937d0de2009-10-15 18:35:38 +0000758 Expr *pPrefix;
drh93ee23c2010-07-22 12:33:57 +0000759 *pisComplete = c==wc[0] && z[cnt+1]==0;
dan937d0de2009-10-15 18:35:38 +0000760 pPrefix = sqlite3Expr(db, TK_STRING, z);
761 if( pPrefix ) pPrefix->u.zToken[cnt] = 0;
762 *ppPrefix = pPrefix;
763 if( op==TK_VARIABLE ){
764 Vdbe *v = pParse->pVdbe;
drhf9b22ca2011-10-21 16:47:31 +0000765 sqlite3VdbeSetVarmask(v, pRight->iColumn);
dan937d0de2009-10-15 18:35:38 +0000766 if( *pisComplete && pRight->u.zToken[1] ){
767 /* If the rhs of the LIKE expression is a variable, and the current
768 ** value of the variable means there is no need to invoke the LIKE
769 ** function, then no OP_Variable will be added to the program.
770 ** This causes problems for the sqlite3_bind_parameter_name()
drhbec451f2009-10-17 13:13:02 +0000771 ** API. To workaround them, add a dummy OP_Variable here.
772 */
773 int r1 = sqlite3GetTempReg(pParse);
774 sqlite3ExprCodeTarget(pParse, pRight, r1);
dan937d0de2009-10-15 18:35:38 +0000775 sqlite3VdbeChangeP3(v, sqlite3VdbeCurrentAddr(v)-1, 0);
drhbec451f2009-10-17 13:13:02 +0000776 sqlite3ReleaseTempReg(pParse, r1);
dan937d0de2009-10-15 18:35:38 +0000777 }
778 }
779 }else{
780 z = 0;
shane85095702009-06-15 16:27:08 +0000781 }
drhf998b732007-11-26 13:36:00 +0000782 }
dan937d0de2009-10-15 18:35:38 +0000783
784 sqlite3ValueFree(pVal);
785 return (z!=0);
drhd2687b72005-08-12 22:56:09 +0000786}
787#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
788
drhedb193b2006-06-27 13:20:21 +0000789
790#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000791/*
drh7f375902006-06-13 17:38:59 +0000792** Check to see if the given expression is of the form
793**
794** column MATCH expr
795**
796** If it is then return TRUE. If not, return FALSE.
797*/
798static int isMatchOfColumn(
799 Expr *pExpr /* Test this expression */
800){
801 ExprList *pList;
802
803 if( pExpr->op!=TK_FUNCTION ){
804 return 0;
805 }
drh33e619f2009-05-28 01:00:55 +0000806 if( sqlite3StrICmp(pExpr->u.zToken,"match")!=0 ){
drh7f375902006-06-13 17:38:59 +0000807 return 0;
808 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000809 pList = pExpr->x.pList;
drh7f375902006-06-13 17:38:59 +0000810 if( pList->nExpr!=2 ){
811 return 0;
812 }
813 if( pList->a[1].pExpr->op != TK_COLUMN ){
814 return 0;
815 }
816 return 1;
817}
drhedb193b2006-06-27 13:20:21 +0000818#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000819
820/*
drh54a167d2005-11-26 14:08:07 +0000821** If the pBase expression originated in the ON or USING clause of
822** a join, then transfer the appropriate markings over to derived.
823*/
824static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
825 pDerived->flags |= pBase->flags & EP_FromJoin;
826 pDerived->iRightJoinTable = pBase->iRightJoinTable;
827}
828
drh3e355802007-02-23 23:13:33 +0000829#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
830/*
drh1a58fe02008-12-20 02:06:13 +0000831** Analyze a term that consists of two or more OR-connected
832** subterms. So in:
drh3e355802007-02-23 23:13:33 +0000833**
drh1a58fe02008-12-20 02:06:13 +0000834** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
835** ^^^^^^^^^^^^^^^^^^^^
drh3e355802007-02-23 23:13:33 +0000836**
drh1a58fe02008-12-20 02:06:13 +0000837** This routine analyzes terms such as the middle term in the above example.
838** A WhereOrTerm object is computed and attached to the term under
839** analysis, regardless of the outcome of the analysis. Hence:
drh3e355802007-02-23 23:13:33 +0000840**
drh1a58fe02008-12-20 02:06:13 +0000841** WhereTerm.wtFlags |= TERM_ORINFO
842** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
drh3e355802007-02-23 23:13:33 +0000843**
drh1a58fe02008-12-20 02:06:13 +0000844** The term being analyzed must have two or more of OR-connected subterms.
danielk1977fdc40192008-12-29 18:33:32 +0000845** A single subterm might be a set of AND-connected sub-subterms.
drh1a58fe02008-12-20 02:06:13 +0000846** Examples of terms under analysis:
drh3e355802007-02-23 23:13:33 +0000847**
drh1a58fe02008-12-20 02:06:13 +0000848** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
849** (B) x=expr1 OR expr2=x OR x=expr3
850** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
851** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
852** (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 +0000853**
drh1a58fe02008-12-20 02:06:13 +0000854** CASE 1:
855**
856** If all subterms are of the form T.C=expr for some single column of C
857** a single table T (as shown in example B above) then create a new virtual
858** term that is an equivalent IN expression. In other words, if the term
859** being analyzed is:
860**
861** x = expr1 OR expr2 = x OR x = expr3
862**
863** then create a new virtual term like this:
864**
865** x IN (expr1,expr2,expr3)
866**
867** CASE 2:
868**
869** If all subterms are indexable by a single table T, then set
870**
871** WhereTerm.eOperator = WO_OR
872** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
873**
874** A subterm is "indexable" if it is of the form
875** "T.C <op> <expr>" where C is any column of table T and
876** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
877** A subterm is also indexable if it is an AND of two or more
878** subsubterms at least one of which is indexable. Indexable AND
879** subterms have their eOperator set to WO_AND and they have
880** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
881**
882** From another point of view, "indexable" means that the subterm could
883** potentially be used with an index if an appropriate index exists.
884** This analysis does not consider whether or not the index exists; that
885** is something the bestIndex() routine will determine. This analysis
886** only looks at whether subterms appropriate for indexing exist.
887**
888** All examples A through E above all satisfy case 2. But if a term
889** also statisfies case 1 (such as B) we know that the optimizer will
890** always prefer case 1, so in that case we pretend that case 2 is not
891** satisfied.
892**
893** It might be the case that multiple tables are indexable. For example,
894** (E) above is indexable on tables P, Q, and R.
895**
896** Terms that satisfy case 2 are candidates for lookup by using
897** separate indices to find rowids for each subterm and composing
898** the union of all rowids using a RowSet object. This is similar
899** to "bitmap indices" in other database engines.
900**
901** OTHERWISE:
902**
903** If neither case 1 nor case 2 apply, then leave the eOperator set to
904** zero. This term is not useful for search.
drh3e355802007-02-23 23:13:33 +0000905*/
drh1a58fe02008-12-20 02:06:13 +0000906static void exprAnalyzeOrTerm(
907 SrcList *pSrc, /* the FROM clause */
908 WhereClause *pWC, /* the complete WHERE clause */
909 int idxTerm /* Index of the OR-term to be analyzed */
910){
911 Parse *pParse = pWC->pParse; /* Parser context */
912 sqlite3 *db = pParse->db; /* Database connection */
913 WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
914 Expr *pExpr = pTerm->pExpr; /* The expression of the term */
drh111a6a72008-12-21 03:51:16 +0000915 WhereMaskSet *pMaskSet = pWC->pMaskSet; /* Table use masks */
drh1a58fe02008-12-20 02:06:13 +0000916 int i; /* Loop counters */
917 WhereClause *pOrWc; /* Breakup of pTerm into subterms */
918 WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
919 WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
920 Bitmask chngToIN; /* Tables that might satisfy case 1 */
921 Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
drh3e355802007-02-23 23:13:33 +0000922
drh1a58fe02008-12-20 02:06:13 +0000923 /*
924 ** Break the OR clause into its separate subterms. The subterms are
925 ** stored in a WhereClause structure containing within the WhereOrInfo
926 ** object that is attached to the original OR clause term.
927 */
928 assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
929 assert( pExpr->op==TK_OR );
drh954701a2008-12-29 23:45:07 +0000930 pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
drh1a58fe02008-12-20 02:06:13 +0000931 if( pOrInfo==0 ) return;
932 pTerm->wtFlags |= TERM_ORINFO;
933 pOrWc = &pOrInfo->wc;
drh9ef61f42011-10-07 14:40:59 +0000934 whereClauseInit(pOrWc, pWC->pParse, pMaskSet, pWC->wctrlFlags);
drh1a58fe02008-12-20 02:06:13 +0000935 whereSplit(pOrWc, pExpr, TK_OR);
936 exprAnalyzeAll(pSrc, pOrWc);
937 if( db->mallocFailed ) return;
938 assert( pOrWc->nTerm>=2 );
939
940 /*
941 ** Compute the set of tables that might satisfy cases 1 or 2.
942 */
danielk1977e672c8e2009-05-22 15:43:26 +0000943 indexable = ~(Bitmask)0;
944 chngToIN = ~(pWC->vmask);
drh1a58fe02008-12-20 02:06:13 +0000945 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
946 if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
drh29435252008-12-28 18:35:08 +0000947 WhereAndInfo *pAndInfo;
948 assert( pOrTerm->eOperator==0 );
949 assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
drh1a58fe02008-12-20 02:06:13 +0000950 chngToIN = 0;
drh29435252008-12-28 18:35:08 +0000951 pAndInfo = sqlite3DbMallocRaw(db, sizeof(*pAndInfo));
952 if( pAndInfo ){
953 WhereClause *pAndWC;
954 WhereTerm *pAndTerm;
955 int j;
956 Bitmask b = 0;
957 pOrTerm->u.pAndInfo = pAndInfo;
958 pOrTerm->wtFlags |= TERM_ANDINFO;
959 pOrTerm->eOperator = WO_AND;
960 pAndWC = &pAndInfo->wc;
drh9ef61f42011-10-07 14:40:59 +0000961 whereClauseInit(pAndWC, pWC->pParse, pMaskSet, pWC->wctrlFlags);
drh29435252008-12-28 18:35:08 +0000962 whereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
963 exprAnalyzeAll(pSrc, pAndWC);
drh8871ef52011-10-07 13:33:10 +0000964 pAndWC->pOuter = pWC;
drh7c2fbde2009-01-07 20:58:57 +0000965 testcase( db->mallocFailed );
drh96c7a7d2009-01-10 15:34:12 +0000966 if( !db->mallocFailed ){
967 for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
968 assert( pAndTerm->pExpr );
969 if( allowedOp(pAndTerm->pExpr->op) ){
970 b |= getMask(pMaskSet, pAndTerm->leftCursor);
971 }
drh29435252008-12-28 18:35:08 +0000972 }
973 }
974 indexable &= b;
975 }
drh1a58fe02008-12-20 02:06:13 +0000976 }else if( pOrTerm->wtFlags & TERM_COPIED ){
977 /* Skip this term for now. We revisit it when we process the
978 ** corresponding TERM_VIRTUAL term */
979 }else{
980 Bitmask b;
981 b = getMask(pMaskSet, pOrTerm->leftCursor);
982 if( pOrTerm->wtFlags & TERM_VIRTUAL ){
983 WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
984 b |= getMask(pMaskSet, pOther->leftCursor);
985 }
986 indexable &= b;
987 if( pOrTerm->eOperator!=WO_EQ ){
988 chngToIN = 0;
989 }else{
990 chngToIN &= b;
991 }
992 }
drh3e355802007-02-23 23:13:33 +0000993 }
drh1a58fe02008-12-20 02:06:13 +0000994
995 /*
996 ** Record the set of tables that satisfy case 2. The set might be
drh111a6a72008-12-21 03:51:16 +0000997 ** empty.
drh1a58fe02008-12-20 02:06:13 +0000998 */
999 pOrInfo->indexable = indexable;
drh111a6a72008-12-21 03:51:16 +00001000 pTerm->eOperator = indexable==0 ? 0 : WO_OR;
drh1a58fe02008-12-20 02:06:13 +00001001
1002 /*
1003 ** chngToIN holds a set of tables that *might* satisfy case 1. But
1004 ** we have to do some additional checking to see if case 1 really
1005 ** is satisfied.
drh4e8be3b2009-06-08 17:11:08 +00001006 **
1007 ** chngToIN will hold either 0, 1, or 2 bits. The 0-bit case means
1008 ** that there is no possibility of transforming the OR clause into an
1009 ** IN operator because one or more terms in the OR clause contain
1010 ** something other than == on a column in the single table. The 1-bit
1011 ** case means that every term of the OR clause is of the form
1012 ** "table.column=expr" for some single table. The one bit that is set
1013 ** will correspond to the common table. We still need to check to make
1014 ** sure the same column is used on all terms. The 2-bit case is when
1015 ** the all terms are of the form "table1.column=table2.column". It
1016 ** might be possible to form an IN operator with either table1.column
1017 ** or table2.column as the LHS if either is common to every term of
1018 ** the OR clause.
1019 **
1020 ** Note that terms of the form "table.column1=table.column2" (the
1021 ** same table on both sizes of the ==) cannot be optimized.
drh1a58fe02008-12-20 02:06:13 +00001022 */
1023 if( chngToIN ){
1024 int okToChngToIN = 0; /* True if the conversion to IN is valid */
1025 int iColumn = -1; /* Column index on lhs of IN operator */
shane63207ab2009-02-04 01:49:30 +00001026 int iCursor = -1; /* Table cursor common to all terms */
drh1a58fe02008-12-20 02:06:13 +00001027 int j = 0; /* Loop counter */
1028
1029 /* Search for a table and column that appears on one side or the
1030 ** other of the == operator in every subterm. That table and column
1031 ** will be recorded in iCursor and iColumn. There might not be any
1032 ** such table and column. Set okToChngToIN if an appropriate table
1033 ** and column is found but leave okToChngToIN false if not found.
1034 */
1035 for(j=0; j<2 && !okToChngToIN; j++){
1036 pOrTerm = pOrWc->a;
1037 for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
1038 assert( pOrTerm->eOperator==WO_EQ );
1039 pOrTerm->wtFlags &= ~TERM_OR_OK;
drh4e8be3b2009-06-08 17:11:08 +00001040 if( pOrTerm->leftCursor==iCursor ){
1041 /* This is the 2-bit case and we are on the second iteration and
1042 ** current term is from the first iteration. So skip this term. */
1043 assert( j==1 );
1044 continue;
1045 }
1046 if( (chngToIN & getMask(pMaskSet, pOrTerm->leftCursor))==0 ){
1047 /* This term must be of the form t1.a==t2.b where t2 is in the
1048 ** chngToIN set but t1 is not. This term will be either preceeded
1049 ** or follwed by an inverted copy (t2.b==t1.a). Skip this term
1050 ** and use its inversion. */
1051 testcase( pOrTerm->wtFlags & TERM_COPIED );
1052 testcase( pOrTerm->wtFlags & TERM_VIRTUAL );
1053 assert( pOrTerm->wtFlags & (TERM_COPIED|TERM_VIRTUAL) );
1054 continue;
1055 }
drh1a58fe02008-12-20 02:06:13 +00001056 iColumn = pOrTerm->u.leftColumn;
1057 iCursor = pOrTerm->leftCursor;
1058 break;
1059 }
1060 if( i<0 ){
drh4e8be3b2009-06-08 17:11:08 +00001061 /* No candidate table+column was found. This can only occur
1062 ** on the second iteration */
drh1a58fe02008-12-20 02:06:13 +00001063 assert( j==1 );
1064 assert( (chngToIN&(chngToIN-1))==0 );
drh4e8be3b2009-06-08 17:11:08 +00001065 assert( chngToIN==getMask(pMaskSet, iCursor) );
drh1a58fe02008-12-20 02:06:13 +00001066 break;
1067 }
drh4e8be3b2009-06-08 17:11:08 +00001068 testcase( j==1 );
1069
1070 /* We have found a candidate table and column. Check to see if that
1071 ** table and column is common to every term in the OR clause */
drh1a58fe02008-12-20 02:06:13 +00001072 okToChngToIN = 1;
1073 for(; i>=0 && okToChngToIN; i--, pOrTerm++){
1074 assert( pOrTerm->eOperator==WO_EQ );
1075 if( pOrTerm->leftCursor!=iCursor ){
1076 pOrTerm->wtFlags &= ~TERM_OR_OK;
1077 }else if( pOrTerm->u.leftColumn!=iColumn ){
1078 okToChngToIN = 0;
1079 }else{
1080 int affLeft, affRight;
1081 /* If the right-hand side is also a column, then the affinities
1082 ** of both right and left sides must be such that no type
1083 ** conversions are required on the right. (Ticket #2249)
1084 */
1085 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
1086 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
1087 if( affRight!=0 && affRight!=affLeft ){
1088 okToChngToIN = 0;
1089 }else{
1090 pOrTerm->wtFlags |= TERM_OR_OK;
1091 }
1092 }
1093 }
1094 }
1095
1096 /* At this point, okToChngToIN is true if original pTerm satisfies
1097 ** case 1. In that case, construct a new virtual term that is
1098 ** pTerm converted into an IN operator.
drhe9cdcea2010-07-22 22:40:03 +00001099 **
1100 ** EV: R-00211-15100
drh1a58fe02008-12-20 02:06:13 +00001101 */
1102 if( okToChngToIN ){
1103 Expr *pDup; /* A transient duplicate expression */
1104 ExprList *pList = 0; /* The RHS of the IN operator */
1105 Expr *pLeft = 0; /* The LHS of the IN operator */
1106 Expr *pNew; /* The complete IN operator */
1107
1108 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
1109 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
1110 assert( pOrTerm->eOperator==WO_EQ );
1111 assert( pOrTerm->leftCursor==iCursor );
1112 assert( pOrTerm->u.leftColumn==iColumn );
danielk19776ab3a2e2009-02-19 14:39:25 +00001113 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight, 0);
drhb7916a72009-05-27 10:31:29 +00001114 pList = sqlite3ExprListAppend(pWC->pParse, pList, pDup);
drh1a58fe02008-12-20 02:06:13 +00001115 pLeft = pOrTerm->pExpr->pLeft;
1116 }
1117 assert( pLeft!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001118 pDup = sqlite3ExprDup(db, pLeft, 0);
drhb7916a72009-05-27 10:31:29 +00001119 pNew = sqlite3PExpr(pParse, TK_IN, pDup, 0, 0);
drh1a58fe02008-12-20 02:06:13 +00001120 if( pNew ){
1121 int idxNew;
1122 transferJoinMarkings(pNew, pExpr);
danielk19776ab3a2e2009-02-19 14:39:25 +00001123 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
1124 pNew->x.pList = pList;
drh1a58fe02008-12-20 02:06:13 +00001125 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
1126 testcase( idxNew==0 );
1127 exprAnalyze(pSrc, pWC, idxNew);
1128 pTerm = &pWC->a[idxTerm];
1129 pWC->a[idxNew].iParent = idxTerm;
1130 pTerm->nChild = 1;
1131 }else{
1132 sqlite3ExprListDelete(db, pList);
1133 }
drh534230c2011-01-22 00:10:45 +00001134 pTerm->eOperator = WO_NOOP; /* case 1 trumps case 2 */
drh1a58fe02008-12-20 02:06:13 +00001135 }
drh3e355802007-02-23 23:13:33 +00001136 }
drh3e355802007-02-23 23:13:33 +00001137}
1138#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +00001139
drh1a58fe02008-12-20 02:06:13 +00001140
drh54a167d2005-11-26 14:08:07 +00001141/*
drh0aa74ed2005-07-16 13:33:20 +00001142** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +00001143** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +00001144** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +00001145** structure.
drh51147ba2005-07-23 22:59:55 +00001146**
1147** If the expression is of the form "<expr> <op> X" it gets commuted
drh1a58fe02008-12-20 02:06:13 +00001148** to the standard form of "X <op> <expr>".
1149**
1150** If the expression is of the form "X <op> Y" where both X and Y are
1151** columns, then the original expression is unchanged and a new virtual
1152** term of the form "Y <op> X" is added to the WHERE clause and
1153** analyzed separately. The original term is marked with TERM_COPIED
1154** and the new term is marked with TERM_DYNAMIC (because it's pExpr
1155** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
1156** is a commuted copy of a prior term.) The original term has nChild=1
1157** and the copy has idxParent set to the index of the original term.
drh75897232000-05-29 14:26:00 +00001158*/
drh0fcef5e2005-07-19 17:38:22 +00001159static void exprAnalyze(
1160 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +00001161 WhereClause *pWC, /* the WHERE clause */
1162 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +00001163){
drh1a58fe02008-12-20 02:06:13 +00001164 WhereTerm *pTerm; /* The term to be analyzed */
drh111a6a72008-12-21 03:51:16 +00001165 WhereMaskSet *pMaskSet; /* Set of table index masks */
drh1a58fe02008-12-20 02:06:13 +00001166 Expr *pExpr; /* The expression to be analyzed */
1167 Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
1168 Bitmask prereqAll; /* Prerequesites of pExpr */
drh5e767c52010-02-25 04:15:47 +00001169 Bitmask extraRight = 0; /* Extra dependencies on LEFT JOIN */
drh1d452e12009-11-01 19:26:59 +00001170 Expr *pStr1 = 0; /* RHS of LIKE/GLOB operator */
1171 int isComplete = 0; /* RHS of LIKE/GLOB ends with wildcard */
1172 int noCase = 0; /* LIKE/GLOB distinguishes case */
drh1a58fe02008-12-20 02:06:13 +00001173 int op; /* Top-level operator. pExpr->op */
1174 Parse *pParse = pWC->pParse; /* Parsing context */
1175 sqlite3 *db = pParse->db; /* Database connection */
drh0fcef5e2005-07-19 17:38:22 +00001176
drhf998b732007-11-26 13:36:00 +00001177 if( db->mallocFailed ){
1178 return;
1179 }
1180 pTerm = &pWC->a[idxTerm];
1181 pMaskSet = pWC->pMaskSet;
1182 pExpr = pTerm->pExpr;
drh0fcef5e2005-07-19 17:38:22 +00001183 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +00001184 op = pExpr->op;
1185 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +00001186 assert( pExpr->pRight==0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001187 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1188 pTerm->prereqRight = exprSelectTableUsage(pMaskSet, pExpr->x.pSelect);
1189 }else{
1190 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->x.pList);
1191 }
drh50b39962006-10-28 00:28:09 +00001192 }else if( op==TK_ISNULL ){
1193 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +00001194 }else{
1195 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
1196 }
drh22d6a532005-09-19 21:05:48 +00001197 prereqAll = exprTableUsage(pMaskSet, pExpr);
1198 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +00001199 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
1200 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +00001201 extraRight = x-1; /* ON clause terms may not be used with an index
1202 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +00001203 }
1204 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +00001205 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +00001206 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +00001207 pTerm->eOperator = 0;
drh50b39962006-10-28 00:28:09 +00001208 if( allowedOp(op) && (pTerm->prereqRight & prereqLeft)==0 ){
drh0fcef5e2005-07-19 17:38:22 +00001209 Expr *pLeft = pExpr->pLeft;
1210 Expr *pRight = pExpr->pRight;
1211 if( pLeft->op==TK_COLUMN ){
1212 pTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001213 pTerm->u.leftColumn = pLeft->iColumn;
drh50b39962006-10-28 00:28:09 +00001214 pTerm->eOperator = operatorMask(op);
drh75897232000-05-29 14:26:00 +00001215 }
drh0fcef5e2005-07-19 17:38:22 +00001216 if( pRight && pRight->op==TK_COLUMN ){
1217 WhereTerm *pNew;
1218 Expr *pDup;
1219 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +00001220 int idxNew;
danielk19776ab3a2e2009-02-19 14:39:25 +00001221 pDup = sqlite3ExprDup(db, pExpr, 0);
drh17435752007-08-16 04:30:38 +00001222 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +00001223 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +00001224 return;
1225 }
drh9eb20282005-08-24 03:52:18 +00001226 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
1227 if( idxNew==0 ) return;
1228 pNew = &pWC->a[idxNew];
1229 pNew->iParent = idxTerm;
1230 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +00001231 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001232 pTerm->wtFlags |= TERM_COPIED;
drh0fcef5e2005-07-19 17:38:22 +00001233 }else{
1234 pDup = pExpr;
1235 pNew = pTerm;
1236 }
drh7d10d5a2008-08-20 16:35:10 +00001237 exprCommute(pParse, pDup);
drh0fcef5e2005-07-19 17:38:22 +00001238 pLeft = pDup->pLeft;
1239 pNew->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001240 pNew->u.leftColumn = pLeft->iColumn;
drh5e767c52010-02-25 04:15:47 +00001241 testcase( (prereqLeft | extraRight) != prereqLeft );
1242 pNew->prereqRight = prereqLeft | extraRight;
drh0fcef5e2005-07-19 17:38:22 +00001243 pNew->prereqAll = prereqAll;
drhb52076c2006-01-23 13:22:09 +00001244 pNew->eOperator = operatorMask(pDup->op);
drh75897232000-05-29 14:26:00 +00001245 }
1246 }
drhed378002005-07-28 23:12:08 +00001247
drhd2687b72005-08-12 22:56:09 +00001248#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +00001249 /* If a term is the BETWEEN operator, create two new virtual terms
drh1a58fe02008-12-20 02:06:13 +00001250 ** that define the range that the BETWEEN implements. For example:
1251 **
1252 ** a BETWEEN b AND c
1253 **
1254 ** is converted into:
1255 **
1256 ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
1257 **
1258 ** The two new terms are added onto the end of the WhereClause object.
1259 ** The new terms are "dynamic" and are children of the original BETWEEN
1260 ** term. That means that if the BETWEEN term is coded, the children are
1261 ** skipped. Or, if the children are satisfied by an index, the original
1262 ** BETWEEN term is skipped.
drhed378002005-07-28 23:12:08 +00001263 */
drh29435252008-12-28 18:35:08 +00001264 else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001265 ExprList *pList = pExpr->x.pList;
drhed378002005-07-28 23:12:08 +00001266 int i;
1267 static const u8 ops[] = {TK_GE, TK_LE};
1268 assert( pList!=0 );
1269 assert( pList->nExpr==2 );
1270 for(i=0; i<2; i++){
1271 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +00001272 int idxNew;
drhb7916a72009-05-27 10:31:29 +00001273 pNewExpr = sqlite3PExpr(pParse, ops[i],
1274 sqlite3ExprDup(db, pExpr->pLeft, 0),
danielk19776ab3a2e2009-02-19 14:39:25 +00001275 sqlite3ExprDup(db, pList->a[i].pExpr, 0), 0);
drh9eb20282005-08-24 03:52:18 +00001276 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001277 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001278 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +00001279 pTerm = &pWC->a[idxTerm];
1280 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +00001281 }
drh45b1ee42005-08-02 17:48:22 +00001282 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +00001283 }
drhd2687b72005-08-12 22:56:09 +00001284#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +00001285
danielk19771576cd92006-01-14 08:02:28 +00001286#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh1a58fe02008-12-20 02:06:13 +00001287 /* Analyze a term that is composed of two or more subterms connected by
1288 ** an OR operator.
drh6c30be82005-07-29 15:10:17 +00001289 */
1290 else if( pExpr->op==TK_OR ){
drh29435252008-12-28 18:35:08 +00001291 assert( pWC->op==TK_AND );
drh1a58fe02008-12-20 02:06:13 +00001292 exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
danielk1977f51d1bd2009-07-31 06:14:51 +00001293 pTerm = &pWC->a[idxTerm];
drh6c30be82005-07-29 15:10:17 +00001294 }
drhd2687b72005-08-12 22:56:09 +00001295#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1296
1297#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
1298 /* Add constraints to reduce the search space on a LIKE or GLOB
1299 ** operator.
drh9f504ea2008-02-23 21:55:39 +00001300 **
1301 ** A like pattern of the form "x LIKE 'abc%'" is changed into constraints
1302 **
1303 ** x>='abc' AND x<'abd' AND x LIKE 'abc%'
1304 **
1305 ** The last character of the prefix "abc" is incremented to form the
shane7bc71e52008-05-28 18:01:44 +00001306 ** termination condition "abd".
drhd2687b72005-08-12 22:56:09 +00001307 */
dan937d0de2009-10-15 18:35:38 +00001308 if( pWC->op==TK_AND
1309 && isLikeOrGlob(pParse, pExpr, &pStr1, &isComplete, &noCase)
1310 ){
drh1d452e12009-11-01 19:26:59 +00001311 Expr *pLeft; /* LHS of LIKE/GLOB operator */
1312 Expr *pStr2; /* Copy of pStr1 - RHS of LIKE/GLOB operator */
1313 Expr *pNewExpr1;
1314 Expr *pNewExpr2;
1315 int idxNew1;
1316 int idxNew2;
drh8342e492010-07-22 17:49:52 +00001317 CollSeq *pColl; /* Collating sequence to use */
drh9eb20282005-08-24 03:52:18 +00001318
danielk19776ab3a2e2009-02-19 14:39:25 +00001319 pLeft = pExpr->x.pList->a[1].pExpr;
danielk19776ab3a2e2009-02-19 14:39:25 +00001320 pStr2 = sqlite3ExprDup(db, pStr1, 0);
drhf998b732007-11-26 13:36:00 +00001321 if( !db->mallocFailed ){
drh254993e2009-06-08 19:44:36 +00001322 u8 c, *pC; /* Last character before the first wildcard */
dan937d0de2009-10-15 18:35:38 +00001323 pC = (u8*)&pStr2->u.zToken[sqlite3Strlen30(pStr2->u.zToken)-1];
drh9f504ea2008-02-23 21:55:39 +00001324 c = *pC;
drh02a50b72008-05-26 18:33:40 +00001325 if( noCase ){
drh254993e2009-06-08 19:44:36 +00001326 /* The point is to increment the last character before the first
1327 ** wildcard. But if we increment '@', that will push it into the
1328 ** alphabetic range where case conversions will mess up the
1329 ** inequality. To avoid this, make sure to also run the full
1330 ** LIKE on all candidate expressions by clearing the isComplete flag
1331 */
drhe9cdcea2010-07-22 22:40:03 +00001332 if( c=='A'-1 ) isComplete = 0; /* EV: R-64339-08207 */
1333
drh254993e2009-06-08 19:44:36 +00001334
drh02a50b72008-05-26 18:33:40 +00001335 c = sqlite3UpperToLower[c];
1336 }
drh9f504ea2008-02-23 21:55:39 +00001337 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +00001338 }
drh8342e492010-07-22 17:49:52 +00001339 pColl = sqlite3FindCollSeq(db, SQLITE_UTF8, noCase ? "NOCASE" : "BINARY",0);
1340 pNewExpr1 = sqlite3PExpr(pParse, TK_GE,
1341 sqlite3ExprSetColl(sqlite3ExprDup(db,pLeft,0), pColl),
1342 pStr1, 0);
drh9eb20282005-08-24 03:52:18 +00001343 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001344 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001345 exprAnalyze(pSrc, pWC, idxNew1);
drh8342e492010-07-22 17:49:52 +00001346 pNewExpr2 = sqlite3PExpr(pParse, TK_LT,
1347 sqlite3ExprSetColl(sqlite3ExprDup(db,pLeft,0), pColl),
1348 pStr2, 0);
drh9eb20282005-08-24 03:52:18 +00001349 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001350 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001351 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +00001352 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +00001353 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +00001354 pWC->a[idxNew1].iParent = idxTerm;
1355 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +00001356 pTerm->nChild = 2;
1357 }
1358 }
1359#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +00001360
1361#ifndef SQLITE_OMIT_VIRTUALTABLE
1362 /* Add a WO_MATCH auxiliary term to the constraint set if the
1363 ** current expression is of the form: column MATCH expr.
1364 ** This information is used by the xBestIndex methods of
1365 ** virtual tables. The native query optimizer does not attempt
1366 ** to do anything with MATCH functions.
1367 */
1368 if( isMatchOfColumn(pExpr) ){
1369 int idxNew;
1370 Expr *pRight, *pLeft;
1371 WhereTerm *pNewTerm;
1372 Bitmask prereqColumn, prereqExpr;
1373
danielk19776ab3a2e2009-02-19 14:39:25 +00001374 pRight = pExpr->x.pList->a[0].pExpr;
1375 pLeft = pExpr->x.pList->a[1].pExpr;
drh7f375902006-06-13 17:38:59 +00001376 prereqExpr = exprTableUsage(pMaskSet, pRight);
1377 prereqColumn = exprTableUsage(pMaskSet, pLeft);
1378 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +00001379 Expr *pNewExpr;
drhb7916a72009-05-27 10:31:29 +00001380 pNewExpr = sqlite3PExpr(pParse, TK_MATCH,
1381 0, sqlite3ExprDup(db, pRight, 0), 0);
drh1a90e092006-06-14 22:07:10 +00001382 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001383 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001384 pNewTerm = &pWC->a[idxNew];
1385 pNewTerm->prereqRight = prereqExpr;
1386 pNewTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001387 pNewTerm->u.leftColumn = pLeft->iColumn;
drh7f375902006-06-13 17:38:59 +00001388 pNewTerm->eOperator = WO_MATCH;
1389 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +00001390 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +00001391 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001392 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001393 pNewTerm->prereqAll = pTerm->prereqAll;
1394 }
1395 }
1396#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001397
drhfaacf172011-08-12 01:51:45 +00001398#ifdef SQLITE_ENABLE_STAT3
drhd3ed7342011-09-21 00:09:41 +00001399 /* When sqlite_stat3 histogram data is available an operator of the
drh534230c2011-01-22 00:10:45 +00001400 ** form "x IS NOT NULL" can sometimes be evaluated more efficiently
1401 ** as "x>NULL" if x is not an INTEGER PRIMARY KEY. So construct a
1402 ** virtual term of that form.
1403 **
1404 ** Note that the virtual term must be tagged with TERM_VNULL. This
1405 ** TERM_VNULL tag will suppress the not-null check at the beginning
1406 ** of the loop. Without the TERM_VNULL flag, the not-null check at
1407 ** the start of the loop will prevent any results from being returned.
1408 */
drhea6dc442011-04-08 21:35:26 +00001409 if( pExpr->op==TK_NOTNULL
1410 && pExpr->pLeft->op==TK_COLUMN
1411 && pExpr->pLeft->iColumn>=0
1412 ){
drh534230c2011-01-22 00:10:45 +00001413 Expr *pNewExpr;
1414 Expr *pLeft = pExpr->pLeft;
1415 int idxNew;
1416 WhereTerm *pNewTerm;
1417
1418 pNewExpr = sqlite3PExpr(pParse, TK_GT,
1419 sqlite3ExprDup(db, pLeft, 0),
1420 sqlite3PExpr(pParse, TK_NULL, 0, 0, 0), 0);
1421
1422 idxNew = whereClauseInsert(pWC, pNewExpr,
1423 TERM_VIRTUAL|TERM_DYNAMIC|TERM_VNULL);
drhda91e712011-02-11 06:59:02 +00001424 if( idxNew ){
1425 pNewTerm = &pWC->a[idxNew];
1426 pNewTerm->prereqRight = 0;
1427 pNewTerm->leftCursor = pLeft->iTable;
1428 pNewTerm->u.leftColumn = pLeft->iColumn;
1429 pNewTerm->eOperator = WO_GT;
1430 pNewTerm->iParent = idxTerm;
1431 pTerm = &pWC->a[idxTerm];
1432 pTerm->nChild = 1;
1433 pTerm->wtFlags |= TERM_COPIED;
1434 pNewTerm->prereqAll = pTerm->prereqAll;
1435 }
drh534230c2011-01-22 00:10:45 +00001436 }
drhfaacf172011-08-12 01:51:45 +00001437#endif /* SQLITE_ENABLE_STAT */
drh534230c2011-01-22 00:10:45 +00001438
drhdafc0ce2008-04-17 19:14:02 +00001439 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1440 ** an index for tables to the left of the join.
1441 */
1442 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001443}
1444
drh7b4fc6a2007-02-06 13:26:32 +00001445/*
dan6f343962011-07-01 18:26:40 +00001446** This function searches the expression list passed as the second argument
1447** for an expression of type TK_COLUMN that refers to the same column and
1448** uses the same collation sequence as the iCol'th column of index pIdx.
1449** Argument iBase is the cursor number used for the table that pIdx refers
1450** to.
1451**
1452** If such an expression is found, its index in pList->a[] is returned. If
1453** no expression is found, -1 is returned.
1454*/
1455static int findIndexCol(
1456 Parse *pParse, /* Parse context */
1457 ExprList *pList, /* Expression list to search */
1458 int iBase, /* Cursor for table associated with pIdx */
1459 Index *pIdx, /* Index to match column of */
1460 int iCol /* Column of index to match */
1461){
1462 int i;
1463 const char *zColl = pIdx->azColl[iCol];
1464
1465 for(i=0; i<pList->nExpr; i++){
1466 Expr *p = pList->a[i].pExpr;
drhf1d3e322011-07-09 13:00:41 +00001467 if( p->op==TK_COLUMN
1468 && p->iColumn==pIdx->aiColumn[iCol]
1469 && p->iTable==iBase
1470 ){
dan6f343962011-07-01 18:26:40 +00001471 CollSeq *pColl = sqlite3ExprCollSeq(pParse, p);
drhf1d3e322011-07-09 13:00:41 +00001472 if( ALWAYS(pColl) && 0==sqlite3StrICmp(pColl->zName, zColl) ){
dan6f343962011-07-01 18:26:40 +00001473 return i;
1474 }
1475 }
1476 }
1477
1478 return -1;
1479}
1480
1481/*
1482** This routine determines if pIdx can be used to assist in processing a
1483** DISTINCT qualifier. In other words, it tests whether or not using this
1484** index for the outer loop guarantees that rows with equal values for
1485** all expressions in the pDistinct list are delivered grouped together.
1486**
1487** For example, the query
1488**
1489** SELECT DISTINCT a, b, c FROM tbl WHERE a = ?
1490**
1491** can benefit from any index on columns "b" and "c".
1492*/
1493static int isDistinctIndex(
1494 Parse *pParse, /* Parsing context */
1495 WhereClause *pWC, /* The WHERE clause */
1496 Index *pIdx, /* The index being considered */
1497 int base, /* Cursor number for the table pIdx is on */
1498 ExprList *pDistinct, /* The DISTINCT expressions */
1499 int nEqCol /* Number of index columns with == */
1500){
1501 Bitmask mask = 0; /* Mask of unaccounted for pDistinct exprs */
1502 int i; /* Iterator variable */
1503
drh04b85bc2012-10-01 17:44:05 +00001504 assert( pDistinct!=0 );
1505 if( pIdx->zName==0 || pDistinct->nExpr>=BMS ) return 0;
drhb24d83f2011-07-02 19:12:05 +00001506 testcase( pDistinct->nExpr==BMS-1 );
dan6f343962011-07-01 18:26:40 +00001507
1508 /* Loop through all the expressions in the distinct list. If any of them
1509 ** are not simple column references, return early. Otherwise, test if the
1510 ** WHERE clause contains a "col=X" clause. If it does, the expression
1511 ** can be ignored. If it does not, and the column does not belong to the
1512 ** same table as index pIdx, return early. Finally, if there is no
1513 ** matching "col=X" expression and the column is on the same table as pIdx,
1514 ** set the corresponding bit in variable mask.
1515 */
1516 for(i=0; i<pDistinct->nExpr; i++){
1517 WhereTerm *pTerm;
1518 Expr *p = pDistinct->a[i].pExpr;
1519 if( p->op!=TK_COLUMN ) return 0;
1520 pTerm = findTerm(pWC, p->iTable, p->iColumn, ~(Bitmask)0, WO_EQ, 0);
1521 if( pTerm ){
1522 Expr *pX = pTerm->pExpr;
1523 CollSeq *p1 = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
1524 CollSeq *p2 = sqlite3ExprCollSeq(pParse, p);
1525 if( p1==p2 ) continue;
1526 }
1527 if( p->iTable!=base ) return 0;
1528 mask |= (((Bitmask)1) << i);
1529 }
1530
1531 for(i=nEqCol; mask && i<pIdx->nColumn; i++){
1532 int iExpr = findIndexCol(pParse, pDistinct, base, pIdx, i);
1533 if( iExpr<0 ) break;
1534 mask &= ~(((Bitmask)1) << iExpr);
1535 }
1536
1537 return (mask==0);
1538}
1539
1540
1541/*
1542** Return true if the DISTINCT expression-list passed as the third argument
1543** is redundant. A DISTINCT list is redundant if the database contains a
1544** UNIQUE index that guarantees that the result of the query will be distinct
1545** anyway.
1546*/
1547static int isDistinctRedundant(
1548 Parse *pParse,
1549 SrcList *pTabList,
1550 WhereClause *pWC,
1551 ExprList *pDistinct
1552){
1553 Table *pTab;
1554 Index *pIdx;
1555 int i;
1556 int iBase;
1557
1558 /* If there is more than one table or sub-select in the FROM clause of
1559 ** this query, then it will not be possible to show that the DISTINCT
1560 ** clause is redundant. */
1561 if( pTabList->nSrc!=1 ) return 0;
1562 iBase = pTabList->a[0].iCursor;
1563 pTab = pTabList->a[0].pTab;
1564
dan94e08d92011-07-02 06:44:05 +00001565 /* If any of the expressions is an IPK column on table iBase, then return
1566 ** true. Note: The (p->iTable==iBase) part of this test may be false if the
1567 ** current SELECT is a correlated sub-query.
1568 */
dan6f343962011-07-01 18:26:40 +00001569 for(i=0; i<pDistinct->nExpr; i++){
1570 Expr *p = pDistinct->a[i].pExpr;
dan94e08d92011-07-02 06:44:05 +00001571 if( p->op==TK_COLUMN && p->iTable==iBase && p->iColumn<0 ) return 1;
dan6f343962011-07-01 18:26:40 +00001572 }
1573
1574 /* Loop through all indices on the table, checking each to see if it makes
1575 ** the DISTINCT qualifier redundant. It does so if:
1576 **
1577 ** 1. The index is itself UNIQUE, and
1578 **
1579 ** 2. All of the columns in the index are either part of the pDistinct
1580 ** list, or else the WHERE clause contains a term of the form "col=X",
1581 ** where X is a constant value. The collation sequences of the
1582 ** comparison and select-list expressions must match those of the index.
dan6a36f432012-04-20 16:59:24 +00001583 **
1584 ** 3. All of those index columns for which the WHERE clause does not
1585 ** contain a "col=X" term are subject to a NOT NULL constraint.
dan6f343962011-07-01 18:26:40 +00001586 */
1587 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1588 if( pIdx->onError==OE_None ) continue;
1589 for(i=0; i<pIdx->nColumn; i++){
1590 int iCol = pIdx->aiColumn[i];
dan6a36f432012-04-20 16:59:24 +00001591 if( 0==findTerm(pWC, iBase, iCol, ~(Bitmask)0, WO_EQ, pIdx) ){
1592 int iIdxCol = findIndexCol(pParse, pDistinct, iBase, pIdx, i);
1593 if( iIdxCol<0 || pTab->aCol[pIdx->aiColumn[i]].notNull==0 ){
1594 break;
1595 }
dan6f343962011-07-01 18:26:40 +00001596 }
1597 }
1598 if( i==pIdx->nColumn ){
1599 /* This index implies that the DISTINCT qualifier is redundant. */
1600 return 1;
1601 }
1602 }
1603
1604 return 0;
1605}
drh0fcef5e2005-07-19 17:38:22 +00001606
drh75897232000-05-29 14:26:00 +00001607/*
drhb6fb62d2005-09-20 08:47:20 +00001608** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +00001609** The results need not be exact. This is only used for estimating
drh909626d2008-05-30 14:58:37 +00001610** the total cost of performing operations with O(logN) or O(NlogN)
drh28c4cf42005-07-27 20:41:43 +00001611** complexity. Because N is just a guess, it is no great tragedy if
1612** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +00001613*/
1614static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +00001615 double logN = 1;
1616 double x = 10;
drh28c4cf42005-07-27 20:41:43 +00001617 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +00001618 logN += 1;
drh28c4cf42005-07-27 20:41:43 +00001619 x *= 10;
1620 }
1621 return logN;
1622}
1623
drh6d209d82006-06-27 01:54:26 +00001624/*
1625** Two routines for printing the content of an sqlite3_index_info
1626** structure. Used for testing and debugging only. If neither
1627** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1628** are no-ops.
1629*/
drh77a2a5e2007-04-06 01:04:39 +00001630#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_DEBUG)
drh6d209d82006-06-27 01:54:26 +00001631static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1632 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001633 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001634 for(i=0; i<p->nConstraint; i++){
1635 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1636 i,
1637 p->aConstraint[i].iColumn,
1638 p->aConstraint[i].iTermOffset,
1639 p->aConstraint[i].op,
1640 p->aConstraint[i].usable);
1641 }
1642 for(i=0; i<p->nOrderBy; i++){
1643 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1644 i,
1645 p->aOrderBy[i].iColumn,
1646 p->aOrderBy[i].desc);
1647 }
1648}
1649static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1650 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001651 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001652 for(i=0; i<p->nConstraint; i++){
1653 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1654 i,
1655 p->aConstraintUsage[i].argvIndex,
1656 p->aConstraintUsage[i].omit);
1657 }
1658 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1659 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1660 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1661 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
1662}
1663#else
1664#define TRACE_IDX_INPUTS(A)
1665#define TRACE_IDX_OUTPUTS(A)
1666#endif
1667
danielk19771d461462009-04-21 09:02:45 +00001668/*
1669** Required because bestIndex() is called by bestOrClauseIndex()
1670*/
drh56f1b992012-09-25 14:29:39 +00001671static void bestIndex(WhereBestIdx*);
danielk19771d461462009-04-21 09:02:45 +00001672
1673/*
1674** This routine attempts to find an scanning strategy that can be used
1675** to optimize an 'OR' expression that is part of a WHERE clause.
1676**
1677** The table associated with FROM clause term pSrc may be either a
1678** regular B-Tree table or a virtual table.
1679*/
drh56f1b992012-09-25 14:29:39 +00001680static void bestOrClauseIndex(WhereBestIdx *p){
danielk19771d461462009-04-21 09:02:45 +00001681#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drh56f1b992012-09-25 14:29:39 +00001682 WhereClause *pWC = p->pWC; /* The WHERE clause */
1683 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
1684 const int iCur = pSrc->iCursor; /* The cursor of the table */
danielk19771d461462009-04-21 09:02:45 +00001685 const Bitmask maskSrc = getMask(pWC->pMaskSet, iCur); /* Bitmask for pSrc */
1686 WhereTerm * const pWCEnd = &pWC->a[pWC->nTerm]; /* End of pWC->a[] */
drh56f1b992012-09-25 14:29:39 +00001687 WhereTerm *pTerm; /* A single term of the WHERE clause */
danielk19771d461462009-04-21 09:02:45 +00001688
drh9ef61f42011-10-07 14:40:59 +00001689 /* The OR-clause optimization is disallowed if the INDEXED BY or
1690 ** NOT INDEXED clauses are used or if the WHERE_AND_ONLY bit is set. */
drh75ad2602010-10-21 02:05:06 +00001691 if( pSrc->notIndexed || pSrc->pIndex!=0 ){
drhed754ce2010-04-15 01:04:54 +00001692 return;
1693 }
drh9ef61f42011-10-07 14:40:59 +00001694 if( pWC->wctrlFlags & WHERE_AND_ONLY ){
1695 return;
1696 }
drhed754ce2010-04-15 01:04:54 +00001697
danielk19771d461462009-04-21 09:02:45 +00001698 /* Search the WHERE clause terms for a usable WO_OR term. */
1699 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
1700 if( pTerm->eOperator==WO_OR
drh56f1b992012-09-25 14:29:39 +00001701 && ((pTerm->prereqAll & ~maskSrc) & p->notReady)==0
danielk19771d461462009-04-21 09:02:45 +00001702 && (pTerm->u.pOrInfo->indexable & maskSrc)!=0
1703 ){
1704 WhereClause * const pOrWC = &pTerm->u.pOrInfo->wc;
1705 WhereTerm * const pOrWCEnd = &pOrWC->a[pOrWC->nTerm];
1706 WhereTerm *pOrTerm;
1707 int flags = WHERE_MULTI_OR;
1708 double rTotal = 0;
1709 double nRow = 0;
dan5236ac12009-08-13 07:09:33 +00001710 Bitmask used = 0;
drh56f1b992012-09-25 14:29:39 +00001711 WhereBestIdx sBOI;
danielk19771d461462009-04-21 09:02:45 +00001712
drh56f1b992012-09-25 14:29:39 +00001713 sBOI = *p;
1714 sBOI.pOrderBy = 0;
1715 sBOI.pDistinct = 0;
1716 sBOI.ppIdxInfo = 0;
danielk19771d461462009-04-21 09:02:45 +00001717 for(pOrTerm=pOrWC->a; pOrTerm<pOrWCEnd; pOrTerm++){
danielk19771d461462009-04-21 09:02:45 +00001718 WHERETRACE(("... Multi-index OR testing for term %d of %d....\n",
1719 (pOrTerm - pOrWC->a), (pTerm - pWC->a)
1720 ));
1721 if( pOrTerm->eOperator==WO_AND ){
drh56f1b992012-09-25 14:29:39 +00001722 sBOI.pWC = &pOrTerm->u.pAndInfo->wc;
1723 bestIndex(&sBOI);
danielk19771d461462009-04-21 09:02:45 +00001724 }else if( pOrTerm->leftCursor==iCur ){
1725 WhereClause tempWC;
1726 tempWC.pParse = pWC->pParse;
1727 tempWC.pMaskSet = pWC->pMaskSet;
drh8871ef52011-10-07 13:33:10 +00001728 tempWC.pOuter = pWC;
danielk19771d461462009-04-21 09:02:45 +00001729 tempWC.op = TK_AND;
1730 tempWC.a = pOrTerm;
drha2153f72011-10-18 19:14:33 +00001731 tempWC.wctrlFlags = 0;
danielk19771d461462009-04-21 09:02:45 +00001732 tempWC.nTerm = 1;
drh56f1b992012-09-25 14:29:39 +00001733 sBOI.pWC = &tempWC;
1734 bestIndex(&sBOI);
danielk19771d461462009-04-21 09:02:45 +00001735 }else{
1736 continue;
1737 }
drh56f1b992012-09-25 14:29:39 +00001738 rTotal += sBOI.cost.rCost;
1739 nRow += sBOI.cost.plan.nRow;
1740 used |= sBOI.cost.used;
1741 if( rTotal>=p->cost.rCost ) break;
danielk19771d461462009-04-21 09:02:45 +00001742 }
1743
1744 /* If there is an ORDER BY clause, increase the scan cost to account
1745 ** for the cost of the sort. */
drh56f1b992012-09-25 14:29:39 +00001746 if( p->pOrderBy!=0 ){
drhed754ce2010-04-15 01:04:54 +00001747 WHERETRACE(("... sorting increases OR cost %.9g to %.9g\n",
1748 rTotal, rTotal+nRow*estLog(nRow)));
danielk19771d461462009-04-21 09:02:45 +00001749 rTotal += nRow*estLog(nRow);
danielk19771d461462009-04-21 09:02:45 +00001750 }
1751
1752 /* If the cost of scanning using this OR term for optimization is
1753 ** less than the current cost stored in pCost, replace the contents
1754 ** of pCost. */
1755 WHERETRACE(("... multi-index OR cost=%.9g nrow=%.9g\n", rTotal, nRow));
drh56f1b992012-09-25 14:29:39 +00001756 if( rTotal<p->cost.rCost ){
1757 p->cost.rCost = rTotal;
1758 p->cost.used = used;
1759 p->cost.plan.nRow = nRow;
drhd663b5b2012-10-03 00:25:54 +00001760 p->cost.plan.nOBSat = p->i ? p->aLevel[p->i-1].plan.nOBSat : 0;
drh56f1b992012-09-25 14:29:39 +00001761 p->cost.plan.wsFlags = flags;
1762 p->cost.plan.u.pTerm = pTerm;
danielk19771d461462009-04-21 09:02:45 +00001763 }
1764 }
1765 }
1766#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1767}
1768
drhc6339082010-04-07 16:54:58 +00001769#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00001770/*
drh4139c992010-04-07 14:59:45 +00001771** Return TRUE if the WHERE clause term pTerm is of a form where it
1772** could be used with an index to access pSrc, assuming an appropriate
1773** index existed.
1774*/
1775static int termCanDriveIndex(
1776 WhereTerm *pTerm, /* WHERE clause term to check */
1777 struct SrcList_item *pSrc, /* Table we are trying to access */
1778 Bitmask notReady /* Tables in outer loops of the join */
1779){
1780 char aff;
1781 if( pTerm->leftCursor!=pSrc->iCursor ) return 0;
1782 if( pTerm->eOperator!=WO_EQ ) return 0;
1783 if( (pTerm->prereqRight & notReady)!=0 ) return 0;
1784 aff = pSrc->pTab->aCol[pTerm->u.leftColumn].affinity;
1785 if( !sqlite3IndexAffinityOk(pTerm->pExpr, aff) ) return 0;
1786 return 1;
1787}
drhc6339082010-04-07 16:54:58 +00001788#endif
drh4139c992010-04-07 14:59:45 +00001789
drhc6339082010-04-07 16:54:58 +00001790#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh4139c992010-04-07 14:59:45 +00001791/*
drh8b307fb2010-04-06 15:57:05 +00001792** If the query plan for pSrc specified in pCost is a full table scan
drh4139c992010-04-07 14:59:45 +00001793** and indexing is allows (if there is no NOT INDEXED clause) and it
drh8b307fb2010-04-06 15:57:05 +00001794** possible to construct a transient index that would perform better
1795** than a full table scan even when the cost of constructing the index
1796** is taken into account, then alter the query plan to use the
1797** transient index.
1798*/
drh56f1b992012-09-25 14:29:39 +00001799static void bestAutomaticIndex(WhereBestIdx *p){
1800 Parse *pParse = p->pParse; /* The parsing context */
1801 WhereClause *pWC = p->pWC; /* The WHERE clause */
1802 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
1803 double nTableRow; /* Rows in the input table */
1804 double logN; /* log(nTableRow) */
drh8b307fb2010-04-06 15:57:05 +00001805 double costTempIdx; /* per-query cost of the transient index */
1806 WhereTerm *pTerm; /* A single term of the WHERE clause */
1807 WhereTerm *pWCEnd; /* End of pWC->a[] */
drh424aab82010-04-06 18:28:20 +00001808 Table *pTable; /* Table tht might be indexed */
drh8b307fb2010-04-06 15:57:05 +00001809
dan969e5592011-07-02 15:32:57 +00001810 if( pParse->nQueryLoop<=(double)1 ){
1811 /* There is no point in building an automatic index for a single scan */
1812 return;
1813 }
drhc6339082010-04-07 16:54:58 +00001814 if( (pParse->db->flags & SQLITE_AutoIndex)==0 ){
1815 /* Automatic indices are disabled at run-time */
1816 return;
1817 }
drh56f1b992012-09-25 14:29:39 +00001818 if( (p->cost.plan.wsFlags & WHERE_NOT_FULLSCAN)!=0 ){
drh8b307fb2010-04-06 15:57:05 +00001819 /* We already have some kind of index in use for this query. */
1820 return;
1821 }
1822 if( pSrc->notIndexed ){
1823 /* The NOT INDEXED clause appears in the SQL. */
1824 return;
1825 }
danda79cf02011-07-08 16:10:54 +00001826 if( pSrc->isCorrelated ){
1827 /* The source is a correlated sub-query. No point in indexing it. */
1828 return;
1829 }
drh8b307fb2010-04-06 15:57:05 +00001830
1831 assert( pParse->nQueryLoop >= (double)1 );
drh8bd54122010-04-08 15:00:59 +00001832 pTable = pSrc->pTab;
drh15564052010-09-25 22:32:56 +00001833 nTableRow = pTable->nRowEst;
drh8b307fb2010-04-06 15:57:05 +00001834 logN = estLog(nTableRow);
1835 costTempIdx = 2*logN*(nTableRow/pParse->nQueryLoop + 1);
drh56f1b992012-09-25 14:29:39 +00001836 if( costTempIdx>=p->cost.rCost ){
drh8b307fb2010-04-06 15:57:05 +00001837 /* The cost of creating the transient table would be greater than
1838 ** doing the full table scan */
1839 return;
1840 }
1841
1842 /* Search for any equality comparison term */
1843 pWCEnd = &pWC->a[pWC->nTerm];
1844 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh56f1b992012-09-25 14:29:39 +00001845 if( termCanDriveIndex(pTerm, pSrc, p->notReady) ){
drh7924f3e2011-02-09 03:04:27 +00001846 WHERETRACE(("auto-index reduces cost from %.1f to %.1f\n",
drh56f1b992012-09-25 14:29:39 +00001847 p->cost.rCost, costTempIdx));
1848 p->cost.rCost = costTempIdx;
1849 p->cost.plan.nRow = logN + 1;
1850 p->cost.plan.wsFlags = WHERE_TEMP_INDEX;
1851 p->cost.used = pTerm->prereqRight;
drh8b307fb2010-04-06 15:57:05 +00001852 break;
1853 }
1854 }
1855}
drhc6339082010-04-07 16:54:58 +00001856#else
drh56f1b992012-09-25 14:29:39 +00001857# define bestAutomaticIndex(A) /* no-op */
drhc6339082010-04-07 16:54:58 +00001858#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh8b307fb2010-04-06 15:57:05 +00001859
drhc6339082010-04-07 16:54:58 +00001860
1861#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00001862/*
drhc6339082010-04-07 16:54:58 +00001863** Generate code to construct the Index object for an automatic index
1864** and to set up the WhereLevel object pLevel so that the code generator
1865** makes use of the automatic index.
drh8b307fb2010-04-06 15:57:05 +00001866*/
drhc6339082010-04-07 16:54:58 +00001867static void constructAutomaticIndex(
drh8b307fb2010-04-06 15:57:05 +00001868 Parse *pParse, /* The parsing context */
1869 WhereClause *pWC, /* The WHERE clause */
1870 struct SrcList_item *pSrc, /* The FROM clause term to get the next index */
1871 Bitmask notReady, /* Mask of cursors that are not available */
1872 WhereLevel *pLevel /* Write new index here */
1873){
1874 int nColumn; /* Number of columns in the constructed index */
1875 WhereTerm *pTerm; /* A single term of the WHERE clause */
1876 WhereTerm *pWCEnd; /* End of pWC->a[] */
1877 int nByte; /* Byte of memory needed for pIdx */
1878 Index *pIdx; /* Object describing the transient index */
1879 Vdbe *v; /* Prepared statement under construction */
drh8b307fb2010-04-06 15:57:05 +00001880 int addrInit; /* Address of the initialization bypass jump */
1881 Table *pTable; /* The table being indexed */
1882 KeyInfo *pKeyinfo; /* Key information for the index */
1883 int addrTop; /* Top of the index fill loop */
1884 int regRecord; /* Register holding an index record */
1885 int n; /* Column counter */
drh4139c992010-04-07 14:59:45 +00001886 int i; /* Loop counter */
1887 int mxBitCol; /* Maximum column in pSrc->colUsed */
drh424aab82010-04-06 18:28:20 +00001888 CollSeq *pColl; /* Collating sequence to on a column */
drh4139c992010-04-07 14:59:45 +00001889 Bitmask idxCols; /* Bitmap of columns used for indexing */
1890 Bitmask extraCols; /* Bitmap of additional columns */
drh8b307fb2010-04-06 15:57:05 +00001891
1892 /* Generate code to skip over the creation and initialization of the
1893 ** transient index on 2nd and subsequent iterations of the loop. */
1894 v = pParse->pVdbe;
1895 assert( v!=0 );
dan1d8cb212011-12-09 13:24:16 +00001896 addrInit = sqlite3CodeOnce(pParse);
drh8b307fb2010-04-06 15:57:05 +00001897
drh4139c992010-04-07 14:59:45 +00001898 /* Count the number of columns that will be added to the index
1899 ** and used to match WHERE clause constraints */
drh8b307fb2010-04-06 15:57:05 +00001900 nColumn = 0;
drh424aab82010-04-06 18:28:20 +00001901 pTable = pSrc->pTab;
drh8b307fb2010-04-06 15:57:05 +00001902 pWCEnd = &pWC->a[pWC->nTerm];
drh4139c992010-04-07 14:59:45 +00001903 idxCols = 0;
drh8b307fb2010-04-06 15:57:05 +00001904 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00001905 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
1906 int iCol = pTerm->u.leftColumn;
drh0013e722010-04-08 00:40:15 +00001907 Bitmask cMask = iCol>=BMS ? ((Bitmask)1)<<(BMS-1) : ((Bitmask)1)<<iCol;
drh52ff8ea2010-04-08 14:15:56 +00001908 testcase( iCol==BMS );
1909 testcase( iCol==BMS-1 );
drh0013e722010-04-08 00:40:15 +00001910 if( (idxCols & cMask)==0 ){
1911 nColumn++;
1912 idxCols |= cMask;
1913 }
drh8b307fb2010-04-06 15:57:05 +00001914 }
1915 }
1916 assert( nColumn>0 );
drh424aab82010-04-06 18:28:20 +00001917 pLevel->plan.nEq = nColumn;
drh4139c992010-04-07 14:59:45 +00001918
1919 /* Count the number of additional columns needed to create a
1920 ** covering index. A "covering index" is an index that contains all
1921 ** columns that are needed by the query. With a covering index, the
1922 ** original table never needs to be accessed. Automatic indices must
1923 ** be a covering index because the index will not be updated if the
1924 ** original table changes and the index and table cannot both be used
1925 ** if they go out of sync.
1926 */
drh0013e722010-04-08 00:40:15 +00001927 extraCols = pSrc->colUsed & (~idxCols | (((Bitmask)1)<<(BMS-1)));
drh4139c992010-04-07 14:59:45 +00001928 mxBitCol = (pTable->nCol >= BMS-1) ? BMS-1 : pTable->nCol;
drh52ff8ea2010-04-08 14:15:56 +00001929 testcase( pTable->nCol==BMS-1 );
1930 testcase( pTable->nCol==BMS-2 );
drh4139c992010-04-07 14:59:45 +00001931 for(i=0; i<mxBitCol; i++){
drh67ae0cb2010-04-08 14:38:51 +00001932 if( extraCols & (((Bitmask)1)<<i) ) nColumn++;
drh4139c992010-04-07 14:59:45 +00001933 }
1934 if( pSrc->colUsed & (((Bitmask)1)<<(BMS-1)) ){
1935 nColumn += pTable->nCol - BMS + 1;
1936 }
1937 pLevel->plan.wsFlags |= WHERE_COLUMN_EQ | WHERE_IDX_ONLY | WO_EQ;
drh8b307fb2010-04-06 15:57:05 +00001938
1939 /* Construct the Index object to describe this index */
1940 nByte = sizeof(Index);
1941 nByte += nColumn*sizeof(int); /* Index.aiColumn */
1942 nByte += nColumn*sizeof(char*); /* Index.azColl */
1943 nByte += nColumn; /* Index.aSortOrder */
1944 pIdx = sqlite3DbMallocZero(pParse->db, nByte);
1945 if( pIdx==0 ) return;
1946 pLevel->plan.u.pIdx = pIdx;
1947 pIdx->azColl = (char**)&pIdx[1];
1948 pIdx->aiColumn = (int*)&pIdx->azColl[nColumn];
1949 pIdx->aSortOrder = (u8*)&pIdx->aiColumn[nColumn];
1950 pIdx->zName = "auto-index";
1951 pIdx->nColumn = nColumn;
drh424aab82010-04-06 18:28:20 +00001952 pIdx->pTable = pTable;
drh8b307fb2010-04-06 15:57:05 +00001953 n = 0;
drh0013e722010-04-08 00:40:15 +00001954 idxCols = 0;
drh8b307fb2010-04-06 15:57:05 +00001955 for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
drh4139c992010-04-07 14:59:45 +00001956 if( termCanDriveIndex(pTerm, pSrc, notReady) ){
drh0013e722010-04-08 00:40:15 +00001957 int iCol = pTerm->u.leftColumn;
1958 Bitmask cMask = iCol>=BMS ? ((Bitmask)1)<<(BMS-1) : ((Bitmask)1)<<iCol;
1959 if( (idxCols & cMask)==0 ){
1960 Expr *pX = pTerm->pExpr;
1961 idxCols |= cMask;
1962 pIdx->aiColumn[n] = pTerm->u.leftColumn;
1963 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
drh6f2e6c02011-02-17 13:33:15 +00001964 pIdx->azColl[n] = ALWAYS(pColl) ? pColl->zName : "BINARY";
drh0013e722010-04-08 00:40:15 +00001965 n++;
1966 }
drh8b307fb2010-04-06 15:57:05 +00001967 }
1968 }
shaneh5eba1f62010-07-02 17:05:03 +00001969 assert( (u32)n==pLevel->plan.nEq );
drh4139c992010-04-07 14:59:45 +00001970
drhc6339082010-04-07 16:54:58 +00001971 /* Add additional columns needed to make the automatic index into
1972 ** a covering index */
drh4139c992010-04-07 14:59:45 +00001973 for(i=0; i<mxBitCol; i++){
drh67ae0cb2010-04-08 14:38:51 +00001974 if( extraCols & (((Bitmask)1)<<i) ){
drh4139c992010-04-07 14:59:45 +00001975 pIdx->aiColumn[n] = i;
1976 pIdx->azColl[n] = "BINARY";
1977 n++;
1978 }
1979 }
1980 if( pSrc->colUsed & (((Bitmask)1)<<(BMS-1)) ){
1981 for(i=BMS-1; i<pTable->nCol; i++){
1982 pIdx->aiColumn[n] = i;
1983 pIdx->azColl[n] = "BINARY";
1984 n++;
1985 }
1986 }
1987 assert( n==nColumn );
drh8b307fb2010-04-06 15:57:05 +00001988
drhc6339082010-04-07 16:54:58 +00001989 /* Create the automatic index */
drh8b307fb2010-04-06 15:57:05 +00001990 pKeyinfo = sqlite3IndexKeyinfo(pParse, pIdx);
1991 assert( pLevel->iIdxCur>=0 );
drha21a64d2010-04-06 22:33:55 +00001992 sqlite3VdbeAddOp4(v, OP_OpenAutoindex, pLevel->iIdxCur, nColumn+1, 0,
drh8b307fb2010-04-06 15:57:05 +00001993 (char*)pKeyinfo, P4_KEYINFO_HANDOFF);
drha21a64d2010-04-06 22:33:55 +00001994 VdbeComment((v, "for %s", pTable->zName));
drh8b307fb2010-04-06 15:57:05 +00001995
drhc6339082010-04-07 16:54:58 +00001996 /* Fill the automatic index with content */
drh8b307fb2010-04-06 15:57:05 +00001997 addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, pLevel->iTabCur);
1998 regRecord = sqlite3GetTempReg(pParse);
1999 sqlite3GenerateIndexKey(pParse, pIdx, pLevel->iTabCur, regRecord, 1);
2000 sqlite3VdbeAddOp2(v, OP_IdxInsert, pLevel->iIdxCur, regRecord);
2001 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2002 sqlite3VdbeAddOp2(v, OP_Next, pLevel->iTabCur, addrTop+1);
drha21a64d2010-04-06 22:33:55 +00002003 sqlite3VdbeChangeP5(v, SQLITE_STMTSTATUS_AUTOINDEX);
drh8b307fb2010-04-06 15:57:05 +00002004 sqlite3VdbeJumpHere(v, addrTop);
2005 sqlite3ReleaseTempReg(pParse, regRecord);
2006
2007 /* Jump here when skipping the initialization */
2008 sqlite3VdbeJumpHere(v, addrInit);
2009}
drhc6339082010-04-07 16:54:58 +00002010#endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
drh8b307fb2010-04-06 15:57:05 +00002011
drh9eff6162006-06-12 21:59:13 +00002012#ifndef SQLITE_OMIT_VIRTUALTABLE
2013/*
danielk19771d461462009-04-21 09:02:45 +00002014** Allocate and populate an sqlite3_index_info structure. It is the
2015** responsibility of the caller to eventually release the structure
2016** by passing the pointer returned by this function to sqlite3_free().
2017*/
drh56f1b992012-09-25 14:29:39 +00002018static sqlite3_index_info *allocateIndexInfo(WhereBestIdx *p){
2019 Parse *pParse = p->pParse;
2020 WhereClause *pWC = p->pWC;
2021 struct SrcList_item *pSrc = p->pSrc;
2022 ExprList *pOrderBy = p->pOrderBy;
danielk19771d461462009-04-21 09:02:45 +00002023 int i, j;
2024 int nTerm;
2025 struct sqlite3_index_constraint *pIdxCons;
2026 struct sqlite3_index_orderby *pIdxOrderBy;
2027 struct sqlite3_index_constraint_usage *pUsage;
2028 WhereTerm *pTerm;
2029 int nOrderBy;
2030 sqlite3_index_info *pIdxInfo;
2031
2032 WHERETRACE(("Recomputing index info for %s...\n", pSrc->pTab->zName));
2033
2034 /* Count the number of possible WHERE clause constraints referring
2035 ** to this virtual table */
2036 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
2037 if( pTerm->leftCursor != pSrc->iCursor ) continue;
2038 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
2039 testcase( pTerm->eOperator==WO_IN );
2040 testcase( pTerm->eOperator==WO_ISNULL );
2041 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drhb4256992011-08-02 01:57:39 +00002042 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00002043 nTerm++;
2044 }
2045
2046 /* If the ORDER BY clause contains only columns in the current
2047 ** virtual table then allocate space for the aOrderBy part of
2048 ** the sqlite3_index_info structure.
2049 */
2050 nOrderBy = 0;
2051 if( pOrderBy ){
drh56f1b992012-09-25 14:29:39 +00002052 int n = pOrderBy->nExpr;
2053 for(i=0; i<n; i++){
danielk19771d461462009-04-21 09:02:45 +00002054 Expr *pExpr = pOrderBy->a[i].pExpr;
2055 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
2056 }
drh56f1b992012-09-25 14:29:39 +00002057 if( i==n){
2058 nOrderBy = n;
danielk19771d461462009-04-21 09:02:45 +00002059 }
2060 }
2061
2062 /* Allocate the sqlite3_index_info structure
2063 */
2064 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
2065 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
2066 + sizeof(*pIdxOrderBy)*nOrderBy );
2067 if( pIdxInfo==0 ){
2068 sqlite3ErrorMsg(pParse, "out of memory");
2069 /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
2070 return 0;
2071 }
2072
2073 /* Initialize the structure. The sqlite3_index_info structure contains
2074 ** many fields that are declared "const" to prevent xBestIndex from
2075 ** changing them. We have to do some funky casting in order to
2076 ** initialize those fields.
2077 */
2078 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
2079 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
2080 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
2081 *(int*)&pIdxInfo->nConstraint = nTerm;
2082 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
2083 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
2084 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
2085 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
2086 pUsage;
2087
2088 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
2089 if( pTerm->leftCursor != pSrc->iCursor ) continue;
2090 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
2091 testcase( pTerm->eOperator==WO_IN );
2092 testcase( pTerm->eOperator==WO_ISNULL );
2093 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drhb4256992011-08-02 01:57:39 +00002094 if( pTerm->wtFlags & TERM_VNULL ) continue;
danielk19771d461462009-04-21 09:02:45 +00002095 pIdxCons[j].iColumn = pTerm->u.leftColumn;
2096 pIdxCons[j].iTermOffset = i;
2097 pIdxCons[j].op = (u8)pTerm->eOperator;
2098 /* The direct assignment in the previous line is possible only because
2099 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
2100 ** following asserts verify this fact. */
2101 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
2102 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
2103 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
2104 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
2105 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
2106 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
2107 assert( pTerm->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
2108 j++;
2109 }
2110 for(i=0; i<nOrderBy; i++){
2111 Expr *pExpr = pOrderBy->a[i].pExpr;
2112 pIdxOrderBy[i].iColumn = pExpr->iColumn;
2113 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
2114 }
2115
2116 return pIdxInfo;
2117}
2118
2119/*
2120** The table object reference passed as the second argument to this function
2121** must represent a virtual table. This function invokes the xBestIndex()
2122** method of the virtual table with the sqlite3_index_info pointer passed
2123** as the argument.
2124**
2125** If an error occurs, pParse is populated with an error message and a
2126** non-zero value is returned. Otherwise, 0 is returned and the output
2127** part of the sqlite3_index_info structure is left populated.
2128**
2129** Whether or not an error is returned, it is the responsibility of the
2130** caller to eventually free p->idxStr if p->needToFreeIdxStr indicates
2131** that this is required.
2132*/
2133static int vtabBestIndex(Parse *pParse, Table *pTab, sqlite3_index_info *p){
danielk1977595a5232009-07-24 17:58:53 +00002134 sqlite3_vtab *pVtab = sqlite3GetVTable(pParse->db, pTab)->pVtab;
danielk19771d461462009-04-21 09:02:45 +00002135 int i;
2136 int rc;
2137
danielk19771d461462009-04-21 09:02:45 +00002138 WHERETRACE(("xBestIndex for %s\n", pTab->zName));
2139 TRACE_IDX_INPUTS(p);
2140 rc = pVtab->pModule->xBestIndex(pVtab, p);
2141 TRACE_IDX_OUTPUTS(p);
danielk19771d461462009-04-21 09:02:45 +00002142
2143 if( rc!=SQLITE_OK ){
2144 if( rc==SQLITE_NOMEM ){
2145 pParse->db->mallocFailed = 1;
2146 }else if( !pVtab->zErrMsg ){
2147 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
2148 }else{
2149 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
2150 }
2151 }
drhb9755982010-07-24 16:34:37 +00002152 sqlite3_free(pVtab->zErrMsg);
danielk19771d461462009-04-21 09:02:45 +00002153 pVtab->zErrMsg = 0;
2154
2155 for(i=0; i<p->nConstraint; i++){
2156 if( !p->aConstraint[i].usable && p->aConstraintUsage[i].argvIndex>0 ){
2157 sqlite3ErrorMsg(pParse,
2158 "table %s: xBestIndex returned an invalid plan", pTab->zName);
2159 }
2160 }
2161
2162 return pParse->nErr;
2163}
2164
2165
2166/*
drh7f375902006-06-13 17:38:59 +00002167** Compute the best index for a virtual table.
2168**
2169** The best index is computed by the xBestIndex method of the virtual
2170** table module. This routine is really just a wrapper that sets up
2171** the sqlite3_index_info structure that is used to communicate with
2172** xBestIndex.
2173**
2174** In a join, this routine might be called multiple times for the
2175** same virtual table. The sqlite3_index_info structure is created
2176** and initialized on the first invocation and reused on all subsequent
2177** invocations. The sqlite3_index_info structure is also used when
2178** code is generated to access the virtual table. The whereInfoDelete()
2179** routine takes care of freeing the sqlite3_index_info structure after
2180** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00002181*/
drh56f1b992012-09-25 14:29:39 +00002182static void bestVirtualIndex(WhereBestIdx *p){
2183 Parse *pParse = p->pParse; /* The parsing context */
2184 WhereClause *pWC = p->pWC; /* The WHERE clause */
2185 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
drh9eff6162006-06-12 21:59:13 +00002186 Table *pTab = pSrc->pTab;
2187 sqlite3_index_info *pIdxInfo;
2188 struct sqlite3_index_constraint *pIdxCons;
drh9eff6162006-06-12 21:59:13 +00002189 struct sqlite3_index_constraint_usage *pUsage;
2190 WhereTerm *pTerm;
2191 int i, j;
2192 int nOrderBy;
danc26c0042010-03-27 09:44:42 +00002193 double rCost;
drh9eff6162006-06-12 21:59:13 +00002194
danielk19776eacd282009-04-29 11:50:53 +00002195 /* Make sure wsFlags is initialized to some sane value. Otherwise, if the
2196 ** malloc in allocateIndexInfo() fails and this function returns leaving
2197 ** wsFlags in an uninitialized state, the caller may behave unpredictably.
2198 */
drh56f1b992012-09-25 14:29:39 +00002199 memset(&p->cost, 0, sizeof(p->cost));
2200 p->cost.plan.wsFlags = WHERE_VIRTUALTABLE;
danielk19776eacd282009-04-29 11:50:53 +00002201
drh9eff6162006-06-12 21:59:13 +00002202 /* If the sqlite3_index_info structure has not been previously
danielk19771d461462009-04-21 09:02:45 +00002203 ** allocated and initialized, then allocate and initialize it now.
drh9eff6162006-06-12 21:59:13 +00002204 */
drh56f1b992012-09-25 14:29:39 +00002205 pIdxInfo = *p->ppIdxInfo;
drh9eff6162006-06-12 21:59:13 +00002206 if( pIdxInfo==0 ){
drh56f1b992012-09-25 14:29:39 +00002207 *p->ppIdxInfo = pIdxInfo = allocateIndexInfo(p);
drh9eff6162006-06-12 21:59:13 +00002208 }
danielk1977732dc552009-04-21 17:23:04 +00002209 if( pIdxInfo==0 ){
2210 return;
2211 }
drh9eff6162006-06-12 21:59:13 +00002212
drh7f375902006-06-13 17:38:59 +00002213 /* At this point, the sqlite3_index_info structure that pIdxInfo points
2214 ** to will have been initialized, either during the current invocation or
2215 ** during some prior invocation. Now we just have to customize the
2216 ** details of pIdxInfo for the current invocation and pass it to
2217 ** xBestIndex.
2218 */
2219
danielk1977935ed5e2007-03-30 09:13:13 +00002220 /* The module name must be defined. Also, by this point there must
2221 ** be a pointer to an sqlite3_vtab structure. Otherwise
2222 ** sqlite3ViewGetColumnNames() would have picked up the error.
2223 */
drh9eff6162006-06-12 21:59:13 +00002224 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
danielk1977595a5232009-07-24 17:58:53 +00002225 assert( sqlite3GetVTable(pParse->db, pTab) );
drh9eff6162006-06-12 21:59:13 +00002226
2227 /* Set the aConstraint[].usable fields and initialize all
drh7f375902006-06-13 17:38:59 +00002228 ** output variables to zero.
2229 **
2230 ** aConstraint[].usable is true for constraints where the right-hand
2231 ** side contains only references to tables to the left of the current
2232 ** table. In other words, if the constraint is of the form:
2233 **
2234 ** column = expr
2235 **
2236 ** and we are evaluating a join, then the constraint on column is
2237 ** only valid if all tables referenced in expr occur to the left
2238 ** of the table containing column.
2239 **
2240 ** The aConstraints[] array contains entries for all constraints
2241 ** on the current table. That way we only have to compute it once
2242 ** even though we might try to pick the best index multiple times.
2243 ** For each attempt at picking an index, the order of tables in the
2244 ** join might be different so we have to recompute the usable flag
2245 ** each time.
drh9eff6162006-06-12 21:59:13 +00002246 */
2247 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
2248 pUsage = pIdxInfo->aConstraintUsage;
2249 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
2250 j = pIdxCons->iTermOffset;
2251 pTerm = &pWC->a[j];
drh56f1b992012-09-25 14:29:39 +00002252 pIdxCons->usable = (pTerm->prereqRight&p->notReady) ? 0 : 1;
drh9eff6162006-06-12 21:59:13 +00002253 }
2254 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
drh4be8b512006-06-13 23:51:34 +00002255 if( pIdxInfo->needToFreeIdxStr ){
2256 sqlite3_free(pIdxInfo->idxStr);
2257 }
2258 pIdxInfo->idxStr = 0;
2259 pIdxInfo->idxNum = 0;
2260 pIdxInfo->needToFreeIdxStr = 0;
drh9eff6162006-06-12 21:59:13 +00002261 pIdxInfo->orderByConsumed = 0;
shanefbd60f82009-02-04 03:59:25 +00002262 /* ((double)2) In case of SQLITE_OMIT_FLOATING_POINT... */
2263 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / ((double)2);
drh9eff6162006-06-12 21:59:13 +00002264 nOrderBy = pIdxInfo->nOrderBy;
drh56f1b992012-09-25 14:29:39 +00002265 if( !p->pOrderBy ){
danielk19771d461462009-04-21 09:02:45 +00002266 pIdxInfo->nOrderBy = 0;
drh9eff6162006-06-12 21:59:13 +00002267 }
danielk197774cdba42006-06-19 12:02:58 +00002268
danielk19771d461462009-04-21 09:02:45 +00002269 if( vtabBestIndex(pParse, pTab, pIdxInfo) ){
2270 return;
danielk197739359dc2008-03-17 09:36:44 +00002271 }
2272
dan5236ac12009-08-13 07:09:33 +00002273 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
2274 for(i=0; i<pIdxInfo->nConstraint; i++){
2275 if( pUsage[i].argvIndex>0 ){
drh56f1b992012-09-25 14:29:39 +00002276 p->cost.used |= pWC->a[pIdxCons[i].iTermOffset].prereqRight;
dan5236ac12009-08-13 07:09:33 +00002277 }
2278 }
2279
danc26c0042010-03-27 09:44:42 +00002280 /* If there is an ORDER BY clause, and the selected virtual table index
2281 ** does not satisfy it, increase the cost of the scan accordingly. This
2282 ** matches the processing for non-virtual tables in bestBtreeIndex().
2283 */
2284 rCost = pIdxInfo->estimatedCost;
drh56f1b992012-09-25 14:29:39 +00002285 if( p->pOrderBy && pIdxInfo->orderByConsumed==0 ){
danc26c0042010-03-27 09:44:42 +00002286 rCost += estLog(rCost)*rCost;
2287 }
2288
danielk19771d461462009-04-21 09:02:45 +00002289 /* The cost is not allowed to be larger than SQLITE_BIG_DBL (the
2290 ** inital value of lowestCost in this loop. If it is, then the
2291 ** (cost<lowestCost) test below will never be true.
2292 **
2293 ** Use "(double)2" instead of "2.0" in case OMIT_FLOATING_POINT
2294 ** is defined.
2295 */
danc26c0042010-03-27 09:44:42 +00002296 if( (SQLITE_BIG_DBL/((double)2))<rCost ){
drh56f1b992012-09-25 14:29:39 +00002297 p->cost.rCost = (SQLITE_BIG_DBL/((double)2));
danielk19771d461462009-04-21 09:02:45 +00002298 }else{
drh56f1b992012-09-25 14:29:39 +00002299 p->cost.rCost = rCost;
danielk19771d461462009-04-21 09:02:45 +00002300 }
drh56f1b992012-09-25 14:29:39 +00002301 p->cost.plan.u.pVtabIdx = pIdxInfo;
drh5901b572009-06-10 19:33:28 +00002302 if( pIdxInfo->orderByConsumed ){
drhd663b5b2012-10-03 00:25:54 +00002303 p->cost.plan.wsFlags |= WHERE_ORDERED;
2304 p->cost.plan.nOBSat = nOrderBy;
2305 }else{
2306 p->cost.plan.nOBSat = p->i ? p->aLevel[p->i-1].plan.nOBSat : 0;
danielk19771d461462009-04-21 09:02:45 +00002307 }
drh56f1b992012-09-25 14:29:39 +00002308 p->cost.plan.nEq = 0;
danielk19771d461462009-04-21 09:02:45 +00002309 pIdxInfo->nOrderBy = nOrderBy;
2310
2311 /* Try to find a more efficient access pattern by using multiple indexes
2312 ** to optimize an OR expression within the WHERE clause.
2313 */
drh56f1b992012-09-25 14:29:39 +00002314 bestOrClauseIndex(p);
drh9eff6162006-06-12 21:59:13 +00002315}
2316#endif /* SQLITE_OMIT_VIRTUALTABLE */
2317
drhfaacf172011-08-12 01:51:45 +00002318#ifdef SQLITE_ENABLE_STAT3
drh28c4cf42005-07-27 20:41:43 +00002319/*
drhfaacf172011-08-12 01:51:45 +00002320** Estimate the location of a particular key among all keys in an
2321** index. Store the results in aStat as follows:
drhe847d322011-01-20 02:56:37 +00002322**
drhfaacf172011-08-12 01:51:45 +00002323** aStat[0] Est. number of rows less than pVal
2324** aStat[1] Est. number of rows equal to pVal
dan02fa4692009-08-17 17:06:58 +00002325**
drhfaacf172011-08-12 01:51:45 +00002326** Return SQLITE_OK on success.
dan02fa4692009-08-17 17:06:58 +00002327*/
drhfaacf172011-08-12 01:51:45 +00002328static int whereKeyStats(
dan02fa4692009-08-17 17:06:58 +00002329 Parse *pParse, /* Database connection */
2330 Index *pIdx, /* Index to consider domain of */
2331 sqlite3_value *pVal, /* Value to consider */
drhfaacf172011-08-12 01:51:45 +00002332 int roundUp, /* Round up if true. Round down if false */
2333 tRowcnt *aStat /* OUT: stats written here */
dan02fa4692009-08-17 17:06:58 +00002334){
drhfaacf172011-08-12 01:51:45 +00002335 tRowcnt n;
2336 IndexSample *aSample;
2337 int i, eType;
2338 int isEq = 0;
drh4e50c5e2011-08-13 19:35:19 +00002339 i64 v;
2340 double r, rS;
dan02fa4692009-08-17 17:06:58 +00002341
drhfaacf172011-08-12 01:51:45 +00002342 assert( roundUp==0 || roundUp==1 );
drh5c624862011-09-22 18:46:34 +00002343 assert( pIdx->nSample>0 );
drhfaacf172011-08-12 01:51:45 +00002344 if( pVal==0 ) return SQLITE_ERROR;
2345 n = pIdx->aiRowEst[0];
2346 aSample = pIdx->aSample;
drhfaacf172011-08-12 01:51:45 +00002347 eType = sqlite3_value_type(pVal);
2348
2349 if( eType==SQLITE_INTEGER ){
drh4e50c5e2011-08-13 19:35:19 +00002350 v = sqlite3_value_int64(pVal);
2351 r = (i64)v;
drhfaacf172011-08-12 01:51:45 +00002352 for(i=0; i<pIdx->nSample; i++){
2353 if( aSample[i].eType==SQLITE_NULL ) continue;
2354 if( aSample[i].eType>=SQLITE_TEXT ) break;
drh4e50c5e2011-08-13 19:35:19 +00002355 if( aSample[i].eType==SQLITE_INTEGER ){
2356 if( aSample[i].u.i>=v ){
2357 isEq = aSample[i].u.i==v;
2358 break;
2359 }
2360 }else{
2361 assert( aSample[i].eType==SQLITE_FLOAT );
2362 if( aSample[i].u.r>=r ){
2363 isEq = aSample[i].u.r==r;
2364 break;
2365 }
dan02fa4692009-08-17 17:06:58 +00002366 }
drhfaacf172011-08-12 01:51:45 +00002367 }
2368 }else if( eType==SQLITE_FLOAT ){
drh4e50c5e2011-08-13 19:35:19 +00002369 r = sqlite3_value_double(pVal);
drhfaacf172011-08-12 01:51:45 +00002370 for(i=0; i<pIdx->nSample; i++){
2371 if( aSample[i].eType==SQLITE_NULL ) continue;
2372 if( aSample[i].eType>=SQLITE_TEXT ) break;
drh4e50c5e2011-08-13 19:35:19 +00002373 if( aSample[i].eType==SQLITE_FLOAT ){
2374 rS = aSample[i].u.r;
2375 }else{
2376 rS = aSample[i].u.i;
2377 }
2378 if( rS>=r ){
2379 isEq = rS==r;
drhfaacf172011-08-12 01:51:45 +00002380 break;
drh9b3eb0a2011-01-21 14:37:04 +00002381 }
drhfaacf172011-08-12 01:51:45 +00002382 }
2383 }else if( eType==SQLITE_NULL ){
2384 i = 0;
drh5c624862011-09-22 18:46:34 +00002385 if( aSample[0].eType==SQLITE_NULL ) isEq = 1;
drhfaacf172011-08-12 01:51:45 +00002386 }else{
2387 assert( eType==SQLITE_TEXT || eType==SQLITE_BLOB );
2388 for(i=0; i<pIdx->nSample; i++){
2389 if( aSample[i].eType==SQLITE_TEXT || aSample[i].eType==SQLITE_BLOB ){
2390 break;
2391 }
2392 }
2393 if( i<pIdx->nSample ){
dan02fa4692009-08-17 17:06:58 +00002394 sqlite3 *db = pParse->db;
2395 CollSeq *pColl;
2396 const u8 *z;
dan02fa4692009-08-17 17:06:58 +00002397 if( eType==SQLITE_BLOB ){
2398 z = (const u8 *)sqlite3_value_blob(pVal);
2399 pColl = db->pDfltColl;
dane275dc32009-08-18 16:24:58 +00002400 assert( pColl->enc==SQLITE_UTF8 );
dan02fa4692009-08-17 17:06:58 +00002401 }else{
drh79e72a52012-10-05 14:43:40 +00002402 pColl = sqlite3GetCollSeq(pParse, SQLITE_UTF8, 0, *pIdx->azColl);
drh9aeda792009-08-20 02:34:15 +00002403 if( pColl==0 ){
dane275dc32009-08-18 16:24:58 +00002404 return SQLITE_ERROR;
2405 }
dan02fa4692009-08-17 17:06:58 +00002406 z = (const u8 *)sqlite3ValueText(pVal, pColl->enc);
dane275dc32009-08-18 16:24:58 +00002407 if( !z ){
2408 return SQLITE_NOMEM;
2409 }
dan02fa4692009-08-17 17:06:58 +00002410 assert( z && pColl && pColl->xCmp );
2411 }
2412 n = sqlite3ValueBytes(pVal, pColl->enc);
drhfaacf172011-08-12 01:51:45 +00002413
2414 for(; i<pIdx->nSample; i++){
drhe847d322011-01-20 02:56:37 +00002415 int c;
dan02fa4692009-08-17 17:06:58 +00002416 int eSampletype = aSample[i].eType;
drhfaacf172011-08-12 01:51:45 +00002417 if( eSampletype<eType ) continue;
2418 if( eSampletype!=eType ) break;
dane83c4f32009-09-21 16:34:24 +00002419#ifndef SQLITE_OMIT_UTF16
2420 if( pColl->enc!=SQLITE_UTF8 ){
dane275dc32009-08-18 16:24:58 +00002421 int nSample;
2422 char *zSample = sqlite3Utf8to16(
dan02fa4692009-08-17 17:06:58 +00002423 db, pColl->enc, aSample[i].u.z, aSample[i].nByte, &nSample
2424 );
dane275dc32009-08-18 16:24:58 +00002425 if( !zSample ){
2426 assert( db->mallocFailed );
2427 return SQLITE_NOMEM;
2428 }
drhe847d322011-01-20 02:56:37 +00002429 c = pColl->xCmp(pColl->pUser, nSample, zSample, n, z);
dane275dc32009-08-18 16:24:58 +00002430 sqlite3DbFree(db, zSample);
dane83c4f32009-09-21 16:34:24 +00002431 }else
2432#endif
2433 {
drhe847d322011-01-20 02:56:37 +00002434 c = pColl->xCmp(pColl->pUser, aSample[i].nByte, aSample[i].u.z, n, z);
dan02fa4692009-08-17 17:06:58 +00002435 }
drhfaacf172011-08-12 01:51:45 +00002436 if( c>=0 ){
2437 if( c==0 ) isEq = 1;
2438 break;
2439 }
dan02fa4692009-08-17 17:06:58 +00002440 }
2441 }
drhfaacf172011-08-12 01:51:45 +00002442 }
dan02fa4692009-08-17 17:06:58 +00002443
drhfaacf172011-08-12 01:51:45 +00002444 /* At this point, aSample[i] is the first sample that is greater than
2445 ** or equal to pVal. Or if i==pIdx->nSample, then all samples are less
2446 ** than pVal. If aSample[i]==pVal, then isEq==1.
2447 */
2448 if( isEq ){
2449 assert( i<pIdx->nSample );
2450 aStat[0] = aSample[i].nLt;
2451 aStat[1] = aSample[i].nEq;
2452 }else{
2453 tRowcnt iLower, iUpper, iGap;
2454 if( i==0 ){
2455 iLower = 0;
2456 iUpper = aSample[0].nLt;
drhfaacf172011-08-12 01:51:45 +00002457 }else{
drh4e50c5e2011-08-13 19:35:19 +00002458 iUpper = i>=pIdx->nSample ? n : aSample[i].nLt;
drhfaacf172011-08-12 01:51:45 +00002459 iLower = aSample[i-1].nEq + aSample[i-1].nLt;
drhfaacf172011-08-12 01:51:45 +00002460 }
drh4e50c5e2011-08-13 19:35:19 +00002461 aStat[1] = pIdx->avgEq;
drhfaacf172011-08-12 01:51:45 +00002462 if( iLower>=iUpper ){
2463 iGap = 0;
2464 }else{
2465 iGap = iUpper - iLower;
drhfaacf172011-08-12 01:51:45 +00002466 }
2467 if( roundUp ){
2468 iGap = (iGap*2)/3;
2469 }else{
2470 iGap = iGap/3;
2471 }
2472 aStat[0] = iLower + iGap;
dan02fa4692009-08-17 17:06:58 +00002473 }
2474 return SQLITE_OK;
2475}
drhfaacf172011-08-12 01:51:45 +00002476#endif /* SQLITE_ENABLE_STAT3 */
dan02fa4692009-08-17 17:06:58 +00002477
2478/*
dan937d0de2009-10-15 18:35:38 +00002479** If expression pExpr represents a literal value, set *pp to point to
2480** an sqlite3_value structure containing the same value, with affinity
2481** aff applied to it, before returning. It is the responsibility of the
2482** caller to eventually release this structure by passing it to
2483** sqlite3ValueFree().
2484**
2485** If the current parse is a recompile (sqlite3Reprepare()) and pExpr
2486** is an SQL variable that currently has a non-NULL value bound to it,
2487** create an sqlite3_value structure containing this value, again with
2488** affinity aff applied to it, instead.
2489**
2490** If neither of the above apply, set *pp to NULL.
2491**
2492** If an error occurs, return an error code. Otherwise, SQLITE_OK.
2493*/
drhfaacf172011-08-12 01:51:45 +00002494#ifdef SQLITE_ENABLE_STAT3
dan937d0de2009-10-15 18:35:38 +00002495static int valueFromExpr(
2496 Parse *pParse,
2497 Expr *pExpr,
2498 u8 aff,
2499 sqlite3_value **pp
2500){
drh4278d532010-12-16 19:52:52 +00002501 if( pExpr->op==TK_VARIABLE
2502 || (pExpr->op==TK_REGISTER && pExpr->op2==TK_VARIABLE)
2503 ){
dan937d0de2009-10-15 18:35:38 +00002504 int iVar = pExpr->iColumn;
drhf9b22ca2011-10-21 16:47:31 +00002505 sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
dan937d0de2009-10-15 18:35:38 +00002506 *pp = sqlite3VdbeGetValue(pParse->pReprepare, iVar, aff);
2507 return SQLITE_OK;
2508 }
2509 return sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, aff, pp);
2510}
danf7b0b0a2009-10-19 15:52:32 +00002511#endif
dan937d0de2009-10-15 18:35:38 +00002512
2513/*
dan02fa4692009-08-17 17:06:58 +00002514** This function is used to estimate the number of rows that will be visited
2515** by scanning an index for a range of values. The range may have an upper
2516** bound, a lower bound, or both. The WHERE clause terms that set the upper
2517** and lower bounds are represented by pLower and pUpper respectively. For
2518** example, assuming that index p is on t1(a):
2519**
2520** ... FROM t1 WHERE a > ? AND a < ? ...
2521** |_____| |_____|
2522** | |
2523** pLower pUpper
2524**
drh98cdf622009-08-20 18:14:42 +00002525** If either of the upper or lower bound is not present, then NULL is passed in
drhcdaca552009-08-20 13:45:07 +00002526** place of the corresponding WhereTerm.
dan02fa4692009-08-17 17:06:58 +00002527**
2528** The nEq parameter is passed the index of the index column subject to the
2529** range constraint. Or, equivalently, the number of equality constraints
2530** optimized by the proposed index scan. For example, assuming index p is
2531** on t1(a, b), and the SQL query is:
2532**
2533** ... FROM t1 WHERE a = ? AND b > ? AND b < ? ...
2534**
2535** then nEq should be passed the value 1 (as the range restricted column,
2536** b, is the second left-most column of the index). Or, if the query is:
2537**
2538** ... FROM t1 WHERE a > ? AND a < ? ...
2539**
2540** then nEq should be passed 0.
2541**
drhfaacf172011-08-12 01:51:45 +00002542** The returned value is an integer divisor to reduce the estimated
2543** search space. A return value of 1 means that range constraints are
2544** no help at all. A return value of 2 means range constraints are
2545** expected to reduce the search space by half. And so forth...
drh98cdf622009-08-20 18:14:42 +00002546**
drhfaacf172011-08-12 01:51:45 +00002547** In the absence of sqlite_stat3 ANALYZE data, each range inequality
2548** reduces the search space by a factor of 4. Hence a single constraint (x>?)
2549** results in a return of 4 and a range constraint (x>? AND x<?) results
2550** in a return of 16.
dan02fa4692009-08-17 17:06:58 +00002551*/
2552static int whereRangeScanEst(
drhcdaca552009-08-20 13:45:07 +00002553 Parse *pParse, /* Parsing & code generating context */
2554 Index *p, /* The index containing the range-compared column; "x" */
2555 int nEq, /* index into p->aCol[] of the range-compared column */
2556 WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
2557 WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
drh4e50c5e2011-08-13 19:35:19 +00002558 double *pRangeDiv /* OUT: Reduce search space by this divisor */
dan02fa4692009-08-17 17:06:58 +00002559){
dan69188d92009-08-19 08:18:32 +00002560 int rc = SQLITE_OK;
2561
drhfaacf172011-08-12 01:51:45 +00002562#ifdef SQLITE_ENABLE_STAT3
dan02fa4692009-08-17 17:06:58 +00002563
drhfaacf172011-08-12 01:51:45 +00002564 if( nEq==0 && p->nSample ){
2565 sqlite3_value *pRangeVal;
2566 tRowcnt iLower = 0;
2567 tRowcnt iUpper = p->aiRowEst[0];
2568 tRowcnt a[2];
dan937d0de2009-10-15 18:35:38 +00002569 u8 aff = p->pTable->aCol[p->aiColumn[0]].affinity;
drh98cdf622009-08-20 18:14:42 +00002570
dan02fa4692009-08-17 17:06:58 +00002571 if( pLower ){
2572 Expr *pExpr = pLower->pExpr->pRight;
drhfaacf172011-08-12 01:51:45 +00002573 rc = valueFromExpr(pParse, pExpr, aff, &pRangeVal);
drhe847d322011-01-20 02:56:37 +00002574 assert( pLower->eOperator==WO_GT || pLower->eOperator==WO_GE );
drhfaacf172011-08-12 01:51:45 +00002575 if( rc==SQLITE_OK
2576 && whereKeyStats(pParse, p, pRangeVal, 0, a)==SQLITE_OK
2577 ){
2578 iLower = a[0];
2579 if( pLower->eOperator==WO_GT ) iLower += a[1];
2580 }
2581 sqlite3ValueFree(pRangeVal);
dan02fa4692009-08-17 17:06:58 +00002582 }
drh98cdf622009-08-20 18:14:42 +00002583 if( rc==SQLITE_OK && pUpper ){
dan02fa4692009-08-17 17:06:58 +00002584 Expr *pExpr = pUpper->pExpr->pRight;
drhfaacf172011-08-12 01:51:45 +00002585 rc = valueFromExpr(pParse, pExpr, aff, &pRangeVal);
drhe847d322011-01-20 02:56:37 +00002586 assert( pUpper->eOperator==WO_LT || pUpper->eOperator==WO_LE );
drhfaacf172011-08-12 01:51:45 +00002587 if( rc==SQLITE_OK
2588 && whereKeyStats(pParse, p, pRangeVal, 1, a)==SQLITE_OK
2589 ){
2590 iUpper = a[0];
drh4e50c5e2011-08-13 19:35:19 +00002591 if( pUpper->eOperator==WO_LE ) iUpper += a[1];
dan02fa4692009-08-17 17:06:58 +00002592 }
drhfaacf172011-08-12 01:51:45 +00002593 sqlite3ValueFree(pRangeVal);
dan02fa4692009-08-17 17:06:58 +00002594 }
drhfaacf172011-08-12 01:51:45 +00002595 if( rc==SQLITE_OK ){
2596 if( iUpper<=iLower ){
drh4e50c5e2011-08-13 19:35:19 +00002597 *pRangeDiv = (double)p->aiRowEst[0];
drhfaacf172011-08-12 01:51:45 +00002598 }else{
drh4e50c5e2011-08-13 19:35:19 +00002599 *pRangeDiv = (double)p->aiRowEst[0]/(double)(iUpper - iLower);
drhfaacf172011-08-12 01:51:45 +00002600 }
drh4e50c5e2011-08-13 19:35:19 +00002601 WHERETRACE(("range scan regions: %u..%u div=%g\n",
2602 (u32)iLower, (u32)iUpper, *pRangeDiv));
drhfaacf172011-08-12 01:51:45 +00002603 return SQLITE_OK;
drh98cdf622009-08-20 18:14:42 +00002604 }
dan02fa4692009-08-17 17:06:58 +00002605 }
drh3f022182009-09-09 16:10:50 +00002606#else
2607 UNUSED_PARAMETER(pParse);
2608 UNUSED_PARAMETER(p);
2609 UNUSED_PARAMETER(nEq);
dan69188d92009-08-19 08:18:32 +00002610#endif
dan02fa4692009-08-17 17:06:58 +00002611 assert( pLower || pUpper );
drh4e50c5e2011-08-13 19:35:19 +00002612 *pRangeDiv = (double)1;
2613 if( pLower && (pLower->wtFlags & TERM_VNULL)==0 ) *pRangeDiv *= (double)4;
2614 if( pUpper ) *pRangeDiv *= (double)4;
dan02fa4692009-08-17 17:06:58 +00002615 return rc;
2616}
2617
drhfaacf172011-08-12 01:51:45 +00002618#ifdef SQLITE_ENABLE_STAT3
drh82759752011-01-20 16:52:09 +00002619/*
2620** Estimate the number of rows that will be returned based on
2621** an equality constraint x=VALUE and where that VALUE occurs in
2622** the histogram data. This only works when x is the left-most
drhfaacf172011-08-12 01:51:45 +00002623** column of an index and sqlite_stat3 histogram data is available
drhac8eb112011-03-17 01:58:21 +00002624** for that index. When pExpr==NULL that means the constraint is
2625** "x IS NULL" instead of "x=VALUE".
drh82759752011-01-20 16:52:09 +00002626**
drh0c50fa02011-01-21 16:27:18 +00002627** Write the estimated row count into *pnRow and return SQLITE_OK.
2628** If unable to make an estimate, leave *pnRow unchanged and return
2629** non-zero.
drh9b3eb0a2011-01-21 14:37:04 +00002630**
2631** This routine can fail if it is unable to load a collating sequence
2632** required for string comparison, or if unable to allocate memory
2633** for a UTF conversion required for comparison. The error is stored
2634** in the pParse structure.
drh82759752011-01-20 16:52:09 +00002635*/
drh041e09f2011-04-07 19:56:21 +00002636static int whereEqualScanEst(
drh82759752011-01-20 16:52:09 +00002637 Parse *pParse, /* Parsing & code generating context */
2638 Index *p, /* The index whose left-most column is pTerm */
drh0c50fa02011-01-21 16:27:18 +00002639 Expr *pExpr, /* Expression for VALUE in the x=VALUE constraint */
drh82759752011-01-20 16:52:09 +00002640 double *pnRow /* Write the revised row estimate here */
2641){
2642 sqlite3_value *pRhs = 0; /* VALUE on right-hand side of pTerm */
drh82759752011-01-20 16:52:09 +00002643 u8 aff; /* Column affinity */
2644 int rc; /* Subfunction return code */
drhfaacf172011-08-12 01:51:45 +00002645 tRowcnt a[2]; /* Statistics */
drh82759752011-01-20 16:52:09 +00002646
2647 assert( p->aSample!=0 );
drh5c624862011-09-22 18:46:34 +00002648 assert( p->nSample>0 );
drh82759752011-01-20 16:52:09 +00002649 aff = p->pTable->aCol[p->aiColumn[0]].affinity;
drh1f9c7662011-03-17 01:34:26 +00002650 if( pExpr ){
2651 rc = valueFromExpr(pParse, pExpr, aff, &pRhs);
2652 if( rc ) goto whereEqualScanEst_cancel;
2653 }else{
2654 pRhs = sqlite3ValueNew(pParse->db);
2655 }
drh0c50fa02011-01-21 16:27:18 +00002656 if( pRhs==0 ) return SQLITE_NOTFOUND;
drhfaacf172011-08-12 01:51:45 +00002657 rc = whereKeyStats(pParse, p, pRhs, 0, a);
2658 if( rc==SQLITE_OK ){
2659 WHERETRACE(("equality scan regions: %d\n", (int)a[1]));
2660 *pnRow = a[1];
drh82759752011-01-20 16:52:09 +00002661 }
drh0c50fa02011-01-21 16:27:18 +00002662whereEqualScanEst_cancel:
drh82759752011-01-20 16:52:09 +00002663 sqlite3ValueFree(pRhs);
drh0c50fa02011-01-21 16:27:18 +00002664 return rc;
2665}
drhfaacf172011-08-12 01:51:45 +00002666#endif /* defined(SQLITE_ENABLE_STAT3) */
drh0c50fa02011-01-21 16:27:18 +00002667
drhfaacf172011-08-12 01:51:45 +00002668#ifdef SQLITE_ENABLE_STAT3
drh0c50fa02011-01-21 16:27:18 +00002669/*
2670** Estimate the number of rows that will be returned based on
drh5ac06072011-01-21 18:18:13 +00002671** an IN constraint where the right-hand side of the IN operator
2672** is a list of values. Example:
2673**
2674** WHERE x IN (1,2,3,4)
drh0c50fa02011-01-21 16:27:18 +00002675**
2676** Write the estimated row count into *pnRow and return SQLITE_OK.
2677** If unable to make an estimate, leave *pnRow unchanged and return
2678** non-zero.
2679**
2680** This routine can fail if it is unable to load a collating sequence
2681** required for string comparison, or if unable to allocate memory
2682** for a UTF conversion required for comparison. The error is stored
2683** in the pParse structure.
2684*/
drh041e09f2011-04-07 19:56:21 +00002685static int whereInScanEst(
drh0c50fa02011-01-21 16:27:18 +00002686 Parse *pParse, /* Parsing & code generating context */
2687 Index *p, /* The index whose left-most column is pTerm */
2688 ExprList *pList, /* The value list on the RHS of "x IN (v1,v2,v3,...)" */
2689 double *pnRow /* Write the revised row estimate here */
2690){
drh68257192011-08-16 17:06:21 +00002691 int rc = SQLITE_OK; /* Subfunction return code */
2692 double nEst; /* Number of rows for a single term */
2693 double nRowEst = (double)0; /* New estimate of the number of rows */
2694 int i; /* Loop counter */
drh0c50fa02011-01-21 16:27:18 +00002695
2696 assert( p->aSample!=0 );
drhfaacf172011-08-12 01:51:45 +00002697 for(i=0; rc==SQLITE_OK && i<pList->nExpr; i++){
2698 nEst = p->aiRowEst[0];
2699 rc = whereEqualScanEst(pParse, p, pList->a[i].pExpr, &nEst);
2700 nRowEst += nEst;
drh0c50fa02011-01-21 16:27:18 +00002701 }
2702 if( rc==SQLITE_OK ){
drh0c50fa02011-01-21 16:27:18 +00002703 if( nRowEst > p->aiRowEst[0] ) nRowEst = p->aiRowEst[0];
2704 *pnRow = nRowEst;
drhfaacf172011-08-12 01:51:45 +00002705 WHERETRACE(("IN row estimate: est=%g\n", nRowEst));
drh0c50fa02011-01-21 16:27:18 +00002706 }
drh0c50fa02011-01-21 16:27:18 +00002707 return rc;
drh82759752011-01-20 16:52:09 +00002708}
drhfaacf172011-08-12 01:51:45 +00002709#endif /* defined(SQLITE_ENABLE_STAT3) */
drh82759752011-01-20 16:52:09 +00002710
drh46c35f92012-09-26 23:17:01 +00002711/*
drh32634d22012-09-27 14:11:36 +00002712** Check to see if column iCol of the table with cursor iTab will appear
drh8e4af1b2012-10-08 18:23:51 +00002713** in sorted order according to the current query plan.
drh32634d22012-09-27 14:11:36 +00002714**
drh8e4af1b2012-10-08 18:23:51 +00002715** Return values:
2716**
2717** 0 iCol is not ordered
2718** 1 iCol has only a single value
2719** 2 iCol is in ASC order
2720** 3 iCol is in DESC order
drh32634d22012-09-27 14:11:36 +00002721*/
drh8e4af1b2012-10-08 18:23:51 +00002722static int isOrderedColumn(
2723 WhereBestIdx *p,
2724 int iTab,
2725 int iCol
2726){
drh32634d22012-09-27 14:11:36 +00002727 int i, j;
2728 WhereLevel *pLevel = &p->aLevel[p->i-1];
2729 Index *pIdx;
2730 u8 sortOrder;
2731 for(i=p->i-1; i>=0; i--, pLevel--){
2732 if( pLevel->iTabCur!=iTab ) continue;
drh60441af2012-09-29 19:10:29 +00002733 if( (pLevel->plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
2734 return 1;
2735 }
drh69a76ba2012-10-09 01:23:25 +00002736 assert( (pLevel->plan.wsFlags & WHERE_ORDERED)!=0 );
drhd663b5b2012-10-03 00:25:54 +00002737 if( (pIdx = pLevel->plan.u.pIdx)!=0 ){
drh6b10a6a2012-09-27 17:31:32 +00002738 if( iCol<0 ){
2739 sortOrder = 0;
2740 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
2741 }else{
drhafcd5222012-10-02 15:19:19 +00002742 int n = pIdx->nColumn;
drh178eb612012-10-02 14:11:29 +00002743 for(j=0; j<n; j++){
drh6b10a6a2012-09-27 17:31:32 +00002744 if( iCol==pIdx->aiColumn[j] ) break;
2745 }
drh178eb612012-10-02 14:11:29 +00002746 if( j>=n ) return 0;
drh6b10a6a2012-09-27 17:31:32 +00002747 sortOrder = pIdx->aSortOrder[j];
2748 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
drh32634d22012-09-27 14:11:36 +00002749 }
drh32634d22012-09-27 14:11:36 +00002750 }else{
2751 if( iCol!=(-1) ) return 0;
2752 sortOrder = 0;
drh6b10a6a2012-09-27 17:31:32 +00002753 testcase( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 );
drh32634d22012-09-27 14:11:36 +00002754 }
drh6b10a6a2012-09-27 17:31:32 +00002755 if( (pLevel->plan.wsFlags & WHERE_REVERSE)!=0 ){
2756 assert( sortOrder==0 || sortOrder==1 );
2757 testcase( sortOrder==1 );
2758 sortOrder = 1 - sortOrder;
2759 }
drh8e4af1b2012-10-08 18:23:51 +00002760 return sortOrder+2;
drh32634d22012-09-27 14:11:36 +00002761 }
2762 return 0;
2763}
2764
2765/*
drh60441af2012-09-29 19:10:29 +00002766** This routine decides if pIdx can be used to satisfy the ORDER BY
2767** clause, either in whole or in part. The return value is the
2768** cumulative number of terms in the ORDER BY clause that are satisfied
2769** by the index pIdx and other indices in outer loops.
2770**
2771** The table being queried has a cursor number of "base". pIdx is the
2772** index that is postulated for use to access the table.
2773**
2774** nEqCol is the number of columns of pIdx that are used as equality
2775** constraints and where the other side of the == is an ordered column
2776** or constant. An "order column" in the previous sentence means a column
2777** in table from an outer loop whose values will always appear in the
2778** correct order due to othre index, or because the outer loop generates
2779** a unique result. Any of the first nEqCol columns of pIdx may be missing
2780** from the ORDER BY clause and the match can still be a success.
2781**
2782** The *pbRev value is set to 0 order 1 depending on whether or not
2783** pIdx should be run in the forward order or in reverse order.
2784*/
2785static int isSortingIndex(
2786 WhereBestIdx *p, /* Best index search context */
2787 Index *pIdx, /* The index we are testing */
2788 int base, /* Cursor number for the table to be sorted */
drh60441af2012-09-29 19:10:29 +00002789 int *pbRev /* Set to 1 for reverse-order scan of pIdx */
2790){
2791 int i; /* Number of pIdx terms used */
2792 int j; /* Number of ORDER BY terms satisfied */
drh4f68d6c2012-10-04 12:10:25 +00002793 int sortOrder = 2; /* 0: forward. 1: backward. 2: unknown */
drh60441af2012-09-29 19:10:29 +00002794 int nTerm; /* Number of ORDER BY terms */
drh8e4af1b2012-10-08 18:23:51 +00002795 struct ExprList_item *pOBItem;/* A term of the ORDER BY clause */
drh4f68d6c2012-10-04 12:10:25 +00002796 Table *pTab = pIdx->pTable; /* Table that owns index pIdx */
drh60441af2012-09-29 19:10:29 +00002797 ExprList *pOrderBy; /* The ORDER BY clause */
2798 Parse *pParse = p->pParse; /* Parser context */
2799 sqlite3 *db = pParse->db; /* Database connection */
2800 int nPriorSat; /* ORDER BY terms satisfied by outer loops */
2801 int seenRowid = 0; /* True if an ORDER BY rowid term is seen */
drh0a4c7412012-10-08 19:41:38 +00002802 int uniqueNotNull; /* pIdx is UNIQUE with all terms are NOT NULL */
drh60441af2012-09-29 19:10:29 +00002803
2804 if( p->i==0 ){
2805 nPriorSat = 0;
2806 }else{
2807 nPriorSat = p->aLevel[p->i-1].plan.nOBSat;
drh0a4c7412012-10-08 19:41:38 +00002808 if( (p->aLevel[p->i-1].plan.wsFlags & WHERE_ORDERED)==0 ){
2809 /* This loop cannot be ordered unless the next outer loop is
2810 ** also ordered */
drhd663b5b2012-10-03 00:25:54 +00002811 return nPriorSat;
2812 }
drh0a4c7412012-10-08 19:41:38 +00002813 if( OptimizationDisabled(db, SQLITE_OrderByIdxJoin) ){
2814 /* Only look at the outer-most loop if the OrderByIdxJoin
2815 ** optimization is disabled */
2816 return nPriorSat;
2817 }
drh60441af2012-09-29 19:10:29 +00002818 }
2819 pOrderBy = p->pOrderBy;
2820 assert( pOrderBy!=0 );
drh0a4c7412012-10-08 19:41:38 +00002821 if( pIdx->bUnordered ){
2822 /* Hash indices (indicated by the "unordered" tag on sqlite_stat1) cannot
2823 ** be used for sorting */
2824 return nPriorSat;
2825 }
drh60441af2012-09-29 19:10:29 +00002826 nTerm = pOrderBy->nExpr;
drh8e4af1b2012-10-08 18:23:51 +00002827 uniqueNotNull = pIdx->onError!=OE_None;
drh60441af2012-09-29 19:10:29 +00002828 assert( nTerm>0 );
2829
2830 /* Argument pIdx must either point to a 'real' named index structure,
2831 ** or an index structure allocated on the stack by bestBtreeIndex() to
2832 ** represent the rowid index that is part of every table. */
2833 assert( pIdx->zName || (pIdx->nColumn==1 && pIdx->aiColumn[0]==-1) );
2834
2835 /* Match terms of the ORDER BY clause against columns of
2836 ** the index.
2837 **
2838 ** Note that indices have pIdx->nColumn regular columns plus
2839 ** one additional column containing the rowid. The rowid column
2840 ** of the index is also allowed to match against the ORDER BY
2841 ** clause.
2842 */
drh8e4af1b2012-10-08 18:23:51 +00002843 j = nPriorSat;
2844 for(i=0,pOBItem=&pOrderBy->a[j]; j<nTerm && i<=pIdx->nColumn; i++){
2845 Expr *pOBExpr; /* The expression of the ORDER BY pOBItem */
2846 CollSeq *pColl; /* The collating sequence of pOBExpr */
2847 int termSortOrder; /* Sort order for this term */
2848 int iColumn; /* The i-th column of the index. -1 for rowid */
2849 int iSortOrder; /* 1 for DESC, 0 for ASC on the i-th index term */
2850 int isEq; /* Subject to an == or IS NULL constraint */
2851 int isMatch; /* ORDER BY term matches the index term */
2852 const char *zColl; /* Name of collating sequence for i-th index term */
2853 WhereTerm *pConstraint; /* A constraint in the WHERE clause */
drh60441af2012-09-29 19:10:29 +00002854
drh8e4af1b2012-10-08 18:23:51 +00002855 /* If the next term of the ORDER BY clause refers to anything other than
2856 ** a column in the "base" table, then this index will not be of any
2857 ** further use in handling the ORDER BY. */
2858 pOBExpr = pOBItem->pExpr;
2859 if( pOBExpr->op!=TK_COLUMN || pOBExpr->iTable!=base ){
drh60441af2012-09-29 19:10:29 +00002860 break;
2861 }
drh8e4af1b2012-10-08 18:23:51 +00002862
2863 /* Find column number and collating sequence for the next entry
2864 ** in the index */
drh60441af2012-09-29 19:10:29 +00002865 if( pIdx->zName && i<pIdx->nColumn ){
2866 iColumn = pIdx->aiColumn[i];
2867 if( iColumn==pIdx->pTable->iPKey ){
2868 iColumn = -1;
2869 }
2870 iSortOrder = pIdx->aSortOrder[i];
2871 zColl = pIdx->azColl[i];
drh8e4af1b2012-10-08 18:23:51 +00002872 assert( zColl!=0 );
drh60441af2012-09-29 19:10:29 +00002873 }else{
2874 iColumn = -1;
2875 iSortOrder = 0;
drh8e4af1b2012-10-08 18:23:51 +00002876 zColl = 0;
drh60441af2012-09-29 19:10:29 +00002877 }
drh8e4af1b2012-10-08 18:23:51 +00002878
2879 /* Check to see if the column number and collating sequence of the
2880 ** index match the column number and collating sequence of the ORDER BY
2881 ** clause entry. Set isMatch to 1 if they both match. */
2882 if( pOBExpr->iColumn==iColumn ){
2883 if( zColl ){
2884 pColl = sqlite3ExprCollSeq(pParse, pOBExpr);
2885 if( !pColl ) pColl = db->pDfltColl;
2886 isMatch = sqlite3StrICmp(pColl->zName, zColl)==0;
drh60441af2012-09-29 19:10:29 +00002887 }else{
drh8e4af1b2012-10-08 18:23:51 +00002888 isMatch = 1;
drh60441af2012-09-29 19:10:29 +00002889 }
2890 }else{
drh8e4af1b2012-10-08 18:23:51 +00002891 isMatch = 0;
2892 }
2893
2894 /* termSortOrder is 0 or 1 for whether or not the access loop should
2895 ** run forward or backwards (respectively) in order to satisfy this
2896 ** term of the ORDER BY clause. */
2897 termSortOrder = iSortOrder ^ pOBItem->sortOrder;
2898
2899 /* If X is the column in the index and ORDER BY clause, check to see
2900 ** if there are any X= or X IS NULL constraints in the WHERE clause. */
2901 pConstraint = findTerm(p->pWC, base, iColumn, p->notReady,
2902 WO_EQ|WO_ISNULL|WO_IN, pIdx);
2903 if( pConstraint==0 ){
2904 isEq = 0;
2905 }else if( pConstraint->eOperator==WO_IN ){
2906 break;
drh8e4af1b2012-10-08 18:23:51 +00002907 }else if( pConstraint->eOperator==WO_ISNULL ){
2908 uniqueNotNull = 0;
2909 isEq = 1;
drh6b9e5652012-10-08 20:27:35 +00002910 }else if( pConstraint->prereqRight==0 ){
2911 isEq = 1;
drh8e4af1b2012-10-08 18:23:51 +00002912 }else{
2913 Expr *pRight = pConstraint->pExpr->pRight;
2914 if( pRight->op==TK_COLUMN ){
2915 WHERETRACE((" .. isOrderedColumn(tab=%d,col=%d)",
2916 pRight->iTable, pRight->iColumn));
2917 isEq = isOrderedColumn(p, pRight->iTable, pRight->iColumn);
2918 WHERETRACE((" -> isEq=%d\n", isEq));
drh2fad8152012-10-08 21:01:15 +00002919 if( isMatch && isEq>=2 && isEq!=pOBItem->sortOrder+2 ){
drh8e4af1b2012-10-08 18:23:51 +00002920 break;
2921 }
2922 }else{
2923 isEq = 0;
2924 }
2925 }
2926 assert( pOBItem->sortOrder==0 || pOBItem->sortOrder==1 );
2927 assert( iSortOrder==0 || iSortOrder==1 );
2928 if( !isMatch ){
2929 if( isEq==0 ){
2930 break;
2931 }else{
2932 continue;
2933 }
drh6b9e5652012-10-08 20:27:35 +00002934 }else if( isEq!=1 ){
2935 if( sortOrder==2 ){
2936 sortOrder = termSortOrder;
2937 }else if( termSortOrder!=sortOrder ){
2938 break;
2939 }
drh60441af2012-09-29 19:10:29 +00002940 }
2941 j++;
drh8e4af1b2012-10-08 18:23:51 +00002942 pOBItem++;
drh60441af2012-09-29 19:10:29 +00002943 if( iColumn<0 ){
2944 seenRowid = 1;
2945 break;
drh6b9e5652012-10-08 20:27:35 +00002946 }else if( pTab->aCol[iColumn].notNull==0 && isEq==0 ){
drh4f68d6c2012-10-04 12:10:25 +00002947 uniqueNotNull = 0;
drh60441af2012-09-29 19:10:29 +00002948 }
2949 }
drh0a4c7412012-10-08 19:41:38 +00002950
2951 /* If we have not found at least one ORDER BY term that matches the
2952 ** index, then show no progress. */
2953 if( pOBItem==&pOrderBy->a[nPriorSat] ) return nPriorSat;
2954
2955 /* Return the necessary scan order back to the caller */
drh4f68d6c2012-10-04 12:10:25 +00002956 *pbRev = sortOrder & 1;
drh60441af2012-09-29 19:10:29 +00002957
2958 /* If there was an "ORDER BY rowid" term that matched, or it is only
2959 ** possible for a single row from this table to match, then skip over
2960 ** any additional ORDER BY terms dealing with this table.
2961 */
drh4f68d6c2012-10-04 12:10:25 +00002962 if( seenRowid || (uniqueNotNull && i>=pIdx->nColumn) ){
drh60441af2012-09-29 19:10:29 +00002963 /* Advance j over additional ORDER BY terms associated with base */
2964 WhereMaskSet *pMS = p->pWC->pMaskSet;
2965 Bitmask m = ~getMask(pMS, base);
2966 while( j<nTerm && (exprTableUsage(pMS, pOrderBy->a[j].pExpr)&m)==0 ){
2967 j++;
2968 }
2969 }
2970 return j;
2971}
dan02fa4692009-08-17 17:06:58 +00002972
2973/*
drh083310d2011-01-28 01:57:41 +00002974** Find the best query plan for accessing a particular table. Write the
drh56f1b992012-09-25 14:29:39 +00002975** best query plan and its cost into the p->cost.
drh51147ba2005-07-23 22:59:55 +00002976**
drh111a6a72008-12-21 03:51:16 +00002977** The lowest cost plan wins. The cost is an estimate of the amount of
drh083310d2011-01-28 01:57:41 +00002978** CPU and disk I/O needed to process the requested result.
drh51147ba2005-07-23 22:59:55 +00002979** Factors that influence cost include:
2980**
2981** * The estimated number of rows that will be retrieved. (The
2982** fewer the better.)
2983**
2984** * Whether or not sorting must occur.
2985**
2986** * Whether or not there must be separate lookups in the
2987** index and in the main table.
2988**
danielk1977e2d7b242009-02-23 17:33:49 +00002989** If there was an INDEXED BY clause (pSrc->pIndex) attached to the table in
2990** the SQL statement, then this function only considers plans using the
drh296a4832009-03-22 20:36:18 +00002991** named index. If no such plan is found, then the returned cost is
2992** SQLITE_BIG_DBL. If a plan is found that uses the named index,
danielk197785574e32008-10-06 05:32:18 +00002993** then the cost is calculated in the usual way.
2994**
danielk1977e2d7b242009-02-23 17:33:49 +00002995** If a NOT INDEXED clause (pSrc->notIndexed!=0) was attached to the table
2996** in the SELECT statement, then no indexes are considered. However, the
drh083310d2011-01-28 01:57:41 +00002997** selected plan may still take advantage of the built-in rowid primary key
danielk197785574e32008-10-06 05:32:18 +00002998** index.
drhfe05af82005-07-21 03:14:59 +00002999*/
drh56f1b992012-09-25 14:29:39 +00003000static void bestBtreeIndex(WhereBestIdx *p){
3001 Parse *pParse = p->pParse; /* The parsing context */
3002 WhereClause *pWC = p->pWC; /* The WHERE clause */
3003 struct SrcList_item *pSrc = p->pSrc; /* The FROM clause term to search */
drh51147ba2005-07-23 22:59:55 +00003004 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
3005 Index *pProbe; /* An index we are evaluating */
dan5236ac12009-08-13 07:09:33 +00003006 Index *pIdx; /* Copy of pProbe, or zero for IPK index */
3007 int eqTermMask; /* Current mask of valid equality operators */
3008 int idxEqTermMask; /* Index mask of valid equality operators */
drhcdaca552009-08-20 13:45:07 +00003009 Index sPk; /* A fake index object for the primary key */
drhfaacf172011-08-12 01:51:45 +00003010 tRowcnt aiRowEstPk[2]; /* The aiRowEst[] value for the sPk index */
drhcdaca552009-08-20 13:45:07 +00003011 int aiColumnPk = -1; /* The aColumn[] value for the sPk index */
drh56f1b992012-09-25 14:29:39 +00003012 int wsFlagMask; /* Allowed flags in p->cost.plan.wsFlag */
drhfe05af82005-07-21 03:14:59 +00003013
drhcdaca552009-08-20 13:45:07 +00003014 /* Initialize the cost to a worst-case value */
drh56f1b992012-09-25 14:29:39 +00003015 memset(&p->cost, 0, sizeof(p->cost));
3016 p->cost.rCost = SQLITE_BIG_DBL;
drh51147ba2005-07-23 22:59:55 +00003017
drhc49de5d2007-01-19 01:06:01 +00003018 /* If the pSrc table is the right table of a LEFT JOIN then we may not
3019 ** use an index to satisfy IS NULL constraints on that table. This is
3020 ** because columns might end up being NULL if the table does not match -
3021 ** a circumstance which the index cannot help us discover. Ticket #2177.
3022 */
dan5236ac12009-08-13 07:09:33 +00003023 if( pSrc->jointype & JT_LEFT ){
3024 idxEqTermMask = WO_EQ|WO_IN;
drhc49de5d2007-01-19 01:06:01 +00003025 }else{
dan5236ac12009-08-13 07:09:33 +00003026 idxEqTermMask = WO_EQ|WO_IN|WO_ISNULL;
drhc49de5d2007-01-19 01:06:01 +00003027 }
3028
danielk197785574e32008-10-06 05:32:18 +00003029 if( pSrc->pIndex ){
drhcdaca552009-08-20 13:45:07 +00003030 /* An INDEXED BY clause specifies a particular index to use */
dan5236ac12009-08-13 07:09:33 +00003031 pIdx = pProbe = pSrc->pIndex;
3032 wsFlagMask = ~(WHERE_ROWID_EQ|WHERE_ROWID_RANGE);
3033 eqTermMask = idxEqTermMask;
3034 }else{
drh083310d2011-01-28 01:57:41 +00003035 /* There is no INDEXED BY clause. Create a fake Index object in local
3036 ** variable sPk to represent the rowid primary key index. Make this
3037 ** fake index the first in a chain of Index objects with all of the real
3038 ** indices to follow */
3039 Index *pFirst; /* First of real indices on the table */
drhcdaca552009-08-20 13:45:07 +00003040 memset(&sPk, 0, sizeof(Index));
3041 sPk.nColumn = 1;
3042 sPk.aiColumn = &aiColumnPk;
3043 sPk.aiRowEst = aiRowEstPk;
drhcdaca552009-08-20 13:45:07 +00003044 sPk.onError = OE_Replace;
3045 sPk.pTable = pSrc->pTab;
drh15564052010-09-25 22:32:56 +00003046 aiRowEstPk[0] = pSrc->pTab->nRowEst;
3047 aiRowEstPk[1] = 1;
drhcdaca552009-08-20 13:45:07 +00003048 pFirst = pSrc->pTab->pIndex;
dan5236ac12009-08-13 07:09:33 +00003049 if( pSrc->notIndexed==0 ){
drh083310d2011-01-28 01:57:41 +00003050 /* The real indices of the table are only considered if the
3051 ** NOT INDEXED qualifier is omitted from the FROM clause */
drhcdaca552009-08-20 13:45:07 +00003052 sPk.pNext = pFirst;
dan5236ac12009-08-13 07:09:33 +00003053 }
drhcdaca552009-08-20 13:45:07 +00003054 pProbe = &sPk;
dan5236ac12009-08-13 07:09:33 +00003055 wsFlagMask = ~(
3056 WHERE_COLUMN_IN|WHERE_COLUMN_EQ|WHERE_COLUMN_NULL|WHERE_COLUMN_RANGE
3057 );
3058 eqTermMask = WO_EQ|WO_IN;
3059 pIdx = 0;
danielk197785574e32008-10-06 05:32:18 +00003060 }
drh51147ba2005-07-23 22:59:55 +00003061
drhcdaca552009-08-20 13:45:07 +00003062 /* Loop over all indices looking for the best one to use
3063 */
dan5236ac12009-08-13 07:09:33 +00003064 for(; pProbe; pIdx=pProbe=pProbe->pNext){
drhfaacf172011-08-12 01:51:45 +00003065 const tRowcnt * const aiRowEst = pProbe->aiRowEst;
drhd663b5b2012-10-03 00:25:54 +00003066 WhereCost pc; /* Cost of using pProbe */
drh93c63842011-09-22 00:28:55 +00003067 double log10N = (double)1; /* base-10 logarithm of nRow (inexact) */
drh8e4af1b2012-10-08 18:23:51 +00003068
dan5236ac12009-08-13 07:09:33 +00003069 /* The following variables are populated based on the properties of
drh083310d2011-01-28 01:57:41 +00003070 ** index being evaluated. They are then used to determine the expected
dan5236ac12009-08-13 07:09:33 +00003071 ** cost and number of rows returned.
3072 **
drhd663b5b2012-10-03 00:25:54 +00003073 ** pc.plan.nEq:
dan5236ac12009-08-13 07:09:33 +00003074 ** Number of equality terms that can be implemented using the index.
drh083310d2011-01-28 01:57:41 +00003075 ** In other words, the number of initial fields in the index that
3076 ** are used in == or IN or NOT NULL constraints of the WHERE clause.
dan5236ac12009-08-13 07:09:33 +00003077 **
3078 ** nInMul:
3079 ** The "in-multiplier". This is an estimate of how many seek operations
3080 ** SQLite must perform on the index in question. For example, if the
3081 ** WHERE clause is:
3082 **
3083 ** WHERE a IN (1, 2, 3) AND b IN (4, 5, 6)
3084 **
3085 ** SQLite must perform 9 lookups on an index on (a, b), so nInMul is
3086 ** set to 9. Given the same schema and either of the following WHERE
3087 ** clauses:
3088 **
3089 ** WHERE a = 1
3090 ** WHERE a >= 2
3091 **
3092 ** nInMul is set to 1.
3093 **
3094 ** If there exists a WHERE term of the form "x IN (SELECT ...)", then
3095 ** the sub-select is assumed to return 25 rows for the purposes of
3096 ** determining nInMul.
3097 **
3098 ** bInEst:
3099 ** Set to true if there was at least one "x IN (SELECT ...)" term used
drh083310d2011-01-28 01:57:41 +00003100 ** in determining the value of nInMul. Note that the RHS of the
3101 ** IN operator must be a SELECT, not a value list, for this variable
3102 ** to be true.
dan5236ac12009-08-13 07:09:33 +00003103 **
drhfaacf172011-08-12 01:51:45 +00003104 ** rangeDiv:
3105 ** An estimate of a divisor by which to reduce the search space due
3106 ** to inequality constraints. In the absence of sqlite_stat3 ANALYZE
3107 ** data, a single inequality reduces the search space to 1/4rd its
3108 ** original size (rangeDiv==4). Two inequalities reduce the search
3109 ** space to 1/16th of its original size (rangeDiv==16).
dan5236ac12009-08-13 07:09:33 +00003110 **
3111 ** bSort:
3112 ** Boolean. True if there is an ORDER BY clause that will require an
3113 ** external sort (i.e. scanning the index being evaluated will not
3114 ** correctly order records).
3115 **
drh04b85bc2012-10-01 17:44:05 +00003116 ** bDist:
drh46c35f92012-09-26 23:17:01 +00003117 ** Boolean. True if there is a DISTINCT clause that will require an
3118 ** external btree.
3119 **
dan5236ac12009-08-13 07:09:33 +00003120 ** bLookup:
drh083310d2011-01-28 01:57:41 +00003121 ** Boolean. True if a table lookup is required for each index entry
3122 ** visited. In other words, true if this is not a covering index.
3123 ** This is always false for the rowid primary key index of a table.
3124 ** For other indexes, it is true unless all the columns of the table
3125 ** used by the SELECT statement are present in the index (such an
3126 ** index is sometimes described as a covering index).
dan5236ac12009-08-13 07:09:33 +00003127 ** For example, given the index on (a, b), the second of the following
drh083310d2011-01-28 01:57:41 +00003128 ** two queries requires table b-tree lookups in order to find the value
3129 ** of column c, but the first does not because columns a and b are
3130 ** both available in the index.
dan5236ac12009-08-13 07:09:33 +00003131 **
3132 ** SELECT a, b FROM tbl WHERE a = 1;
3133 ** SELECT a, b, c FROM tbl WHERE a = 1;
drhfe05af82005-07-21 03:14:59 +00003134 */
drh083310d2011-01-28 01:57:41 +00003135 int bInEst = 0; /* True if "x IN (SELECT...)" seen */
3136 int nInMul = 1; /* Number of distinct equalities to lookup */
drh4e50c5e2011-08-13 19:35:19 +00003137 double rangeDiv = (double)1; /* Estimated reduction in search space */
drh82759752011-01-20 16:52:09 +00003138 int nBound = 0; /* Number of range constraints seen */
drh9cd1c992012-09-25 20:43:35 +00003139 int bSort; /* True if external sort required */
3140 int bDist; /* True if index cannot help with DISTINCT */
drh083310d2011-01-28 01:57:41 +00003141 int bLookup = 0; /* True if not a covering index */
drhd663b5b2012-10-03 00:25:54 +00003142 int nPriorSat; /* ORDER BY terms satisfied by outer loops */
drh46c35f92012-09-26 23:17:01 +00003143 int nOrderBy; /* Number of ORDER BY terms */
drh82759752011-01-20 16:52:09 +00003144 WhereTerm *pTerm; /* A single term of the WHERE clause */
drhfaacf172011-08-12 01:51:45 +00003145#ifdef SQLITE_ENABLE_STAT3
drh0c50fa02011-01-21 16:27:18 +00003146 WhereTerm *pFirstTerm = 0; /* First term matching the index */
drh82759752011-01-20 16:52:09 +00003147#endif
dan5236ac12009-08-13 07:09:33 +00003148
drh86257ff2012-10-09 01:39:25 +00003149 WHERETRACE((
3150 " %s(%s):\n",
3151 pSrc->pTab->zName, (pIdx ? pIdx->zName : "ipk")
3152 ));
drh613a53a2012-10-03 18:09:32 +00003153 memset(&pc, 0, sizeof(pc));
drh46c35f92012-09-26 23:17:01 +00003154 nOrderBy = p->pOrderBy ? p->pOrderBy->nExpr : 0;
drhd663b5b2012-10-03 00:25:54 +00003155 if( p->i ){
3156 nPriorSat = pc.plan.nOBSat = p->aLevel[p->i-1].plan.nOBSat;
3157 bSort = nPriorSat<nOrderBy;
3158 bDist = 0;
3159 }else{
3160 nPriorSat = pc.plan.nOBSat = 0;
3161 bSort = nOrderBy>0;
3162 bDist = p->pDistinct!=0;
3163 }
drh9cd1c992012-09-25 20:43:35 +00003164
drhd663b5b2012-10-03 00:25:54 +00003165 /* Determine the values of pc.plan.nEq and nInMul */
drh4f68d6c2012-10-04 12:10:25 +00003166 for(pc.plan.nEq=0; pc.plan.nEq<pProbe->nColumn; pc.plan.nEq++){
drhd663b5b2012-10-03 00:25:54 +00003167 int j = pProbe->aiColumn[pc.plan.nEq];
drh56f1b992012-09-25 14:29:39 +00003168 pTerm = findTerm(pWC, iCur, j, p->notReady, eqTermMask, pIdx);
drhfe05af82005-07-21 03:14:59 +00003169 if( pTerm==0 ) break;
drhd663b5b2012-10-03 00:25:54 +00003170 pc.plan.wsFlags |= (WHERE_COLUMN_EQ|WHERE_ROWID_EQ);
drh0a61df62011-10-07 17:45:58 +00003171 testcase( pTerm->pWC!=pWC );
drhb52076c2006-01-23 13:22:09 +00003172 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00003173 Expr *pExpr = pTerm->pExpr;
drhd663b5b2012-10-03 00:25:54 +00003174 pc.plan.wsFlags |= WHERE_COLUMN_IN;
danielk19776ab3a2e2009-02-19 14:39:25 +00003175 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drh9b3eb0a2011-01-21 14:37:04 +00003176 /* "x IN (SELECT ...)": Assume the SELECT returns 25 rows */
dan5236ac12009-08-13 07:09:33 +00003177 nInMul *= 25;
3178 bInEst = 1;
drh083310d2011-01-28 01:57:41 +00003179 }else if( ALWAYS(pExpr->x.pList && pExpr->x.pList->nExpr) ){
drh9b3eb0a2011-01-21 14:37:04 +00003180 /* "x IN (value, value, ...)" */
drh083310d2011-01-28 01:57:41 +00003181 nInMul *= pExpr->x.pList->nExpr;
drhfe05af82005-07-21 03:14:59 +00003182 }
drh46619d62009-04-24 14:51:42 +00003183 }else if( pTerm->eOperator & WO_ISNULL ){
drhd663b5b2012-10-03 00:25:54 +00003184 pc.plan.wsFlags |= WHERE_COLUMN_NULL;
drhfe05af82005-07-21 03:14:59 +00003185 }
drhfaacf172011-08-12 01:51:45 +00003186#ifdef SQLITE_ENABLE_STAT3
drhd663b5b2012-10-03 00:25:54 +00003187 if( pc.plan.nEq==0 && pProbe->aSample ) pFirstTerm = pTerm;
drh82759752011-01-20 16:52:09 +00003188#endif
drhd663b5b2012-10-03 00:25:54 +00003189 pc.used |= pTerm->prereqRight;
drhfe05af82005-07-21 03:14:59 +00003190 }
dan0c733f62011-11-16 15:27:09 +00003191
3192 /* If the index being considered is UNIQUE, and there is an equality
3193 ** constraint for all columns in the index, then this search will find
3194 ** at most a single row. In this case set the WHERE_UNIQUE flag to
3195 ** indicate this to the caller.
3196 **
3197 ** Otherwise, if the search may find more than one row, test to see if
drhd663b5b2012-10-03 00:25:54 +00003198 ** there is a range constraint on indexed column (pc.plan.nEq+1) that can be
dan0c733f62011-11-16 15:27:09 +00003199 ** optimized using the index.
3200 */
drhd663b5b2012-10-03 00:25:54 +00003201 if( pc.plan.nEq==pProbe->nColumn && pProbe->onError!=OE_None ){
3202 testcase( pc.plan.wsFlags & WHERE_COLUMN_IN );
3203 testcase( pc.plan.wsFlags & WHERE_COLUMN_NULL );
3204 if( (pc.plan.wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_NULL))==0 ){
3205 pc.plan.wsFlags |= WHERE_UNIQUE;
drh60441af2012-09-29 19:10:29 +00003206 if( p->i==0 || (p->aLevel[p->i-1].plan.wsFlags & WHERE_ALL_UNIQUE)!=0 ){
drhd663b5b2012-10-03 00:25:54 +00003207 pc.plan.wsFlags |= WHERE_ALL_UNIQUE;
drh60441af2012-09-29 19:10:29 +00003208 }
dan0c733f62011-11-16 15:27:09 +00003209 }
3210 }else if( pProbe->bUnordered==0 ){
drhd663b5b2012-10-03 00:25:54 +00003211 int j;
3212 j = (pc.plan.nEq==pProbe->nColumn ? -1 : pProbe->aiColumn[pc.plan.nEq]);
drh56f1b992012-09-25 14:29:39 +00003213 if( findTerm(pWC, iCur, j, p->notReady, WO_LT|WO_LE|WO_GT|WO_GE, pIdx) ){
3214 WhereTerm *pTop, *pBtm;
3215 pTop = findTerm(pWC, iCur, j, p->notReady, WO_LT|WO_LE, pIdx);
3216 pBtm = findTerm(pWC, iCur, j, p->notReady, WO_GT|WO_GE, pIdx);
drhd663b5b2012-10-03 00:25:54 +00003217 whereRangeScanEst(pParse, pProbe, pc.plan.nEq, pBtm, pTop, &rangeDiv);
dan5236ac12009-08-13 07:09:33 +00003218 if( pTop ){
drhed754ce2010-04-15 01:04:54 +00003219 nBound = 1;
drhd663b5b2012-10-03 00:25:54 +00003220 pc.plan.wsFlags |= WHERE_TOP_LIMIT;
3221 pc.used |= pTop->prereqRight;
drh0a61df62011-10-07 17:45:58 +00003222 testcase( pTop->pWC!=pWC );
dan5236ac12009-08-13 07:09:33 +00003223 }
3224 if( pBtm ){
drhed754ce2010-04-15 01:04:54 +00003225 nBound++;
drhd663b5b2012-10-03 00:25:54 +00003226 pc.plan.wsFlags |= WHERE_BTM_LIMIT;
3227 pc.used |= pBtm->prereqRight;
drh0a61df62011-10-07 17:45:58 +00003228 testcase( pBtm->pWC!=pWC );
dan5236ac12009-08-13 07:09:33 +00003229 }
drhd663b5b2012-10-03 00:25:54 +00003230 pc.plan.wsFlags |= (WHERE_COLUMN_RANGE|WHERE_ROWID_RANGE);
dan5236ac12009-08-13 07:09:33 +00003231 }
drh943af3c2005-07-29 19:43:58 +00003232 }
drhfe05af82005-07-21 03:14:59 +00003233
dan5236ac12009-08-13 07:09:33 +00003234 /* If there is an ORDER BY clause and the index being considered will
3235 ** naturally scan rows in the required order, set the appropriate flags
drhd663b5b2012-10-03 00:25:54 +00003236 ** in pc.plan.wsFlags. Otherwise, if there is an ORDER BY clause but
3237 ** the index will scan rows in a different order, set the bSort
3238 ** variable. */
drh8e4af1b2012-10-08 18:23:51 +00003239 if( bSort && (pSrc->jointype & JT_LEFT)==0 ){
3240 int bRev = 2;
3241 WHERETRACE((" --> before isSortingIndex: nPriorSat=%d\n",nPriorSat));
drh4f68d6c2012-10-04 12:10:25 +00003242 pc.plan.nOBSat = isSortingIndex(p, pProbe, iCur, &bRev);
drh8e4af1b2012-10-08 18:23:51 +00003243 WHERETRACE((" --> after isSortingIndex: bRev=%d nOBSat=%d\n",
3244 bRev, pc.plan.nOBSat));
drhd663b5b2012-10-03 00:25:54 +00003245 if( nPriorSat<pc.plan.nOBSat || (pc.plan.wsFlags & WHERE_UNIQUE)!=0 ){
3246 pc.plan.wsFlags |= WHERE_ORDERED;
drh46c35f92012-09-26 23:17:01 +00003247 }
drhd663b5b2012-10-03 00:25:54 +00003248 if( nOrderBy==pc.plan.nOBSat ){
3249 bSort = 0;
3250 pc.plan.wsFlags |= WHERE_ROWID_RANGE|WHERE_COLUMN_RANGE;
3251 }
3252 if( bRev & 1 ) pc.plan.wsFlags |= WHERE_REVERSE;
dan38cc40c2011-06-30 20:17:15 +00003253 }
3254
3255 /* If there is a DISTINCT qualifier and this index will scan rows in
3256 ** order of the DISTINCT expressions, clear bDist and set the appropriate
drhd663b5b2012-10-03 00:25:54 +00003257 ** flags in pc.plan.wsFlags. */
drh9cd1c992012-09-25 20:43:35 +00003258 if( bDist
drhd663b5b2012-10-03 00:25:54 +00003259 && isDistinctIndex(pParse, pWC, pProbe, iCur, p->pDistinct, pc.plan.nEq)
3260 && (pc.plan.wsFlags & WHERE_COLUMN_IN)==0
drh7f67d942012-03-03 00:34:47 +00003261 ){
dan38cc40c2011-06-30 20:17:15 +00003262 bDist = 0;
drhd663b5b2012-10-03 00:25:54 +00003263 pc.plan.wsFlags |= WHERE_ROWID_RANGE|WHERE_COLUMN_RANGE|WHERE_DISTINCT;
drhfe05af82005-07-21 03:14:59 +00003264 }
3265
dan5236ac12009-08-13 07:09:33 +00003266 /* If currently calculating the cost of using an index (not the IPK
3267 ** index), determine if all required column data may be obtained without
drh4139c992010-04-07 14:59:45 +00003268 ** using the main table (i.e. if the index is a covering
dan5236ac12009-08-13 07:09:33 +00003269 ** index for this query). If it is, set the WHERE_IDX_ONLY flag in
drhd663b5b2012-10-03 00:25:54 +00003270 ** pc.plan.wsFlags. Otherwise, set the bLookup variable to true. */
drh3f4d1d12012-09-15 18:45:54 +00003271 if( pIdx ){
drhfe05af82005-07-21 03:14:59 +00003272 Bitmask m = pSrc->colUsed;
3273 int j;
dan5236ac12009-08-13 07:09:33 +00003274 for(j=0; j<pIdx->nColumn; j++){
3275 int x = pIdx->aiColumn[j];
drhfe05af82005-07-21 03:14:59 +00003276 if( x<BMS-1 ){
3277 m &= ~(((Bitmask)1)<<x);
3278 }
3279 }
3280 if( m==0 ){
drhd663b5b2012-10-03 00:25:54 +00003281 pc.plan.wsFlags |= WHERE_IDX_ONLY;
dan5236ac12009-08-13 07:09:33 +00003282 }else{
3283 bLookup = 1;
drhfe05af82005-07-21 03:14:59 +00003284 }
3285 }
3286
drh1e0f4a82010-04-14 19:01:44 +00003287 /*
drh9b3eb0a2011-01-21 14:37:04 +00003288 ** Estimate the number of rows of output. For an "x IN (SELECT...)"
3289 ** constraint, do not let the estimate exceed half the rows in the table.
drhcdaca552009-08-20 13:45:07 +00003290 */
drhd663b5b2012-10-03 00:25:54 +00003291 pc.plan.nRow = (double)(aiRowEst[pc.plan.nEq] * nInMul);
3292 if( bInEst && pc.plan.nRow*2>aiRowEst[0] ){
3293 pc.plan.nRow = aiRowEst[0]/2;
3294 nInMul = (int)(pc.plan.nRow / aiRowEst[pc.plan.nEq]);
dan5236ac12009-08-13 07:09:33 +00003295 }
drhcdaca552009-08-20 13:45:07 +00003296
drhfaacf172011-08-12 01:51:45 +00003297#ifdef SQLITE_ENABLE_STAT3
drhbf4ec552011-07-13 18:31:10 +00003298 /* If the constraint is of the form x=VALUE or x IN (E1,E2,...)
3299 ** and we do not think that values of x are unique and if histogram
drh82759752011-01-20 16:52:09 +00003300 ** data is available for column x, then it might be possible
3301 ** to get a better estimate on the number of rows based on
3302 ** VALUE and how common that value is according to the histogram.
3303 */
drhd663b5b2012-10-03 00:25:54 +00003304 if( pc.plan.nRow>(double)1 && pc.plan.nEq==1
3305 && pFirstTerm!=0 && aiRowEst[1]>1 ){
drh567211e2011-09-23 13:59:33 +00003306 assert( (pFirstTerm->eOperator & (WO_EQ|WO_ISNULL|WO_IN))!=0 );
drh1f9c7662011-03-17 01:34:26 +00003307 if( pFirstTerm->eOperator & (WO_EQ|WO_ISNULL) ){
3308 testcase( pFirstTerm->eOperator==WO_EQ );
drhce62d932011-04-01 02:26:36 +00003309 testcase( pFirstTerm->eOperator==WO_ISNULL );
drhd663b5b2012-10-03 00:25:54 +00003310 whereEqualScanEst(pParse, pProbe, pFirstTerm->pExpr->pRight,
3311 &pc.plan.nRow);
drh567211e2011-09-23 13:59:33 +00003312 }else if( bInEst==0 ){
3313 assert( pFirstTerm->eOperator==WO_IN );
drhd663b5b2012-10-03 00:25:54 +00003314 whereInScanEst(pParse, pProbe, pFirstTerm->pExpr->x.pList,
3315 &pc.plan.nRow);
drh0c50fa02011-01-21 16:27:18 +00003316 }
drh82759752011-01-20 16:52:09 +00003317 }
drhfaacf172011-08-12 01:51:45 +00003318#endif /* SQLITE_ENABLE_STAT3 */
drh82759752011-01-20 16:52:09 +00003319
drh37722062011-02-10 00:08:47 +00003320 /* Adjust the number of output rows and downward to reflect rows
drhcdaca552009-08-20 13:45:07 +00003321 ** that are excluded by range constraints.
3322 */
drhd663b5b2012-10-03 00:25:54 +00003323 pc.plan.nRow = pc.plan.nRow/rangeDiv;
3324 if( pc.plan.nRow<1 ) pc.plan.nRow = 1;
drhcdaca552009-08-20 13:45:07 +00003325
drh37722062011-02-10 00:08:47 +00003326 /* Experiments run on real SQLite databases show that the time needed
3327 ** to do a binary search to locate a row in a table or index is roughly
3328 ** log10(N) times the time to move from one row to the next row within
3329 ** a table or index. The actual times can vary, with the size of
3330 ** records being an important factor. Both moves and searches are
3331 ** slower with larger records, presumably because fewer records fit
3332 ** on one page and hence more pages have to be fetched.
drh083310d2011-01-28 01:57:41 +00003333 **
drh74e7c8f2011-10-21 19:06:32 +00003334 ** The ANALYZE command and the sqlite_stat1 and sqlite_stat3 tables do
drh37722062011-02-10 00:08:47 +00003335 ** not give us data on the relative sizes of table and index records.
3336 ** So this computation assumes table records are about twice as big
3337 ** as index records
drhb9661942011-01-24 15:11:23 +00003338 */
drhd663b5b2012-10-03 00:25:54 +00003339 if( (pc.plan.wsFlags&~(WHERE_REVERSE|WHERE_ORDERED))==WHERE_IDX_ONLY
drh3f4d1d12012-09-15 18:45:54 +00003340 && (pWC->wctrlFlags & WHERE_ONEPASS_DESIRED)==0
drhde9a7b82012-09-17 20:44:46 +00003341 && sqlite3GlobalConfig.bUseCis
drh7e5418e2012-09-27 15:05:54 +00003342 && OptimizationEnabled(pParse->db, SQLITE_CoverIdxScan)
drh3f4d1d12012-09-15 18:45:54 +00003343 ){
3344 /* This index is not useful for indexing, but it is a covering index.
3345 ** A full-scan of the index might be a little faster than a full-scan
3346 ** of the table, so give this case a cost slightly less than a table
3347 ** scan. */
drhd663b5b2012-10-03 00:25:54 +00003348 pc.rCost = aiRowEst[0]*3 + pProbe->nColumn;
3349 pc.plan.wsFlags |= WHERE_COVER_SCAN|WHERE_COLUMN_RANGE;
3350 }else if( (pc.plan.wsFlags & WHERE_NOT_FULLSCAN)==0 ){
drh37722062011-02-10 00:08:47 +00003351 /* The cost of a full table scan is a number of move operations equal
3352 ** to the number of rows in the table.
3353 **
3354 ** We add an additional 4x penalty to full table scans. This causes
3355 ** the cost function to err on the side of choosing an index over
3356 ** choosing a full scan. This 4x full-scan penalty is an arguable
3357 ** decision and one which we expect to revisit in the future. But
3358 ** it seems to be working well enough at the moment.
drh083310d2011-01-28 01:57:41 +00003359 */
drhd663b5b2012-10-03 00:25:54 +00003360 pc.rCost = aiRowEst[0]*4;
3361 pc.plan.wsFlags &= ~WHERE_IDX_ONLY;
drh8e4af1b2012-10-08 18:23:51 +00003362 if( pIdx ){
3363 pc.plan.wsFlags &= ~WHERE_ORDERED;
3364 pc.plan.nOBSat = nPriorSat;
3365 }
drh37722062011-02-10 00:08:47 +00003366 }else{
3367 log10N = estLog(aiRowEst[0]);
drhd663b5b2012-10-03 00:25:54 +00003368 pc.rCost = pc.plan.nRow;
drh37722062011-02-10 00:08:47 +00003369 if( pIdx ){
3370 if( bLookup ){
3371 /* For an index lookup followed by a table lookup:
3372 ** nInMul index searches to find the start of each index range
3373 ** + nRow steps through the index
3374 ** + nRow table searches to lookup the table entry using the rowid
3375 */
drhd663b5b2012-10-03 00:25:54 +00003376 pc.rCost += (nInMul + pc.plan.nRow)*log10N;
drh37722062011-02-10 00:08:47 +00003377 }else{
3378 /* For a covering index:
3379 ** nInMul index searches to find the initial entry
3380 ** + nRow steps through the index
3381 */
drhd663b5b2012-10-03 00:25:54 +00003382 pc.rCost += nInMul*log10N;
drh37722062011-02-10 00:08:47 +00003383 }
3384 }else{
3385 /* For a rowid primary key lookup:
3386 ** nInMult table searches to find the initial entry for each range
3387 ** + nRow steps through the table
3388 */
drhd663b5b2012-10-03 00:25:54 +00003389 pc.rCost += nInMul*log10N;
drh37722062011-02-10 00:08:47 +00003390 }
drhb9661942011-01-24 15:11:23 +00003391 }
3392
drh37722062011-02-10 00:08:47 +00003393 /* Add in the estimated cost of sorting the result. Actual experimental
3394 ** measurements of sorting performance in SQLite show that sorting time
3395 ** adds C*N*log10(N) to the cost, where N is the number of rows to be
3396 ** sorted and C is a factor between 1.95 and 4.3. We will split the
3397 ** difference and select C of 3.0.
drhcdaca552009-08-20 13:45:07 +00003398 */
dan5236ac12009-08-13 07:09:33 +00003399 if( bSort ){
drhd663b5b2012-10-03 00:25:54 +00003400 double m = estLog(pc.plan.nRow*(nOrderBy - pc.plan.nOBSat)/nOrderBy);
3401 m *= (double)(pc.plan.nOBSat ? 2 : 3);
3402 pc.rCost += pc.plan.nRow*m;
dan5236ac12009-08-13 07:09:33 +00003403 }
dan38cc40c2011-06-30 20:17:15 +00003404 if( bDist ){
drhd663b5b2012-10-03 00:25:54 +00003405 pc.rCost += pc.plan.nRow*estLog(pc.plan.nRow)*3;
dan38cc40c2011-06-30 20:17:15 +00003406 }
drhcdaca552009-08-20 13:45:07 +00003407
drhcdaca552009-08-20 13:45:07 +00003408 /**** Cost of using this index has now been computed ****/
dan5236ac12009-08-13 07:09:33 +00003409
drh1e0f4a82010-04-14 19:01:44 +00003410 /* If there are additional constraints on this table that cannot
3411 ** be used with the current index, but which might lower the number
3412 ** of output rows, adjust the nRow value accordingly. This only
3413 ** matters if the current index is the least costly, so do not bother
3414 ** with this step if we already know this index will not be chosen.
drhed754ce2010-04-15 01:04:54 +00003415 ** Also, never reduce the output row count below 2 using this step.
drhed808ac2010-04-15 13:29:37 +00003416 **
drh547caad2010-10-04 23:55:50 +00003417 ** It is critical that the notValid mask be used here instead of
3418 ** the notReady mask. When computing an "optimal" index, the notReady
3419 ** mask will only have one bit set - the bit for the current table.
3420 ** The notValid mask, on the other hand, always has all bits set for
3421 ** tables that are not in outer loops. If notReady is used here instead
3422 ** of notValid, then a optimal index that depends on inner joins loops
3423 ** might be selected even when there exists an optimal index that has
3424 ** no such dependency.
drh1e0f4a82010-04-14 19:01:44 +00003425 */
drhd663b5b2012-10-03 00:25:54 +00003426 if( pc.plan.nRow>2 && pc.rCost<=p->cost.rCost ){
drhed808ac2010-04-15 13:29:37 +00003427 int k; /* Loop counter */
drhd663b5b2012-10-03 00:25:54 +00003428 int nSkipEq = pc.plan.nEq; /* Number of == constraints to skip */
drhed808ac2010-04-15 13:29:37 +00003429 int nSkipRange = nBound; /* Number of < constraints to skip */
3430 Bitmask thisTab; /* Bitmap for pSrc */
3431
3432 thisTab = getMask(pWC->pMaskSet, iCur);
drhd663b5b2012-10-03 00:25:54 +00003433 for(pTerm=pWC->a, k=pWC->nTerm; pc.plan.nRow>2 && k; k--, pTerm++){
drh534230c2011-01-22 00:10:45 +00003434 if( pTerm->wtFlags & TERM_VIRTUAL ) continue;
drh56f1b992012-09-25 14:29:39 +00003435 if( (pTerm->prereqAll & p->notValid)!=thisTab ) continue;
drh1e0f4a82010-04-14 19:01:44 +00003436 if( pTerm->eOperator & (WO_EQ|WO_IN|WO_ISNULL) ){
drhed754ce2010-04-15 01:04:54 +00003437 if( nSkipEq ){
drhd663b5b2012-10-03 00:25:54 +00003438 /* Ignore the first pc.plan.nEq equality matches since the index
drh1e0f4a82010-04-14 19:01:44 +00003439 ** has already accounted for these */
drhed754ce2010-04-15 01:04:54 +00003440 nSkipEq--;
drh1e0f4a82010-04-14 19:01:44 +00003441 }else{
3442 /* Assume each additional equality match reduces the result
3443 ** set size by a factor of 10 */
drhd663b5b2012-10-03 00:25:54 +00003444 pc.plan.nRow /= 10;
drh1e0f4a82010-04-14 19:01:44 +00003445 }
drhed754ce2010-04-15 01:04:54 +00003446 }else if( pTerm->eOperator & (WO_LT|WO_LE|WO_GT|WO_GE) ){
3447 if( nSkipRange ){
drh5ac06072011-01-21 18:18:13 +00003448 /* Ignore the first nSkipRange range constraints since the index
drhed754ce2010-04-15 01:04:54 +00003449 ** has already accounted for these */
3450 nSkipRange--;
3451 }else{
3452 /* Assume each additional range constraint reduces the result
drh083310d2011-01-28 01:57:41 +00003453 ** set size by a factor of 3. Indexed range constraints reduce
3454 ** the search space by a larger factor: 4. We make indexed range
3455 ** more selective intentionally because of the subjective
3456 ** observation that indexed range constraints really are more
3457 ** selective in practice, on average. */
drhd663b5b2012-10-03 00:25:54 +00003458 pc.plan.nRow /= 3;
drhed754ce2010-04-15 01:04:54 +00003459 }
drh534230c2011-01-22 00:10:45 +00003460 }else if( pTerm->eOperator!=WO_NOOP ){
drh1e0f4a82010-04-14 19:01:44 +00003461 /* Any other expression lowers the output row count by half */
drhd663b5b2012-10-03 00:25:54 +00003462 pc.plan.nRow /= 2;
drh1e0f4a82010-04-14 19:01:44 +00003463 }
3464 }
drhd663b5b2012-10-03 00:25:54 +00003465 if( pc.plan.nRow<2 ) pc.plan.nRow = 2;
drh1e0f4a82010-04-14 19:01:44 +00003466 }
3467
3468
dan5236ac12009-08-13 07:09:33 +00003469 WHERETRACE((
drh8e4af1b2012-10-08 18:23:51 +00003470 " nEq=%d nInMul=%d rangeDiv=%d bSort=%d bLookup=%d wsFlags=0x%08x\n"
3471 " notReady=0x%llx log10N=%.1f nRow=%.1f cost=%.1f\n"
3472 " used=0x%llx nOBSat=%d\n",
drhd663b5b2012-10-03 00:25:54 +00003473 pc.plan.nEq, nInMul, (int)rangeDiv, bSort, bLookup, pc.plan.wsFlags,
drh4f68d6c2012-10-04 12:10:25 +00003474 p->notReady, log10N, pc.plan.nRow, pc.rCost, pc.used,
drhd663b5b2012-10-03 00:25:54 +00003475 pc.plan.nOBSat
dan5236ac12009-08-13 07:09:33 +00003476 ));
3477
drhcdaca552009-08-20 13:45:07 +00003478 /* If this index is the best we have seen so far, then record this
drhd663b5b2012-10-03 00:25:54 +00003479 ** index and its cost in the p->cost structure.
drhcdaca552009-08-20 13:45:07 +00003480 */
drhd663b5b2012-10-03 00:25:54 +00003481 if( (!pIdx || pc.plan.wsFlags) && compareCost(&pc, &p->cost) ){
3482 p->cost = pc;
3483 p->cost.plan.wsFlags &= wsFlagMask;
drh56f1b992012-09-25 14:29:39 +00003484 p->cost.plan.u.pIdx = pIdx;
drhfe05af82005-07-21 03:14:59 +00003485 }
dan5236ac12009-08-13 07:09:33 +00003486
drhcdaca552009-08-20 13:45:07 +00003487 /* If there was an INDEXED BY clause, then only that one index is
3488 ** considered. */
dan5236ac12009-08-13 07:09:33 +00003489 if( pSrc->pIndex ) break;
drhcdaca552009-08-20 13:45:07 +00003490
3491 /* Reset masks for the next index in the loop */
dan5236ac12009-08-13 07:09:33 +00003492 wsFlagMask = ~(WHERE_ROWID_EQ|WHERE_ROWID_RANGE);
3493 eqTermMask = idxEqTermMask;
drhfe05af82005-07-21 03:14:59 +00003494 }
3495
dan5236ac12009-08-13 07:09:33 +00003496 /* If there is no ORDER BY clause and the SQLITE_ReverseOrder flag
3497 ** is set, then reverse the order that the index will be scanned
3498 ** in. This is used for application testing, to help find cases
3499 ** where application behaviour depends on the (undefined) order that
3500 ** SQLite outputs rows in in the absence of an ORDER BY clause. */
drh56f1b992012-09-25 14:29:39 +00003501 if( !p->pOrderBy && pParse->db->flags & SQLITE_ReverseOrder ){
3502 p->cost.plan.wsFlags |= WHERE_REVERSE;
dan5236ac12009-08-13 07:09:33 +00003503 }
3504
drhd663b5b2012-10-03 00:25:54 +00003505 assert( p->pOrderBy || (p->cost.plan.wsFlags&WHERE_ORDERED)==0 );
drh56f1b992012-09-25 14:29:39 +00003506 assert( p->cost.plan.u.pIdx==0 || (p->cost.plan.wsFlags&WHERE_ROWID_EQ)==0 );
dan5236ac12009-08-13 07:09:33 +00003507 assert( pSrc->pIndex==0
drh56f1b992012-09-25 14:29:39 +00003508 || p->cost.plan.u.pIdx==0
3509 || p->cost.plan.u.pIdx==pSrc->pIndex
dan5236ac12009-08-13 07:09:33 +00003510 );
3511
drh8e4af1b2012-10-08 18:23:51 +00003512 WHERETRACE((" best index is: %s\n",
drhd663b5b2012-10-03 00:25:54 +00003513 p->cost.plan.u.pIdx ? p->cost.plan.u.pIdx->zName : "ipk"));
dan5236ac12009-08-13 07:09:33 +00003514
drh56f1b992012-09-25 14:29:39 +00003515 bestOrClauseIndex(p);
3516 bestAutomaticIndex(p);
3517 p->cost.plan.wsFlags |= eqTermMask;
drhfe05af82005-07-21 03:14:59 +00003518}
3519
danielk19771d461462009-04-21 09:02:45 +00003520/*
3521** Find the query plan for accessing table pSrc->pTab. Write the
3522** best query plan and its cost into the WhereCost object supplied
3523** as the last parameter. This function may calculate the cost of
3524** both real and virtual table scans.
drh4d85fa72012-09-24 19:50:00 +00003525**
3526** This function does not take ORDER BY or DISTINCT into account. Nor
3527** does it remember the virtual table query plan. All it does is compute
3528** the cost while determining if an OR optimization is applicable. The
3529** details will be reconsidered later if the optimization is found to be
3530** applicable.
danielk19771d461462009-04-21 09:02:45 +00003531*/
drh56f1b992012-09-25 14:29:39 +00003532static void bestIndex(WhereBestIdx *p){
shanee26fa4c2009-06-16 14:15:22 +00003533#ifndef SQLITE_OMIT_VIRTUALTABLE
drh56f1b992012-09-25 14:29:39 +00003534 if( IsVirtual(p->pSrc->pTab) ){
3535 sqlite3_index_info *pIdxInfo = 0;
3536 p->ppIdxInfo = &pIdxInfo;
3537 bestVirtualIndex(p);
3538 if( pIdxInfo->needToFreeIdxStr ){
3539 sqlite3_free(pIdxInfo->idxStr);
danielk19771d461462009-04-21 09:02:45 +00003540 }
drh56f1b992012-09-25 14:29:39 +00003541 sqlite3DbFree(p->pParse->db, pIdxInfo);
shanee26fa4c2009-06-16 14:15:22 +00003542 }else
3543#endif
3544 {
drh56f1b992012-09-25 14:29:39 +00003545 bestBtreeIndex(p);
danielk19771d461462009-04-21 09:02:45 +00003546 }
3547}
drhb6c29892004-11-22 19:12:19 +00003548
3549/*
drh2ffb1182004-07-19 19:14:01 +00003550** Disable a term in the WHERE clause. Except, do not disable the term
3551** if it controls a LEFT OUTER JOIN and it did not originate in the ON
3552** or USING clause of that join.
3553**
3554** Consider the term t2.z='ok' in the following queries:
3555**
3556** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
3557** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
3558** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
3559**
drh23bf66d2004-12-14 03:34:34 +00003560** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00003561** in the ON clause. The term is disabled in (3) because it is not part
3562** of a LEFT OUTER JOIN. In (1), the term is not disabled.
3563**
drhe9cdcea2010-07-22 22:40:03 +00003564** IMPLEMENTATION-OF: R-24597-58655 No tests are done for terms that are
3565** completely satisfied by indices.
3566**
drh2ffb1182004-07-19 19:14:01 +00003567** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00003568** of the join. Disabling is an optimization. When terms are satisfied
3569** by indices, we disable them to prevent redundant tests in the inner
3570** loop. We would get the correct results if nothing were ever disabled,
3571** but joins might run a little slower. The trick is to disable as much
3572** as we can without disabling too much. If we disabled in (1), we'd get
3573** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00003574*/
drh0fcef5e2005-07-19 17:38:22 +00003575static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
3576 if( pTerm
drhbe837bd2010-04-30 21:03:24 +00003577 && (pTerm->wtFlags & TERM_CODED)==0
drh0fcef5e2005-07-19 17:38:22 +00003578 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
3579 ){
drh165be382008-12-05 02:36:33 +00003580 pTerm->wtFlags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00003581 if( pTerm->iParent>=0 ){
3582 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
3583 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00003584 disableTerm(pLevel, pOther);
3585 }
drh0fcef5e2005-07-19 17:38:22 +00003586 }
drh2ffb1182004-07-19 19:14:01 +00003587 }
3588}
3589
3590/*
dan69f8bb92009-08-13 19:21:16 +00003591** Code an OP_Affinity opcode to apply the column affinity string zAff
3592** to the n registers starting at base.
3593**
drh039fc322009-11-17 18:31:47 +00003594** As an optimization, SQLITE_AFF_NONE entries (which are no-ops) at the
3595** beginning and end of zAff are ignored. If all entries in zAff are
3596** SQLITE_AFF_NONE, then no code gets generated.
3597**
3598** This routine makes its own copy of zAff so that the caller is free
3599** to modify zAff after this routine returns.
drh94a11212004-09-25 13:12:14 +00003600*/
dan69f8bb92009-08-13 19:21:16 +00003601static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
3602 Vdbe *v = pParse->pVdbe;
drh039fc322009-11-17 18:31:47 +00003603 if( zAff==0 ){
3604 assert( pParse->db->mallocFailed );
3605 return;
3606 }
dan69f8bb92009-08-13 19:21:16 +00003607 assert( v!=0 );
drh039fc322009-11-17 18:31:47 +00003608
3609 /* Adjust base and n to skip over SQLITE_AFF_NONE entries at the beginning
3610 ** and end of the affinity string.
3611 */
3612 while( n>0 && zAff[0]==SQLITE_AFF_NONE ){
3613 n--;
3614 base++;
3615 zAff++;
3616 }
3617 while( n>1 && zAff[n-1]==SQLITE_AFF_NONE ){
3618 n--;
3619 }
3620
3621 /* Code the OP_Affinity opcode if there is anything left to do. */
3622 if( n>0 ){
3623 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
3624 sqlite3VdbeChangeP4(v, -1, zAff, n);
3625 sqlite3ExprCacheAffinityChange(pParse, base, n);
3626 }
drh94a11212004-09-25 13:12:14 +00003627}
3628
drhe8b97272005-07-19 22:22:12 +00003629
3630/*
drh51147ba2005-07-23 22:59:55 +00003631** Generate code for a single equality term of the WHERE clause. An equality
3632** term can be either X=expr or X IN (...). pTerm is the term to be
3633** coded.
3634**
drh1db639c2008-01-17 02:36:28 +00003635** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00003636**
3637** For a constraint of the form X=expr, the expression is evaluated and its
3638** result is left on the stack. For constraints of the form X IN (...)
3639** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00003640*/
drh678ccce2008-03-31 18:19:54 +00003641static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00003642 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00003643 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh1db639c2008-01-17 02:36:28 +00003644 WhereLevel *pLevel, /* When level of the FROM clause we are working on */
drh678ccce2008-03-31 18:19:54 +00003645 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00003646){
drh0fcef5e2005-07-19 17:38:22 +00003647 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00003648 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00003649 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00003650
danielk19772d605492008-10-01 08:43:03 +00003651 assert( iTarget>0 );
drh50b39962006-10-28 00:28:09 +00003652 if( pX->op==TK_EQ ){
drh678ccce2008-03-31 18:19:54 +00003653 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00003654 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00003655 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00003656 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00003657#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00003658 }else{
danielk19779a96b662007-11-29 17:05:18 +00003659 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00003660 int iTab;
drh72e8fa42007-03-28 14:30:06 +00003661 struct InLoop *pIn;
danielk1977b3bce662005-01-29 08:32:43 +00003662
drh50b39962006-10-28 00:28:09 +00003663 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00003664 iReg = iTarget;
danielk19770cdc0222008-06-26 18:04:03 +00003665 eType = sqlite3FindInIndex(pParse, pX, 0);
danielk1977b3bce662005-01-29 08:32:43 +00003666 iTab = pX->iTable;
drh66a51672008-01-03 00:01:23 +00003667 sqlite3VdbeAddOp2(v, OP_Rewind, iTab, 0);
drh111a6a72008-12-21 03:51:16 +00003668 assert( pLevel->plan.wsFlags & WHERE_IN_ABLE );
3669 if( pLevel->u.in.nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00003670 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00003671 }
drh111a6a72008-12-21 03:51:16 +00003672 pLevel->u.in.nIn++;
3673 pLevel->u.in.aInLoop =
3674 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
3675 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
3676 pIn = pLevel->u.in.aInLoop;
drh72e8fa42007-03-28 14:30:06 +00003677 if( pIn ){
drh111a6a72008-12-21 03:51:16 +00003678 pIn += pLevel->u.in.nIn - 1;
drh72e8fa42007-03-28 14:30:06 +00003679 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00003680 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00003681 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00003682 }else{
drhb3190c12008-12-08 21:37:14 +00003683 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00003684 }
3685 sqlite3VdbeAddOp1(v, OP_IsNull, iReg);
drha6110402005-07-28 20:51:19 +00003686 }else{
drh111a6a72008-12-21 03:51:16 +00003687 pLevel->u.in.nIn = 0;
drhe23399f2005-07-22 00:31:39 +00003688 }
danielk1977b3bce662005-01-29 08:32:43 +00003689#endif
drh94a11212004-09-25 13:12:14 +00003690 }
drh0fcef5e2005-07-19 17:38:22 +00003691 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00003692 return iReg;
drh94a11212004-09-25 13:12:14 +00003693}
3694
drh51147ba2005-07-23 22:59:55 +00003695/*
3696** Generate code that will evaluate all == and IN constraints for an
drh039fc322009-11-17 18:31:47 +00003697** index.
drh51147ba2005-07-23 22:59:55 +00003698**
3699** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
3700** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
3701** The index has as many as three equality constraints, but in this
3702** example, the third "c" value is an inequality. So only two
3703** constraints are coded. This routine will generate code to evaluate
drh6df2acd2008-12-28 16:55:25 +00003704** a==5 and b IN (1,2,3). The current values for a and b will be stored
3705** in consecutive registers and the index of the first register is returned.
drh51147ba2005-07-23 22:59:55 +00003706**
3707** In the example above nEq==2. But this subroutine works for any value
3708** of nEq including 0. If nEq==0, this routine is nearly a no-op.
drh039fc322009-11-17 18:31:47 +00003709** The only thing it does is allocate the pLevel->iMem memory cell and
3710** compute the affinity string.
drh51147ba2005-07-23 22:59:55 +00003711**
drh700a2262008-12-17 19:22:15 +00003712** This routine always allocates at least one memory cell and returns
3713** the index of that memory cell. The code that
3714** calls this routine will use that memory cell to store the termination
drh51147ba2005-07-23 22:59:55 +00003715** key value of the loop. If one or more IN operators appear, then
3716** this routine allocates an additional nEq memory cells for internal
3717** use.
dan69f8bb92009-08-13 19:21:16 +00003718**
3719** Before returning, *pzAff is set to point to a buffer containing a
3720** copy of the column affinity string of the index allocated using
3721** sqlite3DbMalloc(). Except, entries in the copy of the string associated
3722** with equality constraints that use NONE affinity are set to
3723** SQLITE_AFF_NONE. This is to deal with SQL such as the following:
3724**
3725** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
3726** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
3727**
3728** In the example above, the index on t1(a) has TEXT affinity. But since
3729** the right hand side of the equality constraint (t2.b) has NONE affinity,
3730** no conversion should be attempted before using a t2.b value as part of
3731** a key to search the index. Hence the first byte in the returned affinity
3732** string in this example would be set to SQLITE_AFF_NONE.
drh51147ba2005-07-23 22:59:55 +00003733*/
drh1db639c2008-01-17 02:36:28 +00003734static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00003735 Parse *pParse, /* Parsing context */
3736 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
3737 WhereClause *pWC, /* The WHERE clause */
drh1db639c2008-01-17 02:36:28 +00003738 Bitmask notReady, /* Which parts of FROM have not yet been coded */
dan69f8bb92009-08-13 19:21:16 +00003739 int nExtraReg, /* Number of extra registers to allocate */
3740 char **pzAff /* OUT: Set to point to affinity string */
drh51147ba2005-07-23 22:59:55 +00003741){
drh111a6a72008-12-21 03:51:16 +00003742 int nEq = pLevel->plan.nEq; /* The number of == or IN constraints to code */
3743 Vdbe *v = pParse->pVdbe; /* The vm under construction */
3744 Index *pIdx; /* The index being used for this loop */
drh51147ba2005-07-23 22:59:55 +00003745 int iCur = pLevel->iTabCur; /* The cursor of the table */
3746 WhereTerm *pTerm; /* A single constraint term */
3747 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00003748 int regBase; /* Base register */
drh6df2acd2008-12-28 16:55:25 +00003749 int nReg; /* Number of registers to allocate */
dan69f8bb92009-08-13 19:21:16 +00003750 char *zAff; /* Affinity string to return */
drh51147ba2005-07-23 22:59:55 +00003751
drh111a6a72008-12-21 03:51:16 +00003752 /* This module is only called on query plans that use an index. */
3753 assert( pLevel->plan.wsFlags & WHERE_INDEXED );
3754 pIdx = pLevel->plan.u.pIdx;
3755
drh51147ba2005-07-23 22:59:55 +00003756 /* Figure out how many memory cells we will need then allocate them.
drh51147ba2005-07-23 22:59:55 +00003757 */
drh700a2262008-12-17 19:22:15 +00003758 regBase = pParse->nMem + 1;
drh6df2acd2008-12-28 16:55:25 +00003759 nReg = pLevel->plan.nEq + nExtraReg;
3760 pParse->nMem += nReg;
drh51147ba2005-07-23 22:59:55 +00003761
dan69f8bb92009-08-13 19:21:16 +00003762 zAff = sqlite3DbStrDup(pParse->db, sqlite3IndexAffinityStr(v, pIdx));
3763 if( !zAff ){
3764 pParse->db->mallocFailed = 1;
3765 }
3766
drh51147ba2005-07-23 22:59:55 +00003767 /* Evaluate the equality constraints
3768 */
drhc49de5d2007-01-19 01:06:01 +00003769 assert( pIdx->nColumn>=nEq );
3770 for(j=0; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00003771 int r1;
drh51147ba2005-07-23 22:59:55 +00003772 int k = pIdx->aiColumn[j];
drh111a6a72008-12-21 03:51:16 +00003773 pTerm = findTerm(pWC, iCur, k, notReady, pLevel->plan.wsFlags, pIdx);
drh7b36ba32012-08-24 21:54:11 +00003774 if( pTerm==0 ) break;
drhbe837bd2010-04-30 21:03:24 +00003775 /* The following true for indices with redundant columns.
3776 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
3777 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
drhe9cdcea2010-07-22 22:40:03 +00003778 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh678ccce2008-03-31 18:19:54 +00003779 r1 = codeEqualityTerm(pParse, pTerm, pLevel, regBase+j);
3780 if( r1!=regBase+j ){
drh6df2acd2008-12-28 16:55:25 +00003781 if( nReg==1 ){
3782 sqlite3ReleaseTempReg(pParse, regBase);
3783 regBase = r1;
3784 }else{
3785 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
3786 }
drh678ccce2008-03-31 18:19:54 +00003787 }
drh981642f2008-04-19 14:40:43 +00003788 testcase( pTerm->eOperator & WO_ISNULL );
3789 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00003790 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drh039fc322009-11-17 18:31:47 +00003791 Expr *pRight = pTerm->pExpr->pRight;
drh2f2855b2009-11-18 01:25:26 +00003792 sqlite3ExprCodeIsNullJump(v, pRight, regBase+j, pLevel->addrBrk);
drh039fc322009-11-17 18:31:47 +00003793 if( zAff ){
3794 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_NONE ){
3795 zAff[j] = SQLITE_AFF_NONE;
3796 }
3797 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
3798 zAff[j] = SQLITE_AFF_NONE;
3799 }
dan69f8bb92009-08-13 19:21:16 +00003800 }
drh51147ba2005-07-23 22:59:55 +00003801 }
3802 }
dan69f8bb92009-08-13 19:21:16 +00003803 *pzAff = zAff;
drh1db639c2008-01-17 02:36:28 +00003804 return regBase;
drh51147ba2005-07-23 22:59:55 +00003805}
3806
dan2ce22452010-11-08 19:01:16 +00003807#ifndef SQLITE_OMIT_EXPLAIN
dan17c0bc02010-11-09 17:35:19 +00003808/*
drh69174c42010-11-12 15:35:59 +00003809** This routine is a helper for explainIndexRange() below
3810**
3811** pStr holds the text of an expression that we are building up one term
3812** at a time. This routine adds a new term to the end of the expression.
3813** Terms are separated by AND so add the "AND" text for second and subsequent
3814** terms only.
3815*/
3816static void explainAppendTerm(
3817 StrAccum *pStr, /* The text expression being built */
3818 int iTerm, /* Index of this term. First is zero */
3819 const char *zColumn, /* Name of the column */
3820 const char *zOp /* Name of the operator */
3821){
3822 if( iTerm ) sqlite3StrAccumAppend(pStr, " AND ", 5);
3823 sqlite3StrAccumAppend(pStr, zColumn, -1);
3824 sqlite3StrAccumAppend(pStr, zOp, 1);
3825 sqlite3StrAccumAppend(pStr, "?", 1);
3826}
3827
3828/*
dan17c0bc02010-11-09 17:35:19 +00003829** Argument pLevel describes a strategy for scanning table pTab. This
3830** function returns a pointer to a string buffer containing a description
3831** of the subset of table rows scanned by the strategy in the form of an
3832** SQL expression. Or, if all rows are scanned, NULL is returned.
3833**
3834** For example, if the query:
3835**
3836** SELECT * FROM t1 WHERE a=1 AND b>2;
3837**
3838** is run and there is an index on (a, b), then this function returns a
3839** string similar to:
3840**
3841** "a=? AND b>?"
3842**
3843** The returned pointer points to memory obtained from sqlite3DbMalloc().
3844** It is the responsibility of the caller to free the buffer when it is
3845** no longer required.
3846*/
3847static char *explainIndexRange(sqlite3 *db, WhereLevel *pLevel, Table *pTab){
dan2ce22452010-11-08 19:01:16 +00003848 WherePlan *pPlan = &pLevel->plan;
3849 Index *pIndex = pPlan->u.pIdx;
3850 int nEq = pPlan->nEq;
drh69174c42010-11-12 15:35:59 +00003851 int i, j;
3852 Column *aCol = pTab->aCol;
3853 int *aiColumn = pIndex->aiColumn;
3854 StrAccum txt;
dan2ce22452010-11-08 19:01:16 +00003855
drh69174c42010-11-12 15:35:59 +00003856 if( nEq==0 && (pPlan->wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ){
3857 return 0;
3858 }
3859 sqlite3StrAccumInit(&txt, 0, 0, SQLITE_MAX_LENGTH);
drh03b6df12010-11-15 16:29:30 +00003860 txt.db = db;
drh69174c42010-11-12 15:35:59 +00003861 sqlite3StrAccumAppend(&txt, " (", 2);
dan2ce22452010-11-08 19:01:16 +00003862 for(i=0; i<nEq; i++){
drh69174c42010-11-12 15:35:59 +00003863 explainAppendTerm(&txt, i, aCol[aiColumn[i]].zName, "=");
dan2ce22452010-11-08 19:01:16 +00003864 }
3865
drh69174c42010-11-12 15:35:59 +00003866 j = i;
dan2ce22452010-11-08 19:01:16 +00003867 if( pPlan->wsFlags&WHERE_BTM_LIMIT ){
dan0c733f62011-11-16 15:27:09 +00003868 char *z = (j==pIndex->nColumn ) ? "rowid" : aCol[aiColumn[j]].zName;
3869 explainAppendTerm(&txt, i++, z, ">");
dan2ce22452010-11-08 19:01:16 +00003870 }
3871 if( pPlan->wsFlags&WHERE_TOP_LIMIT ){
dan0c733f62011-11-16 15:27:09 +00003872 char *z = (j==pIndex->nColumn ) ? "rowid" : aCol[aiColumn[j]].zName;
3873 explainAppendTerm(&txt, i, z, "<");
dan2ce22452010-11-08 19:01:16 +00003874 }
drh69174c42010-11-12 15:35:59 +00003875 sqlite3StrAccumAppend(&txt, ")", 1);
3876 return sqlite3StrAccumFinish(&txt);
dan2ce22452010-11-08 19:01:16 +00003877}
3878
dan17c0bc02010-11-09 17:35:19 +00003879/*
3880** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
3881** command. If the query being compiled is an EXPLAIN QUERY PLAN, a single
3882** record is added to the output to describe the table scan strategy in
3883** pLevel.
3884*/
3885static void explainOneScan(
dan2ce22452010-11-08 19:01:16 +00003886 Parse *pParse, /* Parse context */
3887 SrcList *pTabList, /* Table list this loop refers to */
3888 WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
3889 int iLevel, /* Value for "level" column of output */
dan4a07e3d2010-11-09 14:48:59 +00003890 int iFrom, /* Value for "from" column of output */
3891 u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
dan2ce22452010-11-08 19:01:16 +00003892){
3893 if( pParse->explain==2 ){
3894 u32 flags = pLevel->plan.wsFlags;
3895 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
dan17c0bc02010-11-09 17:35:19 +00003896 Vdbe *v = pParse->pVdbe; /* VM being constructed */
3897 sqlite3 *db = pParse->db; /* Database handle */
3898 char *zMsg; /* Text to add to EQP output */
dan4a07e3d2010-11-09 14:48:59 +00003899 sqlite3_int64 nRow; /* Expected number of rows visited by scan */
3900 int iId = pParse->iSelectId; /* Select id (left-most output column) */
dan4bc39fa2010-11-13 16:42:27 +00003901 int isSearch; /* True for a SEARCH. False for SCAN. */
dan2ce22452010-11-08 19:01:16 +00003902
dan4a07e3d2010-11-09 14:48:59 +00003903 if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_ONETABLE_ONLY) ) return;
dan2ce22452010-11-08 19:01:16 +00003904
drh04098e62010-11-15 21:50:19 +00003905 isSearch = (pLevel->plan.nEq>0)
3906 || (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
3907 || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
dan4bc39fa2010-11-13 16:42:27 +00003908
3909 zMsg = sqlite3MPrintf(db, "%s", isSearch?"SEARCH":"SCAN");
dan4a07e3d2010-11-09 14:48:59 +00003910 if( pItem->pSelect ){
dan4bc39fa2010-11-13 16:42:27 +00003911 zMsg = sqlite3MAppendf(db, zMsg, "%s SUBQUERY %d", zMsg,pItem->iSelectId);
dan4a07e3d2010-11-09 14:48:59 +00003912 }else{
dan4bc39fa2010-11-13 16:42:27 +00003913 zMsg = sqlite3MAppendf(db, zMsg, "%s TABLE %s", zMsg, pItem->zName);
dan4a07e3d2010-11-09 14:48:59 +00003914 }
3915
dan2ce22452010-11-08 19:01:16 +00003916 if( pItem->zAlias ){
3917 zMsg = sqlite3MAppendf(db, zMsg, "%s AS %s", zMsg, pItem->zAlias);
3918 }
3919 if( (flags & WHERE_INDEXED)!=0 ){
dan17c0bc02010-11-09 17:35:19 +00003920 char *zWhere = explainIndexRange(db, pLevel, pItem->pTab);
dan4bc39fa2010-11-13 16:42:27 +00003921 zMsg = sqlite3MAppendf(db, zMsg, "%s USING %s%sINDEX%s%s%s", zMsg,
dan2ce22452010-11-08 19:01:16 +00003922 ((flags & WHERE_TEMP_INDEX)?"AUTOMATIC ":""),
3923 ((flags & WHERE_IDX_ONLY)?"COVERING ":""),
3924 ((flags & WHERE_TEMP_INDEX)?"":" "),
3925 ((flags & WHERE_TEMP_INDEX)?"": pLevel->plan.u.pIdx->zName),
3926 zWhere
3927 );
3928 sqlite3DbFree(db, zWhere);
3929 }else if( flags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
dan4bc39fa2010-11-13 16:42:27 +00003930 zMsg = sqlite3MAppendf(db, zMsg, "%s USING INTEGER PRIMARY KEY", zMsg);
dan2ce22452010-11-08 19:01:16 +00003931
3932 if( flags&WHERE_ROWID_EQ ){
3933 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid=?)", zMsg);
drh04098e62010-11-15 21:50:19 +00003934 }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
dan2ce22452010-11-08 19:01:16 +00003935 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid>? AND rowid<?)", zMsg);
3936 }else if( flags&WHERE_BTM_LIMIT ){
3937 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid>?)", zMsg);
3938 }else if( flags&WHERE_TOP_LIMIT ){
3939 zMsg = sqlite3MAppendf(db, zMsg, "%s (rowid<?)", zMsg);
3940 }
3941 }
3942#ifndef SQLITE_OMIT_VIRTUALTABLE
3943 else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
3944 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
3945 zMsg = sqlite3MAppendf(db, zMsg, "%s VIRTUAL TABLE INDEX %d:%s", zMsg,
3946 pVtabIdx->idxNum, pVtabIdx->idxStr);
3947 }
3948#endif
dan4a07e3d2010-11-09 14:48:59 +00003949 if( wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX) ){
drh04098e62010-11-15 21:50:19 +00003950 testcase( wctrlFlags & WHERE_ORDERBY_MIN );
dan4a07e3d2010-11-09 14:48:59 +00003951 nRow = 1;
3952 }else{
3953 nRow = (sqlite3_int64)pLevel->plan.nRow;
3954 }
3955 zMsg = sqlite3MAppendf(db, zMsg, "%s (~%lld rows)", zMsg, nRow);
3956 sqlite3VdbeAddOp4(v, OP_Explain, iId, iLevel, iFrom, zMsg, P4_DYNAMIC);
dan2ce22452010-11-08 19:01:16 +00003957 }
3958}
3959#else
dan17c0bc02010-11-09 17:35:19 +00003960# define explainOneScan(u,v,w,x,y,z)
dan2ce22452010-11-08 19:01:16 +00003961#endif /* SQLITE_OMIT_EXPLAIN */
3962
3963
drh111a6a72008-12-21 03:51:16 +00003964/*
3965** Generate code for the start of the iLevel-th loop in the WHERE clause
3966** implementation described by pWInfo.
3967*/
3968static Bitmask codeOneLoopStart(
3969 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
3970 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh336a5302009-04-24 15:46:21 +00003971 u16 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
drh7a484802012-03-16 00:28:11 +00003972 Bitmask notReady /* Which tables are currently available */
drh111a6a72008-12-21 03:51:16 +00003973){
3974 int j, k; /* Loop counters */
3975 int iCur; /* The VDBE cursor for the table */
3976 int addrNxt; /* Where to jump to continue with the next IN case */
3977 int omitTable; /* True if we use the index only */
3978 int bRev; /* True if we need to scan in reverse order */
3979 WhereLevel *pLevel; /* The where level to be coded */
3980 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
3981 WhereTerm *pTerm; /* A WHERE clause term */
3982 Parse *pParse; /* Parsing context */
3983 Vdbe *v; /* The prepared stmt under constructions */
3984 struct SrcList_item *pTabItem; /* FROM clause term being coded */
drh23d04d52008-12-23 23:56:22 +00003985 int addrBrk; /* Jump here to break out of the loop */
3986 int addrCont; /* Jump here to continue with next cycle */
drh61495262009-04-22 15:32:59 +00003987 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
3988 int iReleaseReg = 0; /* Temp register to free before returning */
drh111a6a72008-12-21 03:51:16 +00003989
3990 pParse = pWInfo->pParse;
3991 v = pParse->pVdbe;
3992 pWC = pWInfo->pWC;
3993 pLevel = &pWInfo->a[iLevel];
3994 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
3995 iCur = pTabItem->iCursor;
3996 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
danielk19771d461462009-04-21 09:02:45 +00003997 omitTable = (pLevel->plan.wsFlags & WHERE_IDX_ONLY)!=0
drh336a5302009-04-24 15:46:21 +00003998 && (wctrlFlags & WHERE_FORCE_TABLE)==0;
drh111a6a72008-12-21 03:51:16 +00003999
4000 /* Create labels for the "break" and "continue" instructions
4001 ** for the current loop. Jump to addrBrk to break out of a loop.
4002 ** Jump to cont to go immediately to the next iteration of the
4003 ** loop.
4004 **
4005 ** When there is an IN operator, we also have a "addrNxt" label that
4006 ** means to continue with the next IN value combination. When
4007 ** there are no IN operators in the constraints, the "addrNxt" label
4008 ** is the same as "addrBrk".
4009 */
4010 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
4011 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
4012
4013 /* If this is the right table of a LEFT OUTER JOIN, allocate and
4014 ** initialize a memory cell that records if this table matches any
4015 ** row of the left table of the join.
4016 */
4017 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
4018 pLevel->iLeftJoin = ++pParse->nMem;
4019 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
4020 VdbeComment((v, "init LEFT JOIN no-match flag"));
4021 }
4022
4023#ifndef SQLITE_OMIT_VIRTUALTABLE
4024 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
4025 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
4026 ** to access the data.
4027 */
4028 int iReg; /* P3 Value for OP_VFilter */
4029 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
4030 int nConstraint = pVtabIdx->nConstraint;
4031 struct sqlite3_index_constraint_usage *aUsage =
4032 pVtabIdx->aConstraintUsage;
4033 const struct sqlite3_index_constraint *aConstraint =
4034 pVtabIdx->aConstraint;
4035
drha62bb8d2009-11-23 21:23:45 +00004036 sqlite3ExprCachePush(pParse);
drh111a6a72008-12-21 03:51:16 +00004037 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
drh111a6a72008-12-21 03:51:16 +00004038 for(j=1; j<=nConstraint; j++){
4039 for(k=0; k<nConstraint; k++){
4040 if( aUsage[k].argvIndex==j ){
4041 int iTerm = aConstraint[k].iTermOffset;
drh111a6a72008-12-21 03:51:16 +00004042 sqlite3ExprCode(pParse, pWC->a[iTerm].pExpr->pRight, iReg+j+1);
4043 break;
4044 }
4045 }
4046 if( k==nConstraint ) break;
4047 }
drh111a6a72008-12-21 03:51:16 +00004048 sqlite3VdbeAddOp2(v, OP_Integer, pVtabIdx->idxNum, iReg);
4049 sqlite3VdbeAddOp2(v, OP_Integer, j-1, iReg+1);
4050 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrBrk, iReg, pVtabIdx->idxStr,
4051 pVtabIdx->needToFreeIdxStr ? P4_MPRINTF : P4_STATIC);
drh111a6a72008-12-21 03:51:16 +00004052 pVtabIdx->needToFreeIdxStr = 0;
4053 for(j=0; j<nConstraint; j++){
4054 if( aUsage[j].omit ){
4055 int iTerm = aConstraint[j].iTermOffset;
4056 disableTerm(pLevel, &pWC->a[iTerm]);
4057 }
4058 }
4059 pLevel->op = OP_VNext;
4060 pLevel->p1 = iCur;
4061 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh23d04d52008-12-23 23:56:22 +00004062 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drha62bb8d2009-11-23 21:23:45 +00004063 sqlite3ExprCachePop(pParse, 1);
drh111a6a72008-12-21 03:51:16 +00004064 }else
4065#endif /* SQLITE_OMIT_VIRTUALTABLE */
4066
4067 if( pLevel->plan.wsFlags & WHERE_ROWID_EQ ){
4068 /* Case 1: We can directly reference a single row using an
4069 ** equality comparison against the ROWID field. Or
4070 ** we reference multiple rows using a "rowid IN (...)"
4071 ** construct.
4072 */
danielk19771d461462009-04-21 09:02:45 +00004073 iReleaseReg = sqlite3GetTempReg(pParse);
drh111a6a72008-12-21 03:51:16 +00004074 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
4075 assert( pTerm!=0 );
4076 assert( pTerm->pExpr!=0 );
4077 assert( pTerm->leftCursor==iCur );
4078 assert( omitTable==0 );
drhe9cdcea2010-07-22 22:40:03 +00004079 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
danielk19771d461462009-04-21 09:02:45 +00004080 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, iReleaseReg);
drh111a6a72008-12-21 03:51:16 +00004081 addrNxt = pLevel->addrNxt;
danielk19771d461462009-04-21 09:02:45 +00004082 sqlite3VdbeAddOp2(v, OP_MustBeInt, iRowidReg, addrNxt);
4083 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, iRowidReg);
drhceea3322009-04-23 13:22:42 +00004084 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
drh111a6a72008-12-21 03:51:16 +00004085 VdbeComment((v, "pk"));
4086 pLevel->op = OP_Noop;
4087 }else if( pLevel->plan.wsFlags & WHERE_ROWID_RANGE ){
4088 /* Case 2: We have an inequality comparison against the ROWID field.
4089 */
4090 int testOp = OP_Noop;
4091 int start;
4092 int memEndValue = 0;
4093 WhereTerm *pStart, *pEnd;
4094
4095 assert( omitTable==0 );
4096 pStart = findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0);
4097 pEnd = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0);
4098 if( bRev ){
4099 pTerm = pStart;
4100 pStart = pEnd;
4101 pEnd = pTerm;
4102 }
4103 if( pStart ){
4104 Expr *pX; /* The expression that defines the start bound */
4105 int r1, rTemp; /* Registers for holding the start boundary */
4106
4107 /* The following constant maps TK_xx codes into corresponding
4108 ** seek opcodes. It depends on a particular ordering of TK_xx
4109 */
4110 const u8 aMoveOp[] = {
4111 /* TK_GT */ OP_SeekGt,
4112 /* TK_LE */ OP_SeekLe,
4113 /* TK_LT */ OP_SeekLt,
4114 /* TK_GE */ OP_SeekGe
4115 };
4116 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
4117 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
4118 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
4119
drhe9cdcea2010-07-22 22:40:03 +00004120 testcase( pStart->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004121 pX = pStart->pExpr;
4122 assert( pX!=0 );
4123 assert( pStart->leftCursor==iCur );
4124 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
4125 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
4126 VdbeComment((v, "pk"));
4127 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
4128 sqlite3ReleaseTempReg(pParse, rTemp);
4129 disableTerm(pLevel, pStart);
4130 }else{
4131 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
4132 }
4133 if( pEnd ){
4134 Expr *pX;
4135 pX = pEnd->pExpr;
4136 assert( pX!=0 );
4137 assert( pEnd->leftCursor==iCur );
drhe9cdcea2010-07-22 22:40:03 +00004138 testcase( pEnd->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004139 memEndValue = ++pParse->nMem;
4140 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
4141 if( pX->op==TK_LT || pX->op==TK_GT ){
4142 testOp = bRev ? OP_Le : OP_Ge;
4143 }else{
4144 testOp = bRev ? OP_Lt : OP_Gt;
4145 }
4146 disableTerm(pLevel, pEnd);
4147 }
4148 start = sqlite3VdbeCurrentAddr(v);
4149 pLevel->op = bRev ? OP_Prev : OP_Next;
4150 pLevel->p1 = iCur;
4151 pLevel->p2 = start;
drhafc266a2010-03-31 17:47:44 +00004152 if( pStart==0 && pEnd==0 ){
4153 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4154 }else{
4155 assert( pLevel->p5==0 );
4156 }
danielk19771d461462009-04-21 09:02:45 +00004157 if( testOp!=OP_Noop ){
4158 iRowidReg = iReleaseReg = sqlite3GetTempReg(pParse);
4159 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00004160 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00004161 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
4162 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00004163 }
4164 }else if( pLevel->plan.wsFlags & (WHERE_COLUMN_RANGE|WHERE_COLUMN_EQ) ){
4165 /* Case 3: A scan using an index.
4166 **
4167 ** The WHERE clause may contain zero or more equality
4168 ** terms ("==" or "IN" operators) that refer to the N
4169 ** left-most columns of the index. It may also contain
4170 ** inequality constraints (>, <, >= or <=) on the indexed
4171 ** column that immediately follows the N equalities. Only
4172 ** the right-most column can be an inequality - the rest must
4173 ** use the "==" and "IN" operators. For example, if the
4174 ** index is on (x,y,z), then the following clauses are all
4175 ** optimized:
4176 **
4177 ** x=5
4178 ** x=5 AND y=10
4179 ** x=5 AND y<10
4180 ** x=5 AND y>5 AND y<10
4181 ** x=5 AND y=5 AND z<=10
4182 **
4183 ** The z<10 term of the following cannot be used, only
4184 ** the x=5 term:
4185 **
4186 ** x=5 AND z<10
4187 **
4188 ** N may be zero if there are inequality constraints.
4189 ** If there are no inequality constraints, then N is at
4190 ** least one.
4191 **
4192 ** This case is also used when there are no WHERE clause
4193 ** constraints but an index is selected anyway, in order
4194 ** to force the output order to conform to an ORDER BY.
4195 */
drh3bb9b932010-08-06 02:10:00 +00004196 static const u8 aStartOp[] = {
drh111a6a72008-12-21 03:51:16 +00004197 0,
4198 0,
4199 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
4200 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
4201 OP_SeekGt, /* 4: (start_constraints && !startEq && !bRev) */
4202 OP_SeekLt, /* 5: (start_constraints && !startEq && bRev) */
4203 OP_SeekGe, /* 6: (start_constraints && startEq && !bRev) */
4204 OP_SeekLe /* 7: (start_constraints && startEq && bRev) */
4205 };
drh3bb9b932010-08-06 02:10:00 +00004206 static const u8 aEndOp[] = {
drh111a6a72008-12-21 03:51:16 +00004207 OP_Noop, /* 0: (!end_constraints) */
4208 OP_IdxGE, /* 1: (end_constraints && !bRev) */
4209 OP_IdxLT /* 2: (end_constraints && bRev) */
4210 };
drh3bb9b932010-08-06 02:10:00 +00004211 int nEq = pLevel->plan.nEq; /* Number of == or IN terms */
drh111a6a72008-12-21 03:51:16 +00004212 int isMinQuery = 0; /* If this is an optimized SELECT min(x).. */
4213 int regBase; /* Base register holding constraint values */
4214 int r1; /* Temp register */
4215 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
4216 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
4217 int startEq; /* True if range start uses ==, >= or <= */
4218 int endEq; /* True if range end uses ==, >= or <= */
4219 int start_constraints; /* Start of range is constrained */
4220 int nConstraint; /* Number of constraint terms */
drh3bb9b932010-08-06 02:10:00 +00004221 Index *pIdx; /* The index we will be using */
4222 int iIdxCur; /* The VDBE cursor for the index */
4223 int nExtraReg = 0; /* Number of extra registers needed */
4224 int op; /* Instruction opcode */
dan6ac43392010-06-09 15:47:11 +00004225 char *zStartAff; /* Affinity for start of range constraint */
4226 char *zEndAff; /* Affinity for end of range constraint */
drh111a6a72008-12-21 03:51:16 +00004227
4228 pIdx = pLevel->plan.u.pIdx;
4229 iIdxCur = pLevel->iIdxCur;
dan0c733f62011-11-16 15:27:09 +00004230 k = (nEq==pIdx->nColumn ? -1 : pIdx->aiColumn[nEq]);
drh111a6a72008-12-21 03:51:16 +00004231
drh111a6a72008-12-21 03:51:16 +00004232 /* If this loop satisfies a sort order (pOrderBy) request that
4233 ** was passed to this function to implement a "SELECT min(x) ..."
4234 ** query, then the caller will only allow the loop to run for
4235 ** a single iteration. This means that the first row returned
4236 ** should not have a NULL value stored in 'x'. If column 'x' is
4237 ** the first one after the nEq equality constraints in the index,
4238 ** this requires some special handling.
4239 */
4240 if( (wctrlFlags&WHERE_ORDERBY_MIN)!=0
drhd663b5b2012-10-03 00:25:54 +00004241 && (pLevel->plan.wsFlags&WHERE_ORDERED)
drh111a6a72008-12-21 03:51:16 +00004242 && (pIdx->nColumn>nEq)
4243 ){
4244 /* assert( pOrderBy->nExpr==1 ); */
4245 /* assert( pOrderBy->a[0].pExpr->iColumn==pIdx->aiColumn[nEq] ); */
4246 isMinQuery = 1;
drh6df2acd2008-12-28 16:55:25 +00004247 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004248 }
4249
4250 /* Find any inequality constraint terms for the start and end
4251 ** of the range.
4252 */
4253 if( pLevel->plan.wsFlags & WHERE_TOP_LIMIT ){
4254 pRangeEnd = findTerm(pWC, iCur, k, notReady, (WO_LT|WO_LE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00004255 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004256 }
4257 if( pLevel->plan.wsFlags & WHERE_BTM_LIMIT ){
4258 pRangeStart = findTerm(pWC, iCur, k, notReady, (WO_GT|WO_GE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00004259 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00004260 }
4261
drh6df2acd2008-12-28 16:55:25 +00004262 /* Generate code to evaluate all constraint terms using == or IN
4263 ** and store the values of those terms in an array of registers
4264 ** starting at regBase.
4265 */
dan69f8bb92009-08-13 19:21:16 +00004266 regBase = codeAllEqualityTerms(
dan6ac43392010-06-09 15:47:11 +00004267 pParse, pLevel, pWC, notReady, nExtraReg, &zStartAff
dan69f8bb92009-08-13 19:21:16 +00004268 );
dan6ac43392010-06-09 15:47:11 +00004269 zEndAff = sqlite3DbStrDup(pParse->db, zStartAff);
drh6df2acd2008-12-28 16:55:25 +00004270 addrNxt = pLevel->addrNxt;
4271
drh111a6a72008-12-21 03:51:16 +00004272 /* If we are doing a reverse order scan on an ascending index, or
4273 ** a forward order scan on a descending index, interchange the
4274 ** start and end terms (pRangeStart and pRangeEnd).
4275 */
dan0c733f62011-11-16 15:27:09 +00004276 if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
4277 || (bRev && pIdx->nColumn==nEq)
4278 ){
drh111a6a72008-12-21 03:51:16 +00004279 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
4280 }
4281
4282 testcase( pRangeStart && pRangeStart->eOperator & WO_LE );
4283 testcase( pRangeStart && pRangeStart->eOperator & WO_GE );
4284 testcase( pRangeEnd && pRangeEnd->eOperator & WO_LE );
4285 testcase( pRangeEnd && pRangeEnd->eOperator & WO_GE );
4286 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
4287 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
4288 start_constraints = pRangeStart || nEq>0;
4289
4290 /* Seek the index cursor to the start of the range. */
4291 nConstraint = nEq;
4292 if( pRangeStart ){
dan69f8bb92009-08-13 19:21:16 +00004293 Expr *pRight = pRangeStart->pExpr->pRight;
4294 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh534230c2011-01-22 00:10:45 +00004295 if( (pRangeStart->wtFlags & TERM_VNULL)==0 ){
4296 sqlite3ExprCodeIsNullJump(v, pRight, regBase+nEq, addrNxt);
4297 }
dan6ac43392010-06-09 15:47:11 +00004298 if( zStartAff ){
4299 if( sqlite3CompareAffinity(pRight, zStartAff[nEq])==SQLITE_AFF_NONE){
drh039fc322009-11-17 18:31:47 +00004300 /* Since the comparison is to be performed with no conversions
4301 ** applied to the operands, set the affinity to apply to pRight to
4302 ** SQLITE_AFF_NONE. */
dan6ac43392010-06-09 15:47:11 +00004303 zStartAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004304 }
dan6ac43392010-06-09 15:47:11 +00004305 if( sqlite3ExprNeedsNoAffinityChange(pRight, zStartAff[nEq]) ){
4306 zStartAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004307 }
4308 }
drh111a6a72008-12-21 03:51:16 +00004309 nConstraint++;
drhe9cdcea2010-07-22 22:40:03 +00004310 testcase( pRangeStart->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004311 }else if( isMinQuery ){
4312 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
4313 nConstraint++;
4314 startEq = 0;
4315 start_constraints = 1;
4316 }
dan6ac43392010-06-09 15:47:11 +00004317 codeApplyAffinity(pParse, regBase, nConstraint, zStartAff);
drh111a6a72008-12-21 03:51:16 +00004318 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
4319 assert( op!=0 );
4320 testcase( op==OP_Rewind );
4321 testcase( op==OP_Last );
4322 testcase( op==OP_SeekGt );
4323 testcase( op==OP_SeekGe );
4324 testcase( op==OP_SeekLe );
4325 testcase( op==OP_SeekLt );
drh8cff69d2009-11-12 19:59:44 +00004326 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh111a6a72008-12-21 03:51:16 +00004327
4328 /* Load the value for the inequality constraint at the end of the
4329 ** range (if any).
4330 */
4331 nConstraint = nEq;
4332 if( pRangeEnd ){
dan69f8bb92009-08-13 19:21:16 +00004333 Expr *pRight = pRangeEnd->pExpr->pRight;
drhf49f3522009-12-30 14:12:38 +00004334 sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
dan69f8bb92009-08-13 19:21:16 +00004335 sqlite3ExprCode(pParse, pRight, regBase+nEq);
drh534230c2011-01-22 00:10:45 +00004336 if( (pRangeEnd->wtFlags & TERM_VNULL)==0 ){
4337 sqlite3ExprCodeIsNullJump(v, pRight, regBase+nEq, addrNxt);
4338 }
dan6ac43392010-06-09 15:47:11 +00004339 if( zEndAff ){
4340 if( sqlite3CompareAffinity(pRight, zEndAff[nEq])==SQLITE_AFF_NONE){
drh039fc322009-11-17 18:31:47 +00004341 /* Since the comparison is to be performed with no conversions
4342 ** applied to the operands, set the affinity to apply to pRight to
4343 ** SQLITE_AFF_NONE. */
dan6ac43392010-06-09 15:47:11 +00004344 zEndAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004345 }
dan6ac43392010-06-09 15:47:11 +00004346 if( sqlite3ExprNeedsNoAffinityChange(pRight, zEndAff[nEq]) ){
4347 zEndAff[nEq] = SQLITE_AFF_NONE;
drh039fc322009-11-17 18:31:47 +00004348 }
4349 }
dan6ac43392010-06-09 15:47:11 +00004350 codeApplyAffinity(pParse, regBase, nEq+1, zEndAff);
drh111a6a72008-12-21 03:51:16 +00004351 nConstraint++;
drhe9cdcea2010-07-22 22:40:03 +00004352 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL ); /* EV: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004353 }
dan6ac43392010-06-09 15:47:11 +00004354 sqlite3DbFree(pParse->db, zStartAff);
4355 sqlite3DbFree(pParse->db, zEndAff);
drh111a6a72008-12-21 03:51:16 +00004356
4357 /* Top of the loop body */
4358 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
4359
4360 /* Check if the index cursor is past the end of the range. */
4361 op = aEndOp[(pRangeEnd || nEq) * (1 + bRev)];
4362 testcase( op==OP_Noop );
4363 testcase( op==OP_IdxGE );
4364 testcase( op==OP_IdxLT );
drh6df2acd2008-12-28 16:55:25 +00004365 if( op!=OP_Noop ){
drh8cff69d2009-11-12 19:59:44 +00004366 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
drh6df2acd2008-12-28 16:55:25 +00004367 sqlite3VdbeChangeP5(v, endEq!=bRev ?1:0);
4368 }
drh111a6a72008-12-21 03:51:16 +00004369
4370 /* If there are inequality constraints, check that the value
4371 ** of the table column that the inequality contrains is not NULL.
4372 ** If it is, jump to the next iteration of the loop.
4373 */
4374 r1 = sqlite3GetTempReg(pParse);
4375 testcase( pLevel->plan.wsFlags & WHERE_BTM_LIMIT );
4376 testcase( pLevel->plan.wsFlags & WHERE_TOP_LIMIT );
drh04098e62010-11-15 21:50:19 +00004377 if( (pLevel->plan.wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0 ){
drh111a6a72008-12-21 03:51:16 +00004378 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, nEq, r1);
4379 sqlite3VdbeAddOp2(v, OP_IsNull, r1, addrCont);
4380 }
danielk19771d461462009-04-21 09:02:45 +00004381 sqlite3ReleaseTempReg(pParse, r1);
drh111a6a72008-12-21 03:51:16 +00004382
4383 /* Seek the table cursor, if required */
drh23d04d52008-12-23 23:56:22 +00004384 disableTerm(pLevel, pRangeStart);
4385 disableTerm(pLevel, pRangeEnd);
danielk19771d461462009-04-21 09:02:45 +00004386 if( !omitTable ){
4387 iRowidReg = iReleaseReg = sqlite3GetTempReg(pParse);
4388 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
drhceea3322009-04-23 13:22:42 +00004389 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danielk19771d461462009-04-21 09:02:45 +00004390 sqlite3VdbeAddOp2(v, OP_Seek, iCur, iRowidReg); /* Deferred seek */
drh111a6a72008-12-21 03:51:16 +00004391 }
drh111a6a72008-12-21 03:51:16 +00004392
4393 /* Record the instruction used to terminate the loop. Disable
4394 ** WHERE clause terms made redundant by the index range scan.
4395 */
drh95e037b2011-03-09 21:02:31 +00004396 if( pLevel->plan.wsFlags & WHERE_UNIQUE ){
4397 pLevel->op = OP_Noop;
4398 }else if( bRev ){
4399 pLevel->op = OP_Prev;
4400 }else{
4401 pLevel->op = OP_Next;
4402 }
drh111a6a72008-12-21 03:51:16 +00004403 pLevel->p1 = iIdxCur;
drh3f4d1d12012-09-15 18:45:54 +00004404 if( pLevel->plan.wsFlags & WHERE_COVER_SCAN ){
4405 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4406 }else{
4407 assert( pLevel->p5==0 );
4408 }
drhdd5f5a62008-12-23 13:35:23 +00004409 }else
4410
drh23d04d52008-12-23 23:56:22 +00004411#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00004412 if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drh111a6a72008-12-21 03:51:16 +00004413 /* Case 4: Two or more separately indexed terms connected by OR
4414 **
4415 ** Example:
4416 **
4417 ** CREATE TABLE t1(a,b,c,d);
4418 ** CREATE INDEX i1 ON t1(a);
4419 ** CREATE INDEX i2 ON t1(b);
4420 ** CREATE INDEX i3 ON t1(c);
4421 **
4422 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
4423 **
4424 ** In the example, there are three indexed terms connected by OR.
danielk19771d461462009-04-21 09:02:45 +00004425 ** The top of the loop looks like this:
drh111a6a72008-12-21 03:51:16 +00004426 **
drh1b26c7c2009-04-22 02:15:47 +00004427 ** Null 1 # Zero the rowset in reg 1
drh111a6a72008-12-21 03:51:16 +00004428 **
danielk19771d461462009-04-21 09:02:45 +00004429 ** Then, for each indexed term, the following. The arguments to
drh1b26c7c2009-04-22 02:15:47 +00004430 ** RowSetTest are such that the rowid of the current row is inserted
4431 ** into the RowSet. If it is already present, control skips the
danielk19771d461462009-04-21 09:02:45 +00004432 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
drh111a6a72008-12-21 03:51:16 +00004433 **
danielk19771d461462009-04-21 09:02:45 +00004434 ** sqlite3WhereBegin(<term>)
drh1b26c7c2009-04-22 02:15:47 +00004435 ** RowSetTest # Insert rowid into rowset
danielk19771d461462009-04-21 09:02:45 +00004436 ** Gosub 2 A
4437 ** sqlite3WhereEnd()
4438 **
4439 ** Following the above, code to terminate the loop. Label A, the target
4440 ** of the Gosub above, jumps to the instruction right after the Goto.
4441 **
drh1b26c7c2009-04-22 02:15:47 +00004442 ** Null 1 # Zero the rowset in reg 1
danielk19771d461462009-04-21 09:02:45 +00004443 ** Goto B # The loop is finished.
4444 **
4445 ** A: <loop body> # Return data, whatever.
4446 **
4447 ** Return 2 # Jump back to the Gosub
4448 **
4449 ** B: <after the loop>
4450 **
drh111a6a72008-12-21 03:51:16 +00004451 */
drh111a6a72008-12-21 03:51:16 +00004452 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
drhc01a3c12009-12-16 22:10:49 +00004453 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
dan0efb72c2012-08-24 18:44:56 +00004454 Index *pCov = 0; /* Potential covering index (or NULL) */
4455 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
danielk19771d461462009-04-21 09:02:45 +00004456
4457 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
shane85095702009-06-15 16:27:08 +00004458 int regRowset = 0; /* Register for RowSet object */
4459 int regRowid = 0; /* Register holding rowid */
danielk19771d461462009-04-21 09:02:45 +00004460 int iLoopBody = sqlite3VdbeMakeLabel(v); /* Start of loop body */
4461 int iRetInit; /* Address of regReturn init */
drhc01a3c12009-12-16 22:10:49 +00004462 int untestedTerms = 0; /* Some terms not completely tested */
drh8871ef52011-10-07 13:33:10 +00004463 int ii; /* Loop counter */
4464 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
drh111a6a72008-12-21 03:51:16 +00004465
4466 pTerm = pLevel->plan.u.pTerm;
4467 assert( pTerm!=0 );
4468 assert( pTerm->eOperator==WO_OR );
4469 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
4470 pOrWc = &pTerm->u.pOrInfo->wc;
drhc01a3c12009-12-16 22:10:49 +00004471 pLevel->op = OP_Return;
4472 pLevel->p1 = regReturn;
drh23d04d52008-12-23 23:56:22 +00004473
danbfca6a42012-08-24 10:52:35 +00004474 /* Set up a new SrcList in pOrTab containing the table being scanned
drhc01a3c12009-12-16 22:10:49 +00004475 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
4476 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
4477 */
4478 if( pWInfo->nLevel>1 ){
4479 int nNotReady; /* The number of notReady tables */
4480 struct SrcList_item *origSrc; /* Original list of tables */
4481 nNotReady = pWInfo->nLevel - iLevel - 1;
4482 pOrTab = sqlite3StackAllocRaw(pParse->db,
4483 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
4484 if( pOrTab==0 ) return notReady;
shaneh46aae3c2009-12-31 19:06:23 +00004485 pOrTab->nAlloc = (i16)(nNotReady + 1);
4486 pOrTab->nSrc = pOrTab->nAlloc;
drhc01a3c12009-12-16 22:10:49 +00004487 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
4488 origSrc = pWInfo->pTabList->a;
4489 for(k=1; k<=nNotReady; k++){
4490 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
4491 }
4492 }else{
4493 pOrTab = pWInfo->pTabList;
4494 }
danielk19771d461462009-04-21 09:02:45 +00004495
drh1b26c7c2009-04-22 02:15:47 +00004496 /* Initialize the rowset register to contain NULL. An SQL NULL is
4497 ** equivalent to an empty rowset.
danielk19771d461462009-04-21 09:02:45 +00004498 **
4499 ** Also initialize regReturn to contain the address of the instruction
4500 ** immediately following the OP_Return at the bottom of the loop. This
4501 ** is required in a few obscure LEFT JOIN cases where control jumps
4502 ** over the top of the loop into the body of it. In this case the
4503 ** correct response for the end-of-loop code (the OP_Return) is to
4504 ** fall through to the next instruction, just as an OP_Next does if
4505 ** called on an uninitialized cursor.
4506 */
drh336a5302009-04-24 15:46:21 +00004507 if( (wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
4508 regRowset = ++pParse->nMem;
4509 regRowid = ++pParse->nMem;
4510 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
4511 }
danielk19771d461462009-04-21 09:02:45 +00004512 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
4513
drh8871ef52011-10-07 13:33:10 +00004514 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
4515 ** Then for every term xN, evaluate as the subexpression: xN AND z
4516 ** That way, terms in y that are factored into the disjunction will
4517 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
drh331b67c2012-03-09 22:02:08 +00004518 **
4519 ** Actually, each subexpression is converted to "xN AND w" where w is
4520 ** the "interesting" terms of z - terms that did not originate in the
4521 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
4522 ** indices.
drh8871ef52011-10-07 13:33:10 +00004523 */
4524 if( pWC->nTerm>1 ){
drh7a484802012-03-16 00:28:11 +00004525 int iTerm;
4526 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
4527 Expr *pExpr = pWC->a[iTerm].pExpr;
drh331b67c2012-03-09 22:02:08 +00004528 if( ExprHasProperty(pExpr, EP_FromJoin) ) continue;
drh7a484802012-03-16 00:28:11 +00004529 if( pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_ORINFO) ) continue;
4530 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drh331b67c2012-03-09 22:02:08 +00004531 pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4532 pAndExpr = sqlite3ExprAnd(pParse->db, pAndExpr, pExpr);
4533 }
4534 if( pAndExpr ){
4535 pAndExpr = sqlite3PExpr(pParse, TK_AND, 0, pAndExpr, 0);
4536 }
drh8871ef52011-10-07 13:33:10 +00004537 }
4538
danielk19771d461462009-04-21 09:02:45 +00004539 for(ii=0; ii<pOrWc->nTerm; ii++){
4540 WhereTerm *pOrTerm = &pOrWc->a[ii];
4541 if( pOrTerm->leftCursor==iCur || pOrTerm->eOperator==WO_AND ){
4542 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
drh8871ef52011-10-07 13:33:10 +00004543 Expr *pOrExpr = pOrTerm->pExpr;
4544 if( pAndExpr ){
4545 pAndExpr->pLeft = pOrExpr;
4546 pOrExpr = pAndExpr;
4547 }
danielk19771d461462009-04-21 09:02:45 +00004548 /* Loop through table entries that match term pOrTerm. */
drh8871ef52011-10-07 13:33:10 +00004549 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
drh9ef61f42011-10-07 14:40:59 +00004550 WHERE_OMIT_OPEN_CLOSE | WHERE_AND_ONLY |
dan0efb72c2012-08-24 18:44:56 +00004551 WHERE_FORCE_TABLE | WHERE_ONETABLE_ONLY, iCovCur);
danbfca6a42012-08-24 10:52:35 +00004552 assert( pSubWInfo || pParse->nErr || pParse->db->mallocFailed );
danielk19771d461462009-04-21 09:02:45 +00004553 if( pSubWInfo ){
danbfca6a42012-08-24 10:52:35 +00004554 WhereLevel *pLvl;
dan17c0bc02010-11-09 17:35:19 +00004555 explainOneScan(
dan4a07e3d2010-11-09 14:48:59 +00004556 pParse, pOrTab, &pSubWInfo->a[0], iLevel, pLevel->iFrom, 0
dan2ce22452010-11-08 19:01:16 +00004557 );
drh336a5302009-04-24 15:46:21 +00004558 if( (wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
4559 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
4560 int r;
4561 r = sqlite3ExprCodeGetColumn(pParse, pTabItem->pTab, -1, iCur,
drha748fdc2012-03-28 01:34:47 +00004562 regRowid, 0);
drh8cff69d2009-11-12 19:59:44 +00004563 sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset,
4564 sqlite3VdbeCurrentAddr(v)+2, r, iSet);
drh336a5302009-04-24 15:46:21 +00004565 }
danielk19771d461462009-04-21 09:02:45 +00004566 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
4567
drhc01a3c12009-12-16 22:10:49 +00004568 /* The pSubWInfo->untestedTerms flag means that this OR term
4569 ** contained one or more AND term from a notReady table. The
4570 ** terms from the notReady table could not be tested and will
4571 ** need to be tested later.
4572 */
4573 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
4574
danbfca6a42012-08-24 10:52:35 +00004575 /* If all of the OR-connected terms are optimized using the same
4576 ** index, and the index is opened using the same cursor number
4577 ** by each call to sqlite3WhereBegin() made by this loop, it may
4578 ** be possible to use that index as a covering index.
4579 **
4580 ** If the call to sqlite3WhereBegin() above resulted in a scan that
4581 ** uses an index, and this is either the first OR-connected term
4582 ** processed or the index is the same as that used by all previous
dan0efb72c2012-08-24 18:44:56 +00004583 ** terms, set pCov to the candidate covering index. Otherwise, set
4584 ** pCov to NULL to indicate that no candidate covering index will
4585 ** be available.
danbfca6a42012-08-24 10:52:35 +00004586 */
4587 pLvl = &pSubWInfo->a[0];
4588 if( (pLvl->plan.wsFlags & WHERE_INDEXED)!=0
4589 && (pLvl->plan.wsFlags & WHERE_TEMP_INDEX)==0
dan0efb72c2012-08-24 18:44:56 +00004590 && (ii==0 || pLvl->plan.u.pIdx==pCov)
danbfca6a42012-08-24 10:52:35 +00004591 ){
dan0efb72c2012-08-24 18:44:56 +00004592 assert( pLvl->iIdxCur==iCovCur );
danbfca6a42012-08-24 10:52:35 +00004593 pCov = pLvl->plan.u.pIdx;
danbfca6a42012-08-24 10:52:35 +00004594 }else{
4595 pCov = 0;
4596 }
4597
danielk19771d461462009-04-21 09:02:45 +00004598 /* Finish the loop through table entries that match term pOrTerm. */
4599 sqlite3WhereEnd(pSubWInfo);
4600 }
drhdd5f5a62008-12-23 13:35:23 +00004601 }
4602 }
drhd40e2082012-08-24 23:24:15 +00004603 pLevel->u.pCovidx = pCov;
danbfca6a42012-08-24 10:52:35 +00004604 pLevel->iIdxCur = iCovCur;
drh331b67c2012-03-09 22:02:08 +00004605 if( pAndExpr ){
4606 pAndExpr->pLeft = 0;
4607 sqlite3ExprDelete(pParse->db, pAndExpr);
4608 }
danielk19771d461462009-04-21 09:02:45 +00004609 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
danielk19771d461462009-04-21 09:02:45 +00004610 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrBrk);
4611 sqlite3VdbeResolveLabel(v, iLoopBody);
4612
drhc01a3c12009-12-16 22:10:49 +00004613 if( pWInfo->nLevel>1 ) sqlite3StackFree(pParse->db, pOrTab);
4614 if( !untestedTerms ) disableTerm(pLevel, pTerm);
drhdd5f5a62008-12-23 13:35:23 +00004615 }else
drh23d04d52008-12-23 23:56:22 +00004616#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00004617
4618 {
drh111a6a72008-12-21 03:51:16 +00004619 /* Case 5: There is no usable index. We must do a complete
4620 ** scan of the entire table.
4621 */
drh699b3d42009-02-23 16:52:07 +00004622 static const u8 aStep[] = { OP_Next, OP_Prev };
4623 static const u8 aStart[] = { OP_Rewind, OP_Last };
4624 assert( bRev==0 || bRev==1 );
drh111a6a72008-12-21 03:51:16 +00004625 assert( omitTable==0 );
drh699b3d42009-02-23 16:52:07 +00004626 pLevel->op = aStep[bRev];
drh111a6a72008-12-21 03:51:16 +00004627 pLevel->p1 = iCur;
drh699b3d42009-02-23 16:52:07 +00004628 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrBrk);
drh111a6a72008-12-21 03:51:16 +00004629 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
4630 }
4631 notReady &= ~getMask(pWC->pMaskSet, iCur);
4632
4633 /* Insert code to test every subexpression that can be completely
4634 ** computed using the current set of tables.
drhe9cdcea2010-07-22 22:40:03 +00004635 **
4636 ** IMPLEMENTATION-OF: R-49525-50935 Terms that cannot be satisfied through
4637 ** the use of indices become tests that are evaluated against each row of
4638 ** the relevant input tables.
drh111a6a72008-12-21 03:51:16 +00004639 */
drh111a6a72008-12-21 03:51:16 +00004640 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
4641 Expr *pE;
drhe9cdcea2010-07-22 22:40:03 +00004642 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* IMP: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004643 testcase( pTerm->wtFlags & TERM_CODED );
4644 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhc01a3c12009-12-16 22:10:49 +00004645 if( (pTerm->prereqAll & notReady)!=0 ){
4646 testcase( pWInfo->untestedTerms==0
4647 && (pWInfo->wctrlFlags & WHERE_ONETABLE_ONLY)!=0 );
4648 pWInfo->untestedTerms = 1;
4649 continue;
4650 }
drh111a6a72008-12-21 03:51:16 +00004651 pE = pTerm->pExpr;
4652 assert( pE!=0 );
4653 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
4654 continue;
4655 }
drh111a6a72008-12-21 03:51:16 +00004656 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
drh111a6a72008-12-21 03:51:16 +00004657 pTerm->wtFlags |= TERM_CODED;
4658 }
4659
4660 /* For a LEFT OUTER JOIN, generate code that will record the fact that
4661 ** at least one row of the right table has matched the left table.
4662 */
4663 if( pLevel->iLeftJoin ){
4664 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
4665 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
4666 VdbeComment((v, "record LEFT JOIN hit"));
drhceea3322009-04-23 13:22:42 +00004667 sqlite3ExprCacheClear(pParse);
drh111a6a72008-12-21 03:51:16 +00004668 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
drhe9cdcea2010-07-22 22:40:03 +00004669 testcase( pTerm->wtFlags & TERM_VIRTUAL ); /* IMP: R-30575-11662 */
drh111a6a72008-12-21 03:51:16 +00004670 testcase( pTerm->wtFlags & TERM_CODED );
4671 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhc01a3c12009-12-16 22:10:49 +00004672 if( (pTerm->prereqAll & notReady)!=0 ){
drhb057e562009-12-16 23:43:55 +00004673 assert( pWInfo->untestedTerms );
drhc01a3c12009-12-16 22:10:49 +00004674 continue;
4675 }
drh111a6a72008-12-21 03:51:16 +00004676 assert( pTerm->pExpr );
4677 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
4678 pTerm->wtFlags |= TERM_CODED;
4679 }
4680 }
danielk19771d461462009-04-21 09:02:45 +00004681 sqlite3ReleaseTempReg(pParse, iReleaseReg);
drh23d04d52008-12-23 23:56:22 +00004682
drh111a6a72008-12-21 03:51:16 +00004683 return notReady;
4684}
4685
drh549c8b62005-09-19 13:15:23 +00004686#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00004687/*
4688** The following variable holds a text description of query plan generated
4689** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
4690** overwrites the previous. This information is used for testing and
4691** analysis only.
4692*/
4693char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
4694static int nQPlan = 0; /* Next free slow in _query_plan[] */
4695
4696#endif /* SQLITE_TEST */
4697
4698
drh9eff6162006-06-12 21:59:13 +00004699/*
4700** Free a WhereInfo structure
4701*/
drh10fe8402008-10-11 16:47:35 +00004702static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh52ff8ea2010-04-08 14:15:56 +00004703 if( ALWAYS(pWInfo) ){
drh9eff6162006-06-12 21:59:13 +00004704 int i;
4705 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00004706 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
4707 if( pInfo ){
danielk19771d461462009-04-21 09:02:45 +00004708 /* assert( pInfo->needToFreeIdxStr==0 || db->mallocFailed ); */
danielk197780442942008-12-24 11:25:39 +00004709 if( pInfo->needToFreeIdxStr ){
4710 sqlite3_free(pInfo->idxStr);
danielk1977be229652009-03-20 14:18:51 +00004711 }
drh633e6d52008-07-28 19:34:53 +00004712 sqlite3DbFree(db, pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00004713 }
drh8b307fb2010-04-06 15:57:05 +00004714 if( pWInfo->a[i].plan.wsFlags & WHERE_TEMP_INDEX ){
drha21a64d2010-04-06 22:33:55 +00004715 Index *pIdx = pWInfo->a[i].plan.u.pIdx;
4716 if( pIdx ){
4717 sqlite3DbFree(db, pIdx->zColAff);
4718 sqlite3DbFree(db, pIdx);
4719 }
drh8b307fb2010-04-06 15:57:05 +00004720 }
drh9eff6162006-06-12 21:59:13 +00004721 }
drh111a6a72008-12-21 03:51:16 +00004722 whereClauseClear(pWInfo->pWC);
drh633e6d52008-07-28 19:34:53 +00004723 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00004724 }
4725}
4726
drh94a11212004-09-25 13:12:14 +00004727
4728/*
drhe3184742002-06-19 14:27:05 +00004729** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00004730** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00004731** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00004732** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00004733** in order to complete the WHERE clause processing.
4734**
4735** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00004736**
4737** The basic idea is to do a nested loop, one loop for each table in
4738** the FROM clause of a select. (INSERT and UPDATE statements are the
4739** same as a SELECT with only a single table in the FROM clause.) For
4740** example, if the SQL is this:
4741**
4742** SELECT * FROM t1, t2, t3 WHERE ...;
4743**
4744** Then the code generated is conceptually like the following:
4745**
4746** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00004747** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00004748** foreach row3 in t3 do /
4749** ...
4750** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00004751** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00004752** end /
4753**
drh29dda4a2005-07-21 18:23:20 +00004754** Note that the loops might not be nested in the order in which they
4755** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00004756** use of indices. Note also that when the IN operator appears in
4757** the WHERE clause, it might result in additional nested loops for
4758** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00004759**
drhc27a1ce2002-06-14 20:58:45 +00004760** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00004761** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
4762** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00004763** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00004764**
drhe6f85e72004-12-25 01:03:13 +00004765** The code that sqlite3WhereBegin() generates leaves the cursors named
4766** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00004767** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00004768** data from the various tables of the loop.
4769**
drhc27a1ce2002-06-14 20:58:45 +00004770** If the WHERE clause is empty, the foreach loops must each scan their
4771** entire tables. Thus a three-way join is an O(N^3) operation. But if
4772** the tables have indices and there are terms in the WHERE clause that
4773** refer to those indices, a complete table scan can be avoided and the
4774** code will run much faster. Most of the work of this routine is checking
4775** to see if there are indices that can be used to speed up the loop.
4776**
4777** Terms of the WHERE clause are also used to limit which rows actually
4778** make it to the "..." in the middle of the loop. After each "foreach",
4779** terms of the WHERE clause that use only terms in that loop and outer
4780** loops are evaluated and if false a jump is made around all subsequent
4781** inner loops (or around the "..." if the test occurs within the inner-
4782** most loop)
4783**
4784** OUTER JOINS
4785**
4786** An outer join of tables t1 and t2 is conceptally coded as follows:
4787**
4788** foreach row1 in t1 do
4789** flag = 0
4790** foreach row2 in t2 do
4791** start:
4792** ...
4793** flag = 1
4794** end
drhe3184742002-06-19 14:27:05 +00004795** if flag==0 then
4796** move the row2 cursor to a null row
4797** goto start
4798** fi
drhc27a1ce2002-06-14 20:58:45 +00004799** end
4800**
drhe3184742002-06-19 14:27:05 +00004801** ORDER BY CLAUSE PROCESSING
4802**
drh46ec5b62012-09-24 15:30:54 +00004803** pOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
drhe3184742002-06-19 14:27:05 +00004804** if there is one. If there is no ORDER BY clause or if this routine
drh46ec5b62012-09-24 15:30:54 +00004805** is called from an UPDATE or DELETE statement, then pOrderBy is NULL.
drhe3184742002-06-19 14:27:05 +00004806**
4807** If an index can be used so that the natural output order of the table
4808** scan is correct for the ORDER BY clause, then that index is used and
drh46ec5b62012-09-24 15:30:54 +00004809** the returned WhereInfo.nOBSat field is set to pOrderBy->nExpr. This
4810** is an optimization that prevents an unnecessary sort of the result set
4811** if an index appropriate for the ORDER BY clause already exists.
drhe3184742002-06-19 14:27:05 +00004812**
4813** If the where clause loops cannot be arranged to provide the correct
drh46ec5b62012-09-24 15:30:54 +00004814** output order, then WhereInfo.nOBSat is 0.
drh75897232000-05-29 14:26:00 +00004815*/
danielk19774adee202004-05-08 08:23:19 +00004816WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00004817 Parse *pParse, /* The parser context */
4818 SrcList *pTabList, /* A list of all tables to be scanned */
4819 Expr *pWhere, /* The WHERE clause */
drh46ec5b62012-09-24 15:30:54 +00004820 ExprList *pOrderBy, /* An ORDER BY clause, or NULL */
dan38cc40c2011-06-30 20:17:15 +00004821 ExprList *pDistinct, /* The select-list for DISTINCT queries - or NULL */
dan0efb72c2012-08-24 18:44:56 +00004822 u16 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
4823 int iIdxCur /* If WHERE_ONETABLE_ONLY is set, index cursor number */
drh75897232000-05-29 14:26:00 +00004824){
danielk1977be229652009-03-20 14:18:51 +00004825 int nByteWInfo; /* Num. bytes allocated for WhereInfo struct */
drhc01a3c12009-12-16 22:10:49 +00004826 int nTabList; /* Number of elements in pTabList */
drh75897232000-05-29 14:26:00 +00004827 WhereInfo *pWInfo; /* Will become the return value of this function */
4828 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhfe05af82005-07-21 03:14:59 +00004829 Bitmask notReady; /* Cursors that are not yet positioned */
drh56f1b992012-09-25 14:29:39 +00004830 WhereBestIdx sWBI; /* Best index search context */
drh111a6a72008-12-21 03:51:16 +00004831 WhereMaskSet *pMaskSet; /* The expression mask set */
drh56f1b992012-09-25 14:29:39 +00004832 WhereLevel *pLevel; /* A single level in pWInfo->a[] */
4833 int iFrom; /* First unused FROM clause element */
drh111a6a72008-12-21 03:51:16 +00004834 int andFlags; /* AND-ed combination of all pWC->a[].wtFlags */
drh9cd1c992012-09-25 20:43:35 +00004835 int ii; /* Loop counter */
drh17435752007-08-16 04:30:38 +00004836 sqlite3 *db; /* Database connection */
drh75897232000-05-29 14:26:00 +00004837
drh56f1b992012-09-25 14:29:39 +00004838
4839 /* Variable initialization */
4840 memset(&sWBI, 0, sizeof(sWBI));
4841 sWBI.pParse = pParse;
4842
drh29dda4a2005-07-21 18:23:20 +00004843 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00004844 ** bits in a Bitmask
4845 */
drh67ae0cb2010-04-08 14:38:51 +00004846 testcase( pTabList->nSrc==BMS );
drh29dda4a2005-07-21 18:23:20 +00004847 if( pTabList->nSrc>BMS ){
4848 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00004849 return 0;
4850 }
4851
drhc01a3c12009-12-16 22:10:49 +00004852 /* This function normally generates a nested loop for all tables in
4853 ** pTabList. But if the WHERE_ONETABLE_ONLY flag is set, then we should
4854 ** only generate code for the first table in pTabList and assume that
4855 ** any cursors associated with subsequent tables are uninitialized.
4856 */
4857 nTabList = (wctrlFlags & WHERE_ONETABLE_ONLY) ? 1 : pTabList->nSrc;
4858
drh75897232000-05-29 14:26:00 +00004859 /* Allocate and initialize the WhereInfo structure that will become the
danielk1977be229652009-03-20 14:18:51 +00004860 ** return value. A single allocation is used to store the WhereInfo
4861 ** struct, the contents of WhereInfo.a[], the WhereClause structure
4862 ** and the WhereMaskSet structure. Since WhereClause contains an 8-byte
4863 ** field (type Bitmask) it must be aligned on an 8-byte boundary on
4864 ** some architectures. Hence the ROUND8() below.
drh75897232000-05-29 14:26:00 +00004865 */
drh17435752007-08-16 04:30:38 +00004866 db = pParse->db;
drhc01a3c12009-12-16 22:10:49 +00004867 nByteWInfo = ROUND8(sizeof(WhereInfo)+(nTabList-1)*sizeof(WhereLevel));
danielk1977be229652009-03-20 14:18:51 +00004868 pWInfo = sqlite3DbMallocZero(db,
4869 nByteWInfo +
4870 sizeof(WhereClause) +
4871 sizeof(WhereMaskSet)
4872 );
drh17435752007-08-16 04:30:38 +00004873 if( db->mallocFailed ){
drh8b307fb2010-04-06 15:57:05 +00004874 sqlite3DbFree(db, pWInfo);
4875 pWInfo = 0;
danielk197785574e32008-10-06 05:32:18 +00004876 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00004877 }
drhc01a3c12009-12-16 22:10:49 +00004878 pWInfo->nLevel = nTabList;
drh75897232000-05-29 14:26:00 +00004879 pWInfo->pParse = pParse;
4880 pWInfo->pTabList = pTabList;
danielk19774adee202004-05-08 08:23:19 +00004881 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh56f1b992012-09-25 14:29:39 +00004882 pWInfo->pWC = sWBI.pWC = (WhereClause *)&((u8 *)pWInfo)[nByteWInfo];
drh6df2acd2008-12-28 16:55:25 +00004883 pWInfo->wctrlFlags = wctrlFlags;
drh8b307fb2010-04-06 15:57:05 +00004884 pWInfo->savedNQueryLoop = pParse->nQueryLoop;
drh56f1b992012-09-25 14:29:39 +00004885 pMaskSet = (WhereMaskSet*)&sWBI.pWC[1];
drh46c35f92012-09-26 23:17:01 +00004886 sWBI.aLevel = pWInfo->a;
drh08192d52002-04-30 19:20:28 +00004887
drha9b1b912011-07-08 13:07:02 +00004888 /* Disable the DISTINCT optimization if SQLITE_DistinctOpt is set via
4889 ** sqlite3_test_ctrl(SQLITE_TESTCTRL_OPTIMIZATIONS,...) */
drh7e5418e2012-09-27 15:05:54 +00004890 if( OptimizationDisabled(db, SQLITE_DistinctOpt) ) pDistinct = 0;
drha9b1b912011-07-08 13:07:02 +00004891
drh111a6a72008-12-21 03:51:16 +00004892 /* Split the WHERE clause into separate subexpressions where each
4893 ** subexpression is separated by an AND operator.
4894 */
4895 initMaskSet(pMaskSet);
drh56f1b992012-09-25 14:29:39 +00004896 whereClauseInit(sWBI.pWC, pParse, pMaskSet, wctrlFlags);
drh111a6a72008-12-21 03:51:16 +00004897 sqlite3ExprCodeConstants(pParse, pWhere);
drh56f1b992012-09-25 14:29:39 +00004898 whereSplit(sWBI.pWC, pWhere, TK_AND); /* IMP: R-15842-53296 */
drh111a6a72008-12-21 03:51:16 +00004899
drh08192d52002-04-30 19:20:28 +00004900 /* Special case: a WHERE clause that is constant. Evaluate the
4901 ** expression and either jump over all of the code or fall thru.
4902 */
drhc01a3c12009-12-16 22:10:49 +00004903 if( pWhere && (nTabList==0 || sqlite3ExprIsConstantNotJoin(pWhere)) ){
drh35573352008-01-08 23:54:25 +00004904 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, SQLITE_JUMPIFNULL);
drhdf199a22002-06-14 22:38:41 +00004905 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00004906 }
drh75897232000-05-29 14:26:00 +00004907
drh42165be2008-03-26 14:56:34 +00004908 /* Assign a bit from the bitmask to every term in the FROM clause.
4909 **
4910 ** When assigning bitmask values to FROM clause cursors, it must be
4911 ** the case that if X is the bitmask for the N-th FROM clause term then
4912 ** the bitmask for all FROM clause terms to the left of the N-th term
4913 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
4914 ** its Expr.iRightJoinTable value to find the bitmask of the right table
4915 ** of the join. Subtracting one from the right table bitmask gives a
4916 ** bitmask for all tables to the left of the join. Knowing the bitmask
4917 ** for all tables to the left of a left join is important. Ticket #3015.
danielk1977e672c8e2009-05-22 15:43:26 +00004918 **
4919 ** Configure the WhereClause.vmask variable so that bits that correspond
4920 ** to virtual table cursors are set. This is used to selectively disable
4921 ** the OR-to-IN transformation in exprAnalyzeOrTerm(). It is not helpful
4922 ** with virtual tables.
drhc01a3c12009-12-16 22:10:49 +00004923 **
4924 ** Note that bitmasks are created for all pTabList->nSrc tables in
4925 ** pTabList, not just the first nTabList tables. nTabList is normally
4926 ** equal to pTabList->nSrc but might be shortened to 1 if the
4927 ** WHERE_ONETABLE_ONLY flag is set.
drh42165be2008-03-26 14:56:34 +00004928 */
drh56f1b992012-09-25 14:29:39 +00004929 assert( sWBI.pWC->vmask==0 && pMaskSet->n==0 );
drh9cd1c992012-09-25 20:43:35 +00004930 for(ii=0; ii<pTabList->nSrc; ii++){
4931 createMask(pMaskSet, pTabList->a[ii].iCursor);
shanee26fa4c2009-06-16 14:15:22 +00004932#ifndef SQLITE_OMIT_VIRTUALTABLE
drh9cd1c992012-09-25 20:43:35 +00004933 if( ALWAYS(pTabList->a[ii].pTab) && IsVirtual(pTabList->a[ii].pTab) ){
4934 sWBI.pWC->vmask |= ((Bitmask)1 << ii);
danielk1977e672c8e2009-05-22 15:43:26 +00004935 }
shanee26fa4c2009-06-16 14:15:22 +00004936#endif
drh42165be2008-03-26 14:56:34 +00004937 }
4938#ifndef NDEBUG
4939 {
4940 Bitmask toTheLeft = 0;
drh9cd1c992012-09-25 20:43:35 +00004941 for(ii=0; ii<pTabList->nSrc; ii++){
4942 Bitmask m = getMask(pMaskSet, pTabList->a[ii].iCursor);
drh42165be2008-03-26 14:56:34 +00004943 assert( (m-1)==toTheLeft );
4944 toTheLeft |= m;
4945 }
4946 }
4947#endif
4948
drh29dda4a2005-07-21 18:23:20 +00004949 /* Analyze all of the subexpressions. Note that exprAnalyze() might
4950 ** add new virtual terms onto the end of the WHERE clause. We do not
4951 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00004952 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00004953 */
drh56f1b992012-09-25 14:29:39 +00004954 exprAnalyzeAll(pTabList, sWBI.pWC);
drh17435752007-08-16 04:30:38 +00004955 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00004956 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00004957 }
drh75897232000-05-29 14:26:00 +00004958
dan38cc40c2011-06-30 20:17:15 +00004959 /* Check if the DISTINCT qualifier, if there is one, is redundant.
4960 ** If it is, then set pDistinct to NULL and WhereInfo.eDistinct to
4961 ** WHERE_DISTINCT_UNIQUE to tell the caller to ignore the DISTINCT.
4962 */
drh56f1b992012-09-25 14:29:39 +00004963 if( pDistinct && isDistinctRedundant(pParse, pTabList, sWBI.pWC, pDistinct) ){
dan38cc40c2011-06-30 20:17:15 +00004964 pDistinct = 0;
4965 pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
4966 }
4967
drh29dda4a2005-07-21 18:23:20 +00004968 /* Chose the best index to use for each table in the FROM clause.
4969 **
drh51147ba2005-07-23 22:59:55 +00004970 ** This loop fills in the following fields:
4971 **
4972 ** pWInfo->a[].pIdx The index to use for this level of the loop.
drh165be382008-12-05 02:36:33 +00004973 ** pWInfo->a[].wsFlags WHERE_xxx flags associated with pIdx
drh51147ba2005-07-23 22:59:55 +00004974 ** pWInfo->a[].nEq The number of == and IN constraints
danielk197785574e32008-10-06 05:32:18 +00004975 ** pWInfo->a[].iFrom Which term of the FROM clause is being coded
drh51147ba2005-07-23 22:59:55 +00004976 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
4977 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
drh111a6a72008-12-21 03:51:16 +00004978 ** pWInfo->a[].pTerm When wsFlags==WO_OR, the OR-clause term
drh51147ba2005-07-23 22:59:55 +00004979 **
4980 ** This loop also figures out the nesting order of tables in the FROM
4981 ** clause.
drh75897232000-05-29 14:26:00 +00004982 */
drh9cd1c992012-09-25 20:43:35 +00004983 sWBI.notValid = ~(Bitmask)0;
4984 sWBI.pOrderBy = pOrderBy;
4985 sWBI.n = nTabList;
4986 sWBI.pDistinct = pDistinct;
drh943af3c2005-07-29 19:43:58 +00004987 andFlags = ~0;
drh4f0c5872007-03-26 22:05:01 +00004988 WHERETRACE(("*** Optimizer Start ***\n"));
drh9cd1c992012-09-25 20:43:35 +00004989 for(sWBI.i=iFrom=0, pLevel=pWInfo->a; sWBI.i<nTabList; sWBI.i++, pLevel++){
drh111a6a72008-12-21 03:51:16 +00004990 WhereCost bestPlan; /* Most efficient plan seen so far */
drh29dda4a2005-07-21 18:23:20 +00004991 Index *pIdx; /* Index for FROM table at pTabItem */
drh29dda4a2005-07-21 18:23:20 +00004992 int j; /* For looping over FROM tables */
dan5236ac12009-08-13 07:09:33 +00004993 int bestJ = -1; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00004994 Bitmask m; /* Bitmask value for j or bestJ */
dan5236ac12009-08-13 07:09:33 +00004995 int isOptimal; /* Iterator for optimal/non-optimal search */
drh5e377d92010-08-04 21:17:16 +00004996 int nUnconstrained; /* Number tables without INDEXED BY */
drhaa0ba432010-08-05 02:52:32 +00004997 Bitmask notIndexed; /* Mask of tables that cannot use an index */
drh29dda4a2005-07-21 18:23:20 +00004998
drh111a6a72008-12-21 03:51:16 +00004999 memset(&bestPlan, 0, sizeof(bestPlan));
5000 bestPlan.rCost = SQLITE_BIG_DBL;
drh9cd1c992012-09-25 20:43:35 +00005001 WHERETRACE(("*** Begin search for loop %d ***\n", sWBI.i));
drhdf26fd52006-06-06 11:45:54 +00005002
dan5236ac12009-08-13 07:09:33 +00005003 /* Loop through the remaining entries in the FROM clause to find the
drhed754ce2010-04-15 01:04:54 +00005004 ** next nested loop. The loop tests all FROM clause entries
dan5236ac12009-08-13 07:09:33 +00005005 ** either once or twice.
5006 **
drhed754ce2010-04-15 01:04:54 +00005007 ** The first test is always performed if there are two or more entries
5008 ** remaining and never performed if there is only one FROM clause entry
5009 ** to choose from. The first test looks for an "optimal" scan. In
dan5236ac12009-08-13 07:09:33 +00005010 ** this context an optimal scan is one that uses the same strategy
5011 ** for the given FROM clause entry as would be selected if the entry
drhd0015162009-08-21 13:22:25 +00005012 ** were used as the innermost nested loop. In other words, a table
5013 ** is chosen such that the cost of running that table cannot be reduced
drhed754ce2010-04-15 01:04:54 +00005014 ** by waiting for other tables to run first. This "optimal" test works
5015 ** by first assuming that the FROM clause is on the inner loop and finding
5016 ** its query plan, then checking to see if that query plan uses any
drh9cd1c992012-09-25 20:43:35 +00005017 ** other FROM clause terms that are sWBI.notValid. If no notValid terms
5018 ** are used then the "optimal" query plan works.
dan5236ac12009-08-13 07:09:33 +00005019 **
drh547caad2010-10-04 23:55:50 +00005020 ** Note that the WhereCost.nRow parameter for an optimal scan might
5021 ** not be as small as it would be if the table really were the innermost
5022 ** join. The nRow value can be reduced by WHERE clause constraints
5023 ** that do not use indices. But this nRow reduction only happens if the
5024 ** table really is the innermost join.
5025 **
drhed754ce2010-04-15 01:04:54 +00005026 ** The second loop iteration is only performed if no optimal scan
drh547caad2010-10-04 23:55:50 +00005027 ** strategies were found by the first iteration. This second iteration
5028 ** is used to search for the lowest cost scan overall.
dan5236ac12009-08-13 07:09:33 +00005029 **
5030 ** Previous versions of SQLite performed only the second iteration -
5031 ** the next outermost loop was always that with the lowest overall
5032 ** cost. However, this meant that SQLite could select the wrong plan
5033 ** for scripts such as the following:
5034 **
5035 ** CREATE TABLE t1(a, b);
5036 ** CREATE TABLE t2(c, d);
5037 ** SELECT * FROM t2, t1 WHERE t2.rowid = t1.a;
5038 **
5039 ** The best strategy is to iterate through table t1 first. However it
5040 ** is not possible to determine this with a simple greedy algorithm.
drh15564052010-09-25 22:32:56 +00005041 ** Since the cost of a linear scan through table t2 is the same
dan5236ac12009-08-13 07:09:33 +00005042 ** as the cost of a linear scan through table t1, a simple greedy
5043 ** algorithm may choose to use t2 for the outer loop, which is a much
5044 ** costlier approach.
5045 */
drh5e377d92010-08-04 21:17:16 +00005046 nUnconstrained = 0;
drhaa0ba432010-08-05 02:52:32 +00005047 notIndexed = 0;
drh547caad2010-10-04 23:55:50 +00005048 for(isOptimal=(iFrom<nTabList-1); isOptimal>=0 && bestJ<0; isOptimal--){
drh56f1b992012-09-25 14:29:39 +00005049 for(j=iFrom, sWBI.pSrc=&pTabList->a[j]; j<nTabList; j++, sWBI.pSrc++){
dan5236ac12009-08-13 07:09:33 +00005050 int doNotReorder; /* True if this table should not be reordered */
dan5236ac12009-08-13 07:09:33 +00005051
drh56f1b992012-09-25 14:29:39 +00005052 doNotReorder = (sWBI.pSrc->jointype & (JT_LEFT|JT_CROSS))!=0;
dan5236ac12009-08-13 07:09:33 +00005053 if( j!=iFrom && doNotReorder ) break;
drh56f1b992012-09-25 14:29:39 +00005054 m = getMask(pMaskSet, sWBI.pSrc->iCursor);
drh9cd1c992012-09-25 20:43:35 +00005055 if( (m & sWBI.notValid)==0 ){
dan5236ac12009-08-13 07:09:33 +00005056 if( j==iFrom ) iFrom++;
5057 continue;
5058 }
drh9cd1c992012-09-25 20:43:35 +00005059 sWBI.notReady = (isOptimal ? m : sWBI.notValid);
drh56f1b992012-09-25 14:29:39 +00005060 if( sWBI.pSrc->pIndex==0 ) nUnconstrained++;
dan5236ac12009-08-13 07:09:33 +00005061
drh8e4af1b2012-10-08 18:23:51 +00005062 WHERETRACE((" === trying table %d (%s) with isOptimal=%d ===\n",
drh1afcaae2012-10-02 01:10:00 +00005063 j, sWBI.pSrc->pTab->zName, isOptimal));
drh56f1b992012-09-25 14:29:39 +00005064 assert( sWBI.pSrc->pTab );
drh9eff6162006-06-12 21:59:13 +00005065#ifndef SQLITE_OMIT_VIRTUALTABLE
drh56f1b992012-09-25 14:29:39 +00005066 if( IsVirtual(sWBI.pSrc->pTab) ){
5067 sWBI.ppIdxInfo = &pWInfo->a[j].pIdxInfo;
5068 bestVirtualIndex(&sWBI);
dan5236ac12009-08-13 07:09:33 +00005069 }else
drh9eff6162006-06-12 21:59:13 +00005070#endif
dan5236ac12009-08-13 07:09:33 +00005071 {
drh56f1b992012-09-25 14:29:39 +00005072 bestBtreeIndex(&sWBI);
dan5236ac12009-08-13 07:09:33 +00005073 }
drh9cd1c992012-09-25 20:43:35 +00005074 assert( isOptimal || (sWBI.cost.used&sWBI.notValid)==0 );
dan5236ac12009-08-13 07:09:33 +00005075
drhaa0ba432010-08-05 02:52:32 +00005076 /* If an INDEXED BY clause is present, then the plan must use that
5077 ** index if it uses any index at all */
drh56f1b992012-09-25 14:29:39 +00005078 assert( sWBI.pSrc->pIndex==0
5079 || (sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)==0
5080 || sWBI.cost.plan.u.pIdx==sWBI.pSrc->pIndex );
drhaa0ba432010-08-05 02:52:32 +00005081
drh56f1b992012-09-25 14:29:39 +00005082 if( isOptimal && (sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)==0 ){
drhaa0ba432010-08-05 02:52:32 +00005083 notIndexed |= m;
5084 }
5085
drh5e377d92010-08-04 21:17:16 +00005086 /* Conditions under which this table becomes the best so far:
5087 **
5088 ** (1) The table must not depend on other tables that have not
drh9cd1c992012-09-25 20:43:35 +00005089 ** yet run. (In other words, it must not depend on tables
5090 ** in inner loops.)
drh5e377d92010-08-04 21:17:16 +00005091 **
drh92e4feb2011-03-04 00:56:58 +00005092 ** (2) A full-table-scan plan cannot supercede indexed plan unless
5093 ** the full-table-scan is an "optimal" plan as defined above.
drh5e377d92010-08-04 21:17:16 +00005094 **
drhaa0ba432010-08-05 02:52:32 +00005095 ** (3) All tables have an INDEXED BY clause or this table lacks an
drh5e377d92010-08-04 21:17:16 +00005096 ** INDEXED BY clause or this table uses the specific
drhaa0ba432010-08-05 02:52:32 +00005097 ** index specified by its INDEXED BY clause. This rule ensures
5098 ** that a best-so-far is always selected even if an impossible
5099 ** combination of INDEXED BY clauses are given. The error
5100 ** will be detected and relayed back to the application later.
5101 ** The NEVER() comes about because rule (2) above prevents
5102 ** An indexable full-table-scan from reaching rule (3).
5103 **
drhd663b5b2012-10-03 00:25:54 +00005104 ** (4) The plan cost must be lower than prior plans, where "cost"
5105 ** is defined by the compareCost() function above.
drh5e377d92010-08-04 21:17:16 +00005106 */
drh9cd1c992012-09-25 20:43:35 +00005107 if( (sWBI.cost.used&sWBI.notValid)==0 /* (1) */
drh56f1b992012-09-25 14:29:39 +00005108 && (bestJ<0 || (notIndexed&m)!=0 /* (2) */
drh92e4feb2011-03-04 00:56:58 +00005109 || (bestPlan.plan.wsFlags & WHERE_NOT_FULLSCAN)==0
drh56f1b992012-09-25 14:29:39 +00005110 || (sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)!=0)
5111 && (nUnconstrained==0 || sWBI.pSrc->pIndex==0 /* (3) */
5112 || NEVER((sWBI.cost.plan.wsFlags & WHERE_NOT_FULLSCAN)!=0))
drhd663b5b2012-10-03 00:25:54 +00005113 && (bestJ<0 || compareCost(&sWBI.cost, &bestPlan)) /* (4) */
dan5236ac12009-08-13 07:09:33 +00005114 ){
drh8e4af1b2012-10-08 18:23:51 +00005115 WHERETRACE((" === table %d (%s) is best so far\n"
5116 " cost=%.1f, nRow=%.1f, nOBSat=%d, wsFlags=%08x\n",
drh1afcaae2012-10-02 01:10:00 +00005117 j, sWBI.pSrc->pTab->zName,
5118 sWBI.cost.rCost, sWBI.cost.plan.nRow,
drhd663b5b2012-10-03 00:25:54 +00005119 sWBI.cost.plan.nOBSat, sWBI.cost.plan.wsFlags));
drh56f1b992012-09-25 14:29:39 +00005120 bestPlan = sWBI.cost;
dan5236ac12009-08-13 07:09:33 +00005121 bestJ = j;
5122 }
5123 if( doNotReorder ) break;
drh9eff6162006-06-12 21:59:13 +00005124 }
drh29dda4a2005-07-21 18:23:20 +00005125 }
dan5236ac12009-08-13 07:09:33 +00005126 assert( bestJ>=0 );
drh9cd1c992012-09-25 20:43:35 +00005127 assert( sWBI.notValid & getMask(pMaskSet, pTabList->a[bestJ].iCursor) );
drh1afcaae2012-10-02 01:10:00 +00005128 WHERETRACE(("*** Optimizer selects table %d (%s) for loop %d with:\n"
drhd663b5b2012-10-03 00:25:54 +00005129 " cost=%.1f, nRow=%.1f, nOBSat=%d, wsFlags=0x%08x\n",
drh1afcaae2012-10-02 01:10:00 +00005130 bestJ, pTabList->a[bestJ].pTab->zName,
5131 pLevel-pWInfo->a, bestPlan.rCost, bestPlan.plan.nRow,
drh5343b2d2012-09-27 19:53:38 +00005132 bestPlan.plan.nOBSat, bestPlan.plan.wsFlags));
dan38cc40c2011-06-30 20:17:15 +00005133 if( (bestPlan.plan.wsFlags & WHERE_DISTINCT)!=0 ){
5134 assert( pWInfo->eDistinct==0 );
5135 pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
5136 }
drh111a6a72008-12-21 03:51:16 +00005137 andFlags &= bestPlan.plan.wsFlags;
5138 pLevel->plan = bestPlan.plan;
drha578d042012-10-02 01:25:16 +00005139 pLevel->iTabCur = pTabList->a[bestJ].iCursor;
drh8b307fb2010-04-06 15:57:05 +00005140 testcase( bestPlan.plan.wsFlags & WHERE_INDEXED );
5141 testcase( bestPlan.plan.wsFlags & WHERE_TEMP_INDEX );
5142 if( bestPlan.plan.wsFlags & (WHERE_INDEXED|WHERE_TEMP_INDEX) ){
dan0efb72c2012-08-24 18:44:56 +00005143 if( (wctrlFlags & WHERE_ONETABLE_ONLY)
5144 && (bestPlan.plan.wsFlags & WHERE_TEMP_INDEX)==0
5145 ){
5146 pLevel->iIdxCur = iIdxCur;
5147 }else{
5148 pLevel->iIdxCur = pParse->nTab++;
5149 }
drhfe05af82005-07-21 03:14:59 +00005150 }else{
5151 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00005152 }
drh9cd1c992012-09-25 20:43:35 +00005153 sWBI.notValid &= ~getMask(pMaskSet, pTabList->a[bestJ].iCursor);
shaned87897d2009-01-30 05:40:27 +00005154 pLevel->iFrom = (u8)bestJ;
dan2ce22452010-11-08 19:01:16 +00005155 if( bestPlan.plan.nRow>=(double)1 ){
5156 pParse->nQueryLoop *= bestPlan.plan.nRow;
5157 }
danielk197785574e32008-10-06 05:32:18 +00005158
5159 /* Check that if the table scanned by this loop iteration had an
5160 ** INDEXED BY clause attached to it, that the named index is being
5161 ** used for the scan. If not, then query compilation has failed.
5162 ** Return an error.
5163 */
5164 pIdx = pTabList->a[bestJ].pIndex;
drh171256c2009-01-08 03:11:19 +00005165 if( pIdx ){
5166 if( (bestPlan.plan.wsFlags & WHERE_INDEXED)==0 ){
5167 sqlite3ErrorMsg(pParse, "cannot use index: %s", pIdx->zName);
5168 goto whereBeginError;
5169 }else{
5170 /* If an INDEXED BY clause is used, the bestIndex() function is
5171 ** guaranteed to find the index specified in the INDEXED BY clause
5172 ** if it find an index at all. */
5173 assert( bestPlan.plan.u.pIdx==pIdx );
5174 }
danielk197785574e32008-10-06 05:32:18 +00005175 }
drh75897232000-05-29 14:26:00 +00005176 }
drh4f0c5872007-03-26 22:05:01 +00005177 WHERETRACE(("*** Optimizer Finished ***\n"));
danielk19771d461462009-04-21 09:02:45 +00005178 if( pParse->nErr || db->mallocFailed ){
danielk197780442942008-12-24 11:25:39 +00005179 goto whereBeginError;
5180 }
drhd663b5b2012-10-03 00:25:54 +00005181 if( nTabList ){
5182 pLevel--;
5183 pWInfo->nOBSat = pLevel->plan.nOBSat;
5184 }else{
5185 pWInfo->nOBSat = 0;
5186 }
drh75897232000-05-29 14:26:00 +00005187
drh943af3c2005-07-29 19:43:58 +00005188 /* If the total query only selects a single row, then the ORDER BY
5189 ** clause is irrelevant.
5190 */
drh46ec5b62012-09-24 15:30:54 +00005191 if( (andFlags & WHERE_UNIQUE)!=0 && pOrderBy ){
drhd663b5b2012-10-03 00:25:54 +00005192 assert( nTabList==0 || (pLevel->plan.wsFlags & WHERE_ALL_UNIQUE)!=0 );
drh46ec5b62012-09-24 15:30:54 +00005193 pWInfo->nOBSat = pOrderBy->nExpr;
drh943af3c2005-07-29 19:43:58 +00005194 }
5195
drh08c88eb2008-04-10 13:33:18 +00005196 /* If the caller is an UPDATE or DELETE statement that is requesting
5197 ** to use a one-pass algorithm, determine if this is appropriate.
5198 ** The one-pass algorithm only works if the WHERE clause constraints
5199 ** the statement to update a single row.
5200 */
drh165be382008-12-05 02:36:33 +00005201 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
5202 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 && (andFlags & WHERE_UNIQUE)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00005203 pWInfo->okOnePass = 1;
drh111a6a72008-12-21 03:51:16 +00005204 pWInfo->a[0].plan.wsFlags &= ~WHERE_IDX_ONLY;
drh08c88eb2008-04-10 13:33:18 +00005205 }
5206
drh9012bcb2004-12-19 00:11:35 +00005207 /* Open all tables in the pTabList and any indices selected for
5208 ** searching those tables.
5209 */
5210 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh8b307fb2010-04-06 15:57:05 +00005211 notReady = ~(Bitmask)0;
drh95aa47b2010-11-16 02:49:15 +00005212 pWInfo->nRowOut = (double)1;
drh9cd1c992012-09-25 20:43:35 +00005213 for(ii=0, pLevel=pWInfo->a; ii<nTabList; ii++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00005214 Table *pTab; /* Table to open */
danielk1977da184232006-01-05 11:34:32 +00005215 int iDb; /* Index of database containing table/index */
drh56f1b992012-09-25 14:29:39 +00005216 struct SrcList_item *pTabItem;
drh9012bcb2004-12-19 00:11:35 +00005217
drh29dda4a2005-07-21 18:23:20 +00005218 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00005219 pTab = pTabItem->pTab;
drh95aa47b2010-11-16 02:49:15 +00005220 pWInfo->nRowOut *= pLevel->plan.nRow;
danielk1977595a5232009-07-24 17:58:53 +00005221 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh424aab82010-04-06 18:28:20 +00005222 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ){
drh75bb9f52010-04-06 18:51:42 +00005223 /* Do nothing */
5224 }else
drh9eff6162006-06-12 21:59:13 +00005225#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00005226 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
danielk1977595a5232009-07-24 17:58:53 +00005227 const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
danielk197793626f42006-06-20 13:07:27 +00005228 int iCur = pTabItem->iCursor;
danielk1977595a5232009-07-24 17:58:53 +00005229 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0, pVTab, P4_VTAB);
drh9eff6162006-06-12 21:59:13 +00005230 }else
5231#endif
drh6df2acd2008-12-28 16:55:25 +00005232 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
drh9ef61f42011-10-07 14:40:59 +00005233 && (wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0 ){
drh08c88eb2008-04-10 13:33:18 +00005234 int op = pWInfo->okOnePass ? OP_OpenWrite : OP_OpenRead;
5235 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
drh67ae0cb2010-04-08 14:38:51 +00005236 testcase( pTab->nCol==BMS-1 );
5237 testcase( pTab->nCol==BMS );
danielk197723432972008-11-17 16:42:00 +00005238 if( !pWInfo->okOnePass && pTab->nCol<BMS ){
danielk19779792eef2006-01-13 15:58:43 +00005239 Bitmask b = pTabItem->colUsed;
5240 int n = 0;
drh74161702006-02-24 02:53:49 +00005241 for(; b; b=b>>1, n++){}
drh8cff69d2009-11-12 19:59:44 +00005242 sqlite3VdbeChangeP4(v, sqlite3VdbeCurrentAddr(v)-1,
5243 SQLITE_INT_TO_PTR(n), P4_INT32);
danielk19779792eef2006-01-13 15:58:43 +00005244 assert( n<=pTab->nCol );
5245 }
danielk1977c00da102006-01-07 13:21:04 +00005246 }else{
5247 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00005248 }
drhc6339082010-04-07 16:54:58 +00005249#ifndef SQLITE_OMIT_AUTOMATIC_INDEX
drh8b307fb2010-04-06 15:57:05 +00005250 if( (pLevel->plan.wsFlags & WHERE_TEMP_INDEX)!=0 ){
drh56f1b992012-09-25 14:29:39 +00005251 constructAutomaticIndex(pParse, sWBI.pWC, pTabItem, notReady, pLevel);
drhc6339082010-04-07 16:54:58 +00005252 }else
5253#endif
5254 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
drh111a6a72008-12-21 03:51:16 +00005255 Index *pIx = pLevel->plan.u.pIdx;
danielk1977b3bf5562006-01-10 17:58:23 +00005256 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
drhb0367fb2012-08-25 02:11:13 +00005257 int iIndexCur = pLevel->iIdxCur;
danielk1977da184232006-01-05 11:34:32 +00005258 assert( pIx->pSchema==pTab->pSchema );
drhb0367fb2012-08-25 02:11:13 +00005259 assert( iIndexCur>=0 );
5260 sqlite3VdbeAddOp4(v, OP_OpenRead, iIndexCur, pIx->tnum, iDb,
drh66a51672008-01-03 00:01:23 +00005261 (char*)pKey, P4_KEYINFO_HANDOFF);
danielk1977207872a2008-01-03 07:54:23 +00005262 VdbeComment((v, "%s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00005263 }
danielk1977da184232006-01-05 11:34:32 +00005264 sqlite3CodeVerifySchema(pParse, iDb);
drh56f1b992012-09-25 14:29:39 +00005265 notReady &= ~getMask(sWBI.pWC->pMaskSet, pTabItem->iCursor);
drh9012bcb2004-12-19 00:11:35 +00005266 }
5267 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
drha21a64d2010-04-06 22:33:55 +00005268 if( db->mallocFailed ) goto whereBeginError;
drh9012bcb2004-12-19 00:11:35 +00005269
drh29dda4a2005-07-21 18:23:20 +00005270 /* Generate the code to do the search. Each iteration of the for
5271 ** loop below generates code for a single nested loop of the VM
5272 ** program.
drh75897232000-05-29 14:26:00 +00005273 */
drhfe05af82005-07-21 03:14:59 +00005274 notReady = ~(Bitmask)0;
drh9cd1c992012-09-25 20:43:35 +00005275 for(ii=0; ii<nTabList; ii++){
5276 pLevel = &pWInfo->a[ii];
5277 explainOneScan(pParse, pTabList, pLevel, ii, pLevel->iFrom, wctrlFlags);
5278 notReady = codeOneLoopStart(pWInfo, ii, wctrlFlags, notReady);
dan4a07e3d2010-11-09 14:48:59 +00005279 pWInfo->iContinue = pLevel->addrCont;
drh75897232000-05-29 14:26:00 +00005280 }
drh7ec764a2005-07-21 03:48:20 +00005281
5282#ifdef SQLITE_TEST /* For testing and debugging use only */
5283 /* Record in the query plan information about the current table
5284 ** and the index used to access it (if any). If the table itself
5285 ** is not used, its name is just '{}'. If no index is used
5286 ** the index is listed as "{}". If the primary key is used the
5287 ** index name is '*'.
5288 */
drh9cd1c992012-09-25 20:43:35 +00005289 for(ii=0; ii<nTabList; ii++){
drh7ec764a2005-07-21 03:48:20 +00005290 char *z;
5291 int n;
drh3f4d1d12012-09-15 18:45:54 +00005292 int w;
drh56f1b992012-09-25 14:29:39 +00005293 struct SrcList_item *pTabItem;
5294
drh9cd1c992012-09-25 20:43:35 +00005295 pLevel = &pWInfo->a[ii];
drh3f4d1d12012-09-15 18:45:54 +00005296 w = pLevel->plan.wsFlags;
drh29dda4a2005-07-21 18:23:20 +00005297 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00005298 z = pTabItem->zAlias;
5299 if( z==0 ) z = pTabItem->pTab->zName;
drhea678832008-12-10 19:26:22 +00005300 n = sqlite3Strlen30(z);
drh7ec764a2005-07-21 03:48:20 +00005301 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
drh3f4d1d12012-09-15 18:45:54 +00005302 if( (w & WHERE_IDX_ONLY)!=0 && (w & WHERE_COVER_SCAN)==0 ){
drh5bb3eb92007-05-04 13:15:55 +00005303 memcpy(&sqlite3_query_plan[nQPlan], "{}", 2);
drh7ec764a2005-07-21 03:48:20 +00005304 nQPlan += 2;
5305 }else{
drh5bb3eb92007-05-04 13:15:55 +00005306 memcpy(&sqlite3_query_plan[nQPlan], z, n);
drh7ec764a2005-07-21 03:48:20 +00005307 nQPlan += n;
5308 }
5309 sqlite3_query_plan[nQPlan++] = ' ';
5310 }
drh3f4d1d12012-09-15 18:45:54 +00005311 testcase( w & WHERE_ROWID_EQ );
5312 testcase( w & WHERE_ROWID_RANGE );
5313 if( w & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh5bb3eb92007-05-04 13:15:55 +00005314 memcpy(&sqlite3_query_plan[nQPlan], "* ", 2);
drh7ec764a2005-07-21 03:48:20 +00005315 nQPlan += 2;
drh3f4d1d12012-09-15 18:45:54 +00005316 }else if( (w & WHERE_INDEXED)!=0 && (w & WHERE_COVER_SCAN)==0 ){
drh111a6a72008-12-21 03:51:16 +00005317 n = sqlite3Strlen30(pLevel->plan.u.pIdx->zName);
drh7ec764a2005-07-21 03:48:20 +00005318 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
drh111a6a72008-12-21 03:51:16 +00005319 memcpy(&sqlite3_query_plan[nQPlan], pLevel->plan.u.pIdx->zName, n);
drh7ec764a2005-07-21 03:48:20 +00005320 nQPlan += n;
5321 sqlite3_query_plan[nQPlan++] = ' ';
5322 }
drh111a6a72008-12-21 03:51:16 +00005323 }else{
5324 memcpy(&sqlite3_query_plan[nQPlan], "{} ", 3);
5325 nQPlan += 3;
drh7ec764a2005-07-21 03:48:20 +00005326 }
5327 }
5328 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
5329 sqlite3_query_plan[--nQPlan] = 0;
5330 }
5331 sqlite3_query_plan[nQPlan] = 0;
5332 nQPlan = 0;
5333#endif /* SQLITE_TEST // Testing and debugging use only */
5334
drh29dda4a2005-07-21 18:23:20 +00005335 /* Record the continuation address in the WhereInfo structure. Then
5336 ** clean up and return.
5337 */
drh75897232000-05-29 14:26:00 +00005338 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00005339
5340 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00005341whereBeginError:
drh8b307fb2010-04-06 15:57:05 +00005342 if( pWInfo ){
5343 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
5344 whereInfoFree(db, pWInfo);
5345 }
drhe23399f2005-07-22 00:31:39 +00005346 return 0;
drh75897232000-05-29 14:26:00 +00005347}
5348
5349/*
drhc27a1ce2002-06-14 20:58:45 +00005350** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00005351** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00005352*/
danielk19774adee202004-05-08 08:23:19 +00005353void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00005354 Parse *pParse = pWInfo->pParse;
5355 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00005356 int i;
drh6b563442001-11-07 16:48:26 +00005357 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00005358 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00005359 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00005360
drh9012bcb2004-12-19 00:11:35 +00005361 /* Generate loop termination code.
5362 */
drhceea3322009-04-23 13:22:42 +00005363 sqlite3ExprCacheClear(pParse);
drhc01a3c12009-12-16 22:10:49 +00005364 for(i=pWInfo->nLevel-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00005365 pLevel = &pWInfo->a[i];
drhb3190c12008-12-08 21:37:14 +00005366 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00005367 if( pLevel->op!=OP_Noop ){
drh66a51672008-01-03 00:01:23 +00005368 sqlite3VdbeAddOp2(v, pLevel->op, pLevel->p1, pLevel->p2);
drhd1d38482008-10-07 23:46:38 +00005369 sqlite3VdbeChangeP5(v, pLevel->p5);
drh19a775c2000-06-05 18:54:46 +00005370 }
drh111a6a72008-12-21 03:51:16 +00005371 if( pLevel->plan.wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
drh72e8fa42007-03-28 14:30:06 +00005372 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00005373 int j;
drhb3190c12008-12-08 21:37:14 +00005374 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh111a6a72008-12-21 03:51:16 +00005375 for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00005376 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
5377 sqlite3VdbeAddOp2(v, OP_Next, pIn->iCur, pIn->addrInTop);
5378 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00005379 }
drh111a6a72008-12-21 03:51:16 +00005380 sqlite3DbFree(db, pLevel->u.in.aInLoop);
drhd99f7062002-06-08 23:25:08 +00005381 }
drhb3190c12008-12-08 21:37:14 +00005382 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhad2d8302002-05-24 20:31:36 +00005383 if( pLevel->iLeftJoin ){
5384 int addr;
drh3c84ddf2008-01-09 02:15:38 +00005385 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin);
drh35451c62009-11-12 04:26:39 +00005386 assert( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
5387 || (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 );
5388 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0 ){
5389 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
5390 }
drh9012bcb2004-12-19 00:11:35 +00005391 if( pLevel->iIdxCur>=0 ){
drh3c84ddf2008-01-09 02:15:38 +00005392 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00005393 }
drh336a5302009-04-24 15:46:21 +00005394 if( pLevel->op==OP_Return ){
5395 sqlite3VdbeAddOp2(v, OP_Gosub, pLevel->p1, pLevel->addrFirst);
5396 }else{
5397 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
5398 }
drhd654be82005-09-20 17:42:23 +00005399 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00005400 }
drh19a775c2000-06-05 18:54:46 +00005401 }
drh9012bcb2004-12-19 00:11:35 +00005402
5403 /* The "break" point is here, just past the end of the outer loop.
5404 ** Set it.
5405 */
danielk19774adee202004-05-08 08:23:19 +00005406 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00005407
drh29dda4a2005-07-21 18:23:20 +00005408 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00005409 */
drhc01a3c12009-12-16 22:10:49 +00005410 assert( pWInfo->nLevel==1 || pWInfo->nLevel==pTabList->nSrc );
5411 for(i=0, pLevel=pWInfo->a; i<pWInfo->nLevel; i++, pLevel++){
danbfca6a42012-08-24 10:52:35 +00005412 Index *pIdx = 0;
drh29dda4a2005-07-21 18:23:20 +00005413 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00005414 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00005415 assert( pTab!=0 );
drh4139c992010-04-07 14:59:45 +00005416 if( (pTab->tabFlags & TF_Ephemeral)==0
5417 && pTab->pSelect==0
drh9ef61f42011-10-07 14:40:59 +00005418 && (pWInfo->wctrlFlags & WHERE_OMIT_OPEN_CLOSE)==0
drh4139c992010-04-07 14:59:45 +00005419 ){
drh8b307fb2010-04-06 15:57:05 +00005420 int ws = pLevel->plan.wsFlags;
5421 if( !pWInfo->okOnePass && (ws & WHERE_IDX_ONLY)==0 ){
drh6df2acd2008-12-28 16:55:25 +00005422 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
5423 }
drhf12cde52010-04-08 17:28:00 +00005424 if( (ws & WHERE_INDEXED)!=0 && (ws & WHERE_TEMP_INDEX)==0 ){
drh6df2acd2008-12-28 16:55:25 +00005425 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
5426 }
drh9012bcb2004-12-19 00:11:35 +00005427 }
5428
danielk197721de2e72007-11-29 17:43:27 +00005429 /* If this scan uses an index, make code substitutions to read data
5430 ** from the index in preference to the table. Sometimes, this means
5431 ** the table need never be read from. This is a performance boost,
5432 ** as the vdbe level waits until the table is read before actually
5433 ** seeking the table cursor to the record corresponding to the current
5434 ** position in the index.
drh9012bcb2004-12-19 00:11:35 +00005435 **
5436 ** Calls to the code generator in between sqlite3WhereBegin and
5437 ** sqlite3WhereEnd will have created code that references the table
5438 ** directly. This loop scans all that code looking for opcodes
5439 ** that reference the table and converts them into opcodes that
5440 ** reference the index.
5441 */
danbfca6a42012-08-24 10:52:35 +00005442 if( pLevel->plan.wsFlags & WHERE_INDEXED ){
5443 pIdx = pLevel->plan.u.pIdx;
5444 }else if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drhd40e2082012-08-24 23:24:15 +00005445 pIdx = pLevel->u.pCovidx;
danbfca6a42012-08-24 10:52:35 +00005446 }
5447 if( pIdx && !db->mallocFailed){
danielk1977f0113002006-01-24 12:09:17 +00005448 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00005449 VdbeOp *pOp;
drh9012bcb2004-12-19 00:11:35 +00005450
drh9012bcb2004-12-19 00:11:35 +00005451 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
5452 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00005453 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00005454 if( pOp->p1!=pLevel->iTabCur ) continue;
5455 if( pOp->opcode==OP_Column ){
drh9012bcb2004-12-19 00:11:35 +00005456 for(j=0; j<pIdx->nColumn; j++){
5457 if( pOp->p2==pIdx->aiColumn[j] ){
5458 pOp->p2 = j;
danielk197721de2e72007-11-29 17:43:27 +00005459 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00005460 break;
5461 }
5462 }
drh35451c62009-11-12 04:26:39 +00005463 assert( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
5464 || j<pIdx->nColumn );
drhf0863fe2005-06-12 21:35:51 +00005465 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00005466 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00005467 pOp->opcode = OP_IdxRowid;
drh9012bcb2004-12-19 00:11:35 +00005468 }
5469 }
drh6b563442001-11-07 16:48:26 +00005470 }
drh19a775c2000-06-05 18:54:46 +00005471 }
drh9012bcb2004-12-19 00:11:35 +00005472
5473 /* Final cleanup
5474 */
drhf12cde52010-04-08 17:28:00 +00005475 pParse->nQueryLoop = pWInfo->savedNQueryLoop;
5476 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00005477 return;
5478}