blob: 5075b578671e11489aa4c1f0b750d1419be74ba3 [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 );
dan614efe22018-01-12 16:44:29 +0000237#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
238 }else if( db->xPreUpdateCallback ){
239 sqlite3NestedParse(pParse, "DELETE FROM %Q.%s", pDb->zDbSName, zTab);
240#endif
dan02fa4692009-08-17 17:06:58 +0000241 }else{
dan8ad169a2013-08-12 20:14:04 +0000242 /* The sqlite_stat[134] table already exists. Delete all rows. */
dan02fa4692009-08-17 17:06:58 +0000243 sqlite3VdbeAddOp2(v, OP_Clear, aRoot[i], iDb);
244 }
245 }
drhff2d5ea2005-07-23 00:41:48 +0000246 }
247
danf00e9022013-08-14 19:54:12 +0000248 /* Open the sqlite_stat[134] tables for writing. */
drh1435a9a2013-08-27 23:15:44 +0000249 for(i=0; aTable[i].zCols; i++){
250 assert( i<ArraySize(aTable) );
drh261c02d2013-10-25 14:46:15 +0000251 sqlite3VdbeAddOp4Int(v, OP_OpenWrite, iStatCur+i, aRoot[i], iDb, 3);
drh1435a9a2013-08-27 23:15:44 +0000252 sqlite3VdbeChangeP5(v, aCreateTbl[i]);
drhec9e55d2014-06-30 17:07:39 +0000253 VdbeComment((v, aTable[i].zName));
danielk1977c00da102006-01-07 13:21:04 +0000254 }
drhff2d5ea2005-07-23 00:41:48 +0000255}
256
257/*
danf52bb8d2013-08-03 20:24:58 +0000258** Recommended number of samples for sqlite_stat4
drhfaacf172011-08-12 01:51:45 +0000259*/
danf52bb8d2013-08-03 20:24:58 +0000260#ifndef SQLITE_STAT4_SAMPLES
261# define SQLITE_STAT4_SAMPLES 24
drhfaacf172011-08-12 01:51:45 +0000262#endif
263
264/*
danf00e9022013-08-14 19:54:12 +0000265** Three SQL functions - stat_init(), stat_push(), and stat_get() -
drhade3add2011-08-13 00:58:05 +0000266** share an instance of the following structure to hold their state
267** information.
268*/
danf52bb8d2013-08-03 20:24:58 +0000269typedef struct Stat4Accum Stat4Accum;
danf00e9022013-08-14 19:54:12 +0000270typedef struct Stat4Sample Stat4Sample;
271struct Stat4Sample {
danf00e9022013-08-14 19:54:12 +0000272 tRowcnt *anEq; /* sqlite_stat4.nEq */
danf00e9022013-08-14 19:54:12 +0000273 tRowcnt *anDLt; /* sqlite_stat4.nDLt */
drh1435a9a2013-08-27 23:15:44 +0000274#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000275 tRowcnt *anLt; /* sqlite_stat4.nLt */
drhda475b82013-11-04 21:44:54 +0000276 union {
277 i64 iRowid; /* Rowid in main table of the key */
278 u8 *aRowid; /* Key for WITHOUT ROWID tables */
279 } u;
drhebe25af2013-11-02 18:46:04 +0000280 u32 nRowid; /* Sizeof aRowid[] */
danf00e9022013-08-14 19:54:12 +0000281 u8 isPSample; /* True if a periodic sample */
282 int iCol; /* If !isPSample, the reason for inclusion */
283 u32 iHash; /* Tiebreaker hash */
drh9fecc542013-08-27 20:16:48 +0000284#endif
danf00e9022013-08-14 19:54:12 +0000285};
danf52bb8d2013-08-03 20:24:58 +0000286struct Stat4Accum {
drhade3add2011-08-13 00:58:05 +0000287 tRowcnt nRow; /* Number of rows in the entire table */
288 tRowcnt nPSample; /* How often to do a periodic sample */
drhec9e55d2014-06-30 17:07:39 +0000289 int nCol; /* Number of columns in index + pk/rowid */
290 int nKeyCol; /* Number of index columns w/o the pk/rowid */
drhade3add2011-08-13 00:58:05 +0000291 int mxSample; /* Maximum number of samples to accumulate */
danf00e9022013-08-14 19:54:12 +0000292 Stat4Sample current; /* Current row as a Stat4Sample */
drhf404c862011-08-13 15:25:10 +0000293 u32 iPrn; /* Pseudo-random number used for sampling */
drhebe25af2013-11-02 18:46:04 +0000294 Stat4Sample *aBest; /* Array of nCol best samples */
danf00e9022013-08-14 19:54:12 +0000295 int iMin; /* Index in a[] of entry with minimum score */
296 int nSample; /* Current number of samples */
danbd1d2702017-02-22 19:27:51 +0000297 int nMaxEqZero; /* Max leading 0 in anEq[] for any a[] entry */
danf00e9022013-08-14 19:54:12 +0000298 int iGet; /* Index of current sample accessed by stat_get() */
299 Stat4Sample *a; /* Array of mxSample Stat4Sample objects */
drhebe25af2013-11-02 18:46:04 +0000300 sqlite3 *db; /* Database connection, for malloc() */
drhade3add2011-08-13 00:58:05 +0000301};
302
drhebe25af2013-11-02 18:46:04 +0000303/* Reclaim memory used by a Stat4Sample
304*/
305#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
306static void sampleClear(sqlite3 *db, Stat4Sample *p){
drhda475b82013-11-04 21:44:54 +0000307 assert( db!=0 );
308 if( p->nRowid ){
309 sqlite3DbFree(db, p->u.aRowid);
310 p->nRowid = 0;
311 }
drhebe25af2013-11-02 18:46:04 +0000312}
313#endif
314
drhda475b82013-11-04 21:44:54 +0000315/* Initialize the BLOB value of a ROWID
drhebe25af2013-11-02 18:46:04 +0000316*/
317#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhda475b82013-11-04 21:44:54 +0000318static void sampleSetRowid(sqlite3 *db, Stat4Sample *p, int n, const u8 *pData){
319 assert( db!=0 );
320 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
drh575fad62016-02-05 13:38:36 +0000321 p->u.aRowid = sqlite3DbMallocRawNN(db, n);
drhda475b82013-11-04 21:44:54 +0000322 if( p->u.aRowid ){
323 p->nRowid = n;
324 memcpy(p->u.aRowid, pData, n);
325 }else{
326 p->nRowid = 0;
327 }
328}
329#endif
330
331/* Initialize the INTEGER value of a ROWID.
332*/
333#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
334static void sampleSetRowidInt64(sqlite3 *db, Stat4Sample *p, i64 iRowid){
335 assert( db!=0 );
336 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
337 p->nRowid = 0;
338 p->u.iRowid = iRowid;
339}
340#endif
341
342
343/*
344** Copy the contents of object (*pFrom) into (*pTo).
345*/
346#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
347static void sampleCopy(Stat4Accum *p, Stat4Sample *pTo, Stat4Sample *pFrom){
348 pTo->isPSample = pFrom->isPSample;
349 pTo->iCol = pFrom->iCol;
350 pTo->iHash = pFrom->iHash;
351 memcpy(pTo->anEq, pFrom->anEq, sizeof(tRowcnt)*p->nCol);
352 memcpy(pTo->anLt, pFrom->anLt, sizeof(tRowcnt)*p->nCol);
353 memcpy(pTo->anDLt, pFrom->anDLt, sizeof(tRowcnt)*p->nCol);
354 if( pFrom->nRowid ){
355 sampleSetRowid(p->db, pTo, pFrom->nRowid, pFrom->u.aRowid);
356 }else{
357 sampleSetRowidInt64(p->db, pTo, pFrom->u.iRowid);
drhebe25af2013-11-02 18:46:04 +0000358 }
359}
360#endif
361
362/*
363** Reclaim all memory of a Stat4Accum structure.
364*/
365static void stat4Destructor(void *pOld){
366 Stat4Accum *p = (Stat4Accum*)pOld;
367#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
368 int i;
369 for(i=0; i<p->nCol; i++) sampleClear(p->db, p->aBest+i);
370 for(i=0; i<p->mxSample; i++) sampleClear(p->db, p->a+i);
drhda475b82013-11-04 21:44:54 +0000371 sampleClear(p->db, &p->current);
drhebe25af2013-11-02 18:46:04 +0000372#endif
373 sqlite3DbFree(p->db, p);
374}
375
drhade3add2011-08-13 00:58:05 +0000376/*
drhec9e55d2014-06-30 17:07:39 +0000377** Implementation of the stat_init(N,K,C) SQL function. The three parameters
378** are:
drh553818a2014-07-23 18:36:55 +0000379** N: The number of columns in the index including the rowid/pk (note 1)
380** K: The number of columns in the index excluding the rowid/pk.
381** C: The number of rows in the index (note 2)
drhec9e55d2014-06-30 17:07:39 +0000382**
drh553818a2014-07-23 18:36:55 +0000383** Note 1: In the special case of the covering index that implements a
384** WITHOUT ROWID table, N is the number of PRIMARY KEY columns, not the
385** total number of columns in the table.
drhec9e55d2014-06-30 17:07:39 +0000386**
drh553818a2014-07-23 18:36:55 +0000387** Note 2: C is only used for STAT3 and STAT4.
388**
389** For indexes on ordinary rowid tables, N==K+1. But for indexes on
390** WITHOUT ROWID tables, N=K+P where P is the number of columns in the
391** PRIMARY KEY of the table. The covering index that implements the
392** original WITHOUT ROWID table as N==K as a special case.
drhade3add2011-08-13 00:58:05 +0000393**
danf52bb8d2013-08-03 20:24:58 +0000394** This routine allocates the Stat4Accum object in heap memory. The return
peter.d.reid60ec9142014-09-06 16:39:46 +0000395** value is a pointer to the Stat4Accum object. The datatype of the
drhf8ede572014-09-01 23:06:44 +0000396** return value is BLOB, but it is really just a pointer to the Stat4Accum
397** object.
drhade3add2011-08-13 00:58:05 +0000398*/
danf00e9022013-08-14 19:54:12 +0000399static void statInit(
drhade3add2011-08-13 00:58:05 +0000400 sqlite3_context *context,
401 int argc,
402 sqlite3_value **argv
403){
danf52bb8d2013-08-03 20:24:58 +0000404 Stat4Accum *p;
danf52bb8d2013-08-03 20:24:58 +0000405 int nCol; /* Number of columns in index being sampled */
drhec9e55d2014-06-30 17:07:39 +0000406 int nKeyCol; /* Number of key columns */
drh9fecc542013-08-27 20:16:48 +0000407 int nColUp; /* nCol rounded up for alignment */
danf52bb8d2013-08-03 20:24:58 +0000408 int n; /* Bytes of space to allocate */
drhebe25af2013-11-02 18:46:04 +0000409 sqlite3 *db; /* Database connection */
drh1435a9a2013-08-27 23:15:44 +0000410#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000411 int mxSample = SQLITE_STAT4_SAMPLES;
412#endif
drhade3add2011-08-13 00:58:05 +0000413
danf52bb8d2013-08-03 20:24:58 +0000414 /* Decode the three function arguments */
drh68257192011-08-16 17:06:21 +0000415 UNUSED_PARAMETER(argc);
drh9fecc542013-08-27 20:16:48 +0000416 nCol = sqlite3_value_int(argv[0]);
drhec9e55d2014-06-30 17:07:39 +0000417 assert( nCol>0 );
drh9fecc542013-08-27 20:16:48 +0000418 nColUp = sizeof(tRowcnt)<8 ? (nCol+1)&~1 : nCol;
drhec9e55d2014-06-30 17:07:39 +0000419 nKeyCol = sqlite3_value_int(argv[1]);
420 assert( nKeyCol<=nCol );
421 assert( nKeyCol>0 );
danf52bb8d2013-08-03 20:24:58 +0000422
423 /* Allocate the space required for the Stat4Accum object */
danf00e9022013-08-14 19:54:12 +0000424 n = sizeof(*p)
drh9fecc542013-08-27 20:16:48 +0000425 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anEq */
426 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anDLt */
drh1435a9a2013-08-27 23:15:44 +0000427#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000428 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anLt */
drhebe25af2013-11-02 18:46:04 +0000429 + sizeof(Stat4Sample)*(nCol+mxSample) /* Stat4Accum.aBest[], a[] */
drh9fecc542013-08-27 20:16:48 +0000430 + sizeof(tRowcnt)*3*nColUp*(nCol+mxSample)
431#endif
432 ;
drhebe25af2013-11-02 18:46:04 +0000433 db = sqlite3_context_db_handle(context);
434 p = sqlite3DbMallocZero(db, n);
drhade3add2011-08-13 00:58:05 +0000435 if( p==0 ){
436 sqlite3_result_error_nomem(context);
437 return;
438 }
danf52bb8d2013-08-03 20:24:58 +0000439
drhebe25af2013-11-02 18:46:04 +0000440 p->db = db;
drh9fecc542013-08-27 20:16:48 +0000441 p->nRow = 0;
danf52bb8d2013-08-03 20:24:58 +0000442 p->nCol = nCol;
drhec9e55d2014-06-30 17:07:39 +0000443 p->nKeyCol = nKeyCol;
danf00e9022013-08-14 19:54:12 +0000444 p->current.anDLt = (tRowcnt*)&p[1];
drh9fecc542013-08-27 20:16:48 +0000445 p->current.anEq = &p->current.anDLt[nColUp];
danf00e9022013-08-14 19:54:12 +0000446
drh1435a9a2013-08-27 23:15:44 +0000447#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +0000448 {
449 u8 *pSpace; /* Allocated space not yet assigned */
450 int i; /* Used to iterate through p->aSample[] */
danf52bb8d2013-08-03 20:24:58 +0000451
drh9fecc542013-08-27 20:16:48 +0000452 p->iGet = -1;
453 p->mxSample = mxSample;
drhec9e55d2014-06-30 17:07:39 +0000454 p->nPSample = (tRowcnt)(sqlite3_value_int64(argv[2])/(mxSample/3+1) + 1);
drh9fecc542013-08-27 20:16:48 +0000455 p->current.anLt = &p->current.anEq[nColUp];
drh4081d5d2015-01-01 23:02:01 +0000456 p->iPrn = 0x689e962d*(u32)nCol ^ 0xd0944565*(u32)sqlite3_value_int(argv[2]);
drh9fecc542013-08-27 20:16:48 +0000457
458 /* Set up the Stat4Accum.a[] and aBest[] arrays */
459 p->a = (struct Stat4Sample*)&p->current.anLt[nColUp];
460 p->aBest = &p->a[mxSample];
461 pSpace = (u8*)(&p->a[mxSample+nCol]);
462 for(i=0; i<(mxSample+nCol); i++){
463 p->a[i].anEq = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
464 p->a[i].anLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
465 p->a[i].anDLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
466 }
467 assert( (pSpace - (u8*)p)==n );
468
469 for(i=0; i<nCol; i++){
470 p->aBest[i].iCol = i;
471 }
danf00e9022013-08-14 19:54:12 +0000472 }
drh9fecc542013-08-27 20:16:48 +0000473#endif
danf00e9022013-08-14 19:54:12 +0000474
drhf8ede572014-09-01 23:06:44 +0000475 /* Return a pointer to the allocated object to the caller. Note that
476 ** only the pointer (the 2nd parameter) matters. The size of the object
477 ** (given by the 3rd parameter) is never used and can be any positive
478 ** value. */
drh975e0762014-09-01 22:34:54 +0000479 sqlite3_result_blob(context, p, sizeof(*p), stat4Destructor);
drhade3add2011-08-13 00:58:05 +0000480}
danf00e9022013-08-14 19:54:12 +0000481static const FuncDef statInitFuncdef = {
drhec9e55d2014-06-30 17:07:39 +0000482 2+IsStat34, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000483 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000484 0, /* pUserData */
485 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000486 statInit, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000487 0, /* xFinalize */
dan980cf252018-06-10 07:42:35 +0000488 0, 0, /* xValue, xInverse */
danf00e9022013-08-14 19:54:12 +0000489 "stat_init", /* zName */
drh80738d92016-02-15 00:34:16 +0000490 {0}
drhade3add2011-08-13 00:58:05 +0000491};
492
danb13af4c2013-09-03 14:43:12 +0000493#ifdef SQLITE_ENABLE_STAT4
494/*
495** pNew and pOld are both candidate non-periodic samples selected for
496** the same column (pNew->iCol==pOld->iCol). Ignoring this column and
497** considering only any trailing columns and the sample hash value, this
498** function returns true if sample pNew is to be preferred over pOld.
499** In other words, if we assume that the cardinalities of the selected
500** column for pNew and pOld are equal, is pNew to be preferred over pOld.
501**
502** This function assumes that for each argument sample, the contents of
503** the anEq[] array from pSample->anEq[pSample->iCol+1] onwards are valid.
504*/
505static int sampleIsBetterPost(
506 Stat4Accum *pAccum,
507 Stat4Sample *pNew,
508 Stat4Sample *pOld
509){
510 int nCol = pAccum->nCol;
511 int i;
512 assert( pNew->iCol==pOld->iCol );
513 for(i=pNew->iCol+1; i<nCol; i++){
514 if( pNew->anEq[i]>pOld->anEq[i] ) return 1;
515 if( pNew->anEq[i]<pOld->anEq[i] ) return 0;
516 }
517 if( pNew->iHash>pOld->iHash ) return 1;
518 return 0;
519}
520#endif
521
drh1435a9a2013-08-27 23:15:44 +0000522#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
danf00e9022013-08-14 19:54:12 +0000523/*
524** Return true if pNew is to be preferred over pOld.
danb13af4c2013-09-03 14:43:12 +0000525**
526** This function assumes that for each argument sample, the contents of
527** the anEq[] array from pSample->anEq[pSample->iCol] onwards are valid.
danf00e9022013-08-14 19:54:12 +0000528*/
danb13af4c2013-09-03 14:43:12 +0000529static int sampleIsBetter(
530 Stat4Accum *pAccum,
531 Stat4Sample *pNew,
532 Stat4Sample *pOld
533){
danf00e9022013-08-14 19:54:12 +0000534 tRowcnt nEqNew = pNew->anEq[pNew->iCol];
535 tRowcnt nEqOld = pOld->anEq[pOld->iCol];
536
537 assert( pOld->isPSample==0 && pNew->isPSample==0 );
538 assert( IsStat4 || (pNew->iCol==0 && pOld->iCol==0) );
539
danb13af4c2013-09-03 14:43:12 +0000540 if( (nEqNew>nEqOld) ) return 1;
541#ifdef SQLITE_ENABLE_STAT4
542 if( nEqNew==nEqOld ){
543 if( pNew->iCol<pOld->iCol ) return 1;
544 return (pNew->iCol==pOld->iCol && sampleIsBetterPost(pAccum, pNew, pOld));
danf00e9022013-08-14 19:54:12 +0000545 }
546 return 0;
danb13af4c2013-09-03 14:43:12 +0000547#else
548 return (nEqNew==nEqOld && pNew->iHash>pOld->iHash);
549#endif
danf00e9022013-08-14 19:54:12 +0000550}
drhade3add2011-08-13 00:58:05 +0000551
552/*
danf00e9022013-08-14 19:54:12 +0000553** Copy the contents of sample *pNew into the p->a[] array. If necessary,
554** remove the least desirable sample from p->a[] to make room.
555*/
556static void sampleInsert(Stat4Accum *p, Stat4Sample *pNew, int nEqZero){
drhd2694612013-11-04 22:04:17 +0000557 Stat4Sample *pSample = 0;
danf52bb8d2013-08-03 20:24:58 +0000558 int i;
danf52bb8d2013-08-03 20:24:58 +0000559
danf00e9022013-08-14 19:54:12 +0000560 assert( IsStat4 || nEqZero==0 );
danf52bb8d2013-08-03 20:24:58 +0000561
drh30f07042013-09-04 02:07:38 +0000562#ifdef SQLITE_ENABLE_STAT4
danbd1d2702017-02-22 19:27:51 +0000563 /* Stat4Accum.nMaxEqZero is set to the maximum number of leading 0
564 ** values in the anEq[] array of any sample in Stat4Accum.a[]. In
565 ** other words, if nMaxEqZero is n, then it is guaranteed that there
566 ** are no samples with Stat4Sample.anEq[m]==0 for (m>=n). */
danbd1d2702017-02-22 19:27:51 +0000567 if( nEqZero>p->nMaxEqZero ){
568 p->nMaxEqZero = nEqZero;
569 }
danf00e9022013-08-14 19:54:12 +0000570 if( pNew->isPSample==0 ){
dan1f616ad2013-08-15 14:39:09 +0000571 Stat4Sample *pUpgrade = 0;
danf00e9022013-08-14 19:54:12 +0000572 assert( pNew->anEq[pNew->iCol]>0 );
drhade3add2011-08-13 00:58:05 +0000573
danf00e9022013-08-14 19:54:12 +0000574 /* This sample is being added because the prefix that ends in column
575 ** iCol occurs many times in the table. However, if we have already
576 ** added a sample that shares this prefix, there is no need to add
dan1f616ad2013-08-15 14:39:09 +0000577 ** this one. Instead, upgrade the priority of the highest priority
578 ** existing sample that shares this prefix. */
danf00e9022013-08-14 19:54:12 +0000579 for(i=p->nSample-1; i>=0; i--){
580 Stat4Sample *pOld = &p->a[i];
581 if( pOld->anEq[pNew->iCol]==0 ){
dan1f616ad2013-08-15 14:39:09 +0000582 if( pOld->isPSample ) return;
danb13af4c2013-09-03 14:43:12 +0000583 assert( pOld->iCol>pNew->iCol );
584 assert( sampleIsBetter(p, pNew, pOld) );
585 if( pUpgrade==0 || sampleIsBetter(p, pOld, pUpgrade) ){
dan1f616ad2013-08-15 14:39:09 +0000586 pUpgrade = pOld;
danf00e9022013-08-14 19:54:12 +0000587 }
dan1f28ead2013-08-07 16:15:32 +0000588 }
589 }
dan1f616ad2013-08-15 14:39:09 +0000590 if( pUpgrade ){
591 pUpgrade->iCol = pNew->iCol;
592 pUpgrade->anEq[pUpgrade->iCol] = pNew->anEq[pUpgrade->iCol];
593 goto find_new_min;
594 }
drhade3add2011-08-13 00:58:05 +0000595 }
drh30f07042013-09-04 02:07:38 +0000596#endif
danf52bb8d2013-08-03 20:24:58 +0000597
danf00e9022013-08-14 19:54:12 +0000598 /* If necessary, remove sample iMin to make room for the new sample. */
599 if( p->nSample>=p->mxSample ){
600 Stat4Sample *pMin = &p->a[p->iMin];
danc55521a2013-08-05 05:34:30 +0000601 tRowcnt *anEq = pMin->anEq;
danc55521a2013-08-05 05:34:30 +0000602 tRowcnt *anLt = pMin->anLt;
danf00e9022013-08-14 19:54:12 +0000603 tRowcnt *anDLt = pMin->anDLt;
drhda475b82013-11-04 21:44:54 +0000604 sampleClear(p->db, pMin);
danf00e9022013-08-14 19:54:12 +0000605 memmove(pMin, &pMin[1], sizeof(p->a[0])*(p->nSample-p->iMin-1));
drhf404c862011-08-13 15:25:10 +0000606 pSample = &p->a[p->nSample-1];
drhd2694612013-11-04 22:04:17 +0000607 pSample->nRowid = 0;
danc55521a2013-08-05 05:34:30 +0000608 pSample->anEq = anEq;
609 pSample->anDLt = anDLt;
610 pSample->anLt = anLt;
danf00e9022013-08-14 19:54:12 +0000611 p->nSample = p->mxSample-1;
dan8ad169a2013-08-12 20:14:04 +0000612 }
drhade3add2011-08-13 00:58:05 +0000613
danb49d1042013-09-02 18:58:11 +0000614 /* The "rows less-than" for the rowid column must be greater than that
615 ** for the last sample in the p->a[] array. Otherwise, the samples would
616 ** be out of order. */
617#ifdef SQLITE_ENABLE_STAT4
618 assert( p->nSample==0
619 || pNew->anLt[p->nCol-1] > p->a[p->nSample-1].anLt[p->nCol-1] );
620#endif
621
622 /* Insert the new sample */
623 pSample = &p->a[p->nSample];
624 sampleCopy(p, pSample, pNew);
625 p->nSample++;
626
danf00e9022013-08-14 19:54:12 +0000627 /* Zero the first nEqZero entries in the anEq[] array. */
628 memset(pSample->anEq, 0, sizeof(tRowcnt)*nEqZero);
629
mistachkinc2cfb512013-09-04 04:04:08 +0000630#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000631 find_new_min:
mistachkinc2cfb512013-09-04 04:04:08 +0000632#endif
danf00e9022013-08-14 19:54:12 +0000633 if( p->nSample>=p->mxSample ){
634 int iMin = -1;
danf52bb8d2013-08-03 20:24:58 +0000635 for(i=0; i<p->mxSample; i++){
636 if( p->a[i].isPSample ) continue;
danb13af4c2013-09-03 14:43:12 +0000637 if( iMin<0 || sampleIsBetter(p, &p->a[iMin], &p->a[i]) ){
drhade3add2011-08-13 00:58:05 +0000638 iMin = i;
drhade3add2011-08-13 00:58:05 +0000639 }
640 }
danf52bb8d2013-08-03 20:24:58 +0000641 assert( iMin>=0 );
drhade3add2011-08-13 00:58:05 +0000642 p->iMin = iMin;
643 }
644}
drh1435a9a2013-08-27 23:15:44 +0000645#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
danf00e9022013-08-14 19:54:12 +0000646
647/*
648** Field iChng of the index being scanned has changed. So at this point
649** p->current contains a sample that reflects the previous row of the
650** index. The value of anEq[iChng] and subsequent anEq[] elements are
651** correct at this point.
652*/
653static void samplePushPrevious(Stat4Accum *p, int iChng){
drh92707ac2013-08-17 18:57:15 +0000654#ifdef SQLITE_ENABLE_STAT4
655 int i;
danf00e9022013-08-14 19:54:12 +0000656
drh92707ac2013-08-17 18:57:15 +0000657 /* Check if any samples from the aBest[] array should be pushed
658 ** into IndexSample.a[] at this point. */
659 for(i=(p->nCol-2); i>=iChng; i--){
660 Stat4Sample *pBest = &p->aBest[i];
danb13af4c2013-09-03 14:43:12 +0000661 pBest->anEq[i] = p->current.anEq[i];
662 if( p->nSample<p->mxSample || sampleIsBetter(p, pBest, &p->a[p->iMin]) ){
drh92707ac2013-08-17 18:57:15 +0000663 sampleInsert(p, pBest, i);
danf00e9022013-08-14 19:54:12 +0000664 }
665 }
666
danbd1d2702017-02-22 19:27:51 +0000667 /* Check that no sample contains an anEq[] entry with an index of
668 ** p->nMaxEqZero or greater set to zero. */
drh92707ac2013-08-17 18:57:15 +0000669 for(i=p->nSample-1; i>=0; i--){
670 int j;
danbd1d2702017-02-22 19:27:51 +0000671 for(j=p->nMaxEqZero; j<p->nCol; j++) assert( p->a[i].anEq[j]>0 );
672 }
673
674 /* Update the anEq[] fields of any samples already collected. */
675 if( iChng<p->nMaxEqZero ){
676 for(i=p->nSample-1; i>=0; i--){
677 int j;
678 for(j=iChng; j<p->nCol; j++){
679 if( p->a[i].anEq[j]==0 ) p->a[i].anEq[j] = p->current.anEq[j];
680 }
drh92707ac2013-08-17 18:57:15 +0000681 }
danbd1d2702017-02-22 19:27:51 +0000682 p->nMaxEqZero = iChng;
drh92707ac2013-08-17 18:57:15 +0000683 }
684#endif
685
686#if defined(SQLITE_ENABLE_STAT3) && !defined(SQLITE_ENABLE_STAT4)
687 if( iChng==0 ){
danf00e9022013-08-14 19:54:12 +0000688 tRowcnt nLt = p->current.anLt[0];
689 tRowcnt nEq = p->current.anEq[0];
690
691 /* Check if this is to be a periodic sample. If so, add it. */
692 if( (nLt/p->nPSample)!=(nLt+nEq)/p->nPSample ){
693 p->current.isPSample = 1;
694 sampleInsert(p, &p->current, 0);
695 p->current.isPSample = 0;
696 }else
697
698 /* Or if it is a non-periodic sample. Add it in this case too. */
danb13af4c2013-09-03 14:43:12 +0000699 if( p->nSample<p->mxSample
700 || sampleIsBetter(p, &p->current, &p->a[p->iMin])
701 ){
danf00e9022013-08-14 19:54:12 +0000702 sampleInsert(p, &p->current, 0);
703 }
704 }
drh92707ac2013-08-17 18:57:15 +0000705#endif
drh4f991892013-10-11 15:05:05 +0000706
707#ifndef SQLITE_ENABLE_STAT3_OR_STAT4
708 UNUSED_PARAMETER( p );
709 UNUSED_PARAMETER( iChng );
710#endif
danf00e9022013-08-14 19:54:12 +0000711}
712
713/*
drhebe25af2013-11-02 18:46:04 +0000714** Implementation of the stat_push SQL function: stat_push(P,C,R)
drh9fecc542013-08-27 20:16:48 +0000715** Arguments:
danf00e9022013-08-14 19:54:12 +0000716**
drh9fecc542013-08-27 20:16:48 +0000717** P Pointer to the Stat4Accum object created by stat_init()
718** C Index of left-most column to differ from previous row
drhebe25af2013-11-02 18:46:04 +0000719** R Rowid for the current row. Might be a key record for
720** WITHOUT ROWID tables.
danf00e9022013-08-14 19:54:12 +0000721**
drh553818a2014-07-23 18:36:55 +0000722** This SQL function always returns NULL. It's purpose it to accumulate
723** statistical data and/or samples in the Stat4Accum object about the
724** index being analyzed. The stat_get() SQL function will later be used to
725** extract relevant information for constructing the sqlite_statN tables.
drh9fecc542013-08-27 20:16:48 +0000726**
drhebe25af2013-11-02 18:46:04 +0000727** The R parameter is only used for STAT3 and STAT4
danf00e9022013-08-14 19:54:12 +0000728*/
729static void statPush(
730 sqlite3_context *context,
731 int argc,
732 sqlite3_value **argv
733){
734 int i;
735
736 /* The three function arguments */
737 Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
drh9fecc542013-08-27 20:16:48 +0000738 int iChng = sqlite3_value_int(argv[1]);
danf00e9022013-08-14 19:54:12 +0000739
drh4f991892013-10-11 15:05:05 +0000740 UNUSED_PARAMETER( argc );
741 UNUSED_PARAMETER( context );
drhec9e55d2014-06-30 17:07:39 +0000742 assert( p->nCol>0 );
danf00e9022013-08-14 19:54:12 +0000743 assert( iChng<p->nCol );
744
drh9fecc542013-08-27 20:16:48 +0000745 if( p->nRow==0 ){
danb49d1042013-09-02 18:58:11 +0000746 /* This is the first call to this function. Do initialization. */
drh9fecc542013-08-27 20:16:48 +0000747 for(i=0; i<p->nCol; i++) p->current.anEq[i] = 1;
748 }else{
749 /* Second and subsequent calls get processed here */
danf00e9022013-08-14 19:54:12 +0000750 samplePushPrevious(p, iChng);
751
752 /* Update anDLt[], anLt[] and anEq[] to reflect the values that apply
753 ** to the current row of the index. */
754 for(i=0; i<iChng; i++){
755 p->current.anEq[i]++;
756 }
757 for(i=iChng; i<p->nCol; i++){
758 p->current.anDLt[i]++;
drh1435a9a2013-08-27 23:15:44 +0000759#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
danf00e9022013-08-14 19:54:12 +0000760 p->current.anLt[i] += p->current.anEq[i];
drh9fecc542013-08-27 20:16:48 +0000761#endif
danf00e9022013-08-14 19:54:12 +0000762 p->current.anEq[i] = 1;
763 }
danf00e9022013-08-14 19:54:12 +0000764 }
drh9fecc542013-08-27 20:16:48 +0000765 p->nRow++;
drh1435a9a2013-08-27 23:15:44 +0000766#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhebe25af2013-11-02 18:46:04 +0000767 if( sqlite3_value_type(argv[2])==SQLITE_INTEGER ){
drhda475b82013-11-04 21:44:54 +0000768 sampleSetRowidInt64(p->db, &p->current, sqlite3_value_int64(argv[2]));
drhebe25af2013-11-02 18:46:04 +0000769 }else{
drhda475b82013-11-04 21:44:54 +0000770 sampleSetRowid(p->db, &p->current, sqlite3_value_bytes(argv[2]),
771 sqlite3_value_blob(argv[2]));
drhebe25af2013-11-02 18:46:04 +0000772 }
drh9fecc542013-08-27 20:16:48 +0000773 p->current.iHash = p->iPrn = p->iPrn*1103515245 + 12345;
774#endif
danf00e9022013-08-14 19:54:12 +0000775
drh92707ac2013-08-17 18:57:15 +0000776#ifdef SQLITE_ENABLE_STAT4
777 {
danf00e9022013-08-14 19:54:12 +0000778 tRowcnt nLt = p->current.anLt[p->nCol-1];
779
780 /* Check if this is to be a periodic sample. If so, add it. */
781 if( (nLt/p->nPSample)!=(nLt+1)/p->nPSample ){
782 p->current.isPSample = 1;
783 p->current.iCol = 0;
784 sampleInsert(p, &p->current, p->nCol-1);
785 p->current.isPSample = 0;
786 }
787
788 /* Update the aBest[] array. */
789 for(i=0; i<(p->nCol-1); i++){
790 p->current.iCol = i;
danb13af4c2013-09-03 14:43:12 +0000791 if( i>=iChng || sampleIsBetterPost(p, &p->current, &p->aBest[i]) ){
danf00e9022013-08-14 19:54:12 +0000792 sampleCopy(p, &p->aBest[i], &p->current);
793 }
794 }
795 }
drh92707ac2013-08-17 18:57:15 +0000796#endif
danf00e9022013-08-14 19:54:12 +0000797}
798static const FuncDef statPushFuncdef = {
drh9fecc542013-08-27 20:16:48 +0000799 2+IsStat34, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000800 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000801 0, /* pUserData */
802 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000803 statPush, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000804 0, /* xFinalize */
dan980cf252018-06-10 07:42:35 +0000805 0, 0, /* xValue, xInverse */
danf00e9022013-08-14 19:54:12 +0000806 "stat_push", /* zName */
drh80738d92016-02-15 00:34:16 +0000807 {0}
drhade3add2011-08-13 00:58:05 +0000808};
809
danf00e9022013-08-14 19:54:12 +0000810#define STAT_GET_STAT1 0 /* "stat" column of stat1 table */
811#define STAT_GET_ROWID 1 /* "rowid" column of stat[34] entry */
812#define STAT_GET_NEQ 2 /* "neq" column of stat[34] entry */
813#define STAT_GET_NLT 3 /* "nlt" column of stat[34] entry */
814#define STAT_GET_NDLT 4 /* "ndlt" column of stat[34] entry */
815
drhade3add2011-08-13 00:58:05 +0000816/*
drh92707ac2013-08-17 18:57:15 +0000817** Implementation of the stat_get(P,J) SQL function. This routine is
drh553818a2014-07-23 18:36:55 +0000818** used to query statistical information that has been gathered into
819** the Stat4Accum object by prior calls to stat_push(). The P parameter
drhf8ede572014-09-01 23:06:44 +0000820** has type BLOB but it is really just a pointer to the Stat4Accum object.
drh553818a2014-07-23 18:36:55 +0000821** The content to returned is determined by the parameter J
drh92707ac2013-08-17 18:57:15 +0000822** which is one of the STAT_GET_xxxx values defined above.
drhade3add2011-08-13 00:58:05 +0000823**
drh35497fc2017-02-01 01:34:15 +0000824** The stat_get(P,J) function is not available to generic SQL. It is
825** inserted as part of a manually constructed bytecode program. (See
826** the callStatGet() routine below.) It is guaranteed that the P
827** parameter will always be a poiner to a Stat4Accum object, never a
828** NULL.
829**
drh92707ac2013-08-17 18:57:15 +0000830** If neither STAT3 nor STAT4 are enabled, then J is always
831** STAT_GET_STAT1 and is hence omitted and this routine becomes
832** a one-parameter function, stat_get(P), that always returns the
833** stat1 table entry information.
drhade3add2011-08-13 00:58:05 +0000834*/
danf00e9022013-08-14 19:54:12 +0000835static void statGet(
drhade3add2011-08-13 00:58:05 +0000836 sqlite3_context *context,
837 int argc,
838 sqlite3_value **argv
839){
danf52bb8d2013-08-03 20:24:58 +0000840 Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
drh1435a9a2013-08-27 23:15:44 +0000841#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh92707ac2013-08-17 18:57:15 +0000842 /* STAT3 and STAT4 have a parameter on this routine. */
danf00e9022013-08-14 19:54:12 +0000843 int eCall = sqlite3_value_int(argv[1]);
drh92707ac2013-08-17 18:57:15 +0000844 assert( argc==2 );
danf00e9022013-08-14 19:54:12 +0000845 assert( eCall==STAT_GET_STAT1 || eCall==STAT_GET_NEQ
846 || eCall==STAT_GET_ROWID || eCall==STAT_GET_NLT
847 || eCall==STAT_GET_NDLT
848 );
drh92707ac2013-08-17 18:57:15 +0000849 if( eCall==STAT_GET_STAT1 )
850#else
851 assert( argc==1 );
852#endif
853 {
danf00e9022013-08-14 19:54:12 +0000854 /* Return the value to store in the "stat" column of the sqlite_stat1
855 ** table for this index.
856 **
857 ** The value is a string composed of a list of integers describing
858 ** the index. The first integer in the list is the total number of
859 ** entries in the index. There is one additional integer in the list
860 ** for each indexed column. This additional integer is an estimate of
861 ** the number of rows matched by a stabbing query on the index using
862 ** a key with the corresponding number of fields. In other words,
863 ** if the index is on columns (a,b) and the sqlite_stat1 value is
864 ** "100 10 2", then SQLite estimates that:
865 **
866 ** * the index contains 100 rows,
867 ** * "WHERE a=?" matches 10 rows, and
868 ** * "WHERE a=? AND b=?" matches 2 rows.
869 **
870 ** If D is the count of distinct values and K is the total number of
871 ** rows, then each estimate is computed as:
872 **
873 ** I = (K+D-1)/D
874 */
875 char *z;
876 int i;
877
drhec9e55d2014-06-30 17:07:39 +0000878 char *zRet = sqlite3MallocZero( (p->nKeyCol+1)*25 );
danf00e9022013-08-14 19:54:12 +0000879 if( zRet==0 ){
880 sqlite3_result_error_nomem(context);
881 return;
882 }
883
drh26586e72013-10-09 19:07:22 +0000884 sqlite3_snprintf(24, zRet, "%llu", (u64)p->nRow);
danf00e9022013-08-14 19:54:12 +0000885 z = zRet + sqlite3Strlen30(zRet);
drhec9e55d2014-06-30 17:07:39 +0000886 for(i=0; i<p->nKeyCol; i++){
drh26586e72013-10-09 19:07:22 +0000887 u64 nDistinct = p->current.anDLt[i] + 1;
888 u64 iVal = (p->nRow + nDistinct - 1) / nDistinct;
889 sqlite3_snprintf(24, z, " %llu", iVal);
danf00e9022013-08-14 19:54:12 +0000890 z += sqlite3Strlen30(z);
891 assert( p->current.anEq[i] );
892 }
893 assert( z[0]=='\0' && z>zRet );
894
895 sqlite3_result_text(context, zRet, -1, sqlite3_free);
drh92707ac2013-08-17 18:57:15 +0000896 }
drh1435a9a2013-08-27 23:15:44 +0000897#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh92707ac2013-08-17 18:57:15 +0000898 else if( eCall==STAT_GET_ROWID ){
danf00e9022013-08-14 19:54:12 +0000899 if( p->iGet<0 ){
900 samplePushPrevious(p, 0);
901 p->iGet = 0;
902 }
903 if( p->iGet<p->nSample ){
drhebe25af2013-11-02 18:46:04 +0000904 Stat4Sample *pS = p->a + p->iGet;
905 if( pS->nRowid==0 ){
drhda475b82013-11-04 21:44:54 +0000906 sqlite3_result_int64(context, pS->u.iRowid);
drhebe25af2013-11-02 18:46:04 +0000907 }else{
drhda475b82013-11-04 21:44:54 +0000908 sqlite3_result_blob(context, pS->u.aRowid, pS->nRowid,
909 SQLITE_TRANSIENT);
drhebe25af2013-11-02 18:46:04 +0000910 }
danf00e9022013-08-14 19:54:12 +0000911 }
912 }else{
danf52bb8d2013-08-03 20:24:58 +0000913 tRowcnt *aCnt = 0;
danf00e9022013-08-14 19:54:12 +0000914
915 assert( p->iGet<p->nSample );
916 switch( eCall ){
917 case STAT_GET_NEQ: aCnt = p->a[p->iGet].anEq; break;
918 case STAT_GET_NLT: aCnt = p->a[p->iGet].anLt; break;
919 default: {
920 aCnt = p->a[p->iGet].anDLt;
921 p->iGet++;
922 break;
923 }
danf52bb8d2013-08-03 20:24:58 +0000924 }
925
dan8ad169a2013-08-12 20:14:04 +0000926 if( IsStat3 ){
927 sqlite3_result_int64(context, (i64)aCnt[0]);
danf52bb8d2013-08-03 20:24:58 +0000928 }else{
danf00e9022013-08-14 19:54:12 +0000929 char *zRet = sqlite3MallocZero(p->nCol * 25);
dan8ad169a2013-08-12 20:14:04 +0000930 if( zRet==0 ){
931 sqlite3_result_error_nomem(context);
932 }else{
933 int i;
934 char *z = zRet;
935 for(i=0; i<p->nCol; i++){
drh26586e72013-10-09 19:07:22 +0000936 sqlite3_snprintf(24, z, "%llu ", (u64)aCnt[i]);
dan8ad169a2013-08-12 20:14:04 +0000937 z += sqlite3Strlen30(z);
938 }
939 assert( z[0]=='\0' && z>zRet );
940 z[-1] = '\0';
941 sqlite3_result_text(context, zRet, -1, sqlite3_free);
danf52bb8d2013-08-03 20:24:58 +0000942 }
danf52bb8d2013-08-03 20:24:58 +0000943 }
drhade3add2011-08-13 00:58:05 +0000944 }
drh1435a9a2013-08-27 23:15:44 +0000945#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drh4f991892013-10-11 15:05:05 +0000946#ifndef SQLITE_DEBUG
947 UNUSED_PARAMETER( argc );
948#endif
drhade3add2011-08-13 00:58:05 +0000949}
danf00e9022013-08-14 19:54:12 +0000950static const FuncDef statGetFuncdef = {
drh9fecc542013-08-27 20:16:48 +0000951 1+IsStat34, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000952 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000953 0, /* pUserData */
954 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000955 statGet, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000956 0, /* xFinalize */
dan980cf252018-06-10 07:42:35 +0000957 0, 0, /* xValue, xInverse */
danf00e9022013-08-14 19:54:12 +0000958 "stat_get", /* zName */
drh80738d92016-02-15 00:34:16 +0000959 {0}
drhade3add2011-08-13 00:58:05 +0000960};
drhade3add2011-08-13 00:58:05 +0000961
danf00e9022013-08-14 19:54:12 +0000962static void callStatGet(Vdbe *v, int regStat4, int iParam, int regOut){
963 assert( regOut!=regStat4 && regOut!=regStat4+1 );
drh1435a9a2013-08-27 23:15:44 +0000964#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
danf00e9022013-08-14 19:54:12 +0000965 sqlite3VdbeAddOp2(v, OP_Integer, iParam, regStat4+1);
drh4f991892013-10-11 15:05:05 +0000966#elif SQLITE_DEBUG
drh92707ac2013-08-17 18:57:15 +0000967 assert( iParam==STAT_GET_STAT1 );
drh4f991892013-10-11 15:05:05 +0000968#else
969 UNUSED_PARAMETER( iParam );
drh92707ac2013-08-17 18:57:15 +0000970#endif
drh9b34abe2016-01-16 15:12:35 +0000971 sqlite3VdbeAddOp4(v, OP_Function0, 0, regStat4, regOut,
972 (char*)&statGetFuncdef, P4_FUNCDEF);
drh9fecc542013-08-27 20:16:48 +0000973 sqlite3VdbeChangeP5(v, 1 + IsStat34);
danf00e9022013-08-14 19:54:12 +0000974}
drhade3add2011-08-13 00:58:05 +0000975
976/*
drhff2d5ea2005-07-23 00:41:48 +0000977** Generate code to do an analysis of all indices associated with
978** a single table.
979*/
980static void analyzeOneTable(
981 Parse *pParse, /* Parser context */
982 Table *pTab, /* Table whose indices are to be analyzed */
drha071bc52011-03-31 02:03:28 +0000983 Index *pOnlyIdx, /* If not NULL, only analyze this one index */
drhdfe88ec2008-11-03 20:55:06 +0000984 int iStatCur, /* Index of VdbeCursor that writes the sqlite_stat1 table */
danc6129702013-08-05 19:04:07 +0000985 int iMem, /* Available memory locations begin here */
drh4a54bb52017-02-18 15:58:52 +0000986 int iTab /* Next available cursor */
drhff2d5ea2005-07-23 00:41:48 +0000987){
dan0f9a34e2009-08-19 16:34:31 +0000988 sqlite3 *db = pParse->db; /* Database handle */
dan69188d92009-08-19 08:18:32 +0000989 Index *pIdx; /* An index to being analyzed */
990 int iIdxCur; /* Cursor open on index being analyzed */
danc6129702013-08-05 19:04:07 +0000991 int iTabCur; /* Table cursor */
dan69188d92009-08-19 08:18:32 +0000992 Vdbe *v; /* The virtual machine being built up */
993 int i; /* Loop counter */
drhf6cf1ff2011-03-30 14:54:05 +0000994 int jZeroRows = -1; /* Jump from here if number of rows is zero */
dan69188d92009-08-19 08:18:32 +0000995 int iDb; /* Index of database containing pTab */
drh721dfcf2013-08-01 04:39:17 +0000996 u8 needTableCnt = 1; /* True to count the table */
danf00e9022013-08-14 19:54:12 +0000997 int regNewRowid = iMem++; /* Rowid for the inserted record */
998 int regStat4 = iMem++; /* Register to hold Stat4Accum object */
danf00e9022013-08-14 19:54:12 +0000999 int regChng = iMem++; /* Index of changed index field */
drh1435a9a2013-08-27 23:15:44 +00001000#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +00001001 int regRowid = iMem++; /* Rowid argument passed to stat_push() */
1002#endif
danf00e9022013-08-14 19:54:12 +00001003 int regTemp = iMem++; /* Temporary use register */
dane275dc32009-08-18 16:24:58 +00001004 int regTabname = iMem++; /* Register containing table name */
1005 int regIdxname = iMem++; /* Register containing index name */
danf00e9022013-08-14 19:54:12 +00001006 int regStat1 = iMem++; /* Value for the stat column of sqlite_stat1 */
1007 int regPrev = iMem; /* MUST BE LAST (see below) */
dan614efe22018-01-12 16:44:29 +00001008#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1009 Table *pStat1 = 0;
1010#endif
dan68c4dbb2009-08-20 09:11:06 +00001011
drhf0459fc2013-08-15 16:15:00 +00001012 pParse->nMem = MAX(pParse->nMem, iMem);
drhff2d5ea2005-07-23 00:41:48 +00001013 v = sqlite3GetVdbe(pParse);
drh15564052010-09-25 22:32:56 +00001014 if( v==0 || NEVER(pTab==0) ){
1015 return;
1016 }
drhf39d29c2010-09-28 17:34:46 +00001017 if( pTab->tnum==0 ){
1018 /* Do not gather statistics on views or virtual tables */
drh15564052010-09-25 22:32:56 +00001019 return;
1020 }
drhcedfecf2018-03-23 12:59:10 +00001021 if( sqlite3_strlike("sqlite\\_%", pTab->zName, '\\')==0 ){
drh15564052010-09-25 22:32:56 +00001022 /* Do not gather statistics on system tables */
drhff2d5ea2005-07-23 00:41:48 +00001023 return;
1024 }
dan0f9a34e2009-08-19 16:34:31 +00001025 assert( sqlite3BtreeHoldsAllMutexes(db) );
1026 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
danielk1977da184232006-01-05 11:34:32 +00001027 assert( iDb>=0 );
drh21206082011-04-04 18:22:02 +00001028 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drhe6e04962005-07-23 02:17:03 +00001029#ifndef SQLITE_OMIT_AUTHORIZATION
1030 if( sqlite3AuthCheck(pParse, SQLITE_ANALYZE, pTab->zName, 0,
drh69c33822016-08-18 14:33:11 +00001031 db->aDb[iDb].zDbSName ) ){
drhe6e04962005-07-23 02:17:03 +00001032 return;
1033 }
1034#endif
1035
dan614efe22018-01-12 16:44:29 +00001036#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1037 if( db->xPreUpdateCallback ){
1038 pStat1 = (Table*)sqlite3DbMallocZero(db, sizeof(Table) + 13);
1039 if( pStat1==0 ) return;
1040 pStat1->zName = (char*)&pStat1[1];
1041 memcpy(pStat1->zName, "sqlite_stat1", 13);
1042 pStat1->nCol = 3;
1043 pStat1->iPKey = -1;
1044 sqlite3VdbeAddOp4(pParse->pVdbe, OP_Noop, 0, 0, 0,(char*)pStat1,P4_DYNBLOB);
1045 }
1046#endif
1047
dane0432012013-08-05 18:00:56 +00001048 /* Establish a read-lock on the table at the shared-cache level.
danf00e9022013-08-14 19:54:12 +00001049 ** Open a read-only cursor on the table. Also allocate a cursor number
1050 ** to use for scanning indexes (iIdxCur). No index cursor is opened at
1051 ** this time though. */
danielk1977c00da102006-01-07 13:21:04 +00001052 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danc6129702013-08-05 19:04:07 +00001053 iTabCur = iTab++;
danf00e9022013-08-14 19:54:12 +00001054 iIdxCur = iTab++;
danc6129702013-08-05 19:04:07 +00001055 pParse->nTab = MAX(pParse->nTab, iTab);
dane0432012013-08-05 18:00:56 +00001056 sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
drh076e85f2015-09-03 13:46:12 +00001057 sqlite3VdbeLoadString(v, regTabname, pTab->zName);
dane0432012013-08-05 18:00:56 +00001058
drhff2d5ea2005-07-23 00:41:48 +00001059 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
drh553818a2014-07-23 18:36:55 +00001060 int nCol; /* Number of columns in pIdx. "N" */
danf00e9022013-08-14 19:54:12 +00001061 int addrRewind; /* Address of "OP_Rewind iIdxCur" */
danf00e9022013-08-14 19:54:12 +00001062 int addrNextRow; /* Address of "next_row:" */
drhce95d112013-11-02 19:34:38 +00001063 const char *zIdxName; /* Name of the index */
drh553818a2014-07-23 18:36:55 +00001064 int nColTest; /* Number of columns to test for changes */
danielk1977b3bf5562006-01-10 17:58:23 +00001065
drha071bc52011-03-31 02:03:28 +00001066 if( pOnlyIdx && pOnlyIdx!=pIdx ) continue;
drh721dfcf2013-08-01 04:39:17 +00001067 if( pIdx->pPartIdxWhere==0 ) needTableCnt = 0;
drhec9e55d2014-06-30 17:07:39 +00001068 if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIdx) ){
1069 nCol = pIdx->nKeyCol;
1070 zIdxName = pTab->zName;
drh553818a2014-07-23 18:36:55 +00001071 nColTest = nCol - 1;
drhec9e55d2014-06-30 17:07:39 +00001072 }else{
1073 nCol = pIdx->nColumn;
1074 zIdxName = pIdx->zName;
drh6861b8a2014-07-23 19:37:21 +00001075 nColTest = pIdx->uniqNotNull ? pIdx->nKeyCol-1 : nCol-1;
drhec9e55d2014-06-30 17:07:39 +00001076 }
dane275dc32009-08-18 16:24:58 +00001077
drh15564052010-09-25 22:32:56 +00001078 /* Populate the register containing the index name. */
drh076e85f2015-09-03 13:46:12 +00001079 sqlite3VdbeLoadString(v, regIdxname, zIdxName);
drhec9e55d2014-06-30 17:07:39 +00001080 VdbeComment((v, "Analysis for %s.%s", pTab->zName, zIdxName));
dan69188d92009-08-19 08:18:32 +00001081
dane0432012013-08-05 18:00:56 +00001082 /*
danf00e9022013-08-14 19:54:12 +00001083 ** Pseudo-code for loop that calls stat_push():
dane0432012013-08-05 18:00:56 +00001084 **
danf00e9022013-08-14 19:54:12 +00001085 ** Rewind csr
1086 ** if eof(csr) goto end_of_scan;
1087 ** regChng = 0
1088 ** goto chng_addr_0;
dane0432012013-08-05 18:00:56 +00001089 **
dandd6e1f12013-08-10 19:08:30 +00001090 ** next_row:
danf00e9022013-08-14 19:54:12 +00001091 ** regChng = 0
1092 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1093 ** regChng = 1
1094 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1095 ** ...
1096 ** regChng = N
1097 ** goto chng_addr_N
dane0432012013-08-05 18:00:56 +00001098 **
danf00e9022013-08-14 19:54:12 +00001099 ** chng_addr_0:
1100 ** regPrev(0) = idx(0)
1101 ** chng_addr_1:
1102 ** regPrev(1) = idx(1)
1103 ** ...
dane0432012013-08-05 18:00:56 +00001104 **
drh9d793322014-07-24 19:54:20 +00001105 ** endDistinctTest:
danf00e9022013-08-14 19:54:12 +00001106 ** regRowid = idx(rowid)
drh9fecc542013-08-27 20:16:48 +00001107 ** stat_push(P, regChng, regRowid)
danf00e9022013-08-14 19:54:12 +00001108 ** Next csr
1109 ** if !eof(csr) goto next_row;
dane0432012013-08-05 18:00:56 +00001110 **
danf00e9022013-08-14 19:54:12 +00001111 ** end_of_scan:
dane0432012013-08-05 18:00:56 +00001112 */
danf00e9022013-08-14 19:54:12 +00001113
1114 /* Make sure there are enough memory cells allocated to accommodate
1115 ** the regPrev array and a trailing rowid (the rowid slot is required
1116 ** when building a record to insert into the sample column of
1117 ** the sqlite_stat4 table. */
drh553818a2014-07-23 18:36:55 +00001118 pParse->nMem = MAX(pParse->nMem, regPrev+nColTest);
dan02fa4692009-08-17 17:06:58 +00001119
danf00e9022013-08-14 19:54:12 +00001120 /* Open a read-only cursor on the index being analyzed. */
dane0432012013-08-05 18:00:56 +00001121 assert( iDb==sqlite3SchemaToIndex(db, pIdx->pSchema) );
danf00e9022013-08-14 19:54:12 +00001122 sqlite3VdbeAddOp3(v, OP_OpenRead, iIdxCur, pIdx->tnum, iDb);
drh2ec2fb22013-11-06 19:59:23 +00001123 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
danf00e9022013-08-14 19:54:12 +00001124 VdbeComment((v, "%s", pIdx->zName));
dane0432012013-08-05 18:00:56 +00001125
danf00e9022013-08-14 19:54:12 +00001126 /* Invoke the stat_init() function. The arguments are:
danf52bb8d2013-08-03 20:24:58 +00001127 **
drh553818a2014-07-23 18:36:55 +00001128 ** (1) the number of columns in the index including the rowid
1129 ** (or for a WITHOUT ROWID table, the number of PK columns),
1130 ** (2) the number of columns in the key without the rowid/pk
1131 ** (3) the number of rows in the index,
drh9fecc542013-08-27 20:16:48 +00001132 **
drh553818a2014-07-23 18:36:55 +00001133 **
1134 ** The third argument is only used for STAT3 and STAT4
danf52bb8d2013-08-03 20:24:58 +00001135 */
drh1435a9a2013-08-27 23:15:44 +00001136#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drhec9e55d2014-06-30 17:07:39 +00001137 sqlite3VdbeAddOp2(v, OP_Count, iIdxCur, regStat4+3);
drh9fecc542013-08-27 20:16:48 +00001138#endif
drhec9e55d2014-06-30 17:07:39 +00001139 sqlite3VdbeAddOp2(v, OP_Integer, nCol, regStat4+1);
1140 sqlite3VdbeAddOp2(v, OP_Integer, pIdx->nKeyCol, regStat4+2);
drh9b34abe2016-01-16 15:12:35 +00001141 sqlite3VdbeAddOp4(v, OP_Function0, 0, regStat4+1, regStat4,
1142 (char*)&statInitFuncdef, P4_FUNCDEF);
drhec9e55d2014-06-30 17:07:39 +00001143 sqlite3VdbeChangeP5(v, 2+IsStat34);
danf52bb8d2013-08-03 20:24:58 +00001144
danf00e9022013-08-14 19:54:12 +00001145 /* Implementation of the following:
1146 **
1147 ** Rewind csr
1148 ** if eof(csr) goto end_of_scan;
1149 ** regChng = 0
1150 ** goto next_push_0;
1151 **
dandd6e1f12013-08-10 19:08:30 +00001152 */
danf00e9022013-08-14 19:54:12 +00001153 addrRewind = sqlite3VdbeAddOp1(v, OP_Rewind, iIdxCur);
drh688852a2014-02-17 22:40:43 +00001154 VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001155 sqlite3VdbeAddOp2(v, OP_Integer, 0, regChng);
danf00e9022013-08-14 19:54:12 +00001156 addrNextRow = sqlite3VdbeCurrentAddr(v);
dane0432012013-08-05 18:00:56 +00001157
drh553818a2014-07-23 18:36:55 +00001158 if( nColTest>0 ){
drh9d793322014-07-24 19:54:20 +00001159 int endDistinctTest = sqlite3VdbeMakeLabel(v);
drhb12879f2014-07-24 20:25:16 +00001160 int *aGotoChng; /* Array of jump instruction addresses */
drh575fad62016-02-05 13:38:36 +00001161 aGotoChng = sqlite3DbMallocRawNN(db, sizeof(int)*nColTest);
drhb12879f2014-07-24 20:25:16 +00001162 if( aGotoChng==0 ) continue;
danf00e9022013-08-14 19:54:12 +00001163
drh553818a2014-07-23 18:36:55 +00001164 /*
1165 ** next_row:
1166 ** regChng = 0
1167 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1168 ** regChng = 1
1169 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1170 ** ...
1171 ** regChng = N
drh9d793322014-07-24 19:54:20 +00001172 ** goto endDistinctTest
drh553818a2014-07-23 18:36:55 +00001173 */
1174 sqlite3VdbeAddOp0(v, OP_Goto);
1175 addrNextRow = sqlite3VdbeCurrentAddr(v);
drh5f1d1d92014-07-31 22:59:04 +00001176 if( nColTest==1 && pIdx->nKeyCol==1 && IsUniqueIndex(pIdx) ){
drh9d793322014-07-24 19:54:20 +00001177 /* For a single-column UNIQUE index, once we have found a non-NULL
1178 ** row, we know that all the rest will be distinct, so skip
1179 ** subsequent distinctness tests. */
1180 sqlite3VdbeAddOp2(v, OP_NotNull, regPrev, endDistinctTest);
1181 VdbeCoverage(v);
1182 }
drh553818a2014-07-23 18:36:55 +00001183 for(i=0; i<nColTest; i++){
1184 char *pColl = (char*)sqlite3LocateCollSeq(pParse, pIdx->azColl[i]);
1185 sqlite3VdbeAddOp2(v, OP_Integer, i, regChng);
1186 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regTemp);
1187 aGotoChng[i] =
1188 sqlite3VdbeAddOp4(v, OP_Ne, regTemp, 0, regPrev+i, pColl, P4_COLLSEQ);
1189 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
1190 VdbeCoverage(v);
1191 }
1192 sqlite3VdbeAddOp2(v, OP_Integer, nColTest, regChng);
drh076e85f2015-09-03 13:46:12 +00001193 sqlite3VdbeGoto(v, endDistinctTest);
drh553818a2014-07-23 18:36:55 +00001194
1195
1196 /*
1197 ** chng_addr_0:
1198 ** regPrev(0) = idx(0)
1199 ** chng_addr_1:
1200 ** regPrev(1) = idx(1)
1201 ** ...
1202 */
1203 sqlite3VdbeJumpHere(v, addrNextRow-1);
1204 for(i=0; i<nColTest; i++){
1205 sqlite3VdbeJumpHere(v, aGotoChng[i]);
1206 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regPrev+i);
1207 }
drh9d793322014-07-24 19:54:20 +00001208 sqlite3VdbeResolveLabel(v, endDistinctTest);
drhb12879f2014-07-24 20:25:16 +00001209 sqlite3DbFree(db, aGotoChng);
drhff2d5ea2005-07-23 00:41:48 +00001210 }
drh553818a2014-07-23 18:36:55 +00001211
danf00e9022013-08-14 19:54:12 +00001212 /*
1213 ** chng_addr_N:
drh9fecc542013-08-27 20:16:48 +00001214 ** regRowid = idx(rowid) // STAT34 only
1215 ** stat_push(P, regChng, regRowid) // 3rd parameter STAT34 only
danf00e9022013-08-14 19:54:12 +00001216 ** Next csr
1217 ** if !eof(csr) goto next_row;
1218 */
drh1435a9a2013-08-27 23:15:44 +00001219#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +00001220 assert( regRowid==(regStat4+2) );
drhebe25af2013-11-02 18:46:04 +00001221 if( HasRowid(pTab) ){
1222 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, regRowid);
1223 }else{
1224 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
1225 int j, k, regKey;
1226 regKey = sqlite3GetTempRange(pParse, pPk->nKeyCol);
1227 for(j=0; j<pPk->nKeyCol; j++){
1228 k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
drh49297c82017-03-21 18:56:52 +00001229 assert( k>=0 && k<pIdx->nColumn );
drhebe25af2013-11-02 18:46:04 +00001230 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, regKey+j);
1231 VdbeComment((v, "%s", pTab->aCol[pPk->aiColumn[j]].zName));
1232 }
1233 sqlite3VdbeAddOp3(v, OP_MakeRecord, regKey, pPk->nKeyCol, regRowid);
1234 sqlite3ReleaseTempRange(pParse, regKey, pPk->nKeyCol);
1235 }
drh9fecc542013-08-27 20:16:48 +00001236#endif
1237 assert( regChng==(regStat4+1) );
drh9b34abe2016-01-16 15:12:35 +00001238 sqlite3VdbeAddOp4(v, OP_Function0, 1, regStat4, regTemp,
1239 (char*)&statPushFuncdef, P4_FUNCDEF);
drh9fecc542013-08-27 20:16:48 +00001240 sqlite3VdbeChangeP5(v, 2+IsStat34);
drh688852a2014-02-17 22:40:43 +00001241 sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001242
1243 /* Add the entry to the stat1 table. */
1244 callStatGet(v, regStat4, STAT_GET_STAT1, regStat1);
drh4583c372014-09-19 20:13:25 +00001245 assert( "BBB"[0]==SQLITE_AFF_TEXT );
1246 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
drhade3add2011-08-13 00:58:05 +00001247 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
danf00e9022013-08-14 19:54:12 +00001248 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
dan614efe22018-01-12 16:44:29 +00001249#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1250 sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
1251#endif
drh2d401ab2008-01-10 23:50:11 +00001252 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
danf00e9022013-08-14 19:54:12 +00001253
1254 /* Add the entries to the stat3 or stat4 table. */
drh1435a9a2013-08-27 23:15:44 +00001255#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh9fecc542013-08-27 20:16:48 +00001256 {
danf00e9022013-08-14 19:54:12 +00001257 int regEq = regStat1;
1258 int regLt = regStat1+1;
1259 int regDLt = regStat1+2;
1260 int regSample = regStat1+3;
1261 int regCol = regStat1+4;
1262 int regSampleRowid = regCol + nCol;
1263 int addrNext;
1264 int addrIsNull;
drhebe25af2013-11-02 18:46:04 +00001265 u8 seekOp = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
danf00e9022013-08-14 19:54:12 +00001266
drhec9e55d2014-06-30 17:07:39 +00001267 pParse->nMem = MAX(pParse->nMem, regCol+nCol);
danf00e9022013-08-14 19:54:12 +00001268
1269 addrNext = sqlite3VdbeCurrentAddr(v);
1270 callStatGet(v, regStat4, STAT_GET_ROWID, regSampleRowid);
1271 addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regSampleRowid);
drh688852a2014-02-17 22:40:43 +00001272 VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001273 callStatGet(v, regStat4, STAT_GET_NEQ, regEq);
1274 callStatGet(v, regStat4, STAT_GET_NLT, regLt);
1275 callStatGet(v, regStat4, STAT_GET_NDLT, regDLt);
drhebe25af2013-11-02 18:46:04 +00001276 sqlite3VdbeAddOp4Int(v, seekOp, iTabCur, addrNext, regSampleRowid, 0);
drh6ccbd272018-07-10 17:10:44 +00001277 VdbeCoverage(v);
drh9fecc542013-08-27 20:16:48 +00001278#ifdef SQLITE_ENABLE_STAT3
drh1f9ca2c2015-08-25 16:57:52 +00001279 sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, 0, regSample);
drh9fecc542013-08-27 20:16:48 +00001280#else
drhec9e55d2014-06-30 17:07:39 +00001281 for(i=0; i<nCol; i++){
drh1f9ca2c2015-08-25 16:57:52 +00001282 sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, i, regCol+i);
danf00e9022013-08-14 19:54:12 +00001283 }
drhec9e55d2014-06-30 17:07:39 +00001284 sqlite3VdbeAddOp3(v, OP_MakeRecord, regCol, nCol, regSample);
drh9fecc542013-08-27 20:16:48 +00001285#endif
drh57bf4a82014-02-17 14:59:22 +00001286 sqlite3VdbeAddOp3(v, OP_MakeRecord, regTabname, 6, regTemp);
danf00e9022013-08-14 19:54:12 +00001287 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur+1, regNewRowid);
1288 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur+1, regTemp, regNewRowid);
drhfe705102014-03-06 13:38:37 +00001289 sqlite3VdbeAddOp2(v, OP_Goto, 1, addrNext); /* P1==1 for end-of-loop */
danf00e9022013-08-14 19:54:12 +00001290 sqlite3VdbeJumpHere(v, addrIsNull);
1291 }
drh1435a9a2013-08-27 23:15:44 +00001292#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
danf00e9022013-08-14 19:54:12 +00001293
drh9fecc542013-08-27 20:16:48 +00001294 /* End of analysis */
danf00e9022013-08-14 19:54:12 +00001295 sqlite3VdbeJumpHere(v, addrRewind);
drh15564052010-09-25 22:32:56 +00001296 }
1297
danf00e9022013-08-14 19:54:12 +00001298
drh721dfcf2013-08-01 04:39:17 +00001299 /* Create a single sqlite_stat1 entry containing NULL as the index
1300 ** name and the row count as the content.
drh15564052010-09-25 22:32:56 +00001301 */
drh721dfcf2013-08-01 04:39:17 +00001302 if( pOnlyIdx==0 && needTableCnt ){
drh15564052010-09-25 22:32:56 +00001303 VdbeComment((v, "%s", pTab->zName));
dane0432012013-08-05 18:00:56 +00001304 sqlite3VdbeAddOp2(v, OP_Count, iTabCur, regStat1);
drh688852a2014-02-17 22:40:43 +00001305 jZeroRows = sqlite3VdbeAddOp1(v, OP_IfNot, regStat1); VdbeCoverage(v);
drh721dfcf2013-08-01 04:39:17 +00001306 sqlite3VdbeAddOp2(v, OP_Null, 0, regIdxname);
drh4583c372014-09-19 20:13:25 +00001307 assert( "BBB"[0]==SQLITE_AFF_TEXT );
1308 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
drh721dfcf2013-08-01 04:39:17 +00001309 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
danf00e9022013-08-14 19:54:12 +00001310 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
drh721dfcf2013-08-01 04:39:17 +00001311 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
dan3739f292018-01-17 20:57:20 +00001312#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1313 sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
1314#endif
drh15564052010-09-25 22:32:56 +00001315 sqlite3VdbeJumpHere(v, jZeroRows);
1316 }
drhff2d5ea2005-07-23 00:41:48 +00001317}
1318
drh72052a72017-02-17 16:26:34 +00001319
1320/*
drh4a54bb52017-02-18 15:58:52 +00001321** Generate code that will cause the most recent index analysis to
1322** be loaded into internal hash tables where is can be used.
drh72052a72017-02-17 16:26:34 +00001323*/
drh4a54bb52017-02-18 15:58:52 +00001324static void loadAnalysis(Parse *pParse, int iDb){
drh182e84c2017-02-18 02:19:02 +00001325 Vdbe *v = sqlite3GetVdbe(pParse);
drh4a54bb52017-02-18 15:58:52 +00001326 if( v ){
1327 sqlite3VdbeAddOp1(v, OP_LoadAnalysis, iDb);
1328 }
1329}
drhff2d5ea2005-07-23 00:41:48 +00001330
drh4a54bb52017-02-18 15:58:52 +00001331/*
1332** Generate code that will do an analysis of an entire database
1333*/
1334static void analyzeDatabase(Parse *pParse, int iDb){
1335 sqlite3 *db = pParse->db;
1336 Schema *pSchema = db->aDb[iDb].pSchema; /* Schema of database iDb */
1337 HashElem *k;
1338 int iStatCur;
1339 int iMem;
1340 int iTab;
1341
1342 sqlite3BeginWriteOperation(pParse, 0, iDb);
1343 iStatCur = pParse->nTab;
1344 pParse->nTab += 3;
1345 openStatTable(pParse, iDb, iStatCur, 0, 0);
1346 iMem = pParse->nMem+1;
1347 iTab = pParse->nTab;
1348 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1349 for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
1350 Table *pTab = (Table*)sqliteHashData(k);
1351 analyzeOneTable(pParse, pTab, 0, iStatCur, iMem, iTab);
drhff2d5ea2005-07-23 00:41:48 +00001352 }
drh4a54bb52017-02-18 15:58:52 +00001353 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001354}
1355
1356/*
1357** Generate code that will do an analysis of a single table in
drha071bc52011-03-31 02:03:28 +00001358** a database. If pOnlyIdx is not NULL then it is a single index
1359** in pTab that should be analyzed.
drhff2d5ea2005-07-23 00:41:48 +00001360*/
drha071bc52011-03-31 02:03:28 +00001361static void analyzeTable(Parse *pParse, Table *pTab, Index *pOnlyIdx){
drhff2d5ea2005-07-23 00:41:48 +00001362 int iDb;
1363 int iStatCur;
1364
1365 assert( pTab!=0 );
drh1fee73e2007-08-29 04:00:57 +00001366 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
danielk1977da184232006-01-05 11:34:32 +00001367 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drhff2d5ea2005-07-23 00:41:48 +00001368 sqlite3BeginWriteOperation(pParse, 0, iDb);
dan02fa4692009-08-17 17:06:58 +00001369 iStatCur = pParse->nTab;
drhade3add2011-08-13 00:58:05 +00001370 pParse->nTab += 3;
drha071bc52011-03-31 02:03:28 +00001371 if( pOnlyIdx ){
1372 openStatTable(pParse, iDb, iStatCur, pOnlyIdx->zName, "idx");
1373 }else{
1374 openStatTable(pParse, iDb, iStatCur, pTab->zName, "tbl");
1375 }
drh4a54bb52017-02-18 15:58:52 +00001376 analyzeOneTable(pParse, pTab, pOnlyIdx, iStatCur,pParse->nMem+1,pParse->nTab);
1377 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001378}
1379
1380/*
1381** Generate code for the ANALYZE command. The parser calls this routine
1382** when it recognizes an ANALYZE command.
drh9f18e8a2005-07-08 12:13:04 +00001383**
1384** ANALYZE -- 1
drhff2d5ea2005-07-23 00:41:48 +00001385** ANALYZE <database> -- 2
drh9f18e8a2005-07-08 12:13:04 +00001386** ANALYZE ?<database>.?<tablename> -- 3
1387**
1388** Form 1 causes all indices in all attached databases to be analyzed.
1389** Form 2 analyzes all indices the single database named.
1390** Form 3 analyzes all indices associated with the named table.
1391*/
drh182e84c2017-02-18 02:19:02 +00001392void sqlite3Analyze(Parse *pParse, Token *pName1, Token *pName2){
drhff2d5ea2005-07-23 00:41:48 +00001393 sqlite3 *db = pParse->db;
1394 int iDb;
drh4a54bb52017-02-18 15:58:52 +00001395 int i;
drhff2d5ea2005-07-23 00:41:48 +00001396 char *z, *zDb;
1397 Table *pTab;
drha071bc52011-03-31 02:03:28 +00001398 Index *pIdx;
drhff2d5ea2005-07-23 00:41:48 +00001399 Token *pTableName;
drh4a54bb52017-02-18 15:58:52 +00001400 Vdbe *v;
drhff2d5ea2005-07-23 00:41:48 +00001401
1402 /* Read the database schema. If an error occurs, leave an error message
1403 ** and code in pParse and return NULL. */
drh1fee73e2007-08-29 04:00:57 +00001404 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
drhff2d5ea2005-07-23 00:41:48 +00001405 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
1406 return;
1407 }
1408
drh05800a12009-04-16 17:45:47 +00001409 assert( pName2!=0 || pName1==0 );
drhff2d5ea2005-07-23 00:41:48 +00001410 if( pName1==0 ){
1411 /* Form 1: Analyze everything */
drh4a54bb52017-02-18 15:58:52 +00001412 for(i=0; i<db->nDb; i++){
1413 if( i==1 ) continue; /* Do not analyze the TEMP database */
1414 analyzeDatabase(pParse, i);
1415 }
drhbce04142017-02-23 00:58:36 +00001416 }else if( pName2->n==0 && (iDb = sqlite3FindDb(db, pName1))>=0 ){
1417 /* Analyze the schema named as the argument */
1418 analyzeDatabase(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001419 }else{
drhbce04142017-02-23 00:58:36 +00001420 /* Form 3: Analyze the table or index named as an argument */
drhff2d5ea2005-07-23 00:41:48 +00001421 iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pTableName);
1422 if( iDb>=0 ){
drhbce04142017-02-23 00:58:36 +00001423 zDb = pName2->n ? db->aDb[iDb].zDbSName : 0;
drh17435752007-08-16 04:30:38 +00001424 z = sqlite3NameFromToken(db, pTableName);
drhcf1be452007-05-12 12:08:51 +00001425 if( z ){
drha071bc52011-03-31 02:03:28 +00001426 if( (pIdx = sqlite3FindIndex(db, z, zDb))!=0 ){
1427 analyzeTable(pParse, pIdx->pTable, pIdx);
1428 }else if( (pTab = sqlite3LocateTable(pParse, 0, z, zDb))!=0 ){
1429 analyzeTable(pParse, pTab, 0);
drhcf1be452007-05-12 12:08:51 +00001430 }
drha071bc52011-03-31 02:03:28 +00001431 sqlite3DbFree(db, z);
drhff2d5ea2005-07-23 00:41:48 +00001432 }
drhbce04142017-02-23 00:58:36 +00001433 }
drhff2d5ea2005-07-23 00:41:48 +00001434 }
drhbce04142017-02-23 00:58:36 +00001435 if( db->nSqlExec==0 && (v = sqlite3GetVdbe(pParse))!=0 ){
1436 sqlite3VdbeAddOp0(v, OP_Expire);
1437 }
drh9f18e8a2005-07-08 12:13:04 +00001438}
1439
drh497e4462005-07-23 03:18:40 +00001440/*
1441** Used to pass information from the analyzer reader through to the
1442** callback routine.
1443*/
1444typedef struct analysisInfo analysisInfo;
1445struct analysisInfo {
1446 sqlite3 *db;
1447 const char *zDatabase;
1448};
1449
1450/*
danf52bb8d2013-08-03 20:24:58 +00001451** The first argument points to a nul-terminated string containing a
1452** list of space separated integers. Read the first nOut of these into
1453** the array aOut[].
1454*/
1455static void decodeIntArray(
drhc28c4e52013-10-03 19:21:41 +00001456 char *zIntArray, /* String containing int array to decode */
1457 int nOut, /* Number of slots in aOut[] */
1458 tRowcnt *aOut, /* Store integers here */
dancfc9df72014-04-25 15:01:01 +00001459 LogEst *aLog, /* Or, if aOut==0, here */
drhc28c4e52013-10-03 19:21:41 +00001460 Index *pIndex /* Handle extra flags for this index, if not NULL */
danf52bb8d2013-08-03 20:24:58 +00001461){
1462 char *z = zIntArray;
1463 int c;
1464 int i;
1465 tRowcnt v;
drh1435a9a2013-08-27 23:15:44 +00001466
drh6d57bbf2013-08-28 11:43:49 +00001467#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
1468 if( z==0 ) z = "";
1469#else
drh85d117b2014-10-06 18:33:49 +00001470 assert( z!=0 );
drh6d57bbf2013-08-28 11:43:49 +00001471#endif
danf52bb8d2013-08-03 20:24:58 +00001472 for(i=0; *z && i<nOut; i++){
1473 v = 0;
1474 while( (c=z[0])>='0' && c<='9' ){
1475 v = v*10 + c - '0';
1476 z++;
1477 }
drhc5f246e2014-05-01 20:24:21 +00001478#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh85d117b2014-10-06 18:33:49 +00001479 if( aOut ) aOut[i] = v;
1480 if( aLog ) aLog[i] = sqlite3LogEst(v);
drhc5f246e2014-05-01 20:24:21 +00001481#else
1482 assert( aOut==0 );
1483 UNUSED_PARAMETER(aOut);
drh85d117b2014-10-06 18:33:49 +00001484 assert( aLog!=0 );
1485 aLog[i] = sqlite3LogEst(v);
drhc5f246e2014-05-01 20:24:21 +00001486#endif
danf52bb8d2013-08-03 20:24:58 +00001487 if( *z==' ' ) z++;
1488 }
drh1f1fc0c2013-10-08 23:16:48 +00001489#ifndef SQLITE_ENABLE_STAT3_OR_STAT4
drh0da10d322014-11-22 21:37:00 +00001490 assert( pIndex!=0 ); {
drh1f1fc0c2013-10-08 23:16:48 +00001491#else
drh0da10d322014-11-22 21:37:00 +00001492 if( pIndex ){
drh1f1fc0c2013-10-08 23:16:48 +00001493#endif
drh0da10d322014-11-22 21:37:00 +00001494 pIndex->bUnordered = 0;
1495 pIndex->noSkipScan = 0;
1496 while( z[0] ){
1497 if( sqlite3_strglob("unordered*", z)==0 ){
1498 pIndex->bUnordered = 1;
1499 }else if( sqlite3_strglob("sz=[0-9]*", z)==0 ){
1500 pIndex->szIdxRow = sqlite3LogEst(sqlite3Atoi(z+3));
1501 }else if( sqlite3_strglob("noskipscan*", z)==0 ){
1502 pIndex->noSkipScan = 1;
1503 }
drhdbd94862014-07-23 23:57:42 +00001504#ifdef SQLITE_ENABLE_COSTMULT
drh0da10d322014-11-22 21:37:00 +00001505 else if( sqlite3_strglob("costmult=[0-9]*",z)==0 ){
1506 pIndex->pTable->costMult = sqlite3LogEst(sqlite3Atoi(z+9));
1507 }
drhdbd94862014-07-23 23:57:42 +00001508#endif
drh0da10d322014-11-22 21:37:00 +00001509 while( z[0]!=0 && z[0]!=' ' ) z++;
1510 while( z[0]==' ' ) z++;
1511 }
danf52bb8d2013-08-03 20:24:58 +00001512 }
1513}
1514
1515/*
drh497e4462005-07-23 03:18:40 +00001516** This callback is invoked once for each index when reading the
1517** sqlite_stat1 table.
1518**
drh15564052010-09-25 22:32:56 +00001519** argv[0] = name of the table
1520** argv[1] = name of the index (might be NULL)
1521** argv[2] = results of analysis - on integer for each column
1522**
1523** Entries for which argv[1]==NULL simply record the number of rows in
1524** the table.
drh497e4462005-07-23 03:18:40 +00001525*/
danielk197762c14b32008-11-19 09:05:26 +00001526static int analysisLoader(void *pData, int argc, char **argv, char **NotUsed){
drh497e4462005-07-23 03:18:40 +00001527 analysisInfo *pInfo = (analysisInfo*)pData;
1528 Index *pIndex;
drh15564052010-09-25 22:32:56 +00001529 Table *pTable;
drh497e4462005-07-23 03:18:40 +00001530 const char *z;
1531
drh15564052010-09-25 22:32:56 +00001532 assert( argc==3 );
danielk1977f3d3c272008-11-19 16:52:44 +00001533 UNUSED_PARAMETER2(NotUsed, argc);
1534
drh15564052010-09-25 22:32:56 +00001535 if( argv==0 || argv[0]==0 || argv[2]==0 ){
drh497e4462005-07-23 03:18:40 +00001536 return 0;
1537 }
drh15564052010-09-25 22:32:56 +00001538 pTable = sqlite3FindTable(pInfo->db, argv[0], pInfo->zDatabase);
1539 if( pTable==0 ){
drh497e4462005-07-23 03:18:40 +00001540 return 0;
1541 }
drhc2b23e72013-11-13 15:32:15 +00001542 if( argv[1]==0 ){
drh15564052010-09-25 22:32:56 +00001543 pIndex = 0;
drhc2b23e72013-11-13 15:32:15 +00001544 }else if( sqlite3_stricmp(argv[0],argv[1])==0 ){
1545 pIndex = sqlite3PrimaryKeyIndex(pTable);
1546 }else{
1547 pIndex = sqlite3FindIndex(pInfo->db, argv[1], pInfo->zDatabase);
drh15564052010-09-25 22:32:56 +00001548 }
drh15564052010-09-25 22:32:56 +00001549 z = argv[2];
danf52bb8d2013-08-03 20:24:58 +00001550
1551 if( pIndex ){
dan4eed0532015-04-20 15:13:08 +00001552 tRowcnt *aiRowEst = 0;
dan43085d72014-10-03 19:16:53 +00001553 int nCol = pIndex->nKeyCol+1;
1554#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan4eed0532015-04-20 15:13:08 +00001555 /* Index.aiRowEst may already be set here if there are duplicate
1556 ** sqlite_stat1 entries for this index. In that case just clobber
1557 ** the old data with the new instead of allocating a new array. */
1558 if( pIndex->aiRowEst==0 ){
1559 pIndex->aiRowEst = (tRowcnt*)sqlite3MallocZero(sizeof(tRowcnt) * nCol);
drh4a642b62016-02-05 01:55:27 +00001560 if( pIndex->aiRowEst==0 ) sqlite3OomFault(pInfo->db);
dan4eed0532015-04-20 15:13:08 +00001561 }
1562 aiRowEst = pIndex->aiRowEst;
dan43085d72014-10-03 19:16:53 +00001563#endif
drh25df48d2014-07-22 14:58:12 +00001564 pIndex->bUnordered = 0;
dan43085d72014-10-03 19:16:53 +00001565 decodeIntArray((char*)z, nCol, aiRowEst, pIndex->aiRowLogEst, pIndex);
drh33bec3f2017-02-17 13:38:15 +00001566 pIndex->hasStat1 = 1;
1567 if( pIndex->pPartIdxWhere==0 ){
1568 pTable->nRowLogEst = pIndex->aiRowLogEst[0];
1569 pTable->tabFlags |= TF_HasStat1;
1570 }
danf52bb8d2013-08-03 20:24:58 +00001571 }else{
drh52f6c912013-10-06 22:12:41 +00001572 Index fakeIdx;
1573 fakeIdx.szIdxRow = pTable->szTabRow;
drhdbd94862014-07-23 23:57:42 +00001574#ifdef SQLITE_ENABLE_COSTMULT
1575 fakeIdx.pTable = pTable;
1576#endif
dancfc9df72014-04-25 15:01:01 +00001577 decodeIntArray((char*)z, 1, 0, &pTable->nRowLogEst, &fakeIdx);
drh52f6c912013-10-06 22:12:41 +00001578 pTable->szTabRow = fakeIdx.szIdxRow;
drh33bec3f2017-02-17 13:38:15 +00001579 pTable->tabFlags |= TF_HasStat1;
drh497e4462005-07-23 03:18:40 +00001580 }
danf52bb8d2013-08-03 20:24:58 +00001581
drh497e4462005-07-23 03:18:40 +00001582 return 0;
1583}
1584
1585/*
dan85c165c2009-08-19 14:34:54 +00001586** If the Index.aSample variable is not NULL, delete the aSample[] array
1587** and its contents.
1588*/
dand46def72010-07-24 11:28:28 +00001589void sqlite3DeleteIndexSamples(sqlite3 *db, Index *pIdx){
drh1435a9a2013-08-27 23:15:44 +00001590#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan85c165c2009-08-19 14:34:54 +00001591 if( pIdx->aSample ){
1592 int j;
drhfaacf172011-08-12 01:51:45 +00001593 for(j=0; j<pIdx->nSample; j++){
dan85c165c2009-08-19 14:34:54 +00001594 IndexSample *p = &pIdx->aSample[j];
danf52bb8d2013-08-03 20:24:58 +00001595 sqlite3DbFree(db, p->p);
dan85c165c2009-08-19 14:34:54 +00001596 }
drh8e3937f2011-08-18 13:45:23 +00001597 sqlite3DbFree(db, pIdx->aSample);
dan85c165c2009-08-19 14:34:54 +00001598 }
drh8e3937f2011-08-18 13:45:23 +00001599 if( db && db->pnBytesFreed==0 ){
1600 pIdx->nSample = 0;
1601 pIdx->aSample = 0;
1602 }
shanecea72b22009-09-07 04:38:36 +00001603#else
drh43b18e12010-08-17 19:40:08 +00001604 UNUSED_PARAMETER(db);
shanecea72b22009-09-07 04:38:36 +00001605 UNUSED_PARAMETER(pIdx);
drh1435a9a2013-08-27 23:15:44 +00001606#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
dan85c165c2009-08-19 14:34:54 +00001607}
1608
drh1435a9a2013-08-27 23:15:44 +00001609#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dan0adbed82013-08-15 19:56:32 +00001610/*
1611** Populate the pIdx->aAvgEq[] array based on the samples currently
1612** stored in pIdx->aSample[].
1613*/
1614static void initAvgEq(Index *pIdx){
1615 if( pIdx ){
1616 IndexSample *aSample = pIdx->aSample;
1617 IndexSample *pFinal = &aSample[pIdx->nSample-1];
1618 int iCol;
dan39caccf2014-07-01 11:54:02 +00001619 int nCol = 1;
1620 if( pIdx->nSampleCol>1 ){
1621 /* If this is stat4 data, then calculate aAvgEq[] values for all
1622 ** sample columns except the last. The last is always set to 1, as
1623 ** once the trailing PK fields are considered all index keys are
1624 ** unique. */
1625 nCol = pIdx->nSampleCol-1;
1626 pIdx->aAvgEq[nCol] = 1;
1627 }
1628 for(iCol=0; iCol<nCol; iCol++){
dan43085d72014-10-03 19:16:53 +00001629 int nSample = pIdx->nSample;
dan0adbed82013-08-15 19:56:32 +00001630 int i; /* Used to iterate through samples */
1631 tRowcnt sumEq = 0; /* Sum of the nEq values */
dan0adbed82013-08-15 19:56:32 +00001632 tRowcnt avgEq = 0;
dan43085d72014-10-03 19:16:53 +00001633 tRowcnt nRow; /* Number of rows in index */
1634 i64 nSum100 = 0; /* Number of terms contributing to sumEq */
1635 i64 nDist100; /* Number of distinct values in index */
1636
dan5cca94e2014-12-05 21:04:26 +00001637 if( !pIdx->aiRowEst || iCol>=pIdx->nKeyCol || pIdx->aiRowEst[iCol+1]==0 ){
dan43085d72014-10-03 19:16:53 +00001638 nRow = pFinal->anLt[iCol];
1639 nDist100 = (i64)100 * pFinal->anDLt[iCol];
1640 nSample--;
1641 }else{
1642 nRow = pIdx->aiRowEst[0];
1643 nDist100 = ((i64)100 * pIdx->aiRowEst[0]) / pIdx->aiRowEst[iCol+1];
1644 }
drh9f07cf72014-10-22 15:27:05 +00001645 pIdx->nRowEst0 = nRow;
dan0adbed82013-08-15 19:56:32 +00001646
1647 /* Set nSum to the number of distinct (iCol+1) field prefixes that
dan43085d72014-10-03 19:16:53 +00001648 ** occur in the stat4 table for this index. Set sumEq to the sum of
1649 ** the nEq values for column iCol for the same set (adding the value
1650 ** only once where there exist duplicate prefixes). */
1651 for(i=0; i<nSample; i++){
1652 if( i==(pIdx->nSample-1)
1653 || aSample[i].anDLt[iCol]!=aSample[i+1].anDLt[iCol]
1654 ){
dan0adbed82013-08-15 19:56:32 +00001655 sumEq += aSample[i].anEq[iCol];
dan43085d72014-10-03 19:16:53 +00001656 nSum100 += 100;
dan0adbed82013-08-15 19:56:32 +00001657 }
1658 }
dan43085d72014-10-03 19:16:53 +00001659
drh785d8ed2017-01-11 14:15:29 +00001660 if( nDist100>nSum100 && sumEq<nRow ){
dan43085d72014-10-03 19:16:53 +00001661 avgEq = ((i64)100 * (nRow - sumEq))/(nDist100 - nSum100);
dan0adbed82013-08-15 19:56:32 +00001662 }
1663 if( avgEq==0 ) avgEq = 1;
1664 pIdx->aAvgEq[iCol] = avgEq;
dan0adbed82013-08-15 19:56:32 +00001665 }
1666 }
1667}
1668
dan0106e372013-08-12 16:34:32 +00001669/*
drhce95d112013-11-02 19:34:38 +00001670** Look up an index by name. Or, if the name of a WITHOUT ROWID table
1671** is supplied instead, find the PRIMARY KEY index for that table.
1672*/
1673static Index *findIndexOrPrimaryKey(
1674 sqlite3 *db,
1675 const char *zName,
1676 const char *zDb
1677){
1678 Index *pIdx = sqlite3FindIndex(db, zName, zDb);
1679 if( pIdx==0 ){
1680 Table *pTab = sqlite3FindTable(db, zName, zDb);
1681 if( pTab && !HasRowid(pTab) ) pIdx = sqlite3PrimaryKeyIndex(pTab);
1682 }
1683 return pIdx;
1684}
1685
1686/*
dan0106e372013-08-12 16:34:32 +00001687** Load the content from either the sqlite_stat4 or sqlite_stat3 table
1688** into the relevant Index.aSample[] arrays.
1689**
1690** Arguments zSql1 and zSql2 must point to SQL statements that return
1691** data equivalent to the following (statements are different for stat3,
1692** see the caller of this function for details):
1693**
1694** zSql1: SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx
1695** zSql2: SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4
1696**
1697** where %Q is replaced with the database name before the SQL is executed.
1698*/
1699static int loadStatTbl(
1700 sqlite3 *db, /* Database handle */
1701 int bStat3, /* Assume single column records only */
1702 const char *zSql1, /* SQL statement 1 (see above) */
1703 const char *zSql2, /* SQL statement 2 (see above) */
1704 const char *zDb /* Database name (e.g. "main") */
1705){
drhfaacf172011-08-12 01:51:45 +00001706 int rc; /* Result codes from subroutines */
1707 sqlite3_stmt *pStmt = 0; /* An SQL statement being run */
1708 char *zSql; /* Text of the SQL statement */
1709 Index *pPrevIdx = 0; /* Previous index in the loop */
drhfaacf172011-08-12 01:51:45 +00001710 IndexSample *pSample; /* A slot in pIdx->aSample[] */
1711
drh4a642b62016-02-05 01:55:27 +00001712 assert( db->lookaside.bDisable );
dan0106e372013-08-12 16:34:32 +00001713 zSql = sqlite3MPrintf(db, zSql1, zDb);
drhfaacf172011-08-12 01:51:45 +00001714 if( !zSql ){
mistachkinfad30392016-02-13 23:43:46 +00001715 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001716 }
1717 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1718 sqlite3DbFree(db, zSql);
1719 if( rc ) return rc;
1720
1721 while( sqlite3_step(pStmt)==SQLITE_ROW ){
dan0106e372013-08-12 16:34:32 +00001722 int nIdxCol = 1; /* Number of columns in stat4 records */
dan0106e372013-08-12 16:34:32 +00001723
drhfaacf172011-08-12 01:51:45 +00001724 char *zIndex; /* Index name */
1725 Index *pIdx; /* Pointer to the index object */
1726 int nSample; /* Number of samples */
danf52bb8d2013-08-03 20:24:58 +00001727 int nByte; /* Bytes of space required */
1728 int i; /* Bytes of space required */
1729 tRowcnt *pSpace;
drhfaacf172011-08-12 01:51:45 +00001730
1731 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1732 if( zIndex==0 ) continue;
1733 nSample = sqlite3_column_int(pStmt, 1);
drhce95d112013-11-02 19:34:38 +00001734 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
dan86f69d92013-08-12 17:31:32 +00001735 assert( pIdx==0 || bStat3 || pIdx->nSample==0 );
1736 /* Index.nSample is non-zero at this point if data has already been
1737 ** loaded from the stat4 table. In this case ignore stat3 data. */
1738 if( pIdx==0 || pIdx->nSample ) continue;
dan0106e372013-08-12 16:34:32 +00001739 if( bStat3==0 ){
dan39caccf2014-07-01 11:54:02 +00001740 assert( !HasRowid(pIdx->pTable) || pIdx->nColumn==pIdx->nKeyCol+1 );
1741 if( !HasRowid(pIdx->pTable) && IsPrimaryKeyIndex(pIdx) ){
1742 nIdxCol = pIdx->nKeyCol;
1743 }else{
1744 nIdxCol = pIdx->nColumn;
1745 }
dan0106e372013-08-12 16:34:32 +00001746 }
dan8ad169a2013-08-12 20:14:04 +00001747 pIdx->nSampleCol = nIdxCol;
danf52bb8d2013-08-03 20:24:58 +00001748 nByte = sizeof(IndexSample) * nSample;
dan0106e372013-08-12 16:34:32 +00001749 nByte += sizeof(tRowcnt) * nIdxCol * 3 * nSample;
dan39caccf2014-07-01 11:54:02 +00001750 nByte += nIdxCol * sizeof(tRowcnt); /* Space for Index.aAvgEq[] */
danf52bb8d2013-08-03 20:24:58 +00001751
1752 pIdx->aSample = sqlite3DbMallocZero(db, nByte);
drhfaacf172011-08-12 01:51:45 +00001753 if( pIdx->aSample==0 ){
drhfaacf172011-08-12 01:51:45 +00001754 sqlite3_finalize(pStmt);
mistachkinfad30392016-02-13 23:43:46 +00001755 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001756 }
danf52bb8d2013-08-03 20:24:58 +00001757 pSpace = (tRowcnt*)&pIdx->aSample[nSample];
dan39caccf2014-07-01 11:54:02 +00001758 pIdx->aAvgEq = pSpace; pSpace += nIdxCol;
dan0adbed82013-08-15 19:56:32 +00001759 for(i=0; i<nSample; i++){
dan0106e372013-08-12 16:34:32 +00001760 pIdx->aSample[i].anEq = pSpace; pSpace += nIdxCol;
1761 pIdx->aSample[i].anLt = pSpace; pSpace += nIdxCol;
1762 pIdx->aSample[i].anDLt = pSpace; pSpace += nIdxCol;
danf52bb8d2013-08-03 20:24:58 +00001763 }
1764 assert( ((u8*)pSpace)-nByte==(u8*)(pIdx->aSample) );
drhfaacf172011-08-12 01:51:45 +00001765 }
drh8e3937f2011-08-18 13:45:23 +00001766 rc = sqlite3_finalize(pStmt);
1767 if( rc ) return rc;
drhfaacf172011-08-12 01:51:45 +00001768
dan0106e372013-08-12 16:34:32 +00001769 zSql = sqlite3MPrintf(db, zSql2, zDb);
drhfaacf172011-08-12 01:51:45 +00001770 if( !zSql ){
mistachkinfad30392016-02-13 23:43:46 +00001771 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001772 }
1773 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1774 sqlite3DbFree(db, zSql);
1775 if( rc ) return rc;
1776
1777 while( sqlite3_step(pStmt)==SQLITE_ROW ){
dan0106e372013-08-12 16:34:32 +00001778 char *zIndex; /* Index name */
1779 Index *pIdx; /* Pointer to the index object */
dan0106e372013-08-12 16:34:32 +00001780 int nCol = 1; /* Number of columns in index */
drhfaacf172011-08-12 01:51:45 +00001781
1782 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1783 if( zIndex==0 ) continue;
drhce95d112013-11-02 19:34:38 +00001784 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
drhfaacf172011-08-12 01:51:45 +00001785 if( pIdx==0 ) continue;
dan86f69d92013-08-12 17:31:32 +00001786 /* This next condition is true if data has already been loaded from
1787 ** the sqlite_stat4 table. In this case ignore stat3 data. */
dan0adbed82013-08-15 19:56:32 +00001788 nCol = pIdx->nSampleCol;
1789 if( bStat3 && nCol>1 ) continue;
1790 if( pIdx!=pPrevIdx ){
1791 initAvgEq(pPrevIdx);
1792 pPrevIdx = pIdx;
dan0106e372013-08-12 16:34:32 +00001793 }
danc367d4c2013-08-16 14:09:43 +00001794 pSample = &pIdx->aSample[pIdx->nSample];
dancfc9df72014-04-25 15:01:01 +00001795 decodeIntArray((char*)sqlite3_column_text(pStmt,1),nCol,pSample->anEq,0,0);
1796 decodeIntArray((char*)sqlite3_column_text(pStmt,2),nCol,pSample->anLt,0,0);
1797 decodeIntArray((char*)sqlite3_column_text(pStmt,3),nCol,pSample->anDLt,0,0);
danf52bb8d2013-08-03 20:24:58 +00001798
danc367d4c2013-08-16 14:09:43 +00001799 /* Take a copy of the sample. Add two 0x00 bytes the end of the buffer.
1800 ** This is in case the sample record is corrupted. In that case, the
1801 ** sqlite3VdbeRecordCompare() may read up to two varints past the
1802 ** end of the allocated buffer before it realizes it is dealing with
1803 ** a corrupt record. Adding the two 0x00 bytes prevents this from causing
1804 ** a buffer overread. */
danf52bb8d2013-08-03 20:24:58 +00001805 pSample->n = sqlite3_column_bytes(pStmt, 4);
danc367d4c2013-08-16 14:09:43 +00001806 pSample->p = sqlite3DbMallocZero(db, pSample->n + 2);
danf52bb8d2013-08-03 20:24:58 +00001807 if( pSample->p==0 ){
1808 sqlite3_finalize(pStmt);
mistachkinfad30392016-02-13 23:43:46 +00001809 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001810 }
dan895decf2016-12-30 14:15:56 +00001811 if( pSample->n ){
1812 memcpy(pSample->p, sqlite3_column_blob(pStmt, 4), pSample->n);
1813 }
danc367d4c2013-08-16 14:09:43 +00001814 pIdx->nSample++;
drhfaacf172011-08-12 01:51:45 +00001815 }
drh61b34402013-08-16 13:34:50 +00001816 rc = sqlite3_finalize(pStmt);
1817 if( rc==SQLITE_OK ) initAvgEq(pPrevIdx);
1818 return rc;
drhfaacf172011-08-12 01:51:45 +00001819}
dan0106e372013-08-12 16:34:32 +00001820
1821/*
1822** Load content from the sqlite_stat4 and sqlite_stat3 tables into
1823** the Index.aSample[] arrays of all indices.
1824*/
1825static int loadStat4(sqlite3 *db, const char *zDb){
1826 int rc = SQLITE_OK; /* Result codes from subroutines */
1827
drh4a642b62016-02-05 01:55:27 +00001828 assert( db->lookaside.bDisable );
dan0106e372013-08-12 16:34:32 +00001829 if( sqlite3FindTable(db, "sqlite_stat4", zDb) ){
1830 rc = loadStatTbl(db, 0,
1831 "SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx",
1832 "SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4",
1833 zDb
1834 );
1835 }
1836
1837 if( rc==SQLITE_OK && sqlite3FindTable(db, "sqlite_stat3", zDb) ){
1838 rc = loadStatTbl(db, 1,
1839 "SELECT idx,count(*) FROM %Q.sqlite_stat3 GROUP BY idx",
1840 "SELECT idx,neq,nlt,ndlt,sqlite_record(sample) FROM %Q.sqlite_stat3",
1841 zDb
1842 );
1843 }
1844
1845 return rc;
1846}
drh1435a9a2013-08-27 23:15:44 +00001847#endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
drhfaacf172011-08-12 01:51:45 +00001848
1849/*
drh92707ac2013-08-17 18:57:15 +00001850** Load the content of the sqlite_stat1 and sqlite_stat3/4 tables. The
dan85c165c2009-08-19 14:34:54 +00001851** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
drh92707ac2013-08-17 18:57:15 +00001852** arrays. The contents of sqlite_stat3/4 are used to populate the
dan85c165c2009-08-19 14:34:54 +00001853** Index.aSample[] arrays.
1854**
1855** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
drh92707ac2013-08-17 18:57:15 +00001856** is returned. In this case, even if SQLITE_ENABLE_STAT3/4 was defined
1857** during compilation and the sqlite_stat3/4 table is present, no data is
dan85c165c2009-08-19 14:34:54 +00001858** read from it.
1859**
drh92707ac2013-08-17 18:57:15 +00001860** If SQLITE_ENABLE_STAT3/4 was defined during compilation and the
danf52bb8d2013-08-03 20:24:58 +00001861** sqlite_stat4 table is not present in the database, SQLITE_ERROR is
dan85c165c2009-08-19 14:34:54 +00001862** returned. However, in this case, data is read from the sqlite_stat1
1863** table (if it is present) before returning.
1864**
1865** If an OOM error occurs, this function always sets db->mallocFailed.
1866** This means if the caller does not care about other errors, the return
1867** code may be ignored.
drh497e4462005-07-23 03:18:40 +00001868*/
drhcf1be452007-05-12 12:08:51 +00001869int sqlite3AnalysisLoad(sqlite3 *db, int iDb){
drh497e4462005-07-23 03:18:40 +00001870 analysisInfo sInfo;
1871 HashElem *i;
1872 char *zSql;
drh51b55a32016-04-04 12:38:05 +00001873 int rc = SQLITE_OK;
drh33bec3f2017-02-17 13:38:15 +00001874 Schema *pSchema = db->aDb[iDb].pSchema;
drh497e4462005-07-23 03:18:40 +00001875
drhff0587c2007-08-29 17:43:19 +00001876 assert( iDb>=0 && iDb<db->nDb );
1877 assert( db->aDb[iDb].pBt!=0 );
drh1fee73e2007-08-29 04:00:57 +00001878
drh497e4462005-07-23 03:18:40 +00001879 /* Clear any prior statistics */
drh21206082011-04-04 18:22:02 +00001880 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drh33bec3f2017-02-17 13:38:15 +00001881 for(i=sqliteHashFirst(&pSchema->tblHash); i; i=sqliteHashNext(i)){
1882 Table *pTab = sqliteHashData(i);
1883 pTab->tabFlags &= ~TF_HasStat1;
1884 }
1885 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
drh497e4462005-07-23 03:18:40 +00001886 Index *pIdx = sqliteHashData(i);
drh33bec3f2017-02-17 13:38:15 +00001887 pIdx->hasStat1 = 0;
drh1435a9a2013-08-27 23:15:44 +00001888#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
dand46def72010-07-24 11:28:28 +00001889 sqlite3DeleteIndexSamples(db, pIdx);
1890 pIdx->aSample = 0;
drhfaacf172011-08-12 01:51:45 +00001891#endif
drh497e4462005-07-23 03:18:40 +00001892 }
1893
drhf6661a82016-04-01 12:35:22 +00001894 /* Load new statistics out of the sqlite_stat1 table */
drh497e4462005-07-23 03:18:40 +00001895 sInfo.db = db;
drh69c33822016-08-18 14:33:11 +00001896 sInfo.zDatabase = db->aDb[iDb].zDbSName;
drhf6661a82016-04-01 12:35:22 +00001897 if( sqlite3FindTable(db, "sqlite_stat1", sInfo.zDatabase)!=0 ){
1898 zSql = sqlite3MPrintf(db,
1899 "SELECT tbl,idx,stat FROM %Q.sqlite_stat1", sInfo.zDatabase);
1900 if( zSql==0 ){
1901 rc = SQLITE_NOMEM_BKPT;
1902 }else{
1903 rc = sqlite3_exec(db, zSql, analysisLoader, &sInfo, 0);
1904 sqlite3DbFree(db, zSql);
1905 }
drh497e4462005-07-23 03:18:40 +00001906 }
1907
drhf6661a82016-04-01 12:35:22 +00001908 /* Set appropriate defaults on all indexes not in the sqlite_stat1 table */
1909 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drh33bec3f2017-02-17 13:38:15 +00001910 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
drhf6661a82016-04-01 12:35:22 +00001911 Index *pIdx = sqliteHashData(i);
drh33bec3f2017-02-17 13:38:15 +00001912 if( !pIdx->hasStat1 ) sqlite3DefaultRowEst(pIdx);
drhf16ce3b2009-02-13 16:59:53 +00001913 }
dan02fa4692009-08-17 17:06:58 +00001914
danf52bb8d2013-08-03 20:24:58 +00001915 /* Load the statistics from the sqlite_stat4 table. */
drh1435a9a2013-08-27 23:15:44 +00001916#ifdef SQLITE_ENABLE_STAT3_OR_STAT4
drh72d03a62018-07-20 19:24:02 +00001917 if( rc==SQLITE_OK ){
drh4a642b62016-02-05 01:55:27 +00001918 db->lookaside.bDisable++;
danf52bb8d2013-08-03 20:24:58 +00001919 rc = loadStat4(db, sInfo.zDatabase);
drh4a642b62016-02-05 01:55:27 +00001920 db->lookaside.bDisable--;
dan02fa4692009-08-17 17:06:58 +00001921 }
drh33bec3f2017-02-17 13:38:15 +00001922 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
dan43085d72014-10-03 19:16:53 +00001923 Index *pIdx = sqliteHashData(i);
drh75b170b2014-10-04 00:07:44 +00001924 sqlite3_free(pIdx->aiRowEst);
dan43085d72014-10-03 19:16:53 +00001925 pIdx->aiRowEst = 0;
1926 }
dan69188d92009-08-19 08:18:32 +00001927#endif
dan02fa4692009-08-17 17:06:58 +00001928
dane275dc32009-08-18 16:24:58 +00001929 if( rc==SQLITE_NOMEM ){
drh4a642b62016-02-05 01:55:27 +00001930 sqlite3OomFault(db);
dane275dc32009-08-18 16:24:58 +00001931 }
drhcf1be452007-05-12 12:08:51 +00001932 return rc;
drh497e4462005-07-23 03:18:40 +00001933}
drh9f18e8a2005-07-08 12:13:04 +00001934
drhff2d5ea2005-07-23 00:41:48 +00001935
drh9f18e8a2005-07-08 12:13:04 +00001936#endif /* SQLITE_OMIT_ANALYZE */