blob: eee71fbbde481612e8e329eb492474aaf98dfb86 [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
drh175b8f02019-08-08 15:24:17 +000030** created and used by SQLite versions 3.7.9 through 3.29.0 when
drhc8af8502013-08-09 14:07:55 +000031** SQLITE_ENABLE_STAT3 defined. The functionality of sqlite_stat3
drh175b8f02019-08-08 15:24:17 +000032** is a superset of sqlite_stat2 and is also now deprecated. The
33** sqlite_stat4 is an enhanced version of sqlite_stat3 and is only
34** available when compiled with SQLITE_ENABLE_STAT4 and in SQLite
35** versions 3.8.1 and later. STAT4 is the only variant that is still
36** supported.
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
danf00e9022013-08-14 19:54:12 +0000147#else
drh92707ac2013-08-17 18:57:15 +0000148# define IsStat4 0
drh9fecc542013-08-27 20:16:48 +0000149# undef SQLITE_STAT4_SAMPLES
150# define SQLITE_STAT4_SAMPLES 1
dan8ad169a2013-08-12 20:14:04 +0000151#endif
152
drh9f18e8a2005-07-08 12:13:04 +0000153/*
drh9fecc542013-08-27 20:16:48 +0000154** This routine generates code that opens the sqlite_statN tables.
155** The sqlite_stat1 table is always relevant. sqlite_stat2 is now
156** obsolete. sqlite_stat3 and sqlite_stat4 are only opened when
157** appropriate compile-time options are provided.
drhff2d5ea2005-07-23 00:41:48 +0000158**
drh9fecc542013-08-27 20:16:48 +0000159** If the sqlite_statN tables do not previously exist, it is created.
dan69188d92009-08-19 08:18:32 +0000160**
161** Argument zWhere may be a pointer to a buffer containing a table name,
162** or it may be a NULL pointer. If it is not NULL, then all entries in
drh9fecc542013-08-27 20:16:48 +0000163** the sqlite_statN tables associated with the named table are deleted.
164** If zWhere==0, then code is generated to delete all stat table entries.
drhff2d5ea2005-07-23 00:41:48 +0000165*/
166static void openStatTable(
167 Parse *pParse, /* Parsing context */
168 int iDb, /* The database we are looking in */
169 int iStatCur, /* Open the sqlite_stat1 table on this cursor */
drha071bc52011-03-31 02:03:28 +0000170 const char *zWhere, /* Delete entries for this table or index */
171 const char *zWhereType /* Either "tbl" or "idx" */
drhff2d5ea2005-07-23 00:41:48 +0000172){
dan558814f2010-06-02 05:53:53 +0000173 static const struct {
dan69188d92009-08-19 08:18:32 +0000174 const char *zName;
175 const char *zCols;
176 } aTable[] = {
177 { "sqlite_stat1", "tbl,idx,stat" },
dan0106e372013-08-12 16:34:32 +0000178#if defined(SQLITE_ENABLE_STAT4)
danf52bb8d2013-08-03 20:24:58 +0000179 { "sqlite_stat4", "tbl,idx,neq,nlt,ndlt,sample" },
drh9fecc542013-08-27 20:16:48 +0000180#else
drh9fecc542013-08-27 20:16:48 +0000181 { "sqlite_stat4", 0 },
drhfaacf172011-08-12 01:51:45 +0000182#endif
drh175b8f02019-08-08 15:24:17 +0000183 { "sqlite_stat3", 0 },
drhfaacf172011-08-12 01:51:45 +0000184 };
dan02fa4692009-08-17 17:06:58 +0000185 int i;
drhff2d5ea2005-07-23 00:41:48 +0000186 sqlite3 *db = pParse->db;
187 Db *pDb;
drhff2d5ea2005-07-23 00:41:48 +0000188 Vdbe *v = sqlite3GetVdbe(pParse);
drh9fecc542013-08-27 20:16:48 +0000189 int aRoot[ArraySize(aTable)];
190 u8 aCreateTbl[ArraySize(aTable)];
191
drhcf1be452007-05-12 12:08:51 +0000192 if( v==0 ) return;
drh1fee73e2007-08-29 04:00:57 +0000193 assert( sqlite3BtreeHoldsAllMutexes(db) );
194 assert( sqlite3VdbeDb(v)==db );
drhff2d5ea2005-07-23 00:41:48 +0000195 pDb = &db->aDb[iDb];
dan02fa4692009-08-17 17:06:58 +0000196
drhfaacf172011-08-12 01:51:45 +0000197 /* Create new statistic tables if they do not exist, or clear them
198 ** if they do already exist.
199 */
dan69188d92009-08-19 08:18:32 +0000200 for(i=0; i<ArraySize(aTable); i++){
201 const char *zTab = aTable[i].zName;
dan02fa4692009-08-17 17:06:58 +0000202 Table *pStat;
drh69c33822016-08-18 14:33:11 +0000203 if( (pStat = sqlite3FindTable(db, zTab, pDb->zDbSName))==0 ){
dan8ad169a2013-08-12 20:14:04 +0000204 if( aTable[i].zCols ){
drh9fecc542013-08-27 20:16:48 +0000205 /* The sqlite_statN table does not exist. Create it. Note that a
dan8ad169a2013-08-12 20:14:04 +0000206 ** side-effect of the CREATE TABLE statement is to leave the rootpage
207 ** of the new table in register pParse->regRoot. This is important
208 ** because the OpenWrite opcode below will be needing it. */
209 sqlite3NestedParse(pParse,
drh69c33822016-08-18 14:33:11 +0000210 "CREATE TABLE %Q.%s(%s)", pDb->zDbSName, zTab, aTable[i].zCols
dan8ad169a2013-08-12 20:14:04 +0000211 );
212 aRoot[i] = pParse->regRoot;
213 aCreateTbl[i] = OPFLAG_P2ISREG;
214 }
dan02fa4692009-08-17 17:06:58 +0000215 }else{
216 /* The table already exists. If zWhere is not NULL, delete all entries
217 ** associated with the table zWhere. If zWhere is NULL, delete the
218 ** entire contents of the table. */
219 aRoot[i] = pStat->tnum;
drh9fecc542013-08-27 20:16:48 +0000220 aCreateTbl[i] = 0;
dan69188d92009-08-19 08:18:32 +0000221 sqlite3TableLock(pParse, iDb, aRoot[i], 1, zTab);
dan02fa4692009-08-17 17:06:58 +0000222 if( zWhere ){
223 sqlite3NestedParse(pParse,
drh1435a9a2013-08-27 23:15:44 +0000224 "DELETE FROM %Q.%s WHERE %s=%Q",
drh69c33822016-08-18 14:33:11 +0000225 pDb->zDbSName, zTab, zWhereType, zWhere
dan02fa4692009-08-17 17:06:58 +0000226 );
dan614efe22018-01-12 16:44:29 +0000227#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
228 }else if( db->xPreUpdateCallback ){
229 sqlite3NestedParse(pParse, "DELETE FROM %Q.%s", pDb->zDbSName, zTab);
230#endif
dan02fa4692009-08-17 17:06:58 +0000231 }else{
dan8ad169a2013-08-12 20:14:04 +0000232 /* The sqlite_stat[134] table already exists. Delete all rows. */
dan02fa4692009-08-17 17:06:58 +0000233 sqlite3VdbeAddOp2(v, OP_Clear, aRoot[i], iDb);
234 }
235 }
drhff2d5ea2005-07-23 00:41:48 +0000236 }
237
danf00e9022013-08-14 19:54:12 +0000238 /* Open the sqlite_stat[134] tables for writing. */
drh1435a9a2013-08-27 23:15:44 +0000239 for(i=0; aTable[i].zCols; i++){
240 assert( i<ArraySize(aTable) );
drh261c02d2013-10-25 14:46:15 +0000241 sqlite3VdbeAddOp4Int(v, OP_OpenWrite, iStatCur+i, aRoot[i], iDb, 3);
drh1435a9a2013-08-27 23:15:44 +0000242 sqlite3VdbeChangeP5(v, aCreateTbl[i]);
drhec9e55d2014-06-30 17:07:39 +0000243 VdbeComment((v, aTable[i].zName));
danielk1977c00da102006-01-07 13:21:04 +0000244 }
drhff2d5ea2005-07-23 00:41:48 +0000245}
246
247/*
danf52bb8d2013-08-03 20:24:58 +0000248** Recommended number of samples for sqlite_stat4
drhfaacf172011-08-12 01:51:45 +0000249*/
danf52bb8d2013-08-03 20:24:58 +0000250#ifndef SQLITE_STAT4_SAMPLES
251# define SQLITE_STAT4_SAMPLES 24
drhfaacf172011-08-12 01:51:45 +0000252#endif
253
254/*
danf00e9022013-08-14 19:54:12 +0000255** Three SQL functions - stat_init(), stat_push(), and stat_get() -
drhade3add2011-08-13 00:58:05 +0000256** share an instance of the following structure to hold their state
257** information.
258*/
drhafa1eca2020-03-09 18:26:11 +0000259typedef struct StatAccum StatAccum;
260typedef struct StatSample StatSample;
261struct StatSample {
danf00e9022013-08-14 19:54:12 +0000262 tRowcnt *anEq; /* sqlite_stat4.nEq */
danf00e9022013-08-14 19:54:12 +0000263 tRowcnt *anDLt; /* sqlite_stat4.nDLt */
drh175b8f02019-08-08 15:24:17 +0000264#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +0000265 tRowcnt *anLt; /* sqlite_stat4.nLt */
drhda475b82013-11-04 21:44:54 +0000266 union {
267 i64 iRowid; /* Rowid in main table of the key */
268 u8 *aRowid; /* Key for WITHOUT ROWID tables */
269 } u;
drhebe25af2013-11-02 18:46:04 +0000270 u32 nRowid; /* Sizeof aRowid[] */
danf00e9022013-08-14 19:54:12 +0000271 u8 isPSample; /* True if a periodic sample */
272 int iCol; /* If !isPSample, the reason for inclusion */
273 u32 iHash; /* Tiebreaker hash */
drh9fecc542013-08-27 20:16:48 +0000274#endif
danf00e9022013-08-14 19:54:12 +0000275};
drhafa1eca2020-03-09 18:26:11 +0000276struct StatAccum {
277 sqlite3 *db; /* Database connection, for malloc() */
drhade3add2011-08-13 00:58:05 +0000278 tRowcnt nRow; /* Number of rows in the entire table */
drhec9e55d2014-06-30 17:07:39 +0000279 int nCol; /* Number of columns in index + pk/rowid */
280 int nKeyCol; /* Number of index columns w/o the pk/rowid */
drhafa1eca2020-03-09 18:26:11 +0000281 StatSample current; /* Current row as a StatSample */
282#ifdef SQLITE_ENABLE_STAT4
283 tRowcnt nPSample; /* How often to do a periodic sample */
drhade3add2011-08-13 00:58:05 +0000284 int mxSample; /* Maximum number of samples to accumulate */
drhf404c862011-08-13 15:25:10 +0000285 u32 iPrn; /* Pseudo-random number used for sampling */
drhafa1eca2020-03-09 18:26:11 +0000286 StatSample *aBest; /* Array of nCol best samples */
danf00e9022013-08-14 19:54:12 +0000287 int iMin; /* Index in a[] of entry with minimum score */
288 int nSample; /* Current number of samples */
danbd1d2702017-02-22 19:27:51 +0000289 int nMaxEqZero; /* Max leading 0 in anEq[] for any a[] entry */
danf00e9022013-08-14 19:54:12 +0000290 int iGet; /* Index of current sample accessed by stat_get() */
drhafa1eca2020-03-09 18:26:11 +0000291 StatSample *a; /* Array of mxSample StatSample objects */
292#endif
drhade3add2011-08-13 00:58:05 +0000293};
294
drhafa1eca2020-03-09 18:26:11 +0000295/* Reclaim memory used by a StatSample
drhebe25af2013-11-02 18:46:04 +0000296*/
drh175b8f02019-08-08 15:24:17 +0000297#ifdef SQLITE_ENABLE_STAT4
drhafa1eca2020-03-09 18:26:11 +0000298static void sampleClear(sqlite3 *db, StatSample *p){
drhda475b82013-11-04 21:44:54 +0000299 assert( db!=0 );
300 if( p->nRowid ){
301 sqlite3DbFree(db, p->u.aRowid);
302 p->nRowid = 0;
303 }
drhebe25af2013-11-02 18:46:04 +0000304}
305#endif
306
drhda475b82013-11-04 21:44:54 +0000307/* Initialize the BLOB value of a ROWID
drhebe25af2013-11-02 18:46:04 +0000308*/
drh175b8f02019-08-08 15:24:17 +0000309#ifdef SQLITE_ENABLE_STAT4
drhafa1eca2020-03-09 18:26:11 +0000310static void sampleSetRowid(sqlite3 *db, StatSample *p, int n, const u8 *pData){
drhda475b82013-11-04 21:44:54 +0000311 assert( db!=0 );
312 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
drh575fad62016-02-05 13:38:36 +0000313 p->u.aRowid = sqlite3DbMallocRawNN(db, n);
drhda475b82013-11-04 21:44:54 +0000314 if( p->u.aRowid ){
315 p->nRowid = n;
316 memcpy(p->u.aRowid, pData, n);
317 }else{
318 p->nRowid = 0;
319 }
320}
321#endif
322
323/* Initialize the INTEGER value of a ROWID.
324*/
drh175b8f02019-08-08 15:24:17 +0000325#ifdef SQLITE_ENABLE_STAT4
drhafa1eca2020-03-09 18:26:11 +0000326static void sampleSetRowidInt64(sqlite3 *db, StatSample *p, i64 iRowid){
drhda475b82013-11-04 21:44:54 +0000327 assert( db!=0 );
328 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
329 p->nRowid = 0;
330 p->u.iRowid = iRowid;
331}
332#endif
333
334
335/*
336** Copy the contents of object (*pFrom) into (*pTo).
337*/
drh175b8f02019-08-08 15:24:17 +0000338#ifdef SQLITE_ENABLE_STAT4
drhafa1eca2020-03-09 18:26:11 +0000339static void sampleCopy(StatAccum *p, StatSample *pTo, StatSample *pFrom){
drhda475b82013-11-04 21:44:54 +0000340 pTo->isPSample = pFrom->isPSample;
341 pTo->iCol = pFrom->iCol;
342 pTo->iHash = pFrom->iHash;
343 memcpy(pTo->anEq, pFrom->anEq, sizeof(tRowcnt)*p->nCol);
344 memcpy(pTo->anLt, pFrom->anLt, sizeof(tRowcnt)*p->nCol);
345 memcpy(pTo->anDLt, pFrom->anDLt, sizeof(tRowcnt)*p->nCol);
346 if( pFrom->nRowid ){
347 sampleSetRowid(p->db, pTo, pFrom->nRowid, pFrom->u.aRowid);
348 }else{
349 sampleSetRowidInt64(p->db, pTo, pFrom->u.iRowid);
drhebe25af2013-11-02 18:46:04 +0000350 }
351}
352#endif
353
354/*
drhafa1eca2020-03-09 18:26:11 +0000355** Reclaim all memory of a StatAccum structure.
drhebe25af2013-11-02 18:46:04 +0000356*/
drhafa1eca2020-03-09 18:26:11 +0000357static void statAccumDestructor(void *pOld){
358 StatAccum *p = (StatAccum*)pOld;
drh175b8f02019-08-08 15:24:17 +0000359#ifdef SQLITE_ENABLE_STAT4
drhebe25af2013-11-02 18:46:04 +0000360 int i;
361 for(i=0; i<p->nCol; i++) sampleClear(p->db, p->aBest+i);
362 for(i=0; i<p->mxSample; i++) sampleClear(p->db, p->a+i);
drhda475b82013-11-04 21:44:54 +0000363 sampleClear(p->db, &p->current);
drhebe25af2013-11-02 18:46:04 +0000364#endif
365 sqlite3DbFree(p->db, p);
366}
367
drhade3add2011-08-13 00:58:05 +0000368/*
drhec9e55d2014-06-30 17:07:39 +0000369** Implementation of the stat_init(N,K,C) SQL function. The three parameters
370** are:
drh553818a2014-07-23 18:36:55 +0000371** N: The number of columns in the index including the rowid/pk (note 1)
372** K: The number of columns in the index excluding the rowid/pk.
373** C: The number of rows in the index (note 2)
drhec9e55d2014-06-30 17:07:39 +0000374**
drh553818a2014-07-23 18:36:55 +0000375** Note 1: In the special case of the covering index that implements a
376** WITHOUT ROWID table, N is the number of PRIMARY KEY columns, not the
377** total number of columns in the table.
drhec9e55d2014-06-30 17:07:39 +0000378**
drh175b8f02019-08-08 15:24:17 +0000379** Note 2: C is only used for STAT4.
drh553818a2014-07-23 18:36:55 +0000380**
381** For indexes on ordinary rowid tables, N==K+1. But for indexes on
382** WITHOUT ROWID tables, N=K+P where P is the number of columns in the
383** PRIMARY KEY of the table. The covering index that implements the
384** original WITHOUT ROWID table as N==K as a special case.
drhade3add2011-08-13 00:58:05 +0000385**
drhafa1eca2020-03-09 18:26:11 +0000386** This routine allocates the StatAccum object in heap memory. The return
387** value is a pointer to the StatAccum object. The datatype of the
388** return value is BLOB, but it is really just a pointer to the StatAccum
drhf8ede572014-09-01 23:06:44 +0000389** object.
drhade3add2011-08-13 00:58:05 +0000390*/
danf00e9022013-08-14 19:54:12 +0000391static void statInit(
drhade3add2011-08-13 00:58:05 +0000392 sqlite3_context *context,
393 int argc,
394 sqlite3_value **argv
395){
drhafa1eca2020-03-09 18:26:11 +0000396 StatAccum *p;
danf52bb8d2013-08-03 20:24:58 +0000397 int nCol; /* Number of columns in index being sampled */
drhec9e55d2014-06-30 17:07:39 +0000398 int nKeyCol; /* Number of key columns */
drh9fecc542013-08-27 20:16:48 +0000399 int nColUp; /* nCol rounded up for alignment */
danf52bb8d2013-08-03 20:24:58 +0000400 int n; /* Bytes of space to allocate */
drhebe25af2013-11-02 18:46:04 +0000401 sqlite3 *db; /* Database connection */
drh175b8f02019-08-08 15:24:17 +0000402#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +0000403 int mxSample = SQLITE_STAT4_SAMPLES;
404#endif
drhade3add2011-08-13 00:58:05 +0000405
danf52bb8d2013-08-03 20:24:58 +0000406 /* Decode the three function arguments */
drh68257192011-08-16 17:06:21 +0000407 UNUSED_PARAMETER(argc);
drh9fecc542013-08-27 20:16:48 +0000408 nCol = sqlite3_value_int(argv[0]);
drhec9e55d2014-06-30 17:07:39 +0000409 assert( nCol>0 );
drh9fecc542013-08-27 20:16:48 +0000410 nColUp = sizeof(tRowcnt)<8 ? (nCol+1)&~1 : nCol;
drhec9e55d2014-06-30 17:07:39 +0000411 nKeyCol = sqlite3_value_int(argv[1]);
412 assert( nKeyCol<=nCol );
413 assert( nKeyCol>0 );
danf52bb8d2013-08-03 20:24:58 +0000414
drhafa1eca2020-03-09 18:26:11 +0000415 /* Allocate the space required for the StatAccum object */
danf00e9022013-08-14 19:54:12 +0000416 n = sizeof(*p)
drhafa1eca2020-03-09 18:26:11 +0000417 + sizeof(tRowcnt)*nColUp /* StatAccum.anEq */
418 + sizeof(tRowcnt)*nColUp /* StatAccum.anDLt */
drh175b8f02019-08-08 15:24:17 +0000419#ifdef SQLITE_ENABLE_STAT4
drhafa1eca2020-03-09 18:26:11 +0000420 + sizeof(tRowcnt)*nColUp /* StatAccum.anLt */
421 + sizeof(StatSample)*(nCol+mxSample) /* StatAccum.aBest[], a[] */
drh9fecc542013-08-27 20:16:48 +0000422 + sizeof(tRowcnt)*3*nColUp*(nCol+mxSample)
423#endif
424 ;
drhebe25af2013-11-02 18:46:04 +0000425 db = sqlite3_context_db_handle(context);
426 p = sqlite3DbMallocZero(db, n);
drhade3add2011-08-13 00:58:05 +0000427 if( p==0 ){
428 sqlite3_result_error_nomem(context);
429 return;
430 }
danf52bb8d2013-08-03 20:24:58 +0000431
drhebe25af2013-11-02 18:46:04 +0000432 p->db = db;
drh9fecc542013-08-27 20:16:48 +0000433 p->nRow = 0;
danf52bb8d2013-08-03 20:24:58 +0000434 p->nCol = nCol;
drhec9e55d2014-06-30 17:07:39 +0000435 p->nKeyCol = nKeyCol;
danf00e9022013-08-14 19:54:12 +0000436 p->current.anDLt = (tRowcnt*)&p[1];
drh9fecc542013-08-27 20:16:48 +0000437 p->current.anEq = &p->current.anDLt[nColUp];
danf00e9022013-08-14 19:54:12 +0000438
drh175b8f02019-08-08 15:24:17 +0000439#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +0000440 {
441 u8 *pSpace; /* Allocated space not yet assigned */
442 int i; /* Used to iterate through p->aSample[] */
danf52bb8d2013-08-03 20:24:58 +0000443
drh9fecc542013-08-27 20:16:48 +0000444 p->iGet = -1;
445 p->mxSample = mxSample;
drhec9e55d2014-06-30 17:07:39 +0000446 p->nPSample = (tRowcnt)(sqlite3_value_int64(argv[2])/(mxSample/3+1) + 1);
drh9fecc542013-08-27 20:16:48 +0000447 p->current.anLt = &p->current.anEq[nColUp];
drh4081d5d2015-01-01 23:02:01 +0000448 p->iPrn = 0x689e962d*(u32)nCol ^ 0xd0944565*(u32)sqlite3_value_int(argv[2]);
drh9fecc542013-08-27 20:16:48 +0000449
drhafa1eca2020-03-09 18:26:11 +0000450 /* Set up the StatAccum.a[] and aBest[] arrays */
451 p->a = (struct StatSample*)&p->current.anLt[nColUp];
drh9fecc542013-08-27 20:16:48 +0000452 p->aBest = &p->a[mxSample];
453 pSpace = (u8*)(&p->a[mxSample+nCol]);
454 for(i=0; i<(mxSample+nCol); i++){
455 p->a[i].anEq = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
456 p->a[i].anLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
457 p->a[i].anDLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
458 }
459 assert( (pSpace - (u8*)p)==n );
460
461 for(i=0; i<nCol; i++){
462 p->aBest[i].iCol = i;
463 }
danf00e9022013-08-14 19:54:12 +0000464 }
drh9fecc542013-08-27 20:16:48 +0000465#endif
danf00e9022013-08-14 19:54:12 +0000466
drhf8ede572014-09-01 23:06:44 +0000467 /* Return a pointer to the allocated object to the caller. Note that
468 ** only the pointer (the 2nd parameter) matters. The size of the object
469 ** (given by the 3rd parameter) is never used and can be any positive
470 ** value. */
drhafa1eca2020-03-09 18:26:11 +0000471 sqlite3_result_blob(context, p, sizeof(*p), statAccumDestructor);
drhade3add2011-08-13 00:58:05 +0000472}
danf00e9022013-08-14 19:54:12 +0000473static const FuncDef statInitFuncdef = {
drh175b8f02019-08-08 15:24:17 +0000474 2+IsStat4, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000475 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000476 0, /* pUserData */
477 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000478 statInit, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000479 0, /* xFinalize */
dan980cf252018-06-10 07:42:35 +0000480 0, 0, /* xValue, xInverse */
danf00e9022013-08-14 19:54:12 +0000481 "stat_init", /* zName */
drh80738d92016-02-15 00:34:16 +0000482 {0}
drhade3add2011-08-13 00:58:05 +0000483};
484
danb13af4c2013-09-03 14:43:12 +0000485#ifdef SQLITE_ENABLE_STAT4
486/*
487** pNew and pOld are both candidate non-periodic samples selected for
488** the same column (pNew->iCol==pOld->iCol). Ignoring this column and
489** considering only any trailing columns and the sample hash value, this
490** function returns true if sample pNew is to be preferred over pOld.
491** In other words, if we assume that the cardinalities of the selected
492** column for pNew and pOld are equal, is pNew to be preferred over pOld.
493**
494** This function assumes that for each argument sample, the contents of
495** the anEq[] array from pSample->anEq[pSample->iCol+1] onwards are valid.
496*/
497static int sampleIsBetterPost(
drhafa1eca2020-03-09 18:26:11 +0000498 StatAccum *pAccum,
499 StatSample *pNew,
500 StatSample *pOld
danb13af4c2013-09-03 14:43:12 +0000501){
502 int nCol = pAccum->nCol;
503 int i;
504 assert( pNew->iCol==pOld->iCol );
505 for(i=pNew->iCol+1; i<nCol; i++){
506 if( pNew->anEq[i]>pOld->anEq[i] ) return 1;
507 if( pNew->anEq[i]<pOld->anEq[i] ) return 0;
508 }
509 if( pNew->iHash>pOld->iHash ) return 1;
510 return 0;
511}
512#endif
513
drh175b8f02019-08-08 15:24:17 +0000514#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000515/*
516** Return true if pNew is to be preferred over pOld.
danb13af4c2013-09-03 14:43:12 +0000517**
518** This function assumes that for each argument sample, the contents of
519** the anEq[] array from pSample->anEq[pSample->iCol] onwards are valid.
danf00e9022013-08-14 19:54:12 +0000520*/
danb13af4c2013-09-03 14:43:12 +0000521static int sampleIsBetter(
drhafa1eca2020-03-09 18:26:11 +0000522 StatAccum *pAccum,
523 StatSample *pNew,
524 StatSample *pOld
danb13af4c2013-09-03 14:43:12 +0000525){
danf00e9022013-08-14 19:54:12 +0000526 tRowcnt nEqNew = pNew->anEq[pNew->iCol];
527 tRowcnt nEqOld = pOld->anEq[pOld->iCol];
528
529 assert( pOld->isPSample==0 && pNew->isPSample==0 );
530 assert( IsStat4 || (pNew->iCol==0 && pOld->iCol==0) );
531
danb13af4c2013-09-03 14:43:12 +0000532 if( (nEqNew>nEqOld) ) return 1;
danb13af4c2013-09-03 14:43:12 +0000533 if( nEqNew==nEqOld ){
534 if( pNew->iCol<pOld->iCol ) return 1;
535 return (pNew->iCol==pOld->iCol && sampleIsBetterPost(pAccum, pNew, pOld));
danf00e9022013-08-14 19:54:12 +0000536 }
537 return 0;
538}
drhade3add2011-08-13 00:58:05 +0000539
540/*
danf00e9022013-08-14 19:54:12 +0000541** Copy the contents of sample *pNew into the p->a[] array. If necessary,
542** remove the least desirable sample from p->a[] to make room.
543*/
drhafa1eca2020-03-09 18:26:11 +0000544static void sampleInsert(StatAccum *p, StatSample *pNew, int nEqZero){
545 StatSample *pSample = 0;
danf52bb8d2013-08-03 20:24:58 +0000546 int i;
danf52bb8d2013-08-03 20:24:58 +0000547
danf00e9022013-08-14 19:54:12 +0000548 assert( IsStat4 || nEqZero==0 );
danf52bb8d2013-08-03 20:24:58 +0000549
drhafa1eca2020-03-09 18:26:11 +0000550 /* StatAccum.nMaxEqZero is set to the maximum number of leading 0
551 ** values in the anEq[] array of any sample in StatAccum.a[]. In
danbd1d2702017-02-22 19:27:51 +0000552 ** other words, if nMaxEqZero is n, then it is guaranteed that there
drhafa1eca2020-03-09 18:26:11 +0000553 ** are no samples with StatSample.anEq[m]==0 for (m>=n). */
danbd1d2702017-02-22 19:27:51 +0000554 if( nEqZero>p->nMaxEqZero ){
555 p->nMaxEqZero = nEqZero;
556 }
danf00e9022013-08-14 19:54:12 +0000557 if( pNew->isPSample==0 ){
drhafa1eca2020-03-09 18:26:11 +0000558 StatSample *pUpgrade = 0;
danf00e9022013-08-14 19:54:12 +0000559 assert( pNew->anEq[pNew->iCol]>0 );
drhade3add2011-08-13 00:58:05 +0000560
danf00e9022013-08-14 19:54:12 +0000561 /* This sample is being added because the prefix that ends in column
562 ** iCol occurs many times in the table. However, if we have already
563 ** added a sample that shares this prefix, there is no need to add
dan1f616ad2013-08-15 14:39:09 +0000564 ** this one. Instead, upgrade the priority of the highest priority
565 ** existing sample that shares this prefix. */
danf00e9022013-08-14 19:54:12 +0000566 for(i=p->nSample-1; i>=0; i--){
drhafa1eca2020-03-09 18:26:11 +0000567 StatSample *pOld = &p->a[i];
danf00e9022013-08-14 19:54:12 +0000568 if( pOld->anEq[pNew->iCol]==0 ){
dan1f616ad2013-08-15 14:39:09 +0000569 if( pOld->isPSample ) return;
danb13af4c2013-09-03 14:43:12 +0000570 assert( pOld->iCol>pNew->iCol );
571 assert( sampleIsBetter(p, pNew, pOld) );
572 if( pUpgrade==0 || sampleIsBetter(p, pOld, pUpgrade) ){
dan1f616ad2013-08-15 14:39:09 +0000573 pUpgrade = pOld;
danf00e9022013-08-14 19:54:12 +0000574 }
dan1f28ead2013-08-07 16:15:32 +0000575 }
576 }
dan1f616ad2013-08-15 14:39:09 +0000577 if( pUpgrade ){
578 pUpgrade->iCol = pNew->iCol;
579 pUpgrade->anEq[pUpgrade->iCol] = pNew->anEq[pUpgrade->iCol];
580 goto find_new_min;
581 }
drhade3add2011-08-13 00:58:05 +0000582 }
danf52bb8d2013-08-03 20:24:58 +0000583
danf00e9022013-08-14 19:54:12 +0000584 /* If necessary, remove sample iMin to make room for the new sample. */
585 if( p->nSample>=p->mxSample ){
drhafa1eca2020-03-09 18:26:11 +0000586 StatSample *pMin = &p->a[p->iMin];
danc55521a2013-08-05 05:34:30 +0000587 tRowcnt *anEq = pMin->anEq;
danc55521a2013-08-05 05:34:30 +0000588 tRowcnt *anLt = pMin->anLt;
danf00e9022013-08-14 19:54:12 +0000589 tRowcnt *anDLt = pMin->anDLt;
drhda475b82013-11-04 21:44:54 +0000590 sampleClear(p->db, pMin);
danf00e9022013-08-14 19:54:12 +0000591 memmove(pMin, &pMin[1], sizeof(p->a[0])*(p->nSample-p->iMin-1));
drhf404c862011-08-13 15:25:10 +0000592 pSample = &p->a[p->nSample-1];
drhd2694612013-11-04 22:04:17 +0000593 pSample->nRowid = 0;
danc55521a2013-08-05 05:34:30 +0000594 pSample->anEq = anEq;
595 pSample->anDLt = anDLt;
596 pSample->anLt = anLt;
danf00e9022013-08-14 19:54:12 +0000597 p->nSample = p->mxSample-1;
dan8ad169a2013-08-12 20:14:04 +0000598 }
drhade3add2011-08-13 00:58:05 +0000599
danb49d1042013-09-02 18:58:11 +0000600 /* The "rows less-than" for the rowid column must be greater than that
601 ** for the last sample in the p->a[] array. Otherwise, the samples would
602 ** be out of order. */
danb49d1042013-09-02 18:58:11 +0000603 assert( p->nSample==0
604 || pNew->anLt[p->nCol-1] > p->a[p->nSample-1].anLt[p->nCol-1] );
danb49d1042013-09-02 18:58:11 +0000605
606 /* Insert the new sample */
607 pSample = &p->a[p->nSample];
608 sampleCopy(p, pSample, pNew);
609 p->nSample++;
610
danf00e9022013-08-14 19:54:12 +0000611 /* Zero the first nEqZero entries in the anEq[] array. */
612 memset(pSample->anEq, 0, sizeof(tRowcnt)*nEqZero);
613
drh175b8f02019-08-08 15:24:17 +0000614find_new_min:
danf00e9022013-08-14 19:54:12 +0000615 if( p->nSample>=p->mxSample ){
616 int iMin = -1;
danf52bb8d2013-08-03 20:24:58 +0000617 for(i=0; i<p->mxSample; i++){
618 if( p->a[i].isPSample ) continue;
danb13af4c2013-09-03 14:43:12 +0000619 if( iMin<0 || sampleIsBetter(p, &p->a[iMin], &p->a[i]) ){
drhade3add2011-08-13 00:58:05 +0000620 iMin = i;
drhade3add2011-08-13 00:58:05 +0000621 }
622 }
danf52bb8d2013-08-03 20:24:58 +0000623 assert( iMin>=0 );
drhade3add2011-08-13 00:58:05 +0000624 p->iMin = iMin;
625 }
626}
drh175b8f02019-08-08 15:24:17 +0000627#endif /* SQLITE_ENABLE_STAT4 */
danf00e9022013-08-14 19:54:12 +0000628
drhafa1eca2020-03-09 18:26:11 +0000629#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000630/*
631** Field iChng of the index being scanned has changed. So at this point
632** p->current contains a sample that reflects the previous row of the
633** index. The value of anEq[iChng] and subsequent anEq[] elements are
634** correct at this point.
635*/
drhafa1eca2020-03-09 18:26:11 +0000636static void samplePushPrevious(StatAccum *p, int iChng){
drh92707ac2013-08-17 18:57:15 +0000637 int i;
danf00e9022013-08-14 19:54:12 +0000638
drh92707ac2013-08-17 18:57:15 +0000639 /* Check if any samples from the aBest[] array should be pushed
640 ** into IndexSample.a[] at this point. */
641 for(i=(p->nCol-2); i>=iChng; i--){
drhafa1eca2020-03-09 18:26:11 +0000642 StatSample *pBest = &p->aBest[i];
danb13af4c2013-09-03 14:43:12 +0000643 pBest->anEq[i] = p->current.anEq[i];
644 if( p->nSample<p->mxSample || sampleIsBetter(p, pBest, &p->a[p->iMin]) ){
drh92707ac2013-08-17 18:57:15 +0000645 sampleInsert(p, pBest, i);
danf00e9022013-08-14 19:54:12 +0000646 }
647 }
648
danbd1d2702017-02-22 19:27:51 +0000649 /* Check that no sample contains an anEq[] entry with an index of
650 ** p->nMaxEqZero or greater set to zero. */
drh92707ac2013-08-17 18:57:15 +0000651 for(i=p->nSample-1; i>=0; i--){
652 int j;
danbd1d2702017-02-22 19:27:51 +0000653 for(j=p->nMaxEqZero; j<p->nCol; j++) assert( p->a[i].anEq[j]>0 );
654 }
655
656 /* Update the anEq[] fields of any samples already collected. */
657 if( iChng<p->nMaxEqZero ){
658 for(i=p->nSample-1; i>=0; i--){
659 int j;
660 for(j=iChng; j<p->nCol; j++){
661 if( p->a[i].anEq[j]==0 ) p->a[i].anEq[j] = p->current.anEq[j];
662 }
drh92707ac2013-08-17 18:57:15 +0000663 }
danbd1d2702017-02-22 19:27:51 +0000664 p->nMaxEqZero = iChng;
drh92707ac2013-08-17 18:57:15 +0000665 }
danf00e9022013-08-14 19:54:12 +0000666}
drhafa1eca2020-03-09 18:26:11 +0000667#endif /* SQLITE_ENABLE_STAT4 */
danf00e9022013-08-14 19:54:12 +0000668
669/*
drhebe25af2013-11-02 18:46:04 +0000670** Implementation of the stat_push SQL function: stat_push(P,C,R)
drh9fecc542013-08-27 20:16:48 +0000671** Arguments:
danf00e9022013-08-14 19:54:12 +0000672**
drhafa1eca2020-03-09 18:26:11 +0000673** P Pointer to the StatAccum object created by stat_init()
drh9fecc542013-08-27 20:16:48 +0000674** C Index of left-most column to differ from previous row
drhebe25af2013-11-02 18:46:04 +0000675** R Rowid for the current row. Might be a key record for
676** WITHOUT ROWID tables.
danf00e9022013-08-14 19:54:12 +0000677**
drh553818a2014-07-23 18:36:55 +0000678** This SQL function always returns NULL. It's purpose it to accumulate
drhafa1eca2020-03-09 18:26:11 +0000679** statistical data and/or samples in the StatAccum object about the
drh553818a2014-07-23 18:36:55 +0000680** index being analyzed. The stat_get() SQL function will later be used to
681** extract relevant information for constructing the sqlite_statN tables.
drh9fecc542013-08-27 20:16:48 +0000682**
drh175b8f02019-08-08 15:24:17 +0000683** The R parameter is only used for STAT4
danf00e9022013-08-14 19:54:12 +0000684*/
685static void statPush(
686 sqlite3_context *context,
687 int argc,
688 sqlite3_value **argv
689){
690 int i;
691
692 /* The three function arguments */
drhafa1eca2020-03-09 18:26:11 +0000693 StatAccum *p = (StatAccum*)sqlite3_value_blob(argv[0]);
drh9fecc542013-08-27 20:16:48 +0000694 int iChng = sqlite3_value_int(argv[1]);
danf00e9022013-08-14 19:54:12 +0000695
drh4f991892013-10-11 15:05:05 +0000696 UNUSED_PARAMETER( argc );
697 UNUSED_PARAMETER( context );
drhec9e55d2014-06-30 17:07:39 +0000698 assert( p->nCol>0 );
danf00e9022013-08-14 19:54:12 +0000699 assert( iChng<p->nCol );
700
drh9fecc542013-08-27 20:16:48 +0000701 if( p->nRow==0 ){
danb49d1042013-09-02 18:58:11 +0000702 /* This is the first call to this function. Do initialization. */
drh9fecc542013-08-27 20:16:48 +0000703 for(i=0; i<p->nCol; i++) p->current.anEq[i] = 1;
704 }else{
705 /* Second and subsequent calls get processed here */
drhafa1eca2020-03-09 18:26:11 +0000706#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000707 samplePushPrevious(p, iChng);
drhafa1eca2020-03-09 18:26:11 +0000708#endif
danf00e9022013-08-14 19:54:12 +0000709
710 /* Update anDLt[], anLt[] and anEq[] to reflect the values that apply
711 ** to the current row of the index. */
712 for(i=0; i<iChng; i++){
713 p->current.anEq[i]++;
714 }
715 for(i=iChng; i<p->nCol; i++){
716 p->current.anDLt[i]++;
drh175b8f02019-08-08 15:24:17 +0000717#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000718 p->current.anLt[i] += p->current.anEq[i];
drh9fecc542013-08-27 20:16:48 +0000719#endif
danf00e9022013-08-14 19:54:12 +0000720 p->current.anEq[i] = 1;
721 }
danf00e9022013-08-14 19:54:12 +0000722 }
drh9fecc542013-08-27 20:16:48 +0000723 p->nRow++;
drh175b8f02019-08-08 15:24:17 +0000724#ifdef SQLITE_ENABLE_STAT4
drhebe25af2013-11-02 18:46:04 +0000725 if( sqlite3_value_type(argv[2])==SQLITE_INTEGER ){
drhda475b82013-11-04 21:44:54 +0000726 sampleSetRowidInt64(p->db, &p->current, sqlite3_value_int64(argv[2]));
drhebe25af2013-11-02 18:46:04 +0000727 }else{
drhda475b82013-11-04 21:44:54 +0000728 sampleSetRowid(p->db, &p->current, sqlite3_value_bytes(argv[2]),
729 sqlite3_value_blob(argv[2]));
drhebe25af2013-11-02 18:46:04 +0000730 }
drh9fecc542013-08-27 20:16:48 +0000731 p->current.iHash = p->iPrn = p->iPrn*1103515245 + 12345;
732#endif
danf00e9022013-08-14 19:54:12 +0000733
drh92707ac2013-08-17 18:57:15 +0000734#ifdef SQLITE_ENABLE_STAT4
735 {
danf00e9022013-08-14 19:54:12 +0000736 tRowcnt nLt = p->current.anLt[p->nCol-1];
737
738 /* Check if this is to be a periodic sample. If so, add it. */
739 if( (nLt/p->nPSample)!=(nLt+1)/p->nPSample ){
740 p->current.isPSample = 1;
741 p->current.iCol = 0;
742 sampleInsert(p, &p->current, p->nCol-1);
743 p->current.isPSample = 0;
744 }
745
746 /* Update the aBest[] array. */
747 for(i=0; i<(p->nCol-1); i++){
748 p->current.iCol = i;
danb13af4c2013-09-03 14:43:12 +0000749 if( i>=iChng || sampleIsBetterPost(p, &p->current, &p->aBest[i]) ){
danf00e9022013-08-14 19:54:12 +0000750 sampleCopy(p, &p->aBest[i], &p->current);
751 }
752 }
753 }
drh92707ac2013-08-17 18:57:15 +0000754#endif
danf00e9022013-08-14 19:54:12 +0000755}
756static const FuncDef statPushFuncdef = {
drh175b8f02019-08-08 15:24:17 +0000757 2+IsStat4, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000758 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000759 0, /* pUserData */
760 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000761 statPush, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000762 0, /* xFinalize */
dan980cf252018-06-10 07:42:35 +0000763 0, 0, /* xValue, xInverse */
danf00e9022013-08-14 19:54:12 +0000764 "stat_push", /* zName */
drh80738d92016-02-15 00:34:16 +0000765 {0}
drhade3add2011-08-13 00:58:05 +0000766};
767
danf00e9022013-08-14 19:54:12 +0000768#define STAT_GET_STAT1 0 /* "stat" column of stat1 table */
769#define STAT_GET_ROWID 1 /* "rowid" column of stat[34] entry */
770#define STAT_GET_NEQ 2 /* "neq" column of stat[34] entry */
771#define STAT_GET_NLT 3 /* "nlt" column of stat[34] entry */
772#define STAT_GET_NDLT 4 /* "ndlt" column of stat[34] entry */
773
drhade3add2011-08-13 00:58:05 +0000774/*
drh92707ac2013-08-17 18:57:15 +0000775** Implementation of the stat_get(P,J) SQL function. This routine is
drh553818a2014-07-23 18:36:55 +0000776** used to query statistical information that has been gathered into
drhafa1eca2020-03-09 18:26:11 +0000777** the StatAccum object by prior calls to stat_push(). The P parameter
778** has type BLOB but it is really just a pointer to the StatAccum object.
drh553818a2014-07-23 18:36:55 +0000779** The content to returned is determined by the parameter J
drh92707ac2013-08-17 18:57:15 +0000780** which is one of the STAT_GET_xxxx values defined above.
drhade3add2011-08-13 00:58:05 +0000781**
drh35497fc2017-02-01 01:34:15 +0000782** The stat_get(P,J) function is not available to generic SQL. It is
783** inserted as part of a manually constructed bytecode program. (See
784** the callStatGet() routine below.) It is guaranteed that the P
drhafa1eca2020-03-09 18:26:11 +0000785** parameter will always be a pointer to a StatAccum object, never a
drh35497fc2017-02-01 01:34:15 +0000786** NULL.
787**
drh175b8f02019-08-08 15:24:17 +0000788** If STAT4 is not enabled, then J is always
drh92707ac2013-08-17 18:57:15 +0000789** STAT_GET_STAT1 and is hence omitted and this routine becomes
790** a one-parameter function, stat_get(P), that always returns the
791** stat1 table entry information.
drhade3add2011-08-13 00:58:05 +0000792*/
danf00e9022013-08-14 19:54:12 +0000793static void statGet(
drhade3add2011-08-13 00:58:05 +0000794 sqlite3_context *context,
795 int argc,
796 sqlite3_value **argv
797){
drhafa1eca2020-03-09 18:26:11 +0000798 StatAccum *p = (StatAccum*)sqlite3_value_blob(argv[0]);
drh175b8f02019-08-08 15:24:17 +0000799#ifdef SQLITE_ENABLE_STAT4
800 /* STAT4 has a parameter on this routine. */
danf00e9022013-08-14 19:54:12 +0000801 int eCall = sqlite3_value_int(argv[1]);
drh92707ac2013-08-17 18:57:15 +0000802 assert( argc==2 );
danf00e9022013-08-14 19:54:12 +0000803 assert( eCall==STAT_GET_STAT1 || eCall==STAT_GET_NEQ
804 || eCall==STAT_GET_ROWID || eCall==STAT_GET_NLT
805 || eCall==STAT_GET_NDLT
806 );
drh92707ac2013-08-17 18:57:15 +0000807 if( eCall==STAT_GET_STAT1 )
808#else
809 assert( argc==1 );
810#endif
811 {
danf00e9022013-08-14 19:54:12 +0000812 /* Return the value to store in the "stat" column of the sqlite_stat1
813 ** table for this index.
814 **
815 ** The value is a string composed of a list of integers describing
816 ** the index. The first integer in the list is the total number of
817 ** entries in the index. There is one additional integer in the list
818 ** for each indexed column. This additional integer is an estimate of
drhafa1eca2020-03-09 18:26:11 +0000819 ** the number of rows matched by a equality query on the index using
danf00e9022013-08-14 19:54:12 +0000820 ** a key with the corresponding number of fields. In other words,
821 ** if the index is on columns (a,b) and the sqlite_stat1 value is
822 ** "100 10 2", then SQLite estimates that:
823 **
824 ** * the index contains 100 rows,
825 ** * "WHERE a=?" matches 10 rows, and
826 ** * "WHERE a=? AND b=?" matches 2 rows.
827 **
828 ** If D is the count of distinct values and K is the total number of
829 ** rows, then each estimate is computed as:
830 **
831 ** I = (K+D-1)/D
832 */
833 char *z;
834 int i;
835
drhec9e55d2014-06-30 17:07:39 +0000836 char *zRet = sqlite3MallocZero( (p->nKeyCol+1)*25 );
danf00e9022013-08-14 19:54:12 +0000837 if( zRet==0 ){
838 sqlite3_result_error_nomem(context);
839 return;
840 }
841
drh26586e72013-10-09 19:07:22 +0000842 sqlite3_snprintf(24, zRet, "%llu", (u64)p->nRow);
danf00e9022013-08-14 19:54:12 +0000843 z = zRet + sqlite3Strlen30(zRet);
drhec9e55d2014-06-30 17:07:39 +0000844 for(i=0; i<p->nKeyCol; i++){
drh26586e72013-10-09 19:07:22 +0000845 u64 nDistinct = p->current.anDLt[i] + 1;
846 u64 iVal = (p->nRow + nDistinct - 1) / nDistinct;
847 sqlite3_snprintf(24, z, " %llu", iVal);
danf00e9022013-08-14 19:54:12 +0000848 z += sqlite3Strlen30(z);
849 assert( p->current.anEq[i] );
850 }
851 assert( z[0]=='\0' && z>zRet );
852
853 sqlite3_result_text(context, zRet, -1, sqlite3_free);
drh92707ac2013-08-17 18:57:15 +0000854 }
drh175b8f02019-08-08 15:24:17 +0000855#ifdef SQLITE_ENABLE_STAT4
drh92707ac2013-08-17 18:57:15 +0000856 else if( eCall==STAT_GET_ROWID ){
danf00e9022013-08-14 19:54:12 +0000857 if( p->iGet<0 ){
858 samplePushPrevious(p, 0);
859 p->iGet = 0;
860 }
861 if( p->iGet<p->nSample ){
drhafa1eca2020-03-09 18:26:11 +0000862 StatSample *pS = p->a + p->iGet;
drhebe25af2013-11-02 18:46:04 +0000863 if( pS->nRowid==0 ){
drhda475b82013-11-04 21:44:54 +0000864 sqlite3_result_int64(context, pS->u.iRowid);
drhebe25af2013-11-02 18:46:04 +0000865 }else{
drhda475b82013-11-04 21:44:54 +0000866 sqlite3_result_blob(context, pS->u.aRowid, pS->nRowid,
867 SQLITE_TRANSIENT);
drhebe25af2013-11-02 18:46:04 +0000868 }
danf00e9022013-08-14 19:54:12 +0000869 }
870 }else{
danf52bb8d2013-08-03 20:24:58 +0000871 tRowcnt *aCnt = 0;
danf00e9022013-08-14 19:54:12 +0000872
873 assert( p->iGet<p->nSample );
874 switch( eCall ){
875 case STAT_GET_NEQ: aCnt = p->a[p->iGet].anEq; break;
876 case STAT_GET_NLT: aCnt = p->a[p->iGet].anLt; break;
877 default: {
878 aCnt = p->a[p->iGet].anDLt;
879 p->iGet++;
880 break;
881 }
danf52bb8d2013-08-03 20:24:58 +0000882 }
883
drh175b8f02019-08-08 15:24:17 +0000884 {
danf00e9022013-08-14 19:54:12 +0000885 char *zRet = sqlite3MallocZero(p->nCol * 25);
dan8ad169a2013-08-12 20:14:04 +0000886 if( zRet==0 ){
887 sqlite3_result_error_nomem(context);
888 }else{
889 int i;
890 char *z = zRet;
891 for(i=0; i<p->nCol; i++){
drh26586e72013-10-09 19:07:22 +0000892 sqlite3_snprintf(24, z, "%llu ", (u64)aCnt[i]);
dan8ad169a2013-08-12 20:14:04 +0000893 z += sqlite3Strlen30(z);
894 }
895 assert( z[0]=='\0' && z>zRet );
896 z[-1] = '\0';
897 sqlite3_result_text(context, zRet, -1, sqlite3_free);
danf52bb8d2013-08-03 20:24:58 +0000898 }
danf52bb8d2013-08-03 20:24:58 +0000899 }
drhade3add2011-08-13 00:58:05 +0000900 }
drh175b8f02019-08-08 15:24:17 +0000901#endif /* SQLITE_ENABLE_STAT4 */
drh4f991892013-10-11 15:05:05 +0000902#ifndef SQLITE_DEBUG
903 UNUSED_PARAMETER( argc );
904#endif
drhade3add2011-08-13 00:58:05 +0000905}
danf00e9022013-08-14 19:54:12 +0000906static const FuncDef statGetFuncdef = {
drh175b8f02019-08-08 15:24:17 +0000907 1+IsStat4, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000908 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000909 0, /* pUserData */
910 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000911 statGet, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000912 0, /* xFinalize */
dan980cf252018-06-10 07:42:35 +0000913 0, 0, /* xValue, xInverse */
danf00e9022013-08-14 19:54:12 +0000914 "stat_get", /* zName */
drh80738d92016-02-15 00:34:16 +0000915 {0}
drhade3add2011-08-13 00:58:05 +0000916};
drhade3add2011-08-13 00:58:05 +0000917
drh920cf592019-10-30 16:29:02 +0000918static void callStatGet(Parse *pParse, int regStat4, int iParam, int regOut){
drh175b8f02019-08-08 15:24:17 +0000919#ifdef SQLITE_ENABLE_STAT4
drh920cf592019-10-30 16:29:02 +0000920 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Integer, iParam, regStat4+1);
drh4f991892013-10-11 15:05:05 +0000921#elif SQLITE_DEBUG
drh92707ac2013-08-17 18:57:15 +0000922 assert( iParam==STAT_GET_STAT1 );
drh4f991892013-10-11 15:05:05 +0000923#else
924 UNUSED_PARAMETER( iParam );
drh92707ac2013-08-17 18:57:15 +0000925#endif
drh920cf592019-10-30 16:29:02 +0000926 assert( regOut!=regStat4 && regOut!=regStat4+1 );
927 sqlite3VdbeAddFunctionCall(pParse, 0, regStat4, regOut, 1+IsStat4,
928 &statGetFuncdef, 0);
danf00e9022013-08-14 19:54:12 +0000929}
drhade3add2011-08-13 00:58:05 +0000930
931/*
drhff2d5ea2005-07-23 00:41:48 +0000932** Generate code to do an analysis of all indices associated with
933** a single table.
934*/
935static void analyzeOneTable(
936 Parse *pParse, /* Parser context */
937 Table *pTab, /* Table whose indices are to be analyzed */
drha071bc52011-03-31 02:03:28 +0000938 Index *pOnlyIdx, /* If not NULL, only analyze this one index */
drhdfe88ec2008-11-03 20:55:06 +0000939 int iStatCur, /* Index of VdbeCursor that writes the sqlite_stat1 table */
danc6129702013-08-05 19:04:07 +0000940 int iMem, /* Available memory locations begin here */
drh4a54bb52017-02-18 15:58:52 +0000941 int iTab /* Next available cursor */
drhff2d5ea2005-07-23 00:41:48 +0000942){
dan0f9a34e2009-08-19 16:34:31 +0000943 sqlite3 *db = pParse->db; /* Database handle */
dan69188d92009-08-19 08:18:32 +0000944 Index *pIdx; /* An index to being analyzed */
945 int iIdxCur; /* Cursor open on index being analyzed */
danc6129702013-08-05 19:04:07 +0000946 int iTabCur; /* Table cursor */
dan69188d92009-08-19 08:18:32 +0000947 Vdbe *v; /* The virtual machine being built up */
948 int i; /* Loop counter */
drhf6cf1ff2011-03-30 14:54:05 +0000949 int jZeroRows = -1; /* Jump from here if number of rows is zero */
dan69188d92009-08-19 08:18:32 +0000950 int iDb; /* Index of database containing pTab */
drh721dfcf2013-08-01 04:39:17 +0000951 u8 needTableCnt = 1; /* True to count the table */
danf00e9022013-08-14 19:54:12 +0000952 int regNewRowid = iMem++; /* Rowid for the inserted record */
drhafa1eca2020-03-09 18:26:11 +0000953 int regStat4 = iMem++; /* Register to hold StatAccum object */
danf00e9022013-08-14 19:54:12 +0000954 int regChng = iMem++; /* Index of changed index field */
drh175b8f02019-08-08 15:24:17 +0000955#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +0000956 int regRowid = iMem++; /* Rowid argument passed to stat_push() */
957#endif
danf00e9022013-08-14 19:54:12 +0000958 int regTemp = iMem++; /* Temporary use register */
dane275dc32009-08-18 16:24:58 +0000959 int regTabname = iMem++; /* Register containing table name */
960 int regIdxname = iMem++; /* Register containing index name */
danf00e9022013-08-14 19:54:12 +0000961 int regStat1 = iMem++; /* Value for the stat column of sqlite_stat1 */
962 int regPrev = iMem; /* MUST BE LAST (see below) */
dan614efe22018-01-12 16:44:29 +0000963#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
964 Table *pStat1 = 0;
965#endif
dan68c4dbb2009-08-20 09:11:06 +0000966
drhf0459fc2013-08-15 16:15:00 +0000967 pParse->nMem = MAX(pParse->nMem, iMem);
drhff2d5ea2005-07-23 00:41:48 +0000968 v = sqlite3GetVdbe(pParse);
drh15564052010-09-25 22:32:56 +0000969 if( v==0 || NEVER(pTab==0) ){
970 return;
971 }
drhf39d29c2010-09-28 17:34:46 +0000972 if( pTab->tnum==0 ){
973 /* Do not gather statistics on views or virtual tables */
drh15564052010-09-25 22:32:56 +0000974 return;
975 }
drhcedfecf2018-03-23 12:59:10 +0000976 if( sqlite3_strlike("sqlite\\_%", pTab->zName, '\\')==0 ){
drh15564052010-09-25 22:32:56 +0000977 /* Do not gather statistics on system tables */
drhff2d5ea2005-07-23 00:41:48 +0000978 return;
979 }
dan0f9a34e2009-08-19 16:34:31 +0000980 assert( sqlite3BtreeHoldsAllMutexes(db) );
981 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
danielk1977da184232006-01-05 11:34:32 +0000982 assert( iDb>=0 );
drh21206082011-04-04 18:22:02 +0000983 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drhe6e04962005-07-23 02:17:03 +0000984#ifndef SQLITE_OMIT_AUTHORIZATION
985 if( sqlite3AuthCheck(pParse, SQLITE_ANALYZE, pTab->zName, 0,
drh69c33822016-08-18 14:33:11 +0000986 db->aDb[iDb].zDbSName ) ){
drhe6e04962005-07-23 02:17:03 +0000987 return;
988 }
989#endif
990
dan614efe22018-01-12 16:44:29 +0000991#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
992 if( db->xPreUpdateCallback ){
993 pStat1 = (Table*)sqlite3DbMallocZero(db, sizeof(Table) + 13);
994 if( pStat1==0 ) return;
995 pStat1->zName = (char*)&pStat1[1];
996 memcpy(pStat1->zName, "sqlite_stat1", 13);
997 pStat1->nCol = 3;
998 pStat1->iPKey = -1;
999 sqlite3VdbeAddOp4(pParse->pVdbe, OP_Noop, 0, 0, 0,(char*)pStat1,P4_DYNBLOB);
1000 }
1001#endif
1002
dane0432012013-08-05 18:00:56 +00001003 /* Establish a read-lock on the table at the shared-cache level.
danf00e9022013-08-14 19:54:12 +00001004 ** Open a read-only cursor on the table. Also allocate a cursor number
1005 ** to use for scanning indexes (iIdxCur). No index cursor is opened at
1006 ** this time though. */
danielk1977c00da102006-01-07 13:21:04 +00001007 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danc6129702013-08-05 19:04:07 +00001008 iTabCur = iTab++;
danf00e9022013-08-14 19:54:12 +00001009 iIdxCur = iTab++;
danc6129702013-08-05 19:04:07 +00001010 pParse->nTab = MAX(pParse->nTab, iTab);
dane0432012013-08-05 18:00:56 +00001011 sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
drh076e85f2015-09-03 13:46:12 +00001012 sqlite3VdbeLoadString(v, regTabname, pTab->zName);
dane0432012013-08-05 18:00:56 +00001013
drhff2d5ea2005-07-23 00:41:48 +00001014 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
drh553818a2014-07-23 18:36:55 +00001015 int nCol; /* Number of columns in pIdx. "N" */
danf00e9022013-08-14 19:54:12 +00001016 int addrRewind; /* Address of "OP_Rewind iIdxCur" */
danf00e9022013-08-14 19:54:12 +00001017 int addrNextRow; /* Address of "next_row:" */
drhce95d112013-11-02 19:34:38 +00001018 const char *zIdxName; /* Name of the index */
drh553818a2014-07-23 18:36:55 +00001019 int nColTest; /* Number of columns to test for changes */
danielk1977b3bf5562006-01-10 17:58:23 +00001020
drha071bc52011-03-31 02:03:28 +00001021 if( pOnlyIdx && pOnlyIdx!=pIdx ) continue;
drh721dfcf2013-08-01 04:39:17 +00001022 if( pIdx->pPartIdxWhere==0 ) needTableCnt = 0;
drhec9e55d2014-06-30 17:07:39 +00001023 if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIdx) ){
1024 nCol = pIdx->nKeyCol;
1025 zIdxName = pTab->zName;
drh553818a2014-07-23 18:36:55 +00001026 nColTest = nCol - 1;
drhec9e55d2014-06-30 17:07:39 +00001027 }else{
1028 nCol = pIdx->nColumn;
1029 zIdxName = pIdx->zName;
drh6861b8a2014-07-23 19:37:21 +00001030 nColTest = pIdx->uniqNotNull ? pIdx->nKeyCol-1 : nCol-1;
drhec9e55d2014-06-30 17:07:39 +00001031 }
dane275dc32009-08-18 16:24:58 +00001032
drh15564052010-09-25 22:32:56 +00001033 /* Populate the register containing the index name. */
drh076e85f2015-09-03 13:46:12 +00001034 sqlite3VdbeLoadString(v, regIdxname, zIdxName);
drhec9e55d2014-06-30 17:07:39 +00001035 VdbeComment((v, "Analysis for %s.%s", pTab->zName, zIdxName));
dan69188d92009-08-19 08:18:32 +00001036
dane0432012013-08-05 18:00:56 +00001037 /*
danf00e9022013-08-14 19:54:12 +00001038 ** Pseudo-code for loop that calls stat_push():
dane0432012013-08-05 18:00:56 +00001039 **
danf00e9022013-08-14 19:54:12 +00001040 ** Rewind csr
1041 ** if eof(csr) goto end_of_scan;
1042 ** regChng = 0
1043 ** goto chng_addr_0;
dane0432012013-08-05 18:00:56 +00001044 **
dandd6e1f12013-08-10 19:08:30 +00001045 ** next_row:
danf00e9022013-08-14 19:54:12 +00001046 ** regChng = 0
1047 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1048 ** regChng = 1
1049 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1050 ** ...
1051 ** regChng = N
1052 ** goto chng_addr_N
dane0432012013-08-05 18:00:56 +00001053 **
danf00e9022013-08-14 19:54:12 +00001054 ** chng_addr_0:
1055 ** regPrev(0) = idx(0)
1056 ** chng_addr_1:
1057 ** regPrev(1) = idx(1)
1058 ** ...
dane0432012013-08-05 18:00:56 +00001059 **
drh9d793322014-07-24 19:54:20 +00001060 ** endDistinctTest:
danf00e9022013-08-14 19:54:12 +00001061 ** regRowid = idx(rowid)
drh9fecc542013-08-27 20:16:48 +00001062 ** stat_push(P, regChng, regRowid)
danf00e9022013-08-14 19:54:12 +00001063 ** Next csr
1064 ** if !eof(csr) goto next_row;
dane0432012013-08-05 18:00:56 +00001065 **
danf00e9022013-08-14 19:54:12 +00001066 ** end_of_scan:
dane0432012013-08-05 18:00:56 +00001067 */
danf00e9022013-08-14 19:54:12 +00001068
1069 /* Make sure there are enough memory cells allocated to accommodate
1070 ** the regPrev array and a trailing rowid (the rowid slot is required
1071 ** when building a record to insert into the sample column of
1072 ** the sqlite_stat4 table. */
drh553818a2014-07-23 18:36:55 +00001073 pParse->nMem = MAX(pParse->nMem, regPrev+nColTest);
dan02fa4692009-08-17 17:06:58 +00001074
danf00e9022013-08-14 19:54:12 +00001075 /* Open a read-only cursor on the index being analyzed. */
dane0432012013-08-05 18:00:56 +00001076 assert( iDb==sqlite3SchemaToIndex(db, pIdx->pSchema) );
danf00e9022013-08-14 19:54:12 +00001077 sqlite3VdbeAddOp3(v, OP_OpenRead, iIdxCur, pIdx->tnum, iDb);
drh2ec2fb22013-11-06 19:59:23 +00001078 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
danf00e9022013-08-14 19:54:12 +00001079 VdbeComment((v, "%s", pIdx->zName));
dane0432012013-08-05 18:00:56 +00001080
danf00e9022013-08-14 19:54:12 +00001081 /* Invoke the stat_init() function. The arguments are:
danf52bb8d2013-08-03 20:24:58 +00001082 **
drh553818a2014-07-23 18:36:55 +00001083 ** (1) the number of columns in the index including the rowid
1084 ** (or for a WITHOUT ROWID table, the number of PK columns),
1085 ** (2) the number of columns in the key without the rowid/pk
1086 ** (3) the number of rows in the index,
drh9fecc542013-08-27 20:16:48 +00001087 **
drh553818a2014-07-23 18:36:55 +00001088 **
drh175b8f02019-08-08 15:24:17 +00001089 ** The third argument is only used for STAT4
danf52bb8d2013-08-03 20:24:58 +00001090 */
drh175b8f02019-08-08 15:24:17 +00001091#ifdef SQLITE_ENABLE_STAT4
drhec9e55d2014-06-30 17:07:39 +00001092 sqlite3VdbeAddOp2(v, OP_Count, iIdxCur, regStat4+3);
drh9fecc542013-08-27 20:16:48 +00001093#endif
drhec9e55d2014-06-30 17:07:39 +00001094 sqlite3VdbeAddOp2(v, OP_Integer, nCol, regStat4+1);
1095 sqlite3VdbeAddOp2(v, OP_Integer, pIdx->nKeyCol, regStat4+2);
drh920cf592019-10-30 16:29:02 +00001096 sqlite3VdbeAddFunctionCall(pParse, 0, regStat4+1, regStat4, 2+IsStat4,
1097 &statInitFuncdef, 0);
danf52bb8d2013-08-03 20:24:58 +00001098
danf00e9022013-08-14 19:54:12 +00001099 /* Implementation of the following:
1100 **
1101 ** Rewind csr
1102 ** if eof(csr) goto end_of_scan;
1103 ** regChng = 0
1104 ** goto next_push_0;
1105 **
dandd6e1f12013-08-10 19:08:30 +00001106 */
danf00e9022013-08-14 19:54:12 +00001107 addrRewind = sqlite3VdbeAddOp1(v, OP_Rewind, iIdxCur);
drh688852a2014-02-17 22:40:43 +00001108 VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001109 sqlite3VdbeAddOp2(v, OP_Integer, 0, regChng);
danf00e9022013-08-14 19:54:12 +00001110 addrNextRow = sqlite3VdbeCurrentAddr(v);
dane0432012013-08-05 18:00:56 +00001111
drh553818a2014-07-23 18:36:55 +00001112 if( nColTest>0 ){
drhec4ccdb2018-12-29 02:26:59 +00001113 int endDistinctTest = sqlite3VdbeMakeLabel(pParse);
drhb12879f2014-07-24 20:25:16 +00001114 int *aGotoChng; /* Array of jump instruction addresses */
drh575fad62016-02-05 13:38:36 +00001115 aGotoChng = sqlite3DbMallocRawNN(db, sizeof(int)*nColTest);
drhb12879f2014-07-24 20:25:16 +00001116 if( aGotoChng==0 ) continue;
danf00e9022013-08-14 19:54:12 +00001117
drh553818a2014-07-23 18:36:55 +00001118 /*
1119 ** next_row:
1120 ** regChng = 0
1121 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1122 ** regChng = 1
1123 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1124 ** ...
1125 ** regChng = N
drh9d793322014-07-24 19:54:20 +00001126 ** goto endDistinctTest
drh553818a2014-07-23 18:36:55 +00001127 */
1128 sqlite3VdbeAddOp0(v, OP_Goto);
1129 addrNextRow = sqlite3VdbeCurrentAddr(v);
drh5f1d1d92014-07-31 22:59:04 +00001130 if( nColTest==1 && pIdx->nKeyCol==1 && IsUniqueIndex(pIdx) ){
drh9d793322014-07-24 19:54:20 +00001131 /* For a single-column UNIQUE index, once we have found a non-NULL
1132 ** row, we know that all the rest will be distinct, so skip
1133 ** subsequent distinctness tests. */
1134 sqlite3VdbeAddOp2(v, OP_NotNull, regPrev, endDistinctTest);
1135 VdbeCoverage(v);
1136 }
drh553818a2014-07-23 18:36:55 +00001137 for(i=0; i<nColTest; i++){
1138 char *pColl = (char*)sqlite3LocateCollSeq(pParse, pIdx->azColl[i]);
1139 sqlite3VdbeAddOp2(v, OP_Integer, i, regChng);
1140 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regTemp);
1141 aGotoChng[i] =
1142 sqlite3VdbeAddOp4(v, OP_Ne, regTemp, 0, regPrev+i, pColl, P4_COLLSEQ);
1143 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
1144 VdbeCoverage(v);
1145 }
1146 sqlite3VdbeAddOp2(v, OP_Integer, nColTest, regChng);
drh076e85f2015-09-03 13:46:12 +00001147 sqlite3VdbeGoto(v, endDistinctTest);
drh553818a2014-07-23 18:36:55 +00001148
1149
1150 /*
1151 ** chng_addr_0:
1152 ** regPrev(0) = idx(0)
1153 ** chng_addr_1:
1154 ** regPrev(1) = idx(1)
1155 ** ...
1156 */
1157 sqlite3VdbeJumpHere(v, addrNextRow-1);
1158 for(i=0; i<nColTest; i++){
1159 sqlite3VdbeJumpHere(v, aGotoChng[i]);
1160 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regPrev+i);
1161 }
drh9d793322014-07-24 19:54:20 +00001162 sqlite3VdbeResolveLabel(v, endDistinctTest);
drhb12879f2014-07-24 20:25:16 +00001163 sqlite3DbFree(db, aGotoChng);
drhff2d5ea2005-07-23 00:41:48 +00001164 }
drh553818a2014-07-23 18:36:55 +00001165
danf00e9022013-08-14 19:54:12 +00001166 /*
1167 ** chng_addr_N:
drh175b8f02019-08-08 15:24:17 +00001168 ** regRowid = idx(rowid) // STAT4 only
1169 ** stat_push(P, regChng, regRowid) // 3rd parameter STAT4 only
danf00e9022013-08-14 19:54:12 +00001170 ** Next csr
1171 ** if !eof(csr) goto next_row;
1172 */
drh175b8f02019-08-08 15:24:17 +00001173#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +00001174 assert( regRowid==(regStat4+2) );
drhebe25af2013-11-02 18:46:04 +00001175 if( HasRowid(pTab) ){
1176 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, regRowid);
1177 }else{
1178 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
1179 int j, k, regKey;
1180 regKey = sqlite3GetTempRange(pParse, pPk->nKeyCol);
1181 for(j=0; j<pPk->nKeyCol; j++){
drhb9bcf7c2019-10-19 13:29:10 +00001182 k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
drh49297c82017-03-21 18:56:52 +00001183 assert( k>=0 && k<pIdx->nColumn );
drhebe25af2013-11-02 18:46:04 +00001184 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, regKey+j);
1185 VdbeComment((v, "%s", pTab->aCol[pPk->aiColumn[j]].zName));
1186 }
1187 sqlite3VdbeAddOp3(v, OP_MakeRecord, regKey, pPk->nKeyCol, regRowid);
1188 sqlite3ReleaseTempRange(pParse, regKey, pPk->nKeyCol);
1189 }
drh9fecc542013-08-27 20:16:48 +00001190#endif
1191 assert( regChng==(regStat4+1) );
drh920cf592019-10-30 16:29:02 +00001192 sqlite3VdbeAddFunctionCall(pParse, 1, regStat4, regTemp, 2+IsStat4,
1193 &statPushFuncdef, 0);
drh688852a2014-02-17 22:40:43 +00001194 sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001195
1196 /* Add the entry to the stat1 table. */
drh920cf592019-10-30 16:29:02 +00001197 callStatGet(pParse, regStat4, STAT_GET_STAT1, regStat1);
drh4583c372014-09-19 20:13:25 +00001198 assert( "BBB"[0]==SQLITE_AFF_TEXT );
1199 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
drhade3add2011-08-13 00:58:05 +00001200 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
danf00e9022013-08-14 19:54:12 +00001201 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
dan614efe22018-01-12 16:44:29 +00001202#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1203 sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
1204#endif
drh2d401ab2008-01-10 23:50:11 +00001205 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
danf00e9022013-08-14 19:54:12 +00001206
drh175b8f02019-08-08 15:24:17 +00001207 /* Add the entries to the stat4 table. */
1208#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +00001209 {
danf00e9022013-08-14 19:54:12 +00001210 int regEq = regStat1;
1211 int regLt = regStat1+1;
1212 int regDLt = regStat1+2;
1213 int regSample = regStat1+3;
1214 int regCol = regStat1+4;
1215 int regSampleRowid = regCol + nCol;
1216 int addrNext;
1217 int addrIsNull;
drhebe25af2013-11-02 18:46:04 +00001218 u8 seekOp = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
danf00e9022013-08-14 19:54:12 +00001219
drhec9e55d2014-06-30 17:07:39 +00001220 pParse->nMem = MAX(pParse->nMem, regCol+nCol);
danf00e9022013-08-14 19:54:12 +00001221
1222 addrNext = sqlite3VdbeCurrentAddr(v);
drh920cf592019-10-30 16:29:02 +00001223 callStatGet(pParse, regStat4, STAT_GET_ROWID, regSampleRowid);
danf00e9022013-08-14 19:54:12 +00001224 addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regSampleRowid);
drh688852a2014-02-17 22:40:43 +00001225 VdbeCoverage(v);
drh920cf592019-10-30 16:29:02 +00001226 callStatGet(pParse, regStat4, STAT_GET_NEQ, regEq);
1227 callStatGet(pParse, regStat4, STAT_GET_NLT, regLt);
1228 callStatGet(pParse, regStat4, STAT_GET_NDLT, regDLt);
drhebe25af2013-11-02 18:46:04 +00001229 sqlite3VdbeAddOp4Int(v, seekOp, iTabCur, addrNext, regSampleRowid, 0);
drh6ccbd272018-07-10 17:10:44 +00001230 VdbeCoverage(v);
drhec9e55d2014-06-30 17:07:39 +00001231 for(i=0; i<nCol; i++){
drh1f9ca2c2015-08-25 16:57:52 +00001232 sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, i, regCol+i);
danf00e9022013-08-14 19:54:12 +00001233 }
drhec9e55d2014-06-30 17:07:39 +00001234 sqlite3VdbeAddOp3(v, OP_MakeRecord, regCol, nCol, regSample);
drh57bf4a82014-02-17 14:59:22 +00001235 sqlite3VdbeAddOp3(v, OP_MakeRecord, regTabname, 6, regTemp);
danf00e9022013-08-14 19:54:12 +00001236 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur+1, regNewRowid);
1237 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur+1, regTemp, regNewRowid);
drhfe705102014-03-06 13:38:37 +00001238 sqlite3VdbeAddOp2(v, OP_Goto, 1, addrNext); /* P1==1 for end-of-loop */
danf00e9022013-08-14 19:54:12 +00001239 sqlite3VdbeJumpHere(v, addrIsNull);
1240 }
drh175b8f02019-08-08 15:24:17 +00001241#endif /* SQLITE_ENABLE_STAT4 */
danf00e9022013-08-14 19:54:12 +00001242
drh9fecc542013-08-27 20:16:48 +00001243 /* End of analysis */
danf00e9022013-08-14 19:54:12 +00001244 sqlite3VdbeJumpHere(v, addrRewind);
drh15564052010-09-25 22:32:56 +00001245 }
1246
danf00e9022013-08-14 19:54:12 +00001247
drh721dfcf2013-08-01 04:39:17 +00001248 /* Create a single sqlite_stat1 entry containing NULL as the index
1249 ** name and the row count as the content.
drh15564052010-09-25 22:32:56 +00001250 */
drh721dfcf2013-08-01 04:39:17 +00001251 if( pOnlyIdx==0 && needTableCnt ){
drh15564052010-09-25 22:32:56 +00001252 VdbeComment((v, "%s", pTab->zName));
dane0432012013-08-05 18:00:56 +00001253 sqlite3VdbeAddOp2(v, OP_Count, iTabCur, regStat1);
drh688852a2014-02-17 22:40:43 +00001254 jZeroRows = sqlite3VdbeAddOp1(v, OP_IfNot, regStat1); VdbeCoverage(v);
drh721dfcf2013-08-01 04:39:17 +00001255 sqlite3VdbeAddOp2(v, OP_Null, 0, regIdxname);
drh4583c372014-09-19 20:13:25 +00001256 assert( "BBB"[0]==SQLITE_AFF_TEXT );
1257 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
drh721dfcf2013-08-01 04:39:17 +00001258 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
danf00e9022013-08-14 19:54:12 +00001259 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
drh721dfcf2013-08-01 04:39:17 +00001260 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
dan3739f292018-01-17 20:57:20 +00001261#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1262 sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
1263#endif
drh15564052010-09-25 22:32:56 +00001264 sqlite3VdbeJumpHere(v, jZeroRows);
1265 }
drhff2d5ea2005-07-23 00:41:48 +00001266}
1267
drh72052a72017-02-17 16:26:34 +00001268
1269/*
drh4a54bb52017-02-18 15:58:52 +00001270** Generate code that will cause the most recent index analysis to
1271** be loaded into internal hash tables where is can be used.
drh72052a72017-02-17 16:26:34 +00001272*/
drh4a54bb52017-02-18 15:58:52 +00001273static void loadAnalysis(Parse *pParse, int iDb){
drh182e84c2017-02-18 02:19:02 +00001274 Vdbe *v = sqlite3GetVdbe(pParse);
drh4a54bb52017-02-18 15:58:52 +00001275 if( v ){
1276 sqlite3VdbeAddOp1(v, OP_LoadAnalysis, iDb);
1277 }
1278}
drhff2d5ea2005-07-23 00:41:48 +00001279
drh4a54bb52017-02-18 15:58:52 +00001280/*
1281** Generate code that will do an analysis of an entire database
1282*/
1283static void analyzeDatabase(Parse *pParse, int iDb){
1284 sqlite3 *db = pParse->db;
1285 Schema *pSchema = db->aDb[iDb].pSchema; /* Schema of database iDb */
1286 HashElem *k;
1287 int iStatCur;
1288 int iMem;
1289 int iTab;
1290
1291 sqlite3BeginWriteOperation(pParse, 0, iDb);
1292 iStatCur = pParse->nTab;
1293 pParse->nTab += 3;
1294 openStatTable(pParse, iDb, iStatCur, 0, 0);
1295 iMem = pParse->nMem+1;
1296 iTab = pParse->nTab;
1297 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1298 for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
1299 Table *pTab = (Table*)sqliteHashData(k);
1300 analyzeOneTable(pParse, pTab, 0, iStatCur, iMem, iTab);
drhff2d5ea2005-07-23 00:41:48 +00001301 }
drh4a54bb52017-02-18 15:58:52 +00001302 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001303}
1304
1305/*
1306** Generate code that will do an analysis of a single table in
drha071bc52011-03-31 02:03:28 +00001307** a database. If pOnlyIdx is not NULL then it is a single index
1308** in pTab that should be analyzed.
drhff2d5ea2005-07-23 00:41:48 +00001309*/
drha071bc52011-03-31 02:03:28 +00001310static void analyzeTable(Parse *pParse, Table *pTab, Index *pOnlyIdx){
drhff2d5ea2005-07-23 00:41:48 +00001311 int iDb;
1312 int iStatCur;
1313
1314 assert( pTab!=0 );
drh1fee73e2007-08-29 04:00:57 +00001315 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
danielk1977da184232006-01-05 11:34:32 +00001316 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drhff2d5ea2005-07-23 00:41:48 +00001317 sqlite3BeginWriteOperation(pParse, 0, iDb);
dan02fa4692009-08-17 17:06:58 +00001318 iStatCur = pParse->nTab;
drhade3add2011-08-13 00:58:05 +00001319 pParse->nTab += 3;
drha071bc52011-03-31 02:03:28 +00001320 if( pOnlyIdx ){
1321 openStatTable(pParse, iDb, iStatCur, pOnlyIdx->zName, "idx");
1322 }else{
1323 openStatTable(pParse, iDb, iStatCur, pTab->zName, "tbl");
1324 }
drh4a54bb52017-02-18 15:58:52 +00001325 analyzeOneTable(pParse, pTab, pOnlyIdx, iStatCur,pParse->nMem+1,pParse->nTab);
1326 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001327}
1328
1329/*
1330** Generate code for the ANALYZE command. The parser calls this routine
1331** when it recognizes an ANALYZE command.
drh9f18e8a2005-07-08 12:13:04 +00001332**
1333** ANALYZE -- 1
drhff2d5ea2005-07-23 00:41:48 +00001334** ANALYZE <database> -- 2
drh9f18e8a2005-07-08 12:13:04 +00001335** ANALYZE ?<database>.?<tablename> -- 3
1336**
1337** Form 1 causes all indices in all attached databases to be analyzed.
1338** Form 2 analyzes all indices the single database named.
1339** Form 3 analyzes all indices associated with the named table.
1340*/
drh182e84c2017-02-18 02:19:02 +00001341void sqlite3Analyze(Parse *pParse, Token *pName1, Token *pName2){
drhff2d5ea2005-07-23 00:41:48 +00001342 sqlite3 *db = pParse->db;
1343 int iDb;
drh4a54bb52017-02-18 15:58:52 +00001344 int i;
drhff2d5ea2005-07-23 00:41:48 +00001345 char *z, *zDb;
1346 Table *pTab;
drha071bc52011-03-31 02:03:28 +00001347 Index *pIdx;
drhff2d5ea2005-07-23 00:41:48 +00001348 Token *pTableName;
drh4a54bb52017-02-18 15:58:52 +00001349 Vdbe *v;
drhff2d5ea2005-07-23 00:41:48 +00001350
1351 /* Read the database schema. If an error occurs, leave an error message
1352 ** and code in pParse and return NULL. */
drh1fee73e2007-08-29 04:00:57 +00001353 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
drhff2d5ea2005-07-23 00:41:48 +00001354 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
1355 return;
1356 }
1357
drh05800a12009-04-16 17:45:47 +00001358 assert( pName2!=0 || pName1==0 );
drhff2d5ea2005-07-23 00:41:48 +00001359 if( pName1==0 ){
1360 /* Form 1: Analyze everything */
drh4a54bb52017-02-18 15:58:52 +00001361 for(i=0; i<db->nDb; i++){
1362 if( i==1 ) continue; /* Do not analyze the TEMP database */
1363 analyzeDatabase(pParse, i);
1364 }
drhbce04142017-02-23 00:58:36 +00001365 }else if( pName2->n==0 && (iDb = sqlite3FindDb(db, pName1))>=0 ){
1366 /* Analyze the schema named as the argument */
1367 analyzeDatabase(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001368 }else{
drhbce04142017-02-23 00:58:36 +00001369 /* Form 3: Analyze the table or index named as an argument */
drhff2d5ea2005-07-23 00:41:48 +00001370 iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pTableName);
1371 if( iDb>=0 ){
drhbce04142017-02-23 00:58:36 +00001372 zDb = pName2->n ? db->aDb[iDb].zDbSName : 0;
drh17435752007-08-16 04:30:38 +00001373 z = sqlite3NameFromToken(db, pTableName);
drhcf1be452007-05-12 12:08:51 +00001374 if( z ){
drha071bc52011-03-31 02:03:28 +00001375 if( (pIdx = sqlite3FindIndex(db, z, zDb))!=0 ){
1376 analyzeTable(pParse, pIdx->pTable, pIdx);
1377 }else if( (pTab = sqlite3LocateTable(pParse, 0, z, zDb))!=0 ){
1378 analyzeTable(pParse, pTab, 0);
drhcf1be452007-05-12 12:08:51 +00001379 }
drha071bc52011-03-31 02:03:28 +00001380 sqlite3DbFree(db, z);
drhff2d5ea2005-07-23 00:41:48 +00001381 }
drhbce04142017-02-23 00:58:36 +00001382 }
drhff2d5ea2005-07-23 00:41:48 +00001383 }
drhbce04142017-02-23 00:58:36 +00001384 if( db->nSqlExec==0 && (v = sqlite3GetVdbe(pParse))!=0 ){
1385 sqlite3VdbeAddOp0(v, OP_Expire);
1386 }
drh9f18e8a2005-07-08 12:13:04 +00001387}
1388
drh497e4462005-07-23 03:18:40 +00001389/*
1390** Used to pass information from the analyzer reader through to the
1391** callback routine.
1392*/
1393typedef struct analysisInfo analysisInfo;
1394struct analysisInfo {
1395 sqlite3 *db;
1396 const char *zDatabase;
1397};
1398
1399/*
danf52bb8d2013-08-03 20:24:58 +00001400** The first argument points to a nul-terminated string containing a
1401** list of space separated integers. Read the first nOut of these into
1402** the array aOut[].
1403*/
1404static void decodeIntArray(
drhc28c4e52013-10-03 19:21:41 +00001405 char *zIntArray, /* String containing int array to decode */
1406 int nOut, /* Number of slots in aOut[] */
1407 tRowcnt *aOut, /* Store integers here */
dancfc9df72014-04-25 15:01:01 +00001408 LogEst *aLog, /* Or, if aOut==0, here */
drhc28c4e52013-10-03 19:21:41 +00001409 Index *pIndex /* Handle extra flags for this index, if not NULL */
danf52bb8d2013-08-03 20:24:58 +00001410){
1411 char *z = zIntArray;
1412 int c;
1413 int i;
1414 tRowcnt v;
drh1435a9a2013-08-27 23:15:44 +00001415
drh175b8f02019-08-08 15:24:17 +00001416#ifdef SQLITE_ENABLE_STAT4
drh6d57bbf2013-08-28 11:43:49 +00001417 if( z==0 ) z = "";
1418#else
drh85d117b2014-10-06 18:33:49 +00001419 assert( z!=0 );
drh6d57bbf2013-08-28 11:43:49 +00001420#endif
danf52bb8d2013-08-03 20:24:58 +00001421 for(i=0; *z && i<nOut; i++){
1422 v = 0;
1423 while( (c=z[0])>='0' && c<='9' ){
1424 v = v*10 + c - '0';
1425 z++;
1426 }
drh175b8f02019-08-08 15:24:17 +00001427#ifdef SQLITE_ENABLE_STAT4
drh85d117b2014-10-06 18:33:49 +00001428 if( aOut ) aOut[i] = v;
1429 if( aLog ) aLog[i] = sqlite3LogEst(v);
drhc5f246e2014-05-01 20:24:21 +00001430#else
1431 assert( aOut==0 );
1432 UNUSED_PARAMETER(aOut);
drh85d117b2014-10-06 18:33:49 +00001433 assert( aLog!=0 );
1434 aLog[i] = sqlite3LogEst(v);
drhc5f246e2014-05-01 20:24:21 +00001435#endif
danf52bb8d2013-08-03 20:24:58 +00001436 if( *z==' ' ) z++;
1437 }
drh175b8f02019-08-08 15:24:17 +00001438#ifndef SQLITE_ENABLE_STAT4
drh0da10d322014-11-22 21:37:00 +00001439 assert( pIndex!=0 ); {
drh1f1fc0c2013-10-08 23:16:48 +00001440#else
drh0da10d322014-11-22 21:37:00 +00001441 if( pIndex ){
drh1f1fc0c2013-10-08 23:16:48 +00001442#endif
drh0da10d322014-11-22 21:37:00 +00001443 pIndex->bUnordered = 0;
1444 pIndex->noSkipScan = 0;
1445 while( z[0] ){
1446 if( sqlite3_strglob("unordered*", z)==0 ){
1447 pIndex->bUnordered = 1;
1448 }else if( sqlite3_strglob("sz=[0-9]*", z)==0 ){
drh725dd722019-08-15 14:35:45 +00001449 int sz = sqlite3Atoi(z+3);
1450 if( sz<2 ) sz = 2;
1451 pIndex->szIdxRow = sqlite3LogEst(sz);
drh0da10d322014-11-22 21:37:00 +00001452 }else if( sqlite3_strglob("noskipscan*", z)==0 ){
1453 pIndex->noSkipScan = 1;
1454 }
drhdbd94862014-07-23 23:57:42 +00001455#ifdef SQLITE_ENABLE_COSTMULT
drh0da10d322014-11-22 21:37:00 +00001456 else if( sqlite3_strglob("costmult=[0-9]*",z)==0 ){
1457 pIndex->pTable->costMult = sqlite3LogEst(sqlite3Atoi(z+9));
1458 }
drhdbd94862014-07-23 23:57:42 +00001459#endif
drh0da10d322014-11-22 21:37:00 +00001460 while( z[0]!=0 && z[0]!=' ' ) z++;
1461 while( z[0]==' ' ) z++;
1462 }
danf52bb8d2013-08-03 20:24:58 +00001463 }
1464}
1465
1466/*
drh497e4462005-07-23 03:18:40 +00001467** This callback is invoked once for each index when reading the
1468** sqlite_stat1 table.
1469**
drh15564052010-09-25 22:32:56 +00001470** argv[0] = name of the table
1471** argv[1] = name of the index (might be NULL)
1472** argv[2] = results of analysis - on integer for each column
1473**
1474** Entries for which argv[1]==NULL simply record the number of rows in
1475** the table.
drh497e4462005-07-23 03:18:40 +00001476*/
danielk197762c14b32008-11-19 09:05:26 +00001477static int analysisLoader(void *pData, int argc, char **argv, char **NotUsed){
drh497e4462005-07-23 03:18:40 +00001478 analysisInfo *pInfo = (analysisInfo*)pData;
1479 Index *pIndex;
drh15564052010-09-25 22:32:56 +00001480 Table *pTable;
drh497e4462005-07-23 03:18:40 +00001481 const char *z;
1482
drh15564052010-09-25 22:32:56 +00001483 assert( argc==3 );
danielk1977f3d3c272008-11-19 16:52:44 +00001484 UNUSED_PARAMETER2(NotUsed, argc);
1485
drh15564052010-09-25 22:32:56 +00001486 if( argv==0 || argv[0]==0 || argv[2]==0 ){
drh497e4462005-07-23 03:18:40 +00001487 return 0;
1488 }
drh15564052010-09-25 22:32:56 +00001489 pTable = sqlite3FindTable(pInfo->db, argv[0], pInfo->zDatabase);
1490 if( pTable==0 ){
drh497e4462005-07-23 03:18:40 +00001491 return 0;
1492 }
drhc2b23e72013-11-13 15:32:15 +00001493 if( argv[1]==0 ){
drh15564052010-09-25 22:32:56 +00001494 pIndex = 0;
drhc2b23e72013-11-13 15:32:15 +00001495 }else if( sqlite3_stricmp(argv[0],argv[1])==0 ){
1496 pIndex = sqlite3PrimaryKeyIndex(pTable);
1497 }else{
1498 pIndex = sqlite3FindIndex(pInfo->db, argv[1], pInfo->zDatabase);
drh15564052010-09-25 22:32:56 +00001499 }
drh15564052010-09-25 22:32:56 +00001500 z = argv[2];
danf52bb8d2013-08-03 20:24:58 +00001501
1502 if( pIndex ){
dan4eed0532015-04-20 15:13:08 +00001503 tRowcnt *aiRowEst = 0;
dan43085d72014-10-03 19:16:53 +00001504 int nCol = pIndex->nKeyCol+1;
drh175b8f02019-08-08 15:24:17 +00001505#ifdef SQLITE_ENABLE_STAT4
dan4eed0532015-04-20 15:13:08 +00001506 /* Index.aiRowEst may already be set here if there are duplicate
1507 ** sqlite_stat1 entries for this index. In that case just clobber
1508 ** the old data with the new instead of allocating a new array. */
1509 if( pIndex->aiRowEst==0 ){
1510 pIndex->aiRowEst = (tRowcnt*)sqlite3MallocZero(sizeof(tRowcnt) * nCol);
drh4a642b62016-02-05 01:55:27 +00001511 if( pIndex->aiRowEst==0 ) sqlite3OomFault(pInfo->db);
dan4eed0532015-04-20 15:13:08 +00001512 }
1513 aiRowEst = pIndex->aiRowEst;
dan43085d72014-10-03 19:16:53 +00001514#endif
drh25df48d2014-07-22 14:58:12 +00001515 pIndex->bUnordered = 0;
dan43085d72014-10-03 19:16:53 +00001516 decodeIntArray((char*)z, nCol, aiRowEst, pIndex->aiRowLogEst, pIndex);
drh33bec3f2017-02-17 13:38:15 +00001517 pIndex->hasStat1 = 1;
1518 if( pIndex->pPartIdxWhere==0 ){
1519 pTable->nRowLogEst = pIndex->aiRowLogEst[0];
1520 pTable->tabFlags |= TF_HasStat1;
1521 }
danf52bb8d2013-08-03 20:24:58 +00001522 }else{
drh52f6c912013-10-06 22:12:41 +00001523 Index fakeIdx;
1524 fakeIdx.szIdxRow = pTable->szTabRow;
drhdbd94862014-07-23 23:57:42 +00001525#ifdef SQLITE_ENABLE_COSTMULT
1526 fakeIdx.pTable = pTable;
1527#endif
dancfc9df72014-04-25 15:01:01 +00001528 decodeIntArray((char*)z, 1, 0, &pTable->nRowLogEst, &fakeIdx);
drh52f6c912013-10-06 22:12:41 +00001529 pTable->szTabRow = fakeIdx.szIdxRow;
drh33bec3f2017-02-17 13:38:15 +00001530 pTable->tabFlags |= TF_HasStat1;
drh497e4462005-07-23 03:18:40 +00001531 }
danf52bb8d2013-08-03 20:24:58 +00001532
drh497e4462005-07-23 03:18:40 +00001533 return 0;
1534}
1535
1536/*
dan85c165c2009-08-19 14:34:54 +00001537** If the Index.aSample variable is not NULL, delete the aSample[] array
1538** and its contents.
1539*/
dand46def72010-07-24 11:28:28 +00001540void sqlite3DeleteIndexSamples(sqlite3 *db, Index *pIdx){
drh175b8f02019-08-08 15:24:17 +00001541#ifdef SQLITE_ENABLE_STAT4
dan85c165c2009-08-19 14:34:54 +00001542 if( pIdx->aSample ){
1543 int j;
drhfaacf172011-08-12 01:51:45 +00001544 for(j=0; j<pIdx->nSample; j++){
dan85c165c2009-08-19 14:34:54 +00001545 IndexSample *p = &pIdx->aSample[j];
danf52bb8d2013-08-03 20:24:58 +00001546 sqlite3DbFree(db, p->p);
dan85c165c2009-08-19 14:34:54 +00001547 }
drh8e3937f2011-08-18 13:45:23 +00001548 sqlite3DbFree(db, pIdx->aSample);
dan85c165c2009-08-19 14:34:54 +00001549 }
drh8e3937f2011-08-18 13:45:23 +00001550 if( db && db->pnBytesFreed==0 ){
1551 pIdx->nSample = 0;
1552 pIdx->aSample = 0;
1553 }
shanecea72b22009-09-07 04:38:36 +00001554#else
drh43b18e12010-08-17 19:40:08 +00001555 UNUSED_PARAMETER(db);
shanecea72b22009-09-07 04:38:36 +00001556 UNUSED_PARAMETER(pIdx);
drh175b8f02019-08-08 15:24:17 +00001557#endif /* SQLITE_ENABLE_STAT4 */
dan85c165c2009-08-19 14:34:54 +00001558}
1559
drh175b8f02019-08-08 15:24:17 +00001560#ifdef SQLITE_ENABLE_STAT4
dan0adbed82013-08-15 19:56:32 +00001561/*
1562** Populate the pIdx->aAvgEq[] array based on the samples currently
1563** stored in pIdx->aSample[].
1564*/
1565static void initAvgEq(Index *pIdx){
1566 if( pIdx ){
1567 IndexSample *aSample = pIdx->aSample;
1568 IndexSample *pFinal = &aSample[pIdx->nSample-1];
1569 int iCol;
dan39caccf2014-07-01 11:54:02 +00001570 int nCol = 1;
1571 if( pIdx->nSampleCol>1 ){
1572 /* If this is stat4 data, then calculate aAvgEq[] values for all
1573 ** sample columns except the last. The last is always set to 1, as
1574 ** once the trailing PK fields are considered all index keys are
1575 ** unique. */
1576 nCol = pIdx->nSampleCol-1;
1577 pIdx->aAvgEq[nCol] = 1;
1578 }
1579 for(iCol=0; iCol<nCol; iCol++){
dan43085d72014-10-03 19:16:53 +00001580 int nSample = pIdx->nSample;
dan0adbed82013-08-15 19:56:32 +00001581 int i; /* Used to iterate through samples */
1582 tRowcnt sumEq = 0; /* Sum of the nEq values */
dan0adbed82013-08-15 19:56:32 +00001583 tRowcnt avgEq = 0;
dan43085d72014-10-03 19:16:53 +00001584 tRowcnt nRow; /* Number of rows in index */
1585 i64 nSum100 = 0; /* Number of terms contributing to sumEq */
1586 i64 nDist100; /* Number of distinct values in index */
1587
dan5cca94e2014-12-05 21:04:26 +00001588 if( !pIdx->aiRowEst || iCol>=pIdx->nKeyCol || pIdx->aiRowEst[iCol+1]==0 ){
dan43085d72014-10-03 19:16:53 +00001589 nRow = pFinal->anLt[iCol];
1590 nDist100 = (i64)100 * pFinal->anDLt[iCol];
1591 nSample--;
1592 }else{
1593 nRow = pIdx->aiRowEst[0];
1594 nDist100 = ((i64)100 * pIdx->aiRowEst[0]) / pIdx->aiRowEst[iCol+1];
1595 }
drh9f07cf72014-10-22 15:27:05 +00001596 pIdx->nRowEst0 = nRow;
dan0adbed82013-08-15 19:56:32 +00001597
1598 /* Set nSum to the number of distinct (iCol+1) field prefixes that
dan43085d72014-10-03 19:16:53 +00001599 ** occur in the stat4 table for this index. Set sumEq to the sum of
1600 ** the nEq values for column iCol for the same set (adding the value
1601 ** only once where there exist duplicate prefixes). */
1602 for(i=0; i<nSample; i++){
1603 if( i==(pIdx->nSample-1)
1604 || aSample[i].anDLt[iCol]!=aSample[i+1].anDLt[iCol]
1605 ){
dan0adbed82013-08-15 19:56:32 +00001606 sumEq += aSample[i].anEq[iCol];
dan43085d72014-10-03 19:16:53 +00001607 nSum100 += 100;
dan0adbed82013-08-15 19:56:32 +00001608 }
1609 }
dan43085d72014-10-03 19:16:53 +00001610
drh785d8ed2017-01-11 14:15:29 +00001611 if( nDist100>nSum100 && sumEq<nRow ){
dan43085d72014-10-03 19:16:53 +00001612 avgEq = ((i64)100 * (nRow - sumEq))/(nDist100 - nSum100);
dan0adbed82013-08-15 19:56:32 +00001613 }
1614 if( avgEq==0 ) avgEq = 1;
1615 pIdx->aAvgEq[iCol] = avgEq;
dan0adbed82013-08-15 19:56:32 +00001616 }
1617 }
1618}
1619
dan0106e372013-08-12 16:34:32 +00001620/*
drhce95d112013-11-02 19:34:38 +00001621** Look up an index by name. Or, if the name of a WITHOUT ROWID table
1622** is supplied instead, find the PRIMARY KEY index for that table.
1623*/
1624static Index *findIndexOrPrimaryKey(
1625 sqlite3 *db,
1626 const char *zName,
1627 const char *zDb
1628){
1629 Index *pIdx = sqlite3FindIndex(db, zName, zDb);
1630 if( pIdx==0 ){
1631 Table *pTab = sqlite3FindTable(db, zName, zDb);
1632 if( pTab && !HasRowid(pTab) ) pIdx = sqlite3PrimaryKeyIndex(pTab);
1633 }
1634 return pIdx;
1635}
1636
1637/*
drh175b8f02019-08-08 15:24:17 +00001638** Load the content from either the sqlite_stat4
dan0106e372013-08-12 16:34:32 +00001639** into the relevant Index.aSample[] arrays.
1640**
1641** Arguments zSql1 and zSql2 must point to SQL statements that return
drh175b8f02019-08-08 15:24:17 +00001642** data equivalent to the following:
dan0106e372013-08-12 16:34:32 +00001643**
1644** zSql1: SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx
1645** zSql2: SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4
1646**
1647** where %Q is replaced with the database name before the SQL is executed.
1648*/
1649static int loadStatTbl(
1650 sqlite3 *db, /* Database handle */
dan0106e372013-08-12 16:34:32 +00001651 const char *zSql1, /* SQL statement 1 (see above) */
1652 const char *zSql2, /* SQL statement 2 (see above) */
1653 const char *zDb /* Database name (e.g. "main") */
1654){
drhfaacf172011-08-12 01:51:45 +00001655 int rc; /* Result codes from subroutines */
1656 sqlite3_stmt *pStmt = 0; /* An SQL statement being run */
1657 char *zSql; /* Text of the SQL statement */
1658 Index *pPrevIdx = 0; /* Previous index in the loop */
drhfaacf172011-08-12 01:51:45 +00001659 IndexSample *pSample; /* A slot in pIdx->aSample[] */
1660
drh4a642b62016-02-05 01:55:27 +00001661 assert( db->lookaside.bDisable );
dan0106e372013-08-12 16:34:32 +00001662 zSql = sqlite3MPrintf(db, zSql1, zDb);
drhfaacf172011-08-12 01:51:45 +00001663 if( !zSql ){
mistachkinfad30392016-02-13 23:43:46 +00001664 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001665 }
1666 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1667 sqlite3DbFree(db, zSql);
1668 if( rc ) return rc;
1669
1670 while( sqlite3_step(pStmt)==SQLITE_ROW ){
dan0106e372013-08-12 16:34:32 +00001671 int nIdxCol = 1; /* Number of columns in stat4 records */
dan0106e372013-08-12 16:34:32 +00001672
drhfaacf172011-08-12 01:51:45 +00001673 char *zIndex; /* Index name */
1674 Index *pIdx; /* Pointer to the index object */
1675 int nSample; /* Number of samples */
danf52bb8d2013-08-03 20:24:58 +00001676 int nByte; /* Bytes of space required */
1677 int i; /* Bytes of space required */
1678 tRowcnt *pSpace;
drhfaacf172011-08-12 01:51:45 +00001679
1680 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1681 if( zIndex==0 ) continue;
1682 nSample = sqlite3_column_int(pStmt, 1);
drhce95d112013-11-02 19:34:38 +00001683 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
drh175b8f02019-08-08 15:24:17 +00001684 assert( pIdx==0 || pIdx->nSample==0 );
drh5eae1d12019-08-08 16:23:12 +00001685 if( pIdx==0 ) continue;
drh175b8f02019-08-08 15:24:17 +00001686 assert( !HasRowid(pIdx->pTable) || pIdx->nColumn==pIdx->nKeyCol+1 );
1687 if( !HasRowid(pIdx->pTable) && IsPrimaryKeyIndex(pIdx) ){
1688 nIdxCol = pIdx->nKeyCol;
1689 }else{
1690 nIdxCol = pIdx->nColumn;
dan0106e372013-08-12 16:34:32 +00001691 }
dan8ad169a2013-08-12 20:14:04 +00001692 pIdx->nSampleCol = nIdxCol;
danf52bb8d2013-08-03 20:24:58 +00001693 nByte = sizeof(IndexSample) * nSample;
dan0106e372013-08-12 16:34:32 +00001694 nByte += sizeof(tRowcnt) * nIdxCol * 3 * nSample;
dan39caccf2014-07-01 11:54:02 +00001695 nByte += nIdxCol * sizeof(tRowcnt); /* Space for Index.aAvgEq[] */
danf52bb8d2013-08-03 20:24:58 +00001696
1697 pIdx->aSample = sqlite3DbMallocZero(db, nByte);
drhfaacf172011-08-12 01:51:45 +00001698 if( pIdx->aSample==0 ){
drhfaacf172011-08-12 01:51:45 +00001699 sqlite3_finalize(pStmt);
mistachkinfad30392016-02-13 23:43:46 +00001700 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001701 }
danf52bb8d2013-08-03 20:24:58 +00001702 pSpace = (tRowcnt*)&pIdx->aSample[nSample];
dan39caccf2014-07-01 11:54:02 +00001703 pIdx->aAvgEq = pSpace; pSpace += nIdxCol;
dan0adbed82013-08-15 19:56:32 +00001704 for(i=0; i<nSample; i++){
dan0106e372013-08-12 16:34:32 +00001705 pIdx->aSample[i].anEq = pSpace; pSpace += nIdxCol;
1706 pIdx->aSample[i].anLt = pSpace; pSpace += nIdxCol;
1707 pIdx->aSample[i].anDLt = pSpace; pSpace += nIdxCol;
danf52bb8d2013-08-03 20:24:58 +00001708 }
1709 assert( ((u8*)pSpace)-nByte==(u8*)(pIdx->aSample) );
drhfaacf172011-08-12 01:51:45 +00001710 }
drh8e3937f2011-08-18 13:45:23 +00001711 rc = sqlite3_finalize(pStmt);
1712 if( rc ) return rc;
drhfaacf172011-08-12 01:51:45 +00001713
dan0106e372013-08-12 16:34:32 +00001714 zSql = sqlite3MPrintf(db, zSql2, zDb);
drhfaacf172011-08-12 01:51:45 +00001715 if( !zSql ){
mistachkinfad30392016-02-13 23:43:46 +00001716 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001717 }
1718 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1719 sqlite3DbFree(db, zSql);
1720 if( rc ) return rc;
1721
1722 while( sqlite3_step(pStmt)==SQLITE_ROW ){
dan0106e372013-08-12 16:34:32 +00001723 char *zIndex; /* Index name */
1724 Index *pIdx; /* Pointer to the index object */
dan0106e372013-08-12 16:34:32 +00001725 int nCol = 1; /* Number of columns in index */
drhfaacf172011-08-12 01:51:45 +00001726
1727 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1728 if( zIndex==0 ) continue;
drhce95d112013-11-02 19:34:38 +00001729 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
drhfaacf172011-08-12 01:51:45 +00001730 if( pIdx==0 ) continue;
dan86f69d92013-08-12 17:31:32 +00001731 /* This next condition is true if data has already been loaded from
drh175b8f02019-08-08 15:24:17 +00001732 ** the sqlite_stat4 table. */
dan0adbed82013-08-15 19:56:32 +00001733 nCol = pIdx->nSampleCol;
dan0adbed82013-08-15 19:56:32 +00001734 if( pIdx!=pPrevIdx ){
1735 initAvgEq(pPrevIdx);
1736 pPrevIdx = pIdx;
dan0106e372013-08-12 16:34:32 +00001737 }
danc367d4c2013-08-16 14:09:43 +00001738 pSample = &pIdx->aSample[pIdx->nSample];
dancfc9df72014-04-25 15:01:01 +00001739 decodeIntArray((char*)sqlite3_column_text(pStmt,1),nCol,pSample->anEq,0,0);
1740 decodeIntArray((char*)sqlite3_column_text(pStmt,2),nCol,pSample->anLt,0,0);
1741 decodeIntArray((char*)sqlite3_column_text(pStmt,3),nCol,pSample->anDLt,0,0);
danf52bb8d2013-08-03 20:24:58 +00001742
danc367d4c2013-08-16 14:09:43 +00001743 /* Take a copy of the sample. Add two 0x00 bytes the end of the buffer.
1744 ** This is in case the sample record is corrupted. In that case, the
1745 ** sqlite3VdbeRecordCompare() may read up to two varints past the
1746 ** end of the allocated buffer before it realizes it is dealing with
1747 ** a corrupt record. Adding the two 0x00 bytes prevents this from causing
1748 ** a buffer overread. */
danf52bb8d2013-08-03 20:24:58 +00001749 pSample->n = sqlite3_column_bytes(pStmt, 4);
danc367d4c2013-08-16 14:09:43 +00001750 pSample->p = sqlite3DbMallocZero(db, pSample->n + 2);
danf52bb8d2013-08-03 20:24:58 +00001751 if( pSample->p==0 ){
1752 sqlite3_finalize(pStmt);
mistachkinfad30392016-02-13 23:43:46 +00001753 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001754 }
dan895decf2016-12-30 14:15:56 +00001755 if( pSample->n ){
1756 memcpy(pSample->p, sqlite3_column_blob(pStmt, 4), pSample->n);
1757 }
danc367d4c2013-08-16 14:09:43 +00001758 pIdx->nSample++;
drhfaacf172011-08-12 01:51:45 +00001759 }
drh61b34402013-08-16 13:34:50 +00001760 rc = sqlite3_finalize(pStmt);
1761 if( rc==SQLITE_OK ) initAvgEq(pPrevIdx);
1762 return rc;
drhfaacf172011-08-12 01:51:45 +00001763}
dan0106e372013-08-12 16:34:32 +00001764
1765/*
drh175b8f02019-08-08 15:24:17 +00001766** Load content from the sqlite_stat4 table into
dan0106e372013-08-12 16:34:32 +00001767** the Index.aSample[] arrays of all indices.
1768*/
1769static int loadStat4(sqlite3 *db, const char *zDb){
1770 int rc = SQLITE_OK; /* Result codes from subroutines */
1771
drh4a642b62016-02-05 01:55:27 +00001772 assert( db->lookaside.bDisable );
dan0106e372013-08-12 16:34:32 +00001773 if( sqlite3FindTable(db, "sqlite_stat4", zDb) ){
drh175b8f02019-08-08 15:24:17 +00001774 rc = loadStatTbl(db,
dan0106e372013-08-12 16:34:32 +00001775 "SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx",
1776 "SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4",
1777 zDb
1778 );
1779 }
dan0106e372013-08-12 16:34:32 +00001780 return rc;
1781}
drh175b8f02019-08-08 15:24:17 +00001782#endif /* SQLITE_ENABLE_STAT4 */
drhfaacf172011-08-12 01:51:45 +00001783
1784/*
drh175b8f02019-08-08 15:24:17 +00001785** Load the content of the sqlite_stat1 and sqlite_stat4 tables. The
dan85c165c2009-08-19 14:34:54 +00001786** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
drh175b8f02019-08-08 15:24:17 +00001787** arrays. The contents of sqlite_stat4 are used to populate the
dan85c165c2009-08-19 14:34:54 +00001788** Index.aSample[] arrays.
1789**
1790** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
drh175b8f02019-08-08 15:24:17 +00001791** is returned. In this case, even if SQLITE_ENABLE_STAT4 was defined
1792** during compilation and the sqlite_stat4 table is present, no data is
dan85c165c2009-08-19 14:34:54 +00001793** read from it.
1794**
drh175b8f02019-08-08 15:24:17 +00001795** If SQLITE_ENABLE_STAT4 was defined during compilation and the
danf52bb8d2013-08-03 20:24:58 +00001796** sqlite_stat4 table is not present in the database, SQLITE_ERROR is
dan85c165c2009-08-19 14:34:54 +00001797** returned. However, in this case, data is read from the sqlite_stat1
1798** table (if it is present) before returning.
1799**
1800** If an OOM error occurs, this function always sets db->mallocFailed.
1801** This means if the caller does not care about other errors, the return
1802** code may be ignored.
drh497e4462005-07-23 03:18:40 +00001803*/
drhcf1be452007-05-12 12:08:51 +00001804int sqlite3AnalysisLoad(sqlite3 *db, int iDb){
drh497e4462005-07-23 03:18:40 +00001805 analysisInfo sInfo;
1806 HashElem *i;
1807 char *zSql;
drh51b55a32016-04-04 12:38:05 +00001808 int rc = SQLITE_OK;
drh33bec3f2017-02-17 13:38:15 +00001809 Schema *pSchema = db->aDb[iDb].pSchema;
drh497e4462005-07-23 03:18:40 +00001810
drhff0587c2007-08-29 17:43:19 +00001811 assert( iDb>=0 && iDb<db->nDb );
1812 assert( db->aDb[iDb].pBt!=0 );
drh1fee73e2007-08-29 04:00:57 +00001813
drh497e4462005-07-23 03:18:40 +00001814 /* Clear any prior statistics */
drh21206082011-04-04 18:22:02 +00001815 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drh33bec3f2017-02-17 13:38:15 +00001816 for(i=sqliteHashFirst(&pSchema->tblHash); i; i=sqliteHashNext(i)){
1817 Table *pTab = sqliteHashData(i);
1818 pTab->tabFlags &= ~TF_HasStat1;
1819 }
1820 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
drh497e4462005-07-23 03:18:40 +00001821 Index *pIdx = sqliteHashData(i);
drh33bec3f2017-02-17 13:38:15 +00001822 pIdx->hasStat1 = 0;
drh175b8f02019-08-08 15:24:17 +00001823#ifdef SQLITE_ENABLE_STAT4
dand46def72010-07-24 11:28:28 +00001824 sqlite3DeleteIndexSamples(db, pIdx);
1825 pIdx->aSample = 0;
drhfaacf172011-08-12 01:51:45 +00001826#endif
drh497e4462005-07-23 03:18:40 +00001827 }
1828
drhf6661a82016-04-01 12:35:22 +00001829 /* Load new statistics out of the sqlite_stat1 table */
drh497e4462005-07-23 03:18:40 +00001830 sInfo.db = db;
drh69c33822016-08-18 14:33:11 +00001831 sInfo.zDatabase = db->aDb[iDb].zDbSName;
drhf6661a82016-04-01 12:35:22 +00001832 if( sqlite3FindTable(db, "sqlite_stat1", sInfo.zDatabase)!=0 ){
1833 zSql = sqlite3MPrintf(db,
1834 "SELECT tbl,idx,stat FROM %Q.sqlite_stat1", sInfo.zDatabase);
1835 if( zSql==0 ){
1836 rc = SQLITE_NOMEM_BKPT;
1837 }else{
1838 rc = sqlite3_exec(db, zSql, analysisLoader, &sInfo, 0);
1839 sqlite3DbFree(db, zSql);
1840 }
drh497e4462005-07-23 03:18:40 +00001841 }
1842
drhf6661a82016-04-01 12:35:22 +00001843 /* Set appropriate defaults on all indexes not in the sqlite_stat1 table */
1844 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drh33bec3f2017-02-17 13:38:15 +00001845 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
drhf6661a82016-04-01 12:35:22 +00001846 Index *pIdx = sqliteHashData(i);
drh33bec3f2017-02-17 13:38:15 +00001847 if( !pIdx->hasStat1 ) sqlite3DefaultRowEst(pIdx);
drhf16ce3b2009-02-13 16:59:53 +00001848 }
dan02fa4692009-08-17 17:06:58 +00001849
danf52bb8d2013-08-03 20:24:58 +00001850 /* Load the statistics from the sqlite_stat4 table. */
drh175b8f02019-08-08 15:24:17 +00001851#ifdef SQLITE_ENABLE_STAT4
drh72d03a62018-07-20 19:24:02 +00001852 if( rc==SQLITE_OK ){
drh31f69622019-10-05 14:39:36 +00001853 DisableLookaside;
danf52bb8d2013-08-03 20:24:58 +00001854 rc = loadStat4(db, sInfo.zDatabase);
drh31f69622019-10-05 14:39:36 +00001855 EnableLookaside;
dan02fa4692009-08-17 17:06:58 +00001856 }
drh33bec3f2017-02-17 13:38:15 +00001857 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
dan43085d72014-10-03 19:16:53 +00001858 Index *pIdx = sqliteHashData(i);
drh75b170b2014-10-04 00:07:44 +00001859 sqlite3_free(pIdx->aiRowEst);
dan43085d72014-10-03 19:16:53 +00001860 pIdx->aiRowEst = 0;
1861 }
dan69188d92009-08-19 08:18:32 +00001862#endif
dan02fa4692009-08-17 17:06:58 +00001863
dane275dc32009-08-18 16:24:58 +00001864 if( rc==SQLITE_NOMEM ){
drh4a642b62016-02-05 01:55:27 +00001865 sqlite3OomFault(db);
dane275dc32009-08-18 16:24:58 +00001866 }
drhcf1be452007-05-12 12:08:51 +00001867 return rc;
drh497e4462005-07-23 03:18:40 +00001868}
drh9f18e8a2005-07-08 12:13:04 +00001869
drhff2d5ea2005-07-23 00:41:48 +00001870
drh9f18e8a2005-07-08 12:13:04 +00001871#endif /* SQLITE_OMIT_ANALYZE */