blob: 2c31f81f3ac04173d60e12ea6c71b5475632ef49 [file] [log] [blame]
drh9f18e8a2005-07-08 12:13:04 +00001/*
drh9fecc542013-08-27 20:16:48 +00002** 2005-07-08
drh9f18e8a2005-07-08 12:13:04 +00003**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** 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.
10**
11*************************************************************************
12** This file contains code associated with the ANALYZE command.
drhfaacf172011-08-12 01:51:45 +000013**
14** The ANALYZE command gather statistics about the content of tables
15** and indices. These statistics are made available to the query planner
16** to help it make better decisions about how to perform queries.
17**
18** The following system tables are or have been supported:
19**
20** CREATE TABLE sqlite_stat1(tbl, idx, stat);
21** CREATE TABLE sqlite_stat2(tbl, idx, sampleno, sample);
drhf404c862011-08-13 15:25:10 +000022** CREATE TABLE sqlite_stat3(tbl, idx, nEq, nLt, nDLt, sample);
drhc8af8502013-08-09 14:07:55 +000023** CREATE TABLE sqlite_stat4(tbl, idx, nEq, nLt, nDLt, sample);
drhfaacf172011-08-12 01:51:45 +000024**
25** Additional tables might be added in future releases of SQLite.
26** The sqlite_stat2 table is not created or used unless the SQLite version
drhd3ed7342011-09-21 00:09:41 +000027** is between 3.6.18 and 3.7.8, inclusive, and unless SQLite is compiled
drhfaacf172011-08-12 01:51:45 +000028** with SQLITE_ENABLE_STAT2. The sqlite_stat2 table is deprecated.
drhf7b54962013-05-28 12:11:54 +000029** The sqlite_stat2 table is superseded by sqlite_stat3, which is only
drhd3ed7342011-09-21 00:09:41 +000030** created and used by SQLite versions 3.7.9 and later and with
drhc8af8502013-08-09 14:07:55 +000031** SQLITE_ENABLE_STAT3 defined. The functionality of sqlite_stat3
32** is a superset of sqlite_stat2. The sqlite_stat4 is an enhanced
33** version of sqlite_stat3 and is only available when compiled with
drh0ae4f142013-10-14 14:21:59 +000034** SQLITE_ENABLE_STAT4 and in SQLite versions 3.8.1 and later. It is
drh9fecc542013-08-27 20:16:48 +000035** not possible to enable both STAT3 and STAT4 at the same time. If they
mistachkin79e84452013-08-30 19:59:48 +000036** are both enabled, then STAT4 takes precedence.
drhc8af8502013-08-09 14:07:55 +000037**
38** For most applications, sqlite_stat1 provides all the statisics required
39** for the query planner to make good choices.
drhfaacf172011-08-12 01:51:45 +000040**
41** Format of sqlite_stat1:
42**
43** There is normally one row per index, with the index identified by the
44** name in the idx column. The tbl column is the name of the table to
45** which the index belongs. In each such row, the stat column will be
46** a string consisting of a list of integers. The first integer in this
drhc8af8502013-08-09 14:07:55 +000047** list is the number of rows in the index. (This is the same as the
48** number of rows in the table, except for partial indices.) The second
drhfaacf172011-08-12 01:51:45 +000049** integer is the average number of rows in the index that have the same
50** value in the first column of the index. The third integer is the average
51** number of rows in the index that have the same value for the first two
52** columns. The N-th integer (for N>1) is the average number of rows in
53** the index which have the same value for the first N-1 columns. For
54** a K-column index, there will be K+1 integers in the stat column. If
55** the index is unique, then the last integer will be 1.
56**
57** The list of integers in the stat column can optionally be followed
58** by the keyword "unordered". The "unordered" keyword, if it is present,
59** must be separated from the last integer by a single space. If the
60** "unordered" keyword is present, then the query planner assumes that
61** the index is unordered and will not use the index for a range query.
62**
63** If the sqlite_stat1.idx column is NULL, then the sqlite_stat1.stat
64** column contains a single integer which is the (estimated) number of
65** rows in the table identified by sqlite_stat1.tbl.
66**
67** Format of sqlite_stat2:
68**
69** The sqlite_stat2 is only created and is only used if SQLite is compiled
70** with SQLITE_ENABLE_STAT2 and if the SQLite version number is between
drhd3ed7342011-09-21 00:09:41 +000071** 3.6.18 and 3.7.8. The "stat2" table contains additional information
drhfaacf172011-08-12 01:51:45 +000072** about the distribution of keys within an index. The index is identified by
73** the "idx" column and the "tbl" column is the name of the table to which
74** the index belongs. There are usually 10 rows in the sqlite_stat2
75** table for each index.
76**
dan23e7c4d2011-08-15 12:02:21 +000077** The sqlite_stat2 entries for an index that have sampleno between 0 and 9
drhfaacf172011-08-12 01:51:45 +000078** inclusive are samples of the left-most key value in the index taken at
79** evenly spaced points along the index. Let the number of samples be S
80** (10 in the standard build) and let C be the number of rows in the index.
81** Then the sampled rows are given by:
82**
83** rownumber = (i*C*2 + C)/(S*2)
84**
85** For i between 0 and S-1. Conceptually, the index space is divided into
86** S uniform buckets and the samples are the middle row from each bucket.
87**
88** The format for sqlite_stat2 is recorded here for legacy reference. This
89** version of SQLite does not support sqlite_stat2. It neither reads nor
90** writes the sqlite_stat2 table. This version of SQLite only supports
91** sqlite_stat3.
92**
93** Format for sqlite_stat3:
94**
drhc8af8502013-08-09 14:07:55 +000095** The sqlite_stat3 format is a subset of sqlite_stat4. Hence, the
96** sqlite_stat4 format will be described first. Further information
97** about sqlite_stat3 follows the sqlite_stat4 description.
drhfaacf172011-08-12 01:51:45 +000098**
drhc8af8502013-08-09 14:07:55 +000099** Format for sqlite_stat4:
100**
101** As with sqlite_stat2, the sqlite_stat4 table contains histogram data
102** to aid the query planner in choosing good indices based on the values
103** that indexed columns are compared against in the WHERE clauses of
104** queries.
105**
106** The sqlite_stat4 table contains multiple entries for each index.
drhd3ed7342011-09-21 00:09:41 +0000107** The idx column names the index and the tbl column is the table of the
108** index. If the idx and tbl columns are the same, then the sample is
drhc8af8502013-08-09 14:07:55 +0000109** of the INTEGER PRIMARY KEY. The sample column is a blob which is the
drh0ae4f142013-10-14 14:21:59 +0000110** binary encoding of a key from the index. The nEq column is a
111** list of integers. The first integer is the approximate number
112** of entries in the index whose left-most column exactly matches
113** the left-most column of the sample. The second integer in nEq
114** is the approximate number of entries in the index where the
115** first two columns match the first two columns of the sample.
dan84d4fcc2013-08-09 19:04:07 +0000116** And so forth. nLt is another list of integers that show the approximate
117** number of entries that are strictly less than the sample. The first
drhc8af8502013-08-09 14:07:55 +0000118** integer in nLt contains the number of entries in the index where the
119** left-most column is less than the left-most column of the sample.
120** The K-th integer in the nLt entry is the number of index entries
121** where the first K columns are less than the first K columns of the
122** sample. The nDLt column is like nLt except that it contains the
123** number of distinct entries in the index that are less than the
124** sample.
drhfaacf172011-08-12 01:51:45 +0000125**
drhc8af8502013-08-09 14:07:55 +0000126** There can be an arbitrary number of sqlite_stat4 entries per index.
dan84d4fcc2013-08-09 19:04:07 +0000127** The ANALYZE command will typically generate sqlite_stat4 tables
drhfaacf172011-08-12 01:51:45 +0000128** that contain between 10 and 40 samples which are distributed across
129** the key space, though not uniformly, and which include samples with
drhc8af8502013-08-09 14:07:55 +0000130** large nEq values.
131**
132** Format for sqlite_stat3 redux:
133**
134** The sqlite_stat3 table is like sqlite_stat4 except that it only
135** looks at the left-most column of the index. The sqlite_stat3.sample
136** column contains the actual value of the left-most column instead
137** of a blob encoding of the complete index key as is found in
138** sqlite_stat4.sample. The nEq, nLt, and nDLt entries of sqlite_stat3
139** all contain just a single integer which is the same as the first
140** integer in the equivalent columns in sqlite_stat4.
drh9f18e8a2005-07-08 12:13:04 +0000141*/
142#ifndef SQLITE_OMIT_ANALYZE
143#include "sqliteInt.h"
144
danf00e9022013-08-14 19:54:12 +0000145#if defined(SQLITE_ENABLE_STAT4)
drh92707ac2013-08-17 18:57:15 +0000146# define IsStat4 1
147# define IsStat3 0
danf00e9022013-08-14 19:54:12 +0000148#elif defined(SQLITE_ENABLE_STAT3)
drh92707ac2013-08-17 18:57:15 +0000149# define IsStat4 0
150# define IsStat3 1
danf00e9022013-08-14 19:54:12 +0000151#else
drh92707ac2013-08-17 18:57:15 +0000152# define IsStat4 0
153# define IsStat3 0
drh9fecc542013-08-27 20:16:48 +0000154# undef SQLITE_STAT4_SAMPLES
155# define SQLITE_STAT4_SAMPLES 1
dan8ad169a2013-08-12 20:14:04 +0000156#endif
drh9fecc542013-08-27 20:16:48 +0000157#define IsStat34 (IsStat3+IsStat4) /* 1 for STAT3 or STAT4. 0 otherwise */
dan8ad169a2013-08-12 20:14:04 +0000158
drh9f18e8a2005-07-08 12:13:04 +0000159/*
drh9fecc542013-08-27 20:16:48 +0000160** This routine generates code that opens the sqlite_statN tables.
161** The sqlite_stat1 table is always relevant. sqlite_stat2 is now
162** obsolete. sqlite_stat3 and sqlite_stat4 are only opened when
163** appropriate compile-time options are provided.
drhff2d5ea2005-07-23 00:41:48 +0000164**
drh9fecc542013-08-27 20:16:48 +0000165** If the sqlite_statN tables do not previously exist, it is created.
dan69188d92009-08-19 08:18:32 +0000166**
167** Argument zWhere may be a pointer to a buffer containing a table name,
168** or it may be a NULL pointer. If it is not NULL, then all entries in
drh9fecc542013-08-27 20:16:48 +0000169** the sqlite_statN tables associated with the named table are deleted.
170** If zWhere==0, then code is generated to delete all stat table entries.
drhff2d5ea2005-07-23 00:41:48 +0000171*/
172static void openStatTable(
173 Parse *pParse, /* Parsing context */
174 int iDb, /* The database we are looking in */
175 int iStatCur, /* Open the sqlite_stat1 table on this cursor */
drha071bc52011-03-31 02:03:28 +0000176 const char *zWhere, /* Delete entries for this table or index */
177 const char *zWhereType /* Either "tbl" or "idx" */
drhff2d5ea2005-07-23 00:41:48 +0000178){
dan558814f2010-06-02 05:53:53 +0000179 static const struct {
dan69188d92009-08-19 08:18:32 +0000180 const char *zName;
181 const char *zCols;
182 } aTable[] = {
183 { "sqlite_stat1", "tbl,idx,stat" },
dan0106e372013-08-12 16:34:32 +0000184#if defined(SQLITE_ENABLE_STAT4)
danf52bb8d2013-08-03 20:24:58 +0000185 { "sqlite_stat4", "tbl,idx,neq,nlt,ndlt,sample" },
dan8ad169a2013-08-12 20:14:04 +0000186 { "sqlite_stat3", 0 },
dan0106e372013-08-12 16:34:32 +0000187#elif defined(SQLITE_ENABLE_STAT3)
188 { "sqlite_stat3", "tbl,idx,neq,nlt,ndlt,sample" },
dan8ad169a2013-08-12 20:14:04 +0000189 { "sqlite_stat4", 0 },
drh9fecc542013-08-27 20:16:48 +0000190#else
191 { "sqlite_stat3", 0 },
192 { "sqlite_stat4", 0 },
drhfaacf172011-08-12 01:51:45 +0000193#endif
194 };
dan02fa4692009-08-17 17:06:58 +0000195 int i;
drhff2d5ea2005-07-23 00:41:48 +0000196 sqlite3 *db = pParse->db;
197 Db *pDb;
drhff2d5ea2005-07-23 00:41:48 +0000198 Vdbe *v = sqlite3GetVdbe(pParse);
drh9fecc542013-08-27 20:16:48 +0000199 int aRoot[ArraySize(aTable)];
200 u8 aCreateTbl[ArraySize(aTable)];
201
drhcf1be452007-05-12 12:08:51 +0000202 if( v==0 ) return;
drh1fee73e2007-08-29 04:00:57 +0000203 assert( sqlite3BtreeHoldsAllMutexes(db) );
204 assert( sqlite3VdbeDb(v)==db );
drhff2d5ea2005-07-23 00:41:48 +0000205 pDb = &db->aDb[iDb];
dan02fa4692009-08-17 17:06:58 +0000206
drhfaacf172011-08-12 01:51:45 +0000207 /* Create new statistic tables if they do not exist, or clear them
208 ** if they do already exist.
209 */
dan69188d92009-08-19 08:18:32 +0000210 for(i=0; i<ArraySize(aTable); i++){
211 const char *zTab = aTable[i].zName;
dan02fa4692009-08-17 17:06:58 +0000212 Table *pStat;
dan69188d92009-08-19 08:18:32 +0000213 if( (pStat = sqlite3FindTable(db, zTab, pDb->zName))==0 ){
dan8ad169a2013-08-12 20:14:04 +0000214 if( aTable[i].zCols ){
drh9fecc542013-08-27 20:16:48 +0000215 /* The sqlite_statN table does not exist. Create it. Note that a
dan8ad169a2013-08-12 20:14:04 +0000216 ** side-effect of the CREATE TABLE statement is to leave the rootpage
217 ** of the new table in register pParse->regRoot. This is important
218 ** because the OpenWrite opcode below will be needing it. */
219 sqlite3NestedParse(pParse,
220 "CREATE TABLE %Q.%s(%s)", pDb->zName, zTab, aTable[i].zCols
221 );
222 aRoot[i] = pParse->regRoot;
223 aCreateTbl[i] = OPFLAG_P2ISREG;
224 }
dan02fa4692009-08-17 17:06:58 +0000225 }else{
226 /* The table already exists. If zWhere is not NULL, delete all entries
227 ** associated with the table zWhere. If zWhere is NULL, delete the
228 ** entire contents of the table. */
229 aRoot[i] = pStat->tnum;
drh9fecc542013-08-27 20:16:48 +0000230 aCreateTbl[i] = 0;
dan69188d92009-08-19 08:18:32 +0000231 sqlite3TableLock(pParse, iDb, aRoot[i], 1, zTab);
dan02fa4692009-08-17 17:06:58 +0000232 if( zWhere ){
233 sqlite3NestedParse(pParse,
drh1435a9a2013-08-27 23:15:44 +0000234 "DELETE FROM %Q.%s WHERE %s=%Q",
235 pDb->zName, zTab, zWhereType, zWhere
dan02fa4692009-08-17 17:06:58 +0000236 );
237 }else{
dan8ad169a2013-08-12 20:14:04 +0000238 /* The sqlite_stat[134] table already exists. Delete all rows. */
dan02fa4692009-08-17 17:06:58 +0000239 sqlite3VdbeAddOp2(v, OP_Clear, aRoot[i], iDb);
240 }
241 }
drhff2d5ea2005-07-23 00:41:48 +0000242 }
243
danf00e9022013-08-14 19:54:12 +0000244 /* Open the sqlite_stat[134] tables for writing. */
drh1435a9a2013-08-27 23:15:44 +0000245 for(i=0; aTable[i].zCols; i++){
246 assert( i<ArraySize(aTable) );
drh261c02d2013-10-25 14:46:15 +0000247 sqlite3VdbeAddOp4Int(v, OP_OpenWrite, iStatCur+i, aRoot[i], iDb, 3);
drh1435a9a2013-08-27 23:15:44 +0000248 sqlite3VdbeChangeP5(v, aCreateTbl[i]);
drhec9e55d2014-06-30 17:07:39 +0000249 VdbeComment((v, aTable[i].zName));
danielk1977c00da102006-01-07 13:21:04 +0000250 }
drhff2d5ea2005-07-23 00:41:48 +0000251}
252
253/*
danf52bb8d2013-08-03 20:24:58 +0000254** Recommended number of samples for sqlite_stat4
drhfaacf172011-08-12 01:51:45 +0000255*/
danf52bb8d2013-08-03 20:24:58 +0000256#ifndef SQLITE_STAT4_SAMPLES
257# define SQLITE_STAT4_SAMPLES 24
drhfaacf172011-08-12 01:51:45 +0000258#endif
259
260/*
danf00e9022013-08-14 19:54:12 +0000261** Three SQL functions - stat_init(), stat_push(), and stat_get() -
drhade3add2011-08-13 00:58:05 +0000262** share an instance of the following structure to hold their state
263** information.
264*/
danf52bb8d2013-08-03 20:24:58 +0000265typedef struct Stat4Accum Stat4Accum;
danf00e9022013-08-14 19:54:12 +0000266typedef struct Stat4Sample Stat4Sample;
267struct Stat4Sample {
danf00e9022013-08-14 19:54:12 +0000268 tRowcnt *anEq; /* sqlite_stat4.nEq */
danf00e9022013-08-14 19:54:12 +0000269 tRowcnt *anDLt; /* sqlite_stat4.nDLt */
drh1435a9a2013-08-27 23:15:44 +0000270#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000271 tRowcnt *anLt; /* sqlite_stat4.nLt */
drhda475b82013-11-04 21:44:54 +0000272 union {
273 i64 iRowid; /* Rowid in main table of the key */
274 u8 *aRowid; /* Key for WITHOUT ROWID tables */
275 } u;
drhebe25af2013-11-02 18:46:04 +0000276 u32 nRowid; /* Sizeof aRowid[] */
danf00e9022013-08-14 19:54:12 +0000277 u8 isPSample; /* True if a periodic sample */
278 int iCol; /* If !isPSample, the reason for inclusion */
279 u32 iHash; /* Tiebreaker hash */
drh9fecc542013-08-27 20:16:48 +0000280#endif
danf00e9022013-08-14 19:54:12 +0000281};
danf52bb8d2013-08-03 20:24:58 +0000282struct Stat4Accum {
drhade3add2011-08-13 00:58:05 +0000283 tRowcnt nRow; /* Number of rows in the entire table */
284 tRowcnt nPSample; /* How often to do a periodic sample */
drhec9e55d2014-06-30 17:07:39 +0000285 int nCol; /* Number of columns in index + pk/rowid */
286 int nKeyCol; /* Number of index columns w/o the pk/rowid */
drhade3add2011-08-13 00:58:05 +0000287 int mxSample; /* Maximum number of samples to accumulate */
danf00e9022013-08-14 19:54:12 +0000288 Stat4Sample current; /* Current row as a Stat4Sample */
drhf404c862011-08-13 15:25:10 +0000289 u32 iPrn; /* Pseudo-random number used for sampling */
drhebe25af2013-11-02 18:46:04 +0000290 Stat4Sample *aBest; /* Array of nCol best samples */
danf00e9022013-08-14 19:54:12 +0000291 int iMin; /* Index in a[] of entry with minimum score */
292 int nSample; /* Current number of samples */
293 int iGet; /* Index of current sample accessed by stat_get() */
294 Stat4Sample *a; /* Array of mxSample Stat4Sample objects */
drhebe25af2013-11-02 18:46:04 +0000295 sqlite3 *db; /* Database connection, for malloc() */
drhade3add2011-08-13 00:58:05 +0000296};
297
drhebe25af2013-11-02 18:46:04 +0000298/* Reclaim memory used by a Stat4Sample
299*/
300#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
301static void sampleClear(sqlite3 *db, Stat4Sample *p){
drhda475b82013-11-04 21:44:54 +0000302 assert( db!=0 );
303 if( p->nRowid ){
304 sqlite3DbFree(db, p->u.aRowid);
305 p->nRowid = 0;
306 }
drhebe25af2013-11-02 18:46:04 +0000307}
308#endif
309
drhda475b82013-11-04 21:44:54 +0000310/* Initialize the BLOB value of a ROWID
drhebe25af2013-11-02 18:46:04 +0000311*/
312#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhda475b82013-11-04 21:44:54 +0000313static void sampleSetRowid(sqlite3 *db, Stat4Sample *p, int n, const u8 *pData){
314 assert( db!=0 );
315 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
316 p->u.aRowid = sqlite3DbMallocRaw(db, n);
317 if( p->u.aRowid ){
318 p->nRowid = n;
319 memcpy(p->u.aRowid, pData, n);
320 }else{
321 p->nRowid = 0;
322 }
323}
324#endif
325
326/* Initialize the INTEGER value of a ROWID.
327*/
328#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
329static void sampleSetRowidInt64(sqlite3 *db, Stat4Sample *p, i64 iRowid){
330 assert( db!=0 );
331 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
332 p->nRowid = 0;
333 p->u.iRowid = iRowid;
334}
335#endif
336
337
338/*
339** Copy the contents of object (*pFrom) into (*pTo).
340*/
341#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
342static void sampleCopy(Stat4Accum *p, Stat4Sample *pTo, Stat4Sample *pFrom){
343 pTo->isPSample = pFrom->isPSample;
344 pTo->iCol = pFrom->iCol;
345 pTo->iHash = pFrom->iHash;
346 memcpy(pTo->anEq, pFrom->anEq, sizeof(tRowcnt)*p->nCol);
347 memcpy(pTo->anLt, pFrom->anLt, sizeof(tRowcnt)*p->nCol);
348 memcpy(pTo->anDLt, pFrom->anDLt, sizeof(tRowcnt)*p->nCol);
349 if( pFrom->nRowid ){
350 sampleSetRowid(p->db, pTo, pFrom->nRowid, pFrom->u.aRowid);
351 }else{
352 sampleSetRowidInt64(p->db, pTo, pFrom->u.iRowid);
drhebe25af2013-11-02 18:46:04 +0000353 }
354}
355#endif
356
357/*
358** Reclaim all memory of a Stat4Accum structure.
359*/
360static void stat4Destructor(void *pOld){
361 Stat4Accum *p = (Stat4Accum*)pOld;
362#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
363 int i;
364 for(i=0; i<p->nCol; i++) sampleClear(p->db, p->aBest+i);
365 for(i=0; i<p->mxSample; i++) sampleClear(p->db, p->a+i);
drhda475b82013-11-04 21:44:54 +0000366 sampleClear(p->db, &p->current);
drhebe25af2013-11-02 18:46:04 +0000367#endif
368 sqlite3DbFree(p->db, p);
369}
370
drhade3add2011-08-13 00:58:05 +0000371/*
drhec9e55d2014-06-30 17:07:39 +0000372** Implementation of the stat_init(N,K,C) SQL function. The three parameters
373** are:
drh553818a2014-07-23 18:36:55 +0000374** N: The number of columns in the index including the rowid/pk (note 1)
375** K: The number of columns in the index excluding the rowid/pk.
376** C: The number of rows in the index (note 2)
drhec9e55d2014-06-30 17:07:39 +0000377**
drh553818a2014-07-23 18:36:55 +0000378** Note 1: In the special case of the covering index that implements a
379** WITHOUT ROWID table, N is the number of PRIMARY KEY columns, not the
380** total number of columns in the table.
drhec9e55d2014-06-30 17:07:39 +0000381**
drh553818a2014-07-23 18:36:55 +0000382** Note 2: C is only used for STAT3 and STAT4.
383**
384** For indexes on ordinary rowid tables, N==K+1. But for indexes on
385** WITHOUT ROWID tables, N=K+P where P is the number of columns in the
386** PRIMARY KEY of the table. The covering index that implements the
387** original WITHOUT ROWID table as N==K as a special case.
drhade3add2011-08-13 00:58:05 +0000388**
danf52bb8d2013-08-03 20:24:58 +0000389** This routine allocates the Stat4Accum object in heap memory. The return
390** value is a pointer to the the Stat4Accum object encoded as a blob (i.e.
391** the size of the blob is sizeof(void*) bytes).
drhade3add2011-08-13 00:58:05 +0000392*/
danf00e9022013-08-14 19:54:12 +0000393static void statInit(
drhade3add2011-08-13 00:58:05 +0000394 sqlite3_context *context,
395 int argc,
396 sqlite3_value **argv
397){
danf52bb8d2013-08-03 20:24:58 +0000398 Stat4Accum *p;
danf52bb8d2013-08-03 20:24:58 +0000399 int nCol; /* Number of columns in index being sampled */
drhec9e55d2014-06-30 17:07:39 +0000400 int nKeyCol; /* Number of key columns */
drh9fecc542013-08-27 20:16:48 +0000401 int nColUp; /* nCol rounded up for alignment */
danf52bb8d2013-08-03 20:24:58 +0000402 int n; /* Bytes of space to allocate */
drhebe25af2013-11-02 18:46:04 +0000403 sqlite3 *db; /* Database connection */
drh1435a9a2013-08-27 23:15:44 +0000404#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000405 int mxSample = SQLITE_STAT4_SAMPLES;
406#endif
drhade3add2011-08-13 00:58:05 +0000407
danf52bb8d2013-08-03 20:24:58 +0000408 /* Decode the three function arguments */
drh68257192011-08-16 17:06:21 +0000409 UNUSED_PARAMETER(argc);
drh9fecc542013-08-27 20:16:48 +0000410 nCol = sqlite3_value_int(argv[0]);
drhec9e55d2014-06-30 17:07:39 +0000411 assert( nCol>0 );
drh9fecc542013-08-27 20:16:48 +0000412 nColUp = sizeof(tRowcnt)<8 ? (nCol+1)&~1 : nCol;
drhec9e55d2014-06-30 17:07:39 +0000413 nKeyCol = sqlite3_value_int(argv[1]);
414 assert( nKeyCol<=nCol );
415 assert( nKeyCol>0 );
danf52bb8d2013-08-03 20:24:58 +0000416
417 /* Allocate the space required for the Stat4Accum object */
danf00e9022013-08-14 19:54:12 +0000418 n = sizeof(*p)
drh9fecc542013-08-27 20:16:48 +0000419 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anEq */
420 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anDLt */
drh1435a9a2013-08-27 23:15:44 +0000421#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000422 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anLt */
drhebe25af2013-11-02 18:46:04 +0000423 + sizeof(Stat4Sample)*(nCol+mxSample) /* Stat4Accum.aBest[], a[] */
drh9fecc542013-08-27 20:16:48 +0000424 + sizeof(tRowcnt)*3*nColUp*(nCol+mxSample)
425#endif
426 ;
drhebe25af2013-11-02 18:46:04 +0000427 db = sqlite3_context_db_handle(context);
428 p = sqlite3DbMallocZero(db, n);
drhade3add2011-08-13 00:58:05 +0000429 if( p==0 ){
430 sqlite3_result_error_nomem(context);
431 return;
432 }
danf52bb8d2013-08-03 20:24:58 +0000433
drhebe25af2013-11-02 18:46:04 +0000434 p->db = db;
drh9fecc542013-08-27 20:16:48 +0000435 p->nRow = 0;
danf52bb8d2013-08-03 20:24:58 +0000436 p->nCol = nCol;
drhec9e55d2014-06-30 17:07:39 +0000437 p->nKeyCol = nKeyCol;
danf00e9022013-08-14 19:54:12 +0000438 p->current.anDLt = (tRowcnt*)&p[1];
drh9fecc542013-08-27 20:16:48 +0000439 p->current.anEq = &p->current.anDLt[nColUp];
danf00e9022013-08-14 19:54:12 +0000440
drh1435a9a2013-08-27 23:15:44 +0000441#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000442 {
443 u8 *pSpace; /* Allocated space not yet assigned */
444 int i; /* Used to iterate through p->aSample[] */
danf52bb8d2013-08-03 20:24:58 +0000445
drh9fecc542013-08-27 20:16:48 +0000446 p->iGet = -1;
447 p->mxSample = mxSample;
drhec9e55d2014-06-30 17:07:39 +0000448 p->nPSample = (tRowcnt)(sqlite3_value_int64(argv[2])/(mxSample/3+1) + 1);
drh9fecc542013-08-27 20:16:48 +0000449 p->current.anLt = &p->current.anEq[nColUp];
drhec9e55d2014-06-30 17:07:39 +0000450 p->iPrn = nCol*0x689e962d ^ sqlite3_value_int(argv[2])*0xd0944565;
drh9fecc542013-08-27 20:16:48 +0000451
452 /* Set up the Stat4Accum.a[] and aBest[] arrays */
453 p->a = (struct Stat4Sample*)&p->current.anLt[nColUp];
454 p->aBest = &p->a[mxSample];
455 pSpace = (u8*)(&p->a[mxSample+nCol]);
456 for(i=0; i<(mxSample+nCol); i++){
457 p->a[i].anEq = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
458 p->a[i].anLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
459 p->a[i].anDLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
460 }
461 assert( (pSpace - (u8*)p)==n );
462
463 for(i=0; i<nCol; i++){
464 p->aBest[i].iCol = i;
465 }
danf00e9022013-08-14 19:54:12 +0000466 }
drh9fecc542013-08-27 20:16:48 +0000467#endif
danf00e9022013-08-14 19:54:12 +0000468
danf52bb8d2013-08-03 20:24:58 +0000469 /* Return a pointer to the allocated object to the caller */
drhebe25af2013-11-02 18:46:04 +0000470 sqlite3_result_blob(context, p, sizeof(p), stat4Destructor);
drhade3add2011-08-13 00:58:05 +0000471}
danf00e9022013-08-14 19:54:12 +0000472static const FuncDef statInitFuncdef = {
drhec9e55d2014-06-30 17:07:39 +0000473 2+IsStat34, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000474 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000475 0, /* pUserData */
476 0, /* pNext */
477 statInit, /* xFunc */
478 0, /* xStep */
479 0, /* xFinalize */
480 "stat_init", /* zName */
481 0, /* pHash */
482 0 /* pDestructor */
drhade3add2011-08-13 00:58:05 +0000483};
484
danb13af4c2013-09-03 14:43:12 +0000485#ifdef SQLITE_ENABLE_STAT4
486/*
487** pNew and pOld are both candidate non-periodic samples selected for
488** the same column (pNew->iCol==pOld->iCol). Ignoring this column and
489** considering only any trailing columns and the sample hash value, this
490** function returns true if sample pNew is to be preferred over pOld.
491** In other words, if we assume that the cardinalities of the selected
492** column for pNew and pOld are equal, is pNew to be preferred over pOld.
493**
494** This function assumes that for each argument sample, the contents of
495** the anEq[] array from pSample->anEq[pSample->iCol+1] onwards are valid.
496*/
497static int sampleIsBetterPost(
498 Stat4Accum *pAccum,
499 Stat4Sample *pNew,
500 Stat4Sample *pOld
501){
502 int nCol = pAccum->nCol;
503 int i;
504 assert( pNew->iCol==pOld->iCol );
505 for(i=pNew->iCol+1; i<nCol; i++){
506 if( pNew->anEq[i]>pOld->anEq[i] ) return 1;
507 if( pNew->anEq[i]<pOld->anEq[i] ) return 0;
508 }
509 if( pNew->iHash>pOld->iHash ) return 1;
510 return 0;
511}
512#endif
513
drh1435a9a2013-08-27 23:15:44 +0000514#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
danf00e9022013-08-14 19:54:12 +0000515/*
516** Return true if pNew is to be preferred over pOld.
danb13af4c2013-09-03 14:43:12 +0000517**
518** This function assumes that for each argument sample, the contents of
519** the anEq[] array from pSample->anEq[pSample->iCol] onwards are valid.
danf00e9022013-08-14 19:54:12 +0000520*/
danb13af4c2013-09-03 14:43:12 +0000521static int sampleIsBetter(
522 Stat4Accum *pAccum,
523 Stat4Sample *pNew,
524 Stat4Sample *pOld
525){
danf00e9022013-08-14 19:54:12 +0000526 tRowcnt nEqNew = pNew->anEq[pNew->iCol];
527 tRowcnt nEqOld = pOld->anEq[pOld->iCol];
528
529 assert( pOld->isPSample==0 && pNew->isPSample==0 );
530 assert( IsStat4 || (pNew->iCol==0 && pOld->iCol==0) );
531
danb13af4c2013-09-03 14:43:12 +0000532 if( (nEqNew>nEqOld) ) return 1;
533#ifdef SQLITE_ENABLE_STAT4
534 if( nEqNew==nEqOld ){
535 if( pNew->iCol<pOld->iCol ) return 1;
536 return (pNew->iCol==pOld->iCol && sampleIsBetterPost(pAccum, pNew, pOld));
danf00e9022013-08-14 19:54:12 +0000537 }
538 return 0;
danb13af4c2013-09-03 14:43:12 +0000539#else
540 return (nEqNew==nEqOld && pNew->iHash>pOld->iHash);
541#endif
danf00e9022013-08-14 19:54:12 +0000542}
drhade3add2011-08-13 00:58:05 +0000543
544/*
danf00e9022013-08-14 19:54:12 +0000545** Copy the contents of sample *pNew into the p->a[] array. If necessary,
546** remove the least desirable sample from p->a[] to make room.
547*/
548static void sampleInsert(Stat4Accum *p, Stat4Sample *pNew, int nEqZero){
drhd2694612013-11-04 22:04:17 +0000549 Stat4Sample *pSample = 0;
danf52bb8d2013-08-03 20:24:58 +0000550 int i;
danf52bb8d2013-08-03 20:24:58 +0000551
danf00e9022013-08-14 19:54:12 +0000552 assert( IsStat4 || nEqZero==0 );
danf52bb8d2013-08-03 20:24:58 +0000553
drh30f07042013-09-04 02:07:38 +0000554#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000555 if( pNew->isPSample==0 ){
dan1f616ad2013-08-15 14:39:09 +0000556 Stat4Sample *pUpgrade = 0;
danf00e9022013-08-14 19:54:12 +0000557 assert( pNew->anEq[pNew->iCol]>0 );
drhade3add2011-08-13 00:58:05 +0000558
danf00e9022013-08-14 19:54:12 +0000559 /* This sample is being added because the prefix that ends in column
560 ** iCol occurs many times in the table. However, if we have already
561 ** added a sample that shares this prefix, there is no need to add
dan1f616ad2013-08-15 14:39:09 +0000562 ** this one. Instead, upgrade the priority of the highest priority
563 ** existing sample that shares this prefix. */
danf00e9022013-08-14 19:54:12 +0000564 for(i=p->nSample-1; i>=0; i--){
565 Stat4Sample *pOld = &p->a[i];
566 if( pOld->anEq[pNew->iCol]==0 ){
dan1f616ad2013-08-15 14:39:09 +0000567 if( pOld->isPSample ) return;
danb13af4c2013-09-03 14:43:12 +0000568 assert( pOld->iCol>pNew->iCol );
569 assert( sampleIsBetter(p, pNew, pOld) );
570 if( pUpgrade==0 || sampleIsBetter(p, pOld, pUpgrade) ){
dan1f616ad2013-08-15 14:39:09 +0000571 pUpgrade = pOld;
danf00e9022013-08-14 19:54:12 +0000572 }
dan1f28ead2013-08-07 16:15:32 +0000573 }
574 }
dan1f616ad2013-08-15 14:39:09 +0000575 if( pUpgrade ){
576 pUpgrade->iCol = pNew->iCol;
577 pUpgrade->anEq[pUpgrade->iCol] = pNew->anEq[pUpgrade->iCol];
578 goto find_new_min;
579 }
drhade3add2011-08-13 00:58:05 +0000580 }
drh30f07042013-09-04 02:07:38 +0000581#endif
danf52bb8d2013-08-03 20:24:58 +0000582
danf00e9022013-08-14 19:54:12 +0000583 /* If necessary, remove sample iMin to make room for the new sample. */
584 if( p->nSample>=p->mxSample ){
585 Stat4Sample *pMin = &p->a[p->iMin];
danc55521a2013-08-05 05:34:30 +0000586 tRowcnt *anEq = pMin->anEq;
danc55521a2013-08-05 05:34:30 +0000587 tRowcnt *anLt = pMin->anLt;
danf00e9022013-08-14 19:54:12 +0000588 tRowcnt *anDLt = pMin->anDLt;
drhda475b82013-11-04 21:44:54 +0000589 sampleClear(p->db, pMin);
danf00e9022013-08-14 19:54:12 +0000590 memmove(pMin, &pMin[1], sizeof(p->a[0])*(p->nSample-p->iMin-1));
drhf404c862011-08-13 15:25:10 +0000591 pSample = &p->a[p->nSample-1];
drhd2694612013-11-04 22:04:17 +0000592 pSample->nRowid = 0;
danc55521a2013-08-05 05:34:30 +0000593 pSample->anEq = anEq;
594 pSample->anDLt = anDLt;
595 pSample->anLt = anLt;
danf00e9022013-08-14 19:54:12 +0000596 p->nSample = p->mxSample-1;
dan8ad169a2013-08-12 20:14:04 +0000597 }
drhade3add2011-08-13 00:58:05 +0000598
danb49d1042013-09-02 18:58:11 +0000599 /* The "rows less-than" for the rowid column must be greater than that
600 ** for the last sample in the p->a[] array. Otherwise, the samples would
601 ** be out of order. */
602#ifdef SQLITE_ENABLE_STAT4
603 assert( p->nSample==0
604 || pNew->anLt[p->nCol-1] > p->a[p->nSample-1].anLt[p->nCol-1] );
605#endif
606
607 /* Insert the new sample */
608 pSample = &p->a[p->nSample];
609 sampleCopy(p, pSample, pNew);
610 p->nSample++;
611
danf00e9022013-08-14 19:54:12 +0000612 /* Zero the first nEqZero entries in the anEq[] array. */
613 memset(pSample->anEq, 0, sizeof(tRowcnt)*nEqZero);
614
mistachkinc2cfb512013-09-04 04:04:08 +0000615#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000616 find_new_min:
mistachkinc2cfb512013-09-04 04:04:08 +0000617#endif
danf00e9022013-08-14 19:54:12 +0000618 if( p->nSample>=p->mxSample ){
619 int iMin = -1;
danf52bb8d2013-08-03 20:24:58 +0000620 for(i=0; i<p->mxSample; i++){
621 if( p->a[i].isPSample ) continue;
danb13af4c2013-09-03 14:43:12 +0000622 if( iMin<0 || sampleIsBetter(p, &p->a[iMin], &p->a[i]) ){
drhade3add2011-08-13 00:58:05 +0000623 iMin = i;
drhade3add2011-08-13 00:58:05 +0000624 }
625 }
danf52bb8d2013-08-03 20:24:58 +0000626 assert( iMin>=0 );
drhade3add2011-08-13 00:58:05 +0000627 p->iMin = iMin;
628 }
629}
drh1435a9a2013-08-27 23:15:44 +0000630#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
danf00e9022013-08-14 19:54:12 +0000631
632/*
633** Field iChng of the index being scanned has changed. So at this point
634** p->current contains a sample that reflects the previous row of the
635** index. The value of anEq[iChng] and subsequent anEq[] elements are
636** correct at this point.
637*/
638static void samplePushPrevious(Stat4Accum *p, int iChng){
drh92707ac2013-08-17 18:57:15 +0000639#ifdef SQLITE_ENABLE_STAT4
640 int i;
danf00e9022013-08-14 19:54:12 +0000641
drh92707ac2013-08-17 18:57:15 +0000642 /* Check if any samples from the aBest[] array should be pushed
643 ** into IndexSample.a[] at this point. */
644 for(i=(p->nCol-2); i>=iChng; i--){
645 Stat4Sample *pBest = &p->aBest[i];
danb13af4c2013-09-03 14:43:12 +0000646 pBest->anEq[i] = p->current.anEq[i];
647 if( p->nSample<p->mxSample || sampleIsBetter(p, pBest, &p->a[p->iMin]) ){
drh92707ac2013-08-17 18:57:15 +0000648 sampleInsert(p, pBest, i);
danf00e9022013-08-14 19:54:12 +0000649 }
650 }
651
drh92707ac2013-08-17 18:57:15 +0000652 /* Update the anEq[] fields of any samples already collected. */
653 for(i=p->nSample-1; i>=0; i--){
654 int j;
655 for(j=iChng; j<p->nCol; j++){
656 if( p->a[i].anEq[j]==0 ) p->a[i].anEq[j] = p->current.anEq[j];
657 }
658 }
659#endif
660
661#if defined(SQLITE_ENABLE_STAT3) && !defined(SQLITE_ENABLE_STAT4)
662 if( iChng==0 ){
danf00e9022013-08-14 19:54:12 +0000663 tRowcnt nLt = p->current.anLt[0];
664 tRowcnt nEq = p->current.anEq[0];
665
666 /* Check if this is to be a periodic sample. If so, add it. */
667 if( (nLt/p->nPSample)!=(nLt+nEq)/p->nPSample ){
668 p->current.isPSample = 1;
669 sampleInsert(p, &p->current, 0);
670 p->current.isPSample = 0;
671 }else
672
673 /* Or if it is a non-periodic sample. Add it in this case too. */
danb13af4c2013-09-03 14:43:12 +0000674 if( p->nSample<p->mxSample
675 || sampleIsBetter(p, &p->current, &p->a[p->iMin])
676 ){
danf00e9022013-08-14 19:54:12 +0000677 sampleInsert(p, &p->current, 0);
678 }
679 }
drh92707ac2013-08-17 18:57:15 +0000680#endif
drh4f991892013-10-11 15:05:05 +0000681
682#ifndef SQLITE_ENABLE_STAT3_OR_STAT4
683 UNUSED_PARAMETER( p );
684 UNUSED_PARAMETER( iChng );
685#endif
danf00e9022013-08-14 19:54:12 +0000686}
687
688/*
drhebe25af2013-11-02 18:46:04 +0000689** Implementation of the stat_push SQL function: stat_push(P,C,R)
drh9fecc542013-08-27 20:16:48 +0000690** Arguments:
danf00e9022013-08-14 19:54:12 +0000691**
drh9fecc542013-08-27 20:16:48 +0000692** P Pointer to the Stat4Accum object created by stat_init()
693** C Index of left-most column to differ from previous row
drhebe25af2013-11-02 18:46:04 +0000694** R Rowid for the current row. Might be a key record for
695** WITHOUT ROWID tables.
danf00e9022013-08-14 19:54:12 +0000696**
drh553818a2014-07-23 18:36:55 +0000697** This SQL function always returns NULL. It's purpose it to accumulate
698** statistical data and/or samples in the Stat4Accum object about the
699** index being analyzed. The stat_get() SQL function will later be used to
700** extract relevant information for constructing the sqlite_statN tables.
drh9fecc542013-08-27 20:16:48 +0000701**
drhebe25af2013-11-02 18:46:04 +0000702** The R parameter is only used for STAT3 and STAT4
danf00e9022013-08-14 19:54:12 +0000703*/
704static void statPush(
705 sqlite3_context *context,
706 int argc,
707 sqlite3_value **argv
708){
709 int i;
710
711 /* The three function arguments */
712 Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
drh9fecc542013-08-27 20:16:48 +0000713 int iChng = sqlite3_value_int(argv[1]);
danf00e9022013-08-14 19:54:12 +0000714
drh4f991892013-10-11 15:05:05 +0000715 UNUSED_PARAMETER( argc );
716 UNUSED_PARAMETER( context );
drhec9e55d2014-06-30 17:07:39 +0000717 assert( p->nCol>0 );
danf00e9022013-08-14 19:54:12 +0000718 assert( iChng<p->nCol );
719
drh9fecc542013-08-27 20:16:48 +0000720 if( p->nRow==0 ){
danb49d1042013-09-02 18:58:11 +0000721 /* This is the first call to this function. Do initialization. */
drh9fecc542013-08-27 20:16:48 +0000722 for(i=0; i<p->nCol; i++) p->current.anEq[i] = 1;
723 }else{
724 /* Second and subsequent calls get processed here */
danf00e9022013-08-14 19:54:12 +0000725 samplePushPrevious(p, iChng);
726
727 /* Update anDLt[], anLt[] and anEq[] to reflect the values that apply
728 ** to the current row of the index. */
729 for(i=0; i<iChng; i++){
730 p->current.anEq[i]++;
731 }
732 for(i=iChng; i<p->nCol; i++){
733 p->current.anDLt[i]++;
drh1435a9a2013-08-27 23:15:44 +0000734#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
danf00e9022013-08-14 19:54:12 +0000735 p->current.anLt[i] += p->current.anEq[i];
drh9fecc542013-08-27 20:16:48 +0000736#endif
danf00e9022013-08-14 19:54:12 +0000737 p->current.anEq[i] = 1;
738 }
danf00e9022013-08-14 19:54:12 +0000739 }
drh9fecc542013-08-27 20:16:48 +0000740 p->nRow++;
drh1435a9a2013-08-27 23:15:44 +0000741#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhebe25af2013-11-02 18:46:04 +0000742 if( sqlite3_value_type(argv[2])==SQLITE_INTEGER ){
drhda475b82013-11-04 21:44:54 +0000743 sampleSetRowidInt64(p->db, &p->current, sqlite3_value_int64(argv[2]));
drhebe25af2013-11-02 18:46:04 +0000744 }else{
drhda475b82013-11-04 21:44:54 +0000745 sampleSetRowid(p->db, &p->current, sqlite3_value_bytes(argv[2]),
746 sqlite3_value_blob(argv[2]));
drhebe25af2013-11-02 18:46:04 +0000747 }
drh9fecc542013-08-27 20:16:48 +0000748 p->current.iHash = p->iPrn = p->iPrn*1103515245 + 12345;
749#endif
danf00e9022013-08-14 19:54:12 +0000750
drh92707ac2013-08-17 18:57:15 +0000751#ifdef SQLITE_ENABLE_STAT4
752 {
danf00e9022013-08-14 19:54:12 +0000753 tRowcnt nLt = p->current.anLt[p->nCol-1];
754
755 /* Check if this is to be a periodic sample. If so, add it. */
756 if( (nLt/p->nPSample)!=(nLt+1)/p->nPSample ){
757 p->current.isPSample = 1;
758 p->current.iCol = 0;
759 sampleInsert(p, &p->current, p->nCol-1);
760 p->current.isPSample = 0;
761 }
762
763 /* Update the aBest[] array. */
764 for(i=0; i<(p->nCol-1); i++){
765 p->current.iCol = i;
danb13af4c2013-09-03 14:43:12 +0000766 if( i>=iChng || sampleIsBetterPost(p, &p->current, &p->aBest[i]) ){
danf00e9022013-08-14 19:54:12 +0000767 sampleCopy(p, &p->aBest[i], &p->current);
768 }
769 }
770 }
drh92707ac2013-08-17 18:57:15 +0000771#endif
danf00e9022013-08-14 19:54:12 +0000772}
773static const FuncDef statPushFuncdef = {
drh9fecc542013-08-27 20:16:48 +0000774 2+IsStat34, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000775 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000776 0, /* pUserData */
777 0, /* pNext */
778 statPush, /* xFunc */
779 0, /* xStep */
780 0, /* xFinalize */
781 "stat_push", /* zName */
782 0, /* pHash */
783 0 /* pDestructor */
drhade3add2011-08-13 00:58:05 +0000784};
785
danf00e9022013-08-14 19:54:12 +0000786#define STAT_GET_STAT1 0 /* "stat" column of stat1 table */
787#define STAT_GET_ROWID 1 /* "rowid" column of stat[34] entry */
788#define STAT_GET_NEQ 2 /* "neq" column of stat[34] entry */
789#define STAT_GET_NLT 3 /* "nlt" column of stat[34] entry */
790#define STAT_GET_NDLT 4 /* "ndlt" column of stat[34] entry */
791
drhade3add2011-08-13 00:58:05 +0000792/*
drh92707ac2013-08-17 18:57:15 +0000793** Implementation of the stat_get(P,J) SQL function. This routine is
drh553818a2014-07-23 18:36:55 +0000794** used to query statistical information that has been gathered into
795** the Stat4Accum object by prior calls to stat_push(). The P parameter
796** is a BLOB which is decoded into a pointer to the Stat4Accum objects.
797** The content to returned is determined by the parameter J
drh92707ac2013-08-17 18:57:15 +0000798** which is one of the STAT_GET_xxxx values defined above.
drhade3add2011-08-13 00:58:05 +0000799**
drh92707ac2013-08-17 18:57:15 +0000800** If neither STAT3 nor STAT4 are enabled, then J is always
801** STAT_GET_STAT1 and is hence omitted and this routine becomes
802** a one-parameter function, stat_get(P), that always returns the
803** stat1 table entry information.
drhade3add2011-08-13 00:58:05 +0000804*/
danf00e9022013-08-14 19:54:12 +0000805static void statGet(
drhade3add2011-08-13 00:58:05 +0000806 sqlite3_context *context,
807 int argc,
808 sqlite3_value **argv
809){
danf52bb8d2013-08-03 20:24:58 +0000810 Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
drh1435a9a2013-08-27 23:15:44 +0000811#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh92707ac2013-08-17 18:57:15 +0000812 /* STAT3 and STAT4 have a parameter on this routine. */
danf00e9022013-08-14 19:54:12 +0000813 int eCall = sqlite3_value_int(argv[1]);
drh92707ac2013-08-17 18:57:15 +0000814 assert( argc==2 );
danf00e9022013-08-14 19:54:12 +0000815 assert( eCall==STAT_GET_STAT1 || eCall==STAT_GET_NEQ
816 || eCall==STAT_GET_ROWID || eCall==STAT_GET_NLT
817 || eCall==STAT_GET_NDLT
818 );
drh92707ac2013-08-17 18:57:15 +0000819 if( eCall==STAT_GET_STAT1 )
820#else
821 assert( argc==1 );
822#endif
823 {
danf00e9022013-08-14 19:54:12 +0000824 /* Return the value to store in the "stat" column of the sqlite_stat1
825 ** table for this index.
826 **
827 ** The value is a string composed of a list of integers describing
828 ** the index. The first integer in the list is the total number of
829 ** entries in the index. There is one additional integer in the list
830 ** for each indexed column. This additional integer is an estimate of
831 ** the number of rows matched by a stabbing query on the index using
832 ** a key with the corresponding number of fields. In other words,
833 ** if the index is on columns (a,b) and the sqlite_stat1 value is
834 ** "100 10 2", then SQLite estimates that:
835 **
836 ** * the index contains 100 rows,
837 ** * "WHERE a=?" matches 10 rows, and
838 ** * "WHERE a=? AND b=?" matches 2 rows.
839 **
840 ** If D is the count of distinct values and K is the total number of
841 ** rows, then each estimate is computed as:
842 **
843 ** I = (K+D-1)/D
844 */
845 char *z;
846 int i;
847
drhec9e55d2014-06-30 17:07:39 +0000848 char *zRet = sqlite3MallocZero( (p->nKeyCol+1)*25 );
danf00e9022013-08-14 19:54:12 +0000849 if( zRet==0 ){
850 sqlite3_result_error_nomem(context);
851 return;
852 }
853
drh26586e72013-10-09 19:07:22 +0000854 sqlite3_snprintf(24, zRet, "%llu", (u64)p->nRow);
danf00e9022013-08-14 19:54:12 +0000855 z = zRet + sqlite3Strlen30(zRet);
drhec9e55d2014-06-30 17:07:39 +0000856 for(i=0; i<p->nKeyCol; i++){
drh26586e72013-10-09 19:07:22 +0000857 u64 nDistinct = p->current.anDLt[i] + 1;
858 u64 iVal = (p->nRow + nDistinct - 1) / nDistinct;
859 sqlite3_snprintf(24, z, " %llu", iVal);
danf00e9022013-08-14 19:54:12 +0000860 z += sqlite3Strlen30(z);
861 assert( p->current.anEq[i] );
862 }
863 assert( z[0]=='\0' && z>zRet );
864
865 sqlite3_result_text(context, zRet, -1, sqlite3_free);
drh92707ac2013-08-17 18:57:15 +0000866 }
drh1435a9a2013-08-27 23:15:44 +0000867#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh92707ac2013-08-17 18:57:15 +0000868 else if( eCall==STAT_GET_ROWID ){
danf00e9022013-08-14 19:54:12 +0000869 if( p->iGet<0 ){
870 samplePushPrevious(p, 0);
871 p->iGet = 0;
872 }
873 if( p->iGet<p->nSample ){
drhebe25af2013-11-02 18:46:04 +0000874 Stat4Sample *pS = p->a + p->iGet;
875 if( pS->nRowid==0 ){
drhda475b82013-11-04 21:44:54 +0000876 sqlite3_result_int64(context, pS->u.iRowid);
drhebe25af2013-11-02 18:46:04 +0000877 }else{
drhda475b82013-11-04 21:44:54 +0000878 sqlite3_result_blob(context, pS->u.aRowid, pS->nRowid,
879 SQLITE_TRANSIENT);
drhebe25af2013-11-02 18:46:04 +0000880 }
danf00e9022013-08-14 19:54:12 +0000881 }
882 }else{
danf52bb8d2013-08-03 20:24:58 +0000883 tRowcnt *aCnt = 0;
danf00e9022013-08-14 19:54:12 +0000884
885 assert( p->iGet<p->nSample );
886 switch( eCall ){
887 case STAT_GET_NEQ: aCnt = p->a[p->iGet].anEq; break;
888 case STAT_GET_NLT: aCnt = p->a[p->iGet].anLt; break;
889 default: {
890 aCnt = p->a[p->iGet].anDLt;
891 p->iGet++;
892 break;
893 }
danf52bb8d2013-08-03 20:24:58 +0000894 }
895
dan8ad169a2013-08-12 20:14:04 +0000896 if( IsStat3 ){
897 sqlite3_result_int64(context, (i64)aCnt[0]);
danf52bb8d2013-08-03 20:24:58 +0000898 }else{
danf00e9022013-08-14 19:54:12 +0000899 char *zRet = sqlite3MallocZero(p->nCol * 25);
dan8ad169a2013-08-12 20:14:04 +0000900 if( zRet==0 ){
901 sqlite3_result_error_nomem(context);
902 }else{
903 int i;
904 char *z = zRet;
905 for(i=0; i<p->nCol; i++){
drh26586e72013-10-09 19:07:22 +0000906 sqlite3_snprintf(24, z, "%llu ", (u64)aCnt[i]);
dan8ad169a2013-08-12 20:14:04 +0000907 z += sqlite3Strlen30(z);
908 }
909 assert( z[0]=='\0' && z>zRet );
910 z[-1] = '\0';
911 sqlite3_result_text(context, zRet, -1, sqlite3_free);
danf52bb8d2013-08-03 20:24:58 +0000912 }
danf52bb8d2013-08-03 20:24:58 +0000913 }
drhade3add2011-08-13 00:58:05 +0000914 }
drh1435a9a2013-08-27 23:15:44 +0000915#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drh4f991892013-10-11 15:05:05 +0000916#ifndef SQLITE_DEBUG
917 UNUSED_PARAMETER( argc );
918#endif
drhade3add2011-08-13 00:58:05 +0000919}
danf00e9022013-08-14 19:54:12 +0000920static const FuncDef statGetFuncdef = {
drh9fecc542013-08-27 20:16:48 +0000921 1+IsStat34, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000922 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000923 0, /* pUserData */
924 0, /* pNext */
925 statGet, /* xFunc */
926 0, /* xStep */
927 0, /* xFinalize */
928 "stat_get", /* zName */
929 0, /* pHash */
930 0 /* pDestructor */
drhade3add2011-08-13 00:58:05 +0000931};
drhade3add2011-08-13 00:58:05 +0000932
danf00e9022013-08-14 19:54:12 +0000933static void callStatGet(Vdbe *v, int regStat4, int iParam, int regOut){
934 assert( regOut!=regStat4 && regOut!=regStat4+1 );
drh1435a9a2013-08-27 23:15:44 +0000935#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
danf00e9022013-08-14 19:54:12 +0000936 sqlite3VdbeAddOp2(v, OP_Integer, iParam, regStat4+1);
drh4f991892013-10-11 15:05:05 +0000937#elif SQLITE_DEBUG
drh92707ac2013-08-17 18:57:15 +0000938 assert( iParam==STAT_GET_STAT1 );
drh4f991892013-10-11 15:05:05 +0000939#else
940 UNUSED_PARAMETER( iParam );
drh92707ac2013-08-17 18:57:15 +0000941#endif
danf00e9022013-08-14 19:54:12 +0000942 sqlite3VdbeAddOp3(v, OP_Function, 0, regStat4, regOut);
943 sqlite3VdbeChangeP4(v, -1, (char*)&statGetFuncdef, P4_FUNCDEF);
drh9fecc542013-08-27 20:16:48 +0000944 sqlite3VdbeChangeP5(v, 1 + IsStat34);
danf00e9022013-08-14 19:54:12 +0000945}
drhade3add2011-08-13 00:58:05 +0000946
947/*
drhff2d5ea2005-07-23 00:41:48 +0000948** Generate code to do an analysis of all indices associated with
949** a single table.
950*/
951static void analyzeOneTable(
952 Parse *pParse, /* Parser context */
953 Table *pTab, /* Table whose indices are to be analyzed */
drha071bc52011-03-31 02:03:28 +0000954 Index *pOnlyIdx, /* If not NULL, only analyze this one index */
drhdfe88ec2008-11-03 20:55:06 +0000955 int iStatCur, /* Index of VdbeCursor that writes the sqlite_stat1 table */
danc6129702013-08-05 19:04:07 +0000956 int iMem, /* Available memory locations begin here */
957 int iTab /* Next available cursor */
drhff2d5ea2005-07-23 00:41:48 +0000958){
dan0f9a34e2009-08-19 16:34:31 +0000959 sqlite3 *db = pParse->db; /* Database handle */
dan69188d92009-08-19 08:18:32 +0000960 Index *pIdx; /* An index to being analyzed */
961 int iIdxCur; /* Cursor open on index being analyzed */
danc6129702013-08-05 19:04:07 +0000962 int iTabCur; /* Table cursor */
dan69188d92009-08-19 08:18:32 +0000963 Vdbe *v; /* The virtual machine being built up */
964 int i; /* Loop counter */
drhf6cf1ff2011-03-30 14:54:05 +0000965 int jZeroRows = -1; /* Jump from here if number of rows is zero */
dan69188d92009-08-19 08:18:32 +0000966 int iDb; /* Index of database containing pTab */
drh721dfcf2013-08-01 04:39:17 +0000967 u8 needTableCnt = 1; /* True to count the table */
danf00e9022013-08-14 19:54:12 +0000968 int regNewRowid = iMem++; /* Rowid for the inserted record */
969 int regStat4 = iMem++; /* Register to hold Stat4Accum object */
danf00e9022013-08-14 19:54:12 +0000970 int regChng = iMem++; /* Index of changed index field */
drh1435a9a2013-08-27 23:15:44 +0000971#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000972 int regRowid = iMem++; /* Rowid argument passed to stat_push() */
973#endif
danf00e9022013-08-14 19:54:12 +0000974 int regTemp = iMem++; /* Temporary use register */
dane275dc32009-08-18 16:24:58 +0000975 int regTabname = iMem++; /* Register containing table name */
976 int regIdxname = iMem++; /* Register containing index name */
danf00e9022013-08-14 19:54:12 +0000977 int regStat1 = iMem++; /* Value for the stat column of sqlite_stat1 */
978 int regPrev = iMem; /* MUST BE LAST (see below) */
dan68c4dbb2009-08-20 09:11:06 +0000979
drhf0459fc2013-08-15 16:15:00 +0000980 pParse->nMem = MAX(pParse->nMem, iMem);
drhff2d5ea2005-07-23 00:41:48 +0000981 v = sqlite3GetVdbe(pParse);
drh15564052010-09-25 22:32:56 +0000982 if( v==0 || NEVER(pTab==0) ){
983 return;
984 }
drhf39d29c2010-09-28 17:34:46 +0000985 if( pTab->tnum==0 ){
986 /* Do not gather statistics on views or virtual tables */
drh15564052010-09-25 22:32:56 +0000987 return;
988 }
drh503a6862013-03-01 01:07:17 +0000989 if( sqlite3_strnicmp(pTab->zName, "sqlite_", 7)==0 ){
drh15564052010-09-25 22:32:56 +0000990 /* Do not gather statistics on system tables */
drhff2d5ea2005-07-23 00:41:48 +0000991 return;
992 }
dan0f9a34e2009-08-19 16:34:31 +0000993 assert( sqlite3BtreeHoldsAllMutexes(db) );
994 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
danielk1977da184232006-01-05 11:34:32 +0000995 assert( iDb>=0 );
drh21206082011-04-04 18:22:02 +0000996 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drhe6e04962005-07-23 02:17:03 +0000997#ifndef SQLITE_OMIT_AUTHORIZATION
998 if( sqlite3AuthCheck(pParse, SQLITE_ANALYZE, pTab->zName, 0,
dan0f9a34e2009-08-19 16:34:31 +0000999 db->aDb[iDb].zName ) ){
drhe6e04962005-07-23 02:17:03 +00001000 return;
1001 }
1002#endif
1003
dane0432012013-08-05 18:00:56 +00001004 /* Establish a read-lock on the table at the shared-cache level.
danf00e9022013-08-14 19:54:12 +00001005 ** Open a read-only cursor on the table. Also allocate a cursor number
1006 ** to use for scanning indexes (iIdxCur). No index cursor is opened at
1007 ** this time though. */
danielk1977c00da102006-01-07 13:21:04 +00001008 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danc6129702013-08-05 19:04:07 +00001009 iTabCur = iTab++;
danf00e9022013-08-14 19:54:12 +00001010 iIdxCur = iTab++;
danc6129702013-08-05 19:04:07 +00001011 pParse->nTab = MAX(pParse->nTab, iTab);
dane0432012013-08-05 18:00:56 +00001012 sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
drh15564052010-09-25 22:32:56 +00001013 sqlite3VdbeAddOp4(v, OP_String8, 0, regTabname, 0, pTab->zName, 0);
dane0432012013-08-05 18:00:56 +00001014
drhff2d5ea2005-07-23 00:41:48 +00001015 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
drh553818a2014-07-23 18:36:55 +00001016 int nCol; /* Number of columns in pIdx. "N" */
danf00e9022013-08-14 19:54:12 +00001017 int *aGotoChng; /* Array of jump instruction addresses */
1018 int addrRewind; /* Address of "OP_Rewind iIdxCur" */
danf00e9022013-08-14 19:54:12 +00001019 int addrNextRow; /* Address of "next_row:" */
drhce95d112013-11-02 19:34:38 +00001020 const char *zIdxName; /* Name of the index */
drh553818a2014-07-23 18:36:55 +00001021 int nColTest; /* Number of columns to test for changes */
danielk1977b3bf5562006-01-10 17:58:23 +00001022
drha071bc52011-03-31 02:03:28 +00001023 if( pOnlyIdx && pOnlyIdx!=pIdx ) continue;
drh721dfcf2013-08-01 04:39:17 +00001024 if( pIdx->pPartIdxWhere==0 ) needTableCnt = 0;
drhec9e55d2014-06-30 17:07:39 +00001025 if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIdx) ){
1026 nCol = pIdx->nKeyCol;
1027 zIdxName = pTab->zName;
drh553818a2014-07-23 18:36:55 +00001028 nColTest = nCol - 1;
drhec9e55d2014-06-30 17:07:39 +00001029 }else{
1030 nCol = pIdx->nColumn;
1031 zIdxName = pIdx->zName;
drh553818a2014-07-23 18:36:55 +00001032 nColTest = pIdx->onError==OE_None ? nCol-1 : pIdx->nKeyCol-1;
drhec9e55d2014-06-30 17:07:39 +00001033 }
drh553818a2014-07-23 18:36:55 +00001034 aGotoChng = sqlite3DbMallocRaw(db, sizeof(int)*(nColTest+1));
danf00e9022013-08-14 19:54:12 +00001035 if( aGotoChng==0 ) continue;
dane275dc32009-08-18 16:24:58 +00001036
drh15564052010-09-25 22:32:56 +00001037 /* Populate the register containing the index name. */
drhce95d112013-11-02 19:34:38 +00001038 sqlite3VdbeAddOp4(v, OP_String8, 0, regIdxname, 0, zIdxName, 0);
drhec9e55d2014-06-30 17:07:39 +00001039 VdbeComment((v, "Analysis for %s.%s", pTab->zName, zIdxName));
dan69188d92009-08-19 08:18:32 +00001040
dane0432012013-08-05 18:00:56 +00001041 /*
danf00e9022013-08-14 19:54:12 +00001042 ** Pseudo-code for loop that calls stat_push():
dane0432012013-08-05 18:00:56 +00001043 **
danf00e9022013-08-14 19:54:12 +00001044 ** Rewind csr
1045 ** if eof(csr) goto end_of_scan;
1046 ** regChng = 0
1047 ** goto chng_addr_0;
dane0432012013-08-05 18:00:56 +00001048 **
dandd6e1f12013-08-10 19:08:30 +00001049 ** next_row:
danf00e9022013-08-14 19:54:12 +00001050 ** regChng = 0
1051 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1052 ** regChng = 1
1053 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1054 ** ...
1055 ** regChng = N
1056 ** goto chng_addr_N
dane0432012013-08-05 18:00:56 +00001057 **
danf00e9022013-08-14 19:54:12 +00001058 ** chng_addr_0:
1059 ** regPrev(0) = idx(0)
1060 ** chng_addr_1:
1061 ** regPrev(1) = idx(1)
1062 ** ...
dane0432012013-08-05 18:00:56 +00001063 **
danf00e9022013-08-14 19:54:12 +00001064 ** chng_addr_N:
1065 ** regRowid = idx(rowid)
drh9fecc542013-08-27 20:16:48 +00001066 ** stat_push(P, regChng, regRowid)
danf00e9022013-08-14 19:54:12 +00001067 ** Next csr
1068 ** if !eof(csr) goto next_row;
dane0432012013-08-05 18:00:56 +00001069 **
danf00e9022013-08-14 19:54:12 +00001070 ** end_of_scan:
dane0432012013-08-05 18:00:56 +00001071 */
danf00e9022013-08-14 19:54:12 +00001072
1073 /* Make sure there are enough memory cells allocated to accommodate
1074 ** the regPrev array and a trailing rowid (the rowid slot is required
1075 ** when building a record to insert into the sample column of
1076 ** the sqlite_stat4 table. */
drh553818a2014-07-23 18:36:55 +00001077 pParse->nMem = MAX(pParse->nMem, regPrev+nColTest);
dan02fa4692009-08-17 17:06:58 +00001078
danf00e9022013-08-14 19:54:12 +00001079 /* Open a read-only cursor on the index being analyzed. */
dane0432012013-08-05 18:00:56 +00001080 assert( iDb==sqlite3SchemaToIndex(db, pIdx->pSchema) );
danf00e9022013-08-14 19:54:12 +00001081 sqlite3VdbeAddOp3(v, OP_OpenRead, iIdxCur, pIdx->tnum, iDb);
drh2ec2fb22013-11-06 19:59:23 +00001082 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
danf00e9022013-08-14 19:54:12 +00001083 VdbeComment((v, "%s", pIdx->zName));
dane0432012013-08-05 18:00:56 +00001084
danf00e9022013-08-14 19:54:12 +00001085 /* Invoke the stat_init() function. The arguments are:
danf52bb8d2013-08-03 20:24:58 +00001086 **
drh553818a2014-07-23 18:36:55 +00001087 ** (1) the number of columns in the index including the rowid
1088 ** (or for a WITHOUT ROWID table, the number of PK columns),
1089 ** (2) the number of columns in the key without the rowid/pk
1090 ** (3) the number of rows in the index,
drh9fecc542013-08-27 20:16:48 +00001091 **
drh553818a2014-07-23 18:36:55 +00001092 **
1093 ** The third argument is only used for STAT3 and STAT4
danf52bb8d2013-08-03 20:24:58 +00001094 */
drh1435a9a2013-08-27 23:15:44 +00001095#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhec9e55d2014-06-30 17:07:39 +00001096 sqlite3VdbeAddOp2(v, OP_Count, iIdxCur, regStat4+3);
drh9fecc542013-08-27 20:16:48 +00001097#endif
drhec9e55d2014-06-30 17:07:39 +00001098 sqlite3VdbeAddOp2(v, OP_Integer, nCol, regStat4+1);
1099 sqlite3VdbeAddOp2(v, OP_Integer, pIdx->nKeyCol, regStat4+2);
danf52bb8d2013-08-03 20:24:58 +00001100 sqlite3VdbeAddOp3(v, OP_Function, 0, regStat4+1, regStat4);
danf00e9022013-08-14 19:54:12 +00001101 sqlite3VdbeChangeP4(v, -1, (char*)&statInitFuncdef, P4_FUNCDEF);
drhec9e55d2014-06-30 17:07:39 +00001102 sqlite3VdbeChangeP5(v, 2+IsStat34);
danf52bb8d2013-08-03 20:24:58 +00001103
danf00e9022013-08-14 19:54:12 +00001104 /* Implementation of the following:
1105 **
1106 ** Rewind csr
1107 ** if eof(csr) goto end_of_scan;
1108 ** regChng = 0
1109 ** goto next_push_0;
1110 **
dandd6e1f12013-08-10 19:08:30 +00001111 */
danf00e9022013-08-14 19:54:12 +00001112 addrRewind = sqlite3VdbeAddOp1(v, OP_Rewind, iIdxCur);
drh688852a2014-02-17 22:40:43 +00001113 VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001114 sqlite3VdbeAddOp2(v, OP_Integer, 0, regChng);
danf00e9022013-08-14 19:54:12 +00001115 addrNextRow = sqlite3VdbeCurrentAddr(v);
dane0432012013-08-05 18:00:56 +00001116
drh553818a2014-07-23 18:36:55 +00001117 if( nColTest>0 ){
1118 /*
1119 ** next_row:
1120 ** regChng = 0
1121 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1122 ** regChng = 1
1123 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1124 ** ...
1125 ** regChng = N
1126 ** goto chng_addr_N
1127 */
1128 sqlite3VdbeAddOp0(v, OP_Goto);
1129 addrNextRow = sqlite3VdbeCurrentAddr(v);
1130 for(i=0; i<nColTest; i++){
1131 char *pColl = (char*)sqlite3LocateCollSeq(pParse, pIdx->azColl[i]);
1132 sqlite3VdbeAddOp2(v, OP_Integer, i, regChng);
1133 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regTemp);
1134 aGotoChng[i] =
1135 sqlite3VdbeAddOp4(v, OP_Ne, regTemp, 0, regPrev+i, pColl, P4_COLLSEQ);
1136 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
1137 VdbeCoverage(v);
1138 }
1139 sqlite3VdbeAddOp2(v, OP_Integer, nColTest, regChng);
1140 aGotoChng[nColTest] = sqlite3VdbeAddOp0(v, OP_Goto);
1141
1142
1143 /*
1144 ** chng_addr_0:
1145 ** regPrev(0) = idx(0)
1146 ** chng_addr_1:
1147 ** regPrev(1) = idx(1)
1148 ** ...
1149 */
1150 sqlite3VdbeJumpHere(v, addrNextRow-1);
1151 for(i=0; i<nColTest; i++){
1152 sqlite3VdbeJumpHere(v, aGotoChng[i]);
1153 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regPrev+i);
1154 }
1155 sqlite3VdbeJumpHere(v, aGotoChng[nColTest]);
drhff2d5ea2005-07-23 00:41:48 +00001156 }
drh553818a2014-07-23 18:36:55 +00001157
danf00e9022013-08-14 19:54:12 +00001158 /*
1159 ** chng_addr_N:
drh9fecc542013-08-27 20:16:48 +00001160 ** regRowid = idx(rowid) // STAT34 only
1161 ** stat_push(P, regChng, regRowid) // 3rd parameter STAT34 only
danf00e9022013-08-14 19:54:12 +00001162 ** Next csr
1163 ** if !eof(csr) goto next_row;
1164 */
drh1435a9a2013-08-27 23:15:44 +00001165#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +00001166 assert( regRowid==(regStat4+2) );
drhebe25af2013-11-02 18:46:04 +00001167 if( HasRowid(pTab) ){
1168 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, regRowid);
1169 }else{
1170 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
1171 int j, k, regKey;
1172 regKey = sqlite3GetTempRange(pParse, pPk->nKeyCol);
1173 for(j=0; j<pPk->nKeyCol; j++){
1174 k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
1175 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, regKey+j);
1176 VdbeComment((v, "%s", pTab->aCol[pPk->aiColumn[j]].zName));
1177 }
1178 sqlite3VdbeAddOp3(v, OP_MakeRecord, regKey, pPk->nKeyCol, regRowid);
1179 sqlite3ReleaseTempRange(pParse, regKey, pPk->nKeyCol);
1180 }
drh9fecc542013-08-27 20:16:48 +00001181#endif
1182 assert( regChng==(regStat4+1) );
danf00e9022013-08-14 19:54:12 +00001183 sqlite3VdbeAddOp3(v, OP_Function, 1, regStat4, regTemp);
1184 sqlite3VdbeChangeP4(v, -1, (char*)&statPushFuncdef, P4_FUNCDEF);
drh9fecc542013-08-27 20:16:48 +00001185 sqlite3VdbeChangeP5(v, 2+IsStat34);
drh688852a2014-02-17 22:40:43 +00001186 sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001187
1188 /* Add the entry to the stat1 table. */
1189 callStatGet(v, regStat4, STAT_GET_STAT1, regStat1);
1190 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "aaa", 0);
drhade3add2011-08-13 00:58:05 +00001191 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
danf00e9022013-08-14 19:54:12 +00001192 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
drh2d401ab2008-01-10 23:50:11 +00001193 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
danf00e9022013-08-14 19:54:12 +00001194
1195 /* Add the entries to the stat3 or stat4 table. */
drh1435a9a2013-08-27 23:15:44 +00001196#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +00001197 {
danf00e9022013-08-14 19:54:12 +00001198 int regEq = regStat1;
1199 int regLt = regStat1+1;
1200 int regDLt = regStat1+2;
1201 int regSample = regStat1+3;
1202 int regCol = regStat1+4;
1203 int regSampleRowid = regCol + nCol;
1204 int addrNext;
1205 int addrIsNull;
drhebe25af2013-11-02 18:46:04 +00001206 u8 seekOp = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
danf00e9022013-08-14 19:54:12 +00001207
drhec9e55d2014-06-30 17:07:39 +00001208 pParse->nMem = MAX(pParse->nMem, regCol+nCol);
danf00e9022013-08-14 19:54:12 +00001209
1210 addrNext = sqlite3VdbeCurrentAddr(v);
1211 callStatGet(v, regStat4, STAT_GET_ROWID, regSampleRowid);
1212 addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regSampleRowid);
drh688852a2014-02-17 22:40:43 +00001213 VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001214 callStatGet(v, regStat4, STAT_GET_NEQ, regEq);
1215 callStatGet(v, regStat4, STAT_GET_NLT, regLt);
1216 callStatGet(v, regStat4, STAT_GET_NDLT, regDLt);
drhebe25af2013-11-02 18:46:04 +00001217 sqlite3VdbeAddOp4Int(v, seekOp, iTabCur, addrNext, regSampleRowid, 0);
drhfe705102014-03-06 13:38:37 +00001218 /* We know that the regSampleRowid row exists because it was read by
1219 ** the previous loop. Thus the not-found jump of seekOp will never
1220 ** be taken */
1221 VdbeCoverageNeverTaken(v);
drh9fecc542013-08-27 20:16:48 +00001222#ifdef SQLITE_ENABLE_STAT3
1223 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTabCur,
1224 pIdx->aiColumn[0], regSample);
1225#else
drhec9e55d2014-06-30 17:07:39 +00001226 for(i=0; i<nCol; i++){
drhbbbdc832013-10-22 18:01:40 +00001227 i16 iCol = pIdx->aiColumn[i];
drh9fecc542013-08-27 20:16:48 +00001228 sqlite3ExprCodeGetColumnOfTable(v, pTab, iTabCur, iCol, regCol+i);
danf00e9022013-08-14 19:54:12 +00001229 }
drhec9e55d2014-06-30 17:07:39 +00001230 sqlite3VdbeAddOp3(v, OP_MakeRecord, regCol, nCol, regSample);
drh9fecc542013-08-27 20:16:48 +00001231#endif
drh57bf4a82014-02-17 14:59:22 +00001232 sqlite3VdbeAddOp3(v, OP_MakeRecord, regTabname, 6, regTemp);
danf00e9022013-08-14 19:54:12 +00001233 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur+1, regNewRowid);
1234 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur+1, regTemp, regNewRowid);
drhfe705102014-03-06 13:38:37 +00001235 sqlite3VdbeAddOp2(v, OP_Goto, 1, addrNext); /* P1==1 for end-of-loop */
danf00e9022013-08-14 19:54:12 +00001236 sqlite3VdbeJumpHere(v, addrIsNull);
1237 }
drh1435a9a2013-08-27 23:15:44 +00001238#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
danf00e9022013-08-14 19:54:12 +00001239
drh9fecc542013-08-27 20:16:48 +00001240 /* End of analysis */
danf00e9022013-08-14 19:54:12 +00001241 sqlite3VdbeJumpHere(v, addrRewind);
1242 sqlite3DbFree(db, aGotoChng);
drh15564052010-09-25 22:32:56 +00001243 }
1244
danf00e9022013-08-14 19:54:12 +00001245
drh721dfcf2013-08-01 04:39:17 +00001246 /* Create a single sqlite_stat1 entry containing NULL as the index
1247 ** name and the row count as the content.
drh15564052010-09-25 22:32:56 +00001248 */
drh721dfcf2013-08-01 04:39:17 +00001249 if( pOnlyIdx==0 && needTableCnt ){
drh15564052010-09-25 22:32:56 +00001250 VdbeComment((v, "%s", pTab->zName));
dane0432012013-08-05 18:00:56 +00001251 sqlite3VdbeAddOp2(v, OP_Count, iTabCur, regStat1);
drh688852a2014-02-17 22:40:43 +00001252 jZeroRows = sqlite3VdbeAddOp1(v, OP_IfNot, regStat1); VdbeCoverage(v);
drh721dfcf2013-08-01 04:39:17 +00001253 sqlite3VdbeAddOp2(v, OP_Null, 0, regIdxname);
danf00e9022013-08-14 19:54:12 +00001254 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "aaa", 0);
drh721dfcf2013-08-01 04:39:17 +00001255 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
danf00e9022013-08-14 19:54:12 +00001256 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
drh721dfcf2013-08-01 04:39:17 +00001257 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
drh15564052010-09-25 22:32:56 +00001258 sqlite3VdbeJumpHere(v, jZeroRows);
1259 }
drhff2d5ea2005-07-23 00:41:48 +00001260}
1261
drhfaacf172011-08-12 01:51:45 +00001262
drhff2d5ea2005-07-23 00:41:48 +00001263/*
drh497e4462005-07-23 03:18:40 +00001264** Generate code that will cause the most recent index analysis to
drh15564052010-09-25 22:32:56 +00001265** be loaded into internal hash tables where is can be used.
drh497e4462005-07-23 03:18:40 +00001266*/
1267static void loadAnalysis(Parse *pParse, int iDb){
1268 Vdbe *v = sqlite3GetVdbe(pParse);
drhcf1be452007-05-12 12:08:51 +00001269 if( v ){
drh66a51672008-01-03 00:01:23 +00001270 sqlite3VdbeAddOp1(v, OP_LoadAnalysis, iDb);
drhcf1be452007-05-12 12:08:51 +00001271 }
drh497e4462005-07-23 03:18:40 +00001272}
1273
1274/*
drhff2d5ea2005-07-23 00:41:48 +00001275** Generate code that will do an analysis of an entire database
1276*/
1277static void analyzeDatabase(Parse *pParse, int iDb){
1278 sqlite3 *db = pParse->db;
danielk1977e501b892006-01-09 06:29:47 +00001279 Schema *pSchema = db->aDb[iDb].pSchema; /* Schema of database iDb */
drhff2d5ea2005-07-23 00:41:48 +00001280 HashElem *k;
1281 int iStatCur;
1282 int iMem;
danc6129702013-08-05 19:04:07 +00001283 int iTab;
drhff2d5ea2005-07-23 00:41:48 +00001284
1285 sqlite3BeginWriteOperation(pParse, 0, iDb);
dan02fa4692009-08-17 17:06:58 +00001286 iStatCur = pParse->nTab;
drhade3add2011-08-13 00:58:05 +00001287 pParse->nTab += 3;
drha071bc52011-03-31 02:03:28 +00001288 openStatTable(pParse, iDb, iStatCur, 0, 0);
drh0a07c102008-01-03 18:03:08 +00001289 iMem = pParse->nMem+1;
danc6129702013-08-05 19:04:07 +00001290 iTab = pParse->nTab;
drh21206082011-04-04 18:22:02 +00001291 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
danielk1977da184232006-01-05 11:34:32 +00001292 for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
drhff2d5ea2005-07-23 00:41:48 +00001293 Table *pTab = (Table*)sqliteHashData(k);
danc6129702013-08-05 19:04:07 +00001294 analyzeOneTable(pParse, pTab, 0, iStatCur, iMem, iTab);
drhff2d5ea2005-07-23 00:41:48 +00001295 }
drh497e4462005-07-23 03:18:40 +00001296 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001297}
1298
1299/*
1300** Generate code that will do an analysis of a single table in
drha071bc52011-03-31 02:03:28 +00001301** a database. If pOnlyIdx is not NULL then it is a single index
1302** in pTab that should be analyzed.
drhff2d5ea2005-07-23 00:41:48 +00001303*/
drha071bc52011-03-31 02:03:28 +00001304static void analyzeTable(Parse *pParse, Table *pTab, Index *pOnlyIdx){
drhff2d5ea2005-07-23 00:41:48 +00001305 int iDb;
1306 int iStatCur;
1307
1308 assert( pTab!=0 );
drh1fee73e2007-08-29 04:00:57 +00001309 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
danielk1977da184232006-01-05 11:34:32 +00001310 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drhff2d5ea2005-07-23 00:41:48 +00001311 sqlite3BeginWriteOperation(pParse, 0, iDb);
dan02fa4692009-08-17 17:06:58 +00001312 iStatCur = pParse->nTab;
drhade3add2011-08-13 00:58:05 +00001313 pParse->nTab += 3;
drha071bc52011-03-31 02:03:28 +00001314 if( pOnlyIdx ){
1315 openStatTable(pParse, iDb, iStatCur, pOnlyIdx->zName, "idx");
1316 }else{
1317 openStatTable(pParse, iDb, iStatCur, pTab->zName, "tbl");
1318 }
danc6129702013-08-05 19:04:07 +00001319 analyzeOneTable(pParse, pTab, pOnlyIdx, iStatCur,pParse->nMem+1,pParse->nTab);
drh497e4462005-07-23 03:18:40 +00001320 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001321}
1322
1323/*
1324** Generate code for the ANALYZE command. The parser calls this routine
1325** when it recognizes an ANALYZE command.
drh9f18e8a2005-07-08 12:13:04 +00001326**
1327** ANALYZE -- 1
drhff2d5ea2005-07-23 00:41:48 +00001328** ANALYZE <database> -- 2
drh9f18e8a2005-07-08 12:13:04 +00001329** ANALYZE ?<database>.?<tablename> -- 3
1330**
1331** Form 1 causes all indices in all attached databases to be analyzed.
1332** Form 2 analyzes all indices the single database named.
1333** Form 3 analyzes all indices associated with the named table.
1334*/
1335void sqlite3Analyze(Parse *pParse, Token *pName1, Token *pName2){
drhff2d5ea2005-07-23 00:41:48 +00001336 sqlite3 *db = pParse->db;
1337 int iDb;
1338 int i;
1339 char *z, *zDb;
1340 Table *pTab;
drha071bc52011-03-31 02:03:28 +00001341 Index *pIdx;
drhff2d5ea2005-07-23 00:41:48 +00001342 Token *pTableName;
drh358406f2014-07-22 14:42:16 +00001343 Vdbe *v;
drhff2d5ea2005-07-23 00:41:48 +00001344
1345 /* Read the database schema. If an error occurs, leave an error message
1346 ** and code in pParse and return NULL. */
drh1fee73e2007-08-29 04:00:57 +00001347 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
drhff2d5ea2005-07-23 00:41:48 +00001348 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
1349 return;
1350 }
1351
drh05800a12009-04-16 17:45:47 +00001352 assert( pName2!=0 || pName1==0 );
drhff2d5ea2005-07-23 00:41:48 +00001353 if( pName1==0 ){
1354 /* Form 1: Analyze everything */
1355 for(i=0; i<db->nDb; i++){
1356 if( i==1 ) continue; /* Do not analyze the TEMP database */
1357 analyzeDatabase(pParse, i);
1358 }
drh05800a12009-04-16 17:45:47 +00001359 }else if( pName2->n==0 ){
drhff2d5ea2005-07-23 00:41:48 +00001360 /* Form 2: Analyze the database or table named */
1361 iDb = sqlite3FindDb(db, pName1);
1362 if( iDb>=0 ){
1363 analyzeDatabase(pParse, iDb);
drhe6e04962005-07-23 02:17:03 +00001364 }else{
drh17435752007-08-16 04:30:38 +00001365 z = sqlite3NameFromToken(db, pName1);
danielk1977b8b4bfa2007-11-15 13:10:22 +00001366 if( z ){
drha071bc52011-03-31 02:03:28 +00001367 if( (pIdx = sqlite3FindIndex(db, z, 0))!=0 ){
1368 analyzeTable(pParse, pIdx->pTable, pIdx);
1369 }else if( (pTab = sqlite3LocateTable(pParse, 0, z, 0))!=0 ){
1370 analyzeTable(pParse, pTab, 0);
danielk1977b8b4bfa2007-11-15 13:10:22 +00001371 }
drha071bc52011-03-31 02:03:28 +00001372 sqlite3DbFree(db, z);
drhe6e04962005-07-23 02:17:03 +00001373 }
drhff2d5ea2005-07-23 00:41:48 +00001374 }
drhff2d5ea2005-07-23 00:41:48 +00001375 }else{
1376 /* Form 3: Analyze the fully qualified table name */
1377 iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pTableName);
1378 if( iDb>=0 ){
1379 zDb = db->aDb[iDb].zName;
drh17435752007-08-16 04:30:38 +00001380 z = sqlite3NameFromToken(db, pTableName);
drhcf1be452007-05-12 12:08:51 +00001381 if( z ){
drha071bc52011-03-31 02:03:28 +00001382 if( (pIdx = sqlite3FindIndex(db, z, zDb))!=0 ){
1383 analyzeTable(pParse, pIdx->pTable, pIdx);
1384 }else if( (pTab = sqlite3LocateTable(pParse, 0, z, zDb))!=0 ){
1385 analyzeTable(pParse, pTab, 0);
drhcf1be452007-05-12 12:08:51 +00001386 }
drha071bc52011-03-31 02:03:28 +00001387 sqlite3DbFree(db, z);
drhff2d5ea2005-07-23 00:41:48 +00001388 }
1389 }
1390 }
drh358406f2014-07-22 14:42:16 +00001391 v = sqlite3GetVdbe(pParse);
1392 if( v ) sqlite3VdbeAddOp0(v, OP_Expire);
drh9f18e8a2005-07-08 12:13:04 +00001393}
1394
drh497e4462005-07-23 03:18:40 +00001395/*
1396** Used to pass information from the analyzer reader through to the
1397** callback routine.
1398*/
1399typedef struct analysisInfo analysisInfo;
1400struct analysisInfo {
1401 sqlite3 *db;
1402 const char *zDatabase;
1403};
1404
1405/*
danf52bb8d2013-08-03 20:24:58 +00001406** The first argument points to a nul-terminated string containing a
1407** list of space separated integers. Read the first nOut of these into
1408** the array aOut[].
1409*/
1410static void decodeIntArray(
drhc28c4e52013-10-03 19:21:41 +00001411 char *zIntArray, /* String containing int array to decode */
1412 int nOut, /* Number of slots in aOut[] */
1413 tRowcnt *aOut, /* Store integers here */
dancfc9df72014-04-25 15:01:01 +00001414 LogEst *aLog, /* Or, if aOut==0, here */
drhc28c4e52013-10-03 19:21:41 +00001415 Index *pIndex /* Handle extra flags for this index, if not NULL */
danf52bb8d2013-08-03 20:24:58 +00001416){
1417 char *z = zIntArray;
1418 int c;
1419 int i;
1420 tRowcnt v;
drh1435a9a2013-08-27 23:15:44 +00001421
drh6d57bbf2013-08-28 11:43:49 +00001422#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
1423 if( z==0 ) z = "";
1424#else
drh1435a9a2013-08-27 23:15:44 +00001425 if( NEVER(z==0) ) z = "";
drh6d57bbf2013-08-28 11:43:49 +00001426#endif
danf52bb8d2013-08-03 20:24:58 +00001427 for(i=0; *z && i<nOut; i++){
1428 v = 0;
1429 while( (c=z[0])>='0' && c<='9' ){
1430 v = v*10 + c - '0';
1431 z++;
1432 }
drhc5f246e2014-05-01 20:24:21 +00001433#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dancfc9df72014-04-25 15:01:01 +00001434 if( aOut ){
1435 aOut[i] = v;
drhc5f246e2014-05-01 20:24:21 +00001436 }else
1437#else
1438 assert( aOut==0 );
1439 UNUSED_PARAMETER(aOut);
1440#endif
1441 {
dancfc9df72014-04-25 15:01:01 +00001442 aLog[i] = sqlite3LogEst(v);
1443 }
danf52bb8d2013-08-03 20:24:58 +00001444 if( *z==' ' ) z++;
1445 }
drh1f1fc0c2013-10-08 23:16:48 +00001446#ifndef SQLITE_ENABLE_STAT3_OR_STAT4
1447 assert( pIndex!=0 );
1448#else
1449 if( pIndex )
1450#endif
drh25df48d2014-07-22 14:58:12 +00001451 while( z[0] ){
1452 if( sqlite3_strglob("unordered*", z)==0 ){
drhd3037a42013-10-04 18:29:25 +00001453 pIndex->bUnordered = 1;
drhe13e9f52013-10-05 19:18:00 +00001454 }else if( sqlite3_strglob("sz=[0-9]*", z)==0 ){
drhd3037a42013-10-04 18:29:25 +00001455 int v32 = 0;
drhe13e9f52013-10-05 19:18:00 +00001456 sqlite3GetInt32(z+3, &v32);
1457 pIndex->szIdxRow = sqlite3LogEst(v32);
drhc28c4e52013-10-03 19:21:41 +00001458 }
drh25df48d2014-07-22 14:58:12 +00001459 while( z[0]!=0 && z[0]!=' ' ) z++;
1460 while( z[0]==' ' ) z++;
danf52bb8d2013-08-03 20:24:58 +00001461 }
1462}
1463
1464/*
drh497e4462005-07-23 03:18:40 +00001465** This callback is invoked once for each index when reading the
1466** sqlite_stat1 table.
1467**
drh15564052010-09-25 22:32:56 +00001468** argv[0] = name of the table
1469** argv[1] = name of the index (might be NULL)
1470** argv[2] = results of analysis - on integer for each column
1471**
1472** Entries for which argv[1]==NULL simply record the number of rows in
1473** the table.
drh497e4462005-07-23 03:18:40 +00001474*/
danielk197762c14b32008-11-19 09:05:26 +00001475static int analysisLoader(void *pData, int argc, char **argv, char **NotUsed){
drh497e4462005-07-23 03:18:40 +00001476 analysisInfo *pInfo = (analysisInfo*)pData;
1477 Index *pIndex;
drh15564052010-09-25 22:32:56 +00001478 Table *pTable;
drh497e4462005-07-23 03:18:40 +00001479 const char *z;
1480
drh15564052010-09-25 22:32:56 +00001481 assert( argc==3 );
danielk1977f3d3c272008-11-19 16:52:44 +00001482 UNUSED_PARAMETER2(NotUsed, argc);
1483
drh15564052010-09-25 22:32:56 +00001484 if( argv==0 || argv[0]==0 || argv[2]==0 ){
drh497e4462005-07-23 03:18:40 +00001485 return 0;
1486 }
drh15564052010-09-25 22:32:56 +00001487 pTable = sqlite3FindTable(pInfo->db, argv[0], pInfo->zDatabase);
1488 if( pTable==0 ){
drh497e4462005-07-23 03:18:40 +00001489 return 0;
1490 }
drhc2b23e72013-11-13 15:32:15 +00001491 if( argv[1]==0 ){
drh15564052010-09-25 22:32:56 +00001492 pIndex = 0;
drhc2b23e72013-11-13 15:32:15 +00001493 }else if( sqlite3_stricmp(argv[0],argv[1])==0 ){
1494 pIndex = sqlite3PrimaryKeyIndex(pTable);
1495 }else{
1496 pIndex = sqlite3FindIndex(pInfo->db, argv[1], pInfo->zDatabase);
drh15564052010-09-25 22:32:56 +00001497 }
drh15564052010-09-25 22:32:56 +00001498 z = argv[2];
danf52bb8d2013-08-03 20:24:58 +00001499
1500 if( pIndex ){
drh25df48d2014-07-22 14:58:12 +00001501 pIndex->bUnordered = 0;
dancfc9df72014-04-25 15:01:01 +00001502 decodeIntArray((char*)z, pIndex->nKeyCol+1, 0, pIndex->aiRowLogEst, pIndex);
1503 if( pIndex->pPartIdxWhere==0 ) pTable->nRowLogEst = pIndex->aiRowLogEst[0];
danf52bb8d2013-08-03 20:24:58 +00001504 }else{
drh52f6c912013-10-06 22:12:41 +00001505 Index fakeIdx;
1506 fakeIdx.szIdxRow = pTable->szTabRow;
dancfc9df72014-04-25 15:01:01 +00001507 decodeIntArray((char*)z, 1, 0, &pTable->nRowLogEst, &fakeIdx);
drh52f6c912013-10-06 22:12:41 +00001508 pTable->szTabRow = fakeIdx.szIdxRow;
drh497e4462005-07-23 03:18:40 +00001509 }
danf52bb8d2013-08-03 20:24:58 +00001510
drh497e4462005-07-23 03:18:40 +00001511 return 0;
1512}
1513
1514/*
dan85c165c2009-08-19 14:34:54 +00001515** If the Index.aSample variable is not NULL, delete the aSample[] array
1516** and its contents.
1517*/
dand46def72010-07-24 11:28:28 +00001518void sqlite3DeleteIndexSamples(sqlite3 *db, Index *pIdx){
drh1435a9a2013-08-27 23:15:44 +00001519#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan85c165c2009-08-19 14:34:54 +00001520 if( pIdx->aSample ){
1521 int j;
drhfaacf172011-08-12 01:51:45 +00001522 for(j=0; j<pIdx->nSample; j++){
dan85c165c2009-08-19 14:34:54 +00001523 IndexSample *p = &pIdx->aSample[j];
danf52bb8d2013-08-03 20:24:58 +00001524 sqlite3DbFree(db, p->p);
dan85c165c2009-08-19 14:34:54 +00001525 }
drh8e3937f2011-08-18 13:45:23 +00001526 sqlite3DbFree(db, pIdx->aSample);
dan85c165c2009-08-19 14:34:54 +00001527 }
drh8e3937f2011-08-18 13:45:23 +00001528 if( db && db->pnBytesFreed==0 ){
1529 pIdx->nSample = 0;
1530 pIdx->aSample = 0;
1531 }
shanecea72b22009-09-07 04:38:36 +00001532#else
drh43b18e12010-08-17 19:40:08 +00001533 UNUSED_PARAMETER(db);
shanecea72b22009-09-07 04:38:36 +00001534 UNUSED_PARAMETER(pIdx);
drh1435a9a2013-08-27 23:15:44 +00001535#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
dan85c165c2009-08-19 14:34:54 +00001536}
1537
drh1435a9a2013-08-27 23:15:44 +00001538#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan0adbed82013-08-15 19:56:32 +00001539/*
1540** Populate the pIdx->aAvgEq[] array based on the samples currently
1541** stored in pIdx->aSample[].
1542*/
1543static void initAvgEq(Index *pIdx){
1544 if( pIdx ){
1545 IndexSample *aSample = pIdx->aSample;
1546 IndexSample *pFinal = &aSample[pIdx->nSample-1];
1547 int iCol;
dan39caccf2014-07-01 11:54:02 +00001548 int nCol = 1;
1549 if( pIdx->nSampleCol>1 ){
1550 /* If this is stat4 data, then calculate aAvgEq[] values for all
1551 ** sample columns except the last. The last is always set to 1, as
1552 ** once the trailing PK fields are considered all index keys are
1553 ** unique. */
1554 nCol = pIdx->nSampleCol-1;
1555 pIdx->aAvgEq[nCol] = 1;
1556 }
1557 for(iCol=0; iCol<nCol; iCol++){
dan0adbed82013-08-15 19:56:32 +00001558 int i; /* Used to iterate through samples */
1559 tRowcnt sumEq = 0; /* Sum of the nEq values */
danad4c7aa2013-08-30 20:19:52 +00001560 tRowcnt nSum = 0; /* Number of terms contributing to sumEq */
dan0adbed82013-08-15 19:56:32 +00001561 tRowcnt avgEq = 0;
1562 tRowcnt nDLt = pFinal->anDLt[iCol];
1563
1564 /* Set nSum to the number of distinct (iCol+1) field prefixes that
1565 ** occur in the stat4 table for this index before pFinal. Set
1566 ** sumEq to the sum of the nEq values for column iCol for the same
1567 ** set (adding the value only once where there exist dupicate
1568 ** prefixes). */
1569 for(i=0; i<(pIdx->nSample-1); i++){
1570 if( aSample[i].anDLt[iCol]!=aSample[i+1].anDLt[iCol] ){
1571 sumEq += aSample[i].anEq[iCol];
1572 nSum++;
1573 }
1574 }
1575 if( nDLt>nSum ){
1576 avgEq = (pFinal->anLt[iCol] - sumEq)/(nDLt - nSum);
1577 }
1578 if( avgEq==0 ) avgEq = 1;
1579 pIdx->aAvgEq[iCol] = avgEq;
dan0adbed82013-08-15 19:56:32 +00001580 }
1581 }
1582}
1583
dan0106e372013-08-12 16:34:32 +00001584/*
drhce95d112013-11-02 19:34:38 +00001585** Look up an index by name. Or, if the name of a WITHOUT ROWID table
1586** is supplied instead, find the PRIMARY KEY index for that table.
1587*/
1588static Index *findIndexOrPrimaryKey(
1589 sqlite3 *db,
1590 const char *zName,
1591 const char *zDb
1592){
1593 Index *pIdx = sqlite3FindIndex(db, zName, zDb);
1594 if( pIdx==0 ){
1595 Table *pTab = sqlite3FindTable(db, zName, zDb);
1596 if( pTab && !HasRowid(pTab) ) pIdx = sqlite3PrimaryKeyIndex(pTab);
1597 }
1598 return pIdx;
1599}
1600
1601/*
dan0106e372013-08-12 16:34:32 +00001602** Load the content from either the sqlite_stat4 or sqlite_stat3 table
1603** into the relevant Index.aSample[] arrays.
1604**
1605** Arguments zSql1 and zSql2 must point to SQL statements that return
1606** data equivalent to the following (statements are different for stat3,
1607** see the caller of this function for details):
1608**
1609** zSql1: SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx
1610** zSql2: SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4
1611**
1612** where %Q is replaced with the database name before the SQL is executed.
1613*/
1614static int loadStatTbl(
1615 sqlite3 *db, /* Database handle */
1616 int bStat3, /* Assume single column records only */
1617 const char *zSql1, /* SQL statement 1 (see above) */
1618 const char *zSql2, /* SQL statement 2 (see above) */
1619 const char *zDb /* Database name (e.g. "main") */
1620){
drhfaacf172011-08-12 01:51:45 +00001621 int rc; /* Result codes from subroutines */
1622 sqlite3_stmt *pStmt = 0; /* An SQL statement being run */
1623 char *zSql; /* Text of the SQL statement */
1624 Index *pPrevIdx = 0; /* Previous index in the loop */
drhfaacf172011-08-12 01:51:45 +00001625 IndexSample *pSample; /* A slot in pIdx->aSample[] */
1626
dan0d1614c2012-03-19 10:21:37 +00001627 assert( db->lookaside.bEnabled==0 );
dan0106e372013-08-12 16:34:32 +00001628 zSql = sqlite3MPrintf(db, zSql1, zDb);
drhfaacf172011-08-12 01:51:45 +00001629 if( !zSql ){
1630 return SQLITE_NOMEM;
1631 }
1632 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1633 sqlite3DbFree(db, zSql);
1634 if( rc ) return rc;
1635
1636 while( sqlite3_step(pStmt)==SQLITE_ROW ){
dan0106e372013-08-12 16:34:32 +00001637 int nIdxCol = 1; /* Number of columns in stat4 records */
dan0106e372013-08-12 16:34:32 +00001638
drhfaacf172011-08-12 01:51:45 +00001639 char *zIndex; /* Index name */
1640 Index *pIdx; /* Pointer to the index object */
1641 int nSample; /* Number of samples */
danf52bb8d2013-08-03 20:24:58 +00001642 int nByte; /* Bytes of space required */
1643 int i; /* Bytes of space required */
1644 tRowcnt *pSpace;
drhfaacf172011-08-12 01:51:45 +00001645
1646 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1647 if( zIndex==0 ) continue;
1648 nSample = sqlite3_column_int(pStmt, 1);
drhce95d112013-11-02 19:34:38 +00001649 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
dan86f69d92013-08-12 17:31:32 +00001650 assert( pIdx==0 || bStat3 || pIdx->nSample==0 );
1651 /* Index.nSample is non-zero at this point if data has already been
1652 ** loaded from the stat4 table. In this case ignore stat3 data. */
1653 if( pIdx==0 || pIdx->nSample ) continue;
dan0106e372013-08-12 16:34:32 +00001654 if( bStat3==0 ){
dan39caccf2014-07-01 11:54:02 +00001655 assert( !HasRowid(pIdx->pTable) || pIdx->nColumn==pIdx->nKeyCol+1 );
1656 if( !HasRowid(pIdx->pTable) && IsPrimaryKeyIndex(pIdx) ){
1657 nIdxCol = pIdx->nKeyCol;
1658 }else{
1659 nIdxCol = pIdx->nColumn;
1660 }
dan0106e372013-08-12 16:34:32 +00001661 }
dan8ad169a2013-08-12 20:14:04 +00001662 pIdx->nSampleCol = nIdxCol;
danf52bb8d2013-08-03 20:24:58 +00001663 nByte = sizeof(IndexSample) * nSample;
dan0106e372013-08-12 16:34:32 +00001664 nByte += sizeof(tRowcnt) * nIdxCol * 3 * nSample;
dan39caccf2014-07-01 11:54:02 +00001665 nByte += nIdxCol * sizeof(tRowcnt); /* Space for Index.aAvgEq[] */
danf52bb8d2013-08-03 20:24:58 +00001666
1667 pIdx->aSample = sqlite3DbMallocZero(db, nByte);
drhfaacf172011-08-12 01:51:45 +00001668 if( pIdx->aSample==0 ){
drhfaacf172011-08-12 01:51:45 +00001669 sqlite3_finalize(pStmt);
1670 return SQLITE_NOMEM;
1671 }
danf52bb8d2013-08-03 20:24:58 +00001672 pSpace = (tRowcnt*)&pIdx->aSample[nSample];
dan39caccf2014-07-01 11:54:02 +00001673 pIdx->aAvgEq = pSpace; pSpace += nIdxCol;
dan0adbed82013-08-15 19:56:32 +00001674 for(i=0; i<nSample; i++){
dan0106e372013-08-12 16:34:32 +00001675 pIdx->aSample[i].anEq = pSpace; pSpace += nIdxCol;
1676 pIdx->aSample[i].anLt = pSpace; pSpace += nIdxCol;
1677 pIdx->aSample[i].anDLt = pSpace; pSpace += nIdxCol;
danf52bb8d2013-08-03 20:24:58 +00001678 }
1679 assert( ((u8*)pSpace)-nByte==(u8*)(pIdx->aSample) );
drhfaacf172011-08-12 01:51:45 +00001680 }
drh8e3937f2011-08-18 13:45:23 +00001681 rc = sqlite3_finalize(pStmt);
1682 if( rc ) return rc;
drhfaacf172011-08-12 01:51:45 +00001683
dan0106e372013-08-12 16:34:32 +00001684 zSql = sqlite3MPrintf(db, zSql2, zDb);
drhfaacf172011-08-12 01:51:45 +00001685 if( !zSql ){
1686 return SQLITE_NOMEM;
1687 }
1688 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1689 sqlite3DbFree(db, zSql);
1690 if( rc ) return rc;
1691
1692 while( sqlite3_step(pStmt)==SQLITE_ROW ){
dan0106e372013-08-12 16:34:32 +00001693 char *zIndex; /* Index name */
1694 Index *pIdx; /* Pointer to the index object */
dan0106e372013-08-12 16:34:32 +00001695 int nCol = 1; /* Number of columns in index */
drhfaacf172011-08-12 01:51:45 +00001696
1697 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1698 if( zIndex==0 ) continue;
drhce95d112013-11-02 19:34:38 +00001699 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
drhfaacf172011-08-12 01:51:45 +00001700 if( pIdx==0 ) continue;
dan86f69d92013-08-12 17:31:32 +00001701 /* This next condition is true if data has already been loaded from
1702 ** the sqlite_stat4 table. In this case ignore stat3 data. */
dan0adbed82013-08-15 19:56:32 +00001703 nCol = pIdx->nSampleCol;
1704 if( bStat3 && nCol>1 ) continue;
1705 if( pIdx!=pPrevIdx ){
1706 initAvgEq(pPrevIdx);
1707 pPrevIdx = pIdx;
dan0106e372013-08-12 16:34:32 +00001708 }
danc367d4c2013-08-16 14:09:43 +00001709 pSample = &pIdx->aSample[pIdx->nSample];
dancfc9df72014-04-25 15:01:01 +00001710 decodeIntArray((char*)sqlite3_column_text(pStmt,1),nCol,pSample->anEq,0,0);
1711 decodeIntArray((char*)sqlite3_column_text(pStmt,2),nCol,pSample->anLt,0,0);
1712 decodeIntArray((char*)sqlite3_column_text(pStmt,3),nCol,pSample->anDLt,0,0);
danf52bb8d2013-08-03 20:24:58 +00001713
danc367d4c2013-08-16 14:09:43 +00001714 /* Take a copy of the sample. Add two 0x00 bytes the end of the buffer.
1715 ** This is in case the sample record is corrupted. In that case, the
1716 ** sqlite3VdbeRecordCompare() may read up to two varints past the
1717 ** end of the allocated buffer before it realizes it is dealing with
1718 ** a corrupt record. Adding the two 0x00 bytes prevents this from causing
1719 ** a buffer overread. */
danf52bb8d2013-08-03 20:24:58 +00001720 pSample->n = sqlite3_column_bytes(pStmt, 4);
danc367d4c2013-08-16 14:09:43 +00001721 pSample->p = sqlite3DbMallocZero(db, pSample->n + 2);
danf52bb8d2013-08-03 20:24:58 +00001722 if( pSample->p==0 ){
1723 sqlite3_finalize(pStmt);
1724 return SQLITE_NOMEM;
drhfaacf172011-08-12 01:51:45 +00001725 }
danf52bb8d2013-08-03 20:24:58 +00001726 memcpy(pSample->p, sqlite3_column_blob(pStmt, 4), pSample->n);
danc367d4c2013-08-16 14:09:43 +00001727 pIdx->nSample++;
drhfaacf172011-08-12 01:51:45 +00001728 }
drh61b34402013-08-16 13:34:50 +00001729 rc = sqlite3_finalize(pStmt);
1730 if( rc==SQLITE_OK ) initAvgEq(pPrevIdx);
1731 return rc;
drhfaacf172011-08-12 01:51:45 +00001732}
dan0106e372013-08-12 16:34:32 +00001733
1734/*
1735** Load content from the sqlite_stat4 and sqlite_stat3 tables into
1736** the Index.aSample[] arrays of all indices.
1737*/
1738static int loadStat4(sqlite3 *db, const char *zDb){
1739 int rc = SQLITE_OK; /* Result codes from subroutines */
1740
1741 assert( db->lookaside.bEnabled==0 );
1742 if( sqlite3FindTable(db, "sqlite_stat4", zDb) ){
1743 rc = loadStatTbl(db, 0,
1744 "SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx",
1745 "SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4",
1746 zDb
1747 );
1748 }
1749
1750 if( rc==SQLITE_OK && sqlite3FindTable(db, "sqlite_stat3", zDb) ){
1751 rc = loadStatTbl(db, 1,
1752 "SELECT idx,count(*) FROM %Q.sqlite_stat3 GROUP BY idx",
1753 "SELECT idx,neq,nlt,ndlt,sqlite_record(sample) FROM %Q.sqlite_stat3",
1754 zDb
1755 );
1756 }
1757
1758 return rc;
1759}
drh1435a9a2013-08-27 23:15:44 +00001760#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drhfaacf172011-08-12 01:51:45 +00001761
1762/*
drh92707ac2013-08-17 18:57:15 +00001763** Load the content of the sqlite_stat1 and sqlite_stat3/4 tables. The
dan85c165c2009-08-19 14:34:54 +00001764** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
drh92707ac2013-08-17 18:57:15 +00001765** arrays. The contents of sqlite_stat3/4 are used to populate the
dan85c165c2009-08-19 14:34:54 +00001766** Index.aSample[] arrays.
1767**
1768** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
drh92707ac2013-08-17 18:57:15 +00001769** is returned. In this case, even if SQLITE_ENABLE_STAT3/4 was defined
1770** during compilation and the sqlite_stat3/4 table is present, no data is
dan85c165c2009-08-19 14:34:54 +00001771** read from it.
1772**
drh92707ac2013-08-17 18:57:15 +00001773** If SQLITE_ENABLE_STAT3/4 was defined during compilation and the
danf52bb8d2013-08-03 20:24:58 +00001774** sqlite_stat4 table is not present in the database, SQLITE_ERROR is
dan85c165c2009-08-19 14:34:54 +00001775** returned. However, in this case, data is read from the sqlite_stat1
1776** table (if it is present) before returning.
1777**
1778** If an OOM error occurs, this function always sets db->mallocFailed.
1779** This means if the caller does not care about other errors, the return
1780** code may be ignored.
drh497e4462005-07-23 03:18:40 +00001781*/
drhcf1be452007-05-12 12:08:51 +00001782int sqlite3AnalysisLoad(sqlite3 *db, int iDb){
drh497e4462005-07-23 03:18:40 +00001783 analysisInfo sInfo;
1784 HashElem *i;
1785 char *zSql;
drhcf1be452007-05-12 12:08:51 +00001786 int rc;
drh497e4462005-07-23 03:18:40 +00001787
drhff0587c2007-08-29 17:43:19 +00001788 assert( iDb>=0 && iDb<db->nDb );
1789 assert( db->aDb[iDb].pBt!=0 );
drh1fee73e2007-08-29 04:00:57 +00001790
drh497e4462005-07-23 03:18:40 +00001791 /* Clear any prior statistics */
drh21206082011-04-04 18:22:02 +00001792 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
danielk1977da184232006-01-05 11:34:32 +00001793 for(i=sqliteHashFirst(&db->aDb[iDb].pSchema->idxHash);i;i=sqliteHashNext(i)){
drh497e4462005-07-23 03:18:40 +00001794 Index *pIdx = sqliteHashData(i);
drh51147ba2005-07-23 22:59:55 +00001795 sqlite3DefaultRowEst(pIdx);
drh1435a9a2013-08-27 23:15:44 +00001796#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dand46def72010-07-24 11:28:28 +00001797 sqlite3DeleteIndexSamples(db, pIdx);
1798 pIdx->aSample = 0;
drhfaacf172011-08-12 01:51:45 +00001799#endif
drh497e4462005-07-23 03:18:40 +00001800 }
1801
dan85c165c2009-08-19 14:34:54 +00001802 /* Check to make sure the sqlite_stat1 table exists */
drh497e4462005-07-23 03:18:40 +00001803 sInfo.db = db;
1804 sInfo.zDatabase = db->aDb[iDb].zName;
1805 if( sqlite3FindTable(db, "sqlite_stat1", sInfo.zDatabase)==0 ){
dan85c165c2009-08-19 14:34:54 +00001806 return SQLITE_ERROR;
drh497e4462005-07-23 03:18:40 +00001807 }
1808
drh497e4462005-07-23 03:18:40 +00001809 /* Load new statistics out of the sqlite_stat1 table */
dan85c165c2009-08-19 14:34:54 +00001810 zSql = sqlite3MPrintf(db,
drhfaacf172011-08-12 01:51:45 +00001811 "SELECT tbl,idx,stat FROM %Q.sqlite_stat1", sInfo.zDatabase);
drhf16ce3b2009-02-13 16:59:53 +00001812 if( zSql==0 ){
1813 rc = SQLITE_NOMEM;
1814 }else{
drhf16ce3b2009-02-13 16:59:53 +00001815 rc = sqlite3_exec(db, zSql, analysisLoader, &sInfo, 0);
drhf16ce3b2009-02-13 16:59:53 +00001816 sqlite3DbFree(db, zSql);
drhf16ce3b2009-02-13 16:59:53 +00001817 }
dan02fa4692009-08-17 17:06:58 +00001818
dan85c165c2009-08-19 14:34:54 +00001819
danf52bb8d2013-08-03 20:24:58 +00001820 /* Load the statistics from the sqlite_stat4 table. */
drh1435a9a2013-08-27 23:15:44 +00001821#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan02fa4692009-08-17 17:06:58 +00001822 if( rc==SQLITE_OK ){
dan0d1614c2012-03-19 10:21:37 +00001823 int lookasideEnabled = db->lookaside.bEnabled;
1824 db->lookaside.bEnabled = 0;
danf52bb8d2013-08-03 20:24:58 +00001825 rc = loadStat4(db, sInfo.zDatabase);
dan0d1614c2012-03-19 10:21:37 +00001826 db->lookaside.bEnabled = lookasideEnabled;
dan02fa4692009-08-17 17:06:58 +00001827 }
dan69188d92009-08-19 08:18:32 +00001828#endif
dan02fa4692009-08-17 17:06:58 +00001829
dane275dc32009-08-18 16:24:58 +00001830 if( rc==SQLITE_NOMEM ){
1831 db->mallocFailed = 1;
1832 }
drhcf1be452007-05-12 12:08:51 +00001833 return rc;
drh497e4462005-07-23 03:18:40 +00001834}
drh9f18e8a2005-07-08 12:13:04 +00001835
drhff2d5ea2005-07-23 00:41:48 +00001836
drh9f18e8a2005-07-08 12:13:04 +00001837#endif /* SQLITE_OMIT_ANALYZE */