blob: 495cc954accdc25a2c7efc2ff994c6eab63da9ae [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**
peter.d.reid60ec9142014-09-06 16:39:46 +000038** For most applications, sqlite_stat1 provides all the statistics required
drhc8af8502013-08-09 14:07:55 +000039** 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;
drh69c33822016-08-18 14:33:11 +0000213 if( (pStat = sqlite3FindTable(db, zTab, pDb->zDbSName))==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,
drh69c33822016-08-18 14:33:11 +0000220 "CREATE TABLE %Q.%s(%s)", pDb->zDbSName, zTab, aTable[i].zCols
dan8ad169a2013-08-12 20:14:04 +0000221 );
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",
drh69c33822016-08-18 14:33:11 +0000235 pDb->zDbSName, 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 */
danbd1d2702017-02-22 19:27:51 +0000293 int nMaxEqZero; /* Max leading 0 in anEq[] for any a[] entry */
danf00e9022013-08-14 19:54:12 +0000294 int iGet; /* Index of current sample accessed by stat_get() */
295 Stat4Sample *a; /* Array of mxSample Stat4Sample objects */
drhebe25af2013-11-02 18:46:04 +0000296 sqlite3 *db; /* Database connection, for malloc() */
drhade3add2011-08-13 00:58:05 +0000297};
298
drhebe25af2013-11-02 18:46:04 +0000299/* Reclaim memory used by a Stat4Sample
300*/
301#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
302static void sampleClear(sqlite3 *db, Stat4Sample *p){
drhda475b82013-11-04 21:44:54 +0000303 assert( db!=0 );
304 if( p->nRowid ){
305 sqlite3DbFree(db, p->u.aRowid);
306 p->nRowid = 0;
307 }
drhebe25af2013-11-02 18:46:04 +0000308}
309#endif
310
drhda475b82013-11-04 21:44:54 +0000311/* Initialize the BLOB value of a ROWID
drhebe25af2013-11-02 18:46:04 +0000312*/
313#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhda475b82013-11-04 21:44:54 +0000314static void sampleSetRowid(sqlite3 *db, Stat4Sample *p, int n, const u8 *pData){
315 assert( db!=0 );
316 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
drh575fad62016-02-05 13:38:36 +0000317 p->u.aRowid = sqlite3DbMallocRawNN(db, n);
drhda475b82013-11-04 21:44:54 +0000318 if( p->u.aRowid ){
319 p->nRowid = n;
320 memcpy(p->u.aRowid, pData, n);
321 }else{
322 p->nRowid = 0;
323 }
324}
325#endif
326
327/* Initialize the INTEGER value of a ROWID.
328*/
329#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
330static void sampleSetRowidInt64(sqlite3 *db, Stat4Sample *p, i64 iRowid){
331 assert( db!=0 );
332 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
333 p->nRowid = 0;
334 p->u.iRowid = iRowid;
335}
336#endif
337
338
339/*
340** Copy the contents of object (*pFrom) into (*pTo).
341*/
342#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
343static void sampleCopy(Stat4Accum *p, Stat4Sample *pTo, Stat4Sample *pFrom){
344 pTo->isPSample = pFrom->isPSample;
345 pTo->iCol = pFrom->iCol;
346 pTo->iHash = pFrom->iHash;
347 memcpy(pTo->anEq, pFrom->anEq, sizeof(tRowcnt)*p->nCol);
348 memcpy(pTo->anLt, pFrom->anLt, sizeof(tRowcnt)*p->nCol);
349 memcpy(pTo->anDLt, pFrom->anDLt, sizeof(tRowcnt)*p->nCol);
350 if( pFrom->nRowid ){
351 sampleSetRowid(p->db, pTo, pFrom->nRowid, pFrom->u.aRowid);
352 }else{
353 sampleSetRowidInt64(p->db, pTo, pFrom->u.iRowid);
drhebe25af2013-11-02 18:46:04 +0000354 }
355}
356#endif
357
358/*
359** Reclaim all memory of a Stat4Accum structure.
360*/
361static void stat4Destructor(void *pOld){
362 Stat4Accum *p = (Stat4Accum*)pOld;
363#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
364 int i;
365 for(i=0; i<p->nCol; i++) sampleClear(p->db, p->aBest+i);
366 for(i=0; i<p->mxSample; i++) sampleClear(p->db, p->a+i);
drhda475b82013-11-04 21:44:54 +0000367 sampleClear(p->db, &p->current);
drhebe25af2013-11-02 18:46:04 +0000368#endif
369 sqlite3DbFree(p->db, p);
370}
371
drhade3add2011-08-13 00:58:05 +0000372/*
drhec9e55d2014-06-30 17:07:39 +0000373** Implementation of the stat_init(N,K,C) SQL function. The three parameters
374** are:
drh553818a2014-07-23 18:36:55 +0000375** N: The number of columns in the index including the rowid/pk (note 1)
376** K: The number of columns in the index excluding the rowid/pk.
377** C: The number of rows in the index (note 2)
drhec9e55d2014-06-30 17:07:39 +0000378**
drh553818a2014-07-23 18:36:55 +0000379** Note 1: In the special case of the covering index that implements a
380** WITHOUT ROWID table, N is the number of PRIMARY KEY columns, not the
381** total number of columns in the table.
drhec9e55d2014-06-30 17:07:39 +0000382**
drh553818a2014-07-23 18:36:55 +0000383** Note 2: C is only used for STAT3 and STAT4.
384**
385** For indexes on ordinary rowid tables, N==K+1. But for indexes on
386** WITHOUT ROWID tables, N=K+P where P is the number of columns in the
387** PRIMARY KEY of the table. The covering index that implements the
388** original WITHOUT ROWID table as N==K as a special case.
drhade3add2011-08-13 00:58:05 +0000389**
danf52bb8d2013-08-03 20:24:58 +0000390** This routine allocates the Stat4Accum object in heap memory. The return
peter.d.reid60ec9142014-09-06 16:39:46 +0000391** value is a pointer to the Stat4Accum object. The datatype of the
drhf8ede572014-09-01 23:06:44 +0000392** return value is BLOB, but it is really just a pointer to the Stat4Accum
393** object.
drhade3add2011-08-13 00:58:05 +0000394*/
danf00e9022013-08-14 19:54:12 +0000395static void statInit(
drhade3add2011-08-13 00:58:05 +0000396 sqlite3_context *context,
397 int argc,
398 sqlite3_value **argv
399){
danf52bb8d2013-08-03 20:24:58 +0000400 Stat4Accum *p;
danf52bb8d2013-08-03 20:24:58 +0000401 int nCol; /* Number of columns in index being sampled */
drhec9e55d2014-06-30 17:07:39 +0000402 int nKeyCol; /* Number of key columns */
drh9fecc542013-08-27 20:16:48 +0000403 int nColUp; /* nCol rounded up for alignment */
danf52bb8d2013-08-03 20:24:58 +0000404 int n; /* Bytes of space to allocate */
drhebe25af2013-11-02 18:46:04 +0000405 sqlite3 *db; /* Database connection */
drh1435a9a2013-08-27 23:15:44 +0000406#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000407 int mxSample = SQLITE_STAT4_SAMPLES;
408#endif
drhade3add2011-08-13 00:58:05 +0000409
danf52bb8d2013-08-03 20:24:58 +0000410 /* Decode the three function arguments */
drh68257192011-08-16 17:06:21 +0000411 UNUSED_PARAMETER(argc);
drh9fecc542013-08-27 20:16:48 +0000412 nCol = sqlite3_value_int(argv[0]);
drhec9e55d2014-06-30 17:07:39 +0000413 assert( nCol>0 );
drh9fecc542013-08-27 20:16:48 +0000414 nColUp = sizeof(tRowcnt)<8 ? (nCol+1)&~1 : nCol;
drhec9e55d2014-06-30 17:07:39 +0000415 nKeyCol = sqlite3_value_int(argv[1]);
416 assert( nKeyCol<=nCol );
417 assert( nKeyCol>0 );
danf52bb8d2013-08-03 20:24:58 +0000418
419 /* Allocate the space required for the Stat4Accum object */
danf00e9022013-08-14 19:54:12 +0000420 n = sizeof(*p)
drh9fecc542013-08-27 20:16:48 +0000421 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anEq */
422 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anDLt */
drh1435a9a2013-08-27 23:15:44 +0000423#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000424 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anLt */
drhebe25af2013-11-02 18:46:04 +0000425 + sizeof(Stat4Sample)*(nCol+mxSample) /* Stat4Accum.aBest[], a[] */
drh9fecc542013-08-27 20:16:48 +0000426 + sizeof(tRowcnt)*3*nColUp*(nCol+mxSample)
427#endif
428 ;
drhebe25af2013-11-02 18:46:04 +0000429 db = sqlite3_context_db_handle(context);
430 p = sqlite3DbMallocZero(db, n);
drhade3add2011-08-13 00:58:05 +0000431 if( p==0 ){
432 sqlite3_result_error_nomem(context);
433 return;
434 }
danf52bb8d2013-08-03 20:24:58 +0000435
drhebe25af2013-11-02 18:46:04 +0000436 p->db = db;
drh9fecc542013-08-27 20:16:48 +0000437 p->nRow = 0;
danf52bb8d2013-08-03 20:24:58 +0000438 p->nCol = nCol;
drhec9e55d2014-06-30 17:07:39 +0000439 p->nKeyCol = nKeyCol;
danf00e9022013-08-14 19:54:12 +0000440 p->current.anDLt = (tRowcnt*)&p[1];
drh9fecc542013-08-27 20:16:48 +0000441 p->current.anEq = &p->current.anDLt[nColUp];
danf00e9022013-08-14 19:54:12 +0000442
drh1435a9a2013-08-27 23:15:44 +0000443#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000444 {
445 u8 *pSpace; /* Allocated space not yet assigned */
446 int i; /* Used to iterate through p->aSample[] */
danf52bb8d2013-08-03 20:24:58 +0000447
drh9fecc542013-08-27 20:16:48 +0000448 p->iGet = -1;
449 p->mxSample = mxSample;
drhec9e55d2014-06-30 17:07:39 +0000450 p->nPSample = (tRowcnt)(sqlite3_value_int64(argv[2])/(mxSample/3+1) + 1);
drh9fecc542013-08-27 20:16:48 +0000451 p->current.anLt = &p->current.anEq[nColUp];
drh4081d5d2015-01-01 23:02:01 +0000452 p->iPrn = 0x689e962d*(u32)nCol ^ 0xd0944565*(u32)sqlite3_value_int(argv[2]);
drh9fecc542013-08-27 20:16:48 +0000453
454 /* Set up the Stat4Accum.a[] and aBest[] arrays */
455 p->a = (struct Stat4Sample*)&p->current.anLt[nColUp];
456 p->aBest = &p->a[mxSample];
457 pSpace = (u8*)(&p->a[mxSample+nCol]);
458 for(i=0; i<(mxSample+nCol); i++){
459 p->a[i].anEq = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
460 p->a[i].anLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
461 p->a[i].anDLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
462 }
463 assert( (pSpace - (u8*)p)==n );
464
465 for(i=0; i<nCol; i++){
466 p->aBest[i].iCol = i;
467 }
danf00e9022013-08-14 19:54:12 +0000468 }
drh9fecc542013-08-27 20:16:48 +0000469#endif
danf00e9022013-08-14 19:54:12 +0000470
drhf8ede572014-09-01 23:06:44 +0000471 /* Return a pointer to the allocated object to the caller. Note that
472 ** only the pointer (the 2nd parameter) matters. The size of the object
473 ** (given by the 3rd parameter) is never used and can be any positive
474 ** value. */
drh975e0762014-09-01 22:34:54 +0000475 sqlite3_result_blob(context, p, sizeof(*p), stat4Destructor);
drhade3add2011-08-13 00:58:05 +0000476}
danf00e9022013-08-14 19:54:12 +0000477static const FuncDef statInitFuncdef = {
drhec9e55d2014-06-30 17:07:39 +0000478 2+IsStat34, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000479 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000480 0, /* pUserData */
481 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000482 statInit, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000483 0, /* xFinalize */
484 "stat_init", /* zName */
drh80738d92016-02-15 00:34:16 +0000485 {0}
drhade3add2011-08-13 00:58:05 +0000486};
487
danb13af4c2013-09-03 14:43:12 +0000488#ifdef SQLITE_ENABLE_STAT4
489/*
490** pNew and pOld are both candidate non-periodic samples selected for
491** the same column (pNew->iCol==pOld->iCol). Ignoring this column and
492** considering only any trailing columns and the sample hash value, this
493** function returns true if sample pNew is to be preferred over pOld.
494** In other words, if we assume that the cardinalities of the selected
495** column for pNew and pOld are equal, is pNew to be preferred over pOld.
496**
497** This function assumes that for each argument sample, the contents of
498** the anEq[] array from pSample->anEq[pSample->iCol+1] onwards are valid.
499*/
500static int sampleIsBetterPost(
501 Stat4Accum *pAccum,
502 Stat4Sample *pNew,
503 Stat4Sample *pOld
504){
505 int nCol = pAccum->nCol;
506 int i;
507 assert( pNew->iCol==pOld->iCol );
508 for(i=pNew->iCol+1; i<nCol; i++){
509 if( pNew->anEq[i]>pOld->anEq[i] ) return 1;
510 if( pNew->anEq[i]<pOld->anEq[i] ) return 0;
511 }
512 if( pNew->iHash>pOld->iHash ) return 1;
513 return 0;
514}
515#endif
516
drh1435a9a2013-08-27 23:15:44 +0000517#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
danf00e9022013-08-14 19:54:12 +0000518/*
519** Return true if pNew is to be preferred over pOld.
danb13af4c2013-09-03 14:43:12 +0000520**
521** This function assumes that for each argument sample, the contents of
522** the anEq[] array from pSample->anEq[pSample->iCol] onwards are valid.
danf00e9022013-08-14 19:54:12 +0000523*/
danb13af4c2013-09-03 14:43:12 +0000524static int sampleIsBetter(
525 Stat4Accum *pAccum,
526 Stat4Sample *pNew,
527 Stat4Sample *pOld
528){
danf00e9022013-08-14 19:54:12 +0000529 tRowcnt nEqNew = pNew->anEq[pNew->iCol];
530 tRowcnt nEqOld = pOld->anEq[pOld->iCol];
531
532 assert( pOld->isPSample==0 && pNew->isPSample==0 );
533 assert( IsStat4 || (pNew->iCol==0 && pOld->iCol==0) );
534
danb13af4c2013-09-03 14:43:12 +0000535 if( (nEqNew>nEqOld) ) return 1;
536#ifdef SQLITE_ENABLE_STAT4
537 if( nEqNew==nEqOld ){
538 if( pNew->iCol<pOld->iCol ) return 1;
539 return (pNew->iCol==pOld->iCol && sampleIsBetterPost(pAccum, pNew, pOld));
danf00e9022013-08-14 19:54:12 +0000540 }
541 return 0;
danb13af4c2013-09-03 14:43:12 +0000542#else
543 return (nEqNew==nEqOld && pNew->iHash>pOld->iHash);
544#endif
danf00e9022013-08-14 19:54:12 +0000545}
drhade3add2011-08-13 00:58:05 +0000546
547/*
danf00e9022013-08-14 19:54:12 +0000548** Copy the contents of sample *pNew into the p->a[] array. If necessary,
549** remove the least desirable sample from p->a[] to make room.
550*/
551static void sampleInsert(Stat4Accum *p, Stat4Sample *pNew, int nEqZero){
drhd2694612013-11-04 22:04:17 +0000552 Stat4Sample *pSample = 0;
danf52bb8d2013-08-03 20:24:58 +0000553 int i;
danf52bb8d2013-08-03 20:24:58 +0000554
danf00e9022013-08-14 19:54:12 +0000555 assert( IsStat4 || nEqZero==0 );
danf52bb8d2013-08-03 20:24:58 +0000556
drh30f07042013-09-04 02:07:38 +0000557#ifdef SQLITE_ENABLE_STAT4
danbd1d2702017-02-22 19:27:51 +0000558 /* Stat4Accum.nMaxEqZero is set to the maximum number of leading 0
559 ** values in the anEq[] array of any sample in Stat4Accum.a[]. In
560 ** other words, if nMaxEqZero is n, then it is guaranteed that there
561 ** are no samples with Stat4Sample.anEq[m]==0 for (m>=n). */
danbd1d2702017-02-22 19:27:51 +0000562 if( nEqZero>p->nMaxEqZero ){
563 p->nMaxEqZero = nEqZero;
564 }
danf00e9022013-08-14 19:54:12 +0000565 if( pNew->isPSample==0 ){
dan1f616ad2013-08-15 14:39:09 +0000566 Stat4Sample *pUpgrade = 0;
danf00e9022013-08-14 19:54:12 +0000567 assert( pNew->anEq[pNew->iCol]>0 );
drhade3add2011-08-13 00:58:05 +0000568
danf00e9022013-08-14 19:54:12 +0000569 /* This sample is being added because the prefix that ends in column
570 ** iCol occurs many times in the table. However, if we have already
571 ** added a sample that shares this prefix, there is no need to add
dan1f616ad2013-08-15 14:39:09 +0000572 ** this one. Instead, upgrade the priority of the highest priority
573 ** existing sample that shares this prefix. */
danf00e9022013-08-14 19:54:12 +0000574 for(i=p->nSample-1; i>=0; i--){
575 Stat4Sample *pOld = &p->a[i];
576 if( pOld->anEq[pNew->iCol]==0 ){
dan1f616ad2013-08-15 14:39:09 +0000577 if( pOld->isPSample ) return;
danb13af4c2013-09-03 14:43:12 +0000578 assert( pOld->iCol>pNew->iCol );
579 assert( sampleIsBetter(p, pNew, pOld) );
580 if( pUpgrade==0 || sampleIsBetter(p, pOld, pUpgrade) ){
dan1f616ad2013-08-15 14:39:09 +0000581 pUpgrade = pOld;
danf00e9022013-08-14 19:54:12 +0000582 }
dan1f28ead2013-08-07 16:15:32 +0000583 }
584 }
dan1f616ad2013-08-15 14:39:09 +0000585 if( pUpgrade ){
586 pUpgrade->iCol = pNew->iCol;
587 pUpgrade->anEq[pUpgrade->iCol] = pNew->anEq[pUpgrade->iCol];
588 goto find_new_min;
589 }
drhade3add2011-08-13 00:58:05 +0000590 }
drh30f07042013-09-04 02:07:38 +0000591#endif
danf52bb8d2013-08-03 20:24:58 +0000592
danf00e9022013-08-14 19:54:12 +0000593 /* If necessary, remove sample iMin to make room for the new sample. */
594 if( p->nSample>=p->mxSample ){
595 Stat4Sample *pMin = &p->a[p->iMin];
danc55521a2013-08-05 05:34:30 +0000596 tRowcnt *anEq = pMin->anEq;
danc55521a2013-08-05 05:34:30 +0000597 tRowcnt *anLt = pMin->anLt;
danf00e9022013-08-14 19:54:12 +0000598 tRowcnt *anDLt = pMin->anDLt;
drhda475b82013-11-04 21:44:54 +0000599 sampleClear(p->db, pMin);
danf00e9022013-08-14 19:54:12 +0000600 memmove(pMin, &pMin[1], sizeof(p->a[0])*(p->nSample-p->iMin-1));
drhf404c862011-08-13 15:25:10 +0000601 pSample = &p->a[p->nSample-1];
drhd2694612013-11-04 22:04:17 +0000602 pSample->nRowid = 0;
danc55521a2013-08-05 05:34:30 +0000603 pSample->anEq = anEq;
604 pSample->anDLt = anDLt;
605 pSample->anLt = anLt;
danf00e9022013-08-14 19:54:12 +0000606 p->nSample = p->mxSample-1;
dan8ad169a2013-08-12 20:14:04 +0000607 }
drhade3add2011-08-13 00:58:05 +0000608
danb49d1042013-09-02 18:58:11 +0000609 /* The "rows less-than" for the rowid column must be greater than that
610 ** for the last sample in the p->a[] array. Otherwise, the samples would
611 ** be out of order. */
612#ifdef SQLITE_ENABLE_STAT4
613 assert( p->nSample==0
614 || pNew->anLt[p->nCol-1] > p->a[p->nSample-1].anLt[p->nCol-1] );
615#endif
616
617 /* Insert the new sample */
618 pSample = &p->a[p->nSample];
619 sampleCopy(p, pSample, pNew);
620 p->nSample++;
621
danf00e9022013-08-14 19:54:12 +0000622 /* Zero the first nEqZero entries in the anEq[] array. */
623 memset(pSample->anEq, 0, sizeof(tRowcnt)*nEqZero);
624
mistachkinc2cfb512013-09-04 04:04:08 +0000625#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000626 find_new_min:
mistachkinc2cfb512013-09-04 04:04:08 +0000627#endif
danf00e9022013-08-14 19:54:12 +0000628 if( p->nSample>=p->mxSample ){
629 int iMin = -1;
danf52bb8d2013-08-03 20:24:58 +0000630 for(i=0; i<p->mxSample; i++){
631 if( p->a[i].isPSample ) continue;
danb13af4c2013-09-03 14:43:12 +0000632 if( iMin<0 || sampleIsBetter(p, &p->a[iMin], &p->a[i]) ){
drhade3add2011-08-13 00:58:05 +0000633 iMin = i;
drhade3add2011-08-13 00:58:05 +0000634 }
635 }
danf52bb8d2013-08-03 20:24:58 +0000636 assert( iMin>=0 );
drhade3add2011-08-13 00:58:05 +0000637 p->iMin = iMin;
638 }
639}
drh1435a9a2013-08-27 23:15:44 +0000640#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
danf00e9022013-08-14 19:54:12 +0000641
642/*
643** Field iChng of the index being scanned has changed. So at this point
644** p->current contains a sample that reflects the previous row of the
645** index. The value of anEq[iChng] and subsequent anEq[] elements are
646** correct at this point.
647*/
648static void samplePushPrevious(Stat4Accum *p, int iChng){
drh92707ac2013-08-17 18:57:15 +0000649#ifdef SQLITE_ENABLE_STAT4
650 int i;
danf00e9022013-08-14 19:54:12 +0000651
drh92707ac2013-08-17 18:57:15 +0000652 /* Check if any samples from the aBest[] array should be pushed
653 ** into IndexSample.a[] at this point. */
654 for(i=(p->nCol-2); i>=iChng; i--){
655 Stat4Sample *pBest = &p->aBest[i];
danb13af4c2013-09-03 14:43:12 +0000656 pBest->anEq[i] = p->current.anEq[i];
657 if( p->nSample<p->mxSample || sampleIsBetter(p, pBest, &p->a[p->iMin]) ){
drh92707ac2013-08-17 18:57:15 +0000658 sampleInsert(p, pBest, i);
danf00e9022013-08-14 19:54:12 +0000659 }
660 }
661
danbd1d2702017-02-22 19:27:51 +0000662 /* Check that no sample contains an anEq[] entry with an index of
663 ** p->nMaxEqZero or greater set to zero. */
drh92707ac2013-08-17 18:57:15 +0000664 for(i=p->nSample-1; i>=0; i--){
665 int j;
danbd1d2702017-02-22 19:27:51 +0000666 for(j=p->nMaxEqZero; j<p->nCol; j++) assert( p->a[i].anEq[j]>0 );
667 }
668
669 /* Update the anEq[] fields of any samples already collected. */
670 if( iChng<p->nMaxEqZero ){
671 for(i=p->nSample-1; i>=0; i--){
672 int j;
673 for(j=iChng; j<p->nCol; j++){
674 if( p->a[i].anEq[j]==0 ) p->a[i].anEq[j] = p->current.anEq[j];
675 }
drh92707ac2013-08-17 18:57:15 +0000676 }
danbd1d2702017-02-22 19:27:51 +0000677 p->nMaxEqZero = iChng;
drh92707ac2013-08-17 18:57:15 +0000678 }
679#endif
680
681#if defined(SQLITE_ENABLE_STAT3) && !defined(SQLITE_ENABLE_STAT4)
682 if( iChng==0 ){
danf00e9022013-08-14 19:54:12 +0000683 tRowcnt nLt = p->current.anLt[0];
684 tRowcnt nEq = p->current.anEq[0];
685
686 /* Check if this is to be a periodic sample. If so, add it. */
687 if( (nLt/p->nPSample)!=(nLt+nEq)/p->nPSample ){
688 p->current.isPSample = 1;
689 sampleInsert(p, &p->current, 0);
690 p->current.isPSample = 0;
691 }else
692
693 /* Or if it is a non-periodic sample. Add it in this case too. */
danb13af4c2013-09-03 14:43:12 +0000694 if( p->nSample<p->mxSample
695 || sampleIsBetter(p, &p->current, &p->a[p->iMin])
696 ){
danf00e9022013-08-14 19:54:12 +0000697 sampleInsert(p, &p->current, 0);
698 }
699 }
drh92707ac2013-08-17 18:57:15 +0000700#endif
drh4f991892013-10-11 15:05:05 +0000701
702#ifndef SQLITE_ENABLE_STAT3_OR_STAT4
703 UNUSED_PARAMETER( p );
704 UNUSED_PARAMETER( iChng );
705#endif
danf00e9022013-08-14 19:54:12 +0000706}
707
708/*
drhebe25af2013-11-02 18:46:04 +0000709** Implementation of the stat_push SQL function: stat_push(P,C,R)
drh9fecc542013-08-27 20:16:48 +0000710** Arguments:
danf00e9022013-08-14 19:54:12 +0000711**
drh9fecc542013-08-27 20:16:48 +0000712** P Pointer to the Stat4Accum object created by stat_init()
713** C Index of left-most column to differ from previous row
drhebe25af2013-11-02 18:46:04 +0000714** R Rowid for the current row. Might be a key record for
715** WITHOUT ROWID tables.
danf00e9022013-08-14 19:54:12 +0000716**
drh553818a2014-07-23 18:36:55 +0000717** This SQL function always returns NULL. It's purpose it to accumulate
718** statistical data and/or samples in the Stat4Accum object about the
719** index being analyzed. The stat_get() SQL function will later be used to
720** extract relevant information for constructing the sqlite_statN tables.
drh9fecc542013-08-27 20:16:48 +0000721**
drhebe25af2013-11-02 18:46:04 +0000722** The R parameter is only used for STAT3 and STAT4
danf00e9022013-08-14 19:54:12 +0000723*/
724static void statPush(
725 sqlite3_context *context,
726 int argc,
727 sqlite3_value **argv
728){
729 int i;
730
731 /* The three function arguments */
732 Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
drh9fecc542013-08-27 20:16:48 +0000733 int iChng = sqlite3_value_int(argv[1]);
danf00e9022013-08-14 19:54:12 +0000734
drh4f991892013-10-11 15:05:05 +0000735 UNUSED_PARAMETER( argc );
736 UNUSED_PARAMETER( context );
drhec9e55d2014-06-30 17:07:39 +0000737 assert( p->nCol>0 );
danf00e9022013-08-14 19:54:12 +0000738 assert( iChng<p->nCol );
739
drh9fecc542013-08-27 20:16:48 +0000740 if( p->nRow==0 ){
danb49d1042013-09-02 18:58:11 +0000741 /* This is the first call to this function. Do initialization. */
drh9fecc542013-08-27 20:16:48 +0000742 for(i=0; i<p->nCol; i++) p->current.anEq[i] = 1;
743 }else{
744 /* Second and subsequent calls get processed here */
danf00e9022013-08-14 19:54:12 +0000745 samplePushPrevious(p, iChng);
746
747 /* Update anDLt[], anLt[] and anEq[] to reflect the values that apply
748 ** to the current row of the index. */
749 for(i=0; i<iChng; i++){
750 p->current.anEq[i]++;
751 }
752 for(i=iChng; i<p->nCol; i++){
753 p->current.anDLt[i]++;
drh1435a9a2013-08-27 23:15:44 +0000754#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
danf00e9022013-08-14 19:54:12 +0000755 p->current.anLt[i] += p->current.anEq[i];
drh9fecc542013-08-27 20:16:48 +0000756#endif
danf00e9022013-08-14 19:54:12 +0000757 p->current.anEq[i] = 1;
758 }
danf00e9022013-08-14 19:54:12 +0000759 }
drh9fecc542013-08-27 20:16:48 +0000760 p->nRow++;
drh1435a9a2013-08-27 23:15:44 +0000761#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhebe25af2013-11-02 18:46:04 +0000762 if( sqlite3_value_type(argv[2])==SQLITE_INTEGER ){
drhda475b82013-11-04 21:44:54 +0000763 sampleSetRowidInt64(p->db, &p->current, sqlite3_value_int64(argv[2]));
drhebe25af2013-11-02 18:46:04 +0000764 }else{
drhda475b82013-11-04 21:44:54 +0000765 sampleSetRowid(p->db, &p->current, sqlite3_value_bytes(argv[2]),
766 sqlite3_value_blob(argv[2]));
drhebe25af2013-11-02 18:46:04 +0000767 }
drh9fecc542013-08-27 20:16:48 +0000768 p->current.iHash = p->iPrn = p->iPrn*1103515245 + 12345;
769#endif
danf00e9022013-08-14 19:54:12 +0000770
drh92707ac2013-08-17 18:57:15 +0000771#ifdef SQLITE_ENABLE_STAT4
772 {
danf00e9022013-08-14 19:54:12 +0000773 tRowcnt nLt = p->current.anLt[p->nCol-1];
774
775 /* Check if this is to be a periodic sample. If so, add it. */
776 if( (nLt/p->nPSample)!=(nLt+1)/p->nPSample ){
777 p->current.isPSample = 1;
778 p->current.iCol = 0;
779 sampleInsert(p, &p->current, p->nCol-1);
780 p->current.isPSample = 0;
781 }
782
783 /* Update the aBest[] array. */
784 for(i=0; i<(p->nCol-1); i++){
785 p->current.iCol = i;
danb13af4c2013-09-03 14:43:12 +0000786 if( i>=iChng || sampleIsBetterPost(p, &p->current, &p->aBest[i]) ){
danf00e9022013-08-14 19:54:12 +0000787 sampleCopy(p, &p->aBest[i], &p->current);
788 }
789 }
790 }
drh92707ac2013-08-17 18:57:15 +0000791#endif
danf00e9022013-08-14 19:54:12 +0000792}
793static const FuncDef statPushFuncdef = {
drh9fecc542013-08-27 20:16:48 +0000794 2+IsStat34, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000795 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000796 0, /* pUserData */
797 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000798 statPush, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000799 0, /* xFinalize */
800 "stat_push", /* zName */
drh80738d92016-02-15 00:34:16 +0000801 {0}
drhade3add2011-08-13 00:58:05 +0000802};
803
danf00e9022013-08-14 19:54:12 +0000804#define STAT_GET_STAT1 0 /* "stat" column of stat1 table */
805#define STAT_GET_ROWID 1 /* "rowid" column of stat[34] entry */
806#define STAT_GET_NEQ 2 /* "neq" column of stat[34] entry */
807#define STAT_GET_NLT 3 /* "nlt" column of stat[34] entry */
808#define STAT_GET_NDLT 4 /* "ndlt" column of stat[34] entry */
809
drhade3add2011-08-13 00:58:05 +0000810/*
drh92707ac2013-08-17 18:57:15 +0000811** Implementation of the stat_get(P,J) SQL function. This routine is
drh553818a2014-07-23 18:36:55 +0000812** used to query statistical information that has been gathered into
813** the Stat4Accum object by prior calls to stat_push(). The P parameter
drhf8ede572014-09-01 23:06:44 +0000814** has type BLOB but it is really just a pointer to the Stat4Accum object.
drh553818a2014-07-23 18:36:55 +0000815** The content to returned is determined by the parameter J
drh92707ac2013-08-17 18:57:15 +0000816** which is one of the STAT_GET_xxxx values defined above.
drhade3add2011-08-13 00:58:05 +0000817**
drh35497fc2017-02-01 01:34:15 +0000818** The stat_get(P,J) function is not available to generic SQL. It is
819** inserted as part of a manually constructed bytecode program. (See
820** the callStatGet() routine below.) It is guaranteed that the P
821** parameter will always be a poiner to a Stat4Accum object, never a
822** NULL.
823**
drh92707ac2013-08-17 18:57:15 +0000824** If neither STAT3 nor STAT4 are enabled, then J is always
825** STAT_GET_STAT1 and is hence omitted and this routine becomes
826** a one-parameter function, stat_get(P), that always returns the
827** stat1 table entry information.
drhade3add2011-08-13 00:58:05 +0000828*/
danf00e9022013-08-14 19:54:12 +0000829static void statGet(
drhade3add2011-08-13 00:58:05 +0000830 sqlite3_context *context,
831 int argc,
832 sqlite3_value **argv
833){
danf52bb8d2013-08-03 20:24:58 +0000834 Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
drh1435a9a2013-08-27 23:15:44 +0000835#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh92707ac2013-08-17 18:57:15 +0000836 /* STAT3 and STAT4 have a parameter on this routine. */
danf00e9022013-08-14 19:54:12 +0000837 int eCall = sqlite3_value_int(argv[1]);
drh92707ac2013-08-17 18:57:15 +0000838 assert( argc==2 );
danf00e9022013-08-14 19:54:12 +0000839 assert( eCall==STAT_GET_STAT1 || eCall==STAT_GET_NEQ
840 || eCall==STAT_GET_ROWID || eCall==STAT_GET_NLT
841 || eCall==STAT_GET_NDLT
842 );
drh92707ac2013-08-17 18:57:15 +0000843 if( eCall==STAT_GET_STAT1 )
844#else
845 assert( argc==1 );
846#endif
847 {
danf00e9022013-08-14 19:54:12 +0000848 /* Return the value to store in the "stat" column of the sqlite_stat1
849 ** table for this index.
850 **
851 ** The value is a string composed of a list of integers describing
852 ** the index. The first integer in the list is the total number of
853 ** entries in the index. There is one additional integer in the list
854 ** for each indexed column. This additional integer is an estimate of
855 ** the number of rows matched by a stabbing query on the index using
856 ** a key with the corresponding number of fields. In other words,
857 ** if the index is on columns (a,b) and the sqlite_stat1 value is
858 ** "100 10 2", then SQLite estimates that:
859 **
860 ** * the index contains 100 rows,
861 ** * "WHERE a=?" matches 10 rows, and
862 ** * "WHERE a=? AND b=?" matches 2 rows.
863 **
864 ** If D is the count of distinct values and K is the total number of
865 ** rows, then each estimate is computed as:
866 **
867 ** I = (K+D-1)/D
868 */
869 char *z;
870 int i;
871
drhec9e55d2014-06-30 17:07:39 +0000872 char *zRet = sqlite3MallocZero( (p->nKeyCol+1)*25 );
danf00e9022013-08-14 19:54:12 +0000873 if( zRet==0 ){
874 sqlite3_result_error_nomem(context);
875 return;
876 }
877
drh26586e72013-10-09 19:07:22 +0000878 sqlite3_snprintf(24, zRet, "%llu", (u64)p->nRow);
danf00e9022013-08-14 19:54:12 +0000879 z = zRet + sqlite3Strlen30(zRet);
drhec9e55d2014-06-30 17:07:39 +0000880 for(i=0; i<p->nKeyCol; i++){
drh26586e72013-10-09 19:07:22 +0000881 u64 nDistinct = p->current.anDLt[i] + 1;
882 u64 iVal = (p->nRow + nDistinct - 1) / nDistinct;
883 sqlite3_snprintf(24, z, " %llu", iVal);
danf00e9022013-08-14 19:54:12 +0000884 z += sqlite3Strlen30(z);
885 assert( p->current.anEq[i] );
886 }
887 assert( z[0]=='\0' && z>zRet );
888
889 sqlite3_result_text(context, zRet, -1, sqlite3_free);
drh92707ac2013-08-17 18:57:15 +0000890 }
drh1435a9a2013-08-27 23:15:44 +0000891#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh92707ac2013-08-17 18:57:15 +0000892 else if( eCall==STAT_GET_ROWID ){
danf00e9022013-08-14 19:54:12 +0000893 if( p->iGet<0 ){
894 samplePushPrevious(p, 0);
895 p->iGet = 0;
896 }
897 if( p->iGet<p->nSample ){
drhebe25af2013-11-02 18:46:04 +0000898 Stat4Sample *pS = p->a + p->iGet;
899 if( pS->nRowid==0 ){
drhda475b82013-11-04 21:44:54 +0000900 sqlite3_result_int64(context, pS->u.iRowid);
drhebe25af2013-11-02 18:46:04 +0000901 }else{
drhda475b82013-11-04 21:44:54 +0000902 sqlite3_result_blob(context, pS->u.aRowid, pS->nRowid,
903 SQLITE_TRANSIENT);
drhebe25af2013-11-02 18:46:04 +0000904 }
danf00e9022013-08-14 19:54:12 +0000905 }
906 }else{
danf52bb8d2013-08-03 20:24:58 +0000907 tRowcnt *aCnt = 0;
danf00e9022013-08-14 19:54:12 +0000908
909 assert( p->iGet<p->nSample );
910 switch( eCall ){
911 case STAT_GET_NEQ: aCnt = p->a[p->iGet].anEq; break;
912 case STAT_GET_NLT: aCnt = p->a[p->iGet].anLt; break;
913 default: {
914 aCnt = p->a[p->iGet].anDLt;
915 p->iGet++;
916 break;
917 }
danf52bb8d2013-08-03 20:24:58 +0000918 }
919
dan8ad169a2013-08-12 20:14:04 +0000920 if( IsStat3 ){
921 sqlite3_result_int64(context, (i64)aCnt[0]);
danf52bb8d2013-08-03 20:24:58 +0000922 }else{
danf00e9022013-08-14 19:54:12 +0000923 char *zRet = sqlite3MallocZero(p->nCol * 25);
dan8ad169a2013-08-12 20:14:04 +0000924 if( zRet==0 ){
925 sqlite3_result_error_nomem(context);
926 }else{
927 int i;
928 char *z = zRet;
929 for(i=0; i<p->nCol; i++){
drh26586e72013-10-09 19:07:22 +0000930 sqlite3_snprintf(24, z, "%llu ", (u64)aCnt[i]);
dan8ad169a2013-08-12 20:14:04 +0000931 z += sqlite3Strlen30(z);
932 }
933 assert( z[0]=='\0' && z>zRet );
934 z[-1] = '\0';
935 sqlite3_result_text(context, zRet, -1, sqlite3_free);
danf52bb8d2013-08-03 20:24:58 +0000936 }
danf52bb8d2013-08-03 20:24:58 +0000937 }
drhade3add2011-08-13 00:58:05 +0000938 }
drh1435a9a2013-08-27 23:15:44 +0000939#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drh4f991892013-10-11 15:05:05 +0000940#ifndef SQLITE_DEBUG
941 UNUSED_PARAMETER( argc );
942#endif
drhade3add2011-08-13 00:58:05 +0000943}
danf00e9022013-08-14 19:54:12 +0000944static const FuncDef statGetFuncdef = {
drh9fecc542013-08-27 20:16:48 +0000945 1+IsStat34, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000946 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000947 0, /* pUserData */
948 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000949 statGet, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000950 0, /* xFinalize */
951 "stat_get", /* zName */
drh80738d92016-02-15 00:34:16 +0000952 {0}
drhade3add2011-08-13 00:58:05 +0000953};
drhade3add2011-08-13 00:58:05 +0000954
danf00e9022013-08-14 19:54:12 +0000955static void callStatGet(Vdbe *v, int regStat4, int iParam, int regOut){
956 assert( regOut!=regStat4 && regOut!=regStat4+1 );
drh1435a9a2013-08-27 23:15:44 +0000957#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
danf00e9022013-08-14 19:54:12 +0000958 sqlite3VdbeAddOp2(v, OP_Integer, iParam, regStat4+1);
drh4f991892013-10-11 15:05:05 +0000959#elif SQLITE_DEBUG
drh92707ac2013-08-17 18:57:15 +0000960 assert( iParam==STAT_GET_STAT1 );
drh4f991892013-10-11 15:05:05 +0000961#else
962 UNUSED_PARAMETER( iParam );
drh92707ac2013-08-17 18:57:15 +0000963#endif
drh9b34abe2016-01-16 15:12:35 +0000964 sqlite3VdbeAddOp4(v, OP_Function0, 0, regStat4, regOut,
965 (char*)&statGetFuncdef, P4_FUNCDEF);
drh9fecc542013-08-27 20:16:48 +0000966 sqlite3VdbeChangeP5(v, 1 + IsStat34);
danf00e9022013-08-14 19:54:12 +0000967}
drhade3add2011-08-13 00:58:05 +0000968
969/*
drhff2d5ea2005-07-23 00:41:48 +0000970** Generate code to do an analysis of all indices associated with
971** a single table.
972*/
973static void analyzeOneTable(
974 Parse *pParse, /* Parser context */
975 Table *pTab, /* Table whose indices are to be analyzed */
drha071bc52011-03-31 02:03:28 +0000976 Index *pOnlyIdx, /* If not NULL, only analyze this one index */
drhdfe88ec2008-11-03 20:55:06 +0000977 int iStatCur, /* Index of VdbeCursor that writes the sqlite_stat1 table */
danc6129702013-08-05 19:04:07 +0000978 int iMem, /* Available memory locations begin here */
drh4a54bb52017-02-18 15:58:52 +0000979 int iTab /* Next available cursor */
drhff2d5ea2005-07-23 00:41:48 +0000980){
dan0f9a34e2009-08-19 16:34:31 +0000981 sqlite3 *db = pParse->db; /* Database handle */
dan69188d92009-08-19 08:18:32 +0000982 Index *pIdx; /* An index to being analyzed */
983 int iIdxCur; /* Cursor open on index being analyzed */
danc6129702013-08-05 19:04:07 +0000984 int iTabCur; /* Table cursor */
dan69188d92009-08-19 08:18:32 +0000985 Vdbe *v; /* The virtual machine being built up */
986 int i; /* Loop counter */
drhf6cf1ff2011-03-30 14:54:05 +0000987 int jZeroRows = -1; /* Jump from here if number of rows is zero */
dan69188d92009-08-19 08:18:32 +0000988 int iDb; /* Index of database containing pTab */
drh721dfcf2013-08-01 04:39:17 +0000989 u8 needTableCnt = 1; /* True to count the table */
danf00e9022013-08-14 19:54:12 +0000990 int regNewRowid = iMem++; /* Rowid for the inserted record */
991 int regStat4 = iMem++; /* Register to hold Stat4Accum object */
danf00e9022013-08-14 19:54:12 +0000992 int regChng = iMem++; /* Index of changed index field */
drh1435a9a2013-08-27 23:15:44 +0000993#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000994 int regRowid = iMem++; /* Rowid argument passed to stat_push() */
995#endif
danf00e9022013-08-14 19:54:12 +0000996 int regTemp = iMem++; /* Temporary use register */
dane275dc32009-08-18 16:24:58 +0000997 int regTabname = iMem++; /* Register containing table name */
998 int regIdxname = iMem++; /* Register containing index name */
danf00e9022013-08-14 19:54:12 +0000999 int regStat1 = iMem++; /* Value for the stat column of sqlite_stat1 */
1000 int regPrev = iMem; /* MUST BE LAST (see below) */
dan68c4dbb2009-08-20 09:11:06 +00001001
drhf0459fc2013-08-15 16:15:00 +00001002 pParse->nMem = MAX(pParse->nMem, iMem);
drhff2d5ea2005-07-23 00:41:48 +00001003 v = sqlite3GetVdbe(pParse);
drh15564052010-09-25 22:32:56 +00001004 if( v==0 || NEVER(pTab==0) ){
1005 return;
1006 }
drhf39d29c2010-09-28 17:34:46 +00001007 if( pTab->tnum==0 ){
1008 /* Do not gather statistics on views or virtual tables */
drh15564052010-09-25 22:32:56 +00001009 return;
1010 }
drh8b4a94a2015-11-24 21:23:59 +00001011 if( sqlite3_strlike("sqlite_%", pTab->zName, 0)==0 ){
drh15564052010-09-25 22:32:56 +00001012 /* Do not gather statistics on system tables */
drhff2d5ea2005-07-23 00:41:48 +00001013 return;
1014 }
dan0f9a34e2009-08-19 16:34:31 +00001015 assert( sqlite3BtreeHoldsAllMutexes(db) );
1016 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
danielk1977da184232006-01-05 11:34:32 +00001017 assert( iDb>=0 );
drh21206082011-04-04 18:22:02 +00001018 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drhe6e04962005-07-23 02:17:03 +00001019#ifndef SQLITE_OMIT_AUTHORIZATION
1020 if( sqlite3AuthCheck(pParse, SQLITE_ANALYZE, pTab->zName, 0,
drh69c33822016-08-18 14:33:11 +00001021 db->aDb[iDb].zDbSName ) ){
drhe6e04962005-07-23 02:17:03 +00001022 return;
1023 }
1024#endif
1025
dane0432012013-08-05 18:00:56 +00001026 /* Establish a read-lock on the table at the shared-cache level.
danf00e9022013-08-14 19:54:12 +00001027 ** Open a read-only cursor on the table. Also allocate a cursor number
1028 ** to use for scanning indexes (iIdxCur). No index cursor is opened at
1029 ** this time though. */
danielk1977c00da102006-01-07 13:21:04 +00001030 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danc6129702013-08-05 19:04:07 +00001031 iTabCur = iTab++;
danf00e9022013-08-14 19:54:12 +00001032 iIdxCur = iTab++;
danc6129702013-08-05 19:04:07 +00001033 pParse->nTab = MAX(pParse->nTab, iTab);
dane0432012013-08-05 18:00:56 +00001034 sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
drh076e85f2015-09-03 13:46:12 +00001035 sqlite3VdbeLoadString(v, regTabname, pTab->zName);
dane0432012013-08-05 18:00:56 +00001036
drhff2d5ea2005-07-23 00:41:48 +00001037 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
drh553818a2014-07-23 18:36:55 +00001038 int nCol; /* Number of columns in pIdx. "N" */
danf00e9022013-08-14 19:54:12 +00001039 int addrRewind; /* Address of "OP_Rewind iIdxCur" */
danf00e9022013-08-14 19:54:12 +00001040 int addrNextRow; /* Address of "next_row:" */
drhce95d112013-11-02 19:34:38 +00001041 const char *zIdxName; /* Name of the index */
drh553818a2014-07-23 18:36:55 +00001042 int nColTest; /* Number of columns to test for changes */
danielk1977b3bf5562006-01-10 17:58:23 +00001043
drha071bc52011-03-31 02:03:28 +00001044 if( pOnlyIdx && pOnlyIdx!=pIdx ) continue;
drh721dfcf2013-08-01 04:39:17 +00001045 if( pIdx->pPartIdxWhere==0 ) needTableCnt = 0;
drhec9e55d2014-06-30 17:07:39 +00001046 if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIdx) ){
1047 nCol = pIdx->nKeyCol;
1048 zIdxName = pTab->zName;
drh553818a2014-07-23 18:36:55 +00001049 nColTest = nCol - 1;
drhec9e55d2014-06-30 17:07:39 +00001050 }else{
1051 nCol = pIdx->nColumn;
1052 zIdxName = pIdx->zName;
drh6861b8a2014-07-23 19:37:21 +00001053 nColTest = pIdx->uniqNotNull ? pIdx->nKeyCol-1 : nCol-1;
drhec9e55d2014-06-30 17:07:39 +00001054 }
dane275dc32009-08-18 16:24:58 +00001055
drh15564052010-09-25 22:32:56 +00001056 /* Populate the register containing the index name. */
drh076e85f2015-09-03 13:46:12 +00001057 sqlite3VdbeLoadString(v, regIdxname, zIdxName);
drhec9e55d2014-06-30 17:07:39 +00001058 VdbeComment((v, "Analysis for %s.%s", pTab->zName, zIdxName));
dan69188d92009-08-19 08:18:32 +00001059
dane0432012013-08-05 18:00:56 +00001060 /*
danf00e9022013-08-14 19:54:12 +00001061 ** Pseudo-code for loop that calls stat_push():
dane0432012013-08-05 18:00:56 +00001062 **
danf00e9022013-08-14 19:54:12 +00001063 ** Rewind csr
1064 ** if eof(csr) goto end_of_scan;
1065 ** regChng = 0
1066 ** goto chng_addr_0;
dane0432012013-08-05 18:00:56 +00001067 **
dandd6e1f12013-08-10 19:08:30 +00001068 ** next_row:
danf00e9022013-08-14 19:54:12 +00001069 ** regChng = 0
1070 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1071 ** regChng = 1
1072 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1073 ** ...
1074 ** regChng = N
1075 ** goto chng_addr_N
dane0432012013-08-05 18:00:56 +00001076 **
danf00e9022013-08-14 19:54:12 +00001077 ** chng_addr_0:
1078 ** regPrev(0) = idx(0)
1079 ** chng_addr_1:
1080 ** regPrev(1) = idx(1)
1081 ** ...
dane0432012013-08-05 18:00:56 +00001082 **
drh9d793322014-07-24 19:54:20 +00001083 ** endDistinctTest:
danf00e9022013-08-14 19:54:12 +00001084 ** regRowid = idx(rowid)
drh9fecc542013-08-27 20:16:48 +00001085 ** stat_push(P, regChng, regRowid)
danf00e9022013-08-14 19:54:12 +00001086 ** Next csr
1087 ** if !eof(csr) goto next_row;
dane0432012013-08-05 18:00:56 +00001088 **
danf00e9022013-08-14 19:54:12 +00001089 ** end_of_scan:
dane0432012013-08-05 18:00:56 +00001090 */
danf00e9022013-08-14 19:54:12 +00001091
1092 /* Make sure there are enough memory cells allocated to accommodate
1093 ** the regPrev array and a trailing rowid (the rowid slot is required
1094 ** when building a record to insert into the sample column of
1095 ** the sqlite_stat4 table. */
drh553818a2014-07-23 18:36:55 +00001096 pParse->nMem = MAX(pParse->nMem, regPrev+nColTest);
dan02fa4692009-08-17 17:06:58 +00001097
danf00e9022013-08-14 19:54:12 +00001098 /* Open a read-only cursor on the index being analyzed. */
dane0432012013-08-05 18:00:56 +00001099 assert( iDb==sqlite3SchemaToIndex(db, pIdx->pSchema) );
danf00e9022013-08-14 19:54:12 +00001100 sqlite3VdbeAddOp3(v, OP_OpenRead, iIdxCur, pIdx->tnum, iDb);
drh2ec2fb22013-11-06 19:59:23 +00001101 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
danf00e9022013-08-14 19:54:12 +00001102 VdbeComment((v, "%s", pIdx->zName));
dane0432012013-08-05 18:00:56 +00001103
danf00e9022013-08-14 19:54:12 +00001104 /* Invoke the stat_init() function. The arguments are:
danf52bb8d2013-08-03 20:24:58 +00001105 **
drh553818a2014-07-23 18:36:55 +00001106 ** (1) the number of columns in the index including the rowid
1107 ** (or for a WITHOUT ROWID table, the number of PK columns),
1108 ** (2) the number of columns in the key without the rowid/pk
1109 ** (3) the number of rows in the index,
drh9fecc542013-08-27 20:16:48 +00001110 **
drh553818a2014-07-23 18:36:55 +00001111 **
1112 ** The third argument is only used for STAT3 and STAT4
danf52bb8d2013-08-03 20:24:58 +00001113 */
drh1435a9a2013-08-27 23:15:44 +00001114#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhec9e55d2014-06-30 17:07:39 +00001115 sqlite3VdbeAddOp2(v, OP_Count, iIdxCur, regStat4+3);
drh9fecc542013-08-27 20:16:48 +00001116#endif
drhec9e55d2014-06-30 17:07:39 +00001117 sqlite3VdbeAddOp2(v, OP_Integer, nCol, regStat4+1);
1118 sqlite3VdbeAddOp2(v, OP_Integer, pIdx->nKeyCol, regStat4+2);
drh9b34abe2016-01-16 15:12:35 +00001119 sqlite3VdbeAddOp4(v, OP_Function0, 0, regStat4+1, regStat4,
1120 (char*)&statInitFuncdef, P4_FUNCDEF);
drhec9e55d2014-06-30 17:07:39 +00001121 sqlite3VdbeChangeP5(v, 2+IsStat34);
danf52bb8d2013-08-03 20:24:58 +00001122
danf00e9022013-08-14 19:54:12 +00001123 /* Implementation of the following:
1124 **
1125 ** Rewind csr
1126 ** if eof(csr) goto end_of_scan;
1127 ** regChng = 0
1128 ** goto next_push_0;
1129 **
dandd6e1f12013-08-10 19:08:30 +00001130 */
danf00e9022013-08-14 19:54:12 +00001131 addrRewind = sqlite3VdbeAddOp1(v, OP_Rewind, iIdxCur);
drh688852a2014-02-17 22:40:43 +00001132 VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001133 sqlite3VdbeAddOp2(v, OP_Integer, 0, regChng);
danf00e9022013-08-14 19:54:12 +00001134 addrNextRow = sqlite3VdbeCurrentAddr(v);
dane0432012013-08-05 18:00:56 +00001135
drh553818a2014-07-23 18:36:55 +00001136 if( nColTest>0 ){
drh9d793322014-07-24 19:54:20 +00001137 int endDistinctTest = sqlite3VdbeMakeLabel(v);
drhb12879f2014-07-24 20:25:16 +00001138 int *aGotoChng; /* Array of jump instruction addresses */
drh575fad62016-02-05 13:38:36 +00001139 aGotoChng = sqlite3DbMallocRawNN(db, sizeof(int)*nColTest);
drhb12879f2014-07-24 20:25:16 +00001140 if( aGotoChng==0 ) continue;
danf00e9022013-08-14 19:54:12 +00001141
drh553818a2014-07-23 18:36:55 +00001142 /*
1143 ** next_row:
1144 ** regChng = 0
1145 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1146 ** regChng = 1
1147 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1148 ** ...
1149 ** regChng = N
drh9d793322014-07-24 19:54:20 +00001150 ** goto endDistinctTest
drh553818a2014-07-23 18:36:55 +00001151 */
1152 sqlite3VdbeAddOp0(v, OP_Goto);
1153 addrNextRow = sqlite3VdbeCurrentAddr(v);
drh5f1d1d92014-07-31 22:59:04 +00001154 if( nColTest==1 && pIdx->nKeyCol==1 && IsUniqueIndex(pIdx) ){
drh9d793322014-07-24 19:54:20 +00001155 /* For a single-column UNIQUE index, once we have found a non-NULL
1156 ** row, we know that all the rest will be distinct, so skip
1157 ** subsequent distinctness tests. */
1158 sqlite3VdbeAddOp2(v, OP_NotNull, regPrev, endDistinctTest);
1159 VdbeCoverage(v);
1160 }
drh553818a2014-07-23 18:36:55 +00001161 for(i=0; i<nColTest; i++){
1162 char *pColl = (char*)sqlite3LocateCollSeq(pParse, pIdx->azColl[i]);
1163 sqlite3VdbeAddOp2(v, OP_Integer, i, regChng);
1164 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regTemp);
1165 aGotoChng[i] =
1166 sqlite3VdbeAddOp4(v, OP_Ne, regTemp, 0, regPrev+i, pColl, P4_COLLSEQ);
1167 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
1168 VdbeCoverage(v);
1169 }
1170 sqlite3VdbeAddOp2(v, OP_Integer, nColTest, regChng);
drh076e85f2015-09-03 13:46:12 +00001171 sqlite3VdbeGoto(v, endDistinctTest);
drh553818a2014-07-23 18:36:55 +00001172
1173
1174 /*
1175 ** chng_addr_0:
1176 ** regPrev(0) = idx(0)
1177 ** chng_addr_1:
1178 ** regPrev(1) = idx(1)
1179 ** ...
1180 */
1181 sqlite3VdbeJumpHere(v, addrNextRow-1);
1182 for(i=0; i<nColTest; i++){
1183 sqlite3VdbeJumpHere(v, aGotoChng[i]);
1184 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regPrev+i);
1185 }
drh9d793322014-07-24 19:54:20 +00001186 sqlite3VdbeResolveLabel(v, endDistinctTest);
drhb12879f2014-07-24 20:25:16 +00001187 sqlite3DbFree(db, aGotoChng);
drhff2d5ea2005-07-23 00:41:48 +00001188 }
drh553818a2014-07-23 18:36:55 +00001189
danf00e9022013-08-14 19:54:12 +00001190 /*
1191 ** chng_addr_N:
drh9fecc542013-08-27 20:16:48 +00001192 ** regRowid = idx(rowid) // STAT34 only
1193 ** stat_push(P, regChng, regRowid) // 3rd parameter STAT34 only
danf00e9022013-08-14 19:54:12 +00001194 ** Next csr
1195 ** if !eof(csr) goto next_row;
1196 */
drh1435a9a2013-08-27 23:15:44 +00001197#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +00001198 assert( regRowid==(regStat4+2) );
drhebe25af2013-11-02 18:46:04 +00001199 if( HasRowid(pTab) ){
1200 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, regRowid);
1201 }else{
1202 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
1203 int j, k, regKey;
1204 regKey = sqlite3GetTempRange(pParse, pPk->nKeyCol);
1205 for(j=0; j<pPk->nKeyCol; j++){
1206 k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
drh49297c82017-03-21 18:56:52 +00001207 assert( k>=0 && k<pIdx->nColumn );
drhebe25af2013-11-02 18:46:04 +00001208 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, regKey+j);
1209 VdbeComment((v, "%s", pTab->aCol[pPk->aiColumn[j]].zName));
1210 }
1211 sqlite3VdbeAddOp3(v, OP_MakeRecord, regKey, pPk->nKeyCol, regRowid);
1212 sqlite3ReleaseTempRange(pParse, regKey, pPk->nKeyCol);
1213 }
drh9fecc542013-08-27 20:16:48 +00001214#endif
1215 assert( regChng==(regStat4+1) );
drh9b34abe2016-01-16 15:12:35 +00001216 sqlite3VdbeAddOp4(v, OP_Function0, 1, regStat4, regTemp,
1217 (char*)&statPushFuncdef, P4_FUNCDEF);
drh9fecc542013-08-27 20:16:48 +00001218 sqlite3VdbeChangeP5(v, 2+IsStat34);
drh688852a2014-02-17 22:40:43 +00001219 sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001220
1221 /* Add the entry to the stat1 table. */
1222 callStatGet(v, regStat4, STAT_GET_STAT1, regStat1);
drh4583c372014-09-19 20:13:25 +00001223 assert( "BBB"[0]==SQLITE_AFF_TEXT );
1224 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
drhade3add2011-08-13 00:58:05 +00001225 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
danf00e9022013-08-14 19:54:12 +00001226 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
drh2d401ab2008-01-10 23:50:11 +00001227 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
danf00e9022013-08-14 19:54:12 +00001228
1229 /* Add the entries to the stat3 or stat4 table. */
drh1435a9a2013-08-27 23:15:44 +00001230#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +00001231 {
danf00e9022013-08-14 19:54:12 +00001232 int regEq = regStat1;
1233 int regLt = regStat1+1;
1234 int regDLt = regStat1+2;
1235 int regSample = regStat1+3;
1236 int regCol = regStat1+4;
1237 int regSampleRowid = regCol + nCol;
1238 int addrNext;
1239 int addrIsNull;
drhebe25af2013-11-02 18:46:04 +00001240 u8 seekOp = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
danf00e9022013-08-14 19:54:12 +00001241
drhec9e55d2014-06-30 17:07:39 +00001242 pParse->nMem = MAX(pParse->nMem, regCol+nCol);
danf00e9022013-08-14 19:54:12 +00001243
1244 addrNext = sqlite3VdbeCurrentAddr(v);
1245 callStatGet(v, regStat4, STAT_GET_ROWID, regSampleRowid);
1246 addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regSampleRowid);
drh688852a2014-02-17 22:40:43 +00001247 VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001248 callStatGet(v, regStat4, STAT_GET_NEQ, regEq);
1249 callStatGet(v, regStat4, STAT_GET_NLT, regLt);
1250 callStatGet(v, regStat4, STAT_GET_NDLT, regDLt);
drhebe25af2013-11-02 18:46:04 +00001251 sqlite3VdbeAddOp4Int(v, seekOp, iTabCur, addrNext, regSampleRowid, 0);
drhfe705102014-03-06 13:38:37 +00001252 /* We know that the regSampleRowid row exists because it was read by
1253 ** the previous loop. Thus the not-found jump of seekOp will never
1254 ** be taken */
1255 VdbeCoverageNeverTaken(v);
drh9fecc542013-08-27 20:16:48 +00001256#ifdef SQLITE_ENABLE_STAT3
drh1f9ca2c2015-08-25 16:57:52 +00001257 sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, 0, regSample);
drh9fecc542013-08-27 20:16:48 +00001258#else
drhec9e55d2014-06-30 17:07:39 +00001259 for(i=0; i<nCol; i++){
drh1f9ca2c2015-08-25 16:57:52 +00001260 sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, i, regCol+i);
danf00e9022013-08-14 19:54:12 +00001261 }
drhec9e55d2014-06-30 17:07:39 +00001262 sqlite3VdbeAddOp3(v, OP_MakeRecord, regCol, nCol, regSample);
drh9fecc542013-08-27 20:16:48 +00001263#endif
drh57bf4a82014-02-17 14:59:22 +00001264 sqlite3VdbeAddOp3(v, OP_MakeRecord, regTabname, 6, regTemp);
danf00e9022013-08-14 19:54:12 +00001265 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur+1, regNewRowid);
1266 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur+1, regTemp, regNewRowid);
drhfe705102014-03-06 13:38:37 +00001267 sqlite3VdbeAddOp2(v, OP_Goto, 1, addrNext); /* P1==1 for end-of-loop */
danf00e9022013-08-14 19:54:12 +00001268 sqlite3VdbeJumpHere(v, addrIsNull);
1269 }
drh1435a9a2013-08-27 23:15:44 +00001270#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
danf00e9022013-08-14 19:54:12 +00001271
drh9fecc542013-08-27 20:16:48 +00001272 /* End of analysis */
danf00e9022013-08-14 19:54:12 +00001273 sqlite3VdbeJumpHere(v, addrRewind);
drh15564052010-09-25 22:32:56 +00001274 }
1275
danf00e9022013-08-14 19:54:12 +00001276
drh721dfcf2013-08-01 04:39:17 +00001277 /* Create a single sqlite_stat1 entry containing NULL as the index
1278 ** name and the row count as the content.
drh15564052010-09-25 22:32:56 +00001279 */
drh721dfcf2013-08-01 04:39:17 +00001280 if( pOnlyIdx==0 && needTableCnt ){
drh15564052010-09-25 22:32:56 +00001281 VdbeComment((v, "%s", pTab->zName));
dane0432012013-08-05 18:00:56 +00001282 sqlite3VdbeAddOp2(v, OP_Count, iTabCur, regStat1);
drh688852a2014-02-17 22:40:43 +00001283 jZeroRows = sqlite3VdbeAddOp1(v, OP_IfNot, regStat1); VdbeCoverage(v);
drh721dfcf2013-08-01 04:39:17 +00001284 sqlite3VdbeAddOp2(v, OP_Null, 0, regIdxname);
drh4583c372014-09-19 20:13:25 +00001285 assert( "BBB"[0]==SQLITE_AFF_TEXT );
1286 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
drh721dfcf2013-08-01 04:39:17 +00001287 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
danf00e9022013-08-14 19:54:12 +00001288 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
drh721dfcf2013-08-01 04:39:17 +00001289 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
drh15564052010-09-25 22:32:56 +00001290 sqlite3VdbeJumpHere(v, jZeroRows);
1291 }
drhff2d5ea2005-07-23 00:41:48 +00001292}
1293
drh72052a72017-02-17 16:26:34 +00001294
1295/*
drh4a54bb52017-02-18 15:58:52 +00001296** Generate code that will cause the most recent index analysis to
1297** be loaded into internal hash tables where is can be used.
drh72052a72017-02-17 16:26:34 +00001298*/
drh4a54bb52017-02-18 15:58:52 +00001299static void loadAnalysis(Parse *pParse, int iDb){
drh182e84c2017-02-18 02:19:02 +00001300 Vdbe *v = sqlite3GetVdbe(pParse);
drh4a54bb52017-02-18 15:58:52 +00001301 if( v ){
1302 sqlite3VdbeAddOp1(v, OP_LoadAnalysis, iDb);
1303 }
1304}
drhff2d5ea2005-07-23 00:41:48 +00001305
drh4a54bb52017-02-18 15:58:52 +00001306/*
1307** Generate code that will do an analysis of an entire database
1308*/
1309static void analyzeDatabase(Parse *pParse, int iDb){
1310 sqlite3 *db = pParse->db;
1311 Schema *pSchema = db->aDb[iDb].pSchema; /* Schema of database iDb */
1312 HashElem *k;
1313 int iStatCur;
1314 int iMem;
1315 int iTab;
1316
1317 sqlite3BeginWriteOperation(pParse, 0, iDb);
1318 iStatCur = pParse->nTab;
1319 pParse->nTab += 3;
1320 openStatTable(pParse, iDb, iStatCur, 0, 0);
1321 iMem = pParse->nMem+1;
1322 iTab = pParse->nTab;
1323 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1324 for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
1325 Table *pTab = (Table*)sqliteHashData(k);
1326 analyzeOneTable(pParse, pTab, 0, iStatCur, iMem, iTab);
drhff2d5ea2005-07-23 00:41:48 +00001327 }
drh4a54bb52017-02-18 15:58:52 +00001328 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001329}
1330
1331/*
1332** Generate code that will do an analysis of a single table in
drha071bc52011-03-31 02:03:28 +00001333** a database. If pOnlyIdx is not NULL then it is a single index
1334** in pTab that should be analyzed.
drhff2d5ea2005-07-23 00:41:48 +00001335*/
drha071bc52011-03-31 02:03:28 +00001336static void analyzeTable(Parse *pParse, Table *pTab, Index *pOnlyIdx){
drhff2d5ea2005-07-23 00:41:48 +00001337 int iDb;
1338 int iStatCur;
1339
1340 assert( pTab!=0 );
drh1fee73e2007-08-29 04:00:57 +00001341 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
danielk1977da184232006-01-05 11:34:32 +00001342 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drhff2d5ea2005-07-23 00:41:48 +00001343 sqlite3BeginWriteOperation(pParse, 0, iDb);
dan02fa4692009-08-17 17:06:58 +00001344 iStatCur = pParse->nTab;
drhade3add2011-08-13 00:58:05 +00001345 pParse->nTab += 3;
drha071bc52011-03-31 02:03:28 +00001346 if( pOnlyIdx ){
1347 openStatTable(pParse, iDb, iStatCur, pOnlyIdx->zName, "idx");
1348 }else{
1349 openStatTable(pParse, iDb, iStatCur, pTab->zName, "tbl");
1350 }
drh4a54bb52017-02-18 15:58:52 +00001351 analyzeOneTable(pParse, pTab, pOnlyIdx, iStatCur,pParse->nMem+1,pParse->nTab);
1352 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001353}
1354
1355/*
1356** Generate code for the ANALYZE command. The parser calls this routine
1357** when it recognizes an ANALYZE command.
drh9f18e8a2005-07-08 12:13:04 +00001358**
1359** ANALYZE -- 1
drhff2d5ea2005-07-23 00:41:48 +00001360** ANALYZE <database> -- 2
drh9f18e8a2005-07-08 12:13:04 +00001361** ANALYZE ?<database>.?<tablename> -- 3
1362**
1363** Form 1 causes all indices in all attached databases to be analyzed.
1364** Form 2 analyzes all indices the single database named.
1365** Form 3 analyzes all indices associated with the named table.
1366*/
drh182e84c2017-02-18 02:19:02 +00001367void sqlite3Analyze(Parse *pParse, Token *pName1, Token *pName2){
drhff2d5ea2005-07-23 00:41:48 +00001368 sqlite3 *db = pParse->db;
1369 int iDb;
drh4a54bb52017-02-18 15:58:52 +00001370 int i;
drhff2d5ea2005-07-23 00:41:48 +00001371 char *z, *zDb;
1372 Table *pTab;
drha071bc52011-03-31 02:03:28 +00001373 Index *pIdx;
drhff2d5ea2005-07-23 00:41:48 +00001374 Token *pTableName;
drh4a54bb52017-02-18 15:58:52 +00001375 Vdbe *v;
drhff2d5ea2005-07-23 00:41:48 +00001376
1377 /* Read the database schema. If an error occurs, leave an error message
1378 ** and code in pParse and return NULL. */
drh1fee73e2007-08-29 04:00:57 +00001379 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
drhff2d5ea2005-07-23 00:41:48 +00001380 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
1381 return;
1382 }
1383
drh05800a12009-04-16 17:45:47 +00001384 assert( pName2!=0 || pName1==0 );
drhff2d5ea2005-07-23 00:41:48 +00001385 if( pName1==0 ){
1386 /* Form 1: Analyze everything */
drh4a54bb52017-02-18 15:58:52 +00001387 for(i=0; i<db->nDb; i++){
1388 if( i==1 ) continue; /* Do not analyze the TEMP database */
1389 analyzeDatabase(pParse, i);
1390 }
drhbce04142017-02-23 00:58:36 +00001391 }else if( pName2->n==0 && (iDb = sqlite3FindDb(db, pName1))>=0 ){
1392 /* Analyze the schema named as the argument */
1393 analyzeDatabase(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001394 }else{
drhbce04142017-02-23 00:58:36 +00001395 /* Form 3: Analyze the table or index named as an argument */
drhff2d5ea2005-07-23 00:41:48 +00001396 iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pTableName);
1397 if( iDb>=0 ){
drhbce04142017-02-23 00:58:36 +00001398 zDb = pName2->n ? db->aDb[iDb].zDbSName : 0;
drh17435752007-08-16 04:30:38 +00001399 z = sqlite3NameFromToken(db, pTableName);
drhcf1be452007-05-12 12:08:51 +00001400 if( z ){
drha071bc52011-03-31 02:03:28 +00001401 if( (pIdx = sqlite3FindIndex(db, z, zDb))!=0 ){
1402 analyzeTable(pParse, pIdx->pTable, pIdx);
1403 }else if( (pTab = sqlite3LocateTable(pParse, 0, z, zDb))!=0 ){
1404 analyzeTable(pParse, pTab, 0);
drhcf1be452007-05-12 12:08:51 +00001405 }
drha071bc52011-03-31 02:03:28 +00001406 sqlite3DbFree(db, z);
drhff2d5ea2005-07-23 00:41:48 +00001407 }
drhbce04142017-02-23 00:58:36 +00001408 }
drhff2d5ea2005-07-23 00:41:48 +00001409 }
drhbce04142017-02-23 00:58:36 +00001410 if( db->nSqlExec==0 && (v = sqlite3GetVdbe(pParse))!=0 ){
1411 sqlite3VdbeAddOp0(v, OP_Expire);
1412 }
drh9f18e8a2005-07-08 12:13:04 +00001413}
1414
drh497e4462005-07-23 03:18:40 +00001415/*
1416** Used to pass information from the analyzer reader through to the
1417** callback routine.
1418*/
1419typedef struct analysisInfo analysisInfo;
1420struct analysisInfo {
1421 sqlite3 *db;
1422 const char *zDatabase;
1423};
1424
1425/*
danf52bb8d2013-08-03 20:24:58 +00001426** The first argument points to a nul-terminated string containing a
1427** list of space separated integers. Read the first nOut of these into
1428** the array aOut[].
1429*/
1430static void decodeIntArray(
drhc28c4e52013-10-03 19:21:41 +00001431 char *zIntArray, /* String containing int array to decode */
1432 int nOut, /* Number of slots in aOut[] */
1433 tRowcnt *aOut, /* Store integers here */
dancfc9df72014-04-25 15:01:01 +00001434 LogEst *aLog, /* Or, if aOut==0, here */
drhc28c4e52013-10-03 19:21:41 +00001435 Index *pIndex /* Handle extra flags for this index, if not NULL */
danf52bb8d2013-08-03 20:24:58 +00001436){
1437 char *z = zIntArray;
1438 int c;
1439 int i;
1440 tRowcnt v;
drh1435a9a2013-08-27 23:15:44 +00001441
drh6d57bbf2013-08-28 11:43:49 +00001442#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
1443 if( z==0 ) z = "";
1444#else
drh85d117b2014-10-06 18:33:49 +00001445 assert( z!=0 );
drh6d57bbf2013-08-28 11:43:49 +00001446#endif
danf52bb8d2013-08-03 20:24:58 +00001447 for(i=0; *z && i<nOut; i++){
1448 v = 0;
1449 while( (c=z[0])>='0' && c<='9' ){
1450 v = v*10 + c - '0';
1451 z++;
1452 }
drhc5f246e2014-05-01 20:24:21 +00001453#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh85d117b2014-10-06 18:33:49 +00001454 if( aOut ) aOut[i] = v;
1455 if( aLog ) aLog[i] = sqlite3LogEst(v);
drhc5f246e2014-05-01 20:24:21 +00001456#else
1457 assert( aOut==0 );
1458 UNUSED_PARAMETER(aOut);
drh85d117b2014-10-06 18:33:49 +00001459 assert( aLog!=0 );
1460 aLog[i] = sqlite3LogEst(v);
drhc5f246e2014-05-01 20:24:21 +00001461#endif
danf52bb8d2013-08-03 20:24:58 +00001462 if( *z==' ' ) z++;
1463 }
drh1f1fc0c2013-10-08 23:16:48 +00001464#ifndef SQLITE_ENABLE_STAT3_OR_STAT4
drh0da10d322014-11-22 21:37:00 +00001465 assert( pIndex!=0 ); {
drh1f1fc0c2013-10-08 23:16:48 +00001466#else
drh0da10d322014-11-22 21:37:00 +00001467 if( pIndex ){
drh1f1fc0c2013-10-08 23:16:48 +00001468#endif
drh0da10d322014-11-22 21:37:00 +00001469 pIndex->bUnordered = 0;
1470 pIndex->noSkipScan = 0;
1471 while( z[0] ){
1472 if( sqlite3_strglob("unordered*", z)==0 ){
1473 pIndex->bUnordered = 1;
1474 }else if( sqlite3_strglob("sz=[0-9]*", z)==0 ){
1475 pIndex->szIdxRow = sqlite3LogEst(sqlite3Atoi(z+3));
1476 }else if( sqlite3_strglob("noskipscan*", z)==0 ){
1477 pIndex->noSkipScan = 1;
1478 }
drhdbd94862014-07-23 23:57:42 +00001479#ifdef SQLITE_ENABLE_COSTMULT
drh0da10d322014-11-22 21:37:00 +00001480 else if( sqlite3_strglob("costmult=[0-9]*",z)==0 ){
1481 pIndex->pTable->costMult = sqlite3LogEst(sqlite3Atoi(z+9));
1482 }
drhdbd94862014-07-23 23:57:42 +00001483#endif
drh0da10d322014-11-22 21:37:00 +00001484 while( z[0]!=0 && z[0]!=' ' ) z++;
1485 while( z[0]==' ' ) z++;
1486 }
danf52bb8d2013-08-03 20:24:58 +00001487 }
1488}
1489
1490/*
drh497e4462005-07-23 03:18:40 +00001491** This callback is invoked once for each index when reading the
1492** sqlite_stat1 table.
1493**
drh15564052010-09-25 22:32:56 +00001494** argv[0] = name of the table
1495** argv[1] = name of the index (might be NULL)
1496** argv[2] = results of analysis - on integer for each column
1497**
1498** Entries for which argv[1]==NULL simply record the number of rows in
1499** the table.
drh497e4462005-07-23 03:18:40 +00001500*/
danielk197762c14b32008-11-19 09:05:26 +00001501static int analysisLoader(void *pData, int argc, char **argv, char **NotUsed){
drh497e4462005-07-23 03:18:40 +00001502 analysisInfo *pInfo = (analysisInfo*)pData;
1503 Index *pIndex;
drh15564052010-09-25 22:32:56 +00001504 Table *pTable;
drh497e4462005-07-23 03:18:40 +00001505 const char *z;
1506
drh15564052010-09-25 22:32:56 +00001507 assert( argc==3 );
danielk1977f3d3c272008-11-19 16:52:44 +00001508 UNUSED_PARAMETER2(NotUsed, argc);
1509
drh15564052010-09-25 22:32:56 +00001510 if( argv==0 || argv[0]==0 || argv[2]==0 ){
drh497e4462005-07-23 03:18:40 +00001511 return 0;
1512 }
drh15564052010-09-25 22:32:56 +00001513 pTable = sqlite3FindTable(pInfo->db, argv[0], pInfo->zDatabase);
1514 if( pTable==0 ){
drh497e4462005-07-23 03:18:40 +00001515 return 0;
1516 }
drhc2b23e72013-11-13 15:32:15 +00001517 if( argv[1]==0 ){
drh15564052010-09-25 22:32:56 +00001518 pIndex = 0;
drhc2b23e72013-11-13 15:32:15 +00001519 }else if( sqlite3_stricmp(argv[0],argv[1])==0 ){
1520 pIndex = sqlite3PrimaryKeyIndex(pTable);
1521 }else{
1522 pIndex = sqlite3FindIndex(pInfo->db, argv[1], pInfo->zDatabase);
drh15564052010-09-25 22:32:56 +00001523 }
drh15564052010-09-25 22:32:56 +00001524 z = argv[2];
danf52bb8d2013-08-03 20:24:58 +00001525
1526 if( pIndex ){
dan4eed0532015-04-20 15:13:08 +00001527 tRowcnt *aiRowEst = 0;
dan43085d72014-10-03 19:16:53 +00001528 int nCol = pIndex->nKeyCol+1;
1529#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan4eed0532015-04-20 15:13:08 +00001530 /* Index.aiRowEst may already be set here if there are duplicate
1531 ** sqlite_stat1 entries for this index. In that case just clobber
1532 ** the old data with the new instead of allocating a new array. */
1533 if( pIndex->aiRowEst==0 ){
1534 pIndex->aiRowEst = (tRowcnt*)sqlite3MallocZero(sizeof(tRowcnt) * nCol);
drh4a642b62016-02-05 01:55:27 +00001535 if( pIndex->aiRowEst==0 ) sqlite3OomFault(pInfo->db);
dan4eed0532015-04-20 15:13:08 +00001536 }
1537 aiRowEst = pIndex->aiRowEst;
dan43085d72014-10-03 19:16:53 +00001538#endif
drh25df48d2014-07-22 14:58:12 +00001539 pIndex->bUnordered = 0;
dan43085d72014-10-03 19:16:53 +00001540 decodeIntArray((char*)z, nCol, aiRowEst, pIndex->aiRowLogEst, pIndex);
drh33bec3f2017-02-17 13:38:15 +00001541 pIndex->hasStat1 = 1;
1542 if( pIndex->pPartIdxWhere==0 ){
1543 pTable->nRowLogEst = pIndex->aiRowLogEst[0];
1544 pTable->tabFlags |= TF_HasStat1;
1545 }
danf52bb8d2013-08-03 20:24:58 +00001546 }else{
drh52f6c912013-10-06 22:12:41 +00001547 Index fakeIdx;
1548 fakeIdx.szIdxRow = pTable->szTabRow;
drhdbd94862014-07-23 23:57:42 +00001549#ifdef SQLITE_ENABLE_COSTMULT
1550 fakeIdx.pTable = pTable;
1551#endif
dancfc9df72014-04-25 15:01:01 +00001552 decodeIntArray((char*)z, 1, 0, &pTable->nRowLogEst, &fakeIdx);
drh52f6c912013-10-06 22:12:41 +00001553 pTable->szTabRow = fakeIdx.szIdxRow;
drh33bec3f2017-02-17 13:38:15 +00001554 pTable->tabFlags |= TF_HasStat1;
drh497e4462005-07-23 03:18:40 +00001555 }
danf52bb8d2013-08-03 20:24:58 +00001556
drh497e4462005-07-23 03:18:40 +00001557 return 0;
1558}
1559
1560/*
dan85c165c2009-08-19 14:34:54 +00001561** If the Index.aSample variable is not NULL, delete the aSample[] array
1562** and its contents.
1563*/
dand46def72010-07-24 11:28:28 +00001564void sqlite3DeleteIndexSamples(sqlite3 *db, Index *pIdx){
drh1435a9a2013-08-27 23:15:44 +00001565#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan85c165c2009-08-19 14:34:54 +00001566 if( pIdx->aSample ){
1567 int j;
drhfaacf172011-08-12 01:51:45 +00001568 for(j=0; j<pIdx->nSample; j++){
dan85c165c2009-08-19 14:34:54 +00001569 IndexSample *p = &pIdx->aSample[j];
danf52bb8d2013-08-03 20:24:58 +00001570 sqlite3DbFree(db, p->p);
dan85c165c2009-08-19 14:34:54 +00001571 }
drh8e3937f2011-08-18 13:45:23 +00001572 sqlite3DbFree(db, pIdx->aSample);
dan85c165c2009-08-19 14:34:54 +00001573 }
drh8e3937f2011-08-18 13:45:23 +00001574 if( db && db->pnBytesFreed==0 ){
1575 pIdx->nSample = 0;
1576 pIdx->aSample = 0;
1577 }
shanecea72b22009-09-07 04:38:36 +00001578#else
drh43b18e12010-08-17 19:40:08 +00001579 UNUSED_PARAMETER(db);
shanecea72b22009-09-07 04:38:36 +00001580 UNUSED_PARAMETER(pIdx);
drh1435a9a2013-08-27 23:15:44 +00001581#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
dan85c165c2009-08-19 14:34:54 +00001582}
1583
drh1435a9a2013-08-27 23:15:44 +00001584#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan0adbed82013-08-15 19:56:32 +00001585/*
1586** Populate the pIdx->aAvgEq[] array based on the samples currently
1587** stored in pIdx->aSample[].
1588*/
1589static void initAvgEq(Index *pIdx){
1590 if( pIdx ){
1591 IndexSample *aSample = pIdx->aSample;
1592 IndexSample *pFinal = &aSample[pIdx->nSample-1];
1593 int iCol;
dan39caccf2014-07-01 11:54:02 +00001594 int nCol = 1;
1595 if( pIdx->nSampleCol>1 ){
1596 /* If this is stat4 data, then calculate aAvgEq[] values for all
1597 ** sample columns except the last. The last is always set to 1, as
1598 ** once the trailing PK fields are considered all index keys are
1599 ** unique. */
1600 nCol = pIdx->nSampleCol-1;
1601 pIdx->aAvgEq[nCol] = 1;
1602 }
1603 for(iCol=0; iCol<nCol; iCol++){
dan43085d72014-10-03 19:16:53 +00001604 int nSample = pIdx->nSample;
dan0adbed82013-08-15 19:56:32 +00001605 int i; /* Used to iterate through samples */
1606 tRowcnt sumEq = 0; /* Sum of the nEq values */
dan0adbed82013-08-15 19:56:32 +00001607 tRowcnt avgEq = 0;
dan43085d72014-10-03 19:16:53 +00001608 tRowcnt nRow; /* Number of rows in index */
1609 i64 nSum100 = 0; /* Number of terms contributing to sumEq */
1610 i64 nDist100; /* Number of distinct values in index */
1611
dan5cca94e2014-12-05 21:04:26 +00001612 if( !pIdx->aiRowEst || iCol>=pIdx->nKeyCol || pIdx->aiRowEst[iCol+1]==0 ){
dan43085d72014-10-03 19:16:53 +00001613 nRow = pFinal->anLt[iCol];
1614 nDist100 = (i64)100 * pFinal->anDLt[iCol];
1615 nSample--;
1616 }else{
1617 nRow = pIdx->aiRowEst[0];
1618 nDist100 = ((i64)100 * pIdx->aiRowEst[0]) / pIdx->aiRowEst[iCol+1];
1619 }
drh9f07cf72014-10-22 15:27:05 +00001620 pIdx->nRowEst0 = nRow;
dan0adbed82013-08-15 19:56:32 +00001621
1622 /* Set nSum to the number of distinct (iCol+1) field prefixes that
dan43085d72014-10-03 19:16:53 +00001623 ** occur in the stat4 table for this index. Set sumEq to the sum of
1624 ** the nEq values for column iCol for the same set (adding the value
1625 ** only once where there exist duplicate prefixes). */
1626 for(i=0; i<nSample; i++){
1627 if( i==(pIdx->nSample-1)
1628 || aSample[i].anDLt[iCol]!=aSample[i+1].anDLt[iCol]
1629 ){
dan0adbed82013-08-15 19:56:32 +00001630 sumEq += aSample[i].anEq[iCol];
dan43085d72014-10-03 19:16:53 +00001631 nSum100 += 100;
dan0adbed82013-08-15 19:56:32 +00001632 }
1633 }
dan43085d72014-10-03 19:16:53 +00001634
drh785d8ed2017-01-11 14:15:29 +00001635 if( nDist100>nSum100 && sumEq<nRow ){
dan43085d72014-10-03 19:16:53 +00001636 avgEq = ((i64)100 * (nRow - sumEq))/(nDist100 - nSum100);
dan0adbed82013-08-15 19:56:32 +00001637 }
1638 if( avgEq==0 ) avgEq = 1;
1639 pIdx->aAvgEq[iCol] = avgEq;
dan0adbed82013-08-15 19:56:32 +00001640 }
1641 }
1642}
1643
dan0106e372013-08-12 16:34:32 +00001644/*
drhce95d112013-11-02 19:34:38 +00001645** Look up an index by name. Or, if the name of a WITHOUT ROWID table
1646** is supplied instead, find the PRIMARY KEY index for that table.
1647*/
1648static Index *findIndexOrPrimaryKey(
1649 sqlite3 *db,
1650 const char *zName,
1651 const char *zDb
1652){
1653 Index *pIdx = sqlite3FindIndex(db, zName, zDb);
1654 if( pIdx==0 ){
1655 Table *pTab = sqlite3FindTable(db, zName, zDb);
1656 if( pTab && !HasRowid(pTab) ) pIdx = sqlite3PrimaryKeyIndex(pTab);
1657 }
1658 return pIdx;
1659}
1660
1661/*
dan0106e372013-08-12 16:34:32 +00001662** Load the content from either the sqlite_stat4 or sqlite_stat3 table
1663** into the relevant Index.aSample[] arrays.
1664**
1665** Arguments zSql1 and zSql2 must point to SQL statements that return
1666** data equivalent to the following (statements are different for stat3,
1667** see the caller of this function for details):
1668**
1669** zSql1: SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx
1670** zSql2: SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4
1671**
1672** where %Q is replaced with the database name before the SQL is executed.
1673*/
1674static int loadStatTbl(
1675 sqlite3 *db, /* Database handle */
1676 int bStat3, /* Assume single column records only */
1677 const char *zSql1, /* SQL statement 1 (see above) */
1678 const char *zSql2, /* SQL statement 2 (see above) */
1679 const char *zDb /* Database name (e.g. "main") */
1680){
drhfaacf172011-08-12 01:51:45 +00001681 int rc; /* Result codes from subroutines */
1682 sqlite3_stmt *pStmt = 0; /* An SQL statement being run */
1683 char *zSql; /* Text of the SQL statement */
1684 Index *pPrevIdx = 0; /* Previous index in the loop */
drhfaacf172011-08-12 01:51:45 +00001685 IndexSample *pSample; /* A slot in pIdx->aSample[] */
1686
drh4a642b62016-02-05 01:55:27 +00001687 assert( db->lookaside.bDisable );
dan0106e372013-08-12 16:34:32 +00001688 zSql = sqlite3MPrintf(db, zSql1, zDb);
drhfaacf172011-08-12 01:51:45 +00001689 if( !zSql ){
mistachkinfad30392016-02-13 23:43:46 +00001690 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001691 }
1692 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1693 sqlite3DbFree(db, zSql);
1694 if( rc ) return rc;
1695
1696 while( sqlite3_step(pStmt)==SQLITE_ROW ){
dan0106e372013-08-12 16:34:32 +00001697 int nIdxCol = 1; /* Number of columns in stat4 records */
dan0106e372013-08-12 16:34:32 +00001698
drhfaacf172011-08-12 01:51:45 +00001699 char *zIndex; /* Index name */
1700 Index *pIdx; /* Pointer to the index object */
1701 int nSample; /* Number of samples */
danf52bb8d2013-08-03 20:24:58 +00001702 int nByte; /* Bytes of space required */
1703 int i; /* Bytes of space required */
1704 tRowcnt *pSpace;
drhfaacf172011-08-12 01:51:45 +00001705
1706 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1707 if( zIndex==0 ) continue;
1708 nSample = sqlite3_column_int(pStmt, 1);
drhce95d112013-11-02 19:34:38 +00001709 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
dan86f69d92013-08-12 17:31:32 +00001710 assert( pIdx==0 || bStat3 || pIdx->nSample==0 );
1711 /* Index.nSample is non-zero at this point if data has already been
1712 ** loaded from the stat4 table. In this case ignore stat3 data. */
1713 if( pIdx==0 || pIdx->nSample ) continue;
dan0106e372013-08-12 16:34:32 +00001714 if( bStat3==0 ){
dan39caccf2014-07-01 11:54:02 +00001715 assert( !HasRowid(pIdx->pTable) || pIdx->nColumn==pIdx->nKeyCol+1 );
1716 if( !HasRowid(pIdx->pTable) && IsPrimaryKeyIndex(pIdx) ){
1717 nIdxCol = pIdx->nKeyCol;
1718 }else{
1719 nIdxCol = pIdx->nColumn;
1720 }
dan0106e372013-08-12 16:34:32 +00001721 }
dan8ad169a2013-08-12 20:14:04 +00001722 pIdx->nSampleCol = nIdxCol;
danf52bb8d2013-08-03 20:24:58 +00001723 nByte = sizeof(IndexSample) * nSample;
dan0106e372013-08-12 16:34:32 +00001724 nByte += sizeof(tRowcnt) * nIdxCol * 3 * nSample;
dan39caccf2014-07-01 11:54:02 +00001725 nByte += nIdxCol * sizeof(tRowcnt); /* Space for Index.aAvgEq[] */
danf52bb8d2013-08-03 20:24:58 +00001726
1727 pIdx->aSample = sqlite3DbMallocZero(db, nByte);
drhfaacf172011-08-12 01:51:45 +00001728 if( pIdx->aSample==0 ){
drhfaacf172011-08-12 01:51:45 +00001729 sqlite3_finalize(pStmt);
mistachkinfad30392016-02-13 23:43:46 +00001730 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001731 }
danf52bb8d2013-08-03 20:24:58 +00001732 pSpace = (tRowcnt*)&pIdx->aSample[nSample];
dan39caccf2014-07-01 11:54:02 +00001733 pIdx->aAvgEq = pSpace; pSpace += nIdxCol;
dan0adbed82013-08-15 19:56:32 +00001734 for(i=0; i<nSample; i++){
dan0106e372013-08-12 16:34:32 +00001735 pIdx->aSample[i].anEq = pSpace; pSpace += nIdxCol;
1736 pIdx->aSample[i].anLt = pSpace; pSpace += nIdxCol;
1737 pIdx->aSample[i].anDLt = pSpace; pSpace += nIdxCol;
danf52bb8d2013-08-03 20:24:58 +00001738 }
1739 assert( ((u8*)pSpace)-nByte==(u8*)(pIdx->aSample) );
drhfaacf172011-08-12 01:51:45 +00001740 }
drh8e3937f2011-08-18 13:45:23 +00001741 rc = sqlite3_finalize(pStmt);
1742 if( rc ) return rc;
drhfaacf172011-08-12 01:51:45 +00001743
dan0106e372013-08-12 16:34:32 +00001744 zSql = sqlite3MPrintf(db, zSql2, zDb);
drhfaacf172011-08-12 01:51:45 +00001745 if( !zSql ){
mistachkinfad30392016-02-13 23:43:46 +00001746 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001747 }
1748 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1749 sqlite3DbFree(db, zSql);
1750 if( rc ) return rc;
1751
1752 while( sqlite3_step(pStmt)==SQLITE_ROW ){
dan0106e372013-08-12 16:34:32 +00001753 char *zIndex; /* Index name */
1754 Index *pIdx; /* Pointer to the index object */
dan0106e372013-08-12 16:34:32 +00001755 int nCol = 1; /* Number of columns in index */
drhfaacf172011-08-12 01:51:45 +00001756
1757 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1758 if( zIndex==0 ) continue;
drhce95d112013-11-02 19:34:38 +00001759 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
drhfaacf172011-08-12 01:51:45 +00001760 if( pIdx==0 ) continue;
dan86f69d92013-08-12 17:31:32 +00001761 /* This next condition is true if data has already been loaded from
1762 ** the sqlite_stat4 table. In this case ignore stat3 data. */
dan0adbed82013-08-15 19:56:32 +00001763 nCol = pIdx->nSampleCol;
1764 if( bStat3 && nCol>1 ) continue;
1765 if( pIdx!=pPrevIdx ){
1766 initAvgEq(pPrevIdx);
1767 pPrevIdx = pIdx;
dan0106e372013-08-12 16:34:32 +00001768 }
danc367d4c2013-08-16 14:09:43 +00001769 pSample = &pIdx->aSample[pIdx->nSample];
dancfc9df72014-04-25 15:01:01 +00001770 decodeIntArray((char*)sqlite3_column_text(pStmt,1),nCol,pSample->anEq,0,0);
1771 decodeIntArray((char*)sqlite3_column_text(pStmt,2),nCol,pSample->anLt,0,0);
1772 decodeIntArray((char*)sqlite3_column_text(pStmt,3),nCol,pSample->anDLt,0,0);
danf52bb8d2013-08-03 20:24:58 +00001773
danc367d4c2013-08-16 14:09:43 +00001774 /* Take a copy of the sample. Add two 0x00 bytes the end of the buffer.
1775 ** This is in case the sample record is corrupted. In that case, the
1776 ** sqlite3VdbeRecordCompare() may read up to two varints past the
1777 ** end of the allocated buffer before it realizes it is dealing with
1778 ** a corrupt record. Adding the two 0x00 bytes prevents this from causing
1779 ** a buffer overread. */
danf52bb8d2013-08-03 20:24:58 +00001780 pSample->n = sqlite3_column_bytes(pStmt, 4);
danc367d4c2013-08-16 14:09:43 +00001781 pSample->p = sqlite3DbMallocZero(db, pSample->n + 2);
danf52bb8d2013-08-03 20:24:58 +00001782 if( pSample->p==0 ){
1783 sqlite3_finalize(pStmt);
mistachkinfad30392016-02-13 23:43:46 +00001784 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001785 }
dan895decf2016-12-30 14:15:56 +00001786 if( pSample->n ){
1787 memcpy(pSample->p, sqlite3_column_blob(pStmt, 4), pSample->n);
1788 }
danc367d4c2013-08-16 14:09:43 +00001789 pIdx->nSample++;
drhfaacf172011-08-12 01:51:45 +00001790 }
drh61b34402013-08-16 13:34:50 +00001791 rc = sqlite3_finalize(pStmt);
1792 if( rc==SQLITE_OK ) initAvgEq(pPrevIdx);
1793 return rc;
drhfaacf172011-08-12 01:51:45 +00001794}
dan0106e372013-08-12 16:34:32 +00001795
1796/*
1797** Load content from the sqlite_stat4 and sqlite_stat3 tables into
1798** the Index.aSample[] arrays of all indices.
1799*/
1800static int loadStat4(sqlite3 *db, const char *zDb){
1801 int rc = SQLITE_OK; /* Result codes from subroutines */
1802
drh4a642b62016-02-05 01:55:27 +00001803 assert( db->lookaside.bDisable );
dan0106e372013-08-12 16:34:32 +00001804 if( sqlite3FindTable(db, "sqlite_stat4", zDb) ){
1805 rc = loadStatTbl(db, 0,
1806 "SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx",
1807 "SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4",
1808 zDb
1809 );
1810 }
1811
1812 if( rc==SQLITE_OK && sqlite3FindTable(db, "sqlite_stat3", zDb) ){
1813 rc = loadStatTbl(db, 1,
1814 "SELECT idx,count(*) FROM %Q.sqlite_stat3 GROUP BY idx",
1815 "SELECT idx,neq,nlt,ndlt,sqlite_record(sample) FROM %Q.sqlite_stat3",
1816 zDb
1817 );
1818 }
1819
1820 return rc;
1821}
drh1435a9a2013-08-27 23:15:44 +00001822#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drhfaacf172011-08-12 01:51:45 +00001823
1824/*
drh92707ac2013-08-17 18:57:15 +00001825** Load the content of the sqlite_stat1 and sqlite_stat3/4 tables. The
dan85c165c2009-08-19 14:34:54 +00001826** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
drh92707ac2013-08-17 18:57:15 +00001827** arrays. The contents of sqlite_stat3/4 are used to populate the
dan85c165c2009-08-19 14:34:54 +00001828** Index.aSample[] arrays.
1829**
1830** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
drh92707ac2013-08-17 18:57:15 +00001831** is returned. In this case, even if SQLITE_ENABLE_STAT3/4 was defined
1832** during compilation and the sqlite_stat3/4 table is present, no data is
dan85c165c2009-08-19 14:34:54 +00001833** read from it.
1834**
drh92707ac2013-08-17 18:57:15 +00001835** If SQLITE_ENABLE_STAT3/4 was defined during compilation and the
danf52bb8d2013-08-03 20:24:58 +00001836** sqlite_stat4 table is not present in the database, SQLITE_ERROR is
dan85c165c2009-08-19 14:34:54 +00001837** returned. However, in this case, data is read from the sqlite_stat1
1838** table (if it is present) before returning.
1839**
1840** If an OOM error occurs, this function always sets db->mallocFailed.
1841** This means if the caller does not care about other errors, the return
1842** code may be ignored.
drh497e4462005-07-23 03:18:40 +00001843*/
drhcf1be452007-05-12 12:08:51 +00001844int sqlite3AnalysisLoad(sqlite3 *db, int iDb){
drh497e4462005-07-23 03:18:40 +00001845 analysisInfo sInfo;
1846 HashElem *i;
1847 char *zSql;
drh51b55a32016-04-04 12:38:05 +00001848 int rc = SQLITE_OK;
drh33bec3f2017-02-17 13:38:15 +00001849 Schema *pSchema = db->aDb[iDb].pSchema;
drh497e4462005-07-23 03:18:40 +00001850
drhff0587c2007-08-29 17:43:19 +00001851 assert( iDb>=0 && iDb<db->nDb );
1852 assert( db->aDb[iDb].pBt!=0 );
drh1fee73e2007-08-29 04:00:57 +00001853
drh497e4462005-07-23 03:18:40 +00001854 /* Clear any prior statistics */
drh21206082011-04-04 18:22:02 +00001855 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drh33bec3f2017-02-17 13:38:15 +00001856 for(i=sqliteHashFirst(&pSchema->tblHash); i; i=sqliteHashNext(i)){
1857 Table *pTab = sqliteHashData(i);
1858 pTab->tabFlags &= ~TF_HasStat1;
1859 }
1860 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
drh497e4462005-07-23 03:18:40 +00001861 Index *pIdx = sqliteHashData(i);
drh33bec3f2017-02-17 13:38:15 +00001862 pIdx->hasStat1 = 0;
drh1435a9a2013-08-27 23:15:44 +00001863#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dand46def72010-07-24 11:28:28 +00001864 sqlite3DeleteIndexSamples(db, pIdx);
1865 pIdx->aSample = 0;
drhfaacf172011-08-12 01:51:45 +00001866#endif
drh497e4462005-07-23 03:18:40 +00001867 }
1868
drhf6661a82016-04-01 12:35:22 +00001869 /* Load new statistics out of the sqlite_stat1 table */
drh497e4462005-07-23 03:18:40 +00001870 sInfo.db = db;
drh69c33822016-08-18 14:33:11 +00001871 sInfo.zDatabase = db->aDb[iDb].zDbSName;
drhf6661a82016-04-01 12:35:22 +00001872 if( sqlite3FindTable(db, "sqlite_stat1", sInfo.zDatabase)!=0 ){
1873 zSql = sqlite3MPrintf(db,
1874 "SELECT tbl,idx,stat FROM %Q.sqlite_stat1", sInfo.zDatabase);
1875 if( zSql==0 ){
1876 rc = SQLITE_NOMEM_BKPT;
1877 }else{
1878 rc = sqlite3_exec(db, zSql, analysisLoader, &sInfo, 0);
1879 sqlite3DbFree(db, zSql);
1880 }
drh497e4462005-07-23 03:18:40 +00001881 }
1882
drhf6661a82016-04-01 12:35:22 +00001883 /* Set appropriate defaults on all indexes not in the sqlite_stat1 table */
1884 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drh33bec3f2017-02-17 13:38:15 +00001885 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
drhf6661a82016-04-01 12:35:22 +00001886 Index *pIdx = sqliteHashData(i);
drh33bec3f2017-02-17 13:38:15 +00001887 if( !pIdx->hasStat1 ) sqlite3DefaultRowEst(pIdx);
drhf16ce3b2009-02-13 16:59:53 +00001888 }
dan02fa4692009-08-17 17:06:58 +00001889
danf52bb8d2013-08-03 20:24:58 +00001890 /* Load the statistics from the sqlite_stat4 table. */
drh1435a9a2013-08-27 23:15:44 +00001891#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhd7d71472014-10-22 19:57:16 +00001892 if( rc==SQLITE_OK && OptimizationEnabled(db, SQLITE_Stat34) ){
drh4a642b62016-02-05 01:55:27 +00001893 db->lookaside.bDisable++;
danf52bb8d2013-08-03 20:24:58 +00001894 rc = loadStat4(db, sInfo.zDatabase);
drh4a642b62016-02-05 01:55:27 +00001895 db->lookaside.bDisable--;
dan02fa4692009-08-17 17:06:58 +00001896 }
drh33bec3f2017-02-17 13:38:15 +00001897 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
dan43085d72014-10-03 19:16:53 +00001898 Index *pIdx = sqliteHashData(i);
drh75b170b2014-10-04 00:07:44 +00001899 sqlite3_free(pIdx->aiRowEst);
dan43085d72014-10-03 19:16:53 +00001900 pIdx->aiRowEst = 0;
1901 }
dan69188d92009-08-19 08:18:32 +00001902#endif
dan02fa4692009-08-17 17:06:58 +00001903
dane275dc32009-08-18 16:24:58 +00001904 if( rc==SQLITE_NOMEM ){
drh4a642b62016-02-05 01:55:27 +00001905 sqlite3OomFault(db);
dane275dc32009-08-18 16:24:58 +00001906 }
drhcf1be452007-05-12 12:08:51 +00001907 return rc;
drh497e4462005-07-23 03:18:40 +00001908}
drh9f18e8a2005-07-08 12:13:04 +00001909
drhff2d5ea2005-07-23 00:41:48 +00001910
drh9f18e8a2005-07-08 12:13:04 +00001911#endif /* SQLITE_OMIT_ANALYZE */